hermes-estree 0.32.1 → 0.33.0

package/dist/types.js.flow

@@ -207,8 +207,17 @@ export type ESNode =
   | MatchPattern
   | MatchRestPattern
   | MatchObjectPatternProperty
+  | MatchInstanceObjectPattern
   | MatchExpressionCase
   | MatchStatementCase
+  // Records
+  | RecordDeclaration
+  | RecordDeclarationImplements
+  | RecordDeclarationBody
+  | RecordDeclarationProperty
+  | RecordDeclarationStaticProperty
+  | RecordExpression
+  | RecordExpressionProperties
   // JSX
   | JSXNode;
 
@@ -276,7 +285,8 @@ export type Statement =
   | VariableDeclaration
   | WhileStatement
   | WithStatement
-  | MatchStatement;
+  | MatchStatement
+  | RecordDeclaration;
 
 // nodes that can be the direct parent of a statement
 export type StatementParentSingle =
@@ -486,6 +496,7 @@ export type Expression =
   | AsExpression
   | AsConstExpression
   | MatchExpression
+  | RecordExpression
   | JSXFragment
   | JSXElement;
 
@@ -510,19 +521,25 @@ export interface ObjectExpression extends BaseNode {
 // and object desturcturing properties.
 export type Property = ObjectProperty | DestructuringObjectProperty;
 
+export type ObjectPropertyKey =
+  | Identifier
+  | StringLiteral
+  | NumericLiteral
+  | BigIntLiteral;
+
 export type ObjectProperty =
   | ObjectPropertyWithNonShorthandStaticName
   | ObjectPropertyWithShorthandStaticName
   | ObjectPropertyWithComputedName;
 interface ObjectPropertyBase extends BaseNode {
-  +parent: ObjectExpression | ObjectPattern;
+  +parent: ObjectExpression | ObjectPattern | RecordExpressionProperties;
 }
 export interface ObjectPropertyWithNonShorthandStaticName
   extends ObjectPropertyBase {
   +type: 'Property';
   +computed: false;
   // non-computed, non-shorthand names are constrained significantly
-  +key: Identifier | StringLiteral | NumericLiteral;
+  +key: ObjectPropertyKey;
   +value: Expression;
   +kind: 'init' | 'get' | 'set';
   +method: boolean;
@@ -568,7 +585,7 @@ export interface DestructuringObjectPropertyWithNonShorthandStaticName
   +type: 'Property';
   +computed: false;
   // non-computed, non-shorthand names are constrained significantly
-  +key: Identifier | StringLiteral | NumericLiteral;
+  +key: ObjectPropertyKey;
   // destructuring properties cannot have any value
   +value: DestructuringPattern;
   +shorthand: false;
@@ -914,7 +931,7 @@ interface BaseClass extends BaseNode {
   +body: ClassBody;
 
   +typeParameters: null | TypeParameterDeclaration;
-  +superTypeParameters: null | TypeParameterInstantiation;
+  +superTypeArguments: null | TypeParameterInstantiation;
   +implements: $ReadOnlyArray<ClassImplements>;
   +decorators: $ReadOnlyArray<Decorator>;
 }
@@ -925,8 +942,7 @@ export type PropertyName =
 export type ClassPropertyNameComputed = Expression;
 export type ClassPropertyNameNonComputed =
   | PrivateIdentifier
-  | Identifier
-  | StringLiteral;
+  | ObjectPropertyKey;
 
 export type ClassMember = PropertyDefinition | MethodDefinition | StaticBlock;
 export type ClassMemberWithNonComputedName =
@@ -1090,7 +1106,8 @@ export type NamedDeclaration =
   | TypeAlias
   | OpaqueType
   | InterfaceDeclaration
-  | EnumDeclaration;
+  | EnumDeclaration
+  | RecordDeclaration;
 
 interface ExportNamedDeclarationBase extends BaseNode {
   +type: 'ExportNamedDeclaration';
@@ -1156,6 +1173,9 @@ export type TypeAnnotationType =
   | ThisTypeAnnotation
   | MixedTypeAnnotation
   | VoidTypeAnnotation
+  | UnknownTypeAnnotation
+  | NeverTypeAnnotation
+  | UndefinedTypeAnnotation
   | StringLiteralTypeAnnotation
   | NumberLiteralTypeAnnotation
   | BigIntLiteralTypeAnnotation
@@ -1250,6 +1270,15 @@ export interface MixedTypeAnnotation extends BaseNode {
 export interface VoidTypeAnnotation extends BaseNode {
   +type: 'VoidTypeAnnotation';
 }
+export interface UnknownTypeAnnotation extends BaseNode {
+  +type: 'UnknownTypeAnnotation';
+}
+export interface NeverTypeAnnotation extends BaseNode {
+  +type: 'NeverTypeAnnotation';
+}
+export interface UndefinedTypeAnnotation extends BaseNode {
+  +type: 'UndefinedTypeAnnotation';
+}
 export interface StringLiteralTypeAnnotation extends BaseNode {
   +type: 'StringLiteralTypeAnnotation';
   +value: string;
@@ -1308,7 +1337,7 @@ export interface KeyofTypeAnnotation extends BaseNode {
 }
 export interface TupleTypeAnnotation extends BaseNode {
   +type: 'TupleTypeAnnotation';
-  +types: $ReadOnlyArray<TypeAnnotationType>;
+  +elementTypes: $ReadOnlyArray<TypeAnnotationType>;
   +inexact: boolean;
 }
 export interface TupleTypeSpreadElement extends BaseNode {
@@ -1457,7 +1486,7 @@ export interface ObjectTypeAnnotation extends BaseNode {
 }
 interface ObjectTypePropertyBase extends BaseNode {
   +type: 'ObjectTypeProperty';
-  +key: Identifier | StringLiteral;
+  +key: ObjectPropertyKey;
   +value: TypeAnnotationType;
   +method: boolean;
   +optional: boolean;
@@ -2054,6 +2083,7 @@ export type MatchPattern =
   | MatchMemberPattern
   | MatchBindingPattern
   | MatchObjectPattern
+  | MatchInstancePattern
   | MatchArrayPattern;
 
 export interface MatchOrPattern extends BaseNode {
@@ -2098,10 +2128,20 @@ export interface MatchObjectPattern extends BaseNode {
 }
 export interface MatchObjectPatternProperty extends BaseNode {
   +type: 'MatchObjectPatternProperty';
-  +key: Identifier | StringLiteral | NumericLiteral | BigIntLiteral;
+  +key: ObjectPropertyKey;
   +pattern: MatchPattern;
   +shorthand: boolean;
 }
+export interface MatchInstancePattern extends BaseNode {
+  +type: 'MatchInstancePattern';
+  +targetConstructor: MatchIdentifierPattern | MatchMemberPattern;
+  +properties: MatchInstanceObjectPattern;
+}
+export interface MatchInstanceObjectPattern extends BaseNode {
+  +type: 'MatchInstanceObjectPattern';
+  +properties: $ReadOnlyArray<MatchObjectPatternProperty>;
+  +rest: MatchRestPattern | null;
+}
 export interface MatchArrayPattern extends BaseNode {
   +type: 'MatchArrayPattern';
   +elements: $ReadOnlyArray<MatchPattern>;
@@ -2112,6 +2152,58 @@ export interface MatchRestPattern extends BaseNode {
   +argument: MatchBindingPattern | null;
 }
 
+/***********
+ * Records *
+ ***********/
+export interface RecordDeclaration extends BaseNode {
+  +type: 'RecordDeclaration';
+  +id: Identifier;
+  +typeParameters: TypeParameterDeclaration | null;
+  +implements: $ReadOnlyArray<RecordDeclarationImplements>;
+  +body: RecordDeclarationBody;
+}
+
+export interface RecordDeclarationImplements extends BaseNode {
+  +type: 'RecordDeclarationImplements';
+  +id: Identifier;
+  +typeArguments: TypeParameterInstantiation | null;
+}
+
+export interface RecordDeclarationBody extends BaseNode {
+  +type: 'RecordDeclarationBody';
+  +elements: $ReadOnlyArray<
+    | RecordDeclarationProperty
+    | RecordDeclarationStaticProperty
+    | MethodDefinition,
+  >;
+}
+
+export interface RecordDeclarationProperty extends BaseNode {
+  +type: 'RecordDeclarationProperty';
+  +key: ObjectPropertyKey;
+  +typeAnnotation: TypeAnnotation;
+  +defaultValue: Expression | null;
+}
+
+export interface RecordDeclarationStaticProperty extends BaseNode {
+  +type: 'RecordDeclarationStaticProperty';
+  +key: ObjectPropertyKey;
+  +typeAnnotation: TypeAnnotation;
+  +value: Expression;
+}
+
+export interface RecordExpression extends BaseNode {
+  +type: 'RecordExpression';
+  +recordConstructor: Expression;
+  +typeArguments: TypeParameterInstantiation | null;
+  +properties: RecordExpressionProperties;
+}
+
+export interface RecordExpressionProperties extends BaseNode {
+  +type: 'RecordExpressionProperties';
+  +properties: $ReadOnlyArray<ObjectProperty | SpreadElement>;
+}
+
 /******************************************************
  * Deprecated spec nodes awaiting migration by Hermes *
  ******************************************************/

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hermes-estree",
-  "version": "0.32.1",
+  "version": "0.33.0",
   "description": "Flow types for the Flow-ESTree spec produced by the hermes parser",
   "main": "dist/index.js",
   "license": "MIT",

package/dist/HermesAST.js.flow

@@ -1,57 +0,0 @@
-/**
- * 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
- * @format
- */
-
-// flowlint unclear-type:off
-
-export type HermesPosition = {
-  /** >= 1 */
-  +line: number,
-  /** >= 0 */
-  +column: number,
-};
-export type HermesSourceLocation = {
-  start?: HermesPosition,
-  end?: HermesPosition,
-  rangeStart?: number,
-  rangeEnd?: number,
-};
-export type HermesNode = {
-  type: string,
-  [string]: any,
-};
-export type HermesToken = {
-  type:
-    | 'Boolean'
-    | 'Identifier'
-    | 'Keyword'
-    | 'Null'
-    | 'Numeric'
-    | 'BigInt'
-    | 'Punctuator'
-    | 'String'
-    | 'RegularExpression'
-    | 'Template'
-    | 'JSXText',
-  loc: HermesSourceLocation,
-  value: ?string,
-};
-export type HermesComment = {
-  type: 'CommentLine' | 'CommentBlock' | 'InterpreterDirective',
-  loc: HermesSourceLocation,
-  value: ?string,
-};
-export type HermesProgram = {
-  type: 'Program',
-  loc: HermesSourceLocation,
-  body: Array<?HermesNode>,
-  comments: Array<HermesComment>,
-  tokens?: Array<HermesToken>,
-  interpreter?: ?HermesComment,
-};

package/dist/HermesASTAdapter.js

@@ -1,192 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-
-var _ParserVisitorKeys = require("./generated/ParserVisitorKeys");
-
-/**
- * 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 base class for transforming the Hermes AST to the desired output format.
- * Extended by concrete adapters which output an ESTree or Babel AST.
- */
-class HermesASTAdapter {
-  constructor(options) {
-    this.sourceFilename = void 0;
-    this.sourceType = void 0;
-    this.sourceFilename = options.sourceFilename;
-    this.sourceType = options.sourceType;
-  }
-  /**
-   * Transform the input Hermes AST to the desired output format.
-   * This modifies the input AST in place instead of constructing a new AST.
-   */
-
-
-  transform(program) {
-    // Comments are not traversed via visitor keys
-    const comments = program.comments;
-
-    for (let i = 0; i < comments.length; i++) {
-      const comment = comments[i];
-      this.fixSourceLocation(comment);
-      comments[i] = this.mapComment(comment);
-    } // The first comment may be an interpreter directive and is stored directly on the program node
-
-
-    program.interpreter = comments.length > 0 && comments[0].type === 'InterpreterDirective' ? comments.shift() : null; // Tokens are not traversed via visitor keys
-
-    const tokens = program.tokens;
-
-    if (tokens) {
-      for (let i = 0; i < tokens.length; i++) {
-        this.fixSourceLocation(tokens[i]);
-      }
-    }
-
-    const resultNode = this.mapNode(program);
-
-    if (resultNode.type !== 'Program') {
-      throw new Error(`HermesToESTreeAdapter: Must return a Program node, instead of "${resultNode.type}". `);
-    } // $FlowExpectedError[incompatible-type] We know this is a program at this point.
-
-
-    return resultNode;
-  }
-  /**
-   * Transform a Hermes AST node to the output AST format.
-   *
-   * This may modify the input node in-place and return that same node, or a completely
-   * new node may be constructed and returned. Overriden in child classes.
-   */
-
-
-  mapNode(_node) {
-    throw new Error('Implemented in subclasses');
-  }
-
-  mapNodeDefault(node) {
-    const visitorKeys = _ParserVisitorKeys.HERMES_AST_VISITOR_KEYS[node.type];
-
-    for (const key in visitorKeys) {
-      const childType = visitorKeys[key];
-
-      if (childType === _ParserVisitorKeys.NODE_CHILD) {
-        const child = node[key];
-
-        if (child != null) {
-          node[key] = this.mapNode(child);
-        }
-      } else if (childType === _ParserVisitorKeys.NODE_LIST_CHILD) {
-        const children = node[key];
-
-        for (let i = 0; i < children.length; i++) {
-          const child = children[i];
-
-          if (child != null) {
-            children[i] = this.mapNode(child);
-          }
-        }
-      }
-    }
-
-    return node;
-  }
-  /**
-   * Update the source location for this node depending on the output AST format.
-   * This can modify the input node in-place. Overriden in child classes.
-   */
-
-
-  fixSourceLocation(_node) {
-    throw new Error('Implemented in subclasses');
-  }
-
-  getSourceType() {
-    var _this$sourceType;
-
-    return (_this$sourceType = this.sourceType) != null ? _this$sourceType : 'script';
-  }
-
-  setModuleSourceType() {
-    if (this.sourceType == null) {
-      this.sourceType = 'module';
-    }
-  }
-
-  mapComment(node) {
-    return node;
-  }
-
-  mapEmpty(_node) {
-    // $FlowExpectedError[incompatible-type]
-    return null;
-  }
-
-  mapImportDeclaration(node) {
-    if (node.importKind === 'value') {
-      this.setModuleSourceType();
-    }
-
-    return this.mapNodeDefault(node);
-  }
-
-  mapImportSpecifier(node) {
-    if (node.importKind === 'value') {
-      node.importKind = null;
-    }
-
-    return this.mapNodeDefault(node);
-  }
-
-  mapExportDefaultDeclaration(node) {
-    this.setModuleSourceType();
-    return this.mapNodeDefault(node);
-  }
-
-  mapExportNamedDeclaration(node) {
-    if (node.exportKind === 'value') {
-      this.setModuleSourceType();
-    }
-
-    return this.mapNodeDefault(node);
-  }
-
-  mapExportAllDeclaration(node) {
-    if (node.exportKind === 'value') {
-      this.setModuleSourceType();
-    }
-
-    return this.mapNodeDefault(node);
-  }
-
-  formatError(node, message) {
-    return `${message} (${node.loc.start.line}:${node.loc.start.column})`;
-  }
-
-  getBigIntLiteralValue(bigintString) {
-    const bigint = bigintString // estree spec is to not have a trailing `n` on this property
-    // https://github.com/estree/estree/blob/db962bb417a97effcfe9892f87fbb93c81a68584/es2020.md#bigintliteral
-    .replace(/n$/, '') // `BigInt` doesn't accept numeric separator and `bigint` property should not include numeric separator
-    .replaceAll('_', '');
-    return {
-      bigint,
-      // coerce the string to a bigint value if supported by the environment
-      value: typeof BigInt === 'function' ? BigInt(bigint) : null
-    };
-  }
-
-}
-
-exports.default = HermesASTAdapter;

package/dist/HermesASTAdapter.js.flow

@@ -1,189 +0,0 @@
-/**
- * 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
- * @format
- */
-
-import type {Program} from 'hermes-estree';
-import type {HermesNode} from './HermesAST';
-import type {ParserOptions} from './ParserOptions';
-
-import {
-  HERMES_AST_VISITOR_KEYS,
-  NODE_CHILD,
-  NODE_LIST_CHILD,
-} from './generated/ParserVisitorKeys';
-
-/**
- * The base class for transforming the Hermes AST to the desired output format.
- * Extended by concrete adapters which output an ESTree or Babel AST.
- */
-export default class HermesASTAdapter {
-  sourceFilename: ParserOptions['sourceFilename'];
-  sourceType: ParserOptions['sourceType'];
-
-  constructor(options: ParserOptions) {
-    this.sourceFilename = options.sourceFilename;
-    this.sourceType = options.sourceType;
-  }
-
-  /**
-   * Transform the input Hermes AST to the desired output format.
-   * This modifies the input AST in place instead of constructing a new AST.
-   */
-  transform(program: HermesNode): Program {
-    // Comments are not traversed via visitor keys
-    const comments = program.comments;
-    for (let i = 0; i < comments.length; i++) {
-      const comment = comments[i];
-      this.fixSourceLocation(comment);
-      comments[i] = this.mapComment(comment);
-    }
-
-    // The first comment may be an interpreter directive and is stored directly on the program node
-    program.interpreter =
-      comments.length > 0 && comments[0].type === 'InterpreterDirective'
-        ? comments.shift()
-        : null;
-
-    // Tokens are not traversed via visitor keys
-    const tokens = program.tokens;
-    if (tokens) {
-      for (let i = 0; i < tokens.length; i++) {
-        this.fixSourceLocation(tokens[i]);
-      }
-    }
-
-    const resultNode = this.mapNode(program);
-    if (resultNode.type !== 'Program') {
-      throw new Error(
-        `HermesToESTreeAdapter: Must return a Program node, instead of "${resultNode.type}". `,
-      );
-    }
-
-    // $FlowExpectedError[incompatible-type] We know this is a program at this point.
-    return resultNode;
-  }
-
-  /**
-   * Transform a Hermes AST node to the output AST format.
-   *
-   * This may modify the input node in-place and return that same node, or a completely
-   * new node may be constructed and returned. Overriden in child classes.
-   */
-  mapNode(_node: HermesNode): HermesNode {
-    throw new Error('Implemented in subclasses');
-  }
-
-  mapNodeDefault(node: HermesNode): HermesNode {
-    const visitorKeys = HERMES_AST_VISITOR_KEYS[node.type];
-    for (const key in visitorKeys) {
-      const childType = visitorKeys[key];
-      if (childType === NODE_CHILD) {
-        const child = node[key];
-        if (child != null) {
-          node[key] = this.mapNode(child);
-        }
-      } else if (childType === NODE_LIST_CHILD) {
-        const children = node[key];
-        for (let i = 0; i < children.length; i++) {
-          const child = children[i];
-          if (child != null) {
-            children[i] = this.mapNode(child);
-          }
-        }
-      }
-    }
-
-    return node;
-  }
-
-  /**
-   * Update the source location for this node depending on the output AST format.
-   * This can modify the input node in-place. Overriden in child classes.
-   */
-  fixSourceLocation(_node: HermesNode): void {
-    throw new Error('Implemented in subclasses');
-  }
-
-  getSourceType(): ParserOptions['sourceType'] {
-    return this.sourceType ?? 'script';
-  }
-
-  setModuleSourceType(): void {
-    if (this.sourceType == null) {
-      this.sourceType = 'module';
-    }
-  }
-
-  mapComment(node: HermesNode): HermesNode {
-    return node;
-  }
-
-  mapEmpty(_node: HermesNode): HermesNode {
-    // $FlowExpectedError[incompatible-type]
-    return null;
-  }
-
-  mapImportDeclaration(node: HermesNode): HermesNode {
-    if (node.importKind === 'value') {
-      this.setModuleSourceType();
-    }
-
-    return this.mapNodeDefault(node);
-  }
-
-  mapImportSpecifier(node: HermesNode): HermesNode {
-    if (node.importKind === 'value') {
-      node.importKind = null;
-    }
-
-    return this.mapNodeDefault(node);
-  }
-
-  mapExportDefaultDeclaration(node: HermesNode): HermesNode {
-    this.setModuleSourceType();
-    return this.mapNodeDefault(node);
-  }
-
-  mapExportNamedDeclaration(node: HermesNode): HermesNode {
-    if (node.exportKind === 'value') {
-      this.setModuleSourceType();
-    }
-
-    return this.mapNodeDefault(node);
-  }
-
-  mapExportAllDeclaration(node: HermesNode): HermesNode {
-    if (node.exportKind === 'value') {
-      this.setModuleSourceType();
-    }
-
-    return this.mapNodeDefault(node);
-  }
-
-  formatError(node: HermesNode, message: string): string {
-    return `${message} (${node.loc.start.line}:${node.loc.start.column})`;
-  }
-
-  getBigIntLiteralValue(bigintString: string): {
-    bigint: string,
-    value: bigint | null,
-  } {
-    const bigint = bigintString
-      // estree spec is to not have a trailing `n` on this property
-      // https://github.com/estree/estree/blob/db962bb417a97effcfe9892f87fbb93c81a68584/es2020.md#bigintliteral
-      .replace(/n$/, '')
-      // `BigInt` doesn't accept numeric separator and `bigint` property should not include numeric separator
-      .replaceAll('_', '');
-    return {
-      bigint,
-      // coerce the string to a bigint value if supported by the environment
-      value: typeof BigInt === 'function' ? BigInt(bigint) : null,
-    };
-  }
-}