webdggrid 1.0.1

package/src-ts/webdggrid.ts

@@ -0,0 +1,366 @@
+// @ts-ignore
+import { loadWasm, unloadWasm } from './libdggrid.wasm.js';
+
+/**
+ * Cell Topology
+ *
+ * @export
+ * @enum {String}
+ */
+export enum Topology {
+    'HEXAGON' = 'HEXAGON',
+    'TRIANGLE' = 'TRIANGLE',
+    'SQUARE' = 'SQUARE',
+    'DIAMOND' = 'DIAMOND',
+}
+/**
+ * Projection type
+ *
+ * @export
+ * @enum {number}
+ */
+export enum Projection {
+    'ISEA' = 'ISEA',
+    'FULLER' = 'FULLER',
+}
+
+export interface Coordinate {
+    lat: number;
+    lng: number;
+}
+
+export interface IDGGSProps {
+    poleCoordinates: Coordinate;
+    azimuth: number;
+    aperture: 3 | 4 | 5 | 7;
+    topology: Topology;
+    projection: Projection;
+}
+
+const DEFAULT_RESOLUTION = 1;
+const DEFAULT_DGGS = {
+    poleCoordinates: { lat: 0, lng: 0 },
+    azimuth: 0,
+    topology: Topology.HEXAGON,
+    projection: Projection.ISEA,
+    aperture: 7
+} as IDGGSProps;
+
+export class Webdggrid {
+
+    dggs: IDGGSProps = DEFAULT_DGGS;
+    resolution: number = DEFAULT_RESOLUTION;
+
+    private constructor(protected _module: any) {
+        this._module = _module;
+
+    }
+
+    /**
+     * Compiles and instantiates the raw wasm.
+     * 
+     * ::: info
+     * In general WebAssembly compilation is disallowed on the main thread if the buffer size is larger than 4KB, hence forcing `load` to be asynchronous;
+     * :::
+     * 
+     * @returns A promise to an instance of the Webdggrid class.
+     */
+    static load(): Promise<typeof Webdggrid> {
+        return loadWasm().then((module: any) => {
+            return new Webdggrid(module);
+        }).catch(console.log);
+    }
+
+    /**
+     * Unloades the compiled wasm instance.
+     */
+    static unload() {
+        unloadWasm();
+    }
+
+    /**
+     * @returns The Webdggrid c++ version
+     */
+    version(): string {
+        return this._module.Webdggrid.prototype.version();
+    }
+
+    /**
+     * Set the main dggs configuration
+     * @param dggs A dggs object
+     */
+    setDggs(dggs: IDGGSProps = DEFAULT_DGGS, resolution: number = DEFAULT_RESOLUTION) {
+        this.dggs = dggs;
+        this.resolution = resolution;
+    }
+
+    /**
+     * Get the resolution of the current dggs
+     * @returns {number} the current dggs resolution
+     * @memberof WebDggrid
+     */
+    getResolution(): number {
+        return this.resolution;
+    }
+    /**
+     * Set the resolution of the dggs
+     * @param {number} [resolution=DEFAULT_RESOLUTION] the resolution. It should be a valid integer
+     * @memberof WebDggrid
+     */
+    setResolution(resolution: number) {
+        this.resolution = resolution;
+    }
+
+    /**
+     * test function
+     *
+     * @return {*} 
+     * @memberof WebDggrid
+     */
+    _main() {
+        return this._module._main();
+    }
+
+    /**
+     * @follow Hi
+     * Returns the number of the cells in specific resolution 
+     * @param {number} [resolution=DEFAULT_RESOLUTION]
+     * @return {number}  
+     * @memberof WebDggrid
+     */
+    nCells(resolution: number = DEFAULT_RESOLUTION): number {
+        const {
+            poleCoordinates: { lat, lng },
+            azimuth,
+            topology,
+            projection,
+            aperture,
+        } = this.dggs;
+
+        const cellCount = this._module.nCells(
+            lat,
+            lng,
+            azimuth,
+            aperture,
+            resolution,
+            topology,
+            projection
+        );
+
+        return cellCount as number;
+    }
+
+    cellAreaKM(resolution: number = DEFAULT_RESOLUTION): number {
+        const {
+            poleCoordinates: { lat, lng },
+            azimuth,
+            topology,
+            projection,
+            aperture,
+        } = this.dggs;
+
+        const cellCount = this._module.nCells(
+            lat,
+            lng,
+            azimuth,
+            aperture,
+            resolution,
+            topology,
+            projection
+        );
+
+        return cellCount as number;
+    }
+
+    cellDistKM(resolution: number = DEFAULT_RESOLUTION): number {
+        const {
+            poleCoordinates: { lat, lng },
+            azimuth,
+            topology,
+            projection,
+            aperture,
+        } = this.dggs;
+
+        const cellCount = this._module.nCells(
+            lat,
+            lng,
+            azimuth,
+            aperture,
+            resolution,
+            topology,
+            projection
+        );
+
+        return cellCount as number;
+    }
+
+    gridStatCLS(resolution: number = DEFAULT_RESOLUTION): number {
+        const {
+            poleCoordinates: { lat, lng },
+            azimuth,
+            topology,
+            projection,
+            aperture,
+        } = this.dggs;
+
+        const cellCount = this._module.nCells(
+            lat,
+            lng,
+            azimuth,
+            aperture,
+            resolution,
+            topology,
+            projection
+        );
+
+        return cellCount as number;
+    }
+    /**
+     * Converts an array of geography coordinates to the list of the sequence numbers AKA DggId
+     * @param coordinates A 2d array of [[lng, lat]] values
+     * @param resolution  [resolution=DEFAULT_RESOLUTION] The dggs resolution
+     * @returns An array of the DggIds 
+     */
+    geoToSequenceNum(
+        coordinates: number[][],
+        resolution: number = DEFAULT_RESOLUTION
+    ): bigint[] {
+        const {
+            poleCoordinates: { lat, lng },
+            azimuth,
+            topology,
+            projection,
+            aperture,
+        } = this.dggs;
+
+        const xCoords = coordinates.map((coord) => coord[0]);
+        const yCoords = coordinates.map((coord) => coord[1]);
+
+        const resultArray = this._module.DgGEO_to_SEQNUM(
+            lat,
+            lng,
+            azimuth,
+            aperture,
+            resolution,
+            topology,
+            projection,
+            xCoords,
+            yCoords
+        );
+
+        return resultArray;
+    }
+    /**
+     * Convert a sequence number to the [lng,lat] of the center of the related cell
+     * @param sequenceNum 
+     * @param resolution  [resolution=DEFAULT_RESOLUTION]
+     * @returns An array of [lng,lat]
+     */
+    sequenceNumToGeo(
+        sequenceNum: bigint[],
+        resolution: number = DEFAULT_RESOLUTION
+    ): number[][] {
+        const {
+            poleCoordinates: { lat, lng },
+            azimuth,
+            topology,
+            projection,
+            aperture,
+        } = this.dggs;
+
+        const resultArray = this._module.SEQNUM_to_GEO(
+            lat,
+            lng,
+            azimuth,
+            aperture,
+            resolution,
+            topology,
+            projection,
+            sequenceNum
+        );
+
+        const size = resultArray.length/2;
+        const arrayOfArrays:number[][] = [];
+        for (let i = 0; i < size; i += 1) {
+            arrayOfArrays.push([resultArray[i], resultArray[i+size]]);
+        }
+
+        return arrayOfArrays;
+    }
+    /**
+     * 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 = DEFAULT_RESOLUTION
+    ): number[][] {
+        const {
+            poleCoordinates: { lat, lng },
+            azimuth,
+            topology,
+            projection,
+            aperture,
+        } = this.dggs;
+
+        const xCoords = coordinates.map((coord) => coord[0]);
+        const yCoords = coordinates.map((coord) => coord[1]);
+
+        const resultArray = this._module.GEO_to_GEO(
+            lat,
+            lng,
+            azimuth,
+            aperture,
+            resolution,
+            topology,
+            projection,
+            xCoords,
+            yCoords
+        );
+
+        const size = resultArray.length/2;
+        const arrayOfArrays:number[][] = [];
+        for (let i = 0; i < size; i += 1) {
+            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)); }
+
+    _wVectorToArray = (vector: any) => {
+        if (vector.size() === 0) {
+            return [];
+        }
+
+        const objectType = vector.$$.ptrType.name;
+
+        switch (objectType) {
+            case 'BigIntegerVector*':
+                return this._vectorToArray(vector);
+
+            default:
+                return [];
+        }
+    };
+
+    // _extractColumn(arr: any, column: number) { return arr.map((x: any) => x[column]); }
+}

package/types/extract.d.ts

@@ -0,0 +1,2 @@
+export declare function extract(raw: string): Uint8Array;
+//# sourceMappingURL=extract.d.ts.map

package/types/extract.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"extract.d.ts","sourceRoot":"","sources":["../src-ts/extract.ts"],"names":[],"mappings":"AAuCA,wBAAgB,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,UAAU,CAG/C"}

package/types/index.d.ts

@@ -0,0 +1,4 @@
+export declare namespace Webdggrid {
+    function load(): Promise<typeof import("./webdggrid.js").Webdggrid>;
+}
+//# sourceMappingURL=index.d.ts.map

package/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src-ts/index.ts"],"names":[],"mappings":"AAAA,yBAAiB,SAAS,CAAC;IACzB,SAAgB,IAAI,uDAEnB;CACF"}

package/types/webdggrid.d.ts

@@ -0,0 +1,118 @@
+/**
+ * Cell Topology
+ *
+ * @export
+ * @enum {String}
+ */
+export declare enum Topology {
+    'HEXAGON' = "HEXAGON",
+    'TRIANGLE' = "TRIANGLE",
+    'SQUARE' = "SQUARE",
+    'DIAMOND' = "DIAMOND"
+}
+/**
+ * Projection type
+ *
+ * @export
+ * @enum {number}
+ */
+export declare enum Projection {
+    'ISEA' = "ISEA",
+    'FULLER' = "FULLER"
+}
+export interface Coordinate {
+    lat: number;
+    lng: number;
+}
+export interface IDGGSProps {
+    poleCoordinates: Coordinate;
+    azimuth: number;
+    aperture: 3 | 4 | 5 | 7;
+    topology: Topology;
+    projection: Projection;
+}
+export declare class Webdggrid {
+    protected _module: any;
+    dggs: IDGGSProps;
+    resolution: number;
+    private constructor();
+    /**
+     * Compiles and instantiates the raw wasm.
+     *
+     * ::: info
+     * In general WebAssembly compilation is disallowed on the main thread if the buffer size is larger than 4KB, hence forcing `load` to be asynchronous;
+     * :::
+     *
+     * @returns A promise to an instance of the Webdggrid class.
+     */
+    static load(): Promise<typeof Webdggrid>;
+    /**
+     * Unloades the compiled wasm instance.
+     */
+    static unload(): void;
+    /**
+     * @returns The Webdggrid c++ version
+     */
+    version(): string;
+    /**
+     * Set the main dggs configuration
+     * @param dggs A dggs object
+     */
+    setDggs(dggs?: IDGGSProps, resolution?: number): void;
+    /**
+     * Get the resolution of the current dggs
+     * @returns {number} the current dggs resolution
+     * @memberof WebDggrid
+     */
+    getResolution(): number;
+    /**
+     * Set the resolution of the dggs
+     * @param {number} [resolution=DEFAULT_RESOLUTION] the resolution. It should be a valid integer
+     * @memberof WebDggrid
+     */
+    setResolution(resolution: number): void;
+    /**
+     * test function
+     *
+     * @return {*}
+     * @memberof WebDggrid
+     */
+    _main(): any;
+    /**
+     * @follow Hi
+     * Returns the number of the cells in specific resolution
+     * @param {number} [resolution=DEFAULT_RESOLUTION]
+     * @return {number}
+     * @memberof WebDggrid
+     */
+    nCells(resolution?: number): number;
+    cellAreaKM(resolution?: number): number;
+    cellDistKM(resolution?: number): number;
+    gridStatCLS(resolution?: number): number;
+    /**
+     * Converts an array of geography coordinates to the list of the sequence numbers AKA DggId
+     * @param coordinates A 2d array of [[lng, lat]] values
+     * @param resolution  [resolution=DEFAULT_RESOLUTION] The dggs resolution
+     * @returns An array of the DggIds
+     */
+    geoToSequenceNum(coordinates: number[][], resolution?: number): bigint[];
+    /**
+     * Convert a sequence number to the [lng,lat] of the center of the related cell
+     * @param sequenceNum
+     * @param resolution  [resolution=DEFAULT_RESOLUTION]
+     * @returns An array of [lng,lat]
+     */
+    sequenceNumToGeo(sequenceNum: bigint[], resolution?: number): number[][];
+    /**
+     * 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[];
+}
+//# sourceMappingURL=webdggrid.d.ts.map

package/types/webdggrid.d.ts.map

@@ -0,0 +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"}