@sentryware/s2-node 0.0.6

package/index.d.ts

@@ -0,0 +1,117 @@
+declare module '@radarlabs/s2' {
+
+  export type ChildPosition = 0 | 1 | 2 | 3;
+
+  export class Point {
+    constructor(x: number, y: number, z: number);
+
+    public x(): number;
+    public y(): number;
+    public z(): number;
+  }
+
+  export class LatLng {
+    constructor(latDegrees: number, lngDegrees: number);
+    constructor(point: Point);
+
+    public normalized(): LatLng;
+
+    public latitude(): number;
+    public longitude(): number;
+
+    public approxEquals(ll: LatLng, maxErrorRadians?: number): number;
+
+    public toString(): string;
+  }
+
+  export class CellId {
+    public constructor(id: bigint);
+    public constructor(token: string);
+    public constructor(ll: LatLng);
+
+    public id(): bigint;
+    public idString(): string;
+    public token(): string;
+
+    public contains(other: CellId): boolean;
+    public intersects(other: CellId): boolean;
+    public isLeaf(): boolean;
+
+    public parent(level?: number): CellId;
+    public child(position: ChildPosition): CellId;
+    public next(): CellId;
+
+    public level(): number;
+
+    public rangeMin(): CellId;
+    public rangeMax(): CellId;
+
+    public static fromToken(token: string): CellId;
+  }
+
+  export class Cell {
+    public constructor(cellId: CellId);
+
+    public getVertex(pos: number): Point;
+    public getCenter(): Point;
+  }
+
+  export class CellUnion {
+    public constructor(tokens: string[]);
+    public constructor(cellIds: CellId[]);
+
+    public contains(cells: CellId | CellUnion): boolean;
+    public intersects(cells: CellId | CellUnion): boolean;
+
+    public union(cells: CellUnion): CellUnion;
+    public intersection(cells: CellUnion): CellUnion;
+    public difference(cells: CellUnion): CellUnion;
+
+    public ids(): BigUint64Array;
+    public cellIds(): CellId[];
+    public tokens(): string[];
+  }
+
+  export interface RegionCovererOptions {
+    min?: number;
+    max?: number;
+    max_cells?: number;
+  }
+
+  export class RegionCoverer {
+    public static getCoveringIds(lls: LatLng[], options: RegionCovererOptions): BigUint64Array | null;
+    public static getCoveringTokens(lls: LatLng[], options: RegionCovererOptions): string[] | null;
+    public static getCovering(lls: LatLng[], options: RegionCovererOptions): CellUnion | null;
+
+    public static getRadiusCoveringIds(ll: LatLng, radiusM: number, options: RegionCovererOptions): BigUint64Array | null;
+    public static getRadiusCoveringTokens(ll: LatLng, radiusM: number, options: RegionCovererOptions): string[] | null;
+    public static getRadiusCovering(ll: LatLng, radiusM: number, options: RegionCovererOptions): CellUnion | null;
+  }
+
+  export class Earth {
+    public static toMeters(a: LatLng, b: LatLng): number;
+    public static getDistanceMeters(a: LatLng, b: LatLng): number;
+
+    public static toKm(a: LatLng, b: LatLng): number;
+    public static getDistanceKm(a: LatLng, b: LatLng): number;
+
+    public static getDegrees(a: LatLng, b: LatLng): number;
+    public static getRadians(a: LatLng, b: LatLng): number;
+
+    public static getInitialBearingDegrees(a: LatLng, b: LatLng): number;
+  }
+
+  export class Polyline {
+    public constructor(lls: LatLng[]);
+
+    public contains(cell: Cell): boolean;
+    public nearlyCovers(other: Polyline, maxError: number): boolean;
+
+    public getLength(): number;
+    public getCentroid(): LatLng;
+
+    public interpolate(fraction: number): LatLng;
+    public project(ll: LatLng): LatLng;
+  }
+
+}

package/index.js

@@ -0,0 +1,6 @@
+// magic incantation from step 3 @ https://github.com/mapbox/node-pre-gyp#readme
+const binary = require('@mapbox/node-pre-gyp');
+const path = require('path');
+var binding_path = binary.find(path.resolve(path.join(__dirname,'./package.json')));
+const s2 = require(binding_path);
+module.exports = s2;

package/jest.config.js

@@ -0,0 +1,184 @@
+// For a detailed explanation regarding each configuration property, visit:
+// https://jestjs.io/docs/en/configuration.html
+
+module.exports = {
+  // All imported modules in your tests should be mocked automatically
+  // automock: false,
+
+  // Stop running tests after `n` failures
+  // bail: 0,
+
+  // Respect "browser" field in package.json when resolving modules
+  // browser: false,
+
+  // The directory where Jest should store its cached dependency information
+  // cacheDirectory: "/private/var/folders/3m/0td_0c9j1qxcc0htbz_crjlr0000gn/T/jest_dx",
+
+  // Automatically clear mock calls and instances between every test
+  clearMocks: true,
+
+  // Indicates whether the coverage information should be collected while executing the test
+  collectCoverage: false,
+
+  // An array of glob patterns indicating a set of files for which coverage information should be collected
+  // collectCoverageFrom: null,
+
+  // The directory where Jest should output its coverage files
+  // coverageDirectory: "coverage",
+
+  // An array of regexp pattern strings used to skip coverage collection
+  // coveragePathIgnorePatterns: [
+  //   "/node_modules/"
+  // ],
+
+  // A list of reporter names that Jest uses when writing coverage reports
+  // coverageReporters: [
+  //   "json",
+  //   "text",
+  //   "lcov",
+  //   "clover"
+  // ],
+
+  // An object that configures minimum threshold enforcement for coverage results
+  // coverageThreshold: null,
+
+  // A path to a custom dependency extractor
+  // dependencyExtractor: null,
+
+  // Make calling deprecated APIs throw helpful error messages
+  // errorOnDeprecated: false,
+
+  // Force coverage collection from ignored files using an array of glob patterns
+  // forceCoverageMatch: [],
+
+  // A path to a module which exports an async function that is triggered once before all test suites
+  // globalSetup: null,
+
+  // A path to a module which exports an async function that is triggered once after all test suites
+  // globalTeardown: null,
+
+  // A set of global variables that need to be available in all test environments
+  // globals: {},
+
+  // An array of directory names to be searched recursively up from the requiring module's location
+  // moduleDirectories: [
+  //   "node_modules"
+  // ],
+
+  // An array of file extensions your modules use
+  // moduleFileExtensions: [
+  //   "js",
+  //   "json",
+  //   "jsx",
+  //   "ts",
+  //   "tsx",
+  //   "node"
+  // ],
+
+  // A map from regular expressions to module names that allow to stub out resources with a single module
+  // moduleNameMapper: {},
+
+  // An array of regexp pattern strings, matched against all module paths before considered 'visible' to the module loader
+  // modulePathIgnorePatterns: [],
+
+  // Activates notifications for test results
+  // notify: false,
+
+  // An enum that specifies notification mode. Requires { notify: true }
+  // notifyMode: "failure-change",
+
+  // A preset that is used as a base for Jest's configuration
+  // preset: null,
+
+  // Run tests from one or more projects
+  // projects: null,
+
+  // Use this configuration option to add custom reporters to Jest
+  // reporters: undefined,
+
+  // Automatically reset mock state between every test
+  // resetMocks: false,
+
+  // Reset the module registry before running each individual test
+  // resetModules: false,
+
+  // A path to a custom resolver
+  // resolver: null,
+
+  // Automatically restore mock state between every test
+  // restoreMocks: false,
+
+  // The root directory that Jest should scan for tests and modules within
+  // rootDir: null,
+
+  // A list of paths to directories that Jest should use to search for files in
+  // roots: [
+  //   "<rootDir>"
+  // ],
+
+  // Allows you to use a custom runner instead of Jest's default test runner
+  // runner: "jest-runner",
+
+  // The paths to modules that run some code to configure or set up the testing environment before each test
+  // setupFiles: [],
+
+  // A list of paths to modules that run some code to configure or set up the testing framework before each test
+  // setupFilesAfterEnv: [],
+
+  // A list of paths to snapshot serializer modules Jest should use for snapshot testing
+  // snapshotSerializers: [],
+
+  // The test environment that will be used for testing
+  testEnvironment: "node",
+
+  // Options that will be passed to the testEnvironment
+  // testEnvironmentOptions: {},
+
+  // Adds a location field to test results
+  // testLocationInResults: false,
+
+  // The glob patterns Jest uses to detect test files
+  testMatch: [
+    "**/test/**/*.test.js"
+  ],
+
+  // An array of regexp pattern strings that are matched against all test paths, matched tests are skipped
+  // testPathIgnorePatterns: [
+  //   "/node_modules/"
+  // ],
+
+  // The regexp pattern or array of patterns that Jest uses to detect test files
+  // testRegex: [],
+
+  // This option allows the use of a custom results processor
+  // testResultsProcessor: null,
+
+  // This option allows use of a custom test runner
+  // testRunner: "jasmine2",
+
+  // This option sets the URL for the jsdom environment. It is reflected in properties such as location.href
+  // testURL: "http://localhost",
+
+  // Setting this value to "fake" allows the use of fake timers for functions such as "setTimeout"
+  // timers: "real",
+
+  // A map from regular expressions to paths to transformers
+  transform: {},
+
+  // An array of regexp pattern strings that are matched against all source file paths, matched files will skip transformation
+  // transformIgnorePatterns: [
+  //   "/node_modules/"
+  // ],
+
+  // An array of regexp pattern strings that are matched against all modules before the module loader will automatically return a mock for them
+  // unmockedModulePathPatterns: undefined,
+
+  // Indicates whether each individual test should be reported during the run
+  // verbose: null,
+
+  // An array of regexp patterns that are matched against all source file paths before re-running tests in watch mode
+  // watchPathIgnorePatterns: [],
+
+  // Whether to use watchman for file crawling
+  // watchman: true,
+};

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "@sentryware/s2-node",
+  "version": "0.0.6",
+  "description": "Node.js JavaScript and TypeScript bindings for the Google S2 geolocation library.",
+  "main": "index.js",
+  "types": "index.d.ts",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/sentryware/s2-node.git"
+  },
+  "scripts": {
+    "build": "node-pre-gyp install --build-from-source",
+    "install": "node-pre-gyp install --fallback-to-build",
+    "test": "jest --logHeapUsage --verbose",
+    "publish-to-s3": "node-pre-gyp package unpublish publish"
+  },
+  "author": "Jeff Kao (jeff@radar.com)",
+  "license": "Apache-2.0",
+  "keywords": [
+    "geolocation"
+  ],
+  "devDependencies": {
+    "aws-sdk": "2.x",
+    "bindings": "^1.5.0",
+    "jest": "^24.8.0"
+  },
+  "binary": {
+    "module_name": "s2",
+    "module_path": "./lib/binding/{configuration}/{node_abi}-{platform}-{arch}/",
+    "remote_path": "./{module_name}/v{version}/{configuration}/",
+    "package_name": "{module_name}-v{version}-{node_abi}-{platform}-{arch}.tar.gz",
+    "host": "https://storage.googleapis.com",
+    "bucket": "sentryware-s2-node",
+    "region": "us-central1",
+    "s3ForcePathStyle": true
+  }
+,
+  "dependencies": {
+    "@mapbox/node-pre-gyp": "^2.0.3",
+    "node-addon-api": "^8.6.0",
+    "node-gyp": "^11.5.0"
+  }
+}

package/publish-linux.sh

@@ -0,0 +1,18 @@
+#!/bin/bash
+
+set -ex
+
+export DOCKER_DEFAULT_PLATFORM="${DOCKER_DEFAULT_PLATFORM:-linux/amd64}"
+
+for node in 24 22 20
+do
+  # run image
+  docker run -it \
+    -v "$PWD":/app \
+    -e AWS_DEFAULT_REGION \
+    -e AWS_ACCESS_KEY_ID \
+    -e AWS_SECRET_ACCESS_KEY \
+    -e AWS_SESSION_TOKEN \
+    node:$node \
+    bash -c 'cd /app && npm install && JOBS=max npx node-pre-gyp build package unpublish publish'
+done

package/publish-osx.sh

@@ -0,0 +1,19 @@
+#!/bin/zsh
+
+# to publish x86_64, run with arch -x86_64
+
+set -e
+
+# source ~/.zshrc
+
+# loop through node LTS versions 20 - 24, unpublish and publish them
+# for node in v20 v22 v24
+for node in 20.20.0 22.22.0 24.14.0
+do
+  # nvm install $node
+  # nvm use $node
+  sudo n $node
+  rm -rf node_modules
+  npm install
+  JOBS=max npx node-pre-gyp build package unpublish publish
+done

package/src/builder.cc

@@ -0,0 +1,84 @@
+#include "builder.h"
+
+using s2builderutil::S2PolygonLayer;
+using absl::make_unique;
+
+Napi::FunctionReference Builder::constructor;
+
+Napi::Object Builder::Init(Napi::Env env, Napi::Object exports) {
+  Napi::HandleScope scope(env);
+
+  Napi::Function func = DefineClass(env, "Builder", {
+    InstanceMethod("addLoop", &Builder::AddLoop),
+    InstanceMethod("build", &Builder::Build)
+  });
+
+  constructor = Napi::Persistent(func);
+  constructor.SuppressDestruct();
+
+  exports.Set("Builder", func);
+  return exports;
+}
+
+Builder::Builder(const Napi::CallbackInfo& info) : Napi::ObjectWrap<Builder>(info)  {
+  Napi::Env env = info.Env();
+  Napi::HandleScope scope(env);
+
+  this->s2builderOptions = make_unique<S2Builder::Options>();
+  this->s2builder = make_unique<S2Builder>(*this->s2builderOptions);
+}
+
+Napi::Value Builder::AddLoop(const Napi::CallbackInfo &info) {
+  Napi::Env env = info.Env();
+
+  if (info.Length() <= 0 || !info[0].IsObject()) {
+    Napi::TypeError::New(env, "(loop: s2.Loop) expected.").ThrowAsJavaScriptException();
+    return env.Null();
+  }
+
+  Napi::Object object = info[0].As<Napi::Object>();
+  bool isLoop = object.InstanceOf(Loop::constructor.Value());
+  if (!isLoop) {
+    Napi::TypeError::New(env, "(loop: s2.Loop) expected.").ThrowAsJavaScriptException();
+    return env.Null();
+  }
+
+  Loop* loop = Loop::Unwrap(object);
+
+  this->output = make_unique<S2Polygon>();
+  this->s2builder->StartLayer(
+    make_unique<S2PolygonLayer>(this->output.get())
+  );
+  this->s2builder->AddLoop(*loop->s2loop);
+
+  return env.Null();
+}
+
+Napi::Value Builder::Build(const Napi::CallbackInfo &info) {
+  Napi::Env env = info.Env();
+
+  if (this->output == nullptr) {
+    Napi::Error::New(env, "Add a loop first.").ThrowAsJavaScriptException();
+    return env.Null();
+  }
+
+  S2Error error;
+  bool buildOk = this->s2builder->Build(&error);
+  if (!buildOk) {
+    Napi::Error::New(env, StringPrintf("Build failed: %s", error.text().c_str())).ThrowAsJavaScriptException();
+    return env.Null();
+  }
+
+  if (!this->output->IsValid()) {
+    Napi::Error::New(env, "Output is invalid.").ThrowAsJavaScriptException();
+    return env.Null();
+  }
+
+  // encode the output and return it as a JS object
+  Encoder encoder;
+  this->output->Encode(&encoder);
+
+  return Polygon::constructor.New({
+    Napi::ArrayBuffer::New(env, (void *)encoder.base(), encoder.length())
+  });
+}

package/src/builder.h

@@ -0,0 +1,29 @@
+#ifndef RADAR_BUILDER
+#define RADAR_BUILDER
+
+#include <napi.h>
+#include "loop.h"
+#include "polygon.h"
+#include "s2/s2builder.h"
+#include "s2/s2builderutil_s2polygon_layer.h"
+#include "s2/s2polygon.h"
+#include "s2/third_party/absl/memory/memory.h"
+
+class Builder : public Napi::ObjectWrap<Builder> {
+
+  public:
+    Builder(const Napi::CallbackInfo& info);
+
+    static Napi::FunctionReference constructor;
+    static Napi::Object Init(Napi::Env env, Napi::Object exports);
+
+  private:
+    std::unique_ptr<S2Builder> s2builder;
+    std::unique_ptr<S2Builder::Options> s2builderOptions;
+    std::unique_ptr<S2Polygon> output;
+
+    Napi::Value AddLoop(const Napi::CallbackInfo &info);
+    Napi::Value Build(const Napi::CallbackInfo &info);
+};
+
+#endif

package/src/cell.cc

@@ -0,0 +1,71 @@
+#include "cell.h"
+
+Napi::FunctionReference Cell::constructor;
+
+Napi::Object Cell::Init(Napi::Env env, Napi::Object exports) {
+  Napi::HandleScope scope(env);
+
+  Napi::Function func = DefineClass(env, "Cell", {
+    InstanceMethod("getVertex", &Cell::GetVertex),
+    InstanceMethod("getCenter", &Cell::GetCenter),
+  });
+
+  constructor = Napi::Persistent(func);
+  constructor.SuppressDestruct();
+
+  exports.Set("Cell", func);
+  return exports;
+}
+
+Cell::Cell(const Napi::CallbackInfo& info) : Napi::ObjectWrap<Cell>(info) {
+  Napi::Env env = info.Env();
+  Napi::HandleScope scope(env);
+
+  int length = info.Length();
+  string badArgs = "CellId expected.";
+
+  if (length <= 0 || !info[0].IsObject()) {
+    Napi::TypeError::New(env, badArgs).ThrowAsJavaScriptException();
+    return;
+  }
+
+  Napi::Object object = info[0].As<Napi::Object>();
+  bool isCellId = object.InstanceOf(CellId::constructor.Value());
+  if (!isCellId) {
+    Napi::TypeError::New(env, badArgs).ThrowAsJavaScriptException();
+    return;
+  }
+
+  CellId* cellId = CellId::Unwrap(object);
+  this->s2Cell = S2Cell(cellId->Get());
+}
+
+Napi::Value Cell::GetVertex(const Napi::CallbackInfo &info) {
+  Napi::Env env = info.Env();
+
+  if (info.Length() <= 0 || !info[0].IsNumber()) {
+    Napi::TypeError::New(env, "(vertex: number) expected.").ThrowAsJavaScriptException();
+    return env.Null();
+  }
+
+  Napi::Number vertex = info[0].As<Napi::Number>();
+  S2Point point = s2Cell.GetVertex(vertex);
+
+  return Point::constructor.New({
+    Napi::External<S2Point>::New(env, &point)
+  });
+}
+
+Napi::Value Cell::GetCenter(const Napi::CallbackInfo &info) {
+  Napi::Env env = info.Env();
+
+  S2Point point = s2Cell.GetCenter();
+
+  return Point::constructor.New({
+    Napi::External<S2Point>::New(env, &point)
+  });
+}
+
+S2Cell Cell::Get() {
+  return s2Cell;
+}

package/src/cell.h

@@ -0,0 +1,26 @@
+#ifndef RADAR_CELL
+#define RADAR_CELL
+
+#include <napi.h>
+#include <sstream>
+
+#include "cell_id.h"
+#include "latlng.h"
+#include "point.h"
+#include "s2/s2cell.h"
+
+class Cell : public Napi::ObjectWrap<Cell> {
+  public:
+    Cell(const Napi::CallbackInfo& info);
+    S2Cell Get();
+
+    static Napi::FunctionReference constructor;
+    static Napi::Object Init(Napi::Env env, Napi::Object exports);
+
+  private:
+    Napi::Value GetVertex(const Napi::CallbackInfo &info);
+    Napi::Value GetCenter(const Napi::CallbackInfo &info);
+    S2Cell s2Cell;
+};
+
+#endif