nucleation 0.2.17 → 0.3.0

package/StoreIo.mjs

@@ -0,0 +1,292 @@
+// 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 StoreIo_box_destroy_registry = new FinalizationRegistry((ptr) => {
+    wasm.StoreIo_destroy(ptr);
+});
+
+/**
+ * Namespace type for the URI-based transparent I/O and format-manager
+ * queries (PORTING rule 12).
+ */
+export class StoreIo {
+    // 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("StoreIo 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) {
+            StoreIo_box_destroy_registry.register(this, this.#ptr);
+        }
+
+        return this;
+    }
+    /** @internal */
+    get ffiValue() {
+        return this.#ptr;
+    }
+
+
+    /**
+     * Open a schematic from a URI: a local path, `file://...`, or
+     * `s3://bucket/key.schem`. The format is auto-detected from the URI's
+     * extension. Single-string URIs for `redis://`, `postgres://`, and
+     * `mem://` are rejected by the core resolver; use `Store::open_schematic`
+     * with an explicit store for those backends.
+     */
+    static open(uri) {
+        let functionCleanupArena = new diplomatRuntime.CleanupArena();
+
+        const uriSlice = functionCleanupArena.alloc(diplomatRuntime.DiplomatBuf.sliceWrapper(wasm, diplomatRuntime.DiplomatBuf.str8(wasm, uri)));
+        const diplomatReceive = new diplomatRuntime.DiplomatReceiveBuf(wasm, 5, 4, true);
+
+
+        const result = wasm.StoreIo_open(diplomatReceive.buffer, uriSlice.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 Schematic(diplomatRuntime.internalConstructor, diplomatRuntime.ptrRead(wasm, diplomatReceive.buffer), []);
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+            functionCleanupArena.free();
+
+            diplomatReceive.free();
+        }
+    }
+
+    /**
+     * Save a schematic to a URI: a local path, `file://...`, or
+     * `s3://bucket/key.schem`. The format is auto-detected from the URI's
+     * extension; `version` selects the format version (empty string =
+     * format default). Single-string URIs for `redis://`, `postgres://`, and
+     * `mem://` are rejected by the core resolver; use `Store::save_schematic`
+     * with an explicit store for those backends.
+     */
+    static save(schematic, uri, version) {
+        let functionCleanupArena = new diplomatRuntime.CleanupArena();
+
+        const uriSlice = functionCleanupArena.alloc(diplomatRuntime.DiplomatBuf.sliceWrapper(wasm, diplomatRuntime.DiplomatBuf.str8(wasm, uri)));
+        const versionSlice = functionCleanupArena.alloc(diplomatRuntime.DiplomatBuf.sliceWrapper(wasm, diplomatRuntime.DiplomatBuf.str8(wasm, version)));
+        const diplomatReceive = new diplomatRuntime.DiplomatReceiveBuf(wasm, 5, 4, true);
+
+
+        const result = wasm.StoreIo_save(diplomatReceive.buffer, schematic.ffiValue, uriSlice.ptr, versionSlice.ptr);
+
+        try {
+            if (!diplomatReceive.resultFlag) {
+                const cause = new NucleationError(diplomatRuntime.internalConstructor, diplomatRuntime.enumDiscriminant(wasm, diplomatReceive.buffer));
+                throw new globalThis.Error('NucleationError.' + cause.value, { cause });
+            }
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+            functionCleanupArena.free();
+
+            diplomatReceive.free();
+        }
+    }
+
+    /**
+     * The JSON schema describing the export settings of `format`. Errors
+     * with `NotFound` for an unknown format.
+     */
+    static exportSettingsSchema(format) {
+        let functionCleanupArena = new diplomatRuntime.CleanupArena();
+
+        const formatSlice = functionCleanupArena.alloc(diplomatRuntime.DiplomatBuf.sliceWrapper(wasm, diplomatRuntime.DiplomatBuf.str8(wasm, format)));
+        const diplomatReceive = new diplomatRuntime.DiplomatReceiveBuf(wasm, 5, 4, true);
+
+        const write = new diplomatRuntime.DiplomatWriteBuf(wasm);
+
+
+        const result = wasm.StoreIo_export_settings_schema(diplomatReceive.buffer, formatSlice.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();
+        }
+    }
+
+    /**
+     * The JSON schema describing the import settings of `format`. Errors
+     * with `NotFound` for an unknown format.
+     */
+    static importSettingsSchema(format) {
+        let functionCleanupArena = new diplomatRuntime.CleanupArena();
+
+        const formatSlice = functionCleanupArena.alloc(diplomatRuntime.DiplomatBuf.sliceWrapper(wasm, diplomatRuntime.DiplomatBuf.str8(wasm, format)));
+        const diplomatReceive = new diplomatRuntime.DiplomatReceiveBuf(wasm, 5, 4, true);
+
+        const write = new diplomatRuntime.DiplomatWriteBuf(wasm);
+
+
+        const result = wasm.StoreIo_import_settings_schema(diplomatReceive.buffer, formatSlice.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();
+        }
+    }
+
+    /**
+     * The supported import formats, written as a JSON array string.
+     */
+    static supportedImportFormats() {
+        const diplomatReceive = new diplomatRuntime.DiplomatReceiveBuf(wasm, 5, 4, true);
+
+        const write = new diplomatRuntime.DiplomatWriteBuf(wasm);
+
+
+        const result = wasm.StoreIo_supported_import_formats(diplomatReceive.buffer, 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 supported export formats, written as a JSON array string.
+     */
+    static supportedExportFormats() {
+        const diplomatReceive = new diplomatRuntime.DiplomatReceiveBuf(wasm, 5, 4, true);
+
+        const write = new diplomatRuntime.DiplomatWriteBuf(wasm);
+
+
+        const result = wasm.StoreIo_supported_export_formats(diplomatReceive.buffer, 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 known versions of an export format, written as a JSON array string
+     * (empty array for an unknown format, matching the old ABI).
+     */
+    static formatVersions(format) {
+        let functionCleanupArena = new diplomatRuntime.CleanupArena();
+
+        const formatSlice = functionCleanupArena.alloc(diplomatRuntime.DiplomatBuf.sliceWrapper(wasm, diplomatRuntime.DiplomatBuf.str8(wasm, format)));
+        const diplomatReceive = new diplomatRuntime.DiplomatReceiveBuf(wasm, 5, 4, true);
+
+        const write = new diplomatRuntime.DiplomatWriteBuf(wasm);
+
+
+        const result = wasm.StoreIo_format_versions(diplomatReceive.buffer, formatSlice.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();
+        }
+    }
+
+    /**
+     * The default version of an export format. Errors with `NotFound` for an
+     * unknown format.
+     */
+    static defaultFormatVersion(format) {
+        let functionCleanupArena = new diplomatRuntime.CleanupArena();
+
+        const formatSlice = functionCleanupArena.alloc(diplomatRuntime.DiplomatBuf.sliceWrapper(wasm, diplomatRuntime.DiplomatBuf.str8(wasm, format)));
+        const diplomatReceive = new diplomatRuntime.DiplomatReceiveBuf(wasm, 5, 4, true);
+
+        const write = new diplomatRuntime.DiplomatWriteBuf(wasm);
+
+
+        const result = wasm.StoreIo_default_format_version(diplomatReceive.buffer, formatSlice.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/TextureAtlas.d.ts

@@ -0,0 +1,40 @@
+// generated by diplomat-tool
+import type { MeshConfig } from "./MeshConfig"
+import type { NucleationError } from "./NucleationError"
+import type { ResourcePack } from "./ResourcePack"
+import type { Schematic } from "./Schematic"
+import type { pointer, codepoint } from "./diplomat-runtime.d.ts";
+
+
+
+/**
+ * A packed texture atlas. Wraps {@link schematic_mesher::TextureAtlas}.
+ */
+export class TextureAtlas {
+    /** @internal */
+    get ffiValue(): pointer;
+    /** @internal */
+    constructor();
+
+
+    /**
+     * Build a single shared atlas from every unique block state in the
+     * schematic (old ABI: `schematic_build_global_atlas`).
+     */
+    static buildGlobal(schematic: Schematic, pack: ResourcePack, config: MeshConfig): TextureAtlas;
+
+    /**
+     * Atlas width in pixels.
+     */
+    width(): number;
+
+    /**
+     * Atlas height in pixels.
+     */
+    height(): number;
+
+    /**
+     * Raw RGBA atlas pixels, base64-encoded.
+     */
+    rgbaDataB64(): string;
+}

package/TextureAtlas.mjs

@@ -0,0 +1,122 @@
+// generated by diplomat-tool
+import { MeshConfig } from "./MeshConfig.mjs"
+import { NucleationError } from "./NucleationError.mjs"
+import { ResourcePack } from "./ResourcePack.mjs"
+import { Schematic } from "./Schematic.mjs"
+import wasm from "./diplomat-wasm.mjs";
+import * as diplomatRuntime from "./diplomat-runtime.mjs";
+
+const TextureAtlas_box_destroy_registry = new FinalizationRegistry((ptr) => {
+    wasm.TextureAtlas_destroy(ptr);
+});
+
+/**
+ * A packed texture atlas. Wraps {@link schematic_mesher::TextureAtlas}.
+ */
+export class TextureAtlas {
+    // 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("TextureAtlas 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) {
+            TextureAtlas_box_destroy_registry.register(this, this.#ptr);
+        }
+
+        return this;
+    }
+    /** @internal */
+    get ffiValue() {
+        return this.#ptr;
+    }
+
+
+    /**
+     * Build a single shared atlas from every unique block state in the
+     * schematic (old ABI: `schematic_build_global_atlas`).
+     */
+    static buildGlobal(schematic, pack, config) {
+        const diplomatReceive = new diplomatRuntime.DiplomatReceiveBuf(wasm, 5, 4, true);
+
+
+        const result = wasm.TextureAtlas_build_global(diplomatReceive.buffer, schematic.ffiValue, pack.ffiValue, config.ffiValue);
+
+        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 TextureAtlas(diplomatRuntime.internalConstructor, diplomatRuntime.ptrRead(wasm, diplomatReceive.buffer), []);
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+            diplomatReceive.free();
+        }
+    }
+
+    /**
+     * Atlas width in pixels.
+     */
+    width() {
+
+        const result = wasm.TextureAtlas_width(this.ffiValue);
+
+        try {
+            return result;
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+        }
+    }
+
+    /**
+     * Atlas height in pixels.
+     */
+    height() {
+
+        const result = wasm.TextureAtlas_height(this.ffiValue);
+
+        try {
+            return result;
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+        }
+    }
+
+    /**
+     * Raw RGBA atlas pixels, base64-encoded.
+     */
+    rgbaDataB64() {
+        const write = new diplomatRuntime.DiplomatWriteBuf(wasm);
+
+    wasm.TextureAtlas_rgba_data_b64(this.ffiValue, write.buffer);
+
+        try {
+            return write.readString8();
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+            write.free();
+        }
+    }
+
+    constructor(symbol, ptr, selfEdge) {
+        return this.#internalConstructor(...arguments)
+    }
+}

package/TextureInfo.d.ts

@@ -0,0 +1,34 @@
+// generated by diplomat-tool
+import type { pointer, codepoint } from "./diplomat-runtime.d.ts";
+
+export type TextureInfo_obj = {
+    width: number;
+    height: number;
+    animated: boolean;
+    frameCount: number;
+};
+
+
+
+/**
+ * Texture size/animation metadata for one texture in a resource pack.
+ */
+export class TextureInfo {
+    get width(): number;
+    set width(value: number);
+    get height(): number;
+    set height(value: number);
+    get animated(): boolean;
+    set animated(value: boolean);
+    get frameCount(): number;
+    set frameCount(value: number);
+    /** @internal */
+    static fromFields(structObj : TextureInfo_obj) : TextureInfo;
+
+    /**
+    * Create `TextureInfo` from an object that contains all of `TextureInfo`s fields.
+    * Optional fields do not need to be included in the provided object.
+    */
+    constructor(structObj: TextureInfo_obj);
+
+}

package/TextureInfo.mjs

@@ -0,0 +1,148 @@
+// generated by diplomat-tool
+import wasm from "./diplomat-wasm.mjs";
+import * as diplomatRuntime from "./diplomat-runtime.mjs";
+
+
+
+/**
+ * Texture size/animation metadata for one texture in a resource pack.
+ */
+export class TextureInfo {
+    #width;
+    get width() {
+        return this.#width;
+    }
+    set width(value){
+        this.#width = value;
+    }
+    #height;
+    get height() {
+        return this.#height;
+    }
+    set height(value){
+        this.#height = value;
+    }
+    #animated;
+    get animated() {
+        return this.#animated;
+    }
+    set animated(value){
+        this.#animated = value;
+    }
+    #frameCount;
+    get frameCount() {
+        return this.#frameCount;
+    }
+    set frameCount(value){
+        this.#frameCount = value;
+    }
+    /** @internal */
+    static fromFields(structObj) {
+        return new TextureInfo(structObj);
+    }
+
+    #internalConstructor(structObj) {
+        if (typeof structObj !== "object") {
+            throw new Error("TextureInfo's constructor takes an object of TextureInfo's fields.");
+        }
+
+        if ("width" in structObj) {
+            this.#width = structObj.width;
+        } else {
+            throw new Error("Missing required field width.");
+        }
+
+        if ("height" in structObj) {
+            this.#height = structObj.height;
+        } else {
+            throw new Error("Missing required field height.");
+        }
+
+        if ("animated" in structObj) {
+            this.#animated = structObj.animated;
+        } else {
+            throw new Error("Missing required field animated.");
+        }
+
+        if ("frameCount" in structObj) {
+            this.#frameCount = structObj.frameCount;
+        } else {
+            throw new Error("Missing required field frameCount.");
+        }
+
+        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 16;
+    }
+
+    /// 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 TextureInfo) {
+            return obj;
+        }
+
+        return TextureInfo.fromFields(obj);
+    }
+
+    _writeToArrayBuffer(
+        arrayBuffer,
+        offset,
+        functionCleanupArena,
+        appendArrayMap
+    ) {
+        diplomatRuntime.writeToArrayBuffer(arrayBuffer, offset + 0, this.#width, Uint32Array);
+        diplomatRuntime.writeToArrayBuffer(arrayBuffer, offset + 4, this.#height, Uint32Array);
+        diplomatRuntime.writeToArrayBuffer(arrayBuffer, offset + 8, this.#animated, Uint8Array);
+        diplomatRuntime.writeToArrayBuffer(arrayBuffer, offset + 12, this.#frameCount, Uint32Array);
+    }
+
+    // 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("TextureInfo._fromFFI is not meant to be called externally. Please use the default constructor.");
+        }
+        let structObj = {};
+        const widthDeref = (new Uint32Array(wasm.memory.buffer, ptr, 1))[0];
+        structObj.width = widthDeref;
+        const heightDeref = (new Uint32Array(wasm.memory.buffer, ptr + 4, 1))[0];
+        structObj.height = heightDeref;
+        const animatedDeref = (new Uint8Array(wasm.memory.buffer, ptr + 8, 1))[0] === 1;
+        structObj.animated = animatedDeref;
+        const frameCountDeref = (new Uint32Array(wasm.memory.buffer, ptr + 12, 1))[0];
+        structObj.frameCount = frameCountDeref;
+
+        return new TextureInfo(structObj);
+    }
+
+
+    constructor(structObj) {
+        return this.#internalConstructor(...arguments)
+    }
+}