@myrmidon/gve-core 1.0.0 → 2.0.0

package/lib/components/animation-timeline-set/animation-timeline-set.component.d.ts

@@ -1,6 +1,6 @@
 import { EventEmitter } from '@angular/core';
 import { FormBuilder, FormControl, FormGroup } from '@angular/forms';
-import { DialogService } from '@myrmidon/ng-mat-tools';
+import { DialogService } from '@myrmidon/ngx-mat-tools';
 import { GveAnimationTimeline } from '@myrmidon/gve-snapshot-view';
 import * as i0 from "@angular/core";
 /**

package/lib/components/base-text-editor/base-text-editor.component.d.ts

@@ -1,7 +1,7 @@
 import { EventEmitter } from '@angular/core';
 import { FormBuilder, FormControl, FormGroup } from '@angular/forms';
 import { CharNode, Feature } from '@myrmidon/gve-snapshot-view';
-import { DialogService } from '@myrmidon/ng-mat-tools';
+import { DialogService } from '@myrmidon/ngx-mat-tools';
 import { BaseTextCharEvent } from '../base-text-char/base-text-char.component';
 import { VarBaseTextRange } from '../base-text-view/base-text-view.component';
 import * as i0 from "@angular/core";

package/lib/components/base-text-view/base-text-view.component.d.ts

@@ -1,6 +1,6 @@
 import { EventEmitter } from '@angular/core';
-import { BaseTextChar, BaseTextCharEvent } from '../base-text-char/base-text-char.component';
 import { CharNode } from '@myrmidon/gve-snapshot-view';
+import { BaseTextChar, BaseTextCharEvent } from '../base-text-char/base-text-char.component';
 import * as i0 from "@angular/core";
 /**
  * A range in the base text.
@@ -24,8 +24,9 @@ export interface VarBaseTextRange {
  * - 🔥 `rangePick` (`VarBaseTextRange`): emitted when a range is picked.
  */
 export declare class BaseTextViewComponent {
-    private _text?;
+    private _text;
     private _lastSelectedChar?;
+    private _borderColorCallback?;
     /**
      * The default color for the text.
      */
@@ -45,8 +46,14 @@ export declare class BaseTextViewComponent {
     /**
      * The text to display.
      */
-    get text(): string | CharNode[] | undefined;
-    set text(value: string | CharNode[] | undefined | null);
+    get text(): CharNode[] | undefined;
+    set text(value: CharNode[] | undefined | null);
+    /**
+     * An optional callback to get the color of a character node.
+     * Return null to use the default color.
+     */
+    get borderColorCallback(): ((node: CharNode) => string | null) | undefined;
+    set borderColorCallback(value: ((node: CharNode) => string | null) | undefined);
     /**
      * Emitted when a character is picked.
      */
@@ -62,5 +69,5 @@ export declare class BaseTextViewComponent {
     private resetColors;
     onCharPick(event: BaseTextCharEvent): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<BaseTextViewComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<BaseTextViewComponent, "gve-base-text-view", never, { "defaultColor": { "alias": "defaultColor"; "required": false; }; "defaultBorderColor": { "alias": "defaultBorderColor"; "required": false; }; "selectionColor": { "alias": "selectionColor"; "required": false; }; "hasLineNumber": { "alias": "hasLineNumber"; "required": false; }; "text": { "alias": "text"; "required": false; }; }, { "charPick": "charPick"; "rangePick": "rangePick"; }, never, never, true, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<BaseTextViewComponent, "gve-base-text-view", never, { "defaultColor": { "alias": "defaultColor"; "required": false; }; "defaultBorderColor": { "alias": "defaultBorderColor"; "required": false; }; "selectionColor": { "alias": "selectionColor"; "required": false; }; "hasLineNumber": { "alias": "hasLineNumber"; "required": false; }; "text": { "alias": "text"; "required": false; }; "borderColorCallback": { "alias": "borderColorCallback"; "required": false; }; }, { "charPick": "charPick"; "rangePick": "rangePick"; }, never, never, true, never>;
 }

package/lib/components/chain-operation-editor/chain-operation-editor.component.d.ts

@@ -1,7 +1,7 @@
 import { EventEmitter, OnDestroy, OnInit } from '@angular/core';
 import { FormBuilder, FormControl, FormGroup } from '@angular/forms';
 import { Clipboard } from '@angular/cdk/clipboard';
-import { DialogService } from '@myrmidon/ng-mat-tools';
+import { DialogService } from '@myrmidon/ngx-mat-tools';
 import { CharChainOperation, Feature, OperationFeature, OperationType, OperationSource, SnapshotBase } from '@myrmidon/gve-snapshot-view';
 import { SettingsService } from '../../services/settings.service';
 import * as i0 from "@angular/core";
@@ -114,6 +114,7 @@ export declare class ChainOperationEditorComponent implements OnInit, OnDestroy
     value: FormControl<string | null>;
     svg: FormControl<string>;
     elementFeatures: FormControl<Record<string, Feature[]>>;
+    newTextHidden: FormControl<boolean>;
     dpFeatures: FormControl<Feature[]>;
     form: FormGroup;
     elements: SVGElement[];
@@ -135,6 +136,8 @@ export declare class ChainOperationEditorComponent implements OnInit, OnDestroy
     loadSvg(): void;
     setSvgFromClipboard(): void;
     private parseSvg;
+    removeDecimals(): void;
+    wrapInGroup(): void;
     onTabIndexChange(index: number): void;
     editElementFeatures(element: SVGElement): void;
     deleteElementFeatures(element: SVGElement): void;

package/lib/components/chain-result-view/chain-result-view.component.d.ts

@@ -1,6 +1,6 @@
 import { EventEmitter, OnDestroy, OnInit } from '@angular/core';
 import { FormBuilder, FormControl } from '@angular/forms';
-import { OperationFeature } from '@myrmidon/gve-snapshot-view';
+import { CharNode, OperationFeature } from '@myrmidon/gve-snapshot-view';
 import { VarBaseTextRange } from '../base-text-view/base-text-view.component';
 import { ChainOperationContextStep, CharChainResult } from '../../services/gve-api.service';
 import { BaseTextCharEvent } from '../base-text-char/base-text-char.component';
@@ -46,6 +46,7 @@ export declare class ChainResultViewComponent implements OnInit, OnDestroy {
     selectionFeatures: OperationFeature[];
     constructor(formBuilder: FormBuilder);
     ngOnInit(): void;
+    getCharBorderColor(node: CharNode): string | null;
     private selectInitialStep;
     ngOnDestroy(): void;
     private updateVersionTags;

package/lib/components/feature-editor/feature-editor.component.d.ts

@@ -65,7 +65,7 @@ export declare class FeatureEditorComponent implements OnInit, OnDestroy {
     /**
      * Event emitted when the user saves the edited feature.
      */
-    featureChange: EventEmitter<Feature | OperationFeature>;
+    featureChange: EventEmitter<OperationFeature | Feature>;
     name: FormControl<string>;
     value: FormControl<string>;
     setPolicy: FormControl<FeatureSetPolicy>;

package/lib/components/snapshot-editor/snapshot-editor.component.d.ts

@@ -2,7 +2,7 @@ import { ElementRef, EventEmitter } from '@angular/core';
 import { FormBuilder, FormControl, FormGroup } from '@angular/forms';
 import { MatSnackBar } from '@angular/material/snack-bar';
 import { MatDialog } from '@angular/material/dialog';
-import { DialogService } from '@myrmidon/ng-mat-tools';
+import { DialogService } from '@myrmidon/ngx-mat-tools';
 import { CharChainOperation, CharNode, GveAnimationTimeline, GveVisualEvent, Snapshot, SnapshotViewComponent, SnapshotViewData, SnapshotViewRenderEvent } from '@myrmidon/gve-snapshot-view';
 import { VarBaseTextRange } from '../base-text-view/base-text-view.component';
 import { ChainOperationContextStep, CharChainResult, GveApiService } from '../../services/gve-api.service';
@@ -59,7 +59,7 @@ export declare class SnapshotEditorComponent {
     width: FormControl<number>;
     height: FormControl<number>;
     style: FormControl<string | null>;
-    baseText: FormControl<CharNode[] | string>;
+    baseText: FormControl<CharNode[]>;
     offsetX: FormControl<number>;
     offsetY: FormControl<number>;
     lineHeightOffset: FormControl<number>;
@@ -113,6 +113,7 @@ export declare class SnapshotEditorComponent {
      */
     private setViewData;
     private updateForm;
+    inputBaseText(): void;
     /**
      * Update the line count based on the received text.
      * @param text The text to use for counting lines.
@@ -123,11 +124,6 @@ export declare class SnapshotEditorComponent {
      * @param range The picked range.
      */
     onRangePick(range: VarBaseTextRange): void;
-    /**
-     * Handle the event fired by the base text editor to change the base text.
-     * @param text The text to set.
-     */
-    onTextChange(text: CharNode[]): void;
     /**
      * Update the lists of operation output tags and element IDs by collecting
      * all the operation tags and the IDs of the elements in their diplomatic.g
@@ -158,7 +154,7 @@ export declare class SnapshotEditorComponent {
      * was a new operation.
      * @param op The changed operation.
      */
-    onOperationChange(op: CharChainOperation): Promise<void>;
+    onOperationChange(op: CharChainOperation): void;
     /**
      * Delete the operation at the specified index.
      * @param index The index of the operation to delete.
@@ -169,6 +165,9 @@ export declare class SnapshotEditorComponent {
      * snapshot operations.
      */
     parseOperations(): void;
+    /**
+     * Remove all the operations, close the edited operation and update the view data.
+     */
     private removeAllOperations;
     /**
      * Remove all the operations.
@@ -183,6 +182,24 @@ export declare class SnapshotEditorComponent {
      */
     private parseSvgIds;
     private getTransparentIds;
+    /**
+     * Supply operation nodes to the snapshot text nodes. An execution result is
+     * a compact object, so that to build a snapshot accumulating all the nodes
+     * and their features up to the last executed operation, we need to start
+     * with the base text nodes, and then examine each execution step in the
+     * result. Each step contains only those nodes used by the version of the
+     * text corresponding to its stage. Among them, some are new nodes, and some
+     * are base text nodes. Also, the step contains the full set of features
+     * current at its time, both for the text as a whole and for each node.
+     * This method accumulates the nodes and their features up to the specified
+     * step, updating the features of the nodes already present in the snapshot
+     * text nodes, and adding the new nodes.
+     *
+     * @param snapshot The snapshot to supply the nodes to.
+     * @param result The operations execution result.
+     * @param tag The output tag of the operation to supply the nodes from.
+     */
+    private supplyOpNodes;
     /**
      * Run the operations up to the specified index (included).
      * This is called when:
@@ -198,14 +215,15 @@ export declare class SnapshotEditorComponent {
      * @param lastOperation The operation to use in place of the existing
      * operation in the snapshot at index. This is used when previewing
      * the edited operation from within the operation editor.
+     * @returns A promise that resolves to the execution result.
      */
-    runTo(index: number, lastOperation?: CharChainOperation): Promise<CharChainResult>;
+    runTo(index: number, lastOperation?: CharChainOperation): void;
     /**
      * Run the operations up to the last operation if any, updating the
      * execution result. The execution result is always the result from
      * all the operations, as users must be able to browse across its steps.
      */
-    runToLast(): Promise<void>;
+    runToLast(): void;
     /**
      * Update the snapshot view by running the operations up to the
      * currently edited operation if any.
@@ -230,7 +248,7 @@ export declare class SnapshotEditorComponent {
      *
      * @param step The step to pick.
      */
-    onStepPick(step: ChainOperationContextStep): Promise<void>;
+    onStepPick(step: ChainOperationContextStep): void;
     /**
      * Handle the event fired by a visual in the snapshot view.
      *
@@ -260,6 +278,9 @@ export declare class SnapshotEditorComponent {
      * @param event The rendition event.
      */
     onSnapshotRender(event: CustomEvent<SnapshotViewRenderEvent>): void;
+    onImageLoad(imageElement: HTMLImageElement): void;
+    onImageOpacityChange(value: number): void;
+    resetImgMetadata(): void;
     /**
      * Toggle rulers in the snapshot view.
      */

package/lib/components/snapshot-text-editor/snapshot-text-editor.component.d.ts

@@ -0,0 +1,39 @@
+import { EventEmitter, OnInit } from '@angular/core';
+import { FormBuilder, FormControl, FormGroup } from '@angular/forms';
+import { MatDialogRef } from '@angular/material/dialog';
+import { CharNode } from '@myrmidon/gve-snapshot-view';
+import { PayloadMatDialogConfig } from '../../models';
+import * as i0 from "@angular/core";
+/**
+ * 🔑 `gve-snapshot-text-editor`
+ *
+ * A component to edit a snapshot text. This component can be used both in a dialog
+ * and as a standalone component.
+ *
+ * - ▶️ `text` (`CharNode[]`): the text to edit.
+ * - 🔥 `textChange` (`CharNode[]`): event emitted when text changes.
+ */
+export declare class SnapshotTextEditorComponent implements OnInit {
+    dialogRef?: MatDialogRef<SnapshotTextEditorComponent> | undefined;
+    data?: PayloadMatDialogConfig<{
+        text?: CharNode[];
+    }> | undefined;
+    private _nodes;
+    userText: FormControl<string>;
+    form: FormGroup;
+    get text(): CharNode[];
+    set text(value: CharNode[] | undefined | null);
+    /**
+     * Emitted when text changes.
+     */
+    readonly textChange: EventEmitter<CharNode[]>;
+    constructor(formBuilder: FormBuilder, dialogRef?: MatDialogRef<SnapshotTextEditorComponent> | undefined, data?: PayloadMatDialogConfig<{
+        text?: CharNode[];
+    }> | undefined);
+    private updateUserText;
+    ngOnInit(): void;
+    close(): void;
+    save(): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<SnapshotTextEditorComponent, [null, { optional: true; }, { optional: true; }]>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<SnapshotTextEditorComponent, "gve-snapshot-text-editor", never, { "text": { "alias": "text"; "required": false; }; }, { "textChange": "textChange"; }, never, never, true, never>;
+}

package/lib/components/steps-map/steps-map.component.d.ts

@@ -22,7 +22,10 @@ import * as i0 from "@angular/core";
  */
 export declare class StepsMapComponent {
     private _steps?;
-    lines: string[];
+    private _selectedStep?;
+    lines: {
+        [key: string]: string[];
+    };
     /**
      * The steps to display.
      */
@@ -31,7 +34,8 @@ export declare class StepsMapComponent {
     /**
      * The step that is currently selected.
      */
-    selectedStep: ChainOperationContextStep | undefined;
+    get selectedStep(): ChainOperationContextStep | undefined;
+    set selectedStep(value: ChainOperationContextStep | undefined);
     /**
      * The font size of the steps text.
      */

package/lib/services/gve-api.service.d.ts

@@ -1,6 +1,6 @@
 import { HttpClient } from '@angular/common/http';
 import { Observable } from 'rxjs';
-import { ErrorService, EnvService } from '@myrmidon/ng-tools';
+import { ErrorService, EnvService } from '@myrmidon/ngx-tools';
 import { CharChainOperation, CharNode, OperationFeature } from '@myrmidon/gve-snapshot-view';
 import { ResultWrapper } from '../models';
 import * as i0 from "@angular/core";
@@ -21,13 +21,16 @@ export interface ChainOperationContextStep {
      */
     outputTag: string;
     /**
-     * The string synthetically representing the result.
+     * The string synthetically representing the resulting text
+     * version.
      */
     result?: string;
     /**
      * The features emitted up to the executed operation.
      * These are the features of the text as a whole, and
-     * those belonging to specific nodes.
+     * those belonging to specific nodes, each keyed under
+     * a string built with `v` + output version tag + `_`
+     * + node ID (e.g. `v1_2` for node with ID 2 at version 1).
      */
     featureSet: {
         features: OperationFeature[];
@@ -52,11 +55,15 @@ export interface CharChainResult {
      */
     chainDump: string;
     /**
-     * The list of unique tags in the chain.
+     * The list of all unique tags in the chain.
      */
     chainTags: string[];
     /**
      * The sets of nodes in their order, for each version tag.
+     * These nodes are collected by following the path defined
+     * by the set of links of each version tag; so each of the
+     * sets contains only the nodes used at that step to build
+     * the text version, with their features up to that stage.
      */
     taggedNodes: {
         [key: string]: CharNode[];

package/lib/services/settings.service.d.ts

@@ -1,10 +1,15 @@
+import { Observable } from 'rxjs';
 import * as i0 from "@angular/core";
 /**
- * Service to store and retrieve dynamic settings. On demand, settings can
- * be persisted in the local storage.
+ * Service to store and retrieve dynamic settings.
  */
 export 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.
@@ -12,6 +17,10 @@ export declare class SettingsService {
      * 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.
      *
@@ -19,6 +28,7 @@ export declare class SettingsService {
      * @returns The scoped key.
      */
     private getScopedKey;
+    private isPersist;
     /**
      * Sets a setting's value.
      *
@@ -27,6 +37,15 @@ export declare class SettingsService {
      * @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.
      *
@@ -35,20 +54,36 @@ export declare class SettingsService {
      * is not found in the store.
      * @returns The value.
      */
-    get<T>(key: string, defaultValue?: any): T;
+    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): boolean;
+    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.
      */
-    remove(key: string): void;
+    clear(persist?: boolean): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<SettingsService, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<SettingsService>;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@myrmidon/gve-core",
-  "version": "1.0.0",
+  "version": "2.0.0",
   "description": "Cadmus - GVE Angular frontend core components.",
   "keywords": [
     "GVE"
@@ -17,13 +17,13 @@
     "@angular/common": "^19.0.0",
     "@angular/core": "^19.0.0",
     "@cisstech/nge": "^18.0.4",
-    "@myrmidon/ng-mat-tools": "^4.0.0",
-    "@myrmidon/ng-tools": "^4.0.0",
-    "@myrmidon/gve-snapshot-view": "^1.1.2",
+    "@myrmidon/ngx-mat-tools": "^0.0.1",
+    "@myrmidon/ngx-tools": "^0.0.1",
+    "@myrmidon/gve-snapshot-view": "^1.1.6",
     "@svgdotjs/svg.js": "^3.2.4",
     "gsap": "^3.12.5",
     "monaco-editor": "^0.52.0",
-    "nanoid": "^5.0.8"
+    "nanoid": "^5.0.9"
   },
   "dependencies": {
     "tslib": "^2.3.0"

package/public-api.d.ts

@@ -14,6 +14,7 @@ export * from './lib/components/ln-heights-editor/ln-heights-editor.component';
 export * from './lib/components/operation-source-editor/operation-source-editor.component';
 export * from './lib/components/simple-tree/simple-tree.component';
 export * from './lib/components/snapshot-editor/snapshot-editor.component';
+export * from './lib/components/snapshot-text-editor/snapshot-text-editor.component';
 export * from './lib/components/steps-map/steps-map.component';
 export * from './lib/services/gve-api.service';
 export * from './lib/services/settings.service';