nucleation 0.10.22 → 0.10.24

package/renderer/WsProfile.d.mts

@@ -0,0 +1,46 @@
+// generated by diplomat-tool
+import type { NucleationError } from "./NucleationError.mjs"
+import type { pointer, codepoint } from "./diplomat-runtime.d.ts";
+
+
+
+/**
+ * A pinned {@link WorldProfile}(crate::world_segment::profile::WorldProfile):
+ * the substrate palette + Y band derived (or supplied) once per world and
+ * reused across every segmentation run against it.
+ */
+export class WsProfile {
+    /** @internal */
+    get ffiValue(): pointer;
+    /** @internal */
+    constructor();
+
+
+    /**
+     * Derive a profile from up to `sample` tiles (regions) of a world
+     * directory, in ascending `(x, z)` region order. `coverage` is
+     * `ProfileParams::min_slab_coverage`; every other `ProfileParams`
+     * field uses its default (`sample_stride: 1`, `y_scan: (-64, 320)`).
+     */
+    static deriveFromDir(worldDir: string, minY: number, maxY: number, sample: number, coverage: number): WsProfile;
+
+    /**
+     * The derived substrate Y band's lower bound (inclusive).
+     */
+    bandMin(): number;
+
+    /**
+     * The derived substrate Y band's upper bound (inclusive).
+     */
+    bandMax(): number;
+
+    /**
+     * Number of distinct block names in the substrate palette.
+     */
+    paletteLen(): number;
+
+    /**
+     * The substrate palette as a JSON array of block-name strings.
+     */
+    writePaletteJson(): string;
+}

package/renderer/WsProfile.d.ts

@@ -0,0 +1,46 @@
+// generated by diplomat-tool
+import type { NucleationError } from "./NucleationError.mjs"
+import type { pointer, codepoint } from "./diplomat-runtime.d.ts";
+
+
+
+/**
+ * A pinned {@link WorldProfile}(crate::world_segment::profile::WorldProfile):
+ * the substrate palette + Y band derived (or supplied) once per world and
+ * reused across every segmentation run against it.
+ */
+export class WsProfile {
+    /** @internal */
+    get ffiValue(): pointer;
+    /** @internal */
+    constructor();
+
+
+    /**
+     * Derive a profile from up to `sample` tiles (regions) of a world
+     * directory, in ascending `(x, z)` region order. `coverage` is
+     * `ProfileParams::min_slab_coverage`; every other `ProfileParams`
+     * field uses its default (`sample_stride: 1`, `y_scan: (-64, 320)`).
+     */
+    static deriveFromDir(worldDir: string, minY: number, maxY: number, sample: number, coverage: number): WsProfile;
+
+    /**
+     * The derived substrate Y band's lower bound (inclusive).
+     */
+    bandMin(): number;
+
+    /**
+     * The derived substrate Y band's upper bound (inclusive).
+     */
+    bandMax(): number;
+
+    /**
+     * Number of distinct block names in the substrate palette.
+     */
+    paletteLen(): number;
+
+    /**
+     * The substrate palette as a JSON array of block-name strings.
+     */
+    writePaletteJson(): string;
+}

package/renderer/WsProfile.mjs

@@ -0,0 +1,152 @@
+// generated by diplomat-tool
+import { NucleationError } from "./NucleationError.mjs"
+import wasm from "./diplomat-wasm.mjs";
+import * as diplomatRuntime from "./diplomat-runtime.mjs";
+
+const WsProfile_box_destroy_registry = new FinalizationRegistry((ptr) => {
+    wasm.WsProfile_destroy(ptr);
+});
+
+/**
+ * A pinned {@link WorldProfile}(crate::world_segment::profile::WorldProfile):
+ * the substrate palette + Y band derived (or supplied) once per world and
+ * reused across every segmentation run against it.
+ */
+export class WsProfile {
+    // 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("WsProfile 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) {
+            WsProfile_box_destroy_registry.register(this, this.#ptr);
+        }
+
+        return this;
+    }
+    /** @internal */
+    get ffiValue() {
+        return this.#ptr;
+    }
+
+
+    /**
+     * Derive a profile from up to `sample` tiles (regions) of a world
+     * directory, in ascending `(x, z)` region order. `coverage` is
+     * `ProfileParams::min_slab_coverage`; every other `ProfileParams`
+     * field uses its default (`sample_stride: 1`, `y_scan: (-64, 320)`).
+     */
+    static deriveFromDir(worldDir, minY, maxY, sample, coverage) {
+        let functionCleanupArena = new diplomatRuntime.CleanupArena();
+
+        const worldDirSlice = functionCleanupArena.alloc(diplomatRuntime.DiplomatBuf.sliceWrapper(wasm, diplomatRuntime.DiplomatBuf.str8(wasm, worldDir)));
+        const diplomatReceive = new diplomatRuntime.DiplomatReceiveBuf(wasm, 5, 4, true);
+
+
+        const result = wasm.WsProfile_derive_from_dir(diplomatReceive.buffer, worldDirSlice.ptr, minY, maxY, sample, coverage);
+
+        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 WsProfile(diplomatRuntime.internalConstructor, diplomatRuntime.ptrRead(wasm, diplomatReceive.buffer), []);
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+            functionCleanupArena.free();
+
+            diplomatReceive.free();
+        }
+    }
+
+    /**
+     * The derived substrate Y band's lower bound (inclusive).
+     */
+    bandMin() {
+
+        const result = wasm.WsProfile_band_min(this.ffiValue);
+
+        try {
+            return result;
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+        }
+    }
+
+    /**
+     * The derived substrate Y band's upper bound (inclusive).
+     */
+    bandMax() {
+
+        const result = wasm.WsProfile_band_max(this.ffiValue);
+
+        try {
+            return result;
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+        }
+    }
+
+    /**
+     * Number of distinct block names in the substrate palette.
+     */
+    paletteLen() {
+
+        const result = wasm.WsProfile_palette_len(this.ffiValue);
+
+        try {
+            return result;
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+        }
+    }
+
+    /**
+     * The substrate palette as a JSON array of block-name strings.
+     */
+    writePaletteJson() {
+        const diplomatReceive = new diplomatRuntime.DiplomatReceiveBuf(wasm, 5, 4, true);
+
+        const write = new diplomatRuntime.DiplomatWriteBuf(wasm);
+
+
+        const result = wasm.WsProfile_write_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/renderer/WsRunResult.d.mts

@@ -0,0 +1,83 @@
+// generated by diplomat-tool
+import type { BlockPos } from "./BlockPos.mjs"
+import type { NucleationError } from "./NucleationError.mjs"
+import type { WsPartitionHints } from "./WsPartitionHints.mjs"
+import type { WsProfile } from "./WsProfile.mjs"
+import type { WsSegmentJob } from "./WsSegmentJob.mjs"
+import type { pointer, codepoint } from "./diplomat-runtime.d.ts";
+
+
+
+/**
+ * The materialized output of one segmentation run: every build (in the
+ * pipeline's deterministic stable-id order) plus the aggregate
+ * {@link RunStats}(crate::world_segment::runner::RunStats).
+ */
+export class WsRunResult {
+    /** @internal */
+    get ffiValue(): pointer;
+    /** @internal */
+    constructor();
+
+
+    /**
+     * Run the full pipeline (source -> segment -> stitch -> score ->
+     * identity -> materialize) over a world directory. No prior-snapshot
+     * builds are supplied, so every build seeds a fresh stable id (see
+     * `StableBuildId::seed`).
+     *
+     * See the module docs for why this catches a panic instead of
+     * propagating it.
+     */
+    static runDir(job: WsSegmentJob, hints: WsPartitionHints, profile: WsProfile, worldDir: string): WsRunResult;
+
+    /**
+     * Total builds materialized (same as `build_count`, from `RunStats`).
+     */
+    builds(): bigint;
+
+    tierConfident(): bigint;
+
+    tierProbable(): bigint;
+
+    tierDebris(): bigint;
+
+    crossTile(): bigint;
+
+    largestBlockCount(): bigint;
+
+    /**
+     * Number of builds held in this result (indices `0..build_count()`
+     * are valid for every per-index accessor below).
+     */
+    buildCount(): number;
+
+    /**
+     * The build's stable id (hex), stable across re-runs against the
+     * same source under the same config, absent a prior-snapshot match.
+     */
+    stableIdHex(index: number): string;
+
+    /**
+     * The build's content fingerprint, as 32 lowercase hex digits (u128,
+     * big-endian).
+     */
+    fingerprintHex(index: number): string;
+
+    /**
+     * `0` = Confident, `1` = Probable, `2` = Debris.
+     */
+    tierOf(index: number): number;
+
+    blockCountOf(index: number): bigint;
+
+    /**
+     * The build's world-space bounding box minimum (inclusive).
+     */
+    bboxMinOf(index: number): BlockPos;
+
+    /**
+     * The build's world-space bounding box maximum (inclusive).
+     */
+    bboxMaxOf(index: number): BlockPos;
+}

package/renderer/WsRunResult.d.ts

@@ -0,0 +1,83 @@
+// generated by diplomat-tool
+import type { BlockPos } from "./BlockPos.mjs"
+import type { NucleationError } from "./NucleationError.mjs"
+import type { WsPartitionHints } from "./WsPartitionHints.mjs"
+import type { WsProfile } from "./WsProfile.mjs"
+import type { WsSegmentJob } from "./WsSegmentJob.mjs"
+import type { pointer, codepoint } from "./diplomat-runtime.d.ts";
+
+
+
+/**
+ * The materialized output of one segmentation run: every build (in the
+ * pipeline's deterministic stable-id order) plus the aggregate
+ * {@link RunStats}(crate::world_segment::runner::RunStats).
+ */
+export class WsRunResult {
+    /** @internal */
+    get ffiValue(): pointer;
+    /** @internal */
+    constructor();
+
+
+    /**
+     * Run the full pipeline (source -> segment -> stitch -> score ->
+     * identity -> materialize) over a world directory. No prior-snapshot
+     * builds are supplied, so every build seeds a fresh stable id (see
+     * `StableBuildId::seed`).
+     *
+     * See the module docs for why this catches a panic instead of
+     * propagating it.
+     */
+    static runDir(job: WsSegmentJob, hints: WsPartitionHints, profile: WsProfile, worldDir: string): WsRunResult;
+
+    /**
+     * Total builds materialized (same as `build_count`, from `RunStats`).
+     */
+    builds(): bigint;
+
+    tierConfident(): bigint;
+
+    tierProbable(): bigint;
+
+    tierDebris(): bigint;
+
+    crossTile(): bigint;
+
+    largestBlockCount(): bigint;
+
+    /**
+     * Number of builds held in this result (indices `0..build_count()`
+     * are valid for every per-index accessor below).
+     */
+    buildCount(): number;
+
+    /**
+     * The build's stable id (hex), stable across re-runs against the
+     * same source under the same config, absent a prior-snapshot match.
+     */
+    stableIdHex(index: number): string;
+
+    /**
+     * The build's content fingerprint, as 32 lowercase hex digits (u128,
+     * big-endian).
+     */
+    fingerprintHex(index: number): string;
+
+    /**
+     * `0` = Confident, `1` = Probable, `2` = Debris.
+     */
+    tierOf(index: number): number;
+
+    blockCountOf(index: number): bigint;
+
+    /**
+     * The build's world-space bounding box minimum (inclusive).
+     */
+    bboxMinOf(index: number): BlockPos;
+
+    /**
+     * The build's world-space bounding box maximum (inclusive).
+     */
+    bboxMaxOf(index: number): BlockPos;
+}