@futdevpro/fsm-dynamo 1.14.11 → 1.14.13

package/build/_modules/data-handler/_models/data-list-handler.control-model.d.ts

@@ -0,0 +1,111 @@
+import { BehaviorSubject, Observable } from 'rxjs';
+import { DyFM_DataListHandler_Settings } from './data-handler-settings.control-model';
+import { DyFM_DataHandler } from './data-handler.control-model';
+import { DyFM_Metadata } from '../../../_models/data-models/metadata.data-model';
+/**
+ * A specialized data handler for managing arrays of data items.
+ * Extends DyFM_DataHandler to provide additional functionality for handling lists of data.
+ *
+ * @template T_DataList - The type of the data list (must be an array of T_DataItem)
+ * @template T_DependencyData - The type of dependency data (defaults to any)
+ * @template T_DataLoadBy - The type used to identify how data should be loaded (defaults to string)
+ * @template T_DataItem - The type of individual items in the list (must extend DyFM_Metadata)
+ *
+ * @example
+ * ```typescript
+ * // Create a data list handler for user messages
+ * const messagesHandler = new DyFM_DataListHandler<UserMessage[]>({
+ *   get: async (userId: string): Promise<UserMessage[]> => {
+ *     return await userApiService.getUserMessages(userId, 0, 100);
+ *   }
+ * });
+ *
+ * // Access the data list
+ * const messages = messagesHandler.dataList;
+ *
+ * // Add a new message
+ * messagesHandler.addItem(newMessage);
+ *
+ * // Update an existing message
+ * messagesHandler.updateItem(updatedMessage);
+ *
+ * // Subscribe to changes
+ * messagesHandler.dataList$.subscribe(messages => {
+ *   console.log('Messages updated:', messages);
+ * });
+ * ```
+ */
+export declare class DyFM_DataListHandler<T_DataItem extends DyFM_Metadata, T_DependencyData extends DyFM_Metadata = any, T_DataLoadBy = string, T_UpdateItemBy = string> extends DyFM_DataHandler<T_DataItem[], T_DependencyData, T_DataLoadBy> {
+    protected readonly setItem: (item: T_DataItem, updateBy?: T_UpdateItemBy) => Promise<T_DataItem>;
+    protected readonly deleteItem: (id: string, updateBy?: T_UpdateItemBy) => Promise<void>;
+    /**
+     * BehaviorSubject that holds the current data list.
+     * Computed from the base data_BS BehaviorSubject, ensuring it always returns an array.
+     */
+    protected readonly dataList_BS: BehaviorSubject<T_DataItem[]>;
+    /**
+     * Observable that holds the current data list.
+     * Computed from the base data$ Observable, ensuring it always returns an array.
+     */
+    readonly dataList$: Observable<T_DataItem[]>;
+    /**
+     * BehaviorSubject that holds the currently active item.
+     */
+    readonly activeItem_BS: BehaviorSubject<T_DataItem>;
+    /**
+     * Observable that holds the currently active item.
+     */
+    readonly activeItem$: Observable<T_DataItem>;
+    /**
+     * Gets the current data list.
+     * @returns The current array of data items
+     */
+    get data(): T_DataItem[];
+    /**
+     * Gets the current data list.
+     * Alias for data getter.
+     * @returns The current array of data items
+     */
+    get dataList(): T_DataItem[];
+    /**
+     * Creates a new instance of DyFM_DataListHandler.
+     *
+     * @param set - Configuration settings for the data handler
+     * @param skipDependencyConnections - Optional flag to skip dependency connections during construction
+     */
+    constructor(set: DyFM_DataListHandler_Settings<T_DataItem, T_DependencyData, T_DataLoadBy, T_UpdateItemBy>, 
+    /** is in construct?
+     * so the dependent data handlers are not added here, but in the extended class */
+    skipDependencyConnections?: boolean);
+    reloadData(loadBy?: T_DataLoadBy): Promise<T_DataItem[]>;
+    clear(dontClearDependents?: boolean): void;
+    /**
+     * Adds a new item to the data list.
+     *
+     * @param item - The item to add to the list
+     * @param updateBy - Optional parameter for update tracking
+     * @param dontSendUpdate - Optional flag to prevent sending update notification
+     */
+    addItem(item: T_DataItem, updateBy?: T_UpdateItemBy, dontSendUpdate?: boolean): Promise<void>;
+    /**
+     * Removes an item from the data list.
+     * The item is identified by its _id property.
+     *
+     * @param id - The id of the item to remove from the list
+     * @param updateBy - Optional parameter for update tracking
+     * @param dontSendUpdate - Optional flag to prevent sending update notification
+     */
+    removeItem(id: string, updateBy?: T_UpdateItemBy, dontSendUpdate?: boolean): Promise<void>;
+    /**
+     * Updates an existing item in the data list.
+     * The item is identified by its _id property.
+     *
+     * @param item - The updated item
+     * @param updateBy - Optional parameter for update tracking
+     * @param dontSendUpdate - Optional flag to prevent sending update notification
+     * @throws Error if the item is not found in the list
+     */
+    updateItem(item: T_DataItem, updateBy?: T_UpdateItemBy, dontSendUpdate?: boolean): Promise<void>;
+    setActiveItem(item: T_DataItem): void;
+}
+//# sourceMappingURL=data-list-handler.control-model.d.ts.map

package/build/_modules/data-handler/_models/data-list-handler.control-model.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"data-list-handler.control-model.d.ts","sourceRoot":"","sources":["../../../../src/_modules/data-handler/_models/data-list-handler.control-model.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,UAAU,EAAE,MAAM,MAAM,CAAC;AAEnD,OAAO,EAAE,6BAA6B,EAAE,MAAM,uCAAuC,CAAC;AAEtF,OAAO,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAC;AAChE,OAAO,EAAE,aAAa,EAAE,MAAM,kDAAkD,CAAC;AAGjF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,qBAAa,oBAAoB,CAC/B,UAAU,SAAS,aAAa,EAChC,gBAAgB,SAAS,aAAa,GAAG,GAAG,EAC5C,YAAY,GAAG,MAAM,EACrB,cAAc,GAAG,MAAM,CACvB,SAAQ,gBAAgB,CAAC,UAAU,EAAE,EAAE,gBAAgB,EAAE,YAAY,CAAC;IAEtE,SAAS,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC,IAAI,EAAE,UAAU,EAAE,QAAQ,CAAC,EAAE,cAAc,KAAK,OAAO,CAAC,UAAU,CAAC,CAAC;IACjG,SAAS,CAAC,QAAQ,CAAC,UAAU,EAAE,CAAC,EAAE,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,cAAc,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAExF;;;OAGG;IACH,SAAS,CAAC,QAAQ,CAAC,WAAW,EAAE,eAAe,CAAC,UAAU,EAAE,CAAC,CAAC;IAE9D;;;OAGG;IACH,QAAQ,CAAC,SAAS,EAAE,UAAU,CAAC,UAAU,EAAE,CAAC,CAAC;IAE7C;;OAEG;IACH,QAAQ,CAAC,aAAa,EAAE,eAAe,CAAC,UAAU,CAAC,CAAC;IAEpD;;OAEG;IACH,QAAQ,CAAC,WAAW,EAAE,UAAU,CAAC,UAAU,CAAC,CAAC;IAE7C;;;OAGG;IACH,IAAa,IAAI,IAAI,UAAU,EAAE,CAEhC;IAED;;;;OAIG;IACH,IAAI,QAAQ,IAAI,UAAU,EAAE,CAE3B;IAED;;;;;OAKG;gBAED,GAAG,EAAE,6BAA6B,CAAC,UAAU,EAAE,gBAAgB,EAAE,YAAY,EAAE,cAAc,CAAC;IAC9F;sFACkF;IAClF,yBAAyB,CAAC,EAAE,OAAO;IAmDtB,UAAU,CAAC,MAAM,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC;IAS9D,KAAK,CAAC,mBAAmB,CAAC,EAAE,OAAO,GAAG,IAAI;IAKnD;;;;;;OAMG;IACG,OAAO,CAAC,IAAI,EAAE,UAAU,EAAE,QAAQ,CAAC,EAAE,cAAc,EAAE,cAAc,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAanG;;;;;;;OAOG;IACG,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,cAAc,EAAE,cAAc,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAiBhG;;;;;;;;OAQG;IACG,UAAU,CAAC,IAAI,EAAE,UAAU,EAAE,QAAQ,CAAC,EAAE,cAAc,EAAE,cAAc,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAsBtG,aAAa,CAAC,IAAI,EAAE,UAAU,GAAG,IAAI;CAGtC"}

package/build/_modules/data-handler/_models/data-list-handler.control-model.js

@@ -0,0 +1,217 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DyFM_DataListHandler = void 0;
+const rxjs_1 = require("rxjs");
+const data_handler_control_model_1 = require("./data-handler.control-model");
+const error_control_model_1 = require("../../../_models/control-models/error.control-model");
+/**
+ * A specialized data handler for managing arrays of data items.
+ * Extends DyFM_DataHandler to provide additional functionality for handling lists of data.
+ *
+ * @template T_DataList - The type of the data list (must be an array of T_DataItem)
+ * @template T_DependencyData - The type of dependency data (defaults to any)
+ * @template T_DataLoadBy - The type used to identify how data should be loaded (defaults to string)
+ * @template T_DataItem - The type of individual items in the list (must extend DyFM_Metadata)
+ *
+ * @example
+ * ```typescript
+ * // Create a data list handler for user messages
+ * const messagesHandler = new DyFM_DataListHandler<UserMessage[]>({
+ *   get: async (userId: string): Promise<UserMessage[]> => {
+ *     return await userApiService.getUserMessages(userId, 0, 100);
+ *   }
+ * });
+ *
+ * // Access the data list
+ * const messages = messagesHandler.dataList;
+ *
+ * // Add a new message
+ * messagesHandler.addItem(newMessage);
+ *
+ * // Update an existing message
+ * messagesHandler.updateItem(updatedMessage);
+ *
+ * // Subscribe to changes
+ * messagesHandler.dataList$.subscribe(messages => {
+ *   console.log('Messages updated:', messages);
+ * });
+ * ```
+ */
+class DyFM_DataListHandler extends data_handler_control_model_1.DyFM_DataHandler {
+    setItem;
+    deleteItem;
+    /**
+     * BehaviorSubject that holds the current data list.
+     * Computed from the base data_BS BehaviorSubject, ensuring it always returns an array.
+     */
+    dataList_BS;
+    /**
+     * Observable that holds the current data list.
+     * Computed from the base data$ Observable, ensuring it always returns an array.
+     */
+    dataList$;
+    /**
+     * BehaviorSubject that holds the currently active item.
+     */
+    activeItem_BS;
+    /**
+     * Observable that holds the currently active item.
+     */
+    activeItem$;
+    /**
+     * Gets the current data list.
+     * @returns The current array of data items
+     */
+    get data() {
+        return this.dataList_BS.value;
+    }
+    /**
+     * Gets the current data list.
+     * Alias for data getter.
+     * @returns The current array of data items
+     */
+    get dataList() {
+        return this.dataList_BS.value;
+    }
+    /**
+     * Creates a new instance of DyFM_DataListHandler.
+     *
+     * @param set - Configuration settings for the data handler
+     * @param skipDependencyConnections - Optional flag to skip dependency connections during construction
+     */
+    constructor(set, 
+    /** is in construct?
+     * so the dependent data handlers are not added here, but in the extended class */
+    skipDependencyConnections) {
+        super(set, skipDependencyConnections);
+        // Initialize dataList BehaviorSubject and Observable
+        this.dataList_BS = new rxjs_1.BehaviorSubject([]);
+        this.dataList$ = this.dataList_BS.asObservable();
+        // Initialize activeItem BehaviorSubject and Observable
+        this.activeItem_BS = new rxjs_1.BehaviorSubject(null);
+        this.activeItem$ = this.activeItem_BS.asObservable();
+        // Subscribe to data changes to update dataList
+        this.data$.subscribe(data => {
+            const dataList = Array.isArray(data) ? data : [];
+            this.dataList_BS.next(dataList);
+        });
+        if (set.setItem) {
+            this.setItem = set.setItem;
+        }
+        if (set.deleteItem) {
+            this.deleteItem = set.deleteItem;
+        }
+        this.getPostProcesses.push((data) => {
+            // check if data is an array
+            if (!Array.isArray(data)) {
+                console.error(`DYNAMO DataListHandler (${this.name}) ERROR: ` +
+                    `\nData is not an array!:` +
+                    '\n\n', data);
+                throw new Error(`Data is not an array! (${this.name})`);
+            }
+            return data;
+        });
+        if (!skipDependencyConnections) {
+            if (set.dependencyDataHandler) {
+                this.addDependencyDataHandler(set.dependencyDataHandler);
+            }
+            if (set.dependentDataHandlers) {
+                this.addDependentDataHandlers(set.dependentDataHandlers, true);
+            }
+        }
+    }
+    async reloadData(loadBy) {
+        const setActiveItem = !this.activeItem_BS.value || this.activeItem_BS.value?._id !== loadBy;
+        const dataList = await super.reloadData(loadBy);
+        if (setActiveItem && dataList.length > 0) {
+            this.setActiveItem(dataList[0]);
+        }
+        return dataList;
+    }
+    clear(dontClearDependents) {
+        super.clear(dontClearDependents);
+        this.activeItem_BS.next(null);
+    }
+    /**
+     * Adds a new item to the data list.
+     *
+     * @param item - The item to add to the list
+     * @param updateBy - Optional parameter for update tracking
+     * @param dontSendUpdate - Optional flag to prevent sending update notification
+     */
+    async addItem(item, updateBy, dontSendUpdate) {
+        const currentData = this.data;
+        currentData.push(item);
+        if (this.setItem && !dontSendUpdate) {
+            await this.setItem(item, updateBy);
+            // dont send update because we already sent it to the setItem function
+            await this.updateData(this.dataList_BS.value, true);
+        }
+        else {
+            await this.updateData(this.dataList_BS.value, dontSendUpdate);
+        }
+        this.activeItem_BS.next(item);
+    }
+    /**
+     * Removes an item from the data list.
+     * The item is identified by its _id property.
+     *
+     * @param id - The id of the item to remove from the list
+     * @param updateBy - Optional parameter for update tracking
+     * @param dontSendUpdate - Optional flag to prevent sending update notification
+     */
+    async removeItem(id, updateBy, dontSendUpdate) {
+        const currentData = this.data;
+        const index = currentData.findIndex(i => i._id === id);
+        if (index !== -1) {
+            currentData.splice(index, 1);
+            if (this.deleteItem) {
+                await this.deleteItem(id, updateBy);
+                await this.updateData(this.dataList_BS.value, true);
+            }
+            else {
+                await this.updateData(this.dataList_BS.value, dontSendUpdate);
+            }
+        }
+        if (this.activeItem_BS.value?._id === id) {
+            this.activeItem_BS.next(null);
+        }
+    }
+    /**
+     * Updates an existing item in the data list.
+     * The item is identified by its _id property.
+     *
+     * @param item - The updated item
+     * @param updateBy - Optional parameter for update tracking
+     * @param dontSendUpdate - Optional flag to prevent sending update notification
+     * @throws Error if the item is not found in the list
+     */
+    async updateItem(item, updateBy, dontSendUpdate) {
+        const currentData = this.data;
+        const index = currentData.findIndex(i => i._id === item._id);
+        if (index !== -1) {
+            currentData[index] = item;
+            if (this.setItem) {
+                await this.setItem(item, updateBy);
+                await this.updateData(this.dataList_BS.value, true);
+            }
+            else {
+                await this.updateData(this.dataList_BS.value, dontSendUpdate);
+            }
+        }
+        else {
+            throw new error_control_model_1.DyFM_Error({
+                error: new Error(`Item not found! (${this.name})`),
+                errorCode: 'DyFM-DLH-UI1',
+                additionalContent: {
+                    item: item,
+                },
+            });
+        }
+    }
+    setActiveItem(item) {
+        this.activeItem_BS.next(item);
+    }
+}
+exports.DyFM_DataListHandler = DyFM_DataListHandler;
+//# sourceMappingURL=data-list-handler.control-model.js.map

package/build/_modules/data-handler/_models/data-list-handler.control-model.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"data-list-handler.control-model.js","sourceRoot":"","sources":["../../../../src/_modules/data-handler/_models/data-list-handler.control-model.ts"],"names":[],"mappings":";;;AAAA,+BAAmD;AAInD,6EAAgE;AAEhE,6FAAiF;AAEjF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,MAAa,oBAKX,SAAQ,6CAA8D;IAEnD,OAAO,CAAuE;IAC9E,UAAU,CAA2D;IAExF;;;OAGG;IACgB,WAAW,CAAgC;IAE9D;;;OAGG;IACM,SAAS,CAA2B;IAE7C;;OAEG;IACM,aAAa,CAA8B;IAEpD;;OAEG;IACM,WAAW,CAAyB;IAE7C;;;OAGG;IACH,IAAa,IAAI;QACf,OAAO,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC;IAChC,CAAC;IAED;;;;OAIG;IACH,IAAI,QAAQ;QACV,OAAO,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC;IAChC,CAAC;IAED;;;;;OAKG;IACH,YACE,GAA8F;IAC9F;sFACkF;IAClF,yBAAmC;QAEnC,KAAK,CAAC,GAAG,EAAE,yBAAyB,CAAC,CAAC;QAEtC,qDAAqD;QACrD,IAAI,CAAC,WAAW,GAAG,IAAI,sBAAe,CAAe,EAAE,CAAC,CAAC;QACzD,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,WAAW,CAAC,YAAY,EAAE,CAAC;QAEjD,uDAAuD;QACvD,IAAI,CAAC,aAAa,GAAG,IAAI,sBAAe,CAAa,IAAI,CAAC,CAAC;QAC3D,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,aAAa,CAAC,YAAY,EAAE,CAAC;QAErD,+CAA+C;QAC/C,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE;YAC1B,MAAM,QAAQ,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;YACjD,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAClC,CAAC,CAAC,CAAC;QAEH,IAAI,GAAG,CAAC,OAAO,EAAE,CAAC;YAChB,IAAI,CAAC,OAAO,GAAG,GAAG,CAAC,OAAO,CAAC;QAC7B,CAAC;QAED,IAAI,GAAG,CAAC,UAAU,EAAE,CAAC;YACnB,IAAI,CAAC,UAAU,GAAG,GAAG,CAAC,UAAU,CAAC;QACnC,CAAC;QAED,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC,IAAkB,EAAE,EAAE;YAChD,4BAA4B;YAC5B,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAG,CAAC;gBAC1B,OAAO,CAAC,KAAK,CACX,2BAA2B,IAAI,CAAC,IAAI,WAAW;oBAC/C,0BAA0B;oBAC1B,MAAM,EAAE,IAAI,CACb,CAAC;gBACF,MAAM,IAAI,KAAK,CAAC,0BAA0B,IAAI,CAAC,IAAI,GAAG,CAAC,CAAC;YAC1D,CAAC;YAED,OAAO,IAAI,CAAC;QACd,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,yBAAyB,EAAE,CAAC;YAC/B,IAAI,GAAG,CAAC,qBAAqB,EAAE,CAAC;gBAC9B,IAAI,CAAC,wBAAwB,CAAC,GAAG,CAAC,qBAAqB,CAAC,CAAC;YAC3D,CAAC;YAED,IAAI,GAAG,CAAC,qBAAqB,EAAE,CAAC;gBAC9B,IAAI,CAAC,wBAAwB,CAAC,GAAG,CAAC,qBAAqB,EAAE,IAAI,CAAC,CAAC;YACjE,CAAC;QACH,CAAC;IACH,CAAC;IAEQ,KAAK,CAAC,UAAU,CAAC,MAAqB;QAC7C,MAAM,aAAa,GAAG,CAAC,IAAI,CAAC,aAAa,CAAC,KAAK,IAAI,IAAI,CAAC,aAAa,CAAC,KAAK,EAAE,GAAG,KAAK,MAAM,CAAC;QAC5F,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;QAChD,IAAI,aAAa,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACzC,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;QAClC,CAAC;QACD,OAAO,QAAQ,CAAC;IAClB,CAAC;IAEQ,KAAK,CAAC,mBAA6B;QAC1C,KAAK,CAAC,KAAK,CAAC,mBAAmB,CAAC,CAAC;QACjC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAChC,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,OAAO,CAAC,IAAgB,EAAE,QAAyB,EAAE,cAAwB;QACjF,MAAM,WAAW,GAAG,IAAI,CAAC,IAAI,CAAC;QAC9B,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACvB,IAAI,IAAI,CAAC,OAAO,IAAI,CAAC,cAAc,EAAE,CAAC;YACpC,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;YACnC,sEAAsE;YACtE,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,WAAW,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;QACtD,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,WAAW,CAAC,KAAK,EAAE,cAAc,CAAC,CAAC;QAChE,CAAC;QACD,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAChC,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,UAAU,CAAC,EAAU,EAAE,QAAyB,EAAE,cAAwB;QAC9E,MAAM,WAAW,GAAG,IAAI,CAAC,IAAI,CAAC;QAC9B,MAAM,KAAK,GAAG,WAAW,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,KAAK,EAAE,CAAC,CAAC;QACvD,IAAI,KAAK,KAAK,CAAC,CAAC,EAAE,CAAC;YACjB,WAAW,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;YAC7B,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;gBACpB,MAAM,IAAI,CAAC,UAAU,CAAC,EAAE,EAAE,QAAQ,CAAC,CAAC;gBACpC,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,WAAW,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;YACtD,CAAC;iBAAM,CAAC;gBACN,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,WAAW,CAAC,KAAK,EAAE,cAAc,CAAC,CAAC;YAChE,CAAC;QACH,CAAC;QACD,IAAI,IAAI,CAAC,aAAa,CAAC,KAAK,EAAE,GAAG,KAAK,EAAE,EAAE,CAAC;YACzC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAChC,CAAC;IACH,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,UAAU,CAAC,IAAgB,EAAE,QAAyB,EAAE,cAAwB;QACpF,MAAM,WAAW,GAAG,IAAI,CAAC,IAAI,CAAC;QAC9B,MAAM,KAAK,GAAG,WAAW,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,KAAK,IAAI,CAAC,GAAG,CAAC,CAAC;QAC7D,IAAI,KAAK,KAAK,CAAC,CAAC,EAAE,CAAC;YACjB,WAAW,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC;YAC1B,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;gBACjB,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;gBACnC,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,WAAW,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;YACtD,CAAC;iBAAM,CAAC;gBACN,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,WAAW,CAAC,KAAK,EAAE,cAAc,CAAC,CAAC;YAChE,CAAC;QACH,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,gCAAU,CAAC;gBACnB,KAAK,EAAE,IAAI,KAAK,CAAC,oBAAoB,IAAI,CAAC,IAAI,GAAG,CAAC;gBAClD,SAAS,EAAE,cAAc;gBACzB,iBAAiB,EAAE;oBACjB,IAAI,EAAE,IAAI;iBACX;aACF,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED,aAAa,CAAC,IAAgB;QAC5B,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAChC,CAAC;CACF;AA3MD,oDA2MC"}

package/build/_modules/data-handler/_models/data-search-handler.control-model.d.ts

@@ -0,0 +1,172 @@
+import { Subject } from 'rxjs';
+import { DyFM_DataSearchHandler_Settings } from './data-handler-settings.control-model';
+import { DyFM_DataListHandler } from './data-list-handler.control-model';
+import { DyFM_Metadata } from '../../../_models/data-models/metadata.data-model';
+import { DyFM_SearchQuery } from '../../../_models/interfaces/search-query.interface';
+import { DyFM_SearchResult } from '../../../_models/interfaces/search-result.interface';
+import { DyFM_DSFilter } from '../../../_models/types/ds-filter.type';
+import { DyFM_DSSort } from '../../../_models/types/ds-sort.type';
+interface SearchCache<T> {
+    page: number;
+    loadPageSize: number;
+    data: T[];
+}
+/**
+ * A specialized data handler for managing searchable data with pagination and caching.
+ * Extends DyFM_DataListHandler to provide additional functionality for handling search results.
+ *
+ * @template T_Data - The type of data items in the search results
+ * @template T_DataLoadBy - The type of search query (must extend DyFM_SearchQuery)
+ * @template T_Result - The type of search result (must extend DyFM_SearchResult)
+ * @template T_DependencyData - The type of dependency data (defaults to any)
+ *
+ * @example
+ * ```typescript
+ * // Create a search handler for flow runs
+ * const flowRunsHandler = new DyFM_DataSearchHandler<FlowRun_Preview>({
+ *   name: 'myRuns',
+ *   get: async (query?: DyFM_SearchQuery<FlowRun>): Promise<DyFM_SearchResult<FlowRun_Preview>> => {
+ *     return await flowRunService.searchFlowRuns(query);
+ *   },
+ *   defaultQuery: {
+ *     filterBy: { userId: currentUserId },
+ *     pageSize: 20
+ *   },
+ *   queryUpdateDebounceTime: 500
+ * });
+ *
+ * // Update search query
+ * flowRunsHandler.updateQuery({
+ *   page: 0,
+ *   pageSize: 10,
+ *   filterBy: { status: 'completed' }
+ * });
+ *
+ * // Access search results
+ * const runs = flowRunsHandler.dataList;
+ *
+ * // Get total items count
+ * const totalItems = flowRunsHandler.totalItems;
+ * ```
+ */
+export declare class DyFM_DataSearchHandler<T_Data, T_DataLoadBy extends DyFM_SearchQuery<any> = DyFM_SearchQuery<T_Data>, T_Result extends DyFM_SearchResult<any> = DyFM_SearchResult<T_Data>, T_DependencyData extends DyFM_Metadata = any> extends DyFM_DataListHandler<T_Data, T_DependencyData, T_DataLoadBy> {
+    /**
+     * Subject for handling fresh search queries with debouncing.
+     * Used internally to manage query updates.
+     */
+    protected readonly _freshQuery_S: Subject<T_DataLoadBy>;
+    /**
+     * Cache of search results for different pages.
+     * Helps optimize performance by storing previously loaded results.
+     */
+    protected cache: SearchCache<T_Data>[];
+    /**
+     * Override of the get method to handle search queries.
+     * Must be implemented to fetch search results from the data source.
+     */
+    /**
+     * Maximum number of cached pages to keep in memory.
+     * Default is 5 pages.
+     */
+    protected cacheSize: number;
+    /**
+     * Default number of items per page.
+     * Used when no pageSize is specified in the query.
+     */
+    protected defaultPageSize: number;
+    /**
+     * Default search query to use when no query is provided.
+     * Can include default filters, sorting, and pagination settings.
+     */
+    protected get defaultQuery(): T_DataLoadBy;
+    protected _defaultQuery?: T_DataLoadBy;
+    /**
+     * Total number of items available in the search results.
+     * Updated after each successful search.
+     */
+    protected totalItems: number;
+    /**
+     * Debounce time in milliseconds for query updates.
+     * Helps prevent too frequent API calls when query changes rapidly.
+     */
+    protected queryUpdateDebounceTime: number;
+    /**
+     * Whether to perform initial search when handler is created.
+     * If true, will use defaultQuery for initial search.
+     */
+    protected searchOnInit: boolean;
+    /**
+     * Creates a new instance of DyFM_DataSearchHandler.
+     *
+     * @param set - Configuration settings for the search handler
+     */
+    constructor(set: DyFM_DataSearchHandler_Settings<T_Data, T_DataLoadBy, T_DependencyData>);
+    /**
+     * Updates the search query and triggers a new search.
+     * The search will be debounced according to queryUpdateDebounceTime.
+     *
+     * @param query - The new search query to use
+     */
+    updateQuery(query: T_DataLoadBy): void;
+    /**
+     * Override to prevent adding dependent data handlers.
+     * Search handlers cannot have dependencies.
+     *
+     * @throws Error - Always throws as search handlers cannot have dependencies
+     */
+    addDependentDataHandlers(dependentDataHandlers: any[]): void;
+    /**
+     * Filters the current search query
+     *
+     * @param filterBy - The filter to apply to the current search query
+     */
+    filter(filterBy: DyFM_DSFilter<T_Data>): void;
+    /**
+     * Adds a filter to the current search query
+     *
+     * @param filterBy - The filter to add to the current search query
+     */
+    addFiler(filterBy: DyFM_DSFilter<T_Data>): void;
+    /**
+     * Removes a filter from the current search query
+     *
+     * @param keys - The keys of the filter to remove from the current search query
+     */
+    removeFilter(keys: (keyof T_Data)[]): void;
+    clearFilters(): void;
+    /**
+     * Sorts the current search query
+     *
+     * @param sortBy - The sort to apply to the current search query
+     */
+    sort(sortBy: DyFM_DSSort[]): void;
+    /**
+     * Adds a sort to the current search query
+     *
+     * @param sortBy - The sort to add to the current search query
+     */
+    addSort(sortBy: DyFM_DSSort[]): void;
+    /**
+     * Removes a sort from the current search query
+     *
+     * @param keys - The keys of the sort to remove from the current search query
+     */
+    removeSort(keys: string[]): void;
+    clearSorts(): void;
+    /**
+     * Sets the page of the current search query
+     *
+     * @param page - The page to set to the current search query
+     */
+    page(page: number, pageSize?: number): void;
+    /**
+     * Sets the page size of the current search query
+     *
+     * @param pageSize - The page size to set to the current search query
+     */
+    pageSize(pageSize: number): void;
+    resetPage(): void;
+    resetQuery(): void;
+}
+export {};
+//# sourceMappingURL=data-search-handler.control-model.d.ts.map

package/build/_modules/data-handler/_models/data-search-handler.control-model.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"data-search-handler.control-model.d.ts","sourceRoot":"","sources":["../../../../src/_modules/data-handler/_models/data-search-handler.control-model.ts"],"names":[],"mappings":"AAAA,OAAO,EAAgB,OAAO,EAAE,MAAM,MAAM,CAAC;AAE7C,OAAO,EAAE,+BAA+B,EAAE,MAAM,uCAAuC,CAAC;AAExF,OAAO,EAAE,oBAAoB,EAAE,MAAM,mCAAmC,CAAC;AAEzE,OAAO,EAAE,aAAa,EAAE,MAAM,kDAAkD,CAAC;AACjF,OAAO,EAAE,gBAAgB,EAAE,MAAM,oDAAoD,CAAC;AACtF,OAAO,EAAE,iBAAiB,EAAE,MAAM,qDAAqD,CAAC;AACxF,OAAO,EAAE,aAAa,EAAE,MAAM,uCAAuC,CAAC;AACtE,OAAO,EAAE,WAAW,EAAuB,MAAM,qCAAqC,CAAC;AAEvF,UAAU,WAAW,CAAC,CAAC;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,YAAY,EAAE,MAAM,CAAC;IACrB,IAAI,EAAE,CAAC,EAAE,CAAC;CACX;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AACH,qBAAa,sBAAsB,CACjC,MAAM,EACN,YAAY,SAAS,gBAAgB,CAAC,GAAG,CAAC,GAAG,gBAAgB,CAAC,MAAM,CAAC,EACrE,QAAQ,SAAS,iBAAiB,CAAC,GAAG,CAAC,GAAG,iBAAiB,CAAC,MAAM,CAAC,EACnE,gBAAgB,SAAS,aAAa,GAAG,GAAG,CAC5C,SAAQ,oBAAoB,CAAC,MAAM,EAAE,gBAAgB,EAAE,YAAY,CAAC;IAEpE;;;OAGG;IACH,SAAS,CAAC,QAAQ,CAAC,aAAa,wBAA+B;IAE/D;;;OAGG;IACH,SAAS,CAAC,KAAK,EAAE,WAAW,CAAC,MAAM,CAAC,EAAE,CAAM;IAE5C;;;OAGG;IAIH;;;OAGG;IACH,SAAS,CAAC,SAAS,EAAE,MAAM,CAAK;IAEhC;;;OAGG;IACH,SAAS,CAAC,eAAe,EAAE,MAAM,CAAM;IAEvC;;;OAGG;IACH,SAAS,KAAK,YAAY,IAAI,YAAY,CAEzC;IAED,SAAS,CAAC,aAAa,CAAC,EAAE,YAAY,CAAC;IAEvC;;;OAGG;IACH,SAAS,CAAC,UAAU,EAAE,MAAM,CAAC;IAE7B;;;OAGG;IACH,SAAS,CAAC,uBAAuB,EAAE,MAAM,CAAO;IAEhD;;;OAGG;IACH,SAAS,CAAC,YAAY,EAAE,OAAO,CAAQ;IAEvC;;;;OAIG;gBAED,GAAG,EAAE,+BAA+B,CAAC,MAAM,EAAE,YAAY,EAAE,gBAAgB,CAAC;IA8F9E;;;;;OAKG;IACH,WAAW,CAAC,KAAK,EAAE,YAAY,GAAG,IAAI;IAItC;;;;;OAKG;IACM,wBAAwB,CAAC,qBAAqB,EAAE,GAAG,EAAE,GAAG,IAAI;IAIrE;;;;OAIG;IACH,MAAM,CAAC,QAAQ,EAAE,aAAa,CAAC,MAAM,CAAC,GAAG,IAAI;IAQ7C;;;;OAIG;IACH,QAAQ,CAAC,QAAQ,EAAE,aAAa,CAAC,MAAM,CAAC,GAAG,IAAI;IAQ/C;;;;OAIG;IACH,YAAY,CAAC,IAAI,EAAE,CAAC,MAAM,MAAM,CAAC,EAAE,GAAG,IAAI;IAW1C,YAAY,IAAI,IAAI;IAQpB;;;;OAIG;IACH,IAAI,CAAC,MAAM,EAAE,WAAW,EAAE,GAAG,IAAI;IAQjC;;;;OAIG;IACH,OAAO,CAAC,MAAM,EAAE,WAAW,EAAE,GAAG,IAAI;IAQpC;;;;OAIG;IACH,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,IAAI;IAQhC,UAAU,IAAI,IAAI;IAQlB;;;;OAIG;IACH,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI;IAW3C;;;;OAIG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI;IAQhC,SAAS,IAAI,IAAI;IASjB,UAAU,IAAI,IAAI;CAYnB"}