react-native-tvos 0.87.1-0 → 0.87.1-1

package/types_generated/Libraries/Image/ImageProps.d.ts

@@ -0,0 +1,462 @@
+/**
+ * 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.
+ *
+ * @generated SignedSource<<c37e4c04ec1c964faaa072452e43f430>>
+ *
+ * This file was translated from Flow by scripts/js-api/build-types/index.js.
+ * Original file: packages/react-native/Libraries/Image/ImageProps.js
+ */
+
+import type { ViewProps } from "../Components/View/ViewPropTypes";
+import type { EdgeInsetsProp } from "../StyleSheet/EdgeInsetsPropType";
+import type { ColorValue, ImageStyleProp, ViewStyleProp } from "../StyleSheet/StyleSheet";
+import type { LayoutChangeEvent, NativeSyntheticEvent } from "../Types/CoreEventTypes";
+import type { ImageResizeMode } from "./ImageResizeMode";
+import type { ImageSource, ImageURISource } from "./ImageSource";
+import type { ImageType } from "./ImageTypes.flow";
+import * as React from "react";
+export type ImageSourcePropType = ImageSource;
+type ImageProgressEventDataIOS = {
+  loaded: number;
+  total: number;
+};
+/**
+ * @see ImagePropsIOS.onProgress
+ */
+export type ImageProgressEventIOS = NativeSyntheticEvent<Readonly<ImageProgressEventDataIOS>>;
+type ImageErrorEventData = {
+  error: string;
+};
+export type ImageErrorEvent = NativeSyntheticEvent<Readonly<ImageErrorEventData>>;
+type ImageLoadEventData = {
+  source: {
+    height: number;
+    width: number;
+    uri: string;
+  };
+};
+export type ImageLoadEvent = NativeSyntheticEvent<Readonly<ImageLoadEventData>>;
+export type ImagePropsIOS = Readonly<{
+  /**
+   * A static image to display while loading the image source.
+   *
+   * @platform ios
+   */
+  defaultSource?: ImageSource | undefined;
+  /**
+   * Invoked when a partial load of the image is complete. Definition of what
+   * constitutes a "partial load" is loader specific though this is meant for
+   * progressive JPEG loads.
+   *
+   * @platform ios
+   */
+  onPartialLoad?: (() => void) | undefined;
+  /**
+   * Invoked on download progress.
+   *
+   * @platform ios
+   */
+  onProgress?: ((event: ImageProgressEventIOS) => void) | undefined;
+}>;
+export type ImagePropsAndroid = Readonly<{
+  /**
+   * Resource used to render a loading indicator for the image, displayed
+   * until the image is ready to be displayed.
+   *
+   * @platform android
+   */
+  loadingIndicatorSource?: (number | Readonly<ImageURISource>) | undefined;
+  /**
+   * When `true`, enables progressive JPEG streaming.
+   *
+   * @default `false`
+   * @platform android
+   */
+  progressiveRenderingEnabled?: boolean | undefined;
+  /**
+   * Duration of the fade-in animation in milliseconds.
+   *
+   * @default `300`
+   * @platform android
+   */
+  fadeDuration?: number | undefined;
+  /**
+   * The mechanism that should be used to resize the image when the image's
+   * dimensions differ from the image view's dimensions.
+   *
+   * - `auto`: Use heuristics to pick between `resize` and `scale`.
+   *
+   * - `resize`: A software operation which changes the encoded image in memory
+   *   before it gets decoded. This should be used instead of `scale` when the
+   *   image is much larger than the view.
+   *
+   * - `scale`: The image gets drawn downscaled or upscaled. Compared to
+   *   `resize`, `scale` is faster (usually hardware accelerated) and produces
+   *   higher quality images. This should be used if the image is smaller than
+   *   the view. It should also be used if the image is slightly bigger than
+   *   the view.
+   *
+   * - `none`: No sampling is performed and the image is displayed in its full
+   *   resolution. This should only be used in rare circumstances because it is
+   *   considered unsafe as Android throws a runtime exception when trying to
+   *   render images that consume too much memory.
+   *
+   * @default `'auto'`
+   * @platform android
+   */
+  resizeMethod?: ("auto" | "resize" | "scale" | "none") | undefined;
+  /**
+   * When `resizeMethod` is set to `resize`, the destination dimensions are
+   * multiplied by this value. The `scale` method is used to perform the
+   * remainder of the resize. This is used to produce higher quality images
+   * when resizing to small dimensions.
+   *
+   * @default `1.0`
+   * @platform android
+   */
+  resizeMultiplier?: number | undefined;
+}>;
+export interface ImagePropsBase extends Readonly<Omit<Omit<ViewProps, "style">, keyof {
+  /**
+   * When `true`, indicates the image is an accessibility element.
+   */
+  accessible?: boolean | undefined;
+  /**
+   * Internal prop to set an "Analytics Tag" that can will be set on the Image.
+   */
+  internal_analyticTag?: string | undefined;
+  /**
+   * The text that's read by the screen reader when the user interacts with
+   * the image.
+   */
+  accessibilityLabel?: string | undefined;
+  /**
+   * Alias for `accessibilityLabel`.
+   */
+  "aria-label"?: string | undefined;
+  /**
+   * Represents the `nativeID` of the associated label. When the assistive
+   * technology focuses on the component with this prop.
+   *
+   * @platform android
+   */
+  "aria-labelledby"?: string | undefined;
+  /**
+   * Alternative text description of the image, read by the screen reader
+   * when the user interacts with it. Automatically marks the element as
+   * accessible.
+   */
+  alt?: string | undefined;
+  /**
+   * The blur radius of the blur filter added to the image. On iOS, needs to
+   * be more than 5.
+   */
+  blurRadius?: number | undefined;
+  /**
+   * When the image is resized, the corners of the size specified by
+   * `capInsets` stay a fixed size, but the center content and borders of
+   * the image are stretched. This is useful for creating resizable rounded
+   * buttons, shadows, and other resizable assets.
+   *
+   * @platform ios
+   */
+  capInsets?: EdgeInsetsProp | undefined;
+  /**
+   * CORS mode for fetching the image resource. When unset, the image
+   * request is made without the CORS header.
+   *
+   * @default `'anonymous'`
+   */
+  crossOrigin?: ("anonymous" | "use-credentials") | undefined;
+  /**
+   * Height of the image component.
+   */
+  height?: number | undefined;
+  /**
+   * Width of the image component.
+   */
+  width?: number | undefined;
+  /**
+   * Invoked on load error.
+   */
+  onError?: ((event: ImageErrorEvent) => void) | undefined;
+  /**
+   * Invoked on mount and on layout changes.
+   */
+  onLayout?: ((event: LayoutChangeEvent) => unknown) | undefined;
+  /**
+   * Invoked when load completes successfully.
+   */
+  onLoad?: ((event: ImageLoadEvent) => void) | undefined;
+  /**
+   * Invoked when load either succeeds or fails.
+   */
+  onLoadEnd?: (() => void) | undefined;
+  /**
+   * Invoked on load start.
+   */
+  onLoadStart?: (() => void) | undefined;
+  /**
+   * The image source (either a remote URL or a local file resource).
+   *
+   * This prop can also contain several remote URLs, specified together with
+   * their width and height and potentially with scale/other URI arguments.
+   * The native side then chooses the best URI to display based on the
+   * measured size of the image container. A `cache` property can be added to
+   * control how networked request interacts with the local cache.
+   *
+   * The currently supported formats are `png`, `jpg`, `jpeg`, `bmp`, `gif`,
+   * `webp` (Android only), and `psd` (iOS only).
+   */
+  source?: ImageSource | undefined;
+  /**
+   * Which referrer to use when fetching the image resource.
+   *
+   * @default `'strict-origin-when-cross-origin'`
+   */
+  referrerPolicy?: ("no-referrer" | "no-referrer-when-downgrade" | "origin" | "origin-when-cross-origin" | "same-origin" | "strict-origin" | "strict-origin-when-cross-origin" | "unsafe-url") | undefined;
+  /**
+   * Determines how to resize the image when the frame doesn't match the raw
+   * image dimensions.
+   *
+   * - `cover`: Scale the image uniformly (maintain the image's aspect ratio)
+   *   so that both dimensions (width and height) of the image are equal to
+   *   or larger than the corresponding dimension of the view (minus padding).
+   *
+   * - `contain`: Scale the image uniformly (maintain the image's aspect
+   *   ratio) so that both dimensions (width and height) of the image are
+   *   equal to or less than the corresponding dimension of the view (minus
+   *   padding).
+   *
+   * - `stretch`: Scale width and height independently. This may change the
+   *   aspect ratio of the source.
+   *
+   * - `repeat`: Repeat the image to cover the frame of the view. The image
+   *   keeps its size and aspect ratio (iOS only).
+   *
+   * - `center`: Scale the image down so that it is completely visible, if
+   *   bigger than the area of the view. The image is not scaled up.
+   *
+   * - `none`: Do not resize the image. The image is displayed at its
+   *   intrinsic size.
+   *
+   * @default `'cover'`
+   */
+  resizeMode?: ImageResizeMode | undefined;
+  testID?: string | undefined;
+  /**
+   * Changes the color of all non-transparent pixels to the `tintColor`.
+   */
+  tintColor?: ColorValue | undefined;
+  /**
+   * A remote URL string for the image resource. Takes precedence over
+   * `source`.
+   */
+  src?: string | undefined;
+  /**
+   * Comma-separated list of candidate image sources with pixel density
+   * descriptors.
+   */
+  srcSet?: string | undefined;
+  children?: never | undefined;
+}>> {
+  /**
+   * When `true`, indicates the image is an accessibility element.
+   */
+  readonly accessible?: boolean | undefined;
+  /**
+   * Internal prop to set an "Analytics Tag" that can will be set on the Image.
+   */
+  readonly internal_analyticTag?: string | undefined;
+  /**
+   * The text that's read by the screen reader when the user interacts with
+   * the image.
+   */
+  readonly accessibilityLabel?: string | undefined;
+  /**
+   * Alias for `accessibilityLabel`.
+   */
+  readonly "aria-label"?: string | undefined;
+  /**
+   * Represents the `nativeID` of the associated label. When the assistive
+   * technology focuses on the component with this prop.
+   *
+   * @platform android
+   */
+  readonly "aria-labelledby"?: string | undefined;
+  /**
+   * Alternative text description of the image, read by the screen reader
+   * when the user interacts with it. Automatically marks the element as
+   * accessible.
+   */
+  readonly alt?: string | undefined;
+  /**
+   * The blur radius of the blur filter added to the image. On iOS, needs to
+   * be more than 5.
+   */
+  readonly blurRadius?: number | undefined;
+  /**
+   * When the image is resized, the corners of the size specified by
+   * `capInsets` stay a fixed size, but the center content and borders of
+   * the image are stretched. This is useful for creating resizable rounded
+   * buttons, shadows, and other resizable assets.
+   *
+   * @platform ios
+   */
+  readonly capInsets?: EdgeInsetsProp | undefined;
+  /**
+   * CORS mode for fetching the image resource. When unset, the image
+   * request is made without the CORS header.
+   *
+   * @default `'anonymous'`
+   */
+  readonly crossOrigin?: ("anonymous" | "use-credentials") | undefined;
+  /**
+   * Height of the image component.
+   */
+  readonly height?: number | undefined;
+  /**
+   * Width of the image component.
+   */
+  readonly width?: number | undefined;
+  /**
+   * Invoked on load error.
+   */
+  readonly onError?: ((event: ImageErrorEvent) => void) | undefined;
+  /**
+   * Invoked on mount and on layout changes.
+   */
+  readonly onLayout?: ((event: LayoutChangeEvent) => unknown) | undefined;
+  /**
+   * Invoked when load completes successfully.
+   */
+  readonly onLoad?: ((event: ImageLoadEvent) => void) | undefined;
+  /**
+   * Invoked when load either succeeds or fails.
+   */
+  readonly onLoadEnd?: (() => void) | undefined;
+  /**
+   * Invoked on load start.
+   */
+  readonly onLoadStart?: (() => void) | undefined;
+  /**
+   * The image source (either a remote URL or a local file resource).
+   *
+   * This prop can also contain several remote URLs, specified together with
+   * their width and height and potentially with scale/other URI arguments.
+   * The native side then chooses the best URI to display based on the
+   * measured size of the image container. A `cache` property can be added to
+   * control how networked request interacts with the local cache.
+   *
+   * The currently supported formats are `png`, `jpg`, `jpeg`, `bmp`, `gif`,
+   * `webp` (Android only), and `psd` (iOS only).
+   */
+  readonly source?: ImageSource | undefined;
+  /**
+   * Which referrer to use when fetching the image resource.
+   *
+   * @default `'strict-origin-when-cross-origin'`
+   */
+  readonly referrerPolicy?: ("no-referrer" | "no-referrer-when-downgrade" | "origin" | "origin-when-cross-origin" | "same-origin" | "strict-origin" | "strict-origin-when-cross-origin" | "unsafe-url") | undefined;
+  /**
+   * Determines how to resize the image when the frame doesn't match the raw
+   * image dimensions.
+   *
+   * - `cover`: Scale the image uniformly (maintain the image's aspect ratio)
+   *   so that both dimensions (width and height) of the image are equal to
+   *   or larger than the corresponding dimension of the view (minus padding).
+   *
+   * - `contain`: Scale the image uniformly (maintain the image's aspect
+   *   ratio) so that both dimensions (width and height) of the image are
+   *   equal to or less than the corresponding dimension of the view (minus
+   *   padding).
+   *
+   * - `stretch`: Scale width and height independently. This may change the
+   *   aspect ratio of the source.
+   *
+   * - `repeat`: Repeat the image to cover the frame of the view. The image
+   *   keeps its size and aspect ratio (iOS only).
+   *
+   * - `center`: Scale the image down so that it is completely visible, if
+   *   bigger than the area of the view. The image is not scaled up.
+   *
+   * - `none`: Do not resize the image. The image is displayed at its
+   *   intrinsic size.
+   *
+   * @default `'cover'`
+   */
+  readonly resizeMode?: ImageResizeMode | undefined;
+  readonly testID?: string | undefined;
+  /**
+   * Changes the color of all non-transparent pixels to the `tintColor`.
+   */
+  readonly tintColor?: ColorValue | undefined;
+  /**
+   * A remote URL string for the image resource. Takes precedence over
+   * `source`.
+   */
+  readonly src?: string | undefined;
+  /**
+   * Comma-separated list of candidate image sources with pixel density
+   * descriptors.
+   */
+  readonly srcSet?: string | undefined;
+  readonly children?: never | undefined;
+}
+export type ImageProps = Readonly<Omit<ImagePropsIOS, keyof ImagePropsAndroid | keyof ImagePropsBase | keyof {
+  /**
+   * Style applied to the `Image` component.
+   */
+  style?: ImageStyleProp | undefined;
+}> & Omit<ImagePropsAndroid, keyof ImagePropsBase | keyof {
+  /**
+   * Style applied to the `Image` component.
+   */
+  style?: ImageStyleProp | undefined;
+}> & Omit<ImagePropsBase, keyof {
+  /**
+   * Style applied to the `Image` component.
+   */
+  style?: ImageStyleProp | undefined;
+}> & {
+  /**
+   * Style applied to the `Image` component.
+   */
+  style?: ImageStyleProp | undefined;
+}>;
+export interface ImageBackgroundProps extends Readonly<Omit<ImageProps, keyof {
+  children?: React.ReactNode | undefined;
+  /**
+   * Style applied to the outer `View` wrapper. Accepts `ViewStyle` props
+   * rather than `ImageStyle` props.
+   */
+  style?: ViewStyleProp | undefined;
+  /**
+   * Style applied to the inner `Image` component.
+   */
+  imageStyle?: ImageStyleProp | undefined;
+  /**
+   * A ref setter assigned the element node of the inner `Image` component
+   * when mounted.
+   */
+  imageRef?: React.Ref<React.ComponentRef<ImageType>> | undefined;
+}>> {
+  readonly children?: React.ReactNode | undefined;
+  /**
+   * Style applied to the outer `View` wrapper. Accepts `ViewStyle` props
+   * rather than `ImageStyle` props.
+   */
+  readonly style?: ViewStyleProp | undefined;
+  /**
+   * Style applied to the inner `Image` component.
+   */
+  readonly imageStyle?: ImageStyleProp | undefined;
+  /**
+   * A ref setter assigned the element node of the inner `Image` component
+   * when mounted.
+   */
+  readonly imageRef?: React.Ref<React.ComponentRef<ImageType>> | undefined;
+}

package/types_generated/Libraries/Image/ImageResizeMode.d.ts

@@ -0,0 +1,17 @@
+/**
+ * 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.
+ *
+ * @generated SignedSource<<d2a1976ea0d5cd19ca2eb0f425b0ad28>>
+ *
+ * This file was translated from Flow by scripts/js-api/build-types/index.js.
+ * Original file: packages/react-native/Libraries/Image/ImageResizeMode.js
+ */
+
+/**
+ * ImageResizeMode defines valid values for different image resizing modes set
+ * via the `resizeMode` style property on `<Image>`.
+ */
+export type ImageResizeMode = "center" | "contain" | "cover" | "repeat" | "stretch" | "none";

package/types_generated/Libraries/Image/ImageSource.d.ts

@@ -0,0 +1,94 @@
+/**
+ * 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.
+ *
+ * @generated SignedSource<<0dc503edc33fdb75bdf3f12b3e173f48>>
+ *
+ * This file was translated from Flow by scripts/js-api/build-types/index.js.
+ * Original file: packages/react-native/Libraries/Image/ImageSource.js
+ */
+
+/**
+ * This type is intentionally inexact in order to permit call sites that supply
+ * extra properties.
+ */
+export interface ImageURISource {
+  /**
+   * `uri` is a string representing the resource identifier for the image, which
+   * could be an http address, a local file path, or the name of a static image
+   * resource (which should be wrapped in the `require('./path/to/image.png')`
+   * function).
+   */
+  readonly uri?: string | undefined;
+  /**
+   * `bundle` is the iOS asset bundle which the image is included in. This
+   * will default to [NSBundle mainBundle] if not set.
+   * @platform ios
+   */
+  readonly bundle?: string | undefined;
+  /**
+   * `method` is the HTTP Method to use. Defaults to GET if not specified.
+   */
+  readonly method?: string | undefined;
+  /**
+   * `headers` is an object representing the HTTP headers to send along with the
+   * request for a remote image.
+   */
+  readonly headers?: {
+    [$$Key$$: string]: string;
+  } | undefined;
+  /**
+   * `body` is the HTTP body to send with the request. This must be a valid
+   * UTF-8 string, and will be sent exactly as specified, with no
+   * additional encoding (e.g. URL-escaping or base64) applied.
+   */
+  readonly body?: string | undefined;
+  /**
+   * `cache` determines how the requests handles potentially cached
+   * responses.
+   *
+   * - `default`: Use the native platforms default strategy. `useProtocolCachePolicy` on iOS.
+   *
+   * - `reload`: The data for the URL will be loaded from the originating source.
+   * No existing cache data should be used to satisfy a URL load request.
+   *
+   * - `force-cache`: The existing cached data will be used to satisfy the request,
+   * regardless of its age or expiration date. If there is no existing data in the cache
+   * corresponding the request, the data is loaded from the originating source.
+   *
+   * - `only-if-cached`: The existing cache data will be used to satisfy a request, regardless of
+   * its age or expiration date. If there is no existing data in the cache corresponding
+   * to a URL load request, no attempt is made to load the data from the originating source,
+   * and the load is considered to have failed.
+   */
+  readonly cache?: ("default" | "reload" | "force-cache" | "only-if-cached") | undefined;
+  /**
+   * `width` and `height` can be specified if known at build time, in which case
+   * these will be used to set the default `<Image/>` component dimensions.
+   */
+  readonly width?: number | undefined;
+  readonly height?: number | undefined;
+  /**
+   * `scale` is used to indicate the scale factor of the image. Defaults to 1.0 if
+   * unspecified, meaning that one image pixel equates to one display point / DIP.
+   */
+  readonly scale?: number | undefined;
+}
+export type ImageRequireSource = number;
+export type ImageSource = ImageRequireSource | ImageURISource | ReadonlyArray<ImageURISource>;
+type ImageSourceProperties = {
+  body?: string | undefined;
+  bundle?: string | undefined;
+  cache?: ("default" | "reload" | "force-cache" | "only-if-cached") | undefined;
+  headers?: {
+    [$$Key$$: string]: string;
+  } | undefined;
+  height?: number | undefined;
+  method?: string | undefined;
+  scale?: number | undefined;
+  uri?: string | undefined;
+  width?: number | undefined;
+};
+export declare function getImageSourceProperties(imageSource: ImageURISource): Readonly<ImageSourceProperties>;

package/types_generated/Libraries/Image/ImageTypes.flow.d.ts

@@ -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.
+ *
+ * @generated SignedSource<<f7bbf6cd29a66b7256b815ff38ab71b9>>
+ *
+ * This file was translated from Flow by scripts/js-api/build-types/index.js.
+ * Original file: packages/react-native/Libraries/Image/ImageTypes.flow.js
+ */
+
+import type { HostInstance } from "../..";
+import type { RootTag } from "../Types/RootTagTypes";
+import type { ResolvedAssetSource } from "./AssetSourceResolver";
+import type { ImageProps as ImagePropsType } from "./ImageProps";
+import type { ImageSource } from "./ImageSource";
+import * as React from "react";
+export type ImageInstance = HostInstance;
+export type ImageSize = {
+  width: number;
+  height: number;
+};
+export type ImageResolvedAssetSource = ResolvedAssetSource;
+type ImageComponentStaticsIOS = Readonly<{
+  getSize(uri: string): Promise<ImageSize>;
+  getSize(uri: string, success: (width: number, height: number) => void, failure?: (error: unknown) => void): void;
+  getSizeWithHeaders(uri: string, headers: {
+    [$$Key$$: string]: string;
+  }): Promise<ImageSize>;
+  getSizeWithHeaders(uri: string, headers: {
+    [$$Key$$: string]: string;
+  }, success: (width: number, height: number) => void, failure?: (error: unknown) => void): void;
+  prefetch(url: string): Promise<boolean>;
+  prefetchWithMetadata(url: string, queryRootName: string, rootTag?: RootTag | undefined): Promise<boolean>;
+  queryCache(urls: Array<string>): Promise<{
+    [url: string]: "memory" | "disk" | "disk/memory";
+  }>;
+  /**
+   * @see https://reactnative.dev/docs/image#resolveassetsource
+   */
+  resolveAssetSource(source: ImageSource): ImageResolvedAssetSource | undefined;
+}>;
+type ImageComponentStaticsAndroid = Readonly<Omit<ImageComponentStaticsIOS, keyof {
+  abortPrefetch(requestId: number): void;
+}> & {
+  abortPrefetch(requestId: number): void;
+}>;
+export type AbstractImageAndroid = (props: Omit<ImagePropsType, keyof {
+  ref?: React.Ref<HostInstance> | undefined;
+}> & {
+  ref?: React.Ref<HostInstance> | undefined;
+}) => React.ReactNode;
+export type ImageAndroid = AbstractImageAndroid & ImageComponentStaticsAndroid;
+export type AbstractImageIOS = (props: Omit<ImagePropsType, keyof {
+  ref?: React.Ref<HostInstance> | undefined;
+}> & {
+  ref?: React.Ref<HostInstance> | undefined;
+}) => React.ReactNode;
+export type ImageIOS = AbstractImageIOS & ImageComponentStaticsIOS;
+export type ImageType = ImageIOS | ImageAndroid;
+export type { ImageProps } from "./ImageProps";