@futdevpro/fsm-dynamo 1.15.20 → 1.15.22

package/src/_modules/ngx-models/_utils/shared.service.ts

@@ -0,0 +1,541 @@
+
+import { DyFM_Select } from '../_models/control-models/select.control-model';
+import { DyFM_SelectOptionsCustomConstructor } from '../_models/interfaces/select-options-custom-constructor.interface';
+
+/**
+ * Copies properties from `setTo` to `setOn` when a value exists on
+ * the source and is not already defined on the destination.
+ */
+export function DyFM_setExisitngNonSetValuesOnly<T>(setOn: T, setTo: T): void {
+  for (const key in setTo) {
+    if (setTo[key] !== undefined && !setOn[key]) {
+      setOn[key] = setTo[key];
+    }
+  }
+}
+
+/**
+ *
+ * @param objA
+ * @param objB
+ * @returns
+ */
+/**
+ * Compares two objects by value using JSON stringification.
+ */
+export function DyFM_sameObjects<T>(objA: T, objB: T): boolean {
+  return JSON.stringify(objA) === JSON.stringify(objB);
+}
+
+/**
+ * Checks if `objA` equals each object in `objBs` by value.
+ */
+export function DyFM_sameObjectsMultipleComparasion<T>(objA: T, ...objBs: T[]): boolean {
+  let same = true;
+  const strObjA = JSON.stringify(objA);
+
+  for (let i = 0; i < objBs.length && same; i++) {
+    if (strObjA !== JSON.stringify(objBs[i])) {
+      same = false;
+    }
+  }
+
+  return same;
+}
+
+/**
+ * Collection of helper utilities used across the library.
+ */
+export class DyFM_SharedService {
+
+  /**
+   * enum key will be the value, and the value will be the label
+   * @param enumObject
+   * @param withNull
+   * @returns
+   */
+  static getSelectOptionsByEnumKeys<EnumObj_T>(
+    enumObject: EnumObj_T,
+    withNull?: string
+  ): DyFM_Select<string>[] {
+    const selectOptions: DyFM_Select<string>[] = [];
+    const keys = Object.keys(enumObject);
+
+    if (withNull) {
+      selectOptions.push(new DyFM_Select<string>(withNull, null));
+    }
+    keys.forEach((key): void => {
+      selectOptions.push(
+        new DyFM_Select<string>(enumObject[<keyof EnumObj_T>key] as string, key)
+      );
+    });
+
+    return selectOptions;
+  }
+
+  /**
+   * enum value will be the label AND the value
+   * @param enumObject
+   * @param withNull
+   * @returns
+   */
+  static getSelectOptionsByEnumValues<EnumObj_T, Enum_T>(
+    enumObject: EnumObj_T,
+    withNull?: string
+  ): DyFM_Select<Enum_T>[] {
+    const selectOptions: DyFM_Select<Enum_T>[] = [];
+    const keys = Object.keys(enumObject);
+
+    if (withNull) {
+      selectOptions.push(new DyFM_Select<Enum_T>(withNull, null));
+    }
+    keys.forEach((key): void => {
+      selectOptions.push(
+        new DyFM_Select<Enum_T>(
+          enumObject[<keyof EnumObj_T>key] as string,
+          enumObject[<keyof EnumObj_T>key] as Enum_T
+        )
+      );
+    });
+
+    return selectOptions;
+  }
+
+
+  /**
+   * this object is used by DynamoSharedService.getSelectOptionsByCustomObjectList()
+   * this will help you create select options from any object list
+   *
+   * if withNull is setted, the first element will be a selectoption with the given label and with a null as value
+   *
+   * the priority rule is by:
+   *
+   * if objList & objListLabelKey setted:
+   * these will be used,
+   * if objListValueKey is setted it will be used,
+   * otherwise the full object will be used as value
+   * keys can be defined as sub-objects as well like 'main.person.face.eyeColor' or ['main','person','face','eyeColor']
+   *
+   * if obj is given:
+   * objects all key will be label, and every value will be value
+   *
+   * if list is given:
+   * all labels and values will be a string setted in by the string list
+   *
+   * @example
+   * DynamoSharedService.getSelectOptionsByCustomObjectList({
+   *   objListLabelKey: `name`,
+   *   objListValueKey: '_id',
+   *   objList: customObjectList,
+   *   withNull: true
+   * })
+   */
+  static getSelectOptionsByCustomObjectList<Select_T, Constructor_T>(
+    params: DyFM_SelectOptionsCustomConstructor<Constructor_T>
+  ): DyFM_Select<Select_T>[] {
+    if (params.objListLabelKey?.includes('.')) {
+      params.objListLabelKey = (params.objListLabelKey as string).split('.');
+    }
+
+    if (params.objListLabelKey?.includes('.')) {
+      params.objListValueKey = (params.objListValueKey as string).split('.');
+    }
+    const labelNested = Array.isArray(params.objListLabelKey);
+    const valueNested = Array.isArray(params.objListValueKey);
+
+    if (params.objList && (labelNested || valueNested)) {
+      if (!labelNested) {
+        params.objListLabelKey = [ params.objListLabelKey as string ];
+      }
+
+      if (!valueNested) {
+        params.objListValueKey = [ params.objListValueKey as string ];
+      }
+      params.objList = this.mapObjList(
+        params.objList,
+        [ params.objListLabelKey, params.objListValueKey ] as string[][]
+      );
+      params.objListLabelKey = params.objListLabelKey[params.objListLabelKey.length - 1];
+      params.objListValueKey = params.objListValueKey[params.objListValueKey.length - 1];
+      console.log('obj reduced', params);
+    }
+
+    const dropdown: DyFM_Select<Select_T>[] = [];
+
+    if (params.withNull) {
+      dropdown.push(new DyFM_Select<Select_T>(params.withNull, null));
+    }
+
+    if (params.objList && params.objListLabelKey) {
+      if (params.objListValueKey) {
+        params.objList.forEach((item): void => {
+          if (item[params.objListLabelKey as string] && item[params.objListValueKey as string]) {
+            dropdown.push(
+              new DyFM_Select<Select_T>(
+                item[params.objListLabelKey as string],
+                item[params.objListValueKey as string] as Select_T
+              )
+            );
+          } else {
+            console.error(
+              `DYNAMO ERROR: `,
+              `\n missing property! '${params.objListLabelKey}' OR `,
+              `'${params.objListValueKey}' from`, item,
+            );
+          }
+        });
+
+        return dropdown;
+      } else {
+        params.objList.forEach((item): void => {
+          if (item[params.objListLabelKey as string]) {
+            dropdown.push(new DyFM_Select<any>(item[params.objListLabelKey as string], item));
+          } else {
+            console.error(
+              'DYNAMO ERROR: ',
+              '\n missing property!',
+              params.objListLabelKey,
+              item,
+            );
+          }
+        });
+
+        return dropdown;
+      }
+    } else if (params.obj) {
+      // tslint:disable-next-line: forin
+      for (const key in params.obj) {
+        dropdown.push(
+          new DyFM_Select<Select_T>(key, params.obj[<keyof Constructor_T>key] as Select_T)
+        );
+      }
+
+      return dropdown;
+    } else if (params.list) {
+      params.list.forEach((item: string): void => {
+        dropdown.push(new DyFM_Select<Select_T>(item, item as Select_T));
+      });
+
+      return dropdown;
+    } else {
+      console.error(
+        'DYNAMO ERROR: ',
+        '\n no list or object was provided!',
+      );
+
+      return dropdown;
+    }
+  }
+
+  /**
+   * returns remapped object list by path list
+   * @param objList object list to map
+   * @param paths string list of path etc.:
+   * [ [ 'first', 'sub', 'label' ], [ 'first', 'dif', 'name' ]] will be...
+   * from
+   *  {
+   *    first: {
+   *      sub: {
+   *        label: 'vlmi'
+   *      },
+   *      dif: {
+   *        name: 'asd'
+   *      }
+   *    }
+   *  }[]
+   * to
+   * { label: 'vlmi', name: 'asd' }[]
+   * @returns remapped object list (the final obj will use the deepest keys)
+   */
+  static mapObjList<SourceObj_T, ResultObj_T>(
+    objList: SourceObj_T[],
+    paths: string[][]
+  ): ResultObj_T[] {
+    const resultObjList: ResultObj_T[] = [];
+
+    objList.forEach((obj: SourceObj_T): void => {
+      const newObj: ResultObj_T = {} as ResultObj_T;
+
+      paths.forEach((path: string[]): void => {
+        newObj[<keyof ResultObj_T>path[path.length - 1]] = this.getNestedData(obj, path);
+      });
+
+      /* return newObj; */
+    });
+
+    return resultObjList;
+  }
+  /* OLD
+  static mapObjList(objList: object[], paths: string[][]): object[] {
+    let newObjList = [ ...objList ];
+
+    newObjList = newObjList.map(obj => {
+      const newObj = {};
+
+      paths.forEach((path: string[]) => {
+        newObj[path[path.length - 1]] = this.getNestedData(obj, path);
+      });
+
+      return newObj;
+    });
+
+    return newObjList;
+  } */
+
+  /**
+   * returns nested value from object
+   * @param parentObj data source object
+   * @param nestedDataKeys path of value as string list
+   * etc.: ['nestLvl1', 'nestLvl2', 'nestLvl3'] as parentObj.nestLvl1.nestLvl2.nestLvl3
+   * @returns data from object by path
+   */
+  static getNestedData(parentObj: any, nestedDataKeys: string[]): any {
+    if (!parentObj) {
+      console.error(
+        'DYNAMO ERROR: ',
+        `\nDyFM_SharedService.getNestedData failed; missing parent object`,
+        `\nfor: ${nestedDataKeys[0]}`,
+      );
+    }
+
+    let data = parentObj;
+
+    for(const element of nestedDataKeys) {
+      if (data) {
+        data = data[element];
+      } else {
+        console.error(
+          'DYNAMO ERROR: ',
+          `\nDyFM_SharedService.getNestedData failed; missing parent for: ${element}`,
+          `\nfromKeys: ${nestedDataKeys}`,
+        );
+        break;
+      }
+    }
+    /* nestedDataKeys.forEach((dk: string): void => {
+      if (data) {
+        data = data[dk];
+      } else {
+        console.error(
+          'DYNAMO ERROR: ' +
+          `\nDyFM_SharedService.getNestedData failed; missing parent for: ${dk}`,
+          `\nfromKeys: ${nestedDataKeys[0]}`,
+          '\n\n', new Error()
+        );
+      }
+    }); */
+
+    return data;
+  }
+  /* OLD
+  static getNestedData(parentObj: any, nestedDataKeys: string[]): any {
+    let data = { ...parentObj };
+
+    nestedDataKeys.forEach((dk: string) => {
+      if (data) {
+        data = data[dk];
+      }
+    });
+
+    return data;
+  } */
+
+  /**
+   * recursive function that nests data
+   * @param newData the object that that is needed to be updated
+   * @param nestKeys the path where the data should be updated
+   * @param dataToSet the actual value that will be setted
+   * @returns modified data
+   */
+  static nestData<T>(
+    parentObj: T, 
+    nestKeys: string[], 
+    dataToSet: any, 
+    createMissingObjs?: boolean
+  ): void {
+    if (!parentObj) {
+      if (createMissingObjs) {
+        parentObj = {} as T;
+      } else {
+        console.error(
+          'DYNAMO ERROR: ',
+          `\nDyFM_SharedService.nestData failed; missing parent object for: ${nestKeys[0]}`,
+          `\nturn on createMissingObjs to create missing objects`,
+        );
+      }
+    }
+
+    if (nestKeys.length > 1) {
+      const keys = [ ...nestKeys ];
+      const nextNestKey = keys.shift();
+
+      this.nestData(parentObj[<keyof T>nextNestKey], keys, dataToSet, createMissingObjs);
+    } else {
+      parentObj[<keyof T>nestKeys[0]] = dataToSet;
+    }
+  }
+  /* OLD
+  static nestData<T>(parentObj: T, nestKeys: string[], dataToSet: any): T {
+    const newData = DyFM_Object.clone(parentObj); // {...parentObj};
+
+    if (nestKeys.length > 1) {
+      const keys = [ ...nestKeys ];
+      const nextNestKey = keys.shift();
+
+      newData[nextNestKey] = this.nestData(newData[nextNestKey], keys, dataToSet);
+    } else {
+      newData[nestKeys[0]] = dataToSet;
+    }
+
+    return newData;
+  } */
+
+  /**
+   * recursive function that adds to nested data
+   * @param newData the object that that is needed to be updated
+   * @param nestKeys the path where the data should be updated
+   * @param dataToAdd the actual value that will be setted
+   * @returns modified data
+   */
+  static addToNestedData<T>(
+    parentObj: T, 
+    nestKeys: string[], 
+    dataToAdd: any, 
+    createMissingObjs?: boolean
+  ): void {
+    if (!parentObj) {
+      if (createMissingObjs) {
+        parentObj = {} as T;
+      } else {
+        console.error(
+          'DYNAMO ERROR: ',
+          `\nDyFM_SharedService.addToNestedData failed; missing parent object for: ${nestKeys[0]}`,
+          `\nturn on createMissingObjs to create missing objects`,
+        );
+      }
+    }
+
+    if (nestKeys.length > 1) {
+      const keys = [ ...nestKeys ];
+      const nextNestKey = keys.shift();
+
+      this.addToNestedData(parentObj[<keyof T>nextNestKey], keys, dataToAdd);
+    } else {
+      parentObj[<keyof T>(nestKeys[0])] += dataToAdd;
+    }
+  }
+
+  // TODO
+  /*
+  static addToNestedData<T>(parentObj: T, nestKeys: string[], dataToAdd: any): T {
+    const newData: T = DyFM_Object.clone(parentObj); // {...parentObj};
+
+    if (nestKeys.length > 1) {
+      const keys = [ ...nestKeys ];
+      const nextNestKey = keys.shift();
+
+      newData[<keyof T>nextNestKey] = this.addToNestedData(newData[<keyof T>nextNestKey], keys, dataToAdd);
+    } else {
+      newData[<keyof T>(nestKeys[0])] += dataToAdd;
+    }
+
+    return newData;
+  } */
+
+  /**
+   * recursive function that pushes to nested data
+   * @param newData the object that that is needed to be updated
+   * @param nestKeys the path where the data should be updated
+   * @param dataToPush the actual value that will be setted
+   * @returns modified data
+   */
+  static pushToNestedData<Obj_T, Data_T>(
+    parentObj: Obj_T,
+    nestKeys: string[],
+    dataToPush: Data_T
+  ): void {
+    if (1 < nestKeys.length) {
+      const keys = [ ...nestKeys ];
+      const nextNestKey = keys.shift();
+
+      this.pushToNestedData(parentObj[nextNestKey], keys, dataToPush);
+    } else {
+      if (Array.isArray(parentObj[nestKeys[0]])) {
+        parentObj[nestKeys[0]].push(dataToPush);
+      } else {
+        parentObj[nestKeys[0]] = [ dataToPush ];
+      }
+    }
+  }
+
+  // TODO
+  /*
+  static pushToNestedData(parentObj: any, nestKeys: string[], dataToPush: any): any {
+    const newData = { ...parentObj };
+
+    if (1 < nestKeys.length) {
+      const keys = [ ...nestKeys ];
+      const nextNestKey = keys.shift();
+
+      newData[nextNestKey] = this.pushToNestedData(newData[nextNestKey], keys, dataToPush);
+    } else {
+      if (Array.isArray(newData[nestKeys[0]])) {
+        newData[nestKeys[0]].push(dataToPush);
+      } else {
+        newData[nestKeys[0]] = [dataToPush];
+      }
+    }
+
+    return newData;
+  } */
+
+  /**
+   * recursive function that nests data on recursive data structure etc.: xData: { ..., 'nestedListKey': xData[] }
+   * @param newData the object that that is needed to be updated
+   * @param nestedListKey the location of nested dataList
+   * @param nestIndexes path to the subject ect.: xData.listKey[1].listKey[4].listKey[0] will be [1, 4, 0]
+   * @param dataToSet the actual value that will be setted on location
+   * @returns modified data
+   */
+  static nestRecursiveListedData<T, List_T>(
+    parentObj: T,
+    nestedListKey: string,
+    nestIndexes: number[],
+    dataToSet: List_T
+  ): void {
+    const nestedList: List_T[] = parentObj[<keyof T>nestedListKey] as List_T[];
+
+    if (1 < nestIndexes.length) {
+      const indexes: number[] = [ ...nestIndexes ];
+      const nextLevelKey: number = indexes.shift();
+
+      this.nestRecursiveListedData(
+        nestedList[nextLevelKey], nestedListKey, indexes, dataToSet
+      );
+    } else {
+      nestedList[nestIndexes[0]] = dataToSet;
+    }
+  }
+  /* OLD
+  static nestRecursiveListedData<T>(
+    parentObj: T,
+    nestedListKey: string,
+    nestIndexes: number[],
+    dataToSet: unknown
+  ): T {
+    const newData: T = { ...parentObj };
+
+    if (1 < nestIndexes.length) {
+      const indexes: number[] = [ ...nestIndexes ];
+      const nextLevelKey: number = indexes.shift();
+
+      newData[nestedListKey][nextLevelKey] = this.nestRecursiveListedData(
+        newData[nestedListKey][nextLevelKey], nestedListKey, indexes, dataToSet
+      );
+    } else {
+      newData[nestedListKey][nestIndexes[0]] = dataToSet;
+    }
+
+    return newData;
+  } */
+}

package/src/_modules/ngx-models/index.ts

@@ -0,0 +1,110 @@
+
+
+// COLLECTIONS
+export * from './_collections/button-new-style-settings-presets.const';
+export * from './_collections/dynamo-global.settings';
+
+
+// ENUMS
+export * from './_enums/button-type.enum';
+export * from './_enums/checkbox-label-position.enum';
+export * from './_enums/container-type.enum';
+export * from './_enums/field-appearance.enum';
+export * from './_enums/field-type.enum';
+export * from './_enums/file-type.enum';
+export * from './_enums/form-access.enum';
+export * from './_enums/form-reset-data.enum';
+export * from './_enums/form-store-on.enum';
+export * from './_enums/material-color.enum';
+export * from './_enums/material-tooltip-position.enum';
+export * from './_enums/preconfigured-field-type.enum';
+export * from './_enums/storage-type.enum';
+export * from './_enums/validator-type.enum';
+
+// enums/BUTTON
+export * from './_enums/button-new/button-new-border-radius.enum';
+export * from './_enums/button-new/button-new-icon-style-type.enum';
+export * from './_enums/button-new/button-new-size.enum';
+export * from './_enums/button-new/button-new-style-type.enum';
+
+// enums/FLEX
+export * from './_enums/flex/flex-layout-align.enum';
+export * from './_enums/flex/flex-layout.enum';
+
+// enums/HTML
+export * from './_enums/html/input-types.enum';
+
+// enums/FORMS-V2 (BL-FORMS-V2 Wave-1A)
+export * from './_enums/forms-new/field-new-validator-type.enum';
+
+
+// MODELS
+// models/CONTROL MODELS
+export * from './_models/control-models/button-new-style-settings.control-model';
+export * from './_models/control-models/button-params.control-model';
+export * from './_models/control-models/data-handler.control-model';
+export * from './_models/control-models/data-handler-settings.control-model';
+export * from './_models/control-models/field-settings.control-model';
+export * from './_models/control-models/form-settings.control-model';
+export * from './_models/control-models/select.control-model';
+
+// models/CONTROL MODELS / FORMS-V2 (BL-FORMS-V2 Wave-1A)
+export * from './_models/control-models/forms-new';
+
+// =====================================================================
+// CCAP-MIRROR Wave-1a (BL-CCAP-MIRROR)
+// =====================================================================
+
+// enums/ERRORS
+export * from './_enums/errors/error-ui-mode.enum';
+export * from './_enums/errors/error-level.enum';
+export * from './_enums/errors/error-notification-color.enum';
+
+// enums/FRAMES
+export * from './_enums/frames/header-item-type.enum';
+export * from './_enums/frames/header-position.enum';
+export * from './_enums/frames/side-nav-badge-color.enum';
+
+// enums/VOICE
+export * from './_enums/voice/voice-provider-type.enum';
+export * from './_enums/voice/voice-recorder-state.enum';
+export * from './_enums/voice/audio-mime-type.enum';
+
+// interfaces/VOICE
+export * from './_models/interfaces/voice/transcribe-options.interface';
+export * from './_models/interfaces/voice/transcribe-result.interface';
+export * from './_models/interfaces/voice/speak-options.interface';
+export * from './_models/interfaces/voice/speak-result.interface';
+export * from './_models/interfaces/voice/voice-profile.interface';
+export * from './_models/interfaces/voice/voice-provider-init.interface';
+
+// control-models/ERRORS
+export * from './_models/control-models/errors/error-settings.control-model';
+export * from './_models/control-models/errors/errors-settings.control-model';
+export * from './_models/control-models/errors/error-notification.control-model';
+
+// control-models/FRAMES
+export * from './_models/control-models/frames/header-item-settings.control-model';
+export * from './_models/control-models/frames/main-frame-settings.control-model';
+export * from './_models/control-models/frames/side-nav-item-settings.control-model';
+export * from './_models/control-models/frames/side-nav-settings.control-model';
+
+// control-models/CHAT
+export * from './_models/control-models/chat/chat-column-layout-settings.control-model';
+
+// control-models/VOICE
+export * from './_models/control-models/voice/voice-recorder-settings.control-model';
+export * from './_models/control-models/voice/voice-providers-settings.control-model';
+export * from './_models/control-models/voice/voice-record-button-settings.control-model';
+
+// models/INTERFACES
+export * from './_models/interfaces/button-new-settings.interface';
+export * from './_models/interfaces/confirm-settings.interface';
+export * from './_models/interfaces/global-settings.interface';
+export * from './_models/interfaces/select-options-custom-constructor.interface';
+export * from './_models/interfaces/storage.service';
+
+
+// UTILS
+export * from './_utils/shared.service';
+