nucleation 0.5.1 → 0.7.0

package/Shape.d.mts

@@ -0,0 +1,143 @@
+// generated by diplomat-tool
+import type { Curve3D } from "./Curve3D.mjs"
+import type { NucleationError } from "./NucleationError.mjs"
+import type { pointer, codepoint } from "./diplomat-runtime.d.ts";
+
+
+
+/**
+ * A solid region of blocks: primitives (sphere, cuboid, …) and boolean
+ * combinations thereof. Wraps `ShapeEnum`.
+ */
+export class Shape {
+    /** @internal */
+    get ffiValue(): pointer;
+    /** @internal */
+    constructor();
+
+
+    /**
+     * Thicken a sampled 3D curve into a parametric tube with the given radius.
+     * Inputs outside voxel-coordinate or bounded-work limits are rejected.
+     */
+    static tubeAlong(curve: Curve3D, radius: number): Shape;
+
+    /**
+     * Sphere centered at (`cx`, `cy`, `cz`) (truncated to block coordinates,
+     * matching the old `shape_sphere`).
+     */
+    static sphere(cx: number, cy: number, cz: number, radius: number): Shape;
+
+    /**
+     * Axis-aligned box spanning the two corners (inclusive).
+     */
+    static cuboid(minX: number, minY: number, minZ: number, maxX: number, maxY: number, maxZ: number): Shape;
+
+    /**
+     * A closed 2D polygon extruded between two Y levels (inclusive). The
+     * footprint is `polygon_json`, a JSON array of `[x, z]` world-coordinate
+     * pairs in order (winding does not matter; the ring closes implicitly);
+     * any simple polygon works, concave ones included. This is the shape
+     * behind extruded building footprints, lake outlines, and plot fills.
+     * Errors with `Parse` on invalid JSON and `InvalidArgument` on non-UTF-8
+     * or fewer than three vertices.
+     */
+    static polygonPrism(polygonJson: string, yMin: number, yMax: number): Shape;
+
+    /**
+     * Ellipsoid centered at (`cx`, `cy`, `cz`) with per-axis radii.
+     */
+    static ellipsoid(cx: number, cy: number, cz: number, rx: number, ry: number, rz: number): Shape;
+
+    /**
+     * Cylinder from base point along an axis vector.
+     */
+    static cylinder(bx: number, by: number, bz: number, ax: number, ay: number, az: number, radius: number, height: number): Shape;
+
+    /**
+     * Cylinder spanning the segment between two points.
+     */
+    static cylinderBetween(x1: number, y1: number, z1: number, x2: number, y2: number, z2: number, radius: number): Shape;
+
+    /**
+     * Cone with apex at (`ax`, `ay`, `az`) opening along direction (`dx`, `dy`, `dz`).
+     */
+    static cone(ax: number, ay: number, az: number, dx: number, dy: number, dz: number, radius: number, height: number): Shape;
+
+    /**
+     * Torus centered at (`cx`, `cy`, `cz`) with the given major/minor radii and
+     * axis (`ax`, `ay`, `az`).
+     */
+    static torus(cx: number, cy: number, cz: number, majorR: number, minorR: number, ax: number, ay: number, az: number): Shape;
+
+    /**
+     * Rectangular pyramid: base center, half-extents, height, up-axis.
+     */
+    static pyramid(bx: number, by: number, bz: number, halfW: number, halfD: number, height: number, ax: number, ay: number, az: number): Shape;
+
+    /**
+     * Flat disk: center, radius, plane normal, thickness.
+     */
+    static disk(cx: number, cy: number, cz: number, radius: number, nx: number, ny: number, nz: number, thickness: number): Shape;
+
+    /**
+     * Finite plane patch: origin, two spanning vectors `u`/`v`, extents along
+     * each, thickness.
+     */
+    static plane(ox: number, oy: number, oz: number, ux: number, uy: number, uz: number, vx: number, vy: number, vz: number, uExt: number, vExt: number, thickness: number): Shape;
+
+    /**
+     * Filled triangle between three vertices, thickened by `thickness`.
+     */
+    static triangle(ax: number, ay: number, az: number, bx: number, by: number, bz: number, cx: number, cy: number, cz: number, thickness: number): Shape;
+
+    /**
+     * Line segment between two points, thickened by `thickness`.
+     */
+    static line(x1: number, y1: number, z1: number, x2: number, y2: number, z2: number, thickness: number): Shape;
+
+    /**
+     * Bézier curve through `control_points` (flat `[x0, y0, z0, x1, y1, z1, …]`,
+     * so the length must be a non-zero multiple of 3), thickened by `thickness`
+     * and sampled at `resolution` steps.
+     */
+    static bezier(controlPoints: Array<number>, thickness: number, resolution: number): Shape;
+
+    /**
+     * Any SDF tree as a Shape: the same JSON the terrain sampler takes
+     * (primitives, smooth booleans, noise — see the SDF guide) becomes
+     * fillable with every brush, combinable with other shapes, and
+     * usable in masked fills. Normals come from the field gradient, so
+     * the shaded brush shades smooth blends smoothly. Errors with
+     * `Parse` on invalid JSON and `InvalidArgument` for unbounded trees
+     * (use `sdf_bounded`).
+     */
+    static sdf(sdfJson: string): Shape;
+
+    /**
+     * Like `sdf`, with explicit sampling bounds (inclusive block
+     * coordinates) for unbounded trees such as planes.
+     */
+    static sdfBounded(sdfJson: string, minX: number, minY: number, minZ: number, maxX: number, maxY: number, maxZ: number): Shape;
+
+    /**
+     * Hollowed-out copy of this shape with the given wall thickness (clones the
+     * input, like the old `shape_hollow`).
+     */
+    hollow(thickness: number): Shape;
+
+    /**
+     * Boolean union of this shape and `other` (clones both inputs).
+     */
+    unionWith(other: Shape): Shape;
+
+    /**
+     * Boolean intersection of this shape and `other` (clones both inputs).
+     */
+    intersectionWith(other: Shape): Shape;
+
+    /**
+     * Boolean difference: this shape minus `other` (clones both inputs).
+     */
+    differenceWith(other: Shape): Shape;
+}

package/Shape.d.ts

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

package/SortStrategy.d.mts

@@ -0,0 +1,86 @@
+// generated by diplomat-tool
+import type { NucleationError } from "./NucleationError.mjs"
+import type { pointer, codepoint } from "./diplomat-runtime.d.ts";
+
+
+
+/**
+ * Ordering applied to region positions before bit assignment
+ * (PORTING rule 10).
+ */
+export class SortStrategy {
+    /** @internal */
+    get ffiValue(): pointer;
+    /** @internal */
+    constructor();
+
+
+    /**
+     * Sort by Y ascending, then X, then Z (default Minecraft layer
+     * order). The first position after sorting is bit 0 (LSB).
+     */
+    static yxz(): SortStrategy;
+
+    /**
+     * Sort by X ascending, then Y, then Z.
+     */
+    static xyz(): SortStrategy;
+
+    /**
+     * Sort by Z ascending, then Y, then X.
+     */
+    static zyx(): SortStrategy;
+
+    /**
+     * Sort by Y descending, then X ascending, then Z ascending.
+     */
+    static yDescXz(): SortStrategy;
+
+    /**
+     * Sort by X descending, then Y ascending, then Z ascending.
+     */
+    static xDescYz(): SortStrategy;
+
+    /**
+     * Sort by Z descending, then Y ascending, then X ascending.
+     */
+    static zDescYx(): SortStrategy;
+
+    /**
+     * Old ABI name: `sort_strategy_descending`.
+     */
+    static descending(): SortStrategy;
+
+    /**
+     * Sort by Euclidean distance from the reference point, closest
+     * first (ties broken by Y, X, Z ascending).
+     */
+    static distanceFrom(x: number, y: number, z: number): SortStrategy;
+
+    /**
+     * Sort by Euclidean distance from the reference point, farthest
+     * first (ties broken by Y, X, Z descending).
+     */
+    static distanceFromDesc(x: number, y: number, z: number): SortStrategy;
+
+    /**
+     * Keep positions in the order they were added (no sorting). Useful
+     * when positions were ordered manually or box order matters.
+     */
+    static preserve(): SortStrategy;
+
+    /**
+     * Reverse of the order positions were added.
+     */
+    static reverse(): SortStrategy;
+
+    /**
+     * Parse from a name (e.g. "yxz", "descending", "preserve").
+     */
+    static fromString(s: string): SortStrategy;
+
+    /**
+     * The strategy name.
+     */
+    name(): string;
+}

package/SortStrategy.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/Store.d.mts

@@ -0,0 +1,83 @@
+// generated by diplomat-tool
+import type { NucleationError } from "./NucleationError.mjs"
+import type { Schematic } from "./Schematic.mjs"
+import type { pointer, codepoint } from "./diplomat-runtime.d.ts";
+
+
+
+/**
+ * A key/value store opened from a URL (e.g. `mem://`, `file:///path`,
+ * `s3://bucket/prefix`, `redis://…`, `postgres://…`).
+ */
+export class Store {
+    /** @internal */
+    get ffiValue(): pointer;
+    /** @internal */
+    constructor();
+
+
+    /**
+     * Open a store from a URL. Errors with `Store` on an unknown scheme or
+     * connection failure.
+     */
+    static open(url: string): Store;
+
+    /**
+     * Fetch `key`, writing the value as base64 (PORTING rule 6). Errors with
+     * `NotFound` when the key is absent.
+     */
+    getB64(key: string): string;
+
+    /**
+     * Store `data` at `key`.
+     */
+    put(key: string, data: Array<number>): void;
+
+    /**
+     * Whether `key` exists.
+     */
+    exists(key: string): boolean;
+
+    /**
+     * Delete `key` (idempotent).
+     */
+    delete_(key: string): void;
+
+    /**
+     * List keys under `prefix`, written as a JSON array string.
+     */
+    list(prefix: string): string;
+
+    /**
+     * Atomically write `data` at `key` only if it does not already exist.
+     * Returns `true` if written, `false` if the key existed.
+     */
+    putIfAbsent(key: string, data: Array<number>): boolean;
+
+    /**
+     * A keyset page of keys under `prefix`. `after` is the exclusive cursor
+     * (empty string for the first page); at most `limit` keys are returned.
+     * Writes a JSON object string `{"keys":[...],"next":"…"|null}`.
+     */
+    listPaginated(prefix: string, after: string, limit: number): string;
+
+    /**
+     * Health check: `Ok` when the store is usable.
+     */
+    health(): void;
+
+    /**
+     * Open a schematic stored at `key` in this store. Works for every
+     * backend, including `redis://`/`postgres://`/`mem://` that the
+     * single-string URI form (`StoreIo::open`) rejects.
+     */
+    openSchematic(key: string): Schematic;
+
+    /**
+     * Save a schematic at `key` in this store. `version` selects the format
+     * version (empty string = format default). Works for every backend,
+     * including `redis://`/`postgres://`/`mem://` that the single-string URI
+     * form (`StoreIo::save`) rejects.
+     */
+    saveSchematic(schematic: Schematic, key: string, version: string): void;
+}

package/Store.d.ts

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

package/StoreIo.d.mts

@@ -0,0 +1,71 @@
+// generated by diplomat-tool
+import type { NucleationError } from "./NucleationError.mjs"
+import type { Schematic } from "./Schematic.mjs"
+import type { pointer, codepoint } from "./diplomat-runtime.d.ts";
+
+
+
+/**
+ * Namespace type for the URI-based transparent I/O and format-manager
+ * queries (PORTING rule 12).
+ */
+export class StoreIo {
+    /** @internal */
+    get ffiValue(): pointer;
+    /** @internal */
+    constructor();
+
+
+    /**
+     * Open a schematic from a URI: a local path, `file://...`, or
+     * `s3://bucket/key.schem`. The format is auto-detected from the URI's
+     * extension. Single-string URIs for `redis://`, `postgres://`, and
+     * `mem://` are rejected by the core resolver; use `Store::open_schematic`
+     * with an explicit store for those backends.
+     */
+    static open(uri: string): Schematic;
+
+    /**
+     * Save a schematic to a URI: a local path, `file://...`, or
+     * `s3://bucket/key.schem`. The format is auto-detected from the URI's
+     * extension; `version` selects the format version (empty string =
+     * format default). Single-string URIs for `redis://`, `postgres://`, and
+     * `mem://` are rejected by the core resolver; use `Store::save_schematic`
+     * with an explicit store for those backends.
+     */
+    static save(schematic: Schematic, uri: string, version: string): void;
+
+    /**
+     * The JSON schema describing the export settings of `format`. Errors
+     * with `NotFound` for an unknown format.
+     */
+    static exportSettingsSchema(format: string): string;
+
+    /**
+     * The JSON schema describing the import settings of `format`. Errors
+     * with `NotFound` for an unknown format.
+     */
+    static importSettingsSchema(format: string): string;
+
+    /**
+     * The supported import formats, written as a JSON array string.
+     */
+    static supportedImportFormats(): string;
+
+    /**
+     * The supported export formats, written as a JSON array string.
+     */
+    static supportedExportFormats(): string;
+
+    /**
+     * The known versions of an export format, written as a JSON array string
+     * (empty array for an unknown format, matching the old ABI).
+     */
+    static formatVersions(format: string): string;
+
+    /**
+     * The default version of an export format. Errors with `NotFound` for an
+     * unknown format.
+     */
+    static defaultFormatVersion(format: string): string;
+}

package/StoreIo.d.ts

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

package/TextureAtlas.d.mts

@@ -0,0 +1,40 @@
+// generated by diplomat-tool
+import type { MeshConfig } from "./MeshConfig.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 packed texture atlas. Wraps {@link schematic_mesher::TextureAtlas}.
+ */
+export class TextureAtlas {
+    /** @internal */
+    get ffiValue(): pointer;
+    /** @internal */
+    constructor();
+
+
+    /**
+     * Build a single shared atlas from every unique block state in the
+     * schematic (old ABI: `schematic_build_global_atlas`).
+     */
+    static buildGlobal(schematic: Schematic, pack: ResourcePack, config: MeshConfig): TextureAtlas;
+
+    /**
+     * Atlas width in pixels.
+     */
+    width(): number;
+
+    /**
+     * Atlas height in pixels.
+     */
+    height(): number;
+
+    /**
+     * Raw RGBA atlas pixels, base64-encoded.
+     */
+    rgbaDataB64(): string;
+}

package/TextureAtlas.d.ts

@@ -1,8 +1,8 @@
 // generated by diplomat-tool
-import type { MeshConfig } from "./MeshConfig"
-import type { NucleationError } from "./NucleationError"
-import type { ResourcePack } from "./ResourcePack"
-import type { Schematic } from "./Schematic"
+import type { MeshConfig } from "./MeshConfig.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/TextureInfo.d.mts

@@ -0,0 +1,34 @@
+// generated by diplomat-tool
+import type { pointer, codepoint } from "./diplomat-runtime.d.ts";
+
+export type TextureInfo_obj = {
+    width: number;
+    height: number;
+    animated: boolean;
+    frameCount: number;
+};
+
+
+
+/**
+ * Texture size/animation metadata for one texture in a resource pack.
+ */
+export class TextureInfo {
+    get width(): number;
+    set width(value: number);
+    get height(): number;
+    set height(value: number);
+    get animated(): boolean;
+    set animated(value: boolean);
+    get frameCount(): number;
+    set frameCount(value: number);
+    /** @internal */
+    static fromFields(structObj : TextureInfo_obj) : TextureInfo;
+
+    /**
+    * Create `TextureInfo` from an object that contains all of `TextureInfo`s fields.
+    * Optional fields do not need to be included in the provided object.
+    */
+    constructor(structObj: TextureInfo_obj);
+
+}

package/TypedCircuitExecutor.d.mts

@@ -0,0 +1,101 @@
+// generated by diplomat-tool
+import type { ExecutionMode } from "./ExecutionMode.mjs"
+import type { IoLayout } from "./IoLayout.mjs"
+import type { MchprsWorld } from "./MchprsWorld.mjs"
+import type { NucleationError } from "./NucleationError.mjs"
+import type { Schematic } from "./Schematic.mjs"
+import type { Value } from "./Value.mjs"
+import type { pointer, codepoint } from "./diplomat-runtime.d.ts";
+
+
+
+/**
+ * A typed circuit executor. Wraps
+ * {@link crate::simulation::typed_executor::TypedCircuitExecutor}.
+ */
+export class TypedCircuitExecutor {
+    /** @internal */
+    get ffiValue(): pointer;
+    /** @internal */
+    constructor();
+
+
+    /**
+     * Create from a world and layout. Builds a fresh world from the
+     * world's schematic (matches the old ABI, which cloned internally).
+     */
+    static fromLayout(world: MchprsWorld, layout: IoLayout): TypedCircuitExecutor;
+
+    /**
+     * Create from a world and layout with simulation options.
+     */
+    static fromLayoutWithOptions(world: MchprsWorld, layout: IoLayout, optimize: boolean, ioOnly: boolean): TypedCircuitExecutor;
+
+    /**
+     * Create from Insign annotations in a schematic.
+     */
+    static fromInsign(schematic: Schematic): TypedCircuitExecutor;
+
+    /**
+     * Create from Insign annotations with options.
+     */
+    static fromInsignWithOptions(schematic: Schematic, optimize: boolean, ioOnly: boolean): TypedCircuitExecutor;
+
+    /**
+     * Set the state mode ("stateless" | "stateful" | "manual").
+     */
+    setStateMode(mode: string): void;
+
+    /**
+     * Reset the executor to its initial state.
+     */
+    reset(): void;
+
+    /**
+     * Advance the simulation by `ticks` ticks.
+     */
+    tick(ticks: number): void;
+
+    /**
+     * Flush pending changes.
+     */
+    flush(): void;
+
+    /**
+     * Set a single input value.
+     */
+    setInput(name: string, value: Value): void;
+
+    /**
+     * Read a single output value.
+     */
+    readOutput(name: string): Value;
+
+    /**
+     * Execute the circuit. `inputs_json` is a JSON object like
+     * `{"input_name": {"type": "u32", "value": 42}}`; writes a JSON
+     * object with `outputs`, `ticks_elapsed` and `condition_met`.
+     */
+    execute(inputsJson: string, mode: ExecutionMode): string;
+
+    /**
+     * Input names as a JSON array string.
+     */
+    inputNamesJson(): string;
+
+    /**
+     * Output names as a JSON array string.
+     */
+    outputNamesJson(): string;
+
+    /**
+     * Layout info as a JSON object string
+     * (old ABI: `typed_executor_get_layout_info`).
+     */
+    layoutInfoJson(): string;
+
+    /**
+     * Sync the simulation state and return the schematic (cloned).
+     */
+    syncToSchematic(): Schematic;
+}

package/TypedCircuitExecutor.d.ts

@@ -1,10 +1,10 @@
 // generated by diplomat-tool
-import type { ExecutionMode } from "./ExecutionMode"
-import type { IoLayout } from "./IoLayout"
-import type { MchprsWorld } from "./MchprsWorld"
-import type { NucleationError } from "./NucleationError"
-import type { Schematic } from "./Schematic"
-import type { Value } from "./Value"
+import type { ExecutionMode } from "./ExecutionMode.mjs"
+import type { IoLayout } from "./IoLayout.mjs"
+import type { MchprsWorld } from "./MchprsWorld.mjs"
+import type { NucleationError } from "./NucleationError.mjs"
+import type { Schematic } from "./Schematic.mjs"
+import type { Value } from "./Value.mjs"
 import type { pointer, codepoint } from "./diplomat-runtime.d.ts";