@enbox/api 0.1.1 → 0.2.0

package/dist/types/read-only-record.d.ts

@@ -0,0 +1,133 @@
+/**
+ * NOTE: Added reference types here to avoid a `pnpm` bug during build.
+ * https://github.com/enboxorg/enbox/pull/507
+ */
+import type { AnonymousDwnApi } from '@enbox/agent';
+import type { RecordsWriteMessage, RecordsWriteTags } from '@enbox/dwn-sdk-js';
+/**
+ * Construction options for a {@link ReadOnlyRecord}.
+ *
+ * @beta
+ */
+export type ReadOnlyRecordOptions = {
+    /** The raw `RecordsWriteMessage` returned from a query or read reply. */
+    rawMessage: RecordsWriteMessage;
+    /** The initial write message, if the record has been updated. */
+    initialWrite?: RecordsWriteMessage;
+    /** Encoded data (Base64URL string) if the data was small enough to be inlined in the query reply. */
+    encodedData?: string;
+    /** A readable data stream, present when the record comes from a `RecordsRead` reply. */
+    data?: ReadableStream;
+    /** The DID of the remote DWN this record was fetched from. Used for data re-fetch. */
+    remoteOrigin: string;
+    /** The {@link AnonymousDwnApi} instance used to re-fetch data when needed. */
+    anonymousDwn: AnonymousDwnApi;
+};
+/**
+ * An immutable, read-only view of a DWN record.
+ *
+ * `ReadOnlyRecord` is returned by {@link DwnReaderApi} methods and provides
+ * access to the record's metadata and data without any mutation capabilities.
+ * There are no `update()`, `delete()`, `send()`, `store()`, or `import()`
+ * methods — the compiler prevents accidental writes.
+ *
+ * Data access works identically to the full {@link Record} class:
+ * - If the data was inlined (small payloads from query replies), it is
+ *   available immediately.
+ * - If the data was not inlined, `data.stream()` / `data.text()` / etc.
+ *   automatically perform an anonymous `RecordsRead` to fetch it.
+ *
+ * @beta
+ */
+export declare class ReadOnlyRecord {
+    private _anonymousDwn;
+    private _remoteOrigin;
+    private _author;
+    private _creator;
+    private _descriptor;
+    private _recordId;
+    private _contextId?;
+    private _initialWrite?;
+    private _encodedData?;
+    private _readableStream?;
+    private _authorization;
+    private _attestation?;
+    private _encryption?;
+    constructor(options: ReadOnlyRecordOptions);
+    /** Record's unique identifier. */
+    get id(): string;
+    /** Record's context ID. */
+    get contextId(): string | undefined;
+    /** Record's creation date. */
+    get dateCreated(): string;
+    /** Record's parent ID. */
+    get parentId(): string | undefined;
+    /** Record's protocol URI. */
+    get protocol(): string | undefined;
+    /** Record's protocol path. */
+    get protocolPath(): string | undefined;
+    /** Record's recipient. */
+    get recipient(): string | undefined;
+    /** Record's schema. */
+    get schema(): string | undefined;
+    /** Record's data format / MIME type. */
+    get dataFormat(): string;
+    /** Record's data CID. */
+    get dataCid(): string;
+    /** Record's data size in bytes. */
+    get dataSize(): number;
+    /** Record's published date. */
+    get datePublished(): string | undefined;
+    /** Whether the record is published. */
+    get published(): boolean | undefined;
+    /** Tags associated with the record. */
+    get tags(): RecordsWriteTags | undefined;
+    /** DID that is the logical author of the record. */
+    get author(): string;
+    /** DID that originally created the record. */
+    get creator(): string;
+    /** Record's message timestamp (time of most recent create/update). */
+    get timestamp(): string;
+    /** Record's encryption metadata, if encrypted. */
+    get encryption(): RecordsWriteMessage['encryption'];
+    /** Record's authorization. */
+    get authorization(): RecordsWriteMessage['authorization'];
+    /** Record's attestation signatures. */
+    get attestation(): RecordsWriteMessage['attestation'];
+    /** The initial write message, if the record has been updated. */
+    get initialWrite(): RecordsWriteMessage | undefined;
+    /** The DID of the remote DWN this record was fetched from. */
+    get remoteOrigin(): string;
+    /**
+     * Returns the data of the current record.
+     * If the data is not available in-memory, it is fetched from the remote DWN
+     * using an anonymous `RecordsRead`.
+     *
+     * @returns A data accessor with `blob()`, `bytes()`, `json()`, `text()`, and `stream()` methods.
+     *
+     * @beta
+     */
+    get data(): {
+        blob: () => Promise<Blob>;
+        bytes: () => Promise<Uint8Array>;
+        json: <T = unknown>() => Promise<T>;
+        text: () => Promise<string>;
+        stream: () => Promise<ReadableStream>;
+        then: (onFulfilled?: (value: ReadableStream) => ReadableStream | PromiseLike<ReadableStream>, onRejected?: (reason: any) => PromiseLike<never>) => Promise<ReadableStream>;
+        catch: (onRejected?: (reason: any) => PromiseLike<never>) => Promise<ReadableStream>;
+    };
+    /**
+     * Returns a JSON representation of the record.
+     * Called by `JSON.stringify(...)` automatically.
+     */
+    toJSON(): Record<string, unknown>;
+    /**
+     * Convenience string representation.
+     */
+    toString(): string;
+    /**
+     * Fetches the record's data from the remote DWN using an anonymous `RecordsRead`.
+     */
+    private readRecordData;
+}
+//# sourceMappingURL=read-only-record.d.ts.map

package/dist/types/read-only-record.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"read-only-record.d.ts","sourceRoot":"","sources":["../../src/read-only-record.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AACpD,OAAO,KAAK,EAA0B,mBAAmB,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AAKvG;;;;GAIG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC,yEAAyE;IACzE,UAAU,EAAE,mBAAmB,CAAC;IAChC,iEAAiE;IACjE,YAAY,CAAC,EAAE,mBAAmB,CAAC;IACnC,qGAAqG;IACrG,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,wFAAwF;IACxF,IAAI,CAAC,EAAE,cAAc,CAAC;IACtB,sFAAsF;IACtF,YAAY,EAAE,MAAM,CAAC;IACrB,8EAA8E;IAC9E,YAAY,EAAE,eAAe,CAAC;CAC/B,CAAC;AAEF;;;;;;;;;;;;;;;GAeG;AACH,qBAAa,cAAc;IAEzB,OAAO,CAAC,aAAa,CAAkB;IACvC,OAAO,CAAC,aAAa,CAAS;IAC9B,OAAO,CAAC,OAAO,CAAS;IACxB,OAAO,CAAC,QAAQ,CAAS;IACzB,OAAO,CAAC,WAAW,CAAyB;IAC5C,OAAO,CAAC,SAAS,CAAS;IAC1B,OAAO,CAAC,UAAU,CAAC,CAAS;IAC5B,OAAO,CAAC,aAAa,CAAC,CAAsB;IAC5C,OAAO,CAAC,YAAY,CAAC,CAAO;IAC5B,OAAO,CAAC,eAAe,CAAC,CAAiB;IACzC,OAAO,CAAC,cAAc,CAAuC;IAC7D,OAAO,CAAC,YAAY,CAAC,CAAqC;IAC1D,OAAO,CAAC,WAAW,CAAC,CAAoC;gBAE5C,OAAO,EAAE,qBAAqB;IA6C1C,kCAAkC;IAClC,IAAI,EAAE,IAAI,MAAM,CAA2B;IAE3C,2BAA2B;IAC3B,IAAI,SAAS,IAAI,MAAM,GAAG,SAAS,CAA4B;IAE/D,8BAA8B;IAC9B,IAAI,WAAW,IAAI,MAAM,CAAyC;IAElE,0BAA0B;IAC1B,IAAI,QAAQ,IAAI,MAAM,GAAG,SAAS,CAAsC;IAExE,6BAA6B;IAC7B,IAAI,QAAQ,IAAI,MAAM,GAAG,SAAS,CAAsC;IAExE,8BAA8B;IAC9B,IAAI,YAAY,IAAI,MAAM,GAAG,SAAS,CAA0C;IAEhF,0BAA0B;IAC1B,IAAI,SAAS,IAAI,MAAM,GAAG,SAAS,CAAuC;IAE1E,uBAAuB;IACvB,IAAI,MAAM,IAAI,MAAM,GAAG,SAAS,CAAoC;IAMpE,wCAAwC;IACxC,IAAI,UAAU,IAAI,MAAM,CAAwC;IAEhE,yBAAyB;IACzB,IAAI,OAAO,IAAI,MAAM,CAAqC;IAE1D,mCAAmC;IACnC,IAAI,QAAQ,IAAI,MAAM,CAAsC;IAE5D,+BAA+B;IAC/B,IAAI,aAAa,IAAI,MAAM,GAAG,SAAS,CAA2C;IAElF,uCAAuC;IACvC,IAAI,SAAS,IAAI,OAAO,GAAG,SAAS,CAAuC;IAE3E,uCAAuC;IACvC,IAAI,IAAI,IAAI,gBAAgB,GAAG,SAAS,CAAkC;IAM1E,oDAAoD;IACpD,IAAI,MAAM,IAAI,MAAM,CAAyB;IAE7C,8CAA8C;IAC9C,IAAI,OAAO,IAAI,MAAM,CAA0B;IAE/C,sEAAsE;IACtE,IAAI,SAAS,IAAI,MAAM,CAA8C;IAErE,kDAAkD;IAClD,IAAI,UAAU,IAAI,mBAAmB,CAAC,YAAY,CAAC,CAA6B;IAEhF,8BAA8B;IAC9B,IAAI,aAAa,IAAI,mBAAmB,CAAC,eAAe,CAAC,CAAgC;IAEzF,uCAAuC;IACvC,IAAI,WAAW,IAAI,mBAAmB,CAAC,aAAa,CAAC,CAA8B;IAEnF,iEAAiE;IACjE,IAAI,YAAY,IAAI,mBAAmB,GAAG,SAAS,CAA+B;IAElF,8DAA8D;IAC9D,IAAI,YAAY,IAAI,MAAM,CAA+B;IAMzD;;;;;;;;OAQG;IACH,IAAI,IAAI,IAAI;QACR,IAAI,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;QAC1B,KAAK,EAAE,MAAM,OAAO,CAAC,UAAU,CAAC,CAAC;QACjC,IAAI,EAAE,CAAC,CAAC,GAAG,OAAO,OAAO,OAAO,CAAC,CAAC,CAAC,CAAC;QACpC,IAAI,EAAE,MAAM,OAAO,CAAC,MAAM,CAAC,CAAC;QAC5B,MAAM,EAAE,MAAM,OAAO,CAAC,cAAc,CAAC,CAAC;QACtC,IAAI,EAAE,CACJ,WAAW,CAAC,EAAE,CAAC,KAAK,EAAE,cAAc,KAAK,cAAc,GAAG,WAAW,CAAC,cAAc,CAAC,EACrF,UAAU,CAAC,EAAE,CAAC,MAAM,EAAE,GAAG,KAAK,WAAW,CAAC,KAAK,CAAC,KAC7C,OAAO,CAAC,cAAc,CAAC,CAAC;QAC7B,KAAK,EAAE,CAAC,UAAU,CAAC,EAAE,CAAC,MAAM,EAAE,GAAG,KAAK,WAAW,CAAC,KAAK,CAAC,KAAK,OAAO,CAAC,cAAc,CAAC,CAAC;KACpF,CA6CJ;IAMD;;;OAGG;IACH,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAwBjC;;OAEG;IACH,QAAQ,IAAI,MAAM;IAmBlB;;OAEG;YACW,cAAc;CAgB7B"}

package/dist/types/record.d.ts

@@ -27,8 +27,8 @@ export type RecordModel = ImmutableRecordProperties & OptionalRecordProperties &
     author: string;
     /** The unique identifier of the record. */
     recordId?: string;
-    /** The timestamp indicating when the record was last modified. */
-    messageTimestamp?: string;
+    /** The message timestamp (time of creation, most recent update, or deletion). */
+    timestamp?: string;
     /** The protocol role under which this record is written. */
     protocolRole?: RecordOptions['protocolRole'];
 };
@@ -100,8 +100,8 @@ export type RecordUpdateParams = {
     dataFormat?: string;
     /** The size of the data in bytes. */
     dataSize?: DwnMessageDescriptor[DwnInterface.RecordsWrite]['dataSize'];
-    /** The timestamp indicating when the record was last modified. */
-    dateModified?: DwnMessageDescriptor[DwnInterface.RecordsWrite]['messageTimestamp'];
+    /** The timestamp of the update message. */
+    timestamp?: DwnMessageDescriptor[DwnInterface.RecordsWrite]['messageTimestamp'];
     /** The timestamp indicating when the record was published. */
     datePublished?: DwnMessageDescriptor[DwnInterface.RecordsWrite]['datePublished'];
     /** The protocol role under which this record is written. */
@@ -134,11 +134,29 @@ export type RecordDeleteParams = {
     signAsOwner?: boolean;
     /** Whether or not to prune any children this record may have. */
     prune?: DwnMessageDescriptor[DwnInterface.RecordsDelete]['prune'];
-    /** The timestamp indicating when the record was deleted. */
-    dateModified?: DwnMessageDescriptor[DwnInterface.RecordsDelete]['messageTimestamp'];
+    /** The timestamp of the delete message. */
+    timestamp?: DwnMessageDescriptor[DwnInterface.RecordsDelete]['messageTimestamp'];
     /** The protocol role under which this record will be deleted. */
     protocolRole?: string;
 };
+/**
+ * The result of a {@link Record.update} operation.
+ *
+ * @beta
+ */
+export type RecordUpdateResult = DwnResponseStatus & {
+    /** The updated Record instance reflecting the new state. */
+    record: Record;
+};
+/**
+ * The result of a {@link Record.delete} operation.
+ *
+ * @beta
+ */
+export type RecordDeleteResult = DwnResponseStatus & {
+    /** The deleted Record instance reflecting the deleted state. */
+    record: Record;
+};
 /**
  * The `Record` class encapsulates a single record's data and metadata, providing a more
  * developer-friendly interface for working with Decentralized Web Node (DWN) records.
@@ -146,12 +164,9 @@ export type RecordDeleteParams = {
  * Methods are provided to read, update, and manage the record's lifecycle, including writing to
  * remote DWNs.
  *
- * Note: The `messageTimestamp` of the most recent RecordsWrite message is
- *       logically equivalent to the date/time at which a Record was most
- *       recently modified.  Since this Record class implementation is
- *       intended to simplify the developer experience of working with
- *       logical records (and not individual DWN messages) the
- *       `messageTimestamp` is mapped to `dateModified`.
+ * Note: The DWN SDK's `messageTimestamp` is exposed as `timestamp` on
+ *       the Record class. It represents the time of the most recent
+ *       message (create, update, or delete) for this logical record.
  *
  * @beta
  */
@@ -199,6 +214,10 @@ export declare class Record implements RecordModel {
     private _recordId;
     /** Role under which the record is written. */
     private _protocolRole?;
+    /** Cached reconstructed raw message, invalidated when record state changes. */
+    private _rawMessageCache?;
+    /** Dirty flag indicating the cached raw message needs to be rebuilt. */
+    private _rawMessageDirty;
     /** The `RecordsWriteMessage` descriptor unless the record is in a deleted state */
     private get _recordsWriteDescriptor();
     /** The `RecordsWrite` descriptor from the current record or the initial write if the record is in a delete state. */
@@ -235,8 +254,8 @@ export declare class Record implements RecordModel {
     get author(): string;
     /** DID that is the original creator of the Record. */
     get creator(): string;
-    /** Record's modified date */
-    get dateModified(): string;
+    /** Record's message timestamp (time of creation, most recent update, or deletion). */
+    get timestamp(): string;
     /** Record's encryption */
     get encryption(): DwnMessage[DwnInterface.RecordsWrite]['encryption'];
     /** Record's signatures attestation */
@@ -251,6 +270,7 @@ export declare class Record implements RecordModel {
     get initialWrite(): RecordOptions['initialWrite'];
     /**
      * Returns a copy of the raw `RecordsWriteMessage` that was used to create the current `Record` instance.
+     * The result is cached and only rebuilt when the record's state changes (via `update()` or `delete()`).
      */
     get rawMessage(): DwnMessage[DwnInterface.RecordsWrite] | DwnMessage[DwnInterface.RecordsDelete];
     constructor(agent: Web5Agent, options: RecordOptions, permissionsApi?: PermissionsApi);
@@ -329,13 +349,13 @@ export declare class Record implements RecordModel {
      *
      * @beta
      */
-    update({ dateModified, data, encryption, protocolRole, store, ...params }: RecordUpdateParams): Promise<DwnResponseStatus>;
+    update({ timestamp, data, encryption, protocolRole, store, ...params }: RecordUpdateParams): Promise<RecordUpdateResult>;
     /**
      * Delete the current record on the DWN.
      * @param params - Parameters to delete the record.
-     * @returns the status of the delete request
+     * @returns the status and a new Record instance reflecting the deleted state
      */
-    delete(deleteParams?: RecordDeleteParams): Promise<DwnResponseStatus>;
+    delete(deleteParams?: RecordDeleteParams): Promise<RecordDeleteResult>;
     /**
      * Process the initial write, if it hasn't already been processed, with the options set for storing and/or signing as the owner.
      */

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

@@ -1 +1 @@
-{"version":3,"file":"record.d.ts","sourceRoot":"","sources":["../../src/record.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,KAAK,EACV,WAAW,EACX,UAAU,EACV,oBAAoB,EAEpB,mBAAmB,EACnB,iBAAiB,EACjB,cAAc,EAGd,SAAS,EACV,MAAM,cAAc,CAAC;AAEtB,OAAO,EAEL,YAAY,EAKb,MAAM,cAAc,CAAC;AAKtB;;;;KAIK;AACL,MAAM,MAAM,yBAAyB,GACnC,IAAI,CAAC,oBAAoB,CAAC,YAAY,CAAC,YAAY,CAAC,EAAE,aAAa,GAAG,UAAU,GAAG,UAAU,GAAG,cAAc,GAAG,WAAW,GAAG,QAAQ,CAAC,CAAC;AAE3I;;;;EAIE;AACF,MAAM,MAAM,wBAAwB,GAClC,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC,YAAY,CAAC,EAAE,eAAe,GAAG,aAAa,GAAG,YAAY,GAAG,WAAW,CAAE,GAC1G,IAAI,CAAC,oBAAoB,CAAC,YAAY,CAAC,YAAY,CAAC,EAAE,YAAY,GAAG,SAAS,GAAG,UAAU,GAAG,eAAe,GAAG,WAAW,GAAG,MAAM,CAAC,CAAC;AAExI;;;;;GAKG;AACH,MAAM,MAAM,WAAW,GAAG,yBAAyB,GAAG,wBAAwB,GAAG;IAE/E,wCAAwC;IACxC,MAAM,EAAE,MAAM,CAAC;IAEf,2CAA2C;IAC3C,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,kEAAkE;IAClE,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B,4DAA4D;IAC5D,YAAY,CAAC,EAAE,aAAa,CAAC,cAAc,CAAC,CAAC;CAC9C,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,MAAM,aAAa,GAAG,UAAU,CAAC,YAAY,CAAC,YAAY,GAAG,YAAY,CAAC,aAAa,CAAC,GAAG;IAC/F,sCAAsC;IACtC,MAAM,EAAE,MAAM,CAAC;IAEf,mDAAmD;IACnD,WAAW,CAAC,EAAE,UAAU,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC,aAAa,CAAC,CAAC;IAEnE,iDAAiD;IACjD,UAAU,CAAC,EAAE,UAAU,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC,YAAY,CAAC,CAAC;IAEjE,gDAAgD;IAChD,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,0CAA0C;IAC1C,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,mFAAmF;IACnF,YAAY,EAAE,MAAM,CAAC;IAErB,iFAAiF;IACjF,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,+EAA+E;IAC/E,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;;;;;;OAOG;IACH,IAAI,CAAC,EAAE,cAAc,CAAC;IAEtB,iGAAiG;IACjG,YAAY,CAAC,EAAE,UAAU,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC;IAErD,4DAA4D;IAC5D,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,iFAAiF;IACjF,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;;;OAIG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC;IAEf;;;OAGG;IACH,OAAO,CAAC,EAAE,oBAAoB,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC,SAAS,CAAC,CAAC;IAErE,mDAAmD;IACnD,KAAK,CAAC,EAAE,OAAO,CAAC;IAEhB,qDAAqD;IACrD,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,qCAAqC;IACrC,QAAQ,CAAC,EAAE,oBAAoB,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC,UAAU,CAAC,CAAC;IAEvE,kEAAkE;IAClE,YAAY,CAAC,EAAE,oBAAoB,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC,kBAAkB,CAAC,CAAC;IAEnF,8DAA8D;IAC9D,aAAa,CAAC,EAAE,oBAAoB,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC,eAAe,CAAC,CAAC;IAEjF,4DAA4D;IAC5D,YAAY,CAAC,EAAE,aAAa,CAAC,cAAc,CAAC,CAAC;IAE7C,0CAA0C;IAC1C,SAAS,CAAC,EAAE,oBAAoB,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC,WAAW,CAAC,CAAC;IAGzE,kDAAkD;IAClD,IAAI,CAAC,EAAE,oBAAoB,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC,MAAM,CAAC,CAAC;IAE/D;;;;;;OAMG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B,2CAA2C;IAC3C,KAAK,CAAC,EAAE,OAAO,CAAC;IAEhB,2EAA2E;IAC3E,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB,iEAAiE;IACjE,KAAK,CAAC,EAAE,oBAAoB,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC,OAAO,CAAC,CAAC;IAElE,4DAA4D;IAC5D,YAAY,CAAC,EAAE,oBAAoB,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC,kBAAkB,CAAC,CAAC;IAEpF,iEAAiE;IACjE,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB,CAAC;AAEF;;;;;;;;;;;;;;;GAeG;AACH,qBAAa,MAAO,YAAW,WAAW;IACxC;;;OAGG;IACH,OAAO,CAAC,MAAM,CAAC,UAAU,CAAa;IAItC,iEAAiE;IACjE,OAAO,CAAC,MAAM,CAAY;IAC1B,4EAA4E;IAC5E,OAAO,CAAC,aAAa,CAAS;IAC9B,8EAA8E;IAC9E,OAAO,CAAC,YAAY,CAAC,CAAS;IAC9B,4GAA4G;IAC5G,OAAO,CAAC,eAAe,CAAiB;IACxC,gDAAgD;IAChD,OAAO,CAAC,YAAY,CAAC,CAAO;IAC5B,yFAAyF;IACzF,OAAO,CAAC,eAAe,CAAC,CAAiB;IACzC,kEAAkE;IAClE,OAAO,CAAC,aAAa,CAAC,CAAS;IAI/B,+EAA+E;IAC/E,OAAO,CAAC,OAAO,CAAS;IACxB,gEAAgE;IAChE,OAAO,CAAC,QAAQ,CAAS;IACzB,iCAAiC;IACjC,OAAO,CAAC,YAAY,CAAC,CAAuD;IAC5E,kCAAkC;IAClC,OAAO,CAAC,cAAc,CAAC,CAAsF;IAC7G,6CAA6C;IAC7C,OAAO,CAAC,UAAU,CAAC,CAAS;IAC5B,4EAA4E;IAC5E,OAAO,CAAC,WAAW,CAAqG;IACxH,mEAAmE;IACnE,OAAO,CAAC,WAAW,CAAC,CAAsD;IAC1E,sDAAsD;IACtD,OAAO,CAAC,aAAa,CAAgC;IACrD,mFAAmF;IACnF,OAAO,CAAC,mBAAmB,CAAU;IACrC,yEAAyE;IACzE,OAAO,CAAC,mBAAmB,CAAU;IACrC,uCAAuC;IACvC,OAAO,CAAC,SAAS,CAAS;IAC1B,8CAA8C;IAC9C,OAAO,CAAC,aAAa,CAAC,CAAgC;IAEtD,mFAAmF;IACnF,OAAO,KAAK,uBAAuB,GAMlC;IAED,qHAAqH;IACrH,OAAO,KAAK,oBAAoB,GAE/B;IAGD,kBAAkB;IAClB,IAAI,EAAE,IAAI,MAAM,CAA2B;IAE3C,iGAAiG;IACjG,IAAI,SAAS,IAAI,MAAM,GAAG,SAAS,CAA0E;IAE7G,6BAA6B;IAC7B,IAAI,WAAW,IAAI,MAAM,CAAkD;IAE3E,yBAAyB;IACzB,IAAI,QAAQ,IAAI,MAAM,GAAG,SAAS,CAA+C;IAEjF,wBAAwB;IACxB,IAAI,QAAQ,IAAI,MAAM,GAAG,SAAS,CAA+C;IAEjF,6BAA6B;IAC7B,IAAI,YAAY,IAAI,MAAM,GAAG,SAAS,CAAmD;IAEzF,yBAAyB;IACzB,IAAI,SAAS,IAAI,MAAM,GAAG,SAAS,CAAgD;IAEnF,sBAAsB;IACtB,IAAI,MAAM,IAAI,MAAM,GAAG,SAAS,CAA6C;IAI7E,2BAA2B;IAC3B,IAAI,UAAU,IAAI,MAAM,GAAG,SAAS,CAAqD;IAEzF,mBAAmB;IACnB,IAAI,OAAO,IAAI,MAAM,GAAG,SAAS,CAAkD;IAEnF,yBAAyB;IACzB,IAAI,QAAQ,IAAI,MAAM,GAAG,SAAS,CAAmD;IAErF,8BAA8B;IAC9B,IAAI,aAAa,IAAI,MAAM,GAAG,SAAS,CAAwD;IAE/F,6CAA6C;IAC7C,IAAI,SAAS,IAAI,OAAO,GAAG,SAAS,CAAoD;IAExF,yBAAyB;IACzB,IAAI,IAAI,IAAI,oBAAoB,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC,MAAM,CAAC,GAAG,SAAS,CAE9E;IAGD,oDAAoD;IACpD,IAAI,MAAM,IAAI,MAAM,CAAyB;IAE7C,sDAAsD;IACtD,IAAI,OAAO,IAAI,MAAM,CAA0B;IAE/C,6BAA6B;IAC7B,IAAI,YAAY,IAAI,MAAM,CAA8C;IAExE,0BAA0B;IAC1B,IAAI,UAAU,IAAI,UAAU,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC,YAAY,CAAC,CAA6B;IAElG,sCAAsC;IACtC,IAAI,aAAa,IAAI,UAAU,CAAC,YAAY,CAAC,YAAY,GAAG,YAAY,CAAC,aAAa,CAAC,CAAC,eAAe,CAAC,CAAgC;IAExI,sCAAsC;IACtC,IAAI,WAAW,IAAI,UAAU,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC,aAAa,CAAC,GAAG,SAAS,CAA8B;IAEjH,wDAAwD;IACxD,IAAI,YAAY,IAAI,MAAM,GAAG,SAAS,CAA+B;IAErE,0CAA0C;IAC1C,IAAI,OAAO,IAAI,OAAO,CAAsE;IAE5F,4DAA4D;IAC5D,IAAI,YAAY,IAAI,aAAa,CAAC,cAAc,CAAC,CAA+B;IAEhF;;OAEG;IACH,IAAI,UAAU,IAAI,UAAU,CAAC,YAAY,CAAC,YAAY,CAAC,GAAG,UAAU,CAAC,YAAY,CAAC,aAAa,CAAC,CAqB/F;gBAEW,KAAK,EAAE,SAAS,EAAE,OAAO,EAAE,aAAa,EAAE,cAAc,CAAC,EAAE,cAAc;IAiDrF;;;;;;;OAOG;IACH,IAAI,IAAI,IAAI;QACR,IAAI,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;QAC1B,KAAK,EAAE,MAAM,OAAO,CAAC,UAAU,CAAC,CAAC;QACjC,IAAI,EAAE,CAAC,CAAC,GAAG,OAAO,OAAO,OAAO,CAAC,CAAC,CAAC,CAAC;QACpC,IAAI,EAAE,MAAM,OAAO,CAAC,MAAM,CAAC,CAAC;QAC5B,MAAM,EAAE,MAAM,OAAO,CAAC,cAAc,CAAC,CAAC;QACtC,IAAI,EAAE,CACJ,WAAW,CAAC,EAAE,CAAC,KAAK,EAAE,cAAc,KAAK,cAAc,GAAG,WAAW,CAAC,cAAc,CAAC,EACrF,UAAU,CAAC,EAAE,CAAC,MAAM,EAAE,GAAG,KAAK,WAAW,CAAC,KAAK,CAAC,KAC7C,OAAO,CAAC,cAAc,CAAC,CAAC;QAC7B,KAAK,EAAE,CAAC,UAAU,CAAC,EAAE,CAAC,MAAM,EAAE,GAAG,KAAK,WAAW,CAAC,KAAK,CAAC,KAAK,OAAO,CAAC,cAAc,CAAC,CAAC;KACpF,CAkIJ;IAED;;;;;;;OAOG;IACG,KAAK,CAAC,YAAY,GAAE,OAAe,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAKtE;;;;;;;;OAQG;IACG,MAAM,CAAC,KAAK,GAAE,OAAc,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAI/D;;;;;;;;;;;;OAYG;IACG,IAAI,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,CAAC;IA+CvD;;;OAGG;IACH,MAAM,IAAI,WAAW;IAyBrB;;;OAGG;IACH,QAAQ,IAAI,MAAM;IAqBlB;;;;;OAKG;IACG,gBAAgB,CAAC,IAAI,EAAE,WAAW,GAAG,OAAO,CAAC,mBAAmB,GAAG,SAAS,CAAC;IAInF;;;;;;;OAOG;IACG,MAAM,CAAC,EAAE,YAAY,EAAE,IAAI,EAAE,UAAU,EAAE,YAAY,EAAE,KAAY,EAAE,GAAG,MAAM,EAAE,EAAE,kBAAkB,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAyGvI;;;;OAIG;IACG,MAAM,CAAC,YAAY,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAqF3E;;OAEG;YACW,2BAA2B;IAiDzC;;;OAGG;YACW,aAAa;IA+D3B;;;;;;;;;;;;;;;OAeG;YACW,cAAc;IA0D5B;;;;;;;;;;;;;;OAcG;IACH,OAAO,CAAC,MAAM,CAAC,uBAAuB;IAQtC;;;;OAIG;IACH,OAAO,CAAC,yBAAyB;CAKlC"}
+{"version":3,"file":"record.d.ts","sourceRoot":"","sources":["../../src/record.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,KAAK,EACV,WAAW,EACX,UAAU,EACV,oBAAoB,EAEpB,mBAAmB,EACnB,iBAAiB,EACjB,cAAc,EAGd,SAAS,EACV,MAAM,cAAc,CAAC;AAEtB,OAAO,EAEL,YAAY,EAKb,MAAM,cAAc,CAAC;AAKtB;;;;KAIK;AACL,MAAM,MAAM,yBAAyB,GACnC,IAAI,CAAC,oBAAoB,CAAC,YAAY,CAAC,YAAY,CAAC,EAAE,aAAa,GAAG,UAAU,GAAG,UAAU,GAAG,cAAc,GAAG,WAAW,GAAG,QAAQ,CAAC,CAAC;AAE3I;;;;EAIE;AACF,MAAM,MAAM,wBAAwB,GAClC,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC,YAAY,CAAC,EAAE,eAAe,GAAG,aAAa,GAAG,YAAY,GAAG,WAAW,CAAE,GAC1G,IAAI,CAAC,oBAAoB,CAAC,YAAY,CAAC,YAAY,CAAC,EAAE,YAAY,GAAG,SAAS,GAAG,UAAU,GAAG,eAAe,GAAG,WAAW,GAAG,MAAM,CAAC,CAAC;AAExI;;;;;GAKG;AACH,MAAM,MAAM,WAAW,GAAG,yBAAyB,GAAG,wBAAwB,GAAG;IAE/E,wCAAwC;IACxC,MAAM,EAAE,MAAM,CAAC;IAEf,2CAA2C;IAC3C,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,iFAAiF;IACjF,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,4DAA4D;IAC5D,YAAY,CAAC,EAAE,aAAa,CAAC,cAAc,CAAC,CAAC;CAC9C,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,MAAM,aAAa,GAAG,UAAU,CAAC,YAAY,CAAC,YAAY,GAAG,YAAY,CAAC,aAAa,CAAC,GAAG;IAC/F,sCAAsC;IACtC,MAAM,EAAE,MAAM,CAAC;IAEf,mDAAmD;IACnD,WAAW,CAAC,EAAE,UAAU,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC,aAAa,CAAC,CAAC;IAEnE,iDAAiD;IACjD,UAAU,CAAC,EAAE,UAAU,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC,YAAY,CAAC,CAAC;IAEjE,gDAAgD;IAChD,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,0CAA0C;IAC1C,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,mFAAmF;IACnF,YAAY,EAAE,MAAM,CAAC;IAErB,iFAAiF;IACjF,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,+EAA+E;IAC/E,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;;;;;;OAOG;IACH,IAAI,CAAC,EAAE,cAAc,CAAC;IAEtB,iGAAiG;IACjG,YAAY,CAAC,EAAE,UAAU,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC;IAErD,4DAA4D;IAC5D,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,iFAAiF;IACjF,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;;;OAIG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC;IAEf;;;OAGG;IACH,OAAO,CAAC,EAAE,oBAAoB,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC,SAAS,CAAC,CAAC;IAErE,mDAAmD;IACnD,KAAK,CAAC,EAAE,OAAO,CAAC;IAEhB,qDAAqD;IACrD,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,qCAAqC;IACrC,QAAQ,CAAC,EAAE,oBAAoB,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC,UAAU,CAAC,CAAC;IAEvE,2CAA2C;IAC3C,SAAS,CAAC,EAAE,oBAAoB,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC,kBAAkB,CAAC,CAAC;IAEhF,8DAA8D;IAC9D,aAAa,CAAC,EAAE,oBAAoB,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC,eAAe,CAAC,CAAC;IAEjF,4DAA4D;IAC5D,YAAY,CAAC,EAAE,aAAa,CAAC,cAAc,CAAC,CAAC;IAE7C,0CAA0C;IAC1C,SAAS,CAAC,EAAE,oBAAoB,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC,WAAW,CAAC,CAAC;IAGzE,kDAAkD;IAClD,IAAI,CAAC,EAAE,oBAAoB,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC,MAAM,CAAC,CAAC;IAE/D;;;;;;OAMG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B,2CAA2C;IAC3C,KAAK,CAAC,EAAE,OAAO,CAAC;IAEhB,2EAA2E;IAC3E,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB,iEAAiE;IACjE,KAAK,CAAC,EAAE,oBAAoB,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC,OAAO,CAAC,CAAC;IAElE,2CAA2C;IAC3C,SAAS,CAAC,EAAE,oBAAoB,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC,kBAAkB,CAAC,CAAC;IAEjF,iEAAiE;IACjE,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,GAAG,iBAAiB,GAAG;IACnD,4DAA4D;IAC5D,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,GAAG,iBAAiB,GAAG;IACnD,gEAAgE;IAChE,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,qBAAa,MAAO,YAAW,WAAW;IACxC;;;OAGG;IACH,OAAO,CAAC,MAAM,CAAC,UAAU,CAAa;IAItC,iEAAiE;IACjE,OAAO,CAAC,MAAM,CAAY;IAC1B,4EAA4E;IAC5E,OAAO,CAAC,aAAa,CAAS;IAC9B,8EAA8E;IAC9E,OAAO,CAAC,YAAY,CAAC,CAAS;IAC9B,4GAA4G;IAC5G,OAAO,CAAC,eAAe,CAAiB;IACxC,gDAAgD;IAChD,OAAO,CAAC,YAAY,CAAC,CAAO;IAC5B,yFAAyF;IACzF,OAAO,CAAC,eAAe,CAAC,CAAiB;IACzC,kEAAkE;IAClE,OAAO,CAAC,aAAa,CAAC,CAAS;IAI/B,+EAA+E;IAC/E,OAAO,CAAC,OAAO,CAAS;IACxB,gEAAgE;IAChE,OAAO,CAAC,QAAQ,CAAS;IACzB,iCAAiC;IACjC,OAAO,CAAC,YAAY,CAAC,CAAuD;IAC5E,kCAAkC;IAClC,OAAO,CAAC,cAAc,CAAC,CAAsF;IAC7G,6CAA6C;IAC7C,OAAO,CAAC,UAAU,CAAC,CAAS;IAC5B,4EAA4E;IAC5E,OAAO,CAAC,WAAW,CAAqG;IACxH,mEAAmE;IACnE,OAAO,CAAC,WAAW,CAAC,CAAsD;IAC1E,sDAAsD;IACtD,OAAO,CAAC,aAAa,CAAgC;IACrD,mFAAmF;IACnF,OAAO,CAAC,mBAAmB,CAAU;IACrC,yEAAyE;IACzE,OAAO,CAAC,mBAAmB,CAAU;IACrC,uCAAuC;IACvC,OAAO,CAAC,SAAS,CAAS;IAC1B,8CAA8C;IAC9C,OAAO,CAAC,aAAa,CAAC,CAAgC;IAEtD,+EAA+E;IAC/E,OAAO,CAAC,gBAAgB,CAAC,CAAiF;IAC1G,wEAAwE;IACxE,OAAO,CAAC,gBAAgB,CAAiB;IAEzC,mFAAmF;IACnF,OAAO,KAAK,uBAAuB,GAMlC;IAED,qHAAqH;IACrH,OAAO,KAAK,oBAAoB,GAE/B;IAGD,kBAAkB;IAClB,IAAI,EAAE,IAAI,MAAM,CAA2B;IAE3C,iGAAiG;IACjG,IAAI,SAAS,IAAI,MAAM,GAAG,SAAS,CAA0E;IAE7G,6BAA6B;IAC7B,IAAI,WAAW,IAAI,MAAM,CAAkD;IAE3E,yBAAyB;IACzB,IAAI,QAAQ,IAAI,MAAM,GAAG,SAAS,CAA+C;IAEjF,wBAAwB;IACxB,IAAI,QAAQ,IAAI,MAAM,GAAG,SAAS,CAA+C;IAEjF,6BAA6B;IAC7B,IAAI,YAAY,IAAI,MAAM,GAAG,SAAS,CAAmD;IAEzF,yBAAyB;IACzB,IAAI,SAAS,IAAI,MAAM,GAAG,SAAS,CAAgD;IAEnF,sBAAsB;IACtB,IAAI,MAAM,IAAI,MAAM,GAAG,SAAS,CAA6C;IAI7E,2BAA2B;IAC3B,IAAI,UAAU,IAAI,MAAM,GAAG,SAAS,CAAqD;IAEzF,mBAAmB;IACnB,IAAI,OAAO,IAAI,MAAM,GAAG,SAAS,CAAkD;IAEnF,yBAAyB;IACzB,IAAI,QAAQ,IAAI,MAAM,GAAG,SAAS,CAAmD;IAErF,8BAA8B;IAC9B,IAAI,aAAa,IAAI,MAAM,GAAG,SAAS,CAAwD;IAE/F,6CAA6C;IAC7C,IAAI,SAAS,IAAI,OAAO,GAAG,SAAS,CAAoD;IAExF,yBAAyB;IACzB,IAAI,IAAI,IAAI,oBAAoB,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC,MAAM,CAAC,GAAG,SAAS,CAE9E;IAGD,oDAAoD;IACpD,IAAI,MAAM,IAAI,MAAM,CAAyB;IAE7C,sDAAsD;IACtD,IAAI,OAAO,IAAI,MAAM,CAA0B;IAE/C,sFAAsF;IACtF,IAAI,SAAS,IAAI,MAAM,CAA8C;IAErE,0BAA0B;IAC1B,IAAI,UAAU,IAAI,UAAU,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC,YAAY,CAAC,CAA6B;IAElG,sCAAsC;IACtC,IAAI,aAAa,IAAI,UAAU,CAAC,YAAY,CAAC,YAAY,GAAG,YAAY,CAAC,aAAa,CAAC,CAAC,eAAe,CAAC,CAAgC;IAExI,sCAAsC;IACtC,IAAI,WAAW,IAAI,UAAU,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC,aAAa,CAAC,GAAG,SAAS,CAA8B;IAEjH,wDAAwD;IACxD,IAAI,YAAY,IAAI,MAAM,GAAG,SAAS,CAA+B;IAErE,0CAA0C;IAC1C,IAAI,OAAO,IAAI,OAAO,CAA6D;IAEnF,4DAA4D;IAC5D,IAAI,YAAY,IAAI,aAAa,CAAC,cAAc,CAAC,CAA+B;IAEhF;;;OAGG;IACH,IAAI,UAAU,IAAI,UAAU,CAAC,YAAY,CAAC,YAAY,CAAC,GAAG,UAAU,CAAC,YAAY,CAAC,aAAa,CAAC,CA4B/F;gBAEW,KAAK,EAAE,SAAS,EAAE,OAAO,EAAE,aAAa,EAAE,cAAc,CAAC,EAAE,cAAc;IAiDrF;;;;;;;OAOG;IACH,IAAI,IAAI,IAAI;QACR,IAAI,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;QAC1B,KAAK,EAAE,MAAM,OAAO,CAAC,UAAU,CAAC,CAAC;QACjC,IAAI,EAAE,CAAC,CAAC,GAAG,OAAO,OAAO,OAAO,CAAC,CAAC,CAAC,CAAC;QACpC,IAAI,EAAE,MAAM,OAAO,CAAC,MAAM,CAAC,CAAC;QAC5B,MAAM,EAAE,MAAM,OAAO,CAAC,cAAc,CAAC,CAAC;QACtC,IAAI,EAAE,CACJ,WAAW,CAAC,EAAE,CAAC,KAAK,EAAE,cAAc,KAAK,cAAc,GAAG,WAAW,CAAC,cAAc,CAAC,EACrF,UAAU,CAAC,EAAE,CAAC,MAAM,EAAE,GAAG,KAAK,WAAW,CAAC,KAAK,CAAC,KAC7C,OAAO,CAAC,cAAc,CAAC,CAAC;QAC7B,KAAK,EAAE,CAAC,UAAU,CAAC,EAAE,CAAC,MAAM,EAAE,GAAG,KAAK,WAAW,CAAC,KAAK,CAAC,KAAK,OAAO,CAAC,cAAc,CAAC,CAAC;KACpF,CAkIJ;IAED;;;;;;;OAOG;IACG,KAAK,CAAC,YAAY,GAAE,OAAe,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAKtE;;;;;;;;OAQG;IACG,MAAM,CAAC,KAAK,GAAE,OAAc,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAI/D;;;;;;;;;;;;OAYG;IACG,IAAI,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,CAAC;IA+CvD;;;OAGG;IACH,MAAM,IAAI,WAAW;IAyBrB;;;OAGG;IACH,QAAQ,IAAI,MAAM;IAqBlB;;;;;OAKG;IACG,gBAAgB,CAAC,IAAI,EAAE,WAAW,GAAG,OAAO,CAAC,mBAAmB,GAAG,SAAS,CAAC;IAInF;;;;;;;OAOG;IACG,MAAM,CAAC,EAAE,SAAS,EAAE,IAAI,EAAE,UAAU,EAAE,YAAY,EAAE,KAAY,EAAE,GAAG,MAAM,EAAE,EAAE,kBAAkB,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAsGrI;;;;OAIG;IACG,MAAM,CAAC,YAAY,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAsF5E;;OAEG;YACW,2BAA2B;IAiDzC;;;OAGG;YACW,aAAa;IAkE3B;;;;;;;;;;;;;;;OAeG;YACW,cAAc;IAyD5B;;;;;;;;;;;;;;OAcG;IACH,OAAO,CAAC,MAAM,CAAC,uBAAuB;IAQtC;;;;OAIG;IACH,OAAO,CAAC,yBAAyB;CAKlC"}

package/dist/types/{typed-dwn-api.d.ts → typed-web5.d.ts}

@@ -1,11 +1,30 @@
 /**
- * A type-safe wrapper around {@link DwnApi} scoped to a single protocol.
+ * A protocol-scoped API returned by {@link Web5.using}.
  *
- * `TypedDwnApi` is created via `dwn.using(typedProtocol)` and provides
- * autocompletion for protocol paths, typed data payloads, and tag shapes.
+ * `TypedWeb5` 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.
  *
- * Every method delegates to the corresponding `dwn.records.*` method,
- * injecting the protocol URI, protocolPath, and schema automatically.
+ * @example
+ * ```ts
+ * const social = web5.using(SocialProtocol);
+ *
+ * // Install the protocol
+ * await social.configure();
+ *
+ * // Write — path and data type are checked at compile time
+ * const { record } = await social.records.write('thread', {
+ *   data: { title: 'Hello World', body: '...' },
+ * });
+ *
+ * // Query — protocol and protocolPath are auto-injected
+ * const { records } = await social.records.query('thread');
+ *
+ * // Subscribe — real-time changes via LiveQuery
+ * const { liveQuery } = await social.records.subscribe('thread/reply');
+ * liveQuery.on('create', (record) => { ... });
+ * ```
  */
 import type { DwnApi } from './dwn-api.js';
 import type { LiveQuery } from './live-query.js';
@@ -18,7 +37,7 @@ import type { ProtocolPaths, SchemaMap, TypedProtocol, TypeNameAtPath } from './
  * Resolves the TypeScript data type for a given protocol path.
  *
  * If the schema map contains a mapping for the type name at the given path,
- * that type is returned.  Otherwise falls back to `unknown`.
+ * that type is returned. Otherwise falls back to `unknown`.
  */
 type DataForPath<_D extends ProtocolDefinition, M extends SchemaMap, Path extends string> = TypeNameAtPath<Path> extends keyof M ? M[TypeNameAtPath<Path>] : unknown;
 /**
@@ -31,34 +50,31 @@ type ProtocolTypeForPath<D extends ProtocolDefinition, Path extends string> = Ty
 type DataFormatForPath<D extends ProtocolDefinition, Path extends string> = ProtocolTypeForPath<D, Path> extends {
     dataFormats: infer F;
 } ? F extends readonly string[] ? F[number] : string : string;
-/** Options for `TypedDwnApi.write()`. */
+/** Options for {@link TypedWeb5} `records.write()`. */
 export type TypedWriteRequest<D extends ProtocolDefinition, M extends SchemaMap, Path extends string> = {
     /** The data payload. Type-checked against the schema map. */
     data: DataForPath<D, M, Path>;
-    /** Additional message parameters (protocolPath and protocol are injected). */
-    message?: {
-        parentContextId?: string;
-        published?: boolean;
-        datePublished?: string;
-        recipient?: string;
-        protocolRole?: string;
-        dataFormat?: DataFormatForPath<D, Path>;
-        tags?: globalThis.Record<string, string | number | boolean | string[] | number[]>;
-    };
+    parentContextId?: string;
+    published?: boolean;
+    datePublished?: string;
+    recipient?: string;
+    protocolRole?: string;
+    dataFormat?: DataFormatForPath<D, Path>;
+    tags?: globalThis.Record<string, string | number | boolean | string[] | number[]>;
     /** Whether to persist immediately (defaults to `true`). */
     store?: boolean;
     /** Whether to auto-encrypt (follows protocol definition if omitted). */
     encryption?: boolean;
 };
-/** Response from `TypedDwnApi.write()`. */
+/** Response from {@link TypedWeb5} `records.write()`. */
 export type TypedWriteResponse = DwnResponseStatus & {
-    record?: Record;
+    record: Record;
 };
-/** Filter options for `TypedDwnApi.query()`. */
+/** Filter options for {@link TypedWeb5} `records.query()`. */
 export type TypedQueryFilter = Omit<RecordsFilter, 'protocol' | 'protocolPath' | 'schema'> & {
     tags?: globalThis.Record<string, string | number | boolean | (string | number)[]>;
 };
-/** Options for `TypedDwnApi.query()`. */
+/** Options for {@link TypedWeb5} `records.query()`. */
 export type TypedQueryRequest = {
     /** Optional remote DWN DID to query from. */
     from?: string;
@@ -73,12 +89,12 @@ export type TypedQueryRequest = {
     /** When true, automatically decrypts encrypted records. */
     encryption?: boolean;
 };
-/** Response from `TypedDwnApi.query()`. */
+/** Response from {@link TypedWeb5} `records.query()`. */
 export type TypedQueryResponse = DwnResponseStatus & {
-    records?: Record[];
+    records: Record[];
     cursor?: DwnPaginationCursor;
 };
-/** Options for `TypedDwnApi.read()`. */
+/** Options for {@link TypedWeb5} `records.read()`. */
 export type TypedReadRequest = {
     /** Optional remote DWN DID to read from. */
     from?: string;
@@ -87,18 +103,18 @@ export type TypedReadRequest = {
     /** When true, automatically decrypts the record. */
     encryption?: boolean;
 };
-/** Response from `TypedDwnApi.read()`. */
+/** Response from {@link TypedWeb5} `records.read()`. */
 export type TypedReadResponse = DwnResponseStatus & {
     record: Record;
 };
-/** Options for `TypedDwnApi.delete()`. */
+/** Options for {@link TypedWeb5} `records.delete()`. */
 export type TypedDeleteRequest = {
     /** Optional remote DWN DID to delete from. */
     from?: string;
     /** The `recordId` of the record to delete. */
     recordId: string;
 };
-/** Options for `TypedDwnApi.subscribe()`. */
+/** Options for {@link TypedWeb5} `records.subscribe()`. */
 export type TypedSubscribeRequest = {
     /** Optional remote DWN DID to subscribe to. */
     from?: string;
@@ -106,33 +122,33 @@ export type TypedSubscribeRequest = {
     filter?: TypedQueryFilter;
     protocolRole?: string;
 };
-/** Response from `TypedDwnApi.subscribe()`. */
+/** Response from {@link TypedWeb5} `records.subscribe()`. */
 export type TypedSubscribeResponse = DwnResponseStatus & {
     /** The live query instance, or `undefined` if the request failed. */
     liveQuery?: LiveQuery;
 };
 /**
- * A protocol-scoped wrapper around `DwnApi` that automatically injects
- * the `protocol` URI, `protocolPath`, and `schema` into every DWN operation.
+ * A protocol-scoped API that auto-injects `protocol`, `protocolPath`, and
+ * `schema` into every DWN operation.
  *
- * Obtain an instance via `dwn.using(typedProtocol)`.
+ * Obtain an instance via `web5.using(typedProtocol)`.
  *
  * @example
  * ```ts
- * const social = dwn.using(SocialGraphProtocol);
+ * const social = web5.using(SocialProtocol);
  *
- * // Write — path and data type are checked at compile time
- * const { record } = await social.write('friend', {
+ * await social.configure();
+ *
+ * const { record } = await social.records.write('friend', {
  *   data: { did: 'did:example:alice', alias: 'Alice' },
  * });
  *
- * // Query — protocol and protocolPath are auto-injected
- * const { records } = await social.query('friend', {
+ * const { records } = await social.records.query('friend', {
  *   filter: { tags: { did: 'did:example:alice' } },
  * });
  * ```
  */
-export declare class TypedDwnApi<D extends ProtocolDefinition = ProtocolDefinition, M extends SchemaMap = SchemaMap> {
+export declare class TypedWeb5<D extends ProtocolDefinition = ProtocolDefinition, M extends SchemaMap = SchemaMap> {
     private _dwn;
     private _definition;
     constructor(dwn: DwnApi, protocol: TypedProtocol<D, M>);
@@ -143,6 +159,11 @@ export declare class TypedDwnApi<D extends ProtocolDefinition = ProtocolDefiniti
     /**
      * Configures (installs) this protocol on the local DWN.
      *
+     * If the protocol is already installed with an identical definition,
+     * this is a no-op and returns the existing protocol. If the definition
+     * has changed (e.g. new types, modified structure), the protocol is
+     * re-configured with the updated definition.
+     *
      * @param options - Optional overrides like `encryption`.
      */
     configure(options?: {
@@ -151,43 +172,19 @@ export declare class TypedDwnApi<D extends ProtocolDefinition = ProtocolDefiniti
         protocol?: Protocol;
     }>;
     /**
-     * Write a record at the given protocol path.
-     *
-     * @param path - The protocol path (e.g. `'friend'`, `'group/member'`).
-     * @param request - Write options including typed `data`.
-     */
-    write<Path extends ProtocolPaths<D> & string>(path: Path, request: TypedWriteRequest<D, M, Path>): Promise<TypedWriteResponse>;
-    /**
-     * Query records at the given protocol path.
+     * Protocol-scoped record operations.
      *
-     * @param path - The protocol path to query.
-     * @param request - Query options including optional filter, sort, and pagination.
+     * Every method auto-injects the protocol URI, protocolPath, and schema
+     * from the protocol definition. Path parameters provide compile-time
+     * autocompletion via `ProtocolPaths<D>`.
      */
-    query<Path extends ProtocolPaths<D> & string>(path: Path, request?: TypedQueryRequest): Promise<TypedQueryResponse>;
-    /**
-     * Read a single record at the given protocol path.
-     *
-     * @param path - The protocol path to read from.
-     * @param request - Read options including a filter to identify the record.
-     */
-    read<Path extends ProtocolPaths<D> & string>(path: Path, request: TypedReadRequest): Promise<TypedReadResponse>;
-    /**
-     * Delete a record at the given protocol path.
-     *
-     * @param path - The protocol path (used for permission scoping).
-     * @param request - Delete options including the `recordId`.
-     */
-    delete<Path extends ProtocolPaths<D> & string>(_path: Path, request: TypedDeleteRequest): Promise<DwnResponseStatus>;
-    /**
-     * Subscribe to records at the given protocol path.
-     *
-     * Returns a {@link LiveQuery} that atomically provides an initial snapshot
-     * and a real-time stream of deduplicated change events.
-     *
-     * @param path - The protocol path to subscribe to.
-     * @param request - Subscribe options including optional filter and role.
-     */
-    subscribe<Path extends ProtocolPaths<D> & string>(path: Path, request?: TypedSubscribeRequest): Promise<TypedSubscribeResponse>;
+    get records(): {
+        write: <Path extends ProtocolPaths<D> & string>(path: Path, request: TypedWriteRequest<D, M, Path>) => Promise<TypedWriteResponse>;
+        query: <Path extends ProtocolPaths<D> & string>(path: Path, request?: TypedQueryRequest) => Promise<TypedQueryResponse>;
+        read: <Path extends ProtocolPaths<D> & string>(path: Path, request: TypedReadRequest) => Promise<TypedReadResponse>;
+        delete: <Path extends ProtocolPaths<D> & string>(path: Path, request: TypedDeleteRequest) => Promise<DwnResponseStatus>;
+        subscribe: <Path extends ProtocolPaths<D> & string>(path: Path, request?: TypedSubscribeRequest) => Promise<TypedSubscribeResponse>;
+    };
 }
 export {};
-//# sourceMappingURL=typed-dwn-api.d.ts.map
+//# sourceMappingURL=typed-web5.d.ts.map

package/dist/types/typed-web5.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"typed-web5.d.ts","sourceRoot":"","sources":["../../src/typed-web5.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AAEH,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AAC3C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AACjD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAC9C,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAE1C,OAAO,KAAK,EAAE,QAAQ,EAAE,kBAAkB,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AACnG,OAAO,KAAK,EAAE,mBAAmB,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AAC3E,OAAO,KAAK,EAAE,aAAa,EAAE,SAAS,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAMnG;;;;;GAKG;AACH,KAAK,WAAW,CACd,EAAE,SAAS,kBAAkB,EAC7B,CAAC,SAAS,SAAS,EACnB,IAAI,SAAS,MAAM,IACjB,cAAc,CAAC,IAAI,CAAC,SAAS,MAAM,CAAC,GAAG,CAAC,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC,GAAG,OAAO,CAAC;AAE7E;;GAEG;AACH,KAAK,mBAAmB,CACtB,CAAC,SAAS,kBAAkB,EAC5B,IAAI,SAAS,MAAM,IACjB,cAAc,CAAC,IAAI,CAAC,SAAS,MAAM,CAAC,CAAC,OAAO,CAAC,GAC7C,CAAC,CAAC,OAAO,CAAC,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC,SAAS,YAAY,GACnD,CAAC,CAAC,OAAO,CAAC,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC,GAChC,SAAS,GACX,SAAS,CAAC;AAEd;;GAEG;AACH,KAAK,iBAAiB,CACpB,CAAC,SAAS,kBAAkB,EAC5B,IAAI,SAAS,MAAM,IACjB,mBAAmB,CAAC,CAAC,EAAE,IAAI,CAAC,SAAS;IAAE,WAAW,EAAE,MAAM,CAAC,CAAA;CAAE,GAC7D,CAAC,SAAS,SAAS,MAAM,EAAE,GACzB,CAAC,CAAC,MAAM,CAAC,GACT,MAAM,GACR,MAAM,CAAC;AAMX,uDAAuD;AACvD,MAAM,MAAM,iBAAiB,CAC3B,CAAC,SAAS,kBAAkB,EAC5B,CAAC,SAAS,SAAS,EACnB,IAAI,SAAS,MAAM,IACjB;IACF,6DAA6D;IAC7D,IAAI,EAAE,WAAW,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC;IAE9B,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,UAAU,CAAC,EAAE,iBAAiB,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;IACxC,IAAI,CAAC,EAAE,UAAU,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC,CAAC;IAElF,2DAA2D;IAC3D,KAAK,CAAC,EAAE,OAAO,CAAC;IAEhB,wEAAwE;IACxE,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB,CAAC;AAEF,yDAAyD;AACzD,MAAM,MAAM,kBAAkB,GAAG,iBAAiB,GAAG;IACnD,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,8DAA8D;AAC9D,MAAM,MAAM,gBAAgB,GAAG,IAAI,CAAC,aAAa,EAAE,UAAU,GAAG,cAAc,GAAG,QAAQ,CAAC,GAAG;IAC3F,IAAI,CAAC,EAAE,UAAU,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,CAAC,CAAC;CACnF,CAAC;AAEF,uDAAuD;AACvD,MAAM,MAAM,iBAAiB,GAAG;IAC9B,6CAA6C;IAC7C,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,kEAAkE;IAClE,MAAM,CAAC,EAAE,gBAAgB,CAAC;IAC1B,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,UAAU,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,mBAAmB,CAAA;KAAE,CAAC;IAC9D,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,2DAA2D;IAC3D,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB,CAAC;AAEF,yDAAyD;AACzD,MAAM,MAAM,kBAAkB,GAAG,iBAAiB,GAAG;IACnD,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,MAAM,CAAC,EAAE,mBAAmB,CAAC;CAC9B,CAAC;AAEF,sDAAsD;AACtD,MAAM,MAAM,gBAAgB,GAAG;IAC7B,4CAA4C;IAC5C,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,8EAA8E;IAC9E,MAAM,EAAE,IAAI,CAAC,aAAa,EAAE,UAAU,GAAG,cAAc,GAAG,QAAQ,CAAC,CAAC;IAEpE,oDAAoD;IACpD,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB,CAAC;AAEF,wDAAwD;AACxD,MAAM,MAAM,iBAAiB,GAAG,iBAAiB,GAAG;IAClD,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,wDAAwD;AACxD,MAAM,MAAM,kBAAkB,GAAG;IAC/B,8CAA8C;IAC9C,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,8CAA8C;IAC9C,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,2DAA2D;AAC3D,MAAM,MAAM,qBAAqB,GAAG;IAClC,+CAA+C;IAC/C,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,yEAAyE;IACzE,MAAM,CAAC,EAAE,gBAAgB,CAAC;IAC1B,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB,CAAC;AAEF,6DAA6D;AAC7D,MAAM,MAAM,sBAAsB,GAAG,iBAAiB,GAAG;IACvD,qEAAqE;IACrE,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAMF;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,qBAAa,SAAS,CACpB,CAAC,SAAS,kBAAkB,GAAG,kBAAkB,EACjD,CAAC,SAAS,SAAS,GAAG,SAAS;IAE/B,OAAO,CAAC,IAAI,CAAS;IACrB,OAAO,CAAC,WAAW,CAAI;gBAEX,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,aAAa,CAAC,CAAC,EAAE,CAAC,CAAC;IAKtD,wBAAwB;IACxB,IAAW,QAAQ,IAAI,MAAM,CAE5B;IAED,mCAAmC;IACnC,IAAW,UAAU,IAAI,CAAC,CAEzB;IAED;;;;;;;;;OASG;IACU,SAAS,CAAC,OAAO,CAAC,EAAE;QAAE,UAAU,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,OAAO,CAAC,iBAAiB,GAAG;QAAE,QAAQ,CAAC,EAAE,QAAQ,CAAA;KAAE,CAAC;IAqBhH;;;;;;OAMG;IACH,IAAW,OAAO,IAAI;QACpB,KAAK,EAAE,CAAC,IAAI,SAAS,aAAa,CAAC,CAAC,CAAC,GAAG,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,iBAAiB,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,KAAK,OAAO,CAAC,kBAAkB,CAAC,CAAC;QACnI,KAAK,EAAE,CAAC,IAAI,SAAS,aAAa,CAAC,CAAC,CAAC,GAAG,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,EAAE,iBAAiB,KAAK,OAAO,CAAC,kBAAkB,CAAC,CAAC;QACxH,IAAI,EAAE,CAAC,IAAI,SAAS,aAAa,CAAC,CAAC,CAAC,GAAG,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,gBAAgB,KAAK,OAAO,CAAC,iBAAiB,CAAC,CAAC;QACpH,MAAM,EAAE,CAAC,IAAI,SAAS,aAAa,CAAC,CAAC,CAAC,GAAG,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,kBAAkB,KAAK,OAAO,CAAC,iBAAiB,CAAC,CAAC;QACxH,SAAS,EAAE,CAAC,IAAI,SAAS,aAAa,CAAC,CAAC,CAAC,GAAG,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,EAAE,qBAAqB,KAAK,OAAO,CAAC,sBAAsB,CAAC,CAAC;KACnI,CAmIF;CACF"}

package/dist/types/web5.d.ts

@@ -2,9 +2,13 @@
  * NOTE: Added reference types here to avoid a `pnpm` bug during build.
  * https://github.com/enboxorg/enbox/pull/507
  */
+import type { DidMethodResolver } from '@enbox/dids';
+import type { ProtocolDefinition } from '@enbox/dwn-sdk-js';
 import type { DwnDataEncodedRecordsWriteMessage, DwnProtocolDefinition, HdIdentityVault, Permission, WalletConnectOptions, Web5Agent } from '@enbox/agent';
+import type { SchemaMap, TypedProtocol } from './protocol-types.js';
 import { DidApi } from './did-api.js';
-import { DwnApi } from './dwn-api.js';
+import { DwnReaderApi } from './dwn-reader-api.js';
+import { TypedWeb5 } from './typed-web5.js';
 import { VcApi } from './vc-api.js';
 /** Override defaults configured during the technical preview phase. */
 export type TechPreviewOptions = {
@@ -43,6 +47,26 @@ export type ConnectOptions = Omit<WalletConnectOptions, 'permissionRequests'> &
      */
     permissionRequests: ConnectPermissionRequest[];
 };
+/**
+ * Options for creating an anonymous (read-only) Web5 instance via {@link Web5.anonymous}.
+ *
+ * @beta
+ */
+export type Web5AnonymousOptions = {
+    /** Override the default DID method resolvers. Defaults to `[DidDht, DidJwk, DidKey, DidWeb]`. */
+    didResolvers?: DidMethodResolver[];
+};
+/**
+ * The result of calling {@link Web5.anonymous}.
+ *
+ * Contains only a read-only `dwn` property — no `did`, `vc`, or `agent`.
+ *
+ * @beta
+ */
+export type Web5AnonymousApi = {
+    /** A read-only DWN API for querying public data on remote DWNs. */
+    dwn: DwnReaderApi;
+};
 /** Optional overrides that can be provided when calling {@link Web5.connect}. */
 export type Web5ConnectOptions = {
     /**
@@ -184,11 +208,63 @@ export declare class Web5 {
     agent: Web5Agent;
     /** Exposed instance to the DID APIs, allow users to create and resolve DIDs  */
     did: DidApi;
-    /** Exposed instance to the DWN APIs, allow users to read/write records */
-    dwn: DwnApi;
+    /** Internal DWN API instance. Use {@link Web5.using} for protocol-scoped access. */
+    private _dwn;
     /** Exposed instance to the VC APIs, allow users to issue, present and verify VCs */
     vc: VcApi;
     constructor({ agent, connectedDid, delegateDid }: Web5Params);
+    /**
+     * 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<D extends ProtocolDefinition, M extends SchemaMap>(protocol: TypedProtocol<D, M>): TypedWeb5<D, M>;
+    /**
+     * 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?: Web5AnonymousOptions): Web5AnonymousApi;
     /**
      * Connects to a {@link Web5Agent}. Defaults to creating a local {@link Web5UserAgent} if one
      * isn't provided.