oro-sdk-apis 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 ORO Health Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,35 @@
+# oro-sdk-apis
+
+ORO SDK apis package is intended to be run in browser or Node.js environment. It contains all models and apis services.
+
+## Requirements
+
+-   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
+npm install
+```
+
+Then, it's possible to either build/watch component by using
+
+```bash
+npm start # watch
+npm build # build
+```
+
+### Linking the apis locally:
+
+If you need to link `oro-sdk-apis` to app please see https://github.com/OROHealth/oro-apis/blob/main/sdk/ts/README.md#linking-the-sdk-locally
+
+In all cases (node.js or app), you need to use:
+```bash
+    npm install
+    npm run link:watch
+```

package/dist/index.d.ts

@@ -0,0 +1,27 @@
+import { TellerService, VaultService, GuardService, PracticeService, ConsultService, WorkflowService, DiagnosisService } from './services';
+/**
+ * This function is used to initialize services with a provided url
+ * @param services an object containing the url of the services to init
+ * @param (optional) authenticationCallback the authentification callback
+ * @returns an instance of each services with a provided url
+ */
+declare const init: (services: {
+    tellerBaseURL?: string;
+    vaultBaseURL?: string;
+    guardBaseURL?: string;
+    practiceBaseURL?: string;
+    consultBaseURL?: string;
+    workflowBaseURL?: string;
+    diagnosisBaseURL?: string;
+}, authenticationCallback?: ((err: Error) => void) | undefined) => {
+    tellerService: TellerService | undefined;
+    practiceService: PracticeService | undefined;
+    consultService: ConsultService | undefined;
+    vaultService: VaultService | undefined;
+    guardService: GuardService | undefined;
+    workflowService: WorkflowService | undefined;
+    diagnosisService: DiagnosisService | undefined;
+};
+export * from './models';
+export * from './services';
+export default init;

package/dist/index.js

@@ -0,0 +1,8 @@
+
+'use strict'
+
+if (process.env.NODE_ENV === 'production') {
+  module.exports = require('./oro-sdk-apis.cjs.production.min.js')
+} else {
+  module.exports = require('./oro-sdk-apis.cjs.development.js')
+}

package/dist/models/consult.d.ts

@@ -0,0 +1,102 @@
+export declare enum AssistantType {
+    MedicalSecretary = "MedicalSecretary",
+    Nurse = "Nurse",
+    Specialist = "Specialist",
+    Administrative = "Administrative",
+    Other = "Other"
+}
+export interface ConsultAssignedAssistant {
+    id?: number;
+    uuidConsult: string;
+    uuidAssistant: string;
+    type: AssistantType;
+    tagSpecialty?: string;
+    duuidCurrentTaskDescription?: string;
+}
+export declare enum TransmissionKind {
+    Fax = "Fax",
+    Email = "Email",
+    SMS = "SMS",
+    EncryptedEmail = "EncryptedEmail",
+    Logs = "Logs",
+    API = "API",
+    Other = "Other"
+}
+export declare enum TransmissionStatus {
+    Preparing = "Preparing",
+    Sending = "Sending",
+    Sent = "Sent",
+    Retrying = "Retrying",
+    Failed = "Failed",
+    DriverError = "DriverError",
+    TimedOut = "TimedOut",
+    ReceiverNotExist = "ReceiverNotExist",
+    ReceiverNotAnswering = "ReceiverNotAnswering",
+    ReceiverIncompatible = "ReceiverIncompatible"
+}
+export interface ConsultTransmission {
+    id: number;
+    uuidConsult: string;
+    kind: TransmissionKind;
+    status: TransmissionStatus;
+    nameDriverReceiver: string;
+    addressReceiver: string;
+    idDriverForTransmission: string;
+    txtLastDriverMessage: string;
+    numTry: number;
+    numTryLeft: number;
+    delay: number;
+    tsFirstTry: string;
+    tsLastStatusUpdate: string;
+    keyWebhookSecret: string;
+}
+export declare enum FeeStatus {
+    NoFee = "NoFee",
+    Pending = "Pending",
+    Paid = "Paid",
+    Reimbursed = "Reimbursed",
+    Cancelled = "Cancelled",
+    Contested = "Contested"
+}
+export declare enum MedicalStatus {
+    Creating = "Creating",
+    New = "New",
+    ToAnswer = "ToAnswer",
+    Answered = "Answered",
+    Closed = "Closed",
+    Reopened = "Reopened",
+    Archived = "Archived"
+}
+export declare enum TaskStatus {
+    None = "None",
+    ToDo = "ToDo",
+    InProgress = "InProgress",
+    Blocked = "Blocked",
+    Done = "Done"
+}
+export interface ConsultRequest {
+    uuidPractice: string;
+    tagSpecialtyRequired: string;
+    idStripeInvoiceOrPaymentIntent: string;
+    isoLocalityRequired?: string;
+    isoLanguageRequired: string;
+}
+export interface Consult {
+    uuid: string;
+    uuidPracticeAdmin: string;
+    uuidPractice: string;
+    tagSpecialtyRequired: string;
+    isoLanguageRequired: string;
+    idPracticePayment: number;
+    statusFee?: FeeStatus;
+    isoLocalityRequired: string;
+    statusMedical?: MedicalStatus;
+    uuidAssignedDoctor: string;
+    uuidCurrentAssigned: string;
+    statusTask?: TaskStatus;
+    hasTransmissions?: boolean;
+    assignedAssistant?: ConsultAssignedAssistant[];
+    shortId?: string;
+    createdAt?: string;
+    expiresAt?: string;
+}

package/dist/models/diagnosis.d.ts

@@ -0,0 +1,122 @@
+export declare enum DiagnosisType {
+    Generic = "Generic",
+    Private = "Private",
+    Instance = "Instance"
+}
+export interface DiagnosisRequest {
+    uuid?: string;
+    name: string;
+    description: string;
+    type: DiagnosisType;
+    parentUuid?: string;
+    language: string;
+    tags?: string[];
+    urlMultimedia?: string;
+}
+export interface Diagnosis extends DiagnosisRequest {
+    uuid: string;
+    uuidPractice: string;
+    uuidPractitioner?: string;
+    createdAt: string;
+}
+export interface TreatmentRequest {
+    uuid?: string;
+    uuidDiagnosis?: string;
+    name: string;
+    description: string;
+    urlMultimedia?: string;
+}
+export interface Treatment extends TreatmentRequest {
+    uuid: string;
+    uuidDiagnosis: string;
+    createdAt: string;
+}
+export declare enum DrugType {
+    Generic = "Generic",
+    Instance = "Instance"
+}
+export interface DrugRequest {
+    name: string;
+    description: string;
+    type: DrugType;
+    language: string;
+    sideEffects: string;
+    imageUrl?: string;
+    parentUuid?: string;
+    uuid?: string;
+}
+export interface Drug extends DrugRequest {
+    uuid: string;
+    uuidPractice: string;
+    uuidPractitioner?: string;
+    createdAt: string;
+}
+export interface PrescriptionRequest {
+    uuid?: string;
+    uuidTreatment?: string;
+    uuidDrug?: string;
+    quantity: string;
+    sig: string;
+    renewal: string;
+}
+export interface Prescription extends PrescriptionRequest {
+    uuid: string;
+    uuidTreatment: string;
+    createdAt: string;
+}
+export declare enum PlanStatus {
+    Pending = "Pending",
+    Accepted = "Accepted",
+    Rejected = "Rejected"
+}
+export interface TreatmentPlan {
+    uuid: string;
+    uuidConsult: string;
+    uuidDiagnosis: string;
+    uuidTreatment?: string;
+    status: PlanStatus;
+}
+export interface DrugPrescription {
+    prescription: Prescription;
+    drug: Drug;
+}
+export interface TreatmentAndDrugPrescription {
+    treatment?: Treatment;
+    prescriptionsAndDrugs?: DrugPrescription[];
+    status: PlanStatus;
+    uuidTreatmentPlan: string;
+}
+export interface TreatmentPlans {
+    uuidConsult: string;
+    diagnosis: Diagnosis;
+    plans?: TreatmentAndDrugPrescription[];
+}
+export interface DrugPrescriptionRequest {
+    prescription: PrescriptionRequest;
+    drug: DrugRequest;
+}
+export interface TreatmentAndDrugPrescriptionRequest {
+    trackingId: string;
+    treatment: TreatmentRequest;
+    prescriptionsAndDrugs?: DrugPrescriptionRequest[];
+}
+export interface TreatmentPlansRequest {
+    uuidConsult: string;
+    diagnosis: DiagnosisRequest;
+    plans?: TreatmentAndDrugPrescriptionRequest[];
+}
+export interface TreatmentAndDrugPrescriptionUpdateRequest {
+    treatment: Treatment;
+    prescriptionsAndDrugs?: DrugPrescriptionRequest[];
+}
+export interface TreatmentPlanUpdateRequest extends TreatmentPlansRequest {
+    uuidConsult: string;
+    diagnosis: DiagnosisRequest;
+    plan: TreatmentAndDrugPrescriptionUpdateRequest;
+}
+export interface TreatmentPlansResponseEntry {
+    trackingId?: string;
+    treatmentPlan: TreatmentPlan;
+}
+export interface TreatmentPlansResponse extends Array<TreatmentPlansResponseEntry> {
+}

package/dist/models/error.d.ts

@@ -0,0 +1,12 @@
+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/guard.d.ts

@@ -0,0 +1,119 @@
+import { Uuid, Base64String, TokenData, RFC3339Date, Url } from './';
+export declare type AuthRefreshFunc = (refreshToken?: string) => Promise<AuthTokenResponse>;
+export interface Tokens {
+    accessToken?: string;
+    refreshToken?: string;
+}
+export interface AuthTokenRequest {
+    practiceUuid: string;
+    email: string;
+    password: Base64String;
+    otp?: string;
+}
+export interface AuthTokenResponse {
+    accessToken: string;
+    tokenType: string;
+    refreshToken: string;
+    expiresIn: number;
+}
+export interface AuthRecoverRequest {
+    practiceUuid: string;
+    email: string;
+}
+export interface WhoAmIResponse {
+    aud: string;
+    exp: number;
+    jti: string;
+    iat: number;
+    iss: string;
+    nbf: number;
+    sub: string;
+    scope: string;
+    email: string;
+    practice: string;
+}
+export interface IdentityCreateRequest {
+    practiceUuid: Uuid;
+    email: string;
+    password: Base64String;
+    publicKey: Base64String;
+    recoveryPassword: Base64String;
+    tosAndCpAcceptance: TosAndCpAcceptanceRequest;
+    tokenData?: TokenData;
+    subscription?: boolean;
+}
+export interface TosAndCpAcceptanceRequest {
+    tosVersion: string;
+    cpVersion: string;
+}
+export interface IdentityResponse {
+    id: Uuid;
+    practiceUuid?: Uuid;
+    email?: string;
+    emailConfirmed: boolean;
+    tokenData?: TokenData;
+    mfaEnabled?: boolean;
+    mfaSecret?: Base64String;
+    publicKey: Base64String;
+    recoveryLogin?: Uuid;
+    recoveryPassword: Base64String;
+    recoveryMasterKey: Base64String;
+    recoverySecurityQuestions: SecretShard[];
+    legal?: LegalData;
+    createdAt?: string;
+    updatedAt?: string;
+    refreshToken?: string;
+}
+export interface IdentityUpdateRequest {
+    emailConfirmed?: boolean;
+    password?: PasswordUpdateRequest;
+    mfaEnable?: MFAEnableRequest;
+    recoveryPassword?: Base64String;
+    recoveryMasterKey?: Base64String;
+    recoverySecurityQuestions?: SecretShard[];
+    tokenData?: TokenData;
+    epAcceptance?: EpAcceptanceRequest;
+    rpAcceptance?: RpAcceptanceRequest;
+}
+export interface EpAcceptanceRequest {
+    epVersion: string;
+}
+export interface RpAcceptanceRequest {
+    rpVersion: string;
+}
+export interface PasswordUpdateRequest {
+    oldPassword?: Base64String;
+    newPassword: Base64String;
+}
+export interface QRCodeRequest {
+    password: Base64String;
+}
+export interface QRCodeResponse {
+    url: string;
+    qrContentType: string;
+    qrBytes: Base64String;
+}
+export interface MFAEnableRequest {
+    password: Base64String;
+    otp: string;
+}
+export interface SecretShard {
+    securityQuestion: string;
+    securityAnswer?: string;
+    nonce: Base64String;
+    encryptedShare: Base64String;
+}
+export interface LegalData {
+    tosAcceptedAtTime?: RFC3339Date;
+    tosAcceptedVersion: Url;
+    tosAcceptedAtIP?: string;
+    cpAcceptedAtTime?: RFC3339Date;
+    cpAcceptedVersion: Url;
+    cpAcceptedAtIP?: string;
+    epAcceptedAtTime?: RFC3339Date;
+    epAcceptedVersion: Url;
+    epAcceptedAtIP?: string;
+    rpAcceptedAtTime?: RFC3339Date;
+    rpAcceptedVersion: Url;
+    rpAcceptedAtIP?: string;
+}

package/dist/models/index.d.ts

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