@enbox/api 0.1.1 → 0.2.0

package/dist/esm/web5.js

@@ -23,11 +23,14 @@ var __rest = (this && this.__rest) || function (s, e) {
         }
     return t;
 };
-import { DwnRegistrar } from '@enbox/dwn-clients';
-import { WalletConnect, Web5UserAgent } from '@enbox/agent';
+import { AnonymousDwnApi, WalletConnect, Web5UserAgent } from '@enbox/agent';
+import { DidDht, DidJwk, DidKey, DidResolverCacheMemory, DidWeb, UniversalResolver } from '@enbox/dids';
+import { DwnRegistrar, Web5RpcClient } from '@enbox/dwn-clients';
 import { DidApi } from './did-api.js';
 import { DwnApi } from './dwn-api.js';
+import { DwnReaderApi } from './dwn-reader-api.js';
 import { PermissionGrant } from './permission-grant.js';
+import { TypedWeb5 } from './typed-web5.js';
 import { VcApi } from './vc-api.js';
 /**
  * The main Web5 API interface. It manages the creation of a DID if needed, the connection to the
@@ -37,9 +40,74 @@ export class Web5 {
     constructor({ agent, connectedDid, delegateDid }) {
         this.agent = agent;
         this.did = new DidApi({ agent, connectedDid });
-        this.dwn = new DwnApi({ agent, connectedDid, delegateDid });
+        this._dwn = new DwnApi({ agent, connectedDid, delegateDid });
         this.vc = new VcApi({ agent, connectedDid });
     }
+    /**
+     * Returns a {@link TypedWeb5} instance scoped to the given protocol.
+     *
+     * This is the **primary developer interface** for interacting with
+     * protocol-backed records. It auto-injects the protocol URI, protocolPath,
+     * and schema into every operation, and provides compile-time path
+     * autocompletion plus typed data payloads via the schema map.
+     *
+     * @param protocol - A typed protocol created via `defineProtocol()`.
+     * @returns A `TypedWeb5` instance bound to the given protocol.
+     *
+     * @example
+     * ```ts
+     * const social = web5.using(SocialProtocol);
+     *
+     * await social.configure();
+     *
+     * const { record } = await social.records.write('friend', {
+     *   data: { did: 'did:example:alice', alias: 'Alice' },
+     * });
+     *
+     * const { records } = await social.records.query('friend');
+     * ```
+     */
+    using(protocol) {
+        return new TypedWeb5(this._dwn, protocol);
+    }
+    /**
+     * Creates a lightweight, read-only Web5 instance for querying public DWN data.
+     *
+     * No identity, vault, password, or signing keys are required. The returned
+     * API supports querying and reading published records and protocols from any
+     * remote DWN, using **unsigned** (anonymous) DWN messages.
+     *
+     * @param options - Optional configuration overrides.
+     * @returns A {@link Web5AnonymousApi} with a read-only `dwn` property.
+     *
+     * @example
+     * ```ts
+     * const { dwn } = Web5.anonymous();
+     *
+     * const { records } = await dwn.records.query({
+     *   from: 'did:dht:alice...',
+     *   filter: { protocol: 'https://social.example/posts', protocolPath: 'post' },
+     * });
+     *
+     * for (const record of records) {
+     *   console.log(record.id, await record.data.text());
+     * }
+     * ```
+     *
+     * @beta
+     */
+    static anonymous(options) {
+        var _a;
+        const didResolver = new UniversalResolver({
+            didResolvers: (_a = options === null || options === void 0 ? void 0 : options.didResolvers) !== null && _a !== void 0 ? _a : [DidDht, DidJwk, DidKey, DidWeb],
+            cache: new DidResolverCacheMemory(),
+        });
+        const rpcClient = new Web5RpcClient();
+        const anonymousDwn = new AnonymousDwnApi({ didResolver, rpcClient });
+        return {
+            dwn: new DwnReaderApi(anonymousDwn),
+        };
+    }
     /**
      * Connects to a {@link Web5Agent}. Defaults to creating a local {@link Web5UserAgent} if one
      * isn't provided.

package/dist/esm/web5.js.map

@@ -1 +1 @@
-{"version":3,"file":"web5.js","sourceRoot":"","sources":["../../src/web5.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,2CAA2C;;;;;;;;;;;;;;;;;;;;;AAc3C,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAClD,OAAO,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAE5D,OAAO,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AACtC,OAAO,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AACtC,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AACxD,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AA+LpC;;;GAGG;AACH,MAAM,OAAO,IAAI;IAgBf,YAAY,EAAE,KAAK,EAAE,YAAY,EAAE,WAAW,EAAc;QAC1D,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,GAAG,GAAG,IAAI,MAAM,CAAC,EAAE,KAAK,EAAE,YAAY,EAAE,CAAC,CAAC;QAC/C,IAAI,CAAC,GAAG,GAAG,IAAI,MAAM,CAAC,EAAE,KAAK,EAAE,YAAY,EAAE,WAAW,EAAE,CAAC,CAAC;QAC5D,IAAI,CAAC,EAAE,GAAG,IAAI,KAAK,CAAC,EAAE,KAAK,EAAE,YAAY,EAAE,CAAC,CAAC;IAC/C,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CAAO,OAAO;6DAAC,EACnB,KAAK,EACL,UAAU,EACV,YAAY,EACZ,QAAQ,EACR,cAAc,EACd,IAAI,EACJ,WAAW,EACX,gBAAgB,EAChB,YAAY,EACZ,oBAAoB,MACE,EAAE;;YACxB,IAAI,WAA+B,CAAC;YACpC,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;gBACxB,IAAI,YAAY,GAAG,KAAK,CAAC;gBACzB,0FAA0F;gBAC1F,MAAM,SAAS,GAAG,MAAM,aAAa,CAAC,MAAM,CAAC,EAAE,UAAU,EAAE,CAAC,CAAC;gBAC7D,KAAK,GAAG,SAAS,CAAC;gBAElB,4FAA4F;gBAC5F,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;oBAC3B,QAAQ,GAAG,wBAAwB,CAAC;oBACpC,OAAO,CAAC,IAAI,CACV,wBAAwB;wBACxB,4EAA4E;wBAC5E,4DAA4D;wBAC5D,6CAA6C,EAC7C,gCAAgC,EAChC,sCAAsC,CACvC,CAAC;gBACJ,CAAC;gBAED,+DAA+D;gBAC/D,MAAM,oBAAoB,GAAG,MAAA,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,YAAY,mCAAI,gBAAgB,aAAhB,gBAAgB,uBAAhB,gBAAgB,CAAE,YAAY,mCAAI,CAAC,2BAA2B,CAAC,CAAC;gBAE1H,iDAAiD;gBACjD,IAAI,MAAM,SAAS,CAAC,WAAW,EAAE,EAAE,CAAC;oBAClC,cAAc,GAAG,MAAM,SAAS,CAAC,UAAU,CAAC,EAAE,QAAQ,EAAE,cAAc,EAAE,YAAY,EAAE,oBAAoB,EAAE,CAAC,CAAC;gBAChH,CAAC;gBACD,MAAM,SAAS,CAAC,KAAK,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC;gBACpC,2DAA2D;gBAC3D,MAAM,iBAAiB,GAAmB,MAAM,SAAS,CAAC,QAAQ,CAAC,iBAAiB,EAAE,CAAC;gBACvF,IAAI,QAAwB,CAAC;gBAC7B,IAAI,kBAAkB,GAAa,EAAE,CAAC;gBACtC,IAAI,iBAAiB,EAAE,CAAC;oBACtB,2CAA2C;oBAC3C,yHAAyH;oBACzH,QAAQ,GAAG,iBAAiB,CAAC;gBAC/B,CAAC;qBAAM,IAAI,oBAAoB,EAAE,CAAC;oBAChC,IAAI,IAAI,KAAK,KAAK,EAAE,CAAC;wBACnB,mEAAmE;wBACnE,mHAAmH;wBACnH,MAAM,IAAI,KAAK,CAAC,oDAAoD,CAAC,CAAC;oBACxE,CAAC;oBAED,6FAA6F;oBAC7F,YAAY,GAAG,IAAI,CAAC;oBAEpB,yHAAyH;oBACzH,IAAI,CAAC;wBACH,MAAM,EAAE,kBAAkB,KAAwB,oBAAoB,EAAvC,cAAc,UAAK,oBAAoB,EAAhE,sBAAyC,CAAuB,CAAC;wBACvE,MAAM,wBAAwB,GAAG,kBAAkB,CAAC,GAAG,CACrD,CAAC,EAAE,kBAAkB,EAAE,WAAW,EAAE,EAAE,EAAE,CACtC,aAAa,CAAC,kCAAkC,CAAC;4BAC/C,UAAU,EAAI,kBAAkB;4BAChC,WAAW,EAAG,WAAW,aAAX,WAAW,cAAX,WAAW,GAAI;gCAC3B,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,WAAW;6BAChD;yBACF,CAAC,CACL,CAAC;wBAEF,MAAM,EAAE,mBAAmB,EAAE,YAAY,EAAE,cAAc,EAAE,GAAG,MAAM,aAAa,CAAC,UAAU,iCACvF,cAAc,KACjB,kBAAkB,EAAE,wBAAwB,IAC5C,CAAC;wBAEH,6DAA6D;wBAC7D,+HAA+H;wBAC/H,QAAQ,GAAG,MAAM,SAAS,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,gBAAgB,EAAE;gCAC7D,WAAW,EAAG,mBAAmB;gCACjC,QAAQ,EAAM;oCACZ,YAAY;oCACZ,IAAI,EAAK,SAAS;oCAClB,GAAG,EAAM,mBAAmB,CAAC,GAAG;oCAChC,MAAM,EAAG,KAAK,CAAC,QAAQ,CAAC,GAAG;iCAC5B;6BACF,EAAE,CAAC,CAAC;wBAEL,yEAAyE;wBACzE,yDAAyD;wBACzD,wHAAwH;wBACxH,kBAAkB,GAAG,MAAM,IAAI,CAAC,sBAAsB,CAAC,EAAE,KAAK,EAAE,WAAW,EAAE,mBAAmB,CAAC,GAAG,EAAE,MAAM,EAAE,cAAc,EAAE,CAAC,CAAC;oBAClI,CAAC;oBAAC,OAAO,KAAS,EAAE,CAAC;wBACnB,0DAA0D;wBAC1D,uEAAuE;wBACvE,MAAM,IAAI,CAAC,eAAe,CAAC,EAAE,QAAQ,EAAE,SAAS,EAAE,CAAC,CAAC;wBACpD,MAAM,IAAI,KAAK,CAAC,gCAAgC,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;oBACnE,CAAC;gBACH,CAAC;qBAAM,CAAC;oBACN,mFAAmF;oBACnF,qDAAqD;oBACrD,MAAM,UAAU,GAAG,MAAM,SAAS,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;oBAEnD,gEAAgE;oBAChE,MAAM,qBAAqB,GAAG,UAAU,CAAC,MAAM,CAAC;oBAChD,IAAI,qBAAqB,KAAK,CAAC,EAAE,CAAC;wBAChC,0FAA0F;wBAC1F,YAAY,GAAG,IAAI,CAAC;wBAEpB,4CAA4C;wBAC5C,QAAQ,GAAG,MAAM,SAAS,CAAC,QAAQ,CAAC,MAAM,CAAC;4BACzC,SAAS,EAAI,KAAK;4BAClB,QAAQ,EAAK,EAAE,IAAI,EAAE,SAAS,EAAE;4BAChC,UAAU,EAAG;gCACX,QAAQ,EAAE;oCACR;wCACE,EAAE,EAAgB,KAAK;wCACvB,IAAI,EAAc,sBAAsB;wCACxC,eAAe,EAAG,oBAAoB;wCACtC,GAAG,EAAe,MAAM;wCACxB,GAAG,EAAe,MAAM;qCACzB;iCACF;gCACD,mBAAmB,EAAE;oCACnB;wCACE,SAAS,EAAG,SAAS;wCACrB,EAAE,EAAU,KAAK;wCACjB,QAAQ,EAAI,CAAC,iBAAiB,EAAE,gBAAgB,CAAC;qCAClD;oCACD;wCACE,SAAS,EAAG,QAAQ;wCACpB,EAAE,EAAU,KAAK;wCACjB,QAAQ,EAAI,CAAC,cAAc,CAAC;qCAC7B;iCACF;6BACF;yBACF,CAAC,CAAC;oBAEL,CAAC;yBAAM,CAAC;wBACN,uDAAuD;wBACvD,oEAAoE;wBACpE,QAAQ,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC;oBAC3B,CAAC;gBACH,CAAC;gBAED,6GAA6G;gBAC7G,YAAY,GAAG,MAAA,QAAQ,CAAC,QAAQ,CAAC,YAAY,mCAAI,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC;gBAClE,oHAAoH;gBACpH,WAAW,GAAG,QAAQ,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,SAAS,CAAC;gBAC5E,IAAI,YAAY,KAAK,SAAS,EAAE,CAAC;oBAC/B,+HAA+H;oBAC/H,IAAI,CAAC;wBACH,KAAK,MAAM,WAAW,IAAI,oBAAoB,EAAE,CAAC;4BAC/C,uCAAuC;4BACvC,MAAM,UAAU,GAAG,MAAM,SAAS,CAAC,GAAG,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC;4BAClE,IAAI,UAAU,CAAC,wBAAwB,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gCACrD,2BAA2B;gCAC3B,SAAS;4BACX,CAAC;4BAED,yBAAyB;4BACzB,MAAM,YAAY,CAAC,cAAc,CAAC,WAAW,EAAE,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;4BAEnE,sCAAsC;4BACtC,MAAM,YAAY,CAAC,cAAc,CAAC,WAAW,EAAE,YAAY,CAAC,CAAC;wBAC/D,CAAC;wBAED,uDAAuD;wBACvD,YAAY,CAAC,SAAS,EAAE,CAAC;oBAC3B,CAAC;oBAAC,OAAO,KAAK,EAAE,CAAC;wBACf,8DAA8D;wBAC9D,YAAY,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;oBAChC,CAAC;gBACH,CAAC;gBAED,2CAA2C;gBAC3C,IAAI,IAAI,KAAK,KAAK,EAAE,CAAC;oBACnB,8CAA8C;oBAC9C,+GAA+G;oBAE/G,IAAI,YAAY,EAAE,CAAC;wBACjB,MAAM,SAAS,CAAC,IAAI,CAAC,gBAAgB,CAAC;4BACpC,GAAG,EAAO,YAAY;4BACtB,OAAO,EAAG;gCACR,WAAW;gCACX,SAAS,EAAE,kBAAkB;6BAC9B;yBACF,CAAC,CAAC;wBAEH,IAAI,oBAAoB,KAAK,SAAS,EAAE,CAAC;4BACvC,kIAAkI;4BAClI,MAAM,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;wBACpC,CAAC;oBACH,CAAC;oBAED,uDAAuD;oBACvD,IAAI,aAAJ,IAAI,cAAJ,IAAI,IAAJ,IAAI,GAAK,IAAI,EAAC;oBACd,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;yBACzC,KAAK,CAAC,CAAC,KAAU,EAAE,EAAE;wBACpB,OAAO,CAAC,KAAK,CAAC,gBAAgB,KAAK,EAAE,CAAC,CAAC;oBACzC,CAAC,CAAC,CAAC;gBACP,CAAC;YACH,CAAC;YAED,MAAM,IAAI,GAAG,IAAI,IAAI,CAAC,EAAE,KAAK,EAAE,YAAY,EAAE,WAAW,EAAE,CAAC,CAAC;YAE5D,OAAO,EAAE,IAAI,EAAE,GAAG,EAAE,YAAY,EAAE,WAAW,EAAE,cAAc,EAAE,CAAC;QAClE,CAAC;KAAA;IAED;;;OAGG;IACK,MAAM,CAAO,eAAe;6DAAC,EAAE,QAAQ,EAAE,SAAS,EAGzD;YACC,IAAI,CAAC;gBACH,yCAAyC;gBACzC,MAAM,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC;oBACzB,MAAM,EAAM,QAAQ,CAAC,GAAG,CAAC,GAAG;oBAC5B,MAAM,EAAM,QAAQ,CAAC,QAAQ,CAAC,MAAM;oBACpC,SAAS,EAAG,IAAI;iBACjB,CAAC,CAAC;YACL,CAAC;YAAC,OAAO,KAAU,EAAE,CAAC;gBACpB,OAAO,CAAC,KAAK,CAAC,wBAAwB,QAAQ,CAAC,GAAG,CAAC,GAAG,KAAK,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;YAC9E,CAAC;YAED,IAAI,CAAC;gBACH,sBAAsB;gBACtB,MAAM,SAAS,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,CAAC;YAChE,CAAC;YAAC,OAAO,KAAU,EAAE,CAAC;gBACpB,OAAO,CAAC,KAAK,CAAC,6BAA6B,QAAQ,CAAC,QAAQ,CAAC,IAAI,KAAK,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;YACzF,CAAC;QACH,CAAC;KAAA;IAED;;;;OAIG;IACH,MAAM,CAAO,sBAAsB;6DAAC,EAAE,MAAM,EAAE,KAAK,EAAE,WAAW,EAI/D;YACC,MAAM,kBAAkB,GAAG,IAAI,GAAG,EAAU,CAAC;YAC7C,KAAK,MAAM,YAAY,IAAI,MAAM,EAAE,CAAC;gBAClC,2GAA2G;gBAC3G,MAAM,KAAK,GAAG,MAAM,eAAe,CAAC,KAAK,CAAC,EAAE,YAAY,EAAE,WAAW,EAAE,KAAK,EAAE,OAAO,EAAE,YAAY,EAAE,CAAC,CAAC;gBACvG,gIAAgI;gBAChI,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;gBAC3C,IAAI,MAAM,CAAC,IAAI,KAAK,GAAG,EAAE,CAAC;oBACxB,MAAM,IAAI,KAAK,CAAC,mDAAmD,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC;gBACtF,CAAC;gBAED,MAAM,QAAQ,GAAI,KAAK,CAAC,KAAgE,CAAC,QAAQ,CAAC;gBAClG,IAAI,QAAQ,EAAE,CAAC;oBACb,kBAAkB,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;gBACnC,CAAC;YACH,CAAC;YAED,2HAA2H;YAC3H,sHAAsH;YACtH,OAAO,CAAC,GAAG,kBAAkB,CAAC,CAAC;QACjC,CAAC;KAAA;CACF"}
+{"version":3,"file":"web5.js","sourceRoot":"","sources":["../../src/web5.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,2CAA2C;;;;;;;;;;;;;;;;;;;;;AAkB3C,OAAO,EAAE,eAAe,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAC7E,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,sBAAsB,EAAE,MAAM,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AACxG,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAEjE,OAAO,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AACtC,OAAO,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AACtC,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AACnD,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AACxD,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAC5C,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AAqNpC;;;GAGG;AACH,MAAM,OAAO,IAAI;IAgBf,YAAY,EAAE,KAAK,EAAE,YAAY,EAAE,WAAW,EAAc;QAC1D,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,GAAG,GAAG,IAAI,MAAM,CAAC,EAAE,KAAK,EAAE,YAAY,EAAE,CAAC,CAAC;QAC/C,IAAI,CAAC,IAAI,GAAG,IAAI,MAAM,CAAC,EAAE,KAAK,EAAE,YAAY,EAAE,WAAW,EAAE,CAAC,CAAC;QAC7D,IAAI,CAAC,EAAE,GAAG,IAAI,KAAK,CAAC,EAAE,KAAK,EAAE,YAAY,EAAE,CAAC,CAAC;IAC/C,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACI,KAAK,CACV,QAA6B;QAE7B,OAAO,IAAI,SAAS,CAAO,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IAClD,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,MAAM,CAAC,SAAS,CAAC,OAA8B;;QAC7C,MAAM,WAAW,GAAG,IAAI,iBAAiB,CAAC;YACxC,YAAY,EAAG,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,YAAY,mCAAI,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC;YACxE,KAAK,EAAU,IAAI,sBAAsB,EAAE;SAC5C,CAAC,CAAC;QAEH,MAAM,SAAS,GAAG,IAAI,aAAa,EAAE,CAAC;QACtC,MAAM,YAAY,GAAG,IAAI,eAAe,CAAC,EAAE,WAAW,EAAE,SAAS,EAAE,CAAC,CAAC;QAErE,OAAO;YACL,GAAG,EAAE,IAAI,YAAY,CAAC,YAAY,CAAC;SACpC,CAAC;IACJ,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CAAO,OAAO;6DAAC,EACnB,KAAK,EACL,UAAU,EACV,YAAY,EACZ,QAAQ,EACR,cAAc,EACd,IAAI,EACJ,WAAW,EACX,gBAAgB,EAChB,YAAY,EACZ,oBAAoB,MACE,EAAE;;YACxB,IAAI,WAA+B,CAAC;YACpC,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;gBACxB,IAAI,YAAY,GAAG,KAAK,CAAC;gBACzB,0FAA0F;gBAC1F,MAAM,SAAS,GAAG,MAAM,aAAa,CAAC,MAAM,CAAC,EAAE,UAAU,EAAE,CAAC,CAAC;gBAC7D,KAAK,GAAG,SAAS,CAAC;gBAElB,4FAA4F;gBAC5F,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;oBAC3B,QAAQ,GAAG,wBAAwB,CAAC;oBACpC,OAAO,CAAC,IAAI,CACV,wBAAwB;wBACxB,4EAA4E;wBAC5E,4DAA4D;wBAC5D,6CAA6C,EAC7C,gCAAgC,EAChC,sCAAsC,CACvC,CAAC;gBACJ,CAAC;gBAED,+DAA+D;gBAC/D,MAAM,oBAAoB,GAAG,MAAA,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,YAAY,mCAAI,gBAAgB,aAAhB,gBAAgB,uBAAhB,gBAAgB,CAAE,YAAY,mCAAI,CAAC,2BAA2B,CAAC,CAAC;gBAE1H,iDAAiD;gBACjD,IAAI,MAAM,SAAS,CAAC,WAAW,EAAE,EAAE,CAAC;oBAClC,cAAc,GAAG,MAAM,SAAS,CAAC,UAAU,CAAC,EAAE,QAAQ,EAAE,cAAc,EAAE,YAAY,EAAE,oBAAoB,EAAE,CAAC,CAAC;gBAChH,CAAC;gBACD,MAAM,SAAS,CAAC,KAAK,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC;gBACpC,2DAA2D;gBAC3D,MAAM,iBAAiB,GAAmB,MAAM,SAAS,CAAC,QAAQ,CAAC,iBAAiB,EAAE,CAAC;gBACvF,IAAI,QAAwB,CAAC;gBAC7B,IAAI,kBAAkB,GAAa,EAAE,CAAC;gBACtC,IAAI,iBAAiB,EAAE,CAAC;oBACtB,2CAA2C;oBAC3C,yHAAyH;oBACzH,QAAQ,GAAG,iBAAiB,CAAC;gBAC/B,CAAC;qBAAM,IAAI,oBAAoB,EAAE,CAAC;oBAChC,IAAI,IAAI,KAAK,KAAK,EAAE,CAAC;wBACnB,mEAAmE;wBACnE,mHAAmH;wBACnH,MAAM,IAAI,KAAK,CAAC,oDAAoD,CAAC,CAAC;oBACxE,CAAC;oBAED,6FAA6F;oBAC7F,YAAY,GAAG,IAAI,CAAC;oBAEpB,yHAAyH;oBACzH,IAAI,CAAC;wBACH,MAAM,EAAE,kBAAkB,KAAwB,oBAAoB,EAAvC,cAAc,UAAK,oBAAoB,EAAhE,sBAAyC,CAAuB,CAAC;wBACvE,MAAM,wBAAwB,GAAG,kBAAkB,CAAC,GAAG,CACrD,CAAC,EAAE,kBAAkB,EAAE,WAAW,EAAE,EAAE,EAAE,CACtC,aAAa,CAAC,kCAAkC,CAAC;4BAC/C,UAAU,EAAI,kBAAkB;4BAChC,WAAW,EAAG,WAAW,aAAX,WAAW,cAAX,WAAW,GAAI;gCAC3B,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,WAAW;6BAChD;yBACF,CAAC,CACL,CAAC;wBAEF,MAAM,EAAE,mBAAmB,EAAE,YAAY,EAAE,cAAc,EAAE,GAAG,MAAM,aAAa,CAAC,UAAU,iCACvF,cAAc,KACjB,kBAAkB,EAAE,wBAAwB,IAC5C,CAAC;wBAEH,6DAA6D;wBAC7D,+HAA+H;wBAC/H,QAAQ,GAAG,MAAM,SAAS,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,gBAAgB,EAAE;gCAC7D,WAAW,EAAG,mBAAmB;gCACjC,QAAQ,EAAM;oCACZ,YAAY;oCACZ,IAAI,EAAK,SAAS;oCAClB,GAAG,EAAM,mBAAmB,CAAC,GAAG;oCAChC,MAAM,EAAG,KAAK,CAAC,QAAQ,CAAC,GAAG;iCAC5B;6BACF,EAAE,CAAC,CAAC;wBAEL,yEAAyE;wBACzE,yDAAyD;wBACzD,wHAAwH;wBACxH,kBAAkB,GAAG,MAAM,IAAI,CAAC,sBAAsB,CAAC,EAAE,KAAK,EAAE,WAAW,EAAE,mBAAmB,CAAC,GAAG,EAAE,MAAM,EAAE,cAAc,EAAE,CAAC,CAAC;oBAClI,CAAC;oBAAC,OAAO,KAAS,EAAE,CAAC;wBACnB,0DAA0D;wBAC1D,uEAAuE;wBACvE,MAAM,IAAI,CAAC,eAAe,CAAC,EAAE,QAAQ,EAAE,SAAS,EAAE,CAAC,CAAC;wBACpD,MAAM,IAAI,KAAK,CAAC,gCAAgC,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;oBACnE,CAAC;gBACH,CAAC;qBAAM,CAAC;oBACN,mFAAmF;oBACnF,qDAAqD;oBACrD,MAAM,UAAU,GAAG,MAAM,SAAS,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;oBAEnD,gEAAgE;oBAChE,MAAM,qBAAqB,GAAG,UAAU,CAAC,MAAM,CAAC;oBAChD,IAAI,qBAAqB,KAAK,CAAC,EAAE,CAAC;wBAChC,0FAA0F;wBAC1F,YAAY,GAAG,IAAI,CAAC;wBAEpB,4CAA4C;wBAC5C,QAAQ,GAAG,MAAM,SAAS,CAAC,QAAQ,CAAC,MAAM,CAAC;4BACzC,SAAS,EAAI,KAAK;4BAClB,QAAQ,EAAK,EAAE,IAAI,EAAE,SAAS,EAAE;4BAChC,UAAU,EAAG;gCACX,QAAQ,EAAE;oCACR;wCACE,EAAE,EAAgB,KAAK;wCACvB,IAAI,EAAc,sBAAsB;wCACxC,eAAe,EAAG,oBAAoB;wCACtC,GAAG,EAAe,MAAM;wCACxB,GAAG,EAAe,MAAM;qCACzB;iCACF;gCACD,mBAAmB,EAAE;oCACnB;wCACE,SAAS,EAAG,SAAS;wCACrB,EAAE,EAAU,KAAK;wCACjB,QAAQ,EAAI,CAAC,iBAAiB,EAAE,gBAAgB,CAAC;qCAClD;oCACD;wCACE,SAAS,EAAG,QAAQ;wCACpB,EAAE,EAAU,KAAK;wCACjB,QAAQ,EAAI,CAAC,cAAc,CAAC;qCAC7B;iCACF;6BACF;yBACF,CAAC,CAAC;oBAEL,CAAC;yBAAM,CAAC;wBACN,uDAAuD;wBACvD,oEAAoE;wBACpE,QAAQ,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC;oBAC3B,CAAC;gBACH,CAAC;gBAED,6GAA6G;gBAC7G,YAAY,GAAG,MAAA,QAAQ,CAAC,QAAQ,CAAC,YAAY,mCAAI,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC;gBAClE,oHAAoH;gBACpH,WAAW,GAAG,QAAQ,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,SAAS,CAAC;gBAC5E,IAAI,YAAY,KAAK,SAAS,EAAE,CAAC;oBAC/B,+HAA+H;oBAC/H,IAAI,CAAC;wBACH,KAAK,MAAM,WAAW,IAAI,oBAAoB,EAAE,CAAC;4BAC/C,uCAAuC;4BACvC,MAAM,UAAU,GAAG,MAAM,SAAS,CAAC,GAAG,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC;4BAClE,IAAI,UAAU,CAAC,wBAAwB,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gCACrD,2BAA2B;gCAC3B,SAAS;4BACX,CAAC;4BAED,yBAAyB;4BACzB,MAAM,YAAY,CAAC,cAAc,CAAC,WAAW,EAAE,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;4BAEnE,sCAAsC;4BACtC,MAAM,YAAY,CAAC,cAAc,CAAC,WAAW,EAAE,YAAY,CAAC,CAAC;wBAC/D,CAAC;wBAED,uDAAuD;wBACvD,YAAY,CAAC,SAAS,EAAE,CAAC;oBAC3B,CAAC;oBAAC,OAAO,KAAK,EAAE,CAAC;wBACf,8DAA8D;wBAC9D,YAAY,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;oBAChC,CAAC;gBACH,CAAC;gBAED,2CAA2C;gBAC3C,IAAI,IAAI,KAAK,KAAK,EAAE,CAAC;oBACnB,8CAA8C;oBAC9C,+GAA+G;oBAE/G,IAAI,YAAY,EAAE,CAAC;wBACjB,MAAM,SAAS,CAAC,IAAI,CAAC,gBAAgB,CAAC;4BACpC,GAAG,EAAO,YAAY;4BACtB,OAAO,EAAG;gCACR,WAAW;gCACX,SAAS,EAAE,kBAAkB;6BAC9B;yBACF,CAAC,CAAC;wBAEH,IAAI,oBAAoB,KAAK,SAAS,EAAE,CAAC;4BACvC,kIAAkI;4BAClI,MAAM,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;wBACpC,CAAC;oBACH,CAAC;oBAED,uDAAuD;oBACvD,IAAI,aAAJ,IAAI,cAAJ,IAAI,IAAJ,IAAI,GAAK,IAAI,EAAC;oBACd,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;yBACzC,KAAK,CAAC,CAAC,KAAU,EAAE,EAAE;wBACpB,OAAO,CAAC,KAAK,CAAC,gBAAgB,KAAK,EAAE,CAAC,CAAC;oBACzC,CAAC,CAAC,CAAC;gBACP,CAAC;YACH,CAAC;YAED,MAAM,IAAI,GAAG,IAAI,IAAI,CAAC,EAAE,KAAK,EAAE,YAAY,EAAE,WAAW,EAAE,CAAC,CAAC;YAE5D,OAAO,EAAE,IAAI,EAAE,GAAG,EAAE,YAAY,EAAE,WAAW,EAAE,cAAc,EAAE,CAAC;QAClE,CAAC;KAAA;IAED;;;OAGG;IACK,MAAM,CAAO,eAAe;6DAAC,EAAE,QAAQ,EAAE,SAAS,EAGzD;YACC,IAAI,CAAC;gBACH,yCAAyC;gBACzC,MAAM,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC;oBACzB,MAAM,EAAM,QAAQ,CAAC,GAAG,CAAC,GAAG;oBAC5B,MAAM,EAAM,QAAQ,CAAC,QAAQ,CAAC,MAAM;oBACpC,SAAS,EAAG,IAAI;iBACjB,CAAC,CAAC;YACL,CAAC;YAAC,OAAO,KAAU,EAAE,CAAC;gBACpB,OAAO,CAAC,KAAK,CAAC,wBAAwB,QAAQ,CAAC,GAAG,CAAC,GAAG,KAAK,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;YAC9E,CAAC;YAED,IAAI,CAAC;gBACH,sBAAsB;gBACtB,MAAM,SAAS,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,CAAC;YAChE,CAAC;YAAC,OAAO,KAAU,EAAE,CAAC;gBACpB,OAAO,CAAC,KAAK,CAAC,6BAA6B,QAAQ,CAAC,QAAQ,CAAC,IAAI,KAAK,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;YACzF,CAAC;QACH,CAAC;KAAA;IAED;;;;OAIG;IACH,MAAM,CAAO,sBAAsB;6DAAC,EAAE,MAAM,EAAE,KAAK,EAAE,WAAW,EAI/D;YACC,MAAM,kBAAkB,GAAG,IAAI,GAAG,EAAU,CAAC;YAC7C,KAAK,MAAM,YAAY,IAAI,MAAM,EAAE,CAAC;gBAClC,2GAA2G;gBAC3G,MAAM,KAAK,GAAG,MAAM,eAAe,CAAC,KAAK,CAAC,EAAE,YAAY,EAAE,WAAW,EAAE,KAAK,EAAE,OAAO,EAAE,YAAY,EAAE,CAAC,CAAC;gBACvG,gIAAgI;gBAChI,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;gBAC3C,IAAI,MAAM,CAAC,IAAI,KAAK,GAAG,EAAE,CAAC;oBACxB,MAAM,IAAI,KAAK,CAAC,mDAAmD,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC;gBACtF,CAAC;gBAED,MAAM,QAAQ,GAAI,KAAK,CAAC,KAAgE,CAAC,QAAQ,CAAC;gBAClG,IAAI,QAAQ,EAAE,CAAC;oBACb,kBAAkB,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;gBACnC,CAAC;YACH,CAAC;YAED,2HAA2H;YAC3H,sHAAsH;YACtH,OAAO,CAAC,GAAG,kBAAkB,CAAC,CAAC;QACjC,CAAC;KAAA;CACF"}

package/dist/types/advanced.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Advanced API surface for power users who need direct access to
+ * the underlying {@link DwnApi}.
+ *
+ * Most applications should use `web5.using(protocol)` instead.
+ * Import from `@enbox/api/advanced` to access these exports.
+ *
+ * @packageDocumentation
+ */
+export { DwnApi } from './dwn-api.js';
+export type { FetchGrantsRequest, FetchRequestsRequest, ProtocolsConfigureRequest, ProtocolsConfigureResponse, ProtocolsQueryRequest, ProtocolsQueryResponse, RecordsDeleteRequest, RecordsQueryRequest, RecordsQueryResponse, RecordsReadRequest, RecordsReadResponse, RecordsSubscribeRequest, RecordsSubscribeResponse, RecordsWriteRequest, RecordsWriteResponse, } from './dwn-api.js';
+//# sourceMappingURL=advanced.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"advanced.d.ts","sourceRoot":"","sources":["../../src/advanced.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AAEtC,YAAY,EACV,kBAAkB,EAClB,oBAAoB,EACpB,yBAAyB,EACzB,0BAA0B,EAC1B,qBAAqB,EACrB,sBAAsB,EACtB,oBAAoB,EACpB,mBAAmB,EACnB,oBAAoB,EACpB,kBAAkB,EAClB,mBAAmB,EACnB,uBAAuB,EACvB,wBAAwB,EACxB,mBAAmB,EACnB,oBAAoB,GACrB,MAAM,cAAc,CAAC"}

package/dist/types/define-protocol.d.ts

@@ -2,7 +2,7 @@
  * Factory function for creating typed protocol definitions.
  *
  * `defineProtocol()` wraps a standard {@link ProtocolDefinition} with
- * compile-time type metadata so that {@link TypedDwnApi} can provide
+ * compile-time type metadata so that {@link TypedWeb5} can provide
  * path autocompletion, data-shape inference, and tag type safety.
  */
 import type { ProtocolDefinition } from '@enbox/dwn-sdk-js';
@@ -14,7 +14,7 @@ import type { SchemaMap, TypedProtocol } from './protocol-types.js';
  *
  * The `definition` argument is returned as-is (no cloning). The schema map
  * is a phantom type parameter — it exists only at compile time to thread
- * type information through to `TypedDwnApi`.
+ * type information through to `TypedWeb5`.
  *
  * @param definition - A standard `ProtocolDefinition` object.
  * @param _schemaMap - A phantom value (e.g. `{} as MySchemaMap`) that carries
@@ -29,7 +29,7 @@ import type { SchemaMap, TypedProtocol } from './protocol-types.js';
  * });
  *
  * // socialGraph.definition is the raw ProtocolDefinition
- * // TypedDwnApi infers paths like 'friend' | 'friend/message' and
+ * // TypedWeb5 infers paths like 'friend' | 'friend/message' and
  * // data types from the schema map.
  * ```
  */

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

@@ -4,14 +4,11 @@
  */
 import type { CreateGrantParams, CreateRequestParams, DwnMessageParams, DwnPaginationCursor, DwnResponseStatus, FetchPermissionRequestParams, FetchPermissionsParams, Web5Agent } from '@enbox/agent';
 import { DwnInterface } from '@enbox/agent';
-import type { ProtocolDefinition } from '@enbox/dwn-sdk-js';
-import type { SchemaMap, TypedProtocol } from './protocol-types.js';
 import { LiveQuery } from './live-query.js';
 import { PermissionGrant } from './permission-grant.js';
 import { PermissionRequest } from './permission-request.js';
 import { Protocol } from './protocol.js';
 import { Record } from './record.js';
-import { TypedDwnApi } from './typed-dwn-api.js';
 /**
  * Represents the request payload for fetching permission requests from a Decentralized Web Node (DWN).
  *
@@ -38,9 +35,7 @@ export type FetchGrantsRequest = Omit<FetchPermissionsParams, 'author' | 'target
  *
  * This request type is used to specify the configuration options for the protocol.
  */
-export type ProtocolsConfigureRequest = {
-    /** Configuration options for the protocol. */
-    message: Omit<DwnMessageParams[DwnInterface.ProtocolsConfigure], 'signer'>;
+export type ProtocolsConfigureRequest = Omit<DwnMessageParams[DwnInterface.ProtocolsConfigure], 'signer'> & {
     /** When true, derives and injects $encryption public keys into the protocol definition. */
     encryption?: boolean;
 };
@@ -64,11 +59,9 @@ export type ProtocolsConfigureResponse = DwnResponseStatus & {
  * target the local DWN. If the `from` property is provided, the query will target the specified
  * remote DWN.
  */
-export type ProtocolsQueryRequest = {
+export type ProtocolsQueryRequest = Omit<DwnMessageParams[DwnInterface.ProtocolsQuery], 'signer'> & {
     /** Optional DID specifying the remote target DWN tenant to be queried. */
     from?: string;
-    /** Query filters and options that influence the results returned. */
-    message: Omit<DwnMessageParams[DwnInterface.ProtocolsQuery], 'signer'>;
 };
 /**
  * Wraps the response from a protocols query, including the operation status and the list of
@@ -78,37 +71,6 @@ export type ProtocolsQueryResponse = DwnResponseStatus & {
     /** Array of protocols matching the query. */
     protocols: Protocol[];
 };
-/**
- * Type alias for {@link RecordsWriteRequest}
- */
-export type RecordsCreateRequest = RecordsWriteRequest;
-/**
- * Type alias for {@link RecordsWriteResponse}
- */
-export type RecordsCreateResponse = RecordsWriteResponse;
-/**
- * Represents a request to create a new record based on an existing one.
- *
- * This request type allows specifying the new data for the record, along with any additional
- * message parameters required for the write operation.
- */
-export type RecordsCreateFromRequest = {
-    /** The DID of the entity authoring the record. */
-    author: string;
-    /** The new data for the record. */
-    data: unknown;
-    /** Optional additional parameters for the record write operation */
-    message?: Omit<DwnMessageParams[DwnInterface.RecordsWrite], 'signer'>;
-    /** The existing record instance that is being used as a basis for the new record. */
-    record: Record;
-    /**
-     * Controls whether the new record should be auto-encrypted.
-     *
-     * If omitted, auto-detected from the source record: if the source record was
-     * encrypted, the new record is automatically encrypted with a fresh DEK.
-     */
-    encryption?: boolean;
-};
 /**
  * Defines a request to delete a record from the Decentralized Web Node (DWN).
  *
@@ -116,13 +78,11 @@ export type RecordsCreateFromRequest = {
  * message parameters for the delete operation. If the `from` property is not provided, the record
  * will be deleted from the local DWN.
  */
-export type RecordsDeleteRequest = {
+export type RecordsDeleteRequest = Omit<DwnMessageParams[DwnInterface.RecordsDelete], 'signer'> & {
     /** Optional DID specifying the remote target DWN tenant the record will be deleted from. */
     from?: string;
-    /** Records must be scoped to a specific protocol */
+    /** Protocol URI for permission grant resolution. */
     protocol?: string;
-    /** The parameters for the delete operation. */
-    message: Omit<DwnMessageParams[DwnInterface.RecordsDelete], 'signer'>;
 };
 /**
  * Encapsulates a request to query records from a Decentralized Web Node (DWN).
@@ -131,13 +91,9 @@ export type RecordsDeleteRequest = {
  * parameters, and optionally the target DWN to query from. If the `from` property is not provided,
  * the query will target the local DWN.
  */
-export type RecordsQueryRequest = {
+export type RecordsQueryRequest = Omit<DwnMessageParams[DwnInterface.RecordsQuery], 'signer'> & {
     /** Optional DID specifying the remote target DWN tenant to query from and return results. */
     from?: string;
-    /** Records must be scoped to a specific protocol */
-    protocol?: string;
-    /** The parameters for the query operation, detailing the criteria for selecting records. */
-    message: Omit<DwnMessageParams[DwnInterface.RecordsQuery], 'signer'>;
     /** When true, automatically decrypts encrypted records in the query results. */
     encryption?: boolean;
 };
@@ -147,7 +103,7 @@ export type RecordsQueryRequest = {
  */
 export type RecordsQueryResponse = DwnResponseStatus & {
     /** Array of records matching the query. */
-    records?: Record[];
+    records: Record[];
     /** If there are additional results, the messageCid of the last record will be returned as a pagination cursor. */
     cursor?: DwnPaginationCursor;
 };
@@ -158,13 +114,11 @@ export type RecordsQueryResponse = DwnResponseStatus & {
  * additional parameters for the read operation. It's useful for fetching the details of a single
  * record by its identifier or other criteria.
  */
-export type RecordsReadRequest = {
+export type RecordsReadRequest = Omit<DwnMessageParams[DwnInterface.RecordsRead], 'signer'> & {
     /** Optional DID specifying the remote target DWN tenant the record will be read from. */
     from?: string;
-    /** Records must be scoped to a specific protocol */
+    /** Protocol URI for permission grant resolution. */
     protocol?: string;
-    /** The parameters for the read operation, detailing the criteria for selecting the record. */
-    message: Omit<DwnMessageParams[DwnInterface.RecordsRead], 'signer'>;
     /** When true, automatically decrypts the encrypted record data. */
     encryption?: boolean;
 };
@@ -183,13 +137,9 @@ export type RecordsReadResponse = DwnResponseStatus & {
  * matching records alongside a real-time stream of deduplicated, semantically-
  * typed change events (`create`, `update`, `delete`).
  */
-export type RecordsSubscribeRequest = {
+export type RecordsSubscribeRequest = Omit<DwnMessageParams[DwnInterface.RecordsSubscribe], 'signer'> & {
     /** Optional DID specifying the remote target DWN tenant to subscribe from. */
     from?: string;
-    /** Records must be scoped to a specific protocol. */
-    protocol?: string;
-    /** The parameters for the subscription operation, detailing the criteria for the subscription filter. */
-    message: Omit<DwnMessageParams[DwnInterface.RecordsSubscribe], 'signer'>;
 };
 /** Encapsulates the response from a DWN RecordsSubscribeRequest. */
 export type RecordsSubscribeResponse = DwnResponseStatus & {
@@ -202,16 +152,10 @@ export type RecordsSubscribeResponse = DwnResponseStatus & {
  * This request type allows specifying the data for the new or updated record, along with any
  * additional message parameters required for the write operation, and an optional flag to indicate
  * whether the record should be immediately stored.
- *
- * @param data -
- * @param message - , excluding the signer.
- * @param store -
  */
-export type RecordsWriteRequest = {
+export type RecordsWriteRequest = Omit<Partial<DwnMessageParams[DwnInterface.RecordsWrite]>, 'signer' | 'data'> & {
     /** The data payload for the record, which can be of any type. */
     data: unknown;
-    /** Optional additional parameters for the record write operation. */
-    message?: Omit<Partial<DwnMessageParams[DwnInterface.RecordsWrite]>, 'signer'>;
     /**
      * Optional flag indicating whether the record should be immediately stored. If true, the record
      * is persisted in the DWN as part of the write operation. If false, the record is created,
@@ -238,7 +182,7 @@ export type RecordsWriteResponse = DwnResponseStatus & {
      * The `Record` instance representing the record that was successfully written to the
      * DWN as a result of the write operation.
      */
-    record?: Record;
+    record: Record;
 };
 /**
  * Interface to interact with DWN Records and Protocols
@@ -260,25 +204,6 @@ export declare class DwnApi {
         connectedDid: string;
         delegateDid?: string;
     });
-    /**
-     * Returns a {@link TypedDwnApi} scoped to the given typed protocol.
-     *
-     * The returned API provides path autocompletion, typed data payloads,
-     * and automatically injects the protocol URI and protocolPath into every
-     * DWN operation.
-     *
-     * @param protocol - A typed protocol created via `defineProtocol()`.
-     * @returns A `TypedDwnApi` instance bound to the given protocol.
-     *
-     * @example
-     * ```ts
-     * const social = dwn.using(SocialGraphProtocol);
-     * const { record } = await social.write('friend', {
-     *   data: { did: 'did:example:alice' },
-     * });
-     * ```
-     */
-    using<D extends ProtocolDefinition, M extends SchemaMap>(protocol: TypedProtocol<D, M>): TypedDwnApi<D, M>;
     /**
      * API to interact with Grants
      *
@@ -304,11 +229,9 @@ export declare class DwnApi {
         query: (request: ProtocolsQueryRequest) => Promise<ProtocolsQueryResponse>;
     };
     /**
-     * API to interact with DWN records (e.g., `dwn.records.create()`).
+     * API to interact with DWN records (e.g., `dwn.records.write()`).
      */
     get records(): {
-        create: (request: RecordsCreateRequest) => Promise<RecordsCreateResponse>;
-        createFrom: (request: RecordsCreateFromRequest) => Promise<RecordsWriteResponse>;
         delete: (request: RecordsDeleteRequest) => Promise<DwnResponseStatus>;
         query: (request: RecordsQueryRequest) => Promise<RecordsQueryResponse>;
         read: (request: RecordsReadRequest) => Promise<RecordsReadResponse>;

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;;;GAGG;AAGH,OAAO,KAAK,EACV,iBAAiB,EACjB,mBAAmB,EAEnB,gBAAgB,EAChB,mBAAmB,EAEnB,iBAAiB,EACjB,4BAA4B,EAC5B,sBAAsB,EAEtB,SAAS,EAAE,MAAM,cAAc,CAAC;AAOlC,OAAO,EAAE,YAAY,EAAmB,MAAM,cAAc,CAAC;AAE7D,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAC;AAE5D,OAAO,KAAK,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAGpE,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAC5C,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AACxD,OAAO,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AAC5D,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACzC,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAEjD;;;;GAIG;AACH,MAAM,MAAM,oBAAoB,GAAG,IAAI,CAAC,4BAA4B,EAAE,QAAQ,GAAG,QAAQ,GAAG,QAAQ,CAAC,GAAG;IACtG,0EAA0E;IAC1E,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,kBAAkB,GAAG,IAAI,CAAC,sBAAsB,EAAE,QAAQ,GAAG,QAAQ,GAAG,QAAQ,CAAC,GAAG;IAC9F,0EAA0E;IAC1E,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,sDAAsD;IACtD,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,yBAAyB,GAAG;IACtC,8CAA8C;IAC9C,OAAO,EAAE,IAAI,CAAC,gBAAgB,CAAC,YAAY,CAAC,kBAAkB,CAAC,EAAE,QAAQ,CAAC,CAAC;IAC3E,2FAA2F;IAC3F,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,MAAM,0BAA0B,GAAG,iBAAiB,GAAG;IAC3D,8CAA8C;IAC9C,QAAQ,CAAC,EAAE,QAAQ,CAAC;CACrB,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC,0EAA0E;IAC1E,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,qEAAqE;IACrE,OAAO,EAAE,IAAI,CAAC,gBAAgB,CAAC,YAAY,CAAC,cAAc,CAAC,EAAE,QAAQ,CAAC,CAAA;CACvE,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,sBAAsB,GAAG,iBAAiB,GAAG;IACvD,6CAA6C;IAC7C,SAAS,EAAE,QAAQ,EAAE,CAAC;CACvB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,mBAAmB,CAAC;AAEvD;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG,oBAAoB,CAAC;AAEzD;;;;;GAKG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC,kDAAkD;IAClD,MAAM,EAAE,MAAM,CAAC;IACf,mCAAmC;IACnC,IAAI,EAAE,OAAO,CAAC;IACd,oEAAoE;IACpE,OAAO,CAAC,EAAE,IAAI,CAAC,gBAAgB,CAAC,YAAY,CAAC,YAAY,CAAC,EAAE,QAAQ,CAAC,CAAC;IACtE,qFAAqF;IACrF,MAAM,EAAE,MAAM,CAAC;IACf;;;;;OAKG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC,4FAA4F;IAC5F,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,oDAAoD;IACpD,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,+CAA+C;IAC/C,OAAO,EAAE,IAAI,CAAC,gBAAgB,CAAC,YAAY,CAAC,aAAa,CAAC,EAAE,QAAQ,CAAC,CAAC;CACvE,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC,6FAA6F;IAC7F,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,oDAAoD;IACpD,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,4FAA4F;IAC5F,OAAO,EAAE,IAAI,CAAC,gBAAgB,CAAC,YAAY,CAAC,YAAY,CAAC,EAAE,QAAQ,CAAC,CAAC;IAErE,gFAAgF;IAChF,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,oBAAoB,GAAG,iBAAiB,GAAG;IACrD,2CAA2C;IAC3C,OAAO,CAAC,EAAE,MAAM,EAAE,CAAA;IAElB,kHAAkH;IAClH,MAAM,CAAC,EAAE,mBAAmB,CAAC;CAC9B,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B,yFAAyF;IACzF,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,oDAAoD;IACpD,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,8FAA8F;IAC9F,OAAO,EAAE,IAAI,CAAC,gBAAgB,CAAC,YAAY,CAAC,WAAW,CAAC,EAAE,QAAQ,CAAC,CAAC;IAEpE,mEAAmE;IACnE,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAAG,iBAAiB,GAAG;IACpD,kDAAkD;IAClD,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,uBAAuB,GAAG;IACpC,8EAA8E;IAC9E,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,qDAAqD;IACrD,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,yGAAyG;IACzG,OAAO,EAAE,IAAI,CAAC,gBAAgB,CAAC,YAAY,CAAC,gBAAgB,CAAC,EAAE,QAAQ,CAAC,CAAC;CAC1E,CAAC;AAEF,oEAAoE;AACpE,MAAM,MAAM,wBAAwB,GAAG,iBAAiB,GAAG;IACzD,qEAAqE;IACrE,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF;;;;;;;;;;GAUG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC,iEAAiE;IACjE,IAAI,EAAE,OAAO,CAAC;IAEd,qEAAqE;IACrE,OAAO,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC;IAE/E;;;;OAIG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;IAEhB,8FAA8F;IAC9F,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,oBAAoB,GAAG,iBAAiB,GAAG;IACrD;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB,CAAC;AAEF;;GAEG;AACH,qBAAa,MAAM;IACjB;;;OAGG;IACH,OAAO,CAAC,KAAK,CAAY;IAEzB,4EAA4E;IAC5E,OAAO,CAAC,YAAY,CAAS;IAE7B,qEAAqE;IACrE,OAAO,CAAC,WAAW,CAAC,CAAS;IAE7B,kHAAkH;IAClH,OAAO,CAAC,cAAc,CAAsB;gBAEhC,OAAO,EAAE;QAAE,KAAK,EAAE,SAAS,CAAC;QAAC,YAAY,EAAE,MAAM,CAAC;QAAC,WAAW,CAAC,EAAE,MAAM,CAAA;KAAE;IAOrF;;;;;;;;;;;;;;;;;OAiBG;IACI,KAAK,CAAC,CAAC,SAAS,kBAAkB,EAAE,CAAC,SAAS,SAAS,EAC5D,QAAQ,EAAE,aAAa,CAAC,CAAC,EAAE,CAAC,CAAC,GAC5B,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC;IAIpB;;;;;;;;;;OAUG;IACH,IAAI,WAAW,IAAI;QACf,OAAO,EAAE,CAAC,OAAO,EAAE,IAAI,CAAC,mBAAmB,EAAE,QAAQ,CAAC,KAAK,OAAO,CAAC,iBAAiB,CAAC,CAAC;QACtF,KAAK,EAAE,CAAC,OAAO,EAAE,IAAI,CAAC,iBAAiB,EAAE,QAAQ,CAAC,KAAK,OAAO,CAAC,eAAe,CAAC,CAAC;QAChF,aAAa,EAAE,CAAC,OAAO,CAAC,EAAE,oBAAoB,KAAK,OAAO,CAAC,iBAAiB,EAAE,CAAC,CAAC;QAChF,WAAW,EAAE,CAAC,OAAO,CAAC,EAAE,kBAAkB,KAAK,OAAO,CAAC,eAAe,EAAE,CAAC,CAAC;KACzE,CA+FJ;IAED;;OAEG;IACH,IAAI,SAAS,IAAI;QACb,SAAS,EAAE,CAAC,OAAO,EAAE,yBAAyB,KAAK,OAAO,CAAC,0BAA0B,CAAC,CAAC;QACvF,KAAK,EAAE,CAAC,OAAO,EAAE,qBAAqB,KAAK,OAAO,CAAC,sBAAsB,CAAC,CAAC;KAC1E,CAmGJ;IAED;;OAEG;IACH,IAAI,OAAO,IAAI;QACX,MAAM,EAAE,CAAC,OAAO,EAAE,oBAAoB,KAAK,OAAO,CAAC,qBAAqB,CAAC,CAAC;QAC1E,UAAU,EAAE,CAAC,OAAO,EAAE,wBAAwB,KAAK,OAAO,CAAC,oBAAoB,CAAC,CAAC;QACjF,MAAM,EAAE,CAAC,OAAO,EAAE,oBAAoB,KAAK,OAAO,CAAC,iBAAiB,CAAC,CAAC;QACtE,KAAK,EAAE,CAAC,OAAO,EAAE,mBAAmB,KAAK,OAAO,CAAC,oBAAoB,CAAC,CAAC;QACvE,IAAI,EAAE,CAAC,OAAO,EAAE,kBAAkB,KAAK,OAAO,CAAC,mBAAmB,CAAC,CAAC;QACpE,SAAS,EAAE,CAAC,OAAO,EAAE,uBAAuB,KAAK,OAAO,CAAC,wBAAwB,CAAC,CAAC;QACnF,KAAK,EAAE,CAAC,OAAO,EAAE,mBAAmB,KAAK,OAAO,CAAC,oBAAoB,CAAC,CAAC;KACtE,CAscJ;CACF"}
+{"version":3,"file":"dwn-api.d.ts","sourceRoot":"","sources":["../../src/dwn-api.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,KAAK,EACV,iBAAiB,EACjB,mBAAmB,EAEnB,gBAAgB,EAChB,mBAAmB,EAEnB,iBAAiB,EACjB,4BAA4B,EAC5B,sBAAsB,EAEtB,SAAS,EAAE,MAAM,cAAc,CAAC;AAMlC,OAAO,EAAE,YAAY,EAAmB,MAAM,cAAc,CAAC;AAG7D,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAC5C,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AACxD,OAAO,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AAC5D,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACzC,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAErC;;;;GAIG;AACH,MAAM,MAAM,oBAAoB,GAAG,IAAI,CAAC,4BAA4B,EAAE,QAAQ,GAAG,QAAQ,GAAG,QAAQ,CAAC,GAAG;IACtG,0EAA0E;IAC1E,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,kBAAkB,GAAG,IAAI,CAAC,sBAAsB,EAAE,QAAQ,GAAG,QAAQ,GAAG,QAAQ,CAAC,GAAG;IAC9F,0EAA0E;IAC1E,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,sDAAsD;IACtD,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,yBAAyB,GAAG,IAAI,CAAC,gBAAgB,CAAC,YAAY,CAAC,kBAAkB,CAAC,EAAE,QAAQ,CAAC,GAAG;IAC1G,2FAA2F;IAC3F,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,MAAM,0BAA0B,GAAG,iBAAiB,GAAG;IAC3D,8CAA8C;IAC9C,QAAQ,CAAC,EAAE,QAAQ,CAAC;CACrB,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,MAAM,qBAAqB,GAAG,IAAI,CAAC,gBAAgB,CAAC,YAAY,CAAC,cAAc,CAAC,EAAE,QAAQ,CAAC,GAAG;IAClG,0EAA0E;IAC1E,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,sBAAsB,GAAG,iBAAiB,GAAG;IACvD,6CAA6C;IAC7C,SAAS,EAAE,QAAQ,EAAE,CAAC;CACvB,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,oBAAoB,GAAG,IAAI,CAAC,gBAAgB,CAAC,YAAY,CAAC,aAAa,CAAC,EAAE,QAAQ,CAAC,GAAG;IAChG,4FAA4F;IAC5F,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,oDAAoD;IACpD,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,mBAAmB,GAAG,IAAI,CAAC,gBAAgB,CAAC,YAAY,CAAC,YAAY,CAAC,EAAE,QAAQ,CAAC,GAAG;IAC9F,6FAA6F;IAC7F,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,gFAAgF;IAChF,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,oBAAoB,GAAG,iBAAiB,GAAG;IACrD,2CAA2C;IAC3C,OAAO,EAAE,MAAM,EAAE,CAAC;IAElB,kHAAkH;IAClH,MAAM,CAAC,EAAE,mBAAmB,CAAC;CAC9B,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,kBAAkB,GAAG,IAAI,CAAC,gBAAgB,CAAC,YAAY,CAAC,WAAW,CAAC,EAAE,QAAQ,CAAC,GAAG;IAC5F,yFAAyF;IACzF,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,oDAAoD;IACpD,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,mEAAmE;IACnE,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAAG,iBAAiB,GAAG;IACpD,kDAAkD;IAClD,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,uBAAuB,GAAG,IAAI,CAAC,gBAAgB,CAAC,YAAY,CAAC,gBAAgB,CAAC,EAAE,QAAQ,CAAC,GAAG;IACtG,8EAA8E;IAC9E,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,oEAAoE;AACpE,MAAM,MAAM,wBAAwB,GAAG,iBAAiB,GAAG;IACzD,qEAAqE;IACrE,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,mBAAmB,GAAG,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC,EAAE,QAAQ,GAAG,MAAM,CAAC,GAAG;IAChH,iEAAiE;IACjE,IAAI,EAAE,OAAO,CAAC;IAEd;;;;OAIG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;IAEhB,8FAA8F;IAC9F,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,oBAAoB,GAAG,iBAAiB,GAAG;IACrD;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF;;GAEG;AACH,qBAAa,MAAM;IACjB;;;OAGG;IACH,OAAO,CAAC,KAAK,CAAY;IAEzB,4EAA4E;IAC5E,OAAO,CAAC,YAAY,CAAS;IAE7B,qEAAqE;IACrE,OAAO,CAAC,WAAW,CAAC,CAAS;IAE7B,kHAAkH;IAClH,OAAO,CAAC,cAAc,CAAsB;gBAEhC,OAAO,EAAE;QAAE,KAAK,EAAE,SAAS,CAAC;QAAC,YAAY,EAAE,MAAM,CAAC;QAAC,WAAW,CAAC,EAAE,MAAM,CAAA;KAAE;IAOrF;;;;;;;;;;OAUG;IACH,IAAI,WAAW,IAAI;QACf,OAAO,EAAE,CAAC,OAAO,EAAE,IAAI,CAAC,mBAAmB,EAAE,QAAQ,CAAC,KAAK,OAAO,CAAC,iBAAiB,CAAC,CAAC;QACtF,KAAK,EAAE,CAAC,OAAO,EAAE,IAAI,CAAC,iBAAiB,EAAE,QAAQ,CAAC,KAAK,OAAO,CAAC,eAAe,CAAC,CAAC;QAChF,aAAa,EAAE,CAAC,OAAO,CAAC,EAAE,oBAAoB,KAAK,OAAO,CAAC,iBAAiB,EAAE,CAAC,CAAC;QAChF,WAAW,EAAE,CAAC,OAAO,CAAC,EAAE,kBAAkB,KAAK,OAAO,CAAC,eAAe,EAAE,CAAC,CAAC;KACzE,CA+FJ;IAED;;OAEG;IACH,IAAI,SAAS,IAAI;QACb,SAAS,EAAE,CAAC,OAAO,EAAE,yBAAyB,KAAK,OAAO,CAAC,0BAA0B,CAAC,CAAC;QACvF,KAAK,EAAE,CAAC,OAAO,EAAE,qBAAqB,KAAK,OAAO,CAAC,sBAAsB,CAAC,CAAC;KAC1E,CAsGJ;IAED;;OAEG;IACH,IAAI,OAAO,IAAI;QACX,MAAM,EAAE,CAAC,OAAO,EAAE,oBAAoB,KAAK,OAAO,CAAC,iBAAiB,CAAC,CAAC;QACtE,KAAK,EAAE,CAAC,OAAO,EAAE,mBAAmB,KAAK,OAAO,CAAC,oBAAoB,CAAC,CAAC;QACvE,IAAI,EAAE,CAAC,OAAO,EAAE,kBAAkB,KAAK,OAAO,CAAC,mBAAmB,CAAC,CAAC;QACpE,SAAS,EAAE,CAAC,OAAO,EAAE,uBAAuB,KAAK,OAAO,CAAC,wBAAwB,CAAC,CAAC;QACnF,KAAK,EAAE,CAAC,OAAO,EAAE,mBAAmB,KAAK,OAAO,CAAC,oBAAoB,CAAC,CAAC;KACtE,CA6ZJ;CACF"}

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

@@ -0,0 +1,138 @@
+/**
+ * NOTE: Added reference types here to avoid a `pnpm` bug during build.
+ * https://github.com/enboxorg/enbox/pull/507
+ */
+import type { AnonymousDwnApi, DwnPaginationCursor, DwnResponseStatus } from '@enbox/agent';
+import type { DateSort, Pagination, ProtocolDefinition, ProtocolsQueryFilter, RecordsFilter } from '@enbox/dwn-sdk-js';
+import { ReadOnlyRecord } from './read-only-record.js';
+/**
+ * Request to query public records from a remote DWN.
+ *
+ * @beta
+ */
+export type ReaderRecordsQueryRequest = {
+    /** The DID of the remote DWN to query (required — reader is remote-only). */
+    from: string;
+    /** Filter criteria for the query. */
+    filter: RecordsFilter;
+    /** Sort order for results. */
+    dateSort?: DateSort;
+    /** Pagination options. */
+    pagination?: Pagination;
+};
+/**
+ * Response from a reader records query.
+ *
+ * @beta
+ */
+export type ReaderRecordsQueryResponse = DwnResponseStatus & {
+    /** Array of read-only records matching the query. */
+    records: ReadOnlyRecord[];
+    /** Pagination cursor for fetching the next page. */
+    cursor?: DwnPaginationCursor;
+};
+/**
+ * Request to read a specific public record from a remote DWN.
+ *
+ * @beta
+ */
+export type ReaderRecordsReadRequest = {
+    /** The DID of the remote DWN to read from (required — reader is remote-only). */
+    from: string;
+    /** Filter to identify the record (typically `{ recordId: '...' }`). */
+    filter: RecordsFilter;
+};
+/**
+ * Response from a reader records read.
+ *
+ * @beta
+ */
+export type ReaderRecordsReadResponse = DwnResponseStatus & {
+    /** The read-only record, if found. */
+    record?: ReadOnlyRecord;
+};
+/**
+ * Request to count public records on a remote DWN.
+ *
+ * @beta
+ */
+export type ReaderRecordsCountRequest = {
+    /** The DID of the remote DWN to count records in (required). */
+    from: string;
+    /** Filter criteria for counting. */
+    filter: RecordsFilter;
+};
+/**
+ * Response from a reader records count.
+ *
+ * @beta
+ */
+export type ReaderRecordsCountResponse = DwnResponseStatus & {
+    /** The number of matching public records. */
+    count?: number;
+};
+/**
+ * Request to query published protocols from a remote DWN.
+ *
+ * @beta
+ */
+export type ReaderProtocolsQueryRequest = {
+    /** The DID of the remote DWN to query protocols from (required). */
+    from: string;
+    /** Optional filter for the protocol query. */
+    filter?: ProtocolsQueryFilter;
+};
+/**
+ * Response from a reader protocols query.
+ *
+ * @beta
+ */
+export type ReaderProtocolsQueryResponse = DwnResponseStatus & {
+    /** Array of published protocol definitions. */
+    protocols: ProtocolDefinition[];
+};
+/**
+ * A read-only API for querying public data on remote DWNs without any identity or signing keys.
+ *
+ * This class mirrors the shape of {@link DwnApi}'s `records` and `protocols`
+ * namespaces, but restricts to read-path operations and requires a `from` DID
+ * on every call (remote-only). All messages are unsigned, so only published
+ * records and protocols are accessible.
+ *
+ * Obtain an instance via {@link Web5.anonymous | `Web5.anonymous()`}.
+ *
+ * @example
+ * ```ts
+ * const { dwn } = Web5.anonymous();
+ *
+ * const { records } = await dwn.records.query({
+ *   from: 'did:dht:alice...',
+ *   filter: { protocol: 'https://social.example/posts', protocolPath: 'post' },
+ * });
+ *
+ * for (const record of records) {
+ *   console.log(record.id, await record.data.text());
+ * }
+ * ```
+ *
+ * @beta
+ */
+export declare class DwnReaderApi {
+    private _anonymousDwn;
+    constructor(anonymousDwn: AnonymousDwnApi);
+    /**
+     * API to interact with public DWN records (query, read, count).
+     */
+    get records(): {
+        query: (request: ReaderRecordsQueryRequest) => Promise<ReaderRecordsQueryResponse>;
+        read: (request: ReaderRecordsReadRequest) => Promise<ReaderRecordsReadResponse>;
+        count: (request: ReaderRecordsCountRequest) => Promise<ReaderRecordsCountResponse>;
+    };
+    /**
+     * API to query published protocol definitions from remote DWNs.
+     */
+    get protocols(): {
+        query: (request: ReaderProtocolsQueryRequest) => Promise<ReaderProtocolsQueryResponse>;
+    };
+}
+//# sourceMappingURL=dwn-reader-api.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"dwn-reader-api.d.ts","sourceRoot":"","sources":["../../src/dwn-reader-api.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,KAAK,EAAE,eAAe,EAAE,mBAAmB,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AAC5F,OAAO,KAAK,EACV,QAAQ,EACR,UAAU,EACV,kBAAkB,EAClB,oBAAoB,EACpB,aAAa,EACd,MAAM,mBAAmB,CAAC;AAE3B,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAMvD;;;;GAIG;AACH,MAAM,MAAM,yBAAyB,GAAG;IACtC,6EAA6E;IAC7E,IAAI,EAAE,MAAM,CAAC;IACb,qCAAqC;IACrC,MAAM,EAAE,aAAa,CAAC;IACtB,8BAA8B;IAC9B,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,0BAA0B;IAC1B,UAAU,CAAC,EAAE,UAAU,CAAC;CACzB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,0BAA0B,GAAG,iBAAiB,GAAG;IAC3D,qDAAqD;IACrD,OAAO,EAAE,cAAc,EAAE,CAAC;IAC1B,oDAAoD;IACpD,MAAM,CAAC,EAAE,mBAAmB,CAAC;CAC9B,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC,iFAAiF;IACjF,IAAI,EAAE,MAAM,CAAC;IACb,uEAAuE;IACvE,MAAM,EAAE,aAAa,CAAC;CACvB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,yBAAyB,GAAG,iBAAiB,GAAG;IAC1D,sCAAsC;IACtC,MAAM,CAAC,EAAE,cAAc,CAAC;CACzB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,yBAAyB,GAAG;IACtC,gEAAgE;IAChE,IAAI,EAAE,MAAM,CAAC;IACb,oCAAoC;IACpC,MAAM,EAAE,aAAa,CAAC;CACvB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,0BAA0B,GAAG,iBAAiB,GAAG;IAC3D,6CAA6C;IAC7C,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC;AAMF;;;;GAIG;AACH,MAAM,MAAM,2BAA2B,GAAG;IACxC,oEAAoE;IACpE,IAAI,EAAE,MAAM,CAAC;IACb,8CAA8C;IAC9C,MAAM,CAAC,EAAE,oBAAoB,CAAC;CAC/B,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,4BAA4B,GAAG,iBAAiB,GAAG;IAC7D,+CAA+C;IAC/C,SAAS,EAAE,kBAAkB,EAAE,CAAC;CACjC,CAAC;AAMF;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,qBAAa,YAAY;IACvB,OAAO,CAAC,aAAa,CAAkB;gBAE3B,YAAY,EAAE,eAAe;IAIzC;;OAEG;IACH,IAAI,OAAO,IAAI;QACb,KAAK,EAAE,CAAC,OAAO,EAAE,yBAAyB,KAAK,OAAO,CAAC,0BAA0B,CAAC,CAAC;QACnF,IAAI,EAAE,CAAC,OAAO,EAAE,wBAAwB,KAAK,OAAO,CAAC,yBAAyB,CAAC,CAAC;QAChF,KAAK,EAAE,CAAC,OAAO,EAAE,yBAAyB,KAAK,OAAO,CAAC,0BAA0B,CAAC,CAAC;KAClF,CAiEF;IAED;;OAEG;IACH,IAAI,SAAS,IAAI;QACf,KAAK,EAAE,CAAC,OAAO,EAAE,2BAA2B,KAAK,OAAO,CAAC,4BAA4B,CAAC,CAAC;KACtF,CAkBF;CACF"}

package/dist/types/index.d.ts

@@ -22,15 +22,16 @@
  */
 export * from './define-protocol.js';
 export * from './did-api.js';
-export * from './dwn-api.js';
+export * from './dwn-reader-api.js';
 export * from './grant-revocation.js';
 export * from './live-query.js';
 export * from './permission-grant.js';
 export * from './permission-request.js';
 export * from './protocol.js';
 export * from './protocol-types.js';
+export * from './read-only-record.js';
 export * from './record.js';
-export * from './typed-dwn-api.js';
+export * from './typed-web5.js';
 export * from './vc-api.js';
 export * from './web5.js';
 import * as utils from './utils.js';

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAEH,cAAc,sBAAsB,CAAC;AACrC,cAAc,cAAc,CAAC;AAC7B,cAAc,cAAc,CAAC;AAC7B,cAAc,uBAAuB,CAAC;AACtC,cAAc,iBAAiB,CAAC;AAChC,cAAc,uBAAuB,CAAC;AACtC,cAAc,yBAAyB,CAAC;AACxC,cAAc,eAAe,CAAC;AAC9B,cAAc,qBAAqB,CAAC;AACpC,cAAc,aAAa,CAAC;AAC5B,cAAc,oBAAoB,CAAC;AACnC,cAAc,aAAa,CAAC;AAC5B,cAAc,WAAW,CAAC;AAE1B,OAAO,KAAK,KAAK,MAAM,YAAY,CAAC;AACpC,OAAO,EAAE,KAAK,EAAE,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAEH,cAAc,sBAAsB,CAAC;AACrC,cAAc,cAAc,CAAC;AAC7B,cAAc,qBAAqB,CAAC;AACpC,cAAc,uBAAuB,CAAC;AACtC,cAAc,iBAAiB,CAAC;AAChC,cAAc,uBAAuB,CAAC;AACtC,cAAc,yBAAyB,CAAC;AACxC,cAAc,eAAe,CAAC;AAC9B,cAAc,qBAAqB,CAAC;AACpC,cAAc,uBAAuB,CAAC;AACtC,cAAc,aAAa,CAAC;AAC5B,cAAc,iBAAiB,CAAC;AAChC,cAAc,aAAa,CAAC;AAC5B,cAAc,WAAW,CAAC;AAE1B,OAAO,KAAK,KAAK,MAAM,YAAY,CAAC;AACpC,OAAO,EAAE,KAAK,EAAE,CAAC"}

package/dist/types/live-query.d.ts

@@ -1,5 +1,5 @@
-import type { RecordsQueryReplyEntry } from '@enbox/dwn-sdk-js';
 import type { DwnMessageSubscription, PermissionsApi, Web5Agent } from '@enbox/agent';
+import type { PaginationCursor, RecordsQueryReplyEntry } from '@enbox/dwn-sdk-js';
 import { Record } from './record.js';
 /**
  * The type of change that occurred to a record.
@@ -43,6 +43,8 @@ export type LiveQueryOptions = {
     permissionsApi?: PermissionsApi;
     /** The initial snapshot entries from the subscribe reply. */
     initialEntries: RecordsQueryReplyEntry[];
+    /** Pagination cursor for fetching the next page of initial results. */
+    cursor?: PaginationCursor;
     /** The underlying DWN subscription handle. */
     subscription: DwnMessageSubscription;
 };
@@ -97,6 +99,16 @@ export type LiveQueryOptions = {
 export declare class LiveQuery extends EventTarget {
     /** The initial snapshot of matching records. */
     readonly records: Record[];
+    /**
+     * Pagination cursor for fetching the next page of initial results.
+     *
+     * When the initial snapshot was limited (via `pagination.limit`), this
+     * cursor can be passed in a subsequent `records.subscribe()` call to
+     * continue from where the previous snapshot left off.
+     *
+     * `undefined` when there are no more results.
+     */
+    readonly cursor?: PaginationCursor;
     /** The underlying DWN subscription handle. */
     private _subscription;
     /** Tracks known record states for dedup and change-type classification. */

package/dist/types/live-query.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"live-query.d.ts","sourceRoot":"","sources":["../../src/live-query.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,mBAAmB,CAAC;AAChE,OAAO,KAAK,EAAE,sBAAsB,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAItF,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAErC;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,QAAQ,GAAG,QAAQ,GAAG,QAAQ,CAAC;AAE9D;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB,2DAA2D;IAC3D,IAAI,EAAE,gBAAgB,CAAC;IAEvB,yCAAyC;IACzC,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF;;;;;;GAMG;AACH,qBAAa,iBAAkB,SAAQ,WAAW,CAAC,YAAY,CAAC;gBAClD,MAAM,EAAE,YAAY;CAGjC;AAED;;;GAGG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,2DAA2D;IAC3D,KAAK,EAAE,SAAS,CAAC;IAEjB,qCAAqC;IACrC,YAAY,EAAE,MAAM,CAAC;IAErB,6DAA6D;IAC7D,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,yDAAyD;IACzD,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,iEAAiE;IACjE,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,oEAAoE;IACpE,cAAc,CAAC,EAAE,cAAc,CAAC;IAEhC,6DAA6D;IAC7D,cAAc,EAAE,sBAAsB,EAAE,CAAC;IAEzC,8CAA8C;IAC9C,YAAY,EAAE,sBAAsB,CAAC;CACtC,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+CG;AACH,qBAAa,SAAU,SAAQ,WAAW;IACxC,gDAAgD;IAChD,QAAQ,CAAC,OAAO,EAAE,MAAM,EAAE,CAAC;IAE3B,8CAA8C;IAC9C,OAAO,CAAC,aAAa,CAAyB;IAE9C,2EAA2E;IAC3E,OAAO,CAAC,aAAa,CAAsB;IAE3C,8CAA8C;IAC9C,OAAO,CAAC,OAAO,CAAS;gBAEZ,OAAO,EAAE,gBAAgB;IAiCrC;;;;;OAKG;IACI,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAqCxC;;;;;;;;;;;;OAYG;IACH,EAAE,CAAC,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,MAAM,EAAE,YAAY,KAAK,IAAI,GAAG,MAAM,IAAI;IACxE,EAAE,CAAC,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,GAAG,MAAM,IAAI;IAClE,EAAE,CAAC,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,GAAG,MAAM,IAAI;IAClE,EAAE,CAAC,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,GAAG,MAAM,IAAI;IAelE;;OAEG;IACG,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;CAO7B"}
+{"version":3,"file":"live-query.d.ts","sourceRoot":"","sources":["../../src/live-query.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,sBAAsB,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AACtF,OAAO,KAAK,EAAE,gBAAgB,EAAE,sBAAsB,EAAE,MAAM,mBAAmB,CAAC;AAIlF,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAErC;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,QAAQ,GAAG,QAAQ,GAAG,QAAQ,CAAC;AAE9D;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB,2DAA2D;IAC3D,IAAI,EAAE,gBAAgB,CAAC;IAEvB,yCAAyC;IACzC,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF;;;;;;GAMG;AACH,qBAAa,iBAAkB,SAAQ,WAAW,CAAC,YAAY,CAAC;gBAClD,MAAM,EAAE,YAAY;CAGjC;AAED;;;GAGG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,2DAA2D;IAC3D,KAAK,EAAE,SAAS,CAAC;IAEjB,qCAAqC;IACrC,YAAY,EAAE,MAAM,CAAC;IAErB,6DAA6D;IAC7D,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,yDAAyD;IACzD,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,iEAAiE;IACjE,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,oEAAoE;IACpE,cAAc,CAAC,EAAE,cAAc,CAAC;IAEhC,6DAA6D;IAC7D,cAAc,EAAE,sBAAsB,EAAE,CAAC;IAEzC,uEAAuE;IACvE,MAAM,CAAC,EAAE,gBAAgB,CAAC;IAE1B,8CAA8C;IAC9C,YAAY,EAAE,sBAAsB,CAAC;CACtC,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+CG;AACH,qBAAa,SAAU,SAAQ,WAAW;IACxC,gDAAgD;IAChD,QAAQ,CAAC,OAAO,EAAE,MAAM,EAAE,CAAC;IAE3B;;;;;;;;OAQG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,gBAAgB,CAAC;IAEnC,8CAA8C;IAC9C,OAAO,CAAC,aAAa,CAAyB;IAE9C,2EAA2E;IAC3E,OAAO,CAAC,aAAa,CAAsB;IAE3C,8CAA8C;IAC9C,OAAO,CAAC,OAAO,CAAS;gBAEZ,OAAO,EAAE,gBAAgB;IAmCrC;;;;;OAKG;IACI,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAqCxC;;;;;;;;;;;;OAYG;IACH,EAAE,CAAC,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,MAAM,EAAE,YAAY,KAAK,IAAI,GAAG,MAAM,IAAI;IACxE,EAAE,CAAC,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,GAAG,MAAM,IAAI;IAClE,EAAE,CAAC,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,GAAG,MAAM,IAAI;IAClE,EAAE,CAAC,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,GAAG,MAAM,IAAI;IAelE;;OAEG;IACG,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;CAO7B"}

package/dist/types/protocol-types.d.ts

@@ -64,7 +64,7 @@ export type TagKeys<Tags extends ProtocolTagsDefinition> = Exclude<Extract<keyof
 /**
  * A mapping from protocol type names to their TypeScript data shapes.
  *
- * Used as a type parameter to `defineProtocol()` and `TypedDwnApi` so that
+ * Used as a type parameter to `defineProtocol()` and `TypedWeb5` so that
  * the protocol definition JSON stays JSON-compatible while TypeScript types
  * are tracked separately.
  *
@@ -80,7 +80,7 @@ export type SchemaMap = Record<string, unknown>;
 /**
  * The return type of `defineProtocol()`. Bundles the raw protocol definition
  * with its inferred path strings and schema type map for downstream use
- * by `TypedDwnApi`.
+ * by `TypedWeb5`.
  */
 export type TypedProtocol<D extends ProtocolDefinition = ProtocolDefinition, M extends SchemaMap = SchemaMap> = {
     /** The raw DWN protocol definition (JSON-compatible). */