@legalplace/wizardx-core 0.0.1-alpha.0

package/src/types/Components.type.ts

@@ -0,0 +1,181 @@
+import type { OptionV3, VariableV3 } from '@legalplace/models-v3-types';
+import { TermsheetRow } from './Termsheet.type';
+
+/**
+ * Progress component Props
+ */
+export interface ProgressPropsType {
+  currentSectionTitle: string;
+  currentSectionId: number;
+  currentSection: number;
+  currentPage: number;
+  greatestPage: number;
+  totalPages: number;
+}
+
+/**
+ * Pagination component Props
+ */
+export interface PaginationPropsFromState {
+  totalPages: number;
+  isFirstPage: boolean;
+  isLastPage: boolean;
+  currentPage: number;
+  nextKpmgView: string;
+}
+export interface PaginationPropsFromDispatch {
+  goNextPage: () => void;
+  goPreviousPage: () => void;
+}
+
+export type PaginationPropsType = PaginationPropsFromState &
+  PaginationPropsFromDispatch;
+
+/**
+ * DocumentTitle component Props
+ */
+export interface DocumentTitlePropsType {
+  title: string;
+}
+
+/**
+ * Section component Props
+ */
+export interface SectionPropsType {
+  id: number;
+  title: string;
+  childOptions: number[];
+  tags?: string[];
+}
+
+/**
+ * Root option component Props
+ */
+export interface RootOptionPropsFromState {
+  id: number;
+  multiple: boolean;
+  values: boolean[];
+  meta: OptionV3['meta'];
+}
+export interface RootOptionPropsFromDispatch {
+  addMultipleOccurency: () => void;
+  deleteMultipleOccurency: (index: number) => void;
+}
+
+export interface RootOptionPropsType
+  extends RootOptionPropsFromDispatch,
+    RootOptionPropsFromState {}
+
+/**
+ * Option component Props
+ */
+export interface OptionPropsFromState {
+  id: number;
+  index: number;
+  label: string;
+  type: string;
+  value: boolean;
+  condition?: boolean;
+  validator?: boolean;
+  display: boolean;
+  meta: OptionV3['meta'];
+  selectedRadioChild: number;
+  childOptions: number[];
+  childVariables: number[];
+}
+export interface OptionPropsFromDispatch {
+  updateOption: (value: boolean, id?: number, index?: number) => void;
+}
+export interface OptionPropsType
+  extends OptionPropsFromState,
+    OptionPropsFromDispatch {
+  deleteOccurency?: (() => void) | false;
+  addOccurency?: JSX.Element;
+}
+
+/**
+ * Variable component Props
+ */
+export interface VariablePropsFromState {
+  id: number;
+  index: number;
+  label: string;
+  type: string;
+  value: string | number;
+  condition: boolean | undefined;
+  validator: boolean | undefined;
+  display: boolean;
+  evalVariables?: Record<string, string | number>;
+  meta: VariableV3;
+}
+export interface VariablePropsFromDispatch {
+  updateVariable: (value: string | number) => void;
+}
+
+export interface VariablePropsType
+  extends VariablePropsFromState,
+    VariablePropsFromDispatch {
+  hideLabel?: boolean;
+  hideInput?: boolean;
+}
+
+/**
+ * Outputs props type
+ */
+export interface OutputsPropsType {
+  document: string;
+  outputs: (number | string)[][];
+  multipleOptionsOccurencies: Record<string, number>;
+}
+
+export interface SingleOutputPropsTypes {
+  id: number;
+  index: number;
+  type: string;
+  output: string;
+  condition: boolean | undefined;
+  children: number[];
+  tags?: string[];
+}
+
+/**
+ * Box props type
+ */
+export interface BoxPropsTypes {
+  id: number;
+  index: number;
+  type: string;
+  content: string;
+  boxType: string;
+  boxTitle: string;
+  boxCollapsable: boolean;
+  boxAggregatable: boolean;
+  condition?: boolean;
+  children: number[];
+  tags?: string[];
+}
+
+/**
+ * Termsheet component Props
+ */
+export interface TermsheetPropsType {
+  termsheet: TermsheetRow[];
+  parseLink: (page: number) => string;
+}
+
+/**
+ * Section component Props
+ */
+export interface SectionsSummaryPropsType {
+  sections: number[];
+}
+
+export interface SingleSectionsSummaryPropsType {
+  id: number;
+  link: string;
+  label: string;
+  validity: boolean;
+  preLabel: string;
+  active: boolean;
+  pageNumber: number;
+}

package/src/types/State.type.ts

@@ -0,0 +1,323 @@
+/* eslint-disable @typescript-eslint/no-empty-interface */
+/* eslint-disable @typescript-eslint/no-namespace */
+// eslint-disable-next-line import/no-extraneous-dependencies
+import type {
+  OptionV3,
+  VariableV3,
+  SectionV3,
+  ConditionV3,
+  ModelV3,
+} from '@legalplace/models-v3-types';
+import type { Types } from '@legalplace/referencesparser';
+
+import type { HealthCheckReport } from '@legalplace/model-healthcheck/dist/libs/HealthCheck.type';
+
+/**
+ * Wizard State's Types
+ * --------------------
+ * Note:
+ *  - If you don't know what you're doing DO NOT TOUCH THIS FILE
+ *  - If you do know what you're doing BE VERY CAREFUL WITH THE NAMINGS
+ */
+
+export type MAPPED_CONDITIONS = {
+  dataMap: {
+    o: number[];
+    v: number[];
+    c: { o: number[]; v: number[]; s: number[] };
+  };
+  conditions: ConditionV3;
+};
+
+// State type
+export interface StateType {
+  router: any;
+  app: AppType;
+  user?: UserType;
+  inputs: InputsType;
+  mandatories: MandatoriesType;
+  conditions: ConditionsType;
+  references: Types.ReferencesType;
+  smartscript: SmartScriptType;
+}
+
+export namespace StateType {
+  // State.app
+  export interface App extends AppType {}
+  export namespace App {
+    export interface Meta extends AppMetaType {}
+    export interface Instance extends AppInstanceType {}
+    export interface Pagination extends AppPaginationType {}
+    export interface Wizard extends AppWizardType {}
+    export interface Customization extends AppCustomizationType {}
+    export namespace Customization {
+      export interface meta extends AppCustomizationMetaType {}
+    }
+  }
+
+  // State.user
+  export interface User extends UserType {}
+
+  // State.inputs
+  export interface Inputs extends InputsType {}
+  export namespace Inputs {
+    export interface Options extends InputsOptionsType {}
+    export interface Variables extends InputsVariablesType {}
+  }
+
+  // State.mandatories
+  export interface Mandatories extends MandatoriesType {}
+  export namespace Mandatories {
+    export type Ignore = boolean;
+    export interface Sections extends MandatoriesSectionsType {}
+    export interface Options extends MandatoriesOptionsType {}
+    export interface Variables extends MandatoriesVariablesType {}
+  }
+
+  // State.conditions
+  export interface Conditions extends ConditionsType {}
+  export namespace Conditions {
+    export interface Options extends ConditionsOptionsType {}
+    export interface Variables extends ConditionsVariablesType {}
+    export interface Sections extends ConditionsSectionsDocumentType {}
+    export interface Prefillers extends ConditionsPrefillersType {}
+
+    export interface Validators extends ConditionsValidatorsType {}
+
+    export namespace Validators {
+      // eslint-disable-next-line @typescript-eslint/no-shadow
+      export interface Options extends ConditionsValidatorsOptionsType {}
+      // eslint-disable-next-line @typescript-eslint/no-shadow
+      export interface Variables extends ConditionsValidatorsVariablesType {}
+    }
+  }
+
+  // State.references
+  export interface References extends Types.ReferencesType {}
+  export namespace References {
+    export interface Options extends Types.ReferencesOptionsType {}
+    export namespace Options {
+      export interface Option extends OptionV3 {}
+    }
+
+    export interface Variables extends Types.ReferencesVariablesType {}
+    export namespace Variables {
+      export interface Variable extends VariableV3 {}
+    }
+
+    export interface Outputs extends Types.ReferencesOutputsType {}
+    export namespace Outputs {
+      export interface Output extends Types.ReferencesSingleOutputType {}
+    }
+    export namespace Boxes {
+      export interface Box extends Types.ReferencesSingleBoxType {}
+    }
+
+    export interface Sections extends Types.ReferencesSectionsType {}
+    export namespace Sections {
+      export interface Document extends Types.ReferencesSectionsDocumentType {}
+      export interface Section extends SectionV3 {}
+    }
+
+    export interface Relations extends Types.ReferencesRelationsType {}
+    export namespace Relations {
+      export interface Options extends Types.ReferencesRelationsOptionsType {}
+      export interface Variables
+        extends Types.ReferencesRelationsVariablesType {}
+      export interface Sections extends Types.ReferencesRelationsSectionsType {}
+    }
+
+    export interface Defaults extends Types.ReferencesDefaultsSectionType {}
+  }
+
+  // State.smartscript
+  export interface SmartScript extends SmartScriptType {}
+}
+
+/**
+ * DEFINING TYPES USED ABOVE
+ */
+
+/**
+ * State.app Types
+ */
+export interface AppType {
+  meta: AppMetaType;
+  instance: AppInstanceType;
+  pagination: AppPaginationType;
+  wizard: AppWizardType;
+  customization: AppCustomizationType;
+}
+
+export interface AppPaginationType {
+  currentAppState: string;
+  availableAppStates: string[];
+  currentPage: number;
+  greatestPage: number;
+  isFirstPage: boolean;
+  isLastPage: boolean;
+  totalPages: number;
+}
+
+export interface AppWizardType {
+  currentSectionId: number;
+  availableSections: number[];
+}
+
+export interface AppCustomizationType {
+  disableAutoDefault?: boolean;
+  meta?: AppCustomizationMetaType;
+}
+
+export type ModelV3CustomizationMeta = Exclude<
+  ModelV3['customization']['meta'],
+  undefined
+>;
+
+export interface AppCustomizationMetaType extends ModelV3CustomizationMeta {}
+
+export interface AppInstanceType {
+  dataStatus: 'saved' | 'unsaved' | 'saving' | 'failed';
+  uniqid: string;
+  companyId?: number;
+  employeeId?: number;
+  isPaid?: boolean;
+  isOrderHandled?: boolean;
+  draft?: boolean;
+  steps: '*' | number[];
+}
+
+export interface AppMetaType {
+  fetchStatus:
+    | 'waiting'
+    | 'succeeded'
+    | 'failed'
+    | 'unhealthy'
+    | 'userLocked'
+    | 'nonBlocking';
+  id: number;
+  permalink: string;
+  prefix: string;
+  title: string;
+  modelVersion: number;
+  productType: string;
+  modelUuid?: string;
+  smartScript?: string;
+  report?: {
+    object: HealthCheckReport;
+    raw: string;
+  };
+}
+
+/**
+ * State.user
+ */
+export interface UserType {
+  status: 'authenticated' | 'unauthenticated' | 'inprogress' | 'failed';
+  email: string;
+  displayName: string;
+  level: 'ADMIN' | 'MANAGER' | 'USER' | 'GUEST' | 'SUPER';
+  validToken?: boolean;
+}
+
+/**
+ * State.inputs
+ */
+export interface InputsType {
+  options: InputsOptionsType;
+  variables: InputsVariablesType;
+}
+
+export interface InputsOptionsType {
+  [key: string]: boolean[];
+}
+
+export interface InputsVariablesType {
+  [key: string]: (string | number)[];
+}
+
+/**
+ * State.mandatories
+ */
+export interface MandatoriesType {
+  ignore: boolean;
+  sections: MandatoriesSectionsType;
+  options: MandatoriesOptionsType;
+  variables: MandatoriesVariablesType;
+}
+
+export interface MandatoriesSectionsType {
+  [k: string]: boolean;
+}
+
+export interface MandatoriesOptionsType {
+  [k: string]: boolean[];
+}
+
+export interface MandatoriesVariablesType {
+  [k: string]: boolean[];
+}
+
+/**
+ * State.conditions
+ */
+export interface ConditionsType {
+  options: ConditionsOptionsType;
+  variables: ConditionsVariablesType;
+  documents: ConditionsDocumentsType;
+  sections: ConditionsSectionsType;
+  prefillers: ConditionsPrefillersType;
+  validators: ConditionsValidatorsType;
+}
+
+export interface ConditionsOptionsType {
+  [key: string]: boolean[];
+}
+
+export interface ConditionsVariablesType {
+  [key: string]: boolean[];
+}
+
+export interface ConditionsSectionsType {
+  [key: string]: ConditionsSectionsDocumentType;
+}
+
+export interface ConditionsDocumentsType {
+  [key: string]: boolean;
+}
+
+export interface ConditionsSectionsDocumentType {
+  [key: string]: boolean;
+}
+
+export interface ConditionsPrefillersType {
+  [key: string]: boolean[][];
+}
+
+export interface ConditionsValidatorsType {
+  options: ConditionsValidatorsOptionsType;
+  variables: ConditionsValidatorsVariablesType;
+}
+
+export interface ConditionsValidatorsOptionsType {
+  [key: string]: boolean[];
+}
+
+export interface ConditionsValidatorsVariablesType {
+  [key: string]: boolean[];
+}
+
+/**
+ * State.smartscript
+ */
+export interface SmartScriptType {
+  enabled: boolean;
+  triggers: {
+    options: number[];
+    variables: number[];
+  };
+  hidden: {
+    options: Record<string, number[]>;
+    variables: Record<string, number[]>;
+  };
+}

package/src/types/Termsheet.type.ts

@@ -0,0 +1,28 @@
+export interface TermsheetSection {
+  number: string;
+  label: string;
+  type: 'section';
+}
+
+export interface TermsheetOption {
+  label: string;
+  value: string;
+  type: 'option';
+}
+
+export interface TermsheetVariable {
+  label: string;
+  value: string | number;
+  type: 'variable';
+}
+
+export interface TermsheetRow {
+  pageNumber: number;
+  hash: string;
+  preLabel?: string;
+  valid?: boolean;
+  label: string;
+  value: string;
+  type: 'variable' | 'section' | 'option' | 'multiplelabel';
+  allowUpdate: boolean;
+}

package/src/types/api.type.ts

@@ -0,0 +1,37 @@
+/* eslint-disable camelcase */
+export interface IInstanceCreationResponse {
+  uniqid: string;
+  status: 'SUCCESS' | 'FAIL' | 'ERR';
+  redirect_to?: string;
+  isPaid?: boolean;
+  user?: {
+    email: string;
+    displayName: string;
+    level: 'MANAGER' | 'USER' | 'ADMIN' | 'SUPER' | 'GUEST';
+    role?: 'MANAGER' | 'USER' | 'ADMIN' | 'SUPER' | 'GUEST';
+  };
+  instanceToken?: string;
+}
+
+export interface ClientConfigResponse {
+  clientConfig: {
+    domain?: string;
+    prefix?: string;
+    shortUrl?: boolean;
+    metadata?: any;
+  };
+}
+
+export interface WizardConfigResponse {
+  modelUuid?: string;
+  redirect?: string;
+  redirectParams?: boolean;
+}
+
+export interface CreateInstanceResponse {
+  status?: string;
+  uniqid: string;
+  isPaid: boolean;
+  isOrderHandled: boolean;
+  steps: '*' | number[];
+}

package/src/types/config.type.ts

@@ -0,0 +1,51 @@
+import { IFonts } from '@legalplace/storybook';
+
+export type SideBarType = 'preview' | 'summary' | undefined;
+
+export interface IWizardParamsTheme {
+  name: string;
+  shimmer?: boolean;
+  params: {
+    ui?: {
+      topbar: {
+        previewBtn: boolean;
+        [key: string]: any;
+      };
+      [key: string]: any;
+    };
+    sidebar: {
+      default: SideBarType;
+      states: {
+        wizard?: SideBarType;
+        email?: SideBarType;
+        [key: string]: SideBarType;
+      };
+      [key: string]: any;
+    };
+    fonts?: IFonts;
+    style?: Record<string, any>;
+    [key: string]: any;
+  };
+}
+
+export interface IWizardParams {
+  apiEndpoint: string;
+  authCookieDomain?: string;
+  enableShadowInstance: boolean;
+  fixedConfig?: boolean;
+  router: {
+    wizardPath: string;
+    wizardInstancePath: string;
+    notFoundUrl: string;
+    notFoundPath?: string;
+    appStatesPages?: Record<string, string>;
+  };
+  plugins: Record<string, string>;
+  theme: IWizardParamsTheme;
+  brand?: {
+    name: string;
+  };
+  appStates: string[];
+  ovcBucket?: string;
+  documentBucket?: string;
+}

package/src/types/env.type.ts

@@ -0,0 +1,5 @@
+export namespace NodeJS {
+  export interface ProcessEnv {
+    REACT_APP_API_ENDPOINT: string;
+  }
+}

package/src/types/getActions.type.ts

@@ -0,0 +1,3 @@
+import * as connectorActions from '../redux/actions';
+
+export type ActionsConnector = typeof connectorActions;

package/src/types/getConnectors.type.ts

@@ -0,0 +1,5 @@
+import * as connectors from '../componentsConnectors';
+
+export type ConnectorProps<T extends (c: React.ComponentType<any>) => any> =
+  T extends (c: React.ComponentType<infer P>) => any ? P : {};
+export type ComponentsConnectors = typeof connectors;

package/src/types/getSelectors.type.ts

@@ -0,0 +1,3 @@
+import * as connectorSelectors from '../redux/selectors';
+
+export type SelectorsType = typeof connectorSelectors;

package/src/types/index.ts

@@ -0,0 +1,10 @@
+export * from './Actions.type';
+export * from './api.type';
+export * from './Components.type';
+export * from './config.type';
+export * from './env.type';
+export * from './getActions.type';
+export * from './getConnectors.type';
+export * from './getSelectors.type';
+export * from './State.type';
+export * from './Termsheet.type';

package/src/wizard-params.ts

@@ -0,0 +1,55 @@
+import { IWizardParams } from './types/config.type';
+
+const config: IWizardParams = {
+  apiEndpoint: process.env.REACT_APP_API_ENDPOINT || '',
+
+  // Shadow instance
+  enableShadowInstance: false,
+
+  // Routes
+  router: {
+    wizardPath: '/contrats/:prefix?/:permalink/creer/:page?',
+    wizardInstancePath:
+      '/contrats/:prefix?/:permalink/continuer/:uniqid([0-9a-zA-Z]+)/:page?',
+    notFoundUrl: '/contrats/conditions-generales-de-vente/creer',
+    appStatesPages: {
+      termsheet: 'resume',
+      email: 'email',
+    },
+  },
+
+  // Enabled plugins (this should move to the apiEndpoint first response)
+  plugins: {
+    // pluginName: '1.0.0'
+    // autosaveOnTermsheet: '1.0.0',
+    // filesDownload: '1.0.0',
+    b2c_actions: '1.0.0',
+    datalayer: '1.0.0',
+    checkoutX: '1.0.0',
+    authentication: '1.0.0',
+    // smartdocs: '1.0.0'
+  },
+
+  // Theme (this should move to the apiEndpoint first response)
+  theme: {
+    name: 'legacy',
+    params: {
+      ui: {
+        topbar: {
+          previewBtn: false,
+        },
+      },
+      sidebar: {
+        default: 'preview',
+        states: {
+          wizard: 'summary',
+          email: 'summary',
+        },
+      },
+    },
+  },
+  // App states (this should move to the apiEndpoint first response)
+  appStates: ['wizard', 'email'],
+};
+
+export default config;