@enbox/agent 0.0.1

package/dist/types/store-identity.d.ts

@@ -0,0 +1,34 @@
+import type { Web5PlatformAgent } from './types/agent.js';
+import type { IdentityMetadata } from './types/identity.js';
+import type { AgentDataStore, DataStoreDeleteParams, DataStoreGetParams, DataStoreListParams, DataStoreSetParams } from './store-data.js';
+import { DwnDataStore, InMemoryDataStore } from './store-data.js';
+export declare function isIdentityMetadata(obj: unknown): obj is IdentityMetadata;
+export declare class DwnIdentityStore extends DwnDataStore<IdentityMetadata> implements AgentDataStore<IdentityMetadata> {
+    protected name: string;
+    protected _recordProtocolDefinition: import("./types/dwn.js").DwnProtocolDefinition;
+    /**
+     * Properties to use when writing and querying Identity records with the DWN store.
+     */
+    protected _recordProperties: {
+        dataFormat: string;
+        protocol: string;
+        protocolPath: string;
+        schema: string | undefined;
+    };
+    delete(params: DataStoreDeleteParams): Promise<boolean>;
+    get(params: DataStoreGetParams): Promise<IdentityMetadata | undefined>;
+    set(params: DataStoreSetParams<IdentityMetadata>): Promise<void>;
+    list(params: DataStoreListParams): Promise<IdentityMetadata[]>;
+    protected getAllRecords({ agent, tenantDid }: {
+        agent: Web5PlatformAgent;
+        tenantDid: string;
+    }): Promise<IdentityMetadata[]>;
+}
+export declare class InMemoryIdentityStore extends InMemoryDataStore<IdentityMetadata> implements AgentDataStore<IdentityMetadata> {
+    protected name: string;
+    delete(params: DataStoreDeleteParams): Promise<boolean>;
+    get(params: DataStoreGetParams): Promise<IdentityMetadata | undefined>;
+    list(params: DataStoreListParams): Promise<IdentityMetadata[]>;
+    set(params: DataStoreSetParams<IdentityMetadata>): Promise<void>;
+}
+//# sourceMappingURL=store-identity.d.ts.map

package/dist/types/store-identity.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"store-identity.d.ts","sourceRoot":"","sources":["../../src/store-identity.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AAC1D,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAC5D,OAAO,KAAK,EAAE,cAAc,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,mBAAmB,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AAK1I,OAAO,EAAE,YAAY,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AAElE,wBAAgB,kBAAkB,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,gBAAgB,CAIxE;AAED,qBAAa,gBAAiB,SAAQ,YAAY,CAAC,gBAAgB,CAAE,YAAW,cAAc,CAAC,gBAAgB,CAAC;IAC9G,SAAS,CAAC,IAAI,SAAsB;IAEpC,SAAS,CAAC,yBAAyB,iDAA8B;IAEjE;;OAEG;IACH,SAAS,CAAC,iBAAiB;;;;;MAKzB;IAEW,MAAM,CAAC,MAAM,EAAE,qBAAqB,GAAG,OAAO,CAAC,OAAO,CAAC;IAIvD,GAAG,CAAC,MAAM,EAAE,kBAAkB,GAAG,OAAO,CAAC,gBAAgB,GAAG,SAAS,CAAC;IAItE,GAAG,CAAC,MAAM,EAAE,kBAAkB,CAAC,gBAAgB,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAIhE,IAAI,CAAC,MAAM,EAAE,mBAAmB,GAAG,OAAO,CAAC,gBAAgB,EAAE,CAAC;cAI3D,aAAa,CAAC,EAAE,KAAK,EAAE,SAAS,EAAE,EAAE;QAClD,KAAK,EAAE,iBAAiB,CAAC;QACzB,SAAS,EAAE,MAAM,CAAC;KACnB,GAAG,OAAO,CAAC,gBAAgB,EAAE,CAAC;CAqChC;AAED,qBAAa,qBAAsB,SAAQ,iBAAiB,CAAC,gBAAgB,CAAE,YAAW,cAAc,CAAC,gBAAgB,CAAC;IACxH,SAAS,CAAC,IAAI,SAA2B;IAE5B,MAAM,CAAC,MAAM,EAAE,qBAAqB,GAAG,OAAO,CAAC,OAAO,CAAC;IAIvD,GAAG,CAAC,MAAM,EAAE,kBAAkB,GAAG,OAAO,CAAC,gBAAgB,GAAG,SAAS,CAAC;IAItE,IAAI,CAAC,MAAM,EAAE,mBAAmB,GAAG,OAAO,CAAC,gBAAgB,EAAE,CAAC;IAI9D,GAAG,CAAC,MAAM,EAAE,kBAAkB,CAAC,gBAAgB,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;CAG9E"}

package/dist/types/store-key.d.ts

@@ -0,0 +1,32 @@
+import type { Jwk } from '@enbox/crypto';
+import type { Web5PlatformAgent } from './types/agent.js';
+import { AgentDataStore, DataStoreDeleteParams, DataStoreGetParams, DataStoreListParams, DataStoreSetParams, DwnDataStore, InMemoryDataStore } from './store-data.js';
+export declare class DwnKeyStore extends DwnDataStore<Jwk> implements AgentDataStore<Jwk> {
+    protected name: string;
+    protected _recordProtocolDefinition: import("./types/dwn.js").DwnProtocolDefinition;
+    /**
+     * Properties to use when writing and querying Private Key records with the DWN store.
+     */
+    protected _recordProperties: {
+        dataFormat: string;
+        protocol: string;
+        protocolPath: string;
+        schema: string | undefined;
+    };
+    delete(params: DataStoreDeleteParams): Promise<boolean>;
+    get(params: DataStoreGetParams): Promise<Jwk | undefined>;
+    set(params: DataStoreSetParams<Jwk>): Promise<void>;
+    list(params: DataStoreListParams): Promise<Jwk[]>;
+    protected getAllRecords({ agent, tenantDid }: {
+        agent: Web5PlatformAgent;
+        tenantDid: string;
+    }): Promise<Jwk[]>;
+}
+export declare class InMemoryKeyStore extends InMemoryDataStore<Jwk> implements AgentDataStore<Jwk> {
+    protected name: string;
+    delete(params: DataStoreDeleteParams): Promise<boolean>;
+    get(params: DataStoreGetParams): Promise<Jwk | undefined>;
+    list(params: DataStoreListParams): Promise<Jwk[]>;
+    set(params: DataStoreSetParams<Jwk>): Promise<void>;
+}
+//# sourceMappingURL=store-key.d.ts.map

package/dist/types/store-key.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"store-key.d.ts","sourceRoot":"","sources":["../../src/store-key.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,eAAe,CAAC;AAKzC,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AAK1D,OAAO,EAAE,cAAc,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,mBAAmB,EAAE,kBAAkB,EAAE,YAAY,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AAEtK,qBAAa,WAAY,SAAQ,YAAY,CAAC,GAAG,CAAE,YAAW,cAAc,CAAC,GAAG,CAAC;IAC/E,SAAS,CAAC,IAAI,SAAiB;IAE/B,SAAS,CAAC,yBAAyB,iDAAyB;IAE5D;;OAEG;IACH,SAAS,CAAC,iBAAiB;;;;;MAKzB;IAEW,MAAM,CAAC,MAAM,EAAE,qBAAqB,GAAG,OAAO,CAAC,OAAO,CAAC;IAIvD,GAAG,CAAC,MAAM,EAAE,kBAAkB,GAAG,OAAO,CAAC,GAAG,GAAG,SAAS,CAAC;IAIzD,GAAG,CAAC,MAAM,EAAE,kBAAkB,CAAC,GAAG,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAInD,IAAI,CAAC,MAAM,EAAE,mBAAmB,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC;cAI9C,aAAa,CAAC,EAAE,KAAK,EAAE,SAAS,EAAE,EAAE;QAClD,KAAK,EAAE,iBAAiB,CAAC;QACzB,SAAS,EAAE,MAAM,CAAC;KACnB,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC;CAqCnB;AAED,qBAAa,gBAAiB,SAAQ,iBAAiB,CAAC,GAAG,CAAE,YAAW,cAAc,CAAC,GAAG,CAAC;IACzF,SAAS,CAAC,IAAI,SAAsB;IAEvB,MAAM,CAAC,MAAM,EAAE,qBAAqB,GAAG,OAAO,CAAC,OAAO,CAAC;IAIvD,GAAG,CAAC,MAAM,EAAE,kBAAkB,GAAG,OAAO,CAAC,GAAG,GAAG,SAAS,CAAC;IAIzD,IAAI,CAAC,MAAM,EAAE,mBAAmB,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC;IAIjD,GAAG,CAAC,MAAM,EAAE,kBAAkB,CAAC,GAAG,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;CAGjE"}

package/dist/types/sync-api.d.ts

@@ -0,0 +1,41 @@
+import type { SyncEngine, SyncIdentityOptions } from './types/sync.js';
+import type { Web5PlatformAgent } from './types/agent.js';
+export type SyncApiParams = {
+    agent?: Web5PlatformAgent;
+    syncEngine: SyncEngine;
+};
+export declare class AgentSyncApi implements SyncEngine {
+    /**
+     * Holds the instance of a `Web5PlatformAgent` that represents the current execution context for
+     * the `AgentSyncApi`. This agent is used to interact with other Web5 agent components. It's vital
+     * to ensure this instance is set to correctly contextualize operations within the broader Web5
+     * Agent framework.
+     */
+    private _agent?;
+    private _syncEngine;
+    constructor({ agent, syncEngine }: SyncApiParams);
+    /**
+     * Retrieves the `Web5PlatformAgent` execution context.
+     *
+     * @returns The `Web5PlatformAgent` instance that represents the current execution context.
+     * @throws Will throw an error if the `agent` instance property is undefined.
+     */
+    get agent(): Web5PlatformAgent;
+    set agent(agent: Web5PlatformAgent);
+    registerIdentity(params: {
+        did: string;
+        options?: SyncIdentityOptions;
+    }): Promise<void>;
+    unregisterIdentity(did: string): Promise<void>;
+    getIdentityOptions(did: string): Promise<SyncIdentityOptions | undefined>;
+    updateIdentityOptions(params: {
+        did: string;
+        options: SyncIdentityOptions;
+    }): Promise<void>;
+    sync(direction?: 'push' | 'pull'): Promise<void>;
+    startSync(params: {
+        interval: string;
+    }): Promise<void>;
+    stopSync(timeout?: number): Promise<void>;
+}
+//# sourceMappingURL=sync-api.d.ts.map

package/dist/types/sync-api.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sync-api.d.ts","sourceRoot":"","sources":["../../src/sync-api.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAC;AACvE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AAE1D,MAAM,MAAM,aAAa,GAAG;IAC1B,KAAK,CAAC,EAAE,iBAAiB,CAAC;IAC1B,UAAU,EAAE,UAAU,CAAC;CACxB,CAAA;AAED,qBAAa,YAAa,YAAW,UAAU;IAC7C;;;;;OAKG;IACH,OAAO,CAAC,MAAM,CAAC,CAAoB;IAEnC,OAAO,CAAC,WAAW,CAAa;gBAEpB,EAAE,KAAK,EAAE,UAAU,EAAE,EAAE,aAAa;IAKhD;;;;;OAKG;IACH,IAAI,KAAK,IAAI,iBAAiB,CAM7B;IAED,IAAI,KAAK,CAAC,KAAK,EAAE,iBAAiB,EAGjC;IAEY,gBAAgB,CAAC,MAAM,EAAE;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,mBAAmB,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAIvF,kBAAkB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAI9C,kBAAkB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,GAAG,SAAS,CAAC;IAIzE,qBAAqB,CAAC,MAAM,EAAE;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,mBAAmB,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAIjG,IAAI,CAAC,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIhD,SAAS,CAAC,MAAM,EAAE;QAAE,QAAQ,EAAE,MAAM,CAAC;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAIvD,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAGjD"}

package/dist/types/sync-engine-level.d.ts

@@ -0,0 +1,85 @@
+/// <reference types="node" resolution-mode="require"/>
+import type { AbstractLevel } from 'abstract-level';
+import type { SyncEngine, SyncIdentityOptions } from './types/sync.js';
+import type { Web5PlatformAgent } from './types/agent.js';
+export type SyncEngineLevelParams = {
+    agent?: Web5PlatformAgent;
+    dataPath?: string;
+    db?: AbstractLevel<string | Buffer | Uint8Array>;
+};
+export declare class SyncEngineLevel implements SyncEngine {
+    /**
+     * Holds the instance of a `Web5PlatformAgent` that represents the current execution context for
+     * the `SyncEngineLevel`. This agent is used to interact with other Web5 agent components. It's
+     * vital to ensure this instance is set to correctly contextualize operations within the broader
+     * Web5 Agent framework.
+     */
+    private _agent?;
+    /**
+     * An instance of the `AgentPermissionsApi` that is used to interact with permissions grants used during sync
+     */
+    private _permissionsApi;
+    private _db;
+    private _syncIntervalId?;
+    private _syncLock;
+    private _ulidFactory;
+    constructor({ agent, dataPath, db }: SyncEngineLevelParams);
+    /**
+     * Retrieves the `Web5PlatformAgent` execution context.
+     *
+     * @returns The `Web5PlatformAgent` instance that represents the current execution context.
+     * @throws Will throw an error if the `agent` instance property is undefined.
+     */
+    get agent(): Web5PlatformAgent;
+    set agent(agent: Web5PlatformAgent);
+    clear(): Promise<void>;
+    close(): Promise<void>;
+    private pull;
+    private push;
+    registerIdentity({ did, options }: {
+        did: string;
+        options?: SyncIdentityOptions;
+    }): Promise<void>;
+    unregisterIdentity(did: string): Promise<void>;
+    getIdentityOptions(did: string): Promise<SyncIdentityOptions | undefined>;
+    updateIdentityOptions({ did, options }: {
+        did: string;
+        options: SyncIdentityOptions;
+    }): Promise<void>;
+    sync(direction?: 'push' | 'pull'): Promise<void>;
+    startSync({ interval }: {
+        interval: string;
+    }): Promise<void>;
+    /**
+     * stopSync currently awaits the completion of the current sync operation before stopping the sync interval.
+     * TODO: implement a signal to gracefully stop sync immediately https://github.com/TBD54566975/web5-js/issues/890
+     */
+    stopSync(timeout?: number): Promise<void>;
+    /**
+     * 202: message was successfully written to the remote DWN
+     * 204: an initial write message was written without any data, cannot yet be read until a subsequent message is written with data
+     * 409: message was already present on the remote DWN
+     * RecordsDelete and the status code is 404: the initial write message was not found or the message was already deleted
+     */
+    private static syncMessageReplyIsSuccessful;
+    private enqueueOperations;
+    private static generateSyncMessageParamsKey;
+    private static parseSyncMessageParamsKey;
+    private getDwnEventLog;
+    private getDwnMessage;
+    private getSyncPeerState;
+    private getCursor;
+    private setCursor;
+    /**
+     * The message store is used to prevent "echoes" that occur during a sync pull operation.
+     * After a message is confirmed to already be synchronized on the local DWN, its CID is added
+     * to the message store to ensure that any subsequent pull attempts are skipped.
+     */
+    private messageExists;
+    private addMessage;
+    private getMessageStore;
+    private getCursorStore;
+    private getPushQueue;
+    private getPullQueue;
+}
+//# sourceMappingURL=sync-engine-level.d.ts.map

package/dist/types/sync-engine-level.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sync-engine-level.d.ts","sourceRoot":"","sources":["../../src/sync-engine-level.ts"],"names":[],"mappings":";AACA,OAAO,KAAK,EAA0B,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAkB5E,OAAO,KAAK,EAAE,UAAU,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAC;AACvE,OAAO,KAAK,EAAa,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AAOrE,MAAM,MAAM,qBAAqB,GAAG;IAClC,KAAK,CAAC,EAAE,iBAAiB,CAAC;IAC1B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,EAAE,CAAC,EAAE,aAAa,CAAC,MAAM,GAAG,MAAM,GAAG,UAAU,CAAC,CAAC;CAClD,CAAA;AAwBD,qBAAa,eAAgB,YAAW,UAAU;IAChD;;;;;OAKG;IACH,OAAO,CAAC,MAAM,CAAC,CAAoB;IAEnC;;OAEG;IACH,OAAO,CAAC,eAAe,CAAiB;IAExC,OAAO,CAAC,GAAG,CAA8C;IACzD,OAAO,CAAC,eAAe,CAAC,CAAiC;IACzD,OAAO,CAAC,SAAS,CAAS;IAC1B,OAAO,CAAC,YAAY,CAAc;gBAEtB,EAAE,KAAK,EAAE,QAAQ,EAAE,EAAE,EAAE,EAAE,qBAAqB;IAO1D;;;;;OAKG;IACH,IAAI,KAAK,IAAI,iBAAiB,CAM7B;IAED,IAAI,KAAK,CAAC,KAAK,EAAE,iBAAiB,EAGjC;IAEY,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAKtB,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;YAIrB,IAAI;YA6FJ,IAAI;IAqDL,gBAAgB,CAAC,EAAE,GAAG,EAAE,OAAO,EAAE,EAAE;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,mBAAmB,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAgBjG,kBAAkB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAU9C,kBAAkB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,GAAG,SAAS,CAAC;IAkBzE,qBAAqB,CAAC,EAAE,GAAG,EAAE,OAAO,EAAE,EAAE;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,mBAAmB,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAUrG,IAAI,CAAC,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAkBhD,SAAS,CAAC,EAAE,QAAQ,EAAE,EAAE;QACnC,QAAQ,EAAE,MAAM,CAAA;KACjB,GAAG,OAAO,CAAC,IAAI,CAAC;IAoCjB;;;OAGG;IACU,QAAQ,CAAC,OAAO,GAAE,MAAa,GAAG,OAAO,CAAC,IAAI,CAAC;IAkB5D;;;;;OAKG;IACH,OAAO,CAAC,MAAM,CAAC,4BAA4B;YAe7B,iBAAiB;IA6C/B,OAAO,CAAC,MAAM,CAAC,4BAA4B;IAW3C,OAAO,CAAC,MAAM,CAAC,yBAAyB;YAU1B,cAAc;YAwEd,aAAa;YAsDb,gBAAgB;YA6ChB,SAAS;YAoBT,SAAS;IAOvB;;;;OAIG;YACW,aAAa;YAeb,UAAU;IAMxB,OAAO,CAAC,eAAe;IAIvB,OAAO,CAAC,cAAc;IAItB,OAAO,CAAC,YAAY;IAIpB,OAAO,CAAC,YAAY;CAGrB"}

package/dist/types/test-harness.d.ts

@@ -0,0 +1,69 @@
+/// <reference types="node" resolution-mode="require"/>
+import type { KeyValueStore } from '@enbox/common';
+import type { AbstractLevel } from 'abstract-level';
+import { DataStoreLevel, Dwn, EventLogLevel, MessageStoreLevel, ResumableTaskStoreLevel } from '@enbox/dwn-sdk-js';
+import { DidResolverCache } from '@enbox/dids';
+import type { Web5PlatformAgent } from './types/agent.js';
+import { BearerIdentity } from './bearer-identity.js';
+import { LocalKeyManager } from './local-key-manager.js';
+import { DwnDidStore } from './store-did.js';
+import { DwnKeyStore } from './store-key.js';
+import { DwnIdentityStore } from './store-identity.js';
+type PlatformAgentTestHarnessParams = {
+    agent: Web5PlatformAgent<LocalKeyManager>;
+    agentStores: 'dwn' | 'memory';
+    didResolverCache: DidResolverCache;
+    dwn: Dwn;
+    dwnDataStore: DataStoreLevel;
+    dwnEventLog: EventLogLevel;
+    dwnMessageStore: MessageStoreLevel;
+    dwnResumableTaskStore: ResumableTaskStoreLevel;
+    syncStore: AbstractLevel<string | Buffer | Uint8Array>;
+    vaultStore: KeyValueStore<string, string>;
+    dwnStores: {
+        keyStore: DwnKeyStore;
+        identityStore: DwnIdentityStore;
+        didStore: DwnDidStore;
+        clear: () => void;
+    };
+};
+export declare class PlatformAgentTestHarness {
+    agent: Web5PlatformAgent<LocalKeyManager>;
+    agentStores: 'dwn' | 'memory';
+    didResolverCache: DidResolverCache;
+    dwn: Dwn;
+    dwnDataStore: DataStoreLevel;
+    dwnEventLog: EventLogLevel;
+    dwnMessageStore: MessageStoreLevel;
+    dwnResumableTaskStore: ResumableTaskStoreLevel;
+    syncStore: AbstractLevel<string | Buffer | Uint8Array>;
+    vaultStore: KeyValueStore<string, string>;
+    /**
+     * Custom DWN Stores for `keyStore`, `identityStore` and `didStore`.
+     * This allows us to clear the store cache between tests
+     */
+    dwnStores: {
+        keyStore: DwnKeyStore;
+        identityStore: DwnIdentityStore;
+        didStore: DwnDidStore;
+        /** clears the protocol initialization caches */
+        clear: () => void;
+    };
+    constructor(params: PlatformAgentTestHarnessParams);
+    clearStorage(): Promise<void>;
+    closeStorage(): Promise<void>;
+    createAgentDid(): Promise<void>;
+    createIdentity({ name, testDwnUrls }: {
+        name: string;
+        testDwnUrls: string[];
+    }): Promise<BearerIdentity>;
+    static setup({ agentClass, agentStores, testDataLocation }: {
+        agentClass: new (params: any) => Web5PlatformAgent<LocalKeyManager>;
+        agentStores?: 'dwn' | 'memory';
+        testDataLocation?: string;
+    }): Promise<PlatformAgentTestHarness>;
+    private static useDiskStores;
+    private static useMemoryStores;
+}
+export {};
+//# sourceMappingURL=test-harness.d.ts.map

package/dist/types/test-harness.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"test-harness.d.ts","sourceRoot":"","sources":["../../src/test-harness.ts"],"names":[],"mappings":";AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AACnD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAIpD,OAAO,EAAE,cAAc,EAAE,GAAG,EAAsB,aAAa,EAAE,iBAAiB,EAAE,uBAAuB,EAAE,MAAM,mBAAmB,CAAC;AACvI,OAAO,EAAuC,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAEpF,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AAS1D,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AAEtD,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAEzD,OAAO,EAAE,WAAW,EAAoB,MAAM,gBAAgB,CAAC;AAC/D,OAAO,EAAE,WAAW,EAAoB,MAAM,gBAAgB,CAAC;AAC/D,OAAO,EAAE,gBAAgB,EAAyB,MAAM,qBAAqB,CAAC;AAI9E,KAAK,8BAA8B,GAAG;IACpC,KAAK,EAAE,iBAAiB,CAAC,eAAe,CAAC,CAAA;IAEzC,WAAW,EAAE,KAAK,GAAG,QAAQ,CAAC;IAC9B,gBAAgB,EAAE,gBAAgB,CAAC;IACnC,GAAG,EAAE,GAAG,CAAC;IACT,YAAY,EAAE,cAAc,CAAC;IAC7B,WAAW,EAAE,aAAa,CAAC;IAC3B,eAAe,EAAE,iBAAiB,CAAC;IACnC,qBAAqB,EAAE,uBAAuB,CAAC;IAC/C,SAAS,EAAE,aAAa,CAAC,MAAM,GAAG,MAAM,GAAG,UAAU,CAAC,CAAC;IACvD,UAAU,EAAE,aAAa,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC1C,SAAS,EAAE;QACT,QAAQ,EAAE,WAAW,CAAC;QACtB,aAAa,EAAE,gBAAgB,CAAC;QAChC,QAAQ,EAAE,WAAW,CAAC;QACtB,KAAK,EAAE,MAAM,IAAI,CAAC;KACnB,CAAA;CACF,CAAA;AAED,qBAAa,wBAAwB;IAC5B,KAAK,EAAE,iBAAiB,CAAC,eAAe,CAAC,CAAC;IAE1C,WAAW,EAAE,KAAK,GAAG,QAAQ,CAAC;IAC9B,gBAAgB,EAAE,gBAAgB,CAAC;IACnC,GAAG,EAAE,GAAG,CAAC;IACT,YAAY,EAAE,cAAc,CAAC;IAC7B,WAAW,EAAE,aAAa,CAAC;IAC3B,eAAe,EAAE,iBAAiB,CAAC;IACnC,qBAAqB,EAAE,uBAAuB,CAAC;IAC/C,SAAS,EAAE,aAAa,CAAC,MAAM,GAAG,MAAM,GAAG,UAAU,CAAC,CAAC;IACvD,UAAU,EAAE,aAAa,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAEjD;;;OAGG;IACI,SAAS,EAAE;QAChB,QAAQ,EAAE,WAAW,CAAC;QACtB,aAAa,EAAE,gBAAgB,CAAC;QAChC,QAAQ,EAAE,WAAW,CAAC;QACtB,gDAAgD;QAChD,KAAK,EAAE,MAAM,IAAI,CAAC;KACnB,CAAC;gBAEU,MAAM,EAAE,8BAA8B;IAcrC,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC;IAkC7B,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC;IAU7B,cAAc,IAAI,OAAO,CAAC,IAAI,CAAC;IAO/B,cAAc,CAAC,EAAE,IAAI,EAAE,WAAW,EAAE,EAAE;QACjD,IAAI,EAAE,MAAM,CAAC;QACb,WAAW,EAAE,MAAM,EAAE,CAAC;KACvB,GAAG,OAAO,CAAC,cAAc,CAAC;WAgCP,KAAK,CAAC,EAAE,UAAU,EAAE,WAAW,EAAE,gBAAgB,EAAE,EAAE;QACrE,UAAU,EAAE,KAAK,MAAM,EAAE,GAAG,KAAK,iBAAiB,CAAC,eAAe,CAAC,CAAA;QACnE,WAAW,CAAC,EAAE,KAAK,GAAG,QAAQ,CAAC;QAC/B,gBAAgB,CAAC,EAAE,MAAM,CAAC;KAC3B,GAAG,OAAO,CAAC,wBAAwB,CAAC;IA8FvC,OAAO,CAAC,MAAM,CAAC,aAAa;IAqC5B,OAAO,CAAC,MAAM,CAAC,eAAe;CAsB/B"}

package/dist/types/types/agent.d.ts

@@ -0,0 +1,172 @@
+import type { BearerDid } from '@enbox/dids';
+import type { Web5Rpc } from '../rpc-client.js';
+import type { AgentDwnApi } from '../dwn-api.js';
+import type { AgentSyncApi } from '../sync-api.js';
+import type { AgentCryptoApi } from '../crypto-api.js';
+import type { AgentKeyManager } from './key-manager.js';
+import type { IdentityVault } from './identity-vault.js';
+import type { AgentIdentityApi } from '../identity-api.js';
+import type { AgentPermissionsApi } from '../permissions-api.js';
+import type { ProcessVcRequest, SendVcRequest, VcResponse } from './vc.js';
+import type { AgentDidApi, DidInterface, DidRequest, DidResponse } from '../did-api.js';
+import type { DwnInterface, DwnResponse, ProcessDwnRequest, SendDwnRequest } from './dwn.js';
+/**
+ * Defines the structure for response status in the context of an Agent's interaction within the
+ * Web5 framework.
+ *
+ * This type is utilized to convey the success or failure of an operation performed by the Agent,
+ * providing feedback that can be programmatically interpreted and acted upon.
+ *
+ * This standardized response structure ensures a consistent interface for handling operation
+ * outcomes, enabling clear communication of success or error states along with actionable insights
+ * when necessary.
+ */
+export type ResponseStatus = {
+    /**
+     * A boolean value indicating the overall success (`true`) or failure (`false`) of the operation.
+     * - `true`: Indicates that the operation was successful without errors.
+     * - `false`: Indicates that the operation failed, with the error details provided in the `status`
+     *            object.
+     */
+    ok: boolean;
+    status: {
+        /**
+         * A numerical code representing the specific outcome of the operation.
+         *
+         * This can be aligned with standard HTTP status codes for web-based operations or custom codes
+         * for specific business logic.
+         */
+        code: number;
+        /**
+         * A descriptive message corresponding to the status code that provides additional information
+         * about the operation's result.
+         *
+         * This message is particularly useful for logging, debugging, or displaying contextual messages
+         * to the end-user, offering insights into why an operation succeeded or failed.
+         */
+        message: string;
+    };
+};
+/**
+ * Defines the interface for a Web5 Agent, encapsulating the core functionality all implementations
+ * must include.
+ *
+ * The Agent is responsible for handling decentralized identifier (DID) requests, decentralized web
+ * node (DWN) requests, and verifiable credential (VC) requests.
+ *
+ * The `AgentDid` property represents the Web5 Agent's own DID, while the various process and send
+ * methods enable the Agent to handle and initiate requests pertaining to DIDs, DWNs, and VCs.
+ */
+export interface Web5Agent {
+    /**
+     * The Decentralized Identifier (DID) of this Web5 Agent.
+     */
+    agentDid: BearerDid;
+    /**
+     * Processes a DID request, handling it internally within the agent and returning a DID response,
+     * typically involving operations like DID creation or resolution.
+     */
+    processDidRequest<T extends DidInterface>(request: DidRequest<T>): Promise<DidResponse<T>>;
+    /**
+     * Sends a DID request to another entity or service, expecting a DID response, often used for
+     * interactions involving DIDs occurring over a network or between different agents.
+     */
+    sendDidRequest<T extends DidInterface>(request: DidRequest<T>): Promise<DidResponse<T>>;
+    /**
+     * Processes a request related to a Decentralized Web Node (DWN) and returns a corresponding
+     * response.
+     */
+    processDwnRequest<T extends DwnInterface>(request: ProcessDwnRequest<T>): Promise<DwnResponse<T>>;
+    /**
+     * Sends a request to a Decentralized Web Node (DWN) and awaits a response, often used for
+     * interactions involving DWNs occurring over a network or between different agents.
+     */
+    sendDwnRequest<T extends DwnInterface>(request: SendDwnRequest<T>): Promise<DwnResponse<T>>;
+    /**
+     * Processes a request for handling Verifiable Credentials (VCs), such as issuing or verifying
+     * them, and returns a response indicating the outcome.
+     */
+    processVcRequest(request: ProcessVcRequest): Promise<VcResponse>;
+    /**
+     * Sends a request to issue, verify, or manage Verifiable Credentials (VCs), expecting a response
+     * that indicates the result of the operation. This method is often used for interactions
+     * involving VCs occurring over a network or between different agents.
+     */
+    sendVcRequest(request: SendVcRequest): Promise<VcResponse>;
+}
+/**
+ * Represents a Web5 Platform Agent, an extended and more feature-rich implementation of a
+ * {@link Web5Agent}.
+ *
+ * This Agent integrates a comprehensive set of APIs and functionalities, including cryptographic
+ * operations, DID management, DWN interaction, identity handling, and data synchronization.
+ *
+ * The platform agent provides a higher-level abstraction over the core Web5Agent functionalities,
+ * facilitating a robust platform for developing Web5 applications. It includes lifecycle management
+ * methods like initialization and startup, alongside a suite of specialized APIs and utilities.
+ *
+ * @typeParam TKeyManager - The type of Key Manager used to manage cryptographic keys.
+ */
+export interface Web5PlatformAgent<TKeyManager extends AgentKeyManager = AgentKeyManager> extends Web5Agent {
+    /**
+     * The cryptography API, essential for performing various cryptographic operations such
+     * as encryption, decryption, signing, and verification, ensuring secure data handling and
+     * communication within the Web5 Platform.
+     */
+    crypto: AgentCryptoApi;
+    /**
+     * The DID API, responsible for managing all DID-related functionalities, enabling the agent to
+     * create, resolve, update, and manage DIDs.
+     */
+    did: AgentDidApi<TKeyManager>;
+    /**
+     * The DWN API, enabling the Agent to interact with Decentralized Web Nodes (DWNs) and handle
+     * requests from Web5 applications.
+     */
+    dwn: AgentDwnApi;
+    /**
+     * The identity management API, handling identity-related operations and allowing the agent to
+     * manage Web5 identities, supporting operations like identity creation and update.
+     */
+    identity: AgentIdentityApi<TKeyManager>;
+    /**
+     * The Key Manager instance, central to the agent's cryptographic operations, managing key
+     * generation, storage, retrieval, and usage, ensuring secure cryptographic practices.
+     */
+    keyManager: TKeyManager;
+    /**
+     * The Permissions API, handling permission operations such as request, create, revocation, fetching and verifying revocation status.
+     */
+    permissions: AgentPermissionsApi;
+    /**
+     * The RPC (Remote Procedure Call) client interface, facilitating communication with other Web5
+     * Agents and services.
+     */
+    rpc: Web5Rpc;
+    /**
+     * The synchronization API, responsible for managing the consistency and real-time update of the
+     * agent's data with the state of the distributed network.
+     */
+    sync: AgentSyncApi;
+    /**
+     * An instance of {@link IdentityVault}, providing secure storage and management of a Web5 Agent's
+     * DID and cryptographic keys.
+     */
+    vault: IdentityVault;
+    /**
+     * Determines if it's the first time the Agent is being launched, typically used for initialization
+     * checks or first-time setup routines.
+     */
+    firstLaunch(): Promise<boolean>;
+    /**
+     * Initializes the agent with essential parameters (e.g., a passphrase) and prepares it for
+     * processing Web5 requests.
+     */
+    initialize(params: unknown): Promise<unknown>;
+    /**
+     * Starts the agent with the provided parameters, typically following initialization, to begin
+     * normal operation and readiness to process requests.
+     */
+    start(params: unknown): Promise<unknown>;
+}
+//# sourceMappingURL=agent.d.ts.map

package/dist/types/types/agent.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"agent.d.ts","sourceRoot":"","sources":["../../../src/types/agent.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAE7C,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAChD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AACjD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AACnD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AACvD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AACxD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACzD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAC3D,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AACjE,OAAO,KAAK,EAAE,gBAAgB,EAAE,aAAa,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AAC3E,OAAO,KAAK,EAAE,WAAW,EAAE,YAAY,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AACxF,OAAO,KAAK,EAAE,YAAY,EAAE,WAAW,EAAE,iBAAiB,EAAE,cAAc,EAAE,MAAM,UAAU,CAAC;AAG7F;;;;;;;;;;GAUG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B;;;;;OAKG;IACH,EAAE,EAAE,OAAO,CAAC;IAEZ,MAAM,EAAE;QACN;;;;;WAKG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;;;;;WAMG;QACH,OAAO,EAAE,MAAM,CAAC;KACjB,CAAC;CACH,CAAC;AAEF;;;;;;;;;GASG;AACH,MAAM,WAAW,SAAS;IACxB;;OAEG;IACH,QAAQ,EAAE,SAAS,CAAC;IAEpB;;;OAGG;IACH,iBAAiB,CAAC,CAAC,SAAS,YAAY,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAA;IAE1F;;;OAGG;IACH,cAAc,CAAC,CAAC,SAAS,YAAY,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC;IAExF;;;OAGG;IACH,iBAAiB,CAAC,CAAC,SAAS,YAAY,EAAE,OAAO,EAAE,iBAAiB,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAA;IAEjG;;;OAGG;IACH,cAAc,CAAC,CAAC,SAAS,YAAY,EAAE,OAAO,EAAE,cAAc,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC;IAE5F;;;OAGG;IACH,gBAAgB,CAAC,OAAO,EAAE,gBAAgB,GAAG,OAAO,CAAC,UAAU,CAAC,CAAA;IAEhE;;;;OAIG;IACH,aAAa,CAAC,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;CAC5D;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,WAAW,iBAAiB,CAAC,WAAW,SAAS,eAAe,GAAG,eAAe,CAAE,SAAQ,SAAS;IACzG;;;;OAIG;IACH,MAAM,EAAE,cAAc,CAAC;IAEvB;;;OAGG;IACH,GAAG,EAAE,WAAW,CAAC,WAAW,CAAC,CAAC;IAE9B;;;OAGG;IACH,GAAG,EAAE,WAAW,CAAC;IAEjB;;;OAGG;IACH,QAAQ,EAAE,gBAAgB,CAAC,WAAW,CAAC,CAAC;IAExC;;;OAGG;IACH,UAAU,EAAE,WAAW,CAAC;IAExB;;OAEG;IACH,WAAW,EAAE,mBAAmB,CAAC;IAEjC;;;OAGG;IACH,GAAG,EAAE,OAAO,CAAC;IAEb;;;OAGG;IACH,IAAI,EAAE,YAAY,CAAC;IAEnB;;;OAGG;IACH,KAAK,EAAE,aAAa,CAAC;IAErB;;;OAGG;IACH,WAAW,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC;IAEhC;;;OAGG;IACH,UAAU,CAAC,MAAM,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAE9C;;;OAGG;IACH,KAAK,CAAC,MAAM,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;CAC1C"}

package/dist/types/types/dwn.d.ts

@@ -0,0 +1,178 @@
+import type { DidService } from '@enbox/dids';
+import type { Readable, RequireOnly } from '@enbox/common';
+import type { RecordsReadReply, RecordsQueryReply, RecordsReadMessage, RecordsReadOptions, GenericMessageReply, ProtocolsQueryReply, RecordsQueryMessage, RecordsQueryOptions, RecordsWriteMessage, RecordsWriteOptions, RecordsDeleteMessage, RecordsDeleteOptions, ProtocolsQueryMessage, ProtocolsQueryOptions, ProtocolsConfigureMessage, ProtocolsConfigureOptions, RecordsSubscribeMessage, RecordsSubscribeOptions, RecordsSubscribeReply, MessageSubscriptionHandler, RecordSubscriptionHandler, MessagesQueryMessage, MessagesReadMessage, MessagesSubscribeMessage, MessagesQueryOptions, MessagesReadOptions, MessagesSubscribeOptions, MessagesQueryReply, MessagesReadReply, MessagesSubscribeReply } from '@enbox/dwn-sdk-js';
+import { RecordsRead, RecordsQuery, RecordsWrite, RecordsDelete, ProtocolsQuery, ProtocolsConfigure, RecordsSubscribe, MessagesQuery, MessagesRead, MessagesSubscribe } from '@enbox/dwn-sdk-js';
+/**
+ * Represents a Decentralized Web Node (DWN) service in a DID Document.
+ *
+ * A DWN DID service is a specialized type of DID service with the `type` set to
+ * `DecentralizedWebNode`. It includes specific properties `enc` and `sig` that are used to identify
+ * the public keys that can be used to interact with the DID Subject. The values of these properties
+ * are strings or arrays of strings containing one or more verification method `id` values present in
+ * the same DID document. If the `enc` and/or `sig` properties are an array of strings, an entity
+ * interacting with the DID subject is expected to use the verification methods in the order they
+ * are listed.
+ *
+ * @example
+ * ```ts
+ * const service: DwnDidService = {
+ *   id: 'did:example:123#dwn',
+ *   type: 'DecentralizedWebNode',
+ *   serviceEndpoint: 'https://enbox-production.up.railway.app',
+ *   enc: 'did:example:123#key-1',
+ *   sig: 'did:example:123#key-2'
+ * }
+ * ```
+ *
+ * @see {@link https://identity.foundation/decentralized-web-node/spec/ | DIF Decentralized Web Node (DWN) Specification}
+ */
+export interface DwnDidService extends DidService {
+    /**
+     * One or more verification method `id` values that can be used to encrypt information
+     * intended for the DID subject.
+     */
+    enc?: string | string[];
+    /**
+     * One or more verification method `id` values that will be used by the DID subject to sign data
+     * or by another entity to verify signatures created by the DID subject.
+     */
+    sig: string | string[];
+}
+export declare enum DwnInterface {
+    MessagesQuery = "MessagesQuery",
+    MessagesRead = "MessagesRead",
+    MessagesSubscribe = "MessagesSubscribe",
+    ProtocolsConfigure = "ProtocolsConfigure",
+    ProtocolsQuery = "ProtocolsQuery",
+    RecordsDelete = "RecordsDelete",
+    RecordsQuery = "RecordsQuery",
+    RecordsRead = "RecordsRead",
+    RecordsSubscribe = "RecordsSubscribe",
+    RecordsWrite = "RecordsWrite"
+}
+export type DwnRecordsInterfaces = DwnInterface.RecordsDelete | DwnInterface.RecordsQuery | DwnInterface.RecordsRead | DwnInterface.RecordsSubscribe | DwnInterface.RecordsWrite;
+export type DwnMessageInterfaces = DwnInterface.MessagesQuery | DwnInterface.MessagesRead | DwnInterface.MessagesSubscribe;
+export type DwnProtocolInterfaces = DwnInterface.ProtocolsConfigure | DwnInterface.ProtocolsQuery;
+export interface DwnMessage {
+    [DwnInterface.MessagesQuery]: MessagesQueryMessage;
+    [DwnInterface.MessagesRead]: MessagesReadMessage;
+    [DwnInterface.MessagesSubscribe]: MessagesSubscribeMessage;
+    [DwnInterface.ProtocolsConfigure]: ProtocolsConfigureMessage;
+    [DwnInterface.ProtocolsQuery]: ProtocolsQueryMessage;
+    [DwnInterface.RecordsDelete]: RecordsDeleteMessage;
+    [DwnInterface.RecordsQuery]: RecordsQueryMessage;
+    [DwnInterface.RecordsRead]: RecordsReadMessage;
+    [DwnInterface.RecordsSubscribe]: RecordsSubscribeMessage;
+    [DwnInterface.RecordsWrite]: RecordsWriteMessage;
+}
+export interface DwnMessageDescriptor {
+    [DwnInterface.MessagesQuery]: MessagesQueryMessage['descriptor'];
+    [DwnInterface.MessagesRead]: MessagesReadMessage['descriptor'];
+    [DwnInterface.MessagesSubscribe]: MessagesSubscribeMessage['descriptor'];
+    [DwnInterface.ProtocolsConfigure]: ProtocolsConfigureMessage['descriptor'];
+    [DwnInterface.ProtocolsQuery]: ProtocolsQueryMessage['descriptor'];
+    [DwnInterface.RecordsDelete]: RecordsDeleteMessage['descriptor'];
+    [DwnInterface.RecordsQuery]: RecordsQueryMessage['descriptor'];
+    [DwnInterface.RecordsRead]: RecordsReadMessage['descriptor'];
+    [DwnInterface.RecordsSubscribe]: RecordsSubscribeMessage['descriptor'];
+    [DwnInterface.RecordsWrite]: RecordsWriteMessage['descriptor'];
+}
+export interface DwnMessageParams {
+    [DwnInterface.MessagesQuery]: RequireOnly<MessagesQueryOptions, 'filters'>;
+    [DwnInterface.MessagesRead]: RequireOnly<MessagesReadOptions, 'messageCid'>;
+    [DwnInterface.MessagesSubscribe]: Partial<MessagesSubscribeOptions>;
+    [DwnInterface.ProtocolsConfigure]: RequireOnly<ProtocolsConfigureOptions, 'definition'>;
+    [DwnInterface.ProtocolsQuery]: ProtocolsQueryOptions;
+    [DwnInterface.RecordsDelete]: RequireOnly<RecordsDeleteOptions, 'recordId'>;
+    [DwnInterface.RecordsQuery]: RecordsQueryOptions;
+    [DwnInterface.RecordsRead]: RecordsReadOptions;
+    [DwnInterface.RecordsSubscribe]: RecordsSubscribeOptions;
+    [DwnInterface.RecordsWrite]: RecordsWriteOptions;
+}
+export interface DwnMessageReply {
+    [DwnInterface.MessagesQuery]: MessagesQueryReply;
+    [DwnInterface.MessagesRead]: MessagesReadReply;
+    [DwnInterface.MessagesSubscribe]: MessagesSubscribeReply;
+    [DwnInterface.ProtocolsConfigure]: GenericMessageReply;
+    [DwnInterface.ProtocolsQuery]: ProtocolsQueryReply;
+    [DwnInterface.RecordsDelete]: GenericMessageReply;
+    [DwnInterface.RecordsQuery]: RecordsQueryReply;
+    [DwnInterface.RecordsRead]: RecordsReadReply;
+    [DwnInterface.RecordsSubscribe]: RecordsSubscribeReply;
+    [DwnInterface.RecordsWrite]: GenericMessageReply;
+}
+export interface MessageHandler {
+    [DwnInterface.MessagesSubscribe]: MessageSubscriptionHandler;
+    [DwnInterface.RecordsSubscribe]: RecordSubscriptionHandler;
+    [DwnInterface.MessagesQuery]: undefined;
+    [DwnInterface.MessagesRead]: undefined;
+    [DwnInterface.ProtocolsConfigure]: undefined;
+    [DwnInterface.ProtocolsQuery]: undefined;
+    [DwnInterface.RecordsDelete]: undefined;
+    [DwnInterface.RecordsQuery]: undefined;
+    [DwnInterface.RecordsRead]: undefined;
+    [DwnInterface.RecordsWrite]: undefined;
+}
+export type DwnRequest<T extends DwnInterface> = {
+    author: string;
+    target: string;
+    messageType: T;
+};
+/**
+ * Defines the structure for response status, including a status code and detail message.
+ */
+export type DwnResponseStatus = {
+    /** Encapsulates the outcome of an operation, providing both a numeric status code and a descriptive message. */
+    status: {
+        /** Numeric status code representing the outcome of the operation. */
+        code: number;
+        /** Descriptive detail about the status or error. */
+        detail: string;
+    };
+};
+export type ProcessDwnRequest<T extends DwnInterface> = DwnRequest<T> & {
+    dataStream?: Blob | ReadableStream | Readable;
+    rawMessage?: DwnMessage[T];
+    messageParams?: DwnMessageParams[T];
+    store?: boolean;
+    signAsOwner?: boolean;
+    signAsOwnerDelegate?: boolean;
+    granteeDid?: string;
+    subscriptionHandler?: MessageHandler[T];
+};
+export type SendDwnRequest<T extends DwnInterface> = DwnRequest<T> & (ProcessDwnRequest<T> | {
+    messageCid: string;
+});
+export type DwnResponse<T extends DwnInterface> = {
+    message?: DwnMessage[T];
+    messageCid: string;
+    reply: DwnMessageReply[T];
+};
+export interface DwnMessageConstructor<T extends DwnInterface> {
+    new (): DwnMessageInstance[T];
+    create(params: DwnMessageParams[T]): Promise<DwnMessageInstance[T]>;
+    parse(rawMessage: DwnMessage[T]): Promise<DwnMessageInstance[T]>;
+}
+export declare const dwnMessageConstructors: {
+    [T in DwnInterface]: DwnMessageConstructor<T>;
+};
+export type DwnMessageConstructors = typeof dwnMessageConstructors;
+export interface DwnMessageInstance {
+    [DwnInterface.MessagesQuery]: MessagesQuery;
+    [DwnInterface.MessagesRead]: MessagesRead;
+    [DwnInterface.MessagesSubscribe]: MessagesSubscribe;
+    [DwnInterface.ProtocolsConfigure]: ProtocolsConfigure;
+    [DwnInterface.ProtocolsQuery]: ProtocolsQuery;
+    [DwnInterface.RecordsDelete]: RecordsDelete;
+    [DwnInterface.RecordsQuery]: RecordsQuery;
+    [DwnInterface.RecordsRead]: RecordsRead;
+    [DwnInterface.RecordsSubscribe]: RecordsSubscribe;
+    [DwnInterface.RecordsWrite]: RecordsWrite;
+}
+export type DwnMessageWithData<T extends DwnInterface> = {
+    message: DwnMessage[T];
+    dataStream?: Readable;
+};
+export { DwnConstant, Signer as DwnSigner, DateSort as DwnDateSort, DataEncodedRecordsWriteMessage as DwnDataEncodedRecordsWriteMessage, PublicJwk as DwnPublicKeyJwk, // TODO: Remove once DWN SDK switches to Jwk from @enbox/crypto
+PaginationCursor as DwnPaginationCursor, MessageSubscriptionHandler as DwnMessageSubscriptionHandler, RecordSubscriptionHandler as DwnRecordSubscriptionHandler, MessageSubscription as DwnMessageSubscription, MessagesPermissionScope as DwnMessagesPermissionScope, EncryptionAlgorithm as DwnEncryptionAlgorithm, KeyDerivationScheme as DwnKeyDerivationScheme, PermissionGrant as DwnPermissionGrant, PermissionGrantData as DwnPermissionGrantData, PermissionRequest as DwnPermissionRequest, PermissionRequestData as DwnPermissionRequestData, PermissionsProtocol as DwnPermissionsProtocol, ProtocolDefinition as DwnProtocolDefinition, ProtocolPermissionScope as DwnProtocolPermissionScope, RecordsPermissionScope as DwnRecordsPermissionScope, PermissionConditions as DwnPermissionConditions, PermissionScope as DwnPermissionScope, } from '@enbox/dwn-sdk-js';
+//# sourceMappingURL=dwn.d.ts.map