@loaders.gl/pmtiles 4.0.0-beta.1

package/dist/esm/lib/sources.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sources.js","names":[],"sources":["../../../src/lib/sources.ts"],"sourcesContent":["/*\nimport {fetchFile} from '@loaders.gl/core';\n\nimport {Source as PMTilesSource, RangeResponse} from 'pmtiles';\n\n/** @note \"source\" here is a PMTiles library type, referring to  *\nexport function makeSource(data: string | Blob, fetch?) {\n  if (typeof data === 'string') {\n    return new FetchSource(data, fetch);\n  }\n  if (data instanceof Blob) {\n    const url = '';\n    return new BlobSource(data, url);\n  }\n}\n\nexport class BlobSource implements PMTilesSource {\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    return this.blob.url || '';\n  }\n\n  async getBytes(offset: number, length: number, signal?: AbortSignal): Promise<RangeResponse> {\n    const data = await this.blob.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\nexport class FetchSource implements PMTilesSource {\n  url: string;\n  fetch;\n\n  constructor(url: string, fetch = fetchFile) {\n    this.url = url;\n    this.fetch = fetch;\n  }\n\n  // TODO - how is this used?\n  getKey() {\n    return this.url;\n  }\n\n  async getBytes(offset: number, length: number, signal?: AbortSignal): Promise<RangeResponse> {\n    let controller;\n    if (!signal) {\n      // ToDO why is it so important to abort in case 200?\n      // TODO check this works or assert 206\n      controller = new AbortController();\n      signal = controller.signal;\n    }\n\n    let response = await fetch(this.url, {\n      signal,\n      headers: {Range: `bytes=${offset}-${offset + length - 1}`}\n    });\n\n    switch (response.status) {\n      case 206: // Partial Content success\n        // This is the expected success code for a range request\n        break;\n\n      case 200:\n        // some well-behaved backends, e.g. DigitalOcean CDN, respond with 200 instead of 206\n        // but we also need to detect no support for Byte Serving which is returning the whole file\n        const content_length = response.headers.get('Content-Length');\n        if (!content_length || Number(content_length) > length) {\n          if (controller) {\n            controller.abort();\n          }\n          throw Error(\n            'content-length header missing or exceeding request. Server must support HTTP Byte Serving.'\n          );\n        }\n\n      case 416: // \"Range Not Satisfiable\"\n        // some HTTP servers don't accept ranges beyond the end of the resource.\n        // Retry with the exact length\n        // TODO: can return 416 with offset > 0 if content changed, which will have a blank etag.\n        // See https://github.com/protomaps/PMTiles/issues/90\n        if (offset === 0) {\n          const content_range = response.headers.get('Content-Range');\n          if (!content_range || !content_range.startsWith('bytes *')) {\n            throw Error('Missing content-length on 416 response');\n          }\n          const actual_length = Number(content_range.substr(8));\n          response = await fetch(this.url, {\n            signal,\n            headers: {Range: `bytes=0-${actual_length - 1}`}\n          });\n        }\n        break;\n\n      default:\n        if (response.status >= 300) {\n          throw Error(`Bad response code: ${response.status}`);\n        }\n    }\n\n    const data = await response.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\n/*\nclass TestNodeFileSource implements Source {\n  buffer: ArrayBuffer;\n  path: string;\n  key: string;\n  etag?: string;\n\n  constructor(path: string, key: string) {\n    this.path = path;\n    this.buffer = fs.readFileSync(path);\n    this.key = key;\n  }\n\n  getKey() {\n    return this.key;\n  }\n\n  replaceData(path: string) {\n    this.path = path;\n    this.buffer = fs.readFileSync(path);\n  }\n\n  async getBytes(offset: number, length: number): Promise<RangeResponse> {\n    const slice = new Uint8Array(this.buffer.slice(offset, offset + length))\n      .buffer;\n    return { data: slice, etag: this.etag };\n  }\n}\n*/\n"],"mappings":""}

package/dist/esm/pmtiles-source.js

@@ -0,0 +1,106 @@
+import _defineProperty from "@babel/runtime/helpers/esm/defineProperty";
+import { DataSource, resolvePath } from '@loaders.gl/loader-utils';
+import { ImageLoader } from '@loaders.gl/images';
+import { MVTLoader } from '@loaders.gl/mvt';
+import { PMTiles } from 'pmtiles';
+import { parsePMTilesHeader } from './lib/parse-pmtiles';
+export class BlobSource {
+  constructor(blob, key) {
+    _defineProperty(this, "blob", void 0);
+    _defineProperty(this, "key", void 0);
+    this.blob = blob;
+    this.key = key;
+  }
+  getKey() {
+    return this.blob.url || '';
+  }
+  async getBytes(offset, length, signal) {
+    const slice = this.blob.slice(offset, offset + length);
+    const data = await slice.arrayBuffer();
+    return {
+      data
+    };
+  }
+}
+export class PMTilesSource extends DataSource {
+  constructor(props) {
+    super(props);
+    _defineProperty(this, "props", void 0);
+    _defineProperty(this, "pmtiles", void 0);
+    _defineProperty(this, "metadata", void 0);
+    this.props = props;
+    const url = typeof props.url === 'string' ? resolvePath(props.url) : new BlobSource(props.url, 'pmtiles');
+    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);
+    if (this.props.attributions) {
+      metadata.attributions = [...this.props.attributions, ...(metadata.attributions || [])];
+    }
+    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;
+    }
+    return arrayBuffer;
+  }
+  async getTileData(tileParams) {
+    const {
+      x,
+      y,
+      z
+    } = tileParams.index;
+    const metadata = await this.metadata;
+    switch (metadata.mimeType) {
+      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: []
+        });
+    }
+  }
+  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/dist/esm/pmtiles-source.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pmtiles-source.js","names":["DataSource","resolvePath","ImageLoader","MVTLoader","PMTiles","parsePMTilesHeader","BlobSource","constructor","blob","key","_defineProperty","getKey","url","getBytes","offset","length","signal","slice","data","arrayBuffer","PMTilesSource","props","pmtiles","getTileData","bind","metadata","getMetadata","pmtilesHeader","getHeader","pmtilesMetadata","attributions","getTile","tileParams","x","y","zoom","z","rangeResponse","getZxy","index","mimeType","getVectorTile","layers","getImageTile","parse","loadOptions","_this$loadOptions","shape","mvt","coordinates","tileIndex"],"sources":["../../src/pmtiles-source.ts"],"sourcesContent":["// loaders.gl, MIT license\n\nimport type {GetTileParameters, 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} from '@loaders.gl/images';\nimport {MVTLoader, MVTLoaderOptions} from '@loaders.gl/mvt';\n\nimport {PMTiles, Source, RangeResponse} from 'pmtiles';\n\nimport type {PMTilesMetadata} from './lib/parse-pmtiles';\nimport {parsePMTilesHeader} from './lib/parse-pmtiles';\nimport {TileLoadParameters} from 'modules/loader-utils/src/lib/sources/tile-source';\n\n// export const PMTilesService: Service = {\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// };\n\n/**\n * WIP - Loader for pmtiles metadata\n * @note loads metadata only. To load individual tiles, use PMTilesSource\nexport const PMTilesLoader: LoaderWithParser<PMTilesMetadata, never, PMTilesLoaderOptions> = {\n  name: 'PMTiles',\n  id: 'pmtiles',\n  module: 'pmtiles',\n  version: VERSION,\n  worker: true,\n  extensions: ['pmtiles'],\n  mimeTypes: ['application/octet-stream'],\n  options: {\n    pmtiles: {}\n  },\n  parse: async (arrayBuffer, options) => {\n    throw new Error('not implemented');\n  }\n};\n */\n\nexport type PMTilesSourceProps = DataSourceProps & {\n  url: string | Blob;\n  attributions?: string[];\n};\n\nexport class BlobSource implements 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(offset: number, length: number, signal?: AbortSignal): Promise<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/**\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  props: PMTilesSourceProps;\n  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.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 = parsePMTilesHeader(pmtilesHeader, pmtilesMetadata);\n    if (this.props.attributions) {\n      metadata.attributions = [...this.props.attributions, ...(metadata.attributions || [])];\n    }\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.mimeType) {\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":";AAIA,SAAQA,UAAU,EAAEC,WAAW,QAAO,0BAA0B;AAChE,SAAQC,WAAW,QAAO,oBAAoB;AAC9C,SAAQC,SAAS,QAAyB,iBAAiB;AAE3D,SAAQC,OAAO,QAA8B,SAAS;AAGtD,SAAQC,kBAAkB,QAAO,qBAAqB;AAwCtD,OAAO,MAAMC,UAAU,CAAmB;EAIxCC,WAAWA,CAACC,IAAU,EAAEC,GAAW,EAAE;IAAAC,eAAA;IAAAA,eAAA;IACnC,IAAI,CAACF,IAAI,GAAGA,IAAI;IAChB,IAAI,CAACC,GAAG,GAAGA,GAAG;EAChB;EAGAE,MAAMA,CAAA,EAAG;IAEP,OAAO,IAAI,CAACH,IAAI,CAACI,GAAG,IAAI,EAAE;EAC5B;EAEA,MAAMC,QAAQA,CAACC,MAAc,EAAEC,MAAc,EAAEC,MAAoB,EAA0B;IAC3F,MAAMC,KAAK,GAAG,IAAI,CAACT,IAAI,CAACS,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;AAKA,OAAO,MAAME,aAAa,SAASpB,UAAU,CAA8C;EAKzFO,WAAWA,CAACc,KAAyB,EAAE;IACrC,KAAK,CAACA,KAAK,CAAC;IAACX,eAAA;IAAAA,eAAA;IAAAA,eAAA;IACb,IAAI,CAACW,KAAK,GAAGA,KAAK;IAClB,MAAMT,GAAG,GACP,OAAOS,KAAK,CAACT,GAAG,KAAK,QAAQ,GAAGX,WAAW,CAACoB,KAAK,CAACT,GAAG,CAAC,GAAG,IAAIN,UAAU,CAACe,KAAK,CAACT,GAAG,EAAE,SAAS,CAAC;IAC/F,IAAI,CAACU,OAAO,GAAG,IAAIlB,OAAO,CAACQ,GAAG,CAAC;IAC/B,IAAI,CAACW,WAAW,GAAG,IAAI,CAACA,WAAW,CAACC,IAAI,CAAC,IAAI,CAAC;IAC9C,IAAI,CAACC,QAAQ,GAAG,IAAI,CAACC,WAAW,CAAC,CAAC;EACpC;EAEA,MAAMA,WAAWA,CAAA,EAA6B;IAC5C,MAAMC,aAAa,GAAG,MAAM,IAAI,CAACL,OAAO,CAACM,SAAS,CAAC,CAAC;IACpD,MAAMC,eAAe,GAAG,MAAM,IAAI,CAACP,OAAO,CAACI,WAAW,CAAC,CAAC;IACxD,MAAMD,QAAQ,GAAGpB,kBAAkB,CAACsB,aAAa,EAAEE,eAAe,CAAC;IACnE,IAAI,IAAI,CAACR,KAAK,CAACS,YAAY,EAAE;MAC3BL,QAAQ,CAACK,YAAY,GAAG,CAAC,GAAG,IAAI,CAACT,KAAK,CAACS,YAAY,EAAE,IAAIL,QAAQ,CAACK,YAAY,IAAI,EAAE,CAAC,CAAC;IACxF;IACA,OAAOL,QAAQ;EACjB;EAEA,MAAMM,OAAOA,CAACC,UAA6B,EAA+B;IACxE,MAAM;MAACC,CAAC;MAAEC,CAAC;MAAEC,IAAI,EAAEC;IAAC,CAAC,GAAGJ,UAAU;IAClC,MAAMK,aAAa,GAAG,MAAM,IAAI,CAACf,OAAO,CAACgB,MAAM,CAACF,CAAC,EAAEH,CAAC,EAAEC,CAAC,CAAC;IACxD,MAAMf,WAAW,GAAGkB,aAAa,aAAbA,aAAa,uBAAbA,aAAa,CAAEnB,IAAI;IACvC,IAAI,CAACC,WAAW,EAAE;MAEhB,OAAO,IAAI;IACb;IACA,OAAOA,WAAW;EACpB;EAKA,MAAMI,WAAWA,CAACS,UAA8B,EAA2B;IACzE,MAAM;MAACC,CAAC;MAAEC,CAAC;MAAEE;IAAC,CAAC,GAAGJ,UAAU,CAACO,KAAK;IAClC,MAAMd,QAAQ,GAAG,MAAM,IAAI,CAACA,QAAQ;IACpC,QAAQA,QAAQ,CAACe,QAAQ;MACvB,KAAK,oCAAoC;QACvC,OAAO,MAAM,IAAI,CAACC,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,MAAMb,WAAW,GAAG,MAAM,IAAI,CAACY,OAAO,CAACC,UAAU,CAAC;IAClD,OAAOb,WAAW,GAAG,MAAMjB,WAAW,CAAC0C,KAAK,CAACzB,WAAW,EAAE,IAAI,CAAC0B,WAAW,CAAC,GAAG,IAAI;EACpF;EAIA,MAAMJ,aAAaA,CAACT,UAA6B,EAA2B;IAAA,IAAAc,iBAAA;IAC1E,MAAM3B,WAAW,GAAG,MAAM,IAAI,CAACY,OAAO,CAACC,UAAU,CAAC;IAClD,MAAMa,WAA6B,GAAG;MACpCE,KAAK,EAAE,eAAe;MACtBC,GAAG,EAAE;QACHC,WAAW,EAAE,OAAO;QACpBC,SAAS,EAAE;UAACjB,CAAC,EAAED,UAAU,CAACC,CAAC;UAAEC,CAAC,EAAEF,UAAU,CAACE,CAAC;UAAEE,CAAC,EAAEJ,UAAU,CAACG;QAAI,CAAC;QACjE,KAAAW,iBAAA,GAAI,IAAI,CAACD,WAAW,cAAAC,iBAAA,uBAAjBA,iBAAA,CAAwCE,GAAG;MAChD,CAAC;MACD,GAAG,IAAI,CAACH;IACV,CAAC;IAED,OAAO1B,WAAW,GAAG,MAAMhB,SAAS,CAACyC,KAAK,CAACzB,WAAW,EAAE0B,WAAW,CAAC,GAAG,IAAI;EAC7E;AACF"}

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+export type { PMTilesMetadata } from './lib/parse-pmtiles';
+export type { PMTilesSourceProps } from './pmtiles-source';
+export { PMTilesSource } from './pmtiles-source';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAEA,YAAY,EAAC,eAAe,EAAC,MAAM,qBAAqB,CAAC;AACzD,YAAY,EAAC,kBAAkB,EAAC,MAAM,kBAAkB,CAAC;AACzD,OAAO,EAAC,aAAa,EAAC,MAAM,kBAAkB,CAAC"}

package/dist/lib/parse-pmtiles.d.ts

@@ -0,0 +1,42 @@
+import { Source, Header, TileType } from 'pmtiles';
+import type { TileJSON } from '@loaders.gl/mvt';
+/** Metadata describing a PMTiles file */
+export type PMTilesMetadata = {
+    /** Name of the tileset (extracted from JSON metadata if available) */
+    name?: string;
+    /** Attribution string (extracted from JSON metadata if available) */
+    attributions?: string[];
+    format: 'pmtiles';
+    /** Version of pm tiles format used by this tileset */
+    formatVersion: number;
+    /** PMTiles format specific header */
+    formatHeader?: Header;
+    /** MIME type for tile contents. Unknown tile types will return 'application/octet-stream */
+    mimeType: 'application/vnd.mapbox-vector-tile' | 'image/png' | 'image/jpeg' | 'image/webp' | 'image/avif' | 'application/octet-stream';
+    /** The original numeric tile type constant specified in the PMTiles tileset */
+    tileType: TileType;
+    /** Minimal zoom level of tiles in this tileset */
+    minZoom: number;
+    /** Maximal zoom level of tiles in this tileset */
+    maxZoom: number;
+    /** Bounding box of tiles in this tileset `[[w, s], [e, n]]`  */
+    boundingBox: [min: [x: number, y: number], max: [x: number, y: number]];
+    /** Center long, lat of this tileset */
+    center: [number, number];
+    /** Center zoom level of this tileset */
+    centerZoom: number;
+    /** Cache tag */
+    etag?: string;
+    tileJSON?: TileJSON;
+    /** Current assumption is that this is a tileJSON style metadata generated by e.g. tippecanoe */
+    tilejsonMetadata?: Record<string, unknown>;
+};
+export type ParsePMTilesOptions = {
+    tileZxy?: [number, number, number];
+};
+export declare function loadPMTilesHeader(source: Source): Promise<PMTilesMetadata>;
+export declare function loadPMTile(source: Source, options: ParsePMTilesOptions): Promise<ArrayBuffer | undefined>;
+export declare function parsePMTilesHeader(header: Header, tilejsonMetadata: Record<string, unknown> | null, options?: {
+    includeFormatHeader?: boolean;
+}): PMTilesMetadata;
+//# sourceMappingURL=parse-pmtiles.d.ts.map

package/dist/lib/parse-pmtiles.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"parse-pmtiles.d.ts","sourceRoot":"","sources":["../../src/lib/parse-pmtiles.ts"],"names":[],"mappings":"AAEA,OAAO,EAAC,MAAM,EAAW,MAAM,EAAE,QAAQ,EAAC,MAAM,SAAS,CAAC;AAC1D,OAAO,KAAK,EAAC,QAAQ,EAAC,MAAM,iBAAiB,CAAC;AAG9C,yCAAyC;AACzC,MAAM,MAAM,eAAe,GAAG;IAC5B,sEAAsE;IACtE,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,qEAAqE;IACrE,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;IAExB,MAAM,EAAE,SAAS,CAAC;IAClB,sDAAsD;IACtD,aAAa,EAAE,MAAM,CAAC;IACtB,qCAAqC;IACrC,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,4FAA4F;IAC5F,QAAQ,EACJ,oCAAoC,GACpC,WAAW,GACX,YAAY,GACZ,YAAY,GACZ,YAAY,GACZ,0BAA0B,CAAC;IAC/B,+EAA+E;IAC/E,QAAQ,EAAE,QAAQ,CAAC;IACnB,kDAAkD;IAClD,OAAO,EAAE,MAAM,CAAC;IAChB,kDAAkD;IAClD,OAAO,EAAE,MAAM,CAAC;IAChB,gEAAgE;IAChE,WAAW,EAAE,CAAC,GAAG,EAAE,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC;IACxE,uCAAuC;IACvC,MAAM,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACzB,wCAAwC;IACxC,UAAU,EAAE,MAAM,CAAC;IACnB,gBAAgB;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,gGAAgG;IAChG,gBAAgB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAC5C,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAChC,OAAO,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;CACpC,CAAC;AAEF,wBAAsB,iBAAiB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC,CAShF;AAED,wBAAsB,UAAU,CAC9B,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,mBAAmB,GAC3B,OAAO,CAAC,WAAW,GAAG,SAAS,CAAC,CAQlC;AAED,wBAAgB,kBAAkB,CAChC,MAAM,EAAE,MAAM,EACd,gBAAgB,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,EAChD,OAAO,CAAC,EAAE;IAAC,mBAAmB,CAAC,EAAE,OAAO,CAAA;CAAC,GACxC,eAAe,CA2CjB"}

package/dist/lib/sources.d.ts

@@ -0,0 +1 @@
+//# sourceMappingURL=sources.d.ts.map

package/dist/lib/sources.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sources.d.ts","sourceRoot":"","sources":["../../src/lib/sources.ts"],"names":[],"mappings":""}

package/dist/pmtiles-source.d.ts

@@ -0,0 +1,52 @@
+import type { GetTileParameters, ImageType, DataSourceProps } from '@loaders.gl/loader-utils';
+import type { ImageTileSource, VectorTileSource } from '@loaders.gl/loader-utils';
+import { DataSource } from '@loaders.gl/loader-utils';
+import { PMTiles, Source, RangeResponse } from 'pmtiles';
+import type { PMTilesMetadata } from './lib/parse-pmtiles';
+import { TileLoadParameters } from 'modules/loader-utils/src/lib/sources/tile-source';
+/**
+ * WIP - Loader for pmtiles metadata
+ * @note loads metadata only. To load individual tiles, use PMTilesSource
+export const PMTilesLoader: LoaderWithParser<PMTilesMetadata, never, PMTilesLoaderOptions> = {
+  name: 'PMTiles',
+  id: 'pmtiles',
+  module: 'pmtiles',
+  version: VERSION,
+  worker: true,
+  extensions: ['pmtiles'],
+  mimeTypes: ['application/octet-stream'],
+  options: {
+    pmtiles: {}
+  },
+  parse: async (arrayBuffer, options) => {
+    throw new Error('not implemented');
+  }
+};
+ */
+export type PMTilesSourceProps = DataSourceProps & {
+    url: string | Blob;
+    attributions?: string[];
+};
+export declare class BlobSource implements Source {
+    blob: Blob;
+    key: string;
+    constructor(blob: Blob, key: string);
+    getKey(): any;
+    getBytes(offset: number, length: number, signal?: AbortSignal): Promise<RangeResponse>;
+}
+/**
+ * A PMTiles data source
+ * @note Can be either a raster or vector tile source depending on the contents of the PMTiles file.
+ */
+export declare class PMTilesSource extends DataSource implements ImageTileSource, VectorTileSource {
+    props: PMTilesSourceProps;
+    pmtiles: PMTiles;
+    metadata: Promise<PMTilesMetadata>;
+    constructor(props: PMTilesSourceProps);
+    getMetadata(): Promise<PMTilesMetadata>;
+    getTile(tileParams: GetTileParameters): Promise<ArrayBuffer | null>;
+    getTileData(tileParams: TileLoadParameters): Promise<unknown | null>;
+    getImageTile(tileParams: GetTileParameters): Promise<ImageType | null>;
+    getVectorTile(tileParams: GetTileParameters): Promise<unknown | null>;
+}
+//# sourceMappingURL=pmtiles-source.d.ts.map

package/dist/pmtiles-source.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pmtiles-source.d.ts","sourceRoot":"","sources":["../src/pmtiles-source.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAC,iBAAiB,EAAE,SAAS,EAAE,eAAe,EAAC,MAAM,0BAA0B,CAAC;AAC5F,OAAO,KAAK,EAAC,eAAe,EAAE,gBAAgB,EAAC,MAAM,0BAA0B,CAAC;AAChF,OAAO,EAAC,UAAU,EAAc,MAAM,0BAA0B,CAAC;AAIjE,OAAO,EAAC,OAAO,EAAE,MAAM,EAAE,aAAa,EAAC,MAAM,SAAS,CAAC;AAEvD,OAAO,KAAK,EAAC,eAAe,EAAC,MAAM,qBAAqB,CAAC;AAEzD,OAAO,EAAC,kBAAkB,EAAC,MAAM,kDAAkD,CAAC;AAcpF;;;;;;;;;;;;;;;;;;GAkBG;AAEH,MAAM,MAAM,kBAAkB,GAAG,eAAe,GAAG;IACjD,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;IACnB,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;CACzB,CAAC;AAEF,qBAAa,UAAW,YAAW,MAAM;IACvC,IAAI,EAAE,IAAI,CAAC;IACX,GAAG,EAAE,MAAM,CAAC;gBAEA,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,MAAM;IAMnC,MAAM;IAKA,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,aAAa,CAAC;CAU7F;AACD;;;GAGG;AACH,qBAAa,aAAc,SAAQ,UAAW,YAAW,eAAe,EAAE,gBAAgB;IACxF,KAAK,EAAE,kBAAkB,CAAC;IAC1B,OAAO,EAAE,OAAO,CAAC;IACjB,QAAQ,EAAE,OAAO,CAAC,eAAe,CAAC,CAAC;gBAEvB,KAAK,EAAE,kBAAkB;IAU/B,WAAW,IAAI,OAAO,CAAC,eAAe,CAAC;IAUvC,OAAO,CAAC,UAAU,EAAE,iBAAiB,GAAG,OAAO,CAAC,WAAW,GAAG,IAAI,CAAC;IAcnE,WAAW,CAAC,UAAU,EAAE,kBAAkB,GAAG,OAAO,CAAC,OAAO,GAAG,IAAI,CAAC;IAapE,YAAY,CAAC,UAAU,EAAE,iBAAiB,GAAG,OAAO,CAAC,SAAS,GAAG,IAAI,CAAC;IAOtE,aAAa,CAAC,UAAU,EAAE,iBAAiB,GAAG,OAAO,CAAC,OAAO,GAAG,IAAI,CAAC;CAc5E"}

package/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "@loaders.gl/pmtiles",
+  "version": "4.0.0-beta.1",
+  "description": "Framework-independent loader for the pmtiles format",
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/visgl/loaders.gl"
+  },
+  "keywords": [
+    "webgl",
+    "loader",
+    "3d",
+    "mesh",
+    "point cloud",
+    "PCD"
+  ],
+  "types": "dist/index.d.ts",
+  "main": "dist/es5/index.js",
+  "module": "dist/esm/index.js",
+  "sideEffects": false,
+  "files": [
+    "src",
+    "dist",
+    "README.md"
+  ],
+  "scripts": {
+    "pre-build": "npm run build-bundle",
+    "build-bundle": "esbuild src/bundle.ts --bundle --outfile=dist/dist.min.js"
+  },
+  "dependencies": {
+    "@loaders.gl/images": "4.0.0-beta.1",
+    "@loaders.gl/loader-utils": "4.0.0-beta.1",
+    "@loaders.gl/mvt": "4.0.0-beta.1",
+    "@loaders.gl/schema": "4.0.0-beta.1",
+    "pmtiles": "^2.7.2"
+  },
+  "gitHead": "35c625e67132b0784e597d9ddabae8aefea29ff2"
+}

package/src/bundle.ts

@@ -0,0 +1,4 @@
+// @ts-nocheck
+const moduleExports = require('./index');
+globalThis.loaders = globalThis.loaders || {};
+module.exports = Object.assign(globalThis.loaders, moduleExports);

package/src/index.ts

@@ -0,0 +1,5 @@
+// loaders.gl, MIT license
+
+export type {PMTilesMetadata} from './lib/parse-pmtiles';
+export type {PMTilesSourceProps} from './pmtiles-source';
+export {PMTilesSource} from './pmtiles-source';

package/src/lib/parse-pmtiles.ts

@@ -0,0 +1,147 @@
+// loaders.gl, MIT license
+
+import {Source, PMTiles, Header, TileType} from 'pmtiles';
+import type {TileJSON} from '@loaders.gl/mvt';
+import {TileJSONLoader} from '@loaders.gl/mvt';
+
+/** Metadata describing a PMTiles file */
+export type PMTilesMetadata = {
+  /** Name of the tileset (extracted from JSON metadata if available) */
+  name?: string;
+  /** Attribution string (extracted from JSON metadata if available) */
+  attributions?: string[];
+
+  format: 'pmtiles';
+  /** Version of pm tiles format used by this tileset */
+  formatVersion: number;
+  /** PMTiles format specific header */
+  formatHeader?: Header;
+  /** MIME type for tile contents. Unknown tile types will return 'application/octet-stream */
+  mimeType:
+    | 'application/vnd.mapbox-vector-tile'
+    | 'image/png'
+    | 'image/jpeg'
+    | 'image/webp'
+    | 'image/avif'
+    | 'application/octet-stream';
+  /** The original numeric tile type constant specified in the PMTiles tileset */
+  tileType: TileType;
+  /** Minimal zoom level of tiles in this tileset */
+  minZoom: number;
+  /** Maximal zoom level of tiles in this tileset */
+  maxZoom: number;
+  /** Bounding box of tiles in this tileset `[[w, s], [e, n]]`  */
+  boundingBox: [min: [x: number, y: number], max: [x: number, y: number]];
+  /** Center long, lat of this tileset */
+  center: [number, number];
+  /** Center zoom level of this tileset */
+  centerZoom: number;
+  /** Cache tag */
+  etag?: string;
+  tileJSON?: TileJSON;
+  /** Current assumption is that this is a tileJSON style metadata generated by e.g. tippecanoe */
+  tilejsonMetadata?: Record<string, unknown>;
+};
+
+export type ParsePMTilesOptions = {
+  tileZxy?: [number, number, number];
+};
+
+export async function loadPMTilesHeader(source: Source): Promise<PMTilesMetadata> {
+  const pmTiles = new PMTiles(source);
+  const header = await pmTiles.getHeader();
+  const metadata = await pmTiles.getMetadata();
+  const tilejsonMetadata =
+    metadata && typeof metadata === 'object' && !Array.isArray(metadata)
+      ? (metadata as Record<string, unknown>)
+      : null;
+  return parsePMTilesHeader(header, tilejsonMetadata);
+}
+
+export async function loadPMTile(
+  source: Source,
+  options: ParsePMTilesOptions
+): Promise<ArrayBuffer | undefined> {
+  const pmTiles = new PMTiles(source);
+  if (!options.tileZxy) {
+    throw new Error('tile zxy missing');
+  }
+  const [z, x, y] = options.tileZxy;
+  const tile = await pmTiles.getZxy(z, x, y);
+  return tile?.data;
+}
+
+export function parsePMTilesHeader(
+  header: Header,
+  tilejsonMetadata: Record<string, unknown> | null,
+  options?: {includeFormatHeader?: boolean}
+): PMTilesMetadata {
+  const partialMetadata: Partial<PMTilesMetadata> = {};
+
+  if (typeof tilejsonMetadata?.name === 'string') {
+    partialMetadata.name = tilejsonMetadata.name;
+  }
+
+  if (typeof tilejsonMetadata?.attribution === 'string') {
+    partialMetadata.attributions = [tilejsonMetadata.attribution];
+  }
+
+  const metadata: PMTilesMetadata = {
+    ...partialMetadata,
+    format: 'pmtiles',
+    formatVersion: header.specVersion,
+    mimeType: decodeTileType(header.tileType),
+    tileType: header.tileType,
+    minZoom: header.minZoom,
+    maxZoom: header.maxZoom,
+    boundingBox: [
+      [header.minLon, header.minLat],
+      [header.maxLon, header.maxLat]
+    ],
+    center: [header.centerLon, header.centerLat],
+    centerZoom: header.centerZoom,
+    etag: header.etag
+  };
+
+  if (tilejsonMetadata) {
+    try {
+      metadata.tileJSON =
+        TileJSONLoader.parseTextSync?.(JSON.stringify(tilejsonMetadata)) || undefined;
+    } catch (error) {
+      // console.warn('PMTiles invalid tilejson metadata', error);
+      metadata.tilejsonMetadata = tilejsonMetadata;
+    }
+  }
+
+  if (options?.includeFormatHeader) {
+    metadata.formatHeader = header;
+  }
+
+  return metadata;
+}
+
+/** Extract a MIME type for tiles from vector tile header  */
+function decodeTileType(
+  tileType: TileType
+):
+  | 'application/vnd.mapbox-vector-tile'
+  | 'image/png'
+  | 'image/jpeg'
+  | 'image/webp'
+  | 'image/avif'
+  | 'application/octet-stream' {
+  switch (tileType) {
+    case TileType.Mvt:
+      return 'application/vnd.mapbox-vector-tile';
+    case TileType.Png:
+      return 'image/png';
+    case TileType.Jpeg:
+      return 'image/jpeg';
+    case TileType.Webp:
+      return 'image/webp';
+    case TileType.Avif:
+      return 'image/avif';
+    default:
+      return 'application/octet-stream';
+  }
+}

package/src/lib/sources.ts

@@ -0,0 +1,150 @@
+/*
+import {fetchFile} from '@loaders.gl/core';
+
+import {Source as PMTilesSource, RangeResponse} from 'pmtiles';
+
+/** @note "source" here is a PMTiles library type, referring to  *
+export function makeSource(data: string | Blob, fetch?) {
+  if (typeof data === 'string') {
+    return new FetchSource(data, fetch);
+  }
+  if (data instanceof Blob) {
+    const url = '';
+    return new BlobSource(data, url);
+  }
+}
+
+export class BlobSource implements PMTilesSource {
+  blob: Blob;
+  key: string;
+
+  constructor(blob: Blob, key: string) {
+    this.blob = blob;
+    this.key = key;
+  }
+
+  // TODO - how is this used?
+  getKey() {
+    return this.blob.url || '';
+  }
+
+  async getBytes(offset: number, length: number, signal?: AbortSignal): Promise<RangeResponse> {
+    const data = await this.blob.arrayBuffer();
+    return {
+      data
+      // etag: response.headers.get('ETag') || undefined,
+      // cacheControl: response.headers.get('Cache-Control') || undefined,
+      // expires: response.headers.get('Expires') || undefined
+    };
+  }
+}
+
+export class FetchSource implements PMTilesSource {
+  url: string;
+  fetch;
+
+  constructor(url: string, fetch = fetchFile) {
+    this.url = url;
+    this.fetch = fetch;
+  }
+
+  // TODO - how is this used?
+  getKey() {
+    return this.url;
+  }
+
+  async getBytes(offset: number, length: number, signal?: AbortSignal): Promise<RangeResponse> {
+    let controller;
+    if (!signal) {
+      // ToDO why is it so important to abort in case 200?
+      // TODO check this works or assert 206
+      controller = new AbortController();
+      signal = controller.signal;
+    }
+
+    let response = await fetch(this.url, {
+      signal,
+      headers: {Range: `bytes=${offset}-${offset + length - 1}`}
+    });
+
+    switch (response.status) {
+      case 206: // Partial Content success
+        // This is the expected success code for a range request
+        break;
+
+      case 200:
+        // some well-behaved backends, e.g. DigitalOcean CDN, respond with 200 instead of 206
+        // but we also need to detect no support for Byte Serving which is returning the whole file
+        const content_length = response.headers.get('Content-Length');
+        if (!content_length || Number(content_length) > length) {
+          if (controller) {
+            controller.abort();
+          }
+          throw Error(
+            'content-length header missing or exceeding request. Server must support HTTP Byte Serving.'
+          );
+        }
+
+      case 416: // "Range Not Satisfiable"
+        // some HTTP servers don't accept ranges beyond the end of the resource.
+        // Retry with the exact length
+        // TODO: can return 416 with offset > 0 if content changed, which will have a blank etag.
+        // See https://github.com/protomaps/PMTiles/issues/90
+        if (offset === 0) {
+          const content_range = response.headers.get('Content-Range');
+          if (!content_range || !content_range.startsWith('bytes *')) {
+            throw Error('Missing content-length on 416 response');
+          }
+          const actual_length = Number(content_range.substr(8));
+          response = await fetch(this.url, {
+            signal,
+            headers: {Range: `bytes=0-${actual_length - 1}`}
+          });
+        }
+        break;
+
+      default:
+        if (response.status >= 300) {
+          throw Error(`Bad response code: ${response.status}`);
+        }
+    }
+
+    const data = await response.arrayBuffer();
+    return {
+      data,
+      etag: response.headers.get('ETag') || undefined,
+      cacheControl: response.headers.get('Cache-Control') || undefined,
+      expires: response.headers.get('Expires') || undefined
+    };
+  }
+}
+
+/*
+class TestNodeFileSource implements Source {
+  buffer: ArrayBuffer;
+  path: string;
+  key: string;
+  etag?: string;
+
+  constructor(path: string, key: string) {
+    this.path = path;
+    this.buffer = fs.readFileSync(path);
+    this.key = key;
+  }
+
+  getKey() {
+    return this.key;
+  }
+
+  replaceData(path: string) {
+    this.path = path;
+    this.buffer = fs.readFileSync(path);
+  }
+
+  async getBytes(offset: number, length: number): Promise<RangeResponse> {
+    const slice = new Uint8Array(this.buffer.slice(offset, offset + length))
+      .buffer;
+    return { data: slice, etag: this.etag };
+  }
+}
+*/