@futdevpro/nts-dynamo 1.9.17 → 1.9.19

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

@@ -1,19 +1,19 @@
 
 import { 
-  DynamoFM_Metadata, DynamoFM_DataModel_Params, DynamoFM_DataProperty_Params, DynamoFM_Error,
-  DynamoFM_Log, DynamoFM_AnyError, DynamoFM_Error_Settings, DynamoFM_ErrorLevel 
+  DyFM_Metadata, DyFM_DataModel_Params, DyFM_DataProperty_Params, DyFM_Error,
+  DyFM_Log, DyFM_AnyError, DyFM_Error_Settings, DyFM_ErrorLevel 
 } from '@futdevpro/fsm-dynamo';
-import { DynamoNTS_DBFilter } from '../../_models/types/db-filter.type';
-import { DynamoNTS_DBUpdate } from '../../_models/types/db-update.type';
+import { DyNTS_DBFilter } from '../../_models/types/db-filter.type';
+import { DyNTS_DBUpdate } from '../../_models/types/db-update.type';
 
-import { DynamoNTS_DBService } from './db.service';
-import { DynamoNTS_GlobalService } from '../core/global.service';
+import { DyNTS_DBService } from './db.service';
+import { DyNTS_GlobalService } from '../core/global.service';
 
 /**
  * Basic Data Service that is connected to the relevant DBServices
  * 
  * @example
- * export class UserMatchStatisticsService extends DynamoNTS_DataService<UserMatchStatistics> {
+ * export class UserMatchStatisticsService extends DyNTS_DataService<UserMatchStatistics> {
  *   constructor(
  *     set?: {
  *       data?: UserMatchStatistics,
@@ -28,11 +28,11 @@ import { DynamoNTS_GlobalService } from '../core/global.service';
  *   }
  * }
  */
-export class DynamoNTS_DataService<T extends DynamoFM_Metadata> {
+export class DyNTS_DataService<T extends DyFM_Metadata> {
 
   serviceName: string;
 
-  dataDBService: DynamoNTS_DBService<T>;
+  dataDBService: DyNTS_DBService<T>;
   data: T;
   dataList: T[] = [];
   issuer: string;
@@ -41,9 +41,9 @@ export class DynamoNTS_DataService<T extends DynamoFM_Metadata> {
   depDBServiceKey?: string;
   depKeyIsUnique?: boolean;
   depKeyIsRequired?: boolean;
-  private depDataDBService: DynamoNTS_DBService<any>;
+  private depDataDBService: DyNTS_DBService<any>;
 
-  dataParams: DynamoFM_DataModel_Params;
+  dataParams: DyFM_DataModel_Params;
 
   defaultErrorUserMsg: string = 
     `We encountered an unhandled Data Service Error, ` +
@@ -60,7 +60,7 @@ export class DynamoNTS_DataService<T extends DynamoFM_Metadata> {
     /**
      * DB data prams will be used to connect to usable dbService on GlobalService
      */
-    dataParams: DynamoFM_DataModel_Params,
+    dataParams: DyFM_DataModel_Params,
     /**
      * Initial set for issuer to be able to follow the issuer's activity
      */
@@ -68,23 +68,23 @@ export class DynamoNTS_DataService<T extends DynamoFM_Metadata> {
   ) {
     try {
       this.serviceName = this.constructor?.name;
-      this.dataDBService = DynamoNTS_GlobalService.getDBService<T>(dataParams);
+      this.dataDBService = DyNTS_GlobalService.getDBService<T>(dataParams);
       this.data = data;
       this.dataParams = dataParams;
       this.lookForDependencyDataSettings();
       this.issuer = issuer;
     } catch (error) {
-      throw new DynamoFM_Error({
+      throw new DyFM_Error({
         ...this._getDefaultErrorSettings('constructor', error),
         message: `The dataService construction failed for ${dataParams?.dataName}. ` +
           `${this.serviceName} (${this.constructor.name})` +
           `\nMaybe you forgot to add the dbService to the GlobalService?\n\n`,
-        level: DynamoFM_ErrorLevel.critical,
+        level: DyFM_ErrorLevel.critical,
         
         errorCode: 'NTS-DS0-C00',
       });
-      /* DynamoFM_Log.error(
-        `\nDynamoNTS_DataService ERROR: ` +
+      /* DyFM_Log.error(
+        `\nDyNTS_DataService ERROR: ` +
         `\nThe dataService construction failed for ` +
         `${dataParams?.dataName}. ${this.serviceName} (${this.constructor.name})` +
         `\nMaybe you forgot to add the dbService to the GlobalService?` +
@@ -101,7 +101,7 @@ export class DynamoNTS_DataService<T extends DynamoFM_Metadata> {
     try {
       const dataListExists: T[] = await this.dataDBService.getAll().catch((error): T[] => {
         if (error?.errorCode === 'NTS-DBS-GA1') {
-          DynamoFM_Log.warn(`getAll ${this.dataParams.dataName} didn't found any.`);
+          DyFM_Log.warn(`getAll ${this.dataParams.dataName} didn't found any.`);
 
           return [];
         } else {
@@ -115,7 +115,7 @@ export class DynamoNTS_DataService<T extends DynamoFM_Metadata> {
 
       return dataListExists;
     } catch (error) {
-      throw new DynamoFM_Error({ 
+      throw new DyFM_Error({ 
         ...this._getDefaultErrorSettings('getAll', error),
 
         errorCode: 'NTS-DS0-GA0',
@@ -142,7 +142,7 @@ export class DynamoNTS_DataService<T extends DynamoFM_Metadata> {
   async getDataById(id?: string, dontSetToService?: boolean): Promise<T> {
     try {
       if (!id && !this.data._id) {
-        throw new DynamoFM_Error({ 
+        throw new DyFM_Error({ 
           ...this._getDefaultErrorSettings(
             'getDataById', 
             new Error(
@@ -167,7 +167,7 @@ export class DynamoNTS_DataService<T extends DynamoFM_Metadata> {
       if (error?.errorCode == 'NTS-DS0-GI1') {
         throw error;
       } else {
-        throw new DynamoFM_Error({ 
+        throw new DyFM_Error({ 
           ...this._getDefaultErrorSettings('getDataById', error),
           errorCode: 'NTS-DS0-GI0',
         });
@@ -178,7 +178,7 @@ export class DynamoNTS_DataService<T extends DynamoFM_Metadata> {
   async getDataByIds(ids: string[], dontSetToService?: boolean): Promise<T[]> {
     try {
       if (!ids) {
-        throw new DynamoFM_Error({
+        throw new DyFM_Error({
           ...this._getDefaultErrorSettings(
             'getDataByIds',
             new Error(`getDataByIds failed, ids is missing! (${this.dataParams.dataName})`)
@@ -200,7 +200,7 @@ export class DynamoNTS_DataService<T extends DynamoFM_Metadata> {
 
       return datas;
     } catch (error) {
-      throw new DynamoFM_Error({
+      throw new DyFM_Error({
         ...this._getDefaultErrorSettings('getDataByIds', error),
 
         errorCode: 'NTS-DS0-GIS0',
@@ -216,7 +216,7 @@ export class DynamoNTS_DataService<T extends DynamoFM_Metadata> {
   async getDataByDependencyId(dependencyId?: string, dontSetToService?: boolean): Promise<T> {
     try {
       if (!this.depKey) {
-        throw new DynamoFM_Error({ 
+        throw new DyFM_Error({ 
           ...this._getDefaultErrorSettings(
             'getDataByDependencyId',
             new Error(
@@ -230,7 +230,7 @@ export class DynamoNTS_DataService<T extends DynamoFM_Metadata> {
       }
 
       if (!dependencyId && !this.data[this.depKey]) {
-        throw new DynamoFM_Error({ 
+        throw new DyFM_Error({ 
           ...this._getDefaultErrorSettings(
             'getDataByDependencyId',
             new Error(
@@ -247,7 +247,7 @@ export class DynamoNTS_DataService<T extends DynamoFM_Metadata> {
         dependencyId ?? this.data[this.depKey]
       ).catch((error): null => {
         if (error?.errorCode === 'NTS-DBS-GD2') {
-          DynamoFM_Log.warn(
+          DyFM_Log.warn(
             `getDataByDependencyId failed; ${this.dataParams.dataName} ` +
             `(${this.depKey}: ${dependencyId ?? this.data[this.depKey]}) didn't found any.`
           );
@@ -267,7 +267,7 @@ export class DynamoNTS_DataService<T extends DynamoFM_Metadata> {
       if ([ 'NTS-DS0-GD1', 'NTS-DS0-GD2' ].includes(error?.errorCode)) {
         throw error;
       } else {
-        throw new DynamoFM_Error({ 
+        throw new DyFM_Error({ 
           ...this._getDefaultErrorSettings('getDataByDependencyId', error),
           
           errorCode: 'NTS-DS0-GD0',
@@ -279,7 +279,7 @@ export class DynamoNTS_DataService<T extends DynamoFM_Metadata> {
   async getDatasByDependencyIds(dependencyIds: string[], dontSetToService?: boolean): Promise<T[]> {
     try {
       if (!this.depKey) {
-        throw new DynamoFM_Error({
+        throw new DyFM_Error({
           ...this._getDefaultErrorSettings(
             'getDatasByDependencyIds',
             new Error(
@@ -293,7 +293,7 @@ export class DynamoNTS_DataService<T extends DynamoFM_Metadata> {
       }
 
       if (!dependencyIds) {
-        throw new DynamoFM_Error({
+        throw new DyFM_Error({
           ...this._getDefaultErrorSettings(
             'getDatasByDependencyIds',
             new Error(
@@ -321,7 +321,7 @@ export class DynamoNTS_DataService<T extends DynamoFM_Metadata> {
       if ([ 'NTS-DS0-GDS1', 'NTS-DS0-GDS2' ].includes(error?.errorCode)) {
         throw error;
       } else {
-        throw new DynamoFM_Error({
+        throw new DyFM_Error({
           ...this._getDefaultErrorSettings('getDatasByDependencyIds', error),
 
           errorCode: 'NTS-DS0-GDS0',
@@ -337,7 +337,7 @@ export class DynamoNTS_DataService<T extends DynamoFM_Metadata> {
   async getDataListByDependencyId(dependencyId?: string, dontSetToService?: boolean): Promise<T[]> {
     try {
       if (!this.depKey) {
-        throw new DynamoFM_Error({ 
+        throw new DyFM_Error({ 
           ...this._getDefaultErrorSettings(
             'getDataListByDependencyId',
             new Error(
@@ -351,7 +351,7 @@ export class DynamoNTS_DataService<T extends DynamoFM_Metadata> {
       }
 
       if (!dependencyId && !this.data[this.depKey]) {
-        throw new DynamoFM_Error({ 
+        throw new DyFM_Error({ 
           ...this._getDefaultErrorSettings(
             'getDataListByDependencyId',
             new Error(
@@ -368,7 +368,7 @@ export class DynamoNTS_DataService<T extends DynamoFM_Metadata> {
         dependencyId ?? this.data[this.depKey]
       ).catch((error): T[] => {
         if (error?.errorCode === 'NTS-DBS-GLD2') {
-          DynamoFM_Log.warn(
+          DyFM_Log.warn(
             `getDataListByDependencyId ${this.dataParams.dataName} ` +
             `(${this.depKey}: ${dependencyId ?? this.data[this.depKey]}) didn't found any.`
           );
@@ -388,7 +388,7 @@ export class DynamoNTS_DataService<T extends DynamoFM_Metadata> {
       if ([ 'NTS-DS0-GLD1', 'NTS-DS0-GLD2' ].includes(error?.errorCode)) {
         throw error;
       } else {
-        throw new DynamoFM_Error({ 
+        throw new DyFM_Error({ 
           ...this._getDefaultErrorSettings('getDataListByDependencyId', error),
           
           errorCode: 'NTS-DS0-GLD0',
@@ -428,11 +428,11 @@ export class DynamoNTS_DataService<T extends DynamoFM_Metadata> {
    * //
    * @returns {T} data: T
    */
-  async findData(filterBy: DynamoNTS_DBFilter<T>, dontSetToService?: boolean): Promise<T> {
+  async findData(filterBy: DyNTS_DBFilter<T>, dontSetToService?: boolean): Promise<T> {
     try {
       const dataExists: T = await this.dataDBService.findOne(filterBy).catch((error): null => {
         if (error?.errorCode === 'NTS-DBS-FO1') {
-          DynamoFM_Log.warn(`findData ${this.dataParams.dataName} didn't found any.`);
+          DyFM_Log.warn(`findData ${this.dataParams.dataName} didn't found any.`);
 
           return null;
         } else {
@@ -446,7 +446,7 @@ export class DynamoNTS_DataService<T extends DynamoFM_Metadata> {
 
       return dataExists;
     } catch (error) {
-      throw new DynamoFM_Error({ 
+      throw new DyFM_Error({ 
         ...this._getDefaultErrorSettings('findData', error),
         
         errorCode: 'NTS-DS0-FD0',
@@ -484,11 +484,11 @@ export class DynamoNTS_DataService<T extends DynamoFM_Metadata> {
    * //
    * @returns {T[]} dataList: T[]
    */
-  async findDatas(filterBy: DynamoNTS_DBFilter<T>, dontSetToService?: boolean): Promise<T[]> {
+  async findDatas(filterBy: DyNTS_DBFilter<T>, dontSetToService?: boolean): Promise<T[]> {
     try {
       const dataListExists: T[] = await this.dataDBService.find(filterBy).catch((error): T[] => {
         if (error?.errorCode === 'NTS-DBS-F1') {
-          DynamoFM_Log.warn(`findDatas ${this.dataParams.dataName} didn't found any.`);
+          DyFM_Log.warn(`findDatas ${this.dataParams.dataName} didn't found any.`);
 
           return [];
         } else {
@@ -502,7 +502,7 @@ export class DynamoNTS_DataService<T extends DynamoFM_Metadata> {
 
       return dataListExists;
     } catch (error) {
-      throw new DynamoFM_Error({ 
+      throw new DyFM_Error({ 
         ...this._getDefaultErrorSettings('findDatas', error),
         
         errorCode: 'NTS-DS0-FDS0',
@@ -567,7 +567,7 @@ export class DynamoNTS_DataService<T extends DynamoFM_Metadata> {
    * //
    */
   async updateData(
-    set: { filterBy?: DynamoNTS_DBFilter<T>, update: DynamoNTS_DBUpdate<T> }
+    set: { filterBy?: DyNTS_DBFilter<T>, update: DyNTS_DBUpdate<T> }
   ): Promise<void> {
     try {
       if (set.filterBy) {
@@ -575,20 +575,20 @@ export class DynamoNTS_DataService<T extends DynamoFM_Metadata> {
 
       } else if (this.data._id) {
         await this.dataDBService.updateOne(
-          { _id: this.data._id } as DynamoNTS_DBFilter<T>, 
+          { _id: this.data._id } as DyNTS_DBFilter<T>, 
           set.update, 
           this.issuer
         );
 
       } else if (this.depKey && this.data[this.depKey]) {
         await this.dataDBService.updateOne(
-          { [this.depKey]: this.data[this.depKey] } as DynamoNTS_DBFilter<T>, 
+          { [this.depKey]: this.data[this.depKey] } as DyNTS_DBFilter<T>, 
           set.update, 
           this.issuer
         );
 
       } else {
-        throw new DynamoFM_Error({
+        throw new DyFM_Error({
           ...this._getDefaultErrorSettings(
             'updateData',
             new Error(
@@ -606,7 +606,7 @@ export class DynamoNTS_DataService<T extends DynamoFM_Metadata> {
         throw error;
 
       } else {
-        throw new DynamoFM_Error({ 
+        throw new DyFM_Error({ 
           ...this._getDefaultErrorSettings('updateData', error),
           
           errorCode: 'NTS-DS0-UD0',
@@ -629,7 +629,7 @@ export class DynamoNTS_DataService<T extends DynamoFM_Metadata> {
   async saveData(): Promise<T> {
     try {
       if (!this.data) {
-        throw new DynamoFM_Error({ 
+        throw new DyFM_Error({ 
           ...this._getDefaultErrorSettings(
             'saveData', 
             new Error(`no data to save! (${this.dataParams.dataName})`)
@@ -661,7 +661,7 @@ export class DynamoNTS_DataService<T extends DynamoFM_Metadata> {
           return this.data;
 
         } else {
-          throw new DynamoFM_Error({ 
+          throw new DyFM_Error({ 
             ...this._getDefaultErrorSettings(
               'saveData',
               new Error(
@@ -677,7 +677,7 @@ export class DynamoNTS_DataService<T extends DynamoFM_Metadata> {
 
       if (this.depKey) {
         if (!this.data[this.depKey]) {
-          throw new DynamoFM_Error({ 
+          throw new DyFM_Error({ 
             ...this._getDefaultErrorSettings(
               'saveData',
               new Error(
@@ -706,7 +706,7 @@ export class DynamoNTS_DataService<T extends DynamoFM_Metadata> {
               .catch();
 
             if (!dependencyExists) {
-              throw new DynamoFM_Error({ 
+              throw new DyFM_Error({ 
                 ...this._getDefaultErrorSettings(
                   'saveData',
                   new Error(
@@ -733,7 +733,7 @@ export class DynamoNTS_DataService<T extends DynamoFM_Metadata> {
         throw error;
 
       } else {
-        throw new DynamoFM_Error({ 
+        throw new DyFM_Error({ 
           ...this._getDefaultErrorSettings('saveData', error),
           
           errorCode: 'NTS-DS0-SD0',
@@ -745,10 +745,10 @@ export class DynamoNTS_DataService<T extends DynamoFM_Metadata> {
   /**
    * permanently deletes data from database by data._id
    */
-  async deleteData(): Promise<void> {
+  async deleteData(id?: string): Promise<void> {
     try {
-      if (!this.data._id) {
-        throw new DynamoFM_Error({ 
+      if (!id && !this.data._id) {
+        throw new DyFM_Error({ 
           ...this._getDefaultErrorSettings(
             'deleteData',
             new Error(`deleteData failed, ID is missing! (${this.dataParams.dataName})`)
@@ -758,12 +758,12 @@ export class DynamoNTS_DataService<T extends DynamoFM_Metadata> {
         });
       }
           
-      await this.dataDBService.deleteDataById(this.data._id);
+      await this.dataDBService.deleteDataById(id ?? this.data._id);
     } catch (error) {
       if (error?.errorCode == 'NTS-DS0-DD1') {
         throw error;
       } else {
-        throw new DynamoFM_Error({ 
+        throw new DyFM_Error({ 
           ...this._getDefaultErrorSettings('deleteData', error),
           
           errorCode: 'NTS-DS0-DD0',
@@ -777,25 +777,25 @@ export class DynamoNTS_DataService<T extends DynamoFM_Metadata> {
    */
   async validateForSave(): Promise<void> {
     try {
-      for (let i = 0; i < this.dataParams.properties.length; i++) {
+      for (const element of this.dataParams.properties) {
         // basic required validations
         if (
-          (this.dataParams.properties[i].required && 
-            (this.data[this.dataParams.properties[i].key] === null || 
-              this.data[this.dataParams.properties[i].key] === undefined
+          (element.required && 
+            (this.data[element.key] === null || 
+              this.data[element.key] === undefined
             )
           ) ||
-          (this.dataParams.properties[i].index && 
-            (this.data[this.dataParams.properties[i].key] === null || 
-              this.data[this.dataParams.properties[i].key] === undefined
+          (element.index && 
+            (this.data[element.key] === null || 
+              this.data[element.key] === undefined
             )
           )
         ) {
-          throw new DynamoFM_Error({ 
+          throw new DyFM_Error({ 
             ...this._getDefaultErrorSettings(
               'validateForSave',
               new Error(
-                `validateForSave failed, ${this.dataParams.properties[i].key} is missing! ` +
+                `validateForSave failed, ${element.key} is missing! ` +
                 `(${this.dataParams.dataName})`
               )
             ),
@@ -807,14 +807,14 @@ export class DynamoNTS_DataService<T extends DynamoFM_Metadata> {
         }
 
         // specific Date validation
-        if (this.dataParams.properties[i].type === 'Date' && 
-          !(new Date(this.data[this.dataParams.properties[i].key]) instanceof Date)
+        if (element.type === 'Date' && 
+          !(new Date(this.data[element.key]) instanceof Date)
         ) {
-          throw new DynamoFM_Error({
+          throw new DyFM_Error({
             ...this._getDefaultErrorSettings(
               'validateForSave',
               new Error(
-                `validateForSave failed, ${this.dataParams.properties[i].key} is not a date! ` +
+                `validateForSave failed, ${element.key} is not a date! ` +
                 `(${this.dataParams.dataName})`
               )
             ),
@@ -826,10 +826,10 @@ export class DynamoNTS_DataService<T extends DynamoFM_Metadata> {
         }
 
         // call additional validators
-        if (this.dataParams.properties[i].additionalValidators) {
-          for (let j = 0; j < this.dataParams.properties[i].additionalValidators.length; j++) {
-            this.dataParams.properties[i].additionalValidators[j](
-              this.data[this.dataParams.properties[i].key]
+        if (element.additionalValidators) {
+          for (let j = 0; j < element.additionalValidators.length; j++) {
+            element.additionalValidators[j](
+              this.data[element.key]
             );
           }
         }
@@ -838,7 +838,7 @@ export class DynamoNTS_DataService<T extends DynamoFM_Metadata> {
       if ([ 'NTS-DS0-VD1', 'NTS-DS0-VD2' ].includes(error?.errorCode)) {
         throw error;
       } else {
-        throw new DynamoFM_Error({ 
+        throw new DyFM_Error({ 
           ...this._getDefaultErrorSettings('validateForSave', error),
 
           status: 422, 
@@ -852,8 +852,8 @@ export class DynamoNTS_DataService<T extends DynamoFM_Metadata> {
    * setting up dependency dataHook by DynamoBEDataModelParams
    */
   private lookForDependencyDataSettings(): void {
-    const dependencyParam: DynamoFM_DataProperty_Params = this.dataParams.properties.find(
-      (modelParams: DynamoFM_DataProperty_Params): boolean => modelParams.isDependencyHook
+    const dependencyParam: DyFM_DataProperty_Params = this.dataParams.properties.find(
+      (modelParams: DyFM_DataProperty_Params): boolean => modelParams.isDependencyHook
     );
 
     if (dependencyParam) {
@@ -877,9 +877,9 @@ export class DynamoNTS_DataService<T extends DynamoFM_Metadata> {
    * 
    * @returns 
    */
-  getDependencyDataDBService(): DynamoNTS_DBService<any> {
+  getDependencyDataDBService(): DyNTS_DBService<any> {
     if (!this.depDBServiceKey) {
-      throw new DynamoFM_Error({ 
+      throw new DyFM_Error({ 
         ...this._getDefaultErrorSettings(
           'getDependencyDataDBService',
           new Error(
@@ -896,7 +896,7 @@ export class DynamoNTS_DataService<T extends DynamoFM_Metadata> {
     if (this.depDataDBService) {
       return this.depDataDBService;
     } else {
-      this.depDataDBService = DynamoNTS_GlobalService.getDBServiceByKey(this.depDBServiceKey);
+      this.depDataDBService = DyNTS_GlobalService.getDBServiceByKey(this.depDBServiceKey);
 
       return this.depDataDBService;
     }
@@ -904,17 +904,17 @@ export class DynamoNTS_DataService<T extends DynamoFM_Metadata> {
   
   private _getDefaultErrorSettings(
     fnName: string, 
-    error: DynamoFM_AnyError
-  ): DynamoFM_Error_Settings {
+    error: DyFM_AnyError
+  ): DyFM_Error_Settings {
     return {
-      status: (error as DynamoFM_Error)?.___status ?? 500,
+      status: (error as DyFM_Error)?.___status ?? 500,
       message: 
         (error as Error)?.message ?? 
         `${fnName} was UNSUCCESFUL (NTS; ${this.dataParams.dataName})`,
-      addECToUserMsg: !(error as DynamoFM_Error)?.__userMessage,
-      userMessage: (error as DynamoFM_Error)?.__userMessage ?? this.defaultErrorUserMsg,
+      addECToUserMsg: !(error as DyFM_Error)?.__userMessage,
+      userMessage: (error as DyFM_Error)?.__userMessage ?? this.defaultErrorUserMsg,
       issuer: this.issuer,
-      issuerService: this.serviceName + ` (${this?.constructor?.name}-DynamoNTS_DataService)`,
+      issuerService: this.serviceName + ` (${this?.constructor?.name}-DyNTS_DataService)`,
       error: error,
     };
   }

package/src/_services/base/db.service.spec.ts

@@ -3,7 +3,7 @@
 
 
 
-/* describe('DynamoNTS_DBService', () => {
+/* describe('DyNTS_DBService', () => {
 
   it('should be created', () => {
     expect(true).toBeTrue();