@icure/api 8.6.5 → 8.6.7

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

@@ -464,7 +464,7 @@ class IccDocumentXApi extends icc_api_1.IccDocumentApi {
     }
     // noinspection JSUnusedGlobalSymbols
     /**
-     * Same as {@link findByMessage} but it will only return the ids of the contacts. It can also filter the documents where Document.created is between
+     * Same as {@link findByMessage} but it will only return the ids of the documents. It can also filter the documents where Document.created is between
      * startDate and endDate in ascending or descending order by that field. (default: ascending).
      */
     findIdsByMessage(hcpartyId, message, startDate, endDate, descending) {
@@ -474,11 +474,21 @@ class IccDocumentXApi extends icc_api_1.IccDocumentApi {
             return this.findDocumentIdsByDataOwnerSecretForeignKey(topmostParentId, _.uniq(extractedKeys), startDate, endDate, descending);
         });
     }
+    /**
+     * Decrypts an array of documents.
+     * @param documents the documents to decrypt.
+     * @return an array of objects containing the document and a flag indicating if it was successfully decrypted.
+     */
     decrypt(documents) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.crypto.xapi.tryDecryptEntities(documents, utils_1.EntityWithDelegationTypeName.Document, (x) => new models.Document(x));
         });
     }
+    /**
+     * Encrypts an array of documents.
+     * @param documents the documents to encrypt.
+     * @return the encrypted documents.
+     */
     encrypt(documents) {
         return this.crypto.xapi.tryEncryptEntities(documents, utils_1.EntityWithDelegationTypeName.Document, this.encryptedFields, true, false, (x) => new models.Document(x));
     }
@@ -493,6 +503,13 @@ class IccDocumentXApi extends icc_api_1.IccDocumentApi {
             return this.getMainAttachmentAs(documentId, returnType);
         });
     }
+    /**
+     * Gets the main attachment of a document without decrypting it.
+     * @param documentId the id of the document.
+     * @param returnType the desired return type for the attachment data.
+     * @param tryHardToParseJson if true, will attempt to parse JSON even if the content type is not application/json.
+     * @return the attachment data in the requested format.
+     */
     getMainAttachmentAs(documentId_1, returnType_1) {
         return __awaiter(this, arguments, void 0, function* (documentId, returnType, tryHardToParseJson = false) {
             const url = this.host + `/document/${documentId}/attachment` + '?ts=' + new Date().getTime();
@@ -501,6 +518,12 @@ class IccDocumentXApi extends icc_api_1.IccDocumentApi {
                 .catch((err) => this.handleError(err));
         });
     }
+    /**
+     * Gets and decrypts the main attachment of a document, parsing it to the requested format.
+     * @param document the document containing the attachment.
+     * @param returnType the desired return type for the attachment data.
+     * @return the decrypted and parsed attachment data, or undefined if decryption failed or parsing was unsuccessful.
+     */
     getAndTryDecryptMainAttachmentAs(document, returnType) {
         return __awaiter(this, void 0, void 0, function* () {
             const key = (yield this.crypto.xapi.encryptionKeysOf({ entity: document, type: utils_1.EntityWithDelegationTypeName.Document }, undefined))[0];
@@ -543,10 +566,21 @@ class IccDocumentXApi extends icc_api_1.IccDocumentApi {
             throw new Error(`Unsupported type ${returnType}`);
     }
     // noinspection JSUnusedGlobalSymbols
+    /**
+     * Converts a MIME type and file extension to a UTI (Uniform Type Identifier).
+     * @param mimeType the MIME type.
+     * @param extension the file extension.
+     * @return the corresponding UTI.
+     */
     uti(mimeType, extension) {
         return (mimeType && mimeType !== 'application/octet-stream' ? this.utiDefs[mimeType] : this.utiExts[extension]) || this.utiDefs[mimeType];
     }
     // noinspection JSUnusedGlobalSymbols
+    /**
+     * Converts a UTI (Uniform Type Identifier) to a MIME type.
+     * @param uti the UTI.
+     * @return the corresponding MIME type.
+     */
     mimeType(uti) {
         return this.utiRevDefs[uti];
     }
@@ -789,12 +823,27 @@ class IccDocumentXApi extends icc_api_1.IccDocumentApi {
                 .then((r) => r.mapSuccessAsync((m) => __awaiter(this, void 0, void 0, function* () { return (yield this.decrypt([m]))[0].entity; })));
         });
     }
+    /**
+     * Gets the data owners that have access to a document.
+     * @param entity the document.
+     * @return an object containing the permissions by data owner id and a flag indicating if there are unknown anonymous data owners.
+     */
     getDataOwnersWithAccessTo(entity) {
         return this.crypto.delegationsDeAnonymization.getDataOwnersWithAccessTo({ entity, type: utils_1.EntityWithDelegationTypeName.Document });
     }
+    /**
+     * Gets the encryption keys of a document.
+     * @param entity the document.
+     * @return an array of encryption keys.
+     */
     getEncryptionKeysOf(entity) {
         return this.crypto.xapi.encryptionKeysOf({ entity, type: utils_1.EntityWithDelegationTypeName.Document }, undefined);
     }
+    /**
+     * Creates delegation de-anonymization metadata for a document.
+     * @param entity the document.
+     * @param delegates the data owner ids of the delegates.
+     */
     createDelegationDeAnonymizationMetadata(entity, delegates) {
         return this.crypto.delegationsDeAnonymization.createOrUpdateDeAnonymizationInfo({ entity, type: utils_1.EntityWithDelegationTypeName.Document }, delegates);
     }
@@ -804,6 +853,12 @@ class IccDocumentXApi extends icc_api_1.IccDocumentApi {
             return Object.assign(Object.assign({}, page), { rows: (yield this.decrypt((_a = page.rows) !== null && _a !== void 0 ? _a : [])).map((x) => x.entity) });
         });
     }
+    /**
+     * Creates a new document.
+     * @param user the user (not used).
+     * @param body the document to create.
+     * @return the created document.
+     */
     createDocumentWithUser(user, body) {
         const _super = Object.create(null, {
             createDocument: { get: () => super.createDocument }
@@ -812,6 +867,12 @@ class IccDocumentXApi extends icc_api_1.IccDocumentApi {
             return (yield this.decrypt([yield _super.createDocument.call(this, (yield this.encrypt([body]))[0])]))[0].entity;
         });
     }
+    /**
+     * Deletes the main attachment of a document.
+     * @param user the user (not used).
+     * @param documentId the id of the document.
+     * @return the updated document.
+     */
     deleteAttachmentWithUser(user, documentId) {
         const _super = Object.create(null, {
             deleteAttachment: { get: () => super.deleteAttachment }
@@ -861,6 +922,12 @@ class IccDocumentXApi extends icc_api_1.IccDocumentApi {
             return (yield this.decrypt(yield _super.findWithoutDelegation.call(this, limit))).map((x) => x.entity);
         });
     }
+    /**
+     * Gets a document by id.
+     * @param user the user (not used).
+     * @param documentId the id of the document.
+     * @return the document.
+     */
     getDocumentWithUser(user, documentId) {
         const _super = Object.create(null, {
             getDocument: { get: () => super.getDocument }
@@ -869,6 +936,12 @@ class IccDocumentXApi extends icc_api_1.IccDocumentApi {
             return (yield this.decrypt([yield _super.getDocument.call(this, documentId)]))[0].entity;
         });
     }
+    /**
+     * Gets a document by external UUID.
+     * @param user the user (not used).
+     * @param externalUuid the external UUID of the document.
+     * @return the document.
+     */
     getDocumentByExternalUuidWithUser(user, externalUuid) {
         const _super = Object.create(null, {
             getDocumentByExternalUuid: { get: () => super.getDocumentByExternalUuid }
@@ -877,6 +950,12 @@ class IccDocumentXApi extends icc_api_1.IccDocumentApi {
             return (yield this.decrypt([yield _super.getDocumentByExternalUuid.call(this, externalUuid)]))[0].entity;
         });
     }
+    /**
+     * Gets multiple documents by their ids.
+     * @param user the user (not used).
+     * @param body a list of document ids.
+     * @return the documents.
+     */
     getDocumentsWithUser(user, body) {
         const _super = Object.create(null, {
             getDocuments: { get: () => super.getDocuments }
@@ -885,6 +964,12 @@ class IccDocumentXApi extends icc_api_1.IccDocumentApi {
             return (yield this.decrypt(yield _super.getDocuments.call(this, body))).map((x) => x.entity);
         });
     }
+    /**
+     * Gets all documents with a specific external UUID.
+     * @param user the user (not used).
+     * @param externalUuid the external UUID.
+     * @return the documents.
+     */
     getDocumentsByExternalUuidWithUser(user, externalUuid) {
         const _super = Object.create(null, {
             getDocumentsByExternalUuid: { get: () => super.getDocumentsByExternalUuid }
@@ -893,6 +978,12 @@ class IccDocumentXApi extends icc_api_1.IccDocumentApi {
             return (yield this.decrypt(yield _super.getDocumentsByExternalUuid.call(this, externalUuid))).map((x) => x.entity);
         });
     }
+    /**
+     * Updates a document.
+     * @param user the user (not used).
+     * @param body the document to update.
+     * @return the updated document.
+     */
     modifyDocumentWithUser(user, body) {
         const _super = Object.create(null, {
             modifyDocument: { get: () => super.modifyDocument }
@@ -901,6 +992,12 @@ class IccDocumentXApi extends icc_api_1.IccDocumentApi {
             return (yield this.decrypt([yield _super.modifyDocument.call(this, (yield this.encrypt([body]))[0])]))[0].entity;
         });
     }
+    /**
+     * Updates multiple documents.
+     * @param user the user (not used).
+     * @param body the documents to update.
+     * @return the updated documents.
+     */
     modifyDocumentsWithUser(user, body) {
         const _super = Object.create(null, {
             modifyDocuments: { get: () => super.modifyDocuments }
@@ -909,6 +1006,16 @@ class IccDocumentXApi extends icc_api_1.IccDocumentApi {
             return (yield this.decrypt(yield _super.modifyDocuments.call(this, yield this.encrypt(body)))).map((x) => x.entity);
         });
     }
+    /**
+     * Sets the main attachment of a document.
+     * @param user the user (not used).
+     * @param documentId the id of the document.
+     * @param documentRev the revision of the document.
+     * @param body the attachment data.
+     * @param utis an array of UTIs for the attachment.
+     * @param dataIsEncrypted whether the data is already encrypted.
+     * @return the updated document.
+     */
     setMainDocumentAttachmentWithUser(user, documentId, documentRev, body, utis, dataIsEncrypted) {
         const _super = Object.create(null, {
             setMainDocumentAttachment: { get: () => super.setMainDocumentAttachment }
@@ -917,6 +1024,17 @@ class IccDocumentXApi extends icc_api_1.IccDocumentApi {
             return (yield this.decrypt([yield _super.setMainDocumentAttachment.call(this, documentId, documentRev, body, utis, dataIsEncrypted)]))[0].entity;
         });
     }
+    /**
+     * Sets a secondary attachment on a document.
+     * @param user the user (not used).
+     * @param documentId the id of the document.
+     * @param key the key for the secondary attachment.
+     * @param rev the revision of the document.
+     * @param attachment the attachment data.
+     * @param utis an array of UTIs for the attachment.
+     * @param dataIsEncrypted whether the data is already encrypted.
+     * @return the updated document.
+     */
     setSecondaryAttachmentWithUser(user, documentId, key, rev, attachment, utis, dataIsEncrypted) {
         const _super = Object.create(null, {
             setSecondaryAttachment: { get: () => super.setSecondaryAttachment }
@@ -925,6 +1043,14 @@ class IccDocumentXApi extends icc_api_1.IccDocumentApi {
             return (yield this.decrypt([yield _super.setSecondaryAttachment.call(this, documentId, key, rev, attachment, utis, dataIsEncrypted)]))[0].entity;
         });
     }
+    /**
+     * Deletes a secondary attachment from a document.
+     * @param user the user (not used).
+     * @param documentId the id of the document.
+     * @param key the key of the secondary attachment.
+     * @param rev the revision of the document.
+     * @return the updated document.
+     */
     deleteSecondaryAttachmentWithUser(user, documentId, key, rev) {
         const _super = Object.create(null, {
             deleteSecondaryAttachment: { get: () => super.deleteSecondaryAttachment }