@icure/api 8.0.78 → 8.1.0

package/icc-x-api/crypto/ConfidentialEntities.d.ts

@@ -1,64 +0,0 @@
-import { EncryptedEntity } from '../../icc-api/model/models';
-import { ExtendedApisUtils } from './ExtendedApisUtils';
-import { CryptoPrimitives } from './CryptoPrimitives';
-import { IccDataOwnerXApi } from '../icc-data-owner-x-api';
-import { EncryptedEntityWithType, EntityWithDelegationTypeName } from '../utils/EntityWithDelegationTypeName';
-import { EntityBulkShareResult } from '../../icc-api/model/requests/EntityBulkShareResult';
-import { BulkShareOrUpdateMetadataParams } from '../../icc-api/model/requests/BulkShareOrUpdateMetadataParams';
-/**
- * @internal this class is intended for internal use only and may be changed without notice.
- * This class helps to create confidential medical data in systems where multiple hcps share data with each other using parent hcps: while normally
- * the hcps would share all data with other hcps part of the same "family" (e.g. an hospital) there are situations where the medical data is
- * confidential and should only be known by the doctor which created the data. In these situations it is also important that the secret foreign key
- * used in the confidential data is not known by other members of the hcp family, otherwise they may be able to draw some links between the medical
- * data and the patient.
- */
-export declare class ConfidentialEntities {
-    private readonly entitiesEncryption;
-    private readonly primitives;
-    private readonly dataOwnerApi;
-    constructor(entitiesEncryption: ExtendedApisUtils, primitives: CryptoPrimitives, dataOwnerApi: IccDataOwnerXApi);
-    /**
-     * Ensures that the current data owner has access to a confidential secret id for the provided entity: this is an id that is known to the data owner
-     * but is not known by any of his parents. If there is currently no confidential secret id for this entity the method returns a copy of the entity
-     * with a new confidential secret id for the current data owner (the entity in the database won't be updated), else this method returns undefined.
-     * New confidential secret ids will have an appropriate tag, but existing confidential secret ids may not necessarily have it.
-     * @param entity an entity which needs to have a confidential secret id for the current data owner
-     * @param entityType the type of the entity
-     * @param doRequestBulkShareOrUpdate perform the request to share or update an entity encrypted metadata on the cloud API (and save to DB).
-     * @return undefined if the entity already had a confidential secret id for the current user, or the updated AND SAVED entity with the new
-     * confidential secret id.
-     */
-    initialiseConfidentialSecretId<T extends EncryptedEntity>(entity: T, entityType: EntityWithDelegationTypeName, doRequestBulkShareOrUpdate: (request: BulkShareOrUpdateMetadataParams) => Promise<EntityBulkShareResult<T>[]>): Promise<T | undefined>;
-    /**
-     * Get an existing confidential secret id of the provided entity for the provided data owner (current data owner by default). A confidential secret
-     * id is a secret id known by the data owner but not known by any of his parents: note however that children will know confidential secret ids.
-     * @param entity an entity for which you want to retrieve the confidential secret id.
-     * @param dataOwnerId (current data owner by default) a data owner for which you want to get a confidential secret id.
-     * @return the confidential secret id or undefined if there is no confidential secret id for the provided data owner.
-     */
-    getConfidentialSecretId(entity: EncryptedEntityWithType, dataOwnerId?: string): Promise<string | undefined>;
-    /**
-     * Get all existing confidential secret ids of the provided entity for the provided data owner (current data owner by default). A confidential secret
-     * id is a secret id known by the data owner but not known by any of his parents: note however that children will know confidential secret ids.
-     * @param entity an entity for which you want to retrieve the confidential secret id.
-     * @param dataOwnerId (current data owner by default) a data owner for which you want to get a confidential secret id.
-     * @return the confidential secret ids for the data owner (may be empty).
-     */
-    getConfidentialSecretIds(entity: EncryptedEntityWithType, dataOwnerId?: string): Promise<string[]>;
-    /**
-     * Gets a secret id known by the topmost parent of the current data owner hierarchy. If there is multiple secret ids shared with the topmost parent
-     * there is no guarantee on which one will be chosen.
-     * @param entity an entity.
-     * @return a secret id known by the topmost parent of the current data owner hierarchy, or undefined if there is no secret id currently available
-     * for the topmost parent.
-     */
-    getAnySecretIdSharedWithParents(entity: EncryptedEntityWithType): Promise<string | undefined>;
-    /**
-     * Gets all secret ids known by the topmost parent of the current data owner hierarchy (or all secret ids known by the current data owner if he is
-     * not part of any data owner hierarchy).
-     * @param entity an entity.
-     * @return all secret ids known by the topmost parent of the current data owner hierarchy, may be empty.
-     */
-    getSecretIdsSharedWithParents(entity: EncryptedEntityWithType): Promise<string[]>;
-}

package/icc-x-api/crypto/ConfidentialEntities.js

@@ -1,112 +0,0 @@
-"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.ConfidentialEntities = void 0;
-const ShareMetadataBehaviour_1 = require("./ShareMetadataBehaviour");
-const EntityShareRequest_1 = require("../../icc-api/model/requests/EntityShareRequest");
-var RequestedPermissionEnum = EntityShareRequest_1.EntityShareRequest.RequestedPermissionEnum;
-/**
- * @internal this class is intended for internal use only and may be changed without notice.
- * This class helps to create confidential medical data in systems where multiple hcps share data with each other using parent hcps: while normally
- * the hcps would share all data with other hcps part of the same "family" (e.g. an hospital) there are situations where the medical data is
- * confidential and should only be known by the doctor which created the data. In these situations it is also important that the secret foreign key
- * used in the confidential data is not known by other members of the hcp family, otherwise they may be able to draw some links between the medical
- * data and the patient.
- */
-class ConfidentialEntities {
-    constructor(entitiesEncryption, primitives, dataOwnerApi) {
-        this.entitiesEncryption = entitiesEncryption;
-        this.primitives = primitives;
-        this.dataOwnerApi = dataOwnerApi;
-    }
-    /**
-     * Ensures that the current data owner has access to a confidential secret id for the provided entity: this is an id that is known to the data owner
-     * but is not known by any of his parents. If there is currently no confidential secret id for this entity the method returns a copy of the entity
-     * with a new confidential secret id for the current data owner (the entity in the database won't be updated), else this method returns undefined.
-     * New confidential secret ids will have an appropriate tag, but existing confidential secret ids may not necessarily have it.
-     * @param entity an entity which needs to have a confidential secret id for the current data owner
-     * @param entityType the type of the entity
-     * @param doRequestBulkShareOrUpdate perform the request to share or update an entity encrypted metadata on the cloud API (and save to DB).
-     * @return undefined if the entity already had a confidential secret id for the current user, or the updated AND SAVED entity with the new
-     * confidential secret id.
-     */
-    initialiseConfidentialSecretId(entity, entityType, doRequestBulkShareOrUpdate) {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (yield this.getConfidentialSecretId({ entity, type: entityType }))
-                return undefined;
-            const confidentialSecretId = this.primitives.randomUuid();
-            return (yield this.entitiesEncryption.simpleShareOrUpdateEncryptedEntityMetadata({ entity, type: entityType }, {
-                [yield this.dataOwnerApi.getCurrentDataOwnerId()]: {
-                    shareEncryptionKeys: ShareMetadataBehaviour_1.ShareMetadataBehaviour.NEVER,
-                    shareOwningEntityIds: ShareMetadataBehaviour_1.ShareMetadataBehaviour.NEVER,
-                    shareSecretIds: [confidentialSecretId],
-                    requestedPermissions: RequestedPermissionEnum.MAX_WRITE,
-                },
-            }, (request) => doRequestBulkShareOrUpdate(request))).updatedEntityOrThrow;
-        });
-    }
-    /**
-     * Get an existing confidential secret id of the provided entity for the provided data owner (current data owner by default). A confidential secret
-     * id is a secret id known by the data owner but not known by any of his parents: note however that children will know confidential secret ids.
-     * @param entity an entity for which you want to retrieve the confidential secret id.
-     * @param dataOwnerId (current data owner by default) a data owner for which you want to get a confidential secret id.
-     * @return the confidential secret id or undefined if there is no confidential secret id for the provided data owner.
-     */
-    getConfidentialSecretId(entity, dataOwnerId) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return this.getConfidentialSecretIds(entity, dataOwnerId).then((x) => x[0]);
-        });
-    }
-    /**
-     * Get all existing confidential secret ids of the provided entity for the provided data owner (current data owner by default). A confidential secret
-     * id is a secret id known by the data owner but not known by any of his parents: note however that children will know confidential secret ids.
-     * @param entity an entity for which you want to retrieve the confidential secret id.
-     * @param dataOwnerId (current data owner by default) a data owner for which you want to get a confidential secret id.
-     * @return the confidential secret ids for the data owner (may be empty).
-     */
-    getConfidentialSecretIds(entity, dataOwnerId) {
-        return __awaiter(this, void 0, void 0, function* () {
-            // TODO throw exception if any parent key is not available? if we are missing even only one single parent key we can't be sure it is confidential
-            const chosenDataOwnerId = dataOwnerId !== null && dataOwnerId !== void 0 ? dataOwnerId : (yield this.dataOwnerApi.getCurrentDataOwnerId());
-            const dataOwnerHierarchy = yield this.dataOwnerApi.getCurrentDataOwnerHierarchyIdsFrom(chosenDataOwnerId);
-            const hierarchySecretIds = (yield this.entitiesEncryption.secretIdsForHcpHierarchyOf(entity)).filter((x) => dataOwnerHierarchy.includes(x.ownerId));
-            const keysForDataOwner = hierarchySecretIds.find((x) => x.ownerId === chosenDataOwnerId);
-            if (!keysForDataOwner)
-                return [];
-            return keysForDataOwner.extracted.filter((k) => !hierarchySecretIds.some((x) => x.ownerId !== chosenDataOwnerId && x.extracted.includes(k)));
-        });
-    }
-    /**
-     * Gets a secret id known by the topmost parent of the current data owner hierarchy. If there is multiple secret ids shared with the topmost parent
-     * there is no guarantee on which one will be chosen.
-     * @param entity an entity.
-     * @return a secret id known by the topmost parent of the current data owner hierarchy, or undefined if there is no secret id currently available
-     * for the topmost parent.
-     */
-    getAnySecretIdSharedWithParents(entity) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return (yield this.getSecretIdsSharedWithParents(entity))[0];
-        });
-    }
-    /**
-     * Gets all secret ids known by the topmost parent of the current data owner hierarchy (or all secret ids known by the current data owner if he is
-     * not part of any data owner hierarchy).
-     * @param entity an entity.
-     * @return all secret ids known by the topmost parent of the current data owner hierarchy, may be empty.
-     */
-    getSecretIdsSharedWithParents(entity) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return (yield this.entitiesEncryption.secretIdsForHcpHierarchyOf(entity))[0].extracted;
-        });
-    }
-}
-exports.ConfidentialEntities = ConfidentialEntities;
-//# sourceMappingURL=ConfidentialEntities.js.map

package/icc-x-api/crypto/ConfidentialEntities.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"ConfidentialEntities.js","sourceRoot":"","sources":["../../../icc-x-api/crypto/ConfidentialEntities.ts"],"names":[],"mappings":";;;;;;;;;;;;AAKA,qEAAiE;AACjE,wFAAoF;AACpF,IAAO,uBAAuB,GAAG,uCAAkB,CAAC,uBAAuB,CAAA;AAK3E;;;;;;;GAOG;AACH,MAAa,oBAAoB;IAC/B,YACmB,kBAAqC,EACrC,UAA4B,EAC5B,YAA8B;QAF9B,uBAAkB,GAAlB,kBAAkB,CAAmB;QACrC,eAAU,GAAV,UAAU,CAAkB;QAC5B,iBAAY,GAAZ,YAAY,CAAkB;IAC9C,CAAC;IAEJ;;;;;;;;;;OAUG;IACG,8BAA8B,CAClC,MAAS,EACT,UAAwC,EACxC,0BAA6G;;YAE7G,IAAI,MAAM,IAAI,CAAC,uBAAuB,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC;gBAAE,OAAO,SAAS,CAAA;YACtF,MAAM,oBAAoB,GAAG,IAAI,CAAC,UAAU,CAAC,UAAU,EAAE,CAAA;YACzD,OAAO,CACL,MAAM,IAAI,CAAC,kBAAkB,CAAC,0CAA0C,CACtE,EAAE,MAAM,EAAE,IAAI,EAAE,UAAU,EAAE,EAC5B;gBACE,CAAC,MAAM,IAAI,CAAC,YAAY,CAAC,qBAAqB,EAAE,CAAC,EAAE;oBACjD,mBAAmB,EAAE,+CAAsB,CAAC,KAAK;oBACjD,oBAAoB,EAAE,+CAAsB,CAAC,KAAK;oBAClD,cAAc,EAAE,CAAC,oBAAoB,CAAC;oBACtC,oBAAoB,EAAE,uBAAuB,CAAC,SAAS;iBACxD;aACF,EACD,CAAC,OAAO,EAAE,EAAE,CAAC,0BAA0B,CAAC,OAAO,CAAC,CACjD,CACF,CAAC,oBAAoB,CAAA;QACxB,CAAC;KAAA;IAED;;;;;;OAMG;IACG,uBAAuB,CAAC,MAA+B,EAAE,WAAoB;;YACjF,OAAO,IAAI,CAAC,wBAAwB,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;QAC7E,CAAC;KAAA;IAED;;;;;;OAMG;IACG,wBAAwB,CAAC,MAA+B,EAAE,WAAoB;;YAClF,iJAAiJ;YACjJ,MAAM,iBAAiB,GAAG,WAAW,aAAX,WAAW,cAAX,WAAW,GAAI,CAAC,MAAM,IAAI,CAAC,YAAY,CAAC,qBAAqB,EAAE,CAAC,CAAA;YAC1F,MAAM,kBAAkB,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,mCAAmC,CAAC,iBAAiB,CAAC,CAAA;YACzG,MAAM,kBAAkB,GAAG,CAAC,MAAM,IAAI,CAAC,kBAAkB,CAAC,0BAA0B,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CACzG,kBAAkB,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,CACvC,CAAA;YACD,MAAM,gBAAgB,GAAG,kBAAkB,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,KAAK,iBAAiB,CAAC,CAAA;YAExF,IAAI,CAAC,gBAAgB;gBAAE,OAAO,EAAE,CAAA;YAChC,OAAO,gBAAgB,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,KAAK,iBAAiB,IAAI,CAAC,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;QAC9I,CAAC;KAAA;IAED;;;;;;OAMG;IACG,+BAA+B,CAAC,MAA+B;;YACnE,OAAO,CAAC,MAAM,IAAI,CAAC,6BAA6B,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;QAC9D,CAAC;KAAA;IAED;;;;;OAKG;IACG,6BAA6B,CAAC,MAA+B;;YACjE,OAAO,CAAC,MAAM,IAAI,CAAC,kBAAkB,CAAC,0BAA0B,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;QACxF,CAAC;KAAA;CACF;AA5FD,oDA4FC","sourcesContent":["import { EncryptedEntity } from '../../icc-api/model/models'\nimport { ExtendedApisUtils } from './ExtendedApisUtils'\nimport { CryptoPrimitives } from './CryptoPrimitives'\nimport { IccDataOwnerXApi } from '../icc-data-owner-x-api'\nimport { EncryptedEntityWithType, EntityWithDelegationTypeName } from '../utils/EntityWithDelegationTypeName'\nimport { ShareMetadataBehaviour } from './ShareMetadataBehaviour'\nimport { EntityShareRequest } from '../../icc-api/model/requests/EntityShareRequest'\nimport RequestedPermissionEnum = EntityShareRequest.RequestedPermissionEnum\nimport { EntityShareOrMetadataUpdateRequest } from '../../icc-api/model/requests/EntityShareOrMetadataUpdateRequest'\nimport { EntityBulkShareResult } from '../../icc-api/model/requests/EntityBulkShareResult'\nimport { BulkShareOrUpdateMetadataParams } from '../../icc-api/model/requests/BulkShareOrUpdateMetadataParams'\n\n/**\n * @internal this class is intended for internal use only and may be changed without notice.\n * This class helps to create confidential medical data in systems where multiple hcps share data with each other using parent hcps: while normally\n * the hcps would share all data with other hcps part of the same \"family\" (e.g. an hospital) there are situations where the medical data is\n * confidential and should only be known by the doctor which created the data. In these situations it is also important that the secret foreign key\n * used in the confidential data is not known by other members of the hcp family, otherwise they may be able to draw some links between the medical\n * data and the patient.\n */\nexport class ConfidentialEntities {\n  constructor(\n    private readonly entitiesEncryption: ExtendedApisUtils,\n    private readonly primitives: CryptoPrimitives,\n    private readonly dataOwnerApi: IccDataOwnerXApi\n  ) {}\n\n  /**\n   * Ensures that the current data owner has access to a confidential secret id for the provided entity: this is an id that is known to the data owner\n   * but is not known by any of his parents. If there is currently no confidential secret id for this entity the method returns a copy of the entity\n   * with a new confidential secret id for the current data owner (the entity in the database won't be updated), else this method returns undefined.\n   * New confidential secret ids will have an appropriate tag, but existing confidential secret ids may not necessarily have it.\n   * @param entity an entity which needs to have a confidential secret id for the current data owner\n   * @param entityType the type of the entity\n   * @param doRequestBulkShareOrUpdate perform the request to share or update an entity encrypted metadata on the cloud API (and save to DB).\n   * @return undefined if the entity already had a confidential secret id for the current user, or the updated AND SAVED entity with the new\n   * confidential secret id.\n   */\n  async initialiseConfidentialSecretId<T extends EncryptedEntity>(\n    entity: T,\n    entityType: EntityWithDelegationTypeName,\n    doRequestBulkShareOrUpdate: (request: BulkShareOrUpdateMetadataParams) => Promise<EntityBulkShareResult<T>[]>\n  ): Promise<T | undefined> {\n    if (await this.getConfidentialSecretId({ entity, type: entityType })) return undefined\n    const confidentialSecretId = this.primitives.randomUuid()\n    return (\n      await this.entitiesEncryption.simpleShareOrUpdateEncryptedEntityMetadata(\n        { entity, type: entityType },\n        {\n          [await this.dataOwnerApi.getCurrentDataOwnerId()]: {\n            shareEncryptionKeys: ShareMetadataBehaviour.NEVER,\n            shareOwningEntityIds: ShareMetadataBehaviour.NEVER,\n            shareSecretIds: [confidentialSecretId],\n            requestedPermissions: RequestedPermissionEnum.MAX_WRITE,\n          },\n        },\n        (request) => doRequestBulkShareOrUpdate(request)\n      )\n    ).updatedEntityOrThrow\n  }\n\n  /**\n   * Get an existing confidential secret id of the provided entity for the provided data owner (current data owner by default). A confidential secret\n   * id is a secret id known by the data owner but not known by any of his parents: note however that children will know confidential secret ids.\n   * @param entity an entity for which you want to retrieve the confidential secret id.\n   * @param dataOwnerId (current data owner by default) a data owner for which you want to get a confidential secret id.\n   * @return the confidential secret id or undefined if there is no confidential secret id for the provided data owner.\n   */\n  async getConfidentialSecretId(entity: EncryptedEntityWithType, dataOwnerId?: string): Promise<string | undefined> {\n    return this.getConfidentialSecretIds(entity, dataOwnerId).then((x) => x[0])\n  }\n\n  /**\n   * Get all existing confidential secret ids of the provided entity for the provided data owner (current data owner by default). A confidential secret\n   * id is a secret id known by the data owner but not known by any of his parents: note however that children will know confidential secret ids.\n   * @param entity an entity for which you want to retrieve the confidential secret id.\n   * @param dataOwnerId (current data owner by default) a data owner for which you want to get a confidential secret id.\n   * @return the confidential secret ids for the data owner (may be empty).\n   */\n  async getConfidentialSecretIds(entity: EncryptedEntityWithType, dataOwnerId?: string): Promise<string[]> {\n    // TODO throw exception if any parent key is not available? if we are missing even only one single parent key we can't be sure it is confidential\n    const chosenDataOwnerId = dataOwnerId ?? (await this.dataOwnerApi.getCurrentDataOwnerId())\n    const dataOwnerHierarchy = await this.dataOwnerApi.getCurrentDataOwnerHierarchyIdsFrom(chosenDataOwnerId)\n    const hierarchySecretIds = (await this.entitiesEncryption.secretIdsForHcpHierarchyOf(entity)).filter((x) =>\n      dataOwnerHierarchy.includes(x.ownerId)\n    )\n    const keysForDataOwner = hierarchySecretIds.find((x) => x.ownerId === chosenDataOwnerId)\n\n    if (!keysForDataOwner) return []\n    return keysForDataOwner.extracted.filter((k) => !hierarchySecretIds.some((x) => x.ownerId !== chosenDataOwnerId && x.extracted.includes(k)))\n  }\n\n  /**\n   * Gets a secret id known by the topmost parent of the current data owner hierarchy. If there is multiple secret ids shared with the topmost parent\n   * there is no guarantee on which one will be chosen.\n   * @param entity an entity.\n   * @return a secret id known by the topmost parent of the current data owner hierarchy, or undefined if there is no secret id currently available\n   * for the topmost parent.\n   */\n  async getAnySecretIdSharedWithParents(entity: EncryptedEntityWithType): Promise<string | undefined> {\n    return (await this.getSecretIdsSharedWithParents(entity))[0]\n  }\n\n  /**\n   * Gets all secret ids known by the topmost parent of the current data owner hierarchy (or all secret ids known by the current data owner if he is\n   * not part of any data owner hierarchy).\n   * @param entity an entity.\n   * @return all secret ids known by the topmost parent of the current data owner hierarchy, may be empty.\n   */\n  async getSecretIdsSharedWithParents(entity: EncryptedEntityWithType): Promise<string[]> {\n    return (await this.entitiesEncryption.secretIdsForHcpHierarchyOf(entity))[0].extracted\n  }\n}\n"]}