@abaxxtech/id 0.0.0

package/dist/esm/src/index.js

@@ -0,0 +1,43 @@
+/* eslint-disable max-len */
+export { AllowAllTenantGate } from './core/tenant-gate.js';
+export { Cid } from './utils/cid.js';
+export { RecordsQuery } from './interfaces/records-query.js';
+export { DataStream } from './utils/data-stream.js';
+export { DateSort } from './types/records-types.js';
+export { HdKey, KeyDerivationScheme } from './utils/hd-key.js';
+export { DidKeyResolver } from './did/did-key-resolver.js';
+export { DidIonResolver } from './did/did-ion-resolver.js';
+export { DidDhtResolver } from './did/did-dht-resolver.js';
+export { DidResolver } from './did/did-resolver.js';
+export { Dwn } from './dwn.js';
+export { DwnConstant } from './core/dwn-constant.js';
+export { DwnError, DwnErrorCode } from './core/dwn-error.js';
+export { DwnInterfaceName, DwnMethodName } from './enums/dwn-interface-method.js';
+export { Encoder } from './utils/encoder.js';
+export { EventsGet } from './interfaces/events-get.js';
+export { Encryption, EncryptionAlgorithm } from './utils/encryption.js';
+export { RecordsWrite } from './interfaces/records-write.js';
+export { executeUnlessAborted } from './utils/abort.js';
+export { Jws } from './utils/jws.js';
+export { Message } from './core/message.js';
+export { MessagesGet } from './interfaces/messages-get.js';
+export { PermissionsGrant } from './interfaces/permissions-grant.js';
+export { PermissionsRequest } from './interfaces/permissions-request.js';
+export { PermissionsRevoke } from './interfaces/permissions-revoke.js';
+export { PrivateKeySigner } from './utils/private-key-signer.js';
+export { Protocols } from './utils/protocols.js';
+export { ProtocolsConfigure } from './interfaces/protocols-configure.js';
+export { ProtocolsQuery } from './interfaces/protocols-query.js';
+export { Records } from './utils/records.js';
+export { RecordsDelete } from './interfaces/records-delete.js';
+export { RecordsRead } from './interfaces/records-read.js';
+export { Secp256k1 } from './utils/secp256k1.js';
+export { DataStoreLevel } from './store/data-store-level.js';
+export { EventLogLevel } from './event-log/event-log-level.js';
+export { MessageStoreLevel } from './store/message-store-level.js';
+export { SortOrder } from './types/message-types.js';
+export { Time } from './utils/time.js';
+// custom
+export { Authenticate } from './core/auth.js';
+export { GeneralJwsSigner } from './jose/jws/general/signer.js';
+//# sourceMappingURL=index.js.map

package/dist/esm/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/index.ts"],"names":[],"mappings":"AAAA,4BAA4B;AAqB5B,OAAO,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAE3D,OAAO,EAAE,GAAG,EAAE,MAAM,gBAAgB,CAAC;AACrC,OAAO,EAAE,YAAY,EAAE,MAAM,+BAA+B,CAAC;AAG7D,OAAO,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AACpD,OAAO,EAAE,QAAQ,EAAE,MAAM,0BAA0B,CAAC;AAEpD,OAAO,EAAE,KAAK,EAAE,mBAAmB,EAAE,MAAM,mBAAmB,CAAC;AAC/D,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAC3D,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAC3D,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAC3D,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACpD,OAAO,EAAE,GAAG,EAAE,MAAM,UAAU,CAAC;AAC/B,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AACrD,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAC7D,OAAO,EAAE,gBAAgB,EAAE,aAAa,EAAE,MAAM,iCAAiC,CAAC;AAClF,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAC7C,OAAO,EAAE,SAAS,EAAE,MAAM,4BAA4B,CAAC;AAEvD,OAAO,EAAE,UAAU,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAExE,OAAO,EAAE,YAAY,EAAE,MAAM,+BAA+B,CAAC;AAC7D,OAAO,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAC;AACxD,OAAO,EAAE,GAAG,EAAE,MAAM,gBAAgB,CAAC;AAErC,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAC5C,OAAO,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAI3D,OAAO,EAAE,gBAAgB,EAAE,MAAM,mCAAmC,CAAC;AAErE,OAAO,EAAE,kBAAkB,EAAE,MAAM,qCAAqC,CAAC;AAEzE,OAAO,EAAE,iBAAiB,EAAE,MAAM,oCAAoC,CAAC;AAEvE,OAAO,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AACjE,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AACjD,OAAO,EAAE,kBAAkB,EAAE,MAAM,qCAAqC,CAAC;AAEzE,OAAO,EAAE,cAAc,EAAE,MAAM,iCAAiC,CAAC;AAEjE,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAC7C,OAAO,EAAE,aAAa,EAAE,MAAM,gCAAgC,CAAC;AAE/D,OAAO,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAE3D,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AAEjD,OAAO,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAC;AAC7D,OAAO,EAAE,aAAa,EAAE,MAAM,gCAAgC,CAAC;AAC/D,OAAO,EAAE,iBAAiB,EAAE,MAAM,gCAAgC,CAAC;AACnE,OAAO,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAC;AACrD,OAAO,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAC;AAEvC,SAAS;AACT,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAC"}

package/dist/esm/src/interfaces/events-get.js

@@ -0,0 +1,41 @@
+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 { Time } from '../utils/time.js';
+import { DwnInterfaceName, DwnMethodName } from '../enums/dwn-interface-method.js';
+export class EventsGet extends AbstractMessage {
+    static parse(message) {
+        return __awaiter(this, void 0, void 0, function* () {
+            Message.validateJsonSchema(message);
+            yield Message.validateMessageSignatureIntegrity(message.authorization.signature, message.descriptor);
+            Time.validateTimestamp(message.descriptor.messageTimestamp);
+            return new EventsGet(message);
+        });
+    }
+    static create(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a;
+            const descriptor = {
+                interface: DwnInterfaceName.Events,
+                method: DwnMethodName.Get,
+                messageTimestamp: (_a = options.messageTimestamp) !== null && _a !== void 0 ? _a : Time.getCurrentTimestamp(),
+            };
+            if (options.watermark) {
+                descriptor.watermark = options.watermark;
+            }
+            const authorization = yield Message.createAuthorization({ descriptor, signer: options.signer });
+            const message = { descriptor, authorization };
+            Message.validateJsonSchema(message);
+            return new EventsGet(message);
+        });
+    }
+}
+//# sourceMappingURL=events-get.js.map

package/dist/esm/src/interfaces/events-get.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"events-get.js","sourceRoot":"","sources":["../../../../src/interfaces/events-get.ts"],"names":[],"mappings":";;;;;;;;;AAGA,OAAO,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC;AAC9D,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAC7C,OAAO,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AACxC,OAAO,EAAE,gBAAgB,EAAE,aAAa,EAAE,MAAM,kCAAkC,CAAC;AAQnF,MAAM,OAAO,SAAU,SAAQ,eAAiC;IAEvD,MAAM,CAAO,KAAK,CAAC,OAAyB;;YACjD,OAAO,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC;YACpC,MAAM,OAAO,CAAC,iCAAiC,CAAC,OAAO,CAAC,aAAa,CAAC,SAAS,EAAE,OAAO,CAAC,UAAU,CAAC,CAAC;YACrG,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,UAAU,CAAC,gBAAgB,CAAC,CAAC;YAE5D,OAAO,IAAI,SAAS,CAAC,OAAO,CAAC,CAAC;QAChC,CAAC;KAAA;IAEM,MAAM,CAAO,MAAM,CAAC,OAAyB;;;YAClD,MAAM,UAAU,GAAwB;gBACtC,SAAS,EAAU,gBAAgB,CAAC,MAAM;gBAC1C,MAAM,EAAa,aAAa,CAAC,GAAG;gBACpC,gBAAgB,EAAG,MAAA,OAAO,CAAC,gBAAgB,mCAAI,IAAI,CAAC,mBAAmB,EAAE;aAC1E,CAAC;YAEF,IAAI,OAAO,CAAC,SAAS,EAAE,CAAC;gBACtB,UAAU,CAAC,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC;YAC3C,CAAC;YAED,MAAM,aAAa,GAAG,MAAM,OAAO,CAAC,mBAAmB,CAAC,EAAE,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;YAChG,MAAM,OAAO,GAAG,EAAE,UAAU,EAAE,aAAa,EAAE,CAAC;YAE9C,OAAO,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC;YAEpC,OAAO,IAAI,SAAS,CAAC,OAAO,CAAC,CAAC;QAChC,CAAC;KAAA;CACF"}

package/dist/esm/src/interfaces/messages-get.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 { 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 MessagesGet extends AbstractMessage {
+    static parse(message) {
+        return __awaiter(this, void 0, void 0, function* () {
+            Message.validateJsonSchema(message);
+            this.validateMessageCids(message.descriptor.messageCids);
+            yield Message.validateMessageSignatureIntegrity(message.authorization.signature, message.descriptor);
+            Time.validateTimestamp(message.descriptor.messageTimestamp);
+            return new MessagesGet(message);
+        });
+    }
+    static create(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a;
+            const descriptor = {
+                interface: DwnInterfaceName.Messages,
+                method: DwnMethodName.Get,
+                messageCids: options.messageCids,
+                messageTimestamp: (_a = options === null || options === void 0 ? void 0 : options.messageTimestamp) !== null && _a !== void 0 ? _a : Time.getCurrentTimestamp(),
+            };
+            const authorization = yield Message.createAuthorization({ descriptor, signer: options.signer });
+            const message = { descriptor, authorization };
+            Message.validateJsonSchema(message);
+            MessagesGet.validateMessageCids(options.messageCids);
+            return new MessagesGet(message);
+        });
+    }
+    /**
+     * validates the provided cids
+     * @param messageCids - the cids in question
+     * @throws {DwnError} if an invalid cid is found.
+     */
+    static validateMessageCids(messageCids) {
+        for (const cid of messageCids) {
+            try {
+                Cid.parseCid(cid);
+            }
+            catch (_) {
+                throw new DwnError(DwnErrorCode.MessageGetInvalidCid, `${cid} is not a valid CID`);
+            }
+        }
+    }
+}
+//# sourceMappingURL=messages-get.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"messages-get.js","sourceRoot":"","sources":["../../../../src/interfaces/messages-get.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;AAQnF,MAAM,OAAO,WAAY,SAAQ,eAAmC;IAC3D,MAAM,CAAO,KAAK,CAAC,OAA2B;;YACnD,OAAO,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC;YACpC,IAAI,CAAC,mBAAmB,CAAC,OAAO,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;YAEzD,MAAM,OAAO,CAAC,iCAAiC,CAAC,OAAO,CAAC,aAAa,CAAC,SAAS,EAAE,OAAO,CAAC,UAAU,CAAC,CAAC;YACrG,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,UAAU,CAAC,gBAAgB,CAAC,CAAC;YAE5D,OAAO,IAAI,WAAW,CAAC,OAAO,CAAC,CAAC;QAClC,CAAC;KAAA;IAEM,MAAM,CAAO,MAAM,CAAC,OAA2B;;;YACpD,MAAM,UAAU,GAA0B;gBACxC,SAAS,EAAU,gBAAgB,CAAC,QAAQ;gBAC5C,MAAM,EAAa,aAAa,CAAC,GAAG;gBACpC,WAAW,EAAQ,OAAO,CAAC,WAAW;gBACtC,gBAAgB,EAAG,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,gBAAgB,mCAAI,IAAI,CAAC,mBAAmB,EAAE;aAC3E,CAAC;YAEF,MAAM,aAAa,GAAG,MAAM,OAAO,CAAC,mBAAmB,CAAC,EAAE,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;YAChG,MAAM,OAAO,GAAG,EAAE,UAAU,EAAE,aAAa,EAAE,CAAC;YAE9C,OAAO,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC;YACpC,WAAW,CAAC,mBAAmB,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;YAErD,OAAO,IAAI,WAAW,CAAC,OAAO,CAAC,CAAC;QAClC,CAAC;KAAA;IAED;;;;OAIG;IACK,MAAM,CAAC,mBAAmB,CAAC,WAAqB;QACtD,KAAK,MAAM,GAAG,IAAI,WAAW,EAAE,CAAC;YAC9B,IAAI,CAAC;gBACH,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;YACpB,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACX,MAAM,IAAI,QAAQ,CAAC,YAAY,CAAC,oBAAoB,EAAE,GAAG,GAAG,qBAAqB,CAAC,CAAC;YACrF,CAAC;QACH,CAAC;IACH,CAAC;CACF"}

package/dist/esm/src/interfaces/permissions-grant.js

@@ -0,0 +1,130 @@
+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 { DwnError, DwnErrorCode } from '../core/dwn-error.js';
+import { DwnInterfaceName, DwnMethodName } from '../enums/dwn-interface-method.js';
+import { normalizeProtocolUrl, normalizeSchemaUrl } from '../utils/url.js';
+export class PermissionsGrant extends AbstractMessage {
+    static parse(message) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield Message.validateMessageSignatureIntegrity(message.authorization.signature, message.descriptor);
+            PermissionsGrant.validateScope(message);
+            Time.validateTimestamp(message.descriptor.messageTimestamp);
+            Time.validateTimestamp(message.descriptor.dateExpires);
+            return new PermissionsGrant(message);
+        });
+    }
+    static create(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a;
+            const scope = Object.assign({}, options.scope);
+            scope.protocol = scope.protocol !== undefined ? normalizeProtocolUrl(scope.protocol) : undefined;
+            scope.schema = scope.schema !== undefined ? normalizeSchemaUrl(scope.schema) : undefined;
+            const descriptor = {
+                interface: DwnInterfaceName.Permissions,
+                method: DwnMethodName.Grant,
+                messageTimestamp: (_a = options.messageTimestamp) !== null && _a !== void 0 ? _a : Time.getCurrentTimestamp(),
+                dateExpires: options.dateExpires,
+                description: options.description,
+                grantedTo: options.grantedTo,
+                grantedBy: options.grantedBy,
+                grantedFor: options.grantedFor,
+                delegated: options.delegated,
+                permissionsRequestId: options.permissionsRequestId,
+                scope: scope,
+                conditions: options.conditions,
+            };
+            // 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);
+            const authorization = yield Message.createAuthorization({ descriptor, signer: options.signer });
+            const message = { descriptor, authorization };
+            Message.validateJsonSchema(message);
+            PermissionsGrant.validateScope(message);
+            return new PermissionsGrant(message);
+        });
+    }
+    /**
+     * A convenience method for casting a PermissionsGrantMessage to a DelegatedGrantMessage if the `delegated` property is `true`.
+     * @throws {DwnError} if the `delegated` property is not `true`.
+     */
+    asDelegatedGrant() {
+        return PermissionsGrant.asDelegatedGrant(this.message);
+    }
+    /**
+     * A convenience method for casting a PermissionsGrantMessage to a DelegatedGrantMessage if the `delegated` property is `true`.
+     * @throws {DwnError} if the `delegated` property is not `true`.
+     */
+    static asDelegatedGrant(message) {
+        if (!message.descriptor.delegated) {
+            throw new DwnError(DwnErrorCode.PermissionsGrantNotADelegatedGrant, `PermissionsGrant given is not a delegated grant. Descriptor: ${message.descriptor}`);
+        }
+        return message;
+    }
+    /**
+     * generates a PermissionsGrant using the provided PermissionsRequest
+     * @param permissionsRequest
+     * @param signer - the private key and additional signature material of the grantor
+     * @param overrides - overrides that will be used instead of the properties in `permissionsRequest`
+     */
+    static createFromPermissionsRequest(permissionsRequest, signer, overrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d, _e, _f;
+            const descriptor = permissionsRequest.message.descriptor;
+            return PermissionsGrant.create({
+                dateExpires: overrides.dateExpires,
+                description: (_a = overrides.description) !== null && _a !== void 0 ? _a : descriptor.description,
+                grantedBy: (_b = overrides.grantedBy) !== null && _b !== void 0 ? _b : descriptor.grantedBy,
+                grantedTo: (_c = overrides.grantedTo) !== null && _c !== void 0 ? _c : descriptor.grantedTo,
+                grantedFor: (_d = overrides.grantedFor) !== null && _d !== void 0 ? _d : descriptor.grantedFor,
+                permissionsRequestId: yield Message.getCid(permissionsRequest.message),
+                scope: (_e = overrides.scope) !== null && _e !== void 0 ? _e : descriptor.scope,
+                conditions: (_f = overrides.conditions) !== null && _f !== void 0 ? _f : descriptor.conditions,
+                signer,
+            });
+        });
+    }
+    /**
+     * Current implementation only allows the DWN owner to store grants they created.
+     */
+    authorize() {
+        const { grantedBy, grantedFor } = this.message.descriptor;
+        if (this.author !== grantedBy) {
+            throw new DwnError(DwnErrorCode.PermissionsGrantGrantedByMismatch, 'Message author must match grantedBy property');
+        }
+        else if (grantedBy !== grantedFor) {
+            // Without delegation, only the DWN owner may grant access to their own DWN.
+            throw new DwnError(DwnErrorCode.PermissionsGrantUnauthorizedGrant, `${grantedBy} is not authorized to give access to the DWN belonging to ${grantedFor}`);
+        }
+    }
+    /**
+     * Validates scope structure for properties beyond `interface` and `method`.
+     * Currently only grants for RecordsRead and RecordsWrite have such properties and need validation beyond JSON Schema.
+     */
+    static validateScope(permissionsGrantMessage) {
+        const recordsScope = permissionsGrantMessage.descriptor.scope;
+        // `schema` scopes may not have protocol-related fields
+        if (recordsScope.schema !== undefined) {
+            if (recordsScope.protocol !== undefined || recordsScope.contextId !== undefined || recordsScope.protocolPath) {
+                throw new DwnError(DwnErrorCode.PermissionsGrantScopeSchemaProhibitedFields, 'PermissionsGrants for RecordsRead and RecordsWrite that have `schema` present may not also have protocol-related properties present');
+            }
+        }
+        if (recordsScope.protocol !== undefined) {
+            // `contextId` and `protocolPath` are mutually exclusive
+            if (recordsScope.contextId !== undefined && recordsScope.protocolPath !== undefined) {
+                throw new DwnError(DwnErrorCode.PermissionsGrantScopeContextIdAndProtocolPath, 'PermissionsGrants for RecordsRead and RecordsWrite may not have both `contextId` and `protocolPath` present');
+            }
+        }
+    }
+}
+//# sourceMappingURL=permissions-grant.js.map

package/dist/esm/src/interfaces/permissions-grant.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"permissions-grant.js","sourceRoot":"","sources":["../../../../src/interfaces/permissions-grant.ts"],"names":[],"mappings":";;;;;;;;;AAMA,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,QAAQ,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AAC9D,OAAO,EAAE,gBAAgB,EAAE,aAAa,EAAE,MAAM,kCAAkC,CAAC;AACnF,OAAO,EAAE,oBAAoB,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AA0B3E,MAAM,OAAO,gBAAiB,SAAQ,eAAwC;IAErE,MAAM,CAAO,KAAK,CAAC,OAAgC;;YACxD,MAAM,OAAO,CAAC,iCAAiC,CAAC,OAAO,CAAC,aAAa,CAAC,SAAS,EAAE,OAAO,CAAC,UAAU,CAAC,CAAC;YACrG,gBAAgB,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;YACxC,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,UAAU,CAAC,gBAAgB,CAAC,CAAC;YAC5D,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;YAEvD,OAAO,IAAI,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACvC,CAAC;KAAA;IAED,MAAM,CAAO,MAAM,CAAC,OAAgC;;;YAClD,MAAM,KAAK,GAAG,kBAAK,OAAO,CAAC,KAAK,CAA4B,CAAC;YAC7D,KAAK,CAAC,QAAQ,GAAG,KAAK,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,oBAAoB,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;YACjG,KAAK,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,kBAAkB,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;YAEzF,MAAM,UAAU,GAA+B;gBAC7C,SAAS,EAAc,gBAAgB,CAAC,WAAW;gBACnD,MAAM,EAAiB,aAAa,CAAC,KAAK;gBAC1C,gBAAgB,EAAO,MAAA,OAAO,CAAC,gBAAgB,mCAAI,IAAI,CAAC,mBAAmB,EAAE;gBAC7E,WAAW,EAAY,OAAO,CAAC,WAAW;gBAC1C,WAAW,EAAY,OAAO,CAAC,WAAW;gBAC1C,SAAS,EAAc,OAAO,CAAC,SAAS;gBACxC,SAAS,EAAc,OAAO,CAAC,SAAS;gBACxC,UAAU,EAAa,OAAO,CAAC,UAAU;gBACzC,SAAS,EAAc,OAAO,CAAC,SAAS;gBACxC,oBAAoB,EAAG,OAAO,CAAC,oBAAoB;gBACnD,KAAK,EAAkB,KAAK;gBAC5B,UAAU,EAAa,OAAO,CAAC,UAAU;aAC1C,CAAC;YAEF,+IAA+I;YAC/I,mFAAmF;YACnF,yBAAyB,CAAC,UAAU,CAAC,CAAC;YAEtC,MAAM,aAAa,GAAG,MAAM,OAAO,CAAC,mBAAmB,CAAC,EAAE,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;YAChG,MAAM,OAAO,GAA4B,EAAE,UAAU,EAAE,aAAa,EAAE,CAAC;YAEvE,OAAO,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC;YACpC,gBAAgB,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;YAExC,OAAO,IAAI,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACvC,CAAC;KAAA;IAED;;;OAGG;IACI,gBAAgB;QACrB,OAAO,gBAAgB,CAAC,gBAAgB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACzD,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,gBAAgB,CAAC,OAAgC;QAC7D,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,SAAS,EAAE,CAAC;YAClC,MAAM,IAAI,QAAQ,CAChB,YAAY,CAAC,kCAAkC,EAC/C,gEAAgE,OAAO,CAAC,UAAU,EAAE,CACrF,CAAC;QACJ,CAAC;QAED,OAAO,OAAgC,CAAC;IAC1C,CAAC;IAGD;;;;;OAKG;IACI,MAAM,CAAO,4BAA4B,CAC9C,kBAAsC,EACtC,MAAc,EACd,SAAgD;;;YAEhD,MAAM,UAAU,GAAG,kBAAkB,CAAC,OAAO,CAAC,UAAU,CAAC;YACzD,OAAO,gBAAgB,CAAC,MAAM,CAAC;gBAC7B,WAAW,EAAY,SAAS,CAAC,WAAW;gBAC5C,WAAW,EAAY,MAAA,SAAS,CAAC,WAAW,mCAAI,UAAU,CAAC,WAAW;gBACtE,SAAS,EAAc,MAAA,SAAS,CAAC,SAAS,mCAAI,UAAU,CAAC,SAAS;gBAClE,SAAS,EAAc,MAAA,SAAS,CAAC,SAAS,mCAAI,UAAU,CAAC,SAAS;gBAClE,UAAU,EAAa,MAAA,SAAS,CAAC,UAAU,mCAAI,UAAU,CAAC,UAAU;gBACpE,oBAAoB,EAAG,MAAM,OAAO,CAAC,MAAM,CAAC,kBAAkB,CAAC,OAAO,CAAC;gBACvE,KAAK,EAAkB,MAAA,SAAS,CAAC,KAAK,mCAAI,UAAU,CAAC,KAAK;gBAC1D,UAAU,EAAa,MAAA,SAAS,CAAC,UAAU,mCAAI,UAAU,CAAC,UAAU;gBACpE,MAAM;aACP,CAAC,CAAC;QACL,CAAC;KAAA;IAED;;OAEG;IACI,SAAS;QACd,MAAM,EAAE,SAAS,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC;QAC1D,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YAC9B,MAAM,IAAI,QAAQ,CAAC,YAAY,CAAC,iCAAiC,EAAE,8CAA8C,CAAC,CAAC;QACrH,CAAC;aAAM,IAAI,SAAS,KAAK,UAAU,EAAE,CAAC;YACpC,4EAA4E;YAC5E,MAAM,IAAI,QAAQ,CAChB,YAAY,CAAC,iCAAiC,EAC9C,GAAG,SAAS,6DAA6D,UAAU,EAAE,CACtF,CAAC;QACJ,CAAC;IACH,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,aAAa,CAAC,uBAAgD;QAC1E,MAAM,YAAY,GAAG,uBAAuB,CAAC,UAAU,CAAC,KAA+B,CAAC;QAExF,uDAAuD;QACvD,IAAI,YAAY,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YACtC,IAAI,YAAY,CAAC,QAAQ,KAAK,SAAS,IAAI,YAAY,CAAC,SAAS,KAAK,SAAS,IAAI,YAAY,CAAC,YAAY,EAAE,CAAC;gBAC7G,MAAM,IAAI,QAAQ,CAChB,YAAY,CAAC,2CAA2C,EACxD,qIAAqI,CACtI,CAAC;YACJ,CAAC;QACH,CAAC;QAED,IAAI,YAAY,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;YACxC,wDAAwD;YACxD,IAAI,YAAY,CAAC,SAAS,KAAK,SAAS,IAAI,YAAY,CAAC,YAAY,KAAK,SAAS,EAAE,CAAC;gBACpF,MAAM,IAAI,QAAQ,CAChB,YAAY,CAAC,6CAA6C,EAC1D,6GAA6G,CAC9G,CAAC;YACJ,CAAC;QACH,CAAC;IACH,CAAC;CACF"}

package/dist/esm/src/interfaces/permissions-request.js

@@ -0,0 +1,47 @@
+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 { DwnInterfaceName, DwnMethodName } from '../enums/dwn-interface-method.js';
+export class PermissionsRequest extends AbstractMessage {
+    static parse(message) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield Message.validateMessageSignatureIntegrity(message.authorization.signature, message.descriptor);
+            Time.validateTimestamp(message.descriptor.messageTimestamp);
+            return new PermissionsRequest(message);
+        });
+    }
+    static create(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a;
+            const descriptor = {
+                interface: DwnInterfaceName.Permissions,
+                method: DwnMethodName.Request,
+                messageTimestamp: (_a = options.messageTimestamp) !== null && _a !== void 0 ? _a : Time.getCurrentTimestamp(),
+                description: options.description,
+                grantedTo: options.grantedTo,
+                grantedBy: options.grantedBy,
+                grantedFor: options.grantedFor,
+                scope: options.scope,
+                conditions: options.conditions,
+            };
+            // 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);
+            const auth = yield Message.createAuthorization({ descriptor, signer: options.signer });
+            const message = { descriptor, authorization: auth };
+            Message.validateJsonSchema(message);
+            return new PermissionsRequest(message);
+        });
+    }
+}
+//# sourceMappingURL=permissions-request.js.map

package/dist/esm/src/interfaces/permissions-request.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"permissions-request.js","sourceRoot":"","sources":["../../../../src/interfaces/permissions-request.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,gBAAgB,EAAE,aAAa,EAAE,MAAM,kCAAkC,CAAC;AAanF,MAAM,OAAO,kBAAmB,SAAQ,eAA0C;IAEzE,MAAM,CAAO,KAAK,CAAC,OAAkC;;YAC1D,MAAM,OAAO,CAAC,iCAAiC,CAAC,OAAO,CAAC,aAAa,CAAC,SAAS,EAAE,OAAO,CAAC,UAAU,CAAC,CAAC;YACrG,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,WAAW;gBAC/C,MAAM,EAAa,aAAa,CAAC,OAAO;gBACxC,gBAAgB,EAAG,MAAA,OAAO,CAAC,gBAAgB,mCAAI,IAAI,CAAC,mBAAmB,EAAE;gBACzE,WAAW,EAAQ,OAAO,CAAC,WAAW;gBACtC,SAAS,EAAU,OAAO,CAAC,SAAS;gBACpC,SAAS,EAAU,OAAO,CAAC,SAAS;gBACpC,UAAU,EAAS,OAAO,CAAC,UAAU;gBACrC,KAAK,EAAc,OAAO,CAAC,KAAK;gBAChC,UAAU,EAAS,OAAO,CAAC,UAAU;aACtC,CAAC;YAEF,+IAA+I;YAC/I,mFAAmF;YACnF,yBAAyB,CAAC,UAAU,CAAC,CAAC;YAEtC,MAAM,IAAI,GAAG,MAAM,OAAO,CAAC,mBAAmB,CAAC,EAAE,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;YACvF,MAAM,OAAO,GAA8B,EAAE,UAAU,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC;YAE/E,OAAO,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC;YAEpC,OAAO,IAAI,kBAAkB,CAAC,OAAO,CAAC,CAAC;QACzC,CAAC;KAAA;CACF"}

package/dist/esm/src/interfaces/permissions-revoke.js

@@ -0,0 +1,47 @@
+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 { Time } from '../utils/time.js';
+import { DwnError, DwnErrorCode } from '../core/dwn-error.js';
+import { DwnInterfaceName, DwnMethodName } from '../enums/dwn-interface-method.js';
+export class PermissionsRevoke extends AbstractMessage {
+    static parse(message) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield Message.validateMessageSignatureIntegrity(message.authorization.signature, message.descriptor);
+            Time.validateTimestamp(message.descriptor.messageTimestamp);
+            return new PermissionsRevoke(message);
+        });
+    }
+    static create(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a;
+            const descriptor = {
+                interface: DwnInterfaceName.Permissions,
+                method: DwnMethodName.Revoke,
+                messageTimestamp: (_a = options.messageTimestamp) !== null && _a !== void 0 ? _a : Time.getCurrentTimestamp(),
+                permissionsGrantId: options.permissionsGrantId,
+            };
+            const authorization = yield Message.createAuthorization({ descriptor, signer: options.signer });
+            const message = { descriptor, authorization };
+            Message.validateJsonSchema(message);
+            return new PermissionsRevoke(message);
+        });
+    }
+    authorize(permissionsGrantMessage) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.author !== permissionsGrantMessage.descriptor.grantedFor) {
+                // Until delegation is implemented, only the DWN owner may grant or revoke access to their DWN
+                throw new DwnError(DwnErrorCode.PermissionsRevokeUnauthorizedRevoke, 'Only the DWN owner may revoke a grant');
+            }
+        });
+    }
+}
+//# sourceMappingURL=permissions-revoke.js.map

package/dist/esm/src/interfaces/permissions-revoke.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"permissions-revoke.js","sourceRoot":"","sources":["../../../../src/interfaces/permissions-revoke.ts"],"names":[],"mappings":";;;;;;;;;AAGA,OAAO,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC;AAC9D,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;AAQnF,MAAM,OAAO,iBAAkB,SAAQ,eAAyC;IACvE,MAAM,CAAO,KAAK,CAAC,OAAiC;;YACzD,MAAM,OAAO,CAAC,iCAAiC,CAAC,OAAO,CAAC,aAAa,CAAC,SAAS,EAAE,OAAO,CAAC,UAAU,CAAC,CAAC;YACrG,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,UAAU,CAAC,gBAAgB,CAAC,CAAC;YAE5D,OAAO,IAAI,iBAAiB,CAAC,OAAO,CAAC,CAAC;QACxC,CAAC;KAAA;IAEM,MAAM,CAAO,MAAM,CAAC,OAAiC;;;YAC1D,MAAM,UAAU,GAAgC;gBAC9C,SAAS,EAAY,gBAAgB,CAAC,WAAW;gBACjD,MAAM,EAAe,aAAa,CAAC,MAAM;gBACzC,gBAAgB,EAAK,MAAA,OAAO,CAAC,gBAAgB,mCAAI,IAAI,CAAC,mBAAmB,EAAE;gBAC3E,kBAAkB,EAAG,OAAO,CAAC,kBAAkB;aAChD,CAAC;YAEF,MAAM,aAAa,GAAG,MAAM,OAAO,CAAC,mBAAmB,CAAC,EAAE,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;YAChG,MAAM,OAAO,GAA6B,EAAE,UAAU,EAAE,aAAa,EAAE,CAAC;YAExE,OAAO,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC;YAEpC,OAAO,IAAI,iBAAiB,CAAC,OAAO,CAAC,CAAC;QACxC,CAAC;KAAA;IAEY,SAAS,CAAC,uBAAgD;;YACrE,IAAI,IAAI,CAAC,MAAM,KAAK,uBAAuB,CAAC,UAAU,CAAC,UAAU,EAAE,CAAC;gBAClE,8FAA8F;gBAC9F,MAAM,IAAI,QAAQ,CAAC,YAAY,CAAC,mCAAmC,EAAE,uCAAuC,CAAC,CAAC;YAChH,CAAC;QACH,CAAC;KAAA;CACF"}

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

@@ -0,0 +1,149 @@
+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 { ProtocolActor } from '../types/protocols-types.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';
+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.validateMessageSignatureIntegrity(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,
+                permissionsGrantId: options.permissionsGrantId
+            });
+            const message = { descriptor, authorization };
+            Message.validateJsonSchema(message);
+            ProtocolsConfigure.validateProtocolDefinition(message.descriptor.definition);
+            const protocolsConfigure = new ProtocolsConfigure(message);
+            return protocolsConfigure;
+        });
+    }
+    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 $globalRoles
+        const globalRoles = [];
+        for (const rootRecordPath in definition.structure) {
+            const rootRuleSet = definition.structure[rootRecordPath];
+            if (rootRuleSet.$globalRole) {
+                globalRoles.push(rootRecordPath);
+            }
+        }
+        // Traverse nested rule sets
+        for (const rootRecordPath in definition.structure) {
+            const rootRuleSet = definition.structure[rootRecordPath];
+            // gather $contextRoles
+            const contextRoles = [];
+            for (const childRecordType in rootRuleSet) {
+                if (childRecordType.startsWith('$')) {
+                    continue;
+                }
+                const childRuleSet = rootRuleSet[childRecordType];
+                if (childRuleSet.$contextRole) {
+                    contextRoles.push(`${rootRecordPath}/${childRecordType}`);
+                }
+            }
+            ProtocolsConfigure.validateRuleSet(rootRuleSet, rootRecordPath, [...globalRoles, ...contextRoles]);
+        }
+    }
+    /**
+     * Validates the given rule set structure then recursively validates its nested child rule sets.
+     */
+    static validateRuleSet(ruleSet, protocolPath, roles) {
+        var _a;
+        const depth = protocolPath.split('/').length;
+        if (ruleSet.$globalRole && depth !== 1) {
+            throw new DwnError(DwnErrorCode.ProtocolsConfigureGlobalRoleAtProhibitedProtocolPath, `$globalRole is not allowed at protocol path (${protocolPath}). Only root records may set $globalRole true.`);
+        }
+        else if (ruleSet.$contextRole && depth !== 2) {
+            throw new DwnError(DwnErrorCode.ProtocolsConfigureContextRoleAtProhibitedProtocolPath, `$contextRole is not allowed at protocol path (${protocolPath}). Only second-level records may set $contextRole true.`);
+        }
+        // Validate $actions in the ruleset
+        const actions = (_a = ruleSet.$actions) !== null && _a !== void 0 ? _a : [];
+        for (const action of actions) {
+            // Validate that all `role` properties contain protocol paths $globalRole or $contextRole records
+            if (action.role !== undefined && !roles.includes(action.role)) {
+                throw new DwnError(DwnErrorCode.ProtocolsConfigureInvalidRole, `Invalid role '${action.role}' found at protocol path '${protocolPath}'`);
+            }
+            // Validate that if `who` is set to `anyone` then `of` is not set
+            if (action.who === 'anyone' && action.of) {
+                throw new DwnError(DwnErrorCode.ProtocolsConfigureInvalidActionOfNotAllowed, `'of' is not allowed at protocol path (${protocolPath})`);
+            }
+            // Validate that if `who === recipient` and `of === undefined`, then `can` is either `delete` or `update`
+            // We will not use direct recipient for `read`, `write`, or `query` because:
+            // - Recipients are always allowed to `read`.
+            // - `write` entails ability to create and update, whereas `update` only allows for updates.
+            //    There is no 'recipient' until the record has been created, so it makes no sense to allow recipient to write.
+            // - At this time, `query` is only authorized using roles, so allowing direct recipients to query is outside the scope of this PR.
+            if (action.who === ProtocolActor.Recipient &&
+                action.of === undefined &&
+                !['update', 'delete'].includes(action.can)) {
+                throw new DwnError(DwnErrorCode.ProtocolsConfigureInvalidRecipientOfAction, 'Rules for `recipient` without `of` property must have `can` === `delete` or `update`');
+            }
+            // Validate that if `who` is set to `author` then `of` is set
+            if (action.who === ProtocolActor.Author && !action.of) {
+                throw new DwnError(DwnErrorCode.ProtocolsConfigureInvalidActionMissingOf, `'of' is required when 'author' is specified as 'who'`);
+            }
+        }
+        // Validate nested rule sets
+        for (const recordType in ruleSet) {
+            if (recordType.startsWith('$')) {
+                continue;
+            }
+            const rootRuleSet = ruleSet[recordType];
+            const nextProtocolPath = `${protocolPath}/${recordType}`;
+            ProtocolsConfigure.validateRuleSet(rootRuleSet, nextProtocolPath, 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":";;;;;;;;;AAGA,OAAO,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC;AAC9D,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAC7C,OAAO,EAAE,aAAa,EAAE,MAAM,6BAA6B,CAAC;AAC5D,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;AASvI,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,iCAAiC,CAAC,OAAO,CAAC,aAAa,CAAC,SAAS,EAAE,OAAO,CAAC,UAAU,CAAC,CAAC;YACrG,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,EAAe,OAAO,CAAC,MAAM;gBACnC,kBAAkB,EAAG,OAAO,CAAC,kBAAkB;aAChD,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;IAEO,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;QAC7D,sBAAsB;QACtB,MAAM,WAAW,GAAa,EAAE,CAAC;QACjC,KAAK,MAAM,cAAc,IAAI,UAAU,CAAC,SAAS,EAAE,CAAC;YAClD,MAAM,WAAW,GAAG,UAAU,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC;YACzD,IAAI,WAAW,CAAC,WAAW,EAAE,CAAC;gBAC5B,WAAW,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;YACnC,CAAC;QACH,CAAC;QAED,4BAA4B;QAC5B,KAAK,MAAM,cAAc,IAAI,UAAU,CAAC,SAAS,EAAE,CAAC;YAClD,MAAM,WAAW,GAAG,UAAU,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC;YAEzD,uBAAuB;YACvB,MAAM,YAAY,GAAa,EAAE,CAAC;YAClC,KAAK,MAAM,eAAe,IAAI,WAAW,EAAE,CAAC;gBAC1C,IAAI,eAAe,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;oBACpC,SAAS;gBACX,CAAC;gBACD,MAAM,YAAY,GAAoB,WAAW,CAAC,eAAe,CAAC,CAAC;gBACnE,IAAI,YAAY,CAAC,YAAY,EAAE,CAAC;oBAC9B,YAAY,CAAC,IAAI,CAAC,GAAG,cAAc,IAAI,eAAe,EAAE,CAAC,CAAC;gBAC5D,CAAC;YACH,CAAC;YAED,kBAAkB,CAAC,eAAe,CAAC,WAAW,EAAE,cAAc,EAAE,CAAC,GAAG,WAAW,EAAE,GAAG,YAAY,CAAC,CAAC,CAAC;QACrG,CAAC;IACH,CAAC;IAED;;OAEG;IACK,MAAM,CAAC,eAAe,CAAC,OAAwB,EAAE,YAAoB,EAAE,KAAe;;QAC5F,MAAM,KAAK,GAAG,YAAY,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC;QAC7C,IAAI,OAAO,CAAC,WAAW,IAAI,KAAK,KAAK,CAAC,EAAE,CAAC;YACvC,MAAM,IAAI,QAAQ,CAChB,YAAY,CAAC,oDAAoD,EACjE,gDAAgD,YAAY,gDAAgD,CAC7G,CAAC;QACJ,CAAC;aAAM,IAAI,OAAO,CAAC,YAAY,IAAI,KAAK,KAAK,CAAC,EAAE,CAAC;YAC/C,MAAM,IAAI,QAAQ,CAChB,YAAY,CAAC,qDAAqD,EAClE,iDAAiD,YAAY,yDAAyD,CACvH,CAAC;QACJ,CAAC;QAED,mCAAmC;QACnC,MAAM,OAAO,GAAG,MAAA,OAAO,CAAC,QAAQ,mCAAI,EAAE,CAAC;QACvC,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;YAC7B,iGAAiG;YACjG,IAAI,MAAM,CAAC,IAAI,KAAK,SAAS,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC;gBAC9D,MAAM,IAAI,QAAQ,CAChB,YAAY,CAAC,6BAA6B,EAC1C,iBAAiB,MAAM,CAAC,IAAI,6BAA6B,YAAY,GAAG,CACzE,CAAC;YACJ,CAAC;YAED,iEAAiE;YACjE,IAAI,MAAM,CAAC,GAAG,KAAK,QAAQ,IAAI,MAAM,CAAC,EAAE,EAAE,CAAC;gBACzC,MAAM,IAAI,QAAQ,CAChB,YAAY,CAAC,2CAA2C,EACxD,yCAAyC,YAAY,GAAG,CACzD,CAAC;YACJ,CAAC;YAED,yGAAyG;YACzG,4EAA4E;YAC5E,6CAA6C;YAC7C,4FAA4F;YAC5F,kHAAkH;YAClH,kIAAkI;YAClI,IAAI,MAAM,CAAC,GAAG,KAAK,aAAa,CAAC,SAAS;gBACtC,MAAM,CAAC,EAAE,KAAK,SAAS;gBACvB,CAAC,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,EAC5C,CAAC;gBACD,MAAM,IAAI,QAAQ,CAChB,YAAY,CAAC,0CAA0C,EACvD,sFAAsF,CACvF,CAAC;YACJ,CAAC;YAED,6DAA6D;YAC7D,IAAI,MAAM,CAAC,GAAG,KAAK,aAAa,CAAC,MAAM,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC;gBACtD,MAAM,IAAI,QAAQ,CAChB,YAAY,CAAC,wCAAwC,EACrD,sDAAsD,CACvD,CAAC;YACJ,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;YACD,MAAM,WAAW,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;YACxC,MAAM,gBAAgB,GAAG,GAAG,YAAY,IAAI,UAAU,EAAE,CAAC;YACzD,kBAAkB,CAAC,eAAe,CAAC,WAAW,EAAE,gBAAgB,EAAE,KAAK,CAAC,CAAC;QAC3E,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"}