@kokimoki/app 0.6.9 → 1.0.0

package/dist/kokimoki-client-refactored.js

@@ -0,0 +1,422 @@
+import EventEmitter from "events";
+import { KOKIMOKI_APP_VERSION } from "./version";
+import * as Y from "yjs";
+import { KokimokiTransaction } from "./kokimoki-transaction";
+import { WsMessageType } from "./ws-message-type";
+import { WsMessageWriter } from "./ws-message-writer";
+import { WsMessageReader } from "./ws-message-reader";
+import { RoomSubscriptionMode } from "./room-subscription-mode";
+import { RoomSubscription } from "./room-subscription";
+export class KokimokiClient extends EventEmitter {
+    host;
+    appId;
+    code;
+    _wsUrl;
+    _apiUrl;
+    _id;
+    _token;
+    _apiHeaders;
+    _serverTimeOffset = 0;
+    _clientContext;
+    _ws;
+    _subscriptionsByName = new Map();
+    _subscriptionsByHash = new Map();
+    _subscribeReqPromises = new Map();
+    _transactionPromises = new Map();
+    _connected = false;
+    _connectPromise;
+    _messageId = 0;
+    _reconnectTimeout = 0;
+    constructor(host, appId, code = "") {
+        super();
+        this.host = host;
+        this.appId = appId;
+        this.code = code;
+        // Set up the URLs
+        const secure = this.host.indexOf(":") === -1;
+        this._wsUrl = `ws${secure ? "s" : ""}://${this.host}`;
+        this._apiUrl = `http${secure ? "s" : ""}://${this.host}`;
+    }
+    get id() {
+        if (!this._id) {
+            throw new Error("Client not connected");
+        }
+        return this._id;
+    }
+    get token() {
+        if (!this._token) {
+            throw new Error("Client not connected");
+        }
+        return this._token;
+    }
+    get apiUrl() {
+        if (!this._apiUrl) {
+            throw new Error("Client not connected");
+        }
+        return this._apiUrl;
+    }
+    get apiHeaders() {
+        if (!this._apiHeaders) {
+            throw new Error("Client not connected");
+        }
+        return this._apiHeaders;
+    }
+    get clientContext() {
+        if (this._clientContext === undefined) {
+            throw new Error("Client not connected");
+        }
+        return this._clientContext;
+    }
+    get connected() {
+        return this._connected;
+    }
+    get ws() {
+        if (!this._ws) {
+            throw new Error("Not connected");
+        }
+        return this._ws;
+    }
+    async connect() {
+        if (this._connectPromise) {
+            return await this._connectPromise;
+        }
+        this._ws = new WebSocket(`${this._wsUrl}/apps/${this.appId}?clientVersion=${KOKIMOKI_APP_VERSION}`);
+        this._ws.binaryType = "arraybuffer";
+        // Close previous connection in hot-reload scenarios
+        if (window) {
+            if (!window.__KOKIMOKI_WS__) {
+                window.__KOKIMOKI_WS__ = {};
+            }
+            if (this.appId in window.__KOKIMOKI_WS__) {
+                window.__KOKIMOKI_WS__[this.appId].close();
+            }
+            window.__KOKIMOKI_WS__[this.appId] = this._ws;
+        }
+        // Wait for connection
+        this._connectPromise = new Promise((onInit) => {
+            // Fetch the auth token
+            let clientToken = localStorage.getItem("KM_TOKEN");
+            // Send the app token on first connect
+            this.ws.onopen = () => {
+                this.ws.send(JSON.stringify({ type: "auth", code: this.code, token: clientToken }));
+            };
+            this.ws.onclose = () => {
+                this._connected = false;
+                this._connectPromise = undefined;
+                this._ws = undefined;
+                if (window && window.__KOKIMOKI_WS__) {
+                    delete window.__KOKIMOKI_WS__[this.appId];
+                }
+                // Clean up
+                this._subscribeReqPromises.clear();
+                this._transactionPromises.clear();
+                // Attempt to reconnect
+                console.log(`[Kokimoki] Connection lost, attempting to reconnect in ${this._reconnectTimeout} seconds...`);
+                setTimeout(async () => await this.connect(), this._reconnectTimeout * 1000);
+                this._reconnectTimeout = Math.min(3, this._reconnectTimeout + 1);
+                // Emit disconnected event
+                this.emit("disconnected");
+            };
+            this.ws.onmessage = (e) => {
+                console.log(`Received WS message: ${e.data}`);
+                // Handle JSON messages
+                if (typeof e.data === "string") {
+                    const message = JSON.parse(e.data);
+                    switch (message.type) {
+                        case "serverTime": {
+                            this._serverTimeOffset = Date.now() - message.serverTime;
+                            console.log(`Server time offset: ${this._serverTimeOffset}`);
+                            break;
+                        }
+                        case "init":
+                            this.handleInitMessage(message);
+                            onInit();
+                            break;
+                    }
+                    return;
+                }
+                // Handle binary messages
+                this.handleBinaryMessage(e.data);
+            };
+        });
+        await this._connectPromise;
+        this._connected = true;
+        // Connection established
+        console.log(`[Kokimoki] Client id: ${this.id}`);
+        console.log(`[Kokimoki] Client context:`, this.clientContext);
+        // Restore subscriptions if reconnected
+        const roomNames = Array.from(this._subscriptionsByName.keys()).map((name) => `"${name}"`);
+        if (roomNames.length) {
+            console.log(`[Kokimoki] Restoring subscriptions: ${roomNames}`);
+        }
+        for (const subscription of this._subscriptionsByName.values()) {
+            try {
+                await this.join(subscription.store);
+            }
+            catch (err) {
+                console.error(`[Kokimoki] Failed to restore subscription for "${subscription.roomName}":`, err);
+            }
+        }
+        // Emit connected event
+        this._reconnectTimeout = 0;
+        this.emit("connected");
+    }
+    handleInitMessage(message) {
+        localStorage.setItem("KM_TOKEN", message.clientToken);
+        this._id = message.clientId;
+        this._token = message.appToken;
+        this._clientContext = message.clientContext;
+        // Set up the auth headers
+        this._apiHeaders = new Headers({
+            Authorization: `Bearer ${this.token}`,
+            "Content-Type": "application/json",
+        });
+    }
+    handleBinaryMessage(data) {
+        const reader = new WsMessageReader(data);
+        const type = reader.readInt32();
+        switch (type) {
+            case WsMessageType.SubscribeRes:
+                this.handleSubscribeResMessage(reader);
+                break;
+            case WsMessageType.RoomUpdate:
+                this.handleRoomUpdateMessage(reader);
+                break;
+            case WsMessageType.Error:
+                this.handleErrorMessage(reader);
+                break;
+        }
+    }
+    handleErrorMessage(msg) {
+        const reqId = msg.readInt32();
+        const error = msg.readString();
+        const subscribeReqPromise = this._subscribeReqPromises.get(reqId);
+        const transactionPromise = this._transactionPromises.get(reqId);
+        if (subscribeReqPromise) {
+            this._subscribeReqPromises.delete(reqId);
+            subscribeReqPromise.reject(error);
+        }
+        else if (transactionPromise) {
+            this._transactionPromises.delete(reqId);
+            transactionPromise.reject(error);
+        }
+        else {
+            console.warn(`Received error for unknown request ${reqId}: ${error}`);
+        }
+    }
+    handleSubscribeResMessage(msg) {
+        const reqId = msg.readInt32();
+        const roomHash = msg.readUint32();
+        const promise = this._subscribeReqPromises.get(reqId);
+        if (promise) {
+            this._subscribeReqPromises.delete(reqId);
+            // In Write mode, no initial state is sent
+            if (!msg.end) {
+                promise.resolve(roomHash, msg.readUint8Array());
+            }
+            else {
+                promise.resolve(roomHash);
+            }
+        }
+    }
+    handleRoomUpdateMessage(msg) {
+        const appliedId = msg.readInt32();
+        const roomHash = msg.readUint32();
+        // Apply update if not in Write mode
+        if (!msg.end) {
+            const subscription = this._subscriptionsByHash.get(roomHash);
+            if (subscription) {
+                Y.applyUpdate(subscription.store.doc, msg.readUint8Array(), this);
+            }
+            else {
+                console.warn(`Received update for unknown room ${roomHash}`);
+            }
+        }
+        // Check transaction resolves
+        for (const [transactionId, { resolve },] of this._transactionPromises.entries()) {
+            if (appliedId >= transactionId) {
+                this._transactionPromises.delete(transactionId);
+                resolve();
+            }
+        }
+    }
+    serverTimestamp() {
+        return Date.now() - this._serverTimeOffset;
+    }
+    // Send Y update to room
+    async patchRoomState(room, update) {
+        const res = await fetch(`${this._apiUrl}/rooms/${room}`, {
+            method: "PATCH",
+            headers: this.apiHeaders,
+            body: update,
+        });
+        return await res.json();
+    }
+    // Storage
+    async createUpload(name, blob, tags) {
+        const res = await fetch(`${this._apiUrl}/uploads`, {
+            method: "POST",
+            headers: this.apiHeaders,
+            body: JSON.stringify({
+                name,
+                size: blob.size,
+                mimeType: blob.type,
+                tags,
+            }),
+        });
+        return await res.json();
+    }
+    async uploadChunks(blob, chunkSize, signedUrls) {
+        return await Promise.all(signedUrls.map(async (url, index) => {
+            const start = index * chunkSize;
+            const end = Math.min(start + chunkSize, blob.size);
+            const chunk = blob.slice(start, end);
+            const res = await fetch(url, { method: "PUT", body: chunk });
+            return JSON.parse(res.headers.get("ETag") || '""');
+        }));
+    }
+    async completeUpload(id, etags) {
+        const res = await fetch(`${this._apiUrl}/uploads/${id}`, {
+            method: "PUT",
+            headers: this.apiHeaders,
+            body: JSON.stringify({ etags }),
+        });
+        return await res.json();
+    }
+    async upload(name, blob, tags = []) {
+        const { id, chunkSize, urls } = await this.createUpload(name, blob, tags);
+        const etags = await this.uploadChunks(blob, chunkSize, urls);
+        return await this.completeUpload(id, etags);
+    }
+    async updateUpload(id, update) {
+        const res = await fetch(`${this._apiUrl}/uploads/${id}`, {
+            method: "PUT",
+            headers: this.apiHeaders,
+            body: JSON.stringify(update),
+        });
+        return await res.json();
+    }
+    async listUploads(filter = {}, skip = 0, limit = 100) {
+        const url = new URL("/uploads", this._apiUrl);
+        url.searchParams.set("skip", skip.toString());
+        url.searchParams.set("limit", limit.toString());
+        if (filter.clientId) {
+            url.searchParams.set("clientId", filter.clientId);
+        }
+        if (filter.mimeTypes) {
+            url.searchParams.set("mimeTypes", filter.mimeTypes.join());
+        }
+        if (filter.tags) {
+            url.searchParams.set("tags", filter.tags.join());
+        }
+        const res = await fetch(url.href, {
+            headers: this.apiHeaders,
+        });
+        return await res.json();
+    }
+    async deleteUpload(id) {
+        const res = await fetch(`${this._apiUrl}/uploads/${id}`, {
+            method: "DELETE",
+            headers: this.apiHeaders,
+        });
+        return await res.json();
+    }
+    async exposeScriptingContext(context) {
+        // @ts-ignore
+        window.KM_SCRIPTING_CONTEXT = context;
+        // @ts-ignore
+        window.dispatchEvent(new CustomEvent("km:scriptingContextExposed"));
+    }
+    async sendSubscriptionReq(roomName, mode) {
+        // Set up sync resolver
+        const reqId = ++this._messageId;
+        return await new Promise((resolve, reject) => {
+            this._subscribeReqPromises.set(reqId, {
+                resolve: (roomHash, initialUpdate) => {
+                    resolve({ roomHash, initialUpdate });
+                },
+                reject,
+            });
+            // Send subscription request
+            const msg = new WsMessageWriter();
+            msg.writeInt32(WsMessageType.SubscribeReq);
+            msg.writeInt32(reqId);
+            msg.writeString(roomName);
+            msg.writeChar(mode);
+            this.ws.send(msg.getBuffer());
+        });
+    }
+    async join(store, mode = RoomSubscriptionMode.ReadWrite) {
+        let subscription = this._subscriptionsByName.get(store.roomName);
+        if (!subscription) {
+            subscription = new RoomSubscription(this, store, mode);
+            this._subscriptionsByName.set(store.roomName, subscription);
+        }
+        // Send subscription request if connected to server
+        if (!subscription.joined) {
+            const res = await this.sendSubscriptionReq(store.roomName, mode);
+            this._subscriptionsByHash.set(res.roomHash, subscription);
+            await subscription.applyInitialResponse(res.roomHash, res.initialUpdate);
+        }
+    }
+    async transact(handler) {
+        if (!this._connected) {
+            throw new Error("Client not connected");
+        }
+        const transaction = new KokimokiTransaction(this);
+        handler(transaction);
+        const { updates, consumedMessages } = await transaction.getUpdates();
+        if (!updates.length) {
+            return;
+        }
+        // Construct buffer
+        const writer = new WsMessageWriter();
+        // Write message type
+        writer.writeInt32(WsMessageType.Transaction);
+        // Update and write transaction ID
+        const transactionId = ++this._messageId;
+        writer.writeInt32(transactionId);
+        // Write room hashes where messages were consumed
+        writer.writeInt32(consumedMessages.size);
+        for (const roomName of consumedMessages) {
+            const subscription = this._subscriptionsByName.get(roomName);
+            if (!subscription) {
+                throw new Error(`Cannot consume message in "${roomName}" because it hasn't been joined`);
+            }
+            writer.writeUint32(subscription.roomHash);
+        }
+        // Write updates
+        for (const { roomName, update } of updates) {
+            const subscription = this._subscriptionsByName.get(roomName);
+            if (!subscription) {
+                throw new Error(`Cannot send update to "${roomName}" because it hasn't been joined`);
+            }
+            writer.writeUint32(subscription.roomHash);
+            writer.writeUint8Array(update);
+        }
+        const buffer = writer.getBuffer();
+        // Wait for server to apply transaction
+        await new Promise((resolve, reject) => {
+            this._transactionPromises.set(transactionId, { resolve, reject });
+            // Send update to server
+            try {
+                this.ws.send(buffer);
+            }
+            catch (e) {
+                // Not connected
+                console.log("Failed to send update to server:", e);
+                // TODO: merge updates or something
+                throw e;
+            }
+        });
+        /* // Reset doc in Write-only mode
+        for (const { roomName, update } of updates) {
+          const mode = this._subscriptions.get(roomName);
+    
+          if (mode === RoomSubscriptionMode.Write) {
+            // @ts-ignore
+            // this._stores.get(this._roomHashes.get(roomName)!)!.doc = new Y.Doc();
+          }
+        } */
+    }
+}

package/dist/kokimoki-client.d.ts

@@ -1,12 +1,12 @@
-import { HocuspocusProvider } from "@hocuspocus/provider";
 import type TypedEmitter from "typed-emitter";
-import type { SyncedStore } from "./synced-store";
-import type { DocTypeDescription } from "@syncedstore/core/types/doc";
 import type { KokimokiClientEvents } from "./types/events";
 import type { Upload } from "./types/upload";
 import type { Paginated } from "./types/common";
-declare const KokimokiClient_base: new <T>() => TypedEmitter<KokimokiClientEvents<T>>;
-export declare class KokimokiClient<StatelessDataT = any, ClientContextT = any> extends KokimokiClient_base<StatelessDataT> {
+import { KokimokiTransaction } from "./kokimoki-transaction";
+import type { KokimokiStore } from "./kokimoki-store";
+import type { KokimokiSchema as S } from "./kokimoki-schema";
+declare const KokimokiClient_base: new () => TypedEmitter<KokimokiClientEvents>;
+export declare class KokimokiClient<ClientContextT = any> extends KokimokiClient_base {
     readonly host: string;
     readonly appId: string;
     readonly code: string;
@@ -15,26 +15,34 @@ export declare class KokimokiClient<StatelessDataT = any, ClientContextT = any>
     private _id?;
     private _token?;
     private _apiHeaders?;
-    private _providers;
     private _serverTimeOffset;
     private _clientContext?;
+    private _ws?;
+    private _subscriptionsByName;
+    private _subscriptionsByHash;
+    private _subscribeReqPromises;
+    private _transactionPromises;
     private _connected;
-    private _lastPongAt;
+    private _connectPromise?;
+    private _messageId;
+    private _reconnectTimeout;
+    private _pingInterval;
     constructor(host: string, appId: string, code?: string);
     get id(): string;
     get token(): string;
     get apiUrl(): string;
     get apiHeaders(): Headers;
     get clientContext(): ClientContextT & ({} | null);
+    get connected(): boolean;
+    get ws(): WebSocket;
     connect(): Promise<void>;
+    private handleInitMessage;
+    private handleBinaryMessage;
+    private handleErrorMessage;
+    private handleSubscribeResMessage;
+    private handleRoomUpdateMessage;
     serverTimestamp(): number;
-    private receivePong;
-    private checkConnectionState;
-    setProvider<T extends DocTypeDescription>(name: string, store: SyncedStore<T>): Promise<void>;
-    removeProvider(name: string): void;
-    getProvider(name: string): HocuspocusProvider | undefined;
-    sendStatelessToClient(room: string, clientId: string, data: StatelessDataT): void;
-    sendStatelessToRoom(room: string, data: StatelessDataT, self?: boolean): void;
+    patchRoomState(room: string, update: Uint8Array): Promise<any>;
     private createUpload;
     private uploadChunks;
     private completeUpload;
@@ -52,5 +60,8 @@ export declare class KokimokiClient<StatelessDataT = any, ClientContextT = any>
         deletedCount: number;
     }>;
     exposeScriptingContext(context: any): Promise<void>;
+    private sendSubscriptionReq;
+    join<T extends S.Generic<unknown>>(store: KokimokiStore<T>): Promise<void>;
+    transact(handler: (t: KokimokiTransaction) => void): Promise<void>;
 }
 export {};