@coorpacademy/app-review 0.1.15 → 0.1.16

package/es/reducers/ui/index.d.ts

@@ -1,14 +1,14 @@
 import { CurrentSlideRefState } from './current-slide-ref';
 import { NavigationState } from './navigation';
-import { UISlidesState } from './slides';
+import { AnswerState } from './answers';
 export declare type UIState = {
     currentSlideRef: CurrentSlideRefState;
     navigation: NavigationState;
-    slides: UISlidesState;
+    answers: AnswerState;
 };
 declare const _default: import("redux").Reducer<import("redux").CombinedState<{
     currentSlideRef: string;
     navigation: NavigationState;
-    slides: UISlidesState;
-}>, import("../../actions/ui/slides").SetCurrentSlide | import("../../actions/ui/navigation").NavigateTo | import("../../actions/ui/navigation").NavigateBack>;
+    answers: AnswerState;
+}>, import("../../actions/ui/slides").SetCurrentSlide | import("../../actions/ui/navigation").NavigateTo | import("../../actions/ui/navigation").NavigateBack | import("../../actions/ui/answers").EditBasicAction>;
 export default _default;

package/es/reducers/ui/index.js

@@ -1,9 +1,9 @@
 import { combineReducers } from 'redux';
 import currentSlideRef from './current-slide-ref';
 import navigation from './navigation';
-import slides from './slides';
+import answers from './answers';
 export default combineReducers({
     currentSlideRef,
     navigation,
-    slides
+    answers
 });

package/es/reducers/ui/test/answers.test.d.ts

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

package/es/reducers/ui/test/answers.test.js

@@ -0,0 +1,11 @@
+import test from 'ava';
+import reducer from '../answers';
+import { EDIT_BASIC } from '../../../actions/ui/answers';
+test('should have inital value', t => {
+    const state = reducer(undefined, {});
+    t.deepEqual(state, []);
+});
+test('should set the value of EDIT_BASIC action', t => {
+    const state = reducer([], { type: EDIT_BASIC, payload: ['value'] });
+    t.deepEqual(state, ['value']);
+});

package/es/reducers/ui/test/current-slide-ref.test.d.ts

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

package/es/reducers/ui/test/current-slide-ref.test.js

@@ -0,0 +1,12 @@
+import test from 'ava';
+import reducer from '../current-slide-ref';
+import { SET_CURRENT_SLIDE } from '../../../actions/ui/slides';
+import { freeTextSlide } from '../../../views/slides/test/fixtures/free-text';
+test('should have inital value', t => {
+    const state = reducer(undefined, {});
+    t.is(state, '');
+});
+test('should set the value of SET_CURRENT_SLIDE action', t => {
+    const state = reducer('', { type: SET_CURRENT_SLIDE, payload: freeTextSlide });
+    t.is(state, 'sli_VJYjJnJhg');
+});

package/es/reducers/ui/test/navigation.test.d.ts

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

package/es/reducers/ui/test/navigation.test.js

@@ -0,0 +1,15 @@
+import test from 'ava';
+import reducer from '../navigation';
+import { NAVIGATE_TO, NAVIGATE_BACK } from '../../../actions/ui/navigation';
+test('should have inital value', t => {
+    const state = reducer(undefined, {});
+    t.deepEqual(state, []);
+});
+test('should set the value of NAVIGATE_TO and NAVIGATE_BACK action', t => {
+    const state = reducer([], { type: NAVIGATE_TO, payload: 'loader' });
+    t.deepEqual(state, ['loader']);
+    const updatedState = reducer(state, { type: NAVIGATE_TO, payload: 'skills' });
+    t.deepEqual(updatedState, ['loader', 'skills']);
+    const _updatedState = reducer(updatedState, { type: NAVIGATE_BACK });
+    t.deepEqual(_updatedState, ['loader']);
+});

package/es/services/fetch-slide.js

@@ -3,7 +3,7 @@ import decode from 'jwt-decode';
 import { toJSON } from './tools/fetch-responses';
 export const fetchSlide = async (slideRef, token) => {
     const { host } = decode(token);
-    const response = await crossFetch(`${host}/api/v2/slide/${slideRef}`, {
+    const response = await crossFetch(`${host}/api/v2/slide/${slideRef}/parentContentTitle`, {
         headers: { authorization: token }
     });
     const slide = (await toJSON(response));

package/es/services/index.js

@@ -1,8 +1,10 @@
 import { fetchSkills } from './fetch-skills';
 import { postProgression } from './post-progression';
 import { fetchSlide } from './fetch-slide';
+import { postAnswer } from './post-answer';
 export const getServices = () => ({
     fetchSkills,
     fetchSlide,
-    postProgression
+    postProgression,
+    postAnswer
 });

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

@@ -0,0 +1,2 @@
+import { ProgressionFromAPI } from '../types/common';
+export declare const postAnswer: (skillRef: string, token: string, progressionId: string, answer: string[]) => Promise<ProgressionFromAPI>;

package/es/services/post-answer.js

@@ -0,0 +1,18 @@
+import crossFetch from 'cross-fetch';
+import decode from 'jwt-decode';
+import { toJSON } from './tools/fetch-responses';
+export const postAnswer = async (skillRef, token, progressionId, answer) => {
+    const { host } = decode(token);
+    const response = await crossFetch(`${host}/api/v2/progressions/${progressionId}/answers`, {
+        method: 'post',
+        headers: { authorization: token },
+        body: JSON.stringify({
+            content: {
+                ref: skillRef,
+                type: 'slide'
+            },
+            answer
+        })
+    });
+    return toJSON(response);
+};

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.js

@@ -1,4 +1,4 @@
-import { qcmSlide } from '../../helpers/test/fixtures/qcm';
+import { freeTextSlide } from '../../views/slides/test/fixtures/free-text';
 export const services = {
     fetchSkills: () => {
         return Promise.resolve([
@@ -7,20 +7,17 @@ export const services = {
                 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
+                custom: true
             }
         ]);
     },
     fetchSlide: ref => {
-        return Promise.resolve({ ...qcmSlide, universalRef: ref, id: ref });
+        return Promise.resolve({ ...freeTextSlide, universalRef: ref, id: ref });
     },
     postProgression: () => {
         return Promise.resolve({
@@ -43,7 +40,40 @@ export const services = {
                 slides: [],
                 step: {
                     current: 1
-                }
+                },
+                stars: 0
+            }
+        });
+    },
+    postAnswer: () => {
+        return Promise.resolve({
+            _id: '62b1d1087aa12f00253f40ee',
+            content: {
+                ref: '_skill-ref',
+                type: 'skill'
+            },
+            engine: {
+                ref: 'review'
+            },
+            state: {
+                allAnswers: [
+                    {
+                        slideRef: 'sli_N1XACJobn',
+                        isCorrect: true,
+                        answer: ['Le créateur peut fixer un pourcentage pour chaque transaction future']
+                    }
+                ],
+                isCorrect: true,
+                nextContent: {
+                    ref: 'sli_VkSQroQnx',
+                    type: 'slide'
+                },
+                pendingSlides: [],
+                slides: ['sli_N1XACJobn'],
+                step: {
+                    current: 2
+                },
+                stars: 4
             }
         });
     }

package/es/types/common.d.ts

@@ -23,21 +23,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 +46,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 +56,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 +97,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 +120,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;

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

@@ -1,3 +1,79 @@
+import { Dispatch } from 'redux';
+import { UISlide } from '../../types/common';
+import { SlideIndexes } from '../../common';
 import { StoreState } from '../../reducers';
-import { SlidesViewStaticProps } from '../../types/views/slides';
-export declare const mapStateToSlidesProps: (state: StoreState) => SlidesViewStaticProps | null;
+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 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 | null;
+export {};

package/es/views/slides/index.js

@@ -1,5 +1,71 @@
+import concat from 'lodash/fp/concat';
+import get from 'lodash/fp/get';
+import getOr from 'lodash/fp/getOr';
 import isEmpty from 'lodash/fp/isEmpty';
-const buildStepItemps = (state) => {
+import pipe from 'lodash/fp/pipe';
+import reduce from 'lodash/fp/reduce';
+import set from 'lodash/fp/set';
+import slice from 'lodash/fp/slice';
+import toInteger from 'lodash/fp/toInteger';
+import { mapApiSlideToUi } from './map-api-slide-to-ui';
+const ICON_VALUES = {
+    right: 'right',
+    wrong: 'wrong',
+    'no-answer': 'no-answer'
+};
+export const initialState = {
+    '0': {
+        hidden: false,
+        position: 0
+    },
+    '1': {
+        hidden: false,
+        position: 1
+    },
+    '2': {
+        hidden: false,
+        position: 2
+    },
+    '3': {
+        hidden: false,
+        position: 3
+    },
+    '4': {
+        hidden: false,
+        position: 4
+    }
+};
+const getProgressionSlidesRef = (progression) => {
+    if (progression.state.step.current < 5) {
+        const slideRef = progression.state.nextContent.ref;
+        return concat([slideRef], progression.state.slides);
+    }
+    return slice(0, 5, progression.state.slides);
+};
+const buildStackSlides = (state, dispatch) => {
+    const currentSlideRef = state.ui.currentSlideRef;
+    const progression = state.data.progression;
+    if (!currentSlideRef || !progression)
+        return initialState;
+    const slideRefs = getProgressionSlidesRef(progression);
+    // @ts-expect-error typescript does not support capped versions of lodash functions
+    const stack = reduce.convert({ cap: false })((acc, uiSlide, index) => {
+        const slideRef = slideRefs[toInteger(index)];
+        if (!slideRef)
+            return set(index, uiSlide, acc);
+        const slideFromAPI = get(slideRef, state.data.slides);
+        const answers = state.ui.answers;
+        const { questionText, answerUI } = mapApiSlideToUi(dispatch)(slideFromAPI, answers);
+        const parentContentTitle = getOr('', 'parentContentTitle.title', slideFromAPI);
+        const parentContentType = getOr('', 'parentContentTitle.type', slideFromAPI);
+        const updatedUiSlide = pipe(set(['questionText'], questionText), set(['answerUI'], answerUI), set(['parentContentTitle'], `From "${parentContentTitle}" ${parentContentType}`) // TODO translate: -From- .... -Course/chapter-
+        // TODO: Set position according to currentSlideRef et slideRefs (or maybe a value on the state ui.slidePositions !!)
+        )(uiSlide);
+        return set(index, updatedUiSlide, acc);
+    }, initialState, initialState);
+    return stack;
+};
+const buildStepItems = (state) => {
     const { progression } = state.data;
     const { currentSlideRef } = state.ui;
     if (!progression)
@@ -51,7 +117,7 @@ const buildStepItemps = (state) => {
     });
     return steps;
 };
-export const mapStateToSlidesProps = (state) => {
+export const mapStateToSlidesProps = (state, dispatch) => {
     if (!state.data.slides) {
         return null;
     }
@@ -65,10 +131,10 @@ export const mapStateToSlidesProps = (state) => {
             },
             'aria-label': 'aria-header-wrapper',
             closeButtonAriaLabel: 'aria-close-button',
-            steps: buildStepItemps(state)
+            steps: buildStepItems(state)
         },
         stack: {
-            slides: state.ui.slides,
+            slides: buildStackSlides(state, dispatch),
             validateButton: {
                 label: '__validate',
                 disabled: true,

package/es/views/slides/map-api-slide-to-ui.d.ts

@@ -0,0 +1,8 @@
+import { Dispatch } from 'redux';
+import { AnswerUI } from '../../types/slides';
+import { Question, SlideFromAPI } from '../../types/common';
+export declare const getQuestionType: (question: Question) => Question['type'];
+export declare const mapApiSlideToUi: (dispatch: Dispatch) => (slide: SlideFromAPI, answers: string[]) => {
+    questionText: string;
+    answerUI: AnswerUI;
+};