geoplegma-js 0.0.0-beta

package/README.md

@@ -0,0 +1,74 @@
+# Introduction
+
+JavaScript package for GeoPlegma. At this point, it runs only DGGRID.
+
+## Get Started
+
+Install the library.
+
+```bash
+npm install GeoPlegma-js
+```
+
+or
+
+```bash
+yarn add GeoPlegma-js
+```
+
+or
+
+```bash
+pnpm install GeoPlegma-js
+```
+
+Example:
+
+```js
+import { Dggrs } from "geoplegma-js";
+const g = new Dggrs("isea3h");
+const rl = 3;
+const bbox = [
+  [-10.0, -10.0],
+  [10.0, 10.0],
+];
+const a = g.zonesFromBbox(rl, bbox);
+
+console.log("from bbox: " + a.map((v) => v.id));
+// from bbox: 307fffffffffffff,30bfffffffffffff,31bfffffffffffff,323fffffffffffff,327fffffffffffff,32bfffffffffffff,3a7fffffffffffff
+```
+
+## Development
+
+- Install dependencies:
+
+```bash
+npm install
+```
+
+- Get the native binding files:
+
+```bash
+npm run build-native
+```
+
+This will:
+Build the .node files from GeoPlegma/gp-bindings/js.
+Copy them into GeoPlegma-js/native/.
+Let your JS code require('./native/something.node') without committing them.
+
+- Run the unit tests:
+
+```bash
+npm run test
+```
+
+- Build the library:
+
+```bash
+npm run build
+```
+
+The `build` script will build a new folder `dist` with the bundled files inside, and copy the index.node and index.d.ts files into that same folder. This folder will be used in the npm library as the source code files.
+
+NOTE: Eventually a github job will be added for this statement workflow.

package/dist/index.cjs

@@ -0,0 +1,110 @@
+//#region rolldown:runtime
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+	if (from && typeof from === "object" || typeof from === "function") for (var keys = __getOwnPropNames(from), i = 0, n = keys.length, key; i < n; i++) {
+		key = keys[i];
+		if (!__hasOwnProp.call(to, key) && key !== except) __defProp(to, key, {
+			get: ((k) => from[k]).bind(null, key),
+			enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable
+		});
+	}
+	return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", {
+	value: mod,
+	enumerable: true
+}) : target, mod));
+
+//#endregion
+const module$1 = __toESM(require("module"));
+const url = __toESM(require("url"));
+const path = __toESM(require("path"));
+
+//#region src/utils.ts
+function decodeZones(zones) {
+	const decodedZones = [];
+	const bufferIds = Buffer.from(zones.utf8Ids);
+	const bufferCoords = new Float64Array(zones.regionCoords);
+	for (let i = 0; i < zones.idOffsets.length; i++) {
+		const start = zones.idOffsets[i];
+		const end = i + 1 < zones.idOffsets.length ? zones.idOffsets[i + 1] : bufferIds.length;
+		const id = new TextDecoder("utf-8").decode(bufferIds.subarray(start, end));
+		const vertexCount = zones.vertexCount[i];
+		const regionStart = zones.regionOffsets[i];
+		const bufferRegion = bufferCoords.subarray(regionStart, regionStart + vertexCount * 2);
+		const region = [];
+		for (let j = 0; j < bufferRegion.length; j += 2) region.push([bufferRegion[j], bufferRegion[j + 1]]);
+		const children = decodeChildren(zones, i);
+		const neighbors = decodeNeighbors(zones, i);
+		decodedZones.push({
+			id,
+			center: [zones.centerX[i], zones.centerY[i]],
+			vertexCount,
+			region,
+			children,
+			neighbors
+		});
+	}
+	return decodedZones;
+}
+function decodeChildren(jsZones, zoneIndex) {
+	const children = [];
+	const start = jsZones.childrenOffsets[zoneIndex];
+	const end = zoneIndex + 1 < jsZones.childrenOffsets.length ? jsZones.childrenOffsets[zoneIndex + 1] : jsZones.childrenIdOffsets.length;
+	const buffer = new Float64Array(jsZones.childrenUtf8Ids);
+	for (let i = start; i < end; i++) {
+		const childStart = jsZones.childrenIdOffsets[i];
+		const childEnd = i + 1 < jsZones.childrenIdOffsets.length ? jsZones.childrenIdOffsets[i + 1] : jsZones.childrenUtf8Ids.length;
+		children.push(new TextDecoder("utf-8").decode(buffer.subarray(childStart, childEnd)));
+	}
+	return children;
+}
+function decodeNeighbors(jsZones, zoneIndex) {
+	const neighbors = [];
+	const start = jsZones.neighborsOffsets[zoneIndex];
+	const end = zoneIndex + 1 < jsZones.neighborsOffsets.length ? jsZones.neighborsOffsets[zoneIndex + 1] : jsZones.neighborsIdOffsets.length;
+	const buffer = new Float64Array(jsZones.neighborsUtf8Ids);
+	for (let i = start; i < end; i++) {
+		const nStart = jsZones.neighborsIdOffsets[i];
+		const nEnd = i + 1 < jsZones.neighborsIdOffsets.length ? jsZones.neighborsIdOffsets[i + 1] : jsZones.neighborsUtf8Ids.length;
+		neighbors.push(new TextDecoder("utf-8").decode(buffer.subarray(nStart, nEnd)));
+	}
+	return neighbors;
+}
+
+//#endregion
+//#region src/native-loader.ts
+const __dirname$1 = path.default.dirname((0, url.fileURLToPath)(require("url").pathToFileURL(__filename).href));
+const require$1 = (0, module$1.createRequire)(require("url").pathToFileURL(__filename).href);
+const bindings = require$1(path.default.join(__dirname$1, "native/napi.node"));
+var native_loader_default = bindings;
+
+//#endregion
+//#region src/extend.ts
+const { Dggrs: Aux } = native_loader_default;
+var Dggrs = class extends Aux {
+	constructor(name) {
+		super(name);
+	}
+	zonesFromBbox(refinement_level, bbox, config) {
+		return decodeZones(super.zonesFromBbox(refinement_level, bbox, config));
+	}
+	zoneFromPoint(refinement_level, point, config) {
+		return decodeZones(super.zoneFromPoint(refinement_level, point, config));
+	}
+	zonesFromParent(relative_depth, parentZoneId, config) {
+		return decodeZones(super.zonesFromParent(relative_depth, parentZoneId, config));
+	}
+	zoneFromId(zoneId, config) {
+		return decodeZones(super.zoneFromId(zoneId, config));
+	}
+};
+
+//#endregion
+exports.Dggrs = Dggrs;
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs","names":["zones: any","decodedZones: any","jsZones: any","zoneIndex: any","__dirname","require","bindings","name: string","refinement_level: number","bbox?: number[][]","config?: Config","point?: number[]","relative_depth: number","parentZoneId: string","zoneId: string"],"sources":["../src/utils.ts","../src/native-loader.ts","../src/extend.ts"],"sourcesContent":["// Copyright 2025 contributors to the GeoPlegma project.\n// Originally authored by João Manuel (GeoInsight GmbH, joao.manuel@geoinsight.ai)\n//\n// Licenced under the Apache Licence, Version 2.0 <LICENCE-APACHE or\n// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license\n// <LICENCE-MIT or http://opensource.org/licenses/MIT>, at your\n// discretion. This file may not be copied, modified, or distributed\n// except according to those terms.\n\n// for now the type is `any`, I will add other types in other PRs\nexport function decodeZones(zones: any) {\n  const decodedZones: any = [];\n  const bufferIds = Buffer.from(zones.utf8Ids);\n  const bufferCoords = new Float64Array(zones.regionCoords);\n\n  for (let i = 0; i < zones.idOffsets.length; i++) {\n    const start = zones.idOffsets[i];\n    const end =\n      i + 1 < zones.idOffsets.length\n        ? zones.idOffsets[i + 1]\n        : bufferIds.length;\n    const id = new TextDecoder(\"utf-8\").decode(bufferIds.subarray(start, end));\n\n    // region coords\n    const vertexCount = zones.vertexCount[i];\n    const regionStart = zones.regionOffsets[i];\n    const bufferRegion = bufferCoords.subarray(\n      regionStart,\n      regionStart + vertexCount * 2\n    );\n    const region = [];\n    for (let j = 0; j < bufferRegion.length; j += 2) {\n      region.push([bufferRegion[j], bufferRegion[j + 1]]);\n    }\n\n    // children\n    const children = decodeChildren(zones, i);\n\n    // neighbors\n    const neighbors = decodeNeighbors(zones, i);\n\n    decodedZones.push({\n      id,\n      center: [zones.centerX[i], zones.centerY[i]],\n      vertexCount,\n      region,\n      children,\n      neighbors,\n    });\n  }\n\n  return decodedZones;\n}\n\nexport function decodeChildren(jsZones: any, zoneIndex: any) {\n  const children = [];\n  const start = jsZones.childrenOffsets[zoneIndex];\n  const end =\n    zoneIndex + 1 < jsZones.childrenOffsets.length\n      ? jsZones.childrenOffsets[zoneIndex + 1]\n      : jsZones.childrenIdOffsets.length;\n  const buffer = new Float64Array(jsZones.childrenUtf8Ids);\n\n  // childrenOffsets -> [0, 6, 12,...]\n  // childrenIdOffsets -> [0, 18, 36,...]\n  for (let i = start; i < end; i++) {\n    const childStart = jsZones.childrenIdOffsets[i];\n    const childEnd =\n      i + 1 < jsZones.childrenIdOffsets.length\n        ? jsZones.childrenIdOffsets[i + 1]\n        : jsZones.childrenUtf8Ids.length;\n    children.push(\n      new TextDecoder(\"utf-8\").decode(buffer.subarray(childStart, childEnd))\n    );\n  }\n\n  return children;\n}\n\nexport function decodeNeighbors(jsZones: any, zoneIndex: any) {\n  const neighbors = [];\n  const start = jsZones.neighborsOffsets[zoneIndex];\n  const end =\n    zoneIndex + 1 < jsZones.neighborsOffsets.length\n      ? jsZones.neighborsOffsets[zoneIndex + 1]\n      : jsZones.neighborsIdOffsets.length;\n\n  const buffer = new Float64Array(jsZones.neighborsUtf8Ids);\n  for (let i = start; i < end; i++) {\n    const nStart = jsZones.neighborsIdOffsets[i];\n    const nEnd =\n      i + 1 < jsZones.neighborsIdOffsets.length\n        ? jsZones.neighborsIdOffsets[i + 1]\n        : jsZones.neighborsUtf8Ids.length;\n    neighbors.push(\n      new TextDecoder(\"utf-8\").decode(buffer.subarray(nStart, nEnd))\n    );\n  }\n  return neighbors;\n}\n","// Copyright 2025 contributors to the GeoPlegma project.\n// Originally authored by João Manuel (GeoInsight GmbH, joao.manuel@geoinsight.ai)\n//\n// Licenced under the Apache Licence, Version 2.0 <LICENCE-APACHE or\n// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license\n// <LICENCE-MIT or http://opensource.org/licenses/MIT>, at your\n// discretion. This file may not be copied, modified, or distributed\n// except according to those terms.\n\nimport { createRequire } from \"module\";\nimport { fileURLToPath } from \"url\";\nimport path from \"path\";\n\nconst __dirname = path.dirname(fileURLToPath(import.meta.url));\nconst require = createRequire(import.meta.url);\n\nconst bindings = require(path.join(__dirname, \"native/napi.node\"));\n\nexport default bindings;\n","// Copyright 2025 contributors to the GeoPlegma project.\n// Originally authored by João Manuel (GeoInsight GmbH, joao.manuel@geoinsight.ai)\n//\n// Licenced under the Apache Licence, Version 2.0 <LICENCE-APACHE or\n// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license\n// <LICENCE-MIT or http://opensource.org/licenses/MIT>, at your\n// discretion. This file may not be copied, modified, or distributed\n// except according to those terms.\n\nimport { decodeZones } from \"./utils\";\n\nimport bindings from \"./native-loader\";\n\nconst { Dggrs: Aux } = bindings;\n\ninterface Config {\n  region: boolean;\n  center: boolean;\n  vertexCount: boolean;\n  children: boolean;\n  neighbors: boolean;\n  areaSqm: boolean;\n  densify: boolean;\n}\n\nexport class Dggrs extends Aux {\n  constructor(name: string) {\n    super(name);\n  }\n  zonesFromBbox(refinement_level: number, bbox?: number[][], config?: Config) {\n    return decodeZones(super.zonesFromBbox(refinement_level, bbox, config));\n  }\n  zoneFromPoint(refinement_level: number, point?: number[], config?: Config) {\n    return decodeZones(super.zoneFromPoint(refinement_level, point, config));\n  }\n  zonesFromParent(\n    relative_depth: number,\n    parentZoneId: string,\n    config?: Config\n  ): any {\n    return decodeZones(\n      super.zonesFromParent(relative_depth, parentZoneId, config)\n    );\n  }\n  zoneFromId(zoneId: string, config?: Config): any {\n    return decodeZones(super.zoneFromId(zoneId, config));\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;AAUA,SAAgB,YAAYA,OAAY;CACtC,MAAMC,eAAoB,CAAE;CAC5B,MAAM,YAAY,OAAO,KAAK,MAAM,QAAQ;CAC5C,MAAM,eAAe,IAAI,aAAa,MAAM;AAE5C,MAAK,IAAI,IAAI,GAAG,IAAI,MAAM,UAAU,QAAQ,KAAK;EAC/C,MAAM,QAAQ,MAAM,UAAU;EAC9B,MAAM,MACJ,IAAI,IAAI,MAAM,UAAU,SACpB,MAAM,UAAU,IAAI,KACpB,UAAU;EAChB,MAAM,KAAK,IAAI,YAAY,SAAS,OAAO,UAAU,SAAS,OAAO,IAAI,CAAC;EAG1E,MAAM,cAAc,MAAM,YAAY;EACtC,MAAM,cAAc,MAAM,cAAc;EACxC,MAAM,eAAe,aAAa,SAChC,aACA,cAAc,cAAc,EAC7B;EACD,MAAM,SAAS,CAAE;AACjB,OAAK,IAAI,IAAI,GAAG,IAAI,aAAa,QAAQ,KAAK,EAC5C,QAAO,KAAK,CAAC,aAAa,IAAI,aAAa,IAAI,EAAG,EAAC;EAIrD,MAAM,WAAW,eAAe,OAAO,EAAE;EAGzC,MAAM,YAAY,gBAAgB,OAAO,EAAE;AAE3C,eAAa,KAAK;GAChB;GACA,QAAQ,CAAC,MAAM,QAAQ,IAAI,MAAM,QAAQ,EAAG;GAC5C;GACA;GACA;GACA;EACD,EAAC;CACH;AAED,QAAO;AACR;AAED,SAAgB,eAAeC,SAAcC,WAAgB;CAC3D,MAAM,WAAW,CAAE;CACnB,MAAM,QAAQ,QAAQ,gBAAgB;CACtC,MAAM,MACJ,YAAY,IAAI,QAAQ,gBAAgB,SACpC,QAAQ,gBAAgB,YAAY,KACpC,QAAQ,kBAAkB;CAChC,MAAM,SAAS,IAAI,aAAa,QAAQ;AAIxC,MAAK,IAAI,IAAI,OAAO,IAAI,KAAK,KAAK;EAChC,MAAM,aAAa,QAAQ,kBAAkB;EAC7C,MAAM,WACJ,IAAI,IAAI,QAAQ,kBAAkB,SAC9B,QAAQ,kBAAkB,IAAI,KAC9B,QAAQ,gBAAgB;AAC9B,WAAS,KACP,IAAI,YAAY,SAAS,OAAO,OAAO,SAAS,YAAY,SAAS,CAAC,CACvE;CACF;AAED,QAAO;AACR;AAED,SAAgB,gBAAgBD,SAAcC,WAAgB;CAC5D,MAAM,YAAY,CAAE;CACpB,MAAM,QAAQ,QAAQ,iBAAiB;CACvC,MAAM,MACJ,YAAY,IAAI,QAAQ,iBAAiB,SACrC,QAAQ,iBAAiB,YAAY,KACrC,QAAQ,mBAAmB;CAEjC,MAAM,SAAS,IAAI,aAAa,QAAQ;AACxC,MAAK,IAAI,IAAI,OAAO,IAAI,KAAK,KAAK;EAChC,MAAM,SAAS,QAAQ,mBAAmB;EAC1C,MAAM,OACJ,IAAI,IAAI,QAAQ,mBAAmB,SAC/B,QAAQ,mBAAmB,IAAI,KAC/B,QAAQ,iBAAiB;AAC/B,YAAU,KACR,IAAI,YAAY,SAAS,OAAO,OAAO,SAAS,QAAQ,KAAK,CAAC,CAC/D;CACF;AACD,QAAO;AACR;;;;ACtFD,MAAMC,cAAY,aAAK,QAAQ,qEAA8B,CAAC;AAC9D,MAAMC,YAAU,0EAA8B;AAE9C,MAAM,WAAW,UAAQ,aAAK,KAAKD,aAAW,mBAAmB,CAAC;AAElE,4BAAe;;;;ACLf,MAAM,EAAE,OAAO,KAAK,GAAGE;AAYvB,IAAa,QAAb,cAA2B,IAAI;CAC7B,YAAYC,MAAc;AACxB,QAAM,KAAK;CACZ;CACD,cAAcC,kBAA0BC,MAAmBC,QAAiB;AAC1E,SAAO,YAAY,MAAM,cAAc,kBAAkB,MAAM,OAAO,CAAC;CACxE;CACD,cAAcF,kBAA0BG,OAAkBD,QAAiB;AACzE,SAAO,YAAY,MAAM,cAAc,kBAAkB,OAAO,OAAO,CAAC;CACzE;CACD,gBACEE,gBACAC,cACAH,QACK;AACL,SAAO,YACL,MAAM,gBAAgB,gBAAgB,cAAc,OAAO,CAC5D;CACF;CACD,WAAWI,QAAgBJ,QAAsB;AAC/C,SAAO,YAAY,MAAM,WAAW,QAAQ,OAAO,CAAC;CACrD;AACF"}

package/dist/index.d.cts

@@ -0,0 +1,21 @@
+//#region src/extend.d.ts
+declare const Aux: any;
+interface Config {
+  region: boolean;
+  center: boolean;
+  vertexCount: boolean;
+  children: boolean;
+  neighbors: boolean;
+  areaSqm: boolean;
+  densify: boolean;
+}
+declare class Dggrs extends Aux {
+  constructor(name: string);
+  zonesFromBbox(refinement_level: number, bbox?: number[][], config?: Config): any;
+  zoneFromPoint(refinement_level: number, point?: number[], config?: Config): any;
+  zonesFromParent(relative_depth: number, parentZoneId: string, config?: Config): any;
+  zoneFromId(zoneId: string, config?: Config): any;
+}
+//#endregion
+export { Dggrs };
+//# sourceMappingURL=index.d.cts.map

package/dist/index.d.ts

@@ -0,0 +1,21 @@
+//#region src/extend.d.ts
+declare const Aux: any;
+interface Config {
+  region: boolean;
+  center: boolean;
+  vertexCount: boolean;
+  children: boolean;
+  neighbors: boolean;
+  areaSqm: boolean;
+  densify: boolean;
+}
+declare class Dggrs extends Aux {
+  constructor(name: string);
+  zonesFromBbox(refinement_level: number, bbox?: number[][], config?: Config): any;
+  zoneFromPoint(refinement_level: number, point?: number[], config?: Config): any;
+  zonesFromParent(relative_depth: number, parentZoneId: string, config?: Config): any;
+  zoneFromId(zoneId: string, config?: Config): any;
+}
+//#endregion
+export { Dggrs };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -0,0 +1,87 @@
+import { createRequire } from "module";
+import { fileURLToPath } from "url";
+import path from "path";
+
+//#region src/utils.ts
+function decodeZones(zones) {
+	const decodedZones = [];
+	const bufferIds = Buffer.from(zones.utf8Ids);
+	const bufferCoords = new Float64Array(zones.regionCoords);
+	for (let i = 0; i < zones.idOffsets.length; i++) {
+		const start = zones.idOffsets[i];
+		const end = i + 1 < zones.idOffsets.length ? zones.idOffsets[i + 1] : bufferIds.length;
+		const id = new TextDecoder("utf-8").decode(bufferIds.subarray(start, end));
+		const vertexCount = zones.vertexCount[i];
+		const regionStart = zones.regionOffsets[i];
+		const bufferRegion = bufferCoords.subarray(regionStart, regionStart + vertexCount * 2);
+		const region = [];
+		for (let j = 0; j < bufferRegion.length; j += 2) region.push([bufferRegion[j], bufferRegion[j + 1]]);
+		const children = decodeChildren(zones, i);
+		const neighbors = decodeNeighbors(zones, i);
+		decodedZones.push({
+			id,
+			center: [zones.centerX[i], zones.centerY[i]],
+			vertexCount,
+			region,
+			children,
+			neighbors
+		});
+	}
+	return decodedZones;
+}
+function decodeChildren(jsZones, zoneIndex) {
+	const children = [];
+	const start = jsZones.childrenOffsets[zoneIndex];
+	const end = zoneIndex + 1 < jsZones.childrenOffsets.length ? jsZones.childrenOffsets[zoneIndex + 1] : jsZones.childrenIdOffsets.length;
+	const buffer = new Float64Array(jsZones.childrenUtf8Ids);
+	for (let i = start; i < end; i++) {
+		const childStart = jsZones.childrenIdOffsets[i];
+		const childEnd = i + 1 < jsZones.childrenIdOffsets.length ? jsZones.childrenIdOffsets[i + 1] : jsZones.childrenUtf8Ids.length;
+		children.push(new TextDecoder("utf-8").decode(buffer.subarray(childStart, childEnd)));
+	}
+	return children;
+}
+function decodeNeighbors(jsZones, zoneIndex) {
+	const neighbors = [];
+	const start = jsZones.neighborsOffsets[zoneIndex];
+	const end = zoneIndex + 1 < jsZones.neighborsOffsets.length ? jsZones.neighborsOffsets[zoneIndex + 1] : jsZones.neighborsIdOffsets.length;
+	const buffer = new Float64Array(jsZones.neighborsUtf8Ids);
+	for (let i = start; i < end; i++) {
+		const nStart = jsZones.neighborsIdOffsets[i];
+		const nEnd = i + 1 < jsZones.neighborsIdOffsets.length ? jsZones.neighborsIdOffsets[i + 1] : jsZones.neighborsUtf8Ids.length;
+		neighbors.push(new TextDecoder("utf-8").decode(buffer.subarray(nStart, nEnd)));
+	}
+	return neighbors;
+}
+
+//#endregion
+//#region src/native-loader.ts
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
+const require = createRequire(import.meta.url);
+const bindings = require(path.join(__dirname, "native/napi.node"));
+var native_loader_default = bindings;
+
+//#endregion
+//#region src/extend.ts
+const { Dggrs: Aux } = native_loader_default;
+var Dggrs = class extends Aux {
+	constructor(name) {
+		super(name);
+	}
+	zonesFromBbox(refinement_level, bbox, config) {
+		return decodeZones(super.zonesFromBbox(refinement_level, bbox, config));
+	}
+	zoneFromPoint(refinement_level, point, config) {
+		return decodeZones(super.zoneFromPoint(refinement_level, point, config));
+	}
+	zonesFromParent(relative_depth, parentZoneId, config) {
+		return decodeZones(super.zonesFromParent(relative_depth, parentZoneId, config));
+	}
+	zoneFromId(zoneId, config) {
+		return decodeZones(super.zoneFromId(zoneId, config));
+	}
+};
+
+//#endregion
+export { Dggrs };
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":["zones: any","decodedZones: any","jsZones: any","zoneIndex: any","bindings","name: string","refinement_level: number","bbox?: number[][]","config?: Config","point?: number[]","relative_depth: number","parentZoneId: string","zoneId: string"],"sources":["../src/utils.ts","../src/native-loader.ts","../src/extend.ts"],"sourcesContent":["// Copyright 2025 contributors to the GeoPlegma project.\n// Originally authored by João Manuel (GeoInsight GmbH, joao.manuel@geoinsight.ai)\n//\n// Licenced under the Apache Licence, Version 2.0 <LICENCE-APACHE or\n// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license\n// <LICENCE-MIT or http://opensource.org/licenses/MIT>, at your\n// discretion. This file may not be copied, modified, or distributed\n// except according to those terms.\n\n// for now the type is `any`, I will add other types in other PRs\nexport function decodeZones(zones: any) {\n  const decodedZones: any = [];\n  const bufferIds = Buffer.from(zones.utf8Ids);\n  const bufferCoords = new Float64Array(zones.regionCoords);\n\n  for (let i = 0; i < zones.idOffsets.length; i++) {\n    const start = zones.idOffsets[i];\n    const end =\n      i + 1 < zones.idOffsets.length\n        ? zones.idOffsets[i + 1]\n        : bufferIds.length;\n    const id = new TextDecoder(\"utf-8\").decode(bufferIds.subarray(start, end));\n\n    // region coords\n    const vertexCount = zones.vertexCount[i];\n    const regionStart = zones.regionOffsets[i];\n    const bufferRegion = bufferCoords.subarray(\n      regionStart,\n      regionStart + vertexCount * 2\n    );\n    const region = [];\n    for (let j = 0; j < bufferRegion.length; j += 2) {\n      region.push([bufferRegion[j], bufferRegion[j + 1]]);\n    }\n\n    // children\n    const children = decodeChildren(zones, i);\n\n    // neighbors\n    const neighbors = decodeNeighbors(zones, i);\n\n    decodedZones.push({\n      id,\n      center: [zones.centerX[i], zones.centerY[i]],\n      vertexCount,\n      region,\n      children,\n      neighbors,\n    });\n  }\n\n  return decodedZones;\n}\n\nexport function decodeChildren(jsZones: any, zoneIndex: any) {\n  const children = [];\n  const start = jsZones.childrenOffsets[zoneIndex];\n  const end =\n    zoneIndex + 1 < jsZones.childrenOffsets.length\n      ? jsZones.childrenOffsets[zoneIndex + 1]\n      : jsZones.childrenIdOffsets.length;\n  const buffer = new Float64Array(jsZones.childrenUtf8Ids);\n\n  // childrenOffsets -> [0, 6, 12,...]\n  // childrenIdOffsets -> [0, 18, 36,...]\n  for (let i = start; i < end; i++) {\n    const childStart = jsZones.childrenIdOffsets[i];\n    const childEnd =\n      i + 1 < jsZones.childrenIdOffsets.length\n        ? jsZones.childrenIdOffsets[i + 1]\n        : jsZones.childrenUtf8Ids.length;\n    children.push(\n      new TextDecoder(\"utf-8\").decode(buffer.subarray(childStart, childEnd))\n    );\n  }\n\n  return children;\n}\n\nexport function decodeNeighbors(jsZones: any, zoneIndex: any) {\n  const neighbors = [];\n  const start = jsZones.neighborsOffsets[zoneIndex];\n  const end =\n    zoneIndex + 1 < jsZones.neighborsOffsets.length\n      ? jsZones.neighborsOffsets[zoneIndex + 1]\n      : jsZones.neighborsIdOffsets.length;\n\n  const buffer = new Float64Array(jsZones.neighborsUtf8Ids);\n  for (let i = start; i < end; i++) {\n    const nStart = jsZones.neighborsIdOffsets[i];\n    const nEnd =\n      i + 1 < jsZones.neighborsIdOffsets.length\n        ? jsZones.neighborsIdOffsets[i + 1]\n        : jsZones.neighborsUtf8Ids.length;\n    neighbors.push(\n      new TextDecoder(\"utf-8\").decode(buffer.subarray(nStart, nEnd))\n    );\n  }\n  return neighbors;\n}\n","// Copyright 2025 contributors to the GeoPlegma project.\n// Originally authored by João Manuel (GeoInsight GmbH, joao.manuel@geoinsight.ai)\n//\n// Licenced under the Apache Licence, Version 2.0 <LICENCE-APACHE or\n// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license\n// <LICENCE-MIT or http://opensource.org/licenses/MIT>, at your\n// discretion. This file may not be copied, modified, or distributed\n// except according to those terms.\n\nimport { createRequire } from \"module\";\nimport { fileURLToPath } from \"url\";\nimport path from \"path\";\n\nconst __dirname = path.dirname(fileURLToPath(import.meta.url));\nconst require = createRequire(import.meta.url);\n\nconst bindings = require(path.join(__dirname, \"native/napi.node\"));\n\nexport default bindings;\n","// Copyright 2025 contributors to the GeoPlegma project.\n// Originally authored by João Manuel (GeoInsight GmbH, joao.manuel@geoinsight.ai)\n//\n// Licenced under the Apache Licence, Version 2.0 <LICENCE-APACHE or\n// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license\n// <LICENCE-MIT or http://opensource.org/licenses/MIT>, at your\n// discretion. This file may not be copied, modified, or distributed\n// except according to those terms.\n\nimport { decodeZones } from \"./utils\";\n\nimport bindings from \"./native-loader\";\n\nconst { Dggrs: Aux } = bindings;\n\ninterface Config {\n  region: boolean;\n  center: boolean;\n  vertexCount: boolean;\n  children: boolean;\n  neighbors: boolean;\n  areaSqm: boolean;\n  densify: boolean;\n}\n\nexport class Dggrs extends Aux {\n  constructor(name: string) {\n    super(name);\n  }\n  zonesFromBbox(refinement_level: number, bbox?: number[][], config?: Config) {\n    return decodeZones(super.zonesFromBbox(refinement_level, bbox, config));\n  }\n  zoneFromPoint(refinement_level: number, point?: number[], config?: Config) {\n    return decodeZones(super.zoneFromPoint(refinement_level, point, config));\n  }\n  zonesFromParent(\n    relative_depth: number,\n    parentZoneId: string,\n    config?: Config\n  ): any {\n    return decodeZones(\n      super.zonesFromParent(relative_depth, parentZoneId, config)\n    );\n  }\n  zoneFromId(zoneId: string, config?: Config): any {\n    return decodeZones(super.zoneFromId(zoneId, config));\n  }\n}\n"],"mappings":";;;;;AAUA,SAAgB,YAAYA,OAAY;CACtC,MAAMC,eAAoB,CAAE;CAC5B,MAAM,YAAY,OAAO,KAAK,MAAM,QAAQ;CAC5C,MAAM,eAAe,IAAI,aAAa,MAAM;AAE5C,MAAK,IAAI,IAAI,GAAG,IAAI,MAAM,UAAU,QAAQ,KAAK;EAC/C,MAAM,QAAQ,MAAM,UAAU;EAC9B,MAAM,MACJ,IAAI,IAAI,MAAM,UAAU,SACpB,MAAM,UAAU,IAAI,KACpB,UAAU;EAChB,MAAM,KAAK,IAAI,YAAY,SAAS,OAAO,UAAU,SAAS,OAAO,IAAI,CAAC;EAG1E,MAAM,cAAc,MAAM,YAAY;EACtC,MAAM,cAAc,MAAM,cAAc;EACxC,MAAM,eAAe,aAAa,SAChC,aACA,cAAc,cAAc,EAC7B;EACD,MAAM,SAAS,CAAE;AACjB,OAAK,IAAI,IAAI,GAAG,IAAI,aAAa,QAAQ,KAAK,EAC5C,QAAO,KAAK,CAAC,aAAa,IAAI,aAAa,IAAI,EAAG,EAAC;EAIrD,MAAM,WAAW,eAAe,OAAO,EAAE;EAGzC,MAAM,YAAY,gBAAgB,OAAO,EAAE;AAE3C,eAAa,KAAK;GAChB;GACA,QAAQ,CAAC,MAAM,QAAQ,IAAI,MAAM,QAAQ,EAAG;GAC5C;GACA;GACA;GACA;EACD,EAAC;CACH;AAED,QAAO;AACR;AAED,SAAgB,eAAeC,SAAcC,WAAgB;CAC3D,MAAM,WAAW,CAAE;CACnB,MAAM,QAAQ,QAAQ,gBAAgB;CACtC,MAAM,MACJ,YAAY,IAAI,QAAQ,gBAAgB,SACpC,QAAQ,gBAAgB,YAAY,KACpC,QAAQ,kBAAkB;CAChC,MAAM,SAAS,IAAI,aAAa,QAAQ;AAIxC,MAAK,IAAI,IAAI,OAAO,IAAI,KAAK,KAAK;EAChC,MAAM,aAAa,QAAQ,kBAAkB;EAC7C,MAAM,WACJ,IAAI,IAAI,QAAQ,kBAAkB,SAC9B,QAAQ,kBAAkB,IAAI,KAC9B,QAAQ,gBAAgB;AAC9B,WAAS,KACP,IAAI,YAAY,SAAS,OAAO,OAAO,SAAS,YAAY,SAAS,CAAC,CACvE;CACF;AAED,QAAO;AACR;AAED,SAAgB,gBAAgBD,SAAcC,WAAgB;CAC5D,MAAM,YAAY,CAAE;CACpB,MAAM,QAAQ,QAAQ,iBAAiB;CACvC,MAAM,MACJ,YAAY,IAAI,QAAQ,iBAAiB,SACrC,QAAQ,iBAAiB,YAAY,KACrC,QAAQ,mBAAmB;CAEjC,MAAM,SAAS,IAAI,aAAa,QAAQ;AACxC,MAAK,IAAI,IAAI,OAAO,IAAI,KAAK,KAAK;EAChC,MAAM,SAAS,QAAQ,mBAAmB;EAC1C,MAAM,OACJ,IAAI,IAAI,QAAQ,mBAAmB,SAC/B,QAAQ,mBAAmB,IAAI,KAC/B,QAAQ,iBAAiB;AAC/B,YAAU,KACR,IAAI,YAAY,SAAS,OAAO,OAAO,SAAS,QAAQ,KAAK,CAAC,CAC/D;CACF;AACD,QAAO;AACR;;;;ACtFD,MAAM,YAAY,KAAK,QAAQ,cAAc,OAAO,KAAK,IAAI,CAAC;AAC9D,MAAM,UAAU,cAAc,OAAO,KAAK,IAAI;AAE9C,MAAM,WAAW,QAAQ,KAAK,KAAK,WAAW,mBAAmB,CAAC;AAElE,4BAAe;;;;ACLf,MAAM,EAAE,OAAO,KAAK,GAAGC;AAYvB,IAAa,QAAb,cAA2B,IAAI;CAC7B,YAAYC,MAAc;AACxB,QAAM,KAAK;CACZ;CACD,cAAcC,kBAA0BC,MAAmBC,QAAiB;AAC1E,SAAO,YAAY,MAAM,cAAc,kBAAkB,MAAM,OAAO,CAAC;CACxE;CACD,cAAcF,kBAA0BG,OAAkBD,QAAiB;AACzE,SAAO,YAAY,MAAM,cAAc,kBAAkB,OAAO,OAAO,CAAC;CACzE;CACD,gBACEE,gBACAC,cACAH,QACK;AACL,SAAO,YACL,MAAM,gBAAgB,gBAAgB,cAAc,OAAO,CAC5D;CACF;CACD,WAAWI,QAAgBJ,QAAsB;AAC/C,SAAO,YAAY,MAAM,WAAW,QAAQ,OAAO,CAAC;CACrD;AACF"}

package/dist/native/index.d.ts

@@ -0,0 +1,64 @@
+/* auto-generated by NAPI-RS */
+/* eslint-disable */
+export declare class Dggrs {
+  constructor(dggrs: string)
+  zonesFromBbox(refinementLevel: number, bbox?: Array<Array<number>> | undefined | null, config?: Config | undefined | null): FlatZones
+  zoneFromPoint(refinementLevel: number, point?: Array<number> | undefined | null, config?: Config | undefined | null): FlatZones
+  zonesFromParent(relativeDepth: number, parentZoneId: string, config?: Config | undefined | null): FlatZones
+  zoneFromId(zoneId: string, config?: Config | undefined | null): FlatZones
+}
+
+export interface Config {
+  region: boolean
+  center: boolean
+  vertexCount: boolean
+  children: boolean
+  neighbors: boolean
+  areaSqm: boolean
+  densify: boolean
+}
+
+export declare function defaultConfig(): Config
+
+/**
+ * The Zone struct has nested heap allocations (String, Vec<(f64,f64)>, Vec<String>), which means:
+ * - Each String is 24 bytes (ptr, len, capacity) + heap data.
+ * - Each (f64, f64) is fine in Rust, but Vec<(f64,f64)> is not a flat Vec<f64> in wasm/napi-rs.
+ * - wasm/napi-rs will have to walk and serialize everything, which is slow for thousands of zones.
+ * No napi-rs overhead per zone — you pass one pointer + length per field instead of millions of small objects.
+ * Zero-copy — JS reads directly from WebAssembly memory.
+ * Keeps geometry-heavy Zone struct in Rust for efficient calculations.
+ * Scales to millions of zones without crashing the browser or blowing up memory usage.
+ * Tradeoff
+ * Pro: Hugely faster for large datasets
+ * Con: JS side reconstruction is manual — you need to decode UTF-8 strings from byte arrays using TextDecoder and use offset tables.
+ */
+export interface FlatZones {
+  idOffsets: Array<number>
+  utf8Ids: Array<number>
+  centerX: Array<number>
+  centerY: Array<number>
+  vertexCount: Array<number>
+  regionOffsets: Array<number>
+  regionCoords: Array<number>
+  childrenOffsets: Array<number>
+  childrenIdOffsets: Array<number>
+  childrenUtf8Ids: Array<number>
+  neighborsOffsets: Array<number>
+  neighborsIdOffsets: Array<number>
+  neighborsUtf8Ids: Array<number>
+}
+
+export declare const enum Id {
+  String = 'String',
+  U64 = 'U64'
+}
+
+export interface Zone {
+  id: Id
+  region: Array<Array<number>>
+  center: Array<number>
+  vertexCount: number
+  children?: Array<Id>
+  neighbors?: Array<Id>
+}

package/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "geoplegma-js",
+  "version": "0.0.0-beta",
+  "description": "A JavaScript library for GeoPlegma.",
+  "type": "module",
+  "license": "MIT",
+  "homepage": "https://github.com/GeoPlegma/GeoPlegma-js#readme",
+  "bugs": {
+    "url": "https://github.com/GeoPlegma/GeoPlegma-js/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/GeoPlegma/GeoPlegma-js.git"
+  },
+  "author": "João Manuel <joaocsmanuel@gmail.com>",
+  "files": [
+    "dist"
+  ],
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": "./dist/index.js",
+    "./package.json": "./package.json"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsdown",
+    "dev": "tsdown --watch",
+    "build-native": "scripts/dev.sh",
+    "test": "vitest",
+    "typecheck": "tsc --noEmit",
+    "release": "bumpp && npm publish"
+  },
+  "devDependencies": {
+    "@types/node": "^22.15.17",
+    "bumpp": "^10.1.0",
+    "tsdown": "^0.11.9",
+    "typescript": "^5.8.3",
+    "vitest": "^3.1.3"
+  },
+  "dependencies": {
+    "bindings": "^1.5.0"
+  }
+}