@loaders.gl/shapefile 4.0.0-alpha.5 → 4.0.0-alpha.6

package/dist/lib/parsers/parse-shp-geometry.js

@@ -1,234 +1,287 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseRecord = void 0;
 const LITTLE_ENDIAN = true;
-export function parseRecord(view, options) {
-  const {
-    _maxDimensions
-  } = (options === null || options === void 0 ? void 0 : options.shp) || {};
-  let offset = 0;
-  const type = view.getInt32(offset, LITTLE_ENDIAN);
-  offset += Int32Array.BYTES_PER_ELEMENT;
-
-  switch (type) {
-    case 0:
-      return parseNull();
-
-    case 1:
-      return parsePoint(view, offset, Math.min(2, _maxDimensions));
-
-    case 3:
-      return parsePoly(view, offset, Math.min(2, _maxDimensions), 'LineString');
-
-    case 5:
-      return parsePoly(view, offset, Math.min(2, _maxDimensions), 'Polygon');
-
-    case 8:
-      return parseMultiPoint(view, offset, Math.min(2, _maxDimensions));
-
-    case 11:
-      return parsePoint(view, offset, Math.min(4, _maxDimensions));
-
-    case 13:
-      return parsePoly(view, offset, Math.min(4, _maxDimensions), 'LineString');
-
-    case 15:
-      return parsePoly(view, offset, Math.min(4, _maxDimensions), 'Polygon');
-
-    case 18:
-      return parseMultiPoint(view, offset, Math.min(4, _maxDimensions));
-
-    case 21:
-      return parsePoint(view, offset, Math.min(3, _maxDimensions));
-
-    case 23:
-      return parsePoly(view, offset, Math.min(3, _maxDimensions), 'LineString');
-
-    case 25:
-      return parsePoly(view, offset, Math.min(3, _maxDimensions), 'Polygon');
-
-    case 28:
-      return parseMultiPoint(view, offset, Math.min(3, _maxDimensions));
-
-    default:
-      throw new Error("unsupported shape type: ".concat(type));
-  }
+/**
+ * Parse individual record
+ *
+ * @param view Record data
+ * @return Binary Geometry Object
+ */
+// eslint-disable-next-line complexity
+function parseRecord(view, options) {
+    const { _maxDimensions = 4 } = options?.shp || {};
+    let offset = 0;
+    const type = view.getInt32(offset, LITTLE_ENDIAN);
+    offset += Int32Array.BYTES_PER_ELEMENT;
+    switch (type) {
+        case 0:
+            // Null Shape
+            return parseNull();
+        case 1:
+            // Point
+            return parsePoint(view, offset, Math.min(2, _maxDimensions));
+        case 3:
+            // PolyLine
+            return parsePoly(view, offset, Math.min(2, _maxDimensions), 'LineString');
+        case 5:
+            // Polygon
+            return parsePoly(view, offset, Math.min(2, _maxDimensions), 'Polygon');
+        case 8:
+            // MultiPoint
+            return parseMultiPoint(view, offset, Math.min(2, _maxDimensions));
+        // GeometryZ can have 3 or 4 dimensions, since the M is not required to
+        // exist
+        case 11:
+            // PointZ
+            return parsePoint(view, offset, Math.min(4, _maxDimensions));
+        case 13:
+            // PolyLineZ
+            return parsePoly(view, offset, Math.min(4, _maxDimensions), 'LineString');
+        case 15:
+            // PolygonZ
+            return parsePoly(view, offset, Math.min(4, _maxDimensions), 'Polygon');
+        case 18:
+            // MultiPointZ
+            return parseMultiPoint(view, offset, Math.min(4, _maxDimensions));
+        case 21:
+            // PointM
+            return parsePoint(view, offset, Math.min(3, _maxDimensions));
+        case 23:
+            // PolyLineM
+            return parsePoly(view, offset, Math.min(3, _maxDimensions), 'LineString');
+        case 25:
+            // PolygonM
+            return parsePoly(view, offset, Math.min(3, _maxDimensions), 'Polygon');
+        case 28:
+            // MultiPointM
+            return parseMultiPoint(view, offset, Math.min(3, _maxDimensions));
+        default:
+            throw new Error(`unsupported shape type: ${type}`);
+    }
 }
-
+exports.parseRecord = parseRecord;
+// TODO handle null
+/**
+ * Parse Null geometry
+ *
+ * @return null
+ */
 function parseNull() {
-  return null;
+    return null;
 }
-
+/**
+ * Parse point geometry
+ *
+ * @param view Geometry data
+ * @param offset Offset in view
+ * @param dim Dimension size
+ */
 function parsePoint(view, offset, dim) {
-  let positions;
-  [positions, offset] = parsePositions(view, offset, 1, dim);
-  return {
-    positions: {
-      value: positions,
-      size: dim
-    },
-    type: 'Point'
-  };
+    let positions;
+    [positions, offset] = parsePositions(view, offset, 1, dim);
+    return {
+        positions: { value: positions, size: dim },
+        type: 'Point'
+    };
 }
-
+/**
+ * Parse MultiPoint geometry
+ *
+ * @param view Geometry data
+ * @param offset Offset in view
+ * @param dim Input dimension
+ * @return Binary geometry object
+ */
 function parseMultiPoint(view, offset, dim) {
-  offset += 4 * Float64Array.BYTES_PER_ELEMENT;
-  const nPoints = view.getInt32(offset, LITTLE_ENDIAN);
-  offset += Int32Array.BYTES_PER_ELEMENT;
-  let xyPositions = null;
-  let mPositions = null;
-  let zPositions = null;
-  [xyPositions, offset] = parsePositions(view, offset, nPoints, 2);
-
-  if (dim === 4) {
-    offset += 2 * Float64Array.BYTES_PER_ELEMENT;
-    [zPositions, offset] = parsePositions(view, offset, nPoints, 1);
-  }
-
-  if (dim >= 3) {
-    offset += 2 * Float64Array.BYTES_PER_ELEMENT;
-    [mPositions, offset] = parsePositions(view, offset, nPoints, 1);
-  }
-
-  const positions = concatPositions(xyPositions, mPositions, zPositions);
-  return {
-    positions: {
-      value: positions,
-      size: dim
-    },
-    type: 'Point'
-  };
-}
-
-function parsePoly(view, offset, dim, type) {
-  offset += 4 * Float64Array.BYTES_PER_ELEMENT;
-  const nParts = view.getInt32(offset, LITTLE_ENDIAN);
-  offset += Int32Array.BYTES_PER_ELEMENT;
-  const nPoints = view.getInt32(offset, LITTLE_ENDIAN);
-  offset += Int32Array.BYTES_PER_ELEMENT;
-  const bufferOffset = view.byteOffset + offset;
-  const bufferLength = nParts * Int32Array.BYTES_PER_ELEMENT;
-  const ringIndices = new Int32Array(nParts + 1);
-  ringIndices.set(new Int32Array(view.buffer.slice(bufferOffset, bufferOffset + bufferLength)));
-  ringIndices[nParts] = nPoints;
-  offset += nParts * Int32Array.BYTES_PER_ELEMENT;
-  let xyPositions = null;
-  let mPositions = null;
-  let zPositions = null;
-  [xyPositions, offset] = parsePositions(view, offset, nPoints, 2);
-
-  if (dim === 4) {
-    offset += 2 * Float64Array.BYTES_PER_ELEMENT;
-    [zPositions, offset] = parsePositions(view, offset, nPoints, 1);
-  }
-
-  if (dim >= 3) {
-    offset += 2 * Float64Array.BYTES_PER_ELEMENT;
-    [mPositions, offset] = parsePositions(view, offset, nPoints, 1);
-  }
-
-  const positions = concatPositions(xyPositions, mPositions, zPositions);
-
-  if (type === 'LineString') {
+    // skip parsing box
+    offset += 4 * Float64Array.BYTES_PER_ELEMENT;
+    const nPoints = view.getInt32(offset, LITTLE_ENDIAN);
+    offset += Int32Array.BYTES_PER_ELEMENT;
+    let xyPositions = null;
+    let mPositions = null;
+    let zPositions = null;
+    [xyPositions, offset] = parsePositions(view, offset, nPoints, 2);
+    // Parse Z coordinates
+    if (dim === 4) {
+        // skip parsing range
+        offset += 2 * Float64Array.BYTES_PER_ELEMENT;
+        [zPositions, offset] = parsePositions(view, offset, nPoints, 1);
+    }
+    // Parse M coordinates
+    if (dim >= 3) {
+        // skip parsing range
+        offset += 2 * Float64Array.BYTES_PER_ELEMENT;
+        [mPositions, offset] = parsePositions(view, offset, nPoints, 1);
+    }
+    const positions = concatPositions(xyPositions, mPositions, zPositions);
     return {
-      type,
-      positions: {
-        value: positions,
-        size: dim
-      },
-      pathIndices: {
-        value: ringIndices,
-        size: 1
-      }
+        positions: { value: positions, size: dim },
+        type: 'Point'
     };
-  }
-
-  const polygonIndices = [];
-
-  for (let i = 1; i < ringIndices.length; i++) {
-    const startRingIndex = ringIndices[i - 1];
-    const endRingIndex = ringIndices[i];
-    const ring = xyPositions.subarray(startRingIndex * 2, endRingIndex * 2);
-    const sign = getWindingDirection(ring);
-
-    if (sign > 0) {
-      polygonIndices.push(startRingIndex);
+}
+/**
+ * Polygon and PolyLine parsing
+ *
+ * @param view Geometry data
+ * @param offset Offset in view
+ * @param dim Input dimension
+ * @param type Either 'Polygon' or 'Polyline'
+ * @return Binary geometry object
+ */
+// eslint-disable-next-line max-statements
+function parsePoly(view, offset, dim, type) {
+    // skip parsing bounding box
+    offset += 4 * Float64Array.BYTES_PER_ELEMENT;
+    const nParts = view.getInt32(offset, LITTLE_ENDIAN);
+    offset += Int32Array.BYTES_PER_ELEMENT;
+    const nPoints = view.getInt32(offset, LITTLE_ENDIAN);
+    offset += Int32Array.BYTES_PER_ELEMENT;
+    // Create longer indices array by 1 because output format is expected to
+    // include the last index as the total number of positions
+    const bufferOffset = view.byteOffset + offset;
+    const bufferLength = nParts * Int32Array.BYTES_PER_ELEMENT;
+    const ringIndices = new Int32Array(nParts + 1);
+    ringIndices.set(new Int32Array(view.buffer.slice(bufferOffset, bufferOffset + bufferLength)));
+    ringIndices[nParts] = nPoints;
+    offset += nParts * Int32Array.BYTES_PER_ELEMENT;
+    let xyPositions = null;
+    let mPositions = null;
+    let zPositions = null;
+    [xyPositions, offset] = parsePositions(view, offset, nPoints, 2);
+    // Parse Z coordinates
+    if (dim === 4) {
+        // skip parsing range
+        offset += 2 * Float64Array.BYTES_PER_ELEMENT;
+        [zPositions, offset] = parsePositions(view, offset, nPoints, 1);
     }
-  }
-
-  polygonIndices.push(nPoints);
-  return {
-    type,
-    positions: {
-      value: positions,
-      size: dim
-    },
-    primitivePolygonIndices: {
-      value: ringIndices,
-      size: 1
-    },
-    polygonIndices: {
-      value: new Uint32Array(polygonIndices),
-      size: 1
+    // Parse M coordinates
+    if (dim >= 3) {
+        // skip parsing range
+        offset += 2 * Float64Array.BYTES_PER_ELEMENT;
+        [mPositions, offset] = parsePositions(view, offset, nPoints, 1);
     }
-  };
+    const positions = concatPositions(xyPositions, mPositions, zPositions);
+    // parsePoly only accepts type = LineString or Polygon
+    if (type === 'LineString') {
+        return {
+            type,
+            positions: { value: positions, size: dim },
+            pathIndices: { value: ringIndices, size: 1 }
+        };
+    }
+    // for every ring, determine sign of polygon
+    // Use only 2D positions for ring calc
+    const polygonIndices = [];
+    for (let i = 1; i < ringIndices.length; i++) {
+        const startRingIndex = ringIndices[i - 1];
+        const endRingIndex = ringIndices[i];
+        // @ts-ignore
+        const ring = xyPositions.subarray(startRingIndex * 2, endRingIndex * 2);
+        const sign = getWindingDirection(ring);
+        // A positive sign implies clockwise
+        // A clockwise ring is a filled ring
+        if (sign > 0) {
+            polygonIndices.push(startRingIndex);
+        }
+    }
+    polygonIndices.push(nPoints);
+    return {
+        type,
+        positions: { value: positions, size: dim },
+        primitivePolygonIndices: { value: ringIndices, size: 1 },
+        // TODO: Dynamically choose Uint32Array over Uint16Array only when
+        // necessary. I believe the implementation requires nPoints to be the
+        // largest value in the array, so you should be able to use Uint32Array only
+        // when nPoints > 65535.
+        polygonIndices: { value: new Uint32Array(polygonIndices), size: 1 }
+    };
 }
-
+/**
+ * Parse a contiguous block of positions into a Float64Array
+ *
+ * @param view  Geometry data
+ * @param offset  Offset in view
+ * @param nPoints Number of points
+ * @param dim     Input dimension
+ * @return Data and offset
+ */
 function parsePositions(view, offset, nPoints, dim) {
-  const bufferOffset = view.byteOffset + offset;
-  const bufferLength = nPoints * dim * Float64Array.BYTES_PER_ELEMENT;
-  return [new Float64Array(view.buffer.slice(bufferOffset, bufferOffset + bufferLength)), offset + bufferLength];
+    const bufferOffset = view.byteOffset + offset;
+    const bufferLength = nPoints * dim * Float64Array.BYTES_PER_ELEMENT;
+    return [
+        new Float64Array(view.buffer.slice(bufferOffset, bufferOffset + bufferLength)),
+        offset + bufferLength
+    ];
 }
-
+/**
+ * Concatenate and interleave positions arrays
+ * xy positions are interleaved; mPositions, zPositions are their own arrays
+ *
+ * @param xyPositions 2d positions
+ * @param mPositions  M positions
+ * @param zPositions  Z positions
+ * @return Combined interleaved positions
+ */
+// eslint-disable-next-line complexity
 function concatPositions(xyPositions, mPositions, zPositions) {
-  if (!(mPositions || zPositions)) {
-    return xyPositions;
-  }
-
-  let arrayLength = xyPositions.length;
-  let nDim = 2;
-
-  if (zPositions && zPositions.length) {
-    arrayLength += zPositions.length;
-    nDim++;
-  }
-
-  if (mPositions && mPositions.length) {
-    arrayLength += mPositions.length;
-    nDim++;
-  }
-
-  const positions = new Float64Array(arrayLength);
-
-  for (let i = 0; i < xyPositions.length / 2; i++) {
-    positions[nDim * i] = xyPositions[i * 2];
-    positions[nDim * i + 1] = xyPositions[i * 2 + 1];
-  }
-
-  if (zPositions && zPositions.length) {
-    for (let i = 0; i < zPositions.length; i++) {
-      positions[nDim * i + 2] = zPositions[i];
+    if (!(mPositions || zPositions)) {
+        return xyPositions;
+    }
+    let arrayLength = xyPositions.length;
+    let nDim = 2;
+    if (zPositions && zPositions.length) {
+        arrayLength += zPositions.length;
+        nDim++;
     }
-  }
-
-  if (mPositions && mPositions.length) {
-    for (let i = 0; i < mPositions.length; i++) {
-      positions[nDim * i + (nDim - 1)] = mPositions[i];
+    if (mPositions && mPositions.length) {
+        arrayLength += mPositions.length;
+        nDim++;
     }
-  }
-
-  return positions;
+    const positions = new Float64Array(arrayLength);
+    for (let i = 0; i < xyPositions.length / 2; i++) {
+        positions[nDim * i] = xyPositions[i * 2];
+        positions[nDim * i + 1] = xyPositions[i * 2 + 1];
+    }
+    if (zPositions && zPositions.length) {
+        for (let i = 0; i < zPositions.length; i++) {
+            // If Z coordinates exist; used as third coord in positions array
+            positions[nDim * i + 2] = zPositions[i];
+        }
+    }
+    if (mPositions && mPositions.length) {
+        for (let i = 0; i < mPositions.length; i++) {
+            // M is always last, either 3rd or 4th depending on if Z exists
+            positions[nDim * i + (nDim - 1)] = mPositions[i];
+        }
+    }
+    return positions;
 }
-
+/**
+ * Returns the direction of the polygon path
+ * A positive number is clockwise.
+ * A negative number is counter clockwise.
+ *
+ * @param positions
+ * @return Sign of polygon ring
+ */
 function getWindingDirection(positions) {
-  return Math.sign(getSignedArea(positions));
+    return Math.sign(getSignedArea(positions));
 }
-
+/**
+ * Get signed area of flat typed array of 2d positions
+ *
+ * @param positions
+ * @return Signed area of polygon ring
+ */
 function getSignedArea(positions) {
-  let area = 0;
-  const nCoords = positions.length / 2 - 1;
-
-  for (let i = 0; i < nCoords; i++) {
-    area += (positions[i * 2] + positions[(i + 1) * 2]) * (positions[i * 2 + 1] - positions[(i + 1) * 2 + 1]);
-  }
-
-  return area / 2;
+    let area = 0;
+    // Rings are closed according to shapefile spec
+    const nCoords = positions.length / 2 - 1;
+    for (let i = 0; i < nCoords; i++) {
+        area +=
+            (positions[i * 2] + positions[(i + 1) * 2]) *
+                (positions[i * 2 + 1] - positions[(i + 1) * 2 + 1]);
+    }
+    return area / 2;
 }
-//# sourceMappingURL=parse-shp-geometry.js.map

package/dist/lib/parsers/parse-shp-header.js

@@ -1,32 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseSHPHeader = void 0;
 const LITTLE_ENDIAN = true;
 const BIG_ENDIAN = false;
 const SHP_MAGIC_NUMBER = 0x0000270a;
-export function parseSHPHeader(headerView) {
-  const header = {
-    magic: headerView.getInt32(0, BIG_ENDIAN),
-    length: headerView.getInt32(24, BIG_ENDIAN) * 2,
-    version: headerView.getInt32(28, LITTLE_ENDIAN),
-    type: headerView.getInt32(32, LITTLE_ENDIAN),
-    bbox: {
-      minX: headerView.getFloat64(36, LITTLE_ENDIAN),
-      minY: headerView.getFloat64(44, LITTLE_ENDIAN),
-      minZ: headerView.getFloat64(68, LITTLE_ENDIAN),
-      minM: headerView.getFloat64(84, LITTLE_ENDIAN),
-      maxX: headerView.getFloat64(52, LITTLE_ENDIAN),
-      maxY: headerView.getFloat64(60, LITTLE_ENDIAN),
-      maxZ: headerView.getFloat64(76, LITTLE_ENDIAN),
-      maxM: headerView.getFloat64(92, LITTLE_ENDIAN)
+/**
+ * Extract the binary header
+ * Note: Also used by SHX
+ * @param headerView
+ * @returns SHPHeader
+ */
+function parseSHPHeader(headerView) {
+    // Note: The SHP format switches endianness between fields!
+    // https://www.esri.com/library/whitepapers/pdfs/shapefile.pdf
+    const header = {
+        magic: headerView.getInt32(0, BIG_ENDIAN),
+        // Length is stored as # of 2-byte words; multiply by 2 to get # of bytes
+        length: headerView.getInt32(24, BIG_ENDIAN) * 2,
+        version: headerView.getInt32(28, LITTLE_ENDIAN),
+        type: headerView.getInt32(32, LITTLE_ENDIAN),
+        bbox: {
+            minX: headerView.getFloat64(36, LITTLE_ENDIAN),
+            minY: headerView.getFloat64(44, LITTLE_ENDIAN),
+            minZ: headerView.getFloat64(68, LITTLE_ENDIAN),
+            minM: headerView.getFloat64(84, LITTLE_ENDIAN),
+            maxX: headerView.getFloat64(52, LITTLE_ENDIAN),
+            maxY: headerView.getFloat64(60, LITTLE_ENDIAN),
+            maxZ: headerView.getFloat64(76, LITTLE_ENDIAN),
+            maxM: headerView.getFloat64(92, LITTLE_ENDIAN)
+        }
+    };
+    if (header.magic !== SHP_MAGIC_NUMBER) {
+        // eslint-disable-next-line
+        console.error(`SHP file: bad magic number ${header.magic}`);
     }
-  };
-
-  if (header.magic !== SHP_MAGIC_NUMBER) {
-    console.error("SHP file: bad magic number ".concat(header.magic));
-  }
-
-  if (header.version !== 1000) {
-    console.error("SHP file: bad version ".concat(header.version));
-  }
-
-  return header;
+    if (header.version !== 1000) {
+        // eslint-disable-next-line
+        console.error(`SHP file: bad version ${header.version}`);
+    }
+    return header;
 }
-//# sourceMappingURL=parse-shp-header.js.map
+exports.parseSHPHeader = parseSHPHeader;

package/dist/lib/parsers/parse-shp.d.ts

@@ -1,9 +1,10 @@
 import type { BinaryGeometry } from '@loaders.gl/schema';
-export declare function parseSHP(arrayBuffer: ArrayBuffer, options?: object): BinaryGeometry[];
+import { SHPLoaderOptions } from './types';
+export declare function parseSHP(arrayBuffer: ArrayBuffer, options?: SHPLoaderOptions): BinaryGeometry[];
 /**
  * @param asyncIterator
  * @param options
  * @returns
  */
-export declare function parseSHPInBatches(asyncIterator: AsyncIterable<ArrayBuffer> | Iterable<ArrayBuffer>, options?: object): AsyncIterable<BinaryGeometry | object>;
+export declare function parseSHPInBatches(asyncIterator: AsyncIterable<ArrayBuffer> | Iterable<ArrayBuffer>, options?: SHPLoaderOptions): AsyncIterable<BinaryGeometry | object>;
 //# sourceMappingURL=parse-shp.d.ts.map

package/dist/lib/parsers/parse-shp.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"parse-shp.d.ts","sourceRoot":"","sources":["../../../src/lib/parsers/parse-shp.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAC,cAAc,EAAC,MAAM,oBAAoB,CAAC;AAsDvD,wBAAgB,QAAQ,CAAC,WAAW,EAAE,WAAW,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,cAAc,EAAE,CAOrF;AAED;;;;GAIG;AACH,wBAAuB,iBAAiB,CACtC,aAAa,EAAE,aAAa,CAAC,WAAW,CAAC,GAAG,QAAQ,CAAC,WAAW,CAAC,EACjE,OAAO,CAAC,EAAE,MAAM,GACf,aAAa,CAAC,cAAc,GAAG,MAAM,CAAC,CAqBxC"}
+{"version":3,"file":"parse-shp.d.ts","sourceRoot":"","sources":["../../../src/lib/parsers/parse-shp.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,cAAc,EAAC,MAAM,oBAAoB,CAAC;AAIvD,OAAO,EAAC,gBAAgB,EAAC,MAAM,SAAS,CAAC;AAiEzC,wBAAgB,QAAQ,CAAC,WAAW,EAAE,WAAW,EAAE,OAAO,CAAC,EAAE,gBAAgB,GAAG,cAAc,EAAE,CAO/F;AAED;;;;GAIG;AACH,wBAAuB,iBAAiB,CACtC,aAAa,EAAE,aAAa,CAAC,WAAW,CAAC,GAAG,QAAQ,CAAC,WAAW,CAAC,EACjE,OAAO,CAAC,EAAE,gBAAgB,GACzB,aAAa,CAAC,cAAc,GAAG,MAAM,CAAC,CAqBxC"}