@abaxxtech/id 0.0.0

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

@@ -0,0 +1,80 @@
+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 { GrantAuthorization } from '../core/grant-authorization.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';
+import { normalizeProtocolUrl, validateProtocolUrlNormalized } from '../utils/url.js';
+import { DwnError, DwnErrorCode } from '../core/dwn-error.js';
+export class ProtocolsQuery extends AbstractMessage {
+    static parse(message) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (message.authorization !== undefined) {
+                yield Message.validateMessageSignatureIntegrity(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: ProtocolsQuery.normalizeFilter(options.filter),
+            };
+            // 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,
+                    permissionsGrantId: options.permissionsGrantId
+                });
+            }
+            const message = { descriptor, authorization };
+            Message.validateJsonSchema(message);
+            const protocolsQuery = new ProtocolsQuery(message);
+            return protocolsQuery;
+        });
+    }
+    static normalizeFilter(filter) {
+        if (filter === undefined) {
+            return undefined;
+        }
+        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.permissionsGrantId) {
+                const permissionsGrantMessage = yield GrantAuthorization.fetchGrant(tenant, messageStore, this.signaturePayload.permissionsGrantId);
+                yield GrantAuthorization.authorizeGenericMessage(tenant, this.message, this.author, permissionsGrantMessage, 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,kBAAkB,EAAE,MAAM,gCAAgC,CAAC;AACpE,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;AACnF,OAAO,EAAE,oBAAoB,EAAE,6BAA6B,EAAE,MAAM,iBAAiB,CAAC;AAEtF,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AAS9D,MAAM,OAAO,cAAe,SAAQ,eAAsC;IAEjE,MAAM,CAAO,KAAK,CAAC,OAA8B;;YACtD,IAAI,OAAO,CAAC,aAAa,KAAK,SAAS,EAAE,CAAC;gBACxC,MAAM,OAAO,CAAC,iCAAiC,CAAC,OAAO,CAAC,aAAa,CAAC,SAAS,EAAE,OAAO,CAAC,UAAU,CAAC,CAAC;YACvG,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;;;YACvD,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,cAAc,CAAC,eAAe,CAAC,OAAO,CAAC,MAAM,CAAC;aAClE,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,EAAe,OAAO,CAAC,MAAM;oBACnC,kBAAkB,EAAG,OAAO,CAAC,kBAAkB;iBAChD,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;IAEO,MAAM,CAAC,eAAe,CAAC,MAAwC;QACrE,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;YACzB,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,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,kBAAkB,EAAE,CAAC;gBAClF,MAAM,uBAAuB,GAAG,MAAM,kBAAkB,CAAC,UAAU,CAAC,MAAM,EAAE,YAAY,EAAE,IAAI,CAAC,gBAAiB,CAAC,kBAAkB,CAAC,CAAC;gBACrI,MAAM,kBAAkB,CAAC,uBAAuB,CAC9C,MAAM,EACN,IAAI,CAAC,OAAO,EACZ,IAAI,CAAC,MAAM,EACX,uBAAuB,EACvB,YAAY,CACb,CAAC;YACJ,CAAC;iBAAM,CAAC;gBACN,MAAM,IAAI,QAAQ,CAChB,YAAY,CAAC,0BAA0B,EACvC,yCAAyC,CAC1C,CAAC;YACJ,CAAC;QACH,CAAC;KAAA;CACF"}

package/dist/esm/src/interfaces/records-delete.js

@@ -0,0 +1,56 @@
+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 { Records } from '../utils/records.js';
+import { Time } from '../utils/time.js';
+import { DwnInterfaceName, DwnMethodName } from '../enums/dwn-interface-method.js';
+export class RecordsDelete extends AbstractMessage {
+    static parse(message) {
+        return __awaiter(this, void 0, void 0, function* () {
+            let signaturePayload;
+            if (message.authorization !== undefined) {
+                signaturePayload = yield Message.validateMessageSignatureIntegrity(message.authorization.signature, message.descriptor);
+            }
+            Records.validateDelegatedGrantReferentialIntegrity(message, signaturePayload);
+            Time.validateTimestamp(message.descriptor.messageTimestamp);
+            const recordsDelete = new RecordsDelete(message);
+            return recordsDelete;
+        });
+    }
+    /**
+     * Creates a RecordsDelete message.
+     * @param options.recordId If `undefined`, will be auto-filled as a originating message as convenience for developer.
+     * @param options.messageTimestamp If `undefined`, it will be auto-filled with current time.
+     */
+    static create(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a;
+            const recordId = options.recordId;
+            const currentTime = Time.getCurrentTimestamp();
+            const descriptor = {
+                interface: DwnInterfaceName.Records,
+                method: DwnMethodName.Delete,
+                recordId,
+                messageTimestamp: (_a = options.messageTimestamp) !== null && _a !== void 0 ? _a : currentTime
+            };
+            const authorization = yield Message.createAuthorization({
+                descriptor,
+                signer: options.signer,
+                protocolRole: options.protocolRole,
+                delegatedGrant: options.delegatedGrant
+            });
+            const message = { descriptor, authorization };
+            Message.validateJsonSchema(message);
+            return new RecordsDelete(message);
+        });
+    }
+}
+//# sourceMappingURL=records-delete.js.map

package/dist/esm/src/interfaces/records-delete.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"records-delete.js","sourceRoot":"","sources":["../../../../src/interfaces/records-delete.ts"],"names":[],"mappings":";;;;;;;;;AAIA,OAAO,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC;AAC9D,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAC7C,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAC9C,OAAO,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AACxC,OAAO,EAAE,gBAAgB,EAAE,aAAa,EAAE,MAAM,kCAAkC,CAAC;AAcnF,MAAM,OAAO,aAAc,SAAQ,eAAqC;IAE/D,MAAM,CAAO,KAAK,CAAC,OAA6B;;YACrD,IAAI,gBAAgB,CAAC;YACrB,IAAI,OAAO,CAAC,aAAa,KAAK,SAAS,EAAE,CAAC;gBACxC,gBAAgB,GAAG,MAAM,OAAO,CAAC,iCAAiC,CAAC,OAAO,CAAC,aAAa,CAAC,SAAS,EAAE,OAAO,CAAC,UAAU,CAAC,CAAC;YAC1H,CAAC;YAED,OAAO,CAAC,0CAA0C,CAAC,OAAO,EAAE,gBAAgB,CAAC,CAAC;YAE9E,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,UAAU,CAAC,gBAAgB,CAAC,CAAC;YAE5D,MAAM,aAAa,GAAG,IAAI,aAAa,CAAC,OAAO,CAAC,CAAC;YACjD,OAAO,aAAa,CAAC;QACvB,CAAC;KAAA;IAED;;;;OAIG;IACI,MAAM,CAAO,MAAM,CAAC,OAA6B;;;YACtD,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;YAClC,MAAM,WAAW,GAAG,IAAI,CAAC,mBAAmB,EAAE,CAAC;YAE/C,MAAM,UAAU,GAA4B;gBAC1C,SAAS,EAAU,gBAAgB,CAAC,OAAO;gBAC3C,MAAM,EAAa,aAAa,CAAC,MAAM;gBACvC,QAAQ;gBACR,gBAAgB,EAAG,MAAA,OAAO,CAAC,gBAAgB,mCAAI,WAAW;aAC3D,CAAC;YAEF,MAAM,aAAa,GAAG,MAAM,OAAO,CAAC,mBAAmB,CAAC;gBACtD,UAAU;gBACV,MAAM,EAAW,OAAO,CAAC,MAAM;gBAC/B,YAAY,EAAK,OAAO,CAAC,YAAY;gBACrC,cAAc,EAAG,OAAO,CAAC,cAAc;aACxC,CAAC,CAAC;YACH,MAAM,OAAO,GAAyB,EAAE,UAAU,EAAE,aAAa,EAAE,CAAC;YAEpE,OAAO,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC;YAEpC,OAAO,IAAI,aAAa,CAAC,OAAO,CAAC,CAAC;QACpC,CAAC;KAAA;CACF"}

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

@@ -0,0 +1,81 @@
+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 { Records } from '../utils/records.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 { validateProtocolUrlNormalized, validateSchemaUrlNormalized } from '../utils/url.js';
+/**
+ * A class representing a RecordsQuery DWN message.
+ */
+export class RecordsQuery extends AbstractMessage {
+    /**
+     * Called by `JSON.stringify(...)` automatically.
+     */
+    toJSON() {
+        return this.message;
+    }
+    static parse(message) {
+        return __awaiter(this, void 0, void 0, function* () {
+            let signaturePayload;
+            if (message.authorization !== undefined) {
+                signaturePayload = yield Message.validateMessageSignatureIntegrity(message.authorization.signature, message.descriptor);
+            }
+            Records.validateDelegatedGrantReferentialIntegrity(message, signaturePayload);
+            if ((signaturePayload === null || signaturePayload === void 0 ? void 0 : signaturePayload.protocolRole) !== undefined) {
+                if (message.descriptor.filter.protocolPath === undefined) {
+                    throw new DwnError(DwnErrorCode.RecordsQueryFilterMissingRequiredProperties, 'Role-authorized queries must include `protocolPath` in the filter');
+                }
+            }
+            if (message.descriptor.filter.protocol !== undefined) {
+                validateProtocolUrlNormalized(message.descriptor.filter.protocol);
+            }
+            if (message.descriptor.filter.schema !== undefined) {
+                validateSchemaUrlNormalized(message.descriptor.filter.schema);
+            }
+            Time.validateTimestamp(message.descriptor.messageTimestamp);
+            return new RecordsQuery(message);
+        });
+    }
+    static create(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a;
+            const descriptor = {
+                interface: DwnInterfaceName.Records,
+                method: DwnMethodName.Query,
+                messageTimestamp: (_a = options.messageTimestamp) !== null && _a !== void 0 ? _a : Time.getCurrentTimestamp(),
+                filter: Records.normalizeFilter(options.filter),
+                dateSort: options.dateSort,
+                pagination: options.pagination,
+            };
+            // 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
+            const signer = options.signer;
+            let authorization;
+            if (signer) {
+                authorization = yield Message.createAuthorization({
+                    descriptor,
+                    signer,
+                    protocolRole: options.protocolRole,
+                    delegatedGrant: options.delegatedGrant
+                });
+            }
+            const message = { descriptor, authorization };
+            Message.validateJsonSchema(message);
+            return new RecordsQuery(message);
+        });
+    }
+}
+//# sourceMappingURL=records-query.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"records-query.js","sourceRoot":"","sources":["../../../../src/interfaces/records-query.ts"],"names":[],"mappings":";;;;;;;;;AAKA,OAAO,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC;AAC9D,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAC7C,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAC9C,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,6BAA6B,EAAE,2BAA2B,EAAE,MAAM,iBAAiB,CAAC;AAgB7F;;GAEG;AACH,MAAM,OAAO,YAAa,SAAQ,eAAoC;IAEpE;;OAEG;IACH,MAAM;QACJ,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAEM,MAAM,CAAO,KAAK,CAAC,OAA4B;;YACpD,IAAI,gBAAgB,CAAC;YACrB,IAAI,OAAO,CAAC,aAAa,KAAK,SAAS,EAAE,CAAC;gBACxC,gBAAgB,GAAG,MAAM,OAAO,CAAC,iCAAiC,CAAC,OAAO,CAAC,aAAa,CAAC,SAAS,EAAE,OAAO,CAAC,UAAU,CAAC,CAAC;YAC1H,CAAC;YAED,OAAO,CAAC,0CAA0C,CAAC,OAAO,EAAE,gBAAgB,CAAC,CAAC;YAE9E,IAAI,CAAA,gBAAgB,aAAhB,gBAAgB,uBAAhB,gBAAgB,CAAE,YAAY,MAAK,SAAS,EAAE,CAAC;gBACjD,IAAI,OAAO,CAAC,UAAU,CAAC,MAAM,CAAC,YAAY,KAAK,SAAS,EAAE,CAAC;oBACzD,MAAM,IAAI,QAAQ,CAChB,YAAY,CAAC,2CAA2C,EACxD,mEAAmE,CACpE,CAAC;gBACJ,CAAC;YACH,CAAC;YACD,IAAI,OAAO,CAAC,UAAU,CAAC,MAAM,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;gBACrD,6BAA6B,CAAC,OAAO,CAAC,UAAU,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;YACpE,CAAC;YACD,IAAI,OAAO,CAAC,UAAU,CAAC,MAAM,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;gBACnD,2BAA2B,CAAC,OAAO,CAAC,UAAU,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;YAChE,CAAC;YAED,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,OAAO;gBAC3C,MAAM,EAAa,aAAa,CAAC,KAAK;gBACtC,gBAAgB,EAAG,MAAA,OAAO,CAAC,gBAAgB,mCAAI,IAAI,CAAC,mBAAmB,EAAE;gBACzE,MAAM,EAAa,OAAO,CAAC,eAAe,CAAC,OAAO,CAAC,MAAM,CAAC;gBAC1D,QAAQ,EAAW,OAAO,CAAC,QAAQ;gBACnC,UAAU,EAAS,OAAO,CAAC,UAAU;aACtC,CAAC;YAEF,+IAA+I;YAC/I,mFAAmF;YACnF,yBAAyB,CAAC,UAAU,CAAC,CAAC;YAEtC,yEAAyE;YACzE,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;YAC9B,IAAI,aAAa,CAAC;YAClB,IAAI,MAAM,EAAE,CAAC;gBACX,aAAa,GAAG,MAAM,OAAO,CAAC,mBAAmB,CAAC;oBAChD,UAAU;oBACV,MAAM;oBACN,YAAY,EAAK,OAAO,CAAC,YAAY;oBACrC,cAAc,EAAG,OAAO,CAAC,cAAc;iBACxC,CAAC,CAAC;YACL,CAAC;YACD,MAAM,OAAO,GAAG,EAAE,UAAU,EAAE,aAAa,EAAE,CAAC;YAE9C,OAAO,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC;YAEpC,OAAO,IAAI,YAAY,CAAC,OAAO,CAAC,CAAC;QACnC,CAAC;KAAA;CACF"}

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

@@ -0,0 +1,65 @@
+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 { Records } from '../utils/records.js';
+import { removeUndefinedProperties } from '../utils/object.js';
+import { Time } from '../utils/time.js';
+import { DwnInterfaceName, DwnMethodName } from '../enums/dwn-interface-method.js';
+export class RecordsRead extends AbstractMessage {
+    static parse(message) {
+        return __awaiter(this, void 0, void 0, function* () {
+            let signaturePayload;
+            if (message.authorization !== undefined) {
+                signaturePayload = yield Message.validateMessageSignatureIntegrity(message.authorization.signature, message.descriptor);
+            }
+            Records.validateDelegatedGrantReferentialIntegrity(message, signaturePayload);
+            Time.validateTimestamp(message.descriptor.messageTimestamp);
+            const recordsRead = new RecordsRead(message);
+            return recordsRead;
+        });
+    }
+    /**
+     * Creates a RecordsRead message.
+     * @param options.recordId If `undefined`, will be auto-filled as a originating message as convenience for developer.
+     * @param options.messageTimestamp If `undefined`, it will be auto-filled with current time.
+     *
+     * @throws {DwnError} when a combination of required RecordsReadOptions are missing
+     */
+    static create(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a;
+            const { filter, signer, permissionsGrantId, protocolRole } = options;
+            const currentTime = Time.getCurrentTimestamp();
+            const descriptor = {
+                interface: DwnInterfaceName.Records,
+                method: DwnMethodName.Read,
+                filter: Records.normalizeFilter(filter),
+                messageTimestamp: (_a = options.messageTimestamp) !== null && _a !== void 0 ? _a : currentTime,
+            };
+            removeUndefinedProperties(descriptor);
+            // only generate the `authorization` property if signature input is given
+            let authorization = undefined;
+            if (signer !== undefined) {
+                authorization = yield Message.createAuthorization({
+                    descriptor,
+                    signer,
+                    permissionsGrantId,
+                    protocolRole,
+                    delegatedGrant: options.delegatedGrant
+                });
+            }
+            const message = { descriptor, authorization };
+            Message.validateJsonSchema(message);
+            return new RecordsRead(message);
+        });
+    }
+}
+//# sourceMappingURL=records-read.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"records-read.js","sourceRoot":"","sources":["../../../../src/interfaces/records-read.ts"],"names":[],"mappings":";;;;;;;;;AAIA,OAAO,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC;AAC9D,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAC7C,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAC9C,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;AAmBnF,MAAM,OAAO,WAAY,SAAQ,eAAmC;IAE3D,MAAM,CAAO,KAAK,CAAC,OAA2B;;YACnD,IAAI,gBAAgB,CAAC;YACrB,IAAI,OAAO,CAAC,aAAa,KAAK,SAAS,EAAE,CAAC;gBACxC,gBAAgB,GAAG,MAAM,OAAO,CAAC,iCAAiC,CAAC,OAAO,CAAC,aAAa,CAAC,SAAS,EAAE,OAAO,CAAC,UAAU,CAAC,CAAC;YAC1H,CAAC;YAED,OAAO,CAAC,0CAA0C,CAAC,OAAO,EAAE,gBAAgB,CAAC,CAAC;YAE9E,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,UAAU,CAAC,gBAAgB,CAAC,CAAC;YAE5D,MAAM,WAAW,GAAG,IAAI,WAAW,CAAC,OAAO,CAAC,CAAC;YAC7C,OAAO,WAAW,CAAC;QACrB,CAAC;KAAA;IAED;;;;;;OAMG;IACI,MAAM,CAAO,MAAM,CAAC,OAA2B;;;YACpD,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,kBAAkB,EAAE,YAAY,EAAE,GAAG,OAAO,CAAC;YACrE,MAAM,WAAW,GAAG,IAAI,CAAC,mBAAmB,EAAE,CAAC;YAE/C,MAAM,UAAU,GAA0B;gBACxC,SAAS,EAAU,gBAAgB,CAAC,OAAO;gBAC3C,MAAM,EAAa,aAAa,CAAC,IAAI;gBACrC,MAAM,EAAa,OAAO,CAAC,eAAe,CAAC,MAAM,CAAC;gBAClD,gBAAgB,EAAG,MAAA,OAAO,CAAC,gBAAgB,mCAAI,WAAW;aAC3D,CAAC;YAEF,yBAAyB,CAAC,UAAU,CAAC,CAAC;YAEtC,yEAAyE;YACzE,IAAI,aAAa,GAAQ,SAAS,CAAC;YACnC,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;gBACzB,aAAa,GAAG,MAAM,OAAO,CAAC,mBAAmB,CAAC;oBAChD,UAAU;oBACV,MAAM;oBACN,kBAAkB;oBAClB,YAAY;oBACZ,cAAc,EAAE,OAAO,CAAC,cAAc;iBACvC,CAAC,CAAC;YACL,CAAC;YACD,MAAM,OAAO,GAAuB,EAAE,UAAU,EAAE,aAAa,EAAE,CAAC;YAElE,OAAO,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC;YAEpC,OAAO,IAAI,WAAW,CAAC,OAAO,CAAC,CAAC;QAClC,CAAC;KAAA;CACF"}