@loaders.gl/pmtiles 4.3.0-alpha.2 → 4.3.0-alpha.4

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAIA,YAAY,EAAC,eAAe,EAAC,+BAA4B;AACzD,YAAY,EAAC,kBAAkB,EAAC,4BAAyB;AACzD,OAAO,EAAC,aAAa,EAAC,4BAAyB"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAIA,OAAO,EAAC,aAAa,EAAC,4BAAyB;AAE/C,YAAY,EAAC,eAAe,EAAC,+BAA4B;AACzD,YAAY,EAAC,sBAAsB,EAAC,4BAAyB;AAC7D,OAAO,EAAC,iBAAiB,EAAC,4BAAyB;AAEnD,OAAO,EAAC,aAAa,IAAI,cAAc,EAAC,4BAAyB;AACjE,YAAY,EAAC,oBAAoB,EAAC,4BAAyB"}

package/dist/index.js

@@ -2,3 +2,5 @@
 // SPDX-License-Identifier: MIT
 // Copyright (c) vis.gl contributors
 export { PMTilesSource } from "./pmtiles-source.js";
+export { PMTilesTileSource } from "./pmtiles-source.js";
+export { PMTilesLoader as _PMTilesLoader } from "./pmtiles-loader.js";

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

@@ -1,4 +1,4 @@
-import type { LoaderOptions } from '@loaders.gl/loader-utils';
+import { LoaderOptions } from '@loaders.gl/loader-utils';
 import type { TileJSON } from '@loaders.gl/mvt';
 import * as pmtiles from 'pmtiles';
 /** Metadata describing a PMTiles file */
@@ -39,7 +39,7 @@ export type PMTilesMetadata = {
  * @param loadOptions
  * @returns
  */
-export declare function parsePMTilesHeader(header: pmtiles.Header, pmmetadata: unknown, options?: {
+export declare function parsePMTilesHeader(header: pmtiles.Header, pmtilesMetadata: Record<string, unknown> | null, options?: {
     includeFormatHeader?: boolean;
 }, loadOptions?: LoaderOptions): PMTilesMetadata;
 //# sourceMappingURL=parse-pmtiles.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"parse-pmtiles.d.ts","sourceRoot":"","sources":["../../src/lib/parse-pmtiles.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAC,aAAa,EAAC,MAAM,0BAA0B,CAAC;AAC5D,OAAO,KAAK,EAAC,QAAQ,EAAC,MAAM,iBAAiB,CAAC;AAG9C,OAAO,KAAK,OAAO,MAAM,SAAS,CAAC;AAGnC,yCAAyC;AACzC,MAAM,MAAM,eAAe,GAAG;IAC5B,MAAM,EAAE,SAAS,CAAC;IAClB,sDAAsD;IACtD,aAAa,EAAE,MAAM,CAAC;IAEtB,4FAA4F;IAC5F,YAAY,EACR,oCAAoC,GACpC,WAAW,GACX,YAAY,GACZ,YAAY,GACZ,YAAY,GACZ,0BAA0B,CAAC;IAE/B,sEAAsE;IACtE,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,qEAAqE;IACrE,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;IAExB,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;IAEd,qDAAqD;IACrD,QAAQ,CAAC,EAAE,QAAQ,CAAC;IAEpB,iDAAiD;IACjD,YAAY,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC;IAC9B,2GAA2G;IAC3G,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAC1C,CAAC;AAEF;;;;;;;GAOG;AACH,wBAAgB,kBAAkB,CAChC,MAAM,EAAE,OAAO,CAAC,MAAM,EACtB,UAAU,EAAE,OAAO,EACnB,OAAO,CAAC,EAAE;IAAC,mBAAmB,CAAC,EAAE,OAAO,CAAA;CAAC,EACzC,WAAW,CAAC,EAAE,aAAa,GAC1B,eAAe,CAuDjB"}
+{"version":3,"file":"parse-pmtiles.d.ts","sourceRoot":"","sources":["../../src/lib/parse-pmtiles.ts"],"names":[],"mappings":"AAIA,OAAO,EAAC,aAAa,EAAC,MAAM,0BAA0B,CAAC;AACvD,OAAO,KAAK,EAAC,QAAQ,EAAC,MAAM,iBAAiB,CAAC;AAG9C,OAAO,KAAK,OAAO,MAAM,SAAS,CAAC;AAGnC,yCAAyC;AACzC,MAAM,MAAM,eAAe,GAAG;IAC5B,MAAM,EAAE,SAAS,CAAC;IAClB,sDAAsD;IACtD,aAAa,EAAE,MAAM,CAAC;IAEtB,4FAA4F;IAC5F,YAAY,EACR,oCAAoC,GACpC,WAAW,GACX,YAAY,GACZ,YAAY,GACZ,YAAY,GACZ,0BAA0B,CAAC;IAE/B,sEAAsE;IACtE,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,qEAAqE;IACrE,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;IAExB,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;IAEd,qDAAqD;IACrD,QAAQ,CAAC,EAAE,QAAQ,CAAC;IAEpB,iDAAiD;IACjD,YAAY,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC;IAC9B,2GAA2G;IAC3G,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAC1C,CAAC;AAEF;;;;;;;GAOG;AACH,wBAAgB,kBAAkB,CAChC,MAAM,EAAE,OAAO,CAAC,MAAM,EACtB,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,EAC/C,OAAO,CAAC,EAAE;IAAC,mBAAmB,CAAC,EAAE,OAAO,CAAA;CAAC,EACzC,WAAW,CAAC,EAAE,aAAa,GAC1B,eAAe,CAqDjB"}

package/dist/lib/parse-pmtiles.js

@@ -13,8 +13,7 @@ const { TileType } = pmtiles;
  * @param loadOptions
  * @returns
  */
-export function parsePMTilesHeader(header, pmmetadata, options, loadOptions) {
-    const pmtilesMetadata = pmmetadata;
+export function parsePMTilesHeader(header, pmtilesMetadata, options, loadOptions) {
     // 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/lib/version.d.ts

@@ -0,0 +1,2 @@
+export declare const VERSION: any;
+//# sourceMappingURL=version.d.ts.map

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

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

package/dist/lib/version.js

@@ -0,0 +1,7 @@
+// loaders.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
+// Version constant cannot be imported, it needs to correspond to the build version of **this** module.
+// __VERSION__ is injected by babel-plugin-version-inline
+// @ts-ignore TS2304: Cannot find name '__VERSION__'.
+export const VERSION = typeof "4.3.0-alpha.3" !== 'undefined' ? "4.3.0-alpha.3" : 'latest';

package/dist/pmtiles-loader.d.ts

@@ -0,0 +1,28 @@
+import type { LoaderOptions, ReadableFile } from '@loaders.gl/loader-utils';
+import { VectorSourceInfo, ImageSourceInfo } from "./source-info.js";
+import { PMTilesTileSourceProps } from "./pmtiles-source.js";
+export type PMTilesLoaderOptions = LoaderOptions & {
+    pmtiles?: PMTilesTileSourceProps['pmtiles'];
+};
+/**
+ * Loader for PMTiles metadata
+ * @note This loader is intended to allow PMTiles to be treated like other file types in top-level loading logic.
+ * @note For actual access to the tile data, use the PMTilesSource class.
+ */
+export declare const PMTilesLoader: {
+    readonly name: "PMTiles";
+    readonly id: "pmtiles";
+    readonly module: "pmtiles";
+    readonly version: any;
+    readonly extensions: ["pmtiles"];
+    readonly mimeTypes: ["application/octet-stream"];
+    readonly tests: ["PMTiles"];
+    readonly options: {
+        readonly pmtiles: {};
+    };
+    readonly parse: (arrayBuffer: ArrayBuffer, options?: PMTilesLoaderOptions) => Promise<VectorSourceInfo | ImageSourceInfo>;
+    readonly parseFile: typeof parseFileAsPMTiles;
+};
+declare function parseFileAsPMTiles(file: ReadableFile, options?: PMTilesLoaderOptions): Promise<VectorSourceInfo | ImageSourceInfo>;
+export {};
+//# sourceMappingURL=pmtiles-loader.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"pmtiles-loader.d.ts","sourceRoot":"","sources":["../src/pmtiles-loader.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAmB,aAAa,EAAE,YAAY,EAAC,MAAM,0BAA0B,CAAC;AAI5F,OAAO,EAAC,gBAAgB,EAAE,eAAe,EAAC,yBAAsB;AAChE,OAAO,EAAoB,sBAAsB,EAAC,4BAAyB;AAE3E,MAAM,MAAM,oBAAoB,GAAG,aAAa,GAAG;IACjD,OAAO,CAAC,EAAE,sBAAsB,CAAC,SAAS,CAAC,CAAC;CAC7C,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,aAAa;;;;;;;;;;;kCAWG,WAAW,YAAY,oBAAoB;;CAOvE,CAAC;AAEF,iBAAe,kBAAkB,CAC/B,IAAI,EAAE,YAAY,EAClB,OAAO,CAAC,EAAE,oBAAoB,GAC7B,OAAO,CAAC,gBAAgB,GAAG,eAAe,CAAC,CAqB7C"}

package/dist/pmtiles-loader.js

@@ -0,0 +1,47 @@
+// loaders.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
+import { BlobFile } from '@loaders.gl/loader-utils';
+import { VERSION } from "./lib/version.js";
+import { PMTilesTileSource } from "./pmtiles-source.js";
+/**
+ * Loader for PMTiles metadata
+ * @note This loader is intended to allow PMTiles to be treated like other file types in top-level loading logic.
+ * @note For actual access to the tile data, use the PMTilesSource class.
+ */
+export const PMTilesLoader = {
+    name: 'PMTiles',
+    id: 'pmtiles',
+    module: 'pmtiles',
+    version: VERSION,
+    extensions: ['pmtiles'],
+    mimeTypes: ['application/octet-stream'],
+    tests: ['PMTiles'],
+    options: {
+        pmtiles: {}
+    },
+    parse: async (arrayBuffer, options) => parseFileAsPMTiles(new BlobFile(new Blob([arrayBuffer])), options),
+    parseFile: parseFileAsPMTiles
+};
+async function parseFileAsPMTiles(file, options) {
+    const source = new PMTilesTileSource(file.handle, {
+        pmtiles: options?.pmtiles || {}
+    });
+    const formatSpecificMetadata = await source.getMetadata();
+    const { tileMIMEType, tilejson = {} } = formatSpecificMetadata;
+    const { layers = [] } = tilejson;
+    switch (tileMIMEType) {
+        case 'application/vnd.mapbox-vector-tile':
+            return {
+                shape: 'vector-source',
+                layers: layers.map((layer) => ({ name: layer.name, schema: layer.schema })),
+                tables: [],
+                formatSpecificMetadata
+            };
+        case 'image/png':
+        case 'image/jpeg':
+            return { shape: 'image-source', formatSpecificMetadata };
+        default:
+            throw new Error(`PMTilesLoader: Unsupported tile MIME type ${tileMIMEType}`);
+    }
+}

package/dist/pmtiles-source.d.ts

@@ -1,43 +1,48 @@
 import type { Schema } from '@loaders.gl/schema';
-import type { GetTileParameters, GetTileDataParameters } from '@loaders.gl/loader-utils';
-import type { ImageType, DataSourceProps } from '@loaders.gl/loader-utils';
-import type { ImageTileSource, VectorTileSource } from '@loaders.gl/loader-utils';
-import { DataSource } from '@loaders.gl/loader-utils';
+import type { VectorTileSource, GetTileParameters, GetTileDataParameters } from '@loaders.gl/loader-utils';
+import type { ImageTileSource, ImageType } from '@loaders.gl/loader-utils';
+import { DataSource, DataSourceProps } from '@loaders.gl/loader-utils';
 import { ImageLoaderOptions } from '@loaders.gl/images';
 import { MVTLoaderOptions, TileJSONLoaderOptions } from '@loaders.gl/mvt';
 import * as pmtiles from 'pmtiles';
 import type { PMTilesMetadata } from "./lib/parse-pmtiles.js";
-export type Service = {
-    name: string;
-    id: string;
-    module: string;
-    version: string;
-    extensions: string[];
-    mimeTypes: string[];
-    options: Record<string, unknown>;
-};
-export type ServiceWithSource<SourceT, SourcePropsT> = Service & {
-    _source?: SourceT;
-    _sourceProps?: SourcePropsT;
-    createSource: (props: SourcePropsT) => SourceT;
+/**
+ * Creates vector tile data sources for PMTiles urls or blobs
+ */
+export declare const PMTilesSource: {
+    readonly name: "PMTiles";
+    readonly id: "pmtiles";
+    readonly module: "pmtiles";
+    readonly version: "1.0.0";
+    readonly extensions: ["pmtiles"];
+    readonly mimeTypes: ["application/octet-stream"];
+    readonly options: {
+        readonly url: never;
+        readonly pmtiles: {};
+    };
+    readonly type: "pmtiles";
+    readonly fromUrl: true;
+    readonly fromBlob: true;
+    readonly testURL: (url: string) => boolean;
+    readonly createDataSource: (url: string | Blob, props: PMTilesTileSourceProps) => PMTilesTileSource;
 };
-export declare const PMTilesService: ServiceWithSource<PMTilesSource, PMTilesSourceProps>;
-export type PMTilesSourceProps = DataSourceProps & {
-    url: string | Blob;
+export type PMTilesTileSourceProps = DataSourceProps & {
     attributions?: string[];
-    loadOptions?: TileJSONLoaderOptions & MVTLoaderOptions & ImageLoaderOptions;
+    pmtiles?: {
+        loadOptions?: TileJSONLoaderOptions & MVTLoaderOptions & ImageLoaderOptions;
+    };
 };
 /**
  * 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 {
+export declare class PMTilesTileSource extends DataSource implements ImageTileSource, VectorTileSource {
     data: string | Blob;
-    props: PMTilesSourceProps;
+    props: PMTilesTileSourceProps;
     mimeType: string | null;
     pmtiles: pmtiles.PMTiles;
     metadata: Promise<PMTilesMetadata>;
-    constructor(props: PMTilesSourceProps);
+    constructor(data: string | Blob, props: PMTilesTileSourceProps);
     getSchema(): Promise<Schema>;
     getMetadata(): Promise<PMTilesMetadata>;
     getTile(tileParams: GetTileParameters): Promise<ArrayBuffer | null>;

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

@@ -1 +1 @@
-{"version":3,"file":"pmtiles-source.d.ts","sourceRoot":"","sources":["../src/pmtiles-source.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAC,MAAM,EAAC,MAAM,oBAAoB,CAAC;AAC/C,OAAO,KAAK,EAAC,iBAAiB,EAAE,qBAAqB,EAAC,MAAM,0BAA0B,CAAC;AACvF,OAAO,KAAK,EAAC,SAAS,EAAE,eAAe,EAAC,MAAM,0BAA0B,CAAC;AACzE,OAAO,KAAK,EAAC,eAAe,EAAE,gBAAgB,EAAC,MAAM,0BAA0B,CAAC;AAChF,OAAO,EAAC,UAAU,EAAc,MAAM,0BAA0B,CAAC;AACjE,OAAO,EAAc,kBAAkB,EAAC,MAAM,oBAAoB,CAAC;AACnE,OAAO,EAAY,gBAAgB,EAAE,qBAAqB,EAAC,MAAM,iBAAiB,CAAC;AAEnF,OAAO,KAAK,OAAO,MAAM,SAAS,CAAC;AAGnC,OAAO,KAAK,EAAC,eAAe,EAAC,+BAA4B;AAMzD,MAAM,MAAM,OAAO,GAAG;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB,SAAS,EAAE,MAAM,EAAE,CAAC;IACpB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAClC,CAAC;AAEF,MAAM,MAAM,iBAAiB,CAAC,OAAO,EAAE,YAAY,IAAI,OAAO,GAAG;IAC/D,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,YAAY,CAAC,EAAE,YAAY,CAAC;IAC5B,YAAY,EAAE,CAAC,KAAK,EAAE,YAAY,KAAK,OAAO,CAAC;CAChD,CAAC;AAEF,eAAO,MAAM,cAAc,EAAE,iBAAiB,CAAC,aAAa,EAAE,kBAAkB,CAW/E,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG,eAAe,GAAG;IACjD,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;IACnB,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;IACxB,WAAW,CAAC,EAAE,qBAAqB,GAAG,gBAAgB,GAAG,kBAAkB,CAAC;CAC7E,CAAC;AAEF;;;GAGG;AACH,qBAAa,aAAc,SAAQ,UAAW,YAAW,eAAe,EAAE,gBAAgB;IACxF,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,KAAK,EAAE,kBAAkB,CAAC;IAC1B,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAQ;IAC/B,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC;IACzB,QAAQ,EAAE,OAAO,CAAC,eAAe,CAAC,CAAC;gBAEvB,KAAK,EAAE,kBAAkB;IAW/B,SAAS,IAAI,OAAO,CAAC,MAAM,CAAC;IAI5B,WAAW,IAAI,OAAO,CAAC,eAAe,CAAC;IAoBvC,OAAO,CAAC,UAAU,EAAE,iBAAiB,GAAG,OAAO,CAAC,WAAW,GAAG,IAAI,CAAC;IAcnE,WAAW,CAAC,UAAU,EAAE,qBAAqB,GAAG,OAAO,CAAC,GAAG,CAAC;IAa5D,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"}
+{"version":3,"file":"pmtiles-source.d.ts","sourceRoot":"","sources":["../src/pmtiles-source.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAC,MAAM,EAAC,MAAM,oBAAoB,CAAC;AAE/C,OAAO,KAAK,EACV,gBAAgB,EAChB,iBAAiB,EACjB,qBAAqB,EACtB,MAAM,0BAA0B,CAAC;AAClC,OAAO,KAAK,EAAC,eAAe,EAAE,SAAS,EAAC,MAAM,0BAA0B,CAAC;AACzE,OAAO,EAAC,UAAU,EAAE,eAAe,EAAc,MAAM,0BAA0B,CAAC;AAClF,OAAO,EAAc,kBAAkB,EAAC,MAAM,oBAAoB,CAAC;AACnE,OAAO,EAAY,gBAAgB,EAAE,qBAAqB,EAAC,MAAM,iBAAiB,CAAC;AAEnF,OAAO,KAAK,OAAO,MAAM,SAAS,CAAC;AAGnC,OAAO,KAAK,EAAC,eAAe,EAAC,+BAA4B;AAMzD;;GAEG;AACH,eAAO,MAAM,aAAa;;;;;;;;;;;;;;4BAYT,MAAM;qCACG,MAAM,GAAG,IAAI,SAAS,sBAAsB;CAEA,CAAC;AAEvE,MAAM,MAAM,sBAAsB,GAAG,eAAe,GAAG;IACrD,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;IACxB,OAAO,CAAC,EAAE;QACR,WAAW,CAAC,EAAE,qBAAqB,GAAG,gBAAgB,GAAG,kBAAkB,CAAC;KAE7E,CAAC;CACH,CAAC;AAEF;;;GAGG;AACH,qBAAa,iBAAkB,SAAQ,UAAW,YAAW,eAAe,EAAE,gBAAgB;IAC5F,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,KAAK,EAAE,sBAAsB,CAAC;IAC9B,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAQ;IAC/B,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC;IACzB,QAAQ,EAAE,OAAO,CAAC,eAAe,CAAC,CAAC;gBAEvB,IAAI,EAAE,MAAM,GAAG,IAAI,EAAE,KAAK,EAAE,sBAAsB;IAUxD,SAAS,IAAI,OAAO,CAAC,MAAM,CAAC;IAI5B,WAAW,IAAI,OAAO,CAAC,eAAe,CAAC;IAoBvC,OAAO,CAAC,UAAU,EAAE,iBAAiB,GAAG,OAAO,CAAC,WAAW,GAAG,IAAI,CAAC;IAcnE,WAAW,CAAC,UAAU,EAAE,qBAAqB,GAAG,OAAO,CAAC,GAAG,CAAC;IAa5D,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/dist/pmtiles-source.js

@@ -9,33 +9,38 @@ 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 = {
+/**
+ * Creates vector tile data sources for PMTiles urls or blobs
+ */
+export const PMTilesSource = {
     name: 'PMTiles',
     id: 'pmtiles',
     module: 'pmtiles',
     version: VERSION,
     extensions: ['pmtiles'],
     mimeTypes: ['application/octet-stream'],
-    options: {
-        pmtiles: {}
-    },
-    createSource: (props) => new PMTilesSource(props)
+    options: { url: undefined, pmtiles: {} },
+    type: 'pmtiles',
+    fromUrl: true,
+    fromBlob: true,
+    testURL: (url) => url.endsWith('.pmtiles'),
+    createDataSource: (url, props) => new PMTilesTileSource(url, 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 {
+export class PMTilesTileSource extends DataSource {
     data;
     props;
     mimeType = null;
     pmtiles;
     metadata;
-    constructor(props) {
+    constructor(data, props) {
         super(props);
         this.props = props;
-        const url = typeof props.url === 'string' ? resolvePath(props.url) : new BlobSource(props.url, 'pmtiles');
-        this.data = props.url;
+        const url = typeof data === 'string' ? resolvePath(data) : new BlobSource(data, 'pmtiles');
+        this.data = data;
         this.pmtiles = new PMTiles(url);
         this.getTileData = this.getTileData.bind(this);
         this.metadata = this.getMetadata();
@@ -45,7 +50,7 @@ export class PMTilesSource extends DataSource {
     }
     async getMetadata() {
         const pmtilesHeader = await this.pmtiles.getHeader();
-        const pmtilesMetadata = await this.pmtiles.getMetadata();
+        const pmtilesMetadata = (await this.pmtiles.getMetadata()) || {};
         const metadata = parsePMTilesHeader(pmtilesHeader, pmtilesMetadata, { includeFormatHeader: false }, this.loadOptions);
         // Add additional attribution if necessary
         if (this.props.attributions) {

package/dist/source-info.d.ts

@@ -0,0 +1,25 @@
+import { Schema } from '@loaders.gl/schema';
+export type SourceInfo = VectorSourceInfo | ImageSourceInfo;
+/** Information about a vector source */
+export type VectorSourceInfo = {
+    shape: 'vector-source';
+    /** List of geospatial tables */
+    layers: {
+        name: string;
+        schema: Schema;
+    }[];
+    /** List of nongeospatial tables */
+    tables: {
+        name: string;
+        schema: Schema;
+    }[];
+    /** Format specific metadata */
+    formatSpecificMetadata?: Record<string, any>;
+};
+/** Information about an image source */
+export type ImageSourceInfo = {
+    shape: 'image-source';
+    /** Format specific metadata */
+    formatSpecificMetadata?: Record<string, any>;
+};
+//# sourceMappingURL=source-info.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"source-info.d.ts","sourceRoot":"","sources":["../src/source-info.ts"],"names":[],"mappings":"AAIA,OAAO,EAAC,MAAM,EAAC,MAAM,oBAAoB,CAAC;AAE1C,MAAM,MAAM,UAAU,GAAG,gBAAgB,GAAG,eAAe,CAAC;AAE5D,wCAAwC;AACxC,MAAM,MAAM,gBAAgB,GAAG;IAC7B,KAAK,EAAE,eAAe,CAAC;IACvB,gCAAgC;IAChC,MAAM,EAAE;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAC,EAAE,CAAC;IACzC,mCAAmC;IACnC,MAAM,EAAE;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAC,EAAE,CAAC;IACzC,+BAA+B;IAC/B,sBAAsB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC9C,CAAC;AAEF,wCAAwC;AACxC,MAAM,MAAM,eAAe,GAAG;IAC5B,KAAK,EAAE,cAAc,CAAC;IACtB,+BAA+B;IAC/B,sBAAsB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC9C,CAAC"}

package/dist/source-info.js

@@ -0,0 +1,4 @@
+// loaders.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@loaders.gl/pmtiles",
-  "version": "4.3.0-alpha.2",
+  "version": "4.3.0-alpha.4",
   "description": "Framework-independent loader for the pmtiles format",
   "license": "MIT",
   "type": "module",
@@ -46,14 +46,14 @@
     "build-bundle-dev": "ocular-bundle ./bundle.ts --env=dev --output=dist/dist.dev.js"
   },
   "dependencies": {
-    "@loaders.gl/images": "4.3.0-alpha.2",
-    "@loaders.gl/loader-utils": "4.3.0-alpha.2",
-    "@loaders.gl/mvt": "4.3.0-alpha.2",
-    "@loaders.gl/schema": "4.3.0-alpha.2",
+    "@loaders.gl/images": "4.3.0-alpha.4",
+    "@loaders.gl/loader-utils": "4.3.0-alpha.4",
+    "@loaders.gl/mvt": "4.3.0-alpha.4",
+    "@loaders.gl/schema": "4.3.0-alpha.4",
     "pmtiles": "^3.0.4"
   },
   "peerDependencies": {
     "@loaders.gl/core": "^4.0.0"
   },
-  "gitHead": "77a3cb538ab7a1fbf74245f25590210451689f5c"
+  "gitHead": "4900ac4c4de20366c050b80cef04dc5b52d167af"
 }

package/src/index.ts

@@ -2,6 +2,11 @@
 // SPDX-License-Identifier: MIT
 // Copyright (c) vis.gl contributors
 
-export type {PMTilesMetadata} from './lib/parse-pmtiles';
-export type {PMTilesSourceProps} from './pmtiles-source';
 export {PMTilesSource} from './pmtiles-source';
+
+export type {PMTilesMetadata} from './lib/parse-pmtiles';
+export type {PMTilesTileSourceProps} from './pmtiles-source';
+export {PMTilesTileSource} from './pmtiles-source';
+
+export {PMTilesLoader as _PMTilesLoader} from './pmtiles-loader';
+export type {PMTilesLoaderOptions} from './pmtiles-loader';

package/src/lib/parse-pmtiles.ts

@@ -2,7 +2,7 @@
 // SPDX-License-Identifier: MIT
 // Copyright (c) vis.gl contributors
 
-import type {LoaderOptions} from '@loaders.gl/loader-utils';
+import {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,12 +61,10 @@ export type PMTilesMetadata = {
  */
 export function parsePMTilesHeader(
   header: pmtiles.Header,
-  pmmetadata: unknown,
+  pmtilesMetadata: Record<string, unknown> | null,
   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/src/lib/version.ts

@@ -0,0 +1,8 @@
+// loaders.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
+
+// Version constant cannot be imported, it needs to correspond to the build version of **this** module.
+// __VERSION__ is injected by babel-plugin-version-inline
+// @ts-ignore TS2304: Cannot find name '__VERSION__'.
+export const VERSION = typeof __VERSION__ !== 'undefined' ? __VERSION__ : 'latest';

package/src/pmtiles-loader.ts

@@ -0,0 +1,65 @@
+// loaders.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
+
+import type {LoaderWithParser, LoaderOptions, ReadableFile} from '@loaders.gl/loader-utils';
+import {BlobFile} from '@loaders.gl/loader-utils';
+import {VERSION} from './lib/version';
+
+import {VectorSourceInfo, ImageSourceInfo} from './source-info';
+import {PMTilesTileSource, PMTilesTileSourceProps} from './pmtiles-source';
+
+export type PMTilesLoaderOptions = LoaderOptions & {
+  pmtiles?: PMTilesTileSourceProps['pmtiles'];
+};
+
+/**
+ * Loader for PMTiles metadata
+ * @note This loader is intended to allow PMTiles to be treated like other file types in top-level loading logic.
+ * @note For actual access to the tile data, use the PMTilesSource class.
+ */
+export const PMTilesLoader = {
+  name: 'PMTiles',
+  id: 'pmtiles',
+  module: 'pmtiles',
+  version: VERSION,
+  extensions: ['pmtiles'],
+  mimeTypes: ['application/octet-stream'],
+  tests: ['PMTiles'],
+  options: {
+    pmtiles: {}
+  },
+  parse: async (arrayBuffer: ArrayBuffer, options?: PMTilesLoaderOptions) =>
+    parseFileAsPMTiles(new BlobFile(new Blob([arrayBuffer])), options),
+  parseFile: parseFileAsPMTiles
+} as const satisfies LoaderWithParser<
+  VectorSourceInfo | ImageSourceInfo,
+  never,
+  PMTilesLoaderOptions
+>;
+
+async function parseFileAsPMTiles(
+  file: ReadableFile,
+  options?: PMTilesLoaderOptions
+): Promise<VectorSourceInfo | ImageSourceInfo> {
+  const source = new PMTilesTileSource(file.handle as string | Blob, {
+    pmtiles: options?.pmtiles || {}
+  });
+  const formatSpecificMetadata = await source.getMetadata();
+  const {tileMIMEType, tilejson = {}} = formatSpecificMetadata;
+  const {layers = []} = tilejson;
+  switch (tileMIMEType) {
+    case 'application/vnd.mapbox-vector-tile':
+      return {
+        shape: 'vector-source',
+        layers: layers.map((layer) => ({name: layer.name, schema: layer.schema})),
+        tables: [],
+        formatSpecificMetadata
+      } as VectorSourceInfo;
+    case 'image/png':
+    case 'image/jpeg':
+      return {shape: 'image-source', formatSpecificMetadata} as ImageSourceInfo;
+    default:
+      throw new Error(`PMTilesLoader: Unsupported tile MIME type ${tileMIMEType}`);
+  }
+}

package/src/pmtiles-source.ts

@@ -3,10 +3,14 @@
 // Copyright (c) vis.gl contributors
 
 import type {Schema} from '@loaders.gl/schema';
-import type {GetTileParameters, GetTileDataParameters} from '@loaders.gl/loader-utils';
-import type {ImageType, DataSourceProps} from '@loaders.gl/loader-utils';
-import type {ImageTileSource, VectorTileSource} from '@loaders.gl/loader-utils';
-import {DataSource, resolvePath} from '@loaders.gl/loader-utils';
+import type {Source} from '@loaders.gl/loader-utils';
+import type {
+  VectorTileSource,
+  GetTileParameters,
+  GetTileDataParameters
+} from '@loaders.gl/loader-utils';
+import type {ImageTileSource, ImageType} from '@loaders.gl/loader-utils';
+import {DataSource, DataSourceProps, resolvePath} from '@loaders.gl/loader-utils';
 import {ImageLoader, ImageLoaderOptions} from '@loaders.gl/images';
 import {MVTLoader, MVTLoaderOptions, TileJSONLoaderOptions} from '@loaders.gl/mvt';
 
@@ -19,58 +23,50 @@ import {BlobSource} from './lib/blob-source';
 
 const VERSION = '1.0.0';
 
-export type Service = {
-  name: string;
-  id: string;
-  module: string;
-  version: string;
-  extensions: string[];
-  mimeTypes: string[];
-  options: Record<string, unknown>;
-};
-
-export type ServiceWithSource<SourceT, SourcePropsT> = Service & {
-  _source?: SourceT;
-  _sourceProps?: SourcePropsT;
-  createSource: (props: SourcePropsT) => SourceT;
-};
-
-export const PMTilesService: ServiceWithSource<PMTilesSource, PMTilesSourceProps> = {
+/**
+ * Creates vector tile data sources for PMTiles urls or blobs
+ */
+export const PMTilesSource = {
   name: 'PMTiles',
   id: 'pmtiles',
   module: 'pmtiles',
   version: VERSION,
   extensions: ['pmtiles'],
   mimeTypes: ['application/octet-stream'],
-  options: {
-    pmtiles: {}
-  },
-  createSource: (props: PMTilesSourceProps) => new PMTilesSource(props)
-};
+  options: {url: undefined!, pmtiles: {}},
+  type: 'pmtiles',
+  fromUrl: true,
+  fromBlob: true,
+
+  testURL: (url: string) => url.endsWith('.pmtiles'),
+  createDataSource: (url: string | Blob, props: PMTilesTileSourceProps) =>
+    new PMTilesTileSource(url, props)
+} as const satisfies Source<PMTilesTileSource, PMTilesTileSourceProps>;
 
-export type PMTilesSourceProps = DataSourceProps & {
-  url: string | Blob;
+export type PMTilesTileSourceProps = DataSourceProps & {
   attributions?: string[];
-  loadOptions?: TileJSONLoaderOptions & MVTLoaderOptions & ImageLoaderOptions;
+  pmtiles?: {
+    loadOptions?: TileJSONLoaderOptions & MVTLoaderOptions & ImageLoaderOptions;
+    // TODO - add options here
+  };
 };
 
 /**
  * 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 implements ImageTileSource, VectorTileSource {
+export class PMTilesTileSource extends DataSource implements ImageTileSource, VectorTileSource {
   data: string | Blob;
-  props: PMTilesSourceProps;
+  props: PMTilesTileSourceProps;
   mimeType: string | null = null;
   pmtiles: pmtiles.PMTiles;
   metadata: Promise<PMTilesMetadata>;
 
-  constructor(props: PMTilesSourceProps) {
+  constructor(data: string | Blob, props: PMTilesTileSourceProps) {
     super(props);
     this.props = props;
-    const url =
-      typeof props.url === 'string' ? resolvePath(props.url) : new BlobSource(props.url, 'pmtiles');
-    this.data = props.url;
+    const url = typeof data === 'string' ? resolvePath(data) : new BlobSource(data, 'pmtiles');
+    this.data = data;
     this.pmtiles = new PMTiles(url);
     this.getTileData = this.getTileData.bind(this);
     this.metadata = this.getMetadata();
@@ -82,7 +78,7 @@ export class PMTilesSource extends DataSource implements ImageTileSource, Vector
 
   async getMetadata(): Promise<PMTilesMetadata> {
     const pmtilesHeader = await this.pmtiles.getHeader();
-    const pmtilesMetadata = await this.pmtiles.getMetadata();
+    const pmtilesMetadata = ((await this.pmtiles.getMetadata()) as Record<string, unknown>) || {};
     const metadata: PMTilesMetadata = parsePMTilesHeader(
       pmtilesHeader,
       pmtilesMetadata,

package/src/source-info.ts

@@ -0,0 +1,25 @@
+// loaders.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
+
+import {Schema} from '@loaders.gl/schema';
+
+export type SourceInfo = VectorSourceInfo | ImageSourceInfo;
+
+/** Information about a vector source */
+export type VectorSourceInfo = {
+  shape: 'vector-source';
+  /** List of geospatial tables */
+  layers: {name: string; schema: Schema}[];
+  /** List of nongeospatial tables */
+  tables: {name: string; schema: Schema}[];
+  /** Format specific metadata */
+  formatSpecificMetadata?: Record<string, any>;
+};
+
+/** Information about an image source */
+export type ImageSourceInfo = {
+  shape: 'image-source';
+  /** Format specific metadata */
+  formatSpecificMetadata?: Record<string, any>;
+};