flow-api-translator 0.36.1 → 0.37.0

package/dist/flowToFlowDef.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", {
@@ -49,7 +40,6 @@ function getTopLevelStatement(node, context) {
     var _currentNode$parent;
 
     if (((_currentNode$parent = currentNode.parent) == null ? void 0 : _currentNode$parent.type) === 'Program') {
-      // $FlowFixMe[incompatible-type]
       return currentNode;
     }
 
@@ -60,20 +50,10 @@ function getTopLevelStatement(node, context) {
 }
 
 function transferProgramStatementProperties(stmt, orgStmt) {
-  // $FlowExpectedError[prop-missing]
-  // $FlowExpectedError[incompatible-use]
-  stmt.comments = orgStmt.comments; // $FlowExpectedError[incompatible-use]
-
-  stmt.range = orgStmt.range; // $FlowExpectedError[incompatible-use]
-
+  stmt.comments = orgStmt.comments;
+  stmt.range = orgStmt.range;
   stmt.loc = orgStmt.loc;
 }
-/**
- * Consume an arbitrary Flow AST and convert it into a type definition file.
- *
- * To do this all runtime logic will be stripped and only types that describe the module boundary will remain.
- */
-
 
 function flowToFlowDef(ast, code, scopeManager, opts) {
   var _ast$interpreter$valu, _ast$interpreter;
@@ -123,8 +103,7 @@ function flowToFlowDef(ast, code, scopeManager, opts) {
   function updateProcessedStatement(stmt) {
     processedStatements.add(stmt);
     pendingStatements.delete(stmt);
-  } // Process all export statements
-
+  }
 
   for (const stmt of ast.body) {
     const resultExport = convertExport(stmt, context);
@@ -203,14 +182,11 @@ function convertExport(stmt, context) {
         if (expr.type === 'AssignmentExpression' && expr.left.type === 'MemberExpression') {
           const member = expr.left;
 
-          if ( // exports.A = 1;
-          member.object.type === 'Identifier' && member.object.name === 'exports' || // module.exports.A = 1;
-          member.object.type === 'MemberExpression' && member.object.object.type === 'Identifier' && member.object.object.name === 'module' && member.object.property.type === 'Identifier' && member.object.property.name === 'exports') {
+          if (member.object.type === 'Identifier' && member.object.name === 'exports' || member.object.type === 'MemberExpression' && member.object.object.type === 'Identifier' && member.object.object.name === 'module' && member.object.property.type === 'Identifier' && member.object.property.name === 'exports') {
             throw (0, _ErrorUtils.translationError)(stmt, `convertExport: Named CommonJS exports not supported. Use either \`module.exports = {...}\` or ES6 exports.`, context);
           }
 
-          if ( // exports.A = 1;
-          member.object.type === 'Identifier' && member.object.name === 'module' && member.property.type === 'Identifier' && member.property.name === 'exports') {
+          if (member.object.type === 'Identifier' && member.object.name === 'module' && member.property.type === 'Identifier' && member.property.name === 'exports') {
             const [typeAnnotation, deps] = convertExpressionToTypeAnnotation(expr.right, context);
             return [_hermesTransform.t.DeclareModuleExports({
               typeAnnotation: _hermesTransform.t.TypeAnnotation({
@@ -225,14 +201,12 @@ function convertExport(stmt, context) {
 
     default:
       {
-        // Skip non exported functions
         return null;
       }
   }
 }
 
 function stripUnusedDefs(detachedStmt, usedDeps, context) {
-  // $FlowExpectedError[incompatible-type]
   const stmt = detachedStmt;
 
   switch (stmt.type) {
@@ -315,6 +289,12 @@ function convertStatement(stmt, context) {
 
     case 'VariableDeclaration':
       {
+        const requireImport = convertRequireToImport(stmt);
+
+        if (requireImport != null) {
+          return requireImport;
+        }
+
         const [result, deps] = convertVariableDeclaration(stmt, context);
         return [result, deps];
       }
@@ -396,7 +376,6 @@ function convertExpressionToTypeAnnotation(expr, context) {
 }
 
 function inheritComments(fromNode, toNode) {
-  // $FlowFixMe[unclear-type]
   toNode.comments = fromNode.comments;
   return toNode;
 }
@@ -425,7 +404,6 @@ function convertObjectExpression(expr, context) {
 
             const [resultExpr, deps] = convertAFunction(prop.value, context);
             return [inheritComments(prop, _hermesTransform.t.ObjectTypeMethodSignature({
-              // $FlowFixMe[incompatible-type]
               key: (0, _hermesTransform.asDetachedNode)(prop.key),
               value: resultExpr
             })), deps];
@@ -439,7 +417,6 @@ function convertObjectExpression(expr, context) {
             const kind = prop.kind;
             const [resultExpr, deps] = convertAFunction(prop.value, context);
             return [inheritComments(prop, _hermesTransform.t.ObjectTypeAccessorSignature({
-              // $FlowFixMe[incompatible-type]
               key: (0, _hermesTransform.asDetachedNode)(prop.key),
               kind,
               value: resultExpr
@@ -448,7 +425,6 @@ function convertObjectExpression(expr, context) {
 
           const [resultExpr, deps] = convertExpressionToTypeAnnotation(prop.value, context);
           return [inheritComments(prop, _hermesTransform.t.ObjectTypePropertySignature({
-            // $FlowFixMe[incompatible-type]
             key: (0, _hermesTransform.asDetachedNode)(prop.key),
             value: resultExpr,
             optional: false,
@@ -726,6 +702,76 @@ function convertVariableDeclaration(stmt, context) {
   }), annotDeps];
 }
 
+function convertRequireToImport(stmt) {
+  if (stmt.declarations.length !== 1) {
+    return null;
+  }
+
+  const decl = stmt.declarations[0];
+  const init = decl.init;
+
+  if (init == null || init.type !== 'CallExpression' || init.callee.type !== 'Identifier' || init.callee.name !== 'require' || init.arguments.length !== 1) {
+    return null;
+  }
+
+  const sourceArg = init.arguments[0];
+
+  if (!(0, _hermesEstree.isStringLiteral)(sourceArg)) {
+    return null;
+  }
+
+  const id = decl.id;
+
+  if (id.type === 'Identifier') {
+    return [_hermesTransform.t.ImportDeclaration({
+      importKind: 'value',
+      source: (0, _hermesTransform.asDetachedNode)(sourceArg),
+      specifiers: [_hermesTransform.t.ImportDefaultSpecifier({
+        local: _hermesTransform.t.Identifier({
+          name: id.name
+        })
+      })],
+      attributes: []
+    }), []];
+  }
+
+  if (id.type === 'ObjectPattern') {
+    const specifiers = [];
+
+    for (const prop of id.properties) {
+      if (prop.type === 'RestElement') {
+        return null;
+      }
+
+      const key = prop.key;
+      const value = prop.value;
+
+      if (key.type !== 'Identifier' || value.type !== 'Identifier') {
+        return null;
+      }
+
+      specifiers.push(_hermesTransform.t.ImportSpecifier({
+        imported: _hermesTransform.t.Identifier({
+          name: key.name
+        }),
+        local: _hermesTransform.t.Identifier({
+          name: value.name
+        }),
+        importKind: null
+      }));
+    }
+
+    return [_hermesTransform.t.ImportDeclaration({
+      importKind: 'value',
+      source: (0, _hermesTransform.asDetachedNode)(sourceArg),
+      specifiers,
+      attributes: []
+    }), []];
+  }
+
+  return null;
+}
+
 function convertImportDeclaration(stmt, context) {
   if (stmt.attributes.length > 0) {
     throw (0, _ErrorUtils.translationError)(stmt, 'ImportDeclaration: attributes not supported', context);
@@ -754,7 +800,6 @@ function convertClassDeclaration(class_, context) {
   }
 
   return [_hermesTransform.t.DeclareClass({
-    // $FlowFixMe[incompatible-type]
     id: (0, _hermesTransform.asDetachedNode)(class_.id),
     typeParameters: resultTypeParams,
     implements: class_.implements.map(impl => (0, _hermesTransform.asDetachedNode)(impl)),
@@ -886,7 +931,6 @@ function convertClassMember(member, context) {
       {
         var _member$value;
 
-        // PrivateIdentifier's are not exposed so can be stripped.
         if (member.key.type === 'PrivateIdentifier') {
           return EMPTY_TRANSLATION_RESULT;
         }
@@ -902,7 +946,6 @@ 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 [inheritComments(member, _hermesTransform.t.ObjectTypePropertySignature({
-            // $FlowFixMe[incompatible-type]
             key: (0, _hermesTransform.asDetachedNode)(member.key),
             value: resultTypeAnnotation,
             optional: member.optional,
@@ -913,7 +956,6 @@ function convertClassMember(member, context) {
 
         const [resultTypeAnnotation, deps] = convertTypeAnnotation(member.typeAnnotation, member, context);
         return [inheritComments(member, _hermesTransform.t.ObjectTypePropertySignature({
-          // $FlowFixMe[incompatible-type]
           key: (0, _hermesTransform.asDetachedNode)(member.key),
           value: resultTypeAnnotation,
           optional: member.optional,
@@ -924,7 +966,6 @@ function convertClassMember(member, context) {
 
     case 'MethodDefinition':
       {
-        // PrivateIdentifier's are not exposed so can be stripped.
         if (member.key.type === 'PrivateIdentifier') {
           return EMPTY_TRANSLATION_RESULT;
         }
@@ -943,10 +984,8 @@ function convertClassMember(member, context) {
         }) : member.key;
 
         if (member.kind === 'get' || member.kind === 'set') {
-          // accessors are methods - but flow accessor signatures are properties
           const kind = member.kind;
           return [inheritComments(member, _hermesTransform.t.ObjectTypeAccessorSignature({
-            // $FlowFixMe[incompatible-type]
             key: (0, _hermesTransform.asDetachedNode)(newKey),
             value: resultValue,
             static: member.static,
@@ -955,7 +994,6 @@ function convertClassMember(member, context) {
         }
 
         return [inheritComments(member, _hermesTransform.t.ObjectTypeMethodSignature({
-          // $FlowFixMe[incompatible-type]
           key: (0, _hermesTransform.asDetachedNode)(newKey),
           value: resultValue,
           static: member.static
@@ -1115,8 +1153,7 @@ function convertHookDeclaration(hook, context) {
   var _hook$returnType;
 
   const id = hook.id;
-  const returnType = (_hook$returnType = hook.returnType) != null ? _hook$returnType : // $FlowFixMe[incompatible-type]
-  _hermesTransform.t.TypeAnnotation({
+  const returnType = (_hook$returnType = hook.returnType) != null ? _hook$returnType : _hermesTransform.t.TypeAnnotation({
     typeAnnotation: _hermesTransform.t.VoidTypeAnnotation()
   });
   const [resultReturnType, returnDeps] = convertTypeAnnotation(returnType, hook, context);
@@ -1206,8 +1243,7 @@ function convertFunctionParameters(params, context) {
             throw (0, _ErrorUtils.translationError)(param, `FunctionParameter: Multiple rest elements found`, context);
           }
 
-          const [resultParam, deps] = convertBindingNameToFunctionTypeParam( // $FlowFixMe[incompatible-type] I dont think these other cases are possible
-          param.argument, context, index, false);
+          const [resultParam, deps] = convertBindingNameToFunctionTypeParam(param.argument, context, index, false);
           return [resultParams, resultParam, [...paramsDeps, ...deps]];
         }
     }

package/dist/flowToFlowDef.js.flow

@@ -91,12 +91,12 @@ import {
 
 const EMPTY_TRANSLATION_RESULT: TranslatedResultOrNull<empty> = [null, []];
 
-type TranslatedDeps = $ReadOnlyArray<Dep>;
-type TranslatedResultOrNull<+T> = Readonly<
+type TranslatedDeps = ReadonlyArray<Dep>;
+type TranslatedResultOrNull<out T> = Readonly<
   [DetachedNode<T> | null, TranslatedDeps],
 >;
 type TranslatedResultArray<T> = [
-  $ReadOnlyArray<DetachedNode<T>>,
+  ReadonlyArray<DetachedNode<T>>,
   TranslatedDeps,
 ];
 type TranslatedResult<T> = [DetachedNode<T>, TranslatedDeps];
@@ -104,7 +104,7 @@ type TranslatedResult<T> = [DetachedNode<T>, TranslatedDeps];
 type ProgramStatement = Statement | ModuleDeclaration;
 
 function convertArray<TIn, TOut>(
-  items: $ReadOnlyArray<TIn>,
+  items: ReadonlyArray<TIn>,
   convert: TIn => TranslatedResultOrNull<TOut>,
 ): TranslatedResultArray<TOut> {
   const resultItems: Array<DetachedNode<TOut>> = [];
@@ -409,6 +409,10 @@ function convertStatement(
       return [result, deps];
     }
     case 'VariableDeclaration': {
+      const requireImport = convertRequireToImport(stmt);
+      if (requireImport != null) {
+        return requireImport;
+      }
       const [result, deps] = convertVariableDeclaration(stmt, context);
       return [result, deps];
     }
@@ -486,12 +490,12 @@ function convertExpressionToTypeAnnotation(
   }
 }
 
-function inheritComments<T: DetachedNode<ESNode>>(
+function inheritComments<T extends DetachedNode<ESNode>>(
   fromNode: ESNode,
   toNode: T,
 ): T {
   // $FlowFixMe[unclear-type]
-  (toNode: any).comments = (fromNode: any).comments;
+  (toNode as any).comments = (fromNode as any).comments;
   return toNode;
 }
 
@@ -663,7 +667,7 @@ function convertLiteral(
 function convertExportDeclaration(
   decl:
     | ExportDefaultDeclaration['declaration']
-    | $NonMaybeType<ExportNamedDeclaration['declaration']>,
+    | NonNullable<ExportNamedDeclaration['declaration']>,
   opts: {default: boolean},
   context: TranslationContext,
 ): TranslatedResult<ProgramStatement> {
@@ -831,8 +835,8 @@ function convertExportDefaultDeclaration(
   context: TranslationContext,
 ): TranslatedResult<ProgramStatement> {
   const expr = stmt.declaration;
-  if (isExpression(expr) && (expr: $FlowFixMe).type === 'Identifier') {
-    const name = ((expr: $FlowFixMe): Identifier).name;
+  if (isExpression(expr) && (expr as $FlowFixMe).type === 'Identifier') {
+    const name = (expr as $FlowFixMe as Identifier).name;
     const [declDecl, deps] = [
       t.TypeofTypeAnnotation({argument: t.Identifier({name})}),
       analyzeTypeDependencies(expr, context),
@@ -939,6 +943,78 @@ function convertVariableDeclaration(
   ];
 }
 
+function convertRequireToImport(
+  stmt: VariableDeclaration,
+): ?TranslatedResult<ProgramStatement> {
+  if (stmt.declarations.length !== 1) {
+    return null;
+  }
+  const decl = stmt.declarations[0];
+  const init = decl.init;
+  if (
+    init == null ||
+    init.type !== 'CallExpression' ||
+    init.callee.type !== 'Identifier' ||
+    init.callee.name !== 'require' ||
+    init.arguments.length !== 1
+  ) {
+    return null;
+  }
+  const sourceArg = init.arguments[0];
+  if (!isStringLiteral(sourceArg)) {
+    return null;
+  }
+  const id = decl.id;
+
+  if (id.type === 'Identifier') {
+    return [
+      t.ImportDeclaration({
+        importKind: 'value',
+        source: asDetachedNode(sourceArg),
+        specifiers: [
+          t.ImportDefaultSpecifier({
+            local: t.Identifier({name: id.name}),
+          }),
+        ],
+        attributes: [],
+      }),
+      [],
+    ];
+  }
+
+  if (id.type === 'ObjectPattern') {
+    const specifiers = [];
+    for (const prop of id.properties) {
+      if (prop.type === 'RestElement') {
+        return null;
+      }
+      const key = prop.key;
+      const value = prop.value;
+      if (key.type !== 'Identifier' || value.type !== 'Identifier') {
+        return null;
+      }
+      specifiers.push(
+        t.ImportSpecifier({
+          imported: t.Identifier({name: key.name}),
+          local: t.Identifier({name: value.name}),
+          importKind: null,
+        }),
+      );
+    }
+    return [
+      t.ImportDeclaration({
+        importKind: 'value',
+        source: asDetachedNode(sourceArg),
+        specifiers,
+        attributes: [],
+      }),
+      [],
+    ];
+  }
+
+  return null;
+}
+
 function convertImportDeclaration(
   stmt: ImportDeclaration,
   context: TranslationContext,
@@ -1371,13 +1447,13 @@ function convertComponentDeclaration(
 }
 
 type TranslatedComponentParametersResults = [
-  $ReadOnlyArray<DetachedNode<ComponentTypeParameter>>,
+  ReadonlyArray<DetachedNode<ComponentTypeParameter>>,
   ?DetachedNode<ComponentTypeParameter>,
   TranslatedDeps,
 ];
 
 function hasNonIdentifierStringLiteralParam(
-  params: $ReadOnlyArray<ComponentParameter | RestElement>,
+  params: ReadonlyArray<ComponentParameter | RestElement>,
 ): boolean {
   return params.some(
     param =>
@@ -1408,7 +1484,7 @@ function extractParamTypeInfo(
 }
 
 function convertComponentParameters(
-  params: $ReadOnlyArray<ComponentParameter | RestElement>,
+  params: ReadonlyArray<ComponentParameter | RestElement>,
   context: TranslationContext,
 ): TranslatedComponentParametersResults {
   if (hasNonIdentifierStringLiteralParam(params)) {
@@ -1490,7 +1566,7 @@ function convertComponentParameters(
 }
 
 function convertComponentParametersToPropsObject(
-  params: $ReadOnlyArray<ComponentParameter | RestElement>,
+  params: ReadonlyArray<ComponentParameter | RestElement>,
   context: TranslationContext,
 ): TranslatedComponentParametersResults {
   const properties: Array<
@@ -1673,12 +1749,12 @@ function convertAFunction(
 }
 
 type TranslatedFunctionParametersResults = [
-  $ReadOnlyArray<DetachedNode<FunctionTypeParam>>,
+  ReadonlyArray<DetachedNode<FunctionTypeParam>>,
   ?DetachedNode<FunctionTypeParam>,
   TranslatedDeps,
 ];
 function convertFunctionParameters(
-  params: $ReadOnlyArray<FunctionParameter>,
+  params: ReadonlyArray<FunctionParameter>,
   context: TranslationContext,
 ): TranslatedFunctionParametersResults {
   return params.reduce<TranslatedFunctionParametersResults>(

package/dist/flowToJS.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/index.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", {
@@ -62,8 +53,7 @@ async function translateFlowDefToTSDef(code, prettierOptions = {}) {
   const [tsAST, mutatedCode] = (0, _flowDefToTSDef.flowDefToTSDef)(code, ast, scopeManager, {
     recoverFromErrors: true
   });
-  return (0, _hermesTransform.print)( // $FlowExpectedError[incompatible-type] - this is fine as we're providing the visitor keys
-  tsAST, mutatedCode, { ...prettierOptions
+  return (0, _hermesTransform.print)(tsAST, mutatedCode, { ...prettierOptions
   }, _visitorKeys.visitorKeys);
 }
 
@@ -75,18 +65,6 @@ async function translateFlowToJS(code, prettierOptions = {}) {
   const jsAST = (0, _flowToJS.flowToJS)(ast, code, scopeManager);
   return (0, _hermesTransform.print)(jsAST, code, prettierOptions);
 }
-/**
- * This translator is very experimental and unstable.
- *
- * It is not written with productionizing it in mind, but instead used to evaluate how close Flow
- * is to TypeScript.
- *
- * If you are going to use it anyways, you agree that you are calling a potentially broken function
- * without any guarantee.
- *
- * @deprecated
- */
-
 
 async function unstable_translateTSDefToFlowDef(code, prettierOptions = {}) {
   const ast = (0, _parser.parse)(code, {