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

package/google-maps/index.d.ts

@@ -101,7 +101,7 @@ declare class GoogleMapsService implements OnDestroy {
      * delay-free discriminator: a stale click's timestamp should predate the
      * moment the draw finished. It does not hold up empirically. Driving real
      * mouse draws against the live Storybook and logging both the map `click`
-     * listener and `stopDrawing()` (see .superpowers/closing-click-report.md)
+     * listener and `stopDrawing()` (see docs/superpowers/reports/closing-click-report.md)
      * caught the echo repeatedly, and every single time its `domEvent.timeStamp`
      * was a few milliseconds AFTER `stopDrawing()`'s own timestamp, not before
      * — indistinguishable from a genuinely fresh click by timestamp alone.
@@ -127,6 +127,14 @@ declare class GoogleMapsService implements OnDestroy {
     private _labelProperty;
     private _labelsOverlay?;
     private _warnedAboutLabelDisagreement;
+    private _canDelete;
+    private readonly _deleteBlockedSubject;
+    /**
+     * A delete that was attempted and refused. Fires only from the three delete
+     * commands, never from their `canDelete*` queries — rendering a menu is not
+     * an attempt.
+     */
+    readonly deleteBlocked$: Observable<TheSeamMapGroupTarget>;
     private readonly _selectionSubject;
     /**
      * `distinctUntilChanged` collapses repeated `null`s. Several paths clear the
@@ -176,6 +184,70 @@ declare class GoogleMapsService implements OnDestroy {
     /**
      * Iterates the map's features and removes any that are selected.
      */
+    private _removeSelection;
+    /**
+     * The consumer's veto. Consulted for every delete on every path, and for
+     * whether to offer a delete at all.
+     */
+    setCanDelete(predicate: ((target: TheSeamMapGroupTarget) => boolean) | undefined | null): void;
+    /**
+     * Pair a set of features to remove with the target to consult `canDelete`
+     * with. `null` when there is nothing to delete — distinct from a refusal,
+     * and the reason no honest target exists to report.
+     *
+     * Builds `target.feature` itself rather than delegating the decision to
+     * `_targetFor`. There, `feature: null` means only "no particular feature";
+     * here it is a promise that the whole group is about to cease to exist.
+     * Conflating the two is what let a delete of ONE polygon be consulted as a
+     * group delete — see `ResolvedDeletion.unnamable`.
+     */
+    private _deletionOf;
+    /** Resolves the same features `_removeSelection()` would remove. */
+    private _selectionDeletion;
+    /** Resolves the same features `_removeFocusedFeature()` would remove. */
+    private _focusedFeatureDeletion;
+    /** Resolves the same features `_removeGroup(key)` would remove. */
+    private _groupDeletion;
+    /**
+     * Whether `removing` may be deleted: the feature-declared lock first, then
+     * the consumer's predicate.
+     *
+     * MUST stay pure. It also answers menu-render questions, which are not
+     * delete attempts — a side effect here would fire on every right-click.
+     */
+    private _mayDelete;
+    /**
+     * Whether a resolved deletion may proceed. The single gate every query and
+     * every command goes through.
+     *
+     * Wraps `_mayDelete` with the one refusal that cannot be phrased as a
+     * question about a target: an `unnamable` delete. Consulting the predicate
+     * there would mean LYING to it — handing it `feature: null`, which promises
+     * the whole group is about to cease to exist, for a delete that removes one
+     * polygon and leaves the rest standing. A consumer whose rule is "a field
+     * may be deleted, an individual polygon may not" answers `true` to that and
+     * loses a polygon it meant to keep. Fail closed exactly where a consumer's
+     * rule could be subverted.
+     *
+     * Only when a predicate is actually set. With none there is nobody to lie
+     * to, so there is nothing to protect — and refusing unconditionally would
+     * change 'legacy' mode's behaviour for unsupported-geometry features, which
+     * two applications depend on and this work must not drift.
+     *
+     * Pure, like `_mayDelete`: it also answers menu-render questions.
+     */
+    private _mayDeleteResolved;
+    /** Whether "Delete Polygon" (or the `Delete` key) may act. */
+    canDeleteFocusedFeature(): boolean;
+    /** Whether "Delete Field" may act on `key`. */
+    canDeleteGroup(key: string): boolean;
+    /** Whether the legacy "Delete" item (or the `Delete` key) may act. */
+    canDeleteSelection(): boolean;
+    /**
+     * Remove every selected feature, unless `canDelete` or a feature's own
+     * `editable: false` refuses. A refused delete emits on `deleteBlocked$` and
+     * changes nothing.
+     */
     deleteSelection(): void;
     /**
      * Delete every feature in `key`'s group. Backs the grouped "Delete Field"
@@ -190,6 +262,12 @@ declare class GoogleMapsService implements OnDestroy {
      * selected, a coincidence this design has already stopped being true once
      * before and could again.
      */
+    private _removeGroup;
+    /**
+     * Remove every feature in `key`'s group, unless `canDelete` or a feature's
+     * own `editable: false` refuses. A refused delete emits on `deleteBlocked$`
+     * and changes nothing.
+     */
     deleteGroup(key: string): void;
     /**
      * Whether polygon drawing mode is currently active.
@@ -281,6 +359,25 @@ declare class GoogleMapsService implements OnDestroy {
      * even constructed).
      */
     setLabelProperty(property: string | undefined): void;
+    /**
+     * Write `label` into `featureLabelProperty` on every feature in `key`'s
+     * group, without re-adding any data. Returns `false` when no feature
+     * carries `key`, or when no `featureLabelProperty` is configured — there is
+     * then no property to write the label into.
+     *
+     * Unlike a write through the map's `value`, this does NOT go through
+     * `setData()`, so the selection and the viewport are untouched. The
+     * repaint and the value update fall out of the data layer's own
+     * `setproperty` event, which `_initFeatureChangeListeners()` already turns
+     * into a `_labelsOverlay.refresh()` and a `MapValueSource.FeatureChange`
+     * emission.
+     *
+     * It DOES emit a value change, because the label is part of the GeoJSON and
+     * the value genuinely changed. Writing that emitted value straight back
+     * through the `value` input is inert: `MapValueManagerService.setValue`
+     * finds the serialized form identical and returns without emitting.
+     */
+    setGroupLabel(key: string, label: string): boolean;
     private _ensureLabelsOverlay;
     private _buildLabels;
     private _warnAboutLabelDisagreement;
@@ -328,6 +425,12 @@ declare class GoogleMapsService implements OnDestroy {
      * `feature` no longer exists — `_applySelection` naturally clears to null
      * when the group is now empty, via `groupWithSources`.
      */
+    private _removeFocusedFeature;
+    /**
+     * Remove the focused polygon — or, with nothing focused, the selection —
+     * unless `canDelete` or a feature's own `editable: false` refuses. A
+     * refused delete emits on `deleteBlocked$` and changes nothing.
+     */
     deleteFocusedFeature(): void;
     /** Escape cascades: cancel a draw, then clear selection, then leave edit mode. */
     handleEscape(): void;
@@ -375,7 +478,7 @@ declare class GoogleMapsService implements OnDestroy {
      * Arm `_suppressNextMapClick`, and guarantee it cannot linger forever if
      * the echo it exists for never arrives — confirmed to be the normal case
      * for most real closes, and true of every synthetic/`play()`-driven draw,
-     * per .superpowers/closing-click-report.md. A `setTimeout` would "solve"
+     * per docs/superpowers/reports/closing-click-report.md. A `setTimeout` would "solve"
      * this by guessing a safe wall-clock delay, which is exactly the kind of
      * timing window this fix is trying to avoid introducing. Two
      * `requestAnimationFrame` callbacks bound the window instead: the observed
@@ -409,10 +512,38 @@ interface MapControlsService {
 declare const MAP_CONTROLS_SERVICE: InjectionToken<MapControlsService>;
 declare const MAP_CONTROL_DATA: InjectionToken<any>;
 
+/** One entry in the map's feature context menu. */
 interface TheSeamMapContextMenuItem {
     label: string;
-    action: (item: TheSeamMapContextMenuItem) => void;
+    action: () => void;
+}
+/**
+ * What the menu needs from the map service to decide what to offer.
+ *
+ * Narrowed to the query/command pairs so the decision stays a pure function
+ * and can be tested without a rendered map.
+ */
+interface TheSeamMapDeleteMenuContext {
+    mode: TheSeamMapInteractionMode;
+    editingEnabled: boolean;
+    /** The group the menu is opening for, or null when nothing is targeted. */
+    target: TheSeamMapGroupTarget | null;
+    canDeleteFocusedFeature(): boolean;
+    canDeleteGroup(key: string): boolean;
+    canDeleteSelection(): boolean;
+    deleteFocusedFeature(): void;
+    deleteGroup(key: string): void;
+    deleteSelection(): void;
 }
+/**
+ * The delete items the feature context menu offers.
+ *
+ * A refused item is not rendered at all. The caller is expected to hide the
+ * menu entirely for an empty list, so a consumer that refuses everything gets
+ * no menu rather than an empty one.
+ */
+declare function buildDeleteMenuItems(context: TheSeamMapDeleteMenuContext): TheSeamMapContextMenuItem[];
+
 declare class TheSeamGoogleMapsComponentBase {
     _elementRef: ElementRef;
     constructor(_elementRef: ElementRef);
@@ -497,9 +628,37 @@ declare class TheSeamGoogleMapsComponent extends _TheSeamGoogleMapsMixinBase imp
     newGroupKeyFactory: (() => string) | undefined;
     /** Preselect a group. Applied on map-ready and after each external value write. */
     selectedGroupKey: string | null;
+    /**
+     * Vetoes a delete. Return `false` to refuse the target.
+     *
+     * `target.feature === null` means the whole group is about to cease to
+     * exist — every polygon of it is going, however the delete was asked for.
+     * A non-null `feature` means one polygon is being removed from a group that
+     * survives.
+     *
+     * **Consulted when no delete is happening.** It decides whether to render
+     * the context-menu items, so it runs on every context-menu open. A
+     * predicate that logs an attempt or flips state will do so on every
+     * right-click. It must also be deterministic for a given target, or the
+     * menu and the `Delete` key can disagree about the same target.
+     *
+     * That is a correctness warning, not a performance one. The context-menu
+     * target changes only on a right-click, a delete, and a value write, so
+     * this runs a handful of times per gesture.
+     *
+     * Passing nothing refuses nothing, which is the behaviour this component
+     * has always had.
+     */
+    canDelete: ((target: TheSeamMapGroupTarget) => boolean) | undefined;
     mapReady: EventEmitter<google.maps.Map | undefined>;
     selectionChange: EventEmitter<TheSeamMapGroupTarget | null>;
     featureHoverChange: EventEmitter<TheSeamMapGroupTarget | null>;
+    /**
+     * A delete was attempted and refused — in practice, the `Delete` key, since
+     * a refused menu item is never rendered. Emits the target that was refused
+     * so the consumer can explain why; only the consumer knows the reason.
+     */
+    deleteBlocked: EventEmitter<TheSeamMapGroupTarget>;
     featureContextMenu: MenuComponent;
     _options: {
         mapTypeControl: boolean;
@@ -525,7 +684,6 @@ declare class TheSeamGoogleMapsComponent extends _TheSeamGoogleMapsMixinBase imp
     focus(): void;
     private _getHostElement;
     _onMapReady(theMap: google.maps.Map): void;
-    _onClickDeleteFeature(): void;
     /** Select a group by key. Returns false when no such group exists. */
     selectGroup(key: string): boolean;
     clearSelection(): void;
@@ -534,10 +692,18 @@ declare class TheSeamGoogleMapsComponent extends _TheSeamGoogleMapsMixinBase imp
     /** Pan to a group's centre. Returns false when no such group exists. */
     panToGroup(key: string): boolean;
     getGroups(): TheSeamMapFeatureGroup[];
+    /**
+     * Set a group's label text in place. Returns false when no such group
+     * exists, or when no `featureLabelProperty` is set.
+     *
+     * Does not clear the selection or re-fit the viewport, so it is safe to
+     * call while the user is renaming the very group being displayed.
+     */
+    setGroupLabel(key: string, label: string): boolean;
     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; }; }, { "mapReady": "mapReady"; "selectionChange": "selectionChange"; "featureHoverChange": "featureHoverChange"; }, 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"; }, never, never, false, never>;
 }
 
 /**
@@ -933,6 +1099,21 @@ interface TheSeamMapFeatureStyleContext {
 }
 /** Merge only the supported subset of one options object into another. */
 declare function mergeStyleOptions(target: google.maps.Data.StyleOptions, source: google.maps.Data.StyleOptions | undefined): google.maps.Data.StyleOptions;
+/**
+ * Whether the feature declines to opt OUT of `option`.
+ *
+ * Resolved per key, not per object: a selected feature consults
+ * `styleOptionsSelected` first and falls back to `styleOptions` only for a key
+ * `styleOptionsSelected` does not itself mention. Otherwise a feature
+ * declaring `styleOptionsSelected` for an unrelated reason, such as a
+ * different selected fill colour, would silently lose an unrelated
+ * `editable: false` from `styleOptions` the moment it is selected.
+ *
+ * Only an explicit `false` opts out. Shared by `computeFeatureStyle` and the
+ * delete gate in `GoogleMapsService`, so the lock a consumer declares means
+ * the same thing to both.
+ */
+declare function featureAllows(feature: google.maps.Data.Feature, option: 'editable' | 'draggable' | 'clickable'): boolean;
 /**
  * The style for a feature, in a fixed precedence order:
  *
@@ -960,10 +1141,10 @@ declare function mergeStyleOptions(target: google.maps.Data.StyleOptions, source
  * feature that opts out of one opts out of the other. This implication runs
  * only one way — `draggable: false` alone does not imply `editable: false`, so
  * a feature may still opt out of dragging while remaining reshapeable via its
- * vertex handles. Resolved through the same per-key `wants()` lookup as
- * `editable` itself, so a feature that locks `editable: false` in
- * `styleOptions` cannot be dragged even if `styleOptionsSelected` declares
- * `draggable` for an unrelated reason (or not at all).
+ * vertex handles. Resolved through `featureAllows`, which the delete gate
+ * shares, so a feature that locks `editable: false` in `styleOptions` cannot
+ * be dragged even if `styleOptionsSelected` declares `draggable` for an
+ * unrelated reason (or not at all).
  */
 declare function computeFeatureStyle(feature: google.maps.Data.Feature, context: TheSeamMapFeatureStyleContext): google.maps.Data.StyleOptions;
 /**
@@ -1078,5 +1259,5 @@ declare class TheSeamNoopGoogleMapsAPILoader extends TheSeamGoogleMapsApiLoader
     static ɵprov: i0.ɵɵInjectableDeclaration<TheSeamNoopGoogleMapsAPILoader>;
 }
 
-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, computeFeatureHoverStyle, computeFeatureStyle, createFeatureChangeObservable, dataMultiPolygonFromGeoJson, dataPolygonFromGeoJson, 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, TheSeamMapFeatureGroup, TheSeamMapFeatureStyleContext, TheSeamMapGroupTarget, TheSeamMapInteractionMode };
+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 };

package/package.json

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