@legalplace/wizardx-core 2.6.3 → 2.7.0

package/src/libs/OvcConverter.ts

@@ -1,285 +0,0 @@
-import { StateType } from "../types/State.type";
-import {
-  selectOptionParents,
-  selectOptionReference,
-  selectVariableParents,
-} from "../redux/selectors/references";
-import { selectOptionInput } from "../redux/selectors/inputs";
-
-export interface OvcType {
-  o: {
-    [k: string]: string | number | (string | number)[];
-  };
-  v: {
-    [k: string]: string | number | (string | number)[];
-  };
-  c: {
-    [k: string]: boolean | boolean[];
-  };
-}
-
-class _OvcConverter {
-  public convertToOptionsVariables(
-    ovc: OvcType,
-    references: StateType.References
-  ) {
-    const inputs: StateType.Inputs = {
-      options: {},
-      variables: {},
-    };
-
-    if (typeof ovc !== "object") return inputs;
-
-    // Reading options
-    if (typeof ovc.o === "object") {
-      Object.keys(ovc.o).forEach((id) => {
-        const currentOption = ovc.o[id];
-
-        // If it's a multiple
-        if (Array.isArray(currentOption)) {
-          const occurences = currentOption.length;
-          // Adding static childrens
-          inputs.options = {
-            ...inputs.options,
-            ...this.pushStaticChildren(
-              inputs.options,
-              id,
-              occurences,
-              references
-            ),
-          };
-          currentOption.forEach((childId, index) => {
-            const sanitizedId =
-              typeof childId === "string" && childId.split("_").length > 0
-                ? childId.split("_")[0]
-                : childId;
-
-            // Making sure the input exist
-            if (!Object.prototype.hasOwnProperty.call(inputs.options, id)) {
-              inputs.options[id] = new Array(occurences).fill(false);
-            }
-
-            // Making sure the childId is not empty
-            if (
-              typeof sanitizedId === "string" &&
-              sanitizedId.trim().length === 0
-            ) {
-              return;
-            }
-
-            // Creating input if it doesn't exist
-            if (
-              !Object.prototype.hasOwnProperty.call(inputs.options, sanitizedId)
-            ) {
-              inputs.options[sanitizedId] = new Array(occurences).fill(false);
-            }
-
-            // Adding static childrens
-            inputs.options = {
-              ...inputs.options,
-              ...this.pushStaticChildren(
-                inputs.options,
-                sanitizedId,
-                occurences,
-                references
-              ),
-            };
-
-            // Setting current index to true
-            inputs.options[sanitizedId][index] = true;
-          });
-        } else {
-          if (
-            typeof currentOption === "string" &&
-            currentOption.trim().length === 0
-          )
-            return;
-          inputs.options[currentOption] = [true];
-        }
-      });
-    }
-
-    // Reading checkboxes
-    if (typeof ovc.c === "object") {
-      Object.keys(ovc.c).forEach((id) => {
-        const currentCheckbox = ovc.c[id];
-        if (typeof id === "string" && id.trim().length === 0) return;
-        // If it's a multiple
-        if (Array.isArray(currentCheckbox)) {
-          inputs.options[id] = currentCheckbox;
-        } else {
-          inputs.options[id] = [currentCheckbox];
-        }
-      });
-    }
-
-    // Reading variables
-    if (typeof ovc.v === "object") {
-      Object.keys(ovc.v).forEach((id) => {
-        const currentVariable = ovc.v[id];
-
-        // If it's a multiple
-        if (Array.isArray(currentVariable)) {
-          inputs.variables[id] = currentVariable;
-          // Getting parentsTree & parent id
-          const parentsTree = references.relations.variables[id].parents;
-          const parentOption =
-            inputs.options[`${parentsTree[parentsTree.length - 1]}`];
-          if (Array.isArray(parentOption)) {
-            const occurences = parentOption.length;
-            if (currentVariable.length < occurences) {
-              inputs.variables[id] = [
-                ...currentVariable,
-                ...Array(occurences - currentVariable.length).fill(""),
-              ];
-            }
-          }
-        } else {
-          inputs.variables[id] = [currentVariable];
-        }
-      });
-    }
-
-    return inputs;
-  }
-
-  public convertToOvc(inputs: StateType.Inputs) {
-    const ovc: OvcType = {
-      o: {},
-      v: {},
-      c: {},
-    };
-
-    // Reading options
-    Object.keys(inputs.options).forEach((stringId) => {
-      const id = parseInt(stringId, 10);
-      const values = inputs.options[id];
-
-      // Getting parentsTree & parent id
-      const parentsTree = selectOptionParents(id);
-      const parentId = parentsTree[0];
-
-      // Getting references
-      const optionReference = selectOptionReference(id);
-      // Checking if it's a multiple
-      const rootOptionId =
-        parentsTree.length > 0 ? parentsTree[parentsTree.length - 1] : id;
-      const isMultiple =
-        parentsTree.length > 0 &&
-        selectOptionReference(rootOptionId).meta.multiple?.enabled === true;
-      const occurences = selectOptionInput(rootOptionId).length;
-
-      // If it's not a radio nor a checkbox we stop here
-      if (!["radio", "checkbox"].includes(optionReference.meta.type)) {
-        if (values.length > 1 && rootOptionId === id) {
-          ovc.o[id] = new Array(values.length).fill("");
-        }
-        return;
-      }
-
-      // Getting true indexes
-      const trueIndexes = values
-        .map((value, index) => (value === true ? index : null))
-        .filter(<T>(value: T | null): value is T => value !== null);
-
-      // Checking whether it's a radio or a checkbox
-      const isCheckbox = optionReference.meta.type === "checkbox";
-
-      if (isCheckbox === true) {
-        if (isMultiple === true) {
-          ovc.c[id] = values;
-        } else {
-          [ovc.c[id]] = values;
-        }
-      } else if (isMultiple === true) {
-        if (!Object.prototype.hasOwnProperty.call(ovc.o, parentId)) {
-          ovc.o[parentId] = new Array(occurences).fill("");
-        }
-        trueIndexes.forEach((index) => {
-          const currentOption = ovc.o[parentId];
-          if (Array.isArray(currentOption)) {
-            currentOption[index] = id;
-          }
-        });
-      } else if (values[0] === true) {
-        ovc.o[parentId] = id;
-      }
-    });
-
-    // Reading variables
-    Object.keys(inputs.variables).forEach((stringId) => {
-      const id = parseInt(stringId, 10);
-      const values = inputs.variables[id];
-
-      // Getting parentsTree & parent id
-      const parentsTree = selectVariableParents(id);
-
-      // Checking if it's a multiple
-      const isMultiple =
-        selectOptionReference(parentsTree[parentsTree.length - 1]).meta.multiple
-          ?.enabled === true;
-      const occurences = selectOptionInput(
-        parentsTree[parentsTree.length - 1]
-      ).length;
-
-      if (isMultiple === true) {
-        if (!Object.prototype.hasOwnProperty.call(ovc.o, id)) {
-          ovc.v[id] = new Array(occurences).fill("");
-        }
-        ovc.v[id] = values;
-      } else {
-        [ovc.v[id]] = values;
-      }
-    });
-
-    return ovc;
-  }
-
-  public isOvc(_obj: StateType.Inputs | OvcType) {
-    if (typeof _obj !== "object" || _obj === null) return false;
-    const ovcKeys = ["o", "v", "c"];
-    const foundKeys = Object.keys(_obj)
-      .map((key): number => (ovcKeys.includes(key) ? 1 : 0))
-      .reduce((a, b) => a + b, 0);
-
-    return foundKeys > 1;
-  }
-
-  public isOptionsVariables(_obj: StateType.Inputs | OvcType) {
-    if (typeof _obj !== "object" || _obj === null) return false;
-    const optionsVariablesKeys = ["options", "variables"];
-    const foundKeys = Object.keys(_obj)
-      .map((key): number => (optionsVariablesKeys.includes(key) ? 1 : 0))
-      .reduce((a, b) => a + b, 0);
-    return foundKeys === 2;
-  }
-
-  private pushStaticChildren(
-    inputOptions: StateType.Inputs["options"],
-    id: number | string,
-    occurences: number,
-    references: StateType.References
-  ) {
-    const result = { ...inputOptions };
-    const intId = typeof id === "number" ? id : parseInt(id, 10);
-
-    // Getting children options and variables
-    const { options } = references.relations.options[intId].children;
-
-    // Getting static children
-    const staticOptions = options.filter(
-      (childId) => references.options[childId].meta.type === "static"
-    );
-
-    staticOptions.forEach((childId) => {
-      // Creating input if it doesn't exist
-      if (!Object.prototype.hasOwnProperty.call(result, childId)) {
-        result[childId] = new Array(occurences).fill(false);
-      }
-    });
-
-    return result;
-  }
-}
-
-export const OvcConverter = new _OvcConverter();

package/src/libs/PathReader.ts

@@ -1,272 +0,0 @@
-import { createMatchSelector, RouterState } from "connected-react-router";
-import queryString from "query-string";
-import { getConfig } from "../config";
-import { StateType } from "../types/State.type";
-import { getPluginsPageAppStates } from "../PluginLoader";
-import {
-  selectAvailableSections,
-  selectAvailableAppStates,
-} from "../redux/selectors/app";
-import Globals from "../Globals";
-
-export class PathReader {
-  currentPage = 1;
-
-  currentSectionId = 1;
-
-  currentAppState = "";
-
-  currentPermalink = "";
-
-  currentView = "";
-
-  prefix = "";
-
-  currentUniqid: string | undefined = undefined;
-
-  modelVersion: string | undefined = undefined;
-
-  constructor(state: StateType) {
-    this.matchWithUniqId(state);
-    this.matchWithoutUniqId(state);
-
-    // Setting current id from state
-    if (state.app.instance.uniqid !== "") {
-      this.currentUniqid = state.app.instance.uniqid;
-    }
-  }
-
-  /**
-   * Matches paths without uniqid
-   *
-   * @param state Redux State
-   */
-  matchWithoutUniqId(state: StateType): void {
-    type RouteType = {
-      permalink: string;
-      page: string;
-      view: string;
-      prefix: string;
-      modelVersion: string;
-    };
-    const matchSelector = createMatchSelector<
-      { router: RouterState },
-      RouteType
-    >(getConfig().router.wizardPath);
-    const match = matchSelector(state);
-
-    if (match) {
-      const { permalink, page, view, prefix } = match.params;
-      const modelVersion = queryString.parse(window.location.search).version;
-      this.prefix = prefix || "";
-      this.currentPermalink = Globals.permalink || permalink;
-      this.currentPage = this.getPageNumber(page);
-      this.currentSectionId = this.getSectionId();
-      this.currentAppState = this.getAppState(page);
-      this.currentView = view;
-      this.modelVersion =
-        typeof modelVersion === "string" ? modelVersion : undefined;
-    }
-  }
-
-  /**
-   * Matches paths with uniqid
-   *
-   * @param state Redux State
-   */
-  matchWithUniqId(state: StateType): void {
-    type RouteType = {
-      permalink: string;
-      prefix: string;
-      page: string;
-      uniqid: string;
-      view: string;
-      modelVersion: string;
-    };
-    const matchSelector = createMatchSelector<
-      { router: RouterState },
-      RouteType
-    >(getConfig().router.wizardInstancePath);
-    const match = matchSelector(state);
-
-    if (match) {
-      const { permalink, page, uniqid, view, prefix } = match.params;
-      const modelVersion = queryString.parse(window.location.search).version;
-      this.currentPermalink = Globals.permalink || permalink;
-      this.prefix = prefix || "";
-      this.currentPage = this.getPageNumber(page);
-      this.currentSectionId = this.getSectionId();
-      this.currentUniqid = uniqid;
-      this.currentAppState = this.getAppState(page);
-      this.currentView = view;
-      this.modelVersion =
-        typeof modelVersion === "string" ? modelVersion : undefined;
-    }
-  }
-
-  /**
-   * Returns given pages app state name
-   * @param page Page
-   */
-  getAppState(page: string) {
-    const appStatesPages = this.getAppStatesPages();
-
-    // Initiating current app State with wizard
-    // so that we always fall back to it in case
-    // we don't find the app state
-    let currentAppState = "wizard";
-
-    // Looking for the app state
-    Object.keys(appStatesPages).forEach((appState) => {
-      if (appStatesPages[appState] === page) currentAppState = appState;
-    });
-
-    return currentAppState;
-  }
-
-  /**
-   * Recieves a page number and returns its according page name
-   * Example: email, termsheet etc...
-   * @param page
-   */
-  getPageUrlName(page: number): string {
-    const pagesArray = this.getPagination().pages;
-    if (page > pagesArray.length) return `${pagesArray[pagesArray.length - 1]}`;
-    return `${pagesArray[page - 1]}`;
-  }
-
-  /**
-   * Returns current page number from page slug
-   * @param page Page
-   */
-  getPageNumber(page: string) {
-    const { pages } = this.getPagination();
-    const parsedPage = Number.isNaN(parseInt(page, 10))
-      ? page
-      : parseInt(page, 10);
-
-    return pages.indexOf(parsedPage) + 1 || 1;
-  }
-
-  /**
-   * Returns currentSectionId
-   * @param page Page number
-   */
-  getSectionId(page: number = this.currentPage) {
-    const availableSections = selectAvailableSections();
-    const { appStates } = this.getPagination();
-    const pageIndex = page - 1;
-
-    let availableSectionsIndex = 0;
-
-    if (appStates[pageIndex] === "wizard")
-      availableSectionsIndex = pageIndex - appStates.indexOf("wizard");
-
-    return availableSections[availableSectionsIndex];
-  }
-
-  /**
-   * Returns an array containing pages names in
-   * the correct order of pagination
-   */
-  getPagination() {
-    const availableAppStates = selectAvailableAppStates();
-
-    let pages: (string | number)[] = [];
-    let appStates: string[] = [];
-    availableAppStates.forEach((currentAppState) => {
-      if (currentAppState === "wizard")
-        selectAvailableSections().forEach(() => {
-          pages = [...pages, pages.length + 1];
-          appStates = [...appStates, "wizard"];
-        });
-      else if (
-        Object.prototype.hasOwnProperty.call(
-          this.getAppStatesPages(),
-          currentAppState
-        )
-      ) {
-        pages = [...pages, this.getAppStatesPages()[currentAppState]];
-        appStates = [...appStates, currentAppState];
-      } else {
-        pages = [...pages, pages.length + 1];
-        appStates = [...appStates, currentAppState];
-      }
-    });
-
-    return {
-      pages,
-      appStates,
-    };
-  }
-
-  /**
-   * Returns all liste of appStates with their
-   * corresponding page name
-   */
-  getAppStatesPages() {
-    // Default Global AppStates pages
-    const globalAppStates: Record<string, string> =
-      getConfig().router.appStatesPages || {};
-
-    // Plugins AppStates pages
-    const pluginsAppStates = getPluginsPageAppStates();
-
-    return {
-      ...globalAppStates,
-      ...pluginsAppStates,
-    };
-  }
-
-  /**
-   * Recieves page number, uniqid & modelVersion & parses the right path
-   * according to those
-   * @param page Page Number
-   * @param uniqid Document's uniqid
-   * @param modelVersion Model's version
-   */
-  parsePath(
-    page: number = this.currentPage,
-    uniqid = this.currentUniqid,
-    modelVersion = this.modelVersion
-  ): string {
-    let path =
-      uniqid === undefined
-        ? getConfig().router.wizardPath
-        : getConfig().router.wizardInstancePath;
-
-    // Replacing Permalink
-    path = path.replace(/:permalink(\(([^/]*)\))?/gi, this.currentPermalink);
-
-    // Replacing Permalink
-    if (this.prefix)
-      path = path.replace(/:prefix\?(\(([^/]*)\))?/gi, this.prefix);
-    else path = path.replace(/\/:prefix\?(\(([^/]*)\))?/gi, "");
-    // Replacing page
-    path = path.replace(/:page(\(([^/]*)\))?\??/gi, this.getPageUrlName(page));
-
-    if (uniqid !== undefined) {
-      // Replacing Uniqid
-      path = path.replace(/:uniqid(\(([^/]*)\))?/gi, uniqid);
-    }
-
-    if (modelVersion !== undefined) {
-      // Replacing Uniqid
-      path += `?version=${modelVersion}`;
-    }
-
-    // Replacing view
-    path = path.replace(/:view(\(([^/]*)\))?/gi, this.currentView);
-
-    // Adding other additionnal query params
-    const queryParams = queryString.parse(window.location.search);
-    if (queryParams.version !== undefined) delete queryParams.version;
-    const cleanQueryString = queryString.stringify(queryParams);
-    if (cleanQueryString.length > 0) {
-      path += modelVersion === undefined ? "?" : "&";
-      path += cleanQueryString;
-    }
-
-    return path;
-  }
-}

package/src/libs/SectionValidity.test.ts

@@ -1,146 +0,0 @@
-import { SectionValidity } from './SectionValidity';
-import { StateType } from '../types/State.type';
-
-const mockInputs: StateType.Inputs = {
-  options: {
-    1: [true],
-    2: [true],
-    3: [true],
-    1032: [true],
-  },
-  variables: {},
-};
-
-const mockReferences: {
-  sections: StateType.References.Sections;
-  options: StateType.References.Options;
-} = {
-  sections: {
-    main: {
-      1: {
-        id: 1,
-        label: 'Section 1 - Valid Section',
-        options: [1],
-      },
-      2: {
-        id: 2,
-        label: 'Section 2 - Unvalid Section',
-        options: [2],
-      },
-      3: {
-        id: 3,
-        label: 'Section 3 - Has inexistant child',
-        options: [1032],
-      },
-    },
-  },
-  options: {
-    1: {
-      meta: {
-        type: 'checkbox',
-        id: 1,
-        label: 'Option 1',
-        step: '*',
-      },
-      options: [],
-      variables: [1],
-    },
-    2: {
-      meta: {
-        type: 'checkbox',
-        id: 2,
-        label: 'Option 2',
-        step: '*',
-      },
-      options: [3],
-      variables: [2],
-    },
-    3: {
-      meta: {
-        type: 'checkbox',
-        id: 3,
-        label: 'Option 3',
-        step: '*',
-      },
-      options: [],
-      variables: [],
-    },
-  },
-};
-
-const mockConditions: {
-  options: StateType.Conditions.Options;
-  variables: StateType.Conditions.Variables;
-  validators: StateType.Conditions.Validators;
-} = {
-  options: {
-    1: [true],
-    2: [true],
-    3: [true],
-  },
-  variables: {
-    1: [true],
-    2: [true],
-  },
-  validators: {
-    options: {
-      1: [true],
-      2: [true],
-      3: [false],
-    },
-    variables: {
-      1: [true],
-      2: [false],
-    },
-  },
-};
-
-// ../redux/selectors/inputs.ts
-jest.mock('../redux/selectors/inputs', () => ({
-  __esModule: true,
-  selectOptionInput: (id: number) => mockInputs.options[id],
-  selectOptionInputByIndex: (id: number, index: number) =>
-    mockInputs.options[id][index],
-}));
-
-// ../redux/selectors/references.ts
-jest.mock('../redux/selectors/references', () => ({
-  __esModule: true,
-  selectSectionReference: (id: number) => mockReferences.sections.main[id],
-  selectOptionReference: (id: number) => mockReferences.options[id],
-}));
-
-// ../redux/selectors/conditions.ts
-jest.mock('../redux/selectors/conditions', () => ({
-  __esModule: true,
-  selectOptionConditionValue: (id: number, index: number) =>
-    mockConditions.options[id][index],
-  selectOptionValidatorConditionValue: (id: number, index: number) =>
-    mockConditions.validators.options[id][index],
-  selectVariableConditionValue: (id: number, index: number) =>
-    mockConditions.variables[id][index],
-  selectVariableValidatorConditionValue: (id: number, index: number) =>
-    mockConditions.validators.variables[id][index],
-}));
-
-describe('SectionValidity library test suit', () => {
-  it('Checks valid section', () => {
-    expect(new SectionValidity(1).validity).toBeTruthy();
-  });
-
-  it('Checks unvalid section', () => {
-    expect(new SectionValidity(2).validity).toBeFalsy();
-  });
-
-  it('Should throw an error if option reference does not exist', () => {
-    expect(() => new SectionValidity(3).validity).toThrowError(
-      'Option 1032 does not exist'
-    );
-  });
-
-  it('Should throw an error if section does not exist', () => {
-    expect(() => new SectionValidity(4).validity).toThrowError(
-      'Section 4 does not exist'
-    );
-  });
-});