@transferwise/components 46.79.1 → 46.81.0

package/src/ssr.spec.tsx

@@ -0,0 +1,264 @@
+/**
+ * @jest-environment node
+ */
+import { renderToString } from 'react-dom/server';
+
+import en from './i18n/en.json';
+
+import * as exposedLibraryItems from '.';
+
+type ExposedLibraryItemsType = typeof exposedLibraryItems;
+type ExposedLibraryKeysType = keyof ExposedLibraryItemsType;
+
+const excluded = new Set<ExposedLibraryKeysType | string>([
+  // hooks
+  'useSnackbar',
+  'useDirection',
+  'useLayout',
+  'useScreenSize',
+
+  // specific components
+  'Provider',
+  'BottomSheet',
+  'DropFade',
+  'SelectInputTriggerButton',
+  'Panel',
+  'ResponsivePanel',
+
+  // enums
+  'Size',
+  'Width',
+  'Sentiment',
+  'Variant',
+  'Priority',
+  'ControlType',
+  'Type',
+  'Theme',
+  'DateMode',
+  'MonthFormat',
+  'Position',
+  'Scroll',
+  'ProfileType',
+  'Breakpoint',
+  'Layout',
+  'Status',
+  'MarkdownNodeType',
+  'AvatarType',
+  'InfoPresentation',
+  'UploadStep',
+  'DecisionPresentation',
+  'DecisionType',
+  'AlertArrowPosition',
+  'LogoType',
+  'FileType',
+  'Direction',
+  'Typography',
+
+  // types
+  'SearchInputProps',
+  'SelectInputItem',
+  'SelectInputOptionContentProps',
+  'SelectInputProps',
+  'UploadedFile',
+  'UploadError',
+  'UploadResponse',
+  'LayoutDirection',
+
+  // utils
+  'SUPPORTED_LANGUAGES',
+  'RTL_LANGUAGES',
+  'DEFAULT_LANG',
+  'DEFAULT_LOCALE',
+  'adjustLocale',
+  'getLangFromLocale',
+  'getCountryFromLocale',
+  'getDirectionFromLocale',
+  'isServerSide',
+  'isBrowser',
+
+  // other
+  'translations',
+]);
+
+function isNotExcluded(item: ExposedLibraryKeysType) {
+  return !excluded.has(item);
+}
+
+describe('Server side rendering', () => {
+  const componentNames = (
+    Object.keys(exposedLibraryItems) as (keyof ExposedLibraryItemsType)[]
+  ).filter((moduleName) => isNotExcluded(moduleName));
+
+  // stick all possible properties we might need to render all components in here
+  const allProps: Record<string, unknown> = {
+    currencies: [],
+    steps: [],
+    stepper: {
+      steps: [],
+    },
+    items: [],
+    children: 'yo',
+    id: '1',
+    text: 'test',
+    timeout: 0,
+    timestamp: 1,
+    title: 'trolo',
+    name: 'lolo',
+    label: 'hello',
+    content: 'world',
+    currency: 'XYZ',
+    amount: 0,
+    options: [],
+    model: {},
+    fields: {},
+    media: <h1>Hello</h1>,
+    onClick: jest.fn(),
+    onChange: jest.fn(),
+    status: 'processing',
+    size: 'sm',
+    body: 'body',
+    onClose: jest.fn(),
+    onDismiss: jest.fn(),
+    onRemove: jest.fn(),
+    radios: [
+      {
+        id: 'id-test-0',
+        label: 'Radio1',
+      },
+      {
+        id: 'id-test-0',
+        label: 'Radio1',
+      },
+    ],
+    position: 'left',
+    open: true,
+    tabs: [],
+    direction: {
+      xs: 'column',
+      sm: 'row',
+      md: 'column',
+      lg: 'row',
+    },
+    alt: '',
+    src: '',
+    details: 'yo',
+    icon: <svg />,
+    badge: <svg />,
+    link: 'link',
+    href: '#',
+    description: 'description',
+    'aria-label': 'a label',
+    logo: <svg />,
+    chips: [
+      {
+        value: 1,
+        label: 'One',
+      },
+      {
+        value: 2,
+        label: 'Two',
+      },
+    ],
+    segments: [
+      {
+        id: '1',
+        value: 'accounting',
+        label: 'Accounting',
+      },
+      {
+        id: '2',
+        value: 'payroll',
+        label: 'Payroll',
+      },
+      {
+        id: '3',
+        value: 'reporting',
+        label: 'Reporting',
+      },
+    ],
+  };
+
+  // Override props in case of name collision.
+  const overrideProps: Partial<Record<keyof ExposedLibraryItemsType, Record<string, unknown>>> = {
+    Alert: { children: undefined, message: 'Fluffy kittens', size: undefined },
+    Card: { isExpanded: true },
+    CheckboxButton: { children: undefined, onChange: jest.fn() },
+    Typeahead: { size: 'md' },
+    InputWithDisplayFormat: { displayPattern: '**-**' },
+    TextareaWithDisplayFormat: { displayPattern: '**-**' },
+    Sticky: { position: 'top' },
+    MoneyInput: { selectedCurrency: { currency: 'EUR' } },
+    Tabs: { selected: 1, onTabSelect: jest.fn() },
+    Markdown: { children: '# Markdown string' },
+    SnackbarConsumer: {
+      children: jest.fn(),
+    },
+    SnackbarContext: {
+      children: jest.fn(),
+    },
+    Popover: {
+      children: <div />,
+    },
+    Progress: {
+      progress: { value: 50, max: 100 },
+    },
+    ProgressBar: {
+      progress: { value: 50, max: 100 },
+    },
+    Field: {
+      model: 'a model',
+      type: 'text',
+      children: <input />,
+    },
+    Input: {
+      children: undefined,
+    },
+    SearchInput: {
+      children: undefined,
+    },
+    TextArea: {
+      children: undefined,
+    },
+    Summary: {
+      status: 'done',
+      content: undefined,
+    },
+    Modal: { position: 'top' },
+    ActionOption: { action: 'hello' },
+    DateLookup: { value: new Date() },
+    Link: { size: 16 },
+    Tooltip: { children: <>yo</> },
+    SelectOption: { placeholder: { media: <img alt="img" /> } },
+  };
+
+  const { Provider } = exposedLibraryItems;
+  type ComponentWithProvider = React.ComponentType<unknown> & {
+    Provider?: React.ComponentType<unknown>;
+  };
+
+  componentNames.forEach((componentName: ExposedLibraryKeysType) => {
+    it(`can render component: ${componentName}`, () => {
+      const Component = exposedLibraryItems[componentName] as ComponentWithProvider;
+      const newProps = { ...allProps };
+
+      Object.keys(overrideProps[componentName] ?? {}).forEach((propertyToOverrideKey) => {
+        const key = propertyToOverrideKey as keyof (typeof overrideProps)[typeof componentName];
+        newProps[key] = overrideProps?.[componentName]?.[key];
+      });
+
+      const view = renderToString(
+        <Provider i18n={{ locale: 'en-GB', messages: en }}>
+          {componentName.endsWith('Context') && Component.Provider ? (
+            <Component.Provider {...newProps} />
+          ) : (
+            <div>
+              <Component {...newProps} />
+            </div>
+          )}
+        </Provider>,
+      );
+
+      expect(view).toStrictEqual(expect.any(String));
+    });
+  });
+});

package/src/test-utils/{index.js → index.tsx}

@@ -1,8 +1,9 @@
+import { ReactElement, FC } from 'react';
 import { render, renderHook } from '@testing-library/react';
 import { userEvent } from '@testing-library/user-event';
 
 import { Provider } from '..';
-import { DEFAULT_LOCALE } from '../common/locale';
+import { DEFAULT_LOCALE } from '../common';
 import en from '../i18n/en.json';
 
 /**
@@ -10,9 +11,11 @@ import en from '../i18n/en.json';
  * Source: https://testing-library.com/docs/example-react-intl/#creating-a-custom-render-function
  *
  */
-function customRender(ui, { locale = DEFAULT_LOCALE, messages = en, ...renderOptions } = {}) {
-  // eslint-disable-next-line react/prop-types
-  const Wrapper = ({ children }) => {
+function customRender(
+  ui: ReactElement,
+  { locale = DEFAULT_LOCALE, messages = en, ...renderOptions } = {},
+): ReturnType<typeof render> {
+  const Wrapper: FC<{ children: React.ReactNode }> = ({ children }) => {
     return <Provider i18n={{ locale, messages }}>{children}</Provider>;
   };
   return render(ui, { wrapper: Wrapper, ...renderOptions });
@@ -21,9 +24,11 @@ function customRender(ui, { locale = DEFAULT_LOCALE, messages = en, ...renderOpt
 /**
  * Custom `renderHook` function which wraps passed elements in Provider component
  * For more info: https://react-hooks-testing-library.com/usage/advanced-hooks#context
- *
  */
-function customRenderHook(callback, { locale = DEFAULT_LOCALE, messages = en } = {}) {
+function customRenderHook(
+  callback: () => unknown,
+  { locale = DEFAULT_LOCALE, messages = en } = {},
+) {
   return renderHook(callback, {
     wrapper: ({ children }) => <Provider i18n={{ locale, messages }}>{children}</Provider>,
   });

package/src/test-utils/{jest.setup.js → jest.setup.ts}

@@ -1,14 +1,19 @@
-require('@testing-library/jest-dom');
+import util from 'node:util';
+import '@testing-library/jest-dom';
 
-const { default: Adapter } = require('@cfaester/enzyme-adapter-react-18');
-const Enzyme = require('enzyme');
-const util = require('node:util');
+import Adapter from '@cfaester/enzyme-adapter-react-18';
+import Enzyme from 'enzyme';
+import fetchMock from 'jest-fetch-mock';
 
-global.fetch = require('jest-fetch-mock');
+global.fetch = fetchMock as unknown as typeof global.fetch;
 
+// eslint-disable-next-line @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-unsafe-call
 Enzyme.configure({ adapter: new Adapter() });
 
-global.requestAnimationFrame = (callback) => callback();
+global.requestAnimationFrame = (callback: (time: number) => void): number => {
+  callback(performance.now());
+  return 0;
+};
 
 Object.defineProperty(global, 'TextEncoder', {
   value: util.TextEncoder,
@@ -18,7 +23,7 @@ Object.defineProperty(global, 'TextEncoder', {
 // This mock will make tests fail when props error occurs.
 const { error, warn } = console;
 // eslint-disable-next-line no-console
-console.error = (message, ...args) => {
+console.error = (message: string, ...args: unknown[]): void => {
   if (/(Invalid prop|Failed prop type)/i.test(message)) {
     throw new Error(message);
   }
@@ -27,7 +32,7 @@ console.error = (message, ...args) => {
 };
 
 // eslint-disable-next-line no-console
-console.warn = (message, ...args) => {
+console.warn = (message: string, ...args: unknown[]): void => {
   if (/(Call to useTheme outside a ThemeProvider)/i.test(message)) {
     return;
   }