@brightchain/brightchain-api-lib 0.14.0 → 0.15.0

package/src/lib/blockFetch/httpBlockFetchTransport.js

@@ -0,0 +1,104 @@
+"use strict";
+/**
+ * @fileoverview HTTP Block Fetch Transport
+ *
+ * Implements IBlockFetchTransport using HTTP GET requests to remote nodes'
+ * SyncController `/api/sync/blocks/:blockId` endpoint.
+ *
+ * Node.js specific (uses fetch API available in Node 18+).
+ *
+ * @see cross-node-eventual-consistency design, Section 2
+ * @see Requirements 1.1, 5.2
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HttpBlockFetchTransport = exports.MapNodeAddressResolver = void 0;
+const brightchain_lib_1 = require("@brightchain/brightchain-lib");
+/**
+ * Simple map-based node address resolver.
+ * Maps node IDs to their base URLs.
+ */
+class MapNodeAddressResolver {
+    constructor(nodeAddresses) {
+        this.nodeAddresses = nodeAddresses;
+    }
+    getNodeBaseUrl(nodeId) {
+        return this.nodeAddresses.get(nodeId);
+    }
+}
+exports.MapNodeAddressResolver = MapNodeAddressResolver;
+/**
+ * HTTP-based implementation of IBlockFetchTransport.
+ *
+ * Fetches block data from remote nodes via their SyncController endpoint:
+ *   GET /api/sync/blocks/:blockId[?poolId=<poolId>]
+ *
+ * The response is JSON with `{ message, blockId, data }` where `data` is
+ * base64-encoded. This transport decodes the base64 data and returns raw bytes.
+ *
+ * @see Requirements 1.1 — Block fetching protocol
+ * @see Requirements 5.2 — Pool ID included in fetch request
+ */
+class HttpBlockFetchTransport {
+    constructor(addressResolver) {
+        this.addressResolver = addressResolver;
+    }
+    /**
+     * Fetch raw block data from a specific remote node via HTTP GET.
+     *
+     * @param nodeId - The target node identifier (resolved to URL via addressResolver)
+     * @param blockId - The block checksum/ID to fetch
+     * @param poolId - Optional pool scope; appended as query parameter
+     * @returns The raw block bytes decoded from the base64 response
+     * @throws BlockFetchError if the node address is unknown, HTTP request fails, or response is invalid
+     */
+    async fetchBlockFromNode(nodeId, blockId, poolId) {
+        const baseUrl = this.addressResolver.getNodeBaseUrl(nodeId);
+        if (!baseUrl) {
+            throw new brightchain_lib_1.BlockFetchError(blockId, [
+                {
+                    nodeId,
+                    error: `Unknown node: no address registered for "${nodeId}"`,
+                },
+            ], `Cannot fetch block ${blockId}: no address for node "${nodeId}"`);
+        }
+        const url = this.buildUrl(baseUrl, blockId, poolId);
+        let response;
+        try {
+            response = await fetch(url);
+        }
+        catch (error) {
+            const errorMessage = error instanceof Error ? error.message : String(error);
+            throw new brightchain_lib_1.BlockFetchError(blockId, [{ nodeId, error: errorMessage }], `Network error fetching block ${blockId} from node "${nodeId}": ${errorMessage}`);
+        }
+        if (!response.ok) {
+            const statusText = response.statusText || `HTTP ${response.status}`;
+            throw new brightchain_lib_1.BlockFetchError(blockId, [{ nodeId, error: `${statusText} (${response.status})` }], `Failed to fetch block ${blockId} from node "${nodeId}": ${statusText} (${response.status})`);
+        }
+        let body;
+        try {
+            body = (await response.json());
+        }
+        catch (error) {
+            const errorMessage = error instanceof Error ? error.message : String(error);
+            throw new brightchain_lib_1.BlockFetchError(blockId, [{ nodeId, error: `Invalid JSON response: ${errorMessage}` }], `Invalid response from node "${nodeId}" for block ${blockId}: ${errorMessage}`);
+        }
+        if (!body.data) {
+            throw new brightchain_lib_1.BlockFetchError(blockId, [{ nodeId, error: 'Response missing "data" field' }], `Invalid response from node "${nodeId}" for block ${blockId}: missing "data" field`);
+        }
+        return Buffer.from(body.data, 'base64');
+    }
+    /**
+     * Build the full URL for the block fetch request.
+     * Format: {baseUrl}/api/sync/blocks/{blockId}[?poolId={poolId}]
+     */
+    buildUrl(baseUrl, blockId, poolId) {
+        const path = `/api/sync/blocks/${encodeURIComponent(blockId)}`;
+        const base = baseUrl.endsWith('/') ? baseUrl.slice(0, -1) : baseUrl;
+        if (poolId) {
+            return `${base}${path}?poolId=${encodeURIComponent(poolId)}`;
+        }
+        return `${base}${path}`;
+    }
+}
+exports.HttpBlockFetchTransport = HttpBlockFetchTransport;
+//# sourceMappingURL=httpBlockFetchTransport.js.map

package/src/lib/blockFetch/httpBlockFetchTransport.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"httpBlockFetchTransport.js","sourceRoot":"","sources":["../../../../../brightchain-api-lib/src/lib/blockFetch/httpBlockFetchTransport.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;GAUG;;;AAEH,kEAKsC;AAetC;;;GAGG;AACH,MAAa,sBAAsB;IACjC,YAA6B,aAAkC;QAAlC,kBAAa,GAAb,aAAa,CAAqB;IAAG,CAAC;IAE5D,cAAc,CAAC,MAAc;QAClC,OAAO,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IACxC,CAAC;CACF;AAND,wDAMC;AAED;;;;;;;;;;;GAWG;AACH,MAAa,uBAAuB;IAClC,YAA6B,eAAqC;QAArC,oBAAe,GAAf,eAAe,CAAsB;IAAG,CAAC;IAEtE;;;;;;;;OAQG;IACI,KAAK,CAAC,kBAAkB,CAC7B,MAAc,EACd,OAAe,EACf,MAAe;QAEf,MAAM,OAAO,GAAG,IAAI,CAAC,eAAe,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;QAC5D,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,MAAM,IAAI,iCAAe,CACvB,OAAO,EACP;gBACE;oBACE,MAAM;oBACN,KAAK,EAAE,4CAA4C,MAAM,GAAG;iBAC7D;aACF,EACD,sBAAsB,OAAO,0BAA0B,MAAM,GAAG,CACjE,CAAC;QACJ,CAAC;QAED,MAAM,GAAG,GAAG,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;QAEpD,IAAI,QAAkB,CAAC;QACvB,IAAI,CAAC;YACH,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,CAAC,CAAC;QAC9B,CAAC;QAAC,OAAO,KAAc,EAAE,CAAC;YACxB,MAAM,YAAY,GAChB,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YACzD,MAAM,IAAI,iCAAe,CACvB,OAAO,EACP,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,YAAY,EAAE,CAAC,EACjC,gCAAgC,OAAO,eAAe,MAAM,MAAM,YAAY,EAAE,CACjF,CAAC;QACJ,CAAC;QAED,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,MAAM,UAAU,GAAG,QAAQ,CAAC,UAAU,IAAI,QAAQ,QAAQ,CAAC,MAAM,EAAE,CAAC;YACpE,MAAM,IAAI,iCAAe,CACvB,OAAO,EACP,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,UAAU,KAAK,QAAQ,CAAC,MAAM,GAAG,EAAE,CAAC,EACzD,yBAAyB,OAAO,eAAe,MAAM,MAAM,UAAU,KAAK,QAAQ,CAAC,MAAM,GAAG,CAC7F,CAAC;QACJ,CAAC;QAED,IAAI,IAAwB,CAAC;QAC7B,IAAI,CAAC;YACH,IAAI,GAAG,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAuB,CAAC;QACvD,CAAC;QAAC,OAAO,KAAc,EAAE,CAAC;YACxB,MAAM,YAAY,GAChB,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YACzD,MAAM,IAAI,iCAAe,CACvB,OAAO,EACP,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,0BAA0B,YAAY,EAAE,EAAE,CAAC,EAC7D,+BAA+B,MAAM,eAAe,OAAO,KAAK,YAAY,EAAE,CAC/E,CAAC;QACJ,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;YACf,MAAM,IAAI,iCAAe,CACvB,OAAO,EACP,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,+BAA+B,EAAE,CAAC,EACpD,+BAA+B,MAAM,eAAe,OAAO,wBAAwB,CACpF,CAAC;QACJ,CAAC;QAED,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IAC1C,CAAC;IAED;;;OAGG;IACK,QAAQ,CAAC,OAAe,EAAE,OAAe,EAAE,MAAe;QAChE,MAAM,IAAI,GAAG,oBAAoB,kBAAkB,CAAC,OAAO,CAAC,EAAE,CAAC;QAC/D,MAAM,IAAI,GAAG,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC;QAEpE,IAAI,MAAM,EAAE,CAAC;YACX,OAAO,GAAG,IAAI,GAAG,IAAI,WAAW,kBAAkB,CAAC,MAAM,CAAC,EAAE,CAAC;QAC/D,CAAC;QAED,OAAO,GAAG,IAAI,GAAG,IAAI,EAAE,CAAC;IAC1B,CAAC;CACF;AA7FD,0DA6FC"}

package/src/lib/blockFetch/index.d.ts

@@ -0,0 +1,10 @@
+/**
+ * @fileoverview Block Fetch Module
+ *
+ * Exports the BlockFetcher and FetchQueue implementations for remote block
+ * retrieval with deduplication, concurrency control, and pool-scoped storage.
+ */
+export * from './blockFetcher';
+export * from './fetchQueue';
+export * from './httpBlockFetchTransport';
+//# sourceMappingURL=index.d.ts.map

package/src/lib/blockFetch/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../brightchain-api-lib/src/lib/blockFetch/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,cAAc,gBAAgB,CAAC;AAC/B,cAAc,cAAc,CAAC;AAC7B,cAAc,2BAA2B,CAAC"}

package/src/lib/blockFetch/index.js

@@ -0,0 +1,13 @@
+"use strict";
+/**
+ * @fileoverview Block Fetch Module
+ *
+ * Exports the BlockFetcher and FetchQueue implementations for remote block
+ * retrieval with deduplication, concurrency control, and pool-scoped storage.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./blockFetcher"), exports);
+tslib_1.__exportStar(require("./fetchQueue"), exports);
+tslib_1.__exportStar(require("./httpBlockFetchTransport"), exports);
+//# sourceMappingURL=index.js.map

package/src/lib/blockFetch/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../brightchain-api-lib/src/lib/blockFetch/index.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEH,yDAA+B;AAC/B,uDAA6B;AAC7B,oEAA0C"}

package/src/lib/controllers/api/brightpass.d.ts

@@ -0,0 +1,72 @@
+import { CoreLanguageCode } from '@digitaldefiance/i18n-lib';
+import { PlatformID } from '@digitaldefiance/node-ecies-lib';
+import { ApiErrorResponse, ApiRequestHandler, TypedHandlers } from '@digitaldefiance/node-express-suite';
+import { IBrightChainApplication } from '../../interfaces/application';
+import { DefaultBackendIdType } from '../../shared-types';
+import { BaseController } from '../base';
+interface IBrightPassDataResponse {
+    success: true;
+    data: Record<string, unknown>;
+    [key: string]: any;
+}
+type BrightPassApiResponse = IBrightPassDataResponse | ApiErrorResponse;
+interface BrightPassHandlers extends TypedHandlers {
+    createVault: ApiRequestHandler<BrightPassApiResponse>;
+    listVaults: ApiRequestHandler<BrightPassApiResponse>;
+    openVault: ApiRequestHandler<BrightPassApiResponse>;
+    deleteVault: ApiRequestHandler<BrightPassApiResponse>;
+    createEntry: ApiRequestHandler<BrightPassApiResponse>;
+    getEntry: ApiRequestHandler<BrightPassApiResponse>;
+    updateEntry: ApiRequestHandler<BrightPassApiResponse>;
+    deleteEntry: ApiRequestHandler<BrightPassApiResponse>;
+    searchEntries: ApiRequestHandler<BrightPassApiResponse>;
+    generatePassword: ApiRequestHandler<BrightPassApiResponse>;
+    generateTotp: ApiRequestHandler<BrightPassApiResponse>;
+    validateTotp: ApiRequestHandler<BrightPassApiResponse>;
+    breachCheck: ApiRequestHandler<BrightPassApiResponse>;
+    autofill: ApiRequestHandler<BrightPassApiResponse>;
+    getAuditLog: ApiRequestHandler<BrightPassApiResponse>;
+    shareVault: ApiRequestHandler<BrightPassApiResponse>;
+    revokeShare: ApiRequestHandler<BrightPassApiResponse>;
+    configureEmergencyAccess: ApiRequestHandler<BrightPassApiResponse>;
+    recoverWithShares: ApiRequestHandler<BrightPassApiResponse>;
+    importEntries: ApiRequestHandler<BrightPassApiResponse>;
+}
+/**
+ * BrightPassController — REST API for the BrightPass password manager.
+ *
+ * Provides endpoints for vault CRUD, entry CRUD, search, password generation,
+ * TOTP, breach detection, autofill, audit log, sharing, emergency access, and import.
+ *
+ * All routes require JWT authentication.
+ *
+ * @requirements 5.1–5.11
+ */
+export declare class BrightPassController<TID extends PlatformID = DefaultBackendIdType> extends BaseController<TID, BrightPassApiResponse, BrightPassHandlers, CoreLanguageCode> {
+    private brightPassService;
+    constructor(application: IBrightChainApplication<TID>);
+    private getAuthMemberId;
+    protected initRouteDefinitions(): void;
+    private handleCreateVault;
+    private handleListVaults;
+    private handleOpenVault;
+    private handleDeleteVault;
+    private handleCreateEntry;
+    private handleGetEntry;
+    private handleUpdateEntry;
+    private handleDeleteEntry;
+    private handleSearchEntries;
+    private handleGeneratePassword;
+    private handleGenerateTotp;
+    private handleValidateTotp;
+    private handleBreachCheck;
+    private handleAutofill;
+    private handleGetAuditLog;
+    private handleShareVault;
+    private handleRevokeShare;
+    private handleConfigureEmergencyAccess;
+    private handleRecoverWithShares;
+    private handleImportEntries;
+}
+export {};
+//# sourceMappingURL=brightpass.d.ts.map

package/src/lib/controllers/api/brightpass.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"brightpass.d.ts","sourceRoot":"","sources":["../../../../../../brightchain-api-lib/src/lib/controllers/api/brightpass.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAC7D,OAAO,EAAE,UAAU,EAAE,MAAM,iCAAiC,CAAC;AAC7D,OAAO,EACL,gBAAgB,EAChB,iBAAiB,EAEjB,aAAa,EAEd,MAAM,qCAAqC,CAAC;AAC7C,OAAO,EAAE,uBAAuB,EAAE,MAAM,8BAA8B,CAAC;AAQvE,OAAO,EAAE,oBAAoB,EAAE,MAAM,oBAAoB,CAAC;AAO1D,OAAO,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AAKzC,UAAU,uBAAuB;IAC/B,OAAO,EAAE,IAAI,CAAC;IACd,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC9B,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AAED,KAAK,qBAAqB,GAAG,uBAAuB,GAAG,gBAAgB,CAAC;AAIxE,UAAU,kBAAmB,SAAQ,aAAa;IAChD,WAAW,EAAE,iBAAiB,CAAC,qBAAqB,CAAC,CAAC;IACtD,UAAU,EAAE,iBAAiB,CAAC,qBAAqB,CAAC,CAAC;IACrD,SAAS,EAAE,iBAAiB,CAAC,qBAAqB,CAAC,CAAC;IACpD,WAAW,EAAE,iBAAiB,CAAC,qBAAqB,CAAC,CAAC;IACtD,WAAW,EAAE,iBAAiB,CAAC,qBAAqB,CAAC,CAAC;IACtD,QAAQ,EAAE,iBAAiB,CAAC,qBAAqB,CAAC,CAAC;IACnD,WAAW,EAAE,iBAAiB,CAAC,qBAAqB,CAAC,CAAC;IACtD,WAAW,EAAE,iBAAiB,CAAC,qBAAqB,CAAC,CAAC;IACtD,aAAa,EAAE,iBAAiB,CAAC,qBAAqB,CAAC,CAAC;IACxD,gBAAgB,EAAE,iBAAiB,CAAC,qBAAqB,CAAC,CAAC;IAC3D,YAAY,EAAE,iBAAiB,CAAC,qBAAqB,CAAC,CAAC;IACvD,YAAY,EAAE,iBAAiB,CAAC,qBAAqB,CAAC,CAAC;IACvD,WAAW,EAAE,iBAAiB,CAAC,qBAAqB,CAAC,CAAC;IACtD,QAAQ,EAAE,iBAAiB,CAAC,qBAAqB,CAAC,CAAC;IACnD,WAAW,EAAE,iBAAiB,CAAC,qBAAqB,CAAC,CAAC;IACtD,UAAU,EAAE,iBAAiB,CAAC,qBAAqB,CAAC,CAAC;IACrD,WAAW,EAAE,iBAAiB,CAAC,qBAAqB,CAAC,CAAC;IACtD,wBAAwB,EAAE,iBAAiB,CAAC,qBAAqB,CAAC,CAAC;IACnE,iBAAiB,EAAE,iBAAiB,CAAC,qBAAqB,CAAC,CAAC;IAC5D,aAAa,EAAE,iBAAiB,CAAC,qBAAqB,CAAC,CAAC;CACzD;AA6DD;;;;;;;;;GASG;AACH,qBAAa,oBAAoB,CAC/B,GAAG,SAAS,UAAU,GAAG,oBAAoB,CAC7C,SAAQ,cAAc,CACtB,GAAG,EACH,qBAAqB,EACrB,kBAAkB,EAClB,gBAAgB,CACjB;IACC,OAAO,CAAC,iBAAiB,CAAoB;gBAEjC,WAAW,EAAE,uBAAuB,CAAC,GAAG,CAAC;IAKrD,OAAO,CAAC,eAAe;IAgBvB,SAAS,CAAC,oBAAoB,IAAI,IAAI;IAmPtC,OAAO,CAAC,iBAAiB,CAoBvB;IAEF,OAAO,CAAC,gBAAgB,CAUtB;IAEF,OAAO,CAAC,eAAe,CAoBrB;IAEF,OAAO,CAAC,iBAAiB,CAoBvB;IAIF,OAAO,CAAC,iBAAiB,CAcvB;IAEF,OAAO,CAAC,cAAc,CAWpB;IAEF,OAAO,CAAC,iBAAiB,CAgBvB;IAEF,OAAO,CAAC,iBAAiB,CAWvB;IAEF,OAAO,CAAC,mBAAmB,CAcvB;IAIJ,OAAO,CAAC,sBAAsB,CAW1B;IAEJ,OAAO,CAAC,kBAAkB,CAaxB;IAEF,OAAO,CAAC,kBAAkB,CAiBxB;IAEF,OAAO,CAAC,iBAAiB,CAcvB;IAEF,OAAO,CAAC,cAAc,CAkBpB;IAEF,OAAO,CAAC,iBAAiB,CAUvB;IAIF,OAAO,CAAC,gBAAgB,CAkBtB;IAEF,OAAO,CAAC,iBAAiB,CAevB;IAIF,OAAO,CAAC,8BAA8B,CAwBlC;IAEJ,OAAO,CAAC,uBAAuB,CAmB3B;IAIJ,OAAO,CAAC,mBAAmB,CAuBvB;CACL"}