@abaxxtech/id 0.0.0

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

@@ -0,0 +1,206 @@
+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 { authenticate } from '../core/auth.js';
+import { DateSort } from '../types/records-types.js';
+import { messageReplyFromError } from '../core/message-reply.js';
+import { ProtocolAuthorization } from '../core/protocol-authorization.js';
+import { Records } from '../utils/records.js';
+import { RecordsQuery } from '../interfaces/records-query.js';
+import { SortOrder } from '../types/message-types.js';
+import { DwnInterfaceName, DwnMethodName } from '../enums/dwn-interface-method.js';
+export class RecordsQueryHandler {
+    constructor(didResolver, messageStore, dataStore) {
+        this.didResolver = didResolver;
+        this.messageStore = messageStore;
+        this.dataStore = dataStore;
+    }
+    handle(_a) {
+        return __awaiter(this, arguments, void 0, function* ({ tenant, message }) {
+            let recordsQuery;
+            try {
+                recordsQuery = yield RecordsQuery.parse(message);
+            }
+            catch (e) {
+                return messageReplyFromError(e, 400);
+            }
+            let recordsWrites;
+            let cursor;
+            // if this is an anonymous query and the filter supports published records, query only published records
+            if (RecordsQueryHandler.filterIncludesPublishedRecords(recordsQuery) && recordsQuery.author === undefined) {
+                const results = yield this.fetchPublishedRecords(tenant, recordsQuery);
+                recordsWrites = results.messages;
+                cursor = results.cursor;
+            }
+            else {
+                // authentication and authorization
+                try {
+                    yield authenticate(message.authorization, this.didResolver);
+                    // Only run protocol authz if message deliberately invokes it
+                    if (RecordsQueryHandler.shouldProtocolAuthorizeQuery(recordsQuery)) {
+                        yield ProtocolAuthorization.authorizeQuery(tenant, recordsQuery, this.messageStore);
+                    }
+                }
+                catch (e) {
+                    return messageReplyFromError(e, 401);
+                }
+                if (recordsQuery.author === tenant) {
+                    const results = yield this.fetchRecordsAsOwner(tenant, recordsQuery);
+                    recordsWrites = results.messages;
+                    cursor = results.cursor;
+                }
+                else {
+                    const results = yield this.fetchRecordsAsNonOwner(tenant, recordsQuery);
+                    recordsWrites = results.messages;
+                    cursor = results.cursor;
+                }
+            }
+            return {
+                status: { code: 200, detail: 'OK' },
+                entries: recordsWrites,
+                cursor
+            };
+        });
+    }
+    /**
+     * Convert an incoming DateSort to a sort type accepted by MessageStore
+     * Defaults to 'dateCreated' in Descending order if no sort is supplied.
+     *
+     * @param dateSort the optional DateSort from the RecordsQuery message descriptor.
+     * @returns {MessageSort} for MessageStore sorting.
+     */
+    convertDateSort(dateSort) {
+        switch (dateSort) {
+            case DateSort.CreatedAscending:
+                return { dateCreated: SortOrder.Ascending };
+            case DateSort.CreatedDescending:
+                return { dateCreated: SortOrder.Descending };
+            case DateSort.PublishedAscending:
+                return { datePublished: SortOrder.Ascending };
+            case DateSort.PublishedDescending:
+                return { datePublished: SortOrder.Descending };
+            default:
+                return { dateCreated: SortOrder.Ascending };
+        }
+    }
+    /**
+     * Fetches the records as the owner of the DWN with no additional filtering.
+     */
+    fetchRecordsAsOwner(tenant, recordsQuery) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { dateSort, filter, pagination } = recordsQuery.message.descriptor;
+            // fetch all published records matching the query
+            const queryFilter = Object.assign(Object.assign({}, Records.convertFilter(filter)), { interface: DwnInterfaceName.Records, method: DwnMethodName.Write, isLatestBaseState: true });
+            const messageSort = this.convertDateSort(dateSort);
+            return this.messageStore.query(tenant, [queryFilter], messageSort, pagination);
+        });
+    }
+    /**
+     * Fetches the records as a non-owner.
+     *
+     * Filters can support returning both published and unpublished records,
+     * as well as explicitly only published or only unpublished records.
+     *
+     * A) BOTH published and unpublished:
+     *    1. published records; and
+     *    2. unpublished records intended for the query author (where `recipient` is the query author); and
+     *    3. unpublished records authorized by a protocol rule.
+     *
+     * B) PUBLISHED:
+     *    1. only published records;
+     *
+     * C) UNPUBLISHED:
+     *    1. unpublished records intended for the query author (where `recipient` is the query author); and
+     *    2. unpublished records authorized by a protocol rule.
+     *
+     */
+    fetchRecordsAsNonOwner(tenant, recordsQuery) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { dateSort, pagination } = recordsQuery.message.descriptor;
+            const filters = [];
+            if (RecordsQueryHandler.filterIncludesPublishedRecords(recordsQuery)) {
+                filters.push(RecordsQueryHandler.buildPublishedRecordsFilter(recordsQuery));
+            }
+            if (RecordsQueryHandler.filterIncludesUnpublishedRecords(recordsQuery)) {
+                filters.push(RecordsQueryHandler.buildUnpublishedRecordsByQueryAuthorFilter(recordsQuery));
+                const recipientFilter = recordsQuery.message.descriptor.filter.recipient;
+                if (recipientFilter === undefined || recipientFilter === recordsQuery.author) {
+                    filters.push(RecordsQueryHandler.buildUnpublishedRecordsForQueryAuthorFilter(recordsQuery));
+                }
+                if (RecordsQueryHandler.shouldProtocolAuthorizeQuery(recordsQuery)) {
+                    filters.push(RecordsQueryHandler.buildUnpublishedProtocolAuthorizedRecordsFilter(recordsQuery));
+                }
+            }
+            const messageSort = this.convertDateSort(dateSort);
+            return this.messageStore.query(tenant, filters, messageSort, pagination);
+        });
+    }
+    /**
+     * Fetches only published records.
+     */
+    fetchPublishedRecords(tenant, recordsQuery) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { dateSort, pagination } = recordsQuery.message.descriptor;
+            const filter = RecordsQueryHandler.buildPublishedRecordsFilter(recordsQuery);
+            const messageSort = this.convertDateSort(dateSort);
+            return this.messageStore.query(tenant, [filter], messageSort, pagination);
+        });
+    }
+    static buildPublishedRecordsFilter(recordsQuery) {
+        // fetch all published records matching the query
+        return Object.assign(Object.assign({}, Records.convertFilter(recordsQuery.message.descriptor.filter)), { interface: DwnInterfaceName.Records, method: DwnMethodName.Write, published: true, isLatestBaseState: true });
+    }
+    /**
+     * Creates a filter for unpublished records that are intended for the query author (where `recipient` is the author).
+     */
+    static buildUnpublishedRecordsForQueryAuthorFilter(recordsQuery) {
+        // include records where recipient is query author
+        return Object.assign(Object.assign({}, Records.convertFilter(recordsQuery.message.descriptor.filter)), { interface: DwnInterfaceName.Records, method: DwnMethodName.Write, recipient: recordsQuery.author, isLatestBaseState: true, published: false });
+    }
+    /**
+     * Creates a filter for unpublished records that are within the specified protocol.
+     * Validation that `protocol` and other required protocol-related fields occurs before this method.
+     */
+    static buildUnpublishedProtocolAuthorizedRecordsFilter(recordsQuery) {
+        return Object.assign(Object.assign({}, Records.convertFilter(recordsQuery.message.descriptor.filter)), { interface: DwnInterfaceName.Records, method: DwnMethodName.Write, isLatestBaseState: true, published: false });
+    }
+    /**
+     * Creates a filter for only unpublished records where the author is the same as the query author.
+     */
+    static buildUnpublishedRecordsByQueryAuthorFilter(recordsQuery) {
+        // include records where author is the same as the query author
+        return Object.assign(Object.assign({}, Records.convertFilter(recordsQuery.message.descriptor.filter)), { author: recordsQuery.author, interface: DwnInterfaceName.Records, method: DwnMethodName.Write, isLatestBaseState: true, published: false });
+    }
+    /**
+     * Determines if ProtocolAuthorization.authorizeQuery should be run and if the corresponding filter should be used.
+     */
+    static shouldProtocolAuthorizeQuery(recordsQuery) {
+        return recordsQuery.signaturePayload.protocolRole !== undefined;
+    }
+    /**
+     * Checks if the recordQuery filter supports returning published records.
+     */
+    static filterIncludesPublishedRecords(recordsQuery) {
+        const { filter } = recordsQuery.message.descriptor;
+        // When `published` and `datePublished` range are both undefined, published records can be returned.
+        return filter.datePublished !== undefined || filter.published !== false;
+    }
+    /**
+     * Checks if the recordQuery filter supports returning unpublished records.
+     */
+    static filterIncludesUnpublishedRecords(recordsQuery) {
+        const { filter } = recordsQuery.message.descriptor;
+        // When `published` and `datePublished` range are both undefined, unpublished records can be returned.
+        if (filter.datePublished === undefined && filter.published === undefined) {
+            return true;
+        }
+        return filter.published === false;
+    }
+}
+//# sourceMappingURL=records-query.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"records-query.js","sourceRoot":"","sources":["../../../../src/handlers/records-query.ts"],"names":[],"mappings":";;;;;;;;;AAOA,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAC/C,OAAO,EAAE,QAAQ,EAAE,MAAM,2BAA2B,CAAC;AACrD,OAAO,EAAE,qBAAqB,EAAE,MAAM,0BAA0B,CAAC;AACjE,OAAO,EAAE,qBAAqB,EAAE,MAAM,mCAAmC,CAAC;AAC1E,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAC9C,OAAO,EAAE,YAAY,EAAE,MAAM,gCAAgC,CAAC;AAC9D,OAAO,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAC;AACtD,OAAO,EAAE,gBAAgB,EAAE,aAAa,EAAE,MAAM,kCAAkC,CAAC;AAEnF,MAAM,OAAO,mBAAmB;IAE9B,YAAoB,WAAwB,EAAU,YAA0B,EAAU,SAAoB;QAA1F,gBAAW,GAAX,WAAW,CAAa;QAAU,iBAAY,GAAZ,YAAY,CAAc;QAAU,cAAS,GAAT,SAAS,CAAW;IAAI,CAAC;IAEtG,MAAM;6DAAC,EAClB,MAAM,EACN,OAAO,EACwC;YAC/C,IAAI,YAA0B,CAAC;YAC/B,IAAI,CAAC;gBACH,YAAY,GAAG,MAAM,YAAY,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YACnD,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACX,OAAO,qBAAqB,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;YACvC,CAAC;YAED,IAAI,aAA2D,CAAC;YAChE,IAAI,MAAwB,CAAC;YAC7B,wGAAwG;YACxG,IAAI,mBAAmB,CAAC,8BAA8B,CAAC,YAAY,CAAC,IAAI,YAAY,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;gBAC1G,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,qBAAqB,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;gBACvE,aAAa,GAAG,OAAO,CAAC,QAAwD,CAAC;gBACjF,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;YAC1B,CAAC;iBAAM,CAAC;gBACN,mCAAmC;gBACnC,IAAI,CAAC;oBACH,MAAM,YAAY,CAAC,OAAO,CAAC,aAAc,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;oBAE7D,6DAA6D;oBAC7D,IAAI,mBAAmB,CAAC,4BAA4B,CAAC,YAAY,CAAC,EAAE,CAAC;wBACnE,MAAM,qBAAqB,CAAC,cAAc,CAAC,MAAM,EAAE,YAAY,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;oBACtF,CAAC;gBACH,CAAC;gBAAC,OAAO,CAAC,EAAE,CAAC;oBACX,OAAO,qBAAqB,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;gBACvC,CAAC;gBAED,IAAI,YAAY,CAAC,MAAM,KAAK,MAAM,EAAE,CAAC;oBACnC,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,mBAAmB,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;oBACrE,aAAa,GAAG,OAAO,CAAC,QAAwD,CAAC;oBACjF,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;gBAC1B,CAAC;qBAAM,CAAC;oBACN,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,sBAAsB,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;oBACxE,aAAa,GAAG,OAAO,CAAC,QAAwD,CAAC;oBACjF,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;gBAC1B,CAAC;YACH,CAAC;YAED,OAAO;gBACL,MAAM,EAAI,EAAE,IAAI,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE;gBACrC,OAAO,EAAG,aAAa;gBACvB,MAAM;aACP,CAAC;QACJ,CAAC;KAAA;IAED;;;;;;OAMG;IACK,eAAe,CAAC,QAAmB;QACzC,QAAQ,QAAQ,EAAE,CAAC;YACnB,KAAK,QAAQ,CAAC,gBAAgB;gBAC5B,OAAO,EAAE,WAAW,EAAE,SAAS,CAAC,SAAS,EAAE,CAAC;YAC9C,KAAK,QAAQ,CAAC,iBAAiB;gBAC7B,OAAO,EAAE,WAAW,EAAE,SAAS,CAAC,UAAU,EAAE,CAAC;YAC/C,KAAK,QAAQ,CAAC,kBAAkB;gBAC9B,OAAO,EAAE,aAAa,EAAE,SAAS,CAAC,SAAS,EAAE,CAAC;YAChD,KAAK,QAAQ,CAAC,mBAAmB;gBAC/B,OAAO,EAAE,aAAa,EAAE,SAAS,CAAC,UAAU,EAAE,CAAC;YACjD;gBACE,OAAO,EAAE,WAAW,EAAE,SAAS,CAAC,SAAS,EAAE,CAAC;QAC9C,CAAC;IACH,CAAC;IAED;;OAEG;IACW,mBAAmB,CAC/B,MAAc,EACd,YAA0B;;YAE1B,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,UAAU,EAAE,GAAG,YAAY,CAAC,OAAO,CAAC,UAAU,CAAC;YAEzE,iDAAiD;YACjD,MAAM,WAAW,mCACZ,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,KAChC,SAAS,EAAW,gBAAgB,CAAC,OAAO,EAC5C,MAAM,EAAc,aAAa,CAAC,KAAK,EACvC,iBAAiB,EAAG,IAAI,GACzB,CAAC;YAEF,MAAM,WAAW,GAAG,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC;YACnD,OAAO,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,MAAM,EAAE,CAAE,WAAW,CAAE,EAAE,WAAW,EAAE,UAAU,CAAC,CAAC;QACnF,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACW,sBAAsB,CAClC,MAAc,EAAE,YAA0B;;YAE1C,MAAM,EAAE,QAAQ,EAAE,UAAU,EAAE,GAAG,YAAY,CAAC,OAAO,CAAC,UAAU,CAAC;YACjE,MAAM,OAAO,GAAU,EAAE,CAAC;YAE1B,IAAI,mBAAmB,CAAC,8BAA8B,CAAC,YAAY,CAAC,EAAE,CAAC;gBACrE,OAAO,CAAC,IAAI,CAAC,mBAAmB,CAAC,2BAA2B,CAAC,YAAY,CAAC,CAAC,CAAC;YAC9E,CAAC;YAED,IAAI,mBAAmB,CAAC,gCAAgC,CAAC,YAAY,CAAC,EAAE,CAAC;gBACvE,OAAO,CAAC,IAAI,CAAC,mBAAmB,CAAC,0CAA0C,CAAC,YAAY,CAAC,CAAC,CAAC;gBAE3F,MAAM,eAAe,GAAG,YAAY,CAAC,OAAO,CAAC,UAAU,CAAC,MAAM,CAAC,SAAS,CAAC;gBACzE,IAAI,eAAe,KAAK,SAAS,IAAI,eAAe,KAAK,YAAY,CAAC,MAAM,EAAE,CAAC;oBAC7E,OAAO,CAAC,IAAI,CAAC,mBAAmB,CAAC,2CAA2C,CAAC,YAAY,CAAC,CAAC,CAAC;gBAC9F,CAAC;gBAED,IAAI,mBAAmB,CAAC,4BAA4B,CAAC,YAAY,CAAC,EAAE,CAAC;oBACnE,OAAO,CAAC,IAAI,CAAC,mBAAmB,CAAC,+CAA+C,CAAC,YAAY,CAAC,CAAC,CAAC;gBAClG,CAAC;YACH,CAAC;YAED,MAAM,WAAW,GAAG,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC;YACnD,OAAO,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,MAAM,EAAE,OAAO,EAAE,WAAW,EAAE,UAAU,CAAE,CAAC;QAC5E,CAAC;KAAA;IAED;;OAEG;IACW,qBAAqB,CACjC,MAAc,EAAE,YAA0B;;YAE1C,MAAM,EAAE,QAAQ,EAAE,UAAU,EAAE,GAAG,YAAY,CAAC,OAAO,CAAC,UAAU,CAAC;YACjE,MAAM,MAAM,GAAG,mBAAmB,CAAC,2BAA2B,CAAC,YAAY,CAAC,CAAC;YAC7E,MAAM,WAAW,GAAG,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC;YACnD,OAAO,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,MAAM,EAAE,CAAE,MAAM,CAAE,EAAE,WAAW,EAAE,UAAU,CAAC,CAAC;QAC9E,CAAC;KAAA;IAEO,MAAM,CAAC,2BAA2B,CAAC,YAA0B;QACnE,iDAAiD;QACjD,uCACK,OAAO,CAAC,aAAa,CAAC,YAAY,CAAC,OAAO,CAAC,UAAU,CAAC,MAAM,CAAC,KAChE,SAAS,EAAW,gBAAgB,CAAC,OAAO,EAC5C,MAAM,EAAc,aAAa,CAAC,KAAK,EACvC,SAAS,EAAW,IAAI,EACxB,iBAAiB,EAAG,IAAI,IACxB;IACJ,CAAC;IAED;;OAEG;IACK,MAAM,CAAC,2CAA2C,CAAC,YAA0B;QACnF,kDAAkD;QAClD,uCACK,OAAO,CAAC,aAAa,CAAC,YAAY,CAAC,OAAO,CAAC,UAAU,CAAC,MAAM,CAAC,KAChE,SAAS,EAAW,gBAAgB,CAAC,OAAO,EAC5C,MAAM,EAAc,aAAa,CAAC,KAAK,EACvC,SAAS,EAAW,YAAY,CAAC,MAAO,EACxC,iBAAiB,EAAG,IAAI,EACxB,SAAS,EAAW,KAAK,IACzB;IACJ,CAAC;IAED;;;OAGG;IACK,MAAM,CAAC,+CAA+C,CAAC,YAA0B;QACvF,uCACK,OAAO,CAAC,aAAa,CAAC,YAAY,CAAC,OAAO,CAAC,UAAU,CAAC,MAAM,CAAC,KAChE,SAAS,EAAW,gBAAgB,CAAC,OAAO,EAC5C,MAAM,EAAc,aAAa,CAAC,KAAK,EACvC,iBAAiB,EAAG,IAAI,EACxB,SAAS,EAAW,KAAK,IACzB;IACJ,CAAC;IAED;;OAEG;IACK,MAAM,CAAC,0CAA0C,CAAC,YAA0B;QAClF,+DAA+D;QAC/D,uCACK,OAAO,CAAC,aAAa,CAAC,YAAY,CAAC,OAAO,CAAC,UAAU,CAAC,MAAM,CAAC,KAChE,MAAM,EAAc,YAAY,CAAC,MAAO,EACxC,SAAS,EAAW,gBAAgB,CAAC,OAAO,EAC5C,MAAM,EAAc,aAAa,CAAC,KAAK,EACvC,iBAAiB,EAAG,IAAI,EACxB,SAAS,EAAW,KAAK,IACzB;IACJ,CAAC;IAED;;OAEG;IACK,MAAM,CAAC,4BAA4B,CAAC,YAA0B;QACpE,OAAO,YAAY,CAAC,gBAAiB,CAAC,YAAY,KAAK,SAAS,CAAC;IACnE,CAAC;IAED;;OAEG;IACK,MAAM,CAAC,8BAA8B,CAAC,YAA0B;QACtE,MAAM,EAAE,MAAM,EAAE,GAAG,YAAY,CAAC,OAAO,CAAC,UAAU,CAAC;QACnD,oGAAoG;QACpG,OAAO,MAAM,CAAC,aAAa,KAAK,SAAS,IAAI,MAAM,CAAC,SAAS,KAAK,KAAK,CAAC;IAC1E,CAAC;IAED;;OAEG;IACK,MAAM,CAAC,gCAAgC,CAAC,YAA0B;QACxE,MAAM,EAAE,MAAM,EAAE,GAAG,YAAY,CAAC,OAAO,CAAC,UAAU,CAAC;QACnD,sGAAsG;QACtG,IAAI,MAAM,CAAC,aAAa,KAAK,SAAS,IAAI,MAAM,CAAC,SAAS,KAAK,SAAS,EAAE,CAAC;YACzE,OAAO,IAAI,CAAC;QACd,CAAC;QACD,OAAO,MAAM,CAAC,SAAS,KAAK,KAAK,CAAC;IACpC,CAAC;CACF"}

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

@@ -0,0 +1,118 @@
+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 { authenticate } from '../core/auth.js';
+import { DataStream } from '../utils/data-stream.js';
+import { DwnInterfaceName } from '../enums/dwn-interface-method.js';
+import { Encoder } from '../utils/encoder.js';
+import { GrantAuthorization } from '../core/grant-authorization.js';
+import { Message } from '../core/message.js';
+import { messageReplyFromError } from '../core/message-reply.js';
+import { ProtocolAuthorization } from '../core/protocol-authorization.js';
+import { Records } from '../utils/records.js';
+import { RecordsGrantAuthorization } from '../core/records-grant-authorization.js';
+import { RecordsRead } from '../interfaces/records-read.js';
+import { RecordsWrite } from '../interfaces/records-write.js';
+import { DwnError, DwnErrorCode } from '../core/dwn-error.js';
+export class RecordsReadHandler {
+    constructor(didResolver, messageStore, dataStore) {
+        this.didResolver = didResolver;
+        this.messageStore = messageStore;
+        this.dataStore = dataStore;
+    }
+    handle(_a) {
+        return __awaiter(this, arguments, void 0, function* ({ tenant, message }) {
+            let recordsRead;
+            try {
+                recordsRead = yield RecordsRead.parse(message);
+            }
+            catch (e) {
+                return messageReplyFromError(e, 400);
+            }
+            // authentication
+            try {
+                if (recordsRead.author !== undefined) {
+                    yield authenticate(message.authorization, this.didResolver);
+                }
+            }
+            catch (e) {
+                return messageReplyFromError(e, 401);
+            }
+            // get the latest active messages matching the supplied filter
+            // only RecordsWrite messages will be returned due to 'isLatestBaseState' being set to true.
+            const query = Object.assign({ interface: DwnInterfaceName.Records, isLatestBaseState: true }, Records.convertFilter(message.descriptor.filter));
+            const { messages: existingMessages } = yield this.messageStore.query(tenant, [query]);
+            if (existingMessages.length === 0) {
+                return {
+                    status: { code: 404, detail: 'Not Found' }
+                };
+            }
+            else if (existingMessages.length > 1) {
+                return messageReplyFromError(new DwnError(DwnErrorCode.RecordsReadReturnedMultiple, 'Multiple records exist for the RecordsRead filter'), 400);
+            }
+            const newestRecordsWrite = existingMessages[0];
+            try {
+                yield RecordsReadHandler.authorizeRecordsRead(tenant, recordsRead, yield RecordsWrite.parse(newestRecordsWrite), this.messageStore);
+            }
+            catch (error) {
+                return messageReplyFromError(error, 401);
+            }
+            let data;
+            if (newestRecordsWrite.encodedData !== undefined) {
+                const dataBytes = Encoder.base64UrlToBytes(newestRecordsWrite.encodedData);
+                data = DataStream.fromBytes(dataBytes);
+                delete newestRecordsWrite.encodedData;
+            }
+            else {
+                const messageCid = yield Message.getCid(newestRecordsWrite);
+                const result = yield this.dataStore.get(tenant, messageCid, newestRecordsWrite.descriptor.dataCid);
+                if ((result === null || result === void 0 ? void 0 : result.dataStream) === undefined) {
+                    return {
+                        status: { code: 404, detail: 'Not Found' }
+                    };
+                }
+                data = result.dataStream;
+            }
+            const messageReply = {
+                status: { code: 200, detail: 'OK' },
+                record: Object.assign(Object.assign({}, newestRecordsWrite), { data })
+            };
+            return messageReply;
+        });
+    }
+    ;
+    static authorizeRecordsRead(tenant, recordsRead, newestRecordsWrite, messageStore) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { descriptor } = newestRecordsWrite.message;
+            // if author is the same as the target tenant, we can directly grant access
+            if (recordsRead.author === tenant) {
+                return;
+            }
+            else if (descriptor.published === true) {
+                // authentication is not required for published data
+                return;
+            }
+            else if (recordsRead.author !== undefined && recordsRead.author === descriptor.recipient) {
+                // The recipient of a message may always read it
+                return;
+            }
+            else if (recordsRead.author !== undefined && recordsRead.signaturePayload.permissionsGrantId !== undefined) {
+                const permissionsGrantMessage = yield GrantAuthorization.fetchGrant(tenant, messageStore, recordsRead.signaturePayload.permissionsGrantId);
+                yield RecordsGrantAuthorization.authorizeRead(tenant, recordsRead, newestRecordsWrite.message, recordsRead.author, permissionsGrantMessage, messageStore);
+            }
+            else if (descriptor.protocol !== undefined) {
+                yield ProtocolAuthorization.authorizeRead(tenant, recordsRead, newestRecordsWrite, messageStore);
+            }
+            else {
+                throw new DwnError(DwnErrorCode.RecordsReadAuthorizationFailed, 'message failed authorization');
+            }
+        });
+    }
+}
+//# sourceMappingURL=records-read.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"records-read.js","sourceRoot":"","sources":["../../../../src/handlers/records-read.ts"],"names":[],"mappings":";;;;;;;;;AAOA,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAC/C,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AACrD,OAAO,EAAE,gBAAgB,EAAE,MAAM,kCAAkC,CAAC;AACpE,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAC9C,OAAO,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAC;AACpE,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAC7C,OAAO,EAAE,qBAAqB,EAAE,MAAM,0BAA0B,CAAC;AACjE,OAAO,EAAE,qBAAqB,EAAE,MAAM,mCAAmC,CAAC;AAC1E,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAC9C,OAAO,EAAE,yBAAyB,EAAE,MAAM,wCAAwC,CAAC;AACnF,OAAO,EAAE,WAAW,EAAE,MAAM,+BAA+B,CAAC;AAC5D,OAAO,EAAE,YAAY,EAAE,MAAM,gCAAgC,CAAC;AAC9D,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AAE9D,MAAM,OAAO,kBAAkB;IAE7B,YAAoB,WAAwB,EAAU,YAA0B,EAAU,SAAoB;QAA1F,gBAAW,GAAX,WAAW,CAAa;QAAU,iBAAY,GAAZ,YAAY,CAAc;QAAU,cAAS,GAAT,SAAS,CAAW;IAAI,CAAC;IAEtG,MAAM;6DAAC,EAClB,MAAM,EACN,OAAO,EACyC;YAEhD,IAAI,WAAwB,CAAC;YAC7B,IAAI,CAAC;gBACH,WAAW,GAAG,MAAM,WAAW,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YACjD,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACX,OAAO,qBAAqB,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;YACvC,CAAC;YAED,iBAAiB;YACjB,IAAI,CAAC;gBACH,IAAI,WAAW,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;oBACrC,MAAM,YAAY,CAAC,OAAO,CAAC,aAAc,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;gBAC/D,CAAC;YACH,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACX,OAAO,qBAAqB,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;YACvC,CAAC;YAED,8DAA8D;YAC9D,4FAA4F;YAC5F,MAAM,KAAK,mBACT,SAAS,EAAW,gBAAgB,CAAC,OAAO,EAC5C,iBAAiB,EAAG,IAAI,IACrB,OAAO,CAAC,aAAa,CAAC,OAAO,CAAC,UAAU,CAAC,MAAM,CAAC,CACpD,CAAC;YACF,MAAM,EAAE,QAAQ,EAAE,gBAAgB,EAAE,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,MAAM,EAAE,CAAE,KAAK,CAAE,CAAC,CAAC;YACxF,IAAI,gBAAgB,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBAClC,OAAO;oBACL,MAAM,EAAE,EAAE,IAAI,EAAE,GAAG,EAAE,MAAM,EAAE,WAAW,EAAE;iBAC3C,CAAC;YACJ,CAAC;iBAAM,IAAI,gBAAgB,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACvC,OAAO,qBAAqB,CAAC,IAAI,QAAQ,CACvC,YAAY,CAAC,2BAA2B,EACxC,mDAAmD,CACpD,EAAE,GAAG,CAAC,CAAC;YACV,CAAC;YAED,MAAM,kBAAkB,GAAG,gBAAgB,CAAC,CAAC,CAA+C,CAAC;YAC7F,IAAI,CAAC;gBACH,MAAM,kBAAkB,CAAC,oBAAoB,CAAC,MAAM,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC,KAAK,CAAC,kBAAkB,CAAC,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;YACtI,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,OAAO,qBAAqB,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;YAC3C,CAAC;YAED,IAAI,IAAI,CAAC;YACT,IAAI,kBAAkB,CAAC,WAAW,KAAK,SAAS,EAAE,CAAC;gBACjD,MAAM,SAAS,GAAG,OAAO,CAAC,gBAAgB,CAAC,kBAAkB,CAAC,WAAW,CAAC,CAAC;gBAC3E,IAAI,GAAG,UAAU,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;gBACvC,OAAO,kBAAkB,CAAC,WAAW,CAAC;YACxC,CAAC;iBAAM,CAAC;gBACN,MAAM,UAAU,GAAG,MAAM,OAAO,CAAC,MAAM,CAAC,kBAAkB,CAAC,CAAC;gBAC5D,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,MAAM,EAAE,UAAU,EAAE,kBAAkB,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;gBACnG,IAAI,CAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,UAAU,MAAK,SAAS,EAAE,CAAC;oBACrC,OAAO;wBACL,MAAM,EAAE,EAAE,IAAI,EAAE,GAAG,EAAE,MAAM,EAAE,WAAW,EAAE;qBAC3C,CAAC;gBACJ,CAAC;gBACD,IAAI,GAAG,MAAM,CAAC,UAAU,CAAC;YAC3B,CAAC;YAED,MAAM,YAAY,GAAqB;gBACrC,MAAM,EAAG,EAAE,IAAI,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE;gBACpC,MAAM,kCACD,kBAAkB,KACrB,IAAI,GACL;aACF,CAAC;YACF,OAAO,YAAY,CAAC;QACtB,CAAC;KAAA;IAAA,CAAC;IAEM,MAAM,CAAO,oBAAoB,CACvC,MAAc,EACd,WAAwB,EACxB,kBAAgC,EAChC,YAA0B;;YAE1B,MAAM,EAAE,UAAU,EAAE,GAAG,kBAAkB,CAAC,OAAO,CAAC;YAElD,2EAA2E;YAC3E,IAAI,WAAW,CAAC,MAAM,KAAK,MAAM,EAAE,CAAC;gBAClC,OAAO;YACT,CAAC;iBAAM,IAAI,UAAU,CAAC,SAAS,KAAK,IAAI,EAAE,CAAC;gBACzC,oDAAoD;gBACpD,OAAO;YACT,CAAC;iBAAM,IAAI,WAAW,CAAC,MAAM,KAAK,SAAS,IAAI,WAAW,CAAC,MAAM,KAAK,UAAU,CAAC,SAAS,EAAE,CAAC;gBAC3F,gDAAgD;gBAChD,OAAO;YACT,CAAC;iBAAM,IAAI,WAAW,CAAC,MAAM,KAAK,SAAS,IAAI,WAAW,CAAC,gBAAiB,CAAC,kBAAkB,KAAK,SAAS,EAAE,CAAC;gBAC9G,MAAM,uBAAuB,GAAG,MAAM,kBAAkB,CAAC,UAAU,CAAC,MAAM,EAAE,YAAY,EAAE,WAAW,CAAC,gBAAiB,CAAC,kBAAkB,CAAC,CAAC;gBAC5I,MAAM,yBAAyB,CAAC,aAAa,CAC3C,MAAM,EAAE,WAAW,EAAE,kBAAkB,CAAC,OAAO,EAAE,WAAW,CAAC,MAAM,EAAE,uBAAuB,EAAE,YAAY,CAC3G,CAAC;YACJ,CAAC;iBAAM,IAAI,UAAU,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;gBAC7C,MAAM,qBAAqB,CAAC,aAAa,CAAC,MAAM,EAAE,WAAW,EAAE,kBAAkB,EAAE,YAAY,CAAC,CAAC;YACnG,CAAC;iBAAM,CAAC;gBACN,MAAM,IAAI,QAAQ,CAAC,YAAY,CAAC,8BAA8B,EAAE,8BAA8B,CAAC,CAAC;YAClG,CAAC;QACH,CAAC;KAAA;CACF"}

package/dist/esm/src/handlers/records-write.js

@@ -0,0 +1,252 @@
+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 { authenticate } from '../core/auth.js';
+import { Cid } from '../utils/cid.js';
+import { DataStream } from '../utils/data-stream.js';
+import { DwnConstant } from '../core/dwn-constant.js';
+import { Encoder } from '../utils/encoder.js';
+import { GrantAuthorization } from '../core/grant-authorization.js';
+import { Message } from '../core/message.js';
+import { messageReplyFromError } from '../core/message-reply.js';
+import { ProtocolAuthorization } from '../core/protocol-authorization.js';
+import { RecordsGrantAuthorization } from '../core/records-grant-authorization.js';
+import { RecordsWrite } from '../interfaces/records-write.js';
+import { StorageController } from '../store/storage-controller.js';
+import { DwnError, DwnErrorCode } from '../core/dwn-error.js';
+import { DwnInterfaceName, DwnMethodName } from '../enums/dwn-interface-method.js';
+export class RecordsWriteHandler {
+    constructor(didResolver, messageStore, dataStore, eventLog) {
+        this.didResolver = didResolver;
+        this.messageStore = messageStore;
+        this.dataStore = dataStore;
+        this.eventLog = eventLog;
+    }
+    handle(_a) {
+        return __awaiter(this, arguments, void 0, function* ({ tenant, message, options, dataStream }) {
+            let recordsWrite;
+            try {
+                recordsWrite = yield RecordsWrite.parse(message);
+                // Protocol record specific validation
+                if (message.descriptor.protocol !== undefined) {
+                    yield ProtocolAuthorization.validateReferentialIntegrity(tenant, recordsWrite, this.messageStore);
+                }
+            }
+            catch (e) {
+                return messageReplyFromError(e, 400);
+            }
+            // authentication & authorization
+            try {
+                yield authenticate(message.authorization, this.didResolver);
+                yield RecordsWriteHandler.authorizeRecordsWrite(tenant, recordsWrite, this.messageStore);
+            }
+            catch (e) {
+                return messageReplyFromError(e, 401);
+            }
+            // get existing messages matching the `recordId`
+            const query = {
+                interface: DwnInterfaceName.Records,
+                recordId: message.recordId
+            };
+            const { messages: existingMessages } = yield this.messageStore.query(tenant, [query]);
+            // If this exact message already exists, treat as idempotent no-op.
+            // This makes sync convergent: receiving the same message twice is always safe.
+            const incomingMessageCid = yield Message.getCid(message);
+            for (const existingMessage of existingMessages) {
+                const existingCid = yield Message.getCid(existingMessage);
+                if (existingCid === incomingMessageCid) {
+                    return { status: { code: 202, detail: 'Accepted' } };
+                }
+            }
+            // if the incoming write is not the initial write, then it must not modify any immutable properties defined by the initial write
+            const newMessageIsInitialWrite = yield recordsWrite.isInitialWrite();
+            if (!newMessageIsInitialWrite) {
+                try {
+                    const initialWrite = yield RecordsWrite.getInitialWrite(existingMessages);
+                    RecordsWrite.verifyEqualityOfImmutableProperties(initialWrite, message);
+                }
+                catch (e) {
+                    return messageReplyFromError(e, 400);
+                }
+            }
+            const newestExistingMessage = yield Message.getNewestMessage(existingMessages);
+            let incomingMessageIsNewest = false;
+            let newestMessage; // keep reference of newest message for pruning later
+            if (newestExistingMessage === undefined || (yield Message.isNewer(message, newestExistingMessage))) {
+                incomingMessageIsNewest = true;
+                newestMessage = message;
+            }
+            else { // existing message is the same age or newer than the incoming message
+                newestMessage = newestExistingMessage;
+            }
+            if (!incomingMessageIsNewest) {
+                return {
+                    status: { code: 409, detail: 'Conflict' }
+                };
+            }
+            const isLatestBaseState = true;
+            const indexes = yield recordsWrite.constructRecordsWriteIndexes(isLatestBaseState);
+            // if data is below a certain threshold, we embed the data directly into the message for storage in MessageStore.
+            let messageWithOptionalEncodedData = message;
+            // try to store data, unless options explicitly say to skip storage
+            if (options === undefined || !options.skipDataStorage) {
+                if (dataStream === undefined && (newestExistingMessage === null || newestExistingMessage === void 0 ? void 0 : newestExistingMessage.descriptor.method) === DwnMethodName.Delete) {
+                    return messageReplyFromError(new DwnError(DwnErrorCode.RecordsWriteMissingDataStream, 'No data stream was provided with the previous message being a delete'), 400);
+                }
+                try {
+                    // if data is below the threshold, we store it within MessageStore
+                    if (message.descriptor.dataSize <= DwnConstant.maxDataSizeAllowedToBeEncoded) {
+                        // processes and sets `encodedData` with appropriate data.
+                        messageWithOptionalEncodedData = yield this.processEncodedData(message, dataStream, newestExistingMessage);
+                    }
+                    else {
+                        yield this.putData(tenant, message, dataStream);
+                    }
+                }
+                catch (error) {
+                    const e = error;
+                    if (e.code === DwnErrorCode.RecordsWriteMissingDataInPrevious ||
+                        e.code === DwnErrorCode.RecordsWriteMissingDataAssociation ||
+                        e.code === DwnErrorCode.RecordsWriteDataCidMismatch ||
+                        e.code === DwnErrorCode.RecordsWriteDataSizeMismatch) {
+                        return messageReplyFromError(error, 400);
+                    }
+                    // else throw
+                    throw error;
+                }
+            }
+            yield this.messageStore.put(tenant, messageWithOptionalEncodedData, indexes);
+            yield this.eventLog.append(tenant, yield Message.getCid(message));
+            const messageReply = {
+                status: { code: 202, detail: 'Accepted' }
+            };
+            // delete all existing messages that are not newest, except for the initial write
+            yield StorageController.deleteAllOlderMessagesButKeepInitialWrite(tenant, existingMessages, newestMessage, this.messageStore, this.dataStore, this.eventLog);
+            return messageReply;
+        });
+    }
+    ;
+    /**
+     * Embeds the record's data into the `encodedData` property.
+     * If dataStream is present, it uses the dataStream. Otherwise, uses the `encodedData` from the most recent RecordsWrite.
+     *
+     * @returns {RecordsWriteMessageWithOptionalEncodedData} `encodedData` embedded.
+     *
+     * @throws {DwnError} with `DwnErrorCode.RecordsWriteMissingDataInPrevious`
+     *                    if `dataStream` is absent AND `encodedData` of previous message is missing
+     * @throws {DwnError} with `DwnErrorCode.RecordsWriteDataCidMismatch`
+     *                    if the data stream resulted in a data CID that mismatches with `dataCid` in the given message
+     * @throws {DwnError} with `DwnErrorCode.RecordsWriteDataSizeMismatch`
+     *                    if `dataSize` in `descriptor` given mismatches the actual data size
+     */
+    processEncodedData(message, dataStream, newestExistingMessage) {
+        return __awaiter(this, void 0, void 0, function* () {
+            let dataBytes;
+            if (dataStream === undefined) {
+                const newestWithData = newestExistingMessage;
+                if ((newestWithData === null || newestWithData === void 0 ? void 0 : newestWithData.encodedData) === undefined) {
+                    throw new DwnError(DwnErrorCode.RecordsWriteMissingDataInPrevious, `No dataStream was provided and unable to get data from previous message`);
+                }
+                else {
+                    dataBytes = Encoder.base64UrlToBytes(newestWithData.encodedData);
+                }
+            }
+            else {
+                dataBytes = yield DataStream.toBytes(dataStream);
+            }
+            const dataCid = yield Cid.computeDagPbCidFromBytes(dataBytes);
+            RecordsWriteHandler.validateDataIntegrity(message.descriptor.dataCid, message.descriptor.dataSize, dataCid, dataBytes.length);
+            const recordsWrite = Object.assign({}, message);
+            recordsWrite.encodedData = Encoder.bytesToBase64Url(dataBytes);
+            return recordsWrite;
+        });
+    }
+    /**
+     * Puts the given data in storage unless tenant already has that data for the given recordId
+     *
+     * @throws {DwnError} with `DwnErrorCode.RecordsWriteMissingDataAssociation`
+     *                    if `dataStream` is absent AND unable to associate data given `dataCid`
+     * @throws {DwnError} with `DwnErrorCode.RecordsWriteDataCidMismatch`
+     *                    if the data stream resulted in a data CID that mismatches with `dataCid` in the given message
+     * @throws {DwnError} with `DwnErrorCode.RecordsWriteDataSizeMismatch`
+     *                    if `dataSize` in `descriptor` given mismatches the actual data size
+     */
+    putData(tenant, message, dataStream) {
+        return __awaiter(this, void 0, void 0, function* () {
+            let result;
+            const messageCid = yield Message.getCid(message);
+            if (dataStream === undefined) {
+                const associateResult = yield this.dataStore.associate(tenant, messageCid, message.descriptor.dataCid);
+                if (associateResult === undefined) {
+                    throw new DwnError(DwnErrorCode.RecordsWriteMissingDataAssociation, `Unable to associate dataCid ${message.descriptor.dataCid} ` +
+                        `to messageCid ${messageCid} because dataStream was not provided and data was not found in dataStore`);
+                }
+                result = associateResult;
+            }
+            else {
+                result = yield this.dataStore.put(tenant, messageCid, message.descriptor.dataCid, dataStream);
+            }
+            try {
+                RecordsWriteHandler.validateDataIntegrity(message.descriptor.dataCid, message.descriptor.dataSize, result.dataCid, result.dataSize);
+            }
+            catch (error) {
+                // delete data and throw error to caller
+                yield this.dataStore.delete(tenant, messageCid, message.descriptor.dataCid);
+                throw error;
+            }
+        });
+    }
+    /**
+     * Validates the expected `dataCid` and `dataSize` in the descriptor vs the received data.
+     *
+     * @throws {DwnError} with `DwnErrorCode.RecordsWriteDataCidMismatch`
+     *                    if the data stream resulted in a data CID that mismatches with `dataCid` in the given message
+     * @throws {DwnError} with `DwnErrorCode.RecordsWriteDataSizeMismatch`
+     *                    if `dataSize` in `descriptor` given mismatches the actual data size
+     */
+    static validateDataIntegrity(expectedDataCid, expectedDataSize, actualDataCid, actualDataSize) {
+        if (expectedDataCid !== actualDataCid) {
+            throw new DwnError(DwnErrorCode.RecordsWriteDataCidMismatch, `actual data CID ${actualDataCid} does not match dataCid in descriptor: ${expectedDataCid}`);
+        }
+        if (expectedDataSize !== actualDataSize) {
+            throw new DwnError(DwnErrorCode.RecordsWriteDataSizeMismatch, `actual data size ${actualDataSize} bytes does not match dataSize in descriptor: ${expectedDataSize}`);
+        }
+    }
+    static authorizeRecordsWrite(tenant, recordsWrite, messageStore) {
+        return __awaiter(this, void 0, void 0, function* () {
+            // if owner DID is specified, it must be the same as the tenant DID
+            if (recordsWrite.owner !== undefined && recordsWrite.owner !== tenant) {
+                throw new DwnError(DwnErrorCode.RecordsWriteOwnerAndTenantMismatch, `Owner ${recordsWrite.owner} must be the same as tenant ${tenant} when specified.`);
+            }
+            if (recordsWrite.isSignedByDelegatee) {
+                yield recordsWrite.authorizeDelegatee(messageStore);
+            }
+            if (recordsWrite.owner !== undefined) {
+                // if incoming message is a write retained by this tenant, we by-design always allow
+                // NOTE: the "owner === tenant" check is already done earlier in this method
+                return;
+            }
+            else if (recordsWrite.author === tenant) {
+                // if author is the same as the target tenant, we can directly grant access
+                return;
+            }
+            else if (recordsWrite.author !== undefined && recordsWrite.signaturePayload.permissionsGrantId !== undefined) {
+                const permissionsGrantMessage = yield GrantAuthorization.fetchGrant(tenant, messageStore, recordsWrite.signaturePayload.permissionsGrantId);
+                yield RecordsGrantAuthorization.authorizeWrite(tenant, recordsWrite.message, recordsWrite.author, permissionsGrantMessage, messageStore);
+            }
+            else if (recordsWrite.message.descriptor.protocol !== undefined) {
+                yield ProtocolAuthorization.authorizeWrite(tenant, recordsWrite, messageStore);
+            }
+            else {
+                throw new DwnError(DwnErrorCode.RecordsWriteAuthorizationFailed, 'message failed authorization');
+            }
+        });
+    }
+}
+//# sourceMappingURL=records-write.js.map

package/dist/esm/src/handlers/records-write.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"records-write.js","sourceRoot":"","sources":["../../../../src/handlers/records-write.ts"],"names":[],"mappings":";;;;;;;;;AAQA,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAC/C,OAAO,EAAE,GAAG,EAAE,MAAM,iBAAiB,CAAC;AACtC,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AACrD,OAAO,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AACtD,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAC9C,OAAO,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAC;AACpE,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAC7C,OAAO,EAAE,qBAAqB,EAAE,MAAM,0BAA0B,CAAC;AACjE,OAAO,EAAE,qBAAqB,EAAE,MAAM,mCAAmC,CAAC;AAC1E,OAAO,EAAE,yBAAyB,EAAE,MAAM,wCAAwC,CAAC;AACnF,OAAO,EAAE,YAAY,EAAE,MAAM,gCAAgC,CAAC;AAC9D,OAAO,EAAE,iBAAiB,EAAE,MAAM,gCAAgC,CAAC;AACnE,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AAC9D,OAAO,EAAE,gBAAgB,EAAE,aAAa,EAAE,MAAM,kCAAkC,CAAC;AAQnF,MAAM,OAAO,mBAAmB;IAE9B,YAAoB,WAAwB,EAAU,YAA0B,EAAU,SAAoB,EAAU,QAAkB;QAAtH,gBAAW,GAAX,WAAW,CAAa;QAAU,iBAAY,GAAZ,YAAY,CAAc;QAAU,cAAS,GAAT,SAAS,CAAW;QAAU,aAAQ,GAAR,QAAQ,CAAU;IAAI,CAAC;IAElI,MAAM;6DAAC,EAClB,MAAM,EACN,OAAO,EACP,OAAO,EACP,UAAU,EACE;YACZ,IAAI,YAA0B,CAAC;YAC/B,IAAI,CAAC;gBACH,YAAY,GAAG,MAAM,YAAY,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;gBAEjD,sCAAsC;gBACtC,IAAI,OAAO,CAAC,UAAU,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;oBAC9C,MAAM,qBAAqB,CAAC,4BAA4B,CAAC,MAAM,EAAE,YAAY,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;gBACpG,CAAC;YACH,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACX,OAAO,qBAAqB,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;YACvC,CAAC;YAED,iCAAiC;YACjC,IAAI,CAAC;gBACH,MAAM,YAAY,CAAC,OAAO,CAAC,aAAa,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;gBAC5D,MAAM,mBAAmB,CAAC,qBAAqB,CAAC,MAAM,EAAE,YAAY,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;YAC3F,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACX,OAAO,qBAAqB,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;YACvC,CAAC;YAED,gDAAgD;YAChD,MAAM,KAAK,GAAG;gBACZ,SAAS,EAAG,gBAAgB,CAAC,OAAO;gBACpC,QAAQ,EAAI,OAAO,CAAC,QAAQ;aAC7B,CAAC;YACF,MAAM,EAAE,QAAQ,EAAE,gBAAgB,EAAE,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,MAAM,EAAE,CAAE,KAAK,CAAE,CAAC,CAAC;YAExF,mEAAmE;YACnE,+EAA+E;YAC/E,MAAM,kBAAkB,GAAG,MAAM,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;YACzD,KAAK,MAAM,eAAe,IAAI,gBAAgB,EAAE,CAAC;gBAC/C,MAAM,WAAW,GAAG,MAAM,OAAO,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC;gBAC1D,IAAI,WAAW,KAAK,kBAAkB,EAAE,CAAC;oBACvC,OAAO,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,GAAG,EAAE,MAAM,EAAE,UAAU,EAAE,EAAE,CAAC;gBACvD,CAAC;YACH,CAAC;YAGD,gIAAgI;YAChI,MAAM,wBAAwB,GAAG,MAAM,YAAY,CAAC,cAAc,EAAE,CAAC;YACrE,IAAI,CAAC,wBAAwB,EAAE,CAAC;gBAC9B,IAAI,CAAC;oBACH,MAAM,YAAY,GAAG,MAAM,YAAY,CAAC,eAAe,CAAC,gBAAgB,CAAC,CAAC;oBAC1E,YAAY,CAAC,mCAAmC,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;gBAC1E,CAAC;gBAAC,OAAO,CAAC,EAAE,CAAC;oBACX,OAAO,qBAAqB,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;gBACvC,CAAC;YACH,CAAC;YAED,MAAM,qBAAqB,GAAG,MAAM,OAAO,CAAC,gBAAgB,CAAC,gBAAgB,CAAC,CAAC;YAE/E,IAAI,uBAAuB,GAAG,KAAK,CAAC;YACpC,IAAI,aAAa,CAAC,CAAC,qDAAqD;YACxE,IAAI,qBAAqB,KAAK,SAAS,KAAI,MAAM,OAAO,CAAC,OAAO,CAAC,OAAO,EAAE,qBAAqB,CAAC,CAAA,EAAE,CAAC;gBACjG,uBAAuB,GAAG,IAAI,CAAC;gBAC/B,aAAa,GAAG,OAAO,CAAC;YAC1B,CAAC;iBAAM,CAAC,CAAC,sEAAsE;gBAC7E,aAAa,GAAG,qBAAqB,CAAC;YACxC,CAAC;YAED,IAAI,CAAC,uBAAuB,EAAE,CAAC;gBAC7B,OAAO;oBACL,MAAM,EAAE,EAAE,IAAI,EAAE,GAAG,EAAE,MAAM,EAAE,UAAU,EAAE;iBAC1C,CAAC;YACJ,CAAC;YAED,MAAM,iBAAiB,GAAG,IAAI,CAAC;YAC/B,MAAM,OAAO,GAAG,MAAM,YAAY,CAAC,4BAA4B,CAAC,iBAAiB,CAAC,CAAC;YAEnF,iHAAiH;YACjH,IAAI,8BAA8B,GAA+C,OAAO,CAAC;YAEzF,mEAAmE;YACnE,IAAI,OAAO,KAAK,SAAS,IAAI,CAAC,OAAO,CAAC,eAAe,EAAE,CAAC;gBACtD,IAAI,UAAU,KAAK,SAAS,IAAI,CAAA,qBAAqB,aAArB,qBAAqB,uBAArB,qBAAqB,CAAE,UAAU,CAAC,MAAM,MAAK,aAAa,CAAC,MAAM,EAAE,CAAC;oBAClG,OAAO,qBAAqB,CAAC,IAAI,QAAQ,CAAC,YAAY,CAAC,6BAA6B,EAAE,sEAAsE,CAAC,EAAE,GAAG,CAAC,CAAC;gBACtK,CAAC;gBAED,IAAI,CAAC;oBACH,kEAAkE;oBAClE,IAAI,OAAO,CAAC,UAAU,CAAC,QAAQ,IAAI,WAAW,CAAC,6BAA6B,EAAE,CAAC;wBAC7E,0DAA0D;wBAC1D,8BAA8B,GAAG,MAAM,IAAI,CAAC,kBAAkB,CAC5D,OAAO,EACP,UAAU,EACV,qBAA+E,CAChF,CAAC;oBACJ,CAAC;yBAAM,CAAC;wBACN,MAAM,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC;oBAClD,CAAC;gBACH,CAAC;gBAAC,OAAO,KAAK,EAAE,CAAC;oBACf,MAAM,CAAC,GAAG,KAAY,CAAC;oBACvB,IAAI,CAAC,CAAC,IAAI,KAAK,YAAY,CAAC,iCAAiC;wBACzD,CAAC,CAAC,IAAI,KAAK,YAAY,CAAC,kCAAkC;wBAC1D,CAAC,CAAC,IAAI,KAAK,YAAY,CAAC,2BAA2B;wBACnD,CAAC,CAAC,IAAI,KAAK,YAAY,CAAC,4BAA4B,EAAE,CAAC;wBACzD,OAAO,qBAAqB,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;oBAC3C,CAAC;oBAED,aAAa;oBACb,MAAM,KAAK,CAAC;gBACd,CAAC;YACH,CAAC;YAED,MAAM,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,MAAM,EAAE,8BAA8B,EAAE,OAAO,CAAC,CAAC;YAC7E,MAAM,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC;YAElE,MAAM,YAAY,GAAG;gBACnB,MAAM,EAAE,EAAE,IAAI,EAAE,GAAG,EAAE,MAAM,EAAE,UAAU,EAAE;aAC1C,CAAC;YAEF,iFAAiF;YACjF,MAAM,iBAAiB,CAAC,yCAAyC,CAC/D,MAAM,EAAE,gBAAgB,EAAE,aAAa,EAAE,IAAI,CAAC,YAAY,EAAE,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,QAAQ,CAC1F,CAAC;YAEF,OAAO,YAAY,CAAC;QACtB,CAAC;KAAA;IAAA,CAAC;IAEF;;;;;;;;;;;;OAYG;IACU,kBAAkB,CAC7B,OAA4B,EAC5B,UAA+B,EAC/B,qBAAkE;;YAElE,IAAI,SAAS,CAAC;YACd,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;gBAC7B,MAAM,cAAc,GAAG,qBAA+E,CAAC;gBACvG,IAAI,CAAA,cAAc,aAAd,cAAc,uBAAd,cAAc,CAAE,WAAW,MAAK,SAAS,EAAE,CAAC;oBAC9C,MAAM,IAAI,QAAQ,CAChB,YAAY,CAAC,iCAAiC,EAC9C,yEAAyE,CAC1E,CAAC;gBACJ,CAAC;qBAAM,CAAC;oBACN,SAAS,GAAG,OAAO,CAAC,gBAAgB,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC;gBACnE,CAAC;YACH,CAAC;iBAAM,CAAC;gBACN,SAAS,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;YACnD,CAAC;YAED,MAAM,OAAO,GAAG,MAAM,GAAG,CAAC,wBAAwB,CAAC,SAAS,CAAC,CAAC;YAC9D,mBAAmB,CAAC,qBAAqB,CAAC,OAAO,CAAC,UAAU,CAAC,OAAO,EAAE,OAAO,CAAC,UAAU,CAAC,QAAQ,EAAE,OAAO,EAAE,SAAS,CAAC,MAAM,CAAC,CAAC;YAE9H,MAAM,YAAY,qBAAoD,OAAO,CAAE,CAAC;YAChF,YAAY,CAAC,WAAW,GAAG,OAAO,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC;YAC/D,OAAO,YAAY,CAAC;QACtB,CAAC;KAAA;IAED;;;;;;;;;OASG;IACU,OAAO,CAClB,MAAc,EACd,OAA4B,EAC5B,UAA+B;;YAE/B,IAAI,MAA6C,CAAC;YAClD,MAAM,UAAU,GAAG,MAAM,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;YAEjD,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;gBAC7B,MAAM,eAAe,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,MAAM,EAAE,UAAU,EAAE,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;gBACvG,IAAI,eAAe,KAAK,SAAS,EAAE,CAAC;oBAClC,MAAM,IAAI,QAAQ,CAAC,YAAY,CAAC,kCAAkC,EAAE,+BAA+B,OAAO,CAAC,UAAU,CAAC,OAAO,GAAG;wBAC9H,iBAAiB,UAAU,0EAA0E,CAAC,CAAC;gBAC3G,CAAC;gBACD,MAAM,GAAG,eAAe,CAAC;YAC3B,CAAC;iBAAM,CAAC;gBACN,MAAM,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,MAAM,EAAE,UAAU,EAAE,OAAO,CAAC,UAAU,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;YAChG,CAAC;YAED,IAAI,CAAC;gBACH,mBAAmB,CAAC,qBAAqB,CAAC,OAAO,CAAC,UAAU,CAAC,OAAO,EAAE,OAAO,CAAC,UAAU,CAAC,QAAQ,EAAE,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAC;YACtI,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,wCAAwC;gBACxC,MAAM,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,MAAM,EAAE,UAAU,EAAE,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;gBAC5E,MAAM,KAAK,CAAC;YACd,CAAC;QACH,CAAC;KAAA;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,qBAAqB,CAC1B,eAAuB,EACvB,gBAAwB,EACxB,aAAqB,EACrB,cAAsB;QAEtB,IAAI,eAAe,KAAK,aAAa,EAAE,CAAC;YACtC,MAAM,IAAI,QAAQ,CAChB,YAAY,CAAC,2BAA2B,EACxC,mBAAmB,aAAa,0CAA0C,eAAe,EAAE,CAC5F,CAAC;QACJ,CAAC;QACD,IAAI,gBAAgB,KAAK,cAAc,EAAE,CAAC;YACxC,MAAM,IAAI,QAAQ,CAChB,YAAY,CAAC,4BAA4B,EACzC,oBAAoB,cAAc,iDAAiD,gBAAgB,EAAE,CACtG,CAAC;QACJ,CAAC;IACH,CAAC;IAEO,MAAM,CAAO,qBAAqB,CAAC,MAAc,EAAE,YAA0B,EAAE,YAA0B;;YAC/G,mEAAmE;YACnE,IAAI,YAAY,CAAC,KAAK,KAAK,SAAS,IAAI,YAAY,CAAC,KAAK,KAAK,MAAM,EAAE,CAAC;gBACtE,MAAM,IAAI,QAAQ,CAChB,YAAY,CAAC,kCAAkC,EAC/C,SAAS,YAAY,CAAC,KAAK,+BAA+B,MAAM,kBAAkB,CACnF,CAAC;YACJ,CAAC;YAED,IAAI,YAAY,CAAC,mBAAmB,EAAE,CAAC;gBACrC,MAAM,YAAY,CAAC,kBAAkB,CAAC,YAAY,CAAC,CAAC;YACtD,CAAC;YAED,IAAI,YAAY,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;gBACrC,oFAAoF;gBACpF,4EAA4E;gBAC5E,OAAO;YACT,CAAC;iBAAM,IAAI,YAAY,CAAC,MAAM,KAAK,MAAM,EAAE,CAAC;gBAC1C,2EAA2E;gBAC3E,OAAO;YACT,CAAC;iBAAM,IAAI,YAAY,CAAC,MAAM,KAAK,SAAS,IAAI,YAAY,CAAC,gBAAiB,CAAC,kBAAkB,KAAK,SAAS,EAAE,CAAC;gBAChH,MAAM,uBAAuB,GAAG,MAAM,kBAAkB,CAAC,UAAU,CAAC,MAAM,EAAE,YAAY,EAAE,YAAY,CAAC,gBAAiB,CAAC,kBAAkB,CAAC,CAAC;gBAC7I,MAAM,yBAAyB,CAAC,cAAc,CAAC,MAAM,EAAE,YAAY,CAAC,OAAO,EAAE,YAAY,CAAC,MAAM,EAAE,uBAAuB,EAAE,YAAY,CAAC,CAAC;YAC3I,CAAC;iBAAM,IAAI,YAAY,CAAC,OAAO,CAAC,UAAU,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;gBAClE,MAAM,qBAAqB,CAAC,cAAc,CAAC,MAAM,EAAE,YAAY,EAAE,YAAY,CAAC,CAAC;YACjF,CAAC;iBAAM,CAAC;gBACN,MAAM,IAAI,QAAQ,CAAC,YAAY,CAAC,+BAA+B,EAAE,8BAA8B,CAAC,CAAC;YACnG,CAAC;QACH,CAAC;KAAA;CAEF"}