@futdevpro/nts-dynamo 1.9.15 → 1.9.16

package/src/_modules/usage/usage.data-service.ts

@@ -1,172 +1,172 @@
-
-import { Request } from 'express';
-import { DynamoFM_Error, DynamoFM_Time, DynamoFM_RelativeDate } from '@futdevpro/fsm-dynamo';
-import { DynamoFM_UsageSession, DynamoFM_usageSessionModel_params, DynamoFM_UsageData, 
-  DynamoFM_DailyUsageData } from '@futdevpro/fsm-dynamo/usage-module';
-
-import { DynamoNTS_DataService } from '../../_services/base/data.service';
-import { DynamoNTS_Shared } from '../../_services/shared.static-service';
-
-export class DynamoNTS_Usage_DataService extends DynamoNTS_DataService<DynamoFM_UsageSession> {
-  usageData: DynamoFM_UsageData[] = [];
-  simplifiedDailyUsage: DynamoFM_DailyUsageData[] = [];
-
-  constructor(
-    set?: {
-      usageSession?: DynamoFM_UsageSession,
-      usageData?: DynamoFM_UsageData[],
-      issuer?: string,
-    }
-  ) {
-    super(
-      new DynamoFM_UsageSession(set?.usageSession),
-      DynamoFM_usageSessionModel_params,
-      set?.issuer
-    );
-    this.usageData = set?.usageData ? set?.usageData : [];
-  }
-
-  getLocationDataFromRequest(req: Request): void {
-    try {
-      this.data.address = DynamoNTS_Shared.getIpFromRequest(req);
-      this.data.locationData = DynamoNTS_Shared.getLocationDataByRequest(req);
-
-      /* console.log(`...getLocationDataFromRequest... ip: ${this.data.address}`, this.data.locationData); */
-    } catch (error) {
-      throw new DynamoFM_Error({ 
-        ...this.getDefaultErrorSettings('getLocationDataFromRequest', error),
-        
-        errorCode: 'NTS-US0-GLD',
-        userMessage: `We were unable to deep analyze your request.`,
-      });
-    }
-  }
-
-  async getUsage(range: DynamoFM_RelativeDate = DynamoFM_RelativeDate.lastWeek): Promise<void> {
-    try {
-      await this.dataDBService.find({
-        sessionStart: { $gte: DynamoFM_Time.getDateByRelativeDate(range) },
-      }).then((res: DynamoFM_UsageSession[]): void => {
-        this.dataList = res;
-      });
-      this.simplifiedDailyUsage = [];
-      this.dataList.forEach((session: DynamoFM_UsageSession): void => {
-        let dateIndex = this.simplifiedDailyUsage.findIndex(
-          (dailyData: DynamoFM_DailyUsageData): boolean => dailyData.date === session.date
-        );
-
-        if (-1 < dateIndex) {
-          this.simplifiedDailyUsage[dateIndex].visitations.push(session);
-        } else {
-          const newUsageSimple = new DynamoFM_DailyUsageData({ 
-            date: session.date, 
-            visitations: [ session ],
-          });
-
-          this.simplifiedDailyUsage.push(newUsageSimple);
-          dateIndex = this.simplifiedDailyUsage.length - 1;
-        }
-
-        if (session?.locationData?.country) {
-          if (session.locationData.country === 'HU') {
-            this.simplifiedDailyUsage[dateIndex].visitorsHun++;
-          } else {
-            this.simplifiedDailyUsage[dateIndex].visitorsElse++;
-          }
-        }
-        this.simplifiedDailyUsage[dateIndex].totalVisitTime += session.totalSessionTime;
-        this.simplifiedDailyUsage[dateIndex].averageVisitTime = Math.round(
-          (this.simplifiedDailyUsage[dateIndex].totalVisitTime /
-            this.simplifiedDailyUsage[dateIndex].visitations.length) * 100
-        ) / 100;
-      });
-
-      this.simplifiedDailyUsage.sort(
-        (a: DynamoFM_DailyUsageData, b: DynamoFM_DailyUsageData): number => 
-          +new Date(b.date) - +new Date(a.date)
-      );
-      this.simplifiedDailyUsage.forEach((daily: DynamoFM_DailyUsageData): void => {
-        daily.visitations.sort(
-          (a: DynamoFM_UsageSession, b: DynamoFM_UsageSession): number => 
-            +a.sessionStart - +b.sessionStart
-        );
-      });
-
-    } catch (error) {
-      throw new DynamoFM_Error({ 
-        ...this.getDefaultErrorSettings('getLastWeekUsage', error),
-        
-        errorCode: 'NTS-US0-GLW',
-        userMessage: `We've failed to collect last week's usage data.`,
-      });
-    }
-  }
-
-  async updateUsageData(req: Request): Promise<void> {
-    try {
-      await this.getDataById();
-      this.data.usageData = this.usageData;
-      let totalTime = 0;
-
-      this.data.usageData.forEach((data: DynamoFM_UsageData): void => {
-        totalTime += data.timeSpentOnPage;
-      });
-
-      if (!this.data.locationData) {
-        this.getLocationDataFromRequest(req);
-      }
-      this.data.totalSessionTime = totalTime;
-      await this.saveData();
-    } catch (error) {
-      throw new DynamoFM_Error({ 
-        ...this.getDefaultErrorSettings('updateUsageData', error),
-        
-        errorCode: 'NTS-US0-UU0',
-        userMessage: `The attempt to update Usage Data was unsuccessful.`,
-      });
-    }
-  }
-
-  async closeSession(req: Request): Promise<void> {
-    try {
-      await this.getDataById();
-      this.data.sessionEnd = new Date();
-      const newTotalSessionTime = +this.data.sessionEnd - +this.data.sessionStart;
-
-      this.data.usageData[this.data.usageData.length - 1].timeSpentOnPage = 
-        newTotalSessionTime - this.data.totalSessionTime;
-      
-      if (!this.data.locationData) {
-        this.getLocationDataFromRequest(req);
-      }
-      this.data.usageData.sort(
-        (a: DynamoFM_UsageData, b: DynamoFM_UsageData): number => +a.opened - +b.opened
-      );
-      this.data.totalSessionTime = newTotalSessionTime;
-      await this.saveData();
-    } catch (error) {
-      throw new DynamoFM_Error({ 
-        ...this.getDefaultErrorSettings('closeSession', error),
-        
-        errorCode: 'NTS-US0-CS0',
-        userMessage: `The attempt to close Usage Session was unsuccessful.`,
-      });
-    }
-  }
-  
-  // eslint-disable-next-line @typescript-eslint/explicit-function-return-type
-  private getDefaultErrorSettings(
-    fnName: string, 
-    error: Error | DynamoFM_Error
-  )/* : DynamoFM_ErrorSettings */ {
-    return {
-      status: (error as DynamoFM_Error)?.___status ?? 417,
-      message: (error as Error)?.message ?? `${fnName} was UNSUCCESFUL (NTS; ${this.serviceName})`,
-      addECToUserMsg: true,
-      userMessage: this.defaultErrorUserMsg,
-      issuer: this.issuer,
-      issuerService: this.serviceName,
-      error: error,
-    };
-  }
-}
+
+import { Request } from 'express';
+import { DynamoFM_Error, DynamoFM_Time, DynamoFM_RelativeDate } from '@futdevpro/fsm-dynamo';
+import { DynamoFM_UsageSession, DynamoFM_usageSessionModel_params, DynamoFM_UsageData, 
+  DynamoFM_DailyUsageData } from '@futdevpro/fsm-dynamo/usage-module';
+
+import { DynamoNTS_DataService } from '../../_services/base/data.service';
+import { DynamoNTS_Shared } from '../../_services/shared.static-service';
+
+export class DynamoNTS_Usage_DataService extends DynamoNTS_DataService<DynamoFM_UsageSession> {
+  usageData: DynamoFM_UsageData[] = [];
+  simplifiedDailyUsage: DynamoFM_DailyUsageData[] = [];
+
+  constructor(
+    set?: {
+      usageSession?: DynamoFM_UsageSession,
+      usageData?: DynamoFM_UsageData[],
+      issuer?: string,
+    }
+  ) {
+    super(
+      new DynamoFM_UsageSession(set?.usageSession),
+      DynamoFM_usageSessionModel_params,
+      set?.issuer
+    );
+    this.usageData = set?.usageData ? set?.usageData : [];
+  }
+
+  getLocationDataFromRequest(req: Request): void {
+    try {
+      this.data.address = DynamoNTS_Shared.getIpFromRequest(req);
+      this.data.locationData = DynamoNTS_Shared.getLocationDataByRequest(req);
+
+      /* console.log(`...getLocationDataFromRequest... ip: ${this.data.address}`, this.data.locationData); */
+    } catch (error) {
+      throw new DynamoFM_Error({ 
+        ...this.getDefaultErrorSettings('getLocationDataFromRequest', error),
+        
+        errorCode: 'NTS-US0-GLD',
+        userMessage: `We were unable to deep analyze your request.`,
+      });
+    }
+  }
+
+  async getUsage(range: DynamoFM_RelativeDate = DynamoFM_RelativeDate.lastWeek): Promise<void> {
+    try {
+      await this.dataDBService.find({
+        sessionStart: { $gte: DynamoFM_Time.getDateByRelativeDate(range) },
+      }).then((res: DynamoFM_UsageSession[]): void => {
+        this.dataList = res;
+      });
+      this.simplifiedDailyUsage = [];
+      this.dataList.forEach((session: DynamoFM_UsageSession): void => {
+        let dateIndex = this.simplifiedDailyUsage.findIndex(
+          (dailyData: DynamoFM_DailyUsageData): boolean => dailyData.date === session.date
+        );
+
+        if (-1 < dateIndex) {
+          this.simplifiedDailyUsage[dateIndex].visitations.push(session);
+        } else {
+          const newUsageSimple = new DynamoFM_DailyUsageData({ 
+            date: session.date, 
+            visitations: [ session ],
+          });
+
+          this.simplifiedDailyUsage.push(newUsageSimple);
+          dateIndex = this.simplifiedDailyUsage.length - 1;
+        }
+
+        if (session?.locationData?.country) {
+          if (session.locationData.country === 'HU') {
+            this.simplifiedDailyUsage[dateIndex].visitorsHun++;
+          } else {
+            this.simplifiedDailyUsage[dateIndex].visitorsElse++;
+          }
+        }
+        this.simplifiedDailyUsage[dateIndex].totalVisitTime += session.totalSessionTime;
+        this.simplifiedDailyUsage[dateIndex].averageVisitTime = Math.round(
+          (this.simplifiedDailyUsage[dateIndex].totalVisitTime /
+            this.simplifiedDailyUsage[dateIndex].visitations.length) * 100
+        ) / 100;
+      });
+
+      this.simplifiedDailyUsage.sort(
+        (a: DynamoFM_DailyUsageData, b: DynamoFM_DailyUsageData): number => 
+          +new Date(b.date) - +new Date(a.date)
+      );
+      this.simplifiedDailyUsage.forEach((daily: DynamoFM_DailyUsageData): void => {
+        daily.visitations.sort(
+          (a: DynamoFM_UsageSession, b: DynamoFM_UsageSession): number => 
+            +a.sessionStart - +b.sessionStart
+        );
+      });
+
+    } catch (error) {
+      throw new DynamoFM_Error({ 
+        ...this.getDefaultErrorSettings('getLastWeekUsage', error),
+        
+        errorCode: 'NTS-US0-GLW',
+        userMessage: `We've failed to collect last week's usage data.`,
+      });
+    }
+  }
+
+  async updateUsageData(req: Request): Promise<void> {
+    try {
+      await this.getDataById();
+      this.data.usageData = this.usageData;
+      let totalTime = 0;
+
+      this.data.usageData.forEach((data: DynamoFM_UsageData): void => {
+        totalTime += data.timeSpentOnPage;
+      });
+
+      if (!this.data.locationData) {
+        this.getLocationDataFromRequest(req);
+      }
+      this.data.totalSessionTime = totalTime;
+      await this.saveData();
+    } catch (error) {
+      throw new DynamoFM_Error({ 
+        ...this.getDefaultErrorSettings('updateUsageData', error),
+        
+        errorCode: 'NTS-US0-UU0',
+        userMessage: `The attempt to update Usage Data was unsuccessful.`,
+      });
+    }
+  }
+
+  async closeSession(req: Request): Promise<void> {
+    try {
+      await this.getDataById();
+      this.data.sessionEnd = new Date();
+      const newTotalSessionTime = +this.data.sessionEnd - +this.data.sessionStart;
+
+      this.data.usageData[this.data.usageData.length - 1].timeSpentOnPage = 
+        newTotalSessionTime - this.data.totalSessionTime;
+      
+      if (!this.data.locationData) {
+        this.getLocationDataFromRequest(req);
+      }
+      this.data.usageData.sort(
+        (a: DynamoFM_UsageData, b: DynamoFM_UsageData): number => +a.opened - +b.opened
+      );
+      this.data.totalSessionTime = newTotalSessionTime;
+      await this.saveData();
+    } catch (error) {
+      throw new DynamoFM_Error({ 
+        ...this.getDefaultErrorSettings('closeSession', error),
+        
+        errorCode: 'NTS-US0-CS0',
+        userMessage: `The attempt to close Usage Session was unsuccessful.`,
+      });
+    }
+  }
+  
+  // eslint-disable-next-line @typescript-eslint/explicit-function-return-type
+  private getDefaultErrorSettings(
+    fnName: string, 
+    error: Error | DynamoFM_Error
+  )/* : DynamoFM_ErrorSettings */ {
+    return {
+      status: (error as DynamoFM_Error)?.___status ?? 417,
+      message: (error as Error)?.message ?? `${fnName} was UNSUCCESFUL (NTS; ${this.serviceName})`,
+      addECToUserMsg: true,
+      userMessage: this.defaultErrorUserMsg,
+      issuer: this.issuer,
+      issuerService: this.serviceName,
+      error: error,
+    };
+  }
+}

package/src/_modules/usage-module.index.ts

@@ -1,2 +1,2 @@
-
-export * from './usage';
+
+export * from './usage';