@trackunit/react-test-setup 1.0.0

package/src/setupAllMocks.d.ts

@@ -0,0 +1,38 @@
+import { setupFailOnConsole } from "./setupFailOnConsole";
+export interface SetupAllMocksOptions {
+    failOnConsoleOptions?: Parameters<typeof setupFailOnConsole>[0];
+}
+/**
+ * Sets up all available testing mocks in a single function call.
+ *
+ * This convenience function sets up all the test mocks provided by the library:
+ * - Canvas API mocks
+ * - Console error reporting to fail tests
+ * - Google Maps API and components mocks
+ * - React Helmet mocks
+ * - IntersectionObserver mocks
+ * - MatchMedia API mocks
+ * - React Testing Library and Okta authentication mocks
+ * - React Virtualized AutoSizer mocks
+ * - ResizeObserver mocks
+ * - Tanstack React Virtual mocks
+ * - Time and language related mocks (timezone, timers, etc.)
+ * - Translation mocks (i18n)
+ * - Web Streams API mocks
+ *
+ * Using this function is equivalent to calling each setup function individually.
+ *
+ * @param options Configuration options for individual mocks
+ * @param options.failOnConsoleOptions Options for setupFailOnConsole
+ * @example
+ * // In your jest setup file
+ * import { setupAllMocks } from '@trackunit/react-test-setup';
+ *
+ * setupAllMocks();
+ *
+ * // Or with options for specific mocks:
+ * setupAllMocks({
+ *   failOnConsoleOptions: { shouldFailOnWarn: true }
+ * });
+ */
+export declare const setupAllMocks: (options?: SetupAllMocksOptions) => void;

package/src/setupBasicMocks.d.ts

@@ -0,0 +1,12 @@
+import { SetupAllMocksOptions } from "./setupAllMocks";
+/**
+ * Options for configuring the setupBasicMocks function.
+ * Currently shares the same options structure as SetupAllMocksOptions.
+ */
+export type SetupBasicMocksOptions = SetupAllMocksOptions;
+/**
+ * Sets up essential testing mocks with no external library dependencies.
+ *
+ * @param options Configuration options for the mocks
+ */
+export declare const setupBasicMocks: (options?: SetupBasicMocksOptions) => void;

package/src/setupCanvasMock.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Sets up a mock implementation for HTML Canvas API in testing environments.
+ *
+ * This function uses jest-canvas-mock to provide a mock implementation of the
+ * HTML Canvas API, allowing tests to run without requiring a real DOM canvas.
+ * Useful for testing components that use canvas rendering.
+ *
+ * @example
+ * // In your jest setup file
+ * import { setupCanvasMock } from '@trackunit/react-test-setup';
+ *
+ * setupCanvasMock();
+ */
+export declare const setupCanvasMock: () => void;

package/src/setupDefaultMocks.d.ts

@@ -0,0 +1,49 @@
+/**
+ * Sets up default testing mocks that cover most common React testing needs.
+ *
+ * This convenience function provides a balanced set of mocks that cover most React
+ * application testing needs. It includes all the basic mocks plus essential React
+ * testing utilities. Specifically, it includes:
+ *
+ * From setupBasicMocks:
+ * - Canvas API mocks
+ * - Console error reporting to fail tests
+ * - IntersectionObserver mocks
+ * - MatchMedia API mocks
+ * - ResizeObserver mocks
+ * - Timer mocks (setTimeout, setInterval)
+ * - Web Streams API mocks
+ *
+ * Plus these additional mocks:
+ * - React Testing Library and Okta authentication mocks
+ * - Translation mocks (i18n)
+ *
+ * This is ideal for most React applications that use i18n translations and need
+ * standard testing environment setup, without requiring specialized mocks for things
+ * like Google Maps or virtualized lists.
+ *
+ * @param options Configuration options for individual mocks
+ * @param options.failOnConsoleOptions Options for setupFailOnConsole
+ * @example
+ * // In your jest setup file
+ * import { setupDefaultMocks } from '@trackunit/react-test-setup';
+ *
+ * setupDefaultMocks();
+ *
+ * // Or with options for specific mocks:
+ * setupDefaultMocks({
+ *   failOnConsoleOptions: { shouldFailOnWarn: true }
+ * });
+ */
+import { SetupBasicMocksOptions } from "./setupBasicMocks";
+/**
+ * Options for configuring the setupDefaultMocks function.
+ * Currently shares the same options structure as SetupBasicMocksOptions.
+ */
+export type SetupDefaultMocksOptions = SetupBasicMocksOptions;
+/**
+ * Sets up default testing mocks covering most common React testing scenarios.
+ *
+ * @param options Configuration options for the mocks
+ */
+export declare const setupDefaultMocks: (options?: SetupDefaultMocksOptions) => void;

package/src/setupFailOnConsole.d.ts

@@ -0,0 +1,13 @@
+import failOnConsole from "jest-fail-on-console";
+/**
+ * This will make your tests fail if they log to console.error during the tests.
+ * See more details here: https://www.npmjs.com/package/jest-fail-on-console
+ *
+ * If your tests logs to console.error on purpose, you should spy on the console like so:
+ * ```
+ * jest.spyOn(console, 'error').mockImplementation()
+ * // Do your logic ...
+ * expect(console.error).toHaveBeenCalledWith('your error message')
+ * ```
+ */
+export declare const setupFailOnConsole: (overrides?: Partial<failOnConsole.InitOptions>) => void;

package/src/setupGoogleMaps.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Sets up mocks for Google Maps API and @vis.gl/react-google-maps components in testing environments.
+ *
+ * This function mocks both the Google Maps JavaScript API and React components from @vis.gl/react-google-maps.
+ * It provides mock implementations of Maps, Markers, Geocoder, geometry functions, and places services,
+ * allowing tests of map-dependent components to run without requiring the actual Google Maps API.
+ *
+ * Key features:
+ * - Mocks core Map and Marker components with simple test-friendly implementations
+ * - Provides placeholders for Google Maps geometry calculations
+ * - Stubs out Places API services
+ * - Makes map-related hooks always return loaded state
+ *
+ * @example
+ * // In your jest setup file
+ * import { setupGoogleMaps } from '@trackunit/react-test-setup';
+ *
+ * setupGoogleMaps();
+ */
+export declare const setupGoogleMaps: () => void;

package/src/setupHelmetMock.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Mock helmet module
+ * See more details here: https://www.npmjs.com/package/react-helmet-async
+ */
+export declare const setupHelmetMock: () => void;

package/src/setupIntersectionObserver.d.ts

@@ -0,0 +1,32 @@
+/**
+ * Mocks the IntersectionObserver API for testing environments.
+ *
+ * This function adds a mock implementation of the IntersectionObserver API to the global window object.
+ * The mock implementation provides all the necessary methods (observe, unobserve, disconnect, takeRecords)
+ * but with empty implementations, allowing tests of components that use IntersectionObserver to run
+ * without errors in Jest's JSDOM environment.
+ *
+ * Useful for testing components that rely on:
+ * - Lazy loading
+ * - Infinite scrolling
+ * - Visibility-based rendering
+ * - Any other intersection-based functionality
+ *
+ * @example
+ * // In your jest setup file
+ * import { setupIntersectionObserver } from '@trackunit/react-test-setup';
+ *
+ * setupIntersectionObserver();
+ */
+export declare const setupIntersectionObserver: () => typeof MockIntersectionObserver;
+declare class MockIntersectionObserver {
+    readonly root: Element | null;
+    readonly rootMargin: string;
+    readonly thresholds: readonly number[];
+    constructor();
+    disconnect(): void;
+    observe(): void;
+    takeRecords(): IntersectionObserverEntry[];
+    unobserve(): void;
+}
+export {};

package/src/setupMatchMediaMock.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Mocks the window.matchMedia API for testing environments.
+ *
+ * This function creates a mock implementation of the window.matchMedia method that
+ * is commonly used for responsive design and media queries. The mock always returns
+ * a MediaQueryList-like object with standard methods and properties, but with default
+ * values (matches set to false).
+ *
+ * This allows tests of components that use media queries to run without errors in
+ * Jest's JSDOM environment, which doesn't implement matchMedia natively.
+ *
+ * Ideal for testing:
+ * - Responsive components
+ * - Components that adapt to screen size changes
+ * - Components that use CSS media query matching in JavaScript
+ *
+ * @example
+ * // In your jest setup file
+ * import { setupMatchMediaMock } from '@trackunit/react-test-setup';
+ *
+ * setupMatchMediaMock();
+ */
+export declare const setupMatchMediaMock: () => void;

package/src/setupReactTestingLibrary.d.ts

@@ -0,0 +1,25 @@
+import "@testing-library/jest-dom";
+/**
+ * Sets up React Testing Library and Okta authentication mocks for testing.
+ *
+ * This function configures the testing environment with essential mocks for Okta authentication,
+ * which is necessary for testing components that use Okta for authentication. It creates
+ * mock implementations of Okta authentication objects, tokens, and authentication state,
+ * allowing tests to run without requiring an actual Okta authentication flow.
+ *
+ * The module also imports @testing-library/jest-dom to extend Jest with DOM testing assertions
+ * and sets up afterEach hooks to clear mocks and clean up after each test.
+ *
+ * Key features:
+ * - Mocks Okta tokens and authentication state
+ * - Creates mock implementations of Okta auth methods
+ * - Extends Jest with DOM testing assertions
+ * - Automatically cleans up after each test
+ *
+ * @example
+ * // In your jest setup file
+ * import { setupReactTestingLibrary } from '@trackunit/react-test-setup';
+ *
+ * setupReactTestingLibrary();
+ */
+export declare const setupReactTestingLibrary: () => void;

package/src/setupReactVirtualizedAutoSizer.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Mocks the react-virtualized-auto-sizer component for testing environments.
+ *
+ * This function creates a mock implementation of the AutoSizer component from
+ * react-virtualized-auto-sizer, which is commonly used to measure and adapt to
+ * container dimensions. Instead of actual dimension measurements, the mock provides
+ * fixed dimensions (600x600), allowing tests to run consistently without actual DOM measuring.
+ *
+ * This is especially useful for testing components that use virtualized lists or grids,
+ * as it eliminates the need for setting up complex DOM environments just to get measurements.
+ *
+ * @example
+ * // In your jest setup file
+ * import { setupReactVirtualizedAutoSizer } from '@trackunit/react-test-setup';
+ *
+ * setupReactVirtualizedAutoSizer();
+ */
+export declare const setupReactVirtualizedAutoSizer: () => void;

package/src/setupResizeObserver.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Mock the ResizeObserver to be able to test components that use a resize observer
+ * Like useGeometry, useContainerBreakpoints, etc.
+ * Also componets that _use_ useGeometry, like <BaseInput/> and many more
+ *
+ * Recommended for all react libs
+ */
+export declare const setupResizeObserver: () => void;

package/src/setupTanstackReactVirtualize.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Mocks the @tanstack/react-virtual library for testing environments.
+ *
+ * This function creates a mock implementation of the useVirtualizer hook from
+ * the @tanstack/react-virtual library, which is used for efficiently rendering
+ * large lists and grids. The mock returns a simplified version that generates
+ * virtual items with deterministic sizes and provides all expected methods.
+ *
+ * Each virtual item has:
+ * - A consistent height (40px)
+ * - Index and key properties matching the item's position
+ * - Empty implementation of the measureRef function
+ *
+ * This allows for testing components that use virtualized lists without requiring
+ * actual DOM measurements or complex setup.
+ *
+ * @example
+ * // In your jest setup file
+ * import { setupTanstackReactVirtual } from '@trackunit/react-test-setup';
+ *
+ * setupTanstackReactVirtual();
+ */
+export declare const setupTanstackReactVirtual: () => void;

package/src/setupTimeAndLanguage.d.ts

@@ -0,0 +1,33 @@
+/**
+ * Mocks the Temporal API to use a fixed time zone for testing.
+ *
+ * This function specifically mocks the Temporal.Now.timeZoneId method from the
+ * Temporal library to always return "Europe/Copenhagen", ensuring consistent
+ * time zone-dependent behavior in tests regardless of where they run.
+ *
+ * @example
+ * // In your jest setup file
+ * import { setupTimeZone } from '@trackunit/react-test-setup';
+ *
+ * setupTimeZone();
+ */
+export declare const setupTimeZone: () => void;
+/**
+ * Sets up time, animation, and language-related mocks for testing environments.
+ *
+ * This function configures multiple aspects of the testing environment:
+ * 1. Sets a fixed time zone using setupTimeZone()
+ * 2. Disables React Spring animations for faster, deterministic tests
+ * 3. Mocks the useDebounce hook to immediately return values without delays
+ * 4. Overrides setTimeout and setInterval to execute immediately (0ms delay)
+ *
+ * These changes make tests faster and more predictable by eliminating real-time
+ * delays, animations, and time zone dependencies that could cause flaky tests.
+ *
+ * @example
+ * // In your jest setup file
+ * import { setupTimeAndLanguage } from '@trackunit/react-test-setup';
+ *
+ * setupTimeAndLanguage();
+ */
+export declare const setupTimeAndLanguage: () => void;

package/src/setupTranslations.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Sets up internationalization and translation mocks for testing environments.
+ *
+ * This function delegates to the implementation in setupTranslationsImpl.tsx to configure
+ * mock translations for react-i18next and @trackunit/i18n-library-translation. It creates
+ * simple mock implementations that return the key string as the translation, which allows
+ * for testing internationalized components without the complexity of actual translations.
+ *
+ * The mocks support common translation components and hooks like Trans, useTranslation,
+ * NamespaceTrans, and useNamespaceTranslation.
+ *
+ * @example
+ * // In your jest setup file
+ * import { setupTranslations } from '@trackunit/react-test-setup';
+ *
+ * setupTranslations();
+ */
+export declare const setupTranslations: () => void;

package/src/setupTranslationsImpl.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Implementation of translation mocks for testing environments.
+ *
+ * This function creates detailed mock implementations for react-i18next and
+ * Trackunit i18n library translation utilities. The mocks are designed to:
+ *
+ * 1. Return translation keys as the translated strings (with any provided props)
+ * 2. Render components within Trans components by preserving their React structure
+ * 3. Provide a simplified i18n object with expected properties
+ * 4. Handle nested components and rendering flows without complex translation logic
+ *
+ * These mocks allow components that use internationalization to be tested without
+ * requiring actual translation files or i18n initialization, simplifying test setup
+ * while preserving component rendering behavior.
+ *
+ * @internal
+ */
+export declare const setupTranslations: () => void;

package/src/setupWebStreams.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Sets up Web Streams API polyfills for testing environments.
+ *
+ * This function delegates to the implementation in setupWebStreamsImpl.ts to configure
+ * Web Streams API polyfills from web-streams-polyfill. These polyfills provide implementations
+ * of modern streaming APIs that may not be available in the Jest/JSDOM testing environment.
+ *
+ * The setup enables testing of components and utilities that rely on the Web Streams API,
+ * such as those that process streaming data or implement custom stream transformations.
+ *
+ * @example
+ * // In your jest setup file
+ * import { setupWebStreams } from '@trackunit/react-test-setup';
+ *
+ * setupWebStreams();
+ */
+export declare const setupWebStreams: () => void;

package/src/setupWebStreamsImpl.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Implementation for Web Streams API polyfills in testing environments.
+ *
+ * This function adds the TransformStream and WritableStream implementations from
+ * web-streams-polyfill to the global object, making them available to code running
+ * in the Jest/JSDOM environment which may not have native implementations of these APIs.
+ *
+ * These polyfills are essential for testing code that uses modern streaming features,
+ * particularly for scenarios involving:
+ * - Data processing pipelines
+ * - Chunk-by-chunk text or binary processing
+ * - Streaming responses from APIs
+ *
+ * @internal
+ */
+export declare const setupWebStreams: () => void;