fwtoolkit 0.1.0-alpha.5 → 0.1.0-alpha.7

package/dist/worker.js

@@ -0,0 +1,12 @@
+// @ts-nocheck
+/* allows cross domain web workers */
+/* Taken from https://benohead.com/cross-domain-cross-browser-web-workers/ */
+export const makeWorker = workerUrl => {
+    const a = document.createElement("a");
+    a.href = workerUrl; // turn into absolute URL if needed.
+    const blob = new Blob([`importScripts("${a.href}")`], {
+        type: "application/javascript"
+    }), blobUrl = window.URL.createObjectURL(blob), worker = new Worker(blobUrl);
+    return worker;
+};
+//# sourceMappingURL=worker.js.map

package/dist/worker.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"worker.js","sourceRoot":"","sources":["../src/worker.ts"],"names":[],"mappings":"AAAA,cAAc;AACd,qCAAqC;AACrC,6EAA6E;AAC7E,MAAM,CAAC,MAAM,UAAU,GAAG,SAAS,CAAC,EAAE;IAClC,MAAM,CAAC,GAAG,QAAQ,CAAC,aAAa,CAAC,GAAG,CAAC,CAAA;IACrC,CAAC,CAAC,IAAI,GAAG,SAAS,CAAA,CAAC,oCAAoC;IACvD,MAAM,IAAI,GAAG,IAAI,IAAI,CAAC,CAAC,kBAAkB,CAAC,CAAC,IAAI,IAAI,CAAC,EAAE;QAC9C,IAAI,EAAE,wBAAwB;KACjC,CAAC,EACF,OAAO,GAAG,MAAM,CAAC,GAAG,CAAC,eAAe,CAAC,IAAI,CAAC,EAC1C,MAAM,GAAG,IAAI,MAAM,CAAC,OAAO,CAAC,CAAA;IAChC,OAAO,MAAM,CAAA;AACjB,CAAC,CAAA"}

package/dist/ws.d.ts

@@ -0,0 +1,46 @@
+export declare class WebSocketConnector {
+    constructor({ base, // needs to be specified
+    path, // needs to be specified
+    appLoaded, // required argument
+    anythingToSend, // required argument
+    messagesElement, // element in which to show connection messages
+    initialMessage, resubScribed, // Cleanup when the client connects a second or subsequent time
+    restartMessage, // Too many messages have been lost and we need to restart
+    warningNotAllSent, // Info to show while disconnected WITH unsaved data
+    infoDisconnected, // Info to show while disconnected WITHOUT unsaved data
+    receiveData, failedAuth }: {
+        base?: string;
+        path?: string;
+        appLoaded?: () => boolean;
+        anythingToSend?: () => boolean;
+        messagesElement?: () => boolean;
+        initialMessage?: () => {
+            type: string;
+        };
+        resubScribed?: () => void;
+        restartMessage?: () => {
+            type: string;
+        };
+        warningNotAllSent?: string;
+        infoDisconnected?: string;
+        receiveData?: (_data: any) => void;
+        failedAuth?: () => void;
+    });
+    init(): void;
+    goOffline(): void;
+    goOnline(): void;
+    close(): void;
+    createWSConnection(): void;
+    waitForWS(): Promise<unknown>;
+    onmessage(event: any): void;
+    onclose(): void;
+    open(): void;
+    subscribed(): void;
+    /** Sends data to server or keeps it in a list if currently offline. */
+    send(getData: any, timer?: number): void;
+    setRecentlySentTimer(timer: any): void;
+    resend_messages(from: any): Promise<void>;
+    receive(data: any): void;
+    heartbeat(): void;
+}
+//# sourceMappingURL=ws.d.ts.map

package/dist/ws.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ws.d.ts","sourceRoot":"","sources":["../src/ws.ts"],"names":[],"mappings":"AAGA,qBAAa,kBAAkB;gBACf,EACR,IAAS,EAAE,wBAAwB;IACnC,IAAS,EAAE,wBAAwB;IACnC,SAAuB,EAAE,oBAAoB;IAC7C,cAA4B,EAAE,oBAAoB;IAClD,eAA6B,EAAE,+CAA+C;IAC9E,cAA4C,EAC5C,YAAuB,EAAE,+DAA+D;IACxF,cAA0C,EAAE,0DAA0D;IACtG,iBAA4D,EAAE,oDAAoD;IAClH,gBAAsE,EAAE,uDAAuD;IAC/H,WAAyB,EACzB,UAEC,EACJ;;;;;;;;;;;;;;;;;KAAA;IAiCD,IAAI;IAQJ,SAAS;IAST,QAAQ;IAKR,KAAK;IAQL,kBAAkB;IAiClB,SAAS;IAyBT,SAAS,CAAC,KAAK,KAAA;IAyDf,OAAO;IAoBP,IAAI;IAeJ,UAAU;IASV,uEAAuE;IACvE,IAAI,CAAC,OAAO,KAAA,EAAE,KAAK,SAAK;IAmCxB,oBAAoB,CAAC,KAAK,KAAA;IAa1B,eAAe,CAAC,IAAI,KAAA;IAuBpB,OAAO,CAAC,IAAI,KAAA;IAqBZ,SAAS;CAaZ"}

package/dist/ws.js

@@ -0,0 +1,329 @@
+// @ts-nocheck
+/* Sets up communicating with server (retrieving document, saving, collaboration, etc.).
+ */
+export class WebSocketConnector {
+    constructor({ base = "", // needs to be specified
+    path = "", // needs to be specified
+    appLoaded = () => false, // required argument
+    anythingToSend = () => false, // required argument
+    messagesElement = () => false, // element in which to show connection messages
+    initialMessage = () => ({ type: "subscribe" }), resubScribed = () => { }, // Cleanup when the client connects a second or subsequent time
+    restartMessage = () => ({ type: "restart" }), // Too many messages have been lost and we need to restart
+    warningNotAllSent = gettext("Warning! Some data is unsaved"), // Info to show while disconnected WITH unsaved data
+    infoDisconnected = gettext("Disconnected. Attempting to reconnect..."), // Info to show while disconnected WITHOUT unsaved data
+    receiveData = _data => { }, failedAuth = () => {
+        window.location.href = "/";
+    } }) {
+        this.base = base;
+        this.path = path;
+        this.appLoaded = appLoaded;
+        this.anythingToSend = anythingToSend;
+        this.messagesElement = messagesElement;
+        this.initialMessage = initialMessage;
+        this.resubScribed = resubScribed;
+        this.restartMessage = restartMessage;
+        this.warningNotAllSent = warningNotAllSent;
+        this.infoDisconnected = infoDisconnected;
+        this.receiveData = receiveData;
+        this.failedAuth = failedAuth;
+        /* A list of messages to be sent. Only used when temporarily offline.
+            Messages will be sent when returning back online. */
+        this.messagesToSend = [];
+        /* A list of messages from a previous connection */
+        this.oldMessages = [];
+        this.online = true;
+        this.connected = false;
+        /* Increases when connection has to be reestablished */
+        /* 0 = before first connection. */
+        /* 1 = first connection established, etc. */
+        this.connectionCount = 0;
+        this.recentlySent = false;
+        this.listeners = {};
+        //heartbeat
+        this.pingTimer = false;
+        this.pongTimer = false;
+    }
+    init() {
+        this.createWSConnection();
+        // Close the socket manually for now when the connection is lost. Sometimes the socket isn't closed on disconnection.
+        this.listeners.onOffline = _event => this.ws.close();
+        window.addEventListener("offline", this.listeners.onOffline);
+    }
+    goOffline() {
+        // Simulate offline mode due to lack of ways of doing this in Chrome/Firefox
+        // https://bugzilla.mozilla.org/show_bug.cgi?id=1421357
+        // https://bugs.chromium.org/p/chromium/issues/detail?id=423246
+        this.online = false;
+        this.connected = false;
+        this.ws.close();
+    }
+    goOnline() {
+        // Reconnect from offline mode
+        this.online = true;
+    }
+    close() {
+        if (this.ws) {
+            this.ws.onclose = () => { };
+            this.ws.close();
+        }
+        window.removeEventListener("offline", this.listeners.onOffline);
+    }
+    createWSConnection() {
+        // Messages object used to ensure that data is received in right order.
+        this.messages = {
+            server: 0,
+            client: 0,
+            lastTen: []
+        };
+        let url;
+        if (this.online) {
+            if (this.base.startsWith("/")) {
+                url = this.base + this.path;
+            }
+            else if (location.protocol === "https:") {
+                url = `wss://${this.base}${this.path}`;
+            }
+            else {
+                url = `ws://${this.base}${this.path}`;
+            }
+        }
+        else {
+            if (location.protocol === "https:") {
+                url = "wss://offline";
+            }
+            else {
+                url = "ws://offline";
+            }
+        }
+        if (this.ws) {
+            this.ws.onmessage = () => { };
+            this.ws.onclose = () => { };
+            this.ws.close();
+        }
+        this.ws = new window.WebSocket(url);
+        this.ws.onmessage = event => this.onmessage(event);
+        this.ws.onclose = () => this.onclose();
+    }
+    waitForWS() {
+        return new Promise((resolve, reject) => {
+            const checkState = () => {
+                if (!this.ws) {
+                    // WebSocket doesn't exist
+                    return setTimeout(() => checkState(), 100);
+                }
+                if (this.ws.readyState === this.ws.OPEN) {
+                    // WebSocket is open and ready
+                    return resolve();
+                }
+                else if (this.ws.readyState === this.ws.CONNECTING) {
+                    // WebSocket is still connecting, wait
+                    return setTimeout(() => checkState(), 100);
+                }
+                else {
+                    // WebSocket is in CLOSING or CLOSED state
+                    // We should not try to send on this socket
+                    return reject(new Error("WebSocket is not in OPEN state"));
+                }
+            };
+            checkState();
+        });
+    }
+    onmessage(event) {
+        const data = JSON.parse(event.data);
+        const expectedServer = this.messages.server + 1;
+        if (data.type === "request_resend") {
+            this.resend_messages(data.from);
+        }
+        else if (data.type === "pong") {
+            this.heartbeat();
+        }
+        else if (data.s < expectedServer) {
+            // Receive a message already received at least once. Ignore.
+            return;
+        }
+        else if (data.s > expectedServer) {
+            // Messages from the server have been lost.
+            // Request resend.
+            this.waitForWS()
+                .then(() => this.ws.send(JSON.stringify({
+                type: "request_resend",
+                from: this.messages.server
+            })))
+                .catch(() => {
+                // Connection not ready, we will handle this on reconnection
+            });
+        }
+        else {
+            this.messages.server = expectedServer;
+            if (data.c === this.messages.client) {
+                this.receive(data);
+            }
+            else if (data.c < this.messages.client) {
+                // We have received all server messages, but the server seems
+                // to have missed some of the client's messages. They could
+                // have been sent simultaneously.
+                // The server wins over the client in this case.
+                this.waitForWS().then(() => {
+                    const clientDifference = this.messages.client - data.c;
+                    this.messages.client = data.c;
+                    if (clientDifference > this.messages.lastTen.length) {
+                        // We cannot fix the situation
+                        this.send(this.restartMessage);
+                        return;
+                    }
+                    this.messages["lastTen"]
+                        .slice(0 - clientDifference)
+                        .forEach(data => {
+                        this.messages.client += 1;
+                        data.c = this.messages.client;
+                        data.s = this.messages.server;
+                        this.ws.send(JSON.stringify(data));
+                    });
+                    this.receive(data);
+                });
+            }
+        }
+    }
+    onclose() {
+        this.connected = false;
+        window.setTimeout(() => {
+            this.createWSConnection();
+        }, 2000);
+        if (!this.appLoaded()) {
+            // doc not initiated
+            return;
+        }
+        const messagesElement = this.messagesElement();
+        if (messagesElement) {
+            if (this.anythingToSend()) {
+                messagesElement.innerHTML = `<span class="warn">${this.warningNotAllSent}</span>`;
+            }
+            else {
+                messagesElement.innerHTML = this.infoDisconnected;
+            }
+        }
+    }
+    open() {
+        const messagesElement = this.messagesElement();
+        if (messagesElement) {
+            messagesElement.innerHTML = "";
+        }
+        this.connected = true;
+        const message = this.initialMessage();
+        this.connectionCount++;
+        this.oldMessages = this.messagesToSend;
+        this.messagesToSend = [];
+        this.send(() => message);
+    }
+    subscribed() {
+        if (this.connectionCount > 1) {
+            this.resubScribed();
+        }
+        while (this.oldMessages.length > 0) {
+            this.send(this.oldMessages.shift());
+        }
+    }
+    /** Sends data to server or keeps it in a list if currently offline. */
+    send(getData, timer = 80) {
+        if (this.connected && this.ws.readyState !== this.ws.OPEN) {
+            this.ws.close();
+            return;
+        }
+        if (this.connected && !this.recentlySent) {
+            const data = getData();
+            if (!data) {
+                // message is empty
+                return;
+            }
+            this.messages.client += 1;
+            data.c = this.messages.client;
+            data.s = this.messages.server;
+            this.messages.lastTen.push(data);
+            this.messages.lastTen = this.messages["lastTen"].slice(-10);
+            this.waitForWS()
+                .then(() => {
+                this.ws.send(JSON.stringify(data));
+                this.setRecentlySentTimer(timer);
+            })
+                .catch(() => {
+                // Failed to send - likely WebSocket is not open
+                // Put the message back into the queue
+                this.messages.client -= 1;
+                this.messagesToSend.unshift(getData);
+                // Remove from lastTen to avoid duplicates
+                this.messages.lastTen = this.messages.lastTen.slice(0, -1);
+            });
+        }
+        else {
+            this.messagesToSend.push(getData);
+        }
+    }
+    setRecentlySentTimer(timer) {
+        this.recentlySent = true;
+        window.setTimeout(() => {
+            this.recentlySent = false;
+            const oldMessages = this.messagesToSend;
+            this.messagesToSend = [];
+            while (oldMessages.length > 0) {
+                const getData = oldMessages.shift();
+                this.send(getData, Math.min(timer * 1.2, 10000));
+            }
+        }, timer);
+    }
+    resend_messages(from) {
+        return this.waitForWS()
+            .then(() => {
+            const toSend = this.messages.client - from;
+            this.messages.client = from;
+            if (toSend > this.messages.lastTen.length) {
+                // Too many messages requested. Abort.
+                this.send(this.restartMessage);
+                return;
+            }
+            this.messages.lastTen.slice(0 - toSend).forEach(data => {
+                this.messages.client += 1;
+                data.c = this.messages.client;
+                data.s = this.messages.server;
+                this.ws.send(JSON.stringify(data));
+            });
+        })
+            .catch(() => {
+            // Could not send messages - WebSocket not ready
+            // Will try again when WebSocket is ready
+        });
+    }
+    receive(data) {
+        switch (data.type) {
+            case "redirect":
+                this.base = data.base;
+                break;
+            case "welcome":
+                this.open();
+                break;
+            case "subscribed":
+                this.subscribed();
+                this.heartbeat();
+                break;
+            case "access_denied":
+                this.failedAuth();
+                break;
+            default:
+                this.receiveData(data);
+                break;
+        }
+    }
+    heartbeat() {
+        clearTimeout(this.pingTimer);
+        clearTimeout(this.pongTimer);
+        this.pingTimer = setTimeout(() => {
+            // Don't send ping if WebSocket is not open
+            if (this.ws.readyState === this.ws.OPEN) {
+                this.ws.send('{"type": "ping"}');
+                this.pongTimer = setTimeout(() => {
+                    this.listeners.onOffline();
+                }, 10000);
+            }
+        }, 60000);
+    }
+}
+//# sourceMappingURL=ws.js.map

package/dist/ws.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ws.js","sourceRoot":"","sources":["../src/ws.ts"],"names":[],"mappings":"AAAA,cAAc;AACd;GACG;AACH,MAAM,OAAO,kBAAkB;IAC3B,YAAY,EACR,IAAI,GAAG,EAAE,EAAE,wBAAwB;IACnC,IAAI,GAAG,EAAE,EAAE,wBAAwB;IACnC,SAAS,GAAG,GAAG,EAAE,CAAC,KAAK,EAAE,oBAAoB;IAC7C,cAAc,GAAG,GAAG,EAAE,CAAC,KAAK,EAAE,oBAAoB;IAClD,eAAe,GAAG,GAAG,EAAE,CAAC,KAAK,EAAE,+CAA+C;IAC9E,cAAc,GAAG,GAAG,EAAE,CAAC,CAAC,EAAC,IAAI,EAAE,WAAW,EAAC,CAAC,EAC5C,YAAY,GAAG,GAAG,EAAE,GAAE,CAAC,EAAE,+DAA+D;IACxF,cAAc,GAAG,GAAG,EAAE,CAAC,CAAC,EAAC,IAAI,EAAE,SAAS,EAAC,CAAC,EAAE,0DAA0D;IACtG,iBAAiB,GAAG,OAAO,CAAC,+BAA+B,CAAC,EAAE,oDAAoD;IAClH,gBAAgB,GAAG,OAAO,CAAC,0CAA0C,CAAC,EAAE,uDAAuD;IAC/H,WAAW,GAAG,KAAK,CAAC,EAAE,GAAE,CAAC,EACzB,UAAU,GAAG,GAAG,EAAE;QACd,MAAM,CAAC,QAAQ,CAAC,IAAI,GAAG,GAAG,CAAA;IAC9B,CAAC,EACJ;QACG,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;QAChB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;QAChB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAA;QAC1B,IAAI,CAAC,cAAc,GAAG,cAAc,CAAA;QACpC,IAAI,CAAC,eAAe,GAAG,eAAe,CAAA;QACtC,IAAI,CAAC,cAAc,GAAG,cAAc,CAAA;QACpC,IAAI,CAAC,YAAY,GAAG,YAAY,CAAA;QAChC,IAAI,CAAC,cAAc,GAAG,cAAc,CAAA;QACpC,IAAI,CAAC,iBAAiB,GAAG,iBAAiB,CAAA;QAC1C,IAAI,CAAC,gBAAgB,GAAG,gBAAgB,CAAA;QACxC,IAAI,CAAC,WAAW,GAAG,WAAW,CAAA;QAC9B,IAAI,CAAC,UAAU,GAAG,UAAU,CAAA;QAC5B;gEACwD;QACxD,IAAI,CAAC,cAAc,GAAG,EAAE,CAAA;QACxB,mDAAmD;QACnD,IAAI,CAAC,WAAW,GAAG,EAAE,CAAA;QAErB,IAAI,CAAC,MAAM,GAAG,IAAI,CAAA;QAClB,IAAI,CAAC,SAAS,GAAG,KAAK,CAAA;QACtB,uDAAuD;QACvD,kCAAkC;QAClC,4CAA4C;QAC5C,IAAI,CAAC,eAAe,GAAG,CAAC,CAAA;QACxB,IAAI,CAAC,YAAY,GAAG,KAAK,CAAA;QACzB,IAAI,CAAC,SAAS,GAAG,EAAE,CAAA;QAEnB,WAAW;QACX,IAAI,CAAC,SAAS,GAAG,KAAK,CAAA;QACtB,IAAI,CAAC,SAAS,GAAG,KAAK,CAAA;IAC1B,CAAC;IAED,IAAI;QACA,IAAI,CAAC,kBAAkB,EAAE,CAAA;QAEzB,qHAAqH;QACrH,IAAI,CAAC,SAAS,CAAC,SAAS,GAAG,MAAM,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,KAAK,EAAE,CAAA;QACpD,MAAM,CAAC,gBAAgB,CAAC,SAAS,EAAE,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,CAAA;IAChE,CAAC;IAED,SAAS;QACL,4EAA4E;QAC5E,uDAAuD;QACvD,+DAA+D;QAC/D,IAAI,CAAC,MAAM,GAAG,KAAK,CAAA;QACnB,IAAI,CAAC,SAAS,GAAG,KAAK,CAAA;QACtB,IAAI,CAAC,EAAE,CAAC,KAAK,EAAE,CAAA;IACnB,CAAC;IAED,QAAQ;QACJ,8BAA8B;QAC9B,IAAI,CAAC,MAAM,GAAG,IAAI,CAAA;IACtB,CAAC;IAED,KAAK;QACD,IAAI,IAAI,CAAC,EAAE,EAAE,CAAC;YACV,IAAI,CAAC,EAAE,CAAC,OAAO,GAAG,GAAG,EAAE,GAAE,CAAC,CAAA;YAC1B,IAAI,CAAC,EAAE,CAAC,KAAK,EAAE,CAAA;QACnB,CAAC;QACD,MAAM,CAAC,mBAAmB,CAAC,SAAS,EAAE,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,CAAA;IACnE,CAAC;IAED,kBAAkB;QACd,uEAAuE;QACvE,IAAI,CAAC,QAAQ,GAAG;YACZ,MAAM,EAAE,CAAC;YACT,MAAM,EAAE,CAAC;YACT,OAAO,EAAE,EAAE;SACd,CAAA;QACD,IAAI,GAAG,CAAA;QACP,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YACd,IAAI,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;gBAC5B,GAAG,GAAG,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAA;YAC/B,CAAC;iBAAM,IAAI,QAAQ,CAAC,QAAQ,KAAK,QAAQ,EAAE,CAAC;gBACxC,GAAG,GAAG,SAAS,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,EAAE,CAAA;YAC1C,CAAC;iBAAM,CAAC;gBACJ,GAAG,GAAG,QAAQ,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,EAAE,CAAA;YACzC,CAAC;QACL,CAAC;aAAM,CAAC;YACJ,IAAI,QAAQ,CAAC,QAAQ,KAAK,QAAQ,EAAE,CAAC;gBACjC,GAAG,GAAG,eAAe,CAAA;YACzB,CAAC;iBAAM,CAAC;gBACJ,GAAG,GAAG,cAAc,CAAA;YACxB,CAAC;QACL,CAAC;QACD,IAAI,IAAI,CAAC,EAAE,EAAE,CAAC;YACV,IAAI,CAAC,EAAE,CAAC,SAAS,GAAG,GAAG,EAAE,GAAE,CAAC,CAAA;YAC5B,IAAI,CAAC,EAAE,CAAC,OAAO,GAAG,GAAG,EAAE,GAAE,CAAC,CAAA;YAC1B,IAAI,CAAC,EAAE,CAAC,KAAK,EAAE,CAAA;QACnB,CAAC;QACD,IAAI,CAAC,EAAE,GAAG,IAAI,MAAM,CAAC,SAAS,CAAC,GAAG,CAAC,CAAA;QACnC,IAAI,CAAC,EAAE,CAAC,SAAS,GAAG,KAAK,CAAC,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAA;QAClD,IAAI,CAAC,EAAE,CAAC,OAAO,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,OAAO,EAAE,CAAA;IAC1C,CAAC;IAED,SAAS;QACL,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACnC,MAAM,UAAU,GAAG,GAAG,EAAE;gBACpB,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC;oBACX,0BAA0B;oBAC1B,OAAO,UAAU,CAAC,GAAG,EAAE,CAAC,UAAU,EAAE,EAAE,GAAG,CAAC,CAAA;gBAC9C,CAAC;gBAED,IAAI,IAAI,CAAC,EAAE,CAAC,UAAU,KAAK,IAAI,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC;oBACtC,8BAA8B;oBAC9B,OAAO,OAAO,EAAE,CAAA;gBACpB,CAAC;qBAAM,IAAI,IAAI,CAAC,EAAE,CAAC,UAAU,KAAK,IAAI,CAAC,EAAE,CAAC,UAAU,EAAE,CAAC;oBACnD,sCAAsC;oBACtC,OAAO,UAAU,CAAC,GAAG,EAAE,CAAC,UAAU,EAAE,EAAE,GAAG,CAAC,CAAA;gBAC9C,CAAC;qBAAM,CAAC;oBACJ,0CAA0C;oBAC1C,2CAA2C;oBAC3C,OAAO,MAAM,CAAC,IAAI,KAAK,CAAC,gCAAgC,CAAC,CAAC,CAAA;gBAC9D,CAAC;YACL,CAAC,CAAA;YAED,UAAU,EAAE,CAAA;QAChB,CAAC,CAAC,CAAA;IACN,CAAC;IAED,SAAS,CAAC,KAAK;QACX,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;QACnC,MAAM,cAAc,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAA;QAC/C,IAAI,IAAI,CAAC,IAAI,KAAK,gBAAgB,EAAE,CAAC;YACjC,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QACnC,CAAC;aAAM,IAAI,IAAI,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;YAC9B,IAAI,CAAC,SAAS,EAAE,CAAA;QACpB,CAAC;aAAM,IAAI,IAAI,CAAC,CAAC,GAAG,cAAc,EAAE,CAAC;YACjC,4DAA4D;YAC5D,OAAM;QACV,CAAC;aAAM,IAAI,IAAI,CAAC,CAAC,GAAG,cAAc,EAAE,CAAC;YACjC,2CAA2C;YAC3C,kBAAkB;YAClB,IAAI,CAAC,SAAS,EAAE;iBACX,IAAI,CAAC,GAAG,EAAE,CACP,IAAI,CAAC,EAAE,CAAC,IAAI,CACR,IAAI,CAAC,SAAS,CAAC;gBACX,IAAI,EAAE,gBAAgB;gBACtB,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM;aAC7B,CAAC,CACL,CACJ;iBACA,KAAK,CAAC,GAAG,EAAE;gBACR,4DAA4D;YAChE,CAAC,CAAC,CAAA;QACV,CAAC;aAAM,CAAC;YACJ,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,cAAc,CAAA;YACrC,IAAI,IAAI,CAAC,CAAC,KAAK,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;gBAClC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAA;YACtB,CAAC;iBAAM,IAAI,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;gBACvC,6DAA6D;gBAC7D,2DAA2D;gBAC3D,iCAAiC;gBACjC,gDAAgD;gBAChD,IAAI,CAAC,SAAS,EAAE,CAAC,IAAI,CAAC,GAAG,EAAE;oBACvB,MAAM,gBAAgB,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC,CAAA;oBACtD,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC,CAAA;oBAC7B,IAAI,gBAAgB,GAAG,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;wBAClD,8BAA8B;wBAC9B,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,CAAA;wBAC9B,OAAM;oBACV,CAAC;oBACD,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC;yBACnB,KAAK,CAAC,CAAC,GAAG,gBAAgB,CAAC;yBAC3B,OAAO,CAAC,IAAI,CAAC,EAAE;wBACZ,IAAI,CAAC,QAAQ,CAAC,MAAM,IAAI,CAAC,CAAA;wBACzB,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAA;wBAC7B,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAA;wBAE7B,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAA;oBACtC,CAAC,CAAC,CAAA;oBACN,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAA;gBACtB,CAAC,CAAC,CAAA;YACN,CAAC;QACL,CAAC;IACL,CAAC;IAED,OAAO;QACH,IAAI,CAAC,SAAS,GAAG,KAAK,CAAA;QACtB,MAAM,CAAC,UAAU,CAAC,GAAG,EAAE;YACnB,IAAI,CAAC,kBAAkB,EAAE,CAAA;QAC7B,CAAC,EAAE,IAAI,CAAC,CAAA;QACR,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,EAAE,CAAC;YACpB,oBAAoB;YACpB,OAAM;QACV,CAAC;QAED,MAAM,eAAe,GAAG,IAAI,CAAC,eAAe,EAAE,CAAA;QAC9C,IAAI,eAAe,EAAE,CAAC;YAClB,IAAI,IAAI,CAAC,cAAc,EAAE,EAAE,CAAC;gBACxB,eAAe,CAAC,SAAS,GAAG,sBAAsB,IAAI,CAAC,iBAAiB,SAAS,CAAA;YACrF,CAAC;iBAAM,CAAC;gBACJ,eAAe,CAAC,SAAS,GAAG,IAAI,CAAC,gBAAgB,CAAA;YACrD,CAAC;QACL,CAAC;IACL,CAAC;IAED,IAAI;QACA,MAAM,eAAe,GAAG,IAAI,CAAC,eAAe,EAAE,CAAA;QAC9C,IAAI,eAAe,EAAE,CAAC;YAClB,eAAe,CAAC,SAAS,GAAG,EAAE,CAAA;QAClC,CAAC;QACD,IAAI,CAAC,SAAS,GAAG,IAAI,CAAA;QAErB,MAAM,OAAO,GAAG,IAAI,CAAC,cAAc,EAAE,CAAA;QACrC,IAAI,CAAC,eAAe,EAAE,CAAA;QACtB,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,cAAc,CAAA;QACtC,IAAI,CAAC,cAAc,GAAG,EAAE,CAAA;QAExB,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,CAAA;IAC5B,CAAC;IAED,UAAU;QACN,IAAI,IAAI,CAAC,eAAe,GAAG,CAAC,EAAE,CAAC;YAC3B,IAAI,CAAC,YAAY,EAAE,CAAA;QACvB,CAAC;QACD,OAAO,IAAI,CAAC,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACjC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,KAAK,EAAE,CAAC,CAAA;QACvC,CAAC;IACL,CAAC;IAED,uEAAuE;IACvE,IAAI,CAAC,OAAO,EAAE,KAAK,GAAG,EAAE;QACpB,IAAI,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,EAAE,CAAC,UAAU,KAAK,IAAI,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC;YACxD,IAAI,CAAC,EAAE,CAAC,KAAK,EAAE,CAAA;YACf,OAAM;QACV,CAAC;QACD,IAAI,IAAI,CAAC,SAAS,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC;YACvC,MAAM,IAAI,GAAG,OAAO,EAAE,CAAA;YACtB,IAAI,CAAC,IAAI,EAAE,CAAC;gBACR,mBAAmB;gBACnB,OAAM;YACV,CAAC;YACD,IAAI,CAAC,QAAQ,CAAC,MAAM,IAAI,CAAC,CAAA;YACzB,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAA;YAC7B,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAA;YAC7B,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;YAChC,IAAI,CAAC,QAAQ,CAAC,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAA;YAE3D,IAAI,CAAC,SAAS,EAAE;iBACX,IAAI,CAAC,GAAG,EAAE;gBACP,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAA;gBAClC,IAAI,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAA;YACpC,CAAC,CAAC;iBACD,KAAK,CAAC,GAAG,EAAE;gBACR,gDAAgD;gBAChD,sCAAsC;gBACtC,IAAI,CAAC,QAAQ,CAAC,MAAM,IAAI,CAAC,CAAA;gBACzB,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,OAAO,CAAC,CAAA;gBACpC,0CAA0C;gBAC1C,IAAI,CAAC,QAAQ,CAAC,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAA;YAC9D,CAAC,CAAC,CAAA;QACV,CAAC;aAAM,CAAC;YACJ,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;QACrC,CAAC;IACL,CAAC;IAED,oBAAoB,CAAC,KAAK;QACtB,IAAI,CAAC,YAAY,GAAG,IAAI,CAAA;QACxB,MAAM,CAAC,UAAU,CAAC,GAAG,EAAE;YACnB,IAAI,CAAC,YAAY,GAAG,KAAK,CAAA;YACzB,MAAM,WAAW,GAAG,IAAI,CAAC,cAAc,CAAA;YACvC,IAAI,CAAC,cAAc,GAAG,EAAE,CAAA;YACxB,OAAO,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBAC5B,MAAM,OAAO,GAAG,WAAW,CAAC,KAAK,EAAE,CAAA;gBACnC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,GAAG,CAAC,KAAK,GAAG,GAAG,EAAE,KAAK,CAAC,CAAC,CAAA;YACpD,CAAC;QACL,CAAC,EAAE,KAAK,CAAC,CAAA;IACb,CAAC;IAED,eAAe,CAAC,IAAI;QAChB,OAAO,IAAI,CAAC,SAAS,EAAE;aAClB,IAAI,CAAC,GAAG,EAAE;YACP,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,IAAI,CAAA;YAC1C,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,IAAI,CAAA;YAC3B,IAAI,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;gBACxC,sCAAsC;gBACtC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,CAAA;gBAC9B,OAAM;YACV,CAAC;YACD,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;gBACnD,IAAI,CAAC,QAAQ,CAAC,MAAM,IAAI,CAAC,CAAA;gBACzB,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAA;gBAC7B,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAA;gBAC7B,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAA;YACtC,CAAC,CAAC,CAAA;QACN,CAAC,CAAC;aACD,KAAK,CAAC,GAAG,EAAE;YACR,gDAAgD;YAChD,yCAAyC;QAC7C,CAAC,CAAC,CAAA;IACV,CAAC;IAED,OAAO,CAAC,IAAI;QACR,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;YAChB,KAAK,UAAU;gBACX,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAA;gBACrB,MAAK;YACT,KAAK,SAAS;gBACV,IAAI,CAAC,IAAI,EAAE,CAAA;gBACX,MAAK;YACT,KAAK,YAAY;gBACb,IAAI,CAAC,UAAU,EAAE,CAAA;gBACjB,IAAI,CAAC,SAAS,EAAE,CAAA;gBAChB,MAAK;YACT,KAAK,eAAe;gBAChB,IAAI,CAAC,UAAU,EAAE,CAAA;gBACjB,MAAK;YACT;gBACI,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAA;gBACtB,MAAK;QACb,CAAC;IACL,CAAC;IAED,SAAS;QACL,YAAY,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;QAC5B,YAAY,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;QAC5B,IAAI,CAAC,SAAS,GAAG,UAAU,CAAC,GAAG,EAAE;YAC7B,2CAA2C;YAC3C,IAAI,IAAI,CAAC,EAAE,CAAC,UAAU,KAAK,IAAI,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC;gBACtC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAA;gBAChC,IAAI,CAAC,SAAS,GAAG,UAAU,CAAC,GAAG,EAAE;oBAC7B,IAAI,CAAC,SAAS,CAAC,SAAS,EAAE,CAAA;gBAC9B,CAAC,EAAE,KAAK,CAAC,CAAA;YACb,CAAC;QACL,CAAC,EAAE,KAAK,CAAC,CAAA;IACb,CAAC;CACJ"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "fwtoolkit",
-  "version": "0.1.0-alpha.5",
-  "description": "Fidus Writer Toolkit — reusable utilities, UI helpers and styles for Fidus Writer and other applications",
+  "version": "0.1.0-alpha.7",
+  "description": "Fidus Writer Toolkit — reusable TypeScript utilities, UI helpers and styles for Fidus Writer and other applications",
   "type": "module",
   "license": "LGPL-3.0-or-later",
   "repository": {
@@ -9,18 +9,40 @@
     "url": "https://codeberg.org/fiduswriter/fwtoolkit.git"
   },
   "author": "Johannes Wilm",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
   "files": [
     "src/",
+    "dist/",
     "css/",
     "README.md",
     "LICENSE"
   ],
   "exports": {
-    ".": "./src/index.js",
-    "./*": "./src/*"
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./*": {
+      "types": "./dist/*.d.ts",
+      "default": "./dist/*.js"
+    }
+  },
+  "scripts": {
+    "build": "tsc",
+    "prepublishOnly": "npm run build && npm test",
+    "test": "node --experimental-vm-modules node_modules/jest/bin/jest.js --config jest.config.js"
   },
   "dependencies": {
     "diff-dom": "^5.2.1",
     "w3c-keyname": "^2.2.8"
+  },
+  "devDependencies": {
+    "@fortawesome/fontawesome-free": "^7.2.0",
+    "@types/jest": "^29.5.14",
+    "jest": "^29.7.0",
+    "jest-environment-jsdom": "^29.7.0",
+    "ts-jest": "^29.2.5",
+    "typescript": "^5.8.2"
   }
 }

package/src/{basic.js → basic.ts}

@@ -1,3 +1,4 @@
+// @ts-nocheck
 import {keyName} from "w3c-keyname"
 
 import {ContentMenu} from "./content_menu.js"

package/src/{blob.js → blob.ts}

@@ -1,3 +1,4 @@
+// @ts-nocheck
 export function convertDataURIToBlob(dataURI) {
     const byteString = atob(dataURI.split(",")[1])
     const mimeString = dataURI.split(",")[0].split(":")[1].split(";")[0]

package/src/{content_menu.js → content_menu.ts}

@@ -1,3 +1,4 @@
+// @ts-nocheck
 const menuTemplate = ({
     id,
     classes,
@@ -380,10 +381,10 @@ export class ContentMenu {
                 this.focusMenuItem(this.focusedIndex)
                 break
             case "ArrowLeft":
+                event.preventDefault()
                 if (totalColumns <= 1) {
                     break
                 }
-                event.preventDefault()
                 {
                     const currentCol = Math.floor(
                         this.focusedIndex / itemsPerColumn
@@ -405,10 +406,10 @@ export class ContentMenu {
                 }
                 break
             case "ArrowRight":
+                event.preventDefault()
                 if (totalColumns <= 1) {
                     break
                 }
-                event.preventDefault()
                 {
                     const currentCol = Math.floor(
                         this.focusedIndex / itemsPerColumn

package/src/{datatable_bulk.js → datatable_bulk.ts}

@@ -1,3 +1,4 @@
+// @ts-nocheck
 import {keyName} from "w3c-keyname"
 
 import {whenReady} from "./basic.js"

package/src/{dialog.js → dialog.ts}

@@ -1,3 +1,4 @@
+// @ts-nocheck
 import {keyName} from "w3c-keyname"
 
 import {findTarget} from "./basic.js"

package/src/{events.js → events.ts}

@@ -1,3 +1,4 @@
+// @ts-nocheck
 export const isActivationEvent = event => {
     if (event.type === "click") {
         return true

package/src/{faq_dialog.js → faq_dialog.ts}

@@ -1,3 +1,4 @@
+// @ts-nocheck
 import {escapeText} from "./basic.js"
 import {Dialog} from "./dialog.js"
 import {ensureCSS} from "./network.js"

package/src/file/{dialog.js → dialog.ts}

@@ -1,3 +1,4 @@
+// @ts-nocheck
 import {Dialog} from "../dialog.js"
 import {FileSelector} from "./selector.js"
 import {addAlert} from "../basic.js"

package/src/file/{index.js → index.ts}

@@ -1,3 +1,4 @@
+// @ts-nocheck
 export {FileDialog} from "./dialog.js"
 export {FileSelector} from "./selector.js"
 export {

package/src/file/{new_folder_dialog.js → new_folder_dialog.ts}

@@ -1,3 +1,4 @@
+// @ts-nocheck
 import {Dialog} from "../dialog.js"
 import {newFolderTemplate} from "./templates.js"
 

package/src/file/{selector.js → selector.ts}

@@ -1,3 +1,4 @@
+// @ts-nocheck
 import {escapeText, findTarget} from "../basic.js"
 import {ensureCSS} from "../network.js"
 

package/src/file/{templates.js → templates.ts}

@@ -1,3 +1,4 @@
+// @ts-nocheck
 import {escapeText} from "../index.js"
 
 export const moveTemplate = ({path}) =>

package/src/file/{tools.js → tools.ts}

@@ -1,3 +1,4 @@
+// @ts-nocheck
 import {escapeText} from "../basic.js"
 import {postJson} from "../network.js"
 

package/src/{focus.js → focus.ts}

@@ -1,3 +1,4 @@
+// @ts-nocheck
 // Get the index number of currently focused selement. This it to set tyhe focus close by after doing some dom changes.
 
 export const getFocusIndex = () => {

package/src/global.d.ts

@@ -0,0 +1,11 @@
+// Globals provided by the Fidus Writer host page.
+
+declare const gettext: (msgid: string) => string
+
+declare const staticUrl: (path: string) => string
+
+declare const settings: Record<string, any>
+
+interface Window {
+    settings?: Record<string, any>
+}

package/src/{index.js → index.ts}

@@ -1,3 +1,4 @@
+// @ts-nocheck
 export {OverviewMenuView} from "./overview_menu.js"
 export {
     dropdownSelect,
@@ -41,9 +42,7 @@ export {
 export {Dialog} from "./dialog.js"
 export {ContentMenu} from "./content_menu.js"
 export {makeWorker} from "./worker.js"
-export {baseBodyTemplate} from "./templates.js"
 export {WebSocketConnector} from "./ws.js"
-export {filterPrimaryEmail} from "./user_util.js"
 export {DatatableBulk} from "./datatable_bulk.js"
 export {faqDialog} from "./faq_dialog.js"
 export {

package/src/{network.js → network.ts}

@@ -1,3 +1,4 @@
+// @ts-nocheck
 import {getSettings} from "./settings.js"
 
 /** Get cookie to set as part of the request header of all AJAX requests to the server.

package/src/{overview_menu.js → overview_menu.ts}

@@ -1,3 +1,4 @@
+// @ts-nocheck
 import {DiffDOM} from "diff-dom"
 import {keyName} from "w3c-keyname"
 import {escapeText, whenReady} from "./basic.js"
@@ -588,7 +589,7 @@ export class OverviewMenuView {
                 class="fw-search-field"
                 id="${menuItem.id}-input"
                 aria-description="${gettext("Type to search")}"
-                placeholder="${menuItem.title}"
+                placeholder="${menuItem.placeholder || ""}"
                 aria-label="${menuItem.title}"
                 >
             ${menuItem.icon ? `<i class="fa-solid fa-${menuItem.icon}" aria-hidden="true"></i>` : ""}

package/src/{settings.js → settings.ts}

@@ -1,3 +1,4 @@
+// @ts-nocheck
 let _settings = null
 
 export function initSettings(rawSettings) {

package/src/{user.js → user.ts}

@@ -1,3 +1,4 @@
+// @ts-nocheck
 import {post} from "./network.js"
 
 export const setLanguage = (_config, language) =>

package/src/{worker.js → worker.ts}

@@ -1,3 +1,4 @@
+// @ts-nocheck
 /* allows cross domain web workers */
 /* Taken from https://benohead.com/cross-domain-cross-browser-web-workers/ */
 export const makeWorker = workerUrl => {

package/src/{ws.js → ws.ts}

@@ -1,3 +1,4 @@
+// @ts-nocheck
 /* Sets up communicating with server (retrieving document, saving, collaboration, etc.).
  */
 export class WebSocketConnector {