@loaders.gl/pmtiles 4.2.0-alpha.4 → 4.2.0-alpha.5

package/dist/pmtiles-source.js

@@ -1,112 +1,94 @@
+// loaders.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
 import { DataSource, resolvePath } from '@loaders.gl/loader-utils';
 import { ImageLoader } from '@loaders.gl/images';
 import { MVTLoader } from '@loaders.gl/mvt';
 import * as pmtiles from 'pmtiles';
-const {
-  PMTiles
-} = pmtiles;
+const { PMTiles } = pmtiles;
 import { parsePMTilesHeader } from "./lib/parse-pmtiles.js";
 import { BlobSource } from "./lib/blob-source.js";
 const VERSION = '1.0.0';
 export const PMTilesService = {
-  name: 'PMTiles',
-  id: 'pmtiles',
-  module: 'pmtiles',
-  version: VERSION,
-  extensions: ['pmtiles'],
-  mimeTypes: ['application/octet-stream'],
-  options: {
-    pmtiles: {}
-  },
-  createSource: props => new PMTilesSource(props)
+    name: 'PMTiles',
+    id: 'pmtiles',
+    module: 'pmtiles',
+    version: VERSION,
+    extensions: ['pmtiles'],
+    mimeTypes: ['application/octet-stream'],
+    options: {
+        pmtiles: {}
+    },
+    createSource: (props) => new PMTilesSource(props)
 };
+/**
+ * A PMTiles data source
+ * @note Can be either a raster or vector tile source depending on the contents of the PMTiles file.
+ */
 export class PMTilesSource extends DataSource {
-  constructor(props) {
-    super(props);
-    this.data = void 0;
-    this.props = void 0;
-    this.mimeType = null;
-    this.pmtiles = void 0;
-    this.metadata = void 0;
-    this.props = props;
-    const url = typeof props.url === 'string' ? resolvePath(props.url) : new BlobSource(props.url, 'pmtiles');
-    this.data = props.url;
-    this.pmtiles = new PMTiles(url);
-    this.getTileData = this.getTileData.bind(this);
-    this.metadata = this.getMetadata();
-  }
-  async getMetadata() {
-    const pmtilesHeader = await this.pmtiles.getHeader();
-    const pmtilesMetadata = await this.pmtiles.getMetadata();
-    const metadata = parsePMTilesHeader(pmtilesHeader, pmtilesMetadata, {
-      includeFormatHeader: false
-    }, this.loadOptions);
-    if (this.props.attributions) {
-      metadata.attributions = [...this.props.attributions, ...(metadata.attributions || [])];
+    constructor(props) {
+        super(props);
+        this.mimeType = null;
+        this.props = props;
+        const url = typeof props.url === 'string' ? resolvePath(props.url) : new BlobSource(props.url, 'pmtiles');
+        this.data = props.url;
+        this.pmtiles = new PMTiles(url);
+        this.getTileData = this.getTileData.bind(this);
+        this.metadata = this.getMetadata();
     }
-    if (metadata !== null && metadata !== void 0 && metadata.tileMIMEType) {
-      this.mimeType = metadata === null || metadata === void 0 ? void 0 : metadata.tileMIMEType;
+    async getMetadata() {
+        const pmtilesHeader = await this.pmtiles.getHeader();
+        const pmtilesMetadata = await this.pmtiles.getMetadata();
+        const metadata = parsePMTilesHeader(pmtilesHeader, pmtilesMetadata, { includeFormatHeader: false }, this.loadOptions);
+        // Add additional attribution if necessary
+        if (this.props.attributions) {
+            metadata.attributions = [...this.props.attributions, ...(metadata.attributions || [])];
+        }
+        if (metadata?.tileMIMEType) {
+            this.mimeType = metadata?.tileMIMEType;
+        }
+        // TODO - do we need to allow tileSize to be overridden? Some PMTiles examples seem to suggest it.
+        return metadata;
     }
-    return metadata;
-  }
-  async getTile(tileParams) {
-    const {
-      x,
-      y,
-      zoom: z
-    } = tileParams;
-    const rangeResponse = await this.pmtiles.getZxy(z, x, y);
-    const arrayBuffer = rangeResponse === null || rangeResponse === void 0 ? void 0 : rangeResponse.data;
-    if (!arrayBuffer) {
-      return null;
+    async getTile(tileParams) {
+        const { x, y, zoom: z } = tileParams;
+        const rangeResponse = await this.pmtiles.getZxy(z, x, y);
+        const arrayBuffer = rangeResponse?.data;
+        if (!arrayBuffer) {
+            // console.error('No arrayBuffer', tileParams);
+            return null;
+        }
+        return arrayBuffer;
     }
-    return arrayBuffer;
-  }
-  async getTileData(tileParams) {
-    const {
-      x,
-      y,
-      z
-    } = tileParams.index;
-    const metadata = await this.metadata;
-    switch (metadata.tileMIMEType) {
-      case 'application/vnd.mapbox-vector-tile':
-        return await this.getVectorTile({
-          x,
-          y,
-          zoom: z,
-          layers: []
-        });
-      default:
-        return await this.getImageTile({
-          x,
-          y,
-          zoom: z,
-          layers: []
-        });
+    // Tile Source interface implementation: deck.gl compatible API
+    // TODO - currently only handles image tiles, not vector tiles
+    async getTileData(tileParams) {
+        const { x, y, z } = tileParams.index;
+        const metadata = await this.metadata;
+        switch (metadata.tileMIMEType) {
+            case 'application/vnd.mapbox-vector-tile':
+                return await this.getVectorTile({ x, y, zoom: z, layers: [] });
+            default:
+                return await this.getImageTile({ x, y, zoom: z, layers: [] });
+        }
+    }
+    // ImageTileSource interface implementation
+    async getImageTile(tileParams) {
+        const arrayBuffer = await this.getTile(tileParams);
+        return arrayBuffer ? await ImageLoader.parse(arrayBuffer, this.loadOptions) : null;
+    }
+    // VectorTileSource interface implementation
+    async getVectorTile(tileParams) {
+        const arrayBuffer = await this.getTile(tileParams);
+        const loadOptions = {
+            shape: 'geojson-table',
+            mvt: {
+                coordinates: 'wgs84',
+                tileIndex: { x: tileParams.x, y: tileParams.y, z: tileParams.zoom },
+                ...this.loadOptions?.mvt
+            },
+            ...this.loadOptions
+        };
+        return arrayBuffer ? await MVTLoader.parse(arrayBuffer, loadOptions) : null;
     }
-  }
-  async getImageTile(tileParams) {
-    const arrayBuffer = await this.getTile(tileParams);
-    return arrayBuffer ? await ImageLoader.parse(arrayBuffer, this.loadOptions) : null;
-  }
-  async getVectorTile(tileParams) {
-    var _this$loadOptions;
-    const arrayBuffer = await this.getTile(tileParams);
-    const loadOptions = {
-      shape: 'geojson-table',
-      mvt: {
-        coordinates: 'wgs84',
-        tileIndex: {
-          x: tileParams.x,
-          y: tileParams.y,
-          z: tileParams.zoom
-        },
-        ...((_this$loadOptions = this.loadOptions) === null || _this$loadOptions === void 0 ? void 0 : _this$loadOptions.mvt)
-      },
-      ...this.loadOptions
-    };
-    return arrayBuffer ? await MVTLoader.parse(arrayBuffer, loadOptions) : null;
-  }
 }
-//# sourceMappingURL=pmtiles-source.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@loaders.gl/pmtiles",
-  "version": "4.2.0-alpha.4",
+  "version": "4.2.0-alpha.5",
   "description": "Framework-independent loader for the pmtiles format",
   "license": "MIT",
   "type": "module",
@@ -41,15 +41,19 @@
     "README.md"
   ],
   "scripts": {
-    "pre-build": "npm run build-bundle && npm run build-bundle -- --env=dev",
-    "build-bundle": "ocular-bundle ./src/index.ts"
+    "pre-build": "npm run build-bundle && npm run build-bundle-dev",
+    "build-bundle": "ocular-bundle ./bundle.ts --output=dist/dist.min.js",
+    "build-bundle-dev": "ocular-bundle ./bundle.ts --env=dev --output=dist/dist.dev.js"
   },
   "dependencies": {
-    "@loaders.gl/images": "4.2.0-alpha.4",
-    "@loaders.gl/loader-utils": "4.2.0-alpha.4",
-    "@loaders.gl/mvt": "4.2.0-alpha.4",
-    "@loaders.gl/schema": "4.2.0-alpha.4",
-    "pmtiles": "^2.7.2"
+    "@loaders.gl/images": "4.2.0-alpha.5",
+    "@loaders.gl/loader-utils": "4.2.0-alpha.5",
+    "@loaders.gl/mvt": "4.2.0-alpha.5",
+    "@loaders.gl/schema": "4.2.0-alpha.5",
+    "pmtiles": "^3.0.4"
   },
-  "gitHead": "6c52dee5c3f005648a394cc4aee7fc37005c8e83"
+  "peerDependencies": {
+    "@loaders.gl/core": "^4.0.0"
+  },
+  "gitHead": "32d95a81971f104e4dfeb88ab57065f05321a76a"
 }

package/src/lib/parse-pmtiles.ts

@@ -2,7 +2,7 @@
 // SPDX-License-Identifier: MIT
 // Copyright (c) vis.gl contributors
 
-import {LoaderOptions} from '@loaders.gl/loader-utils';
+import type {LoaderOptions} from '@loaders.gl/loader-utils';
 import type {TileJSON} from '@loaders.gl/mvt';
 import {TileJSONLoader} from '@loaders.gl/mvt';
 // import {Source, PMTiles, Header, TileType} from 'pmtiles';
@@ -61,10 +61,12 @@ export type PMTilesMetadata = {
  */
 export function parsePMTilesHeader(
   header: pmtiles.Header,
-  pmtilesMetadata: Record<string, unknown> | null,
+  pmmetadata: unknown,
   options?: {includeFormatHeader?: boolean},
   loadOptions?: LoaderOptions
 ): PMTilesMetadata {
+  const pmtilesMetadata = pmmetadata as Record<string, unknown> | null;
+
   // Ironically, to use the TileJSON loader we need to stringify the metadata again.
   // This is the price of integrating with the existing pmtiles library.
   // TODO - provide a non-standard TileJSONLoader parsers that accepts a JSON object?

package/dist/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","names":["PMTilesSource"],"sources":["../src/index.ts"],"sourcesContent":["// loaders.gl\n// SPDX-License-Identifier: MIT\n// Copyright (c) vis.gl contributors\n\nexport type {PMTilesMetadata} from './lib/parse-pmtiles';\nexport type {PMTilesSourceProps} from './pmtiles-source';\nexport {PMTilesSource} from './pmtiles-source';\n"],"mappings":"SAMQA,aAAa"}

package/dist/lib/blob-source.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"blob-source.js","names":["BlobSource","constructor","blob","key","getKey","url","getBytes","offset","length","signal","slice","data","arrayBuffer"],"sources":["../../src/lib/blob-source.ts"],"sourcesContent":["// loaders.gl\n// SPDX-License-Identifier: MIT\n// Copyright (c) vis.gl contributors\n\nimport * as pmtiles from 'pmtiles';\n\n/**\n * A PMTiles library compatible source that reads from blobs\n * @deprecated TODO - reimplement as ReadableFileSource\n * Use loaders.gl HTTP range requests instead\n */\nexport class BlobSource implements pmtiles.Source {\n  blob: Blob;\n  key: string;\n\n  constructor(blob: Blob, key: string) {\n    this.blob = blob;\n    this.key = key;\n  }\n\n  // TODO - how is this used?\n  getKey() {\n    // @ts-expect-error url is only defined on File subclass\n    return this.blob.url || '';\n  }\n\n  async getBytes(\n    offset: number,\n    length: number,\n    signal?: AbortSignal\n  ): Promise<pmtiles.RangeResponse> {\n    const slice = this.blob.slice(offset, offset + length);\n    const data = await slice.arrayBuffer();\n    return {\n      data\n      // etag: response.headers.get('ETag') || undefined,\n      // cacheControl: response.headers.get('Cache-Control') || undefined,\n      // expires: response.headers.get('Expires') || undefined\n    };\n  }\n}\n"],"mappings":"AAWA,OAAO,MAAMA,UAAU,CAA2B;EAIhDC,WAAWA,CAACC,IAAU,EAAEC,GAAW,EAAE;IAAA,KAHrCD,IAAI;IAAA,KACJC,GAAG;IAGD,IAAI,CAACD,IAAI,GAAGA,IAAI;IAChB,IAAI,CAACC,GAAG,GAAGA,GAAG;EAChB;EAGAC,MAAMA,CAAA,EAAG;IAEP,OAAO,IAAI,CAACF,IAAI,CAACG,GAAG,IAAI,EAAE;EAC5B;EAEA,MAAMC,QAAQA,CACZC,MAAc,EACdC,MAAc,EACdC,MAAoB,EACY;IAChC,MAAMC,KAAK,GAAG,IAAI,CAACR,IAAI,CAACQ,KAAK,CAACH,MAAM,EAAEA,MAAM,GAAGC,MAAM,CAAC;IACtD,MAAMG,IAAI,GAAG,MAAMD,KAAK,CAACE,WAAW,CAAC,CAAC;IACtC,OAAO;MACLD;IAIF,CAAC;EACH;AACF"}

package/dist/lib/parse-pmtiles.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"parse-pmtiles.js","names":["TileJSONLoader","pmtiles","TileType","parsePMTilesHeader","header","pmtilesMetadata","options","loadOptions","_tilejson","_tilejson2","tilejson","_TileJSONLoader$parse","string","JSON","stringify","parseTextSync","call","error","console","warn","partialMetadata","name","htmlAttribution","attributions","metadata","format","formatVersion","specVersion","tileMIMEType","decodeTileType","tileType","minZoom","maxZoom","boundingBox","minLon","minLat","maxLon","maxLat","center","centerLon","centerLat","centerZoom","etag","includeFormatHeader","formatHeader","formatMetadata","Mvt","Png","Jpeg","Webp","Avif"],"sources":["../../src/lib/parse-pmtiles.ts"],"sourcesContent":["// loaders.gl\n// SPDX-License-Identifier: MIT\n// Copyright (c) vis.gl contributors\n\nimport {LoaderOptions} from '@loaders.gl/loader-utils';\nimport type {TileJSON} from '@loaders.gl/mvt';\nimport {TileJSONLoader} from '@loaders.gl/mvt';\n// import {Source, PMTiles, Header, TileType} from 'pmtiles';\nimport * as pmtiles from 'pmtiles';\nconst {TileType} = pmtiles;\n\n/** Metadata describing a PMTiles file */\nexport type PMTilesMetadata = {\n  format: 'pmtiles';\n  /** Version of pm tiles format used by this tileset */\n  formatVersion: number;\n\n  /** MIME type for tile contents. Unknown tile types will return 'application/octet-stream */\n  tileMIMEType:\n    | 'application/vnd.mapbox-vector-tile'\n    | 'image/png'\n    | 'image/jpeg'\n    | 'image/webp'\n    | 'image/avif'\n    | 'application/octet-stream';\n\n  /** Name of the tileset (extracted from JSON metadata if available) */\n  name?: string;\n  /** Attribution string (extracted from JSON metadata if available) */\n  attributions?: string[];\n\n  /** Minimal zoom level of tiles in this tileset */\n  minZoom: number;\n  /** Maximal zoom level of tiles in this tileset */\n  maxZoom: number;\n  /** Bounding box of tiles in this tileset `[[w, s], [e, n]]`  */\n  boundingBox: [min: [x: number, y: number], max: [x: number, y: number]];\n  /** Center long, lat of this tileset */\n  center: [number, number];\n  /** Center zoom level of this tileset */\n  centerZoom: number;\n  /** Cache tag */\n  etag?: string;\n\n  /** Parsed TileJSON/tilestats metadata, if present */\n  tilejson?: TileJSON;\n\n  /** @deprecated PMTiles format specific header */\n  formatHeader?: pmtiles.Header;\n  /** @deprecated Unparsed metadata (Assumption metadata generated by e.g. tippecanoe, typically TileJSON) */\n  formatMetadata?: Record<string, unknown>;\n};\n\n/**\n * Parse PMTiles metdata from a PMTiles file\n * @param header\n * @param tilejsonMetadata\n * @param options\n * @param loadOptions\n * @returns\n */\nexport function parsePMTilesHeader(\n  header: pmtiles.Header,\n  pmtilesMetadata: Record<string, unknown> | null,\n  options?: {includeFormatHeader?: boolean},\n  loadOptions?: LoaderOptions\n): PMTilesMetadata {\n  // Ironically, to use the TileJSON loader we need to stringify the metadata again.\n  // This is the price of integrating with the existing pmtiles library.\n  // TODO - provide a non-standard TileJSONLoader parsers that accepts a JSON object?\n  let tilejson: TileJSON | null = null;\n  if (pmtilesMetadata) {\n    try {\n      const string = JSON.stringify(pmtilesMetadata);\n      tilejson = TileJSONLoader.parseTextSync?.(string, loadOptions) || null;\n    } catch (error) {\n      // eslint-disable-next-line no-console\n      console.warn('PMTiles metadata could not be interpreted as TileJSON', error);\n    }\n  }\n\n  const partialMetadata: Partial<PMTilesMetadata> = {};\n\n  if (typeof tilejson?.name === 'string') {\n    partialMetadata.name = tilejson.name;\n  }\n\n  if (typeof tilejson?.htmlAttribution === 'string') {\n    partialMetadata.attributions = [tilejson.htmlAttribution];\n  }\n\n  const metadata: PMTilesMetadata = {\n    ...partialMetadata,\n    format: 'pmtiles',\n    formatVersion: header.specVersion,\n    attributions: [],\n    tileMIMEType: decodeTileType(header.tileType),\n    minZoom: header.minZoom,\n    maxZoom: header.maxZoom,\n    boundingBox: [\n      [header.minLon, header.minLat],\n      [header.maxLon, header.maxLat]\n    ],\n    center: [header.centerLon, header.centerLat],\n    centerZoom: header.centerZoom,\n    etag: header.etag\n  };\n\n  if (tilejson) {\n    metadata.tilejson = tilejson;\n  }\n\n  // Application can optionally include the raw header and metadata.\n  if (options?.includeFormatHeader) {\n    metadata.formatHeader = header;\n    metadata.formatMetadata = metadata;\n  }\n\n  return metadata;\n}\n\n/** Extract a MIME type for tiles from vector tile header  */\nfunction decodeTileType(\n  tileType: pmtiles.TileType\n):\n  | 'application/vnd.mapbox-vector-tile'\n  | 'image/png'\n  | 'image/jpeg'\n  | 'image/webp'\n  | 'image/avif'\n  | 'application/octet-stream' {\n  switch (tileType) {\n    case TileType.Mvt:\n      return 'application/vnd.mapbox-vector-tile';\n    case TileType.Png:\n      return 'image/png';\n    case TileType.Jpeg:\n      return 'image/jpeg';\n    case TileType.Webp:\n      return 'image/webp';\n    case TileType.Avif:\n      return 'image/avif';\n    default:\n      return 'application/octet-stream';\n  }\n}\n"],"mappings":"AAMA,SAAQA,cAAc,QAAO,iBAAiB;AAE9C,OAAO,KAAKC,OAAO,MAAM,SAAS;AAClC,MAAM;EAACC;AAAQ,CAAC,GAAGD,OAAO;AAoD1B,OAAO,SAASE,kBAAkBA,CAChCC,MAAsB,EACtBC,eAA+C,EAC/CC,OAAyC,EACzCC,WAA2B,EACV;EAAA,IAAAC,SAAA,EAAAC,UAAA;EAIjB,IAAIC,QAAyB,GAAG,IAAI;EACpC,IAAIL,eAAe,EAAE;IACnB,IAAI;MAAA,IAAAM,qBAAA;MACF,MAAMC,MAAM,GAAGC,IAAI,CAACC,SAAS,CAACT,eAAe,CAAC;MAC9CK,QAAQ,GAAG,EAAAC,qBAAA,GAAAX,cAAc,CAACe,aAAa,cAAAJ,qBAAA,uBAA5BA,qBAAA,CAAAK,IAAA,CAAAhB,cAAc,EAAiBY,MAAM,EAAEL,WAAW,CAAC,KAAI,IAAI;IACxE,CAAC,CAAC,OAAOU,KAAK,EAAE;MAEdC,OAAO,CAACC,IAAI,CAAC,uDAAuD,EAAEF,KAAK,CAAC;IAC9E;EACF;EAEA,MAAMG,eAAyC,GAAG,CAAC,CAAC;EAEpD,IAAI,SAAAZ,SAAA,GAAOE,QAAQ,cAAAF,SAAA,uBAARA,SAAA,CAAUa,IAAI,MAAK,QAAQ,EAAE;IACtCD,eAAe,CAACC,IAAI,GAAGX,QAAQ,CAACW,IAAI;EACtC;EAEA,IAAI,SAAAZ,UAAA,GAAOC,QAAQ,cAAAD,UAAA,uBAARA,UAAA,CAAUa,eAAe,MAAK,QAAQ,EAAE;IACjDF,eAAe,CAACG,YAAY,GAAG,CAACb,QAAQ,CAACY,eAAe,CAAC;EAC3D;EAEA,MAAME,QAAyB,GAAG;IAChC,GAAGJ,eAAe;IAClBK,MAAM,EAAE,SAAS;IACjBC,aAAa,EAAEtB,MAAM,CAACuB,WAAW;IACjCJ,YAAY,EAAE,EAAE;IAChBK,YAAY,EAAEC,cAAc,CAACzB,MAAM,CAAC0B,QAAQ,CAAC;IAC7CC,OAAO,EAAE3B,MAAM,CAAC2B,OAAO;IACvBC,OAAO,EAAE5B,MAAM,CAAC4B,OAAO;IACvBC,WAAW,EAAE,CACX,CAAC7B,MAAM,CAAC8B,MAAM,EAAE9B,MAAM,CAAC+B,MAAM,CAAC,EAC9B,CAAC/B,MAAM,CAACgC,MAAM,EAAEhC,MAAM,CAACiC,MAAM,CAAC,CAC/B;IACDC,MAAM,EAAE,CAAClC,MAAM,CAACmC,SAAS,EAAEnC,MAAM,CAACoC,SAAS,CAAC;IAC5CC,UAAU,EAAErC,MAAM,CAACqC,UAAU;IAC7BC,IAAI,EAAEtC,MAAM,CAACsC;EACf,CAAC;EAED,IAAIhC,QAAQ,EAAE;IACZc,QAAQ,CAACd,QAAQ,GAAGA,QAAQ;EAC9B;EAGA,IAAIJ,OAAO,aAAPA,OAAO,eAAPA,OAAO,CAAEqC,mBAAmB,EAAE;IAChCnB,QAAQ,CAACoB,YAAY,GAAGxC,MAAM;IAC9BoB,QAAQ,CAACqB,cAAc,GAAGrB,QAAQ;EACpC;EAEA,OAAOA,QAAQ;AACjB;AAGA,SAASK,cAAcA,CACrBC,QAA0B,EAOG;EAC7B,QAAQA,QAAQ;IACd,KAAK5B,QAAQ,CAAC4C,GAAG;MACf,OAAO,oCAAoC;IAC7C,KAAK5C,QAAQ,CAAC6C,GAAG;MACf,OAAO,WAAW;IACpB,KAAK7C,QAAQ,CAAC8C,IAAI;MAChB,OAAO,YAAY;IACrB,KAAK9C,QAAQ,CAAC+C,IAAI;MAChB,OAAO,YAAY;IACrB,KAAK/C,QAAQ,CAACgD,IAAI;MAChB,OAAO,YAAY;IACrB;MACE,OAAO,0BAA0B;EACrC;AACF"}

package/dist/pmtiles-source.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"pmtiles-source.js","names":["DataSource","resolvePath","ImageLoader","MVTLoader","pmtiles","PMTiles","parsePMTilesHeader","BlobSource","VERSION","PMTilesService","name","id","module","version","extensions","mimeTypes","options","createSource","props","PMTilesSource","constructor","data","mimeType","metadata","url","getTileData","bind","getMetadata","pmtilesHeader","getHeader","pmtilesMetadata","includeFormatHeader","loadOptions","attributions","tileMIMEType","getTile","tileParams","x","y","zoom","z","rangeResponse","getZxy","arrayBuffer","index","getVectorTile","layers","getImageTile","parse","_this$loadOptions","shape","mvt","coordinates","tileIndex"],"sources":["../src/pmtiles-source.ts"],"sourcesContent":["// loaders.gl\n// SPDX-License-Identifier: MIT\n// Copyright (c) vis.gl contributors\n\nimport type {TileLoadParameters, GetTileParameters} from '@loaders.gl/loader-utils';\nimport type {ImageType, DataSourceProps} from '@loaders.gl/loader-utils';\nimport type {ImageTileSource, VectorTileSource} from '@loaders.gl/loader-utils';\nimport {DataSource, resolvePath} from '@loaders.gl/loader-utils';\nimport {ImageLoader, ImageLoaderOptions} from '@loaders.gl/images';\nimport {MVTLoader, MVTLoaderOptions, TileJSONLoaderOptions} from '@loaders.gl/mvt';\n\nimport * as pmtiles from 'pmtiles';\nconst {PMTiles} = pmtiles;\n\nimport type {PMTilesMetadata} from './lib/parse-pmtiles';\nimport {parsePMTilesHeader} from './lib/parse-pmtiles';\nimport {BlobSource} from './lib/blob-source';\n\nconst VERSION = '1.0.0';\n\nexport type Service = {\n  name: string;\n  id: string;\n  module: string;\n  version: string;\n  extensions: string[];\n  mimeTypes: string[];\n  options: Record<string, unknown>;\n};\n\nexport type ServiceWithSource<SourceT, SourcePropsT> = Service & {\n  _source?: SourceT;\n  _sourceProps?: SourcePropsT;\n  createSource: (props: SourcePropsT) => SourceT;\n};\n\nexport const PMTilesService: ServiceWithSource<PMTilesSource, PMTilesSourceProps> = {\n  name: 'PMTiles',\n  id: 'pmtiles',\n  module: 'pmtiles',\n  version: VERSION,\n  extensions: ['pmtiles'],\n  mimeTypes: ['application/octet-stream'],\n  options: {\n    pmtiles: {}\n  },\n  createSource: (props: PMTilesSourceProps) => new PMTilesSource(props)\n};\n\nexport type PMTilesSourceProps = DataSourceProps & {\n  url: string | Blob;\n  attributions?: string[];\n  loadOptions?: TileJSONLoaderOptions & MVTLoaderOptions & ImageLoaderOptions;\n};\n\n/**\n * A PMTiles data source\n * @note Can be either a raster or vector tile source depending on the contents of the PMTiles file.\n */\nexport class PMTilesSource extends DataSource implements ImageTileSource, VectorTileSource {\n  data: string | Blob;\n  props: PMTilesSourceProps;\n  mimeType: string | null = null;\n  pmtiles: pmtiles.PMTiles;\n  metadata: Promise<PMTilesMetadata>;\n\n  constructor(props: PMTilesSourceProps) {\n    super(props);\n    this.props = props;\n    const url =\n      typeof props.url === 'string' ? resolvePath(props.url) : new BlobSource(props.url, 'pmtiles');\n    this.data = props.url;\n    this.pmtiles = new PMTiles(url);\n    this.getTileData = this.getTileData.bind(this);\n    this.metadata = this.getMetadata();\n  }\n\n  async getMetadata(): Promise<PMTilesMetadata> {\n    const pmtilesHeader = await this.pmtiles.getHeader();\n    const pmtilesMetadata = await this.pmtiles.getMetadata();\n    const metadata: PMTilesMetadata = parsePMTilesHeader(\n      pmtilesHeader,\n      pmtilesMetadata,\n      {includeFormatHeader: false},\n      this.loadOptions\n    );\n    // Add additional attribution if necessary\n    if (this.props.attributions) {\n      metadata.attributions = [...this.props.attributions, ...(metadata.attributions || [])];\n    }\n    if (metadata?.tileMIMEType) {\n      this.mimeType = metadata?.tileMIMEType;\n    }\n    // TODO - do we need to allow tileSize to be overridden? Some PMTiles examples seem to suggest it.\n    return metadata;\n  }\n\n  async getTile(tileParams: GetTileParameters): Promise<ArrayBuffer | null> {\n    const {x, y, zoom: z} = tileParams;\n    const rangeResponse = await this.pmtiles.getZxy(z, x, y);\n    const arrayBuffer = rangeResponse?.data;\n    if (!arrayBuffer) {\n      // console.error('No arrayBuffer', tileParams);\n      return null;\n    }\n    return arrayBuffer;\n  }\n\n  // Tile Source interface implementation: deck.gl compatible API\n  // TODO - currently only handles image tiles, not vector tiles\n\n  async getTileData(tileParams: TileLoadParameters): Promise<unknown | null> {\n    const {x, y, z} = tileParams.index;\n    const metadata = await this.metadata;\n    switch (metadata.tileMIMEType) {\n      case 'application/vnd.mapbox-vector-tile':\n        return await this.getVectorTile({x, y, zoom: z, layers: []});\n      default:\n        return await this.getImageTile({x, y, zoom: z, layers: []});\n    }\n  }\n\n  // ImageTileSource interface implementation\n\n  async getImageTile(tileParams: GetTileParameters): Promise<ImageType | null> {\n    const arrayBuffer = await this.getTile(tileParams);\n    return arrayBuffer ? await ImageLoader.parse(arrayBuffer, this.loadOptions) : null;\n  }\n\n  // VectorTileSource interface implementation\n\n  async getVectorTile(tileParams: GetTileParameters): Promise<unknown | null> {\n    const arrayBuffer = await this.getTile(tileParams);\n    const loadOptions: MVTLoaderOptions = {\n      shape: 'geojson-table',\n      mvt: {\n        coordinates: 'wgs84',\n        tileIndex: {x: tileParams.x, y: tileParams.y, z: tileParams.zoom},\n        ...(this.loadOptions as MVTLoaderOptions)?.mvt\n      },\n      ...this.loadOptions\n    };\n\n    return arrayBuffer ? await MVTLoader.parse(arrayBuffer, loadOptions) : null;\n  }\n}\n"],"mappings":"AAOA,SAAQA,UAAU,EAAEC,WAAW,QAAO,0BAA0B;AAChE,SAAQC,WAAW,QAA2B,oBAAoB;AAClE,SAAQC,SAAS,QAAgD,iBAAiB;AAElF,OAAO,KAAKC,OAAO,MAAM,SAAS;AAClC,MAAM;EAACC;AAAO,CAAC,GAAGD,OAAO;AAAC,SAGlBE,kBAAkB;AAAA,SAClBC,UAAU;AAElB,MAAMC,OAAO,GAAG,OAAO;AAkBvB,OAAO,MAAMC,cAAoE,GAAG;EAClFC,IAAI,EAAE,SAAS;EACfC,EAAE,EAAE,SAAS;EACbC,MAAM,EAAE,SAAS;EACjBC,OAAO,EAAEL,OAAO;EAChBM,UAAU,EAAE,CAAC,SAAS,CAAC;EACvBC,SAAS,EAAE,CAAC,0BAA0B,CAAC;EACvCC,OAAO,EAAE;IACPZ,OAAO,EAAE,CAAC;EACZ,CAAC;EACDa,YAAY,EAAGC,KAAyB,IAAK,IAAIC,aAAa,CAACD,KAAK;AACtE,CAAC;AAYD,OAAO,MAAMC,aAAa,SAASnB,UAAU,CAA8C;EAOzFoB,WAAWA,CAACF,KAAyB,EAAE;IACrC,KAAK,CAACA,KAAK,CAAC;IAAC,KAPfG,IAAI;IAAA,KACJH,KAAK;IAAA,KACLI,QAAQ,GAAkB,IAAI;IAAA,KAC9BlB,OAAO;IAAA,KACPmB,QAAQ;IAIN,IAAI,CAACL,KAAK,GAAGA,KAAK;IAClB,MAAMM,GAAG,GACP,OAAON,KAAK,CAACM,GAAG,KAAK,QAAQ,GAAGvB,WAAW,CAACiB,KAAK,CAACM,GAAG,CAAC,GAAG,IAAIjB,UAAU,CAACW,KAAK,CAACM,GAAG,EAAE,SAAS,CAAC;IAC/F,IAAI,CAACH,IAAI,GAAGH,KAAK,CAACM,GAAG;IACrB,IAAI,CAACpB,OAAO,GAAG,IAAIC,OAAO,CAACmB,GAAG,CAAC;IAC/B,IAAI,CAACC,WAAW,GAAG,IAAI,CAACA,WAAW,CAACC,IAAI,CAAC,IAAI,CAAC;IAC9C,IAAI,CAACH,QAAQ,GAAG,IAAI,CAACI,WAAW,CAAC,CAAC;EACpC;EAEA,MAAMA,WAAWA,CAAA,EAA6B;IAC5C,MAAMC,aAAa,GAAG,MAAM,IAAI,CAACxB,OAAO,CAACyB,SAAS,CAAC,CAAC;IACpD,MAAMC,eAAe,GAAG,MAAM,IAAI,CAAC1B,OAAO,CAACuB,WAAW,CAAC,CAAC;IACxD,MAAMJ,QAAyB,GAAGjB,kBAAkB,CAClDsB,aAAa,EACbE,eAAe,EACf;MAACC,mBAAmB,EAAE;IAAK,CAAC,EAC5B,IAAI,CAACC,WACP,CAAC;IAED,IAAI,IAAI,CAACd,KAAK,CAACe,YAAY,EAAE;MAC3BV,QAAQ,CAACU,YAAY,GAAG,CAAC,GAAG,IAAI,CAACf,KAAK,CAACe,YAAY,EAAE,IAAIV,QAAQ,CAACU,YAAY,IAAI,EAAE,CAAC,CAAC;IACxF;IACA,IAAIV,QAAQ,aAARA,QAAQ,eAARA,QAAQ,CAAEW,YAAY,EAAE;MAC1B,IAAI,CAACZ,QAAQ,GAAGC,QAAQ,aAARA,QAAQ,uBAARA,QAAQ,CAAEW,YAAY;IACxC;IAEA,OAAOX,QAAQ;EACjB;EAEA,MAAMY,OAAOA,CAACC,UAA6B,EAA+B;IACxE,MAAM;MAACC,CAAC;MAAEC,CAAC;MAAEC,IAAI,EAAEC;IAAC,CAAC,GAAGJ,UAAU;IAClC,MAAMK,aAAa,GAAG,MAAM,IAAI,CAACrC,OAAO,CAACsC,MAAM,CAACF,CAAC,EAAEH,CAAC,EAAEC,CAAC,CAAC;IACxD,MAAMK,WAAW,GAAGF,aAAa,aAAbA,aAAa,uBAAbA,aAAa,CAAEpB,IAAI;IACvC,IAAI,CAACsB,WAAW,EAAE;MAEhB,OAAO,IAAI;IACb;IACA,OAAOA,WAAW;EACpB;EAKA,MAAMlB,WAAWA,CAACW,UAA8B,EAA2B;IACzE,MAAM;MAACC,CAAC;MAAEC,CAAC;MAAEE;IAAC,CAAC,GAAGJ,UAAU,CAACQ,KAAK;IAClC,MAAMrB,QAAQ,GAAG,MAAM,IAAI,CAACA,QAAQ;IACpC,QAAQA,QAAQ,CAACW,YAAY;MAC3B,KAAK,oCAAoC;QACvC,OAAO,MAAM,IAAI,CAACW,aAAa,CAAC;UAACR,CAAC;UAAEC,CAAC;UAAEC,IAAI,EAAEC,CAAC;UAAEM,MAAM,EAAE;QAAE,CAAC,CAAC;MAC9D;QACE,OAAO,MAAM,IAAI,CAACC,YAAY,CAAC;UAACV,CAAC;UAAEC,CAAC;UAAEC,IAAI,EAAEC,CAAC;UAAEM,MAAM,EAAE;QAAE,CAAC,CAAC;IAC/D;EACF;EAIA,MAAMC,YAAYA,CAACX,UAA6B,EAA6B;IAC3E,MAAMO,WAAW,GAAG,MAAM,IAAI,CAACR,OAAO,CAACC,UAAU,CAAC;IAClD,OAAOO,WAAW,GAAG,MAAMzC,WAAW,CAAC8C,KAAK,CAACL,WAAW,EAAE,IAAI,CAACX,WAAW,CAAC,GAAG,IAAI;EACpF;EAIA,MAAMa,aAAaA,CAACT,UAA6B,EAA2B;IAAA,IAAAa,iBAAA;IAC1E,MAAMN,WAAW,GAAG,MAAM,IAAI,CAACR,OAAO,CAACC,UAAU,CAAC;IAClD,MAAMJ,WAA6B,GAAG;MACpCkB,KAAK,EAAE,eAAe;MACtBC,GAAG,EAAE;QACHC,WAAW,EAAE,OAAO;QACpBC,SAAS,EAAE;UAAChB,CAAC,EAAED,UAAU,CAACC,CAAC;UAAEC,CAAC,EAAEF,UAAU,CAACE,CAAC;UAAEE,CAAC,EAAEJ,UAAU,CAACG;QAAI,CAAC;QACjE,KAAAU,iBAAA,GAAI,IAAI,CAACjB,WAAW,cAAAiB,iBAAA,uBAAjBA,iBAAA,CAAwCE,GAAG;MAChD,CAAC;MACD,GAAG,IAAI,CAACnB;IACV,CAAC;IAED,OAAOW,WAAW,GAAG,MAAMxC,SAAS,CAAC6C,KAAK,CAACL,WAAW,EAAEX,WAAW,CAAC,GAAG,IAAI;EAC7E;AACF"}