oro-sdk-apis 1.25.0 → 1.26.0

package/package.json

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

package/src/models/workflow.ts

@@ -111,7 +111,26 @@ export enum MetadataCategory { //these are generic metadata categories
     Raw = 'Raw',
 }
 
-export interface GenericQuestionData<T, A = IndexedData<ChoiceInputData>> extends EntryData {
+/**
+ * This interface describes all images-alias question kind options
+ */
+export interface ImagesAliasQuestionOptions {
+    /**
+     * Comma separated list of accepted formats. Will be given to the input html element.
+     * Use same format as described [here](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#accept)
+     */
+    accept?: string
+    /**
+     * Should allow multiple uploads or not
+     */
+    multiple?: boolean
+    /**
+     * Should display photo guide instructions or not
+     */
+     photoGuide?: boolean
+}
+
+export interface GenericQuestionData<T, A = IndexedData<ChoiceInputData>, O = undefined> extends EntryData {
     kind: T
     metaCategory: MetadataCategory
     answers?: A
@@ -119,6 +138,10 @@ export interface GenericQuestionData<T, A = IndexedData<ChoiceInputData>> extend
     placeholder?: string
     defaultValue?: any
     value?: string
+    /**
+     * Options to forward to the workflow component
+     */
+    options?: O
 }
 
 export interface GroupedGenericQuestionData<T, A = IndexedData<ChoiceInputData>> extends GenericQuestionData<T, A> {
@@ -135,12 +158,12 @@ export declare type QuestionData =
           | 'date'
           | 'number'
           | 'images'
-          | 'images-alias'
           | 'body-parts'
           | 'pharmacy-picker'
           | 'online-pharmacy-picker'
           | 'place-address'
       >
+    | GenericQuestionData<'images-alias', IndexedData<ChoiceInputData>, ImagesAliasQuestionOptions>
     | GenericQuestionData<'checkbox-group' | 'select' | 'multiple' | 'text-select-group', IndexedData<ChoiceInputData>>
     | GroupedGenericQuestionData<'radio', IndexedData<RadioInputData>>
     | GroupedGenericQuestionData<'radio-card' | 'profile-selector', IndexedData<RadioCardInputData>>
@@ -187,13 +210,28 @@ export interface WorkflowData {
 }
 
 /**
- * This interface describes a workflow prepared and ready to be sent to vault
+ * This interface describes an upload of an image (could be a picture, a pdf, a text file, etc.)
  */
 export interface WorkflowUploadedImage {
+    /**
+     * Depending on the driver used by WorkflowInput:
+     * - 'indexdb': will fetch the image in IndexDB with this id
+     * - 'vault': will fetch the image in the vault with this id
+     */
     idbId?: string
+    /**
+     * The name of the image
+     */
     name: string
+    /**
+     * the image data (could be a picture, a pdf, a text file, etc.)
+     */
     imageData?: string
 }
+
+/**
+ * This interface describes a workflow prepared and ready to be sent to vault
+ */
 export interface PopulatedWorkflowField {
     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