@centreon/ui 24.5.2 → 24.5.4

package/src/utils/docsURL.ts

@@ -1,31 +0,0 @@
-interface OnPremDocsURL {
-  majorVersion: string;
-  minorVersion: string;
-}
-
-interface DocsURL {
-  isCloudPlatform: boolean;
-  majorVersion: string;
-  minorVersion: string;
-}
-
-export const getOnPremDocsURL = ({
-  majorVersion,
-  minorVersion
-}: OnPremDocsURL): string => {
-  return `https://docs.centreon.com/docs/${majorVersion}.${minorVersion}/alerts-notifications/resources-status/#search-bar`;
-};
-export const cloudDocsURL =
-  'https://docs.centreon.com/cloud/alerts-notifications/resources-status/#search-bar';
-
-export const getDocsURL = ({
-  isCloudPlatform,
-  majorVersion,
-  minorVersion
-}: DocsURL): string => {
-  if (isCloudPlatform) {
-    return cloudDocsURL;
-  }
-
-  return getOnPremDocsURL({ majorVersion, minorVersion });
-};

package/src/utils/index.ts

@@ -1,24 +0,0 @@
-export * from './useLocaleDateTimeFormat';
-export * from './getNormalizedId';
-export * from './statuses';
-export * from './typedMemo';
-export * from './useCopyToClipboard';
-export * from './useDebounce';
-export * from './useDeepCallback';
-export * from './useDeepMemo';
-export * from './useIntersectionObserver';
-export * from './useKeyObserver';
-export * from './useLoadImage';
-export * from './useMemoComponent';
-export * from './useThemeMode';
-export * from './useViewportIntersection';
-export * from './panelSize';
-export * from './sanitizedHTML';
-export * from './docsURL';
-export * from './useInfiniteScrollListing';
-export * from './useLicenseExpirationWarning';
-export * from './useRefreshInterval';
-export * from './centreonBaseURL';
-export * from './usePluralizedTranslation';
-export * from './useResizeObserver';
-export * from './useFullscreen';

package/src/utils/panelSize.ts

@@ -1,15 +0,0 @@
-import { gt } from 'ramda';
-
-export enum PanelSize {
-  Small = 550,
-  Medium = 675,
-  Large = 800
-}
-
-interface PanelSizeParams {
-  currentSize: number;
-}
-
-export const togglePanelSize = ({ currentSize }: PanelSizeParams): number => {
-  return gt(currentSize, PanelSize.Medium) ? PanelSize.Small : PanelSize.Large;
-};

package/src/utils/sanitizedHTML.ts

@@ -1,18 +0,0 @@
-import sanitizeHtml, { IOptions } from 'sanitize-html';
-import ReactHtmlParser from 'react-html-parser';
-
-interface UseSanitizedHTMLProps {
-  initialContent: string;
-  sanitizeOptions?: IOptions;
-}
-
-const sanitizedHTML = ({
-  initialContent,
-  sanitizeOptions = {}
-}: UseSanitizedHTMLProps): JSX.Element => {
-  const sanitizedContent = sanitizeHtml(initialContent, sanitizeOptions);
-
-  return ReactHtmlParser(sanitizedContent);
-};
-
-export { sanitizedHTML };

package/src/utils/translatedLabel.ts

@@ -1,2 +0,0 @@
-export const labelLicenseWarning = (module, daysUntilExpiration): string =>
-  `The ${module} license will expire in ${daysUntilExpiration} days`;

package/src/utils/useFullscreen/Fullscreen.cypress.spec.tsx

@@ -1,130 +0,0 @@
-import { Provider, createStore } from 'jotai';
-import { BrowserRouter } from 'react-router-dom';
-
-import { Button } from '@mui/material';
-
-import { useFullscreen } from './useFullscreen';
-import { router, useFullscreenListener } from './useFullscreenListener';
-
-const labelEnterFullscreen = 'Enter fullscreen';
-const labelExitFullscreen = 'Exit fullscreen';
-
-const ChildComponent = (): JSX.Element => {
-  const { toggleFullscreen, fullscreenEnabled, isFullscreenActivated } =
-    useFullscreen();
-
-  return (
-    <div
-      data-fullscreenActivated={isFullscreenActivated}
-      data-fullscreenEnabled={fullscreenEnabled}
-      id="test"
-    >
-      <Button onClick={() => toggleFullscreen(document.body)}>
-        {isFullscreenActivated ? labelExitFullscreen : labelEnterFullscreen}
-      </Button>
-      <input id="input" />
-      <textarea id="textarea" />
-    </div>
-  );
-};
-
-const TestComponent = (): JSX.Element => {
-  useFullscreenListener();
-
-  return <ChildComponent />;
-};
-
-const initialize = (): void => {
-  const store = createStore();
-
-  const queryParameters = new Map();
-
-  cy.stub(router, 'useSearchParams', () => queryParameters);
-
-  cy.mount({
-    Component: (
-      <BrowserRouter>
-        <Provider store={store}>
-          <TestComponent />
-        </Provider>
-      </BrowserRouter>
-    )
-  });
-};
-
-describe('Fullscreen', () => {
-  it('enters fullscreen mode when the button is clicked', () => {
-    initialize();
-
-    cy.get('#test')
-      .should('have.attr', 'data-fullscreenActivated', 'false')
-      .should('have.attr', 'data-fullscreenEnabled', 'true');
-
-    cy.contains(labelEnterFullscreen).realClick();
-
-    cy.get('#test')
-      .should('have.attr', 'data-fullscreenActivated', 'true')
-      .should('have.attr', 'data-fullscreenEnabled', 'true');
-
-    cy.contains(labelExitFullscreen).realClick();
-  });
-
-  it('exits fullscreen mode when the button is clicked', () => {
-    initialize();
-
-    cy.get('#test')
-      .should('have.attr', 'data-fullscreenActivated', 'false')
-      .should('have.attr', 'data-fullscreenEnabled', 'true');
-
-    cy.contains(labelEnterFullscreen).realClick();
-
-    cy.get('#test')
-      .should('have.attr', 'data-fullscreenActivated', 'true')
-      .should('have.attr', 'data-fullscreenEnabled', 'true');
-
-    cy.contains(labelExitFullscreen).realClick();
-
-    cy.get('#test')
-      .should('have.attr', 'data-fullscreenActivated', 'false')
-      .should('have.attr', 'data-fullscreenEnabled', 'true');
-  });
-
-  it('toggles fullscreen mode when the corresponding shortcut is clicked', () => {
-    initialize();
-
-    cy.get('#test')
-      .should('have.attr', 'data-fullscreenActivated', 'false')
-      .should('have.attr', 'data-fullscreenEnabled', 'true');
-
-    cy.get('#test').realPress(['F']);
-
-    cy.get('#test')
-      .should('have.attr', 'data-fullscreenActivated', 'true')
-      .should('have.attr', 'data-fullscreenEnabled', 'true');
-
-    cy.get('#test').realPress(['F']);
-
-    cy.get('#test')
-      .should('have.attr', 'data-fullscreenActivated', 'false')
-      .should('have.attr', 'data-fullscreenEnabled', 'true');
-  });
-
-  ['input', 'textarea'].forEach((tag) => {
-    it(`cannot toggle fullscreen feature using the shortcut when ${tag === 'input' ? 'an' : 'a'} ${tag} is focused`, () => {
-      initialize();
-
-      cy.get('#test')
-        .should('have.attr', 'data-fullscreenActivated', 'false')
-        .should('have.attr', 'data-fullscreenEnabled', 'true');
-
-      cy.get(`#${tag}`).focus();
-
-      cy.get('#test').realPress(['F']);
-
-      cy.get('#test')
-        .should('have.attr', 'data-fullscreenActivated', 'false')
-        .should('have.attr', 'data-fullscreenEnabled', 'true');
-      cy.get(`#${tag}`).should('have.value', 'F');
-    });
-  });
-});

package/src/utils/useFullscreen/atoms.ts

@@ -1,3 +0,0 @@
-import { atom } from 'jotai';
-
-export const isFullscreenActivatedAtom = atom(false);

package/src/utils/useFullscreen/index.ts

@@ -1,2 +0,0 @@
-export * from './useFullscreen';
-export * from './useFullscreenListener';

package/src/utils/useFullscreen/translatedLabels.ts

@@ -1 +0,0 @@
-export const labelCannotEnterInFullscreen = 'Cannot enter fullscreen mode';

package/src/utils/useFullscreen/useFullscreen.ts

@@ -1,73 +0,0 @@
-import { useTranslation } from 'react-i18next';
-import { useAtom } from 'jotai';
-
-import { useSnackbar } from '../..';
-
-import { labelCannotEnterInFullscreen } from './translatedLabels';
-import { isFullscreenActivatedAtom } from './atoms';
-
-interface UseFullscreenState {
-  enterInFullscreen: (element: HTMLElement | null) => void;
-  exitFullscreen: () => void;
-  fullscreenEnabled: boolean;
-  isFullscreenActivated: boolean;
-  resetVariables: () => void;
-  toggleFullscreen: (element: HTMLElement | null) => void;
-}
-
-export const useFullscreen = (): UseFullscreenState => {
-  const { t } = useTranslation();
-
-  const { showErrorMessage } = useSnackbar();
-
-  const [isFullscreenActivated, setIsFullscreenActivated] = useAtom(
-    isFullscreenActivatedAtom
-  );
-
-  const resetVariables = (): void => {
-    setIsFullscreenActivated(false);
-  };
-
-  const enterInFullscreen = (element: HTMLElement | null): void => {
-    if (!document.fullscreenEnabled) {
-      return;
-    }
-
-    if (!element) {
-      showErrorMessage(t(labelCannotEnterInFullscreen));
-    }
-
-    element
-      ?.requestFullscreen({ navigationUI: 'show' })
-      .then(() => {
-        setIsFullscreenActivated(true);
-      })
-      .catch(() => {
-        showErrorMessage(t(labelCannotEnterInFullscreen));
-        setIsFullscreenActivated(false);
-      });
-  };
-
-  const exitFullscreen = (): void => {
-    document.exitFullscreen().then(resetVariables);
-  };
-
-  const toggleFullscreen = (element: HTMLElement | null): void => {
-    if (isFullscreenActivated || document.fullscreenElement) {
-      exitFullscreen();
-
-      return;
-    }
-
-    enterInFullscreen(element);
-  };
-
-  return {
-    enterInFullscreen,
-    exitFullscreen,
-    fullscreenEnabled: document.fullscreenEnabled,
-    isFullscreenActivated,
-    resetVariables,
-    toggleFullscreen
-  };
-};

package/src/utils/useFullscreen/useFullscreenListener.ts

@@ -1,62 +0,0 @@
-import { useEffect } from 'react';
-
-import { equals, includes } from 'ramda';
-import { useSearchParams } from 'react-router-dom';
-
-import { useDeepCompare } from '../useMemoComponent';
-
-import { useFullscreen } from './useFullscreen';
-
-export const router = {
-  useSearchParams
-};
-
-export const useFullscreenListener = (): boolean => {
-  const { toggleFullscreen, resetVariables, isFullscreenActivated } =
-    useFullscreen();
-
-  const toggle = (event: KeyboardEvent): void => {
-    if (
-      includes(document.activeElement?.tagName, ['INPUT', 'TEXTAREA']) ||
-      equals(
-        document.activeElement?.getAttribute('data-lexical-editor'),
-        'true'
-      ) ||
-      equals(document.activeElement?.getAttribute('contenteditable'), 'true') ||
-      !equals(event.code, 'KeyF')
-    ) {
-      return;
-    }
-
-    toggleFullscreen(document.querySelector('body'));
-  };
-
-  const changeFullscreen = (): void => {
-    if (document.fullscreenElement) {
-      return;
-    }
-
-    resetVariables();
-  };
-
-  useEffect(
-    () => {
-      document.addEventListener('fullscreenchange', changeFullscreen);
-
-      return () => {
-        document.removeEventListener('fullscreenchange', changeFullscreen);
-      };
-    },
-    useDeepCompare([document.fullscreenElement])
-  );
-
-  useEffect(() => {
-    window.addEventListener('keypress', toggle);
-
-    return () => {
-      window.removeEventListener('keypress', toggle);
-    };
-  }, [isFullscreenActivated]);
-
-  return isFullscreenActivated;
-};

package/src/utils/useInfiniteScrollListing.ts

@@ -1,124 +0,0 @@
-import { useEffect, useMemo, useRef, useState } from 'react';
-
-import { equals, gte, isNil, reduce } from 'ramda';
-import { PrimitiveAtom, useAtom } from 'jotai';
-import { JsonDecoder } from 'ts.data.json';
-
-import {
-  QueryParameter,
-  buildListingEndpoint,
-  useFetchQuery,
-  useIntersectionObserver
-} from '@centreon/ui';
-
-import type { Listing } from '../api/models';
-import { Parameters } from '../api/buildListingEndpoint/models';
-
-interface UseInfiniteScrollListing<T> {
-  elementRef: (node) => void;
-  elements: Array<T>;
-  isLoading: boolean;
-  total?: number;
-}
-
-interface UseInfiniteScrollListingProps<T> {
-  customQueryParameters?: Array<QueryParameter>;
-  decoder?: JsonDecoder.Decoder<Listing<T>>;
-  enabled?: boolean;
-  endpoint: string;
-  limit?: number;
-  pageAtom: PrimitiveAtom<number>;
-  parameters?: Parameters;
-  queryKeyName: string;
-  suspense?: boolean;
-}
-
-export const useInfiniteScrollListing = <T>({
-  queryKeyName,
-  endpoint,
-  decoder,
-  pageAtom,
-  suspense = true,
-  parameters,
-  customQueryParameters,
-  limit = 100,
-  enabled = true
-}: UseInfiniteScrollListingProps<T>): UseInfiniteScrollListing<T> => {
-  const [maxPage, setMaxPage] = useState(1);
-
-  const elements = useRef<Array<T> | undefined>(undefined);
-
-  const [page, setPage] = useAtom(pageAtom);
-
-  const { data, isLoading, prefetchNextPage, fetchStatus } = useFetchQuery<
-    Listing<T>
-  >({
-    decoder,
-    getEndpoint: (params) =>
-      buildListingEndpoint({
-        baseEndpoint: endpoint,
-        customQueryParameters,
-        parameters: { limit, page: params?.page || page, ...parameters }
-      }),
-    getQueryKey: () => [queryKeyName, page],
-    isPaginated: true,
-    queryOptions: {
-      enabled,
-      refetchOnMount: false,
-      refetchOnWindowFocus: false,
-      suspense: suspense && equals(page, 1)
-    }
-  });
-
-  const elementRef = useIntersectionObserver({
-    action: () => {
-      setPage((currentPage) => currentPage + 1);
-    },
-    loading: !equals(fetchStatus, 'idle'),
-    maxPage,
-    page
-  });
-
-  elements.current = useMemo(() => {
-    if (isNil(data) || !equals(fetchStatus, 'idle')) {
-      return elements.current;
-    }
-
-    return reduce<T, Array<T>>(
-      (acc, element) => [...acc, element],
-      equals(page, 1) ? [] : elements.current || [],
-      data.result
-    );
-  }, [page, data, fetchStatus]);
-
-  useEffect(() => {
-    if (isNil(data)) {
-      return;
-    }
-
-    const total = data.meta.total || 1;
-    const newMaxPage = Math.ceil(total / limit);
-
-    setMaxPage(newMaxPage);
-
-    if (gte(page, newMaxPage)) {
-      return;
-    }
-
-    prefetchNextPage({
-      getPrefetchQueryKey: (newPage) => [`dashboards`, newPage],
-      page
-    });
-  }, [data]);
-
-  useEffect(() => {
-    return () => setPage(1);
-  }, []);
-
-  return {
-    elementRef,
-    elements: elements.current || [],
-    isLoading,
-    total: data?.meta.total
-  };
-};

package/src/utils/useLicenseExpirationWarning.test.tsx

@@ -1,148 +0,0 @@
-import dayjs from 'dayjs';
-import { renderHook } from '@testing-library/react';
-
-import {
-  getFetchCall,
-  mockResponse,
-  resetMocks,
-  waitFor
-} from '../../test/testRenderer';
-import TestQueryProvider from '../api/TestQueryProvider';
-
-import { labelLicenseWarning } from './translatedLabel';
-
-import { useLicenseExpirationWarning } from '.';
-
-const getMockedResponse = (expirationDate): object => ({
-  result: {
-    module: {
-      entities: [
-        {
-          description: 'Centreon Auto Discovery',
-          id: 'centreon-autodiscovery-server',
-          label: 'Centreon',
-          license: {
-            expiration_date: expirationDate,
-            host_limit: -1,
-            host_usage: 1,
-            is_valid: true,
-            required: true
-          },
-          type: 'module',
-          version: {
-            available: '23.10.0',
-            current: '23.10.0',
-            installed: true,
-            outdated: false
-          }
-        },
-        {
-          description: 'Centreon License Manager',
-          id: 'centreon-license-manager',
-          label: 'Centreon',
-          license: {
-            required: false
-          },
-          type: 'module',
-          version: {
-            available: '23.10.0',
-            current: '23.10.0',
-            installed: true,
-            outdated: false
-          }
-        },
-        {
-          description: 'Centreon Monitoring Connectors Manager',
-          id: 'centreon-pp-manager',
-          label: 'Centreon',
-          license: {
-            required: false
-          },
-          type: 'module',
-          version: {
-            available: '23.10.0',
-            current: '23.10.0',
-            installed: true,
-            outdated: false
-          }
-        }
-      ],
-      pagination: {
-        limit: 3,
-        offset: 0,
-        total: 3
-      }
-    },
-    widget: {
-      entities: [],
-      pagination: {
-        limit: 0,
-        offset: 0,
-        total: 0
-      }
-    }
-  },
-  status: true
-});
-
-const mockRequest = ({ expirationDate }: { expirationDate }): void => {
-  resetMocks();
-  mockResponse({
-    data: getMockedResponse(expirationDate)
-  });
-};
-
-const showMessage = jest.fn();
-
-jest.mock('../Snackbar/useSnackbar', () => ({
-  __esModule: true,
-  default: jest
-    .fn()
-    .mockImplementation(() => ({ showWarningMessage: showMessage }))
-}));
-
-const initialize = (): void => {
-  renderHook(
-    () =>
-      useLicenseExpirationWarning({
-        module: 'centreon-autodiscovery-server'
-      }),
-    {
-      wrapper: TestQueryProvider
-    }
-  );
-};
-
-const currentDate = dayjs();
-
-describe('License', () => {
-  it('does not display any warning message when the license expires in more than 15 days from the current date', () => {
-    mockRequest({ expirationDate: currentDate.add(20, 'day') });
-    initialize();
-
-    waitFor(() => {
-      expect(getFetchCall(0)).toEqual(
-        'internal.php?object=centreon_module&action=list'
-      );
-    });
-
-    expect(showMessage).not.toHaveBeenCalled();
-  });
-
-  it('displays a warning message when the license expires within 15 days', () => {
-    mockRequest({ expirationDate: currentDate.add(10.5, 'day') });
-    initialize();
-
-    waitFor(() => {
-      expect(getFetchCall(0)).toEqual(
-        'internal.php?object=centreon_module&action=list'
-      );
-    });
-
-    waitFor(() => {
-      expect(showMessage).toHaveBeenCalledWith(
-        labelLicenseWarning('centreon-autodiscovery-server', 10)
-      );
-    });
-  });
-});

package/src/utils/useLicenseExpirationWarning.ts

@@ -1,52 +0,0 @@
-import { useEffect } from 'react';
-
-import dayjs from 'dayjs';
-import { path, pipe, propEq, find, lt, isNil } from 'ramda';
-import { useTranslation } from 'react-i18next';
-
-import { useFetchQuery, useSnackbar } from '..';
-
-import { labelLicenseWarning } from './translatedLabel';
-
-const legacyBaseEndpoint = './api/internal.php';
-const extensionsEndpoint = `${legacyBaseEndpoint}?object=centreon_module&action=list`;
-
-interface Props {
-  module: string;
-}
-
-export const useLicenseExpirationWarning = ({ module }: Props): void => {
-  const { t } = useTranslation();
-  const { showWarningMessage } = useSnackbar();
-
-  const { data } = useFetchQuery({
-    getEndpoint: () => extensionsEndpoint,
-    getQueryKey: () => [module]
-  });
-
-  const currentDate = dayjs();
-
-  const getExpirationDate = pipe(
-    path(['result', 'module', 'entities']),
-    find(propEq(module, 'id')),
-    path(['license', 'expiration_date'])
-  ) as (data) => string;
-
-  useEffect(() => {
-    if (isNil(data)) {
-      return;
-    }
-
-    const expirationDate = getExpirationDate(data);
-
-    if (isNil(expirationDate)) {
-      return;
-    }
-
-    const daysUntilExpiration = dayjs(expirationDate).diff(currentDate, 'day');
-
-    if (lt(daysUntilExpiration, 15)) {
-      showWarningMessage(t(labelLicenseWarning(module, daysUntilExpiration)));
-    }
-  }, [data]);
-};