@twip/web 0.0.0 → 0.1.0-alpha.1

package/dist/EditorMode.d.ts

@@ -0,0 +1,34 @@
+// generated by diplomat-tool
+import type { pointer, codepoint } from "./diplomat-runtime.d.ts";
+
+
+
+/**
+ * What the editor lets the user do.
+ */
+export class EditorMode {
+
+    /** @internal */
+    static fromValue(value: EditorMode | string): EditorMode;
+
+    get value(): string;
+
+    /** @internal */
+    get ffiValue(): number;
+
+    /**
+     * Normal editing.
+     */
+    static Editing : EditorMode;
+    /**
+     * Template design: fields and controls show their names.
+     */
+    static Design : EditorMode;
+    /**
+     * Viewing only: nothing can change the document.
+     */
+    static ReadOnly : EditorMode;
+
+
+    constructor(value: EditorMode | string );
+}

package/dist/EditorMode.mjs

@@ -0,0 +1,84 @@
+// generated by diplomat-tool
+import wasm from "./diplomat-wasm.mjs";
+import * as diplomatRuntime from "./diplomat-runtime.mjs";
+
+
+
+/**
+ * What the editor lets the user do.
+ */
+export class EditorMode {
+    #value = undefined;
+
+    static #values = new Map([
+        ["Editing", 0],
+        ["Design", 1],
+        ["ReadOnly", 2]
+    ]);
+
+    static getAllEntries() {
+        return EditorMode.#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 EditorMode.#objectValues[arguments[1]];
+        }
+
+        if (value instanceof EditorMode) {
+            return value;
+        }
+
+        let intVal = EditorMode.#values.get(value);
+
+        // Nullish check, checks for null or undefined
+        if (intVal != null) {
+            return EditorMode.#objectValues[intVal];
+        }
+
+        throw TypeError(value + " is not a EditorMode and does not correspond to any of its enumerator values.");
+    }
+
+    /** @internal */
+    static fromValue(value) {
+        return new EditorMode(value);
+    }
+
+    get value(){
+        return [...EditorMode.#values.keys()][this.#value];
+    }
+
+    /** @internal */
+    get ffiValue(){
+        return this.#value;
+    }
+    static #objectValues = [
+        new EditorMode(diplomatRuntime.internalConstructor, diplomatRuntime.internalConstructor, 0),
+        new EditorMode(diplomatRuntime.internalConstructor, diplomatRuntime.internalConstructor, 1),
+        new EditorMode(diplomatRuntime.internalConstructor, diplomatRuntime.internalConstructor, 2),
+    ];
+
+    /**
+     * Normal editing.
+     */
+    static Editing = EditorMode.#objectValues[0];
+    /**
+     * Template design: fields and controls show their names.
+     */
+    static Design = EditorMode.#objectValues[1];
+    /**
+     * Viewing only: nothing can change the document.
+     */
+    static ReadOnly = EditorMode.#objectValues[2];
+
+
+    constructor(value) {
+        return this.#internalConstructor(...arguments)
+    }
+}

package/dist/Element.d.ts

@@ -0,0 +1,57 @@
+// generated by diplomat-tool
+import type { pointer, codepoint } from "./diplomat-runtime.d.ts";
+
+
+
+/**
+ * A field or content control in the document.
+ */
+export class Element {
+    /** @internal */
+    get ffiValue(): pointer;
+    /** @internal */
+    constructor();
+
+
+    /**
+     * Its id, for the element methods (`select_element`, `set_field`, ...).
+     */
+    id(): string;
+
+    /**
+     * `field`, or the control's kind (`plain_text`, `rich_text`, `checkbox`, `date`, `dropdown`, `picture`, ...).
+     */
+    kind(): string;
+
+    /**
+     * What the document shows for it.
+     */
+    display(): string;
+
+    /**
+     * A field's code (`MERGEFIELD Name`), empty for a control.
+     */
+    code(): string;
+
+    /**
+     * A control's tag, empty for a field.
+     */
+    tag(): string;
+
+    /**
+     * A control's title, empty for a field.
+     */
+    alias(): string;
+
+    /**
+     * The id of the element it's nested in, empty at the top.
+     */
+    parent(): string;
+
+    /**
+     * The story it's in: `body`, `header`, `footer`, `footnote`, `endnote`, `textbox`.
+     */
+    story(): string;
+
+    get locked(): boolean;
+}

package/dist/Element.mjs

@@ -0,0 +1,201 @@
+// generated by diplomat-tool
+import wasm from "./diplomat-wasm.mjs";
+import * as diplomatRuntime from "./diplomat-runtime.mjs";
+
+const Element_box_destroy_registry = new FinalizationRegistry((ptr) => {
+    wasm.Element_destroy(ptr);
+});
+
+/**
+ * A field or content control in the document.
+ */
+export class Element {
+    // 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("Element 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) {
+            Element_box_destroy_registry.register(this, this.#ptr);
+        }
+
+        return this;
+    }
+    /** @internal */
+    get ffiValue() {
+        return this.#ptr;
+    }
+
+
+    /**
+     * Its id, for the element methods (`select_element`, `set_field`, ...).
+     */
+    id() {
+        const write = new diplomatRuntime.DiplomatWriteBuf(wasm);
+
+    wasm.Element_id(this.ffiValue, write.buffer);
+
+        try {
+            return write.readString8();
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+            write.free();
+        }
+    }
+
+    /**
+     * `field`, or the control's kind (`plain_text`, `rich_text`, `checkbox`, `date`, `dropdown`, `picture`, ...).
+     */
+    kind() {
+        const write = new diplomatRuntime.DiplomatWriteBuf(wasm);
+
+    wasm.Element_kind(this.ffiValue, write.buffer);
+
+        try {
+            return write.readString8();
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+            write.free();
+        }
+    }
+
+    /**
+     * What the document shows for it.
+     */
+    display() {
+        const write = new diplomatRuntime.DiplomatWriteBuf(wasm);
+
+    wasm.Element_display(this.ffiValue, write.buffer);
+
+        try {
+            return write.readString8();
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+            write.free();
+        }
+    }
+
+    /**
+     * A field's code (`MERGEFIELD Name`), empty for a control.
+     */
+    code() {
+        const write = new diplomatRuntime.DiplomatWriteBuf(wasm);
+
+    wasm.Element_code(this.ffiValue, write.buffer);
+
+        try {
+            return write.readString8();
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+            write.free();
+        }
+    }
+
+    /**
+     * A control's tag, empty for a field.
+     */
+    tag() {
+        const write = new diplomatRuntime.DiplomatWriteBuf(wasm);
+
+    wasm.Element_tag(this.ffiValue, write.buffer);
+
+        try {
+            return write.readString8();
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+            write.free();
+        }
+    }
+
+    /**
+     * A control's title, empty for a field.
+     */
+    alias() {
+        const write = new diplomatRuntime.DiplomatWriteBuf(wasm);
+
+    wasm.Element_alias(this.ffiValue, write.buffer);
+
+        try {
+            return write.readString8();
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+            write.free();
+        }
+    }
+
+    /**
+     * The id of the element it's nested in, empty at the top.
+     */
+    parent() {
+        const write = new diplomatRuntime.DiplomatWriteBuf(wasm);
+
+    wasm.Element_parent(this.ffiValue, write.buffer);
+
+        try {
+            return write.readString8();
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+            write.free();
+        }
+    }
+
+    /**
+     * The story it's in: `body`, `header`, `footer`, `footnote`, `endnote`, `textbox`.
+     */
+    story() {
+        const write = new diplomatRuntime.DiplomatWriteBuf(wasm);
+
+    wasm.Element_story(this.ffiValue, write.buffer);
+
+        try {
+            return write.readString8();
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+            write.free();
+        }
+    }
+
+    get locked() {
+
+        const result = wasm.Element_locked(this.ffiValue);
+
+        try {
+            return result === 1;
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+        }
+    }
+
+    constructor(symbol, ptr, selfEdge) {
+        return this.#internalConstructor(...arguments)
+    }
+}

package/dist/ElementKind.d.ts

@@ -0,0 +1,28 @@
+// generated by diplomat-tool
+import type { pointer, codepoint } from "./diplomat-runtime.d.ts";
+
+
+
+/**
+ * Which elements to include.
+ */
+export class ElementKind {
+
+    /** @internal */
+    static fromValue(value: ElementKind | string): ElementKind;
+
+    get value(): string;
+
+    /** @internal */
+    get ffiValue(): number;
+
+    /**
+     * Fields and controls.
+     */
+    static Any : ElementKind;
+    static Field : ElementKind;
+    static Control : ElementKind;
+
+
+    constructor(value: ElementKind | string );
+}

package/dist/ElementKind.mjs

@@ -0,0 +1,78 @@
+// generated by diplomat-tool
+import wasm from "./diplomat-wasm.mjs";
+import * as diplomatRuntime from "./diplomat-runtime.mjs";
+
+
+
+/**
+ * Which elements to include.
+ */
+export class ElementKind {
+    #value = undefined;
+
+    static #values = new Map([
+        ["Any", 0],
+        ["Field", 1],
+        ["Control", 2]
+    ]);
+
+    static getAllEntries() {
+        return ElementKind.#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 ElementKind.#objectValues[arguments[1]];
+        }
+
+        if (value instanceof ElementKind) {
+            return value;
+        }
+
+        let intVal = ElementKind.#values.get(value);
+
+        // Nullish check, checks for null or undefined
+        if (intVal != null) {
+            return ElementKind.#objectValues[intVal];
+        }
+
+        throw TypeError(value + " is not a ElementKind and does not correspond to any of its enumerator values.");
+    }
+
+    /** @internal */
+    static fromValue(value) {
+        return new ElementKind(value);
+    }
+
+    get value(){
+        return [...ElementKind.#values.keys()][this.#value];
+    }
+
+    /** @internal */
+    get ffiValue(){
+        return this.#value;
+    }
+    static #objectValues = [
+        new ElementKind(diplomatRuntime.internalConstructor, diplomatRuntime.internalConstructor, 0),
+        new ElementKind(diplomatRuntime.internalConstructor, diplomatRuntime.internalConstructor, 1),
+        new ElementKind(diplomatRuntime.internalConstructor, diplomatRuntime.internalConstructor, 2),
+    ];
+
+    /**
+     * Fields and controls.
+     */
+    static Any = ElementKind.#objectValues[0];
+    static Field = ElementKind.#objectValues[1];
+    static Control = ElementKind.#objectValues[2];
+
+
+    constructor(value) {
+        return this.#internalConstructor(...arguments)
+    }
+}

package/dist/ElementList.d.ts

@@ -0,0 +1,20 @@
+// generated by diplomat-tool
+import type { Element } from "./Element"
+import type { pointer, codepoint } from "./diplomat-runtime.d.ts";
+
+
+
+/**
+ * Elements in document order.
+ */
+export class ElementList {
+    /** @internal */
+    get ffiValue(): pointer;
+    /** @internal */
+    constructor();
+
+
+    get len(): number;
+
+    get(index: number): Element | null;
+}

package/dist/ElementList.mjs

@@ -0,0 +1,71 @@
+// generated by diplomat-tool
+import { Element } from "./Element.mjs"
+import wasm from "./diplomat-wasm.mjs";
+import * as diplomatRuntime from "./diplomat-runtime.mjs";
+
+const ElementList_box_destroy_registry = new FinalizationRegistry((ptr) => {
+    wasm.ElementList_destroy(ptr);
+});
+
+/**
+ * Elements in document order.
+ */
+export class ElementList {
+    // 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("ElementList 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) {
+            ElementList_box_destroy_registry.register(this, this.#ptr);
+        }
+
+        return this;
+    }
+    /** @internal */
+    get ffiValue() {
+        return this.#ptr;
+    }
+
+
+    get len() {
+
+        const result = wasm.ElementList_len(this.ffiValue);
+
+        try {
+            return result;
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+        }
+    }
+
+    get(index) {
+
+        const result = wasm.ElementList_get(this.ffiValue, index);
+
+        try {
+            return result === 0 ? null : new Element(diplomatRuntime.internalConstructor, result, []);
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+        }
+    }
+
+    constructor(symbol, ptr, selfEdge) {
+        return this.#internalConstructor(...arguments)
+    }
+}

package/dist/ElementText.d.ts

@@ -0,0 +1,34 @@
+// generated by diplomat-tool
+import type { pointer, codepoint } from "./diplomat-runtime.d.ts";
+
+
+
+/**
+ * Which text of an element to search.
+ */
+export class ElementText {
+
+    /** @internal */
+    static fromValue(value: ElementText | string): ElementText;
+
+    get value(): string;
+
+    /** @internal */
+    get ffiValue(): number;
+
+    /**
+     * Field codes.
+     */
+    static Code : ElementText;
+    /**
+     * Control tags.
+     */
+    static Tag : ElementText;
+    /**
+     * Control titles.
+     */
+    static Alias : ElementText;
+
+
+    constructor(value: ElementText | string );
+}

package/dist/ElementText.mjs

@@ -0,0 +1,84 @@
+// generated by diplomat-tool
+import wasm from "./diplomat-wasm.mjs";
+import * as diplomatRuntime from "./diplomat-runtime.mjs";
+
+
+
+/**
+ * Which text of an element to search.
+ */
+export class ElementText {
+    #value = undefined;
+
+    static #values = new Map([
+        ["Code", 0],
+        ["Tag", 1],
+        ["Alias", 2]
+    ]);
+
+    static getAllEntries() {
+        return ElementText.#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 ElementText.#objectValues[arguments[1]];
+        }
+
+        if (value instanceof ElementText) {
+            return value;
+        }
+
+        let intVal = ElementText.#values.get(value);
+
+        // Nullish check, checks for null or undefined
+        if (intVal != null) {
+            return ElementText.#objectValues[intVal];
+        }
+
+        throw TypeError(value + " is not a ElementText and does not correspond to any of its enumerator values.");
+    }
+
+    /** @internal */
+    static fromValue(value) {
+        return new ElementText(value);
+    }
+
+    get value(){
+        return [...ElementText.#values.keys()][this.#value];
+    }
+
+    /** @internal */
+    get ffiValue(){
+        return this.#value;
+    }
+    static #objectValues = [
+        new ElementText(diplomatRuntime.internalConstructor, diplomatRuntime.internalConstructor, 0),
+        new ElementText(diplomatRuntime.internalConstructor, diplomatRuntime.internalConstructor, 1),
+        new ElementText(diplomatRuntime.internalConstructor, diplomatRuntime.internalConstructor, 2),
+    ];
+
+    /**
+     * Field codes.
+     */
+    static Code = ElementText.#objectValues[0];
+    /**
+     * Control tags.
+     */
+    static Tag = ElementText.#objectValues[1];
+    /**
+     * Control titles.
+     */
+    static Alias = ElementText.#objectValues[2];
+
+
+    constructor(value) {
+        return this.#internalConstructor(...arguments)
+    }
+}