@lexical/headless 0.2.6

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) Meta Platforms, Inc. and affiliates.
+
+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/LexicalHeadless.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ */
+
+import type {
+  LexicalEditor,
+  LexicalNode,
+  EditorState,
+  EditorThemeClasses,
+} from 'lexical';
+
+export function createHeadlessEditor(editorConfig?: {
+  namespace?: string;
+  editorState?: EditorState;
+  theme?: EditorThemeClasses;
+  parentEditor?: LexicalEditor;
+  nodes?: $ReadOnlyArray<Class<LexicalNode>>;
+  onError: (error: Error) => void;
+  disableEvents?: boolean;
+  readOnly?: boolean;
+}): LexicalEditor;

package/LexicalHeadless.dev.js

@@ -0,0 +1,31 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+'use strict';
+
+var lexical = require('lexical');
+
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * 
+ */
+function createHeadlessEditor(editorConfig) {
+  const editor = lexical.createEditor(editorConfig);
+  editor._headless = true;
+  ['registerDecoratorListener', 'registerRootListener', 'registerMutationListeners', 'getRootElement', 'setRootElement', 'getElementByKey', 'focus', 'blur'].forEach(method => {
+    // $FlowFixMe
+    editor[method] = () => {
+      throw new Error(`${method} is not supported in headless mode`);
+    };
+  });
+  return editor;
+}
+
+exports.createHeadlessEditor = createHeadlessEditor;

package/LexicalHeadless.js

@@ -0,0 +1,9 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+'use strict'
+const LexicalHeadless = process.env.NODE_ENV === 'development' ? require('./LexicalHeadless.dev.js') : require('./LexicalHeadless.prod.js')
+module.exports = LexicalHeadless;

package/LexicalHeadless.js.flow

@@ -0,0 +1,26 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @flow strict
+ */
+
+import type {
+  LexicalEditor,
+  LexicalNode,
+  EditorState,
+  EditorThemeClasses,
+} from 'lexical';
+
+declare export function createHeadlessEditor(editorConfig?: {
+  namespace?: string,
+  editorState?: EditorState,
+  theme?: EditorThemeClasses,
+  parentEditor?: LexicalEditor,
+  nodes?: $ReadOnlyArray<Class<LexicalNode>>,
+  onError: (error: Error) => void,
+  disableEvents?: boolean,
+  readOnly?: boolean,
+}): LexicalEditor;

package/LexicalHeadless.prod.js

@@ -0,0 +1,7 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+var c=require("lexical");exports.createHeadlessEditor=function(d){const a=c.createEditor(d);a._headless=!0;"registerDecoratorListener registerRootListener registerMutationListeners getRootElement setRootElement getElementByKey focus blur".split(" ").forEach(b=>{a[b]=()=>{throw Error(`${b} is not supported in headless mode`);}});return a};

package/README.md

@@ -0,0 +1,45 @@
+# `@lexical/headless`
+
+This package allows creating headless lexical editor (that does not rely on DOM, e.g. for Node.js environment), and use its
+main features like editor.update(), editor.registerNodeTransform(), editor.registerUpdateListener()
+to create, update or traverse state.
+
+```js
+const { createHeadlessEditor } = require('@lexical/headless');
+
+const editor = createHeadlessEditor({
+  nodes: [],
+  onError: () => {},
+});
+
+editor.update(() => {
+  $getRoot().append(
+    $createParagraphNode().append(
+      $createTextNode('Hello world')
+    )
+  )
+});
+```
+
+Any plugins that do not rely on DOM could also be used. Here's an example of how
+you can convert lexical editor state to markdown on server:
+```js
+const { createHeadlessEditor } = require('@lexical/headless');
+const { $convertToMarkdownString, TRANSFORMERS } = require('@lexical/markdown');
+
+app.get('article/:id/markdown', await (req, res) => {
+  const editor = createHeadlessEditor({
+    nodes: [],
+    onError: () => {},
+  });
+
+  const articleEditorStateJSON = await loadArticleBody(req.query.id);
+  editor.setEditorState(editor.parseEditorState(articleEditorStateJSON));  
+
+  editor.update(() => {
+    const markdown = $convertToMarkdownString(TRANSFORMERS);
+    res.send(markdown);
+  });
+});
+
+```

package/package.json

@@ -0,0 +1,21 @@
+{
+  "name": "@lexical/headless",
+  "description": "This package contains Headless helpers and functionality for Lexical.",
+  "keywords": [
+    "lexical",
+    "editor",
+    "rich-text",
+    "headless"
+  ],
+  "license": "MIT",
+  "version": "0.2.6",
+  "main": "LexicalHeadless.js",
+  "peerDependencies": {
+    "lexical": "0.2.6"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/facebook/lexical",
+    "directory": "packages/lexical-headless"
+  }
+}