@acorex/cdk 20.2.0-next.7 → 20.2.0-next.9

package/common/index.d.ts

@@ -492,7 +492,7 @@ declare abstract class AXAutocompleteParentComponent<T> extends MXValueComponent
 }
 
 type AXDataSourceOperator = {
-    type: 'equal' | 'isNull' | 'isEmpty' | 'lt' | 'lte' | 'gt' | 'gte' | 'startsWith' | 'endsWith' | 'contains';
+    type: 'equal' | 'isNull' | 'isEmpty' | 'lt' | 'lte' | 'gt' | 'gte' | 'startsWith' | 'endsWith' | 'contains' | 'in';
     negative?: boolean;
 };
 type AXFilterLogic = 'and' | 'or';
@@ -575,10 +575,10 @@ declare class AXDataSource<T = unknown> {
     }): void;
     find(key: unknown): T | Promise<T>;
 }
-declare function convertArrayToDataSource<T>(items: T[], options?: {
+declare function convertArrayToDataSource<T = unknown>(items: T[], options?: {
     key: string;
     pageSize: number;
-}): AXDataSource;
+}): AXDataSource<T>;
 
 interface AXDataListQuery {
     take?: number;
@@ -803,53 +803,168 @@ declare class MXInputBaseValueComponent<T = string> extends MXValueComponent<T>
     static ɵprov: i0.ɵɵInjectableDeclaration<MXInputBaseValueComponent<any>>;
 }
 
+/**
+ * Service that manages selection state and caching for selection components
+ */
 declare class MXSelectionBridgeService {
+    /** Array of currently selected items */
     selectedItems: unknown[];
-    cacheList: {
-        [key: string | number]: unknown;
-    };
+    /** Cache for normalized items keyed by their unique identifier */
+    cacheList: Record<string | number, unknown>;
     static ɵfac: i0.ɵɵFactoryDeclaration<MXSelectionBridgeService, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<MXSelectionBridgeService>;
 }
+/**
+ * Injection token for the selection bridge service
+ */
 declare const AX_SELECTION_DATA_TOKEN: InjectionToken<MXSelectionBridgeService>;
-declare abstract class MXSelectionValueComponent<T = any> extends MXValueComponent<any> {
-    private formatService;
-    private dataService;
-    disabledCallback: (e: {
-        item: T;
-        index: number;
-    }) => boolean;
+/**
+ * Type definition for disabled callback function
+ */
+type DisabledCallback<T> = (event: {
+    item: T;
+    index: number;
+}) => boolean;
+/**
+ * Type definition for normalized item object
+ */
+interface NormalizedItem {
+    [key: string]: unknown;
+    isLoading?: boolean;
+}
+/**
+ * Abstract base component for selection-based value components
+ * Provides common functionality for components that support item selection
+ */
+declare abstract class MXSelectionValueComponent<T = unknown> extends MXValueComponent<unknown> {
+    private readonly formatService;
+    private readonly dataService;
+    /** Callback function to determine if an item should be disabled */
+    disabledCallback: DisabledCallback<T>;
     private _valueField;
+    /** Field name used to extract the unique value from items */
     get valueField(): string;
-    set valueField(v: string);
-    private _textTemplate;
-    get textTemplate(): string;
-    set textTemplate(v: string);
+    set valueField(value: string);
     private _textField;
+    /** Field name used to extract the display text from items */
     get textField(): string;
-    set textField(v: string);
+    set textField(value: string);
+    private _textTemplate;
+    /** Template string for formatting item display text */
+    get textTemplate(): string;
+    set textTemplate(value: string);
     private _disabledField;
+    /** Field name used to determine if an item is disabled */
     get disabledField(): string;
-    set disabledField(v: string);
+    set disabledField(value: string);
     private _multiple;
+    /** Whether multiple items can be selected */
     get multiple(): boolean;
-    set multiple(v: boolean);
+    set multiple(value: boolean);
+    /** Gets the currently selected items */
     get selectedItems(): unknown[];
-    internalSetValue(value: unknown): any;
-    emitOnValueChangedEvent(oldValue?: unknown, newValue?: unknown): void;
+    /**
+     * Abstract method to retrieve an item by its key
+     * @param key The unique identifier of the item
+     * @returns The item or a Promise that resolves to the item
+     */
     abstract getItemByKey(key: unknown): unknown | Promise<unknown>;
-    protected normalizeItemsList(items: unknown[], findBykey?: boolean): unknown[];
+    /**
+     * Internal method to set and normalize the component value
+     * @param value The value to set (can be single item or array)
+     * @returns Normalized value based on multiple selection mode
+     */
+    internalSetValue(value: unknown): unknown;
+    /**
+     * Override to normalize selected items when value changes
+     */
+    emitOnValueChangedEvent(oldValue?: unknown, newValue?: unknown): void;
+    /**
+     * Normalizes a list of items, filtering out null values
+     * @param items Array of items to normalize
+     * @param findByKey Whether to attempt finding items by key
+     * @returns Array of normalized items
+     */
+    protected normalizeItemsList(items: unknown[], findByKey?: boolean): NormalizedItem[];
+    /**
+     * Normalizes a single item, handling caching and async loading
+     * @param item Item to normalize
+     * @param findByKey Whether to attempt finding the item by key
+     * @returns Normalized item object
+     */
     private normalizeItem;
+    /**
+     * Handles the normalization logic for items that need property assignment
+     */
+    private handleItemNormalization;
+    /**
+     * Handles async item loading with loading state
+     */
+    private handleAsyncItem;
+    /**
+     * Assigns value and text properties to the normalized object
+     */
+    private assignItemProperties;
+    /**
+     * Creates a consistent cache key for an item
+     */
+    private createCacheKey;
+    /**
+     * Normalizes currently selected items and updates the data service
+     */
     private _normalizeSelectedItems;
+    /**
+     * Unselects the specified items from the selection
+     * @param items Items to unselect
+     */
     unselectItems(...items: T[]): void;
+    /**
+     * Selects the specified items
+     * @param items Items to select
+     */
     selectItems(...items: T[]): void;
+    /**
+     * Toggles the selection state of the specified items
+     * @param items Items to toggle
+     */
     toggleSelect(...items: T[]): void;
+    /**
+     * Checks if an item is currently selected
+     * @param item Item to check
+     * @returns True if the item is selected
+     */
     isItemSelected(item: T): boolean;
+    /**
+     * Checks if an item is disabled
+     * @param item Item to check
+     * @returns True if the item is disabled
+     */
     isItemDisabled(item: T): boolean;
-    protected getDisplayText(item: T): any;
-    protected getValue(item: T): any;
+    /**
+     * Gets the display text for an item using template or text field
+     * @param item Item to get display text for
+     * @returns Formatted display text
+     */
+    protected getDisplayText(item: T): string;
+    /**
+     * Gets the value of an item
+     * @param item Item to get value from
+     * @returns Item value
+     */
+    protected getValue(item: T): unknown;
+    /**
+     * Clears the selection cache and selected items
+     */
     protected clearSelectionCache(): void;
+    /**
+     * Clears only the cache while preserving selected items
+     */
     protected softClearSelectionCache(): void;
+    /**
+     * Asynchronously loads an item by its key and caches the result
+     * @param key Key to load item by
+     */
+    private loadAndCacheItemByKey;
     static ɵfac: i0.ɵɵFactoryDeclaration<MXSelectionValueComponent<any>, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<MXSelectionValueComponent<any>>;
 }
@@ -929,4 +1044,4 @@ declare class AXHotkeysService {
 }
 
 export { AXAutoFocusDirective, AXAutocompleteParentComponent, AXButtonClickEvent, AXClearableComponent, AXClickEvent, AXClosableComponent, AXCommonModule, AXComponent, AXComponentCloseEvent, AXComponentClosedPromise, AXComponentClosing, AXComponentResult, AXDataSource, AXDomService, AXEvent, AXFocusEvent, AXFocusableComponent, AXHotkeyDirective, AXHotkeysService, AXHtmlEvent, AXInfiniteScrollerDirective, AXInvertedColorDirective, AXItemClickEvent, AXListDataSource, AXNgModelDelayedValueChangedDirective, AXOptionChangedEvent, AXPagedComponent, AXRangeChangedEvent, AXResponsiveDirective, AXRippleDirective, AXSearchableComponent, AXSelectionValueChangedEvent, AXValuableComponent, AXValueChangedEvent, AX_LOCATIONS, AX_PLACEMENT_BOTTOM, AX_PLACEMENT_BOTTOM_END, AX_PLACEMENT_BOTTOM_START, AX_PLACEMENT_END, AX_PLACEMENT_END_BOTTOM, AX_PLACEMENT_END_TOP, AX_PLACEMENT_MAP, AX_PLACEMENT_START, AX_PLACEMENT_START_BOTTOM, AX_PLACEMENT_START_TOP, AX_PLACEMENT_TOP, AX_PLACEMENT_TOP_END, AX_PLACEMENT_TOP_START, AX_SELECTION_DATA_TOKEN, AX_STYLE_COLOR_TYPES, AX_STYLE_LOOK_TYPES, MXBaseComponent, MXButtonBaseComponent, MXColorComponent, MXColorLookComponent, MXInputBaseValueComponent, MXInteractiveComponent, MXLookComponent, MXLookableComponent, MXSelectionBridgeService, MXSelectionValueComponent, MXValueComponent, NXButtonComponent, NXClickEvent, NXColorComponent, NXComponent, NXEvent, NXInteractiveComponent, NXLookComponent, NXNativeEvent, NXValueComponent, TAB_META_KEY, convertArrayToDataSource, convertToPlacement };
-export type { AXAnimationEasing, AXComponentState, AXConnectedPosition, AXDataListFetchCallbackResult, AXDataListFetchDataCallback, AXDataListItems, AXDataListQuery, AXDataSourceByKeyCallback, AXDataSourceCallbackResult, AXDataSourceChangedEvent, AXDataSourceConfig, AXDataSourceFilterOption, AXDataSourceItemExpandedEvent, AXDataSourceLoadCallback, AXDataSourceOperator, AXDataSourceQuery, AXDataSourceSortOption, AXDirection, AXExpandToggleIcons, AXFilterLogic, AXFormValidationRule, AXHotKeyAction, AXLocation, AXOrientation, AXPagedComponentInterface, AXPlacement, AXPlacementType, AXRange, AXScrollPosition, AXSelectionMode, AXSizeType, AXSortOrder, AXStyleColorType, AXStyleLookType, AXStyleSizeType, AXSurfaceType, MXComponentOptionChanged, MXComponentOptionChanging, MXComponentSetOption };
+export type { AXAnimationEasing, AXComponentState, AXConnectedPosition, AXDataListFetchCallbackResult, AXDataListFetchDataCallback, AXDataListItems, AXDataListQuery, AXDataSourceByKeyCallback, AXDataSourceCallbackResult, AXDataSourceChangedEvent, AXDataSourceConfig, AXDataSourceFilterOption, AXDataSourceItemExpandedEvent, AXDataSourceLoadCallback, AXDataSourceOperator, AXDataSourceQuery, AXDataSourceSortOption, AXDirection, AXExpandToggleIcons, AXFilterLogic, AXFormValidationRule, AXHotKeyAction, AXLocation, AXOrientation, AXPagedComponentInterface, AXPlacement, AXPlacementType, AXRange, AXScrollPosition, AXSelectionMode, AXSizeType, AXSortOrder, AXStyleColorType, AXStyleLookType, AXStyleSizeType, AXSurfaceType, DisabledCallback, MXComponentOptionChanged, MXComponentOptionChanging, MXComponentSetOption, NormalizedItem };