nucleation 0.2.17 → 0.3.0

package/Value.mjs

@@ -0,0 +1,275 @@
+// generated by diplomat-tool
+import { NucleationError } from "./NucleationError.mjs"
+import wasm from "./diplomat-wasm.mjs";
+import * as diplomatRuntime from "./diplomat-runtime.mjs";
+
+const Value_box_destroy_registry = new FinalizationRegistry((ptr) => {
+    wasm.Value_destroy(ptr);
+});
+
+/**
+ * A typed circuit value (payload-carrying enum; PORTING rule 10).
+ */
+export class Value {
+    // Internal ptr reference:
+    #ptr = null;
+
+    // Lifetimes are only to keep dependencies alive.
+    // Since JS won't garbage collect until there are no incoming edges.
+    #selfEdge = [];
+
+    #internalConstructor(symbol, ptr, selfEdge) {
+        if (symbol !== diplomatRuntime.internalConstructor) {
+            console.error("Value is an Opaque type. You cannot call its constructor.");
+            return;
+        }
+        this.#ptr = ptr;
+        this.#selfEdge = selfEdge;
+
+        // Are we being borrowed? If not, we can register.
+        if (this.#selfEdge.length === 0) {
+            Value_box_destroy_registry.register(this, this.#ptr);
+        }
+
+        return this;
+    }
+    /** @internal */
+    get ffiValue() {
+        return this.#ptr;
+    }
+
+
+    /**
+     * Create an unsigned 32-bit integer value.
+     */
+    static fromU32(v) {
+
+        const result = wasm.Value_from_u32(v);
+
+        try {
+            return new Value(diplomatRuntime.internalConstructor, result, []);
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+        }
+    }
+
+    /**
+     * Create a signed 32-bit integer value.
+     */
+    static fromI32(v) {
+
+        const result = wasm.Value_from_i32(v);
+
+        try {
+            return new Value(diplomatRuntime.internalConstructor, result, []);
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+        }
+    }
+
+    /**
+     * Create a 32-bit IEEE 754 float value.
+     */
+    static fromF32(v) {
+
+        const result = wasm.Value_from_f32(v);
+
+        try {
+            return new Value(diplomatRuntime.internalConstructor, result, []);
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+        }
+    }
+
+    /**
+     * Create a boolean value.
+     */
+    static fromBool(v) {
+
+        const result = wasm.Value_from_bool(v);
+
+        try {
+            return new Value(diplomatRuntime.internalConstructor, result, []);
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+        }
+    }
+
+    /**
+     * Create a string value. Fails if the bytes are not valid UTF-8.
+     */
+    static fromString(s) {
+        let functionCleanupArena = new diplomatRuntime.CleanupArena();
+
+        const sSlice = functionCleanupArena.alloc(diplomatRuntime.DiplomatBuf.sliceWrapper(wasm, diplomatRuntime.DiplomatBuf.str8(wasm, s)));
+        const diplomatReceive = new diplomatRuntime.DiplomatReceiveBuf(wasm, 5, 4, true);
+
+
+        const result = wasm.Value_from_string(diplomatReceive.buffer, sSlice.ptr);
+
+        try {
+            if (!diplomatReceive.resultFlag) {
+                const cause = new NucleationError(diplomatRuntime.internalConstructor, diplomatRuntime.enumDiscriminant(wasm, diplomatReceive.buffer));
+                throw new globalThis.Error('NucleationError.' + cause.value, { cause });
+            }
+            return new Value(diplomatRuntime.internalConstructor, diplomatRuntime.ptrRead(wasm, diplomatReceive.buffer), []);
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+            functionCleanupArena.free();
+
+            diplomatReceive.free();
+        }
+    }
+
+    /**
+     * The value as u32. Also accepts u64/non-negative signed ints that
+     * fit, and bool (false → 0, true → 1); fails otherwise.
+     */
+    asU32() {
+        const diplomatReceive = new diplomatRuntime.DiplomatReceiveBuf(wasm, 5, 4, true);
+
+
+        const result = wasm.Value_as_u32(diplomatReceive.buffer, this.ffiValue);
+
+        try {
+            if (!diplomatReceive.resultFlag) {
+                const cause = new NucleationError(diplomatRuntime.internalConstructor, diplomatRuntime.enumDiscriminant(wasm, diplomatReceive.buffer));
+                throw new globalThis.Error('NucleationError.' + cause.value, { cause });
+            }
+            return (new Uint32Array(wasm.memory.buffer, diplomatReceive.buffer, 1))[0];
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+            diplomatReceive.free();
+        }
+    }
+
+    /**
+     * The value as i32. Also accepts i64 values in i32 range; fails for
+     * other types.
+     */
+    asI32() {
+        const diplomatReceive = new diplomatRuntime.DiplomatReceiveBuf(wasm, 5, 4, true);
+
+
+        const result = wasm.Value_as_i32(diplomatReceive.buffer, this.ffiValue);
+
+        try {
+            if (!diplomatReceive.resultFlag) {
+                const cause = new NucleationError(diplomatRuntime.internalConstructor, diplomatRuntime.enumDiscriminant(wasm, diplomatReceive.buffer));
+                throw new globalThis.Error('NucleationError.' + cause.value, { cause });
+            }
+            return (new Int32Array(wasm.memory.buffer, diplomatReceive.buffer, 1))[0];
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+            diplomatReceive.free();
+        }
+    }
+
+    /**
+     * The value as f32; fails if this is not an f32 value.
+     */
+    asF32() {
+        const diplomatReceive = new diplomatRuntime.DiplomatReceiveBuf(wasm, 5, 4, true);
+
+
+        const result = wasm.Value_as_f32(diplomatReceive.buffer, this.ffiValue);
+
+        try {
+            if (!diplomatReceive.resultFlag) {
+                const cause = new NucleationError(diplomatRuntime.internalConstructor, diplomatRuntime.enumDiscriminant(wasm, diplomatReceive.buffer));
+                throw new globalThis.Error('NucleationError.' + cause.value, { cause });
+            }
+            return (new Float32Array(wasm.memory.buffer, diplomatReceive.buffer, 1))[0];
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+            diplomatReceive.free();
+        }
+    }
+
+    /**
+     * The value as bool; fails if this is not a bool value.
+     */
+    asBool() {
+        const diplomatReceive = new diplomatRuntime.DiplomatReceiveBuf(wasm, 5, 1, true);
+
+
+        const result = wasm.Value_as_bool(diplomatReceive.buffer, this.ffiValue);
+
+        try {
+            if (!diplomatReceive.resultFlag) {
+                const cause = new NucleationError(diplomatRuntime.internalConstructor, diplomatRuntime.enumDiscriminant(wasm, diplomatReceive.buffer));
+                throw new globalThis.Error('NucleationError.' + cause.value, { cause });
+            }
+            return (new Uint8Array(wasm.memory.buffer, diplomatReceive.buffer, 1))[0] === 1;
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+            diplomatReceive.free();
+        }
+    }
+
+    /**
+     * The string payload; fails if this is not a string value.
+     */
+    asString() {
+        const diplomatReceive = new diplomatRuntime.DiplomatReceiveBuf(wasm, 5, 4, true);
+
+        const write = new diplomatRuntime.DiplomatWriteBuf(wasm);
+
+
+        const result = wasm.Value_as_string(diplomatReceive.buffer, this.ffiValue, write.buffer);
+
+        try {
+            if (!diplomatReceive.resultFlag) {
+                const cause = new NucleationError(diplomatRuntime.internalConstructor, diplomatRuntime.enumDiscriminant(wasm, diplomatReceive.buffer));
+                throw new globalThis.Error('NucleationError.' + cause.value, { cause });
+            }
+            return write.readString8();
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+            diplomatReceive.free();
+            write.free();
+        }
+    }
+
+    /**
+     * The type name (e.g. "u32", "bool", "string").
+     */
+    typeName() {
+        const write = new diplomatRuntime.DiplomatWriteBuf(wasm);
+
+    wasm.Value_type_name(this.ffiValue, write.buffer);
+
+        try {
+            return write.readString8();
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+            write.free();
+        }
+    }
+
+    constructor(symbol, ptr, selfEdge) {
+        return this.#internalConstructor(...arguments)
+    }
+}

package/WorldChunkView.d.ts

@@ -0,0 +1,63 @@
+// generated by diplomat-tool
+import type { NucleationError } from "./NucleationError"
+import type { Schematic } from "./Schematic"
+import type { pointer, codepoint } from "./diplomat-runtime.d.ts";
+
+
+
+/**
+ * A single decoded chunk (or a from-scratch chunk under construction).
+ */
+export class WorldChunkView {
+    /** @internal */
+    get ffiValue(): pointer;
+    /** @internal */
+    constructor();
+
+
+    /**
+     * Create an empty chunk view at the given chunk coordinates — the
+     * starting point for generating worlds from scratch. Sections are
+     * created on demand by `set_block`. Serialized with
+     * `status = "minecraft:full"` (Minecraft will not regenerate over it)
+     * and the default data version.
+     */
+    static create(cx: number, cz: number): WorldChunkView;
+
+    /**
+     * The chunk X coordinate (in chunk units).
+     */
+    cx(): number;
+
+    /**
+     * The chunk Z coordinate (in chunk units).
+     */
+    cz(): number;
+
+    /**
+     * Convert the chunk view to a standalone schematic.
+     */
+    toSchematic(): Schematic;
+
+    /**
+     * Set a block at absolute world coordinates inside this chunk view.
+     * `block_name` must be a valid Minecraft block identifier (e.g.
+     * `minecraft:stone`). Errors with `InvalidArgument` if (x, z) is outside
+     * this chunk's column.
+     */
+    setBlock(x: number, y: number, z: number, blockName: string): void;
+
+    /**
+     * Overwrite the biome of every currently-present section of the chunk
+     * view with `biome_name` (e.g. `minecraft:desert`). Sections are created
+     * lazily by `set_block`, so call this AFTER placing blocks.
+     */
+    setBiome(biomeName: string): void;
+
+    /**
+     * Deduped union of all sections' biome palette entries, in order of
+     * first appearance, written as a JSON array string (`[]` if no section
+     * carries biome data).
+     */
+    biomePaletteJson(): string;
+}

package/WorldChunkView.mjs

@@ -0,0 +1,201 @@
+// generated by diplomat-tool
+import { NucleationError } from "./NucleationError.mjs"
+import { Schematic } from "./Schematic.mjs"
+import wasm from "./diplomat-wasm.mjs";
+import * as diplomatRuntime from "./diplomat-runtime.mjs";
+
+const WorldChunkView_box_destroy_registry = new FinalizationRegistry((ptr) => {
+    wasm.WorldChunkView_destroy(ptr);
+});
+
+/**
+ * A single decoded chunk (or a from-scratch chunk under construction).
+ */
+export class WorldChunkView {
+    // Internal ptr reference:
+    #ptr = null;
+
+    // Lifetimes are only to keep dependencies alive.
+    // Since JS won't garbage collect until there are no incoming edges.
+    #selfEdge = [];
+
+    #internalConstructor(symbol, ptr, selfEdge) {
+        if (symbol !== diplomatRuntime.internalConstructor) {
+            console.error("WorldChunkView is an Opaque type. You cannot call its constructor.");
+            return;
+        }
+        this.#ptr = ptr;
+        this.#selfEdge = selfEdge;
+
+        // Are we being borrowed? If not, we can register.
+        if (this.#selfEdge.length === 0) {
+            WorldChunkView_box_destroy_registry.register(this, this.#ptr);
+        }
+
+        return this;
+    }
+    /** @internal */
+    get ffiValue() {
+        return this.#ptr;
+    }
+
+
+    /**
+     * Create an empty chunk view at the given chunk coordinates — the
+     * starting point for generating worlds from scratch. Sections are
+     * created on demand by `set_block`. Serialized with
+     * `status = "minecraft:full"` (Minecraft will not regenerate over it)
+     * and the default data version.
+     */
+    static create(cx, cz) {
+
+        const result = wasm.WorldChunkView_create(cx, cz);
+
+        try {
+            return new WorldChunkView(diplomatRuntime.internalConstructor, result, []);
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+        }
+    }
+
+    /**
+     * The chunk X coordinate (in chunk units).
+     */
+    cx() {
+
+        const result = wasm.WorldChunkView_cx(this.ffiValue);
+
+        try {
+            return result;
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+        }
+    }
+
+    /**
+     * The chunk Z coordinate (in chunk units).
+     */
+    cz() {
+
+        const result = wasm.WorldChunkView_cz(this.ffiValue);
+
+        try {
+            return result;
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+        }
+    }
+
+    /**
+     * Convert the chunk view to a standalone schematic.
+     */
+    toSchematic() {
+
+        const result = wasm.WorldChunkView_to_schematic(this.ffiValue);
+
+        try {
+            return new Schematic(diplomatRuntime.internalConstructor, result, []);
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+        }
+    }
+
+    /**
+     * Set a block at absolute world coordinates inside this chunk view.
+     * `block_name` must be a valid Minecraft block identifier (e.g.
+     * `minecraft:stone`). Errors with `InvalidArgument` if (x, z) is outside
+     * this chunk's column.
+     */
+    setBlock(x, y, z, blockName) {
+        let functionCleanupArena = new diplomatRuntime.CleanupArena();
+
+        const blockNameSlice = functionCleanupArena.alloc(diplomatRuntime.DiplomatBuf.sliceWrapper(wasm, diplomatRuntime.DiplomatBuf.str8(wasm, blockName)));
+        const diplomatReceive = new diplomatRuntime.DiplomatReceiveBuf(wasm, 5, 4, true);
+
+
+        const result = wasm.WorldChunkView_set_block(diplomatReceive.buffer, this.ffiValue, x, y, z, blockNameSlice.ptr);
+
+        try {
+            if (!diplomatReceive.resultFlag) {
+                const cause = new NucleationError(diplomatRuntime.internalConstructor, diplomatRuntime.enumDiscriminant(wasm, diplomatReceive.buffer));
+                throw new globalThis.Error('NucleationError.' + cause.value, { cause });
+            }
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+            functionCleanupArena.free();
+
+            diplomatReceive.free();
+        }
+    }
+
+    /**
+     * Overwrite the biome of every currently-present section of the chunk
+     * view with `biome_name` (e.g. `minecraft:desert`). Sections are created
+     * lazily by `set_block`, so call this AFTER placing blocks.
+     */
+    setBiome(biomeName) {
+        let functionCleanupArena = new diplomatRuntime.CleanupArena();
+
+        const biomeNameSlice = functionCleanupArena.alloc(diplomatRuntime.DiplomatBuf.sliceWrapper(wasm, diplomatRuntime.DiplomatBuf.str8(wasm, biomeName)));
+        const diplomatReceive = new diplomatRuntime.DiplomatReceiveBuf(wasm, 5, 4, true);
+
+
+        const result = wasm.WorldChunkView_set_biome(diplomatReceive.buffer, this.ffiValue, biomeNameSlice.ptr);
+
+        try {
+            if (!diplomatReceive.resultFlag) {
+                const cause = new NucleationError(diplomatRuntime.internalConstructor, diplomatRuntime.enumDiscriminant(wasm, diplomatReceive.buffer));
+                throw new globalThis.Error('NucleationError.' + cause.value, { cause });
+            }
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+            functionCleanupArena.free();
+
+            diplomatReceive.free();
+        }
+    }
+
+    /**
+     * Deduped union of all sections' biome palette entries, in order of
+     * first appearance, written as a JSON array string (`[]` if no section
+     * carries biome data).
+     */
+    biomePaletteJson() {
+        const diplomatReceive = new diplomatRuntime.DiplomatReceiveBuf(wasm, 5, 4, true);
+
+        const write = new diplomatRuntime.DiplomatWriteBuf(wasm);
+
+
+        const result = wasm.WorldChunkView_biome_palette_json(diplomatReceive.buffer, this.ffiValue, write.buffer);
+
+        try {
+            if (!diplomatReceive.resultFlag) {
+                const cause = new NucleationError(diplomatRuntime.internalConstructor, diplomatRuntime.enumDiscriminant(wasm, diplomatReceive.buffer));
+                throw new globalThis.Error('NucleationError.' + cause.value, { cause });
+            }
+            return write.readString8();
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+            diplomatReceive.free();
+            write.free();
+        }
+    }
+
+    constructor(symbol, ptr, selfEdge) {
+        return this.#internalConstructor(...arguments)
+    }
+}

package/WorldSink.d.ts

@@ -0,0 +1,50 @@
+// generated by diplomat-tool
+import type { NucleationError } from "./NucleationError"
+import type { WorldChunkView } from "./WorldChunkView"
+import type { pointer, codepoint } from "./diplomat-runtime.d.ts";
+
+
+
+/**
+ * A world writer. `finish` is consuming (PORTING rule 11): the inner sink is
+ * held in an `Option` and taken on `finish`; every method afterwards returns
+ * `AlreadyConsumed`. Dropping the handle without `finish` abandons the sink.
+ */
+export class WorldSink {
+    /** @internal */
+    get ffiValue(): pointer;
+    /** @internal */
+    constructor();
+
+
+    /**
+     * Create a new world sink that writes fresh chunk data to `dir`.
+     * `options_json` is a serialized `WorldExportOptions` (empty string =
+     * defaults).
+     */
+    static create(dir: string, optionsJson: string): WorldSink;
+
+    /**
+     * Open an existing world directory for patching via `put_chunk`.
+     */
+    static openExisting(dir: string): WorldSink;
+
+    /**
+     * Write (append) a chunk view into the sink. The view is not consumed.
+     */
+    writeChunk(view: WorldChunkView): void;
+
+    /**
+     * Overwrite the chunk at (`view.cx`, `view.cz`) of the sink's world with
+     * the supplied view's block data. Only valid on sinks opened with
+     * `open_existing`; errors with `Io` on a create-mode sink. The view is
+     * not consumed.
+     */
+    putChunk(view: WorldChunkView): void;
+
+    /**
+     * Finalise and flush all pending writes. Consuming (PORTING rule 11):
+     * afterwards every method on this sink returns `AlreadyConsumed`.
+     */
+    finish(): void;
+}