@futdevpro/fsm-dynamo 1.16.7 → 1.16.9

package/src/_models/types/db-filter.type.ts

@@ -1,110 +1,110 @@
-
-/**
- * @example 
- * // by email: 
- * { email: email }
- * //
- * @example 
- * // or by id that is in list:
- * { userIds: { $in: this.userId } }
- * //
- * @example 
- * // or by userIds:
- * { userId: { $in: userIds } }
- * //
- * @example 
- * // or by number or Date that is Greater Than AND Less Than:
- * { points: { $gt: 2, $lt: 14 } }
- * // further tools (syntax matches with $gt):
- * $eq:  // Matches values that are EQual to a specified value.
- * $gte: // Matches values that are Greater Than OR Equal to a specified value.
- * $lte: // Matches values that are Less Than or Equal to a specified value.
- * $ne:  // Matches all values that are Not Equal to a specified value.
- * $nin: // Matches None of the values specified IN an array.
- * //
- * @returns {T} data: T
- */
-export type DyFM_DBFilter<T> = 
-  DyFM_DBFilterSimple<T> | 
-  DyFM_DBFilterOR<T> |
-  DyFM_DBFilterNOR<T>;
-
-/**
- * A simple filter for a DynamoDB query.
- */
-export type DyFM_DBFilterSimple<T> = {
-  [K in keyof T]?: T[K] | DyFM_DBFilterExpressions<T[K] | boolean>;
-} & {
-  [path: string]: any;
-};
-
-export type DyFM_DBFilterExpressions<T> = { 
-  /**
-   * Matches values that are includes the value; This works only when T[K] is an array!
-   */
-  $in?: T | T[] | any,
-  /**
-   * Matches values that are EQual to a specified value.
-   */
-  $eq?: T,
-  /**
-   * Matches values that are Greater Than a specified value.
-   */
-  $gt?: number | Date,
-  /**
-   * Matches values that are Greater Than OR Equal to a specified value.
-   */
-  $gte?: number | Date,
-  /**
-   * Matches values that are Less Than a specified value.
-   */
-  $lt?: number | Date,
-  /**
-   * Matches values that are Less Than or Equal to a specified value.
-   */
-  $lte?: number | Date,
-  /**
-   * Matches all values that are Not Equal to a specified value.
-   */
-  $ne?: any,
-  /**
-   * Matches None of the values specified IN an array.
-   */
-  $nin?: T | T[] | any,
-  /**
-   * Inverts the effect of a query expression and returns documents that do not match the query expression.
-   */
-  $not?: T | {
-    $regex?: RegExp | string,
-  },
-  /**
-   * Performs a regular expression on the field's value, and selects documents that match the regular expression.
-   */
-  $exists?: boolean,
-  /**
-   * Selects documents if a field is of the specified type.
-   */
-  $type?: string,
-};
-
-/**
- * Joins query clauses with a logical AND returns all documents that match the conditions of both clauses.
- */
-export type DyFM_DBFilterNOR<T> = {
-  /**
-   * Joins query clauses with a logical NOR returns all documents that fail to match both clauses.
-   */
-  $nor: DyFM_DBFilterSimple<T>[];
-}
-
-/**
- * Joins query clauses with a logical AND returns all documents that match the conditions of both clauses.
- */
-export type DyFM_DBFilterOR<T> = {
-  /**
-   * Joins query clauses with a logical OR returns all documents that match the conditions of either clause.
-   */
-  $or: DyFM_DBFilterSimple<T>[];
-}
-
-
+
+/**
+ * @example 
+ * // by email: 
+ * { email: email }
+ * //
+ * @example 
+ * // or by id that is in list:
+ * { userIds: { $in: this.userId } }
+ * //
+ * @example 
+ * // or by userIds:
+ * { userId: { $in: userIds } }
+ * //
+ * @example 
+ * // or by number or Date that is Greater Than AND Less Than:
+ * { points: { $gt: 2, $lt: 14 } }
+ * // further tools (syntax matches with $gt):
+ * $eq:  // Matches values that are EQual to a specified value.
+ * $gte: // Matches values that are Greater Than OR Equal to a specified value.
+ * $lte: // Matches values that are Less Than or Equal to a specified value.
+ * $ne:  // Matches all values that are Not Equal to a specified value.
+ * $nin: // Matches None of the values specified IN an array.
+ * //
+ * @returns {T} data: T
+ */
+export type DyFM_DBFilter<T> = 
+  DyFM_DBFilterSimple<T> | 
+  DyFM_DBFilterOR<T> |
+  DyFM_DBFilterNOR<T>;
+
+/**
+ * A simple filter for a DynamoDB query.
+ */
+export type DyFM_DBFilterSimple<T> = {
+  [K in keyof T]?: T[K] | DyFM_DBFilterExpressions<T[K] | boolean>;
+} & {
+  [path: string]: any;
+};
+
+export type DyFM_DBFilterExpressions<T> = { 
+  /**
+   * Matches values that are includes the value; This works only when T[K] is an array!
+   */
+  $in?: T | T[] | any,
+  /**
+   * Matches values that are EQual to a specified value.
+   */
+  $eq?: T,
+  /**
+   * Matches values that are Greater Than a specified value.
+   */
+  $gt?: number | Date,
+  /**
+   * Matches values that are Greater Than OR Equal to a specified value.
+   */
+  $gte?: number | Date,
+  /**
+   * Matches values that are Less Than a specified value.
+   */
+  $lt?: number | Date,
+  /**
+   * Matches values that are Less Than or Equal to a specified value.
+   */
+  $lte?: number | Date,
+  /**
+   * Matches all values that are Not Equal to a specified value.
+   */
+  $ne?: any,
+  /**
+   * Matches None of the values specified IN an array.
+   */
+  $nin?: T | T[] | any,
+  /**
+   * Inverts the effect of a query expression and returns documents that do not match the query expression.
+   */
+  $not?: T | {
+    $regex?: RegExp | string,
+  },
+  /**
+   * Performs a regular expression on the field's value, and selects documents that match the regular expression.
+   */
+  $exists?: boolean,
+  /**
+   * Selects documents if a field is of the specified type.
+   */
+  $type?: string,
+};
+
+/**
+ * Joins query clauses with a logical AND returns all documents that match the conditions of both clauses.
+ */
+export type DyFM_DBFilterNOR<T> = {
+  /**
+   * Joins query clauses with a logical NOR returns all documents that fail to match both clauses.
+   */
+  $nor: DyFM_DBFilterSimple<T>[];
+}
+
+/**
+ * Joins query clauses with a logical AND returns all documents that match the conditions of both clauses.
+ */
+export type DyFM_DBFilterOR<T> = {
+  /**
+   * Joins query clauses with a logical OR returns all documents that match the conditions of either clause.
+   */
+  $or: DyFM_DBFilterSimple<T>[];
+}
+
+

package/src/_models/types/db-sort.type.ts

@@ -1,5 +1,5 @@
-
-
-export type DyFM_DBSort<T> = {
-  [K in keyof T]?: 1 | -1 | 'asc' | 'desc' | 'ascending' | 'descending';
+
+
+export type DyFM_DBSort<T> = {
+  [K in keyof T]?: 1 | -1 | 'asc' | 'desc' | 'ascending' | 'descending';
 }

package/src/_models/types/ds-filter.type.ts

@@ -1,68 +1,68 @@
-
-
-import { DyFM_BasicProperty_Type } from '../../_enums/basic-property-type.enum';
-import { DyFM_RangeValue } from '../control-models/range-value.control-model';
-import { DyFM_DBFilterExpressions } from './db-filter.type';
-
-/**
- * A filter for a DynamoDB queries.
- * 
- * it should be the value, a range or an array of the searching values
- */
-export type DyFM_DSFilter<T> = {
-  [K in keyof T]?:  DyFM_DSFilterProperty<T, K>;
-};
-export type DyFM_DSFilterProperty<T, K extends keyof T> =  T[K] | 
-                                                            T[K][] | 
-                                                            DyFM_RangeValue<T[K]> | 
-                                                            DyFM_SpecialSearch<T[K]> | 
-                                                            DyFM_SpecialNestSearch |
-                                                            DyFM_DBFilterExpressions<T[K]>;
-
-export interface DyFM_SpecialSearch<T> {
-  isSpecialSearch: true;
-  searchValue: T | T[];
-  type: DyFM_SpecialSearch_Type;
-}
-
-/**
- * searches for a nested properties in the object
- */
-export interface DyFM_SpecialNestSearch {
-  isSpecialNestSearch: true;
-  nestedPropertySearches: DyFM_NestPropertySearch<any>[];
-}
-
-/**
- * can search for nested properties in arrays as well with the following syntax used in key:
- * nestKeys: [ 'arrayProperty', '*', 'nestedPropertySearch' ]
- */
-export interface DyFM_NestPropertySearch<T> {
-  nestKeys: string[];
-  valueType: DyFM_BasicProperty_Type;
-  search: T | 
-          T[] | 
-          DyFM_RangeValue<T> |
-          DyFM_SpecialSearch<T>;
-}
-
-export enum DyFM_SpecialSearch_Type {
-  /** 
-   * searches each word in the string, returns true if ANY word is found in ANY order
-   * */
-  stringListSearchAny = 'stringListSearchAny',
-  /** 
-   * searches each word in the string, returns true if ALL words are found in ANY order
-   * */
-  stringListSearch = 'stringListSearch',
-  /** 
-   * searches each word in the string, returns true if ALL words are found in the SAME order
-   * */
-  stringListSearchOrdered = 'stringListSearchOrdered',
-}
-
-
-
-
-
-
+
+
+import { DyFM_BasicProperty_Type } from '../../_enums/basic-property-type.enum';
+import { DyFM_RangeValue } from '../control-models/range-value.control-model';
+import { DyFM_DBFilterExpressions } from './db-filter.type';
+
+/**
+ * A filter for a DynamoDB queries.
+ * 
+ * it should be the value, a range or an array of the searching values
+ */
+export type DyFM_DSFilter<T> = {
+  [K in keyof T]?:  DyFM_DSFilterProperty<T, K>;
+};
+export type DyFM_DSFilterProperty<T, K extends keyof T> =  T[K] | 
+                                                            T[K][] | 
+                                                            DyFM_RangeValue<T[K]> | 
+                                                            DyFM_SpecialSearch<T[K]> | 
+                                                            DyFM_SpecialNestSearch |
+                                                            DyFM_DBFilterExpressions<T[K]>;
+
+export interface DyFM_SpecialSearch<T> {
+  isSpecialSearch: true;
+  searchValue: T | T[];
+  type: DyFM_SpecialSearch_Type;
+}
+
+/**
+ * searches for a nested properties in the object
+ */
+export interface DyFM_SpecialNestSearch {
+  isSpecialNestSearch: true;
+  nestedPropertySearches: DyFM_NestPropertySearch<any>[];
+}
+
+/**
+ * can search for nested properties in arrays as well with the following syntax used in key:
+ * nestKeys: [ 'arrayProperty', '*', 'nestedPropertySearch' ]
+ */
+export interface DyFM_NestPropertySearch<T> {
+  nestKeys: string[];
+  valueType: DyFM_BasicProperty_Type;
+  search: T | 
+          T[] | 
+          DyFM_RangeValue<T> |
+          DyFM_SpecialSearch<T>;
+}
+
+export enum DyFM_SpecialSearch_Type {
+  /** 
+   * searches each word in the string, returns true if ANY word is found in ANY order
+   * */
+  stringListSearchAny = 'stringListSearchAny',
+  /** 
+   * searches each word in the string, returns true if ALL words are found in ANY order
+   * */
+  stringListSearch = 'stringListSearch',
+  /** 
+   * searches each word in the string, returns true if ALL words are found in the SAME order
+   * */
+  stringListSearchOrdered = 'stringListSearchOrdered',
+}
+
+
+
+
+
+

package/src/_models/types/ds-sort.type.ts

@@ -1,21 +1,21 @@
-import { DyFM_BasicProperty_Type } from '../../_enums/basic-property-type.enum';
-
-
-
-export type DyFM_DSSort = DyFM_DSPropertySort | DyFM_DSNestedPropertySort;
-export interface DyFM_DSPropertySort {
-  key: string;
-  order: 1 | -1 | 'asc' | 'desc' | 'ascending' | 'descending';
-}
-
-export interface DyFM_DSNestedPropertySort {
-  isNestedPropertySort: true;
-  /** 
-   * the key to sort by   
-   * (can be an array that is used for sorting by nested properties)
-   */
-  nestKeys: string[];
-  valueType: DyFM_BasicProperty_Type;
-  order: 1 | -1 | 'asc' | 'desc' | 'ascending' | 'descending';
-}
-
+import { DyFM_BasicProperty_Type } from '../../_enums/basic-property-type.enum';
+
+
+
+export type DyFM_DSSort = DyFM_DSPropertySort | DyFM_DSNestedPropertySort;
+export interface DyFM_DSPropertySort {
+  key: string;
+  order: 1 | -1 | 'asc' | 'desc' | 'ascending' | 'descending';
+}
+
+export interface DyFM_DSNestedPropertySort {
+  isNestedPropertySort: true;
+  /** 
+   * the key to sort by   
+   * (can be an array that is used for sorting by nested properties)
+   */
+  nestKeys: string[];
+  valueType: DyFM_BasicProperty_Type;
+  order: 1 | -1 | 'asc' | 'desc' | 'ascending' | 'descending';
+}
+

package/src/_modules/ai/_collections/ai-model-ref.util.ts

@@ -1,88 +1,88 @@
-import { DyFM_AI_Provider } from '../_enums/ai-provider.enum';
-
-/**
- * AI modell hivatkozas formatum: {provider}:{model}
- *
- * Peldak: "open-ai:gpt-4o", "anthropic:claude-3-5-sonnet-latest", "fdp-ai:fdp-base-1"
- * A provider resz a DyFM_AI_Provider enum erteke, a model resz a provider sajat modell azonositoja.
- */
-export class DyFM_AI_ModelRef_Util {
-  /** az elvlaszto karakter a provider es modell kozott */
-  private static readonly separator: string = ':';
-
-  /** az osszes ervenyes provider ertek gyorstarhely */
-  private static readonly validProviders: Set<string> = new Set(
-    Object.values(DyFM_AI_Provider)
-  );
-
-  /**
-   * Osszeallitas provider + model -bol
-   * @param provider - AI provider enum ertek
-   * @param model - provider-specifikus modell azonosito
-   */
-  static create(provider: DyFM_AI_Provider, model: string): string {
-    return `${provider}${DyFM_AI_ModelRef_Util.separator}${model}`;
-  }
-
-  /**
-   * Szetbontas provider + model -re
-   * @param modelRef - formatum: {provider}:{model}
-   */
-  static parse(modelRef: string): { provider: DyFM_AI_Provider; model: string } {
-    const separatorIndex: number = modelRef.indexOf(DyFM_AI_ModelRef_Util.separator);
-
-    if (separatorIndex < 0) {
-      throw new Error(`Ervenytelen modelRef formatum: "${modelRef}" -- hianyzik a "${DyFM_AI_ModelRef_Util.separator}" elvlaszto`);
-    }
-
-    const provider: string = modelRef.substring(0, separatorIndex);
-    const model: string = modelRef.substring(separatorIndex + 1);
-
-    if (!DyFM_AI_ModelRef_Util.validProviders.has(provider)) {
-      throw new Error(`Ismeretlen AI provider: "${provider}" a modelRef-ben: "${modelRef}"`);
-    }
-
-    if (!model) {
-      throw new Error(`Ures modell azonosito a modelRef-ben: "${modelRef}"`);
-    }
-
-    return { provider: provider as DyFM_AI_Provider, model: model };
-  }
-
-  /**
-   * Provider kinyerese a modelRef-bol
-   * @param modelRef - formatum: {provider}:{model}
-   */
-  static getProvider(modelRef: string): DyFM_AI_Provider {
-    return DyFM_AI_ModelRef_Util.parse(modelRef).provider;
-  }
-
-  /**
-   * Model kinyerese a modelRef-bol
-   * @param modelRef - formatum: {provider}:{model}
-   */
-  static getModel(modelRef: string): string {
-    return DyFM_AI_ModelRef_Util.parse(modelRef).model;
-  }
-
-  /**
-   * Validalas -- ellenorzi, hogy a modelRef megfelel-e a {provider}:{model} formatumnak
-   * @param modelRef - a vizsgalando string
-   */
-  static isValid(modelRef: string): boolean {
-    if (!modelRef) {
-      return false;
-    }
-
-    const separatorIndex: number = modelRef.indexOf(DyFM_AI_ModelRef_Util.separator);
-
-    if (separatorIndex < 0) {
-      return false;
-    }
-
-    const provider: string = modelRef.substring(0, separatorIndex);
-    const model: string = modelRef.substring(separatorIndex + 1);
-
-    return DyFM_AI_ModelRef_Util.validProviders.has(provider) && !!model;
-  }
-}
+import { DyFM_AI_Provider } from '../_enums/ai-provider.enum';
+
+/**
+ * AI modell hivatkozas formatum: {provider}:{model}
+ *
+ * Peldak: "open-ai:gpt-4o", "anthropic:claude-3-5-sonnet-latest", "fdp-ai:fdp-base-1"
+ * A provider resz a DyFM_AI_Provider enum erteke, a model resz a provider sajat modell azonositoja.
+ */
+export class DyFM_AI_ModelRef_Util {
+  /** az elvlaszto karakter a provider es modell kozott */
+  private static readonly separator: string = ':';
+
+  /** az osszes ervenyes provider ertek gyorstarhely */
+  private static readonly validProviders: Set<string> = new Set(
+    Object.values(DyFM_AI_Provider)
+  );
+
+  /**
+   * Osszeallitas provider + model -bol
+   * @param provider - AI provider enum ertek
+   * @param model - provider-specifikus modell azonosito
+   */
+  static create(provider: DyFM_AI_Provider, model: string): string {
+    return `${provider}${DyFM_AI_ModelRef_Util.separator}${model}`;
+  }
+
+  /**
+   * Szetbontas provider + model -re
+   * @param modelRef - formatum: {provider}:{model}
+   */
+  static parse(modelRef: string): { provider: DyFM_AI_Provider; model: string } {
+    const separatorIndex: number = modelRef.indexOf(DyFM_AI_ModelRef_Util.separator);
+
+    if (separatorIndex < 0) {
+      throw new Error(`Ervenytelen modelRef formatum: "${modelRef}" -- hianyzik a "${DyFM_AI_ModelRef_Util.separator}" elvlaszto`);
+    }
+
+    const provider: string = modelRef.substring(0, separatorIndex);
+    const model: string = modelRef.substring(separatorIndex + 1);
+
+    if (!DyFM_AI_ModelRef_Util.validProviders.has(provider)) {
+      throw new Error(`Ismeretlen AI provider: "${provider}" a modelRef-ben: "${modelRef}"`);
+    }
+
+    if (!model) {
+      throw new Error(`Ures modell azonosito a modelRef-ben: "${modelRef}"`);
+    }
+
+    return { provider: provider as DyFM_AI_Provider, model: model };
+  }
+
+  /**
+   * Provider kinyerese a modelRef-bol
+   * @param modelRef - formatum: {provider}:{model}
+   */
+  static getProvider(modelRef: string): DyFM_AI_Provider {
+    return DyFM_AI_ModelRef_Util.parse(modelRef).provider;
+  }
+
+  /**
+   * Model kinyerese a modelRef-bol
+   * @param modelRef - formatum: {provider}:{model}
+   */
+  static getModel(modelRef: string): string {
+    return DyFM_AI_ModelRef_Util.parse(modelRef).model;
+  }
+
+  /**
+   * Validalas -- ellenorzi, hogy a modelRef megfelel-e a {provider}:{model} formatumnak
+   * @param modelRef - a vizsgalando string
+   */
+  static isValid(modelRef: string): boolean {
+    if (!modelRef) {
+      return false;
+    }
+
+    const separatorIndex: number = modelRef.indexOf(DyFM_AI_ModelRef_Util.separator);
+
+    if (separatorIndex < 0) {
+      return false;
+    }
+
+    const provider: string = modelRef.substring(0, separatorIndex);
+    const model: string = modelRef.substring(separatorIndex + 1);
+
+    return DyFM_AI_ModelRef_Util.validProviders.has(provider) && !!model;
+  }
+}

package/src/_modules/ai/_collections/ai-model-registry.util.spec.ts

@@ -1,37 +1,37 @@
-import { DyFM_AI_ModelRegistry_Util } from './ai-model-registry.util';
-import { DyFM_OAI_Models } from '../_modules/open-ai/_collections/oai-models.const';
-import { DyFM_OAI_Model } from '../_modules/open-ai/_enums/oai-model.enum';
-
-describe('| DyFM_AI_ModelRegistry_Util', (): void => {
-
-  describe('| findModelInfo', (): void => {
-    it('| should find a known model by id', (): void => {
-      const info = DyFM_AI_ModelRegistry_Util.findModelInfo(DyFM_OAI_Models, DyFM_OAI_Model.gpt55);
-
-      expect(info).toBeTruthy();
-      expect(info?.id).toBe(DyFM_OAI_Model.gpt55);
-    });
-
-    it('| should return undefined for an unknown id', (): void => {
-      const info = DyFM_AI_ModelRegistry_Util.findModelInfo(DyFM_OAI_Models, 'no-such-model');
-
-      expect(info).toBeUndefined();
-    });
-  });
-
-  describe('| modelSupportsTools', (): void => {
-    it('| should return true for a tool-capable chat model', (): void => {
-      expect(DyFM_AI_ModelRegistry_Util.modelSupportsTools(DyFM_OAI_Models, DyFM_OAI_Model.gpt55)).toBe(true);
-    });
-
-    it('| should return false for an embedding model', (): void => {
-      expect(
-        DyFM_AI_ModelRegistry_Util.modelSupportsTools(DyFM_OAI_Models, DyFM_OAI_Model.textEmbedding_3Small)
-      ).toBe(false);
-    });
-
-    it('| should return false for an unknown id (no assumption of tool support)', (): void => {
-      expect(DyFM_AI_ModelRegistry_Util.modelSupportsTools(DyFM_OAI_Models, 'no-such-model')).toBe(false);
-    });
-  });
-});
+import { DyFM_AI_ModelRegistry_Util } from './ai-model-registry.util';
+import { DyFM_OAI_Models } from '../_modules/open-ai/_collections/oai-models.const';
+import { DyFM_OAI_Model } from '../_modules/open-ai/_enums/oai-model.enum';
+
+describe('| DyFM_AI_ModelRegistry_Util', (): void => {
+
+  describe('| findModelInfo', (): void => {
+    it('| should find a known model by id', (): void => {
+      const info = DyFM_AI_ModelRegistry_Util.findModelInfo(DyFM_OAI_Models, DyFM_OAI_Model.gpt55);
+
+      expect(info).toBeTruthy();
+      expect(info?.id).toBe(DyFM_OAI_Model.gpt55);
+    });
+
+    it('| should return undefined for an unknown id', (): void => {
+      const info = DyFM_AI_ModelRegistry_Util.findModelInfo(DyFM_OAI_Models, 'no-such-model');
+
+      expect(info).toBeUndefined();
+    });
+  });
+
+  describe('| modelSupportsTools', (): void => {
+    it('| should return true for a tool-capable chat model', (): void => {
+      expect(DyFM_AI_ModelRegistry_Util.modelSupportsTools(DyFM_OAI_Models, DyFM_OAI_Model.gpt55)).toBe(true);
+    });
+
+    it('| should return false for an embedding model', (): void => {
+      expect(
+        DyFM_AI_ModelRegistry_Util.modelSupportsTools(DyFM_OAI_Models, DyFM_OAI_Model.textEmbedding_3Small)
+      ).toBe(false);
+    });
+
+    it('| should return false for an unknown id (no assumption of tool support)', (): void => {
+      expect(DyFM_AI_ModelRegistry_Util.modelSupportsTools(DyFM_OAI_Models, 'no-such-model')).toBe(false);
+    });
+  });
+});