@futdevpro/fsm-dynamo 1.10.37 → 1.10.39

package/src/_modules/custom-data/_collections/cud-module-settings.const.ts

@@ -1,11 +1,17 @@
 
 import { DyFM_Route_Settings } from '../../../_models/interfaces/route-settings.interface';
 
+/**
+ * Routes available in the Custom Data module.
+ */
 export enum DyFM_CustomRoute {
   getCustomData = 'getCustomData',
   modifyCustomData = 'modifyCustomData',
 }
 
+/**
+ * Default settings for the Custom Data module.
+ */
 export const DyFM_customDataModule_settings: DyFM_Route_Settings<DyFM_CustomRoute> = {
   mainRoute: '/custom',
   endPoints: {

package/src/_modules/custom-data/_models/cud.data-model.ts

@@ -5,6 +5,9 @@ import {
 import { DyFM_Metadata } from '../../../_models/data-models/metadata.data-model';
 
 export type DyFM_CustomD = DyFM_CustomData;
+/**
+ * Generic data container that can store custom information.
+ */
 export class DyFM_CustomData<T = any> extends DyFM_Metadata {
   data?: T;
 

package/src/_modules/location/_collections/loc-country-divisions.const.ts

@@ -5,6 +5,7 @@
 import { DyFM_CountryDivision } from '../_models/loc-country-division.interface';
 import { DyFM_Regions } from './loc-regions.util';
 
-export const DyFM_countryDivisions: DyFM_CountryDivision[] = 
+/** List of country subdivisions indexed by ISO-3166 codes. */
+export const DyFM_countryDivisions: DyFM_CountryDivision[] =
   DyFM_Regions?.divisions ?? [];
   

package/src/_modules/location/_collections/loc-regions.util.ts

@@ -18,6 +18,10 @@ import { DyFM_JSONListify } from '../../../_collections/utils/utilities.util';
 import { DyFM_Error } from '../../../_models/control-models/error.control-model';
 
 
+/**
+ * Static utilities for retrieving country and region information
+ * from bundled ISO datasets.
+ */
 export class DyFM_Regions {
   /* static divisions: DivisionCollection = DyFM_Regions.getSubdivisionCollection(); */
   static readonly divisions: DyFM_CountryDivision[] = DyFM_Regions.getAllDivisions();

package/src/_modules/location/_collections/loc.util.ts

@@ -1,12 +1,17 @@
 
 import { DyFM_Error } from '../../../_models/control-models/error.control-model';
 import { DyFM_Trigonometry } from '../../../_collections/utils/math/trigonometry.util';
-import { 
-  DyFM_LocationCoordinates 
+import {
+  DyFM_LocationCoordinates
 } from '../_models/loc-coordinates.interface';
 
+/**
+ * Helper utilities for geographic calculations.
+ */
 export class DyFM_Location {
-  
+  /**
+   * Calculates the distance between two coordinates using the haversine formula.
+   */
   static getDistanceInKilometres(
     from: DyFM_LocationCoordinates,
     to: DyFM_LocationCoordinates
@@ -26,9 +31,12 @@ export class DyFM_Location {
     return R * c;
   }
 
+  /**
+   * Converts a distance in kilometers to degree difference for latitude or longitude.
+   */
   static getLocationDegByKilometers(
-    latiOrLong: 'latitude' | 'longitude', 
-    distanceInKm: number, 
+    latiOrLong: 'latitude' | 'longitude',
+    distanceInKm: number,
     latitude?: number
   ): number {
     if (latiOrLong === 'latitude') {

package/src/_modules/location/_enums/loc-region.enum.ts

@@ -1,6 +1,9 @@
 
 
 
+/**
+ * Continents and large geographic regions.
+ */
 export enum DyFM_Region {
   europe = 'Europe',
   asia = 'Asia',

package/src/_modules/location/_enums/loc-sub-region.enum.ts

@@ -1,6 +1,9 @@
 
 
 
+/**
+ * List of geographic subregions.
+ */
 export enum DyFM_SubRegion {
   northernEurope = 'Northern Europe',
   southernEurope = 'Southern Europe',

package/src/_modules/location/_enums/loc-subdivision-region-type.enum.ts

@@ -1,40 +1,43 @@
 
 
+/**
+ * Types of administrative divisions.
+ */
 export enum DyFM_SubdivisionRegionType {
-  parish,
-  emirate,
-  province,
-  dependency,
-  county,
-  city,
-  region,
-  state,
-  territory,
-  autonomousRepublic,
-  municipate,
-  rayon,
-  division,
-  district,
-  governorate,
-  department,
-  specialMunicipality,
-  federalDistrict,
-  island,
-  town,
-  oblast,
-  commune,
-  prefecture,
-  economicPrefecture,
-  canton,
-  autonomousRegion,
-  specialAdministrativeRegion,
-  capitalDistrict,
-  geographicalRegion,
-  capitalCity,
-  ruralMunicipality,
-  urbanMunicipality,
-  autonomousCommunity,
-  autonomousCity,
+  parish,                 // smaller church administrative region
+  emirate,               // territories ruled by an emir
+  province,              // first-level subdivision in many countries
+  dependency,            // territories dependent on another state
+  county,                // common administrative unit
+  city,                  // incorporated municipality
+  region,                // generic region type
+  state,                 // first-level political subdivision
+  territory,             // land under a jurisdiction
+  autonomousRepublic,    // self-governing republic inside a country
+  municipate,            // municipality-like entity
+  rayon,                 // district used in some post-Soviet states
+  division,              // general division level
+  district,              // smaller subdivision within a state
+  governorate,           // province headed by a governor
+  department,            // used in several countries like France
+  specialMunicipality,   // municipality with special status
+  federalDistrict,       // district under federal jurisdiction
+  island,                // geographic island region
+  town,                  // small urban area
+  oblast,                // administrative region in Slavic countries
+  commune,               // community-level division
+  prefecture,            // prefectural region as in Japan
+  economicPrefecture,    // economic focused prefecture
+  canton,                // administrative division, e.g., Switzerland
+  autonomousRegion,      // region with high autonomy
+  specialAdministrativeRegion, // SAR like Hong Kong
+  capitalDistrict,       // district for capital
+  geographicalRegion,    // purely geographic region
+  capitalCity,           // denotes the capital city
+  ruralMunicipality,     // rural municipality
+  urbanMunicipality,     // urban municipality
+  autonomousCommunity,   // e.g., Spain's communities
+  autonomousCity,        // autonomous city
   administration,
   regionalState,
   metropolitanRegion,

package/src/_modules/location/_models/loc-coordinates.interface.ts

@@ -1,5 +1,6 @@
 
 
+/** Geographic coordinates with longitude and latitude. */
 export interface DyFM_LocationCoordinates {
   longitude: number;
   latitude: number;

package/src/_modules/open-ai/_enums/open-ai-model.enum.ts

@@ -3,6 +3,9 @@
 
 
 
+/**
+ * Models available through the OpenAI API.
+ */
 export enum DyFM_OpenAIModel {
   // GPT-3.5
   /* gpt35_turbo = 'gpt-3.5-turbo',
@@ -14,11 +17,11 @@ export enum DyFM_OpenAIModel {
 
   // GPT-4
   // gpt-4
-  gpt4o = 'gpt-4o',
+  gpt4o = 'gpt-4o', // Latest GPT‑4 Omni model
   // gpt-4o-2024-08-06
-  gpt4o_20240806 = 'gpt-4o-2024-08-06',
+  gpt4o_20240806 = 'gpt-4o-2024-08-06', // Pinned August 2024 release
   // gpt-4o-2024-05-13
-  gpt4o_20240513 = 'gpt-4o-2024-05-13',
+  gpt4o_20240513 = 'gpt-4o-2024-05-13', // Pinned May 2024 release
 
   /* gpt4 = 'gpt-4',
   gpt4_0613 = 'gpt-4-0613',
@@ -30,9 +33,9 @@ export enum DyFM_OpenAIModel {
 
   // GPT-Mini
   // gpt-4o-mini
-  gpt4o_mini = 'gpt-4o-mini',
+  gpt4o_mini = 'gpt-4o-mini', // Lightweight GPT‑4o variant
   // gpt-4o-mini-2024-07-18
-  gpt4o_mini20240718 = 'gpt-4o-mini-2024-07-18',
+  gpt4o_mini20240718 = 'gpt-4o-mini-2024-07-18', // Pinned July 2024 mini release
 
 
   // GPT-4o
@@ -56,11 +59,11 @@ export enum DyFM_OpenAIModel {
 
   // Text Embeddings
   // text-embedding-3-small
-  textEmbedding_3Small = 'text-embedding-3-small',
+  textEmbedding_3Small = 'text-embedding-3-small', // Small embedding model
   // text-embedding-3-large
-  textEmbedding_3Large = 'text-embedding-3-large',
+  textEmbedding_3Large = 'text-embedding-3-large', // Large embedding model
   // text-embedding-ada-002
-  textEmbedding_ada002 = 'text-embedding-ada-002',
+  textEmbedding_ada002 = 'text-embedding-ada-002', // Older Ada embedding model
 
   /* textEmbedding_ada002 = 'text-embedding-ada-002',
   textEmbedding_3Small = 'text-embedding-3-small',

package/src/_modules/pipe/_enums/pip-range-pipe-setting.enum.ts

@@ -1,5 +1,8 @@
 
 
+/**
+ * Keys available for configuring the range pipe.
+ */
 export enum DyFM_RangePipe_Setting {
   avg = 'avg',
   average = 'average',

package/src/_modules/pipe/_enums/pip.enum.ts

@@ -1,9 +1,15 @@
 
 
-export type DyFM_MultiPipeAvailable = 
+/**
+ * Type that accepts either Dynamo or Angular pipes.
+ */
+export type DyFM_MultiPipeAvailable =
   DyFM_AngularMultiPipeAvailable | DyFM_Pipe;
 
 
+/**
+ * Pipe types supported by Dynamo.
+ */
 export enum DyFM_Pipe {
   country = 'country',
   custom = 'custom',
@@ -19,6 +25,9 @@ export enum DyFM_Pipe {
 }
 
 
+/**
+ * Built-in pipes provided by Angular.
+ */
 export enum DyFM_AngularMultiPipeAvailable {
   number = 'number',
   decimal = 'decimal',
@@ -27,7 +36,10 @@ export enum DyFM_AngularMultiPipeAvailable {
   percent = 'percent',
 }
 
-export const DyFM_allMultiPipesAvailable: DyFM_MultiPipeAvailable[] = [ 
+/**
+ * Array containing every supported pipe.
+ */
+export const DyFM_allMultiPipesAvailable: DyFM_MultiPipeAvailable[] = [
   ...Object.values(DyFM_AngularMultiPipeAvailable), 
 
   DyFM_Pipe.country,
@@ -42,9 +54,11 @@ export const DyFM_allMultiPipesAvailable: DyFM_MultiPipeAvailable[] = [
 ] as DyFM_MultiPipeAvailable[];
 
 
+/** List of Dynamo specific pipes. */
 export const DyFM_allDynamoPipes: DyFM_Pipe[] = Object.values(DyFM_Pipe);
 
 
-export const DyFM_allMultiPipeAngularPipes: DyFM_AngularMultiPipeAvailable[] = 
+/** Default Angular pipes. */
+export const DyFM_allMultiPipeAngularPipes: DyFM_AngularMultiPipeAvailable[] =
   Object.values(DyFM_AngularMultiPipeAvailable);
 

package/src/_modules/socket/_enums/sck-event-key.enum.ts

@@ -1,4 +1,7 @@
 
+/**
+ * Names of socket.io events used by the framework.
+ */
 export enum DyFM_SocketEvent_Key {
   /** incoming connection in socket.io */
   incomingNewConnection = 'connection',

package/src/_modules/socket/_models/sck-client-params.control-model.ts

@@ -4,6 +4,18 @@ import * as SocketIOClient from 'socket.io-client';
 import { second } from '../../../_collections/constants/times.const';
 import { DyFM_Log } from '../../../_collections/utils/log.util';
 
+/**
+ * Configuration parameters for a socket client.
+ *
+ * @example
+ * ```ts
+ * new DyFM_SocketClient_Params({
+ *   name: 'demo',
+ *   address: 'http://localhost',
+ *   port: 3000
+ * });
+ * ```
+ */
 export class DyFM_SocketClient_Params {
   name?: string;
   service?: string;

package/src/_modules/socket/_models/sck-socket-event.control-model.ts

@@ -12,7 +12,18 @@ export type DyFM_SocketEventPreprocessTask<T = any, R = any> =
 export type DyFM_SocketEventTask<T> = (content?: T, issuer?: string) => Promise<void>;
 
 /**
- * socket handling and clarification is under development
+ * Describes a socket.io event with pre-processing and task handling.
+ *
+ * Use this model to define how incoming socket events should be processed
+ * and what actions should be executed once the data is prepared.
+ *
+ * @example
+ * ```ts
+ * const event = new DyFM_SocketEvent<string>({
+ *   eventKey: DyFM_SocketEvent_Key.subscribe,
+ *   tasks: [async msg => console.log(msg)]
+ * });
+ * ```
  */
 export class DyFM_SocketEvent<T>{
   name?: string;

package/src/_modules/socket/_services/sck-client.service-base.ts

@@ -14,6 +14,10 @@ import { DyFM_SocketEvent_Key } from '../_enums/sck-event-key.enum';
 import { DyFM_SocketClient_Params } from '../_models/sck-client-params.control-model';
 import { DyFM_SocketEvent } from '../_models/sck-socket-event.control-model';
 
+/**
+ * Base implementation for socket.io clients used by Dynamo.
+ * Handles connection logic, subscriptions and default events.
+ */
 export abstract class DyFM_SocketClient_ServiceBase<T_SubscriptionContent = any> {
 
   private _params: DyFM_SocketClient_Params;

package/src/_modules/test/_collections/tst-module-settings.const.ts

@@ -4,6 +4,9 @@ import {
 } from '../../../_models/control-models/service-endpoint-settings-base.control-model';
 import { DyFM_Route_Settings } from '../../../_models/interfaces/route-settings.interface';
 
+/**
+ * Routes used by the test module.
+ */
 export enum DyFM_TestRoute {
   testGet = 'test-get',
   testPost = 'test-post',
@@ -13,6 +16,9 @@ export enum DyFM_TestRoute {
   getServerStatus = 'get-server-status',
 }
 
+/**
+ * Default route settings for the test module.
+ */
 export const DyFM_testModule_settings: DyFM_Route_Settings<DyFM_TestRoute> = {
   mainRoute: '/test',
   endPoints: {
@@ -22,6 +28,9 @@ export const DyFM_testModule_settings: DyFM_Route_Settings<DyFM_TestRoute> = {
   },
 };
 
+/**
+ * Map of routes with their full path.
+ */
 export const DyFM_fullTestRoute = {
   [DyFM_TestRoute.testGet]: DyFM_testModule_settings.mainRoute + 
     DyFM_testModule_settings.endPoints[DyFM_TestRoute.testGet],

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

@@ -1,7 +1,20 @@
 
 
+/**
+ * Represents a single user action during a session.
+ *
+ * @example
+ * ```ts
+ * const action = new DyFM_UsageAction({
+ *   action: 'click',
+ *   time: new Date()
+ * });
+ * ```
+ */
 export class DyFM_UsageAction {
+  /** Type of the action performed */
   action?: string;
+  /** Timestamp of when the action happened */
   time?: Date;
 
   constructor(

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,