@centreon/ui 23.10.121 → 24.4.1-0

package/src/api/useMutationQuery/index.ts

@@ -8,7 +8,7 @@ import {
 } from '@tanstack/react-query';
 import { JsonDecoder } from 'ts.data.json';
 import anylogger from 'anylogger';
-import { includes } from 'ramda';
+import { includes, omit } from 'ramda';
 
 import { CatchErrorProps, customFetch, ResponseError } from '../customFetch';
 import useSnackbar from '../../Snackbar/useSnackbar';
@@ -22,7 +22,13 @@ export enum Method {
   PUT = 'PUT'
 }
 
+interface Variables<TMeta, T> {
+  _meta?: TMeta;
+  payload?: T;
+}
+
 export type UseMutationQueryProps<T, TMeta> = {
+  baseEndpoint?: string;
   catchError?: (props: CatchErrorProps) => void;
   decoder?: JsonDecoder.Decoder<T>;
   defaultFailureMessage?: string;
@@ -30,14 +36,39 @@ export type UseMutationQueryProps<T, TMeta> = {
   getEndpoint: (_meta: TMeta) => string;
   httpCodesBypassErrorSnackbar?: Array<number>;
   method: Method;
-} & Omit<UseMutationOptions<T & { _meta?: TMeta }>, 'mutationFn'>;
+  onError?: (
+    error: ResponseError,
+    variables: Variables<TMeta, T>,
+    context: unknown
+  ) => unknown;
+  onMutate?: (variables: Variables<TMeta, T>) => Promise<unknown> | unknown;
+  onSuccess?: (
+    data: ResponseError | T,
+    variables: Variables<TMeta, T>,
+    context: unknown
+  ) => unknown;
+} & Omit<
+  UseMutationOptions<{ _meta?: TMeta; payload: T }>,
+  'mutationFn' | 'onError' | 'onMutate' | 'onSuccess' | 'mutateAsync' | 'mutate'
+>;
 
 const log = anylogger('API Request');
 
-export type UseMutationQueryState<T> = {
+export type UseMutationQueryState<T, TMeta> = Omit<
+  UseMutationResult<T | ResponseError>,
+  'isError' | 'mutate' | 'mutateAsync'
+> & {
   isError: boolean;
   isMutating: boolean;
-} & UseMutationResult<T | ResponseError>;
+  mutate: (variables: Variables<TMeta, T>) => ResponseError | T;
+  mutateAsync: (
+    variables: Variables<TMeta, T>,
+    rest?: Pick<
+      UseMutationQueryProps<T, TMeta>,
+      'onError' | 'onMutate' | 'onSettled' | 'onSuccess'
+    >
+  ) => Promise<ResponseError | T>;
+};
 
 const useMutationQuery = <T extends object, TMeta>({
   getEndpoint,
@@ -49,19 +80,24 @@ const useMutationQuery = <T extends object, TMeta>({
   method,
   onMutate,
   onError,
-  onSuccess
-}: UseMutationQueryProps<T, TMeta>): UseMutationQueryState<T> => {
+  onSuccess,
+  onSettled,
+  baseEndpoint
+}: UseMutationQueryProps<T, TMeta>): UseMutationQueryState<T, TMeta> => {
   const { showErrorMessage } = useSnackbar();
 
   const queryData = useMutation<
     T | ResponseError,
     ResponseError,
-    T & { _meta: TMeta }
-  >(
-    (_payload: T & { _meta: TMeta }): Promise<T | ResponseError> => {
-      const { _meta, ...payload } = _payload || {};
+    Variables<TMeta, T>
+  >({
+    mutationFn: (
+      variables: Variables<TMeta, T>
+    ): Promise<T | ResponseError> => {
+      const { _meta, payload } = variables || {};
 
       return customFetch<T>({
+        baseEndpoint,
         catchError,
         decoder,
         defaultFailureMessage,
@@ -75,12 +111,18 @@ const useMutationQuery = <T extends object, TMeta>({
         payload
       });
     },
-    {
-      onError,
-      onMutate,
-      onSuccess
+    onError,
+    onMutate,
+    onSettled,
+    onSuccess: (data, variables, context) => {
+      if (data?.isError) {
+        onError?.(data, variables, context);
+
+        return;
+      }
+      onSuccess?.(data, variables, context);
     }
-  );
+  });
 
   const manageError = (): void => {
     const data = queryData.data as ResponseError | undefined;
@@ -97,14 +139,17 @@ const useMutationQuery = <T extends object, TMeta>({
     }
   };
 
-  useEffect(() => {
-    manageError();
-  }, useDeepCompare([queryData.data]));
+  useEffect(
+    () => {
+      manageError();
+    },
+    useDeepCompare([queryData.data])
+  );
 
   return {
-    ...queryData,
+    ...omit(['isError'], queryData),
     isError: (queryData.data as ResponseError | undefined)?.isError || false,
-    isMutating: queryData.isLoading
+    isMutating: queryData.isPending
   };
 };
 

package/src/components/Button/Icon/IconButton.tsx

@@ -1,6 +1,9 @@
 import React, { ReactElement, ReactNode } from 'react';
 
-import { IconButton as MuiIconButton } from '@mui/material';
+import {
+  IconButton as MuiIconButton,
+  IconButtonProps as MuiIconButtonProps
+} from '@mui/material';
 
 import { AriaLabelingAttributes } from '../../../@types/aria-attributes';
 import { DataTestAttributes } from '../../../@types/data-attributes';
@@ -23,7 +26,8 @@ type IconButtonProps = {
   size?: 'small' | 'medium' | 'large';
   variant?: 'primary' | 'secondary' | 'ghost';
 } & AriaLabelingAttributes &
-  DataTestAttributes;
+  DataTestAttributes &
+  MuiIconButtonProps;
 
 /**
  * @todo re-factor as `iconVariant: 'icon-only'` Button variant, and remove IconButton component (reason: code duplication)

package/src/components/CollapsibleItem/CollapsibleItem.cypress.spec.tsx

@@ -0,0 +1,76 @@
+import { CollapsibleItem, Props } from './CollapsibleItem';
+
+const title = 'Title';
+
+const customizedTitle = <div>Customized title</div>;
+
+const initialize = (props: Omit<Props, 'children'>): void => {
+  cy.mount({
+    Component: <CollapsibleItem {...props}>Content</CollapsibleItem>
+  });
+};
+
+describe('CollapsibleItem', () => {
+  it('displays the component collapsed by default', () => {
+    initialize({ title });
+
+    cy.contains(title).should('be.visible');
+    cy.contains('Content').should('not.be.visible');
+    cy.get('div[aria-expanded="false"]').should('exist');
+
+    cy.makeSnapshot();
+  });
+
+  it('displays the component expanded when the corresponding prop is set to true', () => {
+    initialize({ defaultExpanded: true, title });
+
+    cy.contains(title).should('be.visible');
+    cy.contains('Content').should('be.visible');
+    cy.get('div[aria-expanded="true"]').should('exist');
+
+    cy.makeSnapshot();
+  });
+
+  it('displays a customized title', () => {
+    initialize({ title: customizedTitle });
+
+    cy.contains('Customized title').should('be.visible');
+    cy.get('div[aria-expanded="false"]').should('exist');
+
+    cy.makeSnapshot();
+  });
+
+  it('displays the component as compact', () => {
+    initialize({ compact: true, title });
+
+    cy.contains(title).should('be.visible');
+    cy.get('div[aria-expanded="false"]').should('exist');
+    cy.get('div[data-compact="true"]').should('exist');
+
+    cy.makeSnapshot();
+  });
+
+  it('displays the component as compact and expanded when the icon is clicked', () => {
+    initialize({ compact: true, title });
+
+    cy.contains(title).should('be.visible');
+    cy.get('div[aria-expanded="false"]').should('exist');
+
+    cy.get('div[aria-expanded="false"]').click();
+
+    cy.get('div[aria-expanded="true"]').should('exist');
+    cy.contains('Content').should('be.visible');
+
+    cy.makeSnapshot();
+  });
+
+  it('displays the component as compact and a customized title', () => {
+    initialize({ compact: true, title: customizedTitle });
+
+    cy.contains('Customized title').should('be.visible');
+    cy.get('div[aria-expanded="false"]').should('exist');
+    cy.get('div[data-compact="true"]').should('exist');
+
+    cy.makeSnapshot();
+  });
+});

package/src/components/CollapsibleItem/CollapsibleItem.stories.tsx

@@ -1,5 +1,7 @@
 import { Meta, StoryObj } from '@storybook/react';
 
+import { Checkbox, Typography } from '@mui/material';
+
 import { CollapsibleItem } from './CollapsibleItem';
 
 const meta: Meta<typeof CollapsibleItem> = {
@@ -23,3 +25,27 @@ export const ExpandedByDefault: Story = {
     title: 'Title'
   }
 };
+
+export const customizedTitle: Story = {
+  args: {
+    children: 'Label',
+    defaultExpanded: false,
+    title: <Typography>Title</Typography>
+  }
+};
+
+export const customizedTitleAndCompact: Story = {
+  args: {
+    children: 'Label',
+    compact: true,
+    defaultExpanded: false,
+    title: (
+      <div
+        style={{ alignItems: 'center', display: 'flex', flexDirection: 'row' }}
+      >
+        <Checkbox size="small" />
+        <Typography>Title compact</Typography>
+      </div>
+    )
+  }
+};

package/src/components/CollapsibleItem/CollapsibleItem.tsx

@@ -1,5 +1,7 @@
 import { ReactNode } from 'react';
 
+import { equals, type } from 'ramda';
+
 import {
   AccordionDetails,
   AccordionSummary,
@@ -10,36 +12,63 @@ import ExpandMoreIcon from '@mui/icons-material/ExpandMore';
 
 import { useCollapsibleItemStyles } from './useCollapsibleItemStyles';
 
-interface Props {
+export interface Props {
   children: ReactNode;
+  compact?: boolean;
+  dataTestId?: string;
   defaultExpanded?: boolean;
-  title: string;
+  title: string | JSX.Element;
 }
 
 export const CollapsibleItem = ({
   title,
   children,
-  defaultExpanded
+  defaultExpanded,
+  compact = false,
+  dataTestId = ''
 }: Props): JSX.Element => {
-  const { classes } = useCollapsibleItemStyles();
+  const { classes, cx } = useCollapsibleItemStyles();
+
+  const isStringTitle = equals(type(title), 'String');
 
   return (
     <Accordion
       disableGutters
       className={classes.accordion}
+      data-compact={compact}
+      data-testid={`${dataTestId}-accordion`}
       defaultExpanded={defaultExpanded}
     >
-      <AccordionSummary
-        classes={{
-          content: classes.accordionSummary
-        }}
-        expandIcon={<ExpandMoreIcon color="primary" />}
+      <div className={classes.summaryContainer}>
+        <div className={classes.customTitle}>{!isStringTitle && title}</div>
+        <AccordionSummary
+          classes={{
+            content: cx(
+              compact
+                ? classes.accordionSummaryCompactContent
+                : classes.accordionSummary
+            ),
+            root: cx(
+              compact
+                ? classes.accordionSummaryCompactRoot
+                : classes.accordionSummaryRoot
+            )
+          }}
+          data-testid={`${dataTestId}-summary`}
+          expandIcon={<ExpandMoreIcon color="primary" />}
+        >
+          {isStringTitle && (
+            <Typography color="primary" variant="h6">
+              {title}
+            </Typography>
+          )}
+        </AccordionSummary>
+      </div>
+      <AccordionDetails
+        className={cx(
+          compact ? classes.accordionDetailsCompact : classes.accordionDetails
+        )}
       >
-        <Typography color="primary" variant="h6">
-          {title}
-        </Typography>
-      </AccordionSummary>
-      <AccordionDetails className={classes.accordionDetails}>
         {children}
       </AccordionDetails>
     </Accordion>

package/src/components/CollapsibleItem/useCollapsibleItemStyles.ts

@@ -4,12 +4,35 @@ export const useCollapsibleItemStyles = makeStyles()((theme) => ({
   accordion: {
     backgroundColor: 'transparent',
     border: 'none',
-    borderBottom: `1px solid ${theme.palette.divider}`
+    borderBottom: `1px solid ${theme.palette.divider}`,
+    width: '100%'
   },
   accordionDetails: {
     padding: theme.spacing(0, 2, 2)
   },
+  accordionDetailsCompact: {
+    padding: theme.spacing(0)
+  },
   accordionSummary: {
     margin: theme.spacing(1.5, 0)
+  },
+  accordionSummaryCompactContent: {
+    margin: theme.spacing(0, 0, 0.5)
+  },
+  accordionSummaryCompactRoot: {
+    minHeight: theme.spacing(1),
+    width: '100%'
+  },
+  accordionSummaryRoot: {
+    width: '100%'
+  },
+  customTitle: {
+    whiteSpace: 'nowrap'
+  },
+  summaryContainer: {
+    alignItems: 'center',
+    display: 'flex',
+    flexDirection: 'row',
+    width: '100%'
   }
 }));

package/src/components/DataTable/DataListing.tsx

@@ -0,0 +1,6 @@
+import { RowId } from '../../Listing/models';
+import { Listing, ListingProps } from '../..';
+
+export const DataListing = <TRow extends { id: RowId }>(
+  props: ListingProps<TRow>
+): JSX.Element => <Listing<TRow> {...props} />;

package/src/components/DataTable/DataTable.cypress.spec.tsx

@@ -0,0 +1,174 @@
+import { Box } from '@mui/material';
+import Delete from '@mui/icons-material/Delete';
+
+import { IconButton } from '../..';
+import { ColumnType } from '../../Listing/models';
+
+import { DataTable } from '.';
+
+const data = Array(5)
+  .fill(0)
+  .map((_, idx) => ({
+    description: `Description ${idx}`,
+    id: idx,
+    title: `Entity ${idx}`
+  }));
+
+const CardActions = (): JSX.Element => {
+  return (
+    <IconButton ariaLabel="Delete" title="Delete" onClick={cy.stub()}>
+      <Delete fontSize="small" />
+    </IconButton>
+  );
+};
+
+const initializeDataTableGrid = ({ hasActions, hasCardAction }): void => {
+  cy.viewport(1200, 590);
+  cy.mount({
+    Component: (
+      <DataTable variant="grid">
+        {data.map(({ title, description }) => (
+          <DataTable.Item
+            Actions={<CardActions />}
+            description={description}
+            hasActions={hasActions}
+            hasCardAction={hasCardAction}
+            key={title}
+            title={title}
+          />
+        ))}
+      </DataTable>
+    )
+  });
+};
+
+const initializeDataTableEmpty = (canCreate = false): void => {
+  cy.viewport(1200, 590);
+  cy.mount({
+    Component: (
+      <DataTable isEmpty variant="grid">
+        <DataTable.EmptyState
+          canCreate={canCreate}
+          labels={{
+            actions: {
+              create: 'Create'
+            },
+            title: 'Welcome'
+          }}
+          onCreate={cy.stub()}
+        />
+      </DataTable>
+    )
+  });
+};
+
+const initializeDataTableListing = (): void => {
+  cy.viewport(1200, 590);
+  cy.mount({
+    Component: (
+      <Box sx={{ height: '100vh' }}>
+        <DataTable variant="listing">
+          <DataTable.Listing
+            columns={[
+              {
+                getFormattedString: (row) => row.title,
+                id: 'title',
+                label: 'Title',
+                type: ColumnType.string
+              },
+              {
+                getFormattedString: (row) => row.description,
+                id: 'description',
+                label: 'Description',
+                type: ColumnType.string
+              }
+            ]}
+            rows={data}
+          />
+        </DataTable>
+      </Box>
+    )
+  });
+};
+
+describe('DataTable: Grid', () => {
+  it('displays items with title and description only', () => {
+    initializeDataTableGrid({
+      hasActions: false,
+      hasCardAction: false
+    });
+
+    data.forEach(({ title, description }) => {
+      cy.contains(title).should('be.visible');
+      cy.contains(description).should('be.visible');
+    });
+
+    cy.makeSnapshot();
+  });
+
+  it('displays items with actions', () => {
+    initializeDataTableGrid({
+      hasActions: true,
+      hasCardAction: false
+    });
+
+    cy.findAllByLabelText('Delete').should('have.length', 5);
+
+    cy.makeSnapshot();
+  });
+
+  it('displays items with card action only', () => {
+    initializeDataTableGrid({
+      hasActions: false,
+      hasCardAction: true
+    });
+
+    cy.findAllByLabelText('view').should('have.length', 5);
+
+    cy.makeSnapshot();
+  });
+
+  it('displays items with card action and bottom actions', () => {
+    initializeDataTableGrid({
+      hasActions: true,
+      hasCardAction: true
+    });
+
+    cy.findAllByLabelText('view').should('have.length', 5);
+    cy.findAllByLabelText('Delete').should('have.length', 5);
+
+    cy.makeSnapshot();
+  });
+});
+
+describe('DataTable: Empty', () => {
+  it('displays the title', () => {
+    initializeDataTableEmpty();
+
+    cy.contains('Welcome').should('be.visible');
+
+    cy.makeSnapshot();
+  });
+
+  it('displays the title and the action button', () => {
+    initializeDataTableEmpty(true);
+
+    cy.contains('Welcome').should('be.visible');
+    cy.contains('Create').should('be.visible');
+
+    cy.makeSnapshot();
+  });
+});
+
+describe('DataTable: Listing', () => {
+  it('displays the listing', () => {
+    initializeDataTableListing();
+
+    data.forEach(({ title, description }) => {
+      cy.contains(title).should('be.visible');
+      cy.contains(description).should('be.visible');
+    });
+
+    cy.makeSnapshot();
+  });
+});

package/src/components/DataTable/DataTable.stories.tsx

@@ -1,5 +1,9 @@
 import { Meta, StoryObj } from '@storybook/react';
 
+import { Box } from '@mui/material';
+
+import { ColumnType } from '../../Listing/models';
+
 import { DataTable } from './index';
 
 const meta: Meta<typeof DataTable> = {
@@ -49,3 +53,39 @@ export const withFixedHeightContainer: Story = {
     </div>
   )
 };
+
+const ListingTemplate = (args): JSX.Element => (
+  <Box sx={{ height: '80vh' }}>
+    <DataTable {...args} />
+  </Box>
+);
+
+export const listing: Story = {
+  args: {
+    children: (
+      <DataTable.Listing
+        columns={[
+          {
+            getFormattedString: (row) => row.title,
+            id: 'title',
+            label: 'Title',
+            type: ColumnType.string
+          },
+          {
+            getFormattedString: (row) => row.description,
+            id: 'description',
+            label: 'Description',
+            type: ColumnType.string
+          }
+        ]}
+        rows={[...Array(5)].map((_, i) => ({
+          description: `Item description ${i}`,
+          id: i,
+          title: `Item ${i}`
+        }))}
+      />
+    ),
+    variant: 'listing'
+  },
+  render: ListingTemplate
+};

package/src/components/DataTable/DataTable.styles.ts

@@ -10,6 +10,9 @@ const useStyles = makeStyles()((theme) => ({
       gridGap: theme.spacing(2.5),
       gridTemplateColumns: `repeat(auto-fill, ${theme.spacing(45)})`
     },
+    '&[data-variant="listing"]': {
+      height: '100%'
+    },
     '&[data-variant][data-is-empty="true"]': {
       display: 'flex',
       justifyContent: 'center',

package/src/components/DataTable/DataTable.tsx

@@ -1,11 +1,11 @@
-import React, { ReactElement, ReactNode } from 'react';
+import { ReactElement, ReactNode } from 'react';
 
 import { useStyles } from './DataTable.styles';
 
 type DataTableProps = {
-  children: ReactNode | Array<ReactNode>;
+  children?: ReactNode | Array<ReactNode>;
   isEmpty?: boolean;
-  variant?: 'grid';
+  variant: 'grid' | 'listing';
 };
 
 /** *

package/src/components/DataTable/Item/DataTableItem.styles.ts

@@ -1,13 +1,18 @@
 import { makeStyles } from 'tss-react/mui';
 
 const useStyles = makeStyles()((theme) => ({
+  actions: {
+    display: 'flex',
+    flexDirection: 'row',
+    justifyContent: 'space-between'
+  },
   dataTableItem: {
     '& .MuiCardActionArea-root': {
       alignItems: 'flex-start',
       display: 'flex',
       flexDirection: 'column',
       height: '100%',
-      justifyContent: 'space-between'
+      justifyContent: 'flex-start'
     },
     '& .MuiCardActions-root': {
       '& > span': {
@@ -15,13 +20,13 @@ const useStyles = makeStyles()((theme) => ({
         gap: theme.spacing(1)
       },
       display: 'flex',
-
       justifyContent: 'space-between'
     },
     borderRadius: theme.shape.borderRadius,
     display: 'flex',
     flexDirection: 'column',
     height: '186px',
+    justifyContent: 'space-between',
     p: {
       color: theme.palette.text.secondary,
       letterSpacing: '0',