@loaders.gl/shapefile 4.4.0-alpha.2 → 4.4.0-alpha.9

package/src/lib/parsers/parse-shapefile.ts

@@ -3,7 +3,12 @@
 // Copyright (c) vis.gl contributors
 
 // import type {Feature} from '@loaders.gl/gis';
-import {LoaderContext, parseInBatchesFromContext, parseFromContext} from '@loaders.gl/loader-utils';
+import {
+  LoaderContext,
+  parseInBatchesFromContext,
+  parseFromContext,
+  toArrayBufferIterator
+} from '@loaders.gl/loader-utils';
 import {convertBinaryGeometryToGeometry, transformGeoJsonCoords} from '@loaders.gl/gis';
 import type {
   BinaryGeometry,
@@ -34,7 +39,9 @@ interface ShapefileOutput {
  */
 // eslint-disable-next-line max-statements, complexity
 export async function* parseShapefileInBatches(
-  asyncIterator: AsyncIterable<ArrayBuffer> | Iterable<ArrayBuffer>,
+  asyncIterator:
+    | AsyncIterable<ArrayBufferLike | ArrayBufferView>
+    | Iterable<ArrayBufferLike | ArrayBufferView>,
   options?: ShapefileLoaderOptions,
   context?: LoaderContext
 ): AsyncIterable<ShapefileOutput> {
@@ -43,7 +50,7 @@ export async function* parseShapefileInBatches(
 
   // parse geometries
   const shapeIterable = await parseInBatchesFromContext(
-    asyncIterator,
+    toArrayBufferIterator(asyncIterator),
     SHPLoader,
     options,
     context!
@@ -61,7 +68,10 @@ export async function* parseShapefileInBatches(
       DBFLoader,
       {
         ...options,
-        dbf: {encoding: cpg || 'latin1'}
+        dbf: {
+          ...options?.dbf,
+          encoding: cpg || 'latin1'
+        }
       },
       context!
     );
@@ -147,12 +157,15 @@ export async function parseShapefile(
 
   const dbfResponse = await context?.fetch(replaceExtension(context?.url!, 'dbf'));
   if (dbfResponse?.ok) {
-    propertyTable = await parseFromContext(
-      dbfResponse as any,
-      DBFLoader,
-      {dbf: {shape: 'object-row-table', encoding: cpg || 'latin1'}},
-      context!
-    );
+    const dbfOptions = {
+      ...options,
+      dbf: {
+        ...options?.dbf,
+        shape: 'object-row-table',
+        encoding: cpg || 'latin1'
+      }
+    };
+    propertyTable = await parseFromContext(dbfResponse as any, DBFLoader, dbfOptions, context!);
   }
 
   let features = joinProperties(geojsonGeometries, propertyTable?.data || []);

package/src/lib/parsers/parse-shp.ts

@@ -3,6 +3,7 @@
 // Copyright (c) vis.gl contributors
 
 import type {BinaryGeometry} from '@loaders.gl/schema';
+import {toArrayBufferIterator} from '@loaders.gl/loader-utils';
 import {BinaryChunkReader} from '../streaming/binary-chunk-reader';
 import {parseSHPHeader, SHPHeader} from './parse-shp-header';
 import {parseRecord} from './parse-shp-geometry';
@@ -86,12 +87,14 @@ export function parseSHP(arrayBuffer: ArrayBuffer, options?: SHPLoaderOptions):
  * @returns
  */
 export async function* parseSHPInBatches(
-  asyncIterator: AsyncIterable<ArrayBuffer> | Iterable<ArrayBuffer>,
+  asyncIterator:
+    | AsyncIterable<ArrayBufferLike | ArrayBufferView>
+    | Iterable<ArrayBufferLike | ArrayBufferView>,
   options?: SHPLoaderOptions
 ): AsyncGenerator<BinaryGeometry | object> {
   const parser = new SHPParser(options);
   let headerReturned = false;
-  for await (const arrayBuffer of asyncIterator) {
+  for await (const arrayBuffer of toArrayBufferIterator(asyncIterator)) {
     parser.write(arrayBuffer);
     if (!headerReturned && parser.result.header) {
       headerReturned = true;

package/src/lib/parsers/types.ts

@@ -3,25 +3,30 @@
 // Copyright (c) vis.gl contributors
 
 import type {Schema, ObjectRowTable} from '@loaders.gl/schema';
-import type {LoaderOptions} from '@loaders.gl/loader-utils';
+import type {StrictLoaderOptions} from '@loaders.gl/loader-utils';
 
-export type SHPLoaderOptions = LoaderOptions & {
+export type SHPLoaderOptions = StrictLoaderOptions & {
   shp?: {
     _maxDimensions?: number;
+    /** Override the URL to the worker bundle (by default loads from unpkg.com) */
+    workerUrl?: string;
   };
 };
 
-export type DBFLoaderOptions = LoaderOptions & {
+export type DBFLoaderOptions = StrictLoaderOptions & {
   dbf?: {
     encoding?: string;
     shape?: 'rows' | 'table' | 'object-row-table';
+    /** Override the URL to the worker bundle (by default loads from unpkg.com) */
+    workerUrl?: string;
   };
 };
 
-export type ShapefileLoaderOptions = LoaderOptions &
-  SHPLoaderOptions & {
+export type ShapefileLoaderOptions = StrictLoaderOptions &
+  SHPLoaderOptions &
+  DBFLoaderOptions & {
     shapefile?: {
-      shape?: 'geojson-table';
+      shape?: 'geojson-table' | 'v3';
     };
     gis?: {
       reproject?: boolean;

package/src/shapefile-loader.ts

@@ -2,22 +2,29 @@
 // SPDX-License-Identifier: MIT
 // Copyright (c) vis.gl contributors
 
-import type {LoaderOptions, LoaderWithParser} from '@loaders.gl/loader-utils';
+import type {StrictLoaderOptions, LoaderWithParser} from '@loaders.gl/loader-utils';
 import type {Batch, GeoJSONTable} from '@loaders.gl/schema';
-import {SHP_MAGIC_NUMBER} from './shp-loader';
+import {SHP_MAGIC_NUMBER, SHPLoaderOptions} from './shp-loader';
 import {parseShapefile, parseShapefileInBatches} from './lib/parsers/parse-shapefile';
+import {DBFLoaderOptions} from './dbf-loader';
 
 // __VERSION__ is injected by babel-plugin-version-inline
 // @ts-ignore TS2304: Cannot find name '__VERSION__'.
 const VERSION = typeof __VERSION__ !== 'undefined' ? __VERSION__ : 'latest';
 
-export type ShapefileLoaderOptions = LoaderOptions & {
-  shapefile?: {
-    shape?: 'geojson-table' | 'v3';
-    /** @deprecated Worker URLs must be specified with .dbf.workerUrl * .shp.workerUrl */
-    workerUrl?: never;
+export type ShapefileLoaderOptions = StrictLoaderOptions &
+  SHPLoaderOptions &
+  DBFLoaderOptions & {
+    shapefile?: {
+      shape?: 'geojson-table' | 'v3';
+      /** @deprecated Worker URLs must be specified with .dbf.workerUrl * .shp.workerUrl */
+      workerUrl?: never;
+    };
+    gis?: {
+      reproject?: boolean;
+      _targetCrs?: string;
+    };
   };
-};
 
 /**
  * Shapefile loader

package/src/shp-loader.ts

@@ -2,7 +2,7 @@
 // SPDX-License-Identifier: MIT
 // Copyright (c) vis.gl contributors
 
-import type {Loader, LoaderWithParser, LoaderOptions} from '@loaders.gl/loader-utils';
+import type {Loader, LoaderWithParser, StrictLoaderOptions} from '@loaders.gl/loader-utils';
 import {parseSHP, parseSHPInBatches} from './lib/parsers/parse-shp';
 
 // __VERSION__ is injected by babel-plugin-version-inline
@@ -12,8 +12,8 @@ const VERSION = typeof __VERSION__ !== 'undefined' ? __VERSION__ : 'latest';
 export const SHP_MAGIC_NUMBER = [0x00, 0x00, 0x27, 0x0a];
 
 /** SHPLoader */
-export type SHPLoaderOptions = LoaderOptions & {
-  dbf?: {
+export type SHPLoaderOptions = StrictLoaderOptions & {
+  shp?: {
     _maxDimensions?: number;
     /** Override the URL to the worker bundle (by default loads from unpkg.com) */
     workerUrl?: string;
@@ -50,7 +50,9 @@ export const SHPLoader: LoaderWithParser = {
   parse: async (arrayBuffer, options?) => parseSHP(arrayBuffer, options),
   parseSync: parseSHP,
   parseInBatches: (
-    arrayBufferIterator: AsyncIterable<ArrayBuffer> | Iterable<ArrayBuffer>,
+    arrayBufferIterator:
+      | AsyncIterable<ArrayBufferLike | ArrayBufferView>
+      | Iterable<ArrayBufferLike | ArrayBufferView>,
     options
   ) => parseSHPInBatches(arrayBufferIterator, options)
 };