@icure/api 5.0.7 → 5.0.9

package/README.md

@@ -1,75 +0,0 @@
-# Crypto model in iCure
-
-## Lexic
-
-- `"ABCD"` is a **non** encrypted key (uuid, ...)
-- `{AB}` is the encryption key of the pair `AB`, where hcParty `A` gives delegation to hcParty `B`.
-  The encryption key is stored encrypted in the hcPartyKeys of hcParty `A` document (see below)
-- `<ABCD>_{AB}` is the key `ABCD` encrypted with encryption key `{AB}`
-- `<{AB}>_{A}` is the encryption key `{AB}` encrypted with the public key of hcParty `A`
-
-The encryption keys are stored in the hcParty document that gives delegation to other user, since only the user can modify his hcParty document in CouchDB.
-The hcParty `B` needs to access the hcParty `A` document to decrypt (with his private key) the encryption key `{AB}` stored in the field hcPartyKeys.
-
-```
-## HCP A ##
-hcPartyKeys: {
-   A: [ <{AA}>_{A}, <{AA}>_{A} ]
-   B: [ <{AB}>_{A}, <{AB}>_{B} ]
-}
-```
-
-## Document type relations
-
-```
-## Patient 1234 ##
-ID: "1234"
-Delegations: { A->A: <ABCD>_{AA}, A->B: <ABCD>_{AB} }
-EncryptionKeys: { A->A: <DCBA>_{AA}, A->B: <DCBA>_{AB} }
-```
-
-```
-## Contact 4567 ##
-ID: "4567"
-SecretForeignKeys: [ "ABCD" ]
-CryptedForeignKeys: { A->A: <1234>_{AA}, A->B: <1234>_{AB} }
-EncryptionKeys: { A->A: <EFGH>_{AA}, A->B: <EFGH>_{AB} }
-```
-
-The **delegations** of the **patient** document store the encrypted secretForeignKeys that you find in clear in the **contact** document. And allows, once decrypted, to find the contacts of a patient.
-
-On the other side, the **cryptedForeignKeys** of the **contact** document allows, once decrypted, to find the corresponding **patient** document.
-
-The **encryptionKeys** of a document are used to encrypt the content of the corresponding document. As for the delegations, the document encryption keys are stored encrypted with the encryption keys `{AA}`, `{AB}`, ...
-
-The **healthElement** documents are linked to patient documents in the same way as the contact. This means that the healthElement documents have also **SecretForeignKeys** and **CryptedForeignKeys**, beside the **encryptionKeys**.
-
-## Delegations
-
-- Delegations === encrypted foreign key of all patient icureStoredDocument => it makes the link from a patient to a storedDocument
-- CryptedForeignKeys === encrypted patient.ID => it makes the link from a storedDocument to a patient
-- EncryptionKeys === encrypted encryptionKey (probably symmetric)
-
-## Multi profession
-
-Contacts and delegations need to be segmented.
-=> need to have segmented auto-delegations
-
-# Usage
-
-## Instalation
-
-Install from npm
-
-```
-npm install --save icc-api
-```
-
-## ES6 import
-
-Example
-ES6 include
-
-```javaScript
-import * as IccApi from 'icc-api'
-```

package/apidocs/.swagger-codegen-ignore

@@ -1,23 +0,0 @@
-# Swagger Codegen Ignore
-# Generated by swagger-codegen https://github.com/swagger-api/swagger-codegen
-
-# Use this file to prevent files from being overwritten by the generator.
-# The patterns follow closely to .gitignore or .dockerignore.
-
-# As an example, the C# client generator defines ApiClient.cs.
-# You can make changes and tell Swagger Codgen to ignore just this file by uncommenting the following line:
-#ApiClient.cs
-
-# You can match any string of characters against a directory, file or extension with a single asterisk (*):
-#foo/*/qux
-# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
-
-# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
-#foo/**/qux
-# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
-
-# You can also negate patterns with an exclamation (!).
-# For example, you can ignore all files in a docs folder with the file extension .md:
-#docs/*.md
-# Then explicitly reverse the ignore rule for a single file:
-#!docs/README.md

package/ci/cloudbuild.yaml

@@ -1,16 +0,0 @@
-steps:
-  - name: 'gcr.io/cloud-builders/git'
-    entrypoint: 'bash'
-    args:
-      ['-c', 'git fetch --unshallow --tags && git checkout ${BRANCH_NAME} && git describe --tags --abbrev=10 --dirty --always --long > .gitversion']
-
-  - name: 'gcr.io/cloud-builders/docker'
-    args: ['login', 'docker.taktik.be', '--username', '${_REPO_USERNAME}', '--password', '${_REPO_PASSWORD}']
-
-  - name: 'docker'
-    entrypoint: 'sh'
-    args: ['-c', 'v=$(cat .gitversion) && tag="docker.taktik.be/lutaplanning:$v" && docker build . -t $tag && docker push $tag']
-
-options:
-  machineType: 'N1_HIGHCPU_8'
-timeout: 1800s

package/dist/package.json

@@ -1,22 +0,0 @@
-{
-  "name": "@icure/api",
-  "version": "5.0.7",
-  "description": "Typescript version of iCure standalone API client",
-  "main": "index.js",
-  "types": "index.d.ts",
-  "dependencies": {
-    "date-fns": "^2.23.0",
-    "libphonenumber-js": "^1.7.18",
-    "lodash": "^4.17.21",
-    "moment": "^2.22.1",
-    "text-encoding": "^0.7.0",
-    "uuid": "^8.3.2",
-    "uuid-encoder": "^1.1.0"
-  },
-  "author": "Taktik sa - B12 Consulting",
-  "license": "MIT",
-  "bugs": {
-    "url": "https://github.com/taktik/icc-api/issues"
-  },
-  "homepage": "https://github.com/taktik/icc-api#readme"
-}

package/icc-api/.swagger-codegen/VERSION

@@ -1 +0,0 @@
-1.4.3

package/icc-api/.swagger-codegen-ignore

@@ -1,23 +0,0 @@
-# Swagger Codegen Ignore
-# Generated by swagger-codegen https://github.com/swagger-api/swagger-codegen
-
-# Use this file to prevent files from being overwritten by the generator.
-# The patterns follow closely to .gitignore or .dockerignore.
-
-# As an example, the C# client generator defines ApiClient.cs.
-# You can make changes and tell Swagger Codgen to ignore just this file by uncommenting the following line:
-#ApiClient.cs
-
-# You can match any string of characters against a directory, file or extension with a single asterisk (*):
-#foo/*/qux
-# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
-
-# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
-#foo/**/qux
-# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
-
-# You can also negate patterns with an exclamation (!).
-# For example, you can ignore all files in a docs folder with the file extension .md:
-#docs/*.md
-# Then explicitly reverse the ignore rule for a single file:
-#!docs/README.md

package/icc-api/LICENSE

@@ -1,201 +0,0 @@
-                                 Apache License
-                           Version 2.0, January 2004
-                        http://www.apache.org/licenses/
-
-   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
-
-   1. Definitions.
-
-      "License" shall mean the terms and conditions for use, reproduction,
-      and distribution as defined by Sections 1 through 9 of this document.
-
-      "Licensor" shall mean the copyright owner or entity authorized by
-      the copyright owner that is granting the License.
-
-      "Legal Entity" shall mean the union of the acting entity and all
-      other entities that control, are controlled by, or are under common
-      control with that entity. For the purposes of this definition,
-      "control" means (i) the power, direct or indirect, to cause the
-      direction or management of such entity, whether by contract or
-      otherwise, or (ii) ownership of fifty percent (50%) or more of the
-      outstanding shares, or (iii) beneficial ownership of such entity.
-
-      "You" (or "Your") shall mean an individual or Legal Entity
-      exercising permissions granted by this License.
-
-      "Source" form shall mean the preferred form for making modifications,
-      including but not limited to software source code, documentation
-      source, and configuration files.
-
-      "Object" form shall mean any form resulting from mechanical
-      transformation or translation of a Source form, including but
-      not limited to compiled object code, generated documentation,
-      and conversions to other media types.
-
-      "Work" shall mean the work of authorship, whether in Source or
-      Object form, made available under the License, as indicated by a
-      copyright notice that is included in or attached to the work
-      (an example is provided in the Appendix below).
-
-      "Derivative Works" shall mean any work, whether in Source or Object
-      form, that is based on (or derived from) the Work and for which the
-      editorial revisions, annotations, elaborations, or other modifications
-      represent, as a whole, an original work of authorship. For the purposes
-      of this License, Derivative Works shall not include works that remain
-      separable from, or merely link (or bind by name) to the interfaces of,
-      the Work and Derivative Works thereof.
-
-      "Contribution" shall mean any work of authorship, including
-      the original version of the Work and any modifications or additions
-      to that Work or Derivative Works thereof, that is intentionally
-      submitted to Licensor for inclusion in the Work by the copyright owner
-      or by an individual or Legal Entity authorized to submit on behalf of
-      the copyright owner. For the purposes of this definition, "submitted"
-      means any form of electronic, verbal, or written communication sent
-      to the Licensor or its representatives, including but not limited to
-      communication on electronic mailing lists, source code control systems,
-      and issue tracking systems that are managed by, or on behalf of, the
-      Licensor for the purpose of discussing and improving the Work, but
-      excluding communication that is conspicuously marked or otherwise
-      designated in writing by the copyright owner as "Not a Contribution."
-
-      "Contributor" shall mean Licensor and any individual or Legal Entity
-      on behalf of whom a Contribution has been received by Licensor and
-      subsequently incorporated within the Work.
-
-   2. Grant of Copyright License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      copyright license to reproduce, prepare Derivative Works of,
-      publicly display, publicly perform, sublicense, and distribute the
-      Work and such Derivative Works in Source or Object form.
-
-   3. Grant of Patent License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      (except as stated in this section) patent license to make, have made,
-      use, offer to sell, sell, import, and otherwise transfer the Work,
-      where such license applies only to those patent claims licensable
-      by such Contributor that are necessarily infringed by their
-      Contribution(s) alone or by combination of their Contribution(s)
-      with the Work to which such Contribution(s) was submitted. If You
-      institute patent litigation against any entity (including a
-      cross-claim or counterclaim in a lawsuit) alleging that the Work
-      or a Contribution incorporated within the Work constitutes direct
-      or contributory patent infringement, then any patent licenses
-      granted to You under this License for that Work shall terminate
-      as of the date such litigation is filed.
-
-   4. Redistribution. You may reproduce and distribute copies of the
-      Work or Derivative Works thereof in any medium, with or without
-      modifications, and in Source or Object form, provided that You
-      meet the following conditions:
-
-      (a) You must give any other recipients of the Work or
-          Derivative Works a copy of this License; and
-
-      (b) You must cause any modified files to carry prominent notices
-          stating that You changed the files; and
-
-      (c) You must retain, in the Source form of any Derivative Works
-          that You distribute, all copyright, patent, trademark, and
-          attribution notices from the Source form of the Work,
-          excluding those notices that do not pertain to any part of
-          the Derivative Works; and
-
-      (d) If the Work includes a "NOTICE" text file as part of its
-          distribution, then any Derivative Works that You distribute must
-          include a readable copy of the attribution notices contained
-          within such NOTICE file, excluding those notices that do not
-          pertain to any part of the Derivative Works, in at least one
-          of the following places: within a NOTICE text file distributed
-          as part of the Derivative Works; within the Source form or
-          documentation, if provided along with the Derivative Works; or,
-          within a display generated by the Derivative Works, if and
-          wherever such third-party notices normally appear. The contents
-          of the NOTICE file are for informational purposes only and
-          do not modify the License. You may add Your own attribution
-          notices within Derivative Works that You distribute, alongside
-          or as an addendum to the NOTICE text from the Work, provided
-          that such additional attribution notices cannot be construed
-          as modifying the License.
-
-      You may add Your own copyright statement to Your modifications and
-      may provide additional or different license terms and conditions
-      for use, reproduction, or distribution of Your modifications, or
-      for any such Derivative Works as a whole, provided Your use,
-      reproduction, and distribution of the Work otherwise complies with
-      the conditions stated in this License.
-
-   5. Submission of Contributions. Unless You explicitly state otherwise,
-      any Contribution intentionally submitted for inclusion in the Work
-      by You to the Licensor shall be under the terms and conditions of
-      this License, without any additional terms or conditions.
-      Notwithstanding the above, nothing herein shall supersede or modify
-      the terms of any separate license agreement you may have executed
-      with Licensor regarding such Contributions.
-
-   6. Trademarks. This License does not grant permission to use the trade
-      names, trademarks, service marks, or product names of the Licensor,
-      except as required for reasonable and customary use in describing the
-      origin of the Work and reproducing the content of the NOTICE file.
-
-   7. Disclaimer of Warranty. Unless required by applicable law or
-      agreed to in writing, Licensor provides the Work (and each
-      Contributor provides its Contributions) on an "AS IS" BASIS,
-      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-      implied, including, without limitation, any warranties or conditions
-      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
-      PARTICULAR PURPOSE. You are solely responsible for determining the
-      appropriateness of using or redistributing the Work and assume any
-      risks associated with Your exercise of permissions under this License.
-
-   8. Limitation of Liability. In no event and under no legal theory,
-      whether in tort (including negligence), contract, or otherwise,
-      unless required by applicable law (such as deliberate and grossly
-      negligent acts) or agreed to in writing, shall any Contributor be
-      liable to You for damages, including any direct, indirect, special,
-      incidental, or consequential damages of any character arising as a
-      result of this License or out of the use or inability to use the
-      Work (including but not limited to damages for loss of goodwill,
-      work stoppage, computer failure or malfunction, or any and all
-      other commercial damages or losses), even if such Contributor
-      has been advised of the possibility of such damages.
-
-   9. Accepting Warranty or Additional Liability. While redistributing
-      the Work or Derivative Works thereof, You may choose to offer,
-      and charge a fee for, acceptance of support, warranty, indemnity,
-      or other liability obligations and/or rights consistent with this
-      License. However, in accepting such obligations, You may act only
-      on Your own behalf and on Your sole responsibility, not on behalf
-      of any other Contributor, and only if You agree to indemnify,
-      defend, and hold each Contributor harmless for any liability
-      incurred by, or claims asserted against, such Contributor by reason
-      of your accepting any such warranty or additional liability.
-
-   END OF TERMS AND CONDITIONS
-
-   APPENDIX: How to apply the Apache License to your work.
-
-      To apply the Apache License to your work, attach the following
-      boilerplate notice, with the fields enclosed by brackets "{}"
-      replaced with your own identifying information. (Don't include
-      the brackets!)  The text should be enclosed in the appropriate
-      comment syntax for the file format. We also recommend that a
-      file or class name and description of purpose be included on the
-      same "printed page" as the copyright notice for easier
-      identification within third-party archives.
-
-   Copyright {yyyy} {name of copyright owner}
-
-   Licensed under the Apache License, Version 2.0 (the "License");
-   you may not use this file except in compliance with the License.
-   You may obtain a copy of the License at
-
-       http://www.apache.org/licenses/LICENSE-2.0
-
-   Unless required by applicable law or agreed to in writing, software
-   distributed under the License is distributed on an "AS IS" BASIS,
-   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-   See the License for the specific language governing permissions and
-   limitations under the License.

package/icc-api/api/IccAccesslogApi.ts

@@ -1,198 +0,0 @@
-/**
- * iCure Data Stack API Documentation
- * The iCure Data Stack Application API is the native interface to iCure. This version is obsolete, please use v2.
- *
- * OpenAPI spec version: v1
- *
- *
- * NOTE: This class is auto generated by the swagger code generator program.
- * https://github.com/swagger-api/swagger-codegen.git
- * Do not edit the class manually.
- */
-import { XHR } from './XHR'
-import { AccessLog } from '../model/AccessLog'
-import { DocIdentifier } from '../model/DocIdentifier'
-import { PaginatedListAccessLog } from '../model/PaginatedListAccessLog'
-
-export class IccAccesslogApi {
-  host: string
-  headers: Array<XHR.Header>
-  fetchImpl?: (input: RequestInfo, init?: RequestInit) => Promise<Response>
-
-  constructor(host: string, headers: any, fetchImpl?: (input: RequestInfo, init?: RequestInit) => Promise<Response>) {
-    this.host = host
-    this.headers = Object.keys(headers).map((k) => new XHR.Header(k, headers[k]))
-    this.fetchImpl = fetchImpl
-  }
-
-  setHeaders(h: Array<XHR.Header>) {
-    this.headers = h
-  }
-
-  handleError(e: XHR.XHRError): never {
-    throw e
-  }
-
-  /**
-   *
-   * @summary Create an access log
-   * @param body
-   */
-  createAccessLog(body?: AccessLog): Promise<AccessLog> {
-    let _body = null
-    _body = body
-
-    const _url = this.host + `/accesslog` + '?ts=' + new Date().getTime()
-    let headers = this.headers
-    headers = headers.filter((h) => h.header !== 'Content-Type').concat(new XHR.Header('Content-Type', 'application/json'))
-    return XHR.sendCommand('POST', _url, headers, _body, this.fetchImpl)
-      .then((doc) => new AccessLog(doc.body as JSON))
-      .catch((err) => this.handleError(err))
-  }
-
-  /**
-   *
-   * @summary Delete access logs by batch
-   * @param accessLogIds
-   */
-  deleteAccessLog(accessLogIds: string): Promise<Array<DocIdentifier>> {
-    let _body = null
-
-    const _url = this.host + `/accesslog/${encodeURIComponent(String(accessLogIds))}` + '?ts=' + new Date().getTime()
-    let headers = this.headers
-    return XHR.sendCommand('DELETE', _url, headers, _body, this.fetchImpl)
-      .then((doc) => (doc.body as Array<JSON>).map((it) => new DocIdentifier(it)))
-      .catch((err) => this.handleError(err))
-  }
-
-  /**
-   *
-   * @summary List access logs found by Healthcare Party and secret foreign keyelementIds.
-   * @param hcPartyId
-   * @param secretFKeys
-   */
-  findAccessLogsByHCPartyPatientForeignKeys(hcPartyId: string, secretFKeys: string): Promise<Array<AccessLog>> {
-    let _body = null
-
-    const _url =
-      this.host +
-      `/accesslog/byHcPartySecretForeignKeys` +
-      '?ts=' +
-      new Date().getTime() +
-      (hcPartyId ? '&hcPartyId=' + encodeURIComponent(String(hcPartyId)) : '') +
-      (secretFKeys ? '&secretFKeys=' + encodeURIComponent(String(secretFKeys)) : '')
-    let headers = this.headers
-    return XHR.sendCommand('GET', _url, headers, _body, this.fetchImpl)
-      .then((doc) => (doc.body as Array<JSON>).map((it) => new AccessLog(it)))
-      .catch((err) => this.handleError(err))
-  }
-
-  /**
-   *
-   * @summary Get paginated list of Access Logs
-   * @param userId A User ID
-   * @param accessType The type of access (COMPUTER or USER)
-   * @param startDate The start search epoch
-   * @param startKey The start key for pagination
-   * @param startDocumentId A patient document ID
-   * @param limit Number of rows
-   * @param descending Descending order
-   */
-  findByUserAfterDate(
-    userId: string,
-    accessType?: string,
-    startDate?: number,
-    startKey?: string,
-    startDocumentId?: string,
-    limit?: number,
-    descending?: boolean
-  ): Promise<PaginatedListAccessLog> {
-    let _body = null
-
-    const _url =
-      this.host +
-      `/accesslog/byUser` +
-      '?ts=' +
-      new Date().getTime() +
-      (userId ? '&userId=' + encodeURIComponent(String(userId)) : '') +
-      (accessType ? '&accessType=' + encodeURIComponent(String(accessType)) : '') +
-      (startDate ? '&startDate=' + encodeURIComponent(String(startDate)) : '') +
-      (startKey ? '&startKey=' + encodeURIComponent(String(startKey)) : '') +
-      (startDocumentId ? '&startDocumentId=' + encodeURIComponent(String(startDocumentId)) : '') +
-      (limit ? '&limit=' + encodeURIComponent(String(limit)) : '') +
-      (descending ? '&descending=' + encodeURIComponent(String(descending)) : '')
-    let headers = this.headers
-    return XHR.sendCommand('GET', _url, headers, _body, this.fetchImpl)
-      .then((doc) => new PaginatedListAccessLog(doc.body as JSON))
-      .catch((err) => this.handleError(err))
-  }
-
-  /**
-   *
-   * @summary Get an access log
-   * @param accessLogId
-   */
-  getAccessLog(accessLogId: string): Promise<AccessLog> {
-    let _body = null
-
-    const _url = this.host + `/accesslog/${encodeURIComponent(String(accessLogId))}` + '?ts=' + new Date().getTime()
-    let headers = this.headers
-    return XHR.sendCommand('GET', _url, headers, _body, this.fetchImpl)
-      .then((doc) => new AccessLog(doc.body as JSON))
-      .catch((err) => this.handleError(err))
-  }
-
-  /**
-   *
-   * @summary Get paginated list of Access Logs
-   * @param fromEpoch
-   * @param toEpoch
-   * @param startKey
-   * @param startDocumentId
-   * @param limit
-   * @param descending
-   */
-  listAccessLogs(
-    fromEpoch?: number,
-    toEpoch?: number,
-    startKey?: number,
-    startDocumentId?: string,
-    limit?: number,
-    descending?: boolean
-  ): Promise<PaginatedListAccessLog> {
-    let _body = null
-
-    const _url =
-      this.host +
-      `/accesslog` +
-      '?ts=' +
-      new Date().getTime() +
-      (fromEpoch ? '&fromEpoch=' + encodeURIComponent(String(fromEpoch)) : '') +
-      (toEpoch ? '&toEpoch=' + encodeURIComponent(String(toEpoch)) : '') +
-      (startKey ? '&startKey=' + encodeURIComponent(String(startKey)) : '') +
-      (startDocumentId ? '&startDocumentId=' + encodeURIComponent(String(startDocumentId)) : '') +
-      (limit ? '&limit=' + encodeURIComponent(String(limit)) : '') +
-      (descending ? '&descending=' + encodeURIComponent(String(descending)) : '')
-    let headers = this.headers
-    return XHR.sendCommand('GET', _url, headers, _body, this.fetchImpl)
-      .then((doc) => new PaginatedListAccessLog(doc.body as JSON))
-      .catch((err) => this.handleError(err))
-  }
-
-  /**
-   *
-   * @summary Modifies an access log
-   * @param body
-   */
-  modifyAccessLog(body?: AccessLog): Promise<AccessLog> {
-    let _body = null
-    _body = body
-
-    const _url = this.host + `/accesslog` + '?ts=' + new Date().getTime()
-    let headers = this.headers
-    headers = headers.filter((h) => h.header !== 'Content-Type').concat(new XHR.Header('Content-Type', 'application/json'))
-    return XHR.sendCommand('PUT', _url, headers, _body, this.fetchImpl)
-      .then((doc) => new AccessLog(doc.body as JSON))
-      .catch((err) => this.handleError(err))
-  }
-}