@xylabs/geo 7.0.8 → 8.0.0

package/README.md

@@ -1,979 +1,3 @@
-[![logo][]](https://xylabs.com)
-
 # @xylabs/geo
 
-[![npm][npm-badge]][npm-link]
-[![license][license-badge]][license-link]
-
-> Base functionality used throughout XY Labs TypeScript/JavaScript libraries
-
-## 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).
-
-## Reference
-
-### packages
-
-  ### geo
-
-    ### .temp-typedoc
-
-      ### classes
-
-        ### <a id="GeoJson"></a>GeoJson
-
-[**@xylabs/geo**](#../README)
-
-***
-
-Provides GeoJSON geometry and MapBox source generation from a quadkey.
-
-## Constructors
-
-### Constructor
-
-```ts
-new GeoJson(quadkey): GeoJson;
-```
-
-### Parameters
-
-#### quadkey
-
-`string`
-
-### Returns
-
-`GeoJson`
-
-## Methods
-
-### featureCollection()
-
-```ts
-static featureCollection(features): FeatureCollection;
-```
-
-Creates a GeoJSON FeatureCollection from an array of features.
-
-### Parameters
-
-#### features
-
-`Feature`\<`Geometry`, `GeoJsonProperties`\>[]
-
-The features to include
-
-### Returns
-
-`FeatureCollection`
-
-A GeoJSON FeatureCollection
-
-***
-
-### featuresSource()
-
-```ts
-static featuresSource(data): GeoJSONSourceSpecification;
-```
-
-Creates a MapBox GeoJSON source specification from a FeatureCollection.
-
-### Parameters
-
-#### data
-
-`FeatureCollection`
-
-The FeatureCollection to use as the source data
-
-### Returns
-
-`GeoJSONSourceSpecification`
-
-A MapBox GeoJSON source specification
-
-***
-
-### geometryFeature()
-
-```ts
-static geometryFeature(geometry): Feature;
-```
-
-Wraps a geometry object in a GeoJSON Feature.
-
-### Parameters
-
-#### geometry
-
-`Geometry`
-
-The geometry to wrap
-
-### Returns
-
-`Feature`
-
-A GeoJSON Feature containing the geometry
-
-***
-
-### center()
-
-```ts
-center(): LngLat;
-```
-
-Computes and caches the center point of the quadkey's bounding box as a MapBox LngLat.
-
-### Returns
-
-`LngLat`
-
-***
-
-### point()
-
-```ts
-point(): Point;
-```
-
-Returns a GeoJSON Point geometry at the center of the quadkey's bounding box.
-
-### Returns
-
-`Point`
-
-***
-
-### pointFeature()
-
-```ts
-pointFeature(): Feature;
-```
-
-Returns a GeoJSON Feature containing the center point geometry.
-
-### Returns
-
-`Feature`
-
-***
-
-### pointFeatureCollection()
-
-```ts
-pointFeatureCollection(): FeatureCollection;
-```
-
-Returns a GeoJSON FeatureCollection containing the center point feature.
-
-### Returns
-
-`FeatureCollection`
-
-***
-
-### pointSource()
-
-```ts
-pointSource(): GeoJSONSourceSpecification;
-```
-
-Returns a MapBox GeoJSON source specification for the center point.
-
-### Returns
-
-`GeoJSONSourceSpecification`
-
-***
-
-### polygon()
-
-```ts
-polygon(): Polygon;
-```
-
-Returns a GeoJSON Polygon geometry representing the quadkey's bounding box.
-
-### Returns
-
-`Polygon`
-
-***
-
-### polygonFeature()
-
-```ts
-polygonFeature(): Feature;
-```
-
-Returns a GeoJSON Feature containing the polygon geometry.
-
-### Returns
-
-`Feature`
-
-***
-
-### polygonFeatureCollection()
-
-```ts
-polygonFeatureCollection(): FeatureCollection;
-```
-
-Returns a GeoJSON FeatureCollection containing the polygon feature.
-
-### Returns
-
-`FeatureCollection`
-
-***
-
-### polygonSource()
-
-```ts
-polygonSource(): GeoJSONSourceSpecification;
-```
-
-Returns a MapBox GeoJSON source specification for the polygon.
-
-### Returns
-
-`GeoJSONSourceSpecification`
-
-***
-
-### zoom()
-
-```ts
-zoom(): number;
-```
-
-Returns the zoom level derived from the quadkey length.
-
-### Returns
-
-`number`
-
-        ### <a id="LayerBase"></a>LayerBase
-
-[**@xylabs/geo**](#../README)
-
-***
-
-Abstract base class for managing MapBox map layers with add/remove lifecycle.
-
-## Type Parameters
-
-### T
-
-`T` *extends* `MapBox.Layer`
-
-## Constructors
-
-### Constructor
-
-```ts
-new LayerBase<T>(id, source): LayerBase<T>;
-```
-
-### Parameters
-
-#### id
-
-`string`
-
-#### source
-
-`string`
-
-### Returns
-
-`LayerBase`\<`T`\>
-
-## Properties
-
-### id
-
-```ts
-id: string;
-```
-
-***
-
-### source
-
-```ts
-source: string;
-```
-
-## Methods
-
-### update()
-
-```ts
-update(map, show?): void;
-```
-
-Removes and re-adds the layer on the map, optionally hiding it.
-
-### Parameters
-
-#### map
-
-`Map$1`
-
-The MapBox map instance
-
-#### show?
-
-`boolean` = `true`
-
-Whether to show the layer after updating (default true)
-
-### Returns
-
-`void`
-
-***
-
-### buildLayer()
-
-```ts
-abstract buildLayer(): T;
-```
-
-Builds the MapBox layer configuration object.
-
-### Returns
-
-`T`
-
-        ### <a id="MercatorBoundingBox"></a>MercatorBoundingBox
-
-[**@xylabs/geo**](#../README)
-
-***
-
-A Mercator bounding box extending MapBox LngLatBounds.
-
-## Extends
-
-- `LngLatBounds`
-
-## Constructors
-
-### Constructor
-
-```ts
-new MercatorBoundingBox(sw?, ne?): MercatorBoundingBox;
-```
-
-### Parameters
-
-#### sw?
-
-  \| \[`number`, `number`, `number`, `number`\]
-  \| `LngLatLike`
-  \| \[`LngLatLike`, `LngLatLike`\]
-
-#### ne?
-
-`LngLatLike`
-
-### Returns
-
-`MercatorBoundingBox`
-
-### Inherited from
-
-```ts
-MapBox.LngLatBounds.constructor
-```
-
-        ### <a id="MercatorLngLat"></a>MercatorLngLat
-
-[**@xylabs/geo**](#../README)
-
-***
-
-A Mercator coordinate extending MapBox LngLat.
-
-## Extends
-
-- `LngLat`
-
-## Constructors
-
-### Constructor
-
-```ts
-new MercatorLngLat(lng, lat): MercatorLngLat;
-```
-
-### Parameters
-
-#### lng
-
-`number`
-
-#### lat
-
-`number`
-
-### Returns
-
-`MercatorLngLat`
-
-### Inherited from
-
-```ts
-MapBox.LngLat.constructor
-```
-
-      ### functions
-
-        ### <a id="boundingBoxToBoundary"></a>boundingBoxToBoundary
-
-[**@xylabs/geo**](#../README)
-
-***
-
-```ts
-function boundingBoxToBoundary(box): MercatorBoundary;
-```
-
-Converts a bounding box to an ordered boundary polygon (closed ring of corner points).
-
-## Parameters
-
-### box
-
-[`MercatorBoundingBox`](#../classes/MercatorBoundingBox)
-
-The bounding box to convert
-
-## Returns
-
-[`MercatorBoundary`](#../type-aliases/MercatorBoundary)
-
-An array of corner points forming a closed boundary
-
-        ### <a id="boundingBoxToCenter"></a>boundingBoxToCenter
-
-[**@xylabs/geo**](#../README)
-
-***
-
-```ts
-function boundingBoxToCenter(boundingBox, decimal?): number[];
-```
-
-Computes the center point of a bounding box as [lng, lat], rounded to the specified decimal places.
-
-## Parameters
-
-### boundingBox
-
-[`MercatorBoundingBox`](#../classes/MercatorBoundingBox)
-
-The bounding box to find the center of
-
-### decimal?
-
-`number` = `6`
-
-Number of decimal places for rounding (default 6)
-
-## Returns
-
-`number`[]
-
-A [longitude, latitude] tuple representing the center
-
-        ### <a id="boundingBoxToPolygon"></a>boundingBoxToPolygon
-
-[**@xylabs/geo**](#../README)
-
-***
-
-```ts
-function boundingBoxToPolygon(box): Polygon;
-```
-
-Converts a bounding box to a GeoJSON Polygon geometry.
-
-## Parameters
-
-### box
-
-[`MercatorBoundingBox`](#../classes/MercatorBoundingBox)
-
-The bounding box to convert
-
-## Returns
-
-`Polygon`
-
-A GeoJSON Polygon representing the bounding box
-
-        ### <a id="hasSiblings"></a>hasSiblings
-
-[**@xylabs/geo**](#../README)
-
-***
-
-```ts
-function hasSiblings(tiles, tile): boolean;
-```
-
-Checks whether all four siblings of the given tile exist in the tile array.
-
-## Parameters
-
-### tiles
-
-[`MercatorTile`][#../type-aliases/MercatorTile]()
-
-The array of tiles to search
-
-### tile
-
-[`MercatorTile`](#../type-aliases/MercatorTile)
-
-The tile whose siblings to check for
-
-## Returns
-
-`boolean`
-
-True if all siblings are present in the array
-
-        ### <a id="tileFromPoint"></a>tileFromPoint
-
-[**@xylabs/geo**](#../README)
-
-***
-
-```ts
-function tileFromPoint(point, z): MercatorTile;
-```
-
-Converts a geographic point to the integer Mercator tile containing it at the given zoom level.
-
-## Parameters
-
-### point
-
-[`MercatorLngLat`](#../classes/MercatorLngLat)
-
-The geographic coordinate
-
-### z
-
-`number`
-
-The zoom level
-
-## Returns
-
-[`MercatorTile`](#../type-aliases/MercatorTile)
-
-The tile as [x, y, zoom]
-
-        ### <a id="tileFromQuadkey"></a>tileFromQuadkey
-
-[**@xylabs/geo**](#../README)
-
-***
-
-```ts
-function tileFromQuadkey(quadkey): MercatorTile;
-```
-
-Converts a quadkey string to a Mercator tile [x, y, zoom].
-
-## Parameters
-
-### quadkey
-
-`string`
-
-The quadkey string to decode
-
-## Returns
-
-[`MercatorTile`](#../type-aliases/MercatorTile)
-
-The tile as [x, y, zoom]
-
-        ### <a id="tileToBoundingBox"></a>tileToBoundingBox
-
-[**@xylabs/geo**](#../README)
-
-***
-
-```ts
-function tileToBoundingBox(tile): MercatorBoundingBox;
-```
-
-Converts a Mercator tile to its geographic bounding box.
-
-## Parameters
-
-### tile
-
-[`MercatorTile`](#../type-aliases/MercatorTile)
-
-The tile as [x, y, zoom]
-
-## Returns
-
-[`MercatorBoundingBox`](#../classes/MercatorBoundingBox)
-
-The bounding box covering the tile's geographic extent
-
-        ### <a id="tileToChildren"></a>tileToChildren
-
-[**@xylabs/geo**](#../README)
-
-***
-
-```ts
-function tileToChildren(tile): MercatorTile[];
-```
-
-Returns the four child tiles at one zoom level higher.
-
-## Parameters
-
-### tile
-
-[`MercatorTile`](#../type-aliases/MercatorTile)
-
-The parent tile as [x, y, zoom]
-
-## Returns
-
-[`MercatorTile`][#../type-aliases/MercatorTile]()
-
-An array of four child tiles at zoom + 1
-
-        ### <a id="tileToGeoJson"></a>tileToGeoJson
-
-[**@xylabs/geo**](#../README)
-
-***
-
-```ts
-function tileToGeoJson(tile): Polygon;
-```
-
-Converts a Mercator tile to a GeoJSON Polygon geometry.
-
-## Parameters
-
-### tile
-
-[`MercatorTile`](#../type-aliases/MercatorTile)
-
-The tile as [x, y, zoom]
-
-## Returns
-
-`Polygon`
-
-A GeoJSON Polygon representing the tile's geographic extent
-
-        ### <a id="tileToParent"></a>tileToParent
-
-[**@xylabs/geo**](#../README)
-
-***
-
-```ts
-function tileToParent(tile): MercatorTile;
-```
-
-Returns the parent tile at one zoom level lower.
-
-## Parameters
-
-### tile
-
-[`MercatorTile`](#../type-aliases/MercatorTile)
-
-The tile as [x, y, zoom]
-
-## Returns
-
-[`MercatorTile`](#../type-aliases/MercatorTile)
-
-The parent tile at zoom - 1
-
-        ### <a id="tileToPoint"></a>tileToPoint
-
-[**@xylabs/geo**](#../README)
-
-***
-
-```ts
-function tileToPoint(tile): MercatorLngLat;
-```
-
-Returns the center point of a Mercator tile.
-
-## Parameters
-
-### tile
-
-[`MercatorTile`](#../type-aliases/MercatorTile)
-
-The tile as [x, y, zoom]
-
-## Returns
-
-[`MercatorLngLat`](#../classes/MercatorLngLat)
-
-The center coordinate as a MercatorLngLat
-
-        ### <a id="tileToQuadkey"></a>tileToQuadkey
-
-[**@xylabs/geo**](#../README)
-
-***
-
-```ts
-function tileToQuadkey(param0): string;
-```
-
-Converts a Mercator tile to its quadkey string representation.
-
-## Parameters
-
-### param0
-
-[`MercatorTile`](#../type-aliases/MercatorTile)
-
-The tile as [tileX, tileY, tileZoom]
-
-## Returns
-
-`string`
-
-The quadkey string encoding the tile's position and zoom
-
-        ### <a id="tileToSiblings"></a>tileToSiblings
-
-[**@xylabs/geo**](#../README)
-
-***
-
-```ts
-function tileToSiblings(tile): MercatorTile[];
-```
-
-Returns the four sibling tiles (children of the parent tile) for the given tile.
-
-## Parameters
-
-### tile
-
-[`MercatorTile`](#../type-aliases/MercatorTile)
-
-The tile as [x, y, zoom]
-
-## Returns
-
-[`MercatorTile`][#../type-aliases/MercatorTile]()
-
-An array of four sibling tiles at the same zoom level
-
-        ### <a id="tilesEqual"></a>tilesEqual
-
-[**@xylabs/geo**](#../README)
-
-***
-
-```ts
-function tilesEqual(param0, param1): boolean;
-```
-
-Checks whether two Mercator tiles are equal by comparing their x, y, and zoom values.
-
-## Parameters
-
-### param0
-
-[`MercatorTile`](#../type-aliases/MercatorTile)
-
-The first tile as [x, y, zoom]
-
-### param1
-
-[`MercatorTile`](#../type-aliases/MercatorTile)
-
-The second tile as [x, y, zoom]
-
-## Returns
-
-`boolean`
-
-True if both tiles have identical coordinates and zoom
-
-        ### <a id="tilesFromBoundingBox"></a>tilesFromBoundingBox
-
-[**@xylabs/geo**](#../README)
-
-***
-
-```ts
-function tilesFromBoundingBox(box, zoom): MercatorTile[];
-```
-
-Returns all Mercator tiles that intersect the given bounding box at the specified zoom level.
-
-## Parameters
-
-### box
-
-[`MercatorBoundingBox`](#../classes/MercatorBoundingBox)
-
-The geographic bounding box
-
-### zoom
-
-`number`
-
-The zoom level
-
-## Returns
-
-[`MercatorTile`][#../type-aliases/MercatorTile]()
-
-An array of tiles covering the bounding box
-
-        ### <a id="tilesHasTile"></a>tilesHasTile
-
-[**@xylabs/geo**](#../README)
-
-***
-
-```ts
-function tilesHasTile(tiles, tile): boolean;
-```
-
-Checks whether a specific tile exists in the given tile array.
-
-## Parameters
-
-### tiles
-
-[`MercatorTile`][#../type-aliases/MercatorTile]()
-
-The array of tiles to search
-
-### tile
-
-[`MercatorTile`](#../type-aliases/MercatorTile)
-
-The tile to look for
-
-## Returns
-
-`boolean`
-
-True if the tile is found in the array
-
-      ### type-aliases
-
-        ### <a id="MercatorBoundary"></a>MercatorBoundary
-
-[**@xylabs/geo**](#../README)
-
-***
-
-```ts
-type MercatorBoundary = MercatorLngLat[];
-```
-
-An ordered array of MercatorLngLat points forming a boundary.
-
-        ### <a id="MercatorTile"></a>MercatorTile
-
-[**@xylabs/geo**](#../README)
-
-***
-
-```ts
-type MercatorTile = readonly [number, number, number];
-```
-
-A Mercator tile represented as [x, y, zoom].
-
-      ### variables
-
-        ### <a id="d2r"></a>d2r
-
-[**@xylabs/geo**](#../README)
-
-***
-
-```ts
-const d2r: number;
-```
-
-Conversion factor from degrees to radians.
-
-        ### <a id="r2d"></a>r2d
-
-[**@xylabs/geo**](#../README)
-
-***
-
-```ts
-const r2d: number;
-```
-
-Conversion factor from radians to degrees.
-
-## Credits
-
-[Made with 🔥 and ❄️ by XY Labs](https://xylabs.com)
-
-[npm-badge]: https://img.shields.io/npm/v/@xylabs/geo.svg
-[npm-link]: https://www.npmjs.com/package/@xylabs/geo
-[license-badge]: https://img.shields.io/npm/l/@xylabs/geo.svg
-[license-link]: https://github.com/xylabs/sdk-js/blob/main/LICENSE
-[logo]: https://cdn.xy.company/img/brand/XYPersistentCompany_Logo_Icon_Colored.svg
+DEPRECATED — use `@ariestools/sdk/geo` instead.