@enbox/api 0.2.3 → 0.2.4

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

@@ -0,0 +1,179 @@
+/**
+ * A type-safe wrapper around {@link Record} that carries the data type `T`
+ * through its entire lifecycle — from write to read, query, update, and
+ * subscribe.
+ *
+ * `TypedRecord<T>` uses composition (not inheritance) to wrap the underlying
+ * untyped `Record` class. All read-only getters and lifecycle methods are
+ * forwarded, while data-access and mutation methods are enhanced with the
+ * generic `T`:
+ *
+ * - `.data.json()` returns `Promise<T>` instead of `Promise<unknown>`.
+ * - `.update({ data })` accepts `Partial<T>` for the data payload.
+ *
+ * @example
+ * ```ts
+ * const { record } = await typed.records.write('friend', {
+ *   data: { did: 'did:example:alice', alias: 'Alice' },
+ * });
+ *
+ * // record is TypedRecord<FriendData>
+ * const data = await record.data.json(); // FriendData — no manual cast
+ * ```
+ */
+import type { Record } from './record.js';
+import type { RecordData } from './record-data.js';
+import type { DwnDateSort, DwnMessage, DwnPaginationCursor, DwnResponseStatus } from '@enbox/agent';
+import type { RecordDeleteParams, RecordModel, RecordUpdateParams } from './record-types.js';
+import type { DwnInterface } from '@enbox/agent';
+/**
+ * A data accessor that preserves the record's type parameter `T` on
+ * the `json()` method.
+ *
+ * All other methods (`blob`, `bytes`, `text`, `stream`, `then`, `catch`)
+ * are forwarded unchanged from the underlying {@link RecordData}.
+ */
+export type TypedRecordData<T> = Omit<RecordData, 'json'> & {
+    /** Parse the data as JSON, returning the typed data shape `T`. */
+    json: () => Promise<T>;
+};
+/**
+ * Update parameters for a {@link TypedRecord}.
+ *
+ * Extends the base `RecordUpdateParams` but narrows `data` from `unknown`
+ * to `Partial<T>`.
+ */
+export type TypedRecordUpdateParams<T> = Omit<RecordUpdateParams, 'data'> & {
+    /** The new data for the record. Type-checked against the schema map. */
+    data?: Partial<T>;
+};
+/**
+ * Result of a {@link TypedRecord.update} operation.
+ */
+export type TypedRecordUpdateResult<T> = DwnResponseStatus & {
+    /** The updated record, carrying the same type parameter. */
+    record: TypedRecord<T>;
+};
+/**
+ * Result of a {@link TypedRecord.delete} operation.
+ */
+export type TypedRecordDeleteResult<T> = DwnResponseStatus & {
+    /** The deleted record, carrying the same type parameter. */
+    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.
+ */
+export declare class TypedRecord<T> {
+    /** The underlying untyped Record instance. */
+    private _record;
+    constructor(record: Record);
+    /** Access the underlying untyped {@link Record} for advanced use cases. */
+    get rawRecord(): Record;
+    /**
+     * Returns the data of the current record with type-safe accessors.
+     *
+     * The `json()` method returns `Promise<T>` — no manual generic needed.
+     *
+     * @throws `Error` if the record has been deleted.
+     */
+    get data(): TypedRecordData<T>;
+    /**
+     * Update the current record on the DWN.
+     *
+     * @param params - Parameters including the typed `data` payload.
+     * @returns The status and an updated {@link TypedRecord}.
+     * @throws `Error` if the record has been deleted.
+     */
+    update(params: TypedRecordUpdateParams<T>): Promise<TypedRecordUpdateResult<T>>;
+    /**
+     * Delete the current record on the DWN.
+     *
+     * @param params - Delete parameters.
+     * @returns The status and a {@link TypedRecord} reflecting the deleted state.
+     */
+    delete(params?: RecordDeleteParams): Promise<TypedRecordDeleteResult<T>>;
+    /**
+     * Stores the current record state to the owner's DWN.
+     *
+     * @param importRecord - If true, sign as owner before storing. Defaults to false.
+     */
+    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.
+     *
+     * @param store - If true, store after signing. Defaults to true.
+     */
+    import(store?: boolean): Promise<DwnResponseStatus>;
+    /**
+     * Send the current record to a remote DWN.
+     *
+     * @param target - Optional DID of the target DWN. Defaults to the connected DID.
+     */
+    send(target?: string): Promise<DwnResponseStatus>;
+    /**
+     * Returns a JSON representation of the Record instance.
+     */
+    toJSON(): RecordModel;
+    /**
+     * Returns a string representation of the Record instance.
+     */
+    toString(): string;
+    /**
+     * Returns a pagination cursor for the current record given a sort order.
+     */
+    paginationCursor(sort: DwnDateSort): Promise<DwnPaginationCursor | undefined>;
+    /** Record's ID. */
+    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. */
+    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. */
+    get dataFormat(): string | undefined;
+    /** Record's data CID. */
+    get dataCid(): string | undefined;
+    /** Record's data size. */
+    get dataSize(): number | undefined;
+    /** Record's published date. */
+    get datePublished(): string | undefined;
+    /** Record's published status. */
+    get published(): boolean | undefined;
+    /** Tags of the record. */
+    get tags(): DwnMessage[DwnInterface.RecordsWrite]['descriptor']['tags'] | undefined;
+    /** DID that is the logical author of the Record. */
+    get author(): string;
+    /** DID that is the original creator of the Record. */
+    get creator(): string;
+    /** Record's message timestamp. */
+    get timestamp(): string;
+    /** Record's encryption details. */
+    get encryption(): DwnMessage[DwnInterface.RecordsWrite]['encryption'];
+    /** Record's authorization. */
+    get authorization(): DwnMessage[DwnInterface.RecordsWrite | DwnInterface.RecordsDelete]['authorization'];
+    /** Record's attestation. */
+    get attestation(): DwnMessage[DwnInterface.RecordsWrite]['attestation'] | undefined;
+    /** Role under which the author is writing the record. */
+    get protocolRole(): string | undefined;
+    /** Record's deleted state. */
+    get deleted(): boolean;
+    /** Record's initial write if the record has been updated. */
+    get initialWrite(): DwnMessage[DwnInterface.RecordsWrite] | undefined;
+    /** The raw DWN message backing this record. */
+    get rawMessage(): DwnMessage[DwnInterface.RecordsWrite] | DwnMessage[DwnInterface.RecordsDelete];
+}
+//# sourceMappingURL=typed-record.d.ts.map

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

@@ -0,0 +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"}

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

@@ -6,6 +6,10 @@
  * and schema into every operation, and provides compile-time path
  * autocompletion plus typed data payloads via the schema map.
  *
+ * All record-returning methods wrap the underlying `Record` instances in
+ * {@link TypedRecord} so that type information flows through reads, queries,
+ * updates, and subscriptions without manual casts.
+ *
  * @example
  * ```ts
  * const social = web5.using(SocialProtocol);
@@ -13,33 +17,39 @@
  * // Install the protocol
  * await social.configure();
  *
- * // Write — path and data type are checked at compile time
- * const { record } = await social.records.write('thread', {
+ * // Create — path and data type are checked at compile time
+ * const { record } = await social.records.create('thread', {
  *   data: { title: 'Hello World', body: '...' },
  * });
+ * // record is TypedRecord<ThreadData>
+ *
+ * const data = await record.data.json(); // ThreadData — no cast needed
  *
  * // Query — protocol and protocolPath are auto-injected
  * const { records } = await social.records.query('thread');
+ * // records is TypedRecord<ThreadData>[]
  *
- * // Subscribe — real-time changes via LiveQuery
+ * // Subscribe — real-time changes via TypedLiveQuery
  * const { liveQuery } = await social.records.subscribe('thread/reply');
- * liveQuery.on('create', (record) => { ... });
+ * liveQuery.on('create', (record) => {
+ *   // record is TypedRecord<ReplyData>
+ * });
  * ```
  */
 import type { DwnApi } from './dwn-api.js';
-import type { LiveQuery } from './live-query.js';
 import type { Protocol } from './protocol.js';
-import type { Record } from './record.js';
 import type { DateSort, ProtocolDefinition, ProtocolType, RecordsFilter } from '@enbox/dwn-sdk-js';
 import type { DwnPaginationCursor, DwnResponseStatus } from '@enbox/agent';
 import type { ProtocolPaths, SchemaMap, TypedProtocol, TypeNameAtPath } from './protocol-types.js';
+import { TypedLiveQuery } from './typed-live-query.js';
+import { TypedRecord } from './typed-record.js';
 /**
  * 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`.
  */
-type DataForPath<_D extends ProtocolDefinition, M extends SchemaMap, Path extends string> = TypeNameAtPath<Path> extends keyof M ? M[TypeNameAtPath<Path>] : unknown;
+export type DataForPath<_D extends ProtocolDefinition, M extends SchemaMap, Path extends string> = TypeNameAtPath<Path> extends keyof M ? M[TypeNameAtPath<Path>] : unknown;
 /**
  * Resolves the `ProtocolType` entry for a given protocol path.
  */
@@ -50,8 +60,8 @@ 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 {@link TypedWeb5} `records.write()`. */
-export type TypedWriteRequest<D extends ProtocolDefinition, M extends SchemaMap, Path extends string> = {
+/** Options for {@link TypedWeb5} `records.create()`. */
+export type TypedCreateRequest<D extends ProtocolDefinition, M extends SchemaMap, Path extends string> = {
     /** The data payload. Type-checked against the schema map. */
     data: DataForPath<D, M, Path>;
     parentContextId?: string;
@@ -66,9 +76,9 @@ export type TypedWriteRequest<D extends ProtocolDefinition, M extends SchemaMap,
     /** Whether to auto-encrypt (follows protocol definition if omitted). */
     encryption?: boolean;
 };
-/** Response from {@link TypedWeb5} `records.write()`. */
-export type TypedWriteResponse = DwnResponseStatus & {
-    record: Record;
+/** Response from {@link TypedWeb5} `records.create()`. */
+export type TypedCreateResponse<T = unknown> = DwnResponseStatus & {
+    record: TypedRecord<T>;
 };
 /** Filter options for {@link TypedWeb5} `records.query()`. */
 export type TypedQueryFilter = Omit<RecordsFilter, 'protocol' | 'protocolPath' | 'schema'> & {
@@ -90,8 +100,8 @@ export type TypedQueryRequest = {
     encryption?: boolean;
 };
 /** Response from {@link TypedWeb5} `records.query()`. */
-export type TypedQueryResponse = DwnResponseStatus & {
-    records: Record[];
+export type TypedQueryResponse<T = unknown> = DwnResponseStatus & {
+    records: TypedRecord<T>[];
     cursor?: DwnPaginationCursor;
 };
 /** Options for {@link TypedWeb5} `records.read()`. */
@@ -104,8 +114,8 @@ export type TypedReadRequest = {
     encryption?: boolean;
 };
 /** Response from {@link TypedWeb5} `records.read()`. */
-export type TypedReadResponse = DwnResponseStatus & {
-    record: Record;
+export type TypedReadResponse<T = unknown> = DwnResponseStatus & {
+    record: TypedRecord<T>;
 };
 /** Options for {@link TypedWeb5} `records.delete()`. */
 export type TypedDeleteRequest = {
@@ -123,14 +133,18 @@ export type TypedSubscribeRequest = {
     protocolRole?: string;
 };
 /** Response from {@link TypedWeb5} `records.subscribe()`. */
-export type TypedSubscribeResponse = DwnResponseStatus & {
-    /** The live query instance, or `undefined` if the request failed. */
-    liveQuery?: LiveQuery;
+export type TypedSubscribeResponse<T = unknown> = DwnResponseStatus & {
+    /** The typed live query instance, or `undefined` if the request failed. */
+    liveQuery?: TypedLiveQuery<T>;
 };
 /**
  * A protocol-scoped API that auto-injects `protocol`, `protocolPath`, and
  * `schema` into every DWN operation.
  *
+ * All record-returning methods wrap results in {@link TypedRecord} so that
+ * the data type `T` (resolved from the schema map) flows end-to-end — from
+ * write through read, query, update, and subscribe — without manual casts.
+ *
  * Obtain an instance via `web5.using(typedProtocol)`.
  *
  * @example
@@ -139,18 +153,25 @@ export type TypedSubscribeResponse = DwnResponseStatus & {
  *
  * await social.configure();
  *
- * const { record } = await social.records.write('friend', {
+ * const { record } = await social.records.create('friend', {
  *   data: { did: 'did:example:alice', alias: 'Alice' },
  * });
+ * const data = await record.data.json(); // FriendData — no cast
  *
  * const { records } = await social.records.query('friend', {
  *   filter: { tags: { did: 'did:example:alice' } },
  * });
+ * for (const r of records) {
+ *   const d = await r.data.json(); // FriendData
+ * }
  * ```
  */
 export declare class TypedWeb5<D extends ProtocolDefinition = ProtocolDefinition, M extends SchemaMap = SchemaMap> {
     private _dwn;
     private _definition;
+    private _configured;
+    private _validPaths;
+    private _records?;
     constructor(dwn: DwnApi, protocol: TypedProtocol<D, M>);
     /** The protocol URI. */
     get protocol(): string;
@@ -171,19 +192,29 @@ export declare class TypedWeb5<D extends ProtocolDefinition = ProtocolDefinition
     }): Promise<DwnResponseStatus & {
         protocol?: Protocol;
     }>;
+    /** Whether the protocol has been configured (installed) on the local DWN. */
+    get isConfigured(): boolean;
+    /**
+     * Validates that the protocol has been configured and that the path is
+     * recognized. Throws a descriptive error if either check fails.
+     */
+    private _assertReady;
     /**
      * Protocol-scoped record operations.
      *
      * Every method auto-injects the protocol URI, protocolPath, and schema
      * from the protocol definition. Path parameters provide compile-time
      * autocompletion via `ProtocolPaths<D>`.
+     *
+     * All methods return {@link TypedRecord} or {@link TypedLiveQuery} instances
+     * that carry the resolved data type from the schema map.
      */
     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>;
+        create: <Path extends ProtocolPaths<D> & string>(path: Path, request: TypedCreateRequest<D, M, Path>) => Promise<TypedCreateResponse<DataForPath<D, M, Path>>>;
+        query: <Path extends ProtocolPaths<D> & string>(path: Path, request?: TypedQueryRequest) => Promise<TypedQueryResponse<DataForPath<D, M, Path>>>;
+        read: <Path extends ProtocolPaths<D> & string>(path: Path, request: TypedReadRequest) => Promise<TypedReadResponse<DataForPath<D, M, Path>>>;
         delete: <Path extends ProtocolPaths<D> & string>(path: Path, request: TypedDeleteRequest) => Promise<DwnResponseStatus>;
-        subscribe: <Path extends ProtocolPaths<D> & string>(path: Path, request?: TypedSubscribeRequest) => Promise<TypedSubscribeResponse>;
+        subscribe: <Path extends ProtocolPaths<D> & string>(path: Path, request?: TypedSubscribeRequest) => Promise<TypedSubscribeResponse<DataForPath<D, M, Path>>>;
     };
 }
 export {};

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

@@ -1 +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"}
+{"version":3,"file":"typed-web5.d.ts","sourceRoot":"","sources":["../../src/typed-web5.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AAEH,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AAC3C,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAE9C,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;AAEnG,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AACvD,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAMhD;;;;;GAKG;AACH,MAAM,MAAM,WAAW,CACrB,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,wDAAwD;AACxD,MAAM,MAAM,kBAAkB,CAC5B,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,0DAA0D;AAC1D,MAAM,MAAM,mBAAmB,CAAC,CAAC,GAAG,OAAO,IAAI,iBAAiB,GAAG;IACjE,MAAM,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC;CACxB,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,CAAC,CAAC,GAAG,OAAO,IAAI,iBAAiB,GAAG;IAChE,OAAO,EAAE,WAAW,CAAC,CAAC,CAAC,EAAE,CAAC;IAC1B,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,CAAC,CAAC,GAAG,OAAO,IAAI,iBAAiB,GAAG;IAC/D,MAAM,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC;CACxB,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,CAAC,CAAC,GAAG,OAAO,IAAI,iBAAiB,GAAG;IACpE,2EAA2E;IAC3E,SAAS,CAAC,EAAE,cAAc,CAAC,CAAC,CAAC,CAAC;CAC/B,CAAC;AAMF;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;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;IACvB,OAAO,CAAC,WAAW,CAAkB;IACrC,OAAO,CAAC,WAAW,CAAc;IACjC,OAAO,CAAC,QAAQ,CAAC,CAA6B;gBAElC,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,aAAa,CAAC,CAAC,EAAE,CAAC,CAAC;IAMtD,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;IA4BhH,6EAA6E;IAC7E,IAAW,YAAY,IAAI,OAAO,CAEjC;IAED;;;OAGG;IACH,OAAO,CAAC,YAAY;IAgBpB;;;;;;;;;OASG;IACH,IAAW,OAAO,IAAI;QACpB,MAAM,EAAE,CAAC,IAAI,SAAS,aAAa,CAAC,CAAC,CAAC,GAAG,MAAM,EAC7C,IAAI,EAAE,IAAI,EACV,OAAO,EAAE,kBAAkB,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,KACpC,OAAO,CAAC,mBAAmB,CAAC,WAAW,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;QAE3D,KAAK,EAAE,CAAC,IAAI,SAAS,aAAa,CAAC,CAAC,CAAC,GAAG,MAAM,EAC5C,IAAI,EAAE,IAAI,EACV,OAAO,CAAC,EAAE,iBAAiB,KACxB,OAAO,CAAC,kBAAkB,CAAC,WAAW,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;QAE1D,IAAI,EAAE,CAAC,IAAI,SAAS,aAAa,CAAC,CAAC,CAAC,GAAG,MAAM,EAC3C,IAAI,EAAE,IAAI,EACV,OAAO,EAAE,gBAAgB,KACtB,OAAO,CAAC,iBAAiB,CAAC,WAAW,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;QAEzD,MAAM,EAAE,CAAC,IAAI,SAAS,aAAa,CAAC,CAAC,CAAC,GAAG,MAAM,EAC7C,IAAI,EAAE,IAAI,EACV,OAAO,EAAE,kBAAkB,KACxB,OAAO,CAAC,iBAAiB,CAAC,CAAC;QAEhC,SAAS,EAAE,CAAC,IAAI,SAAS,aAAa,CAAC,CAAC,CAAC,GAAG,MAAM,EAChD,IAAI,EAAE,IAAI,EACV,OAAO,CAAC,EAAE,qBAAqB,KAC5B,OAAO,CAAC,sBAAsB,CAAC,WAAW,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;KAC7D,CAyKF;CACF"}

package/dist/types/web5.d.ts

@@ -67,6 +67,35 @@ export type Web5AnonymousApi = {
     /** A read-only DWN API for querying public data on remote DWNs. */
     dwn: DwnReaderApi;
 };
+/** Parameters passed to the onProviderAuthRequired callback. */
+export type ProviderAuthParams = {
+    /** Full authorize URL to open in a browser (query params already appended). */
+    authorizeUrl: string;
+    /** The DWN endpoint URL this auth is for (informational). */
+    dwnEndpoint: string;
+    /** CSRF nonce — the provider will return this unchanged in the redirect. */
+    state: string;
+};
+/** Result returned by the app after the user completes provider auth. */
+export type ProviderAuthResult = {
+    /** Authorization code from the provider's redirect. */
+    code: string;
+    /** Must match the state from ProviderAuthParams (CSRF validation). */
+    state: string;
+};
+/** Persisted registration token data for a DWN endpoint. */
+export type RegistrationTokenData = {
+    /** Opaque registration token for POST /registration. */
+    registrationToken: string;
+    /** Refresh token for obtaining new registration tokens. */
+    refreshToken?: string;
+    /** Unix timestamp (ms) when the token expires. Undefined = never expires. */
+    expiresAt?: number;
+    /** Provider's token exchange URL (needed for code exchange). */
+    tokenUrl: string;
+    /** Provider's refresh URL (needed for token refresh). */
+    refreshUrl?: string;
+};
 /** Optional overrides that can be provided when calling {@link Web5.connect}. */
 export type Web5ConnectOptions = {
     /**
@@ -152,10 +181,26 @@ export type Web5ConnectOptions = {
      * If registration is successful, the `onSuccess` callback will be called.
      */
     registration?: {
-        /** Called when all of the DWN registrations are successful */
+        /** Called when all of the DWN registrations are successful. */
         onSuccess: () => void;
-        /** Called when any of the DWN registrations fail */
+        /** Called when any of the DWN registrations fail. */
         onFailure: (error: any) => void;
+        /**
+         * Called when a DWN endpoint requires provider auth (`'provider-auth-v0'`).
+         * The app is responsible for opening the authorizeUrl in a browser,
+         * capturing the redirect back, and returning the auth code.
+         * If not provided, provider-auth endpoints fall back to PoW registration.
+         */
+        onProviderAuthRequired?: (params: ProviderAuthParams) => Promise<ProviderAuthResult>;
+        /**
+         * Pre-existing registration tokens from a previous session, keyed by DWN endpoint URL.
+         * If a valid (non-expired) token exists for an endpoint, it is used directly.
+         */
+        registrationTokens?: Record<string, RegistrationTokenData>;
+        /**
+         * Called when new registration tokens are obtained so the app can persist them.
+         */
+        onRegistrationTokens?: (tokens: Record<string, RegistrationTokenData>) => void;
     };
 };
 /**

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

@@ -1 +1 @@
-{"version":3,"file":"web5.d.ts","sourceRoot":"","sources":["../../src/web5.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AACrD,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAC;AAC5D,OAAO,KAAK,EAEV,iCAAiC,EAEjC,qBAAqB,EAErB,eAAe,EACf,UAAU,EACV,oBAAoB,EACpB,SAAS,EACV,MAAM,cAAc,CAAC;AAEtB,OAAO,KAAK,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAMpE,OAAO,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AAEtC,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAEnD,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAC5C,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AAEpC,uEAAuE;AACvE,MAAM,MAAM,kBAAkB,GAAG;IAC/B,oEAAoE;IACpE,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;CACzB,CAAC;AAEF,0CAA0C;AAC1C,MAAM,MAAM,gBAAgB,GAAG;IAC7B,kEAAkE;IAClE,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;CACzB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC;;OAEG;IACH,kBAAkB,EAAE,qBAAqB,CAAC;IAE1C;;OAEG;IACH,WAAW,CAAC,EAAE,UAAU,EAAE,CAAC;CAC5B,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,cAAc,GAAG,IAAI,CAAC,oBAAoB,EAAE,oBAAoB,CAAC,GAAG;IAC9E,iHAAiH;IACjH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,kBAAkB,EAAE,wBAAwB,EAAE,CAAC;CAChD,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC,iGAAiG;IACjG,YAAY,CAAC,EAAE,iBAAiB,EAAE,CAAC;CACpC,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,mEAAmE;IACnE,GAAG,EAAE,YAAY,CAAC;CACnB,CAAC;AAEF,iFAAiF;AACjF,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;;;OAIG;IACH,oBAAoB,CAAC,EAAE,cAAc,CAAC;IAEtC;;;QAGI;IACJ,KAAK,CAAC,EAAE,SAAS,CAAC;IAElB;;;;;QAKI;IACJ,UAAU,CAAC,EAAE,eAAe,CAAC;IAE7B,6CAA6C;IAC7C,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;;;;;;;;;;;;;OAcG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,WAAW,CAAC,EAAE,kBAAkB,CAAC;IAEjC;;;OAGG;IACH,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;IAEpC;;;;;;OAMG;IACH,YAAY,CAAC,EAAG;QACd,8DAA8D;QAC9D,SAAS,EAAE,MAAM,IAAI,CAAC;QACtB,oDAAoD;QACpD,SAAS,EAAE,CAAC,KAAK,EAAE,GAAG,KAAK,IAAI,CAAC;KACjC,CAAA;CACF,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,+EAA+E;IAC/E,IAAI,EAAE,IAAI,CAAC;IAEX,gFAAgF;IAChF,GAAG,EAAE,MAAM,CAAC;IAEZ;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,UAAU,GAAG;IACvB;;;OAGG;IACH,KAAK,EAAE,SAAS,CAAC;IAEjB,2FAA2F;IAC3F,YAAY,EAAE,MAAM,CAAC;IAErB,oFAAoF;IACpF,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF;;;GAGG;AACH,qBAAa,IAAI;IACf;;;OAGG;IACH,KAAK,EAAE,SAAS,CAAC;IAEjB,gFAAgF;IAChF,GAAG,EAAE,MAAM,CAAC;IAEZ,oFAAoF;IACpF,OAAO,CAAC,IAAI,CAAS;IAErB,oFAAoF;IACpF,EAAE,EAAE,KAAK,CAAC;gBAEE,EAAE,KAAK,EAAE,YAAY,EAAE,WAAW,EAAE,EAAE,UAAU;IAO5D;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACI,KAAK,CAAC,CAAC,SAAS,kBAAkB,EAAE,CAAC,SAAS,SAAS,EAC5D,QAAQ,EAAE,aAAa,CAAC,CAAC,EAAE,CAAC,CAAC,GAC5B,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC;IAIlB;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,oBAAoB,GAAG,gBAAgB;IAclE;;;;;;;;;;OAUG;WACU,OAAO,CAAC,EACnB,KAAK,EACL,UAAU,EACV,YAAY,EACZ,QAAQ,EACR,cAAc,EACd,IAAI,EACJ,WAAW,EACX,gBAAgB,EAChB,YAAY,EACZ,oBAAoB,GACrB,GAAE,kBAAuB,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAsMvD;;;OAGG;mBACkB,eAAe;IAuBpC;;;;OAIG;WACU,sBAAsB,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,WAAW,EAAE,EAAE;QAClE,MAAM,EAAE,iCAAiC,EAAE,CAAC;QAC5C,KAAK,EAAE,SAAS,CAAC;QACjB,WAAW,EAAE,MAAM,CAAC;KACrB,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;CAqBtB"}
+{"version":3,"file":"web5.d.ts","sourceRoot":"","sources":["../../src/web5.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AACrD,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAC;AAC5D,OAAO,KAAK,EAEV,iCAAiC,EAEjC,qBAAqB,EAErB,eAAe,EACf,UAAU,EACV,oBAAoB,EACpB,SAAS,EACV,MAAM,cAAc,CAAC;AAEtB,OAAO,KAAK,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAMpE,OAAO,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AAEtC,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAEnD,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAC5C,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AAEpC,uEAAuE;AACvE,MAAM,MAAM,kBAAkB,GAAG;IAC/B,oEAAoE;IACpE,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;CACzB,CAAC;AAEF,0CAA0C;AAC1C,MAAM,MAAM,gBAAgB,GAAG;IAC7B,kEAAkE;IAClE,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;CACzB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC;;OAEG;IACH,kBAAkB,EAAE,qBAAqB,CAAC;IAE1C;;OAEG;IACH,WAAW,CAAC,EAAE,UAAU,EAAE,CAAC;CAC5B,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,cAAc,GAAG,IAAI,CAAC,oBAAoB,EAAE,oBAAoB,CAAC,GAAG;IAC9E,iHAAiH;IACjH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,kBAAkB,EAAE,wBAAwB,EAAE,CAAC;CAChD,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC,iGAAiG;IACjG,YAAY,CAAC,EAAE,iBAAiB,EAAE,CAAC;CACpC,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,mEAAmE;IACnE,GAAG,EAAE,YAAY,CAAC;CACnB,CAAC;AAEF,gEAAgE;AAChE,MAAM,MAAM,kBAAkB,GAAG;IAC/B,+EAA+E;IAC/E,YAAY,EAAE,MAAM,CAAC;IACrB,6DAA6D;IAC7D,WAAW,EAAE,MAAM,CAAC;IACpB,4EAA4E;IAC5E,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,yEAAyE;AACzE,MAAM,MAAM,kBAAkB,GAAG;IAC/B,uDAAuD;IACvD,IAAI,EAAE,MAAM,CAAC;IACb,sEAAsE;IACtE,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,4DAA4D;AAC5D,MAAM,MAAM,qBAAqB,GAAG;IAClC,wDAAwD;IACxD,iBAAiB,EAAE,MAAM,CAAC;IAC1B,2DAA2D;IAC3D,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,6EAA6E;IAC7E,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,gEAAgE;IAChE,QAAQ,EAAE,MAAM,CAAC;IACjB,yDAAyD;IACzD,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF,iFAAiF;AACjF,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;;;OAIG;IACH,oBAAoB,CAAC,EAAE,cAAc,CAAC;IAEtC;;;QAGI;IACJ,KAAK,CAAC,EAAE,SAAS,CAAC;IAElB;;;;;QAKI;IACJ,UAAU,CAAC,EAAE,eAAe,CAAC;IAE7B,6CAA6C;IAC7C,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;;;;;;;;;;;;;OAcG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,WAAW,CAAC,EAAE,kBAAkB,CAAC;IAEjC;;;OAGG;IACH,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;IAEpC;;;;;;OAMG;IACH,YAAY,CAAC,EAAG;QACd,+DAA+D;QAC/D,SAAS,EAAG,MAAM,IAAI,CAAC;QACvB,qDAAqD;QACrD,SAAS,EAAG,CAAC,KAAK,EAAE,GAAG,KAAK,IAAI,CAAC;QAEjC;;;;;WAKG;QACH,sBAAsB,CAAC,EAAG,CAAC,MAAM,EAAE,kBAAkB,KAAK,OAAO,CAAC,kBAAkB,CAAC,CAAC;QAEtF;;;WAGG;QACH,kBAAkB,CAAC,EAAG,MAAM,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAC;QAE5D;;WAEG;QACH,oBAAoB,CAAC,EAAG,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,qBAAqB,CAAC,KAAK,IAAI,CAAC;KACjF,CAAA;CACF,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,+EAA+E;IAC/E,IAAI,EAAE,IAAI,CAAC;IAEX,gFAAgF;IAChF,GAAG,EAAE,MAAM,CAAC;IAEZ;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,UAAU,GAAG;IACvB;;;OAGG;IACH,KAAK,EAAE,SAAS,CAAC;IAEjB,2FAA2F;IAC3F,YAAY,EAAE,MAAM,CAAC;IAErB,oFAAoF;IACpF,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF;;;GAGG;AACH,qBAAa,IAAI;IACf;;;OAGG;IACH,KAAK,EAAE,SAAS,CAAC;IAEjB,gFAAgF;IAChF,GAAG,EAAE,MAAM,CAAC;IAEZ,oFAAoF;IACpF,OAAO,CAAC,IAAI,CAAS;IAErB,oFAAoF;IACpF,EAAE,EAAE,KAAK,CAAC;gBAEE,EAAE,KAAK,EAAE,YAAY,EAAE,WAAW,EAAE,EAAE,UAAU;IAO5D;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACI,KAAK,CAAC,CAAC,SAAS,kBAAkB,EAAE,CAAC,SAAS,SAAS,EAC5D,QAAQ,EAAE,aAAa,CAAC,CAAC,EAAE,CAAC,CAAC,GAC5B,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC;IAIlB;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,oBAAoB,GAAG,gBAAgB;IAclE;;;;;;;;;;OAUG;WACU,OAAO,CAAC,EACnB,KAAK,EACL,UAAU,EACV,YAAY,EACZ,QAAQ,EACR,cAAc,EACd,IAAI,EACJ,WAAW,EACX,gBAAgB,EAChB,YAAY,EACZ,oBAAoB,GACrB,GAAE,kBAAuB,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAkRvD;;;OAGG;mBACkB,eAAe;IAuBpC;;;;OAIG;WACU,sBAAsB,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,WAAW,EAAE,EAAE;QAClE,MAAM,EAAE,iCAAiC,EAAE,CAAC;QAC5C,KAAK,EAAE,SAAS,CAAC;QACjB,WAAW,EAAE,MAAM,CAAC;KACrB,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;CAqBtB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@enbox/api",
-  "version": "0.2.3",
+  "version": "0.2.4",
   "description": "SDK for accessing the features and capabilities of Web5",
   "type": "module",
   "main": "./dist/esm/index.js",
@@ -81,14 +81,15 @@
     "bun": ">=1.0.0"
   },
   "dependencies": {
-    "@enbox/agent": "0.1.8",
-    "@enbox/common": "0.0.3",
-    "@enbox/dwn-clients": "0.0.5"
+    "@enbox/agent": "0.1.9",
+    "@enbox/common": "0.0.4",
+    "@enbox/dwn-clients": "0.0.6"
   },
   "devDependencies": {
-    "@enbox/crypto": "0.0.4",
-    "@enbox/dids": "0.0.5",
-    "@enbox/dwn-sdk-js": "0.0.7",
+    "@enbox/crypto": "0.0.5",
+    "@enbox/dids": "0.0.6",
+    "@enbox/dwn-sdk-js": "0.0.8",
+    "@enbox/protocols": "0.2.6",
     "@types/node": "20.14.8",
     "@types/sinon": "17.0.3",
     "@typescript-eslint/eslint-plugin": "8.32.1",

package/src/dwn-api.ts

@@ -17,6 +17,8 @@ import type {
   ProcessDwnRequest,
   Web5Agent } from '@enbox/agent';
 
+import type { DwnSubscriptionMessage } from '@enbox/dwn-clients';
+
 import {
   AgentPermissionsApi,
 } from '@enbox/agent';
@@ -285,7 +287,7 @@ export class DwnApi {
           message,
         };
 
-        return await PermissionRequest.parse(requestParams);
+        return PermissionRequest.parse(requestParams);
       },
       /**
        * Grant permission for a specific scope to a grantee DID.
@@ -302,7 +304,7 @@ export class DwnApi {
           message,
         };
 
-        return await PermissionGrant.parse(grantParams);
+        return PermissionGrant.parse(grantParams);
       },
       /**
        * Query permission requests. You can filter by protocol and specify if you want to query a remote DWN.
@@ -323,7 +325,7 @@ export class DwnApi {
             agent        : this.agent,
             message      : permission.message,
           };
-          requests.push(await PermissionRequest.parse(requestParams));
+          requests.push(PermissionRequest.parse(requestParams));
         }
 
         return requests;
@@ -351,7 +353,7 @@ export class DwnApi {
             message      : permission.message,
           };
 
-          grants.push(await PermissionGrant.parse(grantParams));
+          grants.push(PermissionGrant.parse(grantParams));
         }
 
         return grants;
@@ -736,19 +738,34 @@ export class DwnApi {
         const remoteOrigin = from;
         const protocolRole = messageParams.protocolRole;
 
-        type RecordEvent = {
-          message: DwnMessage[DwnInterface.RecordsWrite];
-          initialWrite?: DwnMessage[DwnInterface.RecordsWrite];
-        };
+        const subscriptionHandler = (msg: DwnSubscriptionMessage): void => {
+          if (msg.type === 'eose') {
+            liveQuery?.handleLifecycleEvent('eose');
+            return;
+          }
+
+          if (msg.type === 'disconnected') {
+            liveQuery?.handleLifecycleEvent('disconnected');
+            return;
+          }
+
+          if (msg.type === 'reconnected') {
+            liveQuery?.handleLifecycleEvent('reconnected');
+            return;
+          }
+
+          if (msg.type === 'reconnecting') {
+            liveQuery?.handleLifecycleEvent('reconnecting', { attempt: msg.attempt });
+            return;
+          }
 
-        const subscriptionHandler = async (event: RecordEvent): Promise<void> => {
-          const { message, initialWrite } = event;
+          const { message, initialWrite } = msg.event;
           const record = new Record(this.agent, {
-            ...message,
-            author       : getRecordAuthor(message),
+            ...message as DwnMessage[DwnInterface.RecordsWrite],
+            author       : getRecordAuthor(message as DwnMessage[DwnInterface.RecordsWrite]),
             connectedDid : this.connectedDid,
             remoteOrigin,
-            initialWrite,
+            initialWrite : initialWrite as DwnMessage[DwnInterface.RecordsWrite] | undefined,
             protocolRole,
             delegateDid  : this.delegateDid,
           }, this.permissionsApi);

package/src/index.ts

@@ -32,6 +32,12 @@ export * from './protocol.js';
 export * from './protocol-types.js';
 export * from './read-only-record.js';
 export * from './record.js';
+export * from './record-data.js';
+export * from './record-types.js';
+export * from './repository.js';
+export * from './repository-types.js';
+export * from './typed-live-query.js';
+export * from './typed-record.js';
 export * from './typed-web5.js';
 export * from './vc-api.js';
 export * from './web5.js';