oro-sdk 2.1.4-dev1

package/src/models/guard.ts

@@ -0,0 +1,136 @@
+import { Uuid, Base64String, TokenData, RFC3339Date, Url } from './'
+
+export 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 // Whitespace separated list of practice AllTypeRole
+    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
+    //TODO: remove me when https://github.com/OROHealth/oro-guard/pull/72 is merged
+    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/src/models/index.ts

@@ -0,0 +1,9 @@
+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'

package/src/models/practice.ts

@@ -0,0 +1,411 @@
+export enum WorkflowType {
+    Onboard = 'Onboard',
+    Followup = 'Followup',
+    Renew = 'Renew',
+    DataRetrieve = 'DataRetrieve',
+}
+
+export enum RateDimension {
+    RatioOnTotal = 'RatioOnTotal',
+    FixedOnTotal = 'FixedOnTotal',
+    RatioPlatformFee = 'RatioPlatformFee',
+    FixedPlatformFee = 'FixedPlatformFee',
+    RatioOnPlatformFeeTotal = 'RatioOnPlatformFeeTotal',
+    FixedOnPlatformFeeTotal = 'FixedOnPlatformFeeTotal',
+    RatioOnItem = 'RatioOnItem',
+    FixedOnItem = 'FixedOnItem',
+}
+
+export enum PlanType {
+    Onboard = 'Onboard',
+    Followup = 'Followup',
+    Renew = 'Renew',
+    DataRetrieve = 'DataRetrieve',
+}
+
+export enum PaymentStatus {
+    Pending = 'Pending',
+    Success = 'Success',
+    Failure = 'Failure',
+    Canceled = 'Canceled',
+}
+
+export enum PractitionerStatus {
+    Practicing = 'Practicing',
+    Retired = 'Retired',
+    NotInvolvedAnymore = 'NotInvolvedAnymore',
+    Deactivated = 'Deactivated',
+    Flagged = 'Flagged',
+    InConflict = 'InConflict',
+    Delicensed = 'Delicensed',
+}
+
+export enum AssignmentStatus {
+    Assigned = 'Assigned',
+    Reassigned = 'Reassigned',
+    Cancelled = 'Cancelled',
+}
+
+export enum PractitionnerRoleType {
+    Doctor = 'Doctor',
+    MedicalAssistant = 'MedicalAssistant',
+    MedicalSecretary = 'MedicalSecretary',
+    Nurse = 'Nurse',
+    Specialist = 'Specialist',
+    LabAssistant = 'LabAssistant',
+    Administrative = 'Administrative',
+    ManualDispatcher = 'ManualDispatcher',
+    Other = 'Other',
+}
+
+export enum OtherRoleType {
+    Patient = 'Patient',
+    User = 'User',
+    System = 'System',
+}
+
+export type AllRoleType = OtherRoleType | PractitionnerRoleType
+
+export enum LicenseStatus {
+    Valid = 'Valid',
+    Invalid = 'Invalid',
+    Expired = 'Expired',
+    NA = 'NA',
+    Removed = 'Removed',
+}
+
+export enum PeriodType {
+    PerYear = 'PerYear',
+    PerQuarter = 'PerQuarter',
+    PerMonth = 'PerMonth',
+    PerWeek = 'PerWeek',
+    PerBusinessDay = 'PerBusinessDay',
+    PerDay = 'PerDay',
+    PerHour = 'PerHour',
+}
+
+export enum SyncStatus {
+    Requested = 'Requested',
+    Started = 'Started',
+    Succeeded = 'Succeeded',
+    Failed = 'Failed',
+    Cancelled = 'Cancelled',
+}
+
+export enum PracticeEmailKind {
+    SignedUp = 'SignedUp',
+    Onboarded = 'Onboarded',
+    OnboardedPractitioner = 'OnboardedPractitioner',
+    OnboardedPatient = 'OnboardedPatient',
+    Answered = 'Answered',
+    ToAnswer = 'ToAnswer',
+    FollowedUp = 'FollowedUp',
+    Renewed = 'Renewed',
+    DataRetrieved = 'DataRetrieved',
+}
+
+export interface PracticeAccount {
+    id?: number ///optional for insertion
+    uuidPractice: string
+    isoLocality?: string
+    idStripeAccount?: string
+    emailBillingContact: string
+    urlSubdomain?: string
+}
+
+export enum PracticeConfigKind {
+    PractitionerConsultList = 'PractitionerConsultList',
+    PractitionerChatbox = 'PractitionerChatbox',
+    PracticeTheme = 'PracticeTheme',
+    PracticeLocaleSwitcher = 'PracticeLocaleSwitcher',
+    PracticeCookieBanner = 'PracticeCookieBanner',
+}
+
+export interface PracticeConfig<K, T> {
+    uuidPractice: string
+    kind: K // PracticeConfigKind
+    config: T
+}
+
+export type PracticeConfigPractitionerConsultList = PracticeConfig<
+    PracticeConfigKind.PractitionerConsultList,
+    {
+        hideLocality?: boolean
+        hideFax?: boolean
+        hideExpiresAt?: boolean
+    }
+>
+
+export type PracticeConfigPracticeLocaleSwitcher = PracticeConfig<
+    PracticeConfigKind.PracticeLocaleSwitcher,
+    {
+        hideLocaleSwitcher?: boolean
+    }
+>
+
+export type PracticeConfigPractitionerChatbox = PracticeConfig<
+    PracticeConfigKind.PractitionerChatbox,
+    {
+        planAddedMessage?: { [languageISO639_3: string]: string }
+        planUpdatedMessage?: { [languageISO639_3: string]: string }
+    }
+>
+
+export type PracticeConfigPracticeCookieBanner = PracticeConfig<
+    PracticeConfigKind.PracticeCookieBanner,
+    {
+        showCookieBanner?: boolean
+        policyLink?: string
+        useOfCookieLink?: string
+    }
+>
+
+// This type is for demonstration only for now
+export type PracticeConfigPracticeTheme = PracticeConfig<
+    PracticeConfigKind.PracticeTheme,
+    { primaryColor?: string }
+>
+
+export type PracticeConfigs =
+    | PracticeConfigPractitionerConsultList
+    | PracticeConfigPractitionerChatbox
+    | PracticeConfigPracticeLocaleSwitcher
+    | PracticeConfigPracticeCookieBanner
+    | PracticeConfigPracticeTheme // Here for demonstration only
+
+export interface PracticeWorkflow {
+    id?: number ///optional for insertion
+    uuidPractice: string
+    uuidWorkflow: string
+    typeWorkflow: WorkflowType
+    tagSpecialty?: string
+}
+
+export type PracticeWorkflowWithTagSpecialty = PracticeWorkflow & {
+    tagSpecialty: string
+}
+
+export interface PracticePlan {
+    id?: number ///optional for insertion
+    uuidPractice: string
+    isoLocality?: string
+    nameDefault: string
+    descDefault: string
+    hoursExpiration: number
+    active: boolean
+    namePriceCurrency: string // DEPRECATED: left only for in-app receipt display and lower migration risks
+    numPriceAmount: number // DEPRECATED: left only for in-app receipt display and lower migration risks
+    numPriceExtDecimal?: number // DEPRECATED: left only for in-app receipt display and lower migration risks
+    numPriceExtNegativeExponential?: number // DEPRECATED: left only for in-app receipt display and lower migration risks
+    kind: PlanType
+    idStripeProduct: string
+    idStripePrice: string // DEPRECATED: left only for in-app receipt display and lower migration risks
+    dateCreatedAt: Date
+    dateUpdateAt: Date
+    ratePerThousandOverride: number // DEPRECATED: left only to lower migration risks
+}
+
+export enum StripePriceType {
+    Default = 'Default',
+    Discount = 'Discount',
+}
+
+// Subset of Stripe.Price
+export interface PracticePrice {
+    /**
+     * Unique identifier for the object in Stripe.
+     */
+    idStripePrice: string
+    /**
+     * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
+     */
+    currency: string
+    /**
+     * The unit amount in %s to be charged, represented as a whole integer if possible.
+     */
+    unitAmount: number
+}
+
+export interface PracticePlanPrices {
+    idPlan: number
+    default: PracticePrice
+    discount?: PracticePrice
+}
+
+export interface PracticeRate {
+    id?: number
+    uuidPractice: string
+    idPlan: number
+    isoLocality?: string
+    dimension: RateDimension
+    description: string
+    uidTaxRate: string
+    idStripeTaxRate: string
+}
+
+export interface PracticePlatformFee {
+    uuidPractice: string
+    idPlan: number
+    isoLocality?: string
+    numPlatformFinalFee: number
+}
+
+export interface PracticePayment {
+    id?: number ///optional for insertion
+    uuidPractice: string
+    idPlan: number
+    uuidConsult: string
+    hoursConsultExpiration: number
+    idStripeInvoiceOrPaymentIntent: string
+    status: PaymentStatus
+    dateCreatedAt: Date
+    dateUpdateAt: Date
+}
+
+export interface PracticePaymentIntent {
+    id?: number ///optional for insertion
+    uuidPractice: string
+    idPlan: number
+    idPayment: number
+    hoursPlanExpiration: number
+    isoLocality?: string
+    textPaymentMethodOptions: string
+    nameCurrency: string
+    numTotalAmount: number
+    numPlatformFeeAmount: number
+    idStripeInvoice: string
+    idStripePaymtIntent: string
+    stripeClientSecret: string
+    dateCreatedAt?: Date
+    dateUpdateAt?: Date
+}
+
+export interface Assignment {
+    id?: number ///optional for insertion
+    uuidPractice: string
+    uuidAssignor: string //defaulting for insertion to the default practice admin
+    uuidPractitioner?: string
+    status?: AssignmentStatus
+    uuidConsult?: string
+    tagSpecialty?: string
+    timeAssigned?: string //defaulting for insertion
+}
+
+export interface PractitionerRole {
+    id?: number //optional for insertion
+    uuidPractice: string
+    uuidPractitioner: string
+    role: PractitionnerRoleType
+    dateGiven?: Date //default during insertion
+}
+
+export interface PractitionerLicense {
+    id?: number ///optional for insertion
+    uuidPractitioner: string
+    country: string
+    tagSpecialty: string
+    isoLocality: string
+    txtLicenseNumber: string
+    txtComplementary?: string
+    dateProvidedAt?: Date
+    dateObtainedAt?: Date
+    dateRenewedAt?: Date
+    status?: LicenseStatus
+}
+
+export interface PractitionerPreference {
+    id?: number
+    uuidPractitioner: string
+    uuidPractice: string
+    tagSpecialties: string
+    isoLocalityConsult?: string
+    periodQuotaConsult?: PeriodType
+    quantityQuotaConsult?: number
+    tagConsultLanguages?: string
+}
+
+export interface PractitionerQuota {
+    id?: number ///optional for insertion
+    uuidPractitioner: string
+    uuidPractice: string
+    tagSpecialty: string
+    isoLocality: string
+    quantityLeft?: number
+    dateRenewal?: Date
+    dateLastUpdate?: Date
+}
+
+export interface Practitioner {
+    uuid: string
+    uuidPractice: string
+    txtFirstName: string
+    txtLastName: string
+    txtTitle: string
+    emailAddress: string
+    tagsSpecialties: string
+    arrLanguages: string
+    dateAddedAt?: Date //defaulting for insertion
+    status?: PractitionerStatus //defaulting for insertion
+    txtAddressTransmission?: string //the default non-fax address to send prescription to
+}
+
+export interface HydratedPracticeConfigs {
+    [PracticeConfigKind.PractitionerConsultList]?: PracticeConfigPractitionerConsultList
+    [PracticeConfigKind.PractitionerChatbox]?: PracticeConfigPractitionerChatbox
+    [PracticeConfigKind.PracticeTheme]?: PracticeConfigPracticeTheme
+    [PracticeConfigKind.PracticeLocaleSwitcher]?: PracticeConfigPracticeLocaleSwitcher
+    [PracticeConfigKind.PracticeCookieBanner]?: PracticeConfigPracticeCookieBanner
+}
+
+export interface Practice {
+    uuid: string
+    name: string
+    countryOperating: string
+    urlPractice: string
+    urlLinkedPage?: string
+    urlTos?: string
+    urlConfidentiality?: string
+    uuidAdmin: string
+    uuidDefaultAssigned: string
+    uuidDefaultFallback: string
+    prefDefaultLang: string
+    keyGoogleTagNonProd: string
+    keyGoogleTagProd: string
+    txtAddress?: string
+    phoneBusiness?: string
+    urlSupport?: string
+    emailSupport?: string
+    phoneSupport?: string
+    phoneFax?: string
+    txtTaxID?: string
+    txtVATID?: string
+    txtRegistrationID?: string
+    txtLegalInfos?: string
+    txtDefaultTransmissionDriver?: string
+    accounts?: PracticeAccount[]
+    configs?: HydratedPracticeConfigs
+}
+
+export interface Sync {
+    id?: number
+    status?: SyncStatus
+    descriptionStep: string
+    dateStarted?: Date
+    dateFinished?: Date
+}
+
+export interface PracticeEmail {
+    id?: number
+    uuidPractice: string
+    kind: PracticeEmailKind
+    idMailgunTemplate: string
+    isoLanguage: string
+    tags: string
+}
+
+export interface PracticeSubscription {
+    id?: number
+    uuidPractice: string
+    idMailChimpAudience: string
+    isoLanguage: string
+}

package/src/models/shared.ts

@@ -0,0 +1,6 @@
+export type Uuid = string
+export type Url = string
+export type Base64String = string
+export type Metadata = { [val: string]: any }
+export type TokenData = Metadata
+export type RFC3339Date = string

package/src/models/vault.ts

@@ -0,0 +1,158 @@
+import { Uuid, Base64String, Metadata } from './shared'
+import { MetadataCategory } from './workflow'
+
+export interface LockboxCreateResponse {
+    lockboxUuid: Uuid
+}
+
+export interface SharedSecretResponse {
+    sharedSecret: Base64String
+}
+
+export interface LockboxGrantRequest {
+    granteeUuid: Uuid
+    encryptedSecret: Base64String
+}
+
+export interface LockboxDataRequest {
+    publicMetadata?: Metadata
+    privateMetadata?: Base64String
+    data: Base64String
+}
+
+export type LockboxManifest = ManifestEntry[]
+
+export interface ManifestEntry {
+    dataUuid: Uuid
+    metadata: Metadata
+}
+
+export interface GrantedLockboxes {
+    grants: Grant[]
+}
+
+export interface Grant {
+    lockboxOwnerUuid?: Uuid
+    encryptedLockbox?: Base64String
+    lockboxUuid?: Uuid
+}
+
+export interface DataCreateResponse {
+    dataUuid: Uuid
+}
+
+export interface DataResponse {
+    data: Base64String
+}
+
+export interface IndexEntry {
+    uuid?: Uuid
+    uniqueHash?: Base64String
+    timestamp?: Date
+}
+
+export interface IndexConsultLockbox extends IndexEntry {
+    consultationId: Uuid
+    grant: Grant
+}
+
+export interface VaultIndex extends IndexEntry {
+    [IndexKey.ConsultationLockbox]?: IndexConsultLockbox[] // only one should ever exist at a time
+    [IndexKey.Consultation]?: IndexConsultLockbox[] // DEPRECATED REMOVE ME
+}
+
+export interface EncryptedVaultIndex {
+    [IndexKey.Consultation]?: EncryptedIndexEntry[]
+    [IndexKey.ConsultationLockbox]?: EncryptedIndexEntry[]
+    [IndexKey.IndexSnapshot]?: EncryptedIndexEntry[]
+}
+
+export interface EncryptedIndexEntry extends IndexEntry {
+    encryptedIndexEntry: Base64String
+}
+
+export enum IndexKey {
+    Consultation = 'Consultation', //DEPRECATED REMOVE ME
+    IndexSnapshot = 'IndexSnapshot', //DEPRECATED REMOVE ME
+    ConsultationLockbox = 'ConsultationLockbox'
+}
+
+export interface Document extends ManifestEntry {
+    lockboxOwnerUuid?: Uuid
+    lockboxUuid: Uuid
+}
+
+export interface Meta {
+    documentType?: DocumentType
+    category: MetadataCategory
+    contentType?: string
+}
+
+export interface PreferenceMeta extends Meta {
+    category: MetadataCategory.Preference
+    contentType: 'application/json'
+}
+
+export interface RecoveryMeta extends Meta {
+    category: MetadataCategory.Recovery
+    contentType: 'application/json'
+}
+
+export interface RawConsultationMeta extends Meta {
+    category: MetadataCategory.Raw
+    contentType: 'application/json'
+    consultationId?: Uuid
+}
+
+export interface ConsultationMeta extends Meta {
+    documentType: DocumentType
+    category: MetadataCategory.Consultation
+    consultationId?: Uuid
+}
+
+export interface ConsultationImageMeta extends ConsultationMeta {
+    idbId: Uuid
+}
+
+export interface MedicalMeta extends Meta {
+    documentType:
+    | DocumentType.PopulatedWorkflowData
+    | DocumentType.Result
+    | DocumentType.Prescription
+    | DocumentType.DoctorsNote
+    category: MetadataCategory.Medical
+    consultationIds?: Uuid[]
+}
+
+export interface PersonalMeta {
+    documentType: DocumentType.PopulatedWorkflowData | DocumentType.Note
+    category:
+    | MetadataCategory.Personal
+    | MetadataCategory.ChildPersonal
+    | MetadataCategory.OtherPersonal
+    consultationIds?: Uuid[]
+}
+
+export enum DocumentType {
+    Message = 'Message',
+    Note = 'Note',
+    DoctorsNote = 'DoctorsNote',
+    Prescription = 'Prescription',
+    ExamRequest = 'ExamRequest',
+    Result = 'Result',
+    Attachment = 'Attachment',
+    BigFile = 'BigFile',
+    MeetingRequest = 'MeetingRequest',
+    AudioNote = 'AudioNote',
+    VideoNote = 'VideoNote',
+    PopulatedWorkflowData = 'PopulatedWorkflowData',
+    TreatmentPlan = 'TreatmentPlan',
+    ImageAlias = 'ImageAlias',
+}
+
+export interface LocalizedData<T = any> {
+    lockboxOwnerUuid?: string
+    lockboxUuid: string
+    dataUuid: string
+    data: T
+}