@enbox/agent 0.2.1 → 0.3.0

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

@@ -1,8 +1,8 @@
-import type { DidDhtCreateOptions, DidDocument, DidJwkCreateOptions, DidMetadata, DidMethodApi, DidResolutionOptions, DidResolutionResult, DidResolverCache, DidVerificationMethod, PortableDid } from '@enbox/dids';
+import type { DidDhtCreateOptions, DidDocument, DidJwkCreateOptions, DidMetadata, DidMethodApi, DidResolutionOptions, DidResolutionResult, DidResolverCache, DidVerificationMethod, DidWebCreateOptions, PortableDid } from '@enbox/dids';
 import { BearerDid, UniversalResolver } from '@enbox/dids';
 import type { AgentDataStore } from './store-data.js';
 import type { AgentKeyManager } from './types/key-manager.js';
-import type { ResponseStatus, Web5PlatformAgent } from './types/agent.js';
+import type { EnboxPlatformAgent, ResponseStatus } from './types/agent.js';
 export declare enum DidInterface {
     Create = "Create",
     Resolve = "Resolve"
@@ -41,10 +41,11 @@ export interface DidCreateParams<TKeyManager = AgentKeyManager, TMethod extends
 export interface DidMethodCreateOptions<TKeyManager> {
     dht: DidDhtCreateOptions<TKeyManager>;
     jwk: DidJwkCreateOptions<TKeyManager>;
+    web: DidWebCreateOptions<TKeyManager>;
 }
 export interface DidApiParams {
     didMethods: DidMethodApi[];
-    agent?: Web5PlatformAgent;
+    agent?: EnboxPlatformAgent;
     /**
      * An optional `DidResolverCache` instance used for caching resolved DID documents.
      *
@@ -59,16 +60,16 @@ export interface DidApiParams {
 }
 export declare function isDidRequest<T extends DidInterface>(didRequest: DidRequest<DidInterface>, messageType: T): didRequest is DidRequest<T>;
 /**
- * This API is used to manage and interact with DIDs within the Web5 Agent framework.
+ * This API is used to manage and interact with DIDs within the Enbox Agent framework.
  *
  * If a DWN Data Store is used, the DID information is stored under DID's own tenant by default.
  * If a tenant property is passed, that tenant will be used to store the DID information.
  */
 export declare class AgentDidApi<TKeyManager extends AgentKeyManager = AgentKeyManager> extends UniversalResolver {
     /**
-     * Holds the instance of a `Web5PlatformAgent` that represents the current execution context for
-     * the `AgentDidApi`. 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
+     * Holds the instance of a `EnboxPlatformAgent` that represents the current execution context for
+     * the `AgentDidApi`. This agent is used to interact with other Enbox agent components. It's vital
+     * to ensure this instance is set to correctly contextualize operations within the broader Enbox
      * Agent framework.
      */
     private _agent?;
@@ -76,13 +77,13 @@ export declare class AgentDidApi<TKeyManager extends AgentKeyManager = AgentKeyM
     private _store;
     constructor({ agent, didMethods, resolverCache, store }: DidApiParams);
     /**
-     * Retrieves the `Web5PlatformAgent` execution context.
+     * Retrieves the `EnboxPlatformAgent` execution context.
      *
-     * @returns The `Web5PlatformAgent` instance that represents the current execution context.
+     * @returns The `EnboxPlatformAgent` 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);
+    get agent(): EnboxPlatformAgent;
+    set agent(agent: EnboxPlatformAgent);
     create({ method, tenant, options, store }: DidCreateParams<TKeyManager>): Promise<BearerDid>;
     export({ didUri, tenant }: {
         didUri: string;

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

@@ -1 +1 @@
-{"version":3,"file":"did-api.d.ts","sourceRoot":"","sources":["../../src/did-api.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,mBAAmB,EACnB,WAAW,EACX,mBAAmB,EACnB,WAAW,EACX,YAAY,EACZ,oBAAoB,EACpB,mBAAmB,EACnB,gBAAgB,EAChB,qBAAqB,EACrB,WAAW,EACZ,MAAM,aAAa,CAAC;AAErB,OAAO,EAAE,SAAS,EAAe,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAExE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AACtD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAC9D,OAAO,KAAK,EAAE,cAAc,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AAM1E,oBAAY,YAAY;IACtB,MAAM,WAAW;IAEjB,OAAO,YAAY;CAEpB;AAED,MAAM,WAAW,gBAAgB;IAC/B,CAAC,YAAY,CAAC,MAAM,CAAC,EAAE,eAAe,CAAC;IAEvC,CAAC,YAAY,CAAC,OAAO,CAAC,EAAE,gBAAgB,CAAC;CAE1C;AAED,MAAM,WAAW,gBAAgB;IAC/B,CAAC,YAAY,CAAC,MAAM,CAAC,EAAE,eAAe,CAAC;IAEvC,CAAC,YAAY,CAAC,OAAO,CAAC,EAAE,gBAAgB,CAAC;CAE1C;AAED,MAAM,MAAM,eAAe,GAAG;IAC5B,GAAG,EAAE,MAAM,CAAC;IACZ,QAAQ,EAAE,WAAW,CAAC;IACtB,QAAQ,EAAE,WAAW,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG,mBAAmB,CAAC;AAEnD,MAAM,MAAM,UAAU,CAAC,CAAC,SAAS,YAAY,IAAI;IAC/C,WAAW,EAAE,CAAC,CAAC;IACf,aAAa,EAAE,gBAAgB,CAAC,CAAC,CAAC,CAAC;CACpC,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,oBAAoB,CAAC;CAChC,CAAC;AAEF,MAAM,MAAM,WAAW,CAAC,CAAC,SAAS,YAAY,IAAI,cAAc,GAAG;IACjE,MAAM,CAAC,EAAE,gBAAgB,CAAC,CAAC,CAAC,CAAC;CAC9B,CAAC;AAEF,MAAM,WAAW,eAAe,CAC9B,WAAW,GAAG,eAAe,EAC7B,OAAO,SAAS,MAAM,sBAAsB,CAAC,WAAW,CAAC,GAAG,MAAM,sBAAsB,CAAC,WAAW,CAAC;IAErG,MAAM,EAAE,OAAO,CAAC;IAChB,OAAO,CAAC,EAAE,sBAAsB,CAAC,WAAW,CAAC,CAAC,OAAO,CAAC,CAAC;IACvD,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,sBAAsB,CAAC,WAAW;IACjD,GAAG,EAAE,mBAAmB,CAAC,WAAW,CAAC,CAAC;IACtC,GAAG,EAAE,mBAAmB,CAAC,WAAW,CAAC,CAAC;CACvC;AAED,MAAM,WAAW,YAAY;IAC3B,UAAU,EAAE,YAAY,EAAE,CAAC;IAE3B,KAAK,CAAC,EAAE,iBAAiB,CAAC;IAE1B;;;;;;;;OAQG;IACH,aAAa,CAAC,EAAE,gBAAgB,CAAC;IAEjC,KAAK,CAAC,EAAE,cAAc,CAAC,WAAW,CAAC,CAAC;CACrC;AAED,wBAAgB,YAAY,CAAC,CAAC,SAAS,YAAY,EACjD,UAAU,EAAE,UAAU,CAAC,YAAY,CAAC,EAAE,WAAW,EAAE,CAAC,GACnD,UAAU,IAAI,UAAU,CAAC,CAAC,CAAC,CAE7B;AAED;;;;;GAKG;AACH,qBAAa,WAAW,CAAC,WAAW,SAAS,eAAe,GAAG,eAAe,CAAE,SAAQ,iBAAiB;IACvG;;;;;OAKG;IACH,OAAO,CAAC,MAAM,CAAC,CAAoB;IAEnC,OAAO,CAAC,WAAW,CAAwC;IAE3D,OAAO,CAAC,MAAM,CAA8B;gBAEhC,EAAE,KAAK,EAAE,UAAU,EAAE,aAAa,EAAE,KAAK,EAAE,EAAE,YAAY;IAsBrE;;;;;OAKG;IACH,IAAI,KAAK,IAAI,iBAAiB,CAM7B;IAED,IAAI,KAAK,CAAC,KAAK,EAAE,iBAAiB,EAOjC;IAEY,MAAM,CAAC,EAClB,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,KAAK,EAC/B,EAAE,eAAe,CAAC,WAAW,CAAC,GAAG,OAAO,CAAC,SAAS,CAAC;IA+BvC,MAAM,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE;QACtC,MAAM,EAAE,MAAM,CAAC;QACf,MAAM,CAAC,EAAE,MAAM,CAAC;KACjB,GAAG,OAAO,CAAC,WAAW,CAAC;IAeX,GAAG,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE;QACnC,MAAM,EAAE,MAAM,CAAC;QACf,MAAM,CAAC,EAAE,MAAM,CAAA;KAChB,GAAG,OAAO,CAAC,SAAS,GAAG,SAAS,CAAC;IAUrB,gBAAgB,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,EAAE;QAClD,MAAM,EAAE,MAAM,CAAC;QACf,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAsBrB,MAAM,CAAC,EAAE,MAAM,EAAE,WAAW,EAAE,OAAc,EAAE,EAAE;QAC3D,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,WAAW,EAAE,WAAW,CAAC;QACzB,OAAO,CAAC,EAAE,OAAO,CAAC;KACnB,GAAG,OAAO,CAAC,SAAS,CAAC;IAgDT,MAAM,CAAC,EAAE,WAAW,EAAE,MAAM,EAAE,EAAE;QAC3C,WAAW,EAAE,WAAW,CAAC;QACzB,MAAM,CAAC,EAAE,MAAM,CAAC;KACjB,GAAG,OAAO,CAAC,SAAS,CAAC;IA4BT,MAAM,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,SAAgB,EAAE,EAAE;QACxD,MAAM,EAAE,MAAM,CAAC;QACf,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,SAAS,CAAC,EAAE,OAAO,CAAC;KACrB,GAAG,OAAO,CAAC,IAAI,CAAC;IAmBJ,UAAU,CAAC,EAAE,WAAW,EAAE,EAAE;QACvC,WAAW,EAAE,WAAW,CAAC;KAC1B,GAAG,OAAO,CAAC,IAAI,CAAC;IAWJ,cAAc,CAAC,CAAC,SAAS,YAAY,EAChD,OAAO,EAAE,UAAU,CAAC,CAAC,CAAC,GACrB,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;IAuC1B,OAAO,CAAC,SAAS;CASlB"}
+{"version":3,"file":"did-api.d.ts","sourceRoot":"","sources":["../../src/did-api.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,mBAAmB,EACnB,WAAW,EACX,mBAAmB,EACnB,WAAW,EACX,YAAY,EACZ,oBAAoB,EACpB,mBAAmB,EACnB,gBAAgB,EAChB,qBAAqB,EACrB,mBAAmB,EACnB,WAAW,EACZ,MAAM,aAAa,CAAC;AAErB,OAAO,EAAE,SAAS,EAAe,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAExE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AACtD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAC9D,OAAO,KAAK,EAAE,kBAAkB,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAM3E,oBAAY,YAAY;IACtB,MAAM,WAAW;IAEjB,OAAO,YAAY;CAEpB;AAED,MAAM,WAAW,gBAAgB;IAC/B,CAAC,YAAY,CAAC,MAAM,CAAC,EAAE,eAAe,CAAC;IAEvC,CAAC,YAAY,CAAC,OAAO,CAAC,EAAE,gBAAgB,CAAC;CAE1C;AAED,MAAM,WAAW,gBAAgB;IAC/B,CAAC,YAAY,CAAC,MAAM,CAAC,EAAE,eAAe,CAAC;IAEvC,CAAC,YAAY,CAAC,OAAO,CAAC,EAAE,gBAAgB,CAAC;CAE1C;AAED,MAAM,MAAM,eAAe,GAAG;IAC5B,GAAG,EAAE,MAAM,CAAC;IACZ,QAAQ,EAAE,WAAW,CAAC;IACtB,QAAQ,EAAE,WAAW,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG,mBAAmB,CAAC;AAEnD,MAAM,MAAM,UAAU,CAAC,CAAC,SAAS,YAAY,IAAI;IAC/C,WAAW,EAAE,CAAC,CAAC;IACf,aAAa,EAAE,gBAAgB,CAAC,CAAC,CAAC,CAAC;CACpC,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,oBAAoB,CAAC;CAChC,CAAC;AAEF,MAAM,MAAM,WAAW,CAAC,CAAC,SAAS,YAAY,IAAI,cAAc,GAAG;IACjE,MAAM,CAAC,EAAE,gBAAgB,CAAC,CAAC,CAAC,CAAC;CAC9B,CAAC;AAEF,MAAM,WAAW,eAAe,CAC9B,WAAW,GAAG,eAAe,EAC7B,OAAO,SAAS,MAAM,sBAAsB,CAAC,WAAW,CAAC,GAAG,MAAM,sBAAsB,CAAC,WAAW,CAAC;IAErG,MAAM,EAAE,OAAO,CAAC;IAChB,OAAO,CAAC,EAAE,sBAAsB,CAAC,WAAW,CAAC,CAAC,OAAO,CAAC,CAAC;IACvD,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,sBAAsB,CAAC,WAAW;IACjD,GAAG,EAAE,mBAAmB,CAAC,WAAW,CAAC,CAAC;IACtC,GAAG,EAAE,mBAAmB,CAAC,WAAW,CAAC,CAAC;IACtC,GAAG,EAAE,mBAAmB,CAAC,WAAW,CAAC,CAAC;CACvC;AAED,MAAM,WAAW,YAAY;IAC3B,UAAU,EAAE,YAAY,EAAE,CAAC;IAE3B,KAAK,CAAC,EAAE,kBAAkB,CAAC;IAE3B;;;;;;;;OAQG;IACH,aAAa,CAAC,EAAE,gBAAgB,CAAC;IAEjC,KAAK,CAAC,EAAE,cAAc,CAAC,WAAW,CAAC,CAAC;CACrC;AAED,wBAAgB,YAAY,CAAC,CAAC,SAAS,YAAY,EACjD,UAAU,EAAE,UAAU,CAAC,YAAY,CAAC,EAAE,WAAW,EAAE,CAAC,GACnD,UAAU,IAAI,UAAU,CAAC,CAAC,CAAC,CAE7B;AAED;;;;;GAKG;AACH,qBAAa,WAAW,CAAC,WAAW,SAAS,eAAe,GAAG,eAAe,CAAE,SAAQ,iBAAiB;IACvG;;;;;OAKG;IACH,OAAO,CAAC,MAAM,CAAC,CAAqB;IAEpC,OAAO,CAAC,WAAW,CAAwC;IAE3D,OAAO,CAAC,MAAM,CAA8B;gBAEhC,EAAE,KAAK,EAAE,UAAU,EAAE,aAAa,EAAE,KAAK,EAAE,EAAE,YAAY;IAsBrE;;;;;OAKG;IACH,IAAI,KAAK,IAAI,kBAAkB,CAM9B;IAED,IAAI,KAAK,CAAC,KAAK,EAAE,kBAAkB,EAOlC;IAEY,MAAM,CAAC,EAClB,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,KAAK,EAC/B,EAAE,eAAe,CAAC,WAAW,CAAC,GAAG,OAAO,CAAC,SAAS,CAAC;IA+BvC,MAAM,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE;QACtC,MAAM,EAAE,MAAM,CAAC;QACf,MAAM,CAAC,EAAE,MAAM,CAAC;KACjB,GAAG,OAAO,CAAC,WAAW,CAAC;IAeX,GAAG,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE;QACnC,MAAM,EAAE,MAAM,CAAC;QACf,MAAM,CAAC,EAAE,MAAM,CAAA;KAChB,GAAG,OAAO,CAAC,SAAS,GAAG,SAAS,CAAC;IAUrB,gBAAgB,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,EAAE;QAClD,MAAM,EAAE,MAAM,CAAC;QACf,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAsBrB,MAAM,CAAC,EAAE,MAAM,EAAE,WAAW,EAAE,OAAc,EAAE,EAAE;QAC3D,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,WAAW,EAAE,WAAW,CAAC;QACzB,OAAO,CAAC,EAAE,OAAO,CAAC;KACnB,GAAG,OAAO,CAAC,SAAS,CAAC;IAgDT,MAAM,CAAC,EAAE,WAAW,EAAE,MAAM,EAAE,EAAE;QAC3C,WAAW,EAAE,WAAW,CAAC;QACzB,MAAM,CAAC,EAAE,MAAM,CAAC;KACjB,GAAG,OAAO,CAAC,SAAS,CAAC;IA4BT,MAAM,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,SAAgB,EAAE,EAAE;QACxD,MAAM,EAAE,MAAM,CAAC;QACf,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,SAAS,CAAC,EAAE,OAAO,CAAC;KACrB,GAAG,OAAO,CAAC,IAAI,CAAC;IAmBJ,UAAU,CAAC,EAAE,WAAW,EAAE,EAAE;QACvC,WAAW,EAAE,WAAW,CAAC;KAC1B,GAAG,OAAO,CAAC,IAAI,CAAC;IAWJ,cAAc,CAAC,CAAC,SAAS,YAAY,EAChD,OAAO,EAAE,UAAU,CAAC,CAAC,CAAC,GACrB,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;IAuC1B,OAAO,CAAC,SAAS;CASlB"}

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

@@ -1,22 +1,24 @@
 import type { DerivedPrivateJwk, DwnConfig, EncryptionKeyDeriver, ProtocolDefinition } from '@enbox/dwn-sdk-js';
 import type { PublicKeyJwk } from '@enbox/crypto';
 import { Dwn } from '@enbox/dwn-sdk-js';
-import type { Web5PlatformAgent } from './types/agent.js';
+import type { EnboxPlatformAgent } from './types/agent.js';
+import type { LocalDwnStrategy } from './local-dwn.js';
 import type { DwnResponse, ProcessDwnRequest, SendDwnRequest } from './types/dwn.js';
 import { DwnInterface } from './types/dwn.js';
 export { isDwnMessage, isDwnRequest, isMessagesPermissionScope, isRecordPermissionScope, isRecordsType } from './dwn-type-guards.js';
 type DwnApiParams = {
-    agent?: Web5PlatformAgent;
+    agent?: EnboxPlatformAgent;
     dwn: Dwn;
+    localDwnStrategy?: LocalDwnStrategy;
 };
 interface DwnApiCreateDwnParams extends Partial<DwnConfig> {
     dataPath?: string;
 }
 export declare class AgentDwnApi {
     /**
-     * Holds the instance of a `Web5PlatformAgent` that represents the current execution context for
-     * the `AgentDwnApi`. 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
+     * Holds the instance of a `EnboxPlatformAgent` that represents the current execution context for
+     * the `AgentDwnApi`. This agent is used to interact with other Enbox agent components. It's vital
+     * to ensure this instance is set to correctly contextualize operations within the broader Enbox
      * Agent framework.
      */
     private _agent?;
@@ -40,15 +42,60 @@ export declare class AgentDwnApi {
      * Keyed by `ctx~${authorDid}~${rootContextId}`. TTL 30 minutes.
      */
     private _contextDerivedKeyCache;
-    constructor({ agent, dwn }: DwnApiParams);
     /**
-     * Retrieves the `Web5PlatformAgent` execution context.
+     * Cache of locally-managed DIDs (agent DID + identities). Used to decide
+     * whether a target DID should be routed through the local DWN server.
+     */
+    private _localManagedDidCache;
+    /** Controls local DWN discovery behavior ('prefer' | 'only' | 'off'). */
+    private _localDwnStrategy;
+    /** Lazy-initialized local DWN discovery instance. */
+    private _localDwnDiscovery?;
+    constructor({ agent, dwn, localDwnStrategy }: DwnApiParams);
+    /**
+     * Retrieves the `EnboxPlatformAgent` execution context.
      *
-     * @returns The `Web5PlatformAgent` instance that represents the current execution context.
+     * @returns The `EnboxPlatformAgent` 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);
+    get agent(): EnboxPlatformAgent;
+    set agent(agent: EnboxPlatformAgent);
+    get localDwnStrategy(): LocalDwnStrategy;
+    setLocalDwnStrategy(strategy: LocalDwnStrategy): void;
+    /**
+     * Inject a cached local DWN endpoint (e.g. from a `dwn://register`
+     * browser redirect or from persisted storage). The endpoint is validated
+     * via `GET /info` before being accepted.
+     *
+     * @param endpoint - The local DWN server base URL.
+     * @returns `true` if the endpoint was validated and cached, `false` otherwise.
+     * @see https://github.com/enboxorg/enbox/issues/589
+     */
+    setCachedLocalDwnEndpoint(endpoint: string): Promise<boolean>;
+    /**
+     * Resolves the DWN service endpoint URLs for the given target DID, optionally
+     * prepending a local DWN server endpoint when local discovery is enabled and
+     * the target is a locally-managed DID.
+     *
+     * @param targetDid - The DID whose DWN endpoints should be resolved.
+     * @returns An array of endpoint URLs.
+     * @throws When strategy is `'only'` and no local server is available.
+     */
+    getDwnEndpointUrlsForTarget(targetDid: string): Promise<string[]>;
+    /** Lazily retrieves the local DWN server endpoint via discovery. */
+    private getLocalDwnEndpoint;
+    /**
+     * Attempt to create a {@link DwnDiscoveryFile} for file-based local DWN
+     * discovery. Returns `undefined` in environments where the filesystem
+     * is not available (e.g. browsers).
+     */
+    private static _tryCreateDiscoveryFile;
+    /**
+     * Determines whether the given target DID should be routed through the
+     * local DWN server. Returns `true` if the DID is the agent DID or one
+     * of the locally-managed identity DIDs.
+     */
+    private shouldUseLocalDwnForTarget;
     /**
      * Public getter for the DWN instance used by this API.
      *
@@ -57,7 +104,7 @@ export declare class AgentDwnApi {
      *   However, it is recommended to use the `processRequest` method to interact with the DWN
      *   instance to ensure that the DWN message is constructed correctly.
      * - The getter is named `node` to avoid confusion with the `dwn` property of the
-     *   `Web5PlatformAgent`. In other words, so that a developer can call `agent.dwn.node` to access
+     *   `EnboxPlatformAgent`. In other words, so that a developer can call `agent.dwn.node` to access
      *   the DWN instance and not `agent.dwn.dwn`.
      */
     get node(): Dwn;

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

@@ -1 +1 @@
-{"version":3,"file":"dwn-api.d.ts","sourceRoot":"","sources":["../../src/dwn-api.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,iBAAiB,EACjB,SAAS,EAET,oBAAoB,EAGpB,kBAAkB,EAGnB,MAAM,mBAAmB,CAAC;AAE3B,OAAO,KAAK,EAAgC,YAAY,EAAE,MAAM,eAAe,CAAC;AAGhF,OAAO,EAKL,GAAG,EAWJ,MAAM,mBAAmB,CAAC;AAI3B,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AAC1D,OAAO,KAAK,EAMV,WAAW,EAGX,iBAAiB,EACjB,cAAc,EACf,MAAM,gBAAgB,CAAC;AAGxB,OAAO,EAAE,YAAY,EAA0B,MAAM,gBAAgB,CAAC;AAItE,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,yBAAyB,EAAE,uBAAuB,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AA8CrI,KAAK,YAAY,GAAG;IAClB,KAAK,CAAC,EAAE,iBAAiB,CAAC;IAC1B,GAAG,EAAE,GAAG,CAAC;CACV,CAAC;AAEF,UAAU,qBAAsB,SAAQ,OAAO,CAAC,SAAS,CAAC;IACxD,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,qBAAa,WAAW;IACtB;;;;;OAKG;IACH,OAAO,CAAC,MAAM,CAAC,CAAoB;IAEnC;;OAEG;IACH,OAAO,CAAC,IAAI,CAAM;IAElB;;;OAGG;IACH,OAAO,CAAC,wBAAwB,CAE7B;IAEH;;;OAGG;IACH,OAAO,CAAC,gBAAgB,CAII;IAE5B;;;;OAIG;IACH,OAAO,CAAC,uBAAuB,CAE5B;gBAES,EAAE,KAAK,EAAE,GAAG,EAAE,EAAE,YAAY;IAQxC;;;;;OAKG;IACH,IAAI,KAAK,IAAI,iBAAiB,CAM7B;IAED,IAAI,KAAK,CAAC,KAAK,EAAE,iBAAiB,EAEjC;IAED;;;;;;;;;;OAUG;IACH,IAAI,IAAI,IAAI,GAAG,CAEd;WAEmB,SAAS,CAAC,EAC5B,QAAQ,EAAE,SAAS,EAAE,WAAW,EAAE,UAAU,EAAE,QAAQ,EAAE,YAAY,EAAE,UAAU,EAAE,kBAAkB,EACrG,EAAE,qBAAqB,GAAG,OAAO,CAAC,GAAG,CAAC;IAsB1B,cAAc,CAAC,CAAC,SAAS,YAAY,EAChD,OAAO,EAAE,iBAAiB,CAAC,CAAC,CAAC,GAC5B,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;IAkCb,WAAW,CAAC,CAAC,SAAS,YAAY,EAC7C,OAAO,EAAE,cAAc,CAAC,CAAC,CAAC,GACzB,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;IAoE1B;;;;;;;OAOG;YACW,oBAAoB;YAgIpB,iBAAiB;YA8DjB,mBAAmB;IA+VjC,OAAO,CAAC,cAAc;YAMR,SAAS;IA4CvB;;;;;;OAMG;IACU,uBAAuB,CAClC,MAAM,EAAE,MAAM,GACb,OAAO,CAAC,oBAAoB,CAAC;IAIhC;;;;;OAKG;YACW,oBAAoB;IAMlC;;;;OAIG;YACW,eAAe;IAM7B;;;;;OAKG;IACI,qBAAqB,CAAC,MAAM,EAAE;QACnC,kBAAkB,EAAE,kBAAkB,CAAC;QACvC,YAAY,EAAE,MAAM,CAAC;QACrB,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,SAAS,EAAE,MAAM,CAAC;QAClB,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB,GAAG,GAAG,CAAC,MAAM,CAAC;IAIf;;;;;;;OAOG;YACW,qBAAqB;IAUnC;;;OAGG;YACW,6BAA6B;IAU3C;;;;;;;;;;;OAWG;YACW,uBAAuB;IAarC;;;OAGG;YACW,iBAAiB;YAWjB,aAAa;IAqC3B;;;OAGG;IACH,OAAO,CAAC,kCAAkC,CAGvC;IAEH;;;;;OAKG;IACU,yBAAyB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAUxE;;;;;;OAMG;IACU,qBAAqB,CAAC,MAAM,EAAE;QACzC,SAAS,EAAE,MAAM,CAAC;QAClB,YAAY,EAAE,MAAM,CAAC;QACrB,cAAc,EAAE,iBAAiB,CAAC;QAClC,cAAc,EAAE,MAAM,CAAC;QACvB,eAAe,EAAE,MAAM,CAAC;QACxB,6BAA6B,CAAC,EAAE;YAAE,SAAS,EAAE,MAAM,CAAC;YAAC,YAAY,EAAE,YAAY,CAAA;SAAE,CAAC;KACnF,GAAG,OAAO,CAAC,MAAM,CAAC;IASnB;;;OAGG;YACW,yBAAyB;IAWvC;;;;;;OAMG;IACU,qBAAqB,CAAC,MAAM,EAAE;QACzC,QAAQ,EAAE,MAAM,CAAC;QACjB,YAAY,EAAE,MAAM,CAAC;QACrB,cAAc,EAAE,MAAM,CAAC;QACvB,eAAe,EAAE,MAAM,CAAC;KACzB,GAAG,OAAO,CAAC,iBAAiB,GAAG,SAAS,CAAC;CAQ3C"}
+{"version":3,"file":"dwn-api.d.ts","sourceRoot":"","sources":["../../src/dwn-api.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,iBAAiB,EACjB,SAAS,EAET,oBAAoB,EAGpB,kBAAkB,EAGnB,MAAM,mBAAmB,CAAC;AAE3B,OAAO,KAAK,EAAgC,YAAY,EAAE,MAAM,eAAe,CAAC;AAGhF,OAAO,EAKL,GAAG,EAWJ,MAAM,mBAAmB,CAAC;AAI3B,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AAC3D,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AACvD,OAAO,KAAK,EAMV,WAAW,EAGX,iBAAiB,EACjB,cAAc,EACf,MAAM,gBAAgB,CAAC;AAKxB,OAAO,EAAE,YAAY,EAA0B,MAAM,gBAAgB,CAAC;AAItE,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,yBAAyB,EAAE,uBAAuB,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AA8CrI,KAAK,YAAY,GAAG;IAClB,KAAK,CAAC,EAAE,kBAAkB,CAAC;IAC3B,GAAG,EAAE,GAAG,CAAC;IACT,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;CACrC,CAAC;AAEF,UAAU,qBAAsB,SAAQ,OAAO,CAAC,SAAS,CAAC;IACxD,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,qBAAa,WAAW;IACtB;;;;;OAKG;IACH,OAAO,CAAC,MAAM,CAAC,CAAqB;IAEpC;;OAEG;IACH,OAAO,CAAC,IAAI,CAAM;IAElB;;;OAGG;IACH,OAAO,CAAC,wBAAwB,CAE7B;IAEH;;;OAGG;IACH,OAAO,CAAC,gBAAgB,CAII;IAE5B;;;;OAIG;IACH,OAAO,CAAC,uBAAuB,CAE5B;IAEH;;;OAGG;IACH,OAAO,CAAC,qBAAqB,CAE1B;IAEH,yEAAyE;IACzE,OAAO,CAAC,iBAAiB,CAAmB;IAE5C,qDAAqD;IACrD,OAAO,CAAC,kBAAkB,CAAC,CAAoB;gBAEnC,EAAE,KAAK,EAAE,GAAG,EAAE,gBAA2B,EAAE,EAAE,YAAY;IAoBrE;;;;;OAKG;IACH,IAAI,KAAK,IAAI,kBAAkB,CAM9B;IAED,IAAI,KAAK,CAAC,KAAK,EAAE,kBAAkB,EASlC;IAED,IAAI,gBAAgB,IAAI,gBAAgB,CAEvC;IAEM,mBAAmB,CAAC,QAAQ,EAAE,gBAAgB,GAAG,IAAI;IAI5D;;;;;;;;OAQG;IACU,yBAAyB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAS1E;;;;;;;;OAQG;IACU,2BAA2B,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;IAwC9E,oEAAoE;YACtD,mBAAmB;IASjC;;;;OAIG;IACH,OAAO,CAAC,MAAM,CAAC,uBAAuB;IAStC;;;;OAIG;YACW,0BAA0B;IAqCxC;;;;;;;;;;OAUG;IACH,IAAI,IAAI,IAAI,GAAG,CAEd;WAEmB,SAAS,CAAC,EAC5B,QAAQ,EAAE,SAAS,EAAE,WAAW,EAAE,UAAU,EAAE,QAAQ,EAAE,YAAY,EAAE,UAAU,EAAE,kBAAkB,EACrG,EAAE,qBAAqB,GAAG,OAAO,CAAC,GAAG,CAAC;IAsB1B,cAAc,CAAC,CAAC,SAAS,YAAY,EAChD,OAAO,EAAE,iBAAiB,CAAC,CAAC,CAAC,GAC5B,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;IAkCb,WAAW,CAAC,CAAC,SAAS,YAAY,EAC7C,OAAO,EAAE,cAAc,CAAC,CAAC,CAAC,GACzB,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;IAoE1B;;;;;;;OAOG;YACW,oBAAoB;YAgIpB,iBAAiB;YA8DjB,mBAAmB;IA+VjC,OAAO,CAAC,cAAc;YAMR,SAAS;IA4CvB;;;;;;OAMG;IACU,uBAAuB,CAClC,MAAM,EAAE,MAAM,GACb,OAAO,CAAC,oBAAoB,CAAC;IAIhC;;;;;OAKG;YACW,oBAAoB;IAMlC;;;;OAIG;YACW,eAAe;IAM7B;;;;;OAKG;IACI,qBAAqB,CAAC,MAAM,EAAE;QACnC,kBAAkB,EAAE,kBAAkB,CAAC;QACvC,YAAY,EAAE,MAAM,CAAC;QACrB,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,SAAS,EAAE,MAAM,CAAC;QAClB,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB,GAAG,GAAG,CAAC,MAAM,CAAC;IAIf;;;;;;;OAOG;YACW,qBAAqB;IAUnC;;;OAGG;YACW,6BAA6B;IAU3C;;;;;;;;;;;OAWG;YACW,uBAAuB;IAarC;;;OAGG;YACW,iBAAiB;YAWjB,aAAa;IAqC3B;;;OAGG;IACH,OAAO,CAAC,kCAAkC,CAGvC;IAEH;;;;;OAKG;IACU,yBAAyB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAUxE;;;;;;OAMG;IACU,qBAAqB,CAAC,MAAM,EAAE;QACzC,SAAS,EAAE,MAAM,CAAC;QAClB,YAAY,EAAE,MAAM,CAAC;QACrB,cAAc,EAAE,iBAAiB,CAAC;QAClC,cAAc,EAAE,MAAM,CAAC;QACvB,eAAe,EAAE,MAAM,CAAC;QACxB,6BAA6B,CAAC,EAAE;YAAE,SAAS,EAAE,MAAM,CAAC;YAAC,YAAY,EAAE,YAAY,CAAA;SAAE,CAAC;KACnF,GAAG,OAAO,CAAC,MAAM,CAAC;IASnB;;;OAGG;YACW,yBAAyB;IAYvC;;;;;;OAMG;IACU,qBAAqB,CAAC,MAAM,EAAE;QACzC,QAAQ,EAAE,MAAM,CAAC;QACjB,YAAY,EAAE,MAAM,CAAC;QACrB,cAAc,EAAE,MAAM,CAAC;QACvB,eAAe,EAAE,MAAM,CAAC;KACzB,GAAG,OAAO,CAAC,iBAAiB,GAAG,SAAS,CAAC;CAS3C"}

package/dist/types/dwn-discovery-file.d.ts

@@ -0,0 +1,122 @@
+/**
+ * File-based local DWN discovery for CLI and native apps.
+ *
+ * When `electrobun-dwn` (or any local DWN server) starts, it writes a
+ * well-known file (`~/.enbox/dwn.json`) containing the DWN endpoint URL
+ * and the server PID. CLI tools and native apps read this file to discover
+ * the local DWN without port probing.
+ *
+ * The filesystem operations are abstracted behind {@link DiscoveryFileFs}
+ * so the module can be tested without touching the real filesystem, and
+ * adapted to runtimes that provide different I/O primitives.
+ *
+ * @see https://github.com/enboxorg/enbox/issues/587
+ * @module
+ */
+/**
+ * The JSON shape persisted in the discovery file.
+ *
+ * @see https://identity.foundation/dwn-transport/#discovery-file
+ */
+export interface DwnDiscoveryRecord {
+    /** Base URL of the running DWN server (e.g. `"http://127.0.0.1:55500"`). */
+    endpoint: string;
+    /** OS process ID of the DWN server. Used for liveness checking. */
+    pid: number;
+    /**
+     * Transport capabilities advertised by the server (e.g. `["http", "ws"]`).
+     * Optional per the DWN Transport Spec.
+     */
+    capabilities?: string[];
+}
+/**
+ * Minimal filesystem interface required by {@link DwnDiscoveryFile}.
+ *
+ * Consumers can provide a custom implementation for testing or for
+ * runtimes that do not expose Node-compatible `fs` and `os` modules.
+ */
+export interface DiscoveryFileFs {
+    /** Read the file at `path` and return its UTF-8 contents, or `null` if not found. */
+    readFile(path: string): Promise<string | null>;
+    /** Write `contents` to the file at `path`, creating parent directories as needed. */
+    writeFile(path: string, contents: string): Promise<void>;
+    /** Delete the file at `path`. Must not throw if the file does not exist. */
+    removeFile(path: string): Promise<void>;
+    /** Return `true` if the process with the given PID is alive. */
+    isProcessAlive(pid: number): boolean;
+    /** Return the user's home directory (e.g. `/home/alice`). */
+    homedir(): string;
+}
+/**
+ * Creates a {@link DiscoveryFileFs} backed by Node.js / Bun built-in
+ * modules. Returns `undefined` in environments where `node:fs/promises`
+ * or `node:os` are not available (e.g. browsers).
+ */
+export declare function createNodeDiscoveryFileFs(): DiscoveryFileFs | undefined;
+/**
+ * Directory under the user's home where the discovery file lives.
+ * Shared with the `electrobun-dwn` app and other Enbox tooling.
+ */
+export declare const DISCOVERY_DIR = ".enbox";
+/** Filename of the discovery file. */
+export declare const DISCOVERY_FILENAME = "dwn.json";
+/**
+ * Reads, writes, and validates the `~/.enbox/dwn.json` discovery file.
+ *
+ * This is the **file-based discovery channel** for CLI and native apps.
+ * It is complementary to the `dwn://register` browser redirect flow.
+ *
+ * @example Reading the discovery file
+ * ```ts
+ * const discoveryFile = new DwnDiscoveryFile();
+ * const record = await discoveryFile.read();
+ *
+ * if (record) {
+ *   console.log(`Local DWN at ${record.endpoint}`);
+ * }
+ * ```
+ *
+ * @example Writing the discovery file (from electrobun-dwn)
+ * ```ts
+ * const discoveryFile = new DwnDiscoveryFile();
+ * await discoveryFile.write({
+ *   endpoint : 'http://127.0.0.1:55557',
+ *   pid      : process.pid,
+ * });
+ * ```
+ */
+export declare class DwnDiscoveryFile {
+    private readonly _fs;
+    private readonly _filePath;
+    /**
+     * @param fs - Filesystem adapter. Defaults to Node/Bun built-ins.
+     * @param filePath - Override the discovery file path (mainly for testing).
+     * @throws If no filesystem adapter is available (e.g. in a browser).
+     */
+    constructor(fs?: DiscoveryFileFs, filePath?: string);
+    /** The absolute path of the discovery file. */
+    get path(): string;
+    /**
+     * Read and validate the discovery file.
+     *
+     * Returns the parsed {@link DwnDiscoveryRecord} if:
+     * 1. The file exists and contains valid JSON.
+     * 2. The `endpoint` is a non-empty string.
+     * 3. The `pid` is a positive integer whose process is still alive.
+     *
+     * Returns `undefined` in all other cases (missing file, parse error,
+     * stale PID). Stale files are automatically removed.
+     */
+    read(): Promise<DwnDiscoveryRecord | undefined>;
+    /**
+     * Write the discovery file. Creates the `~/.enbox/` directory if needed.
+     *
+     * @param record - The endpoint and PID to persist.
+     */
+    write(record: DwnDiscoveryRecord): Promise<void>;
+    /**
+     * Remove the discovery file. Does not throw if the file is already gone.
+     */
+    remove(): Promise<void>;
+}
+//# sourceMappingURL=dwn-discovery-file.d.ts.map

package/dist/types/dwn-discovery-file.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"dwn-discovery-file.d.ts","sourceRoot":"","sources":["../../src/dwn-discovery-file.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAMH;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IACjC,4EAA4E;IAC5E,QAAQ,EAAE,MAAM,CAAC;IACjB,mEAAmE;IACnE,GAAG,EAAE,MAAM,CAAC;IACZ;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;CACzB;AAED;;;;;GAKG;AACH,MAAM,WAAW,eAAe;IAC9B,qFAAqF;IACrF,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;IAC/C,qFAAqF;IACrF,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACzD,4EAA4E;IAC5E,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACxC,gEAAgE;IAChE,cAAc,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;IACrC,6DAA6D;IAC7D,OAAO,IAAI,MAAM,CAAC;CACnB;AAID;;;;GAIG;AACH,wBAAgB,yBAAyB,IAAI,eAAe,GAAG,SAAS,CA2DvE;AAID;;;GAGG;AACH,eAAO,MAAM,aAAa,WAAW,CAAC;AAEtC,sCAAsC;AACtC,eAAO,MAAM,kBAAkB,aAAa,CAAC;AAI7C;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,qBAAa,gBAAgB;IAC3B,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAkB;IACtC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAS;IAEnC;;;;OAIG;gBACS,EAAE,CAAC,EAAE,eAAe,EAAE,QAAQ,CAAC,EAAE,MAAM;IAoBnD,+CAA+C;IAC/C,IAAW,IAAI,IAAI,MAAM,CAExB;IAED;;;;;;;;;;OAUG;IACU,IAAI,IAAI,OAAO,CAAC,kBAAkB,GAAG,SAAS,CAAC;IAsC5D;;;;OAIG;IACU,KAAK,CAAC,MAAM,EAAE,kBAAkB,GAAG,OAAO,CAAC,IAAI,CAAC;IAc7D;;OAEG;IACU,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC;CAGrC"}

package/dist/types/dwn-discovery-payload.d.ts

@@ -0,0 +1,105 @@
+/**
+ * Shared types and utilities for the `dwn://register` discovery protocol.
+ *
+ * The payload is the JSON data exchanged between the local DWN server
+ * (electrobun-dwn) and the requesting app during the `dwn://register`
+ * redirect flow. It is encoded as base64url and placed in the URL
+ * fragment (`#`) of the callback URL.
+ *
+ * This module intentionally avoids external dependencies so it can be
+ * consumed from any environment (Bun, browser, Electrobun) without
+ * triggering transitive dependency resolution issues.
+ *
+ * @see https://github.com/enboxorg/enbox/issues/586
+ * @module
+ */
+/**
+ * The JSON payload delivered via the URL fragment in a `dwn://register`
+ * callback redirect.
+ *
+ * Intentionally minimal — everything beyond the endpoint (version,
+ * WebSocket support, etc.) is obtained from `GET {endpoint}/info`.
+ */
+export type DwnDiscoveryPayload = {
+    /** Base URL of the running DWN server (e.g. `"http://127.0.0.1:55557"`). */
+    endpoint: string;
+};
+/**
+ * Parsed result from a `dwn://register` URL.
+ */
+export type DwnRegisterUrlParams = {
+    /** The callback URL to redirect to with the discovery payload. */
+    callback: string;
+};
+/** The URL scheme for DWN discovery protocol handlers. */
+export declare const DWN_PROTOCOL_SCHEME = "dwn";
+/** The `dwn://register` path that triggers the discovery handshake. */
+export declare const DWN_REGISTER_PATH = "register";
+/**
+ * Build a `dwn://register?callback=<url>` URL that, when opened by the OS,
+ * triggers electrobun-dwn (or another `dwn://` scheme handler) to redirect
+ * back to `callbackUrl` with the local DWN endpoint in the URL fragment.
+ *
+ * This is the **trigger** side of the `dwn://register` browser flow.
+ * The web app opens this URL (e.g. via `window.open()` or `location.href`),
+ * the OS routes it to the registered handler, and the handler redirects
+ * back with the discovery payload.
+ *
+ * @param callbackUrl - The URL to redirect back to after discovery.
+ *   This should be the current page (or a dedicated callback page) that
+ *   will read the payload from `window.location.hash`.
+ * @returns The `dwn://register?callback=<encoded-url>` URL string.
+ *
+ * @example
+ * ```ts
+ * const registerUrl = buildDwnRegisterUrl('https://myapp.com/callback');
+ * // => 'dwn://register?callback=https%3A%2F%2Fmyapp.com%2Fcallback'
+ * window.open(registerUrl);
+ * ```
+ */
+export declare function buildDwnRegisterUrl(callbackUrl: string): string;
+/**
+ * Encode a {@link DwnDiscoveryPayload} as a base64url string suitable
+ * for use in a URL fragment.
+ *
+ * @param payload - The discovery payload to encode.
+ * @returns A base64url-encoded string (no padding).
+ */
+export declare function encodeDwnDiscoveryPayload(payload: DwnDiscoveryPayload): string;
+/**
+ * Decode a base64url-encoded string back into a {@link DwnDiscoveryPayload}.
+ *
+ * @param encoded - The base64url string from the URL fragment.
+ * @returns The parsed payload, or `undefined` if decoding or parsing fails.
+ */
+export declare function decodeDwnDiscoveryPayload(encoded: string): DwnDiscoveryPayload | undefined;
+/**
+ * Parse a `dwn://register?callback=<url>` URL into its components.
+ *
+ * @param url - The full `dwn://register?callback=...` URL.
+ * @returns The parsed parameters, or `undefined` if the URL is not a
+ *   valid `dwn://register` URL or is missing the `callback` parameter.
+ */
+export declare function parseDwnRegisterUrl(url: string): DwnRegisterUrlParams | undefined;
+/**
+ * Build the full callback redirect URL with the discovery payload
+ * encoded in the URL fragment.
+ *
+ * @param callbackUrl - The callback URL from the `dwn://register` request.
+ * @param payload - The discovery payload to encode in the fragment.
+ * @returns The full redirect URL (e.g. `https://notes.sh/dwn#eyJ...`).
+ */
+export declare function buildDwnDiscoveryRedirectUrl(callbackUrl: string, payload: DwnDiscoveryPayload): string;
+/**
+ * Read a {@link DwnDiscoveryPayload} from a URL's fragment (hash).
+ *
+ * Intended for use in the browser callback page that receives the
+ * redirect from electrobun-dwn.
+ *
+ * @param url - The full URL including the `#` fragment, or just the
+ *   fragment string (with or without the leading `#`).
+ * @returns The parsed payload, or `undefined` if the fragment is missing
+ *   or contains an invalid payload.
+ */
+export declare function readDwnDiscoveryPayloadFromUrl(url: string): DwnDiscoveryPayload | undefined;
+//# sourceMappingURL=dwn-discovery-payload.d.ts.map

package/dist/types/dwn-discovery-payload.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"dwn-discovery-payload.d.ts","sourceRoot":"","sources":["../../src/dwn-discovery-payload.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAIH;;;;;;GAMG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC,4EAA4E;IAC5E,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC,kEAAkE;IAClE,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAIF,0DAA0D;AAC1D,eAAO,MAAM,mBAAmB,QAAQ,CAAC;AAEzC,uEAAuE;AACvE,eAAO,MAAM,iBAAiB,aAAa,CAAC;AAI5C;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAgB,mBAAmB,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,CAE/D;AAID;;;;;;GAMG;AACH,wBAAgB,yBAAyB,CAAC,OAAO,EAAE,mBAAmB,GAAG,MAAM,CAG9E;AAED;;;;;GAKG;AACH,wBAAgB,yBAAyB,CAAC,OAAO,EAAE,MAAM,GAAG,mBAAmB,GAAG,SAAS,CAa1F;AAID;;;;;;GAMG;AACH,wBAAgB,mBAAmB,CAAC,GAAG,EAAE,MAAM,GAAG,oBAAoB,GAAG,SAAS,CAkCjF;AAED;;;;;;;GAOG;AACH,wBAAgB,4BAA4B,CAC1C,WAAW,EAAE,MAAM,EACnB,OAAO,EAAE,mBAAmB,GAC3B,MAAM,CAKR;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,8BAA8B,CAAC,GAAG,EAAE,MAAM,GAAG,mBAAmB,GAAG,SAAS,CAa3F"}

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

@@ -1,6 +1,6 @@
 import type { DerivedPrivateJwk, EncryptionInput, EncryptionKeyDeriver, KeyDecrypter, RecordsWriteMessage } from '@enbox/dwn-sdk-js';
 import type { KeyIdentifier, PublicKeyJwk } from '@enbox/crypto';
-import type { Web5PlatformAgent } from './types/agent.js';
+import type { EnboxPlatformAgent } from './types/agent.js';
 import type { DwnMessageReply, ProcessDwnRequest, SendDwnRequest } from './types/dwn.js';
 import { ContentEncryptionAlgorithm, KeyDerivationScheme } from '@enbox/dwn-sdk-js';
 import { DwnInterface } from './types/dwn.js';
@@ -37,7 +37,7 @@ export declare function encryptAndComputeCid(plaintextBytes: Uint8Array, dek: Ui
  *          and publicKeyJwk. No private key material is returned.
  * @throws If the DID has no keyAgreement verification method or it's not X25519.
  */
-export declare function getEncryptionKeyInfo(agent: Web5PlatformAgent, didUri: string): Promise<{
+export declare function getEncryptionKeyInfo(agent: EnboxPlatformAgent, didUri: string): Promise<{
     keyId: string;
     keyUri: KeyIdentifier;
     publicKeyJwk: PublicKeyJwk;
@@ -54,7 +54,7 @@ export declare function getEncryptionKeyInfo(agent: Web5PlatformAgent, didUri: s
  * @param dek - Data encryption key
  * @param iv - Initialization vector
  */
-export declare function deriveContextEncryptionInput(agent: Web5PlatformAgent, didUri: string, contextId: string, dek: Uint8Array, iv: Uint8Array): Promise<{
+export declare function deriveContextEncryptionInput(agent: EnboxPlatformAgent, didUri: string, contextId: string, dek: Uint8Array, iv: Uint8Array): Promise<{
     encryptionInput: Omit<EncryptionInput, 'authenticationTag'>;
     keyId: string;
     keyUri: KeyIdentifier;
@@ -69,7 +69,7 @@ export declare function deriveContextEncryptionInput(agent: Web5PlatformAgent, d
  * @param keyUri - The KMS key URI
  * @param derivationScheme - The key derivation scheme
  */
-export declare function buildKmsDecryptCallback(agent: Web5PlatformAgent, keyId: string, keyUri: KeyIdentifier, derivationScheme: typeof KeyDerivationScheme.ProtocolPath | typeof KeyDerivationScheme.ProtocolContext): KeyDecrypter;
+export declare function buildKmsDecryptCallback(agent: EnboxPlatformAgent, keyId: string, keyUri: KeyIdentifier, derivationScheme: typeof KeyDerivationScheme.ProtocolPath | typeof KeyDerivationScheme.ProtocolContext): KeyDecrypter;
 /**
  * Constructs an EncryptionKeyDeriver callback for the SDK.
  * The SDK calls derivePublicKey(path), the KMS performs HKDF + public key
@@ -81,7 +81,7 @@ export declare function buildKmsDecryptCallback(agent: Web5PlatformAgent, keyId:
  * @param didUri - The DID URI to create the key deriver for
  * @returns An EncryptionKeyDeriver callback object
  */
-export declare function getEncryptionKeyDeriver(agent: Web5PlatformAgent, didUri: string): Promise<EncryptionKeyDeriver>;
+export declare function getEncryptionKeyDeriver(agent: EnboxPlatformAgent, didUri: string): Promise<EncryptionKeyDeriver>;
 /**
  * Constructs a ProtocolPath KeyDecrypter.
  *
@@ -89,7 +89,7 @@ export declare function getEncryptionKeyDeriver(agent: Web5PlatformAgent, didUri
  * @param didUri - The DID URI to create the key decrypter for
  * @returns A KeyDecrypter callback object
  */
-export declare function getKeyDecrypter(agent: Web5PlatformAgent, didUri: string): Promise<KeyDecrypter>;
+export declare function getKeyDecrypter(agent: EnboxPlatformAgent, didUri: string): Promise<KeyDecrypter>;
 /**
  * Builds a KeyDecrypter from a context-derived private key.
  * Uses the raw key directly (since it was shared with us via the key-delivery protocol).
@@ -112,7 +112,7 @@ export declare function buildContextKeyDecrypter(contextKey: DerivedPrivateJwk):
  * @param contextDerivedKeyCache - Cache for context-derived private keys
  * @param fetchContextKeyRecordFn - Function to fetch context key records from key-delivery protocol
  */
-export declare function resolveKeyDecrypter(agent: Web5PlatformAgent, authorDid: string, recordsWrite: RecordsWriteMessage, targetDid: string | undefined, contextDerivedKeyCache: {
+export declare function resolveKeyDecrypter(agent: EnboxPlatformAgent, authorDid: string, recordsWrite: RecordsWriteMessage, targetDid: string | undefined, contextDerivedKeyCache: {
     get(key: string): DerivedPrivateJwk | undefined;
     set(key: string, value: DerivedPrivateJwk): void;
 }, fetchContextKeyRecordFn: (params: {
@@ -132,7 +132,7 @@ export declare function resolveKeyDecrypter(agent: Web5PlatformAgent, authorDid:
  * @param contextDerivedKeyCache - Cache for context-derived private keys
  * @param fetchContextKeyRecordFn - Function to fetch context key records
  */
-export declare function maybeDecryptReply<T extends DwnInterface>(request: ProcessDwnRequest<T> | SendDwnRequest<T>, reply: DwnMessageReply[T], agent: Web5PlatformAgent, contextDerivedKeyCache: {
+export declare function maybeDecryptReply<T extends DwnInterface>(request: ProcessDwnRequest<T> | SendDwnRequest<T>, reply: DwnMessageReply[T], agent: EnboxPlatformAgent, contextDerivedKeyCache: {
     get(key: string): DerivedPrivateJwk | undefined;
     set(key: string, value: DerivedPrivateJwk): void;
 }, fetchContextKeyRecordFn: (params: {

package/dist/types/dwn-encryption.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"dwn-encryption.d.ts","sourceRoot":"","sources":["../../src/dwn-encryption.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,iBAAiB,EACjB,eAAe,EACf,oBAAoB,EACpB,YAAY,EAGZ,mBAAmB,EACpB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,KAAK,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAEjE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AAC1D,OAAO,KAAK,EACV,eAAe,EACf,iBAAiB,EACjB,cAAc,EACf,MAAM,gBAAgB,CAAC;AAGxB,OAAO,EAEL,0BAA0B,EAI1B,mBAAmB,EAEpB,MAAM,mBAAmB,CAAC;AAE3B,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAG9C;;;GAGG;AACH,wBAAgB,QAAQ,CAAC,SAAS,EAAE,0BAA0B,GAAG,MAAM,CAEtE;AAED;;;;GAIG;AACH,wBAAgB,oBAAoB,CAClC,GAAG,EAAE,UAAU,EACf,EAAE,EAAE,UAAU,EACd,WAAW,EAAE,MAAM,EACnB,SAAS,EAAE,YAAY,EACvB,gBAAgB,EAAE,OAAO,mBAAmB,CAAC,YAAY,GAAG,OAAO,mBAAmB,CAAC,eAAe,GACrG,IAAI,CAAC,eAAe,EAAE,mBAAmB,CAAC,CAU5C;AAED;;;;GAIG;AACH,wBAAsB,oBAAoB,CACxC,cAAc,EAAE,UAAU,EAC1B,GAAG,EAAE,UAAU,EACf,EAAE,EAAE,UAAU,EACd,SAAS,GAAE,0BAA+D,GACzE,OAAO,CAAC;IAAE,cAAc,EAAE,UAAU,CAAC;IAAC,OAAO,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAC;IAAC,iBAAiB,EAAE,UAAU,CAAA;CAAE,CAAC,CAQ3G;AAED;;;;;;;;;;GAUG;AACH,wBAAsB,oBAAoB,CACxC,KAAK,EAAE,iBAAiB,EACxB,MAAM,EAAE,MAAM,GACb,OAAO,CAAC;IACT,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,aAAa,CAAC;IACtB,YAAY,EAAE,YAAY,CAAC;CAC5B,CAAC,CA0DD;AAED;;;;;;;;;;;GAWG;AACH,wBAAsB,4BAA4B,CAChD,KAAK,EAAE,iBAAiB,EACxB,MAAM,EAAE,MAAM,EACd,SAAS,EAAE,MAAM,EACjB,GAAG,EAAE,UAAU,EACf,EAAE,EAAE,UAAU,GACb,OAAO,CAAC;IACT,eAAe,EAAE,IAAI,CAAC,eAAe,EAAE,mBAAmB,CAAC,CAAC;IAC5D,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,aAAa,CAAC;IACtB,qBAAqB,EAAE,MAAM,EAAE,CAAC;CACjC,CAAC,CAcD;AAED;;;;;;;;GAQG;AACH,wBAAgB,uBAAuB,CACrC,KAAK,EAAE,iBAAiB,EACxB,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,aAAa,EACrB,gBAAgB,EAAE,OAAO,mBAAmB,CAAC,YAAY,GAAG,OAAO,mBAAmB,CAAC,eAAe,GACrG,YAAY,CAcd;AAED;;;;;;;;;;GAUG;AACH,wBAAsB,uBAAuB,CAC3C,KAAK,EAAE,iBAAiB,EACxB,MAAM,EAAE,MAAM,GACb,OAAO,CAAC,oBAAoB,CAAC,CAc/B;AAED;;;;;;GAMG;AACH,wBAAsB,eAAe,CACnC,KAAK,EAAE,iBAAiB,EACxB,MAAM,EAAE,MAAM,GACb,OAAO,CAAC,YAAY,CAAC,CAGvB;AAED;;;;;GAKG;AACH,wBAAgB,wBAAwB,CACtC,UAAU,EAAE,iBAAiB,GAC5B,YAAY,CAYd;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAsB,mBAAmB,CACvC,KAAK,EAAE,iBAAiB,EACxB,SAAS,EAAE,MAAM,EACjB,YAAY,EAAE,mBAAmB,EACjC,SAAS,EAAE,MAAM,GAAG,SAAS,EAC7B,sBAAsB,EAAE;IAAE,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,iBAAiB,GAAG,SAAS,CAAC;IAAC,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,iBAAiB,GAAG,IAAI,CAAA;CAAE,EAC7H,uBAAuB,EAAE,CAAC,MAAM,EAAE;IAChC,QAAQ,EAAE,MAAM,CAAC;IACjB,YAAY,EAAE,MAAM,CAAC;IACrB,cAAc,EAAE,MAAM,CAAC;IACvB,eAAe,EAAE,MAAM,CAAC;CACzB,KAAK,OAAO,CAAC,iBAAiB,GAAG,SAAS,CAAC,GAC3C,OAAO,CAAC,YAAY,CAAC,CAuEvB;AAED;;;;;;;;;;GAUG;AACH,wBAAsB,iBAAiB,CAAC,CAAC,SAAS,YAAY,EAC5D,OAAO,EAAE,iBAAiB,CAAC,CAAC,CAAC,GAAG,cAAc,CAAC,CAAC,CAAC,EACjD,KAAK,EAAE,eAAe,CAAC,CAAC,CAAC,EACzB,KAAK,EAAE,iBAAiB,EACxB,sBAAsB,EAAE;IAAE,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,iBAAiB,GAAG,SAAS,CAAC;IAAC,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,iBAAiB,GAAG,IAAI,CAAA;CAAE,EAC7H,uBAAuB,EAAE,CAAC,MAAM,EAAE;IAChC,QAAQ,EAAE,MAAM,CAAC;IACjB,YAAY,EAAE,MAAM,CAAC;IACrB,cAAc,EAAE,MAAM,CAAC;IACvB,eAAe,EAAE,MAAM,CAAC;CACzB,KAAK,OAAO,CAAC,iBAAiB,GAAG,SAAS,CAAC,GAC3C,OAAO,CAAC,IAAI,CAAC,CA6Df"}
+{"version":3,"file":"dwn-encryption.d.ts","sourceRoot":"","sources":["../../src/dwn-encryption.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,iBAAiB,EACjB,eAAe,EACf,oBAAoB,EACpB,YAAY,EAGZ,mBAAmB,EACpB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,KAAK,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAEjE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AAC3D,OAAO,KAAK,EACV,eAAe,EACf,iBAAiB,EACjB,cAAc,EACf,MAAM,gBAAgB,CAAC;AAGxB,OAAO,EAEL,0BAA0B,EAI1B,mBAAmB,EAEpB,MAAM,mBAAmB,CAAC;AAE3B,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAG9C;;;GAGG;AACH,wBAAgB,QAAQ,CAAC,SAAS,EAAE,0BAA0B,GAAG,MAAM,CAEtE;AAED;;;;GAIG;AACH,wBAAgB,oBAAoB,CAClC,GAAG,EAAE,UAAU,EACf,EAAE,EAAE,UAAU,EACd,WAAW,EAAE,MAAM,EACnB,SAAS,EAAE,YAAY,EACvB,gBAAgB,EAAE,OAAO,mBAAmB,CAAC,YAAY,GAAG,OAAO,mBAAmB,CAAC,eAAe,GACrG,IAAI,CAAC,eAAe,EAAE,mBAAmB,CAAC,CAU5C;AAED;;;;GAIG;AACH,wBAAsB,oBAAoB,CACxC,cAAc,EAAE,UAAU,EAC1B,GAAG,EAAE,UAAU,EACf,EAAE,EAAE,UAAU,EACd,SAAS,GAAE,0BAA+D,GACzE,OAAO,CAAC;IAAE,cAAc,EAAE,UAAU,CAAC;IAAC,OAAO,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAC;IAAC,iBAAiB,EAAE,UAAU,CAAA;CAAE,CAAC,CAQ3G;AAED;;;;;;;;;;GAUG;AACH,wBAAsB,oBAAoB,CACxC,KAAK,EAAE,kBAAkB,EACzB,MAAM,EAAE,MAAM,GACb,OAAO,CAAC;IACT,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,aAAa,CAAC;IACtB,YAAY,EAAE,YAAY,CAAC;CAC5B,CAAC,CA0DD;AAED;;;;;;;;;;;GAWG;AACH,wBAAsB,4BAA4B,CAChD,KAAK,EAAE,kBAAkB,EACzB,MAAM,EAAE,MAAM,EACd,SAAS,EAAE,MAAM,EACjB,GAAG,EAAE,UAAU,EACf,EAAE,EAAE,UAAU,GACb,OAAO,CAAC;IACT,eAAe,EAAE,IAAI,CAAC,eAAe,EAAE,mBAAmB,CAAC,CAAC;IAC5D,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,aAAa,CAAC;IACtB,qBAAqB,EAAE,MAAM,EAAE,CAAC;CACjC,CAAC,CAcD;AAED;;;;;;;;GAQG;AACH,wBAAgB,uBAAuB,CACrC,KAAK,EAAE,kBAAkB,EACzB,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,aAAa,EACrB,gBAAgB,EAAE,OAAO,mBAAmB,CAAC,YAAY,GAAG,OAAO,mBAAmB,CAAC,eAAe,GACrG,YAAY,CAcd;AAED;;;;;;;;;;GAUG;AACH,wBAAsB,uBAAuB,CAC3C,KAAK,EAAE,kBAAkB,EACzB,MAAM,EAAE,MAAM,GACb,OAAO,CAAC,oBAAoB,CAAC,CAc/B;AAED;;;;;;GAMG;AACH,wBAAsB,eAAe,CACnC,KAAK,EAAE,kBAAkB,EACzB,MAAM,EAAE,MAAM,GACb,OAAO,CAAC,YAAY,CAAC,CAGvB;AAED;;;;;GAKG;AACH,wBAAgB,wBAAwB,CACtC,UAAU,EAAE,iBAAiB,GAC5B,YAAY,CAYd;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAsB,mBAAmB,CACvC,KAAK,EAAE,kBAAkB,EACzB,SAAS,EAAE,MAAM,EACjB,YAAY,EAAE,mBAAmB,EACjC,SAAS,EAAE,MAAM,GAAG,SAAS,EAC7B,sBAAsB,EAAE;IAAE,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,iBAAiB,GAAG,SAAS,CAAC;IAAC,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,iBAAiB,GAAG,IAAI,CAAA;CAAE,EAC7H,uBAAuB,EAAE,CAAC,MAAM,EAAE;IAChC,QAAQ,EAAE,MAAM,CAAC;IACjB,YAAY,EAAE,MAAM,CAAC;IACrB,cAAc,EAAE,MAAM,CAAC;IACvB,eAAe,EAAE,MAAM,CAAC;CACzB,KAAK,OAAO,CAAC,iBAAiB,GAAG,SAAS,CAAC,GAC3C,OAAO,CAAC,YAAY,CAAC,CAuEvB;AAED;;;;;;;;;;GAUG;AACH,wBAAsB,iBAAiB,CAAC,CAAC,SAAS,YAAY,EAC5D,OAAO,EAAE,iBAAiB,CAAC,CAAC,CAAC,GAAG,cAAc,CAAC,CAAC,CAAC,EACjD,KAAK,EAAE,eAAe,CAAC,CAAC,CAAC,EACzB,KAAK,EAAE,kBAAkB,EACzB,sBAAsB,EAAE;IAAE,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,iBAAiB,GAAG,SAAS,CAAC;IAAC,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,iBAAiB,GAAG,IAAI,CAAA;CAAE,EAC7H,uBAAuB,EAAE,CAAC,MAAM,EAAE;IAChC,QAAQ,EAAE,MAAM,CAAC;IACjB,YAAY,EAAE,MAAM,CAAC;IACrB,cAAc,EAAE,MAAM,CAAC;IACvB,eAAe,EAAE,MAAM,CAAC;CACzB,KAAK,OAAO,CAAC,iBAAiB,GAAG,SAAS,CAAC,GAC3C,OAAO,CAAC,IAAI,CAAC,CA6Df"}

package/dist/types/dwn-key-delivery.d.ts

@@ -1,6 +1,6 @@
 import type { PublicKeyJwk } from '@enbox/crypto';
 import type { DerivedPrivateJwk } from '@enbox/dwn-sdk-js';
-import type { Web5PlatformAgent } from './types/agent.js';
+import type { EnboxPlatformAgent } from './types/agent.js';
 import type { DwnMessage, DwnMessageReply, ProcessDwnRequest } from './types/dwn.js';
 import { DwnInterface } from './types/dwn.js';
 /**
@@ -43,7 +43,7 @@ type ProcessRequestFn = <T extends DwnInterface>(request: ProcessDwnRequest<T>)
  * @param getProtocolDefinition - Function to get a protocol definition
  * @param installedCache - Cache for installation status
  */
-export declare function ensureKeyDeliveryProtocol(agent: Web5PlatformAgent, tenantDid: string, processRequest: ProcessRequestFn, getProtocolDefinition: (tenantDid: string, protocolUri: string) => Promise<any>, installedCache: {
+export declare function ensureKeyDeliveryProtocol(agent: EnboxPlatformAgent, tenantDid: string, processRequest: ProcessRequestFn, getProtocolDefinition: (tenantDid: string, protocolUri: string) => Promise<any>, installedCache: {
     get(key: string): boolean | undefined;
     set(key: string, value: boolean): void;
     delete(key: string): void;
@@ -64,7 +64,7 @@ export declare function ensureKeyDeliveryProtocol(agent: Web5PlatformAgent, tena
  * @param eagerSend - Function to eagerly send the record to the remote DWN
  * @returns The recordId of the written contextKey record
  */
-export declare function writeContextKeyRecord(agent: Web5PlatformAgent, params: WriteContextKeyParams, processRequest: ProcessRequestFn, ensureProtocol: (tenantDid: string) => Promise<void>, eagerSend: (tenantDid: string, message: DwnMessage[DwnInterface.RecordsWrite]) => Promise<void>): Promise<string>;
+export declare function writeContextKeyRecord(agent: EnboxPlatformAgent, params: WriteContextKeyParams, processRequest: ProcessRequestFn, ensureProtocol: (tenantDid: string) => Promise<void>, eagerSend: (tenantDid: string, message: DwnMessage[DwnInterface.RecordsWrite]) => Promise<void>): Promise<string>;
 /**
  * Eagerly sends a contextKey record to the tenant's remote DWN.
  * This is best-effort — sync guarantees eventual consistency regardless.
@@ -74,8 +74,9 @@ export declare function writeContextKeyRecord(agent: Web5PlatformAgent, params:
  * @param contextKeyMessage - The context key message to send
  * @param getDwnMessage - Function to read a full message from local DWN
  * @param sendDwnRpcRequest - Function to send a DWN RPC request
+ * @param getDwnEndpointUrlsForTarget - Function to resolve DWN endpoint URLs (with local discovery)
  */
-export declare function eagerSendContextKeyRecord(agent: Web5PlatformAgent, tenantDid: string, contextKeyMessage: DwnMessage[DwnInterface.RecordsWrite], getDwnMessage: (params: {
+export declare function eagerSendContextKeyRecord(agent: EnboxPlatformAgent, tenantDid: string, contextKeyMessage: DwnMessage[DwnInterface.RecordsWrite], getDwnMessage: (params: {
     author: string;
     messageType: DwnInterface;
     messageCid: string;
@@ -87,7 +88,7 @@ export declare function eagerSendContextKeyRecord(agent: Web5PlatformAgent, tena
     dwnEndpointUrls: string[];
     message: any;
     data?: Blob;
-}) => Promise<any>): Promise<void>;
+}) => Promise<any>, getDwnEndpointUrlsForTarget: (targetDid: string) => Promise<string[]>): Promise<void>;
 /**
  * Fetches and decrypts a `contextKey` record from a DWN, returning the
  * `DerivedPrivateJwk` payload.
@@ -100,13 +101,14 @@ export declare function eagerSendContextKeyRecord(agent: Web5PlatformAgent, tena
  * @param processRequest - The agent's processRequest method (bound)
  * @param getSigner - Function to get a signer for a DID
  * @param sendDwnRpcRequest - Function to send a DWN RPC request
+ * @param getDwnEndpointUrlsForTarget - Function to resolve DWN endpoint URLs (with local discovery)
  * @returns The decrypted `DerivedPrivateJwk`, or `undefined` if no matching record found
  */
-export declare function fetchContextKeyRecord(agent: Web5PlatformAgent, params: FetchContextKeyParams, processRequest: ProcessRequestFn, getSigner: (author: string) => Promise<any>, sendDwnRpcRequest: (params: {
+export declare function fetchContextKeyRecord(agent: EnboxPlatformAgent, params: FetchContextKeyParams, processRequest: ProcessRequestFn, getSigner: (author: string) => Promise<any>, sendDwnRpcRequest: (params: {
     targetDid: string;
     dwnEndpointUrls: string[];
     message: any;
     data?: Blob;
-}) => Promise<any>): Promise<DerivedPrivateJwk | undefined>;
+}) => Promise<any>, getDwnEndpointUrlsForTarget: (targetDid: string) => Promise<string[]>): Promise<DerivedPrivateJwk | undefined>;
 export {};
 //# sourceMappingURL=dwn-key-delivery.d.ts.map

package/dist/types/dwn-key-delivery.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"dwn-key-delivery.d.ts","sourceRoot":"","sources":["../../src/dwn-key-delivery.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAClD,OAAO,KAAK,EACV,iBAAiB,EAIlB,MAAM,mBAAmB,CAAC;AAE3B,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AAC1D,OAAO,KAAK,EACV,UAAU,EACV,eAAe,EACf,iBAAiB,EAClB,MAAM,gBAAgB,CAAC;AAcxB,OAAO,EAAE,YAAY,EAA0B,MAAM,gBAAgB,CAAC;AAEtE;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,EAAE,MAAM,CAAC;IACrB,cAAc,EAAE,iBAAiB,CAAC;IAClC,cAAc,EAAE,MAAM,CAAC;IACvB,eAAe,EAAE,MAAM,CAAC;IACxB,6BAA6B,CAAC,EAAE;QAAE,SAAS,EAAE,MAAM,CAAC;QAAC,YAAY,EAAE,YAAY,CAAA;KAAE,CAAC;CACnF,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC,QAAQ,EAAE,MAAM,CAAC;IACjB,YAAY,EAAE,MAAM,CAAC;IACrB,cAAc,EAAE,MAAM,CAAC;IACvB,eAAe,EAAE,MAAM,CAAC;CACzB,CAAC;AAEF,wEAAwE;AACxE,KAAK,gBAAgB,GAAG,CAAC,CAAC,SAAS,YAAY,EAC7C,OAAO,EAAE,iBAAiB,CAAC,CAAC,CAAC,KAC1B,OAAO,CAAC;IAAE,KAAK,EAAE,eAAe,CAAC,CAAC,CAAC,CAAC;IAAC,OAAO,CAAC,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC;IAAC,UAAU,EAAE,MAAM,CAAA;CAAE,CAAC,CAAC;AAEzF;;;;;;;;;;GAUG;AACH,wBAAsB,yBAAyB,CAC7C,KAAK,EAAE,iBAAiB,EACxB,SAAS,EAAE,MAAM,EACjB,cAAc,EAAE,gBAAgB,EAChC,qBAAqB,EAAE,CAAC,SAAS,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,KAAK,OAAO,CAAC,GAAG,CAAC,EAC/E,cAAc,EAAE;IAAE,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS,CAAC;IAAC,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,GAAG,IAAI,CAAC;IAAC,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAAA;CAAE,EAC5H,uBAAuB,EAAE;IAAE,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAAA;CAAE,GACrD,OAAO,CAAC,IAAI,CAAC,CAgCf;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAsB,qBAAqB,CACzC,KAAK,EAAE,iBAAiB,EACxB,MAAM,EAAE,qBAAqB,EAC7B,cAAc,EAAE,gBAAgB,EAChC,cAAc,EAAE,CAAC,SAAS,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,EACpD,SAAS,EAAE,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,CAAC,YAAY,CAAC,YAAY,CAAC,KAAK,OAAO,CAAC,IAAI,CAAC,GAC9F,OAAO,CAAC,MAAM,CAAC,CAkFjB;AAED;;;;;;;;;GASG;AACH,wBAAsB,yBAAyB,CAC7C,KAAK,EAAE,iBAAiB,EACxB,SAAS,EAAE,MAAM,EACjB,iBAAiB,EAAE,UAAU,CAAC,YAAY,CAAC,YAAY,CAAC,EACxD,aAAa,EAAE,CAAC,MAAM,EAAE;IAAE,MAAM,EAAE,MAAM,CAAC;IAAC,WAAW,EAAE,YAAY,CAAC;IAAC,UAAU,EAAE,MAAM,CAAA;CAAE,KAAK,OAAO,CAAC;IAAE,OAAO,EAAE,GAAG,CAAC;IAAC,IAAI,CAAC,EAAE,IAAI,CAAA;CAAE,CAAC,EACpI,iBAAiB,EAAE,CAAC,MAAM,EAAE;IAAE,SAAS,EAAE,MAAM,CAAC;IAAC,eAAe,EAAE,MAAM,EAAE,CAAC;IAAC,OAAO,EAAE,GAAG,CAAC;IAAC,IAAI,CAAC,EAAE,IAAI,CAAA;CAAE,KAAK,OAAO,CAAC,GAAG,CAAC,GACvH,OAAO,CAAC,IAAI,CAAC,CA0Bf;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAsB,qBAAqB,CACzC,KAAK,EAAE,iBAAiB,EACxB,MAAM,EAAE,qBAAqB,EAC7B,cAAc,EAAE,gBAAgB,EAChC,SAAS,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,OAAO,CAAC,GAAG,CAAC,EAC3C,iBAAiB,EAAE,CAAC,MAAM,EAAE;IAAE,SAAS,EAAE,MAAM,CAAC;IAAC,eAAe,EAAE,MAAM,EAAE,CAAC;IAAC,OAAO,EAAE,GAAG,CAAC;IAAC,IAAI,CAAC,EAAE,IAAI,CAAA;CAAE,KAAK,OAAO,CAAC,GAAG,CAAC,GACvH,OAAO,CAAC,iBAAiB,GAAG,SAAS,CAAC,CA6FxC"}
+{"version":3,"file":"dwn-key-delivery.d.ts","sourceRoot":"","sources":["../../src/dwn-key-delivery.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAClD,OAAO,KAAK,EACV,iBAAiB,EAIlB,MAAM,mBAAmB,CAAC;AAE3B,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AAC3D,OAAO,KAAK,EACV,UAAU,EACV,eAAe,EACf,iBAAiB,EAClB,MAAM,gBAAgB,CAAC;AAaxB,OAAO,EAAE,YAAY,EAA0B,MAAM,gBAAgB,CAAC;AAEtE;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,EAAE,MAAM,CAAC;IACrB,cAAc,EAAE,iBAAiB,CAAC;IAClC,cAAc,EAAE,MAAM,CAAC;IACvB,eAAe,EAAE,MAAM,CAAC;IACxB,6BAA6B,CAAC,EAAE;QAAE,SAAS,EAAE,MAAM,CAAC;QAAC,YAAY,EAAE,YAAY,CAAA;KAAE,CAAC;CACnF,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC,QAAQ,EAAE,MAAM,CAAC;IACjB,YAAY,EAAE,MAAM,CAAC;IACrB,cAAc,EAAE,MAAM,CAAC;IACvB,eAAe,EAAE,MAAM,CAAC;CACzB,CAAC;AAEF,wEAAwE;AACxE,KAAK,gBAAgB,GAAG,CAAC,CAAC,SAAS,YAAY,EAC7C,OAAO,EAAE,iBAAiB,CAAC,CAAC,CAAC,KAC1B,OAAO,CAAC;IAAE,KAAK,EAAE,eAAe,CAAC,CAAC,CAAC,CAAC;IAAC,OAAO,CAAC,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC;IAAC,UAAU,EAAE,MAAM,CAAA;CAAE,CAAC,CAAC;AAEzF;;;;;;;;;;GAUG;AACH,wBAAsB,yBAAyB,CAC7C,KAAK,EAAE,kBAAkB,EACzB,SAAS,EAAE,MAAM,EACjB,cAAc,EAAE,gBAAgB,EAChC,qBAAqB,EAAE,CAAC,SAAS,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,KAAK,OAAO,CAAC,GAAG,CAAC,EAC/E,cAAc,EAAE;IAAE,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS,CAAC;IAAC,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,GAAG,IAAI,CAAC;IAAC,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAAA;CAAE,EAC5H,uBAAuB,EAAE;IAAE,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAAA;CAAE,GACrD,OAAO,CAAC,IAAI,CAAC,CAgCf;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAsB,qBAAqB,CACzC,KAAK,EAAE,kBAAkB,EACzB,MAAM,EAAE,qBAAqB,EAC7B,cAAc,EAAE,gBAAgB,EAChC,cAAc,EAAE,CAAC,SAAS,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,EACpD,SAAS,EAAE,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,CAAC,YAAY,CAAC,YAAY,CAAC,KAAK,OAAO,CAAC,IAAI,CAAC,GAC9F,OAAO,CAAC,MAAM,CAAC,CAkFjB;AAED;;;;;;;;;;GAUG;AACH,wBAAsB,yBAAyB,CAC7C,KAAK,EAAE,kBAAkB,EACzB,SAAS,EAAE,MAAM,EACjB,iBAAiB,EAAE,UAAU,CAAC,YAAY,CAAC,YAAY,CAAC,EACxD,aAAa,EAAE,CAAC,MAAM,EAAE;IAAE,MAAM,EAAE,MAAM,CAAC;IAAC,WAAW,EAAE,YAAY,CAAC;IAAC,UAAU,EAAE,MAAM,CAAA;CAAE,KAAK,OAAO,CAAC;IAAE,OAAO,EAAE,GAAG,CAAC;IAAC,IAAI,CAAC,EAAE,IAAI,CAAA;CAAE,CAAC,EACpI,iBAAiB,EAAE,CAAC,MAAM,EAAE;IAAE,SAAS,EAAE,MAAM,CAAC;IAAC,eAAe,EAAE,MAAM,EAAE,CAAC;IAAC,OAAO,EAAE,GAAG,CAAC;IAAC,IAAI,CAAC,EAAE,IAAI,CAAA;CAAE,KAAK,OAAO,CAAC,GAAG,CAAC,EACxH,2BAA2B,EAAE,CAAC,SAAS,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,EAAE,CAAC,GACpE,OAAO,CAAC,IAAI,CAAC,CA0Bf;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAsB,qBAAqB,CACzC,KAAK,EAAE,kBAAkB,EACzB,MAAM,EAAE,qBAAqB,EAC7B,cAAc,EAAE,gBAAgB,EAChC,SAAS,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,OAAO,CAAC,GAAG,CAAC,EAC3C,iBAAiB,EAAE,CAAC,MAAM,EAAE;IAAE,SAAS,EAAE,MAAM,CAAC;IAAC,eAAe,EAAE,MAAM,EAAE,CAAC;IAAC,OAAO,EAAE,GAAG,CAAC;IAAC,IAAI,CAAC,EAAE,IAAI,CAAA;CAAE,KAAK,OAAO,CAAC,GAAG,CAAC,EACxH,2BAA2B,EAAE,CAAC,SAAS,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,EAAE,CAAC,GACpE,OAAO,CAAC,iBAAiB,GAAG,SAAS,CAAC,CA6FxC"}