@futdevpro/fsm-dynamo 1.15.18 → 1.15.20

package/src/_models/control-models/service-endpoint-settings-base.control-model.ts

@@ -1,187 +1,187 @@
-import { DyFM_getConstructionStackLocation } from '../../_collections/utils/stack.util';
-import { DyFM_HttpCallType } from '../../_enums/http/http-call-type.enum';
-
-/* class Flow {
-  id: string;
-  userId: string;
-  name: string;
-}
-
-class SomethingElse {
-  idddd: string;
-  userIdddd: string;
-  nameeee: string;
-}
- */
-
-
-export interface DyFM_EndpointTypesContainer<
-  T_Result,
-  //T_Inputs extends DyFM_API_Input<any>[] = [],
-  T_Inputs extends any[] = [],
-  T_Body = undefined
-> {
-  resultType: T_Result;
-  inputTypes: T_Inputs;
-  bodyType: T_Body;
-}
-export type DyFM_ServiceEndpointTypesSettings = {
-  [key: string]: DyFM_EndpointTypesContainer<unknown, any, unknown>;
-}
-
-/**
- * A class that represents the settings of a service endpoint.
- * 
- * @example
- * ```ts
- * const endpointSettings: DyFM_Endpoint_SettingsBase<string, [string], undefined> = new DyFM_Endpoint_SettingsBase({
- *   name: 'myEndpoint',
- *   type: DyFM_HttpCallType.get,
- *   endpoint: '/get/:id',
- * });
- * ```
- */
-export class DyFM_Endpoint_SettingsBase<T_Result, I_Inputs, T_Body> {
-  name?: string;
-  type?: DyFM_HttpCallType;
-  endpoint?: string;
-
-  pathParamKeys?: string[] = [];
-
-  constructor(
-    set: DyFM_Endpoint_SettingsBase<T_Result, I_Inputs, T_Body>
-  ) {
-    if (!set.endpoint) {
-      throw new Error(
-        `endpoint not setted up for this endpoint (${set.name ?? DyFM_getConstructionStackLocation()})`
-      );
-    }
-
-    if (set.endpoint.includes('{')) {
-      console.warn(
-        `using {param} brackets in endpoint definitions will be deprecated... ` +
-        `\nuse :param instead ({pathParam} --> :pathParam) (${set.name})`
-      );
-      set.endpoint = set.endpoint.replace(/{/g, ':').replace(/}/g, '');
-    }
-
-    Object.assign(this, set);
-    
-    this.pathParamKeys = this.endpoint.split('/').filter(
-      (part: string): boolean => part.startsWith(':')
-    ).map(
-      (part: string): string => part.replace(':', '')
-    );
-  }
-}
-export type DyFM_ServiceEndpoint_SettingsBase<T extends DyFM_ServiceEndpointTypesSettings> = {
-  [K in keyof T]: DyFM_Endpoint_SettingsBase<T[K]['resultType'], T[K]['inputTypes'], T[K]['bodyType']>;
-}
-
-
-
-export class DyFM_ServerRoute_SettingsBase<
-  T_Result,
-  T_Inputs extends DyFM_API_Input<any>[] = [],
-  T_Body = undefined
-> extends DyFM_Endpoint_SettingsBase<T_Result, T_Inputs, T_Body> {
-
-  preProcesses: ((req: Request, res: Response) => Promise<void>)[];
-  /** this is the old way of setting up tasks, it will be deprecated in future (we want)
-   * @deprecated use simpleTask instead */
-  tasks?: ((req: Request, res: Response, issuer?: string, ...inputs: T_Inputs) => Promise<void>)[];
-  /**
-   * a simple task that is executed after the preProcesses
-   * this will automatically handle the API setup and this will be the TASK that will be executed 
-   * (result will be sent to the client, error will be caught and sent to the client)
-   */
-  simpleTask?: (...inputs: T_Inputs) => Promise<T_Result>;
-
-  constructor(
-    set: DyFM_ServerRoute_SettingsBase<T_Result, T_Inputs, T_Body>
-  ) {
-    super(set);
-
-    Object.assign(this, set);
-  }
-}
-
-export interface DyFM_API_Input<T_Input> {
-  type: DyFM_API_Input_Type;
-  value: T_Input;
-}
-
-export enum DyFM_API_Input_Type {
-  body = 'body',
-  queryParams = 'queryParams',
-}
-
-/* asdasd
-export class DyNX_ApiCall_Settings< 
-  T_Result, 
-  T_Inputs extends Array<any>, 
-  T_Body
-> extends DyFM_Endpoint_SettingsBase<T_Result, T_Inputs, T_Body> {
-  baseUrl?: string;
-
-  httpOptions?: any;
-
-  call?: (...inputs: T_Inputs) => Promise<T_Result>;
-
-  constructor(
-    set: DyNX_ApiCall_Settings<T_Result, T_Inputs, T_Body>
-  ) {
-    super(set);
-  }
-}
-export type DyNX_ApiService_Base<T extends DyFM_ServiceEndpointTypesSetting> = {
-  [K in keyof T]: DyNX_ApiCall_Settings<
-    T[K]['resultType'], T[K]['inputTypes'], T[K]['bodyType']
-  >
-} */
-
-
-
-/* 
-
-
-export interface Flow_EPResult_Settings333 extends DyFM_ServiceEndpointTypesSetting {
-  getFlow: DyFM_EndpointTypesContainer<Flow, [string], undefined>;
-  modifyFlow: DyFM_EndpointTypesContainer<Flow, [string, Flow], Flow>;
-  getFlowsByUserId: DyFM_EndpointTypesContainer<Flow[], [string], undefined>;
-}
-
-export class Flow_EP333 implements DyFM_ServiceEndpoint_SettingsBase<Flow_EPResult_Settings333> {
-  [key: string]: DyFM_Endpoint_SettingsBase<any, any, any>;
-
-  getFlow = new DyFM_Endpoint_SettingsBase({
-    type: DyFM_HttpCallType.get,
-    endpoint: '/get/:userId/:flowId',
-  });
-  modifyFlow = new DyFM_Endpoint_SettingsBase({
-    type: DyFM_HttpCallType.post,
-    endpoint: '/modify/:userId',
-  });
-  getFlowsByUserId = new DyFM_Endpoint_SettingsBase({
-    type: DyFM_HttpCallType.get,
-    endpoint: '/get-all-my/:userId',
-  });
-}
-const flow_EP333 = new Flow_EP333();
-
-export class Flow_API333 implements DyNX_ApiService_Base<Flow_EPResult_Settings333> {
-  [key: string]: DyNX_ApiCall_Settings<any, any, any>;
-
-  getFlow = new DyNX_ApiCall_Settings<Flow, [string], undefined>({
-    ...flow_EP333.getFlow,
-    call: async (id: string) => new Flow(),
-  });
-  modifyFlow = new DyNX_ApiCall_Settings<Flow, [string, Flow], Flow>({
-    ...flow_EP333.modifyFlow,
-    call: async (userId: string, flow: Flow) => new Flow(),
-  });
-  getFlowsByUserId = new DyNX_ApiCall_Settings<Flow[], [string], undefined>({
-    ...flow_EP333.getFlowsByUserId,
-    call: async (userId: string) => [new Flow()],
-  });
+import { DyFM_getConstructionStackLocation } from '../../_collections/utils/stack.util';
+import { DyFM_HttpCallType } from '../../_enums/http/http-call-type.enum';
+
+/* class Flow {
+  id: string;
+  userId: string;
+  name: string;
+}
+
+class SomethingElse {
+  idddd: string;
+  userIdddd: string;
+  nameeee: string;
+}
+ */
+
+
+export interface DyFM_EndpointTypesContainer<
+  T_Result,
+  //T_Inputs extends DyFM_API_Input<any>[] = [],
+  T_Inputs extends any[] = [],
+  T_Body = undefined
+> {
+  resultType: T_Result;
+  inputTypes: T_Inputs;
+  bodyType: T_Body;
+}
+export type DyFM_ServiceEndpointTypesSettings = {
+  [key: string]: DyFM_EndpointTypesContainer<unknown, any, unknown>;
+}
+
+/**
+ * A class that represents the settings of a service endpoint.
+ * 
+ * @example
+ * ```ts
+ * const endpointSettings: DyFM_Endpoint_SettingsBase<string, [string], undefined> = new DyFM_Endpoint_SettingsBase({
+ *   name: 'myEndpoint',
+ *   type: DyFM_HttpCallType.get,
+ *   endpoint: '/get/:id',
+ * });
+ * ```
+ */
+export class DyFM_Endpoint_SettingsBase<T_Result, I_Inputs, T_Body> {
+  name?: string;
+  type?: DyFM_HttpCallType;
+  endpoint?: string;
+
+  pathParamKeys?: string[] = [];
+
+  constructor(
+    set: DyFM_Endpoint_SettingsBase<T_Result, I_Inputs, T_Body>
+  ) {
+    if (!set.endpoint) {
+      throw new Error(
+        `endpoint not setted up for this endpoint (${set.name ?? DyFM_getConstructionStackLocation()})`
+      );
+    }
+
+    if (set.endpoint.includes('{')) {
+      console.warn(
+        `using {param} brackets in endpoint definitions will be deprecated... ` +
+        `\nuse :param instead ({pathParam} --> :pathParam) (${set.name})`
+      );
+      set.endpoint = set.endpoint.replace(/{/g, ':').replace(/}/g, '');
+    }
+
+    Object.assign(this, set);
+    
+    this.pathParamKeys = this.endpoint.split('/').filter(
+      (part: string): boolean => part.startsWith(':')
+    ).map(
+      (part: string): string => part.replace(':', '')
+    );
+  }
+}
+export type DyFM_ServiceEndpoint_SettingsBase<T extends DyFM_ServiceEndpointTypesSettings> = {
+  [K in keyof T]: DyFM_Endpoint_SettingsBase<T[K]['resultType'], T[K]['inputTypes'], T[K]['bodyType']>;
+}
+
+
+
+export class DyFM_ServerRoute_SettingsBase<
+  T_Result,
+  T_Inputs extends DyFM_API_Input<any>[] = [],
+  T_Body = undefined
+> extends DyFM_Endpoint_SettingsBase<T_Result, T_Inputs, T_Body> {
+
+  preProcesses: ((req: Request, res: Response) => Promise<void>)[];
+  /** this is the old way of setting up tasks, it will be deprecated in future (we want)
+   * @deprecated use simpleTask instead */
+  tasks?: ((req: Request, res: Response, issuer?: string, ...inputs: T_Inputs) => Promise<void>)[];
+  /**
+   * a simple task that is executed after the preProcesses
+   * this will automatically handle the API setup and this will be the TASK that will be executed 
+   * (result will be sent to the client, error will be caught and sent to the client)
+   */
+  simpleTask?: (...inputs: T_Inputs) => Promise<T_Result>;
+
+  constructor(
+    set: DyFM_ServerRoute_SettingsBase<T_Result, T_Inputs, T_Body>
+  ) {
+    super(set);
+
+    Object.assign(this, set);
+  }
+}
+
+export interface DyFM_API_Input<T_Input> {
+  type: DyFM_API_Input_Type;
+  value: T_Input;
+}
+
+export enum DyFM_API_Input_Type {
+  body = 'body',
+  queryParams = 'queryParams',
+}
+
+/* asdasd
+export class DyNX_ApiCall_Settings< 
+  T_Result, 
+  T_Inputs extends Array<any>, 
+  T_Body
+> extends DyFM_Endpoint_SettingsBase<T_Result, T_Inputs, T_Body> {
+  baseUrl?: string;
+
+  httpOptions?: any;
+
+  call?: (...inputs: T_Inputs) => Promise<T_Result>;
+
+  constructor(
+    set: DyNX_ApiCall_Settings<T_Result, T_Inputs, T_Body>
+  ) {
+    super(set);
+  }
+}
+export type DyNX_ApiService_Base<T extends DyFM_ServiceEndpointTypesSetting> = {
+  [K in keyof T]: DyNX_ApiCall_Settings<
+    T[K]['resultType'], T[K]['inputTypes'], T[K]['bodyType']
+  >
+} */
+
+
+
+/* 
+
+
+export interface Flow_EPResult_Settings333 extends DyFM_ServiceEndpointTypesSetting {
+  getFlow: DyFM_EndpointTypesContainer<Flow, [string], undefined>;
+  modifyFlow: DyFM_EndpointTypesContainer<Flow, [string, Flow], Flow>;
+  getFlowsByUserId: DyFM_EndpointTypesContainer<Flow[], [string], undefined>;
+}
+
+export class Flow_EP333 implements DyFM_ServiceEndpoint_SettingsBase<Flow_EPResult_Settings333> {
+  [key: string]: DyFM_Endpoint_SettingsBase<any, any, any>;
+
+  getFlow = new DyFM_Endpoint_SettingsBase({
+    type: DyFM_HttpCallType.get,
+    endpoint: '/get/:userId/:flowId',
+  });
+  modifyFlow = new DyFM_Endpoint_SettingsBase({
+    type: DyFM_HttpCallType.post,
+    endpoint: '/modify/:userId',
+  });
+  getFlowsByUserId = new DyFM_Endpoint_SettingsBase({
+    type: DyFM_HttpCallType.get,
+    endpoint: '/get-all-my/:userId',
+  });
+}
+const flow_EP333 = new Flow_EP333();
+
+export class Flow_API333 implements DyNX_ApiService_Base<Flow_EPResult_Settings333> {
+  [key: string]: DyNX_ApiCall_Settings<any, any, any>;
+
+  getFlow = new DyNX_ApiCall_Settings<Flow, [string], undefined>({
+    ...flow_EP333.getFlow,
+    call: async (id: string) => new Flow(),
+  });
+  modifyFlow = new DyNX_ApiCall_Settings<Flow, [string, Flow], Flow>({
+    ...flow_EP333.modifyFlow,
+    call: async (userId: string, flow: Flow) => new Flow(),
+  });
+  getFlowsByUserId = new DyNX_ApiCall_Settings<Flow[], [string], undefined>({
+    ...flow_EP333.getFlowsByUserId,
+    call: async (userId: string) => [new Flow()],
+  });
 } */

package/src/_models/data-models/errors.data-model.spec.ts

@@ -1,71 +1,71 @@
-import { DyFM_Errors } from './errors.data-model';
-import { DyFM_Error } from '../control-models/error.control-model';
-import { DyFM_ErrorLevel } from '../../_enums/error-level.enum';
-
-describe('| DyFM_Errors', (): void => {
-  it('| should create an instance without initial data', (): void => {
-    const errors = new DyFM_Errors<DyFM_Error>();
-
-    expect(errors).toBeTruthy();
-    expect(errors.flag).toBe('DyFM-ERRORS-OBJECT');
-    expect(errors.count).toBe(1);
-    expect(errors.duplications).toEqual([]);
-    expect(errors.__created).toBeInstanceOf(Date);
-    expect(errors.__lastModified).toBeInstanceOf(Date);
-  });
-
-  it('| should create an instance with initial data', (): void => {
-    const error = new DyFM_Error({
-      message: 'Test error',
-      errorCode: 'TEST-ERROR',
-    });
-
-    const initialData: DyFM_Errors<DyFM_Error> = {
-      source: 'test-source',
-      issuer: 'test-issuer',
-      username: 'test-user',
-      versions: ['1.0.0'],
-      localTime: '2023-01-01T00:00:00Z',
-      region: 'US',
-      message: 'Test error message',
-      exception: 'Test exception',
-      exceptionObj: { test: 'data' },
-      stackTrace: ['line1', 'line2'],
-      error: { test: 'error' },
-      count: 5,
-      d_error: error,
-      additionalContent: { extra: 'data' },
-      level: DyFM_ErrorLevel.error,
-      priority: 10,
-      duplications: [],
-    };
-
-    const errors = new DyFM_Errors<DyFM_Error>(initialData);
-
-    expect(errors.source).toBe('test-source');
-    expect(errors.issuer).toBe('test-issuer');
-    expect(errors.username).toBe('test-user');
-    expect(errors.versions).toEqual(['1.0.0']);
-    expect(errors.localTime).toBe('2023-01-01T00:00:00Z');
-    expect(errors.region).toBe('US');
-    expect(errors.message).toBe('Test error message');
-    expect(errors.exception).toBe('Test exception');
-    expect(errors.exceptionObj).toEqual({ test: 'data' });
-    expect(errors.stackTrace).toEqual(['line1', 'line2']);
-    expect(errors.error).toEqual({ test: 'error' });
-    expect(errors.count).toBe(5);
-    expect(errors.d_error).toEqual(error);
-    expect(errors.additionalContent).toEqual({ extra: 'data' });
-    expect(errors.level).toBe(DyFM_ErrorLevel.error);
-    expect(errors.priority).toBe(10);
-    expect(errors.duplications).toEqual([]);
-  });
-
-  it('| should have dataParams defined', (): void => {
-    const { DyFM_errors_dataParams } = require('./errors.data-model');
-
-    expect(DyFM_errors_dataParams).toBeTruthy();
-    expect(DyFM_errors_dataParams.dataName).toBe('errors');
-  });
-});
-
+import { DyFM_Errors } from './errors.data-model';
+import { DyFM_Error } from '../control-models/error.control-model';
+import { DyFM_ErrorLevel } from '../../_enums/error-level.enum';
+
+describe('| DyFM_Errors', (): void => {
+  it('| should create an instance without initial data', (): void => {
+    const errors = new DyFM_Errors<DyFM_Error>();
+
+    expect(errors).toBeTruthy();
+    expect(errors.flag).toBe('DyFM-ERRORS-OBJECT');
+    expect(errors.count).toBe(1);
+    expect(errors.duplications).toEqual([]);
+    expect(errors.__created).toBeInstanceOf(Date);
+    expect(errors.__lastModified).toBeInstanceOf(Date);
+  });
+
+  it('| should create an instance with initial data', (): void => {
+    const error = new DyFM_Error({
+      message: 'Test error',
+      errorCode: 'TEST-ERROR',
+    });
+
+    const initialData: DyFM_Errors<DyFM_Error> = {
+      source: 'test-source',
+      issuer: 'test-issuer',
+      username: 'test-user',
+      versions: ['1.0.0'],
+      localTime: '2023-01-01T00:00:00Z',
+      region: 'US',
+      message: 'Test error message',
+      exception: 'Test exception',
+      exceptionObj: { test: 'data' },
+      stackTrace: ['line1', 'line2'],
+      error: { test: 'error' },
+      count: 5,
+      d_error: error,
+      additionalContent: { extra: 'data' },
+      level: DyFM_ErrorLevel.error,
+      priority: 10,
+      duplications: [],
+    };
+
+    const errors = new DyFM_Errors<DyFM_Error>(initialData);
+
+    expect(errors.source).toBe('test-source');
+    expect(errors.issuer).toBe('test-issuer');
+    expect(errors.username).toBe('test-user');
+    expect(errors.versions).toEqual(['1.0.0']);
+    expect(errors.localTime).toBe('2023-01-01T00:00:00Z');
+    expect(errors.region).toBe('US');
+    expect(errors.message).toBe('Test error message');
+    expect(errors.exception).toBe('Test exception');
+    expect(errors.exceptionObj).toEqual({ test: 'data' });
+    expect(errors.stackTrace).toEqual(['line1', 'line2']);
+    expect(errors.error).toEqual({ test: 'error' });
+    expect(errors.count).toBe(5);
+    expect(errors.d_error).toEqual(error);
+    expect(errors.additionalContent).toEqual({ extra: 'data' });
+    expect(errors.level).toBe(DyFM_ErrorLevel.error);
+    expect(errors.priority).toBe(10);
+    expect(errors.duplications).toEqual([]);
+  });
+
+  it('| should have dataParams defined', (): void => {
+    const { DyFM_errors_dataParams } = require('./errors.data-model');
+
+    expect(DyFM_errors_dataParams).toBeTruthy();
+    expect(DyFM_errors_dataParams.dataName).toBe('errors');
+  });
+});
+