@centreon/ui 24.11.13 → 24.11.14

package/.storybook/main.js

@@ -0,0 +1,82 @@
+const { equals } = require("ramda");
+
+const excludeNodeModulesExceptCentreonUi =
+  /node_modules(\\|\/)(?!(centreon-frontend(\\|\/)packages(\\|\/)(ui-context|centreon-ui)))/;
+  
+module.exports = {
+  core: {
+    builder: 'webpack5',
+  },
+  features: {
+    previewMdx2: true,
+  },
+  stories: ['../src/*.stories.mdx', '../src/**/*.stories.@(jsx|tsx)'],
+  typescript: {
+    reactDocgen: 'react-docgen-typescript'
+  },
+  addons: [
+    'storybook-addon-mock/register',
+    'storybook-dark-mode',
+    '@storybook/addon-controls', 
+    {
+      name: '@storybook/addon-docs',
+      options: {
+        configureJSX: true,
+      },
+    },
+  ],
+  webpackFinal: (config) => {
+    delete config.resolve.alias['emotion-theming'];
+    delete config.resolve.alias['@emotion/styled'];
+    delete config.resolve.alias['@emotion/core'];
+
+    const configWithoutEmotionAliases = {
+      ...config,
+      resolve: {
+        ...config.resolve,
+        extensions: ['.js', '.ts', '.tsx'],
+      },
+      module: {
+        ...config.module,
+        rules: [
+          {
+            test: /\.tsx?$/,
+            exclude: /node_modules(\\|\/)(?!(@centreon))/,
+            use: {
+              loader: 'swc-loader',
+              options: {
+                jsc: {
+                  transform: {
+                    react: {
+                      runtime: 'automatic',
+                    },
+                  },
+                  parser: {
+                    syntax: 'typescript',
+                  },
+                },
+                parseMap: true,
+              },
+            }
+          },
+          {
+            exclude: excludeNodeModulesExceptCentreonUi,
+            test: /\.(bmp|png|jpg|jpeg|gif|svg)$/,
+            use: [
+              {
+                loader: 'url-loader',
+                options: {
+                  limit: 10000,
+                  name: '[name].[hash:8].[ext]',
+                },
+              },
+            ],
+          },
+          ...(config.module.rules.filter(({ type }) => !equals(type, 'asset/resource'))),
+        ],
+      },
+    }
+
+    return configWithoutEmotionAliases;
+  }
+};

package/.storybook/preview.tsx

@@ -0,0 +1,21 @@
+import { addDecorator } from '@storybook/react';
+
+import { useDarkMode } from 'storybook-dark-mode';
+
+import { ThemeMode } from '@centreon/ui-context';
+
+import StoryBookThemeProvider from '../src/StoryBookThemeProvider';
+import QueryProvider from '../src/api/QueryProvider';
+import { ReactQueryDevtools } from '@tanstack/react-query-devtools';
+
+
+const withThemeProvider = (story): JSX.Element => (
+  <StoryBookThemeProvider themeMode={useDarkMode() ? ThemeMode.dark :  ThemeMode.light}>
+    <QueryProvider>
+      {story()}
+      <ReactQueryDevtools />
+    </QueryProvider>
+  </StoryBookThemeProvider>
+);
+
+addDecorator(withThemeProvider);

package/README.md

@@ -20,57 +20,27 @@ To start Storybook server, run:
 
 `pnpm storybook`
 
+# Tests
 
-# Add stories
+We have two kind of tests:
+ - Unit tests provided by Jest
+ - End to End tests provided by Storyshot using Jest. Storyshot is an addon of Storybook that compares graphically our stories.
 
-- Create a file named `index.stories.tsx` along side your component
-      
-- Add a title, the component and argTypes
-  
-  ```typescript
-  export default {
-    title: 'MyComponent',
-    Component: MyComponent,
-    argTypes: {
-      propA: { control: 'text' },
-      propB: { control: 'number' },
-    },
-  };
-  ```
+To run Unit tests:
 
-- Create a playground for your component
+`pnpm test`
 
-  ```typescript
-    const Template: ComponentStory<typeof MyComponent> = (args) => (
-      <MyComponent {...args} />
-    );
+or
 
-    export const Playground = Template.bind({});
-  ```
+`pnpm t`
 
-- Then add your story
+To run End to End tests:
+  - Build Storybook : `pnpm build:storybook`
+  - Run all Storyshot tests : `pnpm test:storyshot`
 
-  ```typescript
-    export const basic = Template.bind({});
-    basic.args = { propA: 'test', propB: 0 };
-  ```
-
-# Tests architecture
-
-There are two kinds of tests in Centreon UI.
-- Jest + RTL and Cypress: Component testing. We want to migrate from Jest to Cypress
-- Chromatic: Chromatic is a tool that snapshots our stories and better handle snapshots changes using a review process
-
-
-### Run Jest tests
-
-```bash
-pnpm t
-```
-
-### Run Cypress tests
+You can also test one or more Components using the following syntax:
 
 ```bash
-pnpm cypress:ui # Opens the Cypress controlled browser to debug tests
-pnpm cypress:cli # Runs tests in the terminal
+pnpm test:storyshot -- --story "Title" # Run Storyshot tests about Title component
+pnpm test:storyshot -- --story "Breadcrumb|Title" # Run Storyshot tests about Title and Breadcrumb components
 ```

package/jest.config.js

@@ -0,0 +1,20 @@
+const baseConfig = require('../js-config/jest');
+
+module.exports = {
+  ...baseConfig,
+  moduleNameMapper: {
+    '\\.(s?css|png|svg)$': 'identity-obj-proxy',
+    '^react($|/.+)': '<rootDir>/../../node_modules/react$1'
+  },
+  reporters: ['default', ['jest-junit', { outputName: 'junit.xml' }]],
+  roots: ['<rootDir>/src/'],
+  setupFilesAfterEnv: [
+    '<rootDir>/setupTests.js',
+    '@testing-library/jest-dom/extend-expect'
+  ],
+  testResultsProcessor: 'jest-junit',
+  transform: {
+    ...baseConfig.transform,
+    '^.+\\.mdx?$': '@storybook/addon-docs/jest-transform-mdx'
+  }
+};

package/package.json

@@ -1,24 +1,17 @@
 {
   "name": "@centreon/ui",
-  "version": "24.11.13",
+  "version": "24.11.14",
   "description": "Centreon UI Components",
+  "main": "src/index.ts",
   "scripts": {
-    "update:deps": "pnpx npm-check-updates -i --format group",
-    "lint": "biome check ./src/ --error-on-warnings",
-    "lint:fix": "pnpm lint --fix",
-    "lint:ci": "biome ci ./src/ --error-on-warnings",
-    "storybook": "storybook dev -p 9001 -c .storybook",
-    "build:storybook": "storybook build -c .storybook -o .out",
-    "test": "jest",
-    "test:storybook:local": "test-storybook --url http://127.0.0.1:9001",
-    "test:ci": "jest --silent --reporter=jest-junit",
-    "cypress:ui": "cypress open --component --browser=chrome",
-    "cypress:run:updateSnapshots": "cypress run --component --browser=chrome --env updateSnapshots=true",
-    "cypress:run:coverage": "cypress run --component --browser=chrome --env codeCoverageTasksRegistered=true",
-    "cypress:run": "cypress run --component --browser=chrome",
-    "tokens:transform": "TS_NODE_PROJECT=tsconfig.node.json ts-node style-dictionary.transform.ts"
+    "eslint": "eslint ./src --ext .js,.jsx,.ts,.tsx --max-warnings 0",
+    "eslint:fix": "pnpm eslint --fix",
+    "storybook": "start-storybook -p 9001 -c .storybook",
+    "build:storybook": "build-storybook -c .storybook -o .out",
+    "test": "node testRunner.js",
+    "test:storyshot": "pnpm test storyshots.test.js",
+    "test:ci": "node testRunner.js --silent --reporter=jest-junit"
   },
-  "type": "module",
   "sideEffects": false,
   "repository": {
     "type": "git",
@@ -28,132 +21,71 @@
     "centreon",
     "react"
   ],
-  "author": {
-    "name": "centreon@centreon.com"
-  },
-  "license": "MIT",
+  "author": "centreon@centreon.com",
+  "license": "GPL-2.0",
   "bugs": {
     "url": "https://github.com/centreon/centreon/issues"
   },
   "homepage": "https://github.com/centreon/centreon#readme",
-  "main": "src/index.ts",
-  "exports": {
-    ".": "./src/index.ts",
-    "./components": "./src/components/index.ts",
-    "./fonts/*": "./src/fonts/*",
-    "./test/testRenderer": "./test/testRenderer.tsx"
-  },
-  "files": [
-    "package.json",
-    "src/*",
-    "public/*",
-    "test/*"
-  ],
   "devDependencies": {
-    "@cypress/react": "^8.0.2",
-    "@cypress/webpack-dev-server": "^3.10.1",
-    "@faker-js/faker": "^8.4.1",
-    "@mdx-js/react": "^3.0.1",
-    "@simonsmith/cypress-image-snapshot": "^9.1.0",
-    "@storybook/addon-a11y": "^8.2.9",
-    "@storybook/addon-docs": "^8.2.9",
-    "@storybook/addon-essentials": "^8.2.9",
-    "@storybook/addon-interactions": "^8.2.9",
-    "@storybook/addon-themes": "^8.2.9",
-    "@storybook/blocks": "^8.2.9",
-    "@storybook/manager-api": "^8.2.9",
-    "@storybook/mdx2-csf": "^1.1.0",
-    "@storybook/preview-api": "^8.2.9",
-    "@storybook/react": "^8.2.9",
-    "@storybook/react-vite": "^8.2.9",
-    "@storybook/test": "^8.2.9",
-    "@storybook/test-runner": "^0.19.1",
-    "@storybook/theming": "^8.2.9",
-    "@testing-library/cypress": "^10.0.2",
-    "@testing-library/jest-dom": "^6.4.8",
-    "@testing-library/react": "^16.0.0",
-    "@testing-library/react-hooks": "^8.0.1",
-    "@types/jest": "^29.5.12",
-    "@types/mocha": "^10.0.7",
-    "@types/ramda": "^0.30.1",
-    "@types/react": "^18.3.3",
-    "@types/testing-library__jest-dom": "^6.0.0",
-    "@vitejs/plugin-react": "^4.3.1",
-    "@vitejs/plugin-react-swc": "^3.7.0",
-    "chai": "^5.1.1",
-    "cypress": "^13.13.3",
+    "@mdx-js/react": "^2.1.4",
+    "@storybook/addon-docs": "^6.5.16",
+    "@storybook/addon-essentials": "^6.5.11",
+    "@storybook/addon-storyshots": "^6.5.11",
+    "@storybook/addon-storyshots-puppeteer": "^6.5.11",
+    "@storybook/builder-webpack5": "^6.5.11",
+    "@storybook/manager-webpack5": "^6.5.11",
+    "@storybook/mdx2-csf": "^0.0.3",
+    "@storybook/react": "^6.5.11",
+    "@types/jest": "^27.5.0",
+    "@types/ramda": "^0.28.12",
+    "axios-mock-adapter": "^1.20.0",
+    "babel-plugin-require-context-hook": "^1.0.0",
+    "clean-webpack-plugin": "^4.0.0",
     "identity-obj-proxy": "^3.0.0",
-    "jest-transform-stub": "^2.0.0",
-    "mochawesome": "^7.1.3",
-    "msw": "2.3.5",
-    "msw-storybook-addon": "^2.0.3",
-    "react": "^18.3.1",
-    "react-dom": "^18.3.1",
-    "react-test-renderer": "^18.3.1",
-    "remark-gfm": "^4.0.0",
-    "speed-measure-vite-plugin": "^1.0.1",
-    "storybook": "^8.2.9",
-    "storybook-addon-mock": "^5.0.0",
-    "storybook-dark-mode": "^4.0.2",
-    "style-dictionary": "^4.0.1",
-    "ts-node": "^10.9.2",
-    "use-resize-observer": "^9.1.0",
-    "vite": "^5.4.1",
-    "vite-plugin-istanbul": "^6.0.2",
-    "vite-plugin-svgr": "^4.2.0",
-    "vite-plugin-turbosnap": "^1.0.3"
-  },
-  "peerDependencies": {
-    "@centreon/ui-context": "file:../ui-context"
+    "puppeteer": "^13.7.0",
+    "react-test-renderer": "^18.1.0",
+    "storybook-addon-mock": "^2.4.1",
+    "storybook-dark-mode": "^1.1.0"
   },
   "dependencies": {
-    "@lexical/html": "^0.17.0",
-    "@lexical/link": "^0.17.0",
-    "@lexical/list": "^0.17.0",
-    "@lexical/react": "^0.17.0",
-    "@lexical/rich-text": "^0.17.0",
-    "@lexical/selection": "^0.17.0",
-    "@lexical/utils": "^0.17.0",
-    "@mui/material": "^5.16.7",
-    "@react-spring/web": "^9.7.4",
-    "@visx/clip-path": "^3.3.0",
-    "@visx/curve": "^3.3.0",
-    "@visx/event": "^3.3.0",
-    "@visx/group": "^3.3.0",
-    "@visx/hierarchy": "^3.3.0",
-    "@visx/legend": "^3.10.3",
-    "@visx/pattern": "^3.3.0",
-    "@visx/point": "^3.3.0",
-    "@visx/scale": "^3.5.0",
-    "@visx/shape": "^3.5.0",
-    "@visx/text": "^3.3.0",
-    "@visx/threshold": "^3.5.0",
-    "@visx/visx": "3.11.0",
-    "@visx/zoom": "^3.3.0",
+    "@lexical/link": "0.8.0",
+    "@lexical/react": "0.8.0",
+    "@lexical/selection": "0.8.0",
+    "@lexical/utils": "0.8.0",
     "anylogger": "^1.0.11",
-    "d3-array": "3.2.4",
-    "dayjs": "^1.11.12",
-    "highlight.js": "^11.10.0",
-    "html-react-parser": "^5.1.12",
-    "humanize-duration": "^3.32.1",
-    "lexical": "^0.17.0",
-    "notistack": "^3.0.1",
-    "numeral": "^2.0.6",
-    "ramda": "0.30.1",
-    "react-grid-layout": "^1.4.4",
-    "react-resizable": "^3.0.5",
-    "react-router-dom": "^6.26.1",
+    "humanize-duration": "^3.27.3",
+    "lexical": "0.8.0",
+    "notistack": "^2.0.8",
     "react-transition-group": "^4.4.5",
-    "sanitize-html": "^2.13.0",
     "ulog": "^2.0.0-beta.19"
   },
+  "peerDependencies": {
+    "@centreon/ui-context": "file:../ui-context",
+    "@dnd-kit/core": "6.x",
+    "@dnd-kit/sortable": "6.x",
+    "@dnd-kit/utilities": "6.x",
+    "@mui/icons-material": "5.x",
+    "@mui/lab": "5.x",
+    "@mui/material": "5.x",
+    "@mui/styles": "5.x",
+    "@tanstack/react-query": "4.x",
+    "axios": ">= 1.6.4",
+    "dayjs": "1.x",
+    "formik": "2.x",
+    "jotai": "2.x",
+    "numeral": "2.x",
+    "ramda": "0.x",
+    "react": "18.x",
+    "react-dom": "18.x",
+    "react-i18next": "12.x",
+    "react-router-dom": "6.x",
+    "resize-observer-polyfill": "1.x",
+    "ts.data.json": "2.x",
+    "tss-react": "4.x"
+  },
   "jest-junit": {
     "suiteName": "jest tests",
     "output": "./junit.xml"
-  },
-  "msw": {
-    "workerDirectory": [
-      "public"
-    ]
   }
 }

package/{test/setupTests.js → setupTests.js}

@@ -1,7 +1,6 @@
 /* eslint-disable no-underscore-dangle */
 /* eslint-disable no-undef */
-
-import '@testing-library/jest-dom';
+// import '@testing-library/jest-dom/extend-expect';
 import i18n from 'i18next';
 import { initReactI18next } from 'react-i18next';
 import fetchMock from 'jest-fetch-mock';

package/src/ActionsList/index.stories.tsx

@@ -1,10 +1,8 @@
 import { ComponentMeta, ComponentStory } from '@storybook/react';
 
-import CopyIcon from '@mui/icons-material/ContentCopy';
 import DeleteIcon from '@mui/icons-material/Delete';
 import EditIcon from '@mui/icons-material/Edit';
-
-import { ActionVariants } from './models';
+import CopyIcon from '@mui/icons-material/ContentCopy';
 
 import ActionsList from '.';
 
@@ -26,72 +24,6 @@ const actions = [
   }
 ];
 
-const actionsWithVariants: Array<{
-  label: string;
-  onClick: () => void;
-  variant?: ActionVariants;
-}> = [
-  {
-    label: 'No variant',
-    onClick: (): void => undefined
-  },
-  {
-    label: 'Primary',
-    onClick: (): void => undefined,
-    variant: 'primary'
-  },
-  {
-    label: 'Secondary',
-    onClick: (): void => undefined,
-    variant: 'secondary'
-  },
-  {
-    label: 'Success',
-    onClick: (): void => undefined,
-    variant: 'success'
-  },
-  {
-    label: 'Warning',
-    onClick: (): void => undefined,
-    variant: 'warning'
-  },
-  {
-    label: 'Error',
-    onClick: (): void => undefined,
-    variant: 'error'
-  },
-  {
-    label: 'Info',
-    onClick: (): void => undefined,
-    variant: 'info'
-  },
-  {
-    label: 'Pending',
-    onClick: (): void => undefined,
-    variant: 'pending'
-  }
-];
-
-const actionsWithSecondaryLabel = [
-  {
-    Icon: EditIcon,
-    label: 'Edit',
-    onClick: (): void => undefined
-  },
-  {
-    Icon: CopyIcon,
-    label: 'Duplicate',
-    onClick: (): void => undefined,
-    secondaryLabel:
-      'This is a secondary label that the purpose is to give a small description about an action'
-  },
-  {
-    Icon: DeleteIcon,
-    label: 'Delete',
-    onClick: (): void => undefined
-  }
-];
-
 export default {
   argTypes: {},
   component: ActionsList,
@@ -107,15 +39,3 @@ export const Playground = Template.bind({});
 Playground.args = {
   actions
 };
-
-export const Variants = Template.bind({});
-
-Variants.args = {
-  actions: actionsWithVariants
-};
-
-export const SecondaryLabel = Template.bind({});
-
-SecondaryLabel.args = {
-  actions: actionsWithSecondaryLabel
-};

package/src/ActionsList/index.tsx

@@ -1,83 +1,46 @@
-import { equals } from 'ramda';
+import * as React from 'react';
+
+import { makeStyles } from 'tss-react/mui';
 import { useTranslation } from 'react-i18next';
 
 import {
-  Divider,
-  ListItemIcon,
-  ListItemText,
-  MenuItem,
+  SvgIconProps,
   MenuList,
-  SvgIconTypeMap
+  MenuItem,
+  ListItemText,
+  ListItemIcon
 } from '@mui/material';
-import { OverridableComponent } from '@mui/material/OverridableComponent';
-
-import { sanitizedHTML } from '..';
-
-import { useStyles } from './ActionsList.styles';
-import { ActionVariants } from './models';
 
 interface ActionsType {
-  Icon?: OverridableComponent<SvgIconTypeMap<object, 'svg'>> & {
-    muiName: string;
-  };
+  Icon: (props: SvgIconProps) => JSX.Element;
   label: string;
-  onClick?: (e?) => void;
-  secondaryLabel?: string;
-  variant?: ActionVariants;
-}
-
-export enum ActionsListActionDivider {
-  divider = 'divider'
+  onClick?: () => void;
 }
-export type ActionsListActions = Array<ActionsType | ActionsListActionDivider>;
 
 interface Props {
-  actions: ActionsListActions;
+  actions: Array<ActionsType>;
   className?: string;
-  listItemClassName?: string;
 }
 
-const ActionsList = ({
-  className,
-  listItemClassName,
-  actions
-}: Props): JSX.Element => {
+const useStyles = makeStyles()({
+  list: {
+    maxWidth: '100%'
+  }
+});
+
+const ActionsList = ({ className, actions }: Props): JSX.Element => {
   const { cx, classes } = useStyles();
   const { t } = useTranslation();
 
   return (
     <MenuList className={cx(classes.list, className)}>
-      {actions?.map((action, idx) => {
-        if (equals(action, ActionsListActionDivider.divider)) {
-          // biome-ignore lint/suspicious/noArrayIndexKey:
-          return <Divider key={`divider_${idx}`} />;
-        }
-
-        const { label, Icon, onClick, variant, secondaryLabel } =
-          action as ActionsType;
-
+      {actions?.map(({ Icon, label, onClick }) => {
         return (
-          <MenuItem
-            aria-label={label}
-            className={classes.item}
-            data-variant={variant}
-            id={label}
-            key={label}
-            onClick={onClick}
-          >
-            {Icon && (
-              <ListItemIcon>
-                <Icon fontSize="small" />
-              </ListItemIcon>
-            )}
-            <ListItemText
-              className={listItemClassName}
-              primary={t(label)}
-              secondary={
-                secondaryLabel &&
-                sanitizedHTML({ initialContent: t(secondaryLabel) })
-              }
-            />
+          <MenuItem aria-label={label} key={label} onClick={onClick}>
+            <ListItemIcon>
+              <Icon fontSize="small" />
+            </ListItemIcon>
+            <ListItemText>{t(label)}</ListItemText>
           </MenuItem>
         );
       })}

package/src/Button/Icon/index.stories.tsx

@@ -1,10 +1,10 @@
-import { ComponentMeta, ComponentStory } from '@storybook/react';
+import { ComponentStory, ComponentMeta } from '@storybook/react';
 import { makeStyles } from 'tss-react/mui';
 
 import AccessibilityIcon from '@mui/icons-material/Accessibility';
 import { Theme } from '@mui/material';
 
-import { IconButton } from '.';
+import IconButton from '.';
 
 const useStyles = makeStyles()((theme: Theme) => ({
   root: {