@futdevpro/fsm-dynamo 1.15.18 → 1.15.21

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

@@ -1,390 +1,390 @@
-import { debounceTime, Subject } from 'rxjs';
-
-import { DyFM_DataSearchHandler_Settings } from './data-handler-settings.control-model';
-
-import { DyFM_DataListHandler } from './data-list-handler.control-model';
-import { DyFM_Object } from '../../../_collections/utils/object.util';
-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, DyFM_DSPropertySort } 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 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 = new 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.
-   */
-  // this is redundant, because the base class has the get method and it uses Generic type
-  /* override get: (query?: T_DataLoadBy) => Promise<T_Result>; */
-
-  /**
-   * Maximum number of cached pages to keep in memory.
-   * Default is 5 pages.
-   */
-  protected cacheSize: number = 5;
-
-  /**
-   * Default number of items per page.
-   * Used when no pageSize is specified in the query.
-   */
-  protected defaultPageSize: number = 10;
-
-  /**
-   * Default search query to use when no query is provided.
-   * Can include default filters, sorting, and pagination settings.
-   */
-  protected get defaultQuery(): T_DataLoadBy {
-    return DyFM_Object.clone(this._defaultQuery);
-  }
-
-  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 = 500;
-
-  /**
-   * Whether to perform initial search when handler is created.
-   * If true, will use defaultQuery for initial search.
-   */
-  protected searchOnInit: boolean = true;
-
-  /**
-   * 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>
-  ) {
-    super({
-      ...set,
-      noId: true,
-    });
-
-    if (set.queryUpdateDebounceTime) {
-      this.queryUpdateDebounceTime = set.queryUpdateDebounceTime;
-    }
-
-    if (set.defaultQuery) {
-      this._defaultQuery = set.defaultQuery;
-    }
-
-    // 3
-    // Add post-processing for search results
-    this.getPostProcesses.unshift(
-      (searchResult: T_Result, loadedBy: T_DataLoadBy): T_Data[] => {
-        console.warn('WTF DyFM_Search_DataHandler getPostProcess', searchResult, this.lastLoadedBy);
-
-        this.cache = this.cache.filter((c) => c.loadPageSize !== this.lastLoadedBy?.pageSize);
-
-        if (this.cache.length >= this.cacheSize) {
-          this.cache.shift();
-        }
-
-        this.cache.push({
-          page: this.lastLoadedBy?.page,
-          loadPageSize: this.lastLoadedBy?.pageSize,
-          data: searchResult.results,
-        });
-
-        this.totalItems = searchResult.totalItems;
-
-        return searchResult.results;
-      }
-    );
-
-    // 2
-    // Set up query update handling with debouncing
-    this._freshQuery_S.pipe(
-      debounceTime(this.queryUpdateDebounceTime),        
-    ).subscribe((query: T_DataLoadBy) => {
-      console.warn('asd', query, this.lastLoadedBy);
-
-      if (!query) {
-        if (!this._defaultQuery) {
-          this.reloadData();
-          return;
-        }
-
-        query = this.defaultQuery;
-      }
-
-      if (!query.page) {
-        query.page = 0;
-      }
-
-      if (!query.pageSize) {
-        query.pageSize = this.defaultPageSize;
-      }
-
-      if (this._defaultQuery?.filterBy) {
-        if (!query.filterBy) {
-          query.filterBy = {};
-        }
-
-        for (const key in this._defaultQuery.filterBy) {
-          if (!query.filterBy[key] && query.filterBy[key] !== null) {
-            query.filterBy[key] = this._defaultQuery.filterBy[key];
-          }
-        }
-      }
-
-      if (this._defaultQuery?.sortBy) {
-        if (!query.sortBy) {
-          query.sortBy = [];
-        }
-
-        if (!query.sortBy.length) {
-          query.sortBy = DyFM_Object.clone(this._defaultQuery.sortBy);
-        }
-      }
-
-      this.reloadData(query);
-    });
-
-    if (this.searchOnInit) {
-      this._freshQuery_S.next(this.defaultQuery);
-    }
-  }
-
-  // 1
-  /**
-   * 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 {
-    this._freshQuery_S.next(query);
-  }
-
-  /**
-   * Override to prevent adding dependent data handlers.
-   * Search handlers cannot have dependencies.
-   * 
-   * @throws Error - Always throws as search handlers cannot have dependencies
-   */
-  override addDependentDataHandlers(dependentDataHandlers: any[]): void {
-    throw new Error('Cannot add dependent data handlers to a search data handler');
-  }
-
-  /**
-   * Filters the current search query
-   * 
-   * @param filterBy - The filter to apply to the current search query 
-   */
-  filter(filterBy: DyFM_DSFilter<T_Data>): void {
-    const query = this.lastLoadedBy ?? this.defaultQuery;
-    if (query) {
-      query.filterBy = filterBy;
-      this.reloadData(query);
-    }
-  }
-
-  /**
-   * 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 {
-    const query = this.lastLoadedBy ?? this.defaultQuery;
-    if (query) {
-      Object.assign(query.filterBy, filterBy);
-      this.reloadData(query);
-    }
-  }
-
-  /**
-   * 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 {
-    const query = this.lastLoadedBy ?? this.defaultQuery;
-    if (query) {
-      keys.forEach((key) => {
-        delete query.filterBy[key];
-      });
-      
-      this.reloadData(query);
-    }
-  }
-
-  clearFilters(): void {
-    const query = this.lastLoadedBy ?? this.defaultQuery;
-    if (query) {
-      query.filterBy = {};
-      this.reloadData(query);
-    }
-  }
-
-  /**
-   * Sorts the current search query
-   * 
-   * @param sortBy - The sort to apply to the current search query
-   */
-  sort(sortBy: DyFM_DSSort[]): void {
-    const query = this.lastLoadedBy ?? this.defaultQuery;
-    if (query) {
-      query.sortBy = sortBy;
-      this.reloadData(query);
-    }
-  }
-
-  /**
-   * Adds a sort to the current search query
-   * 
-   * @param sortBy - The sort to add to the current search query
-   */
-  addSort(sortBy: DyFM_DSSort[]): void {
-    const query = this.lastLoadedBy ?? this.defaultQuery;
-    if (query) {
-      query.sortBy.push(...sortBy);
-      this.reloadData(query);
-    }
-  }
-
-  /**
-   * 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 {
-    const query = this.lastLoadedBy ?? this.defaultQuery;
-    if (query) {
-      query.sortBy = query.sortBy.filter((sort) => !keys.includes((sort as DyFM_DSPropertySort).key));
-      this.reloadData(query);
-    }
-  }
-
-  clearSorts(): void {
-    const query = this.lastLoadedBy ?? this.defaultQuery;
-    if (query) {
-      query.sortBy = [];
-      this.reloadData(query);
-    }
-  }
-
-  /**
-   * 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 {
-    const query = this.lastLoadedBy ?? this.defaultQuery;
-    if (query) {
-      query.page = page;
-      if (pageSize) {
-        query.pageSize = pageSize;
-      }
-      this.reloadData(query);
-    }
-  }
-
-  /**
-   * 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 {
-    const query = this.lastLoadedBy ?? this.defaultQuery;
-    if (query) {
-      query.pageSize = pageSize;
-      this.reloadData(query);
-    }
-  }
-
-  resetPage(): void {
-    const query = this.lastLoadedBy ?? this.defaultQuery;
-    if (query) {
-      query.page = 0;
-      query.pageSize = this.defaultPageSize;
-      this.reloadData(query);
-    }
-  }
-
-  resetQuery(): void {
-    const query = this.defaultQuery;
-    if (query) {
-      this.reloadData(query);
-    } else {
-      query.filterBy = {};
-      query.sortBy = [];
-      query.page = 0;
-      query.pageSize = this.defaultPageSize;
-      this.reloadData(query);
-    }
-  }
-}
+import { debounceTime, Subject } from 'rxjs';
+
+import { DyFM_DataSearchHandler_Settings } from './data-handler-settings.control-model';
+
+import { DyFM_DataListHandler } from './data-list-handler.control-model';
+import { DyFM_Object } from '../../../_collections/utils/object.util';
+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, DyFM_DSPropertySort } 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 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 = new 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.
+   */
+  // this is redundant, because the base class has the get method and it uses Generic type
+  /* override get: (query?: T_DataLoadBy) => Promise<T_Result>; */
+
+  /**
+   * Maximum number of cached pages to keep in memory.
+   * Default is 5 pages.
+   */
+  protected cacheSize: number = 5;
+
+  /**
+   * Default number of items per page.
+   * Used when no pageSize is specified in the query.
+   */
+  protected defaultPageSize: number = 10;
+
+  /**
+   * Default search query to use when no query is provided.
+   * Can include default filters, sorting, and pagination settings.
+   */
+  protected get defaultQuery(): T_DataLoadBy {
+    return DyFM_Object.clone(this._defaultQuery);
+  }
+
+  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 = 500;
+
+  /**
+   * Whether to perform initial search when handler is created.
+   * If true, will use defaultQuery for initial search.
+   */
+  protected searchOnInit: boolean = true;
+
+  /**
+   * 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>
+  ) {
+    super({
+      ...set,
+      noId: true,
+    });
+
+    if (set.queryUpdateDebounceTime) {
+      this.queryUpdateDebounceTime = set.queryUpdateDebounceTime;
+    }
+
+    if (set.defaultQuery) {
+      this._defaultQuery = set.defaultQuery;
+    }
+
+    // 3
+    // Add post-processing for search results
+    this.getPostProcesses.unshift(
+      (searchResult: T_Result, loadedBy: T_DataLoadBy): T_Data[] => {
+        console.warn('WTF DyFM_Search_DataHandler getPostProcess', searchResult, this.lastLoadedBy);
+
+        this.cache = this.cache.filter((c) => c.loadPageSize !== this.lastLoadedBy?.pageSize);
+
+        if (this.cache.length >= this.cacheSize) {
+          this.cache.shift();
+        }
+
+        this.cache.push({
+          page: this.lastLoadedBy?.page,
+          loadPageSize: this.lastLoadedBy?.pageSize,
+          data: searchResult.results,
+        });
+
+        this.totalItems = searchResult.totalItems;
+
+        return searchResult.results;
+      }
+    );
+
+    // 2
+    // Set up query update handling with debouncing
+    this._freshQuery_S.pipe(
+      debounceTime(this.queryUpdateDebounceTime),        
+    ).subscribe((query: T_DataLoadBy) => {
+      console.warn('asd', query, this.lastLoadedBy);
+
+      if (!query) {
+        if (!this._defaultQuery) {
+          this.reloadData();
+          return;
+        }
+
+        query = this.defaultQuery;
+      }
+
+      if (!query.page) {
+        query.page = 0;
+      }
+
+      if (!query.pageSize) {
+        query.pageSize = this.defaultPageSize;
+      }
+
+      if (this._defaultQuery?.filterBy) {
+        if (!query.filterBy) {
+          query.filterBy = {};
+        }
+
+        for (const key in this._defaultQuery.filterBy) {
+          if (!query.filterBy[key] && query.filterBy[key] !== null) {
+            query.filterBy[key] = this._defaultQuery.filterBy[key];
+          }
+        }
+      }
+
+      if (this._defaultQuery?.sortBy) {
+        if (!query.sortBy) {
+          query.sortBy = [];
+        }
+
+        if (!query.sortBy.length) {
+          query.sortBy = DyFM_Object.clone(this._defaultQuery.sortBy);
+        }
+      }
+
+      this.reloadData(query);
+    });
+
+    if (this.searchOnInit) {
+      this._freshQuery_S.next(this.defaultQuery);
+    }
+  }
+
+  // 1
+  /**
+   * 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 {
+    this._freshQuery_S.next(query);
+  }
+
+  /**
+   * Override to prevent adding dependent data handlers.
+   * Search handlers cannot have dependencies.
+   * 
+   * @throws Error - Always throws as search handlers cannot have dependencies
+   */
+  override addDependentDataHandlers(dependentDataHandlers: any[]): void {
+    throw new Error('Cannot add dependent data handlers to a search data handler');
+  }
+
+  /**
+   * Filters the current search query
+   * 
+   * @param filterBy - The filter to apply to the current search query 
+   */
+  filter(filterBy: DyFM_DSFilter<T_Data>): void {
+    const query = this.lastLoadedBy ?? this.defaultQuery;
+    if (query) {
+      query.filterBy = filterBy;
+      this.reloadData(query);
+    }
+  }
+
+  /**
+   * 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 {
+    const query = this.lastLoadedBy ?? this.defaultQuery;
+    if (query) {
+      Object.assign(query.filterBy, filterBy);
+      this.reloadData(query);
+    }
+  }
+
+  /**
+   * 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 {
+    const query = this.lastLoadedBy ?? this.defaultQuery;
+    if (query) {
+      keys.forEach((key) => {
+        delete query.filterBy[key];
+      });
+      
+      this.reloadData(query);
+    }
+  }
+
+  clearFilters(): void {
+    const query = this.lastLoadedBy ?? this.defaultQuery;
+    if (query) {
+      query.filterBy = {};
+      this.reloadData(query);
+    }
+  }
+
+  /**
+   * Sorts the current search query
+   * 
+   * @param sortBy - The sort to apply to the current search query
+   */
+  sort(sortBy: DyFM_DSSort[]): void {
+    const query = this.lastLoadedBy ?? this.defaultQuery;
+    if (query) {
+      query.sortBy = sortBy;
+      this.reloadData(query);
+    }
+  }
+
+  /**
+   * Adds a sort to the current search query
+   * 
+   * @param sortBy - The sort to add to the current search query
+   */
+  addSort(sortBy: DyFM_DSSort[]): void {
+    const query = this.lastLoadedBy ?? this.defaultQuery;
+    if (query) {
+      query.sortBy.push(...sortBy);
+      this.reloadData(query);
+    }
+  }
+
+  /**
+   * 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 {
+    const query = this.lastLoadedBy ?? this.defaultQuery;
+    if (query) {
+      query.sortBy = query.sortBy.filter((sort) => !keys.includes((sort as DyFM_DSPropertySort).key));
+      this.reloadData(query);
+    }
+  }
+
+  clearSorts(): void {
+    const query = this.lastLoadedBy ?? this.defaultQuery;
+    if (query) {
+      query.sortBy = [];
+      this.reloadData(query);
+    }
+  }
+
+  /**
+   * 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 {
+    const query = this.lastLoadedBy ?? this.defaultQuery;
+    if (query) {
+      query.page = page;
+      if (pageSize) {
+        query.pageSize = pageSize;
+      }
+      this.reloadData(query);
+    }
+  }
+
+  /**
+   * 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 {
+    const query = this.lastLoadedBy ?? this.defaultQuery;
+    if (query) {
+      query.pageSize = pageSize;
+      this.reloadData(query);
+    }
+  }
+
+  resetPage(): void {
+    const query = this.lastLoadedBy ?? this.defaultQuery;
+    if (query) {
+      query.page = 0;
+      query.pageSize = this.defaultPageSize;
+      this.reloadData(query);
+    }
+  }
+
+  resetQuery(): void {
+    const query = this.defaultQuery;
+    if (query) {
+      this.reloadData(query);
+    } else {
+      query.filterBy = {};
+      query.sortBy = [];
+      query.page = 0;
+      query.pageSize = this.defaultPageSize;
+      this.reloadData(query);
+    }
+  }
+}