@brightchain/node-express-suite 0.25.0

package/src/lib/create-test-app.js

@@ -0,0 +1,49 @@
+"use strict";
+/**
+ * @fileoverview Test utility for creating an in-memory BrightDB plugin instance.
+ *
+ * Useful for integration tests that need a connected BrightDB instance
+ * without requiring a real block store on disk.
+ *
+ * @module create-test-app
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createTestApp = createTestApp;
+const bright_db_database_plugin_1 = require("./plugins/bright-db-database-plugin");
+const environment_1 = require("./environment");
+/**
+ * Create a test-friendly BrightDB plugin with in-memory configuration.
+ * Useful for integration tests that need a connected BrightDB instance.
+ */
+async function createTestApp(envOverrides) {
+    // Set up in-memory environment
+    const envVars = {
+        USE_MEMORY_DOCSTORE: 'true',
+        DEV_DATABASE: 'test-pool',
+        NODE_ENV: 'test',
+        ...envOverrides,
+    };
+    // Set env vars temporarily
+    const originalEnv = {};
+    for (const [key, value] of Object.entries(envVars)) {
+        originalEnv[key] = process.env[key];
+        process.env[key] = value;
+    }
+    const environment = new environment_1.BrightDbEnvironment();
+    // Restore env vars
+    for (const [key, value] of Object.entries(originalEnv)) {
+        if (value === undefined) {
+            delete process.env[key];
+        }
+        else {
+            process.env[key] = value;
+        }
+    }
+    const plugin = new bright_db_database_plugin_1.BrightDbDatabasePlugin(environment);
+    await plugin.connect();
+    const teardown = async () => {
+        await plugin.disconnect();
+    };
+    return { plugin, environment, teardown };
+}
+//# sourceMappingURL=create-test-app.js.map

package/src/lib/create-test-app.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"create-test-app.js","sourceRoot":"","sources":["../../../../brightchain-node-express-suite/src/lib/create-test-app.ts"],"names":[],"mappings":";AAAA;;;;;;;GAOG;;AAgBH,sCAqCC;AAnDD,mFAA6E;AAC7E,+CAAoD;AASpD;;;GAGG;AACI,KAAK,UAAU,aAAa,CACjC,YAAqC;IAErC,+BAA+B;IAC/B,MAAM,OAAO,GAA2B;QACtC,mBAAmB,EAAE,MAAM;QAC3B,YAAY,EAAE,WAAW;QACzB,QAAQ,EAAE,MAAM;QAChB,GAAG,YAAY;KAChB,CAAC;IAEF,2BAA2B;IAC3B,MAAM,WAAW,GAAuC,EAAE,CAAC;IAC3D,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;QACnD,WAAW,CAAC,GAAG,CAAC,GAAG,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACpC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;IAC3B,CAAC;IAED,MAAM,WAAW,GAAG,IAAI,iCAAmB,EAAO,CAAC;IAEnD,mBAAmB;IACnB,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,CAAC;QACvD,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACxB,OAAO,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAC1B,CAAC;aAAM,CAAC;YACN,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;QAC3B,CAAC;IACH,CAAC;IAED,MAAM,MAAM,GAAG,IAAI,kDAAsB,CAAM,WAAW,CAAC,CAAC;IAC5D,MAAM,MAAM,CAAC,OAAO,EAAE,CAAC;IAEvB,MAAM,QAAQ,GAAG,KAAK,IAAI,EAAE;QAC1B,MAAM,MAAM,CAAC,UAAU,EAAE,CAAC;IAC5B,CAAC,CAAC;IAEF,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,QAAQ,EAAE,CAAC;AAC3C,CAAC"}

package/src/lib/databaseInit.d.ts

@@ -0,0 +1,53 @@
+/**
+ * @fileoverview Generic BrightChain database initialization function.
+ *
+ * This is the Suite's generic version of the database init — it creates
+ * the block store and BrightDb instance based on environment configuration,
+ * but does NOT create domain-specific stores (MemberStore, EnergyAccountStore).
+ *
+ * Domain-specific model registrations are passed in via an optional callback.
+ *
+ * @module databaseInit
+ */
+import type { IBlockStore, ICloudBlockStoreConfig, IInitResult } from '@brightchain/brightchain-lib';
+import { BlockSize, BlockStoreType } from '@brightchain/brightchain-lib';
+import { BrightDb } from '@brightchain/db';
+/**
+ * Minimal environment interface required by the generic database init.
+ * Consumers pass an object satisfying this shape — it does NOT depend on
+ * api-lib's full Environment class.
+ */
+export interface IDatabaseInitEnvironment {
+    blockStorePath?: string;
+    blockStoreBlockSizes: readonly BlockSize[];
+    blockStoreType: BlockStoreType;
+    devDatabasePoolName?: string;
+    azureConfig?: ICloudBlockStoreConfig & Record<string, any>;
+    s3Config?: ICloudBlockStoreConfig & Record<string, any>;
+    memberPoolName: string;
+}
+/**
+ * The backend data returned on successful generic database init.
+ * Does NOT include domain-specific stores — those are added by the caller.
+ */
+export interface IGenericInitData {
+    blockStore: IBlockStore;
+    db: BrightDb;
+}
+/**
+ * Initialize the BrightChain database stack (generic version).
+ *
+ * Creates a block store and BrightDb instance based on environment config.
+ * Optionally calls a `modelRegistrations` callback after db.connect() so
+ * that the caller can register domain-specific models (e.g. energy_accounts).
+ *
+ * @param environment - Object satisfying IDatabaseInitEnvironment
+ * @param options.modelRegistrations - Optional callback to register models on the BrightDb instance.
+ *        Receives both the db and blockStore so callers can create domain-specific stores.
+ * @returns An IInitResult containing { blockStore, db } on success,
+ *          or a failure result with a descriptive error message.
+ */
+export declare function brightchainDatabaseInit(environment: IDatabaseInitEnvironment, options?: {
+    modelRegistrations?: (db: BrightDb, blockStore: IBlockStore) => void | Promise<void>;
+}): Promise<IInitResult<IGenericInitData>>;
+//# sourceMappingURL=databaseInit.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"databaseInit.d.ts","sourceRoot":"","sources":["../../../../brightchain-node-express-suite/src/lib/databaseInit.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,OAAO,KAAK,EACV,WAAW,EACX,sBAAsB,EACtB,WAAW,EACZ,MAAM,8BAA8B,CAAC;AACtC,OAAO,EACL,SAAS,EAET,cAAc,EACf,MAAM,8BAA8B,CAAC;AACtC,OAAO,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAI3C;;;;GAIG;AACH,MAAM,WAAW,wBAAwB;IACvC,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,oBAAoB,EAAE,SAAS,SAAS,EAAE,CAAC;IAC3C,cAAc,EAAE,cAAc,CAAC;IAC/B,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B,WAAW,CAAC,EAAE,sBAAsB,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAE3D,QAAQ,CAAC,EAAE,sBAAsB,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACxD,cAAc,EAAE,MAAM,CAAC;CACxB;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC/B,UAAU,EAAE,WAAW,CAAC;IACxB,EAAE,EAAE,QAAQ,CAAC;CACd;AAwBD;;;;;;;;;;;;GAYG;AACH,wBAAsB,uBAAuB,CAC3C,WAAW,EAAE,wBAAwB,EACrC,OAAO,CAAC,EAAE;IACR,kBAAkB,CAAC,EAAE,CAAC,EAAE,EAAE,QAAQ,EAAE,UAAU,EAAE,WAAW,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACtF,GACA,OAAO,CAAC,WAAW,CAAC,gBAAgB,CAAC,CAAC,CAuExC"}

package/src/lib/databaseInit.js

@@ -0,0 +1,114 @@
+"use strict";
+/**
+ * @fileoverview Generic BrightChain database initialization function.
+ *
+ * This is the Suite's generic version of the database init — it creates
+ * the block store and BrightDb instance based on environment configuration,
+ * but does NOT create domain-specific stores (MemberStore, EnergyAccountStore).
+ *
+ * Domain-specific model registrations are passed in via an optional callback.
+ *
+ * @module databaseInit
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.brightchainDatabaseInit = brightchainDatabaseInit;
+const brightchain_lib_1 = require("@brightchain/brightchain-lib");
+const db_1 = require("@brightchain/db");
+const fs_1 = require("fs");
+const promises_1 = require("fs/promises");
+/**
+ * Validate that the given directory path exists and is accessible.
+ * If the directory does not exist, attempt to create it recursively.
+ * Throws if the path is inaccessible after creation attempt.
+ */
+async function validateDataDir(dirPath) {
+    try {
+        await (0, promises_1.access)(dirPath, fs_1.constants.R_OK | fs_1.constants.W_OK);
+    }
+    catch {
+        // Directory doesn't exist or isn't accessible — try to create it
+        try {
+            await (0, promises_1.mkdir)(dirPath, { recursive: true });
+        }
+        catch (mkdirError) {
+            const message = mkdirError instanceof Error ? mkdirError.message : String(mkdirError);
+            throw new Error(`Cannot create or access data directory "${dirPath}": ${message}`);
+        }
+    }
+}
+/**
+ * Initialize the BrightChain database stack (generic version).
+ *
+ * Creates a block store and BrightDb instance based on environment config.
+ * Optionally calls a `modelRegistrations` callback after db.connect() so
+ * that the caller can register domain-specific models (e.g. energy_accounts).
+ *
+ * @param environment - Object satisfying IDatabaseInitEnvironment
+ * @param options.modelRegistrations - Optional callback to register models on the BrightDb instance.
+ *        Receives both the db and blockStore so callers can create domain-specific stores.
+ * @returns An IInitResult containing { blockStore, db } on success,
+ *          or a failure result with a descriptive error message.
+ */
+async function brightchainDatabaseInit(environment, options) {
+    try {
+        const blockStorePath = environment.blockStorePath;
+        const supportedBlockSizes = environment.blockStoreBlockSizes;
+        const devPoolName = environment.devDatabasePoolName;
+        let blockStore;
+        let dataDir;
+        if (devPoolName) {
+            // DEV_DATABASE is set — use ephemeral in-memory store for development
+            console.info(`[BrightChain] DEV_DATABASE="${devPoolName}" — using ephemeral MemoryBlockStore. Data will not persist across restarts.`);
+            blockStore = brightchain_lib_1.BlockStoreFactory.createMemoryStore({ supportedBlockSizes });
+        }
+        else if (environment.blockStoreType === brightchain_lib_1.BlockStoreType.AzureBlob) {
+            // Factory must have been registered by the consuming app importing
+            // '@brightchain/azure-store' at its entry point.
+            blockStore = brightchain_lib_1.BlockStoreFactory.createAzureStore(environment.azureConfig);
+        }
+        else if (environment.blockStoreType === brightchain_lib_1.BlockStoreType.S3) {
+            // Factory must have been registered by the consuming app importing
+            // '@brightchain/s3-store' at its entry point.
+            blockStore = brightchain_lib_1.BlockStoreFactory.createS3Store(environment.s3Config);
+        }
+        else if (blockStorePath) {
+            // Validate path accessibility, create if needed
+            await validateDataDir(blockStorePath);
+            blockStore = brightchain_lib_1.BlockStoreFactory.createDiskStore({
+                storePath: blockStorePath,
+                supportedBlockSizes,
+            });
+            dataDir = blockStorePath;
+        }
+        else {
+            throw new Error('Neither DEV_DATABASE nor BRIGHTCHAIN_BLOCKSTORE_PATH is set. ' +
+                'Set DEV_DATABASE to a pool name for in-memory development mode, ' +
+                'or set BRIGHTCHAIN_BLOCKSTORE_PATH for persistent disk storage.');
+        }
+        // Create BrightDb — uses PersistentHeadRegistry when dataDir is set,
+        // InMemoryHeadRegistry otherwise.
+        const db = new db_1.BrightDb(blockStore, dataDir ? { name: environment.memberPoolName, dataDir } : undefined);
+        // Mark the db as connected (no-op for block-store-backed DB, but sets
+        // the isConnected() flag that consumers check).
+        await db.connect();
+        // Call optional model registrations callback
+        if (options?.modelRegistrations) {
+            await options.modelRegistrations(db, blockStore);
+        }
+        return {
+            success: true,
+            backend: {
+                blockStore,
+                db,
+            },
+        };
+    }
+    catch (error) {
+        const message = error instanceof Error ? error.message : String(error);
+        return {
+            success: false,
+            error: `Database initialization failed: ${message}`,
+        };
+    }
+}
+//# sourceMappingURL=databaseInit.js.map

package/src/lib/databaseInit.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"databaseInit.js","sourceRoot":"","sources":["../../../../brightchain-node-express-suite/src/lib/databaseInit.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;GAUG;;AA6EH,0DA4EC;AAlJD,kEAIsC;AACtC,wCAA2C;AAC3C,2BAA8C;AAC9C,0CAA4C;AA4B5C;;;;GAIG;AACH,KAAK,UAAU,eAAe,CAAC,OAAe;IAC5C,IAAI,CAAC;QACH,MAAM,IAAA,iBAAM,EAAC,OAAO,EAAE,cAAW,CAAC,IAAI,GAAG,cAAW,CAAC,IAAI,CAAC,CAAC;IAC7D,CAAC;IAAC,MAAM,CAAC;QACP,iEAAiE;QACjE,IAAI,CAAC;YACH,MAAM,IAAA,gBAAK,EAAC,OAAO,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QAC5C,CAAC;QAAC,OAAO,UAAmB,EAAE,CAAC;YAC7B,MAAM,OAAO,GACX,UAAU,YAAY,KAAK,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;YACxE,MAAM,IAAI,KAAK,CACb,2CAA2C,OAAO,MAAM,OAAO,EAAE,CAClE,CAAC;QACJ,CAAC;IACH,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;GAYG;AACI,KAAK,UAAU,uBAAuB,CAC3C,WAAqC,EACrC,OAEC;IAED,IAAI,CAAC;QACH,MAAM,cAAc,GAAG,WAAW,CAAC,cAAc,CAAC;QAClD,MAAM,mBAAmB,GACvB,WAAW,CAAC,oBAAoB,CAAC;QACnC,MAAM,WAAW,GAAG,WAAW,CAAC,mBAAmB,CAAC;QAEpD,IAAI,UAAuB,CAAC;QAC5B,IAAI,OAA2B,CAAC;QAEhC,IAAI,WAAW,EAAE,CAAC;YAChB,sEAAsE;YACtE,OAAO,CAAC,IAAI,CACV,+BAA+B,WAAW,8EAA8E,CACzH,CAAC;YACF,UAAU,GAAG,mCAAiB,CAAC,iBAAiB,CAAC,EAAE,mBAAmB,EAAE,CAAC,CAAC;QAC5E,CAAC;aAAM,IAAI,WAAW,CAAC,cAAc,KAAK,gCAAc,CAAC,SAAS,EAAE,CAAC;YACnE,mEAAmE;YACnE,iDAAiD;YACjD,UAAU,GAAG,mCAAiB,CAAC,gBAAgB,CAAC,WAAW,CAAC,WAAY,CAAC,CAAC;QAC5E,CAAC;aAAM,IAAI,WAAW,CAAC,cAAc,KAAK,gCAAc,CAAC,EAAE,EAAE,CAAC;YAC5D,mEAAmE;YACnE,8CAA8C;YAC9C,UAAU,GAAG,mCAAiB,CAAC,aAAa,CAAC,WAAW,CAAC,QAAS,CAAC,CAAC;QACtE,CAAC;aAAM,IAAI,cAAc,EAAE,CAAC;YAC1B,gDAAgD;YAChD,MAAM,eAAe,CAAC,cAAc,CAAC,CAAC;YAEtC,UAAU,GAAG,mCAAiB,CAAC,eAAe,CAAC;gBAC7C,SAAS,EAAE,cAAc;gBACzB,mBAAmB;aACpB,CAAC,CAAC;YACH,OAAO,GAAG,cAAc,CAAC;QAC3B,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,KAAK,CACb,+DAA+D;gBAC7D,kEAAkE;gBAClE,iEAAiE,CACpE,CAAC;QACJ,CAAC;QAED,qEAAqE;QACrE,kCAAkC;QAClC,MAAM,EAAE,GAAG,IAAI,aAAQ,CACrB,UAAU,EACV,OAAO,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,WAAW,CAAC,cAAc,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,SAAS,CACpE,CAAC;QAEF,sEAAsE;QACtE,gDAAgD;QAChD,MAAM,EAAE,CAAC,OAAO,EAAE,CAAC;QAEnB,6CAA6C;QAC7C,IAAI,OAAO,EAAE,kBAAkB,EAAE,CAAC;YAChC,MAAM,OAAO,CAAC,kBAAkB,CAAC,EAAE,EAAE,UAAU,CAAC,CAAC;QACnD,CAAC;QAED,OAAO;YACL,OAAO,EAAE,IAAI;YACb,OAAO,EAAE;gBACP,UAAU;gBACV,EAAE;aACH;SACF,CAAC;IACJ,CAAC;IAAC,OAAO,KAAc,EAAE,CAAC;QACxB,MAAM,OAAO,GAAG,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QACvE,OAAO;YACL,OAAO,EAAE,KAAK;YACd,KAAK,EAAE,mCAAmC,OAAO,EAAE;SACpD,CAAC;IACJ,CAAC;AACH,CAAC"}

package/src/lib/datastore/block-document-store-factory.d.ts

@@ -0,0 +1,31 @@
+import { BlockSize, IBlockStore, IQuorumService } from '@brightchain/brightchain-lib';
+import { PlatformID } from '@digitaldefiance/ecies-lib';
+import { DocumentStore } from './document-store';
+export type BlockDocumentStoreOptions = {
+    blockStore?: IBlockStore;
+    storePath?: string;
+    blockSize?: BlockSize;
+    useMemory?: boolean;
+    /**
+     * Optional QuorumService for encryption support
+     */
+    quorumService?: IQuorumService<PlatformID>;
+    /**
+     * Optional factory function to create a disk-backed block store.
+     * This replaces the direct DiskBlockAsyncStore import, allowing
+     * consumers (e.g., api-lib) to inject their own disk store implementation.
+     */
+    diskBlockStoreFactory?: (options: {
+        storePath: string;
+        blockSize: BlockSize;
+    }) => IBlockStore;
+};
+/**
+ * Create a BlockDocumentStore backed by either a provided BlockStore, a disk store, or an in-memory store.
+ * Optionally supports encryption via QuorumService.
+ *
+ * For disk-backed stores, provide a `diskBlockStoreFactory` callback that creates the appropriate
+ * IBlockStore implementation (e.g., DiskBlockAsyncStore from api-lib).
+ */
+export declare function createBlockDocumentStore(options: BlockDocumentStoreOptions): DocumentStore;
+//# sourceMappingURL=block-document-store-factory.d.ts.map

package/src/lib/datastore/block-document-store-factory.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"block-document-store-factory.d.ts","sourceRoot":"","sources":["../../../../../brightchain-node-express-suite/src/lib/datastore/block-document-store-factory.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,SAAS,EACT,WAAW,EACX,cAAc,EAEf,MAAM,8BAA8B,CAAC;AACtC,OAAO,EAAE,UAAU,EAAE,MAAM,4BAA4B,CAAC;AAExD,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAEjD,MAAM,MAAM,yBAAyB,GAAG;IACtC,UAAU,CAAC,EAAE,WAAW,CAAC;IACzB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB;;OAEG;IACH,aAAa,CAAC,EAAE,cAAc,CAAC,UAAU,CAAC,CAAC;IAC3C;;;;OAIG;IACH,qBAAqB,CAAC,EAAE,CAAC,OAAO,EAAE;QAChC,SAAS,EAAE,MAAM,CAAC;QAClB,SAAS,EAAE,SAAS,CAAC;KACtB,KAAK,WAAW,CAAC;CACnB,CAAC;AAEF;;;;;;GAMG;AACH,wBAAgB,wBAAwB,CACtC,OAAO,EAAE,yBAAyB,GACjC,aAAa,CA6Bf"}

package/src/lib/datastore/block-document-store-factory.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createBlockDocumentStore = createBlockDocumentStore;
+const brightchain_lib_1 = require("@brightchain/brightchain-lib");
+const block_document_store_1 = require("./block-document-store");
+/**
+ * Create a BlockDocumentStore backed by either a provided BlockStore, a disk store, or an in-memory store.
+ * Optionally supports encryption via QuorumService.
+ *
+ * For disk-backed stores, provide a `diskBlockStoreFactory` callback that creates the appropriate
+ * IBlockStore implementation (e.g., DiskBlockAsyncStore from api-lib).
+ */
+function createBlockDocumentStore(options) {
+    const blockSize = options.blockSize ?? brightchain_lib_1.BlockSize.Small;
+    if (options.blockStore) {
+        return new block_document_store_1.BlockDocumentStore(options.blockStore, options.quorumService);
+    }
+    if (options.useMemory) {
+        const memoryStore = new brightchain_lib_1.MemoryBlockStore(blockSize);
+        return new block_document_store_1.BlockDocumentStore(memoryStore, options.quorumService);
+    }
+    if (options.storePath) {
+        if (!options.diskBlockStoreFactory) {
+            throw new Error('createBlockDocumentStore requires a diskBlockStoreFactory when using storePath. ' +
+                'Provide a factory function that creates an IBlockStore for disk-backed storage.');
+        }
+        const diskStore = options.diskBlockStoreFactory({
+            storePath: options.storePath,
+            blockSize,
+        });
+        return new block_document_store_1.BlockDocumentStore(diskStore, options.quorumService);
+    }
+    throw new Error('createBlockDocumentStore requires a blockStore, storePath (with diskBlockStoreFactory), or useMemory=true');
+}
+//# sourceMappingURL=block-document-store-factory.js.map

package/src/lib/datastore/block-document-store-factory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"block-document-store-factory.js","sourceRoot":"","sources":["../../../../../brightchain-node-express-suite/src/lib/datastore/block-document-store-factory.ts"],"names":[],"mappings":";;AAqCA,4DA+BC;AApED,kEAKsC;AAEtC,iEAA4D;AAuB5D;;;;;;GAMG;AACH,SAAgB,wBAAwB,CACtC,OAAkC;IAElC,MAAM,SAAS,GAAG,OAAO,CAAC,SAAS,IAAI,2BAAS,CAAC,KAAK,CAAC;IAEvD,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC;QACvB,OAAO,IAAI,yCAAkB,CAAC,OAAO,CAAC,UAAU,EAAE,OAAO,CAAC,aAAa,CAAC,CAAC;IAC3E,CAAC;IAED,IAAI,OAAO,CAAC,SAAS,EAAE,CAAC;QACtB,MAAM,WAAW,GAAG,IAAI,kCAAgB,CAAC,SAAS,CAAC,CAAC;QACpD,OAAO,IAAI,yCAAkB,CAAC,WAAW,EAAE,OAAO,CAAC,aAAa,CAAC,CAAC;IACpE,CAAC;IAED,IAAI,OAAO,CAAC,SAAS,EAAE,CAAC;QACtB,IAAI,CAAC,OAAO,CAAC,qBAAqB,EAAE,CAAC;YACnC,MAAM,IAAI,KAAK,CACb,kFAAkF;gBAChF,iFAAiF,CACpF,CAAC;QACJ,CAAC;QACD,MAAM,SAAS,GAAG,OAAO,CAAC,qBAAqB,CAAC;YAC9C,SAAS,EAAE,OAAO,CAAC,SAAS;YAC5B,SAAS;SACV,CAAC,CAAC;QACH,OAAO,IAAI,yCAAkB,CAAC,SAAS,EAAE,OAAO,CAAC,aAAa,CAAC,CAAC;IAClE,CAAC;IAED,MAAM,IAAI,KAAK,CACb,2GAA2G,CAC5G,CAAC;AACJ,CAAC"}

package/src/lib/datastore/block-document-store.d.ts

@@ -0,0 +1,201 @@
+import { IBlockStore, IQuorumService } from '@brightchain/brightchain-lib';
+import { HexString, IIdProvider, Member, PlatformID } from '@digitaldefiance/ecies-lib';
+import { DocumentCollection, DocumentId, DocumentRecord, IBrightDbDocumentStore, QueryBuilder } from './document-store';
+/**
+ * Options for creating a document with optional encryption
+ */
+export interface CreateDocumentOptions<TID extends PlatformID = Uint8Array> {
+    /**
+     * Whether to encrypt the document using quorum sealing
+     */
+    encrypt?: boolean;
+    /**
+     * The member performing the sealing operation (required if encrypt is true)
+     */
+    agent?: Member<TID>;
+    /**
+     * IDs of members who will receive shares (required if encrypt is true)
+     */
+    memberIds?: TID[];
+    /**
+     * Number of shares required to unseal (defaults to all members)
+     */
+    sharesRequired?: number;
+}
+/**
+ * Options for retrieving an encrypted document
+ */
+export interface RetrieveDocumentOptions<TID extends PlatformID = Uint8Array> {
+    /**
+     * Members with loaded private keys for decryption (required for encrypted documents)
+     */
+    membersWithPrivateKey?: Member<TID>[];
+}
+/**
+ * Metadata stored alongside encrypted documents
+ */
+interface EncryptedDocumentMetadata {
+    isEncrypted: boolean;
+    sealedDocumentId?: HexString;
+    memberIds?: HexString[];
+    sharesRequired?: number;
+    createdAt?: string;
+}
+/**
+ * Simple in-memory registry for collection head pointers.
+ * This maps collection names to their latest index block IDs.
+ *
+ * In a production system, this would be persisted to a separate
+ * key-value store or database. For now, we use a static map
+ * that's shared across all BlockDocumentStore instances.
+ */
+export declare class CollectionHeadRegistry {
+    private static instance;
+    private readonly heads;
+    private constructor();
+    static getInstance(): CollectionHeadRegistry;
+    getHead(collectionKey: string): string | undefined;
+    setHead(collectionKey: string, indexBlockId: string): void;
+    /**
+     * Generate a unique key for a collection based on store identity and collection name
+     */
+    static makeKey(storeId: string, collectionName: string): string;
+    /**
+     * Clear all heads (useful for testing)
+     */
+    clear(): void;
+}
+declare class BlockCollection<T extends DocumentRecord, TID extends PlatformID = PlatformID> implements DocumentCollection<T> {
+    private readonly store;
+    private readonly collectionName;
+    private readonly quorumService?;
+    private readonly storeId;
+    private readonly generateId;
+    private readonly index;
+    private readonly registryKey;
+    private indexLoaded;
+    private indexLoading;
+    constructor(store: IBlockStore, collectionName: string, quorumService?: IQuorumService<TID> | undefined, storeId?: string, generateId?: () => string);
+    private ensureIndexLoaded;
+    private persistIndex;
+    private resolveBlockId;
+    private writeDoc;
+    private readDoc;
+    private toSingleQuery;
+    private toManyQuery;
+    find(filter?: Partial<T>): QueryBuilder<T[]>;
+    findOne(filter?: Partial<T>): QueryBuilder<T>;
+    findById(id: DocumentId): QueryBuilder<T>;
+    /**
+     * Retrieve a document by ID, decrypting if necessary
+     * @param id - The document ID
+     * @param options - Options for retrieving encrypted documents
+     * @returns The document (decrypted if it was encrypted)
+     */
+    findByIdDecrypted(id: DocumentId, options?: RetrieveDocumentOptions<TID>): Promise<T | null>;
+    /**
+     * Check if a document is encrypted
+     * @param id - The document ID
+     * @returns True if the document is encrypted
+     */
+    isEncrypted(id: DocumentId): Promise<boolean>;
+    /**
+     * Get encryption metadata for a document
+     * @param id - The document ID
+     * @returns The encryption metadata, or null if not encrypted
+     */
+    getEncryptionMetadata(id: DocumentId): Promise<EncryptedDocumentMetadata | null>;
+    /**
+     * Check if a member has access to a document
+     * @param id - The document ID
+     * @param memberId - The member ID to check access for
+     * @returns True if the member has access (either unencrypted or member is in the encryption list)
+     */
+    hasAccess(id: DocumentId, memberId: HexString): Promise<boolean>;
+    /**
+     * Find all documents accessible by a specific member
+     * @param memberId - The member ID to filter by
+     * @param filter - Optional additional filter criteria
+     * @returns Array of documents the member has access to
+     */
+    findAccessibleBy(memberId: HexString, filter?: Partial<T>): Promise<T[]>;
+    /**
+     * Find one document accessible by a specific member
+     * @param memberId - The member ID to filter by
+     * @param filter - Optional additional filter criteria
+     * @returns The first document the member has access to, or null
+     */
+    findOneAccessibleBy(memberId: HexString, filter?: Partial<T>): Promise<T | null>;
+    /**
+     * Count documents accessible by a specific member
+     * @param memberId - The member ID to filter by
+     * @param filter - Optional additional filter criteria
+     * @returns The count of documents the member has access to
+     */
+    countAccessibleBy(memberId: HexString, filter?: Partial<T>): Promise<number>;
+    findOneAndUpdate(filter: Partial<T>, update: Partial<T>): QueryBuilder<T>;
+    findOneAndDelete(filter: Partial<T>): QueryBuilder<T>;
+    findByIdAndUpdate(id: DocumentId, update: Partial<T>): QueryBuilder<T>;
+    findByIdAndDelete(id: DocumentId): QueryBuilder<T>;
+    create(doc: T): Promise<T>;
+    create(doc: T, options?: CreateDocumentOptions<TID>): Promise<T>;
+    insertMany(docs: T[]): Promise<T[]>;
+    updateOne(filter: Partial<T>, update: Partial<T>): Promise<{
+        modifiedCount: number;
+        matchedCount: number;
+    }>;
+    updateMany(filter: Partial<T>, update: Partial<T>): Promise<{
+        modifiedCount: number;
+        matchedCount: number;
+    }>;
+    replaceOne(filter: Partial<T>, doc: T): Promise<{
+        modifiedCount: number;
+        matchedCount: number;
+    }>;
+    deleteOne(filter: Partial<T>): Promise<{
+        deletedCount: number;
+    }>;
+    deleteMany(filter: Partial<T>): Promise<{
+        deletedCount: number;
+    }>;
+    countDocuments(filter?: Partial<T>): Promise<number>;
+    estimatedDocumentCount(): Promise<number>;
+    aggregate<U = unknown>(_pipeline: unknown[]): QueryBuilder<U[]>;
+    distinct(field: keyof T): QueryBuilder<T[keyof T][]>;
+    exists(filter: Partial<T>): Promise<{
+        _id: DocumentId;
+    } | null>;
+    watch(): void;
+    startSession(): unknown;
+}
+export declare class BlockDocumentStore<TID extends PlatformID = PlatformID> implements IBrightDbDocumentStore {
+    private readonly blockStore;
+    private readonly quorumService?;
+    private readonly collections;
+    private readonly storeId;
+    private readonly generateId;
+    private _connected;
+    constructor(blockStore: IBlockStore, quorumService?: IQuorumService<TID> | undefined, idProvider?: IIdProvider<TID>);
+    /**
+     * Attempt to resolve the ID provider from the global ServiceProvider.
+     * Returns undefined if the ServiceProvider is not yet initialized.
+     */
+    private resolveIdProvider;
+    collection<T extends DocumentRecord>(name: string): DocumentCollection<T>;
+    /**
+     * Get a collection with encryption support
+     * @param name - The collection name
+     * @returns The collection with encryption methods available
+     */
+    encryptedCollection<T extends DocumentRecord>(name: string): BlockCollection<T, TID>;
+    connect(): Promise<void>;
+    disconnect(): Promise<void>;
+    isConnected(): boolean;
+    /**
+     * Retrieve a collection by model name.
+     * Alias for collection() to match upstream's IDocumentStore.getModel() pattern.
+     */
+    getModel<T extends DocumentRecord>(modelName: string): DocumentCollection<T>;
+}
+export {};
+//# sourceMappingURL=block-document-store.d.ts.map

package/src/lib/datastore/block-document-store.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"block-document-store.d.ts","sourceRoot":"","sources":["../../../../../brightchain-node-express-suite/src/lib/datastore/block-document-store.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,WAAW,EACX,cAAc,EAEf,MAAM,8BAA8B,CAAC;AACtC,OAAO,EACL,SAAS,EACT,WAAW,EACX,MAAM,EACN,UAAU,EACX,MAAM,4BAA4B,CAAC;AAEpC,OAAO,EACL,kBAAkB,EAClB,UAAU,EACV,cAAc,EAEd,sBAAsB,EACtB,YAAY,EAEb,MAAM,kBAAkB,CAAC;AAE1B;;GAEG;AACH,MAAM,WAAW,qBAAqB,CAAC,GAAG,SAAS,UAAU,GAAG,UAAU;IACxE;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC;IACpB;;OAEG;IACH,SAAS,CAAC,EAAE,GAAG,EAAE,CAAC;IAClB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB,CAAC,GAAG,SAAS,UAAU,GAAG,UAAU;IAC1E;;OAEG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC;CACvC;AAED;;GAEG;AACH,UAAU,yBAAyB;IACjC,WAAW,EAAE,OAAO,CAAC;IACrB,gBAAgB,CAAC,EAAE,SAAS,CAAC;IAC7B,SAAS,CAAC,EAAE,SAAS,EAAE,CAAC;IACxB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AASD;;;;;;;GAOG;AACH,qBAAa,sBAAsB;IACjC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAyB;IAChD,OAAO,CAAC,QAAQ,CAAC,KAAK,CAA6B;IAEnD,OAAO;IAEP,MAAM,CAAC,WAAW,IAAI,sBAAsB;IAO5C,OAAO,CAAC,aAAa,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;IAIlD,OAAO,CAAC,aAAa,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,IAAI;IAI1D;;OAEG;IACH,MAAM,CAAC,OAAO,CAAC,OAAO,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,GAAG,MAAM;IAI/D;;OAEG;IACH,KAAK,IAAI,IAAI;CAGd;AAwFD,cAAM,eAAe,CACnB,CAAC,SAAS,cAAc,EACxB,GAAG,SAAS,UAAU,GAAG,UAAU,CACnC,YAAW,kBAAkB,CAAC,CAAC,CAAC;IAQ9B,OAAO,CAAC,QAAQ,CAAC,KAAK;IACtB,OAAO,CAAC,QAAQ,CAAC,cAAc;IAC/B,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAC;IAC/B,OAAO,CAAC,QAAQ,CAAC,OAAO;IACxB,OAAO,CAAC,QAAQ,CAAC,UAAU;IAV7B,OAAO,CAAC,QAAQ,CAAC,KAAK,CAA6B;IACnD,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAS;IACrC,OAAO,CAAC,WAAW,CAAS;IAC5B,OAAO,CAAC,YAAY,CAA4B;gBAG7B,KAAK,EAAE,WAAW,EAClB,cAAc,EAAE,MAAM,EACtB,aAAa,CAAC,EAAE,cAAc,CAAC,GAAG,CAAC,YAAA,EACnC,OAAO,GAAE,MAAkB,EAC3B,UAAU,GAAE,MAAM,MACH;YAMpB,iBAAiB;YA0CjB,YAAY;IAyB1B,OAAO,CAAC,cAAc;YAIR,QAAQ;YAgCR,OAAO;IAgBrB,OAAO,CAAC,aAAa;IAIrB,OAAO,CAAC,WAAW;IAMnB,IAAI,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,GAAG,YAAY,CAAC,CAAC,EAAE,CAAC;IAY5C,OAAO,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,GAAG,YAAY,CAAC,CAAC,CAAC;IAW7C,QAAQ,CAAC,EAAE,EAAE,UAAU,GAAG,YAAY,CAAC,CAAC,CAAC;IAIzC;;;;;OAKG;IACG,iBAAiB,CACrB,EAAE,EAAE,UAAU,EACd,OAAO,CAAC,EAAE,uBAAuB,CAAC,GAAG,CAAC,GACrC,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC;IAgDpB;;;;OAIG;IACG,WAAW,CAAC,EAAE,EAAE,UAAU,GAAG,OAAO,CAAC,OAAO,CAAC;IASnD;;;;OAIG;IACG,qBAAqB,CACzB,EAAE,EAAE,UAAU,GACb,OAAO,CAAC,yBAAyB,GAAG,IAAI,CAAC;IAS5C;;;;;OAKG;IACG,SAAS,CAAC,EAAE,EAAE,UAAU,EAAE,QAAQ,EAAE,SAAS,GAAG,OAAO,CAAC,OAAO,CAAC;IAiBtE;;;;;OAKG;IACG,gBAAgB,CACpB,QAAQ,EAAE,SAAS,EACnB,MAAM,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,GAClB,OAAO,CAAC,CAAC,EAAE,CAAC;IAwBf;;;;;OAKG;IACG,mBAAmB,CACvB,QAAQ,EAAE,SAAS,EACnB,MAAM,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,GAClB,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC;IAsBpB;;;;;OAKG;IACG,iBAAiB,CACrB,QAAQ,EAAE,SAAS,EACnB,MAAM,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,GAClB,OAAO,CAAC,MAAM,CAAC;IAKlB,gBAAgB,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,GAAG,YAAY,CAAC,CAAC,CAAC;IAazE,gBAAgB,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,GAAG,YAAY,CAAC,CAAC,CAAC;IASrD,iBAAiB,CAAC,EAAE,EAAE,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,GAAG,YAAY,CAAC,CAAC,CAAC;IAItE,iBAAiB,CAAC,EAAE,EAAE,UAAU,GAAG,YAAY,CAAC,CAAC,CAAC;IAI5C,MAAM,CAAC,GAAG,EAAE,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;IAC1B,MAAM,CAAC,GAAG,EAAE,CAAC,EAAE,OAAO,CAAC,EAAE,qBAAqB,CAAC,GAAG,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;IAkDhE,UAAU,CAAC,IAAI,EAAE,CAAC,EAAE,GAAG,OAAO,CAAC,CAAC,EAAE,CAAC;IASnC,SAAS,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;;;;IAWhD,UAAU,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;;;;IAgBjD,UAAU,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC;;;;IAUrC,SAAS,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;;;IAkB5B,UAAU,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;;;IAqB7B,cAAc,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC;IAKlC,sBAAsB;IAI5B,SAAS,CAAC,CAAC,GAAG,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,GAAG,YAAY,CAAC,CAAC,EAAE,CAAC;IAI/D,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC,GAAG,YAAY,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC;IAW9C,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;aAGsB,UAAU;;IAG/D,KAAK,IAAI,IAAI;IAIb,YAAY,IAAI,OAAO;CAGxB;AAGD,qBAAa,kBAAkB,CAAC,GAAG,SAAS,UAAU,GAAG,UAAU,CACjE,YAAW,sBAAsB;IAW/B,OAAO,CAAC,QAAQ,CAAC,UAAU;IAC3B,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAC;IAVjC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAGxB;IACJ,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAS;IACjC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAe;IAC1C,OAAO,CAAC,UAAU,CAAS;gBAGR,UAAU,EAAE,WAAW,EACvB,aAAa,CAAC,EAAE,cAAc,CAAC,GAAG,CAAC,YAAA,EACpD,UAAU,CAAC,EAAE,WAAW,CAAC,GAAG,CAAC;IAc/B;;;OAGG;IACH,OAAO,CAAC,iBAAiB;IAQzB,UAAU,CAAC,CAAC,SAAS,cAAc,EAAE,IAAI,EAAE,MAAM,GAAG,kBAAkB,CAAC,CAAC,CAAC;IAgBzE;;;;OAIG;IACH,mBAAmB,CAAC,CAAC,SAAS,cAAc,EAC1C,IAAI,EAAE,MAAM,GACX,eAAe,CAAC,CAAC,EAAE,GAAG,CAAC;IAqBpB,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAIxB,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;IAIjC,WAAW,IAAI,OAAO;IAItB;;;OAGG;IACH,QAAQ,CAAC,CAAC,SAAS,cAAc,EAAE,SAAS,EAAE,MAAM,GAAG,kBAAkB,CAAC,CAAC,CAAC;CAG7E"}