From 9010e691e098b310d56e019e543377bc4350baf2 Mon Sep 17 00:00:00 2001 From: Jakub Piasecki Date: Tue, 6 May 2025 06:21:15 -0700 Subject: [PATCH] Update transform types to preserve behavior in TypeScript (#51115) Summary: Pull Request resolved: https://github.com/facebook/react-native/pull/51115 Changelog: [Internal] Reviewed By: huntie Differential Revision: D74229819 fbshipit-source-id: 08e363ae58c29ca910601b2f078153b8ff30103c --- .../StyleSheet/private/_TransformStyle.js | 70 +++++++++++++------ .../__snapshots__/public-api-test.js.snap | 65 +++++++++++------ 2 files changed, 93 insertions(+), 42 deletions(-) diff --git a/packages/react-native/Libraries/StyleSheet/private/_TransformStyle.js b/packages/react-native/Libraries/StyleSheet/private/_TransformStyle.js index 74aecb7decd..ab847c68f6f 100644 --- a/packages/react-native/Libraries/StyleSheet/private/_TransformStyle.js +++ b/packages/react-native/Libraries/StyleSheet/private/_TransformStyle.js @@ -10,6 +10,25 @@ import type AnimatedNode from '../../Animated/nodes/AnimatedNode'; +// Helper types to enforce that a single key is used in a transform object +// after generating a TypeScript definition file from the Flow types. +// $FlowExpectedError[unclear-type] +type KeysOfUnion = T extends any ? $Keys : empty; +// $FlowExpectedError[unclear-type] +type ValueOfUnion = T extends any + ? K extends $Keys + ? T[K] + : empty + : empty; +type MergeUnion = { + [K in KeysOfUnion]?: ValueOfUnion, +}; +type MaximumOneOf = $Values<{ + [K in keyof T]: $Exact<{ + [P in keyof T]?: P extends K ? T[P] : empty, + }>, +}>; + export type ____TransformStyle_Internal = $ReadOnly<{ /** * `transform` accepts an array of transformation objects. Each object specifies @@ -29,27 +48,36 @@ export type ____TransformStyle_Internal = $ReadOnly<{ */ transform?: | $ReadOnlyArray< - | {+perspective: number | AnimatedNode} - | {+rotate: string | AnimatedNode} - | {+rotateX: string | AnimatedNode} - | {+rotateY: string | AnimatedNode} - | {+rotateZ: string | AnimatedNode} - | {+scale: number | AnimatedNode} - | {+scaleX: number | AnimatedNode} - | {+scaleY: number | AnimatedNode} - | {+translateX: number | string | AnimatedNode} - | {+translateY: number | string | AnimatedNode} - | { - +translate: - | [number | string | AnimatedNode, number | string | AnimatedNode] - | AnimatedNode, - } - | {+skewX: string | AnimatedNode} - | {+skewY: string | AnimatedNode} - // TODO: what is the actual type it expects? - | { - +matrix: $ReadOnlyArray | AnimatedNode, - }, + $ReadOnly< + MaximumOneOf< + MergeUnion< + | {+perspective: number | AnimatedNode} + | {+rotate: string | AnimatedNode} + | {+rotateX: string | AnimatedNode} + | {+rotateY: string | AnimatedNode} + | {+rotateZ: string | AnimatedNode} + | {+scale: number | AnimatedNode} + | {+scaleX: number | AnimatedNode} + | {+scaleY: number | AnimatedNode} + | {+translateX: number | string | AnimatedNode} + | {+translateY: number | string | AnimatedNode} + | { + +translate: + | [ + number | string | AnimatedNode, + number | string | AnimatedNode, + ] + | AnimatedNode, + } + | {+skewX: string | AnimatedNode} + | {+skewY: string | AnimatedNode} + // TODO: what is the actual type it expects? + | { + +matrix: $ReadOnlyArray | AnimatedNode, + }, + >, + >, + >, > | string, /** diff --git a/packages/react-native/Libraries/__tests__/__snapshots__/public-api-test.js.snap b/packages/react-native/Libraries/__tests__/__snapshots__/public-api-test.js.snap index a9b5b7375d9..096c639c7b1 100644 --- a/packages/react-native/Libraries/__tests__/__snapshots__/public-api-test.js.snap +++ b/packages/react-native/Libraries/__tests__/__snapshots__/public-api-test.js.snap @@ -7580,29 +7580,52 @@ export type ____ViewStyle_InternalOverrides = $ReadOnly<{}>; `; exports[`public API should not change unintentionally Libraries/StyleSheet/private/_TransformStyle.js 1`] = ` -"export type ____TransformStyle_Internal = $ReadOnly<{ +"type KeysOfUnion = T extends any ? $Keys : empty; +type ValueOfUnion = T extends any + ? K extends $Keys + ? T[K] + : empty + : empty; +type MergeUnion = { + [K in KeysOfUnion]?: ValueOfUnion, +}; +type MaximumOneOf = $Values<{ + [K in keyof T]: $Exact<{ + [P in keyof T]?: P extends K ? T[P] : empty, + }>, +}>; +export type ____TransformStyle_Internal = $ReadOnly<{ transform?: | $ReadOnlyArray< - | { +perspective: number | AnimatedNode } - | { +rotate: string | AnimatedNode } - | { +rotateX: string | AnimatedNode } - | { +rotateY: string | AnimatedNode } - | { +rotateZ: string | AnimatedNode } - | { +scale: number | AnimatedNode } - | { +scaleX: number | AnimatedNode } - | { +scaleY: number | AnimatedNode } - | { +translateX: number | string | AnimatedNode } - | { +translateY: number | string | AnimatedNode } - | { - +translate: - | [number | string | AnimatedNode, number | string | AnimatedNode] - | AnimatedNode, - } - | { +skewX: string | AnimatedNode } - | { +skewY: string | AnimatedNode } - | { - +matrix: $ReadOnlyArray | AnimatedNode, - }, + $ReadOnly< + MaximumOneOf< + MergeUnion< + | { +perspective: number | AnimatedNode } + | { +rotate: string | AnimatedNode } + | { +rotateX: string | AnimatedNode } + | { +rotateY: string | AnimatedNode } + | { +rotateZ: string | AnimatedNode } + | { +scale: number | AnimatedNode } + | { +scaleX: number | AnimatedNode } + | { +scaleY: number | AnimatedNode } + | { +translateX: number | string | AnimatedNode } + | { +translateY: number | string | AnimatedNode } + | { + +translate: + | [ + number | string | AnimatedNode, + number | string | AnimatedNode, + ] + | AnimatedNode, + } + | { +skewX: string | AnimatedNode } + | { +skewY: string | AnimatedNode } + | { + +matrix: $ReadOnlyArray | AnimatedNode, + }, + >, + >, + >, > | string, transformOrigin?: