Fixing schema types for component command params of Arrays#48476

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
elicwhite wants to merge 5 commits into from
Closed

Fixing schema types for component command params of Arrays #48476

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
abc7c4c
Make CompleteType contain module and component reserved names
elicwhite Jan 6, 2025
3eebf4d
Simplify CompleteTypeAnnotation
elicwhite Jan 6, 2025
2061343
Separate component array types and command array types
elicwhite Jan 6, 2025
a4f3bed
Add command type to CompleteTypeAnnotation
elicwhite Jan 6, 2025
e36140c
Fixing schema types for component command params of Arrays (#48476)
elicwhite Jan 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 14 additions & 1 deletion packages/react-native-codegen/src/CodegenSchema.d.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -142,6 +142,19 @@ export type ComponentArrayTypeAnnotation = ArrayTypeAnnotation<
| ArrayTypeAnnotation<ObjectTypeAnnotation<PropTypeAnnotation>>
>;

export type ComponentCommandArrayTypeAnnotation = ArrayTypeAnnotation<
| BooleanTypeAnnotation
| StringTypeAnnotation
| DoubleTypeAnnotation
| FloatTypeAnnotation
| Int32TypeAnnotation
// Mixed is not great. This generally means its a type alias to another type
// like an object or union. Ideally we'd encode that type in the schema so the compat-check can
// validate those deeper objects for breaking changes and the generators can do something smarter.
// As of now, the generators just create ReadableMap or (const NSArray *) which are untyped
| MixedTypeAnnotation
>;

export interface ArrayTypeAnnotation<T> {
readonly type: 'ArrayTypeAnnotation';
readonly elementType: T;
Expand DownExpand Up@@ -206,7 +219,7 @@ export type CommandParamTypeAnnotation =
| DoubleTypeAnnotation
| FloatTypeAnnotation
| StringTypeAnnotation
| ComponentArrayTypeAnnotation;
| ComponentCommandArrayTypeAnnotation;

export interface ReservedTypeAnnotation {
readonly type: 'ReservedTypeAnnotation';
Expand Down
32 changes: 27 additions & 5 deletions packages/react-native-codegen/src/CodegenSchema.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -158,6 +158,19 @@ export type ComponentArrayTypeAnnotation = ArrayTypeAnnotation<
| ArrayTypeAnnotation<ObjectTypeAnnotation<PropTypeAnnotation>>,
>;

export type ComponentCommandArrayTypeAnnotation = ArrayTypeAnnotation<
| BooleanTypeAnnotation
| StringTypeAnnotation
| DoubleTypeAnnotation
| FloatTypeAnnotation
| Int32TypeAnnotation
// Mixed is not great. This generally means its a type alias to another type
// like an object or union. Ideally we'd encode that type in the schema so the compat-check can
// validate those deeper objects for breaking changes and the generators can do something smarter.
// As of now, the generators just create ReadableMap or (const NSArray *) which are untyped
| MixedTypeAnnotation,
>;

export type ArrayTypeAnnotation<+T> = $ReadOnly<{
type: 'ArrayTypeAnnotation',
elementType: T,
Expand DownExpand Up@@ -222,7 +235,7 @@ export type CommandParamTypeAnnotation =
| DoubleTypeAnnotation
| FloatTypeAnnotation
| StringTypeAnnotation
| ComponentArrayTypeAnnotation;
| ComponentCommandArrayTypeAnnotation;

export type ReservedTypeAnnotation = $ReadOnly<{
type: 'ReservedTypeAnnotation',
Expand DownExpand Up@@ -412,6 +425,14 @@ type NativeModuleReturnOnlyTypeAnnotation =
| NativeModulePromiseTypeAnnotation
| VoidTypeAnnotation;

// Add the allowed component reserved types to the native module union
export type CompleteReservedTypeAnnotation =
| ReservedTypeAnnotation
| {
type: 'ReservedTypeAnnotation',
name: ReservedPropTypeAnnotation['name'],
};

// Used by compatibility check which needs to handle all possible types
// This will eventually also include the union of all view manager types
export type CompleteTypeAnnotation =
Expand All@@ -421,7 +442,8 @@ export type CompleteTypeAnnotation =
| EventEmitterTypeAnnotation
| NativeModuleEnumDeclarationWithMembers
| UnsafeAnyTypeAnnotation
// Native Module event emitters and methods
| ObjectTypeAnnotation<
Nullable<NativeModuleFunctionTypeAnnotation> | EventEmitterTypeAnnotation,
>;
| ArrayTypeAnnotation<CompleteTypeAnnotation>
| ObjectTypeAnnotation<CompleteTypeAnnotation>
// Components
| CommandTypeAnnotation
| CompleteReservedTypeAnnotation;
10 changes: 10 additions & 0 deletions packages/react-native-codegen/src/generators/components/__test_fixtures__/fixtures.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -1693,6 +1693,16 @@ const COMMANDS: SchemaType = {
type: 'BooleanTypeAnnotation',
},
},
{
name: 'locations',
optional: false,
typeAnnotation: {
type: 'ArrayTypeAnnotation',
elementType: {
type: 'MixedTypeAnnotation',
},
},
},
],
returnTypeAnnotation: {
type: 'VoidTypeAnnotation',
Expand Down
16 changes: 12 additions & 4 deletions ...n/src/generators/components/__tests__/__snapshots__/GenerateComponentHObjCpp-test.js.snap
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -119,7 +119,7 @@ NS_ASSUME_NONNULL_BEGIN

@protocol RCTCommandNativeComponentViewProtocol <NSObject>
- (void)flashScrollIndicators;
- (void)allTypes:(NSInteger)x y:(float)y z:(double)z message:(NSString *)message animated:(BOOL)animated;
- (void)allTypes:(NSInteger)x y:(float)y z:(double)z message:(NSString *)message animated:(BOOL)animated locations:(const NSArray *)locations;
@end

RCT_EXTERN inline void RCTCommandNativeComponentHandleCommand(
Expand All@@ -143,8 +143,8 @@ RCT_EXTERN inline void RCTCommandNativeComponentHandleCommand(

if ([commandName isEqualToString:@\\"allTypes\\"]) {
#if RCT_DEBUG
if ([args count] != 5) {
RCTLogError(@\\"%@ command %@ received %d arguments, expected %d.\\", @\\"CommandNativeComponent\\", commandName, (int)[args count], 5);
if ([args count] != 6) {
RCTLogError(@\\"%@ command %@ received %d arguments, expected %d.\\", @\\"CommandNativeComponent\\", commandName, (int)[args count], 6);
return;
}
#endif
Expand DownExpand Up@@ -189,7 +189,15 @@ NSObject *arg4 = args[4];
#endif
BOOL animated = [(NSNumber *)arg4 boolValue];

[componentView allTypes:x y:y z:z message:message animated:animated];
NSObject *arg5 = args[5];
#if RCT_DEBUG
if (!RCTValidateTypeOfViewCommandArgument(arg5, [NSArray class], @\\"array\\", @\\"CommandNativeComponent\\", commandName, @\\"6th\\")) {
return;
}
#endif
const NSArray * locations = (NSArray *)arg5;

[componentView allTypes:x y:y z:z message:message animated:animated locations:locations];
return;
}

Expand Down
2 changes: 1 addition & 1 deletion .../src/generators/components/__tests__/__snapshots__/GeneratePropsJavaDelegate-test.js.snap
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -224,7 +224,7 @@ public class CommandNativeComponentManagerDelegate<T extends View, U extends Bas
mViewManager.flashScrollIndicators(view);
break;
case \\"allTypes\\":
mViewManager.allTypes(view, args.getInt(0), (float) args.getDouble(1), args.getDouble(2), args.getString(3), args.getBoolean(4));
mViewManager.allTypes(view, args.getInt(0), (float) args.getDouble(1), args.getDouble(2), args.getString(3), args.getBoolean(4), args.getArray(5));
break;
}
}
Expand Down
3 changes: 2 additions & 1 deletion ...src/generators/components/__tests__/__snapshots__/GeneratePropsJavaInterface-test.js.snap
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -118,11 +118,12 @@ Map {
package com.facebook.react.viewmanagers;

import android.view.View;
import com.facebook.react.bridge.ReadableArray;

public interface CommandNativeComponentManagerInterface<T extends View> {
// No props
void flashScrollIndicators(T view);
void allTypes(T view, int x, float y, double z, String message, boolean animated);
void allTypes(T view, int x, float y, double z, String message, boolean animated, ReadableArray locations);
}
",
}
Expand Down
4 changes: 2 additions & 2 deletions ...degen/src/generators/components/__tests__/__snapshots__/GenerateViewConfigJs-test.js.snap
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -187,8 +187,8 @@ export const Commands = {
dispatchCommand(ref, \\"flashScrollIndicators\\", []);
},

allTypes(ref, x, y, z, message, animated) {
dispatchCommand(ref, \\"allTypes\\", [x, y, z, message, animated]);
allTypes(ref, x, y, z, message, animated, locations) {
dispatchCommand(ref, \\"allTypes\\", [x, y, z, message, animated, locations]);
}
};
",
Expand Down
15 changes: 14 additions & 1 deletion packages/react-native-codegen/src/parsers/flow/components/__test_fixtures__/fixtures.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -951,10 +951,18 @@ interface NativeCommands {
z: Double,
animated: boolean,
): void;
+arrayArgs: (
viewRef: React.ElementRef<NativeType>,
booleanArray: $ReadOnlyArray<boolean>,
stringArray: $ReadOnlyArray<string>,
floatArray: $ReadOnlyArray<Float>,
intArray: $ReadOnlyArray<Int32>,
doubleArray: $ReadOnlyArray<Double>,
) => void;
}

export const Commands = codegenNativeCommands<NativeCommands>({
supportedCommands: ['handleRootTag', 'hotspotUpdate', 'scrollTo'],
supportedCommands: ['handleRootTag', 'hotspotUpdate', 'scrollTo', 'arrayArgs'],
});

export default (codegenNativeComponent<ModuleProps>(
Expand DownExpand Up@@ -985,6 +993,10 @@ import type {HostComponent} from 'react-native';
export type Boolean = boolean;
export type Int = Int32;
export type Void = void;
export type Locations = {
x: number,
y: number,
}

export type ModuleProps = $ReadOnly<{|
...ViewProps,
Expand All@@ -1006,6 +1018,7 @@ interface NativeCommands {
overlayColorsReadOnly: $ReadOnlyArray<string>,
overlayColorsArray: Array<string>,
overlayColorsArrayAnnotation: string[],
overlayLocations: $ReadOnlyArray<Locations>,
) => void;
}

Expand Down
72 changes: 72 additions & 0 deletions ...codegen/src/parsers/flow/components/__tests__/__snapshots__/component-parser-test.js.snap
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -1447,6 +1447,68 @@ exports[`RN Codegen Flow Parser can generate fixture COMMANDS_DEFINED_WITH_ALL_T
'type': 'VoidTypeAnnotation'
}
}
},
{
'name': 'arrayArgs',
'optional': false,
'typeAnnotation': {
'type': 'FunctionTypeAnnotation',
'params': [
{
'name': 'booleanArray',
'optional': false,
'typeAnnotation': {
'type': 'ArrayTypeAnnotation',
'elementType': {
'type': 'BooleanTypeAnnotation'
}
}
},
{
'name': 'stringArray',
'optional': false,
'typeAnnotation': {
'type': 'ArrayTypeAnnotation',
'elementType': {
'type': 'StringTypeAnnotation'
}
}
},
{
'name': 'floatArray',
'optional': false,
'typeAnnotation': {
'type': 'ArrayTypeAnnotation',
'elementType': {
'type': 'FloatTypeAnnotation'
}
}
},
{
'name': 'intArray',
'optional': false,
'typeAnnotation': {
'type': 'ArrayTypeAnnotation',
'elementType': {
'type': 'Int32TypeAnnotation'
}
}
},
{
'name': 'doubleArray',
'optional': false,
'typeAnnotation': {
'type': 'ArrayTypeAnnotation',
'elementType': {
'type': 'DoubleTypeAnnotation'
}
}
}
],
'returnTypeAnnotation': {
'type': 'VoidTypeAnnotation'
}
}
}
]
}
Expand DownExpand Up@@ -4826,6 +4888,16 @@ exports[`RN Codegen Flow Parser can generate fixture COMMANDS_WITH_EXTERNAL_TYPE
'type': 'StringTypeAnnotation'
}
}
},
{
'name': 'overlayLocations',
'optional': false,
'typeAnnotation': {
'type': 'ArrayTypeAnnotation',
'elementType': {
'type': 'MixedTypeAnnotation'
}
}
}
],
'returnTypeAnnotation': {
Expand Down
73 changes: 65 additions & 8 deletions packages/react-native-codegen/src/parsers/flow/components/commands.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@
import type {
CommandParamTypeAnnotation,
CommandTypeAnnotation,
ComponentCommandArrayTypeAnnotation,
NamedShape,
} from '../../../CodegenSchema.js';
import type {TypeDeclarationMap} from '../../utils';
Expand DownExpand Up@@ -109,19 +110,15 @@ function buildCommandSchema(
}
returnType = {
type: 'ArrayTypeAnnotation',
elementType: {
// TODO: T172453752 support complex type annotation for array element
type: paramValue.typeParameters.params[0].type,
},
elementType: getCommandArrayElementTypeType(
paramValue.typeParameters.params[0],
),
};
break;
case 'ArrayTypeAnnotation':
returnType = {
type: 'ArrayTypeAnnotation',
elementType: {
// TODO: T172453752 support complex type annotation for array element
type: paramValue.elementType.type,
},
elementType: getCommandArrayElementTypeType(paramValue.elementType),
};
break;
default:
Expand DownExpand Up@@ -151,6 +148,66 @@ function buildCommandSchema(
};
}

type Allowed = ComponentCommandArrayTypeAnnotation['elementType'];

function getCommandArrayElementTypeType(inputType: mixed): Allowed {
// TODO: T172453752 support more complex type annotation for array element
if (typeof inputType !== 'object') {
throw new Error('Expected an object');
}

const type = inputType?.type;

if (inputType == null || typeof type !== 'string') {
throw new Error('Command array element type must be a string');
}

switch (type) {
case 'BooleanTypeAnnotation':
return {
type: 'BooleanTypeAnnotation',
};
case 'StringTypeAnnotation':
return {
type: 'StringTypeAnnotation',
};
case 'GenericTypeAnnotation':
const name = typeof inputType.id === 'object' ? inputType.id?.name : null;

if (typeof name !== 'string') {
throw new Error(
'Expected GenericTypeAnnotation AST name to be a string',
);
}

switch (name) {
case 'Int32':
return {
type: 'Int32TypeAnnotation',
};
case 'Float':
return {
type: 'FloatTypeAnnotation',
};
case 'Double':
return {
type: 'DoubleTypeAnnotation',
};
default:
// This is not a great solution. This generally means its a type alias to another type
// like an object or union. Ideally we'd encode that in the schema so the compat-check can
// validate those deeper objects for breaking changes and the generators can do something smarter.
// As of now, the generators just create ReadableMap or (const NSArray *) which are untyped
return {
type: 'MixedTypeAnnotation',
};
}

default:
throw new Error(`Unsupported array element type ${type}`);
}
}

function getCommands(
commandTypeAST: $ReadOnlyArray<EventTypeAST>,
types: TypeDeclarationMap,
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
Fixing schema types for component command params of Arrays#48476

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

elicwhite
wants to merge
5
commits into

from

 Closed


Fixing schema types for component command params of Arrays
#48476
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
abc7c4c

Make CompleteType contain module and component reserved names


elicwhite Jan 6, 2025
3eebf4d

Simplify CompleteTypeAnnotation


elicwhite Jan 6, 2025
2061343

Separate component array types and command array types


elicwhite Jan 6, 2025
a4f3bed

Add command type to CompleteTypeAnnotation


elicwhite Jan 6, 2025
e36140c

Fixing schema types for component command params of Arrays (#48476)


elicwhite Jan 7, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


15 changes: 14 additions & 1 deletion
packages/react-native-codegen/src/CodegenSchema.d.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -142,6 +142,19 @@ export type ComponentArrayTypeAnnotation = ArrayTypeAnnotation<
 | ArrayTypeAnnotation<ObjectTypeAnnotation<PropTypeAnnotation>>
>;

export type ComponentCommandArrayTypeAnnotation = ArrayTypeAnnotation<
 | BooleanTypeAnnotation
 | StringTypeAnnotation
 | DoubleTypeAnnotation
 | FloatTypeAnnotation
 | Int32TypeAnnotation
 // Mixed is not great. This generally means its a type alias to another type
 // like an object or union. Ideally we'd encode that type in the schema so the compat-check can
 // validate those deeper objects for breaking changes and the generators can do something smarter.
 // As of now, the generators just create ReadableMap or (const NSArray *) which are untyped
 | MixedTypeAnnotation
>;

export interface ArrayTypeAnnotation<T> {
 readonly type: 'ArrayTypeAnnotation';
 readonly elementType: T;
Expand DownExpand Up@@ -206,7 +219,7 @@ export type CommandParamTypeAnnotation =
 | DoubleTypeAnnotation
 | FloatTypeAnnotation
 | StringTypeAnnotation
 | ComponentArrayTypeAnnotation;
 | ComponentCommandArrayTypeAnnotation;

export interface ReservedTypeAnnotation {
 readonly type: 'ReservedTypeAnnotation';
Expand Down

32 changes: 27 additions & 5 deletions
packages/react-native-codegen/src/CodegenSchema.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -158,6 +158,19 @@ export type ComponentArrayTypeAnnotation = ArrayTypeAnnotation<
 | ArrayTypeAnnotation<ObjectTypeAnnotation<PropTypeAnnotation>>,
>;

export type ComponentCommandArrayTypeAnnotation = ArrayTypeAnnotation<
 | BooleanTypeAnnotation
 | StringTypeAnnotation
 | DoubleTypeAnnotation
 | FloatTypeAnnotation
 | Int32TypeAnnotation
 // Mixed is not great. This generally means its a type alias to another type
 // like an object or union. Ideally we'd encode that type in the schema so the compat-check can
 // validate those deeper objects for breaking changes and the generators can do something smarter.
 // As of now, the generators just create ReadableMap or (const NSArray *) which are untyped
 | MixedTypeAnnotation,
>;

export type ArrayTypeAnnotation<+T> = $ReadOnly<{
 type: 'ArrayTypeAnnotation',
 elementType: T,
Expand DownExpand Up@@ -222,7 +235,7 @@ export type CommandParamTypeAnnotation =
 | DoubleTypeAnnotation
 | FloatTypeAnnotation
 | StringTypeAnnotation
 | ComponentArrayTypeAnnotation;
 | ComponentCommandArrayTypeAnnotation;

export type ReservedTypeAnnotation = $ReadOnly<{
 type: 'ReservedTypeAnnotation',
Expand DownExpand Up@@ -412,6 +425,14 @@ type NativeModuleReturnOnlyTypeAnnotation =
 | NativeModulePromiseTypeAnnotation
 | VoidTypeAnnotation;

// Add the allowed component reserved types to the native module union
export type CompleteReservedTypeAnnotation =
 | ReservedTypeAnnotation
 | {
 type: 'ReservedTypeAnnotation',
 name: ReservedPropTypeAnnotation['name'],
 };

// Used by compatibility check which needs to handle all possible types
// This will eventually also include the union of all view manager types
export type CompleteTypeAnnotation =
Expand All@@ -421,7 +442,8 @@ export type CompleteTypeAnnotation =
 | EventEmitterTypeAnnotation
 | NativeModuleEnumDeclarationWithMembers
 | UnsafeAnyTypeAnnotation
 // Native Module event emitters and methods
 | ObjectTypeAnnotation<
 Nullable<NativeModuleFunctionTypeAnnotation> | EventEmitterTypeAnnotation,
 >;
 | ArrayTypeAnnotation<CompleteTypeAnnotation>
 | ObjectTypeAnnotation<CompleteTypeAnnotation>
 // Components
 | CommandTypeAnnotation
 | CompleteReservedTypeAnnotation;

10 changes: 10 additions & 0 deletions
packages/react-native-codegen/src/generators/components/__test_fixtures__/fixtures.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1693,6 +1693,16 @@ const COMMANDS: SchemaType = {
 type: 'BooleanTypeAnnotation',
 },
 },
 {
 name: 'locations',
 optional: false,
 typeAnnotation: {
 type: 'ArrayTypeAnnotation',
 elementType: {
 type: 'MixedTypeAnnotation',
 },
 },
 },
 ],
 returnTypeAnnotation: {
 type: 'VoidTypeAnnotation',
Expand Down

16 changes: 12 additions & 4 deletions
...n/src/generators/components/__tests__/__snapshots__/GenerateComponentHObjCpp-test.js.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -119,7 +119,7 @@ NS_ASSUME_NONNULL_BEGIN

@protocol RCTCommandNativeComponentViewProtocol <NSObject>
- (void)flashScrollIndicators;
- (void)allTypes:(NSInteger)x y:(float)y z:(double)z message:(NSString *)message animated:(BOOL)animated;
- (void)allTypes:(NSInteger)x y:(float)y z:(double)z message:(NSString *)message animated:(BOOL)animated locations:(const NSArray *)locations;
@end

RCT_EXTERN inline void RCTCommandNativeComponentHandleCommand(
Expand All@@ -143,8 +143,8 @@ RCT_EXTERN inline void RCTCommandNativeComponentHandleCommand(

if ([commandName isEqualToString:@\\"allTypes\\"]) {
#if RCT_DEBUG
 if ([args count] != 5) {
 RCTLogError(@\\"%@ command %@ received %d arguments, expected %d.\\", @\\"CommandNativeComponent\\", commandName, (int)[args count], 5);
 if ([args count] != 6) {
 RCTLogError(@\\"%@ command %@ received %d arguments, expected %d.\\", @\\"CommandNativeComponent\\", commandName, (int)[args count], 6);
 return;
 }
#endif
Expand DownExpand Up@@ -189,7 +189,15 @@ NSObject *arg4 = args[4];
#endif
 BOOL animated = [(NSNumber *)arg4 boolValue];

 [componentView allTypes:x y:y z:z message:message animated:animated];
NSObject *arg5 = args[5];
#if RCT_DEBUG
 if (!RCTValidateTypeOfViewCommandArgument(arg5, [NSArray class], @\\"array\\", @\\"CommandNativeComponent\\", commandName, @\\"6th\\")) {
 return;
 }
#endif
 const NSArray * locations = (NSArray *)arg5;

 [componentView allTypes:x y:y z:z message:message animated:animated locations:locations];
 return;
}

Expand Down

2 changes: 1 addition & 1 deletion
.../src/generators/components/__tests__/__snapshots__/GeneratePropsJavaDelegate-test.js.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -224,7 +224,7 @@ public class CommandNativeComponentManagerDelegate<T extends View, U extends Bas
 mViewManager.flashScrollIndicators(view);
 break;
 case \\"allTypes\\":
 mViewManager.allTypes(view, args.getInt(0), (float) args.getDouble(1), args.getDouble(2), args.getString(3), args.getBoolean(4));
 mViewManager.allTypes(view, args.getInt(0), (float) args.getDouble(1), args.getDouble(2), args.getString(3), args.getBoolean(4), args.getArray(5));
 break;
 }
 }
Expand Down

3 changes: 2 additions & 1 deletion
...src/generators/components/__tests__/__snapshots__/GeneratePropsJavaInterface-test.js.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -118,11 +118,12 @@ Map {
package com.facebook.react.viewmanagers;

import android.view.View;
import com.facebook.react.bridge.ReadableArray;

public interface CommandNativeComponentManagerInterface<T extends View> {
 // No props
 void flashScrollIndicators(T view);
 void allTypes(T view, int x, float y, double z, String message, boolean animated);
 void allTypes(T view, int x, float y, double z, String message, boolean animated, ReadableArray locations);
}
",
}
Expand Down

4 changes: 2 additions & 2 deletions
...degen/src/generators/components/__tests__/__snapshots__/GenerateViewConfigJs-test.js.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -187,8 +187,8 @@ export const Commands = {
 dispatchCommand(ref, \\"flashScrollIndicators\\", []);
 },

 allTypes(ref, x, y, z, message, animated) {
 dispatchCommand(ref, \\"allTypes\\", [x, y, z, message, animated]);
 allTypes(ref, x, y, z, message, animated, locations) {
 dispatchCommand(ref, \\"allTypes\\", [x, y, z, message, animated, locations]);
 }
};
",
Expand Down

15 changes: 14 additions & 1 deletion
packages/react-native-codegen/src/parsers/flow/components/__test_fixtures__/fixtures.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -951,10 +951,18 @@ interface NativeCommands {
 z: Double,
 animated: boolean,
 ): void;
 +arrayArgs: (
 viewRef: React.ElementRef<NativeType>,
 booleanArray: $ReadOnlyArray<boolean>,
 stringArray: $ReadOnlyArray<string>,
 floatArray: $ReadOnlyArray<Float>,
 intArray: $ReadOnlyArray<Int32>,
 doubleArray: $ReadOnlyArray<Double>,
 ) => void;
}

export const Commands = codegenNativeCommands<NativeCommands>({
 supportedCommands: ['handleRootTag', 'hotspotUpdate', 'scrollTo'],
 supportedCommands: ['handleRootTag', 'hotspotUpdate', 'scrollTo', 'arrayArgs'],
});

export default (codegenNativeComponent<ModuleProps>(
Expand DownExpand Up@@ -985,6 +993,10 @@ import type {HostComponent} from 'react-native';
export type Boolean = boolean;
export type Int = Int32;
export type Void = void;
export type Locations = {
 x: number,
 y: number,
}

export type ModuleProps = $ReadOnly<{|
 ...ViewProps,
Expand All@@ -1006,6 +1018,7 @@ interface NativeCommands {
 overlayColorsReadOnly: $ReadOnlyArray<string>,
 overlayColorsArray: Array<string>,
 overlayColorsArrayAnnotation: string[],
 overlayLocations: $ReadOnlyArray<Locations>,
 ) => void;
}

Expand Down

72 changes: 72 additions & 0 deletions
...codegen/src/parsers/flow/components/__tests__/__snapshots__/component-parser-test.js.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1447,6 +1447,68 @@ exports[`RN Codegen Flow Parser can generate fixture COMMANDS_DEFINED_WITH_ALL_T
 'type': 'VoidTypeAnnotation'
 }
 }
 },
 {
 'name': 'arrayArgs',
 'optional': false,
 'typeAnnotation': {
 'type': 'FunctionTypeAnnotation',
 'params': [
 {
 'name': 'booleanArray',
 'optional': false,
 'typeAnnotation': {
 'type': 'ArrayTypeAnnotation',
 'elementType': {
 'type': 'BooleanTypeAnnotation'
 }
 }
 },
 {
 'name': 'stringArray',
 'optional': false,
 'typeAnnotation': {
 'type': 'ArrayTypeAnnotation',
 'elementType': {
 'type': 'StringTypeAnnotation'
 }
 }
 },
 {
 'name': 'floatArray',
 'optional': false,
 'typeAnnotation': {
 'type': 'ArrayTypeAnnotation',
 'elementType': {
 'type': 'FloatTypeAnnotation'
 }
 }
 },
 {
 'name': 'intArray',
 'optional': false,
 'typeAnnotation': {
 'type': 'ArrayTypeAnnotation',
 'elementType': {
 'type': 'Int32TypeAnnotation'
 }
 }
 },
 {
 'name': 'doubleArray',
 'optional': false,
 'typeAnnotation': {
 'type': 'ArrayTypeAnnotation',
 'elementType': {
 'type': 'DoubleTypeAnnotation'
 }
 }
 }
 ],
 'returnTypeAnnotation': {
 'type': 'VoidTypeAnnotation'
 }
 }
 }
 ]
 }
Expand DownExpand Up@@ -4826,6 +4888,16 @@ exports[`RN Codegen Flow Parser can generate fixture COMMANDS_WITH_EXTERNAL_TYPE
 'type': 'StringTypeAnnotation'
 }
 }
 },
 {
 'name': 'overlayLocations',
 'optional': false,
 'typeAnnotation': {
 'type': 'ArrayTypeAnnotation',
 'elementType': {
 'type': 'MixedTypeAnnotation'
 }
 }
 }
 ],
 'returnTypeAnnotation': {
Expand Down

73 changes: 65 additions & 8 deletions
packages/react-native-codegen/src/parsers/flow/components/commands.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@
import type {
 CommandParamTypeAnnotation,
 CommandTypeAnnotation,
 ComponentCommandArrayTypeAnnotation,
 NamedShape,
} from '../../../CodegenSchema.js';
import type {TypeDeclarationMap} from '../../utils';
Expand DownExpand Up@@ -109,19 +110,15 @@ function buildCommandSchema(
 }
 returnType = {
 type: 'ArrayTypeAnnotation',
 elementType: {
 // TODO: T172453752 support complex type annotation for array element
 type: paramValue.typeParameters.params[0].type,
 },
 elementType: getCommandArrayElementTypeType(
 paramValue.typeParameters.params[0],
 ),
 };
 break;
 case 'ArrayTypeAnnotation':
 returnType = {
 type: 'ArrayTypeAnnotation',
 elementType: {
 // TODO: T172453752 support complex type annotation for array element
 type: paramValue.elementType.type,
 },
 elementType: getCommandArrayElementTypeType(paramValue.elementType),
 };
 break;
 default:
Expand DownExpand Up@@ -151,6 +148,66 @@ function buildCommandSchema(
 };
}

type Allowed = ComponentCommandArrayTypeAnnotation['elementType'];

function getCommandArrayElementTypeType(inputType: mixed): Allowed {
 // TODO: T172453752 support more complex type annotation for array element
 if (typeof inputType !== 'object') {
 throw new Error('Expected an object');
 }

 const type = inputType?.type;

 if (inputType == null || typeof type !== 'string') {
 throw new Error('Command array element type must be a string');
 }

 switch (type) {
 case 'BooleanTypeAnnotation':
 return {
 type: 'BooleanTypeAnnotation',
 };
 case 'StringTypeAnnotation':
 return {
 type: 'StringTypeAnnotation',
 };
 case 'GenericTypeAnnotation':
 const name = typeof inputType.id === 'object' ? inputType.id?.name : null;

 if (typeof name !== 'string') {
 throw new Error(
 'Expected GenericTypeAnnotation AST name to be a string',
 );
 }

 switch (name) {
 case 'Int32':
 return {
 type: 'Int32TypeAnnotation',
 };
 case 'Float':
 return {
 type: 'FloatTypeAnnotation',
 };
 case 'Double':
 return {
 type: 'DoubleTypeAnnotation',
 };
 default:
 // This is not a great solution. This generally means its a type alias to another type
 // like an object or union. Ideally we'd encode that in the schema so the compat-check can
 // validate those deeper objects for breaking changes and the generators can do something smarter.
 // As of now, the generators just create ReadableMap or (const NSArray *) which are untyped
 return {
 type: 'MixedTypeAnnotation',
 };
 }

 default:
 throw new Error(`Unsupported array element type ${type}`);
 }
}

function getCommands(
 commandTypeAST: $ReadOnlyArray<EventTypeAST>,
 types: TypeDeclarationMap,
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Fixing schema types for component command params of Arrays#48476

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

elicwhite
wants to merge
5
commits into

from

 Closed


Fixing schema types for component command params of Arrays
#48476
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
abc7c4c

Make CompleteType contain module and component reserved names


elicwhite Jan 6, 2025
3eebf4d

Simplify CompleteTypeAnnotation


elicwhite Jan 6, 2025
2061343

Separate component array types and command array types


elicwhite Jan 6, 2025
a4f3bed

Add command type to CompleteTypeAnnotation


elicwhite Jan 6, 2025
e36140c

Fixing schema types for component command params of Arrays (#48476)


elicwhite Jan 7, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


15 changes: 14 additions & 1 deletion
packages/react-native-codegen/src/CodegenSchema.d.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -142,6 +142,19 @@ export type ComponentArrayTypeAnnotation = ArrayTypeAnnotation<
 | ArrayTypeAnnotation<ObjectTypeAnnotation<PropTypeAnnotation>>
>;

export type ComponentCommandArrayTypeAnnotation = ArrayTypeAnnotation<
 | BooleanTypeAnnotation
 | StringTypeAnnotation
 | DoubleTypeAnnotation
 | FloatTypeAnnotation
 | Int32TypeAnnotation
 // Mixed is not great. This generally means its a type alias to another type
 // like an object or union. Ideally we'd encode that type in the schema so the compat-check can
 // validate those deeper objects for breaking changes and the generators can do something smarter.
 // As of now, the generators just create ReadableMap or (const NSArray *) which are untyped
 | MixedTypeAnnotation
>;

export interface ArrayTypeAnnotation<T> {
 readonly type: 'ArrayTypeAnnotation';
 readonly elementType: T;
Expand DownExpand Up@@ -206,7 +219,7 @@ export type CommandParamTypeAnnotation =
 | DoubleTypeAnnotation
 | FloatTypeAnnotation
 | StringTypeAnnotation
 | ComponentArrayTypeAnnotation;
 | ComponentCommandArrayTypeAnnotation;

export interface ReservedTypeAnnotation {
 readonly type: 'ReservedTypeAnnotation';
Expand Down

32 changes: 27 additions & 5 deletions
packages/react-native-codegen/src/CodegenSchema.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -158,6 +158,19 @@ export type ComponentArrayTypeAnnotation = ArrayTypeAnnotation<
 | ArrayTypeAnnotation<ObjectTypeAnnotation<PropTypeAnnotation>>,
>;

export type ComponentCommandArrayTypeAnnotation = ArrayTypeAnnotation<
 | BooleanTypeAnnotation
 | StringTypeAnnotation
 | DoubleTypeAnnotation
 | FloatTypeAnnotation
 | Int32TypeAnnotation
 // Mixed is not great. This generally means its a type alias to another type
 // like an object or union. Ideally we'd encode that type in the schema so the compat-check can
 // validate those deeper objects for breaking changes and the generators can do something smarter.
 // As of now, the generators just create ReadableMap or (const NSArray *) which are untyped
 | MixedTypeAnnotation,
>;

export type ArrayTypeAnnotation<+T> = $ReadOnly<{
 type: 'ArrayTypeAnnotation',
 elementType: T,
Expand DownExpand Up@@ -222,7 +235,7 @@ export type CommandParamTypeAnnotation =
 | DoubleTypeAnnotation
 | FloatTypeAnnotation
 | StringTypeAnnotation
 | ComponentArrayTypeAnnotation;
 | ComponentCommandArrayTypeAnnotation;

export type ReservedTypeAnnotation = $ReadOnly<{
 type: 'ReservedTypeAnnotation',
Expand DownExpand Up@@ -412,6 +425,14 @@ type NativeModuleReturnOnlyTypeAnnotation =
 | NativeModulePromiseTypeAnnotation
 | VoidTypeAnnotation;

// Add the allowed component reserved types to the native module union
export type CompleteReservedTypeAnnotation =
 | ReservedTypeAnnotation
 | {
 type: 'ReservedTypeAnnotation',
 name: ReservedPropTypeAnnotation['name'],
 };

// Used by compatibility check which needs to handle all possible types
// This will eventually also include the union of all view manager types
export type CompleteTypeAnnotation =
Expand All@@ -421,7 +442,8 @@ export type CompleteTypeAnnotation =
 | EventEmitterTypeAnnotation
 | NativeModuleEnumDeclarationWithMembers
 | UnsafeAnyTypeAnnotation
 // Native Module event emitters and methods
 | ObjectTypeAnnotation<
 Nullable<NativeModuleFunctionTypeAnnotation> | EventEmitterTypeAnnotation,
 >;
 | ArrayTypeAnnotation<CompleteTypeAnnotation>
 | ObjectTypeAnnotation<CompleteTypeAnnotation>
 // Components
 | CommandTypeAnnotation
 | CompleteReservedTypeAnnotation;

10 changes: 10 additions & 0 deletions
packages/react-native-codegen/src/generators/components/__test_fixtures__/fixtures.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1693,6 +1693,16 @@ const COMMANDS: SchemaType = {
 type: 'BooleanTypeAnnotation',
 },
 },
 {
 name: 'locations',
 optional: false,
 typeAnnotation: {
 type: 'ArrayTypeAnnotation',
 elementType: {
 type: 'MixedTypeAnnotation',
 },
 },
 },
 ],
 returnTypeAnnotation: {
 type: 'VoidTypeAnnotation',
Expand Down

16 changes: 12 additions & 4 deletions
...n/src/generators/components/__tests__/__snapshots__/GenerateComponentHObjCpp-test.js.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -119,7 +119,7 @@ NS_ASSUME_NONNULL_BEGIN

@protocol RCTCommandNativeComponentViewProtocol <NSObject>
- (void)flashScrollIndicators;
- (void)allTypes:(NSInteger)x y:(float)y z:(double)z message:(NSString *)message animated:(BOOL)animated;
- (void)allTypes:(NSInteger)x y:(float)y z:(double)z message:(NSString *)message animated:(BOOL)animated locations:(const NSArray *)locations;
@end

RCT_EXTERN inline void RCTCommandNativeComponentHandleCommand(
Expand All@@ -143,8 +143,8 @@ RCT_EXTERN inline void RCTCommandNativeComponentHandleCommand(

if ([commandName isEqualToString:@\\"allTypes\\"]) {
#if RCT_DEBUG
 if ([args count] != 5) {
 RCTLogError(@\\"%@ command %@ received %d arguments, expected %d.\\", @\\"CommandNativeComponent\\", commandName, (int)[args count], 5);
 if ([args count] != 6) {
 RCTLogError(@\\"%@ command %@ received %d arguments, expected %d.\\", @\\"CommandNativeComponent\\", commandName, (int)[args count], 6);
 return;
 }
#endif
Expand DownExpand Up@@ -189,7 +189,15 @@ NSObject *arg4 = args[4];
#endif
 BOOL animated = [(NSNumber *)arg4 boolValue];

 [componentView allTypes:x y:y z:z message:message animated:animated];
NSObject *arg5 = args[5];
#if RCT_DEBUG
 if (!RCTValidateTypeOfViewCommandArgument(arg5, [NSArray class], @\\"array\\", @\\"CommandNativeComponent\\", commandName, @\\"6th\\")) {
 return;
 }
#endif
 const NSArray * locations = (NSArray *)arg5;

 [componentView allTypes:x y:y z:z message:message animated:animated locations:locations];
 return;
}

Expand Down

2 changes: 1 addition & 1 deletion
.../src/generators/components/__tests__/__snapshots__/GeneratePropsJavaDelegate-test.js.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -224,7 +224,7 @@ public class CommandNativeComponentManagerDelegate<T extends View, U extends Bas
 mViewManager.flashScrollIndicators(view);
 break;
 case \\"allTypes\\":
 mViewManager.allTypes(view, args.getInt(0), (float) args.getDouble(1), args.getDouble(2), args.getString(3), args.getBoolean(4));
 mViewManager.allTypes(view, args.getInt(0), (float) args.getDouble(1), args.getDouble(2), args.getString(3), args.getBoolean(4), args.getArray(5));
 break;
 }
 }
Expand Down

3 changes: 2 additions & 1 deletion
...src/generators/components/__tests__/__snapshots__/GeneratePropsJavaInterface-test.js.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -118,11 +118,12 @@ Map {
package com.facebook.react.viewmanagers;

import android.view.View;
import com.facebook.react.bridge.ReadableArray;

public interface CommandNativeComponentManagerInterface<T extends View> {
 // No props
 void flashScrollIndicators(T view);
 void allTypes(T view, int x, float y, double z, String message, boolean animated);
 void allTypes(T view, int x, float y, double z, String message, boolean animated, ReadableArray locations);
}
",
}
Expand Down

4 changes: 2 additions & 2 deletions
...degen/src/generators/components/__tests__/__snapshots__/GenerateViewConfigJs-test.js.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -187,8 +187,8 @@ export const Commands = {
 dispatchCommand(ref, \\"flashScrollIndicators\\", []);
 },

 allTypes(ref, x, y, z, message, animated) {
 dispatchCommand(ref, \\"allTypes\\", [x, y, z, message, animated]);
 allTypes(ref, x, y, z, message, animated, locations) {
 dispatchCommand(ref, \\"allTypes\\", [x, y, z, message, animated, locations]);
 }
};
",
Expand Down

15 changes: 14 additions & 1 deletion
packages/react-native-codegen/src/parsers/flow/components/__test_fixtures__/fixtures.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -951,10 +951,18 @@ interface NativeCommands {
 z: Double,
 animated: boolean,
 ): void;
 +arrayArgs: (
 viewRef: React.ElementRef<NativeType>,
 booleanArray: $ReadOnlyArray<boolean>,
 stringArray: $ReadOnlyArray<string>,
 floatArray: $ReadOnlyArray<Float>,
 intArray: $ReadOnlyArray<Int32>,
 doubleArray: $ReadOnlyArray<Double>,
 ) => void;
}

export const Commands = codegenNativeCommands<NativeCommands>({
 supportedCommands: ['handleRootTag', 'hotspotUpdate', 'scrollTo'],
 supportedCommands: ['handleRootTag', 'hotspotUpdate', 'scrollTo', 'arrayArgs'],
});

export default (codegenNativeComponent<ModuleProps>(
Expand DownExpand Up@@ -985,6 +993,10 @@ import type {HostComponent} from 'react-native';
export type Boolean = boolean;
export type Int = Int32;
export type Void = void;
export type Locations = {
 x: number,
 y: number,
}

export type ModuleProps = $ReadOnly<{|
 ...ViewProps,
Expand All@@ -1006,6 +1018,7 @@ interface NativeCommands {
 overlayColorsReadOnly: $ReadOnlyArray<string>,
 overlayColorsArray: Array<string>,
 overlayColorsArrayAnnotation: string[],
 overlayLocations: $ReadOnlyArray<Locations>,
 ) => void;
}

Expand Down

72 changes: 72 additions & 0 deletions
...codegen/src/parsers/flow/components/__tests__/__snapshots__/component-parser-test.js.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1447,6 +1447,68 @@ exports[`RN Codegen Flow Parser can generate fixture COMMANDS_DEFINED_WITH_ALL_T
 'type': 'VoidTypeAnnotation'
 }
 }
 },
 {
 'name': 'arrayArgs',
 'optional': false,
 'typeAnnotation': {
 'type': 'FunctionTypeAnnotation',
 'params': [
 {
 'name': 'booleanArray',
 'optional': false,
 'typeAnnotation': {
 'type': 'ArrayTypeAnnotation',
 'elementType': {
 'type': 'BooleanTypeAnnotation'
 }
 }
 },
 {
 'name': 'stringArray',
 'optional': false,
 'typeAnnotation': {
 'type': 'ArrayTypeAnnotation',
 'elementType': {
 'type': 'StringTypeAnnotation'
 }
 }
 },
 {
 'name': 'floatArray',
 'optional': false,
 'typeAnnotation': {
 'type': 'ArrayTypeAnnotation',
 'elementType': {
 'type': 'FloatTypeAnnotation'
 }
 }
 },
 {
 'name': 'intArray',
 'optional': false,
 'typeAnnotation': {
 'type': 'ArrayTypeAnnotation',
 'elementType': {
 'type': 'Int32TypeAnnotation'
 }
 }
 },
 {
 'name': 'doubleArray',
 'optional': false,
 'typeAnnotation': {
 'type': 'ArrayTypeAnnotation',
 'elementType': {
 'type': 'DoubleTypeAnnotation'
 }
 }
 }
 ],
 'returnTypeAnnotation': {
 'type': 'VoidTypeAnnotation'
 }
 }
 }
 ]
 }
Expand DownExpand Up@@ -4826,6 +4888,16 @@ exports[`RN Codegen Flow Parser can generate fixture COMMANDS_WITH_EXTERNAL_TYPE
 'type': 'StringTypeAnnotation'
 }
 }
 },
 {
 'name': 'overlayLocations',
 'optional': false,
 'typeAnnotation': {
 'type': 'ArrayTypeAnnotation',
 'elementType': {
 'type': 'MixedTypeAnnotation'
 }
 }
 }
 ],
 'returnTypeAnnotation': {
Expand Down

73 changes: 65 additions & 8 deletions
packages/react-native-codegen/src/parsers/flow/components/commands.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@
import type {
 CommandParamTypeAnnotation,
 CommandTypeAnnotation,
 ComponentCommandArrayTypeAnnotation,
 NamedShape,
} from '../../../CodegenSchema.js';
import type {TypeDeclarationMap} from '../../utils';
Expand DownExpand Up@@ -109,19 +110,15 @@ function buildCommandSchema(
 }
 returnType = {
 type: 'ArrayTypeAnnotation',
 elementType: {
 // TODO: T172453752 support complex type annotation for array element
 type: paramValue.typeParameters.params[0].type,
 },
 elementType: getCommandArrayElementTypeType(
 paramValue.typeParameters.params[0],
 ),
 };
 break;
 case 'ArrayTypeAnnotation':
 returnType = {
 type: 'ArrayTypeAnnotation',
 elementType: {
 // TODO: T172453752 support complex type annotation for array element
 type: paramValue.elementType.type,
 },
 elementType: getCommandArrayElementTypeType(paramValue.elementType),
 };
 break;
 default:
Expand DownExpand Up@@ -151,6 +148,66 @@ function buildCommandSchema(
 };
}

type Allowed = ComponentCommandArrayTypeAnnotation['elementType'];

function getCommandArrayElementTypeType(inputType: mixed): Allowed {
 // TODO: T172453752 support more complex type annotation for array element
 if (typeof inputType !== 'object') {
 throw new Error('Expected an object');
 }

 const type = inputType?.type;

 if (inputType == null || typeof type !== 'string') {
 throw new Error('Command array element type must be a string');
 }

 switch (type) {
 case 'BooleanTypeAnnotation':
 return {
 type: 'BooleanTypeAnnotation',
 };
 case 'StringTypeAnnotation':
 return {
 type: 'StringTypeAnnotation',
 };
 case 'GenericTypeAnnotation':
 const name = typeof inputType.id === 'object' ? inputType.id?.name : null;

 if (typeof name !== 'string') {
 throw new Error(
 'Expected GenericTypeAnnotation AST name to be a string',
 );
 }

 switch (name) {
 case 'Int32':
 return {
 type: 'Int32TypeAnnotation',
 };
 case 'Float':
 return {
 type: 'FloatTypeAnnotation',
 };
 case 'Double':
 return {
 type: 'DoubleTypeAnnotation',
 };
 default:
 // This is not a great solution. This generally means its a type alias to another type
 // like an object or union. Ideally we'd encode that in the schema so the compat-check can
 // validate those deeper objects for breaking changes and the generators can do something smarter.
 // As of now, the generators just create ReadableMap or (const NSArray *) which are untyped
 return {
 type: 'MixedTypeAnnotation',
 };
 }

 default:
 throw new Error(`Unsupported array element type ${type}`);
 }
}

function getCommands(
 commandTypeAST: $ReadOnlyArray<EventTypeAST>,
 types: TypeDeclarationMap,
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Fixing schema types for component command params of Arrays#48476

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

elicwhite
wants to merge
5
commits into

from

 Closed


Fixing schema types for component command params of Arrays
#48476
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
abc7c4c

Make CompleteType contain module and component reserved names


elicwhite Jan 6, 2025
3eebf4d

Simplify CompleteTypeAnnotation


elicwhite Jan 6, 2025
2061343

Separate component array types and command array types


elicwhite Jan 6, 2025
a4f3bed

Add command type to CompleteTypeAnnotation


elicwhite Jan 6, 2025
e36140c

Fixing schema types for component command params of Arrays (#48476)


elicwhite Jan 7, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


15 changes: 14 additions & 1 deletion
packages/react-native-codegen/src/CodegenSchema.d.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -142,6 +142,19 @@ export type ComponentArrayTypeAnnotation = ArrayTypeAnnotation<
 | ArrayTypeAnnotation<ObjectTypeAnnotation<PropTypeAnnotation>>
>;

export type ComponentCommandArrayTypeAnnotation = ArrayTypeAnnotation<
 | BooleanTypeAnnotation
 | StringTypeAnnotation
 | DoubleTypeAnnotation
 | FloatTypeAnnotation
 | Int32TypeAnnotation
 // Mixed is not great. This generally means its a type alias to another type
 // like an object or union. Ideally we'd encode that type in the schema so the compat-check can
 // validate those deeper objects for breaking changes and the generators can do something smarter.
 // As of now, the generators just create ReadableMap or (const NSArray *) which are untyped
 | MixedTypeAnnotation
>;

export interface ArrayTypeAnnotation<T> {
 readonly type: 'ArrayTypeAnnotation';
 readonly elementType: T;
Expand DownExpand Up@@ -206,7 +219,7 @@ export type CommandParamTypeAnnotation =
 | DoubleTypeAnnotation
 | FloatTypeAnnotation
 | StringTypeAnnotation
 | ComponentArrayTypeAnnotation;
 | ComponentCommandArrayTypeAnnotation;

export interface ReservedTypeAnnotation {
 readonly type: 'ReservedTypeAnnotation';
Expand Down

32 changes: 27 additions & 5 deletions
packages/react-native-codegen/src/CodegenSchema.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -158,6 +158,19 @@ export type ComponentArrayTypeAnnotation = ArrayTypeAnnotation<
 | ArrayTypeAnnotation<ObjectTypeAnnotation<PropTypeAnnotation>>,
>;

export type ComponentCommandArrayTypeAnnotation = ArrayTypeAnnotation<
 | BooleanTypeAnnotation
 | StringTypeAnnotation
 | DoubleTypeAnnotation
 | FloatTypeAnnotation
 | Int32TypeAnnotation
 // Mixed is not great. This generally means its a type alias to another type
 // like an object or union. Ideally we'd encode that type in the schema so the compat-check can
 // validate those deeper objects for breaking changes and the generators can do something smarter.
 // As of now, the generators just create ReadableMap or (const NSArray *) which are untyped
 | MixedTypeAnnotation,
>;

export type ArrayTypeAnnotation<+T> = $ReadOnly<{
 type: 'ArrayTypeAnnotation',
 elementType: T,
Expand DownExpand Up@@ -222,7 +235,7 @@ export type CommandParamTypeAnnotation =
 | DoubleTypeAnnotation
 | FloatTypeAnnotation
 | StringTypeAnnotation
 | ComponentArrayTypeAnnotation;
 | ComponentCommandArrayTypeAnnotation;

export type ReservedTypeAnnotation = $ReadOnly<{
 type: 'ReservedTypeAnnotation',
Expand DownExpand Up@@ -412,6 +425,14 @@ type NativeModuleReturnOnlyTypeAnnotation =
 | NativeModulePromiseTypeAnnotation
 | VoidTypeAnnotation;

// Add the allowed component reserved types to the native module union
export type CompleteReservedTypeAnnotation =
 | ReservedTypeAnnotation
 | {
 type: 'ReservedTypeAnnotation',
 name: ReservedPropTypeAnnotation['name'],
 };

// Used by compatibility check which needs to handle all possible types
// This will eventually also include the union of all view manager types
export type CompleteTypeAnnotation =
Expand All@@ -421,7 +442,8 @@ export type CompleteTypeAnnotation =
 | EventEmitterTypeAnnotation
 | NativeModuleEnumDeclarationWithMembers
 | UnsafeAnyTypeAnnotation
 // Native Module event emitters and methods
 | ObjectTypeAnnotation<
 Nullable<NativeModuleFunctionTypeAnnotation> | EventEmitterTypeAnnotation,
 >;
 | ArrayTypeAnnotation<CompleteTypeAnnotation>
 | ObjectTypeAnnotation<CompleteTypeAnnotation>
 // Components
 | CommandTypeAnnotation
 | CompleteReservedTypeAnnotation;

10 changes: 10 additions & 0 deletions
packages/react-native-codegen/src/generators/components/__test_fixtures__/fixtures.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1693,6 +1693,16 @@ const COMMANDS: SchemaType = {
 type: 'BooleanTypeAnnotation',
 },
 },
 {
 name: 'locations',
 optional: false,
 typeAnnotation: {
 type: 'ArrayTypeAnnotation',
 elementType: {
 type: 'MixedTypeAnnotation',
 },
 },
 },
 ],
 returnTypeAnnotation: {
 type: 'VoidTypeAnnotation',
Expand Down

16 changes: 12 additions & 4 deletions
...n/src/generators/components/__tests__/__snapshots__/GenerateComponentHObjCpp-test.js.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -119,7 +119,7 @@ NS_ASSUME_NONNULL_BEGIN

@protocol RCTCommandNativeComponentViewProtocol <NSObject>
- (void)flashScrollIndicators;
- (void)allTypes:(NSInteger)x y:(float)y z:(double)z message:(NSString *)message animated:(BOOL)animated;
- (void)allTypes:(NSInteger)x y:(float)y z:(double)z message:(NSString *)message animated:(BOOL)animated locations:(const NSArray *)locations;
@end

RCT_EXTERN inline void RCTCommandNativeComponentHandleCommand(
Expand All@@ -143,8 +143,8 @@ RCT_EXTERN inline void RCTCommandNativeComponentHandleCommand(

if ([commandName isEqualToString:@\\"allTypes\\"]) {
#if RCT_DEBUG
 if ([args count] != 5) {
 RCTLogError(@\\"%@ command %@ received %d arguments, expected %d.\\", @\\"CommandNativeComponent\\", commandName, (int)[args count], 5);
 if ([args count] != 6) {
 RCTLogError(@\\"%@ command %@ received %d arguments, expected %d.\\", @\\"CommandNativeComponent\\", commandName, (int)[args count], 6);
 return;
 }
#endif
Expand DownExpand Up@@ -189,7 +189,15 @@ NSObject *arg4 = args[4];
#endif
 BOOL animated = [(NSNumber *)arg4 boolValue];

 [componentView allTypes:x y:y z:z message:message animated:animated];
NSObject *arg5 = args[5];
#if RCT_DEBUG
 if (!RCTValidateTypeOfViewCommandArgument(arg5, [NSArray class], @\\"array\\", @\\"CommandNativeComponent\\", commandName, @\\"6th\\")) {
 return;
 }
#endif
 const NSArray * locations = (NSArray *)arg5;

 [componentView allTypes:x y:y z:z message:message animated:animated locations:locations];
 return;
}

Expand Down

2 changes: 1 addition & 1 deletion
.../src/generators/components/__tests__/__snapshots__/GeneratePropsJavaDelegate-test.js.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -224,7 +224,7 @@ public class CommandNativeComponentManagerDelegate<T extends View, U extends Bas
 mViewManager.flashScrollIndicators(view);
 break;
 case \\"allTypes\\":
 mViewManager.allTypes(view, args.getInt(0), (float) args.getDouble(1), args.getDouble(2), args.getString(3), args.getBoolean(4));
 mViewManager.allTypes(view, args.getInt(0), (float) args.getDouble(1), args.getDouble(2), args.getString(3), args.getBoolean(4), args.getArray(5));
 break;
 }
 }
Expand Down

3 changes: 2 additions & 1 deletion
...src/generators/components/__tests__/__snapshots__/GeneratePropsJavaInterface-test.js.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -118,11 +118,12 @@ Map {
package com.facebook.react.viewmanagers;

import android.view.View;
import com.facebook.react.bridge.ReadableArray;

public interface CommandNativeComponentManagerInterface<T extends View> {
 // No props
 void flashScrollIndicators(T view);
 void allTypes(T view, int x, float y, double z, String message, boolean animated);
 void allTypes(T view, int x, float y, double z, String message, boolean animated, ReadableArray locations);
}
",
}
Expand Down

4 changes: 2 additions & 2 deletions
...degen/src/generators/components/__tests__/__snapshots__/GenerateViewConfigJs-test.js.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -187,8 +187,8 @@ export const Commands = {
 dispatchCommand(ref, \\"flashScrollIndicators\\", []);
 },

 allTypes(ref, x, y, z, message, animated) {
 dispatchCommand(ref, \\"allTypes\\", [x, y, z, message, animated]);
 allTypes(ref, x, y, z, message, animated, locations) {
 dispatchCommand(ref, \\"allTypes\\", [x, y, z, message, animated, locations]);
 }
};
",
Expand Down

15 changes: 14 additions & 1 deletion
packages/react-native-codegen/src/parsers/flow/components/__test_fixtures__/fixtures.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -951,10 +951,18 @@ interface NativeCommands {
 z: Double,
 animated: boolean,
 ): void;
 +arrayArgs: (
 viewRef: React.ElementRef<NativeType>,
 booleanArray: $ReadOnlyArray<boolean>,
 stringArray: $ReadOnlyArray<string>,
 floatArray: $ReadOnlyArray<Float>,
 intArray: $ReadOnlyArray<Int32>,
 doubleArray: $ReadOnlyArray<Double>,
 ) => void;
}

export const Commands = codegenNativeCommands<NativeCommands>({
 supportedCommands: ['handleRootTag', 'hotspotUpdate', 'scrollTo'],
 supportedCommands: ['handleRootTag', 'hotspotUpdate', 'scrollTo', 'arrayArgs'],
});

export default (codegenNativeComponent<ModuleProps>(
Expand DownExpand Up@@ -985,6 +993,10 @@ import type {HostComponent} from 'react-native';
export type Boolean = boolean;
export type Int = Int32;
export type Void = void;
export type Locations = {
 x: number,
 y: number,
}

export type ModuleProps = $ReadOnly<{|
 ...ViewProps,
Expand All@@ -1006,6 +1018,7 @@ interface NativeCommands {
 overlayColorsReadOnly: $ReadOnlyArray<string>,
 overlayColorsArray: Array<string>,
 overlayColorsArrayAnnotation: string[],
 overlayLocations: $ReadOnlyArray<Locations>,
 ) => void;
}

Expand Down

72 changes: 72 additions & 0 deletions
...codegen/src/parsers/flow/components/__tests__/__snapshots__/component-parser-test.js.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1447,6 +1447,68 @@ exports[`RN Codegen Flow Parser can generate fixture COMMANDS_DEFINED_WITH_ALL_T
 'type': 'VoidTypeAnnotation'
 }
 }
 },
 {
 'name': 'arrayArgs',
 'optional': false,
 'typeAnnotation': {
 'type': 'FunctionTypeAnnotation',
 'params': [
 {
 'name': 'booleanArray',
 'optional': false,
 'typeAnnotation': {
 'type': 'ArrayTypeAnnotation',
 'elementType': {
 'type': 'BooleanTypeAnnotation'
 }
 }
 },
 {
 'name': 'stringArray',
 'optional': false,
 'typeAnnotation': {
 'type': 'ArrayTypeAnnotation',
 'elementType': {
 'type': 'StringTypeAnnotation'
 }
 }
 },
 {
 'name': 'floatArray',
 'optional': false,
 'typeAnnotation': {
 'type': 'ArrayTypeAnnotation',
 'elementType': {
 'type': 'FloatTypeAnnotation'
 }
 }
 },
 {
 'name': 'intArray',
 'optional': false,
 'typeAnnotation': {
 'type': 'ArrayTypeAnnotation',
 'elementType': {
 'type': 'Int32TypeAnnotation'
 }
 }
 },
 {
 'name': 'doubleArray',
 'optional': false,
 'typeAnnotation': {
 'type': 'ArrayTypeAnnotation',
 'elementType': {
 'type': 'DoubleTypeAnnotation'
 }
 }
 }
 ],
 'returnTypeAnnotation': {
 'type': 'VoidTypeAnnotation'
 }
 }
 }
 ]
 }
Expand DownExpand Up@@ -4826,6 +4888,16 @@ exports[`RN Codegen Flow Parser can generate fixture COMMANDS_WITH_EXTERNAL_TYPE
 'type': 'StringTypeAnnotation'
 }
 }
 },
 {
 'name': 'overlayLocations',
 'optional': false,
 'typeAnnotation': {
 'type': 'ArrayTypeAnnotation',
 'elementType': {
 'type': 'MixedTypeAnnotation'
 }
 }
 }
 ],
 'returnTypeAnnotation': {
Expand Down

73 changes: 65 additions & 8 deletions
packages/react-native-codegen/src/parsers/flow/components/commands.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@
import type {
 CommandParamTypeAnnotation,
 CommandTypeAnnotation,
 ComponentCommandArrayTypeAnnotation,
 NamedShape,
} from '../../../CodegenSchema.js';
import type {TypeDeclarationMap} from '../../utils';
Expand DownExpand Up@@ -109,19 +110,15 @@ function buildCommandSchema(
 }
 returnType = {
 type: 'ArrayTypeAnnotation',
 elementType: {
 // TODO: T172453752 support complex type annotation for array element
 type: paramValue.typeParameters.params[0].type,
 },
 elementType: getCommandArrayElementTypeType(
 paramValue.typeParameters.params[0],
 ),
 };
 break;
 case 'ArrayTypeAnnotation':
 returnType = {
 type: 'ArrayTypeAnnotation',
 elementType: {
 // TODO: T172453752 support complex type annotation for array element
 type: paramValue.elementType.type,
 },
 elementType: getCommandArrayElementTypeType(paramValue.elementType),
 };
 break;
 default:
Expand DownExpand Up@@ -151,6 +148,66 @@ function buildCommandSchema(
 };
}

type Allowed = ComponentCommandArrayTypeAnnotation['elementType'];

function getCommandArrayElementTypeType(inputType: mixed): Allowed {
 // TODO: T172453752 support more complex type annotation for array element
 if (typeof inputType !== 'object') {
 throw new Error('Expected an object');
 }

 const type = inputType?.type;

 if (inputType == null || typeof type !== 'string') {
 throw new Error('Command array element type must be a string');
 }

 switch (type) {
 case 'BooleanTypeAnnotation':
 return {
 type: 'BooleanTypeAnnotation',
 };
 case 'StringTypeAnnotation':
 return {
 type: 'StringTypeAnnotation',
 };
 case 'GenericTypeAnnotation':
 const name = typeof inputType.id === 'object' ? inputType.id?.name : null;

 if (typeof name !== 'string') {
 throw new Error(
 'Expected GenericTypeAnnotation AST name to be a string',
 );
 }

 switch (name) {
 case 'Int32':
 return {
 type: 'Int32TypeAnnotation',
 };
 case 'Float':
 return {
 type: 'FloatTypeAnnotation',
 };
 case 'Double':
 return {
 type: 'DoubleTypeAnnotation',
 };
 default:
 // This is not a great solution. This generally means its a type alias to another type
 // like an object or union. Ideally we'd encode that in the schema so the compat-check can
 // validate those deeper objects for breaking changes and the generators can do something smarter.
 // As of now, the generators just create ReadableMap or (const NSArray *) which are untyped
 return {
 type: 'MixedTypeAnnotation',
 };
 }

 default:
 throw new Error(`Unsupported array element type ${type}`);
 }
}

function getCommands(
 commandTypeAST: $ReadOnlyArray<EventTypeAST>,
 types: TypeDeclarationMap,
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
Fixing schema types for component command params of Arrays#48476

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

elicwhite
wants to merge
5
commits into

from

 Closed


Fixing schema types for component command params of Arrays
#48476
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
abc7c4c

Make CompleteType contain module and component reserved names


elicwhite Jan 6, 2025
3eebf4d

Simplify CompleteTypeAnnotation


elicwhite Jan 6, 2025
2061343

Separate component array types and command array types


elicwhite Jan 6, 2025
a4f3bed

Add command type to CompleteTypeAnnotation


elicwhite Jan 6, 2025
e36140c

Fixing schema types for component command params of Arrays (#48476)


elicwhite Jan 7, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


15 changes: 14 additions & 1 deletion
packages/react-native-codegen/src/CodegenSchema.d.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -142,6 +142,19 @@ export type ComponentArrayTypeAnnotation = ArrayTypeAnnotation<
 | ArrayTypeAnnotation<ObjectTypeAnnotation<PropTypeAnnotation>>
>;

export type ComponentCommandArrayTypeAnnotation = ArrayTypeAnnotation<
 | BooleanTypeAnnotation
 | StringTypeAnnotation
 | DoubleTypeAnnotation
 | FloatTypeAnnotation
 | Int32TypeAnnotation
 // Mixed is not great. This generally means its a type alias to another type
 // like an object or union. Ideally we'd encode that type in the schema so the compat-check can
 // validate those deeper objects for breaking changes and the generators can do something smarter.
 // As of now, the generators just create ReadableMap or (const NSArray *) which are untyped
 | MixedTypeAnnotation
>;

export interface ArrayTypeAnnotation<T> {
 readonly type: 'ArrayTypeAnnotation';
 readonly elementType: T;
Expand DownExpand Up@@ -206,7 +219,7 @@ export type CommandParamTypeAnnotation =
 | DoubleTypeAnnotation
 | FloatTypeAnnotation
 | StringTypeAnnotation
 | ComponentArrayTypeAnnotation;
 | ComponentCommandArrayTypeAnnotation;

export interface ReservedTypeAnnotation {
 readonly type: 'ReservedTypeAnnotation';
Expand Down

32 changes: 27 additions & 5 deletions
packages/react-native-codegen/src/CodegenSchema.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -158,6 +158,19 @@ export type ComponentArrayTypeAnnotation = ArrayTypeAnnotation<
 | ArrayTypeAnnotation<ObjectTypeAnnotation<PropTypeAnnotation>>,
>;

export type ComponentCommandArrayTypeAnnotation = ArrayTypeAnnotation<
 | BooleanTypeAnnotation
 | StringTypeAnnotation
 | DoubleTypeAnnotation
 | FloatTypeAnnotation
 | Int32TypeAnnotation
 // Mixed is not great. This generally means its a type alias to another type
 // like an object or union. Ideally we'd encode that type in the schema so the compat-check can
 // validate those deeper objects for breaking changes and the generators can do something smarter.
 // As of now, the generators just create ReadableMap or (const NSArray *) which are untyped
 | MixedTypeAnnotation,
>;

export type ArrayTypeAnnotation<+T> = $ReadOnly<{
 type: 'ArrayTypeAnnotation',
 elementType: T,
Expand DownExpand Up@@ -222,7 +235,7 @@ export type CommandParamTypeAnnotation =
 | DoubleTypeAnnotation
 | FloatTypeAnnotation
 | StringTypeAnnotation
 | ComponentArrayTypeAnnotation;
 | ComponentCommandArrayTypeAnnotation;

export type ReservedTypeAnnotation = $ReadOnly<{
 type: 'ReservedTypeAnnotation',
Expand DownExpand Up@@ -412,6 +425,14 @@ type NativeModuleReturnOnlyTypeAnnotation =
 | NativeModulePromiseTypeAnnotation
 | VoidTypeAnnotation;

// Add the allowed component reserved types to the native module union
export type CompleteReservedTypeAnnotation =
 | ReservedTypeAnnotation
 | {
 type: 'ReservedTypeAnnotation',
 name: ReservedPropTypeAnnotation['name'],
 };

// Used by compatibility check which needs to handle all possible types
// This will eventually also include the union of all view manager types
export type CompleteTypeAnnotation =
Expand All@@ -421,7 +442,8 @@ export type CompleteTypeAnnotation =
 | EventEmitterTypeAnnotation
 | NativeModuleEnumDeclarationWithMembers
 | UnsafeAnyTypeAnnotation
 // Native Module event emitters and methods
 | ObjectTypeAnnotation<
 Nullable<NativeModuleFunctionTypeAnnotation> | EventEmitterTypeAnnotation,
 >;
 | ArrayTypeAnnotation<CompleteTypeAnnotation>
 | ObjectTypeAnnotation<CompleteTypeAnnotation>
 // Components
 | CommandTypeAnnotation
 | CompleteReservedTypeAnnotation;

10 changes: 10 additions & 0 deletions
packages/react-native-codegen/src/generators/components/__test_fixtures__/fixtures.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1693,6 +1693,16 @@ const COMMANDS: SchemaType = {
 type: 'BooleanTypeAnnotation',
 },
 },
 {
 name: 'locations',
 optional: false,
 typeAnnotation: {
 type: 'ArrayTypeAnnotation',
 elementType: {
 type: 'MixedTypeAnnotation',
 },
 },
 },
 ],
 returnTypeAnnotation: {
 type: 'VoidTypeAnnotation',
Expand Down

16 changes: 12 additions & 4 deletions
...n/src/generators/components/__tests__/__snapshots__/GenerateComponentHObjCpp-test.js.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -119,7 +119,7 @@ NS_ASSUME_NONNULL_BEGIN

@protocol RCTCommandNativeComponentViewProtocol <NSObject>
- (void)flashScrollIndicators;
- (void)allTypes:(NSInteger)x y:(float)y z:(double)z message:(NSString *)message animated:(BOOL)animated;
- (void)allTypes:(NSInteger)x y:(float)y z:(double)z message:(NSString *)message animated:(BOOL)animated locations:(const NSArray *)locations;
@end

RCT_EXTERN inline void RCTCommandNativeComponentHandleCommand(
Expand All@@ -143,8 +143,8 @@ RCT_EXTERN inline void RCTCommandNativeComponentHandleCommand(

if ([commandName isEqualToString:@\\"allTypes\\"]) {
#if RCT_DEBUG
 if ([args count] != 5) {
 RCTLogError(@\\"%@ command %@ received %d arguments, expected %d.\\", @\\"CommandNativeComponent\\", commandName, (int)[args count], 5);
 if ([args count] != 6) {
 RCTLogError(@\\"%@ command %@ received %d arguments, expected %d.\\", @\\"CommandNativeComponent\\", commandName, (int)[args count], 6);
 return;
 }
#endif
Expand DownExpand Up@@ -189,7 +189,15 @@ NSObject *arg4 = args[4];
#endif
 BOOL animated = [(NSNumber *)arg4 boolValue];

 [componentView allTypes:x y:y z:z message:message animated:animated];
NSObject *arg5 = args[5];
#if RCT_DEBUG
 if (!RCTValidateTypeOfViewCommandArgument(arg5, [NSArray class], @\\"array\\", @\\"CommandNativeComponent\\", commandName, @\\"6th\\")) {
 return;
 }
#endif
 const NSArray * locations = (NSArray *)arg5;

 [componentView allTypes:x y:y z:z message:message animated:animated locations:locations];
 return;
}

Expand Down

2 changes: 1 addition & 1 deletion
.../src/generators/components/__tests__/__snapshots__/GeneratePropsJavaDelegate-test.js.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -224,7 +224,7 @@ public class CommandNativeComponentManagerDelegate<T extends View, U extends Bas
 mViewManager.flashScrollIndicators(view);
 break;
 case \\"allTypes\\":
 mViewManager.allTypes(view, args.getInt(0), (float) args.getDouble(1), args.getDouble(2), args.getString(3), args.getBoolean(4));
 mViewManager.allTypes(view, args.getInt(0), (float) args.getDouble(1), args.getDouble(2), args.getString(3), args.getBoolean(4), args.getArray(5));
 break;
 }
 }
Expand Down

3 changes: 2 additions & 1 deletion
...src/generators/components/__tests__/__snapshots__/GeneratePropsJavaInterface-test.js.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -118,11 +118,12 @@ Map {
package com.facebook.react.viewmanagers;

import android.view.View;
import com.facebook.react.bridge.ReadableArray;

public interface CommandNativeComponentManagerInterface<T extends View> {
 // No props
 void flashScrollIndicators(T view);
 void allTypes(T view, int x, float y, double z, String message, boolean animated);
 void allTypes(T view, int x, float y, double z, String message, boolean animated, ReadableArray locations);
}
",
}
Expand Down

4 changes: 2 additions & 2 deletions
...degen/src/generators/components/__tests__/__snapshots__/GenerateViewConfigJs-test.js.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -187,8 +187,8 @@ export const Commands = {
 dispatchCommand(ref, \\"flashScrollIndicators\\", []);
 },

 allTypes(ref, x, y, z, message, animated) {
 dispatchCommand(ref, \\"allTypes\\", [x, y, z, message, animated]);
 allTypes(ref, x, y, z, message, animated, locations) {
 dispatchCommand(ref, \\"allTypes\\", [x, y, z, message, animated, locations]);
 }
};
",
Expand Down

15 changes: 14 additions & 1 deletion
packages/react-native-codegen/src/parsers/flow/components/__test_fixtures__/fixtures.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -951,10 +951,18 @@ interface NativeCommands {
 z: Double,
 animated: boolean,
 ): void;
 +arrayArgs: (
 viewRef: React.ElementRef<NativeType>,
 booleanArray: $ReadOnlyArray<boolean>,
 stringArray: $ReadOnlyArray<string>,
 floatArray: $ReadOnlyArray<Float>,
 intArray: $ReadOnlyArray<Int32>,
 doubleArray: $ReadOnlyArray<Double>,
 ) => void;
}

export const Commands = codegenNativeCommands<NativeCommands>({
 supportedCommands: ['handleRootTag', 'hotspotUpdate', 'scrollTo'],
 supportedCommands: ['handleRootTag', 'hotspotUpdate', 'scrollTo', 'arrayArgs'],
});

export default (codegenNativeComponent<ModuleProps>(
Expand DownExpand Up@@ -985,6 +993,10 @@ import type {HostComponent} from 'react-native';
export type Boolean = boolean;
export type Int = Int32;
export type Void = void;
export type Locations = {
 x: number,
 y: number,
}

export type ModuleProps = $ReadOnly<{|
 ...ViewProps,
Expand All@@ -1006,6 +1018,7 @@ interface NativeCommands {
 overlayColorsReadOnly: $ReadOnlyArray<string>,
 overlayColorsArray: Array<string>,
 overlayColorsArrayAnnotation: string[],
 overlayLocations: $ReadOnlyArray<Locations>,
 ) => void;
}

Expand Down

72 changes: 72 additions & 0 deletions
...codegen/src/parsers/flow/components/__tests__/__snapshots__/component-parser-test.js.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1447,6 +1447,68 @@ exports[`RN Codegen Flow Parser can generate fixture COMMANDS_DEFINED_WITH_ALL_T
 'type': 'VoidTypeAnnotation'
 }
 }
 },
 {
 'name': 'arrayArgs',
 'optional': false,
 'typeAnnotation': {
 'type': 'FunctionTypeAnnotation',
 'params': [
 {
 'name': 'booleanArray',
 'optional': false,
 'typeAnnotation': {
 'type': 'ArrayTypeAnnotation',
 'elementType': {
 'type': 'BooleanTypeAnnotation'
 }
 }
 },
 {
 'name': 'stringArray',
 'optional': false,
 'typeAnnotation': {
 'type': 'ArrayTypeAnnotation',
 'elementType': {
 'type': 'StringTypeAnnotation'
 }
 }
 },
 {
 'name': 'floatArray',
 'optional': false,
 'typeAnnotation': {
 'type': 'ArrayTypeAnnotation',
 'elementType': {
 'type': 'FloatTypeAnnotation'
 }
 }
 },
 {
 'name': 'intArray',
 'optional': false,
 'typeAnnotation': {
 'type': 'ArrayTypeAnnotation',
 'elementType': {
 'type': 'Int32TypeAnnotation'
 }
 }
 },
 {
 'name': 'doubleArray',
 'optional': false,
 'typeAnnotation': {
 'type': 'ArrayTypeAnnotation',
 'elementType': {
 'type': 'DoubleTypeAnnotation'
 }
 }
 }
 ],
 'returnTypeAnnotation': {
 'type': 'VoidTypeAnnotation'
 }
 }
 }
 ]
 }
Expand DownExpand Up@@ -4826,6 +4888,16 @@ exports[`RN Codegen Flow Parser can generate fixture COMMANDS_WITH_EXTERNAL_TYPE
 'type': 'StringTypeAnnotation'
 }
 }
 },
 {
 'name': 'overlayLocations',
 'optional': false,
 'typeAnnotation': {
 'type': 'ArrayTypeAnnotation',
 'elementType': {
 'type': 'MixedTypeAnnotation'
 }
 }
 }
 ],
 'returnTypeAnnotation': {
Expand Down

73 changes: 65 additions & 8 deletions
packages/react-native-codegen/src/parsers/flow/components/commands.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@
import type {
 CommandParamTypeAnnotation,
 CommandTypeAnnotation,
 ComponentCommandArrayTypeAnnotation,
 NamedShape,
} from '../../../CodegenSchema.js';
import type {TypeDeclarationMap} from '../../utils';
Expand DownExpand Up@@ -109,19 +110,15 @@ function buildCommandSchema(
 }
 returnType = {
 type: 'ArrayTypeAnnotation',
 elementType: {
 // TODO: T172453752 support complex type annotation for array element
 type: paramValue.typeParameters.params[0].type,
 },
 elementType: getCommandArrayElementTypeType(
 paramValue.typeParameters.params[0],
 ),
 };
 break;
 case 'ArrayTypeAnnotation':
 returnType = {
 type: 'ArrayTypeAnnotation',
 elementType: {
 // TODO: T172453752 support complex type annotation for array element
 type: paramValue.elementType.type,
 },
 elementType: getCommandArrayElementTypeType(paramValue.elementType),
 };
 break;
 default:
Expand DownExpand Up@@ -151,6 +148,66 @@ function buildCommandSchema(
 };
}

type Allowed = ComponentCommandArrayTypeAnnotation['elementType'];

function getCommandArrayElementTypeType(inputType: mixed): Allowed {
 // TODO: T172453752 support more complex type annotation for array element
 if (typeof inputType !== 'object') {
 throw new Error('Expected an object');
 }

 const type = inputType?.type;

 if (inputType == null || typeof type !== 'string') {
 throw new Error('Command array element type must be a string');
 }

 switch (type) {
 case 'BooleanTypeAnnotation':
 return {
 type: 'BooleanTypeAnnotation',
 };
 case 'StringTypeAnnotation':
 return {
 type: 'StringTypeAnnotation',
 };
 case 'GenericTypeAnnotation':
 const name = typeof inputType.id === 'object' ? inputType.id?.name : null;

 if (typeof name !== 'string') {
 throw new Error(
 'Expected GenericTypeAnnotation AST name to be a string',
 );
 }

 switch (name) {
 case 'Int32':
 return {
 type: 'Int32TypeAnnotation',
 };
 case 'Float':
 return {
 type: 'FloatTypeAnnotation',
 };
 case 'Double':
 return {
 type: 'DoubleTypeAnnotation',
 };
 default:
 // This is not a great solution. This generally means its a type alias to another type
 // like an object or union. Ideally we'd encode that in the schema so the compat-check can
 // validate those deeper objects for breaking changes and the generators can do something smarter.
 // As of now, the generators just create ReadableMap or (const NSArray *) which are untyped
 return {
 type: 'MixedTypeAnnotation',
 };
 }

 default:
 throw new Error(`Unsupported array element type ${type}`);
 }
}

function getCommands(
 commandTypeAST: $ReadOnlyArray<EventTypeAST>,
 types: TypeDeclarationMap,
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Fixing schema types for component command params of Arrays#48476

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

elicwhite
wants to merge
5
commits into

from

 Closed


Fixing schema types for component command params of Arrays
#48476
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
abc7c4c

Make CompleteType contain module and component reserved names


elicwhite Jan 6, 2025
3eebf4d

Simplify CompleteTypeAnnotation


elicwhite Jan 6, 2025
2061343

Separate component array types and command array types


elicwhite Jan 6, 2025
a4f3bed

Add command type to CompleteTypeAnnotation


elicwhite Jan 6, 2025
e36140c

Fixing schema types for component command params of Arrays (#48476)


elicwhite Jan 7, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


15 changes: 14 additions & 1 deletion
packages/react-native-codegen/src/CodegenSchema.d.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -142,6 +142,19 @@ export type ComponentArrayTypeAnnotation = ArrayTypeAnnotation<
 | ArrayTypeAnnotation<ObjectTypeAnnotation<PropTypeAnnotation>>
>;

export type ComponentCommandArrayTypeAnnotation = ArrayTypeAnnotation<
 | BooleanTypeAnnotation
 | StringTypeAnnotation
 | DoubleTypeAnnotation
 | FloatTypeAnnotation
 | Int32TypeAnnotation
 // Mixed is not great. This generally means its a type alias to another type
 // like an object or union. Ideally we'd encode that type in the schema so the compat-check can
 // validate those deeper objects for breaking changes and the generators can do something smarter.
 // As of now, the generators just create ReadableMap or (const NSArray *) which are untyped
 | MixedTypeAnnotation
>;

export interface ArrayTypeAnnotation<T> {
 readonly type: 'ArrayTypeAnnotation';
 readonly elementType: T;
Expand DownExpand Up@@ -206,7 +219,7 @@ export type CommandParamTypeAnnotation =
 | DoubleTypeAnnotation
 | FloatTypeAnnotation
 | StringTypeAnnotation
 | ComponentArrayTypeAnnotation;
 | ComponentCommandArrayTypeAnnotation;

export interface ReservedTypeAnnotation {
 readonly type: 'ReservedTypeAnnotation';
Expand Down

32 changes: 27 additions & 5 deletions
packages/react-native-codegen/src/CodegenSchema.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -158,6 +158,19 @@ export type ComponentArrayTypeAnnotation = ArrayTypeAnnotation<
 | ArrayTypeAnnotation<ObjectTypeAnnotation<PropTypeAnnotation>>,
>;

export type ComponentCommandArrayTypeAnnotation = ArrayTypeAnnotation<
 | BooleanTypeAnnotation
 | StringTypeAnnotation
 | DoubleTypeAnnotation
 | FloatTypeAnnotation
 | Int32TypeAnnotation
 // Mixed is not great. This generally means its a type alias to another type
 // like an object or union. Ideally we'd encode that type in the schema so the compat-check can
 // validate those deeper objects for breaking changes and the generators can do something smarter.
 // As of now, the generators just create ReadableMap or (const NSArray *) which are untyped
 | MixedTypeAnnotation,
>;

export type ArrayTypeAnnotation<+T> = $ReadOnly<{
 type: 'ArrayTypeAnnotation',
 elementType: T,
Expand DownExpand Up@@ -222,7 +235,7 @@ export type CommandParamTypeAnnotation =
 | DoubleTypeAnnotation
 | FloatTypeAnnotation
 | StringTypeAnnotation
 | ComponentArrayTypeAnnotation;
 | ComponentCommandArrayTypeAnnotation;

export type ReservedTypeAnnotation = $ReadOnly<{
 type: 'ReservedTypeAnnotation',
Expand DownExpand Up@@ -412,6 +425,14 @@ type NativeModuleReturnOnlyTypeAnnotation =
 | NativeModulePromiseTypeAnnotation
 | VoidTypeAnnotation;

// Add the allowed component reserved types to the native module union
export type CompleteReservedTypeAnnotation =
 | ReservedTypeAnnotation
 | {
 type: 'ReservedTypeAnnotation',
 name: ReservedPropTypeAnnotation['name'],
 };

// Used by compatibility check which needs to handle all possible types
// This will eventually also include the union of all view manager types
export type CompleteTypeAnnotation =
Expand All@@ -421,7 +442,8 @@ export type CompleteTypeAnnotation =
 | EventEmitterTypeAnnotation
 | NativeModuleEnumDeclarationWithMembers
 | UnsafeAnyTypeAnnotation
 // Native Module event emitters and methods
 | ObjectTypeAnnotation<
 Nullable<NativeModuleFunctionTypeAnnotation> | EventEmitterTypeAnnotation,
 >;
 | ArrayTypeAnnotation<CompleteTypeAnnotation>
 | ObjectTypeAnnotation<CompleteTypeAnnotation>
 // Components
 | CommandTypeAnnotation
 | CompleteReservedTypeAnnotation;

10 changes: 10 additions & 0 deletions
packages/react-native-codegen/src/generators/components/__test_fixtures__/fixtures.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1693,6 +1693,16 @@ const COMMANDS: SchemaType = {
 type: 'BooleanTypeAnnotation',
 },
 },
 {
 name: 'locations',
 optional: false,
 typeAnnotation: {
 type: 'ArrayTypeAnnotation',
 elementType: {
 type: 'MixedTypeAnnotation',
 },
 },
 },
 ],
 returnTypeAnnotation: {
 type: 'VoidTypeAnnotation',
Expand Down

16 changes: 12 additions & 4 deletions
...n/src/generators/components/__tests__/__snapshots__/GenerateComponentHObjCpp-test.js.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -119,7 +119,7 @@ NS_ASSUME_NONNULL_BEGIN

@protocol RCTCommandNativeComponentViewProtocol <NSObject>
- (void)flashScrollIndicators;
- (void)allTypes:(NSInteger)x y:(float)y z:(double)z message:(NSString *)message animated:(BOOL)animated;
- (void)allTypes:(NSInteger)x y:(float)y z:(double)z message:(NSString *)message animated:(BOOL)animated locations:(const NSArray *)locations;
@end

RCT_EXTERN inline void RCTCommandNativeComponentHandleCommand(
Expand All@@ -143,8 +143,8 @@ RCT_EXTERN inline void RCTCommandNativeComponentHandleCommand(

if ([commandName isEqualToString:@\\"allTypes\\"]) {
#if RCT_DEBUG
 if ([args count] != 5) {
 RCTLogError(@\\"%@ command %@ received %d arguments, expected %d.\\", @\\"CommandNativeComponent\\", commandName, (int)[args count], 5);
 if ([args count] != 6) {
 RCTLogError(@\\"%@ command %@ received %d arguments, expected %d.\\", @\\"CommandNativeComponent\\", commandName, (int)[args count], 6);
 return;
 }
#endif
Expand DownExpand Up@@ -189,7 +189,15 @@ NSObject *arg4 = args[4];
#endif
 BOOL animated = [(NSNumber *)arg4 boolValue];

 [componentView allTypes:x y:y z:z message:message animated:animated];
NSObject *arg5 = args[5];
#if RCT_DEBUG
 if (!RCTValidateTypeOfViewCommandArgument(arg5, [NSArray class], @\\"array\\", @\\"CommandNativeComponent\\", commandName, @\\"6th\\")) {
 return;
 }
#endif
 const NSArray * locations = (NSArray *)arg5;

 [componentView allTypes:x y:y z:z message:message animated:animated locations:locations];
 return;
}

Expand Down

2 changes: 1 addition & 1 deletion
.../src/generators/components/__tests__/__snapshots__/GeneratePropsJavaDelegate-test.js.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -224,7 +224,7 @@ public class CommandNativeComponentManagerDelegate<T extends View, U extends Bas
 mViewManager.flashScrollIndicators(view);
 break;
 case \\"allTypes\\":
 mViewManager.allTypes(view, args.getInt(0), (float) args.getDouble(1), args.getDouble(2), args.getString(3), args.getBoolean(4));
 mViewManager.allTypes(view, args.getInt(0), (float) args.getDouble(1), args.getDouble(2), args.getString(3), args.getBoolean(4), args.getArray(5));
 break;
 }
 }
Expand Down

3 changes: 2 additions & 1 deletion
...src/generators/components/__tests__/__snapshots__/GeneratePropsJavaInterface-test.js.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -118,11 +118,12 @@ Map {
package com.facebook.react.viewmanagers;

import android.view.View;
import com.facebook.react.bridge.ReadableArray;

public interface CommandNativeComponentManagerInterface<T extends View> {
 // No props
 void flashScrollIndicators(T view);
 void allTypes(T view, int x, float y, double z, String message, boolean animated);
 void allTypes(T view, int x, float y, double z, String message, boolean animated, ReadableArray locations);
}
",
}
Expand Down

4 changes: 2 additions & 2 deletions
...degen/src/generators/components/__tests__/__snapshots__/GenerateViewConfigJs-test.js.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -187,8 +187,8 @@ export const Commands = {
 dispatchCommand(ref, \\"flashScrollIndicators\\", []);
 },

 allTypes(ref, x, y, z, message, animated) {
 dispatchCommand(ref, \\"allTypes\\", [x, y, z, message, animated]);
 allTypes(ref, x, y, z, message, animated, locations) {
 dispatchCommand(ref, \\"allTypes\\", [x, y, z, message, animated, locations]);
 }
};
",
Expand Down

15 changes: 14 additions & 1 deletion
packages/react-native-codegen/src/parsers/flow/components/__test_fixtures__/fixtures.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -951,10 +951,18 @@ interface NativeCommands {
 z: Double,
 animated: boolean,
 ): void;
 +arrayArgs: (
 viewRef: React.ElementRef<NativeType>,
 booleanArray: $ReadOnlyArray<boolean>,
 stringArray: $ReadOnlyArray<string>,
 floatArray: $ReadOnlyArray<Float>,
 intArray: $ReadOnlyArray<Int32>,
 doubleArray: $ReadOnlyArray<Double>,
 ) => void;
}

export const Commands = codegenNativeCommands<NativeCommands>({
 supportedCommands: ['handleRootTag', 'hotspotUpdate', 'scrollTo'],
 supportedCommands: ['handleRootTag', 'hotspotUpdate', 'scrollTo', 'arrayArgs'],
});

export default (codegenNativeComponent<ModuleProps>(
Expand DownExpand Up@@ -985,6 +993,10 @@ import type {HostComponent} from 'react-native';
export type Boolean = boolean;
export type Int = Int32;
export type Void = void;
export type Locations = {
 x: number,
 y: number,
}

export type ModuleProps = $ReadOnly<{|
 ...ViewProps,
Expand All@@ -1006,6 +1018,7 @@ interface NativeCommands {
 overlayColorsReadOnly: $ReadOnlyArray<string>,
 overlayColorsArray: Array<string>,
 overlayColorsArrayAnnotation: string[],
 overlayLocations: $ReadOnlyArray<Locations>,
 ) => void;
}

Expand Down

72 changes: 72 additions & 0 deletions
...codegen/src/parsers/flow/components/__tests__/__snapshots__/component-parser-test.js.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1447,6 +1447,68 @@ exports[`RN Codegen Flow Parser can generate fixture COMMANDS_DEFINED_WITH_ALL_T
 'type': 'VoidTypeAnnotation'
 }
 }
 },
 {
 'name': 'arrayArgs',
 'optional': false,
 'typeAnnotation': {
 'type': 'FunctionTypeAnnotation',
 'params': [
 {
 'name': 'booleanArray',
 'optional': false,
 'typeAnnotation': {
 'type': 'ArrayTypeAnnotation',
 'elementType': {
 'type': 'BooleanTypeAnnotation'
 }
 }
 },
 {
 'name': 'stringArray',
 'optional': false,
 'typeAnnotation': {
 'type': 'ArrayTypeAnnotation',
 'elementType': {
 'type': 'StringTypeAnnotation'
 }
 }
 },
 {
 'name': 'floatArray',
 'optional': false,
 'typeAnnotation': {
 'type': 'ArrayTypeAnnotation',
 'elementType': {
 'type': 'FloatTypeAnnotation'
 }
 }
 },
 {
 'name': 'intArray',
 'optional': false,
 'typeAnnotation': {
 'type': 'ArrayTypeAnnotation',
 'elementType': {
 'type': 'Int32TypeAnnotation'
 }
 }
 },
 {
 'name': 'doubleArray',
 'optional': false,
 'typeAnnotation': {
 'type': 'ArrayTypeAnnotation',
 'elementType': {
 'type': 'DoubleTypeAnnotation'
 }
 }
 }
 ],
 'returnTypeAnnotation': {
 'type': 'VoidTypeAnnotation'
 }
 }
 }
 ]
 }
Expand DownExpand Up@@ -4826,6 +4888,16 @@ exports[`RN Codegen Flow Parser can generate fixture COMMANDS_WITH_EXTERNAL_TYPE
 'type': 'StringTypeAnnotation'
 }
 }
 },
 {
 'name': 'overlayLocations',
 'optional': false,
 'typeAnnotation': {
 'type': 'ArrayTypeAnnotation',
 'elementType': {
 'type': 'MixedTypeAnnotation'
 }
 }
 }
 ],
 'returnTypeAnnotation': {
Expand Down

73 changes: 65 additions & 8 deletions
packages/react-native-codegen/src/parsers/flow/components/commands.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@
import type {
 CommandParamTypeAnnotation,
 CommandTypeAnnotation,
 ComponentCommandArrayTypeAnnotation,
 NamedShape,
} from '../../../CodegenSchema.js';
import type {TypeDeclarationMap} from '../../utils';
Expand DownExpand Up@@ -109,19 +110,15 @@ function buildCommandSchema(
 }
 returnType = {
 type: 'ArrayTypeAnnotation',
 elementType: {
 // TODO: T172453752 support complex type annotation for array element
 type: paramValue.typeParameters.params[0].type,
 },
 elementType: getCommandArrayElementTypeType(
 paramValue.typeParameters.params[0],
 ),
 };
 break;
 case 'ArrayTypeAnnotation':
 returnType = {
 type: 'ArrayTypeAnnotation',
 elementType: {
 // TODO: T172453752 support complex type annotation for array element
 type: paramValue.elementType.type,
 },
 elementType: getCommandArrayElementTypeType(paramValue.elementType),
 };
 break;
 default:
Expand DownExpand Up@@ -151,6 +148,66 @@ function buildCommandSchema(
 };
}

type Allowed = ComponentCommandArrayTypeAnnotation['elementType'];

function getCommandArrayElementTypeType(inputType: mixed): Allowed {
 // TODO: T172453752 support more complex type annotation for array element
 if (typeof inputType !== 'object') {
 throw new Error('Expected an object');
 }

 const type = inputType?.type;

 if (inputType == null || typeof type !== 'string') {
 throw new Error('Command array element type must be a string');
 }

 switch (type) {
 case 'BooleanTypeAnnotation':
 return {
 type: 'BooleanTypeAnnotation',
 };
 case 'StringTypeAnnotation':
 return {
 type: 'StringTypeAnnotation',
 };
 case 'GenericTypeAnnotation':
 const name = typeof inputType.id === 'object' ? inputType.id?.name : null;

 if (typeof name !== 'string') {
 throw new Error(
 'Expected GenericTypeAnnotation AST name to be a string',
 );
 }

 switch (name) {
 case 'Int32':
 return {
 type: 'Int32TypeAnnotation',
 };
 case 'Float':
 return {
 type: 'FloatTypeAnnotation',
 };
 case 'Double':
 return {
 type: 'DoubleTypeAnnotation',
 };
 default:
 // This is not a great solution. This generally means its a type alias to another type
 // like an object or union. Ideally we'd encode that in the schema so the compat-check can
 // validate those deeper objects for breaking changes and the generators can do something smarter.
 // As of now, the generators just create ReadableMap or (const NSArray *) which are untyped
 return {
 type: 'MixedTypeAnnotation',
 };
 }

 default:
 throw new Error(`Unsupported array element type ${type}`);
 }
}

function getCommands(
 commandTypeAST: $ReadOnlyArray<EventTypeAST>,
 types: TypeDeclarationMap,
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Fixing schema types for component command params of Arrays#48476

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

elicwhite
wants to merge
5
commits into

from

 Closed


Fixing schema types for component command params of Arrays
#48476
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
abc7c4c

Make CompleteType contain module and component reserved names


elicwhite Jan 6, 2025
3eebf4d

Simplify CompleteTypeAnnotation


elicwhite Jan 6, 2025
2061343

Separate component array types and command array types


elicwhite Jan 6, 2025
a4f3bed

Add command type to CompleteTypeAnnotation


elicwhite Jan 6, 2025
e36140c

Fixing schema types for component command params of Arrays (#48476)


elicwhite Jan 7, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


15 changes: 14 additions & 1 deletion
packages/react-native-codegen/src/CodegenSchema.d.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -142,6 +142,19 @@ export type ComponentArrayTypeAnnotation = ArrayTypeAnnotation<
 | ArrayTypeAnnotation<ObjectTypeAnnotation<PropTypeAnnotation>>
>;

export type ComponentCommandArrayTypeAnnotation = ArrayTypeAnnotation<
 | BooleanTypeAnnotation
 | StringTypeAnnotation
 | DoubleTypeAnnotation
 | FloatTypeAnnotation
 | Int32TypeAnnotation
 // Mixed is not great. This generally means its a type alias to another type
 // like an object or union. Ideally we'd encode that type in the schema so the compat-check can
 // validate those deeper objects for breaking changes and the generators can do something smarter.
 // As of now, the generators just create ReadableMap or (const NSArray *) which are untyped
 | MixedTypeAnnotation
>;

export interface ArrayTypeAnnotation<T> {
 readonly type: 'ArrayTypeAnnotation';
 readonly elementType: T;
Expand DownExpand Up@@ -206,7 +219,7 @@ export type CommandParamTypeAnnotation =
 | DoubleTypeAnnotation
 | FloatTypeAnnotation
 | StringTypeAnnotation
 | ComponentArrayTypeAnnotation;
 | ComponentCommandArrayTypeAnnotation;

export interface ReservedTypeAnnotation {
 readonly type: 'ReservedTypeAnnotation';
Expand Down

32 changes: 27 additions & 5 deletions
packages/react-native-codegen/src/CodegenSchema.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -158,6 +158,19 @@ export type ComponentArrayTypeAnnotation = ArrayTypeAnnotation<
 | ArrayTypeAnnotation<ObjectTypeAnnotation<PropTypeAnnotation>>,
>;

export type ComponentCommandArrayTypeAnnotation = ArrayTypeAnnotation<
 | BooleanTypeAnnotation
 | StringTypeAnnotation
 | DoubleTypeAnnotation
 | FloatTypeAnnotation
 | Int32TypeAnnotation
 // Mixed is not great. This generally means its a type alias to another type
 // like an object or union. Ideally we'd encode that type in the schema so the compat-check can
 // validate those deeper objects for breaking changes and the generators can do something smarter.
 // As of now, the generators just create ReadableMap or (const NSArray *) which are untyped
 | MixedTypeAnnotation,
>;

export type ArrayTypeAnnotation<+T> = $ReadOnly<{
 type: 'ArrayTypeAnnotation',
 elementType: T,
Expand DownExpand Up@@ -222,7 +235,7 @@ export type CommandParamTypeAnnotation =
 | DoubleTypeAnnotation
 | FloatTypeAnnotation
 | StringTypeAnnotation
 | ComponentArrayTypeAnnotation;
 | ComponentCommandArrayTypeAnnotation;

export type ReservedTypeAnnotation = $ReadOnly<{
 type: 'ReservedTypeAnnotation',
Expand DownExpand Up@@ -412,6 +425,14 @@ type NativeModuleReturnOnlyTypeAnnotation =
 | NativeModulePromiseTypeAnnotation
 | VoidTypeAnnotation;

// Add the allowed component reserved types to the native module union
export type CompleteReservedTypeAnnotation =
 | ReservedTypeAnnotation
 | {
 type: 'ReservedTypeAnnotation',
 name: ReservedPropTypeAnnotation['name'],
 };

// Used by compatibility check which needs to handle all possible types
// This will eventually also include the union of all view manager types
export type CompleteTypeAnnotation =
Expand All@@ -421,7 +442,8 @@ export type CompleteTypeAnnotation =
 | EventEmitterTypeAnnotation
 | NativeModuleEnumDeclarationWithMembers
 | UnsafeAnyTypeAnnotation
 // Native Module event emitters and methods
 | ObjectTypeAnnotation<
 Nullable<NativeModuleFunctionTypeAnnotation> | EventEmitterTypeAnnotation,
 >;
 | ArrayTypeAnnotation<CompleteTypeAnnotation>
 | ObjectTypeAnnotation<CompleteTypeAnnotation>
 // Components
 | CommandTypeAnnotation
 | CompleteReservedTypeAnnotation;

10 changes: 10 additions & 0 deletions
packages/react-native-codegen/src/generators/components/__test_fixtures__/fixtures.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1693,6 +1693,16 @@ const COMMANDS: SchemaType = {
 type: 'BooleanTypeAnnotation',
 },
 },
 {
 name: 'locations',
 optional: false,
 typeAnnotation: {
 type: 'ArrayTypeAnnotation',
 elementType: {
 type: 'MixedTypeAnnotation',
 },
 },
 },
 ],
 returnTypeAnnotation: {
 type: 'VoidTypeAnnotation',
Expand Down

16 changes: 12 additions & 4 deletions
...n/src/generators/components/__tests__/__snapshots__/GenerateComponentHObjCpp-test.js.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -119,7 +119,7 @@ NS_ASSUME_NONNULL_BEGIN

@protocol RCTCommandNativeComponentViewProtocol <NSObject>
- (void)flashScrollIndicators;
- (void)allTypes:(NSInteger)x y:(float)y z:(double)z message:(NSString *)message animated:(BOOL)animated;
- (void)allTypes:(NSInteger)x y:(float)y z:(double)z message:(NSString *)message animated:(BOOL)animated locations:(const NSArray *)locations;
@end

RCT_EXTERN inline void RCTCommandNativeComponentHandleCommand(
Expand All@@ -143,8 +143,8 @@ RCT_EXTERN inline void RCTCommandNativeComponentHandleCommand(

if ([commandName isEqualToString:@\\"allTypes\\"]) {
#if RCT_DEBUG
 if ([args count] != 5) {
 RCTLogError(@\\"%@ command %@ received %d arguments, expected %d.\\", @\\"CommandNativeComponent\\", commandName, (int)[args count], 5);
 if ([args count] != 6) {
 RCTLogError(@\\"%@ command %@ received %d arguments, expected %d.\\", @\\"CommandNativeComponent\\", commandName, (int)[args count], 6);
 return;
 }
#endif
Expand DownExpand Up@@ -189,7 +189,15 @@ NSObject *arg4 = args[4];
#endif
 BOOL animated = [(NSNumber *)arg4 boolValue];

 [componentView allTypes:x y:y z:z message:message animated:animated];
NSObject *arg5 = args[5];
#if RCT_DEBUG
 if (!RCTValidateTypeOfViewCommandArgument(arg5, [NSArray class], @\\"array\\", @\\"CommandNativeComponent\\", commandName, @\\"6th\\")) {
 return;
 }
#endif
 const NSArray * locations = (NSArray *)arg5;

 [componentView allTypes:x y:y z:z message:message animated:animated locations:locations];
 return;
}

Expand Down

2 changes: 1 addition & 1 deletion
.../src/generators/components/__tests__/__snapshots__/GeneratePropsJavaDelegate-test.js.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -224,7 +224,7 @@ public class CommandNativeComponentManagerDelegate<T extends View, U extends Bas
 mViewManager.flashScrollIndicators(view);
 break;
 case \\"allTypes\\":
 mViewManager.allTypes(view, args.getInt(0), (float) args.getDouble(1), args.getDouble(2), args.getString(3), args.getBoolean(4));
 mViewManager.allTypes(view, args.getInt(0), (float) args.getDouble(1), args.getDouble(2), args.getString(3), args.getBoolean(4), args.getArray(5));
 break;
 }
 }
Expand Down

3 changes: 2 additions & 1 deletion
...src/generators/components/__tests__/__snapshots__/GeneratePropsJavaInterface-test.js.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -118,11 +118,12 @@ Map {
package com.facebook.react.viewmanagers;

import android.view.View;
import com.facebook.react.bridge.ReadableArray;

public interface CommandNativeComponentManagerInterface<T extends View> {
 // No props
 void flashScrollIndicators(T view);
 void allTypes(T view, int x, float y, double z, String message, boolean animated);
 void allTypes(T view, int x, float y, double z, String message, boolean animated, ReadableArray locations);
}
",
}
Expand Down

4 changes: 2 additions & 2 deletions
...degen/src/generators/components/__tests__/__snapshots__/GenerateViewConfigJs-test.js.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -187,8 +187,8 @@ export const Commands = {
 dispatchCommand(ref, \\"flashScrollIndicators\\", []);
 },

 allTypes(ref, x, y, z, message, animated) {
 dispatchCommand(ref, \\"allTypes\\", [x, y, z, message, animated]);
 allTypes(ref, x, y, z, message, animated, locations) {
 dispatchCommand(ref, \\"allTypes\\", [x, y, z, message, animated, locations]);
 }
};
",
Expand Down

15 changes: 14 additions & 1 deletion
packages/react-native-codegen/src/parsers/flow/components/__test_fixtures__/fixtures.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -951,10 +951,18 @@ interface NativeCommands {
 z: Double,
 animated: boolean,
 ): void;
 +arrayArgs: (
 viewRef: React.ElementRef<NativeType>,
 booleanArray: $ReadOnlyArray<boolean>,
 stringArray: $ReadOnlyArray<string>,
 floatArray: $ReadOnlyArray<Float>,
 intArray: $ReadOnlyArray<Int32>,
 doubleArray: $ReadOnlyArray<Double>,
 ) => void;
}

export const Commands = codegenNativeCommands<NativeCommands>({
 supportedCommands: ['handleRootTag', 'hotspotUpdate', 'scrollTo'],
 supportedCommands: ['handleRootTag', 'hotspotUpdate', 'scrollTo', 'arrayArgs'],
});

export default (codegenNativeComponent<ModuleProps>(
Expand DownExpand Up@@ -985,6 +993,10 @@ import type {HostComponent} from 'react-native';
export type Boolean = boolean;
export type Int = Int32;
export type Void = void;
export type Locations = {
 x: number,
 y: number,
}

export type ModuleProps = $ReadOnly<{|
 ...ViewProps,
Expand All@@ -1006,6 +1018,7 @@ interface NativeCommands {
 overlayColorsReadOnly: $ReadOnlyArray<string>,
 overlayColorsArray: Array<string>,
 overlayColorsArrayAnnotation: string[],
 overlayLocations: $ReadOnlyArray<Locations>,
 ) => void;
}

Expand Down

72 changes: 72 additions & 0 deletions
...codegen/src/parsers/flow/components/__tests__/__snapshots__/component-parser-test.js.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1447,6 +1447,68 @@ exports[`RN Codegen Flow Parser can generate fixture COMMANDS_DEFINED_WITH_ALL_T
 'type': 'VoidTypeAnnotation'
 }
 }
 },
 {
 'name': 'arrayArgs',
 'optional': false,
 'typeAnnotation': {
 'type': 'FunctionTypeAnnotation',
 'params': [
 {
 'name': 'booleanArray',
 'optional': false,
 'typeAnnotation': {
 'type': 'ArrayTypeAnnotation',
 'elementType': {
 'type': 'BooleanTypeAnnotation'
 }
 }
 },
 {
 'name': 'stringArray',
 'optional': false,
 'typeAnnotation': {
 'type': 'ArrayTypeAnnotation',
 'elementType': {
 'type': 'StringTypeAnnotation'
 }
 }
 },
 {
 'name': 'floatArray',
 'optional': false,
 'typeAnnotation': {
 'type': 'ArrayTypeAnnotation',
 'elementType': {
 'type': 'FloatTypeAnnotation'
 }
 }
 },
 {
 'name': 'intArray',
 'optional': false,
 'typeAnnotation': {
 'type': 'ArrayTypeAnnotation',
 'elementType': {
 'type': 'Int32TypeAnnotation'
 }
 }
 },
 {
 'name': 'doubleArray',
 'optional': false,
 'typeAnnotation': {
 'type': 'ArrayTypeAnnotation',
 'elementType': {
 'type': 'DoubleTypeAnnotation'
 }
 }
 }
 ],
 'returnTypeAnnotation': {
 'type': 'VoidTypeAnnotation'
 }
 }
 }
 ]
 }
Expand DownExpand Up@@ -4826,6 +4888,16 @@ exports[`RN Codegen Flow Parser can generate fixture COMMANDS_WITH_EXTERNAL_TYPE
 'type': 'StringTypeAnnotation'
 }
 }
 },
 {
 'name': 'overlayLocations',
 'optional': false,
 'typeAnnotation': {
 'type': 'ArrayTypeAnnotation',
 'elementType': {
 'type': 'MixedTypeAnnotation'
 }
 }
 }
 ],
 'returnTypeAnnotation': {
Expand Down

73 changes: 65 additions & 8 deletions
packages/react-native-codegen/src/parsers/flow/components/commands.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@
import type {
 CommandParamTypeAnnotation,
 CommandTypeAnnotation,
 ComponentCommandArrayTypeAnnotation,
 NamedShape,
} from '../../../CodegenSchema.js';
import type {TypeDeclarationMap} from '../../utils';
Expand DownExpand Up@@ -109,19 +110,15 @@ function buildCommandSchema(
 }
 returnType = {
 type: 'ArrayTypeAnnotation',
 elementType: {
 // TODO: T172453752 support complex type annotation for array element
 type: paramValue.typeParameters.params[0].type,
 },
 elementType: getCommandArrayElementTypeType(
 paramValue.typeParameters.params[0],
 ),
 };
 break;
 case 'ArrayTypeAnnotation':
 returnType = {
 type: 'ArrayTypeAnnotation',
 elementType: {
 // TODO: T172453752 support complex type annotation for array element
 type: paramValue.elementType.type,
 },
 elementType: getCommandArrayElementTypeType(paramValue.elementType),
 };
 break;
 default:
Expand DownExpand Up@@ -151,6 +148,66 @@ function buildCommandSchema(
 };
}

type Allowed = ComponentCommandArrayTypeAnnotation['elementType'];

function getCommandArrayElementTypeType(inputType: mixed): Allowed {
 // TODO: T172453752 support more complex type annotation for array element
 if (typeof inputType !== 'object') {
 throw new Error('Expected an object');
 }

 const type = inputType?.type;

 if (inputType == null || typeof type !== 'string') {
 throw new Error('Command array element type must be a string');
 }

 switch (type) {
 case 'BooleanTypeAnnotation':
 return {
 type: 'BooleanTypeAnnotation',
 };
 case 'StringTypeAnnotation':
 return {
 type: 'StringTypeAnnotation',
 };
 case 'GenericTypeAnnotation':
 const name = typeof inputType.id === 'object' ? inputType.id?.name : null;

 if (typeof name !== 'string') {
 throw new Error(
 'Expected GenericTypeAnnotation AST name to be a string',
 );
 }

 switch (name) {
 case 'Int32':
 return {
 type: 'Int32TypeAnnotation',
 };
 case 'Float':
 return {
 type: 'FloatTypeAnnotation',
 };
 case 'Double':
 return {
 type: 'DoubleTypeAnnotation',
 };
 default:
 // This is not a great solution. This generally means its a type alias to another type
 // like an object or union. Ideally we'd encode that in the schema so the compat-check can
 // validate those deeper objects for breaking changes and the generators can do something smarter.
 // As of now, the generators just create ReadableMap or (const NSArray *) which are untyped
 return {
 type: 'MixedTypeAnnotation',
 };
 }

 default:
 throw new Error(`Unsupported array element type ${type}`);
 }
}

function getCommands(
 commandTypeAST: $ReadOnlyArray<EventTypeAST>,
 types: TypeDeclarationMap,
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
Fixing schema types for component command params of Arrays#48476

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

elicwhite
wants to merge
5
commits into

from

 Closed


Fixing schema types for component command params of Arrays
#48476
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
abc7c4c

Make CompleteType contain module and component reserved names


elicwhite Jan 6, 2025
3eebf4d

Simplify CompleteTypeAnnotation


elicwhite Jan 6, 2025
2061343

Separate component array types and command array types


elicwhite Jan 6, 2025
a4f3bed

Add command type to CompleteTypeAnnotation


elicwhite Jan 6, 2025
e36140c

Fixing schema types for component command params of Arrays (#48476)


elicwhite Jan 7, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


15 changes: 14 additions & 1 deletion
packages/react-native-codegen/src/CodegenSchema.d.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -142,6 +142,19 @@ export type ComponentArrayTypeAnnotation = ArrayTypeAnnotation<
 | ArrayTypeAnnotation<ObjectTypeAnnotation<PropTypeAnnotation>>
>;

export type ComponentCommandArrayTypeAnnotation = ArrayTypeAnnotation<
 | BooleanTypeAnnotation
 | StringTypeAnnotation
 | DoubleTypeAnnotation
 | FloatTypeAnnotation
 | Int32TypeAnnotation
 // Mixed is not great. This generally means its a type alias to another type
 // like an object or union. Ideally we'd encode that type in the schema so the compat-check can
 // validate those deeper objects for breaking changes and the generators can do something smarter.
 // As of now, the generators just create ReadableMap or (const NSArray *) which are untyped
 | MixedTypeAnnotation
>;

export interface ArrayTypeAnnotation<T> {
 readonly type: 'ArrayTypeAnnotation';
 readonly elementType: T;
Expand DownExpand Up@@ -206,7 +219,7 @@ export type CommandParamTypeAnnotation =
 | DoubleTypeAnnotation
 | FloatTypeAnnotation
 | StringTypeAnnotation
 | ComponentArrayTypeAnnotation;
 | ComponentCommandArrayTypeAnnotation;

export interface ReservedTypeAnnotation {
 readonly type: 'ReservedTypeAnnotation';
Expand Down

32 changes: 27 additions & 5 deletions
packages/react-native-codegen/src/CodegenSchema.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -158,6 +158,19 @@ export type ComponentArrayTypeAnnotation = ArrayTypeAnnotation<
 | ArrayTypeAnnotation<ObjectTypeAnnotation<PropTypeAnnotation>>,
>;

export type ComponentCommandArrayTypeAnnotation = ArrayTypeAnnotation<
 | BooleanTypeAnnotation
 | StringTypeAnnotation
 | DoubleTypeAnnotation
 | FloatTypeAnnotation
 | Int32TypeAnnotation
 // Mixed is not great. This generally means its a type alias to another type
 // like an object or union. Ideally we'd encode that type in the schema so the compat-check can
 // validate those deeper objects for breaking changes and the generators can do something smarter.
 // As of now, the generators just create ReadableMap or (const NSArray *) which are untyped
 | MixedTypeAnnotation,
>;

export type ArrayTypeAnnotation<+T> = $ReadOnly<{
 type: 'ArrayTypeAnnotation',
 elementType: T,
Expand DownExpand Up@@ -222,7 +235,7 @@ export type CommandParamTypeAnnotation =
 | DoubleTypeAnnotation
 | FloatTypeAnnotation
 | StringTypeAnnotation
 | ComponentArrayTypeAnnotation;
 | ComponentCommandArrayTypeAnnotation;

export type ReservedTypeAnnotation = $ReadOnly<{
 type: 'ReservedTypeAnnotation',
Expand DownExpand Up@@ -412,6 +425,14 @@ type NativeModuleReturnOnlyTypeAnnotation =
 | NativeModulePromiseTypeAnnotation
 | VoidTypeAnnotation;

// Add the allowed component reserved types to the native module union
export type CompleteReservedTypeAnnotation =
 | ReservedTypeAnnotation
 | {
 type: 'ReservedTypeAnnotation',
 name: ReservedPropTypeAnnotation['name'],
 };

// Used by compatibility check which needs to handle all possible types
// This will eventually also include the union of all view manager types
export type CompleteTypeAnnotation =
Expand All@@ -421,7 +442,8 @@ export type CompleteTypeAnnotation =
 | EventEmitterTypeAnnotation
 | NativeModuleEnumDeclarationWithMembers
 | UnsafeAnyTypeAnnotation
 // Native Module event emitters and methods
 | ObjectTypeAnnotation<
 Nullable<NativeModuleFunctionTypeAnnotation> | EventEmitterTypeAnnotation,
 >;
 | ArrayTypeAnnotation<CompleteTypeAnnotation>
 | ObjectTypeAnnotation<CompleteTypeAnnotation>
 // Components
 | CommandTypeAnnotation
 | CompleteReservedTypeAnnotation;

10 changes: 10 additions & 0 deletions
packages/react-native-codegen/src/generators/components/__test_fixtures__/fixtures.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1693,6 +1693,16 @@ const COMMANDS: SchemaType = {
 type: 'BooleanTypeAnnotation',
 },
 },
 {
 name: 'locations',
 optional: false,
 typeAnnotation: {
 type: 'ArrayTypeAnnotation',
 elementType: {
 type: 'MixedTypeAnnotation',
 },
 },
 },
 ],
 returnTypeAnnotation: {
 type: 'VoidTypeAnnotation',
Expand Down

16 changes: 12 additions & 4 deletions
...n/src/generators/components/__tests__/__snapshots__/GenerateComponentHObjCpp-test.js.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -119,7 +119,7 @@ NS_ASSUME_NONNULL_BEGIN

@protocol RCTCommandNativeComponentViewProtocol <NSObject>
- (void)flashScrollIndicators;
- (void)allTypes:(NSInteger)x y:(float)y z:(double)z message:(NSString *)message animated:(BOOL)animated;
- (void)allTypes:(NSInteger)x y:(float)y z:(double)z message:(NSString *)message animated:(BOOL)animated locations:(const NSArray *)locations;
@end

RCT_EXTERN inline void RCTCommandNativeComponentHandleCommand(
Expand All@@ -143,8 +143,8 @@ RCT_EXTERN inline void RCTCommandNativeComponentHandleCommand(

if ([commandName isEqualToString:@\\"allTypes\\"]) {
#if RCT_DEBUG
 if ([args count] != 5) {
 RCTLogError(@\\"%@ command %@ received %d arguments, expected %d.\\", @\\"CommandNativeComponent\\", commandName, (int)[args count], 5);
 if ([args count] != 6) {
 RCTLogError(@\\"%@ command %@ received %d arguments, expected %d.\\", @\\"CommandNativeComponent\\", commandName, (int)[args count], 6);
 return;
 }
#endif
Expand DownExpand Up@@ -189,7 +189,15 @@ NSObject *arg4 = args[4];
#endif
 BOOL animated = [(NSNumber *)arg4 boolValue];

 [componentView allTypes:x y:y z:z message:message animated:animated];
NSObject *arg5 = args[5];
#if RCT_DEBUG
 if (!RCTValidateTypeOfViewCommandArgument(arg5, [NSArray class], @\\"array\\", @\\"CommandNativeComponent\\", commandName, @\\"6th\\")) {
 return;
 }
#endif
 const NSArray * locations = (NSArray *)arg5;

 [componentView allTypes:x y:y z:z message:message animated:animated locations:locations];
 return;
}

Expand Down

2 changes: 1 addition & 1 deletion
.../src/generators/components/__tests__/__snapshots__/GeneratePropsJavaDelegate-test.js.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -224,7 +224,7 @@ public class CommandNativeComponentManagerDelegate<T extends View, U extends Bas
 mViewManager.flashScrollIndicators(view);
 break;
 case \\"allTypes\\":
 mViewManager.allTypes(view, args.getInt(0), (float) args.getDouble(1), args.getDouble(2), args.getString(3), args.getBoolean(4));
 mViewManager.allTypes(view, args.getInt(0), (float) args.getDouble(1), args.getDouble(2), args.getString(3), args.getBoolean(4), args.getArray(5));
 break;
 }
 }
Expand Down

3 changes: 2 additions & 1 deletion
...src/generators/components/__tests__/__snapshots__/GeneratePropsJavaInterface-test.js.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -118,11 +118,12 @@ Map {
package com.facebook.react.viewmanagers;

import android.view.View;
import com.facebook.react.bridge.ReadableArray;

public interface CommandNativeComponentManagerInterface<T extends View> {
 // No props
 void flashScrollIndicators(T view);
 void allTypes(T view, int x, float y, double z, String message, boolean animated);
 void allTypes(T view, int x, float y, double z, String message, boolean animated, ReadableArray locations);
}
",
}
Expand Down

4 changes: 2 additions & 2 deletions
...degen/src/generators/components/__tests__/__snapshots__/GenerateViewConfigJs-test.js.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -187,8 +187,8 @@ export const Commands = {
 dispatchCommand(ref, \\"flashScrollIndicators\\", []);
 },

 allTypes(ref, x, y, z, message, animated) {
 dispatchCommand(ref, \\"allTypes\\", [x, y, z, message, animated]);
 allTypes(ref, x, y, z, message, animated, locations) {
 dispatchCommand(ref, \\"allTypes\\", [x, y, z, message, animated, locations]);
 }
};
",
Expand Down

15 changes: 14 additions & 1 deletion
packages/react-native-codegen/src/parsers/flow/components/__test_fixtures__/fixtures.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -951,10 +951,18 @@ interface NativeCommands {
 z: Double,
 animated: boolean,
 ): void;
 +arrayArgs: (
 viewRef: React.ElementRef<NativeType>,
 booleanArray: $ReadOnlyArray<boolean>,
 stringArray: $ReadOnlyArray<string>,
 floatArray: $ReadOnlyArray<Float>,
 intArray: $ReadOnlyArray<Int32>,
 doubleArray: $ReadOnlyArray<Double>,
 ) => void;
}

export const Commands = codegenNativeCommands<NativeCommands>({
 supportedCommands: ['handleRootTag', 'hotspotUpdate', 'scrollTo'],
 supportedCommands: ['handleRootTag', 'hotspotUpdate', 'scrollTo', 'arrayArgs'],
});

export default (codegenNativeComponent<ModuleProps>(
Expand DownExpand Up@@ -985,6 +993,10 @@ import type {HostComponent} from 'react-native';
export type Boolean = boolean;
export type Int = Int32;
export type Void = void;
export type Locations = {
 x: number,
 y: number,
}

export type ModuleProps = $ReadOnly<{|
 ...ViewProps,
Expand All@@ -1006,6 +1018,7 @@ interface NativeCommands {
 overlayColorsReadOnly: $ReadOnlyArray<string>,
 overlayColorsArray: Array<string>,
 overlayColorsArrayAnnotation: string[],
 overlayLocations: $ReadOnlyArray<Locations>,
 ) => void;
}

Expand Down

72 changes: 72 additions & 0 deletions
...codegen/src/parsers/flow/components/__tests__/__snapshots__/component-parser-test.js.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1447,6 +1447,68 @@ exports[`RN Codegen Flow Parser can generate fixture COMMANDS_DEFINED_WITH_ALL_T
 'type': 'VoidTypeAnnotation'
 }
 }
 },
 {
 'name': 'arrayArgs',
 'optional': false,
 'typeAnnotation': {
 'type': 'FunctionTypeAnnotation',
 'params': [
 {
 'name': 'booleanArray',
 'optional': false,
 'typeAnnotation': {
 'type': 'ArrayTypeAnnotation',
 'elementType': {
 'type': 'BooleanTypeAnnotation'
 }
 }
 },
 {
 'name': 'stringArray',
 'optional': false,
 'typeAnnotation': {
 'type': 'ArrayTypeAnnotation',
 'elementType': {
 'type': 'StringTypeAnnotation'
 }
 }
 },
 {
 'name': 'floatArray',
 'optional': false,
 'typeAnnotation': {
 'type': 'ArrayTypeAnnotation',
 'elementType': {
 'type': 'FloatTypeAnnotation'
 }
 }
 },
 {
 'name': 'intArray',
 'optional': false,
 'typeAnnotation': {
 'type': 'ArrayTypeAnnotation',
 'elementType': {
 'type': 'Int32TypeAnnotation'
 }
 }
 },
 {
 'name': 'doubleArray',
 'optional': false,
 'typeAnnotation': {
 'type': 'ArrayTypeAnnotation',
 'elementType': {
 'type': 'DoubleTypeAnnotation'
 }
 }
 }
 ],
 'returnTypeAnnotation': {
 'type': 'VoidTypeAnnotation'
 }
 }
 }
 ]
 }
Expand DownExpand Up@@ -4826,6 +4888,16 @@ exports[`RN Codegen Flow Parser can generate fixture COMMANDS_WITH_EXTERNAL_TYPE
 'type': 'StringTypeAnnotation'
 }
 }
 },
 {
 'name': 'overlayLocations',
 'optional': false,
 'typeAnnotation': {
 'type': 'ArrayTypeAnnotation',
 'elementType': {
 'type': 'MixedTypeAnnotation'
 }
 }
 }
 ],
 'returnTypeAnnotation': {
Expand Down

73 changes: 65 additions & 8 deletions
packages/react-native-codegen/src/parsers/flow/components/commands.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@
import type {
 CommandParamTypeAnnotation,
 CommandTypeAnnotation,
 ComponentCommandArrayTypeAnnotation,
 NamedShape,
} from '../../../CodegenSchema.js';
import type {TypeDeclarationMap} from '../../utils';
Expand DownExpand Up@@ -109,19 +110,15 @@ function buildCommandSchema(
 }
 returnType = {
 type: 'ArrayTypeAnnotation',
 elementType: {
 // TODO: T172453752 support complex type annotation for array element
 type: paramValue.typeParameters.params[0].type,
 },
 elementType: getCommandArrayElementTypeType(
 paramValue.typeParameters.params[0],
 ),
 };
 break;
 case 'ArrayTypeAnnotation':
 returnType = {
 type: 'ArrayTypeAnnotation',
 elementType: {
 // TODO: T172453752 support complex type annotation for array element
 type: paramValue.elementType.type,
 },
 elementType: getCommandArrayElementTypeType(paramValue.elementType),
 };
 break;
 default:
Expand DownExpand Up@@ -151,6 +148,66 @@ function buildCommandSchema(
 };
}

type Allowed = ComponentCommandArrayTypeAnnotation['elementType'];

function getCommandArrayElementTypeType(inputType: mixed): Allowed {
 // TODO: T172453752 support more complex type annotation for array element
 if (typeof inputType !== 'object') {
 throw new Error('Expected an object');
 }

 const type = inputType?.type;

 if (inputType == null || typeof type !== 'string') {
 throw new Error('Command array element type must be a string');
 }

 switch (type) {
 case 'BooleanTypeAnnotation':
 return {
 type: 'BooleanTypeAnnotation',
 };
 case 'StringTypeAnnotation':
 return {
 type: 'StringTypeAnnotation',
 };
 case 'GenericTypeAnnotation':
 const name = typeof inputType.id === 'object' ? inputType.id?.name : null;

 if (typeof name !== 'string') {
 throw new Error(
 'Expected GenericTypeAnnotation AST name to be a string',
 );
 }

 switch (name) {
 case 'Int32':
 return {
 type: 'Int32TypeAnnotation',
 };
 case 'Float':
 return {
 type: 'FloatTypeAnnotation',
 };
 case 'Double':
 return {
 type: 'DoubleTypeAnnotation',
 };
 default:
 // This is not a great solution. This generally means its a type alias to another type
 // like an object or union. Ideally we'd encode that in the schema so the compat-check can
 // validate those deeper objects for breaking changes and the generators can do something smarter.
 // As of now, the generators just create ReadableMap or (const NSArray *) which are untyped
 return {
 type: 'MixedTypeAnnotation',
 };
 }

 default:
 throw new Error(`Unsupported array element type ${type}`);
 }
}

function getCommands(
 commandTypeAST: $ReadOnlyArray<EventTypeAST>,
 types: TypeDeclarationMap,
Expand Down
Loading