@office-iss/react-native-win32 0.71.0 → 0.71.2

package/src/Libraries/Components/View/ViewPropTypes.win32.d.ts

@@ -0,0 +1,372 @@
+/**
+ * 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.
+ *
+ * @format
+ */
+
+import type * as React from 'react';
+import {Insets} from 'react-native/types/public/Insets';
+import {GestureResponderHandlers} from 'react-native/types/public/ReactNativeRenderer';
+import {StyleProp} from 'react-native/Libraries/StyleSheet/StyleSheet';
+import {ViewStyle} from 'react-native/Libraries/StyleSheet/StyleSheetTypes';
+import {
+  LayoutChangeEvent,
+  MouseEvent, // Win32
+  NativeSyntheticEvent, // Win32
+  PointerEvents,
+} from 'react-native/Libraries/Types/CoreEventTypes';
+import {Touchable} from 'react-native/Libraries/Components/Touchable/Touchable';
+import {AccessibilityProps} from './ViewAccessibility';
+
+export type TVParallaxProperties = {
+  /**
+   * If true, parallax effects are enabled.  Defaults to true.
+   */
+  enabled?: boolean | undefined;
+
+  /**
+   * Defaults to 2.0.
+   */
+  shiftDistanceX?: number | undefined;
+
+  /**
+   * Defaults to 2.0.
+   */
+  shiftDistanceY?: number | undefined;
+
+  /**
+   * Defaults to 0.05.
+   */
+  tiltAngle?: number | undefined;
+
+  /**
+   * Defaults to 1.0
+   */
+  magnification?: number | undefined;
+
+  /**
+   * Defaults to 1.0
+   */
+  pressMagnification?: number | undefined;
+
+  /**
+   * Defaults to 0.3
+   */
+  pressDuration?: number | undefined;
+
+  /**
+   * Defaults to 0.3
+   */
+  pressDelay?: number | undefined;
+};
+
+export interface TVViewPropsIOS {
+  /**
+   * *(Apple TV only)* When set to true, this view will be focusable
+   * and navigable using the Apple TV remote.
+   *
+   * @platform ios
+   */
+  isTVSelectable?: boolean | undefined;
+
+  /**
+   * *(Apple TV only)* May be set to true to force the Apple TV focus engine to move focus to this view.
+   *
+   * @platform ios
+   */
+  hasTVPreferredFocus?: boolean | undefined;
+
+  /**
+   * *(Apple TV only)* Object with properties to control Apple TV parallax effects.
+   *
+   * @platform ios
+   */
+  tvParallaxProperties?: TVParallaxProperties | undefined;
+
+  /**
+   * *(Apple TV only)* May be used to change the appearance of the Apple TV parallax effect when this view goes in or out of focus.  Defaults to 2.0.
+   *
+   * @platform ios
+   */
+  tvParallaxShiftDistanceX?: number | undefined;
+
+  /**
+   * *(Apple TV only)* May be used to change the appearance of the Apple TV parallax effect when this view goes in or out of focus.  Defaults to 2.0.
+   *
+   * @platform ios
+   */
+  tvParallaxShiftDistanceY?: number | undefined;
+
+  /**
+   * *(Apple TV only)* May be used to change the appearance of the Apple TV parallax effect when this view goes in or out of focus.  Defaults to 0.05.
+   *
+   * @platform ios
+   */
+  tvParallaxTiltAngle?: number | undefined;
+
+  /**
+   * *(Apple TV only)* May be used to change the appearance of the Apple TV parallax effect when this view goes in or out of focus.  Defaults to 1.0.
+   *
+   * @platform ios
+   */
+  tvParallaxMagnification?: number | undefined;
+}
+
+export interface ViewPropsIOS extends TVViewPropsIOS {
+  /**
+   * Whether this view should be rendered as a bitmap before compositing.
+   *
+   * On iOS, this is useful for animations and interactions that do not modify this component's dimensions nor its children;
+   * for example, when translating the position of a static view, rasterization allows the renderer to reuse a cached bitmap of a static view
+   * and quickly composite it during each frame.
+   *
+   * Rasterization incurs an off-screen drawing pass and the bitmap consumes memory.
+   * Test and measure when using this property.
+   */
+  shouldRasterizeIOS?: boolean | undefined;
+}
+
+export interface ViewPropsAndroid {
+  /**
+   * Views that are only used to layout their children or otherwise don't draw anything
+   * may be automatically removed from the native hierarchy as an optimization.
+   * Set this property to false to disable this optimization and ensure that this View exists in the native view hierarchy.
+   */
+  collapsable?: boolean | undefined;
+
+  /**
+   * Whether this view needs to rendered offscreen and composited with an alpha in order to preserve 100% correct colors and blending behavior.
+   * The default (false) falls back to drawing the component and its children
+   * with an alpha applied to the paint used to draw each element instead of rendering the full component offscreen and compositing it back with an alpha value.
+   * This default may be noticeable and undesired in the case where the View you are setting an opacity on
+   * has multiple overlapping elements (e.g. multiple overlapping Views, or text and a background).
+   *
+   * Rendering offscreen to preserve correct alpha behavior is extremely expensive
+   * and hard to debug for non-native developers, which is why it is not turned on by default.
+   * If you do need to enable this property for an animation,
+   * consider combining it with renderToHardwareTextureAndroid if the view contents are static (i.e. it doesn't need to be redrawn each frame).
+   * If that property is enabled, this View will be rendered off-screen once,
+   * saved in a hardware texture, and then composited onto the screen with an alpha each frame without having to switch rendering targets on the GPU.
+   */
+  needsOffscreenAlphaCompositing?: boolean | undefined;
+
+  /**
+   * Whether this view should render itself (and all of its children) into a single hardware texture on the GPU.
+   *
+   * On Android, this is useful for animations and interactions that only modify opacity, rotation, translation, and/or scale:
+   * in those cases, the view doesn't have to be redrawn and display lists don't need to be re-executed. The texture can just be
+   * re-used and re-composited with different parameters. The downside is that this can use up limited video memory, so this prop should be set back to false at the end of the interaction/animation.
+   */
+  renderToHardwareTextureAndroid?: boolean | undefined;
+
+  /**
+   * Whether this `View` should be focusable with a non-touch input device, eg. receive focus with a hardware keyboard.
+   */
+  focusable?: boolean | undefined;
+}
+
+// [Win32
+
+export type Cursor =
+  | 'auto'
+  | 'default'
+  | 'pointer'
+  | 'help'
+  | 'not-allowed'
+  | 'wait'
+  | 'move'
+  | 'nesw-resize'
+  | 'ns-resize'
+  | 'nwse-resize'
+  | 'we-resize'
+  | 'text';
+
+export interface INativeKeyboardEvent {
+  altKey: boolean;
+  ctrlKey: boolean;
+  metaKey: boolean;
+  shiftKey: boolean;
+  key: string;
+}
+export type IKeyboardEvent = NativeSyntheticEvent<INativeKeyboardEvent>;
+
+// All of T becomes optional except for Keys
+type PartiallyRequired<T, Keys extends keyof T = keyof T> = Pick<
+  Partial<T>,
+  Exclude<keyof T, Keys>
+> &
+  Pick<T, Keys>;
+
+export type IHandledKeyboardEvent = PartiallyRequired<
+  INativeKeyboardEvent,
+  'key'
+>;
+// Win32]
+
+export interface ViewPropsWin32 {
+  onKeyDown?: (args: IKeyboardEvent) => void;
+  onKeyDownCapture?: (args: IKeyboardEvent) => void;
+  onKeyUp?: (args: IKeyboardEvent) => void;
+  onKeyUpCapture?: (args: IKeyboardEvent) => void;
+
+  keyDownEvents?: IHandledKeyboardEvent[];
+  keyUpEvents?: IHandledKeyboardEvent[];
+
+  onMouseLeave?: ?((event: MouseEvent) => void);
+  onMouseEnter?: ?((event: MouseEvent) => void);
+
+  /**
+   * Specifies the Tooltip for the view
+   * @platform windows
+   */
+  tooltip?: ?string;
+
+  /**
+   * Tab Index
+   * @platform windows
+   */
+  tabIndex?: ?number;
+
+  /**
+   * Specifies if the control should show System focus visuals
+   */
+  enableFocusRing?: ?boolean;
+
+  /**
+   * The onBlur event occurs when an element loses focus.  The opposite of onBlur is onFocus.  Note that in React
+   * Native, unlike in the web, the onBlur event bubbles (similar to onFocusOut in the web).
+   *
+   * `ev.target === ev.currentTarget` when the focus is being lost from this component.
+   * `ev.target !== ev.currentTarget` when the focus is being lost from a descendant.
+   */
+  onBlur?: (ev: NativeSyntheticEvent<{}>) => void;
+  /**
+   * The onBlur event occurs when an element loses focus.  The opposite of onBlur is onFocus.  Note that in React
+   * Native, unlike in the web, the onBlur event bubbles (similar to onFocusOut in the web).
+   *
+   * `ev.target === ev.currentTarget` when the focus is being lost from this component.
+   * `ev.target !== ev.currentTarget` when the focus is being lost from a descendant.
+   */
+  onBlurCapture?: (ev: NativeSyntheticEvent<{}>) => void;
+  /**
+   * The onFocus event occurs when an element gets focus. The opposite of onFocus is onBlur.  Note that in React
+   * Native, unlike in the web, the onFocus event bubbles (similar to onFocusIn in the web).
+   *
+   * `ev.target === ev.currentTarget` when the focus is being lost from this component.
+   * `ev.target !== ev.currentTarget` when the focus is being lost from a descendant.
+   */
+  onFocus?: (ev: NativeSyntheticEvent<{}>) => void;
+  /**
+   * The onFocus event occurs when an element gets focus. The opposite of onFocus is onBlur.  Note that in React
+   * Native, unlike in the web, the onFocus event bubbles (similar to onFocusIn in the web).
+   *
+   * `ev.target === ev.currentTarget` when the focus is being lost from this component.
+   * `ev.target !== ev.currentTarget` when the focus is being lost from a descendant.
+   */
+  onFocusCapture?: (ev: NativeSyntheticEvent<{}>) => void;
+
+  cursor?: Cursor;
+
+  /**
+   * Whether this `View` should be focusable with a non-touch input device, eg. receive focus with a hardware keyboard.
+   */
+  focusable?: boolean | undefined;
+
+  /**
+   * Specified an AirSpace animation class to apply to this view
+   */
+  animationClass?: string;
+}
+
+/**
+ * @see https://reactnative.dev/docs/view#props
+ */
+export interface ViewProps
+  extends ViewPropsAndroid,
+    ViewPropsIOS,
+    ViewPropsWin32,
+    GestureResponderHandlers,
+    Touchable,
+    PointerEvents,
+    AccessibilityProps {
+  children?: React.ReactNode;
+  /**
+   * This defines how far a touch event can start away from the view.
+   * Typical interface guidelines recommend touch targets that are at least
+   * 30 - 40 points/density-independent pixels. If a Touchable view has
+   * a height of 20 the touchable height can be extended to 40 with
+   * hitSlop={{top: 10, bottom: 10, left: 0, right: 0}}
+   * NOTE The touch area never extends past the parent view bounds and
+   * the Z-index of sibling views always takes precedence if a touch
+   * hits two overlapping views.
+   */
+  hitSlop?: Insets | undefined;
+
+  /**
+   * Used to reference react managed views from native code.
+   */
+  id?: string | undefined;
+
+  /**
+   * Invoked on mount and layout changes with
+   *
+   * {nativeEvent: { layout: {x, y, width, height}}}.
+   */
+  onLayout?: ((event: LayoutChangeEvent) => void) | undefined;
+
+  /**
+   *
+   * In the absence of auto property, none is much like CSS's none value. box-none is as if you had applied the CSS class:
+   *
+   * .box-none {
+   *   pointer-events: none;
+   * }
+   * .box-none * {
+   *   pointer-events: all;
+   * }
+   *
+   * box-only is the equivalent of
+   *
+   * .box-only {
+   *   pointer-events: all;
+   * }
+   * .box-only * {
+   *   pointer-events: none;
+   * }
+   *
+   * But since pointerEvents does not affect layout/appearance, and we are already deviating from the spec by adding additional modes,
+   * we opt to not include pointerEvents on style. On some platforms, we would need to implement it as a className anyways. Using style or not is an implementation detail of the platform.
+   */
+  pointerEvents?: 'box-none' | 'none' | 'box-only' | 'auto' | undefined;
+
+  /**
+   *
+   * This is a special performance property exposed by RCTView and is useful for scrolling content when there are many subviews,
+   * most of which are offscreen. For this property to be effective, it must be applied to a view that contains many subviews that extend outside its bound.
+   * The subviews must also have overflow: hidden, as should the containing view (or one of its superviews).
+   */
+  removeClippedSubviews?: boolean | undefined;
+
+  style?: StyleProp<ViewStyle> | undefined;
+
+  /**
+   * Used to locate this view in end-to-end tests.
+   */
+  testID?: string | undefined;
+
+  /**
+   * Used to reference react managed views from native code.
+   */
+  nativeID?: string | undefined;
+}
+
+// For backwards compat.... // Win32
+export interface IViewWin32 {
+  focus: () => void;
+}
+
+// For backwards compat.... // Win32
+export type IViewWin32Props = ViewProps;

package/src/Libraries/Components/View/ViewWin32.d.ts

@@ -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.
+ *
+ * @format
+ */
+
+import type * as React from 'react';
+import {Constructor} from 'react-native/types/private/Utilities';
+import {ViewProps} from './ViewPropTypes';
+import {NativeMethods} from 'react-native/types/public/ReactNativeTypes';
+
+/**
+ * The most fundamental component for building UI, View is a container that supports layout with flexbox, style, some touch handling,
+ * and accessibility controls, and is designed to be nested inside other views and to have 0 to many children of any type.
+ * View maps directly to the native view equivalent on whatever platform React is running on,
+ * whether that is a UIView, <div>, android.view, etc.
+ */
+declare class ViewWin32Component extends React.Component<ViewProps> {}
+declare const ViewWin32Base: Constructor<NativeMethods> &
+  typeof ViewWin32Component;
+export class ViewWin32 extends ViewWin32Base {
+  /**
+   * Is 3D Touch / Force Touch available (i.e. will touch events include `force`)
+   * @platform ios
+   */
+  static forceTouchAvailable: boolean;
+}

package/src/Libraries/platform-types.d.ts

@@ -5,19 +5,13 @@
 *        need to also be added to index.win32.js
 */
 
-export type { 
-      AccessibilityActionInfo,
-      AccessibilityActionName,
-      AccessibilityState
-} from './Components/View/ViewWin32.Props';
-export * from './Components/View/ViewWin32.Props';
-export * from './Components/View/ViewWin32';
-export * from './Components/Text/TextWin32.Props';
-export * from './Components/Text/TextWin32';
-export * from './Components/Button/ButtonWin32.Props';
-export * from './Components/Button/ButtonWin32';
-export * from './StyleSheet/PlatformColorValueTypesWin32';
-export * from './Components/Touchable/TouchableWin32.Props';
+export {ViewWin32} from './Components/View/ViewWin32';
+export {TextWin32TextStyle, ITextWin32Props } from './Components/Text/TextWin32.Props';
+export {TextWin32} from './Components/Text/TextWin32';
+export {IButtonWin32Props, IButtonWin32Style} from './Components/Button/ButtonWin32.Props';
+export {ButtonWin32} from './Components/Button/ButtonWin32';
+export {GradientColorStop, GradientColorValueWin32, ColorGradientWin32} from './StyleSheet/PlatformColorValueTypesWin32';
+export {ITouchableWin32Props} from './Components/Touchable/TouchableWin32.Props';
 export * from './Components/Touchable/TouchableWin32.Types';
 export * from './Components/Touchable/TouchableWin32';
 export * from './PersonaCoin/PersonaCoin';

package/types/modules/BatchedBridge.d.ts

@@ -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.
+ *
+ * @format
+ */
+
+interface SpyData {
+  type: number;
+  module?: string | undefined;
+  method: string | number;
+  args: any[];
+}
+
+declare class MessageQueue {
+  static spy(spyOrToggle: boolean | ((data: SpyData) => void)): void;
+
+  getCallableModule(name: string): Object;
+  registerCallableModule(name: string, module: Object): void;
+  registerLazyCallableModule(name: string, factory: () => Object): void;
+}
+
+declare module 'react-native/Libraries/BatchedBridge/BatchedBridge' {
+  const BatchedBridge: MessageQueue;
+  export default BatchedBridge;
+}
+
+declare module 'react-native/Libraries/BatchedBridge/MessageQueue' {
+  export default MessageQueue;
+}

package/types/modules/Codegen.d.ts

@@ -0,0 +1,74 @@
+/**
+ * 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.
+ *
+ * @format
+ */
+
+declare module 'react-native/Libraries/Utilities/codegenNativeCommands' {
+  export interface Options<T extends string> {
+    readonly supportedCommands: ReadonlyArray<T>;
+  }
+
+  function codegenNativeCommands<T extends object>(
+    options: Options<keyof T extends string ? keyof T : never>,
+  ): T;
+
+  export default codegenNativeCommands;
+}
+
+declare module 'react-native/Libraries/Utilities/codegenNativeComponent' {
+  import type {HostComponent} from 'react-native';
+
+  export interface Options {
+    readonly interfaceOnly?: boolean;
+    readonly paperComponentName?: string;
+    readonly paperComponentNameDeprecated?: string;
+    readonly excludedPlatforms?: ReadonlyArray<'iOS' | 'android'>;
+  }
+
+  export type NativeComponentType<T> = HostComponent<T>;
+
+  function codegenNativeComponent<Props extends object>(
+    componentName: string,
+    options?: Options,
+  ): NativeComponentType<Props>;
+
+  export default codegenNativeComponent;
+}
+
+declare module 'react-native/Libraries/Types/CodegenTypes' {
+  import type {NativeSyntheticEvent} from 'react-native';
+
+  // Event types
+  // We're not using the PaperName, it is only used to codegen view config settings
+
+  export type BubblingEventHandler<
+    T,
+    PaperName extends string | never = never,
+  > = (event: NativeSyntheticEvent<T>) => void | Promise<void>;
+  export type DirectEventHandler<
+    T,
+    PaperName extends string | never = never,
+  > = (event: NativeSyntheticEvent<T>) => void | Promise<void>;
+
+  // Prop types
+  export type Double = number;
+  export type Float = number;
+  export type Int32 = number;
+  export type UnsafeObject = object;
+
+  type DefaultTypes = number | boolean | string | ReadonlyArray<string>;
+  // Default handling, ignore the unused value
+  // we're only using it for type checking
+  //
+  // TODO: (rickhanlonii) T44881457 If a default is provided, it should always be optional
+  //  but that is currently not supported in the codegen since we require a default
+
+  export type WithDefault<
+    Type extends DefaultTypes,
+    Value extends Type | string | undefined | null,
+  > = Type | undefined | null;
+}

package/types/modules/Devtools.d.ts

@@ -0,0 +1,31 @@
+/**
+ * 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.
+ *
+ * @format
+ */
+
+declare module 'react-native/Libraries/Core/Devtools/parseErrorStack' {
+  export type StackFrame = {
+    file: string;
+    methodName: string;
+    lineNumber: number;
+    column: number | null;
+  };
+
+  export interface ExtendedError extends Error {
+    framesToPop?: number | undefined;
+  }
+
+  export default function parseErrorStack(error: ExtendedError): StackFrame[];
+}
+
+declare module 'react-native/Libraries/Core/Devtools/symbolicateStackTrace' {
+  import {StackFrame} from 'react-native/Libraries/Core/Devtools/parseErrorStack';
+
+  export default function symbolicateStackTrace(
+    stack: ReadonlyArray<StackFrame>,
+  ): Promise<StackFrame[]>;
+}

package/types/modules/LaunchScreen.d.ts

@@ -0,0 +1,18 @@
+/**
+ * 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.
+ *
+ * @format
+ */
+
+// Adds the JSX elements used in the launch screen.
+
+declare module 'react-native/Libraries/NewAppScreen' {
+  export const Header: any;
+  export const LearnMoreLinks: any;
+  export const Colors: any;
+  export const DebugInstructions: any;
+  export const ReloadInstructions: any;
+}