@futdevpro/fsm-dynamo 1.15.18 → 1.15.21

package/src/_models/control-models/server-status.control-model.spec.ts

@@ -1,66 +1,66 @@
-import { DyFM_ServerStatus } from './server-status.control-model';
-import { DyFM_ServerConnection_Status } from '../../_enums/server-connection-status.enum';
-
-describe('| DyFM_ServerStatus', (): void => {
-  it('| should create an instance without initial data', (): void => {
-    const serverStatus = new DyFM_ServerStatus();
-
-    expect(serverStatus).toBeTruthy();
-    expect(serverStatus.__created).toBeInstanceOf(Date);
-    expect(serverStatus.__lastModified).toBeInstanceOf(Date);
-  });
-
-  it('| should create an instance with initial data', (): void => {
-    const initialData: DyFM_ServerStatus = {
-      status: 'ready',
-      systemName: 'Test System',
-      systemShortCode: 'TS',
-      clientVersionOk: true,
-      latestClientVersion: '1.0.0',
-      latestClientVersionNumeric: 100,
-      serverVersion: '1.0.0',
-      serverNumericVersion: 100,
-      uptime: 3600000,
-      serverMessage: 'Server is running',
-      memoryUsage: {
-        rss: 1000000,
-        heapTotal: 500000,
-        heapUsed: 300000,
-        external: 200000,
-        arrayBuffers: 100000,
-      },
-      cpuUsage: {
-        user: 1000,
-        system: 500,
-      },
-      serverConnections: {
-        'db': DyFM_ServerConnection_Status.accessible,
-        'redis': DyFM_ServerConnection_Status.accessible,
-      },
-    };
-
-    const serverStatus = new DyFM_ServerStatus(initialData);
-
-    expect(serverStatus.status).toBe('ready');
-    expect(serverStatus.systemName).toBe('Test System');
-    expect(serverStatus.systemShortCode).toBe('TS');
-    expect(serverStatus.clientVersionOk).toBe(true);
-    expect(serverStatus.latestClientVersion).toBe('1.0.0');
-    expect(serverStatus.latestClientVersionNumeric).toBe(100);
-    expect(serverStatus.serverVersion).toBe('1.0.0');
-    expect(serverStatus.serverNumericVersion).toBe(100);
-    expect(serverStatus.uptime).toBe(3600000);
-    expect(serverStatus.serverMessage).toBe('Server is running');
-    expect(serverStatus.memoryUsage).toEqual(initialData.memoryUsage);
-    expect(serverStatus.cpuUsage).toEqual(initialData.cpuUsage);
-    expect(serverStatus.serverConnections).toEqual(initialData.serverConnections);
-  });
-
-  it('| should have dataParams defined', (): void => {
-    const { DyFM_serverStatus_dataParams } = require('./server-status.control-model');
-
-    expect(DyFM_serverStatus_dataParams).toBeTruthy();
-    expect(DyFM_serverStatus_dataParams.dataName).toBe('server_status');
-  });
-});
-
+import { DyFM_ServerStatus } from './server-status.control-model';
+import { DyFM_ServerConnection_Status } from '../../_enums/server-connection-status.enum';
+
+describe('| DyFM_ServerStatus', (): void => {
+  it('| should create an instance without initial data', (): void => {
+    const serverStatus = new DyFM_ServerStatus();
+
+    expect(serverStatus).toBeTruthy();
+    expect(serverStatus.__created).toBeInstanceOf(Date);
+    expect(serverStatus.__lastModified).toBeInstanceOf(Date);
+  });
+
+  it('| should create an instance with initial data', (): void => {
+    const initialData: DyFM_ServerStatus = {
+      status: 'ready',
+      systemName: 'Test System',
+      systemShortCode: 'TS',
+      clientVersionOk: true,
+      latestClientVersion: '1.0.0',
+      latestClientVersionNumeric: 100,
+      serverVersion: '1.0.0',
+      serverNumericVersion: 100,
+      uptime: 3600000,
+      serverMessage: 'Server is running',
+      memoryUsage: {
+        rss: 1000000,
+        heapTotal: 500000,
+        heapUsed: 300000,
+        external: 200000,
+        arrayBuffers: 100000,
+      },
+      cpuUsage: {
+        user: 1000,
+        system: 500,
+      },
+      serverConnections: {
+        'db': DyFM_ServerConnection_Status.accessible,
+        'redis': DyFM_ServerConnection_Status.accessible,
+      },
+    };
+
+    const serverStatus = new DyFM_ServerStatus(initialData);
+
+    expect(serverStatus.status).toBe('ready');
+    expect(serverStatus.systemName).toBe('Test System');
+    expect(serverStatus.systemShortCode).toBe('TS');
+    expect(serverStatus.clientVersionOk).toBe(true);
+    expect(serverStatus.latestClientVersion).toBe('1.0.0');
+    expect(serverStatus.latestClientVersionNumeric).toBe(100);
+    expect(serverStatus.serverVersion).toBe('1.0.0');
+    expect(serverStatus.serverNumericVersion).toBe(100);
+    expect(serverStatus.uptime).toBe(3600000);
+    expect(serverStatus.serverMessage).toBe('Server is running');
+    expect(serverStatus.memoryUsage).toEqual(initialData.memoryUsage);
+    expect(serverStatus.cpuUsage).toEqual(initialData.cpuUsage);
+    expect(serverStatus.serverConnections).toEqual(initialData.serverConnections);
+  });
+
+  it('| should have dataParams defined', (): void => {
+    const { DyFM_serverStatus_dataParams } = require('./server-status.control-model');
+
+    expect(DyFM_serverStatus_dataParams).toBeTruthy();
+    expect(DyFM_serverStatus_dataParams.dataName).toBe('server_status');
+  });
+});
+

package/src/_models/control-models/server-status.control-model.ts

@@ -1,85 +1,85 @@
-import { DyFM_DataModel_Params } from '../..';
-import { DyFM_ServerConnection_Status } from '../../_enums/server-connection-status.enum';
-import { DyFM_Metadata } from '../data-models/metadata.data-model';
-
-
-export interface DyFM_ServerConnectionCheckResult {
-  [key: string]: DyFM_ServerConnection_Status,
-}
-
-/**
- * A class that represents the status of a server.
- * 
- * @example
- * ```ts
- * const serverStatus: DyFM_ServerStatus = new DyFM_ServerStatus({
- *   status: 'ready',
- * });
- * ```
- */
-export class DyFM_ServerStatus extends DyFM_Metadata {
-  status?: 'ready';
-
-  systemName?: string;
-  systemShortCode?: string;
-
-  clientVersionOk?: boolean;
-  latestClientVersion?: string;
-  latestClientVersionNumeric?: number;
-
-  serverVersion?: string;
-  serverNumericVersion?: number;
-
-  uptime?: number;
-  
-  serverMessage?: string;
-
-  memoryUsage?: {
-    rss: number,
-    heapTotal: number,
-    heapUsed: number,
-    external: number,
-    arrayBuffers: number,
-  };
-  cpuUsage?: {
-    user: number,
-    system: number,
-  };
-  serverConnections?: DyFM_ServerConnectionCheckResult;
-
-  constructor(
-    set?: DyFM_ServerStatus
-  ) {
-    super(set);
-
-    if (set) {
-      Object.assign(this, set);
-    }
-  }
-}
-
-export const DyFM_serverStatus_dataParams = new DyFM_DataModel_Params<DyFM_ServerStatus>({
-  dataName: 'server_status',
-  properties: {
-    status: { type: 'string' },
-
-    systemName: { type: 'string' },
-    systemShortCode: { type: 'string' },
-
-    clientVersionOk: { type: 'boolean' },
-    latestClientVersion: { type: 'string' },
-    latestClientVersionNumeric: { type: 'number' },
-
-    serverVersion: { type: 'string' },
-    serverNumericVersion: { type: 'number' },
-
-    uptime: { type: 'number' },
-
-    serverMessage: { type: 'string' },
-
-    memoryUsage: { type: 'object' },
-    cpuUsage: { type: 'object' },
-    serverConnections: { type: 'object' },
-  },
-});
-
+import { DyFM_DataModel_Params } from '../..';
+import { DyFM_ServerConnection_Status } from '../../_enums/server-connection-status.enum';
+import { DyFM_Metadata } from '../data-models/metadata.data-model';
+
+
+export interface DyFM_ServerConnectionCheckResult {
+  [key: string]: DyFM_ServerConnection_Status,
+}
+
+/**
+ * A class that represents the status of a server.
+ * 
+ * @example
+ * ```ts
+ * const serverStatus: DyFM_ServerStatus = new DyFM_ServerStatus({
+ *   status: 'ready',
+ * });
+ * ```
+ */
+export class DyFM_ServerStatus extends DyFM_Metadata {
+  status?: 'ready';
+
+  systemName?: string;
+  systemShortCode?: string;
+
+  clientVersionOk?: boolean;
+  latestClientVersion?: string;
+  latestClientVersionNumeric?: number;
+
+  serverVersion?: string;
+  serverNumericVersion?: number;
+
+  uptime?: number;
+  
+  serverMessage?: string;
+
+  memoryUsage?: {
+    rss: number,
+    heapTotal: number,
+    heapUsed: number,
+    external: number,
+    arrayBuffers: number,
+  };
+  cpuUsage?: {
+    user: number,
+    system: number,
+  };
+  serverConnections?: DyFM_ServerConnectionCheckResult;
+
+  constructor(
+    set?: DyFM_ServerStatus
+  ) {
+    super(set);
+
+    if (set) {
+      Object.assign(this, set);
+    }
+  }
+}
+
+export const DyFM_serverStatus_dataParams = new DyFM_DataModel_Params<DyFM_ServerStatus>({
+  dataName: 'server_status',
+  properties: {
+    status: { type: 'string' },
+
+    systemName: { type: 'string' },
+    systemShortCode: { type: 'string' },
+
+    clientVersionOk: { type: 'boolean' },
+    latestClientVersion: { type: 'string' },
+    latestClientVersionNumeric: { type: 'number' },
+
+    serverVersion: { type: 'string' },
+    serverNumericVersion: { type: 'number' },
+
+    uptime: { type: 'number' },
+
+    serverMessage: { type: 'string' },
+
+    memoryUsage: { type: 'object' },
+    cpuUsage: { type: 'object' },
+    serverConnections: { type: 'object' },
+  },
+});
+

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

@@ -1,145 +1,145 @@
-import { DyFM_Endpoint_SettingsBase, DyFM_ServerRoute_SettingsBase, DyFM_API_Input_Type } from './service-endpoint-settings-base.control-model';
-import { DyFM_HttpCallType } from '../../_enums/http/http-call-type.enum';
-
-describe('| DyFM_Endpoint_SettingsBase', (): void => {
-  it('| should create an instance with valid endpoint', (): void => {
-    const settings = new DyFM_Endpoint_SettingsBase<string, [string], undefined>({
-      name: 'testEndpoint',
-      type: DyFM_HttpCallType.get,
-      endpoint: '/test/:id'
-    });
-
-    expect(settings.name).toBe('testEndpoint');
-    expect(settings.type).toBe(DyFM_HttpCallType.get);
-    expect(settings.endpoint).toBe('/test/:id');
-    expect(settings.pathParamKeys).toEqual(['id']);
-  });
-
-  it('| should throw error when endpoint is not provided', (): void => {
-    expect(() => {
-      new DyFM_Endpoint_SettingsBase<string, [string], undefined>({
-        name: 'testEndpoint',
-        type: DyFM_HttpCallType.get
-      } as any);
-    }).toThrow();
-  });
-
-  it('| should convert {param} to :param format', (): void => {
-    const settings = new DyFM_Endpoint_SettingsBase<string, [string], undefined>({
-      name: 'testEndpoint',
-      type: DyFM_HttpCallType.get,
-      endpoint: '/test/{id}'
-    });
-
-    expect(settings.endpoint).toBe('/test/:id');
-    expect(settings.pathParamKeys).toEqual(['id']);
-  });
-
-  it('| should extract path parameters from endpoint', (): void => {
-    const settings = new DyFM_Endpoint_SettingsBase<string, [string, string], undefined>({
-      name: 'testEndpoint',
-      type: DyFM_HttpCallType.get,
-      endpoint: '/test/:userId/:itemId'
-    });
-
-    expect(settings.pathParamKeys).toEqual(['userId', 'itemId']);
-  });
-
-  it('| should handle endpoint without path parameters', (): void => {
-    const settings = new DyFM_Endpoint_SettingsBase<string, [], undefined>({
-      name: 'testEndpoint',
-      type: DyFM_HttpCallType.get,
-      endpoint: '/test/all'
-    });
-
-    expect(settings.pathParamKeys).toEqual([]);
-  });
-
-  it('| should handle complex endpoint with multiple path parameters', (): void => {
-    const settings = new DyFM_Endpoint_SettingsBase<string, [string, string, string], undefined>({
-      name: 'testEndpoint',
-      type: DyFM_HttpCallType.post,
-      endpoint: '/api/:version/:resource/:id'
-    });
-
-    expect(settings.pathParamKeys).toEqual(['version', 'resource', 'id']);
-  });
-
-  it('| should handle endpoint with path parameters in middle', (): void => {
-    const settings = new DyFM_Endpoint_SettingsBase<string, [string], undefined>({
-      name: 'testEndpoint',
-      type: DyFM_HttpCallType.get,
-      endpoint: '/api/v1/users/:id/posts'
-    });
-
-    expect(settings.pathParamKeys).toEqual(['id']);
-  });
-});
-
-describe('| DyFM_ServerRoute_SettingsBase', (): void => {
-  it('| should create an instance with valid endpoint', (): void => {
-    const settings = new DyFM_ServerRoute_SettingsBase<string, [], undefined>({
-      name: 'testRoute',
-      type: DyFM_HttpCallType.get,
-      endpoint: '/test',
-      preProcesses: []
-    });
-
-    expect(settings.name).toBe('testRoute');
-    expect(settings.type).toBe(DyFM_HttpCallType.get);
-    expect(settings.endpoint).toBe('/test');
-    expect(settings.preProcesses).toEqual([]);
-  });
-
-  it('| should inherit from DyFM_Endpoint_SettingsBase', (): void => {
-    const settings = new DyFM_ServerRoute_SettingsBase<string, [], undefined>({
-      name: 'testRoute',
-      type: DyFM_HttpCallType.get,
-      endpoint: '/test/:id',
-      preProcesses: []
-    });
-
-    expect(settings.pathParamKeys).toEqual(['id']);
-  });
-
-  it('| should handle tasks array', (): void => {
-    const task = async (): Promise<void> => {
-      // Test task
-    };
-    const settings = new DyFM_ServerRoute_SettingsBase<string, [], undefined>({
-      name: 'testRoute',
-      type: DyFM_HttpCallType.get,
-      endpoint: '/test',
-      preProcesses: [],
-      tasks: [task]
-    });
-
-    expect(settings.tasks).toEqual([task]);
-  });
-
-  it('| should handle simpleTask', (): void => {
-    const simpleTask = async (): Promise<string> => {
-      return 'result';
-    };
-    const settings = new DyFM_ServerRoute_SettingsBase<string, [], undefined>({
-      name: 'testRoute',
-      type: DyFM_HttpCallType.get,
-      endpoint: '/test',
-      preProcesses: [],
-      simpleTask: simpleTask
-    });
-
-    expect(settings.simpleTask).toBe(simpleTask);
-  });
-});
-
-describe('| DyFM_API_Input_Type', (): void => {
-  it('| should have body value', (): void => {
-    expect(DyFM_API_Input_Type.body).toBe('body');
-  });
-
-  it('| should have queryParams value', (): void => {
-    expect(DyFM_API_Input_Type.queryParams).toBe('queryParams');
-  });
-});
-
+import { DyFM_Endpoint_SettingsBase, DyFM_ServerRoute_SettingsBase, DyFM_API_Input_Type } from './service-endpoint-settings-base.control-model';
+import { DyFM_HttpCallType } from '../../_enums/http/http-call-type.enum';
+
+describe('| DyFM_Endpoint_SettingsBase', (): void => {
+  it('| should create an instance with valid endpoint', (): void => {
+    const settings = new DyFM_Endpoint_SettingsBase<string, [string], undefined>({
+      name: 'testEndpoint',
+      type: DyFM_HttpCallType.get,
+      endpoint: '/test/:id'
+    });
+
+    expect(settings.name).toBe('testEndpoint');
+    expect(settings.type).toBe(DyFM_HttpCallType.get);
+    expect(settings.endpoint).toBe('/test/:id');
+    expect(settings.pathParamKeys).toEqual(['id']);
+  });
+
+  it('| should throw error when endpoint is not provided', (): void => {
+    expect(() => {
+      new DyFM_Endpoint_SettingsBase<string, [string], undefined>({
+        name: 'testEndpoint',
+        type: DyFM_HttpCallType.get
+      } as any);
+    }).toThrow();
+  });
+
+  it('| should convert {param} to :param format', (): void => {
+    const settings = new DyFM_Endpoint_SettingsBase<string, [string], undefined>({
+      name: 'testEndpoint',
+      type: DyFM_HttpCallType.get,
+      endpoint: '/test/{id}'
+    });
+
+    expect(settings.endpoint).toBe('/test/:id');
+    expect(settings.pathParamKeys).toEqual(['id']);
+  });
+
+  it('| should extract path parameters from endpoint', (): void => {
+    const settings = new DyFM_Endpoint_SettingsBase<string, [string, string], undefined>({
+      name: 'testEndpoint',
+      type: DyFM_HttpCallType.get,
+      endpoint: '/test/:userId/:itemId'
+    });
+
+    expect(settings.pathParamKeys).toEqual(['userId', 'itemId']);
+  });
+
+  it('| should handle endpoint without path parameters', (): void => {
+    const settings = new DyFM_Endpoint_SettingsBase<string, [], undefined>({
+      name: 'testEndpoint',
+      type: DyFM_HttpCallType.get,
+      endpoint: '/test/all'
+    });
+
+    expect(settings.pathParamKeys).toEqual([]);
+  });
+
+  it('| should handle complex endpoint with multiple path parameters', (): void => {
+    const settings = new DyFM_Endpoint_SettingsBase<string, [string, string, string], undefined>({
+      name: 'testEndpoint',
+      type: DyFM_HttpCallType.post,
+      endpoint: '/api/:version/:resource/:id'
+    });
+
+    expect(settings.pathParamKeys).toEqual(['version', 'resource', 'id']);
+  });
+
+  it('| should handle endpoint with path parameters in middle', (): void => {
+    const settings = new DyFM_Endpoint_SettingsBase<string, [string], undefined>({
+      name: 'testEndpoint',
+      type: DyFM_HttpCallType.get,
+      endpoint: '/api/v1/users/:id/posts'
+    });
+
+    expect(settings.pathParamKeys).toEqual(['id']);
+  });
+});
+
+describe('| DyFM_ServerRoute_SettingsBase', (): void => {
+  it('| should create an instance with valid endpoint', (): void => {
+    const settings = new DyFM_ServerRoute_SettingsBase<string, [], undefined>({
+      name: 'testRoute',
+      type: DyFM_HttpCallType.get,
+      endpoint: '/test',
+      preProcesses: []
+    });
+
+    expect(settings.name).toBe('testRoute');
+    expect(settings.type).toBe(DyFM_HttpCallType.get);
+    expect(settings.endpoint).toBe('/test');
+    expect(settings.preProcesses).toEqual([]);
+  });
+
+  it('| should inherit from DyFM_Endpoint_SettingsBase', (): void => {
+    const settings = new DyFM_ServerRoute_SettingsBase<string, [], undefined>({
+      name: 'testRoute',
+      type: DyFM_HttpCallType.get,
+      endpoint: '/test/:id',
+      preProcesses: []
+    });
+
+    expect(settings.pathParamKeys).toEqual(['id']);
+  });
+
+  it('| should handle tasks array', (): void => {
+    const task = async (): Promise<void> => {
+      // Test task
+    };
+    const settings = new DyFM_ServerRoute_SettingsBase<string, [], undefined>({
+      name: 'testRoute',
+      type: DyFM_HttpCallType.get,
+      endpoint: '/test',
+      preProcesses: [],
+      tasks: [task]
+    });
+
+    expect(settings.tasks).toEqual([task]);
+  });
+
+  it('| should handle simpleTask', (): void => {
+    const simpleTask = async (): Promise<string> => {
+      return 'result';
+    };
+    const settings = new DyFM_ServerRoute_SettingsBase<string, [], undefined>({
+      name: 'testRoute',
+      type: DyFM_HttpCallType.get,
+      endpoint: '/test',
+      preProcesses: [],
+      simpleTask: simpleTask
+    });
+
+    expect(settings.simpleTask).toBe(simpleTask);
+  });
+});
+
+describe('| DyFM_API_Input_Type', (): void => {
+  it('| should have body value', (): void => {
+    expect(DyFM_API_Input_Type.body).toBe('body');
+  });
+
+  it('| should have queryParams value', (): void => {
+    expect(DyFM_API_Input_Type.queryParams).toBe('queryParams');
+  });
+});
+