nucleation 0.10.22 → 0.10.24

package/renderer/WsRunResult.mjs

@@ -0,0 +1,326 @@
+// generated by diplomat-tool
+import { BlockPos } from "./BlockPos.mjs"
+import { NucleationError } from "./NucleationError.mjs"
+import { WsPartitionHints } from "./WsPartitionHints.mjs"
+import { WsProfile } from "./WsProfile.mjs"
+import { WsSegmentJob } from "./WsSegmentJob.mjs"
+import wasm from "./diplomat-wasm.mjs";
+import * as diplomatRuntime from "./diplomat-runtime.mjs";
+
+const WsRunResult_box_destroy_registry = new FinalizationRegistry((ptr) => {
+    wasm.WsRunResult_destroy(ptr);
+});
+
+/**
+ * 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 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("WsRunResult 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) {
+            WsRunResult_box_destroy_registry.register(this, this.#ptr);
+        }
+
+        return this;
+    }
+    /** @internal */
+    get ffiValue() {
+        return this.#ptr;
+    }
+
+
+    /**
+     * 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, hints, profile, worldDir) {
+        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.WsRunResult_run_dir(diplomatReceive.buffer, job.ffiValue, hints.ffiValue, profile.ffiValue, worldDirSlice.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 WsRunResult(diplomatRuntime.internalConstructor, diplomatRuntime.ptrRead(wasm, diplomatReceive.buffer), []);
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+            functionCleanupArena.free();
+
+            diplomatReceive.free();
+        }
+    }
+
+    /**
+     * Total builds materialized (same as `build_count`, from `RunStats`).
+     */
+    builds() {
+
+        const result = wasm.WsRunResult_builds(this.ffiValue);
+
+        try {
+            return result;
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+        }
+    }
+
+    tierConfident() {
+
+        const result = wasm.WsRunResult_tier_confident(this.ffiValue);
+
+        try {
+            return result;
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+        }
+    }
+
+    tierProbable() {
+
+        const result = wasm.WsRunResult_tier_probable(this.ffiValue);
+
+        try {
+            return result;
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+        }
+    }
+
+    tierDebris() {
+
+        const result = wasm.WsRunResult_tier_debris(this.ffiValue);
+
+        try {
+            return result;
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+        }
+    }
+
+    crossTile() {
+
+        const result = wasm.WsRunResult_cross_tile(this.ffiValue);
+
+        try {
+            return result;
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+        }
+    }
+
+    largestBlockCount() {
+
+        const result = wasm.WsRunResult_largest_block_count(this.ffiValue);
+
+        try {
+            return result;
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+        }
+    }
+
+    /**
+     * Number of builds held in this result (indices `0..build_count()`
+     * are valid for every per-index accessor below).
+     */
+    buildCount() {
+
+        const result = wasm.WsRunResult_build_count(this.ffiValue);
+
+        try {
+            return result;
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+        }
+    }
+
+    /**
+     * 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) {
+        const diplomatReceive = new diplomatRuntime.DiplomatReceiveBuf(wasm, 5, 4, true);
+
+        const write = new diplomatRuntime.DiplomatWriteBuf(wasm);
+
+
+        const result = wasm.WsRunResult_stable_id_hex(diplomatReceive.buffer, this.ffiValue, index, 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 build's content fingerprint, as 32 lowercase hex digits (u128,
+     * big-endian).
+     */
+    fingerprintHex(index) {
+        const diplomatReceive = new diplomatRuntime.DiplomatReceiveBuf(wasm, 5, 4, true);
+
+        const write = new diplomatRuntime.DiplomatWriteBuf(wasm);
+
+
+        const result = wasm.WsRunResult_fingerprint_hex(diplomatReceive.buffer, this.ffiValue, index, 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();
+        }
+    }
+
+    /**
+     * `0` = Confident, `1` = Probable, `2` = Debris.
+     */
+    tierOf(index) {
+        const diplomatReceive = new diplomatRuntime.DiplomatReceiveBuf(wasm, 5, 1, true);
+
+
+        const result = wasm.WsRunResult_tier_of(diplomatReceive.buffer, this.ffiValue, index);
+
+        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];
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+            diplomatReceive.free();
+        }
+    }
+
+    blockCountOf(index) {
+        const diplomatReceive = new diplomatRuntime.DiplomatReceiveBuf(wasm, 9, 8, true);
+
+
+        const result = wasm.WsRunResult_block_count_of(diplomatReceive.buffer, this.ffiValue, index);
+
+        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 BigUint64Array(wasm.memory.buffer, diplomatReceive.buffer, 1))[0];
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+            diplomatReceive.free();
+        }
+    }
+
+    /**
+     * The build's world-space bounding box minimum (inclusive).
+     */
+    bboxMinOf(index) {
+        const diplomatReceive = new diplomatRuntime.DiplomatReceiveBuf(wasm, 13, 4, true);
+
+
+        const result = wasm.WsRunResult_bbox_min_of(diplomatReceive.buffer, this.ffiValue, index);
+
+        try {
+            if (!diplomatReceive.resultFlag) {
+                const cause = new NucleationError(diplomatRuntime.internalConstructor, diplomatRuntime.enumDiscriminant(wasm, diplomatReceive.buffer));
+                throw new globalThis.Error('NucleationError.' + cause.value, { cause });
+            }
+            return BlockPos._fromFFI(diplomatRuntime.internalConstructor, diplomatReceive.buffer);
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+            diplomatReceive.free();
+        }
+    }
+
+    /**
+     * The build's world-space bounding box maximum (inclusive).
+     */
+    bboxMaxOf(index) {
+        const diplomatReceive = new diplomatRuntime.DiplomatReceiveBuf(wasm, 13, 4, true);
+
+
+        const result = wasm.WsRunResult_bbox_max_of(diplomatReceive.buffer, this.ffiValue, index);
+
+        try {
+            if (!diplomatReceive.resultFlag) {
+                const cause = new NucleationError(diplomatRuntime.internalConstructor, diplomatRuntime.enumDiscriminant(wasm, diplomatReceive.buffer));
+                throw new globalThis.Error('NucleationError.' + cause.value, { cause });
+            }
+            return BlockPos._fromFFI(diplomatRuntime.internalConstructor, diplomatReceive.buffer);
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+            diplomatReceive.free();
+        }
+    }
+
+    constructor(symbol, ptr, selfEdge) {
+        return this.#internalConstructor(...arguments)
+    }
+}

package/renderer/WsSegmentJob.d.mts

@@ -0,0 +1,28 @@
+// generated by diplomat-tool
+import type { NucleationError } from "./NucleationError.mjs"
+import type { pointer, codepoint } from "./diplomat-runtime.d.ts";
+
+
+
+/**
+ * One segmentation run's parameters (the primitive knobs of
+ * {@link SegmentJob}(crate::world_segment::runner::SegmentJob), plus a
+ * `hard_cut` flag selecting {@link PartitionPolicy}). Built once, passed by
+ * reference into {@link WsRunResult::run_dir}.
+ */
+export class WsSegmentJob {
+    /** @internal */
+    get ffiValue(): pointer;
+    /** @internal */
+    constructor();
+
+
+    /**
+     * `algorithm_version` is pinned to
+     * {@link SegConfig::default}(crate::world_segment::segment::SegConfig)'s
+     * value; `score_config` uses `ScoreConfig::default()`. Neither is
+     * exposed as a knob here — construct a `SegmentJob` directly in Rust
+     * if you need to override them.
+     */
+    static create(cellSize: number, closingRadius: number, minClusterBlocks: bigint, sourceId: string, snapshotId: string, minY: number, maxY: number, extractedAt: bigint, matchIou: number, hardCut: boolean): WsSegmentJob;
+}

package/renderer/WsSegmentJob.d.ts

@@ -0,0 +1,28 @@
+// generated by diplomat-tool
+import type { NucleationError } from "./NucleationError.mjs"
+import type { pointer, codepoint } from "./diplomat-runtime.d.ts";
+
+
+
+/**
+ * One segmentation run's parameters (the primitive knobs of
+ * {@link SegmentJob}(crate::world_segment::runner::SegmentJob), plus a
+ * `hard_cut` flag selecting {@link PartitionPolicy}). Built once, passed by
+ * reference into {@link WsRunResult::run_dir}.
+ */
+export class WsSegmentJob {
+    /** @internal */
+    get ffiValue(): pointer;
+    /** @internal */
+    constructor();
+
+
+    /**
+     * `algorithm_version` is pinned to
+     * {@link SegConfig::default}(crate::world_segment::segment::SegConfig)'s
+     * value; `score_config` uses `ScoreConfig::default()`. Neither is
+     * exposed as a knob here — construct a `SegmentJob` directly in Rust
+     * if you need to override them.
+     */
+    static create(cellSize: number, closingRadius: number, minClusterBlocks: bigint, sourceId: string, snapshotId: string, minY: number, maxY: number, extractedAt: bigint, matchIou: number, hardCut: boolean): WsSegmentJob;
+}

package/renderer/WsSegmentJob.mjs

@@ -0,0 +1,81 @@
+// generated by diplomat-tool
+import { NucleationError } from "./NucleationError.mjs"
+import wasm from "./diplomat-wasm.mjs";
+import * as diplomatRuntime from "./diplomat-runtime.mjs";
+
+const WsSegmentJob_box_destroy_registry = new FinalizationRegistry((ptr) => {
+    wasm.WsSegmentJob_destroy(ptr);
+});
+
+/**
+ * One segmentation run's parameters (the primitive knobs of
+ * {@link SegmentJob}(crate::world_segment::runner::SegmentJob), plus a
+ * `hard_cut` flag selecting {@link PartitionPolicy}). Built once, passed by
+ * reference into {@link WsRunResult::run_dir}.
+ */
+export class WsSegmentJob {
+    // 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("WsSegmentJob 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) {
+            WsSegmentJob_box_destroy_registry.register(this, this.#ptr);
+        }
+
+        return this;
+    }
+    /** @internal */
+    get ffiValue() {
+        return this.#ptr;
+    }
+
+
+    /**
+     * `algorithm_version` is pinned to
+     * {@link SegConfig::default}(crate::world_segment::segment::SegConfig)'s
+     * value; `score_config` uses `ScoreConfig::default()`. Neither is
+     * exposed as a knob here — construct a `SegmentJob` directly in Rust
+     * if you need to override them.
+     */
+    static create(cellSize, closingRadius, minClusterBlocks, sourceId, snapshotId, minY, maxY, extractedAt, matchIou, hardCut) {
+        let functionCleanupArena = new diplomatRuntime.CleanupArena();
+
+        const sourceIdSlice = functionCleanupArena.alloc(diplomatRuntime.DiplomatBuf.sliceWrapper(wasm, diplomatRuntime.DiplomatBuf.str8(wasm, sourceId)));
+        const snapshotIdSlice = functionCleanupArena.alloc(diplomatRuntime.DiplomatBuf.sliceWrapper(wasm, diplomatRuntime.DiplomatBuf.str8(wasm, snapshotId)));
+        const diplomatReceive = new diplomatRuntime.DiplomatReceiveBuf(wasm, 5, 4, true);
+
+
+        const result = wasm.WsSegmentJob_create(diplomatReceive.buffer, cellSize, closingRadius, minClusterBlocks, sourceIdSlice.ptr, snapshotIdSlice.ptr, minY, maxY, extractedAt, matchIou, hardCut);
+
+        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 WsSegmentJob(diplomatRuntime.internalConstructor, diplomatRuntime.ptrRead(wasm, diplomatReceive.buffer), []);
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+            functionCleanupArena.free();
+
+            diplomatReceive.free();
+        }
+    }
+
+    constructor(symbol, ptr, selfEdge) {
+        return this.#internalConstructor(...arguments)
+    }
+}

package/renderer/diplomat-runtime.d.mts

@@ -0,0 +1,15 @@
+/// A [codepoint] is a Unicode code point, such as `a`, or `💡`.
+///
+/// The recommended way to obtain a `codepoint` is to create it from a
+/// `String`, which is conceptually a list of `codepoint`s. For example,
+/// `'a'.codePointAt(0)` is equal to the `char` `a`.
+///
+/// JS does not have a character/codepoint literal, so integer literals
+/// need to be used. For example the Unicode code point U+1F4A1, `💡`,
+/// can be represented by `0x1F4A1`. Note that only values in the ranges
+/// `0x0..0xD7FF` and `0xE000..0x10FFFF` (both inclusive) are Unicode
+/// code points, and hence valid `codepoint`s.
+///
+/// A `String` can be constructed from a `codepoint` using `String.fromCodePoint()`.
+export type codepoint = number;
+export type pointer = number;

package/renderer/diplomat-runtime.d.ts

@@ -0,0 +1,15 @@
+/// A [codepoint] is a Unicode code point, such as `a`, or `💡`.
+///
+/// The recommended way to obtain a `codepoint` is to create it from a
+/// `String`, which is conceptually a list of `codepoint`s. For example,
+/// `'a'.codePointAt(0)` is equal to the `char` `a`.
+///
+/// JS does not have a character/codepoint literal, so integer literals
+/// need to be used. For example the Unicode code point U+1F4A1, `💡`,
+/// can be represented by `0x1F4A1`. Note that only values in the ranges
+/// `0x0..0xD7FF` and `0xE000..0x10FFFF` (both inclusive) are Unicode
+/// code points, and hence valid `codepoint`s.
+///
+/// A `String` can be constructed from a `codepoint` using `String.fromCodePoint()`.
+export type codepoint = number;
+export type pointer = number;