@react-native/codegen 0.75.0-nightly-20240527-c207708c4 → 0.75.0-nightly-20240529-5fbebb485

package/lib/CodegenSchema.d.ts

@@ -15,6 +15,9 @@ export interface SchemaType {
   };
 }
 
+/**
+ * Component Type Annotations
+ */
 export interface DoubleTypeAnnotation {
   readonly type: 'DoubleTypeAnnotation';
 }
@@ -47,6 +50,7 @@ export interface VoidTypeAnnotation {
 export interface ObjectTypeAnnotation<T> {
   readonly type: 'ObjectTypeAnnotation';
   readonly properties: readonly NamedShape<T>[];
+  // metadata for objects that generated from interfaces
   readonly baseTypes?: readonly string[] | undefined;
 }
 
@@ -83,8 +87,13 @@ export interface ComponentShape extends OptionsShape {
 
 export interface OptionsShape {
   readonly interfaceOnly?: boolean | undefined;
+  // Use for components with no current paper rename in progress
+  // Does not check for new name
   readonly paperComponentName?: string | undefined;
+  // Use for components that are not used on other platforms.
   readonly excludedPlatforms?: readonly PlatformType[] | undefined;
+  // Use for components currently being renamed in paper
+  // Will use new name if it is available and fallback to this name
   readonly paperComponentNameDeprecated?: string | undefined;
 }
 
@@ -112,6 +121,7 @@ export type EventTypeAnnotation =
   | DoubleTypeAnnotation
   | FloatTypeAnnotation
   | Int32TypeAnnotation
+  | MixedTypeAnnotation
   | StringEnumTypeAnnotation
   | ObjectTypeAnnotation<EventTypeAnnotation>
   | {
@@ -119,18 +129,35 @@ export type EventTypeAnnotation =
     readonly elementType: EventTypeAnnotation
   };
 
+export type ArrayTypeAnnotation = {
+  readonly type: 'ArrayTypeAnnotation';
+  readonly elementType:
+    | BooleanTypeAnnotation
+    | StringTypeAnnotation
+    | DoubleTypeAnnotation
+    | FloatTypeAnnotation
+    | Int32TypeAnnotation
+    | {
+        readonly type: 'StringEnumTypeAnnotation';
+        readonly default: string;
+        readonly options: readonly string[];
+      }
+    | ObjectTypeAnnotation<PropTypeAnnotation>
+    | ReservedPropTypeAnnotation
+    | {
+        readonly type: 'ArrayTypeAnnotation';
+        readonly elementType: ObjectTypeAnnotation<PropTypeAnnotation>;
+      };
+}
+
 export type PropTypeAnnotation =
   | {
       readonly type: 'BooleanTypeAnnotation';
-      readonly default:
-        | boolean
-        | null;
+      readonly default: boolean | null;
     }
   | {
       readonly type: 'StringTypeAnnotation';
-      readonly default:
-        | string
-        | null;
+      readonly default: string | null;
     }
   | {
       readonly type: 'DoubleTypeAnnotation';
@@ -138,9 +165,7 @@ export type PropTypeAnnotation =
     }
   | {
       readonly type: 'FloatTypeAnnotation';
-      readonly default:
-        | number
-        | null;
+      readonly default: number | null;
     }
   | {
       readonly type: 'Int32TypeAnnotation';
@@ -158,26 +183,7 @@ export type PropTypeAnnotation =
     }
   | ReservedPropTypeAnnotation
   | ObjectTypeAnnotation<PropTypeAnnotation>
-  | {
-      readonly type: 'ArrayTypeAnnotation';
-      readonly elementType:
-        | BooleanTypeAnnotation
-        | StringTypeAnnotation
-        | DoubleTypeAnnotation
-        | FloatTypeAnnotation
-        | Int32TypeAnnotation
-        | {
-            readonly type: 'StringEnumTypeAnnotation';
-            readonly default: string;
-            readonly options: readonly string[];
-          }
-        | ObjectTypeAnnotation<PropTypeAnnotation>
-        | ReservedPropTypeAnnotation
-        | {
-            readonly type: 'ArrayTypeAnnotation';
-            readonly elementType: ObjectTypeAnnotation<PropTypeAnnotation>;
-          };
-    }
+  | ArrayTypeAnnotation
   | MixedTypeAnnotation;
 
 export interface ReservedPropTypeAnnotation {
@@ -191,7 +197,10 @@ export interface ReservedPropTypeAnnotation {
     | 'DimensionPrimitive';
 }
 
-export type CommandTypeAnnotation = FunctionTypeAnnotation<CommandParamTypeAnnotation, VoidTypeAnnotation>;
+export type CommandTypeAnnotation = FunctionTypeAnnotation<
+  CommandParamTypeAnnotation,
+  VoidTypeAnnotation
+>;
 
 export type CommandParamTypeAnnotation =
   | ReservedTypeAnnotation
@@ -200,21 +209,16 @@ export type CommandParamTypeAnnotation =
   | DoubleTypeAnnotation
   | FloatTypeAnnotation
   | StringTypeAnnotation
-  | {
-    readonly type: 'ArrayTypeAnnotation';
-    readonly elementType:
-    | Int32TypeAnnotation
-    | DoubleTypeAnnotation
-    | FloatTypeAnnotation
-    | BooleanTypeAnnotation
-    | StringTypeAnnotation
-  };
+  | ArrayTypeAnnotation;
 
 export interface ReservedTypeAnnotation {
   readonly type: 'ReservedTypeAnnotation';
-  readonly name: 'RootTag';
+  readonly name: 'RootTag'; // Union with more custom types.
 }
 
+/**
+ * NativeModule Types
+ */
 export type Nullable<T extends NativeModuleTypeAnnotation> =
   | NullableTypeAnnotation<T>
   | T;
@@ -230,6 +234,9 @@ export interface NativeModuleSchema {
   readonly enumMap: NativeModuleEnumMap;
   readonly spec: NativeModuleSpec;
   readonly moduleName: string;
+  // Use for modules that are not used on other platforms.
+  // TODO: It's clearer to define `restrictedToPlatforms` instead, but
+  // `excludedPlatforms` is used here to be consistent with ComponentSchema.
   readonly excludedPlatforms?: readonly PlatformType[] | undefined;
 }
 
@@ -237,7 +244,9 @@ export interface NativeModuleSpec {
   readonly properties: readonly NativeModulePropertyShape[];
 }
 
-export type NativeModulePropertyShape = NamedShape<Nullable<NativeModuleFunctionTypeAnnotation>>;
+export type NativeModulePropertyShape = NamedShape<
+  Nullable<NativeModuleFunctionTypeAnnotation>
+>;
 
 export interface NativeModuleEnumMap {
   readonly [enumName: string]: NativeModuleEnumDeclarationWithMembers;
@@ -247,12 +256,21 @@ export interface NativeModuleAliasMap {
   readonly [aliasName: string]: NativeModuleObjectTypeAnnotation;
 }
 
-export type NativeModuleFunctionTypeAnnotation = FunctionTypeAnnotation<Nullable<NativeModuleParamTypeAnnotation>, Nullable<NativeModuleReturnTypeAnnotation>>;
+export type NativeModuleFunctionTypeAnnotation = FunctionTypeAnnotation<
+  Nullable<NativeModuleParamTypeAnnotation>,
+  Nullable<NativeModuleReturnTypeAnnotation>
+>;
 
-export type NativeModuleObjectTypeAnnotation = ObjectTypeAnnotation<Nullable<NativeModuleBaseTypeAnnotation>>;
+export type NativeModuleObjectTypeAnnotation = ObjectTypeAnnotation<
+  Nullable<NativeModuleBaseTypeAnnotation>
+>;
 
 export interface NativeModuleArrayTypeAnnotation<T extends Nullable<NativeModuleBaseTypeAnnotation>> {
   readonly type: 'ArrayTypeAnnotation';
+  /**
+   * TODO(T72031674): Migrate all our NativeModule specs to not use
+   * invalid Array ElementTypes. Then, make the elementType required.
+   */
   readonly elementType?: T | undefined;
 }
 
@@ -304,6 +322,9 @@ export interface NativeModuleEnumDeclarationWithMembers {
 
 export interface NativeModuleGenericObjectTypeAnnotation {
   readonly type: 'GenericObjectTypeAnnotation';
+  // a dictionary type is codegen as "Object"
+  // but we know all its members are in the same type
+  // when it happens, the following field is non-null
   readonly dictionaryValueType?: Nullable<NativeModuleTypeAnnotation> | undefined;
 }
 
@@ -360,9 +381,9 @@ export type NativeModuleTypeAnnotation =
   | NativeModuleParamOnlyTypeAnnotation
   | NativeModuleReturnOnlyTypeAnnotation;
 
-export type NativeModuleParamOnlyTypeAnnotation = NativeModuleFunctionTypeAnnotation;
+type NativeModuleParamOnlyTypeAnnotation = NativeModuleFunctionTypeAnnotation;
 
-export type NativeModuleReturnOnlyTypeAnnotation =
+type NativeModuleReturnOnlyTypeAnnotation =
   | NativeModuleFunctionTypeAnnotation
   | NativeModulePromiseTypeAnnotation
   | VoidTypeAnnotation;

package/lib/CodegenSchema.js.flow

@@ -53,7 +53,6 @@ export type VoidTypeAnnotation = $ReadOnly<{
 export type ObjectTypeAnnotation<+T> = $ReadOnly<{
   type: 'ObjectTypeAnnotation',
   properties: $ReadOnlyArray<NamedShape<T>>,
-
   // metadata for objects that generated from interfaces
   baseTypes?: $ReadOnlyArray<string>,
 }>;
@@ -91,14 +90,11 @@ export type ComponentShape = $ReadOnly<{
 
 export type OptionsShape = $ReadOnly<{
   interfaceOnly?: boolean,
-
   // Use for components with no current paper rename in progress
   // Does not check for new name
   paperComponentName?: string,
-
   // Use for components that are not used on other platforms.
   excludedPlatforms?: $ReadOnlyArray<PlatformType>,
-
   // Use for components currently being renamed in paper
   // Will use new name if it is available and fallback to this name
   paperComponentNameDeprecated?: string,
@@ -331,7 +327,6 @@ export type NativeModuleEnumDeclarationWithMembers = {
 
 export type NativeModuleGenericObjectTypeAnnotation = $ReadOnly<{
   type: 'GenericObjectTypeAnnotation',
-
   // a dictionary type is codegen as "Object"
   // but we know all its members are in the same type
   // when it happens, the following field is non-null
@@ -392,6 +387,7 @@ export type NativeModuleTypeAnnotation =
   | NativeModuleReturnOnlyTypeAnnotation;
 
 type NativeModuleParamOnlyTypeAnnotation = NativeModuleFunctionTypeAnnotation;
+
 type NativeModuleReturnOnlyTypeAnnotation =
   | NativeModulePromiseTypeAnnotation
   | VoidTypeAnnotation;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@react-native/codegen",
-  "version": "0.75.0-nightly-20240527-c207708c4",
+  "version": "0.75.0-nightly-20240529-5fbebb485",
   "description": "Code generation tools for React Native",
   "license": "MIT",
   "repository": {