@react-native/jest-preset 0.85.0-nightly-20260219-44901aaf9

package/README.md

@@ -0,0 +1,39 @@
+# @react-native/jest-preset
+
+Jest preset for [React Native](https://reactnative.dev) apps.
+
+## Usage
+
+### Installation
+
+Install `@react-native/jest-preset` in your app:
+
+with `npm`:
+
+```sh
+npm i @react-native/jest-preset --save-dev
+```
+
+or with `yarn`:
+
+```sh
+yarn add -D @react-native/jest-preset
+```
+
+### Configuring Jest
+
+Then, create a file called `jest.config.js` in your project's root directory. Then load this preset:
+
+```
+module.exports = {
+  preset: '@react-native/jest-preset',
+};
+```
+
+You can further customize your Jest configuration by specifying other options. See [Jest's `jest.config.js` documentation](https://jestjs.io/docs/configuration) to learn more.
+
+### Migration Note
+
+This Jest preset used to be part of the core `react-native` package and accessible at `react-native/jest-preset.js`. As long as `@react-native/jest-preset` is installed, `react-native/jest-preset.js` will be aliased to this package and continue to work but is deprecated.
+
+Follow the installation instructions above to migrate to `@react-native/jest-preset` and change `preset: 'react-native'` to `preset: '@react-native/jest-preset` to migrate.

package/jest/MockNativeMethods.js

@@ -0,0 +1,27 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @flow strict
+ * @format
+ */
+
+const MockNativeMethods = {
+  measure: jest.fn(),
+  measureInWindow: jest.fn(),
+  measureLayout: jest.fn(),
+  setNativeProps: jest.fn(),
+  focus: jest.fn(),
+  blur: jest.fn(),
+} as {
+  measure: () => void,
+  measureInWindow: () => void,
+  measureLayout: () => void,
+  setNativeProps: () => void,
+  focus: () => void,
+  blur: () => void,
+};
+
+export default MockNativeMethods;

package/jest/RefreshControlMock.js

@@ -0,0 +1,32 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @flow strict-local
+ * @format
+ */
+
+'use strict';
+
+import type {HostComponent} from 'react-native/src/private/types/HostComponent';
+
+import * as React from 'react';
+import requireNativeComponent from 'react-native/Libraries/ReactNative/requireNativeComponent';
+
+const RCTRefreshControl: HostComponent<{}> = requireNativeComponent<{}>(
+  'RCTRefreshControl',
+);
+
+export default class RefreshControlMock extends React.Component<{...}> {
+  static latestRef: ?RefreshControlMock;
+
+  render(): React.Node {
+    return <RCTRefreshControl />;
+  }
+
+  componentDidMount() {
+    RefreshControlMock.latestRef = this;
+  }
+}

package/jest/assetFileTransformer.js

@@ -0,0 +1,38 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @noflow
+ * @format
+ */
+
+'use strict';
+
+/* eslint-env node */
+
+const createCacheKeyFunction =
+  require('@jest/create-cache-key-function').default;
+const path = require('path');
+
+// NOTE: This file used to be at `react-native/jest/assetFileTransformer.js`
+// To keep the mock `testUri` paths the same, we create a fake path that outputs the same relative path as before
+const basePath = path.resolve(
+  require.resolve('react-native/package.json'),
+  '../jest/',
+);
+
+module.exports = {
+  // Mocks asset requires to return the filename. Makes it possible to test that
+  // the correct images are loaded for components. Essentially
+  // require('img1.png') becomes `Object { "testUri": 'path/to/img1.png' }` in
+  // the Jest snapshot.
+  process: (_, filename) => ({
+    code: `module.exports = {
+      testUri:
+        ${JSON.stringify(path.relative(basePath, filename).replace(/\\/g, '/'))}
+    };`,
+  }),
+  getCacheKey: createCacheKeyFunction([__filename]),
+};

package/jest/local-setup.js

@@ -0,0 +1,29 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @flow strict-local
+ * @format
+ */
+
+// Global setup for tests local to the react-native repo. This setup is not
+// included in the react-native Jest preset.
+
+import './setup';
+
+const consoleError = console.error;
+const consoleWarn = console.warn;
+
+// $FlowFixMe[cannot-write]
+console.error = (...args) => {
+  consoleError(...args);
+  throw new Error('console.error() was called (see error above)');
+};
+
+// $FlowFixMe[cannot-write]
+console.warn = (...args) => {
+  consoleWarn(...args);
+  throw new Error('console.warn() was called (see warning above)');
+};

package/jest/mock.js

@@ -0,0 +1,39 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @flow strict
+ * @format
+ * @oncall react_native
+ */
+
+/**
+ * Mocks the module referenced by `moduleRef` (expected to begin with `m#`)
+ * while enforcing type safety of mock factories.
+ *
+ * If `factoryRef` is provided, it is expected to reference a module that
+ * exports the same type signature as the module referenced by `moduleRef`.
+ */
+export default function mock<TModuleRef: $Flow$ModuleRef<unknown>>(
+  moduleRef: TModuleRef,
+  factoryRef?: NoInfer<TModuleRef>,
+): void {
+  // NOTE: Jest's `babel-plugin-jest-hoist` requires that the second argument to
+  // `jest.mock` be an inline function, so structure this code accordingly.
+  if (factoryRef === undefined) {
+    jest.mock(deref(moduleRef));
+  } else {
+    // NOTE: Jest's `babel-plugin-jest-hoist` requires that module factories
+    // only reference local variables or variables starting with "mock", so be
+    // careful when renaming this `mockFactory` variable.
+    const mockFactory = deref(factoryRef);
+    jest.mock(deref(moduleRef), () => jest.requireActual(mockFactory));
+  }
+}
+
+function deref(ref: $Flow$ModuleRef<unknown>): string {
+  // $FlowFixMe[incompatible-type]
+  return (ref as string).substring(2);
+}

package/jest/mockComponent.js

@@ -0,0 +1,103 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @flow strict
+ * @format
+ */
+
+import * as React from 'react';
+import {createElement} from 'react';
+
+type Modulish<T> = T | Readonly<{default: T}>;
+type ModuleDefault<T> = T['default'];
+
+type TComponentType = React.ComponentType<{...}>;
+
+/**
+ * WARNING: The `moduleName` must be relative to this file's directory, which is
+ * a major footgun. Be careful when using this function!
+ */
+export default function mockComponent<
+  TComponentModule: Modulish<TComponentType>,
+  TIsESModule: boolean,
+>(
+  moduleName: string,
+  instanceMethods: ?interface {},
+  isESModule: TIsESModule,
+): TIsESModule extends true // $FlowFixMe[incompatible-use]
+  ? ModuleDefault<TComponentModule & typeof instanceMethods>
+  : TComponentModule & typeof instanceMethods {
+  const RealComponent: TComponentType = isESModule
+    ? // $FlowFixMe[prop-missing]
+      jest.requireActual<TComponentModule>(moduleName).default
+    : // $FlowFixMe[incompatible-type]
+      jest.requireActual<TComponentModule>(moduleName);
+
+  const SuperClass: typeof React.Component<{...}> =
+    typeof RealComponent === 'function' &&
+    RealComponent.prototype?.constructor instanceof React.Component
+      ? RealComponent
+      : React.Component;
+
+  const name =
+    RealComponent.displayName ??
+    RealComponent.name ??
+    // $FlowFixMe[prop-missing] - Checking for `forwardRef` values.
+    (RealComponent.render == null
+      ? 'Unknown'
+      : // $FlowFixMe[incompatible-use]
+        (RealComponent.render.displayName ?? RealComponent.render.name));
+
+  const nameWithoutPrefix = name.replace(/^(RCT|RK)/, '');
+
+  const Component = class extends SuperClass {
+    static displayName: ?string = 'Component';
+
+    render(): React.Node {
+      // $FlowFixMe[prop-missing]
+      const props = {...RealComponent.defaultProps};
+
+      if (this.props) {
+        Object.keys(this.props).forEach(prop => {
+          // We can't just assign props on top of defaultProps
+          // because React treats undefined as special and different from null.
+          // If a prop is specified but set to undefined it is ignored and the
+          // default prop is used instead. If it is set to null, then the
+          // null value overwrites the default value.
+          if (this.props[prop] !== undefined) {
+            props[prop] = this.props[prop];
+          }
+        });
+      }
+
+      // $FlowFixMe[not-a-function]
+      // $FlowFixMe[prop-missing]
+      return createElement(nameWithoutPrefix, props, this.props.children);
+    }
+  };
+
+  Object.defineProperty(Component, 'name', {
+    value: name,
+    writable: false,
+    enumerable: false,
+    configurable: true,
+  });
+
+  Component.displayName = nameWithoutPrefix;
+
+  // $FlowFixMe[not-an-object]
+  Object.keys(RealComponent).forEach(classStatic => {
+    Component[classStatic] = RealComponent[classStatic];
+  });
+
+  if (instanceMethods != null) {
+    // $FlowFixMe[unsafe-object-assign]
+    Object.assign(Component.prototype, instanceMethods);
+  }
+
+  // $FlowFixMe[incompatible-type]
+  return Component;
+}

package/jest/mockNativeComponent.js

@@ -0,0 +1,52 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @flow strict
+ * @format
+ */
+
+import type {HostInstance} from 'react-native/src/private/types/HostInstance';
+
+import * as React from 'react';
+import {createElement} from 'react';
+
+let nativeTag = 1;
+
+type MockNativeComponent<TProps: {...}> = component(
+  ref?: ?React.RefSetter<HostInstance>,
+  ...props: TProps
+);
+
+export default function mockNativeComponent<TProps: {...}>(
+  viewName: string,
+): MockNativeComponent<TProps> {
+  const Component = class extends React.Component<TProps> {
+    _nativeTag: number = nativeTag++;
+
+    render(): React.Node {
+      // $FlowFixMe[not-a-function]
+      // $FlowFixMe[prop-missing]
+      return createElement(viewName, this.props, this.props.children);
+    }
+
+    // The methods that exist on host components
+    blur: () => void = jest.fn();
+    focus: () => void = jest.fn();
+    measure: () => void = jest.fn();
+    measureInWindow: () => void = jest.fn();
+    measureLayout: () => void = jest.fn();
+    setNativeProps: () => void = jest.fn();
+  };
+
+  if (viewName === 'RCTView') {
+    Component.displayName = 'View';
+  } else {
+    Component.displayName = viewName;
+  }
+
+  // $FlowFixMe[incompatible-type] - Error supressed during the migration of HostInstance to ReactNativeElement
+  return Component;
+}

package/jest/mocks/AccessibilityInfo.js

@@ -0,0 +1,62 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @flow strict
+ * @format
+ */
+
+const AccessibilityInfo = {
+  addEventListener: jest.fn(() => ({
+    remove: jest.fn(),
+  })) as JestMockFn<$FlowFixMe, {remove: JestMockFn<[], void>}>,
+  announceForAccessibility: jest.fn() as JestMockFn<$FlowFixMe, $FlowFixMe>,
+  announceForAccessibilityWithOptions: jest.fn() as JestMockFn<
+    $FlowFixMe,
+    $FlowFixMe,
+  >,
+  isAccessibilityServiceEnabled: jest.fn(() =>
+    Promise.resolve(false),
+  ) as JestMockFn<$FlowFixMe, $FlowFixMe>,
+  isBoldTextEnabled: jest.fn(() => Promise.resolve(false)) as JestMockFn<
+    $FlowFixMe,
+    $FlowFixMe,
+  >,
+  isGrayscaleEnabled: jest.fn(() => Promise.resolve(false)) as JestMockFn<
+    $FlowFixMe,
+    $FlowFixMe,
+  >,
+  isInvertColorsEnabled: jest.fn(() => Promise.resolve(false)) as JestMockFn<
+    $FlowFixMe,
+    $FlowFixMe,
+  >,
+  isReduceMotionEnabled: jest.fn(() => Promise.resolve(false)) as JestMockFn<
+    $FlowFixMe,
+    $FlowFixMe,
+  >,
+  isHighTextContrastEnabled: jest.fn(() =>
+    Promise.resolve(false),
+  ) as JestMockFn<$FlowFixMe, $FlowFixMe>,
+  isDarkerSystemColorsEnabled: jest.fn(() =>
+    Promise.resolve(false),
+  ) as JestMockFn<$FlowFixMe, $FlowFixMe>,
+  prefersCrossFadeTransitions: jest.fn(() =>
+    Promise.resolve(false),
+  ) as JestMockFn<$FlowFixMe, $FlowFixMe>,
+  isReduceTransparencyEnabled: jest.fn(() =>
+    Promise.resolve(false),
+  ) as JestMockFn<$FlowFixMe, $FlowFixMe>,
+  isScreenReaderEnabled: jest.fn(() => Promise.resolve(false)) as JestMockFn<
+    $FlowFixMe,
+    $FlowFixMe,
+  >,
+  setAccessibilityFocus: jest.fn() as JestMockFn<$FlowFixMe, $FlowFixMe>,
+  sendAccessibilityEvent: jest.fn() as JestMockFn<$FlowFixMe, $FlowFixMe>,
+  getRecommendedTimeoutMillis: jest.fn(() =>
+    Promise.resolve(false),
+  ) as JestMockFn<$FlowFixMe, $FlowFixMe>,
+};
+
+export default AccessibilityInfo;

package/jest/mocks/ActivityIndicator.js

@@ -0,0 +1,23 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @flow strict-local
+ * @format
+ */
+
+import typeof * as TmockComponent from '../mockComponent';
+import typeof TActivityIndicator from 'react-native/Libraries/Components/ActivityIndicator/ActivityIndicator';
+
+const mockComponent =
+  jest.requireActual<TmockComponent>('../mockComponent').default;
+
+const ActivityIndicator = mockComponent(
+  'react-native/Libraries/Components/ActivityIndicator/ActivityIndicator',
+  null, // instanceMethods
+  true, // isESModule
+) as TActivityIndicator;
+
+export default ActivityIndicator;

package/jest/mocks/AppState.js

@@ -0,0 +1,19 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @flow strict
+ * @format
+ */
+
+const AppState = {
+  addEventListener: jest.fn(() => ({
+    remove: jest.fn(),
+  })) as JestMockFn<$FlowFixMe, $FlowFixMe>,
+  removeEventListener: jest.fn() as JestMockFn<$FlowFixMe, $FlowFixMe>,
+  currentState: jest.fn() as JestMockFn<$FlowFixMe, $FlowFixMe>,
+};
+
+export default AppState;

package/jest/mocks/Clipboard.js

@@ -0,0 +1,16 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @flow strict
+ * @format
+ */
+
+const Clipboard = {
+  getString: jest.fn(async () => '') as JestMockFn<[], Promise<string>>,
+  setString: jest.fn() as JestMockFn<[string], void>,
+};
+
+export default Clipboard;

package/jest/mocks/Image.js

@@ -0,0 +1,23 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @flow strict-local
+ * @format
+ */
+
+import typeof * as TmockComponent from '../mockComponent';
+import typeof TImage from 'react-native/Libraries/Image/Image';
+
+const mockComponent =
+  jest.requireActual<TmockComponent>('../mockComponent').default;
+
+const Image = mockComponent(
+  'react-native/Libraries/Image/Image',
+  null, // instanceMethods
+  true, // isESModule
+) as TImage;
+
+export default Image;

package/jest/mocks/InitializeCore.js

@@ -0,0 +1,9 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @flow strict
+ * @format
+ */

package/jest/mocks/Linking.js

@@ -0,0 +1,28 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @flow strict
+ * @format
+ */
+
+const Linking = {
+  openURL: jest.fn() as JestMockFn<$FlowFixMe, $FlowFixMe>,
+  canOpenURL: jest.fn(() => Promise.resolve(true)) as JestMockFn<
+    $FlowFixMe,
+    $FlowFixMe,
+  >,
+  openSettings: jest.fn() as JestMockFn<$FlowFixMe, $FlowFixMe>,
+  addEventListener: jest.fn(() => ({
+    remove: jest.fn(),
+  })) as JestMockFn<$FlowFixMe, $FlowFixMe>,
+  getInitialURL: jest.fn(() => Promise.resolve()) as JestMockFn<
+    $FlowFixMe,
+    $FlowFixMe,
+  >,
+  sendIntent: jest.fn() as JestMockFn<$FlowFixMe, $FlowFixMe>,
+};
+
+export default Linking;

package/jest/mocks/Modal.js

@@ -0,0 +1,33 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @flow strict-local
+ * @format
+ */
+
+import typeof * as TmockComponent from '../mockComponent';
+import type {ModalProps} from 'react-native/Libraries/Modal/Modal';
+
+const mockComponent =
+  jest.requireActual<TmockComponent>('../mockComponent').default;
+
+type TModal = component(...ModalProps);
+
+const BaseComponent = mockComponent(
+  'react-native/Libraries/Modal/Modal',
+  null, // instanceMethods
+  true, // isESModule
+) as TModal;
+
+// $FlowFixMe[incompatible-use]
+export default class Modal extends BaseComponent {
+  render(): React.Node {
+    if (this.props.visible === false) {
+      return null;
+    }
+    return <BaseComponent {...this.props}>{this.props.children}</BaseComponent>;
+  }
+}

package/jest/mocks/NativeComponentRegistry.js

@@ -0,0 +1,30 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @flow strict
+ * @format
+ */
+
+import typeof * as TmockNativeComponent from '../mockNativeComponent';
+
+const mockNativeComponent = jest.requireActual<TmockNativeComponent>(
+  '../mockNativeComponent',
+).default;
+
+export const get = jest.fn((name, viewConfigProvider) => {
+  return mockNativeComponent(name);
+}) as JestMockFn<$FlowFixMe, $FlowFixMe>;
+
+export const getWithFallback_DEPRECATED = jest.fn(
+  (name, viewConfigProvider) => {
+    return mockNativeComponent(name);
+  },
+) as JestMockFn<$FlowFixMe, $FlowFixMe>;
+
+export const setRuntimeConfigProvider = jest.fn() as JestMockFn<
+  $FlowFixMe,
+  $FlowFixMe,
+>;