@icure/api 7.1.16 → 8.0.0-RC.2

package/icc-x-api/icc-time-table-x-api.js

@@ -14,13 +14,22 @@ const i18n = require("./rsrc/contact.i18n");
 const icc_api_1 = require("../icc-api");
 const models = require("../icc-api/model/models");
 const AuthenticationProvider_1 = require("./auth/AuthenticationProvider");
+const ShareMetadataBehaviour_1 = require("./crypto/ShareMetadataBehaviour");
+const SecureDelegation_1 = require("../icc-api/model/SecureDelegation");
+var AccessLevelEnum = SecureDelegation_1.SecureDelegation.AccessLevelEnum;
 class IccTimeTableXApi extends icc_api_1.IccTimeTableApi {
-    constructor(host, headers, crypto, dataOwnerApi, authenticationProvider = new AuthenticationProvider_1.NoAuthenticationProvider(), fetchImpl = typeof window !== 'undefined'
+    get headers() {
+        return super.headers.then((h) => this.crypto.accessControlKeysHeaders.addAccessControlKeysHeaders(h, 'TimeTable'));
+    }
+    constructor(host, headers, crypto, dataOwnerApi, autofillAuthor, authenticationProvider = new AuthenticationProvider_1.NoAuthenticationProvider(), fetchImpl = typeof window !== 'undefined'
         ? window.fetch
         : typeof self !== 'undefined'
             ? self.fetch
             : fetch) {
         super(host, headers, authenticationProvider, fetchImpl);
+        this.crypto = crypto;
+        this.dataOwnerApi = dataOwnerApi;
+        this.autofillAuthor = autofillAuthor;
         this.i18n = i18n;
         this.crypto = crypto;
         this.dataOwnerApi = dataOwnerApi;
@@ -33,24 +42,27 @@ class IccTimeTableXApi extends icc_api_1.IccTimeTableApi {
      * @param options optional parameters:
      * - additionalDelegates: delegates which will have access to the entity in addition to the current data owner and delegates from the
      * auto-delegations. Must be an object which associates each data owner id with the access level to give to that data owner. May overlap with
-     * auto-delegations, in such case the access level specified here will be used. Currently only WRITE access is supported, but in future also read
-     * access will be possible.
+     * auto-delegations, in such case the access level specified here will be used.
      * @return a new instance of timetable.
      */
     newInstance(user, tt, options = {}) {
         var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m;
         return __awaiter(this, void 0, void 0, function* () {
-            const timeTable = Object.assign(Object.assign({}, (tt !== null && tt !== void 0 ? tt : {})), { _type: 'org.taktik.icure.entities.TimeTable', id: (_a = tt === null || tt === void 0 ? void 0 : tt.id) !== null && _a !== void 0 ? _a : this.crypto.primitives.randomUuid(), created: (_b = tt === null || tt === void 0 ? void 0 : tt.created) !== null && _b !== void 0 ? _b : new Date().getTime(), modified: (_c = tt === null || tt === void 0 ? void 0 : tt.modified) !== null && _c !== void 0 ? _c : new Date().getTime(), responsible: (_d = tt === null || tt === void 0 ? void 0 : tt.responsible) !== null && _d !== void 0 ? _d : this.dataOwnerApi.getDataOwnerIdOf(user), author: (_e = tt === null || tt === void 0 ? void 0 : tt.author) !== null && _e !== void 0 ? _e : user.id, codes: (_f = tt === null || tt === void 0 ? void 0 : tt.codes) !== null && _f !== void 0 ? _f : [], tags: (_g = tt === null || tt === void 0 ? void 0 : tt.tags) !== null && _g !== void 0 ? _g : [] });
-            const extraDelegations = [
-                ...Object.keys((_h = options.additionalDelegates) !== null && _h !== void 0 ? _h : {}),
-                ...((_k = (_j = user.autoDelegations) === null || _j === void 0 ? void 0 : _j.all) !== null && _k !== void 0 ? _k : []),
-                ...((_m = (_l = user.autoDelegations) === null || _l === void 0 ? void 0 : _l.administrativeData) !== null && _m !== void 0 ? _m : []),
-            ];
-            return new models.TimeTable(yield this.crypto.entities
-                .entityWithInitialisedEncryptedMetadata(timeTable, undefined, undefined, true, extraDelegations)
+            const timeTable = Object.assign(Object.assign({}, (tt !== null && tt !== void 0 ? tt : {})), { id: (_a = tt === null || tt === void 0 ? void 0 : tt.id) !== null && _a !== void 0 ? _a : this.crypto.primitives.randomUuid(), created: (_b = tt === null || tt === void 0 ? void 0 : tt.created) !== null && _b !== void 0 ? _b : new Date().getTime(), modified: (_c = tt === null || tt === void 0 ? void 0 : tt.modified) !== null && _c !== void 0 ? _c : new Date().getTime(), responsible: (_d = tt === null || tt === void 0 ? void 0 : tt.responsible) !== null && _d !== void 0 ? _d : (this.autofillAuthor ? this.dataOwnerApi.getDataOwnerIdOf(user) : undefined), author: (_e = tt === null || tt === void 0 ? void 0 : tt.author) !== null && _e !== void 0 ? _e : (this.autofillAuthor ? user.id : undefined), codes: (_f = tt === null || tt === void 0 ? void 0 : tt.codes) !== null && _f !== void 0 ? _f : [], tags: (_g = tt === null || tt === void 0 ? void 0 : tt.tags) !== null && _g !== void 0 ? _g : [] });
+            const extraDelegations = Object.assign(Object.assign({}, Object.fromEntries([...((_j = (_h = user.autoDelegations) === null || _h === void 0 ? void 0 : _h.all) !== null && _j !== void 0 ? _j : []), ...((_l = (_k = user.autoDelegations) === null || _k === void 0 ? void 0 : _k.administrativeData) !== null && _l !== void 0 ? _l : [])].map((d) => [d, AccessLevelEnum.WRITE]))), ((_m = options === null || options === void 0 ? void 0 : options.additionalDelegates) !== null && _m !== void 0 ? _m : {}));
+            return new models.TimeTable(yield this.crypto.xapi
+                .entityWithInitialisedEncryptedMetadata(timeTable, 'TimeTable', undefined, undefined, true, false, extraDelegations)
                 .then((x) => x.updatedEntity));
         });
     }
+    /**
+     * @return if the logged data owner has write access to the content of the given time table
+     */
+    hasWriteAccess(timeTable) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.crypto.xapi.hasWriteAccess({ entity: timeTable, type: 'TimeTable' });
+        });
+    }
     /**
      * Share an existing time table with other data owners, allowing them to access the non-encrypted data of the time table and optionally also
      * the encrypted content, with read-only or read-write permissions.
@@ -60,8 +72,8 @@ class IccTimeTableXApi extends icc_api_1.IccTimeTableApi {
      * - shareEncryptionKey: specifies if the encryption key of the access log should be shared with the delegate, giving access to all encrypted
      * content of the entity, excluding other encrypted metadata (defaults to {@link ShareMetadataBehaviour.IF_AVAILABLE}). Note that by default a
      * time table does not have encrypted content.
-     * @return a promise which will contain the result of the operation: the updated entity if the operation was successful or details of the error if
-     * the operation failed.
+     * - requestedPermissions: the requested permissions for the delegate, defaults to {@link RequestedPermissionEnum.MAX_WRITE}.
+     * @return the updated entity
      */
     shareWith(delegateId, timeTable, options = {}) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -72,32 +84,54 @@ class IccTimeTableXApi extends icc_api_1.IccTimeTableApi {
      * Share an existing time table with other data owners, allowing them to access the non-encrypted data of the time table and optionally also
      * the encrypted content, with read-only or read-write permissions.
      * @param timeTable the time table to share.
-     * @param delegates sharing options for each delegate.
+     * @param delegates associates the id of data owners which will be granted access to the entity, to the following sharing options:
      * - shareEncryptionKey: specifies if the encryption key of the access log should be shared with the delegate, giving access to all encrypted
      * content of the entity, excluding other encrypted metadata (defaults to {@link ShareMetadataBehaviour.IF_AVAILABLE}). Note that by default a
      * time table does not have encrypted content.
-     * @return a promise which will contain the result of the operation: the updated entity if the operation was successful or details of the error if
-     * the operation failed.
+     * - requestedPermissions: the requested permissions for the delegate, defaults to {@link RequestedPermissionEnum.MAX_WRITE}.
+     * @return the updated entity
      */
     shareWithMany(timeTable, delegates) {
         return __awaiter(this, void 0, void 0, function* () {
-            const extended = yield this.crypto.entities.entityWithAutoExtendedEncryptedMetadata(timeTable, true, delegates);
-            if (!!extended) {
-                return yield this.modifyTimeTable(extended);
-            }
-            else
-                return timeTable;
+            return (yield this.tryShareWithMany(timeTable, delegates)).updatedEntityOrThrow;
         });
     }
-    getDataOwnersWithAccessTo(entity) {
+    /**
+     * Share an existing time table with other data owners, allowing them to access the non-encrypted data of the time table and optionally also
+     * the encrypted content, with read-only or read-write permissions.
+     * @param timeTable the time table to share.
+     * @param delegates associates the id of data owners which will be granted access to the entity, to the following sharing options:
+     * - shareEncryptionKey: specifies if the encryption key of the access log should be shared with the delegate, giving access to all encrypted
+     * content of the entity, excluding other encrypted metadata (defaults to {@link ShareMetadataBehaviour.IF_AVAILABLE}). Note that by default a
+     * time table does not have encrypted content.
+     * - requestedPermissions: the requested permissions for the delegate, defaults to {@link RequestedPermissionEnum.MAX_WRITE}.
+     * @return a promise which will contain the result of the operation: the updated entity if the operation was successful or details of the error if
+     * the operation failed.
+     */
+    tryShareWithMany(timeTable, delegates) {
         return __awaiter(this, void 0, void 0, function* () {
-            return yield this.crypto.entities.getDataOwnersWithAccessTo(entity);
+            // All entities should have an encryption key.
+            const entityWithEncryptionKey = yield this.crypto.xapi.ensureEncryptionKeysInitialised(timeTable, 'TimeTable');
+            const updatedEntity = entityWithEncryptionKey ? yield this.modifyTimeTable(entityWithEncryptionKey) : timeTable;
+            return this.crypto.xapi.simpleShareOrUpdateEncryptedEntityMetadata({ entity: updatedEntity, type: 'TimeTable' }, true, Object.fromEntries(Object.entries(delegates).map(([delegateId, options]) => [
+                delegateId,
+                {
+                    requestedPermissions: options.requestedPermissions,
+                    shareEncryptionKeys: options.shareEncryptionKey,
+                    shareOwningEntityIds: ShareMetadataBehaviour_1.ShareMetadataBehaviour.NEVER,
+                    shareSecretIds: undefined,
+                },
+            ])), (x) => this.bulkShareTimeTable(x));
         });
     }
+    getDataOwnersWithAccessTo(entity) {
+        return this.crypto.delegationsDeAnonymization.getDataOwnersWithAccessTo({ entity, type: 'TimeTable' });
+    }
     getEncryptionKeysOf(entity) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return yield this.crypto.entities.encryptionKeysOf(entity);
-        });
+        return this.crypto.xapi.encryptionKeysOf({ entity, type: 'TimeTable' }, undefined);
+    }
+    createDelegationDeAnonymizationMetadata(entity, delegates) {
+        return this.crypto.delegationsDeAnonymization.createOrUpdateDeAnonymizationInfo({ entity, type: 'TimeTable' }, delegates);
     }
 }
 exports.IccTimeTableXApi = IccTimeTableXApi;

package/icc-x-api/icc-time-table-x-api.js.map

@@ -1 +1 @@
-{"version":3,"file":"icc-time-table-x-api.js","sourceRoot":"","sources":["../../icc-x-api/icc-time-table-x-api.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,4CAA2C;AAG3C,wCAA4C;AAK5C,kDAAiD;AACjD,0EAAgG;AAIhG,MAAa,gBAAiB,SAAQ,yBAAe;IAKnD,YACE,IAAY,EACZ,OAAkC,EAClC,MAAqB,EACrB,YAA8B,EAC9B,yBAAiD,IAAI,iDAAwB,EAAE,EAC/E,YAA2E,OAAO,MAAM,KAAK,WAAW;QACtG,CAAC,CAAC,MAAM,CAAC,KAAK;QACd,CAAC,CAAC,OAAO,IAAI,KAAK,WAAW;YAC7B,CAAC,CAAC,IAAI,CAAC,KAAK;YACZ,CAAC,CAAC,KAAK;QAET,KAAK,CAAC,IAAI,EAAE,OAAO,EAAE,sBAAsB,EAAE,SAAS,CAAC,CAAA;QAhBzD,SAAI,GAAQ,IAAI,CAAA;QAiBd,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;QACpB,IAAI,CAAC,YAAY,GAAG,YAAY,CAAA;IAClC,CAAC;IAED;;;;;;;;;;;OAWG;IACG,WAAW,CACf,IAAU,EACV,EAAa,EACb,UAEI,EAAE;;;YAEN,MAAM,SAAS,mCACV,CAAC,EAAE,aAAF,EAAE,cAAF,EAAE,GAAI,EAAE,CAAC,KACb,KAAK,EAAE,qCAAqC,EAC5C,EAAE,EAAE,MAAA,EAAE,aAAF,EAAE,uBAAF,EAAE,CAAE,EAAE,mCAAI,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,UAAU,EAAE,EACjD,OAAO,EAAE,MAAA,EAAE,aAAF,EAAE,uBAAF,EAAE,CAAE,OAAO,mCAAI,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,EAC5C,QAAQ,EAAE,MAAA,EAAE,aAAF,EAAE,uBAAF,EAAE,CAAE,QAAQ,mCAAI,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,EAC9C,WAAW,EAAE,MAAA,EAAE,aAAF,EAAE,uBAAF,EAAE,CAAE,WAAW,mCAAI,IAAI,CAAC,YAAY,CAAC,gBAAgB,CAAC,IAAI,CAAC,EACxE,MAAM,EAAE,MAAA,EAAE,aAAF,EAAE,uBAAF,EAAE,CAAE,MAAM,mCAAI,IAAI,CAAC,EAAE,EAC7B,KAAK,EAAE,MAAA,EAAE,aAAF,EAAE,uBAAF,EAAE,CAAE,KAAK,mCAAI,EAAE,EACtB,IAAI,EAAE,MAAA,EAAE,aAAF,EAAE,uBAAF,EAAE,CAAE,IAAI,mCAAI,EAAE,GACrB,CAAA;YAED,MAAM,gBAAgB,GAAG;gBACvB,GAAG,MAAM,CAAC,IAAI,CAAC,MAAA,OAAO,CAAC,mBAAmB,mCAAI,EAAE,CAAC;gBACjD,GAAG,CAAC,MAAA,MAAA,IAAI,CAAC,eAAe,0CAAE,GAAG,mCAAI,EAAE,CAAC;gBACpC,GAAG,CAAC,MAAA,MAAA,IAAI,CAAC,eAAe,0CAAE,kBAAkB,mCAAI,EAAE,CAAC;aACpD,CAAA;YACD,OAAO,IAAI,MAAM,CAAC,SAAS,CACzB,MAAM,IAAI,CAAC,MAAM,CAAC,QAAQ;iBACvB,sCAAsC,CAAC,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,IAAI,EAAE,gBAAgB,CAAC;iBAC/F,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,aAAa,CAAC,CAChC,CAAA;;KACF;IAED;;;;;;;;;;;OAWG;IACG,SAAS,CACb,UAAkB,EAClB,SAA2B,EAC3B,UAEI,EAAE;;YAEN,OAAO,IAAI,CAAC,aAAa,CAAC,SAAS,EAAE,EAAE,CAAC,UAAU,CAAC,EAAE,OAAO,EAAE,CAAC,CAAA;QACjE,CAAC;KAAA;IAED;;;;;;;;;;OAUG;IACG,aAAa,CACjB,SAA2B,EAC3B,SAIC;;YAED,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,uCAAuC,CAAC,SAAS,EAAE,IAAI,EAAE,SAAS,CAAC,CAAA;YAC/G,IAAI,CAAC,CAAC,QAAQ,EAAE;gBACd,OAAO,MAAM,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAA;aAC5C;;gBAAM,OAAO,SAAS,CAAA;QACzB,CAAC;KAAA;IAEK,yBAAyB,CAC7B,MAAwB;;YAExB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,yBAAyB,CAAC,MAAM,CAAC,CAAA;QACrE,CAAC;KAAA;IAEK,mBAAmB,CAAC,MAAwB;;YAChD,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAA;QAC5D,CAAC;KAAA;CACF;AAzHD,4CAyHC","sourcesContent":["import * as i18n from './rsrc/contact.i18n'\n\nimport * as _ from 'lodash'\nimport { IccTimeTableApi } from '../icc-api'\nimport { User } from '../icc-api/model/User'\nimport { TimeTable } from '../icc-api/model/TimeTable'\nimport { IccCryptoXApi } from './icc-crypto-x-api'\nimport { IccDataOwnerXApi } from './icc-data-owner-x-api'\nimport * as models from '../icc-api/model/models'\nimport { AuthenticationProvider, NoAuthenticationProvider } from './auth/AuthenticationProvider'\nimport { ShareMetadataBehaviour } from './crypto/ShareMetadataBehaviour'\nimport { EncryptedEntityXApi } from './basexapi/EncryptedEntityXApi'\n\nexport class IccTimeTableXApi extends IccTimeTableApi implements EncryptedEntityXApi<TimeTable> {\n  i18n: any = i18n\n  crypto: IccCryptoXApi\n  dataOwnerApi: IccDataOwnerXApi\n\n  constructor(\n    host: string,\n    headers: { [key: string]: string },\n    crypto: IccCryptoXApi,\n    dataOwnerApi: IccDataOwnerXApi,\n    authenticationProvider: AuthenticationProvider = new NoAuthenticationProvider(),\n    fetchImpl: (input: RequestInfo, init?: RequestInit) => Promise<Response> = typeof window !== 'undefined'\n      ? window.fetch\n      : typeof self !== 'undefined'\n      ? self.fetch\n      : fetch\n  ) {\n    super(host, headers, authenticationProvider, fetchImpl)\n    this.crypto = crypto\n    this.dataOwnerApi = dataOwnerApi\n  }\n\n  /**\n   * Creates a new instance of timetable with initialised encryption metadata (not in the database).\n   * @param user the current user.\n   * @param tt initialised data for the timetable. Metadata such as id, creation data, etc. will be automatically initialised, but you can specify\n   * other kinds of data or overwrite generated metadata with this. You can't specify encryption metadata.\n   * @param options optional parameters:\n   * - additionalDelegates: delegates which will have access to the entity in addition to the current data owner and delegates from the\n   * auto-delegations. Must be an object which associates each data owner id with the access level to give to that data owner. May overlap with\n   * auto-delegations, in such case the access level specified here will be used. Currently only WRITE access is supported, but in future also read\n   * access will be possible.\n   * @return a new instance of timetable.\n   */\n  async newInstance(\n    user: User,\n    tt: TimeTable,\n    options: {\n      additionalDelegates?: { [dataOwnerId: string]: 'WRITE' }\n    } = {}\n  ) {\n    const timeTable = {\n      ...(tt ?? {}),\n      _type: 'org.taktik.icure.entities.TimeTable',\n      id: tt?.id ?? this.crypto.primitives.randomUuid(),\n      created: tt?.created ?? new Date().getTime(),\n      modified: tt?.modified ?? new Date().getTime(),\n      responsible: tt?.responsible ?? this.dataOwnerApi.getDataOwnerIdOf(user),\n      author: tt?.author ?? user.id,\n      codes: tt?.codes ?? [],\n      tags: tt?.tags ?? [],\n    }\n\n    const extraDelegations = [\n      ...Object.keys(options.additionalDelegates ?? {}),\n      ...(user.autoDelegations?.all ?? []),\n      ...(user.autoDelegations?.administrativeData ?? []),\n    ]\n    return new models.TimeTable(\n      await this.crypto.entities\n        .entityWithInitialisedEncryptedMetadata(timeTable, undefined, undefined, true, extraDelegations)\n        .then((x) => x.updatedEntity)\n    )\n  }\n\n  /**\n   * Share an existing time table with other data owners, allowing them to access the non-encrypted data of the time table and optionally also\n   * the encrypted content, with read-only or read-write permissions.\n   * @param delegateId the id of the data owner which will be granted access to the time table.\n   * @param timeTable the time table to share.\n   * @param options optional parameters to customize the sharing behaviour:\n   * - shareEncryptionKey: specifies if the encryption key of the access log should be shared with the delegate, giving access to all encrypted\n   * content of the entity, excluding other encrypted metadata (defaults to {@link ShareMetadataBehaviour.IF_AVAILABLE}). Note that by default a\n   * time table does not have encrypted content.\n   * @return a promise which will contain the result of the operation: the updated entity if the operation was successful or details of the error if\n   * the operation failed.\n   */\n  async shareWith(\n    delegateId: string,\n    timeTable: models.TimeTable,\n    options: {\n      shareEncryptionKey?: ShareMetadataBehaviour // Defaults to ShareMetadataBehaviour.IF_AVAILABLE\n    } = {}\n  ): Promise<models.TimeTable> {\n    return this.shareWithMany(timeTable, { [delegateId]: options })\n  }\n\n  /**\n   * Share an existing time table with other data owners, allowing them to access the non-encrypted data of the time table and optionally also\n   * the encrypted content, with read-only or read-write permissions.\n   * @param timeTable the time table to share.\n   * @param delegates sharing options for each delegate.\n   * - shareEncryptionKey: specifies if the encryption key of the access log should be shared with the delegate, giving access to all encrypted\n   * content of the entity, excluding other encrypted metadata (defaults to {@link ShareMetadataBehaviour.IF_AVAILABLE}). Note that by default a\n   * time table does not have encrypted content.\n   * @return a promise which will contain the result of the operation: the updated entity if the operation was successful or details of the error if\n   * the operation failed.\n   */\n  async shareWithMany(\n    timeTable: models.TimeTable,\n    delegates: {\n      [delegateId: string]: {\n        shareEncryptionKey?: ShareMetadataBehaviour // Defaults to ShareMetadataBehaviour.IF_AVAILABLE\n      }\n    }\n  ): Promise<models.TimeTable> {\n    const extended = await this.crypto.entities.entityWithAutoExtendedEncryptedMetadata(timeTable, true, delegates)\n    if (!!extended) {\n      return await this.modifyTimeTable(extended)\n    } else return timeTable\n  }\n\n  async getDataOwnersWithAccessTo(\n    entity: models.TimeTable\n  ): Promise<{ permissionsByDataOwnerId: { [p: string]: 'WRITE' }; hasUnknownAnonymousDataOwners: boolean }> {\n    return await this.crypto.entities.getDataOwnersWithAccessTo(entity)\n  }\n\n  async getEncryptionKeysOf(entity: models.TimeTable): Promise<string[]> {\n    return await this.crypto.entities.encryptionKeysOf(entity)\n  }\n}\n"]}
+{"version":3,"file":"icc-time-table-x-api.js","sourceRoot":"","sources":["../../icc-x-api/icc-time-table-x-api.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,4CAA2C;AAG3C,wCAA4C;AAK5C,kDAAiD;AACjD,0EAAgG;AAChG,4EAAwE;AAIxE,wEAAoE;AACpE,IAAO,eAAe,GAAG,mCAAgB,CAAC,eAAe,CAAA;AAKzD,MAAa,gBAAiB,SAAQ,yBAAe;IAGnD,IAAI,OAAO;QACT,OAAO,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,wBAAwB,CAAC,2BAA2B,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC,CAAA;IACpH,CAAC;IAED,YACE,IAAY,EACZ,OAAkC,EACjB,MAAqB,EACrB,YAA8B,EAC9B,cAAuB,EACxC,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;QAVtC,WAAM,GAAN,MAAM,CAAe;QACrB,iBAAY,GAAZ,YAAY,CAAkB;QAC9B,mBAAc,GAAd,cAAc,CAAS;QAX1C,SAAI,GAAQ,IAAI,CAAA;QAoBd,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;QACpB,IAAI,CAAC,YAAY,GAAG,YAAY,CAAA;IAClC,CAAC;IAED;;;;;;;;;;OAUG;IACG,WAAW,CACf,IAAU,EACV,EAAa,EACb,UAGI,EAAE;;;YAEN,MAAM,SAAS,mCACV,CAAC,EAAE,aAAF,EAAE,cAAF,EAAE,GAAI,EAAE,CAAC,KACb,EAAE,EAAE,MAAA,EAAE,aAAF,EAAE,uBAAF,EAAE,CAAE,EAAE,mCAAI,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,UAAU,EAAE,EACjD,OAAO,EAAE,MAAA,EAAE,aAAF,EAAE,uBAAF,EAAE,CAAE,OAAO,mCAAI,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,EAC5C,QAAQ,EAAE,MAAA,EAAE,aAAF,EAAE,uBAAF,EAAE,CAAE,QAAQ,mCAAI,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,EAC9C,WAAW,EAAE,MAAA,EAAE,aAAF,EAAE,uBAAF,EAAE,CAAE,WAAW,mCAAI,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,EAC5G,MAAM,EAAE,MAAA,EAAE,aAAF,EAAE,uBAAF,EAAE,CAAE,MAAM,mCAAI,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EACjE,KAAK,EAAE,MAAA,EAAE,aAAF,EAAE,uBAAF,EAAE,CAAE,KAAK,mCAAI,EAAE,EACtB,IAAI,EAAE,MAAA,EAAE,aAAF,EAAE,uBAAF,EAAE,CAAE,IAAI,mCAAI,EAAE,GACrB,CAAA;YAED,MAAM,gBAAgB,mCACjB,MAAM,CAAC,WAAW,CACnB,CAAC,GAAG,CAAC,MAAA,MAAA,IAAI,CAAC,eAAe,0CAAE,GAAG,mCAAI,EAAE,CAAC,EAAE,GAAG,CAAC,MAAA,MAAA,IAAI,CAAC,eAAe,0CAAE,kBAAkB,mCAAI,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,eAAe,CAAC,KAAK,CAAC,CAAC,CACnI,GACE,CAAC,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,mBAAmB,mCAAI,EAAE,CAAC,CACxC,CAAA;YAED,OAAO,IAAI,MAAM,CAAC,SAAS,CACzB,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI;iBACnB,sCAAsC,CAAC,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,gBAAgB,CAAC;iBACnH,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,aAAa,CAAC,CAChC,CAAA;;KACF;IAED;;OAEG;IACG,cAAc,CAAC,SAA2B;;YAC9C,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC,CAAA;QAClF,CAAC;KAAA;IAED;;;;;;;;;;;OAWG;IACG,SAAS,CACb,UAAkB,EAClB,SAA2B,EAC3B,UAGI,EAAE;;YAEN,OAAO,IAAI,CAAC,aAAa,CAAC,SAAS,EAAE,EAAE,CAAC,UAAU,CAAC,EAAE,OAAO,EAAE,CAAC,CAAA;QACjE,CAAC;KAAA;IAED;;;;;;;;;;OAUG;IACG,aAAa,CACjB,SAA2B,EAC3B,SAKC;;YAED,OAAO,CAAC,MAAM,IAAI,CAAC,gBAAgB,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC,CAAC,oBAAoB,CAAA;QACjF,CAAC;KAAA;IAED;;;;;;;;;;;OAWG;IACG,gBAAgB,CACpB,SAA2B,EAC3B,SAKC;;YAED,8CAA8C;YAC9C,MAAM,uBAAuB,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,+BAA+B,CAAC,SAAS,EAAE,WAAW,CAAC,CAAA;YAC9G,MAAM,aAAa,GAAG,uBAAuB,CAAC,CAAC,CAAC,MAAM,IAAI,CAAC,eAAe,CAAC,uBAAuB,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;YAC/G,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,0CAA0C,CAChE,EAAE,MAAM,EAAE,aAAa,EAAE,IAAI,EAAE,WAAW,EAAE,EAC5C,IAAI,EACJ,MAAM,CAAC,WAAW,CAChB,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,UAAU,EAAE,OAAO,CAAC,EAAE,EAAE,CAAC;gBACvD,UAAU;gBACV;oBACE,oBAAoB,EAAE,OAAO,CAAC,oBAAoB;oBAClD,mBAAmB,EAAE,OAAO,CAAC,kBAAkB;oBAC/C,oBAAoB,EAAE,+CAAsB,CAAC,KAAK;oBAClD,cAAc,EAAE,SAAS;iBAC1B;aACF,CAAC,CACH,EACD,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAClC,CAAA;QACH,CAAC;KAAA;IAED,yBAAyB,CACvB,MAAwB;QAExB,OAAO,IAAI,CAAC,MAAM,CAAC,0BAA0B,CAAC,yBAAyB,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC,CAAA;IACxG,CAAC;IAED,mBAAmB,CAAC,MAAwB;QAC1C,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,WAAW,EAAE,EAAE,SAAS,CAAC,CAAA;IACpF,CAAC;IAED,uCAAuC,CAAC,MAAwB,EAAE,SAAmB;QACnF,OAAO,IAAI,CAAC,MAAM,CAAC,0BAA0B,CAAC,iCAAiC,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,WAAW,EAAE,EAAE,SAAS,CAAC,CAAA;IAC3H,CAAC;CACF;AAjLD,4CAiLC","sourcesContent":["import * as i18n from './rsrc/contact.i18n'\n\nimport * as _ from 'lodash'\nimport { IccTimeTableApi } from '../icc-api'\nimport { User } from '../icc-api/model/User'\nimport { TimeTable } from '../icc-api/model/TimeTable'\nimport { IccCryptoXApi } from './icc-crypto-x-api'\nimport { IccDataOwnerXApi } from './icc-data-owner-x-api'\nimport * as models from '../icc-api/model/models'\nimport { AuthenticationProvider, NoAuthenticationProvider } from './auth/AuthenticationProvider'\nimport { ShareMetadataBehaviour } from './crypto/ShareMetadataBehaviour'\nimport { ShareResult } from './utils/ShareResult'\nimport { EntityShareRequest } from '../icc-api/model/requests/EntityShareRequest'\nimport RequestedPermissionEnum = EntityShareRequest.RequestedPermissionEnum\nimport { SecureDelegation } from '../icc-api/model/SecureDelegation'\nimport AccessLevelEnum = SecureDelegation.AccessLevelEnum\nimport { XHR } from '../icc-api/api/XHR'\nimport { EncryptedEntityXApi } from './basexapi/EncryptedEntityXApi'\nimport { MaintenanceTask } from '../icc-api/model/models'\n\nexport class IccTimeTableXApi extends IccTimeTableApi implements EncryptedEntityXApi<models.TimeTable> {\n  i18n: any = i18n\n\n  get headers(): Promise<Array<XHR.Header>> {\n    return super.headers.then((h) => this.crypto.accessControlKeysHeaders.addAccessControlKeysHeaders(h, 'TimeTable'))\n  }\n\n  constructor(\n    host: string,\n    headers: { [key: string]: string },\n    private readonly crypto: IccCryptoXApi,\n    private readonly dataOwnerApi: IccDataOwnerXApi,\n    private readonly autofillAuthor: boolean,\n    authenticationProvider: AuthenticationProvider = new NoAuthenticationProvider(),\n    fetchImpl: (input: RequestInfo, init?: RequestInit) => Promise<Response> = typeof window !== 'undefined'\n      ? window.fetch\n      : typeof self !== 'undefined'\n      ? self.fetch\n      : fetch\n  ) {\n    super(host, headers, authenticationProvider, fetchImpl)\n    this.crypto = crypto\n    this.dataOwnerApi = dataOwnerApi\n  }\n\n  /**\n   * Creates a new instance of timetable with initialised encryption metadata (not in the database).\n   * @param user the current user.\n   * @param tt initialised data for the timetable. Metadata such as id, creation data, etc. will be automatically initialised, but you can specify\n   * other kinds of data or overwrite generated metadata with this. You can't specify encryption metadata.\n   * @param options optional parameters:\n   * - additionalDelegates: delegates which will have access to the entity in addition to the current data owner and delegates from the\n   * auto-delegations. Must be an object which associates each data owner id with the access level to give to that data owner. May overlap with\n   * auto-delegations, in such case the access level specified here will be used.\n   * @return a new instance of timetable.\n   */\n  async newInstance(\n    user: User,\n    tt: TimeTable,\n    options: {\n      additionalDelegates?: { [dataOwnerId: string]: AccessLevelEnum }\n      preferredSfk?: string\n    } = {}\n  ) {\n    const timeTable: TimeTable = {\n      ...(tt ?? {}),\n      id: tt?.id ?? this.crypto.primitives.randomUuid(),\n      created: tt?.created ?? new Date().getTime(),\n      modified: tt?.modified ?? new Date().getTime(),\n      responsible: tt?.responsible ?? (this.autofillAuthor ? this.dataOwnerApi.getDataOwnerIdOf(user) : undefined),\n      author: tt?.author ?? (this.autofillAuthor ? user.id : undefined),\n      codes: tt?.codes ?? [],\n      tags: tt?.tags ?? [],\n    }\n\n    const extraDelegations = {\n      ...Object.fromEntries(\n        [...(user.autoDelegations?.all ?? []), ...(user.autoDelegations?.administrativeData ?? [])].map((d) => [d, AccessLevelEnum.WRITE])\n      ),\n      ...(options?.additionalDelegates ?? {}),\n    }\n\n    return new models.TimeTable(\n      await this.crypto.xapi\n        .entityWithInitialisedEncryptedMetadata(timeTable, 'TimeTable', undefined, undefined, true, false, extraDelegations)\n        .then((x) => x.updatedEntity)\n    )\n  }\n\n  /**\n   * @return if the logged data owner has write access to the content of the given time table\n   */\n  async hasWriteAccess(timeTable: models.TimeTable): Promise<boolean> {\n    return this.crypto.xapi.hasWriteAccess({ entity: timeTable, type: 'TimeTable' })\n  }\n\n  /**\n   * Share an existing time table with other data owners, allowing them to access the non-encrypted data of the time table and optionally also\n   * the encrypted content, with read-only or read-write permissions.\n   * @param delegateId the id of the data owner which will be granted access to the time table.\n   * @param timeTable the time table to share.\n   * @param options optional parameters to customize the sharing behaviour:\n   * - shareEncryptionKey: specifies if the encryption key of the access log should be shared with the delegate, giving access to all encrypted\n   * content of the entity, excluding other encrypted metadata (defaults to {@link ShareMetadataBehaviour.IF_AVAILABLE}). Note that by default a\n   * time table does not have encrypted content.\n   * - requestedPermissions: the requested permissions for the delegate, defaults to {@link RequestedPermissionEnum.MAX_WRITE}.\n   * @return the updated entity\n   */\n  async shareWith(\n    delegateId: string,\n    timeTable: models.TimeTable,\n    options: {\n      requestedPermissions?: RequestedPermissionEnum\n      shareEncryptionKey?: ShareMetadataBehaviour // Defaults to ShareMetadataBehaviour.IF_AVAILABLE\n    } = {}\n  ): Promise<models.TimeTable> {\n    return this.shareWithMany(timeTable, { [delegateId]: options })\n  }\n\n  /**\n   * Share an existing time table with other data owners, allowing them to access the non-encrypted data of the time table and optionally also\n   * the encrypted content, with read-only or read-write permissions.\n   * @param timeTable the time table to share.\n   * @param delegates associates the id of data owners which will be granted access to the entity, to the following sharing options:\n   * - shareEncryptionKey: specifies if the encryption key of the access log should be shared with the delegate, giving access to all encrypted\n   * content of the entity, excluding other encrypted metadata (defaults to {@link ShareMetadataBehaviour.IF_AVAILABLE}). Note that by default a\n   * time table does not have encrypted content.\n   * - requestedPermissions: the requested permissions for the delegate, defaults to {@link RequestedPermissionEnum.MAX_WRITE}.\n   * @return the updated entity\n   */\n  async shareWithMany(\n    timeTable: models.TimeTable,\n    delegates: {\n      [delegateId: string]: {\n        requestedPermissions?: RequestedPermissionEnum\n        shareEncryptionKey?: ShareMetadataBehaviour // Defaults to ShareMetadataBehaviour.IF_AVAILABLE\n      }\n    }\n  ): Promise<models.TimeTable> {\n    return (await this.tryShareWithMany(timeTable, delegates)).updatedEntityOrThrow\n  }\n\n  /**\n   * Share an existing time table with other data owners, allowing them to access the non-encrypted data of the time table and optionally also\n   * the encrypted content, with read-only or read-write permissions.\n   * @param timeTable the time table to share.\n   * @param delegates associates the id of data owners which will be granted access to the entity, to the following sharing options:\n   * - shareEncryptionKey: specifies if the encryption key of the access log should be shared with the delegate, giving access to all encrypted\n   * content of the entity, excluding other encrypted metadata (defaults to {@link ShareMetadataBehaviour.IF_AVAILABLE}). Note that by default a\n   * time table does not have encrypted content.\n   * - requestedPermissions: the requested permissions for the delegate, defaults to {@link RequestedPermissionEnum.MAX_WRITE}.\n   * @return a promise which will contain the result of the operation: the updated entity if the operation was successful or details of the error if\n   * the operation failed.\n   */\n  async tryShareWithMany(\n    timeTable: models.TimeTable,\n    delegates: {\n      [delegateId: string]: {\n        requestedPermissions?: RequestedPermissionEnum\n        shareEncryptionKey?: ShareMetadataBehaviour // Defaults to ShareMetadataBehaviour.IF_AVAILABLE\n      }\n    }\n  ): Promise<ShareResult<models.TimeTable>> {\n    // All entities should have an encryption key.\n    const entityWithEncryptionKey = await this.crypto.xapi.ensureEncryptionKeysInitialised(timeTable, 'TimeTable')\n    const updatedEntity = entityWithEncryptionKey ? await this.modifyTimeTable(entityWithEncryptionKey) : timeTable\n    return this.crypto.xapi.simpleShareOrUpdateEncryptedEntityMetadata(\n      { entity: updatedEntity, type: 'TimeTable' },\n      true,\n      Object.fromEntries(\n        Object.entries(delegates).map(([delegateId, options]) => [\n          delegateId,\n          {\n            requestedPermissions: options.requestedPermissions,\n            shareEncryptionKeys: options.shareEncryptionKey,\n            shareOwningEntityIds: ShareMetadataBehaviour.NEVER,\n            shareSecretIds: undefined,\n          },\n        ])\n      ),\n      (x) => this.bulkShareTimeTable(x)\n    )\n  }\n\n  getDataOwnersWithAccessTo(\n    entity: models.TimeTable\n  ): Promise<{ permissionsByDataOwnerId: { [p: string]: AccessLevelEnum }; hasUnknownAnonymousDataOwners: boolean }> {\n    return this.crypto.delegationsDeAnonymization.getDataOwnersWithAccessTo({ entity, type: 'TimeTable' })\n  }\n\n  getEncryptionKeysOf(entity: models.TimeTable): Promise<string[]> {\n    return this.crypto.xapi.encryptionKeysOf({ entity, type: 'TimeTable' }, undefined)\n  }\n\n  createDelegationDeAnonymizationMetadata(entity: models.TimeTable, delegates: string[]): Promise<void> {\n    return this.crypto.delegationsDeAnonymization.createOrUpdateDeAnonymizationInfo({ entity, type: 'TimeTable' }, delegates)\n  }\n}\n"]}

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

@@ -0,0 +1,191 @@
+import { IccAuthApi, IccTopicApi } from '../icc-api';
+import { IccCryptoXApi } from './icc-crypto-x-api';
+import * as models from '../icc-api/model/models';
+import { ListOfIds, Topic, TopicRole } from '../icc-api/model/models';
+import { IccDataOwnerXApi } from './icc-data-owner-x-api';
+import { AuthenticationProvider } from './auth/AuthenticationProvider';
+import { SecureDelegation } from '../icc-api/model/SecureDelegation';
+import { ShareMetadataBehaviour } from './crypto/ShareMetadataBehaviour';
+import { ShareResult } from './utils/ShareResult';
+import { EntityShareRequest } from '../icc-api/model/requests/EntityShareRequest';
+import { XHR } from '../icc-api/api/XHR';
+import { EncryptedEntityXApi } from './basexapi/EncryptedEntityXApi';
+import { FilterChainTopic } from '../icc-api/model/FilterChainTopic';
+import { PaginatedListTopic } from '../icc-api/model/PaginatedListTopic';
+import AccessLevelEnum = SecureDelegation.AccessLevelEnum;
+import RequestedPermissionEnum = EntityShareRequest.RequestedPermissionEnum;
+import { SubscriptionOptions } from './utils';
+import { AbstractFilter } from './filters/filters';
+import { Connection } from '../icc-api/model/Connection';
+export declare class IccTopicXApi extends IccTopicApi implements EncryptedEntityXApi<models.Topic> {
+    private readonly crypto;
+    private readonly dataOwnerApi;
+    private readonly authApi;
+    private readonly autofillAuthor;
+    private readonly encryptedFields;
+    constructor(host: string, headers: {
+        [key: string]: string;
+    }, crypto: IccCryptoXApi, dataOwnerApi: IccDataOwnerXApi, authApi: IccAuthApi, autofillAuthor: boolean, authenticationProvider?: AuthenticationProvider, encryptedKeys?: Array<string>, fetchImpl?: (input: RequestInfo, init?: RequestInit) => Promise<Response>);
+    get headers(): Promise<Array<XHR.Header>>;
+    /**
+     * Creates a new instance of topic with initialised encryption metadata (not in the database).
+     * @param user the current user.
+     * @param patient the patient this topic refers to.
+     * @param c initialised data for the topic. Metadata such as id, creation data, etc. will be automatically initialised, but you can specify
+     * other kinds of data or overwrite generated metadata with this. You can't specify encryption metadata.
+     * @param options optional parameters:
+     * - additionalDelegates: delegates which will have access to the entity in addition to the current data owner and delegates from the
+     * auto-delegations. Must be an object which associates each data owner id with the access level to give to that data owner. May overlap with
+     * auto-delegations, in such case the access level specified here will be used.
+     * - preferredSfk: secret id of the patient to use as the secret foreign key to use for the topic. The default value will be a
+     * secret id of patient known by the topmost parent in the current data owner hierarchy.
+     * @return a new instance of topic.
+     */
+    newInstance(user: models.User, patient: models.Patient | null, c?: Topic, // TODO: Why this isn't Topic?
+    options?: {
+        additionalDelegates?: {
+            [dataOwnerId: string]: AccessLevelEnum;
+        };
+        preferredSfk?: string;
+    }): Promise<models.Topic>;
+    decrypt(topics: Array<models.Topic>): Promise<models.Topic[]>;
+    encrypt(topics: Array<models.Topic>): Promise<Array<models.Topic>>;
+    /**
+     * Create and share a new topic with other participants.
+     * @param body the topic to create.
+     * @return the created topic.
+     */
+    createTopic(body: Topic): Promise<Topic>;
+    /**
+     * @param topic a topic
+     * @return the id of the patient that the topic refers to, retrieved from the encrypted metadata. Normally there should only be one element
+     * in the returned array, but in case of entity merges there could be multiple values.
+     */
+    decryptPatientIdOf(topic: models.Topic): Promise<string[]>;
+    /**
+     * @return if the logged data owner has write access to the content of the given topic
+     */
+    hasWriteAccess(topic: models.Topic): Promise<boolean>;
+    /**
+     * Share an existing topic with other data owners, allowing them to access the non-encrypted data of the topic and optionally also
+     * the encrypted content, with read-only or read-write permissions.
+     * @param delegateId the id of the data owner which will be granted access to the topic.
+     * @param topic the topic to share.
+     * @param options optional parameters to customize the sharing behaviour:
+     * - shareEncryptionKey: specifies if the encryption key of the access log should be shared with the delegate, giving access to all encrypted
+     * content of the entity, excluding other encrypted metadata (defaults to {@link ShareMetadataBehaviour.IF_AVAILABLE}).
+     * - sharePatientId: specifies if the id of the patient that this topic refers to should be shared with the delegate (defaults to
+     * {@link ShareMetadataBehaviour.IF_AVAILABLE}).
+     * - requestedPermissions: the requested permissions for the delegate, defaults to {@link RequestedPermissionEnum.MAX_WRITE}.
+     * @return the updated entity
+     */
+    shareWith(delegateId: string, topic: models.Topic, options?: {
+        requestedPermissions?: RequestedPermissionEnum;
+        shareEncryptionKey?: ShareMetadataBehaviour;
+        sharePatientId?: ShareMetadataBehaviour;
+    }): Promise<models.Topic>;
+    /**
+     * Share an existing topic with other data owners, allowing them to access the non-encrypted data of the topic and optionally also
+     * the encrypted content, with read-only or read-write permissions.
+     * @param topic the topic to share.
+     * @param delegates associates the id of data owners which will be granted access to the entity, to the following sharing options:
+     * - shareEncryptionKey: specifies if the encryption key of the access log should be shared with the delegate, giving access to all encrypted
+     * content of the entity, excluding other encrypted metadata (defaults to {@link ShareMetadataBehaviour.IF_AVAILABLE}). Note that by default a
+     * topic does not have encrypted content.
+     * - sharePatientId: specifies if the id of the patient that this topic refers to should be shared with the delegate (defaults to
+     * {@link ShareMetadataBehaviour.IF_AVAILABLE}).
+     * - requestedPermissions: the requested permissions for the delegate, defaults to {@link RequestedPermissionEnum.MAX_WRITE}.
+     * @return the updated entity
+     */
+    shareWithMany(topic: models.Topic, delegates: {
+        [delegateId: string]: {
+            requestedPermissions?: RequestedPermissionEnum;
+            shareEncryptionKey?: ShareMetadataBehaviour;
+            sharePatientId?: ShareMetadataBehaviour;
+        };
+    }): Promise<models.Topic>;
+    /**
+     * Share an existing topic with other data owners, allowing them to access the non-encrypted data of the topic and optionally also
+     * the encrypted content, with read-only or read-write permissions.
+     * @param topic the topic to share.
+     * @param delegates associates the id of data owners which will be granted access to the entity, to the following sharing options:
+     * - shareEncryptionKey: specifies if the encryption key of the access log should be shared with the delegate, giving access to all encrypted
+     * content of the entity, excluding other encrypted metadata (defaults to {@link ShareMetadataBehaviour.IF_AVAILABLE}). Note that by default a
+     * topic does not have encrypted content.
+     * - sharePatientId: specifies if the id of the patient that this topic refers to should be shared with the delegate (defaults to
+     * {@link ShareMetadataBehaviour.IF_AVAILABLE}).
+     * - requestedPermissions: the requested permissions for the delegate, defaults to {@link RequestedPermissionEnum.MAX_WRITE}.
+     * @return a promise which will contain the result of the operation: the updated entity if the operation was successful or details of the error if
+     * the operation failed.
+     */
+    tryShareWithMany(topic: models.Topic, delegates: {
+        [delegateId: string]: {
+            requestedPermissions?: RequestedPermissionEnum;
+            shareEncryptionKey?: ShareMetadataBehaviour;
+            sharePatientId?: ShareMetadataBehaviour;
+        };
+    }): Promise<ShareResult<models.Topic>>;
+    getDataOwnersWithAccessTo(entity: models.Topic): Promise<{
+        permissionsByDataOwnerId: {
+            [p: string]: AccessLevelEnum;
+        };
+        hasUnknownAnonymousDataOwners: boolean;
+    }>;
+    getEncryptionKeysOf(entity: models.Topic): Promise<string[]>;
+    /**
+     * Filter and decrypt topics by the given filter.
+     * @param body the filter to apply.
+     * @param startDocumentId the document id to start from (inclusive).
+     * @param limit the maximum number of topics to return in the page.
+     * @return a paginated list of topics.
+     */
+    filterTopicsBy(body: FilterChainTopic, startDocumentId?: string, limit?: number): Promise<PaginatedListTopic>;
+    /**
+     * Obtain the topic with the given id and decrypt it.
+     * @param id the id of the topic to retrieve.
+     * @return the decrypted topic.
+     */
+    getTopic(id: string): Promise<Topic>;
+    /**
+     * Obtain the topics with the given ids and decrypt them.
+     * @param body the ids of the topics to retrieve.
+     * @return the decrypted topics.
+     */
+    getTopics(body: ListOfIds): Promise<Array<Topic>>;
+    /**
+     * Update and encrypt the given topic.
+     * @param body the topic to update.
+     * @return the updated decrypted topic.
+     */
+    modifyTopic(body: Topic): Promise<Topic>;
+    /**
+     * @internal this method is for internal use only and may be changed without notice
+     * @param body data owner id of the data owner to which the participant should be added and the topic role of the participant.
+     * @param topicId Id of the topic to which the participant should be added.
+     */
+    addParticipant(body: {
+        dataOwnerId: string;
+        topicRole: TopicRole;
+    }, topicId: string): Promise<Topic>;
+    /**
+     * This method is similar to {@link addParticipant} but it also shares the topic with the data owner before adding the participant.
+     * @param body data owner id of the data owner to which the participant should be added and the topic role of the participant.
+     * @param topic the topic to share and to which the participant should be added.
+     * @return the updated topic.
+     */
+    addParticipantWithTopic(body: {
+        dataOwnerId: string;
+        topicRole: TopicRole;
+    }, topic: Topic): Promise<Topic>;
+    /**
+     * Remove the participant with the given data owner id from the topic with the given id.
+     * @param body data owner id of the participant to remove.
+     * @param topicId Id of the topic from which the participant should be removed.
+     * @return the updated decrypted topic.
+     */
+    removeParticipant(body: {
+        dataOwnerId: string;
+    }, topicId: string): Promise<Topic>;
+    subscribeToTopicEvents(eventTypes: ('CREATE' | 'UPDATE' | 'DELETE')[], filter: AbstractFilter<Topic> | undefined, eventFired: (message: Topic) => Promise<void>, options?: SubscriptionOptions): Promise<Connection>;
+    createDelegationDeAnonymizationMetadata(entity: Topic, delegates: string[]): Promise<void>;
+}