@icure/api 7.1.14 → 8.0.0-RC.1

package/icc-x-api/icc-document-x-api.js

@@ -16,6 +16,8 @@ const XHR_1 = require("../icc-api/api/XHR");
 const models = require("../icc-api/model/models");
 const binary_utils_1 = require("./utils/binary-utils");
 const AuthenticationProvider_1 = require("./auth/AuthenticationProvider");
+const SecureDelegation_1 = require("../icc-api/model/SecureDelegation");
+var AccessLevelEnum = SecureDelegation_1.SecureDelegation.AccessLevelEnum;
 // noinspection JSUnusedGlobalSymbols
 class IccDocumentXApi extends icc_api_1.IccDocumentApi {
     constructor(host, headers, crypto, authApi, dataOwnerApi, authenticationProvider = new AuthenticationProvider_1.NoAuthenticationProvider(), fetchImpl = typeof window !== 'undefined'
@@ -419,6 +421,9 @@ class IccDocumentXApi extends icc_api_1.IccDocumentApi {
         this.authenticationProvider = authenticationProvider;
         this.dataOwnerApi = dataOwnerApi;
     }
+    get headers() {
+        return super.headers.then((h) => this.crypto.accessControlKeysHeaders.addAccessControlKeysHeaders(h, 'Document'));
+    }
     /**
      * Creates a new instance of document with initialised encryption metadata (not in the database).
      * @param user the current user.
@@ -428,10 +433,9 @@ class IccDocumentXApi extends icc_api_1.IccDocumentApi {
      * @param options optional parameters:
      * - additionalDelegates: delegates which will have access to the entity in addition to the current data owner and delegates from the
      * auto-delegations. Must be an object which associates each data owner id with the access level to give to that data owner. May overlap with
-     * auto-delegations, in such case the access level specified here will be used. Currently only WRITE access is supported, but in future also read
-     * access will be possible.
-     * - preferredSfk: secret id of the patient to use as the secret foreign key to use for the classification. The default value will be a
-     * secret id of patient known by the topmost parent in the current data owner hierarchy.
+     * auto-delegations, in such case the access level specified here will be used.
+     * - preferredSfk: secret id of the message to use as the secret foreign key to use for the document. The default value will be a
+     * secret id of the message known by the topmost parent in the current data owner hierarchy.
      * @return a new instance of document.
      */
     newInstance(user, message, c = {}, options = {}) {
@@ -443,23 +447,21 @@ class IccDocumentXApi extends icc_api_1.IccDocumentApi {
             const ownerId = this.dataOwnerApi.getDataOwnerIdOf(user);
             if (ownerId !== (yield this.dataOwnerApi.getCurrentDataOwnerId()))
                 throw new Error('Can only initialise entities as current data owner.');
-            const sfk = message ? (_h = options.preferredSfk) !== null && _h !== void 0 ? _h : (yield this.crypto.confidential.getAnySecretIdSharedWithParents(message)) : undefined;
+            const sfk = message
+                ? (_h = options.preferredSfk) !== null && _h !== void 0 ? _h : (yield this.crypto.confidential.getAnySecretIdSharedWithParents({ entity: message, type: 'Message' }))
+                : undefined;
             if (message && !sfk)
                 throw new Error(`Couldn't find any sfk of parent message ${message.id}`);
-            const extraDelegations = [
-                ...Object.keys((_j = options.additionalDelegates) !== null && _j !== void 0 ? _j : {}),
-                ...((_l = (_k = user.autoDelegations) === null || _k === void 0 ? void 0 : _k.all) !== null && _l !== void 0 ? _l : []),
-                ...((_o = (_m = user.autoDelegations) === null || _m === void 0 ? void 0 : _m.medicalInformation) !== null && _o !== void 0 ? _o : []),
-            ];
-            return new models.Document(yield this.crypto.entities
-                .entityWithInitialisedEncryptedMetadata(document, message === null || message === void 0 ? void 0 : message.id, sfk, true, extraDelegations)
+            const extraDelegations = Object.assign(Object.assign({}, Object.fromEntries([...((_k = (_j = user.autoDelegations) === null || _j === void 0 ? void 0 : _j.all) !== null && _k !== void 0 ? _k : []), ...((_m = (_l = user.autoDelegations) === null || _l === void 0 ? void 0 : _l.medicalInformation) !== null && _m !== void 0 ? _m : [])].map((d) => [d, AccessLevelEnum.WRITE]))), ((_o = options === null || options === void 0 ? void 0 : options.additionalDelegates) !== null && _o !== void 0 ? _o : {}));
+            return new models.Document(yield this.crypto.xapi
+                .entityWithInitialisedEncryptedMetadata(document, 'Document', message === null || message === void 0 ? void 0 : message.id, sfk, true, false, extraDelegations)
                 .then((x) => x.updatedEntity));
         });
     }
     // noinspection JSUnusedGlobalSymbols
     findByMessage(hcpartyId, message) {
         return __awaiter(this, void 0, void 0, function* () {
-            const extractedKeys = yield this.crypto.entities.secretIdsOf(message, hcpartyId);
+            const extractedKeys = yield this.crypto.xapi.secretIdsOf({ entity: message, type: 'Message' }, hcpartyId);
             const topmostParentId = (yield this.dataOwnerApi.getCurrentDataOwnerHierarchyIds())[0];
             let documents = yield this.findDocumentsByHCPartyPatientForeignKeys(topmostParentId, _.uniq(extractedKeys).join(','));
             return yield this.decrypt(hcpartyId, documents);
@@ -467,19 +469,17 @@ class IccDocumentXApi extends icc_api_1.IccDocumentApi {
     }
     // Note: this is only for dealing with legacy documents: new document are not encrypted, only their attachments are
     decrypt(hcpartyId, documents) {
-        return Promise.all(documents.map((document) => this.crypto
-            .extractKeysFromDelegationsForHcpHierarchy(hcpartyId, document.id, _.size(document.encryptionKeys) ? document.encryptionKeys : document.delegations)
-            .then(({ extractedKeys: sfks }) => {
-            if (!sfks || !sfks.length) {
+        return Promise.all(documents.map((document) => this.crypto.xapi.decryptAndImportAllDecryptionKeys({ entity: document, type: 'Document' }).then((keys) => {
+            if (!keys.length) {
                 console.log('Cannot decrypt document', document.id);
                 return Promise.resolve(document);
             }
-            if (sfks.length && (document.encryptedSelf || document.encryptedAttachment)) {
-                return this.crypto.AES.importKey('raw', (0, binary_utils_1.hex2ua)(sfks[0].replace(/-/g, '')))
-                    .then((key) => Promise.all([
+            if (keys.length && (document.encryptedSelf || document.encryptedAttachment)) {
+                const key = keys[0].key;
+                return Promise.all([
                     document.encryptedSelf
                         ? new Promise((resolve) => {
-                            this.crypto.AES.decrypt(key, (0, binary_utils_1.string2ua)((0, binary_utils_1.a2b)(document.encryptedSelf))).then(resolve, () => {
+                            this.crypto.primitives.AES.decrypt(key, (0, binary_utils_1.string2ua)((0, binary_utils_1.a2b)(document.encryptedSelf))).then(resolve, () => {
                                 console.log('Cannot decrypt document', document.id);
                                 resolve(null);
                             });
@@ -487,14 +487,13 @@ class IccDocumentXApi extends icc_api_1.IccDocumentApi {
                         : Promise.resolve(null),
                     document.encryptedAttachment
                         ? new Promise((resolve) => {
-                            this.crypto.AES.decrypt(key, document.encryptedAttachment).then(resolve, () => {
+                            this.crypto.primitives.AES.decrypt(key, document.encryptedAttachment).then(resolve, () => {
                                 console.log('Cannot decrypt document', document.id);
                                 resolve(null);
                             });
                         })
                         : Promise.resolve(null),
-                ]))
-                    .then((decrypted) => {
+                ]).then((decrypted) => {
                     if (decrypted) {
                         if (decrypted[0]) {
                             document = _.extend(document, JSON.parse((0, binary_utils_1.ua2string)(decrypted[0])));
@@ -514,16 +513,29 @@ class IccDocumentXApi extends icc_api_1.IccDocumentApi {
             return Promise.resolve(documents);
         });
     }
+    /**
+     * @deprecated use getMainAttachmentAs instead
+     */
     getAttachmentAs(documentId, attachmentId, returnType, enckeys, fileName) {
-        const url = this.host +
-            `/document/${documentId}/attachment/${attachmentId}` +
-            '?ts=' +
-            new Date().getTime() +
-            (enckeys ? `&enckeys=${enckeys}` : '') +
-            (fileName ? `&fileName=${fileName}` : '');
-        return XHR_1.XHR.sendCommand('GET', url, this.headers, null, this.fetchImpl, returnType, this.authenticationProvider.getAuthService())
-            .then((doc) => doc.body)
-            .catch((err) => this.handleError(err));
+        return __awaiter(this, void 0, void 0, function* () {
+            const url = this.host +
+                `/document/${documentId}/attachment/${attachmentId}` +
+                '?ts=' +
+                new Date().getTime() +
+                (enckeys ? `&enckeys=${enckeys}` : '') +
+                (fileName ? `&fileName=${fileName}` : '');
+            return XHR_1.XHR.sendCommand('GET', url, yield this.headers, null, this.fetchImpl, returnType, this.authenticationProvider.getAuthService())
+                .then((doc) => doc.body)
+                .catch((err) => this.handleError(err));
+        });
+    }
+    getMainAttachmentAs(documentId, returnType) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const url = this.host + `/document/${documentId}/attachment` + '?ts=' + new Date().getTime();
+            return XHR_1.XHR.sendCommand('GET', url, yield this.headers, null, this.fetchImpl, returnType, this.authenticationProvider.getAuthService())
+                .then((doc) => doc.body)
+                .catch((err) => this.handleError(err));
+        });
     }
     // noinspection JSUnusedGlobalSymbols
     getAttachmentUrl(documentId, attachmentId, sfks, fileName) {
@@ -551,9 +563,12 @@ class IccDocumentXApi extends icc_api_1.IccDocumentApi {
      * @return the updated document.
      */
     encryptAndSetDocumentAttachment(document, attachment, utis) {
+        var _a;
         return __awaiter(this, void 0, void 0, function* () {
-            const encryptedData = yield this.crypto.entities.encryptDataOf(document, attachment);
-            return yield this.setDocumentAttachment(document.id, undefined, encryptedData, utis);
+            if (!document.rev)
+                throw new Error('Cannot set attachment on document without rev');
+            const { encryptedData, updatedEntity } = yield this.crypto.xapi.encryptDataOf(document, 'Document', attachment, (d) => this.modifyDocument(d));
+            return yield this.setMainDocumentAttachment(document.id, (_a = updatedEntity === null || updatedEntity === void 0 ? void 0 : updatedEntity.rev) !== null && _a !== void 0 ? _a : document.rev, encryptedData, utis);
         });
     }
     /**
@@ -566,7 +581,9 @@ class IccDocumentXApi extends icc_api_1.IccDocumentApi {
      */
     setClearDocumentAttachment(document, attachment, utis) {
         return __awaiter(this, void 0, void 0, function* () {
-            return yield this.setDocumentAttachment(document.id, undefined, attachment, utis);
+            if (!document.rev)
+                throw new Error('Cannot set attachment on document without rev');
+            return yield this.setMainDocumentAttachment(document.id, document.rev, attachment, utis);
         });
     }
     /**
@@ -579,9 +596,12 @@ class IccDocumentXApi extends icc_api_1.IccDocumentApi {
      * @return the updated document.
      */
     encryptAndSetSecondaryDocumentAttachment(document, secondaryAttachmentKey, attachment, utis) {
+        var _a;
         return __awaiter(this, void 0, void 0, function* () {
-            const encryptedData = yield this.crypto.entities.encryptDataOf(document, attachment);
-            return yield this.setSecondaryAttachment(document.id, secondaryAttachmentKey, document.rev, encryptedData, utis);
+            if (!document.rev)
+                throw new Error('Cannot set attachment on document without rev');
+            const { encryptedData, updatedEntity } = yield this.crypto.xapi.encryptDataOf(document, 'Document', attachment, (d) => this.modifyDocument());
+            return yield this.setSecondaryAttachment(document.id, secondaryAttachmentKey, (_a = updatedEntity === null || updatedEntity === void 0 ? void 0 : updatedEntity.rev) !== null && _a !== void 0 ? _a : document.rev, encryptedData, utis);
         });
     }
     /**
@@ -607,10 +627,10 @@ class IccDocumentXApi extends icc_api_1.IccDocumentApi {
      */
     getAndDecryptDocumentAttachment(document, validator = () => Promise.resolve(true)) {
         return __awaiter(this, void 0, void 0, function* () {
-            const { data, wasDecrypted } = yield this.crypto.entities.tryDecryptDataOf(document, yield this.getDocumentAttachment(document.id, 'ignored'), (x) => validator(x));
-            if (!wasDecrypted)
+            const retrieved = yield this.getAndTryDecryptDocumentAttachment(document, (x) => validator(x));
+            if (!retrieved.wasDecrypted)
                 throw new Error(`No valid key found to decrypt data of document ${document.id}.`);
-            return data;
+            return retrieved.data;
         });
     }
     /**
@@ -624,7 +644,7 @@ class IccDocumentXApi extends icc_api_1.IccDocumentApi {
      */
     getAndTryDecryptDocumentAttachment(document, validator = () => Promise.resolve(true)) {
         return __awaiter(this, void 0, void 0, function* () {
-            return yield this.crypto.entities.tryDecryptDataOf(document, yield this.getDocumentAttachment(document.id, 'ignored'), (x) => validator(x));
+            return yield this.crypto.xapi.tryDecryptDataOf({ entity: document, type: 'Document' }, yield this.getMainDocumentAttachment(document.id), (x) => validator(x));
         });
     }
     /**
@@ -637,7 +657,7 @@ class IccDocumentXApi extends icc_api_1.IccDocumentApi {
      */
     getAndDecryptSecondaryDocumentAttachment(document, secondaryAttachmentKey, validator = () => Promise.resolve(true)) {
         return __awaiter(this, void 0, void 0, function* () {
-            const { data, wasDecrypted } = yield this.crypto.entities.tryDecryptDataOf(document, yield this.getSecondaryAttachment(document.id, secondaryAttachmentKey), (x) => validator(x));
+            const { data, wasDecrypted } = yield this.getAndTryDecryptSecondaryDocumentAttachment(document, secondaryAttachmentKey, (x) => validator(x));
             if (!wasDecrypted)
                 throw new Error(`No valid key found to decrypt data of document ${document.id}.`);
             return data;
@@ -655,7 +675,7 @@ class IccDocumentXApi extends icc_api_1.IccDocumentApi {
      */
     getAndTryDecryptSecondaryDocumentAttachment(document, secondaryAttachmentKey, validator = () => Promise.resolve(true)) {
         return __awaiter(this, void 0, void 0, function* () {
-            return yield this.crypto.entities.tryDecryptDataOf(document, yield this.getSecondaryAttachment(document.id, secondaryAttachmentKey), (x) => validator(x));
+            return yield this.crypto.xapi.tryDecryptDataOf({ entity: document, type: 'Document' }, yield this.getSecondaryAttachment(document.id, secondaryAttachmentKey), (x) => validator(x));
         });
     }
     /**
@@ -665,12 +685,20 @@ class IccDocumentXApi extends icc_api_1.IccDocumentApi {
      */
     decryptMessageIdOf(document) {
         return __awaiter(this, void 0, void 0, function* () {
-            return this.crypto.entities.owningEntityIdsOf(document, undefined);
+            return this.crypto.xapi.owningEntityIdsOf({ entity: document, type: 'Document' }, undefined);
+        });
+    }
+    /**
+     * @return if the logged data owner has write access to the content of the given document
+     */
+    hasWriteAccess(document) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.crypto.xapi.hasWriteAccess({ entity: document, type: 'Document' });
         });
     }
     /**
      * Share an existing document with other data owners, allowing them to access the non-encrypted data of the document and optionally also
-     * the encrypted content.
+     * the encrypted content, with read-only or read-write permissions.
      * @param delegateId the id of the data owner which will be granted access to the document.
      * @param document the document to share.
      * @param options optional parameters to customize the sharing behaviour:
@@ -678,7 +706,8 @@ class IccDocumentXApi extends icc_api_1.IccDocumentApi {
      * content of the entity, excluding other encrypted metadata (defaults to {@link ShareMetadataBehaviour.IF_AVAILABLE}).
      * - shareMessageId: specifies if the id of the message that this document refers to should be shared with the delegate (defaults to
      * {@link ShareMetadataBehaviour.IF_AVAILABLE}).
-     * @return a promise which will contain the updated document.
+     * - requestedPermissions: the requested permissions for the delegate, defaults to {@link RequestedPermissionEnum.MAX_WRITE}.
+     * @return the updated entity
      */
     shareWith(delegateId, document, options = {}) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -687,40 +716,58 @@ class IccDocumentXApi extends icc_api_1.IccDocumentApi {
     }
     /**
      * Share an existing document with other data owners, allowing them to access the non-encrypted data of the document and optionally also
-     * the encrypted content.
+     * the encrypted content, with read-only or read-write permissions.
      * @param document the document to share.
-     * @param delegates sharing options for each delegate.
+     * @param delegates associates the id of data owners which will be granted access to the entity, to the following sharing options:
      * - shareEncryptionKey: specifies if the encryption key of the access log should be shared with the delegate, giving access to all encrypted
      * content of the entity, excluding other encrypted metadata (defaults to {@link ShareMetadataBehaviour.IF_AVAILABLE}).
      * - shareMessageId: specifies if the id of the message that this document refers to should be shared with the delegate (defaults to
      * {@link ShareMetadataBehaviour.IF_AVAILABLE}).
-     * @return a promise which will contain the updated document.
+     * - requestedPermissions: the requested permissions for the delegate, defaults to {@link RequestedPermissionEnum.MAX_WRITE}.
+     * @return the updated entity.
      */
     shareWithMany(document, delegates) {
         return __awaiter(this, void 0, void 0, function* () {
-            const extended = yield this.crypto.entities.entityWithAutoExtendedEncryptedMetadata(document, true, Object.fromEntries(Object.entries(delegates).map(([delegateId, options]) => [
+            return (yield this.tryShareWithMany(document, delegates)).updatedEntityOrThrow;
+        });
+    }
+    /**
+     * Share an existing document with other data owners, allowing them to access the non-encrypted data of the document and optionally also
+     * the encrypted content, with read-only or read-write permissions.
+     * @param document the document to share.
+     * @param delegates associates the id of data owners which will be granted access to the entity, to the following sharing options:
+     * - shareEncryptionKey: specifies if the encryption key of the access log should be shared with the delegate, giving access to all encrypted
+     * content of the entity, excluding other encrypted metadata (defaults to {@link ShareMetadataBehaviour.IF_AVAILABLE}).
+     * - shareMessageId: specifies if the id of the message that this document refers to should be shared with the delegate (defaults to
+     * {@link ShareMetadataBehaviour.IF_AVAILABLE}).
+     * - requestedPermissions: the requested permissions for the delegate, defaults to {@link RequestedPermissionEnum.MAX_WRITE}.
+     * @return a promise which will contain the result of the operation: the updated entity if the operation was successful or details of the error if
+     * the operation failed.
+     */
+    tryShareWithMany(document, delegates) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const self = yield this.dataOwnerApi.getCurrentDataOwnerId();
+            // All entities should have an encryption key.
+            const entityWithEncryptionKey = yield this.crypto.xapi.ensureEncryptionKeysInitialised(document, 'Document');
+            const updatedEntity = entityWithEncryptionKey ? yield this.modifyDocument(entityWithEncryptionKey) : document;
+            return this.crypto.xapi
+                .simpleShareOrUpdateEncryptedEntityMetadata({ entity: updatedEntity, type: 'Document' }, true, Object.fromEntries(Object.entries(delegates).map(([delegateId, options]) => [
                 delegateId,
                 {
-                    shareEncryptionKey: options.shareEncryptionKey,
+                    requestedPermissions: options.requestedPermissions,
+                    shareEncryptionKeys: options.shareEncryptionKey,
                     shareOwningEntityIds: options.shareMessageId,
+                    shareSecretIds: undefined,
                 },
-            ])));
-            if (!!extended) {
-                return yield this.modifyDocument(extended);
-            }
-            else
-                return document;
+            ])), (x) => this.bulkShareDocument(x))
+                .then((r) => r.mapSuccessAsync((e) => this.decrypt(self, [e]).then((es) => es[0])));
         });
     }
     getDataOwnersWithAccessTo(entity) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return yield this.crypto.entities.getDataOwnersWithAccessTo(entity);
-        });
+        return this.crypto.xapi.getDataOwnersWithAccessTo({ entity, type: 'Document' });
     }
     getEncryptionKeysOf(entity) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return yield this.crypto.entities.encryptionKeysOf(entity);
-        });
+        return this.crypto.xapi.encryptionKeysOf({ entity, type: 'Document' }, undefined);
     }
 }
 exports.IccDocumentXApi = IccDocumentXApi;