@xyo-network/quadkey 2.73.4 → 2.74.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (19) hide show
  1. package/dist/Quadkey.d.mts +91 -0
  2. package/dist/Quadkey.d.mts.map +1 -0
  3. package/dist/Quadkey.d.ts +91 -0
  4. package/dist/Quadkey.d.ts.map +1 -0
  5. package/dist/RelativeDirectionConstantLookup.d.mts +2 -0
  6. package/dist/RelativeDirectionConstantLookup.d.mts.map +1 -0
  7. package/dist/RelativeDirectionConstantLookup.d.ts +2 -0
  8. package/dist/RelativeDirectionConstantLookup.d.ts.map +1 -0
  9. package/dist/docs.json +132 -132
  10. package/dist/index.d.mts +2 -96
  11. package/dist/index.d.mts.map +1 -0
  12. package/dist/index.d.ts +2 -96
  13. package/dist/index.d.ts.map +1 -0
  14. package/dist/utils.d.mts +5 -0
  15. package/dist/utils.d.mts.map +1 -0
  16. package/dist/utils.d.ts +5 -0
  17. package/dist/utils.d.ts.map +1 -0
  18. package/package.json +7 -13
  19. package/tsup.config.ts +0 -16
package/dist/Quadkey.d.mts ADDED
@@ -0,0 +1,91 @@
1
+ import { BigNumber } from '@xylabs/bignumber';
2
+ import { Buffer } from '@xylabs/buffer';
3
+ import { GeoJson, MercatorBoundingBox, MercatorTile } from '@xyo-network/sdk-geo';
4
+ import { LngLat, LngLatLike } from 'mapbox-gl';
5
+ export * from './utils';
6
+ export declare const isQuadkey: (obj: {
7
+ type: string;
8
+ }) => boolean;
9
+ export declare class Quadkey {
10
+ static Zero: Quadkey;
11
+ static root: Quadkey;
12
+ static type: string;
13
+ type: string;
14
+ private _geoJson?;
15
+ private key;
16
+ constructor(key?: Buffer);
17
+ get base10String(): string;
18
+ get base4Hash(): string;
19
+ get base4HashLabel(): string;
20
+ get bigNumber(): BigNumber;
21
+ get boundingBox(): MercatorBoundingBox;
22
+ get buffer(): Buffer;
23
+ get center(): LngLat;
24
+ get children(): Quadkey[];
25
+ get gridLocation(): {
26
+ col: number;
27
+ row: number;
28
+ zoom: number;
29
+ };
30
+ get hex(): string;
31
+ get id(): Buffer;
32
+ get parent(): Quadkey | undefined;
33
+ get siblings(): Quadkey[];
34
+ get tile(): MercatorTile;
35
+ get valid(): boolean;
36
+ get zoom(): number;
37
+ static from(zoom: number, id: Buffer): Quadkey;
38
+ static fromBase10String(value: string): Quadkey;
39
+ static fromBase16String(value: string): Quadkey;
40
+ static fromBase4String(value?: string): Quadkey | undefined;
41
+ static fromBoundingBox(boundingBox: MercatorBoundingBox, zoom: number): Quadkey[];
42
+ static fromBuffer(value: Buffer): Quadkey;
43
+ static fromLngLat(point: LngLatLike, zoom: number): Quadkey | undefined;
44
+ static fromString(zoom: number, id: string, base?: number): Quadkey;
45
+ static fromTile(tile: MercatorTile): Quadkey | undefined;
46
+ childrenByZoom(zoom: number): Quadkey[];
47
+ clone(): Quadkey;
48
+ compareTo(quadkey: Quadkey): 0 | 1 | -1;
49
+ equals(obj: Quadkey): boolean;
50
+ geoJson(): GeoJson;
51
+ getGridBoundingBox(size: number): {
52
+ height: number;
53
+ left: number;
54
+ top: number;
55
+ width: number;
56
+ };
57
+ /** @deprecated use .gridLocation instead */
58
+ getGridLocation(): {
59
+ col: number;
60
+ row: number;
61
+ zoom: number;
62
+ };
63
+ isInBoundingBox(boundingBox: MercatorBoundingBox): boolean;
64
+ relative(direction: string): Quadkey | undefined;
65
+ setId(id: Buffer): this;
66
+ setKey(zoom: number, id: Buffer): this;
67
+ setZoom(zoom: number): this;
68
+ /** @deprecated use .base10String*/
69
+ toBase10String(): string;
70
+ /** @deprecated use .base4Hash */
71
+ toBase4Hash(): string;
72
+ /** @deprecated use .base4HashLabel */
73
+ toBase4HashLabel(): string;
74
+ /** @deprecated use .bigNumber */
75
+ toBigNumber(): BigNumber;
76
+ /** @deprecated use .boundingBox */
77
+ toBoundingBox(): MercatorBoundingBox;
78
+ /** @deprecated use .buffer */
79
+ toBuffer(): Buffer;
80
+ /** @deprecated use .center */
81
+ toCenter(): LngLat;
82
+ /** @deprecated use .hex instead */
83
+ toHex(): string;
84
+ toJSON(): string;
85
+ toShortString(): string;
86
+ toString(): string;
87
+ /** @deprecated use .tile instead */
88
+ toTile(): MercatorTile;
89
+ protected guessZoom(): void;
90
+ }
91
+ //# sourceMappingURL=Quadkey.d.ts.map
package/dist/Quadkey.d.mts.map ADDED
@@ -0,0 +1 @@
1
+ {"version":3,"file":"Quadkey.d.ts","sourceRoot":"","sources":["../src/Quadkey.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAA;AAC7C,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAA;AACvC,OAAO,EAEL,OAAO,EACP,mBAAmB,EACnB,YAAY,EAMb,MAAM,sBAAsB,CAAA;AAC7B,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,WAAW,CAAA;AAK9C,cAAc,SAAS,CAAA;AAIvB,eAAO,MAAM,SAAS,QAAS;IAAE,IAAI,EAAE,MAAM,CAAA;CAAE,YAA+B,CAAA;AAE9E,qBAAa,OAAO;IAClB,MAAM,CAAC,IAAI,UAAuC;IAClD,MAAM,CAAC,IAAI,UAAgB;IAC3B,MAAM,CAAC,IAAI,SAAY;IAEvB,IAAI,SAAe;IAEnB,OAAO,CAAC,QAAQ,CAAC,CAAS;IAC1B,OAAO,CAAC,GAAG,CAAmB;gBAElB,GAAG,SAAmB;IAKlC,IAAI,YAAY,WAEf;IAED,IAAI,SAAS,WAWZ;IAED,IAAI,cAAc,WAGjB;IAED,IAAI,SAAS,cAEZ;IAED,IAAI,WAAW,IAAI,mBAAmB,CAErC;IAED,IAAI,MAAM,WAET;IAED,IAAI,MAAM,WAGT;IAED,IAAI,QAAQ,cAUX;IAED,IAAI,YAAY;;;;MAQf;IAED,IAAI,GAAG,WAEN;IAED,IAAI,EAAE,WAEL;IAED,IAAI,MAAM,IAAI,OAAO,GAAG,SAAS,CAIhC;IAED,IAAI,QAAQ,cAKX;IAED,IAAI,IAAI,IAAI,YAAY,CAEvB;IAED,IAAI,KAAK,YAYR;IAED,IAAI,IAAI,WAEP;IAED,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM;IAIpC,MAAM,CAAC,gBAAgB,CAAC,KAAK,EAAE,MAAM;IAIrC,MAAM,CAAC,gBAAgB,CAAC,KAAK,EAAE,MAAM;IAKrC,MAAM,CAAC,eAAe,CAAC,KAAK,CAAC,EAAE,MAAM;IAUrC,MAAM,CAAC,eAAe,CAAC,WAAW,EAAE,mBAAmB,EAAE,IAAI,EAAE,MAAM;IAUrE,MAAM,CAAC,UAAU,CAAC,KAAK,EAAE,MAAM;IAI/B,MAAM,CAAC,UAAU,CAAC,KAAK,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM;IAMjD,MAAM,CAAC,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,IAAI,SAAK;IAWrD,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,YAAY;IAIlC,cAAc,CAAC,IAAI,EAAE,MAAM;IAc3B,KAAK;IAIL,SAAS,CAAC,OAAO,EAAE,OAAO;IAI1B,MAAM,CAAC,GAAG,EAAE,OAAO,GAAG,OAAO;IAI7B,OAAO;IAKP,kBAAkB,CAAC,IAAI,EAAE,MAAM;;;;;;IAiC/B,4CAA4C;IAC5C,eAAe;;;;;IAIf,eAAe,CAAC,WAAW,EAAE,mBAAmB;IAUhD,QAAQ,CAAC,SAAS,EAAE,MAAM;IAyB1B,KAAK,CAAC,EAAE,EAAE,MAAM;IAKhB,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM;IAM/B,OAAO,CAAC,IAAI,EAAE,MAAM;IAMpB,mCAAmC;IACnC,cAAc;IAId,iCAAiC;IACjC,WAAW;IAIX,sCAAsC;IACtC,gBAAgB;IAKhB,iCAAiC;IACjC,WAAW;IAIX,mCAAmC;IACnC,aAAa,IAAI,mBAAmB;IAIpC,8BAA8B;IAC9B,QAAQ;IAIR,8BAA8B;IAC9B,QAAQ;IAIR,mCAAmC;IACnC,KAAK;IAIL,MAAM,IAAI,MAAM;IAIhB,aAAa;IAOb,QAAQ;IAIR,oCAAoC;IACpC,MAAM,IAAI,YAAY;IAItB,SAAS,CAAC,SAAS;CAKpB"}
package/dist/Quadkey.d.ts ADDED
@@ -0,0 +1,91 @@
1
+ import { BigNumber } from '@xylabs/bignumber';
2
+ import { Buffer } from '@xylabs/buffer';
3
+ import { GeoJson, MercatorBoundingBox, MercatorTile } from '@xyo-network/sdk-geo';
4
+ import { LngLat, LngLatLike } from 'mapbox-gl';
5
+ export * from './utils';
6
+ export declare const isQuadkey: (obj: {
7
+ type: string;
8
+ }) => boolean;
9
+ export declare class Quadkey {
10
+ static Zero: Quadkey;
11
+ static root: Quadkey;
12
+ static type: string;
13
+ type: string;
14
+ private _geoJson?;
15
+ private key;
16
+ constructor(key?: Buffer);
17
+ get base10String(): string;
18
+ get base4Hash(): string;
19
+ get base4HashLabel(): string;
20
+ get bigNumber(): BigNumber;
21
+ get boundingBox(): MercatorBoundingBox;
22
+ get buffer(): Buffer;
23
+ get center(): LngLat;
24
+ get children(): Quadkey[];
25
+ get gridLocation(): {
26
+ col: number;
27
+ row: number;
28
+ zoom: number;
29
+ };
30
+ get hex(): string;
31
+ get id(): Buffer;
32
+ get parent(): Quadkey | undefined;
33
+ get siblings(): Quadkey[];
34
+ get tile(): MercatorTile;
35
+ get valid(): boolean;
36
+ get zoom(): number;
37
+ static from(zoom: number, id: Buffer): Quadkey;
38
+ static fromBase10String(value: string): Quadkey;
39
+ static fromBase16String(value: string): Quadkey;
40
+ static fromBase4String(value?: string): Quadkey | undefined;
41
+ static fromBoundingBox(boundingBox: MercatorBoundingBox, zoom: number): Quadkey[];
42
+ static fromBuffer(value: Buffer): Quadkey;
43
+ static fromLngLat(point: LngLatLike, zoom: number): Quadkey | undefined;
44
+ static fromString(zoom: number, id: string, base?: number): Quadkey;
45
+ static fromTile(tile: MercatorTile): Quadkey | undefined;
46
+ childrenByZoom(zoom: number): Quadkey[];
47
+ clone(): Quadkey;
48
+ compareTo(quadkey: Quadkey): 0 | 1 | -1;
49
+ equals(obj: Quadkey): boolean;
50
+ geoJson(): GeoJson;
51
+ getGridBoundingBox(size: number): {
52
+ height: number;
53
+ left: number;
54
+ top: number;
55
+ width: number;
56
+ };
57
+ /** @deprecated use .gridLocation instead */
58
+ getGridLocation(): {
59
+ col: number;
60
+ row: number;
61
+ zoom: number;
62
+ };
63
+ isInBoundingBox(boundingBox: MercatorBoundingBox): boolean;
64
+ relative(direction: string): Quadkey | undefined;
65
+ setId(id: Buffer): this;
66
+ setKey(zoom: number, id: Buffer): this;
67
+ setZoom(zoom: number): this;
68
+ /** @deprecated use .base10String*/
69
+ toBase10String(): string;
70
+ /** @deprecated use .base4Hash */
71
+ toBase4Hash(): string;
72
+ /** @deprecated use .base4HashLabel */
73
+ toBase4HashLabel(): string;
74
+ /** @deprecated use .bigNumber */
75
+ toBigNumber(): BigNumber;
76
+ /** @deprecated use .boundingBox */
77
+ toBoundingBox(): MercatorBoundingBox;
78
+ /** @deprecated use .buffer */
79
+ toBuffer(): Buffer;
80
+ /** @deprecated use .center */
81
+ toCenter(): LngLat;
82
+ /** @deprecated use .hex instead */
83
+ toHex(): string;
84
+ toJSON(): string;
85
+ toShortString(): string;
86
+ toString(): string;
87
+ /** @deprecated use .tile instead */
88
+ toTile(): MercatorTile;
89
+ protected guessZoom(): void;
90
+ }
91
+ //# sourceMappingURL=Quadkey.d.ts.map
package/dist/Quadkey.d.ts.map ADDED
@@ -0,0 +1 @@
1
+ {"version":3,"file":"Quadkey.d.ts","sourceRoot":"","sources":["../src/Quadkey.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAA;AAC7C,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAA;AACvC,OAAO,EAEL,OAAO,EACP,mBAAmB,EACnB,YAAY,EAMb,MAAM,sBAAsB,CAAA;AAC7B,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,WAAW,CAAA;AAK9C,cAAc,SAAS,CAAA;AAIvB,eAAO,MAAM,SAAS,QAAS;IAAE,IAAI,EAAE,MAAM,CAAA;CAAE,YAA+B,CAAA;AAE9E,qBAAa,OAAO;IAClB,MAAM,CAAC,IAAI,UAAuC;IAClD,MAAM,CAAC,IAAI,UAAgB;IAC3B,MAAM,CAAC,IAAI,SAAY;IAEvB,IAAI,SAAe;IAEnB,OAAO,CAAC,QAAQ,CAAC,CAAS;IAC1B,OAAO,CAAC,GAAG,CAAmB;gBAElB,GAAG,SAAmB;IAKlC,IAAI,YAAY,WAEf;IAED,IAAI,SAAS,WAWZ;IAED,IAAI,cAAc,WAGjB;IAED,IAAI,SAAS,cAEZ;IAED,IAAI,WAAW,IAAI,mBAAmB,CAErC;IAED,IAAI,MAAM,WAET;IAED,IAAI,MAAM,WAGT;IAED,IAAI,QAAQ,cAUX;IAED,IAAI,YAAY;;;;MAQf;IAED,IAAI,GAAG,WAEN;IAED,IAAI,EAAE,WAEL;IAED,IAAI,MAAM,IAAI,OAAO,GAAG,SAAS,CAIhC;IAED,IAAI,QAAQ,cAKX;IAED,IAAI,IAAI,IAAI,YAAY,CAEvB;IAED,IAAI,KAAK,YAYR;IAED,IAAI,IAAI,WAEP;IAED,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM;IAIpC,MAAM,CAAC,gBAAgB,CAAC,KAAK,EAAE,MAAM;IAIrC,MAAM,CAAC,gBAAgB,CAAC,KAAK,EAAE,MAAM;IAKrC,MAAM,CAAC,eAAe,CAAC,KAAK,CAAC,EAAE,MAAM;IAUrC,MAAM,CAAC,eAAe,CAAC,WAAW,EAAE,mBAAmB,EAAE,IAAI,EAAE,MAAM;IAUrE,MAAM,CAAC,UAAU,CAAC,KAAK,EAAE,MAAM;IAI/B,MAAM,CAAC,UAAU,CAAC,KAAK,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM;IAMjD,MAAM,CAAC,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,IAAI,SAAK;IAWrD,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,YAAY;IAIlC,cAAc,CAAC,IAAI,EAAE,MAAM;IAc3B,KAAK;IAIL,SAAS,CAAC,OAAO,EAAE,OAAO;IAI1B,MAAM,CAAC,GAAG,EAAE,OAAO,GAAG,OAAO;IAI7B,OAAO;IAKP,kBAAkB,CAAC,IAAI,EAAE,MAAM;;;;;;IAiC/B,4CAA4C;IAC5C,eAAe;;;;;IAIf,eAAe,CAAC,WAAW,EAAE,mBAAmB;IAUhD,QAAQ,CAAC,SAAS,EAAE,MAAM;IAyB1B,KAAK,CAAC,EAAE,EAAE,MAAM;IAKhB,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM;IAM/B,OAAO,CAAC,IAAI,EAAE,MAAM;IAMpB,mCAAmC;IACnC,cAAc;IAId,iCAAiC;IACjC,WAAW;IAIX,sCAAsC;IACtC,gBAAgB;IAKhB,iCAAiC;IACjC,WAAW;IAIX,mCAAmC;IACnC,aAAa,IAAI,mBAAmB;IAIpC,8BAA8B;IAC9B,QAAQ;IAIR,8BAA8B;IAC9B,QAAQ;IAIR,mCAAmC;IACnC,KAAK;IAIL,MAAM,IAAI,MAAM;IAIhB,aAAa;IAOb,QAAQ;IAIR,oCAAoC;IACpC,MAAM,IAAI,YAAY;IAItB,SAAS,CAAC,SAAS;CAKpB"}
package/dist/RelativeDirectionConstantLookup.d.mts ADDED
@@ -0,0 +1,2 @@
1
+ export declare const RelativeDirectionConstantLookup: Record<string, number>;
2
+ //# sourceMappingURL=RelativeDirectionConstantLookup.d.ts.map
package/dist/RelativeDirectionConstantLookup.d.mts.map ADDED
@@ -0,0 +1 @@
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/RelativeDirectionConstantLookup.d.ts ADDED
@@ -0,0 +1,2 @@
1
+ export declare const RelativeDirectionConstantLookup: Record<string, number>;
2
+ //# sourceMappingURL=RelativeDirectionConstantLookup.d.ts.map
package/dist/RelativeDirectionConstantLookup.d.ts.map ADDED
@@ -0,0 +1 @@
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"}