@loaders.gl/shapefile 4.0.0-beta.1 → 4.0.0-beta.3

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

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

package/dist/{esm/dbf-loader.js → dbf-loader.js}

@@ -1,5 +1,5 @@
-import { parseDBF, parseDBFInBatches } from './lib/parsers/parse-dbf';
-const VERSION = typeof "4.0.0-beta.1" !== 'undefined' ? "4.0.0-beta.1" : 'latest';
+import { parseDBF, parseDBFInBatches } from "./lib/parsers/parse-dbf.js";
+const VERSION = typeof __VERSION__ !== 'undefined' ? __VERSION__ : 'latest';
 export const DBFWorkerLoader = {
   name: 'DBF',
   id: 'dbf',

package/dist/dbf-loader.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dbf-loader.js","names":["parseDBF","parseDBFInBatches","VERSION","__VERSION__","DBFWorkerLoader","name","id","module","version","worker","category","extensions","mimeTypes","options","dbf","encoding","DBFLoader","parse","arrayBuffer","parseSync","parseInBatches","arrayBufferIterator"],"sources":["../src/dbf-loader.ts"],"sourcesContent":["import type {Loader, LoaderWithParser} from '@loaders.gl/loader-utils';\nimport {parseDBF, parseDBFInBatches} from './lib/parsers/parse-dbf';\n\n// __VERSION__ is injected by babel-plugin-version-inline\n// @ts-ignore TS2304: Cannot find name '__VERSION__'.\nconst VERSION = typeof __VERSION__ !== 'undefined' ? __VERSION__ : 'latest';\n\n/**\n * DBFLoader - DBF files are used to contain non-geometry columns in Shapefiles\n */\nexport const DBFWorkerLoader: Loader = {\n  name: 'DBF',\n  id: 'dbf',\n  module: 'shapefile',\n  version: VERSION,\n  worker: true,\n  category: 'table',\n  extensions: ['dbf'],\n  mimeTypes: ['application/x-dbf'],\n  options: {\n    dbf: {\n      encoding: 'latin1'\n    }\n  }\n};\n\n/** DBF file loader */\nexport const DBFLoader: LoaderWithParser = {\n  ...DBFWorkerLoader,\n  parse: async (arrayBuffer, options) => parseDBF(arrayBuffer, options),\n  parseSync: parseDBF,\n  parseInBatches(arrayBufferIterator: AsyncIterable<ArrayBuffer> | Iterable<ArrayBuffer>, options) {\n    return parseDBFInBatches(arrayBufferIterator, options);\n  }\n};\n"],"mappings":"SACQA,QAAQ,EAAEC,iBAAiB;AAInC,MAAMC,OAAO,GAAG,OAAOC,WAAW,KAAK,WAAW,GAAGA,WAAW,GAAG,QAAQ;AAK3E,OAAO,MAAMC,eAAuB,GAAG;EACrCC,IAAI,EAAE,KAAK;EACXC,EAAE,EAAE,KAAK;EACTC,MAAM,EAAE,WAAW;EACnBC,OAAO,EAAEN,OAAO;EAChBO,MAAM,EAAE,IAAI;EACZC,QAAQ,EAAE,OAAO;EACjBC,UAAU,EAAE,CAAC,KAAK,CAAC;EACnBC,SAAS,EAAE,CAAC,mBAAmB,CAAC;EAChCC,OAAO,EAAE;IACPC,GAAG,EAAE;MACHC,QAAQ,EAAE;IACZ;EACF;AACF,CAAC;AAGD,OAAO,MAAMC,SAA2B,GAAG;EACzC,GAAGZ,eAAe;EAClBa,KAAK,EAAE,MAAAA,CAAOC,WAAW,EAAEL,OAAO,KAAKb,QAAQ,CAACkB,WAAW,EAAEL,OAAO,CAAC;EACrEM,SAAS,EAAEnB,QAAQ;EACnBoB,cAAcA,CAACC,mBAAuE,EAAER,OAAO,EAAE;IAC/F,OAAOZ,iBAAiB,CAACoB,mBAAmB,EAAER,OAAO,CAAC;EACxD;AACF,CAAC"}

package/dist/dbf-worker.js

@@ -1,3 +1,4 @@
+"use strict";
 (() => {
   // src/lib/streaming/binary-chunk-reader.ts
   var BinaryChunkReader = class {
@@ -8,6 +9,9 @@
       this.ended = false;
       this.maxRewindBytes = maxRewindBytes;
     }
+    /**
+     * @param arrayBuffer
+     */
     write(arrayBuffer) {
       this.arrayBuffers.push(arrayBuffer);
     }
@@ -15,6 +19,12 @@
       this.arrayBuffers = [];
       this.ended = true;
     }
+    /**
+     * 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) {
@@ -25,6 +35,12 @@
       }
       return false;
     }
+    /**
+     * 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 = [];
@@ -48,6 +64,12 @@
       }
       return null;
     }
+    /**
+     * 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);
       if (!bufferOffsets && this.ended) {
@@ -69,12 +91,25 @@
       this.disposeBuffers();
       return view;
     }
+    /**
+     * 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();
       }
     }
+    /**
+     * 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) {
@@ -91,9 +126,15 @@
       }
       return result.buffer;
     }
+    /**
+     * @param bytes
+     */
     skip(bytes) {
       this.offset += bytes;
     }
+    /**
+     * @param bytes
+     */
     rewind(bytes) {
       this.offset -= bytes;
     }
@@ -102,23 +143,18 @@
   // src/lib/parsers/parse-dbf.ts
   var LITTLE_ENDIAN = true;
   var DBF_HEADER_SIZE = 32;
-  var STATE;
-  (function(STATE2) {
-    STATE2[STATE2["START"] = 0] = "START";
-    STATE2[STATE2["FIELD_DESCRIPTORS"] = 1] = "FIELD_DESCRIPTORS";
-    STATE2[STATE2["FIELD_PROPERTIES"] = 2] = "FIELD_PROPERTIES";
-    STATE2[STATE2["END"] = 3] = "END";
-    STATE2[STATE2["ERROR"] = 4] = "ERROR";
-  })(STATE || (STATE = {}));
   var DBFParser = class {
     constructor(options) {
       this.binaryReader = new BinaryChunkReader();
-      this.state = 0;
+      this.state = 0 /* START */;
       this.result = {
         data: []
       };
       this.textDecoder = new TextDecoder(options.encoding);
     }
+    /**
+     * @param arrayBuffer
+     */
     write(arrayBuffer) {
       this.binaryReader.write(arrayBuffer);
       this.state = parseState(this.state, this.result, this.binaryReader, this.textDecoder);
@@ -126,8 +162,8 @@
     end() {
       this.binaryReader.end();
       this.state = parseState(this.state, this.result, this.binaryReader, this.textDecoder);
-      if (this.state !== 3) {
-        this.state = 4;
+      if (this.state !== 3 /* END */) {
+        this.state = 4 /* ERROR */;
         this.result.error = "DBF incomplete file";
       }
     }
@@ -179,10 +215,10 @@
     while (true) {
       try {
         switch (state) {
-          case 4:
-          case 3:
+          case 4 /* ERROR */:
+          case 3 /* END */:
             return state;
-          case 0:
+          case 0 /* START */:
             const dataView = binaryReader.getDataView(DBF_HEADER_SIZE);
             if (!dataView) {
               return state;
@@ -193,10 +229,13 @@
               rowsTotal: result.dbfHeader.nRecords,
               rows: 0
             };
-            state = 1;
+            state = 1 /* FIELD_DESCRIPTORS */;
             break;
-          case 1:
-            const fieldDescriptorView = binaryReader.getDataView(result.dbfHeader.headerLength - DBF_HEADER_SIZE);
+          case 1 /* FIELD_DESCRIPTORS */:
+            const fieldDescriptorView = binaryReader.getDataView(
+              // @ts-ignore
+              result.dbfHeader.headerLength - DBF_HEADER_SIZE
+            );
             if (!fieldDescriptorView) {
               return state;
             }
@@ -205,10 +244,10 @@
               fields: result.dbfFields.map((dbfField) => makeField(dbfField)),
               metadata: {}
             };
-            state = 2;
+            state = 2 /* FIELD_PROPERTIES */;
             binaryReader.skip(1);
             break;
-          case 2:
+          case 2 /* FIELD_PROPERTIES */:
             const { recordLength = 0, nRecords = 0 } = result?.dbfHeader || {};
             while (result.data.length < nRecords) {
               const recordView = binaryReader.getDataView(recordLength - 1);
@@ -220,15 +259,15 @@
               result.data.push(row);
               result.progress.rows = result.data.length;
             }
-            state = 3;
+            state = 3 /* END */;
             break;
           default:
-            state = 4;
+            state = 4 /* ERROR */;
             result.error = `illegal parser state ${state}`;
             return state;
         }
       } catch (error) {
-        state = 4;
+        state = 4 /* ERROR */;
         result.error = `DBF parsing failed: ${error.message}`;
         return state;
       }
@@ -236,12 +275,17 @@
   }
   function parseDBFHeader(headerView) {
     return {
+      // Last updated date
       year: headerView.getUint8(1) + 1900,
       month: headerView.getUint8(2),
       day: headerView.getUint8(3),
+      // Number of records in data file
       nRecords: headerView.getUint32(4, LITTLE_ENDIAN),
+      // Length of header in bytes
       headerLength: headerView.getUint16(8, LITTLE_ENDIAN),
+      // Length of each record
       recordLength: headerView.getUint16(10, LITTLE_ENDIAN),
+      // Not sure if this is usually set
       languageDriver: headerView.getUint8(29)
     };
   }
@@ -265,7 +309,9 @@
     const out = {};
     let offset = 0;
     for (const field of fields) {
-      const text = textDecoder.decode(new Uint8Array(view.buffer, view.byteOffset + offset, field.fieldLength));
+      const text = textDecoder.decode(
+        new Uint8Array(view.buffer, view.byteOffset + offset, field.fieldLength)
+      );
       out[field.name] = parseField(text, field.dataType);
       offset += field.fieldLength;
     }
@@ -326,7 +372,7 @@
   }
 
   // src/dbf-loader.ts
-  var VERSION = true ? "4.0.0-beta.1" : "latest";
+  var VERSION = true ? "4.0.0-beta.3" : "latest";
   var DBFWorkerLoader = {
     name: "DBF",
     id: "dbf",
@@ -353,7 +399,7 @@
 
   // ../worker-utils/src/lib/worker-utils/get-transfer-list.ts
   function getTransferList(object, recursive = true, transfers) {
-    const transfersSet = transfers || new Set();
+    const transfersSet = transfers || /* @__PURE__ */ new Set();
     if (!object) {
     } else if (isTransferable(object)) {
       transfersSet.add(object);
@@ -396,11 +442,15 @@
     }
     return parentPort;
   }
-  var onMessageWrapperMap = new Map();
+  var onMessageWrapperMap = /* @__PURE__ */ new Map();
   var WorkerBody = class {
+    /** Check that we are actually in a worker thread */
     static inWorkerThread() {
       return typeof self !== "undefined" || Boolean(getParentPort());
     }
+    /*
+     * (type: WorkerMessageType, payload: WorkerMessagePayload) => any
+     */
     static set onmessage(onMessage) {
       function handleMessage(message) {
         const parentPort3 = getParentPort();
@@ -444,6 +494,11 @@
         globalThis.removeEventListener("message", onMessageWrapper);
       }
     }
+    /**
+     * Send a message from a worker to creating thread (main thread)
+     * @param type
+     * @param payload
+     */
     static postMessage(type, payload) {
       const data = { source: "loaders.gl", type, payload };
       const transferList = getTransferList(payload);
@@ -475,6 +530,7 @@
               loader,
               arrayBuffer: input,
               options,
+              // @ts-expect-error fetch missing
               context: {
                 ...context,
                 _parse: parseOnMainThread