@k67/kaitai-struct-ts 0.3.0 → 0.6.0

package/dist/index.js

@@ -193,6 +193,7 @@ var KaitaiStream = class _KaitaiStream {
     if (buffer instanceof ArrayBuffer) {
       this.buffer = new Uint8Array(buffer);
       this.view = new DataView(buffer);
+      this._size = buffer.byteLength;
     } else {
       this.buffer = buffer;
       this.view = new DataView(
@@ -200,6 +201,7 @@ var KaitaiStream = class _KaitaiStream {
         buffer.byteOffset,
         buffer.byteLength
       );
+      this._size = buffer.byteLength;
     }
   }
   /**
@@ -216,13 +218,13 @@ var KaitaiStream = class _KaitaiStream {
    * Total size of the stream in bytes
    */
   get size() {
-    return this.buffer.length;
+    return this._size;
   }
   /**
    * Check if we've reached the end of the stream
    */
   isEof() {
-    return this._pos >= this.buffer.length;
+    return this._pos >= this._size;
   }
   /**
    * Seek to a specific position in the stream
@@ -642,6 +644,7 @@ var KsyParser = class {
       throw new ParseError("KSY file must contain an object");
     }
     const schema = parsed;
+    this.processParametricTypes(schema);
     if (validate) {
       const result = this.validate(schema, { strict });
       if (!result.valid) {
@@ -659,6 +662,65 @@ var KsyParser = class {
     }
     return schema;
   }
+  /**
+   * Process parametric type syntax in schema.
+   * Converts "type_name(arg1, arg2)" to structured format.
+   *
+   * @param schema - Schema to process
+   * @private
+   */
+  processParametricTypes(schema) {
+    if (schema.seq) {
+      for (const attr of schema.seq) {
+        if (typeof attr.type === "string") {
+          this.parseParametricType(attr);
+        }
+      }
+    }
+    if (schema.instances) {
+      for (const instance of Object.values(schema.instances)) {
+        if (typeof instance.type === "string") {
+          this.parseParametricType(instance);
+        }
+      }
+    }
+    if (schema.types) {
+      for (const type of Object.values(schema.types)) {
+        this.processParametricTypes(type);
+      }
+    }
+  }
+  /**
+   * Parse parametric type syntax from a type string.
+   * Converts "type_name(arg1, arg2)" to type + type-args.
+   *
+   * @param attr - Attribute to process
+   * @private
+   */
+  parseParametricType(attr) {
+    if (typeof attr.type !== "string") return;
+    const match = attr.type.match(/^([a-z_][a-z0-9_]*)\((.*)\)$/i);
+    if (!match) return;
+    const [, typeName, argsStr] = match;
+    const args = [];
+    if (argsStr.trim()) {
+      const argParts = argsStr.split(",").map((s) => s.trim());
+      for (const arg of argParts) {
+        const num = Number(arg);
+        if (!isNaN(num)) {
+          args.push(num);
+        } else if (arg === "true") {
+          args.push(true);
+        } else if (arg === "false") {
+          args.push(false);
+        } else {
+          args.push(arg);
+        }
+      }
+    }
+    attr.type = typeName;
+    attr["type-args"] = args;
+  }
   /**
    * Validate a schema object.
    *
@@ -1857,9 +1919,7 @@ var Evaluator = class {
   evaluateEnumAccess(enumName, valueName, context) {
     const value = context.getEnumValue(enumName, valueName);
     if (value === void 0) {
-      throw new ParseError(
-        `Enum value "${enumName}::${valueName}" not found`
-      );
+      throw new ParseError(`Enum value "${enumName}::${valueName}" not found`);
     }
     return value;
   }
@@ -1956,6 +2016,10 @@ var TypeInterpreter = class _TypeInterpreter {
   constructor(schema, parentMeta) {
     this.schema = schema;
     this.parentMeta = parentMeta;
+    // Performance optimization: cache for constant expressions
+    // Limited size to prevent memory leaks
+    this.expressionCache = /* @__PURE__ */ new Map();
+    this.MAX_CACHE_SIZE = 1e3;
     if (!schema.meta && !parentMeta) {
       throw new ParseError("Schema must have meta section");
     }
@@ -1968,12 +2032,21 @@ var TypeInterpreter = class _TypeInterpreter {
    *
    * @param stream - Binary stream to parse
    * @param parent - Parent object (for nested types)
+   * @param typeArgs - Arguments for parametric types
    * @returns Parsed object
    */
-  parse(stream, parent) {
+  parse(stream, parent, typeArgs) {
     const result = {};
     const context = new Context(stream, result, parent, this.schema.enums);
     context.current = result;
+    if (typeArgs && this.schema.params) {
+      for (let i = 0; i < this.schema.params.length && i < typeArgs.length; i++) {
+        const param = this.schema.params[i];
+        const argValue = typeArgs[i];
+        const evaluatedArg = typeof argValue === "string" ? this.evaluateValue(argValue, context) : argValue;
+        context.set(param.id, evaluatedArg);
+      }
+    }
     if (this.schema.seq) {
       for (const attr of this.schema.seq) {
         const value = this.parseAttribute(attr, context);
@@ -1982,8 +2055,86 @@ var TypeInterpreter = class _TypeInterpreter {
         }
       }
     }
+    if (this.schema.instances) {
+      this.setupInstances(result, stream, context);
+    }
     return result;
   }
+  /**
+   * Set up lazy-evaluated instance getters.
+   * Instances are computed on first access and cached.
+   *
+   * @param result - Result object to add getters to
+   * @param stream - Stream for parsing
+   * @param context - Execution context
+   * @private
+   */
+  setupInstances(result, stream, context) {
+    if (!this.schema.instances) return;
+    for (const [name, instance] of Object.entries(this.schema.instances)) {
+      let cached = void 0;
+      let evaluated = false;
+      Object.defineProperty(result, name, {
+        get: () => {
+          if (!evaluated) {
+            cached = this.parseInstance(
+              instance,
+              stream,
+              context
+            );
+            evaluated = true;
+          }
+          return cached;
+        },
+        enumerable: true,
+        configurable: true
+      });
+    }
+  }
+  /**
+   * Parse an instance (lazy-evaluated field).
+   *
+   * @param instance - Instance specification
+   * @param stream - Stream to read from
+   * @param context - Execution context
+   * @returns Parsed or calculated value
+   * @private
+   */
+  parseInstance(instance, stream, context) {
+    if ("value" in instance) {
+      return this.evaluateValue(
+        instance.value,
+        context
+      );
+    }
+    const savedPos = stream.pos;
+    try {
+      if (instance.pos !== void 0) {
+        const pos = this.evaluateValue(
+          instance.pos,
+          context
+        );
+        if (typeof pos === "number") {
+          stream.seek(pos);
+        } else if (typeof pos === "bigint") {
+          stream.seek(Number(pos));
+        } else {
+          throw new ParseError(
+            `pos must evaluate to a number, got ${typeof pos}`
+          );
+        }
+      }
+      const value = this.parseAttribute(
+        instance,
+        context
+      );
+      return value;
+    } finally {
+      if (instance.pos !== void 0) {
+        stream.seek(savedPos);
+      }
+    }
+  }
   /**
    * Parse a single attribute according to its specification.
    *
@@ -2013,6 +2164,11 @@ var TypeInterpreter = class _TypeInterpreter {
     if (attr.io) {
       throw new NotImplementedError("Custom I/O streams");
     }
+    if (!attr.type && !attr.size && !attr["size-eos"] && !attr.contents) {
+      throw new ParseError(
+        `Attribute "${attr.id || "unknown"}" must have type, size, size-eos, or contents`
+      );
+    }
     if (attr.repeat) {
       return this.parseRepeated(attr, context);
     }
@@ -2062,7 +2218,13 @@ var TypeInterpreter = class _TypeInterpreter {
           throw new ParseError("repeat-until expression is required");
         }
         let index = 0;
+        const maxIterations = 1e6;
         while (true) {
+          if (index >= maxIterations) {
+            throw new ParseError(
+              `repeat-until exceeded maximum iterations (${maxIterations}). Possible infinite loop.`
+            );
+          }
           context.set("_index", index);
           const value = this.parseAttribute(
             { ...attr, repeat: void 0, "repeat-until": void 0 },
@@ -2137,16 +2299,34 @@ var TypeInterpreter = class _TypeInterpreter {
       if (size < 0) {
         throw new ParseError(`size must be non-negative, got ${size}`);
       }
+      if (stream.pos + size > stream.size) {
+        throw new ParseError(
+          `Not enough data: need ${size} bytes at position ${stream.pos}, but only ${stream.size - stream.pos} bytes available`
+        );
+      }
       if (type === "str" || !type) {
         const encoding = attr.encoding || this.schema.meta.encoding || "UTF-8";
+        let data;
         if (type === "str") {
-          return stream.readStr(size, encoding);
+          data = stream.readBytes(size);
+          if (attr.process) {
+            data = this.applyProcessing(data, attr.process);
+          }
+          return new TextDecoder(encoding).decode(data);
         } else {
-          return stream.readBytes(size);
+          data = stream.readBytes(size);
+          if (attr.process) {
+            data = this.applyProcessing(data, attr.process);
+          }
+          return data;
         }
       } else {
-        const substream = stream.substream(size);
-        return this.parseType(type, substream, context);
+        let data = stream.readBytes(size);
+        if (attr.process) {
+          data = this.applyProcessing(data, attr.process);
+        }
+        const substream = new KaitaiStream(data);
+        return this.parseType(type, substream, context, attr["type-args"]);
       }
     }
     if (attr["size-eos"]) {
@@ -2161,7 +2341,7 @@ var TypeInterpreter = class _TypeInterpreter {
     if (!type) {
       throw new ParseError("Attribute must have either type, size, or contents");
     }
-    return this.parseType(type, stream, context);
+    return this.parseType(type, stream, context, attr["type-args"]);
   }
   /**
    * Parse a value of a specific type.
@@ -2169,12 +2349,17 @@ var TypeInterpreter = class _TypeInterpreter {
    * @param type - Type name or switch specification
    * @param stream - Stream to read from
    * @param context - Execution context
+   * @param typeArgs - Arguments for parametric types
    * @returns Parsed value
    * @private
    */
-  parseType(type, stream, context) {
+  parseType(type, stream, context, typeArgs) {
     if (typeof type === "object") {
-      throw new NotImplementedError("Switch types");
+      return this.parseSwitchType(
+        type,
+        stream,
+        context
+      );
     }
     if (isBuiltinType(type)) {
       return this.parseBuiltinType(type, stream, context);
@@ -2185,11 +2370,46 @@ var TypeInterpreter = class _TypeInterpreter {
       if (this.schema.enums && !typeSchema.enums) {
         typeSchema.enums = this.schema.enums;
       }
+      if (this.schema.types && !typeSchema.types) {
+        typeSchema.types = this.schema.types;
+      }
       const interpreter = new _TypeInterpreter(typeSchema, meta);
-      return interpreter.parse(stream, context.current);
+      return interpreter.parse(stream, context.current, typeArgs);
     }
     throw new ParseError(`Unknown type: ${type}`);
   }
+  /**
+   * Parse a switch type (type selection based on expression).
+   *
+   * @param switchType - Switch type specification
+   * @param stream - Stream to read from
+   * @param context - Execution context
+   * @returns Parsed value
+   * @private
+   */
+  parseSwitchType(switchType, stream, context) {
+    const switchOn = switchType["switch-on"];
+    const cases = switchType["cases"];
+    const defaultType = switchType["default"];
+    if (!switchOn || typeof switchOn !== "string") {
+      throw new ParseError("switch-on expression is required for switch types");
+    }
+    if (!cases) {
+      throw new ParseError("cases are required for switch types");
+    }
+    const switchValue = this.evaluateValue(switchOn, context);
+    const switchKey = String(switchValue);
+    let selectedType = cases[switchKey];
+    if (selectedType === void 0 && defaultType) {
+      selectedType = defaultType;
+    }
+    if (selectedType === void 0) {
+      throw new ParseError(
+        `No matching case for switch value "${switchKey}" and no default type specified`
+      );
+    }
+    return this.parseType(selectedType, stream, context);
+  }
   /**
    * Parse a built-in type.
    *
@@ -2205,6 +2425,13 @@ var TypeInterpreter = class _TypeInterpreter {
     const meta = this.schema.meta || this.parentMeta;
     const metaEndian = meta?.endian;
     const endian = typeEndian || (typeof metaEndian === "string" ? metaEndian : "le");
+    if (type.startsWith("b") && type.length > 1) {
+      const bits = parseInt(type.substring(1), 10);
+      if (!isNaN(bits) && bits >= 1 && bits <= 64) {
+        const value = endian === "be" ? stream.readBitsIntBe(bits) : stream.readBitsIntLe(bits);
+        return bits <= 32 ? Number(value) : value;
+      }
+    }
     if (isIntegerType(type)) {
       return this.readInteger(base, endian, stream);
     }
@@ -2267,11 +2494,27 @@ var TypeInterpreter = class _TypeInterpreter {
     }
   }
   /**
-   * Evaluate an expression or return a literal value.
-   * If the value is a string, it's treated as an expression.
-   * If it's a number or boolean, it's returned as-is.
+   * Apply processing transformation to data.
+   * Supports basic transformations like zlib decompression.
+   *
+   * @param data - Data to process
+   * @param process - Processing specification
+   * @returns Processed data
+   * @private
+   */
+  applyProcessing(data, process) {
+    const processType = typeof process === "string" ? process : process.algorithm;
+    if (processType) {
+      throw new NotImplementedError(
+        `Processing type "${processType}" is not yet implemented. Supported in future versions with zlib, encryption, etc.`
+      );
+    }
+    return data;
+  }
+  /**
+   * Evaluate a value that can be an expression or literal.
    *
-   * @param value - Expression string or literal value
+   * @param value - Value to evaluate (expression string, number, or boolean)
    * @param context - Execution context
    * @returns Evaluated result
    * @private
@@ -2284,8 +2527,21 @@ var TypeInterpreter = class _TypeInterpreter {
       return value;
     }
     if (typeof value === "string") {
+      if (!value.includes("_") && !value.includes(".")) {
+        const cached = this.expressionCache.get(value);
+        if (cached !== void 0) {
+          return cached;
+        }
+      }
       try {
-        return evaluateExpression(value, context);
+        const result = evaluateExpression(value, context);
+        if (!value.includes("_") && !value.includes(".")) {
+          if (this.expressionCache.size >= this.MAX_CACHE_SIZE) {
+            this.expressionCache.clear();
+          }
+          this.expressionCache.set(value, result);
+        }
+        return result;
       } catch (error) {
         throw new ParseError(
           `Failed to evaluate expression "${value}": ${error instanceof Error ? error.message : String(error)}`
@@ -2426,7 +2682,7 @@ function parse(ksyYaml, buffer, options = {}) {
  * @module kaitai-struct-ts
  * @author Fabiano Pinto
  * @license MIT
- * @version 0.2.0
+ * @version 0.6.0
  *
  * @description
  * A runtime interpreter for Kaitai Struct binary format definitions in TypeScript.