@futdevpro/fsm-dynamo 1.15.17 → 1.15.20

package/src/_models/control-models/data-property-params.control-model.spec.ts

@@ -1,93 +1,93 @@
-import { DyFM_Log } from '../../_collections/utils/log.util';
-import { DyFM_BasicProperty_Type } from '../../_enums/basic-property-type.enum';
-import { DyFM_DataProperty_Params, DyFM_DataProperty_Settings } from './data-property-params.control-model';
-
-describe('| DyFM_DataProperty_Params', () => {
-  it('| should create an instance with given settings', () => {
-    const settings: DyFM_DataProperty_Settings<string, any> = {
-      key: 'testKey',
-      type: DyFM_BasicProperty_Type.string,
-      default: 'defaultValue',
-      unique: true,
-      readonly: false,
-      required: true,
-      index: false,
-      dependencyDataName: 'dependencyName',
-      minlength: 5,
-      maxlength: 10,
-      subObjectParams: {},
-      additionalValidators: [(data) => { console.log(data); }]
-    };
-
-    const instance = new DyFM_DataProperty_Params(settings, { dataName: 'testDataName' } as any);
-
-    expect(instance.key).toBe('testKey');
-    expect(instance.type).toBe(DyFM_BasicProperty_Type.string);
-    expect(instance.default).toBe('defaultValue');
-    expect(instance.unique).toBe(true);
-    expect(instance.readonly).toBe(false);
-    expect(instance.required).toBe(true);
-    expect(instance.index).toBe(false);
-    expect(instance.dependencyDataName).toBe('dependencyName');
-    expect(instance.minlength).toBe(5);
-    expect(instance.maxlength).toBe(10);
-    expect(instance.subObjectParams).toEqual({});
-    expect(instance.additionalValidators?.length).toBe(1);
-  });
-
-  xit('should log error if type is missing', () => {
-    const consoleErrorSpy = spyOn(DyFM_Log, 'error');
-    const settings: DyFM_DataProperty_Settings<string, any> = {
-      key: 'testKey',
-      type: undefined as any, // Simulating missing type
-    };
-
-    new DyFM_DataProperty_Params(settings, { dataName: 'testDataName' } as any);
-
-    expect(consoleErrorSpy).toHaveBeenCalledWith(
-      'DYNAMO ERROR: ',
-      `\n type is missing from DynamoNTSDataPropertyParams at "testKey" in ` +
-        `"testDataName" model.` +
-      `\n stackLocation: WHAT`
-    );
-  });
-
-  xit('should log error if settings are not provided', () => {
-    const consoleErrorSpy = spyOn(DyFM_Log, 'error');
-
-    new DyFM_DataProperty_Params(undefined as any, { dataName: 'testDataName' } as any);
-
-    expect(consoleErrorSpy).toHaveBeenCalledWith(
-      'DYNAMO ERROR: ',
-      `\nMISSING DynamoNTSDataPropertyParams constructor input at "testKey" in ` +
-        `"testDataName" model.` +
-      `\n stackLocation: WHAT`
-    );
-  });
-
-  xit('should return correct BEType based on type', () => {
-    const settings: DyFM_DataProperty_Settings<any, any> = {
-      type: DyFM_BasicProperty_Type.string
-    };
-    const instance = new DyFM_DataProperty_Params(settings, { dataName: 'testDataName' } as any);
-    expect(instance.getBEType()).toBe(String);
-
-    settings.type = DyFM_BasicProperty_Type.number;
-    expect(instance.getBEType()).toBe(Number);
-
-    settings.type = DyFM_BasicProperty_Type.boolean;
-    expect(instance.getBEType()).toBe(Boolean);
-
-    settings.type = DyFM_BasicProperty_Type.date;
-    expect(instance.getBEType()).toBe(Date);
-
-    settings.type = DyFM_BasicProperty_Type.object;
-    expect(instance.getBEType()).toBe(Object);
-
-    settings.type = 'customType[]';
-    expect(instance.getBEType()).toBe(Array);
-
-    settings.type = 'customFunction =>';
-    expect(instance.getBEType()).toBe(Function);
-  });
-});
+import { DyFM_Log } from '../../_collections/utils/log.util';
+import { DyFM_BasicProperty_Type } from '../../_enums/basic-property-type.enum';
+import { DyFM_DataProperty_Params, DyFM_DataProperty_Settings } from './data-property-params.control-model';
+
+describe('| DyFM_DataProperty_Params', () => {
+  it('| should create an instance with given settings', () => {
+    const settings: DyFM_DataProperty_Settings<string, any> = {
+      key: 'testKey',
+      type: DyFM_BasicProperty_Type.string,
+      default: 'defaultValue',
+      unique: true,
+      readonly: false,
+      required: true,
+      index: false,
+      dependencyDataName: 'dependencyName',
+      minlength: 5,
+      maxlength: 10,
+      subObjectParams: {},
+      additionalValidators: [(data) => { console.log(data); }]
+    };
+
+    const instance = new DyFM_DataProperty_Params(settings, { dataName: 'testDataName' } as any);
+
+    expect(instance.key).toBe('testKey');
+    expect(instance.type).toBe(DyFM_BasicProperty_Type.string);
+    expect(instance.default).toBe('defaultValue');
+    expect(instance.unique).toBe(true);
+    expect(instance.readonly).toBe(false);
+    expect(instance.required).toBe(true);
+    expect(instance.index).toBe(false);
+    expect(instance.dependencyDataName).toBe('dependencyName');
+    expect(instance.minlength).toBe(5);
+    expect(instance.maxlength).toBe(10);
+    expect(instance.subObjectParams).toEqual({});
+    expect(instance.additionalValidators?.length).toBe(1);
+  });
+
+  xit('should log error if type is missing', () => {
+    const consoleErrorSpy = spyOn(DyFM_Log, 'error');
+    const settings: DyFM_DataProperty_Settings<string, any> = {
+      key: 'testKey',
+      type: undefined as any, // Simulating missing type
+    };
+
+    new DyFM_DataProperty_Params(settings, { dataName: 'testDataName' } as any);
+
+    expect(consoleErrorSpy).toHaveBeenCalledWith(
+      'DYNAMO ERROR: ',
+      `\n type is missing from DynamoNTSDataPropertyParams at "testKey" in ` +
+        `"testDataName" model.` +
+      `\n stackLocation: WHAT`
+    );
+  });
+
+  xit('should log error if settings are not provided', () => {
+    const consoleErrorSpy = spyOn(DyFM_Log, 'error');
+
+    new DyFM_DataProperty_Params(undefined as any, { dataName: 'testDataName' } as any);
+
+    expect(consoleErrorSpy).toHaveBeenCalledWith(
+      'DYNAMO ERROR: ',
+      `\nMISSING DynamoNTSDataPropertyParams constructor input at "testKey" in ` +
+        `"testDataName" model.` +
+      `\n stackLocation: WHAT`
+    );
+  });
+
+  xit('should return correct BEType based on type', () => {
+    const settings: DyFM_DataProperty_Settings<any, any> = {
+      type: DyFM_BasicProperty_Type.string
+    };
+    const instance = new DyFM_DataProperty_Params(settings, { dataName: 'testDataName' } as any);
+    expect(instance.getBEType()).toBe(String);
+
+    settings.type = DyFM_BasicProperty_Type.number;
+    expect(instance.getBEType()).toBe(Number);
+
+    settings.type = DyFM_BasicProperty_Type.boolean;
+    expect(instance.getBEType()).toBe(Boolean);
+
+    settings.type = DyFM_BasicProperty_Type.date;
+    expect(instance.getBEType()).toBe(Date);
+
+    settings.type = DyFM_BasicProperty_Type.object;
+    expect(instance.getBEType()).toBe(Object);
+
+    settings.type = 'customType[]';
+    expect(instance.getBEType()).toBe(Array);
+
+    settings.type = 'customFunction =>';
+    expect(instance.getBEType()).toBe(Function);
+  });
+});

package/src/_models/control-models/data-property-params.control-model.ts

@@ -1,201 +1,201 @@
-import { DyFM_Log } from '../../_collections/utils/log.util';
-import { DyFM_getConstructionStackLocation } from '../../_collections/utils/stack.util';
-import { DyFM_BasicProperty_Type } from '../../_enums/basic-property-type.enum';
-import { DyFM_OAI_EmbeddingModel } from '../../_modules/ai/_modules/open-ai/_enums/oai-model.enum';
-import { DyFM_DataModel_Params } from './data-model-params.control-model';
-
-export type DyFM_DataProperties<T_Data> = {
-  [K in keyof T_Data]: DyFM_DataProperty_Params<T_Data[K], T_Data>;
-}
-
-/* export type DyFM_DataPropertySettings<T = any> = DyFM_DataProperty_Settings<T>; */
-
-export class DyFM_DataProperty_Settings<T_Property, T_Data>{
-  key?: string;
-  type!: DyFM_BasicProperty_Type | string;
-  nonBasicType?: string;
-  default?: T_Property;
-
-  unique?: boolean;
-  readonly?: boolean;
-  required?: boolean;
-  index?: boolean;
-  forbidden?: boolean;
-
-  /* isDependencyHook?: boolean; */
-  /**
-   * This will be used to prehook dependency db service to data service by 
-   * dataName from dependency data's DyNTS_DataPropertyParams
-   * Use the dependency data's DyNTS_DataPropertyParams.
-   * 
-   * @example
-   * accountId: { dependencyName: accountModelParams.dataName }
-   */
-  dependencyDataName?: string;
-  archiveable?: boolean;
-  archiveListAfter?: number;
-
-  /**
-   * If only one property is set, it will be vectorized from that property directly.
-   * 
-   * If multiple properties are set, they will be merged into a stringified JSON object, 
-   * with the given properties.
-   */
-  vectorizedFrom?: string[];
-  /* vectorizeTo?: string; */
-  embeddingModel?: string; // DyFM_OAI_EmbeddingModel;
-  /**
-   * If true, the property will be vectorized always, even if the property is already vectorized.
-   */
-  vectorizeAlways?: boolean;
-  /** 
-   * This is the name of the index created in the DB (in the Atlas)
-   * 
-   * @example
-   * ```json
-   * {
-   *   "fields": [
-   *     {
-   *       "type": "vector",
-   *       "path": "contentVectorized",
-   *       "numDimensions": 3072,
-   *       "similarity": "cosine"
-   *     }
-   *   ]
-   * }
-   * ```
-   */
-  vectorizeUseIndex?: string;
-
-  minlength?: number;
-  maxlength?: number;
-
-  subObjectParams?: DyFM_DataProperties<any>;
-
-  additionalValidators?: ((propertyValue: T_Property, data: T_Data) => void)[];
-}
-
-
-/* export type DyFM_DataPropertyParams<T> = DyFM_DataProperty_Params<T>;
-export type DyFM_DPropPs<T> = DyFM_DataProperty_Params<T>; */
-/**
- * This will be used for setting up db. 
- * DataServices also uses this to prehook tools, as db service and dependency db service.
- * 
- * @example
- * ```ts
- * const params: DyFM_DataProperty_Params<string, any> = new DyFM_DataProperty_Params({
- *   key: 'name',
- *   type: DyFM_BasicProperty_Type.string,
- * });
- * ```
- */
-export class DyFM_DataProperty_Params<T_Property, T_Data> extends DyFM_DataProperty_Settings<T_Property, T_Data> {
-
-  /* override subObjectParams?: DyFM_DataProperty_Params<>[] = []; */
-  /* override subObjectParams?: DyFM_Data_Params<T> = {}; */
-
-  override additionalValidators?: ((propertyValue: T_Property, data: T_Data) => void)[] = [];
-
-  constructor(
-    set: DyFM_DataProperty_Settings<T_Property, T_Data>,
-    parentDataParams?: DyFM_DataModel_Params<any>,
-  ) {
-    super();
-    
-    if (set) {
-      if (!set.type && !set.forbidden) {
-        DyFM_Log.error(
-          'DYNAMO ERROR: ',
-          `\n type is missing from DynamoNTSDataPropertyParams at "${set.key}" in ` +
-            `"${parentDataParams?.dataName}" model.` +
-          `\n stackLocation: ${DyFM_getConstructionStackLocation(2)}`
-        );
-      }
-
-      if (set.dependencyDataName) {
-        if (set.required === false) {
-          DyFM_Log.warn(
-            'DYNAMO WARNING: ',
-            `\n required is not recommended to be false if dependency is set at "${set.key}" in ` +
-            `"${parentDataParams?.dataName}" model.` +
-            `\n stackLocation: ${DyFM_getConstructionStackLocation(2)}`
-          );
-        } else if (set.required === undefined) {
-          DyFM_Log.warn(
-            'DYNAMO WARNING: ',
-            `\n required is recommended to be set if dependency is set at "${set.key}" in ` +
-              `"${parentDataParams?.dataName}" model.` +
-            `\n   (it is required or it is not a dependency)` +
-            `\n It will be set to true by while you are not setting it. ` +
-            `\n stackLocation: ${DyFM_getConstructionStackLocation(2)}`
-          );
-          set.required = true;
-        }
-      }
-
-      if (set.vectorizedFrom) {
-        if (set.index) {
-          DyFM_Log.warn(
-            'DYNAMO WARNING: ',
-            `\n vectorizedFrom and index are not recommended to be set at the same time at "${set.key}" in ` +
-              `"${parentDataParams?.dataName}" model.` +
-            `\n It will be set to false by while you are not setting it. ` +
-            `\n stackLocation: ${DyFM_getConstructionStackLocation(2)}`
-          );
-
-          set.index = false;
-        }
-        
-        if (!set.vectorizeUseIndex) {
-          DyFM_Log.S_warn(
-            'DYNAMO WARNING: ',
-            `\n vectorizeUseIndex is required if vectorizedFrom is set at "${set.key}" in ` +
-              `"${parentDataParams?.dataName}" model. (It will be set to "${set.key}" by default)` +
-            `\n stackLocation: ${DyFM_getConstructionStackLocation(2)}`
-          );
-          set.vectorizeUseIndex = set.key;
-        }
-      }
-      
-      Object.assign(this, set);
-    } else {
-      DyFM_Log.error(
-        'DYNAMO ERROR: ',
-        `\nMISSING DynamoNTSDataPropertyParams constructor input at "${this.key}"!` +
-        `\n stackLocation: ${DyFM_getConstructionStackLocation(2)}`
-      );
-    }
-  }
-
-  constructed?(): boolean { 
-    return true; 
-  }
-
-  // tslint:disable-next-line: ban-types
-  getBEType?(): string | number | boolean | object | Function | Array<any> | Date {
-    switch (this.type) {
-      case DyFM_BasicProperty_Type.string:
-        return String;
-
-      case DyFM_BasicProperty_Type.number:
-        return Number;
-
-      case DyFM_BasicProperty_Type.boolean:
-        return Boolean;
-
-      case DyFM_BasicProperty_Type.date:
-        return Date;
-
-      case DyFM_BasicProperty_Type.object:
-      default:
-        if (this.type?.includes('[]')) {
-          return Array;
-        } else if (this.type?.includes('=>') || this.type?.includes('function')) {
-          return Function;
-        } else {
-          return Object;
-        }
-    }
-  }
-}
+import { DyFM_Log } from '../../_collections/utils/log.util';
+import { DyFM_getConstructionStackLocation } from '../../_collections/utils/stack.util';
+import { DyFM_BasicProperty_Type } from '../../_enums/basic-property-type.enum';
+import { DyFM_OAI_EmbeddingModel } from '../../_modules/ai/_modules/open-ai/_enums/oai-model.enum';
+import { DyFM_DataModel_Params } from './data-model-params.control-model';
+
+export type DyFM_DataProperties<T_Data> = {
+  [K in keyof T_Data]: DyFM_DataProperty_Params<T_Data[K], T_Data>;
+}
+
+/* export type DyFM_DataPropertySettings<T = any> = DyFM_DataProperty_Settings<T>; */
+
+export class DyFM_DataProperty_Settings<T_Property, T_Data>{
+  key?: string;
+  type!: DyFM_BasicProperty_Type | string;
+  nonBasicType?: string;
+  default?: T_Property;
+
+  unique?: boolean;
+  readonly?: boolean;
+  required?: boolean;
+  index?: boolean;
+  forbidden?: boolean;
+
+  /* isDependencyHook?: boolean; */
+  /**
+   * This will be used to prehook dependency db service to data service by 
+   * dataName from dependency data's DyNTS_DataPropertyParams
+   * Use the dependency data's DyNTS_DataPropertyParams.
+   * 
+   * @example
+   * accountId: { dependencyName: accountModelParams.dataName }
+   */
+  dependencyDataName?: string;
+  archiveable?: boolean;
+  archiveListAfter?: number;
+
+  /**
+   * If only one property is set, it will be vectorized from that property directly.
+   * 
+   * If multiple properties are set, they will be merged into a stringified JSON object, 
+   * with the given properties.
+   */
+  vectorizedFrom?: string[];
+  /* vectorizeTo?: string; */
+  embeddingModel?: string; // DyFM_OAI_EmbeddingModel;
+  /**
+   * If true, the property will be vectorized always, even if the property is already vectorized.
+   */
+  vectorizeAlways?: boolean;
+  /** 
+   * This is the name of the index created in the DB (in the Atlas)
+   * 
+   * @example
+   * ```json
+   * {
+   *   "fields": [
+   *     {
+   *       "type": "vector",
+   *       "path": "contentVectorized",
+   *       "numDimensions": 3072,
+   *       "similarity": "cosine"
+   *     }
+   *   ]
+   * }
+   * ```
+   */
+  vectorizeUseIndex?: string;
+
+  minlength?: number;
+  maxlength?: number;
+
+  subObjectParams?: DyFM_DataProperties<any>;
+
+  additionalValidators?: ((propertyValue: T_Property, data: T_Data) => void)[];
+}
+
+
+/* export type DyFM_DataPropertyParams<T> = DyFM_DataProperty_Params<T>;
+export type DyFM_DPropPs<T> = DyFM_DataProperty_Params<T>; */
+/**
+ * This will be used for setting up db. 
+ * DataServices also uses this to prehook tools, as db service and dependency db service.
+ * 
+ * @example
+ * ```ts
+ * const params: DyFM_DataProperty_Params<string, any> = new DyFM_DataProperty_Params({
+ *   key: 'name',
+ *   type: DyFM_BasicProperty_Type.string,
+ * });
+ * ```
+ */
+export class DyFM_DataProperty_Params<T_Property, T_Data> extends DyFM_DataProperty_Settings<T_Property, T_Data> {
+
+  /* override subObjectParams?: DyFM_DataProperty_Params<>[] = []; */
+  /* override subObjectParams?: DyFM_Data_Params<T> = {}; */
+
+  override additionalValidators?: ((propertyValue: T_Property, data: T_Data) => void)[] = [];
+
+  constructor(
+    set: DyFM_DataProperty_Settings<T_Property, T_Data>,
+    parentDataParams?: DyFM_DataModel_Params<any>,
+  ) {
+    super();
+    
+    if (set) {
+      if (!set.type && !set.forbidden) {
+        DyFM_Log.error(
+          'DYNAMO ERROR: ',
+          `\n type is missing from DynamoNTSDataPropertyParams at "${set.key}" in ` +
+            `"${parentDataParams?.dataName}" model.` +
+          `\n stackLocation: ${DyFM_getConstructionStackLocation(2)}`
+        );
+      }
+
+      if (set.dependencyDataName) {
+        if (set.required === false) {
+          DyFM_Log.warn(
+            'DYNAMO WARNING: ',
+            `\n required is not recommended to be false if dependency is set at "${set.key}" in ` +
+            `"${parentDataParams?.dataName}" model.` +
+            `\n stackLocation: ${DyFM_getConstructionStackLocation(2)}`
+          );
+        } else if (set.required === undefined) {
+          DyFM_Log.warn(
+            'DYNAMO WARNING: ',
+            `\n required is recommended to be set if dependency is set at "${set.key}" in ` +
+              `"${parentDataParams?.dataName}" model.` +
+            `\n   (it is required or it is not a dependency)` +
+            `\n It will be set to true by while you are not setting it. ` +
+            `\n stackLocation: ${DyFM_getConstructionStackLocation(2)}`
+          );
+          set.required = true;
+        }
+      }
+
+      if (set.vectorizedFrom) {
+        if (set.index) {
+          DyFM_Log.warn(
+            'DYNAMO WARNING: ',
+            `\n vectorizedFrom and index are not recommended to be set at the same time at "${set.key}" in ` +
+              `"${parentDataParams?.dataName}" model.` +
+            `\n It will be set to false by while you are not setting it. ` +
+            `\n stackLocation: ${DyFM_getConstructionStackLocation(2)}`
+          );
+
+          set.index = false;
+        }
+        
+        if (!set.vectorizeUseIndex) {
+          DyFM_Log.S_warn(
+            'DYNAMO WARNING: ',
+            `\n vectorizeUseIndex is required if vectorizedFrom is set at "${set.key}" in ` +
+              `"${parentDataParams?.dataName}" model. (It will be set to "${set.key}" by default)` +
+            `\n stackLocation: ${DyFM_getConstructionStackLocation(2)}`
+          );
+          set.vectorizeUseIndex = set.key;
+        }
+      }
+      
+      Object.assign(this, set);
+    } else {
+      DyFM_Log.error(
+        'DYNAMO ERROR: ',
+        `\nMISSING DynamoNTSDataPropertyParams constructor input at "${this.key}"!` +
+        `\n stackLocation: ${DyFM_getConstructionStackLocation(2)}`
+      );
+    }
+  }
+
+  constructed?(): boolean { 
+    return true; 
+  }
+
+  // tslint:disable-next-line: ban-types
+  getBEType?(): string | number | boolean | object | Function | Array<any> | Date {
+    switch (this.type) {
+      case DyFM_BasicProperty_Type.string:
+        return String;
+
+      case DyFM_BasicProperty_Type.number:
+        return Number;
+
+      case DyFM_BasicProperty_Type.boolean:
+        return Boolean;
+
+      case DyFM_BasicProperty_Type.date:
+        return Date;
+
+      case DyFM_BasicProperty_Type.object:
+      default:
+        if (this.type?.includes('[]')) {
+          return Array;
+        } else if (this.type?.includes('=>') || this.type?.includes('function')) {
+          return Function;
+        } else {
+          return Object;
+        }
+    }
+  }
+}