@brightchain/brightchain-api-lib 0.14.0 → 0.16.0

package/package.json

@@ -1,15 +1,15 @@
 {
   "name": "@brightchain/brightchain-api-lib",
-  "version": "0.14.0",
+  "version": "0.16.0",
   "main": "./src/index.js",
   "types": "./src/index.d.ts",
   "dependencies": {
     "@aws-sdk/client-ses": "^3.859.0",
-    "@brightchain/brightchain-lib": "0.14.0",
-    "@digitaldefiance/branded-enum": "^0.0.6",
+    "@brightchain/brightchain-lib": "0.16.0",
+    "@digitaldefiance/branded-enum": "^0.0.7",
     "@digitaldefiance/enclave-bridge-client": "^1.1.0",
-    "@digitaldefiance/i18n-lib": "^4.3.2",
-    "@digitaldefiance/node-ecies-lib": "^4.17.2",
+    "@digitaldefiance/i18n-lib": "^4.6.2",
+    "@digitaldefiance/node-ecies-lib": "^4.19.3",
     "@ethereumjs/wallet": "^10.0.0",
     "bip39": "^3.1.0",
     "buffer": "^6.0.3",

package/src/browser.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Browser-safe exports from brightchain-api-lib
+ *
+ * This file exports only the types and constants that are safe to use
+ * in browser environments, excluding Node.js-specific implementations.
+ */
+export * from './lib/constants';
+export * from './lib/enumerations';
+export * from './lib/errors';
+export type { IApiConstants } from './lib/interfaces/api-constants';
+export type { ClientSession, DefaultBackendIdType, SchemaMap } from './lib/shared-types';
+export * from './lib/browserKeyring';
+//# sourceMappingURL=browser.d.ts.map

package/src/browser.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"browser.d.ts","sourceRoot":"","sources":["../../../brightchain-api-lib/src/browser.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAGH,cAAc,iBAAiB,CAAC;AAChC,cAAc,oBAAoB,CAAC;AACnC,cAAc,cAAc,CAAC;AAG7B,YAAY,EAAE,aAAa,EAAE,MAAM,gCAAgC,CAAC;AACpE,YAAY,EAAE,aAAa,EAAE,oBAAoB,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAGzF,cAAc,sBAAsB,CAAC"}

package/src/browser.js

@@ -0,0 +1,16 @@
+"use strict";
+/**
+ * Browser-safe exports from brightchain-api-lib
+ *
+ * This file exports only the types and constants that are safe to use
+ * in browser environments, excluding Node.js-specific implementations.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+// Export only constants and types, no Node.js implementations
+tslib_1.__exportStar(require("./lib/constants"), exports);
+tslib_1.__exportStar(require("./lib/enumerations"), exports);
+tslib_1.__exportStar(require("./lib/errors"), exports);
+// Export browser-safe keyring
+tslib_1.__exportStar(require("./lib/browserKeyring"), exports);
+//# sourceMappingURL=browser.js.map

package/src/browser.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"browser.js","sourceRoot":"","sources":["../../../brightchain-api-lib/src/browser.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEH,8DAA8D;AAC9D,0DAAgC;AAChC,6DAAmC;AACnC,uDAA6B;AAM7B,8BAA8B;AAC9B,+DAAqC"}

package/src/index.d.ts

@@ -3,7 +3,7 @@ export * from './lib/transforms';
 export * from './lib/services';
 export * from './lib/appConstants';
 export * from './lib/application';
-export * from './lib/application-base';
+export * from './lib/upstream-stubs';
 export * from './lib/constants';
 export * from './lib/controllers';
 export * from './lib/enumerations';
@@ -14,9 +14,12 @@ export * from './lib/datastore';
 export * from './lib/middlewares';
 export * from './lib/routers';
 export * from './lib/availability';
+export * from './lib/blockFetch';
 export * from './lib/utils/errorResponse';
 export * from './lib/utils/type-converters';
 export type { ClientSession, DefaultBackendIdType, SchemaMap, } from './lib/shared-types';
+export * from './lib/auth';
+export * from './lib/encryption';
 export * from './lib/browserKeyring';
 export * from './lib/nodeKeyring';
 export * from './lib/secureEnclaveKeyring';

package/src/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../brightchain-api-lib/src/index.ts"],"names":[],"mappings":"AACA,cAAc,cAAc,CAAC;AAC7B,cAAc,kBAAkB,CAAC;AAGjC,cAAc,gBAAgB,CAAC;AAG/B,cAAc,oBAAoB,CAAC;AACnC,cAAc,mBAAmB,CAAC;AAClC,cAAc,wBAAwB,CAAC;AACvC,cAAc,iBAAiB,CAAC;AAChC,cAAc,mBAAmB,CAAC;AAElC,cAAc,oBAAoB,CAAC;AACnC,cAAc,mBAAmB,CAAC;AAClC,cAAc,cAAc,CAAC;AAC7B,cAAc,kBAAkB,CAAC;AAKjC,cAAc,iBAAiB,CAAC;AAChC,cAAc,mBAAmB,CAAC;AAClC,cAAc,eAAe,CAAC;AAG9B,cAAc,oBAAoB,CAAC;AACnC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,6BAA6B,CAAC;AAE5C,YAAY,EACV,aAAa,EACb,oBAAoB,EACpB,SAAS,GACV,MAAM,oBAAoB,CAAC;AAG5B,cAAc,sBAAsB,CAAC;AACrC,cAAc,mBAAmB,CAAC;AAClC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,qBAAqB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../brightchain-api-lib/src/index.ts"],"names":[],"mappings":"AACA,cAAc,cAAc,CAAC;AAC7B,cAAc,kBAAkB,CAAC;AAGjC,cAAc,gBAAgB,CAAC;AAG/B,cAAc,oBAAoB,CAAC;AACnC,cAAc,mBAAmB,CAAC;AAClC,cAAc,sBAAsB,CAAC;AACrC,cAAc,iBAAiB,CAAC;AAChC,cAAc,mBAAmB,CAAC;AAElC,cAAc,oBAAoB,CAAC;AACnC,cAAc,mBAAmB,CAAC;AAClC,cAAc,cAAc,CAAC;AAC7B,cAAc,kBAAkB,CAAC;AAKjC,cAAc,iBAAiB,CAAC;AAChC,cAAc,mBAAmB,CAAC;AAClC,cAAc,eAAe,CAAC;AAG9B,cAAc,oBAAoB,CAAC;AACnC,cAAc,kBAAkB,CAAC;AACjC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,6BAA6B,CAAC;AAE5C,YAAY,EACV,aAAa,EACb,oBAAoB,EACpB,SAAS,GACV,MAAM,oBAAoB,CAAC;AAG5B,cAAc,YAAY,CAAC;AAG3B,cAAc,kBAAkB,CAAC;AAGjC,cAAc,sBAAsB,CAAC;AACrC,cAAc,mBAAmB,CAAC;AAClC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,qBAAqB,CAAC"}

package/src/index.js

@@ -9,7 +9,7 @@ tslib_1.__exportStar(require("./lib/services"), exports);
 // API lib exports
 tslib_1.__exportStar(require("./lib/appConstants"), exports);
 tslib_1.__exportStar(require("./lib/application"), exports);
-tslib_1.__exportStar(require("./lib/application-base"), exports);
+tslib_1.__exportStar(require("./lib/upstream-stubs"), exports);
 tslib_1.__exportStar(require("./lib/constants"), exports);
 tslib_1.__exportStar(require("./lib/controllers"), exports);
 // Note: UserController is exported from controllers/api, not controllers/user (which is the legacy location)
@@ -26,8 +26,13 @@ tslib_1.__exportStar(require("./lib/routers"), exports);
 // Note: FEC types (ParityData, FecRecoveryResult, IFecService) are re-exported from brightchain-lib
 // Only export the WASM implementation class with a unique name to avoid conflicts
 tslib_1.__exportStar(require("./lib/availability"), exports);
+tslib_1.__exportStar(require("./lib/blockFetch"), exports);
 tslib_1.__exportStar(require("./lib/utils/errorResponse"), exports);
 tslib_1.__exportStar(require("./lib/utils/type-converters"), exports);
+// Auth exports
+tslib_1.__exportStar(require("./lib/auth"), exports);
+// Encryption exports
+tslib_1.__exportStar(require("./lib/encryption"), exports);
 // Keyring exports
 tslib_1.__exportStar(require("./lib/browserKeyring"), exports);
 tslib_1.__exportStar(require("./lib/nodeKeyring"), exports);

package/src/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../brightchain-api-lib/src/index.ts"],"names":[],"mappings":";;;AAAA,qCAAqC;AACrC,uDAA6B;AAC7B,2DAAiC;AAEjC,mCAAmC;AACnC,yDAA+B;AAE/B,kBAAkB;AAClB,6DAAmC;AACnC,4DAAkC;AAClC,iEAAuC;AACvC,0DAAgC;AAChC,4DAAkC;AAClC,6GAA6G;AAC7G,6DAAmC;AACnC,4DAAkC;AAClC,uDAA6B;AAC7B,2DAAiC;AACjC,iGAAiG;AACjG,+EAA+E;AAC/E,gFAAgF;AAEhF,0DAAgC;AAChC,4DAAkC;AAClC,wDAA8B;AAC9B,oGAAoG;AACpG,kFAAkF;AAClF,6DAAmC;AACnC,oEAA0C;AAC1C,sEAA4C;AAQ5C,kBAAkB;AAClB,+DAAqC;AACrC,4DAAkC;AAClC,qEAA2C;AAC3C,8DAAoC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../brightchain-api-lib/src/index.ts"],"names":[],"mappings":";;;AAAA,qCAAqC;AACrC,uDAA6B;AAC7B,2DAAiC;AAEjC,mCAAmC;AACnC,yDAA+B;AAE/B,kBAAkB;AAClB,6DAAmC;AACnC,4DAAkC;AAClC,+DAAqC;AACrC,0DAAgC;AAChC,4DAAkC;AAClC,6GAA6G;AAC7G,6DAAmC;AACnC,4DAAkC;AAClC,uDAA6B;AAC7B,2DAAiC;AACjC,iGAAiG;AACjG,+EAA+E;AAC/E,gFAAgF;AAEhF,0DAAgC;AAChC,4DAAkC;AAClC,wDAA8B;AAC9B,oGAAoG;AACpG,kFAAkF;AAClF,6DAAmC;AACnC,2DAAiC;AACjC,oEAA0C;AAC1C,sEAA4C;AAQ5C,eAAe;AACf,qDAA2B;AAE3B,qBAAqB;AACrB,2DAAiC;AAEjC,kBAAkB;AAClB,+DAAqC;AACrC,4DAAkC;AAClC,qEAA2C;AAC3C,8DAAoC"}

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

@@ -1,40 +1,11 @@
-import { PlatformID } from '@digitaldefiance/node-ecies-lib';
-import { IApplication, IBaseDocument, IConstants, PluginManager, ServiceContainer } from '@digitaldefiance/node-express-suite';
-import { DocumentStore } from './datastore/document-store';
-import { Environment } from './environment';
-import type { DefaultBackendIdType } from './shared-types';
 /**
- * Base Application class with core functionality
+ * @deprecated This file is no longer used.
+ *
+ * The local BaseApplication class has been removed as part of the upstream
+ * Application refactor. BrightChain's App<TID> now extends the upstream
+ * Application from @digitaldefiance/node-express-suite directly, and
+ * manages DocumentStore/BlockDocumentStore internally.
+ *
+ * See: brightchain-api-lib/src/lib/application.ts
  */
-export declare class BaseApplication<TID extends PlatformID = DefaultBackendIdType> implements IApplication<TID> {
-    private _environment;
-    get environment(): Environment<TID>;
-    get constants(): IConstants;
-    get db(): any;
-    private _services;
-    get services(): ServiceContainer;
-    private _plugins;
-    get plugins(): PluginManager<TID>;
-    getModel<U extends IBaseDocument<any, any>>(modelName: string): U;
-    reloadEnvironment(path?: string, override?: boolean): void;
-    static get distDir(): string;
-    /**
-     * Flag indicating whether the application is ready to handle requests
-     */
-    protected _ready: boolean;
-    /**
-     * Get whether the application is ready to handle requests
-     */
-    get ready(): boolean;
-    constructor(environment: Environment<TID>, documentStore?: DocumentStore);
-    private readonly documentStore;
-    /**
-     * Start the application and connect to the database
-     */
-    start(delayReady?: boolean): Promise<void>;
-    /**
-     * Stop the application
-     */
-    stop(): Promise<void>;
-}
 //# sourceMappingURL=application-base.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"application-base.d.ts","sourceRoot":"","sources":["../../../../brightchain-api-lib/src/lib/application-base.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,UAAU,EAAE,MAAM,iCAAiC,CAAC;AAC7D,OAAO,EACL,YAAY,EACZ,aAAa,EACb,UAAU,EACV,aAAa,EACb,gBAAgB,EACjB,MAAM,qCAAqC,CAAC;AAI7C,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAC3D,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,gBAAgB,CAAC;AAE3D;;GAEG;AACH,qBAAa,eAAe,CAC1B,GAAG,SAAS,UAAU,GAAG,oBAAoB,CAC7C,YAAW,YAAY,CAAC,GAAG,CAAC;IAC5B,OAAO,CAAC,YAAY,CAAmB;IACvC,IAAW,WAAW,IAAI,WAAW,CAAC,GAAG,CAAC,CAEzC;IAED,IAAW,SAAS,IAAI,UAAU,CAEjC;IAED,IAAW,EAAE,IAAI,GAAG,CAEnB;IAED,OAAO,CAAC,SAAS,CAA+B;IAChD,IAAW,QAAQ,IAAI,gBAAgB,CAKtC;IAED,OAAO,CAAC,QAAQ,CAAiC;IACjD,IAAW,OAAO,IAAI,aAAa,CAAC,GAAG,CAAC,CAKvC;IAEM,QAAQ,CAAC,CAAC,SAAS,aAAa,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,SAAS,EAAE,MAAM,GAAG,CAAC;IAMjE,iBAAiB,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,QAAQ,UAAO,GAAG,IAAI;IAI9D,WAAkB,OAAO,IAAI,MAAM,CAIlC;IAED;;OAEG;IACH,SAAS,CAAC,MAAM,EAAE,OAAO,CAAC;IAE1B;;OAEG;IACH,IAAW,KAAK,IAAI,OAAO,CAE1B;gBAEW,WAAW,EAAE,WAAW,CAAC,GAAG,CAAC,EAAE,aAAa,CAAC,EAAE,aAAa;IAQxE,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAgB;IAE9C;;OAEG;IACU,KAAK,CAAC,UAAU,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAevD;;OAEG;IACU,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;CAGnC"}
+{"version":3,"file":"application-base.d.ts","sourceRoot":"","sources":["../../../../brightchain-api-lib/src/lib/application-base.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG"}

package/src/lib/application-base.js

@@ -1,84 +1,12 @@
 "use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.BaseApplication = void 0;
-/* eslint-disable @typescript-eslint/no-explicit-any */
-const brightchain_lib_1 = require("@brightchain/brightchain-lib");
-const node_express_suite_1 = require("@digitaldefiance/node-express-suite");
-const path_1 = require("path");
-const appConstants_1 = require("./appConstants");
-const block_document_store_1 = require("./datastore/block-document-store");
-const environment_1 = require("./environment");
 /**
- * Base Application class with core functionality
+ * @deprecated This file is no longer used.
+ *
+ * The local BaseApplication class has been removed as part of the upstream
+ * Application refactor. BrightChain's App<TID> now extends the upstream
+ * Application from @digitaldefiance/node-express-suite directly, and
+ * manages DocumentStore/BlockDocumentStore internally.
+ *
+ * See: brightchain-api-lib/src/lib/application.ts
  */
-class BaseApplication {
-    get environment() {
-        return this._environment;
-    }
-    get constants() {
-        return appConstants_1.AppConstants;
-    }
-    get db() {
-        return this.documentStore;
-    }
-    get services() {
-        if (!this._services) {
-            this._services = new node_express_suite_1.ServiceContainer();
-        }
-        return this._services;
-    }
-    get plugins() {
-        if (!this._plugins) {
-            this._plugins = new node_express_suite_1.PluginManager();
-        }
-        return this._plugins;
-    }
-    getModel(modelName) {
-        // Get a collection from the in-memory document store
-        const collection = this.documentStore.collection(modelName);
-        return collection;
-    }
-    reloadEnvironment(path, override = true) {
-        this._environment = new environment_1.Environment(path, false, override);
-    }
-    static get distDir() {
-        const cwd = process.cwd();
-        const distPath = (0, path_1.join)(cwd, 'dist');
-        return distPath;
-    }
-    /**
-     * Get whether the application is ready to handle requests
-     */
-    get ready() {
-        return this._ready;
-    }
-    constructor(environment, documentStore) {
-        this._ready = false;
-        this._environment = environment;
-        this.documentStore =
-            documentStore ??
-                new block_document_store_1.BlockDocumentStore(new brightchain_lib_1.MemoryBlockStore(brightchain_lib_1.BlockSize.Small));
-    }
-    /**
-     * Start the application and connect to the database
-     */
-    async start(delayReady) {
-        if (this._ready) {
-            console.error('Failed to start the application:', 'Application is already running');
-            const err = new Error('Application is already running');
-            if (process.env['NODE_ENV'] === 'test') {
-                throw err;
-            }
-            process.exit(1);
-        }
-        this._ready = delayReady ? false : true;
-    }
-    /**
-     * Stop the application
-     */
-    async stop() {
-        this._ready = false;
-    }
-}
-exports.BaseApplication = BaseApplication;
 //# sourceMappingURL=application-base.js.map

package/src/lib/application-base.js.map

@@ -1 +1 @@
-{"version":3,"file":"application-base.js","sourceRoot":"","sources":["../../../../brightchain-api-lib/src/lib/application-base.ts"],"names":[],"mappings":";;;AAAA,uDAAuD;AACvD,kEAA2E;AAE3E,4EAM6C;AAC7C,+BAA4B;AAC5B,iDAA8C;AAC9C,2EAAsE;AAEtE,+CAA4C;AAG5C;;GAEG;AACH,MAAa,eAAe;IAI1B,IAAW,WAAW;QACpB,OAAO,IAAI,CAAC,YAAY,CAAC;IAC3B,CAAC;IAED,IAAW,SAAS;QAClB,OAAO,2BAAY,CAAC;IACtB,CAAC;IAED,IAAW,EAAE;QACX,OAAO,IAAI,CAAC,aAAa,CAAC;IAC5B,CAAC;IAGD,IAAW,QAAQ;QACjB,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC;YACpB,IAAI,CAAC,SAAS,GAAG,IAAI,qCAAgB,EAAE,CAAC;QAC1C,CAAC;QACD,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAGD,IAAW,OAAO;QAChB,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC;YACnB,IAAI,CAAC,QAAQ,GAAG,IAAI,kCAAa,EAAE,CAAC;QACtC,CAAC;QACD,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAEM,QAAQ,CAAoC,SAAiB;QAClE,qDAAqD;QACrD,MAAM,UAAU,GAAG,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;QAC5D,OAAO,UAA0B,CAAC;IACpC,CAAC;IAEM,iBAAiB,CAAC,IAAa,EAAE,QAAQ,GAAG,IAAI;QACrD,IAAI,CAAC,YAAY,GAAG,IAAI,yBAAW,CAAC,IAAI,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC;IAC7D,CAAC;IAEM,MAAM,KAAK,OAAO;QACvB,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC;QAC1B,MAAM,QAAQ,GAAG,IAAA,WAAI,EAAC,GAAG,EAAE,MAAM,CAAC,CAAC;QACnC,OAAO,QAAQ,CAAC;IAClB,CAAC;IAOD;;OAEG;IACH,IAAW,KAAK;QACd,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED,YAAY,WAA6B,EAAE,aAA6B;QACtE,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;QACpB,IAAI,CAAC,YAAY,GAAG,WAAW,CAAC;QAChC,IAAI,CAAC,aAAa;YAChB,aAAa;gBACb,IAAI,yCAAkB,CAAC,IAAI,kCAAgB,CAAC,2BAAS,CAAC,KAAK,CAAC,CAAC,CAAC;IAClE,CAAC;IAID;;OAEG;IACI,KAAK,CAAC,KAAK,CAAC,UAAoB;QACrC,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChB,OAAO,CAAC,KAAK,CACX,kCAAkC,EAClC,gCAAgC,CACjC,CAAC;YACF,MAAM,GAAG,GAAG,IAAI,KAAK,CAAC,gCAAgC,CAAC,CAAC;YACxD,IAAI,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,KAAK,MAAM,EAAE,CAAC;gBACvC,MAAM,GAAG,CAAC;YACZ,CAAC;YACD,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAClB,CAAC;QACD,IAAI,CAAC,MAAM,GAAG,UAAU,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC;IAC1C,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,IAAI;QACf,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;IACtB,CAAC;CACF;AA9FD,0CA8FC"}
+{"version":3,"file":"application-base.js","sourceRoot":"","sources":["../../../../brightchain-api-lib/src/lib/application-base.ts"],"names":[],"mappings":";AAAA;;;;;;;;;GASG"}

package/src/lib/application.d.ts

@@ -1,26 +1,56 @@
 import { IAvailabilityService, IDiscoveryProtocol, IReconciliationService } from '@brightchain/brightchain-lib';
 import { PlatformID } from '@digitaldefiance/node-ecies-lib';
-import { Application } from 'express';
-import { BaseApplication } from './application-base';
+import { IConstants, Application as UpstreamApplication } from '@digitaldefiance/node-express-suite';
+import { DocumentCollection, DocumentRecord, DocumentStore } from './datastore/document-store';
 import { Environment } from './environment';
+import { IBrightChainInitResult } from './interfaces/brightchain-init-result';
 import { ApiRouter } from './routers/api';
+import { AppRouter } from './routers/app';
 import { EventNotificationSystem } from './services/eventNotificationSystem';
 import { MessagePassingService } from './services/messagePassingService';
 import { WebSocketMessageServer } from './services/webSocketMessageServer';
 /**
- * Application class
+ * Application class for BrightChain.
+ *
+ * Extends the upstream Application from @digitaldefiance/node-express-suite,
+ * inheriting HTTP/HTTPS server lifecycle, greenlock/Let's Encrypt support,
+ * middleware initialization, and graceful shutdown.
+ *
+ * BrightChain-specific concerns (services, WebSocket, UPnP, EventNotificationSystem)
+ * are initialized after the upstream start() completes.
+ *
+ * Mongoose-related upstream parameters are satisfied with no-op stubs since
+ * BrightChain uses DocumentStore/BlockDocumentStore instead.
  */
-export declare class App<TID extends PlatformID> extends BaseApplication<TID> {
-    readonly expressApp: Application;
-    private server;
+export declare class App<TID extends PlatformID> extends UpstreamApplication<IBrightChainInitResult<TID>, Record<string, never>, TID, Environment<TID>, IConstants, AppRouter<TID>> {
     private controllers;
     private readonly keyStorage;
+    private readonly _brightchainDocumentStore;
     private apiRouter;
     private eventSystem;
     private wsServer;
     private messagePassingService;
+    private upnpManager;
+    /**
+     * Captured HTTP server reference for WebSocket attachment.
+     * The upstream Application stores the server as a private field,
+     * so we intercept expressApp.listen() to capture it here.
+     */
+    private _httpServer;
     constructor(environment: Environment<TID>);
-    start(): Promise<void>;
+    /**
+     * Get the BrightChain document store.
+     * Overrides the upstream mongoose-based `db` getter since BrightChain
+     * uses its own BlockDocumentStore instead of mongoose.
+     */
+    get db(): DocumentStore;
+    /**
+     * Get a collection from the BrightChain document store by name.
+     * Overrides the upstream mongoose-based `getModel()` to delegate
+     * to the BlockDocumentStore's collection() method.
+     */
+    getModel<U extends DocumentRecord>(modelName: string): DocumentCollection<U>;
+    start(mongoUri?: string): Promise<void>;
     stop(): Promise<void>;
     getController<T = unknown>(name: string): T;
     setController(name: string, controller: unknown): void;

package/src/lib/application.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"application.d.ts","sourceRoot":"","sources":["../../../../brightchain-api-lib/src/lib/application.ts"],"names":[],"mappings":"AAAA,OAAO,EAKL,oBAAoB,EACpB,kBAAkB,EAClB,sBAAsB,EAGvB,MAAM,8BAA8B,CAAC;AAEtC,OAAO,EAAE,UAAU,EAAE,MAAM,iCAAiC,CAAC;AAW7D,OAAgB,EAAE,WAAW,EAAmC,MAAM,SAAS,CAAC;AAKhF,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAErD,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAG5C,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAG1C,OAAO,EAAE,uBAAuB,EAAE,MAAM,oCAAoC,CAAC;AAC7E,OAAO,EAAE,qBAAqB,EAAE,MAAM,kCAAkC,CAAC;AACzE,OAAO,EAAE,sBAAsB,EAAE,MAAM,mCAAmC,CAAC;AAE3E;;GAEG;AACH,qBAAa,GAAG,CAAC,GAAG,SAAS,UAAU,CAAE,SAAQ,eAAe,CAAC,GAAG,CAAC;IACnE,SAAgB,UAAU,EAAE,WAAW,CAAC;IACxC,OAAO,CAAC,MAAM,CAAuB;IACrC,OAAO,CAAC,WAAW,CAAmC;IACtD,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAmB;IAC9C,OAAO,CAAC,SAAS,CAA+B;IAChD,OAAO,CAAC,WAAW,CAAwC;IAC3D,OAAO,CAAC,QAAQ,CAAuC;IACvD,OAAO,CAAC,qBAAqB,CAAsC;gBAEvD,WAAW,EAAE,WAAW,CAAC,GAAG,CAAC;IAcnB,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAuJtB,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IA2CpC,aAAa,CAAC,CAAC,GAAG,OAAO,EAAE,IAAI,EAAE,MAAM,GAAG,CAAC;IAI3C,aAAa,CAAC,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,GAAG,IAAI;IAI7D;;;OAGG;IACI,YAAY,IAAI,SAAS,CAAC,GAAG,CAAC,GAAG,IAAI;IAI5C;;;OAGG;IACI,cAAc,IAAI,uBAAuB,GAAG,IAAI;IAIvD;;;OAGG;IACI,kBAAkB,IAAI,sBAAsB,GAAG,IAAI;IAI1D;;;;;OAKG;IACI,wBAAwB,CAAC,OAAO,EAAE,qBAAqB,GAAG,IAAI;IAQrE;;;;;OAKG;IACI,oBAAoB,CAAC,QAAQ,EAAE,kBAAkB,GAAG,IAAI;IAO/D;;;;;OAKG;IACI,sBAAsB,CAAC,OAAO,EAAE,oBAAoB,GAAG,IAAI;IAQlE;;;;;OAKG;IACI,wBAAwB,CAAC,OAAO,EAAE,sBAAsB,GAAG,IAAI;CAMvE"}
+{"version":3,"file":"application.d.ts","sourceRoot":"","sources":["../../../../brightchain-api-lib/src/lib/application.ts"],"names":[],"mappings":"AAAA,OAAO,EAIL,oBAAoB,EACpB,kBAAkB,EAClB,sBAAsB,EAEvB,MAAM,8BAA8B,CAAC;AACtC,OAAO,EAAE,UAAU,EAAE,MAAM,iCAAiC,CAAC;AAC7D,OAAO,EAGL,UAAU,EAEV,WAAW,IAAI,mBAAmB,EACnC,MAAM,qCAAqC,CAAC;AAI7C,OAAO,EACL,kBAAkB,EAClB,cAAc,EACd,aAAa,EACd,MAAM,4BAA4B,CAAC;AACpC,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAE5C,OAAO,EAAE,sBAAsB,EAAE,MAAM,sCAAsC,CAAC;AAE9E,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAC1C,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAE1C,OAAO,EAAE,uBAAuB,EAAE,MAAM,oCAAoC,CAAC;AAC7E,OAAO,EAAE,qBAAqB,EAAE,MAAM,kCAAkC,CAAC;AACzE,OAAO,EAAE,sBAAsB,EAAE,MAAM,mCAAmC,CAAC;AAO3E;;;;;;;;;;;;GAYG;AACH,qBAAa,GAAG,CAAC,GAAG,SAAS,UAAU,CAAE,SAAQ,mBAAmB,CAClE,sBAAsB,CAAC,GAAG,CAAC,EAC3B,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,EACrB,GAAG,EACH,WAAW,CAAC,GAAG,CAAC,EAChB,UAAU,EACV,SAAS,CAAC,GAAG,CAAC,CACf;IACC,OAAO,CAAC,WAAW,CAAmC;IACtD,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAmB;IAC9C,OAAO,CAAC,QAAQ,CAAC,yBAAyB,CAAgB;IAC1D,OAAO,CAAC,SAAS,CAA+B;IAChD,OAAO,CAAC,WAAW,CAAwC;IAC3D,OAAO,CAAC,QAAQ,CAAuC;IACvD,OAAO,CAAC,qBAAqB,CAAsC;IACnE,OAAO,CAAC,WAAW,CAA4B;IAE/C;;;;OAIG;IACH,OAAO,CAAC,WAAW,CAAuB;gBAE9B,WAAW,EAAE,WAAW,CAAC,GAAG,CAAC;IA2BzC;;;;OAIG;IAEH,IAAoB,EAAE,IAAI,aAAa,CAEtC;IAED;;;;OAIG;IAEa,QAAQ,CAAC,CAAC,SAAS,cAAc,EAC/C,SAAS,EAAE,MAAM,GAChB,kBAAkB,CAAC,CAAC,CAAC;IAIF,KAAK,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IA8FvC,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IA6BpC,aAAa,CAAC,CAAC,GAAG,OAAO,EAAE,IAAI,EAAE,MAAM,GAAG,CAAC;IAI3C,aAAa,CAAC,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,GAAG,IAAI;IAI7D;;;OAGG;IACI,YAAY,IAAI,SAAS,CAAC,GAAG,CAAC,GAAG,IAAI;IAI5C;;;OAGG;IACI,cAAc,IAAI,uBAAuB,GAAG,IAAI;IAIvD;;;OAGG;IACI,kBAAkB,IAAI,sBAAsB,GAAG,IAAI;IAI1D;;;;;OAKG;IACI,wBAAwB,CAAC,OAAO,EAAE,qBAAqB,GAAG,IAAI;IAQrE;;;;;OAKG;IACI,oBAAoB,CAAC,QAAQ,EAAE,kBAAkB,GAAG,IAAI;IAO/D;;;;;OAKG;IACI,sBAAsB,CAAC,OAAO,EAAE,oBAAoB,GAAG,IAAI;IAQlE;;;;;OAKG;IACI,wBAAwB,CAAC,OAAO,EAAE,sBAAsB,GAAG,IAAI;CAMvE"}

package/src/lib/application.js

@@ -1,17 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.App = void 0;
-const tslib_1 = require("tslib");
 const brightchain_lib_1 = require("@brightchain/brightchain-lib");
-const i18n_lib_1 = require("@digitaldefiance/i18n-lib");
 const node_express_suite_1 = require("@digitaldefiance/node-express-suite");
-const suite_core_lib_1 = require("@digitaldefiance/suite-core-lib");
-/* eslint-disable @typescript-eslint/no-explicit-any */
-const express_1 = tslib_1.__importDefault(require("express"));
-const fs_1 = require("fs");
-const https_1 = require("https");
-const path_1 = require("path");
-const application_base_1 = require("./application-base");
+const appConstants_1 = require("./appConstants");
 const block_document_store_factory_1 = require("./datastore/block-document-store-factory");
 const blockStoreFactory_1 = require("./factories/blockStoreFactory");
 const middlewares_1 = require("./middlewares");
@@ -20,114 +12,149 @@ const app_1 = require("./routers/app");
 const services_1 = require("./services");
 const eventNotificationSystem_1 = require("./services/eventNotificationSystem");
 const webSocketMessageServer_1 = require("./services/webSocketMessageServer");
+const upstream_stubs_1 = require("./upstream-stubs");
 /**
- * Application class
+ * Application class for BrightChain.
+ *
+ * Extends the upstream Application from @digitaldefiance/node-express-suite,
+ * inheriting HTTP/HTTPS server lifecycle, greenlock/Let's Encrypt support,
+ * middleware initialization, and graceful shutdown.
+ *
+ * BrightChain-specific concerns (services, WebSocket, UPnP, EventNotificationSystem)
+ * are initialized after the upstream start() completes.
+ *
+ * Mongoose-related upstream parameters are satisfied with no-op stubs since
+ * BrightChain uses DocumentStore/BlockDocumentStore instead.
  */
-class App extends application_base_1.BaseApplication {
+class App extends node_express_suite_1.Application {
     constructor(environment) {
-        super(environment, (0, block_document_store_factory_1.createBlockDocumentStore)({
-            storePath: environment.blockStorePath,
-            blockSize: environment.blockStoreBlockSize,
-            useMemory: environment.useMemoryDocumentStore,
-        }));
-        this.server = null;
+        super(environment, 
+        // apiRouterFactory — creates BrightChain's ApiRouter
+        // @ts-expect-error — App overrides db/getModel with DocumentStore types; runtime-compatible
+        (app) => new api_1.ApiRouter(app), 
+        // schemaMapFactory — no-op, returns empty object (no mongoose models)
+        upstream_stubs_1.noOpSchemaMapFactory, 
+        // databaseInitFunction — no-op, returns { success: true }
+        upstream_stubs_1.noOpDatabaseInitFunction, 
+        // initResultHashFunction — no-op, returns 'no-mongoose'
+        upstream_stubs_1.noOpInitResultHashFunction, 
+        // cspConfig — undefined; BrightChain's Middlewares.init handles CSP
+        undefined, 
+        // constants
+        appConstants_1.AppConstants, 
+        // appRouterFactory — creates BrightChain's AppRouter wrapping the ApiRouter
+        (apiRouter) => new app_1.AppRouter(apiRouter), 
+        // customInitMiddleware — wrap Middlewares.init to match upstream signature
+        (app) => middlewares_1.Middlewares.init(app));
         this.controllers = new Map();
         this.apiRouter = null;
         this.eventSystem = null;
         this.wsServer = null;
         this.messagePassingService = null;
-        this.expressApp = (0, express_1.default)();
-        this.server = null;
+        this.upnpManager = null;
+        /**
+         * Captured HTTP server reference for WebSocket attachment.
+         * The upstream Application stores the server as a private field,
+         * so we intercept expressApp.listen() to capture it here.
+         */
+        this._httpServer = null;
         this.keyStorage = services_1.SecureKeyStorage.getInstance();
+        this._brightchainDocumentStore = (0, block_document_store_factory_1.createBlockDocumentStore)({
+            useMemory: true,
+        });
     }
-    async start() {
-        await super.start(true);
+    /**
+     * Get the BrightChain document store.
+     * Overrides the upstream mongoose-based `db` getter since BrightChain
+     * uses its own BlockDocumentStore instead of mongoose.
+     */
+    // @ts-expect-error — intentional override: BrightChain uses DocumentStore, not mongoose
+    get db() {
+        return this._brightchainDocumentStore;
+    }
+    /**
+     * Get a collection from the BrightChain document store by name.
+     * Overrides the upstream mongoose-based `getModel()` to delegate
+     * to the BlockDocumentStore's collection() method.
+     */
+    // @ts-expect-error — intentional override: returns DocumentCollection, not mongoose Model
+    getModel(modelName) {
+        return this._brightchainDocumentStore.collection(modelName);
+    }
+    async start(mongoUri) {
+        // Intercept expressApp.listen to capture the HTTP server reference.
+        // The upstream Application creates the server internally via expressApp.listen(),
+        // but stores it in a private field we cannot access from a subclass.
+        const originalListen = this.expressApp.listen.bind(this.expressApp);
+        this.expressApp.listen = ((...args) => {
+            const server = originalListen(...args);
+            this._httpServer = server;
+            return server;
+        });
+        // Delegate to upstream — handles: middleware init, router setup, error handler,
+        // HTTP server on :port, greenlock/HTTPS on :443, dev-HTTPS, _ready = true
+        // Pass undefined to skip mongoose connection.
+        await super.start(mongoUri);
+        // Restore original listen to avoid side effects on subsequent calls
+        this.expressApp.listen = originalListen;
+        // ── BrightChain-specific initialization ──────────────────────────
+        await this.keyStorage.initializeFromEnvironment();
+        // Initialize core services
+        const blockStore = blockStoreFactory_1.BlockStoreFactory.createMemoryStore({
+            blockSize: brightchain_lib_1.BlockSize.Small,
+        });
+        const memberStore = new brightchain_lib_1.MemberStore(blockStore);
+        const energyStore = new brightchain_lib_1.EnergyAccountStore();
+        const energyLedger = new brightchain_lib_1.EnergyLedger();
+        // @ts-expect-error — App overrides db/getModel with DocumentStore types; runtime-compatible
+        const emailService = new services_1.EmailService(this);
+        const authService = new services_1.AuthService(
+        // @ts-expect-error — App overrides db/getModel with DocumentStore types; runtime-compatible
+        this, memberStore, energyStore, emailService, this.environment.jwtSecret);
+        // Register services in the upstream ServiceContainer
+        this.services.register('memberStore', () => memberStore);
+        this.services.register('energyStore', () => energyStore);
+        this.services.register('energyLedger', () => energyLedger);
+        this.services.register('emailService', () => emailService);
+        this.services.register('auth', () => authService);
+        // EventNotificationSystem for WebSocket events
+        this.eventSystem = new eventNotificationSystem_1.EventNotificationSystem();
+        this.services.register('eventSystem', () => this.eventSystem);
+        // WebSocket — attach to the captured HTTP server
+        if (this._httpServer) {
+            this.wsServer = new webSocketMessageServer_1.WebSocketMessageServer(this._httpServer, false);
+            this.services.register('wsServer', () => this.wsServer);
+            (0, node_express_suite_1.debugLog)(this.environment.debug, 'log', '[ ready ] WebSocket server initialized');
+        }
+        // Wire EventNotificationSystem to SyncController via the apiRouter
+        if (this.apiRouter) {
+            this.apiRouter.setSyncEventSystem(this.eventSystem);
+        }
+        // UPnP port mapping (non-fatal on failure)
         try {
-            if (this._ready) {
-                console.error('Failed to start the application:', 'Application is already running');
-                process.exit(1);
+            if (this.environment.upnp?.enabled) {
+                this.upnpManager = new node_express_suite_1.UpnpManager(this.environment.upnp);
+                await this.upnpManager.initialize();
+                this.services.register('upnpManager', () => this.upnpManager);
+                (0, node_express_suite_1.debugLog)(this.environment.debug, 'log', '[ ready ] UPnP port mapping initialized');
             }
-            await this.keyStorage.initializeFromEnvironment();
-            // Initialize services
-            const blockStore = blockStoreFactory_1.BlockStoreFactory.createMemoryStore({
-                blockSize: brightchain_lib_1.BlockSize.Small,
-            });
-            const memberStore = new brightchain_lib_1.MemberStore(blockStore);
-            const energyStore = new brightchain_lib_1.EnergyAccountStore();
-            const energyLedger = new brightchain_lib_1.EnergyLedger();
-            const emailService = new services_1.EmailService(this);
-            const authService = new services_1.AuthService(this, memberStore, energyStore, emailService, this.environment.jwtSecret);
-            // Register services
-            this.services.register('memberStore', () => memberStore);
-            this.services.register('energyStore', () => energyStore);
-            this.services.register('energyLedger', () => energyLedger);
-            this.services.register('emailService', () => emailService);
-            this.services.register('auth', () => authService);
-            // Initialize EventNotificationSystem for WebSocket events
-            // @requirements 5.1, 5.2, 5.4
-            this.eventSystem = new eventNotificationSystem_1.EventNotificationSystem();
-            this.services.register('eventSystem', () => this.eventSystem);
-            middlewares_1.Middlewares.init(this.expressApp);
-            const apiRouter = new api_1.ApiRouter(this);
-            this.apiRouter = apiRouter;
-            const appRouter = new app_1.AppRouter(apiRouter);
-            // Wire EventNotificationSystem to SyncController for replication events
-            // @requirements 4.5
-            apiRouter.setSyncEventSystem(this.eventSystem);
-            appRouter.init(this.expressApp);
-            this.expressApp.use((err, req, res, next) => {
-                const handleableError = err instanceof i18n_lib_1.HandleableError
-                    ? err
-                    : new i18n_lib_1.HandleableError(new Error(err.message ||
-                        (0, brightchain_lib_1.translate)(brightchain_lib_1.BrightChainStrings.Error_Unexpected_Error)), { cause: err });
-                (0, node_express_suite_1.handleError)(handleableError, res, node_express_suite_1.sendApiMessageResponse, next);
-            });
-            const serversReady = [];
-            serversReady.push(new Promise((resolve) => {
-                this.server = this.expressApp.listen(this.environment.port, this.environment.host, () => {
-                    (0, node_express_suite_1.debugLog)(this.environment.debug, 'log', `[ ready ] http://${this.environment.host}:${this.environment.port}`);
-                    // Initialize WebSocket server after HTTP server is ready
-                    // @requirements 5.1
-                    if (this.server) {
-                        this.wsServer = new webSocketMessageServer_1.WebSocketMessageServer(this.server, false);
-                        this.services.register('wsServer', () => this.wsServer);
-                        (0, node_express_suite_1.debugLog)(this.environment.debug, 'log', '[ ready ] WebSocket server initialized');
-                    }
-                    resolve();
-                });
-            }));
-            if (this.environment.httpsDevCertRoot) {
-                try {
-                    const certPath = (0, path_1.resolve)(this.environment.httpsDevCertRoot + '.pem');
-                    const keyPath = (0, path_1.resolve)(this.environment.httpsDevCertRoot + '-key.pem');
-                    const options = {
-                        key: (0, fs_1.readFileSync)(keyPath),
-                        cert: (0, fs_1.readFileSync)(certPath),
-                    };
-                    serversReady.push(new Promise((resolve) => {
-                        (0, https_1.createServer)(options, this.expressApp).listen(this.environment.httpsDevPort, () => {
-                            console.log(`[ ${(0, suite_core_lib_1.getSuiteCoreTranslation)(suite_core_lib_1.SuiteCoreStringKey.Common_Ready)} ] https://${this.environment.host}:${this.environment.httpsDevPort}`);
-                            resolve();
-                        });
-                    }));
-                }
-                catch (err) {
-                    console.error('Failed to start HTTPS server:', err);
-                }
+            else {
+                (0, node_express_suite_1.debugLog)(this.environment.debug, 'log', '[ info ] UPnP port mapping disabled');
             }
-            await Promise.all(serversReady);
-            this._ready = true;
         }
-        catch (err) {
-            console.error('Failed to start the application:', err);
-            if (process.env['NODE_ENV'] === 'test') {
-                throw err;
-            }
-            process.exit(1);
+        catch (upnpErr) {
+            console.warn('[ warning ] UPnP initialization failed, continuing without port mapping:', upnpErr);
         }
     }
     async stop() {
-        // Close WebSocket server first
+        // BrightChain-specific cleanup first, then delegate to upstream
+        // Shutdown UPnP port mappings
+        if (this.upnpManager) {
+            (0, node_express_suite_1.debugLog)(this.environment.debug, 'log', '[ stopping ] UPnP port mapping');
+            await this.upnpManager.shutdown();
+            this.upnpManager = null;
+        }
+        // Close WebSocket server
         if (this.wsServer) {
             (0, node_express_suite_1.debugLog)(this.environment.debug, 'log', '[ stopping ] WebSocket server');
             await new Promise((resolve) => {
@@ -135,28 +162,13 @@ class App extends application_base_1.BaseApplication {
             });
             this.wsServer = null;
         }
-        if (this.server) {
-            (0, node_express_suite_1.debugLog)(this.environment.debug, 'log', '[ stopping ] Application server');
-            await new Promise((resolve, reject) => {
-                this.server.closeAllConnections?.();
-                this.server.close((err) => {
-                    if (err) {
-                        reject(err);
-                    }
-                    else {
-                        resolve();
-                    }
-                });
-            });
-            this.server = null;
-        }
-        // Clean up other services
+        // Clean up BrightChain services
         this.eventSystem = null;
         this.messagePassingService = null;
         this.apiRouter = null;
+        this._httpServer = null;
+        // Upstream handles: greenlockManager.stop(), server.close(), db disconnect, _ready = false
         await super.stop();
-        this._ready = false;
-        (0, node_express_suite_1.debugLog)(this.environment.debug, 'log', '[ stopped ] Application server and database connections');
     }
     getController(name) {
         return this.controllers.get(name);