@futdevpro/fsm-dynamo 1.15.18 → 1.15.20

package/src/_models/interfaces/search-result.interface.ts

@@ -1,6 +1,6 @@
-
-
-export interface DyFM_SearchResult<T> {
-  results: T[];
-  totalItems: number;
+
+
+export interface DyFM_SearchResult<T> {
+  results: T[];
+  totalItems: number;
 }

package/src/_models/interfaces/server-error-statistics.interface.ts

@@ -1,24 +1,24 @@
-
-
-export interface DyFM_Error_Statistics {
-  range?: string;
-
-  allErrors?: number;
-  allAllErrors?: number;
-
-  serverErrors?: number;
-  clientErrors?: number;
-  allServerErrors?: number;
-  allClientErrors?: number;
-
-  infoErrors?: number;
-  warningErrors?: number;
-  errorErrors?: number;
-  criticalErrors?: number;
-
-  allInfoErrors?: number;
-  allWarningErrors?: number;
-  allErrorErrors?: number;
-  allCriticalErrors?: number;
-}
-
+
+
+export interface DyFM_Error_Statistics {
+  range?: string;
+
+  allErrors?: number;
+  allAllErrors?: number;
+
+  serverErrors?: number;
+  clientErrors?: number;
+  allServerErrors?: number;
+  allClientErrors?: number;
+
+  infoErrors?: number;
+  warningErrors?: number;
+  errorErrors?: number;
+  criticalErrors?: number;
+
+  allInfoErrors?: number;
+  allWarningErrors?: number;
+  allErrorErrors?: number;
+  allCriticalErrors?: number;
+}
+

package/src/_models/interfaces/vector2.interface.ts

@@ -1,21 +1,21 @@
-
-
-
-
-
-/**
- * Represents a 2D vector with x and y coordinates
- * 
- * @see {@link DyFM_Vector2_Util} for utility functions
- * 
- * @example
- * ```ts
- * const vector: DyFM_Vector2 = { x: 10, y: 20 };
- * ```
- */
-export interface DyFM_Vector2 {
-  /** horizontal coordinate */
-  x: number;
-  /** vertical coordinate */
-  y: number;
+
+
+
+
+
+/**
+ * Represents a 2D vector with x and y coordinates
+ * 
+ * @see {@link DyFM_Vector2_Util} for utility functions
+ * 
+ * @example
+ * ```ts
+ * const vector: DyFM_Vector2 = { x: 10, y: 20 };
+ * ```
+ */
+export interface DyFM_Vector2 {
+  /** horizontal coordinate */
+  x: number;
+  /** vertical coordinate */
+  y: number;
 }

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';
+}
+