@futdevpro/nts-dynamo 1.6.7 → 1.6.9

package/src/_modules/test/index.ts

@@ -1,5 +1,5 @@
 
 // TEST MODULE
 export * from './test.controller';
-export * from './get-test-routing-module';
+export * from './get-test-routing-module.util';
 export * from '@futdevpro/fsm-dynamo/test-module';

package/src/_modules/test/test.controller.ts

@@ -3,10 +3,10 @@ import { Request, Response } from 'express';
 
 import { testModuleSettings } from '@futdevpro/fsm-dynamo/test-module';
 
-import { DynamoNTS_HttpCallType } from '../../_enums/http/dynamo-nts-http-call-type.enum';
-import { DynamoNTS_Controller } from '../../_services/dynamo-nts-controller.service';
-import { DynamoNTS_EndpointParams } from '../../_models/control-models/dynamo-nts-endpoint-params.model';
-import { DynamoNTS_GlobalService } from '../../_services/dynamo-nts-global.service';
+import { DynamoNTS_HttpCallType } from '../../_enums/http/http-call-type.enum';
+import { DynamoNTS_Controller } from '../../_services/controller.service';
+import { DynamoNTS_EndpointParams } from '../../_models/control-models/endpoint-params.control-model';
+import { DynamoNTS_GlobalService } from '../../_services/global.service';
 
 export class TestController extends DynamoNTS_Controller {
 

package/src/_modules/usage/{get-usage-routing-module.ts → get-usage-routing-module.util.ts}

@@ -1,17 +1,19 @@
 
 import { usageModuleSettings } from '@futdevpro/fsm-dynamo/usage-module';
-import { DynamoNTS_RouteSecurity } from '../../_enums/dynamo-nts-route-security.enum';
-import { DynamoNTS_RoutingModuleSettings } from '../../_models/interfaces/dynamo-nts-routing-module-settings.interface';
-import { DynamoNTS_RoutingModule } from '../../_services/dynamo-nts-routing-module.service';
-import { UsageController } from './usage-controller';
+import { DynamoNTS_RouteSecurity } from '../../_enums/route-security.enum';
+import { DynamoNTS_RoutingModuleSettings } from '../../_models/interfaces/routing-module-settings.interface';
+import { DynamoNTS_RoutingModule } from '../../_services/routing-module.service';
+import { UsageController } from './usage.controller';
 
 export function getUsageRoutingModule(securityOverride?: DynamoNTS_RouteSecurity): DynamoNTS_RoutingModule {
   const set: DynamoNTS_RoutingModuleSettings = {
     route: usageModuleSettings.mainRoute,
     controllers: [ UsageController.getInstance() ]
   }
+
   if (securityOverride) {
     set.securityOverride = securityOverride;
   }
+
   return new DynamoNTS_RoutingModule(set);
 }

package/src/_modules/usage/index.ts

@@ -1,7 +1,7 @@
 
 // USAGE MODULE
-export * from './usage-controller';
-export * from './usage.service';
-export * from './get-usage-routing-module';
+export * from './usage.controller';
+export * from './usage.data-service';
+export * from './get-usage-routing-module.util';
 export * from '@futdevpro/fsm-dynamo/usage-module';
 

package/src/_modules/usage/{usage-controller.ts → usage.controller.ts}

@@ -3,12 +3,12 @@ import { Request, Response } from 'express';
 
 import { usageModuleSettings, Dynamo_UsageSession } from '@futdevpro/fsm-dynamo/usage-module';
 
-import { DynamoNTS_HttpCallType } from '../../_enums/http/dynamo-nts-http-call-type.enum';
-import { DynamoNTS_AuthService } from '../../_services/dynamo-nts-auth.service';
-import { DynamoNTS_Controller } from '../../_services/dynamo-nts-controller.service';
-import { DynamoNTS_GlobalService } from '../../_services/dynamo-nts-global.service';
-import { DynamoNTS_EndpointParams } from '../../_models/control-models/dynamo-nts-endpoint-params.model';
-import { UsageService } from './usage.service';
+import { DynamoNTS_HttpCallType } from '../../_enums/http/http-call-type.enum';
+import { DynamoNTS_AuthService } from '../../_services/auth.service';
+import { DynamoNTS_Controller } from '../../_services/controller.service';
+import { DynamoNTS_GlobalService } from '../../_services/global.service';
+import { DynamoNTS_EndpointParams } from '../../_models/control-models/endpoint-params.control-model';
+import { UsageService } from './usage.data-service';
 
 export class UsageController extends DynamoNTS_Controller {
     

package/src/_modules/usage/{usage.service.ts → usage.data-service.ts}

@@ -4,8 +4,8 @@ import { Dynamo_Error, Dynamo_Time } from '@futdevpro/fsm-dynamo';
 import { Dynamo_UsageSession, usageSessionModelParams, Dynamo_UsageData, 
   Dynamo_DailyUsageData } from '@futdevpro/fsm-dynamo/usage-module';
 
-import { DynamoNTS_DataService } from '../../_services/dynamo-nts-data.service';
-import { DynamoNTS_Shared } from '../../_services/dynamo-nts-shared.service';
+import { DynamoNTS_DataService } from '../../_services/data.service';
+import { DynamoNTS_Shared } from '../../_services/shared.static-service';
 
 export class UsageService extends DynamoNTS_DataService<Dynamo_UsageSession> {
   usageData: Dynamo_UsageData[] = [];

package/src/_services/{dynamo-nts-api.service.ts → api.service.ts}

@@ -2,9 +2,9 @@
 import * as Axios from 'axios';
 import { Dynamo_Error, Dynamo_Log } from '@futdevpro/fsm-dynamo';
 
-import { DynamoNTS_HttpCallType } from '../_enums/http/dynamo-nts-http-call-type.enum';
-import { DynamoNTS_HttpResponseType } from '../_enums/http/dynamo-nts-http-response-type.enum';
-import { DynamoNTS_ApiCallParams } from '../_models/control-models/dynamo-nts-api-call-params.model';
+import { DynamoNTS_HttpCallType } from '../_enums/http/http-call-type.enum';
+import { DynamoNTS_HttpResponseType } from '../_enums/http/http-response-type.enum';
+import { DynamoNTS_ApiCallParams } from '../_models/control-models/api-call-params.control-model';
 
 /**
  * This predefined Api service contains the basic API call function which can be used in various ways

package/src/_services/{dynamo-nts-app-extended.server.ts → app-extended.server.ts}

@@ -4,10 +4,10 @@ import * as Http from 'http';
 
 import { Dynamo_Log } from '@futdevpro/fsm-dynamo';
 
-import { DynamoNTS_App } from './dynamo-nts-app.server';
-import { DynamoNTS_RouteSecurity } from '../_enums/dynamo-nts-route-security.enum';
-import { DynamoNTS_SocketServerService } from './dynamo-nts-socket-server.service';
-import { DynamoNTS_SocketSecurity } from '../_enums/dynamo-nts-socket-security.enum';
+import { DynamoNTS_App } from './app.server';
+import { DynamoNTS_RouteSecurity } from '../_enums/route-security.enum';
+import { DynamoNTS_SocketServerService } from './socket-server.service';
+import { DynamoNTS_SocketSecurity } from '../_enums/socket-security.enum';
 
 /**
  * This will be the MAIN service of our server project,

package/src/_services/app.server.spec.ts

@@ -0,0 +1,40 @@
+
+import { DynamoNTS_AppParams } from '../_models/control-models/app-params.control-model';
+import { DynamoNTS_GlobalServiceSettings } from '../_models/interfaces/global-service-settings.interface';
+import { DynamoNTS_PortSettings } from '../_models/interfaces/port-settings.interface';
+import { DynamoNTS_App } from './app.server';
+import { DynamoNTS_RoutingModule } from './routing-module.service';
+
+class TestApp extends DynamoNTS_App {
+  getAppParams(): DynamoNTS_AppParams {
+    return new DynamoNTS_AppParams({
+      name: 'test',
+      version: '0.0.1',
+      dbName: 'test',
+    });
+  }
+
+  getGlobalServiceCollection(): DynamoNTS_GlobalServiceSettings {
+    return {};
+  }
+
+  getPortSettings(): DynamoNTS_PortSettings {
+    return {};
+  }
+
+  getRoutingModules(): DynamoNTS_RoutingModule[] {
+    return [];
+  }
+}  
+
+describe('DynamoNTS_App', () => {
+  let app: TestApp;
+
+  beforeEach(() => {
+    app = new TestApp();
+  });
+
+  it('should create an instance', () => {
+    expect(app).toBeTruthy();
+  });
+});

package/src/_services/{dynamo-nts-app.server.ts → app.server.ts}

@@ -7,16 +7,16 @@ import * as BodyParser from 'body-parser';
 
 import { Dynamo_Log } from '@futdevpro/fsm-dynamo';
 
-import { DynamoNTS_SingletonService } from './dynamo-nts-singleton.service';
-import { DynamoNTS_RouteSecurity } from '../_enums/dynamo-nts-route-security.enum';
-import { DynamoNTS_RoutingModule } from './dynamo-nts-routing-module.service';
-import { DynamoNTS_GlobalService } from './dynamo-nts-global.service';
-import { DynamoNTS_PortSettings } from '../_models/interfaces/dynamo-nts-port-settings.interface';
-import { DynamoNTS_CertificationSettings } from '../_models/interfaces/dynamo-nts-certification-settings.interface';
-import { DynamoNTS_GlobalServiceSettings } from '../_models/interfaces/dynamo-nts-global-service-settings.interface';
-import { dynamoNTS_GlobalSettings } from '../_constants/dynamo-nts-global-settings.const';
-import { DynamoNTS_AppParams } from '../_models/control-models/dynamo-nts-app-params.model';
-import { DynamoNTS_EndpointParams } from '../_models/control-models/dynamo-nts-endpoint-params.model';
+import { DynamoNTS_SingletonService } from './singleton.service';
+import { DynamoNTS_RouteSecurity } from '../_enums/route-security.enum';
+import { DynamoNTS_RoutingModule } from './routing-module.service';
+import { DynamoNTS_GlobalService } from './global.service';
+import { DynamoNTS_PortSettings } from '../_models/interfaces/port-settings.interface';
+import { DynamoNTS_CertificationSettings } from '../_models/interfaces/certification-settings.interface';
+import { DynamoNTS_GlobalServiceSettings } from '../_models/interfaces/global-service-settings.interface';
+import { dynamoNTS_GlobalSettings } from '../_constants/global-settings.const';
+import { DynamoNTS_AppParams } from '../_models/control-models/app-params.control-model';
+import { DynamoNTS_EndpointParams } from '../_models/control-models/endpoint-params.control-model';
 
 /**
  * This will be the MAIN service of our server project,
@@ -128,6 +128,52 @@ import { DynamoNTS_EndpointParams } from '../_models/control-models/dynamo-nts-e
  * 
  * //
  */
+
+/**
+ * This will be the MAIN service of our server project,  
+ * follow the types and type instructions while setting up your project
+ * 
+ * In this service, there are abstract functions that you will need to implement,  
+ * where you need to set up the main params for your application.
+ * 
+ * (after the example, you can find the list of services you can/should setup)
+ * 
+ * You need to setup the following functions:
+ * ```ts
+ * // this is where you set up the main params for your application
+ * getAppParams(): DynamoNTS_AppParams 
+ * 
+ * // this is where you connect your main services
+ * getGlobalServiceSettings(): DynamoNTS_GlobalServiceSettings 
+ * 
+ * // this is where you set up your ports
+ * getPorts(): DynamoNTS_PortSettings 
+ * 
+ * // this is where you set up your routes
+ * getRoutingModules(): DynamoNTS_RoutingModule[] 
+ * 
+ * 
+ * 
+ * ```
+ * optionally you can setup the following functions:
+ * ```ts
+ * // this is where you set up your certifications
+ * getCertificationSettings(): DynamoNTS_CertificationSettings 
+ * 
+ * // this is where you set up additional root services
+ * getRootServices(): DynamoNTS_SingletonService[] 
+ * 
+ * // this is where you set up your initial db entries
+ * createEntries(): void 
+ * 
+ * // this is where you can define post setup processes
+ * postProcess(): void 
+ * 
+ * 
+ * 
+ * ```
+ * 
+ */
 export abstract class DynamoNTS_App extends DynamoNTS_SingletonService {
 
   private _params: DynamoNTS_AppParams;
@@ -354,7 +400,7 @@ export abstract class DynamoNTS_App extends DynamoNTS_SingletonService {
       if (this._security !== DynamoNTS_RouteSecurity.open) {
         this.httpsServer
           .listen(this._ports.httpsPort, 'localhost', 0, () => {
-            Dynamo_Log.success(`\nHTTPS (secure) server is listening on port ${this._ports.httpsPort}\n`);
+            Dynamo_Log.success(`\nHTTPS (secure) server is listening on port ${this._ports.httpsPort}`);
           })
           .on('error', (error) => {
             Dynamo_Log.error(`\nHTTPS (secure) server ERROR`, error);
@@ -367,13 +413,13 @@ export abstract class DynamoNTS_App extends DynamoNTS_SingletonService {
       if (this._security !== DynamoNTS_RouteSecurity.secure) {
         this.openExpress
           .listen(this._ports.httpPort, () => {
-            Dynamo_Log.success(`\nHTTP  (-open-) server is listening on port ${this._ports.httpPort}\n`);
+            Dynamo_Log.success(`\nHTTP (-open-) server is listening on port ${this._ports.httpPort}`);
           })
           .on('error', (error) => {
-            Dynamo_Log.error(`\nHTTP  (-open-) server ERROR`, error);
+            Dynamo_Log.error(`\nHTTP (-open-) server ERROR`, error);
           })
           .on('uncaughtException', (ex) => {
-            Dynamo_Log.warn(`\nHTTP  (-open-) server uncaughtException`, ex);
+            Dynamo_Log.warn(`\nHTTP (-open-) server uncaughtException`, ex);
           });
       }
     } catch (error) {

package/src/_services/{dynamo-nts-auth.service.ts → auth.service.ts}

@@ -3,7 +3,7 @@ import { NextFunction, Request, Response } from 'express';
 
 import { Dynamo_Error } from '@futdevpro/fsm-dynamo';
 
-import { DynamoNTS_SingletonService } from './dynamo-nts-singleton.service';
+import { DynamoNTS_SingletonService } from './singleton.service';
 
 /**
  * Extend this class as an Auth Service implementation

package/src/_services/controller-service-collection.service.ts

@@ -0,0 +1,14 @@
+
+/* import { DynamoNTS_ServiceCollection } from './service-collection.service';
+import { DynamoNTS_SingletonService } from './singleton.service'; */
+
+/**
+ * 
+ */
+/* export class DynamoNTS_SimpleServiceCollection extends DynamoNTS_SingletonService {
+
+  [service: string]: DynamoNTS_SingletonService;
+
+} */
+
+/* export class DynamoNTS_SimpleServiceCollection extends DynamoNTS_ServiceCollection<DynamoNTS_SingletonService> {} */

package/src/_services/{dynamo-nts-controller.service.ts → controller.service.ts}

@@ -1,9 +1,9 @@
 
 
 import { Dynamo_Log } from '@futdevpro/fsm-dynamo';
-import { DynamoNTS_EndpointParams } from '../_models/control-models/dynamo-nts-endpoint-params.model';
+import { DynamoNTS_EndpointParams } from '../_models/control-models/endpoint-params.control-model';
 
-import { DynamoNTS_SingletonService } from './dynamo-nts-singleton.service';
+import { DynamoNTS_SingletonService } from './singleton.service';
 
 /**
  * Basic controller for endpoint handlings

package/src/_services/{dynamo-nts-data.service.ts → data.service.ts}

@@ -1,8 +1,10 @@
 
 import { Dynamo_Metadata, Dynamo_DataParams, Dynamo_DataPropertyParams, Dynamo_Error, Dynamo_Log } from '@futdevpro/fsm-dynamo';
+import { DynamoNTS_DBFilter } from '../_models/types/db-filter.type';
+import { DynamoNTS_DBUpdate } from '../_models/types/db-update.type';
 
-import { DynamoNTS_DBFilter, DynamoNTS_DBService, DynamoNTS_DBUpdate } from './dynamo-nts-db.service';
-import { DynamoNTS_GlobalService } from './dynamo-nts-global.service';
+import { DynamoNTS_DBService } from './db.service';
+import { DynamoNTS_GlobalService } from './global.service';
 
 /**
  * Basic Data Service that is connected to the relevant DBServices

package/src/_services/db-service-collection.service.ts

@@ -0,0 +1,18 @@
+
+/* import { DynamoNTS_DBService } from './db.service';
+import { DynamoNTS_ServiceCollection } from './service-collection.service'; */
+/* import { DynamoNTS_SingletonService } from './singleton.service'; */
+
+/**
+ * 
+ */
+/* export class DynamoNTS_DBServiceCollection extends DynamoNTS_SingletonService {
+
+  [service: string]: DynamoNTS_DBService<any>;
+  
+}
+ */
+
+/* export class DynamoNTS_DBServiceCollection extends DynamoNTS_ServiceCollection<DynamoNTS_DBService<any>> {} */
+
+

package/src/_services/{dynamo-nts-db.service.ts → db.service.ts}

@@ -5,193 +5,13 @@ import { Schema } from 'mongoose';
 import { 
   Dynamo_Metadata, Dynamo_DataParams, Dynamo_DataPropertyParams, Dynamo_Error 
 } from '@futdevpro/fsm-dynamo';
+import { DynamoNTS_DBFilter } from '../_models/types/db-filter.type';
+import { DynamoNTS_DBUpdate } from '../_models/types/db-update.type';
 
-/**
- * @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>;
-
-type DynamoNTS_DBFilterSimple<T> = {
-  [K in keyof T]?: T[K] | { 
-    /**
-     * 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[K],
-    /**
-     * 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[K],
-    /**
-     * Matches None of the values specified IN an array.
-     */
-    $nin?: T[K],
-    /**
-     * Inverts the effect of a query expression and returns documents that do not match the query expression.
-     */
-    $not?: T[K] | {
-      $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,
-  };
-};
-
-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>[];
-}
-
-type DynamoNTS_DBFilterNOR<T> = {
-  /**
-   * Joins query clauses with a logical NOR returns all documents that fail to match both clauses.
-   */
-  $nor: DynamoNTS_DBFilterSimple<T>[];
-}
-
-/**
- * @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 };
-  /**
-   * 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>;
 
-type DynamoNTS_DBSimpleUpdate<T> = {
-  [K in keyof T]?: T[K];
-};
 
 /**
- * 
+ * DB Service for MongoDB
  */
 export class DynamoNTS_DBService<T extends Dynamo_Metadata> {
   dataModel = mongoose.model(this.dataParams.dbName, this.getSchema());

package/src/_services/email-service-collection.service.ts

@@ -0,0 +1,25 @@
+
+/* import { DynamoNTS_EmailService } from './email.service';
+import { DynamoNTS_ServiceCollection } from './service-collection.service'; */
+/* import { DynamoNTS_SingletonService } from './singleton.service'; */
+
+/**
+ * Extend this class as an Email Service Collection implementation
+ * 
+ * You should use singleton instance getting function by implementing a
+ * static getInstance() function
+ * @example
+ * export class EmailServiceCollectionService extends DynamoBEEmailServiceCollection {
+ *
+ *   static getInstance(): EmailServiceCollectionService {
+ *     return EmailServiceCollectionService.getSingletonInstance();
+ *   }
+ *   ...
+ */
+/* export class DynamoNTS_EmailServiceCollection extends DynamoNTS_ServiceCollection<DynamoNTS_EmailService> {} */
+
+/* export class DynamoNTS_EmailServiceCollection extends DynamoNTS_SingletonService {
+
+  [service: string]: DynamoNTS_EmailService;
+
+} */