@coorpacademy/app-review 0.1.9 → 0.1.10

package/src/types/common.ts

@@ -7,14 +7,83 @@ type TemplateContextValues = {
   translations?: unknown; // TODO type Translations
 };
 
-export type SlideFromAPI = {
-  question: {
-    content: {
-      choices: Record<string, unknown>[];
-    };
+// TODO: EDIT_CHOICES -> specify typing
+export type ChoiceFromAPI = {
+  _id: string;
+  id?: string;
+  value?: string;
+  name?: string;
+  type?: 'text' | 'select';
+  label?: string;
+  items: {text: string; value: string; _id: string}[];
+  media?: unknown;
+};
+
+type BaseContent = {
+  media?: unknown;
+  choices: ChoiceFromAPI[];
+};
+
+type Question = {
+  header?: string;
+  content: BaseContent;
+  explanation?: string;
+};
+
+export type QcmQuestion = Question & {
+  type: 'qcm';
+};
+
+export type QcmGraphicQuestion = Question & {
+  type: 'qcmGraphic';
+};
+
+export type QcmDragQuestion = Question & {
+  type: 'qcmDrag';
+};
+
+export type BasicQuestion = Omit<Question, 'content'> & {
+  type: 'basic';
+  content: {
+    media?: unknown;
+    label?: string;
+    placeholder?: string;
+    id: string;
+  };
+};
+
+export type SliderQuestion = Omit<Question, 'content'> & {
+  content: {
+    media?: unknown;
+    unitLabel: string;
+    min: number;
+    max: number;
+    step?: number;
   };
+  type: 'slider';
+};
+
+export type TemplateQuestion = Omit<Question, 'content'> & {
+  content: BaseContent & {
+    template: string;
+  };
+  type: 'template';
+};
+
+export type SlideFromAPI = {
+  question:
+    | QcmQuestion
+    | QcmGraphicQuestion
+    | QcmDragQuestion
+    | BasicQuestion
+    | SliderQuestion
+    | TemplateQuestion;
   klf: string;
   universalRef: string;
+  tips?: string;
+  clue?: string;
+  hasClue?: boolean;
+  id?: string;
 };
 
 export type ProgressionFromAPI = {

package/src/types/slides.ts

@@ -1,9 +1,10 @@
 export type Choice = {
   order?: number;
   selected: boolean;
-  title: string;
-  help: string;
+  title?: string;
+  help?: string;
   onClick: Function;
+  ariaLabel?: string;
 };
 
 export type QcmDrag = {
@@ -14,20 +15,20 @@ export type QcmDrag = {
 
 export type Qcm = {
   type: 'qcm';
-  choices: (Choice & {ariaLabel: string})[];
+  answers: Choice[];
 };
 
 export type QcmGraphic = {
   type: 'qcmGraphic';
-  choices: (Choice & {image: string})[];
+  answers: (Choice & {image: string})[];
 };
 
 export type FreeText = {
   type: 'freeText';
   placeholder: string;
-  value: string;
+  value?: string;
   onChange: Function;
-  ariaLabel: string;
+  ariaLabel?: string;
 };
 
 export type DropDownOption = {
@@ -39,9 +40,9 @@ export type DropDownOption = {
 
 export type DropDown = {
   type: 'dropDown';
-  onChange: Function;
+  onChange?: Function;
   options: DropDownOption[];
-  theme:
+  theme?:
     | 'filter'
     | 'invalid'
     | 'header'
@@ -56,19 +57,35 @@ export type DropDown = {
 
 export type QuestionRange = {
   type: 'slider';
-  onChange: Function;
-  onChangeEnd: Function;
-  multi: boolean;
+  placeholder?: string;
+  onChange?: Function;
+  onChangeEnd?: Function;
+  multi?: boolean;
   value: number | number[];
   title: string;
   minLabel: string;
   maxLabel: string;
 };
 
+export type TextTemplate = {
+  type: 'text';
+  name: string;
+  placeholder: string;
+  value?: string;
+  onChange: Function;
+};
+
+export type SelectionTemplate = {
+  type: 'select';
+  name: string;
+  onChange?: Function;
+  options?: DropDownOption[];
+};
+
 export type Template = {
   type: 'template';
   template: string;
-  choices: (DropDown & {type?: string})[];
+  answers: (TextTemplate | SelectionTemplate)[];
 };
 
 export type AnswerUI = {