@enbox/api 0.0.1

package/dist/cjs/permission-grant.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"permission-grant.js","sourceRoot":"","sources":["../../src/permission-grant.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AASA,wCAAwC;AACxC,sCAIsB;AACtB,6DAAkE;AAqElE;;;;;;;GAOG;AACH;IAUE,yBAAoB,EAKnB;YALqB,GAAG,SAAA,EAAE,YAAY,kBAAA,EAAE,OAAO,aAAA,EAAE,KAAK,WAAA;QAMrD,IAAI,CAAC,YAAY,GAAG,GAAG,CAAC;QAExB,2CAA2C;QAC3C,IAAI,CAAC,aAAa,GAAG,YAAY,CAAC;QAElC,+CAA+C;QAC/C,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;QAExB,iCAAiC;QACjC,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;IACtB,CAAC;IAED,4FAA4F;IAC/E,qBAAK,GAAlB,UAAmB,OAA+B;;;;;4BAElC,qBAAM,0BAAkB,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,EAAA;;wBAAvD,KAAK,GAAG,SAA+C;wBACvD,GAAG,GAAG,IAAI,2BAAmB,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC;wBAC9D,sBAAO,IAAI,eAAe,uBAAM,OAAO,KAAE,KAAK,OAAA,EAAE,GAAG,KAAA,IAAG,EAAC;;;;KACxD;IAGD,sBAAY,kCAAK;QADjB,2DAA2D;aAC3D;YACE,OAAO,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC;QACjC,CAAC;;;OAAA;IAGD,sBAAI,+BAAE;QADN,+DAA+D;aAC/D;YACE,OAAO,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;QACxB,CAAC;;;OAAA;IAGD,sBAAI,oCAAO;QADX,4CAA4C;aAC5C;YACE,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC;QAC7B,CAAC;;;OAAA;IAGD,sBAAI,oCAAO;QADX,kDAAkD;aAClD;YACE,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC;QAC7B,CAAC;;;OAAA;IAGD,sBAAI,wCAAW;QADf,0CAA0C;aAC1C;YACE,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC;QACjC,CAAC;;;OAAA;IAGD,sBAAI,wCAAW;QADf,qDAAqD;aACrD;YACE,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC;QACjC,CAAC;;;OAAA;IAGD,sBAAI,sCAAS;QADb,iEAAiE;aACjE;YACE,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC;QAC/B,CAAC;;;OAAA;IAGD,sBAAI,wCAAW;QADf,+CAA+C;aAC/C;YACE,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC;QACjC,CAAC;;;OAAA;IAGD,sBAAI,sCAAS;QADb,iFAAiF;aACjF;YACE,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC;QAC/B,CAAC;;;OAAA;IAGD,sBAAI,kCAAK;QADT,0DAA0D;aAC1D;YACE,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC;QAC3B,CAAC;;;OAAA;IAGD,sBAAI,uCAAU;QADd,oDAAoD;aACpD;YACE,OAAO,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC;QAChC,CAAC;;;OAAA;IAGD,sBAAI,uCAAU;QADd,mGAAmG;aACnG;YACE,OAAO,IAAI,CAAC,QAAQ,CAAC;QACvB,CAAC;;;OAAA;IAED;;;;;;;;OAQG;IACG,8BAAI,GAAV,UAAW,MAAe;;;;;;wBACxB,MAAM,aAAN,MAAM,cAAN,MAAM,IAAN,MAAM,GAAK,IAAI,CAAC,aAAa,EAAC;wBAExB,KAAiC,IAAI,CAAC,QAAQ,EAA5C,WAAW,iBAAA,EAAK,UAAU,cAA5B,eAA8B,CAAF,CAAmB;wBAC/C,UAAU,GAAG,IAAI,IAAI,CAAC,CAAE,gBAAO,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,YAAY,EAAE,CAAE,CAAC,CAAC;wBAEzE,kBAAkB,GAA8C;4BACpE,WAAW,EAAG,oBAAY,CAAC,YAAY;4BACvC,MAAM,EAAQ,IAAI,CAAC,aAAa;4BAChC,MAAM,EAAQ,MAAM;4BACpB,UAAU,YAAA;4BACV,UAAU,YAAA;yBACX,CAAC;wBAGgB,qBAAM,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,kBAAkB,CAAC,EAAA;;wBAA7D,KAAK,GAAK,CAAA,SAAmD,CAAA,MAAxD;wBACb,sBAAO,KAAK,EAAC;;;;KACd;IAED;;;;;;;OAOG;IACG,+BAAK,GAAX,UAAY,WAA4B;QAA5B,4BAAA,EAAA,mBAA4B;;;;;;wBAChC,KAAiC,IAAI,CAAC,UAAU,EAA9C,WAAW,iBAAA,EAAK,UAAU,cAA5B,eAA8B,CAAF,CAAqB;wBACjD,UAAU,GAAG,IAAI,IAAI,CAAC,CAAE,gBAAO,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,YAAY,EAAE,CAAE,CAAC,CAAC;wBAEpD,qBAAM,IAAI,CAAC,KAAK,CAAC,iBAAiB,CAAC;gCAC5D,KAAK,EAAS,IAAI;gCAClB,MAAM,EAAQ,IAAI,CAAC,aAAa;gCAChC,MAAM,EAAQ,IAAI,CAAC,aAAa;gCAChC,WAAW,EAAG,oBAAY,CAAC,YAAY;gCACvC,WAAW,EAAG,WAAW;gCACzB,UAAU,YAAA;gCACV,UAAU,YAAA;6BACX,CAAC,EAAA;;wBARI,KAAqB,SAQzB,EARM,KAAK,WAAA,EAAE,OAAO,aAAA;wBAUtB,IAAI,CAAC,QAAQ,yBAAQ,OAAO,KAAE,WAAW,EAAE,WAAW,GAAE,CAAC;wBACzD,sBAAO,EAAE,MAAM,EAAE,KAAK,CAAC,MAAM,EAAE,EAAC;;;;KACjC;IAED;;;;;;;;OAQG;IACG,gCAAM,GAAZ,UAAa,KAAsB;QAAtB,sBAAA,EAAA,aAAsB;;;;;;wBAC3B,KAAiC,IAAI,CAAC,UAAU,EAA9C,WAAW,iBAAA,EAAK,UAAU,cAA5B,eAA8B,CAAF,CAAqB;wBACjD,UAAU,GAAG,IAAI,IAAI,CAAC,CAAE,gBAAO,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,YAAY,EAAE,CAAE,CAAC,CAAC;wBAEpD,qBAAM,IAAI,CAAC,KAAK,CAAC,iBAAiB,CAAC;gCAC5D,KAAK,OAAA;gCACL,MAAM,EAAQ,IAAI,CAAC,aAAa;gCAChC,MAAM,EAAQ,IAAI,CAAC,aAAa;gCAChC,WAAW,EAAG,oBAAY,CAAC,YAAY;gCACvC,WAAW,EAAG,IAAI;gCAClB,UAAU,YAAA;gCACV,UAAU,YAAA;6BACX,CAAC,EAAA;;wBARI,KAAqB,SAQzB,EARM,KAAK,WAAA,EAAE,OAAO,aAAA;wBAUtB,IAAI,CAAC,QAAQ,yBAAQ,OAAO,KAAE,WAAW,EAAE,WAAW,GAAE,CAAC;wBACzD,sBAAO,EAAE,MAAM,EAAE,KAAK,CAAC,MAAM,EAAE,EAAC;;;;KACjC;IAED;;;;;;;OAOG;IACG,gCAAM,GAAZ,UAAa,KAAqB;QAArB,sBAAA,EAAA,YAAqB;;;;;4BACb,qBAAM,IAAI,CAAC,YAAY,CAAC,gBAAgB,CAAC;4BAC1D,KAAK,OAAA;4BACL,MAAM,EAAG,IAAI,CAAC,aAAa;4BAC3B,KAAK,EAAI,IAAI,CAAC,MAAM;yBACrB,CAAC,EAAA;;wBAJI,UAAU,GAAG,SAIjB;wBAEF,sBAAO,+CAAyB,CAAC,KAAK,CAAC;gCACrC,YAAY,EAAG,IAAI,CAAC,aAAa;gCACjC,KAAK,EAAU,IAAI,CAAC,KAAK;gCACzB,OAAO,EAAQ,UAAU,CAAC,OAAO;6BAClC,CAAC,EAAC;;;;KACJ;IAED;;;;;;;;OAQG;IACH,mCAAS,GAAT,UAAU,MAAuB;QAAvB,uBAAA,EAAA,cAAuB;QAC/B,OAAO,IAAI,CAAC,YAAY,CAAC,cAAc,CAAC;YACtC,MAAM,EAAU,IAAI,CAAC,aAAa;YAClC,MAAM,EAAU,IAAI,CAAC,OAAO;YAC5B,aAAa,EAAG,IAAI,CAAC,EAAE;YACvB,MAAM,QAAA;SACP,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,gCAAM,GAAN;QACE,OAAO;YACL,EAAE,EAAY,IAAI,CAAC,EAAE;YACrB,OAAO,EAAO,IAAI,CAAC,OAAO;YAC1B,OAAO,EAAO,IAAI,CAAC,OAAO;YAC1B,WAAW,EAAG,IAAI,CAAC,WAAW;YAC9B,WAAW,EAAG,IAAI,CAAC,WAAW;YAC9B,SAAS,EAAK,IAAI,CAAC,SAAS;YAC5B,WAAW,EAAG,IAAI,CAAC,WAAW;YAC9B,SAAS,EAAK,IAAI,CAAC,SAAS;YAC5B,KAAK,EAAS,IAAI,CAAC,KAAK;YACxB,UAAU,EAAI,IAAI,CAAC,UAAU;SAC9B,CAAC;IACJ,CAAC;IACH,sBAAC;AAAD,CAAC,AA1OD,IA0OC;AA1OY,0CAAe"}

package/dist/cjs/permission-request.js

@@ -0,0 +1,272 @@
+"use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+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());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PermissionRequest = void 0;
+var agent_1 = require("@enbox/agent");
+var agent_2 = require("@enbox/agent");
+var common_1 = require("@enbox/common");
+var permission_grant_js_1 = require("./permission-grant.js");
+/**
+ * The `PermissionRequest` class encapsulates a permissions protocol `request` record, providing a more
+ * developer-friendly interface for working with Decentralized Web Node (DWN) records.
+ *
+ * Methods are provided to grant the request and manage the request's lifecycle, including writing to remote DWNs.
+ *
+ * @beta
+ */
+var PermissionRequest = /** @class */ (function () {
+    function PermissionRequest(_a) {
+        var api = _a.api, connectedDid = _a.connectedDid, message = _a.message, request = _a.request;
+        this._permissions = api;
+        this._connectedDid = connectedDid;
+        // Store the parsed request object.
+        this._request = request;
+        // Store the message that represents the grant.
+        this._message = message;
+    }
+    /** parses the request given an agent, connectedDid and data encoded records write message  */
+    PermissionRequest.parse = function (_a) {
+        var connectedDid = _a.connectedDid, agent = _a.agent, message = _a.message;
+        return __awaiter(this, void 0, void 0, function () {
+            var request, api;
+            return __generator(this, function (_b) {
+                switch (_b.label) {
+                    case 0: return [4 /*yield*/, agent_1.DwnPermissionRequest.parse(message)];
+                    case 1:
+                        request = _b.sent();
+                        api = new agent_1.AgentPermissionsApi({ agent: agent });
+                        return [2 /*return*/, new PermissionRequest({ api: api, connectedDid: connectedDid, message: message, request: request })];
+                }
+            });
+        });
+    };
+    Object.defineProperty(PermissionRequest.prototype, "agent", {
+        /** The agent to use for this instantiation of the request */
+        get: function () {
+            return this._permissions.agent;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(PermissionRequest.prototype, "id", {
+        /** The request's ID, which is also the underlying record's ID  */
+        get: function () {
+            return this._request.id;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(PermissionRequest.prototype, "requester", {
+        /** The DID that is requesting a permission */
+        get: function () {
+            return this._request.requester;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(PermissionRequest.prototype, "description", {
+        /** (optional) Description of the permission request */
+        get: function () {
+            return this._request.description;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(PermissionRequest.prototype, "delegated", {
+        /** Whether or not the permission request can be used to impersonate the grantor */
+        get: function () {
+            return this._request.delegated;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(PermissionRequest.prototype, "scope", {
+        /** The permission scope under which the requested grant would be valid */
+        get: function () {
+            return this._request.scope;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(PermissionRequest.prototype, "conditions", {
+        /** The conditions under which the requested grant would be valid */
+        get: function () {
+            return this._request.conditions;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(PermissionRequest.prototype, "rawMessage", {
+        /** The `RecordsWrite` DWN message with encoded data that was used to instantiate this request */
+        get: function () {
+            return this._message;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    /**
+     * Send the current permission request to a remote DWN by specifying their DID
+     * If no DID is specified, the target is assumed to be the owner (connectedDID).
+     *
+     * @param target - the optional DID to send the permission request to, if none is set it is sent to the connectedDid
+     * @returns the status of the send permission request
+     *
+     * @beta
+     */
+    PermissionRequest.prototype.send = function (target) {
+        return __awaiter(this, void 0, void 0, function () {
+            var _a, encodedData, rawMessage, dataStream, sendRequestOptions, reply;
+            return __generator(this, function (_b) {
+                switch (_b.label) {
+                    case 0:
+                        target !== null && target !== void 0 ? target : (target = this._connectedDid);
+                        _a = this._message, encodedData = _a.encodedData, rawMessage = __rest(_a, ["encodedData"]);
+                        dataStream = new Blob([common_1.Convert.base64Url(encodedData).toUint8Array()]);
+                        sendRequestOptions = {
+                            messageType: agent_2.DwnInterface.RecordsWrite,
+                            author: this._connectedDid,
+                            target: target,
+                            dataStream: dataStream,
+                            rawMessage: rawMessage,
+                        };
+                        return [4 /*yield*/, this.agent.sendDwnRequest(sendRequestOptions)];
+                    case 1:
+                        reply = (_b.sent()).reply;
+                        return [2 /*return*/, reply];
+                }
+            });
+        });
+    };
+    /**
+     * Stores the current permission request to the owner's DWN.
+     *
+     * @param importGrant - if true, the permission request will signed by the owner before storing it to the owner's DWN. Defaults to false.
+     * @returns the status of the store request
+     *
+     * @beta
+     */
+    PermissionRequest.prototype.store = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            var _a, encodedData, rawMessage, dataStream, _b, reply, message;
+            return __generator(this, function (_c) {
+                switch (_c.label) {
+                    case 0:
+                        _a = this.rawMessage, encodedData = _a.encodedData, rawMessage = __rest(_a, ["encodedData"]);
+                        dataStream = new Blob([common_1.Convert.base64Url(encodedData).toUint8Array()]);
+                        return [4 /*yield*/, this.agent.processDwnRequest({
+                                author: this._connectedDid,
+                                target: this._connectedDid,
+                                messageType: agent_2.DwnInterface.RecordsWrite,
+                                rawMessage: rawMessage,
+                                dataStream: dataStream,
+                            })];
+                    case 1:
+                        _b = _c.sent(), reply = _b.reply, message = _b.message;
+                        this._message = __assign(__assign({}, message), { encodedData: encodedData });
+                        return [2 /*return*/, { status: reply.status }];
+                }
+            });
+        });
+    };
+    /**
+     * Grants the permission request to the requester.
+     *
+     * @param dateExpires - the date when the permission grant will expire.
+     * @param store - if true, the permission grant will be stored in the owner's DWN. Defaults to true.
+     * @returns {PermissionGrant} the granted permission.
+     *
+     * @beta
+     */
+    PermissionRequest.prototype.grant = function (dateExpires, store) {
+        if (store === void 0) { store = true; }
+        return __awaiter(this, void 0, void 0, function () {
+            var message;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this._permissions.createGrant({
+                            requestId: this.id,
+                            grantedTo: this.requester,
+                            scope: this.scope,
+                            delegated: this.delegated,
+                            author: this._connectedDid,
+                            store: store,
+                            dateExpires: dateExpires,
+                        })];
+                    case 1:
+                        message = (_a.sent()).message;
+                        return [2 /*return*/, permission_grant_js_1.PermissionGrant.parse({
+                                connectedDid: this._connectedDid,
+                                agent: this.agent,
+                                message: message
+                            })];
+                }
+            });
+        });
+    };
+    /**
+     * @returns the JSON representation of the permission request
+     */
+    PermissionRequest.prototype.toJSON = function () {
+        return this._request;
+    };
+    return PermissionRequest;
+}());
+exports.PermissionRequest = PermissionRequest;
+//# sourceMappingURL=permission-request.js.map

package/dist/cjs/permission-request.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"permission-request.js","sourceRoot":"","sources":["../../src/permission-request.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,sCAAuM;AACvM,sCAA4C;AAC5C,wCAAwC;AACxC,6DAAwD;AAuCxD;;;;;;;GAOG;AACH;IAUE,2BAAoB,EAKnB;YALqB,GAAG,SAAA,EAAE,YAAY,kBAAA,EAAE,OAAO,aAAA,EAAE,OAAO,aAAA;QAMvD,IAAI,CAAC,YAAY,GAAG,GAAG,CAAC;QACxB,IAAI,CAAC,aAAa,GAAG,YAAY,CAAC;QAElC,mCAAmC;QACnC,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;QAExB,+CAA+C;QAC/C,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;IAC1B,CAAC;IAED,8FAA8F;IACjF,uBAAK,GAAlB,UAAmB,EAIlB;YAJoB,YAAY,kBAAA,EAAE,KAAK,WAAA,EAAE,OAAO,aAAA;;;;;4BAM/B,qBAAM,4BAAoB,CAAC,KAAK,CAAC,OAAO,CAAC,EAAA;;wBAAnD,OAAO,GAAG,SAAyC;wBACnD,GAAG,GAAG,IAAI,2BAAmB,CAAC,EAAE,KAAK,OAAA,EAAE,CAAC,CAAC;wBAC/C,sBAAO,IAAI,iBAAiB,CAAC,EAAE,GAAG,KAAA,EAAE,YAAY,cAAA,EAAE,OAAO,SAAA,EAAE,OAAO,SAAA,EAAE,CAAC,EAAC;;;;KACvE;IAGD,sBAAY,oCAAK;QADjB,6DAA6D;aAC7D;YACE,OAAO,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC;QACjC,CAAC;;;OAAA;IAGD,sBAAI,iCAAE;QADN,kEAAkE;aAClE;YACE,OAAO,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC1B,CAAC;;;OAAA;IAGD,sBAAI,wCAAS;QADb,8CAA8C;aAC9C;YACE,OAAO,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC;QACjC,CAAC;;;OAAA;IAGD,sBAAI,0CAAW;QADf,uDAAuD;aACvD;YACE,OAAO,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC;QACnC,CAAC;;;OAAA;IAGD,sBAAI,wCAAS;QADb,mFAAmF;aACnF;YACE,OAAO,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC;QACjC,CAAC;;;OAAA;IAGD,sBAAI,oCAAK;QADT,0EAA0E;aAC1E;YACE,OAAO,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC;QAC7B,CAAC;;;OAAA;IAGD,sBAAI,yCAAU;QADd,oEAAoE;aACpE;YACE,OAAO,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC;QAClC,CAAC;;;OAAA;IAGD,sBAAI,yCAAU;QADd,iGAAiG;aACjG;YACE,OAAO,IAAI,CAAC,QAAQ,CAAC;QACvB,CAAC;;;OAAA;IAED;;;;;;;;OAQG;IACG,gCAAI,GAAV,UAAW,MAAe;;;;;;wBACxB,MAAM,aAAN,MAAM,cAAN,MAAM,IAAN,MAAM,GAAK,IAAI,CAAC,aAAa,EAAC;wBAExB,KAAiC,IAAI,CAAC,QAAQ,EAA5C,WAAW,iBAAA,EAAK,UAAU,cAA5B,eAA8B,CAAF,CAAmB;wBAC/C,UAAU,GAAG,IAAI,IAAI,CAAC,CAAE,gBAAO,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,YAAY,EAAE,CAAE,CAAC,CAAC;wBAEzE,kBAAkB,GAA8C;4BACpE,WAAW,EAAG,oBAAY,CAAC,YAAY;4BACvC,MAAM,EAAQ,IAAI,CAAC,aAAa;4BAChC,MAAM,EAAQ,MAAM;4BACpB,UAAU,YAAA;4BACV,UAAU,YAAA;yBACX,CAAC;wBAGgB,qBAAM,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,kBAAkB,CAAC,EAAA;;wBAA7D,KAAK,GAAK,CAAA,SAAmD,CAAA,MAAxD;wBACb,sBAAO,KAAK,EAAC;;;;KACd;IAED;;;;;;;OAOG;IACG,iCAAK,GAAX;;;;;;wBACQ,KAAiC,IAAI,CAAC,UAAU,EAA9C,WAAW,iBAAA,EAAK,UAAU,cAA5B,eAA8B,CAAF,CAAqB;wBACjD,UAAU,GAAG,IAAI,IAAI,CAAC,CAAE,gBAAO,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,YAAY,EAAE,CAAE,CAAC,CAAC;wBAEpD,qBAAM,IAAI,CAAC,KAAK,CAAC,iBAAiB,CAAC;gCAC5D,MAAM,EAAQ,IAAI,CAAC,aAAa;gCAChC,MAAM,EAAQ,IAAI,CAAC,aAAa;gCAChC,WAAW,EAAG,oBAAY,CAAC,YAAY;gCACvC,UAAU,YAAA;gCACV,UAAU,YAAA;6BACX,CAAC,EAAA;;wBANI,KAAqB,SAMzB,EANM,KAAK,WAAA,EAAE,OAAO,aAAA;wBAQtB,IAAI,CAAC,QAAQ,yBAAQ,OAAO,KAAE,WAAW,EAAE,WAAW,GAAE,CAAC;wBACzD,sBAAO,EAAE,MAAM,EAAE,KAAK,CAAC,MAAM,EAAE,EAAC;;;;KACjC;IAED;;;;;;;;OAQG;IACG,iCAAK,GAAX,UAAY,WAAmB,EAAE,KAAqB;QAArB,sBAAA,EAAA,YAAqB;;;;;4BAChC,qBAAM,IAAI,CAAC,YAAY,CAAC,WAAW,CAAC;4BACtD,SAAS,EAAG,IAAI,CAAC,EAAE;4BACnB,SAAS,EAAG,IAAI,CAAC,SAAS;4BAC1B,KAAK,EAAO,IAAI,CAAC,KAAK;4BACtB,SAAS,EAAG,IAAI,CAAC,SAAS;4BAC1B,MAAM,EAAM,IAAI,CAAC,aAAa;4BAC9B,KAAK,OAAA;4BACL,WAAW,aAAA;yBACZ,CAAC,EAAA;;wBARM,OAAO,GAAK,CAAA,SAQlB,CAAA,QARa;wBAUf,sBAAO,qCAAe,CAAC,KAAK,CAAC;gCAC3B,YAAY,EAAG,IAAI,CAAC,aAAa;gCACjC,KAAK,EAAU,IAAI,CAAC,KAAK;gCACzB,OAAO,SAAA;6BACR,CAAC,EAAC;;;;KACJ;IAED;;OAEG;IACH,kCAAM,GAAN;QACE,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IACH,wBAAC;AAAD,CAAC,AAnKD,IAmKC;AAnKY,8CAAiB"}

package/dist/cjs/protocol.js

@@ -0,0 +1,110 @@
+"use strict";
+/**
+ * NOTE: Added reference types here to avoid a `pnpm` bug during build.
+ * https://github.com/TBD54566975/web5-js/pull/507
+ */
+/// <reference types="@enbox/dwn-sdk-js" />
+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());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Protocol = void 0;
+var agent_1 = require("@enbox/agent");
+/**
+ * Encapsulates a DWN Protocol with its associated metadata and configuration.
+ *
+ * This class primarly exists to provide developers with a convenient way to configure/install
+ * protocols on remote DWNs.
+ */
+var Protocol = /** @class */ (function () {
+    /**
+     * Constructs a new instance of the Protocol class.
+     *
+     * @param agent - The Web5Agent instance used for network interactions.
+     * @param protocolsConfigureMessage - The configuration message containing the protocol details.
+     * @param metadata - Metadata associated with the protocol, including the author and optional message CID.
+     */
+    function Protocol(agent, protocolsConfigureMessage, metadata) {
+        this._agent = agent;
+        this._metadata = metadata;
+        this._protocolsConfigureMessage = protocolsConfigureMessage;
+    }
+    Object.defineProperty(Protocol.prototype, "definition", {
+        /**
+         * Retrieves the protocol definition from the protocol's configuration message.
+         * @returns The protocol definition.
+         */
+        get: function () {
+            return this._protocolsConfigureMessage.descriptor.definition;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    /**
+     * Serializes the protocol's configuration message to JSON.
+     * @returns The serialized JSON object of the protocol's configuration message.
+     */
+    Protocol.prototype.toJSON = function () {
+        return this._protocolsConfigureMessage;
+    };
+    /**
+     * Sends the protocol configuration to a remote DWN identified by the target DID.
+     *
+     * @param target - The DID of the target DWN to which the protocol configuration will be installed.
+     * @returns A promise that resolves to an object containing the status of the send operation.
+     */
+    Protocol.prototype.send = function (target) {
+        return __awaiter(this, void 0, void 0, function () {
+            var reply;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this._agent.sendDwnRequest({
+                            author: this._metadata.author,
+                            messageCid: this._metadata.messageCid,
+                            messageType: agent_1.DwnInterface.ProtocolsConfigure,
+                            target: target,
+                        })];
+                    case 1:
+                        reply = (_a.sent()).reply;
+                        return [2 /*return*/, { status: reply.status }];
+                }
+            });
+        });
+    };
+    return Protocol;
+}());
+exports.Protocol = Protocol;
+//# sourceMappingURL=protocol.js.map

package/dist/cjs/protocol.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"protocol.js","sourceRoot":"","sources":["../../src/protocol.ts"],"names":[],"mappings":";AAAA;;;GAGG;AACH,2CAA2C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAI3C,sCAA4C;AAiB5C;;;;;GAKG;AACH;IAUE;;;;;;OAMG;IACH,kBAAY,KAAgB,EAAE,yBAAsE,EAAE,QAA0B;QAC9H,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;QACpB,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;QAC1B,IAAI,CAAC,0BAA0B,GAAG,yBAAyB,CAAC;IAC9D,CAAC;IAMD,sBAAI,gCAAU;QAJd;;;WAGG;aACH;YACE,OAAO,IAAI,CAAC,0BAA0B,CAAC,UAAU,CAAC,UAAU,CAAC;QAC/D,CAAC;;;OAAA;IAED;;;OAGG;IACH,yBAAM,GAAN;QACE,OAAO,IAAI,CAAC,0BAA0B,CAAC;IACzC,CAAC;IAED;;;;;OAKG;IACG,uBAAI,GAAV,UAAW,MAAc;;;;;4BACL,qBAAM,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC;4BACjD,MAAM,EAAQ,IAAI,CAAC,SAAS,CAAC,MAAM;4BACnC,UAAU,EAAI,IAAI,CAAC,SAAS,CAAC,UAAU;4BACvC,WAAW,EAAG,oBAAY,CAAC,kBAAkB;4BAC7C,MAAM,EAAQ,MAAM;yBACrB,CAAC,EAAA;;wBALM,KAAK,GAAK,CAAA,SAKhB,CAAA,MALW;wBAOb,sBAAO,EAAE,MAAM,EAAE,KAAK,CAAC,MAAM,EAAE,EAAC;;;;KACjC;IACH,eAAC;AAAD,CAAC,AAvDD,IAuDC;AAvDY,4BAAQ"}