@futdevpro/fsm-dynamo 1.10.37 → 1.10.39

package/src/_collections/utils/type-cloning-facility.util.ts

@@ -1,4 +1,3 @@
-
 export type DyFM_TCF = DyFM_TypeCloningFacility;
 
 /** 
@@ -15,6 +14,14 @@ export type DyFM_TCF = DyFM_TypeCloningFacility;
  * */
 export class DyFM_TypeCloningFacility {
 
+  /**
+   * Clone an object
+   * @param object - The object to clone
+   * @param skip - An array of keys to skip
+   * @param affectedObjects - An array of objects that have already been cloned
+   * @param debug - Whether to log debug information
+   * @returns The cloned object
+   */
   static clone<T>(
     object: T, 
     skip: string[] = [], 
@@ -28,8 +35,8 @@ export class DyFM_TypeCloningFacility {
         console.log('clone DEBUG; key:', key);
       }
 
-      if (typeof object === 'object'/* object.hasOwnProperty(key) */) {
-        const type = typeof object[key];
+      if (object && typeof object === 'object'/* object.hasOwnProperty(key) */) {
+        const type: string = typeof object[key];
 
         if (skip.includes(key)) {
           continue;
@@ -44,7 +51,7 @@ export class DyFM_TypeCloningFacility {
             
           } else {
             const newAffectedObject: ObjectCollector = {
-              id: object[key]
+              id: object[key] as string
             };
 
             affectedObjects.push(newAffectedObject);
@@ -83,6 +90,14 @@ export class DyFM_TypeCloningFacility {
     return result;
   }
 
+  /**
+   * Clone an array
+   * @param array - The array to clone
+   * @param skip - An array of keys to skip
+   * @param affectedObjects - An array of objects that have already been cloned
+   * @param debug - Whether to log debug information
+   * @returns The cloned array
+   */
   static cloneArray<T>(
     array: T[],
     skip: string[] = [], 
@@ -107,13 +122,47 @@ export class DyFM_TypeCloningFacility {
     return result;
   }
 
-  storeCirculation // TODO stringifyable -------------------------------------------------------------------------------------------------------------------------------------------
+  /**
+   * Store the circulation of an object
+   * @param object - The object to store the circulation of
+   * @returns The serialized object
+   */
+  static storeCirculation(object: any): string {
+    const cache = new Map();
+    const result = JSON.stringify(object, (key, value) => {
+      if (typeof value === 'object' && value !== null) {
+        if (cache.has(value)) {
+          return `__cycle__${cache.get(value)}`;
+        }
+        cache.set(value, cache.size);
+      }
+      return value;
+    });
+    return result;
+  }
 
-  restoreCirculation // TODO stringified -------------------------------------------------------------------------------------------------------------------------------------------
+  /**
+   * Restore the circulation of an object
+   * @param serialized - The serialized object
+   * @returns The restored object
+   */
+  static restoreCirculation(serialized: string): any {
+    const cache = new Map();
+    const result = JSON.parse(serialized, (key, value) => {
+      if (typeof value === 'string' && value.startsWith('__cycle__')) {
+        return cache.get(parseInt(value.slice(9), 10));
+      }
+      if (typeof value === 'object' && value !== null) {
+        cache.set(cache.size, value);
+      }
+      return value;
+    });
+    return result;
+  }
 }
 
 interface ObjectCollector {
-  id;
-  clonedObject?;
+  id: string;
+  clonedObject?: any;
 }
 

package/src/_collections/utils/utilities.util.spec.ts

@@ -157,8 +157,8 @@ describe('| Utilities', () => {
 
   describe('| DyFM_JSONListify', () => {
     it('| should convert a JSON list to an array', () => {
-      const JSONList = { 0: 'a', 1: 'b', 2: 'c' };
-      const result = DyFM_JSONListify<string>(JSONList);
+      const JSONList: Record<string, string> = { 0: 'a', 1: 'b', 2: 'c' };
+      const result = DyFM_JSONListify<string>(JSONList as any as string[]);
       expect(result).toEqual(['a', 'b', 'c']);
     });
   });

package/src/_collections/utils/utilities.util.ts

@@ -8,6 +8,11 @@ const defaultErrorMsg =
   'contains object hooks for its own objects, therefore its creating an object loop. ' +
   'See further information in the detailed error:\n\n';
 
+/**
+ * Clone an object
+ * @param object - The object to clone
+ * @returns The cloned object
+ */
 export function DyFM_clone<T>(object: T): T {
   try {
     return object ? JSON.parse(JSON.stringify(object)) as T : object;
@@ -22,9 +27,14 @@ export function DyFM_clone<T>(object: T): T {
 }
 export const DyFM_copy = DyFM_clone;
 
-export function DyFM_surfaceClone<T>(object: T): T {
+/**
+ * Surface clone an object
+ * @param object - The object to surface clone
+ * @returns The surface cloned object
+ */
+export function DyFM_surfaceClone<T extends Record<string, any>>(object: T): T {
   try {
-    const result = {};
+    const result: Record<string, any> = {};
 
     Object.keys(object).forEach((key: string): void => {
       result[key] = object[key];
@@ -42,9 +52,14 @@ export function DyFM_surfaceClone<T>(object: T): T {
 }
 export const DyFM_surfaceCopy = DyFM_surfaceClone;
 
-export function DyFM_deepClone<T>(object: T): T {
+/**
+ * Deep clone an object
+ * @param object - The object to deep clone
+ * @returns The deep cloned object
+ */
+export function DyFM_deepClone<T extends Record<string, any>>(object: T): T {
   try {
-    const result = {};
+    const result: Record<string, any> = {};
     
     Object.keys(object).forEach((key: string): void => {
       if (typeof object[key] === 'object') {
@@ -141,6 +156,13 @@ export function DyFM_orderedSameObject<T>(objA: T, objB: T): boolean {
   }
 }
 
+/**
+ * We experienced that sameObjects() function is not working properly for cases when 
+ * deleting a key from the objects (to prevent strict results).
+ * 
+ * This function is created to prevent that issue.
+ * But be aware that this function is not as fast as sameObjects() function.
+ */
 export function DyFM_orderedSameObject2<T>(objA: T, objB: T): boolean {
   try {
     console.log('using orderedSameObject2');
@@ -175,6 +197,12 @@ export function DyFM_orderedSameObject2<T>(objA: T, objB: T): boolean {
   }
 }
 
+/**
+ * compares the surface of two objects
+ * @param objA 
+ * @param objB 
+ * @returns 
+ */
 export function DyFM_sameObjectSurface<T>(objA: T, objB: T): boolean {
   let result = true;
 
@@ -201,6 +229,11 @@ export function DyFM_setExistingValuesOnly(setOn: any, setTo: any): void {
   }
 }
 
+/**
+ * delays the execution of a function
+ * @param ms 
+ * @returns 
+ */
 export function DyFM_delay(ms: number): Promise<void> {
   return new Promise((resolve): any => setTimeout(resolve, ms));
 }
@@ -267,13 +300,16 @@ export function DyFM_takeUntil<T>(
       (value?: T): void => {
         if (check(value)) {
           sub.unsubscribe();
-          resolve(value);
+          resolve(value as T);
         }
       }
     );
   });
 }
 
+/**
+ * the return type of the sortForTrue function
+ */
 export type DyFM_SortDirection = 0 | 1 | -1
 
 /**
@@ -294,20 +330,37 @@ export function DyFM_sortForTrue<T>(
 ): DyFM_SortDirection {
   const isA = check(a);
 
-  return isA === check(b) ? 0 : isA ? -1 : 1;
+  if (isA === check(b)) {
+    return 0;
+  } else if (isA) {
+    return -1;
+  } else {
+    return 1;
+  }
 }
 
+/**
+ * returns a function that can be used to sort an array of objects
+ * sorts so that the objects that have the value true for the checkFor function are at the beginning of the array
+ * @param checkFor 
+ * @returns 
+ */
 export function DyFM_getSortForTrueFn<T>(
   checkFor: (a: T) => boolean
 ): (a: T, b: T) => DyFM_SortDirection {
   return (a: T, b: T): DyFM_SortDirection => DyFM_sortForTrue<T>(a, b, checkFor);
 }
 
-export function DyFM_JSONListify<T>(JSONList): T[] {
+/**
+ * converts a JSONList to an array
+ * @param JSONList 
+ * @returns 
+ */
+export function DyFM_JSONListify<T>(JSONList: any): T[] {
   const result: T[] = [];
 
   for (let i = 0; JSONList[i]; i++) {
-    result.push(JSONList[i] as T);
+    result.push(JSONList[i]);
   }
 
   return result; 

package/src/_collections/utils/uuid.util.ts

@@ -5,6 +5,11 @@ import * as UUID from 'uuid';
 export class DyFM_UUID {
   /* static readonly getUUID = UUID.v4; */
 
+  /**
+   * generates a UUID
+   * @param reserved - an array of reserved UUIDs
+   * @returns a UUID
+   */
   static generate(reserved?: string[]): string {
     let uuid = UUID.v4();
 

package/src/_enums/basic-property-type.enum.ts

@@ -1,6 +1,14 @@
 
 
 
+/**
+ * Basic property types used by the framework.
+ *
+ * @example
+ * ```ts
+ * const type: DyFM_BasicProperty_Type = DyFM_BasicProperty_Type.string;
+ * ```
+ */
 export enum DyFM_BasicProperty_Type {
   string = 'string',
   number = 'number',

package/src/_enums/data-model-type.enum.ts

@@ -2,17 +2,22 @@
 
 
 /**
- * DataModelType is declaring where the data type is used
- * 
- * data: used in DB
- * control: used only in runtime and needs a constructor
- * interface: used only in runtime and doesnt need constructor
+ * Indicates in which layer a given structure is used based on its model type.
+ *
+ * @example
+ * ```ts
+ * const type = DyFM_DataModel_Type.data;
+ * ```
  */
 export enum DyFM_DataModel_Type {
   data = 'data-model',
   control = 'control-model',
   interface = 'interface',
 }
-export const DyFM_allDataModelTypes: DyFM_DataModel_Type[] = 
+
+/**
+ * Array containing every available data model type.
+ */
+export const DyFM_allDataModelTypes: DyFM_DataModel_Type[] =
   Object.values(DyFM_DataModel_Type);
 

package/src/_enums/environment-flag.enum.ts

@@ -1,5 +1,15 @@
 
 
+/**
+ * Flags representing the runtime environment of the application.
+ *
+ * @example
+ * ```ts
+ * if (flag === DyFM_EnvironmentFlag.dev) {
+ *   console.log('Development environment');
+ * }
+ * ```
+ */
 export enum DyFM_EnvironmentFlag {
   local = 'local',
   dev = 'dev',
@@ -7,4 +17,12 @@ export enum DyFM_EnvironmentFlag {
   prod = 'prod',
 }
 
+/**
+ * Every available environment flag collected into an array.
+ *
+ * @example
+ * ```ts
+ * console.log(DyFM_allEnvironmentFlags);
+ * ```
+ */
 export const DyFM_allEnvironmentFlags = Object.values(DyFM_EnvironmentFlag);

package/src/_enums/error-level.enum.ts

@@ -2,6 +2,16 @@
 
 
 
+/**
+ * Severity levels used for logging and error handling.
+ *
+ * @example
+ * ```ts
+ * if (err.level === DyFM_ErrorLevel.warning) {
+ *   console.warn('Handle warning');
+ * }
+ * ```
+ */
 export enum DyFM_ErrorLevel {
   user = 'user',
   debug = 'debug',

package/src/_enums/http-call-type.enum.ts

@@ -1,7 +1,11 @@
 
 /**
- * basic Http Call Types such as;
- * get, post, put, patch, delete
+ * Basic HTTP request methods.
+ *
+ * @example
+ * ```ts
+ * const method: DyFM_HttpCallType = DyFM_HttpCallType.get;
+ * ```
  */
 export enum DyFM_HttpCallType {
   get = 'get',

package/src/_enums/http-response-type.enum.ts

@@ -1,4 +1,12 @@
 
+/**
+ * Expected payload type of an HTTP response.
+ *
+ * @example
+ * ```ts
+ * const responseType = DyFM_HttpResponseType.json;
+ * ```
+ */
 export enum DyFM_HttpResponseType {
   arraybuffer = 'arraybuffer',
   blob = 'blob',

package/src/_enums/log-style.enum.ts

@@ -1,6 +1,14 @@
 
 
 
+/**
+ * ANSI escape codes for console styling.
+ *
+ * @example
+ * ```ts
+ * console.log(DyFM_LogStyle.green + 'OK' + DyFM_LogStyle.reset);
+ * ```
+ */
 export enum DyFM_LogStyle {
   reset = '\x1b[0m',
 

package/src/_enums/time/day-of-week.enum.ts

@@ -2,6 +2,14 @@
 
 
 
+/**
+ * Names of the days of the week.
+ *
+ * @example
+ * ```ts
+ * const today = DyFM_DayOfWeek.monday;
+ * ```
+ */
 export enum DyFM_DayOfWeek {
   monday = 'monday',
   tuesday = 'tuesday',
@@ -12,10 +20,13 @@ export enum DyFM_DayOfWeek {
   sunday = 'sunday',
 }
 
+/**
+ * Every day of the week in an array.
+ */
 export const DyFM_allDaysOfWeek = Object.values(DyFM_DayOfWeek);
 
 
-/** stupid style */
+/** In U.S. order starting with Sunday */
 export const DyFM_allDaysOfWeekAmericanStyle = [
   DyFM_DayOfWeek.sunday,
   DyFM_DayOfWeek.monday,
@@ -26,5 +37,6 @@ export const DyFM_allDaysOfWeekAmericanStyle = [
   DyFM_DayOfWeek.saturday,
 ];
 
+/** Same as `DyFM_allDaysOfWeekAmericanStyle`. */
 export const DyFM_allDaysOfWeekStupid = DyFM_allDaysOfWeekAmericanStyle;
 

package/src/_enums/time/month.enum.ts

@@ -1,6 +1,14 @@
 
 
 
+/**
+ * Enumeration of calendar months.
+ *
+ * @example
+ * ```ts
+ * const month = DyFM_Month.january;
+ * ```
+ */
 export enum DyFM_Month {
   january = 'january',
   february = 'february',

package/src/_enums/time/relative-date.enum.ts

@@ -1,6 +1,16 @@
 
 
 
+/**
+ * Human readable identifiers for relative date ranges.
+ *
+ * @example
+ * ```ts
+ * if (range === DyFM_RelativeDate.lastWeek) {
+ *   // ...
+ * }
+ * ```
+ */
 export enum DyFM_RelativeDate {
   lastDay = 'lastDay',
   lastWeek = 'lastWeek',

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

@@ -5,20 +5,20 @@ import { DyFM_DataModel_Type } from '../../_enums/data-model-type.enum';
 import { DyFM_Metadata } from '../data-models/metadata.data-model';
 import { DyFM_DataProperties, DyFM_DataProperty_Params } from './data-property-params.control-model';
 
-export type DyFM_Data_S<T> = DyFM_DataModel_Settings<T>;
-export type DyFM_Data_Settings<T> = DyFM_DataModel_Settings<T>;
+export type DyFM_Data_S<T extends DyFM_Metadata> = DyFM_DataModel_Settings<T>;
+export type DyFM_Data_Settings<T extends DyFM_Metadata> = DyFM_DataModel_Settings<T>;
 export class DyFM_DataModel_Settings<T extends DyFM_Metadata> extends DyFM_Metadata {
   /** this will be used as db table name, therefore it should be in snake_case,
    * this also will be used in logs and errors
    */
-  dataName: string;
+  dataName!: string;
   modelType?: DyFM_DataModel_Type;
   addArchive?: boolean;
-  properties: DyFM_DataProperties<T>;
+  properties!: DyFM_DataProperties<T>;
 }
 
-export type DyFM_Data_P<T> = DyFM_DataModel_Params<T>;
-export type DyFM_Data_Params<T> = DyFM_DataModel_Params<T>;
+export type DyFM_Data_P<T extends DyFM_Metadata> = DyFM_DataModel_Params<T>;
+export type DyFM_Data_Params<T extends DyFM_Metadata> = DyFM_DataModel_Params<T>;
 export class DyFM_DataModel_Params<T extends DyFM_Metadata> extends DyFM_DataModel_Settings<T> {
   
   /* override properties?: DyFM_DataProperties<T>; */

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

@@ -11,7 +11,7 @@ export type DyFM_DataPropertySettings<T = any> = DyFM_DataProperty_Settings<T>;
 
 export class DyFM_DataProperty_Settings<T>{
   key?: string;
-  type: DyFM_BasicProperty_Type | string;
+  type!: DyFM_BasicProperty_Type | string;
   default?: T;
 
   unique?: boolean;

package/src/_models/control-models/error.control-model.spec.ts

@@ -2,7 +2,7 @@
 
 import { DyFM_error_defaults } from '../../_collections/constants/error-defaults.const';
 import { DyFM_Log } from '../../_collections/utils/log.util';
-import { DyFM_Error } from './error.control-model';
+import { DyFM_Error, DyFM_Error_Settings } from './error.control-model';
 
 function testFormatter(any: any): any {
   if (any instanceof Error) {
@@ -479,7 +479,7 @@ describe('| DyFM_Error;', (): void => {
   });
 
   describe('| should have get proper simplified;', (): void => {
-    let simplified;
+    let simplified: DyFM_Error_Settings;
 
     describe('| on error_0;', (): void => {
       beforeEach((): void => {

package/src/_models/interfaces/box-bounds.interface.ts

@@ -0,0 +1,8 @@
+import { DyFM_Vector2 } from './vector2.interface';
+
+export interface DyFM_BoxBounds {
+  pos: DyFM_Vector2;
+  size: DyFM_Vector2;
+  center: DyFM_Vector2;
+  centerMargin: DyFM_Vector2;
+}

package/src/_models/interfaces/environment/global-settings.interface.ts

@@ -9,6 +9,8 @@ import { DyFM_GlobalLog_Settings } from './global-log-settings.interface';
  * 
  */
 export interface DyFM_Global_Settings {
+  systemShortCodeName: string;
+  
   /**
    * this will be used as the main baseUrl for the application,
    * this is not required, but we suggest to use at least a '/api' as base route

package/src/_models/interfaces/route-settings.interface.ts

@@ -3,7 +3,12 @@ export type DyFM_Route_S<T> = DyFM_Route_Settings<T>;
 export interface DyFM_Route_Settings<T> {
   mainRoute: string;
 
-  /** TODO ezitten tökszar mert nem ellenőriz típust */
+  /**
+   * Mapping of route keys to their endpoint paths.
+   *
+   * The generic type is not fully enforced here, so make sure
+   * that the keys correspond to the enum provided for <T>.
+   */
   endPoints: {
     [key in T as string]: string
   };