oro-sdk-apis 1.18.0 → 1.19.0

package/package.json

@@ -1,5 +1,5 @@
 {
-    "version": "1.18.0",
+    "version": "1.19.0",
     "main": "dist/index.js",
     "typings": "dist/index.d.ts",
     "files": [

package/src/models/workflow.ts

@@ -1,3 +1,41 @@
+/**
+ * This type represents all the patient profile kind
+ */
+export type ProfileKind = 'myself' | 'child' | 'other'
+/**
+ * this type is done as an example on how to add another data kind
+ */
+export type OtherKind = 'otherKindOfType'
+
+/**
+ * This type represents all the kind a data that can define `ChoiceInputData` (`OtherKind` is here only as an example on how to add a new kind)
+ */
+export type AllChoiceInputDataKind = ProfileKind | OtherKind
+
+/**
+ * This interface represents a `StateTrigger` on selected profile kind
+ */
+export interface ProfileTrigger {
+    kind: 'profileTrigger'
+    value: ProfileKind
+}
+
+/**
+ * This interface is meant as an example of another kind of `StateTrigger`
+ */
+export interface OtherTrigger {
+    kind: 'otherTrigger'
+    field1: number
+    field2: string
+}
+
+/**
+ * This type represents all the state triggers that are defined.
+ *
+ * A state trigger is triggered onto app states. In other words, it is for triggers that cannot be defined thanks to pure workflow answers.
+ */
+export type StateTrigger = ProfileTrigger | OtherTrigger
+
 export interface IndexedData<T> {
     [key: string]: T
 }
@@ -9,6 +47,8 @@ export interface ChoiceInputData {
     text: string
     className?: string
     order?: number
+    /** If defined, the choice input contains a kind that can be used into app. For instance, to check if a specific `kind` of answer has been selected */
+    kind?: AllChoiceInputDataKind
 }
 
 export interface RadioInputIconOptionsData {
@@ -37,7 +77,14 @@ export interface EntryData {
     summaryLabel?: string
     summaryHidden?: boolean
     className?: string
+    /**
+     * This field represents a list of `selectedAnswers` that must be set for this entry to be displayed.
+     */
     triggers?: string[]
+    /**
+     * This field represents a list of `StateTrigger` that must be fulfilled for this entry to be displayed.
+     */
+    stateTriggers?: StateTrigger[]
 }
 
 export interface SlideData {
@@ -80,8 +127,23 @@ export interface GroupedGenericQuestionData<T, A = IndexedData<ChoiceInputData>>
     order?: number
 }
 
-export declare type QuestionData = GenericQuestionData<'title' | 'paragraph' | 'checkbox', void> | GenericQuestionData<'text' | 'text-area' | 'date' | 'number' | 'images' | 'images-alias' | 'body-parts' | 'pharmacy-picker' | 'place-address'> | GenericQuestionData<'checkbox-group' | 'select' | 'multiple' | 'text-select-group', IndexedData<ChoiceInputData>> | GroupedGenericQuestionData<'radio', IndexedData<RadioInputData>> | GroupedGenericQuestionData<'radio-card', IndexedData<RadioCardInputData>> | GroupedGenericQuestionData<'language-picker', IndexedData<LanguagePickerData>>;
-
+export declare type QuestionData =
+    | GenericQuestionData<'title' | 'paragraph' | 'checkbox', void>
+    | GenericQuestionData<
+          | 'text'
+          | 'text-area'
+          | 'date'
+          | 'number'
+          | 'images'
+          | 'images-alias'
+          | 'body-parts'
+          | 'pharmacy-picker'
+          | 'place-address'
+      >
+    | GenericQuestionData<'checkbox-group' | 'select' | 'multiple' | 'text-select-group', IndexedData<ChoiceInputData>>
+    | GroupedGenericQuestionData<'radio', IndexedData<RadioInputData>>
+    | GroupedGenericQuestionData<'radio-card', IndexedData<RadioCardInputData>>
+    | GroupedGenericQuestionData<'language-picker', IndexedData<LanguagePickerData>>
 
 export interface FieldData {
     type: 'field'

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.