@turf/kinks 7.0.0-alpha.2 → 7.0.0

package/README.md

@@ -10,62 +10,66 @@ returns [points][5] at all self-intersections.
 
 ### Parameters
 
-- `featureIn` **[Feature][6]<([LineString][7] | [MultiLineString][8] | [MultiPolygon][9] | [Polygon][10])>** input feature
+*   `featureIn` **[Feature][6]<([LineString][7] | [MultiLineString][8] | [MultiPolygon][9] | [Polygon][10])>** input feature
 
 ### Examples
 
 ```javascript
-var poly = turf.polygon([
-  [
-    [-12.034835, 8.901183],
-    [-12.060413, 8.899826],
-    [-12.03638, 8.873199],
-    [-12.059383, 8.871418],
-    [-12.034835, 8.901183],
-  ],
-]);
+var poly = turf.polygon([[
+  [-12.034835, 8.901183],
+  [-12.060413, 8.899826],
+  [-12.03638, 8.873199],
+  [-12.059383, 8.871418],
+  [-12.034835, 8.901183]
+]]);
 
 var kinks = turf.kinks(poly);
 
 //addToMap
-var addToMap = [poly, kinks];
+var addToMap = [poly, kinks]
 ```
 
 Returns **[FeatureCollection][11]<[Point][12]>** self-intersections
 
 [1]: https://tools.ietf.org/html/rfc7946#section-3.1.4
+
 [2]: https://tools.ietf.org/html/rfc7946#section-3.1.5
+
 [3]: https://tools.ietf.org/html/rfc7946#section-3.1.7
+
 [4]: https://tools.ietf.org/html/rfc7946#section-3.1.6
+
 [5]: https://tools.ietf.org/html/rfc7946#section-3.1.2
+
 [6]: https://tools.ietf.org/html/rfc7946#section-3.2
+
 [7]: https://tools.ietf.org/html/rfc7946#section-3.1.4
+
 [8]: https://tools.ietf.org/html/rfc7946#section-3.1.5
+
 [9]: https://tools.ietf.org/html/rfc7946#section-3.1.7
+
 [10]: https://tools.ietf.org/html/rfc7946#section-3.1.6
+
 [11]: https://tools.ietf.org/html/rfc7946#section-3.3
+
 [12]: https://tools.ietf.org/html/rfc7946#section-3.1.2
 
-<!-- This file is automatically generated. Please don't edit it directly:
-if you find an error, edit the source file (likely index.js), and re-run
-./scripts/generate-readmes in the turf project. -->
+<!-- This file is automatically generated. Please don't edit it directly. If you find an error, edit the source file of the module in question (likely index.js or index.ts), and re-run "yarn docs" from the root of the turf project. -->
 
 ---
 
-This module is part of the [Turfjs project](http://turfjs.org/), an open source
-module collection dedicated to geographic algorithms. It is maintained in the
-[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create
-PRs and issues.
+This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues.
 
 ### Installation
 
-Install this module individually:
+Install this single module individually:
 
 ```sh
 $ npm install @turf/kinks
 ```
 
-Or install the Turf module that includes it as a function:
+Or install the all-encompassing @turf/turf module that includes all modules as functions:
 
 ```sh
 $ npm install @turf/turf

package/dist/cjs/index.cjs

@@ -0,0 +1,35 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true}); function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }var __defProp = Object.defineProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+
+// index.ts
+var _helpers = require('@turf/helpers');
+
+// lib/sweepline-intersections-export.ts
+var _sweeplineintersections = require('sweepline-intersections'); var _sweeplineintersections2 = _interopRequireDefault(_sweeplineintersections);
+var sweeplineIntersections = _sweeplineintersections2.default;
+
+// index.ts
+function kinks(featureIn) {
+  const results = {
+    type: "FeatureCollection",
+    features: []
+  };
+  if (featureIn.type === "Feature" && (featureIn.geometry.type === "Point" || featureIn.geometry.type === "MultiPoint")) {
+    throw new Error(
+      "Input must be a LineString, MultiLineString, Polygon, or MultiPolygon Feature or Geometry"
+    );
+  }
+  const intersections = sweeplineIntersections(featureIn, false);
+  for (let i = 0; i < intersections.length; ++i) {
+    const intersection = intersections[i];
+    results.features.push(_helpers.point.call(void 0, [intersection[0], intersection[1]]));
+  }
+  return results;
+}
+__name(kinks, "kinks");
+var turf_kinks_default = kinks;
+
+
+
+exports.default = turf_kinks_default; exports.kinks = kinks;
+//# sourceMappingURL=index.cjs.map

package/dist/cjs/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../index.ts","../../lib/sweepline-intersections-export.ts"],"names":[],"mappings":";;;;AASA,SAAS,aAAa;;;ACLtB,OAAO,SAAS;AAET,IAAM,yBAAyB;;;AD4BtC,SAAS,MACP,WAC0B;AAC1B,QAAM,UAAoC;AAAA,IACxC,MAAM;AAAA,IACN,UAAU,CAAC;AAAA,EACb;AACA,MACE,UAAU,SAAS,cACjB,UAAsB,SAAS,SAAS,WACvC,UAAsB,SAAS,SAAS,eAC3C;AACA,UAAM,IAAI;AAAA,MACR;AAAA,IAEF;AAAA,EACF;AACA,QAAM,gBAAgB,uBAAkB,WAAW,KAAK;AACxD,WAAS,IAAI,GAAG,IAAI,cAAc,QAAQ,EAAE,GAAG;AAC7C,UAAM,eAAe,cAAc,CAAC;AACpC,YAAQ,SAAS,KAAK,MAAM,CAAC,aAAa,CAAC,GAAG,aAAa,CAAC,CAAC,CAAC,CAAC;AAAA,EACjE;AACA,SAAO;AACT;AAvBS;AA0BT,IAAO,qBAAQ","sourcesContent":["import {\n  Feature,\n  FeatureCollection,\n  LineString,\n  MultiLineString,\n  MultiPolygon,\n  Point,\n  Polygon,\n} from \"geojson\";\nimport { point } from \"@turf/helpers\";\nimport { sweeplineIntersections as findIntersections } from \"./lib/sweepline-intersections-export.js\";\n\n/**\n * Takes a {@link LineString|linestring}, {@link MultiLineString|multi-linestring},\n * {@link MultiPolygon|multi-polygon} or {@link Polygon|polygon} and\n * returns {@link Point|points} at all self-intersections.\n *\n * @name kinks\n * @param {Feature<LineString|MultiLineString|MultiPolygon|Polygon>} featureIn input feature\n * @returns {FeatureCollection<Point>} self-intersections\n * @example\n * var poly = turf.polygon([[\n *   [-12.034835, 8.901183],\n *   [-12.060413, 8.899826],\n *   [-12.03638, 8.873199],\n *   [-12.059383, 8.871418],\n *   [-12.034835, 8.901183]\n * ]]);\n *\n * var kinks = turf.kinks(poly);\n *\n * //addToMap\n * var addToMap = [poly, kinks]\n */\nfunction kinks<T extends LineString | MultiLineString | Polygon | MultiPolygon>(\n  featureIn: Feature<T>\n): FeatureCollection<Point> {\n  const results: FeatureCollection<Point> = {\n    type: \"FeatureCollection\",\n    features: [],\n  };\n  if (\n    featureIn.type === \"Feature\" &&\n    ((featureIn as Feature).geometry.type === \"Point\" ||\n      (featureIn as Feature).geometry.type === \"MultiPoint\")\n  ) {\n    throw new Error(\n      \"Input must be a LineString, MultiLineString, \" +\n        \"Polygon, or MultiPolygon Feature or Geometry\"\n    );\n  }\n  const intersections = findIntersections(featureIn, false);\n  for (let i = 0; i < intersections.length; ++i) {\n    const intersection = intersections[i];\n    results.features.push(point([intersection[0], intersection[1]]));\n  }\n  return results;\n}\n\nexport { kinks };\nexport default kinks;\n","// Get around problems with moduleResolution node16 and some older libraries.\n// Manifests as \"This expression is not callable ... has no call signatures\"\n// https://stackoverflow.com/a/74709714\n\nimport lib from \"sweepline-intersections\";\n\nexport const sweeplineIntersections = lib as unknown as typeof lib.default;\n"]}

package/dist/cjs/index.d.cts

@@ -0,0 +1,27 @@
+import { LineString, MultiLineString, Polygon, MultiPolygon, Feature, FeatureCollection, Point } from 'geojson';
+
+/**
+ * Takes a {@link LineString|linestring}, {@link MultiLineString|multi-linestring},
+ * {@link MultiPolygon|multi-polygon} or {@link Polygon|polygon} and
+ * returns {@link Point|points} at all self-intersections.
+ *
+ * @name kinks
+ * @param {Feature<LineString|MultiLineString|MultiPolygon|Polygon>} featureIn input feature
+ * @returns {FeatureCollection<Point>} self-intersections
+ * @example
+ * var poly = turf.polygon([[
+ *   [-12.034835, 8.901183],
+ *   [-12.060413, 8.899826],
+ *   [-12.03638, 8.873199],
+ *   [-12.059383, 8.871418],
+ *   [-12.034835, 8.901183]
+ * ]]);
+ *
+ * var kinks = turf.kinks(poly);
+ *
+ * //addToMap
+ * var addToMap = [poly, kinks]
+ */
+declare function kinks<T extends LineString | MultiLineString | Polygon | MultiPolygon>(featureIn: Feature<T>): FeatureCollection<Point>;
+
+export { kinks as default, kinks };

package/dist/{js → esm}/index.d.ts

@@ -1,4 +1,5 @@
-import { Feature, FeatureCollection, LineString, MultiLineString, MultiPolygon, Point, Polygon } from "geojson";
+import { LineString, MultiLineString, Polygon, MultiPolygon, Feature, FeatureCollection, Point } from 'geojson';
+
 /**
  * Takes a {@link LineString|linestring}, {@link MultiLineString|multi-linestring},
  * {@link MultiPolygon|multi-polygon} or {@link Polygon|polygon} and
@@ -21,4 +22,6 @@ import { Feature, FeatureCollection, LineString, MultiLineString, MultiPolygon,
  * //addToMap
  * var addToMap = [poly, kinks]
  */
-export default function kinks<T extends LineString | MultiLineString | Polygon | MultiPolygon>(featureIn: Feature<T>): FeatureCollection<Point>;
+declare function kinks<T extends LineString | MultiLineString | Polygon | MultiPolygon>(featureIn: Feature<T>): FeatureCollection<Point>;
+
+export { kinks as default, kinks };

package/dist/esm/index.js

@@ -0,0 +1,35 @@
+var __defProp = Object.defineProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+
+// index.ts
+import { point } from "@turf/helpers";
+
+// lib/sweepline-intersections-export.ts
+import lib from "sweepline-intersections";
+var sweeplineIntersections = lib;
+
+// index.ts
+function kinks(featureIn) {
+  const results = {
+    type: "FeatureCollection",
+    features: []
+  };
+  if (featureIn.type === "Feature" && (featureIn.geometry.type === "Point" || featureIn.geometry.type === "MultiPoint")) {
+    throw new Error(
+      "Input must be a LineString, MultiLineString, Polygon, or MultiPolygon Feature or Geometry"
+    );
+  }
+  const intersections = sweeplineIntersections(featureIn, false);
+  for (let i = 0; i < intersections.length; ++i) {
+    const intersection = intersections[i];
+    results.features.push(point([intersection[0], intersection[1]]));
+  }
+  return results;
+}
+__name(kinks, "kinks");
+var turf_kinks_default = kinks;
+export {
+  turf_kinks_default as default,
+  kinks
+};
+//# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../index.ts","../../lib/sweepline-intersections-export.ts"],"sourcesContent":["import {\n  Feature,\n  FeatureCollection,\n  LineString,\n  MultiLineString,\n  MultiPolygon,\n  Point,\n  Polygon,\n} from \"geojson\";\nimport { point } from \"@turf/helpers\";\nimport { sweeplineIntersections as findIntersections } from \"./lib/sweepline-intersections-export.js\";\n\n/**\n * Takes a {@link LineString|linestring}, {@link MultiLineString|multi-linestring},\n * {@link MultiPolygon|multi-polygon} or {@link Polygon|polygon} and\n * returns {@link Point|points} at all self-intersections.\n *\n * @name kinks\n * @param {Feature<LineString|MultiLineString|MultiPolygon|Polygon>} featureIn input feature\n * @returns {FeatureCollection<Point>} self-intersections\n * @example\n * var poly = turf.polygon([[\n *   [-12.034835, 8.901183],\n *   [-12.060413, 8.899826],\n *   [-12.03638, 8.873199],\n *   [-12.059383, 8.871418],\n *   [-12.034835, 8.901183]\n * ]]);\n *\n * var kinks = turf.kinks(poly);\n *\n * //addToMap\n * var addToMap = [poly, kinks]\n */\nfunction kinks<T extends LineString | MultiLineString | Polygon | MultiPolygon>(\n  featureIn: Feature<T>\n): FeatureCollection<Point> {\n  const results: FeatureCollection<Point> = {\n    type: \"FeatureCollection\",\n    features: [],\n  };\n  if (\n    featureIn.type === \"Feature\" &&\n    ((featureIn as Feature).geometry.type === \"Point\" ||\n      (featureIn as Feature).geometry.type === \"MultiPoint\")\n  ) {\n    throw new Error(\n      \"Input must be a LineString, MultiLineString, \" +\n        \"Polygon, or MultiPolygon Feature or Geometry\"\n    );\n  }\n  const intersections = findIntersections(featureIn, false);\n  for (let i = 0; i < intersections.length; ++i) {\n    const intersection = intersections[i];\n    results.features.push(point([intersection[0], intersection[1]]));\n  }\n  return results;\n}\n\nexport { kinks };\nexport default kinks;\n","// Get around problems with moduleResolution node16 and some older libraries.\n// Manifests as \"This expression is not callable ... has no call signatures\"\n// https://stackoverflow.com/a/74709714\n\nimport lib from \"sweepline-intersections\";\n\nexport const sweeplineIntersections = lib as unknown as typeof lib.default;\n"],"mappings":";;;;AASA,SAAS,aAAa;;;ACLtB,OAAO,SAAS;AAET,IAAM,yBAAyB;;;AD4BtC,SAAS,MACP,WAC0B;AAC1B,QAAM,UAAoC;AAAA,IACxC,MAAM;AAAA,IACN,UAAU,CAAC;AAAA,EACb;AACA,MACE,UAAU,SAAS,cACjB,UAAsB,SAAS,SAAS,WACvC,UAAsB,SAAS,SAAS,eAC3C;AACA,UAAM,IAAI;AAAA,MACR;AAAA,IAEF;AAAA,EACF;AACA,QAAM,gBAAgB,uBAAkB,WAAW,KAAK;AACxD,WAAS,IAAI,GAAG,IAAI,cAAc,QAAQ,EAAE,GAAG;AAC7C,UAAM,eAAe,cAAc,CAAC;AACpC,YAAQ,SAAS,KAAK,MAAM,CAAC,aAAa,CAAC,GAAG,aAAa,CAAC,CAAC,CAAC,CAAC;AAAA,EACjE;AACA,SAAO;AACT;AAvBS;AA0BT,IAAO,qBAAQ;","names":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@turf/kinks",
-  "version": "7.0.0-alpha.2",
+  "version": "7.0.0",
   "description": "turf kinks module",
   "author": "Turf Authors",
   "license": "MIT",
@@ -21,45 +21,52 @@
     "kinks",
     "self-intersection"
   ],
-  "main": "dist/js/index.js",
-  "module": "dist/es/index.js",
+  "type": "module",
+  "main": "dist/cjs/index.cjs",
+  "module": "dist/esm/index.js",
+  "types": "dist/esm/index.d.ts",
   "exports": {
     "./package.json": "./package.json",
     ".": {
-      "types": "./dist/js/index.d.ts",
-      "import": "./dist/es/index.js",
-      "require": "./dist/js/index.js"
+      "import": {
+        "types": "./dist/esm/index.d.ts",
+        "default": "./dist/esm/index.js"
+      },
+      "require": {
+        "types": "./dist/cjs/index.d.cts",
+        "default": "./dist/cjs/index.cjs"
+      }
     }
   },
-  "types": "dist/js/index.d.ts",
   "sideEffects": false,
   "files": [
     "dist"
   ],
   "scripts": {
-    "bench": "tsx bench.js",
-    "build": "npm-run-all build:*",
-    "build:es": "tsc --outDir dist/es --module esnext --declaration false && echo '{\"type\":\"module\"}' > dist/es/package.json",
-    "build:js": "tsc",
-    "docs": "tsx ../../scripts/generate-readmes",
-    "test": "npm-run-all test:*",
-    "test:tape": "tsx test.js",
-    "test:types": "tsc --esModuleInterop --noEmit --strict types.ts"
+    "bench": "tsx bench.ts",
+    "build": "tsup --config ../../tsup.config.ts",
+    "docs": "tsx ../../scripts/generate-readmes.ts",
+    "test": "npm-run-all --npm-path npm test:*",
+    "test:tape": "tsx test.ts",
+    "test:types": "tsc --esModuleInterop --module node16 --moduleResolution node16 --noEmit --strict types.ts"
   },
   "devDependencies": {
-    "@turf/meta": "^7.0.0-alpha.2",
-    "benchmark": "*",
-    "load-json-file": "*",
-    "npm-run-all": "*",
-    "tape": "*",
-    "tsx": "*",
-    "typescript": "*",
-    "write-json-file": "*"
+    "@turf/meta": "^7.0.0",
+    "@types/benchmark": "^2.1.5",
+    "@types/tape": "^4.2.32",
+    "benchmark": "^2.1.4",
+    "load-json-file": "^7.0.1",
+    "npm-run-all": "^4.1.5",
+    "tape": "^5.7.2",
+    "tsup": "^8.0.1",
+    "tsx": "^4.6.2",
+    "typescript": "^5.2.2",
+    "write-json-file": "^5.0.0"
   },
   "dependencies": {
-    "@turf/helpers": "^7.0.0-alpha.2",
+    "@turf/helpers": "^7.0.0",
     "sweepline-intersections": "^1.5.0",
-    "tslib": "^2.3.0"
+    "tslib": "^2.6.2"
   },
-  "gitHead": "dd35b52725945b4fa29a98d9a550733e06cc222e"
+  "gitHead": "3d3a7917025fbabe191dbddbc89754b86f9c7739"
 }

package/dist/es/index.js

@@ -1,42 +0,0 @@
-import findIntersections from "sweepline-intersections";
-import { point } from "@turf/helpers";
-/**
- * Takes a {@link LineString|linestring}, {@link MultiLineString|multi-linestring},
- * {@link MultiPolygon|multi-polygon} or {@link Polygon|polygon} and
- * returns {@link Point|points} at all self-intersections.
- *
- * @name kinks
- * @param {Feature<LineString|MultiLineString|MultiPolygon|Polygon>} featureIn input feature
- * @returns {FeatureCollection<Point>} self-intersections
- * @example
- * var poly = turf.polygon([[
- *   [-12.034835, 8.901183],
- *   [-12.060413, 8.899826],
- *   [-12.03638, 8.873199],
- *   [-12.059383, 8.871418],
- *   [-12.034835, 8.901183]
- * ]]);
- *
- * var kinks = turf.kinks(poly);
- *
- * //addToMap
- * var addToMap = [poly, kinks]
- */
-export default function kinks(featureIn) {
-    const results = {
-        type: "FeatureCollection",
-        features: [],
-    };
-    if (featureIn.type === "Feature" &&
-        (featureIn.geometry.type === "Point" ||
-            featureIn.geometry.type === "MultiPoint")) {
-        throw new Error("Input must be a LineString, MultiLineString, " +
-            "Polygon, or MultiPolygon Feature or Geometry");
-    }
-    const intersections = findIntersections(featureIn, false);
-    for (let i = 0; i < intersections.length; ++i) {
-        const intersection = intersections[i];
-        results.features.push(point([intersection[0], intersection[1]]));
-    }
-    return results;
-}

package/dist/es/package.json

@@ -1 +0,0 @@
-{"type":"module"}

package/dist/js/index.js

@@ -1,46 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-const sweepline_intersections_1 = tslib_1.__importDefault(require("sweepline-intersections"));
-const helpers_1 = require("@turf/helpers");
-/**
- * Takes a {@link LineString|linestring}, {@link MultiLineString|multi-linestring},
- * {@link MultiPolygon|multi-polygon} or {@link Polygon|polygon} and
- * returns {@link Point|points} at all self-intersections.
- *
- * @name kinks
- * @param {Feature<LineString|MultiLineString|MultiPolygon|Polygon>} featureIn input feature
- * @returns {FeatureCollection<Point>} self-intersections
- * @example
- * var poly = turf.polygon([[
- *   [-12.034835, 8.901183],
- *   [-12.060413, 8.899826],
- *   [-12.03638, 8.873199],
- *   [-12.059383, 8.871418],
- *   [-12.034835, 8.901183]
- * ]]);
- *
- * var kinks = turf.kinks(poly);
- *
- * //addToMap
- * var addToMap = [poly, kinks]
- */
-function kinks(featureIn) {
-    const results = {
-        type: "FeatureCollection",
-        features: [],
-    };
-    if (featureIn.type === "Feature" &&
-        (featureIn.geometry.type === "Point" ||
-            featureIn.geometry.type === "MultiPoint")) {
-        throw new Error("Input must be a LineString, MultiLineString, " +
-            "Polygon, or MultiPolygon Feature or Geometry");
-    }
-    const intersections = sweepline_intersections_1.default(featureIn, false);
-    for (let i = 0; i < intersections.length; ++i) {
-        const intersection = intersections[i];
-        results.features.push(helpers_1.point([intersection[0], intersection[1]]));
-    }
-    return results;
-}
-exports.default = kinks;