oro-sdk 2.2.0 → 2.5.0

package/README.md

@@ -4,13 +4,14 @@ ORO SDK package is intended to be run in browser only. It contains everything ne
 
 ## Requirements
 
--   npm 6.14.11
+-   npm >=6.14.13
 
 > Powered by [tsdx](https://github.com/formium/tsdx)
 
 ## Local development
 
 > If you cannot see Jest types try opening this folder in a seperate VSCode window.
+
 ### Set up project
 
 ```bash
@@ -24,49 +25,66 @@ npm start # watch
 npm build # build
 ```
 
-### Linking the SDK locally:
+### Linking and running the app with sdk
 
-Ensure that you are running `node v14.17.0` and `npm v6.14.13`, you can use nvm to quickly install and use different versions of node via the commandline https://github.com/nvm-sh/nvm
-```
-❯ npm -v
-6.14.13
+#### First you need to publish locally the `oro-sdk`
 
-❯ node -v
-v14.17.0
-```
-In **`oro-apis/sdk/js`**:
+Two cases are possible:
 
-Use [npm link](https://docs.npmjs.com/cli/v7/commands/npm-link)
+1. You are updating `oro-apis/sdk/ts`:
 
-```bash
-npm install
-npm run link:watch
-```
+    In **`oro-apis/sdk/ts`**:
+
+    ```bash
+    npm install
+    npm run link:watch
+    ```
+
+2. You are updating `oro-apis/sdk/apis`:
+
+    In **`oro-apis/sdk/apis`**:
+
+    ```bash
+    npm install
+    npm run link:watch
+    ```
+
+    In **`oro-apis/sdk/ts`**:
+
+    ```bash
+    npm install
+    npm uninstall oro-sdk-apis # optional
+    npm run link:watch:apis
+    ```
+
+#### Then you need to link it locally to the app
 
 In **`oro-apps/web`**:
 
 ```bash
-npm uninstall oro-sdk-ts
-npm link oro-sdk-ts
+npm uninstall oro-sdk # optional
+npm run dev:link
 ```
 
-in `/web/src/services/oro-client.ts` set the correct module, at line 15 comment out the module definition and use the already written local definition, don't forget to change PATH_TO_oro-apis to what it is on your machine. When done it should look like this:
+### Publishing package
 
-```js
-const module = await import('PATH_TO_oro-apis/sdk/js/node_modules/oro-toolbox')
-//const module = await import('oro-toolbox')
-```
+1. (Only first time) Locally run `npm login` and use the creds in 1password (tech-team-oro) . This will create ~/.npmrc . You will require a OTP but it's sent on tech@orohealth.me so you should all have it.
+2. Run `docker-compose up --build sdk-publisher`
 
-Do the same for `/web/src/server.ts` uncomment line 94 and update the path to match your machine:
+#### Versioning of `oro-sdk` and `oro-sdk-apis`
 
-```js
-sirv('PATH_TO_oro-apis/sdk/js/node_modules/oro-toolbox', { dev }),
-```
+As `oro-sdk-apis` is a dependency of `oro-sdk`, if you do some changes on `oro-sdk-apis` you will need to update `oro-sdk` and web app as well.
 
-You can then run the app locally:
+The versionning should be the same for `oro-sdk-apis` and `oro-sdk`. In other words, as we are using semantic versioning if we update patch/minor/major version of `oro-sdk-apis` we must update the same on `oro-sdk`.
 
-```bash
-npm run dev
-```
+>Example: 
+>
+>I want to update the minor version of `oro-sdk-apis`: 1.2.5 -> 1.3.0
+>
+>Then I also need to update `package.json` of `oro-sdk` with the dependency `oro-sdk-apis@1.3.0` and I update the minor version of `oro-sdk`: 2.3.2 -> 2.4.0
+
+You then need to publish packages in following order: `oro-sdk-apis`, `oro-sdk`:
+
+Then, you update web app dependencies with `oro-sdk@2.4.0`
 
-> Caveat: There is some caveat using `npm link` please see [doc](https://docs.npmjs.com/cli/v7/commands/npm-link#caveat)
+Done.

package/dist/client.d.ts

@@ -1,6 +1,6 @@
+import { Consult, ConsultRequest, ConsultService, DataCreateResponse, DiagnosisService, Document, DocumentType, Grant, GuardService, IdentityResponse, LocalizedData, LockboxManifest, Meta, Metadata, MetadataCategory, PopulatedWorkflowData, Practice, PracticeService, TellerService, TokenData, TosAndCpAcceptanceRequest, Uuid, VaultIndex, VaultService, WorkflowData, WorkflowService } from 'oro-sdk-apis';
 import * as OroToolbox from 'oro-toolbox';
-import { Consult, ConsultRequest, DataCreateResponse, Document, DocumentType, Grant, IdentityResponse, LocalEncryptedData, LocalizedData, LockboxManifest, Meta, Metadata, MetadataCategory, PopulatedWorkflowData, Practice, RecoveryData, RegisterPatientOutput, TokenData, TosAndCpAcceptanceRequest, UserPreference, Uuid, VaultIndex, WorkflowData } from './models';
-import { ConsultService, DiagnosisService, GuardService, PracticeService, TellerService, VaultService, WorkflowService } from './services';
+import { LocalEncryptedData, RecoveryData, RegisterPatientOutput, UserPreference } from './models';
 export declare class OroClient {
     private toolbox;
     tellerClient: TellerService;
@@ -19,7 +19,7 @@ export declare class OroClient {
     constructor(toolbox: typeof OroToolbox, tellerClient: TellerService, vaultClient: VaultService, guardClient: GuardService, practiceClient: PracticeService, consultClient: ConsultService, workflowClient: WorkflowService, diagnosisClient: DiagnosisService, authenticationCallback?: ((err: Error) => void) | undefined);
     /**
      * clears the vaultIndex and cached metadata grants
-    */
+     */
     cleanIndex(): Promise<void>;
     /**
      * Generates an RSA key pair and password payload (rsa private key encrypted with the password)
@@ -70,7 +70,7 @@ export declare class OroClient {
      * @throws IncompleteAuthentication if rsa is not set
      * @calls authenticationCallback if rsa is not set
      */
-    localDecryptJsonPayload({ encryptedKey, encryptedData, }: LocalEncryptedData): any;
+    localDecryptJsonPayload({ encryptedKey, encryptedData }: LocalEncryptedData): any;
     /**
      * Effectively kills your "session"
      */

package/dist/helpers/client.d.ts

@@ -1,4 +1,4 @@
-import { PopulatedWorkflowData, MetadataCategory, SelectedAnswersData } from '../models';
+import { PopulatedWorkflowData, MetadataCategory, SelectedAnswersData } from 'oro-sdk-apis';
 import { PersonalInformations } from '../models/client';
 /**
  * This function extract PersonalInformations from data input object coming from workflow

package/dist/helpers/patient-registration.d.ts

@@ -1,5 +1,5 @@
+import { ConsultRequest, MetadataCategory, Uuid, WorkflowData } from 'oro-sdk-apis';
 import { OroClient, RegisterPatientOutput } from '..';
-import { ConsultRequest, MetadataCategory, Uuid, WorkflowData } from '../models';
 export declare function registerPatient(patientUuid: Uuid, consultRequest: ConsultRequest, workflow: WorkflowData, oroClient: OroClient, masterKey?: Uuid, recoveryQA?: {
     recoverySecurityQuestions: string[];
     recoverySecurityAnswers: string[];

package/dist/helpers/vault-grants.d.ts

@@ -1,5 +1,5 @@
 import { CryptoRSA } from "oro-toolbox";
-import { EncryptedIndexEntry, Grant } from "..";
+import { EncryptedIndexEntry, Grant } from "oro-sdk-apis";
 /**
  * Decrypts and returns the encrypted grants
  * If something went wrong during decryption, that grant will be removed from the list

package/dist/helpers/workflow.d.ts

@@ -1,4 +1,4 @@
-import { MetadataCategory, PopulatedWorkflowData, SelectedAnswerData, SelectedAnswersData, WorkflowData, WorkflowUploadedImage } from '../models';
+import { MetadataCategory, PopulatedWorkflowData, SelectedAnswerData, SelectedAnswersData, WorkflowData, WorkflowUploadedImage } from 'oro-sdk-apis';
 export declare function filterTriggeredAnsweredWithKind(workflowData: WorkflowData, kind: 'text' | 'date' | 'number' | 'images' | 'images-alias' | 'body-parts' | 'pharmacy-picker'): Promise<SelectedAnswerData[]>;
 /**
  * Filters and Populates the `selectedAnswers` from the workflow by

package/dist/index.d.ts

@@ -2,8 +2,22 @@ import { OroClient } from './client';
 import * as OroToolboxNamespace from 'oro-toolbox';
 export declare type OroToolbox = typeof OroToolboxNamespace;
 export declare let wasmPath: string;
-declare const init: (toolbox: OroToolbox, tellerBaseURL: string, vaultBaseURL: string, guardBaseURL: string, practiceBaseURL: string, consultBaseURL: string, workflowBaseURL: string, diagnosisBaseUrl: string, authenticationCallback?: ((err: Error) => void) | undefined) => OroClient;
+/**
+ * This function helps you to initialize and OroClient instance
+ * @param toolbox the OroToolbox object
+ * @param tellerBaseURL the teller service base URL
+ * @param vaultBaseURL the vault service base URL
+ * @param guardBaseURL the guard service base URL
+ * @param practiceBaseURL the practice service base URL
+ * @param consultBaseURL the consult service base URL
+ * @param workflowBaseURL the workflow service base URL
+ * @param diagnosisBaseURL the diagnosis service base URL
+ * @param authenticationCallback (optional) authenticationCallback the authentification callback
+ * @returns an instance of OroClient
+ */
+declare const init: (toolbox: OroToolbox, tellerBaseURL: string, vaultBaseURL: string, guardBaseURL: string, practiceBaseURL: string, consultBaseURL: string, workflowBaseURL: string, diagnosisBaseURL: string, authenticationCallback?: ((err: Error) => void) | undefined) => OroClient;
 export { OroClient } from './client';
+export * from 'oro-sdk-apis';
 export * from './models';
 export * from './helpers';
 export * from './services';

package/dist/models/client.d.ts

@@ -1,5 +1,5 @@
 import { PlaceData } from '../services/external/clinia';
-import { Uuid } from './shared';
+import { Uuid } from 'oro-sdk-apis';
 export interface PersonalInformations {
     birthday?: string;
     firstname?: string;

package/dist/models/error.d.ts

@@ -6,21 +6,7 @@ export declare class MissingLockbox extends Error {
 }
 export declare class MissingLockboxOwner extends Error {
 }
-export declare class IndexBuildError extends Error {
-}
 export declare class AssociatedLockboxNotFound extends Error {
 }
 export declare class WorkflowAnswersMissingError extends Error {
 }
-export declare class AuthenticationFailed extends Error {
-}
-export declare class AuthenticationBadRequest extends Error {
-}
-export declare class AuthenticationServerError extends Error {
-}
-export declare class IdentityCreationFailed extends Error {
-}
-export declare class IdentityCreationBadRequest extends Error {
-}
-export declare class IdentityCreationConflict extends Error {
-}

package/dist/models/index.d.ts

@@ -1,9 +1,2 @@
 export * from './client';
-export * from './consult';
-export * from './diagnosis';
 export * from './error';
-export * from './guard';
-export * from './practice';
-export * from './shared';
-export * from './vault';
-export * from './workflow';