@enbox/api 0.3.1 → 0.4.0

package/dist/types/typed-record.d.ts

@@ -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();
  * ```
  */
 import type { Record } from './record.js';
@@ -32,148 +47,507 @@ import type { DwnInterface } from '@enbox/agent';
  *
  * All other methods (`blob`, `bytes`, `text`, `stream`, `then`, `catch`)
  * are forwarded unchanged from the underlying {@link RecordData}.
+ *
+ * @typeParam T - The TypeScript type returned by {@link TypedRecordData.json | json()}.
+ *
+ * @example
+ * ```ts
+ * const { record } = await proto.records.read('notebook', {
+ *   filter: { recordId: notebookId },
+ * });
+ *
+ * const payload = await record.data.json();   // Promise<NotebookData>
+ * const raw     = await record.data.text();   // Promise<string>
+ * const blob    = await record.data.blob();   // Promise<Blob>
+ * const stream  = await record.data.stream(); // Promise<ReadableStream>
+ * ```
  */
 export type TypedRecordData<T> = Omit<RecordData, 'json'> & {
-    /** Parse the data as JSON, returning the typed data shape `T`. */
+    /**
+     * Parse the record's data as JSON, returning the typed data shape `T`.
+     *
+     * @returns A promise resolving to the record's data payload typed as `T`.
+     * @throws If the data is not valid JSON or the record has been deleted.
+     */
     json: () => Promise<T>;
 };
 /**
  * Update parameters for a {@link TypedRecord}.
  *
- * Extends the base `RecordUpdateParams` but narrows `data` from `unknown`
- * to `Partial<T>`.
+ * Extends the base {@link RecordUpdateParams} but narrows `data` from
+ * `unknown` to `Partial<T>`, providing compile-time type safety when
+ * updating record payloads.
+ *
+ * @typeParam T - The full data type of the record being updated.
+ *
+ * @example
+ * ```ts
+ * await record.update({
+ *   data: { title: 'Updated title' },  // Partial<NotebookData>
+ *   tags: { category: 'work' },
+ * });
+ * ```
  */
 export type TypedRecordUpdateParams<T> = Omit<RecordUpdateParams, 'data'> & {
-    /** The new data for the record. Type-checked against the schema map. */
+    /**
+     * The new data for the record. Type-checked against the schema map as
+     * `Partial<T>`, so you only need to supply the fields you want to change.
+     */
     data?: Partial<T>;
 };
 /**
  * Result of a {@link TypedRecord.update} operation.
+ *
+ * Includes the DWN response status (`status.code` / `status.detail`) and
+ * the updated record, which carries the same type parameter `T` so
+ * subsequent reads remain type-safe.
+ *
+ * @typeParam T - The data type of the record.
  */
 export type TypedRecordUpdateResult<T> = DwnResponseStatus & {
-    /** The updated record, carrying the same type parameter. */
+    /**
+     * The updated record, carrying the same type parameter `T`.
+     *
+     * This is a **new** {@link TypedRecord} instance reflecting the post-update
+     * state. The original record instance is also mutated in-place, so both
+     * references see the updated data.
+     */
     record: TypedRecord<T>;
 };
 /**
  * Result of a {@link TypedRecord.delete} operation.
+ *
+ * Includes the DWN response status and the record in its deleted state.
+ * The original record instance is also mutated in-place, so both
+ * references reflect the deletion.
+ *
+ * @typeParam T - The data type of the record.
  */
 export type TypedRecordDeleteResult<T> = DwnResponseStatus & {
-    /** The deleted record, carrying the same type parameter. */
+    /**
+     * The record in its deleted state. The {@link TypedRecord.deleted} getter
+     * will return `true`, and data accessors will throw.
+     */
     record: TypedRecord<T>;
 };
 /**
  * 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 declare class TypedRecord<T> {
-    /** The underlying untyped Record instance. */
+    /** @internal The underlying untyped Record instance. */
     private _record;
+    /**
+     * @internal Wrap an untyped {@link Record} in a type-safe shell.
+     * @param record - The underlying `Record` instance to wrap.
+     */
     constructor(record: Record);
-    /** 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(): Record;
     /**
-     * Returns the data of the current record with type-safe accessors.
+     * Returns the record's data with type-safe accessors.
      *
-     * The `json()` method returns `Promise<T>` — no manual generic needed.
+     * The returned object provides multiple ways to consume the data:
      *
+     * | 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(): TypedRecordData<T>;
     /**
-     * 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: TypedRecordUpdateParams<T>): Promise<TypedRecordUpdateResult<T>>;
     /**
-     * Delete the current record on the DWN.
+     * Delete the current record from the DWN.
+     *
+     * 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.
      *
-     * @param params - Delete parameters.
-     * @returns The status and a {@link TypedRecord} reflecting the deleted state.
+     * @example
+     * ```ts
+     * const { status } = await record.delete({ prune: true });
+     * if (status.code === 202) {
+     *   console.log('Record and children deleted');
+     * }
+     * ```
      */
     delete(params?: RecordDeleteParams): Promise<TypedRecordDeleteResult<T>>;
     /**
-     * Stores the current record state to the owner's DWN.
+     * Stores the current record state to the local DWN.
      *
-     * @param importRecord - If true, sign as owner before storing. Defaults to false.
+     * 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 the record as the DWN owner
+     *   before storing (useful for importing records authored by others).
+     *   Defaults to `false`.
+     * @returns The DWN response status.
      */
     store(importRecord?: boolean): Promise<DwnResponseStatus>;
     /**
-     * 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.
+     *
+     * 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, store after signing. Defaults to true.
+     * @param store - If `true`, persist the record after signing.
+     *   Defaults to `true`.
+     * @returns The DWN response status.
      */
     import(store?: boolean): Promise<DwnResponseStatus>;
     /**
-     * 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?: string): Promise<DwnResponseStatus>;
     /**
-     * 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(): RecordModel;
     /**
-     * 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(): string;
     /**
-     * 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: DwnDateSort): Promise<DwnPaginationCursor | undefined>;
-    /** 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(): string;
-    /** 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(): string | undefined;
-    /** 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(): string;
-    /** 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(): string | undefined;
-    /** 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(): string | undefined;
-    /** 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(): string | undefined;
-    /** 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(): string | undefined;
-    /** 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(): string | undefined;
-    /** 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(): string | undefined;
-    /** 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(): string | undefined;
-    /** Record's data size. */
+    /**
+     * The size of the record's data payload in bytes.
+     */
     get dataSize(): number | undefined;
-    /** 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(): string | undefined;
-    /** 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(): boolean | undefined;
-    /** 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(): DwnMessage[DwnInterface.RecordsWrite]['descriptor']['tags'] | undefined;
-    /** 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(): string;
-    /** 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(): string;
-    /** 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(): string;
-    /** 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(): DwnMessage[DwnInterface.RecordsWrite]['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(): DwnMessage[DwnInterface.RecordsWrite | DwnInterface.RecordsDelete]['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(): DwnMessage[DwnInterface.RecordsWrite]['attestation'] | undefined;
-    /** 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(): string | undefined;
-    /** 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(): boolean;
-    /** 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(): DwnMessage[DwnInterface.RecordsWrite] | undefined;
-    /** 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(): DwnMessage[DwnInterface.RecordsWrite] | DwnMessage[DwnInterface.RecordsDelete];
 }
 //# sourceMappingURL=typed-record.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"typed-record.d.ts","sourceRoot":"","sources":["../../src/typed-record.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAEH,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAC1C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AACnD,OAAO,KAAK,EAAE,WAAW,EAAE,UAAU,EAAE,mBAAmB,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AACpG,OAAO,KAAK,EAAE,kBAAkB,EAAE,WAAW,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAC;AAE7F,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAMjD;;;;;;GAMG;AACH,MAAM,MAAM,eAAe,CAAC,CAAC,IAAI,IAAI,CAAC,UAAU,EAAE,MAAM,CAAC,GAAG;IAC1D,kEAAkE;IAClE,IAAI,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,CAAC;CACxB,CAAC;AAMF;;;;;GAKG;AACH,MAAM,MAAM,uBAAuB,CAAC,CAAC,IAAI,IAAI,CAAC,kBAAkB,EAAE,MAAM,CAAC,GAAG;IAC1E,wEAAwE;IACxE,IAAI,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC;CACnB,CAAC;AAMF;;GAEG;AACH,MAAM,MAAM,uBAAuB,CAAC,CAAC,IAAI,iBAAiB,GAAG;IAC3D,4DAA4D;IAC5D,MAAM,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC;CACxB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,uBAAuB,CAAC,CAAC,IAAI,iBAAiB,GAAG;IAC3D,4DAA4D;IAC5D,MAAM,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC;CACxB,CAAC;AAMF;;;;;GAKG;AACH,qBAAa,WAAW,CAAC,CAAC;IACxB,8CAA8C;IAC9C,OAAO,CAAC,OAAO,CAAS;gBAEZ,MAAM,EAAE,MAAM;IAQ1B,2EAA2E;IAC3E,IAAW,SAAS,IAAI,MAAM,CAE7B;IAMD;;;;;;OAMG;IACH,IAAW,IAAI,IAAI,eAAe,CAAC,CAAC,CAAC,CAWpC;IAMD;;;;;;OAMG;IACU,MAAM,CAAC,MAAM,EAAE,uBAAuB,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,uBAAuB,CAAC,CAAC,CAAC,CAAC;IAK5F;;;;;OAKG;IACU,MAAM,CAAC,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,uBAAuB,CAAC,CAAC,CAAC,CAAC;IASrF;;;;OAIG;IACU,KAAK,CAAC,YAAY,GAAE,OAAe,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAI7E;;;;;OAKG;IACU,MAAM,CAAC,KAAK,GAAE,OAAc,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAItE;;;;OAIG;IACU,IAAI,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAI9D;;OAEG;IACI,MAAM,IAAI,WAAW;IAI5B;;OAEG;IACI,QAAQ,IAAI,MAAM;IAIzB;;OAEG;IACU,gBAAgB,CAAC,IAAI,EAAE,WAAW,GAAG,OAAO,CAAC,mBAAmB,GAAG,SAAS,CAAC;IAQ1F,mBAAmB;IACnB,IAAW,EAAE,IAAI,MAAM,CAA4B;IAEnD,2BAA2B;IAC3B,IAAW,SAAS,IAAI,MAAM,GAAG,SAAS,CAAmC;IAE7E,8BAA8B;IAC9B,IAAW,WAAW,IAAI,MAAM,CAAqC;IAErE,0BAA0B;IAC1B,IAAW,QAAQ,IAAI,MAAM,GAAG,SAAS,CAAkC;IAE3E,yBAAyB;IACzB,IAAW,QAAQ,IAAI,MAAM,GAAG,SAAS,CAAkC;IAE3E,8BAA8B;IAC9B,IAAW,YAAY,IAAI,MAAM,GAAG,SAAS,CAAsC;IAEnF,0BAA0B;IAC1B,IAAW,SAAS,IAAI,MAAM,GAAG,SAAS,CAAmC;IAE7E,uBAAuB;IACvB,IAAW,MAAM,IAAI,MAAM,GAAG,SAAS,CAAgC;IAMvE,4BAA4B;IAC5B,IAAW,UAAU,IAAI,MAAM,GAAG,SAAS,CAAoC;IAE/E,yBAAyB;IACzB,IAAW,OAAO,IAAI,MAAM,GAAG,SAAS,CAAiC;IAEzE,0BAA0B;IAC1B,IAAW,QAAQ,IAAI,MAAM,GAAG,SAAS,CAAkC;IAE3E,+BAA+B;IAC/B,IAAW,aAAa,IAAI,MAAM,GAAG,SAAS,CAAuC;IAErF,iCAAiC;IACjC,IAAW,SAAS,IAAI,OAAO,GAAG,SAAS,CAAmC;IAE9E,0BAA0B;IAC1B,IAAW,IAAI,IAAI,UAAU,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC,YAAY,CAAC,CAAC,MAAM,CAAC,GAAG,SAAS,CAEzF;IAMD,oDAAoD;IACpD,IAAW,MAAM,IAAI,MAAM,CAAgC;IAE3D,sDAAsD;IACtD,IAAW,OAAO,IAAI,MAAM,CAAiC;IAE7D,kCAAkC;IAClC,IAAW,SAAS,IAAI,MAAM,CAAmC;IAEjE,mCAAmC;IACnC,IAAW,UAAU,IAAI,UAAU,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC,YAAY,CAAC,CAE3E;IAED,8BAA8B;IAC9B,IAAW,aAAa,IAAI,UAAU,CAAC,YAAY,CAAC,YAAY,GAAG,YAAY,CAAC,aAAa,CAAC,CAAC,eAAe,CAAC,CAE9G;IAED,4BAA4B;IAC5B,IAAW,WAAW,IAAI,UAAU,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC,aAAa,CAAC,GAAG,SAAS,CAEzF;IAED,yDAAyD;IACzD,IAAW,YAAY,IAAI,MAAM,GAAG,SAAS,CAAsC;IAEnF,8BAA8B;IAC9B,IAAW,OAAO,IAAI,OAAO,CAAiC;IAE9D,6DAA6D;IAC7D,IAAW,YAAY,IAAI,UAAU,CAAC,YAAY,CAAC,YAAY,CAAC,GAAG,SAAS,CAE3E;IAED,+CAA+C;IAC/C,IAAW,UAAU,IAAI,UAAU,CAAC,YAAY,CAAC,YAAY,CAAC,GAAG,UAAU,CAAC,YAAY,CAAC,aAAa,CAAC,CAEtG;CACF"}
+{"version":3,"file":"typed-record.d.ts","sourceRoot":"","sources":["../../src/typed-record.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AAEH,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAC1C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AACnD,OAAO,KAAK,EAAE,WAAW,EAAE,UAAU,EAAE,mBAAmB,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AACpG,OAAO,KAAK,EAAE,kBAAkB,EAAE,WAAW,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAC;AAE7F,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAMjD;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,MAAM,eAAe,CAAC,CAAC,IAAI,IAAI,CAAC,UAAU,EAAE,MAAM,CAAC,GAAG;IAC1D;;;;;OAKG;IACH,IAAI,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,CAAC;CACxB,CAAC;AAMF;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,MAAM,uBAAuB,CAAC,CAAC,IAAI,IAAI,CAAC,kBAAkB,EAAE,MAAM,CAAC,GAAG;IAC1E;;;OAGG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC;CACnB,CAAC;AAMF;;;;;;;;GAQG;AACH,MAAM,MAAM,uBAAuB,CAAC,CAAC,IAAI,iBAAiB,GAAG;IAC3D;;;;;;OAMG;IACH,MAAM,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC;CACxB,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,MAAM,uBAAuB,CAAC,CAAC,IAAI,iBAAiB,GAAG;IAC3D;;;OAGG;IACH,MAAM,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC;CACxB,CAAC;AAMF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,qBAAa,WAAW,CAAC,CAAC;IACxB,wDAAwD;IACxD,OAAO,CAAC,OAAO,CAAS;IAExB;;;OAGG;gBACS,MAAM,EAAE,MAAM;IAQ1B;;;;;;;OAOG;IACH,IAAW,SAAS,IAAI,MAAM,CAE7B;IAMD;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,IAAW,IAAI,IAAI,eAAe,CAAC,CAAC,CAAC,CAWpC;IAMD;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACU,MAAM,CAAC,MAAM,EAAE,uBAAuB,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,uBAAuB,CAAC,CAAC,CAAC,CAAC;IAS5F;;;;;;;;;;;;;;;;;;;;;OAqBG;IACU,MAAM,CAAC,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,uBAAuB,CAAC,CAAC,CAAC,CAAC;IASrF;;;;;;;;;;OAUG;IACU,KAAK,CAAC,YAAY,GAAE,OAAe,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAI7E;;;;;;;;;OASG;IACU,MAAM,CAAC,KAAK,GAAE,OAAc,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAItE;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACU,IAAI,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAI9D;;;;;;;;OAQG;IACI,MAAM,IAAI,WAAW;IAI5B;;;;OAIG;IACI,QAAQ,IAAI,MAAM;IAIzB;;;;;;;;;;;OAWG;IACU,gBAAgB,CAAC,IAAI,EAAE,WAAW,GAAG,OAAO,CAAC,mBAAmB,GAAG,SAAS,CAAC;IAQ1F;;;;;OAKG;IACH,IAAW,EAAE,IAAI,MAAM,CAA4B;IAEnD;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,IAAW,SAAS,IAAI,MAAM,GAAG,SAAS,CAAmC;IAE7E;;;;;;OAMG;IACH,IAAW,WAAW,IAAI,MAAM,CAAqC;IAErE;;;;OAIG;IACH,IAAW,QAAQ,IAAI,MAAM,GAAG,SAAS,CAAkC;IAE3E;;;;;OAKG;IACH,IAAW,QAAQ,IAAI,MAAM,GAAG,SAAS,CAAkC;IAE3E;;;;;OAKG;IACH,IAAW,YAAY,IAAI,MAAM,GAAG,SAAS,CAAsC;IAEnF;;;;;OAKG;IACH,IAAW,SAAS,IAAI,MAAM,GAAG,SAAS,CAAmC;IAE7E;;;;;OAKG;IACH,IAAW,MAAM,IAAI,MAAM,GAAG,SAAS,CAAgC;IAMvE;;;;;OAKG;IACH,IAAW,UAAU,IAAI,MAAM,GAAG,SAAS,CAAoC;IAE/E;;;;;OAKG;IACH,IAAW,OAAO,IAAI,MAAM,GAAG,SAAS,CAAiC;IAEzE;;OAEG;IACH,IAAW,QAAQ,IAAI,MAAM,GAAG,SAAS,CAAkC;IAE3E;;;;;OAKG;IACH,IAAW,aAAa,IAAI,MAAM,GAAG,SAAS,CAAuC;IAErF;;;;;OAKG;IACH,IAAW,SAAS,IAAI,OAAO,GAAG,SAAS,CAAmC;IAE9E;;;;;;;;;;;;;;;;;;;OAmBG;IACH,IAAW,IAAI,IAAI,UAAU,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC,YAAY,CAAC,CAAC,MAAM,CAAC,GAAG,SAAS,CAEzF;IAMD;;;;;OAKG;IACH,IAAW,MAAM,IAAI,MAAM,CAAgC;IAE3D;;;;;;OAMG;IACH,IAAW,OAAO,IAAI,MAAM,CAAiC;IAE7D;;;;;;;;;OASG;IACH,IAAW,SAAS,IAAI,MAAM,CAAmC;IAEjE;;;;;;OAMG;IACH,IAAW,UAAU,IAAI,UAAU,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC,YAAY,CAAC,CAE3E;IAED;;;;;OAKG;IACH,IAAW,aAAa,IAAI,UAAU,CAAC,YAAY,CAAC,YAAY,GAAG,YAAY,CAAC,aAAa,CAAC,CAAC,eAAe,CAAC,CAE9G;IAED;;;;;;;OAOG;IACH,IAAW,WAAW,IAAI,UAAU,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC,aAAa,CAAC,GAAG,SAAS,CAEzF;IAED;;;;;;;;;OASG;IACH,IAAW,YAAY,IAAI,MAAM,GAAG,SAAS,CAAsC;IAEnF;;;;;OAKG;IACH,IAAW,OAAO,IAAI,OAAO,CAAiC;IAE9D;;;;;;;OAOG;IACH,IAAW,YAAY,IAAI,UAAU,CAAC,YAAY,CAAC,YAAY,CAAC,GAAG,SAAS,CAE3E;IAED;;;;;OAKG;IACH,IAAW,UAAU,IAAI,UAAU,CAAC,YAAY,CAAC,YAAY,CAAC,GAAG,UAAU,CAAC,YAAY,CAAC,aAAa,CAAC,CAEtG;CACF"}

package/dist/types/utils.d.ts

@@ -1,3 +1,26 @@
+import type { DwnResponseStatus } from '@enbox/agent';
+/**
+ * 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 declare function isOk(response: DwnResponseStatus): boolean;
 /**
  * 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/types/utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/utils.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,wBAAgB,UAAU,CAAC,IAAI,EAAE,GAAG,EAAE,UAAU,CAAC,EAAE,MAAM,GAAG;IAC1D,+CAA+C;IAC/C,QAAQ,EAAE,IAAI,CAAC;IACf,iCAAiC;IACjC,UAAU,EAAE,MAAM,CAAC;CACpB,CA8BA;AAED;;;;;;;;;;;;GAYG;AACH,qBAAa,SAAS;IACpB;;;MAGE;IACF,OAAO,CAAC,MAAM,CAAC,KAAK,CAAkC;IAEtD;;;;OAIG;IACH,OAAO,CAAC,MAAM,CAAC,cAAc,CAAO;IAEpC;;;;;;;OAOG;WACW,KAAK,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO;IAKxD;;;;;;;OAOG;WACW,GAAG,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,IAAI;CAepD"}
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/utils.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AAGtD;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,IAAI,CAAC,QAAQ,EAAE,iBAAiB,GAAG,OAAO,CAGzD;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,wBAAgB,UAAU,CAAC,IAAI,EAAE,GAAG,EAAE,UAAU,CAAC,EAAE,MAAM,GAAG;IAC1D,+CAA+C;IAC/C,QAAQ,EAAE,IAAI,CAAC;IACf,iCAAiC;IACjC,UAAU,EAAE,MAAM,CAAC;CACpB,CA8BA;AAED;;;;;;;;;;;;GAYG;AACH,qBAAa,SAAS;IACpB;;;MAGE;IACF,OAAO,CAAC,MAAM,CAAC,KAAK,CAAkC;IAEtD;;;;OAIG;IACH,OAAO,CAAC,MAAM,CAAC,cAAc,CAAO;IAEpC;;;;;;;OAOG;WACW,KAAK,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO;IAKxD;;;;;;;OAOG;WACW,GAAG,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,IAAI;CAepD"}

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

@@ -1,4 +1,4 @@
-import type { Web5Agent } from '@enbox/agent';
+import type { EnboxAgent } from '@enbox/agent';
 /**
  * The VC API is used to issue, present and verify VCs
  *
@@ -6,14 +6,14 @@ import type { Web5Agent } from '@enbox/agent';
  */
 export declare class VcApi {
     /**
-     * Holds the instance of a {@link Web5Agent} that represents the current execution context for
+     * Holds the instance of a {@link EnboxAgent} that represents the current execution context for
      * the `VcApi`. This agent is used to process VC requests.
      */
     private agent;
     /** The DID of the tenant under which DID operations are being performed. */
     private connectedDid;
     constructor(options: {
-        agent: Web5Agent;
+        agent: EnboxAgent;
         connectedDid: string;
     });
     /**

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

@@ -1 +1 @@
-{"version":3,"file":"vc-api.d.ts","sourceRoot":"","sources":["../../src/vc-api.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAE9C;;;;GAIG;AACH,qBAAa,KAAK;IAChB;;;OAGG;IACH,OAAO,CAAC,KAAK,CAAY;IAEzB,4EAA4E;IAC5E,OAAO,CAAC,YAAY,CAAS;gBAEjB,OAAO,EAAE;QAAE,KAAK,EAAE,SAAS,CAAC;QAAC,YAAY,EAAE,MAAM,CAAA;KAAE;IAK/D;;OAEG;IACG,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC;CAI9B"}
+{"version":3,"file":"vc-api.d.ts","sourceRoot":"","sources":["../../src/vc-api.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE/C;;;;GAIG;AACH,qBAAa,KAAK;IAChB;;;OAGG;IACH,OAAO,CAAC,KAAK,CAAa;IAE1B,4EAA4E;IAC5E,OAAO,CAAC,YAAY,CAAS;gBAEjB,OAAO,EAAE;QAAE,KAAK,EAAE,UAAU,CAAC;QAAC,YAAY,EAAE,MAAM,CAAA;KAAE;IAKhE;;OAEG;IACG,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC;CAI9B"}