@futdevpro/fsm-dynamo 1.16.4 → 1.16.7

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

@@ -1,110 +1,110 @@
-
-import { DyFM_Metadata } from '../../../_models/data-models/metadata.data-model';
-import { DyFM_SearchQuery } from '../../../_models/interfaces/search-query.interface';
-import { DyFM_DataHandler, DyFM_DataHandlerDataLoadPostProcess } from './data-handler.control-model';
-
-/**
- * DyFM_DataHandler_Settings
- * @param apiService any service can be used as apiService
- * as long as the function, you pass in getDataFunctionName exists,
- * uses (or not uses an ID as input) and returns the data as Promise<Type>
- * @param getDataFunctionName the function name on the apiService,
- * that will be used as get api call
- *
- * @param successfulReloadCallBack you can create direct callback for successful reloads
- * by passing it here
- *
- * @param getPostPreprocessLoad post processes can be implemented to ensure special conditions on data
- *
- * @param defaultValue you can set default value that will be used before any load
- * @param noId this flag needs to be true, when using api function without id
- *
- * @example
- * personalInformationDH = new DynamoDataHandler<PersonalInformation>({
- *   apiService: this.accountApiService,
- *   getDataFunctionName: 'getPersonalInformation',
- * });
- */
-export class DyFM_DataHandler_Settings<
-  T extends DyFM_Metadata | DyFM_Metadata[],
-  T_Dependency extends DyFM_Metadata = any,
-  T_LoadBy = string
-> {
-  name?: string;
-
-  /** this will be used to get the data from the API
-   * while creating arrow function for this, dont forget to use async n await! */
-  get?: (loadBy?: T_LoadBy) => Promise<any>;
-  /** this will be used to set the data to the data handler
-   * while creating arrow function for this, dont forget to use async n await! */
-  set?: (data: T) => Promise<T>;
-  /* patch?: (data: T) => Promise<T>; */
-
-  // TODO
-  /* directApiSetup?: { set, get,}; */
-  // AVAGY
-  /* apiCallSettings?: DyNX_ApiCall_Settings; */
-
-  /* successfulLoadCallBack?: (data: T) => void; */
-
-  /**
-   * post processes will be called as pipes after data is loaded by get function,
-   * but before data is set to data handler by data_$.set (after get, before Signal triggers)
-   */
-  getPostProcess?: DyFM_DataHandlerDataLoadPostProcess<T_LoadBy>;
-
-  dependencyDataHandler?: DyFM_DataHandler<T_Dependency>;
-  dependentDataHandlers?: DyFM_DataHandler<any>[];
-
-  defaultValue?: T;
-  defaultLoadBy?: T_LoadBy;
-  noId?: boolean;
-
-  debugLog?: boolean;
-}
-
-/**
- * DyFM_DataListHandler_Settings
- */
-export class DyFM_DataListHandler_Settings<
-  T_DataItem extends DyFM_Metadata,
-  T_DependencyData extends DyFM_Metadata = any,
-  T_DataLoadBy = string,
-  T_UpdateItemBy = string,
-> extends DyFM_DataHandler_Settings<T_DataItem[], T_DependencyData, T_DataLoadBy> {
-  /** this will be used to send the item update to the API
-   * while creating arrow function for this, dont forget to use async n await! */
-  setItem?: (item: T_DataItem, updateBy?: T_UpdateItemBy) => Promise<T_DataItem>;
-  /** this will be used to send the item delete to the API
-   * while creating arrow function for this, dont forget to use async n await! */
-  deleteItem?: (id: string, updateBy?: T_UpdateItemBy) => Promise<void>;
-}
-
-export class DyFM_DataSearchHandler_Settings<
-  T_DataItem extends DyFM_Metadata,
-  T_DataLoadBy extends DyFM_SearchQuery<any> = DyFM_SearchQuery<T_DataItem>,
-  /* T_Result extends DyFM_SearchResult<any> = DyFM_SearchResult<T_DataItem>, */
-  T_DependencyData extends DyFM_Metadata = any,
-> extends DyFM_DataHandler_Settings<T_DataItem[], T_DependencyData, T_DataLoadBy> {
-  defaultQuery?: T_DataLoadBy;
-  defaultPageSize?: number;
-  cacheSize?: number;
-  queryUpdateDebounceTime?: number;
-  searchOnInit?: boolean;
-}
-
-export class DyFM_ListCollectorDataHandler_Settings<
-  T_ListCollectorData extends DyFM_Metadata,
-  T_DataItem extends DyFM_Metadata,
-  T_DependencyData extends DyFM_Metadata = any,
-  T_DataLoadBy = string,
-> extends DyFM_DataHandler_Settings<T_ListCollectorData, T_DependencyData, T_DataLoadBy> {
-  /** this will be used to send the item update to the API
-   * while creating arrow function for this, dont forget to use async n await! */
-  setItem?: (item: T_DataItem, collectorId?: string) => Promise<T_DataItem>;
-  /** this will be used to send the item delete to the API
-   * while creating arrow function for this, dont forget to use async n await! */
-  deleteItem?: (id: string, collectorId?: string) => Promise<void>;
-
-  listKey: string;
-}
+
+import { DyFM_Metadata } from '../../../_models/data-models/metadata.data-model';
+import { DyFM_SearchQuery } from '../../../_models/interfaces/search-query.interface';
+import { DyFM_DataHandler, DyFM_DataHandlerDataLoadPostProcess } from './data-handler.control-model';
+
+/**
+ * DyFM_DataHandler_Settings
+ * @param apiService any service can be used as apiService
+ * as long as the function, you pass in getDataFunctionName exists,
+ * uses (or not uses an ID as input) and returns the data as Promise<Type>
+ * @param getDataFunctionName the function name on the apiService,
+ * that will be used as get api call
+ *
+ * @param successfulReloadCallBack you can create direct callback for successful reloads
+ * by passing it here
+ *
+ * @param getPostPreprocessLoad post processes can be implemented to ensure special conditions on data
+ *
+ * @param defaultValue you can set default value that will be used before any load
+ * @param noId this flag needs to be true, when using api function without id
+ *
+ * @example
+ * personalInformationDH = new DynamoDataHandler<PersonalInformation>({
+ *   apiService: this.accountApiService,
+ *   getDataFunctionName: 'getPersonalInformation',
+ * });
+ */
+export class DyFM_DataHandler_Settings<
+  T extends DyFM_Metadata | DyFM_Metadata[],
+  T_Dependency extends DyFM_Metadata = any,
+  T_LoadBy = string
+> {
+  name?: string;
+
+  /** this will be used to get the data from the API
+   * while creating arrow function for this, dont forget to use async n await! */
+  get?: (loadBy?: T_LoadBy) => Promise<any>;
+  /** this will be used to set the data to the data handler
+   * while creating arrow function for this, dont forget to use async n await! */
+  set?: (data: T) => Promise<T>;
+  /* patch?: (data: T) => Promise<T>; */
+
+  // TODO
+  /* directApiSetup?: { set, get,}; */
+  // AVAGY
+  /* apiCallSettings?: DyNX_ApiCall_Settings; */
+
+  /* successfulLoadCallBack?: (data: T) => void; */
+
+  /**
+   * post processes will be called as pipes after data is loaded by get function,
+   * but before data is set to data handler by data_$.set (after get, before Signal triggers)
+   */
+  getPostProcess?: DyFM_DataHandlerDataLoadPostProcess<T_LoadBy>;
+
+  dependencyDataHandler?: DyFM_DataHandler<T_Dependency>;
+  dependentDataHandlers?: DyFM_DataHandler<any>[];
+
+  defaultValue?: T;
+  defaultLoadBy?: T_LoadBy;
+  noId?: boolean;
+
+  debugLog?: boolean;
+}
+
+/**
+ * DyFM_DataListHandler_Settings
+ */
+export class DyFM_DataListHandler_Settings<
+  T_DataItem extends DyFM_Metadata,
+  T_DependencyData extends DyFM_Metadata = any,
+  T_DataLoadBy = string,
+  T_UpdateItemBy = string,
+> extends DyFM_DataHandler_Settings<T_DataItem[], T_DependencyData, T_DataLoadBy> {
+  /** this will be used to send the item update to the API
+   * while creating arrow function for this, dont forget to use async n await! */
+  setItem?: (item: T_DataItem, updateBy?: T_UpdateItemBy) => Promise<T_DataItem>;
+  /** this will be used to send the item delete to the API
+   * while creating arrow function for this, dont forget to use async n await! */
+  deleteItem?: (id: string, updateBy?: T_UpdateItemBy) => Promise<void>;
+}
+
+export class DyFM_DataSearchHandler_Settings<
+  T_DataItem extends DyFM_Metadata,
+  T_DataLoadBy extends DyFM_SearchQuery<any> = DyFM_SearchQuery<T_DataItem>,
+  /* T_Result extends DyFM_SearchResult<any> = DyFM_SearchResult<T_DataItem>, */
+  T_DependencyData extends DyFM_Metadata = any,
+> extends DyFM_DataHandler_Settings<T_DataItem[], T_DependencyData, T_DataLoadBy> {
+  defaultQuery?: T_DataLoadBy;
+  defaultPageSize?: number;
+  cacheSize?: number;
+  queryUpdateDebounceTime?: number;
+  searchOnInit?: boolean;
+}
+
+export class DyFM_ListCollectorDataHandler_Settings<
+  T_ListCollectorData extends DyFM_Metadata,
+  T_DataItem extends DyFM_Metadata,
+  T_DependencyData extends DyFM_Metadata = any,
+  T_DataLoadBy = string,
+> extends DyFM_DataHandler_Settings<T_ListCollectorData, T_DependencyData, T_DataLoadBy> {
+  /** this will be used to send the item update to the API
+   * while creating arrow function for this, dont forget to use async n await! */
+  setItem?: (item: T_DataItem, collectorId?: string) => Promise<T_DataItem>;
+  /** this will be used to send the item delete to the API
+   * while creating arrow function for this, dont forget to use async n await! */
+  deleteItem?: (id: string, collectorId?: string) => Promise<void>;
+
+  listKey: string;
+}