@legalplace/wizardx-core 0.0.1-alpha.0

package/src/redux/reducers/app/pagination/updateAvailableAppStates.ts

@@ -0,0 +1,77 @@
+import { StateType } from '../../../../types/State.type';
+import { ActionsType } from '../../../../types/Actions.type';
+import { registerPluginsAppStates } from '../../../../PluginLoader';
+
+// eslint-disable-next-line max-len
+export const updateAvailableAppStatesReducer = (
+  state: StateType.App,
+  action: ActionsType.App.updateAvailableAppStates
+): StateType.App => {
+  let availableAppStates;
+  if (!action.ingorePluginAppStateReset) {
+    availableAppStates = registerPluginsAppStates(action.availableAppStates);
+  } else {
+    availableAppStates = action.availableAppStates;
+  }
+
+  if (
+    state.pagination.availableAppStates.reduce((p, c) => p + c, '') ===
+    availableAppStates.reduce((p, c) => p + c, '')
+  )
+    return state;
+
+  // Making sure value has changed before changing the state
+
+  // Calculating total pages
+  const totalPages =
+    availableAppStates.length + state.wizard.availableSections.length - 1;
+
+  /**
+   * Recalculating currentPage
+   */
+  let appStates: string[] = [];
+  availableAppStates.forEach((currentAppState) => {
+    if (currentAppState === 'wizard')
+      state.wizard.availableSections.forEach(() => {
+        appStates = [...appStates, 'wizard'];
+      });
+    else {
+      appStates = [...appStates, currentAppState];
+    }
+  });
+
+  // If currentAppState is still available
+  // we put its page, otherwise we leave
+  // the logic to the pagination middleware
+  // to handle this case
+  let { currentPage } = state.pagination;
+  const { currentAppState } = state.pagination;
+  if (
+    appStates[currentPage - 1] !== currentAppState &&
+    appStates.indexOf(state.pagination.currentAppState) > -1
+  ) {
+    currentPage = appStates.indexOf(state.pagination.currentAppState) + 1;
+  } else {
+    // Making sure currentPage is not superior to totalPages
+    currentPage =
+      state.pagination.currentPage <= totalPages
+        ? state.pagination.currentPage
+        : totalPages;
+  }
+
+  // Checking first/last page
+  const isFirstPage = currentPage === 1;
+  const isLastPage = currentPage === totalPages;
+
+  return {
+    ...state,
+    pagination: {
+      ...state.pagination,
+      totalPages,
+      isFirstPage,
+      isLastPage,
+      currentPage,
+      availableAppStates,
+    },
+  };
+};

package/src/redux/reducers/app/pagination.test.ts

@@ -0,0 +1,363 @@
+import { initPaginationReducer } from './pagination/initPagination';
+import { goPageReducer } from './pagination/goPage';
+import { goNextPageReducer } from './pagination/goNextPage';
+import { goPreviousPageReducer } from './pagination/goPreviousPage';
+import { StateType } from '../../../types/State.type';
+
+const appStateMock: StateType.App = {
+  meta: {
+    fetchStatus: 'succeeded',
+    id: 0,
+    prefix: '',
+    permalink: 'permalink',
+    title: 'title',
+    modelVersion: 1,
+    productType: 'demarche',
+  },
+  wizard: {
+    availableSections: [1, 2, 3],
+    currentSectionId: 1,
+  },
+  pagination: {
+    currentPage: 1,
+    greatestPage: 1,
+    currentAppState: 'one',
+    availableAppStates: ['one', 'wizard', 'three', 'four'],
+    isFirstPage: true,
+    isLastPage: false,
+    totalPages: 6,
+  },
+  instance: {
+    dataStatus: 'saved',
+    uniqid: '3jHD42343sDE',
+    isPaid: false,
+    steps: '*',
+  },
+  customization: {},
+};
+
+describe('Pagination reducers test suit', () => {
+  // initPaginationReducer
+  it('initPaginationReducer', () => {
+    const state: StateType.App = {
+      ...appStateMock,
+      pagination: {
+        ...appStateMock.pagination,
+        currentPage: 2,
+        greatestPage: 2,
+      },
+      wizard: {
+        currentSectionId: 2,
+        availableSections: [1, 2, 5],
+      },
+    };
+
+    const reducer = initPaginationReducer(state, {
+      type: 'INIT_PAGINATION',
+      currentSectionId: 1,
+      currentPage: 3,
+      greatestPage: 3,
+      availableSections: [1, 2, 3],
+      availableAppStates: ['one', 'wizard', 'three', 'four'],
+      currentAppState: 'one',
+    });
+
+    return expect(reducer).toStrictEqual({
+      ...state,
+      pagination: {
+        ...state.pagination,
+        currentPage: 3,
+        greatestPage: 3,
+        isFirstPage: false,
+        isLastPage: false,
+      },
+      wizard: {
+        currentSectionId: 1,
+        availableSections: [1, 2, 3],
+      },
+    });
+  });
+
+  // goPageReducer
+  it('goPageReducer move to wizard', () => {
+    const state: StateType.App = {
+      ...appStateMock,
+      pagination: {
+        ...appStateMock.pagination,
+        currentPage: 2,
+        greatestPage: 2,
+      },
+      wizard: {
+        currentSectionId: 2,
+        availableSections: [1, 2, 5],
+      },
+    };
+
+    const reducer = goPageReducer(state, {
+      type: 'GO_PAGE',
+      currentPage: 3,
+      pushHistory: false,
+    });
+
+    return expect(reducer).toStrictEqual({
+      ...appStateMock,
+      pagination: {
+        ...appStateMock.pagination,
+        currentPage: 3,
+        greatestPage: 3,
+        isFirstPage: false,
+        isLastPage: false,
+        currentAppState: 'wizard',
+      },
+      wizard: {
+        ...appStateMock.wizard,
+        currentSectionId: 2,
+        availableSections: [1, 2, 5],
+      },
+    });
+  });
+
+  // goPageReducer
+  it('goPageReducer go to "one"', () => {
+    const state: StateType.App = {
+      ...appStateMock,
+      pagination: {
+        ...appStateMock.pagination,
+        currentPage: 2,
+        greatestPage: 4,
+      },
+    };
+    const reducer = goPageReducer(state, {
+      type: 'GO_PAGE',
+      currentPage: 1,
+      pushHistory: false,
+    });
+
+    return expect(reducer).toStrictEqual({
+      ...appStateMock,
+      pagination: {
+        ...appStateMock.pagination,
+        currentPage: 1,
+        greatestPage: 4,
+        isFirstPage: true,
+        isLastPage: false,
+        currentAppState: 'one',
+      },
+    });
+  });
+
+  // goPageReducer
+  it('goPageReducer go to "three"', () => {
+    const state: StateType.App = {
+      ...appStateMock,
+      pagination: {
+        ...appStateMock.pagination,
+        currentPage: 2,
+        greatestPage: 3,
+      },
+    };
+    const reducer = goPageReducer(state, {
+      type: 'GO_PAGE',
+      currentPage: 5,
+      pushHistory: false,
+    });
+
+    return expect(reducer).toStrictEqual({
+      ...appStateMock,
+      pagination: {
+        ...appStateMock.pagination,
+        currentPage: 5,
+        greatestPage: 5,
+        isFirstPage: false,
+        isLastPage: false,
+        currentAppState: 'three',
+      },
+      wizard: {
+        ...state.wizard,
+        currentSectionId: 3,
+      },
+    });
+  });
+
+  // goNextPageReducer
+  it('goNextPageReducer from 0 to "one"', () => {
+    const state: StateType.App = {
+      ...appStateMock,
+      pagination: {
+        ...appStateMock.pagination,
+        currentPage: 0,
+        greatestPage: 5,
+      },
+      wizard: {
+        currentSectionId: 1,
+        availableSections: [1, 4, 3],
+      },
+    };
+
+    const reducer = goNextPageReducer(state);
+
+    return expect(reducer).toStrictEqual({
+      ...state,
+      pagination: {
+        ...state.pagination,
+        currentPage: 1,
+        greatestPage: 5,
+        isFirstPage: false,
+        currentAppState: 'one',
+      },
+      wizard: {
+        ...state.wizard,
+        currentSectionId: 1,
+      },
+    });
+  });
+
+  // goNextPageReducer
+  it('goNextPageReducer from "wizard to "three"', () => {
+    const state: StateType.App = {
+      ...appStateMock,
+      pagination: {
+        ...appStateMock.pagination,
+        currentPage: 4,
+        greatestPage: 5,
+        currentAppState: 'wizard',
+      },
+      wizard: {
+        currentSectionId: 3,
+        availableSections: [1, 4, 3],
+      },
+    };
+
+    const reducer = goNextPageReducer(state);
+
+    return expect(reducer).toStrictEqual({
+      ...state,
+      pagination: {
+        ...state.pagination,
+        currentPage: 5,
+        greatestPage: 5,
+        isFirstPage: false,
+        currentAppState: 'three',
+      },
+      wizard: {
+        ...state.wizard,
+        currentSectionId: 3,
+      },
+    });
+  });
+
+  // goNextPageReducer
+  it('goNextPageReducer should not change state on last page', () => {
+    const state: StateType.App = {
+      ...appStateMock,
+      pagination: {
+        ...appStateMock.pagination,
+        currentPage: 6,
+        greatestPage: 6,
+        currentAppState: 'four',
+      },
+      wizard: {
+        currentSectionId: 3,
+        availableSections: [1, 4, 3],
+      },
+    };
+
+    const reducer = goNextPageReducer(state);
+
+    return expect(reducer).toEqual(state);
+  });
+
+  // goPreviousPageReducer
+  it('goPreviousPageReducer when page > 1', () => {
+    const state: StateType.App = {
+      ...appStateMock,
+      pagination: {
+        ...appStateMock.pagination,
+        currentPage: 2,
+        greatestPage: 5,
+      },
+      wizard: {
+        currentSectionId: 2,
+        availableSections: [1, 2, 3],
+      },
+    };
+
+    const reducer = goPreviousPageReducer(state);
+
+    return expect(reducer).toStrictEqual({
+      ...state,
+      pagination: {
+        ...state.pagination,
+        currentPage: 1,
+        greatestPage: 5,
+      },
+      wizard: {
+        ...state.wizard,
+        currentSectionId: 1,
+      },
+    });
+  });
+
+  // goPreviousPageReducer
+  it('goPreviousPageReducer when page =< 1', () => {
+    const currentState: StateType.App = {
+      ...appStateMock,
+      pagination: {
+        ...appStateMock.pagination,
+        currentPage: 1,
+        greatestPage: 2,
+      },
+      wizard: {
+        currentSectionId: 1,
+        availableSections: [1, 2, 3],
+      },
+    };
+
+    const reducer = goPreviousPageReducer(currentState);
+
+    return expect(reducer).toStrictEqual({
+      ...currentState,
+      pagination: {
+        ...currentState.pagination,
+        currentPage: 1,
+        greatestPage: 2,
+      },
+      wizard: {
+        ...currentState.wizard,
+        currentSectionId: 1,
+      },
+    });
+  });
+
+  // goPreviousPageReducer
+  it('goPreviousPageReducer from "four" to "three"', () => {
+    const currentState: StateType.App = {
+      ...appStateMock,
+      pagination: {
+        ...appStateMock.pagination,
+        currentPage: 6,
+        greatestPage: 6,
+        currentAppState: 'four',
+        isFirstPage: false,
+        isLastPage: true,
+      },
+      wizard: {
+        currentSectionId: 3,
+        availableSections: [1, 2, 3],
+      },
+    };
+
+    const reducer = goPreviousPageReducer(currentState);
+
+    return expect(reducer).toStrictEqual({
+      ...currentState,
+      pagination: {
+        ...currentState.pagination,
+        currentPage: 5,
+        greatestPage: 6,
+        currentAppState: 'three',
+        isLastPage: false,
+      },
+    });
+  });
+});

package/src/redux/reducers/app/wizard/updateAvailableSections.ts

@@ -0,0 +1,40 @@
+import { StateType } from '../../../../types/State.type';
+import { ActionsType } from '../../../../types/Actions.type';
+
+// eslint-disable-next-line max-len
+export const updateAvailableSectionsReducer = (
+  state: StateType.App,
+  action: ActionsType.App.updateAvailableSections
+): StateType.App => {
+  const { availableSections } = action;
+
+  // Making sure value has changed before changing the state
+  if (
+    state.wizard.availableSections.reduce((p, c) => p + c, '') ===
+    availableSections.reduce((p, c) => p + c, '')
+  )
+    return state;
+
+  // Calculating total pages
+  const totalPages =
+    state.pagination.availableAppStates.length + availableSections.length - 1;
+
+  // Checking first/last page
+  const isFirstPage = state.pagination.currentPage === 1;
+  const isLastPage =
+    state.pagination.currentPage === state.pagination.totalPages;
+
+  return {
+    ...state,
+    pagination: {
+      ...state.pagination,
+      totalPages,
+      isFirstPage,
+      isLastPage,
+    },
+    wizard: {
+      ...state.wizard,
+      availableSections,
+    },
+  };
+};

package/src/redux/reducers/app/wizard.test.ts

@@ -0,0 +1,84 @@
+import { updateAvailableSectionsReducer } from './wizard/updateAvailableSections';
+import { StateType } from '../../../types/State.type';
+
+const appStateMock: StateType.App = {
+  meta: {
+    fetchStatus: 'succeeded',
+    id: 0,
+    prefix: '',
+    permalink: 'permalink',
+    title: 'title',
+    modelVersion: 1,
+    productType: 'demarche',
+  },
+  wizard: {
+    availableSections: [1, 2, 3],
+    currentSectionId: 1,
+  },
+  pagination: {
+    currentPage: 1,
+    greatestPage: 1,
+    currentAppState: 'wizard',
+    availableAppStates: ['wizard', 'termsheet'],
+    isFirstPage: true,
+    isLastPage: false,
+    totalPages: 4,
+  },
+  instance: {
+    dataStatus: 'saved',
+    uniqid: '3jHD42343sDE',
+    isPaid: false,
+    steps: '*',
+  },
+  customization: {},
+};
+
+describe('Wizard reducers test suit', () => {
+  // updateAvailableSectionsReducer
+  it('updateAvailableSectionsReducer', () => {
+    const state = {
+      ...appStateMock,
+      wizard: {
+        ...appStateMock.wizard,
+        availableSections: [1, 2, 3],
+        currentSectionId: 1,
+      },
+    };
+
+    const reducer = updateAvailableSectionsReducer(state, {
+      type: 'UPDATE_AVAILABLE_SECTIONS',
+      availableSections: [1, 4, 5, 6],
+    });
+
+    return expect(reducer).toStrictEqual({
+      ...appStateMock,
+      pagination: {
+        ...appStateMock.pagination,
+        totalPages: 5,
+      },
+      wizard: {
+        currentSectionId: 1,
+        availableSections: [1, 4, 5, 6],
+      },
+    });
+  });
+
+  // updateAvailableSectionsReducer
+  it('updateAvailableSectionsReducer should not update state if sections did not change', () => {
+    const state = {
+      ...appStateMock,
+      wizard: {
+        ...appStateMock.wizard,
+        availableSections: [1, 2, 3],
+        currentSectionId: 1,
+      },
+    };
+
+    const reducer = updateAvailableSectionsReducer(state, {
+      type: 'UPDATE_AVAILABLE_SECTIONS',
+      availableSections: [1, 2, 3],
+    });
+
+    return expect(reducer).toEqual(state);
+  });
+});