@futdevpro/fsm-dynamo 1.10.38 → 1.10.40

package/src/_modules/usage/_models/usg-daily-usage-data.control-model.ts

@@ -2,13 +2,27 @@
 import { DyFM_UsageSession } from './usg-session.data-model';
 
 
+/**
+ * Aggregated usage information for a specific day.
+ *
+ * @example
+ * ```ts
+ * const daily = new DyFM_DailyUsageData({ date: '2024-07-20' });
+ * ```
+ */
 export class DyFM_DailyUsageData {
+  /** ISO date string of the day */
   date?: string;
+  /** Total time spent on the site that day */
   totalVisitTime?: number = 0;
+  /** Average time of a single visit */
   averageVisitTime?: number = 0;
+  /** Number of visitors from Hungary */
   visitorsHun?: number = 0;
+  /** Number of visitors from other countries */
   visitorsElse?: number = 0;
 
+  /** Sessions belonging to the day */
   visitations?: DyFM_UsageSession[] = [];
 
   constructor(

package/src/_modules/usage/_models/usg-data.control-model.ts

@@ -2,10 +2,26 @@
 import { DyFM_UsageAction } from './usg-action.control-model';
 
 export type DyFM_UsageD = DyFM_UsageData;
+/**
+ * Detailed usage information for a single page visit.
+ *
+ * @example
+ * ```ts
+ * const data = new DyFM_UsageData({
+ *   page: '/home',
+ *   opened: new Date(),
+ *   timeSpentOnPage: 120
+ * });
+ * ```
+ */
 export class DyFM_UsageData {
+  /** URL or identifier of the visited page */
   page?: string;
+  /** When the page was opened */
   opened?: Date;
+  /** Time spent on the page in seconds */
   timeSpentOnPage?: number;
+  /** List of actions performed on the page */
   actions?: DyFM_UsageAction[] = [];
 
   constructor(

package/src/_modules/usage/_models/usg-session.data-model.spec.ts

@@ -1,3 +1,4 @@
+import { DyFM_DataProperties } from '../../../_models/control-models/data-property-params.control-model';
 import { DyFM_GeoIpLocation } from '../../location/_models/loc-geo-ip-location.interface';
 import { DyFM_UsageData } from './usg-data.control-model';
 import { DyFM_UsageSession, DyFM_usageSession_dataParams } from './usg-session.data-model';
@@ -58,7 +59,7 @@ describe('| DyFM_usageSession_dataParams', () => {
   });
 
   it('| should have the correct properties configuration', () => {
-    const properties = DyFM_usageSession_dataParams.properties;
+    const properties: DyFM_DataProperties<DyFM_UsageSession> = DyFM_usageSession_dataParams.properties;
     expect(properties.date.key).toBe('date');
     expect(properties.date.type).toBe('string');
     expect(properties.date.required).toBe(true);

package/src/_modules/usage/_models/usg-session.data-model.ts

@@ -7,16 +7,33 @@ import { DyFM_GeoIpLocation } from '../../location/_models/loc-geo-ip-location.i
 
 import { DyFM_UsageData } from './usg-data.control-model';
 
+/**
+ * Represents a user session including all tracked data.
+ *
+ * @example
+ * ```ts
+ * const session = new DyFM_UsageSession({ sessionStart: new Date() });
+ * ```
+ */
 export class DyFM_UsageSession extends DyFM_Metadata {
+  /** ISO date string of the session */
   date?: string;
+  /** Start time of the session */
   sessionStart?: Date;
+  /** End time of the session */
   sessionEnd?: Date;
+  /** IP address or identifier */
   address?: string;
+  /** Issuer of the session (e.g., user agent) */
   issuer?: string;
+  /** Geolocation data if available */
   locationData?: DyFM_GeoIpLocation;
 
+  /** Actions performed within the session */
   usageData?: DyFM_UsageData[] = [];
+  /** Total session time in seconds */
   totalSessionTime?: number;
+  /** Identifier of the logged in user */
   loggedInAs?: string;
 
   constructor(

package/src/index.ts

@@ -61,6 +61,7 @@ export * from './_models/data-models/errors.data-model';
 export * from './_models/data-models/metadata.data-model';
 
 // models/INTERFACES
+export * from './_models/interfaces/box-bounds.interface';
 export * from './_models/interfaces/error-defaults.interface';
 export * from './_models/interfaces/paged.interface';
 export * from './_models/interfaces/random-weight.interface';

package/tsconfig.json

@@ -9,6 +9,7 @@
       "es2022",
       "dom"
     ],     
+    "strict": false,
     "allowJs": true,
     "declaration": true, 
     "declarationMap": true,