@xylabs/geo 5.0.79 → 5.0.81

package/README.md

@@ -312,7 +312,7 @@ source: string;
 ### update()
 
 ```ts
-update(map, show): void;
+update(map, show?): void;
 ```
 
 ### Parameters
@@ -321,7 +321,7 @@ update(map, show): void;
 
 `Map$1`
 
-#### show
+#### show?
 
 `boolean` = `true`
 
@@ -446,7 +446,7 @@ function boundingBoxToBoundary(box): MercatorBoundary;
 ***
 
 ```ts
-function boundingBoxToCenter(boundingBox, decimal): number[];
+function boundingBoxToCenter(boundingBox, decimal?): number[];
 ```
 
 ## Parameters
@@ -455,7 +455,7 @@ function boundingBoxToCenter(boundingBox, decimal): number[];
 
 [`MercatorBoundingBox`](#../classes/MercatorBoundingBox)
 
-### decimal
+### decimal?
 
 `number` = `6`
 
@@ -514,7 +514,7 @@ function hasSiblings(tiles, tile): boolean;
 ***
 
 ```ts
-function tileFromPoint(point, z): number[];
+function tileFromPoint(point, z): MercatorTile;
 ```
 
 ## Parameters
@@ -529,7 +529,7 @@ function tileFromPoint(point, z): number[];
 
 ## Returns
 
-`number`[]
+[`MercatorTile`](#../type-aliases/MercatorTile)
 
   ### <a id="tileFromQuadkey"></a>tileFromQuadkey
 
@@ -538,7 +538,7 @@ function tileFromPoint(point, z): number[];
 ***
 
 ```ts
-function tileFromQuadkey(quadkey): number[];
+function tileFromQuadkey(quadkey): MercatorTile;
 ```
 
 ## Parameters
@@ -549,7 +549,7 @@ function tileFromQuadkey(quadkey): number[];
 
 ## Returns
 
-`number`[]
+[`MercatorTile`](#../type-aliases/MercatorTile)
 
   ### <a id="tileToBoundingBox"></a>tileToBoundingBox
 
@@ -578,7 +578,7 @@ function tileToBoundingBox(tile): MercatorBoundingBox;
 ***
 
 ```ts
-function tileToChildren(tile): number[][];
+function tileToChildren(tile): MercatorTile[];
 ```
 
 ## Parameters
@@ -589,7 +589,7 @@ function tileToChildren(tile): number[][];
 
 ## Returns
 
-`number`[][]
+[`MercatorTile`](#../type-aliases/MercatorTile)[]
 
   ### <a id="tileToGeoJson"></a>tileToGeoJson
 
@@ -658,12 +658,12 @@ function tileToPoint(tile): MercatorLngLat;
 ***
 
 ```ts
-function tileToQuadkey(tile): string;
+function tileToQuadkey(__namedParameters): string;
 ```
 
 ## Parameters
 
-### tile
+### \_\_namedParameters
 
 [`MercatorTile`](#../type-aliases/MercatorTile)
 
@@ -698,16 +698,16 @@ function tileToSiblings(tile): MercatorTile[];
 ***
 
 ```ts
-function tilesEqual(tile1, tile2): boolean;
+function tilesEqual(__namedParameters, __namedParameters): boolean;
 ```
 
 ## Parameters
 
-### tile1
+### \_\_namedParameters
 
 [`MercatorTile`](#../type-aliases/MercatorTile)
 
-### tile2
+### \_\_namedParameters
 
 [`MercatorTile`](#../type-aliases/MercatorTile)
 
@@ -782,7 +782,7 @@ type MercatorBoundary = MercatorLngLat[];
 ***
 
 ```ts
-type MercatorTile = number[];
+type MercatorTile = readonly [number, number, number];
 ```
 
 ### variables

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xylabs/geo",
-  "version": "5.0.79",
+  "version": "5.0.81",
   "description": "Base functionality used throughout XY Labs TypeScript/JavaScript libraries",
   "keywords": [
     "xylabs",
@@ -28,28 +28,25 @@
   "exports": {
     ".": {
       "types": "./dist/neutral/index.d.ts",
-      "source": "./src/index.ts",
       "default": "./dist/neutral/index.mjs"
     },
     "./package.json": "./package.json"
   },
   "module": "./dist/neutral/index.mjs",
-  "source": "./src/index.ts",
   "types": "./dist/neutral/index.d.ts",
   "files": [
     "dist",
-    "src",
     "!**/*.bench.*",
     "!**/*.spec.*",
     "!**/*.test.*"
   ],
   "dependencies": {
     "@types/geojson": "~7946.0.16",
-    "mapbox-gl": "~3.18.1"
+    "mapbox-gl": "~3.19.1"
   },
   "devDependencies": {
-    "@xylabs/ts-scripts-yarn3": "~7.3.2",
-    "@xylabs/tsconfig": "~7.3.2",
+    "@xylabs/ts-scripts-yarn3": "~7.4.11",
+    "@xylabs/tsconfig": "~7.4.11",
     "typescript": "~5.9.3",
     "vitest": "~4.0.18"
   },

package/src/GeoJson.ts

@@ -1,104 +0,0 @@
-import type {
-  Feature, FeatureCollection, Geometry, Point, Polygon,
-} from 'geojson'
-import MapBox from 'mapbox-gl'
-
-import {
-  boundingBoxToCenter, boundingBoxToPolygon, tileFromQuadkey, tileToBoundingBox,
-} from './mercator/index.ts'
-
-class GeoJson {
-  private _lngLat?: MapBox.LngLat
-  private _point?: Point
-  private _polygon?: Polygon
-  private _zoom?: number
-
-  private quadkey: string
-
-  constructor(quadkey: string) {
-    this.quadkey = quadkey
-  }
-
-  static featureCollection(features: Feature[]): FeatureCollection {
-    return {
-      features,
-      type: 'FeatureCollection',
-    }
-  }
-
-  static featuresSource(data: FeatureCollection): MapBox.GeoJSONSourceSpecification {
-    return {
-      data,
-      type: 'geojson',
-    }
-  }
-
-  static geometryFeature(geometry: Geometry): Feature {
-    return {
-      geometry,
-      properties: {},
-      type: 'Feature',
-    }
-  }
-
-  center(): MapBox.LngLat {
-    if (!this._lngLat) {
-      const tile = tileFromQuadkey(this.quadkey)
-      const bb = tileToBoundingBox(tile)
-      const point = boundingBoxToCenter(bb)
-      this._lngLat = new MapBox.LngLat(point[0], point[1])
-    }
-    return this._lngLat
-  }
-
-  point(): Point {
-    if (!this._point) {
-      this._point = {
-        coordinates: this.center().toArray(),
-        type: 'Point',
-      }
-    }
-    return this._point
-  }
-
-  pointFeature(): Feature {
-    return GeoJson.geometryFeature(this.point())
-  }
-
-  pointFeatureCollection(): FeatureCollection {
-    return GeoJson.featureCollection([this.pointFeature()])
-  }
-
-  pointSource(): MapBox.GeoJSONSourceSpecification {
-    return {
-      data: this.pointFeatureCollection(),
-      type: 'geojson',
-    }
-  }
-
-  polygon(): Polygon {
-    if (!this._polygon) {
-      this._polygon = boundingBoxToPolygon(tileToBoundingBox(tileFromQuadkey(this.quadkey))) as Polygon
-    }
-    return this._polygon
-  }
-
-  polygonFeature(): Feature {
-    return GeoJson.geometryFeature(this.polygon())
-  }
-
-  polygonFeatureCollection(): FeatureCollection {
-    return GeoJson.featureCollection([this.polygonFeature()])
-  }
-
-  polygonSource(): MapBox.GeoJSONSourceSpecification {
-    return GeoJson.featuresSource(this.polygonFeatureCollection())
-  }
-
-  zoom(): number {
-    this._zoom = this._zoom ?? tileFromQuadkey(this.quadkey)[2]
-    return this._zoom
-  }
-}
-
-export { GeoJson }

package/src/LayerBase.ts

@@ -1,22 +0,0 @@
-import type MapBox from 'mapbox-gl'
-
-export abstract class LayerBase<T extends MapBox.Layer> {
-  id: string
-  source: string
-
-  constructor(id: string, source: string) {
-    this.id = id
-    this.source = source
-  }
-
-  update(map: MapBox.Map, show = true) {
-    if (map.getLayer(this.id)) {
-      map.removeLayer(this.id)
-    }
-    if (show) {
-      map.addLayer(this.buildLayer())
-    }
-  }
-
-  abstract buildLayer(): T
-}

package/src/index.ts

@@ -1,3 +0,0 @@
-export * from './GeoJson.ts'
-export * from './LayerBase.ts'
-export * from './mercator/index.ts'

package/src/mercator/boundingbox/index.ts

@@ -1 +0,0 @@
-export * from './to/index.ts'

package/src/mercator/boundingbox/to/boundary.ts

@@ -1,5 +0,0 @@
-import type { MercatorBoundary, MercatorBoundingBox } from '../../types.ts'
-
-export const boundingBoxToBoundary = (box: MercatorBoundingBox): MercatorBoundary => {
-  return [box.getNorthWest(), box.getNorthEast(), box.getSouthEast(), box.getSouthWest(), box.getNorthWest()]
-}

package/src/mercator/boundingbox/to/center.ts

@@ -1,15 +0,0 @@
-import type { MercatorBoundingBox } from '../../types.ts'
-
-export const boundingBoxToCenter = (boundingBox: MercatorBoundingBox, decimal = 6) => {
-  const west = boundingBox.getWest()
-  const south = boundingBox.getSouth()
-  const east = boundingBox.getEast()
-  const north = boundingBox.getNorth()
-  let lng = (west - east) / 2 + east
-  let lat = (south - north) / 2 + north
-  if (decimal !== undefined && decimal !== null) {
-    lng = Number(lng.toFixed(decimal))
-    lat = Number(lat.toFixed(decimal))
-  }
-  return [lng, lat]
-}

package/src/mercator/boundingbox/to/index.ts

@@ -1,3 +0,0 @@
-export { boundingBoxToBoundary } from './boundary.ts'
-export { boundingBoxToCenter } from './center.ts'
-export { boundingBoxToPolygon } from './polygon.ts'

package/src/mercator/boundingbox/to/polygon.ts

@@ -1,12 +0,0 @@
-import type { Polygon } from 'geojson'
-
-import type { MercatorBoundingBox, MercatorLngLat } from '../../types.ts'
-import { boundingBoxToBoundary } from './boundary.ts'
-
-export const boundingBoxToPolygon = (box: MercatorBoundingBox): Polygon => {
-  const boundry = boundingBoxToBoundary(box)
-  return {
-    coordinates: [boundry.map((lnglng: MercatorLngLat) => lnglng.toArray())],
-    type: 'Polygon',
-  }
-}

package/src/mercator/constants.ts

@@ -1,4 +0,0 @@
-const d2r = Math.PI / 180
-const r2d = 180 / Math.PI
-
-export { d2r, r2d }

package/src/mercator/index.ts

@@ -1,5 +0,0 @@
-export * from './boundingbox/index.ts'
-export * from './constants.ts'
-export * from './tile/index.ts'
-export * from './tiles/index.ts'
-export * from './types.ts'

package/src/mercator/tile/from/index.ts

@@ -1,2 +0,0 @@
-export { tileFromPoint } from './point.ts'
-export { tileFromQuadkey } from './quadkey.ts'

package/src/mercator/tile/from/point.ts

@@ -1,23 +0,0 @@
-import { d2r } from '../../constants.ts'
-import type { MercatorLngLat, MercatorTile } from '../../types.ts'
-
-const pointToTileFraction = (point: MercatorLngLat, z: number): MercatorTile => {
-  const sin = Math.sin(point.lat * d2r)
-  const z2 = Math.pow(2, z)
-  let x = z2 * (point.lng / 360 + 0.5)
-  const y = z2 * (0.5 - (0.25 * Math.log((1 + sin) / (1 - sin))) / Math.PI)
-
-  // Wrap Tile X
-  x = x % z2
-  if (x < 0) x = x + z2
-  return [x, y, z]
-}
-
-const tileFromPoint = (point: MercatorLngLat, z: number): MercatorTile => {
-  const [tileX, tileY, tileZoom] = pointToTileFraction(point, z)
-  const x = Math.max(Math.floor(tileX), 0)
-  const y = Math.max(Math.floor(tileY), 0)
-  return [x, y, tileZoom]
-}
-
-export { tileFromPoint }

package/src/mercator/tile/from/quadkey.ts

@@ -1,21 +0,0 @@
-import type { MercatorTile } from '../../types.ts'
-
-const tileFromQuadkey = (quadkey: string): MercatorTile => {
-  let x = 0
-  let y = 0
-  const z = quadkey.length
-
-  for (let i = z; i > 0; i--) {
-    const mask = 1 << (i - 1)
-    const q = +quadkey[z - i]
-    if (q === 1) x |= mask
-    if (q === 2) y |= mask
-    if (q === 3) {
-      x |= mask
-      y |= mask
-    }
-  }
-  return [x, y, z]
-}
-
-export { tileFromQuadkey }

package/src/mercator/tile/index.ts

@@ -1,2 +0,0 @@
-export * from './from/index.ts'
-export * from './to/index.ts'

package/src/mercator/tile/to/boundingbox.ts

@@ -1,24 +0,0 @@
-import MapBox from 'mapbox-gl'
-
-import { r2d } from '../../constants.ts'
-import type { MercatorTile } from '../../types.ts'
-import { MercatorBoundingBox } from '../../types.ts'
-
-const toLongitude = (x: number, z: number): number => {
-  return (x / Math.pow(2, z)) * 360 - 180
-}
-
-const toLatitude = (y: number, z: number): number => {
-  const n = Math.PI - (2 * Math.PI * y) / Math.pow(2, z)
-  return r2d * Math.atan(0.5 * (Math.exp(n) - Math.exp(-n)))
-}
-
-const tileToBoundingBox = (tile: MercatorTile): MercatorBoundingBox => {
-  const e = toLongitude(tile[0] + 1, tile[2])
-  const w = toLongitude(tile[0], tile[2])
-  const s = toLatitude(tile[1] + 1, tile[2])
-  const n = toLatitude(tile[1], tile[2])
-  return new MercatorBoundingBox(new MapBox.LngLat(w, s), new MapBox.LngLat(e, n))
-}
-
-export { tileToBoundingBox }

package/src/mercator/tile/to/children.ts

@@ -1,12 +0,0 @@
-import type { MercatorTile } from '../../types.ts'
-
-const tileToChildren = (tile: MercatorTile): MercatorTile[] => {
-  return [
-    [tile[0] * 2, tile[1] * 2, tile[2] + 1],
-    [tile[0] * 2 + 1, tile[1] * 2, tile[2] + 1],
-    [tile[0] * 2 + 1, tile[1] * 2 + 1, tile[2] + 1],
-    [tile[0] * 2, tile[1] * 2 + 1, tile[2] + 1],
-  ]
-}
-
-export { tileToChildren }

package/src/mercator/tile/to/geoJson.ts

@@ -1,23 +0,0 @@
-import type { Polygon, Position } from 'geojson'
-
-import type { MercatorTile } from '../../types.ts'
-import { tileToBoundingBox } from './boundingbox.ts'
-
-const tileToGeoJson = (tile: MercatorTile): Polygon => {
-  const box = tileToBoundingBox(tile)
-  const poly: Polygon = {
-    coordinates: [
-      [
-        box.getNorthWest().toArray() as Position,
-        box.getNorthEast().toArray() as Position,
-        box.getSouthEast().toArray() as Position,
-        box.getSouthWest().toArray() as Position,
-        box.getNorthWest().toArray() as Position,
-      ],
-    ],
-    type: 'Polygon',
-  }
-  return poly
-}
-
-export { tileToGeoJson }

package/src/mercator/tile/to/index.ts

@@ -1,7 +0,0 @@
-export { tileToBoundingBox } from './boundingbox.ts'
-export { tileToChildren } from './children.ts'
-export { tileToGeoJson } from './geoJson.ts'
-export { tileToParent } from './parent.ts'
-export { tileToPoint } from './point.ts'
-export { tileToQuadkey } from './quadkey.ts'
-export { tileToSiblings } from './siblings.ts'

package/src/mercator/tile/to/parent.ts

@@ -1,7 +0,0 @@
-import type { MercatorTile } from '../../types.ts'
-
-const tileToParent = (tile: MercatorTile): MercatorTile => {
-  return [tile[0] >> 1, tile[1] >> 1, tile[2] - 1]
-}
-
-export { tileToParent }

package/src/mercator/tile/to/point.ts

@@ -1,10 +0,0 @@
-import type { MercatorLngLat, MercatorTile } from '../../types.ts'
-import { tileToBoundingBox } from './boundingbox.ts'
-
-const tileToPoint = (tile: MercatorTile): MercatorLngLat => {
-  const boundingBox = tileToBoundingBox(tile)
-  boundingBox.getCenter()
-  return boundingBox.getCenter()
-}
-
-export { tileToPoint }

package/src/mercator/tile/to/quadkey.ts

@@ -1,15 +0,0 @@
-import type { MercatorTile } from '../../types.ts'
-
-const tileToQuadkey = ([tileX, tileY, tileZoom]: MercatorTile): string => {
-  let index = ''
-  for (let z = tileZoom; z > 0; z--) {
-    let b = 0
-    const mask = 1 << (z - 1)
-    if ((tileX & mask) !== 0) b++
-    if ((tileY & mask) !== 0) b += 2
-    index += b.toString()
-  }
-  return index
-}
-
-export { tileToQuadkey }

package/src/mercator/tile/to/siblings.ts

@@ -1,9 +0,0 @@
-import type { MercatorTile } from '../../types.ts'
-import { tileToChildren } from './children.ts'
-import { tileToParent } from './parent.ts'
-
-const tileToSiblings = (tile: MercatorTile): MercatorTile[] => {
-  return tileToChildren(tileToParent(tile))
-}
-
-export { tileToSiblings }

package/src/mercator/tiles/equal.ts

@@ -1,5 +0,0 @@
-import type { MercatorTile } from '../types.ts'
-
-export const tilesEqual = /* @__PURE__ */ ([x1, y1, zoom1]: MercatorTile, [x2, y2, zoom2]: MercatorTile): boolean => {
-  return x1 === x2 && y1 === y2 && zoom1 === zoom2
-}

package/src/mercator/tiles/from/boundingbox.ts

@@ -1,37 +0,0 @@
-import { tileFromPoint } from '../../tile/index.ts'
-import type { MercatorBoundingBox, MercatorTile } from '../../types.ts'
-
-const tilesFromBoundingBox = (box: MercatorBoundingBox, zoom: number): MercatorTile[] => {
-  const nw = tileFromPoint(box.getNorthWest(), zoom)
-  const se = tileFromPoint(box.getSouthEast(), zoom)
-  const size = Math.pow(2, zoom)
-
-  let minX = nw[0]
-  let maxX = se[0]
-  let minY = nw[1]
-  let maxY = se[1]
-
-  // in case of horizontal wrapping
-  if (minX >= maxX) {
-    maxX = maxX + size
-  }
-
-  if (zoom < 4) {
-    minX = 0
-    maxX = size - 1
-    minY = 0
-    maxY = size - 1
-  }
-
-  const result: MercatorTile[] = []
-
-  for (let x = minX; x <= maxX; x++) {
-    for (let y = minY; y <= maxY; y++) {
-      result.push([x % size, y, zoom])
-    }
-  }
-
-  return result
-}
-
-export { tilesFromBoundingBox }

package/src/mercator/tiles/from/index.ts

@@ -1 +0,0 @@
-export { tilesFromBoundingBox } from './boundingbox.ts'

package/src/mercator/tiles/hasSiblings.ts

@@ -1,11 +0,0 @@
-import { tileToSiblings } from '../tile/index.ts'
-import type { MercatorTile } from '../types.ts'
-import { tilesHasTile } from './hasTile.ts'
-
-export const hasSiblings = (tiles: MercatorTile[], tile: MercatorTile) => {
-  const siblings = tileToSiblings(tile)
-  for (const sibling of siblings) {
-    if (!tilesHasTile(tiles, sibling)) return false
-  }
-  return true
-}

package/src/mercator/tiles/hasTile.ts

@@ -1,9 +0,0 @@
-import type { MercatorTile } from '../types.ts'
-import { tilesEqual } from './equal.ts'
-
-export const tilesHasTile = (tiles: MercatorTile[], tile: MercatorTile) => {
-  for (const tileToCheck of tiles) {
-    if (tilesEqual(tileToCheck, tile)) return true
-  }
-  return false
-}

package/src/mercator/tiles/index.ts

@@ -1,5 +0,0 @@
-export * from './equal.ts'
-export * from './from/index.ts'
-export * from './hasSiblings.ts'
-export * from './hasTile.ts'
-export * from './hasTile.ts'

package/src/mercator/types.ts

@@ -1,9 +0,0 @@
-import MapBox from 'mapbox-gl'
-
-type MercatorTile = readonly [x: number, y: number, zoom: number]
-type MercatorBoundary = MercatorLngLat[]
-class MercatorBoundingBox extends MapBox.LngLatBounds {}
-class MercatorLngLat extends MapBox.LngLat {}
-
-export { MercatorBoundingBox, MercatorLngLat }
-export type { MercatorBoundary, MercatorTile }