@loaders.gl/shapefile 4.0.0-alpha.1 → 4.0.0-alpha.11

package/dist/lib/streaming/binary-chunk-reader.js

@@ -1,137 +1,161 @@
-import _defineProperty from "@babel/runtime/helpers/esm/defineProperty";
-export default class BinaryChunkReader {
-  constructor(options) {
-    _defineProperty(this, "offset", void 0);
-
-    _defineProperty(this, "arrayBuffers", void 0);
-
-    _defineProperty(this, "ended", void 0);
-
-    _defineProperty(this, "maxRewindBytes", void 0);
-
-    const {
-      maxRewindBytes = 0
-    } = options || {};
-    this.offset = 0;
-    this.arrayBuffers = [];
-    this.ended = false;
-    this.maxRewindBytes = maxRewindBytes;
-  }
-
-  write(arrayBuffer) {
-    this.arrayBuffers.push(arrayBuffer);
-  }
-
-  end() {
-    this.arrayBuffers = [];
-    this.ended = true;
-  }
-
-  hasAvailableBytes(bytes) {
-    let bytesAvailable = -this.offset;
-
-    for (const arrayBuffer of this.arrayBuffers) {
-      bytesAvailable += arrayBuffer.byteLength;
-
-      if (bytesAvailable >= bytes) {
-        return true;
-      }
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class BinaryChunkReader {
+    constructor(options) {
+        const { maxRewindBytes = 0 } = options || {};
+        /** current global offset into current array buffer*/
+        this.offset = 0;
+        /** current buffer from iterator */
+        this.arrayBuffers = [];
+        this.ended = false;
+        /** bytes behind offset to hold on to */
+        this.maxRewindBytes = maxRewindBytes;
     }
-
-    return false;
-  }
-
-  findBufferOffsets(bytes) {
-    let offset = -this.offset;
-    const selectedBuffers = [];
-
-    for (let i = 0; i < this.arrayBuffers.length; i++) {
-      const buf = this.arrayBuffers[i];
-
-      if (offset + buf.byteLength <= 0) {
-        offset += buf.byteLength;
-        continue;
-      }
-
-      const start = offset <= 0 ? Math.abs(offset) : 0;
-      let end;
-
-      if (start + bytes <= buf.byteLength) {
-        end = start + bytes;
-        selectedBuffers.push([i, [start, end]]);
-        return selectedBuffers;
-      }
-
-      end = buf.byteLength;
-      selectedBuffers.push([i, [start, end]]);
-      bytes -= buf.byteLength - start;
-      offset += buf.byteLength;
+    /**
+     * @param arrayBuffer
+     */
+    write(arrayBuffer) {
+        this.arrayBuffers.push(arrayBuffer);
     }
-
-    return null;
-  }
-
-  getDataView(bytes) {
-    const bufferOffsets = this.findBufferOffsets(bytes);
-
-    if (!bufferOffsets && this.ended) {
-      throw new Error('binary data exhausted');
+    end() {
+        this.arrayBuffers = [];
+        this.ended = true;
     }
-
-    if (!bufferOffsets) {
-      return null;
+    /**
+     * Has enough bytes available in array buffers
+     *
+     * @param bytes Number of bytes
+     * @return boolean
+     */
+    hasAvailableBytes(bytes) {
+        let bytesAvailable = -this.offset;
+        for (const arrayBuffer of this.arrayBuffers) {
+            bytesAvailable += arrayBuffer.byteLength;
+            if (bytesAvailable >= bytes) {
+                return true;
+            }
+        }
+        return false;
     }
-
-    if (bufferOffsets.length === 1) {
-      const [bufferIndex, [start, end]] = bufferOffsets[0];
-      const arrayBuffer = this.arrayBuffers[bufferIndex];
-      const view = new DataView(arrayBuffer, start, end - start);
-      this.offset += bytes;
-      this.disposeBuffers();
-      return view;
+    /**
+     * Find offsets of byte ranges within this.arrayBuffers
+     *
+     * @param  bytes Byte length to read
+     * @return Arrays with byte ranges pointing to this.arrayBuffers, Output type is nested array, e.g. [ [0, [1, 2]], ...]
+     */
+    findBufferOffsets(bytes) {
+        let offset = -this.offset;
+        const selectedBuffers = [];
+        for (let i = 0; i < this.arrayBuffers.length; i++) {
+            const buf = this.arrayBuffers[i];
+            // Current buffer isn't long enough to reach global offset
+            if (offset + buf.byteLength <= 0) {
+                offset += buf.byteLength;
+                // eslint-disable-next-line no-continue
+                continue;
+            }
+            // Find start/end offsets for this buffer
+            // When offset < 0, need to skip over Math.abs(offset) bytes
+            // When offset > 0, implies bytes in previous buffer, start at 0
+            const start = offset <= 0 ? Math.abs(offset) : 0;
+            let end;
+            // Length of requested bytes is contained in current buffer
+            if (start + bytes <= buf.byteLength) {
+                end = start + bytes;
+                selectedBuffers.push([i, [start, end]]);
+                return selectedBuffers;
+            }
+            // Will need to look into next buffer
+            end = buf.byteLength;
+            selectedBuffers.push([i, [start, end]]);
+            // Need to read fewer bytes in next iter
+            bytes -= buf.byteLength - start;
+            offset += buf.byteLength;
+        }
+        // Should only finish loop if exhausted all arrays
+        return null;
     }
-
-    const view = new DataView(this._combineArrayBuffers(bufferOffsets));
-    this.offset += bytes;
-    this.disposeBuffers();
-    return view;
-  }
-
-  disposeBuffers() {
-    while (this.arrayBuffers.length > 0 && this.offset - this.maxRewindBytes >= this.arrayBuffers[0].byteLength) {
-      this.offset -= this.arrayBuffers[0].byteLength;
-      this.arrayBuffers.shift();
+    /**
+     * Get the required number of bytes from the iterator
+     *
+     * @param bytes Number of bytes
+     * @return DataView with data
+     */
+    getDataView(bytes) {
+        const bufferOffsets = this.findBufferOffsets(bytes);
+        // return `null` if not enough data, except if end() already called, in
+        // which case throw an error.
+        if (!bufferOffsets && this.ended) {
+            throw new Error('binary data exhausted');
+        }
+        if (!bufferOffsets) {
+            // @ts-ignore
+            return null;
+        }
+        // If only one arrayBuffer needed, return DataView directly
+        if (bufferOffsets.length === 1) {
+            const [bufferIndex, [start, end]] = bufferOffsets[0];
+            const arrayBuffer = this.arrayBuffers[bufferIndex];
+            const view = new DataView(arrayBuffer, start, end - start);
+            this.offset += bytes;
+            this.disposeBuffers();
+            return view;
+        }
+        // Concatenate portions of multiple ArrayBuffers
+        const view = new DataView(this._combineArrayBuffers(bufferOffsets));
+        this.offset += bytes;
+        this.disposeBuffers();
+        return view;
     }
-  }
-
-  _combineArrayBuffers(bufferOffsets) {
-    let byteLength = 0;
-
-    for (const bufferOffset of bufferOffsets) {
-      const [start, end] = bufferOffset[1];
-      byteLength += end - start;
+    /**
+     * Dispose of old array buffers
+     */
+    disposeBuffers() {
+        while (this.arrayBuffers.length > 0 &&
+            this.offset - this.maxRewindBytes >= this.arrayBuffers[0].byteLength) {
+            this.offset -= this.arrayBuffers[0].byteLength;
+            this.arrayBuffers.shift();
+        }
     }
-
-    const result = new Uint8Array(byteLength);
-    let resultOffset = 0;
-
-    for (const bufferOffset of bufferOffsets) {
-      const [bufferIndex, [start, end]] = bufferOffset;
-      const sourceArray = new Uint8Array(this.arrayBuffers[bufferIndex]);
-      result.set(sourceArray.subarray(start, end), resultOffset);
-      resultOffset += end - start;
+    /**
+     * Copy multiple ArrayBuffers into one contiguous ArrayBuffer
+     *
+     * In contrast to concatenateArrayBuffers, this only copies the necessary
+     * portions of the source arrays, rather than first copying the entire arrays
+     * then taking a part of them.
+     *
+     * @param bufferOffsets List of internal array offsets
+     * @return New contiguous ArrayBuffer
+     */
+    _combineArrayBuffers(bufferOffsets) {
+        let byteLength = 0;
+        for (const bufferOffset of bufferOffsets) {
+            const [start, end] = bufferOffset[1];
+            byteLength += end - start;
+        }
+        const result = new Uint8Array(byteLength);
+        // Copy the subarrays
+        let resultOffset = 0;
+        for (const bufferOffset of bufferOffsets) {
+            const [bufferIndex, [start, end]] = bufferOffset;
+            const sourceArray = new Uint8Array(this.arrayBuffers[bufferIndex]);
+            result.set(sourceArray.subarray(start, end), resultOffset);
+            resultOffset += end - start;
+        }
+        return result.buffer;
+    }
+    /**
+     * @param bytes
+     */
+    skip(bytes) {
+        this.offset += bytes;
+    }
+    /**
+     * @param bytes
+     */
+    rewind(bytes) {
+        // TODO - only works if offset is already set
+        this.offset -= bytes;
     }
-
-    return result.buffer;
-  }
-
-  skip(bytes) {
-    this.offset += bytes;
-  }
-
-  rewind(bytes) {
-    this.offset -= bytes;
-  }
-
 }
-//# sourceMappingURL=binary-chunk-reader.js.map
+exports.default = BinaryChunkReader;

package/dist/lib/streaming/binary-reader.d.ts

@@ -0,0 +1,32 @@
+export default class BinaryReader {
+    offset: number;
+    arrayBuffer: ArrayBuffer;
+    constructor(arrayBuffer: ArrayBuffer);
+    /**
+     * Checks if there are available bytes in data
+     *
+     * @param bytes
+     * @returns boolean
+     */
+    hasAvailableBytes(bytes: number): boolean;
+    /**
+     * Get the required number of bytes from the iterator
+     *
+     * @param bytes
+     * @returns Dataview
+     */
+    getDataView(bytes: number): DataView;
+    /**
+     * Skipping
+     *
+     * @param bytes
+     */
+    skip(bytes: number): void;
+    /**
+     * Rewinding
+     *
+     * @param bytes
+     */
+    rewind(bytes: number): void;
+}
+//# sourceMappingURL=binary-reader.d.ts.map

package/dist/lib/streaming/binary-reader.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"binary-reader.d.ts","sourceRoot":"","sources":["../../../src/lib/streaming/binary-reader.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,OAAO,OAAO,YAAY;IAC/B,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,EAAE,WAAW,CAAC;gBAEb,WAAW,EAAE,WAAW;IAMpC;;;;;OAKG;IACH,iBAAiB,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO;IAIzC;;;;;OAKG;IACH,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,QAAQ;IAYpC;;;;OAIG;IACH,IAAI,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAIzB;;;;OAIG;IACH,MAAM,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;CAG5B"}

package/dist/lib/streaming/binary-reader.js

@@ -1,35 +1,52 @@
-import _defineProperty from "@babel/runtime/helpers/esm/defineProperty";
-export default class BinaryReader {
-  constructor(arrayBuffer) {
-    _defineProperty(this, "offset", void 0);
-
-    _defineProperty(this, "arrayBuffer", void 0);
-
-    this.offset = 0;
-    this.arrayBuffer = arrayBuffer;
-  }
-
-  hasAvailableBytes(bytes) {
-    return this.arrayBuffer.byteLength - this.offset >= bytes;
-  }
-
-  getDataView(bytes) {
-    if (bytes && !this.hasAvailableBytes(bytes)) {
-      throw new Error('binary data exhausted');
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class BinaryReader {
+    constructor(arrayBuffer) {
+        /** current global (stream) offset */
+        this.offset = 0;
+        /** current buffer from iterator */
+        this.arrayBuffer = arrayBuffer;
+    }
+    /**
+     * Checks if there are available bytes in data
+     *
+     * @param bytes
+     * @returns boolean
+     */
+    hasAvailableBytes(bytes) {
+        return this.arrayBuffer.byteLength - this.offset >= bytes;
+    }
+    /**
+     * Get the required number of bytes from the iterator
+     *
+     * @param bytes
+     * @returns Dataview
+     */
+    getDataView(bytes) {
+        if (bytes && !this.hasAvailableBytes(bytes)) {
+            throw new Error('binary data exhausted');
+        }
+        const dataView = bytes
+            ? new DataView(this.arrayBuffer, this.offset, bytes)
+            : new DataView(this.arrayBuffer, this.offset);
+        this.offset += bytes;
+        return dataView;
+    }
+    /**
+     * Skipping
+     *
+     * @param bytes
+     */
+    skip(bytes) {
+        this.offset += bytes;
+    }
+    /**
+     * Rewinding
+     *
+     * @param bytes
+     */
+    rewind(bytes) {
+        this.offset -= bytes;
     }
-
-    const dataView = bytes ? new DataView(this.arrayBuffer, this.offset, bytes) : new DataView(this.arrayBuffer, this.offset);
-    this.offset += bytes;
-    return dataView;
-  }
-
-  skip(bytes) {
-    this.offset += bytes;
-  }
-
-  rewind(bytes) {
-    this.offset -= bytes;
-  }
-
 }
-//# sourceMappingURL=binary-reader.js.map
+exports.default = BinaryReader;

package/dist/lib/streaming/zip-batch-iterators.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Zip two iterators together
+ *
+ * @param iterator1
+ * @param iterator2
+ */
+export declare function zipBatchIterators(iterator1: AsyncIterator<any[]>, iterator2: AsyncIterator<any[]>): AsyncGenerator<number[][], void, unknown>;
+//# sourceMappingURL=zip-batch-iterators.d.ts.map

package/dist/lib/streaming/zip-batch-iterators.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"zip-batch-iterators.d.ts","sourceRoot":"","sources":["../../../src/lib/streaming/zip-batch-iterators.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,wBAAuB,iBAAiB,CACtC,SAAS,EAAE,aAAa,CAAC,GAAG,EAAE,CAAC,EAC/B,SAAS,EAAE,aAAa,CAAC,GAAG,EAAE,CAAC,GAC9B,cAAc,CAAC,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,OAAO,CAAC,CA8B3C"}

package/dist/lib/streaming/zip-batch-iterators.js

@@ -1,52 +1,61 @@
-export async function* zipBatchIterators(iterator1, iterator2) {
-  let batch1 = [];
-  let batch2 = [];
-  let iterator1Done = false;
-  let iterator2Done = false;
-
-  while (!iterator1Done && !iterator2Done) {
-    if (batch1.length === 0 && !iterator1Done) {
-      const {
-        value,
-        done
-      } = await iterator1.next();
-
-      if (done) {
-        iterator1Done = true;
-      } else {
-        batch1 = value;
-      }
-    } else if (batch2.length === 0 && !iterator2Done) {
-      const {
-        value,
-        done
-      } = await iterator2.next();
-
-      if (done) {
-        iterator2Done = true;
-      } else {
-        batch2 = value;
-      }
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.zipBatchIterators = void 0;
+/**
+ * Zip two iterators together
+ *
+ * @param iterator1
+ * @param iterator2
+ */
+async function* zipBatchIterators(iterator1, iterator2) {
+    let batch1 = [];
+    let batch2 = [];
+    let iterator1Done = false;
+    let iterator2Done = false;
+    // TODO - one could let all iterators flow at full speed using `Promise.race`
+    // however we might end up with a big temporary buffer
+    while (!iterator1Done && !iterator2Done) {
+        if (batch1.length === 0 && !iterator1Done) {
+            const { value, done } = await iterator1.next();
+            if (done) {
+                iterator1Done = true;
+            }
+            else {
+                batch1 = value;
+            }
+        }
+        else if (batch2.length === 0 && !iterator2Done) {
+            const { value, done } = await iterator2.next();
+            if (done) {
+                iterator2Done = true;
+            }
+            else {
+                batch2 = value;
+            }
+        }
+        const batch = extractBatch(batch1, batch2);
+        if (batch) {
+            yield batch;
+        }
     }
-
-    const batch = extractBatch(batch1, batch2);
-
-    if (batch) {
-      yield batch;
-    }
-  }
 }
-
+exports.zipBatchIterators = zipBatchIterators;
+/**
+ * Extract batch of same length from two batches
+ *
+ * @param batch1
+ * @param batch2
+ * @return array | null
+ */
 function extractBatch(batch1, batch2) {
-  const batchLength = Math.min(batch1.length, batch2.length);
-
-  if (batchLength === 0) {
-    return null;
-  }
-
-  const batch = [batch1.slice(0, batchLength), batch2.slice(0, batchLength)];
-  batch1.splice(0, batchLength);
-  batch2.splice(0, batchLength);
-  return batch;
+    const batchLength = Math.min(batch1.length, batch2.length);
+    if (batchLength === 0) {
+        return null;
+    }
+    // Non interleaved arrays
+    const batch = [batch1.slice(0, batchLength), batch2.slice(0, batchLength)];
+    // Modify the 2 batches
+    batch1.splice(0, batchLength);
+    batch2.splice(0, batchLength);
+    return batch;
 }
-//# sourceMappingURL=zip-batch-iterators.js.map

package/dist/shapefile-loader.d.ts

@@ -0,0 +1,26 @@
+import type { LoaderWithParser } from '@loaders.gl/loader-utils';
+import { parseShapefile, parseShapefileInBatches } from './lib/parsers/parse-shapefile';
+/**
+ * Shapefile loader
+ * @note Shapefile is multifile format and requires providing additional files
+ */
+export declare const ShapefileLoader: {
+    name: string;
+    id: string;
+    module: string;
+    version: any;
+    category: string;
+    extensions: string[];
+    mimeTypes: string[];
+    tests: ArrayBufferLike[];
+    options: {
+        shapefile: {};
+        shp: {
+            _maxDimensions: number;
+        };
+    };
+    parse: typeof parseShapefile;
+    parseInBatches: typeof parseShapefileInBatches;
+};
+export declare const _typecheckShapefileLoader: LoaderWithParser;
+//# sourceMappingURL=shapefile-loader.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"shapefile-loader.d.ts","sourceRoot":"","sources":["../src/shapefile-loader.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,gBAAgB,EAAC,MAAM,0BAA0B,CAAC;AAE/D,OAAO,EAAC,cAAc,EAAE,uBAAuB,EAAC,MAAM,+BAA+B,CAAC;AAMtF;;;GAGG;AACH,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;;;CAiB3B,CAAC;AAEF,eAAO,MAAM,yBAAyB,EAAE,gBAAkC,CAAC"}

package/dist/shapefile-loader.js

@@ -1,23 +1,31 @@
-import { SHP_MAGIC_NUMBER } from './shp-loader';
-import { parseShapefile, parseShapefileInBatches } from './lib/parsers/parse-shapefile';
-const VERSION = typeof "4.0.0-alpha.1" !== 'undefined' ? "4.0.0-alpha.1" : 'latest';
-export const ShapefileLoader = {
-  name: 'Shapefile',
-  id: 'shapefile',
-  module: 'shapefile',
-  version: VERSION,
-  category: 'geometry',
-  extensions: ['shp'],
-  mimeTypes: ['application/octet-stream'],
-  tests: [new Uint8Array(SHP_MAGIC_NUMBER).buffer],
-  options: {
-    shapefile: {},
-    shp: {
-      _maxDimensions: 4
-    }
-  },
-  parse: parseShapefile,
-  parseInBatches: parseShapefileInBatches
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports._typecheckShapefileLoader = exports.ShapefileLoader = void 0;
+const shp_loader_1 = require("./shp-loader");
+const parse_shapefile_1 = require("./lib/parsers/parse-shapefile");
+// __VERSION__ is injected by babel-plugin-version-inline
+// @ts-ignore TS2304: Cannot find name '__VERSION__'.
+const VERSION = typeof __VERSION__ !== 'undefined' ? __VERSION__ : 'latest';
+/**
+ * Shapefile loader
+ * @note Shapefile is multifile format and requires providing additional files
+ */
+exports.ShapefileLoader = {
+    name: 'Shapefile',
+    id: 'shapefile',
+    module: 'shapefile',
+    version: VERSION,
+    category: 'geometry',
+    extensions: ['shp'],
+    mimeTypes: ['application/octet-stream'],
+    tests: [new Uint8Array(shp_loader_1.SHP_MAGIC_NUMBER).buffer],
+    options: {
+        shapefile: {},
+        shp: {
+            _maxDimensions: 4
+        }
+    },
+    parse: parse_shapefile_1.parseShapefile,
+    parseInBatches: parse_shapefile_1.parseShapefileInBatches
 };
-export const _typecheckShapefileLoader = ShapefileLoader;
-//# sourceMappingURL=shapefile-loader.js.map
+exports._typecheckShapefileLoader = exports.ShapefileLoader;

package/dist/shp-loader.d.ts

@@ -0,0 +1,9 @@
+import type { Loader, LoaderWithParser } from '@loaders.gl/loader-utils';
+export declare const SHP_MAGIC_NUMBER: number[];
+/**
+ * SHP file loader
+ */
+export declare const SHPWorkerLoader: Loader;
+/** SHP file loader */
+export declare const SHPLoader: LoaderWithParser;
+//# sourceMappingURL=shp-loader.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"shp-loader.d.ts","sourceRoot":"","sources":["../src/shp-loader.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,MAAM,EAAE,gBAAgB,EAAC,MAAM,0BAA0B,CAAC;AAOvE,eAAO,MAAM,gBAAgB,UAA2B,CAAC;AAEzD;;GAEG;AACH,eAAO,MAAM,eAAe,EAAE,MAgB7B,CAAC;AAEF,sBAAsB;AACtB,eAAO,MAAM,SAAS,EAAE,gBAKvB,CAAC"}