nucleation 0.10.21 → 0.10.23

package/renderer/SchematicBuilder.d.mts

@@ -0,0 +1,103 @@
+// 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";
+
+
+
+/**
+ * Fluent builder for schematics from character-mapped text layers.
+ *
+ * `build` is consuming (PORTING rule 11): the inner builder is held in an
+ * `Option` and taken on `build`; every method afterwards returns
+ * `AlreadyConsumed`.
+ */
+export class SchematicBuilder {
+    /** @internal */
+    get ffiValue(): pointer;
+    /** @internal */
+    constructor();
+
+
+    /**
+     * Create a new builder, pre-loaded with the standard Unicode palette
+     * (override any character via `map` or `palette`).
+     */
+    static create(): SchematicBuilder;
+
+    /**
+     * Parse a builder from the canonical template text format.
+     */
+    static fromTemplate(template: string): SchematicBuilder;
+
+    /**
+     * Set the schematic name.
+     */
+    name(name: string): void;
+
+    /**
+     * Map a palette character to a block string. `ch` must contain exactly
+     * one character (its first char is used).
+     */
+    map(ch: string, block: string): void;
+
+    /**
+     * Append layers. `layers_json` is a JSON array of arrays of row strings,
+     * e.g. `[["ab","cd"],["ef","gh"]]`.
+     */
+    layers(layersJson: string): void;
+
+    /**
+     * Append a single layer of rows. `rows_json` is a JSON array of strings,
+     * e.g. `["abc", "def"]`. Equivalent to a one-element layers array.
+     */
+    layer(rowsJson: string): void;
+
+    /**
+     * Bulk-register palette characters. `pairs_json` is a JSON array of
+     * `[char, block]` two-element arrays, e.g.
+     * `[["c", "minecraft:gray_concrete"], [" ", "minecraft:air"]]`.
+     */
+    palette(pairsJson: string): void;
+
+    /**
+     * Set the build offset applied to every placed block.
+     */
+    offset(x: number, y: number, z: number): void;
+
+    /**
+     * Register the standard Unicode palette (redstone wires, repeaters,
+     * comparators, torches, blocks, air...; the same set `create`
+     * pre-loads), overwriting any clashing character mappings.
+     */
+    useStandardPalette(): void;
+
+    /**
+     * Register the minimal palette (an essentials-only subset of the
+     * standard one), overwriting any clashing character mappings.
+     */
+    useMinimalPalette(): void;
+
+    /**
+     * Register the compact ASCII-only palette, overwriting any clashing
+     * character mappings.
+     */
+    useCompactPalette(): void;
+
+    /**
+     * Run pre-build validation without consuming the builder.
+     */
+    validate(): void;
+
+    /**
+     * Serialize the builder back into the canonical template format.
+     */
+    toTemplate(): string;
+
+    /**
+     * Build the schematic. Consuming: the builder cannot be reused afterwards
+     * (subsequent calls return `AlreadyConsumed`), including after a failed
+     * build.
+     */
+    build(): Schematic;
+}

package/renderer/SchematicBuilder.d.ts

@@ -0,0 +1,103 @@
+// 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";
+
+
+
+/**
+ * Fluent builder for schematics from character-mapped text layers.
+ *
+ * `build` is consuming (PORTING rule 11): the inner builder is held in an
+ * `Option` and taken on `build`; every method afterwards returns
+ * `AlreadyConsumed`.
+ */
+export class SchematicBuilder {
+    /** @internal */
+    get ffiValue(): pointer;
+    /** @internal */
+    constructor();
+
+
+    /**
+     * Create a new builder, pre-loaded with the standard Unicode palette
+     * (override any character via `map` or `palette`).
+     */
+    static create(): SchematicBuilder;
+
+    /**
+     * Parse a builder from the canonical template text format.
+     */
+    static fromTemplate(template: string): SchematicBuilder;
+
+    /**
+     * Set the schematic name.
+     */
+    name(name: string): void;
+
+    /**
+     * Map a palette character to a block string. `ch` must contain exactly
+     * one character (its first char is used).
+     */
+    map(ch: string, block: string): void;
+
+    /**
+     * Append layers. `layers_json` is a JSON array of arrays of row strings,
+     * e.g. `[["ab","cd"],["ef","gh"]]`.
+     */
+    layers(layersJson: string): void;
+
+    /**
+     * Append a single layer of rows. `rows_json` is a JSON array of strings,
+     * e.g. `["abc", "def"]`. Equivalent to a one-element layers array.
+     */
+    layer(rowsJson: string): void;
+
+    /**
+     * Bulk-register palette characters. `pairs_json` is a JSON array of
+     * `[char, block]` two-element arrays, e.g.
+     * `[["c", "minecraft:gray_concrete"], [" ", "minecraft:air"]]`.
+     */
+    palette(pairsJson: string): void;
+
+    /**
+     * Set the build offset applied to every placed block.
+     */
+    offset(x: number, y: number, z: number): void;
+
+    /**
+     * Register the standard Unicode palette (redstone wires, repeaters,
+     * comparators, torches, blocks, air...; the same set `create`
+     * pre-loads), overwriting any clashing character mappings.
+     */
+    useStandardPalette(): void;
+
+    /**
+     * Register the minimal palette (an essentials-only subset of the
+     * standard one), overwriting any clashing character mappings.
+     */
+    useMinimalPalette(): void;
+
+    /**
+     * Register the compact ASCII-only palette, overwriting any clashing
+     * character mappings.
+     */
+    useCompactPalette(): void;
+
+    /**
+     * Run pre-build validation without consuming the builder.
+     */
+    validate(): void;
+
+    /**
+     * Serialize the builder back into the canonical template format.
+     */
+    toTemplate(): string;
+
+    /**
+     * Build the schematic. Consuming: the builder cannot be reused afterwards
+     * (subsequent calls return `AlreadyConsumed`), including after a failed
+     * build.
+     */
+    build(): Schematic;
+}

package/renderer/SchematicBuilder.mjs

@@ -0,0 +1,401 @@
+// 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 SchematicBuilder_box_destroy_registry = new FinalizationRegistry((ptr) => {
+    wasm.SchematicBuilder_destroy(ptr);
+});
+
+/**
+ * Fluent builder for schematics from character-mapped text layers.
+ *
+ * `build` is consuming (PORTING rule 11): the inner builder is held in an
+ * `Option` and taken on `build`; every method afterwards returns
+ * `AlreadyConsumed`.
+ */
+export class SchematicBuilder {
+    // 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("SchematicBuilder 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) {
+            SchematicBuilder_box_destroy_registry.register(this, this.#ptr);
+        }
+
+        return this;
+    }
+    /** @internal */
+    get ffiValue() {
+        return this.#ptr;
+    }
+
+
+    /**
+     * Create a new builder, pre-loaded with the standard Unicode palette
+     * (override any character via `map` or `palette`).
+     */
+    static create() {
+
+        const result = wasm.SchematicBuilder_create();
+
+        try {
+            return new SchematicBuilder(diplomatRuntime.internalConstructor, result, []);
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+        }
+    }
+
+    /**
+     * Parse a builder from the canonical template text format.
+     */
+    static fromTemplate(template) {
+        let functionCleanupArena = new diplomatRuntime.CleanupArena();
+
+        const templateSlice = functionCleanupArena.alloc(diplomatRuntime.DiplomatBuf.sliceWrapper(wasm, diplomatRuntime.DiplomatBuf.str8(wasm, template)));
+        const diplomatReceive = new diplomatRuntime.DiplomatReceiveBuf(wasm, 5, 4, true);
+
+
+        const result = wasm.SchematicBuilder_from_template(diplomatReceive.buffer, templateSlice.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 SchematicBuilder(diplomatRuntime.internalConstructor, diplomatRuntime.ptrRead(wasm, diplomatReceive.buffer), []);
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+            functionCleanupArena.free();
+
+            diplomatReceive.free();
+        }
+    }
+
+    /**
+     * Set the schematic name.
+     */
+    name(name) {
+        let functionCleanupArena = new diplomatRuntime.CleanupArena();
+
+        const nameSlice = functionCleanupArena.alloc(diplomatRuntime.DiplomatBuf.sliceWrapper(wasm, diplomatRuntime.DiplomatBuf.str8(wasm, name)));
+        const diplomatReceive = new diplomatRuntime.DiplomatReceiveBuf(wasm, 5, 4, true);
+
+
+        const result = wasm.SchematicBuilder_name(diplomatReceive.buffer, this.ffiValue, nameSlice.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();
+        }
+    }
+
+    /**
+     * Map a palette character to a block string. `ch` must contain exactly
+     * one character (its first char is used).
+     */
+    map(ch, block) {
+        let functionCleanupArena = new diplomatRuntime.CleanupArena();
+
+        const chSlice = functionCleanupArena.alloc(diplomatRuntime.DiplomatBuf.sliceWrapper(wasm, diplomatRuntime.DiplomatBuf.str8(wasm, ch)));
+        const blockSlice = functionCleanupArena.alloc(diplomatRuntime.DiplomatBuf.sliceWrapper(wasm, diplomatRuntime.DiplomatBuf.str8(wasm, block)));
+        const diplomatReceive = new diplomatRuntime.DiplomatReceiveBuf(wasm, 5, 4, true);
+
+
+        const result = wasm.SchematicBuilder_map(diplomatReceive.buffer, this.ffiValue, chSlice.ptr, blockSlice.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();
+        }
+    }
+
+    /**
+     * Append layers. `layers_json` is a JSON array of arrays of row strings,
+     * e.g. `[["ab","cd"],["ef","gh"]]`.
+     */
+    layers(layersJson) {
+        let functionCleanupArena = new diplomatRuntime.CleanupArena();
+
+        const layersJsonSlice = functionCleanupArena.alloc(diplomatRuntime.DiplomatBuf.sliceWrapper(wasm, diplomatRuntime.DiplomatBuf.str8(wasm, layersJson)));
+        const diplomatReceive = new diplomatRuntime.DiplomatReceiveBuf(wasm, 5, 4, true);
+
+
+        const result = wasm.SchematicBuilder_layers(diplomatReceive.buffer, this.ffiValue, layersJsonSlice.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();
+        }
+    }
+
+    /**
+     * Append a single layer of rows. `rows_json` is a JSON array of strings,
+     * e.g. `["abc", "def"]`. Equivalent to a one-element layers array.
+     */
+    layer(rowsJson) {
+        let functionCleanupArena = new diplomatRuntime.CleanupArena();
+
+        const rowsJsonSlice = functionCleanupArena.alloc(diplomatRuntime.DiplomatBuf.sliceWrapper(wasm, diplomatRuntime.DiplomatBuf.str8(wasm, rowsJson)));
+        const diplomatReceive = new diplomatRuntime.DiplomatReceiveBuf(wasm, 5, 4, true);
+
+
+        const result = wasm.SchematicBuilder_layer(diplomatReceive.buffer, this.ffiValue, rowsJsonSlice.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();
+        }
+    }
+
+    /**
+     * Bulk-register palette characters. `pairs_json` is a JSON array of
+     * `[char, block]` two-element arrays, e.g.
+     * `[["c", "minecraft:gray_concrete"], [" ", "minecraft:air"]]`.
+     */
+    palette(pairsJson) {
+        let functionCleanupArena = new diplomatRuntime.CleanupArena();
+
+        const pairsJsonSlice = functionCleanupArena.alloc(diplomatRuntime.DiplomatBuf.sliceWrapper(wasm, diplomatRuntime.DiplomatBuf.str8(wasm, pairsJson)));
+        const diplomatReceive = new diplomatRuntime.DiplomatReceiveBuf(wasm, 5, 4, true);
+
+
+        const result = wasm.SchematicBuilder_palette(diplomatReceive.buffer, this.ffiValue, pairsJsonSlice.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();
+        }
+    }
+
+    /**
+     * Set the build offset applied to every placed block.
+     */
+    offset(x, y, z) {
+        const diplomatReceive = new diplomatRuntime.DiplomatReceiveBuf(wasm, 5, 4, true);
+
+
+        const result = wasm.SchematicBuilder_offset(diplomatReceive.buffer, this.ffiValue, x, y, z);
+
+        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();
+            diplomatReceive.free();
+        }
+    }
+
+    /**
+     * Register the standard Unicode palette (redstone wires, repeaters,
+     * comparators, torches, blocks, air...; the same set `create`
+     * pre-loads), overwriting any clashing character mappings.
+     */
+    useStandardPalette() {
+        const diplomatReceive = new diplomatRuntime.DiplomatReceiveBuf(wasm, 5, 4, true);
+
+
+        const result = wasm.SchematicBuilder_use_standard_palette(diplomatReceive.buffer, this.ffiValue);
+
+        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();
+            diplomatReceive.free();
+        }
+    }
+
+    /**
+     * Register the minimal palette (an essentials-only subset of the
+     * standard one), overwriting any clashing character mappings.
+     */
+    useMinimalPalette() {
+        const diplomatReceive = new diplomatRuntime.DiplomatReceiveBuf(wasm, 5, 4, true);
+
+
+        const result = wasm.SchematicBuilder_use_minimal_palette(diplomatReceive.buffer, this.ffiValue);
+
+        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();
+            diplomatReceive.free();
+        }
+    }
+
+    /**
+     * Register the compact ASCII-only palette, overwriting any clashing
+     * character mappings.
+     */
+    useCompactPalette() {
+        const diplomatReceive = new diplomatRuntime.DiplomatReceiveBuf(wasm, 5, 4, true);
+
+
+        const result = wasm.SchematicBuilder_use_compact_palette(diplomatReceive.buffer, this.ffiValue);
+
+        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();
+            diplomatReceive.free();
+        }
+    }
+
+    /**
+     * Run pre-build validation without consuming the builder.
+     */
+    validate() {
+        const diplomatReceive = new diplomatRuntime.DiplomatReceiveBuf(wasm, 5, 4, true);
+
+
+        const result = wasm.SchematicBuilder_validate(diplomatReceive.buffer, this.ffiValue);
+
+        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();
+            diplomatReceive.free();
+        }
+    }
+
+    /**
+     * Serialize the builder back into the canonical template format.
+     */
+    toTemplate() {
+        const diplomatReceive = new diplomatRuntime.DiplomatReceiveBuf(wasm, 5, 4, true);
+
+        const write = new diplomatRuntime.DiplomatWriteBuf(wasm);
+
+
+        const result = wasm.SchematicBuilder_to_template(diplomatReceive.buffer, this.ffiValue, 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();
+        }
+    }
+
+    /**
+     * Build the schematic. Consuming: the builder cannot be reused afterwards
+     * (subsequent calls return `AlreadyConsumed`), including after a failed
+     * build.
+     */
+    build() {
+        const diplomatReceive = new diplomatRuntime.DiplomatReceiveBuf(wasm, 5, 4, true);
+
+
+        const result = wasm.SchematicBuilder_build(diplomatReceive.buffer, this.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 Schematic(diplomatRuntime.internalConstructor, diplomatRuntime.ptrRead(wasm, diplomatReceive.buffer), []);
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+            diplomatReceive.free();
+        }
+    }
+
+    constructor(symbol, ptr, selfEdge) {
+        return this.#internalConstructor(...arguments)
+    }
+}

package/renderer/SchematicRegions.d.mts

@@ -0,0 +1,93 @@
+// generated by diplomat-tool
+import type { DefinitionRegion } from "./DefinitionRegion.mjs"
+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 schematic-attached definition-region operations
+ * (PORTING rule 12; the `Schematic` opaque lives in another module, so
+ * these are statics taking it explicitly, like `Autostack`).
+ */
+export class SchematicRegions {
+    /** @internal */
+    get ffiValue(): pointer;
+    /** @internal */
+    constructor();
+
+
+    /**
+     * Insert (or overwrite) `region` under `name`.
+     */
+    static add(schematic: Schematic, name: string, region: DefinitionRegion): void;
+
+    /**
+     * Overwrite the region stored under `name` (identical to `add` in the
+     * old ABI too; kept as a separate method for 1:1 coverage of
+     * `schematic_update_region`).
+     */
+    static update(schematic: Schematic, name: string, region: DefinitionRegion): void;
+
+    /**
+     * A copy of the region stored under `name`. Errors with `NotFound` when
+     * absent.
+     */
+    static get(schematic: Schematic, name: string): DefinitionRegion;
+
+    /**
+     * Remove the region stored under `name`. Errors with `NotFound` when
+     * absent.
+     */
+    static remove(schematic: Schematic, name: string): void;
+
+    /**
+     * The names of every definition region, written as a JSON array string.
+     */
+    static namesJson(schematic: Schematic): string;
+
+    /**
+     * Create an empty region under `name`.
+     */
+    static create(schematic: Schematic, name: string): void;
+
+    /**
+     * Create a single-point region under `name`.
+     */
+    static createFromPoint(schematic: Schematic, name: string, x: number, y: number, z: number): void;
+
+    /**
+     * Create a single-box region under `name`.
+     */
+    static createFromBounds(schematic: Schematic, name: string, minX: number, minY: number, minZ: number, maxX: number, maxY: number, maxZ: number): void;
+
+    /**
+     * Create a single-box region under `name` and return a copy of it.
+     */
+    static createRegion(schematic: Schematic, name: string, minX: number, minY: number, minZ: number, maxX: number, maxY: number, maxZ: number): DefinitionRegion;
+
+    /**
+     * Add a box to the region stored under `name`. Errors with `NotFound`
+     * when absent.
+     */
+    static addBoundsTo(schematic: Schematic, name: string, minX: number, minY: number, minZ: number, maxX: number, maxY: number, maxZ: number): void;
+
+    /**
+     * Add a point to the region stored under `name`. Errors with `NotFound`
+     * when absent.
+     */
+    static addPointTo(schematic: Schematic, name: string, x: number, y: number, z: number): void;
+
+    /**
+     * Set a metadata entry on the region stored under `name`. Errors with
+     * `NotFound` when absent.
+     */
+    static setMetadataOn(schematic: Schematic, name: string, key: string, value: string): void;
+
+    /**
+     * Shift the region stored under `name` by (`dx`, `dy`, `dz`). Errors
+     * with `NotFound` when absent.
+     */
+    static shiftRegion(schematic: Schematic, name: string, dx: number, dy: number, dz: number): void;
+}