@acorex/platform 20.9.6 → 20.9.9

package/fesm2022/acorex-platform-core.mjs

@@ -1,14 +1,14 @@
 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, DestroyRef, untracked, provideAppInitializer, Pipe } from '@angular/core';
 import { AXTranslationService, resolveMultiLanguageString } from '@acorex/core/translation';
-import { AXDataSource } from '@acorex/cdk/common';
+import { AXDataSource, convertArrayToDataSource } from '@acorex/cdk/common';
 import { AXPPlatformCoreDataSourceKeys, isFormContextDirty, summarizeFormContextDirtyDiff, getSmart, isSelectionValueEqual, isFormValueEqual, setSmart, extractValue, AXPKeyboardShortcutPriority, getSystemActions, isLocaleStringMap } from '@acorex/platform/contracts';
-import { cloneDeep, isEmpty, isEqual, has, unset, isPlainObject, get, sortBy, set, isUndefined, isNil, endsWith, startsWith, includes, lte, gte, lt, gt, orderBy } from 'lodash-es';
+import { cloneDeep, isEmpty, isEqual, has, unset, isPlainObject, get, sortBy, set, isNil, castArray, isString, isUndefined, endsWith, startsWith, includes, lte, gte, lt, gt, orderBy } from 'lodash-es';
 import { signalStore, withState, withComputed, withMethods, patchState } from '@ngrx/signals';
 import { AXFormatService } from '@acorex/core/format';
 import * as i1 from '@acorex/components/skeleton';
 import { AXSkeletonModule } from '@acorex/components/skeleton';
-import { Subject, interval, fromEvent } from 'rxjs';
+import { filter, take, ReplaySubject, Subject, interval, fromEvent } from 'rxjs';
 import { toSignal } from '@angular/core/rxjs-interop';
 import { DOCUMENT } from '@angular/common';
 import { AXLocaleService } from '@acorex/core/locale';
@@ -1881,6 +1881,246 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "21.2.9", ngImpor
             args: [{ providedIn: 'root' }]
         }] });
 
+//#region ----   Imports   ----
+//#endregion
+/**
+ * Resolves registry-backed {@link AXDataSource} instances and exposes readiness (`isReady`, `whenReady`)
+ * so widgets do not bind selected values before the provider datasource is available.
+ */
+class AXPDataSourceQueryService {
+    constructor() {
+        //#region ----   Services & State   ----
+        this.definitionService = inject(AXPDataSourceDefinitionProviderService);
+        this.entries = new Map();
+    }
+    //#endregion
+    //#region ----   Public API   ----
+    /**
+     * Returns true when the named registry datasource has been resolved for the given options.
+     */
+    isReady(name, options) {
+        const entry = this.entries.get(this.buildCacheKey(name, options));
+        return entry?.result?.ready === true && entry.result.dataSource != null;
+    }
+    /**
+     * Emits once when the registry datasource is resolved (or fails) for the given options.
+     */
+    whenReady(name, options) {
+        return this.ensureLoading(name, options).readySubject.asObservable().pipe(filter((result) => result.ready), take(1));
+    }
+    /**
+     * Resolves and returns the {@link AXDataSource} for a registry name, waiting for providers when needed.
+     */
+    async getDataSource(name, options) {
+        const result = await this.resolve(name, options);
+        return result.dataSource;
+    }
+    /**
+     * Resolves the registry datasource, then looks up one or more keys via `byKey`.
+     */
+    async queryByKey(name, key, options) {
+        if (isNil(key)) {
+            return null;
+        }
+        const result = await this.resolve(name, options);
+        const dataSource = result.dataSource;
+        if (!dataSource?.config?.byKey) {
+            return null;
+        }
+        if (Array.isArray(key)) {
+            const items = await Promise.all(key.map((k) => dataSource.config.byKey(k)));
+            return items.filter((item) => item != null);
+        }
+        return (await dataSource.config.byKey(key)) ?? null;
+    }
+    /**
+     * Fully resolves a registry datasource (definition + AXDataSource instance).
+     */
+    async resolve(name, options) {
+        const entry = this.ensureLoading(name, options);
+        if (entry.result?.ready) {
+            return entry.result;
+        }
+        return entry.loadPromise;
+    }
+    /**
+     * Clears cached query state. Pass a registry name to invalidate one datasource, or omit to clear all.
+     */
+    invalidate(name) {
+        if (!name) {
+            this.entries.clear();
+            return;
+        }
+        const prefix = `${name}::`;
+        for (const key of [...this.entries.keys()]) {
+            if (key === name || key.startsWith(prefix)) {
+                this.entries.delete(key);
+            }
+        }
+    }
+    //#endregion
+    //#region ----   Loading   ----
+    ensureLoading(name, options) {
+        const cacheKey = this.buildCacheKey(name, options);
+        let entry = this.entries.get(cacheKey);
+        if (!entry) {
+            entry = {
+                name,
+                cacheKey,
+                readySubject: new ReplaySubject(1),
+            };
+            this.entries.set(cacheKey, entry);
+            entry.loadPromise = this.loadEntry(entry, name, options);
+        }
+        return entry;
+    }
+    async loadEntry(entry, name, options) {
+        const pending = {
+            name,
+            ready: false,
+            dataSource: null,
+            valueField: options?.valueField ?? 'id',
+            textField: 'title',
+        };
+        try {
+            const definition = await this.waitForDefinition(name, options);
+            if (!definition) {
+                const failed = {
+                    ...pending,
+                    ready: true,
+                    error: new Error(`Data source '${name}' was not found in the registry`),
+                };
+                entry.result = failed;
+                entry.readySubject.next(failed);
+                return failed;
+            }
+            const valueField = options?.valueField ?? definition.valueField?.name ?? 'id';
+            const textField = definition.textField?.name ?? 'title';
+            const dataSource = await this.createDataSource(definition, {
+                ...options,
+                valueField,
+            });
+            const translated = dataSource ? this.wrapTranslatedDataSource(dataSource, textField) : null;
+            const success = {
+                name,
+                ready: true,
+                dataSource: translated,
+                definition,
+                valueField,
+                textField,
+            };
+            entry.result = success;
+            entry.readySubject.next(success);
+            return success;
+        }
+        catch (error) {
+            const failed = {
+                ...pending,
+                ready: true,
+                error,
+            };
+            entry.result = failed;
+            entry.readySubject.next(failed);
+            return failed;
+        }
+    }
+    async waitForDefinition(name, options) {
+        const waitForRegistry = options?.waitForRegistry ?? true;
+        const maxAttempts = options?.maxRegistryAttempts ?? 20;
+        const retryDelayMs = options?.registryRetryDelayMs ?? 50;
+        const attempts = waitForRegistry ? maxAttempts : 1;
+        for (let attempt = 0; attempt < attempts; attempt++) {
+            const definition = await this.definitionService.get(name);
+            if (definition) {
+                return definition;
+            }
+            if (attempt < attempts - 1) {
+                await this.sleep(retryDelayMs);
+            }
+        }
+        return undefined;
+    }
+    async createDataSource(definition, options) {
+        if (options.useSamples && definition.samples) {
+            const samples = await this.resolveSamples(definition.samples);
+            return convertArrayToDataSource(samples, {
+                key: options.valueField,
+                pageSize: 500,
+            });
+        }
+        const sourceResult = definition.source();
+        const resolved = await Promise.resolve(sourceResult);
+        if (resolved instanceof AXDataSource) {
+            this.applyValueFieldAsKey(resolved, options.valueField);
+            return resolved;
+        }
+        if (Array.isArray(resolved)) {
+            return convertArrayToDataSource(resolved, {
+                key: options.valueField,
+                pageSize: 500,
+            });
+        }
+        return null;
+    }
+    async resolveSamples(samples) {
+        return castArray(await Promise.resolve(samples));
+    }
+    applyValueFieldAsKey(dataSource, valueField) {
+        if (dataSource.config?.key !== valueField) {
+            dataSource.config = { ...dataSource.config, key: valueField };
+        }
+    }
+    wrapTranslatedDataSource(dataSource, textField) {
+        const config = dataSource.config;
+        if (!config) {
+            return dataSource;
+        }
+        const originalByKey = config.byKey;
+        const originalLoad = config.load;
+        if (originalByKey) {
+            config.byKey = async (key) => this.translateItem(await originalByKey(key), textField);
+        }
+        if (originalLoad) {
+            config.load = async (event) => {
+                const result = await originalLoad(event);
+                if (!result?.items?.length) {
+                    return result;
+                }
+                return {
+                    ...result,
+                    items: result.items.map((item) => this.translateItem(item, textField)),
+                };
+            };
+        }
+        return dataSource;
+    }
+    translateItem(item, textField) {
+        if (item == null || typeof item !== 'object') {
+            return item;
+        }
+        const title = get(item, textField);
+        // Keep i18n keys for UI widgets (ax-select-box translate pipe) so labels react to locale changes.
+        if (isString(title) && title.startsWith('@')) {
+            return item;
+        }
+        return item;
+    }
+    buildCacheKey(name, options) {
+        const valueField = options?.valueField ?? '';
+        const useSamples = options?.useSamples ? '1' : '0';
+        return `${name}::${valueField}::${useSamples}`;
+    }
+    sleep(ms) {
+        return new Promise((resolve) => setTimeout(resolve, ms));
+    }
+    static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "21.2.9", ngImport: i0, type: AXPDataSourceQueryService, deps: [], target: i0.ɵɵFactoryTarget.Injectable }); }
+    static { this.ɵprov = i0.ɵɵngDeclareInjectable({ minVersion: "12.0.0", version: "21.2.9", ngImport: i0, type: AXPDataSourceQueryService, providedIn: 'root' }); }
+}
+i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "21.2.9", ngImport: i0, type: AXPDataSourceQueryService, decorators: [{
+            type: Injectable,
+            args: [{ providedIn: 'root' }]
+        }] });
+
 // src/app/directives/grid-layout.directive.ts
 class AXPContentCheckerDirective {
     constructor() {
@@ -4718,5 +4958,5 @@ function provideLazyProvider(token, loader, multi = true) {
  * Generated bundle index. Do not edit.
  */
 
-export { AXHighlightService, AXPActivityLogProvider, AXPActivityLogService, AXPAppStartUpProvider, AXPAppStartUpService, AXPBroadcastEventService, AXPCatalogScopeDefinitionProviderService, AXPCatalogScopeDefinitionsDataSourceDefinition, AXPColorPaletteProvider, AXPColorPaletteService, AXPColumnWidthService, AXPComponentLogoConfig, AXPComponentSlot, AXPComponentSlotDirective, AXPComponentSlotModule, AXPComponentSlotRegistryService, AXPContentCheckerDirective, AXPContextDefinitionProviderService, AXPContextEvalFactory, AXPContextStore, AXPCountdownPipe, AXPDataGenerator, AXPDataSourceDefinitionProviderService, AXPDblClickDirective, AXPDebugService, AXPDefaultColorPalettesProvider, AXPDeviceService, AXPDeviceType, AXPDistributedEventListenerService, AXPElementDataDirective, AXPExpressionEvaluatorScopeProviderContext, AXPExpressionEvaluatorScopeProviderService, AXPExpressionEvaluatorService, AXPFeatureDefinitionProviderContext, AXPGridLayoutDirective, AXPHookService, AXPIconLogoConfig, AXPIdleSchedulerService, AXPImageUrlLogoConfig, AXPKeyboardShortcutRegistry, AXPModuleManifestModule, AXPModuleManifestRegistry, AXPModuleManifestsDataSourceDefinition, AXPScreenSize, 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, AX_OVERLAY_CONTAINER_SELECTOR, AX_OVERLAY_PANE_SELECTOR, DEFAULT_CANCEL_DIALOG_ACTION_SHORTCUTS, DEFAULT_SUBMIT_DIALOG_ACTION_SHORTCUTS, FORM_DIRTY_TRACE_NS, OVERLAY_DETAILS_VIEW_TRACE_NS, OVERLAY_LAYOUT_TRACE_NS, OVERLAY_ROOT_LAYOUT_TRACE_NS, OVERLAY_WIDGET_SETTLE_TRACE_NS, applyContextEvalPipes, applyFilterArray, applyPagination, applyQueryArray, applySortArray, applySystemActionDefault, chordToKbdItemKeys, contextEvalWithPipes, createProviderWithInjectionContext, defaultColumnWidthProvider, findOverlayContainerAncestor, formatKeyboardShortcutChord, formatKeyboardShortcutChords, getNestedVisibleOverlayPanes, getPrimaryKeyboardShortcutChord, getTopVisibleOverlayContainer, getVisibleAnchoredOverlayPanes, getVisibleOverlayContainers, hasForegroundOverlayLayer, isDialogShortcutAllowedInEditableField, isHorizontalDirectionalShortcutKey, isKeyboardTargetInsideEditableField, isMacPlatform, isVisibleOverlayElement, matchesDialogActionShortcut, matchesKeyboardShortcutChord, mirrorHorizontalDirectionalKey, normalizeContextEvalPipes, normalizeDialogActionShortcutChord, normalizeExpressionTemplate, normalizeKeyboardShortcut, normalizeKeyboardShortcuts, objectKeyValueTransforms, parseDialogActionShortcut, parseKeyboardShortcutChord, provideLazyProvider, registerPopupFooterKeyboardShortcuts, resolveConfiguredFooterActionShortcuts, resolveDialogActionShortcuts, resolveDisplayShortcutChord, resolveEffectiveDirectionBehavior, resolveSemanticDirectionalKey, setupPopupFooterKeyboardShortcuts, shouldDeferEscapeToOpenOverlay, shouldTriggerDialogActionShortcut };
+export { AXHighlightService, AXPActivityLogProvider, AXPActivityLogService, AXPAppStartUpProvider, AXPAppStartUpService, AXPBroadcastEventService, AXPCatalogScopeDefinitionProviderService, AXPCatalogScopeDefinitionsDataSourceDefinition, AXPColorPaletteProvider, AXPColorPaletteService, AXPColumnWidthService, AXPComponentLogoConfig, AXPComponentSlot, AXPComponentSlotDirective, AXPComponentSlotModule, AXPComponentSlotRegistryService, AXPContentCheckerDirective, AXPContextDefinitionProviderService, AXPContextEvalFactory, AXPContextStore, AXPCountdownPipe, AXPDataGenerator, AXPDataSourceDefinitionProviderService, AXPDataSourceQueryService, AXPDblClickDirective, AXPDebugService, AXPDefaultColorPalettesProvider, AXPDeviceService, AXPDeviceType, AXPDistributedEventListenerService, AXPElementDataDirective, AXPExpressionEvaluatorScopeProviderContext, AXPExpressionEvaluatorScopeProviderService, AXPExpressionEvaluatorService, AXPFeatureDefinitionProviderContext, AXPGridLayoutDirective, AXPHookService, AXPIconLogoConfig, AXPIdleSchedulerService, AXPImageUrlLogoConfig, AXPKeyboardShortcutRegistry, AXPModuleManifestModule, AXPModuleManifestRegistry, AXPModuleManifestsDataSourceDefinition, AXPScreenSize, 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, AX_OVERLAY_CONTAINER_SELECTOR, AX_OVERLAY_PANE_SELECTOR, DEFAULT_CANCEL_DIALOG_ACTION_SHORTCUTS, DEFAULT_SUBMIT_DIALOG_ACTION_SHORTCUTS, FORM_DIRTY_TRACE_NS, OVERLAY_DETAILS_VIEW_TRACE_NS, OVERLAY_LAYOUT_TRACE_NS, OVERLAY_ROOT_LAYOUT_TRACE_NS, OVERLAY_WIDGET_SETTLE_TRACE_NS, applyContextEvalPipes, applyFilterArray, applyPagination, applyQueryArray, applySortArray, applySystemActionDefault, chordToKbdItemKeys, contextEvalWithPipes, createProviderWithInjectionContext, defaultColumnWidthProvider, findOverlayContainerAncestor, formatKeyboardShortcutChord, formatKeyboardShortcutChords, getNestedVisibleOverlayPanes, getPrimaryKeyboardShortcutChord, getTopVisibleOverlayContainer, getVisibleAnchoredOverlayPanes, getVisibleOverlayContainers, hasForegroundOverlayLayer, isDialogShortcutAllowedInEditableField, isHorizontalDirectionalShortcutKey, isKeyboardTargetInsideEditableField, isMacPlatform, isVisibleOverlayElement, matchesDialogActionShortcut, matchesKeyboardShortcutChord, mirrorHorizontalDirectionalKey, normalizeContextEvalPipes, normalizeDialogActionShortcutChord, normalizeExpressionTemplate, normalizeKeyboardShortcut, normalizeKeyboardShortcuts, objectKeyValueTransforms, parseDialogActionShortcut, parseKeyboardShortcutChord, provideLazyProvider, registerPopupFooterKeyboardShortcuts, resolveConfiguredFooterActionShortcuts, resolveDialogActionShortcuts, resolveDisplayShortcutChord, resolveEffectiveDirectionBehavior, resolveSemanticDirectionalKey, setupPopupFooterKeyboardShortcuts, shouldDeferEscapeToOpenOverlay, shouldTriggerDialogActionShortcut };
 //# sourceMappingURL=acorex-platform-core.mjs.map