@carbonenginejs/runtime-resource 0.12.2 → 0.13.0

package/dist/formats/gr2/index.js

@@ -1,2 +1,2 @@
-export { CjsGr2Format, CjsGr2Format as default } from './CjsGr2Format.js';
-//# sourceMappingURL=index.js.map
+export { CjsGr2Format, CjsGr2Format as default } from './CjsGr2Format.js';
+//# sourceMappingURL=index.js.map

package/dist/formats/hlsl/CjsHlslFormat.js

@@ -1,254 +1,254 @@
-import { HlslEffectRes } from './core/tr2/resources/HlslEffectRes.js';
-import { DEFAULT_VALUES, normalizeValues, validateClassKey, validateClass, readWithValues, inspectWithValues, toJsonValue, toBytes, OUTPUT_JSON, OUTPUT_METADATA, OUTPUT_RAW } from './core/helpers.js';
-import { CLASS_KEYS } from './core/json.js';
-
-/**
- * Exposed CarbonEngineJS-facing Tr2 effect container format class.
- *
- * Keep this file small and reviewable: the Tr2 effect graph parser lives
- * under src/core/tr2 (internal parsing machinery, not part of this
- * package's public surface); input/option normalization, the shared read
- * path, and the JSON emitters live under src/core.
- */
-
-const FORMAT_NAME = "CjsHlslFormat";
-
-/**
- * CarbonEngineJS-facing reader for CCP's Tr2 compiled effect container
- * format (`.sm_hi` / `.sm_lo` / `.sm_depth` bodies).
- *
- * The Cjs prefix marks this as a JavaScript format/construction boundary.
- * This format profile has no dependency on any DXBC/shader-bytecode decoder: shader
- * bodies stay as opaque bytes in the emitted graph. The public contract is
- * plain JSON data (`emit: "json"`, the default) — the documented effect
- * graph shape described in `docs/reference/json-graph.md`. `emit: "raw"`
- * exposes the internal
- * HlslEffectRes graph directly; treat it as unstable, not schema-guaranteed
- * internals, useful mainly for resolving multiple permutations by hand.
- *
- * The `classes` option lets a caller register constructors for specific
- * node kinds in the emitted JSON graph (see `CjsHlslFormat.CLASS_KEYS`);
- * class registration does not depend on importing internal graph classes.
- */
-class CjsHlslFormat {
-  #emit = DEFAULT_VALUES.emit;
-  #source = DEFAULT_VALUES.source;
-  #permutation = DEFAULT_VALUES.permutation;
-  #classes = DEFAULT_VALUES.classes;
-
-  /**
-   * Create a reusable format profile.
-   *
-   * @param {object} [options] Default format values.
-   */
-  constructor(options = {}) {
-    this.SetValues(options);
-  }
-
-  /**
-   * Set format values for this reusable profile.
-   *
-   * @param {object} [options] Values to merge into the profile.
-   * @returns {CjsHlslFormat} This format profile.
-   */
-  SetValues(options = {}) {
-    const values = normalizeValues(this.GetValues(), options, FORMAT_NAME);
-    this.#emit = values.emit;
-    this.#source = values.source;
-    this.#permutation = values.permutation;
-    this.#classes = values.classes;
-    return this;
-  }
-
-  /**
-   * Get this profile's current values, optionally with per-call overrides.
-   *
-   * @param {object} [options] Optional values to merge into a copy.
-   * @returns {object} A copy of the effective values.
-   */
-  GetValues(options = {}) {
-    return normalizeValues({
-      emit: this.#emit,
-      source: this.#source,
-      permutation: this.#permutation,
-      classes: this.#classes
-    }, options, FORMAT_NAME);
-  }
-
-  /**
-   * Set multiple node-class constructors for this profile.
-   *
-   * @param {object} [classes] Map of node class keys to constructors. See {@link CjsHlslFormat.CLASS_KEYS}.
-   * @returns {CjsHlslFormat} This format profile.
-   */
-  SetClasses(classes = {}) {
-    return this.SetValues({
-      classes
-    });
-  }
-
-  /**
-   * Set one node-class constructor for this profile.
-   *
-   * @param {string} type Node class key.
-   * @param {Function|null|undefined} Class Constructor to use, or nullish to delete.
-   * @returns {CjsHlslFormat} This format profile.
-   */
-  SetClass(type, Class) {
-    if (Class === null || Class === undefined) {
-      validateClassKey(type, FORMAT_NAME);
-      const classes = {
-        ...this.#classes
-      };
-      delete classes[type];
-      this.#classes = classes;
-      return this;
-    }
-    validateClass(type, Class, FORMAT_NAME);
-    return this.SetValues({
-      classes: {
-        [type]: Class
-      }
-    });
-  }
-
-  /**
-   * Get a configured node-class constructor.
-   *
-   * @param {string} type Node class key.
-   * @returns {Function|undefined} The registered constructor, if any.
-   */
-  GetClass(type) {
-    validateClassKey(type, FORMAT_NAME);
-    return this.#classes[type];
-  }
-
-  /**
-   * Whether this reader has a constructor registered for a node class key.
-   *
-   * @param {string} type Node class key.
-   * @returns {boolean} True when a constructor is registered.
-   */
-  HasClass(type) {
-    return !!this.GetClass(type);
-  }
-
-  /**
-   * Read a Tr2 effect payload with this profile's values.
-   *
-   * @param {Uint8Array|ArrayBuffer|Buffer|DataView} input Tr2 effect container bytes.
-   * @param {object} [options] Per-call value overrides.
-   * @returns {HlslEffectRes|object} The raw HlslEffectRes instance, compact metadata, or the documented JSON graph.
-   */
-  Read(input, options = {}) {
-    return readWithValues(input, this.GetValues(options));
-  }
-
-  /**
-   * Inspect a Tr2 effect payload: header facts plus the default (or
-   * selected) permutation's technique names and stage counts.
-   *
-   * @param {Uint8Array|ArrayBuffer|Buffer|DataView} input Tr2 effect container bytes.
-   * @param {object} [options] Per-call value overrides.
-   * @returns {object} Plain summary data.
-   */
-  Inspect(input, options = {}) {
-    return inspectWithValues(input, this.GetValues(options));
-  }
-
-  /**
-   * Convert format output to JSON-compatible data.
-   *
-   * @param {any} value Format output to convert.
-   * @returns {any} Plain JSON-compatible data.
-   */
-  ToJSON(value) {
-    return toJsonValue(value);
-  }
-
-  /**
-   * Static payload sniff. Static methods use camelCase by convention.
-   *
-   * The Tr2 effect container has no magic number, so this attempts a
-   * cheap header-only load (version, string table, permutation axes and
-   * body offsets — no shader bodies) and reports whether it succeeded.
-   *
-   * @param {Uint8Array|ArrayBuffer|Buffer|DataView} input Candidate bytes.
-   * @returns {boolean} True when the payload's header decodes as a supported Tr2 effect.
-   */
-  static isSupported(input) {
-    try {
-      const bytes = toBytes(input);
-      return new HlslEffectRes().DoLoad(bytes, {
-        source: "isSupported"
-      });
-    } catch {
-      return false;
-    }
-  }
-
-  /**
-   * Static one-shot read.
-   *
-   * @param {Uint8Array|ArrayBuffer|Buffer|DataView} input Tr2 effect container bytes.
-   * @param {object} [options] Format values.
-   * @returns {HlslEffectRes|object} The raw HlslEffectRes instance, compact metadata, or the documented JSON graph.
-   */
-  static read(input, options = {}) {
-    return readWithValues(input, normalizeValues(DEFAULT_VALUES, options, FORMAT_NAME));
-  }
-
-  /**
-   * Static one-shot inspection.
-   *
-   * @param {Uint8Array|ArrayBuffer|Buffer|DataView} input Tr2 effect container bytes.
-   * @param {object} [options] Format values.
-   * @returns {object} Plain summary data.
-   */
-  static inspect(input, options = {}) {
-    return inspectWithValues(input, normalizeValues(DEFAULT_VALUES, options, FORMAT_NAME));
-  }
-
-  /**
-   * Static JSON-compatible conversion.
-   *
-   * @param {any} value Format output to convert.
-   * @returns {any} Plain JSON-compatible data.
-   */
-  static toJSON(value) {
-    return toJsonValue(value);
-  }
-
-  /**
-   * Node-only convenience: reads a compiled Tr2 effect file from disk.
-   *
-   * @param {string} path Path to a compiled Carbon effect file (`.sm_hi` etc.).
-   * @param {object} [options] Format values.
-   * @returns {Promise<HlslEffectRes|object>} The raw HlslEffectRes instance, compact metadata, or the documented JSON graph.
-   */
-  static async readFile(path, options = {}) {
-    if (typeof path !== "string" || !path) {
-      throw new TypeError(`${FORMAT_NAME}: readFile path must be a non-empty string`);
-    }
-    const {
-      readFile
-    } = await import('node:fs/promises');
-    const input = await readFile(path);
-    return readWithValues(input, normalizeValues(DEFAULT_VALUES, {
-      source: path,
-      ...options
-    }, FORMAT_NAME));
-  }
-  static OUTPUT_JSON = OUTPUT_JSON;
-  static OUTPUT_METADATA = OUTPUT_METADATA;
-  static OUTPUT_RAW = OUTPUT_RAW;
-  static CLASS_KEYS = CLASS_KEYS;
-  static type = Object.freeze(["shader"]);
-  static mediaTypes = Object.freeze(["shader"]);
-  static inputTypes = Object.freeze(["sm_hi", "sm_lo", "sm_depth"]);
-  static outputTypes = Object.freeze([OUTPUT_JSON, OUTPUT_METADATA]);
-  static debugOutputTypes = Object.freeze([OUTPUT_RAW]);
-}
-
-export { CjsHlslFormat, CjsHlslFormat as default };
-//# sourceMappingURL=CjsHlslFormat.js.map
+import { HlslEffectRes } from './core/tr2/resources/HlslEffectRes.js';
+import { DEFAULT_VALUES, normalizeValues, validateClassKey, validateClass, readWithValues, inspectWithValues, toJsonValue, toBytes, OUTPUT_JSON, OUTPUT_METADATA, OUTPUT_RAW } from './core/helpers.js';
+import { CLASS_KEYS } from './core/json.js';
+
+/**
+ * Exposed CarbonEngineJS-facing Tr2 effect container format class.
+ *
+ * Keep this file small and reviewable: the Tr2 effect graph parser lives
+ * under src/core/tr2 (internal parsing machinery, not part of this
+ * package's public surface); input/option normalization, the shared read
+ * path, and the JSON emitters live under src/core.
+ */
+
+const FORMAT_NAME = "CjsHlslFormat";
+
+/**
+ * CarbonEngineJS-facing reader for CCP's Tr2 compiled effect container
+ * format (`.sm_hi` / `.sm_lo` / `.sm_depth` bodies).
+ *
+ * The Cjs prefix marks this as a JavaScript format/construction boundary.
+ * This format profile has no dependency on any DXBC/shader-bytecode decoder: shader
+ * bodies stay as opaque bytes in the emitted graph. The public contract is
+ * plain JSON data (`emit: "json"`, the default) — the documented effect
+ * graph shape described in `docs/reference/json-graph.md`. `emit: "raw"`
+ * exposes the internal
+ * HlslEffectRes graph directly; treat it as unstable, not schema-guaranteed
+ * internals, useful mainly for resolving multiple permutations by hand.
+ *
+ * The `classes` option lets a caller register constructors for specific
+ * node kinds in the emitted JSON graph (see `CjsHlslFormat.CLASS_KEYS`);
+ * class registration does not depend on importing internal graph classes.
+ */
+class CjsHlslFormat {
+  #emit = DEFAULT_VALUES.emit;
+  #source = DEFAULT_VALUES.source;
+  #permutation = DEFAULT_VALUES.permutation;
+  #classes = DEFAULT_VALUES.classes;
+
+  /**
+   * Create a reusable format profile.
+   *
+   * @param {object} [options] Default format values.
+   */
+  constructor(options = {}) {
+    this.SetValues(options);
+  }
+
+  /**
+   * Set format values for this reusable profile.
+   *
+   * @param {object} [options] Values to merge into the profile.
+   * @returns {CjsHlslFormat} This format profile.
+   */
+  SetValues(options = {}) {
+    const values = normalizeValues(this.GetValues(), options, FORMAT_NAME);
+    this.#emit = values.emit;
+    this.#source = values.source;
+    this.#permutation = values.permutation;
+    this.#classes = values.classes;
+    return this;
+  }
+
+  /**
+   * Get this profile's current values, optionally with per-call overrides.
+   *
+   * @param {object} [options] Optional values to merge into a copy.
+   * @returns {object} A copy of the effective values.
+   */
+  GetValues(options = {}) {
+    return normalizeValues({
+      emit: this.#emit,
+      source: this.#source,
+      permutation: this.#permutation,
+      classes: this.#classes
+    }, options, FORMAT_NAME);
+  }
+
+  /**
+   * Set multiple node-class constructors for this profile.
+   *
+   * @param {object} [classes] Map of node class keys to constructors. See {@link CjsHlslFormat.CLASS_KEYS}.
+   * @returns {CjsHlslFormat} This format profile.
+   */
+  SetClasses(classes = {}) {
+    return this.SetValues({
+      classes
+    });
+  }
+
+  /**
+   * Set one node-class constructor for this profile.
+   *
+   * @param {string} type Node class key.
+   * @param {Function|null|undefined} Class Constructor to use, or nullish to delete.
+   * @returns {CjsHlslFormat} This format profile.
+   */
+  SetClass(type, Class) {
+    if (Class === null || Class === undefined) {
+      validateClassKey(type, FORMAT_NAME);
+      const classes = {
+        ...this.#classes
+      };
+      delete classes[type];
+      this.#classes = classes;
+      return this;
+    }
+    validateClass(type, Class, FORMAT_NAME);
+    return this.SetValues({
+      classes: {
+        [type]: Class
+      }
+    });
+  }
+
+  /**
+   * Get a configured node-class constructor.
+   *
+   * @param {string} type Node class key.
+   * @returns {Function|undefined} The registered constructor, if any.
+   */
+  GetClass(type) {
+    validateClassKey(type, FORMAT_NAME);
+    return this.#classes[type];
+  }
+
+  /**
+   * Whether this reader has a constructor registered for a node class key.
+   *
+   * @param {string} type Node class key.
+   * @returns {boolean} True when a constructor is registered.
+   */
+  HasClass(type) {
+    return !!this.GetClass(type);
+  }
+
+  /**
+   * Read a Tr2 effect payload with this profile's values.
+   *
+   * @param {Uint8Array|ArrayBuffer|Buffer|DataView} input Tr2 effect container bytes.
+   * @param {object} [options] Per-call value overrides.
+   * @returns {HlslEffectRes|object} The raw HlslEffectRes instance, compact metadata, or the documented JSON graph.
+   */
+  Read(input, options = {}) {
+    return readWithValues(input, this.GetValues(options));
+  }
+
+  /**
+   * Inspect a Tr2 effect payload: header facts plus the default (or
+   * selected) permutation's technique names and stage counts.
+   *
+   * @param {Uint8Array|ArrayBuffer|Buffer|DataView} input Tr2 effect container bytes.
+   * @param {object} [options] Per-call value overrides.
+   * @returns {object} Plain summary data.
+   */
+  Inspect(input, options = {}) {
+    return inspectWithValues(input, this.GetValues(options));
+  }
+
+  /**
+   * Convert format output to JSON-compatible data.
+   *
+   * @param {any} value Format output to convert.
+   * @returns {any} Plain JSON-compatible data.
+   */
+  ToJSON(value) {
+    return toJsonValue(value);
+  }
+
+  /**
+   * Static payload sniff. Static methods use camelCase by convention.
+   *
+   * The Tr2 effect container has no magic number, so this attempts a
+   * cheap header-only load (version, string table, permutation axes and
+   * body offsets — no shader bodies) and reports whether it succeeded.
+   *
+   * @param {Uint8Array|ArrayBuffer|Buffer|DataView} input Candidate bytes.
+   * @returns {boolean} True when the payload's header decodes as a supported Tr2 effect.
+   */
+  static isSupported(input) {
+    try {
+      const bytes = toBytes(input);
+      return new HlslEffectRes().DoLoad(bytes, {
+        source: "isSupported"
+      });
+    } catch {
+      return false;
+    }
+  }
+
+  /**
+   * Static one-shot read.
+   *
+   * @param {Uint8Array|ArrayBuffer|Buffer|DataView} input Tr2 effect container bytes.
+   * @param {object} [options] Format values.
+   * @returns {HlslEffectRes|object} The raw HlslEffectRes instance, compact metadata, or the documented JSON graph.
+   */
+  static read(input, options = {}) {
+    return readWithValues(input, normalizeValues(DEFAULT_VALUES, options, FORMAT_NAME));
+  }
+
+  /**
+   * Static one-shot inspection.
+   *
+   * @param {Uint8Array|ArrayBuffer|Buffer|DataView} input Tr2 effect container bytes.
+   * @param {object} [options] Format values.
+   * @returns {object} Plain summary data.
+   */
+  static inspect(input, options = {}) {
+    return inspectWithValues(input, normalizeValues(DEFAULT_VALUES, options, FORMAT_NAME));
+  }
+
+  /**
+   * Static JSON-compatible conversion.
+   *
+   * @param {any} value Format output to convert.
+   * @returns {any} Plain JSON-compatible data.
+   */
+  static toJSON(value) {
+    return toJsonValue(value);
+  }
+
+  /**
+   * Node-only convenience: reads a compiled Tr2 effect file from disk.
+   *
+   * @param {string} path Path to a compiled Carbon effect file (`.sm_hi` etc.).
+   * @param {object} [options] Format values.
+   * @returns {Promise<HlslEffectRes|object>} The raw HlslEffectRes instance, compact metadata, or the documented JSON graph.
+   */
+  static async readFile(path, options = {}) {
+    if (typeof path !== "string" || !path) {
+      throw new TypeError(`${FORMAT_NAME}: readFile path must be a non-empty string`);
+    }
+    const {
+      readFile
+    } = await import('node:fs/promises');
+    const input = await readFile(path);
+    return readWithValues(input, normalizeValues(DEFAULT_VALUES, {
+      source: path,
+      ...options
+    }, FORMAT_NAME));
+  }
+  static OUTPUT_JSON = OUTPUT_JSON;
+  static OUTPUT_METADATA = OUTPUT_METADATA;
+  static OUTPUT_RAW = OUTPUT_RAW;
+  static CLASS_KEYS = CLASS_KEYS;
+  static type = Object.freeze(["shader"]);
+  static mediaTypes = Object.freeze(["shader"]);
+  static inputTypes = Object.freeze(["sm_hi", "sm_lo", "sm_depth"]);
+  static outputTypes = Object.freeze([OUTPUT_JSON, OUTPUT_METADATA]);
+  static debugOutputTypes = Object.freeze([OUTPUT_RAW]);
+}
+
+export { CjsHlslFormat, CjsHlslFormat as default };
+//# sourceMappingURL=CjsHlslFormat.js.map

package/dist/formats/hlsl/core/HlslBinaryUtils.js

@@ -1,15 +1,15 @@
-/**
- * Reinterprets a little-endian uint32 annotation payload as a float32.
- *
- * @param {number} value Unsigned 32-bit integer containing float bits.
- * @returns {number} Float value represented by the same bits.
- */
-function cjsUint32ToFloat32(value) {
-  const bytes = new Uint8Array(4);
-  const view = new DataView(bytes.buffer);
-  view.setUint32(0, value >>> 0, true);
-  return view.getFloat32(0, true);
-}
-
-export { cjsUint32ToFloat32 };
-//# sourceMappingURL=HlslBinaryUtils.js.map
+/**
+ * Reinterprets a little-endian uint32 annotation payload as a float32.
+ *
+ * @param {number} value Unsigned 32-bit integer containing float bits.
+ * @returns {number} Float value represented by the same bits.
+ */
+function cjsUint32ToFloat32(value) {
+  const bytes = new Uint8Array(4);
+  const view = new DataView(bytes.buffer);
+  view.setUint32(0, value >>> 0, true);
+  return view.getFloat32(0, true);
+}
+
+export { cjsUint32ToFloat32 };
+//# sourceMappingURL=HlslBinaryUtils.js.map

package/dist/formats/hlsl/core/HlslEffectReadError.js

@@ -1,19 +1,19 @@
-/**
- * Error raised when a Carbon/Trinity effect payload cannot be decoded safely.
- */
-class HlslEffectReadError extends Error {
-  /**
-  * Creates an effect-read error with structured location details.
-  *
-  * @param {string} message Human-readable failure reason.
-  * @param {object} [details] Extra reader state such as source, offset, or size.
-  */
-  constructor(message, details = {}) {
-    super(message);
-    this.name = "HlslEffectReadError";
-    this.details = details;
-  }
-}
-
-export { HlslEffectReadError };
-//# sourceMappingURL=HlslEffectReadError.js.map
+/**
+ * Error raised when a Carbon/Trinity effect payload cannot be decoded safely.
+ */
+class HlslEffectReadError extends Error {
+  /**
+  * Creates an effect-read error with structured location details.
+  *
+  * @param {string} message Human-readable failure reason.
+  * @param {object} [details] Extra reader state such as source, offset, or size.
+  */
+  constructor(message, details = {}) {
+    super(message);
+    this.name = "HlslEffectReadError";
+    this.details = details;
+  }
+}
+
+export { HlslEffectReadError };
+//# sourceMappingURL=HlslEffectReadError.js.map