@futdevpro/nts-dynamo 1.15.15 → 1.15.16

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

@@ -1,47 +1,47 @@
-
-
-
-
-import { Request, Response } from 'express';
-
-import { DyFM_DataModel_Params } from '@futdevpro/fsm-dynamo';
-
-import { DyNTS_AuthService } from '../../_services/core/auth.service';
-import { DyNTS_EmailService } from '../../_services/core/email.service';
-import { DyNTS_Service_Collection } from '../../_services/core/service-collection.service';
-
-
-export interface DyNTS_GlobalService_Settings {
-  /**
-   * You need to setup your Own Auth Service extending the DyNTS_AuthService class
-   */
-  authService?: DyNTS_AuthService,
-
-  /**
-   * You can setup your Own Email Service extending the DyNTS_EmailServiceCollection class
-   */
-  emailServiceCollection?: DyNTS_Service_Collection<DyNTS_EmailService>,
-
-  /**
-   * you can setup data tables by passing a DyFM_DataModel_Params list at this point 
-   */
-  dbModels?: DyFM_DataModel_Params<any>[],
-
-  /**
-   * you can setup other services by passing a DyNTS_SingletonService list at this point
-   */
-  /* simpleServicesCollection?: DyNTS_SimpleServiceCollection, */
-
-  /**
-   * you can setup socket services by passing a DyNTS_SocketServiceCollection list at this point
-   */
-  /* socketServiceCollection?: DyNTS_SocketServiceCollection, */
-
-  /**
-   * you can setup global error handler by passing a function at this point
-   */
-  errorHandler?: DyNTS_GlobalErrorHandlerFn,
-}
-
-export type DyNTS_GlobalErrorHandlerFn = 
-  (err: any, req?: Request, res?: Response, issuer?: string) => Promise<void>;
+
+
+
+
+import { Request, Response } from 'express';
+
+import { DyFM_DataModel_Params } from '@futdevpro/fsm-dynamo';
+
+import { DyNTS_AuthService } from '../../_services/core/auth.service';
+import { DyNTS_EmailService } from '../../_services/core/email.service';
+import { DyNTS_Service_Collection } from '../../_services/core/service-collection.service';
+
+
+export interface DyNTS_GlobalService_Settings {
+  /**
+   * You need to setup your Own Auth Service extending the DyNTS_AuthService class
+   */
+  authService?: DyNTS_AuthService,
+
+  /**
+   * You can setup your Own Email Service extending the DyNTS_EmailServiceCollection class
+   */
+  emailServiceCollection?: DyNTS_Service_Collection<DyNTS_EmailService>,
+
+  /**
+   * you can setup data tables by passing a DyFM_DataModel_Params list at this point 
+   */
+  dbModels?: DyFM_DataModel_Params<any>[],
+
+  /**
+   * you can setup other services by passing a DyNTS_SingletonService list at this point
+   */
+  /* simpleServicesCollection?: DyNTS_SimpleServiceCollection, */
+
+  /**
+   * you can setup socket services by passing a DyNTS_SocketServiceCollection list at this point
+   */
+  /* socketServiceCollection?: DyNTS_SocketServiceCollection, */
+
+  /**
+   * you can setup global error handler by passing a function at this point
+   */
+  errorHandler?: DyNTS_GlobalErrorHandlerFn,
+}
+
+export type DyNTS_GlobalErrorHandlerFn = 
+  (err: any, req?: Request, res?: Response, issuer?: string) => Promise<void>;

package/src/_models/interfaces/routing-module-settings.interface.ts

@@ -1,21 +1,21 @@
-import { DyNTS_RouteSecurity } from '../../_enums/route-security.enum';
-import { DyNTS_Controller } from '../../_services/route/controller.service';
-
-
-/**
- * This is a main route point handler, which collects a list of controllers for the API
- */
-export interface DyNTS_RoutingModule_Settings {
-  /**
-   * main route of the module
-   */
-  route: string;
-  /**
-   * the collection of controllers (sub-routes, with differentlogical parts, to different db elements)
-   */
-  controllers: DyNTS_Controller[];
-  /**
-   * securityOverride will be used to create different security for a single module without changing the default security (http/https/both)
-   */
-  securityOverride?: DyNTS_RouteSecurity;
-}
+import { DyNTS_RouteSecurity } from '../../_enums/route-security.enum';
+import { DyNTS_Controller } from '../../_services/route/controller.service';
+
+
+/**
+ * This is a main route point handler, which collects a list of controllers for the API
+ */
+export interface DyNTS_RoutingModule_Settings {
+  /**
+   * main route of the module
+   */
+  route: string;
+  /**
+   * the collection of controllers (sub-routes, with differentlogical parts, to different db elements)
+   */
+  controllers: DyNTS_Controller[];
+  /**
+   * securityOverride will be used to create different security for a single module without changing the default security (http/https/both)
+   */
+  securityOverride?: DyNTS_RouteSecurity;
+}

package/src/_models/interfaces/static-client-settings.interface.spec.ts

@@ -1,29 +1,29 @@
-import { DyNTS_StaticClient_Settings } from './static-client-settings.interface';
-
-describe('| DyNTS_StaticClient_Settings', () => {
-  it('| should allow minimal settings with only root', () => {
-    const s: DyNTS_StaticClient_Settings = { root: '/dist' };
-    expect(s.root).toBe('/dist');
-    expect(s.fallbackPath).toBeUndefined();
-  });
-
-  it('| should allow optional fallbackPath', () => {
-    const s: DyNTS_StaticClient_Settings = {
-      root: '/dist',
-      fallbackPath: 'index.html',
-    };
-    expect(s.fallbackPath).toBe('index.html');
-  });
-
-  it('| should allow SPA cache options', () => {
-    const s: DyNTS_StaticClient_Settings = {
-      root: '/dist',
-      assetCacheMaxAge: 31536000,
-      assetCacheImmutable: true,
-      fallbackCacheMaxAge: 0,
-    };
-    expect(s.assetCacheMaxAge).toBe(31536000);
-    expect(s.assetCacheImmutable).toBe(true);
-    expect(s.fallbackCacheMaxAge).toBe(0);
-  });
-});
+import { DyNTS_StaticClient_Settings } from './static-client-settings.interface';
+
+describe('| DyNTS_StaticClient_Settings', () => {
+  it('| should allow minimal settings with only root', () => {
+    const s: DyNTS_StaticClient_Settings = { root: '/dist' };
+    expect(s.root).toBe('/dist');
+    expect(s.fallbackPath).toBeUndefined();
+  });
+
+  it('| should allow optional fallbackPath', () => {
+    const s: DyNTS_StaticClient_Settings = {
+      root: '/dist',
+      fallbackPath: 'index.html',
+    };
+    expect(s.fallbackPath).toBe('index.html');
+  });
+
+  it('| should allow SPA cache options', () => {
+    const s: DyNTS_StaticClient_Settings = {
+      root: '/dist',
+      assetCacheMaxAge: 31536000,
+      assetCacheImmutable: true,
+      fallbackCacheMaxAge: 0,
+    };
+    expect(s.assetCacheMaxAge).toBe(31536000);
+    expect(s.assetCacheImmutable).toBe(true);
+    expect(s.fallbackCacheMaxAge).toBe(0);
+  });
+});

package/src/_models/interfaces/static-client-settings.interface.ts

@@ -1,28 +1,28 @@
-/**
- * Beállítások a client static fájlok kiszolgálásához (pl. SPA) a '/' path alatt.
- * Ha megadva, a getStaticClientSettings() által visszaadott értéket a base app
- * a mountStaticClient() során használja (API route-ok után).
- * A cache mezők SPA (pl. Angular) optimalizáláshoz opcionálisak; ha nincs kitöltve,
- * viselkedés változatlan (alkalmas nem-SPA kiszolgálásra is).
- */
-export interface DyNTS_StaticClient_Settings {
-  /** A static fájlok könyvtárának path-ja (abszolút vagy process.cwd()-hez képest). */
-  root: string;
-  /** SPA fallback: ha a kérés nem egy fájlra mutat, ezt a fájlt szolgáljuk ki (pl. 'index.html'). */
-  fallbackPath?: string;
-  /**
-   * Static asset-ek (pl. JS, CSS) Cache-Control max-age másodpercben.
-   * SPA (Angular) hashed fájloknál pl. 1 év (31536000).
-   */
-  assetCacheMaxAge?: number;
-  /**
-   * Ha true és assetCacheMaxAge is megadva, Cache-Control-hoz hozzáadódik az immutable direktíva
-   * (Angular hashed fájlokra ideális).
-   */
-  assetCacheImmutable?: boolean;
-  /**
-   * Fallback (pl. index.html) Cache-Control max-age másodpercben.
-   * SPA esetén ajánlott 0, hogy a böngésző ne cache-elje az index.html-t (deploy után friss).
-   */
-  fallbackCacheMaxAge?: number;
-}
+/**
+ * Beállítások a client static fájlok kiszolgálásához (pl. SPA) a '/' path alatt.
+ * Ha megadva, a getStaticClientSettings() által visszaadott értéket a base app
+ * a mountStaticClient() során használja (API route-ok után).
+ * A cache mezők SPA (pl. Angular) optimalizáláshoz opcionálisak; ha nincs kitöltve,
+ * viselkedés változatlan (alkalmas nem-SPA kiszolgálásra is).
+ */
+export interface DyNTS_StaticClient_Settings {
+  /** A static fájlok könyvtárának path-ja (abszolút vagy process.cwd()-hez képest). */
+  root: string;
+  /** SPA fallback: ha a kérés nem egy fájlra mutat, ezt a fájlt szolgáljuk ki (pl. 'index.html'). */
+  fallbackPath?: string;
+  /**
+   * Static asset-ek (pl. JS, CSS) Cache-Control max-age másodpercben.
+   * SPA (Angular) hashed fájloknál pl. 1 év (31536000).
+   */
+  assetCacheMaxAge?: number;
+  /**
+   * Ha true és assetCacheMaxAge is megadva, Cache-Control-hoz hozzáadódik az immutable direktíva
+   * (Angular hashed fájlokra ideális).
+   */
+  assetCacheImmutable?: boolean;
+  /**
+   * Fallback (pl. index.html) Cache-Control max-age másodpercben.
+   * SPA esetén ajánlott 0, hogy a böngésző ne cache-elje az index.html-t (deploy után friss).
+   */
+  fallbackCacheMaxAge?: number;
+}

package/src/_models/types/db-update.type.ts

@@ -1,100 +1,100 @@
-
-/**
- * @param update this uses the basic Mongoose updateOne
- * @example
- * // increase a specific value (here by 15): 
- * { $inc: { popularity: 15 } }
- * //
- * @example 
- * // or add element to a list:
- * { $push: { reactions: this.newReaction }
- * // or add multiple elements to a list
- * { $push: { schedule: {$each: [ monday, tuesday, wednesday ] } } }
- * //
- * @example 
- * // or all at once 
- * {  
- *   $inc: { popularity: this.newVote.amount }, 
- *   emailVerified: true, 
- *   $push: { reactions: this.newReaction } 
- * }
- * // further tools (syntax matches with $inc):
- * $currentDate: // Sets the value of a field to current date, either as a Date or a Timestamp.
- * $min:         // Only updates the field if the specified value is less than the existing field value.
- * $max:         // Only updates the field if the specified value is greater than the existing field value.
- * $mul:         // Multiplies the value of the field by the specified amount.
- * $rename:      // Renames a field.
- * $unset:       // Removes the specified field from a document. (set: "" to value)
- * //
- */
-export type DyNTS_DBUpdate<T> = {
-  /**
-   * Sets the value of a field to current date, either as a Date or a Timestamp.
-   */
-  /* $currentDate?: { [K in keyof T]?: boolean }; */
-  /**
-   * Increments the value of the field by the specified amount.
-   */
-  $inc?: { [K in keyof T]?: number };
-  /**
-   * Only updates the field if the specified value is less than the existing field value.
-   */
-  $min?: { [K in keyof T]?: number };
-  /**
-   * Only updates the field if the specified value is greater than the existing field value.
-   */
-  $max?: { [K in keyof T]?: number };
-  /**
-   * Multiplies the value of the field by the specified amount.
-   */
-  $mul?: { [K in keyof T]?: number };
-  /**
-   * Renames a field.
-   */
-  $rename?: { [K in keyof T]?: string };
-  /**
-   * Removes the specified field from a document. (set: "" to value)
-   */
-  $unset?: { [K in keyof T]?: string };
-  /**
-   * Sets the value of a field in a document.
-   */
-  $set?: { [K in keyof T]?: string } | any;
-  /**
-   * Sets the value of a field if an update results in an insert of a document. 
-   * Has no effect on update operations that modify existing documents.
-   */
-  $setOnInsert?: { [K in keyof T]?: T[K] };
-  /**
-   * Removes the first or last item of an array.
-   */
-
-  // array only operations
-  /**
-   * Removes the first or last item of an array.
-   */
-  $push?: { [K in keyof T]?: any | { $each?: T[K] } };
-  /**
-   * Removes the first or last item of an array.
-   */
-  $addToSet?: { [K in keyof T]?: any | { $each?: T[K] } };
-  /**
-   * Removes the first or last item of an array.
-   */
-  $pop?: { [K in keyof T]?: 1 | -1 };
-  /**
-   * Removes all array elements that match a specified query.
-   */
-  $pull?: { [K in keyof T]?: any | { $each?: T[K] } };
-  /**
-   * Removes all array elements that match a specified query.
-   */
-  $pullAll?: { [K in keyof T]?: any | { $each?: T[K] } };
-} & DyNTS_DBSimpleUpdate<T>;
-
-/**
- * 
- */
-export type DyNTS_DBSimpleUpdate<T> = {
-  [K in keyof T]?: T[K];
-};
+
+/**
+ * @param update this uses the basic Mongoose updateOne
+ * @example
+ * // increase a specific value (here by 15): 
+ * { $inc: { popularity: 15 } }
+ * //
+ * @example 
+ * // or add element to a list:
+ * { $push: { reactions: this.newReaction }
+ * // or add multiple elements to a list
+ * { $push: { schedule: {$each: [ monday, tuesday, wednesday ] } } }
+ * //
+ * @example 
+ * // or all at once 
+ * {  
+ *   $inc: { popularity: this.newVote.amount }, 
+ *   emailVerified: true, 
+ *   $push: { reactions: this.newReaction } 
+ * }
+ * // further tools (syntax matches with $inc):
+ * $currentDate: // Sets the value of a field to current date, either as a Date or a Timestamp.
+ * $min:         // Only updates the field if the specified value is less than the existing field value.
+ * $max:         // Only updates the field if the specified value is greater than the existing field value.
+ * $mul:         // Multiplies the value of the field by the specified amount.
+ * $rename:      // Renames a field.
+ * $unset:       // Removes the specified field from a document. (set: "" to value)
+ * //
+ */
+export type DyNTS_DBUpdate<T> = {
+  /**
+   * Sets the value of a field to current date, either as a Date or a Timestamp.
+   */
+  /* $currentDate?: { [K in keyof T]?: boolean }; */
+  /**
+   * Increments the value of the field by the specified amount.
+   */
+  $inc?: { [K in keyof T]?: number };
+  /**
+   * Only updates the field if the specified value is less than the existing field value.
+   */
+  $min?: { [K in keyof T]?: number };
+  /**
+   * Only updates the field if the specified value is greater than the existing field value.
+   */
+  $max?: { [K in keyof T]?: number };
+  /**
+   * Multiplies the value of the field by the specified amount.
+   */
+  $mul?: { [K in keyof T]?: number };
+  /**
+   * Renames a field.
+   */
+  $rename?: { [K in keyof T]?: string };
+  /**
+   * Removes the specified field from a document. (set: "" to value)
+   */
+  $unset?: { [K in keyof T]?: string };
+  /**
+   * Sets the value of a field in a document.
+   */
+  $set?: { [K in keyof T]?: string } | any;
+  /**
+   * Sets the value of a field if an update results in an insert of a document. 
+   * Has no effect on update operations that modify existing documents.
+   */
+  $setOnInsert?: { [K in keyof T]?: T[K] };
+  /**
+   * Removes the first or last item of an array.
+   */
+
+  // array only operations
+  /**
+   * Removes the first or last item of an array.
+   */
+  $push?: { [K in keyof T]?: any | { $each?: T[K] } };
+  /**
+   * Removes the first or last item of an array.
+   */
+  $addToSet?: { [K in keyof T]?: any | { $each?: T[K] } };
+  /**
+   * Removes the first or last item of an array.
+   */
+  $pop?: { [K in keyof T]?: 1 | -1 };
+  /**
+   * Removes all array elements that match a specified query.
+   */
+  $pull?: { [K in keyof T]?: any | { $each?: T[K] } };
+  /**
+   * Removes all array elements that match a specified query.
+   */
+  $pullAll?: { [K in keyof T]?: any | { $each?: T[K] } };
+} & DyNTS_DBSimpleUpdate<T>;
+
+/**
+ * 
+ */
+export type DyNTS_DBSimpleUpdate<T> = {
+  [K in keyof T]?: T[K];
+};