@icure/api 6.4.0 → 7.0.0-beta.1

package/icc-x-api/icc-classification-x-api.d.ts

@@ -3,13 +3,56 @@ import { IccCryptoXApi } from './icc-crypto-x-api';
 import * as models from '../icc-api/model/models';
 import { IccDataOwnerXApi } from './icc-data-owner-x-api';
 import { AuthenticationProvider } from './auth/AuthenticationProvider';
+import { ShareMetadataBehaviour } from './crypto/ShareMetadataBehaviour';
 export declare class IccClassificationXApi extends IccClassificationApi {
     crypto: IccCryptoXApi;
     dataOwnerApi: IccDataOwnerXApi;
     constructor(host: string, headers: {
         [key: string]: string;
     }, crypto: IccCryptoXApi, dataOwnerApi: IccDataOwnerXApi, authenticationProvider?: AuthenticationProvider, fetchImpl?: (input: RequestInfo, init?: RequestInit) => Promise<Response>);
-    newInstance(user: models.User, patient: models.Patient, c?: any, delegates?: string[]): Promise<models.Classification>;
-    initDelegationsAndEncryptionKeys(user: models.User, patient: models.Patient, classification: models.Classification, delegates?: string[]): Promise<models.Classification>;
+    /**
+     * Creates a new instance of classification with initialised encryption metadata (not in the database).
+     * @param user the current user.
+     * @param patient the patient this classification refers to.
+     * @param c initialised data for the classification. Metadata such as id, creation data, etc. will be automatically initialised, but you can specify
+     * other kinds of data or overwrite generated metadata with this. You can't specify encryption metadata.
+     * @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.
+     * @return a new instance of classification.
+     */
+    newInstance(user: models.User, patient: models.Patient, c?: any, options?: {
+        additionalDelegates?: {
+            [dataOwnerId: string]: 'WRITE';
+        };
+        preferredSfk?: string;
+    }): Promise<models.Classification>;
     findBy(hcpartyId: string, patient: models.Patient): Promise<models.Classification[]>;
+    /**
+     * @param classification a classification
+     * @return the id of the patient that the classification refers to, retrieved from the encrypted metadata. Normally there should only be one element
+     * in the returned array, but in case of entity merges there could be multiple values.
+     */
+    decryptPatientIdOf(classification: models.Classification): Promise<string[]>;
+    /**
+     * Share an existing classification with other data owners, allowing them to access the non-encrypted data of the classification and optionally also
+     * the encrypted content.
+     * @param delegateId the id of the data owner which will be granted access to the classification.
+     * @param classification the classification to share.
+     * @param options optional parameters to customize the sharing behaviour:
+     * - 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}). Note that by default a
+     * classification does not have encrypted content.
+     * - sharePatientId: specifies if the id of the patient that this classification refers to should be shared with the delegate (defaults to
+     * {@link ShareMetadataBehaviour.IF_AVAILABLE}).
+     * @return a promise which will contain the updated classification.
+     */
+    shareWith(delegateId: string, classification: models.Classification, options?: {
+        shareEncryptionKey?: ShareMetadataBehaviour;
+        sharePatientId?: ShareMetadataBehaviour;
+    }): Promise<models.Classification>;
 }

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

@@ -1,7 +1,17 @@
 "use strict";
+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());
+    });
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.IccClassificationXApi = void 0;
 const icc_api_1 = require("../icc-api");
+const models = require("../icc-api/model/models");
 const _ = require("lodash");
 const moment = require("moment");
 const AuthenticationProvider_1 = require("./auth/AuthenticationProvider");
@@ -15,50 +25,88 @@ class IccClassificationXApi extends icc_api_1.IccClassificationApi {
         this.crypto = crypto;
         this.dataOwnerApi = dataOwnerApi;
     }
-    newInstance(user, patient, c = {}, delegates = []) {
-        const classification = _.assign({
-            id: this.crypto.randomUuid(),
-            _type: 'org.taktik.icure.entities.Classification',
-            created: new Date().getTime(),
-            modified: new Date().getTime(),
-            responsible: this.dataOwnerApi.getDataOwnerOf(user),
-            author: user.id,
-            codes: [],
-            tags: [],
-            healthElementId: this.crypto.randomUuid(),
-            openingDate: parseInt(moment().format('YYYYMMDDHHmmss')),
-        }, c || {});
-        return this.initDelegationsAndEncryptionKeys(user, patient, classification, delegates);
-    }
-    initDelegationsAndEncryptionKeys(user, patient, classification, delegates = []) {
-        const dataOwnerId = this.dataOwnerApi.getDataOwnerOf(user);
-        return this.crypto
-            .extractDelegationsSFKs(patient, dataOwnerId)
-            .then((secretForeignKeys) => this.crypto.initObjectDelegations(classification, patient, dataOwnerId, secretForeignKeys.extractedKeys[0]))
-            .then((initData) => {
-            _.extend(classification, {
-                delegations: initData.delegations,
-                cryptedForeignKeys: initData.cryptedForeignKeys,
-                secretForeignKeys: initData.secretForeignKeys,
-            });
-            let promise = Promise.resolve(classification);
-            _.uniq(delegates.concat(user.autoDelegations ? (user.autoDelegations.all || []).concat(user.autoDelegations.medicalInformation || []) : [])).forEach((delegateId) => (promise = promise.then((classification) => this.crypto
-                .extendedDelegationsAndCryptedForeignKeys(classification, patient, dataOwnerId, delegateId, initData.secretId)
-                .then((extraData) => _.extend(classification, {
-                delegations: extraData.delegations,
-                cryptedForeignKeys: extraData.cryptedForeignKeys,
-            }))
-                .catch((e) => {
-                console.log(e);
-                return classification;
-            }))));
-            return promise;
+    /**
+     * Creates a new instance of classification with initialised encryption metadata (not in the database).
+     * @param user the current user.
+     * @param patient the patient this classification refers to.
+     * @param c initialised data for the classification. Metadata such as id, creation data, etc. will be automatically initialised, but you can specify
+     * other kinds of data or overwrite generated metadata with this. You can't specify encryption metadata.
+     * @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.
+     * @return a new instance of classification.
+     */
+    newInstance(user, patient, c = {}, options = {}) {
+        var _a, _b, _c, _d, _e, _f;
+        return __awaiter(this, void 0, void 0, function* () {
+            const classification = _.assign({
+                id: this.crypto.primitives.randomUuid(),
+                _type: 'org.taktik.icure.entities.Classification',
+                created: new Date().getTime(),
+                modified: new Date().getTime(),
+                responsible: this.dataOwnerApi.getDataOwnerIdOf(user),
+                author: user.id,
+                codes: [],
+                tags: [],
+                healthElementId: this.crypto.primitives.randomUuid(),
+                openingDate: parseInt(moment().format('YYYYMMDDHHmmss')),
+            }, c || {});
+            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 = (_a = options.preferredSfk) !== null && _a !== void 0 ? _a : (yield this.crypto.confidential.getAnySecretIdSharedWithParents(patient));
+            if (!sfk)
+                throw new Error(`Couldn't find any sfk of parent patient ${patient.id}`);
+            const extraDelegations = [
+                ...Object.keys((_b = options.additionalDelegates) !== null && _b !== void 0 ? _b : {}),
+                ...((_d = (_c = user.autoDelegations) === null || _c === void 0 ? void 0 : _c.all) !== null && _d !== void 0 ? _d : []),
+                ...((_f = (_e = user.autoDelegations) === null || _e === void 0 ? void 0 : _e.medicalInformation) !== null && _f !== void 0 ? _f : []),
+            ];
+            return new models.Classification(yield this.crypto.entities
+                .entityWithInitialisedEncryptedMetadata(classification, patient === null || patient === void 0 ? void 0 : patient.id, sfk, true, extraDelegations)
+                .then((x) => x.updatedEntity));
         });
     }
     findBy(hcpartyId, patient) {
-        return this.crypto
-            .extractDelegationsSFKs(patient, hcpartyId)
-            .then((secretForeignKeys) => this.findClassificationsByHCPartyPatientForeignKeys(secretForeignKeys.hcpartyId, _.uniq(secretForeignKeys.extractedKeys).join(',')));
+        return __awaiter(this, void 0, void 0, function* () {
+            const extractedKeys = yield this.crypto.entities.secretIdsOf(patient, hcpartyId);
+            const topmostParentId = (yield this.dataOwnerApi.getCurrentDataOwnerHierarchyIds())[0];
+            return extractedKeys && extractedKeys.length > 0
+                ? this.findClassificationsByHCPartyPatientForeignKeys(topmostParentId, _.uniq(extractedKeys).join(','))
+                : Promise.resolve([]);
+        });
+    }
+    /**
+     * @param classification a classification
+     * @return the id of the patient that the classification refers to, retrieved from the encrypted metadata. Normally there should only be one element
+     * in the returned array, but in case of entity merges there could be multiple values.
+     */
+    decryptPatientIdOf(classification) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.crypto.entities.owningEntityIdsOf(classification, undefined);
+        });
+    }
+    /**
+     * Share an existing classification with other data owners, allowing them to access the non-encrypted data of the classification and optionally also
+     * the encrypted content.
+     * @param delegateId the id of the data owner which will be granted access to the classification.
+     * @param classification the classification to share.
+     * @param options optional parameters to customize the sharing behaviour:
+     * - 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}). Note that by default a
+     * classification does not have encrypted content.
+     * - sharePatientId: specifies if the id of the patient that this classification refers to should be shared with the delegate (defaults to
+     * {@link ShareMetadataBehaviour.IF_AVAILABLE}).
+     * @return a promise which will contain the updated classification.
+     */
+    shareWith(delegateId, classification, options = {}) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.modifyClassification(yield this.crypto.entities.entityWithAutoExtendedEncryptedMetadata(classification, delegateId, undefined, options.shareEncryptionKey, options.sharePatientId));
+        });
     }
 }
 exports.IccClassificationXApi = IccClassificationXApi;

package/icc-x-api/icc-classification-x-api.js.map

@@ -1 +1 @@
-{"version":3,"file":"icc-classification-x-api.js","sourceRoot":"","sources":["../../icc-x-api/icc-classification-x-api.ts"],"names":[],"mappings":";;;AAAA,wCAAiD;AAKjD,4BAA2B;AAC3B,iCAAgC;AAEhC,0EAAgG;AAEhG,MAAa,qBAAsB,SAAQ,8BAAoB;IAI7D,YACE,IAAY,EACZ,OAAkC,EAClC,MAAqB,EACrB,YAA8B,EAC9B,yBAAiD,IAAI,iDAAwB,EAAE,EAC/E,YAA2E,OAAO,MAAM,KAAK,WAAW;QACtG,CAAC,CAAC,MAAM,CAAC,KAAK;QACd,CAAC,CAAC,OAAO,IAAI,KAAK,WAAW;YAC7B,CAAC,CAAC,IAAI,CAAC,KAAK;YACZ,CAAC,CAAC,KAAK;QAET,KAAK,CAAC,IAAI,EAAE,OAAO,EAAE,sBAAsB,EAAE,SAAS,CAAC,CAAA;QACvD,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;QACpB,IAAI,CAAC,YAAY,GAAG,YAAY,CAAA;IAClC,CAAC;IAED,WAAW,CAAC,IAAiB,EAAE,OAAuB,EAAE,IAAS,EAAE,EAAE,YAAsB,EAAE;QAC3F,MAAM,cAAc,GAAG,CAAC,CAAC,MAAM,CAC7B;YACE,EAAE,EAAE,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE;YAC5B,KAAK,EAAE,0CAA0C;YACjD,OAAO,EAAE,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE;YAC7B,QAAQ,EAAE,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE;YAC9B,WAAW,EAAE,IAAI,CAAC,YAAY,CAAC,cAAc,CAAC,IAAI,CAAC;YACnD,MAAM,EAAE,IAAI,CAAC,EAAE;YACf,KAAK,EAAE,EAAE;YACT,IAAI,EAAE,EAAE;YACR,eAAe,EAAE,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE;YACzC,WAAW,EAAE,QAAQ,CAAC,MAAM,EAAE,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAC;SACzD,EACD,CAAC,IAAI,EAAE,CACR,CAAA;QAED,OAAO,IAAI,CAAC,gCAAgC,CAAC,IAAI,EAAE,OAAO,EAAE,cAAc,EAAE,SAAS,CAAC,CAAA;IACxF,CAAC;IAED,gCAAgC,CAC9B,IAAiB,EACjB,OAAuB,EACvB,cAAqC,EACrC,YAAsB,EAAE;QAExB,MAAM,WAAW,GAAG,IAAI,CAAC,YAAY,CAAC,cAAc,CAAC,IAAI,CAAC,CAAA;QAC1D,OAAO,IAAI,CAAC,MAAM;aACf,sBAAsB,CAAC,OAAO,EAAE,WAAY,CAAC;aAC7C,IAAI,CAAC,CAAC,iBAAiB,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,qBAAqB,CAAC,cAAc,EAAE,OAAO,EAAE,WAAY,EAAE,iBAAiB,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC;aACzI,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE;YACjB,CAAC,CAAC,MAAM,CAAC,cAAc,EAAE;gBACvB,WAAW,EAAE,QAAQ,CAAC,WAAW;gBACjC,kBAAkB,EAAE,QAAQ,CAAC,kBAAkB;gBAC/C,iBAAiB,EAAE,QAAQ,CAAC,iBAAiB;aAC9C,CAAC,CAAA;YAEF,IAAI,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,cAAc,CAAC,CAAA;YAC7C,CAAC,CAAC,IAAI,CACJ,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,GAAG,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC,kBAAkB,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CACrI,CAAC,OAAO,CACP,CAAC,UAAU,EAAE,EAAE,CACb,CAAC,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,cAAc,EAAE,EAAE,CACzC,IAAI,CAAC,MAAM;iBACR,wCAAwC,CAAC,cAAc,EAAE,OAAO,EAAE,WAAY,EAAE,UAAU,EAAE,QAAQ,CAAC,QAAQ,CAAC;iBAC9G,IAAI,CAAC,CAAC,SAAS,EAAE,EAAE,CAClB,CAAC,CAAC,MAAM,CAAC,cAAc,EAAE;gBACvB,WAAW,EAAE,SAAS,CAAC,WAAW;gBAClC,kBAAkB,EAAE,SAAS,CAAC,kBAAkB;aACjD,CAAC,CACH;iBACA,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE;gBACX,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAA;gBACd,OAAO,cAAc,CAAA;YACvB,CAAC,CAAC,CACL,CAAC,CACL,CAAA;YAED,OAAO,OAAO,CAAA;QAChB,CAAC,CAAC,CAAA;IACN,CAAC;IAED,MAAM,CAAC,SAAiB,EAAE,OAAuB;QAC/C,OAAO,IAAI,CAAC,MAAM;aACf,sBAAsB,CAAC,OAAO,EAAE,SAAS,CAAC;aAC1C,IAAI,CAAC,CAAC,iBAAiB,EAAE,EAAE,CAC1B,IAAI,CAAC,8CAA8C,CAAC,iBAAiB,CAAC,SAAU,EAAE,CAAC,CAAC,IAAI,CAAC,iBAAiB,CAAC,aAAa,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CACrI,CAAA;IACL,CAAC;CACF;AA1FD,sDA0FC","sourcesContent":["import { IccClassificationApi } from '../icc-api'\nimport { IccCryptoXApi } from './icc-crypto-x-api'\n\nimport * as models from '../icc-api/model/models'\n\nimport * as _ from 'lodash'\nimport * as moment from 'moment'\nimport { IccDataOwnerXApi } from './icc-data-owner-x-api'\nimport { AuthenticationProvider, NoAuthenticationProvider } from './auth/AuthenticationProvider'\n\nexport class IccClassificationXApi extends IccClassificationApi {\n  crypto: IccCryptoXApi\n  dataOwnerApi: IccDataOwnerXApi\n\n  constructor(\n    host: string,\n    headers: { [key: string]: string },\n    crypto: IccCryptoXApi,\n    dataOwnerApi: IccDataOwnerXApi,\n    authenticationProvider: AuthenticationProvider = new NoAuthenticationProvider(),\n    fetchImpl: (input: RequestInfo, init?: RequestInit) => Promise<Response> = typeof window !== 'undefined'\n      ? window.fetch\n      : typeof self !== 'undefined'\n      ? self.fetch\n      : fetch\n  ) {\n    super(host, headers, authenticationProvider, fetchImpl)\n    this.crypto = crypto\n    this.dataOwnerApi = dataOwnerApi\n  }\n\n  newInstance(user: models.User, patient: models.Patient, c: any = {}, delegates: string[] = []): Promise<models.Classification> {\n    const classification = _.assign(\n      {\n        id: this.crypto.randomUuid(),\n        _type: 'org.taktik.icure.entities.Classification',\n        created: new Date().getTime(),\n        modified: new Date().getTime(),\n        responsible: this.dataOwnerApi.getDataOwnerOf(user),\n        author: user.id,\n        codes: [],\n        tags: [],\n        healthElementId: this.crypto.randomUuid(),\n        openingDate: parseInt(moment().format('YYYYMMDDHHmmss')),\n      },\n      c || {}\n    )\n\n    return this.initDelegationsAndEncryptionKeys(user, patient, classification, delegates)\n  }\n\n  initDelegationsAndEncryptionKeys(\n    user: models.User,\n    patient: models.Patient,\n    classification: models.Classification,\n    delegates: string[] = []\n  ): Promise<models.Classification> {\n    const dataOwnerId = this.dataOwnerApi.getDataOwnerOf(user)\n    return this.crypto\n      .extractDelegationsSFKs(patient, dataOwnerId!)\n      .then((secretForeignKeys) => this.crypto.initObjectDelegations(classification, patient, dataOwnerId!, secretForeignKeys.extractedKeys[0]))\n      .then((initData) => {\n        _.extend(classification, {\n          delegations: initData.delegations,\n          cryptedForeignKeys: initData.cryptedForeignKeys,\n          secretForeignKeys: initData.secretForeignKeys,\n        })\n\n        let promise = Promise.resolve(classification)\n        _.uniq(\n          delegates.concat(user.autoDelegations ? (user.autoDelegations.all || []).concat(user.autoDelegations.medicalInformation || []) : [])\n        ).forEach(\n          (delegateId) =>\n            (promise = promise.then((classification) =>\n              this.crypto\n                .extendedDelegationsAndCryptedForeignKeys(classification, patient, dataOwnerId!, delegateId, initData.secretId)\n                .then((extraData) =>\n                  _.extend(classification, {\n                    delegations: extraData.delegations,\n                    cryptedForeignKeys: extraData.cryptedForeignKeys,\n                  })\n                )\n                .catch((e) => {\n                  console.log(e)\n                  return classification\n                })\n            ))\n        )\n\n        return promise\n      })\n  }\n\n  findBy(hcpartyId: string, patient: models.Patient) {\n    return this.crypto\n      .extractDelegationsSFKs(patient, hcpartyId)\n      .then((secretForeignKeys) =>\n        this.findClassificationsByHCPartyPatientForeignKeys(secretForeignKeys.hcpartyId!, _.uniq(secretForeignKeys.extractedKeys).join(','))\n      )\n  }\n}\n"]}
+{"version":3,"file":"icc-classification-x-api.js","sourceRoot":"","sources":["../../icc-x-api/icc-classification-x-api.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,wCAAiD;AAGjD,kDAAiD;AAEjD,4BAA2B;AAC3B,iCAAgC;AAEhC,0EAAgG;AAGhG,MAAa,qBAAsB,SAAQ,8BAAoB;IAI7D,YACE,IAAY,EACZ,OAAkC,EAClC,MAAqB,EACrB,YAA8B,EAC9B,yBAAiD,IAAI,iDAAwB,EAAE,EAC/E,YAA2E,OAAO,MAAM,KAAK,WAAW;QACtG,CAAC,CAAC,MAAM,CAAC,KAAK;QACd,CAAC,CAAC,OAAO,IAAI,KAAK,WAAW;YAC7B,CAAC,CAAC,IAAI,CAAC,KAAK;YACZ,CAAC,CAAC,KAAK;QAET,KAAK,CAAC,IAAI,EAAE,OAAO,EAAE,sBAAsB,EAAE,SAAS,CAAC,CAAA;QACvD,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;QACpB,IAAI,CAAC,YAAY,GAAG,YAAY,CAAA;IAClC,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACG,WAAW,CACf,IAAiB,EACjB,OAAuB,EACvB,IAAS,EAAE,EACX,UAGI,EAAE;;;YAEN,MAAM,cAAc,GAAG,CAAC,CAAC,MAAM,CAC7B;gBACE,EAAE,EAAE,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,UAAU,EAAE;gBACvC,KAAK,EAAE,0CAA0C;gBACjD,OAAO,EAAE,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE;gBAC7B,QAAQ,EAAE,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE;gBAC9B,WAAW,EAAE,IAAI,CAAC,YAAY,CAAC,gBAAgB,CAAC,IAAI,CAAC;gBACrD,MAAM,EAAE,IAAI,CAAC,EAAE;gBACf,KAAK,EAAE,EAAE;gBACT,IAAI,EAAE,EAAE;gBACR,eAAe,EAAE,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,UAAU,EAAE;gBACpD,WAAW,EAAE,QAAQ,CAAC,MAAM,EAAE,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAC;aACzD,EACD,CAAC,IAAI,EAAE,CACR,CAAA;YAED,MAAM,OAAO,GAAG,IAAI,CAAC,YAAY,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAA;YACxD,IAAI,OAAO,KAAK,CAAC,MAAM,IAAI,CAAC,YAAY,CAAC,qBAAqB,EAAE,CAAC;gBAAE,MAAM,IAAI,KAAK,CAAC,qDAAqD,CAAC,CAAA;YACzI,MAAM,GAAG,GAAG,MAAA,OAAO,CAAC,YAAY,mCAAI,CAAC,MAAM,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,+BAA+B,CAAC,OAAO,CAAC,CAAC,CAAA;YAC7G,IAAI,CAAC,GAAG;gBAAE,MAAM,IAAI,KAAK,CAAC,2CAA2C,OAAO,CAAC,EAAE,EAAE,CAAC,CAAA;YAClF,MAAM,gBAAgB,GAAG;gBACvB,GAAG,MAAM,CAAC,IAAI,CAAC,MAAA,OAAO,CAAC,mBAAmB,mCAAI,EAAE,CAAC;gBACjD,GAAG,CAAC,MAAA,MAAA,IAAI,CAAC,eAAe,0CAAE,GAAG,mCAAI,EAAE,CAAC;gBACpC,GAAG,CAAC,MAAA,MAAA,IAAI,CAAC,eAAe,0CAAE,kBAAkB,mCAAI,EAAE,CAAC;aACpD,CAAA;YACD,OAAO,IAAI,MAAM,CAAC,cAAc,CAC9B,MAAM,IAAI,CAAC,MAAM,CAAC,QAAQ;iBACvB,sCAAsC,CAAC,cAAc,EAAE,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,EAAE,EAAE,GAAG,EAAE,IAAI,EAAE,gBAAgB,CAAC;iBAChG,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,aAAa,CAAC,CAChC,CAAA;;KACF;IAEK,MAAM,CAAC,SAAiB,EAAE,OAAuB;;YACrD,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,WAAW,CAAC,OAAO,EAAE,SAAS,CAAC,CAAA;YAChF,MAAM,eAAe,GAAG,CAAC,MAAM,IAAI,CAAC,YAAY,CAAC,+BAA+B,EAAE,CAAC,CAAC,CAAC,CAAC,CAAA;YACtF,OAAO,aAAa,IAAI,aAAa,CAAC,MAAM,GAAG,CAAC;gBAC9C,CAAC,CAAC,IAAI,CAAC,8CAA8C,CAAC,eAAe,EAAE,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;gBACvG,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;QACzB,CAAC;KAAA;IACD;;;;OAIG;IACG,kBAAkB,CAAC,cAAqC;;YAC5D,OAAO,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,iBAAiB,CAAC,cAAc,EAAE,SAAS,CAAC,CAAA;QAC1E,CAAC;KAAA;IAED;;;;;;;;;;;;OAYG;IACG,SAAS,CACb,UAAkB,EAClB,cAAqC,EACrC,UAGI,EAAE;;YAEN,OAAO,MAAM,IAAI,CAAC,oBAAoB,CACpC,MAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,uCAAuC,CAChE,cAAc,EACd,UAAU,EACV,SAAS,EACT,OAAO,CAAC,kBAAkB,EAC1B,OAAO,CAAC,cAAc,CACvB,CACF,CAAA;QACH,CAAC;KAAA;CACF;AA5HD,sDA4HC","sourcesContent":["import { IccClassificationApi } from '../icc-api'\nimport { IccCryptoXApi } from './icc-crypto-x-api'\n\nimport * as models from '../icc-api/model/models'\n\nimport * as _ from 'lodash'\nimport * as moment from 'moment'\nimport { IccDataOwnerXApi } from './icc-data-owner-x-api'\nimport { AuthenticationProvider, NoAuthenticationProvider } from './auth/AuthenticationProvider'\nimport { ShareMetadataBehaviour } from './crypto/ShareMetadataBehaviour'\n\nexport class IccClassificationXApi extends IccClassificationApi {\n  crypto: IccCryptoXApi\n  dataOwnerApi: IccDataOwnerXApi\n\n  constructor(\n    host: string,\n    headers: { [key: string]: string },\n    crypto: IccCryptoXApi,\n    dataOwnerApi: IccDataOwnerXApi,\n    authenticationProvider: AuthenticationProvider = new NoAuthenticationProvider(),\n    fetchImpl: (input: RequestInfo, init?: RequestInit) => Promise<Response> = typeof window !== 'undefined'\n      ? window.fetch\n      : typeof self !== 'undefined'\n      ? self.fetch\n      : fetch\n  ) {\n    super(host, headers, authenticationProvider, fetchImpl)\n    this.crypto = crypto\n    this.dataOwnerApi = dataOwnerApi\n  }\n\n  /**\n   * Creates a new instance of classification with initialised encryption metadata (not in the database).\n   * @param user the current user.\n   * @param patient the patient this classification refers to.\n   * @param c initialised data for the classification. Metadata such as id, creation data, etc. will be automatically initialised, but you can specify\n   * other kinds of data or overwrite generated metadata with this. You can't specify encryption metadata.\n   * @param options optional parameters:\n   * - additionalDelegates: delegates which will have access to the entity in addition to the current data owner and delegates from the\n   * 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\n   * auto-delegations, in such case the access level specified here will be used. Currently only WRITE access is supported, but in future also read\n   * access will be possible.\n   * - preferredSfk: secret id of the patient to use as the secret foreign key to use for the classification. The default value will be a\n   * secret id of patient known by the topmost parent in the current data owner hierarchy.\n   * @return a new instance of classification.\n   */\n  async newInstance(\n    user: models.User,\n    patient: models.Patient,\n    c: any = {},\n    options: {\n      additionalDelegates?: { [dataOwnerId: string]: 'WRITE' }\n      preferredSfk?: string\n    } = {}\n  ): Promise<models.Classification> {\n    const classification = _.assign(\n      {\n        id: this.crypto.primitives.randomUuid(),\n        _type: 'org.taktik.icure.entities.Classification',\n        created: new Date().getTime(),\n        modified: new Date().getTime(),\n        responsible: this.dataOwnerApi.getDataOwnerIdOf(user),\n        author: user.id,\n        codes: [],\n        tags: [],\n        healthElementId: this.crypto.primitives.randomUuid(),\n        openingDate: parseInt(moment().format('YYYYMMDDHHmmss')),\n      },\n      c || {}\n    )\n\n    const ownerId = this.dataOwnerApi.getDataOwnerIdOf(user)\n    if (ownerId !== (await this.dataOwnerApi.getCurrentDataOwnerId())) throw new Error('Can only initialise entities as current data owner.')\n    const sfk = options.preferredSfk ?? (await this.crypto.confidential.getAnySecretIdSharedWithParents(patient))\n    if (!sfk) throw new Error(`Couldn't find any sfk of parent patient ${patient.id}`)\n    const extraDelegations = [\n      ...Object.keys(options.additionalDelegates ?? {}),\n      ...(user.autoDelegations?.all ?? []),\n      ...(user.autoDelegations?.medicalInformation ?? []),\n    ]\n    return new models.Classification(\n      await this.crypto.entities\n        .entityWithInitialisedEncryptedMetadata(classification, patient?.id, sfk, true, extraDelegations)\n        .then((x) => x.updatedEntity)\n    )\n  }\n\n  async findBy(hcpartyId: string, patient: models.Patient) {\n    const extractedKeys = await this.crypto.entities.secretIdsOf(patient, hcpartyId)\n    const topmostParentId = (await this.dataOwnerApi.getCurrentDataOwnerHierarchyIds())[0]\n    return extractedKeys && extractedKeys.length > 0\n      ? this.findClassificationsByHCPartyPatientForeignKeys(topmostParentId, _.uniq(extractedKeys).join(','))\n      : Promise.resolve([])\n  }\n  /**\n   * @param classification a classification\n   * @return the id of the patient that the classification refers to, retrieved from the encrypted metadata. Normally there should only be one element\n   * in the returned array, but in case of entity merges there could be multiple values.\n   */\n  async decryptPatientIdOf(classification: models.Classification): Promise<string[]> {\n    return this.crypto.entities.owningEntityIdsOf(classification, undefined)\n  }\n\n  /**\n   * Share an existing classification with other data owners, allowing them to access the non-encrypted data of the classification and optionally also\n   * the encrypted content.\n   * @param delegateId the id of the data owner which will be granted access to the classification.\n   * @param classification the classification to share.\n   * @param options optional parameters to customize the sharing behaviour:\n   * - shareEncryptionKey: specifies if the encryption key of the access log should be shared with the delegate, giving access to all encrypted\n   * content of the entity, excluding other encrypted metadata (defaults to {@link ShareMetadataBehaviour.IF_AVAILABLE}). Note that by default a\n   * classification does not have encrypted content.\n   * - sharePatientId: specifies if the id of the patient that this classification refers to should be shared with the delegate (defaults to\n   * {@link ShareMetadataBehaviour.IF_AVAILABLE}).\n   * @return a promise which will contain the updated classification.\n   */\n  async shareWith(\n    delegateId: string,\n    classification: models.Classification,\n    options: {\n      shareEncryptionKey?: ShareMetadataBehaviour // Defaults to ShareMetadataBehaviour.IF_AVAILABLE\n      sharePatientId?: ShareMetadataBehaviour // Defaults to ShareMetadataBehaviour.IF_AVAILABLE\n    } = {}\n  ): Promise<models.Classification> {\n    return await this.modifyClassification(\n      await this.crypto.entities.entityWithAutoExtendedEncryptedMetadata(\n        classification,\n        delegateId,\n        undefined,\n        options.shareEncryptionKey,\n        options.sharePatientId\n      )\n    )\n  }\n}\n"]}

package/icc-x-api/icc-contact-x-api.d.ts

@@ -5,6 +5,7 @@ import { Contact, ListOfIds, Service } from '../icc-api/model/models';
 import { PaginatedListContact } from '../icc-api/model/PaginatedListContact';
 import { IccDataOwnerXApi } from './icc-data-owner-x-api';
 import { AuthenticationProvider } from './auth/AuthenticationProvider';
+import { ShareMetadataBehaviour } from './crypto/ShareMetadataBehaviour';
 export declare class IccContactXApi extends IccContactApi {
     i18n: any;
     crypto: IccCryptoXApi;
@@ -12,19 +13,30 @@ export declare class IccContactXApi extends IccContactApi {
     constructor(host: string, headers: {
         [key: string]: string;
     }, crypto: IccCryptoXApi, dataOwnerApi: IccDataOwnerXApi, authenticationProvider?: AuthenticationProvider, fetchImpl?: (input: RequestInfo, init?: RequestInit) => Promise<Response>);
-    newInstance(user: models.User, patient: models.Patient, c: any, confidential?: boolean, delegates?: string[]): Promise<models.Contact>;
     /**
-     * 1. Extract(decrypt) the patient's secretForeignKeys from the
-     * "delegations" object.
-     * 2. Initialize & encrypt the Contact's delegations & cryptedForeignKeys.
-     * 3. Initialize & encrypt the Contact's encryptionKeys.
-     * 4. Return the contact with the extended delegations, cryptedForeignKeys
-     * & encryptionKeys.
+     * Creates a new instance of contact with initialised encryption metadata (not in the database).
+     * @param user the current user.
+     * @param patient the patient this contact refers to.
+     * @param c initialised data for the contact. Metadata such as id, creation data, etc. will be automatically initialised, but you can specify other
+     * kinds of data or overwrite generated metadata with this. You can't specify encryption metadata.
+     * @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.
+     * - confidential: if true, the entity will be created as confidential. Confidential entities are not shared with auto-delegations, and the default
+     * foreign key used is any key that is not shared with any of the data owner parents. By default entities are created as non-confidential.
+     * @return a new instance of contact.
      */
-    private initDelegationsAndEncryptionKeys;
-    initEncryptionKeys(user: models.User, ctc: models.Contact): Promise<models.Contact & {
-        encryptionKeys: any;
-    }>;
+    newInstance(user: models.User, patient: models.Patient, c: any, options?: {
+        additionalDelegates?: {
+            [dataOwnerId: string]: 'WRITE';
+        };
+        preferredSfk?: string;
+        confidential?: boolean;
+    }): Promise<models.Contact>;
     /**
      * 1. Check whether there is a delegation with 'hcpartyId' or not.
      * 2. 'fetchHcParty[hcpartyId][1]': is encrypted AES exchange key by RSA public key of him.
@@ -53,25 +65,28 @@ export declare class IccContactXApi extends IccContactApi {
     modifyContact(body?: Contact): never;
     modifyContacts(body?: Array<Contact>): never;
     createContact(body?: Contact): never;
-    findByHCPartyPatientSecretFKeys(hcPartyId: string, secretFKeys: string, planOfActionIds?: string, skipClosedContacts?: boolean): Promise<Array<models.Contact> | any>;
+    findByHCPartyPatientSecretFKeys(hcPartyId: string, secretFKeys: string, planOfActionIds?: string, skipClosedContacts?: boolean): Promise<Array<models.Contact>>;
     findByHCPartyPatientSecretFKeysArray(hcPartyId: string, secretFKeys: string[], planOfActionIds?: string, skipClosedContacts?: boolean): Promise<Array<models.Contact> | any>;
     filterByWithUser(user: models.User, startDocumentId?: string, limit?: number, body?: models.FilterChainContact): Promise<PaginatedListContact | any>;
     listContactsByOpeningDateWithUser(user: models.User, startKey: number, endKey: number, hcpartyid: string, startDocumentId?: string, limit?: number): Promise<PaginatedListContact | any>;
     listServicesWithUser(user: models.User, serviceIds: ListOfIds): Promise<Array<Service> | any>;
     findByHCPartyFormIdWithUser(user: models.User, hcPartyId: string, formId: string): Promise<Array<models.Contact> | any>;
     findByHCPartyFormIdsWithUser(user: models.User, hcPartyId: string, body: models.ListOfIds): Promise<Array<models.Contact> | any>;
-    getContactWithUser(user: models.User, contactId: string): Promise<models.Contact | any>;
+    getContactWithUser(user: models.User, contactId: string): Promise<models.Contact>;
     getContactsWithUser(user: models.User, body?: models.ListOfIds): Promise<Array<models.Contact> | any>;
     modifyContactWithUser(user: models.User, body?: models.Contact): Promise<models.Contact | any>;
+    private modifyAs;
     modifyContactsWithUser(user: models.User, bodies?: Array<models.Contact>): Promise<models.Contact[] | any>;
-    createContactWithUser(user: models.User, body?: models.Contact): Promise<models.Contact | any>;
-    createContactsWithUser(user: models.User, bodies?: Array<models.Contact>): Promise<models.Contact[] | any>;
+    createContactWithUser(user: models.User, body?: models.Contact): Promise<models.Contact | null>;
+    createContactsWithUser(user: models.User, bodies?: Array<models.Contact>): Promise<models.Contact[] | null>;
     encryptServices(key: CryptoKey, rawKey: string, services: Service[]): PromiseLike<Service[]>;
-    encrypt(user: models.User, ctcs: Array<models.Contact>): Promise<(models.Contact | (models.Contact & {
-        encryptionKeys: any;
-    }))[]>;
+    encrypt(user: models.User, ctcs: Array<models.Contact>): Promise<models.Contact[]>;
+    private encryptAs;
     decrypt(hcpartyId: string, ctcs: Array<models.Contact>): Promise<Array<models.Contact>>;
-    decryptServices(hcpartyId: string, svcs: Array<models.Service>, key?: CryptoKey, rawKey?: string): Promise<Array<models.Service>>;
+    decryptServices(hcpartyId: string, svcs: Array<models.Service>, keys?: {
+        key: CryptoKey;
+        raw: string;
+    }[]): Promise<Array<models.Service>>;
     contactOfService(ctcs: Array<models.Contact>, svcId: string): models.Contact | undefined;
     filteredServices(ctcs: Array<models.Contact>, filter: any): Array<models.Service>;
     filterServices(ctcs: Array<models.Contact>, filter: any): Promise<Array<models.Service>>;
@@ -126,4 +141,27 @@ export declare class IccContactXApi extends IccContactApi {
         regimenToString: (r: models.RegimenItem, lang: string) => string | null;
         localize: (s: any, lang: string) => any;
     };
+    /**
+     * @param contact a contact
+     * @return the id of the patient that the contact refers to, retrieved from the encrypted metadata. Normally there should only be one element
+     * in the returned array, but in case of entity merges there could be multiple values.
+     */
+    decryptPatientIdOf(contact: models.Contact): Promise<string[]>;
+    /**
+     * Share an existing contact with other data owners, allowing them to access the non-encrypted data of the contact and optionally also
+     * the encrypted content.
+     * @param delegateId the id of the data owner which will be granted access to the contact.
+     * @param contact the contact to share.
+     * @param options optional parameters to customize the sharing behaviour:
+     * - 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}). Note that by default a
+     * contact does not have encrypted content.
+     * - sharePatientId: specifies if the id of the patient that this contact refers to should be shared with the delegate (defaults to
+     * {@link ShareMetadataBehaviour.IF_AVAILABLE}).
+     * @return a promise which will contain the updated contact.
+     */
+    shareWith(delegateId: string, contact: models.Contact, options?: {
+        shareEncryptionKey?: ShareMetadataBehaviour;
+        sharePatientId?: ShareMetadataBehaviour;
+    }): Promise<models.Contact>;
 }