@legalplace/wizardx-core 0.0.1-alpha.0

package/dist/types/State.type.d.ts

@@ -0,0 +1,265 @@
+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';
+export declare type MAPPED_CONDITIONS = {
+    dataMap: {
+        o: number[];
+        v: number[];
+        c: {
+            o: number[];
+            v: number[];
+            s: number[];
+        };
+    };
+    conditions: ConditionV3;
+};
+export interface StateType {
+    router: any;
+    app: AppType;
+    user?: UserType;
+    inputs: InputsType;
+    mandatories: MandatoriesType;
+    conditions: ConditionsType;
+    references: Types.ReferencesType;
+    smartscript: SmartScriptType;
+}
+export declare namespace StateType {
+    interface App extends AppType {
+    }
+    namespace App {
+        interface Meta extends AppMetaType {
+        }
+        interface Instance extends AppInstanceType {
+        }
+        interface Pagination extends AppPaginationType {
+        }
+        interface Wizard extends AppWizardType {
+        }
+        interface Customization extends AppCustomizationType {
+        }
+        namespace Customization {
+            interface meta extends AppCustomizationMetaType {
+            }
+        }
+    }
+    interface User extends UserType {
+    }
+    interface Inputs extends InputsType {
+    }
+    namespace Inputs {
+        interface Options extends InputsOptionsType {
+        }
+        interface Variables extends InputsVariablesType {
+        }
+    }
+    interface Mandatories extends MandatoriesType {
+    }
+    namespace Mandatories {
+        type Ignore = boolean;
+        interface Sections extends MandatoriesSectionsType {
+        }
+        interface Options extends MandatoriesOptionsType {
+        }
+        interface Variables extends MandatoriesVariablesType {
+        }
+    }
+    interface Conditions extends ConditionsType {
+    }
+    namespace Conditions {
+        interface Options extends ConditionsOptionsType {
+        }
+        interface Variables extends ConditionsVariablesType {
+        }
+        interface Sections extends ConditionsSectionsDocumentType {
+        }
+        interface Prefillers extends ConditionsPrefillersType {
+        }
+        interface Validators extends ConditionsValidatorsType {
+        }
+        namespace Validators {
+            interface Options extends ConditionsValidatorsOptionsType {
+            }
+            interface Variables extends ConditionsValidatorsVariablesType {
+            }
+        }
+    }
+    interface References extends Types.ReferencesType {
+    }
+    namespace References {
+        interface Options extends Types.ReferencesOptionsType {
+        }
+        namespace Options {
+            interface Option extends OptionV3 {
+            }
+        }
+        interface Variables extends Types.ReferencesVariablesType {
+        }
+        namespace Variables {
+            interface Variable extends VariableV3 {
+            }
+        }
+        interface Outputs extends Types.ReferencesOutputsType {
+        }
+        namespace Outputs {
+            interface Output extends Types.ReferencesSingleOutputType {
+            }
+        }
+        namespace Boxes {
+            interface Box extends Types.ReferencesSingleBoxType {
+            }
+        }
+        interface Sections extends Types.ReferencesSectionsType {
+        }
+        namespace Sections {
+            interface Document extends Types.ReferencesSectionsDocumentType {
+            }
+            interface Section extends SectionV3 {
+            }
+        }
+        interface Relations extends Types.ReferencesRelationsType {
+        }
+        namespace Relations {
+            interface Options extends Types.ReferencesRelationsOptionsType {
+            }
+            interface Variables extends Types.ReferencesRelationsVariablesType {
+            }
+            interface Sections extends Types.ReferencesRelationsSectionsType {
+            }
+        }
+        interface Defaults extends Types.ReferencesDefaultsSectionType {
+        }
+    }
+    interface SmartScript extends SmartScriptType {
+    }
+}
+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 declare 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;
+    };
+}
+export interface UserType {
+    status: 'authenticated' | 'unauthenticated' | 'inprogress' | 'failed';
+    email: string;
+    displayName: string;
+    level: 'ADMIN' | 'MANAGER' | 'USER' | 'GUEST' | 'SUPER';
+    validToken?: boolean;
+}
+export interface InputsType {
+    options: InputsOptionsType;
+    variables: InputsVariablesType;
+}
+export interface InputsOptionsType {
+    [key: string]: boolean[];
+}
+export interface InputsVariablesType {
+    [key: string]: (string | number)[];
+}
+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[];
+}
+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[];
+}
+export interface SmartScriptType {
+    enabled: boolean;
+    triggers: {
+        options: number[];
+        variables: number[];
+    };
+    hidden: {
+        options: Record<string, number[]>;
+        variables: Record<string, number[]>;
+    };
+}

package/dist/types/State.type.js

@@ -0,0 +1 @@
+export {};

package/dist/types/Termsheet.type.d.ts

@@ -0,0 +1,25 @@
+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/dist/types/Termsheet.type.js

@@ -0,0 +1 @@
+export {};

package/dist/types/api.type.d.ts

@@ -0,0 +1,33 @@
+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/dist/types/api.type.js

@@ -0,0 +1 @@
+export {};

package/dist/types/config.type.d.ts

@@ -0,0 +1,48 @@
+import { IFonts } from '@legalplace/storybook';
+export declare 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/dist/types/config.type.js

@@ -0,0 +1 @@
+export {};

package/dist/types/env.type.d.ts

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

package/dist/types/env.type.js

@@ -0,0 +1 @@
+export {};

package/dist/types/getActions.type.d.ts

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

package/dist/types/getActions.type.js

@@ -0,0 +1 @@
+export {};

package/dist/types/getConnectors.type.d.ts

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

package/dist/types/getConnectors.type.js

@@ -0,0 +1 @@
+export {};

package/dist/types/getSelectors.type.d.ts

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

package/dist/types/getSelectors.type.js

@@ -0,0 +1 @@
+export {};

package/dist/types/index.d.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/dist/types/index.js

@@ -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/dist/wizard-params.d.ts

@@ -0,0 +1,3 @@
+import { IWizardParams } from './types/config.type';
+declare const config: IWizardParams;
+export default config;

package/dist/wizard-params.js

@@ -0,0 +1,38 @@
+const config = {
+    apiEndpoint: process.env.REACT_APP_API_ENDPOINT || '',
+    enableShadowInstance: false,
+    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',
+        },
+    },
+    plugins: {
+        b2c_actions: '1.0.0',
+        datalayer: '1.0.0',
+        checkoutX: '1.0.0',
+        authentication: '1.0.0',
+    },
+    theme: {
+        name: 'legacy',
+        params: {
+            ui: {
+                topbar: {
+                    previewBtn: false,
+                },
+            },
+            sidebar: {
+                default: 'preview',
+                states: {
+                    wizard: 'summary',
+                    email: 'summary',
+                },
+            },
+        },
+    },
+    appStates: ['wizard', 'email'],
+};
+export default config;

package/jest.config.ts

@@ -0,0 +1,196 @@
+/*
+ * For a detailed explanation regarding each configuration property and type check, visit:
+ * https://jestjs.io/docs/configuration
+ */
+
+export default {
+  // All imported modules in your tests should be mocked automatically
+  // automock: false,
+
+  // Stop running tests after `n` failures
+  // bail: 0,
+
+  // The directory where Jest should store its cached dependency information
+  // cacheDirectory: "/private/var/folders/cc/yjms5nz10198m80g1mz2zy980000gn/T/jest_dx",
+
+  // Automatically clear mock calls and instances between every test
+  clearMocks: true,
+
+  // Indicates whether the coverage information should be collected while executing the test
+  collectCoverage: false,
+
+  // An array of glob patterns indicating a set of files for which coverage information should be collected
+  // collectCoverageFrom: undefined,
+
+  // The directory where Jest should output its coverage files
+  coverageDirectory: 'coverage',
+
+  // An array of regexp pattern strings used to skip coverage collection
+  // coveragePathIgnorePatterns: ['/node_modules/', '/dist/'],
+
+  // Indicates which provider should be used to instrument code for coverage
+  coverageProvider: 'v8',
+
+  // A list of reporter names that Jest uses when writing coverage reports
+  // coverageReporters: [
+  //   "json",
+  //   "text",
+  //   "lcov",
+  //   "clover"
+  // ],
+
+  // An object that configures minimum threshold enforcement for coverage results
+  // coverageThreshold: undefined,
+
+  // A path to a custom dependency extractor
+  // dependencyExtractor: undefined,
+
+  // Make calling deprecated APIs throw helpful error messages
+  // errorOnDeprecated: false,
+
+  // Force coverage collection from ignored files using an array of glob patterns
+  // forceCoverageMatch: [],
+
+  // A path to a module which exports an async function that is triggered once before all test suites
+  // globalSetup: undefined,
+
+  // A path to a module which exports an async function that is triggered once after all test suites
+  // globalTeardown: undefined,
+
+  // A set of global variables that need to be available in all test environments
+  // globals: {},
+
+  // The maximum amount of workers used to run your tests. Can be specified as % or a number. E.g. maxWorkers: 10% will use 10% of your CPU amount + 1 as the maximum worker number. maxWorkers: 2 will use a maximum of 2 workers.
+  // maxWorkers: "50%",
+
+  // An array of directory names to be searched recursively up from the requiring module's location
+  // moduleDirectories: [
+  //   "node_modules"
+  // ],
+
+  // An array of file extensions your modules use
+  // moduleFileExtensions: [
+  //   "js",
+  //   "jsx",
+  //   "ts",
+  //   "tsx",
+  //   "json",
+  //   "node"
+  // ],
+
+  // A map from regular expressions to module names or to arrays of module names that allow to stub out resources with a single module
+  moduleNameMapper: {
+    '\\.(jpg|jpeg|png|gif|eot|otf|webp|svg|ttf|woff|woff2|mp4|webm|wav|mp3|m4a|aac|oga)$':
+      '<rootDir>__mocks__/fileMock.js',
+    '\\.(css|less|sass|scss)$': 'identity-obj-proxy',
+  },
+
+  // An array of regexp pattern strings, matched against all module paths before considered 'visible' to the module loader
+  // modulePathIgnorePatterns: [],
+
+  // Activates notifications for test results
+  // notify: false,
+
+  // An enum that specifies notification mode. Requires { notify: true }
+  // notifyMode: "failure-change",
+
+  // A preset that is used as a base for Jest's configuration
+  // preset: undefined,
+
+  // Run tests from one or more projects
+  // projects: undefined,
+
+  // Use this configuration option to add custom reporters to Jest
+  // reporters: undefined,
+
+  // Automatically reset mock state between every test
+  // resetMocks: false,
+
+  // Reset the module registry before running each individual test
+  // resetModules: false,
+
+  // A path to a custom resolver
+  // resolver: undefined,
+
+  // Automatically restore mock state between every test
+  // restoreMocks: false,
+
+  // The root directory that Jest should scan for tests and modules within
+  // rootDir: undefined,
+
+  // A list of paths to directories that Jest should use to search for files in
+  roots: ['src/'],
+
+  // Allows you to use a custom runner instead of Jest's default test runner
+  // runner: "jest-runner",
+
+  // The paths to modules that run some code to configure or set up the testing environment before each test
+  // setupFiles: [],
+
+  // A list of paths to modules that run some code to configure or set up the testing framework before each test
+  // setupFilesAfterEnv: [],
+
+  // The number of seconds after which a test is considered as slow and reported as such in the results.
+  // slowTestThreshold: 5,
+
+  // A list of paths to snapshot serializer modules Jest should use for snapshot testing
+  // snapshotSerializers: [],
+
+  // The test environment that will be used for testing
+  testEnvironment: 'jsdom',
+
+  // Options that will be passed to the testEnvironment
+  // testEnvironmentOptions: {},
+
+  // Adds a location field to test results
+  // testLocationInResults: false,
+
+  // The glob patterns Jest uses to detect test files
+  // testMatch: [
+  //   "**/__tests__/**/*.[jt]s?(x)",
+  //   "**/?(*.)+(spec|test).[tj]s?(x)"
+  // ],
+
+  // An array of regexp pattern strings that are matched against all test paths, matched tests are skipped
+  // testPathIgnorePatterns: [
+  //   "/node_modules/"
+  // ],
+
+  // The regexp pattern or array of patterns that Jest uses to detect test files
+  // testRegex: [],
+
+  // This option allows the use of a custom results processor
+  // testResultsProcessor: undefined,
+
+  // This option allows use of a custom test runner
+  // testRunner: "jest-circus/runner",
+
+  // This option sets the URL for the jsdom environment. It is reflected in properties such as location.href
+  // testURL: "http://localhost",
+
+  // Setting this value to "fake" allows the use of fake timers for functions such as "setTimeout"
+  // timers: "real",
+
+  // A map from regular expressions to paths to transformers
+  transform: {
+    '^.+\\.tsx?$': '@swc-node/jest',
+  },
+
+  // An array of regexp pattern strings that are matched against all source file paths, matched files will skip transformation
+  // transformIgnorePatterns: [
+  //   "/node_modules/",
+  //   "\\.pnp\\.[^\\/]+$"
+  // ],
+
+  // An array of regexp pattern strings that are matched against all modules before the module loader will automatically return a mock for them
+  // unmockedModulePathPatterns: undefined,
+
+  // Indicates whether each individual test should be reported during the run
+  // verbose: undefined,
+
+  // An array of regexp patterns that are matched against all source file paths before re-running tests in watch mode
+  // watchPathIgnorePatterns: [],
+
+  // Whether to use watchman for file crawling
+  // watchman: true,
+};