@acorex/platform 21.0.0-next.70 → 21.0.0-next.71

package/fesm2022/acorex-platform-core.mjs

@@ -1,12 +1,12 @@
 import * as i0 from '@angular/core';
 import { InjectionToken, inject, Injectable, Directive, computed, Injector, ChangeDetectionStrategy, Component, input, ElementRef, ViewContainerRef, signal, effect, runInInjectionContext, Optional, Inject, NgModule, EventEmitter, HostListener, Output, provideAppInitializer, Pipe } from '@angular/core';
-import { get, isPlainObject, set, isNil, isEmpty, isArray, merge, isObjectLike, transform, isEqual, differenceWith, union, cloneDeep, has, sortBy, isUndefined, endsWith, startsWith, includes, lte, gte, lt, gt, orderBy } from 'lodash-es';
+import { AXTranslationService, resolveMultiLanguageString } from '@acorex/core/translation';
+import { AXDataSource } from '@acorex/cdk/common';
+import { get, isPlainObject, set, isNil, isEmpty, isArray, merge, isObjectLike, transform, isEqual, differenceWith, union, cloneDeep, isObject, has, sortBy, isUndefined, endsWith, startsWith, includes, lte, gte, lt, gt, orderBy } from 'lodash-es';
 import { signalStore, withState, withComputed, withMethods, patchState } from '@ngrx/signals';
 import * as i1 from '@acorex/components/skeleton';
 import { AXSkeletonModule } from '@acorex/components/skeleton';
 import { Subject, interval, fromEvent } from 'rxjs';
-import { AXDataSource } from '@acorex/cdk/common';
-import { AXTranslationService, resolveMultiLanguageString } from '@acorex/core/translation';
 import { AXCalendarService } from '@acorex/core/date-time';
 import { startWith, map, debounceTime } from 'rxjs/operators';
 
@@ -32,6 +32,184 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "21.2.9", ngImpor
 class AXPActivityLogProvider {
 }
 
+//#region ---- Catalog scope definition ----
+//#endregion
+
+//#region ---- Provider contract ----
+const AXP_CATALOG_SCOPE_DEFINITION_PROVIDER = new InjectionToken('AXP_CATALOG_SCOPE_DEFINITION_PROVIDER');
+//#endregion
+
+//#region ---- Imports ----
+//#endregion
+//#region ---- Aggregator service ----
+/**
+ * Collects {@link AXPCatalogScopeDefinition} entries from all registered providers.
+ */
+class AXPCatalogScopeDefinitionProviderService {
+    constructor() {
+        //#region ---- Services & Dependencies ----
+        this.providers = inject(AXP_CATALOG_SCOPE_DEFINITION_PROVIDER, { optional: true });
+        this.translation = inject(AXTranslationService);
+    }
+    //#endregion
+    //#region ---- Public API ----
+    async items() {
+        const merged = [];
+        const seen = new Set();
+        if (!Array.isArray(this.providers)) {
+            return merged;
+        }
+        for (const raw of this.providers) {
+            const provider = await Promise.resolve(raw);
+            if (!provider || typeof provider.items !== 'function') {
+                continue;
+            }
+            for (const item of await provider.items()) {
+                const name = item.name?.trim();
+                if (!name) {
+                    continue;
+                }
+                if (seen.has(name)) {
+                    throw new Error(`Duplicate catalog scope definition: "${name}"`);
+                }
+                seen.add(name);
+                merged.push(item);
+            }
+        }
+        return merged.sort((a, b) => (a.order ?? 0) - (b.order ?? 0));
+    }
+    async get(name) {
+        const key = name?.trim();
+        if (!key) {
+            return undefined;
+        }
+        return (await this.items()).find((d) => d.name === key);
+    }
+    /**
+     * Scopes applicable to the given entity ref (`Module.Entity`).
+     */
+    async byTarget(entityRef) {
+        const target = entityRef?.trim();
+        if (!target) {
+            return [];
+        }
+        return (await this.items()).filter((d) => d.targets?.some((t) => t === target));
+    }
+    /**
+     * Resolves display title for a scope key (active locale).
+     */
+    resolveTitle(definition) {
+        const locale = this.translation.getActiveLang() ?? 'en-US';
+        if (typeof definition.title === 'string') {
+            const title = definition.title.trim();
+            if (title.startsWith('@')) {
+                return this.translation.translateSync(title) || title;
+            }
+            return title;
+        }
+        return resolveMultiLanguageString(definition.title, locale) || definition.name;
+    }
+    static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "21.2.9", ngImport: i0, type: AXPCatalogScopeDefinitionProviderService, deps: [], target: i0.ɵɵFactoryTarget.Injectable }); }
+    static { this.ɵprov = i0.ɵɵngDeclareInjectable({ minVersion: "12.0.0", version: "21.2.9", ngImport: i0, type: AXPCatalogScopeDefinitionProviderService, providedIn: 'root' }); }
+}
+i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "21.2.9", ngImport: i0, type: AXPCatalogScopeDefinitionProviderService, decorators: [{
+            type: Injectable,
+            args: [{ providedIn: 'root' }]
+        }] });
+
+//#region ---- Imports ----
+//#endregion
+//#region ---- Constants ----
+/** Data source name for select widgets listing registered catalog scopes. */
+const PLATFORM_CATALOG_SCOPES_DATASOURCE_NAME = 'platform-catalog-scopes';
+//#endregion
+//#region ---- Data source definition ----
+/**
+ * Registered catalog scopes for select / selection-list widgets via {@link PLATFORM_CATALOG_SCOPES_DATASOURCE_NAME}.
+ */
+class AXPCatalogScopeDefinitionsDataSourceDefinition {
+    constructor() {
+        //#region ---- Services & Dependencies ----
+        this.catalogScopeRegistry = inject(AXPCatalogScopeDefinitionProviderService);
+        //#endregion
+    }
+    //#endregion
+    //#region ---- Public API ----
+    async items() {
+        return [
+            {
+                name: PLATFORM_CATALOG_SCOPES_DATASOURCE_NAME,
+                title: 'Catalog scopes',
+                source: () => new AXDataSource({
+                    key: 'name',
+                    pageSize: 500,
+                    load: async (e) => {
+                        const all = await this.catalogScopeRegistry.items();
+                        const localeFilter = this.readTargetFilter(e?.filter);
+                        const items = all
+                            .filter((scope) => !localeFilter || scope.targets?.includes(localeFilter))
+                            .map((scope) => ({
+                            name: scope.name,
+                            title: this.catalogScopeRegistry.resolveTitle(scope),
+                            description: scope.description,
+                            targets: scope.targets,
+                            icon: scope.icon,
+                            cssClass: scope.cssClass,
+                        }));
+                        return { items, total: items.length };
+                    },
+                    byKey: async (key) => {
+                        const name = String(key ?? '').trim();
+                        if (!name) {
+                            return undefined;
+                        }
+                        const scope = await this.catalogScopeRegistry.get(name);
+                        if (!scope) {
+                            return undefined;
+                        }
+                        return {
+                            name: scope.name,
+                            title: this.catalogScopeRegistry.resolveTitle(scope),
+                            description: scope.description,
+                            targets: scope.targets,
+                            icon: scope.icon,
+                            cssClass: scope.cssClass,
+                        };
+                    },
+                }),
+                columns: [
+                    { name: 'name', title: 'Name', datatype: 'string', type: 'text-editor' },
+                    { name: 'title', title: 'Title', datatype: 'string', type: 'text-editor' },
+                ],
+                filters: [
+                    {
+                        field: 'targets',
+                        title: 'Target entity',
+                        operator: { type: 'contains' },
+                        widget: { type: 'text-editor' },
+                        filterType: { advance: false, inline: false },
+                    },
+                ],
+                textField: { name: 'title', title: 'Title' },
+                valueField: { name: 'name', title: 'Name' },
+            },
+        ];
+    }
+    //#endregion
+    //#region ---- Helpers ----
+    readTargetFilter(filter) {
+        if (!filter || typeof filter !== 'object') {
+            return undefined;
+        }
+        const f = filter;
+        if (f.field === 'targets' && typeof f.value === 'string' && f.value.trim()) {
+            return f.value.trim();
+        }
+        return undefined;
+    }
+}
+//#endregion
+
 //#region ----   Color Palette Provider   ----
 /**
  * Abstract class for color palette providers
@@ -789,6 +967,20 @@ function getEnumValues(enumType) {
     return Object.entries(enumType).map(([key, value]) => ({ id: value, title: key }));
 }
 
+/**
+ * Returns whether `current` differs from the saved/clean `baseline` snapshot.
+ * Used by entity details pages, layout-builder dialogs, and {@link AXPContextStore}.
+ */
+function isFormContextDirty(current, baseline) {
+    return !isEqual(current, baseline);
+}
+/**
+ * Clones a context object for use as a dirty-tracking baseline.
+ */
+function captureFormContextBaseline(context) {
+    return cloneDeep(context);
+}
+
 class AXPContextChangeEvent {
 }
 //#endregion
@@ -801,33 +993,56 @@ withState(() => ({
     state: 'initiated', // Current state
     initialSnapshot: {}, // Snapshot of the first initialized state
     previousSnapshot: {}, // Snapshot of the previous state
+    userDirtyPaths: [], // Paths changed by user interaction
     lastChange: {
         state: 'initiated',
     }, // Last change event
 })), 
 // Computed Signals
-withComputed(({ data, state, lastChange, initialSnapshot, previousSnapshot }) => ({
+withComputed(({ data, state, lastChange, initialSnapshot, previousSnapshot, userDirtyPaths }) => ({
     isChanged: computed(() => state() === 'changed'),
     isReset: computed(() => state() === 'restored'),
     isInitiated: computed(() => state() === 'initiated'),
     isEmpty: computed(() => Object.keys(data()).length === 0),
-    isDirty: computed(() => !isEqual(data(), previousSnapshot())),
+    isDirty: computed(() => isFormContextDirty(data(), initialSnapshot())),
+    isUserDirty: computed(() => userDirtyPaths().length > 0),
     snapshot: computed(() => cloneDeep(data())), // Current data snapshot
     initial: computed(() => cloneDeep(initialSnapshot())), // Initial snapshot
     previous: computed(() => cloneDeep(previousSnapshot())), // Previous snapshot
     changeEvent: computed(() => lastChange()), // Reactive last change event
 })), 
 // Methods for State Management
-withMethods((store) => ({
-    // Update a specific value
-    update(path, value) {
+withMethods((store) => {
+    const markUserDirtyPath = (path) => {
+        const normalized = path?.trim();
+        if (!normalized) {
+            return;
+        }
+        const current = store.userDirtyPaths();
+        if (current.includes(normalized)) {
+            return;
+        }
+        patchState(store, { userDirtyPaths: [...current, normalized] });
+    };
+    const clearUserDirtyPaths = () => {
+        if (store.userDirtyPaths().length === 0) {
+            return;
+        }
+        patchState(store, { userDirtyPaths: [] });
+    };
+    const resolvePatchOptions = (second) => {
+        if (typeof second === 'boolean') {
+            return { skipDirtyTracking: second };
+        }
+        return second ?? {};
+    };
+    const updateValue = (path, value, options) => {
         const currentData = cloneDeep(store.data());
         const oldValue = getSmart(currentData, path);
-        // Skip if the value hasn't changed
         if (isEqual(oldValue, value)) {
             return;
         }
-        // Update the value and prepare the change event
+        const origin = options?.origin ?? 'system';
         const updatedData = setSmart(currentData, path, value);
         const changeEvent = {
             oldValue,
@@ -835,78 +1050,119 @@ withMethods((store) => ({
             path,
             state: 'changed',
             data: updatedData,
+            origin,
         };
-        // Patch the state
-        patchState(store, {
-            previousSnapshot: store.snapshot(), // Save the previous state
-            data: updatedData,
-            state: 'changed',
-            lastChange: changeEvent,
-        });
-    },
-    patch(context, skipDirtyTracking = false) {
-        const currentData = cloneDeep(store.data());
-        // Update the value and prepare the change event
-        const updatedData = { ...currentData, ...context };
-        const changeEvent = {
-            state: 'patch',
-            data: updatedData,
-        };
-        // Patch the state
         patchState(store, {
-            ...(skipDirtyTracking ? {} : { previousSnapshot: store.snapshot() }),
+            previousSnapshot: store.snapshot(),
             data: updatedData,
             state: 'changed',
             lastChange: changeEvent,
         });
-    },
-    // Reset to the initial state
-    reset() {
-        const initialData = store.initial();
-        const changeEvent = {
-            oldValue: cloneDeep(store.data()), // Current data becomes old value
-            newValue: cloneDeep(initialData), // Reset to the initial state
-            path: '',
-            state: 'restored',
-            data: initialData,
-        };
-        patchState(store, {
-            previousSnapshot: store.snapshot(), // Save the previous state
-            data: initialData,
-            state: 'restored',
-            lastChange: changeEvent,
-        });
-    },
-    // Initialize the state
-    set(initialData) {
-        const currentData = store.data();
-        if (isEqual(currentData, initialData)) {
-            return; // Skip if the current state matches the initial state
+        if (origin === 'user') {
+            markUserDirtyPath(path);
         }
-        const changeEvent = {
-            oldValue: null,
-            newValue: cloneDeep(initialData),
-            path: '',
-            state: 'initiated',
-            data: initialData,
-        };
-        patchState(store, {
-            initialSnapshot: cloneDeep(initialData), // Save the initial state
-            previousSnapshot: store.snapshot(), // Save the current state as the previous
-            data: initialData,
-            state: 'initiated',
-            lastChange: changeEvent,
-        });
-    },
-    // Get a specific value
-    getValue(path) {
-        return getSmart(store.data(), path);
-    },
-    // Check if a path exists in the context
-    hasValue(path) {
-        return has(store.data(), path);
-    },
-})));
+    };
+    const applyObjectPaths = (obj, options, prefix = '') => {
+        for (const [key, value] of Object.entries(obj ?? {})) {
+            const path = prefix ? `${prefix}.${key}` : key;
+            if (value !== null && isObject(value) && !Array.isArray(value)) {
+                applyObjectPaths(value, options, path);
+            }
+            else {
+                updateValue(path, value, options);
+            }
+        }
+    };
+    return {
+        // Update a specific value
+        update(path, value, options) {
+            updateValue(path, value, options);
+        },
+        applyObjectPaths,
+        patch(context, second) {
+            const options = resolvePatchOptions(second);
+            const currentData = cloneDeep(store.data());
+            const updatedData = { ...currentData, ...context };
+            const origin = options.origin ?? 'system';
+            const changeEvent = {
+                state: 'patch',
+                data: updatedData,
+                origin,
+            };
+            const syncedSnapshot = cloneDeep(updatedData);
+            patchState(store, {
+                ...(options.skipDirtyTracking
+                    ? { initialSnapshot: syncedSnapshot, previousSnapshot: syncedSnapshot }
+                    : { previousSnapshot: store.snapshot() }),
+                data: updatedData,
+                state: 'changed',
+                lastChange: changeEvent,
+            });
+            if (!options.skipDirtyTracking && origin === 'user') {
+                Object.keys(context).forEach((key) => markUserDirtyPath(key));
+            }
+        },
+        // Reset to the initial state
+        reset() {
+            const initialData = store.initial();
+            const changeEvent = {
+                oldValue: cloneDeep(store.data()), // Current data becomes old value
+                newValue: cloneDeep(initialData), // Reset to the initial state
+                path: '',
+                state: 'restored',
+                data: initialData,
+            };
+            patchState(store, {
+                previousSnapshot: store.snapshot(), // Save the previous state
+                data: initialData,
+                state: 'restored',
+                lastChange: changeEvent,
+                userDirtyPaths: [],
+            });
+        },
+        // Initialize the state
+        set(initialData) {
+            const currentData = store.data();
+            if (isEqual(currentData, initialData)) {
+                return; // Skip if the current state matches the initial state
+            }
+            const changeEvent = {
+                oldValue: null,
+                newValue: cloneDeep(initialData),
+                path: '',
+                state: 'initiated',
+                data: initialData,
+            };
+            patchState(store, {
+                initialSnapshot: cloneDeep(initialData), // Save the initial state
+                previousSnapshot: store.snapshot(), // Save the current state as the previous
+                data: initialData,
+                state: 'initiated',
+                lastChange: changeEvent,
+                userDirtyPaths: [],
+            });
+        },
+        // Get a specific value
+        getValue(path) {
+            return getSmart(store.data(), path);
+        },
+        // Check if a path exists in the context
+        hasValue(path) {
+            return has(store.data(), path);
+        },
+        /** Marks the current data as the clean baseline (after init/normalization settles). */
+        commitBaseline() {
+            const snapshot = cloneDeep(store.data());
+            patchState(store, {
+                initialSnapshot: snapshot,
+                previousSnapshot: snapshot,
+                state: 'initiated',
+                userDirtyPaths: [],
+            });
+        },
+        clearUserDirtyPaths,
+    };
+}));
 //#endregion
 
 class AXPExpressionEvaluatorScopeProviderContext {
@@ -4468,5 +4724,5 @@ function generateKebabCase(title) {
  * Generated bundle index. Do not edit.
  */
 
-export { AXHighlightService, AXPActivityLogProvider, AXPActivityLogService, AXPAppStartUpProvider, AXPAppStartUpService, AXPBroadcastEventService, AXPColorPaletteProvider, AXPColorPaletteService, AXPColumnWidthService, AXPComponentLogoConfig, AXPComponentSlot, AXPComponentSlotDirective, AXPComponentSlotModule, AXPComponentSlotRegistryService, AXPContentCheckerDirective, AXPContextChangeEvent, AXPContextDefinitionProviderService, AXPContextStore, AXPCountdownPipe, AXPDataGenerator, AXPDataSourceDefinitionProviderService, AXPDblClickDirective, AXPDefaultColorPalettesProvider, AXPDeviceService, AXPDeviceType, AXPDistributedEventListenerService, AXPElementDataDirective, AXPExportTemplateToken, AXPExpressionEvaluatorScopeProviderContext, AXPExpressionEvaluatorScopeProviderService, AXPExpressionEvaluatorService, AXPFeatureDefinitionProviderContext, AXPGridLayoutDirective, AXPHookService, AXPIconLogoConfig, AXPImageUrlLogoConfig, AXPModuleManifestModule, AXPModuleManifestRegistry, AXPModuleManifestsDataSourceDefinition, AXPPlatformScope, AXPScreenSize, AXPSystemActionType, AXPSystemActions, AXPTagProvider, AXPTagService, AXP_ACTIVITY_LOG_PROVIDER, AXP_COLOR_PALETTE_PROVIDER, AXP_COLUMN_WIDTH_PROVIDER, AXP_CONTEXT_DEFINITION_PROVIDER, AXP_DATASOURCE_DEFINITION_PROVIDER, AXP_DISTRIBUTED_EVENT_LISTENER_PROVIDER, AXP_EXPRESSION_EVALUATOR_SCOPE_PROVIDER, AXP_FEATURE_DEFINITION_PROVIDER, AXP_MODULE_MANIFEST_PROVIDER, AXP_SESSION_SERVICE, AXP_TAG_PROVIDER, MODULE_MANIFESTS_DATASOURCE_NAME, applyFilterArray, applyPagination, applyQueryArray, applySortArray, applySystemActionDefault, cleanDeep, coerceUnknownToBoolean, coerceUnknownToDate, coerceUnknownToFiniteNumber, coerceUnknownToTrimmedString, compareMultiLanguageStrings, containsHtmlMarkup, createProviderWithInjectionContext, defaultColumnWidthProvider, extractNestedFieldsWildcard, extractTextFromHtml, extractValue, generateKebabCase, getActionButton, getChangedPaths, getDetailedChanges, getEnumValues, getNestedKeys, getSmart, getSystemActions, normalizeDefinitionCategories, objectKeyValueTransforms, provideLazyProvider, resolveActionLook, resolvePlatformScopeKey, resolvePlatformScopeName, searchInMultiLanguageString, setSmart, sortByMultiLanguageString, unwrapValueProperty };
+export { AXHighlightService, AXPActivityLogProvider, AXPActivityLogService, AXPAppStartUpProvider, AXPAppStartUpService, AXPBroadcastEventService, AXPCatalogScopeDefinitionProviderService, AXPCatalogScopeDefinitionsDataSourceDefinition, AXPColorPaletteProvider, AXPColorPaletteService, AXPColumnWidthService, AXPComponentLogoConfig, AXPComponentSlot, AXPComponentSlotDirective, AXPComponentSlotModule, AXPComponentSlotRegistryService, AXPContentCheckerDirective, AXPContextChangeEvent, AXPContextDefinitionProviderService, AXPContextStore, AXPCountdownPipe, AXPDataGenerator, AXPDataSourceDefinitionProviderService, AXPDblClickDirective, AXPDefaultColorPalettesProvider, AXPDeviceService, AXPDeviceType, AXPDistributedEventListenerService, AXPElementDataDirective, AXPExportTemplateToken, AXPExpressionEvaluatorScopeProviderContext, AXPExpressionEvaluatorScopeProviderService, AXPExpressionEvaluatorService, AXPFeatureDefinitionProviderContext, AXPGridLayoutDirective, AXPHookService, AXPIconLogoConfig, AXPImageUrlLogoConfig, AXPModuleManifestModule, AXPModuleManifestRegistry, AXPModuleManifestsDataSourceDefinition, AXPPlatformScope, AXPScreenSize, AXPSystemActionType, AXPSystemActions, AXPTagProvider, AXPTagService, AXP_ACTIVITY_LOG_PROVIDER, AXP_CATALOG_SCOPE_DEFINITION_PROVIDER, AXP_COLOR_PALETTE_PROVIDER, AXP_COLUMN_WIDTH_PROVIDER, AXP_CONTEXT_DEFINITION_PROVIDER, AXP_DATASOURCE_DEFINITION_PROVIDER, AXP_DISTRIBUTED_EVENT_LISTENER_PROVIDER, AXP_EXPRESSION_EVALUATOR_SCOPE_PROVIDER, AXP_FEATURE_DEFINITION_PROVIDER, AXP_MODULE_MANIFEST_PROVIDER, AXP_SESSION_SERVICE, AXP_TAG_PROVIDER, MODULE_MANIFESTS_DATASOURCE_NAME, PLATFORM_CATALOG_SCOPES_DATASOURCE_NAME, applyFilterArray, applyPagination, applyQueryArray, applySortArray, applySystemActionDefault, captureFormContextBaseline, cleanDeep, coerceUnknownToBoolean, coerceUnknownToDate, coerceUnknownToFiniteNumber, coerceUnknownToTrimmedString, compareMultiLanguageStrings, containsHtmlMarkup, createProviderWithInjectionContext, defaultColumnWidthProvider, extractNestedFieldsWildcard, extractTextFromHtml, extractValue, generateKebabCase, getActionButton, getChangedPaths, getDetailedChanges, getEnumValues, getNestedKeys, getSmart, getSystemActions, isFormContextDirty, normalizeDefinitionCategories, objectKeyValueTransforms, provideLazyProvider, resolveActionLook, resolvePlatformScopeKey, resolvePlatformScopeName, searchInMultiLanguageString, setSmart, sortByMultiLanguageString, unwrapValueProperty };
 //# sourceMappingURL=acorex-platform-core.mjs.map