nucleation 0.6.0 → 0.7.0

package/IoLayout.d.mts

@@ -0,0 +1,26 @@
+// generated by diplomat-tool
+import type { pointer, codepoint } from "./diplomat-runtime.d.ts";
+
+
+
+/**
+ * An immutable IO layout. Wraps
+ * {@link crate::simulation::typed_executor::IoLayout}.
+ */
+export class IoLayout {
+    /** @internal */
+    get ffiValue(): pointer;
+    /** @internal */
+    constructor();
+
+
+    /**
+     * Input names as a JSON array string.
+     */
+    inputNamesJson(): string;
+
+    /**
+     * Output names as a JSON array string.
+     */
+    outputNamesJson(): string;
+}

package/IoLayoutBuilder.d.mts

@@ -0,0 +1,73 @@
+// generated by diplomat-tool
+import type { IoLayout } from "./IoLayout.mjs"
+import type { IoType } from "./IoType.mjs"
+import type { LayoutFunction } from "./LayoutFunction.mjs"
+import type { NucleationError } from "./NucleationError.mjs"
+import type { pointer, codepoint } from "./diplomat-runtime.d.ts";
+
+
+
+/**
+ * Builder for an {@link IoLayout}. `build` consumes it (PORTING rule 11).
+ */
+export class IoLayoutBuilder {
+    /** @internal */
+    get ffiValue(): pointer;
+    /** @internal */
+    constructor();
+
+
+    /**
+     * Create an empty layout builder.
+     */
+    static create(): IoLayoutBuilder;
+
+    /**
+     * Add an input. `positions` is flat `[x,y,z, x,y,z, ...]`.
+     */
+    addInput(name: string, ioType: IoType, layout: LayoutFunction, positions: Array<number>): void;
+
+    /**
+     * Add an output. `positions` is flat `[x,y,z, x,y,z, ...]`.
+     */
+    addOutput(name: string, ioType: IoType, layout: LayoutFunction, positions: Array<number>): void;
+
+    /**
+     * Add an input with automatic layout inference.
+     */
+    addInputAuto(name: string, ioType: IoType, positions: Array<number>): void;
+
+    /**
+     * Add an output with automatic layout inference.
+     */
+    addOutputAuto(name: string, ioType: IoType, positions: Array<number>): void;
+
+    /**
+     * Add an input from a region given as flat block positions (sorted by
+     * the default YXZ strategy, matching the old region semantics).
+     */
+    addInputFromRegion(name: string, ioType: IoType, layout: LayoutFunction, regionPositions: Array<number>): void;
+
+    /**
+     * Add an input from a region (flat positions) with automatic layout
+     * inference.
+     */
+    addInputFromRegionAuto(name: string, ioType: IoType, regionPositions: Array<number>): void;
+
+    /**
+     * Add an output from a region given as flat block positions.
+     */
+    addOutputFromRegion(name: string, ioType: IoType, layout: LayoutFunction, regionPositions: Array<number>): void;
+
+    /**
+     * Add an output from a region (flat positions) with automatic layout
+     * inference.
+     */
+    addOutputFromRegionAuto(name: string, ioType: IoType, regionPositions: Array<number>): void;
+
+    /**
+     * Build the {@link IoLayout}. Consumes the builder (a second call returns
+     * `AlreadyConsumed`).
+     */
+    build(): IoLayout;
+}

package/IoLayoutBuilder.d.ts

@@ -1,8 +1,8 @@
 // generated by diplomat-tool
-import type { IoLayout } from "./IoLayout"
-import type { IoType } from "./IoType"
-import type { LayoutFunction } from "./LayoutFunction"
-import type { NucleationError } from "./NucleationError"
+import type { IoLayout } from "./IoLayout.mjs"
+import type { IoType } from "./IoType.mjs"
+import type { LayoutFunction } from "./LayoutFunction.mjs"
+import type { NucleationError } from "./NucleationError.mjs"
 import type { pointer, codepoint } from "./diplomat-runtime.d.ts";
 
 

package/IoType.d.mts

@@ -0,0 +1,41 @@
+// generated by diplomat-tool
+import type { pointer, codepoint } from "./diplomat-runtime.d.ts";
+
+
+
+/**
+ * The wire type of a circuit input/output (PORTING rule 10).
+ */
+export class IoType {
+    /** @internal */
+    get ffiValue(): pointer;
+    /** @internal */
+    constructor();
+
+
+    /**
+     * Unsigned integer of `bits` bits (LSB-first bit order).
+     */
+    static unsignedInt(bits: number): IoType;
+
+    /**
+     * Signed integer of `bits` bits (two's complement, LSB-first).
+     */
+    static signedInt(bits: number): IoType;
+
+    /**
+     * 32-bit IEEE 754 float (crosses the wire as its 32 raw bits).
+     */
+    static float32(): IoType;
+
+    /**
+     * Single boolean (1 bit).
+     */
+    static boolean(): IoType;
+
+    /**
+     * Fixed-length ASCII string of `chars` characters (8 bits per char;
+     * shorter strings are zero-padded, longer ones truncated).
+     */
+    static ascii(chars: number): IoType;
+}

package/ItemModelConfig.d.mts

@@ -0,0 +1,65 @@
+// generated by diplomat-tool
+import type { NucleationError } from "./NucleationError.mjs"
+import type { pointer, codepoint } from "./diplomat-runtime.d.ts";
+
+
+
+/**
+ * Item model generation configuration. Wraps {@link crate::meshing::ItemModelConfig}.
+ */
+export class ItemModelConfig {
+    /** @internal */
+    get ffiValue(): pointer;
+    /** @internal */
+    constructor();
+
+
+    /**
+     * Create a config for a model named `model_name` (used in resource-pack
+     * file paths). Other options start at their defaults: namespace
+     * "nucleation", centered, 16px texture resolution, item "paper",
+     * custom model data "1", auto scale.
+     */
+    static create(modelName: string): ItemModelConfig;
+
+    /**
+     * Set the resource-pack namespace (default: "nucleation").
+     */
+    setNamespace(namespace: string): void;
+
+    /**
+     * Center the schematic within the model bounds (default: true).
+     */
+    setCenter(center: boolean): void;
+
+    /**
+     * Set the texture resolution in pixels per block face (default: 16).
+     */
+    setTextureResolution(resolution: number): void;
+
+    /**
+     * Set the Minecraft item the model binds to (default: "paper").
+     */
+    setItem(item: string): void;
+
+    /**
+     * Set the custom-model-data string used to select this model in game
+     * (default: "1").
+     */
+    setCustomModelData(cmd: string): void;
+
+    /**
+     * Uniform scale.
+     */
+    setScale(scale: number): void;
+
+    /**
+     * Per-axis scale.
+     */
+    setScaleXyz(sx: number, sy: number, sz: number): void;
+
+    /**
+     * Auto-fit scale.
+     */
+    setScaleAuto(): void;
+}

package/ItemModelConfig.d.ts

@@ -1,5 +1,5 @@
 // generated by diplomat-tool
-import type { NucleationError } from "./NucleationError"
+import type { NucleationError } from "./NucleationError.mjs"
 import type { pointer, codepoint } from "./diplomat-runtime.d.ts";
 
 

package/ItemModelPackBuilder.d.mts

@@ -0,0 +1,32 @@
+// generated by diplomat-tool
+import type { NucleationError } from "./NucleationError.mjs"
+import type { pointer, codepoint } from "./diplomat-runtime.d.ts";
+
+
+
+/**
+ * Accumulates {@link ItemModelResult}s to build a combined resource pack ZIP
+ * (old ABI: `itemmodel_build_resource_pack` took an array of pointers).
+ */
+export class ItemModelPackBuilder {
+    /** @internal */
+    get ffiValue(): pointer;
+    /** @internal */
+    constructor();
+
+
+    /**
+     * Create an empty pack builder.
+     */
+    static create(): ItemModelPackBuilder;
+
+    /**
+     * Number of results added so far.
+     */
+    len(): number;
+
+    /**
+     * Build a resource pack ZIP from every added result, base64-encoded.
+     */
+    buildZipB64(): string;
+}

package/ItemModelPackBuilder.d.ts

@@ -1,5 +1,5 @@
 // generated by diplomat-tool
-import type { NucleationError } from "./NucleationError"
+import type { NucleationError } from "./NucleationError.mjs"
 import type { pointer, codepoint } from "./diplomat-runtime.d.ts";
 
 

package/ItemModelResult.d.mts

@@ -0,0 +1,72 @@
+// generated by diplomat-tool
+import type { Dimensions } from "./Dimensions.mjs"
+import type { ItemModelConfig } from "./ItemModelConfig.mjs"
+import type { ItemModelPackBuilder } from "./ItemModelPackBuilder.mjs"
+import type { ItemScale } from "./ItemScale.mjs"
+import type { NucleationError } from "./NucleationError.mjs"
+import type { ResourcePack } from "./ResourcePack.mjs"
+import type { Schematic } from "./Schematic.mjs"
+import type { pointer, codepoint } from "./diplomat-runtime.d.ts";
+
+
+
+/**
+ * A generated item model. Wraps {@link crate::meshing::ItemModelResult}.
+ *
+ * Holds `Option<...>` because {@link ItemModelResult::add_to_pack} moves the
+ * inner value into an {@link ItemModelPackBuilder} (PORTING rule 11); accessors
+ * return `AlreadyConsumed` afterwards.
+ */
+export class ItemModelResult {
+    /** @internal */
+    get ffiValue(): pointer;
+    /** @internal */
+    constructor();
+
+
+    /**
+     * Generate an item model from a schematic (old ABI: `schematic_to_item_model`).
+     */
+    static create(schematic: Schematic, pack: ResourcePack, config: ItemModelConfig): ItemModelResult;
+
+    /**
+     * The Minecraft item model JSON.
+     */
+    modelJson(): string;
+
+    /**
+     * Number of elements (cuboids) in the generated model.
+     */
+    elementCount(): number;
+
+    /**
+     * Number of textures the generated model uses.
+     */
+    textureCount(): number;
+
+    /**
+     * Number of textured planes in the generated model.
+     */
+    planeCount(): number;
+
+    /**
+     * Source schematic dimensions in blocks.
+     */
+    dimensions(): Dimensions;
+
+    /**
+     * The applied model scale (old ABI: `itemmodel_result_scale`).
+     */
+    scale(): ItemScale;
+
+    /**
+     * A single-model resource pack ZIP, base64-encoded.
+     */
+    toResourcePackZipB64(): string;
+
+    /**
+     * Move this result into a pack builder. Consumes the result: further
+     * accessor calls return `AlreadyConsumed`.
+     */
+    addToPack(builder: ItemModelPackBuilder): void;
+}

package/ItemModelResult.d.ts

@@ -1,11 +1,11 @@
 // generated by diplomat-tool
-import type { Dimensions } from "./Dimensions"
-import type { ItemModelConfig } from "./ItemModelConfig"
-import type { ItemModelPackBuilder } from "./ItemModelPackBuilder"
-import type { ItemScale } from "./ItemScale"
-import type { NucleationError } from "./NucleationError"
-import type { ResourcePack } from "./ResourcePack"
-import type { Schematic } from "./Schematic"
+import type { Dimensions } from "./Dimensions.mjs"
+import type { ItemModelConfig } from "./ItemModelConfig.mjs"
+import type { ItemModelPackBuilder } from "./ItemModelPackBuilder.mjs"
+import type { ItemScale } from "./ItemScale.mjs"
+import type { NucleationError } from "./NucleationError.mjs"
+import type { ResourcePack } from "./ResourcePack.mjs"
+import type { Schematic } from "./Schematic.mjs"
 import type { pointer, codepoint } from "./diplomat-runtime.d.ts";
 
 

package/ItemScale.d.mts

@@ -0,0 +1,31 @@
+// generated by diplomat-tool
+import type { pointer, codepoint } from "./diplomat-runtime.d.ts";
+
+export type ItemScale_obj = {
+    x: number;
+    y: number;
+    z: number;
+};
+
+
+
+/**
+ * Non-uniform model scale factors.
+ */
+export class ItemScale {
+    get x(): number;
+    set x(value: number);
+    get y(): number;
+    set y(value: number);
+    get z(): number;
+    set z(value: number);
+    /** @internal */
+    static fromFields(structObj : ItemScale_obj) : ItemScale;
+
+    /**
+    * Create `ItemScale` from an object that contains all of `ItemScale`s fields.
+    * Optional fields do not need to be included in the provided object.
+    */
+    constructor(structObj: ItemScale_obj);
+
+}

package/LayoutFunction.d.mts

@@ -0,0 +1,52 @@
+// generated by diplomat-tool
+import type { NucleationError } from "./NucleationError.mjs"
+import type { pointer, codepoint } from "./diplomat-runtime.d.ts";
+
+
+
+/**
+ * Maps logical bits to physical positions (PORTING rule 10).
+ */
+export class LayoutFunction {
+    /** @internal */
+    get ffiValue(): pointer;
+    /** @internal */
+    constructor();
+
+
+    /**
+     * One bit per position: signal strength 0 = false, 15 = true.
+     * The most common layout for traditional redstone circuits.
+     */
+    static oneToOne(): LayoutFunction;
+
+    /**
+     * Four bits per position, packed as a hex nibble (0-15) with the
+     * lowest bit first; uses `ceil(bits / 4)` positions (4x denser than
+     * one-to-one).
+     */
+    static packed4(): LayoutFunction;
+
+    /**
+     * Custom bit-to-position mapping.
+     */
+    static custom(mapping: Array<number>): LayoutFunction;
+
+    /**
+     * 2D matrix layout, elements laid out row by row; element bits are
+     * packed 4 per position (nibbles).
+     */
+    static rowMajor(rows: number, cols: number, bitsPerElement: number): LayoutFunction;
+
+    /**
+     * 2D matrix layout, elements laid out column by column; element bits
+     * are packed 4 per position (nibbles).
+     */
+    static columnMajor(rows: number, cols: number, bitsPerElement: number): LayoutFunction;
+
+    /**
+     * Screen layout: pixels laid out row by row, left to right; pixel
+     * bits are packed 4 per position (nibbles).
+     */
+    static scanline(width: number, height: number, bitsPerPixel: number): LayoutFunction;
+}

package/LayoutFunction.d.ts

@@ -1,5 +1,5 @@
 // generated by diplomat-tool
-import type { NucleationError } from "./NucleationError"
+import type { NucleationError } from "./NucleationError.mjs"
 import type { pointer, codepoint } from "./diplomat-runtime.d.ts";
 
 

package/MchprsWorld.d.mts

@@ -0,0 +1,131 @@
+// generated by diplomat-tool
+import type { NucleationError } from "./NucleationError.mjs"
+import type { RedstoneGraph } from "./RedstoneGraph.mjs"
+import type { Schematic } from "./Schematic.mjs"
+import type { pointer, codepoint } from "./diplomat-runtime.d.ts";
+
+
+
+/**
+ * A running MCHPRS redstone simulation. Wraps {@link crate::simulation::MchprsWorld}.
+ */
+export class MchprsWorld {
+    /** @internal */
+    get ffiValue(): pointer;
+    /** @internal */
+    constructor();
+
+
+    /**
+     * Create a simulation world from a schematic with default options.
+     */
+    static create(schematic: Schematic): MchprsWorld;
+
+    /**
+     * Create a simulation world with explicit options.
+     */
+    static createWithOptions(schematic: Schematic, optimize: boolean, ioOnly: boolean): MchprsWorld;
+
+    /**
+     * Create a simulation world with custom IO positions
+     * (`custom_io_positions` is flat `[x,y,z, x,y,z, ...]`).
+     */
+    static createWithCustomIo(schematic: Schematic, optimize: boolean, ioOnly: boolean, customIoPositions: Array<number>): MchprsWorld;
+
+    /**
+     * One-shot convenience (old ABI: `schematic_simulate_use_block`):
+     * build a world from `schematic`, fire an `on_use_block` event per
+     * triple in `events_xyz`, run `ticks` ticks, and return the simulated
+     * schematic. Unlike the old ABI (which mutated in place), this returns
+     * a new `Schematic`.
+     */
+    static simulateUseBlock(schematic: Schematic, ticks: number, eventsXyz: Array<number>): Schematic;
+
+    /**
+     * Advance the simulation by `ticks` ticks.
+     */
+    tick(ticks: number): void;
+
+    /**
+     * Flush pending changes from the compiler to the world.
+     */
+    flush(): void;
+
+    /**
+     * Set the power state of a lever.
+     */
+    setLeverPower(x: number, y: number, z: number, powered: boolean): void;
+
+    /**
+     * Get the power state of a lever.
+     */
+    getLeverPower(x: number, y: number, z: number): boolean;
+
+    /**
+     * Whether a redstone lamp is lit at the given position.
+     */
+    isLit(x: number, y: number, z: number): boolean;
+
+    /**
+     * Set the signal strength (0-15) at a custom IO position.
+     */
+    setSignalStrength(x: number, y: number, z: number, strength: number): void;
+
+    /**
+     * Get the signal strength (0-15) at a position.
+     */
+    getSignalStrength(x: number, y: number, z: number): number;
+
+    /**
+     * Simulate a right-click on a block (typically a lever).
+     */
+    onUseBlock(x: number, y: number, z: number): void;
+
+    /**
+     * Sync the simulation state back to the internal schematic.
+     */
+    syncToSchematic(): void;
+
+    /**
+     * A clone of the world's schematic.
+     */
+    getSchematic(): Schematic;
+
+    /**
+     * The redstone power level (0-15) at a position.
+     */
+    getRedstonePower(x: number, y: number, z: number): number;
+
+    /**
+     * Check for custom IO changes since the last check. Call before
+     * `poll_custom_io_changes_json`.
+     */
+    checkCustomIoChanges(): void;
+
+    /**
+     * Queued custom IO changes as a JSON array
+     * (`[{"x":..,"y":..,"z":..,"old_power":..,"new_power":..}, ...]`),
+     * clearing the queue.
+     */
+    pollCustomIoChangesJson(): string;
+
+    /**
+     * Queued custom IO changes as JSON without clearing the queue.
+     */
+    peekCustomIoChangesJson(): string;
+
+    /**
+     * Clear all queued custom IO changes.
+     */
+    clearCustomIoChanges(): void;
+
+    /**
+     * Extract the compiled (post-optimization) redstone logic graph.
+     */
+    exportGraph(): RedstoneGraph;
+
+    /**
+     * Extract the structural (pre-fold, as-built) redstone logic graph.
+     */
+    exportGraphStructural(): RedstoneGraph;
+}

package/MchprsWorld.d.ts

@@ -1,7 +1,7 @@
 // generated by diplomat-tool
-import type { NucleationError } from "./NucleationError"
-import type { RedstoneGraph } from "./RedstoneGraph"
-import type { Schematic } from "./Schematic"
+import type { NucleationError } from "./NucleationError.mjs"
+import type { RedstoneGraph } from "./RedstoneGraph.mjs"
+import type { Schematic } from "./Schematic.mjs"
 import type { pointer, codepoint } from "./diplomat-runtime.d.ts";
 
 

package/MeshBounds.d.mts

@@ -0,0 +1,40 @@
+// generated by diplomat-tool
+import type { pointer, codepoint } from "./diplomat-runtime.d.ts";
+
+export type MeshBounds_obj = {
+    minX: number;
+    minY: number;
+    minZ: number;
+    maxX: number;
+    maxY: number;
+    maxZ: number;
+};
+
+
+
+/**
+ * Axis-aligned bounding box of a mesh result.
+ */
+export class MeshBounds {
+    get minX(): number;
+    set minX(value: number);
+    get minY(): number;
+    set minY(value: number);
+    get minZ(): number;
+    set minZ(value: number);
+    get maxX(): number;
+    set maxX(value: number);
+    get maxY(): number;
+    set maxY(value: number);
+    get maxZ(): number;
+    set maxZ(value: number);
+    /** @internal */
+    static fromFields(structObj : MeshBounds_obj) : MeshBounds;
+
+    /**
+    * Create `MeshBounds` from an object that contains all of `MeshBounds`s fields.
+    * Optional fields do not need to be included in the provided object.
+    */
+    constructor(structObj: MeshBounds_obj);
+
+}