@legalplace/wizardx-core 0.0.1-alpha.0

package/src/redux/actions/app.ts

@@ -0,0 +1,249 @@
+import type { ModelV3 } from '@legalplace/models-v3-types';
+import { StateType } from '../../types/State.type';
+import { ActionsType } from '../../types/Actions.type';
+import {
+  INIT_META,
+  INIT_INSTANCE,
+  UPDATE_INSTANCE_PAID,
+  INIT_PAGINATION,
+  GO_PAGE,
+  GO_NEXT_PAGE,
+  GO_PREVIOUS_PAGE,
+  UPDATE_AVAILABLE_SECTIONS,
+  UPDATE_CURRENT_APPSTATE,
+  UPDATE_CURRENT_SECTION_ID,
+  FETCH_MODEL_SUCCEEDED,
+  FETCH_MODEL_FAILED,
+  SET_DATA_STATUS,
+  UPDATE_AVAILABLE_APPSTATES,
+  INIT_CUSTOMIZATION_META,
+  FETCH_MODEL_UNHEALTHY,
+  FETCH_MODEL_USER_LOCKED,
+  INIT_CUSTOMIZATION_AUTO_DEFAULT,
+  UPDATE_INSTANCE,
+  SET_FETCH_STATUS,
+  FETCH_MODEL_NONBLOCKING,
+  SET_MODEL_UUID,
+} from '../constants/app';
+
+/**
+ * Meta initialization action
+ * @param meta An object containing the document's id, permalink & title
+ */
+export const initMetaAction = (
+  meta: Omit<StateType.App.Meta, 'fetchStatus'>
+): ActionsType.App.initMeta => ({
+  type: INIT_META,
+  ...meta,
+});
+
+/**
+ * Returns a set Model Uuid action
+ */
+export const setModelUuidAction = (
+  modelUuid: StateType.App.Meta['modelUuid']
+): ActionsType.App.setModelUuid => ({
+  type: SET_MODEL_UUID,
+  modelUuid,
+});
+
+/**
+ * Returns a fetch model succeeded action
+ */
+export const fetchModelSucceededAction =
+  (): ActionsType.App.fetchModelSucceeded => ({
+    type: FETCH_MODEL_SUCCEEDED,
+  });
+
+/**
+ * Returns a fetch model succeeded action
+ */
+export const fetchModelNonBlockingAction =
+  (): ActionsType.App.fetchModelNonBlocking => ({
+    type: FETCH_MODEL_NONBLOCKING,
+  });
+
+/**
+ * Returns a fetch model succeeded action
+ */
+export const fetchModelUnhealthyAction = (
+  report: StateType.App.Meta['report']
+): ActionsType.App.fetchModelUnhealthy => ({
+  type: FETCH_MODEL_UNHEALTHY,
+  report,
+});
+
+/**
+ * Returns a fetch model succeeded action
+ */
+export const fetchModelUserLockedAction =
+  (): ActionsType.App.fetchModelUserLocked => ({
+    type: FETCH_MODEL_USER_LOCKED,
+  });
+
+/**
+ * Returns a fetch model failed action
+ */
+export const fetchModelFailedAction = (): ActionsType.App.fetchModelFailed => ({
+  type: FETCH_MODEL_FAILED,
+});
+
+/**
+ * Instance initialization action
+ * @param instance An object containing the instance's uniqid
+ * & isPaid a boolean to define if document is paid or not
+ */
+export const setDataStatus = (
+  dataStatus: 'saved' | 'unsaved' | 'saving' | 'failed'
+): ActionsType.App.setDataStatus => ({
+  type: SET_DATA_STATUS,
+  dataStatus,
+});
+
+/**
+ * Update Fetch Status in case of post fetchModel fetching
+ */
+export const setFetchStatus = (
+  fetchStatus: 'waiting' | 'succeeded' | 'failed' | 'unhealthy' | 'userLocked'
+): ActionsType.App.setFetchStatus => ({
+  type: SET_FETCH_STATUS,
+  fetchStatus,
+});
+
+// eslint-disable-next-line max-len
+export const initInstanceAction = (
+  instance: StateType.App.Instance
+): ActionsType.App.initInstance => ({
+  type: INIT_INSTANCE,
+  ...instance,
+});
+
+export const updateInstanceAction = (
+  instance: Partial<StateType.App.Instance>
+): ActionsType.App.updateInstance => ({
+  type: UPDATE_INSTANCE,
+  ...instance,
+});
+
+/**
+ * Update instance paid status
+ * @param isPaid A boolean defining if document is paid or not
+ */
+export const updateInstancePaidAction = (
+  isPaid: boolean
+): ActionsType.App.updateInstancePaid => ({
+  type: UPDATE_INSTANCE_PAID,
+  isPaid,
+});
+
+/**
+ * Initiates pagination
+ * @param pagination An object containing currentPage, currentSectionId, availableSections
+ */
+// eslint-disable-next-line max-len
+export type initPaginationActionPropsType = Omit<
+  ActionsType.App.initPagination,
+  'type'
+>;
+export const initPaginationAction = (
+  pagination: initPaginationActionPropsType
+): ActionsType.App.initPagination => ({
+  type: INIT_PAGINATION,
+  ...pagination,
+});
+
+/**
+ * Updates available app states
+ * @param availableAppStates Available app states array
+ */
+export const updateAvailableAppStatesAction = (
+  availableAppStates: StateType.App.Pagination['availableAppStates'],
+  ingorePluginAppStateReset = false
+): ActionsType.App.updateAvailableAppStates => ({
+  type: UPDATE_AVAILABLE_APPSTATES,
+  availableAppStates,
+  ingorePluginAppStateReset,
+});
+
+/**
+ * Move to specific page
+ * @param page Page number
+ */
+export const goPageAction = (
+  page: number,
+  pushHistory = true
+): ActionsType.App.goPage => ({
+  type: GO_PAGE,
+  currentPage: page,
+  pushHistory,
+});
+
+/**
+ * Move to next page
+ */
+export const goNextPageAction = (): ActionsType.App.goNextPage => ({
+  type: GO_NEXT_PAGE,
+});
+
+/**
+ * Move to previous page
+ */
+export const goPreviousPageAction = (): ActionsType.App.goPreviousPage => ({
+  type: GO_PREVIOUS_PAGE,
+});
+
+/**
+ * Updates current App State
+ * @param currentAppState {string}
+ */
+export const updateCurrentAppStateAction = (
+  currentAppState: string
+): ActionsType.App.updateCurrentAppState => ({
+  type: UPDATE_CURRENT_APPSTATE,
+  currentAppState,
+});
+
+/**
+ * Update available sections
+ * @param availableSections An array containing the available section's array
+ */
+// eslint-disable-next-line max-len
+export const updateAvailableSectionsAction = (
+  availableSections: number[]
+): ActionsType.App.updateAvailableSections => ({
+  type: UPDATE_AVAILABLE_SECTIONS,
+  availableSections,
+});
+
+/**
+ * Updates current section id
+ * @param currentSectionId Current section's id
+ */
+// eslint-disable-next-line max-len
+export const updateCurrentSectionIdAction = (
+  currentSectionId: number
+): ActionsType.App.updateCurrentSectionId => ({
+  type: UPDATE_CURRENT_SECTION_ID,
+  currentSectionId,
+});
+
+/**
+ * Sets extracts customizations
+ * @param extracts ExtractV3 Array
+ */
+export const initCustomizationMetaAction = (
+  meta: Exclude<ModelV3['customization']['meta'], undefined>
+): ActionsType.App.initCustomizationMeta => ({
+  type: INIT_CUSTOMIZATION_META,
+  meta,
+});
+/**
+ * Sets autoDefault customizations
+ * @param disableAutoDefault autoDefault Customization object
+ */
+export const initCustomizationAutoDefaultAction = (
+  disableAutoDefault: StateType.App.Customization['disableAutoDefault']
+): ActionsType.App.initCustomizationAutoDefault => ({
+  type: INIT_CUSTOMIZATION_AUTO_DEFAULT,
+  disableAutoDefault,
+});

package/src/redux/actions/conditions.test.ts

@@ -0,0 +1,84 @@
+import {
+  initConditionsAction,
+  updateOptionConditionsAction,
+  updateVariableConditionsAction,
+  updateSectionConditionsAction,
+  updatePrefillersConditionsAction,
+} from './conditions';
+
+describe('Conditions actions test suit', () => {
+  it('initConditions Action', () => {
+    const action = initConditionsAction({
+      options: {},
+      variables: {},
+      prefillers: {},
+      validators: {
+        options: {},
+        variables: {},
+      },
+      sections: {
+        main: {},
+      },
+      documents: {},
+    });
+
+    expect(action).toEqual({
+      type: 'INIT_CONDITIONS',
+      options: {},
+      variables: {},
+      prefillers: {},
+      validators: {
+        options: {},
+        variables: {},
+      },
+      sections: {
+        main: {},
+      },
+      documents: {},
+    });
+  });
+
+  it('updateOptionConditions Action', () => {
+    const action = updateOptionConditionsAction(1, 0, true);
+
+    expect(action).toEqual({
+      type: 'UPDATE_OPTION_CONDITION',
+      id: 1,
+      index: 0,
+      value: true,
+    });
+  });
+
+  it('updateVariableConditions Action', () => {
+    const action = updateVariableConditionsAction(1, 0, true);
+
+    expect(action).toEqual({
+      type: 'UPDATE_VARIABLE_CONDITION',
+      id: 1,
+      index: 0,
+      value: true,
+    });
+  });
+
+  it('updateSectionConditions Action', () => {
+    const action = updateSectionConditionsAction(1, 'main', true);
+
+    expect(action).toEqual({
+      type: 'UPDATE_SECTION_CONDITION',
+      id: 1,
+      document: 'main',
+      value: true,
+    });
+  });
+
+  it('updatePrefillersConditions Action', () => {
+    const action = updatePrefillersConditionsAction(1, 0, [true]);
+
+    expect(action).toEqual({
+      type: 'UPDATE_PREFILLER_CONDITION',
+      id: 1,
+      index: 0,
+      value: [true],
+    });
+  });
+});

package/src/redux/actions/conditions.ts

@@ -0,0 +1,135 @@
+import { ActionsType } from '../../types/Actions.type';
+import {
+  UPDATE_OPTION_CONDITION,
+  INIT_CONDITIONS,
+  UPDATE_VARIABLE_CONDITION,
+  UPDATE_SECTION_CONDITION,
+  UPDATE_PREFILLER_CONDITION,
+  UPDATE_OPTION_VALIDATOR_CONDITION,
+  UPDATE_VARIABLE_VALIDATOR_CONDITION,
+  UPDATE_DOCUMENT_CONDITION,
+} from '../constants/conditions';
+import { StateType } from '../../types/State.type';
+
+/**
+ * Initiates conditions
+ * @param conditions Initial condition's objecy
+ */
+export const initConditionsAction = (
+  conditions: StateType.Conditions
+): ActionsType.Conditions.initConditions => ({
+  type: INIT_CONDITIONS,
+  ...conditions,
+});
+
+/**
+ * Update condition
+ * @param index Occurency index
+ * @param value Condition's value
+ */
+export const updateOptionConditionsAction = (
+  id: number,
+  index: number,
+  value: boolean
+): ActionsType.Conditions.updateOptionCondition => ({
+  type: UPDATE_OPTION_CONDITION,
+  id,
+  index,
+  value,
+});
+
+/**
+ * Update condition
+ * @param index Occurency index
+ * @param value Condition's value
+ */
+export const updateVariableConditionsAction = (
+  id: number,
+  index: number,
+  value: boolean
+): ActionsType.Conditions.updateVariableCondition => ({
+  type: UPDATE_VARIABLE_CONDITION,
+  id,
+  index,
+  value,
+});
+
+/**
+ * Update condition
+ * @param value Condition's value
+ */
+export const updateDocumentConditionsAction = (
+  name: string,
+  index: number,
+  value: boolean
+): ActionsType.Conditions.updateDocumentCondition => ({
+  type: UPDATE_DOCUMENT_CONDITION,
+  name,
+  value,
+});
+
+/**
+ * Update condition
+ * @param index Occurency index
+ * @param value Condition's value
+ */
+export const updateSectionConditionsAction = (
+  id: number,
+  document: string,
+  value: boolean
+): ActionsType.Conditions.updateSectionCondition => ({
+  type: UPDATE_SECTION_CONDITION,
+  document,
+  id,
+  value,
+});
+
+/**
+ * Update condition
+ * @param index Occurency index
+ * @param value Condition's value
+ */
+export const updatePrefillersConditionsAction = (
+  id: number,
+  index: number,
+  value: boolean[]
+): ActionsType.Conditions.updatePrefillerCondition => ({
+  type: UPDATE_PREFILLER_CONDITION,
+  id,
+  index,
+  value,
+});
+
+/**
+ * Update condition
+ * @param index Occurency index
+ * @param value Condition's value
+ */
+// eslint-disable-next-line max-len
+export const updateOptionValidatorConditionsAction = (
+  id: number,
+  index: number,
+  value: boolean
+): ActionsType.Conditions.updateOptionValidatorCondition => ({
+  type: UPDATE_OPTION_VALIDATOR_CONDITION,
+  id,
+  index,
+  value,
+});
+
+/**
+ * Update condition
+ * @param index Occurency index
+ * @param value Condition's value
+ */
+// eslint-disable-next-line max-len
+export const updateVariableValidatorConditionsAction = (
+  id: number,
+  index: number,
+  value: boolean
+): ActionsType.Conditions.updateVariableValidatorCondition => ({
+  type: UPDATE_VARIABLE_VALIDATOR_CONDITION,
+  id,
+  index,
+  value,
+});

package/src/redux/actions/index.ts

@@ -0,0 +1,8 @@
+export * from './app';
+export * from './conditions';
+export * from './inputs';
+export * from './mandatories';
+export * from './references';
+export * from './smartscript';
+export * from './user';
+export * from './sagas';

package/src/redux/actions/inputs.test.ts

@@ -0,0 +1,85 @@
+import {
+  initOptionAction,
+  initVariableAction,
+  updateOptionAction,
+  updateVariableAction,
+  addMultipleOccurencyAction,
+  deleteMultipleOccurencyAction,
+} from './inputs';
+import {
+  UPDATE_OPTION_INPUT,
+  INIT_VARIABLE,
+  INIT_OPTION,
+  UPDATE_VARIABLE_INPUT,
+  ADD_MULTIPLE_OCCURENCY,
+  DELETE_MULTIPLE_OCCURENCY,
+} from '../constants/inputs';
+
+describe('Inputs actions test suit', () => {
+  // Init option action
+  it('initOption Action', () => {
+    const action = initOptionAction(123, [true]);
+
+    return expect(action).toStrictEqual({
+      type: INIT_OPTION,
+      id: 123,
+      values: [true],
+    });
+  });
+
+  // Init variable action
+  it('initVariable Action', () => {
+    const action = initVariableAction(123, ['']);
+
+    return expect(action).toStrictEqual({
+      type: INIT_VARIABLE,
+      id: 123,
+      values: [''],
+    });
+  });
+
+  // Update option action
+  it('updateOption Action', () => {
+    const action = updateOptionAction(123, true, 3);
+
+    return expect(action).toStrictEqual({
+      type: UPDATE_OPTION_INPUT,
+      id: 123,
+      value: true,
+      index: 3,
+    });
+  });
+
+  // Update variable action
+  it('updateVariable Action', () => {
+    const action = updateVariableAction(123, 'Hello', 1);
+
+    return expect(action).toStrictEqual({
+      type: UPDATE_VARIABLE_INPUT,
+      id: 123,
+      value: 'Hello',
+      index: 1,
+    });
+  });
+
+  // Add multiple occurency action
+  it('addMultipleOccurency Action', () => {
+    const action = addMultipleOccurencyAction(123);
+
+    return expect(action).toStrictEqual({
+      type: ADD_MULTIPLE_OCCURENCY,
+      id: 123,
+    });
+  });
+
+  // Delete multiple occurency action
+  it('deleteMultipleOccurency Action', () => {
+    const action = deleteMultipleOccurencyAction(123, 1);
+
+    return expect(action).toStrictEqual({
+      type: DELETE_MULTIPLE_OCCURENCY,
+      id: 123,
+      index: 1,
+    });
+  });
+});

package/src/redux/actions/inputs.ts

@@ -0,0 +1,95 @@
+import { ActionsType } from '../../types/Actions.type';
+import {
+  INIT_OPTION,
+  INIT_VARIABLE,
+  UPDATE_OPTION_INPUT,
+  UPDATE_VARIABLE_INPUT,
+  ADD_MULTIPLE_OCCURENCY,
+  DELETE_MULTIPLE_OCCURENCY,
+} from '../constants/inputs';
+
+/**
+ * Initiates option's input
+ * @param id Option's id
+ * @param values Option's initial values
+ */
+export const initOptionAction = (
+  id: number,
+  values: boolean[]
+): ActionsType.Inputs.initOption => ({
+  type: INIT_OPTION,
+  id,
+  values,
+});
+
+/**
+ * Updating option's input
+ * @param id option's id
+ * @param value option's value
+ * @param index occurency's index
+ */
+export const updateOptionAction = (
+  id: number,
+  value: boolean,
+  index: number
+): ActionsType.Inputs.updateOptionInput => ({
+  type: UPDATE_OPTION_INPUT,
+  id,
+  value,
+  index,
+});
+
+/**
+ * Initiates variable's input
+ * @param id Variable's id
+ * @param values Variable's initial values
+ */
+export const initVariableAction = (
+  id: number,
+  values: (string | number)[]
+): ActionsType.Inputs.initVariable => ({
+  type: INIT_VARIABLE,
+  id,
+  values,
+});
+
+/**
+ * Updating variable's input
+ * @param id variable's id
+ * @param value variable's value
+ * @param index occurency's index
+ */
+export const updateVariableAction = (
+  id: number,
+  value: string | number,
+  index: number
+): ActionsType.Inputs.updateVariableInput => ({
+  type: UPDATE_VARIABLE_INPUT,
+  id,
+  value,
+  index,
+});
+
+/**
+ * Adding multiple's occurency
+ * @param id Root option's id
+ */
+export const addMultipleOccurencyAction = (
+  id: number
+): ActionsType.Inputs.addMultipleOccurency => ({
+  type: ADD_MULTIPLE_OCCURENCY,
+  id,
+});
+
+/**
+ * Deleting multiple's occurency
+ * @param id Root option's id
+ */
+export const deleteMultipleOccurencyAction = (
+  id: number,
+  index: number
+): ActionsType.Inputs.deleteMultipleOccurency => ({
+  type: DELETE_MULTIPLE_OCCURENCY,
+  id,
+  index,
+});