@futdevpro/nts-dynamo 1.15.157 → 1.15.163

package/src/_collections/star.controller.ts

@@ -1,130 +0,0 @@
-
-
-
-
-
-import { Request, Response } from 'express';
-
-import { DyFM_Error, DyFM_HttpCallType, DyFM_Log } from '@futdevpro/fsm-dynamo';
-
-import { DyNTS_Endpoint_Params } from '../_models/control-models/endpoint-params.control-model';
-import { DyNTS_Controller } from '../_services/route/controller.service';
-import { DyNTS_global_settings } from './global-settings.const';
-import { DyNTS_RoutingModule } from '../_services/route/routing-module.service';
-
-
-export function DyNTS_getStarRoute(): DyNTS_RoutingModule {
-  return new DyNTS_RoutingModule({
-    route: '/**',
-    controllers: [ 
-      DyNTS_Star_Controller.getInstance() 
-    ],
-  });
-}
-
-export class DyNTS_Star_Controller extends DyNTS_Controller {
-
-  static getInstance(): DyNTS_Star_Controller {
-    return DyNTS_Star_Controller.getSingletonInstance();
-  }
-
-  setupEndpoints(): void {
-    this.endpoints = [
-      new DyNTS_Endpoint_Params({
-        name: 'defaultGet',
-        endpoint: '/*',
-        type: DyFM_HttpCallType.get,
-        tasks: [
-          async (req: Request, res: Response, issuer: string): Promise<void> => { 
-            throw new DyFM_Error({
-              ...this.getDefaultErrorSettings(
-                'defaultRoute', 
-                new Error(`Invalid route (404): ${req.originalUrl}`),
-                issuer
-              ),
-
-              status: 404,
-              errorCode: `${DyNTS_global_settings.systemShortCodeName}|DyNTS-RMS-G404`,
-            });
-          }
-        ],
-      }),
-      new DyNTS_Endpoint_Params({
-        name: 'defaultPost',
-        endpoint: '/*',
-        type: DyFM_HttpCallType.post,
-        tasks: [
-          async (req: Request, res: Response, issuer: string): Promise<void> => { 
-            throw new DyFM_Error({
-              ...this.getDefaultErrorSettings(
-                'defaultRoute', 
-                new Error(`Invalid route (404): ${req.originalUrl}`),
-                issuer
-              ),
-
-              status: 404,
-              errorCode: `${DyNTS_global_settings.systemShortCodeName}|DyNTS-RMS-PO404`,
-            });
-          }
-        ],
-      }),
-      new DyNTS_Endpoint_Params({
-        name: 'defaultPut',
-        endpoint: '/*',
-        type: DyFM_HttpCallType.put,
-        tasks: [
-          async (req: Request, res: Response, issuer: string): Promise<void> => { 
-            throw new DyFM_Error({
-              ...this.getDefaultErrorSettings(
-                'defaultRoute', 
-                new Error(`Invalid route (404): ${req.originalUrl}`),
-                issuer
-              ),
-
-              status: 404,
-              errorCode: `${DyNTS_global_settings.systemShortCodeName}|DyNTS-RMS-PU404`,
-            });
-          }
-        ],
-      }),
-      new DyNTS_Endpoint_Params({
-        name: 'defaultPatch',
-        endpoint: '/*',
-        type: DyFM_HttpCallType.patch,
-        tasks: [
-          async (req: Request, res: Response, issuer: string): Promise<void> => { 
-            throw new DyFM_Error({
-              ...this.getDefaultErrorSettings(
-                'defaultRoute', 
-                new Error(`Invalid route (404): ${req.originalUrl}`),
-                issuer
-              ),
-                
-              status: 404,
-              errorCode: `${DyNTS_global_settings.systemShortCodeName}|DyNTS-RMS-PA404`,
-            });
-          }
-        ],
-      }),
-      new DyNTS_Endpoint_Params({
-        name: 'defaultDelete',
-        endpoint: '/*',
-        type: DyFM_HttpCallType.delete,
-        tasks: [
-          async (req: Request, res: Response, issuer: string): Promise<void> => { 
-            throw new DyFM_Error({
-              ...this.getDefaultErrorSettings(
-                'defaultRoute', 
-                new Error(`Invalid route (404): ${req.originalUrl}`),
-                issuer
-              ),
-
-              status: 404,
-              errorCode: `${DyNTS_global_settings.systemShortCodeName}|DyNTS-RMS-D404`,
-            });
-          }
-        ],
-      })
-    ];
-  }
-}

package/src/_collections/static-cache-control.util.spec.ts

@@ -1,47 +0,0 @@
-import { DyNTS_resolveStaticCacheControlHeader } from './static-cache-control.util';
-
-describe('DyNTS_resolveStaticCacheControlHeader', () => {
-  // AAA: Arrange-Act-Assert
-
-  it('a index.html-t no-cache-eli (NEM immutable), hogy a friss bundle-referenciák eljussanak', () => {
-    // Arrange + Act
-    const header: string = DyNTS_resolveStaticCacheControlHeader({
-      filePath: '/app/client-dist/index.html',
-      assetCacheMaxAge: 31536000,
-      assetCacheImmutable: true,
-    });
-
-    // Assert
-    expect(header).toBe('no-cache');
-  });
-
-  it('bármely .html fájlt no-cache-el (nem csak az index.html-t)', () => {
-    const header: string = DyNTS_resolveStaticCacheControlHeader({
-      filePath: '/app/client-dist/some-page.html',
-      assetCacheMaxAge: 31536000,
-      assetCacheImmutable: true,
-    });
-
-    expect(header).toBe('no-cache');
-  });
-
-  it('a hash-elt asset-eket immutable long-cache-eli, ha assetCacheImmutable=true', () => {
-    const header: string = DyNTS_resolveStaticCacheControlHeader({
-      filePath: '/app/client-dist/main-A1B2C3D4.js',
-      assetCacheMaxAge: 31536000,
-      assetCacheImmutable: true,
-    });
-
-    expect(header).toBe('max-age=31536000, immutable');
-  });
-
-  it('a hash-elt asset-eket immutable NÉLKÜL cache-eli, ha assetCacheImmutable=false', () => {
-    const header: string = DyNTS_resolveStaticCacheControlHeader({
-      filePath: '/app/client-dist/styles-99ZZ.css',
-      assetCacheMaxAge: 3600,
-      assetCacheImmutable: false,
-    });
-
-    expect(header).toBe('max-age=3600');
-  });
-});

package/src/_collections/static-cache-control.util.ts

@@ -1,25 +0,0 @@
-/**
- * A statikus SPA-fájlok Cache-Control fejlécének meghatározása.
- *
- * KULCS-szabály: a HTML entry-fájlok (index.html) SOHA nem kaphatnak immutable /
- * long-lived cache-t — ezek hivatkoznak az AKTUÁLIS, content-hash-elt asset-
- * fájlnevekre (pl. `main-A1B2C3.js`). Ha immutable-ként cache-eljük az index.html-t,
- * a visszatérő user-ek és a köztes proxy-k beragadnak egy RÉGI index.html-be, ami
- * régi bundle-neveket hivatkozik → a felhasználó SOHA nem kapja meg a friss deploy-t
- * hard-refresh nélkül (a "served-stale-index" bug). A hash-elt asset-ek viszont
- * per-definíció megváltoztatják a nevüket tartalom-változáskor, ezért NÁLUK helyes
- * (és kívánatos) az immutable long-cache.
- */
-export function DyNTS_resolveStaticCacheControlHeader(params: {
-  filePath: string;
-  assetCacheMaxAge: number;
-  assetCacheImmutable: boolean;
-}): string {
-  // HTML entry (index.html és bármely .html) → mindig újra-validálandó.
-  if (params.filePath.endsWith('.html')) {
-    return 'no-cache';
-  }
-
-  const immutable: string = params.assetCacheImmutable ? ', immutable' : '';
-  return `max-age=${params.assetCacheMaxAge}${immutable}`;
-}

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

@@ -1,14 +0,0 @@
-
-/**
- * Declares where a given model definition is used.
- *
- * - `dataModel`: persisted in the database
- * - `controlModel`: runtime only
- * - `interfaceModel`: runtime without constructor
- */
-/** @deprecated */
-export enum DyNTS_DataModelType {
-  dataModel = 'data-model',
-  controlModel = 'control-model',
-  interfaceModel = 'interface-model',
-}

package/src/_enums/data-service-function.enum.ts

@@ -1,24 +0,0 @@
-
-/**
- * Commonly used operations within data services.
- *
- * Each value represents a standard CRUD style method
- * that can be implemented by a service.
- */
-export enum DyNTS_DSF {
-  /** Retrieve all documents from the store. */
-  getAll = 'getAll',
-
-  /** Load a single document by its identifier. */
-  getDataById = 'getDataById',
-  /* checkIfDataExists = 'checkIfDataExists',
-  createData = 'createNewData', */
-  /** Update an existing document. */
-  modifyData = 'modifyData',
-
-  /** Remove a document. */
-  deleteData = 'deleteData',
-
-  /** Return data supplied directly rather than fetched. */
-  getProvidedData = 'getProvidedData',
-}

package/src/_enums/predefined-data-types.enum.ts

@@ -1,17 +0,0 @@
-
-/**
- * A small set of primitive data type names used when
- * describing field types in various models.
- */
-export enum DyanmoNTS_PredefinedDataTypes {
-  'string',
-  'number',
-  'boolean',
-  'Date',
-  'object',
-}
-
-/**
- * Full list of complex types supported by the framework
- * when interacting with the database.
- */

package/src/_enums/route-security.enum.ts

@@ -1,12 +0,0 @@
-
-/**
- * security settings for API,
- * different security paths will need different handlers
- * 
- * open; http, secure; https or both,
- */
-export enum DyNTS_RouteSecurity {
-  open = 'open',
-  secure = 'secure',
-  both = 'both',
-}

package/src/_models/control-models/api-call-params.control-model.spec.ts

@@ -1,152 +0,0 @@
-
-import { DyFM_HttpCallType, DyFM_HttpResponseType, DyFM_Log } from '@futdevpro/fsm-dynamo';
-
-import { DyNTS_ApiCall_Params, DyNTS_HttpOptions } from './api-call-params.control-model';
-
-describe('| DyNTS_ApiCall_Params', () => {
-  it('| should create an instance with default values', () => {
-    const params = new DyNTS_ApiCall_Params({
-      name: 'testCall',
-      type: DyFM_HttpCallType.get,
-      endpoint: '/test/endpoint',
-      baseUrl: 'https://example.com/api',
-    });
-
-    expect(params.name).toBe('testCall');
-    expect(params.type).toBe(DyFM_HttpCallType.get);
-    expect(params.endpoint).toBe('/test/endpoint');
-    expect(params.baseUrl).toBe('https://example.com/api');
-    expect(params.getFullResponse).toBe(false);
-    expect(params.httpOptions).toEqual({});
-  });
-
-  it('| should create an instance with provided values', () => {
-    const httpOptions = new DyNTS_HttpOptions({
-      responseType: DyFM_HttpResponseType.json,
-      headers: { 'Content-Type': 'application/json' },
-      observe: 'body',
-      reportProgress: true,
-      withCredentials: true,
-    });
-
-    const params = new DyNTS_ApiCall_Params({
-      name: 'testCall',
-      type: DyFM_HttpCallType.post,
-      endpoint: '/test/endpoint',
-      baseUrl: 'https://example.com/api',
-      getFullResponse: true,
-      httpOptions: httpOptions,
-    });
-
-    expect(params.name).toBe('testCall');
-    expect(params.type).toBe(DyFM_HttpCallType.post);
-    expect(params.endpoint).toBe('/test/endpoint');
-    expect(params.baseUrl).toBe('https://example.com/api');
-    expect(params.getFullResponse).toBe(true);
-    expect(params.httpOptions).toEqual(httpOptions);
-  });
-
-  it('| should replace deprecated endpoint parameter braces', () => {
-    spyOn(DyFM_Log, 'warn');
-
-    const params = new DyNTS_ApiCall_Params({
-      name: 'testCall',
-      type: DyFM_HttpCallType.get,
-      endpoint: '/test/{param}/endpoint',
-      baseUrl: 'https://example.com/api',
-    });
-
-    expect(DyFM_Log.warn).toHaveBeenCalledWith(
-      'WARNING: using {param} bracets in endpoint definitions will be deprecated... (/test/{param}/endpoint)' +
-      '\n  use :param instead ({pathparam} --> :pathparam)'
-    );
-    expect(params.endpoint).toBe('/test/:param/endpoint');
-  });
-
-  it('| should extract pathParamKeys from endpoint with colons', () => {
-    const params = new DyNTS_ApiCall_Params({
-      name: 'testCall',
-      type: DyFM_HttpCallType.get,
-      endpoint: '/test/:userId/:itemId',
-      baseUrl: 'https://example.com/api',
-    });
-
-    expect(params.pathParamKeys).toEqual(['userId', 'itemId']);
-  });
-
-  it('| should handle endpoint without path parameters', () => {
-    const params = new DyNTS_ApiCall_Params({
-      name: 'testCall',
-      type: DyFM_HttpCallType.get,
-      endpoint: '/test/endpoint',
-      baseUrl: 'https://example.com/api',
-    });
-
-    expect(params.pathParamKeys).toEqual([]);
-  });
-
-  it('| should use global baseUrl when baseUrl is not provided', () => {
-    spyOn(DyFM_Log, 'error');
-
-    const params = new DyNTS_ApiCall_Params({
-      name: 'testCall',
-      type: DyFM_HttpCallType.get,
-      endpoint: '/test/endpoint',
-    } as any);
-
-    expect(DyFM_Log.error).toHaveBeenCalled();
-    expect(params.baseUrl).toBeDefined();
-  });
-
-  it('| should handle missing endpoint', () => {
-    spyOn(DyFM_Log, 'warn');
-
-    const params = new DyNTS_ApiCall_Params({
-      name: 'testCall',
-      type: DyFM_HttpCallType.get,
-      baseUrl: 'https://example.com/api',
-    } as any);
-
-    expect(DyFM_Log.warn).toHaveBeenCalled();
-    expect(params.endpoint).toBe('');
-  });
-
-  it('| should throw error when endpoint is invalid', () => {
-    expect(() => {
-      new DyNTS_ApiCall_Params({
-        name: 'testCall',
-        type: DyFM_HttpCallType.get,
-        endpoint: { includes: false } as any,
-        baseUrl: 'https://example.com/api',
-      });
-    }).toThrowError(/DyNTS_ApiCall_Params Error: something went wrong with the endpoint, it is provided but not valid/);
-  });
-});
-
-describe('| DyNTS_HttpOptions', () => {
-  it('| should create an instance with default values', () => {
-    const options = new DyNTS_HttpOptions({});
-
-    expect(options.responseType).toBeUndefined();
-    expect(options.headers).toBeUndefined();
-    expect(options.observe).toBeUndefined();
-    expect(options.reportProgress).toBeUndefined();
-    expect(options.withCredentials).toBeUndefined();
-  });
-
-  it('| should create an instance with provided values', () => {
-    const options = new DyNTS_HttpOptions({
-      responseType: DyFM_HttpResponseType.json,
-      headers: { 'Content-Type': 'application/json' },
-      observe: 'body',
-      reportProgress: true,
-      withCredentials: true,
-    });
-
-    expect(options.responseType).toBe(DyFM_HttpResponseType.json);
-    expect(options.headers).toEqual({ 'Content-Type': 'application/json' });
-    expect(options.observe).toBe('body');
-    expect(options.reportProgress).toBe(true);
-    expect(options.withCredentials).toBe(true);
-  });
-});

package/src/_models/control-models/api-call-params.control-model.ts

@@ -1,142 +0,0 @@
-
-import { DyFM_Error, DyFM_getConstructionStackLocation, DyFM_HttpCallType, DyFM_HttpResponseType, DyFM_Log, } from '@futdevpro/fsm-dynamo';
-import { DyNTS_global_settings } from '../../_collections/global-settings.const';
-
-
-export interface DyNTS_AxiosSettings {
-  headers?: { [header: string]: string | string[] };
-  httpAgent?: any;
-  httpsAgent?: any;
-  timeout?: number;
-  maxRedirects?: number;
-  withCredentials?: boolean;
-  responseType?: DyFM_HttpResponseType;
-}
-
-/**
- * API call params,
- * such as
- * type (HttpCallType),
- * endpoint,
- * and other options as httpOptions
- */
-export class DyNTS_ApiCall_Params {
-  /**
-   * name the call to be able to identify it when debugging
-   */
-  name: string;
-  /**
-   * type of the call as; HttpCallType .get, .post, ...ect
-   */
-  type: DyFM_HttpCallType = DyFM_HttpCallType.get;
-  /**
-   * the endpoint of the API, without the baseUrl:
-   * '/user/get/:userId',
-   * where the parts starting with ':', will be used as pathParam
-   */
-  baseUrl: string;
-  /**
-   * baseUrl of the API;
-   * 'https://futdevpro.hu/api'
-   */
-  endpoint: string;
-
-  /**
-   * if this value is true, the call will return the full HTTP call response in raw
-   */
-  getFullResponse: boolean = false;
-  /**
-   * this setting will be passed to the axios http call
-   */
-  httpOptions: any | DyNTS_AxiosSettings = {};
-
-  pathParamKeys: string[] = [];
-  
-  readonly stack: string;
-
-  constructor(
-    /**
-     * set of options necessary for setting up an API call
-     */
-    set: Partial<DyNTS_ApiCall_Params>
-  ) {
-    this.stack = DyFM_getConstructionStackLocation();
-
-    if (!set.name) {
-      // ?TODO: nullable warning
-      DyFM_Log.warn(
-        'WARNING: DyNTS_ApiCall_Params: name is not provided, using stack location!',
-        '\n  stack:', this.stack
-      );
-      this.name = this.stack;
-    }
-
-    if (!set.baseUrl) {
-      // ?TODO: nullable warning
-      DyFM_Log.error(
-        'ERROR: DyNTS_ApiCall_Params: baseUrl is not provided, using global baseUrl!',
-        '\n  stack:', this.stack
-      );
-      this.baseUrl = DyNTS_global_settings.baseUrl;
-    }
-
-    if (!set.endpoint) {
-      // ?TODO: nullable warning
-      DyFM_Log.warn(
-        'WARNING: DyNTS_ApiCall_Params: endpoint is not provided',
-        '\n  stack:', this.stack
-      );
-      this.endpoint = '';
-    } else if (!set.endpoint.includes) {
-      throw new Error(
-        'DyNTS_ApiCall_Params Error: something went wrong with the endpoint, it is provided but not valid'
-      );
-    } else if (set.endpoint.includes('{')) {
-      DyFM_Log.warn(
-        `WARNING: using {param} bracets in endpoint definitions will be deprecated... (${set.endpoint})` +
-        '\n  use :param instead ({pathparam} --> :pathparam)'
-      );
-      set.endpoint = set.endpoint.replace(/{/g, ':').replace(/}/g, '');
-    } else {
-      this.pathParamKeys = set.endpoint.split('/')
-        .filter(part => part.startsWith(':'))
-        .map(part => part.slice(1));
-    }
-
-    Object.assign(this, set);
-  }
-}
-
-/**
- * basic axios HttpsOptions,
- * 
- * learn more on axios package....
- * TOD: link package documentations
- */
-export class DyNTS_HttpOptions {
-  responseType?: DyFM_HttpResponseType;
-  headers?: {
-    [header: string]: string | string[];
-  };
-  observe?: 'body';
-  reportProgress?: boolean;
-  withCredentials?: boolean;
-
-  constructor(
-    set: {
-      responseType?: DyFM_HttpResponseType,
-      headers?: {
-        [header: string]: string | string[];
-      },
-      observe?: 'body',
-      reportProgress?: boolean,
-      withCredentials?: boolean
-    }
-  ) {
-    this.responseType = set.responseType;
-    this.headers = set.headers;
-    this.observe = set.observe;
-    this.reportProgress = set.reportProgress;
-    this.withCredentials = set.withCredentials;
-  }
-}

package/src/_models/control-models/app-ext-system-controls.control-model.spec.ts

@@ -1,52 +0,0 @@
-
-import { DyNTS_AppExtSysControls } from './app-ext-system-controls.control-model';
-import { DyNTS_SystemControl } from './system-control.control-model';
-
-describe('| DyNTS_AppExtSysControls', () => {
-  let appExtSysControls: DyNTS_AppExtSysControls;
-
-  beforeEach(() => {
-    appExtSysControls = new DyNTS_AppExtSysControls();
-  });
-
-  it('| should create an instance of DyNTS_AppExtSysControls', () => {
-    expect(appExtSysControls).toBeTruthy();
-  });
-
-  it('| should initialize "appExtended" as an instance of DyNTS_SystemControl', () => {
-    expect(appExtSysControls.appExtended).toBeInstanceOf(DyNTS_SystemControl);
-  });
-
-  it('| should initialize "httpSocketServer" as an instance of DyNTS_SystemControl', () => {
-    expect(appExtSysControls.httpSocketServer).toBeInstanceOf(DyNTS_SystemControl);
-  });
-
-  it('| should initialize "httpsSocketServer" as an instance of DyNTS_SystemControl', () => {
-    expect(appExtSysControls.httpsSocketServer).toBeInstanceOf(DyNTS_SystemControl);
-  });
-
-  it('| should have independent SystemControl instances', () => {
-    expect(appExtSysControls.appExtended).not.toBe(appExtSysControls.httpSocketServer);
-    expect(appExtSysControls.appExtended).not.toBe(appExtSysControls.httpsSocketServer);
-    expect(appExtSysControls.httpSocketServer).not.toBe(appExtSysControls.httpsSocketServer);
-  });
-
-  it('| should allow setting init and started on appExtended', () => {
-    appExtSysControls.appExtended.init = true;
-    appExtSysControls.appExtended.started = true;
-    expect(appExtSysControls.appExtended.getIsReady()).toBeTrue();
-  });
-
-  it('| should allow setting init and started on httpSocketServer', () => {
-    appExtSysControls.httpSocketServer.init = true;
-    appExtSysControls.httpSocketServer.started = false;
-    expect(appExtSysControls.httpSocketServer.getIsReady()).toBeFalse();
-  });
-
-  it('| should allow setting init and started on httpsSocketServer', () => {
-    appExtSysControls.httpsSocketServer.init = true;
-    appExtSysControls.httpsSocketServer.started = true;
-    expect(appExtSysControls.httpsSocketServer.getIsReady()).toBeTrue();
-  });
-});
-

package/src/_models/control-models/app-ext-system-controls.control-model.ts

@@ -1,9 +0,0 @@
-
-
-import { DyNTS_SystemControl } from './system-control.control-model';
-
-export class DyNTS_AppExtSysControls {
-  appExtended: DyNTS_SystemControl = new DyNTS_SystemControl();
-  httpSocketServer: DyNTS_SystemControl = new DyNTS_SystemControl();
-  httpsSocketServer: DyNTS_SystemControl = new DyNTS_SystemControl();  
-}