@xyo-network/quadkey 5.3.24 → 5.3.26

package/README.md

@@ -1,23 +1,799 @@
+[![logo][]](https://xyo.network)
+
 # @xyo-network/quadkey
 
-[![logo][]](https://xyo.network)
+[![npm][npm-badge]][npm-link]
+[![license][license-badge]][license-link]
+
+> Primary SDK for using XYO Protocol 2.0
+
+## Install
+
+Using npm:
 
-Version: 5.0.2
+```sh
+npm install {{name}}
+```
 
-Primary SDK for using XYO Protocol 2.0
+Using yarn:
 
-## Documentation
+```sh
+yarn add {{name}}
+```
 
-[TypeDoc Generated Documentation](https://gitbook.xyo.network/xyo-data-lab/xyo-reference/package-documentation/xyo-network__quadkey)
+Using pnpm:
+
+```sh
+pnpm add {{name}}
+```
+
+Using bun:
+
+```sh
+bun add {{name}}
+```
 
-Part of [sdk-xyo-client-js](https://www.npmjs.com/package/@xyo-network/sdk-xyo-client-js)
 
 ## License
 
-> See the [LICENSE](LICENSE) file for license details
+See the [LICENSE](LICENSE) file for license rights and limitations (LGPL-3.0-only).
+
+## Reference
+
+### packages
+
+  ### sdk-utils
+
+    ### packages
+
+      ### quadkey
+
+        ### .temp-typedoc
+
+          ### classes
+
+            ### <a id="Quadkey"></a>Quadkey
+
+[**@xyo-network/quadkey**](#../README)
+
+***
+
+## Constructors
+
+### Constructor
+
+```ts
+new Quadkey(key?): Quadkey;
+```
+
+### Parameters
+
+#### key?
+
+`bigint` = `0n`
+
+### Returns
+
+`Quadkey`
+
+## Properties
+
+### Zero
+
+```ts
+readonly static Zero: Quadkey;
+```
+
+***
+
+### root
+
+```ts
+readonly static root: Quadkey;
+```
+
+***
+
+### type
+
+```ts
+readonly static type: "Quadkey" = 'Quadkey';
+```
+
+***
+
+### key
+
+```ts
+key: bigint;
+```
+
+***
+
+### type
+
+```ts
+type: string = Quadkey.type;
+```
+
+## Accessors
+
+### base10String
+
+### Get Signature
+
+```ts
+get base10String(): string;
+```
+
+#### Returns
+
+`string`
+
+***
+
+### base16String
+
+### Get Signature
+
+```ts
+get base16String(): string;
+```
+
+#### Returns
+
+`string`
+
+***
+
+### base4Hash
+
+### Get Signature
+
+```ts
+get base4Hash(): string;
+```
+
+#### Returns
+
+`string`
+
+***
+
+### base4HashLabel
+
+### Get Signature
+
+```ts
+get base4HashLabel(): string;
+```
+
+#### Returns
+
+`string`
+
+***
+
+### boundingBox
+
+### Get Signature
+
+```ts
+get boundingBox(): MercatorBoundingBox;
+```
+
+#### Returns
+
+`MercatorBoundingBox`
+
+***
+
+### center
+
+### Get Signature
+
+```ts
+get center(): LngLat;
+```
+
+#### Returns
+
+`LngLat`
+
+***
+
+### children
+
+### Get Signature
+
+```ts
+get children(): Quadkey[];
+```
+
+#### Returns
+
+`Quadkey`[]
+
+***
+
+### gridLocation
+
+### Get Signature
+
+```ts
+get gridLocation(): object;
+```
+
+#### Returns
+
+`object`
+
+##### col
+
+```ts
+col: number;
+```
+
+##### row
+
+```ts
+row: number;
+```
+
+##### zoom
+
+```ts
+zoom: number;
+```
+
+***
+
+### id
+
+### Get Signature
+
+```ts
+get id(): bigint;
+```
+
+#### Returns
+
+`bigint`
+
+***
+
+### parent
+
+### Get Signature
+
+```ts
+get parent(): Quadkey | undefined;
+```
+
+#### Returns
+
+`Quadkey` \| `undefined`
+
+***
+
+### siblings
+
+### Get Signature
+
+```ts
+get siblings(): Quadkey[];
+```
+
+#### Returns
+
+`Quadkey`[]
+
+***
+
+### tile
+
+### Get Signature
+
+```ts
+get tile(): MercatorTile;
+```
+
+#### Returns
+
+`MercatorTile`
+
+***
+
+### valid
+
+### Get Signature
+
+```ts
+get valid(): boolean;
+```
+
+#### Returns
+
+`boolean`
+
+***
+
+### zoom
+
+### Get Signature
+
+```ts
+get zoom(): number;
+```
+
+#### Returns
+
+`number`
+
+## Methods
+
+### from()
+
+```ts
+static from(zoom, id): Quadkey;
+```
+
+### Parameters
+
+#### zoom
+
+`number`
+
+#### id
+
+`bigint`
+
+### Returns
+
+`Quadkey`
+
+***
+
+### fromArrayBuffer()
+
+```ts
+static fromArrayBuffer(zoom, id): Quadkey;
+```
+
+### Parameters
+
+#### zoom
+
+`number`
+
+#### id
+
+`ArrayBuffer`
+
+### Returns
+
+`Quadkey`
+
+***
+
+### fromBase16String()
+
+```ts
+static fromBase16String(value): Quadkey;
+```
+
+### Parameters
+
+#### value
+
+`string`
+
+### Returns
+
+`Quadkey`
+
+***
+
+### fromBase4String()
+
+```ts
+static fromBase4String(value?): Quadkey;
+```
+
+### Parameters
+
+#### value?
+
+`string`
+
+### Returns
+
+`Quadkey`
+
+***
+
+### fromBoundingBox()
+
+```ts
+static fromBoundingBox(boundingBox, zoom): Quadkey[];
+```
+
+### Parameters
+
+#### boundingBox
+
+`MercatorBoundingBox`
+
+#### zoom
+
+`number`
+
+### Returns
+
+`Quadkey`[]
+
+***
+
+### fromLngLat()
+
+```ts
+static fromLngLat(point, zoom): Quadkey;
+```
+
+### Parameters
+
+#### point
+
+`LngLatLike`
+
+#### zoom
+
+`number`
+
+### Returns
+
+`Quadkey`
+
+***
+
+### fromString()
+
+```ts
+static fromString(
+   zoom, 
+   id, 
+   base?): Quadkey;
+```
+
+### Parameters
+
+#### zoom
+
+`number`
+
+#### id
+
+`string`
+
+#### base?
+
+`number` = `16`
+
+### Returns
+
+`Quadkey`
+
+***
+
+### fromTile()
+
+```ts
+static fromTile(tile): Quadkey;
+```
+
+### Parameters
+
+#### tile
+
+`MercatorTile`
+
+### Returns
+
+`Quadkey`
+
+***
+
+### childrenByZoom()
+
+```ts
+childrenByZoom(zoom): Quadkey[];
+```
+
+### Parameters
+
+#### zoom
+
+`number`
+
+### Returns
+
+`Quadkey`[]
+
+***
+
+### clone()
+
+```ts
+clone(): Quadkey;
+```
+
+### Returns
+
+`Quadkey`
+
+***
+
+### equals()
+
+```ts
+equals(obj): boolean;
+```
+
+### Parameters
+
+#### obj
+
+`Quadkey`
+
+### Returns
+
+`boolean`
+
+***
+
+### geoJson()
+
+```ts
+geoJson(): GeoJson;
+```
+
+### Returns
+
+`GeoJson`
+
+***
+
+### getGridBoundingBox()
+
+```ts
+getGridBoundingBox(size): object;
+```
+
+### Parameters
+
+#### size
+
+`number`
+
+### Returns
+
+`object`
+
+#### height
+
+```ts
+height: number = blockSize;
+```
+
+#### left
+
+```ts
+left: number;
+```
+
+#### top
+
+```ts
+top: number;
+```
+
+#### width
+
+```ts
+width: number = blockSize;
+```
+
+***
+
+### ~~getGridLocation()~~
+
+```ts
+getGridLocation(): object;
+```
+
+### Returns
+
+`object`
+
+#### ~~col~~
+
+```ts
+col: number;
+```
+
+#### ~~row~~
+
+```ts
+row: number;
+```
+
+#### ~~zoom~~
+
+```ts
+zoom: number;
+```
+
+### Deprecated
+
+use .gridLocation instead
+
+***
+
+### isInBoundingBox()
+
+```ts
+isInBoundingBox(boundingBox): boolean;
+```
+
+### Parameters
+
+#### boundingBox
+
+`MercatorBoundingBox`
+
+### Returns
+
+`boolean`
+
+***
+
+### relative()
+
+```ts
+relative(direction): Quadkey;
+```
+
+### Parameters
+
+#### direction
+
+`string`
+
+### Returns
+
+`Quadkey`
+
+***
+
+### setId()
+
+```ts
+setId(id): Quadkey;
+```
+
+### Parameters
+
+#### id
+
+`bigint`
+
+### Returns
+
+`Quadkey`
+
+***
+
+### setKey()
+
+```ts
+setKey(zoom, key): Quadkey;
+```
+
+### Parameters
+
+#### zoom
+
+`number`
+
+#### key
+
+`bigint`
+
+### Returns
+
+`Quadkey`
+
+***
+
+### setZoom()
+
+```ts
+setZoom(zoom): Quadkey;
+```
+
+### Parameters
+
+#### zoom
+
+`number`
+
+### Returns
+
+`Quadkey`
+
+***
+
+### toJSON()
+
+```ts
+toJSON(): string;
+```
+
+### Returns
+
+`string`
+
+***
+
+### toString()
+
+```ts
+toString(): string;
+```
+
+### Returns
+
+`string`
+
+***
+
+### guessZoom()
+
+```ts
+protected guessZoom(): void;
+```
+
+### Returns
+
+`void`
+
+          ### functions
+
+            ### <a id="isQuadkey"></a>isQuadkey
+
+[**@xyo-network/quadkey**](#../README)
+
+***
+
+```ts
+function isQuadkey(obj): boolean;
+```
+
+## Parameters
+
+### obj
+
+### type
+
+`string`
+
+## Returns
 
-## Credits
+`boolean`
 
-[Made with 🔥 and ❄️ by XYO](https://xyo.network)
 
-[logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png
+[logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png
+[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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/quadkey",
-  "version": "5.3.24",
+  "version": "5.3.26",
   "description": "Primary SDK for using XYO Protocol 2.0",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -22,11 +22,11 @@
   "exports": {
     ".": {
       "types": "./dist/neutral/index.d.ts",
+      "import": "./dist/neutral/index.mjs",
       "default": "./dist/neutral/index.mjs"
     },
     "./package.json": "./package.json"
   },
-  "module": "dist/neutral/index.mjs",
   "types": "dist/neutral/index.d.ts",
   "files": [
     "dist",
@@ -37,13 +37,13 @@
   ],
   "devDependencies": {
     "@opentelemetry/api": "^1.9.1",
-    "@types/node": "^25.5.0",
-    "@xylabs/geo": "^5.0.93",
-    "@xylabs/sdk-js": "^5.0.93",
-    "@xylabs/ts-scripts-common": "~7.6.16",
-    "@xylabs/ts-scripts-pnpm": "~7.6.16",
-    "@xylabs/tsconfig": "~7.6.16",
-    "@xylabs/vitest-extended": "~5.0.93",
+    "@types/node": "^25.5.2",
+    "@xylabs/geo": "^5.0.94",
+    "@xylabs/sdk-js": "^5.0.94",
+    "@xylabs/ts-scripts-common": "~7.7.5",
+    "@xylabs/ts-scripts-pnpm": "~7.7.5",
+    "@xylabs/tsconfig": "~7.7.5",
+    "@xylabs/vitest-extended": "~5.0.94",
     "acorn": "^8.16.0",
     "axios": "^1.14.0",
     "esbuild": "^0.28.0",