nucleation 0.5.1 → 0.7.0

package/WorldSink.d.mts

@@ -0,0 +1,50 @@
+// generated by diplomat-tool
+import type { NucleationError } from "./NucleationError.mjs"
+import type { WorldChunkView } from "./WorldChunkView.mjs"
+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;
+}

package/WorldSink.d.ts

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

package/WorldStream.d.mts

@@ -0,0 +1,45 @@
+// generated by diplomat-tool
+import type { NucleationError } from "./NucleationError.mjs"
+import type { WorldChunkView } from "./WorldChunkView.mjs"
+import type { pointer, codepoint } from "./diplomat-runtime.d.ts";
+
+
+
+/**
+ * A streaming iterator over the chunks of a world.
+ */
+export class WorldStream {
+    /** @internal */
+    get ffiValue(): pointer;
+    /** @internal */
+    constructor();
+
+
+    /**
+     * Open a streaming iterator over a world directory.
+     */
+    static openDir(path: string): WorldStream;
+
+    /**
+     * Open a streaming iterator over a world directory, bounded to the given
+     * block-coordinate box `[min_x..max_x, min_y..max_y, min_z..max_z]`.
+     */
+    static openDirBounded(path: string, minX: number, minY: number, minZ: number, maxX: number, maxY: number, maxZ: number): WorldStream;
+
+    /**
+     * Open a streaming iterator from a zip archive in memory.
+     */
+    static fromZip(data: Array<number>): WorldStream;
+
+    /**
+     * Open a bounded streaming iterator from a zip archive in memory.
+     */
+    static fromZipBounded(data: Array<number>, minX: number, minY: number, minZ: number, maxX: number, maxY: number, maxZ: number): WorldStream;
+
+    /**
+     * Advance the iterator and return the next chunk view. Errors with
+     * `NotFound` at end-of-stream (the old ABI returned NULL). Corrupt
+     * chunks are silently skipped, matching the old ABI.
+     */
+    next(): WorldChunkView;
+}

package/WorldStream.d.ts

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

package/WsPartitionHints.d.mts

@@ -0,0 +1,29 @@
+// generated by diplomat-tool
+import type { NucleationError } from "./NucleationError.mjs"
+import type { pointer, codepoint } from "./diplomat-runtime.d.ts";
+
+
+
+/**
+ * Caller-supplied partition hints (full-column boxes a cluster may never
+ * span under {@link PartitionPolicy::HardCut}). Order does not matter:
+ * {@link PartitionIndex::new}(crate::world_segment::partition::PartitionIndex)
+ * sorts hints by full content at construction time.
+ */
+export class WsPartitionHints {
+    /** @internal */
+    get ffiValue(): pointer;
+    /** @internal */
+    constructor();
+
+
+    static create(): WsPartitionHints;
+
+    /**
+     * Add a full-column hint (`y_range: None`) covering inclusive
+     * `x0..=x1, z0..=z1`.
+     */
+    add(id: string, x0: number, x1: number, z0: number, z1: number): void;
+
+    len(): number;
+}

package/WsPartitionHints.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/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/WsProfile.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/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/WsRunResult.d.ts

@@ -1,9 +1,9 @@
 // generated by diplomat-tool
-import type { BlockPos } from "./BlockPos"
-import type { NucleationError } from "./NucleationError"
-import type { WsPartitionHints } from "./WsPartitionHints"
-import type { WsProfile } from "./WsProfile"
-import type { WsSegmentJob } from "./WsSegmentJob"
+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";
 
 

package/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/WsSegmentJob.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/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/index.d.mts

@@ -0,0 +1,177 @@
+
+export { codepoint } from './diplomat-runtime.mjs';
+
+
+export { RegionBounds, RegionBounds_obj } from "./RegionBounds.mjs"
+
+export { ItemScale, ItemScale_obj } from "./ItemScale.mjs"
+
+export { MeshBounds, MeshBounds_obj } from "./MeshBounds.mjs"
+
+export { MeshProgress, MeshProgress_obj } from "./MeshProgress.mjs"
+
+export { TextureInfo, TextureInfo_obj } from "./TextureInfo.mjs"
+
+export { BlockPos, BlockPos_obj } from "./BlockPos.mjs"
+
+export { Dimensions, Dimensions_obj } from "./Dimensions.mjs"
+
+export { FieldRange } from "./FieldRange.mjs"
+
+export { SdfBounds } from "./SdfBounds.mjs"
+
+export { SdfNormal } from "./SdfNormal.mjs"
+
+export { AnimationEffect } from "./AnimationEffect.mjs"
+
+export { BuildAnimation } from "./BuildAnimation.mjs"
+
+export { VideoConfig } from "./VideoConfig.mjs"
+
+export { Autostack } from "./Autostack.mjs"
+
+export { Blocks } from "./Blocks.mjs"
+
+export { Brush } from "./Brush.mjs"
+
+export { BuildingTool } from "./BuildingTool.mjs"
+
+export { Curve3D } from "./Curve3D.mjs"
+
+export { Palette } from "./Palette.mjs"
+
+export { PaletteBuilder } from "./PaletteBuilder.mjs"
+
+export { Shape } from "./Shape.mjs"
+
+export { DefinitionRegion } from "./DefinitionRegion.mjs"
+
+export { SchematicRegions } from "./SchematicRegions.mjs"
+
+export { Diff } from "./Diff.mjs"
+
+export { Fingerprint } from "./Fingerprint.mjs"
+
+export { DistanceField } from "./DistanceField.mjs"
+
+export { Field3 } from "./Field3.mjs"
+
+export { Geo } from "./Geo.mjs"
+
+export { ChunkMeshResult } from "./ChunkMeshResult.mjs"
+
+export { ItemModelConfig } from "./ItemModelConfig.mjs"
+
+export { ItemModelPackBuilder } from "./ItemModelPackBuilder.mjs"
+
+export { ItemModelResult } from "./ItemModelResult.mjs"
+
+export { MeshConfig } from "./MeshConfig.mjs"
+
+export { MeshJob } from "./MeshJob.mjs"
+
+export { MeshResult } from "./MeshResult.mjs"
+
+export { MultiMeshResult } from "./MultiMeshResult.mjs"
+
+export { RawMeshExport } from "./RawMeshExport.mjs"
+
+export { ResourcePack } from "./ResourcePack.mjs"
+
+export { ResourcePackList } from "./ResourcePackList.mjs"
+
+export { TextureAtlas } from "./TextureAtlas.mjs"
+
+export { Nbt } from "./Nbt.mjs"
+
+export { RenderConfig } from "./RenderConfig.mjs"
+
+export { Renderer } from "./Renderer.mjs"
+
+export { BlockState } from "./BlockState.mjs"
+
+export { Schematic } from "./Schematic.mjs"
+
+export { SchematicBuilder } from "./SchematicBuilder.mjs"
+
+export { Scripting } from "./Scripting.mjs"
+
+export { FieldProgram } from "./FieldProgram.mjs"
+
+export { FieldProgramBuilder } from "./FieldProgramBuilder.mjs"
+
+export { Sdf } from "./Sdf.mjs"
+
+export { CircuitBuilder } from "./CircuitBuilder.mjs"
+
+export { ExecutionMode } from "./ExecutionMode.mjs"
+
+export { IoLayout } from "./IoLayout.mjs"
+
+export { IoLayoutBuilder } from "./IoLayoutBuilder.mjs"
+
+export { IoType } from "./IoType.mjs"
+
+export { LayoutFunction } from "./LayoutFunction.mjs"
+
+export { MchprsWorld } from "./MchprsWorld.mjs"
+
+export { OutputCondition } from "./OutputCondition.mjs"
+
+export { RedstoneGraph } from "./RedstoneGraph.mjs"
+
+export { SortStrategy } from "./SortStrategy.mjs"
+
+export { TypedCircuitExecutor } from "./TypedCircuitExecutor.mjs"
+
+export { Value } from "./Value.mjs"
+
+export { Store } from "./Store.mjs"
+
+export { StoreIo } from "./StoreIo.mjs"
+
+export { Voxelizer } from "./Voxelizer.mjs"
+
+export { CellularSdfConfig } from "./CellularSdfConfig.mjs"
+
+export { GeneratedChunk } from "./GeneratedChunk.mjs"
+
+export { GeneratedWorldStream } from "./GeneratedWorldStream.mjs"
+
+export { WorldGenerator } from "./WorldGenerator.mjs"
+
+export { WsPartitionHints } from "./WsPartitionHints.mjs"
+
+export { WsProfile } from "./WsProfile.mjs"
+
+export { WsRunResult } from "./WsRunResult.mjs"
+
+export { WsSegmentJob } from "./WsSegmentJob.mjs"
+
+export { WorldChunkView } from "./WorldChunkView.mjs"
+
+export { WorldSink } from "./WorldSink.mjs"
+
+export { WorldStream } from "./WorldStream.mjs"
+
+export { InterpolationSpace } from "./InterpolationSpace.mjs"
+
+export { MeshPhase } from "./MeshPhase.mjs"
+
+export { FieldProgramBinaryOp } from "./FieldProgramBinaryOp.mjs"
+
+export { FieldProgramDistanceKind } from "./FieldProgramDistanceKind.mjs"
+
+export { FieldProgramUnaryOp } from "./FieldProgramUnaryOp.mjs"
+
+export { FieldProgramValueType } from "./FieldProgramValueType.mjs"
+
+export { SdfAxis } from "./SdfAxis.mjs"
+
+export { SdfCellMode } from "./SdfCellMode.mjs"
+
+export { NucleationError } from "./NucleationError.mjs"
+
+export { GeneratedChunkCoverage } from "./GeneratedChunkCoverage.mjs"
+
+export { GeneratedChunkOverlayMode } from "./GeneratedChunkOverlayMode.mjs"