@lexical/headless 0.13.0 → 0.14.0

package/LexicalHeadless.dev.esm.js

@@ -0,0 +1,29 @@
+/**
+ * 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 { createEditor } from 'lexical';
+
+/** @module @lexical/headless */
+
+/**
+ * Generates a headless editor that allows lexical to be used without the need for a DOM, eg in Node.js.
+ * Throws an error when unsupported methods are used.
+ * @param editorConfig - The optional lexical editor configuration.
+ * @returns - The configured headless editor.
+ */
+function createHeadlessEditor(editorConfig) {
+  const editor = createEditor(editorConfig);
+  editor._headless = true;
+  const unsupportedMethods = ['registerDecoratorListener', 'registerRootListener', 'registerMutationListener', 'getRootElement', 'setRootElement', 'getElementByKey', 'focus', 'blur'];
+  unsupportedMethods.forEach(method => {
+    editor[method] = () => {
+      throw new Error(`${method} is not supported in headless mode`);
+    };
+  });
+  return editor;
+}
+
+export { createHeadlessEditor };

package/LexicalHeadless.dev.js

@@ -12,7 +12,7 @@ var lexical = require('lexical');
 
 /**
  * Generates a headless editor that allows lexical to be used without the need for a DOM, eg in Node.js.
- * Throws an error when unsupported metehods are used.
+ * Throws an error when unsupported methods are used.
  * @param editorConfig - The optional lexical editor configuration.
  * @returns - The configured headless editor.
  */

package/LexicalHeadless.esm.js

@@ -0,0 +1,10 @@
+/**
+ * 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 * as modDev from './LexicalHeadless.dev.esm.js';
+import * as modProd from './LexicalHeadless.prod.esm.js';
+const mod = process.env.NODE_ENV === 'development' ? modDev : modProd;
+export const createHeadlessEditor = mod.createHeadlessEditor;

package/LexicalHeadless.js

@@ -5,5 +5,5 @@
  * 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')
+const LexicalHeadless = process.env.NODE_ENV === 'development' ? require('./LexicalHeadless.dev.js') : require('./LexicalHeadless.prod.js');
 module.exports = LexicalHeadless;

package/LexicalHeadless.prod.esm.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.
+ */
+import{createEditor as e}from"lexical";function t(t){const r=e(t);r._headless=!0;return["registerDecoratorListener","registerRootListener","registerMutationListener","getRootElement","setRootElement","getElementByKey","focus","blur"].forEach((e=>{r[e]=()=>{throw new Error(`${e} is not supported in headless mode`)}})),r}export{t as createHeadlessEditor};

package/README.md

@@ -1,5 +1,7 @@
 # `@lexical/headless`
 
+[![See API Documentation](https://lexical.dev/img/see-api-documentation.svg)](https://lexical.dev/docs/api/modules/lexical_headless)
+
 This package allows you to interact with Lexical in a headless environment (one 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.
@@ -40,7 +42,7 @@ app.get('article/:id/markdown', await (req, res) => {
   });
 
   const articleEditorStateJSON = await loadArticleBody(req.query.id);
-  editor.setEditorState(editor.parseEditorState(articleEditorStateJSON));  
+  editor.setEditorState(editor.parseEditorState(articleEditorStateJSON));
 
   editor.update(() => {
     const markdown = $convertToMarkdownString(TRANSFORMERS);

package/index.d.ts

@@ -9,7 +9,7 @@
 import type { CreateEditorArgs, LexicalEditor } from 'lexical';
 /**
  * Generates a headless editor that allows lexical to be used without the need for a DOM, eg in Node.js.
- * Throws an error when unsupported metehods are used.
+ * Throws an error when unsupported methods are used.
  * @param editorConfig - The optional lexical editor configuration.
  * @returns - The configured headless editor.
  */

package/package.json

@@ -8,14 +8,16 @@
     "headless"
   ],
   "license": "MIT",
-  "version": "0.13.0",
+  "version": "0.14.0",
   "main": "LexicalHeadless.js",
   "peerDependencies": {
-    "lexical": "0.13.0"
+    "lexical": "0.14.0"
   },
   "repository": {
     "type": "git",
     "url": "https://github.com/facebook/lexical",
     "directory": "packages/lexical-headless"
-  }
+  },
+  "module": "LexicalHeadless.esm.js",
+  "sideEffects": false
 }