flow-api-translator 0.36.1 → 0.327.0

package/dist/src/flowToJS.js

@@ -1,39 +1,23 @@
-/**
- * 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", {
   value: true
 });
 exports.flowToJS = flowToJS;
-
-var _hermesParser = require("hermes-parser");
-
+var _flowParser = require("flow-parser");
 var _DocblockUtils = require("./utils/DocblockUtils");
-
 const {
   nodeWith
-} = _hermesParser.astNodeMutationHelpers;
-
+} = _flowParser.astNodeMutationHelpers;
 function stripAtFlow(ast, _options) {
   const docblock = ast.docblock;
-
   if (docblock == null) {
     return ast;
   }
-
   return nodeWith(ast, {
     docblock: (0, _DocblockUtils.removeAtFlowFromDocblock)(docblock)
   });
 }
-
 function flowToJS(sourceAST, _code, _scopeManager) {
-  return [_hermesParser.Transforms.transformComponentSyntax, _hermesParser.Transforms.stripFlowTypes, stripAtFlow].reduce((ast, transform) => transform(ast, {}), sourceAST);
+  return [_flowParser.Transforms.transformComponentSyntax, _flowParser.Transforms.stripFlowTypes, stripAtFlow].reduce((ast, transform) => transform(ast, {}), sourceAST);
 }

package/dist/src/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", {
@@ -18,98 +9,69 @@ exports.translateFlowToFlowDef = translateFlowToFlowDef;
 exports.translateFlowToJS = translateFlowToJS;
 exports.translateFlowToTSDef = translateFlowToTSDef;
 exports.unstable_translateTSDefToFlowDef = unstable_translateTSDefToFlowDef;
-
-var _hermesTransform = require("hermes-transform");
-
+var _flowTransform = require("flow-transform");
 var _parser = require("@typescript-eslint/parser");
-
 var _visitorKeys = require("@typescript-eslint/visitor-keys");
-
 var _flowToFlowDef = _interopRequireDefault(require("./flowToFlowDef"));
-
 var _flowDefToTSDef = require("./flowDefToTSDef");
-
 var _flowToJS = require("./flowToJS");
-
 var _flowImportTo = require("./flowImportTo");
-
 var _TSDefToFlowDef = require("./TSDefToFlowDef");
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
 async function translateFlowToFlowDef(code, prettierOptions = {}, opts) {
   const {
     ast,
     scopeManager
-  } = await (0, _hermesTransform.parse)(code);
+  } = await (0, _flowTransform.parse)(code);
   const [flowDefAst, mutatedCode] = (0, _flowToFlowDef.default)(ast, code, scopeManager, {
     recoverFromErrors: true,
     mungeUnderscores: opts == null ? void 0 : opts.mungeUnderscores
   });
-  return (0, _hermesTransform.print)(flowDefAst, mutatedCode, prettierOptions);
+  return (0, _flowTransform.print)(flowDefAst, mutatedCode, prettierOptions);
 }
-
 async function translateFlowToTSDef(code, prettierOptions = {}) {
   const flowDefCode = await translateFlowToFlowDef(code, prettierOptions);
   return translateFlowDefToTSDef(flowDefCode, prettierOptions);
 }
-
 async function translateFlowDefToTSDef(code, prettierOptions = {}) {
   const {
     ast,
     scopeManager
-  } = await (0, _hermesTransform.parse)(code);
+  } = await (0, _flowTransform.parse)(code);
   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, _flowTransform.print)(tsAST, mutatedCode, {
+    ...prettierOptions
   }, _visitorKeys.visitorKeys);
 }
-
 async function translateFlowToJS(code, prettierOptions = {}) {
   const {
     ast,
     scopeManager
-  } = await (0, _hermesTransform.parse)(code);
+  } = await (0, _flowTransform.parse)(code);
   const jsAST = (0, _flowToJS.flowToJS)(ast, code, scopeManager);
-  return (0, _hermesTransform.print)(jsAST, code, prettierOptions);
+  return (0, _flowTransform.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, {
     loc: true,
     range: true,
     sourceType: 'module'
   });
-
   if (ast == null) {
     throw `Failed to parse ${code} with @typescript-eslint/parser`;
   }
-
   const [flowAST, mutatedCode] = (0, _TSDefToFlowDef.TSDefToFlowDef)(code, ast, {
     recoverFromErrors: false
   });
-  return (0, _hermesTransform.print)(flowAST, mutatedCode, prettierOptions);
+  return (0, _flowTransform.print)(flowAST, mutatedCode, prettierOptions);
 }
-
 async function translateFlowImportsTo(code, prettierOptions = {}, opts) {
   const {
     ast,
     scopeManager
-  } = await (0, _hermesTransform.parse)(code);
+  } = await (0, _flowTransform.parse)(code);
   const jsAST = (0, _flowImportTo.flowImportTo)(ast, code, scopeManager, opts);
-  return (0, _hermesTransform.print)(jsAST, code, prettierOptions);
+  return (0, _flowTransform.print)(jsAST, code, prettierOptions);
 }

package/dist/src/utils/DocblockUtils.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", {
@@ -14,18 +5,17 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.removeAtFlowFromDocblock = removeAtFlowFromDocblock;
 const FLOW_DIRECTIVE = /(@flow(\s+(strict(-local)?|weak))?|@noflow)/;
-
 function removeAtFlowFromDocblock(docblock) {
   if (!FLOW_DIRECTIVE.test(docblock.comment.value)) {
     return docblock;
   }
-
   return {
-    // $FlowExpectedError[cannot-spread-interface]
-    comment: { ...docblock.comment,
+    comment: {
+      ...docblock.comment,
       value: docblock.comment.value.replace(FLOW_DIRECTIVE, '')
     },
-    directives: { ...docblock.directives,
+    directives: {
+      ...docblock.directives,
       flow: undefined,
       noflow: undefined
     }

package/dist/src/utils/ErrorUtils.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", {
@@ -17,73 +8,46 @@ exports.buildCodeFrame = buildCodeFrame;
 exports.flowFixMeOrError = flowFixMeOrError;
 exports.translationError = translationError;
 exports.unexpectedTranslationError = unexpectedTranslationError;
-
-var _hermesTransform = require("hermes-transform");
-
+var _flowTransform = require("flow-transform");
 var _codeFrame = require("@babel/code-frame");
-
 function flowFixMeOrError(container, message, context) {
   if (context.recoverFromErrors) {
-    return _hermesTransform.t.GenericTypeAnnotation({
-      id: _hermesTransform.t.Identifier({
+    return _flowTransform.t.GenericTypeAnnotation({
+      id: _flowTransform.t.Identifier({
         name: '$FlowFixMe'
       })
     });
   }
-
   throw translationError(container, message, context);
 }
-
 class TranslationErrorBase extends Error {
   constructor(node, message, context) {
     const framedMessage = buildCodeFrame(node, message, context.code);
-    super( // jest error snapshots will use a hard-coded string representation if
-    // `instanceof Error` which makes the code frame look awful and hard to verify:
-    //
-    // [TranslationError: > 12 | code
-    //       | ^^^^ error]
-    //
-    // this just adds a newline in jest tests so that it all lines up nicely
-    //
-    // [TranslationError:
-    // > 12 | code
-    //      | ^^^^ error]
-    process.env.JEST_WORKER_ID == null ? framedMessage : `\n${framedMessage}`);
+    super(process.env.JEST_WORKER_ID == null ? framedMessage : `\n${framedMessage}`);
     this.name = 'TranslationError';
   }
-
 }
-
 class ExpectedTranslationError extends TranslationErrorBase {
   constructor(...args) {
     super(...args);
     this.name = 'ExpectedTranslationError';
   }
-
 }
-
 exports.ExpectedTranslationError = ExpectedTranslationError;
-
 function translationError(node, message, context) {
   return new ExpectedTranslationError(node, message, context);
 }
-
 class UnexpectedTranslationError extends TranslationErrorBase {
   constructor(...args) {
     super(...args);
     this.name = 'UnexpectedTranslationError';
   }
-
 }
-
 exports.UnexpectedTranslationError = UnexpectedTranslationError;
-
 function unexpectedTranslationError(node, message, context) {
   return new UnexpectedTranslationError(node, message, context);
 }
-
 function buildCodeFrame(node, message, code, highlightCode = process.env.NODE_ENV !== 'test') {
-  // babel uses 1-indexed columns
   const locForBabel = {
     start: {
       line: node.loc.start.line,

package/dist/src/utils/FlowAnalyze.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", {
@@ -14,42 +5,31 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.analyzeFunctionReturn = analyzeFunctionReturn;
 exports.analyzeTypeDependencies = analyzeTypeDependencies;
-
-var _hermesTransform = require("hermes-transform");
-
-var _hermesParser = require("hermes-parser");
-
+var _flowTransform = require("flow-transform");
+var _flowParser = require("flow-parser");
 function analyzeFunctionReturn(func) {
   const returnType = func.returnType;
-
   if (returnType != null) {
     return returnType;
-  } // We trust Flow has validated this function to only return void
-  // $FlowFixMe[incompatible-type]
-
-
-  return _hermesTransform.t.TypeAnnotation({
-    typeAnnotation: _hermesTransform.t.VoidTypeAnnotation()
+  }
+  return _flowTransform.t.TypeAnnotation({
+    typeAnnotation: _flowTransform.t.VoidTypeAnnotation()
   });
 }
-
 function analyzeTypeDependencies(rootNode, context) {
   const deps = [];
-
-  _hermesParser.SimpleTraverser.traverse(rootNode, {
+  _flowParser.SimpleTraverser.traverse(rootNode, {
     enter(node) {
       if (node.type === 'Identifier' || node.type === 'JSXIdentifier') {
         const variable = context.referenceMap.get(node);
-
         if (variable != null) {
           deps.push(variable.name);
+        } else if (context.variableMap.has(node.name)) {
+          deps.push(node.name);
         }
       }
     },
-
     leave() {}
-
   });
-
   return deps;
 }

package/dist/src/utils/TSNodeUtils.js

@@ -0,0 +1,83 @@
+'use strict';
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.ensureTypeIncludesUndefined = ensureTypeIncludesUndefined;
+exports.extractPropertyKeyLiterals = extractPropertyKeyLiterals;
+var TSESTree = _interopRequireWildcard(require("./ts-estree-ast-types"));
+function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r = new WeakMap(), n = new WeakMap(); return (_interopRequireWildcard = function (e, t) { if (!t && e && e.__esModule) return e; var o, i, f = { __proto__: null, default: e }; if (null === e || "object" != typeof e && "function" != typeof e) return f; if (o = t ? n : r) { if (o.has(e)) return o.get(e); o.set(e, f); } for (const t in e) "default" !== t && {}.hasOwnProperty.call(e, t) && ((i = (o = Object.defineProperty) && Object.getOwnPropertyDescriptor(e, t)) && (i.get || i.set) ? o(f, t, i) : f[t] = e[t]); return f; })(e, t); }
+const DUMMY_LOC = {
+  start: {
+    line: 1,
+    column: 0
+  },
+  end: {
+    line: 1,
+    column: 0
+  }
+};
+function extractPropertyKeyLiterals(members) {
+  if (members.length === 0) {
+    return null;
+  }
+  const literals = [];
+  for (const member of members) {
+    if (member.type !== 'TSPropertySignature' && member.type !== 'TSMethodSignature') {
+      return null;
+    }
+    if (member.computed === true) {
+      return null;
+    }
+    const {
+      key
+    } = member;
+    if (key.type === 'Identifier') {
+      literals.push({
+        type: 'TSLiteralType',
+        loc: DUMMY_LOC,
+        literal: {
+          type: 'Literal',
+          loc: DUMMY_LOC,
+          value: key.name,
+          raw: `'${key.name}'`
+        }
+      });
+    } else if (key.type === 'Literal') {
+      literals.push({
+        type: 'TSLiteralType',
+        loc: DUMMY_LOC,
+        literal: key
+      });
+    } else {
+      return null;
+    }
+  }
+  return literals;
+}
+function ensureTypeIncludesUndefined(typeAnnotation) {
+  if (typeAnnotation.type === 'TSUndefinedKeyword') {
+    return typeAnnotation;
+  }
+  if (typeAnnotation.type === 'TSUnionType') {
+    if (typeAnnotation.types.some(type => type.type === 'TSUndefinedKeyword')) {
+      return typeAnnotation;
+    }
+    return {
+      type: 'TSUnionType',
+      loc: DUMMY_LOC,
+      types: [...typeAnnotation.types, {
+        type: 'TSUndefinedKeyword',
+        loc: DUMMY_LOC
+      }]
+    };
+  }
+  return {
+    type: 'TSUnionType',
+    loc: DUMMY_LOC,
+    types: [typeAnnotation, {
+      type: 'TSUndefinedKeyword',
+      loc: DUMMY_LOC
+    }]
+  };
+}

package/dist/src/utils/TranslationUtils.js

@@ -1,19 +1,9 @@
-/**
- * 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", {
   value: true
 });
 exports.createTranslationContext = createTranslationContext;
-
 function createTranslationContext(code, scopeManager, {
   recoverFromErrors,
   mungeUnderscores = true
@@ -21,18 +11,15 @@ function createTranslationContext(code, scopeManager, {
   const referenceMap = new Map();
   const variableMap = new Map();
   const moduleScope = scopeManager.globalScope.childScopes[0];
-
   if (moduleScope == null || moduleScope.type !== 'module') {
     throw new Error('createTranslationContext: Module scope not found');
   }
-
   for (const variable of moduleScope.variables) {
     for (const reference of variable.references) {
       referenceMap.set(reference.identifier, variable);
       variableMap.set(variable.name, variable);
     }
   }
-
   return {
     scopeManager,
     referenceMap,

package/dist/src/utils/ts-estree-ast-types.js

@@ -1,30 +1 @@
-/**
- * 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
- */
-
-/**
- * The following types have been adapted by hand from
- * https://unpkg.com/browse/@typescript-eslint/types@5.41.0/dist/generated/ast-spec.d.ts
- *
- * Changes:
- * - remove and inline `ValueOf` type
- * - `undefined` -> `void`
- * - remove all `declare` keywords
- * - comment out `bigint` type
- *     -> flow doesn't support it yet
- * - remove `range` and `loc` from `NodeOrTokenData`
- *     -> during conversion our locations will be all off, so we'll rely on prettier to print later
- * - make all properties readonly and all arrays $ReadOnlyArray
- *     -> unlike TS - flow enforces subtype constraints strictly!
- * - add `type` to interfaces that previously relied upon inheriting the `type`
- *     -> this is because flow sentinel refinement does not check inherited members
- * - create "Ambiguous" versions for some nodes that have unions (like PropertyDefinition, MemberDefinition)
- *     -> makes it easier to construct them from other nodes that have unions
- */
 'use strict';

package/dist/utils/DocblockUtils.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", {
@@ -14,18 +5,17 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.removeAtFlowFromDocblock = removeAtFlowFromDocblock;
 const FLOW_DIRECTIVE = /(@flow(\s+(strict(-local)?|weak))?|@noflow)/;
-
 function removeAtFlowFromDocblock(docblock) {
   if (!FLOW_DIRECTIVE.test(docblock.comment.value)) {
     return docblock;
   }
-
   return {
-    // $FlowExpectedError[cannot-spread-interface]
-    comment: { ...docblock.comment,
+    comment: {
+      ...docblock.comment,
       value: docblock.comment.value.replace(FLOW_DIRECTIVE, '')
     },
-    directives: { ...docblock.directives,
+    directives: {
+      ...docblock.directives,
       flow: undefined,
       noflow: undefined
     }

package/dist/utils/DocblockUtils.js.flow

@@ -10,7 +10,7 @@
 
 'use strict';
 
-import type {DocblockMetadata} from 'hermes-estree';
+import type {DocblockMetadata} from 'flow-estree';
 
 const FLOW_DIRECTIVE = /(@flow(\s+(strict(-local)?|weak))?|@noflow)/;
 

package/dist/utils/ErrorUtils.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", {
@@ -17,73 +8,46 @@ exports.buildCodeFrame = buildCodeFrame;
 exports.flowFixMeOrError = flowFixMeOrError;
 exports.translationError = translationError;
 exports.unexpectedTranslationError = unexpectedTranslationError;
-
-var _hermesTransform = require("hermes-transform");
-
+var _flowTransform = require("flow-transform");
 var _codeFrame = require("@babel/code-frame");
-
 function flowFixMeOrError(container, message, context) {
   if (context.recoverFromErrors) {
-    return _hermesTransform.t.GenericTypeAnnotation({
-      id: _hermesTransform.t.Identifier({
+    return _flowTransform.t.GenericTypeAnnotation({
+      id: _flowTransform.t.Identifier({
         name: '$FlowFixMe'
       })
     });
   }
-
   throw translationError(container, message, context);
 }
-
 class TranslationErrorBase extends Error {
   constructor(node, message, context) {
     const framedMessage = buildCodeFrame(node, message, context.code);
-    super( // jest error snapshots will use a hard-coded string representation if
-    // `instanceof Error` which makes the code frame look awful and hard to verify:
-    //
-    // [TranslationError: > 12 | code
-    //       | ^^^^ error]
-    //
-    // this just adds a newline in jest tests so that it all lines up nicely
-    //
-    // [TranslationError:
-    // > 12 | code
-    //      | ^^^^ error]
-    process.env.JEST_WORKER_ID == null ? framedMessage : `\n${framedMessage}`);
+    super(process.env.JEST_WORKER_ID == null ? framedMessage : `\n${framedMessage}`);
     this.name = 'TranslationError';
   }
-
 }
-
 class ExpectedTranslationError extends TranslationErrorBase {
   constructor(...args) {
     super(...args);
     this.name = 'ExpectedTranslationError';
   }
-
 }
-
 exports.ExpectedTranslationError = ExpectedTranslationError;
-
 function translationError(node, message, context) {
   return new ExpectedTranslationError(node, message, context);
 }
-
 class UnexpectedTranslationError extends TranslationErrorBase {
   constructor(...args) {
     super(...args);
     this.name = 'UnexpectedTranslationError';
   }
-
 }
-
 exports.UnexpectedTranslationError = UnexpectedTranslationError;
-
 function unexpectedTranslationError(node, message, context) {
   return new UnexpectedTranslationError(node, message, context);
 }
-
 function buildCodeFrame(node, message, code, highlightCode = process.env.NODE_ENV !== 'test') {
-  // babel uses 1-indexed columns
   const locForBabel = {
     start: {
       line: node.loc.start.line,

package/dist/utils/ErrorUtils.js.flow

@@ -10,11 +10,11 @@
 
 'use strict';
 
-import type {ObjectWithLoc, TypeAnnotationType} from 'hermes-estree';
+import type {ObjectWithLoc, TypeAnnotationType} from 'flow-estree';
 import type {TranslationContext} from './TranslationUtils';
-import type {DetachedNode} from 'hermes-transform';
+import type {DetachedNode} from 'flow-transform';
 
-import {t} from 'hermes-transform';
+import {t} from 'flow-transform';
 import {codeFrameColumns} from '@babel/code-frame';
 
 export function flowFixMeOrError(
@@ -33,7 +33,7 @@ class TranslationErrorBase extends Error {
   constructor(
     node: ObjectWithLoc,
     message: string,
-    context: $ReadOnly<{code: string, ...}>,
+    context: Readonly<{code: string, ...}>,
   ) {
     const framedMessage = buildCodeFrame(node, message, context.code);
     super(
@@ -59,7 +59,7 @@ export class ExpectedTranslationError extends TranslationErrorBase {
 export function translationError(
   node: ObjectWithLoc,
   message: string,
-  context: $ReadOnly<{code: string, ...}>,
+  context: Readonly<{code: string, ...}>,
 ): ExpectedTranslationError {
   return new ExpectedTranslationError(node, message, context);
 }
@@ -70,7 +70,7 @@ export class UnexpectedTranslationError extends TranslationErrorBase {
 export function unexpectedTranslationError(
   node: ObjectWithLoc,
   message: string,
-  context: $ReadOnly<{code: string, ...}>,
+  context: Readonly<{code: string, ...}>,
 ): UnexpectedTranslationError {
   return new UnexpectedTranslationError(node, message, context);
 }