@nodesecure/js-x-ray 7.2.0 → 7.3.0

package/README.md

@@ -307,7 +307,7 @@ $ yarn add @nodesecure/estree-ast-util
 ## Contributors ✨
 
 <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
-[![All Contributors](https://img.shields.io/badge/all_contributors-17-orange.svg?style=flat-square)](#contributors-)
+[![All Contributors](https://img.shields.io/badge/all_contributors-18-orange.svg?style=flat-square)](#contributors-)
 <!-- ALL-CONTRIBUTORS-BADGE:END -->
 
 Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
@@ -339,6 +339,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/FredGuiou"><img src="https://avatars.githubusercontent.com/u/99122562?v=4?s=100" width="100px;" alt="FredGuiou"/><br /><sub><b>FredGuiou</b></sub></a><br /><a href="https://github.com/NodeSecure/js-x-ray/commits?author=FredGuiou" title="Documentation">📖</a> <a href="https://github.com/NodeSecure/js-x-ray/commits?author=FredGuiou" title="Code">💻</a></td>
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/madina0801"><img src="https://avatars.githubusercontent.com/u/101329759?v=4?s=100" width="100px;" alt="Madina"/><br /><sub><b>Madina</b></sub></a><br /><a href="https://github.com/NodeSecure/js-x-ray/commits?author=madina0801" title="Code">💻</a></td>
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/sairuss7"><img src="https://avatars.githubusercontent.com/u/87803528?v=4?s=100" width="100px;" alt="SairussDev"/><br /><sub><b>SairussDev</b></sub></a><br /><a href="https://github.com/NodeSecure/js-x-ray/commits?author=sairuss7" title="Code">💻</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/fless-lab"><img src="https://avatars.githubusercontent.com/u/71844440?v=4?s=100" width="100px;" alt="Abdou-Raouf ATARMLA"/><br /><sub><b>Abdou-Raouf ATARMLA</b></sub></a><br /><a href="https://github.com/NodeSecure/js-x-ray/commits?author=fless-lab" title="Code">💻</a></td>
     </tr>
   </tbody>
 </table>

package/index.js

@@ -8,6 +8,14 @@ function runASTAnalysis(
   str,
   options = Object.create(null)
 ) {
+  process.emitWarning(
+    'The runASTAnalysis API is deprecated and will be removed in v8. Please use the AstAnalyser class instead.',
+    {
+      code: 'DeprecationWarning',
+      detail: 'The runASTAnalysis API is deprecated and will be removed in v8. Please use the AstAnalyser class instead.'
+    }
+  );
+
   const {
     customParser = new JsSourceParser(),
     customProbes = [],
@@ -28,6 +36,14 @@ async function runASTAnalysisOnFile(
   pathToFile,
   options = {}
 ) {
+  process.emitWarning(
+    'The runASTAnalysisOnFile API is deprecated and will be removed in v8. Please use the AstAnalyser class instead.',
+    {
+      code: 'DeprecationWarning',
+      detail: 'The runASTAnalysisOnFile API is deprecated and will be removed in v8. Please use the AstAnalyser class instead.'
+    }
+  );
+
   const {
     customProbes = [],
     customParser = new JsSourceParser(),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nodesecure/js-x-ray",
-  "version": "7.2.0",
+  "version": "7.3.0",
   "description": "JavaScript AST XRay analysis",
   "type": "module",
   "exports": "./index.js",
@@ -56,10 +56,10 @@
   "devDependencies": {
     "@nodesecure/eslint-config": "^1.6.0",
     "@types/node": "^20.6.2",
-    "c8": "^9.0.0",
+    "c8": "^10.1.2",
     "cross-env": "^7.0.3",
     "eslint": "^9.0.0",
-    "glob": "^10.3.4",
+    "glob": "^11.0.0",
     "iterator-matcher": "^2.1.0",
     "pkg-ok": "^3.0.0"
   }

package/src/AstAnalyser.js

@@ -1,5 +1,6 @@
 // Import Node.js Dependencies
 import fs from "node:fs/promises";
+import fsSync from "node:fs";
 import path from "node:path";
 
 // Import Third-party Dependencies
@@ -127,6 +128,52 @@ export class AstAnalyser {
     }
   }
 
+  analyseFileSync(
+    pathToFile,
+    options = {}
+  ) {
+    try {
+      const {
+        packageName = null,
+        module = true,
+        removeHTMLComments = false,
+        initialize,
+        finalize
+      } = options;
+
+      const str = fsSync.readFileSync(pathToFile, "utf-8");
+      const filePathString = pathToFile instanceof URL ? pathToFile.href : pathToFile;
+
+      const isMin = filePathString.includes(".min") || isMinified(str);
+      const data = this.analyse(str, {
+        isMinified: isMin,
+        module: path.extname(filePathString) === ".mjs" ? true : module,
+        removeHTMLComments,
+        initialize,
+        finalize
+      });
+
+      if (packageName !== null) {
+        data.dependencies.delete(packageName);
+      }
+
+      return {
+        ok: true,
+        dependencies: data.dependencies,
+        warnings: data.warnings,
+        isMinified: !data.isOneLineRequire && isMin
+      };
+    }
+    catch (error) {
+      return {
+        ok: false,
+        warnings: [
+          { kind: "parsing-error", value: error.message, location: [[0, 0], [0, 0]] }
+        ]
+      };
+    }
+  }
+
   /**
    * @param {!string} source
    * @param {object} options

package/src/utils/isOneLineExpressionExport.js

@@ -2,17 +2,23 @@
 import { exportAssignmentHasRequireLeave } from "./exportAssignmentHasRequireLeave.js";
 
 export function isOneLineExpressionExport(body) {
-  if (body.length > 1) {
+  if (body.length === 0 || body.length > 1) {
     return false;
   }
 
-  if (body[0].type !== "ExpressionStatement") {
+  const [firstNode] = body;
+  if (firstNode.type !== "ExpressionStatement") {
     return false;
   }
 
-  if (body[0].expression.type !== "AssignmentExpression") {
-    return false;
+  switch (firstNode.expression.type) {
+    // module.exports = require('...');
+    case "AssignmentExpression":
+      return exportAssignmentHasRequireLeave(firstNode.expression.right);
+    // require('...');
+    case "CallExpression":
+      return exportAssignmentHasRequireLeave(firstNode.expression);
+    default:
+      return false;
   }
-
-  return exportAssignmentHasRequireLeave(body[0].expression.right);
 }