cosveti-sync 0.0.1

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2024 Convex, Inc.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,272 @@
+# cosveti-sync
+
+Real-time collaborative editing for TipTap in Svelte with Convex synchronization
+
+## Features
+
+- Real-time synchronization for TipTap editors across multiple clients
+- Convex-powered backend for reliable data synchronization
+- Optimistic updates for smooth user experience
+- Client-side caching with localStorage fallback
+- Configurable sync options and error handling
+- Easy integration with SvelteKit projects
+- Support for pausing/resuming synchronization
+- Prosemirror collab protocol implementation
+
+## Installation
+
+Install the package using your preferred package manager:
+
+```bash
+# npm
+npm install cosveti-sync
+
+# yarn
+yarn add cosveti-sync
+
+# pnpm
+pnpm add cosveti-sync
+```
+
+This package has the following peer dependencies that you'll also need to install:
+- `@tiptap/pm` (v3.18.0+)
+- `@tiptap/core` (v3.18.0+)
+- `convex` (v1.10.0+)
+- `svelte` (v5.0.0+)
+
+## Basic Setup
+
+### 1. Convex Backend Configuration
+
+First, set up the backend API in your Convex project. Create a file like `convex/tiptapSync.ts`:
+
+```typescript
+import { TiptapSyncSvelte } from 'cosveti-sync';
+import { defineComponent } from './_generated/server';
+import { api } from './_generated/api';
+
+// Initialize the component
+const tiptapSyncComponent = defineComponent('./component');
+
+// Create the sync instance
+const tiptapSyncSvelte = new TiptapSyncSvelte(tiptapSyncComponent);
+
+// Export the sync API with optional permission checks
+export const {
+  getSnapshot,
+  submitSnapshot,
+  latestVersion,
+  getSteps,
+  submitSteps
+} = tiptapSyncSvelte.syncApi({
+  // Optional: Add read/write permission checks
+  checkRead: async (ctx, id) => {
+    // Add your authorization logic here
+  },
+  checkWrite: async (ctx, id) => {
+    // Add your authorization logic here
+  },
+  // Optional: Callback when a new snapshot is available
+  onSnapshot: async (ctx, id, snapshot, version) => {
+    // Do something when a new snapshot is saved
+  }
+});
+
+// Export the API for the client to use
+export default {
+  tiptapSyncSvelte
+};
+```
+
+### 2. Client-Side Usage
+
+In your Svelte component, use the `useTiptapSync` hook:
+
+```svelte
+<script lang="ts">
+  import { useTiptapSync } from 'cosveti-sync';
+  import { api } from '$convex/_generated/api';
+  import { useConvexClient } from 'convex-svelte';
+  import { Editor } from '@tiptap/core';
+  import { StarterKit } from '@tiptap/starter-kit';
+  import { onMount } from 'svelte';
+
+  // Get the Convex client (assuming convex-svelte is set up)
+  const convex = useConvexClient();
+
+  // Initialize the sync functionality
+  const { isSyncEnabled, extension, isLoading, initialContent, create } = $derived(
+    useTiptapSync(
+      convex,
+      api.tiptapSyncSvelte,
+      'your-document-id', // Unique document ID
+      {
+        onSyncError: (error) => {
+          console.error('Sync error:', error);
+        },
+        snapshotDebounceMs: 1000, // Debounce snapshot submissions (default: 1000ms)
+        debug: false // Enable debug logging (default: false)
+      }
+    )
+  );
+
+  let editorContainer: HTMLElement;
+  let editor: Editor;
+
+  onMount(() => {
+    if (!$extension) return;
+
+    editor = new Editor({
+      element: editorContainer,
+      extensions: [
+        StarterKit,
+        $extension // Add the sync extension from useTiptapSync
+      ],
+      content: $initialContent
+    });
+  });
+
+  function handleCreateDocument() {
+    create({
+      type: 'doc',
+      content: [
+        { type: 'paragraph', content: [{ type: 'text', text: 'Hello world!' }] }
+      ]
+    });
+  }
+</script>
+
+{#if $isLoading}
+  <div>Loading editor...</div>
+{:else if !$initialContent}
+  <button on:click={handleCreateDocument}>
+    Create New Document
+  </button>
+{:else if $extension}
+  <div>
+    <button
+      on:click={() => $isSyncEnabled.update(n => !n)}
+    >
+      {$isSyncEnabled ? 'Pause Sync' : 'Resume Sync'}
+    </button>
+    <div bind:this={editorContainer}></div>
+  </div>
+{/if}
+```
+
+## API Documentation
+
+### `useTiptapSync()`
+
+The main hook for enabling real-time synchronization.
+
+#### Parameters
+
+- `convex`: Convex client instance
+- `syncApi`: The sync API object from your Convex backend
+- `id`: Unique identifier for the document
+- `opts` (optional): Options object with the following properties:
+  - `onSyncError`: Callback function for handling synchronization errors
+  - `snapshotDebounceMs`: Debounce time for snapshot submissions (default: 1000ms)
+  - `debug`: Enable debug logging (default: false)
+
+#### Returns
+
+- `isSyncEnabled`: Svelte store for controlling sync enable/disable state
+- `isLoading`: Svelte store indicating if the initial content is loading
+- `initialContent`: Svelte store with the initial document content
+- `extension`: TipTap extension to add to your editor
+- `create`: Function to create a new document with initial content
+
+## Configuration Options
+
+### Sync Options
+
+| Option | Type | Default | Description |
+|--------|------|---------|-------------|
+| `onSyncError` | `(error: Error) => void` | `undefined` | Callback for handling synchronization errors |
+| `snapshotDebounceMs` | `number` | `1000` | Debounce time in milliseconds for submitting snapshots |
+| `debug` | `boolean` | `false` | Enable debug logging to console |
+
+### Backend API Options
+
+When creating the sync API in Convex, you can configure:
+
+- `checkRead`: Function to check read permissions
+- `checkWrite`: Function to check write permissions
+- `onSnapshot`: Callback when new snapshots are available
+- `pruneSnapshots`: Whether to prune old snapshots (default: true)
+
+## Example Usage in Svelte
+
+Here's a complete example showing how to integrate the library:
+
+```svelte
+<script lang="ts">
+  import { useTiptapSync } from 'cosveti-sync';
+  import { api } from '$convex/_generated/api';
+  import { useConvexClient } from 'convex-svelte';
+  import { Editor } from '@tiptap/core';
+  import { StarterKit } from '@tiptap/starter-kit';
+  import { onMount, onDestroy } from 'svelte';
+
+  const convex = useConvexClient();
+  const documentId = 'my-shared-document';
+
+  const {
+    isSyncEnabled,
+    extension,
+    isLoading,
+    initialContent,
+    create
+  } = $derived(
+    useTiptapSync(convex, api.tiptapSyncSvelte, documentId)
+  );
+
+  let editorContainer: HTMLElement;
+  let editor: Editor;
+
+  $: if ($extension && $initialContent && !editor) {
+    editor = new Editor({
+      element: editorContainer,
+      extensions: [
+        StarterKit,
+        $extension
+      ],
+      content: $initialContent
+    });
+  }
+
+  onDestroy(() => {
+    editor?.destroy();
+  });
+
+  function handleCreate() {
+    create({
+      type: 'doc',
+      content: [{ type: 'paragraph', content: [{ type: 'text', text: 'New document' }] }]
+    });
+  }
+</script>
+
+<div class="editor-container">
+  {#if $isLoading}
+    <p>Loading...</p>
+  {:else if !$initialContent}
+    <button on:click={handleCreate}>Create Document</button>
+  {:else if $extension}
+    <div class="controls">
+      <button
+        on:click={() => $isSyncEnabled.update(enabled => !enabled)}
+      >
+        {$isSyncEnabled ? 'Pause Sync' : 'Resume Sync'}
+      </button>
+    </div>
+    <div bind:this={editorContainer} class="editor"></div>
+  {/if}
+</div>
+```
+
+## License
+
+Apache-2.0

package/dist/client/index.d.ts

@@ -0,0 +1,183 @@
+import { type ApiFromModules, type GenericDataModel, type GenericMutationCtx, type GenericQueryCtx } from 'convex/server';
+import type { ComponentApi } from '../component/_generated/component.js';
+import { Schema, Node } from '@tiptap/pm/model';
+import { Transform } from '@tiptap/pm/transform';
+export type SyncApi = ApiFromModules<{
+    sync: ReturnType<TiptapSyncSvelte['syncApi']>;
+}>['sync'];
+export type RunMutationCtx = {
+    runMutation: GenericMutationCtx<GenericDataModel>['runMutation'];
+    runQuery: GenericQueryCtx<GenericDataModel>['runQuery'];
+};
+export declare class TiptapSyncSvelte<Id extends string = string> {
+    component: ComponentApi;
+    /**
+     * Backend API for the ProsemirrorSync component.
+     * Responsible for exposing the `sync` API to the client, and having
+     * convenience methods for interacting with the component from the backend.
+     *
+     * Typically used like:
+     *
+     * ```ts
+     * const prosemirrorSync = new ProsemirrorSync(components.prosemirrorSync);
+     * export const {
+     * ... // see {@link syncApi} docstring for details
+     * } = prosemirrorSync.syncApi({...});
+     * ```
+     *
+     * @param component - Generally `components.prosemirrorSync` from
+     * `./_generated/api` once you've configured it in `convex.config.ts`.
+     */
+    constructor(component: ComponentApi);
+    /**
+     * Create a new document with the given ID and content.
+     *
+     * @param ctx - A Convex mutation context.
+     * @param id - The document ID.
+     * @param content - The document content. Should be ProseMirror JSON.
+     * @returns A promise that resolves when the document is created.
+     */
+    create(ctx: RunMutationCtx, id: Id, content: object): Promise<null>;
+    /**
+     * Get the latest document version and content.
+     *
+     * @param ctx - A Convex mutation context.
+     * @param id - The document ID.
+     * @param schema - Your ProseMirror schema.
+     *   For Tiptap, use `getSchema(extensions)`.
+     *   For BlockNote, use `editor.pmSchema`.
+     * @returns The latest ProseMirror doc (Node) and version.
+     */
+    getDoc(ctx: RunMutationCtx, id: Id, schema: Schema): Promise<{
+        version: number;
+        doc: Node;
+    }>;
+    /**
+     * Transform the document by applying the given function to the document.
+     *
+     * This will keep applying the function until the document is synced,
+     * so ensure that the function is idempotent (can be applied multiple times).
+     *
+     * e.g.
+     * ```ts
+     * import { getSchema } from "@tiptap/core";
+     * import { Transform } from "@tiptap/pm/transform";
+     *
+     * const schema = getSchema(extensions);
+     * await prosemirrorSync.transform(ctx, id, schema, (doc) => {
+     *   const tr = new Transform(doc);
+     *   tr.insert(0, schema.text("Hello world"));
+     *   return tr;
+     * });
+     * ```
+     *
+     * @param ctx - A Convex mutation context.
+     * @param id - The document ID.
+     * @param schema - The document schema.
+     * @param fn - A function that takes the document and returns a Transform
+     *   or null if no changes are needed.
+     * @returns A promise that resolves with the transformed document.
+     */
+    transform(ctx: RunMutationCtx, id: Id, schema: Schema, fn: (node: Node, version: number) => Transform | null | Promise<Transform | null>, opts?: {
+        clientId?: string;
+    }): Promise<Node>;
+    /**
+     * Expose the sync API to the client for use with the `useTiptapSync` hook.
+     * If you export these in `convex/prosemirror.ts`, pass `api.prosemirror`
+     * to the `useTiptapSync` hook.
+     *
+     * It allows you to define optional read and write permissions, along with
+     * a callback when new snapshots are available.
+     *
+     * You can pass the optional type argument `<DataModel>` to have the `ctx`
+     * parameter specific to your tables.
+     *
+     * ```ts
+     * import { DataModel } from "./convex/_generated/dataModel";
+     * // ...
+     * export const { ... } = prosemirrorSync.syncApi<DataModel>({...});
+     * ```
+     *
+     * To define just one function to use for both, you can define it like this:
+     * ```ts
+     * async function checkPermissions(ctx: QueryCtx, id: string) {
+     *   const user = await getAuthUser(ctx);
+     *   if (!user || !(await canUserAccessDocument(user, id))) {
+     *     throw new Error("Unauthorized");
+     *   }
+     * }
+     * ```
+     * @param opts - Optional callbacks.
+     * @returns functions to export, so the `useTiptapSync` hook can use them.
+     */
+    syncApi<DataModel extends GenericDataModel>(opts?: {
+        /**
+         * Optional callback to check read permissions.
+         * Throw an error if the user is not authorized to read the document.
+         * @param ctx - A Convex query context.
+         * @param id - The document ID.
+         */
+        checkRead?: (ctx: GenericQueryCtx<DataModel>, id: Id) => void | Promise<void>;
+        /**
+         * Optional callback to check write permissions.
+         * Throw an error if the user is not authorized to write to the document.
+         * @param ctx - A Convex mutation context.
+         * @param id - The document ID.
+         */
+        checkWrite?: (ctx: GenericMutationCtx<DataModel>, id: Id) => void | Promise<void>;
+        /**
+         * Optional callback to run when a new snapshot is available.
+         * Version 1 is the initial content.
+         * @param ctx - A Convex mutation context.
+         * @param id - The document ID.
+         * @param snapshot - The snapshot content, as stringified ProseMirror JSON.
+         * @param version - The version this snapshot represents.
+         */
+        onSnapshot?: (ctx: GenericMutationCtx<DataModel>, id: Id, snapshot: string, version: number) => void | Promise<void>;
+        /**
+         * Whether to prune old snapshots.
+         * If set to true, only the original and newest snapshots are kept.
+         * @default true
+         */
+        pruneSnapshots?: boolean;
+    }): {
+        getSnapshot: import("convex/server").RegisteredQuery<"public", {
+            version?: number | undefined;
+            id: Id;
+        }, Promise<{
+            content: null;
+            version: null;
+        } | {
+            content: string;
+            version: number;
+        }>>;
+        submitSnapshot: import("convex/server").RegisteredMutation<"public", {
+            id: Id;
+            version: number;
+            content: string;
+        }, Promise<void>>;
+        latestVersion: import("convex/server").RegisteredQuery<"public", {
+            id: Id;
+        }, Promise<number | null>>;
+        getSteps: import("convex/server").RegisteredQuery<"public", {
+            id: Id;
+            version: number;
+        }, Promise<{
+            clientIds: Array<string | number>;
+            steps: Array<string>;
+            version: number;
+        }>>;
+        submitSteps: import("convex/server").RegisteredMutation<"public", {
+            id: Id;
+            version: number;
+            clientId: string | number;
+            steps: string[];
+        }, Promise<{
+            clientIds: Array<string | number>;
+            status: "needs-rebase";
+            steps: Array<string>;
+        } | {
+            status: "synced";
+        }>>;
+    };
+}