@placemarkio/polyline 1.1.1 → 2.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Placemark
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,4 +1,10 @@
-# polyline
+# @placemarkio/polyline
+
+[![npm version](https://badge.fury.io/js/@placemarkio%2Fpolyline.svg)](https://badge.fury.io/js/@placemarkio%2Fpolyline)
+
+```
+@placemarkio/polyline
+```
 
 _polyline development is supported by 🌎 [placemark.io](https://placemark.io/)_
 

package/dist/{polyline.cjs → index.cjs}

@@ -1,8 +1,9 @@
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
-const factor = 100000; // Math.pow(10, 5);
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.decode = decode;
+exports.encode = encode;
+exports.geoJSONToPolyline = geoJSONToPolyline;
+exports.polylineToGeoJSON = polylineToGeoJSON;
 // https://github.com/mapbox/polyline/blob/master/src/polyline.js
 // Based off of [the offical Google document](https://developers.google.com/maps/documentation/utilities/polylinealgorithm)
 //
@@ -39,7 +40,8 @@ function resultChange(result) {
  * with an arbitrary string, it'll produce coordinates well
  * outside of the normal range.
  */
-function decode(str) {
+function decode(str, precision = 5) {
+    const factor = 10 ** precision;
     let index = 0;
     let lat = 0;
     let lng = 0;
@@ -82,10 +84,11 @@ function decode(str) {
  * @param coordinates Coordinates, in longitude, latitude order
  * @returns encoded polyline
  */
-function encode(coordinates) {
+function encode(coordinates, precision = 5) {
     if (!coordinates.length) {
         return "";
     }
+    const factor = 10 ** precision;
     let output = encodeNumber(coordinates[0][1], 0, factor) +
         encodeNumber(coordinates[0][0], 0, factor);
     for (let i = 1; i < coordinates.length; i++) {
@@ -101,24 +104,19 @@ function encode(coordinates) {
  *
  * @param geojson A LineString
  */
-function geoJSONToPolyline(geojson) {
-    return encode(geojson.coordinates);
+function geoJSONToPolyline(geojson, precision = 5) {
+    return encode(geojson.coordinates, precision);
 }
 /**
  * Decodes to a GeoJSON LineString geometry.
  *
  * @param str An encoded polyline as a string.
  */
-function polylineToGeoJSON(str) {
-    const coords = decode(str);
+function polylineToGeoJSON(str, precision = 5) {
+    const coords = decode(str, precision);
     return {
         type: "LineString",
         coordinates: coords,
     };
 }
-
-exports.decode = decode;
-exports.encode = encode;
-exports.geoJSONToPolyline = geoJSONToPolyline;
-exports.polylineToGeoJSON = polylineToGeoJSON;
-//# sourceMappingURL=polyline.cjs.map
+//# sourceMappingURL=index.js.map

package/dist/index.d.cts

@@ -0,0 +1,29 @@
+import type { LineString, Position } from "geojson";
+/**
+ * Decodes any string into a [longitude, latitude] coordinates array.
+ *
+ * Any string is a valid polyline, but if you provide this
+ * with an arbitrary string, it'll produce coordinates well
+ * outside of the normal range.
+ */
+export declare function decode(str: string, precision?: number): Position[];
+/**
+ * Encodes the given [latitude, longitude] coordinates array.
+ *
+ * @param coordinates Coordinates, in longitude, latitude order
+ * @returns encoded polyline
+ */
+export declare function encode(coordinates: number[][], precision?: number): string;
+/**
+ * Encodes a GeoJSON LineString feature/geometry.
+ *
+ * @param geojson A LineString
+ */
+export declare function geoJSONToPolyline(geojson: LineString, precision?: number): string;
+/**
+ * Decodes to a GeoJSON LineString geometry.
+ *
+ * @param str An encoded polyline as a string.
+ */
+export declare function polylineToGeoJSON(str: string, precision?: number): LineString;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts

@@ -6,23 +6,24 @@ import type { LineString, Position } from "geojson";
  * with an arbitrary string, it'll produce coordinates well
  * outside of the normal range.
  */
-export declare function decode(str: string): Position[];
+export declare function decode(str: string, precision?: number): Position[];
 /**
  * Encodes the given [latitude, longitude] coordinates array.
  *
  * @param coordinates Coordinates, in longitude, latitude order
  * @returns encoded polyline
  */
-export declare function encode(coordinates: number[][]): string;
+export declare function encode(coordinates: number[][], precision?: number): string;
 /**
  * Encodes a GeoJSON LineString feature/geometry.
  *
  * @param geojson A LineString
  */
-export declare function geoJSONToPolyline(geojson: LineString): string;
+export declare function geoJSONToPolyline(geojson: LineString, precision?: number): string;
 /**
  * Decodes to a GeoJSON LineString geometry.
  *
  * @param str An encoded polyline as a string.
  */
-export declare function polylineToGeoJSON(str: string): LineString;
+export declare function polylineToGeoJSON(str: string, precision?: number): LineString;
+//# sourceMappingURL=index.d.ts.map

package/dist/{polyline.es.mjs → index.js}

@@ -1,4 +1,3 @@
-const factor = 100000; // Math.pow(10, 5);
 // https://github.com/mapbox/polyline/blob/master/src/polyline.js
 // Based off of [the offical Google document](https://developers.google.com/maps/documentation/utilities/polylinealgorithm)
 //
@@ -35,7 +34,8 @@ function resultChange(result) {
  * with an arbitrary string, it'll produce coordinates well
  * outside of the normal range.
  */
-function decode(str) {
+export function decode(str, precision = 5) {
+    const factor = 10 ** precision;
     let index = 0;
     let lat = 0;
     let lng = 0;
@@ -78,10 +78,11 @@ function decode(str) {
  * @param coordinates Coordinates, in longitude, latitude order
  * @returns encoded polyline
  */
-function encode(coordinates) {
+export function encode(coordinates, precision = 5) {
     if (!coordinates.length) {
         return "";
     }
+    const factor = 10 ** precision;
     let output = encodeNumber(coordinates[0][1], 0, factor) +
         encodeNumber(coordinates[0][0], 0, factor);
     for (let i = 1; i < coordinates.length; i++) {
@@ -97,21 +98,19 @@ function encode(coordinates) {
  *
  * @param geojson A LineString
  */
-function geoJSONToPolyline(geojson) {
-    return encode(geojson.coordinates);
+export function geoJSONToPolyline(geojson, precision = 5) {
+    return encode(geojson.coordinates, precision);
 }
 /**
  * Decodes to a GeoJSON LineString geometry.
  *
  * @param str An encoded polyline as a string.
  */
-function polylineToGeoJSON(str) {
-    const coords = decode(str);
+export function polylineToGeoJSON(str, precision = 5) {
+    const coords = decode(str, precision);
     return {
         type: "LineString",
         coordinates: coords,
     };
 }
-
-export { decode, encode, geoJSONToPolyline, polylineToGeoJSON };
-//# sourceMappingURL=polyline.es.mjs.map
+//# sourceMappingURL=index.js.map