@futdevpro/fsm-dynamo 1.15.17 → 1.15.20

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

@@ -1,128 +1,128 @@
-
-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,
-    },
-  ){
-    if (set) {
-      if (!set._id && set._id !== undefined) { 
-        set._id = undefined;
-      }
-
-      this._id = set._id;
-      this.__created = set.__created;
-      this.__createdBy = set.__createdBy;
-      this.__lastModified = set.__lastModified;
-      this.__lastModifiedBy = set.__lastModifiedBy;
-      this.__v = set.__v;
-
-      if (set._archived) {
-        this._archived = set._archived;
-        this._originalId = set._originalId;
-      }
-    }
-
-    if (!this.__created) {
-      this.__created = new Date();
-    }
-
-    if (!this.__lastModified) {
-      this.__lastModified = new Date();
-    }
-    
-    if (!this.__v) {
-      this.__v = 0;
-    }
-    
-    if (init) {
-      if (!this._id && init?.id) {
-        this._id = init.id;
-      }
-
-      if (init?.issuer) {
-        if (!this.__createdBy) {
-          this.__createdBy = init.issuer;
-        }
-
-        if (!this.__lastModifiedBy) {
-          this.__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;
-  }
-}
+
+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,
+    },
+  ){
+    if (set) {
+      if (!set._id && set._id !== undefined) { 
+        set._id = undefined;
+      }
+
+      this._id = set._id;
+      this.__created = set.__created;
+      this.__createdBy = set.__createdBy;
+      this.__lastModified = set.__lastModified;
+      this.__lastModifiedBy = set.__lastModifiedBy;
+      this.__v = set.__v;
+
+      if (set._archived) {
+        this._archived = set._archived;
+        this._originalId = set._originalId;
+      }
+    }
+
+    if (!this.__created) {
+      this.__created = new Date();
+    }
+
+    if (!this.__lastModified) {
+      this.__lastModified = new Date();
+    }
+    
+    if (!this.__v) {
+      this.__v = 0;
+    }
+    
+    if (init) {
+      if (!this._id && init?.id) {
+        this._id = init.id;
+      }
+
+      if (init?.issuer) {
+        if (!this.__createdBy) {
+          this.__createdBy = init.issuer;
+        }
+
+        if (!this.__lastModifiedBy) {
+          this.__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 +1,8 @@
-import { DyFM_Vector2 } from './vector2.interface';
-
-export interface DyFM_BoxBounds {
-  pos: DyFM_Vector2;
-  size: DyFM_Vector2;
-  center: DyFM_Vector2;
-  centerMargin: DyFM_Vector2;
+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 +1,86 @@
-
-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;
-}
+
+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,47 +1,47 @@
-
-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>;
-}
+
+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>;
+}

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

@@ -1,11 +1,11 @@
-
-export interface DyFM_Error_Defaults {
-  errorCode: string;
-  message: string;
-  userMessage: string;
-  issuer: string;
-  issuerService: string;
-  issuerSystem: string;
-  systemVersion: string;
-}
-
+
+export interface DyFM_Error_Defaults {
+  errorCode: string;
+  message: string;
+  userMessage: string;
+  issuer: string;
+  issuerService: string;
+  issuerSystem: string;
+  systemVersion: string;
+}
+

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

@@ -1,12 +1,12 @@
-
-
-
-export interface DyFM_Paged<T> {
-  pageIndex: number;
-  pageSize: number;
-  total: number;
-  totalPageCount?: number;
-  items: T[];
-}
-
-
+
+
+
+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 +1,7 @@
-
-
-export interface DyFM_RandomWeight<T> {
-  chance: number;
-  result: T;
-}
-
+
+
+export interface DyFM_RandomWeight<T> {
+  chance: number;
+  result: T;
+}
+

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

@@ -1,15 +1,15 @@
-
-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
-  };
-}
+
+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 +1,23 @@
-
-
-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;
-}
-
+
+
+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;
+}
+