oro-sdk-apis 1.9.0 → 1.11.1-dev1

package/dist/services/guard.d.ts

@@ -97,4 +97,18 @@ export declare class GuardService {
      * @return void
      */
     identitySendConfirmEmail(req: IdentityResendConfirmEmailRequest): Promise<void>;
+    /**
+     *  Get an identity using a customer email (format: customer+[b64Hash]@orohealth.me)
+     *
+     * @param email the customer email
+     * @returns IdentityResponse
+     */
+    identityGetByCustomerEmail(email: string): Promise<IdentityResponse>;
+    /**
+     * Get an identity using a base64 hash
+     *
+     * @param b64Hash base64 hash of the identity
+     * @returns IdentityResponse
+     */
+    identityGetByHash(b64Hash: string): Promise<IdentityResponse>;
 }

package/dist/services/practice.d.ts

@@ -1,4 +1,4 @@
-import { PracticeAccount, Uuid } from '../models';
+import { ConsultRequestMetadata, PracticeAccount, Uuid } from '../models';
 import { Assignment, PlanType, Practice, PracticeConfigKind, PracticeConfigs, PracticeInvoice, PracticePayment, PracticePaymentIntent, PracticePlan, PracticePlanPrices, PracticeWorkflow, PracticeWorkflowWithTagSpecialty, Practitioner, PractitionerLicense, PractitionerPreference, PractitionerQuota, PractitionerRole, WorkflowType } from '../models/practice';
 import { APIService } from './api';
 export declare class PracticeService {
@@ -62,7 +62,18 @@ export declare class PracticeService {
      * @returns a hashed email
      */
     getPaymentIntentHashedEmail(email: string): string;
-    practiceCreatePaymentsIntent(practiceUuid: Uuid, planId: number, userEmail: string, isoLocality?: string, url_subdomain?: string, promotionCode?: string): Promise<PracticePaymentIntent>;
+    /**
+     * Creates a PracticePaymentIntent
+     * @param practiceUuid the uuid of the practice
+     * @param planId the plan id to use
+     * @param userEmail the email address of the user
+     * @param isoLocality (optional) the desired locality
+     * @param url_subdomain  (optional) the url of the sub domain (@bruno-morel need you to document that)
+     * @param promotionCode (optional) promotion code to apply
+     * @param consultRequest (optional) consult request to use. If defined, when payment service call our hooks in practice, it will try to create a consult with these infos.
+     * @returns
+     */
+    practiceCreatePaymentsIntent(practiceUuid: Uuid, planId: number, userEmail: string, isoLocality?: string, url_subdomain?: string, promotionCode?: string, consultRequest?: ConsultRequestMetadata): Promise<PracticePaymentIntent>;
     practiceGetPaymentsIntent(practiceUuid: Uuid, paymentIntentId: number): Promise<PracticePaymentIntent>;
     practiceUpdatePaymentsIntent(practiceUuid: string, idPraticePaymentIntent: number, practicePaymentIntent: PracticePaymentIntent, userEmail: string, promotionCode?: string): Promise<PracticePaymentIntent>;
     /**

package/package.json

@@ -1,5 +1,5 @@
 {
-    "version": "1.9.0",
+    "version": "1.11.1-dev1",
     "main": "dist/index.js",
     "typings": "dist/index.d.ts",
     "files": [
@@ -19,12 +19,8 @@
         "prepare": "tsdx build",
         "size": "size-limit",
         "analyze": "size-limit --why",
-        "package": "tsdx build && npm publish"
-    },
-    "husky": {
-        "hooks": {
-            "pre-commit": "tsdx lint"
-        }
+        "package": "tsdx build && npm publish",
+        "pretty": "prettier --config ../../.prettierrc.yaml --write './src/**/*.{ts,js,json,md}' && prettier --write './*.md'"
     },
     "name": "oro-sdk-apis",
     "author": "Antoine Jaouën <antoine@orohealth.me>",
@@ -45,8 +41,7 @@
         "@types/jest": "^27.4.1",
         "@types/sha.js": "^2.4.0",
         "@types/uuid": "^8.3.0",
-        "husky": "^6.0.0",
-        "prettier": "^2.5.1",
+        "prettier": "^2.6.1",
         "prettier-plugin-svelte": "^2.3.0",
         "size-limit": "^4.10.2",
         "tsdx": "^0.14.1",

package/src/models/external/clinia.ts

@@ -0,0 +1,75 @@
+
+export type FacetFilter = 'type:PHARMACY' | 'type:CLINIC' | 'type:PHARMACY_VIRTUAL'
+
+export interface CliniaResponse<T> {
+    facets: any
+    meta: {
+        query: string
+        page: number
+        numPages: number
+        perPage: number
+        total: number
+    }
+    records: T[]
+}
+
+export interface PlaceData {
+    id: string // The Clinia Id of the resource.
+    documentType: string // Type of document. This will always be set to health_facility.
+    type: string // The type of the resource. Possible Place types are detailed here.
+    name: string // The name of the resource.
+    address: AddressData // The address of the resource.
+    geoPoint: GeoPointData // The coordinates of the resource. Useful to locate resource on a map.
+    distance: number // The distance (in meters) the is from the location used to filter the query.
+    onlineBookingUrl: string // The url for the online booking system of the resource.
+    openingHours: Map<string, Array<IntervalData>> // The opening hours of the resource. This object has integers from 1 to 7 as keys, representing days of the week from Monday to Sunday as per ISO 8601.
+    phones: Array<PhoneData> // Phones associated with this resource.
+    socials: Array<SocialData> // The social links of the resource. Can be a website or a social media link.
+    note: string // Special notes on the resource.
+    services: Array<string> // The services offered by the resource.
+    owner: string // The owner of the resource in the Clinia ecosystem.
+}
+
+export interface AddressData {
+    streetAddress: string //	Street number plus route name.
+    suiteNumber: string //	Suite, door, appartment number.
+    postalCode: string //	Postal code.
+    neighborhood: string //	Neighborhood.
+    locality: string //	Locality.
+    place: string //	City.
+    region: string //	Name of the region.
+    regionCode: string //	ISO 3166-2 region code.
+    country: string //	Name of the country.
+    countryCode: string //	ISO 3166 country code
+}
+
+export interface PhoneData {
+    number: string //The phone number.
+    extension: string //The extension of the phone number.
+    countryCode: string //The country code associated with this phone number.
+    type:
+        | 'MAIN'
+        | 'ALTERNATE'
+        | 'RECEPTION'
+        | 'FAX'
+        | 'TEXT_TELEPHONE_TTY'
+        | 'INFO'
+        | 'OTHER' //The type of phone.
+    isTollFree: boolean //If the number is toll free or not.
+    province?: string //If the number is specific to a province
+}
+
+export interface IntervalData {
+    start: string //	Start time of the time interval. Format is HH:mm.
+    end: string //	End time of the time interval. Format is HH:mm.
+}
+
+export interface GeoPointData {
+    lat: number //	Latitude
+    lng: number //	Longitude
+}
+
+export interface SocialData {
+    url: string //	Url representing the link.
+    type: string // Type of link.
+}

package/src/models/external/index.ts

@@ -0,0 +1 @@
+export * from './clinia'

package/src/models/guard.ts

@@ -44,6 +44,7 @@ export interface WhoAmIResponse {
 export interface IdentityCreateRequest {
     practiceUuid: Uuid
     email: string
+    emailConfirmed?: boolean //In any env that aren't production, you can skip the email verification. Useful to write tests for instance.
     password: Base64String
     publicKey: Base64String
     recoveryPassword: Base64String

package/src/models/index.ts

@@ -6,3 +6,4 @@ export * from './practice'
 export * from './shared'
 export * from './vault'
 export * from './workflow'
+export * from './external'

package/src/models/practice.ts

@@ -1,3 +1,5 @@
+import { PlaceData } from "."
+
 export enum WorkflowType {
     Onboard = 'Onboard',
     Followup = 'Followup',
@@ -156,11 +158,7 @@ export type PracticeConfigPractitionerChatbox = PracticeConfig<
 export type PracticeConfigPracticeOnlinePharmacy = PracticeConfig<
     PracticeConfigKind.PracticePharmacyPicker,
     {
-        onlinePharmacy?: {
-            name: string,
-            id: string,
-            phones: { countryCode: string, number: string, extension: string | null, type: string, isTollFree: boolean, province?: string }[]
-        }
+        onlinePharmacy?: PlaceData
     }
 >
 
@@ -291,6 +289,16 @@ export interface PracticePaymentIntent {
     dateUpdateAt?: Date
 }
 
+/**
+ * This interface is used as metadata when creating Stripe Invoice.
+ * It will be used to create the consult when stripe use our hook.
+ */
+export interface ConsultRequestMetadata {
+    tagSpecialtyRequired: string
+    isoLocalityRequired?: string
+    isoLanguageRequired: string
+}
+
 export interface Assignment {
     id?: number ///optional for insertion
     uuidPractice: string
@@ -428,4 +436,4 @@ export interface PracticeInvoice {
     subtotal: number
     currency: string
     discount: number
-}
+}

package/src/models/workflow.ts

@@ -32,6 +32,8 @@ export interface LanguagePickerData extends ChoiceInputData {
 export interface EntryData {
     id?: number
     label?: string
+    hideLabel?: boolean
+    minorLabel?: string
     summaryLabel?: string
     summaryHidden?: boolean
     className?: string
@@ -81,7 +83,7 @@ export interface GroupedGenericQuestionData<T, A = IndexedData<ChoiceInputData>>
 export type QuestionData =
     | GenericQuestionData<'title' | 'paragraph' | 'checkbox', void>
     | GenericQuestionData<
-          'text' | 'date' | 'number' | 'images' | 'images-alias' | 'body-parts' | 'pharmacy-picker' | 'place-address'
+          'text' | 'textArea' | 'hybrid' | 'date' | 'number' | 'images' | 'images-alias' | 'body-parts' | 'pharmacy-picker' | 'place-address'
       >
     | GenericQuestionData<'checkbox-group' | 'select' | 'multiple', IndexedData<ChoiceInputData>>
     | GroupedGenericQuestionData<'radio', IndexedData<RadioInputData>>

package/src/services/guard.ts

@@ -157,7 +157,7 @@ export class GuardService {
         }
         return resp
     }
-    
+
     /**
      * Retrieve an identity. Will return public fields only when requested
      * without authentication
@@ -229,4 +229,32 @@ export class GuardService {
     public async identitySendConfirmEmail(req: IdentityResendConfirmEmailRequest): Promise<void> {
         return this.api.post<void>(`${this.baseURL}/v1/identity/confirm`, req)
     }
+
+    /**
+     *  Get an identity using a customer email (format: customer+[b64Hash]@orohealth.me)
+     *
+     * @param email the customer email
+     * @returns IdentityResponse
+     */
+    public async identityGetByCustomerEmail(email: string): Promise<IdentityResponse> {
+        return this.identityGetByHash(email.substring(email.indexOf('+')+1, email.indexOf('@')))
+    }
+
+    /**
+     * Get an identity using a base64 hash
+     *
+     * @param b64Hash base64 hash of the identity
+     * @returns IdentityResponse
+     */
+    public async identityGetByHash(b64Hash: string): Promise<IdentityResponse> {
+        //TODO: Right now this maps directly to the IdentityGet call.
+        //Eventually, with the mapping table method, this would lead to another
+        //call (ie: /v1/mapping/[b64Hash]) which would return a blob to decrypt
+        //which would contain the real identityID to call IdentityGet with.
+
+
+        //The hash comes in base64 format but it isn't URL safe soe we have to convert
+        //to base64URL (see https://en.wikipedia.org/wiki/Base64#The_URL_applications)
+        return this.identityGet(b64Hash.replace('+','-').replace('/','_'))
+    }
 }

package/src/services/practice.ts

@@ -1,6 +1,6 @@
 import { Buffer } from 'buffer/'
 import { sha256 } from 'hash.js'
-import { PracticeAccount, Uuid } from '../models'
+import { ConsultRequestMetadata, PracticeAccount, Uuid } from '../models'
 import {
     Assignment,
     PlanType,
@@ -178,13 +178,25 @@ export class PracticeService {
         return Buffer.from(sha256().update(email.toLowerCase()).digest('hex'), 'hex').toString('base64')
     }
 
+    /**
+     * Creates a PracticePaymentIntent
+     * @param practiceUuid the uuid of the practice
+     * @param planId the plan id to use
+     * @param userEmail the email address of the user
+     * @param isoLocality (optional) the desired locality
+     * @param url_subdomain  (optional) the url of the sub domain (@bruno-morel need you to document that)
+     * @param promotionCode (optional) promotion code to apply
+     * @param consultRequest (optional) consult request to use. If defined, when payment service call our hooks in practice, it will try to create a consult with these infos.
+     * @returns
+     */
     public practiceCreatePaymentsIntent(
         practiceUuid: Uuid,
         planId: number,
         userEmail: string,
         isoLocality?: string,
         url_subdomain?: string,
-        promotionCode?: string
+        promotionCode?: string,
+        consultRequest?: ConsultRequestMetadata
     ): Promise<PracticePaymentIntent> {
         return this.api.post<PracticePaymentIntent>(
             `${this.baseURL}/v1/practices/${practiceUuid}/payments/intents/`,
@@ -192,6 +204,7 @@ export class PracticeService {
                 idPlan: planId,
                 hashUserEmail: userEmail ? this.getPaymentIntentHashedEmail(userEmail) : undefined,
                 isoLocality,
+                consultRequest,
             },
             { params: { url_subdomain, promotionCode } }
         )
@@ -225,12 +238,9 @@ export class PracticeService {
      * @param practiceUuid UUID of the practice to get the invoice from
      * @param invoiceId ID of the invoice in stripe
      */
-    public getInvoice(
-        practiceUuid: Uuid,
-        invoiceId: string
-    ): Promise<PracticeInvoice> {
+    public getInvoice(practiceUuid: Uuid, invoiceId: string): Promise<PracticeInvoice> {
         return this.api.get<PracticeInvoice>(
-            `${this.baseURL}/v1/practices/${practiceUuid}/payments/invoices/${invoiceId}`,
+            `${this.baseURL}/v1/practices/${practiceUuid}/payments/invoices/${invoiceId}`
         )
     }
 

package/LICENSE

@@ -1,21 +0,0 @@
-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.