oro-sdk-apis 1.45.0 → 1.48.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1,5 +1,5 @@
1
1
  {
2
- "version": "1.45.0",
2
+ "version": "1.48.0",
3
3
  "main": "dist/index.js",
4
4
  "typings": "dist/index.d.ts",
5
5
  "files": [
@@ -54,4 +54,4 @@
54
54
  "buffer": "^6.0.3",
55
55
  "hash.js": "^1.1.7"
56
56
  }
57
- }
57
+ }
@@ -134,7 +134,9 @@ export interface PracticeAccount {
134
134
  *
135
135
  */
136
136
  export enum PracticeConfigKind {
137
+ PatientConsultCard = 'PatientConsultCard',
137
138
  PracticeCloseConsultationTypes = 'PracticeCloseConsultationTypes',
139
+ PracticeConsultTabs = 'PracticeConsultTabs',
138
140
  PracticeConfigExample = 'PracticeConfigExample',
139
141
  PracticeCookieBanner = 'PracticeCookieBanner',
140
142
  PracticeCssVariables = 'PracticeCssVariables',
@@ -202,6 +204,17 @@ export interface PracticeConfig<K, T> {
202
204
  config: T
203
205
  }
204
206
 
207
+ export type PracticeConfigPatientConsultCard = PracticeConfig<
208
+ PracticeConfigKind.PatientConsultCard,
209
+ { hideDiagnosis?: boolean }
210
+ >
211
+
212
+ export type PracticeConfigPracticeConsultTabs = PracticeConfig<
213
+ PracticeConfigKind.PracticeConsultTabs,
214
+ { hideDxTx?: boolean }
215
+ >
216
+
217
+
205
218
  /**
206
219
  * This type is for test (do not remove without updating the integration tests)
207
220
  */
@@ -374,6 +387,8 @@ export type PracticeConfigs =
374
387
  | PracticeConfigPracticeFontsLinks
375
388
  | PracticeConfigPracticePrescriptionFields
376
389
  | PracticeConfigPracticeConfigExample // Here for integration tests only
390
+ | PracticeConfigPracticeConsultTabs
391
+ | PracticeConfigPatientConsultCard
377
392
 
378
393
  export interface PracticeWorkflow {
379
394
  id?: number ///optional for insertion
@@ -575,7 +590,9 @@ export interface Practitioner {
575
590
  }
576
591
 
577
592
  export interface HydratedPracticeConfigs {
593
+ [PracticeConfigKind.PatientConsultCard]?: PracticeConfigPatientConsultCard
578
594
  [PracticeConfigKind.PracticeCloseConsultationTypes]?: PracticeConfigPracticeCloseConsultationTypes
595
+ [PracticeConfigKind.PracticeConsultTabs]?: PracticeConfigPracticeConsultTabs
579
596
  [PracticeConfigKind.PracticeConfigExample]?: PracticeConfigPracticeConfigExample
580
597
  [PracticeConfigKind.PracticeCookieBanner]?: PracticeConfigPracticeCookieBanner
581
598
  [PracticeConfigKind.PracticeCssVariables]?: PracticeConfigPracticeCssVariables
@@ -666,4 +683,4 @@ export interface PracticeSecret {
666
683
  * It's decrypted on the fly when returned by the api.
667
684
  */
668
685
  payload: string
669
- }
686
+ }
@@ -78,9 +78,45 @@ export interface EntryData {
78
78
  summaryHidden?: boolean
79
79
  className?: string
80
80
  /**
81
- * This field represents a list of `selectedAnswers` that must be set for this entry to be displayed.
81
+ * This field represents a list of `selectedAnswers` that must be set for this entry to be displayed using the followng logical combination of rules:
82
+ *
83
+ * #### Single string
84
+ *
85
+ * ```
86
+ * // Required: rule1
87
+ * rules: rule1
88
+ * ```
89
+ *
90
+ * #### Array of strings (AND is applied between statements):
91
+ *
92
+ * ```
93
+ * // Required: rule1 AND rule2
94
+ * rules: [ rule1, rule2 ]
95
+ * ```
96
+ *
97
+ * #### Array of arrays of strings (OR is applied between inner arrays. AND is applied between inner arrays statements)
98
+ *
99
+ * ```
100
+ * // Required: rule1 OR rule2
101
+ * rules: [
102
+ * [ rule1 ],
103
+ * [ rule2 ]
104
+ * ]
105
+ *
106
+ * // Required: rule1 OR (rule2 AND rule3)
107
+ * rules: [
108
+ * [ rule1 ],
109
+ * [ rule2, rule3 ]
110
+ * ]
111
+ *
112
+ * // THIS IS FORBIDDEN
113
+ * rules: [
114
+ * rule1, // <-- THIS IS FORBIDDEN. Instead use [ rule1 ]
115
+ * [ rule2, rule3 ]
116
+ * ]
117
+ * ```
82
118
  */
83
- triggers?: string[]
119
+ triggers?: string[][] | string[] | string
84
120
  /**
85
121
  * This field represents a list of `StateTrigger` that must be fulfilled for this entry to be displayed.
86
122
  */
@@ -130,7 +166,7 @@ export interface ImagesAliasQuestionOptions {
130
166
  /**
131
167
  * Should display photo guide instructions or not
132
168
  */
133
- photoGuide?: boolean
169
+ photoGuide?: boolean
134
170
  }
135
171
 
136
172
  export interface GenericQuestionData<T, A = IndexedData<ChoiceInputData>, O = undefined> extends EntryData {
@@ -167,12 +203,14 @@ export declare type QuestionData =
167
203
  | 'place-address'
168
204
  >
169
205
  | GenericQuestionData<'images-alias', IndexedData<ChoiceInputData>, ImagesAliasQuestionOptions>
170
- | GenericQuestionData<'checkbox-group' | 'hair-loss-frontal' | 'select' | 'multiple' | 'text-select-group', IndexedData<ChoiceInputData>>
171
- | GroupedGenericQuestionData<'radio'
172
- | 'hair-selector-women'
173
- | 'hair-selector-men'
174
- | 'hair-loss-stage',
175
- IndexedData<RadioInputData>>
206
+ | GenericQuestionData<
207
+ 'checkbox-group' | 'hair-loss-frontal' | 'select' | 'multiple' | 'text-select-group',
208
+ IndexedData<ChoiceInputData>
209
+ >
210
+ | GroupedGenericQuestionData<
211
+ 'radio' | 'hair-selector-women' | 'hair-selector-men' | 'hair-loss-stage',
212
+ IndexedData<RadioInputData>
213
+ >
176
214
  | GroupedGenericQuestionData<'radio-card' | 'profile-selector', IndexedData<RadioCardInputData>>
177
215
  | GroupedGenericQuestionData<'language-picker', IndexedData<LanguagePickerData>>
178
216
 
@@ -214,6 +252,14 @@ export interface WorkflowData {
214
252
  summarySymptomsFieldName?: string // this field is used to show the consult summary symptoms
215
253
  selectedAnswers?: SelectedAnswersData
216
254
  walkthroughSlides?: SlideData[]
255
+ /**
256
+ * (optional) the service name this workflow provides
257
+ */
258
+ serviceName?: string
259
+ /**
260
+ * (optional) the description of the service this workflow provides
261
+ */
262
+ serviceDescription?: string
217
263
  }
218
264
 
219
265
  /**
@@ -250,4 +296,4 @@ export interface PopulatedWorkflowData {
250
296
  workflowCreatedAt: string // The workflow version
251
297
  locale?: string
252
298
  fields: Record<string, PopulatedWorkflowField> // key corresponds to the QuestionData key in the workflow
253
- }
299
+ }
package/LICENSE DELETED
@@ -1,21 +0,0 @@
1
- MIT License
2
-
3
- Copyright (c) 2021 ORO Health Inc.
4
-
5
- Permission is hereby granted, free of charge, to any person obtaining a copy
6
- of this software and associated documentation files (the "Software"), to deal
7
- in the Software without restriction, including without limitation the rights
8
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
- copies of the Software, and to permit persons to whom the Software is
10
- furnished to do so, subject to the following conditions:
11
-
12
- The above copyright notice and this permission notice shall be included in all
13
- copies or substantial portions of the Software.
14
-
15
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
- SOFTWARE.