@loaders.gl/pmtiles 4.3.0-alpha.1 → 4.3.0-alpha.3

package/dist/pmtiles-source.d.ts

@@ -1,45 +1,53 @@
-import type { TileLoadParameters, GetTileParameters } 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 { Schema } from '@loaders.gl/schema';
+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 & {
+export type PMTilesTileSourceProps = DataSourceProps & {
     url: string | Blob;
     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>;
-    getTileData(tileParams: TileLoadParameters): Promise<unknown | null>;
+    getTileData(tileParams: GetTileDataParameters): Promise<any>;
     getImageTile(tileParams: GetTileParameters): Promise<ImageType | null>;
     getVectorTile(tileParams: GetTileParameters): Promise<unknown | 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,kBAAkB,EAAE,iBAAiB,EAAC,MAAM,0BAA0B,CAAC;AACpF,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,WAAW,IAAI,OAAO,CAAC,eAAe,CAAC;IAoBvC,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"}
+{"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,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;IACnB,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,37 +9,45 @@ 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');
+        const url = typeof data === 'string' ? resolvePath(data) : new BlobSource(data, 'pmtiles');
         this.data = props.url;
         this.pmtiles = new PMTiles(url);
         this.getTileData = this.getTileData.bind(this);
         this.metadata = this.getMetadata();
     }
+    async getSchema() {
+        return { fields: [], metadata: {} };
+    }
     async getMetadata() {
         const pmtilesHeader = await this.pmtiles.getHeader();
         const pmtilesMetadata = await this.pmtiles.getMetadata();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@loaders.gl/pmtiles",
-  "version": "4.3.0-alpha.1",
+  "version": "4.3.0-alpha.3",
   "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.1",
-    "@loaders.gl/loader-utils": "4.3.0-alpha.1",
-    "@loaders.gl/mvt": "4.3.0-alpha.1",
-    "@loaders.gl/schema": "4.3.0-alpha.1",
+    "@loaders.gl/images": "4.3.0-alpha.3",
+    "@loaders.gl/loader-utils": "4.3.0-alpha.3",
+    "@loaders.gl/mvt": "4.3.0-alpha.3",
+    "@loaders.gl/schema": "4.3.0-alpha.3",
     "pmtiles": "^3.0.4"
   },
   "peerDependencies": {
     "@loaders.gl/core": "^4.0.0"
   },
-  "gitHead": "568446ea69eb590f0c42d965459b636216cda74e"
+  "gitHead": "3213679d79e6ff2814d48fd3337acfa446c74099"
 }

package/src/index.ts

@@ -2,6 +2,8 @@
 // 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';

package/src/pmtiles-source.ts

@@ -2,10 +2,15 @@
 // SPDX-License-Identifier: MIT
 // Copyright (c) vis.gl contributors
 
-import type {TileLoadParameters, GetTileParameters} 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 {Schema} from '@loaders.gl/schema';
+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';
 
@@ -18,63 +23,60 @@ 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 & {
+export type PMTilesTileSourceProps = DataSourceProps & {
   url: string | Blob;
   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');
+    const url = typeof data === 'string' ? resolvePath(data) : new BlobSource(data, 'pmtiles');
     this.data = props.url;
     this.pmtiles = new PMTiles(url);
     this.getTileData = this.getTileData.bind(this);
     this.metadata = this.getMetadata();
   }
 
+  async getSchema(): Promise<Schema> {
+    return {fields: [], metadata: {}};
+  }
+
   async getMetadata(): Promise<PMTilesMetadata> {
     const pmtilesHeader = await this.pmtiles.getHeader();
     const pmtilesMetadata = await this.pmtiles.getMetadata();
@@ -109,7 +111,7 @@ export class PMTilesSource extends DataSource implements ImageTileSource, Vector
   // Tile Source interface implementation: deck.gl compatible API
   // TODO - currently only handles image tiles, not vector tiles
 
-  async getTileData(tileParams: TileLoadParameters): Promise<unknown | null> {
+  async getTileData(tileParams: GetTileDataParameters): Promise<any> {
     const {x, y, z} = tileParams.index;
     const metadata = await this.metadata;
     switch (metadata.tileMIMEType) {