@enbox/api 0.1.1 → 0.2.0

package/dist/esm/typed-dwn-api.js

@@ -1,182 +0,0 @@
-/**
- * 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.
- */
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-// ---------------------------------------------------------------------------
-// TypedDwnApi class
-// ---------------------------------------------------------------------------
-/**
- * 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 class TypedDwnApi {
-    constructor(dwn, protocol) {
-        this._dwn = dwn;
-        this._definition = protocol.definition;
-    }
-    /** The protocol URI. */
-    get protocol() {
-        return this._definition.protocol;
-    }
-    /** The raw protocol definition. */
-    get definition() {
-        return this._definition;
-    }
-    /**
-     * Configures (installs) this protocol on the local DWN.
-     *
-     * @param options - Optional overrides like `encryption`.
-     */
-    configure(options) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return this._dwn.protocols.configure({
-                message: { definition: this._definition },
-                encryption: options === null || options === void 0 ? void 0 : options.encryption,
-            });
-        });
-    }
-    /**
-     * 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, request) {
-        return __awaiter(this, void 0, void 0, function* () {
-            var _a, _b, _c;
-            const typeName = lastSegment(path);
-            const typeEntry = this._definition.types[typeName];
-            return this._dwn.records.write({
-                data: request.data,
-                store: request.store,
-                encryption: request.encryption,
-                message: Object.assign(Object.assign({}, request.message), { protocol: this._definition.protocol, protocolPath: path, schema: typeEntry === null || typeEntry === void 0 ? void 0 : typeEntry.schema, dataFormat: (_b = (_a = request.message) === null || _a === void 0 ? void 0 : _a.dataFormat) !== null && _b !== void 0 ? _b : (_c = typeEntry === null || typeEntry === void 0 ? void 0 : typeEntry.dataFormats) === null || _c === void 0 ? void 0 : _c[0] }),
-            });
-        });
-    }
-    /**
-     * 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, request) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const typeName = lastSegment(path);
-            const typeEntry = this._definition.types[typeName];
-            return this._dwn.records.query({
-                from: request === null || request === void 0 ? void 0 : request.from,
-                protocol: this._definition.protocol,
-                encryption: request === null || request === void 0 ? void 0 : request.encryption,
-                message: {
-                    filter: Object.assign(Object.assign({}, request === null || request === void 0 ? void 0 : request.filter), { protocol: this._definition.protocol, protocolPath: path, schema: typeEntry === null || typeEntry === void 0 ? void 0 : typeEntry.schema }),
-                    dateSort: request === null || request === void 0 ? void 0 : request.dateSort,
-                    pagination: request === null || request === void 0 ? void 0 : request.pagination,
-                    protocolRole: request === null || request === void 0 ? void 0 : request.protocolRole,
-                },
-            });
-        });
-    }
-    /**
-     * 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, request) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const typeName = lastSegment(path);
-            const typeEntry = this._definition.types[typeName];
-            return this._dwn.records.read({
-                from: request.from,
-                protocol: this._definition.protocol,
-                encryption: request.encryption,
-                message: {
-                    filter: Object.assign(Object.assign({}, request.filter), { protocol: this._definition.protocol, protocolPath: path, schema: typeEntry === null || typeEntry === void 0 ? void 0 : typeEntry.schema }),
-                },
-            });
-        });
-    }
-    /**
-     * 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, request) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return this._dwn.records.delete({
-                from: request.from,
-                protocol: this._definition.protocol,
-                message: {
-                    recordId: request.recordId,
-                },
-            });
-        });
-    }
-    /**
-     * 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, request) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const typeName = lastSegment(path);
-            const typeEntry = this._definition.types[typeName];
-            return this._dwn.records.subscribe({
-                from: request === null || request === void 0 ? void 0 : request.from,
-                protocol: this._definition.protocol,
-                message: {
-                    filter: Object.assign(Object.assign({}, request === null || request === void 0 ? void 0 : request.filter), { protocol: this._definition.protocol, protocolPath: path, schema: typeEntry === null || typeEntry === void 0 ? void 0 : typeEntry.schema }),
-                    protocolRole: request === null || request === void 0 ? void 0 : request.protocolRole,
-                },
-            });
-        });
-    }
-}
-// ---------------------------------------------------------------------------
-// Helpers
-// ---------------------------------------------------------------------------
-/**
- * Returns the last segment of a slash-delimited path.
- */
-function lastSegment(path) {
-    const parts = path.split('/');
-    return parts[parts.length - 1];
-}
-//# sourceMappingURL=typed-dwn-api.js.map

package/dist/esm/typed-dwn-api.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"typed-dwn-api.js","sourceRoot":"","sources":["../../src/typed-dwn-api.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;;;;;;;;;;AA2JH,8EAA8E;AAC9E,oBAAoB;AACpB,8EAA8E;AAE9E;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,OAAO,WAAW;IAOtB,YAAY,GAAW,EAAE,QAA6B;QACpD,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC;QAChB,IAAI,CAAC,WAAW,GAAG,QAAQ,CAAC,UAAU,CAAC;IACzC,CAAC;IAED,wBAAwB;IACxB,IAAW,QAAQ;QACjB,OAAO,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC;IACnC,CAAC;IAED,mCAAmC;IACnC,IAAW,UAAU;QACnB,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IAED;;;;OAIG;IACU,SAAS,CAAC,OAAkC;;YACvD,OAAO,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC;gBACnC,OAAO,EAAM,EAAE,UAAU,EAAE,IAAI,CAAC,WAAW,EAAE;gBAC7C,UAAU,EAAG,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,UAAU;aACjC,CAAC,CAAC;QACL,CAAC;KAAA;IAED;;;;;OAKG;IACU,KAAK,CAChB,IAAW,EACX,OAAuC;;;YAEvC,MAAM,QAAQ,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC;YACnC,MAAM,SAAS,GAAG,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,QAAQ,CAA6B,CAAC;YAE/E,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC;gBAC7B,IAAI,EAAS,OAAO,CAAC,IAAI;gBACzB,KAAK,EAAQ,OAAO,CAAC,KAAK;gBAC1B,UAAU,EAAG,OAAO,CAAC,UAAU;gBAC/B,OAAO,kCACF,OAAO,CAAC,OAAO,KAClB,QAAQ,EAAO,IAAI,CAAC,WAAW,CAAC,QAAQ,EACxC,YAAY,EAAG,IAAI,EACnB,MAAM,EAAS,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,MAAM,EAChC,UAAU,EAAK,MAAA,MAAA,OAAO,CAAC,OAAO,0CAAE,UAAU,mCAAI,MAAA,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,WAAW,0CAAG,CAAC,CAAC,GAC1E;aACF,CAAC,CAAC;QACL,CAAC;KAAA;IAED;;;;;OAKG;IACU,KAAK,CAChB,IAAW,EACX,OAA4B;;YAE5B,MAAM,QAAQ,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC;YACnC,MAAM,SAAS,GAAG,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,QAAQ,CAA6B,CAAC;YAE/E,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC;gBAC7B,IAAI,EAAS,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,IAAI;gBAC1B,QAAQ,EAAK,IAAI,CAAC,WAAW,CAAC,QAAQ;gBACtC,UAAU,EAAG,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,UAAU;gBAChC,OAAO,EAAM;oBACX,MAAM,kCACD,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,MAAM,KAClB,QAAQ,EAAO,IAAI,CAAC,WAAW,CAAC,QAAQ,EACxC,YAAY,EAAG,IAAI,EACnB,MAAM,EAAS,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,MAAM,GACjC;oBACD,QAAQ,EAAO,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,QAAQ;oBAChC,UAAU,EAAK,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,UAAU;oBAClC,YAAY,EAAG,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,YAAY;iBACrC;aACF,CAAC,CAAC;QACL,CAAC;KAAA;IAED;;;;;OAKG;IACU,IAAI,CACf,IAAW,EACX,OAA0B;;YAE1B,MAAM,QAAQ,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC;YACnC,MAAM,SAAS,GAAG,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,QAAQ,CAA6B,CAAC;YAE/E,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC;gBAC5B,IAAI,EAAS,OAAO,CAAC,IAAI;gBACzB,QAAQ,EAAK,IAAI,CAAC,WAAW,CAAC,QAAQ;gBACtC,UAAU,EAAG,OAAO,CAAC,UAAU;gBAC/B,OAAO,EAAM;oBACX,MAAM,kCACD,OAAO,CAAC,MAAM,KACjB,QAAQ,EAAO,IAAI,CAAC,WAAW,CAAC,QAAQ,EACxC,YAAY,EAAG,IAAI,EACnB,MAAM,EAAS,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,MAAM,GACjC;iBACF;aACF,CAAC,CAAC;QACL,CAAC;KAAA;IAED;;;;;OAKG;IACU,MAAM,CACjB,KAAY,EACZ,OAA4B;;YAE5B,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC;gBAC9B,IAAI,EAAO,OAAO,CAAC,IAAI;gBACvB,QAAQ,EAAG,IAAI,CAAC,WAAW,CAAC,QAAQ;gBACpC,OAAO,EAAI;oBACT,QAAQ,EAAE,OAAO,CAAC,QAAQ;iBAC3B;aACF,CAAC,CAAC;QACL,CAAC;KAAA;IAED;;;;;;;;OAQG;IACU,SAAS,CACpB,IAAW,EACX,OAAgC;;YAEhC,MAAM,QAAQ,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC;YACnC,MAAM,SAAS,GAAG,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,QAAQ,CAA6B,CAAC;YAE/E,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC;gBACjC,IAAI,EAAO,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,IAAI;gBACxB,QAAQ,EAAG,IAAI,CAAC,WAAW,CAAC,QAAQ;gBACpC,OAAO,EAAI;oBACT,MAAM,kCACD,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,MAAM,KAClB,QAAQ,EAAO,IAAI,CAAC,WAAW,CAAC,QAAQ,EACxC,YAAY,EAAG,IAAI,EACnB,MAAM,EAAS,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,MAAM,GACjC;oBACD,YAAY,EAAE,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,YAAY;iBACpC;aACF,CAAC,CAAC;QACL,CAAC;KAAA;CACF;AAED,8EAA8E;AAC9E,UAAU;AACV,8EAA8E;AAE9E;;GAEG;AACH,SAAS,WAAW,CAAC,IAAY;IAC/B,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAC9B,OAAO,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;AACjC,CAAC"}

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

@@ -1 +0,0 @@
-{"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/src/typed-dwn-api.ts

@@ -1,370 +0,0 @@
-/**
- * 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';
-
-// ---------------------------------------------------------------------------
-// Helper types
-// ---------------------------------------------------------------------------
-
-/**
- * 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;
-
-// ---------------------------------------------------------------------------
-// Request / response types
-// ---------------------------------------------------------------------------
-
-/** 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;
-};
-
-// ---------------------------------------------------------------------------
-// TypedDwnApi class
-// ---------------------------------------------------------------------------
-
-/**
- * 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 class TypedDwnApi<
-  D extends ProtocolDefinition = ProtocolDefinition,
-  M extends SchemaMap = SchemaMap,
-> {
-  private _dwn: DwnApi;
-  private _definition: D;
-
-  constructor(dwn: DwnApi, protocol: TypedProtocol<D, M>) {
-    this._dwn = dwn;
-    this._definition = protocol.definition;
-  }
-
-  /** The protocol URI. */
-  public get protocol(): string {
-    return this._definition.protocol;
-  }
-
-  /** The raw protocol definition. */
-  public get definition(): D {
-    return this._definition;
-  }
-
-  /**
-   * Configures (installs) this protocol on the local DWN.
-   *
-   * @param options - Optional overrides like `encryption`.
-   */
-  public async configure(options?: { encryption?: boolean }): Promise<DwnResponseStatus & { protocol?: Protocol }> {
-    return this._dwn.protocols.configure({
-      message    : { definition: this._definition },
-      encryption : options?.encryption,
-    });
-  }
-
-  /**
-   * 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`.
-   */
-  public async write<Path extends ProtocolPaths<D> & string>(
-    path : Path,
-    request : TypedWriteRequest<D, M, Path>,
-  ): Promise<TypedWriteResponse> {
-    const typeName = lastSegment(path);
-    const typeEntry = this._definition.types[typeName] as ProtocolType | undefined;
-
-    return this._dwn.records.write({
-      data       : request.data,
-      store      : request.store,
-      encryption : request.encryption,
-      message    : {
-        ...request.message,
-        protocol     : this._definition.protocol,
-        protocolPath : path,
-        schema       : typeEntry?.schema,
-        dataFormat   : request.message?.dataFormat ?? typeEntry?.dataFormats?.[0],
-      },
-    });
-  }
-
-  /**
-   * Query records at the given protocol path.
-   *
-   * @param path - The protocol path to query.
-   * @param request - Query options including optional filter, sort, and pagination.
-   */
-  public async query<Path extends ProtocolPaths<D> & string>(
-    path : Path,
-    request? : TypedQueryRequest,
-  ): Promise<TypedQueryResponse> {
-    const typeName = lastSegment(path);
-    const typeEntry = this._definition.types[typeName] as ProtocolType | undefined;
-
-    return this._dwn.records.query({
-      from       : request?.from,
-      protocol   : this._definition.protocol,
-      encryption : request?.encryption,
-      message    : {
-        filter: {
-          ...request?.filter,
-          protocol     : this._definition.protocol,
-          protocolPath : path,
-          schema       : typeEntry?.schema,
-        },
-        dateSort     : request?.dateSort,
-        pagination   : request?.pagination,
-        protocolRole : request?.protocolRole,
-      },
-    });
-  }
-
-  /**
-   * 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.
-   */
-  public async read<Path extends ProtocolPaths<D> & string>(
-    path : Path,
-    request : TypedReadRequest,
-  ): Promise<TypedReadResponse> {
-    const typeName = lastSegment(path);
-    const typeEntry = this._definition.types[typeName] as ProtocolType | undefined;
-
-    return this._dwn.records.read({
-      from       : request.from,
-      protocol   : this._definition.protocol,
-      encryption : request.encryption,
-      message    : {
-        filter: {
-          ...request.filter,
-          protocol     : this._definition.protocol,
-          protocolPath : path,
-          schema       : typeEntry?.schema,
-        },
-      },
-    });
-  }
-
-  /**
-   * Delete a record at the given protocol path.
-   *
-   * @param path - The protocol path (used for permission scoping).
-   * @param request - Delete options including the `recordId`.
-   */
-  public async delete<Path extends ProtocolPaths<D> & string>(
-    _path : Path,
-    request : TypedDeleteRequest,
-  ): Promise<DwnResponseStatus> {
-    return this._dwn.records.delete({
-      from     : request.from,
-      protocol : this._definition.protocol,
-      message  : {
-        recordId: request.recordId,
-      },
-    });
-  }
-
-  /**
-   * 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.
-   */
-  public async subscribe<Path extends ProtocolPaths<D> & string>(
-    path : Path,
-    request? : TypedSubscribeRequest,
-  ): Promise<TypedSubscribeResponse> {
-    const typeName = lastSegment(path);
-    const typeEntry = this._definition.types[typeName] as ProtocolType | undefined;
-
-    return this._dwn.records.subscribe({
-      from     : request?.from,
-      protocol : this._definition.protocol,
-      message  : {
-        filter: {
-          ...request?.filter,
-          protocol     : this._definition.protocol,
-          protocolPath : path,
-          schema       : typeEntry?.schema,
-        },
-        protocolRole: request?.protocolRole,
-      },
-    });
-  }
-}
-
-// ---------------------------------------------------------------------------
-// Helpers
-// ---------------------------------------------------------------------------
-
-/**
- * Returns the last segment of a slash-delimited path.
- */
-function lastSegment(path: string): string {
-  const parts = path.split('/');
-  return parts[parts.length - 1];
-}