@theseam/ui-common 2.0.1-beta.115 → 2.0.1-beta.119

package/google-maps/index.d.ts

@@ -58,6 +58,19 @@ interface FeatureGroupRegistryOptions {
     newGroupKeyFactory?: () => string;
 }
 
+/** A file the map tried to import and could not read. */
+interface TheSeamMapFileImportError {
+    /** The file as the consumer's user chose or dropped it. */
+    file: File;
+    /**
+     * Whatever `readGeoFile` rejected with. Usually an `Error` carrying one of
+     * its messages — `Shape data not found.`, `Unable to parse as GeoJSON.` —
+     * but a malformed file can surface anything a parser throws, so it is not
+     * narrowed.
+     */
+    error: unknown;
+}
+
 /** Which interaction model a map uses. */
 type TheSeamMapInteractionMode = 'legacy' | 'grouped';
 
@@ -135,6 +148,13 @@ declare class GoogleMapsService implements OnDestroy {
      * an attempt.
      */
     readonly deleteBlocked$: Observable<TheSeamMapGroupTarget>;
+    /**
+     * A file reached one of the import paths and could not be read. Plain
+     * `Subject`, not `BehaviorSubject`: a consumer subscribing later should not
+     * be handed a failure from before it was listening.
+     */
+    private readonly _fileImportErrorSubject;
+    readonly fileImportError$: Observable<TheSeamMapFileImportError>;
     private readonly _selectionSubject;
     /**
      * `distinctUntilChanged` collapses repeated `null`s. Several paths clear the
@@ -351,6 +371,12 @@ declare class GoogleMapsService implements OnDestroy {
     allowDrawingHoleInPolygon(allow: boolean): void;
     setFileInputHandler(handler: ((file: File) => void) | undefined | null): void;
     getFileInputHandler(): ((file: File) => void) | undefined | null;
+    /**
+     * Reports a file the library tried to import and could not read. Called by
+     * the import controls, not by consumers — a consumer that owns importing
+     * through `setFileInputHandler` reports its own failures.
+     */
+    notifyFileImportError(file: File, error: unknown): void;
     setInteractionMode(mode: TheSeamMapInteractionMode): void;
     setGroupOptions(options: FeatureGroupRegistryOptions): void;
     /**
@@ -596,6 +622,17 @@ declare class TheSeamGoogleMapsComponent extends _TheSeamGoogleMapsMixinBase imp
     streetViewControlEnabled: boolean;
     allowDrawingHoleInPolygon: boolean;
     editingEnabled: boolean;
+    /**
+     * Intercepts a file the user chose or dropped, in place of the library's own
+     * import handling. Covers **both** import paths: a file picked through the
+     * upload button and one dropped onto the map (`fileDropEnabled` defaults to
+     * `true`, so setting this now also intercepts drops a consumer relying on
+     * the default previously had handled internally).
+     *
+     * Once called, the consumer owns the file, including reporting any failure
+     * in its own UI — `fileImportError` will not fire for a file handed to this
+     * handler.
+     */
     set fileImportHandler(value: ((file: File) => void) | undefined | null);
     get _attrDisabled(): true | null;
     get _attrTabIndex(): number;
@@ -659,6 +696,15 @@ declare class TheSeamGoogleMapsComponent extends _TheSeamGoogleMapsMixinBase imp
      * so the consumer can explain why; only the consumer knows the reason.
      */
     deleteBlocked: EventEmitter<TheSeamMapGroupTarget>;
+    /**
+     * A file reached one of the import paths and could not be read — a corrupt
+     * archive, a `.zip` of something else, malformed GeoJSON. Emitted so the
+     * consumer can say so in its own UI; the library has nowhere to show it.
+     *
+     * Not emitted for a file a `fileImportHandler` took: once the consumer owns
+     * the file, it owns reporting the outcome too.
+     */
+    fileImportError: EventEmitter<TheSeamMapFileImportError>;
     featureContextMenu: MenuComponent;
     _options: {
         mapTypeControl: boolean;
@@ -703,7 +749,7 @@ declare class TheSeamGoogleMapsComponent extends _TheSeamGoogleMapsMixinBase imp
     setEditMode(enabled: boolean): void;
     isEditMode(): boolean;
     static ɵfac: i0.ɵɵFactoryDeclaration<TheSeamGoogleMapsComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<TheSeamGoogleMapsComponent, "seam-google-maps", ["seamGoogleMaps"], { "disabled": { "alias": "disabled"; "required": false; }; "value": { "alias": "value"; "required": false; }; "tabIndex": { "alias": "tabIndex"; "required": false; }; "fileDropEnabled": { "alias": "fileDropEnabled"; "required": false; }; "fileUploadControlEnabled": { "alias": "fileUploadControlEnabled"; "required": false; }; "fullscreenControlEnabled": { "alias": "fullscreenControlEnabled"; "required": false; }; "reCenterControlEnabled": { "alias": "reCenterControlEnabled"; "required": false; }; "mapTypeControlEnabled": { "alias": "mapTypeControlEnabled"; "required": false; }; "streetViewControlEnabled": { "alias": "streetViewControlEnabled"; "required": false; }; "allowDrawingHoleInPolygon": { "alias": "allowDrawingHoleInPolygon"; "required": false; }; "editingEnabled": { "alias": "editingEnabled"; "required": false; }; "fileImportHandler": { "alias": "fileImportHandler"; "required": false; }; "zoom": { "alias": "zoom"; "required": false; }; "longitude": { "alias": "longitude"; "required": false; }; "latitude": { "alias": "latitude"; "required": false; }; "padding": { "alias": "padding"; "required": false; }; "interactionMode": { "alias": "interactionMode"; "required": false; }; "featureGroupProperty": { "alias": "featureGroupProperty"; "required": false; }; "featureLabelProperty": { "alias": "featureLabelProperty"; "required": false; }; "newGroupKeyFactory": { "alias": "newGroupKeyFactory"; "required": false; }; "selectedGroupKey": { "alias": "selectedGroupKey"; "required": false; }; "canDelete": { "alias": "canDelete"; "required": false; }; }, { "mapReady": "mapReady"; "selectionChange": "selectionChange"; "featureHoverChange": "featureHoverChange"; "deleteBlocked": "deleteBlocked"; }, never, never, false, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<TheSeamGoogleMapsComponent, "seam-google-maps", ["seamGoogleMaps"], { "disabled": { "alias": "disabled"; "required": false; }; "value": { "alias": "value"; "required": false; }; "tabIndex": { "alias": "tabIndex"; "required": false; }; "fileDropEnabled": { "alias": "fileDropEnabled"; "required": false; }; "fileUploadControlEnabled": { "alias": "fileUploadControlEnabled"; "required": false; }; "fullscreenControlEnabled": { "alias": "fullscreenControlEnabled"; "required": false; }; "reCenterControlEnabled": { "alias": "reCenterControlEnabled"; "required": false; }; "mapTypeControlEnabled": { "alias": "mapTypeControlEnabled"; "required": false; }; "streetViewControlEnabled": { "alias": "streetViewControlEnabled"; "required": false; }; "allowDrawingHoleInPolygon": { "alias": "allowDrawingHoleInPolygon"; "required": false; }; "editingEnabled": { "alias": "editingEnabled"; "required": false; }; "fileImportHandler": { "alias": "fileImportHandler"; "required": false; }; "zoom": { "alias": "zoom"; "required": false; }; "longitude": { "alias": "longitude"; "required": false; }; "latitude": { "alias": "latitude"; "required": false; }; "padding": { "alias": "padding"; "required": false; }; "interactionMode": { "alias": "interactionMode"; "required": false; }; "featureGroupProperty": { "alias": "featureGroupProperty"; "required": false; }; "featureLabelProperty": { "alias": "featureLabelProperty"; "required": false; }; "newGroupKeyFactory": { "alias": "newGroupKeyFactory"; "required": false; }; "selectedGroupKey": { "alias": "selectedGroupKey"; "required": false; }; "canDelete": { "alias": "canDelete"; "required": false; }; }, { "mapReady": "mapReady"; "selectionChange": "selectionChange"; "featureHoverChange": "featureHoverChange"; "deleteBlocked": "deleteBlocked"; "fileImportError": "fileImportError"; }, never, never, false, never>;
 }
 
 /**
@@ -731,10 +777,15 @@ declare class TheSeamMapFileDropComponent implements OnInit, OnDestroy {
     private _disableFileDrop;
     private readonly _handleDragOverEvent;
     private readonly _handleDropEvent;
+    /**
+     * Routes a dropped file the same way the upload button routes a chosen one,
+     * so `fileImportHandler` means "the consumer owns imported files" whichever
+     * way the file arrived.
+     */
+    private _importDroppedFile;
     private readonly _handleDragEnterEvent;
     private readonly _handleDragLeaveEvent;
     private _dropAllowed;
-    private _isSupportedDataTransfer;
     private _isSupportedDataTransferTypes;
     static ɵfac: i0.ɵɵFactoryDeclaration<TheSeamMapFileDropComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<TheSeamMapFileDropComponent, "seam-map-file-drop", never, {}, {}, never, never, false, never>;
@@ -763,6 +814,7 @@ declare class TheSeamGoogleMapsUploadButtonControlComponent implements OnDestroy
     ngOnDestroy(): void;
     private _getFile;
     private _importFile;
+    private _reportImportError;
     private _createHiddenInput;
     private _createTemporaryFormElement;
     /**
@@ -1260,4 +1312,4 @@ declare class TheSeamNoopGoogleMapsAPILoader extends TheSeamGoogleMapsApiLoader
 }
 
 export { AppFeaturePropertyName, FEATURE_STYLE_OPTIONS_DEFAULT, FEATURE_STYLE_OPTIONS_SELECTED, FEATURE_STYLE_OVERRIDE_OPTIONS_HOVERED, GoogleMapsContextMenu, GoogleMapsControlsService, GoogleMapsService, MAP_CONTROLS_SERVICE, MAP_CONTROL_DATA, MapControlRef, MapValueManagerService, MapValueSource, SEAM_GOOGLE_PLACES_AUTOCOMPLETE_DEFAULT_OPTIONS, SUPPORTED_PROPERTY_STYLE_OPTIONS, THESEAM_LAZY_MAPS_API_CONFIG, TheSeamGoogleMapsApiLoader, TheSeamGoogleMapsComponent, TheSeamGoogleMapsModule, TheSeamGoogleMapsPlacesAutoCompleteComponent, TheSeamGoogleMapsPlacesAutocompleteDirective, TheSeamGoogleMapsRecenterButtonControlComponent, TheSeamGoogleMapsUploadButtonControlComponent, TheSeamLazyMapsApiLoader, TheSeamMapFileDropComponent, TheSeamMapsControlComponent, TheSeamNoopGoogleMapsAPILoader, applyHoleToFeature, buildDeleteMenuItems, computeFeatureHoverStyle, computeFeatureStyle, createFeatureChangeObservable, dataMultiPolygonFromGeoJson, dataPolygonFromGeoJson, featureAllows, geoJsonFeatureFromDataFeature, geoJsonPolygonFromDataFeature, getBoundsWithAllFeatures, getFeatureBounds, getFeatureCenter, getFeaturesCount, getHoveredStyleOptionsDefinedByFeature, getSelectedStyleOptionsDefinedByFeature, getStyleOptionsDefinedByFeature, isAppFeatureProperty, isFeatureSelected, mergeStyleOptions, polygonCoordinates, polygonHasValidPathsLengths, polygonsFromDataFeature, removeAllFeatures, setFeatureSelected, stripAppFeaturePropertiesFromJson };
-export type { GoogleMapsRecenterButtonControlData, GoogleMapsUploadButtonControlData, MapControl, MapControlsService, MapValue, MapValueChange, TheSeamLazyMapsApiLoaderConfig, TheSeamMapContextMenuItem, TheSeamMapDeleteMenuContext, TheSeamMapFeatureGroup, TheSeamMapFeatureStyleContext, TheSeamMapGroupTarget, TheSeamMapInteractionMode };
+export type { GoogleMapsRecenterButtonControlData, GoogleMapsUploadButtonControlData, MapControl, MapControlsService, MapValue, MapValueChange, TheSeamLazyMapsApiLoaderConfig, TheSeamMapContextMenuItem, TheSeamMapDeleteMenuContext, TheSeamMapFeatureGroup, TheSeamMapFeatureStyleContext, TheSeamMapFileImportError, TheSeamMapGroupTarget, TheSeamMapInteractionMode };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@theseam/ui-common",
-  "version": "2.0.1-beta.115",
+  "version": "2.0.1-beta.119",
   "peerDependencies": {
     "@angular/cdk": "^20.2.3",
     "@angular/common": "^20.3.0",

package/utils/index.d.ts

@@ -219,6 +219,17 @@ declare function noInnerRingsValidator(): ValidatorFn;
 declare const NO_KINKS_VALIDATOR_NAME = "no-kinks";
 declare function noKinksValidator(): ValidatorFn;
 
+/**
+ * Property key under which `readGeoFile` records the archive member a feature
+ * came from, for shapefile archives only.
+ *
+ * A zip can hold one shapefile per field, and once their features are
+ * concatenated the member name is the only thing distinguishing them — for
+ * some producer exports it is the only usable name at all, because the `.dbf`
+ * carries nothing but numbers. The value is the member's basename, without its
+ * directory or extension.
+ */
+declare const GEO_FILE_SOURCE_NAME_PROPERTY = "seamSourceFileName";
 /**
  * Reads a File, or buffer of file content, in GeoJSON or ESRI Shapefile format
  * and returns a GeoJSON `FeatureCollection`.
@@ -484,5 +495,5 @@ interface SanitizeFilenameOptions {
 }
 declare function sanitizeFilename(filename: string, options?: SanitizeFilenameOptions): string;
 
-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 };
+export { GEO_FILE_SOURCE_NAME_PROPERTY, 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 };
 export type { IActivatedRouteWithData, IFileData, PollingActionFn, RefreshableOptions, SanitizeFilenameOptions, SubscriberCountChangedFn };