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

package/fesm2022/theseam-ui-common-google-maps.mjs

@@ -1138,6 +1138,13 @@ class GoogleMapsService {
      * an attempt.
      */
     deleteBlocked$ = this._deleteBlockedSubject.asObservable();
+    /**
+     * 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.
+     */
+    _fileImportErrorSubject = new Subject();
+    fileImportError$ = this._fileImportErrorSubject.asObservable();
     _selectionSubject = new BehaviorSubject(null);
     /**
      * `distinctUntilChanged` collapses repeated `null`s. Several paths clear the
@@ -1193,6 +1200,7 @@ class GoogleMapsService {
         this._editModeSubject.complete();
         this._interactionModeSubject.complete();
         this._deleteBlockedSubject.complete();
+        this._fileImportErrorSubject.complete();
         this._groups = undefined;
         this._labelsOverlay?.destroy();
         this._labelsOverlay = undefined;
@@ -1825,6 +1833,14 @@ class GoogleMapsService {
     getFileInputHandler() {
         return this._fileInputHandler;
     }
+    /**
+     * 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, error) {
+        this._fileImportErrorSubject.next({ file, error });
+    }
     setInteractionMode(mode) {
         this._model =
             mode === 'grouped'
@@ -2708,7 +2724,12 @@ class TheSeamGoogleMapsUploadButtonControlComponent {
     async _importFile(file) {
         const json = await readGeoFile(file);
         this._mapValueManager.setValue(json, MapValueSource.Input);
-        this._resetInput();
+    }
+    _reportImportError(file, error) {
+        if (file === undefined) {
+            return;
+        }
+        this._googleMaps.notifyFileImportError(file, error);
     }
     _createHiddenInput() {
         const fileInputElement = this._renderer.createElement('input');
@@ -2716,16 +2737,32 @@ class TheSeamGoogleMapsUploadButtonControlComponent {
         this._renderer.setAttribute(fileInputElement, 'hidden', '');
         this._renderer.setAttribute(fileInputElement, 'accept', '.json,.geojson,.shp,.zip');
         this._listeners.push(this._renderer.listen(fileInputElement, 'change', (event) => {
-            const file = this._getFile();
+            let file;
+            try {
+                file = this._getFile();
+            }
+            catch (err) {
+                // `_getFile` refuses a multi-file selection. Report it like any
+                // other reason the chosen files could not be imported. `_getFile`
+                // has already read `files` by this point, so resetting now cannot
+                // disturb the read.
+                this._reportImportError(this._fileInputElement.files?.[0], err);
+                this._resetInput();
+                return;
+            }
             if (file === null) {
                 return;
             }
             const fileImportHandler = this._googleMaps.getFileInputHandler();
             if (fileImportHandler) {
+                // The consumer owns the file now, including reporting its failures.
                 fileImportHandler(file);
+                this._resetInput();
             }
             else {
-                this._importFile(file);
+                this._importFile(file)
+                    .catch((err) => this._reportImportError(file, err))
+                    .finally(() => this._resetInput());
             }
         }));
         return fileInputElement;
@@ -2910,16 +2947,55 @@ class TheSeamMapFileDropComponent {
         event.preventDefault();
         event.stopPropagation();
         this._renderer.setStyle(this._elementRef.nativeElement, 'display', 'none');
-        // TODO: Show error if multiple files?
-        if (!this._isSupportedDataTransfer(event.dataTransfer)) {
+        if (!this._isSupportedDataTransferTypes(event.dataTransfer)) {
+            // Not a file drag at all — selected text, a link, an image dragged out
+            // of a page. Nobody asked for an import and there is no file to name,
+            // so this stays silent rather than reporting a failure.
+            return;
+        }
+        const files = event.dataTransfer.files;
+        if (files.length !== 1) {
+            if (files.length > 1) {
+                // Refused before any handler is consulted, exactly as the upload
+                // button's `_getFile` does: `fileImportHandler` takes a single file
+                // and cannot be handed several, so the consumer never sees these and
+                // this output is its only way to learn the drop was rejected. Same
+                // message as the button, so a consumer matching on it needs one
+                // string rather than two.
+                this._ngZone.run(() => this._googleMaps.notifyFileImportError(files[0], Error('Only one file can be imported at a time.')));
+            }
             return;
         }
         const item = event.dataTransfer.items[0];
         const file = item.getAsFile();
-        readGeoFile(file).then((json) => {
+        if (file === null) {
+            return;
+        }
+        // These listeners are registered outside Angular's zone, so re-enter it
+        // before calling back into anything that expects change detection — the
+        // consumer's handler may well render a message from here.
+        this._ngZone.run(() => this._importDroppedFile(file));
+    };
+    /**
+     * 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.
+     */
+    _importDroppedFile(file) {
+        const fileImportHandler = this._googleMaps.getFileInputHandler();
+        if (fileImportHandler) {
+            // The consumer owns the file now, including reporting its failures.
+            fileImportHandler(file);
+            return;
+        }
+        readGeoFile(file)
+            .then((json) => {
             this._mapValueManager.setValue(json, MapValueSource.Input);
+        })
+            .catch((error) => {
+            this._googleMaps.notifyFileImportError(file, error);
         });
-    };
+    }
     _handleDragEnterEvent = (event) => {
         if (!this._dropAllowed()) {
             return;
@@ -2938,9 +3014,6 @@ class TheSeamMapFileDropComponent {
     _dropAllowed() {
         return !this._globalDragInProgress;
     }
-    _isSupportedDataTransfer(dataTransfer) {
-        return dataTransfer.files.length === 1 && dataTransfer.types[0] === 'Files';
-    }
     _isSupportedDataTransferTypes(dataTransfer) {
         return dataTransfer.types[0] === 'Files';
     }
@@ -3092,6 +3165,17 @@ class TheSeamGoogleMapsComponent extends _TheSeamGoogleMapsMixinBase {
     streetViewControlEnabled = false;
     allowDrawingHoleInPolygon = false;
     editingEnabled = true;
+    /**
+     * 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) {
         this._googleMaps.setFileInputHandler(value);
     }
@@ -3161,6 +3245,15 @@ class TheSeamGoogleMapsComponent extends _TheSeamGoogleMapsMixinBase {
      * so the consumer can explain why; only the consumer knows the reason.
      */
     deleteBlocked = new EventEmitter();
+    /**
+     * 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 = new EventEmitter();
     featureContextMenu;
     _options = {
         mapTypeControl: true,
@@ -3218,6 +3311,11 @@ class TheSeamGoogleMapsComponent extends _TheSeamGoogleMapsMixinBase {
         this._googleMaps.deleteBlocked$
             .pipe(tap((target) => this.deleteBlocked.emit(target)), takeUntil(this._ngUnsubscribe))
             .subscribe();
+        // As with `deleteBlocked$`, a plain Subject with nothing to replay, so no
+        // `skip(1)`.
+        this._googleMaps.fileImportError$
+            .pipe(tap((value) => this.fileImportError.emit(value)), takeUntil(this._ngUnsubscribe))
+            .subscribe();
         this._contextMenuItems$ = combineLatest([
             this._googleMaps.editingEnabled$,
             // The RIGHT-CLICKED feature's group — what "Delete Field" is
@@ -3472,7 +3570,7 @@ class TheSeamGoogleMapsComponent extends _TheSeamGoogleMapsMixinBase {
         return this._googleMaps.isEditMode();
     }
     static ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "20.3.15", ngImport: i0, type: TheSeamGoogleMapsComponent, deps: [{ token: i0.ElementRef }, { token: i1.FocusMonitor }, { token: GoogleMapsService }, { token: MapValueManagerService }, { token: TheSeamGoogleMapsApiLoader }], target: i0.ɵɵFactoryTarget.Component });
-    static ɵcmp = i0.ɵɵngDeclareComponent({ minVersion: "14.0.0", version: "20.3.15", type: TheSeamGoogleMapsComponent, isStandalone: false, selector: "seam-google-maps", inputs: { disabled: "disabled", value: "value", tabIndex: "tabIndex", fileDropEnabled: "fileDropEnabled", fileUploadControlEnabled: "fileUploadControlEnabled", fullscreenControlEnabled: "fullscreenControlEnabled", reCenterControlEnabled: "reCenterControlEnabled", mapTypeControlEnabled: "mapTypeControlEnabled", streetViewControlEnabled: "streetViewControlEnabled", allowDrawingHoleInPolygon: "allowDrawingHoleInPolygon", editingEnabled: "editingEnabled", fileImportHandler: "fileImportHandler", zoom: "zoom", longitude: "longitude", latitude: "latitude", padding: "padding", interactionMode: "interactionMode", featureGroupProperty: "featureGroupProperty", featureLabelProperty: "featureLabelProperty", newGroupKeyFactory: "newGroupKeyFactory", selectedGroupKey: "selectedGroupKey", canDelete: "canDelete" }, outputs: { mapReady: "mapReady", selectionChange: "selectionChange", featureHoverChange: "featureHoverChange", deleteBlocked: "deleteBlocked" }, host: { properties: { "attr.disabled": "this._attrDisabled", "attr.tabindex": "this._attrTabIndex" } }, providers: [
+    static ɵcmp = i0.ɵɵngDeclareComponent({ minVersion: "14.0.0", version: "20.3.15", type: TheSeamGoogleMapsComponent, isStandalone: false, selector: "seam-google-maps", inputs: { disabled: "disabled", value: "value", tabIndex: "tabIndex", fileDropEnabled: "fileDropEnabled", fileUploadControlEnabled: "fileUploadControlEnabled", fullscreenControlEnabled: "fullscreenControlEnabled", reCenterControlEnabled: "reCenterControlEnabled", mapTypeControlEnabled: "mapTypeControlEnabled", streetViewControlEnabled: "streetViewControlEnabled", allowDrawingHoleInPolygon: "allowDrawingHoleInPolygon", editingEnabled: "editingEnabled", fileImportHandler: "fileImportHandler", zoom: "zoom", longitude: "longitude", latitude: "latitude", padding: "padding", interactionMode: "interactionMode", featureGroupProperty: "featureGroupProperty", featureLabelProperty: "featureLabelProperty", newGroupKeyFactory: "newGroupKeyFactory", selectedGroupKey: "selectedGroupKey", canDelete: "canDelete" }, outputs: { mapReady: "mapReady", selectionChange: "selectionChange", featureHoverChange: "featureHoverChange", deleteBlocked: "deleteBlocked", fileImportError: "fileImportError" }, host: { properties: { "attr.disabled": "this._attrDisabled", "attr.tabindex": "this._attrTabIndex" } }, providers: [
             MapValueManagerService,
             GoogleMapsService,
             { provide: MAP_CONTROLS_SERVICE, useClass: GoogleMapsControlsService },
@@ -3584,6 +3682,8 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "20.3.15", ngImpo
                 type: Output
             }], deleteBlocked: [{
                 type: Output
+            }], fileImportError: [{
+                type: Output
             }], featureContextMenu: [{
                 type: ViewChild,
                 args: ['featureContextMenu', { static: true, read: MenuComponent }]