@theseam/ui-common 1.0.2-beta.87 → 2.0.1-beta.101

package/fesm2022/theseam-ui-common-utils.mjs

@@ -1,10 +1,11 @@
 import { switchMap, startWith, map, distinctUntilChanged, mapTo, filter, take, pairwise, toArray, tap, auditTime, share } from 'rxjs/operators';
 import { of, merge, interval, from, combineLatest, Observable, isObservable, Subject, BehaviorSubject, EMPTY } from 'rxjs';
 import area from '@turf/area';
-import { convertArea } from '@turf/helpers';
+import { convertArea, polygon } from '@turf/helpers';
 import kinks from '@turf/kinks';
 import { fileTypeFromBuffer } from 'file-type';
 import shp from 'shpjs';
+import booleanContains from '@turf/boolean-contains';
 
 /**
  *
@@ -476,6 +477,18 @@ function notNullOrUndefined(value) {
     return value !== null && value !== undefined;
 }
 
+/**
+ * Checks if a single polygon ring's coordinate count violates the given
+ * min/max point bounds. `max` is only applied when it is greater than `min`.
+ */
+function polygonViolatesMinMax(coordinateLength, min, max) {
+    if (coordinateLength < min ||
+        (notNullOrUndefined(max) && max > min && coordinateLength > max)) {
+        return true;
+    }
+    return false;
+}
+
 const MIN_MAX_POINTS_VALIDATOR_NAME = 'min-max-points';
 function minMaxPointsValidator(min = 3, max) {
     return (control) => {
@@ -522,13 +535,6 @@ function collectionViolatesMinMax(featureCollection, min, max) {
     }
     return false;
 }
-function polygonViolatesMinMax(coordinateLength, min, max) {
-    if (coordinateLength < min ||
-        (notNullOrUndefined(max) && max > min && coordinateLength > max)) {
-        return true;
-    }
-    return false;
-}
 
 const NO_EMPTY_FEATURE_COLLECTION_VALIDATOR_NAME = 'no-empty-feature-collection';
 function noEmptyFeatureCollectionValidator() {
@@ -819,11 +825,11 @@ function splitMultPolygon(multiPolygon) {
 }
 
 /**
- * Close all polygons in the GeoJSON.
+ * Close all polygons in the GeoJSON so the first and last position of every
+ * ring are identical.
  *
- * Google Maps requires that polygons be closed, but not all libraries have that
- * requirement. This may add redundent points to the GeoJSON, but it will ensure
- * that the GeoJSON is valid for Google Maps.
+ * Google Maps requires closed polygon rings, but not all libraries produce
+ * them. This is idempotent: rings that are already closed are left unchanged.
  */
 function closePolygons(geoJson) {
     if (geoJson.type === 'FeatureCollection') {
@@ -834,6 +840,12 @@ function closePolygons(geoJson) {
     else if (geoJson.type === 'Feature') {
         closePolygonsFeature(geoJson);
     }
+    else if (geoJson.type === 'Polygon') {
+        closePolygon(geoJson);
+    }
+    else if (geoJson.type === 'MultiPolygon') {
+        closeMultiPolygon(geoJson);
+    }
 }
 function closePolygonsFeature(feature) {
     if (feature.geometry.type === 'Polygon') {
@@ -844,17 +856,96 @@ function closePolygonsFeature(feature) {
     }
 }
 function closePolygon(polygon) {
-    for (const c of polygon.coordinates) {
-        c.push(c[0]);
+    for (const ring of polygon.coordinates) {
+        closeRing(ring);
     }
 }
 function closeMultiPolygon(multiPolygon) {
-    for (const p of multiPolygon.coordinates) {
-        for (const c of p) {
-            c.push(c[0]);
+    for (const polygon of multiPolygon.coordinates) {
+        for (const ring of polygon) {
+            closeRing(ring);
         }
     }
 }
+/**
+ * Appends the first position to the end of a ring only when it is not already
+ * closed. Exact equality is correct here: the closing point is a copy of the
+ * first point, so we compare a value against its own copy.
+ */
+function closeRing(ring) {
+    if (ring.length < 1) {
+        return;
+    }
+    const first = ring[0];
+    const last = ring[ring.length - 1];
+    if (first[0] === last[0] && first[1] === last[1]) {
+        return;
+    }
+    ring.push([...first]);
+}
+
+/** Count distinct vertices in a ring, ignoring an explicit closing point. */
+function distinctVertexCount(ring) {
+    if (ring.length === 0) {
+        return 0;
+    }
+    const first = ring[0];
+    const last = ring[ring.length - 1];
+    const isClosed = ring.length > 1 && first[0] === last[0] && first[1] === last[1];
+    return isClosed ? ring.length - 1 : ring.length;
+}
+/**
+ * Whether a polygon's outer ring has at least `min` distinct vertices.
+ * Ring closure (a repeated first/last point) does not count toward the total,
+ * so this behaves the same for closed and unclosed rings.
+ */
+function polygonHasMinDistinctVertices(polygon, min = 3) {
+    const outer = polygon.coordinates[0] ?? [];
+    return !polygonViolatesMinMax(distinctVertexCount(outer), min, undefined);
+}
+
+/**
+ * Whether `outer` fully contains `inner`, using turf's boolean-contains on the
+ * GeoJSON geometries directly (no Google Maps dependency).
+ */
+function polygonContains(outer, inner) {
+    return booleanContains(polygon(outer.coordinates), polygon(inner.coordinates));
+}
+
+/**
+ * Whether a ring is wound clockwise, via the shoelace signed-area sign.
+ * Sum of (x2 - x1) * (y2 + y1) is positive for clockwise rings in standard
+ * (x = lng, y = lat) orientation.
+ */
+function ringIsClockwise(ring) {
+    let sum = 0;
+    for (let i = 0; i < ring.length - 1; i++) {
+        const [x1, y1] = ring[i];
+        const [x2, y2] = ring[i + 1];
+        sum += (x2 - x1) * (y2 + y1);
+    }
+    return sum > 0;
+}
+/** Return `ring` wound opposite to `reference`, reversing a copy if needed. */
+function ringWoundOpposite(reference, ring) {
+    if (ringIsClockwise(reference) === ringIsClockwise(ring)) {
+        return [...ring].reverse();
+    }
+    return [...ring];
+}
+/**
+ * Append the outer ring of `hole` to `exterior` as an interior ring (a
+ * cutout), wound opposite the exterior ring so it renders as a hole. Returns a
+ * new Polygon; inputs are not mutated.
+ */
+function addHoleToPolygon(exterior, hole) {
+    const exteriorRing = exterior.coordinates[0];
+    const holeRing = ringWoundOpposite(exteriorRing, hole.coordinates[0]);
+    return {
+        type: 'Polygon',
+        coordinates: [...exterior.coordinates, holeRing],
+    };
+}
 
 // Based on source: https://github.com/sindresorhus/array-move/blob/main/index.js
 /**
@@ -1403,5 +1494,5 @@ function sanitizeFilename(filename, options) {
  * Generated bundle index. Do not edit.
  */
 
-export { IS_FEATURE_COLLECTION_VALIDATOR_NAME, IS_ONLY_GEOMETRY_TYPES_VALIDATOR_NAME, MIN_MAX_POINTS_VALIDATOR_NAME, NO_EMPTY_FEATURE_COLLECTION_VALIDATOR_NAME, NO_INNER_RINGS_VALIDATOR_NAME, NO_KINKS_VALIDATOR_NAME, PollingTickerOptions, Refreshable, activatedRoutesWithDataProperty, arrayMoveImmutable, arrayMoveMutable, calcPercentage, closePolygons, coerceFeatureCollection, createPadding, deleteProperties, deleteProperty, fileBufferToBlob, fileBufferToObjectUrl, fileDataFromBuffer, fractionalDigitsCount, geoJsonToArea, getAttribute, getClosestWidgetCdkDrag, getControlName, getControlPath, hasAttribute, hasProperty, hasRequiredControl, isAbsoluteUrl, isEmptyInputValue, isEmptyUrlRoute, isFeatureCollectionValidator, isNullOrUndefined, isNullOrUndefinedOrEmpty, isNumeric, isOnlyGeometryTypes, isOnlyGeometryTypesValidator, leafChildRoute, loadStyle, loadStyleSheet, mapEach, mergePolygons, minMaxPointsValidator, noEmptyFeatureCollectionValidator, noInnerRingsValidator, noKinksValidator, notNullOrUndefined, notNullOrUndefinedOrEmpty, observeControlIsDifferent, observeControlStatus, observeControlValid, observeControlValue, observeControlValueChange, observeQueryList, openBlob, padEnd, padStart, phoneNumberMask, pollingTicker, readFileAsDataUrlAsync, readFileAsync, readGeoFile, routeSnapshotPathFull, routeSnapshotPathRelative, sanitizeFilename, splitMultiPolygons, stripOuter, subscriberCount, tapFirst, toggleAttribute, trimRepeated, waitOnConditionAsync, waitOnNonPendingStatus, willHaveDataProp, withoutProperties, withoutProperty, wrapIntoObservable };
+export { IS_FEATURE_COLLECTION_VALIDATOR_NAME, IS_ONLY_GEOMETRY_TYPES_VALIDATOR_NAME, MIN_MAX_POINTS_VALIDATOR_NAME, NO_EMPTY_FEATURE_COLLECTION_VALIDATOR_NAME, NO_INNER_RINGS_VALIDATOR_NAME, NO_KINKS_VALIDATOR_NAME, PollingTickerOptions, Refreshable, activatedRoutesWithDataProperty, addHoleToPolygon, arrayMoveImmutable, arrayMoveMutable, calcPercentage, closePolygons, coerceFeatureCollection, createPadding, deleteProperties, deleteProperty, fileBufferToBlob, fileBufferToObjectUrl, fileDataFromBuffer, fractionalDigitsCount, geoJsonToArea, getAttribute, getClosestWidgetCdkDrag, getControlName, getControlPath, hasAttribute, hasProperty, hasRequiredControl, isAbsoluteUrl, isEmptyInputValue, isEmptyUrlRoute, isFeatureCollectionValidator, isNullOrUndefined, isNullOrUndefinedOrEmpty, isNumeric, isOnlyGeometryTypes, isOnlyGeometryTypesValidator, leafChildRoute, loadStyle, loadStyleSheet, mapEach, mergePolygons, minMaxPointsValidator, noEmptyFeatureCollectionValidator, noInnerRingsValidator, noKinksValidator, notNullOrUndefined, notNullOrUndefinedOrEmpty, observeControlIsDifferent, observeControlStatus, observeControlValid, observeControlValue, observeControlValueChange, observeQueryList, openBlob, padEnd, padStart, phoneNumberMask, pollingTicker, polygonContains, polygonHasMinDistinctVertices, polygonViolatesMinMax, readFileAsDataUrlAsync, readFileAsync, readGeoFile, ringIsClockwise, routeSnapshotPathFull, routeSnapshotPathRelative, sanitizeFilename, splitMultiPolygons, stripOuter, subscriberCount, tapFirst, toggleAttribute, trimRepeated, waitOnConditionAsync, waitOnNonPendingStatus, willHaveDataProp, withoutProperties, withoutProperty, wrapIntoObservable };
 //# sourceMappingURL=theseam-ui-common-utils.mjs.map