@legalplace/wizardx-core 2.6.4 → 2.7.0

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

@@ -0,0 +1,57 @@
+import type { LoadableComponent } from "@loadable/component";
+import type React from "react";
+import type { AnyAction, CombinedState, Reducer } from "redux";
+import type { ActionsLibraryType } from "./getActions.type";
+export interface IPluginConfig {
+    componentsHooks?: IPluginConfigComponentsHooks;
+    redux?: IPluginConfigRedux;
+    pagination?: IPluginConfigPagination;
+    requires?: string[];
+}
+export interface IPluginConfigComponentsHooks {
+    replace?: IPluginConfigComponentsHooksList;
+    before?: IPluginConfigComponentsHooksList;
+    after?: IPluginConfigComponentsHooksList;
+}
+export interface IPluginConfigComponentsHooksList {
+    [key: string]: React.LazyExoticComponent<React.ComponentType<any>> | LoadableComponent<React.ComponentType<any>> | React.ComponentType<any>;
+}
+export interface IPluginComponentHookConfig {
+    [key: string]: React.ComponentType<any> | Promise<any>;
+}
+export declare type InferAction<T extends (...args: any) => {
+    [key: string]: any;
+    type: any;
+}> = T extends (...args: any) => infer P ? P : never;
+export declare type InferActionType<T extends (...args: any) => {
+    [key: string]: any;
+    type: any;
+}> = T extends (...args: any) => {
+    type: infer P;
+    [key: string]: any;
+} ? P : never;
+export interface IPluginConfigRedux {
+    watchers?: IPluginConfigReduxWatchers;
+    overrides?: IPluginConfigReduxOverrides;
+    reducer?: IPluginConfigReduxReducer;
+}
+export declare type IPluginConfigReduxWatchers = {
+    [I in keyof ActionsLibraryType as InferActionType<ActionsLibraryType[I]>]?: (action: InferAction<ActionsLibraryType[I]>) => void;
+};
+export declare type IPluginConfigReduxOverrides = {
+    [I in keyof ActionsLibraryType as InferActionType<ActionsLibraryType[I]>]?: (action: InferAction<ActionsLibraryType[I]>) => InferAction<ActionsLibraryType[I]>;
+};
+export declare type IPluginConfigReduxReducer<T extends Record<string, any> = {}> = Reducer<CombinedState<T>, AnyAction>;
+export interface IPluginConfigPagination {
+    alterAppStates?: (currentAppStates: string[]) => string[];
+    appstates?: IPluginConfigPaginationAppState[];
+    routes?: IPluginConfigPaginationRoute[];
+}
+export interface IPluginConfigPaginationAppState {
+    page?: string;
+    component?: React.LazyExoticComponent<React.ComponentType<any>> | LoadableComponent<React.ComponentType<any>> | React.ComponentType<any>;
+}
+export interface IPluginConfigPaginationRoute {
+    path?: string;
+    component?: React.LazyExoticComponent<React.ComponentType<any>> | LoadableComponent<React.ComponentType<any>> | React.ComponentType<any>;
+}

package/dist/types/PluginConfig.type.js

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

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

@@ -22,6 +22,7 @@ export interface StateType {
     conditions: ConditionsType;
     references: Types.ReferencesType;
     smartscript: SmartScriptType;
+    pluginsStore: PluginsStoreType;
 }
 export declare namespace StateType {
     interface App extends AppType {
@@ -131,6 +132,8 @@ export declare namespace StateType {
     }
     interface SmartScript extends SmartScriptType {
     }
+    interface PluginsStore extends PluginsStoreType {
+    }
 }
 export interface AppType {
     meta: AppMetaType;
@@ -263,3 +266,6 @@ export interface SmartScriptType {
         variables: Record<string, number[]>;
     };
 }
+export interface PluginsStoreType {
+    [key: string]: Record<string, any>;
+}

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

@@ -10,7 +10,7 @@ export interface IWizardParamsTheme {
             };
             [key: string]: any;
         };
-        sidebar: {
+        sidebar?: {
             default: SideBarType;
             states: {
                 wizard?: SideBarType;
@@ -28,6 +28,7 @@ export interface IWizardParams {
     apiEndpoint: string;
     authCookieDomain?: string;
     enableShadowInstance: boolean;
+    disableRemoteConfig?: boolean;
     fixedConfig?: boolean;
     router: {
         wizardPath: string;
@@ -40,6 +41,7 @@ export interface IWizardParams {
     theme: IWizardParamsTheme;
     brand?: {
         name: string;
+        documentTitle?: string | boolean;
     };
     appStates: string[];
     ovcBucket?: string;

package/dist/types/index.d.ts

@@ -0,0 +1,11 @@
+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 "./PluginConfig.type";
+export * from "./State.type";
+export * from "./Termsheet.type";

package/dist/types/index.js

@@ -0,0 +1,11 @@
+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 "./PluginConfig.type";
+export * from "./State.type";
+export * from "./Termsheet.type";

package/package.json

@@ -1,14 +1,12 @@
 {
   "name": "@legalplace/wizardx-core",
-  "version": "2.6.4",
+  "version": "2.7.0",
   "author": "Moncef Hammou (moncef@legalplace.fr)",
   "license": "MIT",
-  "exports": {
-    ".": "./dist",
-    "./redux": "./dist/redux",
-    "./redux/selectors": "./dist/selectors",
-    "./componentsConnectors": "./dist/componentsConnectors"
-  },
+  "files": [
+    "dist/**/*"
+  ],
+  "main": "dist/index.js",
   "scripts": {
     "build": "npx rimraf dist && npx tsc",
     "start": "npx tsc-watch --noClear -p ./tsconfig.json",
@@ -20,11 +18,13 @@
     "precommit": "test && lint:fix"
   },
   "dependencies": {
+    "@appnest/masonry-layout": "^2.0.8",
+    "@cryptography/sha1": "^0.2.0",
     "@legalplace/lp-events": "1.9.0",
     "@legalplace/lplogic": "^2.1.6",
     "@legalplace/model-healthcheck": "^1.1.5",
     "@legalplace/referencesparser": "^1.7.0",
-    "@legalplace/sb-experiment": "^0.1.0-alpha.3",
+    "@legalplace/storybook": "2.8.0-2604-0.3",
     "@loadable/component": "^5.15.0",
     "@redux-saga/core": "^1.1.3",
     "connected-react-router": "^6.8.0",
@@ -39,6 +39,7 @@
     "react-app-polyfill": "^2.0.0",
     "react-dom": "^17.0.1",
     "react-redux": "^7.2.5",
+    "react-router": "5.2.1",
     "react-router-dom": "^5.2.0",
     "react-test-renderer": "^17.0.2",
     "redux": "^4.1.1",
@@ -50,7 +51,7 @@
     "xss": "^1.0.9"
   },
   "devDependencies": {
-    "@legalplace/eslint-config": "^2.1.3",
+    "@legalplace/eslint-config": "^2.1.4",
     "@legalplace/models-v3-types": "^3.6.0",
     "@legalplace/prettier-config": "^2.1.3",
     "@swc-node/jest": "^1.3.2",
@@ -78,7 +79,6 @@
     "jest-junit": "^13.0.0",
     "lodash": "^4.17.21",
     "react-async-ssr": "^0.7.2",
-    "react-router": "5.2.1",
     "redux-mock-store": "^1.5.4",
     "regenerator-runtime": "^0.13.9",
     "rimraf": "^3.0.2",
@@ -91,5 +91,5 @@
     "*.test.ts",
     "*.test.tsx"
   ],
-  "gitHead": "8fb640031a007e1e39a5710b22e271c65bd3a29a"
+  "gitHead": "bf413725716b7aafa4e9e001ac9e69a4065258d1"
 }

package/.depcheckrc

@@ -1 +0,0 @@
-ignores: ["eslint", "@types/jest", "jest*"]

package/.eslintignore

@@ -1,2 +0,0 @@
-*.test.ts
-*.test.tsx

package/.eslintrc

@@ -1,5 +0,0 @@
-{
-  "extends": [
-    "@legalplace/eslint-config"
-  ]
-}

package/__mocks__/fileMock.js

@@ -1 +0,0 @@
-module.exports = '';

package/babel.config.json

@@ -1,3 +0,0 @@
-{
-  "presets": ["@babel/preset-env"]
-}

package/jest.config.ts

@@ -1,193 +0,0 @@
-/*
- * For a detailed explanation regarding each configuration property and type check, visit:
- * https://jestjs.io/docs/configuration
- */
-
-const jestConfig = {
-  // 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: ['src/**/*.ts', 'src/**/*.tsx', '!**/node_modules/**'],
-
-  // 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: ['html', 'text', 'text-summary', 'cobertura'],
-
-  // 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: ['./setupJest.ts'],
-
-  // 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,
-};
-
-export default jestConfig;

package/setupJest.ts

@@ -1,8 +0,0 @@
-/* eslint-disable import/no-extraneous-dependencies */
-import { GlobalWithFetchMock } from 'jest-fetch-mock';
-
-const customGlobal: GlobalWithFetchMock =
-  global as unknown as GlobalWithFetchMock;
-customGlobal.fetch = require('jest-fetch-mock');
-
-customGlobal.fetchMock = customGlobal.fetch;

package/src/App.test.tsx

@@ -1,41 +0,0 @@
-import React from 'react';
-import ReactDOM from 'react-dom';
-import App from './App';
-import { testModel } from './misc/test_model';
-
-jest.mock('react', () => {
-  const rect = jest.requireActual('react');
-  const Loadable = jest.requireActual('@loadable/component');
-  rect.lazy = Loadable.lazy;
-  return rect;
-});
-
-// Mocking config
-jest.mock('./config', () => ({
-  getConfig: () => ({
-    apiEndpoint: 'https://api.legalplace.eu/api/v1',
-    pluginsDir: 'plugins/',
-    router: {
-      wizardPath: '/:permalink/questionnaire/:page',
-      termsheetPath: '/:permalink/questionnaire/resume',
-    },
-    plugins: {},
-    theme: 'social',
-    appState: ['wizard', 'termsheet'],
-  }),
-}));
-
-it('renders without crashing', () => {
-  const div = document.createElement('div');
-  ReactDOM.render(
-    <App
-      historyType="browser"
-      model={testModel.model}
-      meta={testModel.meta}
-      loadPlugin={async () => {}}
-      loadTheme={async () => {}}
-    />,
-    div
-  );
-  ReactDOM.unmountComponentAtNode(div);
-});

package/src/App.tsx

@@ -1,152 +0,0 @@
-import React from "react";
-import { Route, Switch, Redirect, generatePath } from "react-router-dom";
-import { Provider } from "react-redux";
-import { ConnectedRouter } from "connected-react-router";
-import type { ModelV3 } from "@legalplace/models-v3-types";
-import { getStore, createAppStore } from "./redux/store";
-import { getHistory } from "./redux/routerHistory";
-import type { StateType } from "./types/State.type";
-import Globals, { setGlobals, IGlobalParams } from "./Globals";
-import { getConfig, updateConfig } from "./config";
-import { fetchModelPrerequisitesAction } from "./redux/actions/sagas/model";
-import type { IWizardParams } from "./types/config.type";
-import { preloadTheme } from "./helpers/preloadTheme";
-import ViewComponent from "./components/View";
-import PluginRoute from "./components/PluginRoute";
-import SmartScriptComponent from "./components/SmartScript";
-import { clearPlugins } from "./PluginLoader";
-
-// App components props interface
-export interface AppProps {
-  historyType: "browser" | "memory";
-  model?: ModelV3;
-  meta?: StateType.App.Meta;
-  instance?: StateType.App.Instance;
-  user?: StateType.User;
-  wizardParams?: IWizardParams;
-  preloadTheme?: boolean;
-  loadPlugin: (plugin: string) => Promise<any>;
-  loadTheme: (theme: string) => Promise<any>;
-}
-
-class WizardXCore extends React.Component<AppProps, { loaded: boolean }> {
-  constructor(props: AppProps) {
-    super(props);
-
-    // Clearing Plugins
-    clearPlugins();
-
-    // Creating the history
-    const historyType =
-      typeof props.historyType === "string" ? props.historyType : "browser";
-
-    const params: IGlobalParams = {
-      ...Globals,
-      loadTheme: props.loadTheme,
-      loadPlugin: props.loadPlugin,
-    };
-
-    // Checking model
-    if (props.model) {
-      params.model = props.model;
-    }
-
-    // Checking meta
-    if (props.meta) {
-      params.meta = props.meta;
-    }
-
-    // Checking instance
-    if (props.instance) {
-      params.instance = props.instance;
-    }
-
-    // Checking user
-    if (props.user) {
-      params.user = props.user;
-    }
-
-    // Setting Global params
-    setGlobals(params);
-
-    // Setting Wizard params
-    if (props.wizardParams) updateConfig(props.wizardParams);
-
-    // Preloading theme
-    if (props.preloadTheme && props.wizardParams?.theme.name)
-      preloadTheme(props.wizardParams.theme.name);
-
-    // Creating the store
-    createAppStore(historyType);
-  }
-
-  componentDidMount(): void {
-    if (getConfig().permalink) {
-      const { permalink, prefix, uniqid } = getConfig();
-      if (uniqid?.trim().length) {
-        getHistory().push(
-          generatePath(getConfig().router.wizardInstancePath, {
-            prefix: prefix?.trim().length ? prefix : undefined,
-            permalink,
-            uniqid,
-          })
-        );
-      } else {
-        getHistory().push(
-          generatePath(getConfig().router.wizardPath, {
-            prefix: prefix?.trim().length ? prefix : undefined,
-            permalink,
-          })
-        );
-      }
-    }
-
-    // Fetching model
-    const { dispatch, getState } = getStore();
-    const state = getState();
-    dispatch(
-      fetchModelPrerequisitesAction(
-        getConfig().permalink || state.app.meta.permalink,
-        getConfig().prefix || state.app.meta.prefix || ""
-      )
-    );
-  }
-
-  render(): JSX.Element {
-    return (
-      <Provider store={getStore()}>
-        <ConnectedRouter history={getHistory()}>
-          <Switch>
-            {/* Plugins additional routes */}
-            <Route path="/p/:path" component={PluginRoute} />
-            <Route
-              path={getConfig().router.wizardInstancePath}
-              component={ViewComponent}
-            />
-            <Route
-              path={getConfig().router.wizardPath}
-              component={ViewComponent}
-            />
-
-            {/* SmartScript Frame */}
-            <Route
-              path={
-                getConfig().router.smartscriptPath ||
-                "/contrats/:permalink/smartscript/:uniqid?"
-              }
-              component={SmartScriptComponent}
-            />
-
-            <Redirect
-              to={{
-                pathname: getConfig().router.notFoundPath,
-              }}
-            />
-          </Switch>
-        </ConnectedRouter>
-      </Provider>
-    );
-  }
-}
-
-export default WizardXCore;