@enbox/dwn-sdk-js 0.0.1

package/dist/esm/src/interfaces/messages-query.js

@@ -0,0 +1,53 @@
+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());
+    });
+};
+import { AbstractMessage } from '../core/abstract-message.js';
+import { Message } from '../core/message.js';
+import { Messages } from '../utils/messages.js';
+import { removeUndefinedProperties } from '../utils/object.js';
+import { Time } from '../utils/time.js';
+import { validateProtocolUrlNormalized } from '../utils/url.js';
+import { DwnInterfaceName, DwnMethodName } from '../enums/dwn-interface-method.js';
+export class MessagesQuery extends AbstractMessage {
+    static parse(message) {
+        return __awaiter(this, void 0, void 0, function* () {
+            Message.validateJsonSchema(message);
+            yield Message.validateSignatureStructure(message.authorization.signature, message.descriptor);
+            for (const filter of message.descriptor.filters) {
+                if ('protocol' in filter && filter.protocol !== undefined) {
+                    validateProtocolUrlNormalized(filter.protocol);
+                }
+            }
+            return new MessagesQuery(message);
+        });
+    }
+    static create(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a;
+            const descriptor = {
+                interface: DwnInterfaceName.Messages,
+                method: DwnMethodName.Query,
+                filters: options.filters ? Messages.normalizeFilters(options.filters) : [],
+                messageTimestamp: (_a = options.messageTimestamp) !== null && _a !== void 0 ? _a : Time.getCurrentTimestamp(),
+                cursor: options.cursor,
+            };
+            removeUndefinedProperties(descriptor);
+            const { permissionGrantId, signer } = options;
+            const authorization = yield Message.createAuthorization({
+                descriptor,
+                signer,
+                permissionGrantId
+            });
+            const message = { descriptor, authorization };
+            Message.validateJsonSchema(message);
+            return new MessagesQuery(message);
+        });
+    }
+}
+//# sourceMappingURL=messages-query.js.map

package/dist/esm/src/interfaces/messages-query.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"messages-query.js","sourceRoot":"","sources":["../../../../src/interfaces/messages-query.ts"],"names":[],"mappings":";;;;;;;;;AAIA,OAAO,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC;AAC9D,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAC7C,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAChD,OAAO,EAAE,yBAAyB,EAAE,MAAM,oBAAoB,CAAC;AAC/D,OAAO,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AACxC,OAAO,EAAE,6BAA6B,EAAE,MAAM,iBAAiB,CAAC;AAChE,OAAO,EAAE,gBAAgB,EAAE,aAAa,EAAE,MAAM,kCAAkC,CAAC;AAUnF,MAAM,OAAO,aAAc,SAAQ,eAAqC;IAE/D,MAAM,CAAO,KAAK,CAAC,OAA6B;;YACrD,OAAO,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC;YACpC,MAAM,OAAO,CAAC,0BAA0B,CAAC,OAAO,CAAC,aAAa,CAAC,SAAS,EAAE,OAAO,CAAC,UAAU,CAAC,CAAC;YAE9F,KAAK,MAAM,MAAM,IAAI,OAAO,CAAC,UAAU,CAAC,OAAO,EAAE,CAAC;gBAChD,IAAI,UAAU,IAAI,MAAM,IAAI,MAAM,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;oBAC1D,6BAA6B,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;gBACjD,CAAC;YACH,CAAC;YAED,OAAO,IAAI,aAAa,CAAC,OAAO,CAAC,CAAC;QACpC,CAAC;KAAA;IAEM,MAAM,CAAO,MAAM,CAAC,OAA6B;;;YACtD,MAAM,UAAU,GAA4B;gBAC1C,SAAS,EAAU,gBAAgB,CAAC,QAAQ;gBAC5C,MAAM,EAAa,aAAa,CAAC,KAAK;gBACtC,OAAO,EAAY,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,QAAQ,CAAC,gBAAgB,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE;gBACpF,gBAAgB,EAAG,MAAA,OAAO,CAAC,gBAAgB,mCAAI,IAAI,CAAC,mBAAmB,EAAE;gBACzE,MAAM,EAAa,OAAO,CAAC,MAAM;aAClC,CAAC;YAEF,yBAAyB,CAAC,UAAU,CAAC,CAAC;YAEtC,MAAM,EAAE,iBAAiB,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC;YAC9C,MAAM,aAAa,GAAG,MAAM,OAAO,CAAC,mBAAmB,CAAC;gBACtD,UAAU;gBACV,MAAM;gBACN,iBAAiB;aAClB,CAAC,CAAC;YAEH,MAAM,OAAO,GAAG,EAAE,UAAU,EAAE,aAAa,EAAE,CAAC;YAE9C,OAAO,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC;YAEpC,OAAO,IAAI,aAAa,CAAC,OAAO,CAAC,CAAC;QACpC,CAAC;KAAA;CACF"}

package/dist/esm/src/interfaces/messages-read.js

@@ -0,0 +1,61 @@
+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());
+    });
+};
+import { AbstractMessage } from '../core/abstract-message.js';
+import { Cid } from '../utils/cid.js';
+import { Message } from '../core/message.js';
+import { Time } from '../utils/time.js';
+import { DwnError, DwnErrorCode } from '../core/dwn-error.js';
+import { DwnInterfaceName, DwnMethodName } from '../enums/dwn-interface-method.js';
+export class MessagesRead extends AbstractMessage {
+    static parse(message) {
+        return __awaiter(this, void 0, void 0, function* () {
+            Message.validateJsonSchema(message);
+            this.validateMessageCid(message.descriptor.messageCid);
+            yield Message.validateSignatureStructure(message.authorization.signature, message.descriptor);
+            Time.validateTimestamp(message.descriptor.messageTimestamp);
+            return new MessagesRead(message);
+        });
+    }
+    static create(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a;
+            const descriptor = {
+                interface: DwnInterfaceName.Messages,
+                method: DwnMethodName.Read,
+                messageCid: options.messageCid,
+                messageTimestamp: (_a = options.messageTimestamp) !== null && _a !== void 0 ? _a : Time.getCurrentTimestamp(),
+            };
+            const { signer, permissionGrantId } = options;
+            const authorization = yield Message.createAuthorization({
+                descriptor,
+                signer,
+                permissionGrantId,
+            });
+            const message = { descriptor, authorization };
+            Message.validateJsonSchema(message);
+            MessagesRead.validateMessageCid(options.messageCid);
+            return new MessagesRead(message);
+        });
+    }
+    /**
+     * validates the provided cid
+     * @param messageCid - the cid in question
+     * @throws {DwnError} if an invalid cid is found.
+     */
+    static validateMessageCid(messageCid) {
+        try {
+            Cid.parseCid(messageCid);
+        }
+        catch (_) {
+            throw new DwnError(DwnErrorCode.MessagesReadInvalidCid, `${messageCid} is not a valid CID`);
+        }
+    }
+}
+//# sourceMappingURL=messages-read.js.map

package/dist/esm/src/interfaces/messages-read.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"messages-read.js","sourceRoot":"","sources":["../../../../src/interfaces/messages-read.ts"],"names":[],"mappings":";;;;;;;;;AAGA,OAAO,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC;AAC9D,OAAO,EAAE,GAAG,EAAE,MAAM,iBAAiB,CAAC;AACtC,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAC7C,OAAO,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AACxC,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AAC9D,OAAO,EAAE,gBAAgB,EAAE,aAAa,EAAE,MAAM,kCAAkC,CAAC;AASnF,MAAM,OAAO,YAAa,SAAQ,eAAoC;IAC7D,MAAM,CAAO,KAAK,CAAC,OAA4B;;YACpD,OAAO,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC;YACpC,IAAI,CAAC,kBAAkB,CAAC,OAAO,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;YAEvD,MAAM,OAAO,CAAC,0BAA0B,CAAC,OAAO,CAAC,aAAa,CAAC,SAAS,EAAE,OAAO,CAAC,UAAU,CAAC,CAAC;YAC9F,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,UAAU,CAAC,gBAAgB,CAAC,CAAC;YAE5D,OAAO,IAAI,YAAY,CAAC,OAAO,CAAC,CAAC;QACnC,CAAC;KAAA;IAEM,MAAM,CAAO,MAAM,CAAC,OAA4B;;;YACrD,MAAM,UAAU,GAA2B;gBACzC,SAAS,EAAU,gBAAgB,CAAC,QAAQ;gBAC5C,MAAM,EAAa,aAAa,CAAC,IAAI;gBACrC,UAAU,EAAS,OAAO,CAAC,UAAU;gBACrC,gBAAgB,EAAG,MAAA,OAAO,CAAC,gBAAgB,mCAAI,IAAI,CAAC,mBAAmB,EAAE;aAC1E,CAAC;YAEF,MAAM,EAAE,MAAM,EAAE,iBAAiB,EAAE,GAAG,OAAO,CAAC;YAC9C,MAAM,aAAa,GAAG,MAAM,OAAO,CAAC,mBAAmB,CAAC;gBACtD,UAAU;gBACV,MAAM;gBACN,iBAAiB;aAClB,CAAC,CAAC;YACH,MAAM,OAAO,GAAG,EAAE,UAAU,EAAE,aAAa,EAAE,CAAC;YAE9C,OAAO,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC;YACpC,YAAY,CAAC,kBAAkB,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;YAEpD,OAAO,IAAI,YAAY,CAAC,OAAO,CAAC,CAAC;QACnC,CAAC;KAAA;IAED;;;;OAIG;IACK,MAAM,CAAC,kBAAkB,CAAC,UAAkB;QAClD,IAAI,CAAC;YACH,GAAG,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;QAC3B,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,MAAM,IAAI,QAAQ,CAAC,YAAY,CAAC,sBAAsB,EAAE,GAAG,UAAU,qBAAqB,CAAC,CAAC;QAC9F,CAAC;IACH,CAAC;CACF"}

package/dist/esm/src/interfaces/messages-subscribe.js

@@ -0,0 +1,58 @@
+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());
+    });
+};
+import { AbstractMessage } from '../core/abstract-message.js';
+import { Message } from '../core/message.js';
+import { removeUndefinedProperties } from '../utils/object.js';
+import { Time } from '../utils/time.js';
+import { validateProtocolUrlNormalized } from '../utils/url.js';
+import { DwnInterfaceName, DwnMethodName } from '../enums/dwn-interface-method.js';
+export class MessagesSubscribe extends AbstractMessage {
+    static parse(message) {
+        return __awaiter(this, void 0, void 0, function* () {
+            Message.validateJsonSchema(message);
+            yield Message.validateSignatureStructure(message.authorization.signature, message.descriptor);
+            for (const filter of message.descriptor.filters) {
+                if ('protocol' in filter && filter.protocol !== undefined) {
+                    validateProtocolUrlNormalized(filter.protocol);
+                }
+            }
+            Time.validateTimestamp(message.descriptor.messageTimestamp);
+            return new MessagesSubscribe(message);
+        });
+    }
+    /**
+     * Creates a MessagesSubscribe message.
+     *
+     * @throws {DwnError} if json schema validation fails.
+     */
+    static create(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b;
+            const currentTime = Time.getCurrentTimestamp();
+            const descriptor = {
+                interface: DwnInterfaceName.Messages,
+                method: DwnMethodName.Subscribe,
+                filters: (_a = options.filters) !== null && _a !== void 0 ? _a : [],
+                messageTimestamp: (_b = options.messageTimestamp) !== null && _b !== void 0 ? _b : currentTime,
+            };
+            removeUndefinedProperties(descriptor);
+            const { permissionGrantId, signer } = options;
+            const authorization = yield Message.createAuthorization({
+                descriptor,
+                signer,
+                permissionGrantId
+            });
+            const message = { descriptor, authorization };
+            Message.validateJsonSchema(message);
+            return new MessagesSubscribe(message);
+        });
+    }
+}
+//# sourceMappingURL=messages-subscribe.js.map

package/dist/esm/src/interfaces/messages-subscribe.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"messages-subscribe.js","sourceRoot":"","sources":["../../../../src/interfaces/messages-subscribe.ts"],"names":[],"mappings":";;;;;;;;;AAIA,OAAO,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC;AAC9D,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAC7C,OAAO,EAAE,yBAAyB,EAAE,MAAM,oBAAoB,CAAC;AAC/D,OAAO,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AACxC,OAAO,EAAE,6BAA6B,EAAE,MAAM,iBAAiB,CAAC;AAChE,OAAO,EAAE,gBAAgB,EAAE,aAAa,EAAE,MAAM,kCAAkC,CAAC;AAUnF,MAAM,OAAO,iBAAkB,SAAQ,eAAyC;IACvE,MAAM,CAAO,KAAK,CAAC,OAAiC;;YACzD,OAAO,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC;YACpC,MAAM,OAAO,CAAC,0BAA0B,CAAC,OAAO,CAAC,aAAa,CAAC,SAAS,EAAE,OAAO,CAAC,UAAU,CAAC,CAAC;YAE9F,KAAK,MAAM,MAAM,IAAI,OAAO,CAAC,UAAU,CAAC,OAAO,EAAE,CAAC;gBAChD,IAAI,UAAU,IAAI,MAAM,IAAI,MAAM,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;oBAC1D,6BAA6B,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;gBACjD,CAAC;YACH,CAAC;YAED,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,UAAU,CAAC,gBAAgB,CAAC,CAAC;YAC5D,OAAO,IAAI,iBAAiB,CAAC,OAAO,CAAC,CAAC;QACxC,CAAC;KAAA;IAED;;;;OAIG;IACI,MAAM,CAAO,MAAM,CACxB,OAAiC;;;YAEjC,MAAM,WAAW,GAAG,IAAI,CAAC,mBAAmB,EAAE,CAAC;YAE/C,MAAM,UAAU,GAAgC;gBAC9C,SAAS,EAAU,gBAAgB,CAAC,QAAQ;gBAC5C,MAAM,EAAa,aAAa,CAAC,SAAS;gBAC1C,OAAO,EAAY,MAAA,OAAO,CAAC,OAAO,mCAAI,EAAE;gBACxC,gBAAgB,EAAG,MAAA,OAAO,CAAC,gBAAgB,mCAAI,WAAW;aAC3D,CAAC;YAEF,yBAAyB,CAAC,UAAU,CAAC,CAAC;YACtC,MAAM,EAAE,iBAAiB,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC;YAC9C,MAAM,aAAa,GAAG,MAAM,OAAO,CAAC,mBAAmB,CAAC;gBACtD,UAAU;gBACV,MAAM;gBACN,iBAAiB;aAClB,CAAC,CAAC;YAEH,MAAM,OAAO,GAA6B,EAAE,UAAU,EAAE,aAAa,EAAE,CAAC;YACxE,OAAO,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC;YACpC,OAAO,IAAI,iBAAiB,CAAC,OAAO,CAAC,CAAC;QACxC,CAAC;KAAA;CACF"}

package/dist/esm/src/interfaces/protocols-configure.js

@@ -0,0 +1,271 @@
+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 __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;
+};
+import { AbstractMessage } from '../core/abstract-message.js';
+import Ajv from 'ajv/dist/2020.js';
+import { Message } from '../core/message.js';
+import { PermissionGrant } from '../protocols/permission-grant.js';
+import { ProtocolsGrantAuthorization } from '../core/protocols-grant-authorization.js';
+import { Time } from '../utils/time.js';
+import { DwnError, DwnErrorCode } from '../core/dwn-error.js';
+import { DwnInterfaceName, DwnMethodName } from '../enums/dwn-interface-method.js';
+import { normalizeProtocolUrl, normalizeSchemaUrl, validateProtocolUrlNormalized, validateSchemaUrlNormalized } from '../utils/url.js';
+import { ProtocolAction, ProtocolActor } from '../types/protocols-types.js';
+export class ProtocolsConfigure extends AbstractMessage {
+    static parse(message) {
+        return __awaiter(this, void 0, void 0, function* () {
+            Message.validateJsonSchema(message);
+            ProtocolsConfigure.validateProtocolDefinition(message.descriptor.definition);
+            yield Message.validateSignatureStructure(message.authorization.signature, message.descriptor);
+            Time.validateTimestamp(message.descriptor.messageTimestamp);
+            return new ProtocolsConfigure(message);
+        });
+    }
+    static create(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a;
+            const descriptor = {
+                interface: DwnInterfaceName.Protocols,
+                method: DwnMethodName.Configure,
+                messageTimestamp: (_a = options.messageTimestamp) !== null && _a !== void 0 ? _a : Time.getCurrentTimestamp(),
+                definition: ProtocolsConfigure.normalizeDefinition(options.definition)
+            };
+            const authorization = yield Message.createAuthorization({
+                descriptor,
+                signer: options.signer,
+                delegatedGrant: options.delegatedGrant,
+                permissionGrantId: options.permissionGrantId
+            });
+            const message = { descriptor, authorization };
+            Message.validateJsonSchema(message);
+            ProtocolsConfigure.validateProtocolDefinition(message.descriptor.definition);
+            const protocolsConfigure = new ProtocolsConfigure(message);
+            return protocolsConfigure;
+        });
+    }
+    /**
+     * Authorizes the author-delegate who signed this message.
+     * @param messageStore Used to check if the grant has been revoked.
+     */
+    authorizeAuthorDelegate(messageStore) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const delegatedGrant = yield PermissionGrant.parse(this.message.authorization.authorDelegatedGrant);
+            yield ProtocolsGrantAuthorization.authorizeConfigure({
+                protocolsConfigureMessage: this.message,
+                expectedGrantor: this.author,
+                expectedGrantee: this.signer,
+                permissionGrant: delegatedGrant,
+                messageStore
+            });
+        });
+    }
+    /**
+     * Performs validation on the given protocol definition that are not easy to do using a JSON schema.
+     */
+    static validateProtocolDefinition(definition) {
+        const { protocol, types } = definition;
+        // validate protocol url
+        validateProtocolUrlNormalized(protocol);
+        // validate schema url normalized
+        for (const typeName in types) {
+            const schema = types[typeName].schema;
+            if (schema !== undefined) {
+                validateSchemaUrlNormalized(schema);
+            }
+        }
+        // validate `structure
+        ProtocolsConfigure.validateStructure(definition);
+    }
+    static validateStructure(definition) {
+        // gather all declared record types
+        const recordTypes = Object.keys(definition.types);
+        // gather all roles
+        const roles = ProtocolsConfigure.fetchAllRolePathsRecursively('', definition.structure, []);
+        // validate the entire rule set structure recursively
+        ProtocolsConfigure.validateRuleSetRecursively({
+            ruleSet: definition.structure,
+            ruleSetProtocolPath: '',
+            recordTypes,
+            roles
+        });
+    }
+    /**
+     * Parses the given rule set hierarchy to get all the role protocol paths.
+     * @throws DwnError if the hierarchy depth goes beyond 10 levels.
+     */
+    static fetchAllRolePathsRecursively(ruleSetProtocolPath, ruleSet, roles) {
+        // Limit the depth of the record hierarchy to 10 levels
+        // There is opportunity to optimize here to avoid repeated string splitting
+        if (ruleSetProtocolPath.split('/').length > 10) {
+            throw new DwnError(DwnErrorCode.ProtocolsConfigureRecordNestingDepthExceeded, 'Record nesting depth exceeded 10 levels.');
+        }
+        for (const recordType in ruleSet) {
+            // ignore non-nested-record properties
+            if (recordType.startsWith('$')) {
+                continue;
+            }
+            const childRuleSet = ruleSet[recordType];
+            let childRuleSetProtocolPath;
+            if (ruleSetProtocolPath === '') {
+                childRuleSetProtocolPath = recordType;
+            }
+            else {
+                childRuleSetProtocolPath = `${ruleSetProtocolPath}/${recordType}`;
+            }
+            // if this is a role record, add it to the list, else continue to traverse
+            if (childRuleSet.$role) {
+                roles.push(childRuleSetProtocolPath);
+            }
+            else {
+                ProtocolsConfigure.fetchAllRolePathsRecursively(childRuleSetProtocolPath, childRuleSet, roles);
+            }
+        }
+        return roles;
+    }
+    /**
+     * Validates the given rule set structure then recursively validates its nested child rule sets.
+     */
+    static validateRuleSetRecursively(input) {
+        var _a;
+        const { ruleSet, ruleSetProtocolPath, recordTypes, roles } = input;
+        // Validate $actions in the rule set
+        if (ruleSet.$size !== undefined) {
+            const { min = 0, max } = ruleSet.$size;
+            if (max !== undefined && max < min) {
+                throw new DwnError(DwnErrorCode.ProtocolsConfigureInvalidSize, `Invalid size range found: max limit ${max} less than min limit ${min} at protocol path '${ruleSetProtocolPath}'`);
+            }
+        }
+        if (ruleSet.$tags) {
+            const ajv = new Ajv.default();
+            const _b = ruleSet.$tags, { $allowUndefinedTags, $requiredTags } = _b, tagProperties = __rest(_b, ["$allowUndefinedTags", "$requiredTags"]);
+            // we validate each tag's expected schema to ensure it is a valid JSON schema
+            for (const tag in tagProperties) {
+                const tagSchemaDefinition = tagProperties[tag];
+                if (!ajv.validateSchema(tagSchemaDefinition)) {
+                    const schemaError = ajv.errorsText(ajv.errors, { dataVar: `${ruleSetProtocolPath}/$tags/${tag}` });
+                    throw new DwnError(DwnErrorCode.ProtocolsConfigureInvalidTagSchema, `tags schema validation error: ${schemaError}`);
+                }
+            }
+        }
+        // validate each action rule
+        const actionRules = (_a = ruleSet.$actions) !== null && _a !== void 0 ? _a : [];
+        for (let i = 0; i < actionRules.length; i++) {
+            const actionRule = actionRules[i];
+            // Validate the `role` property of an `action` if exists.
+            if (actionRule.role !== undefined) {
+                // make sure the role contains a valid protocol paths to a role record
+                if (!roles.includes(actionRule.role)) {
+                    throw new DwnError(DwnErrorCode.ProtocolsConfigureRoleDoesNotExistAtGivenPath, `Role in action ${JSON.stringify(actionRule)} for rule set ${ruleSetProtocolPath} does not exist.`);
+                }
+                else {
+                    // it is a role record, we ensure that if any of the `can` actions are 'read' type of actions ('read', 'query', 'subscribe'),
+                    // that they are all present.
+                    const readActions = [ProtocolAction.Read, ProtocolAction.Query, ProtocolAction.Subscribe];
+                    if (readActions.find(action => actionRule.can.includes(action)) && !readActions.every(action => actionRule.can.includes(action))) {
+                        throw new DwnError(DwnErrorCode.ProtocolsConfigureRoleReadActionMissing, `Role in action ${JSON.stringify(actionRule)} for rule set ${ruleSetProtocolPath} must contain all read actions (${readActions.join(', ')}).`);
+                    }
+                }
+            }
+            // Validate that if `who` is set to `anyone` then `of` is not set
+            if (actionRule.who === 'anyone' && actionRule.of) {
+                throw new DwnError(DwnErrorCode.ProtocolsConfigureInvalidActionOfNotAllowed, `'of' is not allowed at rule set protocol path (${ruleSetProtocolPath})`);
+            }
+            // Validate that if `who === recipient` and `of === undefined`, then `can` can only contain `co-update`, `co-delete`, and `co-prune`.
+            // We do not allow `read`, `write`, or `query` in the `can` array because:
+            // - `read` - Recipients are always allowed to `read`.
+            // - `write` - Entails ability to create and update.
+            //             Since `of` is undefined, it implies the recipient of THIS record,
+            //             there is no 'recipient' until this record has been created, so it makes no sense to allow recipient to write this record.
+            // - `query` - Only authorized using roles, so allowing direct recipients to query is outside the scope.
+            if (actionRule.who === ProtocolActor.Recipient && actionRule.of === undefined) {
+                // throw if `can` contains a value that is not `co-update`, `co-delete`, or `co-prune`
+                const hasDisallowedAction = actionRule.can.some(action => ![ProtocolAction.CoUpdate, ProtocolAction.CoDelete, ProtocolAction.CoPrune].includes(action));
+                if (hasDisallowedAction) {
+                    throw new DwnError(DwnErrorCode.ProtocolsConfigureInvalidRecipientOfAction, 'Rules for `recipient` without `of` property must have `can` containing only `co-update`, `co-delete`, and `co-prune`.');
+                }
+            }
+            // Validate that if `who` is set to `author` then `of` is set
+            if (actionRule.who === ProtocolActor.Author && !actionRule.of) {
+                throw new DwnError(DwnErrorCode.ProtocolsConfigureInvalidActionMissingOf, `'of' is required when 'author' is specified as 'who'`);
+            }
+            // validate that if `can` contains `update` or `delete`, it must also contain `create`
+            if (actionRule.can !== undefined) {
+                if (actionRule.can.includes(ProtocolAction.Update) && !actionRule.can.includes(ProtocolAction.Create)) {
+                    throw new DwnError(DwnErrorCode.ProtocolsConfigureInvalidActionUpdateWithoutCreate, `Action rule ${JSON.stringify(actionRule)} contains 'update' action but missing the required 'create' action.`);
+                }
+                if (actionRule.can.includes(ProtocolAction.Delete) && !actionRule.can.includes(ProtocolAction.Create)) {
+                    throw new DwnError(DwnErrorCode.ProtocolsConfigureInvalidActionDeleteWithoutCreate, `Action rule ${JSON.stringify(actionRule)} contains 'delete' action but missing the required 'create' action.`);
+                }
+            }
+            // Validate that there are no duplicate actors or roles in the remaining action rules:
+            // ie. no two action rules can have the same combination of `who` + `of` or `role`.
+            // NOTE: we only need to check the remaining action rules that have yet to go through action rule validation loop, as a perf shortcut.
+            for (let j = i + 1; j < actionRules.length; j++) {
+                const otherActionRule = actionRules[j];
+                if (actionRule.who !== undefined) {
+                    if (actionRule.who === otherActionRule.who && actionRule.of === otherActionRule.of) {
+                        throw new DwnError(DwnErrorCode.ProtocolsConfigureDuplicateActorInRuleSet, `More than one action rule per actor ${actionRule.who} of ${actionRule.of} not allowed within a rule set: ${JSON.stringify(actionRule)}`);
+                    }
+                }
+                else {
+                    // else implicitly a role-based action rule
+                    if (actionRule.role === otherActionRule.role) {
+                        throw new DwnError(DwnErrorCode.ProtocolsConfigureDuplicateRoleInRuleSet, `More than one action rule per role ${actionRule.role} not allowed within a rule set: ${JSON.stringify(actionRule)}`);
+                    }
+                }
+            }
+        }
+        // Validate nested rule sets
+        for (const recordType in ruleSet) {
+            if (recordType.startsWith('$')) {
+                continue;
+            }
+            if (!recordTypes.includes(recordType)) {
+                throw new DwnError(DwnErrorCode.ProtocolsConfigureInvalidRuleSetRecordType, `Rule set ${recordType} is not declared as an allowed type in the protocol definition.`);
+            }
+            const childRuleSet = ruleSet[recordType];
+            let childRuleSetProtocolPath;
+            if (ruleSetProtocolPath === '') {
+                childRuleSetProtocolPath = recordType; // case of initial definition structure
+            }
+            else {
+                childRuleSetProtocolPath = `${ruleSetProtocolPath}/${recordType}`;
+            }
+            ProtocolsConfigure.validateRuleSetRecursively({
+                ruleSet: childRuleSet,
+                ruleSetProtocolPath: childRuleSetProtocolPath,
+                recordTypes,
+                roles
+            });
+        }
+    }
+    static normalizeDefinition(definition) {
+        const typesCopy = Object.assign({}, definition.types);
+        // Normalize schema url
+        for (const typeName in typesCopy) {
+            const schema = typesCopy[typeName].schema;
+            if (schema !== undefined) {
+                typesCopy[typeName].schema = normalizeSchemaUrl(schema);
+            }
+        }
+        return Object.assign(Object.assign({}, definition), { protocol: normalizeProtocolUrl(definition.protocol), types: typesCopy });
+    }
+}
+//# sourceMappingURL=protocols-configure.js.map

package/dist/esm/src/interfaces/protocols-configure.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"protocols-configure.js","sourceRoot":"","sources":["../../../../src/interfaces/protocols-configure.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;AAKA,OAAO,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC;AAC9D,OAAO,GAAG,MAAM,kBAAkB,CAAC;AACnC,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAC7C,OAAO,EAAE,eAAe,EAAE,MAAM,kCAAkC,CAAC;AACnE,OAAO,EAAE,2BAA2B,EAAE,MAAM,0CAA0C,CAAC;AACvF,OAAO,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AACxC,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AAC9D,OAAO,EAAE,gBAAgB,EAAE,aAAa,EAAE,MAAM,kCAAkC,CAAC;AACnF,OAAO,EAAE,oBAAoB,EAAE,kBAAkB,EAAE,6BAA6B,EAAE,2BAA2B,EAAE,MAAM,iBAAiB,CAAC;AACvI,OAAO,EAAE,cAAc,EAAE,aAAa,EAAE,MAAM,6BAA6B,CAAC;AAa5E,MAAM,OAAO,kBAAmB,SAAQ,eAA0C;IACzE,MAAM,CAAO,KAAK,CAAC,OAAkC;;YAC1D,OAAO,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC;YACpC,kBAAkB,CAAC,0BAA0B,CAAC,OAAO,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;YAC7E,MAAM,OAAO,CAAC,0BAA0B,CAAC,OAAO,CAAC,aAAa,CAAC,SAAS,EAAE,OAAO,CAAC,UAAU,CAAC,CAAC;YAC9F,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,UAAU,CAAC,gBAAgB,CAAC,CAAC;YAE5D,OAAO,IAAI,kBAAkB,CAAC,OAAO,CAAC,CAAC;QACzC,CAAC;KAAA;IAEM,MAAM,CAAO,MAAM,CAAC,OAAkC;;;YAC3D,MAAM,UAAU,GAAiC;gBAC/C,SAAS,EAAU,gBAAgB,CAAC,SAAS;gBAC7C,MAAM,EAAa,aAAa,CAAC,SAAS;gBAC1C,gBAAgB,EAAG,MAAA,OAAO,CAAC,gBAAgB,mCAAI,IAAI,CAAC,mBAAmB,EAAE;gBACzE,UAAU,EAAS,kBAAkB,CAAC,mBAAmB,CAAC,OAAO,CAAC,UAAU,CAAC;aAC9E,CAAC;YAEF,MAAM,aAAa,GAAG,MAAM,OAAO,CAAC,mBAAmB,CAAC;gBACtD,UAAU;gBACV,MAAM,EAAc,OAAO,CAAC,MAAM;gBAClC,cAAc,EAAM,OAAO,CAAC,cAAc;gBAC1C,iBAAiB,EAAG,OAAO,CAAC,iBAAiB;aAC9C,CAAC,CAAC;YACH,MAAM,OAAO,GAAG,EAAE,UAAU,EAAE,aAAa,EAAE,CAAC;YAE9C,OAAO,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC;YACpC,kBAAkB,CAAC,0BAA0B,CAAC,OAAO,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;YAE7E,MAAM,kBAAkB,GAAG,IAAI,kBAAkB,CAAC,OAAO,CAAC,CAAC;YAC3D,OAAO,kBAAkB,CAAC;QAC5B,CAAC;KAAA;IAED;;;OAGG;IACU,uBAAuB,CAAC,YAA0B;;YAC7D,MAAM,cAAc,GAAG,MAAM,eAAe,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,oBAAqB,CAAC,CAAC;YACrG,MAAM,2BAA2B,CAAC,kBAAkB,CAAC;gBACnD,yBAAyB,EAAG,IAAI,CAAC,OAAO;gBACxC,eAAe,EAAa,IAAI,CAAC,MAAO;gBACxC,eAAe,EAAa,IAAI,CAAC,MAAO;gBACxC,eAAe,EAAa,cAAc;gBAC1C,YAAY;aACb,CAAC,CAAC;QACL,CAAC;KAAA;IAED;;OAEG;IACK,MAAM,CAAC,0BAA0B,CAAC,UAA8B;QACtE,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,GAAG,UAAU,CAAC;QAEvC,wBAAwB;QACxB,6BAA6B,CAAC,QAAQ,CAAC,CAAC;QAExC,iCAAiC;QACjC,KAAK,MAAM,QAAQ,IAAI,KAAK,EAAE,CAAC;YAC7B,MAAM,MAAM,GAAG,KAAK,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC;YACtC,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;gBACzB,2BAA2B,CAAC,MAAM,CAAC,CAAC;YACtC,CAAC;QACH,CAAC;QAED,sBAAsB;QACtB,kBAAkB,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAAC;IACnD,CAAC;IAEO,MAAM,CAAC,iBAAiB,CAAC,UAA8B;QAE7D,mCAAmC;QACnC,MAAM,WAAW,GAAG,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;QAElD,mBAAmB;QACnB,MAAM,KAAK,GAAG,kBAAkB,CAAC,4BAA4B,CAAC,EAAE,EAAE,UAAU,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;QAE5F,qDAAqD;QACrD,kBAAkB,CAAC,0BAA0B,CAAC;YAC5C,OAAO,EAAe,UAAU,CAAC,SAAS;YAC1C,mBAAmB,EAAG,EAAE;YACxB,WAAW;YACX,KAAK;SACN,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACK,MAAM,CAAC,4BAA4B,CAAC,mBAA2B,EAAE,OAAwB,EAAE,KAAe;QAChH,uDAAuD;QACvD,2EAA2E;QAC3E,IAAI,mBAAmB,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,GAAG,EAAE,EAAE,CAAC;YAC/C,MAAM,IAAI,QAAQ,CAAC,YAAY,CAAC,4CAA4C,EAAE,0CAA0C,CAAC,CAAC;QAC5H,CAAC;QAED,KAAK,MAAM,UAAU,IAAI,OAAO,EAAE,CAAC;YACjC,sCAAsC;YACtC,IAAI,UAAU,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;gBAC/B,SAAS;YACX,CAAC;YAED,MAAM,YAAY,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;YAEzC,IAAI,wBAAwB,CAAC;YAC7B,IAAI,mBAAmB,KAAK,EAAE,EAAE,CAAC;gBAC/B,wBAAwB,GAAG,UAAU,CAAC;YACxC,CAAC;iBAAM,CAAC;gBACN,wBAAwB,GAAG,GAAG,mBAAmB,IAAI,UAAU,EAAE,CAAC;YACpE,CAAC;YAED,0EAA0E;YAC1E,IAAI,YAAY,CAAC,KAAK,EAAE,CAAC;gBACvB,KAAK,CAAC,IAAI,CAAC,wBAAwB,CAAC,CAAC;YACvC,CAAC;iBAAM,CAAC;gBACN,kBAAkB,CAAC,4BAA4B,CAAC,wBAAwB,EAAE,YAAY,EAAE,KAAK,CAAC,CAAC;YACjG,CAAC;QACH,CAAC;QAED,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;OAEG;IACK,MAAM,CAAC,0BAA0B,CACvC,KAAwG;;QAExG,MAAM,EAAE,OAAO,EAAE,mBAAmB,EAAE,WAAW,EAAE,KAAK,EAAE,GAAG,KAAK,CAAC;QAEnE,oCAAoC;QACpC,IAAI,OAAO,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;YAChC,MAAM,EAAE,GAAG,GAAG,CAAC,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC,KAAK,CAAC;YAEvC,IAAI,GAAG,KAAK,SAAS,IAAI,GAAG,GAAG,GAAG,EAAE,CAAC;gBACnC,MAAM,IAAI,QAAQ,CAChB,YAAY,CAAC,6BAA6B,EAC1C,uCAAuC,GAAG,wBAAwB,GAAG,sBAAsB,mBAAmB,GAAG,CAClH,CAAC;YACJ,CAAC;QACH,CAAC;QAED,IAAI,OAAO,CAAC,KAAK,EAAE,CAAC;YAClB,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,OAAO,EAAE,CAAC;YAC9B,MAAM,KAA2D,OAAO,CAAC,KAAK,EAAxE,EAAE,mBAAmB,EAAE,aAAa,OAAoC,EAA/B,aAAa,cAAtD,wCAAwD,CAAgB,CAAC;YAE/E,6EAA6E;YAC7E,KAAK,MAAM,GAAG,IAAI,aAAa,EAAE,CAAC;gBAChC,MAAM,mBAAmB,GAAG,aAAa,CAAC,GAAG,CAAC,CAAC;gBAE/C,IAAI,CAAC,GAAG,CAAC,cAAc,CAAC,mBAAmB,CAAC,EAAE,CAAC;oBAC7C,MAAM,WAAW,GAAG,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,MAAM,EAAE,EAAE,OAAO,EAAE,GAAG,mBAAmB,UAAU,GAAG,EAAE,EAAE,CAAC,CAAC;oBACnG,MAAM,IAAI,QAAQ,CAAC,YAAY,CAAC,kCAAkC,EAAE,iCAAiC,WAAW,EAAE,CAAC,CAAC;gBACtH,CAAC;YACH,CAAC;QACH,CAAC;QAED,4BAA4B;QAC5B,MAAM,WAAW,GAAG,MAAA,OAAO,CAAC,QAAQ,mCAAI,EAAE,CAAC;QAC3C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,WAAW,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YAC5C,MAAM,UAAU,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC;YAElC,yDAAyD;YACzD,IAAI,UAAU,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;gBAClC,sEAAsE;gBACtE,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;oBACrC,MAAM,IAAI,QAAQ,CAChB,YAAY,CAAC,6CAA6C,EAC1D,kBAAkB,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,iBAAiB,mBAAmB,kBAAkB,CACnG,CAAC;gBACJ,CAAC;qBAAM,CAAC;oBACN,6HAA6H;oBAC7H,6BAA6B;oBAC7B,MAAM,WAAW,GAAG,CAAC,cAAc,CAAC,IAAI,EAAE,cAAc,CAAC,KAAK,EAAE,cAAc,CAAC,SAAS,CAAC,CAAC;oBAC1F,IAAI,WAAW,CAAC,IAAI,CAAE,MAAM,CAAC,EAAE,CAAC,UAAU,CAAC,GAAG,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC,UAAU,CAAC,GAAG,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC;wBAClI,MAAM,IAAI,QAAQ,CAChB,YAAY,CAAC,uCAAuC,EACpD,kBAAkB,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,iBAAiB,mBAAmB,mCAAmC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAC9I,CAAC;oBACJ,CAAC;gBACH,CAAC;YACH,CAAC;YAED,iEAAiE;YACjE,IAAI,UAAU,CAAC,GAAG,KAAK,QAAQ,IAAI,UAAU,CAAC,EAAE,EAAE,CAAC;gBACjD,MAAM,IAAI,QAAQ,CAChB,YAAY,CAAC,2CAA2C,EACxD,kDAAkD,mBAAmB,GAAG,CACzE,CAAC;YACJ,CAAC;YAED,qIAAqI;YACrI,0EAA0E;YAC1E,sDAAsD;YACtD,oDAAoD;YACpD,gFAAgF;YAChF,wIAAwI;YACxI,wGAAwG;YACxG,IAAI,UAAU,CAAC,GAAG,KAAK,aAAa,CAAC,SAAS,IAAI,UAAU,CAAC,EAAE,KAAK,SAAS,EAAE,CAAC;gBAE9E,sFAAsF;gBACtF,MAAM,mBAAmB,GAAG,UAAU,CAAC,GAAG,CAAC,IAAI,CAC7C,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,cAAc,CAAC,QAAQ,EAAE,cAAc,CAAC,QAAQ,EAAE,cAAc,CAAC,OAAO,CAAC,CAAC,QAAQ,CAAC,MAAwB,CAAC,CACzH,CAAC;gBACF,IAAI,mBAAmB,EAAE,CAAC;oBACxB,MAAM,IAAI,QAAQ,CAChB,YAAY,CAAC,0CAA0C,EACvD,uHAAuH,CACxH,CAAC;gBACJ,CAAC;YACH,CAAC;YAED,6DAA6D;YAC7D,IAAI,UAAU,CAAC,GAAG,KAAK,aAAa,CAAC,MAAM,IAAI,CAAC,UAAU,CAAC,EAAE,EAAE,CAAC;gBAC9D,MAAM,IAAI,QAAQ,CAChB,YAAY,CAAC,wCAAwC,EACrD,sDAAsD,CACvD,CAAC;YACJ,CAAC;YAED,sFAAsF;YACtF,IAAI,UAAU,CAAC,GAAG,KAAK,SAAS,EAAE,CAAC;gBACjC,IAAI,UAAU,CAAC,GAAG,CAAC,QAAQ,CAAC,cAAc,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,QAAQ,CAAC,cAAc,CAAC,MAAM,CAAC,EAAE,CAAC;oBACtG,MAAM,IAAI,QAAQ,CAChB,YAAY,CAAC,kDAAkD,EAC/D,eAAe,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,qEAAqE,CAC/G,CAAC;gBACJ,CAAC;gBAED,IAAI,UAAU,CAAC,GAAG,CAAC,QAAQ,CAAC,cAAc,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,QAAQ,CAAC,cAAc,CAAC,MAAM,CAAC,EAAE,CAAC;oBACtG,MAAM,IAAI,QAAQ,CAChB,YAAY,CAAC,kDAAkD,EAC/D,eAAe,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,qEAAqE,CAC/G,CAAC;gBACJ,CAAC;YACH,CAAC;YAED,sFAAsF;YACtF,mFAAmF;YACnF,sIAAsI;YACtI,KAAK,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,WAAW,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;gBAChD,MAAM,eAAe,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC;gBAEvC,IAAI,UAAU,CAAC,GAAG,KAAK,SAAS,EAAE,CAAC;oBACjC,IAAI,UAAU,CAAC,GAAG,KAAK,eAAe,CAAC,GAAG,IAAI,UAAU,CAAC,EAAE,KAAK,eAAe,CAAC,EAAE,EAAE,CAAC;wBACnF,MAAM,IAAI,QAAQ,CAChB,YAAY,CAAC,yCAAyC,EACtD,uCAAuC,UAAU,CAAC,GAAG,OAAO,UAAU,CAAC,EAAE,mCAAmC,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,EAAE,CACzI,CAAC;oBACJ,CAAC;gBACH,CAAC;qBAAM,CAAC;oBACN,2CAA2C;oBAE3C,IAAI,UAAU,CAAC,IAAI,KAAK,eAAe,CAAC,IAAI,EAAE,CAAC;wBAC7C,MAAM,IAAI,QAAQ,CAChB,YAAY,CAAC,wCAAwC,EACrD,sCAAsC,UAAU,CAAC,IAAI,mCAAmC,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,EAAE,CACrH,CAAC;oBACJ,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;QAED,4BAA4B;QAC5B,KAAK,MAAM,UAAU,IAAI,OAAO,EAAE,CAAC;YACjC,IAAI,UAAU,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;gBAC/B,SAAS;YACX,CAAC;YAED,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC;gBACtC,MAAM,IAAI,QAAQ,CAChB,YAAY,CAAC,0CAA0C,EACvD,YAAY,UAAU,iEAAiE,CACxF,CAAC;YACJ,CAAC;YAED,MAAM,YAAY,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;YAEzC,IAAI,wBAAwB,CAAC;YAC7B,IAAI,mBAAmB,KAAK,EAAE,EAAE,CAAC;gBAC/B,wBAAwB,GAAG,UAAU,CAAC,CAAC,uCAAuC;YAChF,CAAC;iBAAM,CAAC;gBACN,wBAAwB,GAAG,GAAG,mBAAmB,IAAI,UAAU,EAAE,CAAC;YACpE,CAAC;YAED,kBAAkB,CAAC,0BAA0B,CAAC;gBAC5C,OAAO,EAAe,YAAY;gBAClC,mBAAmB,EAAG,wBAAwB;gBAC9C,WAAW;gBACX,KAAK;aACN,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAEO,MAAM,CAAC,mBAAmB,CAAC,UAA8B;QAC/D,MAAM,SAAS,qBAAQ,UAAU,CAAC,KAAK,CAAE,CAAC;QAE1C,uBAAuB;QACvB,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;YACjC,MAAM,MAAM,GAAG,SAAS,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC;YAC1C,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;gBACzB,SAAS,CAAC,QAAQ,CAAC,CAAC,MAAM,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAC;YAC1D,CAAC;QACH,CAAC;QAED,uCACK,UAAU,KACb,QAAQ,EAAG,oBAAoB,CAAC,UAAU,CAAC,QAAQ,CAAC,EACpD,KAAK,EAAM,SAAS,IACpB;IACJ,CAAC;CACF"}

package/dist/esm/src/interfaces/protocols-query.js

@@ -0,0 +1,84 @@
+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());
+    });
+};
+import { AbstractMessage } from '../core/abstract-message.js';
+import { Message } from '../core/message.js';
+import { PermissionsProtocol } from '../protocols/permissions.js';
+import { ProtocolsGrantAuthorization } from '../core/protocols-grant-authorization.js';
+import { removeUndefinedProperties } from '../utils/object.js';
+import { Time } from '../utils/time.js';
+import { DwnError, DwnErrorCode } from '../core/dwn-error.js';
+import { DwnInterfaceName, DwnMethodName } from '../enums/dwn-interface-method.js';
+import { normalizeProtocolUrl, validateProtocolUrlNormalized } from '../utils/url.js';
+export class ProtocolsQuery extends AbstractMessage {
+    static parse(message) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (message.authorization !== undefined) {
+                yield Message.validateSignatureStructure(message.authorization.signature, message.descriptor);
+            }
+            if (message.descriptor.filter !== undefined) {
+                validateProtocolUrlNormalized(message.descriptor.filter.protocol);
+            }
+            Time.validateTimestamp(message.descriptor.messageTimestamp);
+            return new ProtocolsQuery(message);
+        });
+    }
+    static create(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a;
+            const descriptor = {
+                interface: DwnInterfaceName.Protocols,
+                method: DwnMethodName.Query,
+                messageTimestamp: (_a = options.messageTimestamp) !== null && _a !== void 0 ? _a : Time.getCurrentTimestamp(),
+                filter: options.filter ? ProtocolsQuery.normalizeFilter(options.filter) : undefined,
+            };
+            // delete all descriptor properties that are `undefined` else the code will encounter the following IPLD issue when attempting to generate CID:
+            // Error: `undefined` is not supported by the IPLD Data Model and cannot be encoded
+            removeUndefinedProperties(descriptor);
+            // only generate the `authorization` property if signature input is given
+            let authorization;
+            if (options.signer !== undefined) {
+                authorization = yield Message.createAuthorization({
+                    descriptor,
+                    signer: options.signer,
+                    permissionGrantId: options.permissionGrantId
+                });
+            }
+            const message = { descriptor, authorization };
+            Message.validateJsonSchema(message);
+            const protocolsQuery = new ProtocolsQuery(message);
+            return protocolsQuery;
+        });
+    }
+    static normalizeFilter(filter) {
+        return Object.assign(Object.assign({}, filter), { protocol: normalizeProtocolUrl(filter.protocol) });
+    }
+    authorize(tenant, messageStore) {
+        return __awaiter(this, void 0, void 0, function* () {
+            // if author is the same as the target tenant, we can directly grant access
+            if (this.author === tenant) {
+                return;
+            }
+            else if (this.author !== undefined && this.signaturePayload.permissionGrantId) {
+                const permissionGrant = yield PermissionsProtocol.fetchGrant(tenant, messageStore, this.signaturePayload.permissionGrantId);
+                yield ProtocolsGrantAuthorization.authorizeQuery({
+                    expectedGrantor: tenant,
+                    expectedGrantee: this.author,
+                    incomingMessage: this.message,
+                    permissionGrant,
+                    messageStore
+                });
+            }
+            else {
+                throw new DwnError(DwnErrorCode.ProtocolsQueryUnauthorized, 'The ProtocolsQuery failed authorization');
+            }
+        });
+    }
+}
+//# sourceMappingURL=protocols-query.js.map

package/dist/esm/src/interfaces/protocols-query.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"protocols-query.js","sourceRoot":"","sources":["../../../../src/interfaces/protocols-query.ts"],"names":[],"mappings":";;;;;;;;;AAKA,OAAO,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC;AAC9D,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAC7C,OAAO,EAAE,mBAAmB,EAAE,MAAM,6BAA6B,CAAC;AAClE,OAAO,EAAE,2BAA2B,EAAE,MAAM,0CAA0C,CAAC;AACvF,OAAO,EAAE,yBAAyB,EAAE,MAAM,oBAAoB,CAAC;AAC/D,OAAO,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AACxC,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AAC9D,OAAO,EAAE,gBAAgB,EAAE,aAAa,EAAE,MAAM,kCAAkC,CAAC;AACnF,OAAO,EAAE,oBAAoB,EAAE,6BAA6B,EAAE,MAAM,iBAAiB,CAAC;AAStF,MAAM,OAAO,cAAe,SAAQ,eAAsC;IAEjE,MAAM,CAAO,KAAK,CAAC,OAA8B;;YACtD,IAAI,OAAO,CAAC,aAAa,KAAK,SAAS,EAAE,CAAC;gBACxC,MAAM,OAAO,CAAC,0BAA0B,CAAC,OAAO,CAAC,aAAa,CAAC,SAAS,EAAE,OAAO,CAAC,UAAU,CAAC,CAAC;YAChG,CAAC;YAED,IAAI,OAAO,CAAC,UAAU,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;gBAC5C,6BAA6B,CAAC,OAAO,CAAC,UAAU,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;YACpE,CAAC;YACD,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,UAAU,CAAC,gBAAgB,CAAC,CAAC;YAE5D,OAAO,IAAI,cAAc,CAAC,OAAO,CAAC,CAAC;QACrC,CAAC;KAAA;IAEM,MAAM,CAAO,MAAM,CAAC,OAA8B;;;YAEvD,MAAM,UAAU,GAA6B;gBAC3C,SAAS,EAAU,gBAAgB,CAAC,SAAS;gBAC7C,MAAM,EAAa,aAAa,CAAC,KAAK;gBACtC,gBAAgB,EAAG,MAAA,OAAO,CAAC,gBAAgB,mCAAI,IAAI,CAAC,mBAAmB,EAAE;gBACzE,MAAM,EAAa,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,cAAc,CAAC,eAAe,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS;aAC/F,CAAC;YAEF,+IAA+I;YAC/I,mFAAmF;YACnF,yBAAyB,CAAC,UAAU,CAAC,CAAC;YAEtC,yEAAyE;YACzE,IAAI,aAA6C,CAAC;YAClD,IAAI,OAAO,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;gBACjC,aAAa,GAAG,MAAM,OAAO,CAAC,mBAAmB,CAAC;oBAChD,UAAU;oBACV,MAAM,EAAc,OAAO,CAAC,MAAM;oBAClC,iBAAiB,EAAG,OAAO,CAAC,iBAAiB;iBAC9C,CAAC,CAAC;YACL,CAAC;YAED,MAAM,OAAO,GAAG,EAAE,UAAU,EAAE,aAAa,EAAE,CAAC;YAE9C,OAAO,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC;YAEpC,MAAM,cAAc,GAAG,IAAI,cAAc,CAAC,OAAO,CAAC,CAAC;YACnD,OAAO,cAAc,CAAC;QACxB,CAAC;KAAA;IAED,MAAM,CAAC,eAAe,CAAC,MAA4B;QACjD,uCACK,MAAM,KACT,QAAQ,EAAE,oBAAoB,CAAC,MAAM,CAAC,QAAQ,CAAC,IAC/C;IACJ,CAAC;IAEY,SAAS,CAAC,MAAc,EAAE,YAA0B;;YAC/D,2EAA2E;YAC3E,IAAI,IAAI,CAAC,MAAM,KAAK,MAAM,EAAE,CAAC;gBAC3B,OAAO;YACT,CAAC;iBAAM,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,IAAI,IAAI,CAAC,gBAAiB,CAAC,iBAAiB,EAAE,CAAC;gBACjF,MAAM,eAAe,GAAG,MAAM,mBAAmB,CAAC,UAAU,CAAC,MAAM,EAAE,YAAY,EAAE,IAAI,CAAC,gBAAiB,CAAC,iBAAiB,CAAC,CAAC;gBAC7H,MAAM,2BAA2B,CAAC,cAAc,CAAC;oBAC/C,eAAe,EAAG,MAAM;oBACxB,eAAe,EAAG,IAAI,CAAC,MAAM;oBAC7B,eAAe,EAAG,IAAI,CAAC,OAAO;oBAC9B,eAAe;oBACf,YAAY;iBACb,CAAC,CAAC;YACL,CAAC;iBAAM,CAAC;gBACN,MAAM,IAAI,QAAQ,CAChB,YAAY,CAAC,0BAA0B,EACvC,yCAAyC,CAC1C,CAAC;YACJ,CAAC;QACH,CAAC;KAAA;CACF"}