@enbox/api 0.3.2 → 0.4.1

package/dist/esm/typed-record.js

@@ -11,14 +11,29 @@
  * - `.data.json()` returns `Promise<T>` instead of `Promise<unknown>`.
  * - `.update({ data })` accepts `Partial<T>` for the data payload.
  *
+ * You never construct `TypedRecord` directly — instances are returned by
+ * {@link TypedEnbox} methods such as `records.create()`, `records.query()`,
+ * `records.read()`, and `records.subscribe()`.
+ *
+ * @typeParam T - The TypeScript type of the record's data payload, resolved
+ *   from the protocol's schema map at the given protocol path.
+ *
  * @example
  * ```ts
- * const { record } = await typed.records.write('friend', {
+ * const { record } = await proto.records.create('friend', {
  *   data: { did: 'did:example:alice', alias: 'Alice' },
  * });
  *
  * // record is TypedRecord<FriendData>
  * const data = await record.data.json(); // FriendData — no manual cast
+ *
+ * // Update preserves the type
+ * const { record: updated } = await record.update({
+ *   data: { alias: 'Ali' },   // Partial<FriendData>
+ * });
+ *
+ * // Send to the remote DWN
+ * await updated.send();
  * ```
  */
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
@@ -36,17 +51,56 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 /**
  * A type-safe wrapper around {@link Record} that preserves the data type `T`.
  *
- * Obtain instances through `TypedWeb5.records.write()`, `.query()`, `.read()`,
- * or `.subscribe()` — never construct directly.
+ * Obtain instances through {@link TypedEnbox} methods — `records.create()`,
+ * `records.query()`, `records.read()`, or `records.subscribe()` — never
+ * construct directly.
+ *
+ * @typeParam T - The TypeScript type of the record's data payload. This type
+ *   is inferred automatically from the protocol's schema map and the protocol
+ *   path used when creating or querying the record.
+ *
+ * @example
+ * ```ts
+ * // TypedRecord instances are returned by TypedEnbox methods:
+ * const { record } = await proto.records.create('notebook', {
+ *   data: { name: 'My Notebook' },
+ * });
+ *
+ * // Access metadata
+ * console.log(record.id);          // unique record ID
+ * console.log(record.contextId);   // context ID for hierarchical grouping
+ * console.log(record.dateCreated); // ISO 8601 creation timestamp
+ * console.log(record.timestamp);   // ISO 8601 last-update timestamp
+ * console.log(record.tags);        // key-value metadata tags
+ *
+ * // Type-safe data access
+ * const data = await record.data.json(); // NotebookData
+ *
+ * // Lifecycle
+ * await record.send();                   // push to remote DWN
+ * await record.update({ data: { name: 'Renamed' } });
+ * await record.delete();
+ * ```
  */
 export class TypedRecord {
+    /**
+     * @internal Wrap an untyped {@link Record} in a type-safe shell.
+     * @param record - The underlying `Record` instance to wrap.
+     */
     constructor(record) {
         this._record = record;
     }
     // -------------------------------------------------------------------------
     // Escape hatch
     // -------------------------------------------------------------------------
-    /** Access the underlying untyped {@link Record} for advanced use cases. */
+    /**
+     * Access the underlying untyped {@link Record} for advanced use cases.
+     *
+     * Use this escape hatch when you need to call `Record` methods or access
+     * properties that are not surfaced by the typed wrapper.
+     *
+     * @returns The wrapped {@link Record} instance.
+     */
     get rawRecord() {
         return this._record;
     }
@@ -54,11 +108,32 @@ export class TypedRecord {
     // Typed data accessor
     // -------------------------------------------------------------------------
     /**
-     * Returns the data of the current record with type-safe accessors.
+     * Returns the record's data with type-safe accessors.
+     *
+     * The returned object provides multiple ways to consume the data:
      *
-     * The `json()` method returns `Promise<T>` — no manual generic needed.
+     * | Method     | Return type              | Description                          |
+     * |------------|--------------------------|--------------------------------------|
+     * | `json()`   | `Promise<T>`             | Parse as JSON with full type safety   |
+     * | `text()`   | `Promise<string>`        | Raw UTF-8 text                        |
+     * | `blob()`   | `Promise<Blob>`          | Binary blob (respects `dataFormat`)   |
+     * | `bytes()`  | `Promise<Uint8Array>`    | Raw bytes                             |
+     * | `stream()` | `Promise<ReadableStream>`| Web `ReadableStream` for streaming    |
      *
+     * The object is also directly awaitable (returns the stream).
+     *
+     * @returns A {@link TypedRecordData} accessor whose `json()` returns `Promise<T>`.
      * @throws `Error` if the record has been deleted.
+     *
+     * @example
+     * ```ts
+     * const { record } = await proto.records.read('notebook', {
+     *   filter: { recordId },
+     * });
+     *
+     * const notebook = await record.data.json(); // NotebookData
+     * const raw      = await record.data.text(); // string
+     * ```
      */
     get data() {
         const underlying = this._record.data;
@@ -76,23 +151,63 @@ export class TypedRecord {
     // Typed mutation methods
     // -------------------------------------------------------------------------
     /**
-     * Update the current record on the DWN.
+     * Update the current record's data and/or metadata on the DWN.
+     *
+     * The `data` field accepts `Partial<T>`, so you only need to provide
+     * the fields you want to change. A new {@link TypedRecord} is returned
+     * **and** the original instance is mutated in-place, so both the returned
+     * record and the original reference reflect the updated state.
      *
-     * @param params - Parameters including the typed `data` payload.
-     * @returns The status and an updated {@link TypedRecord}.
+     * @param params - Update parameters. `data` is type-checked as `Partial<T>`.
+     *   Other fields like `tags`, `published`, and `datePublished` can also be
+     *   updated.
+     * @returns A {@link TypedRecordUpdateResult} containing the DWN response
+     *   `status` and the updated {@link TypedRecord}.
      * @throws `Error` if the record has been deleted.
+     *
+     * @example
+     * ```ts
+     * const { status, record: updated } = await record.update({
+     *   data: { title: 'New Title' },  // Partial<PageData>
+     *   tags: { priority: 'high' },
+     * });
+     *
+     * if (status.code === 202) {
+     *   await updated.send(); // push update to remote
+     * }
+     * ```
      */
     update(params) {
         return __awaiter(this, void 0, void 0, function* () {
             const { status, record } = yield this._record.update(params);
+            // The underlying Record.update() now also mutates `this._record` in-place,
+            // so the original TypedRecord reference already reflects the new data.
+            // We still return a new TypedRecord wrapping the returned record for callers
+            // that use the destructured result.
             return { status, record: new TypedRecord(record) };
         });
     }
     /**
-     * Delete the current record on the DWN.
+     * Delete the current record from the DWN.
      *
-     * @param params - Delete parameters.
-     * @returns The status and a {@link TypedRecord} reflecting the deleted state.
+     * After deletion, **both** the returned record and the original instance's
+     * {@link TypedRecord.deleted | deleted} property will be `true`, and
+     * calling data accessors on either will throw.
+     *
+     * @param params - Optional delete parameters:
+     *   - `store` — whether to persist the delete message (defaults to `true`).
+     *   - `prune` — whether to also delete child records.
+     *   - `signAsOwner` — sign the delete as the DWN owner (for imports).
+     * @returns A {@link TypedRecordDeleteResult} containing the DWN response
+     *   `status` and the record in its deleted state.
+     *
+     * @example
+     * ```ts
+     * const { status } = await record.delete({ prune: true });
+     * if (status.code === 202) {
+     *   console.log('Record and children deleted');
+     * }
+     * ```
      */
     delete(params) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -104,9 +219,15 @@ export class TypedRecord {
     // Forwarded lifecycle methods
     // -------------------------------------------------------------------------
     /**
-     * Stores the current record state to the owner's DWN.
+     * Stores the current record state to the local DWN.
+     *
+     * Call this after creating a record with `store: false` or after
+     * receiving a record from a remote DWN that you want to persist locally.
      *
-     * @param importRecord - If true, sign as owner before storing. Defaults to false.
+     * @param importRecord - If `true`, sign the record as the DWN owner
+     *   before storing (useful for importing records authored by others).
+     *   Defaults to `false`.
+     * @returns The DWN response status.
      */
     store() {
         return __awaiter(this, arguments, void 0, function* (importRecord = false) {
@@ -114,10 +235,14 @@ export class TypedRecord {
         });
     }
     /**
-     * Signs and optionally stores the record to the owner's DWN.
-     * Useful when importing a record signed by someone else.
+     * Signs the record as the DWN owner and optionally stores it.
      *
-     * @param store - If true, store after signing. Defaults to true.
+     * Use this when importing a record authored/signed by another DID into
+     * your own DWN. The record will be re-signed under your identity.
+     *
+     * @param store - If `true`, persist the record after signing.
+     *   Defaults to `true`.
+     * @returns The DWN response status.
      */
     import() {
         return __awaiter(this, arguments, void 0, function* (store = true) {
@@ -125,9 +250,28 @@ export class TypedRecord {
         });
     }
     /**
-     * Send the current record to a remote DWN.
+     * Push the current record to a remote DWN.
+     *
+     * This sends the record (including its data) to the specified remote
+     * DWN. Use this after `create`, `update`, or `delete` to sync changes
+     * with the remote node.
+     *
+     * @param target - The DID of the remote DWN to send to. If omitted,
+     *   defaults to the DID of the currently connected identity.
+     * @returns The DWN response status from the remote node.
+     *
+     * @example
+     * ```ts
+     * const { record } = await proto.records.create('notebook', {
+     *   data: { name: 'Travel Notes' },
+     * });
      *
-     * @param target - Optional DID of the target DWN. Defaults to the connected DID.
+     * // Push to your own remote DWN
+     * await record.send();
+     *
+     * // Or push to another user's DWN
+     * await record.send('did:example:bob');
+     * ```
      */
     send(target) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -135,19 +279,36 @@ export class TypedRecord {
         });
     }
     /**
-     * Returns a JSON representation of the Record instance.
+     * Returns a JSON-serializable representation of the record's metadata.
+     *
+     * Useful for logging, debugging, or serializing the record's state.
+     * Does **not** include the record's data payload — use {@link TypedRecord.data | data}
+     * accessors for that.
+     *
+     * @returns A {@link RecordModel} containing the record's metadata fields.
      */
     toJSON() {
         return this._record.toJSON();
     }
     /**
-     * Returns a string representation of the Record instance.
+     * Returns a human-readable string representation of the record.
+     *
+     * @returns A string summary of the record (delegates to the underlying Record).
      */
     toString() {
         return this._record.toString();
     }
     /**
-     * Returns a pagination cursor for the current record given a sort order.
+     * Returns a pagination cursor anchored at this record for the given sort
+     * order.
+     *
+     * Pass the returned cursor to a subsequent `query()` call's
+     * `pagination.cursor` to resume pagination from this record.
+     *
+     * @param sort - The date-sort order to use for cursor positioning
+     *   (e.g. `DateSort.CreatedAscending`).
+     * @returns A pagination cursor, or `undefined` if the record cannot
+     *   produce one.
      */
     paginationCursor(sort) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -157,69 +318,232 @@ export class TypedRecord {
     // -------------------------------------------------------------------------
     // Forwarded immutable property getters
     // -------------------------------------------------------------------------
-    /** Record's ID. */
+    /**
+     * The record's unique identifier.
+     *
+     * This is a stable, globally unique ID assigned when the record is first
+     * created. It does not change across updates or deletes.
+     */
     get id() { return this._record.id; }
-    /** Record's context ID. */
+    /**
+     * The context ID used to group hierarchical records.
+     *
+     * When a record is created as a child (using `parentContextId`), the DWN
+     * assigns a `contextId` that links all records in the same hierarchy.
+     * Use this value as the `parentContextId` when creating child records,
+     * or as a `parentId` filter when querying for children.
+     *
+     * @returns The context ID string, or `undefined` if the record is not
+     *   part of a hierarchical context.
+     *
+     * @example
+     * ```ts
+     * const { record: notebook } = await proto.records.create('notebook', {
+     *   data: { name: 'My Notebook' },
+     * });
+     *
+     * // Create a child page under the notebook's context
+     * const { record: page } = await proto.records.create('notebook/page', {
+     *   data: { title: 'Page 1' },
+     *   parentContextId: notebook.contextId,
+     * });
+     * ```
+     */
     get contextId() { return this._record.contextId; }
-    /** Record's creation date. */
+    /**
+     * ISO 8601 timestamp of when the record was first created.
+     *
+     * This value is immutable and never changes, even when the record is
+     * updated or deleted. For the timestamp of the most recent mutation,
+     * use {@link TypedRecord.timestamp | timestamp}.
+     */
     get dateCreated() { return this._record.dateCreated; }
-    /** Record's parent ID. */
+    /**
+     * The parent record's ID, if this record was created as a child.
+     *
+     * @returns The parent's record ID, or `undefined` for top-level records.
+     */
     get parentId() { return this._record.parentId; }
-    /** Record's protocol. */
+    /**
+     * The protocol URI this record belongs to.
+     *
+     * @returns The protocol URI string (e.g. `'https://example.com/social'`),
+     *   or `undefined` if the record is not protocol-scoped.
+     */
     get protocol() { return this._record.protocol; }
-    /** Record's protocol path. */
+    /**
+     * The protocol path of this record within the protocol's structure.
+     *
+     * For example, `'notebook'` or `'notebook/page'`. This identifies which
+     * type definition in the protocol structure governs this record.
+     */
     get protocolPath() { return this._record.protocolPath; }
-    /** Record's recipient. */
+    /**
+     * The DID of the intended recipient of this record.
+     *
+     * @returns The recipient's DID string, or `undefined` if no specific
+     *   recipient was set.
+     */
     get recipient() { return this._record.recipient; }
-    /** Record's schema. */
+    /**
+     * The schema URI associated with this record's type in the protocol
+     * definition.
+     *
+     * @returns The schema URI string, or `undefined` if the type has no schema.
+     */
     get schema() { return this._record.schema; }
     // -------------------------------------------------------------------------
     // Forwarded mutable property getters
     // -------------------------------------------------------------------------
-    /** Record's data format. */
+    /**
+     * The MIME type / data format of the record's payload.
+     *
+     * Typically `'application/json'` for structured data, but can be any
+     * MIME type supported by the protocol definition's `dataFormats` array.
+     */
     get dataFormat() { return this._record.dataFormat; }
-    /** Record's data CID. */
+    /**
+     * The Content Identifier (CID) of the record's data.
+     *
+     * This is a content-addressable hash of the data payload, useful for
+     * verifying data integrity.
+     */
     get dataCid() { return this._record.dataCid; }
-    /** Record's data size. */
+    /**
+     * The size of the record's data payload in bytes.
+     */
     get dataSize() { return this._record.dataSize; }
-    /** Record's published date. */
+    /**
+     * ISO 8601 timestamp of when the record was published.
+     *
+     * Only present if the record has been explicitly published
+     * (i.e. `published: true` was set during create or update).
+     */
     get datePublished() { return this._record.datePublished; }
-    /** Record's published status. */
+    /**
+     * Whether the record is publicly published.
+     *
+     * Published records can be read by anyone without authorization.
+     * `undefined` if the published state was never explicitly set.
+     */
     get published() { return this._record.published; }
-    /** Tags of the record. */
+    /**
+     * Key-value metadata tags attached to the record.
+     *
+     * Tags are indexed by the DWN and can be used in query filters for
+     * efficient lookups. Values can be strings, numbers, booleans, or
+     * arrays of strings/numbers.
+     *
+     * @returns The tags object, or `undefined` if no tags are set.
+     *
+     * @example
+     * ```ts
+     * // Query records by tag
+     * const { records } = await proto.records.query('notebook', {
+     *   filter: { tags: { category: 'work' } },
+     * });
+     *
+     * // Read tags from a record
+     * const tags = record.tags; // { category: 'work', priority: 1 }
+     * ```
+     */
     get tags() {
         return this._record.tags;
     }
     // -------------------------------------------------------------------------
     // Forwarded state-dependent property getters
     // -------------------------------------------------------------------------
-    /** DID that is the logical author of the Record. */
+    /**
+     * The DID of the logical author of this record.
+     *
+     * For records you create, this is your own DID. For records written by
+     * others (e.g. received via a protocol role), this is the signer's DID.
+     */
     get author() { return this._record.author; }
-    /** DID that is the original creator of the Record. */
+    /**
+     * The DID of the original creator of this record.
+     *
+     * Unlike {@link TypedRecord.author | author}, which reflects the current
+     * message signer (and may change on updates), `creator` always refers
+     * to the DID that authored the initial write.
+     */
     get creator() { return this._record.creator; }
-    /** Record's message timestamp. */
+    /**
+     * ISO 8601 timestamp of the record's most recent message (create, update,
+     * or delete).
+     *
+     * This value changes with every mutation. For the original creation time,
+     * use {@link TypedRecord.dateCreated | dateCreated}.
+     *
+     * **Note:** There is no `.dateModified` property — use `timestamp` to
+     * determine when the record was last changed.
+     */
     get timestamp() { return this._record.timestamp; }
-    /** Record's encryption details. */
+    /**
+     * Encryption metadata for the record, if it was encrypted.
+     *
+     * Contains the algorithm, key encryption details, and initialization
+     * vectors used to encrypt the record's data. `undefined` for
+     * unencrypted records.
+     */
     get encryption() {
         return this._record.encryption;
     }
-    /** Record's authorization. */
+    /**
+     * The authorization signature(s) for the current record message.
+     *
+     * Contains the JWS (JSON Web Signature) proving the message was
+     * authorized by the author.
+     */
     get authorization() {
         return this._record.authorization;
     }
-    /** Record's attestation. */
+    /**
+     * Optional attestation signature(s) for the record.
+     *
+     * Attestations are additional signatures (beyond the author's
+     * authorization) that vouch for the record's content.
+     *
+     * @returns The attestation JWS, or `undefined` if none is present.
+     */
     get attestation() {
         return this._record.attestation;
     }
-    /** Role under which the author is writing the record. */
+    /**
+     * The protocol role under which this record was written.
+     *
+     * When a record is created with a `protocolRole`, the DWN checks that
+     * the author is authorized to write under that role per the protocol's
+     * `$actions` rules.
+     *
+     * @returns The role string (e.g. `'admin'`, `'member'`), or `undefined`
+     *   if no role was specified.
+     */
     get protocolRole() { return this._record.protocolRole; }
-    /** Record's deleted state. */
+    /**
+     * Whether the record has been deleted.
+     *
+     * Once `true`, data accessors (`data.json()`, etc.) will throw. The
+     * record's metadata (ID, timestamps, etc.) remains accessible.
+     */
     get deleted() { return this._record.deleted; }
-    /** Record's initial write if the record has been updated. */
+    /**
+     * The initial `RecordsWrite` message for this record, if it has been
+     * updated at least once.
+     *
+     * The DWN preserves the initial write message to allow other nodes to
+     * verify the full history chain. For records that have never been
+     * updated, this is `undefined`.
+     */
     get initialWrite() {
         return this._record.initialWrite;
     }
-    /** The raw DWN message backing this record. */
+    /**
+     * The raw DWN message backing this record's current state.
+     *
+     * This is the full, unprocessed DWN message — either a `RecordsWrite`
+     * or `RecordsDelete` message depending on the record's state.
+     */
     get rawMessage() {
         return this._record.rawMessage;
     }

package/dist/esm/typed-record.js.map

@@ -1 +1 @@
-{"version":3,"file":"typed-record.js","sourceRoot":"","sources":["../../src/typed-record.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;;;;;;;;;;AA4DH,8EAA8E;AAC9E,oBAAoB;AACpB,8EAA8E;AAE9E;;;;;GAKG;AACH,MAAM,OAAO,WAAW;IAItB,YAAY,MAAc;QACxB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;IACxB,CAAC;IAED,4EAA4E;IAC5E,eAAe;IACf,4EAA4E;IAE5E,2EAA2E;IAC3E,IAAW,SAAS;QAClB,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED,4EAA4E;IAC5E,sBAAsB;IACtB,4EAA4E;IAE5E;;;;;;OAMG;IACH,IAAW,IAAI;QACb,MAAM,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC;QACrC,OAAO;YACL,IAAI,EAAK,GAAkB,EAAE,CAAC,UAAU,CAAC,IAAI,EAAE;YAC/C,KAAK,EAAI,GAAwB,EAAE,CAAC,UAAU,CAAC,KAAK,EAAE;YACtD,IAAI,EAAK,GAAe,EAAE,CAAC,UAAU,CAAC,IAAI,EAAK;YAC/C,IAAI,EAAK,GAAoB,EAAE,CAAC,UAAU,CAAC,IAAI,EAAE;YACjD,MAAM,EAAG,GAA4B,EAAE,CAAC,UAAU,CAAC,MAAM,EAAE;YAC3D,IAAI,EAAK,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC;YACzC,KAAK,EAAI,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC;SAC3C,CAAC;IACJ,CAAC;IAED,4EAA4E;IAC5E,yBAAyB;IACzB,4EAA4E;IAE5E;;;;;;OAMG;IACU,MAAM,CAAC,MAAkC;;YACpD,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,MAA4B,CAAC,CAAC;YACnF,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,WAAW,CAAI,MAAM,CAAC,EAAE,CAAC;QACxD,CAAC;KAAA;IAED;;;;;OAKG;IACU,MAAM,CAAC,MAA2B;;YAC7C,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;YAC7D,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,WAAW,CAAI,MAAM,CAAC,EAAE,CAAC;QACxD,CAAC;KAAA;IAED,4EAA4E;IAC5E,8BAA8B;IAC9B,4EAA4E;IAE5E;;;;OAIG;IACU,KAAK;6DAAC,eAAwB,KAAK;YAC9C,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;QAC1C,CAAC;KAAA;IAED;;;;;OAKG;IACU,MAAM;6DAAC,QAAiB,IAAI;YACvC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QACpC,CAAC;KAAA;IAED;;;;OAIG;IACU,IAAI,CAAC,MAAe;;YAC/B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACnC,CAAC;KAAA;IAED;;OAEG;IACI,MAAM;QACX,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;IAC/B,CAAC;IAED;;OAEG;IACI,QAAQ;QACb,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC;IACjC,CAAC;IAED;;OAEG;IACU,gBAAgB,CAAC,IAAiB;;YAC7C,OAAO,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;QAC7C,CAAC;KAAA;IAED,4EAA4E;IAC5E,uCAAuC;IACvC,4EAA4E;IAE5E,mBAAmB;IACnB,IAAW,EAAE,KAAa,OAAO,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC;IAEnD,2BAA2B;IAC3B,IAAW,SAAS,KAAyB,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC;IAE7E,8BAA8B;IAC9B,IAAW,WAAW,KAAa,OAAO,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC;IAErE,0BAA0B;IAC1B,IAAW,QAAQ,KAAyB,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC;IAE3E,yBAAyB;IACzB,IAAW,QAAQ,KAAyB,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC;IAE3E,8BAA8B;IAC9B,IAAW,YAAY,KAAyB,OAAO,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC;IAEnF,0BAA0B;IAC1B,IAAW,SAAS,KAAyB,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC;IAE7E,uBAAuB;IACvB,IAAW,MAAM,KAAyB,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC;IAEvE,4EAA4E;IAC5E,qCAAqC;IACrC,4EAA4E;IAE5E,4BAA4B;IAC5B,IAAW,UAAU,KAAyB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC;IAE/E,yBAAyB;IACzB,IAAW,OAAO,KAAyB,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC;IAEzE,0BAA0B;IAC1B,IAAW,QAAQ,KAAyB,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC;IAE3E,+BAA+B;IAC/B,IAAW,aAAa,KAAyB,OAAO,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC;IAErF,iCAAiC;IACjC,IAAW,SAAS,KAA0B,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC;IAE9E,0BAA0B;IAC1B,IAAW,IAAI;QACb,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC;IAC3B,CAAC;IAED,4EAA4E;IAC5E,6CAA6C;IAC7C,4EAA4E;IAE5E,oDAAoD;IACpD,IAAW,MAAM,KAAa,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC;IAE3D,sDAAsD;IACtD,IAAW,OAAO,KAAa,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC;IAE7D,kCAAkC;IAClC,IAAW,SAAS,KAAa,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC;IAEjE,mCAAmC;IACnC,IAAW,UAAU;QACnB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC;IACjC,CAAC;IAED,8BAA8B;IAC9B,IAAW,aAAa;QACtB,OAAO,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC;IACpC,CAAC;IAED,4BAA4B;IAC5B,IAAW,WAAW;QACpB,OAAO,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC;IAClC,CAAC;IAED,yDAAyD;IACzD,IAAW,YAAY,KAAyB,OAAO,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC;IAEnF,8BAA8B;IAC9B,IAAW,OAAO,KAAc,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC;IAE9D,6DAA6D;IAC7D,IAAW,YAAY;QACrB,OAAO,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC;IACnC,CAAC;IAED,+CAA+C;IAC/C,IAAW,UAAU;QACnB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC;IACjC,CAAC;CACF"}
+{"version":3,"file":"typed-record.js","sourceRoot":"","sources":["../../src/typed-record.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;;;;;;;;;;AAkHH,8EAA8E;AAC9E,oBAAoB;AACpB,8EAA8E;AAE9E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,MAAM,OAAO,WAAW;IAItB;;;OAGG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;IACxB,CAAC;IAED,4EAA4E;IAC5E,eAAe;IACf,4EAA4E;IAE5E;;;;;;;OAOG;IACH,IAAW,SAAS;QAClB,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED,4EAA4E;IAC5E,sBAAsB;IACtB,4EAA4E;IAE5E;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,IAAW,IAAI;QACb,MAAM,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC;QACrC,OAAO;YACL,IAAI,EAAK,GAAkB,EAAE,CAAC,UAAU,CAAC,IAAI,EAAE;YAC/C,KAAK,EAAI,GAAwB,EAAE,CAAC,UAAU,CAAC,KAAK,EAAE;YACtD,IAAI,EAAK,GAAe,EAAE,CAAC,UAAU,CAAC,IAAI,EAAK;YAC/C,IAAI,EAAK,GAAoB,EAAE,CAAC,UAAU,CAAC,IAAI,EAAE;YACjD,MAAM,EAAG,GAA4B,EAAE,CAAC,UAAU,CAAC,MAAM,EAAE;YAC3D,IAAI,EAAK,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC;YACzC,KAAK,EAAI,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC;SAC3C,CAAC;IACJ,CAAC;IAED,4EAA4E;IAC5E,yBAAyB;IACzB,4EAA4E;IAE5E;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACU,MAAM,CAAC,MAAkC;;YACpD,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,MAA4B,CAAC,CAAC;YACnF,2EAA2E;YAC3E,uEAAuE;YACvE,6EAA6E;YAC7E,oCAAoC;YACpC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,WAAW,CAAI,MAAM,CAAC,EAAE,CAAC;QACxD,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACU,MAAM,CAAC,MAA2B;;YAC7C,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;YAC7D,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,WAAW,CAAI,MAAM,CAAC,EAAE,CAAC;QACxD,CAAC;KAAA;IAED,4EAA4E;IAC5E,8BAA8B;IAC9B,4EAA4E;IAE5E;;;;;;;;;;OAUG;IACU,KAAK;6DAAC,eAAwB,KAAK;YAC9C,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;QAC1C,CAAC;KAAA;IAED;;;;;;;;;OASG;IACU,MAAM;6DAAC,QAAiB,IAAI;YACvC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QACpC,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACU,IAAI,CAAC,MAAe;;YAC/B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACnC,CAAC;KAAA;IAED;;;;;;;;OAQG;IACI,MAAM;QACX,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;IAC/B,CAAC;IAED;;;;OAIG;IACI,QAAQ;QACb,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC;IACjC,CAAC;IAED;;;;;;;;;;;OAWG;IACU,gBAAgB,CAAC,IAAiB;;YAC7C,OAAO,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;QAC7C,CAAC;KAAA;IAED,4EAA4E;IAC5E,uCAAuC;IACvC,4EAA4E;IAE5E;;;;;OAKG;IACH,IAAW,EAAE,KAAa,OAAO,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC;IAEnD;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,IAAW,SAAS,KAAyB,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC;IAE7E;;;;;;OAMG;IACH,IAAW,WAAW,KAAa,OAAO,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC;IAErE;;;;OAIG;IACH,IAAW,QAAQ,KAAyB,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC;IAE3E;;;;;OAKG;IACH,IAAW,QAAQ,KAAyB,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC;IAE3E;;;;;OAKG;IACH,IAAW,YAAY,KAAyB,OAAO,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC;IAEnF;;;;;OAKG;IACH,IAAW,SAAS,KAAyB,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC;IAE7E;;;;;OAKG;IACH,IAAW,MAAM,KAAyB,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC;IAEvE,4EAA4E;IAC5E,qCAAqC;IACrC,4EAA4E;IAE5E;;;;;OAKG;IACH,IAAW,UAAU,KAAyB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC;IAE/E;;;;;OAKG;IACH,IAAW,OAAO,KAAyB,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC;IAEzE;;OAEG;IACH,IAAW,QAAQ,KAAyB,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC;IAE3E;;;;;OAKG;IACH,IAAW,aAAa,KAAyB,OAAO,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC;IAErF;;;;;OAKG;IACH,IAAW,SAAS,KAA0B,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC;IAE9E;;;;;;;;;;;;;;;;;;;OAmBG;IACH,IAAW,IAAI;QACb,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC;IAC3B,CAAC;IAED,4EAA4E;IAC5E,6CAA6C;IAC7C,4EAA4E;IAE5E;;;;;OAKG;IACH,IAAW,MAAM,KAAa,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC;IAE3D;;;;;;OAMG;IACH,IAAW,OAAO,KAAa,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC;IAE7D;;;;;;;;;OASG;IACH,IAAW,SAAS,KAAa,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC;IAEjE;;;;;;OAMG;IACH,IAAW,UAAU;QACnB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC;IACjC,CAAC;IAED;;;;;OAKG;IACH,IAAW,aAAa;QACtB,OAAO,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC;IACpC,CAAC;IAED;;;;;;;OAOG;IACH,IAAW,WAAW;QACpB,OAAO,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC;IAClC,CAAC;IAED;;;;;;;;;OASG;IACH,IAAW,YAAY,KAAyB,OAAO,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC;IAEnF;;;;;OAKG;IACH,IAAW,OAAO,KAAc,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC;IAE9D;;;;;;;OAOG;IACH,IAAW,YAAY;QACrB,OAAO,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC;IACnC,CAAC;IAED;;;;;OAKG;IACH,IAAW,UAAU;QACnB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC;IACjC,CAAC;CACF"}

package/dist/esm/utils.js

@@ -1,4 +1,29 @@
 import { Convert, universalTypeOf } from '@enbox/common';
+/**
+ * Returns `true` if the DWN response status indicates success (2xx code).
+ *
+ * Use this instead of manually checking `status.code >= 200 && status.code <= 299`
+ * on every API call.
+ *
+ * @param response - Any object that conforms to {@link DwnResponseStatus}.
+ * @returns `true` for 2xx status codes, `false` otherwise.
+ *
+ * @example
+ * ```ts
+ * const result = await proto.records.create('note', { data: { text: 'hello' } });
+ * if (!isOk(result)) {
+ *   console.error('Create failed:', result.status.detail);
+ *   return;
+ * }
+ * // result.record is safe to use here
+ * ```
+ *
+ * @beta
+ */
+export function isOk(response) {
+    const code = response.status.code;
+    return code >= 200 && code <= 299;
+}
 /**
  * Converts various data types to a `Blob` object, automatically detecting the data type or using
  * the specified `dataFormat` to set the Blob's MIME type.

package/dist/esm/utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAEzD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,MAAM,UAAU,UAAU,CAAC,IAAS,EAAE,UAAmB;IAMvD,IAAI,QAAc,CAAC;IAEnB,2FAA2F;IAC3F,sFAAsF;IACtF,6FAA6F;IAC7F,8EAA8E;IAC9E,IAAI,gBAAoC,CAAC;IAEzC,4DAA4D;IAC5D,MAAM,YAAY,GAAG,eAAe,CAAC,IAAI,CAAC,CAAC;IAC3C,IAAI,UAAU,KAAK,YAAY,IAAI,YAAY,KAAK,QAAQ,EAAE,CAAC;QAC7D,gBAAgB,GAAG,YAAY,CAAC;QAChC,QAAQ,GAAG,IAAI,IAAI,CAAC,CAAC,IAAI,CAAC,EAAE,EAAE,IAAI,EAAE,gBAAgB,EAAE,CAAC,CAAC;IAC1D,CAAC;SAAM,IAAI,UAAU,KAAK,kBAAkB,IAAI,YAAY,KAAK,QAAQ,EAAE,CAAC;QAC1E,gBAAgB,GAAG,kBAAkB,CAAC;QACtC,MAAM,SAAS,GAAG,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,YAAY,EAAE,CAAC;QACtD,QAAQ,GAAG,IAAI,IAAI,CAAC,CAAC,SAAS,CAAC,EAAE,EAAE,IAAI,EAAE,gBAAgB,EAAE,CAAC,CAAC;IAC/D,CAAC;SAAM,IAAI,YAAY,KAAK,YAAY,IAAI,YAAY,KAAK,aAAa,EAAE,CAAC;QAC3E,gBAAgB,GAAG,0BAA0B,CAAC;QAC9C,QAAQ,GAAG,IAAI,IAAI,CAAC,CAAC,IAAI,CAAC,EAAE,EAAE,IAAI,EAAE,gBAAgB,EAAE,CAAC,CAAC;IAC1D,CAAC;SAAM,IAAI,YAAY,KAAK,MAAM,EAAE,CAAC;QACnC,QAAQ,GAAG,IAAI,CAAC;IAClB,CAAC;SAAM,CAAC;QACN,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAC;IAC9C,CAAC;IAED,UAAU,GAAG,UAAU,IAAI,gBAAgB,IAAI,QAAQ,CAAC,IAAI,IAAI,0BAA0B,CAAC;IAE3F,OAAO,EAAE,QAAQ,EAAE,UAAU,EAAE,CAAC;AAClC,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,OAAO,SAAS;IAcpB;;;;;;;OAOG;IACI,MAAM,CAAC,KAAK,CAAC,EAAU,EAAE,MAAc;QAC5C,MAAM,WAAW,GAAG,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QAC5C,OAAO,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;IACvD,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,GAAG,CAAC,EAAU,EAAE,MAAc;QAC1C,MAAM,WAAW,GAAG,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,IAAI,GAAG,EAAE,CAAC;QACzD,SAAS,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;QAC3B,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,EAAE,WAAW,CAAC,CAAC;QACrC,IAAI,IAAI,CAAC,KAAK,CAAC,IAAI,GAAG,SAAS,CAAC,cAAc,EAAE,CAAC;YAC/C,MAAM,WAAW,GAAG,SAAS,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC;YACxD,SAAS,CAAC,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;QACtC,CAAC;QACD,WAAW,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QAC3B,WAAW,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QACxB,IAAI,WAAW,CAAC,IAAI,GAAG,SAAS,CAAC,cAAc,EAAE,CAAC;YAChD,MAAM,WAAW,GAAG,WAAW,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC;YACpD,WAAW,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;QAClC,CAAC;IACH,CAAC;;AAhDD;;;EAGE;AACa,eAAK,GAAG,IAAI,GAAG,EAAuB,CAAC;AAEtD;;;;GAIG;AACY,wBAAc,GAAG,GAAG,CAAC"}
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/utils.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,OAAO,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAEzD;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,UAAU,IAAI,CAAC,QAA2B;IAC9C,MAAM,IAAI,GAAG,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC;IAClC,OAAO,IAAI,IAAI,GAAG,IAAI,IAAI,IAAI,GAAG,CAAC;AACpC,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,MAAM,UAAU,UAAU,CAAC,IAAS,EAAE,UAAmB;IAMvD,IAAI,QAAc,CAAC;IAEnB,2FAA2F;IAC3F,sFAAsF;IACtF,6FAA6F;IAC7F,8EAA8E;IAC9E,IAAI,gBAAoC,CAAC;IAEzC,4DAA4D;IAC5D,MAAM,YAAY,GAAG,eAAe,CAAC,IAAI,CAAC,CAAC;IAC3C,IAAI,UAAU,KAAK,YAAY,IAAI,YAAY,KAAK,QAAQ,EAAE,CAAC;QAC7D,gBAAgB,GAAG,YAAY,CAAC;QAChC,QAAQ,GAAG,IAAI,IAAI,CAAC,CAAC,IAAI,CAAC,EAAE,EAAE,IAAI,EAAE,gBAAgB,EAAE,CAAC,CAAC;IAC1D,CAAC;SAAM,IAAI,UAAU,KAAK,kBAAkB,IAAI,YAAY,KAAK,QAAQ,EAAE,CAAC;QAC1E,gBAAgB,GAAG,kBAAkB,CAAC;QACtC,MAAM,SAAS,GAAG,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,YAAY,EAAE,CAAC;QACtD,QAAQ,GAAG,IAAI,IAAI,CAAC,CAAC,SAAS,CAAC,EAAE,EAAE,IAAI,EAAE,gBAAgB,EAAE,CAAC,CAAC;IAC/D,CAAC;SAAM,IAAI,YAAY,KAAK,YAAY,IAAI,YAAY,KAAK,aAAa,EAAE,CAAC;QAC3E,gBAAgB,GAAG,0BAA0B,CAAC;QAC9C,QAAQ,GAAG,IAAI,IAAI,CAAC,CAAC,IAAI,CAAC,EAAE,EAAE,IAAI,EAAE,gBAAgB,EAAE,CAAC,CAAC;IAC1D,CAAC;SAAM,IAAI,YAAY,KAAK,MAAM,EAAE,CAAC;QACnC,QAAQ,GAAG,IAAI,CAAC;IAClB,CAAC;SAAM,CAAC;QACN,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAC;IAC9C,CAAC;IAED,UAAU,GAAG,UAAU,IAAI,gBAAgB,IAAI,QAAQ,CAAC,IAAI,IAAI,0BAA0B,CAAC;IAE3F,OAAO,EAAE,QAAQ,EAAE,UAAU,EAAE,CAAC;AAClC,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,OAAO,SAAS;IAcpB;;;;;;;OAOG;IACI,MAAM,CAAC,KAAK,CAAC,EAAU,EAAE,MAAc;QAC5C,MAAM,WAAW,GAAG,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QAC5C,OAAO,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;IACvD,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,GAAG,CAAC,EAAU,EAAE,MAAc;QAC1C,MAAM,WAAW,GAAG,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,IAAI,GAAG,EAAE,CAAC;QACzD,SAAS,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;QAC3B,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,EAAE,WAAW,CAAC,CAAC;QACrC,IAAI,IAAI,CAAC,KAAK,CAAC,IAAI,GAAG,SAAS,CAAC,cAAc,EAAE,CAAC;YAC/C,MAAM,WAAW,GAAG,SAAS,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC;YACxD,SAAS,CAAC,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;QACtC,CAAC;QACD,WAAW,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QAC3B,WAAW,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QACxB,IAAI,WAAW,CAAC,IAAI,GAAG,SAAS,CAAC,cAAc,EAAE,CAAC;YAChD,MAAM,WAAW,GAAG,WAAW,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC;YACpD,WAAW,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;QAClC,CAAC;IACH,CAAC;;AAhDD;;;EAGE;AACa,eAAK,GAAG,IAAI,GAAG,EAAuB,CAAC;AAEtD;;;;GAIG;AACY,wBAAc,GAAG,GAAG,CAAC"}

package/dist/esm/vc-api.js.map

@@ -1 +1 @@
-{"version":3,"file":"vc-api.js","sourceRoot":"","sources":["../../src/vc-api.ts"],"names":[],"mappings":";;;;;;;;;AAEA;;;;GAIG;AACH,MAAM,OAAO,KAAK;IAUhB,YAAY,OAAmD;QAC7D,IAAI,CAAC,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC;QAC3B,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC;IAC3C,CAAC;IAED;;OAEG;IACG,MAAM;;YACV,kBAAkB;YAClB,MAAM,IAAI,KAAK,CAAC,kBAAkB,CAAC,CAAC;QACtC,CAAC;KAAA;CACF"}
+{"version":3,"file":"vc-api.js","sourceRoot":"","sources":["../../src/vc-api.ts"],"names":[],"mappings":";;;;;;;;;AAEA;;;;GAIG;AACH,MAAM,OAAO,KAAK;IAUhB,YAAY,OAAoD;QAC9D,IAAI,CAAC,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC;QAC3B,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC;IAC3C,CAAC;IAED;;OAEG;IACG,MAAM;;YACV,kBAAkB;YAClB,MAAM,IAAI,KAAK,CAAC,kBAAkB,CAAC,CAAC;QACtC,CAAC;KAAA;CACF"}

package/dist/types/advanced.d.ts

@@ -2,7 +2,7 @@
  * Advanced API surface for power users who need direct access to
  * the underlying {@link DwnApi}.
  *
- * Most applications should use `web5.using(protocol)` instead.
+ * Most applications should use `enbox.using(protocol)` instead.
  * Import from `@enbox/api/advanced` to access these exports.
  *
  * @packageDocumentation

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 TypedWeb5} can provide
+ * compile-time type metadata so that {@link TypedEnbox} 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 `TypedWeb5`.
+ * type information through to `TypedEnbox`.
  *
  * @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
- * // TypedWeb5 infers paths like 'friend' | 'friend/message' and
+ * // TypedEnbox infers paths like 'friend' | 'friend/message' and
  * // data types from the schema map.
  * ```
  */