@futdevpro/nts-dynamo 1.9.15 → 1.9.17

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

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

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

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

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

@@ -1,126 +1,126 @@
-
-import { DynamoFM_Log } from '@futdevpro/fsm-dynamo';
-import { DynamoNTS_HttpCallType } from '../../_enums/http/http-call-type.enum';
-import { DynamoNTS_HttpResponseType } from '../../_enums/http/http-response-type.enum';
-
-/**
- * API call params,
- * such as
- * type (HttpCallType),
- * endpoint,
- * and other options as httpOptions
- */
-export class DynamoNTS_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: DynamoNTS_HttpCallType;
-  /**
-   * 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;
-  /**
-   * this setting will be passed to the axios http call
-   */
-  httpOptions: any;
-
-  constructor(
-    /**
-     * set of options necessary for setting up an API call
-     */
-    set: {
-      /**
-       * name the call to be able to identify it when debugging
-       */
-      name: string,
-      /**
-       * set type as; HttpCallType .get, .post, ...ect
-       */
-      type: DynamoNTS_HttpCallType,
-      /**
-       * the endpoint of the API, without the baseUrl:
-       * '/user/get/:userId',
-       * where the parts starting with ':', will be used as pathParam
-       */
-      endPoint: string,
-      /**
-       * baseUrl of the API;
-       * 'https://futdevpro.hu/api'
-       */
-      baseUrl: string,
-      /**
-       * setting this value to true, will return the full HTTP call response in raw
-       */
-      getFullResponse?: boolean,
-      /**
-       * this setting will pass any kind of http setting used by the axios http messaging package
-       */
-      httpOptions?: DynamoNTS_HttpOptions,
-    }
-  ) {
-    this.name = set.name;
-    this.type = set.type;
-    
-    if (set.endPoint.includes('{')) {
-      DynamoFM_Log.warn(
-        `using {param} bracets in endpoint definitions will be deprecated... (${set.endPoint})` +
-        'use :param instead ({pathparam} --> :pathparam)'
-      );
-      set.endPoint.replace(/{/g, ':').replace(/}/g, '');
-    }
-    this.endPoint = set.endPoint;
-    this.baseUrl = set.baseUrl;
-    this.getFullResponse = !!set.getFullResponse;
-    this.httpOptions = set.httpOptions ? set.httpOptions : {};
-  }
-}
-
-/**
- * basic axios HttpsOptions,
- * 
- * learn more on axios package....
- * TOD: link package documentations
- */
-export class DynamoNTS_HttpOptions {
-  responseType?: DynamoNTS_HttpResponseType;
-  headers?: {
-    [header: string]: string | string[];
-  };
-  observe?: 'body';
-  reportProgress?: boolean;
-  withCredentials?: boolean;
-
-  constructor(
-    set: {
-      responseType?: DynamoNTS_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;
-  }
-}
+
+import { DynamoFM_Log } from '@futdevpro/fsm-dynamo';
+import { DynamoNTS_HttpCallType } from '../../_enums/http/http-call-type.enum';
+import { DynamoNTS_HttpResponseType } from '../../_enums/http/http-response-type.enum';
+
+/**
+ * API call params,
+ * such as
+ * type (HttpCallType),
+ * endpoint,
+ * and other options as httpOptions
+ */
+export class DynamoNTS_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: DynamoNTS_HttpCallType;
+  /**
+   * 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;
+  /**
+   * this setting will be passed to the axios http call
+   */
+  httpOptions: any;
+
+  constructor(
+    /**
+     * set of options necessary for setting up an API call
+     */
+    set: {
+      /**
+       * name the call to be able to identify it when debugging
+       */
+      name: string,
+      /**
+       * set type as; HttpCallType .get, .post, ...ect
+       */
+      type: DynamoNTS_HttpCallType,
+      /**
+       * the endpoint of the API, without the baseUrl:
+       * '/user/get/:userId',
+       * where the parts starting with ':', will be used as pathParam
+       */
+      endPoint: string,
+      /**
+       * baseUrl of the API;
+       * 'https://futdevpro.hu/api'
+       */
+      baseUrl: string,
+      /**
+       * setting this value to true, will return the full HTTP call response in raw
+       */
+      getFullResponse?: boolean,
+      /**
+       * this setting will pass any kind of http setting used by the axios http messaging package
+       */
+      httpOptions?: DynamoNTS_HttpOptions,
+    }
+  ) {
+    this.name = set.name;
+    this.type = set.type;
+    
+    if (set.endPoint.includes('{')) {
+      DynamoFM_Log.warn(
+        `using {param} bracets in endpoint definitions will be deprecated... (${set.endPoint})` +
+        'use :param instead ({pathparam} --> :pathparam)'
+      );
+      set.endPoint.replace(/{/g, ':').replace(/}/g, '');
+    }
+    this.endPoint = set.endPoint;
+    this.baseUrl = set.baseUrl;
+    this.getFullResponse = !!set.getFullResponse;
+    this.httpOptions = set.httpOptions ? set.httpOptions : {};
+  }
+}
+
+/**
+ * basic axios HttpsOptions,
+ * 
+ * learn more on axios package....
+ * TOD: link package documentations
+ */
+export class DynamoNTS_HttpOptions {
+  responseType?: DynamoNTS_HttpResponseType;
+  headers?: {
+    [header: string]: string | string[];
+  };
+  observe?: 'body';
+  reportProgress?: boolean;
+  withCredentials?: boolean;
+
+  constructor(
+    set: {
+      responseType?: DynamoNTS_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.ts

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

package/src/_models/control-models/app-params.control-model.ts

@@ -1,45 +1,46 @@
-
-/**
- * This will hold and set the basic settings of an application
- */
-export class DynamoNTS_App_Params {
-  /**
-   * name of the application
-   */
-  name: string;
-  /**
-   * title will be shown on the start of the application
-   */
-  title?: string;
-  /**
-   * version of the application
-   * you should set the version,
-   * probably, you should set from the package.json as follows:
-   * import { version } from '../package.json';
-   */
-  version: string;
-  /**
-   * name of your MongoDB table
-   * by default, its: `mongodb://localhost:27017/${this.dbName}`
-   */
-  dbUri?: string;
-  /**
-   * name of your MongoDB table
-   */
-  dbName: string;
-  /**
-   * name of the system, by default, its: this.name.replace(' ', '-')
-   */
-  systemName?: string;
-
-  constructor(
-    set: DynamoNTS_App_Params
-  ) {
-    this.name = set.name;
-    this.title = set.title ?? '';
-    this.version = set.version;
-    this.dbName = set.dbName;
-    this.dbUri = set.dbUri ?? `mongodb://localhost:27017/${this.dbName}`;
-    this.systemName = set.systemName ?? this.name.replace(' ', '-');
-  }
-}
+
+export type DyNTS_App_Params = DynamoNTS_App_Params;
+/**
+ * This will hold and set the basic settings of an application
+ */
+export class DynamoNTS_App_Params {
+  /**
+   * name of the application
+   */
+  name: string;
+  /**
+   * title will be shown on the start of the application
+   */
+  title?: string;
+  /**
+   * version of the application
+   * you should set the version,
+   * probably, you should set from the package.json as follows:
+   * import { version } from '../package.json';
+   */
+  version: string;
+  /**
+   * name of your MongoDB table
+   * by default, its: `mongodb://localhost:27017/${this.dbName}`
+   */
+  dbUri?: string;
+  /**
+   * name of your MongoDB table
+   */
+  dbName: string;
+  /**
+   * name of the system, by default, its: this.name.replace(' ', '-')
+   */
+  systemName?: string;
+
+  constructor(
+    set: DynamoNTS_App_Params
+  ) {
+    this.name = set.name;
+    this.title = set.title ?? '';
+    this.version = set.version;
+    this.dbName = set.dbName;
+    this.dbUri = set.dbUri ?? `mongodb://localhost:27017/${this.dbName}`;
+    this.systemName = set.systemName ?? this.name.replace(' ', '-');
+  }
+}

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

@@ -1,9 +1,9 @@
-
-import { DynamoNTS_SystemControl } from './system-control.control-model';
-
-export class DynamoNTS_AppSystemControls {
-  app: DynamoNTS_SystemControl = new DynamoNTS_SystemControl();
-  mongoose: DynamoNTS_SystemControl = new DynamoNTS_SystemControl();
-  httpServer: DynamoNTS_SystemControl = new DynamoNTS_SystemControl();
-  httpsServer: DynamoNTS_SystemControl = new DynamoNTS_SystemControl();  
-}
+
+import { DynamoNTS_SystemControl } from './system-control.control-model';
+
+export class DynamoNTS_AppSystemControls {
+  app: DynamoNTS_SystemControl = new DynamoNTS_SystemControl();
+  mongoose: DynamoNTS_SystemControl = new DynamoNTS_SystemControl();
+  httpServer: DynamoNTS_SystemControl = new DynamoNTS_SystemControl();
+  httpsServer: DynamoNTS_SystemControl = new DynamoNTS_SystemControl();  
+}