@decaf-ts/for-angular 0.1.17 → 0.1.20

package/index.d.ts

@@ -1,5 +1,5 @@
 import * as i0 from '@angular/core';
-import { Type, Injector, ElementRef, EnvironmentInjector, InjectionToken, OnChanges, OnDestroy, WritableSignal, ChangeDetectorRef, Renderer2, EventEmitter, SimpleChanges, EnvironmentProviders, Provider, AfterViewInit, ViewContainerRef, TemplateRef, OnInit, ComponentMirror, ComponentRef, PipeTransform, ModuleWithProviders } from '@angular/core';
+import { Type, Injector, ElementRef, EnvironmentInjector, InjectionToken, OnChanges, OnDestroy, WritableSignal, ChangeDetectorRef, Renderer2, EventEmitter, SimpleChanges, EnvironmentProviders, Provider, AfterViewInit, ViewContainerRef, TemplateRef, OnInit, PipeTransform, ComponentMirror, ComponentRef, ModuleWithProviders } from '@angular/core';
 import * as i2 from '@angular/forms';
 import { FormGroup, FormControl, FormArray, ControlValueAccessor, AbstractControl } from '@angular/forms';
 import { OrderDirection, AttributeOption, Observer, Condition, Paginator, Repository, Adapter } from '@decaf-ts/core';
@@ -18,7 +18,7 @@ import { OverlayBaseController } from '@ionic/angular/common';
 import { HttpClient } from '@angular/common/http';
 import { Observable, Subject, Subscription } from 'rxjs';
 import * as i3 from '@ngx-translate/core';
-import { InterpolationParameters, Translation, InterpolatableTranslationObject, Language, TranslateService, TranslateLoader, TranslationObject, TranslateParser, RootTranslateServiceConfig } from '@ngx-translate/core';
+import { InterpolationParameters, Translation, InterpolatableTranslationObject, Language, TranslateLoader, TranslationObject, TranslateParser, RootTranslateServiceConfig, TranslateService } from '@ngx-translate/core';
 import { Title, SafeHtml, DomSanitizer } from '@angular/platform-browser';
 import { sf, Logger, LoggedClass } from '@decaf-ts/logging';
 import { NavigationOptions } from '@ionic/angular/common/providers/nav-controller';
@@ -485,6 +485,28 @@ interface ILayoutModelContext {
     };
     models: IRepositoryModelProps<Model>[];
 }
+/**
+ * @description Configuration object for the {@link DecafTooltipDirective} directive.
+ * @summary Defines the shape of the options accepted by the `[ngx-decaf-tooltip]` attribute
+ * selector. Controls the tooltip text content, whether visible text should be truncated,
+ * the character limit for truncation, and the trailing string appended after a cut.
+ * @property {string} text - The full text to display inside the tooltip and, when truncated,
+ * the source for the truncated visible content.
+ * @property {boolean} [truncate] - When `true`, the host element's inner text is replaced with
+ * a truncated version. Defaults to `false`.
+ * @property {number} [limit] - Maximum number of characters before truncation occurs.
+ * Defaults to `30`.
+ * @property {string} [trail] - String appended at the end of the truncated text.
+ * Defaults to `'...'`.
+ * @interface TooltipConfig
+ * @memberOf module:DecafTooltipDirective
+ */
+interface ITooltipConfig {
+    text: string;
+    truncate?: boolean;
+    limit?: number;
+    trail?: string;
+}
 
 declare const DB_ADAPTER_FLAVOUR_TOKEN = "DbAdapterFlavour";
 /**
@@ -1009,7 +1031,7 @@ declare class NgxMediaService {
 declare class NgxTranslateService extends DecafTranslateService implements DecafTranslateService {
     private translateService;
     instant(key: string, interpolateParams?: InterpolationParameters): Translation;
-    translate(key: string, params?: InterpolationParameters): Translation;
+    translate(key: string, params?: InterpolationParameters | string): Promise<string>;
     get(key: string | string[], params?: InterpolationParameters | string): Promise<string>;
     use(lang: string): void;
     setFallbackLang(lang: string): Observable<InterpolatableTranslationObject>;
@@ -8592,29 +8614,165 @@ declare class NgxRouterService {
 }
 
 declare class TableComponent extends ListComponent implements OnInit {
-    filterModel: Model | string;
+    /**
+     * @description Maximum character count before cell content is truncated. `-1` disables truncation.
+     * @type {number}
+     * @default -1
+     */
+    maxContentLength: number;
+    /**
+     * @description Column keys whose values are never truncated regardless of `maxContentLength`.
+     * @type {string[]}
+     * @default ['userId']
+     */
+    preserve: string[];
+    /**
+     * @description Source used to populate filter select options: a model class, async function, or string key.
+     * @type {Model | FunctionLike | string}
+     */
+    filterModel: Model | FunctionLike | string;
+    /**
+     * @description Array of {@link SelectOption} objects displayed in the filter select control.
+     * @type {SelectOption[]}
+     */
     filterOptions: SelectOption[];
+    /**
+     * @description Translatable label rendered on the filter select input.
+     * @type {string}
+     */
     filterLabel: string;
+    /**
+     * @description Custom function that maps a repository item to a {@link SelectOption} shape.
+     * @type {FunctionLike}
+     */
     filterOptionsMapper: FunctionLike;
+    /**
+     * @description Currently selected filter value; `undefined` when no filter is active.
+     * @type {string | undefined}
+     */
     filterValue?: string;
+    /**
+     * @description Ordered array of column keys rendered as table columns. Includes `'actions'` when operations are permitted.
+     * @type {string[]}
+     */
     cols: string[];
+    /**
+     * @description Column header label array, mirrors `cols` after `getOperations()` resolves.
+     * @type {string[]}
+     */
     headers: string[];
+    /**
+     * @description When `true`, row-level action buttons are rendered if the user has the required permissions.
+     * @type {boolean}
+     * @default true
+     */
     allowOperations: boolean;
+    /**
+     * @description Injected {@link NgxRouterService} used to read URL query parameters for pre-populating the search state.
+     * @type {NgxRouterService}
+     */
     routerService: NgxRouterService;
+    /**
+     * @description Resolves and sorts the visible column keys from the current mapper metadata.
+     * @summary Reads `this._mapper` to obtain all columns that carry a `sequence` property,
+     * then sorts them so that columns anchored to `UIKeys.FIRST` appear first, numerically
+     * sequenced columns are ordered by their value, and `UIKeys.LAST` anchored columns appear
+     * last. Returns the final sorted array of column key strings.
+     * @return {string[]} Sorted array of column keys derived from the mapper.
+     * @mermaid
+     * sequenceDiagram
+     *   participant TC as TableComponent
+     *   participant M as _mapper
+     *   TC->>M: Object.entries(_mapper)
+     *   M-->>TC: [key, value][] entries
+     *   TC->>TC: sort by sequence weight (FIRST=0, number=1, LAST=100)
+     *   TC-->>TC: return sorted keys[]
+     */
     private get _cols();
+    /**
+     * @description Returns the column header labels derived directly from the resolved `cols` array.
+     * @return {string[]} Shallow copy of `cols` used as table header labels.
+     */
     private get _headers();
+    /**
+     * @description Filters the raw mapper to only the entries that declare a `sequence` property.
+     * @summary Iterates over `this.mapper`, retains only keys whose value is a plain object
+     * containing a `sequence` field, and returns the resulting subset as a {@link KeyValue} map
+     * used by `_cols` for ordered column resolution.
+     * @return {KeyValue} Filtered mapper containing only sequenced column definitions.
+     */
     get _mapper(): KeyValue;
+    /**
+     * @description Angular lifecycle hook that initializes the table and loads its first page of data.
+     * @summary Sets up the table by resolving columns, headers, and filter options. It also reads URL query parameters
+     * to pre-populate the search state and triggers the initial data refresh.
+     * @return {Promise<void>}
+     */
     ngOnInit(): Promise<void>;
+    /**
+     * @description Determines which row-level CRUD operations are permitted and finalizes the column list.
+     * @summary Checks user permissions for `UPDATE` and `DELETE` operations. Updates the `cols` and `headers` arrays accordingly.
+     * @return {void}
+     */
     getOperations(): void;
+    /**
+     * @description Populates `filterOptions` from a function call or a decorator-bound repository.
+     * @summary Resolves filter options dynamically based on the provided `filterModel`. Supports both
+     * async functions and repository-based data sources.
+     * @return {Promise<void>}
+     */
     protected getFilterOptions(): Promise<void>;
+    /**
+     * @description Maps a single raw data row to the cell-structured format expected by the table template.
+     * @summary Applies transformations and event bindings to each row of data, preparing it for rendering.
+     * @param {KeyValue} item - Raw data object representing a single table row.
+     * @param {KeyValue} mapper - Column mapper definitions.
+     * @param {KeyValue} [props={}] - Additional rendering props.
+     * @return {Promise<KeyValue>} Mapped row object.
+     */
     protected itemMapper(item: KeyValue, mapper: KeyValue, props?: KeyValue): Promise<KeyValue>;
+    /**
+     * @description Maps an array of raw data objects to the cell-structured rows used by the template.
+     * @summary Resolves all rows concurrently via `Promise.all`, delegating each item to `itemMapper`.
+     * @param {KeyValue[]} data - Raw row objects returned by the data source.
+     * @return {Promise<KeyValue[]>} Array of structured row objects.
+     */
     mapResults(data: KeyValue[]): Promise<KeyValue[]>;
+    /**
+     * @description Handles a CRUD action triggered by a row action button.
+     * @summary Invokes a custom handler or navigates to the appropriate route for the given action.
+     * @param {IBaseCustomEvent} event - The originating event.
+     * @param {UIFunctionLike | undefined} handler - Optional custom handler.
+     * @param {string} uid - Primary key value of the target row.
+     * @param {CrudOperations} action - The CRUD operation type.
+     * @return {Promise<void>}
+     */
     handleAction(event: IBaseCustomEvent, handler: UIFunctionLike | undefined, uid: string, action: CrudOperations): Promise<void>;
+    /**
+     * @description Navigates to the CRUD action route for the specified row.
+     * @summary Verifies the requested `action` and navigates to the appropriate route.
+     * @param {Event | IBaseCustomEvent} event - The originating event.
+     * @param {string} uid - Primary key value of the target row.
+     * @param {CrudOperations} action - The CRUD operation to navigate to.
+     * @return {Promise<void>}
+     */
     handleRedirect(event: Event | IBaseCustomEvent, uid: string, action: CrudOperations): Promise<void>;
+    /**
+     * @description Opens the filter select UI, allowing the user to narrow table results by a field value.
+     * @summary Determines the presentation mode and handles user selection.
+     * @param {Event} event - The click event that triggered the filter open action.
+     * @return {Promise<void>}
+     */
     openFilterSelectOptions(event: Event): Promise<void>;
+    /**
+     * @description Clears the active filter selection and resets the table to an unfiltered state.
+     * @summary Resets `filterValue` and reloads the full data set.
+     * @param {CustomEvent} event - The clear event emitted by the filter select control.
+     * @return {Promise<void>}
+     */
     handleFilterSelectClear(event: CustomEvent): Promise<void>;
     static ɵfac: i0.ɵɵFactoryDeclaration<TableComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<TableComponent, "ngx-decaf-table", never, { "filterModel": { "alias": "filterModel"; "required": false; }; "filterOptions": { "alias": "filterOptions"; "required": false; }; "filterLabel": { "alias": "filterLabel"; "required": false; }; "filterOptionsMapper": { "alias": "filterOptionsMapper"; "required": false; }; "allowOperations": { "alias": "allowOperations"; "required": false; }; }, {}, never, never, true, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<TableComponent, "ngx-decaf-table", never, { "maxContentLength": { "alias": "maxContentLength"; "required": false; }; "preserve": { "alias": "preserve"; "required": false; }; "filterModel": { "alias": "filterModel"; "required": false; }; "filterOptions": { "alias": "filterOptions"; "required": false; }; "filterLabel": { "alias": "filterLabel"; "required": false; }; "filterOptionsMapper": { "alias": "filterOptionsMapper"; "required": false; }; "allowOperations": { "alias": "allowOperations"; "required": false; }; }, {}, never, never, true, never>;
 }
 
 declare class ForAngularComponentsModule {
@@ -8623,6 +8781,151 @@ declare class ForAngularComponentsModule {
     static ɵinj: i0.ɵɵInjectorDeclaration<ForAngularComponentsModule>;
 }
 
+/**
+ * @module lib/directives/NgxSvgDirective
+ * @description Standalone directive that inlines SVG assets into the host element.
+ * @summary Provides {@link NgxSvgDirective}, a lightweight Angular directive that resolves
+ * an SVG file path from either its input binding or the host element's `src` attribute and
+ * delegates the HTTP fetch and DOM injection to {@link NgxMediaService}.
+ * @link {@link NgxSvgDirective}
+ */
+
+/**
+ * @description Angular directive that fetches an SVG file and inlines it into the host element.
+ * @summary Standalone directive bound to the `[ngx-decaf-svg]` attribute selector. On
+ * initialisation it resolves the SVG asset path from the `[ngx-decaf-svg]` input binding or,
+ * as a fallback, the host element's native `src` attribute. Once a non-empty path is determined
+ * it calls {@link NgxMediaService.loadSvgObserver}, which performs the HTTP request via
+ * {@link HttpClient} and injects the SVG markup directly into the host element's DOM, enabling
+ * full CSS styling of the inlined SVG.
+ * @class NgxSvgDirective
+ * @implements {OnInit}
+ * @example
+ * ```html
+ * <!-- Via directive binding -->
+ * <div [ngx-decaf-svg]="'/assets/icons/logo.svg'"></div>
+ *
+ * <!-- Fallback to src attribute -->
+ * <img ngx-decaf-svg src="/assets/icons/arrow.svg" />
+ * ```
+ */
+declare class NgxSvgDirective implements OnInit {
+    /**
+     * @description URL or asset path to the SVG file to inline.
+     * @summary Bound via the `[ngx-decaf-svg]` attribute. When empty or not provided, the
+     * directive falls back to reading the host element's native `src` attribute during
+     * `ngOnInit`.
+     * @type {string}
+     * @memberOf module:lib/directives/NgxSvgDirective
+     */
+    path: string;
+    /**
+     * @description Service responsible for fetching and inlining the SVG markup.
+     * @summary Injected {@link NgxMediaService} instance used by `ngOnInit` to perform the
+     * HTTP request and inject the resulting SVG markup into the host element's DOM.
+     * @type {NgxMediaService}
+     * @memberOf module:lib/directives/NgxSvgDirective
+     */
+    mediaService: NgxMediaService;
+    /**
+     * @description Reference to the host DOM element into which the SVG will be injected.
+     * @summary Obtained via Angular's `inject(ElementRef)`. Provides access to the native
+     * element forwarded to {@link NgxMediaService.loadSvgObserver} as the injection target,
+     * and used as a fallback source for the `src` attribute when `path` is not set.
+     * @type {ElementRef}
+     * @memberOf module:lib/directives/NgxSvgDirective
+     */
+    element: ElementRef;
+    /**
+     * @description HTTP client instance forwarded to the media service for the SVG fetch.
+     * @summary Injected {@link HttpClient} passed directly to
+     * {@link NgxMediaService.loadSvgObserver} so the service can issue the GET request for
+     * the SVG file without managing its own HTTP dependency.
+     * @type {HttpClient}
+     * @memberOf module:lib/directives/NgxSvgDirective
+     */
+    http: HttpClient;
+    /**
+     * @description Resolves the SVG path and triggers the inline load.
+     * @summary Trims `path` and, when empty, falls back to the host element's `src` attribute.
+     * When a valid path is found, delegates to {@link NgxMediaService.loadSvgObserver} to
+     * fetch the file and inject the SVG markup into the host element.
+     * @returns {void}
+     * @memberOf module:lib/directives/NgxSvgDirective
+     */
+    ngOnInit(): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<NgxSvgDirective, never>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<NgxSvgDirective, "[ngx-decaf-svg]", never, { "path": { "alias": "ngx-decaf-svg"; "required": false; }; }, {}, never, never, true, never>;
+}
+
+declare class DecafTruncatePipe implements PipeTransform {
+    transform(value: string, limit?: number, trail?: string): string;
+    sanitize(value: string): string;
+    static ɵfac: i0.ɵɵFactoryDeclaration<DecafTruncatePipe, never>;
+    static ɵpipe: i0.ɵɵPipeDeclaration<DecafTruncatePipe, "truncate", true>;
+}
+
+/**
+ * @module DecafTooltipDirective
+ * @description Provides a tooltip directive for the decaf-ts for-angular library.
+ * @summary This module defines the {@link DecafTooltipDirective}, a standalone Angular directive
+ * that dynamically appends a tooltip element to any host element it decorates. It also supports
+ * optional text truncation using the {@link DecafTruncatePipe}.
+ */
+
+/**
+ * @description Angular directive that appends a tooltip `<span>` to the host element and
+ * optionally truncates its visible text content.
+ * @summary The `DecafTooltipDirective` is a standalone Angular directive bound to the
+ * `[ngx-decaf-tooltip]` attribute selector. It processes the {@link TooltipConfig} provided
+ * via the `options` input, sanitizes the text, and appends a `.dcf-tooltip` `<span>` containing
+ * the sanitized full text to the host element. The directive also applies the `dcf-tooltip-parent`
+ * CSS class to the host for tooltip positioning. When truncation is enabled, the host element's
+ * inner content is replaced with the truncated text before the tooltip span is added.
+ * @example
+ * ```html
+ * <!-- Basic tooltip -->
+ * <span [ngx-decaf-tooltip]="{ text: 'Full description here' }">Hover me</span>
+ *
+ * <!-- Truncated visible text with tooltip showing the full content -->
+ * <span [ngx-decaf-tooltip]="{ text: veryLongLabel, truncate: true, limit: 20, trail: '…' }">
+ *   {{ veryLongLabel }}
+ * </span>
+ * ```
+ * @class DecafTooltipDirective
+ */
+/**
+ * @description Angular lifecycle hook invoked whenever one or more input properties change.
+ * @summary Processes the {@link ITooltipConfig} options, sanitizes the text, and updates the
+ * host element's content and tooltip span accordingly. Applies the `dcf-tooltip-parent` CSS class
+ * to the host for styling.
+ * @return {void}
+ */
+declare class DecafTooltipDirective implements OnChanges {
+    options: ITooltipConfig;
+    /**
+     * @description Reference to the host DOM element into which the SVG will be injected.
+     * @summary Obtained via Angular's `inject(ElementRef)`. Provides access to the native
+     * element forwarded to {@link NgxMediaService.loadSvgObserver} as the injection target,
+     * and used as a fallback source for the `src` attribute when `path` is not set.
+     * @type {ElementRef}
+     * @memberOf module:lib/directives/NgxSvgDirective
+     */
+    element: ElementRef;
+    renderer: Renderer2;
+    truncatePipe: DecafTruncatePipe;
+    /**
+     * @description Angular lifecycle hook invoked whenever one or more input properties change.
+     * @summary Processes the {@link TooltipConfig} options, sanitizes the text, and updates the
+     * host element's content and tooltip span accordingly. Applies the `dcf-tooltip-parent` CSS class
+     * to the host for styling.
+     * @return {void}
+     */
+    ngOnChanges(): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<DecafTooltipDirective, never>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<DecafTooltipDirective, "[ngx-decaf-tooltip]", never, { "options": { "alias": "ngx-decaf-tooltip"; "required": false; }; }, {}, never, never, true, never>;
+}
+
 declare function getDbAdapterFlavour(): string;
 /**
  * @description Provides an array of component types for dynamic rendering.
@@ -9468,6 +9771,8 @@ declare class NgxFormService {
      * @static
      */
     static getFormData(formGroup: FormGroup): Record<string, unknown>;
+    static getFormArrayControlsValue(formArray: FormArray): unknown;
+    static controlHasValue(control: AbstractControl): boolean;
     /**
      * @description Validates fields in a form control or form group.
      * @summary Recursively validates all fields in a form control or form group, marking them as touched and dirty.
@@ -9652,14 +9957,204 @@ declare abstract class NgxEventHandler extends DecafEventHandler {
     afterUpdate(...args: unknown[]): Promise<any>;
 }
 
-declare class NgxSvgDirective implements OnInit {
-    path: string;
-    mediaService: NgxMediaService;
-    element: ElementRef;
-    http: HttpClient;
-    ngOnInit(): void;
-    static ɵfac: i0.ɵɵFactoryDeclaration<NgxSvgDirective, never>;
-    static ɵdir: i0.ɵɵDirectiveDeclaration<NgxSvgDirective, "[ngx-decaf-svg]", never, { "path": { "alias": "ngx-decaf-svg"; "required": false; }; }, {}, never, never, true, never>;
+/**
+ * @module lib/for-angular-common.module
+ * @description Core Angular module and providers for Decaf's for-angular package.
+ * @summary Provides the shared Angular module, injection tokens and helper functions used
+ * by the for-angular integration. This module wires up common imports (forms, translation)
+ * and exposes helper providers such as DB adapter registration and logger utilities.
+ * @link {@link ForAngularCommonModule}
+ */
+
+/**
+ * @description Main Angular module for the Decaf framework.
+ * @summary The ForAngularCommonModule provides the core functionality for integrating Decaf with Angular applications.
+ * It imports and exports common Angular and Ionic components and modules needed for Decaf applications,
+ * including form handling, translation support, and Ionic UI components. This module can be imported
+ * directly or via the forRoot() method for proper initialization in the application's root module.
+ * @class ForAngularCommonModule
+ * @memberOf module:lib/for-angular-common.module
+ * @example
+ * // In your app module:
+ * @NgModule({
+ *   imports: [
+ *     ForAngularCommonModule.forRoot(),
+ *     // other imports
+ *   ],
+ *   // ...
+ * })
+ * export class AppModule {}
+ */
+declare class ForAngularCommonModule {
+    /**
+     * @description Creates a module with providers for root module import.
+     * @summary This static method provides the proper way to import the ForAngularCommonModule in the application's
+     * root module. It returns a ModuleWithProviders object that includes the ForAngularCommonModule itself.
+     * Using forRoot() ensures that the module and its providers are properly initialized and only
+     * instantiated once in the application.
+     * @return {ModuleWithProviders<ForAngularCommonModule>} The module with its providers
+     * @memberOf ForAngularCommonModule
+     * @static
+     * @example
+     * // Import in root module
+     * @NgModule({
+     *   imports: [ForAngularCommonModule.forRoot()],
+     *   // ...
+     * })
+     * export class AppModule {}
+     */
+    static forRoot(): ModuleWithProviders<ForAngularCommonModule>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<ForAngularCommonModule, never>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<ForAngularCommonModule, never, [typeof i1.CommonModule, typeof i2.FormsModule, typeof i2.ReactiveFormsModule, typeof i3.TranslateModule, typeof i3.TranslatePipe], [typeof i1.CommonModule, typeof i2.FormsModule, typeof i2.ReactiveFormsModule, typeof i3.TranslateModule, typeof i3.TranslatePipe]>;
+    static ɵinj: i0.ɵɵInjectorDeclaration<ForAngularCommonModule>;
+}
+
+/**
+ * @module module:lib/i18n/Loader
+ * @description Internationalization loader and helpers for the for-angular package.
+ * @summary Provides an implementation of TranslateLoader (I18nLoader) and helper factories
+ * to load translation resources. Also exposes locale utilities used by components to resolve
+ * localized keys.
+ *
+ * @link {@link I18nLoader}
+ */
+
+/**
+ * @description Retrieves the locale context for a given class, object, or string.
+ * @summary Resolves the locale context by extracting the class name or using the provided suffix.
+ *
+ * @param {FunctionLike | object | string} clazz - The class, object, or string to derive the locale context from.
+ * @param {string} [suffix] - An optional suffix to append to the locale context.
+ * @returns {string} - The resolved locale context string.
+ */
+declare function getLocaleContext(clazz: FunctionLike | object | string, suffix?: string): string;
+/**
+ * @description Generates a localized string by combining locale and phrase
+ * @summary This utility function creates a properly formatted locale string by combining
+ * a locale identifier with a phrase. It handles edge cases such as empty phrases,
+ * missing locales, and phrases that already include the locale prefix. This function
+ * is useful for ensuring consistent formatting of localized strings throughout the application.
+ *
+ * @param {string} locale - The locale identifier (e.g., 'en', 'fr')
+ * @param {string | undefined} phrase - The phrase to localize
+ * @return {string} The formatted locale string, or empty string if phrase is undefined
+ *
+ * @function generateLocaleFromString
+ * @memberOf module:for-angular
+ */
+declare function getLocaleContextByKey(locale: string, phrase: string | undefined): string;
+/**
+ * @description Factory function for creating an instance of I18nLoader.
+ * @summary Configures and returns an I18nLoader instance with the specified HTTP client and translation resources.
+ *
+ * @param {HttpClient} http - The HTTP client used to fetch translation resources.
+ * @returns {TranslateLoader} - An instance of I18nLoader configured with the provided HTTP client and resources.
+ */
+declare function I18nLoaderFactory(http: HttpClient): TranslateLoader;
+/**
+ * @description Provides the I18nLoader configuration.
+ * @summary Configures the translation resources and versioned suffix for the I18nLoader.
+ *
+ * @param {I18nResourceConfigType} [resources=[]] - The translation resources to be used by the loader.
+ * @param {boolean} [versionedSuffix=false] - Whether to append a versioned suffix to resource URLs.
+ * @returns {object} - The configuration object for the I18nLoader.
+ */
+declare function provideDecafI18nLoader(resources?: I18nResourceConfigType, versionedSuffix?: boolean): {
+    provide: typeof I18N_CONFIG_TOKEN;
+    useValue: {
+        resources: I18nResourceConfig[];
+        versionedSuffix: boolean;
+    };
+};
+/**
+ * @description Custom implementation of TranslateLoader for loading translations.
+ * @summary Fetches and merges translation resources, supporting versioned suffixes and recursive merging.
+ */
+declare class I18nLoader implements TranslateLoader {
+    private http;
+    private resources;
+    private versionedSuffix;
+    static enabled: boolean;
+    static cache: Record<string, TranslationObject>;
+    /**
+     * @param {HttpClient} http - The HTTP client used to fetch translation resources.
+     * @param {I18nResourceConfig[]} [resources=[]] - The translation resources to be loaded.
+     * @param {boolean} [versionedSuffix=false] - Whether to append a versioned suffix to resource URLs.
+     */
+    constructor(http: HttpClient, resources?: I18nResourceConfig[], versionedSuffix?: boolean);
+    /**
+     * @description Appends a versioned suffix to the resource URL if enabled.
+     * @summary Generates a versioned suffix based on the current date.
+     *
+     * @param {string} suffix - The original suffix of the resource URL.
+     * @returns {string} - The modified suffix with a version string appended.
+     */
+    private getSuffix;
+    /**
+     * @description Fetches and merges translations for the specified language.
+     * @summary Loads translation resources, merges them recursively, and includes library keys.
+     *
+     * @param {string} lang - The language code for the translations to load.
+     * @returns {Observable<TranslationObject>} - An observable that emits the merged translation object.
+     */
+    getTranslation(lang: string): Observable<TranslationObject>;
+}
+/**
+ * @description Custom implementation of TranslateParser for interpolation.
+ * @summary Extends TranslateParser to support string formatting with parameters.
+ */
+declare class I18nParser extends TranslateParser {
+    /**
+     * @description Interpolates a translation string with parameters.
+     * @summary Replaces placeholders in the translation string with parameter values.
+     *
+     * @param {string} value - The translation string to interpolate.
+     * @param {object | string} [params={}] - The parameters to replace placeholders with.
+     * @returns {string} - The interpolated translation string.
+     */
+    interpolate(value: string, params?: object | string): string;
+}
+/**
+ * @description Provides the internationalization (i18n) configuration for the application.
+ * @summary Configures the translation service with a fallback language, default language, custom parser, and loader.
+ *
+ * @param {RootTranslateServiceConfig} [config={fallbackLang: 'en', lang: 'en'}] - The configuration for the translation service, including fallback and default languages.
+ * @param {I18nResourceConfigType} [resources=[]] - The translation resources to be used by the loader.
+ * @param {boolean} [versionedSuffix=false] - Whether to append a versioned suffix to resource URLs.
+ * @returns {AngularProvider[]} - An array of providers for the translation service and loader.
+ */
+declare function provideDecafI18nConfig(config?: RootTranslateServiceConfig, resources?: I18nResourceConfigType, versionedSuffix?: boolean, enabled?: boolean): AngularProvider[];
+
+/**
+ * @module DecafTranslatePipe
+ * @description Angular pipe for translating text using the `@ngx-translate/core` library.
+ * @summary The `DecafTranslatePipe` provides a mechanism to translate text keys into localized
+ * strings based on the current language settings. It integrates with the `TranslateService`
+ * to fetch translations dynamically and supports fallback rendering for untranslated keys.
+ * @class DecafTranslatePipe
+ * @implements {PipeTransform}
+ */
+declare class DecafTranslatePipe implements PipeTransform {
+    /**
+     * @description Injected instance of the `TranslateService` for handling translations.
+     * @type {TranslateService}
+     */
+    translate: TranslateService;
+    /**
+     * @description Transforms a text key into its localized string representation.
+     * @summary Uses the `TranslateService` to fetch the translated string for the provided key.
+     * If translations are disabled or the key is not found, it returns a fallback HTML-wrapped key.
+     * @param {string} value - The translation key to be transformed.
+     * @param {...any[]} args - Optional arguments to interpolate within the translation string.
+     * @return {string} The translated string or a fallback HTML-wrapped key.
+     * @example
+     * ```html
+     * {{ 'HELLO_WORLD' | translate }}
+     * ```
+     */
+    transform(value: string, ...args: []): string;
+    static ɵfac: i0.ɵɵFactoryDeclaration<DecafTranslatePipe, never>;
+    static ɵpipe: i0.ɵɵPipeDeclaration<DecafTranslatePipe, "translate", true>;
 }
 
 /**
@@ -10004,6 +10499,7 @@ declare function filterString(original: string | string[], value: string, contai
  * @returns {string} The icon associated with the menu item if found, otherwise an empty string.
  */
 declare function getMenuIcon(label: string, menu: IMenuItem[]): string;
+declare function dateFromString(value: string): Date;
 
 declare class DecafFakerRepository<T extends Model> extends LoggedClass {
     protected model: string | Model;
@@ -10023,179 +10519,5 @@ declare class DecafFakerRepository<T extends Model> extends LoggedClass {
 }
 declare function getFakerData<T extends Model>(limit: number | undefined, data: Record<string, FunctionLike>, model?: string): T[];
 
-/**
- * @module module:lib/i18n/Loader
- * @description Internationalization loader and helpers for the for-angular package.
- * @summary Provides an implementation of TranslateLoader (I18nLoader) and helper factories
- * to load translation resources. Also exposes locale utilities used by components to resolve
- * localized keys.
- *
- * @link {@link I18nLoader}
- */
-
-/**
- * @description Retrieves the locale context for a given class, object, or string.
- * @summary Resolves the locale context by extracting the class name or using the provided suffix.
- *
- * @param {FunctionLike | object | string} clazz - The class, object, or string to derive the locale context from.
- * @param {string} [suffix] - An optional suffix to append to the locale context.
- * @returns {string} - The resolved locale context string.
- */
-declare function getLocaleContext(clazz: FunctionLike | object | string, suffix?: string): string;
-/**
- * @description Generates a localized string by combining locale and phrase
- * @summary This utility function creates a properly formatted locale string by combining
- * a locale identifier with a phrase. It handles edge cases such as empty phrases,
- * missing locales, and phrases that already include the locale prefix. This function
- * is useful for ensuring consistent formatting of localized strings throughout the application.
- *
- * @param {string} locale - The locale identifier (e.g., 'en', 'fr')
- * @param {string | undefined} phrase - The phrase to localize
- * @return {string} The formatted locale string, or empty string if phrase is undefined
- *
- * @function generateLocaleFromString
- * @memberOf module:for-angular
- */
-declare function getLocaleContextByKey(locale: string, phrase: string | undefined): string;
-/**
- * @description Factory function for creating an instance of I18nLoader.
- * @summary Configures and returns an I18nLoader instance with the specified HTTP client and translation resources.
- *
- * @param {HttpClient} http - The HTTP client used to fetch translation resources.
- * @returns {TranslateLoader} - An instance of I18nLoader configured with the provided HTTP client and resources.
- */
-declare function I18nLoaderFactory(http: HttpClient): TranslateLoader;
-/**
- * @description Provides the I18nLoader configuration.
- * @summary Configures the translation resources and versioned suffix for the I18nLoader.
- *
- * @param {I18nResourceConfigType} [resources=[]] - The translation resources to be used by the loader.
- * @param {boolean} [versionedSuffix=false] - Whether to append a versioned suffix to resource URLs.
- * @returns {object} - The configuration object for the I18nLoader.
- */
-declare function provideDecafI18nLoader(resources?: I18nResourceConfigType, versionedSuffix?: boolean): {
-    provide: typeof I18N_CONFIG_TOKEN;
-    useValue: {
-        resources: I18nResourceConfig[];
-        versionedSuffix: boolean;
-    };
-};
-/**
- * @description Custom implementation of TranslateLoader for loading translations.
- * @summary Fetches and merges translation resources, supporting versioned suffixes and recursive merging.
- */
-declare class I18nLoader implements TranslateLoader {
-    private http;
-    private resources;
-    private versionedSuffix;
-    static enabled: boolean;
-    static cache: Record<string, TranslationObject>;
-    /**
-     * @param {HttpClient} http - The HTTP client used to fetch translation resources.
-     * @param {I18nResourceConfig[]} [resources=[]] - The translation resources to be loaded.
-     * @param {boolean} [versionedSuffix=false] - Whether to append a versioned suffix to resource URLs.
-     */
-    constructor(http: HttpClient, resources?: I18nResourceConfig[], versionedSuffix?: boolean);
-    /**
-     * @description Appends a versioned suffix to the resource URL if enabled.
-     * @summary Generates a versioned suffix based on the current date.
-     *
-     * @param {string} suffix - The original suffix of the resource URL.
-     * @returns {string} - The modified suffix with a version string appended.
-     */
-    private getSuffix;
-    /**
-     * @description Fetches and merges translations for the specified language.
-     * @summary Loads translation resources, merges them recursively, and includes library keys.
-     *
-     * @param {string} lang - The language code for the translations to load.
-     * @returns {Observable<TranslationObject>} - An observable that emits the merged translation object.
-     */
-    getTranslation(lang: string): Observable<TranslationObject>;
-}
-/**
- * @description Custom implementation of TranslateParser for interpolation.
- * @summary Extends TranslateParser to support string formatting with parameters.
- */
-declare class I18nParser extends TranslateParser {
-    /**
-     * @description Interpolates a translation string with parameters.
-     * @summary Replaces placeholders in the translation string with parameter values.
-     *
-     * @param {string} value - The translation string to interpolate.
-     * @param {object | string} [params={}] - The parameters to replace placeholders with.
-     * @returns {string} - The interpolated translation string.
-     */
-    interpolate(value: string, params?: object | string): string;
-}
-/**
- * @description Provides the internationalization (i18n) configuration for the application.
- * @summary Configures the translation service with a fallback language, default language, custom parser, and loader.
- *
- * @param {RootTranslateServiceConfig} [config={fallbackLang: 'en', lang: 'en'}] - The configuration for the translation service, including fallback and default languages.
- * @param {I18nResourceConfigType} [resources=[]] - The translation resources to be used by the loader.
- * @param {boolean} [versionedSuffix=false] - Whether to append a versioned suffix to resource URLs.
- * @returns {AngularProvider[]} - An array of providers for the translation service and loader.
- */
-declare function provideDecafI18nConfig(config?: RootTranslateServiceConfig, resources?: I18nResourceConfigType, versionedSuffix?: boolean, enabled?: boolean): AngularProvider[];
-declare class DecafTranslatePipe implements PipeTransform {
-    translate: TranslateService;
-    transform(value: string, ...args: []): unknown;
-    static ɵfac: i0.ɵɵFactoryDeclaration<DecafTranslatePipe, never>;
-    static ɵpipe: i0.ɵɵPipeDeclaration<DecafTranslatePipe, "translate", true>;
-}
-
-/**
- * @module lib/for-angular-common.module
- * @description Core Angular module and providers for Decaf's for-angular package.
- * @summary Provides the shared Angular module, injection tokens and helper functions used
- * by the for-angular integration. This module wires up common imports (forms, translation)
- * and exposes helper providers such as DB adapter registration and logger utilities.
- * @link {@link ForAngularCommonModule}
- */
-
-/**
- * @description Main Angular module for the Decaf framework.
- * @summary The ForAngularCommonModule provides the core functionality for integrating Decaf with Angular applications.
- * It imports and exports common Angular and Ionic components and modules needed for Decaf applications,
- * including form handling, translation support, and Ionic UI components. This module can be imported
- * directly or via the forRoot() method for proper initialization in the application's root module.
- * @class ForAngularCommonModule
- * @memberOf module:lib/for-angular-common.module
- * @example
- * // In your app module:
- * @NgModule({
- *   imports: [
- *     ForAngularCommonModule.forRoot(),
- *     // other imports
- *   ],
- *   // ...
- * })
- * export class AppModule {}
- */
-declare class ForAngularCommonModule {
-    /**
-     * @description Creates a module with providers for root module import.
-     * @summary This static method provides the proper way to import the ForAngularCommonModule in the application's
-     * root module. It returns a ModuleWithProviders object that includes the ForAngularCommonModule itself.
-     * Using forRoot() ensures that the module and its providers are properly initialized and only
-     * instantiated once in the application.
-     * @return {ModuleWithProviders<ForAngularCommonModule>} The module with its providers
-     * @memberOf ForAngularCommonModule
-     * @static
-     * @example
-     * // Import in root module
-     * @NgModule({
-     *   imports: [ForAngularCommonModule.forRoot()],
-     *   // ...
-     * })
-     * export class AppModule {}
-     */
-    static forRoot(): ModuleWithProviders<ForAngularCommonModule>;
-    static ɵfac: i0.ɵɵFactoryDeclaration<ForAngularCommonModule, never>;
-    static ɵmod: i0.ɵɵNgModuleDeclaration<ForAngularCommonModule, never, [typeof i1.CommonModule, typeof i2.FormsModule, typeof i2.ReactiveFormsModule, typeof i3.TranslateModule, typeof i3.TranslatePipe], [typeof i1.CommonModule, typeof i2.FormsModule, typeof i2.ReactiveFormsModule, typeof i3.TranslateModule, typeof i3.TranslatePipe]>;
-    static ɵinj: i0.ɵɵInjectorDeclaration<ForAngularCommonModule>;
-}
-
-export { ActionRoles, AngularEngineKeys, BaseComponentProps, CPTKN, CardComponent, ComponentRendererComponent, ComponentsTagNames, CrudFieldComponent, CrudFormComponent, CssClasses, DB_ADAPTER_FLAVOUR_TOKEN, DB_ADAPTER_PROVIDER_TOKEN, DecafFakerRepository, DecafTranslatePipe, DefaultFormReactiveOptions, DefaultListEmptyOptions, DefaultModalOptions, Dynamic, DynamicModule, EmptyStateComponent, FieldsetComponent, FileUploadComponent, FilterComponent, ForAngularCommonModule, ForAngularComponentsModule, I18N_CONFIG_TOKEN, I18nLoader, I18nLoaderFactory, I18nParser, IconComponent, LOCALE_ROOT_TOKEN, LayoutComponent, ListComponent, ListComponentsTypes, ListItemComponent, ListItemPositions, ModalComponent, ModalConfirmComponent, ModelRendererComponent, NgxComponentDirective, NgxEventHandler, NgxFormDirective, NgxFormFieldDirective, NgxFormService, NgxMediaService, NgxModelPageDirective, NgxPageDirective, NgxParentComponentDirective, NgxRenderingEngine, NgxRouterService, NgxSvgDirective, PaginationComponent, RouteDirections, SearchbarComponent, SelectFieldInterfaces, SteppedFormComponent, TableComponent, WindowColorSchemes, cleanSpaces, dataMapper, decafPageTransition, filterString, formatDate, generateRandomValue, getDbAdapterFlavour, getFakerData, getInjectablesRegistry, getLocaleContext, getLocaleContextByKey, getLocaleFromClassName, getLocaleLanguage, getLogger, getMenuIcon, getModelAndRepository, getNgxInlineModal, getNgxModalComponent, getNgxModalCrudComponent, getNgxSelectOptionsModal, getOnWindow, getOnWindowDocument, getWindow, getWindowDocument, getWindowWidth, isDarkMode, isDevelopmentMode, isNotUndefined, isValidDate, itemMapper, patternValidators, presentModalConfirm, presentNgxInlineModal, presentNgxLightBoxModal, provideDecafDarkMode, provideDecafDbAdapter, provideDecafDynamicComponents, provideDecafI18nConfig, provideDecafI18nLoader, provideDecafPageTransition, removeFocusTrap, setOnWindow, stringToBoolean, windowEventEmitter };
-export type { ActionRole, AngularDynamicOutput, AngularFieldDefinition, AngularProvider, CheckboxOption, ComparisonValidationKey, ComponentMetadata, CrudEvent, CrudFieldOption, DecafComponentConstructor, DecafRepository, DecafRepositoryAdapter, ElementPosition, ElementSize, FieldUpdateMode, FilterCondition, FlexPosition, FormParent, FormParentGroup, FormServiceControl, FormServiceControls, FunctionLike, HTML5InputType, HTMLFormTarget, I18nResourceConfig, I18nResourceConfigType, I18nToken, IBaseCustomEvent, IComponentConfig, IComponentHolder, IComponentProperties, ICrudFormEvent, ICrudFormOptions, IFieldSetItem, IFieldSetValidationEvent, IFileUploadError, IFilterQuery, IFilterQueryItem, IFormComponentProperties, IFormElement, ILayoutModelContext, IListComponentRefreshEvent, IListEmptyOptions, IListItemCustomEvent, IMenuItem, IModelComponentSubmitEvent, IPaginationCustomEvent, IRenderedModel, IRepositoryModelProps, ISortObject, ITabItem, IWindowResizeEvent, InputOption, KeyValue, LayoutGridGap, ListItemPosition, PossibleInputTypes, PropsMapperFn, RadioOption, RawQuery, SelectOption, StringOrBoolean, WindowColorScheme };
+export { ActionRoles, AngularEngineKeys, BaseComponentProps, CPTKN, CardComponent, ComponentRendererComponent, ComponentsTagNames, CrudFieldComponent, CrudFormComponent, CssClasses, DB_ADAPTER_FLAVOUR_TOKEN, DB_ADAPTER_PROVIDER_TOKEN, DecafFakerRepository, DecafTooltipDirective, DecafTranslatePipe, DecafTruncatePipe, DefaultFormReactiveOptions, DefaultListEmptyOptions, DefaultModalOptions, Dynamic, DynamicModule, EmptyStateComponent, FieldsetComponent, FileUploadComponent, FilterComponent, ForAngularCommonModule, ForAngularComponentsModule, I18N_CONFIG_TOKEN, I18nLoader, I18nLoaderFactory, I18nParser, IconComponent, LOCALE_ROOT_TOKEN, LayoutComponent, ListComponent, ListComponentsTypes, ListItemComponent, ListItemPositions, ModalComponent, ModalConfirmComponent, ModelRendererComponent, NgxComponentDirective, NgxEventHandler, NgxFormDirective, NgxFormFieldDirective, NgxFormService, NgxMediaService, NgxModelPageDirective, NgxPageDirective, NgxParentComponentDirective, NgxRenderingEngine, NgxRouterService, NgxSvgDirective, PaginationComponent, RouteDirections, SearchbarComponent, SelectFieldInterfaces, SteppedFormComponent, TableComponent, WindowColorSchemes, cleanSpaces, dataMapper, dateFromString, decafPageTransition, filterString, formatDate, generateRandomValue, getDbAdapterFlavour, getFakerData, getInjectablesRegistry, getLocaleContext, getLocaleContextByKey, getLocaleFromClassName, getLocaleLanguage, getLogger, getMenuIcon, getModelAndRepository, getNgxInlineModal, getNgxModalComponent, getNgxModalCrudComponent, getNgxSelectOptionsModal, getOnWindow, getOnWindowDocument, getWindow, getWindowDocument, getWindowWidth, isDarkMode, isDevelopmentMode, isNotUndefined, isValidDate, itemMapper, patternValidators, presentModalConfirm, presentNgxInlineModal, presentNgxLightBoxModal, provideDecafDarkMode, provideDecafDbAdapter, provideDecafDynamicComponents, provideDecafI18nConfig, provideDecafI18nLoader, provideDecafPageTransition, removeFocusTrap, setOnWindow, stringToBoolean, windowEventEmitter };
+export type { ActionRole, AngularDynamicOutput, AngularFieldDefinition, AngularProvider, CheckboxOption, ComparisonValidationKey, ComponentMetadata, CrudEvent, CrudFieldOption, DecafComponentConstructor, DecafRepository, DecafRepositoryAdapter, ElementPosition, ElementSize, FieldUpdateMode, FilterCondition, FlexPosition, FormParent, FormParentGroup, FormServiceControl, FormServiceControls, FunctionLike, HTML5InputType, HTMLFormTarget, I18nResourceConfig, I18nResourceConfigType, I18nToken, IBaseCustomEvent, IComponentConfig, IComponentHolder, IComponentProperties, ICrudFormEvent, ICrudFormOptions, IFieldSetItem, IFieldSetValidationEvent, IFileUploadError, IFilterQuery, IFilterQueryItem, IFormComponentProperties, IFormElement, ILayoutModelContext, IListComponentRefreshEvent, IListEmptyOptions, IListItemCustomEvent, IMenuItem, IModelComponentSubmitEvent, IPaginationCustomEvent, IRenderedModel, IRepositoryModelProps, ISortObject, ITabItem, ITooltipConfig, IWindowResizeEvent, InputOption, KeyValue, LayoutGridGap, ListItemPosition, PossibleInputTypes, PropsMapperFn, RadioOption, RawQuery, SelectOption, StringOrBoolean, WindowColorScheme };