@dereekb/dbx-core 14.17.0 → 14.18.0

package/fesm2022/dereekb-dbx-core.mjs

@@ -453,6 +453,31 @@ class DbxActionContextStoreSourceInstance {
     destroy() {
         this.lockSet.destroyOnNextUnlock();
     }
+    // MARK: Value Snapshot
+    /**
+     * Registers the function that returns the value a trigger would ready right now. See {@link ActionContextStore.registerValueSnapshot}.
+     *
+     * @param valueSnapshotFunction - Function that returns the current value.
+     * @returns Removes the registration when called.
+     */
+    registerValueSnapshot(valueSnapshotFunction) {
+        let unregister;
+        const sub = this.useStore((x) => (unregister = x.registerValueSnapshot(valueSnapshotFunction)));
+        return () => {
+            sub.unsubscribe();
+            unregister?.();
+        };
+    }
+    /**
+     * Returns the value a trigger would ready right now, without triggering the action. See {@link ActionContextStore.valueSnapshot}.
+     *
+     * @returns The current value, or undefined when it is not available synchronously.
+     */
+    valueSnapshot() {
+        let snapshot;
+        this.useStore((x) => (snapshot = x.valueSnapshot())).unsubscribe();
+        return snapshot;
+    }
     // MARK: Store
     get store$() {
         return this.source.store$;
@@ -1168,6 +1193,7 @@ class ActionContextStore extends ComponentStore {
             delayTime: ACTION_CONTEXT_STORE_LOCKSET_DESTROY_DELAY_TIME
         }
     });
+    _valueSnapshotFunction;
     constructor() {
         super({ ...INITIAL_STATE$3 });
         this.lockSet.addLock('working', this.isWorking$);
@@ -1367,6 +1393,34 @@ class ActionContextStore extends ComponentStore {
         return this.state$.pipe(map((x) => [x, loadingStateTypeForActionContextState(x)]), distinctUntilChanged((a, b) => a?.[1] === b?.[1]), // Filter out when the loading state remains the same.
         map((x) => x[0]), shareReplay(1));
     }
+    // MARK: Value Snapshot
+    /**
+     * Registers the function that returns the value a trigger would ready right now. Registered by the action's value source, such as dbxActionValue or dbxActionForm.
+     *
+     * Only one function is kept, so a later registration replaces an earlier one.
+     *
+     * @param valueSnapshotFunction - Function that returns the current value.
+     * @returns Removes the registration when called, unless it was already replaced.
+     */
+    registerValueSnapshot(valueSnapshotFunction) {
+        this._valueSnapshotFunction = valueSnapshotFunction;
+        return () => {
+            if (this._valueSnapshotFunction === valueSnapshotFunction) {
+                this._valueSnapshotFunction = undefined;
+            }
+        };
+    }
+    /**
+     * Returns the value a trigger would ready right now, without triggering the action.
+     *
+     * Lets a change be applied synchronously when the action's own trigger path and its delays can no longer run, such as right before
+     * the content that holds the action is destroyed.
+     *
+     * @returns The current value, or undefined when no value source registered a snapshot or its value is not available synchronously.
+     */
+    valueSnapshot() {
+        return this._valueSnapshotFunction?.();
+    }
     // MARK: Cleanup
     // eslint-disable-next-line @angular-eslint/no-empty-lifecycle-method
     ngOnDestroy() {
@@ -2666,6 +2720,16 @@ class DbxActionValueDirective {
                 this.source.readyValue(value);
             })
         });
+        clean(this.source.registerValueSnapshot(() => this.valueSnapshot()));
+    }
+    /**
+     * Returns the value a trigger would ready right now, without triggering the action.
+     *
+     * @returns The current value, or undefined when no value is set.
+     */
+    valueSnapshot() {
+        const valueOrFunction = this._valueOrFunctionOverride.value ?? this.valueOrFunction();
+        return valueOrFunction == null ? undefined : { value: getValueFromGetter(valueOrFunction) };
     }
     setValueOrFunction(value) {
         this._valueOrFunctionOverride.next(value);
@@ -2835,6 +2899,7 @@ class DbxActionValueGetterInstance {
     }).pipe(shareReplay(1));
     source;
     _triggeredSub = new SubscriptionObject();
+    _unregisterValueSnapshot;
     constructor(config) {
         this.source = config.source;
         this.setValueGetterFunction(config.valueGetter);
@@ -2852,13 +2917,7 @@ class DbxActionValueGetterInstance {
     }
     init() {
         // Ready the value after the source is triggered. Do modified check one last time.
-        this._triggeredSub.subscription = this.source.triggered$
-            .pipe(switchMap(() => this.valueGetterFunction$.pipe(switchMap((valueGetter) => asObservable(valueGetter())), combineLatestWith(this.isModifiedFunction$), 
-        // If the value is not null/undefined and is considered modified, then pass the value.
-        switchMap(([value, isModifiedFunction]) => returnIfIs(isModifiedFunction, value, false).pipe(map((value) => ({ value })))), 
-        // Catch unknown errors and pass them to reject.
-        catchError((reject) => of({ reject: toReadableError(reject) })))))
-            .subscribe((result) => {
+        this._triggeredSub.subscription = this.source.triggered$.pipe(switchMap(() => this._valueResult())).subscribe((result) => {
             if (result.value == null) {
                 this.source.reject(result.reject);
             }
@@ -2866,8 +2925,32 @@ class DbxActionValueGetterInstance {
                 this.source.readyValue(result.value);
             }
         });
+        this._unregisterValueSnapshot = this.source.registerValueSnapshot(() => this.valueSnapshot());
+    }
+    /**
+     * Returns the value a trigger would ready right now, without triggering the action.
+     *
+     * Runs the same value getter and modified check as a trigger.
+     *
+     * @returns The current result, or undefined when the value getter or the modified check does not resolve synchronously.
+     */
+    valueSnapshot() {
+        let snapshot;
+        this._valueResult()
+            .pipe(first())
+            .subscribe((result) => (snapshot = result))
+            .unsubscribe();
+        return snapshot;
+    }
+    _valueResult() {
+        return this.valueGetterFunction$.pipe(switchMap((valueGetter) => asObservable(valueGetter())), combineLatestWith(this.isModifiedFunction$), 
+        // If the value is not null/undefined and is considered modified, then pass the value.
+        switchMap(([value, isModifiedFunction]) => returnIfIs(isModifiedFunction, value, false).pipe(map((value) => ({ value })))), 
+        // Catch unknown errors and pass them to reject.
+        catchError((reject) => of({ reject: toReadableError(reject) })));
     }
     destroy() {
+        this._unregisterValueSnapshot?.();
         this.source.lockSet.onNextUnlock(() => {
             this._valueGetterFunction.complete();
             this._isModifiedFunction.complete();