@brightchain/brightchain-api-lib 0.24.1 → 0.26.0

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

@@ -1,192 +1,3 @@
-import { IBlockStore, IQuorumService } from '@brightchain/brightchain-lib';
-import { HexString, IIdProvider, Member, PlatformID } from '@digitaldefiance/ecies-lib';
-import { DocumentCollection, DocumentId, DocumentRecord, DocumentStore, 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 DocumentStore {
-    private readonly blockStore;
-    private readonly quorumService?;
-    private readonly collections;
-    private readonly storeId;
-    private readonly generateId;
-    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>;
-}
-export {};
+export type { CreateDocumentOptions, RetrieveDocumentOptions, } from '@brightchain/node-express-suite';
+export { BlockDocumentStore, CollectionHeadRegistry, } from '@brightchain/node-express-suite';
 //# sourceMappingURL=block-document-store.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"block-document-store.d.ts","sourceRoot":"","sources":["../../../../../brightchain-api-lib/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,EACd,aAAa,EACb,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;AAED,qBAAa,kBAAkB,CAAC,GAAG,SAAS,UAAU,GAAG,UAAU,CACjE,YAAW,aAAa;IAUtB,OAAO,CAAC,QAAQ,CAAC,UAAU;IAC3B,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAC;IATjC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAGxB;IACJ,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAS;IACjC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAe;gBAGvB,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;CAkB3B"}
+{"version":3,"file":"block-document-store.d.ts","sourceRoot":"","sources":["../../../../../brightchain-api-lib/src/lib/datastore/block-document-store.ts"],"names":[],"mappings":"AACA,YAAY,EACV,qBAAqB,EACrB,uBAAuB,GACxB,MAAM,iCAAiC,CAAC;AACzC,OAAO,EACL,kBAAkB,EAClB,sBAAsB,GACvB,MAAM,iCAAiC,CAAC"}