@runtime-type-inspector/transpiler 3.2.0 → 3.2.2

package/bin.js

@@ -0,0 +1,11 @@
+#!/usr/bin/env node
+import {addTypeChecks} from './index.mjs';
+import {readFileSync} from "fs";
+const filename = process.argv[2];
+if (!filename) {
+  console.error('Please specify a filename as 2nd argument');
+  process.exit(1);
+}
+const content = readFileSync(filename, 'utf8');
+const contentTypeChecked = addTypeChecks(content);
+console.log(contentTypeChecked);

package/index.cjs

@@ -267,7 +267,7 @@
 	 *
 	 * @todo Better handling of weird case: Array<>
 	 * @example
-	 * const {expandType} = await import("./src-transpiler/expandType.mjs");
+	 * const {expandType} = await import("./src-transpiler/expandType.js");
 	 * expandType('[string, Array|AnyTypedArray, number[]]|[ONNXTensor]');
 	 * expandType('(123)                    '); // Outputs: '123'
 	 * expandType('  ( ( 123 ) )            '); // Outputs: '123'
@@ -1405,7 +1405,7 @@
 	     * Generates a string representing type checks for a given Babel AST node.
 	     *
 	     * Note: This method serves as a stub and should be overridden in subclasses.
-	     * The actual implementation is expected to be provided in Asserter.mjs, where
+	     * The actual implementation is expected to be provided in Asserter.js, where
 	     * it would create runtime type assertions based on the AST node provided.
 	     *
 	     * @param {Node} node - The Babel AST node for which to generate type checks.
@@ -2944,7 +2944,7 @@
 	/** @typedef {import('@babel/types').Node              } Node               */
 	/** @typedef {import("@babel/types").ClassMethod       } ClassMethod        */
 	/** @typedef {import("@babel/types").ClassPrivateMethod} ClassPrivateMethod */
-	/** @typedef {import('./stat.mjs').Stat                } Stat               */
+	/** @typedef {import('./stat.js').Stat                } Stat               */
 	/**
 	 * @typedef {object} Options
 	 * @property {boolean} [forceCurly] - Determines whether curly braces are enforced in Stringifier.
@@ -3025,6 +3025,8 @@
 	    });
 	    /** @type {Record<string, object>} */
 	    _defineProperty(_assertThisInitialized(_this), "typedefs", {});
+	    /** @type {string[]} */
+	    _defineProperty(_assertThisInitialized(_this), "addLaterImportNamespaceSpecifier", []);
 	    _this.forceCurly = forceCurly;
 	    _this.validateDivision = validateDivision;
 	    // @todo collect every type + manually validate as test set
@@ -3120,7 +3122,7 @@
 	      if (this.validateDivision) {
 	        header += ", validateDivision";
 	      }
-	      header += ", registerTypedef, registerClass} from '@runtime-type-inspector/runtime';\n";
+	      header += ", registerTypedef, registerClass, registerImportNamespaceSpecifier} from '@runtime-type-inspector/runtime';\n";
 	      // Prevent tree-shaking in UMD build so we can always "add a breakpoint here".
 	      header += "export * from '@runtime-type-inspector/runtime';\n";
 	      return header;
@@ -3703,6 +3705,43 @@
 	      }
 	      return ret;
 	    }
+	  }, {
+	    key: "ImportDeclaration",
+	    value:
+	    /**
+	     * @override
+	     * @param {import("@babel/types").ImportDeclaration} node - The Babel AST node.
+	     * @returns {string} Stringification of the node.
+	     */
+	    function ImportDeclaration(node) {
+	      var out = _get(_getPrototypeOf(Asserter.prototype), "ImportDeclaration", this).call(this, node);
+	      var _iterator5 = _createForOfIteratorHelper(this.addLaterImportNamespaceSpecifier),
+	        _step5;
+	      try {
+	        for (_iterator5.s(); !(_step5 = _iterator5.n()).done;) {
+	          var name = _step5.value;
+	          out += "\nregisterImportNamespaceSpecifier('".concat(name, "', ").concat(name, ");");
+	        }
+	      } catch (err) {
+	        _iterator5.e(err);
+	      } finally {
+	        _iterator5.f();
+	      }
+	      return out;
+	    }
+	    /**
+	     * @override
+	     * @param {import("@babel/types").ImportNamespaceSpecifier} node - The Babel AST node.
+	     * @returns {string} Stringification of the node.
+	     */
+	  }, {
+	    key: "ImportNamespaceSpecifier",
+	    value: function ImportNamespaceSpecifier(node) {
+	      var local = node.local;
+	      var name = this.toSource(local);
+	      this.addLaterImportNamespaceSpecifier.push(name);
+	      return _get(_getPrototypeOf(Asserter.prototype), "ImportNamespaceSpecifier", this).call(this, node);
+	    }
 	  }]);
 	  return Asserter;
 	}(Stringifier);
@@ -3718,7 +3757,7 @@
 	 *
 	 * @param {string} src - The input source code containing JSDoc comments to be processed
 	 * for type checks.
-	 * @param {import('./Asserter.mjs').Options} [options] - Configuration options that dictate
+	 * @param {import('./Asserter.js').Options} [options] - Configuration options that dictate
 	 * how the processing is performed.
 	 * @returns {string} The transformed source code with inserted runtime type checks, or the
 	 * original source code commented with an error if processing fails.
@@ -3810,7 +3849,7 @@
 	/**
 	 * @todo Better handling of weird case: Array<>
 	 * @example
-	 * const {expandTypeBabelTS} = await import("./src-transpiler/expandTypeBabelTS.mjs");
+	 * const {expandTypeBabelTS} = await import("./src-transpiler/expandTypeBabelTS.js");
 	 * expandTypeBabelTS('[string, Array|AnyTypedArray, number[]]|[ONNXTensor]');
 	 * expandTypeBabelTS('(123)                    '); // Outputs: '123'
 	 * expandTypeBabelTS('  ( ( 123 ) )            '); // Outputs: '123'

package/index.mjs

@@ -10,7 +10,7 @@ import ts from 'typescript';
  *
  * @todo Better handling of weird case: Array<>
  * @example
- * const {expandType} = await import("./src-transpiler/expandType.mjs");
+ * const {expandType} = await import("./src-transpiler/expandType.js");
  * expandType('[string, Array|AnyTypedArray, number[]]|[ONNXTensor]');
  * expandType('(123)                    '); // Outputs: '123'
  * expandType('  ( ( 123 ) )            '); // Outputs: '123'
@@ -1106,7 +1106,7 @@ class Stringifier {
    * Generates a string representing type checks for a given Babel AST node.
    *
    * Note: This method serves as a stub and should be overridden in subclasses.
-   * The actual implementation is expected to be provided in Asserter.mjs, where
+   * The actual implementation is expected to be provided in Asserter.js, where
    * it would create runtime type assertions based on the AST node provided.
    *
    * @param {Node} node - The Babel AST node for which to generate type checks.
@@ -2631,7 +2631,7 @@ class Stringifier {
 /** @typedef {import('@babel/types').Node              } Node               */
 /** @typedef {import("@babel/types").ClassMethod       } ClassMethod        */
 /** @typedef {import("@babel/types").ClassPrivateMethod} ClassPrivateMethod */
-/** @typedef {import('./stat.mjs').Stat                } Stat               */
+/** @typedef {import('./stat.js').Stat                } Stat               */
 /**
  * @typedef {object} Options
  * @property {boolean} [forceCurly] - Determines whether curly braces are enforced in Stringifier.
@@ -2703,6 +2703,8 @@ class Asserter extends Stringifier {
     };
     /** @type {Record<string, object>} */
     this.typedefs = {};
+    /** @type {string[]} */
+    this.addLaterImportNamespaceSpecifier = [];
     this.forceCurly = forceCurly;
     this.validateDivision = validateDivision;
     // @todo collect every type + manually validate as test set
@@ -2790,7 +2792,7 @@ class Asserter extends Stringifier {
     if (this.validateDivision) {
       header += ", validateDivision";
     }
-    header += ", registerTypedef, registerClass} from '@runtime-type-inspector/runtime';\n";
+    header += ", registerTypedef, registerClass, registerImportNamespaceSpecifier} from '@runtime-type-inspector/runtime';\n";
     // Prevent tree-shaking in UMD build so we can always "add a breakpoint here".
     header += "export * from '@runtime-type-inspector/runtime';\n";
     return header;
@@ -3324,6 +3326,31 @@ class Asserter extends Stringifier {
     }
     return ret;
   }
+  /**
+   * @override
+   * @param {import("@babel/types").ImportDeclaration} node - The Babel AST node.
+   * @returns {string} Stringification of the node.
+   */
+  ImportDeclaration(node) {
+    let out = super.ImportDeclaration(node);
+    for (const name of this.addLaterImportNamespaceSpecifier) {
+      out += `\nregisterImportNamespaceSpecifier('${name}', ${name});`;
+    }
+    return out;
+  }
+  /**
+   * @override
+   * @param {import("@babel/types").ImportNamespaceSpecifier} node - The Babel AST node.
+   * @returns {string} Stringification of the node.
+   */
+  ImportNamespaceSpecifier(node) {
+    const {
+      local
+    } = node;
+    const name = this.toSource(local);
+    this.addLaterImportNamespaceSpecifier.push(name);
+    return super.ImportNamespaceSpecifier(node);
+  }
 }
 
 /**
@@ -3337,7 +3364,7 @@ class Asserter extends Stringifier {
  *
  * @param {string} src - The input source code containing JSDoc comments to be processed
  * for type checks.
- * @param {import('./Asserter.mjs').Options} [options] - Configuration options that dictate
+ * @param {import('./Asserter.js').Options} [options] - Configuration options that dictate
  * how the processing is performed.
  * @returns {string} The transformed source code with inserted runtime type checks, or the
  * original source code commented with an error if processing fails.
@@ -3429,7 +3456,7 @@ function compareAST(left, right) {
 /**
  * @todo Better handling of weird case: Array<>
  * @example
- * const {expandTypeBabelTS} = await import("./src-transpiler/expandTypeBabelTS.mjs");
+ * const {expandTypeBabelTS} = await import("./src-transpiler/expandTypeBabelTS.js");
  * expandTypeBabelTS('[string, Array|AnyTypedArray, number[]]|[ONNXTensor]');
  * expandTypeBabelTS('(123)                    '); // Outputs: '123'
  * expandTypeBabelTS('  ( ( 123 ) )            '); // Outputs: '123'

package/package.json

@@ -1,6 +1,7 @@
 {
+  "bin": "bin.js",
   "name": "@runtime-type-inspector/transpiler",
-  "version": "3.2.0",
+  "version": "3.2.2",
   "description": "Validating JSDoc types at runtime for high-quality types - Trust is good, control is better.",
   "main": "index.cjs",
   "module": "index.mjs",
@@ -18,7 +19,7 @@
   "homepage": "https://github.com/kungfooman/RuntimeTypeInspector.js#readme",
   "dependencies": {
     "@babel/parser": "^7.23.0",
-    "@runtime-type-inspector/runtime": "^3.2.0",
+    "@runtime-type-inspector/runtime": "^3.2.2",
     "typescript": "^5.1.6"
   },
   "files": [