@icure/api 7.0.0-beta.1 → 7.0.0-beta.3

package/icc-x-api/icc-data-owner-x-api.js

@@ -9,26 +9,22 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.IccDataOwnerXApi = exports.DataOwnerTypeEnum = void 0;
+exports.IccDataOwnerXApi = void 0;
 const utils_1 = require("./crypto/utils");
-const XHR_1 = require("../icc-api/api/XHR");
-exports.DataOwnerTypeEnum = {
-    Patient: 'patient',
-    Device: 'device',
-    Hcp: 'hcp',
-};
-class IccDataOwnerXApi {
+const IccDataownerApi_1 = require("../icc-api/api/IccDataownerApi");
+const AuthenticationProvider_1 = require("./auth/AuthenticationProvider");
+class IccDataOwnerXApi extends IccDataownerApi_1.IccDataownerApi {
     get selfDataOwnerId() {
         if (!this.currentDataOwnerHierarchyIds)
             return undefined;
         return this.currentDataOwnerHierarchyIds[this.currentDataOwnerHierarchyIds.length - 1];
     }
-    constructor(userBaseApi, hcpartyBaseApi, //Init with a hcparty x api for better performances
-    patientBaseApi, deviceBaseApi) {
-        this.userBaseApi = userBaseApi;
-        this.hcpartyBaseApi = hcpartyBaseApi;
-        this.patientBaseApi = patientBaseApi;
-        this.deviceBaseApi = deviceBaseApi;
+    constructor(host, headers, authenticationProvider = new AuthenticationProvider_1.NoAuthenticationProvider(), fetchImpl = typeof window !== 'undefined'
+        ? window.fetch
+        : typeof self !== 'undefined'
+            ? self.fetch
+            : fetch) {
+        super(host, headers, authenticationProvider, fetchImpl);
     }
     /**
      * If the logged user is a data owner get the current data owner. This information is cached without expiration, and will only be updated in case
@@ -76,20 +72,6 @@ class IccDataOwnerXApi {
             throw new Error(`${parentId} is not part of the data owner hierarchy for the current user`);
         });
     }
-    /**
-     * If the logged user is a data owner get the current data owner.
-     * @throws if the current user is not a data owner.
-     */
-    getCurrentDataOwner() {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (!this.currentDataOwnerHierarchyIds) {
-                const dataOwnerHierarchy = yield this.forceLoadCurrentDataOwnerHierarchyAndCacheIds();
-                return dataOwnerHierarchy[dataOwnerHierarchy.length - 1];
-            }
-            else
-                return this.getDataOwner(yield this.getCurrentDataOwnerId());
-        });
-    }
     /**
      * If the logged user is a data owner get the current data owner and all of his parents.
      * @throws if the current user is not a data owner.
@@ -131,23 +113,38 @@ class IccDataOwnerXApi {
         return dataOwnerId;
     }
     /**
-     * Get a data owner. Uses a cache to improve performance.
+     * Get a data owner. Note that this does not decrpyt patient data owners.
      * @param ownerId id of the data owner to retrieve (patient, medical device, hcp, ...)
-     * @return the data owner or undefined if loadIfMissingFromCache is false and there is no data owner with provided id in cache.
-     * @throws if no data owner with the provided id could be found on an error occurred while attempting to retrieve it.
+     * @return the data owner with the provided id
+     * @throws if you have no access to the data owner. Use {@link getCryptoActorStub}.
      */
     getDataOwner(ownerId) {
+        const _super = Object.create(null, {
+            getDataOwner: { get: () => super.getDataOwner }
+        });
         return __awaiter(this, void 0, void 0, function* () {
-            const _url = this.userBaseApi.host + `/dataowner/` + ownerId + '?ts=' + new Date().getTime();
-            let headers = this.userBaseApi.headers;
-            return XHR_1.XHR.sendCommand('GET', _url, headers, null, this.userBaseApi.fetchImpl, undefined, this.userBaseApi.authenticationProvider.getAuthService())
-                .then((doc) => doc.body)
-                .then((dowt) => {
+            return _super.getDataOwner.call(this, ownerId).then((dowt) => {
                 if (dowt.dataOwner.id === this.selfDataOwnerId)
                     this.checkDataOwnerIntegrity(dowt.dataOwner);
                 return dowt;
-            })
-                .catch((err) => this.handleError(err));
+            });
+        });
+    }
+    /**
+     * Get a crypto actor stub for a data owner.
+     * @param ownerId id of the data owner for which you want to retrieve the stub (patient, medical device, hcp, ...)
+     * @return the crypto actor stub of the data owner with the provided id
+     */
+    getCryptoActorStub(ownerId) {
+        const _super = Object.create(null, {
+            getCryptoActorStub: { get: () => super.getCryptoActorStub }
+        });
+        return __awaiter(this, void 0, void 0, function* () {
+            return _super.getCryptoActorStub.call(this, ownerId).then((dowt) => {
+                if (dowt.stub.id === this.selfDataOwnerId)
+                    this.checkDataOwnerIntegrity(dowt.stub);
+                return dowt;
+            });
         });
     }
     /**
@@ -165,31 +162,6 @@ class IccDataOwnerXApi {
     clearCurrentDataOwnerIdsCache() {
         this.currentDataOwnerHierarchyIds = undefined;
     }
-    /**
-     * @internal This method is intended only for internal use and may be changed without notice.
-     * Updates a data owner and its cached value.
-     * @param dataOwner a data owner with updated value.
-     * @return the updated data owner, with updated revision.
-     */
-    updateDataOwner(dataOwner) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const ownerType = dataOwner.type;
-            const ownerToUpdate = dataOwner.dataOwner;
-            if (ownerType === 'hcp') {
-                return yield this.hcpartyBaseApi
-                    .modifyHealthcareParty(ownerToUpdate)
-                    .then((x) => ({ type: 'hcp', dataOwner: x }));
-            }
-            else if (ownerType === 'patient') {
-                return yield this.patientBaseApi.modifyPatient(ownerToUpdate).then((x) => ({ type: 'patient', dataOwner: x }));
-            }
-            else if (ownerType === 'device') {
-                return yield this.deviceBaseApi.updateDevice(ownerToUpdate).then((x) => ({ type: 'device', dataOwner: x }));
-            }
-            else
-                throw new Error(`Unrecognised data owner type: ${ownerType}`);
-        });
-    }
     checkDataOwnerIntegrity(dataOwner) {
         const keys = this.getHexPublicKeysOf(dataOwner);
         if (new Set(Array.from(keys).map((x) => x.slice(-32))).size != keys.size)
@@ -197,8 +169,7 @@ class IccDataOwnerXApi {
     }
     forceLoadCurrentDataOwnerHierarchyAndCacheIds() {
         return __awaiter(this, void 0, void 0, function* () {
-            const currentUser = yield this.userBaseApi.getCurrentUser();
-            let curr = yield this.getDataOwner(this.getDataOwnerIdOf(currentUser));
+            let curr = yield this.getCurrentDataOwner();
             this.checkDataOwnerIntegrity(curr.dataOwner);
             this.currentDataOwnerType = curr.type;
             let res = [curr];
@@ -210,9 +181,6 @@ class IccDataOwnerXApi {
             return res;
         });
     }
-    handleError(e) {
-        throw e;
-    }
 }
 exports.IccDataOwnerXApi = IccDataOwnerXApi;
 //# sourceMappingURL=icc-data-owner-x-api.js.map

package/icc-x-api/icc-data-owner-x-api.js.map

@@ -1 +1 @@
-{"version":3,"file":"icc-data-owner-x-api.js","sourceRoot":"","sources":["../../icc-x-api/icc-data-owner-x-api.ts"],"names":[],"mappings":";;;;;;;;;;;;AAKA,0CAAgD;AAEhD,4CAAwC;AAM3B,QAAA,iBAAiB,GAAyC;IACrE,OAAO,EAAE,SAAS;IAClB,MAAM,EAAE,QAAQ;IAChB,GAAG,EAAE,KAAK;CACX,CAAA;AAgBD,MAAa,gBAAgB;IAQ3B,IAAY,eAAe;QACzB,IAAI,CAAC,IAAI,CAAC,4BAA4B;YAAE,OAAO,SAAS,CAAA;QACxD,OAAO,IAAI,CAAC,4BAA4B,CAAC,IAAI,CAAC,4BAA4B,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;IACxF,CAAC;IAED,YACE,WAAuB,EACvB,cAA8B,EAAE,mDAAmD;IACnF,cAA6B,EAC7B,aAA2B;QAE3B,IAAI,CAAC,WAAW,GAAG,WAAW,CAAA;QAC9B,IAAI,CAAC,cAAc,GAAG,cAAc,CAAA;QACpC,IAAI,CAAC,cAAc,GAAG,cAAc,CAAA;QACpC,IAAI,CAAC,aAAa,GAAG,aAAa,CAAA;IACpC,CAAC;IAED;;;;OAIG;IACG,qBAAqB;;YACzB,IAAI,CAAC,IAAI,CAAC,4BAA4B,EAAE;gBACtC,MAAM,IAAI,CAAC,+BAA+B,EAAE,CAAA;aAC7C;YACD,OAAO,IAAI,CAAC,4BAA6B,CAAC,IAAI,CAAC,4BAA6B,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;QAC1F,CAAC;KAAA;IAED;;;;;OAKG;IACG,+BAA+B;;YACnC,IAAI,CAAC,IAAI,CAAC,4BAA4B,EAAE;gBACtC,MAAM,IAAI,CAAC,6CAA6C,EAAE,CAAA;aAC3D;YACD,OAAO,CAAC,GAAG,IAAI,CAAC,4BAA6B,CAAC,CAAA;QAChD,CAAC;KAAA;IAED;;;;OAIG;IACG,mCAAmC,CAAC,QAAgB;;YACxD,IAAI,CAAC,IAAI,CAAC,4BAA4B,EAAE;gBACtC,MAAM,IAAI,CAAC,+BAA+B,EAAE,CAAA;aAC7C;YACD,MAAM,GAAG,GAAG,EAAE,CAAA;YACd,KAAK,MAAM,WAAW,IAAI,IAAI,CAAC,4BAA6B,EAAE;gBAC5D,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,CAAA;gBACrB,IAAI,WAAW,KAAK,QAAQ;oBAAE,OAAO,GAAG,CAAA;aACzC;YACD,MAAM,IAAI,KAAK,CAAC,GAAG,QAAQ,+DAA+D,CAAC,CAAA;QAC7F,CAAC;KAAA;IAED;;;OAGG;IACG,mBAAmB;;YACvB,IAAI,CAAC,IAAI,CAAC,4BAA4B,EAAE;gBACtC,MAAM,kBAAkB,GAAG,MAAM,IAAI,CAAC,6CAA6C,EAAE,CAAA;gBACrF,OAAO,kBAAkB,CAAC,kBAAkB,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;aACzD;;gBAAM,OAAO,IAAI,CAAC,YAAY,CAAC,MAAM,IAAI,CAAC,qBAAqB,EAAE,CAAC,CAAA;QACrE,CAAC;KAAA;IAED;;;;OAIG;IACG,4BAA4B;;YAChC,IAAI,CAAC,IAAI,CAAC,4BAA4B,EAAE;gBACtC,OAAO,MAAM,IAAI,CAAC,6CAA6C,EAAE,CAAA;aAClE;;gBAAM,OAAO,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,4BAA6B,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC,CAAC,CAAA;QAClG,CAAC;KAAA;IAED;;;OAGG;IACG,uBAAuB;;YAC3B,IAAI,CAAC,IAAI,CAAC,4BAA4B,EAAE;gBACtC,MAAM,IAAI,CAAC,6CAA6C,EAAE,CAAA;aAC3D;YACD,OAAO,IAAI,CAAC,oBAAqB,CAAA;QACnC,CAAC;KAAA;IAED;;;;;OAKG;IACH,gBAAgB,CAAC,IAAU;;QACzB,MAAM,WAAW,GAAG,MAAA,MAAA,IAAI,CAAC,iBAAiB,mCAAI,IAAI,CAAC,SAAS,mCAAI,IAAI,CAAC,QAAQ,CAAA;QAC7E,IAAI,WAAW,IAAI,SAAS,EAAE;YAC5B,MAAM,KAAK,CAAC,QAAQ,IAAI,CAAC,EAAE,sBAAsB,CAAC,CAAA;SACnD;QACD,OAAO,WAAW,CAAA;IACpB,CAAC;IAED;;;;;OAKG;IACG,YAAY,CAAC,OAAe;;YAChC,MAAM,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,GAAG,aAAa,GAAG,OAAO,GAAG,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,CAAA;YAC5F,IAAI,OAAO,GAAG,IAAI,CAAC,WAAW,CAAC,OAAO,CAAA;YACtC,OAAO,SAAG,CAAC,WAAW,CACpB,KAAK,EACL,IAAI,EACJ,OAAO,EACP,IAAI,EACJ,IAAI,CAAC,WAAW,CAAC,SAAS,EAC1B,SAAS,EACT,IAAI,CAAC,WAAW,CAAC,sBAAsB,CAAC,cAAc,EAAE,CACzD;iBACE,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAyB,CAAC;iBAC5C,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE;gBACb,IAAI,IAAI,CAAC,SAAS,CAAC,EAAE,KAAK,IAAI,CAAC,eAAe;oBAAE,IAAI,CAAC,uBAAuB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;gBAC5F,OAAO,IAAI,CAAA;YACb,CAAC,CAAC;iBACD,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAA;QAC1C,CAAC;KAAA;IAED;;;;OAIG;IACH,kBAAkB,CAAC,SAAoB;QACrC,OAAO,IAAA,uBAAe,EAAC,SAAS,CAAC,CAAA;IACnC,CAAC;IAED;;;OAGG;IACH,6BAA6B;QAC3B,IAAI,CAAC,4BAA4B,GAAG,SAAS,CAAA;IAC/C,CAAC;IAED;;;;;OAKG;IACG,eAAe,CAAC,SAA4B;;YAChD,MAAM,SAAS,GAAG,SAAS,CAAC,IAAI,CAAA;YAChC,MAAM,aAAa,GAAG,SAAS,CAAC,SAAS,CAAA;YACzC,IAAI,SAAS,KAAK,KAAK,EAAE;gBACvB,OAAO,MAAM,IAAI,CAAC,cAAc;qBAC7B,qBAAqB,CAAC,aAAgC,CAAC;qBACvD,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,EAAwB,CAAA,CAAC,CAAA;aACrE;iBAAM,IAAI,SAAS,KAAK,SAAS,EAAE;gBAClC,OAAO,MAAM,IAAI,CAAC,cAAc,CAAC,aAAa,CAAC,aAAwB,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,SAAS,EAAE,CAAC,EAAwB,CAAA,CAAC,CAAA;aAC/I;iBAAM,IAAI,SAAS,KAAK,QAAQ,EAAE;gBACjC,OAAO,MAAM,IAAI,CAAC,aAAa,CAAC,YAAY,CAAC,aAAuB,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,SAAS,EAAE,CAAC,EAAwB,CAAA,CAAC,CAAA;aAC3I;;gBAAM,MAAM,IAAI,KAAK,CAAC,iCAAiC,SAAS,EAAE,CAAC,CAAA;QACtE,CAAC;KAAA;IAEO,uBAAuB,CAAC,SAAoB;QAClD,MAAM,IAAI,GAAG,IAAI,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAA;QAC/C,IAAI,IAAI,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,IAAI;YACtE,MAAM,IAAI,KAAK,CACb,6BAA6B,SAAS,CAAC,EAAE,gHAAgH,CAC1J,CAAA;IACL,CAAC;IAEa,6CAA6C;;YACzD,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,cAAc,EAAE,CAAA;YAC3D,IAAI,IAAI,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,gBAAgB,CAAC,WAAW,CAAC,CAAC,CAAA;YACtE,IAAI,CAAC,uBAAuB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;YAC5C,IAAI,CAAC,oBAAoB,GAAG,IAAI,CAAC,IAAI,CAAA;YACrC,IAAI,GAAG,GAAG,CAAC,IAAI,CAAC,CAAA;YAChB,OAAQ,IAAI,CAAC,SAA6B,CAAC,QAAQ,EAAE;gBACnD,IAAI,GAAG,MAAM,IAAI,CAAC,YAAY,CAAE,IAAI,CAAC,SAA6B,CAAC,QAAS,CAAC,CAAA;gBAC7E,GAAG,GAAG,CAAC,IAAI,EAAE,GAAG,GAAG,CAAC,CAAA;aACrB;YACD,IAAI,CAAC,4BAA4B,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAG,CAAC,CAAA;YACnE,OAAO,GAAG,CAAA;QACZ,CAAC;KAAA;IAEO,WAAW,CAAC,CAAe;QACjC,MAAM,CAAC,CAAA;IACT,CAAC;CACF;AA1MD,4CA0MC","sourcesContent":["import { User } from '../icc-api/model/User'\nimport { IccDeviceApi, IccPatientApi, IccUserApi } from '../icc-api'\nimport { HealthcareParty } from '../icc-api/model/HealthcareParty'\nimport { Patient } from '../icc-api/model/Patient'\nimport { Device } from '../icc-api/model/Device'\nimport { hexPublicKeysOf } from './crypto/utils'\nimport { IccHcpartyXApi } from './icc-hcparty-x-api'\nimport { XHR } from '../icc-api/api/XHR'\n\n/**\n * Represents a type of data owner.\n */\nexport type DataOwnerTypeEnum = 'patient' | 'device' | 'hcp'\nexport const DataOwnerTypeEnum: { [key: string]: DataOwnerTypeEnum } = {\n  Patient: 'patient',\n  Device: 'device',\n  Hcp: 'hcp',\n}\n\n/**\n * Represents any data owner.\n */\n// Trick to make typechecking work: without this you can pass anything to a data owner\nexport type DataOwner = (Patient | Device | HealthcareParty) & { id: string }\n\n/**\n * Represents any data owner enriched with type information.\n */\nexport type DataOwnerWithType =\n  | { type: 'patient'; dataOwner: Patient & DataOwner }\n  | { type: 'device'; dataOwner: Device & DataOwner }\n  | { type: 'hcp'; dataOwner: HealthcareParty & DataOwner }\n\nexport class IccDataOwnerXApi {\n  private readonly userBaseApi: IccUserApi\n  private readonly hcpartyBaseApi: IccHcpartyXApi\n  private readonly patientBaseApi: IccPatientApi\n  private readonly deviceBaseApi: IccDeviceApi\n  private currentDataOwnerType: DataOwnerTypeEnum | undefined\n  private currentDataOwnerHierarchyIds: string[] | undefined\n\n  private get selfDataOwnerId(): string | undefined {\n    if (!this.currentDataOwnerHierarchyIds) return undefined\n    return this.currentDataOwnerHierarchyIds[this.currentDataOwnerHierarchyIds.length - 1]\n  }\n\n  constructor(\n    userBaseApi: IccUserApi,\n    hcpartyBaseApi: IccHcpartyXApi, //Init with a hcparty x api for better performances\n    patientBaseApi: IccPatientApi,\n    deviceBaseApi: IccDeviceApi\n  ) {\n    this.userBaseApi = userBaseApi\n    this.hcpartyBaseApi = hcpartyBaseApi\n    this.patientBaseApi = patientBaseApi\n    this.deviceBaseApi = deviceBaseApi\n  }\n\n  /**\n   * If the logged user is a data owner get the current data owner. This information is cached without expiration, and will only be updated in case\n   * of forced refresh.\n   * @throws if the current user is not a data owner.\n   */\n  async getCurrentDataOwnerId(): Promise<string> {\n    if (!this.currentDataOwnerHierarchyIds) {\n      await this.getCurrentDataOwnerHierarchyIds()\n    }\n    return this.currentDataOwnerHierarchyIds![this.currentDataOwnerHierarchyIds!.length - 1]\n  }\n\n  /**\n   * If the logged user is a data owner get its parent hierarchy. This information is cached without expiration, and will only be updated in case\n   * of forced refresh.\n   * The resulting array starts with the topmost parent (the only ancestor without a parent) and ends with the data owner itself.\n   * @throws if the current user is not a data owner.\n   */\n  async getCurrentDataOwnerHierarchyIds(): Promise<string[]> {\n    if (!this.currentDataOwnerHierarchyIds) {\n      await this.forceLoadCurrentDataOwnerHierarchyAndCacheIds()\n    }\n    return [...this.currentDataOwnerHierarchyIds!]\n  }\n\n  /**\n   * Get the hierarchy for the current data owner starting from the specified parent.\n   * @throws an array starting at the topmost parent and ending at the provided parent id. If the provided id is not part of the hierarchy throws an\n   * error.\n   */\n  async getCurrentDataOwnerHierarchyIdsFrom(parentId: string): Promise<string[]> {\n    if (!this.currentDataOwnerHierarchyIds) {\n      await this.getCurrentDataOwnerHierarchyIds()\n    }\n    const res = []\n    for (const dataOwnerId of this.currentDataOwnerHierarchyIds!) {\n      res.push(dataOwnerId)\n      if (dataOwnerId === parentId) return res\n    }\n    throw new Error(`${parentId} is not part of the data owner hierarchy for the current user`)\n  }\n\n  /**\n   * If the logged user is a data owner get the current data owner.\n   * @throws if the current user is not a data owner.\n   */\n  async getCurrentDataOwner(): Promise<DataOwnerWithType> {\n    if (!this.currentDataOwnerHierarchyIds) {\n      const dataOwnerHierarchy = await this.forceLoadCurrentDataOwnerHierarchyAndCacheIds()\n      return dataOwnerHierarchy[dataOwnerHierarchy.length - 1]\n    } else return this.getDataOwner(await this.getCurrentDataOwnerId())\n  }\n\n  /**\n   * If the logged user is a data owner get the current data owner and all of his parents.\n   * @throws if the current user is not a data owner.\n   * @return the current data owner hierarchy, starting from the topmost parent to the current data owner.\n   */\n  async getCurrentDataOwnerHierarchy(): Promise<DataOwnerWithType[]> {\n    if (!this.currentDataOwnerHierarchyIds) {\n      return await this.forceLoadCurrentDataOwnerHierarchyAndCacheIds()\n    } else return Promise.all(this.currentDataOwnerHierarchyIds!.map((id) => this.getDataOwner(id)))\n  }\n\n  /**\n   * If the logged user is a data owner get the type of the current data owner. This information is cached.\n   * @throws if the current user is not a data owner\n   */\n  async getCurrentDataOwnerType(): Promise<DataOwnerTypeEnum> {\n    if (!this.currentDataOwnerHierarchyIds) {\n      await this.forceLoadCurrentDataOwnerHierarchyAndCacheIds()\n    }\n    return this.currentDataOwnerType!\n  }\n\n  /**\n   * Get the id of the data owner entity for a user.\n   * @param user a user that is also a data owner.\n   * @return the id of the data owner corresponding to the provided user.\n   * @throws if the user is not a data owner.\n   */\n  getDataOwnerIdOf(user: User): string {\n    const dataOwnerId = user.healthcarePartyId ?? user.patientId ?? user.deviceId\n    if (dataOwnerId == undefined) {\n      throw Error(`User ${user.id} is not a data owner`)\n    }\n    return dataOwnerId\n  }\n\n  /**\n   * Get a data owner. Uses a cache to improve performance.\n   * @param ownerId id of the data owner to retrieve (patient, medical device, hcp, ...)\n   * @return the data owner or undefined if loadIfMissingFromCache is false and there is no data owner with provided id in cache.\n   * @throws if no data owner with the provided id could be found on an error occurred while attempting to retrieve it.\n   */\n  async getDataOwner(ownerId: string): Promise<DataOwnerWithType> {\n    const _url = this.userBaseApi.host + `/dataowner/` + ownerId + '?ts=' + new Date().getTime()\n    let headers = this.userBaseApi.headers\n    return XHR.sendCommand(\n      'GET',\n      _url,\n      headers,\n      null,\n      this.userBaseApi.fetchImpl,\n      undefined,\n      this.userBaseApi.authenticationProvider.getAuthService()\n    )\n      .then((doc) => doc.body as DataOwnerWithType)\n      .then((dowt) => {\n        if (dowt.dataOwner.id === this.selfDataOwnerId) this.checkDataOwnerIntegrity(dowt.dataOwner)\n        return dowt\n      })\n      .catch((err) => this.handleError(err))\n  }\n\n  /**\n   * Gets the public keys of a data owner in hex format.\n   * @param dataOwner a data owner.\n   * @return the public keys for the data owner in hex format.\n   */\n  getHexPublicKeysOf(dataOwner: DataOwner): Set<string> {\n    return hexPublicKeysOf(dataOwner)\n  }\n\n  /**\n   * Clears the cache of current data owner id and parent hierarchy ids. The hierarchy of a data owner should not normally change over time, so this\n   * method should be rarely needed.\n   */\n  clearCurrentDataOwnerIdsCache() {\n    this.currentDataOwnerHierarchyIds = undefined\n  }\n\n  /**\n   * @internal This method is intended only for internal use and may be changed without notice.\n   * Updates a data owner and its cached value.\n   * @param dataOwner a data owner with updated value.\n   * @return the updated data owner, with updated revision.\n   */\n  async updateDataOwner(dataOwner: DataOwnerWithType): Promise<DataOwnerWithType> {\n    const ownerType = dataOwner.type\n    const ownerToUpdate = dataOwner.dataOwner\n    if (ownerType === 'hcp') {\n      return await this.hcpartyBaseApi\n        .modifyHealthcareParty(ownerToUpdate as HealthcareParty)\n        .then((x) => ({ type: 'hcp', dataOwner: x } as DataOwnerWithType))\n    } else if (ownerType === 'patient') {\n      return await this.patientBaseApi.modifyPatient(ownerToUpdate as Patient).then((x) => ({ type: 'patient', dataOwner: x } as DataOwnerWithType))\n    } else if (ownerType === 'device') {\n      return await this.deviceBaseApi.updateDevice(ownerToUpdate as Device).then((x) => ({ type: 'device', dataOwner: x } as DataOwnerWithType))\n    } else throw new Error(`Unrecognised data owner type: ${ownerType}`)\n  }\n\n  private checkDataOwnerIntegrity(dataOwner: DataOwner) {\n    const keys = this.getHexPublicKeysOf(dataOwner)\n    if (new Set(Array.from(keys).map((x) => x.slice(-32))).size != keys.size)\n      throw new Error(\n        `Different public keys for ${dataOwner.id} have the same fingerprint; this should not happen in normal circumstances. Please report this error to iCure.`\n      )\n  }\n\n  private async forceLoadCurrentDataOwnerHierarchyAndCacheIds(): Promise<DataOwnerWithType[]> {\n    const currentUser = await this.userBaseApi.getCurrentUser()\n    let curr = await this.getDataOwner(this.getDataOwnerIdOf(currentUser))\n    this.checkDataOwnerIntegrity(curr.dataOwner)\n    this.currentDataOwnerType = curr.type\n    let res = [curr]\n    while ((curr.dataOwner as HealthcareParty).parentId) {\n      curr = await this.getDataOwner((curr.dataOwner as HealthcareParty).parentId!)\n      res = [curr, ...res]\n    }\n    this.currentDataOwnerHierarchyIds = res.map((x) => x.dataOwner.id!)\n    return res\n  }\n\n  private handleError(e: XHR.XHRError): never {\n    throw e\n  }\n}\n"]}
+{"version":3,"file":"icc-data-owner-x-api.js","sourceRoot":"","sources":["../../icc-x-api/icc-data-owner-x-api.ts"],"names":[],"mappings":";;;;;;;;;;;;AAIA,0CAAgD;AAGhD,oEAAgE;AAChE,0EAAgG;AAMhG,MAAa,gBAAiB,SAAQ,iCAAe;IAInD,IAAY,eAAe;QACzB,IAAI,CAAC,IAAI,CAAC,4BAA4B;YAAE,OAAO,SAAS,CAAA;QACxD,OAAO,IAAI,CAAC,4BAA4B,CAAC,IAAI,CAAC,4BAA4B,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;IACxF,CAAC;IAED,YACE,IAAY,EACZ,OAAkC,EAClC,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;IACzD,CAAC;IAED;;;;OAIG;IACG,qBAAqB;;YACzB,IAAI,CAAC,IAAI,CAAC,4BAA4B,EAAE;gBACtC,MAAM,IAAI,CAAC,+BAA+B,EAAE,CAAA;aAC7C;YACD,OAAO,IAAI,CAAC,4BAA6B,CAAC,IAAI,CAAC,4BAA6B,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;QAC1F,CAAC;KAAA;IAED;;;;;OAKG;IACG,+BAA+B;;YACnC,IAAI,CAAC,IAAI,CAAC,4BAA4B,EAAE;gBACtC,MAAM,IAAI,CAAC,6CAA6C,EAAE,CAAA;aAC3D;YACD,OAAO,CAAC,GAAG,IAAI,CAAC,4BAA6B,CAAC,CAAA;QAChD,CAAC;KAAA;IAED;;;;OAIG;IACG,mCAAmC,CAAC,QAAgB;;YACxD,IAAI,CAAC,IAAI,CAAC,4BAA4B,EAAE;gBACtC,MAAM,IAAI,CAAC,+BAA+B,EAAE,CAAA;aAC7C;YACD,MAAM,GAAG,GAAG,EAAE,CAAA;YACd,KAAK,MAAM,WAAW,IAAI,IAAI,CAAC,4BAA6B,EAAE;gBAC5D,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,CAAA;gBACrB,IAAI,WAAW,KAAK,QAAQ;oBAAE,OAAO,GAAG,CAAA;aACzC;YACD,MAAM,IAAI,KAAK,CAAC,GAAG,QAAQ,+DAA+D,CAAC,CAAA;QAC7F,CAAC;KAAA;IAED;;;;OAIG;IACG,4BAA4B;;YAChC,IAAI,CAAC,IAAI,CAAC,4BAA4B,EAAE;gBACtC,OAAO,MAAM,IAAI,CAAC,6CAA6C,EAAE,CAAA;aAClE;;gBAAM,OAAO,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,4BAA6B,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC,CAAC,CAAA;QAClG,CAAC;KAAA;IAED;;;OAGG;IACG,uBAAuB;;YAC3B,IAAI,CAAC,IAAI,CAAC,4BAA4B,EAAE;gBACtC,MAAM,IAAI,CAAC,6CAA6C,EAAE,CAAA;aAC3D;YACD,OAAO,IAAI,CAAC,oBAAqB,CAAA;QACnC,CAAC;KAAA;IAED;;;;;OAKG;IACH,gBAAgB,CAAC,IAAU;;QACzB,MAAM,WAAW,GAAG,MAAA,MAAA,IAAI,CAAC,iBAAiB,mCAAI,IAAI,CAAC,SAAS,mCAAI,IAAI,CAAC,QAAQ,CAAA;QAC7E,IAAI,WAAW,IAAI,SAAS,EAAE;YAC5B,MAAM,KAAK,CAAC,QAAQ,IAAI,CAAC,EAAE,sBAAsB,CAAC,CAAA;SACnD;QACD,OAAO,WAAW,CAAA;IACpB,CAAC;IAED;;;;;OAKG;IACG,YAAY,CAAC,OAAe;;;;;YAChC,OAAO,OAAM,YAAY,YAAC,OAAO,EAAE,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE;gBAC/C,IAAI,IAAI,CAAC,SAAS,CAAC,EAAE,KAAK,IAAI,CAAC,eAAe;oBAAE,IAAI,CAAC,uBAAuB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;gBAC5F,OAAO,IAAI,CAAA;YACb,CAAC,CAAC,CAAA;QACJ,CAAC;KAAA;IAED;;;;OAIG;IACG,kBAAkB,CAAC,OAAe;;;;;YACtC,OAAO,OAAM,kBAAkB,YAAC,OAAO,EAAE,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE;gBACrD,IAAI,IAAI,CAAC,IAAI,CAAC,EAAE,KAAK,IAAI,CAAC,eAAe;oBAAE,IAAI,CAAC,uBAAuB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;gBAClF,OAAO,IAAI,CAAA;YACb,CAAC,CAAC,CAAA;QACJ,CAAC;KAAA;IAED;;;;OAIG;IACH,kBAAkB,CAAC,SAA0B;QAC3C,OAAO,IAAA,uBAAe,EAAC,SAAS,CAAC,CAAA;IACnC,CAAC;IAED;;;OAGG;IACH,6BAA6B;QAC3B,IAAI,CAAC,4BAA4B,GAAG,SAAS,CAAA;IAC/C,CAAC;IAEO,uBAAuB,CAAC,SAA0B;QACxD,MAAM,IAAI,GAAG,IAAI,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAA;QAC/C,IAAI,IAAI,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,IAAI;YACtE,MAAM,IAAI,KAAK,CACb,6BAA6B,SAAS,CAAC,EAAE,gHAAgH,CAC1J,CAAA;IACL,CAAC;IAEa,6CAA6C;;YACzD,IAAI,IAAI,GAAG,MAAM,IAAI,CAAC,mBAAmB,EAAE,CAAA;YAC3C,IAAI,CAAC,uBAAuB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;YAC5C,IAAI,CAAC,oBAAoB,GAAG,IAAI,CAAC,IAAI,CAAA;YACrC,IAAI,GAAG,GAAG,CAAC,IAAI,CAAC,CAAA;YAChB,OAAQ,IAAI,CAAC,SAA6B,CAAC,QAAQ,EAAE;gBACnD,IAAI,GAAG,MAAM,IAAI,CAAC,YAAY,CAAE,IAAI,CAAC,SAA6B,CAAC,QAAS,CAAC,CAAA;gBAC7E,GAAG,GAAG,CAAC,IAAI,EAAE,GAAG,GAAG,CAAC,CAAA;aACrB;YACD,IAAI,CAAC,4BAA4B,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAG,CAAC,CAAA;YACnE,OAAO,GAAG,CAAA;QACZ,CAAC;KAAA;CACF;AAlKD,4CAkKC","sourcesContent":["import { User } from '../icc-api/model/User'\nimport { HealthcareParty } from '../icc-api/model/HealthcareParty'\nimport { Patient } from '../icc-api/model/Patient'\nimport { Device } from '../icc-api/model/Device'\nimport { hexPublicKeysOf } from './crypto/utils'\nimport { DataOwnerTypeEnum } from 'icc-api/model/DataOwnerTypeEnum'\nimport { CryptoActorStub, CryptoActorStubWithType } from '../icc-api/model/CryptoActorStub'\nimport { IccDataownerApi } from '../icc-api/api/IccDataownerApi'\nimport { AuthenticationProvider, NoAuthenticationProvider } from './auth/AuthenticationProvider'\nimport { DataOwnerWithType } from '../icc-api/model/DataOwnerWithType'\n\nexport type DataOwnerOrStub = DataOwner | CryptoActorStub\nexport type DataOwner = HealthcareParty | Patient | Device\n\nexport class IccDataOwnerXApi extends IccDataownerApi {\n  private currentDataOwnerType: DataOwnerTypeEnum | undefined\n  private currentDataOwnerHierarchyIds: string[] | undefined\n\n  private get selfDataOwnerId(): string | undefined {\n    if (!this.currentDataOwnerHierarchyIds) return undefined\n    return this.currentDataOwnerHierarchyIds[this.currentDataOwnerHierarchyIds.length - 1]\n  }\n\n  constructor(\n    host: string,\n    headers: { [key: string]: string },\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  }\n\n  /**\n   * If the logged user is a data owner get the current data owner. This information is cached without expiration, and will only be updated in case\n   * of forced refresh.\n   * @throws if the current user is not a data owner.\n   */\n  async getCurrentDataOwnerId(): Promise<string> {\n    if (!this.currentDataOwnerHierarchyIds) {\n      await this.getCurrentDataOwnerHierarchyIds()\n    }\n    return this.currentDataOwnerHierarchyIds![this.currentDataOwnerHierarchyIds!.length - 1]\n  }\n\n  /**\n   * If the logged user is a data owner get its parent hierarchy. This information is cached without expiration, and will only be updated in case\n   * of forced refresh.\n   * The resulting array starts with the topmost parent (the only ancestor without a parent) and ends with the data owner itself.\n   * @throws if the current user is not a data owner.\n   */\n  async getCurrentDataOwnerHierarchyIds(): Promise<string[]> {\n    if (!this.currentDataOwnerHierarchyIds) {\n      await this.forceLoadCurrentDataOwnerHierarchyAndCacheIds()\n    }\n    return [...this.currentDataOwnerHierarchyIds!]\n  }\n\n  /**\n   * Get the hierarchy for the current data owner starting from the specified parent.\n   * @throws an array starting at the topmost parent and ending at the provided parent id. If the provided id is not part of the hierarchy throws an\n   * error.\n   */\n  async getCurrentDataOwnerHierarchyIdsFrom(parentId: string): Promise<string[]> {\n    if (!this.currentDataOwnerHierarchyIds) {\n      await this.getCurrentDataOwnerHierarchyIds()\n    }\n    const res = []\n    for (const dataOwnerId of this.currentDataOwnerHierarchyIds!) {\n      res.push(dataOwnerId)\n      if (dataOwnerId === parentId) return res\n    }\n    throw new Error(`${parentId} is not part of the data owner hierarchy for the current user`)\n  }\n\n  /**\n   * If the logged user is a data owner get the current data owner and all of his parents.\n   * @throws if the current user is not a data owner.\n   * @return the current data owner hierarchy, starting from the topmost parent to the current data owner.\n   */\n  async getCurrentDataOwnerHierarchy(): Promise<DataOwnerWithType[]> {\n    if (!this.currentDataOwnerHierarchyIds) {\n      return await this.forceLoadCurrentDataOwnerHierarchyAndCacheIds()\n    } else return Promise.all(this.currentDataOwnerHierarchyIds!.map((id) => this.getDataOwner(id)))\n  }\n\n  /**\n   * If the logged user is a data owner get the type of the current data owner. This information is cached.\n   * @throws if the current user is not a data owner\n   */\n  async getCurrentDataOwnerType(): Promise<DataOwnerTypeEnum> {\n    if (!this.currentDataOwnerHierarchyIds) {\n      await this.forceLoadCurrentDataOwnerHierarchyAndCacheIds()\n    }\n    return this.currentDataOwnerType!\n  }\n\n  /**\n   * Get the id of the data owner entity for a user.\n   * @param user a user that is also a data owner.\n   * @return the id of the data owner corresponding to the provided user.\n   * @throws if the user is not a data owner.\n   */\n  getDataOwnerIdOf(user: User): string {\n    const dataOwnerId = user.healthcarePartyId ?? user.patientId ?? user.deviceId\n    if (dataOwnerId == undefined) {\n      throw Error(`User ${user.id} is not a data owner`)\n    }\n    return dataOwnerId\n  }\n\n  /**\n   * Get a data owner. Note that this does not decrpyt patient data owners.\n   * @param ownerId id of the data owner to retrieve (patient, medical device, hcp, ...)\n   * @return the data owner with the provided id\n   * @throws if you have no access to the data owner. Use {@link getCryptoActorStub}.\n   */\n  async getDataOwner(ownerId: string): Promise<DataOwnerWithType> {\n    return super.getDataOwner(ownerId).then((dowt) => {\n      if (dowt.dataOwner.id === this.selfDataOwnerId) this.checkDataOwnerIntegrity(dowt.dataOwner)\n      return dowt\n    })\n  }\n\n  /**\n   * Get a crypto actor stub for a data owner.\n   * @param ownerId id of the data owner for which you want to retrieve the stub (patient, medical device, hcp, ...)\n   * @return the crypto actor stub of the data owner with the provided id\n   */\n  async getCryptoActorStub(ownerId: string): Promise<CryptoActorStubWithType> {\n    return super.getCryptoActorStub(ownerId).then((dowt) => {\n      if (dowt.stub.id === this.selfDataOwnerId) this.checkDataOwnerIntegrity(dowt.stub)\n      return dowt\n    })\n  }\n\n  /**\n   * Gets the public keys of a data owner in hex format.\n   * @param dataOwner a data owner.\n   * @return the public keys for the data owner in hex format.\n   */\n  getHexPublicKeysOf(dataOwner: DataOwnerOrStub): Set<string> {\n    return hexPublicKeysOf(dataOwner)\n  }\n\n  /**\n   * Clears the cache of current data owner id and parent hierarchy ids. The hierarchy of a data owner should not normally change over time, so this\n   * method should be rarely needed.\n   */\n  clearCurrentDataOwnerIdsCache() {\n    this.currentDataOwnerHierarchyIds = undefined\n  }\n\n  private checkDataOwnerIntegrity(dataOwner: DataOwnerOrStub) {\n    const keys = this.getHexPublicKeysOf(dataOwner)\n    if (new Set(Array.from(keys).map((x) => x.slice(-32))).size != keys.size)\n      throw new Error(\n        `Different public keys for ${dataOwner.id} have the same fingerprint; this should not happen in normal circumstances. Please report this error to iCure.`\n      )\n  }\n\n  private async forceLoadCurrentDataOwnerHierarchyAndCacheIds(): Promise<DataOwnerWithType[]> {\n    let curr = await this.getCurrentDataOwner()\n    this.checkDataOwnerIntegrity(curr.dataOwner)\n    this.currentDataOwnerType = curr.type\n    let res = [curr]\n    while ((curr.dataOwner as HealthcareParty).parentId) {\n      curr = await this.getDataOwner((curr.dataOwner as HealthcareParty).parentId!)\n      res = [curr, ...res]\n    }\n    this.currentDataOwnerHierarchyIds = res.map((x) => x.dataOwner.id!)\n    return res\n  }\n}\n"]}

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

@@ -4,7 +4,8 @@ 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 IccDocumentXApi extends IccDocumentApi {
+import { EncryptedEntityXApi } from './basexapi/EncryptedEntityXApi';
+export declare class IccDocumentXApi extends IccDocumentApi implements EncryptedEntityXApi<models.Document> {
     private crypto;
     private authApi;
     fetchImpl: (input: RequestInfo, init?: RequestInit) => Promise<Response>;
@@ -65,6 +66,13 @@ export declare class IccDocumentXApi extends IccDocumentApi {
      * @return the updated document.
      */
     encryptAndSetDocumentAttachment(document: models.Document, attachment: ArrayBuffer | Uint8Array): Promise<models.Document>;
+    /**
+     * Adds an unencrypted attachment to a document.
+     * @param document a document.
+     * @param attachment a new main attachment for the document.
+     * @return the updated document.
+     */
+    setClearDocumentAttachment(document: models.Document, attachment: ArrayBuffer | Uint8Array): Promise<models.Document>;
     /**
      * Adds a secondary attachment to a document, encrypting it on client side using the encryption keys of the provided document.
      * @param document a document.
@@ -74,7 +82,15 @@ export declare class IccDocumentXApi extends IccDocumentApi {
      */
     encryptAndSetSecondaryDocumentAttachment(document: models.Document, secondaryAttachmentKey: string, attachment: ArrayBuffer | Uint8Array): Promise<models.Document>;
     /**
-     * Gets the main attachment of a document and tries to decrypt it using the encryption keys of the document.
+     * Adds an unencrypted secondary attachment to a document.
+     * @param document a document.
+     * @param secondaryAttachmentKey key for the secondary attachment.
+     * @param attachment a new secondary attachment for the document.
+     * @return the updated document.
+     */
+    setClearSecondaryDocumentAttachment(document: models.Document, secondaryAttachmentKey: string, attachment: ArrayBuffer | Uint8Array): Promise<models.Document>;
+    /**
+     * Gets the main attachment of a document and tries to decrypt it using the encryption keys of the document, throwing an error if the operation fails.
      * @param document a document.
      * @param validator optionally a validator function which checks if the decryption was successful. In cases where the document has many encryption
      * keys and it is unclear which one should be used this function can help to detect bad decryptions.
@@ -82,14 +98,41 @@ export declare class IccDocumentXApi extends IccDocumentApi {
      */
     getAndDecryptDocumentAttachment(document: models.Document, validator?: (decrypted: ArrayBuffer) => Promise<boolean>): Promise<ArrayBuffer>;
     /**
-     * Gets the secondary attachment of a document and tries to decrypt it using the encryption keys of the document.
+     * Gets the main attachment of a document and tries to decrypt it using the encryption keys of the document.
+     * @param document a document.
+     * @param validator optionally a validator function which checks if the decryption was successful. In cases where the document has many encryption
+     * keys and it is unclear which one should be used this function can help to detect bad decryptions.
+     * @return an object containing:
+     * - data: the decrypted attachment, if it could be decrypted, else the encrypted attachment.
+     * - wasDecrypted: if the data was successfully decrypted or not
+     */
+    getAndTryDecryptDocumentAttachment(document: models.Document, validator?: (decrypted: ArrayBuffer) => Promise<boolean>): Promise<{
+        data: ArrayBuffer;
+        wasDecrypted: boolean;
+    }>;
+    /**
+     * Gets the secondary attachment of a document and tries to decrypt it using the encryption keys of the document, throwing an error if the operation fails.
      * @param document a document.
      * @param secondaryAttachmentKey key of the secondary attachment.
      * @param validator optionally a validator function which checks if the decryption was successful. In cases where the document has many encryption
      * keys and it is unclear which one should be used this function can help to detect bad decryptions.
-     * @return the decrypted attachment, if it could be decrypted, else the encrypted attachment.
+     * @return the decrypted attachment.
      */
     getAndDecryptSecondaryDocumentAttachment(document: models.Document, secondaryAttachmentKey: string, validator?: (decrypted: ArrayBuffer) => Promise<boolean>): Promise<ArrayBuffer>;
+    /**
+     * Gets the secondary attachment of a document and tries to decrypt it using the encryption keys of the document.
+     * @param document a document.
+     * @param secondaryAttachmentKey key of the secondary attachment.
+     * @param validator optionally a validator function which checks if the decryption was successful. In cases where the document has many encryption
+     * keys and it is unclear which one should be used this function can help to detect bad decryptions.
+     * @return an object containing:
+     * - data: the decrypted attachment, if it could be decrypted, else the encrypted attachment.
+     * - wasDecrypted: if the data was successfully decrypted or not
+     */
+    getAndTryDecryptSecondaryDocumentAttachment(document: models.Document, secondaryAttachmentKey: string, validator?: (decrypted: ArrayBuffer) => Promise<boolean>): Promise<{
+        data: ArrayBuffer;
+        wasDecrypted: boolean;
+    }>;
     /**
      * @param document a document
      * @return the id of the message that the document refers to, retrieved from the encrypted metadata. Normally there should only be one element
@@ -112,4 +155,28 @@ export declare class IccDocumentXApi extends IccDocumentApi {
         shareEncryptionKey?: ShareMetadataBehaviour;
         shareMessageId?: ShareMetadataBehaviour;
     }): Promise<models.Document>;
+    /**
+     * Share an existing document with other data owners, allowing them to access the non-encrypted data of the document and optionally also
+     * the encrypted content.
+     * @param document the document to share.
+     * @param delegates sharing options for each delegate.
+     * - shareEncryptionKey: specifies if the encryption key of the access log should be shared with the delegate, giving access to all encrypted
+     * content of the entity, excluding other encrypted metadata (defaults to {@link ShareMetadataBehaviour.IF_AVAILABLE}).
+     * - shareMessageId: specifies if the id of the message that this document refers to should be shared with the delegate (defaults to
+     * {@link ShareMetadataBehaviour.IF_AVAILABLE}).
+     * @return a promise which will contain the updated document.
+     */
+    shareWithMany(document: models.Document, delegates: {
+        [delegateId: string]: {
+            shareEncryptionKey?: ShareMetadataBehaviour;
+            shareMessageId?: ShareMetadataBehaviour;
+        };
+    }): Promise<models.Document>;
+    getDataOwnersWithAccessTo(entity: models.Document): Promise<{
+        permissionsByDataOwnerId: {
+            [p: string]: 'WRITE';
+        };
+        hasUnknownAnonymousDataOwners: boolean;
+    }>;
+    getEncryptionKeysOf(entity: models.Document): Promise<string[]>;
 }

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

@@ -563,6 +563,17 @@ class IccDocumentXApi extends icc_api_1.IccDocumentApi {
             return yield this.setDocumentAttachment(document.id, undefined, encryptedData);
         });
     }
+    /**
+     * Adds an unencrypted attachment to a document.
+     * @param document a document.
+     * @param attachment a new main attachment for the document.
+     * @return the updated document.
+     */
+    setClearDocumentAttachment(document, attachment) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.setDocumentAttachment(document.id, undefined, attachment);
+        });
+    }
     /**
      * Adds a secondary attachment to a document, encrypting it on client side using the encryption keys of the provided document.
      * @param document a document.
@@ -577,7 +588,19 @@ class IccDocumentXApi extends icc_api_1.IccDocumentApi {
         });
     }
     /**
-     * Gets the main attachment of a document and tries to decrypt it using the encryption keys of the document.
+     * Adds an unencrypted secondary attachment to a document.
+     * @param document a document.
+     * @param secondaryAttachmentKey key for the secondary attachment.
+     * @param attachment a new secondary attachment for the document.
+     * @return the updated document.
+     */
+    setClearSecondaryDocumentAttachment(document, secondaryAttachmentKey, attachment) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.setSecondaryAttachment(document.id, secondaryAttachmentKey, document.rev, attachment);
+        });
+    }
+    /**
+     * Gets the main attachment of a document and tries to decrypt it using the encryption keys of the document, throwing an error if the operation fails.
      * @param document a document.
      * @param validator optionally a validator function which checks if the decryption was successful. In cases where the document has many encryption
      * keys and it is unclear which one should be used this function can help to detect bad decryptions.
@@ -585,20 +608,55 @@ class IccDocumentXApi extends icc_api_1.IccDocumentApi {
      */
     getAndDecryptDocumentAttachment(document, validator = () => Promise.resolve(true)) {
         return __awaiter(this, void 0, void 0, function* () {
-            return yield this.crypto.entities.decryptDataOf(document, yield this.getDocumentAttachment(document.id, 'ignored'), (x) => validator(x));
+            const { data, wasDecrypted } = yield this.crypto.entities.tryDecryptDataOf(document, yield this.getDocumentAttachment(document.id, 'ignored'), (x) => validator(x));
+            if (!wasDecrypted)
+                throw new Error(`No valid key found to decrypt data of document ${document.id}.`);
+            return data;
         });
     }
     /**
-     * Gets the secondary attachment of a document and tries to decrypt it using the encryption keys of the document.
+     * Gets the main attachment of a document and tries to decrypt it using the encryption keys of the document.
+     * @param document a document.
+     * @param validator optionally a validator function which checks if the decryption was successful. In cases where the document has many encryption
+     * keys and it is unclear which one should be used this function can help to detect bad decryptions.
+     * @return an object containing:
+     * - data: the decrypted attachment, if it could be decrypted, else the encrypted attachment.
+     * - wasDecrypted: if the data was successfully decrypted or not
+     */
+    getAndTryDecryptDocumentAttachment(document, validator = () => Promise.resolve(true)) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.crypto.entities.tryDecryptDataOf(document, yield this.getDocumentAttachment(document.id, 'ignored'), (x) => validator(x));
+        });
+    }
+    /**
+     * Gets the secondary attachment of a document and tries to decrypt it using the encryption keys of the document, throwing an error if the operation fails.
      * @param document a document.
      * @param secondaryAttachmentKey key of the secondary attachment.
      * @param validator optionally a validator function which checks if the decryption was successful. In cases where the document has many encryption
      * keys and it is unclear which one should be used this function can help to detect bad decryptions.
-     * @return the decrypted attachment, if it could be decrypted, else the encrypted attachment.
+     * @return the decrypted attachment.
      */
     getAndDecryptSecondaryDocumentAttachment(document, secondaryAttachmentKey, validator = () => Promise.resolve(true)) {
         return __awaiter(this, void 0, void 0, function* () {
-            return yield this.crypto.entities.decryptDataOf(document, yield this.getSecondaryAttachment(document.id, secondaryAttachmentKey), (x) => validator(x));
+            const { data, wasDecrypted } = yield this.crypto.entities.tryDecryptDataOf(document, yield this.getSecondaryAttachment(document.id, secondaryAttachmentKey), (x) => validator(x));
+            if (!wasDecrypted)
+                throw new Error(`No valid key found to decrypt data of document ${document.id}.`);
+            return data;
+        });
+    }
+    /**
+     * Gets the secondary attachment of a document and tries to decrypt it using the encryption keys of the document.
+     * @param document a document.
+     * @param secondaryAttachmentKey key of the secondary attachment.
+     * @param validator optionally a validator function which checks if the decryption was successful. In cases where the document has many encryption
+     * keys and it is unclear which one should be used this function can help to detect bad decryptions.
+     * @return an object containing:
+     * - data: the decrypted attachment, if it could be decrypted, else the encrypted attachment.
+     * - wasDecrypted: if the data was successfully decrypted or not
+     */
+    getAndTryDecryptSecondaryDocumentAttachment(document, secondaryAttachmentKey, validator = () => Promise.resolve(true)) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.crypto.entities.tryDecryptDataOf(document, yield this.getSecondaryAttachment(document.id, secondaryAttachmentKey), (x) => validator(x));
         });
     }
     /**
@@ -625,7 +683,39 @@ class IccDocumentXApi extends icc_api_1.IccDocumentApi {
      */
     shareWith(delegateId, document, options = {}) {
         return __awaiter(this, void 0, void 0, function* () {
-            return yield this.modifyDocument(yield this.crypto.entities.entityWithAutoExtendedEncryptedMetadata(document, delegateId, undefined, options.shareEncryptionKey, options.shareMessageId));
+            return this.shareWithMany(document, { [delegateId]: options });
+        });
+    }
+    /**
+     * Share an existing document with other data owners, allowing them to access the non-encrypted data of the document and optionally also
+     * the encrypted content.
+     * @param document the document to share.
+     * @param delegates sharing options for each delegate.
+     * - shareEncryptionKey: specifies if the encryption key of the access log should be shared with the delegate, giving access to all encrypted
+     * content of the entity, excluding other encrypted metadata (defaults to {@link ShareMetadataBehaviour.IF_AVAILABLE}).
+     * - shareMessageId: specifies if the id of the message that this document refers to should be shared with the delegate (defaults to
+     * {@link ShareMetadataBehaviour.IF_AVAILABLE}).
+     * @return a promise which will contain the updated document.
+     */
+    shareWithMany(document, delegates) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.modifyDocument(yield this.crypto.entities.entityWithAutoExtendedEncryptedMetadata(document, true, Object.fromEntries(Object.entries(delegates).map(([delegateId, options]) => [
+                delegateId,
+                {
+                    shareEncryptionKey: options.shareEncryptionKey,
+                    shareOwningEntityIds: options.shareMessageId,
+                },
+            ]))));
+        });
+    }
+    getDataOwnersWithAccessTo(entity) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.crypto.entities.getDataOwnersWithAccessTo(entity);
+        });
+    }
+    getEncryptionKeysOf(entity) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.crypto.entities.encryptionKeysOf(entity);
         });
     }
 }