@futdevpro/nts-dynamo 1.9.15 → 1.9.16

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

@@ -1,83 +1,83 @@
-import { DynamoNTS_RouteSecurity } from '../../_enums/route-security.enum';
-import { DynamoNTS_SocketSecurity } from '../../_enums/socket-security.enum';
-
-/**
- * 
- * 
- * @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 DynamoNTS_Global_Settings {
-  /**
-   * 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 sets the default security for routes
-   */
-  defaultRouteSecurity: DynamoNTS_RouteSecurity;
-  /**
-   * this sets the default security for sockets
-   */
-  defaultSocketSecurity: DynamoNTS_SocketSecurity;
-
-  /**
-   * this setting will enable debug logs for setting up the application
-   */
-  logSetup?: boolean;
-
-  /**
-   * this is an application wide default setting for route debug logs
-   */
-  logRequest?: boolean;
-  /**
-   * this is an application wide default setting for route debug logs
-   */
-  logRequestsParams?: boolean;
-  /**
-   * this is an application wide default setting for route debug logs
-   */
-  logRequestsContent?: boolean;
-  /**
-   * this is an application wide default setting for route debug logs
-   */
-  logResponseContent?: boolean;
-
-  /**
-   * this is an application wide default setting for socket debug logs
-   */
-  logAllSocketEvent?: boolean;
-  /**
-   * this is an application wide default setting for socket debug logs
-   */
-  logMainSocketEvents?: boolean;
-  /**
-   * this is an application wide default setting for socket debug logs
-   */
-  logSocketEventContent?: boolean;
-
-  /**
-   * this is an application wide default setting for api debug logs
-   */
-  logApiEvents?: boolean;
-  /**
-   * this is an application wide default setting for api debug logs
-   */
-  logApiRequestContents?: boolean;
-  /**
-   * this is an application wide default setting for api debug logs
-   */
-  logApiRequestSettings?: boolean;
-  /**
-   * this is an application wide default setting for api debug logs
-   */
-  logApiResponseContents?: boolean;
-
-  /**
-   * this is an application wide default setting for detailed error logs
-   */
-  logDetailedErrors?: boolean;
-}
+import { DynamoNTS_RouteSecurity } from '../../_enums/route-security.enum';
+import { DynamoNTS_SocketSecurity } from '../../_enums/socket-security.enum';
+
+/**
+ * 
+ * 
+ * @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 DynamoNTS_Global_Settings {
+  /**
+   * 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 sets the default security for routes
+   */
+  defaultRouteSecurity: DynamoNTS_RouteSecurity;
+  /**
+   * this sets the default security for sockets
+   */
+  defaultSocketSecurity: DynamoNTS_SocketSecurity;
+
+  /**
+   * this setting will enable debug logs for setting up the application
+   */
+  logSetup?: boolean;
+
+  /**
+   * this is an application wide default setting for route debug logs
+   */
+  logRequest?: boolean;
+  /**
+   * this is an application wide default setting for route debug logs
+   */
+  logRequestsParams?: boolean;
+  /**
+   * this is an application wide default setting for route debug logs
+   */
+  logRequestsContent?: boolean;
+  /**
+   * this is an application wide default setting for route debug logs
+   */
+  logResponseContent?: boolean;
+
+  /**
+   * this is an application wide default setting for socket debug logs
+   */
+  logAllSocketEvent?: boolean;
+  /**
+   * this is an application wide default setting for socket debug logs
+   */
+  logMainSocketEvents?: boolean;
+  /**
+   * this is an application wide default setting for socket debug logs
+   */
+  logSocketEventContent?: boolean;
+
+  /**
+   * this is an application wide default setting for api debug logs
+   */
+  logApiEvents?: boolean;
+  /**
+   * this is an application wide default setting for api debug logs
+   */
+  logApiRequestContents?: boolean;
+  /**
+   * this is an application wide default setting for api debug logs
+   */
+  logApiRequestSettings?: boolean;
+  /**
+   * this is an application wide default setting for api debug logs
+   */
+  logApiResponseContents?: boolean;
+
+  /**
+   * this is an application wide default setting for detailed error logs
+   */
+  logDetailedErrors?: boolean;
+}

package/src/_models/interfaces/index.ts

@@ -1,7 +1,7 @@
-
-// INTERFACES
-export * from './global-service-settings.interface';
-export * from '../control-models/http-settings.control-model';
-export * from './certification-settings.interface';
-export * from './global-settings.interface';
-export * from './routing-module-settings.interface';
+
+// INTERFACES
+export * from './global-service-settings.interface';
+export * from '../control-models/http-settings.control-model';
+export * from './certification-settings.interface';
+export * from './global-settings.interface';
+export * from './routing-module-settings.interface';

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

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

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

@@ -1,108 +1,108 @@
-
-/**
- * @example 
- * // by email: 
- * { email: email }
- * //
- * @example 
- * // or by id that is in list:
- * { userIds: { $in: this.userId } }
- * //
- * @example 
- * // or by number or Date that is Greater Than AND Less Than:
- * { points: { $gt: 2, $lt: 14 } }
- * // further tools (syntax matches with $gt):
- * $eq:  // Matches values that are EQual to a specified value.
- * $gte: // Matches values that are Greater Than OR Equal to a specified value.
- * $lte: // Matches values that are Less Than or Equal to a specified value.
- * $ne:  // Matches all values that are Not Equal to a specified value.
- * $nin: // Matches None of the values specified IN an array.
- * //
- * @returns {T} data: T
- */
-export type DynamoNTS_DBFilter<T> = 
-  DynamoNTS_DBFilterSimple<T> | 
-  DynamoNTS_DBFilterOR<T> |
-  DynamoNTS_DBFilterNOR<T>;
-
-/**
- * A simple filter for a DynamoDB query.
- */
-export type DynamoNTS_DBFilterSimple<T> = {
-  [K in keyof T]?: T[K] | DynamoNTS_DBFilterExpressions<T[K]>;
-} & {
-  [path: string]: any;
-};
-
-export type DynamoNTS_DBFilterExpressions<T> = { 
-  /**
-   * Matches values that are includes the value; This works only when T[K] is an array!
-   */
-  $in?: any,
-  /**
-   * Matches values that are EQual to a specified value.
-   */
-  $eq?: T,
-  /**
-   * Matches values that are Greater Than a specified value.
-   */
-  $gt?: number | Date,
-  /**
-   * Matches values that are Greater Than OR Equal to a specified value.
-   */
-  $gte?: number | Date,
-  /**
-   * Matches values that are Less Than a specified value.
-   */
-  $lt?: number | Date,
-  /**
-   * Matches values that are Less Than or Equal to a specified value.
-   */
-  $lte?: number | Date,
-  /**
-   * Matches all values that are Not Equal to a specified value.
-   */
-  $ne?: T,
-  /**
-   * Matches None of the values specified IN an array.
-   */
-  $nin?: T,
-  /**
-   * Inverts the effect of a query expression and returns documents that do not match the query expression.
-   */
-  $not?: T | {
-    $regex?: RegExp | string,
-  },
-  /**
-   * Performs a regular expression on the field's value, and selects documents that match the regular expression.
-   */
-  $exists?: boolean,
-  /**
-   * Selects documents if a field is of the specified type.
-   */
-  $type?: string,
-};
-
-
-/**
- * Joins query clauses with a logical AND returns all documents that match the conditions of both clauses.
- */
-export type DynamoNTS_DBFilterNOR<T> = {
-  /**
-   * Joins query clauses with a logical NOR returns all documents that fail to match both clauses.
-   */
-  $nor: DynamoNTS_DBFilterSimple<T>[];
-}
-
-
-/**
- * Joins query clauses with a logical AND returns all documents that match the conditions of both clauses.
- */
-export type DynamoNTS_DBFilterOR<T> = {
-  /**
-   * Joins query clauses with a logical OR returns all documents that match the conditions of either clause.
-   */
-  $or: DynamoNTS_DBFilterSimple<T>[];
-}
-
-
+
+/**
+ * @example 
+ * // by email: 
+ * { email: email }
+ * //
+ * @example 
+ * // or by id that is in list:
+ * { userIds: { $in: this.userId } }
+ * //
+ * @example 
+ * // or by number or Date that is Greater Than AND Less Than:
+ * { points: { $gt: 2, $lt: 14 } }
+ * // further tools (syntax matches with $gt):
+ * $eq:  // Matches values that are EQual to a specified value.
+ * $gte: // Matches values that are Greater Than OR Equal to a specified value.
+ * $lte: // Matches values that are Less Than or Equal to a specified value.
+ * $ne:  // Matches all values that are Not Equal to a specified value.
+ * $nin: // Matches None of the values specified IN an array.
+ * //
+ * @returns {T} data: T
+ */
+export type DynamoNTS_DBFilter<T> = 
+  DynamoNTS_DBFilterSimple<T> | 
+  DynamoNTS_DBFilterOR<T> |
+  DynamoNTS_DBFilterNOR<T>;
+
+/**
+ * A simple filter for a DynamoDB query.
+ */
+export type DynamoNTS_DBFilterSimple<T> = {
+  [K in keyof T]?: T[K] | DynamoNTS_DBFilterExpressions<T[K]>;
+} & {
+  [path: string]: any;
+};
+
+export type DynamoNTS_DBFilterExpressions<T> = { 
+  /**
+   * Matches values that are includes the value; This works only when T[K] is an array!
+   */
+  $in?: any,
+  /**
+   * Matches values that are EQual to a specified value.
+   */
+  $eq?: T,
+  /**
+   * Matches values that are Greater Than a specified value.
+   */
+  $gt?: number | Date,
+  /**
+   * Matches values that are Greater Than OR Equal to a specified value.
+   */
+  $gte?: number | Date,
+  /**
+   * Matches values that are Less Than a specified value.
+   */
+  $lt?: number | Date,
+  /**
+   * Matches values that are Less Than or Equal to a specified value.
+   */
+  $lte?: number | Date,
+  /**
+   * Matches all values that are Not Equal to a specified value.
+   */
+  $ne?: T,
+  /**
+   * Matches None of the values specified IN an array.
+   */
+  $nin?: T,
+  /**
+   * Inverts the effect of a query expression and returns documents that do not match the query expression.
+   */
+  $not?: T | {
+    $regex?: RegExp | string,
+  },
+  /**
+   * Performs a regular expression on the field's value, and selects documents that match the regular expression.
+   */
+  $exists?: boolean,
+  /**
+   * Selects documents if a field is of the specified type.
+   */
+  $type?: string,
+};
+
+
+/**
+ * Joins query clauses with a logical AND returns all documents that match the conditions of both clauses.
+ */
+export type DynamoNTS_DBFilterNOR<T> = {
+  /**
+   * Joins query clauses with a logical NOR returns all documents that fail to match both clauses.
+   */
+  $nor: DynamoNTS_DBFilterSimple<T>[];
+}
+
+
+/**
+ * Joins query clauses with a logical AND returns all documents that match the conditions of both clauses.
+ */
+export type DynamoNTS_DBFilterOR<T> = {
+  /**
+   * Joins query clauses with a logical OR returns all documents that match the conditions of either clause.
+   */
+  $or: DynamoNTS_DBFilterSimple<T>[];
+}
+
+

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 DynamoNTS_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] } };
-} & DynamoNTS_DBSimpleUpdate<T>;
-
-/**
- * 
- */
-export type DynamoNTS_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 DynamoNTS_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] } };
+} & DynamoNTS_DBSimpleUpdate<T>;
+
+/**
+ * 
+ */
+export type DynamoNTS_DBSimpleUpdate<T> = {
+  [K in keyof T]?: T[K];
+};

package/src/_models/types/index.ts

@@ -1,5 +1,5 @@
-
-
-// TYPES
-export * from './db-filter.type';
-export * from './db-update.type';
+
+
+// TYPES
+export * from './db-filter.type';
+export * from './db-update.type';