nucleation 0.10.21 → 0.10.23

package/renderer/Diff.d.mts

@@ -0,0 +1,88 @@
+// 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";
+
+
+
+/**
+ * A computed diff between two schematics.
+ */
+export class Diff {
+    /** @internal */
+    get ffiValue(): pointer;
+    /** @internal */
+    constructor();
+
+
+    /**
+     * Diff two schematics with the given preset (default cost model).
+     * Errors with `InvalidArgument` on an unknown preset.
+     */
+    static compute(a: Schematic, b: Schematic, preset: string): Diff;
+
+    /**
+     * Diff two schematics with optional cost/symmetry overrides. Negative
+     * cost ints mean "unset" (use the preset default); an empty `symmetry`
+     * string means "unset". Errors with `InvalidArgument` on an unknown
+     * preset or symmetry name.
+     */
+    static computeWithOpts(a: Schematic, b: Schematic, preset: string, costAdd: number, costDelete: number, costChange: number, costSwap: number, symmetry: string): Diff;
+
+    /**
+     * Reconstruct a diff from its JSON representation.
+     */
+    static fromJson(json: string): Diff;
+
+    /**
+     * The edit distance of the diff.
+     */
+    distance(): bigint;
+
+    /**
+     * The support (alignment confidence) of the diff.
+     */
+    support(): number;
+
+    /**
+     * Serialize the diff to its full JSON representation.
+     */
+    toJson(): string;
+
+    /**
+     * Serialize the diff to its compact summary JSON.
+     */
+    summaryJson(): string;
+
+    /**
+     * A new schematic containing only the blocks added in this diff.
+     */
+    added(): Schematic;
+
+    /**
+     * A new schematic containing only the blocks removed in this diff.
+     */
+    removed(): Schematic;
+
+    /**
+     * A new schematic containing only the blocks changed in this diff.
+     */
+    changed(): Schematic;
+
+    /**
+     * A new schematic containing only the blocks swapped in this diff.
+     */
+    swapped(): Schematic;
+
+    /**
+     * A new schematic with marker blocks summarizing this diff.
+     */
+    markers(): Schematic;
+
+    /**
+     * Render a diff overlay on top of an "after" GLB buffer, returning the
+     * new GLB as base64 (PORTING rule 6). Requires the `meshing` feature;
+     * errors with `Mesh` when compiled without it.
+     */
+    toOverlayGlbB64(afterGlb: Array<number>): string;
+}

package/renderer/Diff.d.ts

@@ -0,0 +1,88 @@
+// 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";
+
+
+
+/**
+ * A computed diff between two schematics.
+ */
+export class Diff {
+    /** @internal */
+    get ffiValue(): pointer;
+    /** @internal */
+    constructor();
+
+
+    /**
+     * Diff two schematics with the given preset (default cost model).
+     * Errors with `InvalidArgument` on an unknown preset.
+     */
+    static compute(a: Schematic, b: Schematic, preset: string): Diff;
+
+    /**
+     * Diff two schematics with optional cost/symmetry overrides. Negative
+     * cost ints mean "unset" (use the preset default); an empty `symmetry`
+     * string means "unset". Errors with `InvalidArgument` on an unknown
+     * preset or symmetry name.
+     */
+    static computeWithOpts(a: Schematic, b: Schematic, preset: string, costAdd: number, costDelete: number, costChange: number, costSwap: number, symmetry: string): Diff;
+
+    /**
+     * Reconstruct a diff from its JSON representation.
+     */
+    static fromJson(json: string): Diff;
+
+    /**
+     * The edit distance of the diff.
+     */
+    distance(): bigint;
+
+    /**
+     * The support (alignment confidence) of the diff.
+     */
+    support(): number;
+
+    /**
+     * Serialize the diff to its full JSON representation.
+     */
+    toJson(): string;
+
+    /**
+     * Serialize the diff to its compact summary JSON.
+     */
+    summaryJson(): string;
+
+    /**
+     * A new schematic containing only the blocks added in this diff.
+     */
+    added(): Schematic;
+
+    /**
+     * A new schematic containing only the blocks removed in this diff.
+     */
+    removed(): Schematic;
+
+    /**
+     * A new schematic containing only the blocks changed in this diff.
+     */
+    changed(): Schematic;
+
+    /**
+     * A new schematic containing only the blocks swapped in this diff.
+     */
+    swapped(): Schematic;
+
+    /**
+     * A new schematic with marker blocks summarizing this diff.
+     */
+    markers(): Schematic;
+
+    /**
+     * Render a diff overlay on top of an "after" GLB buffer, returning the
+     * new GLB as base64 (PORTING rule 6). Requires the `meshing` feature;
+     * errors with `Mesh` when compiled without it.
+     */
+    toOverlayGlbB64(afterGlb: Array<number>): string;
+}

package/renderer/Diff.mjs

@@ -0,0 +1,316 @@
+// 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 Diff_box_destroy_registry = new FinalizationRegistry((ptr) => {
+    wasm.Diff_destroy(ptr);
+});
+
+/**
+ * A computed diff between two schematics.
+ */
+export class Diff {
+    // 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("Diff 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) {
+            Diff_box_destroy_registry.register(this, this.#ptr);
+        }
+
+        return this;
+    }
+    /** @internal */
+    get ffiValue() {
+        return this.#ptr;
+    }
+
+
+    /**
+     * Diff two schematics with the given preset (default cost model).
+     * Errors with `InvalidArgument` on an unknown preset.
+     */
+    static compute(a, b, preset) {
+        let functionCleanupArena = new diplomatRuntime.CleanupArena();
+
+        const presetSlice = functionCleanupArena.alloc(diplomatRuntime.DiplomatBuf.sliceWrapper(wasm, diplomatRuntime.DiplomatBuf.str8(wasm, preset)));
+        const diplomatReceive = new diplomatRuntime.DiplomatReceiveBuf(wasm, 5, 4, true);
+
+
+        const result = wasm.Diff_compute(diplomatReceive.buffer, a.ffiValue, b.ffiValue, presetSlice.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 Diff(diplomatRuntime.internalConstructor, diplomatRuntime.ptrRead(wasm, diplomatReceive.buffer), []);
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+            functionCleanupArena.free();
+
+            diplomatReceive.free();
+        }
+    }
+
+    /**
+     * Diff two schematics with optional cost/symmetry overrides. Negative
+     * cost ints mean "unset" (use the preset default); an empty `symmetry`
+     * string means "unset". Errors with `InvalidArgument` on an unknown
+     * preset or symmetry name.
+     */
+    static computeWithOpts(a, b, preset, costAdd, costDelete, costChange, costSwap, symmetry) {
+        let functionCleanupArena = new diplomatRuntime.CleanupArena();
+
+        const presetSlice = functionCleanupArena.alloc(diplomatRuntime.DiplomatBuf.sliceWrapper(wasm, diplomatRuntime.DiplomatBuf.str8(wasm, preset)));
+        const symmetrySlice = functionCleanupArena.alloc(diplomatRuntime.DiplomatBuf.sliceWrapper(wasm, diplomatRuntime.DiplomatBuf.str8(wasm, symmetry)));
+        const diplomatReceive = new diplomatRuntime.DiplomatReceiveBuf(wasm, 5, 4, true);
+
+
+        const result = wasm.Diff_compute_with_opts(diplomatReceive.buffer, a.ffiValue, b.ffiValue, presetSlice.ptr, costAdd, costDelete, costChange, costSwap, symmetrySlice.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 Diff(diplomatRuntime.internalConstructor, diplomatRuntime.ptrRead(wasm, diplomatReceive.buffer), []);
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+            functionCleanupArena.free();
+
+            diplomatReceive.free();
+        }
+    }
+
+    /**
+     * Reconstruct a diff from its JSON representation.
+     */
+    static fromJson(json) {
+        let functionCleanupArena = new diplomatRuntime.CleanupArena();
+
+        const jsonSlice = functionCleanupArena.alloc(diplomatRuntime.DiplomatBuf.sliceWrapper(wasm, diplomatRuntime.DiplomatBuf.str8(wasm, json)));
+        const diplomatReceive = new diplomatRuntime.DiplomatReceiveBuf(wasm, 5, 4, true);
+
+
+        const result = wasm.Diff_from_json(diplomatReceive.buffer, jsonSlice.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 Diff(diplomatRuntime.internalConstructor, diplomatRuntime.ptrRead(wasm, diplomatReceive.buffer), []);
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+            functionCleanupArena.free();
+
+            diplomatReceive.free();
+        }
+    }
+
+    /**
+     * The edit distance of the diff.
+     */
+    distance() {
+
+        const result = wasm.Diff_distance(this.ffiValue);
+
+        try {
+            return result;
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+        }
+    }
+
+    /**
+     * The support (alignment confidence) of the diff.
+     */
+    support() {
+
+        const result = wasm.Diff_support(this.ffiValue);
+
+        try {
+            return result;
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+        }
+    }
+
+    /**
+     * Serialize the diff to its full JSON representation.
+     */
+    toJson() {
+        const write = new diplomatRuntime.DiplomatWriteBuf(wasm);
+
+    wasm.Diff_to_json(this.ffiValue, write.buffer);
+
+        try {
+            return write.readString8();
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+            write.free();
+        }
+    }
+
+    /**
+     * Serialize the diff to its compact summary JSON.
+     */
+    summaryJson() {
+        const write = new diplomatRuntime.DiplomatWriteBuf(wasm);
+
+    wasm.Diff_summary_json(this.ffiValue, write.buffer);
+
+        try {
+            return write.readString8();
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+            write.free();
+        }
+    }
+
+    /**
+     * A new schematic containing only the blocks added in this diff.
+     */
+    added() {
+
+        const result = wasm.Diff_added(this.ffiValue);
+
+        try {
+            return new Schematic(diplomatRuntime.internalConstructor, result, []);
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+        }
+    }
+
+    /**
+     * A new schematic containing only the blocks removed in this diff.
+     */
+    removed() {
+
+        const result = wasm.Diff_removed(this.ffiValue);
+
+        try {
+            return new Schematic(diplomatRuntime.internalConstructor, result, []);
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+        }
+    }
+
+    /**
+     * A new schematic containing only the blocks changed in this diff.
+     */
+    changed() {
+
+        const result = wasm.Diff_changed(this.ffiValue);
+
+        try {
+            return new Schematic(diplomatRuntime.internalConstructor, result, []);
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+        }
+    }
+
+    /**
+     * A new schematic containing only the blocks swapped in this diff.
+     */
+    swapped() {
+
+        const result = wasm.Diff_swapped(this.ffiValue);
+
+        try {
+            return new Schematic(diplomatRuntime.internalConstructor, result, []);
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+        }
+    }
+
+    /**
+     * A new schematic with marker blocks summarizing this diff.
+     */
+    markers() {
+
+        const result = wasm.Diff_markers(this.ffiValue);
+
+        try {
+            return new Schematic(diplomatRuntime.internalConstructor, result, []);
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+        }
+    }
+
+    /**
+     * Render a diff overlay on top of an "after" GLB buffer, returning the
+     * new GLB as base64 (PORTING rule 6). Requires the `meshing` feature;
+     * errors with `Mesh` when compiled without it.
+     */
+    toOverlayGlbB64(afterGlb) {
+        let functionCleanupArena = new diplomatRuntime.CleanupArena();
+
+        const afterGlbSlice = functionCleanupArena.alloc(diplomatRuntime.DiplomatBuf.sliceWrapper(wasm, diplomatRuntime.DiplomatBuf.slice(wasm, afterGlb, "u8")));
+        const diplomatReceive = new diplomatRuntime.DiplomatReceiveBuf(wasm, 5, 4, true);
+
+        const write = new diplomatRuntime.DiplomatWriteBuf(wasm);
+
+
+        const result = wasm.Diff_to_overlay_glb_b64(diplomatReceive.buffer, this.ffiValue, afterGlbSlice.ptr, 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();
+            functionCleanupArena.free();
+
+            diplomatReceive.free();
+            write.free();
+        }
+    }
+
+    constructor(symbol, ptr, selfEdge) {
+        return this.#internalConstructor(...arguments)
+    }
+}

package/renderer/Dimensions.d.mts

@@ -0,0 +1,28 @@
+// generated by diplomat-tool
+import type { pointer, codepoint } from "./diplomat-runtime.d.ts";
+
+export type Dimensions_obj = {
+    x: number;
+    y: number;
+    z: number;
+};
+
+
+
+export class Dimensions {
+    get x(): number;
+    set x(value: number);
+    get y(): number;
+    set y(value: number);
+    get z(): number;
+    set z(value: number);
+    /** @internal */
+    static fromFields(structObj : Dimensions_obj) : Dimensions;
+
+    /**
+    * Create `Dimensions` from an object that contains all of `Dimensions`s fields.
+    * Optional fields do not need to be included in the provided object.
+    */
+    constructor(structObj: Dimensions_obj);
+
+}

package/renderer/Dimensions.d.ts

@@ -0,0 +1,28 @@
+// generated by diplomat-tool
+import type { pointer, codepoint } from "./diplomat-runtime.d.ts";
+
+export type Dimensions_obj = {
+    x: number;
+    y: number;
+    z: number;
+};
+
+
+
+export class Dimensions {
+    get x(): number;
+    set x(value: number);
+    get y(): number;
+    set y(value: number);
+    get z(): number;
+    set z(value: number);
+    /** @internal */
+    static fromFields(structObj : Dimensions_obj) : Dimensions;
+
+    /**
+    * Create `Dimensions` from an object that contains all of `Dimensions`s fields.
+    * Optional fields do not need to be included in the provided object.
+    */
+    constructor(structObj: Dimensions_obj);
+
+}

package/renderer/Dimensions.mjs

@@ -0,0 +1,130 @@
+// generated by diplomat-tool
+import wasm from "./diplomat-wasm.mjs";
+import * as diplomatRuntime from "./diplomat-runtime.mjs";
+
+
+
+export class Dimensions {
+    #x;
+    get x() {
+        return this.#x;
+    }
+    set x(value){
+        this.#x = value;
+    }
+    #y;
+    get y() {
+        return this.#y;
+    }
+    set y(value){
+        this.#y = value;
+    }
+    #z;
+    get z() {
+        return this.#z;
+    }
+    set z(value){
+        this.#z = value;
+    }
+    /** @internal */
+    static fromFields(structObj) {
+        return new Dimensions(structObj);
+    }
+
+    #internalConstructor(structObj) {
+        if (typeof structObj !== "object") {
+            throw new Error("Dimensions's constructor takes an object of Dimensions's fields.");
+        }
+
+        if ("x" in structObj) {
+            this.#x = structObj.x;
+        } else {
+            throw new Error("Missing required field x.");
+        }
+
+        if ("y" in structObj) {
+            this.#y = structObj.y;
+        } else {
+            throw new Error("Missing required field y.");
+        }
+
+        if ("z" in structObj) {
+            this.#z = structObj.z;
+        } else {
+            throw new Error("Missing required field z.");
+        }
+
+        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 12;
+    }
+
+    /// 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 Dimensions) {
+            return obj;
+        }
+
+        return Dimensions.fromFields(obj);
+    }
+
+    _writeToArrayBuffer(
+        arrayBuffer,
+        offset,
+        functionCleanupArena,
+        appendArrayMap
+    ) {
+        diplomatRuntime.writeToArrayBuffer(arrayBuffer, offset + 0, this.#x, Int32Array);
+        diplomatRuntime.writeToArrayBuffer(arrayBuffer, offset + 4, this.#y, Int32Array);
+        diplomatRuntime.writeToArrayBuffer(arrayBuffer, offset + 8, this.#z, Int32Array);
+    }
+
+    // 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) {
+        ptr >>>= 0; // unsigned wasm32 address; field values retain their signedness.
+        if (internalConstructor !== diplomatRuntime.internalConstructor) {
+            throw new Error("Dimensions._fromFFI is not meant to be called externally. Please use the default constructor.");
+        }
+        let structObj = {};
+        const xDeref = (new Int32Array(wasm.memory.buffer, ptr, 1))[0];
+        structObj.x = xDeref;
+        const yDeref = (new Int32Array(wasm.memory.buffer, ptr + 4, 1))[0];
+        structObj.y = yDeref;
+        const zDeref = (new Int32Array(wasm.memory.buffer, ptr + 8, 1))[0];
+        structObj.z = zDeref;
+
+        return new Dimensions(structObj);
+    }
+
+
+    constructor(structObj) {
+        return this.#internalConstructor(...arguments)
+    }
+}