@icure/api 8.6.5 → 8.6.6

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,0CAAiH;AAGjH,sEAA2F;AAE3F,0EAAgG;AAChG,oEAAgE;AAMhE,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;IACH,0BAA0B,CAAC,SAA0B;QACnD,OAAO,IAAA,+BAAuB,EAAC,SAAS,CAAC,CAAA;IAC3C,CAAC;IAED;;;;OAIG;IACH,4BAA4B,CAAC,SAA0B;QACrD,OAAO,IAAA,iCAAyB,EAAC,SAAS,CAAC,CAAA;IAC7C,CAAC;IAED;;;OAGG;IACH,kBAAkB,CAAC,SAA0B;QAC3C,OAAO,IAAI,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,0BAA0B,CAAC,SAAS,CAAC,EAAE,GAAG,IAAI,CAAC,4BAA4B,CAAC,SAAS,CAAC,CAAC,CAAC,CAAA;IAClH,CAAC;IAEK,uBAAuB;;YAC3B,OAAO,yCAAuB,CAAC,aAAa,CAAC,MAAM,IAAI,CAAC,mBAAmB,EAAE,CAAC,CAAA;QAChF,CAAC;KAAA;IAED;;;;OAIG;IACG,qBAAqB;;YACzB,IAAI,CAAC,IAAI,CAAC,4BAA4B,EAAE,CAAC;gBACvC,MAAM,IAAI,CAAC,+BAA+B,EAAE,CAAA;YAC9C,CAAC;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,CAAC;gBACvC,MAAM,IAAI,CAAC,6CAA6C,EAAE,CAAA;YAC5D,CAAC;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,CAAC;gBACvC,MAAM,IAAI,CAAC,+BAA+B,EAAE,CAAA;YAC9C,CAAC;YACD,MAAM,GAAG,GAAG,EAAE,CAAA;YACd,KAAK,MAAM,WAAW,IAAI,IAAI,CAAC,4BAA6B,EAAE,CAAC;gBAC7D,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,CAAA;gBACrB,IAAI,WAAW,KAAK,QAAQ;oBAAE,OAAO,GAAG,CAAA;YAC1C,CAAC;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,CAAC;gBACvC,OAAO,MAAM,IAAI,CAAC,6CAA6C,EAAE,CAAA;YACnE,CAAC;;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,CAAC;gBACvC,MAAM,IAAI,CAAC,6CAA6C,EAAE,CAAA;YAC5D,CAAC;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,CAAC;YAC7B,MAAM,KAAK,CAAC,QAAQ,IAAI,CAAC,EAAE,sBAAsB,CAAC,CAAA;QACpD,CAAC;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;;;OAGG;IACH,6BAA6B;QAC3B,IAAI,CAAC,4BAA4B,GAAG,SAAS,CAAA;IAC/C,CAAC;IAEO,uBAAuB,CAAC,SAA0B;QACxD,MAAM,IAAI,GAAG,IAAI,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,0BAA0B,CAAC,SAAS,CAAC,EAAE,GAAG,IAAI,CAAC,4BAA4B,CAAC,SAAS,CAAC,CAAC,CAAC,CAAA;QACtH,IAAI,IAAI,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAA,qBAAa,EAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,IAAI;YAC1E,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,CAAC;gBACpD,IAAI,GAAG,MAAM,IAAI,CAAC,YAAY,CAAE,IAAI,CAAC,SAA6B,CAAC,QAAS,CAAC,CAAA;gBAC7E,GAAG,GAAG,CAAC,IAAI,EAAE,GAAG,GAAG,CAAC,CAAA;YACtB,CAAC;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;AAvLD,4CAuLC","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 { fingerprintV1, fingerprintV2, hexPublicKeysWithSha1Of, hexPublicKeysWithSha256Of } from './crypto/utils'\nimport { IccHcpartyXApi } from './icc-hcparty-x-api'\nimport { XHR } from '../icc-api/api/XHR'\nimport { CryptoActorStub, CryptoActorStubWithType } from '../icc-api/model/CryptoActorStub'\nimport { DataOwnerTypeEnum } from '../icc-api/model/DataOwnerTypeEnum'\nimport { AuthenticationProvider, NoAuthenticationProvider } from './auth/AuthenticationProvider'\nimport { IccDataownerApi } from '../icc-api/api/IccDataownerApi'\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   * Gets the public keys of a data owner to be used for encryption with RSA-OAEP+SHA-1, in hex format.\n   * @param dataOwner a data owner.\n   * @return the public keys for the data owner in hex format.\n   */\n  getHexPublicKeysWithSha1Of(dataOwner: DataOwnerOrStub): Set<string> {\n    return hexPublicKeysWithSha1Of(dataOwner)\n  }\n\n  /**\n   * Gets the public keys of a data owner to be used for encryption with RSA-OAEP+SHA-256, in hex format.\n   * @param dataOwner a data owner.\n   * @return the public keys for the data owner in hex format.\n   */\n  getHexPublicKeysWithSha256Of(dataOwner: DataOwnerOrStub): Set<string> {\n    return hexPublicKeysWithSha256Of(dataOwner)\n  }\n\n  /**\n   * Gets all public keys of a data owner to be used for encryption, in hex format. Note that this may include keys that should be used for different\n   * encryption algorithms.\n   */\n  getHexPublicKeysOf(dataOwner: DataOwnerOrStub): Set<string> {\n    return new Set([...this.getHexPublicKeysWithSha1Of(dataOwner), ...this.getHexPublicKeysWithSha256Of(dataOwner)])\n  }\n\n  async getCurrentDataOwnerStub(): Promise<CryptoActorStubWithType> {\n    return CryptoActorStubWithType.fromDataOwner(await this.getCurrentDataOwner())\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   * 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 = new Set([...this.getHexPublicKeysWithSha1Of(dataOwner), ...this.getHexPublicKeysWithSha256Of(dataOwner)])\n    if (new Set(Array.from(keys).map((x) => fingerprintV2(x))).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"]}
+{"version":3,"file":"icc-data-owner-x-api.js","sourceRoot":"","sources":["../../icc-x-api/icc-data-owner-x-api.ts"],"names":[],"mappings":";;;;;;;;;;;;AAKA,0CAAiH;AAGjH,sEAA2F;AAE3F,0EAAgG;AAChG,oEAAgE;AAMhE;;;GAGG;AACH,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;IACH,0BAA0B,CAAC,SAA0B;QACnD,OAAO,IAAA,+BAAuB,EAAC,SAAS,CAAC,CAAA;IAC3C,CAAC;IAED;;;;OAIG;IACH,4BAA4B,CAAC,SAA0B;QACrD,OAAO,IAAA,iCAAyB,EAAC,SAAS,CAAC,CAAA;IAC7C,CAAC;IAED;;;OAGG;IACH,kBAAkB,CAAC,SAA0B;QAC3C,OAAO,IAAI,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,0BAA0B,CAAC,SAAS,CAAC,EAAE,GAAG,IAAI,CAAC,4BAA4B,CAAC,SAAS,CAAC,CAAC,CAAC,CAAA;IAClH,CAAC;IAED;;;;;OAKG;IACG,uBAAuB;;YAC3B,OAAO,yCAAuB,CAAC,aAAa,CAAC,MAAM,IAAI,CAAC,mBAAmB,EAAE,CAAC,CAAA;QAChF,CAAC;KAAA;IAED;;;;OAIG;IACG,qBAAqB;;YACzB,IAAI,CAAC,IAAI,CAAC,4BAA4B,EAAE,CAAC;gBACvC,MAAM,IAAI,CAAC,+BAA+B,EAAE,CAAA;YAC9C,CAAC;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,CAAC;gBACvC,MAAM,IAAI,CAAC,6CAA6C,EAAE,CAAA;YAC5D,CAAC;YACD,OAAO,CAAC,GAAG,IAAI,CAAC,4BAA6B,CAAC,CAAA;QAChD,CAAC;KAAA;IAED;;;;;OAKG;IACG,mCAAmC,CAAC,QAAgB;;YACxD,IAAI,CAAC,IAAI,CAAC,4BAA4B,EAAE,CAAC;gBACvC,MAAM,IAAI,CAAC,+BAA+B,EAAE,CAAA;YAC9C,CAAC;YACD,MAAM,GAAG,GAAG,EAAE,CAAA;YACd,KAAK,MAAM,WAAW,IAAI,IAAI,CAAC,4BAA6B,EAAE,CAAC;gBAC7D,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,CAAA;gBACrB,IAAI,WAAW,KAAK,QAAQ;oBAAE,OAAO,GAAG,CAAA;YAC1C,CAAC;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,CAAC;gBACvC,OAAO,MAAM,IAAI,CAAC,6CAA6C,EAAE,CAAA;YACnE,CAAC;;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,CAAC;gBACvC,MAAM,IAAI,CAAC,6CAA6C,EAAE,CAAA;YAC5D,CAAC;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,CAAC;YAC7B,MAAM,KAAK,CAAC,QAAQ,IAAI,CAAC,EAAE,sBAAsB,CAAC,CAAA;QACpD,CAAC;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;;;OAGG;IACH,6BAA6B;QAC3B,IAAI,CAAC,4BAA4B,GAAG,SAAS,CAAA;IAC/C,CAAC;IAEO,uBAAuB,CAAC,SAA0B;QACxD,MAAM,IAAI,GAAG,IAAI,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,0BAA0B,CAAC,SAAS,CAAC,EAAE,GAAG,IAAI,CAAC,4BAA4B,CAAC,SAAS,CAAC,CAAC,CAAC,CAAA;QACtH,IAAI,IAAI,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAA,qBAAa,EAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,IAAI;YAC1E,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,CAAC;gBACpD,IAAI,GAAG,MAAM,IAAI,CAAC,YAAY,CAAE,IAAI,CAAC,SAA6B,CAAC,QAAS,CAAC,CAAA;gBAC7E,GAAG,GAAG,CAAC,IAAI,EAAE,GAAG,GAAG,CAAC,CAAA;YACtB,CAAC;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;AA9LD,4CA8LC","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 { fingerprintV1, fingerprintV2, hexPublicKeysWithSha1Of, hexPublicKeysWithSha256Of } from './crypto/utils'\nimport { IccHcpartyXApi } from './icc-hcparty-x-api'\nimport { XHR } from '../icc-api/api/XHR'\nimport { CryptoActorStub, CryptoActorStubWithType } from '../icc-api/model/CryptoActorStub'\nimport { DataOwnerTypeEnum } from '../icc-api/model/DataOwnerTypeEnum'\nimport { AuthenticationProvider, NoAuthenticationProvider } from './auth/AuthenticationProvider'\nimport { IccDataownerApi } from '../icc-api/api/IccDataownerApi'\nimport { DataOwnerWithType } from '../icc-api/model/DataOwnerWithType'\n\nexport type DataOwnerOrStub = DataOwner | CryptoActorStub\nexport type DataOwner = HealthcareParty | Patient | Device\n\n/**\n * Extended API for managing data owners (healthcare parties, patients, and devices).\n * Provides methods to retrieve data owner information, manage hierarchies, and handle cryptographic keys.\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   * Gets the public keys of a data owner to be used for encryption with RSA-OAEP+SHA-1, in hex format.\n   * @param dataOwner a data owner.\n   * @return the public keys for the data owner in hex format.\n   */\n  getHexPublicKeysWithSha1Of(dataOwner: DataOwnerOrStub): Set<string> {\n    return hexPublicKeysWithSha1Of(dataOwner)\n  }\n\n  /**\n   * Gets the public keys of a data owner to be used for encryption with RSA-OAEP+SHA-256, in hex format.\n   * @param dataOwner a data owner.\n   * @return the public keys for the data owner in hex format.\n   */\n  getHexPublicKeysWithSha256Of(dataOwner: DataOwnerOrStub): Set<string> {\n    return hexPublicKeysWithSha256Of(dataOwner)\n  }\n\n  /**\n   * Gets all public keys of a data owner to be used for encryption, in hex format. Note that this may include keys that should be used for different\n   * encryption algorithms.\n   */\n  getHexPublicKeysOf(dataOwner: DataOwnerOrStub): Set<string> {\n    return new Set([...this.getHexPublicKeysWithSha1Of(dataOwner), ...this.getHexPublicKeysWithSha256Of(dataOwner)])\n  }\n\n  /**\n   * Gets the crypto actor stub for the current data owner. This is a lightweight representation containing only\n   * cryptographic information without full data owner details.\n   * @return the crypto actor stub of the current data owner.\n   * @throws if the current user is not a data owner.\n   */\n  async getCurrentDataOwnerStub(): Promise<CryptoActorStubWithType> {\n    return CryptoActorStubWithType.fromDataOwner(await this.getCurrentDataOwner())\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   * @param parentId the id of a parent in the current data owner hierarchy.\n   * @return an array starting at the topmost parent and ending at the provided parent id.\n   * @throws if the provided id is not part of the data owner hierarchy.\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 decrypt 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   * 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 = new Set([...this.getHexPublicKeysWithSha1Of(dataOwner), ...this.getHexPublicKeysWithSha256Of(dataOwner)])\n    if (new Set(Array.from(keys).map((x) => fingerprintV2(x))).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-device-x-api.d.ts

@@ -11,5 +11,13 @@ export declare class IccDeviceXApi extends IccDeviceApi {
     constructor(host: string, headers: {
         [key: string]: string;
     }, authenticationProvider: AuthenticationProvider | undefined, userApi: IccUserXApi, authApi: IccAuthApi, fetchImpl?: (input: RequestInfo, init?: RequestInit) => Promise<Response>);
+    /**
+     * Subscribes to real-time device events using a WebSocket connection.
+     * @param eventTypes the types of events to listen for (e.g. 'CREATE', 'UPDATE', 'DELETE').
+     * @param filter an optional filter to restrict which device events trigger the callback.
+     * @param eventFired the callback function invoked when a matching device event is received.
+     * @param options optional subscription configuration such as connection parameters and retry behaviour.
+     * @return a connection object that can be used to manage the WebSocket subscription lifecycle.
+     */
     subscribeToDeviceEvents(eventTypes: ('CREATE' | 'UPDATE' | 'DELETE')[], filter: AbstractFilter<Device> | undefined, eventFired: (dataSample: Device) => Promise<void>, options?: SubscriptionOptions): Promise<Connection>;
 }

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

@@ -25,6 +25,14 @@ class IccDeviceXApi extends icc_api_1.IccDeviceApi {
         this.userApi = userApi;
         this.authApi = authApi;
     }
+    /**
+     * Subscribes to real-time device events using a WebSocket connection.
+     * @param eventTypes the types of events to listen for (e.g. 'CREATE', 'UPDATE', 'DELETE').
+     * @param filter an optional filter to restrict which device events trigger the callback.
+     * @param eventFired the callback function invoked when a matching device event is received.
+     * @param options optional subscription configuration such as connection parameters and retry behaviour.
+     * @return a connection object that can be used to manage the WebSocket subscription lifecycle.
+     */
     subscribeToDeviceEvents(eventTypes_1, filter_1, eventFired_1) {
         return __awaiter(this, arguments, void 0, function* (eventTypes, filter, eventFired, options = {}) {
             return (0, websocket_1.subscribeToEntityEvents)(this.host, this.authApi, 'Device', eventTypes, filter, eventFired, options).then((rs) => new Connection_1.ConnectionImpl(rs));

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

@@ -1 +1 @@
-{"version":3,"file":"icc-device-x-api.js","sourceRoot":"","sources":["../../icc-x-api/icc-device-x-api.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,wCAAmD;AAEnD,0EAA8F;AAE9F,4DAAsE;AACtE,iDAA8E;AAG9E,qCAAqC;AACrC,MAAa,aAAc,SAAQ,sBAAY;IAI7C,YACE,IAAY,EACZ,OAAkC,EAClC,yBAAiD,IAAI,iDAAwB,EAAE,EAC/E,OAAoB,EACpB,OAAmB,EACnB,YAA2E,OAAO,MAAM,KAAK,WAAW;QACtG,CAAC,CAAC,MAAM,CAAC,KAAK;QACd,CAAC,CAAC,OAAO,IAAI,KAAK,WAAW;YAC3B,CAAC,CAAC,IAAI,CAAC,KAAK;YACZ,CAAC,CAAC,KAAK;QAEX,KAAK,CAAC,IAAI,EAAE,OAAO,EAAE,sBAAsB,EAAE,SAAS,CAAC,CAAA;QAEvD,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;QACtB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;IACxB,CAAC;IAEK,uBAAuB;6DAC3B,UAA8C,EAC9C,MAA0C,EAC1C,UAAiD,EACjD,UAA+B,EAAE;YAEjC,OAAO,IAAA,mCAAuB,EAC5B,IAAI,CAAC,IAAI,EACT,IAAI,CAAC,OAAO,EACZ,QAAQ,EACR,UAAU,EACV,MAAM,EACN,UAAU,EACV,OAAO,CACR,CAAC,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,IAAI,2BAAc,CAAC,EAAE,CAAC,CAAC,CAAA;QACxC,CAAC;KAAA;CACF;AAtCD,sCAsCC","sourcesContent":["import {IccAuthApi, IccDeviceApi} from '../icc-api'\nimport {Device} from '../icc-api/model/Device'\nimport {AuthenticationProvider, NoAuthenticationProvider} from './auth/AuthenticationProvider'\nimport {AbstractFilter} from \"./filters/filters\"\nimport {Connection, ConnectionImpl} from \"../icc-api/model/Connection\"\nimport {subscribeToEntityEvents, SubscriptionOptions} from \"./utils/websocket\"\nimport {IccUserXApi} from \"./icc-user-x-api\"\n\n// noinspection JSUnusedGlobalSymbols\nexport class IccDeviceXApi extends IccDeviceApi {\n  private readonly userApi: IccUserXApi\n  private readonly authApi: IccAuthApi\n\n  constructor(\n    host: string,\n    headers: { [key: string]: string },\n    authenticationProvider: AuthenticationProvider = new NoAuthenticationProvider(),\n    userApi: IccUserXApi,\n    authApi: IccAuthApi,\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    this.userApi = userApi\n    this.authApi = authApi\n  }\n\n  async subscribeToDeviceEvents(\n    eventTypes: ('CREATE' | 'UPDATE' | 'DELETE')[],\n    filter: AbstractFilter<Device> | undefined,\n    eventFired: (dataSample: Device) => Promise<void>,\n    options: SubscriptionOptions = {}\n  ): Promise<Connection> {\n    return subscribeToEntityEvents(\n      this.host,\n      this.authApi,\n      'Device',\n      eventTypes,\n      filter,\n      eventFired,\n      options,\n    ).then((rs) => new ConnectionImpl(rs))\n  }\n}\n"]}
+{"version":3,"file":"icc-device-x-api.js","sourceRoot":"","sources":["../../icc-x-api/icc-device-x-api.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,wCAAmD;AAEnD,0EAA8F;AAE9F,4DAAsE;AACtE,iDAA8E;AAG9E,qCAAqC;AACrC,MAAa,aAAc,SAAQ,sBAAY;IAI7C,YACE,IAAY,EACZ,OAAkC,EAClC,yBAAiD,IAAI,iDAAwB,EAAE,EAC/E,OAAoB,EACpB,OAAmB,EACnB,YAA2E,OAAO,MAAM,KAAK,WAAW;QACtG,CAAC,CAAC,MAAM,CAAC,KAAK;QACd,CAAC,CAAC,OAAO,IAAI,KAAK,WAAW;YAC3B,CAAC,CAAC,IAAI,CAAC,KAAK;YACZ,CAAC,CAAC,KAAK;QAEX,KAAK,CAAC,IAAI,EAAE,OAAO,EAAE,sBAAsB,EAAE,SAAS,CAAC,CAAA;QAEvD,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;QACtB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;IACxB,CAAC;IAED;;;;;;;OAOG;IACG,uBAAuB;6DAC3B,UAA8C,EAC9C,MAA0C,EAC1C,UAAiD,EACjD,UAA+B,EAAE;YAEjC,OAAO,IAAA,mCAAuB,EAC5B,IAAI,CAAC,IAAI,EACT,IAAI,CAAC,OAAO,EACZ,QAAQ,EACR,UAAU,EACV,MAAM,EACN,UAAU,EACV,OAAO,CACR,CAAC,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,IAAI,2BAAc,CAAC,EAAE,CAAC,CAAC,CAAA;QACxC,CAAC;KAAA;CACF;AA9CD,sCA8CC","sourcesContent":["import {IccAuthApi, IccDeviceApi} from '../icc-api'\nimport {Device} from '../icc-api/model/Device'\nimport {AuthenticationProvider, NoAuthenticationProvider} from './auth/AuthenticationProvider'\nimport {AbstractFilter} from \"./filters/filters\"\nimport {Connection, ConnectionImpl} from \"../icc-api/model/Connection\"\nimport {subscribeToEntityEvents, SubscriptionOptions} from \"./utils/websocket\"\nimport {IccUserXApi} from \"./icc-user-x-api\"\n\n// noinspection JSUnusedGlobalSymbols\nexport class IccDeviceXApi extends IccDeviceApi {\n  private readonly userApi: IccUserXApi\n  private readonly authApi: IccAuthApi\n\n  constructor(\n    host: string,\n    headers: { [key: string]: string },\n    authenticationProvider: AuthenticationProvider = new NoAuthenticationProvider(),\n    userApi: IccUserXApi,\n    authApi: IccAuthApi,\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    this.userApi = userApi\n    this.authApi = authApi\n  }\n\n  /**\n   * Subscribes to real-time device events using a WebSocket connection.\n   * @param eventTypes the types of events to listen for (e.g. 'CREATE', 'UPDATE', 'DELETE').\n   * @param filter an optional filter to restrict which device events trigger the callback.\n   * @param eventFired the callback function invoked when a matching device event is received.\n   * @param options optional subscription configuration such as connection parameters and retry behaviour.\n   * @return a connection object that can be used to manage the WebSocket subscription lifecycle.\n   */\n  async subscribeToDeviceEvents(\n    eventTypes: ('CREATE' | 'UPDATE' | 'DELETE')[],\n    filter: AbstractFilter<Device> | undefined,\n    eventFired: (dataSample: Device) => Promise<void>,\n    options: SubscriptionOptions = {}\n  ): Promise<Connection> {\n    return subscribeToEntityEvents(\n      this.host,\n      this.authApi,\n      'Device',\n      eventTypes,\n      filter,\n      eventFired,\n      options,\n    ).then((rs) => new ConnectionImpl(rs))\n  }\n}\n"]}

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

@@ -10,8 +10,34 @@ export declare class IccDoctemplateXApi extends IccDoctemplateApi {
     constructor(host: string, headers: {
         [key: string]: string;
     }, crypto: IccCryptoXApi, authenticationProvider?: AuthenticationProvider, fetchImpl?: (input: RequestInfo, init?: RequestInit) => Promise<Response>);
+    /**
+     * Creates a new instance of document template with initialised metadata (not persisted in the database).
+     * @param user the current user, used to set the owner.
+     * @param template the template content as a string, which will be converted to an ArrayBuffer attachment.
+     * @param c optional initial data to merge into the document template. Metadata such as id, creation date, and guid
+     * will be automatically generated if not provided.
+     * @return a new DocumentTemplate instance with populated metadata fields.
+     */
     newInstance(user: models.User, template: string, c: any): Promise<DocumentTemplate>;
+    /**
+     * @deprecated not implemented. Always rejects with an error.
+     * @param ownerId the id of the owner.
+     * @return always rejects.
+     */
     findAllByOwnerId(ownerId: string): Promise<Array<models.DocumentTemplate>>;
+    /**
+     * Builds the URL for downloading a document template attachment.
+     * @param documentId the id of the document template.
+     * @param attachmentId the id of the attachment.
+     * @return the fully qualified URL to the attachment resource.
+     */
     getAttachmentUrl(documentId: string, attachmentId: string): string;
+    /**
+     * Retrieves the text content of a document template attachment. Decodes binary responses as UTF-8 text, and
+     * returns text/plain, text/html, or text/xml content directly. Returns false for unsupported content types.
+     * @param documentTemplateId the id of the document template.
+     * @param attachmentId the id of the attachment.
+     * @return the attachment text content as a string, or false if the content type is unsupported.
+     */
     getAttachmentText(documentTemplateId: string, attachmentId: string): Promise<any | boolean>;
 }

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

@@ -17,6 +17,14 @@ class IccDoctemplateXApi extends icc_api_1.IccDoctemplateApi {
         this.authenticationProvider = authenticationProvider;
         this.fetchImpl = fetchImpl;
     }
+    /**
+     * Creates a new instance of document template with initialised metadata (not persisted in the database).
+     * @param user the current user, used to set the owner.
+     * @param template the template content as a string, which will be converted to an ArrayBuffer attachment.
+     * @param c optional initial data to merge into the document template. Metadata such as id, creation date, and guid
+     * will be automatically generated if not provided.
+     * @return a new DocumentTemplate instance with populated metadata fields.
+     */
     newInstance(user, template, c) {
         return new Promise((resolve, reject) => {
             var _a, _b, _c, _d, _e, _f, _g, _h, _j;
@@ -31,16 +39,34 @@ class IccDoctemplateXApi extends icc_api_1.IccDoctemplateApi {
             return resolve(documentTemplate);
         });
     }
+    /**
+     * @deprecated not implemented. Always rejects with an error.
+     * @param ownerId the id of the owner.
+     * @return always rejects.
+     */
     // noinspection JSUnusedLocalSymbols
     findAllByOwnerId(ownerId) {
         return new Promise(function (resolve, reject) {
             reject(console.log('findByHCPartyPatientSecretFKeys not implemented in document API!'));
         });
     }
+    /**
+     * Builds the URL for downloading a document template attachment.
+     * @param documentId the id of the document template.
+     * @param attachmentId the id of the attachment.
+     * @return the fully qualified URL to the attachment resource.
+     */
     // noinspection JSUnusedGlobalSymbols
     getAttachmentUrl(documentId, attachmentId) {
         return (this.host + '/doctemplate/{documentId}/attachment/{attachmentId}'.replace('{documentId}', documentId).replace('{attachmentId}', attachmentId));
     }
+    /**
+     * Retrieves the text content of a document template attachment. Decodes binary responses as UTF-8 text, and
+     * returns text/plain, text/html, or text/xml content directly. Returns false for unsupported content types.
+     * @param documentTemplateId the id of the document template.
+     * @param attachmentId the id of the attachment.
+     * @return the attachment text content as a string, or false if the content type is unsupported.
+     */
     getAttachmentText(documentTemplateId, attachmentId) {
         const _body = null;
         const _url = this.host +

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

@@ -1 +1 @@
-{"version":3,"file":"icc-doctemplate-x-api.js","sourceRoot":"","sources":["../../icc-x-api/icc-doctemplate-x-api.ts"],"names":[],"mappings":";;;AAAA,wCAA8C;AAM9C,uDAAgD;AAChD,4CAAwC;AACxC,0EAAgG;AAEhG,qCAAqC;AACrC,MAAa,kBAAmB,SAAQ,2BAAiB;IAKvD,YACE,IAAY,EACZ,OAAkC,EAClC,MAAqB,EACrB,yBAAiD,IAAI,iDAAwB,EAAE,EAC/E,YAA2E,OAAO,MAAM,KAAK,WAAW;QACtG,CAAC,CAAC,MAAM,CAAC,KAAK;QACd,CAAC,CAAC,OAAO,IAAI,KAAK,WAAW;YAC7B,CAAC,CAAC,IAAI,CAAC,KAAK;YACZ,CAAC,CAAC,KAAK;QAET,KAAK,CAAC,IAAI,EAAE,OAAO,EAAE,sBAAsB,EAAE,SAAS,CAAC,CAAA;QACvD,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;QACpB,IAAI,CAAC,sBAAsB,GAAG,sBAAsB,CAAA;QACpD,IAAI,CAAC,SAAS,GAAG,SAAS,CAAA;IAC5B,CAAC;IAED,WAAW,CAAC,IAAiB,EAAE,QAAgB,EAAE,CAAM;QACrD,OAAO,IAAI,OAAO,CAAmB,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;;YACvD,MAAM,gBAAgB,mCACjB,CAAC,CAAC,aAAD,CAAC,cAAD,CAAC,GAAI,EAAE,CAAC,KACZ,KAAK,EAAE,4CAA4C,EACnD,EAAE,EAAE,MAAA,CAAC,aAAD,CAAC,uBAAD,CAAC,CAAE,EAAE,mCAAI,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,UAAU,EAAE,EAChD,KAAK,EAAE,MAAA,CAAC,aAAD,CAAC,uBAAD,CAAC,CAAE,KAAK,mCAAI,IAAI,CAAC,EAAE,EAC1B,OAAO,EAAE,MAAA,CAAC,aAAD,CAAC,uBAAD,CAAC,CAAE,OAAO,mCAAI,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,EAC3C,QAAQ,EAAE,MAAA,CAAC,aAAD,CAAC,uBAAD,CAAC,CAAE,QAAQ,mCAAI,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,EAC7C,IAAI,EAAE,MAAA,CAAC,aAAD,CAAC,uBAAD,CAAC,CAAE,IAAI,mCAAI,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,UAAU,EAAE,EACpD,KAAK,EAAE,MAAA,CAAC,aAAD,CAAC,uBAAD,CAAC,CAAE,KAAK,mCAAI,IAAI,EACvB,SAAS,EAAE,MAAA,CAAC,aAAD,CAAC,uBAAD,CAAC,CAAE,SAAS,mCAAI,IAAI,EAC/B,UAAU,EAAE,MAAA,CAAC,aAAD,CAAC,uBAAD,CAAC,CAAE,UAAU,mCAAI,IAAA,wBAAS,EAAC,QAAQ,CAAC,EAChD,OAAO,EAAE,MAAA,CAAC,aAAD,CAAC,uBAAD,CAAC,CAAE,OAAO,mCAAI,mBAAmB,GAC3C,CAAA;YACD,IAAI,gBAAgB,CAAC,KAAK,IAAI,gBAAgB,CAAC,KAAK,CAAC,IAAI,IAAI,IAAI,EAAE,CAAC;gBAClE,gBAAgB,CAAC,KAAK,CAAC,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,UAAU,EAAE,CAAA;YACnE,CAAC;YAED,2BAA2B;YAE3B,IAAI,QAAQ,EAAE,CAAC;gBACb,kBAAkB;YACpB,CAAC;YAED,OAAO,OAAO,CAAC,gBAAgB,CAAC,CAAA;QAClC,CAAC,CAAC,CAAA;IACJ,CAAC;IAED,oCAAoC;IACpC,gBAAgB,CAAC,OAAe;QAC9B,OAAO,IAAI,OAAO,CAAC,UAAU,OAAO,EAAE,MAAM;YAC1C,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,kEAAkE,CAAC,CAAC,CAAA;QACzF,CAAC,CAAC,CAAA;IACJ,CAAC;IAED,qCAAqC;IACrC,gBAAgB,CAAC,UAAkB,EAAE,YAAoB;QACvD,OAAO,CACL,IAAI,CAAC,IAAI,GAAG,qDAAqD,CAAC,OAAO,CAAC,cAAc,EAAE,UAAU,CAAC,CAAC,OAAO,CAAC,gBAAgB,EAAE,YAAY,CAAC,CAC9I,CAAA;IACH,CAAC;IAED,iBAAiB,CAAC,kBAA0B,EAAE,YAAoB;QAChE,MAAM,KAAK,GAAG,IAAI,CAAA;QAElB,MAAM,IAAI,GACR,IAAI,CAAC,IAAI;YACT,iEAAiE;iBAC9D,OAAO,CAAC,sBAAsB,EAAE,kBAAkB,GAAG,EAAE,CAAC;iBACxD,OAAO,CAAC,gBAAgB,EAAE,YAAY,GAAG,EAAE,CAAC;YAC/C,MAAM;YACN,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,CAAA;QAEtB,OAAO,SAAG,CAAC,WAAW,CAAC,KAAK,EAAE,IAAI,EAAE,IAAI,CAAC,OAAO,EAAE,KAAK,EAAE,IAAI,CAAC,SAAS,EAAE,SAAS,EAAE,IAAI,CAAC,sBAAsB,CAAC,cAAc,EAAE,CAAC;aAC9H,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE;YACZ,IAAI,GAAG,CAAC,WAAW,CAAC,UAAU,CAAC,0BAA0B,CAAC,EAAE,CAAC;gBAC3D,MAAM,GAAG,GAAG,IAAI,WAAW,CAAC,OAAO,CAAC,CAAA;gBACpC,MAAM,GAAG,GAAG,IAAI,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;gBACpC,OAAO,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;YACxB,CAAC;iBAAM,IAAI,GAAG,CAAC,WAAW,CAAC,UAAU,CAAC,YAAY,CAAC,IAAI,GAAG,CAAC,WAAW,CAAC,UAAU,CAAC,WAAW,CAAC,IAAI,GAAG,CAAC,WAAW,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE,CAAC;gBACzI,OAAO,GAAG,CAAC,IAAI,CAAA;YACjB,CAAC;iBAAM,CAAC;gBACN,OAAO,KAAK,CAAA;YACd,CAAC;QACH,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAA;IAC1C,CAAC;CACF;AA1FD,gDA0FC","sourcesContent":["import { IccDoctemplateApi } from '../icc-api'\nimport { IccCryptoXApi } from './icc-crypto-x-api'\n\nimport { extend } from 'lodash'\nimport * as models from '../icc-api/model/models'\nimport { DocumentTemplate } from '../icc-api/model/models'\nimport { string2ua } from './utils/binary-utils'\nimport { XHR } from '../icc-api/api/XHR'\nimport { AuthenticationProvider, NoAuthenticationProvider } from './auth/AuthenticationProvider'\n\n// noinspection JSUnusedGlobalSymbols\nexport class IccDoctemplateXApi extends IccDoctemplateApi {\n  crypto: IccCryptoXApi\n  authenticationProvider: AuthenticationProvider\n  fetchImpl: (input: RequestInfo, init?: RequestInit) => Promise<Response>\n\n  constructor(\n    host: string,\n    headers: { [key: string]: string },\n    crypto: IccCryptoXApi,\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.authenticationProvider = authenticationProvider\n    this.fetchImpl = fetchImpl\n  }\n\n  newInstance(user: models.User, template: string, c: any): Promise<DocumentTemplate> {\n    return new Promise<DocumentTemplate>((resolve, reject) => {\n      const documentTemplate: DocumentTemplate = {\n        ...(c ?? {}),\n        _type: 'org.taktik.icure.entities.DocumentTemplate',\n        id: c?.id ?? this.crypto.primitives.randomUuid(),\n        owner: c?.owner ?? user.id,\n        created: c?.created ?? new Date().getTime(),\n        modified: c?.modified ?? new Date().getTime(),\n        guid: c?.guid ?? this.crypto.primitives.randomUuid(),\n        group: c?.group ?? null,\n        specialty: c?.specialty ?? null,\n        attachment: c?.attachment ?? string2ua(template),\n        mainUti: c?.mainUti ?? 'public.plain-text',\n      }\n      if (documentTemplate.group && documentTemplate.group.guid == null) {\n        documentTemplate.group.guid = this.crypto.primitives.randomUuid()\n      }\n\n      //sauver l doctemplate vide\n\n      if (template) {\n        //save attachement\n      }\n\n      return resolve(documentTemplate)\n    })\n  }\n\n  // noinspection JSUnusedLocalSymbols\n  findAllByOwnerId(ownerId: string): Promise<Array<models.DocumentTemplate>> {\n    return new Promise(function (resolve, reject) {\n      reject(console.log('findByHCPartyPatientSecretFKeys not implemented in document API!'))\n    })\n  }\n\n  // noinspection JSUnusedGlobalSymbols\n  getAttachmentUrl(documentId: string, attachmentId: string) {\n    return (\n      this.host + '/doctemplate/{documentId}/attachment/{attachmentId}'.replace('{documentId}', documentId).replace('{attachmentId}', attachmentId)\n    )\n  }\n\n  getAttachmentText(documentTemplateId: string, attachmentId: string): Promise<any | boolean> {\n    const _body = null\n\n    const _url =\n      this.host +\n      '/doctemplate/{documentTemplateId}/attachmentText/{attachmentId}'\n        .replace('{documentTemplateId}', documentTemplateId + '')\n        .replace('{attachmentId}', attachmentId + '') +\n      '?ts=' +\n      new Date().getTime()\n\n    return XHR.sendCommand('GET', _url, this.headers, _body, this.fetchImpl, undefined, this.authenticationProvider.getAuthService())\n      .then((doc) => {\n        if (doc.contentType.startsWith('application/octet-stream')) {\n          const enc = new TextDecoder('utf-8')\n          const arr = new Uint8Array(doc.body)\n          return enc.decode(arr)\n        } else if (doc.contentType.startsWith('text/plain') || doc.contentType.startsWith('text/html') || doc.contentType.startsWith('text/xml')) {\n          return doc.body\n        } else {\n          return false\n        }\n      })\n      .catch((err) => this.handleError(err))\n  }\n}\n"]}
+{"version":3,"file":"icc-doctemplate-x-api.js","sourceRoot":"","sources":["../../icc-x-api/icc-doctemplate-x-api.ts"],"names":[],"mappings":";;;AAAA,wCAA8C;AAM9C,uDAAgD;AAChD,4CAAwC;AACxC,0EAAgG;AAEhG,qCAAqC;AACrC,MAAa,kBAAmB,SAAQ,2BAAiB;IAKvD,YACE,IAAY,EACZ,OAAkC,EAClC,MAAqB,EACrB,yBAAiD,IAAI,iDAAwB,EAAE,EAC/E,YAA2E,OAAO,MAAM,KAAK,WAAW;QACtG,CAAC,CAAC,MAAM,CAAC,KAAK;QACd,CAAC,CAAC,OAAO,IAAI,KAAK,WAAW;YAC7B,CAAC,CAAC,IAAI,CAAC,KAAK;YACZ,CAAC,CAAC,KAAK;QAET,KAAK,CAAC,IAAI,EAAE,OAAO,EAAE,sBAAsB,EAAE,SAAS,CAAC,CAAA;QACvD,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;QACpB,IAAI,CAAC,sBAAsB,GAAG,sBAAsB,CAAA;QACpD,IAAI,CAAC,SAAS,GAAG,SAAS,CAAA;IAC5B,CAAC;IAED;;;;;;;OAOG;IACH,WAAW,CAAC,IAAiB,EAAE,QAAgB,EAAE,CAAM;QACrD,OAAO,IAAI,OAAO,CAAmB,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;;YACvD,MAAM,gBAAgB,mCACjB,CAAC,CAAC,aAAD,CAAC,cAAD,CAAC,GAAI,EAAE,CAAC,KACZ,KAAK,EAAE,4CAA4C,EACnD,EAAE,EAAE,MAAA,CAAC,aAAD,CAAC,uBAAD,CAAC,CAAE,EAAE,mCAAI,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,UAAU,EAAE,EAChD,KAAK,EAAE,MAAA,CAAC,aAAD,CAAC,uBAAD,CAAC,CAAE,KAAK,mCAAI,IAAI,CAAC,EAAE,EAC1B,OAAO,EAAE,MAAA,CAAC,aAAD,CAAC,uBAAD,CAAC,CAAE,OAAO,mCAAI,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,EAC3C,QAAQ,EAAE,MAAA,CAAC,aAAD,CAAC,uBAAD,CAAC,CAAE,QAAQ,mCAAI,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,EAC7C,IAAI,EAAE,MAAA,CAAC,aAAD,CAAC,uBAAD,CAAC,CAAE,IAAI,mCAAI,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,UAAU,EAAE,EACpD,KAAK,EAAE,MAAA,CAAC,aAAD,CAAC,uBAAD,CAAC,CAAE,KAAK,mCAAI,IAAI,EACvB,SAAS,EAAE,MAAA,CAAC,aAAD,CAAC,uBAAD,CAAC,CAAE,SAAS,mCAAI,IAAI,EAC/B,UAAU,EAAE,MAAA,CAAC,aAAD,CAAC,uBAAD,CAAC,CAAE,UAAU,mCAAI,IAAA,wBAAS,EAAC,QAAQ,CAAC,EAChD,OAAO,EAAE,MAAA,CAAC,aAAD,CAAC,uBAAD,CAAC,CAAE,OAAO,mCAAI,mBAAmB,GAC3C,CAAA;YACD,IAAI,gBAAgB,CAAC,KAAK,IAAI,gBAAgB,CAAC,KAAK,CAAC,IAAI,IAAI,IAAI,EAAE,CAAC;gBAClE,gBAAgB,CAAC,KAAK,CAAC,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,UAAU,EAAE,CAAA;YACnE,CAAC;YAED,2BAA2B;YAE3B,IAAI,QAAQ,EAAE,CAAC;gBACb,kBAAkB;YACpB,CAAC;YAED,OAAO,OAAO,CAAC,gBAAgB,CAAC,CAAA;QAClC,CAAC,CAAC,CAAA;IACJ,CAAC;IAED;;;;OAIG;IACH,oCAAoC;IACpC,gBAAgB,CAAC,OAAe;QAC9B,OAAO,IAAI,OAAO,CAAC,UAAU,OAAO,EAAE,MAAM;YAC1C,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,kEAAkE,CAAC,CAAC,CAAA;QACzF,CAAC,CAAC,CAAA;IACJ,CAAC;IAED;;;;;OAKG;IACH,qCAAqC;IACrC,gBAAgB,CAAC,UAAkB,EAAE,YAAoB;QACvD,OAAO,CACL,IAAI,CAAC,IAAI,GAAG,qDAAqD,CAAC,OAAO,CAAC,cAAc,EAAE,UAAU,CAAC,CAAC,OAAO,CAAC,gBAAgB,EAAE,YAAY,CAAC,CAC9I,CAAA;IACH,CAAC;IAED;;;;;;OAMG;IACH,iBAAiB,CAAC,kBAA0B,EAAE,YAAoB;QAChE,MAAM,KAAK,GAAG,IAAI,CAAA;QAElB,MAAM,IAAI,GACR,IAAI,CAAC,IAAI;YACT,iEAAiE;iBAC9D,OAAO,CAAC,sBAAsB,EAAE,kBAAkB,GAAG,EAAE,CAAC;iBACxD,OAAO,CAAC,gBAAgB,EAAE,YAAY,GAAG,EAAE,CAAC;YAC/C,MAAM;YACN,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,CAAA;QAEtB,OAAO,SAAG,CAAC,WAAW,CAAC,KAAK,EAAE,IAAI,EAAE,IAAI,CAAC,OAAO,EAAE,KAAK,EAAE,IAAI,CAAC,SAAS,EAAE,SAAS,EAAE,IAAI,CAAC,sBAAsB,CAAC,cAAc,EAAE,CAAC;aAC9H,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE;YACZ,IAAI,GAAG,CAAC,WAAW,CAAC,UAAU,CAAC,0BAA0B,CAAC,EAAE,CAAC;gBAC3D,MAAM,GAAG,GAAG,IAAI,WAAW,CAAC,OAAO,CAAC,CAAA;gBACpC,MAAM,GAAG,GAAG,IAAI,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;gBACpC,OAAO,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;YACxB,CAAC;iBAAM,IAAI,GAAG,CAAC,WAAW,CAAC,UAAU,CAAC,YAAY,CAAC,IAAI,GAAG,CAAC,WAAW,CAAC,UAAU,CAAC,WAAW,CAAC,IAAI,GAAG,CAAC,WAAW,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE,CAAC;gBACzI,OAAO,GAAG,CAAC,IAAI,CAAA;YACjB,CAAC;iBAAM,CAAC;gBACN,OAAO,KAAK,CAAA;YACd,CAAC;QACH,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAA;IAC1C,CAAC;CACF;AApHD,gDAoHC","sourcesContent":["import { IccDoctemplateApi } from '../icc-api'\nimport { IccCryptoXApi } from './icc-crypto-x-api'\n\nimport { extend } from 'lodash'\nimport * as models from '../icc-api/model/models'\nimport { DocumentTemplate } from '../icc-api/model/models'\nimport { string2ua } from './utils/binary-utils'\nimport { XHR } from '../icc-api/api/XHR'\nimport { AuthenticationProvider, NoAuthenticationProvider } from './auth/AuthenticationProvider'\n\n// noinspection JSUnusedGlobalSymbols\nexport class IccDoctemplateXApi extends IccDoctemplateApi {\n  crypto: IccCryptoXApi\n  authenticationProvider: AuthenticationProvider\n  fetchImpl: (input: RequestInfo, init?: RequestInit) => Promise<Response>\n\n  constructor(\n    host: string,\n    headers: { [key: string]: string },\n    crypto: IccCryptoXApi,\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.authenticationProvider = authenticationProvider\n    this.fetchImpl = fetchImpl\n  }\n\n  /**\n   * Creates a new instance of document template with initialised metadata (not persisted in the database).\n   * @param user the current user, used to set the owner.\n   * @param template the template content as a string, which will be converted to an ArrayBuffer attachment.\n   * @param c optional initial data to merge into the document template. Metadata such as id, creation date, and guid\n   * will be automatically generated if not provided.\n   * @return a new DocumentTemplate instance with populated metadata fields.\n   */\n  newInstance(user: models.User, template: string, c: any): Promise<DocumentTemplate> {\n    return new Promise<DocumentTemplate>((resolve, reject) => {\n      const documentTemplate: DocumentTemplate = {\n        ...(c ?? {}),\n        _type: 'org.taktik.icure.entities.DocumentTemplate',\n        id: c?.id ?? this.crypto.primitives.randomUuid(),\n        owner: c?.owner ?? user.id,\n        created: c?.created ?? new Date().getTime(),\n        modified: c?.modified ?? new Date().getTime(),\n        guid: c?.guid ?? this.crypto.primitives.randomUuid(),\n        group: c?.group ?? null,\n        specialty: c?.specialty ?? null,\n        attachment: c?.attachment ?? string2ua(template),\n        mainUti: c?.mainUti ?? 'public.plain-text',\n      }\n      if (documentTemplate.group && documentTemplate.group.guid == null) {\n        documentTemplate.group.guid = this.crypto.primitives.randomUuid()\n      }\n\n      //sauver l doctemplate vide\n\n      if (template) {\n        //save attachement\n      }\n\n      return resolve(documentTemplate)\n    })\n  }\n\n  /**\n   * @deprecated not implemented. Always rejects with an error.\n   * @param ownerId the id of the owner.\n   * @return always rejects.\n   */\n  // noinspection JSUnusedLocalSymbols\n  findAllByOwnerId(ownerId: string): Promise<Array<models.DocumentTemplate>> {\n    return new Promise(function (resolve, reject) {\n      reject(console.log('findByHCPartyPatientSecretFKeys not implemented in document API!'))\n    })\n  }\n\n  /**\n   * Builds the URL for downloading a document template attachment.\n   * @param documentId the id of the document template.\n   * @param attachmentId the id of the attachment.\n   * @return the fully qualified URL to the attachment resource.\n   */\n  // noinspection JSUnusedGlobalSymbols\n  getAttachmentUrl(documentId: string, attachmentId: string) {\n    return (\n      this.host + '/doctemplate/{documentId}/attachment/{attachmentId}'.replace('{documentId}', documentId).replace('{attachmentId}', attachmentId)\n    )\n  }\n\n  /**\n   * Retrieves the text content of a document template attachment. Decodes binary responses as UTF-8 text, and\n   * returns text/plain, text/html, or text/xml content directly. Returns false for unsupported content types.\n   * @param documentTemplateId the id of the document template.\n   * @param attachmentId the id of the attachment.\n   * @return the attachment text content as a string, or false if the content type is unsupported.\n   */\n  getAttachmentText(documentTemplateId: string, attachmentId: string): Promise<any | boolean> {\n    const _body = null\n\n    const _url =\n      this.host +\n      '/doctemplate/{documentTemplateId}/attachmentText/{attachmentId}'\n        .replace('{documentTemplateId}', documentTemplateId + '')\n        .replace('{attachmentId}', attachmentId + '') +\n      '?ts=' +\n      new Date().getTime()\n\n    return XHR.sendCommand('GET', _url, this.headers, _body, this.fetchImpl, undefined, this.authenticationProvider.getAuthService())\n      .then((doc) => {\n        if (doc.contentType.startsWith('application/octet-stream')) {\n          const enc = new TextDecoder('utf-8')\n          const arr = new Uint8Array(doc.body)\n          return enc.decode(arr)\n        } else if (doc.contentType.startsWith('text/plain') || doc.contentType.startsWith('text/html') || doc.contentType.startsWith('text/xml')) {\n          return doc.body\n        } else {\n          return false\n        }\n      })\n      .catch((err) => this.handleError(err))\n  }\n}\n"]}

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

@@ -63,14 +63,24 @@ export declare class IccDocumentXApi extends IccDocumentApi implements Encrypted
         alternateRootDelegation?: string;
     }): Promise<models.Document>;
     /**
-     * Same as {@link findByMessage} but it will only return the ids of the contacts. It can also filter the documents where Document.created is between
+     * Same as {@link findByMessage} but it will only return the ids of the documents. It can also filter the documents where Document.created is between
      * startDate and endDate in ascending or descending order by that field. (default: ascending).
      */
     findIdsByMessage(hcpartyId: string, message: models.Message, startDate?: number, endDate?: number, descending?: boolean): Promise<string[]>;
+    /**
+     * Decrypts an array of documents.
+     * @param documents the documents to decrypt.
+     * @return an array of objects containing the document and a flag indicating if it was successfully decrypted.
+     */
     decrypt(documents: Array<models.Document>): Promise<{
         entity: models.Document;
         decrypted: boolean;
     }[]>;
+    /**
+     * Encrypts an array of documents.
+     * @param documents the documents to encrypt.
+     * @return the encrypted documents.
+     */
     encrypt(documents: Array<models.Document>): Promise<Array<models.Document>>;
     getAttachmentAs(documentId: string, attachmentId: string, returnType: "application/octet-stream", enckeys?: string, fileName?: string): Promise<ArrayBuffer>;
     getAttachmentAs(documentId: string, attachmentId: string, returnType: "text/plain", enckeys?: string, fileName?: string): Promise<string>;
@@ -84,7 +94,18 @@ export declare class IccDocumentXApi extends IccDocumentApi implements Encrypted
     getAndTryDecryptMainAttachmentAs(document: models.Document, returnType: "application/json"): Promise<any | undefined>;
     getAndTryDecryptMainAttachmentAs(document: models.Document, returnType: 'application/octet-stream' | 'text/plain' | 'application/json'): Promise<any | undefined>;
     private parserFor;
+    /**
+     * Converts a MIME type and file extension to a UTI (Uniform Type Identifier).
+     * @param mimeType the MIME type.
+     * @param extension the file extension.
+     * @return the corresponding UTI.
+     */
     uti(mimeType: string, extension: string): string;
+    /**
+     * Converts a UTI (Uniform Type Identifier) to a MIME type.
+     * @param uti the UTI.
+     * @return the corresponding MIME type.
+     */
     mimeType(uti: string): string;
     /**
      * Adds an attachment to a document, encrypting it on client side using the encryption keys of the provided document.
@@ -241,16 +262,43 @@ export declare class IccDocumentXApi extends IccDocumentApi implements Encrypted
             shareMessageId?: ShareMetadataBehaviour;
         };
     }): Promise<ShareResult<models.Document>>;
+    /**
+     * Gets the data owners that have access to a document.
+     * @param entity the document.
+     * @return an object containing the permissions by data owner id and a flag indicating if there are unknown anonymous data owners.
+     */
     getDataOwnersWithAccessTo(entity: models.Document): Promise<{
         permissionsByDataOwnerId: {
             [p: string]: AccessLevelEnum;
         };
         hasUnknownAnonymousDataOwners: boolean;
     }>;
+    /**
+     * Gets the encryption keys of a document.
+     * @param entity the document.
+     * @return an array of encryption keys.
+     */
     getEncryptionKeysOf(entity: models.Document): Promise<string[]>;
+    /**
+     * Creates delegation de-anonymization metadata for a document.
+     * @param entity the document.
+     * @param delegates the data owner ids of the delegates.
+     */
     createDelegationDeAnonymizationMetadata(entity: models.Document, delegates: string[]): Promise<void>;
     private decryptPage;
+    /**
+     * Creates a new document.
+     * @param user the user (not used).
+     * @param body the document to create.
+     * @return the created document.
+     */
     createDocumentWithUser(user: models.User | undefined, body: models.Document): Promise<models.Document>;
+    /**
+     * Deletes the main attachment of a document.
+     * @param user the user (not used).
+     * @param documentId the id of the document.
+     * @return the updated document.
+     */
     deleteAttachmentWithUser(user: models.User | undefined, documentId: string): Promise<models.Document>;
     /**
      * @deprecated
@@ -265,14 +313,79 @@ export declare class IccDocumentXApi extends IccDocumentApi implements Encrypted
      */
     findDocumentsByHCPartyPatientForeignKeyWithUser(user: models.User | undefined, hcPartyId: string, secretFKey: string, startKey?: string, startDocumentId?: string, limit?: number): Promise<PaginatedListDocument>;
     findWithoutDelegationWithUser(user: models.User | undefined, limit?: number): Promise<Array<models.Document>>;
+    /**
+     * Gets a document by id.
+     * @param user the user (not used).
+     * @param documentId the id of the document.
+     * @return the document.
+     */
     getDocumentWithUser(user: models.User | undefined, documentId: string): Promise<models.Document>;
+    /**
+     * Gets a document by external UUID.
+     * @param user the user (not used).
+     * @param externalUuid the external UUID of the document.
+     * @return the document.
+     */
     getDocumentByExternalUuidWithUser(user: models.User | undefined, externalUuid: string): Promise<models.Document>;
+    /**
+     * Gets multiple documents by their ids.
+     * @param user the user (not used).
+     * @param body a list of document ids.
+     * @return the documents.
+     */
     getDocumentsWithUser(user: models.User | undefined, body?: ListOfIds): Promise<Array<models.Document>>;
+    /**
+     * Gets all documents with a specific external UUID.
+     * @param user the user (not used).
+     * @param externalUuid the external UUID.
+     * @return the documents.
+     */
     getDocumentsByExternalUuidWithUser(user: models.User | undefined, externalUuid: string): Promise<Array<models.Document>>;
+    /**
+     * Updates a document.
+     * @param user the user (not used).
+     * @param body the document to update.
+     * @return the updated document.
+     */
     modifyDocumentWithUser(user: models.User | undefined, body: models.Document): Promise<models.Document>;
+    /**
+     * Updates multiple documents.
+     * @param user the user (not used).
+     * @param body the documents to update.
+     * @return the updated documents.
+     */
     modifyDocumentsWithUser(user: models.User | undefined, body: Array<models.Document>): Promise<Array<models.Document>>;
+    /**
+     * Sets the main attachment of a document.
+     * @param user the user (not used).
+     * @param documentId the id of the document.
+     * @param documentRev the revision of the document.
+     * @param body the attachment data.
+     * @param utis an array of UTIs for the attachment.
+     * @param dataIsEncrypted whether the data is already encrypted.
+     * @return the updated document.
+     */
     setMainDocumentAttachmentWithUser(user: models.User | undefined, documentId: string, documentRev: string, body: Object, utis?: Array<string>, dataIsEncrypted?: boolean): Promise<models.Document>;
+    /**
+     * Sets a secondary attachment on a document.
+     * @param user the user (not used).
+     * @param documentId the id of the document.
+     * @param key the key for the secondary attachment.
+     * @param rev the revision of the document.
+     * @param attachment the attachment data.
+     * @param utis an array of UTIs for the attachment.
+     * @param dataIsEncrypted whether the data is already encrypted.
+     * @return the updated document.
+     */
     setSecondaryAttachmentWithUser(user: models.User | undefined, documentId: string, key: string, rev: string, attachment: Object, utis?: Array<string>, dataIsEncrypted?: boolean): Promise<models.Document>;
+    /**
+     * Deletes a secondary attachment from a document.
+     * @param user the user (not used).
+     * @param documentId the id of the document.
+     * @param key the key of the secondary attachment.
+     * @param rev the revision of the document.
+     * @return the updated document.
+     */
     deleteSecondaryAttachmentWithUser(user: models.User | undefined, documentId: string, key: string, rev: string): Promise<models.Document>;
     createDocument(body?: models.Document): never;
     deleteAttachment(documentId: string): never;