@coorpacademy/app-review 0.1.15 → 0.1.17

package/es/services/test/fetch-slide.test.d.ts

@@ -0,0 +1 @@
+export {};

package/es/services/test/fetch-slide.test.js

@@ -0,0 +1,22 @@
+import test from 'ava';
+import nock from 'nock';
+import { qcmDragSlide } from '../../views/slides/test/fixtures/qcm-drag';
+import { fetchSlide } from '../fetch-slide';
+test.before(() => {
+    nock('http://localhost:3000')
+        .get('/api/v2/slide/sli_123546/parentContentTitle')
+        .reply(200, qcmDragSlide);
+});
+test.after(() => {
+    nock.cleanAll();
+});
+test('should fetch a slide with the parentTitleContent info successfully', async (t) => {
+    const token = process.env.API_TEST_TOKEN || '';
+    const slide = await fetchSlide('sli_123546', token);
+    t.deepEqual(qcmDragSlide, slide);
+});
+test('should reject if a bad token is passed', async (t) => {
+    const badToken = 'token is not a jwt';
+    const error = await t.throwsAsync(() => fetchSlide('sli_123546', badToken));
+    t.is(error?.message, "Invalid token specified: Cannot read properties of undefined (reading 'replace')");
+});

package/es/services/test/post-answer.test.d.ts

@@ -0,0 +1 @@
+export {};

package/es/services/test/post-answer.test.js

@@ -0,0 +1,57 @@
+import test from 'ava';
+import nock from 'nock';
+import { postAnswer } from '../post-answer';
+const progressionId = '123456789123';
+const skillRef = '_skill-ref';
+const answer = ['Lister vos tâches pour vous libérer l’esprit', 'Vous isoler dans un lieu calme'];
+const result = {
+    content: {
+        type: 'skill',
+        ref: skillRef
+    },
+    engine: {
+        ref: 'review'
+    },
+    _id: '123456123456',
+    state: {
+        allAnswers: [
+            {
+                slideRef: 'sli_NkvrWPFF2',
+                isCorrect: true,
+                answer
+            }
+        ],
+        isCorrect: true,
+        nextContent: {
+            type: 'slide',
+            ref: 'sli_NJ3m5KtWh'
+        },
+        pendingSlides: [],
+        slides: ['sli_NkvrWPFF2'],
+        content: {
+            ref: 'sli_NkvrWPFF2',
+            type: 'slide'
+        },
+        step: {
+            current: 2
+        },
+        stars: 4
+    }
+};
+test.before(() => {
+    const moocApi = nock('http://localhost:3000');
+    moocApi.post(`/api/v2/progressions/${progressionId}/answers`).reply(200, result);
+});
+test.after(() => {
+    nock.cleanAll();
+});
+test('should post the answers successfully', async (t) => {
+    const token = process.env.API_TEST_TOKEN || '';
+    const progression = await postAnswer(skillRef, token, progressionId, answer);
+    t.deepEqual(result, progression);
+});
+test('should reject bad token', async (t) => {
+    const badToken = 'token is not a jwt';
+    const error = await t.throwsAsync(() => postAnswer(skillRef, badToken, progressionId, answer));
+    t.is(error?.message, "Invalid token specified: Cannot read properties of undefined (reading 'replace')");
+});

package/es/services/test/post-progression.test.js

@@ -4,6 +4,13 @@ import { postProgression } from '../post-progression';
 const skillRef = '_skill-ref';
 const result = {
     _id: '123456123456',
+    content: {
+        ref: '_skill-ref',
+        type: 'skill'
+    },
+    engine: {
+        ref: 'review'
+    },
     state: {
         allAnswers: [],
         isCorrect: true,
@@ -15,7 +22,8 @@ const result = {
         slides: [],
         step: {
             current: 1
-        }
+        },
+        stars: 0
     }
 };
 test.before(() => {

package/es/test/util/services.mock.d.ts

@@ -1,2 +1,3 @@
-import { Services } from '../../types/common';
+import { ProgressionFromAPI, Services } from '../../types/common';
+export declare const postAnswerResponse: ProgressionFromAPI;
 export declare const services: Services;

package/es/test/util/services.mock.js

@@ -1,50 +1,94 @@
-import { qcmSlide } from '../../helpers/test/fixtures/qcm';
-export const services = {
-    fetchSkills: () => {
-        return Promise.resolve([
-            {
-                skillRef: '_skill-ref',
-                slidesToReview: 2,
-                name: 'skill-test',
-                custom: false
-                // TODO parentContentTitle
-            },
-            {
-                skillRef: '_skill-ref-2',
-                slidesToReview: 2,
-                name: 'skill-test-2',
-                custom: true,
-                parentContentTitle: 'parentContentTitle 2'
-                // TODO parentContentTitle
-            }
-        ]);
+import { qcmSlide } from '../../views/slides/test/fixtures/qcm';
+import { qcmGraphicSlide } from '../../views/slides/test/fixtures/qcm-graphic';
+import { freeTextSlide } from '../../views/slides/test/fixtures/free-text';
+import { sliderSlide } from '../../views/slides/test/fixtures/slider';
+const getSlideFixture = (ref) => {
+    switch (ref) {
+        case qcmSlide.universalRef:
+            return qcmSlide;
+        case qcmGraphicSlide.universalRef:
+            return qcmGraphicSlide;
+        case freeTextSlide.universalRef:
+            return freeTextSlide;
+        default:
+            return sliderSlide;
+    }
+};
+const fetchSkillsResponse = [
+    {
+        skillRef: '_skill-ref',
+        slidesToReview: 2,
+        name: 'skill-test',
+        custom: false
+    },
+    {
+        skillRef: '_skill-ref-2',
+        slidesToReview: 2,
+        name: 'skill-test-2',
+        custom: true
+    }
+];
+const postProgressionResponse = {
+    _id: '62b1d1087aa12f00253f40ee',
+    content: {
+        ref: '_skill-ref',
+        type: 'skill'
     },
-    fetchSlide: ref => {
-        return Promise.resolve({ ...qcmSlide, universalRef: ref, id: ref });
+    engine: {
+        ref: 'review'
     },
-    postProgression: () => {
-        return Promise.resolve({
-            _id: '62b1d1087aa12f00253f40ee',
-            content: {
-                ref: '_skill-ref',
-                type: 'skill'
-            },
-            engine: {
-                ref: 'review'
-            },
-            state: {
-                allAnswers: [],
+    state: {
+        allAnswers: [],
+        isCorrect: true,
+        nextContent: {
+            ref: 'sli_VJYjJnJhg',
+            type: 'slide'
+        },
+        pendingSlides: [],
+        slides: [],
+        step: {
+            current: 1
+        },
+        stars: 0
+    }
+};
+export const postAnswerResponse = {
+    _id: '62b1d1087aa12f00253f40ee',
+    content: {
+        ref: '_skill-ref',
+        type: 'skill'
+    },
+    engine: {
+        ref: 'review'
+    },
+    state: {
+        allAnswers: [
+            {
+                slideRef: 'sli_VJYjJnJhg',
                 isCorrect: true,
-                nextContent: {
-                    ref: 'sli_N1XACJobn',
-                    type: 'slide'
-                },
-                pendingSlides: [],
-                slides: [],
-                step: {
-                    current: 1
-                }
+                answer: ['Benchmark']
             }
-        });
+        ],
+        isCorrect: true,
+        nextContent: {
+            ref: 'sli_VkSQroQnx',
+            type: 'slide'
+        },
+        content: {
+            ref: 'sli_VJYjJnJhg',
+            type: 'slide'
+        },
+        pendingSlides: [],
+        slides: ['sli_VJYjJnJhg'],
+        step: {
+            current: 2
+        },
+        stars: 4
     }
 };
+export const services = {
+    fetchSkills: () => Promise.resolve(fetchSkillsResponse),
+    fetchSlide: ref => Promise.resolve({ ...getSlideFixture(ref), universalRef: ref, id: ref }),
+    postProgression: () => Promise.resolve(postProgressionResponse),
+    postAnswer: () => Promise.resolve(postAnswerResponse)
+};

package/es/types/common.d.ts

@@ -1,5 +1,3 @@
-import { SlideIndexes } from '../common';
-import { AnswerUI } from './slides';
 declare type TemplateContextValues = {
     brandTheme?: unknown;
     theme?: unknown;
@@ -23,21 +21,21 @@ declare type BaseContent = {
     media?: unknown;
     choices: ChoiceFromAPI[];
 };
-declare type Question = {
+declare type BaseQuestion = {
     header?: string;
     content: BaseContent;
     explanation?: string;
 };
-export declare type QcmQuestion = Question & {
+export declare type QcmQuestion = BaseQuestion & {
     type: 'qcm';
 };
-export declare type QcmGraphicQuestion = Question & {
+export declare type QcmGraphicQuestion = BaseQuestion & {
     type: 'qcmGraphic';
 };
-export declare type QcmDragQuestion = Question & {
+export declare type QcmDragQuestion = BaseQuestion & {
     type: 'qcmDrag';
 };
-export declare type BasicQuestion = Omit<Question, 'content'> & {
+export declare type BasicQuestion = Omit<BaseQuestion, 'content'> & {
     type: 'basic';
     content: {
         media?: unknown;
@@ -46,7 +44,7 @@ export declare type BasicQuestion = Omit<Question, 'content'> & {
         id: string;
     };
 };
-export declare type SliderQuestion = Omit<Question, 'content'> & {
+export declare type SliderQuestion = Omit<BaseQuestion, 'content'> & {
     content: {
         media?: unknown;
         unitLabel: string;
@@ -56,20 +54,25 @@ export declare type SliderQuestion = Omit<Question, 'content'> & {
     };
     type: 'slider';
 };
-export declare type TemplateQuestion = Omit<Question, 'content'> & {
+export declare type TemplateQuestion = Omit<BaseQuestion, 'content'> & {
     content: BaseContent & {
         template: string;
     };
     type: 'template';
 };
+export declare type Question = QcmQuestion | QcmGraphicQuestion | QcmDragQuestion | BasicQuestion | SliderQuestion | TemplateQuestion;
 export declare type SlideFromAPI = {
-    question: QcmQuestion | QcmGraphicQuestion | QcmDragQuestion | BasicQuestion | SliderQuestion | TemplateQuestion;
+    question: Question;
     klf: string;
     universalRef: string;
     tips?: string;
     clue?: string;
     hasClue?: boolean;
     id: string;
+    parentContentTitle: {
+        title: string;
+        type: 'chapter' | 'course';
+    };
 };
 declare type ProgressionAnswerItem = {
     isCorrect: boolean;
@@ -92,9 +95,17 @@ export declare type ProgressionState = {
     step: {
         current: number;
     };
+    stars: number;
 };
 export declare type ProgressionFromAPI = {
     _id: string;
+    content: {
+        type: 'skill';
+        ref: string;
+    };
+    engine: {
+        ref: 'review';
+    };
     state: ProgressionState;
 };
 export declare type Skill = {
@@ -107,6 +118,7 @@ export declare type Services = {
     fetchSkills(token: string): Promise<Skill[]>;
     fetchSlide(slideRef: string, token: string): Promise<SlideFromAPI | void>;
     postProgression(skillRef: string, token: string): Promise<ProgressionFromAPI>;
+    postAnswer(skillRef: string, token: string, progressionId: string, answer: string[]): Promise<ProgressionFromAPI>;
 };
 export declare type Options = {
     services: Services;
@@ -128,29 +140,6 @@ export declare type JWT = {
     usage: string;
     host: string;
 };
-declare type SlideUIAnimations = 'unstack' | 'restack';
-export declare type NextUISlide = {
-    questionText?: string;
-    answerUI?: AnswerUI;
-    hidden?: boolean;
-    position?: number;
-    animationType?: SlideUIAnimations;
-    isCorrect?: boolean;
-    endReview?: boolean;
-};
-export declare type UISlide = {
-    questionText?: string;
-    answerUI?: AnswerUI;
-    hidden?: boolean;
-    position: number;
-    animationType?: SlideUIAnimations;
-    isCorrect?: boolean;
-    endReview?: boolean;
-    nextContent?: NextUISlide;
-};
-export declare type FinishedSlides = {
-    [key in SlideIndexes]?: true;
-};
 export declare type WithRequired<T, K extends keyof T> = T & {
     [P in K]-?: T[P];
 };

package/es/views/skills/index.d.ts

@@ -23,4 +23,4 @@ declare type SkillsProps = NoSkillsProps & {
     listSkills: SkillCard[];
 };
 export { SkillsProps };
-export declare const mapStateToSkillsProps: (state: StoreState) => SkillsProps | null;
+export declare const mapStateToSkillsProps: (state: StoreState) => SkillsProps;

package/es/views/skills/index.js

@@ -1,7 +1,4 @@
 export const mapStateToSkillsProps = (state) => {
-    if (!state.data.skills) {
-        return null;
-    }
     return {
         title: '@todo title',
         titleNoSkills: '@todo titleNoSkills',

package/es/views/skills/test/skills.test.d.ts

@@ -0,0 +1 @@
+export {};

package/es/views/skills/test/skills.test.js

@@ -0,0 +1,94 @@
+import test from 'ava';
+import map from 'lodash/fp/map';
+import omit from 'lodash/fp/omit';
+import { mapStateToSkillsProps } from '..';
+test('should create initial props when there are no skills on the state', t => {
+    const state = {
+        data: {
+            progression: null,
+            skills: [],
+            slides: {},
+            token: '1234'
+        },
+        ui: {
+            currentSlideRef: '',
+            navigation: ['loader', 'skills'],
+            answers: [],
+            slide: {
+                validateButton: false
+            }
+        }
+    };
+    const props = mapStateToSkillsProps(state);
+    t.deepEqual(props, {
+        title: '@todo title',
+        titleNoSkills: '@todo titleNoSkills',
+        textNoSkills: '@todo textNoSkills',
+        iconSkillAriaLabel: '@todo iconSkillAriaLabel',
+        isLoading: false,
+        isLoadingAriaLabel: '@todo loading',
+        listSkills: []
+    });
+});
+test('should create initial props when skills on the state', t => {
+    const state = {
+        data: {
+            progression: null,
+            skills: [
+                {
+                    skillRef: '_skill-ref',
+                    slidesToReview: 2,
+                    name: 'skill-test',
+                    custom: false
+                },
+                {
+                    skillRef: '_skill-ref-2',
+                    slidesToReview: 5,
+                    name: 'skill-test-2',
+                    custom: true
+                }
+            ],
+            slides: {},
+            token: '1234'
+        },
+        ui: {
+            currentSlideRef: '',
+            navigation: ['loader', 'skills'],
+            answers: [],
+            slide: {
+                validateButton: false
+            }
+        }
+    };
+    const props = mapStateToSkillsProps(state);
+    t.deepEqual(omit('listSkills', props), {
+        title: '@todo title',
+        titleNoSkills: '@todo titleNoSkills',
+        textNoSkills: '@todo textNoSkills',
+        iconSkillAriaLabel: '@todo iconSkillAriaLabel',
+        isLoading: false,
+        isLoadingAriaLabel: '@todo loading'
+    });
+    t.deepEqual(map(omit('onClick'), props.listSkills), [
+        {
+            'aria-label': '',
+            isCustom: false,
+            skillTitle: 'skill-test',
+            skillAriaLabel: '@todo skill aria label',
+            buttonLabel: '@todo button',
+            buttonAriaLabel: '@todo button aria label',
+            reviseLabel: '@todo revise',
+            reviseAriaLabel: '@todo revise aria label'
+        },
+        {
+            'aria-label': '',
+            isCustom: true,
+            skillTitle: 'skill-test-2',
+            skillAriaLabel: '@todo skill aria label',
+            buttonLabel: '@todo button',
+            buttonAriaLabel: '@todo button aria label',
+            reviseLabel: '@todo revise',
+            reviseAriaLabel: '@todo revise aria label'
+        }
+    ]);
+});

package/es/views/slides/index.d.ts

@@ -1,3 +1,90 @@
+import { Dispatch } from 'redux';
+import { SlideIndexes } from '../../common';
 import { StoreState } from '../../reducers';
-import { SlidesViewStaticProps } from '../../types/views/slides';
-export declare const mapStateToSlidesProps: (state: StoreState) => SlidesViewStaticProps | null;
+import { AnswerUI } from '../../types/slides';
+declare const ICON_VALUES: {
+    readonly right: "right";
+    readonly wrong: "wrong";
+    readonly 'no-answer': "no-answer";
+};
+declare type IconValue = keyof typeof ICON_VALUES;
+declare type StepItem = {
+    current: boolean;
+    icon: IconValue;
+    value: string;
+};
+declare type SlideUIAnimations = 'unstack' | 'restack';
+export declare type UISlide = {
+    questionText?: string;
+    answerUI?: AnswerUI;
+    hidden?: boolean;
+    position: number;
+    animationType?: SlideUIAnimations;
+    isCorrect?: boolean;
+    endReview?: boolean;
+    loading: boolean;
+};
+declare type SlidesStack = {
+    [key in SlideIndexes]: UISlide;
+};
+export declare type CorrectionPopinProps = {
+    klf: {
+        label: string;
+        onClick: Function;
+        tooltip: string;
+    };
+    information: {
+        label: string;
+        message: string;
+    };
+    next: {
+        label: string;
+        ariaLabel: string;
+    };
+    successLabel: string;
+    failureLabel: string;
+};
+export declare type SlidesViewProps = {
+    header: {
+        mode: string;
+        skillName: string;
+        onQuitClick: Function;
+        'aria-label'?: string;
+        closeButtonAriaLabel: string;
+        steps: StepItem[];
+    };
+    stack: {
+        slides: SlidesStack;
+        validateButton: {
+            label: string;
+            disabled: boolean;
+            onClick: Function;
+        };
+        correctionPopinProps?: CorrectionPopinProps;
+        endReview: boolean;
+    };
+    reviewBackgroundAriaLabel?: string;
+    congratsProps?: {
+        'aria-label'?: string;
+        'data-name'?: string;
+        animationLottie: unknown;
+        title: string;
+        cardCongratsStar: unknown;
+        cardCongratsRank: unknown;
+        buttonRevising: {
+            'aria-label'?: string;
+            label: string;
+            onClick: Function;
+            type: string;
+        };
+        buttonRevisingSkill: {
+            'aria-label'?: string;
+            label: string;
+            onClick: Function;
+            type: string;
+        };
+    };
+};
+export declare const initialState: SlidesStack;
+export declare const mapStateToSlidesProps: (state: StoreState, dispatch: Dispatch) => SlidesViewProps;
+export {};