@futdevpro/fsm-dynamo 1.20.9 → 1.20.12

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

@@ -1,184 +0,0 @@
-import { DyFM_Metadata } from './metadata.data-model';
-
-describe('| DyFM_Metadata', (): void => {
-  it('| should create an instance without initial data', (): void => {
-    const instance = new DyFM_Metadata();
-    expect(instance).toBeTruthy();
-    expect(instance.__created).toBeInstanceOf(Date);
-    expect(instance.__lastModified).toBeInstanceOf(Date);
-    expect(instance.__v).toBe(0);
-  });
-
-  it('| should create an instance with initial data', (): void => {
-    const initialData: DyFM_Metadata = {
-      _id: 'test-id',
-      __created: new Date('2023-01-01'),
-      __createdBy: 'user1',
-      __lastModified: new Date('2023-01-02'),
-      __lastModifiedBy: 'user2',
-      __v: 1
-    };
-    const instance = new DyFM_Metadata(initialData);
-
-    expect(instance._id).toBe('test-id');
-    expect(instance.__created).toEqual(new Date('2023-01-01'));
-    expect(instance.__createdBy).toBe('user1');
-    expect(instance.__lastModified).toEqual(new Date('2023-01-02'));
-    expect(instance.__lastModifiedBy).toBe('user2');
-    expect(instance.__v).toBe(1);
-  });
-
-  it('| should set default values when not provided', (): void => {
-    const instance = new DyFM_Metadata({});
-
-    expect(instance.__created).toBeInstanceOf(Date);
-    expect(instance.__lastModified).toBeInstanceOf(Date);
-    expect(instance.__v).toBe(0);
-  });
-
-  it('| should handle init parameter with id and issuer', (): void => {
-    const instance = new DyFM_Metadata(undefined, {
-      id: 'init-id',
-      issuer: 'init-user'
-    });
-
-    expect(instance._id).toBe('init-id');
-    expect(instance.__createdBy).toBe('init-user');
-    expect(instance.__lastModifiedBy).toBe('init-user');
-  });
-
-  it('| should not override existing _id with init id', (): void => {
-    const instance = new DyFM_Metadata(
-      { _id: 'existing-id' },
-      { id: 'init-id', issuer: 'user' }
-    );
-
-    expect(instance._id).toBe('existing-id');
-  });
-
-  it('| should not override existing __createdBy with init issuer', (): void => {
-    const instance = new DyFM_Metadata(
-      { __createdBy: 'existing-user' },
-      { issuer: 'init-user' }
-    );
-
-    expect(instance.__createdBy).toBe('existing-user');
-  });
-
-  it('| should handle archived data', (): void => {
-    const archivedDate = new Date('2023-01-01');
-    const instance = new DyFM_Metadata({
-      _archived: archivedDate,
-      _originalId: 'original-id'
-    });
-
-    expect(instance._archived).toEqual(archivedDate);
-    expect(instance._originalId).toBe('original-id');
-  });
-
-  it('| should handle deleted data', (): void => {
-    const deletedDate = new Date('2023-01-01');
-    const instance = new DyFM_Metadata({
-      _deleted: deletedDate,
-      _deletedBy: 'deleter'
-    } as any);
-    instance._deleted = deletedDate;
-    instance._deletedBy = 'deleter';
-
-    expect(instance._deleted).toEqual(deletedDate);
-    expect(instance._deletedBy).toBe('deleter');
-  });
-
-  it('| should set _id to undefined when _id is falsy but not undefined', (): void => {
-    // Test case for line 40-42: if (!set._id && set._id !== undefined)
-    // This happens when _id is null, empty string, 0, false, etc.
-    const instance1 = new DyFM_Metadata({ _id: null as any });
-    expect(instance1._id).toBeUndefined();
-
-    const instance2 = new DyFM_Metadata({ _id: '' as any });
-    expect(instance2._id).toBeUndefined();
-
-    const instance3 = new DyFM_Metadata({ _id: 0 as any });
-    expect(instance3._id).toBeUndefined();
-  });
-
-  describe('| updateMetadata', (): void => {
-    it('| should update metadata correctly', (): void => {
-      const data = new DyFM_Metadata();
-      const updated = DyFM_Metadata.updateMetadata!(data, 'updater', 'new-id');
-
-      expect(updated._id).toBe('new-id');
-      expect(updated.__createdBy).toBe('updater');
-      expect(updated.__lastModifiedBy).toBe('updater');
-      expect(updated.__lastModified).toBeInstanceOf(Date);
-      expect(updated.__v).toBe(1);
-    });
-
-    it('| should increment version on update', (): void => {
-      const data = new DyFM_Metadata({ __v: 5 });
-      const updated = DyFM_Metadata.updateMetadata!(data, 'updater');
-
-      expect(updated.__v).toBe(6);
-    });
-
-    it('| should set version to 1 if not present', (): void => {
-      const data = new DyFM_Metadata({ __v: undefined });
-      const updated = DyFM_Metadata.updateMetadata!(data, 'updater');
-
-      expect(updated.__v).toBe(1);
-    });
-
-    it('| should not override existing _id if id not provided', (): void => {
-      const data = new DyFM_Metadata({ _id: 'existing-id' });
-      const updated = DyFM_Metadata.updateMetadata!(data, 'updater');
-
-      expect(updated._id).toBe('existing-id');
-    });
-
-    it('| should set _id if not present and id provided', (): void => {
-      const data = new DyFM_Metadata({ _id: undefined });
-      const updated = DyFM_Metadata.updateMetadata!(data, 'updater', 'new-id');
-
-      expect(updated._id).toBe('new-id');
-    });
-
-    it('| should throw error when updating deleted data', (): void => {
-      const data = new DyFM_Metadata({ _deleted: new Date() } as any);
-      data._deleted = new Date();
-
-      expect(() => {
-        DyFM_Metadata.updateMetadata!(data, 'updater');
-      }).toThrowError('Cannot update metadata of deleted data');
-    });
-
-    it('| should return data as-is if data is null', (): void => {
-      const result = DyFM_Metadata.updateMetadata!(null as any, 'updater');
-
-      expect(result).toBeNull();
-    });
-
-    it('| should set __created if not present', (): void => {
-      const data = new DyFM_Metadata({ __created: undefined });
-      const updated = DyFM_Metadata.updateMetadata!(data, 'updater');
-
-      expect(updated.__created).toBeInstanceOf(Date);
-    });
-
-    it('| should set __createdBy if not present', (): void => {
-      const data = new DyFM_Metadata({ __createdBy: undefined });
-      const updated = DyFM_Metadata.updateMetadata!(data, 'updater');
-
-      expect(updated.__createdBy).toBe('updater');
-    });
-
-    it('| should set __created if not present (branch coverage)', (): void => {
-      // Test case for line 114-116: if (!data.__created)
-      const data = new DyFM_Metadata();
-      data.__created = undefined as any;
-      const updated = DyFM_Metadata.updateMetadata!(data, 'updater');
-
-      expect(updated.__created).toBeInstanceOf(Date);
-    });
-  });
-});
-

package/src/_models/data-models/metadata.data-model.ts

@@ -1,153 +0,0 @@
-
-export type DyFM_MetaD = DyFM_Metadata;
-
-/**
- * This class is the base class for all data models.
- * It contains the metadata for the data model.
- * 
- * @example
- * ```ts
- * const metadata: DyFM_Metadata = new DyFM_Metadata({
- *   _id: '123',
- * });
- * ```
- */
-export class DyFM_Metadata {
-  _id?: string;
-
-  __created?: Date;
-  __createdBy?: string;
-  __lastModified?: Date;
-  __lastModifiedBy?: string;
-  __v?: number;
-
-  _deleted?: Date;
-  _deletedBy?: string;
-
-  _archived?: Date;
-  //_archivedBy?: string;
-  //_archiveId?: string;
-  _originalId?: string;
-
-  constructor(
-    set?: DyFM_Metadata,
-    init?: {
-      id?: string,
-      issuer: string,
-    },
-  ){
-    // a metadata-init logika a statikus applyMetadata-ban el — igy a `DyFM_Error extends Error`
-    // (ami NEM tudja super()-rel hivni ezt a constructort) ugyanezt a target-en futtathatja.
-    DyFM_Metadata.applyMetadata(this, set, init);
-  }
-
-  /**
-   * Applies the metadata fields onto a target object.
-   *
-   * Kiemelt statikus a constructor-torzsbol: a viselkedes BIT-RE azonos a korabbi
-   * constructorral, de igy a `DyFM_Error extends Error implements DyFM_Metadata` is meg
-   * tudja hivni (az Error-bol orokolt osztaly nem tud `super(set, init)`-tel a
-   * DyFM_Metadata constructorba lepni, ezert target-alapon kell elerni az init-logikat).
-   *
-   * @param target - The object the metadata fields are written onto (`this`)
-   * @param set - The source metadata to copy from
-   * @param init - Optional id + issuer defaults
-   */
-  static applyMetadata(
-    target: DyFM_Metadata,
-    set?: DyFM_Metadata,
-    init?: {
-      id?: string,
-      issuer: string,
-    },
-  ): void {
-    if (set) {
-      if (!set._id && set._id !== undefined) {
-        set._id = undefined;
-      }
-
-      target._id = set._id;
-      target.__created = set.__created;
-      target.__createdBy = set.__createdBy;
-      target.__lastModified = set.__lastModified;
-      target.__lastModifiedBy = set.__lastModifiedBy;
-      target.__v = set.__v;
-
-      if (set._archived) {
-        target._archived = set._archived;
-        target._originalId = set._originalId;
-      }
-    }
-
-    if (!target.__created) {
-      target.__created = new Date();
-    }
-
-    if (!target.__lastModified) {
-      target.__lastModified = new Date();
-    }
-
-    if (!target.__v) {
-      target.__v = 0;
-    }
-
-    if (init) {
-      if (!target._id && init?.id) {
-        target._id = init.id;
-      }
-
-      if (init?.issuer) {
-        if (!target.__createdBy) {
-          target.__createdBy = init.issuer;
-        }
-
-        if (!target.__lastModifiedBy) {
-          target.__lastModifiedBy = init.issuer;
-        }
-      }
-    }
-  }
-  
-  /**
-   * Updates the metadata of a data model
-   * @param data - The data model to update
-   * @param issuer - The issuer of the data model
-   * @param id - The id of the data model
-   * @returns The updated data model
-   *
-   * @example
-   * ```ts
-   * const metadata: DyFM_Metadata = new DyFM_Metadata({
-   *   _id: '123',
-   * });
-   * const updatedMetadata = DyFM_Metadata.updateMetadata(metadata, 'user', '456');
-   * ```
-   */
-  static updateMetadata?<T extends DyFM_Metadata>(data: T, issuer: string, id?: string): T {
-    if (!data) {
-      return data;
-    }
-
-    if (data._deleted) {
-      throw new Error('Cannot update metadata of deleted data');
-    }
-
-    if (!data._id && id) {
-      data._id = id;
-    }
-
-    if (!data.__created) {
-      data.__created = new Date();
-    }
-    
-    if (!data.__createdBy) {
-      data.__createdBy = issuer;
-    }
-
-    data.__lastModified = new Date();
-    data.__lastModifiedBy = issuer;
-    data.__v = data.__v ? data.__v + 1 : 1;
-
-    return data;
-  }
-}

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

@@ -1,8 +0,0 @@
-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-log-settings.interface.ts

@@ -1,86 +0,0 @@
-
-export interface DyFM_GlobalLog_Settings {
-  /**
-   * this setting will set which logs will be shown
-   */
-  highDetailedLogs?: boolean;
-
-  deep?: boolean;
-
-  /**
-   * this setting will enable debug logs for setting up the application
-   */
-  setup?: boolean;
-
-  /**
-   * this setting will enable debug logs for setting up the database
-   */
-  dbSetup?: boolean;
-
-  /**
-   * this is an application wide default setting for route debug logs
-   */
-  request?: boolean;
-
-  /**
-   * this is an application wide default setting for route debug logs
-   */
-  requestsParams?: boolean;
-
-  /**
-   * this is an application wide default setting for route debug logs
-   */
-  requestsContent?: boolean;
-
-  /**
-   * this is an application wide default setting for route debug logs
-   */
-  responseContent?: boolean;
-  
-
-  /**
-   * this is an application wide default setting for socket debug logs
-   */
-  socket_allEvents?: boolean;
-
-  /**
-   * this is an application wide default setting for socket debug logs
-   */
-  socket_mainEvents?: boolean;
-
-  /**
-   * this is an application wide default setting for socket debug logs
-   */
-  socket_eventContent?: boolean;
-
-
-  /**
-   * this is an application wide default setting for api debug logs
-   */
-  api_events?: boolean;
-
-  /**
-   * this is an application wide default setting for api debug logs
-   */
-  api_requestContents?: boolean;
-
-  /**
-   * this is an application wide default setting for api debug logs
-   */
-  api_requestSettings?: boolean;
-
-  /**
-   * this is an application wide default setting for api debug logs
-   */
-  api_responseContents?: boolean;
-
-
-  /**
-   * this is an application wide default setting for detailed error logs
-   */
-  detailedErrors?: boolean;
-
-  server_debug?: boolean;
-
-  functions?: boolean;
-}

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

@@ -1,69 +0,0 @@
-
-import { DyFM_EnvironmentFlag } from '../../../_enums/environment-flag.enum';
-import { DyFM_GlobalLog_Settings } from './global-log-settings.interface';
-
-/**
- * 
- * @param logRequestsContent only will log if the specific logRequest is also true
- * 
- * @param logEventContent only will log if the specific socket event is also set to log
- * 
- */
-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
-   */
-  baseUrl: string;
-
-  /**
-   * this setting will set which logs will be shown
-   */
-  log_settings: DyFM_GlobalLog_Settings;
-
-  /**
-   * FR-015 Phase 2 — isomorphic env-var overrides surface.
-   *
-   * On Node, `DyFM_requireEnv(name, ...)` reads `process.env[name]` directly.
-   * On browser there is no `process.env` at runtime, so consumers populate
-   * this map at app bootstrap from `environment.ts`:
-   *
-   * ```ts
-   * import { DyFM_global_settings } from '@futdevpro/fsm-dynamo';
-   * import { environment } from './environments/environment';
-   *
-   * DyFM_global_settings.envOverrides = {
-   *   FDP_CORE_FE_AUTH_KEY: environment.authKey,
-   *   FDP_EXTRA_AUTH_STORAGE_KEY: environment.extraAuthStorageKey,
-   *   DyNM_STORAGE_ENCRYPTION_KEY: environment.storageEncryptionKey,
-   * };
-   * ```
-   *
-   * `DyFM_requireEnv` checks `process.env` first, then this map, then
-   * the caller's optional `fallback`, then throws a structured DyFM_Error.
-   */
-  envOverrides?: Record<string, string>;
-
-  /**
-   * The RESOLVED runtime environment of the application.
-   *
-   * **Why this exists:** the fleet already knows how to resolve the environment
-   * (`FDP_environmentFromHostname` / `FDP_setupFEEnvSettings` in `@futdevpro/fdp-templates`,
-   * called from every app's `main.ts`), but the RESULT was never stored anywhere — each app
-   * kept it in a local `const`. Bedrock UI (e.g. the "TEST" ribbon in `@futdevpro/ngx-dynamo`)
-   * therefore had NO readable source. This field is that source.
-   *
-   * **Layering:** `ngx-dynamo` must not depend on `fdp-templates` (the dependency runs the other
-   * way), so the shared lower layer — this package — owns the field.
-   *
-   * **FAIL-SAFE default: `prod`.** An unknown/unset environment must never light up a test
-   * indicator on a production surface. A missing setup degrades to "silently production-like",
-   * not to "warns everyone".
-   *
-   * Populated at app bootstrap; on the frontend `FDP_setupFEEnvSettings()` writes it as a side
-   * effect, so consumers need no extra call.
-   */
-  environmentFlag: DyFM_EnvironmentFlag;
-}

package/src/_models/interfaces/error-defaults.interface.ts

@@ -1,18 +0,0 @@
-
-export interface DyFM_Error_Defaults {
-  errorCode: string;
-  message: string;
-  userMessage: string;
-  issuer: string;
-  issuerService: string;
-  issuerSystem: string;
-  systemVersion: string;
-  /**
-   * BFR-FDPTOKENSERVICE-013 — globális kill-switch az `ErrorCode:` userMessage-utótagra.
-   * `false`-ra állítva SOHA nem kerül belső hibakód a `__userMessage`-be (végfelhasználói felület);
-   * `undefined`/`true` mellett a per-error `addECToUserMsg` flag dönt (visszafelé-kompatibilis).
-   * A kód a `_errorCode` mezőben változatlanul elérhető — a support onnan olvassa.
-   */
-  addECToUserMsg?: boolean;
-}
-

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

@@ -1,12 +0,0 @@
-
-
-
-export interface DyFM_Paged<T> {
-  pageIndex: number;
-  pageSize: number;
-  total: number;
-  totalPageCount?: number;
-  items: T[];
-}
-
-

package/src/_models/interfaces/random-weight.interface.ts

@@ -1,7 +0,0 @@
-
-
-export interface DyFM_RandomWeight<T> {
-  chance: number;
-  result: T;
-}
-

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

@@ -1,15 +0,0 @@
-
-export type DyFM_Route_S<T> = DyFM_Route_Settings<T>;
-export interface DyFM_Route_Settings<T> {
-  mainRoute: string;
-
-  /**
-   * 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
-  };
-}

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

@@ -1,23 +0,0 @@
-
-
-import { DyFM_DSFilter } from '../types/ds-filter.type';
-import { DyFM_DSSort } from '../types/ds-sort.type';
-
-export interface DyFM_SearchQuery<T> {
-  filterBy?: DyFM_DSFilter<T>; //DyFM_DBFilterSimple<T>; //DyFM_DBFilter<T>;
-  /**
-   * The sort order to load.
-   * The last sort will apply last, so it will be the strongest sort.
-   */
-  sortBy?: DyFM_DSSort[];
-  /**
-   * The page index number to load.
-   * 0-indexed.
-   */
-  page?: number;
-  /**
-   * The page size to load.
-   */
-  pageSize?: number;
-}
-

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

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

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

@@ -1,24 +0,0 @@
-
-
-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 +0,0 @@
-
-
-
-
-
-/**
- * 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;
-}