nucleation 0.6.0 → 0.7.0

package/FieldProgramDistanceKind.d.mts

@@ -0,0 +1,26 @@
+// generated by diplomat-tool
+import type { pointer, codepoint } from "./diplomat-runtime.d.ts";
+
+
+
+/**
+ * What kind of distance a field program's output represents.
+ */
+export class FieldProgramDistanceKind {
+
+    /** @internal */
+    static fromValue(value: FieldProgramDistanceKind | string): FieldProgramDistanceKind;
+
+    get value(): string;
+
+    /** @internal */
+    get ffiValue(): number;
+
+    static Exact : FieldProgramDistanceKind;
+    static LowerBound : FieldProgramDistanceKind;
+    static Estimate : FieldProgramDistanceKind;
+    static Implicit : FieldProgramDistanceKind;
+
+
+    constructor(value: FieldProgramDistanceKind | string );
+}

package/FieldProgramDistanceKind.d.ts

@@ -0,0 +1,26 @@
+// generated by diplomat-tool
+import type { pointer, codepoint } from "./diplomat-runtime.d.ts";
+
+
+
+/**
+ * What kind of distance a field program's output represents.
+ */
+export class FieldProgramDistanceKind {
+
+    /** @internal */
+    static fromValue(value: FieldProgramDistanceKind | string): FieldProgramDistanceKind;
+
+    get value(): string;
+
+    /** @internal */
+    get ffiValue(): number;
+
+    static Exact : FieldProgramDistanceKind;
+    static LowerBound : FieldProgramDistanceKind;
+    static Estimate : FieldProgramDistanceKind;
+    static Implicit : FieldProgramDistanceKind;
+
+
+    constructor(value: FieldProgramDistanceKind | string );
+}

package/FieldProgramDistanceKind.mjs

@@ -0,0 +1,78 @@
+// generated by diplomat-tool
+import wasm from "./diplomat-wasm.mjs";
+import * as diplomatRuntime from "./diplomat-runtime.mjs";
+
+
+
+/**
+ * What kind of distance a field program's output represents.
+ */
+export class FieldProgramDistanceKind {
+    #value = undefined;
+
+    static #values = new Map([
+        ["Exact", 0],
+        ["LowerBound", 1],
+        ["Estimate", 2],
+        ["Implicit", 3]
+    ]);
+
+    static getAllEntries() {
+        return FieldProgramDistanceKind.#values.entries();
+    }
+
+    #internalConstructor(value) {
+        if (arguments.length > 1 && arguments[0] === diplomatRuntime.internalConstructor) {
+            // We pass in two internalConstructor arguments to create *new*
+            // instances of this type, otherwise the enums are treated as singletons.
+            if (arguments[1] === diplomatRuntime.internalConstructor ) {
+                this.#value = arguments[2];
+                return this;
+            }
+            return FieldProgramDistanceKind.#objectValues[arguments[1]];
+        }
+
+        if (value instanceof FieldProgramDistanceKind) {
+            return value;
+        }
+
+        let intVal = FieldProgramDistanceKind.#values.get(value);
+
+        // Nullish check, checks for null or undefined
+        if (intVal != null) {
+            return FieldProgramDistanceKind.#objectValues[intVal];
+        }
+
+        throw TypeError(value + " is not a FieldProgramDistanceKind and does not correspond to any of its enumerator values.");
+    }
+
+    /** @internal */
+    static fromValue(value) {
+        return new FieldProgramDistanceKind(value);
+    }
+
+    get value(){
+        return [...FieldProgramDistanceKind.#values.keys()][this.#value];
+    }
+
+    /** @internal */
+    get ffiValue(){
+        return this.#value;
+    }
+    static #objectValues = [
+        new FieldProgramDistanceKind(diplomatRuntime.internalConstructor, diplomatRuntime.internalConstructor, 0),
+        new FieldProgramDistanceKind(diplomatRuntime.internalConstructor, diplomatRuntime.internalConstructor, 1),
+        new FieldProgramDistanceKind(diplomatRuntime.internalConstructor, diplomatRuntime.internalConstructor, 2),
+        new FieldProgramDistanceKind(diplomatRuntime.internalConstructor, diplomatRuntime.internalConstructor, 3),
+    ];
+
+    static Exact = FieldProgramDistanceKind.#objectValues[0];
+    static LowerBound = FieldProgramDistanceKind.#objectValues[1];
+    static Estimate = FieldProgramDistanceKind.#objectValues[2];
+    static Implicit = FieldProgramDistanceKind.#objectValues[3];
+
+
+    constructor(value) {
+        return this.#internalConstructor(...arguments)
+    }
+}

package/FieldProgramUnaryOp.d.mts

@@ -0,0 +1,34 @@
+// generated by diplomat-tool
+import type { pointer, codepoint } from "./diplomat-runtime.d.ts";
+
+
+
+/**
+ * Unary field-program operations (see `crate::sdf::UnaryOp`).
+ */
+export class FieldProgramUnaryOp {
+
+    /** @internal */
+    static fromValue(value: FieldProgramUnaryOp | string): FieldProgramUnaryOp;
+
+    get value(): string;
+
+    /** @internal */
+    get ffiValue(): number;
+
+    static Neg : FieldProgramUnaryOp;
+    static Abs : FieldProgramUnaryOp;
+    static Sqrt : FieldProgramUnaryOp;
+    static Log : FieldProgramUnaryOp;
+    static Sin : FieldProgramUnaryOp;
+    static Cos : FieldProgramUnaryOp;
+    static Acos : FieldProgramUnaryOp;
+    static VecX : FieldProgramUnaryOp;
+    static VecY : FieldProgramUnaryOp;
+    static VecZ : FieldProgramUnaryOp;
+    static Length : FieldProgramUnaryOp;
+    static Normalize : FieldProgramUnaryOp;
+
+
+    constructor(value: FieldProgramUnaryOp | string );
+}

package/FieldProgramUnaryOp.d.ts

@@ -0,0 +1,34 @@
+// generated by diplomat-tool
+import type { pointer, codepoint } from "./diplomat-runtime.d.ts";
+
+
+
+/**
+ * Unary field-program operations (see `crate::sdf::UnaryOp`).
+ */
+export class FieldProgramUnaryOp {
+
+    /** @internal */
+    static fromValue(value: FieldProgramUnaryOp | string): FieldProgramUnaryOp;
+
+    get value(): string;
+
+    /** @internal */
+    get ffiValue(): number;
+
+    static Neg : FieldProgramUnaryOp;
+    static Abs : FieldProgramUnaryOp;
+    static Sqrt : FieldProgramUnaryOp;
+    static Log : FieldProgramUnaryOp;
+    static Sin : FieldProgramUnaryOp;
+    static Cos : FieldProgramUnaryOp;
+    static Acos : FieldProgramUnaryOp;
+    static VecX : FieldProgramUnaryOp;
+    static VecY : FieldProgramUnaryOp;
+    static VecZ : FieldProgramUnaryOp;
+    static Length : FieldProgramUnaryOp;
+    static Normalize : FieldProgramUnaryOp;
+
+
+    constructor(value: FieldProgramUnaryOp | string );
+}

package/FieldProgramUnaryOp.mjs

@@ -0,0 +1,102 @@
+// generated by diplomat-tool
+import wasm from "./diplomat-wasm.mjs";
+import * as diplomatRuntime from "./diplomat-runtime.mjs";
+
+
+
+/**
+ * Unary field-program operations (see `crate::sdf::UnaryOp`).
+ */
+export class FieldProgramUnaryOp {
+    #value = undefined;
+
+    static #values = new Map([
+        ["Neg", 0],
+        ["Abs", 1],
+        ["Sqrt", 2],
+        ["Log", 3],
+        ["Sin", 4],
+        ["Cos", 5],
+        ["Acos", 6],
+        ["VecX", 7],
+        ["VecY", 8],
+        ["VecZ", 9],
+        ["Length", 10],
+        ["Normalize", 11]
+    ]);
+
+    static getAllEntries() {
+        return FieldProgramUnaryOp.#values.entries();
+    }
+
+    #internalConstructor(value) {
+        if (arguments.length > 1 && arguments[0] === diplomatRuntime.internalConstructor) {
+            // We pass in two internalConstructor arguments to create *new*
+            // instances of this type, otherwise the enums are treated as singletons.
+            if (arguments[1] === diplomatRuntime.internalConstructor ) {
+                this.#value = arguments[2];
+                return this;
+            }
+            return FieldProgramUnaryOp.#objectValues[arguments[1]];
+        }
+
+        if (value instanceof FieldProgramUnaryOp) {
+            return value;
+        }
+
+        let intVal = FieldProgramUnaryOp.#values.get(value);
+
+        // Nullish check, checks for null or undefined
+        if (intVal != null) {
+            return FieldProgramUnaryOp.#objectValues[intVal];
+        }
+
+        throw TypeError(value + " is not a FieldProgramUnaryOp and does not correspond to any of its enumerator values.");
+    }
+
+    /** @internal */
+    static fromValue(value) {
+        return new FieldProgramUnaryOp(value);
+    }
+
+    get value(){
+        return [...FieldProgramUnaryOp.#values.keys()][this.#value];
+    }
+
+    /** @internal */
+    get ffiValue(){
+        return this.#value;
+    }
+    static #objectValues = [
+        new FieldProgramUnaryOp(diplomatRuntime.internalConstructor, diplomatRuntime.internalConstructor, 0),
+        new FieldProgramUnaryOp(diplomatRuntime.internalConstructor, diplomatRuntime.internalConstructor, 1),
+        new FieldProgramUnaryOp(diplomatRuntime.internalConstructor, diplomatRuntime.internalConstructor, 2),
+        new FieldProgramUnaryOp(diplomatRuntime.internalConstructor, diplomatRuntime.internalConstructor, 3),
+        new FieldProgramUnaryOp(diplomatRuntime.internalConstructor, diplomatRuntime.internalConstructor, 4),
+        new FieldProgramUnaryOp(diplomatRuntime.internalConstructor, diplomatRuntime.internalConstructor, 5),
+        new FieldProgramUnaryOp(diplomatRuntime.internalConstructor, diplomatRuntime.internalConstructor, 6),
+        new FieldProgramUnaryOp(diplomatRuntime.internalConstructor, diplomatRuntime.internalConstructor, 7),
+        new FieldProgramUnaryOp(diplomatRuntime.internalConstructor, diplomatRuntime.internalConstructor, 8),
+        new FieldProgramUnaryOp(diplomatRuntime.internalConstructor, diplomatRuntime.internalConstructor, 9),
+        new FieldProgramUnaryOp(diplomatRuntime.internalConstructor, diplomatRuntime.internalConstructor, 10),
+        new FieldProgramUnaryOp(diplomatRuntime.internalConstructor, diplomatRuntime.internalConstructor, 11),
+    ];
+
+    static Neg = FieldProgramUnaryOp.#objectValues[0];
+    static Abs = FieldProgramUnaryOp.#objectValues[1];
+    static Sqrt = FieldProgramUnaryOp.#objectValues[2];
+    static Log = FieldProgramUnaryOp.#objectValues[3];
+    static Sin = FieldProgramUnaryOp.#objectValues[4];
+    static Cos = FieldProgramUnaryOp.#objectValues[5];
+    static Acos = FieldProgramUnaryOp.#objectValues[6];
+    static VecX = FieldProgramUnaryOp.#objectValues[7];
+    static VecY = FieldProgramUnaryOp.#objectValues[8];
+    static VecZ = FieldProgramUnaryOp.#objectValues[9];
+    static Length = FieldProgramUnaryOp.#objectValues[10];
+    static Normalize = FieldProgramUnaryOp.#objectValues[11];
+
+
+    constructor(value) {
+        return this.#internalConstructor(...arguments)
+    }
+}

package/FieldProgramValueType.d.mts

@@ -0,0 +1,25 @@
+// generated by diplomat-tool
+import type { pointer, codepoint } from "./diplomat-runtime.d.ts";
+
+
+
+/**
+ * The type of a value on a {@link FieldProgramBuilder}'s stack or in a slot.
+ */
+export class FieldProgramValueType {
+
+    /** @internal */
+    static fromValue(value: FieldProgramValueType | string): FieldProgramValueType;
+
+    get value(): string;
+
+    /** @internal */
+    get ffiValue(): number;
+
+    static Scalar : FieldProgramValueType;
+    static Vec3 : FieldProgramValueType;
+    static Bool : FieldProgramValueType;
+
+
+    constructor(value: FieldProgramValueType | string );
+}

package/FieldProgramValueType.d.ts

@@ -0,0 +1,25 @@
+// generated by diplomat-tool
+import type { pointer, codepoint } from "./diplomat-runtime.d.ts";
+
+
+
+/**
+ * The type of a value on a {@link FieldProgramBuilder}'s stack or in a slot.
+ */
+export class FieldProgramValueType {
+
+    /** @internal */
+    static fromValue(value: FieldProgramValueType | string): FieldProgramValueType;
+
+    get value(): string;
+
+    /** @internal */
+    get ffiValue(): number;
+
+    static Scalar : FieldProgramValueType;
+    static Vec3 : FieldProgramValueType;
+    static Bool : FieldProgramValueType;
+
+
+    constructor(value: FieldProgramValueType | string );
+}

package/FieldProgramValueType.mjs

@@ -0,0 +1,75 @@
+// generated by diplomat-tool
+import wasm from "./diplomat-wasm.mjs";
+import * as diplomatRuntime from "./diplomat-runtime.mjs";
+
+
+
+/**
+ * The type of a value on a {@link FieldProgramBuilder}'s stack or in a slot.
+ */
+export class FieldProgramValueType {
+    #value = undefined;
+
+    static #values = new Map([
+        ["Scalar", 0],
+        ["Vec3", 1],
+        ["Bool", 2]
+    ]);
+
+    static getAllEntries() {
+        return FieldProgramValueType.#values.entries();
+    }
+
+    #internalConstructor(value) {
+        if (arguments.length > 1 && arguments[0] === diplomatRuntime.internalConstructor) {
+            // We pass in two internalConstructor arguments to create *new*
+            // instances of this type, otherwise the enums are treated as singletons.
+            if (arguments[1] === diplomatRuntime.internalConstructor ) {
+                this.#value = arguments[2];
+                return this;
+            }
+            return FieldProgramValueType.#objectValues[arguments[1]];
+        }
+
+        if (value instanceof FieldProgramValueType) {
+            return value;
+        }
+
+        let intVal = FieldProgramValueType.#values.get(value);
+
+        // Nullish check, checks for null or undefined
+        if (intVal != null) {
+            return FieldProgramValueType.#objectValues[intVal];
+        }
+
+        throw TypeError(value + " is not a FieldProgramValueType and does not correspond to any of its enumerator values.");
+    }
+
+    /** @internal */
+    static fromValue(value) {
+        return new FieldProgramValueType(value);
+    }
+
+    get value(){
+        return [...FieldProgramValueType.#values.keys()][this.#value];
+    }
+
+    /** @internal */
+    get ffiValue(){
+        return this.#value;
+    }
+    static #objectValues = [
+        new FieldProgramValueType(diplomatRuntime.internalConstructor, diplomatRuntime.internalConstructor, 0),
+        new FieldProgramValueType(diplomatRuntime.internalConstructor, diplomatRuntime.internalConstructor, 1),
+        new FieldProgramValueType(diplomatRuntime.internalConstructor, diplomatRuntime.internalConstructor, 2),
+    ];
+
+    static Scalar = FieldProgramValueType.#objectValues[0];
+    static Vec3 = FieldProgramValueType.#objectValues[1];
+    static Bool = FieldProgramValueType.#objectValues[2];
+
+
+    constructor(value) {
+        return this.#internalConstructor(...arguments)
+    }
+}

package/FieldRange.d.mts

@@ -0,0 +1,15 @@
+// generated by diplomat-tool
+import type { pointer, codepoint } from "./diplomat-runtime.d.ts";
+
+
+
+/**
+ * The closed interval a field's values are analytically proven to lie in.
+ */
+export class FieldRange {
+    get min(): number;
+    get max(): number;
+    /** @internal */
+    constructor();
+
+}

package/FieldRange.d.ts

@@ -0,0 +1,15 @@
+// generated by diplomat-tool
+import type { pointer, codepoint } from "./diplomat-runtime.d.ts";
+
+
+
+/**
+ * The closed interval a field's values are analytically proven to lie in.
+ */
+export class FieldRange {
+    get min(): number;
+    get max(): number;
+    /** @internal */
+    constructor();
+
+}

package/FieldRange.mjs

@@ -0,0 +1,108 @@
+// generated by diplomat-tool
+import wasm from "./diplomat-wasm.mjs";
+import * as diplomatRuntime from "./diplomat-runtime.mjs";
+
+
+
+/**
+ * The closed interval a field's values are analytically proven to lie in.
+ */
+export class FieldRange {
+    #min;
+    get min() {
+        return this.#min;
+    }
+    #max;
+    get max() {
+        return this.#max;
+    }
+    #internalConstructor(structObj, internalConstructor) {
+        if (typeof structObj !== "object") {
+            throw new Error("FieldRange's constructor takes an object of FieldRange's fields.");
+        }
+
+        if (internalConstructor !== diplomatRuntime.internalConstructor) {
+            throw new Error("FieldRange is an out struct and can only be created internally.");
+        }
+        if ("min" in structObj) {
+            this.#min = structObj.min;
+        } else {
+            throw new Error("Missing required field min.");
+        }
+
+        if ("max" in structObj) {
+            this.#max = structObj.max;
+        } else {
+            throw new Error("Missing required field max.");
+        }
+
+        return this;
+    }
+
+    // Return this struct in FFI function friendly format.
+    // Returns an array that can be expanded with spread syntax (...)
+    _intoFFI(
+        dst,
+        functionCleanupArena,
+        appendArrayMap
+    ) {
+
+        this._writeToArrayBuffer(wasm.memory.buffer, dst, functionCleanupArena, appendArrayMap);
+
+        return dst;
+    }
+
+    static get _sizeBytes() {
+        return 8;
+    }
+
+    /// Currently unused, we may want to use later on though:
+    static get _sizeAlign() {
+        return 4;
+    }
+
+    static _fromSuppliedValue(internalConstructor, obj) {
+        if (internalConstructor !== diplomatRuntime.internalConstructor) {
+            throw new Error("_fromSuppliedValue cannot be called externally.");
+        }
+
+        if (obj instanceof FieldRange) {
+            return obj;
+        }
+
+        return FieldRange.fromFields(obj);
+    }
+
+    _writeToArrayBuffer(
+        arrayBuffer,
+        offset,
+        functionCleanupArena,
+        appendArrayMap
+    ) {
+        diplomatRuntime.writeToArrayBuffer(arrayBuffer, offset + 0, this.#min, Float32Array);
+        diplomatRuntime.writeToArrayBuffer(arrayBuffer, offset + 4, this.#max, Float32Array);
+    }
+
+    // This struct contains borrowed fields, so this takes in a list of
+    // "edges" corresponding to where each lifetime's data may have been borrowed from
+    // and passes it down to individual fields containing the borrow.
+    // This method does not attempt to handle any dependencies between lifetimes, the caller
+    // should handle this when constructing edge arrays.
+    static _fromFFI(internalConstructor, ptr) {
+        if (internalConstructor !== diplomatRuntime.internalConstructor) {
+            throw new Error("FieldRange._fromFFI is not meant to be called externally. Please use the default constructor.");
+        }
+        let structObj = {};
+        const minDeref = (new Float32Array(wasm.memory.buffer, ptr, 1))[0];
+        structObj.min = minDeref;
+        const maxDeref = (new Float32Array(wasm.memory.buffer, ptr + 4, 1))[0];
+        structObj.max = maxDeref;
+
+        return new FieldRange(structObj, internalConstructor);
+    }
+
+
+    constructor(structObj, internalConstructor) {
+        return this.#internalConstructor(...arguments)
+    }
+}

package/Fingerprint.d.mts

@@ -0,0 +1,44 @@
+// 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 fingerprint free functions (PORTING rule 12).
+ */
+export class Fingerprint {
+    /** @internal */
+    get ffiValue(): pointer;
+    /** @internal */
+    constructor();
+
+
+    /**
+     * The fingerprint of a schematic for the given preset, as a hex string.
+     * Errors with `InvalidArgument` on an unknown preset.
+     */
+    static compute(schematic: Schematic, preset: string): string;
+
+    /**
+     * The structural signature (JSON) of a schematic for the given preset.
+     */
+    static signatureJson(schematic: Schematic, preset: string): string;
+
+    /**
+     * Translation-invariant fuzzy distance between two builds' footprints.
+     */
+    static footprintDistance(a: Schematic, b: Schematic, preset: string): number;
+
+    /**
+     * The schematic's translation/scale-invariant FFT shape footprint as a
+     * JSON array of floats.
+     */
+    static footprintJson(schematic: Schematic, preset: string): string;
+
+    /**
+     * Whether two schematics share the same fingerprint for the given preset.
+     */
+    static isDuplicate(a: Schematic, b: Schematic, preset: string): boolean;
+}

package/Fingerprint.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/GeneratedChunk.d.mts

@@ -0,0 +1,35 @@
+// generated by diplomat-tool
+import type { GeneratedChunkCoverage } from "./GeneratedChunkCoverage.mjs"
+import type { NucleationError } from "./NucleationError.mjs"
+import type { WorldChunkView } from "./WorldChunkView.mjs"
+import type { pointer, codepoint } from "./diplomat-runtime.d.ts";
+
+
+
+/**
+ * One generated chunk plus coverage and source-version metadata.
+ * Call `take_view` once to move its chunk into the existing world-stream API.
+ */
+export class GeneratedChunk {
+    /** @internal */
+    get ffiValue(): pointer;
+    /** @internal */
+    constructor();
+
+
+    cx(): number;
+
+    cz(): number;
+
+    coverage(): GeneratedChunkCoverage;
+
+    sourceId(): string;
+
+    version(): string;
+
+    /**
+     * Consume the generated chunk payload. Metadata access and a second call
+     * return `AlreadyConsumed` afterwards.
+     */
+    takeView(): WorldChunkView;
+}