@brightchain/brightchain-api-lib 0.17.2 → 0.18.0

package/src/lib/interfaces/storage/index.js

@@ -1,7 +1,19 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.MEMBER_INDEX_SCHEMA = void 0;
-// Member index schema (runtime value — uses brandedField)
+exports.USER_SCHEMA = exports.USERS_COLLECTION = exports.USER_ROLE_SCHEMA = exports.USER_ROLES_COLLECTION = exports.ROLE_SCHEMA = exports.ROLES_COLLECTION = exports.MNEMONIC_SCHEMA = exports.MNEMONICS_COLLECTION = exports.MEMBER_INDEX_SCHEMA = void 0;
+// Collection schemas (runtime values)
 var memberIndexSchema_1 = require("./memberIndexSchema");
 Object.defineProperty(exports, "MEMBER_INDEX_SCHEMA", { enumerable: true, get: function () { return memberIndexSchema_1.MEMBER_INDEX_SCHEMA; } });
+var mnemonicSchema_1 = require("./mnemonicSchema");
+Object.defineProperty(exports, "MNEMONICS_COLLECTION", { enumerable: true, get: function () { return mnemonicSchema_1.MNEMONICS_COLLECTION; } });
+Object.defineProperty(exports, "MNEMONIC_SCHEMA", { enumerable: true, get: function () { return mnemonicSchema_1.MNEMONIC_SCHEMA; } });
+var roleSchema_1 = require("./roleSchema");
+Object.defineProperty(exports, "ROLES_COLLECTION", { enumerable: true, get: function () { return roleSchema_1.ROLES_COLLECTION; } });
+Object.defineProperty(exports, "ROLE_SCHEMA", { enumerable: true, get: function () { return roleSchema_1.ROLE_SCHEMA; } });
+var userRoleSchema_1 = require("./userRoleSchema");
+Object.defineProperty(exports, "USER_ROLES_COLLECTION", { enumerable: true, get: function () { return userRoleSchema_1.USER_ROLES_COLLECTION; } });
+Object.defineProperty(exports, "USER_ROLE_SCHEMA", { enumerable: true, get: function () { return userRoleSchema_1.USER_ROLE_SCHEMA; } });
+var userSchema_1 = require("./userSchema");
+Object.defineProperty(exports, "USERS_COLLECTION", { enumerable: true, get: function () { return userSchema_1.USERS_COLLECTION; } });
+Object.defineProperty(exports, "USER_SCHEMA", { enumerable: true, get: function () { return userSchema_1.USER_SCHEMA; } });
 //# sourceMappingURL=index.js.map

package/src/lib/interfaces/storage/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../brightchain-api-lib/src/lib/interfaces/storage/index.ts"],"names":[],"mappings":";;;AAMA,0DAA0D;AAC1D,yDAA0D;AAAjD,wHAAA,mBAAmB,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../brightchain-api-lib/src/lib/interfaces/storage/index.ts"],"names":[],"mappings":";;;AAMA,sCAAsC;AACtC,yDAA0D;AAAjD,wHAAA,mBAAmB,OAAA;AAC5B,mDAAyE;AAAhE,sHAAA,oBAAoB,OAAA;AAAE,iHAAA,eAAe,OAAA;AAC9C,2CAA6D;AAApD,8GAAA,gBAAgB,OAAA;AAAE,yGAAA,WAAW,OAAA;AACtC,mDAA2E;AAAlE,uHAAA,qBAAqB,OAAA;AAAE,kHAAA,gBAAgB,OAAA;AAChD,2CAA6D;AAApD,8GAAA,gBAAgB,OAAA;AAAE,yGAAA,WAAW,OAAA"}

package/src/lib/interfaces/storage/mnemonicSchema.d.ts

@@ -0,0 +1,10 @@
+import type { CollectionSchema } from './document-types';
+/** Well-known collection name for mnemonic hash documents. */
+export declare const MNEMONICS_COLLECTION = "mnemonics";
+/**
+ * Schema for the mnemonics collection.
+ * Mirrors the Mongoose mnemonic document structure:
+ *   hmac (non-reversible HMAC of the mnemonic for uniqueness checks)
+ */
+export declare const MNEMONIC_SCHEMA: CollectionSchema;
+//# sourceMappingURL=mnemonicSchema.d.ts.map

package/src/lib/interfaces/storage/mnemonicSchema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mnemonicSchema.d.ts","sourceRoot":"","sources":["../../../../../../brightchain-api-lib/src/lib/interfaces/storage/mnemonicSchema.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AAEzD,8DAA8D;AAC9D,eAAO,MAAM,oBAAoB,cAAc,CAAC;AAEhD;;;;GAIG;AACH,eAAO,MAAM,eAAe,EAAE,gBAU7B,CAAC"}

package/src/lib/interfaces/storage/mnemonicSchema.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MNEMONIC_SCHEMA = exports.MNEMONICS_COLLECTION = void 0;
+/** Well-known collection name for mnemonic hash documents. */
+exports.MNEMONICS_COLLECTION = 'mnemonics';
+/**
+ * Schema for the mnemonics collection.
+ * Mirrors the Mongoose mnemonic document structure:
+ *   hmac (non-reversible HMAC of the mnemonic for uniqueness checks)
+ */
+exports.MNEMONIC_SCHEMA = {
+    name: 'mnemonic',
+    properties: {
+        _id: { type: 'string', required: true },
+        hmac: { type: 'string', required: true },
+    },
+    required: ['_id', 'hmac'],
+    additionalProperties: true,
+    validationLevel: 'strict',
+    validationAction: 'error',
+};
+//# sourceMappingURL=mnemonicSchema.js.map

package/src/lib/interfaces/storage/mnemonicSchema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mnemonicSchema.js","sourceRoot":"","sources":["../../../../../../brightchain-api-lib/src/lib/interfaces/storage/mnemonicSchema.ts"],"names":[],"mappings":";;;AAEA,8DAA8D;AACjD,QAAA,oBAAoB,GAAG,WAAW,CAAC;AAEhD;;;;GAIG;AACU,QAAA,eAAe,GAAqB;IAC/C,IAAI,EAAE,UAAU;IAChB,UAAU,EAAE;QACV,GAAG,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE;QACvC,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE;KACzC;IACD,QAAQ,EAAE,CAAC,KAAK,EAAE,MAAM,CAAC;IACzB,oBAAoB,EAAE,IAAI;IAC1B,eAAe,EAAE,QAAQ;IACzB,gBAAgB,EAAE,OAAO;CAC1B,CAAC"}

package/src/lib/interfaces/storage/roleSchema.d.ts

@@ -0,0 +1,10 @@
+import type { CollectionSchema } from './document-types';
+/** Well-known collection name for roles. */
+export declare const ROLES_COLLECTION = "roles";
+/**
+ * Schema for the roles collection.
+ * Mirrors the Mongoose role document structure:
+ *   name, admin, member, child, system, createdBy, updatedBy, timestamps
+ */
+export declare const ROLE_SCHEMA: CollectionSchema;
+//# sourceMappingURL=roleSchema.d.ts.map

package/src/lib/interfaces/storage/roleSchema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"roleSchema.d.ts","sourceRoot":"","sources":["../../../../../../brightchain-api-lib/src/lib/interfaces/storage/roleSchema.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AAEzD,4CAA4C;AAC5C,eAAO,MAAM,gBAAgB,UAAU,CAAC;AAExC;;;;GAIG;AACH,eAAO,MAAM,WAAW,EAAE,gBAiCzB,CAAC"}

package/src/lib/interfaces/storage/roleSchema.js

@@ -0,0 +1,45 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ROLE_SCHEMA = exports.ROLES_COLLECTION = void 0;
+/** Well-known collection name for roles. */
+exports.ROLES_COLLECTION = 'roles';
+/**
+ * Schema for the roles collection.
+ * Mirrors the Mongoose role document structure:
+ *   name, admin, member, child, system, createdBy, updatedBy, timestamps
+ */
+exports.ROLE_SCHEMA = {
+    name: 'role',
+    properties: {
+        _id: { type: 'string', required: true },
+        name: {
+            type: 'string',
+            required: true,
+            enum: ['System', 'Admin', 'Member'],
+        },
+        admin: { type: 'boolean', required: true },
+        member: { type: 'boolean', required: true },
+        child: { type: 'boolean', required: true },
+        system: { type: 'boolean', required: true },
+        createdBy: { type: 'string', required: true },
+        updatedBy: { type: 'string', required: true },
+        createdAt: { type: 'string', required: true },
+        updatedAt: { type: 'string', required: true },
+    },
+    required: [
+        '_id',
+        'name',
+        'admin',
+        'member',
+        'child',
+        'system',
+        'createdBy',
+        'updatedBy',
+        'createdAt',
+        'updatedAt',
+    ],
+    additionalProperties: true,
+    validationLevel: 'strict',
+    validationAction: 'error',
+};
+//# sourceMappingURL=roleSchema.js.map

package/src/lib/interfaces/storage/roleSchema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"roleSchema.js","sourceRoot":"","sources":["../../../../../../brightchain-api-lib/src/lib/interfaces/storage/roleSchema.ts"],"names":[],"mappings":";;;AAEA,4CAA4C;AAC/B,QAAA,gBAAgB,GAAG,OAAO,CAAC;AAExC;;;;GAIG;AACU,QAAA,WAAW,GAAqB;IAC3C,IAAI,EAAE,MAAM;IACZ,UAAU,EAAE;QACV,GAAG,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE;QACvC,IAAI,EAAE;YACJ,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,IAAI;YACd,IAAI,EAAE,CAAC,QAAQ,EAAE,OAAO,EAAE,QAAQ,CAAC;SACpC;QACD,KAAK,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,QAAQ,EAAE,IAAI,EAAE;QAC1C,MAAM,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,QAAQ,EAAE,IAAI,EAAE;QAC3C,KAAK,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,QAAQ,EAAE,IAAI,EAAE;QAC1C,MAAM,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,QAAQ,EAAE,IAAI,EAAE;QAC3C,SAAS,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE;QAC7C,SAAS,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE;QAC7C,SAAS,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE;QAC7C,SAAS,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE;KAC9C;IACD,QAAQ,EAAE;QACR,KAAK;QACL,MAAM;QACN,OAAO;QACP,QAAQ;QACR,OAAO;QACP,QAAQ;QACR,WAAW;QACX,WAAW;QACX,WAAW;QACX,WAAW;KACZ;IACD,oBAAoB,EAAE,IAAI;IAC1B,eAAe,EAAE,QAAQ;IACzB,gBAAgB,EAAE,OAAO;CAC1B,CAAC"}

package/src/lib/interfaces/storage/userRoleSchema.d.ts

@@ -0,0 +1,10 @@
+import type { CollectionSchema } from './document-types';
+/** Well-known collection name for user-role junction documents. */
+export declare const USER_ROLES_COLLECTION = "user-roles";
+/**
+ * Schema for the user-roles collection.
+ * Mirrors the Mongoose user-role junction document structure:
+ *   userId, roleId, createdBy, updatedBy, timestamps
+ */
+export declare const USER_ROLE_SCHEMA: CollectionSchema;
+//# sourceMappingURL=userRoleSchema.d.ts.map

package/src/lib/interfaces/storage/userRoleSchema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"userRoleSchema.d.ts","sourceRoot":"","sources":["../../../../../../brightchain-api-lib/src/lib/interfaces/storage/userRoleSchema.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AAEzD,mEAAmE;AACnE,eAAO,MAAM,qBAAqB,eAAe,CAAC;AAElD;;;;GAIG;AACH,eAAO,MAAM,gBAAgB,EAAE,gBAuB9B,CAAC"}

package/src/lib/interfaces/storage/userRoleSchema.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.USER_ROLE_SCHEMA = exports.USER_ROLES_COLLECTION = void 0;
+/** Well-known collection name for user-role junction documents. */
+exports.USER_ROLES_COLLECTION = 'user-roles';
+/**
+ * Schema for the user-roles collection.
+ * Mirrors the Mongoose user-role junction document structure:
+ *   userId, roleId, createdBy, updatedBy, timestamps
+ */
+exports.USER_ROLE_SCHEMA = {
+    name: 'userRole',
+    properties: {
+        _id: { type: 'string', required: true },
+        userId: { type: 'string', required: true },
+        roleId: { type: 'string', required: true },
+        createdBy: { type: 'string', required: true },
+        updatedBy: { type: 'string', required: true },
+        createdAt: { type: 'string', required: true },
+        updatedAt: { type: 'string', required: true },
+    },
+    required: [
+        '_id',
+        'userId',
+        'roleId',
+        'createdBy',
+        'updatedBy',
+        'createdAt',
+        'updatedAt',
+    ],
+    additionalProperties: true,
+    validationLevel: 'strict',
+    validationAction: 'error',
+};
+//# sourceMappingURL=userRoleSchema.js.map

package/src/lib/interfaces/storage/userRoleSchema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"userRoleSchema.js","sourceRoot":"","sources":["../../../../../../brightchain-api-lib/src/lib/interfaces/storage/userRoleSchema.ts"],"names":[],"mappings":";;;AAEA,mEAAmE;AACtD,QAAA,qBAAqB,GAAG,YAAY,CAAC;AAElD;;;;GAIG;AACU,QAAA,gBAAgB,GAAqB;IAChD,IAAI,EAAE,UAAU;IAChB,UAAU,EAAE;QACV,GAAG,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE;QACvC,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE;QAC1C,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE;QAC1C,SAAS,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE;QAC7C,SAAS,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE;QAC7C,SAAS,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE;QAC7C,SAAS,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE;KAC9C;IACD,QAAQ,EAAE;QACR,KAAK;QACL,QAAQ;QACR,QAAQ;QACR,WAAW;QACX,WAAW;QACX,WAAW;QACX,WAAW;KACZ;IACD,oBAAoB,EAAE,IAAI;IAC1B,eAAe,EAAE,QAAQ;IACzB,gBAAgB,EAAE,OAAO;CAC1B,CAAC"}

package/src/lib/interfaces/storage/userSchema.d.ts

@@ -0,0 +1,12 @@
+import type { CollectionSchema } from './document-types';
+/** Well-known collection name for users. */
+export declare const USERS_COLLECTION = "users";
+/**
+ * Schema for the users collection.
+ * Mirrors the Mongoose user document structure:
+ *   username, email, publicKey, passwordWrappedPrivateKey, mnemonicRecovery,
+ *   mnemonicId, backupCodes, accountStatus, emailVerified, directChallenge,
+ *   timezone, siteLanguage, currency, darkMode, timestamps, owners
+ */
+export declare const USER_SCHEMA: CollectionSchema;
+//# sourceMappingURL=userSchema.d.ts.map

package/src/lib/interfaces/storage/userSchema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"userSchema.d.ts","sourceRoot":"","sources":["../../../../../../brightchain-api-lib/src/lib/interfaces/storage/userSchema.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AAEzD,4CAA4C;AAC5C,eAAO,MAAM,gBAAgB,UAAU,CAAC;AAExC;;;;;;GAMG;AACH,eAAO,MAAM,WAAW,EAAE,gBAgDzB,CAAC"}

package/src/lib/interfaces/storage/userSchema.js

@@ -0,0 +1,62 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.USER_SCHEMA = exports.USERS_COLLECTION = void 0;
+/** Well-known collection name for users. */
+exports.USERS_COLLECTION = 'users';
+/**
+ * Schema for the users collection.
+ * Mirrors the Mongoose user document structure:
+ *   username, email, publicKey, passwordWrappedPrivateKey, mnemonicRecovery,
+ *   mnemonicId, backupCodes, accountStatus, emailVerified, directChallenge,
+ *   timezone, siteLanguage, currency, darkMode, timestamps, owners
+ */
+exports.USER_SCHEMA = {
+    name: 'user',
+    properties: {
+        _id: { type: 'string', required: true },
+        username: { type: 'string', required: true },
+        email: { type: 'string', required: true },
+        publicKey: { type: 'string', required: true },
+        passwordWrappedPrivateKey: { type: 'object' },
+        mnemonicRecovery: { type: 'string', required: true },
+        mnemonicId: { type: 'string' },
+        backupCodes: { type: 'array', required: true },
+        accountStatus: {
+            type: 'string',
+            required: true,
+            enum: ['PendingEmailVerification', 'Active', 'AdminLock'],
+        },
+        emailVerified: { type: 'boolean', required: true },
+        directChallenge: { type: 'boolean', required: true },
+        timezone: { type: 'string', required: true },
+        siteLanguage: { type: 'string', required: true },
+        currency: { type: 'string' },
+        darkMode: { type: 'boolean', required: true },
+        createdBy: { type: 'string', required: true },
+        updatedBy: { type: 'string', required: true },
+        createdAt: { type: 'string', required: true },
+        updatedAt: { type: 'string', required: true },
+    },
+    required: [
+        '_id',
+        'username',
+        'email',
+        'publicKey',
+        'mnemonicRecovery',
+        'backupCodes',
+        'accountStatus',
+        'emailVerified',
+        'directChallenge',
+        'timezone',
+        'siteLanguage',
+        'darkMode',
+        'createdBy',
+        'updatedBy',
+        'createdAt',
+        'updatedAt',
+    ],
+    additionalProperties: true,
+    validationLevel: 'strict',
+    validationAction: 'error',
+};
+//# sourceMappingURL=userSchema.js.map

package/src/lib/interfaces/storage/userSchema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"userSchema.js","sourceRoot":"","sources":["../../../../../../brightchain-api-lib/src/lib/interfaces/storage/userSchema.ts"],"names":[],"mappings":";;;AAEA,4CAA4C;AAC/B,QAAA,gBAAgB,GAAG,OAAO,CAAC;AAExC;;;;;;GAMG;AACU,QAAA,WAAW,GAAqB;IAC3C,IAAI,EAAE,MAAM;IACZ,UAAU,EAAE;QACV,GAAG,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE;QACvC,QAAQ,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE;QAC5C,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE;QACzC,SAAS,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE;QAC7C,yBAAyB,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QAC7C,gBAAgB,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE;QACpD,UAAU,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QAC9B,WAAW,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE;QAC9C,aAAa,EAAE;YACb,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,IAAI;YACd,IAAI,EAAE,CAAC,0BAA0B,EAAE,QAAQ,EAAE,WAAW,CAAC;SAC1D;QACD,aAAa,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,QAAQ,EAAE,IAAI,EAAE;QAClD,eAAe,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,QAAQ,EAAE,IAAI,EAAE;QACpD,QAAQ,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE;QAC5C,YAAY,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE;QAChD,QAAQ,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QAC5B,QAAQ,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,QAAQ,EAAE,IAAI,EAAE;QAC7C,SAAS,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE;QAC7C,SAAS,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE;QAC7C,SAAS,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE;QAC7C,SAAS,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE;KAC9C;IACD,QAAQ,EAAE;QACR,KAAK;QACL,UAAU;QACV,OAAO;QACP,WAAW;QACX,kBAAkB;QAClB,aAAa;QACb,eAAe;QACf,eAAe;QACf,iBAAiB;QACjB,UAAU;QACV,cAAc;QACd,UAAU;QACV,WAAW;QACX,WAAW;QACX,WAAW;QACX,WAAW;KACZ;IACD,oBAAoB,EAAE,IAAI;IAC1B,eAAe,EAAE,QAAQ;IACzB,gBAAgB,EAAE,OAAO;CAC1B,CAAC"}

package/src/lib/plugins/brightchain-database-plugin.d.ts

@@ -0,0 +1,150 @@
+/**
+ * @fileoverview BrightChain database plugin for the express-suite plugin architecture.
+ *
+ * Implements IDatabasePlugin<TID> to encapsulate the BrightChain database stack
+ * lifecycle: block stores, BrightChainDb, member/energy stores, and the
+ * authentication provider. The plugin is registered via Application.useDatabasePlugin()
+ * and participates in the standard plugin lifecycle (connect → init → stop).
+ *
+ * BrightChainDb already implements IDatabase from express-suite, so the plugin's
+ * `database` property returns the BrightChainDb instance directly — no adapter needed.
+ *
+ * @module plugins/brightchain-database-plugin
+ */
+import type { IBlockStore, IDocumentStore } from '@brightchain/brightchain-lib';
+import { EnergyAccountStore, MemberStore } from '@brightchain/brightchain-lib';
+import type { BrightChainDb } from '@brightchain/db';
+import type { PlatformID } from '@digitaldefiance/node-ecies-lib';
+import type { IApplication, IAuthenticationProvider, IDatabase, IDatabasePlugin } from '@digitaldefiance/node-express-suite';
+import type { Environment } from '../environment';
+/**
+ * BrightChain database plugin implementing IDatabasePlugin<TID>.
+ *
+ * Owns the full database lifecycle:
+ * - connect() → calls brightchainDatabaseInit() and stores backend references
+ * - init(app) → creates BrightChainAuthenticationProvider
+ * - stop() → delegates to disconnect()
+ * - disconnect() → releases all references (idempotent)
+ *
+ * Typed accessors (blockStore, memberStore, energyStore, brightChainDb, documentStore)
+ * throw descriptive errors when the plugin is not connected.
+ */
+export declare class BrightChainDatabasePlugin<TID extends PlatformID> implements IDatabasePlugin<TID> {
+    readonly name = "brightchain-database";
+    readonly version = "1.0.0";
+    private readonly _environment;
+    private _connected;
+    private _blockStore;
+    private _brightChainDb;
+    private _documentStore;
+    private _memberStore;
+    private _energyStore;
+    private _authProvider;
+    constructor(environment: Environment<TID>);
+    /**
+     * The IDatabase instance this plugin manages.
+     * BrightChainDb implements IDatabase directly, so no adapter is needed.
+     * @throws Error if the plugin is not connected.
+     */
+    get database(): IDatabase;
+    /**
+     * Authentication provider created during init().
+     * Returns undefined before init() is called.
+     */
+    get authenticationProvider(): IAuthenticationProvider<TID> | undefined;
+    /**
+     * Connect the BrightChain database stack.
+     *
+     * Calls brightchainDatabaseInit(environment) and stores the resulting
+     * backend references (blockStore, db/BrightChainDb, documentStore,
+     * memberStore, energyStore).
+     *
+     * @param _uri - Ignored; BrightChain uses environment-based configuration.
+     * @throws Error if brightchainDatabaseInit() returns a failure result.
+     */
+    connect(_uri?: string): Promise<void>;
+    /**
+     * Disconnect and release all backend references.
+     * Idempotent — calling when already disconnected completes without error.
+     */
+    disconnect(): Promise<void>;
+    /**
+     * Whether the database is currently connected.
+     */
+    isConnected(): boolean;
+    /**
+     * Initialize the plugin after connection.
+     * Creates the BrightChainAuthenticationProvider and stores it
+     * as the authenticationProvider property.
+     *
+     * @param app - The application instance (must implement IBrightChainApplication).
+     */
+    init(app: IApplication<TID>): Promise<void>;
+    /**
+     * Stop the plugin. Delegates to disconnect() for cleanup.
+     */
+    stop(): Promise<void>;
+    /**
+     * Provision an ephemeral dev/test block store.
+     *
+     * Called by Application.start() before connect() when
+     * environment.devDatabase is truthy. BrightChain doesn't use
+     * connection URIs — the memory vs disk decision is driven by
+     * environment.blockStorePath (absent → memory). This hook
+     * signals that we're in dev mode and returns an empty string
+     * (no URI concept for block stores).
+     */
+    setupDevStore(): Promise<string>;
+    /**
+     * Tear down the ephemeral dev/test block store.
+     *
+     * Called during stop() flow. Our disconnect() already releases
+     * all in-memory references, so this is a no-op beyond logging.
+     */
+    teardownDevStore(): Promise<void>;
+    /**
+     * Seed the dev database after connection.
+     *
+     * Called by Application.start() after connect() and init() when
+     * environment.devDatabase is truthy. Currently a no-op — can be
+     * extended to seed test users, blocks, etc. for local development.
+     */
+    initializeDevStore(): Promise<unknown>;
+    /**
+     * The block store backing the BrightChain database.
+     * @throws Error if the plugin is not connected.
+     */
+    get blockStore(): IBlockStore;
+    /**
+     * The BrightChainDb instance (implements IDatabase).
+     * @throws Error if the plugin is not connected.
+     */
+    get brightChainDb(): BrightChainDb;
+    /**
+     * The document store (BrightChainDbDocumentStoreAdapter wrapping BrightChainDb).
+     * @throws Error if the plugin is not connected.
+     */
+    get documentStore(): IDocumentStore;
+    /**
+     * The member store for user/member operations.
+     * @throws Error if the plugin is not connected.
+     */
+    get memberStore(): MemberStore;
+    /**
+     * The energy account store for energy ledger operations.
+     * @throws Error if the plugin is not connected.
+     */
+    get energyStore(): EnergyAccountStore;
+    /**
+     * Extract the underlying BrightChainDb from the IDocumentStore adapter.
+     *
+     * brightchainDatabaseInit() wraps BrightChainDb in a
+     * BrightChainDbDocumentStoreAdapter. We need the raw BrightChainDb
+     * for the IDatabasePlugin.database property (IDatabase contract).
+     *
+     * We verify the adapter type via instanceof, then access the runtime
+     * `db` property (TypeScript `private` is compile-time only).
+     */
+    private extractBrightChainDb;
+}
+//# sourceMappingURL=brightchain-database-plugin.d.ts.map

package/src/lib/plugins/brightchain-database-plugin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"brightchain-database-plugin.d.ts","sourceRoot":"","sources":["../../../../../brightchain-api-lib/src/lib/plugins/brightchain-database-plugin.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAEH,OAAO,KAAK,EAAE,WAAW,EAAE,cAAc,EAAE,MAAM,8BAA8B,CAAC;AAChF,OAAO,EAAE,kBAAkB,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAC/E,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AACrD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iCAAiC,CAAC;AAClE,OAAO,KAAK,EACV,YAAY,EACZ,uBAAuB,EACvB,SAAS,EACT,eAAe,EAChB,MAAM,qCAAqC,CAAC;AAG7C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAIlD;;;;;;;;;;;GAWG;AACH,qBAAa,yBAAyB,CACpC,GAAG,SAAS,UAAU,CACtB,YAAW,eAAe,CAAC,GAAG,CAAC;IAC/B,SAAgB,IAAI,0BAA0B;IAC9C,SAAgB,OAAO,WAAW;IAElC,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAmB;IAChD,OAAO,CAAC,UAAU,CAAS;IAC3B,OAAO,CAAC,WAAW,CAA4B;IAC/C,OAAO,CAAC,cAAc,CAA8B;IACpD,OAAO,CAAC,cAAc,CAA+B;IACrD,OAAO,CAAC,YAAY,CAA4B;IAChD,OAAO,CAAC,YAAY,CAAmC;IACvD,OAAO,CAAC,aAAa,CAAuD;gBAEhE,WAAW,EAAE,WAAW,CAAC,GAAG,CAAC;IAMzC;;;;OAIG;IACH,IAAI,QAAQ,IAAI,SAAS,CAOxB;IAED;;;OAGG;IACH,IAAI,sBAAsB,IAAI,uBAAuB,CAAC,GAAG,CAAC,GAAG,SAAS,CAErE;IAED;;;;;;;;;OASG;IACG,OAAO,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAwB3C;;;OAGG;IACG,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;IAkBjC;;OAEG;IACH,WAAW,IAAI,OAAO;IAItB;;;;;;OAMG;IACG,IAAI,CAAC,GAAG,EAAE,YAAY,CAAC,GAAG,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAMjD;;OAEG;IACG,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAc3B;;;;;;;;;OASG;IACG,aAAa,IAAI,OAAO,CAAC,MAAM,CAAC;IAOtC;;;;;OAKG;IACG,gBAAgB,IAAI,OAAO,CAAC,IAAI,CAAC;IAIvC;;;;;;OAMG;IACG,kBAAkB,IAAI,OAAO,CAAC,OAAO,CAAC;IAM5C;;;OAGG;IACH,IAAI,UAAU,IAAI,WAAW,CAO5B;IAED;;;OAGG;IACH,IAAI,aAAa,IAAI,aAAa,CAOjC;IAED;;;OAGG;IACH,IAAI,aAAa,IAAI,cAAc,CAOlC;IAED;;;OAGG;IACH,IAAI,WAAW,IAAI,WAAW,CAO7B;IAED;;;OAGG;IACH,IAAI,WAAW,IAAI,kBAAkB,CAOpC;IAID;;;;;;;;;OASG;IACH,OAAO,CAAC,oBAAoB;CAqB7B"}