@xyo-network/quadkey 7.0.11 → 7.0.13

package/README.md

@@ -1,3 +1,49 @@
+[![logo][]](https://xyo.network)
+
 # @xyo-network/quadkey
 
-Deprecated compatibility stub. Use `@xyo-network/sdk-protocol/quadkey` instead.
+[![npm][npm-badge]][npm-link]
+[![license][license-badge]][license-link]
+
+> Primary SDK for using XYO Protocol 2.0
+
+## Install
+
+Using npm:
+
+```sh
+npm install {{name}}
+```
+
+Using yarn:
+
+```sh
+yarn add {{name}}
+```
+
+Using pnpm:
+
+```sh
+pnpm add {{name}}
+```
+
+Using bun:
+
+```sh
+bun add {{name}}
+```
+
+
+## License
+
+See the [LICENSE](LICENSE) file for license rights and limitations (LGPL-3.0-only).
+
+## Credits
+
+[Made with 🔥 and ❄️ by XYO Foundation](https://xyo.network)
+
+[npm-badge]: https://img.shields.io/npm/v/@xyo-network/quadkey.svg
+[npm-link]: https://www.npmjs.com/package/@xyo-network/quadkey
+[license-badge]: https://img.shields.io/npm/l/@xyo-network/quadkey.svg
+[license-link]: https://github.com/xylabs/sdk-js/blob/main/LICENSE
+[logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png

package/dist/neutral/Quadkey.d.ts

@@ -0,0 +1,65 @@
+import type { MercatorBoundingBox, MercatorLngLatLike, MercatorTile } from '@xylabs/geo';
+import { GeoJson, MercatorLngLat } from '@xylabs/geo';
+export declare const isQuadkey: (obj: {
+    type: string;
+}) => boolean;
+export declare class Quadkey {
+    static readonly Zero: Quadkey;
+    static readonly root: Quadkey;
+    static readonly type = "Quadkey";
+    private _geoJson?;
+    key: bigint;
+    type: string;
+    constructor(key?: bigint);
+    static from(zoom: number, id: bigint): Quadkey;
+    static fromArrayBuffer(zoom: number, id: ArrayBuffer): Quadkey;
+    static fromBase16String(value: string): Quadkey;
+    static fromBase4String(value?: string): Quadkey;
+    static fromBoundingBox(boundingBox: MercatorBoundingBox, zoom: number): Quadkey[];
+    static fromLngLat(point: MercatorLngLatLike, zoom: number): Quadkey;
+    static fromString(zoom: number, id: string, base?: number): Quadkey;
+    static fromTile(tile: MercatorTile): Quadkey;
+    get base10String(): string;
+    get base16String(): string;
+    get base4Hash(): string;
+    get base4HashLabel(): string;
+    get boundingBox(): MercatorBoundingBox;
+    get center(): MercatorLngLat;
+    get children(): Quadkey[];
+    get gridLocation(): {
+        col: number;
+        row: number;
+        zoom: number;
+    };
+    get id(): bigint;
+    get parent(): Quadkey | undefined;
+    get siblings(): Quadkey[];
+    get tile(): MercatorTile;
+    get valid(): boolean;
+    get zoom(): number;
+    childrenByZoom(zoom: number): Quadkey[];
+    clone(): Quadkey;
+    equals(obj: Quadkey): boolean;
+    geoJson(): GeoJson;
+    getGridBoundingBox(size: number): {
+        height: number;
+        left: number;
+        top: number;
+        width: number;
+    };
+    /** @deprecated use .gridLocation instead */
+    getGridLocation(): {
+        col: number;
+        row: number;
+        zoom: number;
+    };
+    isInBoundingBox(boundingBox: MercatorBoundingBox): boolean;
+    relative(direction: string): Quadkey;
+    setId(id: bigint): this;
+    setKey(zoom: number, key: bigint): this;
+    setZoom(zoom: number): this;
+    toJSON(): string;
+    toString(): string;
+    protected guessZoom(): void;
+}
+//# sourceMappingURL=Quadkey.d.ts.map

package/dist/neutral/Quadkey.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Quadkey.d.ts","sourceRoot":"","sources":["../../src/Quadkey.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EACV,mBAAmB,EACnB,kBAAkB,EAClB,YAAY,EACb,MAAM,aAAa,CAAA;AACpB,OAAO,EAEL,OAAO,EACP,cAAc,EAMf,MAAM,aAAa,CAAA;AAMpB,eAAO,MAAM,SAAS,GAAI,KAAK;IAAE,IAAI,EAAE,MAAM,CAAA;CAAE,YAA+B,CAAA;AA2B9E,qBAAa,OAAO;IAClB,MAAM,CAAC,QAAQ,CAAC,IAAI,UAAsB;IAC1C,MAAM,CAAC,QAAQ,CAAC,IAAI,UAAgB;IACpC,MAAM,CAAC,QAAQ,CAAC,IAAI,aAAY;IAEhC,OAAO,CAAC,QAAQ,CAAC,CAAS;IAE1B,GAAG,EAAE,MAAM,CAAA;IAEX,IAAI,SAAe;gBAEP,GAAG,SAAK;IAMpB,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM;IAKpC,MAAM,CAAC,eAAe,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,WAAW;IAKpD,MAAM,CAAC,gBAAgB,CAAC,KAAK,EAAE,MAAM;IAIrC,MAAM,CAAC,eAAe,CAAC,KAAK,CAAC,EAAE,MAAM;IAcrC,MAAM,CAAC,eAAe,CAAC,WAAW,EAAE,mBAAmB,EAAE,IAAI,EAAE,MAAM;IAKrE,MAAM,CAAC,UAAU,CAAC,KAAK,EAAE,kBAAkB,EAAE,IAAI,EAAE,MAAM;IAMzD,MAAM,CAAC,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,IAAI,SAAK;IAWrD,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,YAAY;IAIlC,IAAI,YAAY,WAEf;IAED,IAAI,YAAY,WAEf;IAED,IAAI,SAAS,WAKZ;IAED,IAAI,cAAc,WAGjB;IAED,IAAI,WAAW,IAAI,mBAAmB,CAErC;IAED,IAAI,MAAM,mBAGT;IAED,IAAI,QAAQ,cASX;IAED,IAAI,YAAY,IAAI;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,GAAG,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,CAQ7D;IAED,IAAI,EAAE,WAEL;IAED,IAAI,MAAM,IAAI,OAAO,GAAG,SAAS,CAMhC;IAED,IAAI,QAAQ,cAKX;IAED,IAAI,IAAI,IAAI,YAAY,CAEvB;IAED,IAAI,KAAK,YAGR;IAED,IAAI,IAAI,WAGP;IAED,cAAc,CAAC,IAAI,EAAE,MAAM;IAc3B,KAAK;IAIL,MAAM,CAAC,GAAG,EAAE,OAAO,GAAG,OAAO;IAI7B,OAAO;IAKP,kBAAkB,CAAC,IAAI,EAAE,MAAM;;;;;;IAwB/B,4CAA4C;IAC5C,eAAe;aA/FY,MAAM;aAAO,MAAM;cAAQ,MAAM;;IAmG5D,eAAe,CAAC,WAAW,EAAE,mBAAmB;IAUhD,QAAQ,CAAC,SAAS,EAAE,MAAM;IAyB1B,KAAK,CAAC,EAAE,EAAE,MAAM;IAMhB,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM;IAOhC,OAAO,CAAC,IAAI,EAAE,MAAM;IAMpB,MAAM,IAAI,MAAM;IAIhB,QAAQ;IAIR,SAAS,CAAC,SAAS;CAIpB"}

package/dist/neutral/RelativeDirectionConstantLookup.d.ts

@@ -0,0 +1,2 @@
+export declare const RelativeDirectionConstantLookup: Record<string, number>;
+//# sourceMappingURL=RelativeDirectionConstantLookup.d.ts.map

package/dist/neutral/RelativeDirectionConstantLookup.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RelativeDirectionConstantLookup.d.ts","sourceRoot":"","sources":["../../src/RelativeDirectionConstantLookup.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,+BAA+B,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAKlE,CAAA"}

package/dist/neutral/index.d.ts

@@ -1,6 +1,2 @@
-/**
- * @deprecated Use `@xyo-network/sdk-protocol/quadkey` instead.
- * `@xyo-network/quadkey` is a backward-compatibility re-export stub.
- */
-export * from '@xyo-network/sdk-protocol/quadkey';
+export * from './Quadkey.ts';
 //# sourceMappingURL=index.d.ts.map

package/dist/neutral/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,cAAc,mCAAmC,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAA"}

package/dist/neutral/index.mjs

@@ -1,3 +1,281 @@
-// src/index.ts
-export * from "@xyo-network/sdk-protocol/quadkey";
+// src/Quadkey.ts
+import {
+  assertEx,
+  hexFromArrayBuffer,
+  hexFromHexString
+} from "@ariestools/sdk";
+import {
+  boundingBoxToCenter,
+  GeoJson,
+  MercatorLngLat,
+  tileFromPoint,
+  tileFromQuadkey,
+  tilesFromBoundingBox,
+  tileToBoundingBox,
+  tileToQuadkey
+} from "@xylabs/geo";
+
+// src/RelativeDirectionConstantLookup.ts
+var RelativeDirectionConstantLookup = {
+  e: 1,
+  n: -2,
+  s: 2,
+  w: -1
+};
+
+// src/Quadkey.ts
+var MAX_ZOOM = 124;
+var isQuadkey = (obj) => obj?.type === Quadkey.type;
+var FULL_MASK = 2n ** 256n - 1n;
+var ZOOM_MASK = 0xFFn << 248n;
+var ID_MASK = ZOOM_MASK ^ FULL_MASK;
+var assertMaxBitUint = (value, bits = 256n) => {
+  assertEx(value < 2n ** bits && value >= 0, () => "Not a 256 Bit Uint!");
+};
+function gridOffsetForDigit(digit, blockSize) {
+  switch (digit) {
+    case "1": {
+      return { left: blockSize, top: 0 };
+    }
+    case "2": {
+      return { left: 0, top: blockSize };
+    }
+    case "3": {
+      return { left: blockSize, top: blockSize };
+    }
+    default: {
+      return { left: 0, top: 0 };
+    }
+  }
+}
+var Quadkey = class _Quadkey {
+  static Zero = _Quadkey.from(0, 0n);
+  static root = new _Quadkey();
+  static type = "Quadkey";
+  _geoJson;
+  key;
+  type = _Quadkey.type;
+  constructor(key = 0n) {
+    assertMaxBitUint(key);
+    this.key = key;
+    this.guessZoom();
+  }
+  static from(zoom, id) {
+    const quadkey = new _Quadkey();
+    return quadkey.setId(id).setZoom(zoom);
+  }
+  static fromArrayBuffer(zoom, id) {
+    const quadkey = new _Quadkey();
+    return quadkey.setId(BigInt(hexFromArrayBuffer(id, { prefix: true }))).setZoom(zoom);
+  }
+  static fromBase16String(value) {
+    return new _Quadkey(BigInt(hexFromHexString(value, { prefix: true })));
+  }
+  static fromBase4String(value) {
+    if (value === void 0 || ["fhr", ""].includes(value)) {
+      return this.root;
+    }
+    let id = 0n;
+    for (const digit of value) {
+      const nibble = Number.parseInt(digit);
+      assertEx(nibble < 4 && nibble >= 0, () => `Invalid Base4 String: ${value}`);
+      id = id << 2n | BigInt(nibble);
+    }
+    const quadkey = new _Quadkey();
+    return quadkey.setId(id).setZoom(value.length);
+  }
+  static fromBoundingBox(boundingBox, zoom) {
+    const tiles = tilesFromBoundingBox(boundingBox, Math.floor(zoom));
+    return Array.from(tiles, (tile) => assertEx(this.fromTile(tile), () => "Bad Quadkey"));
+  }
+  static fromLngLat(point, zoom) {
+    const tile = tileFromPoint(point, zoom);
+    const quadkeyString = tileToQuadkey(tile);
+    return this.fromBase4String(quadkeyString);
+  }
+  static fromString(zoom, id, base = 16) {
+    switch (base) {
+      case 16: {
+        return this.fromBase16String(id).setZoom(zoom);
+      }
+      default: {
+        throw new Error(`Invalid base [${base}]`);
+      }
+    }
+  }
+  static fromTile(tile) {
+    return this.fromBase4String(tileToQuadkey(tile));
+  }
+  get base10String() {
+    return this.id.toString(10);
+  }
+  get base16String() {
+    return this.id.toString(16).padStart(62, "0");
+  }
+  get base4Hash() {
+    if (this.id === 0n && this.zoom === 0) {
+      return "";
+    }
+    return this.id.toString(4).padStart(this.zoom, "0");
+  }
+  get base4HashLabel() {
+    const hash = this.base4Hash;
+    return hash.length === 0 ? "fhr" : hash;
+  }
+  get boundingBox() {
+    return tileToBoundingBox(this.tile);
+  }
+  get center() {
+    const result = boundingBoxToCenter(this.boundingBox);
+    return new MercatorLngLat(result[0], result[1]);
+  }
+  get children() {
+    assertEx(this.zoom < MAX_ZOOM - 1, () => "Can not get children of bottom tiles");
+    const result = [];
+    const shiftedId = this.id << 2n;
+    for (let i = 0n; i < 4n; i++) {
+      const quadkey = new _Quadkey();
+      result.push(quadkey.setId(shiftedId | i).setZoom(this.zoom + 1));
+    }
+    return result;
+  }
+  get gridLocation() {
+    const tileData = tileFromQuadkey(this.base4Hash);
+    return {
+      col: 2 ** tileData[2] - tileData[1] - 1,
+      row: tileData[0],
+      zoom: tileData[2]
+    };
+  }
+  get id() {
+    return this.key & ID_MASK;
+  }
+  get parent() {
+    if (this.zoom <= 0) {
+      return;
+    }
+    const quadkey = new _Quadkey();
+    return quadkey.setId(this.id >> 2n).setZoom(this.zoom - 1);
+  }
+  get siblings() {
+    const siblings = assertEx(this.parent?.children, () => `siblings: parentChildren ${this.base4Hash}`);
+    const filteredSiblings = siblings.filter((quadkey) => quadkey.key !== this.key);
+    assertEx(filteredSiblings.length === 3, () => `siblings: expected 3 [${filteredSiblings.length}]`);
+    return filteredSiblings;
+  }
+  get tile() {
+    return tileFromQuadkey(this.base4Hash);
+  }
+  get valid() {
+    return this.id.toString(4) === this.base4Hash.padStart(64, "0");
+  }
+  get zoom() {
+    return Number((this.key & ZOOM_MASK) >> 248n);
+  }
+  childrenByZoom(zoom) {
+    if (zoom > 0 && zoom === this.zoom) {
+      return [this];
+    }
+    let deepResult = [];
+    for (const quadkey of this.children) {
+      deepResult = [...deepResult, ...quadkey.childrenByZoom(zoom)];
+    }
+    return deepResult;
+  }
+  clone() {
+    return new _Quadkey(this.key);
+  }
+  equals(obj) {
+    return obj.key == this.key;
+  }
+  geoJson() {
+    this._geoJson = this._geoJson ?? new GeoJson(this.base4Hash);
+    return this._geoJson;
+  }
+  getGridBoundingBox(size) {
+    const hash = this.base4Hash;
+    let index = 0;
+    let left = 0;
+    let top = 0;
+    let blockSize = size;
+    while (index < hash.length) {
+      blockSize >>= 1;
+      const offset = gridOffsetForDigit(hash[index], blockSize);
+      left += offset.left;
+      top += offset.top;
+      index++;
+    }
+    if (blockSize < 2) {
+      blockSize = 2;
+    }
+    return {
+      height: blockSize,
+      left,
+      top,
+      width: blockSize
+    };
+  }
+  /** @deprecated use .gridLocation instead */
+  getGridLocation() {
+    return this.gridLocation;
+  }
+  isInBoundingBox(boundingBox) {
+    const tileBoundingBox = tileToBoundingBox(this.tile);
+    return boundingBox.contains(tileBoundingBox.getNorthEast()) || boundingBox.contains(tileBoundingBox.getNorthWest()) || boundingBox.contains(tileBoundingBox.getSouthEast()) || boundingBox.contains(tileBoundingBox.getSouthWest());
+  }
+  relative(direction) {
+    const directionConstant = assertEx(RelativeDirectionConstantLookup[direction], () => "Invalid direction");
+    let quadkey = this.base4Hash;
+    if (quadkey.length === 0) {
+      return this;
+    }
+    let index = quadkey.length - 1;
+    while (index >= 0) {
+      let number = Number.parseInt(quadkey.charAt(index));
+      number += directionConstant;
+      if (number > 3) {
+        number -= 4;
+        quadkey = quadkey.slice(0, Math.max(0, index)) + number.toString() + quadkey.slice(Math.max(0, index + 1));
+        index--;
+      } else if (number < 0) {
+        number += 4;
+        quadkey = quadkey.slice(0, Math.max(0, index)) + number.toString() + quadkey.slice(Math.max(0, index + 1));
+        index--;
+      } else {
+        index = -1;
+      }
+    }
+    return _Quadkey.fromBase4String(quadkey);
+  }
+  setId(id) {
+    assertMaxBitUint(id, 248n);
+    this.setKey(this.zoom, id);
+    return this;
+  }
+  setKey(zoom, key) {
+    assertMaxBitUint(key);
+    this.key = key;
+    this.setZoom(zoom);
+    return this;
+  }
+  setZoom(zoom) {
+    assertEx(zoom < MAX_ZOOM, () => `Invalid zoom [${zoom}] max=${MAX_ZOOM}`);
+    this.key = this.key & ID_MASK | BigInt(zoom) << 248n;
+    return this;
+  }
+  toJSON() {
+    return this.base4HashLabel;
+  }
+  toString() {
+    return this.base4Hash;
+  }
+  guessZoom() {
+    const quadkeySimple = this.id.toString(4);
+    this.setZoom(quadkeySimple.length);
+  }
+};
+export {
+  Quadkey,
+  isQuadkey
+};
 //# sourceMappingURL=index.mjs.map

package/dist/neutral/index.mjs.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
-  "sources": ["../../src/index.ts"],
-  "sourcesContent": ["/**\n * @deprecated Use `@xyo-network/sdk-protocol/quadkey` instead.\n * `@xyo-network/quadkey` is a backward-compatibility re-export stub.\n */\nexport * from '@xyo-network/sdk-protocol/quadkey'\n"],
-  "mappings": ";AAIA,cAAc;",
+  "sources": ["../../src/Quadkey.ts", "../../src/RelativeDirectionConstantLookup.ts"],
+  "sourcesContent": ["import {\n  assertEx, hexFromArrayBuffer, hexFromHexString,\n} from '@ariestools/sdk'\nimport type {\n  MercatorBoundingBox,\n  MercatorLngLatLike,\n  MercatorTile,\n} from '@xylabs/geo'\nimport {\n  boundingBoxToCenter,\n  GeoJson,\n  MercatorLngLat,\n  tileFromPoint,\n  tileFromQuadkey,\n  tilesFromBoundingBox,\n  tileToBoundingBox,\n  tileToQuadkey,\n} from '@xylabs/geo'\n\nimport { RelativeDirectionConstantLookup } from './RelativeDirectionConstantLookup.ts'\n\nconst MAX_ZOOM = 124\n\nexport const isQuadkey = (obj: { type: string }) => obj?.type === Quadkey.type\n\nconst FULL_MASK = 2n ** 256n - 1n\nconst ZOOM_MASK = 0xFFn << 248n\nconst ID_MASK = ZOOM_MASK ^ FULL_MASK\n\nconst assertMaxBitUint = (value: bigint, bits = 256n) => {\n  assertEx(value < 2n ** bits && value >= 0, () => 'Not a 256 Bit Uint!')\n}\n\nfunction gridOffsetForDigit(digit: string, blockSize: number): { left: number; top: number } {\n  switch (digit) {\n    case '1': {\n      return { left: blockSize, top: 0 }\n    }\n    case '2': {\n      return { left: 0, top: blockSize }\n    }\n    case '3': {\n      return { left: blockSize, top: blockSize }\n    }\n    default: {\n      return { left: 0, top: 0 }\n    }\n  }\n}\n\nexport class Quadkey {\n  static readonly Zero = Quadkey.from(0, 0n)\n  static readonly root = new Quadkey()\n  static readonly type = 'Quadkey'\n\n  private _geoJson?: GeoJson\n\n  key: bigint\n\n  type = Quadkey.type\n\n  constructor(key = 0n) {\n    assertMaxBitUint(key)\n    this.key = key\n    this.guessZoom()\n  }\n\n  static from(zoom: number, id: bigint) {\n    const quadkey = new Quadkey()\n    return quadkey.setId(id).setZoom(zoom)\n  }\n\n  static fromArrayBuffer(zoom: number, id: ArrayBuffer) {\n    const quadkey = new Quadkey()\n    return quadkey.setId(BigInt(hexFromArrayBuffer(id, { prefix: true }))).setZoom(zoom)\n  }\n\n  static fromBase16String(value: string) {\n    return new Quadkey(BigInt(hexFromHexString(value, { prefix: true })))\n  }\n\n  static fromBase4String(value?: string) {\n    if (value === undefined || ['fhr', ''].includes(value)) {\n      return this.root\n    }\n    let id = 0n\n    for (const digit of value) {\n      const nibble = Number.parseInt(digit)\n      assertEx(nibble < 4 && nibble >= 0, () => `Invalid Base4 String: ${value}`)\n      id = (id << 2n) | BigInt(nibble)\n    }\n    const quadkey = new Quadkey()\n    return quadkey.setId(id).setZoom(value.length)\n  }\n\n  static fromBoundingBox(boundingBox: MercatorBoundingBox, zoom: number) {\n    const tiles = tilesFromBoundingBox(boundingBox, Math.floor(zoom))\n    return Array.from(tiles, tile => assertEx(this.fromTile(tile), () => 'Bad Quadkey'))\n  }\n\n  static fromLngLat(point: MercatorLngLatLike, zoom: number) {\n    const tile = tileFromPoint(point as MercatorLngLat, zoom)\n    const quadkeyString = tileToQuadkey(tile)\n    return this.fromBase4String(quadkeyString)\n  }\n\n  static fromString(zoom: number, id: string, base = 16) {\n    switch (base) {\n      case 16: {\n        return this.fromBase16String(id).setZoom(zoom)\n      }\n      default: {\n        throw new Error(`Invalid base [${base}]`)\n      }\n    }\n  }\n\n  static fromTile(tile: MercatorTile) {\n    return this.fromBase4String(tileToQuadkey(tile))\n  }\n\n  get base10String() {\n    return this.id.toString(10)\n  }\n\n  get base16String() {\n    return this.id.toString(16).padStart(62, '0')\n  }\n\n  get base4Hash() {\n    if (this.id === 0n && this.zoom === 0) {\n      return ''\n    }\n    return this.id.toString(4).padStart(this.zoom, '0')\n  }\n\n  get base4HashLabel() {\n    const hash = this.base4Hash\n    return hash.length === 0 ? 'fhr' : hash\n  }\n\n  get boundingBox(): MercatorBoundingBox {\n    return tileToBoundingBox(this.tile)\n  }\n\n  get center() {\n    const result = boundingBoxToCenter(this.boundingBox)\n    return new MercatorLngLat(result[0], result[1])\n  }\n\n  get children() {\n    assertEx(this.zoom < MAX_ZOOM - 1, () => 'Can not get children of bottom tiles')\n    const result: Quadkey[] = []\n    const shiftedId = this.id << 2n\n    for (let i = 0n; i < 4n; i++) {\n      const quadkey = new Quadkey()\n      result.push(quadkey.setId(shiftedId | i).setZoom(this.zoom + 1))\n    }\n    return result\n  }\n\n  get gridLocation(): { col: number; row: number; zoom: number } {\n    const tileData = tileFromQuadkey(this.base4Hash)\n\n    return {\n      col: 2 ** tileData[2] - tileData[1] - 1,\n      row: tileData[0],\n      zoom: tileData[2],\n    }\n  }\n\n  get id() {\n    return this.key & ID_MASK\n  }\n\n  get parent(): Quadkey | undefined {\n    if (this.zoom <= 0) {\n      return\n    }\n    const quadkey = new Quadkey()\n    return quadkey.setId(this.id >> 2n).setZoom(this.zoom - 1)\n  }\n\n  get siblings() {\n    const siblings = assertEx(this.parent?.children, () => `siblings: parentChildren ${this.base4Hash}`)\n    const filteredSiblings = siblings.filter(quadkey => quadkey.key !== this.key)\n    assertEx(filteredSiblings.length === 3, () => `siblings: expected 3 [${filteredSiblings.length}]`)\n    return filteredSiblings\n  }\n\n  get tile(): MercatorTile {\n    return tileFromQuadkey(this.base4Hash)\n  }\n\n  get valid() {\n    // check for additional data outside zoom scope\n    return this.id.toString(4) === this.base4Hash.padStart(64, '0')\n  }\n\n  get zoom() {\n    // zoom is stored in top byte\n    return Number((this.key & ZOOM_MASK) >> 248n)\n  }\n\n  childrenByZoom(zoom: number) {\n    // if we are limiting by zoom, and we are already at that limit, just return this quadkey\n    if (zoom > 0 && zoom === this.zoom) {\n      return [this]\n    }\n\n    // recursively get children\n    let deepResult: Quadkey[] = []\n    for (const quadkey of this.children) {\n      deepResult = [...deepResult, ...quadkey.childrenByZoom(zoom)]\n    }\n    return deepResult\n  }\n\n  clone() {\n    return new Quadkey(this.key)\n  }\n\n  equals(obj: Quadkey): boolean {\n    return obj.key == this.key\n  }\n\n  geoJson() {\n    this._geoJson = this._geoJson ?? new GeoJson(this.base4Hash)\n    return this._geoJson\n  }\n\n  getGridBoundingBox(size: number) {\n    const hash = this.base4Hash\n    let index = 0\n    let left = 0\n    let top = 0\n    let blockSize = size\n    while (index < hash.length) {\n      blockSize >>= 1\n      const offset = gridOffsetForDigit(hash[index], blockSize)\n      left += offset.left\n      top += offset.top\n      index++\n    }\n    if (blockSize < 2) {\n      blockSize = 2\n    }\n    return {\n      height: blockSize,\n      left,\n      top,\n      width: blockSize,\n    }\n  }\n\n  /** @deprecated use .gridLocation instead */\n  getGridLocation() {\n    return this.gridLocation\n  }\n\n  isInBoundingBox(boundingBox: MercatorBoundingBox) {\n    const tileBoundingBox = tileToBoundingBox(this.tile)\n    return (\n      boundingBox.contains(tileBoundingBox.getNorthEast())\n      || boundingBox.contains(tileBoundingBox.getNorthWest())\n      || boundingBox.contains(tileBoundingBox.getSouthEast())\n      || boundingBox.contains(tileBoundingBox.getSouthWest())\n    )\n  }\n\n  relative(direction: string) {\n    const directionConstant = assertEx(RelativeDirectionConstantLookup[direction], () => 'Invalid direction')\n    let quadkey = this.base4Hash\n    if (quadkey.length === 0) {\n      return this\n    }\n    let index = quadkey.length - 1\n    while (index >= 0) {\n      let number = Number.parseInt(quadkey.charAt(index))\n      number += directionConstant\n      if (number > 3) {\n        number -= 4\n        quadkey = quadkey.slice(0, Math.max(0, index)) + number.toString() + quadkey.slice(Math.max(0, index + 1))\n        index--\n      } else if (number < 0) {\n        number += 4\n        quadkey = quadkey.slice(0, Math.max(0, index)) + number.toString() + quadkey.slice(Math.max(0, index + 1))\n        index--\n      } else {\n        index = -1\n      }\n    }\n    return Quadkey.fromBase4String(quadkey)\n  }\n\n  setId(id: bigint) {\n    assertMaxBitUint(id, 248n)\n    this.setKey(this.zoom, id)\n    return this\n  }\n\n  setKey(zoom: number, key: bigint) {\n    assertMaxBitUint(key)\n    this.key = key\n    this.setZoom(zoom)\n    return this\n  }\n\n  setZoom(zoom: number) {\n    assertEx(zoom < MAX_ZOOM, () => `Invalid zoom [${zoom}] max=${MAX_ZOOM}`)\n    this.key = (this.key & ID_MASK) | (BigInt(zoom) << 248n)\n    return this\n  }\n\n  toJSON(): string {\n    return this.base4HashLabel\n  }\n\n  toString() {\n    return this.base4Hash\n  }\n\n  protected guessZoom() {\n    const quadkeySimple = this.id.toString(4)\n    this.setZoom(quadkeySimple.length)\n  }\n}\n", "export const RelativeDirectionConstantLookup: Record<string, number> = {\n  e: 1,\n  n: -2,\n  s: 2,\n  w: -1,\n}\n"],
+  "mappings": ";AAAA;AAAA,EACE;AAAA,EAAU;AAAA,EAAoB;AAAA,OACzB;AAMP;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;;;ACjBA,IAAM,kCAA0D;AAAA,EACrE,GAAG;AAAA,EACH,GAAG;AAAA,EACH,GAAG;AAAA,EACH,GAAG;AACL;;;ADgBA,IAAM,WAAW;AAEV,IAAM,YAAY,CAAC,QAA0B,KAAK,SAAS,QAAQ;AAE1E,IAAM,YAAY,MAAM,OAAO;AAC/B,IAAM,YAAY,SAAS;AAC3B,IAAM,UAAU,YAAY;AAE5B,IAAM,mBAAmB,CAAC,OAAe,OAAO,SAAS;AACvD,WAAS,QAAQ,MAAM,QAAQ,SAAS,GAAG,MAAM,qBAAqB;AACxE;AAEA,SAAS,mBAAmB,OAAe,WAAkD;AAC3F,UAAQ,OAAO;AAAA,IACb,KAAK,KAAK;AACR,aAAO,EAAE,MAAM,WAAW,KAAK,EAAE;AAAA,IACnC;AAAA,IACA,KAAK,KAAK;AACR,aAAO,EAAE,MAAM,GAAG,KAAK,UAAU;AAAA,IACnC;AAAA,IACA,KAAK,KAAK;AACR,aAAO,EAAE,MAAM,WAAW,KAAK,UAAU;AAAA,IAC3C;AAAA,IACA,SAAS;AACP,aAAO,EAAE,MAAM,GAAG,KAAK,EAAE;AAAA,IAC3B;AAAA,EACF;AACF;AAEO,IAAM,UAAN,MAAM,SAAQ;AAAA,EACnB,OAAgB,OAAO,SAAQ,KAAK,GAAG,EAAE;AAAA,EACzC,OAAgB,OAAO,IAAI,SAAQ;AAAA,EACnC,OAAgB,OAAO;AAAA,EAEf;AAAA,EAER;AAAA,EAEA,OAAO,SAAQ;AAAA,EAEf,YAAY,MAAM,IAAI;AACpB,qBAAiB,GAAG;AACpB,SAAK,MAAM;AACX,SAAK,UAAU;AAAA,EACjB;AAAA,EAEA,OAAO,KAAK,MAAc,IAAY;AACpC,UAAM,UAAU,IAAI,SAAQ;AAC5B,WAAO,QAAQ,MAAM,EAAE,EAAE,QAAQ,IAAI;AAAA,EACvC;AAAA,EAEA,OAAO,gBAAgB,MAAc,IAAiB;AACpD,UAAM,UAAU,IAAI,SAAQ;AAC5B,WAAO,QAAQ,MAAM,OAAO,mBAAmB,IAAI,EAAE,QAAQ,KAAK,CAAC,CAAC,CAAC,EAAE,QAAQ,IAAI;AAAA,EACrF;AAAA,EAEA,OAAO,iBAAiB,OAAe;AACrC,WAAO,IAAI,SAAQ,OAAO,iBAAiB,OAAO,EAAE,QAAQ,KAAK,CAAC,CAAC,CAAC;AAAA,EACtE;AAAA,EAEA,OAAO,gBAAgB,OAAgB;AACrC,QAAI,UAAU,UAAa,CAAC,OAAO,EAAE,EAAE,SAAS,KAAK,GAAG;AACtD,aAAO,KAAK;AAAA,IACd;AACA,QAAI,KAAK;AACT,eAAW,SAAS,OAAO;AACzB,YAAM,SAAS,OAAO,SAAS,KAAK;AACpC,eAAS,SAAS,KAAK,UAAU,GAAG,MAAM,yBAAyB,KAAK,EAAE;AAC1E,WAAM,MAAM,KAAM,OAAO,MAAM;AAAA,IACjC;AACA,UAAM,UAAU,IAAI,SAAQ;AAC5B,WAAO,QAAQ,MAAM,EAAE,EAAE,QAAQ,MAAM,MAAM;AAAA,EAC/C;AAAA,EAEA,OAAO,gBAAgB,aAAkC,MAAc;AACrE,UAAM,QAAQ,qBAAqB,aAAa,KAAK,MAAM,IAAI,CAAC;AAChE,WAAO,MAAM,KAAK,OAAO,UAAQ,SAAS,KAAK,SAAS,IAAI,GAAG,MAAM,aAAa,CAAC;AAAA,EACrF;AAAA,EAEA,OAAO,WAAW,OAA2B,MAAc;AACzD,UAAM,OAAO,cAAc,OAAyB,IAAI;AACxD,UAAM,gBAAgB,cAAc,IAAI;AACxC,WAAO,KAAK,gBAAgB,aAAa;AAAA,EAC3C;AAAA,EAEA,OAAO,WAAW,MAAc,IAAY,OAAO,IAAI;AACrD,YAAQ,MAAM;AAAA,MACZ,KAAK,IAAI;AACP,eAAO,KAAK,iBAAiB,EAAE,EAAE,QAAQ,IAAI;AAAA,MAC/C;AAAA,MACA,SAAS;AACP,cAAM,IAAI,MAAM,iBAAiB,IAAI,GAAG;AAAA,MAC1C;AAAA,IACF;AAAA,EACF;AAAA,EAEA,OAAO,SAAS,MAAoB;AAClC,WAAO,KAAK,gBAAgB,cAAc,IAAI,CAAC;AAAA,EACjD;AAAA,EAEA,IAAI,eAAe;AACjB,WAAO,KAAK,GAAG,SAAS,EAAE;AAAA,EAC5B;AAAA,EAEA,IAAI,eAAe;AACjB,WAAO,KAAK,GAAG,SAAS,EAAE,EAAE,SAAS,IAAI,GAAG;AAAA,EAC9C;AAAA,EAEA,IAAI,YAAY;AACd,QAAI,KAAK,OAAO,MAAM,KAAK,SAAS,GAAG;AACrC,aAAO;AAAA,IACT;AACA,WAAO,KAAK,GAAG,SAAS,CAAC,EAAE,SAAS,KAAK,MAAM,GAAG;AAAA,EACpD;AAAA,EAEA,IAAI,iBAAiB;AACnB,UAAM,OAAO,KAAK;AAClB,WAAO,KAAK,WAAW,IAAI,QAAQ;AAAA,EACrC;AAAA,EAEA,IAAI,cAAmC;AACrC,WAAO,kBAAkB,KAAK,IAAI;AAAA,EACpC;AAAA,EAEA,IAAI,SAAS;AACX,UAAM,SAAS,oBAAoB,KAAK,WAAW;AACnD,WAAO,IAAI,eAAe,OAAO,CAAC,GAAG,OAAO,CAAC,CAAC;AAAA,EAChD;AAAA,EAEA,IAAI,WAAW;AACb,aAAS,KAAK,OAAO,WAAW,GAAG,MAAM,sCAAsC;AAC/E,UAAM,SAAoB,CAAC;AAC3B,UAAM,YAAY,KAAK,MAAM;AAC7B,aAAS,IAAI,IAAI,IAAI,IAAI,KAAK;AAC5B,YAAM,UAAU,IAAI,SAAQ;AAC5B,aAAO,KAAK,QAAQ,MAAM,YAAY,CAAC,EAAE,QAAQ,KAAK,OAAO,CAAC,CAAC;AAAA,IACjE;AACA,WAAO;AAAA,EACT;AAAA,EAEA,IAAI,eAA2D;AAC7D,UAAM,WAAW,gBAAgB,KAAK,SAAS;AAE/C,WAAO;AAAA,MACL,KAAK,KAAK,SAAS,CAAC,IAAI,SAAS,CAAC,IAAI;AAAA,MACtC,KAAK,SAAS,CAAC;AAAA,MACf,MAAM,SAAS,CAAC;AAAA,IAClB;AAAA,EACF;AAAA,EAEA,IAAI,KAAK;AACP,WAAO,KAAK,MAAM;AAAA,EACpB;AAAA,EAEA,IAAI,SAA8B;AAChC,QAAI,KAAK,QAAQ,GAAG;AAClB;AAAA,IACF;AACA,UAAM,UAAU,IAAI,SAAQ;AAC5B,WAAO,QAAQ,MAAM,KAAK,MAAM,EAAE,EAAE,QAAQ,KAAK,OAAO,CAAC;AAAA,EAC3D;AAAA,EAEA,IAAI,WAAW;AACb,UAAM,WAAW,SAAS,KAAK,QAAQ,UAAU,MAAM,4BAA4B,KAAK,SAAS,EAAE;AACnG,UAAM,mBAAmB,SAAS,OAAO,aAAW,QAAQ,QAAQ,KAAK,GAAG;AAC5E,aAAS,iBAAiB,WAAW,GAAG,MAAM,yBAAyB,iBAAiB,MAAM,GAAG;AACjG,WAAO;AAAA,EACT;AAAA,EAEA,IAAI,OAAqB;AACvB,WAAO,gBAAgB,KAAK,SAAS;AAAA,EACvC;AAAA,EAEA,IAAI,QAAQ;AAEV,WAAO,KAAK,GAAG,SAAS,CAAC,MAAM,KAAK,UAAU,SAAS,IAAI,GAAG;AAAA,EAChE;AAAA,EAEA,IAAI,OAAO;AAET,WAAO,QAAQ,KAAK,MAAM,cAAc,IAAI;AAAA,EAC9C;AAAA,EAEA,eAAe,MAAc;AAE3B,QAAI,OAAO,KAAK,SAAS,KAAK,MAAM;AAClC,aAAO,CAAC,IAAI;AAAA,IACd;AAGA,QAAI,aAAwB,CAAC;AAC7B,eAAW,WAAW,KAAK,UAAU;AACnC,mBAAa,CAAC,GAAG,YAAY,GAAG,QAAQ,eAAe,IAAI,CAAC;AAAA,IAC9D;AACA,WAAO;AAAA,EACT;AAAA,EAEA,QAAQ;AACN,WAAO,IAAI,SAAQ,KAAK,GAAG;AAAA,EAC7B;AAAA,EAEA,OAAO,KAAuB;AAC5B,WAAO,IAAI,OAAO,KAAK;AAAA,EACzB;AAAA,EAEA,UAAU;AACR,SAAK,WAAW,KAAK,YAAY,IAAI,QAAQ,KAAK,SAAS;AAC3D,WAAO,KAAK;AAAA,EACd;AAAA,EAEA,mBAAmB,MAAc;AAC/B,UAAM,OAAO,KAAK;AAClB,QAAI,QAAQ;AACZ,QAAI,OAAO;AACX,QAAI,MAAM;AACV,QAAI,YAAY;AAChB,WAAO,QAAQ,KAAK,QAAQ;AAC1B,oBAAc;AACd,YAAM,SAAS,mBAAmB,KAAK,KAAK,GAAG,SAAS;AACxD,cAAQ,OAAO;AACf,aAAO,OAAO;AACd;AAAA,IACF;AACA,QAAI,YAAY,GAAG;AACjB,kBAAY;AAAA,IACd;AACA,WAAO;AAAA,MACL,QAAQ;AAAA,MACR;AAAA,MACA;AAAA,MACA,OAAO;AAAA,IACT;AAAA,EACF;AAAA;AAAA,EAGA,kBAAkB;AAChB,WAAO,KAAK;AAAA,EACd;AAAA,EAEA,gBAAgB,aAAkC;AAChD,UAAM,kBAAkB,kBAAkB,KAAK,IAAI;AACnD,WACE,YAAY,SAAS,gBAAgB,aAAa,CAAC,KAChD,YAAY,SAAS,gBAAgB,aAAa,CAAC,KACnD,YAAY,SAAS,gBAAgB,aAAa,CAAC,KACnD,YAAY,SAAS,gBAAgB,aAAa,CAAC;AAAA,EAE1D;AAAA,EAEA,SAAS,WAAmB;AAC1B,UAAM,oBAAoB,SAAS,gCAAgC,SAAS,GAAG,MAAM,mBAAmB;AACxG,QAAI,UAAU,KAAK;AACnB,QAAI,QAAQ,WAAW,GAAG;AACxB,aAAO;AAAA,IACT;AACA,QAAI,QAAQ,QAAQ,SAAS;AAC7B,WAAO,SAAS,GAAG;AACjB,UAAI,SAAS,OAAO,SAAS,QAAQ,OAAO,KAAK,CAAC;AAClD,gBAAU;AACV,UAAI,SAAS,GAAG;AACd,kBAAU;AACV,kBAAU,QAAQ,MAAM,GAAG,KAAK,IAAI,GAAG,KAAK,CAAC,IAAI,OAAO,SAAS,IAAI,QAAQ,MAAM,KAAK,IAAI,GAAG,QAAQ,CAAC,CAAC;AACzG;AAAA,MACF,WAAW,SAAS,GAAG;AACrB,kBAAU;AACV,kBAAU,QAAQ,MAAM,GAAG,KAAK,IAAI,GAAG,KAAK,CAAC,IAAI,OAAO,SAAS,IAAI,QAAQ,MAAM,KAAK,IAAI,GAAG,QAAQ,CAAC,CAAC;AACzG;AAAA,MACF,OAAO;AACL,gBAAQ;AAAA,MACV;AAAA,IACF;AACA,WAAO,SAAQ,gBAAgB,OAAO;AAAA,EACxC;AAAA,EAEA,MAAM,IAAY;AAChB,qBAAiB,IAAI,IAAI;AACzB,SAAK,OAAO,KAAK,MAAM,EAAE;AACzB,WAAO;AAAA,EACT;AAAA,EAEA,OAAO,MAAc,KAAa;AAChC,qBAAiB,GAAG;AACpB,SAAK,MAAM;AACX,SAAK,QAAQ,IAAI;AACjB,WAAO;AAAA,EACT;AAAA,EAEA,QAAQ,MAAc;AACpB,aAAS,OAAO,UAAU,MAAM,iBAAiB,IAAI,SAAS,QAAQ,EAAE;AACxE,SAAK,MAAO,KAAK,MAAM,UAAY,OAAO,IAAI,KAAK;AACnD,WAAO;AAAA,EACT;AAAA,EAEA,SAAiB;AACf,WAAO,KAAK;AAAA,EACd;AAAA,EAEA,WAAW;AACT,WAAO,KAAK;AAAA,EACd;AAAA,EAEU,YAAY;AACpB,UAAM,gBAAgB,KAAK,GAAG,SAAS,CAAC;AACxC,SAAK,QAAQ,cAAc,MAAM;AAAA,EACnC;AACF;",
   "names": []
 }

package/package.json

@@ -1,8 +1,7 @@
 {
   "name": "@xyo-network/quadkey",
-  "version": "7.0.11",
-  "description": "DEPRECATED - use @xyo-network/sdk-protocol/quadkey. Backward-compatibility re-export stub for @xyo-network/quadkey.",
-  "deprecated": "Use @xyo-network/sdk-protocol/quadkey instead. @xyo-network/quadkey is a backward-compatibility re-export stub and will not receive further updates.",
+  "version": "7.0.13",
+  "description": "Primary SDK for using XYO Protocol 2.0",
   "homepage": "https://xyo.network",
   "bugs": {
     "url": "git+https://github.com/XYOracleNetwork/sdk-xyo-client-js/issues",
@@ -34,35 +33,30 @@
     "!**/*.test.*",
     "README.md"
   ],
-  "dependencies": {
-    "@xyo-network/sdk-protocol": "~7.0.11"
-  },
   "devDependencies": {
-    "@xylabs/toolchain": "~8.5.15",
-    "@xylabs/tsconfig": "~8.5.15",
-    "browserslist": "4.28.4",
-    "eslint": "^10.6.0",
-    "eslint-import-resolver-typescript": "^4.4.5",
-    "typescript": "~6.0.3"
+    "@ariestools/sdk": "~7.0.8",
+    "@opentelemetry/api": "~1.9.1",
+    "@opentelemetry/sdk-trace-base": "~2.9.0",
+    "@xylabs/geo": "~7.0.8",
+    "@xylabs/toolchain": "~8.6.2",
+    "@xylabs/tsconfig": "~8.6.2",
+    "@xylabs/vitest-extended": "~7.0.8",
+    "async-mutex": "~0.5.0",
+    "browserslist": "~4.28.4",
+    "eslint": "~10.6.0",
+    "eslint-import-resolver-typescript": "~4.4.5",
+    "typescript": "~6.0.3",
+    "vite": "~8.1.3",
+    "vitest": "~4.1.9",
+    "zod": "~4.4.3"
   },
   "peerDependencies": {
-    "@ariestools/sdk": "^7.0.4",
-    "@bitauth/libauth": "~3.0",
-    "@noble/post-quantum": "~0.6.1",
-    "@opentelemetry/api": "^1.9",
-    "@opentelemetry/sdk-trace-base": "^2.7",
-    "@scure/base": "~2.2",
-    "@scure/bip39": "~2.2",
-    "@xylabs/geo": "^7.0",
-    "@xylabs/threads": "^7.0",
-    "ajv": "^8.20",
-    "async-mutex": "^0.5",
-    "debug": "^4.4",
-    "ethers": "^6.16",
-    "hash-wasm": "~4.12",
-    "idb": "^8.0",
-    "observable-fns": "^0.6",
-    "zod": "^4.4"
+    "@ariestools/sdk": "^7.0.8",
+    "@opentelemetry/api": "^1.9.1",
+    "@opentelemetry/sdk-trace-base": "^2.9.0",
+    "@xylabs/geo": "^7.0.8",
+    "async-mutex": "^0.5.0",
+    "zod": "^4.4.3"
   },
   "engines": {
     "node": "^24"