cosveti-sync 0.0.1

package/dist/tiptap/syncExtension.js

@@ -0,0 +1,126 @@
+import { Extension } from '@tiptap/core';
+import * as collab from '@tiptap/pm/collab';
+import { Step } from '@tiptap/pm/transform';
+import { doSync } from './doSync.js';
+import { SNAPSHOT_DEBOUNCE_MS } from './index.js';
+import { get } from 'svelte/store';
+export function syncExtension(convex, id, syncApi, initialState, opts, isSyncEnabled) {
+    const log = opts?.debug ? console.debug : () => { };
+    let snapshotTimer;
+    const trySubmitSnapshot = (version, content) => {
+        if (snapshotTimer) {
+            clearTimeout(snapshotTimer);
+        }
+        snapshotTimer = setTimeout(() => {
+            void convex
+                .mutation(syncApi.submitSnapshot, { id, version, content })
+                .catch(opts?.onSyncError); // Changed to string
+        }, opts?.snapshotDebounceMs ?? SNAPSHOT_DEBOUNCE_MS);
+    };
+    let active = false;
+    let pending;
+    // let watch: Watch<number | null> | undefined; // REACT CODE
+    let serverVersion = undefined;
+    let unsubscribe; // Changed to use onUpdate from convex/browser instead of convex/react
+    async function trySync(editor) {
+        // console.log('Called trySync');
+        if (serverVersion === undefined) {
+            return;
+        }
+        if (serverVersion && serverVersion > collab.getVersion(editor.state)) {
+            clearTimeout(snapshotTimer);
+            snapshotTimer = undefined;
+        }
+        if (active) {
+            if (!pending) {
+                let resolve = () => { };
+                let reject = () => { };
+                const promise = new Promise((res, rej) => {
+                    resolve = res;
+                    reject = rej;
+                });
+                pending = { resolve, reject, promise };
+            }
+            return pending.promise;
+        }
+        active = true;
+        try {
+            if (await doSync(editor, convex, syncApi, id, serverVersion, initialState, opts?.debug)) {
+                const version = collab.getVersion(editor.state);
+                const content = JSON.stringify(editor.state.doc.toJSON());
+                localStorage.setItem(`convex-sync-${id}`, JSON.stringify({
+                    content: editor.getJSON(),
+                    version: collab.getVersion(editor.state)
+                }));
+                if (collab.sendableSteps(editor.state)) {
+                    throw new Error('Synced but still have sendable steps');
+                }
+                trySubmitSnapshot(version, content);
+            }
+        }
+        catch (error) {
+            if (opts?.onSyncError) {
+                opts.onSyncError(error);
+            }
+            else {
+                throw error;
+            }
+        }
+        finally {
+            active = false;
+            if (pending) {
+                const { resolve, reject } = pending;
+                pending = undefined;
+                trySync(editor).then(resolve, reject);
+            }
+        }
+    }
+    return Extension.create({
+        name: 'convex-sync',
+        onDestroy() {
+            log('destroying');
+            unsubscribe?.();
+        },
+        onCreate() {
+            if (initialState.restoredSteps?.length) {
+                // TODO: verify that restoring local steps works
+                console.log('Restoring local steps', initialState.restoredSteps);
+                const tr = this.editor.state.tr;
+                for (const step of initialState.restoredSteps) {
+                    tr.step(Step.fromJSON(this.editor.schema, step));
+                }
+                this.editor.view.dispatch(tr);
+            }
+            unsubscribe = convex.onUpdate(syncApi.latestVersion, { id }, (newVersion) => {
+                // 🔑 CRITICAL: Skip *processing* updates when sync is OFF
+                // Subscription remains ACTIVE (Convex still tracks changes)
+                if (isSyncEnabled && get(isSyncEnabled) == false) {
+                    console.log('Sync paused: Ignoring incoming version update (still tracking)');
+                    return;
+                }
+                console.log('New version received.');
+                serverVersion = newVersion;
+                void trySync(this.editor);
+            }, opts?.onSyncError);
+            // void trySync(this.editor);
+        },
+        onUpdate() {
+            // 🔑 SKIP MUTATION IF SYNC IS OFF (zero impact on incoming updates)
+            if (isSyncEnabled && get(isSyncEnabled) == false) {
+                console.log('Sync enabled: ' + get(isSyncEnabled));
+                return; // <-- Single-line guard
+            }
+            void trySync(this.editor);
+        },
+        addProseMirrorPlugins() {
+            log('Adding collab plugin', {
+                version: initialState.initialVersion
+            });
+            return [
+                collab.collab({
+                    version: initialState.initialVersion
+                })
+            ];
+        }
+    });
+}

package/dist/tiptap/types.d.ts

@@ -0,0 +1,19 @@
+import type { Content } from '@tiptap/core';
+import type { SyncApi } from '../client/index.js';
+import type { ConvexClient } from 'convex/browser';
+export type UseSyncOptions = {
+    onSyncError?: (error: Error) => void;
+    snapshotDebounceMs?: number;
+    debug?: boolean;
+};
+export type InitialState = {
+    initialContent: Content | null;
+    initialVersion?: number;
+    restoredSteps?: object[];
+};
+export type SyncContext = {
+    convex: ConvexClient;
+    id: string;
+    syncApi: SyncApi;
+    opts?: UseSyncOptions;
+};

package/dist/tiptap/types.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -0,0 +1,81 @@
+{
+	"name": "cosveti-sync",
+	"description": "A convex component for syncing tiptap in a svelte project",
+	"version": "0.0.1",
+	"scripts": {
+		"dev": "vite dev",
+		"build": "vite build && npm run prepack",
+		"preview": "vite preview",
+		"prepare": "svelte-kit sync || echo ''",
+		"prepack": "svelte-kit sync && svelte-package && publint",
+		"check": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json",
+		"check:watch": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json --watch",
+		"lint": "prettier --check . && eslint .",
+		"test:unit": "vitest",
+		"test": "npm run test:unit -- --run",
+		"format": "prettier --write ."
+	},
+	"files": [
+		"dist",
+		"!dist/**/*.test.*",
+		"!dist/**/*.spec.*"
+	],
+	"sideEffects": [
+		"**/*.css"
+	],
+	"svelte": "./dist/index.js",
+	"types": "./dist/index.d.ts",
+	"type": "module",
+	"exports": {
+		".": {
+			"types": "./dist/index.d.ts",
+			"svelte": "./dist/index.js"
+		}
+	},
+	"peerDependencies": {
+		"@tiptap/pm": "^3.18.0",
+		"@tiptap/core": "^3.18.0",
+		"convex": "^1.10.0",
+		"svelte": "^5.0.0"
+	},
+	"devDependencies": {
+		"convex-svelte": "^0.0.12",
+		"@eslint/compat": "^2.0.1",
+		"@eslint/js": "^9.39.2",
+		"@sveltejs/adapter-auto": "^7.0.0",
+		"@sveltejs/kit": "^2.50.1",
+		"@sveltejs/package": "^2.5.7",
+		"@sveltejs/vite-plugin-svelte": "^6.2.4",
+		"@types/node": "^22",
+		"@vitest/browser-playwright": "^4.0.18",
+		"eslint": "^9.39.2",
+		"eslint-config-prettier": "^10.1.8",
+		"eslint-plugin-svelte": "^3.14.0",
+		"globals": "^17.1.0",
+		"playwright": "^1.58.0",
+		"prettier": "^3.8.1",
+		"prettier-plugin-svelte": "^3.4.1",
+		"publint": "^0.3.17",
+		"svelte": "^5.48.2",
+		"svelte-check": "^4.3.5",
+		"typescript": "^5.9.3",
+		"typescript-eslint": "^8.53.1",
+		"vite": "^7.3.1",
+		"vitest": "^4.0.18",
+		"vitest-browser-svelte": "^2.0.2"
+	},
+	"keywords": [
+		"svelte",
+		"tiptap",
+		"convex",
+		"collab",
+		"prosemirror",
+		"sync",
+		"editor"
+	],
+	"dependencies": {
+		"@tiptap/extension-bubble-menu": "^3.18.0",
+		"@tiptap/starter-kit": "^3.18.0"
+	},
+	"license": "Apache-2.0"
+}