@digitaldefiance/node-express-suite 3.12.16 → 3.13.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@digitaldefiance/node-express-suite",
-  "version": "3.12.16",
+  "version": "3.13.0",
   "homepage": "https://github.com/Digital-Defiance/node-express-suite",
   "repository": {
     "type": "git",
@@ -38,6 +38,7 @@
     "publish:public": "npm publish --access public"
   },
   "dependencies": {
+    "@brightchain/brightchain-lib": "file:../../../BrightChain/dist/brightchain-lib",
     "@digitaldefiance/ecies-lib": "4.18.0",
     "@digitaldefiance/i18n-lib": "4.5.0",
     "@digitaldefiance/mongoose-types": "8.20.9",

package/src/application-base.d.ts

@@ -1,47 +1,55 @@
 /**
  * @fileoverview Base application class with core functionality.
- * Provides database connection, schema management, and plugin support.
+ * Delegates database operations to an IDatabase instance (or legacy IDocumentStore).
  * @module application-base
  */
-import mongoose, { Model } from '@digitaldefiance/mongoose-types';
+import type { BsonDocument, ICollection, IDatabase, IDatabaseLifecycleHooks } from '@brightchain/brightchain-lib';
+import { Model } from '@digitaldefiance/mongoose-types';
+import mongoose from '@digitaldefiance/mongoose-types';
 import { MongoMemoryReplSet } from 'mongodb-memory-server';
 import { ServiceContainer } from './container';
 import { IBaseDocument } from './documents/base';
 import { Environment } from './environment';
 import { IApplication } from './interfaces/application';
 import { IConstants } from './interfaces/constants';
-import { IFailableResult } from './interfaces/failable-result';
+import { IDocumentStore } from './interfaces/document-store';
 import { PluginManager } from './plugins';
 import { SchemaMap } from './types';
 import type { PlatformID } from '@digitaldefiance/node-ecies-lib';
 /**
- * Base Application class with core functionality
+ * Base Application class with core functionality.
+ * Accepts an IDatabase (preferred) or legacy IDocumentStore for backward compatibility.
+ * When an IDatabase is provided, database lifecycle is managed through the IDatabase contract.
+ * When a legacy IDocumentStore is provided, it is used directly for backward compatibility.
  */
 export declare class BaseApplication<TID extends PlatformID, TModelDocs extends Record<string, IBaseDocument<any, TID>>, TInitResults, TConstants extends IConstants = IConstants> implements IApplication<TID> {
     /**
      * Application environment
      */
     private _environment;
-    /**
-     * In-memory MongoDB instance for development
-     */
-    private _devDatabase?;
     /**
      * Constants for the application
      */
     private _constants;
     /**
-     * Function to create the schema map given a Mongoose connection
+     * The IDatabase instance for storage-agnostic database operations.
+     * Set when an IDatabase is passed to the constructor.
      */
-    private readonly _schemaMapFactory;
+    protected readonly _database: IDatabase | undefined;
     /**
-     * Function to initialize the database with default data
+     * The injected document store handling all database operations.
+     * Set when a legacy IDocumentStore is passed to the constructor.
+     * @deprecated Prefer _database (IDatabase) for new code.
      */
-    private readonly _databaseInitFunction;
+    protected readonly _documentStore: IDocumentStore<TID, TModelDocs> | undefined;
     /**
-     * Function to create a hash from the database initialization results (for logging purposes)
+     * Optional lifecycle hooks for database initialization on the IDatabase path.
      */
-    private readonly _initResultHashFunction;
+    protected readonly _lifecycleHooks: IDatabaseLifecycleHooks<TInitResults> | undefined;
+    /**
+     * Whether setupDevStore was invoked during start() (for teardown on stop).
+     */
+    protected _devStoreProvisioned: boolean;
     /**
      * Get the application environment
      */
@@ -56,13 +64,9 @@ export declare class BaseApplication<TID extends PlatformID, TModelDocs extends
      */
     static get distDir(): string;
     /**
-     * Mongoose database instance
-     */
-    protected _db?: typeof mongoose;
-    /**
-     * Schema map for all models
+     * Schema map for all models, delegated to the document store.
+     * Only available when a legacy IDocumentStore is used.
      */
-    protected _schemaMap: SchemaMap<TID, TModelDocs> | undefined;
     get schemaMap(): SchemaMap<TID, TModelDocs>;
     /**
      * Flag indicating whether the application is ready to handle requests
@@ -77,51 +81,50 @@ export declare class BaseApplication<TID extends PlatformID, TModelDocs extends
      */
     readonly plugins: PluginManager<TID>;
     /**
-     * Get the connected MongoDB database instance
+     * Get the connected MongoDB database instance.
+     * @deprecated Use database (IDatabase) or documentStore instead for storage-agnostic access.
      */
     get db(): typeof mongoose;
     /**
-     * Get whether the application is ready to handle requests
-     */
-    get ready(): boolean;
-    constructor(environment: Environment<TID>, schemaMapFactory: (connection: mongoose.Connection) => SchemaMap<TID, TModelDocs>, databaseInitFunction: (application: BaseApplication<TID, TModelDocs, TInitResults>) => Promise<IFailableResult<TInitResults>>, initResultHashFunction: (initResults: TInitResults) => string, constants?: TConstants);
-    /**
-     * Validate MongoDB URI to prevent SSRF attacks
+     * Get the IDatabase instance, if one was provided.
      */
-    private validateMongoUri;
+    get database(): IDatabase | undefined;
     /**
-     * Connect to MongoDB and initialize schemas
+     * Get the injected document store.
+     * @deprecated Prefer database (IDatabase) for new code.
      */
-    protected connectDatabase(mongoUri: string, debug?: boolean): Promise<void>;
+    get documentStore(): IDocumentStore<TID, TModelDocs> | undefined;
     /**
-     * Disconnect from database
+     * Get the in-memory MongoDB instance (if any), delegated to the document store.
+     * Only available when a legacy IDocumentStore is used.
      */
-    protected disconnectDatabase(debug?: boolean): Promise<void>;
-    /**
-     * Set up an in-memory MongoDB instance for development
-     * @returns The MongoDB connection URI
-     */
-    protected setupDevDatabase(): Promise<string>;
-    /**
-     * Initialize the development database with default data
-     */
-    protected initializeDevDatabase(): Promise<TInitResults>;
+    get devDatabase(): MongoMemoryReplSet | undefined;
     /**
-     * Get the in-memory MongoDB instance (if any)
+     * Get whether the application is ready to handle requests
      */
-    get devDatabase(): MongoMemoryReplSet | undefined;
+    get ready(): boolean;
+    constructor(environment: Environment<TID>, databaseOrStore: IDatabase | IDocumentStore<TID, TModelDocs>, constants?: TConstants, lifecycleHooks?: IDatabaseLifecycleHooks<TInitResults>);
     /**
-     * Start the application and connect to the database
+     * Start the application and connect to the database.
+     * Delegates connection to IDatabase or legacy IDocumentStore.
      */
     start(mongoUri?: string, delayReady?: boolean): Promise<void>;
     /**
-     * Stop the application
+     * Stop the application.
+     * Delegates disconnection to IDatabase or legacy IDocumentStore.
      */
     stop(): Promise<void>;
     /**
-     * Get a Mongoose model by name
+     * Get a collection by name via the IDatabase interface.
+     * @param name Name of the collection
+     * @returns ICollection<T> for the named collection
+     * @throws if no IDatabase was provided
+     */
+    getCollection<T extends BsonDocument>(name: string): ICollection<T>;
+    /**
+     * Get a model by name, delegated to the legacy document store.
+     * @deprecated Use getCollection<T>(name) with IDatabase instead.
      * @param modelName Name of the model
-     * @returns
      */
     getModel<T extends IBaseDocument<any, TID>>(modelName: string): Model<T>;
 }

package/src/application-base.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"application-base.d.ts","sourceRoot":"","sources":["../../../../packages/digitaldefiance-node-express-suite/src/application-base.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAGH,OAAO,QAAQ,EAAE,EAAE,KAAK,EAAE,MAAM,iCAAiC,CAAC;AAQlE,OAAO,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAE3D,OAAO,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAC/C,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACjD,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AACxD,OAAO,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AACpD,OAAO,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AAG/D,OAAO,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAC1C,OAAO,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAEpC,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iCAAiC,CAAC;AAElE;;GAEG;AACH,qBAAa,eAAe,CAC1B,GAAG,SAAS,UAAU,EACtB,UAAU,SAAS,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,EAC1D,YAAY,EACZ,UAAU,SAAS,UAAU,GAAG,UAAU,CAC1C,YAAW,YAAY,CAAC,GAAG,CAAC;IAC5B;;OAEG;IACH,OAAO,CAAC,YAAY,CAAmB;IACvC;;OAEG;IACH,OAAO,CAAC,YAAY,CAAC,CAAqB;IAC1C;;OAEG;IACH,OAAO,CAAC,UAAU,CAAa;IAC/B;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAEF;IAChC;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,qBAAqB,CAEM;IAC5C;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,uBAAuB,CAE5B;IAEZ;;OAEG;IACH,IAAW,WAAW,IAAI,WAAW,CAAC,GAAG,CAAC,CAEzC;IAED,IAAW,SAAS,IAAI,UAAU,CAEjC;IAED;;OAEG;IACI,iBAAiB,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,QAAQ,UAAO,GAAG,IAAI;IAI9D;;OAEG;IACH,WAAkB,OAAO,IAAI,MAAM,CAIlC;IAED;;OAEG;IACH,SAAS,CAAC,GAAG,CAAC,EAAE,OAAO,QAAQ,CAAC;IAEhC;;OAEG;IACH,SAAS,CAAC,UAAU,EAAE,SAAS,CAAC,GAAG,EAAE,UAAU,CAAC,GAAG,SAAS,CAAC;IAC7D,IAAW,SAAS,IAAI,SAAS,CAAC,GAAG,EAAE,UAAU,CAAC,CAOjD;IAED;;OAEG;IACH,SAAS,CAAC,MAAM,EAAE,OAAO,CAAC;IAE1B;;OAEG;IACH,SAAgB,QAAQ,EAAE,gBAAgB,CAAC;IAE3C;;OAEG;IACH,SAAgB,OAAO,EAAE,aAAa,CAAC,GAAG,CAAC,CAAC;IAE5C;;OAEG;IACH,IAAW,EAAE,IAAI,OAAO,QAAQ,CAO/B;IAED;;OAEG;IACH,IAAW,KAAK,IAAI,OAAO,CAE1B;gBAGC,WAAW,EAAE,WAAW,CAAC,GAAG,CAAC,EAC7B,gBAAgB,EAAE,CAChB,UAAU,EAAE,QAAQ,CAAC,UAAU,KAC5B,SAAS,CAAC,GAAG,EAAE,UAAU,CAAC,EAC/B,oBAAoB,EAAE,CACpB,WAAW,EAAE,eAAe,CAAC,GAAG,EAAE,UAAU,EAAE,YAAY,CAAC,KACxD,OAAO,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC,EAC3C,sBAAsB,EAAE,CAAC,WAAW,EAAE,YAAY,KAAK,MAAM,EAC7D,SAAS,GAAE,UAAoC;IAYjD;;OAEG;IACH,OAAO,CAAC,gBAAgB;IAqCxB;;OAEG;cACa,eAAe,CAC7B,QAAQ,EAAE,MAAM,EAChB,KAAK,UAAQ,GACZ,OAAO,CAAC,IAAI,CAAC;IAyIhB;;OAEG;cACa,kBAAkB,CAAC,KAAK,UAAQ,GAAG,OAAO,CAAC,IAAI,CAAC;IAehE;;;OAGG;cACa,gBAAgB,IAAI,OAAO,CAAC,MAAM,CAAC;IAiBnD;;OAEG;cACa,qBAAqB,IAAI,OAAO,CAAC,YAAY,CAAC;IA2D9D;;OAEG;IACH,IAAW,WAAW,IAAI,kBAAkB,GAAG,SAAS,CAEvD;IAED;;OAEG;IACU,KAAK,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAuC1E;;OAEG;IACU,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAUlC;;;;OAIG;IACI,QAAQ,CAAC,CAAC,SAAS,aAAa,CAAC,GAAG,EAAE,GAAG,CAAC,EAC/C,SAAS,EAAE,MAAM,GAChB,KAAK,CAAC,CAAC,CAAC;CAOZ"}
+{"version":3,"file":"application-base.d.ts","sourceRoot":"","sources":["../../../../packages/digitaldefiance-node-express-suite/src/application-base.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAGH,OAAO,KAAK,EACV,YAAY,EACZ,WAAW,EACX,SAAS,EACT,uBAAuB,EACxB,MAAM,8BAA8B,CAAC;AACtC,OAAO,EAAE,KAAK,EAAE,MAAM,iCAAiC,CAAC;AACxD,OAAO,QAAQ,MAAM,iCAAiC,CAAC;AAOvD,OAAO,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAE3D,OAAO,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAC/C,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACjD,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AACxD,OAAO,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AACpD,OAAO,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAC;AAC7D,OAAO,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAE1C,OAAO,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAGpC,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iCAAiC,CAAC;AAiBlE;;;;;GAKG;AACH,qBAAa,eAAe,CAC1B,GAAG,SAAS,UAAU,EACtB,UAAU,SAAS,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,EAC1D,YAAY,EACZ,UAAU,SAAS,UAAU,GAAG,UAAU,CAC1C,YAAW,YAAY,CAAC,GAAG,CAAC;IAC5B;;OAEG;IACH,OAAO,CAAC,YAAY,CAAmB;IAEvC;;OAEG;IACH,OAAO,CAAC,UAAU,CAAa;IAE/B;;;OAGG;IACH,SAAS,CAAC,QAAQ,CAAC,SAAS,EAAE,SAAS,GAAG,SAAS,CAAC;IAEpD;;;;OAIG;IACH,SAAS,CAAC,QAAQ,CAAC,cAAc,EAC7B,cAAc,CAAC,GAAG,EAAE,UAAU,CAAC,GAC/B,SAAS,CAAC;IAEd;;OAEG;IACH,SAAS,CAAC,QAAQ,CAAC,eAAe,EAC9B,uBAAuB,CAAC,YAAY,CAAC,GACrC,SAAS,CAAC;IAEd;;OAEG;IACH,SAAS,CAAC,oBAAoB,UAAS;IAEvC;;OAEG;IACH,IAAW,WAAW,IAAI,WAAW,CAAC,GAAG,CAAC,CAEzC;IAED,IAAW,SAAS,IAAI,UAAU,CAEjC;IAED;;OAEG;IACI,iBAAiB,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,QAAQ,UAAO,GAAG,IAAI;IAI9D;;OAEG;IACH,WAAkB,OAAO,IAAI,MAAM,CAIlC;IAED;;;OAGG;IACH,IAAW,SAAS,IAAI,SAAS,CAAC,GAAG,EAAE,UAAU,CAAC,CAajD;IAED;;OAEG;IACH,SAAS,CAAC,MAAM,EAAE,OAAO,CAAC;IAE1B;;OAEG;IACH,SAAgB,QAAQ,EAAE,gBAAgB,CAAC;IAE3C;;OAEG;IACH,SAAgB,OAAO,EAAE,aAAa,CAAC,GAAG,CAAC,CAAC;IAE5C;;;OAGG;IACH,IAAW,EAAE,IAAI,OAAO,QAAQ,CAO/B;IAED;;OAEG;IACH,IAAW,QAAQ,IAAI,SAAS,GAAG,SAAS,CAE3C;IAED;;;OAGG;IACH,IAAW,aAAa,IAAI,cAAc,CAAC,GAAG,EAAE,UAAU,CAAC,GAAG,SAAS,CAEtE;IAED;;;OAGG;IACH,IAAW,WAAW,IAAI,kBAAkB,GAAG,SAAS,CAEvD;IAED;;OAEG;IACH,IAAW,KAAK,IAAI,OAAO,CAE1B;gBAGC,WAAW,EAAE,WAAW,CAAC,GAAG,CAAC,EAC7B,eAAe,EAAE,SAAS,GAAG,cAAc,CAAC,GAAG,EAAE,UAAU,CAAC,EAC5D,SAAS,GAAE,UAAoC,EAC/C,cAAc,CAAC,EAAE,uBAAuB,CAAC,YAAY,CAAC;IAsBxD;;;OAGG;IACU,KAAK,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAuH1E;;;OAGG;IACU,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IA+BlC;;;;;OAKG;IACI,aAAa,CAAC,CAAC,SAAS,YAAY,EAAE,IAAI,EAAE,MAAM,GAAG,WAAW,CAAC,CAAC,CAAC;IAS1E;;;;OAIG;IAEI,QAAQ,CAAC,CAAC,SAAS,aAAa,CAAC,GAAG,EAAE,GAAG,CAAC,EAC/C,SAAS,EAAE,MAAM,GAChB,KAAK,CAAC,CAAC,CAAC;CAQZ"}