@legalplace/wizardx-core 0.0.1-alpha.0

package/src/types/Actions.type.ts

@@ -0,0 +1,604 @@
+import type {
+  ModelV3,
+  OptionV3,
+  VariableV3,
+} from '@legalplace/models-v3-types';
+import { StateType } from './State.type';
+import {
+  UPDATE_AVAILABLE_SECTIONS,
+  UPDATE_AVAILABLE_APPSTATES,
+  GO_PREVIOUS_PAGE,
+  GO_NEXT_PAGE,
+  GO_PAGE,
+  INIT_PAGINATION,
+  UPDATE_INSTANCE_PAID,
+  INIT_INSTANCE,
+  UPDATE_INSTANCE,
+  INIT_META,
+  UPDATE_CURRENT_APPSTATE,
+  UPDATE_CURRENT_SECTION_ID,
+  FETCH_MODEL_SUCCEEDED,
+  FETCH_MODEL_FAILED,
+  SET_DATA_STATUS,
+  SET_FETCH_STATUS,
+  INIT_CUSTOMIZATION_META,
+  FETCH_MODEL_UNHEALTHY,
+  FETCH_MODEL_USER_LOCKED,
+  INIT_CUSTOMIZATION_AUTO_DEFAULT,
+  FETCH_MODEL_NONBLOCKING,
+  SET_MODEL_UUID,
+} from '../redux/constants/app';
+import {
+  INIT_USER,
+  SET_USER_STATUS,
+  SET_USER_VALID_TOKEN,
+} from '../redux/constants/user';
+import {
+  INIT_REFERENCES,
+  UPDATE_VARIABLE_META,
+  UPDATE_OPTION_META,
+} from '../redux/constants/references';
+import {
+  INIT_OPTION,
+  UPDATE_OPTION_INPUT,
+  INIT_VARIABLE,
+  UPDATE_VARIABLE_INPUT,
+  ADD_MULTIPLE_OCCURENCY,
+  DELETE_MULTIPLE_OCCURENCY,
+} from '../redux/constants/inputs';
+import {
+  INIT_CONDITIONS,
+  UPDATE_OPTION_CONDITION,
+  UPDATE_VARIABLE_CONDITION,
+  UPDATE_SECTION_CONDITION,
+  UPDATE_PREFILLER_CONDITION,
+  UPDATE_OPTION_VALIDATOR_CONDITION,
+  UPDATE_VARIABLE_VALIDATOR_CONDITION,
+  UPDATE_DOCUMENT_CONDITION,
+} from '../redux/constants/conditions';
+import {
+  FETCH_MODEL,
+  FETCH_MODEL_PREREQUISITES,
+} from '../redux/constants/sagas/model';
+import { SAVE_DATA } from '../redux/constants/sagas/data';
+import {
+  SET_USER_EMAIL,
+  SET_USER_EMAIL_SUCCEEDED,
+} from '../redux/constants/sagas/user';
+import {
+  SET_MANDATORY_IGNORE,
+  SET_MANDATORY_SECTION,
+  SET_MANDATORY_OPTION,
+  SET_MANDATORY_VARIABLE,
+  INIT_MANDATORY_OPTION,
+  INIT_MANDATORY_VARIABLE,
+} from '../redux/constants/mandatories';
+import {
+  ENABLE_SMARTSCRIPT,
+  INIT_SMARTSCRIPT_TRIGGERS,
+  UPDATE_SMARTSCRIPT_OPTION_HIDDEN,
+  UPDATE_SMARTSCRIPT_VARIABLE_HIDDEN,
+} from '../redux/constants/smartscript';
+import { PathReader } from '../libs/PathReader';
+import { WizardConfigResponse } from './api.type';
+
+/**
+ * Actions types
+ */
+export namespace ActionsType {
+  // App
+  export namespace App {
+    // INIT_META ACTION
+    export interface initMeta extends Omit<StateType.App.Meta, 'fetchStatus'> {
+      type: typeof INIT_META;
+    }
+    // SET_MODEL_UUID ACTION
+    export interface setModelUuid
+      extends Pick<StateType.App.Meta, 'modelUuid'> {
+      type: typeof SET_MODEL_UUID;
+    }
+
+    // FETCH_MODEL_SUCCEEDED
+    export interface fetchModelSucceeded {
+      type: typeof FETCH_MODEL_SUCCEEDED;
+    }
+
+    // FETCH_MODEL_NONBLOCKING
+    export interface fetchModelNonBlocking {
+      type: typeof FETCH_MODEL_NONBLOCKING;
+    }
+
+    // FETCH_MODEL_UNHEALTHY
+    export interface fetchModelUnhealthy
+      extends Pick<StateType.App.Meta, 'report'> {
+      type: typeof FETCH_MODEL_UNHEALTHY;
+    }
+
+    // FETCH_MODEL_USER_LOCKED
+    export interface fetchModelUserLocked
+      extends Pick<StateType.App.Meta, 'report'> {
+      type: typeof FETCH_MODEL_USER_LOCKED;
+    }
+
+    // FETCH_MODEL_FAILED
+    export interface fetchModelFailed {
+      type: typeof FETCH_MODEL_FAILED;
+    }
+
+    // INIT_INSTANCE ACTION
+    export interface initInstance extends StateType.App.Instance {
+      type: typeof INIT_INSTANCE;
+    }
+
+    // UPDATE_INSTANCE ACTION
+    export interface updateInstance extends Partial<StateType.App.Instance> {
+      type: typeof UPDATE_INSTANCE;
+    }
+
+    // UPDATE_INSTANCE_PAID
+    export interface updateInstancePaid {
+      type: typeof UPDATE_INSTANCE_PAID;
+      isPaid: boolean;
+    }
+
+    // SET_DATA_STATUS
+    export interface setDataStatus {
+      type: typeof SET_DATA_STATUS;
+      dataStatus: 'saved' | 'unsaved' | 'saving' | 'failed';
+    }
+
+    export interface setFetchStatus {
+      type: typeof SET_FETCH_STATUS;
+      fetchStatus:
+        | 'waiting'
+        | 'succeeded'
+        | 'failed'
+        | 'unhealthy'
+        | 'userLocked';
+    }
+
+    // INIT_PAGINATION
+    export type AppPaginationWithoutIsFirstPage = Omit<
+      StateType.App.Pagination,
+      'isFirstPage'
+    >;
+    export type AppPaginationWithoutIsLastPage = Omit<
+      AppPaginationWithoutIsFirstPage,
+      'isLastPage'
+    >;
+    export type AppPaginationWithoutTotalPages = Omit<
+      AppPaginationWithoutIsLastPage,
+      'totalPages'
+    >;
+    export interface initPagination
+      extends AppPaginationWithoutTotalPages,
+        StateType.App.Wizard {
+      type: typeof INIT_PAGINATION;
+    }
+
+    // GO_PAGE
+    export interface goPage {
+      type: typeof GO_PAGE;
+      currentPage: number;
+      pushHistory: boolean;
+    }
+
+    // GO_NEXT_PAGE
+    export interface goNextPage {
+      type: typeof GO_NEXT_PAGE;
+    }
+
+    // GO_PREVIOUS_PAGE
+    export interface goPreviousPage {
+      type: typeof GO_PREVIOUS_PAGE;
+    }
+
+    // UPDATE_AVAILABLE_SECTIONS
+    export interface updateAvailableSections {
+      type: typeof UPDATE_AVAILABLE_SECTIONS;
+      availableSections: StateType.App.Wizard['availableSections'];
+    }
+
+    // UPDATE_AVAILABLE_APPSTATES
+    export interface updateAvailableAppStates {
+      type: typeof UPDATE_AVAILABLE_APPSTATES;
+      availableAppStates: StateType.App.Pagination['availableAppStates'];
+      ingorePluginAppStateReset: boolean;
+    }
+
+    // UPDATE_CURRENT_APPSTATE
+    export interface updateCurrentAppState {
+      type: typeof UPDATE_CURRENT_APPSTATE;
+      currentAppState: string;
+    }
+
+    // UPDATE_CURRENT_SECTION_ID
+    export interface updateCurrentSectionId {
+      type: typeof UPDATE_CURRENT_SECTION_ID;
+      currentSectionId: number;
+    }
+
+    // INIT_CUSTOMIZATION_META
+    export interface initCustomizationMeta {
+      type: typeof INIT_CUSTOMIZATION_META;
+      meta: Exclude<ModelV3['customization']['meta'], undefined>;
+    }
+
+    // INIT_CUSTOMIZATION_AUTO_DEFAULT
+    export interface initCustomizationAutoDefault {
+      type: typeof INIT_CUSTOMIZATION_AUTO_DEFAULT;
+      disableAutoDefault: StateType.App.Customization['disableAutoDefault'];
+    }
+  }
+
+  // User
+  export namespace User {
+    // INIT_USER
+    export interface initUser extends Omit<StateType.User, 'status'> {
+      type: typeof INIT_USER;
+    }
+
+    // SET_USER_STATUS
+    export interface setUserStatus {
+      type: typeof SET_USER_STATUS;
+      status: StateType.User['status'];
+    }
+
+    export interface setUserValidToken {
+      type: typeof SET_USER_VALID_TOKEN;
+      validToken: StateType.User['validToken'];
+    }
+
+    // SET_USER_EMAIL
+    export interface setUserEmail {
+      type: typeof SET_USER_EMAIL;
+      email: StateType.User['email'];
+      disableRedirect?: boolean;
+      tags?: Record<string, string>;
+      inBackground?: boolean;
+    }
+
+    export interface setUserEmailSucceeded {
+      type: typeof SET_USER_EMAIL_SUCCEEDED;
+    }
+  }
+
+  // References
+  export namespace References {
+    // INIT_REFERENCES
+    export interface initReferences extends StateType.References {
+      type: typeof INIT_REFERENCES;
+    }
+
+    // UPDATE_VARIABLE_META
+    export interface VariableUpdatableMeta
+      extends Omit<
+        VariableV3,
+        | 'id'
+        | 'label'
+        | 'step'
+        | 'type'
+        | 'prefillings'
+        | 'conditions'
+        | 'validator'
+      > {
+      label?: string;
+      step?: '*' | number[];
+      validator?: {
+        message?: string;
+      };
+    }
+
+    export interface updateVariableMeta {
+      type: typeof UPDATE_VARIABLE_META;
+      id: number;
+      meta: VariableUpdatableMeta;
+    }
+
+    // UPDATE_OPTION_META
+    export interface OptionUpdatableMeta
+      extends Omit<
+        OptionV3['meta'],
+        | 'id'
+        | 'label'
+        | 'step'
+        | 'type'
+        | 'conditions'
+        | 'repeatOption'
+        | 'validator'
+        | 'multiple'
+      > {
+      label?: string;
+      step?: '*' | number[];
+      validator?: {
+        message?: string;
+      };
+      multiple?: {
+        cta?: string;
+        label?: string;
+        incrementationStart?: number;
+      };
+    }
+
+    export interface updateOptionMeta {
+      type: typeof UPDATE_OPTION_META;
+      id: number;
+      meta: OptionUpdatableMeta;
+    }
+  }
+
+  // Inputs
+  export namespace Inputs {
+    // INIT_OPTION
+    export interface initOption {
+      type: typeof INIT_OPTION;
+      id: number;
+      values: boolean[];
+    }
+
+    // UPDATE_OPTION_INPUT
+    export interface updateOptionInput {
+      type: typeof UPDATE_OPTION_INPUT;
+      id: number;
+      value: boolean;
+      index: number;
+    }
+
+    // INIT_VARIABLE
+    export interface initVariable {
+      type: typeof INIT_VARIABLE;
+      id: number;
+      values: (string | number)[];
+    }
+
+    // UPDATE_VARIABLE_INPUT
+    export interface updateVariableInput {
+      type: typeof UPDATE_VARIABLE_INPUT;
+      id: number;
+      value: string | number;
+      index: number;
+    }
+
+    // ADD_MULTIPLE_OCCURENCY
+    export interface addMultipleOccurency {
+      type: typeof ADD_MULTIPLE_OCCURENCY;
+      id: number;
+      optionRelations?: StateType.References.Relations.Options;
+      optionsReferences?: Record<string, StateType.References.Options.Option>;
+      prefillersVariables?: Record<
+        string,
+        StateType.References.Variables.Variable['prefillings']
+      >;
+    }
+
+    // DELETE_MULTIPLE_OCCURENCY
+    export interface deleteMultipleOccurency {
+      type: typeof DELETE_MULTIPLE_OCCURENCY;
+      id: number;
+      index: number;
+      optionRelations?: StateType.References.Relations.Options;
+    }
+  }
+
+  // Mandatories
+  export namespace Mandatories {
+    // SET_MANDATORY_IGNORE
+    export interface setMandatoryIgnore {
+      type: typeof SET_MANDATORY_IGNORE;
+      value: boolean;
+    }
+
+    // INIT_MANDATORY_OPTION
+    export interface initMandatoryOption {
+      type: typeof INIT_MANDATORY_OPTION;
+      id: number;
+      value: boolean[];
+    }
+
+    // INIT_MANDATORY_VARIABLE
+    export interface initMandatoryVariable {
+      type: typeof INIT_MANDATORY_VARIABLE;
+      id: number;
+      value: boolean[];
+    }
+
+    // SET_MANDATORY_SECTION
+    export interface setMandatorySection {
+      type: typeof SET_MANDATORY_SECTION;
+      id: number;
+      value: boolean;
+    }
+
+    // SET_MANDATORY_OPTION
+    export interface setMandatoryOption {
+      type: typeof SET_MANDATORY_OPTION;
+      id: number;
+      index: number;
+      value: boolean;
+    }
+
+    // SET_MANDATORY_VARIABLE
+    export interface setMandatoryVariable {
+      type: typeof SET_MANDATORY_VARIABLE;
+      id: number;
+      index: number;
+      value: boolean;
+    }
+  }
+
+  // Conditions
+  export namespace Conditions {
+    // INIT_CONDITIONS
+    export interface initConditions extends StateType.Conditions {
+      type: typeof INIT_CONDITIONS;
+    }
+
+    // UPDATE_OPTION_CONDITION
+    export interface updateOptionCondition {
+      type: typeof UPDATE_OPTION_CONDITION;
+      id: number;
+      index: number;
+      value: boolean;
+    }
+
+    // UPDATE_VARIABLE_CONDITION
+    export interface updateVariableCondition {
+      type: typeof UPDATE_VARIABLE_CONDITION;
+      id: number;
+      index: number;
+      value: boolean;
+    }
+
+    // UPDATE_DOCUMENT_CONDITION
+    export interface updateDocumentCondition {
+      type: typeof UPDATE_DOCUMENT_CONDITION;
+      name: string;
+      value: boolean;
+    }
+
+    // UPDATE_SECTION_CONDITION
+    export interface updateSectionCondition {
+      type: typeof UPDATE_SECTION_CONDITION;
+      document: string;
+      id: number;
+      value: boolean;
+    }
+
+    // UPDATE_PREFILLER_CONDITION
+    export interface updatePrefillerCondition {
+      type: typeof UPDATE_PREFILLER_CONDITION;
+      id: number;
+      index: number;
+      value: boolean[];
+    }
+
+    // UPDATE_OPTION_VALIDATOR_CONDITION
+    export interface updateOptionValidatorCondition {
+      type: typeof UPDATE_OPTION_VALIDATOR_CONDITION;
+      id: number;
+      index: number;
+      value: boolean;
+    }
+
+    // UPDATE_VARIABLE_VALIDATOR_CONDITION
+    export interface updateVariableValidatorCondition {
+      type: typeof UPDATE_VARIABLE_VALIDATOR_CONDITION;
+      id: number;
+      index: number;
+      value: boolean;
+    }
+  }
+
+  // Sagas
+  export namespace Sagas {
+    // Fetch model saga
+    export namespace Model {
+      // FETCH_MODEL_PREREQUISITES action
+      export interface fetchModelPrerequisites {
+        type: typeof FETCH_MODEL_PREREQUISITES;
+        permalink: string;
+        prefix: string;
+      }
+
+      // FETCH_MODEL action
+      export interface fetchModel {
+        type: typeof FETCH_MODEL;
+        permalink: string;
+        prefix: string;
+        uniqid?: string;
+        uniqidParam?: string;
+        queryParams: URLSearchParams;
+        pathReader: PathReader;
+        urlParams: URLSearchParams;
+        clientConfigReturnValue: {
+          appStates: string[];
+          enableShadowInstance: boolean;
+        };
+        wizardConfig: WizardConfigResponse;
+        callback?: () => Promise<any>;
+        firstCurrentAppState?: string;
+      }
+    }
+
+    // Save data saga
+    export namespace Data {
+      // SAVE_DATA action
+      export interface saveData {
+        type: typeof SAVE_DATA;
+        confirmAnswer?: boolean;
+        redirect: boolean;
+        redirectFallback?: string;
+        additionalProperties?: Record<string, number | string>;
+      }
+    }
+  }
+
+  // SmartScript
+  export namespace SmartScript {
+    // ENABLE_SMARTSCRIPT
+    export interface enableSmartScript {
+      type: typeof ENABLE_SMARTSCRIPT;
+    }
+
+    // INIT_SMARTSCRIPT_TRIGGERS
+    export interface initSmartscriptTriggers {
+      type: typeof INIT_SMARTSCRIPT_TRIGGERS;
+      triggers: StateType.SmartScript['triggers'];
+    }
+
+    // UPDATE_SMARTSCRIPT_OPTION_HIDDEN
+    export interface updateSmartscriptOptionHidden {
+      type: typeof UPDATE_SMARTSCRIPT_OPTION_HIDDEN;
+      id: number;
+      index: number;
+      hide: boolean;
+    }
+
+    // UPDATE_SMARTSCRIPT_VARIABLE_HIDDEN
+    export interface updateSmartscriptVariableHidden {
+      type: typeof UPDATE_SMARTSCRIPT_VARIABLE_HIDDEN;
+      id: number;
+      index: number;
+      hide: boolean;
+    }
+  }
+}
+
+/**
+ * Concatenated actions types
+ */
+export type ConditionsActions =
+  | ActionsType.Conditions.initConditions
+  | ActionsType.Conditions.updateOptionCondition
+  | ActionsType.Conditions.updateVariableCondition
+  | ActionsType.Conditions.updateSectionCondition
+  | ActionsType.Conditions.updateVariableValidatorCondition
+  | ActionsType.Conditions.updatePrefillerCondition
+  | ActionsType.Conditions.updateOptionValidatorCondition;
+
+export type UserActions =
+  | ActionsType.User.initUser
+  | ActionsType.User.setUserStatus;
+
+export type ReferencesActions =
+  | ActionsType.References.initReferences
+  | ActionsType.References.updateOptionMeta
+  | ActionsType.References.updateVariableMeta;
+
+export type InputsActions =
+  | ActionsType.Inputs.initVariable
+  | ActionsType.Inputs.updateVariableInput
+  | ActionsType.Inputs.initOption
+  | ActionsType.Inputs.updateOptionInput;
+
+export type MandatoriesActions =
+  | ActionsType.Mandatories.initMandatoryOption
+  | ActionsType.Mandatories.initMandatoryVariable
+  | ActionsType.Mandatories.setMandatoryIgnore
+  | ActionsType.Mandatories.setMandatorySection
+  | ActionsType.Mandatories.setMandatoryOption
+  | ActionsType.Mandatories.setMandatoryVariable;
+
+export type SmartScriptActions =
+  | ActionsType.SmartScript.enableSmartScript
+  | ActionsType.SmartScript.initSmartscriptTriggers;