webdggrid 1.0.3 → 1.0.5

package/src-ts/webdggrid.ts

@@ -1,6 +1,6 @@
 // @ts-ignore
 import { loadWasm, unloadWasm } from './libdggrid.wasm.js';
-
+import { Feature, FeatureCollection, GeoJsonProperties, Polygon, Position } from 'geojson';
 /**
  * Cell Topology
  *
@@ -24,11 +24,27 @@ export enum Projection {
     'FULLER' = 'FULLER',
 }
 
+/**
+ * A geographic coordinate
+ */
 export interface Coordinate {
     lat: number;
     lng: number;
 }
 
+/**
+ * Geojson properties type.
+ * TODO: Better handeling the types
+ */
+export type DGGSGeoJsonProperty = GeoJsonProperties & {
+    /**
+     * It stores the seq number if exists
+     */
+    id?: BigInt;
+    i?: BigInt;
+    j?: BigInt;
+}
+
 export interface IDGGSProps {
     poleCoordinates: Coordinate;
     azimuth: number;
@@ -259,7 +275,7 @@ export class Webdggrid {
     sequenceNumToGeo(
         sequenceNum: bigint[],
         resolution: number = DEFAULT_RESOLUTION
-    ): number[][] {
+    ): Position[] {
         const {
             poleCoordinates: { lat, lng },
             azimuth,
@@ -279,10 +295,10 @@ export class Webdggrid {
             sequenceNum
         );
 
-        const size = resultArray.length/2;
-        const arrayOfArrays:number[][] = [];
+        const size = resultArray.length / 2;
+        const arrayOfArrays: number[][] = [];
         for (let i = 0; i < size; i += 1) {
-            arrayOfArrays.push([resultArray[i], resultArray[i+size]]);
+            arrayOfArrays.push([resultArray[i], resultArray[i + size]]);
         }
 
         return arrayOfArrays;
@@ -296,7 +312,7 @@ export class Webdggrid {
     geoToGeo(
         coordinates: number[][],
         resolution: number = DEFAULT_RESOLUTION
-    ): number[][] {
+    ): Position[] {
         const {
             poleCoordinates: { lat, lng },
             azimuth,
@@ -320,47 +336,106 @@ export class Webdggrid {
             yCoords
         );
 
-        const size = resultArray.length/2;
-        const arrayOfArrays:number[][] = [];
+        const size = resultArray.length / 2;
+        const arrayOfArrays: number[][] = [];
         for (let i = 0; i < size; i += 1) {
-            arrayOfArrays.push([resultArray[i], resultArray[i+size]]);
+            arrayOfArrays.push([resultArray[i], resultArray[i + size]]);
         }
 
         return arrayOfArrays;
     }
 
-    _is2dArray(array: any): boolean { return array.some((item: any) => Array.isArray(item)); }
-
-    _arrayToVector(array: any) {
-        const is2d = this._is2dArray(array);
-        if (is2d) {
-            const dDVector = new this._module.DoubleVectorVector();
-            array.forEach((item: any) => {
-                const dVector = new this._module.DoubleVector();
-                dVector.push_back(item[0]);
-                dVector.push_back(item[1]);
-                dDVector.push_back(dVector);
-            });
-            return dDVector;
-        }
-    }
-    _vectorToArray(vector: any) { return new Array(vector.size()).fill(0).map((_, id) => vector.get(id)); }
+    /**
+     * Convert an array of sequence numbers to the grid coordinates with format of `[lng,lat]`. The output is an array with the same
+     * size as input `sequenceNum` and it includes an array of `CoordinateLike` objects.
+     * @param sequenceNum 
+     * @param resolution  [resolution=DEFAULT_RESOLUTION]
+     * @returns An array of [lng,lat]
+     */
+    sequenceNumToGrid(
+        sequenceNum: bigint[],
+        resolution: number = DEFAULT_RESOLUTION
+    ): Position[][] {
+        const {
+            poleCoordinates: { lat, lng },
+            azimuth,
+            topology,
+            projection,
+            aperture,
+        } = this.dggs;
 
-    _wVectorToArray = (vector: any) => {
-        if (vector.size() === 0) {
-            return [];
+        let resultArray = [];
+        try {
+            resultArray = this._module.SeqNumGrid(
+                lat,
+                lng,
+                azimuth,
+                aperture,
+                resolution,
+                topology,
+                projection,
+                sequenceNum
+            );
+        } catch (e) {
+            console.error(this._module.getExceptionMessage(e).toString());
+            throw(e);
         }
 
-        const objectType = vector.$$.ptrType.name;
+        const inputSize = sequenceNum.length;
+
+        const allShapeVertexes = resultArray.slice(0, inputSize);
 
-        switch (objectType) {
-            case 'BigIntegerVector*':
-                return this._vectorToArray(vector);
+        const sumVertexes = allShapeVertexes.reduce((accumulator, currentValue) => {
+            return accumulator + currentValue;
+        }, 0);
 
-            default:
-                return [];
+        const featureSet: Position[][] = [];
+
+        let xOffset = inputSize;
+        let yOffset = inputSize + sumVertexes;
+        for (let i = 0; i < allShapeVertexes.length; i += 1) {
+            const numVertexes = allShapeVertexes[i];
+
+            const currentShapeXVertexes = resultArray.slice(xOffset, xOffset + numVertexes);
+            const currentShapeYVertexes = resultArray.slice(yOffset, yOffset + numVertexes);
+
+            const coordinates: Position[] = [];
+            for (let i = 0; i < numVertexes; i += 1) {
+                coordinates.push([currentShapeXVertexes[i], currentShapeYVertexes[i]]);
+            }
+            featureSet.push(coordinates);
+            xOffset += numVertexes;
+            yOffset += numVertexes;
         }
-    };
 
-    // _extractColumn(arr: any, column: number) { return arr.map((x: any) => x[column]); }
+        return featureSet;
+    }
+
+    sequenceNumToGridFeatureCollection(
+        sequenceNum: bigint[],
+        resolution: number = DEFAULT_RESOLUTION
+    ): FeatureCollection<Polygon, DGGSGeoJsonProperty> {
+
+        const coordinatesArray = this.sequenceNumToGrid(sequenceNum, resolution);
+
+        const features = coordinatesArray.map((coordinates, index) => {
+            const seqNum = sequenceNum[index];
+            return {
+                type: 'Feature',
+                geometry: {
+                    type: 'Polygon',
+                    coordinates: [coordinates]
+                },
+                id: seqNum as unknown as number,
+                properties: {
+                    id: seqNum
+                } as DGGSGeoJsonProperty
+            } as Feature<Polygon, DGGSGeoJsonProperty>;
+        });
+
+        return {
+            type: 'FeatureCollection',
+            features,
+        };
+    }
 }

package/types/webdggrid.d.ts

@@ -1,3 +1,4 @@
+import { FeatureCollection, GeoJsonProperties, Polygon, Position } from 'geojson';
 /**
  * Cell Topology
  *
@@ -20,10 +21,25 @@ export declare enum Projection {
     'ISEA' = "ISEA",
     'FULLER' = "FULLER"
 }
+/**
+ * A geographic coordinate
+ */
 export interface Coordinate {
     lat: number;
     lng: number;
 }
+/**
+ * Geojson properties type.
+ * TODO: Better handeling the types
+ */
+export type DGGSGeoJsonProperty = GeoJsonProperties & {
+    /**
+     * It stores the seq number if exists
+     */
+    id?: BigInt;
+    i?: BigInt;
+    j?: BigInt;
+};
 export interface IDGGSProps {
     poleCoordinates: Coordinate;
     azimuth: number;
@@ -102,17 +118,22 @@ export declare class Webdggrid {
      * @param resolution  [resolution=DEFAULT_RESOLUTION]
      * @returns An array of [lng,lat]
      */
-    sequenceNumToGeo(sequenceNum: bigint[], resolution?: number): number[][];
+    sequenceNumToGeo(sequenceNum: bigint[], resolution?: number): Position[];
     /**
      * Converts a set of coordinates to the cell centroid values
      * @param coordinates A 2d array of lng and lat values
      * @param resolution  [resolution=DEFAULT_RESOLUTION] The resolution of the dggs
      * @returns An array of dggs cell centroid coordinates
      */
-    geoToGeo(coordinates: number[][], resolution?: number): number[][];
-    _is2dArray(array: any): boolean;
-    _arrayToVector(array: any): any;
-    _vectorToArray(vector: any): any[];
-    _wVectorToArray: (vector: any) => any[];
+    geoToGeo(coordinates: number[][], resolution?: number): Position[];
+    /**
+     * Convert an array of sequence numbers to the grid coordinates with format of `[lng,lat]`. The output is an array with the same
+     * size as input `sequenceNum` and it includes an array of `CoordinateLike` objects.
+     * @param sequenceNum
+     * @param resolution  [resolution=DEFAULT_RESOLUTION]
+     * @returns An array of [lng,lat]
+     */
+    sequenceNumToGrid(sequenceNum: bigint[], resolution?: number): Position[][];
+    sequenceNumToGridFeatureCollection(sequenceNum: bigint[], resolution?: number): FeatureCollection<Polygon, DGGSGeoJsonProperty>;
 }
 //# sourceMappingURL=webdggrid.d.ts.map

package/types/webdggrid.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"webdggrid.d.ts","sourceRoot":"","sources":["../src-ts/webdggrid.ts"],"names":[],"mappings":"AAGA;;;;;GAKG;AACH,oBAAY,QAAQ;IAChB,SAAS,YAAY;IACrB,UAAU,aAAa;IACvB,QAAQ,WAAW;IACnB,SAAS,YAAY;CACxB;AACD;;;;;GAKG;AACH,oBAAY,UAAU;IAClB,MAAM,SAAS;IACf,QAAQ,WAAW;CACtB;AAED,MAAM,WAAW,UAAU;IACvB,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,UAAU;IACvB,eAAe,EAAE,UAAU,CAAC;IAC5B,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IACxB,QAAQ,EAAE,QAAQ,CAAC;IACnB,UAAU,EAAE,UAAU,CAAC;CAC1B;AAWD,qBAAa,SAAS;IAKE,SAAS,CAAC,OAAO,EAAE,GAAG;IAH1C,IAAI,EAAE,UAAU,CAAgB;IAChC,UAAU,EAAE,MAAM,CAAsB;IAExC,OAAO;IAKP;;;;;;;;OAQG;IACH,MAAM,CAAC,IAAI,IAAI,OAAO,CAAC,OAAO,SAAS,CAAC;IAMxC;;OAEG;IACH,MAAM,CAAC,MAAM;IAIb;;OAEG;IACH,OAAO,IAAI,MAAM;IAIjB;;;OAGG;IACH,OAAO,CAAC,IAAI,GAAE,UAAyB,EAAE,UAAU,GAAE,MAA2B;IAKhF;;;;OAIG;IACH,aAAa,IAAI,MAAM;IAGvB;;;;OAIG;IACH,aAAa,CAAC,UAAU,EAAE,MAAM;IAIhC;;;;;OAKG;IACH,KAAK;IAIL;;;;;;OAMG;IACH,MAAM,CAAC,UAAU,GAAE,MAA2B,GAAG,MAAM;IAsBvD,UAAU,CAAC,UAAU,GAAE,MAA2B,GAAG,MAAM;IAsB3D,UAAU,CAAC,UAAU,GAAE,MAA2B,GAAG,MAAM;IAsB3D,WAAW,CAAC,UAAU,GAAE,MAA2B,GAAG,MAAM;IAqB5D;;;;;OAKG;IACH,gBAAgB,CACZ,WAAW,EAAE,MAAM,EAAE,EAAE,EACvB,UAAU,GAAE,MAA2B,GACxC,MAAM,EAAE;IA0BX;;;;;OAKG;IACH,gBAAgB,CACZ,WAAW,EAAE,MAAM,EAAE,EACrB,UAAU,GAAE,MAA2B,GACxC,MAAM,EAAE,EAAE;IA4Bb;;;;;OAKG;IACH,QAAQ,CACJ,WAAW,EAAE,MAAM,EAAE,EAAE,EACvB,UAAU,GAAE,MAA2B,GACxC,MAAM,EAAE,EAAE;IAiCb,UAAU,CAAC,KAAK,EAAE,GAAG,GAAG,OAAO;IAE/B,cAAc,CAAC,KAAK,EAAE,GAAG;IAazB,cAAc,CAAC,MAAM,EAAE,GAAG;IAE1B,eAAe,WAAY,GAAG,WAc5B;CAGL"}
+{"version":3,"file":"webdggrid.d.ts","sourceRoot":"","sources":["../src-ts/webdggrid.ts"],"names":[],"mappings":"AAEA,OAAO,EAAW,iBAAiB,EAAE,iBAAiB,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAC3F;;;;;GAKG;AACH,oBAAY,QAAQ;IAChB,SAAS,YAAY;IACrB,UAAU,aAAa;IACvB,QAAQ,WAAW;IACnB,SAAS,YAAY;CACxB;AACD;;;;;GAKG;AACH,oBAAY,UAAU;IAClB,MAAM,SAAS;IACf,QAAQ,WAAW;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IACvB,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;CACf;AAED;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAAG,iBAAiB,GAAG;IAClD;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,CAAC,CAAC,EAAE,MAAM,CAAC;IACX,CAAC,CAAC,EAAE,MAAM,CAAC;CACd,CAAA;AAED,MAAM,WAAW,UAAU;IACvB,eAAe,EAAE,UAAU,CAAC;IAC5B,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IACxB,QAAQ,EAAE,QAAQ,CAAC;IACnB,UAAU,EAAE,UAAU,CAAC;CAC1B;AAWD,qBAAa,SAAS;IAKE,SAAS,CAAC,OAAO,EAAE,GAAG;IAH1C,IAAI,EAAE,UAAU,CAAgB;IAChC,UAAU,EAAE,MAAM,CAAsB;IAExC,OAAO;IAKP;;;;;;;;OAQG;IACH,MAAM,CAAC,IAAI,IAAI,OAAO,CAAC,OAAO,SAAS,CAAC;IAMxC;;OAEG;IACH,MAAM,CAAC,MAAM;IAIb;;OAEG;IACH,OAAO,IAAI,MAAM;IAIjB;;;OAGG;IACH,OAAO,CAAC,IAAI,GAAE,UAAyB,EAAE,UAAU,GAAE,MAA2B;IAKhF;;;;OAIG;IACH,aAAa,IAAI,MAAM;IAGvB;;;;OAIG;IACH,aAAa,CAAC,UAAU,EAAE,MAAM;IAIhC;;;;;OAKG;IACH,KAAK;IAIL;;;;;;OAMG;IACH,MAAM,CAAC,UAAU,GAAE,MAA2B,GAAG,MAAM;IAsBvD,UAAU,CAAC,UAAU,GAAE,MAA2B,GAAG,MAAM;IAsB3D,UAAU,CAAC,UAAU,GAAE,MAA2B,GAAG,MAAM;IAsB3D,WAAW,CAAC,UAAU,GAAE,MAA2B,GAAG,MAAM;IAqB5D;;;;;OAKG;IACH,gBAAgB,CACZ,WAAW,EAAE,MAAM,EAAE,EAAE,EACvB,UAAU,GAAE,MAA2B,GACxC,MAAM,EAAE;IA0BX;;;;;OAKG;IACH,gBAAgB,CACZ,WAAW,EAAE,MAAM,EAAE,EACrB,UAAU,GAAE,MAA2B,GACxC,QAAQ,EAAE;IA4Bb;;;;;OAKG;IACH,QAAQ,CACJ,WAAW,EAAE,MAAM,EAAE,EAAE,EACvB,UAAU,GAAE,MAA2B,GACxC,QAAQ,EAAE;IAiCb;;;;;;OAMG;IACH,iBAAiB,CACb,WAAW,EAAE,MAAM,EAAE,EACrB,UAAU,GAAE,MAA2B,GACxC,QAAQ,EAAE,EAAE;IAwDf,kCAAkC,CAC9B,WAAW,EAAE,MAAM,EAAE,EACrB,UAAU,GAAE,MAA2B,GACxC,iBAAiB,CAAC,OAAO,EAAE,mBAAmB,CAAC;CAwBrD"}