@loaders.gl/flatgeobuf 4.3.2 → 4.4.0-alpha.1

package/dist/index.d.ts

@@ -1,3 +1,6 @@
+export { FlatGeobufFormat } from "./flatgeobuf-format.js";
 export type { FlatGeobufLoaderOptions } from "./flatgeobuf-loader.js";
 export { FlatGeobufLoader, FlatGeobufWorkerLoader } from "./flatgeobuf-loader.js";
+export type { FlatGeobufSourceOptions } from "./flatgeobuf-source.js";
+export { FlatGeobufSource as _FlatGeobufSource } from "./flatgeobuf-source.js";
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAIA,YAAY,EAAC,uBAAuB,EAAC,+BAA4B;AACjE,OAAO,EAAC,gBAAgB,EAAE,sBAAsB,EAAC,+BAA4B"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAIA,OAAO,EAAC,gBAAgB,EAAC,+BAA4B;AAErD,YAAY,EAAC,uBAAuB,EAAC,+BAA4B;AACjE,OAAO,EAAC,gBAAgB,EAAE,sBAAsB,EAAC,+BAA4B;AAE7E,YAAY,EAAC,uBAAuB,EAAC,+BAA4B;AACjE,OAAO,EAAC,gBAAgB,IAAI,iBAAiB,EAAC,+BAA4B"}

package/dist/index.js

@@ -1,4 +1,6 @@
 // loaders.gl
 // SPDX-License-Identifier: MIT
 // Copyright (c) vis.gl contributors
+export { FlatGeobufFormat } from "./flatgeobuf-format.js";
 export { FlatGeobufLoader, FlatGeobufWorkerLoader } from "./flatgeobuf-loader.js";
+export { FlatGeobufSource as _FlatGeobufSource } from "./flatgeobuf-source.js";

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@loaders.gl/flatgeobuf",
   "description": "Loader for FlatGeobuf",
-  "version": "4.3.2",
+  "version": "4.4.0-alpha.1",
   "license": "MIT",
   "type": "module",
   "publishConfig": {
@@ -44,9 +44,9 @@
     "build-worker": "esbuild src/workers/flatgeobuf-worker.ts --bundle --outfile=dist/flatgeobuf-worker.js --define:__VERSION__=\\\"$npm_package_version\\\""
   },
   "dependencies": {
-    "@loaders.gl/gis": "4.3.2",
-    "@loaders.gl/loader-utils": "4.3.2",
-    "@loaders.gl/schema": "4.3.2",
+    "@loaders.gl/gis": "4.4.0-alpha.1",
+    "@loaders.gl/loader-utils": "4.4.0-alpha.1",
+    "@loaders.gl/schema": "4.4.0-alpha.1",
     "@math.gl/proj4": "^4.1.0",
     "flatgeobuf": "3.27.2"
   },
@@ -54,7 +54,7 @@
     "stream-buffers": "3.0.2"
   },
   "peerDependencies": {
-    "@loaders.gl/core": "^4.3.0"
+    "@loaders.gl/core": "4.4.0-alpha.0"
   },
-  "gitHead": "b4203b8703f64a38d6f79a3113bc7bb51d45c93a"
+  "gitHead": "f1732de45907bd500bf4eedb4803beca8bf4bfb0"
 }

package/src/flatgeobuf-format.ts

@@ -0,0 +1,15 @@
+// loaders.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
+
+import type {Format} from '@loaders.gl/loader-utils';
+
+/** flatgeobuf format */
+export const FlatGeobufFormat = {
+  id: 'flatgeobuf',
+  name: 'FlatGeobuf',
+  module: 'flatgeobuf',
+  extensions: ['fgb'],
+  mimeTypes: ['application/octet-stream'],
+  category: 'geometry'
+} as const satisfies Format;

package/src/flatgeobuf-loader.ts

@@ -9,6 +9,7 @@ import {
   parseFlatGeobufInBatches,
   ParseFlatGeobufOptions
 } from './lib/parse-flatgeobuf';
+import {FlatGeobufFormat} from './flatgeobuf-format';
 
 // __VERSION__ is injected by babel-plugin-version-inline
 // @ts-ignore TS2304: Cannot find name '__VERSION__'.
@@ -32,17 +33,12 @@ export type FlatGeobufLoaderOptions = LoaderOptions & {
 
 /** Load flatgeobuf on a worker */
 export const FlatGeobufWorkerLoader = {
+  ...FlatGeobufFormat,
+
   dataType: null as any,
   batchType: null as any,
-
-  id: 'flatgeobuf',
-  name: 'FlatGeobuf',
-  module: 'flatgeobuf',
   version: VERSION,
   worker: true,
-  extensions: ['fgb'],
-  mimeTypes: ['application/octet-stream'],
-  category: 'geometry',
   tests: [new Uint8Array(FGB_MAGIC_NUMBER).buffer],
   options: {
     flatgeobuf: {

package/src/{floatgeobuf-source.ts → flatgeobuf-source.ts}

@@ -4,64 +4,51 @@
 
 import {Schema, GeoJSONTable} from '@loaders.gl/schema';
 import type {
-  VectorSourceProps,
+  DataSourceOptions,
   VectorSourceMetadata,
-  GetFeaturesParameters,
-  LoaderWithParser
+  GetFeaturesParameters
 } from '@loaders.gl/loader-utils';
-import {Source, VectorSource} from '@loaders.gl/loader-utils';
+import {Source, DataSource, VectorSource} from '@loaders.gl/loader-utils';
 
 import {FlatGeobufLoader} from './flatgeobuf-loader';
+import {FlatGeobufFormat} from './flatgeobuf-format';
+
+export type FlatGeobufSourceOptions = DataSourceOptions & {
+  flatgeobuf?: {};
+};
 
 /**
+ * FlatGeobufSource
+ * Incrementally load bounding boxes from a spatially indexed FlatGeobuf file
  * @ndeprecated This is a WIP, not fully implemented
- * @see https://developers.arcgis.com/rest/services-reference/enterprise/feature-service.htm
  */
 export const FlatGeobufSource = {
-  name: 'FlatGeobuf',
-  id: 'flatgeobuf-server',
-  module: 'wms',
+  ...FlatGeobufFormat,
   version: '0.0.0',
-  extensions: [],
-  mimeTypes: [],
-  options: {
-    url: undefined!,
-    'flatgeobuf-server': {
-      /** Tabular loaders, normally the GeoJSONLoader */
-      loaders: []
-    }
-  },
-
   type: 'flatgeobuf-server',
   fromUrl: true,
   fromBlob: false, // TODO check if supported by library?
 
-  testURL: (url: string): boolean => url.toLowerCase().includes('FeatureServer'),
-  createDataSource: (url, props: FlatGeobufVectorSourceProps): FlatGeobufVectorSource =>
-    new FlatGeobufVectorSource(props)
-} as const satisfies Source<FlatGeobufVectorSource, FlatGeobufVectorSourceProps>;
+  defaultOptions: {
+    flatgeobuf: {}
+  },
 
-export type FlatGeobufVectorSourceProps = VectorSourceProps & {
-  url: string;
-  'flatgeobuf-server'?: {
-    loaders: LoaderWithParser[];
-  };
-};
+  testURL: (url: string): boolean => url.toLowerCase().includes('FeatureServer'),
+  createDataSource: (url: string, options: FlatGeobufSourceOptions): FlatGeobufVectorSource =>
+    new FlatGeobufVectorSource(url, options)
+} as const satisfies Source<FlatGeobufVectorSource>;
 
 /**
- * ArcGIS ImageServer
- * Note - exports a big API, that could be exposed here if there is a use case
- * @see https://developers.arcgis.com/rest/services-reference/enterprise/feature-service.htm
+ * FlatGeobufVectorSource
  */
-export class FlatGeobufVectorSource extends VectorSource<FlatGeobufVectorSourceProps> {
-  data: string;
-  url: string;
+export class FlatGeobufVectorSource
+  extends DataSource<string, FlatGeobufSourceOptions>
+  implements VectorSource
+{
   protected formatSpecificMetadata: Promise<any> | null = null;
 
-  constructor(props: FlatGeobufVectorSourceProps) {
-    super(props);
-    this.data = props.url;
-    this.url = props.url;
+  constructor(data: string, options: FlatGeobufSourceOptions) {
+    super(data, options, FlatGeobufSource.defaultOptions);
     // this.formatSpecificMetadata = this._getFormatSpecificMetadata();
   }
 
@@ -93,7 +80,7 @@ export class FlatGeobufVectorSource extends VectorSource<FlatGeobufVectorSourceP
     // TODO - hack - done to avoid pulling in selectLoader from core
 
     const table = await FlatGeobufLoader.parse(arrayBuffer, {});
-    // const loader = this.props['flatgeobuf-server']?.loaders?.[0];
+    // const loader = this.options['flatgeobuf-server']?.loaders?.[0];
     // const table = loader?.parse(arrayBuffer);
     return table as GeoJSONTable;
   }

package/src/index.ts

@@ -2,5 +2,10 @@
 // SPDX-License-Identifier: MIT
 // Copyright (c) vis.gl contributors
 
+export {FlatGeobufFormat} from './flatgeobuf-format';
+
 export type {FlatGeobufLoaderOptions} from './flatgeobuf-loader';
 export {FlatGeobufLoader, FlatGeobufWorkerLoader} from './flatgeobuf-loader';
+
+export type {FlatGeobufSourceOptions} from './flatgeobuf-source';
+export {FlatGeobufSource as _FlatGeobufSource} from './flatgeobuf-source';

package/dist/floatgeobuf-source.d.ts

@@ -1,51 +0,0 @@
-import { Schema, GeoJSONTable } from '@loaders.gl/schema';
-import type { VectorSourceProps, VectorSourceMetadata, GetFeaturesParameters, LoaderWithParser } from '@loaders.gl/loader-utils';
-import { VectorSource } from '@loaders.gl/loader-utils';
-/**
- * @ndeprecated This is a WIP, not fully implemented
- * @see https://developers.arcgis.com/rest/services-reference/enterprise/feature-service.htm
- */
-export declare const FlatGeobufSource: {
-    readonly name: "FlatGeobuf";
-    readonly id: "flatgeobuf-server";
-    readonly module: "wms";
-    readonly version: "0.0.0";
-    readonly extensions: [];
-    readonly mimeTypes: [];
-    readonly options: {
-        readonly url: never;
-        readonly 'flatgeobuf-server': {
-            /** Tabular loaders, normally the GeoJSONLoader */
-            readonly loaders: [];
-        };
-    };
-    readonly type: "flatgeobuf-server";
-    readonly fromUrl: true;
-    readonly fromBlob: false;
-    readonly testURL: (url: string) => boolean;
-    readonly createDataSource: (url: string | Blob, props: FlatGeobufVectorSourceProps) => FlatGeobufVectorSource;
-};
-export type FlatGeobufVectorSourceProps = VectorSourceProps & {
-    url: string;
-    'flatgeobuf-server'?: {
-        loaders: LoaderWithParser[];
-    };
-};
-/**
- * ArcGIS ImageServer
- * Note - exports a big API, that could be exposed here if there is a use case
- * @see https://developers.arcgis.com/rest/services-reference/enterprise/feature-service.htm
- */
-export declare class FlatGeobufVectorSource extends VectorSource<FlatGeobufVectorSourceProps> {
-    data: string;
-    url: string;
-    protected formatSpecificMetadata: Promise<any> | null;
-    constructor(props: FlatGeobufVectorSourceProps);
-    /** TODO - not yet clear if we can find schema information in the FeatureServer metadata or if we need to request a feature */
-    getSchema(): Promise<Schema>;
-    getMetadata(options: {
-        formatSpecificMetadata: any;
-    }): Promise<VectorSourceMetadata>;
-    getFeatures(parameters: GetFeaturesParameters): Promise<GeoJSONTable>;
-}
-//# sourceMappingURL=floatgeobuf-source.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"floatgeobuf-source.d.ts","sourceRoot":"","sources":["../src/floatgeobuf-source.ts"],"names":[],"mappings":"AAIA,OAAO,EAAC,MAAM,EAAE,YAAY,EAAC,MAAM,oBAAoB,CAAC;AACxD,OAAO,KAAK,EACV,iBAAiB,EACjB,oBAAoB,EACpB,qBAAqB,EACrB,gBAAgB,EACjB,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAS,YAAY,EAAC,MAAM,0BAA0B,CAAC;AAI9D;;;GAGG;AACH,eAAO,MAAM,gBAAgB;;;;;;;;;;YAUvB,kDAAkD;;;;;;;4BASvC,MAAM,KAAG,OAAO;2DACA,2BAA2B,KAAG,sBAAsB;CAEL,CAAC;AAEjF,MAAM,MAAM,2BAA2B,GAAG,iBAAiB,GAAG;IAC5D,GAAG,EAAE,MAAM,CAAC;IACZ,mBAAmB,CAAC,EAAE;QACpB,OAAO,EAAE,gBAAgB,EAAE,CAAC;KAC7B,CAAC;CACH,CAAC;AAEF;;;;GAIG;AACH,qBAAa,sBAAuB,SAAQ,YAAY,CAAC,2BAA2B,CAAC;IACnF,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,SAAS,CAAC,sBAAsB,EAAE,OAAO,CAAC,GAAG,CAAC,GAAG,IAAI,CAAQ;gBAEjD,KAAK,EAAE,2BAA2B;IAO9C,8HAA8H;IACxH,SAAS,IAAI,OAAO,CAAC,MAAM,CAAC;IAK5B,WAAW,CAAC,OAAO,EAAE;QAAC,sBAAsB,MAAA;KAAC,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAgB7E,WAAW,CAAC,UAAU,EAAE,qBAAqB,GAAG,OAAO,CAAC,YAAY,CAAC;CAU5E"}