automerge-lexical 0.1.1 → 0.1.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Rohan Shah
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,75 +1,140 @@
-# React + TypeScript + Vite
 
-This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
+# Automerge Lexical Bindings
 
-Currently, two official plugins are available:
+Collaborate on rich text documents which follow the [rich text schema](https://automerge.org/docs/reference/under-the-hood/rich-text-schema/) using Lexical.
 
-- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react) uses [Oxc](https://oxc.rs)
-- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react-swc) uses [SWC](https://swc.rs/)
 
-## React Compiler
+## Installation
 
-The React Compiler is not enabled on this template because of its impact on dev & build performances. To add it, see [this documentation](https://react.dev/learn/react-compiler/installation).
+```bash
+  npm install automerge-lexical
+```
 
-## Expanding the ESLint configuration
+## Playground
 
-If you are developing a production application, we recommend updating the configuration to enable type-aware lint rules:
+You can setup a fully functional example to play around with. 
 
-```js
-export default defineConfig([
-  globalIgnores(['dist']),
-  {
-    files: ['**/*.{ts,tsx}'],
-    extends: [
-      // Other configs...
-
-      // Remove tseslint.configs.recommended and replace with this
-      tseslint.configs.recommendedTypeChecked,
-      // Alternatively, use this for stricter rules
-      tseslint.configs.strictTypeChecked,
-      // Optionally, add this for stylistic rules
-      tseslint.configs.stylisticTypeChecked,
-
-      // Other configs...
-    ],
-    languageOptions: {
-      parserOptions: {
-        project: ['./tsconfig.node.json', './tsconfig.app.json'],
-        tsconfigRootDir: import.meta.dirname,
-      },
-      // other options...
-    },
-  },
-])
+```bash
+  git clone https://github.com/rohankshah/automerge-lexical-plugin.git
+```
 
+```bash
+  pnpm install
+  pnpm build:plugin
+  pnpm dev:playground
 ```
 
-You can also install [eslint-plugin-react-x](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-x) and [eslint-plugin-react-dom](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-dom) for React-specific lint rules:
+The playground will run on `http://localhost:5173.`
+
+
+## Quick Start
+
+This library provides a plugin which maps between Automerge documents and Lexical. At present it only supports the Automerge [rich text schema](https://automerge.org/docs/reference/under-the-hood/rich-text-schema/).
+
+
+```typescript
+import { LexicalComposer } from "@lexical/react/LexicalComposer";
+import { RichTextPlugin } from "@lexical/react/LexicalRichTextPlugin";
+import { ContentEditable } from "@lexical/react/LexicalContentEditable";
+import { HistoryPlugin } from "@lexical/react/LexicalHistoryPlugin";
+import { LexicalErrorBoundary } from "@lexical/react/LexicalErrorBoundary";
+
+// Import automerge-lexical config and change plugin
+import {
+  AutomergeChangePlugin,
+  automergeConfig
+} from "automerge-lexical-plugin";
+
+
+// Obtain a DocHandle somehow
+const docUrl = "some-doc-url";
+const handle = repo.find(docUrl);
+
+// wait for the handle to be ready before continuing
+await handle.whenReady();
 
-```js
-// eslint.config.js
-import reactX from 'eslint-plugin-react-x'
-import reactDom from 'eslint-plugin-react-dom'
+// add path to the rich text object in the automerge document
+const path = ["text"]
 
-export default defineConfig([
-  globalIgnores(['dist']),
+const { initialConfig, registerSync } = automergeConfig(
   {
-    files: ['**/*.{ts,tsx}'],
-    extends: [
-      // Other configs...
-      // Enable lint rules for React
-      reactX.configs['recommended-typescript'],
-      // Enable lint rules for React DOM
-      reactDom.configs.recommended,
-    ],
-    languageOptions: {
-      parserOptions: {
-        project: ['./tsconfig.node.json', './tsconfig.app.json'],
-        tsconfigRootDir: import.meta.dirname,
-      },
-      // other options...
+    namespace: "MyEditor",
+    nodes: [],
+    theme,
+    onError(error: Error) {
+      throw error;
     },
   },
-])
+  path,
+  docUrl
+);
 
+return (
+  <LexicalComposer initialConfig={initialConfig}>
+    <RichTextPlugin
+      contentEditable={<ContentEditable />}
+      placeholder={<div>Type something...</div>}
+      ErrorBoundary={LexicalErrorBoundary}
+    />
+    <HistoryPlugin />
+    <AutomergeChangePlugin registerSync={registerSync} handle={handle} />
+  </LexicalComposer>
+);
 ```
+
+
+## API
+
+### `automergeConfig`
+
+Creates a Lexical configuration object that's connected to an Automerge document.
+
+```typescript
+/**
+ * Creates an Automerge configuration for a Lexical editor.
+ *
+ * @param editorConfig - Lexical editor configuration.
+ * @param path - Path to the rich text object in the document.
+ * @param docUrl - URL of the Automerge document.
+ * @param schema - Optional, schema used to map Lexical nodes to Automerge.
+ * @returns A configuration object for the editor.
+ */
+automergeConfig(
+    editorConfig,
+    path,
+    docUrl,
+    schema
+  )
+```
+
+### `AutomergeChangePlugin`
+
+A plugin that two way syncs between Automerge document and Lexical editor
+
+```typescript
+interface AutomergeChangePluginProps<T> {
+  /**
+   * Registers two way synchronization between lexical and automerge
+   *
+   * @param editor - The Lexical editor instance.
+   * @param handle - The Automerge document handle.
+   * @param updateSpansConfig - Optional configuration passed to `am.updateSpans()`.
+   * @returns A cleanup function that unregisters all listeners.
+   */
+  registerSync(
+    editor: LexicalEditor,
+    handle: DocHandle<T>,
+    updateSpansConfig?: UpdateSpansConfig
+  ): () => void;
+  /**
+   * The Automerge document handle to synchronize with.
+   */
+  handle: DocHandle<T>;
+}
+
+<AutomergeChangePlugin registerSync={...} handle={...} />
+```
+
+## License
+
+[MIT](https://choosealicense.com/licenses/mit/)

package/dist/AutomergeChangePlugin.d.ts

@@ -3,7 +3,12 @@ import { DocHandle } from '@automerge/automerge-repo';
 import { LexicalEditor } from 'lexical';
 interface AutomergeChangePluginProps<T> {
     /**
-     * Registers synchronization between a Lexical editor and an Automerge document.
+     * Registers two way synchronization between lexical and automerge
+     *
+     * @param editor - The Lexical editor instance.
+     * @param handle - The Automerge document handle.
+     * @param updateSpansConfig - Optional configuration passed to `am.updateSpans()`.
+     * @returns A cleanup function that unregisters all listeners.
      */
     registerSync(editor: LexicalEditor, handle: DocHandle<T>, updateSpansConfig?: UpdateSpansConfig): () => void;
     /**

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "automerge-lexical",
   "private": false,
-  "version": "0.1.1",
+  "version": "0.1.2",
   "type": "module",
   "main": "./dist/automerge-lexical-plugin.es.js",
   "module": "./dist/automerge-lexical-plugin.es.js",