@futdevpro/nts-dynamo 1.10.49 → 1.10.51

package/src/_services/shared.static-service.ts

@@ -7,14 +7,15 @@ import { DyFM_Shared } from '@futdevpro/fsm-dynamo';
 import { DyFM_GeoIpLocation } from '@futdevpro/fsm-dynamo/location';
 
 /**
- * 
+ * Collection of static helper utilities shared across modules.
  */
 export class DyNTS_Shared extends DyFM_Shared {
 
   /**
-   * 
-   * @param request 
-   * @returns 
+   * Extract the IP address from an Express request.
+   *
+   * @param request Incoming HTTP request
+   * @returns Resolved IP string
    */
   static getIpFromRequest(request: Request): string {
     let ip: string;
@@ -32,27 +33,30 @@ export class DyNTS_Shared extends DyFM_Shared {
   }
 
   /**
-   * 
-   * @param request 
-   * @returns 
+   * Lookup the Geo location of a request based on its IP address.
+   *
+   * @param request Incoming request
+   * @returns Resolved geo location information
    */
   static getLocationDataByRequest(request: Request): DyFM_GeoIpLocation {
     return GeoIp.lookup(this.getIpFromRequest(request));
   }
 
   /**
-   * 
-   * @param request 
-   * @returns 
+   * Lookup the Geo location of a raw IP address.
+   *
+   * @param ip IP address string
+   * @returns Geo location information
    */
   static getLocationByIp(ip: string): DyFM_GeoIpLocation {
     return GeoIp.lookup(ip);
   }
 
   /**
-   * 
-   * @param question 
-   * @returns 
+   * Simple CLI helper to prompt the user for input.
+   *
+   * @param question Text displayed to the user
+   * @returns Entered string value
    */
   static async prompt(question: string): Promise<string> {
     const readLine = ReadLine.createInterface({ 

package/src/index.ts

@@ -1,24 +1,60 @@
 
 // COLLECTIONS
+/**
+ * Utility helpers for dealing with archived collections.
+ *
+ * @example
+ * ```ts
+ * const name = DyNTS_getArchivedDBName('users');
+ * // => 'users_archived'
+ * ```
+ */
 export * from './_collections/archive.util';
+
+/**
+ * Common application wide settings used across the framework.
+ *
+ * @example
+ * ```ts
+ * console.log(DyNTS_global_settings.baseUrl);
+ * ```
+ */
 export * from './_collections/global-settings.const';
 
 
 // ENUMS
+/**
+ * Enumerations describing model usage locations.
+ */
 export * from './_enums/data-model-type.enum';
+
+/**
+ * Enumerations listing the supported service function names.
+ */
 export * from './_enums/data-service-function.enum';
+
+/**
+ * Common primitive data types used in models.
+ */
 export * from './_enums/predefined-data-types.enum';
+
+/**
+ * Defines if routes should use HTTP, HTTPS or both.
+ */
 export * from './_enums/route-security.enum';
 
 
 // MODELS (CONTROL-MODELS, INTERFACES, TYPES)
-// models/INTERFACES
+
+/** Interfaces describing global configuration and certificates. */
 export * from './_models/interfaces/certification-settings.interface';
 export * from './_models/interfaces/global-service-settings.interface';
 export * from './_models/interfaces/global-settings.interface';
 export * from './_models/interfaces/routing-module-settings.interface';
 
 // models/CONTROL MODELS
+
+/** Classes defining runtime structures without database persistence. */
 export * from './_models/control-models/api-call-params.control-model';
 export * from './_models/control-models/app-ext-system-controls.control-model'
 export * from './_models/control-models/app-params.control-model';
@@ -28,32 +64,57 @@ export * from './_models/control-models/http-settings.control-model';
 export * from './_models/control-models/system-control.control-model';
 
 // models/TYPES
+
+/** Types describing MongoDB style update objects. */
 export * from './_models/types/db-update.type';
 
 
 // SERVICES
 // services/CORE
+/** Client side helper for making HTTP requests. */
 export * from './_services/core/api.service';
+
+/** Basic authentication helper functions. */
 export * from './_services/core/auth.service';
+
+/** Utility for sending transactional emails. */
 export * from './_services/core/email.service';
+
+/** Global service registry and bootstrapping utilities. */
 export * from './_services/core/global.service';
+
+/** Singleton service container. */
 export * from './_services/core/service-collection.service';
 
 // services/BASE
+/** Handles moving data to archive collections. */
 export * from './_services/base/archive-data.service';
+
+/** Basic CRUD service used by feature modules. */
 export * from './_services/base/data.service';
+
+/** Thin wrapper around the database driver. */
 export * from './_services/base/db.service';
+
+/** Base class for implementing singleton services. */
 export * from './_services/base/singleton.service';
 
 // services/SERVER
+/** Express server wrapper. */
 export * from './_services/server/app.server';
+
+/** Environment detection helpers. */
 export * from './_services/server/env-set';
 
 // services/ROUTE
+/** Abstract base controller for defining routes. */
 export * from './_services/route/controller.service';
+
+/** Handles route registration and mounting. */
 export * from './_services/route/routing-module.service';
 
 // services/SHARED
+/** Assorted shared helpers accessible statically. */
 export * from './_services/shared.static-service';