flow-api-translator 0.36.0 → 0.37.0

package/dist/flowDefToTSDef.js.flow

@@ -26,6 +26,7 @@ import {
   unexpectedTranslationError as unexpectedTranslationErrorBase,
 } from './utils/ErrorUtils';
 import {removeAtFlowFromDocblock} from './utils/DocblockUtils';
+import {extractPropertyKeyLiterals} from './utils/TSNodeUtils';
 import {EOL} from 'os';
 
 type DeclarationOrUnsupported<T> = T | TSESTree.TSTypeAliasDeclaration;
@@ -35,23 +36,23 @@ const DUMMY_LOC: FlowESTree.SourceLocation = {
   end: {line: 1, column: 0},
 };
 
-type LooseOmit<O: interface {}, K: $Keys<$FlowFixMe>> = Pick<
+type LooseOmit<O extends interface {}, K extends keyof $FlowFixMe> = Pick<
   O,
-  Exclude<$Keys<O>, K>,
+  Exclude<keyof O, K>,
 >;
-function constructFlowNode<T: FlowESTree.BaseNode>(
+function constructFlowNode<T extends FlowESTree.BaseNode>(
   node: LooseOmit<NoInfer<T>, 'parent'>,
 ): T {
-  return (node: $FlowFixMe);
+  return node as $FlowFixMe;
 }
 
 const cloneJSDocCommentsToNewNode =
   // $FlowExpectedError[incompatible-type] - trust me this re-type is 100% safe
-  (cloneJSDocCommentsToNewNodeOriginal: (mixed, mixed) => void);
+  cloneJSDocCommentsToNewNodeOriginal as (unknown, unknown) => void;
 
 const makeCommentOwnLine =
   // $FlowExpectedError[incompatible-type] - trust me this re-type is 100% safe
-  (makeCommentOwnLineOriginal: (string, mixed) => string);
+  makeCommentOwnLineOriginal as (string, unknown) => string;
 
 const VALID_REACT_IMPORTS = new Set<string>(['React', 'react']);
 
@@ -180,7 +181,7 @@ const getTransforms = (
     // $FlowExpectedError[cannot-write]
     node.comments ??= [];
     // $FlowExpectedError[incompatible-type]
-    (node.comments: Array<TSESTree.Comment>).push(comment);
+    (node.comments as Array<TSESTree.Comment>).push(comment);
   }
   function unsupportedAnnotation(
     node: ObjectWithLoc,
@@ -385,12 +386,12 @@ const getTransforms = (
             loc: DUMMY_LOC,
             computed: false,
             id: transform.Identifier(member.id, false),
-            initializer: ({
+            initializer: {
               type: 'Literal',
               loc: DUMMY_LOC,
               raw: `"${member.id.name}"`,
               value: member.id.name,
-            }: TSESTree.StringLiteral),
+            } as TSESTree.StringLiteral,
           });
           break;
         }
@@ -607,7 +608,7 @@ const getTransforms = (
                       loc: DUMMY_LOC,
                       name: 'IterableIterator',
                     },
-                    typeParameters: {
+                    typeArguments: {
                       type: 'TSTypeParameterInstantiation',
                       loc: DUMMY_LOC,
                       params: [
@@ -818,13 +819,13 @@ const getTransforms = (
       return {
         type: 'TSLiteralType',
         loc: DUMMY_LOC,
-        literal: ({
+        literal: {
           type: 'Literal',
           loc: DUMMY_LOC,
           value: node.value,
           raw: node.raw,
           bigint,
-        }: TSESTree.BigIntLiteral),
+        } as TSESTree.BigIntLiteral,
       };
     },
     BigIntTypeAnnotation(
@@ -849,12 +850,12 @@ const getTransforms = (
       return {
         type: 'TSLiteralType',
         loc: DUMMY_LOC,
-        literal: ({
+        literal: {
           type: 'Literal',
           loc: DUMMY_LOC,
           value: node.value,
           raw: node.raw,
-        }: TSESTree.BooleanLiteral),
+        } as TSESTree.BooleanLiteral,
       };
     },
     BooleanTypeAnnotation(
@@ -872,7 +873,7 @@ const getTransforms = (
         type: 'TSClassImplements',
         loc: DUMMY_LOC,
         expression: transform.Identifier(node.id, false),
-        typeParameters: transform.TypeParameterInstantiation(
+        typeArguments: transform.TypeParameterInstantiation(
           node.typeParameters,
         ),
       };
@@ -1084,8 +1085,8 @@ const getTransforms = (
             ? null
             : superClass.id.type === 'QualifiedTypeIdentifier'
               ? transform.QualifiedTypeIdentifier(superClass.id)
-              : transform.Identifier((superClass.id: $FlowFixMe), false),
-        superTypeParameters: transform.TypeParameterInstantiation(
+              : transform.Identifier(superClass.id as $FlowFixMe, false),
+        superTypeArguments: transform.TypeParameterInstantiation(
           superClass?.typeParameters,
         ),
         typeParameters:
@@ -1378,7 +1379,7 @@ const getTransforms = (
         if (node.source === null) {
           // eslint-disable-next-line eqeqeq
           if (node.declaration === null) {
-            return ({
+            return {
               type: 'ExportNamedDeclaration',
               loc: DUMMY_LOC,
               // flow does not currently support attributes
@@ -1388,7 +1389,7 @@ const getTransforms = (
               exportKind: 'value',
               source: null,
               specifiers: node.specifiers.map(transform.ExportSpecifier),
-            }: TSESTree.ExportNamedDeclarationWithoutSourceWithMultiple);
+            } as TSESTree.ExportNamedDeclarationWithoutSourceWithMultiple;
           }
 
           const declarations = ((): Array<{
@@ -1537,7 +1538,7 @@ const getTransforms = (
 
           return mappedDeclarations.flat();
         } else {
-          return ({
+          return {
             type: 'ExportNamedDeclaration',
             loc: DUMMY_LOC,
             // flow does not currently support attributes
@@ -1547,7 +1548,7 @@ const getTransforms = (
             exportKind: 'value',
             source: transform.StringLiteral(node.source),
             specifiers: node.specifiers.map(transform.ExportSpecifier),
-          }: TSESTree.ExportNamedDeclarationWithSource);
+          } as TSESTree.ExportNamedDeclarationWithSource;
         }
       }
     },
@@ -1582,7 +1583,7 @@ const getTransforms = (
               name: `ReactNode`,
             },
           },
-          typeParameters: undefined,
+          typeArguments: undefined,
         },
       };
 
@@ -1605,9 +1606,9 @@ const getTransforms = (
       };
     },
     ComponentTypeParameters(
-      params: $ReadOnlyArray<FlowESTree.ComponentTypeParameter>,
+      params: ReadonlyArray<FlowESTree.ComponentTypeParameter>,
       rest: FlowESTree.ComponentTypeParameter | null,
-    ): $ReadOnlyArray<TSESTree.Parameter> {
+    ): ReadonlyArray<TSESTree.Parameter> {
       if (params.length === 0 && rest != null) {
         return [
           {
@@ -1974,7 +1975,7 @@ const getTransforms = (
       })();
 
       const mainExport = {
-        type: ('ExportNamedDeclaration': 'ExportNamedDeclaration'),
+        type: 'ExportNamedDeclaration' as 'ExportNamedDeclaration',
         loc: DUMMY_LOC,
         assertions: [],
         declaration: exportedDeclaration,
@@ -2112,7 +2113,7 @@ const getTransforms = (
 
       const assertHasExactlyNTypeParameters = (
         count: number,
-      ): $ReadOnlyArray<TSESTree.TypeNode> => {
+      ): ReadonlyArray<TSESTree.TypeNode> => {
         if (node.typeParameters != null) {
           if (node.typeParameters.params.length !== count) {
             throw translationError(
@@ -2143,7 +2144,7 @@ const getTransforms = (
       function assertHasTypeParametersInRange(
         min: number,
         max: number,
-      ): $ReadOnlyArray<TSESTree.TypeNode> {
+      ): ReadonlyArray<TSESTree.TypeNode> {
         const {typeParameters} = node;
         if (typeParameters == null) {
           if (min > 0) {
@@ -2219,7 +2220,7 @@ const getTransforms = (
               loc: DUMMY_LOC,
               name: 'ArrayLike',
             },
-            typeParameters: {
+            typeArguments: {
               type: 'TSTypeParameterInstantiation',
               loc: DUMMY_LOC,
               params: assertHasExactlyNTypeParameters(1),
@@ -2239,7 +2240,7 @@ const getTransforms = (
               loc: DUMMY_LOC,
               name: 'Pick',
             },
-            typeParameters: {
+            typeArguments: {
               type: 'TSTypeParameterInstantiation',
               loc: DUMMY_LOC,
               params: [
@@ -2252,7 +2253,7 @@ const getTransforms = (
                     loc: DUMMY_LOC,
                     name: 'Exclude',
                   },
-                  typeParameters: {
+                  typeArguments: {
                     type: 'TSTypeParameterInstantiation',
                     loc: DUMMY_LOC,
                     params: [
@@ -2309,7 +2310,7 @@ const getTransforms = (
           }
 
           // New AST format for `typeof import('module')`
-          return ({
+          return {
             type: 'TSTypeQuery',
             loc: DUMMY_LOC,
             exprName: {
@@ -2317,9 +2318,11 @@ const getTransforms = (
               loc: DUMMY_LOC,
               argument: moduleName,
               qualifier: null,
-              typeParameters: null,
+              options: null,
+              source: moduleName.literal,
+              typeArguments: null,
             },
-          }: $FlowFixMe);
+          } as $FlowFixMe;
         }
 
         case '$FlowFixMe': {
@@ -2397,7 +2400,7 @@ const getTransforms = (
               loc: DUMMY_LOC,
               name: 'NonNullable',
             },
-            typeParameters: {
+            typeArguments: {
               type: 'TSTypeParameterInstantiation',
               loc: DUMMY_LOC,
               params: assertHasExactlyNTypeParameters(1),
@@ -2415,7 +2418,7 @@ const getTransforms = (
               loc: DUMMY_LOC,
               name: 'Readonly',
             },
-            typeParameters: {
+            typeArguments: {
               type: 'TSTypeParameterInstantiation',
               loc: DUMMY_LOC,
               params: assertHasExactlyNTypeParameters(1),
@@ -2436,7 +2439,7 @@ const getTransforms = (
               loc: DUMMY_LOC,
               name: 'ReadonlyArray',
             },
-            typeParameters: {
+            typeArguments: {
               type: 'TSTypeParameterInstantiation',
               loc: DUMMY_LOC,
               params: assertHasExactlyNTypeParameters(1),
@@ -2453,7 +2456,7 @@ const getTransforms = (
               loc: DUMMY_LOC,
               name: 'ReadonlyMap',
             },
-            typeParameters: {
+            typeArguments: {
               type: 'TSTypeParameterInstantiation',
               loc: DUMMY_LOC,
               params: assertHasExactlyNTypeParameters(2),
@@ -2470,7 +2473,7 @@ const getTransforms = (
               loc: DUMMY_LOC,
               name: 'ReadonlySet',
             },
-            typeParameters: {
+            typeArguments: {
               type: 'TSTypeParameterInstantiation',
               loc: DUMMY_LOC,
               params: assertHasExactlyNTypeParameters(1),
@@ -2640,7 +2643,7 @@ const getTransforms = (
       const hasReactImport = isReactImport(baseId, baseId.name);
       if (validReactImportOrGlobal || hasReactImport) {
         switch (fullTypeName) {
-          // TODO: In flow this is `ChildrenArray<T> = T | $ReadOnlyArray<ChildrenArray<T>>`.
+          // TODO: In flow this is `ChildrenArray<T> = T | ReadonlyArray<ChildrenArray<T>>`.
           // The recursive nature of it is rarely needed, so we're simplifying this for now
           // but omitting that aspect. Once we're able to provide utility types for our translations,
           // we should update this.
@@ -2662,7 +2665,7 @@ const getTransforms = (
                     loc: DUMMY_LOC,
                     name: 'ReadonlyArray',
                   },
-                  typeParameters: {
+                  typeArguments: {
                     type: 'TSTypeParameterInstantiation',
                     loc: DUMMY_LOC,
                     params: [param],
@@ -2703,7 +2706,7 @@ const getTransforms = (
                   name: 'Component',
                 },
               },
-              typeParameters: {
+              typeArguments: {
                 type: 'TSTypeParameterInstantiation',
                 loc: DUMMY_LOC,
                 params: params.map(param => transformTypeAnnotationType(param)),
@@ -2728,7 +2731,7 @@ const getTransforms = (
                   name: `Context`,
                 },
               },
-              typeParameters: {
+              typeArguments: {
                 type: 'TSTypeParameterInstantiation',
                 loc: DUMMY_LOC,
                 params: assertHasExactlyNTypeParameters(1),
@@ -2771,7 +2774,7 @@ const getTransforms = (
                   name: `ElementType`,
                 },
               },
-              typeParameters: undefined,
+              typeArguments: undefined,
             };
           }
           // React.Node -> React.ReactNode
@@ -2791,7 +2794,7 @@ const getTransforms = (
                   name: `ReactNode`,
                 },
               },
-              typeParameters: undefined,
+              typeArguments: undefined,
             };
           }
           // React.Element<typeof Component> -> React.ReactElement<typeof Component>
@@ -2810,7 +2813,7 @@ const getTransforms = (
                   name: `ReactElement`,
                 },
               },
-              typeParameters: {
+              typeArguments: {
                 type: 'TSTypeParameterInstantiation',
                 loc: DUMMY_LOC,
                 params: assertHasExactlyNTypeParameters(1),
@@ -2834,7 +2837,7 @@ const getTransforms = (
                   name: `ComponentRef`,
                 },
               },
-              typeParameters: {
+              typeArguments: {
                 type: 'TSTypeParameterInstantiation',
                 loc: DUMMY_LOC,
                 params: assertHasExactlyNTypeParameters(1),
@@ -2889,7 +2892,7 @@ const getTransforms = (
                   name: 'Element',
                 },
               },
-              typeParameters: undefined,
+              typeArguments: undefined,
             };
           }
           // React.ComponentType<Config> -> React.ComponentType<Config>
@@ -2909,7 +2912,7 @@ const getTransforms = (
                   name: 'ComponentType',
                 },
               },
-              typeParameters: {
+              typeArguments: {
                 type: 'TSTypeParameterInstantiation',
                 loc: DUMMY_LOC,
                 params: assertHasExactlyNTypeParameters(1),
@@ -2937,7 +2940,7 @@ const getTransforms = (
               );
             }
 
-            const newParams = ((): $ReadOnlyArray<TSESTree.TypeNode> => {
+            const newParams = ((): ReadonlyArray<TSESTree.TypeNode> => {
               if (params.length === 1) {
                 return assertHasExactlyNTypeParameters(1);
               }
@@ -2968,7 +2971,7 @@ const getTransforms = (
                           name: 'RefAttributes',
                         },
                       },
-                      typeParameters: {
+                      typeArguments: {
                         type: 'TSTypeParameterInstantiation',
                         loc: DUMMY_LOC,
                         params: [ref],
@@ -2992,7 +2995,7 @@ const getTransforms = (
                   name: 'ComponentType',
                 },
               },
-              typeParameters: {
+              typeArguments: {
                 type: 'TSTypeParameterInstantiation',
                 loc: DUMMY_LOC,
                 params: newParams,
@@ -3016,7 +3019,7 @@ const getTransforms = (
                   name: 'ComponentProps',
                 },
               },
-              typeParameters: {
+              typeArguments: {
                 type: 'TSTypeParameterInstantiation',
                 loc: DUMMY_LOC,
                 params: assertHasExactlyNTypeParameters(1),
@@ -3054,7 +3057,7 @@ const getTransforms = (
                   name: 'LibraryManagedAttributes',
                 },
               },
-              typeParameters: {
+              typeArguments: {
                 type: 'TSTypeParameterInstantiation',
                 loc: DUMMY_LOC,
                 params: [
@@ -3072,7 +3075,7 @@ const getTransforms = (
                         name: `ComponentProps`,
                       },
                     },
-                    typeParameters: {
+                    typeArguments: {
                       type: 'TSTypeParameterInstantiation',
                       loc: DUMMY_LOC,
                       params: [param],
@@ -3099,7 +3102,7 @@ const getTransforms = (
                   name: 'Ref',
                 },
               },
-              typeParameters: {
+              typeArguments: {
                 type: 'TSTypeParameterInstantiation',
                 loc: DUMMY_LOC,
                 params: assertHasExactlyNTypeParameters(1),
@@ -3117,7 +3120,7 @@ const getTransforms = (
           node.id.type === 'Identifier'
             ? transform.Identifier(node.id, false)
             : transform.QualifiedTypeIdentifier(node.id),
-        typeParameters: transform.TypeParameterInstantiation(
+        typeArguments: transform.TypeParameterInstantiation(
           node.typeParameters,
         ),
       };
@@ -3256,7 +3259,7 @@ const getTransforms = (
           node.id.type === 'QualifiedTypeIdentifier'
             ? transform.QualifiedTypeIdentifier(node.id)
             : transform.Identifier(node.id, false),
-        typeParameters: transform.TypeParameterInstantiation(
+        typeArguments: transform.TypeParameterInstantiation(
           node.typeParameters,
         ),
       };
@@ -3276,8 +3279,8 @@ const getTransforms = (
               type: 'TSTypeReference',
               loc: DUMMY_LOC,
               // Bug: ex.id can be qualified
-              typeName: transform.Identifier((ex.id: $FlowFixMe), false),
-              typeParameters: transform.TypeParameterInstantiation(
+              typeName: transform.Identifier(ex.id as $FlowFixMe, false),
+              typeArguments: transform.TypeParameterInstantiation(
                 ex.typeParameters,
               ),
             })),
@@ -3364,12 +3367,12 @@ const getTransforms = (
       return {
         type: 'TSLiteralType',
         loc: DUMMY_LOC,
-        literal: ({
+        literal: {
           type: 'Literal',
           loc: DUMMY_LOC,
           value: node.value,
           raw: node.raw,
-        }: TSESTree.NumberLiteral),
+        } as TSESTree.NumberLiteral,
       };
     },
     NumberTypeAnnotation(
@@ -3546,15 +3549,15 @@ const getTransforms = (
         ```
         type T = { ...T1, b: string  };
         // becomes
-        type T = Omit<T1, keyof { b: string }> & { b: string };
+        type T = Omit<T1, 'b'> & { b: string };
         ```
         ```
         type T = { ...T1, ...T2, ...T3, b: string  };
         // becomes
         type T =
-          & Omit<T1, keyof T2 | keyof T3 | keyof { b: string }>
-          & Omit<T2, keyof T3 | keyof { b: string }>
-          & Omit<T3, keyof { b: string }>
+          & Omit<T1, keyof T2 | keyof T3 | 'b'>
+          & Omit<T2, keyof T3 | 'b'>
+          & Omit<T3, 'b'>
           & { b: string };
         ```
 
@@ -3616,10 +3619,33 @@ const getTransforms = (
           members: tsBody,
         };
 
+        // When the non-spread properties have statically known key
+        // names, emit them as string literal types directly instead of
+        // wrapping in `keyof`. Falls back to `keyof objectType` when
+        // any key is computed or otherwise non-extractable.
+        const objectKeyTypes: ReadonlyArray<TSESTree.TypeNode> =
+          extractPropertyKeyLiterals(tsBody) ?? [
+            {
+              type: 'TSTypeOperator',
+              loc: DUMMY_LOC,
+              operator: 'keyof',
+              typeAnnotation: objectType,
+            },
+          ];
+
         const intersectionMembers: Array<TSESTree.TypeNode> = [];
         for (let i = 0; i < typesToIntersect.length; i += 1) {
           const currentType = typesToIntersect[i];
           const remainingTypes = typesToIntersect.slice(i + 1);
+          const omitKeyTypes: Array<TSESTree.TypeNode> = [
+            ...remainingTypes.map(t => ({
+              type: 'TSTypeOperator',
+              loc: DUMMY_LOC,
+              operator: 'keyof',
+              typeAnnotation: t,
+            })),
+            ...objectKeyTypes,
+          ];
           intersectionMembers.push({
             type: 'TSTypeReference',
             loc: DUMMY_LOC,
@@ -3628,29 +3654,18 @@ const getTransforms = (
               loc: DUMMY_LOC,
               name: 'Omit',
             },
-            typeParameters: {
+            typeArguments: {
               type: 'TSTypeParameterInstantiation',
               loc: DUMMY_LOC,
               params: [
                 currentType,
-                {
-                  type: 'TSUnionType',
-                  loc: DUMMY_LOC,
-                  types: [
-                    ...remainingTypes.map(t => ({
-                      type: 'TSTypeOperator',
+                omitKeyTypes.length === 1
+                  ? omitKeyTypes[0]
+                  : {
+                      type: 'TSUnionType',
                       loc: DUMMY_LOC,
-                      operator: 'keyof',
-                      typeAnnotation: t,
-                    })),
-                    {
-                      type: 'TSTypeOperator',
-                      loc: DUMMY_LOC,
-                      operator: 'keyof',
-                      typeAnnotation: objectType,
+                      types: omitKeyTypes,
                     },
-                  ],
-                },
               ],
             },
           });
@@ -3866,7 +3881,7 @@ const getTransforms = (
             loc: DUMMY_LOC,
             name: 'NonNullable',
           },
-          typeParameters: {
+          typeArguments: {
             type: 'TSTypeParameterInstantiation',
             loc: DUMMY_LOC,
             params: [transformTypeAnnotationType(node.objectType)],
@@ -3931,12 +3946,12 @@ const getTransforms = (
       return {
         type: 'TSLiteralType',
         loc: DUMMY_LOC,
-        literal: ({
+        literal: {
           type: 'Literal',
           loc: DUMMY_LOC,
           value: node.value,
           raw: node.raw,
-        }: TSESTree.StringLiteral),
+        } as TSESTree.StringLiteral,
       };
     },
     StringTypeAnnotation(
@@ -4064,14 +4079,14 @@ const getTransforms = (
             type: 'TSTypeQuery',
             loc: DUMMY_LOC,
             exprName: transform.Identifier(node.argument),
-            typeParameters: undefined,
+            typeArguments: undefined,
           };
         case 'QualifiedTypeofIdentifier':
           return {
             type: 'TSTypeQuery',
             loc: DUMMY_LOC,
             exprName: transform.QualifiedTypeofIdentifier(node.argument),
-            typeParameters: undefined,
+            typeArguments: undefined,
           };
       }
     },
@@ -4249,7 +4264,7 @@ const getTransforms = (
                 name: `ReactNode`,
               },
             },
-            typeParameters: undefined,
+            typeArguments: undefined,
           };
         }
       }
@@ -4283,7 +4298,7 @@ const getTransforms = (
               name: `ReactNode`,
             },
           },
-          typeParameters: undefined,
+          typeArguments: undefined,
         },
       };
 

package/dist/flowImportTo.js

@@ -1,12 +1,3 @@
-/**
- * Copyright (c) Meta Platforms, Inc. and affiliates.
- *
- * This source code is licensed under the MIT license found in the
- * LICENSE file in the root directory of this source tree.
- *
- * 
- * @format
- */
 'use strict';
 
 Object.defineProperty(exports, "__esModule", {

package/dist/flowImportTo.js.flow

@@ -19,7 +19,7 @@ export type SourceMapperParams = {
   module: string,
 };
 
-export type MapperOptions = $ReadOnly<{
+export type MapperOptions = Readonly<{
   sourceMapper: SourceMapperParams => string,
 }>;