@icure/api 8.0.64 → 8.0.66

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

@@ -259,21 +259,17 @@ export interface ExtendedApisUtils {
         data: ArrayBuffer;
         wasDecrypted: boolean;
     }>;
-    /**
-     * TODO work on this
-     * Decrypts the content of an encrypted entity.
-     */
-    decryptEntity<T extends EncryptedEntity>(entity: T, entityType: EntityWithDelegationTypeName, constructor: (json: any) => T): Promise<{
+    tryDecryptEntities<T extends EncryptedEntity>(entities: T[], entityType: EntityWithDelegationTypeName, constructor: (json: any) => T): Promise<{
         entity: T;
         decrypted: boolean;
-    }>;
+    }[]>;
     /**
      * Tries to decrypt data to a json object using the provided keys.
      */
     tryDecryptJson(potentialKeys: {
         key: CryptoKey;
         raw: string;
-    }[], encrypted: Uint8Array, truncateTrailingDecryptedNulls: boolean): Promise<{} | undefined>;
+    }[], encrypted: Uint8Array, truncateTrailingDecryptedNulls: boolean): Promise<{} | null>;
     /**
      * Tries to encrypt the content of an encrypted entity.
      * 1. If valid key for encryption is found the method returns the entity with the encrypted fields specified by cryptedKeys
@@ -282,30 +278,56 @@ export interface ExtendedApisUtils {
      * for fields which should be encrypted according to cryptedKeys (e.g. note in a patient using the default configuration). If the entity specifies
      * a value for any field which should be encrypted the method throws an error, otherwise the method returns the original entity.
      */
-    tryEncryptEntity<T extends EncryptedEntity>(entity: T, entityType: EntityWithDelegationTypeName, fieldsToEncrypt: EncryptedFieldsManifest, encodeBinaryData: boolean, requireEncryption: boolean, constructor: (json: any) => T): Promise<T>;
+    tryEncryptEntities<T extends EncryptedEntity>(entities: T[], entityType: EntityWithDelegationTypeName, fieldsToEncrypt: EncryptedFieldsManifest, encodeBinaryData: boolean, requireEncryption: boolean, constructor: (json: any) => T): Promise<T[]>;
     /**
-     * Returns the first encryption key which could be properly decrypted from the entity using the current data owner.
-     * @throws if no key could be decrypted.
+     * Verifies if the entity has valid encryption keys (regardless of whether the current data owner has access to them or not). If not this method
+     * will throw an error, otherwise it will return undefined. For pre-2018 users there are some cases where the data may have been encrypted with a
+     * key not safe for encryption anymore, in which case this method will return the entity with a new and safe encryption key.
+     * After this method is called, if it returns an entity it should also be re-encrypted (using the new key) and saved to the cloud.
      */
-    decryptAndImportAnyEncryptionKey(entity: EncryptedEntityWithType): Promise<{
-        key: CryptoKey;
-        raw: string;
-    }>;
+    ensureEncryptionKeysInitialised<T extends EncryptedEntity>(entity: T, entityType: EntityWithDelegationTypeName): Promise<T | undefined>;
     /**
-     * Returns all encryption keys which could be properly decrypted from the entity using the current data owner. The keys returned by this method
-     * should not be used for encryption of the entity, but only for decryption.
-     * This is because this for data from pre-2018 users this method may return also keys from old formats of entities which are not safe anymore for
-     * encryption.
+     * Attempts to do the action providing "incrementally decrypted" keys as input; stops the first time the action
+     * completes successfully.
+     * The method tries to decrypt encryption keys for the entity "incrementally", trying first to decrypt keys that
+     * require less effort for decryption (e.g. using already cached exchange data or using exchange data for which the
+     * id is known without going through the exchange data map). Each time one or more new keys are decrypted the action
+     * is called providing ALL keys decrypted up to that point.
+     * If no key can be decrypted at all the method returns null without ever attempting the action (the action always
+     * receives at least a key in input or is not called).
+     * @param entity the entity from which to decrypt the encryption keys.
+     * @param entityType the type of entity
+     * @param action the action that consumes the encryption key.
+     * @return the wrapped result of the first successful action invocation, or null if the action never succeeded or if
+     * no key could be decrypted
      */
-    decryptAndImportAllDecryptionKeys(entity: EncryptedEntityWithType): Promise<{
+    doIncrementallyDecryptingKeys<E extends EncryptedEntity | EncryptedEntityStub, T>(entity: E, entityType: EntityWithDelegationTypeName, action: (entity: E, entityType: EntityWithDelegationTypeName, keys: {
         key: CryptoKey;
         raw: string;
-    }[]>;
+    }[]) => Promise<{
+        success: T;
+    } | null>): Promise<{
+        success: T;
+    } | null>;
     /**
-     * Verifies if the entity has valid encryption keys (regardless of whether the current data owner has access to them or not). If not this method
-     * will throw an error, otherwise it will return undefined. For pre-2018 users there are some cases where the data may have been encrypted with a
-     * key not safe for encryption anymore, in which case this method will return the entity with a new and safe encryption key.
-     * After this method is called, if it returns an entity it should also be re-encrypted (using the new key) and saved to the cloud.
+     * Bulk version of {@link doIncrementallyDecryptingKeys}.
+     * Differences:
+     * - The action is called until it succeeds for all entities or until all decryptable keys have been tried.
+     * - For each input the action must return an entry for that entity id with the result if successful or not include
+     *   the entity id in the result keys if unsuccessful.
+     * - An attempt on the action is done only if new keys could be decrypted for all the entities.
+     *   Additionally, there will be a final attempt after attempting all decryption steps if at least a new key could be
+     *   decrypted for an entity since the last attempt.
+     *   In this case entities for which no new key could be decrypted are omitted from the input.
+     * @param entities
+     * @param entitiesType
+     * @param action
+     * @return all entities id for which the action completed successfully associated to the result.
      */
-    ensureEncryptionKeysInitialised<T extends EncryptedEntity>(entity: T, entityType: EntityWithDelegationTypeName): Promise<T | undefined>;
+    doManyIncrementallyDecryptingKeys<E extends EncryptedEntity | EncryptedEntityStub, T>(entities: E[], entitiesType: EntityWithDelegationTypeName, action: (entity: E, entityType: EntityWithDelegationTypeName, keys: {
+        key: CryptoKey;
+        raw: string;
+    }[]) => Promise<{
+        success: T;
+    } | null>): Promise<Map<string, T>>;
 }

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

@@ -1 +1 @@
-{"version":3,"file":"ExtendedApisUtils.js","sourceRoot":"","sources":["../../../icc-x-api/crypto/ExtendedApisUtils.ts"],"names":[],"mappings":"","sourcesContent":["import { EncryptedEntity, EncryptedEntityStub } from '../../icc-api/model/models'\nimport { EncryptedEntityWithType, EntityWithDelegationTypeName } from '../utils/EntityWithDelegationTypeName'\nimport { SecureDelegation } from '../../icc-api/model/SecureDelegation'\nimport AccessLevelEnum = SecureDelegation.AccessLevelEnum\nimport { EntityShareOrMetadataUpdateRequest } from '../../icc-api/model/requests/EntityShareOrMetadataUpdateRequest'\nimport { EntityShareRequest } from '../../icc-api/model/requests/EntityShareRequest'\nimport { EntityBulkShareResult } from '../../icc-api/model/requests/EntityBulkShareResult'\nimport RequestedPermissionEnum = EntityShareRequest.RequestedPermissionEnum\nimport { ShareMetadataBehaviour } from './ShareMetadataBehaviour'\nimport { ShareResult } from '../utils/ShareResult'\nimport { MinimalEntityBulkShareResult } from '../../icc-api/model/requests/MinimalEntityBulkShareResult'\nimport { EncryptedFieldsManifest } from '../utils'\nimport { BulkShareOrUpdateMetadataParams } from '../../icc-api/model/requests/BulkShareOrUpdateMetadataParams'\n\n/**\n * @internal this interface is meant only for internal use and may be changed without notice.\n * Gives access to several functions to access encrypted entities metadata.\n */\nexport interface ExtendedApisUtils {\n  // region metadata decryption\n  /**\n   * Get the encryption keys of an entity that the provided data owner can access, potentially using the keys for his parent.\n   * There should only be one encryption key for each entity, but the method supports more to allow to deal with conflicts and merged duplicate data.\n   * @param entity an encrypted entity.\n   * @param dataOwnerId optionally a data owner part of the hierarchy for the current data owner, defaults to the current data owner.\n   * @return the encryption keys that the provided data owner can decrypt, deduplicated.\n   */\n  encryptionKeysOf(entity: EncryptedEntityWithType, dataOwnerId: string | undefined): Promise<string[]>\n\n  /**\n   * Get the encryption keys of an entity that the current data owner and his parents can access. The resulting array contains the keys for each data\n   * owner in the hierarchy which can be decrypted using only that data owner keys (excludes keys accessible through the parent keys). The order of\n   * the array is the same as in {@link IccDataOwnerXApi.getCurrentDataOwnerHierarchyIds}.\n   * Note that different data owners may have access to the same keys, but the keys extracted for each data owner are deduplicated.\n   * There should only be one encryption key for each entity, but the method supports more to allow to deal with conflicts and merged duplicate data.\n   * @param entity an encrypted entity.\n   * @return the encryption keys that each member of the current data owner hierarchy can decrypt using only his keys and not keys of his parents.\n   */\n  encryptionKeysForHcpHierarchyOf(entity: EncryptedEntityWithType): Promise<{ ownerId: string; extracted: string[] }[]>\n\n  /**\n   * Get the secret ids (SFKs) of an entity that the provided data owner can access, potentially using the keys for his parent.\n   * @param entity an encrypted entity.\n   * @param dataOwnerId optionally a data owner part of the hierarchy for the current data owner, defaults to the current data owner.\n   * @return the secret ids (SFKs) that the provided data owner can decrypt, deduplicated.\n   */\n  secretIdsOf(entity: EncryptedEntityWithType, dataOwnerId: string | undefined): Promise<string[]>\n\n  /**\n   * Get the secret ids (SFKs) of an entity that the current data owner and his parents can access. The resulting array contains the ids for each data\n   * owner in the hierarchy which can be decrypted using only that data owner keys (excludes ids accessible through the parent keys). The order of\n   * the array is the same as in {@link IccDataOwnerXApi.getCurrentDataOwnerHierarchyIds}.\n   * Note that different data owners may have access to the same secret ids, but the secret ids extracted for each data owner are deduplicated.\n   * @param entity an encrypted entity.\n   * @return the secret ids that each member of the current data owner hierarchy can decrypt using only his keys and not keys of his parents.\n   */\n  secretIdsForHcpHierarchyOf(entity: EncryptedEntityWithType): Promise<{ ownerId: string; extracted: string[] }[]>\n\n  /**\n   * Get the decrypted owning entity ids (formerly CFKs) for the provided entity that can be decrypted using the private keys of the current data\n   * owner and his parents. The owning entity id would be, for example, the id of a patient for contact and healthcare elements, or the id of a\n   * message for documents.\n   * There should only be one owning entity id for each entity, but the method supports more to allow to deal with conflicts and merged duplicate\n   * data.\n   * @param entity an encrypted entity.\n   * @param dataOwnerId optionally a data owner part of the hierarchy for the current data owner, defaults to the current data owner.\n   * @return the owning entity ids (CFKs) that the provided data owner can decrypt, deduplicated.\n   */\n  owningEntityIdsOf(entity: EncryptedEntityWithType, dataOwnerId: string | undefined): Promise<string[]>\n\n  /**\n   * Get the decrypted owning entity ids (formerly CFKs) for the provided entity that can be decrypted using the private keys of the current data\n   * owner and his parents. The owning entity id would be, for example, the id of a patient for contact and healthcare elements, or the id of a\n   * message for documents.\n   * The resulting array contains the ids for each data owner in the hierarchy which can be decrypted using only that data owner keys (excludes ids\n   * accessible through the parent keys). The order of the array is the same as in {@link IccDataOwnerXApi.getCurrentDataOwnerHierarchyIds}.\n   * Note that different data owners may have access to the same owning entity ids, but the owning entity ids extracted for each data owner are\n   * deduplicated in case they could be accessed through different delegations.\n   * There should only be one owning entity id for each entity, but the method supports more to allow to deal with conflicts and merged duplicate\n   * data.\n   * @param entity an encrypted entity.\n   * @return the owning entity ids that each member of the current data owner hierarchy can decrypt using only his keys and not keys of his parents.\n   */\n  owningEntityIdsForHcpHierarchyOf(entity: EncryptedEntityWithType): Promise<{ ownerId: string; extracted: string[] }[]>\n\n  /**\n   * Get if the current data owner has write access to the content of the entity.\n   * @param entity an entity\n   * @return if the current data owner (or one of his parents) has write access to the content of the entity.\n   */\n  hasWriteAccess(entity: EncryptedEntityWithType): Promise<boolean>\n\n  /**\n   * @param entity an entity\n   * @return if the entity has no encryption metadata and can be safely initialised using .\n   */\n  hasEmptyEncryptionMetadata(entity: EncryptedEntity): boolean\n  // endregion\n\n  // region metadata initialisation and share\n  /**\n   * Initializes encryption metadata for an entity. This includes the encrypted secret id, owning entity id, encryption key for the entity, and\n   * the clear text secret foreign key of the parent entity.\n   * This method returns a modified copy of the entity and DOES NOT SAVE the entity to the cloud/DB: you will have to save the entity manually.\n   * @param entity entity which requires encryption metadata initialisation.\n   * @param entityType type of the entity.\n   * @param owningEntity id of the owning entity, if any (e.g. patient id for Contact/HealtchareElement, message id for Document, ...).\n   * @param owningEntitySecretId secret id of the parent entity, to use in the secret foreign keys for the provided entity, if any.\n   * @param initialiseEncryptionKey if false this method will not initialize an encryption key for the entity. Use only for entities which use\n   * delegations for access control but don't actually have any encrypted content.\n   * HealthcareElement).\n   * @param autoDelegations automatically shares the metadata with the provided data owners, with the provided access level.\n   * @throws if the entity already has non-empty values for encryption metadata.\n   * @return an updated copy of the entity.\n   */\n  entityWithInitialisedEncryptedMetadata<T extends EncryptedEntity>(\n    entity: T,\n    entityType: EntityWithDelegationTypeName,\n    owningEntity: string | undefined,\n    owningEntitySecretId: string | undefined,\n    initialiseEncryptionKey: boolean,\n    autoDelegations: { [p: string]: SecureDelegation.AccessLevelEnum }\n  ): Promise<{ updatedEntity: T; rawEncryptionKey: string | undefined; secretId: string | undefined }>\n\n  /**\n   * Updates encryption metadata for an entity in order to share it with a delegate or in order to add additional encrypted metadata for an existing\n   * delegate.\n   * The first time this method is used for a specific delegate it will give access to all unencrypted content of the entity to the delegate data\n   * owner. Additionally, this method also allows to share new or existing secret ids (shareSecretId), encryption keys (shareEncryptionKeys) and\n   * owning entity ids (shareOwningEntityIds) for the entity.\n   * You can use methods like {@link secretIdsOf}, {@link secretIdsForHcpHierarchyOf}, {@link encryptionKeysOf}, ... to retrieve the data you want to\n   * share. In most cases you may want to share everything related to the entity, but note that if you use confidential delegations for patients you\n   * may want to avoid sharing the confidential secret ids of the current user with other hcps.\n   * This updates the entity in the cloud/DB (the updated entities in the returned promise are already saved in the DB). NOTE: this method can only\n   * be used with entities which already exist in the cloud (the entities must have been saved).\n   * @param entitiesType type of entities to update\n   * @param entitiesUpdates share/update requests for each entity. An array of objects containing:\n   * - The entity to share/update (or at least its encrypted metadata)\n   * - The data to share/update for each delegate. An object associating to each delegate id the data to share/update for that delegate, and the\n   * permissions requested for the delegate (ignored if the request will only update already existing shared metadata).\n   * @param doRequestBulkShareOrUpdate perform the request to share or update an entity encrypted metadata on the cloud API (and save to DB).\n   * @throws if there are duplicate entities in the requested updates.\n   * @return a promise which will be completed with an object containing:\n   * - the updated entities, only for entities were at least one update was successful\n   * - information on the individual requests failed, containing the id of the entity, id of the delegate that the request was for, the content,\n   * an error code mirroring an http status code, and a human-friendly description of the error (but not necessarily end-user friendly).\n   */\n  bulkShareOrUpdateEncryptedEntityMetadata<T extends EncryptedEntityStub>(\n    entitiesType: EntityWithDelegationTypeName,\n    entitiesUpdates: {\n      entity: EncryptedEntityStub\n      dataForDelegates: {\n        [delegateId: string]: {\n          shareSecretIds: string[]\n          shareEncryptionKeys: string[]\n          shareOwningEntityIds: string[]\n          requestedPermissions: RequestedPermissionEnum\n        }\n      }\n    }[],\n    doRequestBulkShareOrUpdate: (request: BulkShareOrUpdateMetadataParams) => Promise<EntityBulkShareResult<T>[]>\n  ): Promise<{\n    updatedEntities: T[]\n    unmodifiedEntitiesIds: string[]\n    updateErrors: {\n      entityId: string\n      delegateId: string\n      request?: {\n        shareSecretIds?: string[]\n        shareEncryptionKeys?: string[]\n        shareOwningEntityIds?: string[]\n        requestedPermissions: RequestedPermissionEnum\n      }\n      updatedForMigration: boolean\n      code?: number\n      reason?: string\n    }[]\n  }>\n\n  bulkShareOrUpdateEncryptedEntityMetadataNoEntities(\n    entitiesType: EntityWithDelegationTypeName,\n    entitiesUpdates: {\n      entity: EncryptedEntityStub\n      dataForDelegates: {\n        [delegateId: string]: {\n          shareSecretIds: string[]\n          shareEncryptionKeys: string[]\n          shareOwningEntityIds: string[]\n          requestedPermissions: RequestedPermissionEnum\n        }\n      }\n    }[],\n    doRequestBulkShareOrUpdate: (request: BulkShareOrUpdateMetadataParams) => Promise<MinimalEntityBulkShareResult[]>\n  ): Promise<{\n    unmodifiedEntitiesIds: string[]\n    successfulUpdates: { entityId: string; delegateId: string }[]\n    updateErrors: {\n      entityId: string\n      delegateId: string\n      request?: {\n        shareSecretIds?: string[]\n        shareEncryptionKeys?: string[]\n        shareOwningEntityIds?: string[]\n        requestedPermissions: RequestedPermissionEnum\n      }\n      updatedForMigration: boolean\n      code?: number\n      reason?: string\n    }[]\n  }>\n\n  /**\n   * Simplified version of {@link bulkShareOrUpdateEncryptedEntityMetadata} for a single entity and with automatic retrieval of the encryption keys\n   * and owning entity ids if requested. NOTE: this method can only be used with entities which already exist in the cloud (the entity must have\n   * been saved).\n   * @param entity an entity.\n   * versions. If true the method expects `shareSecretIds` options to always be undefined and will always share any available secret ids. If false\n   * it expects `shareSecretIds` options to always be defined and will only share the secret ids specified in the options.\n   * @param delegates associates the id of data owners which will be granted access to the entity, to the following sharing options:\n   * - shareEncryptionKeys specifies if the encryption keys of the entity should be shared. Defaults to\n   * {@link ShareMetadataBehaviour.IF_AVAILABLE}.\n   * - shareOwningEntityIds specifies if the owning entity ids of the entity should be shared. Defaults to\n   * {@link ShareMetadataBehaviour.IF_AVAILABLE}.\n   * - shareSecretIds specifies which secret ids of the entity should be shared. Should be defined only if {@link unusedSecretIds} is false.\n   * - requestedPermissions requested permissions for the delegate. Defaults to {@link RequestedPermissionEnum.MAX_WRITE}.\n   * @param doRequestBulkShareOrUpdate perform the request to share or update an entity encrypted metadata on the cloud API (and save to DB).\n   * @return a promise which will be completed with the result of the operation\n   * @throws if shareEncryptionKeys or shareOwningEntityIds is {@link ShareMetadataBehaviour.REQUIRED} and the current data owner can't access any\n   * value for the required metadata.\n   */\n  simpleShareOrUpdateEncryptedEntityMetadata<T extends EncryptedEntityStub>(\n    entity: { entity: T; type: EntityWithDelegationTypeName },\n    delegates: {\n      [p: string]: {\n        shareSecretIds: string[] | undefined\n        shareEncryptionKeys: ShareMetadataBehaviour | undefined\n        shareOwningEntityIds: ShareMetadataBehaviour | undefined\n        requestedPermissions: EntityShareRequest.RequestedPermissionEnum | undefined\n      }\n    },\n    doRequestBulkShareOrUpdate: (request: BulkShareOrUpdateMetadataParams) => Promise<EntityBulkShareResult<T>[]>\n  ): Promise<ShareResult<T>>\n  // endregion\n\n  // region content encryption and decryption\n  /**\n   * Encrypts data using a key of the entity that the provided data owner can access (current data owner by default). If the provided data owner can\n   * access multiple encryption keys of the entity there is no guarantee on which key will be used.\n   * Note: you should not use this method to encrypt the `encryptedSelf` of iCure entities, since that will be automatically handled by the extended\n   * apis. You should use this method only to encrypt additional data, such as document attachments.\n   * @param entity an entity.\n   * @param type type of the entity.\n   * @param content data of the entity which you want to encrypt.\n   * @param saveEntity a function which saves the entity to the cloud/DB. Used only if a new encryption key needed to be initialised for the entity.\n   * @return the encrypted data and, if a new encryption key was initialised for the entity, the updated entity.\n   * @throws if the provided data owner can't access any encryption keys for the entity.\n   */\n  encryptDataOf<T extends EncryptedEntityStub>(\n    entity: T,\n    type: EntityWithDelegationTypeName,\n    content: ArrayBuffer | Uint8Array,\n    saveEntity: (entity: T) => Promise<T>\n  ): Promise<{ encryptedData: ArrayBuffer; updatedEntity: T | undefined }>\n\n  /**\n   * Decrypts data using a key of the entity that the provided data owner can access (current data owner by default). If the provided data owner can\n   * access multiple encryption keys each of them will be tried for decryption until one of them gives a result that is valid according to the\n   * provided validator.\n   * Note: you should not use this method to decrypt the `encryptedSelf` of iCure entities, since that will be automatically handled by the extended\n   * apis. You should use this method only to decrypt additional data, such as document attachments.\n   * @param entity an entity.\n   * @param content data of the entity which you want to decrypt.\n   * @param validator a function which verifies the correctness of decrypted content: helps to identify decryption with the wrong key without relying\n   * solely on padding.\n   * @return the decrypted data.\n   * @throws if the provided data owner can't access any encryption keys for the entity, or if no key could be found which provided valid decrypted\n   * content according to the validator.\n   */\n  tryDecryptDataOf(\n    entity: EncryptedEntityWithType,\n    content: ArrayBuffer | Uint8Array,\n    validator: (decryptedData: ArrayBuffer) => Promise<boolean> | undefined\n  ): Promise<{ data: ArrayBuffer; wasDecrypted: boolean }>\n\n  /**\n   * TODO work on this\n   * Decrypts the content of an encrypted entity.\n   */\n  decryptEntity<T extends EncryptedEntity>(\n    entity: T,\n    entityType: EntityWithDelegationTypeName,\n    constructor: (json: any) => T\n  ): Promise<{ entity: T; decrypted: boolean }>\n\n  /**\n   * Tries to decrypt data to a json object using the provided keys.\n   */\n  tryDecryptJson(\n    potentialKeys: { key: CryptoKey; raw: string }[],\n    encrypted: Uint8Array,\n    truncateTrailingDecryptedNulls: boolean\n  ): Promise<{} | undefined>\n\n  /**\n   * Tries to encrypt the content of an encrypted entity.\n   * 1. If valid key for encryption is found the method returns the entity with the encrypted fields specified by cryptedKeys\n   * 2. If requireEncryption is true and no key could be found for encryption of the entity the method fails.\n   * 3. If requireEncryption is false and no key could be found for encryption the method will only check that the entity does not specify any value\n   * for fields which should be encrypted according to cryptedKeys (e.g. note in a patient using the default configuration). If the entity specifies\n   * a value for any field which should be encrypted the method throws an error, otherwise the method returns the original entity.\n   */\n  tryEncryptEntity<T extends EncryptedEntity>(\n    entity: T,\n    entityType: EntityWithDelegationTypeName,\n    fieldsToEncrypt: EncryptedFieldsManifest,\n    encodeBinaryData: boolean,\n    requireEncryption: boolean,\n    constructor: (json: any) => T\n  ): Promise<T>\n\n  /**\n   * Returns the first encryption key which could be properly decrypted from the entity using the current data owner.\n   * @throws if no key could be decrypted.\n   */\n  decryptAndImportAnyEncryptionKey(entity: EncryptedEntityWithType): Promise<{ key: CryptoKey; raw: string }>\n\n  /**\n   * Returns all encryption keys which could be properly decrypted from the entity using the current data owner. The keys returned by this method\n   * should not be used for encryption of the entity, but only for decryption.\n   * This is because this for data from pre-2018 users this method may return also keys from old formats of entities which are not safe anymore for\n   * encryption.\n   */\n  decryptAndImportAllDecryptionKeys(entity: EncryptedEntityWithType): Promise<{ key: CryptoKey; raw: string }[]>\n\n  /**\n   * Verifies if the entity has valid encryption keys (regardless of whether the current data owner has access to them or not). If not this method\n   * will throw an error, otherwise it will return undefined. For pre-2018 users there are some cases where the data may have been encrypted with a\n   * key not safe for encryption anymore, in which case this method will return the entity with a new and safe encryption key.\n   * After this method is called, if it returns an entity it should also be re-encrypted (using the new key) and saved to the cloud.\n   */\n  ensureEncryptionKeysInitialised<T extends EncryptedEntity>(entity: T, entityType: EntityWithDelegationTypeName): Promise<T | undefined>\n  // endregion\n}\n"]}
+{"version":3,"file":"ExtendedApisUtils.js","sourceRoot":"","sources":["../../../icc-x-api/crypto/ExtendedApisUtils.ts"],"names":[],"mappings":"","sourcesContent":["import { EncryptedEntity, EncryptedEntityStub } from '../../icc-api/model/models'\nimport { EncryptedEntityWithType, EntityWithDelegationTypeName } from '../utils/EntityWithDelegationTypeName'\nimport { SecureDelegation } from '../../icc-api/model/SecureDelegation'\nimport AccessLevelEnum = SecureDelegation.AccessLevelEnum\nimport { EntityShareOrMetadataUpdateRequest } from '../../icc-api/model/requests/EntityShareOrMetadataUpdateRequest'\nimport { EntityShareRequest } from '../../icc-api/model/requests/EntityShareRequest'\nimport { EntityBulkShareResult } from '../../icc-api/model/requests/EntityBulkShareResult'\nimport RequestedPermissionEnum = EntityShareRequest.RequestedPermissionEnum\nimport { ShareMetadataBehaviour } from './ShareMetadataBehaviour'\nimport { ShareResult } from '../utils/ShareResult'\nimport { MinimalEntityBulkShareResult } from '../../icc-api/model/requests/MinimalEntityBulkShareResult'\nimport { EncryptedFieldsManifest } from '../utils'\nimport { BulkShareOrUpdateMetadataParams } from '../../icc-api/model/requests/BulkShareOrUpdateMetadataParams'\n\n/**\n * @internal this interface is meant only for internal use and may be changed without notice.\n * Gives access to several functions to access encrypted entities metadata.\n */\nexport interface ExtendedApisUtils {\n  // region metadata decryption\n  /**\n   * Get the encryption keys of an entity that the provided data owner can access, potentially using the keys for his parent.\n   * There should only be one encryption key for each entity, but the method supports more to allow to deal with conflicts and merged duplicate data.\n   * @param entity an encrypted entity.\n   * @param dataOwnerId optionally a data owner part of the hierarchy for the current data owner, defaults to the current data owner.\n   * @return the encryption keys that the provided data owner can decrypt, deduplicated.\n   */\n  encryptionKeysOf(entity: EncryptedEntityWithType, dataOwnerId: string | undefined): Promise<string[]>\n\n  /**\n   * Get the encryption keys of an entity that the current data owner and his parents can access. The resulting array contains the keys for each data\n   * owner in the hierarchy which can be decrypted using only that data owner keys (excludes keys accessible through the parent keys). The order of\n   * the array is the same as in {@link IccDataOwnerXApi.getCurrentDataOwnerHierarchyIds}.\n   * Note that different data owners may have access to the same keys, but the keys extracted for each data owner are deduplicated.\n   * There should only be one encryption key for each entity, but the method supports more to allow to deal with conflicts and merged duplicate data.\n   * @param entity an encrypted entity.\n   * @return the encryption keys that each member of the current data owner hierarchy can decrypt using only his keys and not keys of his parents.\n   */\n  encryptionKeysForHcpHierarchyOf(entity: EncryptedEntityWithType): Promise<{ ownerId: string; extracted: string[] }[]>\n\n  /**\n   * Get the secret ids (SFKs) of an entity that the provided data owner can access, potentially using the keys for his parent.\n   * @param entity an encrypted entity.\n   * @param dataOwnerId optionally a data owner part of the hierarchy for the current data owner, defaults to the current data owner.\n   * @return the secret ids (SFKs) that the provided data owner can decrypt, deduplicated.\n   */\n  secretIdsOf(entity: EncryptedEntityWithType, dataOwnerId: string | undefined): Promise<string[]>\n\n  /**\n   * Get the secret ids (SFKs) of an entity that the current data owner and his parents can access. The resulting array contains the ids for each data\n   * owner in the hierarchy which can be decrypted using only that data owner keys (excludes ids accessible through the parent keys). The order of\n   * the array is the same as in {@link IccDataOwnerXApi.getCurrentDataOwnerHierarchyIds}.\n   * Note that different data owners may have access to the same secret ids, but the secret ids extracted for each data owner are deduplicated.\n   * @param entity an encrypted entity.\n   * @return the secret ids that each member of the current data owner hierarchy can decrypt using only his keys and not keys of his parents.\n   */\n  secretIdsForHcpHierarchyOf(entity: EncryptedEntityWithType): Promise<{ ownerId: string; extracted: string[] }[]>\n\n  /**\n   * Get the decrypted owning entity ids (formerly CFKs) for the provided entity that can be decrypted using the private keys of the current data\n   * owner and his parents. The owning entity id would be, for example, the id of a patient for contact and healthcare elements, or the id of a\n   * message for documents.\n   * There should only be one owning entity id for each entity, but the method supports more to allow to deal with conflicts and merged duplicate\n   * data.\n   * @param entity an encrypted entity.\n   * @param dataOwnerId optionally a data owner part of the hierarchy for the current data owner, defaults to the current data owner.\n   * @return the owning entity ids (CFKs) that the provided data owner can decrypt, deduplicated.\n   */\n  owningEntityIdsOf(entity: EncryptedEntityWithType, dataOwnerId: string | undefined): Promise<string[]>\n\n  /**\n   * Get the decrypted owning entity ids (formerly CFKs) for the provided entity that can be decrypted using the private keys of the current data\n   * owner and his parents. The owning entity id would be, for example, the id of a patient for contact and healthcare elements, or the id of a\n   * message for documents.\n   * The resulting array contains the ids for each data owner in the hierarchy which can be decrypted using only that data owner keys (excludes ids\n   * accessible through the parent keys). The order of the array is the same as in {@link IccDataOwnerXApi.getCurrentDataOwnerHierarchyIds}.\n   * Note that different data owners may have access to the same owning entity ids, but the owning entity ids extracted for each data owner are\n   * deduplicated in case they could be accessed through different delegations.\n   * There should only be one owning entity id for each entity, but the method supports more to allow to deal with conflicts and merged duplicate\n   * data.\n   * @param entity an encrypted entity.\n   * @return the owning entity ids that each member of the current data owner hierarchy can decrypt using only his keys and not keys of his parents.\n   */\n  owningEntityIdsForHcpHierarchyOf(entity: EncryptedEntityWithType): Promise<{ ownerId: string; extracted: string[] }[]>\n\n  /**\n   * Get if the current data owner has write access to the content of the entity.\n   * @param entity an entity\n   * @return if the current data owner (or one of his parents) has write access to the content of the entity.\n   */\n  hasWriteAccess(entity: EncryptedEntityWithType): Promise<boolean>\n\n  /**\n   * @param entity an entity\n   * @return if the entity has no encryption metadata and can be safely initialised using .\n   */\n  hasEmptyEncryptionMetadata(entity: EncryptedEntity): boolean\n  // endregion\n\n  // region metadata initialisation and share\n  /**\n   * Initializes encryption metadata for an entity. This includes the encrypted secret id, owning entity id, encryption key for the entity, and\n   * the clear text secret foreign key of the parent entity.\n   * This method returns a modified copy of the entity and DOES NOT SAVE the entity to the cloud/DB: you will have to save the entity manually.\n   * @param entity entity which requires encryption metadata initialisation.\n   * @param entityType type of the entity.\n   * @param owningEntity id of the owning entity, if any (e.g. patient id for Contact/HealtchareElement, message id for Document, ...).\n   * @param owningEntitySecretId secret id of the parent entity, to use in the secret foreign keys for the provided entity, if any.\n   * @param initialiseEncryptionKey if false this method will not initialize an encryption key for the entity. Use only for entities which use\n   * delegations for access control but don't actually have any encrypted content.\n   * HealthcareElement).\n   * @param autoDelegations automatically shares the metadata with the provided data owners, with the provided access level.\n   * @throws if the entity already has non-empty values for encryption metadata.\n   * @return an updated copy of the entity.\n   */\n  entityWithInitialisedEncryptedMetadata<T extends EncryptedEntity>(\n    entity: T,\n    entityType: EntityWithDelegationTypeName,\n    owningEntity: string | undefined,\n    owningEntitySecretId: string | undefined,\n    initialiseEncryptionKey: boolean,\n    autoDelegations: { [p: string]: SecureDelegation.AccessLevelEnum }\n  ): Promise<{ updatedEntity: T; rawEncryptionKey: string | undefined; secretId: string | undefined }>\n\n  /**\n   * Updates encryption metadata for an entity in order to share it with a delegate or in order to add additional encrypted metadata for an existing\n   * delegate.\n   * The first time this method is used for a specific delegate it will give access to all unencrypted content of the entity to the delegate data\n   * owner. Additionally, this method also allows to share new or existing secret ids (shareSecretId), encryption keys (shareEncryptionKeys) and\n   * owning entity ids (shareOwningEntityIds) for the entity.\n   * You can use methods like {@link secretIdsOf}, {@link secretIdsForHcpHierarchyOf}, {@link encryptionKeysOf}, ... to retrieve the data you want to\n   * share. In most cases you may want to share everything related to the entity, but note that if you use confidential delegations for patients you\n   * may want to avoid sharing the confidential secret ids of the current user with other hcps.\n   * This updates the entity in the cloud/DB (the updated entities in the returned promise are already saved in the DB). NOTE: this method can only\n   * be used with entities which already exist in the cloud (the entities must have been saved).\n   * @param entitiesType type of entities to update\n   * @param entitiesUpdates share/update requests for each entity. An array of objects containing:\n   * - The entity to share/update (or at least its encrypted metadata)\n   * - The data to share/update for each delegate. An object associating to each delegate id the data to share/update for that delegate, and the\n   * permissions requested for the delegate (ignored if the request will only update already existing shared metadata).\n   * @param doRequestBulkShareOrUpdate perform the request to share or update an entity encrypted metadata on the cloud API (and save to DB).\n   * @throws if there are duplicate entities in the requested updates.\n   * @return a promise which will be completed with an object containing:\n   * - the updated entities, only for entities were at least one update was successful\n   * - information on the individual requests failed, containing the id of the entity, id of the delegate that the request was for, the content,\n   * an error code mirroring an http status code, and a human-friendly description of the error (but not necessarily end-user friendly).\n   */\n  bulkShareOrUpdateEncryptedEntityMetadata<T extends EncryptedEntityStub>(\n    entitiesType: EntityWithDelegationTypeName,\n    entitiesUpdates: {\n      entity: EncryptedEntityStub\n      dataForDelegates: {\n        [delegateId: string]: {\n          shareSecretIds: string[]\n          shareEncryptionKeys: string[]\n          shareOwningEntityIds: string[]\n          requestedPermissions: RequestedPermissionEnum\n        }\n      }\n    }[],\n    doRequestBulkShareOrUpdate: (request: BulkShareOrUpdateMetadataParams) => Promise<EntityBulkShareResult<T>[]>\n  ): Promise<{\n    updatedEntities: T[]\n    unmodifiedEntitiesIds: string[]\n    updateErrors: {\n      entityId: string\n      delegateId: string\n      request?: {\n        shareSecretIds?: string[]\n        shareEncryptionKeys?: string[]\n        shareOwningEntityIds?: string[]\n        requestedPermissions: RequestedPermissionEnum\n      }\n      updatedForMigration: boolean\n      code?: number\n      reason?: string\n    }[]\n  }>\n\n  bulkShareOrUpdateEncryptedEntityMetadataNoEntities(\n    entitiesType: EntityWithDelegationTypeName,\n    entitiesUpdates: {\n      entity: EncryptedEntityStub\n      dataForDelegates: {\n        [delegateId: string]: {\n          shareSecretIds: string[]\n          shareEncryptionKeys: string[]\n          shareOwningEntityIds: string[]\n          requestedPermissions: RequestedPermissionEnum\n        }\n      }\n    }[],\n    doRequestBulkShareOrUpdate: (request: BulkShareOrUpdateMetadataParams) => Promise<MinimalEntityBulkShareResult[]>\n  ): Promise<{\n    unmodifiedEntitiesIds: string[]\n    successfulUpdates: { entityId: string; delegateId: string }[]\n    updateErrors: {\n      entityId: string\n      delegateId: string\n      request?: {\n        shareSecretIds?: string[]\n        shareEncryptionKeys?: string[]\n        shareOwningEntityIds?: string[]\n        requestedPermissions: RequestedPermissionEnum\n      }\n      updatedForMigration: boolean\n      code?: number\n      reason?: string\n    }[]\n  }>\n\n  /**\n   * Simplified version of {@link bulkShareOrUpdateEncryptedEntityMetadata} for a single entity and with automatic retrieval of the encryption keys\n   * and owning entity ids if requested. NOTE: this method can only be used with entities which already exist in the cloud (the entity must have\n   * been saved).\n   * @param entity an entity.\n   * versions. If true the method expects `shareSecretIds` options to always be undefined and will always share any available secret ids. If false\n   * it expects `shareSecretIds` options to always be defined and will only share the secret ids specified in the options.\n   * @param delegates associates the id of data owners which will be granted access to the entity, to the following sharing options:\n   * - shareEncryptionKeys specifies if the encryption keys of the entity should be shared. Defaults to\n   * {@link ShareMetadataBehaviour.IF_AVAILABLE}.\n   * - shareOwningEntityIds specifies if the owning entity ids of the entity should be shared. Defaults to\n   * {@link ShareMetadataBehaviour.IF_AVAILABLE}.\n   * - shareSecretIds specifies which secret ids of the entity should be shared. Should be defined only if {@link unusedSecretIds} is false.\n   * - requestedPermissions requested permissions for the delegate. Defaults to {@link RequestedPermissionEnum.MAX_WRITE}.\n   * @param doRequestBulkShareOrUpdate perform the request to share or update an entity encrypted metadata on the cloud API (and save to DB).\n   * @return a promise which will be completed with the result of the operation\n   * @throws if shareEncryptionKeys or shareOwningEntityIds is {@link ShareMetadataBehaviour.REQUIRED} and the current data owner can't access any\n   * value for the required metadata.\n   */\n  simpleShareOrUpdateEncryptedEntityMetadata<T extends EncryptedEntityStub>(\n    entity: { entity: T; type: EntityWithDelegationTypeName },\n    delegates: {\n      [p: string]: {\n        shareSecretIds: string[] | undefined\n        shareEncryptionKeys: ShareMetadataBehaviour | undefined\n        shareOwningEntityIds: ShareMetadataBehaviour | undefined\n        requestedPermissions: EntityShareRequest.RequestedPermissionEnum | undefined\n      }\n    },\n    doRequestBulkShareOrUpdate: (request: BulkShareOrUpdateMetadataParams) => Promise<EntityBulkShareResult<T>[]>\n  ): Promise<ShareResult<T>>\n  // endregion\n\n  // region content encryption and decryption\n  /**\n   * Encrypts data using a key of the entity that the provided data owner can access (current data owner by default). If the provided data owner can\n   * access multiple encryption keys of the entity there is no guarantee on which key will be used.\n   * Note: you should not use this method to encrypt the `encryptedSelf` of iCure entities, since that will be automatically handled by the extended\n   * apis. You should use this method only to encrypt additional data, such as document attachments.\n   * @param entity an entity.\n   * @param type type of the entity.\n   * @param content data of the entity which you want to encrypt.\n   * @param saveEntity a function which saves the entity to the cloud/DB. Used only if a new encryption key needed to be initialised for the entity.\n   * @return the encrypted data and, if a new encryption key was initialised for the entity, the updated entity.\n   * @throws if the provided data owner can't access any encryption keys for the entity.\n   */\n  encryptDataOf<T extends EncryptedEntityStub>(\n    entity: T,\n    type: EntityWithDelegationTypeName,\n    content: ArrayBuffer | Uint8Array,\n    saveEntity: (entity: T) => Promise<T>\n  ): Promise<{ encryptedData: ArrayBuffer; updatedEntity: T | undefined }>\n\n  /**\n   * Decrypts data using a key of the entity that the provided data owner can access (current data owner by default). If the provided data owner can\n   * access multiple encryption keys each of them will be tried for decryption until one of them gives a result that is valid according to the\n   * provided validator.\n   * Note: you should not use this method to decrypt the `encryptedSelf` of iCure entities, since that will be automatically handled by the extended\n   * apis. You should use this method only to decrypt additional data, such as document attachments.\n   * @param entity an entity.\n   * @param content data of the entity which you want to decrypt.\n   * @param validator a function which verifies the correctness of decrypted content: helps to identify decryption with the wrong key without relying\n   * solely on padding.\n   * @return the decrypted data.\n   * @throws if the provided data owner can't access any encryption keys for the entity, or if no key could be found which provided valid decrypted\n   * content according to the validator.\n   */\n  tryDecryptDataOf(\n    entity: EncryptedEntityWithType,\n    content: ArrayBuffer | Uint8Array,\n    validator: (decryptedData: ArrayBuffer) => Promise<boolean> | undefined\n  ): Promise<{ data: ArrayBuffer; wasDecrypted: boolean }>\n\n  tryDecryptEntities<T extends EncryptedEntity>(\n    entities: T[],\n    entityType: EntityWithDelegationTypeName,\n    constructor: (json: any) => T\n  ): Promise<{ entity: T; decrypted: boolean }[]>\n\n  /**\n   * Tries to decrypt data to a json object using the provided keys.\n   */\n  tryDecryptJson(potentialKeys: { key: CryptoKey; raw: string }[], encrypted: Uint8Array, truncateTrailingDecryptedNulls: boolean): Promise<{} | null>\n\n  /**\n   * Tries to encrypt the content of an encrypted entity.\n   * 1. If valid key for encryption is found the method returns the entity with the encrypted fields specified by cryptedKeys\n   * 2. If requireEncryption is true and no key could be found for encryption of the entity the method fails.\n   * 3. If requireEncryption is false and no key could be found for encryption the method will only check that the entity does not specify any value\n   * for fields which should be encrypted according to cryptedKeys (e.g. note in a patient using the default configuration). If the entity specifies\n   * a value for any field which should be encrypted the method throws an error, otherwise the method returns the original entity.\n   */\n  tryEncryptEntities<T extends EncryptedEntity>(\n    entities: T[],\n    entityType: EntityWithDelegationTypeName,\n    fieldsToEncrypt: EncryptedFieldsManifest,\n    encodeBinaryData: boolean,\n    requireEncryption: boolean,\n    constructor: (json: any) => T\n  ): Promise<T[]>\n\n  /**\n   * Verifies if the entity has valid encryption keys (regardless of whether the current data owner has access to them or not). If not this method\n   * will throw an error, otherwise it will return undefined. For pre-2018 users there are some cases where the data may have been encrypted with a\n   * key not safe for encryption anymore, in which case this method will return the entity with a new and safe encryption key.\n   * After this method is called, if it returns an entity it should also be re-encrypted (using the new key) and saved to the cloud.\n   */\n  ensureEncryptionKeysInitialised<T extends EncryptedEntity>(entity: T, entityType: EntityWithDelegationTypeName): Promise<T | undefined>\n\n  /**\n   * Attempts to do the action providing \"incrementally decrypted\" keys as input; stops the first time the action\n   * completes successfully.\n   * The method tries to decrypt encryption keys for the entity \"incrementally\", trying first to decrypt keys that\n   * require less effort for decryption (e.g. using already cached exchange data or using exchange data for which the\n   * id is known without going through the exchange data map). Each time one or more new keys are decrypted the action\n   * is called providing ALL keys decrypted up to that point.\n   * If no key can be decrypted at all the method returns null without ever attempting the action (the action always\n   * receives at least a key in input or is not called).\n   * @param entity the entity from which to decrypt the encryption keys.\n   * @param entityType the type of entity\n   * @param action the action that consumes the encryption key.\n   * @return the wrapped result of the first successful action invocation, or null if the action never succeeded or if\n   * no key could be decrypted\n   */\n  doIncrementallyDecryptingKeys<E extends EncryptedEntity | EncryptedEntityStub, T>(\n    entity: E,\n    entityType: EntityWithDelegationTypeName,\n    action: (entity: E, entityType: EntityWithDelegationTypeName, keys: { key: CryptoKey; raw: string }[]) => Promise<{ success: T } | null>\n  ): Promise<{ success: T } | null>\n\n  /**\n   * Bulk version of {@link doIncrementallyDecryptingKeys}.\n   * Differences:\n   * - The action is called until it succeeds for all entities or until all decryptable keys have been tried.\n   * - For each input the action must return an entry for that entity id with the result if successful or not include\n   *   the entity id in the result keys if unsuccessful.\n   * - An attempt on the action is done only if new keys could be decrypted for all the entities.\n   *   Additionally, there will be a final attempt after attempting all decryption steps if at least a new key could be\n   *   decrypted for an entity since the last attempt.\n   *   In this case entities for which no new key could be decrypted are omitted from the input.\n   * @param entities\n   * @param entitiesType\n   * @param action\n   * @return all entities id for which the action completed successfully associated to the result.\n   */\n  doManyIncrementallyDecryptingKeys<E extends EncryptedEntity | EncryptedEntityStub, T>(\n    entities: E[],\n    entitiesType: EntityWithDelegationTypeName,\n    action: (entity: E, entityType: EntityWithDelegationTypeName, keys: { key: CryptoKey; raw: string }[]) => Promise<{ success: T } | null>\n  ): Promise<Map<string, T>>\n  // endregion\n}\n"]}

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

@@ -1,21 +1,19 @@
 import { EncryptedEntity, EncryptedEntityStub } from '../../icc-api/model/models';
 import { IccDataOwnerXApi } from '../icc-data-owner-x-api';
-import { EncryptedFieldsManifest } from '../utils';
+import { EncryptedEntityWithType, EncryptedFieldsManifest, EntityWithDelegationTypeName } from '../utils';
 import { CryptoPrimitives } from './CryptoPrimitives';
-import { EncryptedEntityWithType, EntityWithDelegationTypeName } from '../utils/EntityWithDelegationTypeName';
+import { SecurityMetadataDecryptor } from './SecurityMetadataDecryptor';
 import { SecureDelegation } from '../../icc-api/model/SecureDelegation';
 import { ExtendedApisUtils } from './ExtendedApisUtils';
 import { EntityBulkShareResult } from '../../icc-api/model/requests/EntityBulkShareResult';
 import { EntityShareRequest } from '../../icc-api/model/requests/EntityShareRequest';
 import { SecureDelegationsManager } from './SecureDelegationsManager';
-import { LegacyDelegationSecurityMetadataDecryptor } from './LegacyDelegationSecurityMetadataDecryptor';
-import { SecureDelegationsSecurityMetadataDecryptor } from './SecureDelegationsSecurityMetadataDecryptor';
 import { ShareResult } from '../utils/ShareResult';
 import { ShareMetadataBehaviour } from './ShareMetadataBehaviour';
 import { IccUserXApi } from '../icc-user-x-api';
 import { MinimalEntityBulkShareResult } from '../../icc-api/model/requests/MinimalEntityBulkShareResult';
-import RequestedPermissionEnum = EntityShareRequest.RequestedPermissionEnum;
 import { BulkShareOrUpdateMetadataParams } from '../../icc-api/model/requests/BulkShareOrUpdateMetadataParams';
+import RequestedPermissionEnum = EntityShareRequest.RequestedPermissionEnum;
 /**
  * @internal this class is for internal use only and may be changed without notice.
  * Methods to support extended apis.
@@ -23,13 +21,11 @@ import { BulkShareOrUpdateMetadataParams } from '../../icc-api/model/requests/Bu
 export declare class ExtendedApisUtilsImpl implements ExtendedApisUtils {
     private readonly primitives;
     private readonly dataOwnerApi;
-    private readonly legacyDelMetadataDecryptor;
-    private readonly secDelMetadataDecryptor;
+    private readonly securityMetadataDecryptor;
     private readonly secureDelegationsManager;
     private readonly userApi;
     private readonly useParentKeys;
-    private readonly allSecurityMetadataDecryptor;
-    constructor(primitives: CryptoPrimitives, dataOwnerApi: IccDataOwnerXApi, legacyDelMetadataDecryptor: LegacyDelegationSecurityMetadataDecryptor, secDelMetadataDecryptor: SecureDelegationsSecurityMetadataDecryptor, secureDelegationsManager: SecureDelegationsManager, userApi: IccUserXApi, useParentKeys: boolean);
+    constructor(primitives: CryptoPrimitives, dataOwnerApi: IccDataOwnerXApi, securityMetadataDecryptor: SecurityMetadataDecryptor, secureDelegationsManager: SecureDelegationsManager, userApi: IccUserXApi, useParentKeys: boolean);
     encryptionKeysOf(entity: EncryptedEntityWithType, dataOwnerId?: string): Promise<string[]>;
     encryptionKeysForHcpHierarchyOf(entity: EncryptedEntityWithType): Promise<{
         ownerId: string;
@@ -132,28 +128,33 @@ export declare class ExtendedApisUtilsImpl implements ExtendedApisUtils {
         encryptedData: ArrayBuffer;
         updatedEntity: T | undefined;
     }>;
-    decryptEntity<T extends EncryptedEntity>(entity: T, entityType: EntityWithDelegationTypeName, constructor: (json: any) => T): Promise<{
+    tryDecryptEntities<T extends EncryptedEntity>(entities: T[], entityType: EntityWithDelegationTypeName, constructor: (json: any) => T): Promise<{
         entity: T;
         decrypted: boolean;
-    }>;
+    }[]>;
     tryDecryptJson(potentialKeys: {
         key: CryptoKey;
         raw: string;
-    }[], encrypted: Uint8Array, truncateTrailingDecryptedNulls: boolean): Promise<{} | undefined>;
-    tryEncryptEntity<T extends EncryptedEntity>(entity: T, entityType: EntityWithDelegationTypeName, fieldsToEncrypt: EncryptedFieldsManifest, encodeBinaryData: boolean, requireEncryption: boolean, constructor: (json: any) => T): Promise<T>;
+    }[], encrypted: Uint8Array, truncateTrailingDecryptedNulls: boolean): Promise<{} | null>;
+    tryEncryptEntities<T extends EncryptedEntity>(entities: T[], entityType: EntityWithDelegationTypeName, fieldsToEncrypt: EncryptedFieldsManifest, encodeBinaryData: boolean, requireEncryption: boolean, constructor: (json: any) => T): Promise<T[]>;
     ensureEncryptionKeysInitialised<T extends EncryptedEntity>(entity: T, entityType: EntityWithDelegationTypeName): Promise<T | undefined>;
     private decryptHierarchy;
     private decryptAndMergeHierarchy;
     private tryImportKey;
-    decryptAndImportAllDecryptionKeys(entity: EncryptedEntityWithType): Promise<{
+    doIncrementallyDecryptingKeys<E extends EncryptedEntity | EncryptedEntityStub, T>(entity: E, entityType: EntityWithDelegationTypeName, action: (entity: E, entityType: EntityWithDelegationTypeName, keys: {
         key: CryptoKey;
         raw: string;
-    }[]>;
-    decryptAndImportAnyEncryptionKey(entity: EncryptedEntityWithType): Promise<{
+    }[]) => Promise<{
+        success: T;
+    } | null>): Promise<{
+        success: T;
+    } | null>;
+    doManyIncrementallyDecryptingKeys<E extends EncryptedEntity | EncryptedEntityStub, T>(entities: E[], entitiesType: EntityWithDelegationTypeName, action: (entity: E, entityType: EntityWithDelegationTypeName, keys: {
         key: CryptoKey;
         raw: string;
-    }>;
-    private tryImportFirstValidKey;
+    }[]) => Promise<{
+        success: T;
+    } | null>): Promise<Map<string, T>>;
     private deduplicate;
     private throwDetailedExceptionForInvalidParameter;
     private checkEmptyEncryptionMetadata;