Rename 'getImportAssertion()' to 'getImportAttributes()' in QL library

Author: aibaars

javascript/ql/lib/semmle/javascript/ES2015Modules.qll

@@ -91,14 +91,27 @@ class ImportDeclaration extends Stmt, Import, @import_declaration {
   override PathExpr getImportedPath() { result = this.getChildExpr(-1) }
 
   /**
-   * Gets the object literal passed as part of the `assert` clause in this import declaration.
+   * Gets the object literal passed as part of the `with` (or `assert`) clause in this import declaration.
    *
    * For example, this gets the `{ type: "json" }` object literal in the following:
    * ```js
+   * import foo from "foo" with { type: "json" };
    * import foo from "foo" assert { type: "json" };
    * ```
    */
-  ObjectExpr getImportAssertion() { result = this.getChildExpr(-10) }
+  ObjectExpr getImportAttributes() { result = this.getChildExpr(-10) }
+
+  /**
+   * DEPRECATED: use `getImportAttributes` instead.
+   * Gets the object literal passed as part of the `with` (or `assert`) clause in this import declaration.
+   *
+   * For example, this gets the `{ type: "json" }` object literal in the following:
+   * ```js
+   * import foo from "foo" with { type: "json" };
+   * import foo from "foo" assert { type: "json" };
+   * ```
+   */
+  deprecated ObjectExpr getImportAssertion() { result = this.getImportAttributes() }
 
   /** Gets the `i`th import specifier of this import declaration. */
   ImportSpecifier getSpecifier(int i) { result = this.getChildExpr(i) }
@@ -322,17 +335,33 @@ abstract class ExportDeclaration extends Stmt, @export_declaration {
   override string getAPrimaryQlClass() { result = "ExportDeclaration" }
 
   /**
-   * Gets the object literal passed as part of the `assert` clause, if this is
+   * Gets the object literal passed as part of the `with` (or `assert`) clause, if this is
+   * a re-export declaration.
+   *
+   * For example, this gets the `{ type: "json" }` expression in each of the following:
+   * ```js
+   * export { x } from 'foo' with { type: "json" };
+   * export * from 'foo' with { type: "json" };
+   * export * as x from 'foo' with { type: "json" };
+   * export * from 'foo' assert { type: "json" };
+   * ```
+   */
+  ObjectExpr getImportAttributes() { result = this.getChildExpr(-10) }
+
+  /**
+   * DEPRECATED: use `getImportAttributes` instead.
+   * Gets the object literal passed as part of the `with` (or `assert`) clause, if this is
    * a re-export declaration.
    *
    * For example, this gets the `{ type: "json" }` expression in each of the following:
    * ```js
-   * export { x } from 'foo' assert { type: "json" };
+   * export { x } from 'foo' with { type: "json" };
+   * export * from 'foo' with { type: "json" };
+   * export * as x from 'foo' with { type: "json" };
    * export * from 'foo' assert { type: "json" };
-   * export * as x from 'foo' assert { type: "json" };
    * ```
    */
-  ObjectExpr getImportAssertion() { result = this.getChildExpr(-10) }
+  deprecated ObjectExpr getImportAssertion() { result = this.getImportAttributes() }
 }
 
 /**

javascript/ql/lib/semmle/javascript/Expr.qll

@@ -2807,7 +2807,7 @@ class FunctionBindExpr extends @bind_expr, Expr {
  *
  * ```
  * import("fs")
- * import("foo", { assert: { type: "json" }})
+ * import("foo", { with: { type: "json" }})
  * ```
  */
 class DynamicImportExpr extends @dynamic_import, Expr, Import {
@@ -2823,9 +2823,9 @@ class DynamicImportExpr extends @dynamic_import, Expr, Import {
   /**
    * Gets the second "argument" to the import expression, that is, the `Y` in `import(X, Y)`.
    *
-   * For example, gets the `{ assert: { type: "json" }}` expression in the following:
+   * For example, gets the `{ with: { type: "json" }}` expression in the following:
    * ```js
-   * import('foo', { assert: { type: "json" }})
+   * import('foo', { with: { type: "json" }})
    * ```
    */
   Expr getImportAttributes() { result = this.getChildExpr(1) }

javascript/ql/test/library-tests/TypeScript/ImportAssertions/test.expected

@@ -1,4 +1,4 @@
-getImportAssertionFromImport
+getImportAttributesFromImport
 | js-import-assertions.js:1:1:1:40 | import  ... son" }; | js-import-assertions.js:1:24:1:39 | { type: "json" } |
 | js-import-assertions.js:2:1:2:53 | import  ... son" }; | js-import-assertions.js:2:37:2:52 | { type: "json" } |
 | js-import-assertions.js:3:1:3:52 | import  ... son" }; | js-import-assertions.js:3:36:3:51 | { type: "json" } |
@@ -7,7 +7,7 @@ getImportAssertionFromImport
 | ts-import-assertions.ts:4:1:4:53 | import  ... son" }; | ts-import-assertions.ts:4:37:4:52 | { type: "json" } |
 | ts-import-assertions.ts:5:1:5:52 | import  ... son" }; | ts-import-assertions.ts:5:36:5:51 | { type: "json" } |
 | ts-import-assertions.ts:6:1:6:48 | import  ... son" }; | ts-import-assertions.ts:6:32:6:47 | { type: "json" } |
-getImportAssertionFromExport
+getImportAttributesFromExport
 | js-import-assertions.js:6:1:6:52 | export  ... son" }; | js-import-assertions.js:6:36:6:51 | { type: "json" } |
 | js-import-assertions.js:7:1:7:47 | export  ... son" }; | js-import-assertions.js:7:31:7:46 | { type: "json" } |
 | js-import-assertions.js:8:1:8:53 | export  ... son" }; | js-import-assertions.js:8:37:8:52 | { type: "json" } |

javascript/ql/test/library-tests/TypeScript/ImportAssertions/test.ql

@@ -1,11 +1,11 @@
 import javascript
 
-query Expr getImportAssertionFromImport(ImportDeclaration decl) {
-  result = decl.getImportAssertion()
+query Expr getImportAttributesFromImport(ImportDeclaration decl) {
+  result = decl.getImportAttributes()
 }
 
-query Expr getImportAssertionFromExport(ExportDeclaration decl) {
-  result = decl.getImportAssertion()
+query Expr getImportAttributesFromExport(ExportDeclaration decl) {
+  result = decl.getImportAttributes()
 }
 
 query Expr getImportAttributes(DynamicImportExpr imprt) { result = imprt.getImportAttributes() }