fix(js-x-ray): exclude d.ts from EFA and automatically apply TsSourceParser with .ts extension

* feat: support native Node.js type striping for JS parser

* fix(js-x-ray): exclude d.ts from EFA and automatically apply TsSourceParser with .ts extension

Author: fraxken

.changeset/odd-wolves-read.md

@@ -0,0 +1,5 @@
+---
+"@nodesecure/js-x-ray": patch
+---
+
+Exclude d.ts from EFA to avoid error and add .ts detection to automatically load TsSourceParser when required

tsconfig.base.json

@@ -1,6 +1,7 @@
 {
   "extends": "@openally/config.typescript/esm-ts-next",
   "compilerOptions": {
-    "composite": true
+    "composite": true,
+    "types": ["node"]
   }
 }

workspaces/js-x-ray/package.json

@@ -20,7 +20,7 @@
   "scripts": {
     "prepublishOnly": "npm run build",
     "build": "tsc",
-    "test-only": "node --test-reporter=spec --test './test/**/*.spec.ts'",
+    "test-only": "node --test-reporter=spec --test ./test/**/*.spec.ts",
     "test": "c8 --all --src ./src -r html npm run test-only",
     "bench": "node --expose-gc --experimental-strip-types ./benchmark/index.ts"
   },

workspaces/js-x-ray/src/AstAnalyser.ts

@@ -7,7 +7,13 @@ import path from "node:path";
 import type { ESTree } from "meriyah";
 
 // Import Internal Dependencies
-import { JsSourceParser, type SourceParser } from "./parsers/JsSourceParser.ts";
+import {
+  JsSourceParser,
+  type SourceParser
+} from "./parsers/JsSourceParser.ts";
+import {
+  TsSourceParser
+} from "./parsers/TsSourceParser.ts";
 import * as trojan from "./obfuscators/trojan-source.ts";
 import {
   PipelineRunner,
@@ -254,6 +260,14 @@ export class AstAnalyser {
     pathToFile: string | URL,
     options: RuntimeOptions = {}
   ): Promise<ReportOnFile> {
+    const filePathString = pathToFile instanceof URL ?
+      pathToFile.href :
+      pathToFile;
+
+    if (filePathString.includes("d.ts")) {
+      throw new Error("Declaration files are not supported");
+    }
+
     try {
       const {
         packageName,
@@ -264,17 +278,20 @@ export class AstAnalyser {
         metadata
       } = options;
 
-      const str = await fs.readFile(pathToFile, "utf-8");
-      const filePathString = pathToFile instanceof URL ? pathToFile.href : pathToFile;
+      let customParserToUse = customParser;
+      if (!customParser && path.extname(filePathString) === ".ts") {
+        customParserToUse = new TsSourceParser();
+      }
 
+      const str = await fs.readFile(pathToFile, "utf-8");
       const isMin = filePathString.includes(".min") || isMinifiedCode(str);
       const data = this.analyse(str, {
         location: path.dirname(filePathString),
         isMinified: isMin,
         removeHTMLComments,
         initialize,
         finalize,
-        customParser,
+        customParser: customParserToUse,
         metadata,
         packageName
       });
@@ -306,6 +323,14 @@ export class AstAnalyser {
     pathToFile: string | URL,
     options: RuntimeOptions = {}
   ): ReportOnFile {
+    const filePathString = pathToFile instanceof URL ?
+      pathToFile.href :
+      pathToFile;
+
+    if (filePathString.includes("d.ts")) {
+      throw new Error("Declaration files are not supported");
+    }
+
     try {
       const {
         packageName,
@@ -316,17 +341,20 @@ export class AstAnalyser {
         metadata
       } = options;
 
-      const str = fsSync.readFileSync(pathToFile, "utf-8");
-      const filePathString = pathToFile instanceof URL ? pathToFile.href : pathToFile;
+      let customParserToUse = customParser;
+      if (!customParser && path.extname(filePathString) === ".ts") {
+        customParserToUse = new TsSourceParser();
+      }
 
+      const str = fsSync.readFileSync(pathToFile, "utf-8");
       const isMin = filePathString.includes(".min") || isMinifiedCode(str);
       const data = this.analyse(str, {
         location: path.dirname(filePathString),
         isMinified: isMin,
         removeHTMLComments,
         initialize,
         finalize,
-        customParser,
+        customParser: customParserToUse,
         metadata,
         packageName
       });

workspaces/js-x-ray/src/EntryFilesAnalyser.ts

@@ -134,6 +134,11 @@ export class EntryFilesAnalyser {
     relativeFile: string,
     options: RuntimeOptions
   ) {
+    // Skip declaration files as they are not meant to be analysed
+    if (file.includes("d.ts")) {
+      return;
+    }
+
     this.dependencies.addVertex({
       id: relativeFile,
       adjacentTo: [],

workspaces/js-x-ray/src/parsers/TsSourceParser.ts

@@ -1,9 +1,11 @@
 // Import Third-party Dependencies
 import {
   parse,
-  TSESTree,
   type TSESTreeOptions
 } from "@typescript-eslint/typescript-estree";
+import {
+  type ESTree
+} from "meriyah";
 
 // CONSTANTS
 const kTypeScriptParsingOptions: TSESTreeOptions = {
@@ -26,12 +28,17 @@ export class TsSourceParser {
   parse(
     source: string,
     options: TSESTreeOptions = {}
-  ): TSESTree.Program["body"] {
+  ): ESTree.Statement[] {
     const { body } = parse(source, {
       ...kTypeScriptParsingOptions,
       ...options
     });
 
-    return body;
+    /**
+     * Not pretty but the types are not compatible and we know
+     * that the body is compatible with ESTree.Statement[]
+     * since the parser is designed to be compatible with ESTree.
+     */
+    return body as unknown as ESTree.Statement[];
   }
 }

workspaces/js-x-ray/test/AstAnalyser.spec.ts

@@ -294,6 +294,23 @@ describe("AstAnalyser", () => {
   });
 
   describe("analyseFile", () => {
+    it("should detect typescript extension and use TsSourceParser automatically", async() => {
+      const result = await new AstAnalyser().analyseFile(
+        new URL("test.ts", kFixtureURL),
+        { packageName: "foobar" }
+      );
+
+      assert.ok(result.ok);
+      assert.strictEqual(result.warnings.length, 0);
+    });
+
+    it("should throw when providing a typescript declaration file", async() => {
+      await assert.rejects(() => new AstAnalyser().analyseFile(
+        new URL("test.d.ts", kFixtureURL),
+        { packageName: "foobar" }
+      ), { message: "Declaration files are not supported" });
+    });
+
     it("remove the packageName from the dependencies list", async() => {
       const dependencySet = new DefaultCollectableSet<Dependency>("dependency");
       const result = await new AstAnalyser({ collectables: [dependencySet] }).analyseFile(
@@ -535,6 +552,23 @@ describe("AstAnalyser", () => {
   });
 
   describe("analyseFileSync", () => {
+    it("should detect typescript extension and use TsSourceParser automatically", () => {
+      const result = new AstAnalyser().analyseFileSync(
+        new URL("test.ts", kFixtureURL),
+        { packageName: "foobar" }
+      );
+
+      assert.ok(result.ok);
+      assert.strictEqual(result.warnings.length, 0);
+    });
+
+    it("should throw when providing a typescript declaration file", () => {
+      assert.throws(() => new AstAnalyser().analyseFileSync(
+        new URL("test.d.ts", kFixtureURL),
+        { packageName: "foobar" }
+      ), { message: "Declaration files are not supported" });
+    });
+
     it("remove the packageName from the dependencies list", () => {
       const dependencySet = new DefaultCollectableSet<Dependency>("dependency");
       const result = new AstAnalyser({ collectables: [dependencySet] }).analyseFileSync(

workspaces/js-x-ray/test/fixtures/entryFilesTs/declaration.d.ts

@@ -0,0 +1 @@
+export type yoo = string;

workspaces/js-x-ray/test/fixtures/entryFilesTs/entry.ts

@@ -1,2 +1,3 @@
 import { foo } from "./entryExport.ts";
+import type { yoo } from "./declaration.d.ts";
 console.log(foo);

workspaces/js-x-ray/test/fixtures/searchRuntimeDependencies/test.ts

@@ -0,0 +1,8 @@
+interface Foo {
+  bar: string;
+}
+
+export function test() {
+  const foo: Foo = { bar: "baz" };
+  console.log(foo);
+}