@futdevpro/nts-dynamo 1.9.44 → 1.9.50

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

@@ -6,9 +6,9 @@ import { Request, Response } from 'express';
 
 import { DyFM_DataModel_Params } from '@futdevpro/fsm-dynamo';
 
-import { DyNTS_Service_Collection } from '../../_services/core/service-collection.service';
-import { DyNTS_EmailService } from '../../_services/core/email.service';
 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 {
@@ -25,7 +25,7 @@ export interface DyNTS_GlobalService_Settings {
   /**
    * you can setup data tables by passing a DyFM_DataModel_Params list at this point 
    */
-  dbModels?: DyFM_DataModel_Params[],
+  dbModels?: DyFM_DataModel_Params<any>[],
 
   /**
    * you can setup other services by passing a DyNTS_SingletonService list at this point

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

@@ -39,4 +39,9 @@ export interface DyNTS_Global_Settings {
    * this setting will set which logs will be shown
    */
   log_settings: DyNTS_GlobalLog_Settings;
+
+  /**
+   * this is the default page size for pagination
+   */
+  defaultPageSize: number;
 }

package/src/_modules/mock/data-model.mock.ts

@@ -22,18 +22,18 @@ export class Dependency_Mock extends DyFM_Metadata {
   }
 }
 
-export const dependency_mock_DataParams = new DyFM_DataModel_Params({
+export const dependency_mock_DataParams = new DyFM_DataModel_Params<Dependency_Mock>({
   dataName: 'dependencyMock',
-  properties: [
-    { key: 'string', type: 'string' },
-    { key: 'number', type: 'number' },
-    { key: 'date', type: 'Date' },
-    { key: 'boolean', type: 'boolean' },
-    { key: 'array', type: 'string[]' },
-    { key: 'object', type: 'any' },
-    { key: 'objectArray', type: 'any[]' },
-    { key: 'objectArrayArray', type: 'any[][]' },
-  ],
+  properties: {
+    string: { type: 'string' },
+    number: { type: 'number' },
+    date: { type: 'Date' },
+    boolean: { type: 'boolean' },
+    array: { type: 'string[]' },
+    object: { type: 'any' },
+    objectArray: { type: 'any[]' },
+    objectArrayArray: { type: 'any[][]' },
+  },
 });
 
 ////////////////////////////////////////////////////////////////////
@@ -63,21 +63,21 @@ export class Dependent_Mock extends DyFM_Metadata {
   }
 }
 
-export const dependent_mock_DataParams = new DyFM_DataModel_Params({
+export const dependent_mock_DataParams = new DyFM_DataModel_Params<Dependent_Mock>({
   dataName: 'dependentMock',
-  properties: [
-    { key: 'dependencyId', type: 'string',
+  properties: {
+    dependencyId: { type: 'string',
       unique: true, required: true,
       isDependencyHook: true,
       dependencyDataName:  dependency_mock_DataParams.dataName,
     },
-    { key: 'string', type: 'string' },
-    { key: 'number', type: 'number' },
-    { key: 'date', type: 'Date' },
-    { key: 'boolean', type: 'boolean' },
-    { key: 'array', type: 'string[]' },
-    { key: 'object', type: 'any' },
-    { key: 'objectArray', type: 'any[]' },
-    { key: 'objectArrayArray', type: 'any[][]' },
-  ],
+    string: { type: 'string' },
+    number: { type: 'number' },
+    date: { type: 'Date' },
+    boolean: { type: 'boolean' },
+    array: { type: 'string[]' },
+    object: { type: 'any' },
+    objectArray: { type: 'any[]' },
+    objectArrayArray: { type: 'any[][]' },
+  },
 });

package/src/_modules/mock/socket-server.mock.ts

@@ -1,11 +1,11 @@
-import { Socket } from 'socket.io';
 import { DyFM_SocketEvent } from '@futdevpro/fsm-dynamo/socket';
+import { Socket } from 'socket.io';
 
-import { 
-  DyNTS_SocketPresence 
+import {
+  DyNTS_SocketPresence
 } from '../socket/_models/socket-presence.control-model';
-import { 
-  DyNTS_SocketServerService_Params 
+import {
+  DyNTS_SocketServerService_Params
 } from '../socket/_models/socket-server-service-params.control-model';
 import { DyNTS_SocketServerService } from '../socket/_services/socket-server.service';
 

package/src/_modules/socket/_services/socket-server.service.spec.ts

@@ -4,7 +4,7 @@ import { DyNTS_SocketServer_Mock } from '../../mock/socket-server.mock';
 
 describe('DyNTS_SocketServerService', () => {
   it('should create an instance', () => {
-    expect(new DyNTS_SocketServer_Mock()).toBeTruthy();
+    expect(DyNTS_SocketServer_Mock.getInstance()).toBeTruthy();
   });
 });
 

package/src/_modules/socket/_services/socket-server.service.ts

@@ -64,7 +64,7 @@ export abstract class DyNTS_SocketServerService<
     `We encountered an unhandled Socket Server Error, ` +
     `\nplease contact the responsible development team.`;
 
-  constructor(){
+  protected constructor(){
     super();
 
     this.asyncConstructor().catch((error: any) => {

package/src/_services/base/archive-data.service.ts

@@ -1,13 +1,15 @@
 
-import { 
-  DyFM_Metadata, DyFM_DataModel_Params, DyFM_Error
+import {
+  DyFM_DataModel_Params,
+  DyFM_DBFilterSimple,
+  DyFM_Error,
+  DyFM_Metadata
 } from '@futdevpro/fsm-dynamo';
 
-import { DyNTS_DataService } from './data.service';
 import { DyNTS_getArchivedDBName } from '../../_collections/archive.util';
 import { DyNTS_GlobalService } from '../core/global.service';
+import { DyNTS_DataService } from './data.service';
 import { DyNTS_DBService } from './db.service';
-import { DyNTS_DBFilterSimple } from '../../_models/types/db-filter.type';
 
 // TODO: 3 type of archiving service system: 
 // 1.: within list (data have a list that have elements to archive)
@@ -26,7 +28,7 @@ export class DyNTS_ArchiveDataService<T extends DyFM_Metadata> extends DyNTS_Dat
     /**
      * DB data prams will be used to connect to usable dbService on GlobalService
      */
-    dataParams: DyFM_DataModel_Params,
+    dataParams: DyFM_DataModel_Params<T>,
     /**
      * Initial set for issuer to be able to follow the issuer's activity
      */
@@ -95,7 +97,7 @@ export class DyNTS_ArchiveDataService<T extends DyFM_Metadata> extends DyNTS_Dat
       return await this.findData(
         {
           _originalId: originalId,
-        } as DyNTS_DBFilterSimple<T>, 
+        } as DyFM_DBFilterSimple<T>, 
         dontSetToService
       );
     } catch (error) {

package/src/_services/base/data.service.ts

@@ -2,15 +2,18 @@
 import {
   DyFM_AnyError,
   DyFM_Array,
-  DyFM_DataModel_Params, DyFM_DataProperty_Params, DyFM_Error,
+  DyFM_Data_Params,
+  DyFM_DataModel_Params, DyFM_DataProperty_Params,
+  DyFM_DBFilter,
+  DyFM_Error,
   DyFM_Error_Settings, DyFM_ErrorLevel,
   DyFM_Log,
-  DyFM_Metadata
+  DyFM_Metadata,
+  DyFM_SearchQuery
 } from '@futdevpro/fsm-dynamo';
 
 import { DyNTS_getArchivedDBName } from '../../_collections/archive.util';
 import { DyNTS_global_settings } from '../../_collections/global-settings.const';
-import { DyNTS_DBFilter } from '../../_models/types/db-filter.type';
 import { DyNTS_DBUpdate } from '../../_models/types/db-update.type';
 import { DyNTS_GlobalService } from '../core/global.service';
 import { DyNTS_ArchiveDataService } from './archive-data.service';
@@ -54,7 +57,7 @@ export class DyNTS_DataService<T extends DyFM_Metadata> {
   depKeyIsRequired?: boolean;
   private depDataDBService: DyNTS_DBService<any>;
 
-  dataParams: DyFM_DataModel_Params;
+  dataParams: DyFM_DataModel_Params<T>;
 
   readonly defaultErrorUserMsg: string = 
     `We encountered an unhandled Data Service Error, ` +
@@ -71,7 +74,8 @@ export class DyNTS_DataService<T extends DyFM_Metadata> {
     /**
      * DB data prams will be used to connect to usable dbService on GlobalService
      */
-    dataParams: DyFM_DataModel_Params,
+    /* dataParams: DyFM_DataModel_Params, */
+    dataParams: DyFM_Data_Params<T>,
     /**
      * Initial set for issuer to be able to follow the issuer's activity
      */
@@ -254,37 +258,41 @@ export class DyNTS_DataService<T extends DyFM_Metadata> {
         });
       }
 
-      if (!dependencyId && !this.data[this.depKey]) {
-        throw new DyFM_Error({ 
-          ...this._getDefaultErrorSettings(
-            'getDataByDependencyId',
-            new Error(
-              `getDataByDependencyId failed, "${this.depKey}" is missing! ` +
-              `(${this.dataParams.dataName})`
-            )
-          ),
-          
-          errorCode: 'NTS-DS0-GD2',
-          additionalContent: {
-            data: this.data,
-          },
-        });
+      if (!dependencyId) {
+        dependencyId = this.data?.[this.depKey];
+
+        if (!dependencyId) {
+          throw new DyFM_Error({ 
+            ...this._getDefaultErrorSettings(
+              'getDataByDependencyId',
+              new Error(
+                `getDataByDependencyId failed, "${this.depKey}" is missing! ` +
+                `(${this.dataParams.dataName})`
+              )
+            ),
+            
+            errorCode: 'NTS-DS0-GD2',
+            additionalContent: {
+              data: this.data,
+            },
+          });
+        }
       }
 
-      const dataExists: T = await this.dataDBService.getDataByDependencyId(
-        dependencyId ?? this.data[this.depKey]
-      ).catch((error): null => {
-        if (error?.errorCode === 'NTS-DBS-GD2') {
-          DyFM_Log.warn(
-            `getDataByDependencyId failed; "${this.dataParams.dataName}" ` +
-            `(${this.depKey}: ${dependencyId ?? this.data[this.depKey]}) didn't found any.`
-          );
+      const dataExists: T = await this.dataDBService.getDataByDependencyId(dependencyId).catch(
+        (error): null => {
+          if (error?.errorCode === 'NTS-DBS-GD2') {
+            DyFM_Log.warn(
+              `getDataByDependencyId failed; "${this.dataParams.dataName}" ` +
+              `(${this.depKey}: ${dependencyId ?? this.data[this.depKey]}) didn't found any.`
+            );
 
-          return null;
-        } else {
-          throw error;
+            return null;
+          } else {
+            throw error;
+          }
         }
-      });
+      );
 
       if (!dontSetToService) {
         this.data = dataExists;
@@ -462,7 +470,7 @@ export class DyNTS_DataService<T extends DyFM_Metadata> {
    * //
    * @returns {T} data: T
    */
-  async findData(filterBy: DyNTS_DBFilter<T>, dontSetToService?: boolean): Promise<T> {
+  async findData(filterBy: DyFM_DBFilter<T>, dontSetToService?: boolean): Promise<T> {
     try {
       const dataExists: T = await this.dataDBService.findOne(filterBy).catch((error): null => {
         if (error?.errorCode === 'NTS-DBS-FO1') {
@@ -518,7 +526,7 @@ export class DyNTS_DataService<T extends DyFM_Metadata> {
    * //
    * @returns {T[]} dataList: T[]
    */
-  async findDataList(filterBy: DyNTS_DBFilter<T>, dontSetToService?: boolean): Promise<T[]> {
+  async findDataList(filterBy: DyFM_DBFilter<T>, dontSetToService?: boolean): Promise<T[]> {
     try {
       const dataListExists: T[] = await this.dataDBService.find(filterBy).catch((error): T[] => {
         if (error?.errorCode === 'NTS-DBS-F1') {
@@ -601,7 +609,7 @@ export class DyNTS_DataService<T extends DyFM_Metadata> {
    * //
    */
   async updateData(
-    set: { filterBy?: DyNTS_DBFilter<T>, update: DyNTS_DBUpdate<T> }, 
+    set: { filterBy?: DyFM_DBFilter<T>, update: DyNTS_DBUpdate<T> }, 
     dontUpdateModified?: boolean
   ): Promise<void> {
     try {
@@ -615,7 +623,7 @@ export class DyNTS_DataService<T extends DyFM_Metadata> {
 
       } else if (this.data._id) {
         await this.dataDBService.updateOne(
-          { _id: this.data._id } as DyNTS_DBFilter<T>, 
+          { _id: this.data._id } as DyFM_DBFilter<T>, 
           set.update, 
           this.issuer,
           dontUpdateModified
@@ -623,7 +631,7 @@ export class DyNTS_DataService<T extends DyFM_Metadata> {
 
       } else if (this.depKey && this.data[this.depKey]) {
         await this.dataDBService.updateOne(
-          { [this.depKey]: this.data[this.depKey] } as DyNTS_DBFilter<T>, 
+          { [this.depKey]: this.data[this.depKey] } as DyFM_DBFilter<T>, 
           set.update, 
           this.issuer,
           dontUpdateModified
@@ -679,15 +687,15 @@ export class DyNTS_DataService<T extends DyFM_Metadata> {
   }
 
   /**
-   * modifies data if the data have ID and already exists in the DB, 
-   * creates new if the ID is not present or cant find in DB, 
-   * and if dependency data setted up, will check before creation,
-   * 
-   * @warning
-   * but the proper way to update data, if you use update method instead,
-   * this way, you can avoid data override errors 
-   * (when you simultaneously trying to change the same data's 
-   * different values from different flows)
+   * modifies data if the data have ID and already exists in the DB,   
+   * creates new if the ID is not present or cant find in DB,   
+   * and if dependency data setted up, will check before creation,  
+   *   
+   * @warning  
+   * but the proper way to update data, if you use update method instead,  
+   * this way, you can avoid data override errors   
+   * (when you simultaneously trying to change the same data's   
+   * different values from different flows)  
    */
   async saveData(data?: T, dontSetToService?: boolean, dontUpdateModified?: boolean): Promise<T> {
     try {
@@ -797,6 +805,23 @@ export class DyNTS_DataService<T extends DyFM_Metadata> {
       // if data not exists create new data
       data = await this.dataDBService.createData(data, this.issuer);
 
+      if (!data._id) {
+        throw new DyFM_Error({ 
+          ...this._getDefaultErrorSettings(
+            'saveData',
+            new Error(
+              `saveData was unsuccessful: data creation failed ` +
+              `(${this.dataParams.dataName})`
+            )
+          ),
+          
+          errorCode: 'NTS-DS0-SD4',
+          additionalContent: {
+            data: data,
+          },
+        });
+      }
+
       if (!dontSetToService) {
         this.data = data;
       }
@@ -804,7 +829,12 @@ export class DyNTS_DataService<T extends DyFM_Metadata> {
       return data;
 
     } catch (error) {
-      if ([ 'NTS-DS0-SD1', 'NTS-DS0-SD2' ].includes(error?.errorCode)) {
+      if ([ 
+        'NTS-DS0-SD1', 
+        'NTS-DS0-SD2', 
+        'NTS-DS0-SD3', 
+        'NTS-DS0-SD4',
+      ].includes(error?.errorCode)) {
         throw error;
 
       } else {
@@ -818,8 +848,8 @@ export class DyNTS_DataService<T extends DyFM_Metadata> {
   }
 
   /**
-   * markes data as deleted, if can be archived, will be archived as well
-   * if absolute is true, permanently deletes data from database by data._id
+   * markes data as deleted, if can be archived, will be archived as well  
+   * if absolute is true, permanently deletes data from database by data._id  
    */
   async deleteData(id?: string, absolute?: boolean): Promise<void> {
     try {
@@ -971,72 +1001,74 @@ export class DyNTS_DataService<T extends DyFM_Metadata> {
   }
 
   /**
-   * validation of data, for modify and create, by the ModelParams
+   * validation of data, for modify and create, by the ModelParams  
    */
   async validateForSave(data?: T): Promise<void> {
     try {
       data = this.ensureData(data);
 
-      for (const element of this.dataParams.properties) {
-        // basic required validations
-        if (
-          (
-            element.required ||
-            element.index
-          ) && (
-            data[element.key] === null || 
-            data[element.key] === undefined
-          )
-        ) {
-          throw new DyFM_Error({ 
-            ...this._getDefaultErrorSettings(
-              'validateForSave',
-              new Error(
-                `validateForSave failed, "${element.key}" is missing! ` +
-                `(${this.dataParams.dataName})`
-              )
-            ),
-
-            status: 522, 
-            errorCode: 'NTS-DS0-VD1',
-            userMessage: this.defaultValidationErrorUserMsg,
-            additionalContent: {
-              data: data,
-            },
-          });
-        }
-
-        // specific Date validation
-        if (element.type === 'Date' && 
-          !(new Date(data[element.key]) instanceof Date)
-        ) {
-          throw new DyFM_Error({
-            ...this._getDefaultErrorSettings(
-              'validateForSave',
-              new Error(
-                `validateForSave failed, "${element.key}" is not a date! ` +
-                `(${this.dataParams.dataName})`
-              )
-            ),
+      Object.values(this.dataParams.properties).forEach(
+        (element: DyFM_DataProperty_Params<any>) => {
+          // basic required validations
+          if (
+            (
+              element.required ||
+              element.index
+            ) && (
+              data[element.key] === null || 
+              data[element.key] === undefined
+            )
+          ) {
+            throw new DyFM_Error({ 
+              ...this._getDefaultErrorSettings(
+                'validateForSave',
+                new Error(
+                  `validateForSave failed, "${element.key}" is missing! ` +
+                  `(${this.dataParams.dataName})`
+                )
+              ),
+
+              status: 522, 
+              errorCode: 'NTS-DS0-VD1',
+              userMessage: this.defaultValidationErrorUserMsg,
+              additionalContent: {
+                data: data,
+              },
+            });
+          }
 
-            status: 522, 
-            errorCode: 'NTS-DS0-VD2',
-            userMessage: this.defaultValidationErrorUserMsg,
-            additionalContent: {
-              data: data,
-            },
-          });
-        }
+          // specific Date validation
+          if (element.type === 'Date' && 
+            !(new Date(data[element.key]) instanceof Date)
+          ) {
+            throw new DyFM_Error({
+              ...this._getDefaultErrorSettings(
+                'validateForSave',
+                new Error(
+                  `validateForSave failed, "${element.key}" is not a date! ` +
+                  `(${this.dataParams.dataName})`
+                )
+              ),
+
+              status: 522, 
+              errorCode: 'NTS-DS0-VD2',
+              userMessage: this.defaultValidationErrorUserMsg,
+              additionalContent: {
+                data: data,
+              },
+            });
+          }
 
-        // call additional validators
-        if (element.additionalValidators) {
-          for (let j = 0; j < element.additionalValidators.length; j++) {
-            element.additionalValidators[j](
-              data[element.key]
-            );
+          // call additional validators
+          if (element.additionalValidators) {
+            for (let j = 0; j < element.additionalValidators.length; j++) {
+              element.additionalValidators[j](
+                data[element.key]
+              );
+            }
           }
         }
-      }
+      );
     } catch (error) {
       if ([ 'NTS-DS0-VD1', 'NTS-DS0-VD2' ].includes(error?.errorCode)) {
         throw error;
@@ -1051,13 +1083,57 @@ export class DyNTS_DataService<T extends DyFM_Metadata> {
     }
   }
 
+  async searchData(query?: DyFM_SearchQuery<T>): Promise<T[]> {
+    try {
+      if (!query || Object.keys(query).length === 0) {
+        return await this.getAll();
+      }
+
+      if (!query.filterBy) {
+        query.filterBy = {};
+      }
+      
+      if (!query.page && !query.pageSize && !query.sortBy) {
+        return await this.dataDBService.find(query.filterBy);
+      }
+
+      if (!query.page) {
+        query.page = 1;
+      }
+
+      if (!query.pageSize) {
+        DyFM_Log.warn('searchData pageSize is not setted, setting to 10.');
+        query.pageSize = DyNTS_global_settings.defaultPageSize;
+      }
+
+      if (!query.sortBy) {
+        query.sortBy = { __lastModified: -1 };
+      }
+
+      return await this.dataDBService.findWithPaging(
+        query.filterBy,
+        query.page,
+        query.pageSize,
+        query.sortBy
+      );
+    } catch (error) {
+      throw new DyFM_Error({ 
+        ...this._getDefaultErrorSettings('searchData', error),
+        
+        errorCode: 'NTS-DS0-SD0',
+      });
+    }
+  }
+
+
   /**
    * setting up dependency dataHook by DynamoBEDataModelParams
    */
   private lookForDependencyDataSettings(): void {
-    const dependencyParam: DyFM_DataProperty_Params = this.dataParams.properties.find(
-      (modelParams: DyFM_DataProperty_Params): boolean => modelParams.isDependencyHook
-    );
+    const dependencyParam: DyFM_DataProperty_Params<any> = 
+      Object.values(this.dataParams.properties).find(
+        (modelParams: DyFM_DataProperty_Params<any>): boolean => modelParams.isDependencyHook
+      );
 
     if (dependencyParam) {
       this.depKey = dependencyParam.key;