flow-api-translator 0.28.0 → 0.29.0

package/dist/TSDefToFlowDef.js.flow

@@ -32,11 +32,15 @@ const DUMMY_COMMON = {
   parent: DUMMY_PARENT,
 };
 
+type LooseOmit<O: interface {}, K: $Keys<$FlowFixMe>> = Pick<
+  O,
+  Exclude<$Keys<O>, K>,
+>;
 function constructFlowNode<T: FlowESTree.BaseNode>(
-  node: $Diff<T, FlowESTree.BaseNode>,
+  node: LooseOmit<NoInfer<T>, 'parent'>,
 ): T {
   return {
-    ...node,
+    ...(node: $FlowFixMe),
     ...DUMMY_COMMON,
   };
 }
@@ -92,7 +96,7 @@ const getTransforms = (originalCode: string, opts: TranslationOptions) => {
     return buildCodeFrame(node, message, code, false);
   }
   function addErrorComment(node: FlowESTree.ESNode, message: string): void {
-    const comment = {
+    const comment: TSESTree.Comment = {
       type: 'Block',
       loc: DUMMY_LOC,
       value: `*${EOL} * ${message.replace(

package/dist/flowDefToTSDef.js

@@ -42,7 +42,6 @@ const DUMMY_LOC = {
 };
 
 function constructFlowNode(node) {
-  // $FlowFixMe[prop-missing]
   return node;
 }
 
@@ -812,7 +811,7 @@ const getTransforms = (originalCode, scopeManager, opts) => {
         type: 'TSClassImplements',
         loc: DUMMY_LOC,
         expression: transform.Identifier(node.id, false),
-        typeParameters: node.typeParameters == null ? undefined : transform.TypeParameterInstantiation(node.typeParameters)
+        typeParameters: transform.TypeParameterInstantiation(node.typeParameters)
       };
     },
 
@@ -1006,7 +1005,7 @@ const getTransforms = (originalCode, scopeManager, opts) => {
         id: transform.Identifier(node.id, false),
         implements: node.implements == null ? undefined : node.implements.map(transform.ClassImplements),
         superClass: superClass == null ? null : superClass.id.type === 'QualifiedTypeIdentifier' ? transform.QualifiedTypeIdentifier(superClass.id) : transform.Identifier(superClass.id, false),
-        superTypeParameters: (superClass == null ? void 0 : superClass.typeParameters) == null ? undefined : transform.TypeParameterInstantiation(superClass.typeParameters),
+        superTypeParameters: transform.TypeParameterInstantiation(superClass == null ? void 0 : superClass.typeParameters),
         typeParameters: node.typeParameters == null ? undefined : transform.TypeParameterDeclaration(node.typeParameters) // TODO - mixins??
 
       };
@@ -2856,7 +2855,7 @@ const getTransforms = (originalCode, scopeManager, opts) => {
         type: 'TSTypeReference',
         loc: DUMMY_LOC,
         typeName: node.id.type === 'Identifier' ? transform.Identifier(node.id, false) : transform.QualifiedTypeIdentifier(node.id),
-        typeParameters: node.typeParameters == null ? undefined : transform.TypeParameterInstantiation(node.typeParameters)
+        typeParameters: transform.TypeParameterInstantiation(node.typeParameters)
       };
     },
 
@@ -2965,7 +2964,7 @@ const getTransforms = (originalCode, scopeManager, opts) => {
         type: 'TSInterfaceHeritage',
         loc: DUMMY_LOC,
         expression: node.id.type === 'QualifiedTypeIdentifier' ? transform.QualifiedTypeIdentifier(node.id) : transform.Identifier(node.id, false),
-        typeParameters: node.typeParameters == null ? undefined : transform.TypeParameterInstantiation(node.typeParameters)
+        typeParameters: transform.TypeParameterInstantiation(node.typeParameters)
       };
     },
 
@@ -2982,7 +2981,7 @@ const getTransforms = (originalCode, scopeManager, opts) => {
             loc: DUMMY_LOC,
             // Bug: ex.id can be qualified
             typeName: transform.Identifier(ex.id, false),
-            typeParameters: ex.typeParameters == null ? undefined : transform.TypeParameterInstantiation(ex.typeParameters)
+            typeParameters: transform.TypeParameterInstantiation(ex.typeParameters)
           })), transform.ObjectTypeAnnotation(node.body)]
         };
       }
@@ -3698,6 +3697,12 @@ const getTransforms = (originalCode, scopeManager, opts) => {
     },
 
     TypeParameterInstantiation(node) {
+      // Empty parameters in Flow are valid, but TS requires at least one parameter.
+      // This ensures empty type parameters are not created in TS
+      if (node == null || node.params.length === 0) {
+        return undefined;
+      }
+
       return {
         type: 'TSTypeParameterInstantiation',
         loc: DUMMY_LOC,
@@ -3832,10 +3837,12 @@ const getTransforms = (originalCode, scopeManager, opts) => {
     transform[key] = (node, ...args) => {
       const result = originalFn(node, ...args);
 
-      if (Array.isArray(result)) {
-        cloneJSDocCommentsToNewNode(node, result[0]);
-      } else {
-        cloneJSDocCommentsToNewNode(node, result);
+      if (node != null && result != null) {
+        if (Array.isArray(result)) {
+          cloneJSDocCommentsToNewNode(node, result[0]);
+        } else {
+          cloneJSDocCommentsToNewNode(node, result);
+        }
       }
 
       return result;

package/dist/flowDefToTSDef.js.flow

@@ -35,11 +35,14 @@ const DUMMY_LOC: FlowESTree.SourceLocation = {
   end: {line: 1, column: 0},
 };
 
+type LooseOmit<O: interface {}, K: $Keys<$FlowFixMe>> = Pick<
+  O,
+  Exclude<$Keys<O>, K>,
+>;
 function constructFlowNode<T: FlowESTree.BaseNode>(
-  node: $Diff<T, FlowESTree.BaseNode>,
+  node: LooseOmit<NoInfer<T>, 'parent'>,
 ): T {
-  // $FlowFixMe[prop-missing]
-  return node;
+  return (node: $FlowFixMe);
 }
 
 const cloneJSDocCommentsToNewNode =
@@ -60,7 +63,7 @@ let shouldAddReactImport: boolean | null = null;
 
 // Returns appropriate Identifier for `React` import.
 // If a global is in use, set a flag to indicate that we should add the import.
-function getReactIdentifier(hasReactImport: boolean) {
+function getReactIdentifier(hasReactImport: boolean): TSESTree.EntityName {
   if (shouldAddReactImport !== false) {
     shouldAddReactImport = !hasReactImport;
   }
@@ -408,7 +411,7 @@ const getTransforms = (
       }
     }
 
-    const bodyRepresentationType =
+    const bodyRepresentationType: TSESTree.TypeNode =
       body.type === 'EnumNumberBody'
         ? {type: 'TSNumberKeyword', loc: DUMMY_LOC}
         : {type: 'TSStringKeyword', loc: DUMMY_LOC};
@@ -851,10 +854,9 @@ const getTransforms = (
         type: 'TSClassImplements',
         loc: DUMMY_LOC,
         expression: transform.Identifier(node.id, false),
-        typeParameters:
-          node.typeParameters == null
-            ? undefined
-            : transform.TypeParameterInstantiation(node.typeParameters),
+        typeParameters: transform.TypeParameterInstantiation(
+          node.typeParameters,
+        ),
       };
     },
     DeclareClass(
@@ -928,7 +930,7 @@ const getTransforms = (
               cloneJSDocCommentsToNewNode(member, newNode);
               classMembers.push(newNode);
             } else {
-              const [key, computed] = (() => {
+              const [key, computed] = ((): [TSESTree.PropertyName, boolean] => {
                 const _key = member.key;
                 if (_key.type === 'Identifier' && _key.name.startsWith('@@')) {
                   const name = _key.name.slice(2);
@@ -1065,10 +1067,9 @@ const getTransforms = (
             : superClass.id.type === 'QualifiedTypeIdentifier'
             ? transform.QualifiedTypeIdentifier(superClass.id)
             : transform.Identifier((superClass.id: $FlowFixMe), false),
-        superTypeParameters:
-          superClass?.typeParameters == null
-            ? undefined
-            : transform.TypeParameterInstantiation(superClass.typeParameters),
+        superTypeParameters: transform.TypeParameterInstantiation(
+          superClass?.typeParameters,
+        ),
         typeParameters:
           node.typeParameters == null
             ? undefined
@@ -1372,7 +1373,10 @@ const getTransforms = (
             }: TSESTree.ExportNamedDeclarationWithoutSourceWithMultiple);
           }
 
-          const declarations = (() => {
+          const declarations = ((): Array<{
+            declaration: TSESTree.NamedExportDeclarations,
+            exportKind: TSESTree.ExportKind,
+          }> => {
             switch (node.declaration.type) {
               case 'DeclareClass':
                 return [
@@ -1951,7 +1955,7 @@ const getTransforms = (
       })();
 
       const mainExport = {
-        type: 'ExportNamedDeclaration',
+        type: ('ExportNamedDeclaration': 'ExportNamedDeclaration'),
         loc: DUMMY_LOC,
         assertions: [],
         declaration: exportedDeclaration,
@@ -2898,7 +2902,7 @@ const getTransforms = (
               );
             }
 
-            const newParams = (() => {
+            const newParams = ((): $ReadOnlyArray<TSESTree.TypeNode> => {
               if (params.length === 1) {
                 return assertHasExactlyNTypeParameters(1);
               }
@@ -3078,10 +3082,9 @@ const getTransforms = (
           node.id.type === 'Identifier'
             ? transform.Identifier(node.id, false)
             : transform.QualifiedTypeIdentifier(node.id),
-        typeParameters:
-          node.typeParameters == null
-            ? undefined
-            : transform.TypeParameterInstantiation(node.typeParameters),
+        typeParameters: transform.TypeParameterInstantiation(
+          node.typeParameters,
+        ),
       };
     },
     Identifier(
@@ -3132,12 +3135,12 @@ const getTransforms = (
     ): Array<DeclarationOrUnsupported<TSESTree.ImportDeclaration>> {
       const importKind = node.importKind;
 
-      const specifiers = [];
+      const specifiers: Array<TSESTree.ImportClause> = [];
       const unsupportedSpecifiers: Array<TSESTree.TSTypeAliasDeclaration> = [];
       node.specifiers.forEach(spec => {
         let id = (() => {
           if (node.importKind === 'typeof' || spec.importKind === 'typeof') {
-            const id = {
+            const id: TSESTree.Identifier = {
               type: 'Identifier',
               loc: DUMMY_LOC,
               name: getPlaceholderNameForTypeofImport(),
@@ -3218,10 +3221,9 @@ const getTransforms = (
           node.id.type === 'QualifiedTypeIdentifier'
             ? transform.QualifiedTypeIdentifier(node.id)
             : transform.Identifier(node.id, false),
-        typeParameters:
-          node.typeParameters == null
-            ? undefined
-            : transform.TypeParameterInstantiation(node.typeParameters),
+        typeParameters: transform.TypeParameterInstantiation(
+          node.typeParameters,
+        ),
       };
     },
     InterfaceTypeAnnotation(
@@ -3240,10 +3242,9 @@ const getTransforms = (
               loc: DUMMY_LOC,
               // Bug: ex.id can be qualified
               typeName: transform.Identifier((ex.id: $FlowFixMe), false),
-              typeParameters:
-                ex.typeParameters == null
-                  ? undefined
-                  : transform.TypeParameterInstantiation(ex.typeParameters),
+              typeParameters: transform.TypeParameterInstantiation(
+                ex.typeParameters,
+              ),
             })),
             transform.ObjectTypeAnnotation(node.body),
           ],
@@ -3566,7 +3567,7 @@ const getTransforms = (
         const tsBody = members
           .sort((a, b) => a.start - b.start)
           .map(({node}) => node);
-        const objectType = {
+        const objectType: TSESTree.TypeNode = {
           type: 'TSTypeLiteral',
           loc: DUMMY_LOC,
           members: tsBody,
@@ -3886,7 +3887,7 @@ const getTransforms = (
             element.variance != null &&
             element.variance.kind === 'plus',
         );
-      const elems = node.types.map(element => {
+      const elems = node.types.map((element): TSESTree.TypeNode => {
         switch (element.type) {
           case 'TupleTypeLabeledElement':
             if (!allReadOnly && element.variance != null) {
@@ -3924,7 +3925,7 @@ const getTransforms = (
         }
       });
 
-      const elementTypes = node.inexact
+      const elementTypes: Array<TSESTree.TypeNode> = node.inexact
         ? [
             ...elems,
             {
@@ -4040,8 +4041,14 @@ const getTransforms = (
       };
     },
     TypeParameterInstantiation(
-      node: FlowESTree.TypeParameterInstantiation,
-    ): TSESTree.TSTypeParameterInstantiation {
+      node: ?FlowESTree.TypeParameterInstantiation,
+    ): TSESTree.TSTypeParameterInstantiation | void {
+      // Empty parameters in Flow are valid, but TS requires at least one parameter.
+      // This ensures empty type parameters are not created in TS
+      if (node == null || node.params.length === 0) {
+        return undefined;
+      }
+
       return {
         type: 'TSTypeParameterInstantiation',
         loc: DUMMY_LOC,
@@ -4147,7 +4154,7 @@ const getTransforms = (
 
       // TS cannot support `renderType` so we always use ReactNode as the return type.
       const hasReactImport = isReactImport(node, 'React');
-      const returnType = {
+      const returnType: TSESTree.TSTypeAnnotation = {
         type: 'TSTypeAnnotation',
         loc: DUMMY_LOC,
         // If no rendersType we assume its ReactNode type.
@@ -4186,10 +4193,12 @@ const getTransforms = (
     // $FlowExpectedError[missing-local-annot]
     transform[key] = (node, ...args) => {
       const result = originalFn(node, ...args);
-      if (Array.isArray(result)) {
-        cloneJSDocCommentsToNewNode(node, result[0]);
-      } else {
-        cloneJSDocCommentsToNewNode(node, result);
+      if (node != null && result != null) {
+        if (Array.isArray(result)) {
+          cloneJSDocCommentsToNewNode(node, result[0]);
+        } else {
+          cloneJSDocCommentsToNewNode(node, result);
+        }
       }
       return result;
     };

package/dist/flowToFlowDef.js

@@ -897,25 +897,25 @@ function convertClassMember(member, context) {
 
         if (((_member$value = member.value) == null ? void 0 : _member$value.type) === 'ArrowFunctionExpression' && member.typeAnnotation == null) {
           const [resultTypeAnnotation, deps] = convertAFunction(member.value, context);
-          return [_hermesTransform.t.ObjectTypePropertySignature({
+          return [inheritComments(member, _hermesTransform.t.ObjectTypePropertySignature({
             // $FlowFixMe[incompatible-call]
             key: (0, _hermesTransform.asDetachedNode)(member.key),
             value: resultTypeAnnotation,
             optional: member.optional,
             static: member.static,
             variance: member.variance
-          }), deps];
+          })), deps];
         }
 
         const [resultTypeAnnotation, deps] = convertTypeAnnotation(member.typeAnnotation, member, context);
-        return [_hermesTransform.t.ObjectTypePropertySignature({
+        return [inheritComments(member, _hermesTransform.t.ObjectTypePropertySignature({
           // $FlowFixMe[incompatible-call]
           key: (0, _hermesTransform.asDetachedNode)(member.key),
           value: resultTypeAnnotation,
           optional: member.optional,
           static: member.static,
           variance: member.variance
-        }), deps];
+        })), deps];
       }
 
     case 'MethodDefinition':
@@ -937,21 +937,21 @@ function convertClassMember(member, context) {
         if (member.kind === 'get' || member.kind === 'set') {
           // accessors are methods - but flow accessor signatures are properties
           const kind = member.kind;
-          return [_hermesTransform.t.ObjectTypeAccessorSignature({
+          return [inheritComments(member, _hermesTransform.t.ObjectTypeAccessorSignature({
             // $FlowFixMe[incompatible-call]
             key: (0, _hermesTransform.asDetachedNode)(newKey),
             value: resultValue,
             static: member.static,
             kind
-          }), deps];
+          })), deps];
         }
 
-        return [_hermesTransform.t.ObjectTypeMethodSignature({
+        return [inheritComments(member, _hermesTransform.t.ObjectTypeMethodSignature({
           // $FlowFixMe[incompatible-call]
           key: (0, _hermesTransform.asDetachedNode)(newKey),
           value: resultValue,
           static: member.static
-        }), deps];
+        })), deps];
       }
 
     default:

package/dist/flowToFlowDef.js.flow

@@ -1198,16 +1198,19 @@ function convertClassMember(
         );
 
         return [
-          t.ObjectTypePropertySignature({
-            // $FlowFixMe[incompatible-call]
-            key: asDetachedNode<
-              ClassPropertyNameComputed | ClassPropertyNameNonComputed,
-            >(member.key),
-            value: resultTypeAnnotation,
-            optional: member.optional,
-            static: member.static,
-            variance: member.variance,
-          }),
+          inheritComments(
+            member,
+            t.ObjectTypePropertySignature({
+              // $FlowFixMe[incompatible-call]
+              key: asDetachedNode<
+                ClassPropertyNameComputed | ClassPropertyNameNonComputed,
+              >(member.key),
+              value: resultTypeAnnotation,
+              optional: member.optional,
+              static: member.static,
+              variance: member.variance,
+            }),
+          ),
           deps,
         ];
       }
@@ -1219,16 +1222,19 @@ function convertClassMember(
       );
 
       return [
-        t.ObjectTypePropertySignature({
-          // $FlowFixMe[incompatible-call]
-          key: asDetachedNode<
-            ClassPropertyNameComputed | ClassPropertyNameNonComputed,
-          >(member.key),
-          value: resultTypeAnnotation,
-          optional: member.optional,
-          static: member.static,
-          variance: member.variance,
-        }),
+        inheritComments(
+          member,
+          t.ObjectTypePropertySignature({
+            // $FlowFixMe[incompatible-call]
+            key: asDetachedNode<
+              ClassPropertyNameComputed | ClassPropertyNameNonComputed,
+            >(member.key),
+            value: resultTypeAnnotation,
+            optional: member.optional,
+            static: member.static,
+            variance: member.variance,
+          }),
+        ),
         deps,
       ];
     }
@@ -1269,28 +1275,34 @@ function convertClassMember(
         const kind = member.kind;
 
         return [
-          t.ObjectTypeAccessorSignature({
+          inheritComments(
+            member,
+            t.ObjectTypeAccessorSignature({
+              // $FlowFixMe[incompatible-call]
+              key: asDetachedNode<
+                ClassPropertyNameComputed | ClassPropertyNameNonComputed,
+              >(newKey),
+              value: resultValue,
+              static: member.static,
+              kind,
+            }),
+          ),
+          deps,
+        ];
+      }
+
+      return [
+        inheritComments(
+          member,
+          t.ObjectTypeMethodSignature({
             // $FlowFixMe[incompatible-call]
             key: asDetachedNode<
               ClassPropertyNameComputed | ClassPropertyNameNonComputed,
             >(newKey),
             value: resultValue,
             static: member.static,
-            kind,
           }),
-          deps,
-        ];
-      }
-
-      return [
-        t.ObjectTypeMethodSignature({
-          // $FlowFixMe[incompatible-call]
-          key: asDetachedNode<
-            ClassPropertyNameComputed | ClassPropertyNameNonComputed,
-          >(newKey),
-          value: resultValue,
-          static: member.static,
-        }),
+        ),
         deps,
       ];
     }