@futdevpro/fsm-dynamo 1.16.39 → 1.20.2

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

@@ -1,147 +1,147 @@
-import { DyFM_Metadata } from '../../../..';
-import { BehaviorSubject } from 'rxjs';
-import { DyFM_WritableSignalPlaceholder } from '../../_collections/angular-placeholders';
-import { DyFM_SignalDataHandler_Settings } from './data-handler-settings.control-model';
-/**
- * DyFM_SignalDataHandlerDataLoadInProgress
- * @deprecated
- * meg kell nézni hogy mit kell az fsm-ből használni, és mit kell signal-osra alakítani
- * ellenőrizni kell, hogy minden funkcionalitás átkerült az fsm-be mielőtt remove-oljuk ezeket
- */
-export interface DyFM_SignalDataHandlerDataLoadInProgress<T_LoadBy> {
-    loadBy: T_LoadBy;
-    progress: Promise<any>;
-}
-/**
- * DyFM_DataHandlerDataPostProcess
- * @deprecated
- * meg kell nézni hogy mit kell az fsm-ből használni, és mit kell signal-osra alakítani
- * ellenőrizni kell, hogy minden funkcionalitás átkerült az fsm-be mielőtt remove-oljuk ezeket
- */
-export type DyFM_SignalDataHandlerDataLoadPostProcess<T_LoadBy> = (data: any, loadedBy: T_LoadBy) => Promise<any> | any;
-/**
- * DynamoDataHandler is used to create application wide data handling
- * used to create subscribeAble data handler
- *
- * this implements data reload function that uses predefined apiService,
- * using previous or given id,
- * prevents multiple load calls and triggers data change subscriptions when done
- *
- * load post processes can be implemented to ensure special conditions
- *
- * @example
- * personalInformationDH = new DynamoDataHandler<PersonalInformation>({
- *   apiService: this.accountApiService,
- *   getDataFunctionName: 'getPersonalInformation',
- * });
- * @deprecated
- * meg kell nézni hogy mit kell az fsm-ből használni, és mit kell signal-osra alakítani
- * ellenőrizni kell, hogy minden funkcionalitás átkerült az fsm-be mielőtt remove-oljuk ezeket
- */
-export declare abstract class DyFM_SignalDataHandler<T extends DyFM_Metadata | DyFM_Metadata[], T_Dependency extends DyFM_Metadata = any, T_LoadBy = string> {
-    name: string;
-    abstract readonly data_$: DyFM_WritableSignalPlaceholder<T>;
-    /**
-     * this is only declared if createObservable is set to true in settings
-     * (handled by DyNX_DataHandler)
-     */
-    protected abstract readonly data_BS: BehaviorSubject<T>;
-    get data(): T;
-    /**
-     * last loaded by will work properly only if you use the Dynamo form of "_id" for loading
-     */
-    lastLoadedBy: T_LoadBy;
-    /** this will handle the data loading from the api */
-    protected readonly get: (loadBy?: T_LoadBy) => Promise<any>;
-    /** this will handle the data setting to the data handler */
-    protected readonly set: (data: T) => Promise<T>;
-    /** this will handle the data patching to the data handler */
-    /**
-     * 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)
-     */
-    protected readonly getPostProcesses: DyFM_SignalDataHandlerDataLoadPostProcess<T_LoadBy>[];
-    noId?: boolean;
-    abstract readonly loaded_$: DyFM_WritableSignalPlaceholder<boolean>;
-    abstract readonly loadInProgress_$: DyFM_WritableSignalPlaceholder<DyFM_SignalDataHandlerDataLoadInProgress<T_LoadBy> | false>;
-    waitsOnLoad: {
-        promise: Promise<void>;
-        resolve: () => void;
-    }[];
-    protected readonly dependentDataHandlers?: DyFM_SignalDataHandler<any>[];
-    loopSafetyCollection: {
-        at: Date;
-        stack: string;
-    }[];
-    loopSafetyTimeout: number;
-    /** if set to 0, loop safety will be disabled */
-    loopSafety: number;
-    debugLog?: boolean;
-    /**
-     * DynamoDataHandler
-     * @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',
-     * });
-     */
-    constructor(set: DyFM_SignalDataHandler_Settings<T, T_Dependency, T_LoadBy>, 
-    /** is in construct?
-     * so the dependent data handlers are not added here, but in the extended class */
-    skipDependencyConnections?: boolean);
-    addDependencyDataHandler(dependencyDataHandler: DyFM_SignalDataHandler<any>, isInConstruct?: boolean): void;
-    addDependentDataHandlers(dependentDataHandlers: DyFM_SignalDataHandler<any, any, any>[], isInConstruct?: boolean): void;
-    /**
-     * reloads data on DynamoDataHandler using predefined apiservice,
-     * using previous or given id,
-     * prevents multiple load calls and triggers data change subscriptions when done
-     * @param loadBy previous or given id (or can be disabled trough setup by: { noId: true })
-     * @param opts BFR-MASTERPROMPTER-024: `silentMissingId` — a hiányzó-ID ág NE console.error-ozzon
-     *   (a throw MARAD). A `getData()` not-loaded-yet útja használja: friss boot-on a dependency-cascade
-     *   (header token-balance/user-data read) a session-restore ELŐTT ér ide → az ID-hiány ott
-     *   „még-nincs-betöltve", NEM caller-hiba — a korábbi feltétel-nélküli console.error minden
-     *   hard-nav-on 2 hamis error-t tett a konzolra (release-gate-zaj). Direct `reloadData()`-hívásnál
-     *   a hiba-log változatlan (valódi caller-hiba látható marad).
-     * @returns the data as Promise<T>, finishes when the call ends (throws error on fail)
-     */
-    reloadData(loadBy?: T_LoadBy, opts?: {
-        silentMissingId?: boolean;
-    }): Promise<T>;
-    getData(): Promise<T>;
-    protected doReloadDataBy(loadedBy: T_LoadBy): Promise<T>;
-    /**
-     * Az adat közvetlen frissítése (round-trip nélkül; pl. SPA-login → user_DH.updateData). Alapból CSAK
-     * a saját `data_$`-t frissíti.
-     *
-     * @param reloadDependents opt-in (BFR-MASTERPROMPTER-013): ha true, a dependent DataHandler-eket
-     *   (pl. token-balance) is újratölti az új adat `_id`-jével — a `reloadData` post-process
-     *   dependent-lánca az `updateData` (round-trip-mentes) úton eddig NEM futott → a friss SPA-login után
-     *   a dependent-DH-adatok üresek maradtak hard-reload-ig. DEFAULT false (backward-safe: a vak
-     *   dependent-reload HTTP-flood-ot okozhatna, az updateData szándéka épp a szerver-hívás elkerülése).
-     */
-    updateData(data: T, dontSendUpdate?: boolean, reloadDependents?: boolean): Promise<void>;
-    clear(dontClearDependents?: boolean): void;
-    protected processLoadResult(result: any, loadedBy: T_LoadBy): Promise<T>;
-    private resolveWaitsOnLoad;
-    /**
-     * waits for the first load to finish
-     * @returns a promise that resolves when the first load finishes after this "subscription"
-     */
-    waitForLoad(): Promise<void>;
-    protected loopSafetyCheck(): void;
-}
+import { DyFM_Metadata } from '../../../..';
+import { BehaviorSubject } from 'rxjs';
+import { DyFM_WritableSignalPlaceholder } from '../../_collections/angular-placeholders';
+import { DyFM_SignalDataHandler_Settings } from './data-handler-settings.control-model';
+/**
+ * DyFM_SignalDataHandlerDataLoadInProgress
+ * @deprecated
+ * meg kell nézni hogy mit kell az fsm-ből használni, és mit kell signal-osra alakítani
+ * ellenőrizni kell, hogy minden funkcionalitás átkerült az fsm-be mielőtt remove-oljuk ezeket
+ */
+export interface DyFM_SignalDataHandlerDataLoadInProgress<T_LoadBy> {
+    loadBy: T_LoadBy;
+    progress: Promise<any>;
+}
+/**
+ * DyFM_DataHandlerDataPostProcess
+ * @deprecated
+ * meg kell nézni hogy mit kell az fsm-ből használni, és mit kell signal-osra alakítani
+ * ellenőrizni kell, hogy minden funkcionalitás átkerült az fsm-be mielőtt remove-oljuk ezeket
+ */
+export type DyFM_SignalDataHandlerDataLoadPostProcess<T_LoadBy> = (data: any, loadedBy: T_LoadBy) => Promise<any> | any;
+/**
+ * DynamoDataHandler is used to create application wide data handling
+ * used to create subscribeAble data handler
+ *
+ * this implements data reload function that uses predefined apiService,
+ * using previous or given id,
+ * prevents multiple load calls and triggers data change subscriptions when done
+ *
+ * load post processes can be implemented to ensure special conditions
+ *
+ * @example
+ * personalInformationDH = new DynamoDataHandler<PersonalInformation>({
+ *   apiService: this.accountApiService,
+ *   getDataFunctionName: 'getPersonalInformation',
+ * });
+ * @deprecated
+ * meg kell nézni hogy mit kell az fsm-ből használni, és mit kell signal-osra alakítani
+ * ellenőrizni kell, hogy minden funkcionalitás átkerült az fsm-be mielőtt remove-oljuk ezeket
+ */
+export declare abstract class DyFM_SignalDataHandler<T extends DyFM_Metadata | DyFM_Metadata[], T_Dependency extends DyFM_Metadata = any, T_LoadBy = string> {
+    name: string;
+    abstract readonly data_$: DyFM_WritableSignalPlaceholder<T>;
+    /**
+     * this is only declared if createObservable is set to true in settings
+     * (handled by DyNX_DataHandler)
+     */
+    protected abstract readonly data_BS: BehaviorSubject<T>;
+    get data(): T;
+    /**
+     * last loaded by will work properly only if you use the Dynamo form of "_id" for loading
+     */
+    lastLoadedBy: T_LoadBy;
+    /** this will handle the data loading from the api */
+    protected readonly get: (loadBy?: T_LoadBy) => Promise<any>;
+    /** this will handle the data setting to the data handler */
+    protected readonly set: (data: T) => Promise<T>;
+    /** this will handle the data patching to the data handler */
+    /**
+     * 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)
+     */
+    protected readonly getPostProcesses: DyFM_SignalDataHandlerDataLoadPostProcess<T_LoadBy>[];
+    noId?: boolean;
+    abstract readonly loaded_$: DyFM_WritableSignalPlaceholder<boolean>;
+    abstract readonly loadInProgress_$: DyFM_WritableSignalPlaceholder<DyFM_SignalDataHandlerDataLoadInProgress<T_LoadBy> | false>;
+    waitsOnLoad: {
+        promise: Promise<void>;
+        resolve: () => void;
+    }[];
+    protected readonly dependentDataHandlers?: DyFM_SignalDataHandler<any>[];
+    loopSafetyCollection: {
+        at: Date;
+        stack: string;
+    }[];
+    loopSafetyTimeout: number;
+    /** if set to 0, loop safety will be disabled */
+    loopSafety: number;
+    debugLog?: boolean;
+    /**
+     * DynamoDataHandler
+     * @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',
+     * });
+     */
+    constructor(set: DyFM_SignalDataHandler_Settings<T, T_Dependency, T_LoadBy>, 
+    /** is in construct?
+     * so the dependent data handlers are not added here, but in the extended class */
+    skipDependencyConnections?: boolean);
+    addDependencyDataHandler(dependencyDataHandler: DyFM_SignalDataHandler<any>, isInConstruct?: boolean): void;
+    addDependentDataHandlers(dependentDataHandlers: DyFM_SignalDataHandler<any, any, any>[], isInConstruct?: boolean): void;
+    /**
+     * reloads data on DynamoDataHandler using predefined apiservice,
+     * using previous or given id,
+     * prevents multiple load calls and triggers data change subscriptions when done
+     * @param loadBy previous or given id (or can be disabled trough setup by: { noId: true })
+     * @param opts BFR-MASTERPROMPTER-024: `silentMissingId` — a hiányzó-ID ág NE console.error-ozzon
+     *   (a throw MARAD). A `getData()` not-loaded-yet útja használja: friss boot-on a dependency-cascade
+     *   (header token-balance/user-data read) a session-restore ELŐTT ér ide → az ID-hiány ott
+     *   „még-nincs-betöltve", NEM caller-hiba — a korábbi feltétel-nélküli console.error minden
+     *   hard-nav-on 2 hamis error-t tett a konzolra (release-gate-zaj). Direct `reloadData()`-hívásnál
+     *   a hiba-log változatlan (valódi caller-hiba látható marad).
+     * @returns the data as Promise<T>, finishes when the call ends (throws error on fail)
+     */
+    reloadData(loadBy?: T_LoadBy, opts?: {
+        silentMissingId?: boolean;
+    }): Promise<T>;
+    getData(): Promise<T>;
+    protected doReloadDataBy(loadedBy: T_LoadBy): Promise<T>;
+    /**
+     * Az adat közvetlen frissítése (round-trip nélkül; pl. SPA-login → user_DH.updateData). Alapból CSAK
+     * a saját `data_$`-t frissíti.
+     *
+     * @param reloadDependents opt-in (BFR-MASTERPROMPTER-013): ha true, a dependent DataHandler-eket
+     *   (pl. token-balance) is újratölti az új adat `_id`-jével — a `reloadData` post-process
+     *   dependent-lánca az `updateData` (round-trip-mentes) úton eddig NEM futott → a friss SPA-login után
+     *   a dependent-DH-adatok üresek maradtak hard-reload-ig. DEFAULT false (backward-safe: a vak
+     *   dependent-reload HTTP-flood-ot okozhatna, az updateData szándéka épp a szerver-hívás elkerülése).
+     */
+    updateData(data: T, dontSendUpdate?: boolean, reloadDependents?: boolean): Promise<void>;
+    clear(dontClearDependents?: boolean): void;
+    protected processLoadResult(result: any, loadedBy: T_LoadBy): Promise<T>;
+    private resolveWaitsOnLoad;
+    /**
+     * waits for the first load to finish
+     * @returns a promise that resolves when the first load finishes after this "subscription"
+     */
+    waitForLoad(): Promise<void>;
+    protected loopSafetyCheck(): void;
+}
 //# sourceMappingURL=data-handler.control-model.d.ts.map