@team-geospan/structuresio 0.0.3 → 0.0.5

package/README.md

@@ -1,6 +1,6 @@
 # GEOSPAN StructuresIO
 
-JavaScript utilities for working with the [StructuresJSON]() format.
+JavaScript utilities for working with the [StructuresJSON](https://github.com/team-geospan/structures-json) format.
 
 ## Installation
 

package/lib/geojson.js

@@ -22,56 +22,65 @@
 import { isCollection } from "./helpers";
 
 /**
- * toCoordinateArray converts the surface topology to a GeoJSON style
- * Polygon geometry coordinates array.
- *
- * This is written to be as clear and testable as possible.
- * There are likely more efficient ways to loop through this loop,
- * but this version works and is relatively easy to read.
- *
+ * simplifyRing converts a single surface ring and coverts it to a list
+ * of points.
  */
-export const toCoordinateArray = (surface, edges, points) => {
-  // the "edges" array is structued similar to a simple features polygon.
-  // [outer ring, inner ring, inner ring]
-  // And each ring is composed of [edgeId, edgeId, edgeId]
-  // edges contains points [pointId, pointId]
-  const coords = surface.edges.map((edgeIds) => {
-    const edgePoints = [];
-    edgeIds.forEach((edgeId, edgeIdx) => {
-      const edge = edges[edgeId];
-      // copy the points to ensure the origin edge is not mutated.
-      const nextPoints = [...edge.points];
-      if (edgeIdx === 0) {
-        // determine whether to start the line with the first segment reversed
-        const testPoints = edges[edgeIds[1]].points;
-        if (nextPoints[0] === testPoints[0]) {
-          // flip it
-          nextPoints.reverse();
-        }
-      } else {
-        // keep the line contiguous, flip the next set of points
-        //  when the lastPoint in the line does not match the
-        //  first point of the next edge.
-        const lastPoint = edgePoints[edgePoints.length - 1];
-        if (nextPoints[0] !== lastPoint) {
-          nextPoints.reverse();
-        }
+export const simplifyRing = (ringEdges) => {
+  if (ringEdges.length === 0) {
+    return [];
+  }
+
+  let edges = structuredClone(ringEdges);
+  const sortedList = [];
+
+  sortedList.push(edges.shift());
+
+  // ensure the iterations of the while loop do not exceed
+  // O(n^2), the input edge structure is likely degenerate.
+  let maxIter = edges.length * edges.length;
+  while (maxIter > 0 && edges.length > 0) {
+    for (let i = 0, len = edges.length; i < len; i++) {
+      const edge = edges[i];
+      const len = sortedList.length - 1;
+      if (sortedList[len][1] === edge[0]) {
+        sortedList.push(edge);
+        edges = edges.slice(0, i).concat(edges.slice(i + 1));
+        break;
+      } else if (sortedList[len][1] === edge[edge.length - 1]) {
+        sortedList.push(edge.reverse());
+        edges = edges.slice(0, i).concat(edges.slice(i + 1));
+        break;
       }
-      // use slice(1) to prevent duplicate points.
-      nextPoints.slice(1).forEach((p) => edgePoints.push(p));
-    });
-    // ensure the polygon is closed.
-    if (edgePoints[0] !== edgePoints[edgePoints.length - 1]) {
-      edgePoints.push(edgePoints[0]);
     }
-    // convert all the point ids into [x, y, z] coordinates.
-    return edgePoints.map((ptId) => points[ptId].coordinates);
+    maxIter--;
+  }
+
+  // flatten the list
+  const asPoints = sortedList.map((edge) => edge[0]);
+  // ensure the polygon is closed
+  asPoints.push(sortedList[0][0]);
+  return asPoints;
+};
+
+// surfaceRings returns a list of point ids based on the surfaces edges
+const surfaceRings = (surfaceId, { surfaces, edges }) => {
+  return surfaces[surfaceId].edges.map((ring) => {
+    return ring.map((edgeId) => {
+      return edges[edgeId].points;
+    });
   });
-  return coords;
 };
 
 const structureToPolygonFeature = ({ surfaces, points, edges }) => {
   const features = Object.keys(surfaces).map((surfaceId) => {
+    const rings = surfaceRings(surfaceId, { surfaces, edges }).map((ring) =>
+      simplifyRing(ring),
+    );
+    // convert all the rings into coordinates
+    const coordinates = rings.map((ring) =>
+      ring.map((pointId) => points[pointId].coordinates),
+    );
+
     return {
       type: "Feature",
       properties: {
@@ -81,7 +90,7 @@ const structureToPolygonFeature = ({ surfaces, points, edges }) => {
       },
       geometry: {
         type: "Polygon",
-        coordinates: toCoordinateArray(surfaces[surfaceId], edges, points),
+        coordinates,
       },
     };
   });
@@ -94,10 +103,9 @@ const structureToPolygonFeature = ({ surfaces, points, edges }) => {
  */
 export const toPolygonGeoJSON = (collection) => {
   // handle either a collection or single structure
-  const allFeatures =
-    collection.kind === "StructureCollection"
-      ? collection.structures.map(structureToPolygonFeature)
-      : [structureToPolygonFeature(collection)];
+  const allFeatures = isCollection(collection)
+    ? collection.structures.map(structureToPolygonFeature)
+    : [structureToPolygonFeature(collection)];
 
   return {
     type: "FeatureCollection",

package/lib/summary.js

@@ -49,3 +49,21 @@ export const summarizeSurfaceMaterials = (collection, flatten = false) => {
 
   return summary;
 };
+
+export const summarizeEdges = (collection, flatten = false) => {
+  const summary = {};
+  collection.structures.forEach((structure) => {
+    Object.values(structure.edges).forEach((edge) => {
+      const kind = edge.kind || "";
+      summary[kind] =
+        (summary[kind] || 0) +
+        ((edge.properties && edge.properties.length) || 0);
+    });
+  });
+
+  if (flatten) {
+    return Object.keys(summary).map((key) => [key, summary[key]]);
+  }
+
+  return summary;
+};

package/lib/units.js

@@ -1,3 +1,5 @@
+/* v8 ignore start */
+
 /**
  * Copyright GEOSPAN Corp
  *

package/package.json

@@ -1,15 +1,19 @@
 {
   "name": "@team-geospan/structuresio",
-  "version": "0.0.3",
+  "version": "0.0.5",
   "description": "Collection of utilities for working with StructuresJSON",
   "type": "module",
+  "exports": {
+    "./*": "./lib/*"
+  },
   "files": [
     "./lib"
   ],
   "scripts": {
     "lint": "eslint --report-unused-disable-directives --max-warnings 0 ./tests ./lib --ext .js",
     "lint:fix": "npm run lint -- --fix",
-    "test": "vitest ./tests"
+    "test": "vitest ./tests",
+    "coverage": "vitest ./tests --coverage"
   },
   "eslintConfig": {
     "env": {
@@ -29,6 +33,7 @@
     }
   },
   "devDependencies": {
+    "@vitest/coverage-v8": "^3.1.1",
     "eslint": "^8.57.0",
     "eslint-config-prettier": "^10.0.1",
     "eslint-plugin-prettier": "^5.2.3",