oro-sdk-apis 6.0.2 → 6.3.0

package/package.json

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

package/src/models/workflow.ts

@@ -43,6 +43,26 @@ export interface IndexedData<T> {
 export type SelectedAnswerData = string | string[]
 export type SelectedAnswersData = IndexedData<SelectedAnswerData>[]
 
+/**
+ * Tracking between the selected answers and the previous ones (if exist)
+ */
+export interface PreviousAnswerData<T = (SelectedAnswerData | WorkflowUploadedImage[])> {
+    /**
+     * The answer from the previous consultation
+    */
+    previousAnswer: T
+    /**
+     * The timestamp of when the previous answer was entered
+     */
+    timestamp?: Date
+    /**
+     * Whether the value from the current answer and the previous answer has changed
+     */
+    changed: boolean
+}
+
+export type PreviousAnswersData = IndexedData<PreviousAnswerData>[]
+
 export interface ChoiceInputData {
     text: string
     className?: string
@@ -278,7 +298,8 @@ export interface WorkflowData {
     pages: WorkflowPageData[]
     summaryImageFieldName?: string // this field is used to show the consult summary image
     summarySymptomsFieldName?: string // this field is used to show the consult summary symptoms
-    selectedAnswers?: SelectedAnswersData
+    selectedAnswers?: SelectedAnswersData // all current answers
+    previousAnswers?: PreviousAnswersData // if exists, it is a 1-1 mapping of the selectedAnswers' previous values
     serviceImage?: string
     walkthroughSlides?: SlideData[]
     /**
@@ -299,6 +320,11 @@ export interface WorkflowData {
      */
     extendingWorkflow?: string
 
+    /**
+     * (optional) the extending referenced workflows `createdAt` timestamp
+     */
+    extendingWorkflowTimestamp?: string
+
     /**
      * (optional) rules for the extension of another workflow 
      */
@@ -366,7 +392,8 @@ export interface WorkflowUploadedImage {
  * This interface describes a workflow prepared and ready to be sent to vault
  */
 export interface PopulatedWorkflowField {
-    answer: SelectedAnswerData | WorkflowUploadedImage[] // Actual answer from the workflow
+    previousAnswer?: PreviousAnswerData // Answer from previous consultation
+    answer?: SelectedAnswerData | WorkflowUploadedImage[] // Actual answer from the workflow
     displayedAnswer?: any // This answer is to be used only when it's impossible to get data from workflow
     kind: string // If we don't store question. We will need that field to at least know the field type
 }