@runtime-type-inspector/transpiler 5.0.0 → 5.0.1

package/index.cjs

@@ -3853,6 +3853,9 @@
 	 * @typedef {object} Options
 	 * @property {boolean} [forceCurly] - Determines whether curly braces are enforced in Stringifier.
 	 * @property {boolean} [validateDivision] - Indicates whether division operations should be validated.
+	 * @property {boolean} [inspectIndexedAccess] - Indicates whether indexed accesses
+	 * like `arr[i]` should be wrapped for bounds and integer validation. Disable
+	 * to drop indexed access inspection entirely. Defaults to true.
 	 * @property {import('./parseJSDoc.js').ExpandType} [expandType] - A function that expands shorthand types into full descriptions.
 	 * @property {string} [filename] - The name of a file to which the instance pertains.
 	 * @property {boolean} [addHeader] - Whether to add import declarations headers. Defaults to true.
@@ -3871,6 +3874,8 @@
 	      forceCurly = _ref$forceCurly === void 0 ? true : _ref$forceCurly,
 	      _ref$validateDivision = _ref.validateDivision,
 	      validateDivision = _ref$validateDivision === void 0 ? true : _ref$validateDivision,
+	      _ref$inspectIndexedAc = _ref.inspectIndexedAccess,
+	      inspectIndexedAccess = _ref$inspectIndexedAc === void 0 ? true : _ref$inspectIndexedAc,
 	      _ref$expandType = _ref.expandType,
 	      expandType = _ref$expandType === void 0 ? expandTypeDepFree : _ref$expandType,
 	      filename = _ref.filename,
@@ -3933,6 +3938,7 @@
 	    _defineProperty(_assertThisInitialized(_this), "addLaterImportNamespaceSpecifier", []);
 	    _this.forceCurly = forceCurly;
 	    _this.validateDivision = validateDivision;
+	    _this.inspectIndexedAccess = inspectIndexedAccess;
 	    // @todo collect every type + manually validate as test set
 	    // + implement expandType using Babel Flow type parser aswell
 	    _this.expandType = expandType;
@@ -4799,6 +4805,9 @@
 	      var computed = node.computed,
 	        object = node.object,
 	        property = node.property;
+	      if (!this.inspectIndexedAccess) {
+	        return _get(_getPrototypeOf(Asserter.prototype), "MemberExpression", this).call(this, node);
+	      }
 	      if (!computed || object.type === 'Super') {
 	        return _get(_getPrototypeOf(Asserter.prototype), "MemberExpression", this).call(this, node);
 	      }
@@ -4815,6 +4824,45 @@
 	        if (parent.type === 'UnaryExpression' && parent.operator === 'delete' && parent.argument === node) {
 	          return _get(_getPrototypeOf(Asserter.prototype), "MemberExpression", this).call(this, node);
 	        }
+	        // Destructuring, rest and loop targets are assigned to, never read.
+	        if (parent.type === 'ArrayPattern') {
+	          return _get(_getPrototypeOf(Asserter.prototype), "MemberExpression", this).call(this, node);
+	        }
+	        if (parent.type === 'RestElement' && parent.argument === node) {
+	          return _get(_getPrototypeOf(Asserter.prototype), "MemberExpression", this).call(this, node);
+	        }
+	        if (parent.type === 'ObjectProperty' && parent.value === node) {
+	          // `({p: a[i]})` reads but `({p: a[i]} = ...)` writes: bypass inside patterns only.
+	          var grandparent = this.parents[this.parents.findLastIndex(function (_) {
+	            return _ === parent;
+	          }) - 1];
+	          if ((grandparent === null || grandparent === void 0 ? void 0 : grandparent.type) === 'ObjectPattern') {
+	            return _get(_getPrototypeOf(Asserter.prototype), "MemberExpression", this).call(this, node);
+	          }
+	        }
+	        if (parent.type === 'AssignmentPattern' && parent.left === node) {
+	          return _get(_getPrototypeOf(Asserter.prototype), "MemberExpression", this).call(this, node);
+	        }
+	        if ((parent.type === 'ForOfStatement' || parent.type === 'ForInStatement') && parent.left === node) {
+	          return _get(_getPrototypeOf(Asserter.prototype), "MemberExpression", this).call(this, node);
+	        }
+	        // Method calls and tags carry their base as `this`; wrapping the callee
+	        // would silently rebind it to undefined.
+	        if ((parent.type === 'CallExpression' || parent.type === 'OptionalCallExpression') && parent.callee === node) {
+	          return _get(_getPrototypeOf(Asserter.prototype), "MemberExpression", this).call(this, node);
+	        }
+	        if (parent.type === 'TaggedTemplateExpression' && parent.tag === node) {
+	          return _get(_getPrototypeOf(Asserter.prototype), "MemberExpression", this).call(this, node);
+	        }
+	        // `new a[i](...)` must stay `new (inspectIndexedAccess(...))(...)`:
+	        // without parens it parses as `(new inspectIndexedAccess(...))(...)`,
+	        // constructing the wrapper instead of the accessed value.
+	        if (parent.type === 'NewExpression' && parent.callee === node) {
+	          var _object_ = this.toSource(object);
+	          var _property_ = this.toSource(property);
+	          var _loc4 = this.getName(node);
+	          return "(inspectIndexedAccess(".concat(_object_, ", ").concat(_property_, ", ").concat(JSON.stringify(_loc4), "))");
+	        }
 	      }
 	      var object_ = this.toSource(object);
 	      var property_ = this.toSource(property);

package/index.mjs

@@ -3516,6 +3516,9 @@ class Stringifier {
  * @typedef {object} Options
  * @property {boolean} [forceCurly] - Determines whether curly braces are enforced in Stringifier.
  * @property {boolean} [validateDivision] - Indicates whether division operations should be validated.
+ * @property {boolean} [inspectIndexedAccess] - Indicates whether indexed accesses
+ * like `arr[i]` should be wrapped for bounds and integer validation. Disable
+ * to drop indexed access inspection entirely. Defaults to true.
  * @property {import('./parseJSDoc.js').ExpandType} [expandType] - A function that expands shorthand types into full descriptions.
  * @property {string} [filename] - The name of a file to which the instance pertains.
  * @property {boolean} [addHeader] - Whether to add import declarations headers. Defaults to true.
@@ -3528,6 +3531,7 @@ class Asserter extends Stringifier {
   constructor({
     forceCurly = true,
     validateDivision = true,
+    inspectIndexedAccess = true,
     expandType = expandTypeDepFree,
     filename,
     addHeader = true,
@@ -3587,6 +3591,7 @@ class Asserter extends Stringifier {
     this.addLaterImportNamespaceSpecifier = [];
     this.forceCurly = forceCurly;
     this.validateDivision = validateDivision;
+    this.inspectIndexedAccess = inspectIndexedAccess;
     // @todo collect every type + manually validate as test set
     // + implement expandType using Babel Flow type parser aswell
     this.expandType = expandType;
@@ -4393,6 +4398,9 @@ class Asserter extends Stringifier {
       object,
       property
     } = node;
+    if (!this.inspectIndexedAccess) {
+      return super.MemberExpression(node);
+    }
     if (!computed || object.type === 'Super') {
       return super.MemberExpression(node);
     }
@@ -4409,6 +4417,43 @@ class Asserter extends Stringifier {
       if (parent.type === 'UnaryExpression' && parent.operator === 'delete' && parent.argument === node) {
         return super.MemberExpression(node);
       }
+      // Destructuring, rest and loop targets are assigned to, never read.
+      if (parent.type === 'ArrayPattern') {
+        return super.MemberExpression(node);
+      }
+      if (parent.type === 'RestElement' && parent.argument === node) {
+        return super.MemberExpression(node);
+      }
+      if (parent.type === 'ObjectProperty' && parent.value === node) {
+        // `({p: a[i]})` reads but `({p: a[i]} = ...)` writes: bypass inside patterns only.
+        const grandparent = this.parents[this.parents.findLastIndex(_ => _ === parent) - 1];
+        if ((grandparent == null ? void 0 : grandparent.type) === 'ObjectPattern') {
+          return super.MemberExpression(node);
+        }
+      }
+      if (parent.type === 'AssignmentPattern' && parent.left === node) {
+        return super.MemberExpression(node);
+      }
+      if ((parent.type === 'ForOfStatement' || parent.type === 'ForInStatement') && parent.left === node) {
+        return super.MemberExpression(node);
+      }
+      // Method calls and tags carry their base as `this`; wrapping the callee
+      // would silently rebind it to undefined.
+      if ((parent.type === 'CallExpression' || parent.type === 'OptionalCallExpression') && parent.callee === node) {
+        return super.MemberExpression(node);
+      }
+      if (parent.type === 'TaggedTemplateExpression' && parent.tag === node) {
+        return super.MemberExpression(node);
+      }
+      // `new a[i](...)` must stay `new (inspectIndexedAccess(...))(...)`:
+      // without parens it parses as `(new inspectIndexedAccess(...))(...)`,
+      // constructing the wrapper instead of the accessed value.
+      if (parent.type === 'NewExpression' && parent.callee === node) {
+        const _object_ = this.toSource(object);
+        const _property_ = this.toSource(property);
+        const _loc5 = this.getName(node);
+        return `(inspectIndexedAccess(${_object_}, ${_property_}, ${JSON.stringify(_loc5)}))`;
+      }
     }
     const object_ = this.toSource(object);
     const property_ = this.toSource(property);

package/package.json

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