@decaf-ts/for-angular 0.0.62 → 0.0.64

package/index.d.ts

@@ -4,7 +4,7 @@ import { IonInput, IonSelect, IonTextarea, IonCheckbox, SpinnerTypes, InfiniteSc
 import { TextFieldTypes, SelectInterface, AutocompleteTypes, CheckboxCustomEvent, Color, PredefinedColors, OverlayEventDetail } from '@ionic/core';
 import * as i2 from '@angular/forms';
 import { FormGroup, FormControl, FormArray, ControlValueAccessor, AbstractControl } from '@angular/forms';
-import { OrderDirection, Repository, Adapter, EventIds, AttributeOption, Paginator, Condition } from '@decaf-ts/core';
+import { OrderDirection, Repository, Adapter, EventIds, AttributeOption, Observer, Paginator, Condition } from '@decaf-ts/core';
 import { FieldProperties, IPagedComponentProperties, CrudOperationKeys, UIFunctionLike, HTML5InputTypes, DecafComponent, UIModelMetadata, FieldDefinition, UIMediaBreakPointsType, UIElementMetadata, RenderingEngine, DecafEventHandler } from '@decaf-ts/ui-decorators';
 import * as _decaf_ts_decorator_validation from '@decaf-ts/decorator-validation';
 import { VALIDATION_PARENT_KEY, Model, ModelConstructor } from '@decaf-ts/decorator-validation';
@@ -17,8 +17,8 @@ import * as i1 from '@angular/common';
 import { Location } from '@angular/common';
 import * as i3 from '@ngx-translate/core';
 import { TranslateService, TranslateLoader, TranslationObject, TranslateParser, RootTranslateServiceConfig } from '@ngx-translate/core';
+import { Observable, Subject, Subscription } from 'rxjs';
 import { HttpClient } from '@angular/common/http';
-import { Observable, Subscription } from 'rxjs';
 import { SafeHtml, DomSanitizer, Title } from '@angular/platform-browser';
 import { InjectablesRegistry } from '@decaf-ts/injectable-decorators';
 import { LoggedClass, Logger } from '@decaf-ts/logging';
@@ -1621,6 +1621,27 @@ declare abstract class NgxComponentDirective extends DecafComponent implements O
      * @default WindowColorSchemes.light
      */
     protected colorSchema: WindowColorScheme;
+    /**
+     * @description Observer object for repository change notifications.
+     * @summary Implements the Observer interface to receive notifications when the
+     * underlying data repository changes. This enables automatic list updates when
+     * data is created, updated, or deleted through the repository.
+     *
+     * @private
+     * @type {Observer}
+     */
+    protected repositoryObserver: Observer;
+    protected destroySubscriptions$: Subject<void>;
+    /**
+     * @description Subject for debouncing repository observation events.
+     * @summary RxJS Subject that collects repository change events and emits them after
+     * a debounce period. This prevents multiple rapid repository changes from triggering
+     * multiple list refresh operations, improving performance and user experience.
+     *
+     * @private
+     * @type {Subject<any>}
+     */
+    protected repositoryObserverSubject: Subject<any>;
     /**
      * @description Constructor for NgxComponentDirective.
      * @summary Initializes the directive by setting up the component name, locale root,
@@ -1638,9 +1659,9 @@ declare abstract class NgxComponentDirective extends DecafComponent implements O
      * released (DOM listeners, timers, subscriptions, etc.). Implementations should
      * keep `mediaService.destroy()` idempotent; calling it here prevents leaks when
      * components are torn down.
-     * @returns {void}
+     * @returns {Promise<void>}
      */
-    ngOnDestroy(): Promise<void> | void;
+    ngOnDestroy(): Promise<void>;
     refresh(...args: unknown[]): Promise<void>;
     /**
      * @description Getter for the current locale context identifier.
@@ -1686,6 +1707,18 @@ declare abstract class NgxComponentDirective extends DecafComponent implements O
      */
     translate(phrase: string | string[], params?: object | string): Promise<string>;
     protected checkDarkMode(): void;
+    /**
+     * @description Handles repository observation events with debouncing.
+     * @summary Processes repository change notifications and routes them appropriately.
+     * For CREATE events with a UID, handles them immediately. For other events,
+     * passes them to the debounced observer subject to prevent excessive updates.
+     *
+     * @param {...unknown[]} args - The repository event arguments including table, event type, and UID
+     * @returns {Promise<void>}
+     * @memberOf ListComponent
+     */
+    handleRepositoryRefresh(...args: unknown[]): Promise<void>;
+    handleObserveEvent(...args: unknown[]): Promise<void>;
     /**
      * @description Retrieves or sets the locale context for the component.
      * @summary Gets the locale identifier from the locale context system. If a locale parameter
@@ -3055,7 +3088,7 @@ declare class CrudFieldComponent extends NgxFormFieldDirective implements OnInit
      * @returns {void}
      * @memberOf CrudFieldComponent
      */
-    ngOnDestroy(): void;
+    ngOnDestroy(): Promise<void>;
     toggleOptionSelection(val: string, event: CheckboxCustomEvent): void;
     isOptionChecked(value: string): boolean;
     static ɵfac: i0.ɵɵFactoryDeclaration<CrudFieldComponent, never>;
@@ -3215,7 +3248,7 @@ declare class NgxParentComponentDirective extends NgxComponentDirective implemen
      */
     protected timerSubscription: Subscription;
     ngOnInit(model?: Model | string): Promise<void>;
-    ngOnDestroy(): Promise<void> | void;
+    ngOnDestroy(): Promise<void>;
     protected getActivePage(page: number, firstClick?: boolean): UIModelMetadata | UIModelMetadata[] | FieldDefinition | undefined;
     static ɵfac: i0.ɵɵFactoryDeclaration<NgxParentComponentDirective, never>;
     static ɵdir: i0.ɵɵDirectiveDeclaration<NgxParentComponentDirective, never, never, { "page": { "alias": "page"; "required": false; }; "pages": { "alias": "pages"; "required": false; }; "parentForm": { "alias": "parentForm"; "required": false; }; "children": { "alias": "children"; "required": false; }; "cols": { "alias": "cols"; "required": false; }; "rows": { "alias": "rows"; "required": false; }; "cardBody": { "alias": "cardBody"; "required": false; }; "cardType": { "alias": "cardType"; "required": false; }; "breakpoint": { "alias": "breakpoint"; "required": false; }; "match": { "alias": "match"; "required": false; }; }, {}, never, never, true, never>;
@@ -3359,7 +3392,7 @@ declare abstract class NgxFormDirective extends NgxParentComponentDirective impl
      *
      * @returns {void}
      */
-    ngOnDestroy(): void;
+    ngOnDestroy(): Promise<void>;
     getFormArrayIndex(index: number): FormParent | undefined;
     /**
      * @description Handles form reset or navigation back functionality.
@@ -5092,6 +5125,17 @@ declare class ListComponent extends NgxComponentDirective implements OnInit, OnD
      * @memberOf ListComponent
      */
     showSearchbar: boolean;
+    /**
+     * @description Controls the visibility of the search bar.
+     * @summary When set to true, displays a search bar at the top of the list that allows
+     * users to filter the list items. The search functionality works by filtering the
+     * existing data or by triggering a new data fetch with search parameters.
+     *
+     * @type {boolean}
+     * @default true
+     * @memberOf ListComponent
+     */
+    searchbarPlaceholder: string;
     /**
      * @description Direct data input for the list component.
      * @summary Provides a way to directly pass data to the list component instead of
@@ -5376,28 +5420,6 @@ declare class ListComponent extends NgxComponentDirective implements OnInit, OnD
      * @memberOf ListComponent
      */
     private clickItemSubject;
-    /**
-     * @description Subject for debouncing repository observation events.
-     * @summary RxJS Subject that collects repository change events and emits them after
-     * a debounce period. This prevents multiple rapid repository changes from triggering
-     * multiple list refresh operations, improving performance and user experience.
-     *
-     * @private
-     * @type {Subject<any>}
-     * @memberOf ListComponent
-     */
-    private observerSubjet;
-    /**
-     * @description Observer object for repository change notifications.
-     * @summary Implements the Observer interface to receive notifications when the
-     * underlying data repository changes. This enables automatic list updates when
-     * data is created, updated, or deleted through the repository.
-     *
-     * @private
-     * @type {Observer}
-     * @memberOf ListComponent
-     */
-    private observer;
     /**
      * @description List of available indexes for data querying and filtering.
      * @summary Provides a list of index names that can be used to optimize data querying and filtering
@@ -5459,21 +5481,63 @@ declare class ListComponent extends NgxComponentDirective implements OnInit, OnD
      * @summary Performs cleanup operations when the component is being removed from the DOM.
      * This includes clearing references to models and data to prevent memory leaks.
      *
-     * @returns {void}
+     * @returns {Promise<void>}
      * @memberOf ListComponent
      */
-    ngOnDestroy(): void;
+    ngOnDestroy(): Promise<void>;
+    destroy(): Promise<void>;
     /**
-     * @description Handles repository observation events with debouncing.
-     * @summary Processes repository change notifications and routes them appropriately.
-     * For CREATE events with a UID, handles them immediately. For other events,
-     * passes them to the debounced observer subject to prevent excessive updates.
+     * @description Refreshes the list data from the configured source.
+     * @summary This method handles both initial data loading and subsequent refresh operations,
+     * including pull-to-refresh and infinite scrolling. It manages the data fetching process,
+     * updates the component's state, and handles pagination or infinite scrolling logic based
+     * on the component's configuration.
+     *
+     * The method performs the following steps:
+     * 1. Sets the refreshing flag to indicate a data fetch is in progress
+     * 2. Calculates the appropriate start and limit values based on pagination settings
+     * 3. Fetches data from the appropriate source (model or request)
+     * 4. Updates the component's data and emits a refresh event
+     * 5. Handles pagination or infinite scrolling state updates
+     * 6. Completes any provided event (like InfiniteScrollCustomEvent)
+     *
+     * @param {InfiniteScrollCustomEvent | RefresherCustomEvent | boolean} event - The event that triggered the refresh,
+     * or a boolean flag indicating if this is a forced refresh
+     * @returns {Promise<void>} A promise that resolves when the refresh operation is complete
+     *
+     * @mermaid
+     * sequenceDiagram
+     *   participant L as ListComponent
+     *   participant D as Data Source
+     *   participant E as Event System
+     *
+     *   L->>L: refresh(event)
+     *   L->>L: Set refreshing flag
+     *   L->>L: Calculate start and limit
+     *   alt Using model
+     *     L->>D: getFromModel(force, start, limit)
+     *     D-->>L: Return data
+     *   else Using request
+     *     L->>D: getFromRequest(force, start, limit)
+     *     D-->>L: Return data
+     *   end
+     *   L->>E: refreshEventEmit()
+     *   alt Infinite scrolling mode
+     *     L->>L: Check if reached last page
+     *     alt Last page reached
+     *       L->>L: Complete scroll event
+     *       L->>L: Disable loadMoreData
+     *     else More pages available
+     *       L->>L: Increment page number
+     *       L->>L: Complete scroll event after delay
+     *     end
+     *   else Paginated mode
+     *     L->>L: Clear refreshing flag after delay
+     *   end
      *
-     * @param {...unknown[]} args - The repository event arguments including table, event type, and UID
-     * @returns {Promise<void>}
      * @memberOf ListComponent
      */
-    observeRepository(...args: unknown[]): Promise<void>;
+    refresh(event?: InfiniteScrollCustomEvent | RefresherCustomEvent | boolean): Promise<void>;
     /**
      * @description Handles specific repository events and updates the list accordingly.
      * @summary Processes repository change events (CREATE, UPDATE, DELETE) and performs
@@ -5613,58 +5677,6 @@ declare class ListComponent extends NgxComponentDirective implements OnInit, OnD
      * @memberOf ListComponent
      */
     private clickEventEmit;
-    /**
-     * @description Refreshes the list data from the configured source.
-     * @summary This method handles both initial data loading and subsequent refresh operations,
-     * including pull-to-refresh and infinite scrolling. It manages the data fetching process,
-     * updates the component's state, and handles pagination or infinite scrolling logic based
-     * on the component's configuration.
-     *
-     * The method performs the following steps:
-     * 1. Sets the refreshing flag to indicate a data fetch is in progress
-     * 2. Calculates the appropriate start and limit values based on pagination settings
-     * 3. Fetches data from the appropriate source (model or request)
-     * 4. Updates the component's data and emits a refresh event
-     * 5. Handles pagination or infinite scrolling state updates
-     * 6. Completes any provided event (like InfiniteScrollCustomEvent)
-     *
-     * @param {InfiniteScrollCustomEvent | RefresherCustomEvent | boolean} event - The event that triggered the refresh,
-     * or a boolean flag indicating if this is a forced refresh
-     * @returns {Promise<void>} A promise that resolves when the refresh operation is complete
-     *
-     * @mermaid
-     * sequenceDiagram
-     *   participant L as ListComponent
-     *   participant D as Data Source
-     *   participant E as Event System
-     *
-     *   L->>L: refresh(event)
-     *   L->>L: Set refreshing flag
-     *   L->>L: Calculate start and limit
-     *   alt Using model
-     *     L->>D: getFromModel(force, start, limit)
-     *     D-->>L: Return data
-     *   else Using request
-     *     L->>D: getFromRequest(force, start, limit)
-     *     D-->>L: Return data
-     *   end
-     *   L->>E: refreshEventEmit()
-     *   alt Infinite scrolling mode
-     *     L->>L: Check if reached last page
-     *     alt Last page reached
-     *       L->>L: Complete scroll event
-     *       L->>L: Disable loadMoreData
-     *     else More pages available
-     *       L->>L: Increment page number
-     *       L->>L: Complete scroll event after delay
-     *     end
-     *   else Paginated mode
-     *     L->>L: Clear refreshing flag after delay
-     *   end
-     *
-     * @memberOf ListComponent
-     */
-    refresh(event?: InfiniteScrollCustomEvent | RefresherCustomEvent | boolean): Promise<void>;
     /**
      * @description Handles pagination events from the pagination component.
      * @summary Processes pagination events by updating the current page number and
@@ -5806,7 +5818,7 @@ declare class ListComponent extends NgxComponentDirective implements OnInit, OnD
     mapResults(data: KeyValue[]): KeyValue[];
     parseSearchValue(): string | IFilterQuery;
     static ɵfac: i0.ɵɵFactoryDeclaration<ListComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<ListComponent, "ngx-decaf-list", never, { "type": { "alias": "type"; "required": false; }; "showSearchbar": { "alias": "showSearchbar"; "required": false; }; "data": { "alias": "data"; "required": false; }; "source": { "alias": "source"; "required": false; }; "start": { "alias": "start"; "required": false; }; "limit": { "alias": "limit"; "required": false; }; "loadMoreData": { "alias": "loadMoreData"; "required": false; }; "lines": { "alias": "lines"; "required": false; }; "inset": { "alias": "inset"; "required": false; }; "scrollThreshold": { "alias": "scrollThreshold"; "required": false; }; "scrollPosition": { "alias": "scrollPosition"; "required": false; }; "loadingText": { "alias": "loadingText"; "required": false; }; "showRefresher": { "alias": "showRefresher"; "required": false; }; "createButton": { "alias": "createButton"; "required": false; }; "loadingSpinner": { "alias": "loadingSpinner"; "required": false; }; "enableFilter": { "alias": "enableFilter"; "required": false; }; "sortBy": { "alias": "sortBy"; "required": false; }; "sortDirection": { "alias": "sortDirection"; "required": false; }; "disableSort": { "alias": "disableSort"; "required": false; }; "empty": { "alias": "empty"; "required": false; }; }, { "clickEvent": "clickEvent"; }, never, ["*"], true, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<ListComponent, "ngx-decaf-list", never, { "type": { "alias": "type"; "required": false; }; "showSearchbar": { "alias": "showSearchbar"; "required": false; }; "searchbarPlaceholder": { "alias": "searchbarPlaceholder"; "required": false; }; "data": { "alias": "data"; "required": false; }; "source": { "alias": "source"; "required": false; }; "start": { "alias": "start"; "required": false; }; "limit": { "alias": "limit"; "required": false; }; "loadMoreData": { "alias": "loadMoreData"; "required": false; }; "lines": { "alias": "lines"; "required": false; }; "inset": { "alias": "inset"; "required": false; }; "scrollThreshold": { "alias": "scrollThreshold"; "required": false; }; "scrollPosition": { "alias": "scrollPosition"; "required": false; }; "loadingText": { "alias": "loadingText"; "required": false; }; "showRefresher": { "alias": "showRefresher"; "required": false; }; "createButton": { "alias": "createButton"; "required": false; }; "loadingSpinner": { "alias": "loadingSpinner"; "required": false; }; "enableFilter": { "alias": "enableFilter"; "required": false; }; "sortBy": { "alias": "sortBy"; "required": false; }; "sortDirection": { "alias": "sortDirection"; "required": false; }; "disableSort": { "alias": "disableSort"; "required": false; }; "empty": { "alias": "empty"; "required": false; }; }, { "clickEvent": "clickEvent"; }, never, ["*"], true, never>;
 }
 
 /**
@@ -6567,7 +6579,7 @@ declare class SearchbarComponent extends NgxComponentDirective implements OnInit
      * @default "off"
      * @memberOf SearchbarComponent
      */
-    autocorrect: "on" | "off";
+    autocorrect: 'on' | 'off';
     /**
      * @description Whether the searchbar should animate.
      * @summary Controls the animation behavior of the searchbar during appearance and disappearance transitions.
@@ -6630,7 +6642,7 @@ declare class SearchbarComponent extends NgxComponentDirective implements OnInit
      * @default "enter"
      * @memberOf SearchbarComponent
      */
-    enterkeyhint: "search" | "enter" | "done" | "go" | "next" | "previous" | "send" | undefined;
+    enterkeyhint: 'search' | 'enter' | 'done' | 'go' | 'next' | 'previous' | 'send' | undefined;
     /**
      * @description The input mode for the searchbar.
      * @summary Specifies the type of data that might be entered by the user while editing the element or its contents.
@@ -6638,7 +6650,7 @@ declare class SearchbarComponent extends NgxComponentDirective implements OnInit
      * @default 'search'
      * @memberOf SearchbarComponent
      */
-    inputmode: "text" | "search" | "none" | "email" | "tel" | "url" | "numeric" | "decimal" | undefined;
+    inputmode: 'text' | 'search' | 'none' | 'email' | 'tel' | 'url' | 'numeric' | 'decimal' | undefined;
     /**
      * @description The placeholder for the searchbar input.
      * @summary Specifies the placeholder text to be displayed in the searchbar when it's empty.
@@ -6662,7 +6674,7 @@ declare class SearchbarComponent extends NgxComponentDirective implements OnInit
      * @default "never"
      * @memberOf SearchbarComponent
      */
-    showCancelButton: "always" | "focus" | "never";
+    showCancelButton: 'always' | 'focus' | 'never';
     /**
      * @description When to show the clear button.
      * @summary Controls the visibility of the clear button in different states of the searchbar.
@@ -6670,7 +6682,7 @@ declare class SearchbarComponent extends NgxComponentDirective implements OnInit
      * @default "focus"
      * @memberOf SearchbarComponent
      */
-    showClearButton: "always" | "focus" | "never";
+    showClearButton: 'always' | 'focus' | 'never';
     /**
      * @description Whether to enable spellcheck on the searchbar input.
      * @summary Controls whether the browser's spellcheck feature is enabled for the searchbar input.
@@ -6686,7 +6698,7 @@ declare class SearchbarComponent extends NgxComponentDirective implements OnInit
      * @default "search"
      * @memberOf SearchbarComponent
      */
-    type: 'number' | "text" | "search" | "email" | "password" | "tel" | "url" | undefined;
+    type: 'number' | 'text' | 'search' | 'email' | 'password' | 'tel' | 'url' | undefined;
     /**
      * @description The value of the searchbar input.
      * @summary Specifies the current value of the searchbar input.
@@ -7073,7 +7085,7 @@ declare class SteppedFormComponent extends NgxFormDirective implements OnInit, O
      *
      * @memberOf SteppedFormComponent
      */
-    ngOnDestroy(): void;
+    ngOnDestroy(): Promise<void>;
     /**
      * @description Handles navigation to the next page or form submission.
      * @summary Validates the current page's form fields and either navigates to the next page
@@ -7625,9 +7637,9 @@ declare class FileUploadComponent extends NgxFormFieldDirective implements OnIni
      * @description Lifecycle hook that is called when a directive, pipe, or service is destroyed.
      * @summary Cleans up the component by calling the parent ngOnDestroy method and clearing the file upload state.
      *
-     * @returns {Promise<void> | void}
+     * @returns {Promise<void>}
      */
-    ngOnDestroy(): Promise<void> | void;
+    ngOnDestroy(): Promise<void>;
     /**
      * @description Handles the click event to trigger file selection.
      * @summary Simulates a click on the hidden file input element to open the file selection dialog.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@decaf-ts/for-angular",
-  "version": "0.0.62",
+  "version": "0.0.64",
   "author": "Tiago Venceslau and Contributors",
   "license": "MPL-2.0 OR AGPL-3.0",
   "repository": {