geoplegma-js 0.0.0 → 0.0.2-beta

package/README.md

@@ -1,6 +1,42 @@
-# tsdown-starter
+# Introduction
 
-A starter for creating a TypeScript package.
+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("IVEA7H");
+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
 
@@ -10,6 +46,18 @@ A starter for creating a TypeScript package.
 npm install
 ```
 
+- Get the native binding files, and run the script:
+
+```bash
+./scripts/dev.sh
+```
+
+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
@@ -21,7 +69,7 @@ npm run test
 ```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.
 
+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.
+NOTE: Eventually a github job will be added for this statement workflow.

package/dist/native/index.d.ts

@@ -4,8 +4,8 @@ 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
+  zonesFromParent(relativeDepth: number, parentZoneId: string | number, config?: Config | undefined | null): FlatZones
+  zoneFromId(zoneId: string | number, config?: Config | undefined | null): FlatZones
 }
 
 export interface Config {

package/package.json

@@ -1,16 +1,16 @@
 {
   "name": "geoplegma-js",
-  "version": "0.0.0",
+  "version": "0.0.2-beta",
   "description": "A JavaScript library for GeoPlegma.",
   "type": "module",
   "license": "MIT",
-  "homepage": "https://github.com/author/library#readme",
+  "homepage": "https://github.com/GeoPlegma/GeoPlegma-js#readme",
   "bugs": {
-    "url": "https://github.com/author/library/issues"
+    "url": "https://github.com/GeoPlegma/GeoPlegma-js/issues"
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/author/library.git"
+    "url": "git+https://github.com/GeoPlegma/GeoPlegma-js.git"
   },
   "author": "João Manuel <joaocsmanuel@gmail.com>",
   "files": [
@@ -29,6 +29,7 @@
   "scripts": {
     "build": "tsdown",
     "dev": "tsdown --watch",
+    "build-native": "scripts/dev.sh",
     "test": "vitest",
     "typecheck": "tsc --noEmit",
     "release": "bumpp && npm publish"

package/dist/native/browser.js

@@ -1 +0,0 @@
-export * from 'js-wasm32-wasi'

package/dist/native/napi.wasi-browser.js

@@ -1,61 +0,0 @@
-import {
-  createOnMessage as __wasmCreateOnMessageForFsProxy,
-  getDefaultContext as __emnapiGetDefaultContext,
-  instantiateNapiModuleSync as __emnapiInstantiateNapiModuleSync,
-  WASI as __WASI,
-} from '@napi-rs/wasm-runtime'
-
-
-
-const __wasi = new __WASI({
-  version: 'preview1',
-})
-
-const __wasmUrl = new URL('./napi.wasm32-wasi.wasm', import.meta.url).href
-const __emnapiContext = __emnapiGetDefaultContext()
-
-
-const __sharedMemory = new WebAssembly.Memory({
-  initial: 4000,
-  maximum: 65536,
-  shared: true,
-})
-
-const __wasmFile = await fetch(__wasmUrl).then((res) => res.arrayBuffer())
-
-const {
-  instance: __napiInstance,
-  module: __wasiModule,
-  napiModule: __napiModule,
-} = __emnapiInstantiateNapiModuleSync(__wasmFile, {
-  context: __emnapiContext,
-  asyncWorkPoolSize: 4,
-  wasi: __wasi,
-  onCreateWorker() {
-    const worker = new Worker(new URL('./wasi-worker-browser.mjs', import.meta.url), {
-      type: 'module',
-    })
-
-    return worker
-  },
-  overwriteImports(importObject) {
-    importObject.env = {
-      ...importObject.env,
-      ...importObject.napi,
-      ...importObject.emnapi,
-      memory: __sharedMemory,
-    }
-    return importObject
-  },
-  beforeInit({ instance }) {
-    for (const name of Object.keys(instance.exports)) {
-      if (name.startsWith('__napi_register__')) {
-        instance.exports[name]()
-      }
-    }
-  },
-})
-export default __napiModule.exports
-export const Dggrs = __napiModule.exports.Dggrs
-export const defaultConfig = __napiModule.exports.defaultConfig
-export const Id = __napiModule.exports.Id

package/dist/native/napi.wasi.cjs

@@ -1,113 +0,0 @@
-/* eslint-disable */
-/* prettier-ignore */
-
-/* auto-generated by NAPI-RS */
-
-const __nodeFs = require('node:fs')
-const __nodePath = require('node:path')
-const { WASI: __nodeWASI } = require('node:wasi')
-const { Worker } = require('node:worker_threads')
-
-const {
-  createOnMessage: __wasmCreateOnMessageForFsProxy,
-  getDefaultContext: __emnapiGetDefaultContext,
-  instantiateNapiModuleSync: __emnapiInstantiateNapiModuleSync,
-} = require('@napi-rs/wasm-runtime')
-
-const __rootDir = __nodePath.parse(process.cwd()).root
-
-const __wasi = new __nodeWASI({
-  version: 'preview1',
-  env: process.env,
-  preopens: {
-    [__rootDir]: __rootDir,
-  }
-})
-
-const __emnapiContext = __emnapiGetDefaultContext()
-
-const __sharedMemory = new WebAssembly.Memory({
-  initial: 4000,
-  maximum: 65536,
-  shared: true,
-})
-
-let __wasmFilePath = __nodePath.join(__dirname, 'napi.wasm32-wasi.wasm')
-const __wasmDebugFilePath = __nodePath.join(__dirname, 'napi.wasm32-wasi.debug.wasm')
-
-if (__nodeFs.existsSync(__wasmDebugFilePath)) {
-  __wasmFilePath = __wasmDebugFilePath
-} else if (!__nodeFs.existsSync(__wasmFilePath)) {
-  try {
-    __wasmFilePath = __nodePath.resolve('js-wasm32-wasi')
-  } catch {
-    throw new Error('Cannot find napi.wasm32-wasi.wasm file, and js-wasm32-wasi package is not installed.')
-  }
-}
-
-const { instance: __napiInstance, module: __wasiModule, napiModule: __napiModule } = __emnapiInstantiateNapiModuleSync(__nodeFs.readFileSync(__wasmFilePath), {
-  context: __emnapiContext,
-  asyncWorkPoolSize: (function() {
-    const threadsSizeFromEnv = Number(process.env.NAPI_RS_ASYNC_WORK_POOL_SIZE ?? process.env.UV_THREADPOOL_SIZE)
-    // NaN > 0 is false
-    if (threadsSizeFromEnv > 0) {
-      return threadsSizeFromEnv
-    } else {
-      return 4
-    }
-  })(),
-  reuseWorker: true,
-  wasi: __wasi,
-  onCreateWorker() {
-    const worker = new Worker(__nodePath.join(__dirname, 'wasi-worker.mjs'), {
-      env: process.env,
-    })
-    worker.onmessage = ({ data }) => {
-      __wasmCreateOnMessageForFsProxy(__nodeFs)(data)
-    }
-
-    // The main thread of Node.js waits for all the active handles before exiting.
-    // But Rust threads are never waited without `thread::join`.
-    // So here we hack the code of Node.js to prevent the workers from being referenced (active).
-    // According to https://github.com/nodejs/node/blob/19e0d472728c79d418b74bddff588bea70a403d0/lib/internal/worker.js#L415,
-    // a worker is consist of two handles: kPublicPort and kHandle.
-    {
-      const kPublicPort = Object.getOwnPropertySymbols(worker).find(s =>
-        s.toString().includes("kPublicPort")
-      );
-      if (kPublicPort) {
-        worker[kPublicPort].ref = () => {};
-      }
-
-      const kHandle = Object.getOwnPropertySymbols(worker).find(s =>
-        s.toString().includes("kHandle")
-      );
-      if (kHandle) {
-        worker[kHandle].ref = () => {};
-      }
-
-      worker.unref();
-    }
-    return worker
-  },
-  overwriteImports(importObject) {
-    importObject.env = {
-      ...importObject.env,
-      ...importObject.napi,
-      ...importObject.emnapi,
-      memory: __sharedMemory,
-    }
-    return importObject
-  },
-  beforeInit({ instance }) {
-    for (const name of Object.keys(instance.exports)) {
-      if (name.startsWith('__napi_register__')) {
-        instance.exports[name]()
-      }
-    }
-  },
-})
-module.exports = __napiModule.exports
-module.exports.Dggrs = __napiModule.exports.Dggrs
-module.exports.defaultConfig = __napiModule.exports.defaultConfig
-module.exports.Id = __napiModule.exports.Id

package/dist/native/wasi-worker-browser.mjs

@@ -1,32 +0,0 @@
-import { instantiateNapiModuleSync, MessageHandler, WASI } from '@napi-rs/wasm-runtime'
-
-const handler = new MessageHandler({
-  onLoad({ wasmModule, wasmMemory }) {
-    const wasi = new WASI({
-      print: function () {
-        // eslint-disable-next-line no-console
-        console.log.apply(console, arguments)
-      },
-      printErr: function() {
-        // eslint-disable-next-line no-console
-        console.error.apply(console, arguments)
-      },
-    })
-    return instantiateNapiModuleSync(wasmModule, {
-      childThread: true,
-      wasi,
-      overwriteImports(importObject) {
-        importObject.env = {
-          ...importObject.env,
-          ...importObject.napi,
-          ...importObject.emnapi,
-          memory: wasmMemory,
-        }
-      },
-    })
-  },
-})
-
-globalThis.onmessage = function (e) {
-  handler.handle(e)
-}

package/dist/native/wasi-worker.mjs

@@ -1,63 +0,0 @@
-import fs from "node:fs";
-import { createRequire } from "node:module";
-import { parse } from "node:path";
-import { WASI } from "node:wasi";
-import { parentPort, Worker } from "node:worker_threads";
-
-const require = createRequire(import.meta.url);
-
-const { instantiateNapiModuleSync, MessageHandler, getDefaultContext } = require("@napi-rs/wasm-runtime");
-
-if (parentPort) {
-  parentPort.on("message", (data) => {
-    globalThis.onmessage({ data });
-  });
-}
-
-Object.assign(globalThis, {
-  self: globalThis,
-  require,
-  Worker,
-  importScripts: function (f) {
-    ;(0, eval)(fs.readFileSync(f, "utf8") + "//# sourceURL=" + f);
-  },
-  postMessage: function (msg) {
-    if (parentPort) {
-      parentPort.postMessage(msg);
-    }
-  },
-});
-
-const emnapiContext = getDefaultContext();
-
-const __rootDir = parse(process.cwd()).root;
-
-const handler = new MessageHandler({
-  onLoad({ wasmModule, wasmMemory }) {
-    const wasi = new WASI({
-      version: 'preview1',
-      env: process.env,
-      preopens: {
-        [__rootDir]: __rootDir,
-      },
-    });
-
-    return instantiateNapiModuleSync(wasmModule, {
-      childThread: true,
-      wasi,
-      context: emnapiContext,
-      overwriteImports(importObject) {
-        importObject.env = {
-          ...importObject.env,
-          ...importObject.napi,
-          ...importObject.emnapi,
-          memory: wasmMemory
-        };
-      },
-    });
-  },
-});
-
-globalThis.onmessage = function (e) {
-  handler.handle(e);
-};