flow-api-translator 0.36.0 → 0.37.0

package/dist/src/utils/TSNodeUtils.js

@@ -0,0 +1,68 @@
+'use strict';
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.extractPropertyKeyLiterals = extractPropertyKeyLiterals;
+
+var TSESTree = _interopRequireWildcard(require("./ts-estree-ast-types"));
+
+function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
+
+function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
+
+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;
+}

package/dist/src/utils/TranslationUtils.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", {
@@ -15,7 +6,8 @@ Object.defineProperty(exports, "__esModule", {
 exports.createTranslationContext = createTranslationContext;
 
 function createTranslationContext(code, scopeManager, {
-  recoverFromErrors
+  recoverFromErrors,
+  mungeUnderscores = true
 }) {
   const referenceMap = new Map();
   const variableMap = new Map();
@@ -37,6 +29,7 @@ function createTranslationContext(code, scopeManager, {
     referenceMap,
     variableMap,
     recoverFromErrors,
+    mungeUnderscores,
     code
   };
 }

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", {
@@ -21,7 +12,6 @@ function removeAtFlowFromDocblock(docblock) {
   }
 
   return {
-    // $FlowExpectedError[cannot-spread-interface]
     comment: { ...docblock.comment,
       value: docblock.comment.value.replace(FLOW_DIRECTIVE, '')
     },

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", {
@@ -37,18 +28,7 @@ function flowFixMeOrError(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';
   }
 
@@ -83,7 +63,6 @@ function 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

@@ -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);
 }

package/dist/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", {
@@ -24,9 +15,7 @@ function analyzeFunctionReturn(func) {
 
   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()
@@ -43,6 +32,8 @@ function analyzeTypeDependencies(rootNode, context) {
 
         if (variable != null) {
           deps.push(variable.name);
+        } else if (context.variableMap.has(node.name)) {
+          deps.push(node.name);
         }
       }
     },

package/dist/utils/FlowAnalyze.js.flow

@@ -30,7 +30,7 @@ export function analyzeFunctionReturn(func: AFunction): TypeAnnotation {
 export function analyzeTypeDependencies(
   rootNode: ESNode,
   context: TranslationContext,
-): $ReadOnlyArray<Dep> {
+): ReadonlyArray<Dep> {
   const deps = [];
   SimpleTraverser.traverse(rootNode, {
     enter(node: ESNode) {
@@ -38,6 +38,11 @@ export function analyzeTypeDependencies(
         const variable = context.referenceMap.get(node);
         if (variable != null) {
           deps.push(variable.name);
+        } else if (context.variableMap.has(node.name)) {
+          // The scope manager may not track type references to value
+          // variables (e.g. `const Foo = require('foo')` used as `Foo`
+          // in a GenericTypeAnnotation). Fall back to variableMap.
+          deps.push(node.name);
         }
       }
     },

package/dist/utils/TSNodeUtils.js

@@ -0,0 +1,68 @@
+'use strict';
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.extractPropertyKeyLiterals = extractPropertyKeyLiterals;
+
+var TSESTree = _interopRequireWildcard(require("./ts-estree-ast-types"));
+
+function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
+
+function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
+
+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;
+}

package/dist/utils/TSNodeUtils.js.flow

@@ -0,0 +1,74 @@
+/**
+ * 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.
+ *
+ * @flow strict-local
+ * @format
+ */
+
+'use strict';
+
+import type {SourceLocation} from 'hermes-estree';
+
+import * as TSESTree from './ts-estree-ast-types';
+
+const DUMMY_LOC: SourceLocation = {
+  start: {line: 1, column: 0},
+  end: {line: 1, column: 0},
+};
+
+/**
+ * Extract statically known property key names from a list of TS type element
+ * nodes and return them as `TSLiteralType` (string literal) AST nodes.
+ *
+ * Returns `null` if any member has a computed or non-extractable key,
+ * or if the list is empty.
+ */
+export function extractPropertyKeyLiterals(
+  members: ReadonlyArray<TSESTree.TypeElement>,
+): Array<TSESTree.TSLiteralType> | null {
+  // An empty member list has no keys to extract. Returning `null` here lets
+  // the caller fall back to `keyof {}`, preserving the original output for
+  // spread-only objects (e.g. `{...T1}`) where a literal union would be
+  // invalid TS.
+  if (members.length === 0) {
+    return null;
+  }
+  const literals: Array<TSESTree.TSLiteralType> = [];
+  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}'`,
+        } as TSESTree.StringLiteral,
+      });
+    } else if (key.type === 'Literal') {
+      // A string or numeric literal key is already a valid literal type.
+      literals.push({
+        type: 'TSLiteralType',
+        loc: DUMMY_LOC,
+        literal: key,
+      });
+    } else {
+      return null;
+    }
+  }
+  return literals;
+}

package/dist/utils/TranslationUtils.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", {
@@ -15,7 +6,8 @@ Object.defineProperty(exports, "__esModule", {
 exports.createTranslationContext = createTranslationContext;
 
 function createTranslationContext(code, scopeManager, {
-  recoverFromErrors
+  recoverFromErrors,
+  mungeUnderscores = true
 }) {
   const referenceMap = new Map();
   const variableMap = new Map();
@@ -37,6 +29,7 @@ function createTranslationContext(code, scopeManager, {
     referenceMap,
     variableMap,
     recoverFromErrors,
+    mungeUnderscores,
     code
   };
 }

package/dist/utils/TranslationUtils.js.flow

@@ -14,19 +14,23 @@ import type {Identifier, JSXIdentifier} from 'hermes-estree';
 import type {ScopeManager, Variable} from 'hermes-eslint';
 
 export type Dep = string;
-export type TranslationOptions = {recoverFromErrors: boolean};
+export type TranslationOptions = {
+  recoverFromErrors: boolean,
+  mungeUnderscores?: boolean,
+};
 export type TranslationContext = {
   scopeManager: ScopeManager,
   referenceMap: Map<Identifier | JSXIdentifier, Variable>,
   variableMap: Map<Dep, Variable>,
   recoverFromErrors: boolean,
+  mungeUnderscores: boolean,
   code: string,
 };
 
 export function createTranslationContext(
   code: string,
   scopeManager: ScopeManager,
-  {recoverFromErrors}: TranslationOptions,
+  {recoverFromErrors, mungeUnderscores = true}: TranslationOptions,
 ): TranslationContext {
   const referenceMap = new Map<Identifier | JSXIdentifier, Variable>();
   const variableMap = new Map<Dep, Variable>();
@@ -40,5 +44,12 @@ export function createTranslationContext(
       variableMap.set(variable.name, variable);
     }
   }
-  return {scopeManager, referenceMap, variableMap, recoverFromErrors, code};
+  return {
+    scopeManager,
+    referenceMap,
+    variableMap,
+    recoverFromErrors,
+    mungeUnderscores,
+    code,
+  };
 }

package/dist/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';