feat: Folders and TypeScript

BREAKING CHANGE

This rewrites much of the core of toGeoJSON to modernize and update it, as well as adding support for KML folder structures. This also adds **TypeScript types**.

* Support folders, TypeScript
* Add codeclimate config
* Refactoring
* Refactor out gpx internals
* Refactor out extensions
* Note Folder support in README, expand parsed objects
* Bumps and dependency updates

.codeclimate.yml

@@ -0,0 +1,20 @@
+version: "2"
+checks:
+  argument-count:
+    config:
+      threshold: 6
+  return-statements:
+    config:
+      threshold: 10
+  complex-logic:
+    config:
+      threshold: 10
+  file-lines:
+    config:
+      threshold: 200
+  method-complexity:
+    config:
+      threshold: 10
+  method-lines:
+    config:
+      threshold: 50

.eslintrc.cjs

@@ -0,0 +1,20 @@
+module.exports = {
+    "env": {
+        "browser": true,
+        "es2021": true
+    },
+    "extends": [
+        "eslint:recommended",
+        "plugin:@typescript-eslint/recommended"
+    ],
+    "parser": "@typescript-eslint/parser",
+    "parserOptions": {
+        "ecmaVersion": "latest",
+        "sourceType": "module"
+    },
+    "plugins": [
+        "@typescript-eslint"
+    ],
+    "rules": {
+    }
+}

.gitignore

@@ -1,5 +1,6 @@
 .DS_Store
 dist
+coverage
 node_modules/
 npm-debug.log
 .nyc_output

CHANGELOG.md

@@ -2,6 +2,8 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+### [4.7.1-0](https://github.com/tmcw/togeojson/compare/v4.7.0...v4.7.1-0) (2022-03-09)
+
 ## [4.7.0](https://github.com/tmcw/togeojson/compare/v4.6.1...v4.7.0) (2022-03-08)
 
 

README.md

@@ -15,51 +15,6 @@ looking for a command line too, use [@tmcw/togeojson-cli](https://github.com/tmc
 want to convert one KML or GPX file, use [my online tool](https://observablehq.com/@tmcw/convert-kml-to-geojson).
 If you want to convert another format, consider [GDAL](https://www.gdal.org/)._
 
-## API
-
-### `toGeoJSON.kml(doc)`
-
-Convert a KML document to GeoJSON. The first argument, `doc`, must be a KML
-document as an XML DOM - not as a string. You can get this using jQuery's default
-`.ajax` function or using a bare XMLHttpRequest with the `.response` property
-holding an XML DOM.
-
-The output is a JavaScript object of GeoJSON data. You can convert it to a string
-with [JSON.stringify](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify)
-or use it directly in libraries.
-
-### `toGeoJSON.kmlGen(doc)`
-
-Convert KML to GeoJSON incrementally, returning a [Generator](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Iterators_and_Generators)
-that yields output feature by feature.
-
-### `toGeoJSON.gpx(doc)`
-
-Convert a GPX document to GeoJSON. The first argument, `doc`, must be a GPX
-document as an XML DOM - not as a string. You can get this using jQuery's default
-`.ajax` function or using a bare XMLHttpRequest with the `.response` property
-holding an XML DOM.
-
-The output is a JavaScript object of GeoJSON data, same as `.kml` outputs, with the
-addition of a `_gpxType` property on each `LineString` feature that indicates whether
-the feature was encoded as a route (`rte`) or track (`trk`) in the GPX document.
-
-### `toGeoJSON.gpxGen(doc)`
-
-Convert GPX to GeoJSON incrementally, returning a [Generator](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Iterators_and_Generators)
-that yields output feature by feature.
-
-### `toGeoJSON.tcx(doc)`
-
-Convert a TCX document to GeoJSON. The first argument, `doc`, must be a TCX
-document as an XML DOM - not as a string.
-
-### `toGeoJSON.tcxGen(doc)`
-
-Convert a TCX document to GeoJSON incrementally, returning a [Generator](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Iterators_and_Generators)
-that yields output feature by feature. The first argument, `doc`, must be a TCX
-document as an XML DOM - not as a string.
-
 ## Property conversions
 
 In addition to converting KML’s `<ExtendedData>` verbatim, @tmcw/togeojson
@@ -138,10 +93,11 @@ import { kml } from "@tmcw/togeojson";
 - [x] ExtendedData
 - [x] SimpleData
 - [x] MultiGeometry -> GeometryCollection
-- [x] Styles with hashing
+- [x] Styles
 - [x] Tracks & MultiTracks with `gx:coords`, including altitude
 - [x] [TimeSpan](https://developers.google.com/kml/documentation/kmlreference#timespan)
 - [x] [TimeStamp](https://developers.google.com/kml/documentation/kmlreference#timestamp)
+- [x] Folders (with kmlWithFolders)
 - [ ] NetworkLinks
 - [ ] GroundOverlays
 
@@ -167,20 +123,6 @@ import { kml } from "@tmcw/togeojson";
 - The command line utility was moved to [tmcw/togeojson-cli](https://github.com/tmcw/togeojson-cli),
   which lets this module enjoy reduced dependencies: installing @tmcw/togeojson doesn’t
   require any other dependencies.
-- The hashing method is improved, which means that parsing is the same between browsers and
-  Node.js, and there are no runtime dependencies.
-
-### What is hashing?
-
-KML's style system isn't semantic: a typical document made through official tools
-(read Google) has hundreds of identical styles. So, togeojson does its best to
-make this into something usable, by taking a quick hash of each style and exposing
-`styleUrl` and `styleHash` to users. This lets you work backwards from the awful
-representation and build your own styles or derive data based on the classes
-chosen.
-
-Implied here is that this does not try to represent all data contained in KML
-styles.
 
 ### Why doesn't toGeoJSON support NetworkLinks?
 

doc/.nojekyll

@@ -0,0 +1 @@
+TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false.

doc/assets/highlight.css

@@ -0,0 +1,113 @@
+:root {
+    --light-hl-0: #000000;
+    --dark-hl-0: #D4D4D4;
+    --light-hl-1: #A31515;
+    --dark-hl-1: #CE9178;
+    --light-hl-2: #001080;
+    --dark-hl-2: #9CDCFE;
+    --light-hl-3: #008000;
+    --dark-hl-3: #6A9955;
+    --light-hl-4: #0000FF;
+    --dark-hl-4: #569CD6;
+    --light-hl-5: #0070C1;
+    --dark-hl-5: #4FC1FF;
+    --light-hl-6: #795E26;
+    --dark-hl-6: #DCDCAA;
+    --light-hl-7: #AF00DB;
+    --dark-hl-7: #C586C0;
+    --light-hl-8: #800000;
+    --dark-hl-8: #808080;
+    --light-hl-9: #800000;
+    --dark-hl-9: #569CD6;
+    --light-hl-10: #000000FF;
+    --dark-hl-10: #D4D4D4;
+    --light-hl-11: #FF0000;
+    --dark-hl-11: #9CDCFE;
+    --light-hl-12: #0000FF;
+    --dark-hl-12: #CE9178;
+    --light-code-background: #F5F5F5;
+    --dark-code-background: #1E1E1E;
+}
+
+@media (prefers-color-scheme: light) { :root {
+    --hl-0: var(--light-hl-0);
+    --hl-1: var(--light-hl-1);
+    --hl-2: var(--light-hl-2);
+    --hl-3: var(--light-hl-3);
+    --hl-4: var(--light-hl-4);
+    --hl-5: var(--light-hl-5);
+    --hl-6: var(--light-hl-6);
+    --hl-7: var(--light-hl-7);
+    --hl-8: var(--light-hl-8);
+    --hl-9: var(--light-hl-9);
+    --hl-10: var(--light-hl-10);
+    --hl-11: var(--light-hl-11);
+    --hl-12: var(--light-hl-12);
+    --code-background: var(--light-code-background);
+} }
+
+@media (prefers-color-scheme: dark) { :root {
+    --hl-0: var(--dark-hl-0);
+    --hl-1: var(--dark-hl-1);
+    --hl-2: var(--dark-hl-2);
+    --hl-3: var(--dark-hl-3);
+    --hl-4: var(--dark-hl-4);
+    --hl-5: var(--dark-hl-5);
+    --hl-6: var(--dark-hl-6);
+    --hl-7: var(--dark-hl-7);
+    --hl-8: var(--dark-hl-8);
+    --hl-9: var(--dark-hl-9);
+    --hl-10: var(--dark-hl-10);
+    --hl-11: var(--dark-hl-11);
+    --hl-12: var(--dark-hl-12);
+    --code-background: var(--dark-code-background);
+} }
+
+body.light {
+    --hl-0: var(--light-hl-0);
+    --hl-1: var(--light-hl-1);
+    --hl-2: var(--light-hl-2);
+    --hl-3: var(--light-hl-3);
+    --hl-4: var(--light-hl-4);
+    --hl-5: var(--light-hl-5);
+    --hl-6: var(--light-hl-6);
+    --hl-7: var(--light-hl-7);
+    --hl-8: var(--light-hl-8);
+    --hl-9: var(--light-hl-9);
+    --hl-10: var(--light-hl-10);
+    --hl-11: var(--light-hl-11);
+    --hl-12: var(--light-hl-12);
+    --code-background: var(--light-code-background);
+}
+
+body.dark {
+    --hl-0: var(--dark-hl-0);
+    --hl-1: var(--dark-hl-1);
+    --hl-2: var(--dark-hl-2);
+    --hl-3: var(--dark-hl-3);
+    --hl-4: var(--dark-hl-4);
+    --hl-5: var(--dark-hl-5);
+    --hl-6: var(--dark-hl-6);
+    --hl-7: var(--dark-hl-7);
+    --hl-8: var(--dark-hl-8);
+    --hl-9: var(--dark-hl-9);
+    --hl-10: var(--dark-hl-10);
+    --hl-11: var(--dark-hl-11);
+    --hl-12: var(--dark-hl-12);
+    --code-background: var(--dark-code-background);
+}
+
+.hl-0 { color: var(--hl-0); }
+.hl-1 { color: var(--hl-1); }
+.hl-2 { color: var(--hl-2); }
+.hl-3 { color: var(--hl-3); }
+.hl-4 { color: var(--hl-4); }
+.hl-5 { color: var(--hl-5); }
+.hl-6 { color: var(--hl-6); }
+.hl-7 { color: var(--hl-7); }
+.hl-8 { color: var(--hl-8); }
+.hl-9 { color: var(--hl-9); }
+.hl-10 { color: var(--hl-10); }
+.hl-11 { color: var(--hl-11); }
+.hl-12 { color: var(--hl-12); }
+pre, code { background: var(--code-background); }