@myrmidon/gve-core 7.0.8 → 7.0.9

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@myrmidon/gve-core",
-  "version": "7.0.8",
+  "version": "7.0.9",
   "description": "Cadmus - GVE Angular frontend core components.",
   "keywords": [
     "GVE"

package/types/myrmidon-gve-core.d.ts

@@ -6,7 +6,6 @@ import { DialogService } from '@myrmidon/ngx-mat-tools';
 import { HttpClient } from '@angular/common/http';
 import { Observable } from 'rxjs';
 import { ErrorService, EnvService } from '@myrmidon/ngx-tools';
-import { Clipboard } from '@angular/cdk/clipboard';
 import { MatSnackBar } from '@angular/material/snack-bar';
 import { GveSnapshotRendition, GveRenditionSettings } from '@myrmidon/gve-snapshot-rendition';
 
@@ -607,94 +606,6 @@ declare class BatchOperationEditorComponent implements OnInit {
     static ɵcmp: _angular_core.ɵɵComponentDeclaration<BatchOperationEditorComponent, "gve-batch-operation-editor", never, { "preset": { "alias": "preset"; "required": false; "isSignal": true; }; }, { "operationsChange": "operationsChange"; }, never, never, true, never>;
 }
 
-/**
- * Service to store and retrieve dynamic settings.
- */
-declare class SettingsService {
-    private readonly _cache;
-    private readonly _subject;
-    /**
-     * Observable emitting the key of the setting that has changed.
-     */
-    get settingChange$(): Observable<string | null>;
-    /**
-     * Prefix to scope the keys. This prefix is used internally to scope the keys
-     * so that they cannot conflict with other keys in the local storage.
-     * The prefix is totally transparent to the user of the service, who should
-     * use the keys without the prefix.
-     */
-    keyPrefix?: string;
-    /**
-     * True to persist the settings in the local storage by default.
-     */
-    persistDefault: boolean;
-    /**
-     * Scopes the key by prefixing it with the keyPrefix if any.
-     *
-     * @param key The key to scope.
-     * @returns The scoped key.
-     */
-    private getScopedKey;
-    private isPersist;
-    /**
-     * Sets a setting's value.
-     *
-     * @param key The key.
-     * @param value The value.
-     * @param persist True to persist this setting in local storage.
-     */
-    set(key: string, value: any, persist?: boolean): void;
-    /**
-     * Set multiple settings at once from the specified settings object.
-     *
-     * @param settings The settings to set.
-     * @param persist True to persist these settings in local storage.
-     */
-    setFrom(settings: {
-        [key: string]: any;
-    } | undefined | null, persist?: boolean): void;
-    /**
-     * Get a setting's value of type T.
-     *
-     * @param key The key.
-     * @param defaultValue The default value to get when the setting
-     * is not found in the store.
-     * @returns The value.
-     */
-    get<T>(key: string, defaultValue?: any, persist?: boolean): T;
-    /**
-     * Check if a key exists in the store.
-     *
-     * @param key The key.
-     * @param persist True to check if the key exists in local storage.
-     * @returns True if the key exists in the store.
-     */
-    contains(key: string, persist?: boolean): boolean;
-    /**
-     * Get all the keys of the settings in the store.
-     *
-     * @param persist True to include keys from local storage.
-     * @returns The keys of the settings in the store.
-     */
-    getKeys(persist?: boolean): string[];
-    /**
-     * Remove a setting if present.
-     *
-     * @param key The key.
-     * @param persist True to remove the setting from local storage.
-     */
-    remove(key: string, persist?: boolean): void;
-    /**
-     * Clear all settings. Warning: this will remove all settings from the
-     * local storage if no key prefix is set.
-     *
-     * @param persist True to remove all settings from local storage.
-     */
-    clear(persist?: boolean): void;
-    static ɵfac: _angular_core.ɵɵFactoryDeclaration<SettingsService, never>;
-    static ɵprov: _angular_core.ɵɵInjectableDeclaration<SettingsService>;
-}
-
 /**
  * Features map. This is used for features from closed sets,
  * and lists the possible values for each feature.
@@ -704,6 +615,20 @@ declare class SettingsService {
 interface FeatureMap {
     [key: string]: LabeledId[];
 }
+/**
+ * Feature properties map. This is used to preset properties like set policy,
+ * negation, global, and short-lived for specific features without hardcoding
+ * that logic in the component. The key is the feature name's ID, and the
+ * value is an object containing the properties to preset for that feature.
+ */
+interface FeaturePropMap {
+    [key: string]: {
+        setPolicy: FeatureSetPolicy;
+        isNegated?: boolean;
+        isGlobal?: boolean;
+        isShortLived?: boolean;
+    };
+}
 /**
  * 🔑 `gve-feature-editor`
  *
@@ -742,6 +667,14 @@ declare class FeatureEditorComponent implements OnInit, OnDestroy {
      * to populate the value selection.
      */
     readonly featValues: _angular_core.InputSignal<FeatureMap | undefined>;
+    /**
+     * The feature properties map. When specified and the user selects a
+     * feature name present in the map keys, the corresponding properties
+     * will be used to populate the form controls for set policy, negation,
+     * global, and short-lived. This allows presetting these properties
+     * for specific features without hardcoding that logic in the component.
+     */
+    readonly featProps: _angular_core.InputSignal<FeaturePropMap | undefined>;
     /**
      * The feature to edit.
      */
@@ -796,7 +729,7 @@ declare class FeatureEditorComponent implements OnInit, OnDestroy {
     cancel(): void;
     save(): void;
     static ɵfac: _angular_core.ɵɵFactoryDeclaration<FeatureEditorComponent, never>;
-    static ɵcmp: _angular_core.ɵɵComponentDeclaration<FeatureEditorComponent, "gve-feature-editor", never, { "featNames": { "alias": "featNames"; "required": false; "isSignal": true; }; "featValues": { "alias": "featValues"; "required": false; "isSignal": true; }; "feature": { "alias": "feature"; "required": false; "isSignal": true; }; "isVar": { "alias": "isVar"; "required": false; "isSignal": true; }; "multiValuedFeatureIds": { "alias": "multiValuedFeatureIds"; "required": false; "isSignal": true; }; }, { "feature": "featureChange"; "featureCancel": "featureCancel"; }, never, never, true, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<FeatureEditorComponent, "gve-feature-editor", never, { "featNames": { "alias": "featNames"; "required": false; "isSignal": true; }; "featValues": { "alias": "featValues"; "required": false; "isSignal": true; }; "featProps": { "alias": "featProps"; "required": false; "isSignal": true; }; "feature": { "alias": "feature"; "required": false; "isSignal": true; }; "isVar": { "alias": "isVar"; "required": false; "isSignal": true; }; "multiValuedFeatureIds": { "alias": "multiValuedFeatureIds"; "required": false; "isSignal": true; }; }, { "feature": "featureChange"; "featureCancel": "featureCancel"; }, never, never, true, never>;
 }
 
 /**
@@ -814,6 +747,14 @@ interface FeatureDefinitions {
      * to populate the value selection.
      */
     values?: FeatureMap;
+    /**
+     * The feature properties map. When specified and the user selects a
+     * feature name present in the map keys, the corresponding properties
+     * will be used to populate the form controls for set policy, negation,
+     * global, and short-lived. This allows presetting these properties
+     * for specific features without hardcoding that logic in the component.
+     */
+    props?: FeaturePropMap;
 }
 /**
  * 🔑 `gve-chain-operation-editor`
@@ -826,7 +767,7 @@ interface FeatureDefinitions {
  * - ▶️ `sourceIds` (`LabeledId[]`): the list of source IDs, when using a closed list.
  * - ▶️ `sourceTypes` (`LabeledId[]`): the list of source types, when using a closed list.
  * - ▶️ `featureDefs` (`FeatureDefinitions`): definitions for features, including
- * names and values.
+ * names, values, and properties.
  * - ▶️ `rangePatch` (`BaseTextRange`): when set, the edited operation's text
  * range (at and run) will be patched with the provided one.
  * - 🔥 `operationChange` (`CharChainOperation`): emitted when the operation
@@ -872,9 +813,6 @@ interface FeatureDefinitions {
  * as a whole.
  */
 declare class ChainOperationEditorComponent implements OnInit, OnDestroy {
-    private _clipboard;
-    private _settings;
-    private _dialogService;
     private readonly _subs;
     private readonly _nanoid;
     /**
@@ -890,7 +828,7 @@ declare class ChainOperationEditorComponent implements OnInit, OnDestroy {
      */
     readonly hidePreview: _angular_core.InputSignal<boolean | undefined>;
     /**
-     * Definitions for features, including names and values.
+     * Definitions for features, including names, values, and properties.
      */
     readonly featureDefs: _angular_core.InputSignal<FeatureDefinitions | undefined>;
     /**
@@ -951,7 +889,7 @@ declare class ChainOperationEditorComponent implements OnInit, OnDestroy {
     newTextHidden: FormControl<boolean>;
     dpFeatures: FormControl<Feature[]>;
     form: FormGroup;
-    constructor(formBuilder: FormBuilder, _clipboard: Clipboard, _settings: SettingsService, _dialogService: DialogService);
+    constructor(formBuilder: FormBuilder);
     ngOnInit(): void;
     ngOnDestroy(): void;
     private toggleLfEscape;
@@ -1096,6 +1034,14 @@ declare class FeatureSetEditorComponent implements OnInit, OnDestroy {
      * to populate the value selection.
      */
     readonly featValues: _angular_core.InputSignal<FeatureMap | undefined>;
+    /**
+     * The feature properties map. When specified and the user selects a
+     * feature name present in the map keys, the corresponding properties
+     * will be used to populate the form controls for set policy, negation,
+     * global, and short-lived. This allows presetting these properties
+     * for specific features without hardcoding that logic in the component.
+     */
+    readonly featProps: _angular_core.InputSignal<FeaturePropMap | undefined>;
     /**
      * The threshold at which the features filter should become visible.
      * If set to 0, the filter is always visible; if set to -1, it is always
@@ -1142,7 +1088,7 @@ declare class FeatureSetEditorComponent implements OnInit, OnDestroy {
     onFeatureCancel(): void;
     onOk(): void;
     static ɵfac: _angular_core.ɵɵFactoryDeclaration<FeatureSetEditorComponent, never>;
-    static ɵcmp: _angular_core.ɵɵComponentDeclaration<FeatureSetEditorComponent, "gve-feature-set-editor", never, { "isVar": { "alias": "isVar"; "required": false; "isSignal": true; }; "featNames": { "alias": "featNames"; "required": false; "isSignal": true; }; "featValues": { "alias": "featValues"; "required": false; "isSignal": true; }; "filterThreshold": { "alias": "filterThreshold"; "required": false; "isSignal": true; }; "multiValuedFeatureIds": { "alias": "multiValuedFeatureIds"; "required": false; "isSignal": true; }; "batchMode": { "alias": "batchMode"; "required": false; "isSignal": true; }; "features": { "alias": "features"; "required": false; "isSignal": true; }; }, { "close": "close"; "features": "featuresChange"; }, never, never, true, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<FeatureSetEditorComponent, "gve-feature-set-editor", never, { "isVar": { "alias": "isVar"; "required": false; "isSignal": true; }; "featNames": { "alias": "featNames"; "required": false; "isSignal": true; }; "featValues": { "alias": "featValues"; "required": false; "isSignal": true; }; "featProps": { "alias": "featProps"; "required": false; "isSignal": true; }; "filterThreshold": { "alias": "filterThreshold"; "required": false; "isSignal": true; }; "multiValuedFeatureIds": { "alias": "multiValuedFeatureIds"; "required": false; "isSignal": true; }; "batchMode": { "alias": "batchMode"; "required": false; "isSignal": true; }; "features": { "alias": "features"; "required": false; "isSignal": true; }; }, { "close": "close"; "features": "featuresChange"; }, never, never, true, never>;
 }
 
 /**
@@ -1687,5 +1633,93 @@ declare class GveGraphvizService {
     static ɵprov: _angular_core.ɵɵInjectableDeclaration<GveGraphvizService>;
 }
 
+/**
+ * Service to store and retrieve dynamic settings.
+ */
+declare class SettingsService {
+    private readonly _cache;
+    private readonly _subject;
+    /**
+     * Observable emitting the key of the setting that has changed.
+     */
+    get settingChange$(): Observable<string | null>;
+    /**
+     * Prefix to scope the keys. This prefix is used internally to scope the keys
+     * so that they cannot conflict with other keys in the local storage.
+     * The prefix is totally transparent to the user of the service, who should
+     * use the keys without the prefix.
+     */
+    keyPrefix?: string;
+    /**
+     * True to persist the settings in the local storage by default.
+     */
+    persistDefault: boolean;
+    /**
+     * Scopes the key by prefixing it with the keyPrefix if any.
+     *
+     * @param key The key to scope.
+     * @returns The scoped key.
+     */
+    private getScopedKey;
+    private isPersist;
+    /**
+     * Sets a setting's value.
+     *
+     * @param key The key.
+     * @param value The value.
+     * @param persist True to persist this setting in local storage.
+     */
+    set(key: string, value: any, persist?: boolean): void;
+    /**
+     * Set multiple settings at once from the specified settings object.
+     *
+     * @param settings The settings to set.
+     * @param persist True to persist these settings in local storage.
+     */
+    setFrom(settings: {
+        [key: string]: any;
+    } | undefined | null, persist?: boolean): void;
+    /**
+     * Get a setting's value of type T.
+     *
+     * @param key The key.
+     * @param defaultValue The default value to get when the setting
+     * is not found in the store.
+     * @returns The value.
+     */
+    get<T>(key: string, defaultValue?: any, persist?: boolean): T;
+    /**
+     * Check if a key exists in the store.
+     *
+     * @param key The key.
+     * @param persist True to check if the key exists in local storage.
+     * @returns True if the key exists in the store.
+     */
+    contains(key: string, persist?: boolean): boolean;
+    /**
+     * Get all the keys of the settings in the store.
+     *
+     * @param persist True to include keys from local storage.
+     * @returns The keys of the settings in the store.
+     */
+    getKeys(persist?: boolean): string[];
+    /**
+     * Remove a setting if present.
+     *
+     * @param key The key.
+     * @param persist True to remove the setting from local storage.
+     */
+    remove(key: string, persist?: boolean): void;
+    /**
+     * Clear all settings. Warning: this will remove all settings from the
+     * local storage if no key prefix is set.
+     *
+     * @param persist True to remove all settings from local storage.
+     */
+    clear(persist?: boolean): void;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<SettingsService, never>;
+    static ɵprov: _angular_core.ɵɵInjectableDeclaration<SettingsService>;
+}
+
 export { BaseTextCharComponent, BaseTextEditorComponent, BaseTextViewComponent, BatchOperationEditorComponent, ChainOperationEditorComponent, ChainResultViewComponent, FeatureEditorComponent, FeatureSetEditorComponent, FeatureSetPolicy, FeatureSetViewComponent, GveApiService, GveBaseTextService, GveGraphvizService, OperationSourceEditorComponent, OperationType, SettingsService, SnapshotEditorComponent, SnapshotTextEditorComponent, StepsMapComponent };
-export type { BaseTextChar, BaseTextCharEvent, BaseTextRange, ChainOperationContextStep, ChainOperationTags, CharChain, CharChainLink, CharChainNode, CharChainOperation, CharChainResult, CharNode, Feature, FeatureDefinitions, FeatureMap, GraphvizRankdir, LabeledId, OperationFeature, OperationMetadata, OperationSource, PayloadMatDialogConfig, ResultWrapper, Snapshot, TreeNode };
+export type { BaseTextChar, BaseTextCharEvent, BaseTextRange, ChainOperationContextStep, ChainOperationTags, CharChain, CharChainLink, CharChainNode, CharChainOperation, CharChainResult, CharNode, Feature, FeatureDefinitions, FeatureMap, FeaturePropMap, GraphvizRankdir, LabeledId, OperationFeature, OperationMetadata, OperationSource, PayloadMatDialogConfig, ResultWrapper, Snapshot, TreeNode };