@enbox/api 0.0.8 → 0.1.1

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

@@ -0,0 +1,95 @@
+/**
+ * Type-level utilities for extracting typed paths, type names, schemas,
+ * data formats, and tag shapes from a {@link ProtocolDefinition}.
+ *
+ * These types are purely compile-time — they produce no runtime code.
+ */
+import type { ProtocolDefinition, ProtocolRuleSet, ProtocolTagsDefinition, ProtocolType } from '@enbox/dwn-sdk-js';
+/**
+ * Recursively extracts all valid protocol path strings from a `ProtocolRuleSet`.
+ *
+ * Given a structure like `{ foo: { bar: { ... } } }`, this produces
+ * `'foo' | 'foo/bar'`.  Directive keys (starting with `$`) are excluded.
+ */
+export type RuleSetPaths<R, Prefix extends string = ''> = {
+    [K in Extract<keyof R, string>]: K extends `$${string}` ? never : R[K] extends ProtocolRuleSet ? `${Prefix}${K}` | RuleSetPaths<R[K], `${Prefix}${K}/`> : never;
+}[Extract<keyof R, string>];
+/**
+ * All valid protocol path strings for a given `ProtocolDefinition`.
+ *
+ * @example
+ * ```ts
+ * type Paths = ProtocolPaths<typeof myDef>;
+ * // 'friend' | 'friend/message' | 'group' | 'group/member'
+ * ```
+ */
+export type ProtocolPaths<D extends ProtocolDefinition> = RuleSetPaths<D['structure']>;
+/**
+ * Extracts the last segment (type name) from a protocol path string.
+ *
+ * @example
+ * ```ts
+ * type T = TypeNameAtPath<'group/member'>; // 'member'
+ * ```
+ */
+export type TypeNameAtPath<Path extends string> = Path extends `${string}/${infer Rest}` ? TypeNameAtPath<Rest> : Path;
+/**
+ * The type names declared in the `types` map of a `ProtocolDefinition`.
+ */
+export type TypeNames<D extends ProtocolDefinition> = Extract<keyof D['types'], string>;
+/**
+ * Looks up the `schema` URI for a given type name in the protocol definition.
+ * Returns `undefined` if the type does not declare a schema.
+ */
+export type SchemaForType<D extends ProtocolDefinition, TypeName extends string> = TypeName extends keyof D['types'] ? D['types'][TypeName] extends ProtocolType ? D['types'][TypeName]['schema'] : undefined : undefined;
+/**
+ * Looks up the `dataFormats` array for a given type name in the protocol definition.
+ * Returns `undefined` if the type does not declare dataFormats.
+ */
+export type DataFormatsForType<D extends ProtocolDefinition, TypeName extends string> = TypeName extends keyof D['types'] ? D['types'][TypeName] extends ProtocolType ? D['types'][TypeName]['dataFormats'] : undefined : undefined;
+/**
+ * Navigates a `ProtocolRuleSet` tree to the node at the given slash-delimited path.
+ */
+type RuleSetAtPath<R, Path extends string> = Path extends `${infer Head}/${infer Tail}` ? Head extends keyof R ? R[Head] extends ProtocolRuleSet ? RuleSetAtPath<R[Head], Tail> : never : never : Path extends keyof R ? R[Path] extends ProtocolRuleSet ? R[Path] : never : never;
+/**
+ * Extracts the `$tags` definition for a given protocol path.
+ * Returns `never` if the path does not declare `$tags`.
+ */
+export type TagsAtPath<D extends ProtocolDefinition, Path extends string> = RuleSetAtPath<D['structure'], Path> extends infer RS ? RS extends ProtocolRuleSet ? RS['$tags'] extends ProtocolTagsDefinition ? RS['$tags'] : never : never : never;
+/**
+ * Extracts the user-defined tag keys (excluding `$`-prefixed meta-keys)
+ * from a `ProtocolTagsDefinition`.
+ */
+export type TagKeys<Tags extends ProtocolTagsDefinition> = Exclude<Extract<keyof Tags, string>, `$${string}`>;
+/**
+ * A mapping from protocol type names to their TypeScript data shapes.
+ *
+ * Used as a type parameter to `defineProtocol()` and `TypedDwnApi` so that
+ * the protocol definition JSON stays JSON-compatible while TypeScript types
+ * are tracked separately.
+ *
+ * @example
+ * ```ts
+ * type MySchemaMap = {
+ *   profile : { displayName: string; bio?: string };
+ *   avatar  : Blob;
+ * };
+ * ```
+ */
+export type SchemaMap = Record<string, unknown>;
+/**
+ * The return type of `defineProtocol()`. Bundles the raw protocol definition
+ * with its inferred path strings and schema type map for downstream use
+ * by `TypedDwnApi`.
+ */
+export type TypedProtocol<D extends ProtocolDefinition = ProtocolDefinition, M extends SchemaMap = SchemaMap> = {
+    /** The raw DWN protocol definition (JSON-compatible). */
+    readonly definition: D;
+    /**
+     * Phantom property carrying the schema map type. Not present at runtime;
+     * used only by TypeScript to thread the generic through.
+     */
+    readonly _schemaMap?: M;
+};
+export {};
+//# sourceMappingURL=protocol-types.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"protocol-types.d.ts","sourceRoot":"","sources":["../../src/protocol-types.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,kBAAkB,EAAE,eAAe,EAAE,sBAAsB,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAMnH;;;;;GAKG;AACH,MAAM,MAAM,YAAY,CAAC,CAAC,EAAE,MAAM,SAAS,MAAM,GAAG,EAAE,IAAI;KACvD,CAAC,IAAI,OAAO,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,GAAG,CAAC,SAAS,IAAI,MAAM,EAAE,GACnD,KAAK,GACL,CAAC,CAAC,CAAC,CAAC,SAAS,eAAe,GAC1B,GAAG,MAAM,GAAG,CAAC,EAAE,GAAG,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,GAAG,MAAM,GAAG,CAAC,GAAG,CAAC,GACtD,KAAK;CACZ,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC;AAE5B;;;;;;;;GAQG;AACH,MAAM,MAAM,aAAa,CAAC,CAAC,SAAS,kBAAkB,IAAI,YAAY,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC;AAMvF;;;;;;;GAOG;AACH,MAAM,MAAM,cAAc,CAAC,IAAI,SAAS,MAAM,IAC5C,IAAI,SAAS,GAAG,MAAM,IAAI,MAAM,IAAI,EAAE,GAClC,cAAc,CAAC,IAAI,CAAC,GACpB,IAAI,CAAC;AAMX;;GAEG;AACH,MAAM,MAAM,SAAS,CAAC,CAAC,SAAS,kBAAkB,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC,CAAC;AAExF;;;GAGG;AACH,MAAM,MAAM,aAAa,CAAC,CAAC,SAAS,kBAAkB,EAAE,QAAQ,SAAS,MAAM,IAC7E,QAAQ,SAAS,MAAM,CAAC,CAAC,OAAO,CAAC,GAC7B,CAAC,CAAC,OAAO,CAAC,CAAC,QAAQ,CAAC,SAAS,YAAY,GACvC,CAAC,CAAC,OAAO,CAAC,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,GAC9B,SAAS,GACX,SAAS,CAAC;AAEhB;;;GAGG;AACH,MAAM,MAAM,kBAAkB,CAAC,CAAC,SAAS,kBAAkB,EAAE,QAAQ,SAAS,MAAM,IAClF,QAAQ,SAAS,MAAM,CAAC,CAAC,OAAO,CAAC,GAC7B,CAAC,CAAC,OAAO,CAAC,CAAC,QAAQ,CAAC,SAAS,YAAY,GACvC,CAAC,CAAC,OAAO,CAAC,CAAC,QAAQ,CAAC,CAAC,aAAa,CAAC,GACnC,SAAS,GACX,SAAS,CAAC;AAMhB;;GAEG;AACH,KAAK,aAAa,CAAC,CAAC,EAAE,IAAI,SAAS,MAAM,IACvC,IAAI,SAAS,GAAG,MAAM,IAAI,IAAI,MAAM,IAAI,EAAE,GACtC,IAAI,SAAS,MAAM,CAAC,GAClB,CAAC,CAAC,IAAI,CAAC,SAAS,eAAe,GAC7B,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,GAC5B,KAAK,GACP,KAAK,GACP,IAAI,SAAS,MAAM,CAAC,GAClB,CAAC,CAAC,IAAI,CAAC,SAAS,eAAe,GAC7B,CAAC,CAAC,IAAI,CAAC,GACP,KAAK,GACP,KAAK,CAAC;AAEd;;;GAGG;AACH,MAAM,MAAM,UAAU,CAAC,CAAC,SAAS,kBAAkB,EAAE,IAAI,SAAS,MAAM,IACtE,aAAa,CAAC,CAAC,CAAC,WAAW,CAAC,EAAE,IAAI,CAAC,SAAS,MAAM,EAAE,GAChD,EAAE,SAAS,eAAe,GACxB,EAAE,CAAC,OAAO,CAAC,SAAS,sBAAsB,GACxC,EAAE,CAAC,OAAO,CAAC,GACX,KAAK,GACP,KAAK,GACP,KAAK,CAAC;AAEZ;;;GAGG;AACH,MAAM,MAAM,OAAO,CAAC,IAAI,SAAS,sBAAsB,IAAI,OAAO,CAChE,OAAO,CAAC,MAAM,IAAI,EAAE,MAAM,CAAC,EAC3B,IAAI,MAAM,EAAE,CACb,CAAC;AAMF;;;;;;;;;;;;;;GAcG;AACH,MAAM,MAAM,SAAS,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAMhD;;;;GAIG;AACH,MAAM,MAAM,aAAa,CACvB,CAAC,SAAS,kBAAkB,GAAG,kBAAkB,EACjD,CAAC,SAAS,SAAS,GAAG,SAAS,IAC7B;IACF,yDAAyD;IACzD,QAAQ,CAAC,UAAU,EAAE,CAAC,CAAC;IAEvB;;;OAGG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;CACzB,CAAC"}

package/dist/types/record.d.ts

@@ -265,7 +265,7 @@ export declare class Record implements RecordModel {
     get data(): {
         blob: () => Promise<Blob>;
         bytes: () => Promise<Uint8Array>;
-        json: () => Promise<any>;
+        json: <T = unknown>() => Promise<T>;
         text: () => Promise<string>;
         stream: () => Promise<ReadableStream>;
         then: (onFulfilled?: (value: ReadableStream) => ReadableStream | PromiseLike<ReadableStream>, onRejected?: (reason: any) => PromiseLike<never>) => Promise<ReadableStream>;

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

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

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

@@ -0,0 +1,193 @@
+/**
+ * A type-safe wrapper around {@link DwnApi} scoped to a single protocol.
+ *
+ * `TypedDwnApi` is created via `dwn.using(typedProtocol)` and provides
+ * autocompletion for protocol paths, typed data payloads, and tag shapes.
+ *
+ * Every method delegates to the corresponding `dwn.records.*` method,
+ * injecting the protocol URI, protocolPath, and schema automatically.
+ */
+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';
+/**
+ * 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;
+/**
+ * Resolves the `ProtocolType` entry for a given protocol path.
+ */
+type ProtocolTypeForPath<D extends ProtocolDefinition, Path extends string> = TypeNameAtPath<Path> extends keyof D['types'] ? D['types'][TypeNameAtPath<Path>] extends ProtocolType ? D['types'][TypeNameAtPath<Path>] : undefined : undefined;
+/**
+ * Resolves a `dataFormat` string literal union for a path, or `string` if none.
+ */
+type DataFormatForPath<D extends ProtocolDefinition, Path extends string> = ProtocolTypeForPath<D, Path> extends {
+    dataFormats: infer F;
+} ? F extends readonly string[] ? F[number] : string : string;
+/** Options for `TypedDwnApi.write()`. */
+export type TypedWriteRequest<D extends ProtocolDefinition, M extends SchemaMap, Path extends string> = {
+    /** The data payload. Type-checked against the schema map. */
+    data: DataForPath<D, M, Path>;
+    /** Additional message parameters (protocolPath and protocol are injected). */
+    message?: {
+        parentContextId?: string;
+        published?: boolean;
+        datePublished?: string;
+        recipient?: string;
+        protocolRole?: string;
+        dataFormat?: DataFormatForPath<D, Path>;
+        tags?: globalThis.Record<string, string | number | boolean | string[] | number[]>;
+    };
+    /** Whether to persist immediately (defaults to `true`). */
+    store?: boolean;
+    /** Whether to auto-encrypt (follows protocol definition if omitted). */
+    encryption?: boolean;
+};
+/** Response from `TypedDwnApi.write()`. */
+export type TypedWriteResponse = DwnResponseStatus & {
+    record?: Record;
+};
+/** Filter options for `TypedDwnApi.query()`. */
+export type TypedQueryFilter = Omit<RecordsFilter, 'protocol' | 'protocolPath' | 'schema'> & {
+    tags?: globalThis.Record<string, string | number | boolean | (string | number)[]>;
+};
+/** Options for `TypedDwnApi.query()`. */
+export type TypedQueryRequest = {
+    /** Optional remote DWN DID to query from. */
+    from?: string;
+    /** Query filter (protocol, protocolPath, schema are injected). */
+    filter?: TypedQueryFilter;
+    dateSort?: DateSort;
+    pagination?: {
+        limit?: number;
+        cursor?: DwnPaginationCursor;
+    };
+    protocolRole?: string;
+    /** When true, automatically decrypts encrypted records. */
+    encryption?: boolean;
+};
+/** Response from `TypedDwnApi.query()`. */
+export type TypedQueryResponse = DwnResponseStatus & {
+    records?: Record[];
+    cursor?: DwnPaginationCursor;
+};
+/** Options for `TypedDwnApi.read()`. */
+export type TypedReadRequest = {
+    /** Optional remote DWN DID to read from. */
+    from?: string;
+    /** Filter to identify the record (protocol and protocolPath are injected). */
+    filter: Omit<RecordsFilter, 'protocol' | 'protocolPath' | 'schema'>;
+    /** When true, automatically decrypts the record. */
+    encryption?: boolean;
+};
+/** Response from `TypedDwnApi.read()`. */
+export type TypedReadResponse = DwnResponseStatus & {
+    record: Record;
+};
+/** Options for `TypedDwnApi.delete()`. */
+export type TypedDeleteRequest = {
+    /** Optional remote DWN DID to delete from. */
+    from?: string;
+    /** The `recordId` of the record to delete. */
+    recordId: string;
+};
+/** Options for `TypedDwnApi.subscribe()`. */
+export type TypedSubscribeRequest = {
+    /** Optional remote DWN DID to subscribe to. */
+    from?: string;
+    /** Subscription filter (protocol, protocolPath, schema are injected). */
+    filter?: TypedQueryFilter;
+    protocolRole?: string;
+};
+/** Response from `TypedDwnApi.subscribe()`. */
+export type TypedSubscribeResponse = DwnResponseStatus & {
+    /** The live query instance, or `undefined` if the request failed. */
+    liveQuery?: LiveQuery;
+};
+/**
+ * A protocol-scoped wrapper around `DwnApi` that automatically injects
+ * the `protocol` URI, `protocolPath`, and `schema` into every DWN operation.
+ *
+ * Obtain an instance via `dwn.using(typedProtocol)`.
+ *
+ * @example
+ * ```ts
+ * const social = dwn.using(SocialGraphProtocol);
+ *
+ * // Write — path and data type are checked at compile time
+ * const { record } = await social.write('friend', {
+ *   data: { did: 'did:example:alice', alias: 'Alice' },
+ * });
+ *
+ * // Query — protocol and protocolPath are auto-injected
+ * const { records } = await social.query('friend', {
+ *   filter: { tags: { did: 'did:example:alice' } },
+ * });
+ * ```
+ */
+export declare class TypedDwnApi<D extends ProtocolDefinition = ProtocolDefinition, M extends SchemaMap = SchemaMap> {
+    private _dwn;
+    private _definition;
+    constructor(dwn: DwnApi, protocol: TypedProtocol<D, M>);
+    /** The protocol URI. */
+    get protocol(): string;
+    /** The raw protocol definition. */
+    get definition(): D;
+    /**
+     * Configures (installs) this protocol on the local DWN.
+     *
+     * @param options - Optional overrides like `encryption`.
+     */
+    configure(options?: {
+        encryption?: boolean;
+    }): Promise<DwnResponseStatus & {
+        protocol?: Protocol;
+    }>;
+    /**
+     * Write a record at the given protocol path.
+     *
+     * @param path - The protocol path (e.g. `'friend'`, `'group/member'`).
+     * @param request - Write options including typed `data`.
+     */
+    write<Path extends ProtocolPaths<D> & string>(path: Path, request: TypedWriteRequest<D, M, Path>): Promise<TypedWriteResponse>;
+    /**
+     * Query records at the given protocol path.
+     *
+     * @param path - The protocol path to query.
+     * @param request - Query options including optional filter, sort, and pagination.
+     */
+    query<Path extends ProtocolPaths<D> & string>(path: Path, request?: TypedQueryRequest): Promise<TypedQueryResponse>;
+    /**
+     * Read a single record at the given protocol path.
+     *
+     * @param path - The protocol path to read from.
+     * @param request - Read options including a filter to identify the record.
+     */
+    read<Path extends ProtocolPaths<D> & string>(path: Path, request: TypedReadRequest): Promise<TypedReadResponse>;
+    /**
+     * Delete a record at the given protocol path.
+     *
+     * @param path - The protocol path (used for permission scoping).
+     * @param request - Delete options including the `recordId`.
+     */
+    delete<Path extends ProtocolPaths<D> & string>(_path: Path, request: TypedDeleteRequest): Promise<DwnResponseStatus>;
+    /**
+     * Subscribe to records at the given protocol path.
+     *
+     * Returns a {@link LiveQuery} that atomically provides an initial snapshot
+     * and a real-time stream of deduplicated change events.
+     *
+     * @param path - The protocol path to subscribe to.
+     * @param request - Subscribe options including optional filter and role.
+     */
+    subscribe<Path extends ProtocolPaths<D> & string>(path: Path, request?: TypedSubscribeRequest): Promise<TypedSubscribeResponse>;
+}
+export {};
+//# sourceMappingURL=typed-dwn-api.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"typed-dwn-api.d.ts","sourceRoot":"","sources":["../../src/typed-dwn-api.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;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,yCAAyC;AACzC,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,8EAA8E;IAC9E,OAAO,CAAC,EAAE;QACR,eAAe,CAAC,EAAG,MAAM,CAAC;QAC1B,SAAS,CAAC,EAAG,OAAO,CAAC;QACrB,aAAa,CAAC,EAAG,MAAM,CAAC;QACxB,SAAS,CAAC,EAAG,MAAM,CAAC;QACpB,YAAY,CAAC,EAAG,MAAM,CAAC;QACvB,UAAU,CAAC,EAAG,iBAAiB,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;QACzC,IAAI,CAAC,EAAG,UAAU,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC,CAAC;KACpF,CAAC;IAEF,2DAA2D;IAC3D,KAAK,CAAC,EAAE,OAAO,CAAC;IAEhB,wEAAwE;IACxE,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB,CAAC;AAEF,2CAA2C;AAC3C,MAAM,MAAM,kBAAkB,GAAG,iBAAiB,GAAG;IACnD,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,gDAAgD;AAChD,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,yCAAyC;AACzC,MAAM,MAAM,iBAAiB,GAAG;IAC9B,6CAA6C;IAC7C,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,kEAAkE;IAClE,MAAM,CAAC,EAAG,gBAAgB,CAAC;IAC3B,QAAQ,CAAC,EAAG,QAAQ,CAAC;IACrB,UAAU,CAAC,EAAG;QAAE,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,mBAAmB,CAAA;KAAE,CAAC;IAC/D,YAAY,CAAC,EAAG,MAAM,CAAC;IAEvB,2DAA2D;IAC3D,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB,CAAC;AAEF,2CAA2C;AAC3C,MAAM,MAAM,kBAAkB,GAAG,iBAAiB,GAAG;IACnD,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,MAAM,CAAC,EAAG,mBAAmB,CAAC;CAC/B,CAAC;AAEF,wCAAwC;AACxC,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,0CAA0C;AAC1C,MAAM,MAAM,iBAAiB,GAAG,iBAAiB,GAAG;IAClD,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,0CAA0C;AAC1C,MAAM,MAAM,kBAAkB,GAAG;IAC/B,8CAA8C;IAC9C,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,8CAA8C;IAC9C,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,6CAA6C;AAC7C,MAAM,MAAM,qBAAqB,GAAG;IAClC,+CAA+C;IAC/C,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,yEAAyE;IACzE,MAAM,CAAC,EAAG,gBAAgB,CAAC;IAC3B,YAAY,CAAC,EAAG,MAAM,CAAC;CACxB,CAAC;AAEF,+CAA+C;AAC/C,MAAM,MAAM,sBAAsB,GAAG,iBAAiB,GAAG;IACvD,qEAAqE;IACrE,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAMF;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,qBAAa,WAAW,CACtB,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;;;;OAIG;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;IAOhH;;;;;OAKG;IACU,KAAK,CAAC,IAAI,SAAS,aAAa,CAAC,CAAC,CAAC,GAAG,MAAM,EACvD,IAAI,EAAG,IAAI,EACX,OAAO,EAAG,iBAAiB,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,GACtC,OAAO,CAAC,kBAAkB,CAAC;IAkB9B;;;;;OAKG;IACU,KAAK,CAAC,IAAI,SAAS,aAAa,CAAC,CAAC,CAAC,GAAG,MAAM,EACvD,IAAI,EAAG,IAAI,EACX,OAAO,CAAC,EAAG,iBAAiB,GAC3B,OAAO,CAAC,kBAAkB,CAAC;IAsB9B;;;;;OAKG;IACU,IAAI,CAAC,IAAI,SAAS,aAAa,CAAC,CAAC,CAAC,GAAG,MAAM,EACtD,IAAI,EAAG,IAAI,EACX,OAAO,EAAG,gBAAgB,GACzB,OAAO,CAAC,iBAAiB,CAAC;IAmB7B;;;;;OAKG;IACU,MAAM,CAAC,IAAI,SAAS,aAAa,CAAC,CAAC,CAAC,GAAG,MAAM,EACxD,KAAK,EAAG,IAAI,EACZ,OAAO,EAAG,kBAAkB,GAC3B,OAAO,CAAC,iBAAiB,CAAC;IAU7B;;;;;;;;OAQG;IACU,SAAS,CAAC,IAAI,SAAS,aAAa,CAAC,CAAC,CAAC,GAAG,MAAM,EAC3D,IAAI,EAAG,IAAI,EACX,OAAO,CAAC,EAAG,qBAAqB,GAC/B,OAAO,CAAC,sBAAsB,CAAC;CAkBnC"}

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,EAEV,iCAAiC,EAEjC,qBAAqB,EAErB,eAAe,EACf,UAAU,EACV,oBAAoB,EACpB,SAAS,EACV,MAAM,cAAc,CAAC;AAItB,OAAO,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AACtC,OAAO,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AAEtC,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,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,0EAA0E;IAC1E,GAAG,EAAE,MAAM,CAAC;IAEZ,oFAAoF;IACpF,EAAE,EAAE,KAAK,CAAC;gBAEE,EAAE,KAAK,EAAE,YAAY,EAAE,WAAW,EAAE,EAAE,UAAU;IAO5D;;;;;;;;;;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,EAEV,iCAAiC,EAEjC,qBAAqB,EAErB,eAAe,EACf,UAAU,EACV,oBAAoB,EACpB,SAAS,EACV,MAAM,cAAc,CAAC;AAKtB,OAAO,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AACtC,OAAO,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AAEtC,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,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,0EAA0E;IAC1E,GAAG,EAAE,MAAM,CAAC;IAEZ,oFAAoF;IACpF,EAAE,EAAE,KAAK,CAAC;gBAEE,EAAE,KAAK,EAAE,YAAY,EAAE,WAAW,EAAE,EAAE,UAAU;IAO5D;;;;;;;;;;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"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@enbox/api",
-  "version": "0.0.8",
+  "version": "0.1.1",
   "description": "SDK for accessing the features and capabilities of Web5",
   "type": "module",
   "main": "./dist/esm/index.js",
@@ -9,14 +9,14 @@
   "scripts": {
     "clean": "rimraf dist",
     "build:esm": "rimraf dist/esm dist/types && bun tsc -p tsconfig.json",
-    "build:browser": "rimraf dist/browser.mjs dist/browser.js && bun build/bundles.js",
-    "build:tests:browser": "rimraf tests/compiled && bun build/esbuild-tests.cjs",
+    "build:browser": "rimraf dist/browser.mjs && bun ../../build/browser-bundle.js --node-shims --metafile",
     "build": "bun run clean && bun run build:esm && bun run build:browser",
     "lint": "eslint . --max-warnings 0",
     "lint:fix": "eslint . --fix",
     "test:node": "bun test --timeout 10000 .spec.ts",
     "test:node:coverage": "bun test --timeout 10000 --coverage --coverage-reporter=text --coverage-reporter=lcov --coverage-dir=coverage .spec.ts",
-    "test:browser": "bun run build:tests:browser && bunx web-test-runner"
+    "test:browser": "bunx --bun vitest --config vitest.browser.config.ts --run",
+    "test:browser:coverage": "bunx --bun vitest --config vitest.browser.config.ts --run --coverage --coverage.provider=istanbul --coverage.reportsDirectory=./coverage-browser"
   },
   "homepage": "https://github.com/enboxorg/enbox/tree/main/packages/api#readme",
   "bugs": "https://github.com/enboxorg/enbox/issues",
@@ -77,28 +77,25 @@
     "bun": ">=1.0.0"
   },
   "dependencies": {
-    "@enbox/agent": "0.1.3",
-    "@enbox/common": "0.0.3"
+    "@enbox/agent": "0.1.5",
+    "@enbox/common": "0.0.3",
+    "@enbox/dwn-clients": "0.0.3"
   },
   "devDependencies": {
-    "@playwright/test": "1.45.3",
-    "@enbox/crypto": "0.0.3",
-    "@enbox/dids": "0.0.3",
-    "@enbox/dwn-sdk-js": "0.0.4",
+    "@enbox/crypto": "0.0.4",
+    "@enbox/dids": "0.0.4",
+    "@enbox/dwn-sdk-js": "0.0.6",
     "@types/node": "20.14.8",
     "@types/sinon": "17.0.3",
     "@typescript-eslint/eslint-plugin": "8.32.1",
     "@typescript-eslint/parser": "8.32.1",
-    "@web/test-runner": "0.18.2",
-    "@web/test-runner-playwright": "0.11.0",
+    "@vitest/browser-playwright": "4.0.18",
+    "@vitest/coverage-istanbul": "4.0.18",
     "bun-types": "latest",
-    "esbuild": "0.19.8",
     "eslint": "9.7.0",
-    "node-stdlib-browser": "1.2.0",
-    "playwright": "1.45.3",
     "rimraf": "4.4.0",
     "sinon": "18.0.0",
-    "source-map-loader": "4.0.2",
-    "typescript": "5.5.4"
+    "typescript": "5.5.4",
+    "vitest": "4.0.18"
   }
 }

package/src/define-protocol.ts

@@ -0,0 +1,48 @@
+/**
+ * Factory function for creating typed protocol definitions.
+ *
+ * `defineProtocol()` wraps a standard {@link ProtocolDefinition} with
+ * compile-time type metadata so that {@link TypedDwnApi} can provide
+ * path autocompletion, data-shape inference, and tag type safety.
+ */
+
+import type { ProtocolDefinition } from '@enbox/dwn-sdk-js';
+
+import type { SchemaMap, TypedProtocol } from './protocol-types.js';
+
+/**
+ * Creates a {@link TypedProtocol} from a plain DWN protocol definition and
+ * an optional schema map that associates TypeScript types with protocol type
+ * names.
+ *
+ * The `definition` argument is returned as-is (no cloning). The schema map
+ * is a phantom type parameter — it exists only at compile time to thread
+ * type information through to `TypedDwnApi`.
+ *
+ * @param definition - A standard `ProtocolDefinition` object.
+ * @param _schemaMap - A phantom value (e.g. `{} as MySchemaMap`) that carries
+ *   the TypeScript type mapping. The runtime value is ignored.
+ * @returns A `TypedProtocol` containing the definition and inferred types.
+ *
+ * @example
+ * ```ts
+ * const socialGraph = defineProtocol(SocialGraphDefinition, {} as {
+ *   friend : { did: string; alias?: string };
+ *   block  : { did: string; reason?: string };
+ * });
+ *
+ * // socialGraph.definition is the raw ProtocolDefinition
+ * // TypedDwnApi infers paths like 'friend' | 'friend/message' and
+ * // data types from the schema map.
+ * ```
+ */
+export function defineProtocol<
+  D extends ProtocolDefinition,
+  M extends SchemaMap = SchemaMap,
+>(
+  definition : D,
+
+  _schemaMap?: M,
+): TypedProtocol<D, M> {
+  return { definition } as TypedProtocol<D, M>;
+}