@twip/web 0.0.0 → 0.1.0-alpha.1

package/dist/Highlight.mjs

@@ -0,0 +1,117 @@
+// generated by diplomat-tool
+import wasm from "./diplomat-wasm.mjs";
+import * as diplomatRuntime from "./diplomat-runtime.mjs";
+
+
+
+/**
+ * A text highlight colour.
+ */
+export class Highlight {
+    #value = undefined;
+
+    static #values = new Map([
+        ["Yellow", 0],
+        ["Green", 1],
+        ["Cyan", 2],
+        ["Magenta", 3],
+        ["Blue", 4],
+        ["Red", 5],
+        ["DarkBlue", 6],
+        ["DarkCyan", 7],
+        ["DarkGreen", 8],
+        ["DarkMagenta", 9],
+        ["DarkRed", 10],
+        ["DarkYellow", 11],
+        ["DarkGray", 12],
+        ["LightGray", 13],
+        ["Black", 14],
+        ["None", 15]
+    ]);
+
+    static getAllEntries() {
+        return Highlight.#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 Highlight.#objectValues[arguments[1]];
+        }
+
+        if (value instanceof Highlight) {
+            return value;
+        }
+
+        let intVal = Highlight.#values.get(value);
+
+        // Nullish check, checks for null or undefined
+        if (intVal != null) {
+            return Highlight.#objectValues[intVal];
+        }
+
+        throw TypeError(value + " is not a Highlight and does not correspond to any of its enumerator values.");
+    }
+
+    /** @internal */
+    static fromValue(value) {
+        return new Highlight(value);
+    }
+
+    get value(){
+        return [...Highlight.#values.keys()][this.#value];
+    }
+
+    /** @internal */
+    get ffiValue(){
+        return this.#value;
+    }
+    static #objectValues = [
+        new Highlight(diplomatRuntime.internalConstructor, diplomatRuntime.internalConstructor, 0),
+        new Highlight(diplomatRuntime.internalConstructor, diplomatRuntime.internalConstructor, 1),
+        new Highlight(diplomatRuntime.internalConstructor, diplomatRuntime.internalConstructor, 2),
+        new Highlight(diplomatRuntime.internalConstructor, diplomatRuntime.internalConstructor, 3),
+        new Highlight(diplomatRuntime.internalConstructor, diplomatRuntime.internalConstructor, 4),
+        new Highlight(diplomatRuntime.internalConstructor, diplomatRuntime.internalConstructor, 5),
+        new Highlight(diplomatRuntime.internalConstructor, diplomatRuntime.internalConstructor, 6),
+        new Highlight(diplomatRuntime.internalConstructor, diplomatRuntime.internalConstructor, 7),
+        new Highlight(diplomatRuntime.internalConstructor, diplomatRuntime.internalConstructor, 8),
+        new Highlight(diplomatRuntime.internalConstructor, diplomatRuntime.internalConstructor, 9),
+        new Highlight(diplomatRuntime.internalConstructor, diplomatRuntime.internalConstructor, 10),
+        new Highlight(diplomatRuntime.internalConstructor, diplomatRuntime.internalConstructor, 11),
+        new Highlight(diplomatRuntime.internalConstructor, diplomatRuntime.internalConstructor, 12),
+        new Highlight(diplomatRuntime.internalConstructor, diplomatRuntime.internalConstructor, 13),
+        new Highlight(diplomatRuntime.internalConstructor, diplomatRuntime.internalConstructor, 14),
+        new Highlight(diplomatRuntime.internalConstructor, diplomatRuntime.internalConstructor, 15),
+    ];
+
+    static Yellow = Highlight.#objectValues[0];
+    static Green = Highlight.#objectValues[1];
+    static Cyan = Highlight.#objectValues[2];
+    static Magenta = Highlight.#objectValues[3];
+    static Blue = Highlight.#objectValues[4];
+    static Red = Highlight.#objectValues[5];
+    static DarkBlue = Highlight.#objectValues[6];
+    static DarkCyan = Highlight.#objectValues[7];
+    static DarkGreen = Highlight.#objectValues[8];
+    static DarkMagenta = Highlight.#objectValues[9];
+    static DarkRed = Highlight.#objectValues[10];
+    static DarkYellow = Highlight.#objectValues[11];
+    static DarkGray = Highlight.#objectValues[12];
+    static LightGray = Highlight.#objectValues[13];
+    static Black = Highlight.#objectValues[14];
+    /**
+     * No highlight.
+     */
+    static None = Highlight.#objectValues[15];
+
+
+    constructor(value) {
+        return this.#internalConstructor(...arguments)
+    }
+}

package/dist/MarginPreset.d.ts

@@ -0,0 +1,38 @@
+// generated by diplomat-tool
+import type { pointer, codepoint } from "./diplomat-runtime.d.ts";
+
+
+
+/**
+ * Page margin presets.
+ */
+export class MarginPreset {
+
+    /** @internal */
+    static fromValue(value: MarginPreset | string): MarginPreset;
+
+    get value(): string;
+
+    /** @internal */
+    get ffiValue(): number;
+
+    /**
+     * 1 in on every side.
+     */
+    static Normal : MarginPreset;
+    /**
+     * 0.5 in on every side.
+     */
+    static Narrow : MarginPreset;
+    /**
+     * 1 in top and bottom, 0.75 in left and right.
+     */
+    static Moderate : MarginPreset;
+    /**
+     * 1 in top and bottom, 2 in left and right.
+     */
+    static Wide : MarginPreset;
+
+
+    constructor(value: MarginPreset | string );
+}

package/dist/MarginPreset.mjs

@@ -0,0 +1,90 @@
+// generated by diplomat-tool
+import wasm from "./diplomat-wasm.mjs";
+import * as diplomatRuntime from "./diplomat-runtime.mjs";
+
+
+
+/**
+ * Page margin presets.
+ */
+export class MarginPreset {
+    #value = undefined;
+
+    static #values = new Map([
+        ["Normal", 0],
+        ["Narrow", 1],
+        ["Moderate", 2],
+        ["Wide", 3]
+    ]);
+
+    static getAllEntries() {
+        return MarginPreset.#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 MarginPreset.#objectValues[arguments[1]];
+        }
+
+        if (value instanceof MarginPreset) {
+            return value;
+        }
+
+        let intVal = MarginPreset.#values.get(value);
+
+        // Nullish check, checks for null or undefined
+        if (intVal != null) {
+            return MarginPreset.#objectValues[intVal];
+        }
+
+        throw TypeError(value + " is not a MarginPreset and does not correspond to any of its enumerator values.");
+    }
+
+    /** @internal */
+    static fromValue(value) {
+        return new MarginPreset(value);
+    }
+
+    get value(){
+        return [...MarginPreset.#values.keys()][this.#value];
+    }
+
+    /** @internal */
+    get ffiValue(){
+        return this.#value;
+    }
+    static #objectValues = [
+        new MarginPreset(diplomatRuntime.internalConstructor, diplomatRuntime.internalConstructor, 0),
+        new MarginPreset(diplomatRuntime.internalConstructor, diplomatRuntime.internalConstructor, 1),
+        new MarginPreset(diplomatRuntime.internalConstructor, diplomatRuntime.internalConstructor, 2),
+        new MarginPreset(diplomatRuntime.internalConstructor, diplomatRuntime.internalConstructor, 3),
+    ];
+
+    /**
+     * 1 in on every side.
+     */
+    static Normal = MarginPreset.#objectValues[0];
+    /**
+     * 0.5 in on every side.
+     */
+    static Narrow = MarginPreset.#objectValues[1];
+    /**
+     * 1 in top and bottom, 0.75 in left and right.
+     */
+    static Moderate = MarginPreset.#objectValues[2];
+    /**
+     * 1 in top and bottom, 2 in left and right.
+     */
+    static Wide = MarginPreset.#objectValues[3];
+
+
+    constructor(value) {
+        return this.#internalConstructor(...arguments)
+    }
+}

package/dist/MarkSeverity.d.ts

@@ -0,0 +1,25 @@
+// generated by diplomat-tool
+import type { pointer, codepoint } from "./diplomat-runtime.d.ts";
+
+
+
+/**
+ * How serious a mark on an element is.
+ */
+export class MarkSeverity {
+
+    /** @internal */
+    static fromValue(value: MarkSeverity | string): MarkSeverity;
+
+    get value(): string;
+
+    /** @internal */
+    get ffiValue(): number;
+
+    static Error : MarkSeverity;
+    static Warning : MarkSeverity;
+    static Info : MarkSeverity;
+
+
+    constructor(value: MarkSeverity | string );
+}

package/dist/MarkSeverity.mjs

@@ -0,0 +1,75 @@
+// generated by diplomat-tool
+import wasm from "./diplomat-wasm.mjs";
+import * as diplomatRuntime from "./diplomat-runtime.mjs";
+
+
+
+/**
+ * How serious a mark on an element is.
+ */
+export class MarkSeverity {
+    #value = undefined;
+
+    static #values = new Map([
+        ["Error", 0],
+        ["Warning", 1],
+        ["Info", 2]
+    ]);
+
+    static getAllEntries() {
+        return MarkSeverity.#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 MarkSeverity.#objectValues[arguments[1]];
+        }
+
+        if (value instanceof MarkSeverity) {
+            return value;
+        }
+
+        let intVal = MarkSeverity.#values.get(value);
+
+        // Nullish check, checks for null or undefined
+        if (intVal != null) {
+            return MarkSeverity.#objectValues[intVal];
+        }
+
+        throw TypeError(value + " is not a MarkSeverity and does not correspond to any of its enumerator values.");
+    }
+
+    /** @internal */
+    static fromValue(value) {
+        return new MarkSeverity(value);
+    }
+
+    get value(){
+        return [...MarkSeverity.#values.keys()][this.#value];
+    }
+
+    /** @internal */
+    get ffiValue(){
+        return this.#value;
+    }
+    static #objectValues = [
+        new MarkSeverity(diplomatRuntime.internalConstructor, diplomatRuntime.internalConstructor, 0),
+        new MarkSeverity(diplomatRuntime.internalConstructor, diplomatRuntime.internalConstructor, 1),
+        new MarkSeverity(diplomatRuntime.internalConstructor, diplomatRuntime.internalConstructor, 2),
+    ];
+
+    static Error = MarkSeverity.#objectValues[0];
+    static Warning = MarkSeverity.#objectValues[1];
+    static Info = MarkSeverity.#objectValues[2];
+
+
+    constructor(value) {
+        return this.#internalConstructor(...arguments)
+    }
+}

package/dist/Modifiers.d.ts

@@ -0,0 +1,34 @@
+// generated by diplomat-tool
+import type { pointer, codepoint } from "./diplomat-runtime.d.ts";
+
+export type Modifiers_obj = {
+    ctrl: boolean;
+    shift: boolean;
+    alt: boolean;
+    meta: boolean;
+};
+
+
+
+/**
+ * Modifier keys held during a key press or pointer event.
+ */
+export class Modifiers {
+    get ctrl(): boolean;
+    set ctrl(value: boolean);
+    get shift(): boolean;
+    set shift(value: boolean);
+    get alt(): boolean;
+    set alt(value: boolean);
+    get meta(): boolean;
+    set meta(value: boolean);
+    /** @internal */
+    static fromFields(structObj : Modifiers_obj) : Modifiers;
+
+    /**
+    * Create `Modifiers` from an object that contains all of `Modifiers`s fields.
+    * Optional fields do not need to be included in the provided object.
+    */
+    constructor(structObj: Modifiers_obj);
+
+}

package/dist/Modifiers.mjs

@@ -0,0 +1,148 @@
+// generated by diplomat-tool
+import wasm from "./diplomat-wasm.mjs";
+import * as diplomatRuntime from "./diplomat-runtime.mjs";
+
+
+
+/**
+ * Modifier keys held during a key press or pointer event.
+ */
+export class Modifiers {
+    #ctrl;
+    get ctrl() {
+        return this.#ctrl;
+    }
+    set ctrl(value){
+        this.#ctrl = value;
+    }
+    #shift;
+    get shift() {
+        return this.#shift;
+    }
+    set shift(value){
+        this.#shift = value;
+    }
+    #alt;
+    get alt() {
+        return this.#alt;
+    }
+    set alt(value){
+        this.#alt = value;
+    }
+    #meta;
+    get meta() {
+        return this.#meta;
+    }
+    set meta(value){
+        this.#meta = value;
+    }
+    /** @internal */
+    static fromFields(structObj) {
+        return new Modifiers(structObj);
+    }
+
+    #internalConstructor(structObj) {
+        if (typeof structObj !== "object") {
+            throw new Error("Modifiers's constructor takes an object of Modifiers's fields.");
+        }
+
+        if ("ctrl" in structObj) {
+            this.#ctrl = structObj.ctrl;
+        } else {
+            throw new Error("Missing required field ctrl.");
+        }
+
+        if ("shift" in structObj) {
+            this.#shift = structObj.shift;
+        } else {
+            throw new Error("Missing required field shift.");
+        }
+
+        if ("alt" in structObj) {
+            this.#alt = structObj.alt;
+        } else {
+            throw new Error("Missing required field alt.");
+        }
+
+        if ("meta" in structObj) {
+            this.#meta = structObj.meta;
+        } else {
+            throw new Error("Missing required field meta.");
+        }
+
+        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 4;
+    }
+
+    /// Currently unused, we may want to use later on though:
+    static get _sizeAlign() {
+        return 1;
+    }
+
+    static _fromSuppliedValue(internalConstructor, obj) {
+        if (internalConstructor !== diplomatRuntime.internalConstructor) {
+            throw new Error("_fromSuppliedValue cannot be called externally.");
+        }
+
+        if (obj instanceof Modifiers) {
+            return obj;
+        }
+
+        return Modifiers.fromFields(obj);
+    }
+
+    _writeToArrayBuffer(
+        arrayBuffer,
+        offset,
+        functionCleanupArena,
+        appendArrayMap
+    ) {
+        diplomatRuntime.writeToArrayBuffer(arrayBuffer, offset + 0, this.#ctrl, Uint8Array);
+        diplomatRuntime.writeToArrayBuffer(arrayBuffer, offset + 1, this.#shift, Uint8Array);
+        diplomatRuntime.writeToArrayBuffer(arrayBuffer, offset + 2, this.#alt, Uint8Array);
+        diplomatRuntime.writeToArrayBuffer(arrayBuffer, offset + 3, this.#meta, Uint8Array);
+    }
+
+    // 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("Modifiers._fromFFI is not meant to be called externally. Please use the default constructor.");
+        }
+        let structObj = {};
+        const ctrlDeref = (new Uint8Array(wasm.memory.buffer, ptr, 1))[0] === 1;
+        structObj.ctrl = ctrlDeref;
+        const shiftDeref = (new Uint8Array(wasm.memory.buffer, ptr + 1, 1))[0] === 1;
+        structObj.shift = shiftDeref;
+        const altDeref = (new Uint8Array(wasm.memory.buffer, ptr + 2, 1))[0] === 1;
+        structObj.alt = altDeref;
+        const metaDeref = (new Uint8Array(wasm.memory.buffer, ptr + 3, 1))[0] === 1;
+        structObj.meta = metaDeref;
+
+        return new Modifiers(structObj);
+    }
+
+
+    constructor(structObj) {
+        return this.#internalConstructor(...arguments)
+    }
+}

package/dist/OpenError.d.ts

@@ -0,0 +1,30 @@
+// generated by diplomat-tool
+import type { pointer, codepoint } from "./diplomat-runtime.d.ts";
+
+
+
+/**
+ * Why a document didn't open.
+ */
+export class OpenError {
+
+    /** @internal */
+    static fromValue(value: OpenError | string): OpenError;
+
+    get value(): string;
+
+    /** @internal */
+    get ffiValue(): number;
+
+    /**
+     * No bytes.
+     */
+    static Empty : OpenError;
+    /**
+     * Not a .docx package Twip can read.
+     */
+    static Invalid : OpenError;
+
+
+    constructor(value: OpenError | string );
+}

package/dist/OpenError.mjs

@@ -0,0 +1,78 @@
+// generated by diplomat-tool
+import wasm from "./diplomat-wasm.mjs";
+import * as diplomatRuntime from "./diplomat-runtime.mjs";
+
+
+
+/**
+ * Why a document didn't open.
+ */
+export class OpenError {
+    #value = undefined;
+
+    static #values = new Map([
+        ["Empty", 0],
+        ["Invalid", 1]
+    ]);
+
+    static getAllEntries() {
+        return OpenError.#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 OpenError.#objectValues[arguments[1]];
+        }
+
+        if (value instanceof OpenError) {
+            return value;
+        }
+
+        let intVal = OpenError.#values.get(value);
+
+        // Nullish check, checks for null or undefined
+        if (intVal != null) {
+            return OpenError.#objectValues[intVal];
+        }
+
+        throw TypeError(value + " is not a OpenError and does not correspond to any of its enumerator values.");
+    }
+
+    /** @internal */
+    static fromValue(value) {
+        return new OpenError(value);
+    }
+
+    get value(){
+        return [...OpenError.#values.keys()][this.#value];
+    }
+
+    /** @internal */
+    get ffiValue(){
+        return this.#value;
+    }
+    static #objectValues = [
+        new OpenError(diplomatRuntime.internalConstructor, diplomatRuntime.internalConstructor, 0),
+        new OpenError(diplomatRuntime.internalConstructor, diplomatRuntime.internalConstructor, 1),
+    ];
+
+    /**
+     * No bytes.
+     */
+    static Empty = OpenError.#objectValues[0];
+    /**
+     * Not a .docx package Twip can read.
+     */
+    static Invalid = OpenError.#objectValues[1];
+
+
+    constructor(value) {
+        return this.#internalConstructor(...arguments)
+    }
+}

package/dist/Orientation.d.ts

@@ -0,0 +1,30 @@
+// generated by diplomat-tool
+import type { pointer, codepoint } from "./diplomat-runtime.d.ts";
+
+
+
+/**
+ * Page orientation.
+ */
+export class Orientation {
+
+    /** @internal */
+    static fromValue(value: Orientation | string): Orientation;
+
+    get value(): string;
+
+    /** @internal */
+    get ffiValue(): number;
+
+    /**
+     * Taller than wide.
+     */
+    static Portrait : Orientation;
+    /**
+     * Wider than tall.
+     */
+    static Landscape : Orientation;
+
+
+    constructor(value: Orientation | string );
+}