@liveblocks/react-lexical 2.0.0-alpha2 → 2.0.0-alpha4

package/dist/index.d.mts

@@ -1,74 +1,84 @@
-import { BaseMetadata, ThreadData } from '@liveblocks/core';
+import { BaseMetadata } from '@liveblocks/core';
 import { ComposerProps } from '@liveblocks/react-ui';
 import * as lexical from 'lexical';
-import { LexicalCommand, ElementNode, NodeKey, RangeSelection, LexicalNode, BaseSelection, Spread, SerializedElementNode, DecoratorNode, DOMConversionMap, DOMExportOutput, SerializedLexicalNode } from 'lexical';
-import React, { ComponentType, ReactNode, JSX as JSX$1 } from 'react';
+import { LexicalCommand } from 'lexical';
+import React from 'react';
 import { InitialConfigType } from '@lexical/react/LexicalComposer';
 
+/**
+ * Returns whether the associated thread annotation for the given thread id is selected or not in the editor.
+ * @param threadId The id of the thread to check if the associated annotation is selected or not.
+ * @returns true if the associated annotation for the thread is selected, false otherwise.
+ */
+declare function useIsThreadActive(threadId: string): boolean;
+
+/**
+ * Dispatching OPEN_FLOATING_COMPOSER_COMMAND will display the FloatingComposer
+ *
+ * @example
+ * import { useLexicalComposerContext } from "@lexical/react/LexicalComposerContext";
+ * import { OPEN_FLOATING_COMPOSER_COMMAND } from "@liveblocks/react-lexical";
+ *
+ * function Toolbar() {
+ *   const [editor] = useLexicalComposerContext();
+ *
+ *   return (
+ *     <button
+ *       onClick={() => {
+ *         editor.dispatchCommand(OPEN_FLOATING_COMPOSER_COMMAND);
+ *       }}
+ *     >
+ *       💬 New comment
+ *     </button>
+ *   );
+ * }
+ */
 declare const OPEN_FLOATING_COMPOSER_COMMAND: LexicalCommand<void>;
 declare type ThreadMetadata = {
     resolved?: boolean;
 };
 declare type FloatingComposerProps<M extends BaseMetadata = ThreadMetadata> = Omit<ComposerProps<M>, "threadId" | "commentId">;
+/**
+ * Displays a `Composer` near the current lexical selection.
+ *
+ * To open it, dispatch `OPEN_FLOATING_COMPOSER_COMMAND`.
+ *
+ * Submitting a comment will attach an annotation thread at the current selection.
+ * Should be nested inside `LiveblocksPlugin`.
+ */
 declare const FloatingComposer: React.ForwardRefExoticComponent<FloatingComposerProps<ThreadMetadata> & React.RefAttributes<HTMLFormElement>>;
 
 /**
- * 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:
+ * Function that takes a Lexical editor config and modifies it to add the necessary
+ * `nodes` and `theme` to make `LiveblocksPlugin` works correctly.
  *
- * The above copyright notice and this permission notice shall be included in all
- * copies or substantial portions of the Software.
+ * @example
+ * import { LexicalComposer } from "@lexical/react/LexicalComposer";
+ * import { RichTextPlugin } from "@lexical/react/LexicalRichTextPlugin";
+ * import { ContentEditable } from "@lexical/react/LexicalContentEditable";
+ * import { LexicalErrorBoundary } from "@lexical/react/LexicalErrorBoundary";
+ * import { liveblocksConfig, LiveblocksPlugin } from "@liveblocks/react-lexical";
  *
- * 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.
+ * const initialConfig = liveblocksConfig({
+ *   namespace: "MyEditor",
+ *   theme: {},
+ *   nodes: [],
+ *   onError: (err) => console.error(err),
+ * });
+ *
+ * function Editor() {
+ *   return (
+ *     <LexicalComposer initialConfig={initialConfig}>
+ *       <LiveblocksPlugin />
+ *       <RichTextPlugin
+ *         contentEditable={<ContentEditable />}
+ *         placeholder={<div>Enter some text...</div>}
+ *         ErrorBoundary={LexicalErrorBoundary}
+ *       />
+ *     </LexicalComposer>
+ *   );
+ * }
  */
-
-declare type SerializedThreadMarkNode = Spread<{
-    ids: Array<string>;
-}, SerializedElementNode>;
-declare class ThreadMarkNode extends ElementNode {
-    static getType(): string;
-    static clone(node: ThreadMarkNode): ThreadMarkNode;
-    static importDOM(): null;
-    static importJSON(serializedNode: SerializedThreadMarkNode): ThreadMarkNode;
-    exportJSON(): SerializedThreadMarkNode;
-    constructor(ids: Array<string>, key?: NodeKey);
-    createDOM(): HTMLElement;
-    updateDOM(): boolean;
-    hasID(id: string): boolean;
-    getIDs(): Array<string>;
-    addID(id: string): void;
-    deleteID(id: string): void;
-    insertNewAfter(_: RangeSelection, restoreSelection?: boolean): null | ElementNode;
-    canInsertTextBefore(): false;
-    canInsertTextAfter(): false;
-    canBeEmpty(): false;
-    isInline(): true;
-    extractWithChild(_: LexicalNode, selection: BaseSelection, destination: "clone" | "html"): boolean;
-    excludeFromCopy(destination: "clone" | "html"): boolean;
-}
-
-declare type ThreadProps = {
-    thread: ThreadData<BaseMetadata>;
-    isActive: boolean;
-};
-declare type ThreadPanelProps = {
-    renderThread?: ComponentType<ThreadProps>;
-};
-declare const ThreadPanel: ({ renderThread }: ThreadPanelProps) => React.JSX.Element;
-
 declare function liveblocksConfig(editorConfig: Omit<InitialConfigType, "editorState">): {
     nodes: (lexical.KlassConstructor<typeof lexical.LexicalNode> | lexical.LexicalNodeReplacement)[];
     editorState: null;
@@ -80,34 +90,57 @@ declare function liveblocksConfig(editorConfig: Omit<InitialConfigType, "editorS
     theme?: lexical.EditorThemeClasses | undefined;
 };
 
+declare type EditorStatus = "not-loaded" | "loading"
+/**
+ * Not working yet! Will be available in a future release.
+ * Some editor state modifications has not been acknowledged yet by the server
+ */
+ | "synchronizing" | "synchronized";
+/**
+ * Get the storage status.
+ *
+ * - `not-loaded`: Initial state when entering the room.
+ * - `loading`: Once the editor state has been requested by LiveblocksPlugin.
+ * - `synchronizing`: Not working yet! Will be available in a future release.
+ * - `synchronized`:  The editor state is sync with Liveblocks servers.
+ */
+declare function useEditorStatus(): EditorStatus;
 declare type LiveblocksPluginProps = {
     children?: React.ReactNode;
 };
+/**
+ * Liveblocks plugin for Lexical that adds collaboration to your editor.
+ *
+ * `LiveblocksPlugin` should always be nested inside `LexicalComposer`.
+ *
+ * @example
+ *
+ * import { LexicalComposer } from "@lexical/react/LexicalComposer";
+ * import { RichTextPlugin } from "@lexical/react/LexicalRichTextPlugin";
+ * import { ContentEditable } from "@lexical/react/LexicalContentEditable";
+ * import { LexicalErrorBoundary } from "@lexical/react/LexicalErrorBoundary";
+ * import { liveblocksConfig, LiveblocksPlugin } from "@liveblocks/react-lexical";
+ *
+ * const initialConfig = liveblocksConfig({
+ *   namespace: "MyEditor",
+ *   theme: {},
+ *   nodes: [],
+ *   onError: (err) => console.error(err),
+ * });
+ *
+ * function Editor() {
+ *   return (
+ *     <LexicalComposer initialConfig={initialConfig}>
+ *       <LiveblocksPlugin />
+ *       <RichTextPlugin
+ *         contentEditable={<ContentEditable />}
+ *         placeholder={<div>Enter some text...</div>}
+ *         ErrorBoundary={LexicalErrorBoundary}
+ *       />
+ *     </LexicalComposer>
+ *   );
+ * }
+ */
 declare const LiveblocksPlugin: ({ children, }: LiveblocksPluginProps) => JSX.Element;
 
-declare function Mention({ nodeKey, children, }: {
-    nodeKey: NodeKey;
-    children: ReactNode;
-}): React.JSX.Element;
-
-declare type SerializedMentionNode = Spread<{
-    userId: string;
-}, SerializedLexicalNode>;
-declare class MentionNode extends DecoratorNode<JSX$1.Element> {
-    __id: string;
-    __userId: string;
-    constructor(id: string, userId: string, key?: NodeKey);
-    static getType(): string;
-    static clone(node: MentionNode): MentionNode;
-    createDOM(): HTMLElement;
-    updateDOM(): boolean;
-    static importDom(): DOMConversionMap<HTMLElement> | null;
-    exportDOM(): DOMExportOutput;
-    static importJSON(serializedNode: SerializedMentionNode): MentionNode;
-    exportJSON(): SerializedMentionNode;
-    getUserId(): string;
-    getId(): string;
-    decorate(): JSX$1.Element;
-}
-
-export { FloatingComposer, LiveblocksPlugin, Mention, MentionNode, OPEN_FLOATING_COMPOSER_COMMAND, ThreadMarkNode, ThreadPanel, liveblocksConfig };
+export { FloatingComposer, LiveblocksPlugin, OPEN_FLOATING_COMPOSER_COMMAND, liveblocksConfig, useEditorStatus, useIsThreadActive };

package/dist/index.d.ts

@@ -1,74 +1,84 @@
-import { BaseMetadata, ThreadData } from '@liveblocks/core';
+import { BaseMetadata } from '@liveblocks/core';
 import { ComposerProps } from '@liveblocks/react-ui';
 import * as lexical from 'lexical';
-import { LexicalCommand, ElementNode, NodeKey, RangeSelection, LexicalNode, BaseSelection, Spread, SerializedElementNode, DecoratorNode, DOMConversionMap, DOMExportOutput, SerializedLexicalNode } from 'lexical';
-import React, { ComponentType, ReactNode, JSX as JSX$1 } from 'react';
+import { LexicalCommand } from 'lexical';
+import React from 'react';
 import { InitialConfigType } from '@lexical/react/LexicalComposer';
 
+/**
+ * Returns whether the associated thread annotation for the given thread id is selected or not in the editor.
+ * @param threadId The id of the thread to check if the associated annotation is selected or not.
+ * @returns true if the associated annotation for the thread is selected, false otherwise.
+ */
+declare function useIsThreadActive(threadId: string): boolean;
+
+/**
+ * Dispatching OPEN_FLOATING_COMPOSER_COMMAND will display the FloatingComposer
+ *
+ * @example
+ * import { useLexicalComposerContext } from "@lexical/react/LexicalComposerContext";
+ * import { OPEN_FLOATING_COMPOSER_COMMAND } from "@liveblocks/react-lexical";
+ *
+ * function Toolbar() {
+ *   const [editor] = useLexicalComposerContext();
+ *
+ *   return (
+ *     <button
+ *       onClick={() => {
+ *         editor.dispatchCommand(OPEN_FLOATING_COMPOSER_COMMAND);
+ *       }}
+ *     >
+ *       💬 New comment
+ *     </button>
+ *   );
+ * }
+ */
 declare const OPEN_FLOATING_COMPOSER_COMMAND: LexicalCommand<void>;
 declare type ThreadMetadata = {
     resolved?: boolean;
 };
 declare type FloatingComposerProps<M extends BaseMetadata = ThreadMetadata> = Omit<ComposerProps<M>, "threadId" | "commentId">;
+/**
+ * Displays a `Composer` near the current lexical selection.
+ *
+ * To open it, dispatch `OPEN_FLOATING_COMPOSER_COMMAND`.
+ *
+ * Submitting a comment will attach an annotation thread at the current selection.
+ * Should be nested inside `LiveblocksPlugin`.
+ */
 declare const FloatingComposer: React.ForwardRefExoticComponent<FloatingComposerProps<ThreadMetadata> & React.RefAttributes<HTMLFormElement>>;
 
 /**
- * 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:
+ * Function that takes a Lexical editor config and modifies it to add the necessary
+ * `nodes` and `theme` to make `LiveblocksPlugin` works correctly.
  *
- * The above copyright notice and this permission notice shall be included in all
- * copies or substantial portions of the Software.
+ * @example
+ * import { LexicalComposer } from "@lexical/react/LexicalComposer";
+ * import { RichTextPlugin } from "@lexical/react/LexicalRichTextPlugin";
+ * import { ContentEditable } from "@lexical/react/LexicalContentEditable";
+ * import { LexicalErrorBoundary } from "@lexical/react/LexicalErrorBoundary";
+ * import { liveblocksConfig, LiveblocksPlugin } from "@liveblocks/react-lexical";
  *
- * 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.
+ * const initialConfig = liveblocksConfig({
+ *   namespace: "MyEditor",
+ *   theme: {},
+ *   nodes: [],
+ *   onError: (err) => console.error(err),
+ * });
+ *
+ * function Editor() {
+ *   return (
+ *     <LexicalComposer initialConfig={initialConfig}>
+ *       <LiveblocksPlugin />
+ *       <RichTextPlugin
+ *         contentEditable={<ContentEditable />}
+ *         placeholder={<div>Enter some text...</div>}
+ *         ErrorBoundary={LexicalErrorBoundary}
+ *       />
+ *     </LexicalComposer>
+ *   );
+ * }
  */
-
-declare type SerializedThreadMarkNode = Spread<{
-    ids: Array<string>;
-}, SerializedElementNode>;
-declare class ThreadMarkNode extends ElementNode {
-    static getType(): string;
-    static clone(node: ThreadMarkNode): ThreadMarkNode;
-    static importDOM(): null;
-    static importJSON(serializedNode: SerializedThreadMarkNode): ThreadMarkNode;
-    exportJSON(): SerializedThreadMarkNode;
-    constructor(ids: Array<string>, key?: NodeKey);
-    createDOM(): HTMLElement;
-    updateDOM(): boolean;
-    hasID(id: string): boolean;
-    getIDs(): Array<string>;
-    addID(id: string): void;
-    deleteID(id: string): void;
-    insertNewAfter(_: RangeSelection, restoreSelection?: boolean): null | ElementNode;
-    canInsertTextBefore(): false;
-    canInsertTextAfter(): false;
-    canBeEmpty(): false;
-    isInline(): true;
-    extractWithChild(_: LexicalNode, selection: BaseSelection, destination: "clone" | "html"): boolean;
-    excludeFromCopy(destination: "clone" | "html"): boolean;
-}
-
-declare type ThreadProps = {
-    thread: ThreadData<BaseMetadata>;
-    isActive: boolean;
-};
-declare type ThreadPanelProps = {
-    renderThread?: ComponentType<ThreadProps>;
-};
-declare const ThreadPanel: ({ renderThread }: ThreadPanelProps) => React.JSX.Element;
-
 declare function liveblocksConfig(editorConfig: Omit<InitialConfigType, "editorState">): {
     nodes: (lexical.KlassConstructor<typeof lexical.LexicalNode> | lexical.LexicalNodeReplacement)[];
     editorState: null;
@@ -80,34 +90,57 @@ declare function liveblocksConfig(editorConfig: Omit<InitialConfigType, "editorS
     theme?: lexical.EditorThemeClasses | undefined;
 };
 
+declare type EditorStatus = "not-loaded" | "loading"
+/**
+ * Not working yet! Will be available in a future release.
+ * Some editor state modifications has not been acknowledged yet by the server
+ */
+ | "synchronizing" | "synchronized";
+/**
+ * Get the storage status.
+ *
+ * - `not-loaded`: Initial state when entering the room.
+ * - `loading`: Once the editor state has been requested by LiveblocksPlugin.
+ * - `synchronizing`: Not working yet! Will be available in a future release.
+ * - `synchronized`:  The editor state is sync with Liveblocks servers.
+ */
+declare function useEditorStatus(): EditorStatus;
 declare type LiveblocksPluginProps = {
     children?: React.ReactNode;
 };
+/**
+ * Liveblocks plugin for Lexical that adds collaboration to your editor.
+ *
+ * `LiveblocksPlugin` should always be nested inside `LexicalComposer`.
+ *
+ * @example
+ *
+ * import { LexicalComposer } from "@lexical/react/LexicalComposer";
+ * import { RichTextPlugin } from "@lexical/react/LexicalRichTextPlugin";
+ * import { ContentEditable } from "@lexical/react/LexicalContentEditable";
+ * import { LexicalErrorBoundary } from "@lexical/react/LexicalErrorBoundary";
+ * import { liveblocksConfig, LiveblocksPlugin } from "@liveblocks/react-lexical";
+ *
+ * const initialConfig = liveblocksConfig({
+ *   namespace: "MyEditor",
+ *   theme: {},
+ *   nodes: [],
+ *   onError: (err) => console.error(err),
+ * });
+ *
+ * function Editor() {
+ *   return (
+ *     <LexicalComposer initialConfig={initialConfig}>
+ *       <LiveblocksPlugin />
+ *       <RichTextPlugin
+ *         contentEditable={<ContentEditable />}
+ *         placeholder={<div>Enter some text...</div>}
+ *         ErrorBoundary={LexicalErrorBoundary}
+ *       />
+ *     </LexicalComposer>
+ *   );
+ * }
+ */
 declare const LiveblocksPlugin: ({ children, }: LiveblocksPluginProps) => JSX.Element;
 
-declare function Mention({ nodeKey, children, }: {
-    nodeKey: NodeKey;
-    children: ReactNode;
-}): React.JSX.Element;
-
-declare type SerializedMentionNode = Spread<{
-    userId: string;
-}, SerializedLexicalNode>;
-declare class MentionNode extends DecoratorNode<JSX$1.Element> {
-    __id: string;
-    __userId: string;
-    constructor(id: string, userId: string, key?: NodeKey);
-    static getType(): string;
-    static clone(node: MentionNode): MentionNode;
-    createDOM(): HTMLElement;
-    updateDOM(): boolean;
-    static importDom(): DOMConversionMap<HTMLElement> | null;
-    exportDOM(): DOMExportOutput;
-    static importJSON(serializedNode: SerializedMentionNode): MentionNode;
-    exportJSON(): SerializedMentionNode;
-    getUserId(): string;
-    getId(): string;
-    decorate(): JSX$1.Element;
-}
-
-export { FloatingComposer, LiveblocksPlugin, Mention, MentionNode, OPEN_FLOATING_COMPOSER_COMMAND, ThreadMarkNode, ThreadPanel, liveblocksConfig };
+export { FloatingComposer, LiveblocksPlugin, OPEN_FLOATING_COMPOSER_COMMAND, liveblocksConfig, useEditorStatus, useIsThreadActive };

package/dist/index.js

@@ -2,22 +2,17 @@
 
 var core = require('@liveblocks/core');
 var version = require('./version.js');
+var commentPluginProvider = require('./comments/comment-plugin-provider.js');
 var floatingComposer = require('./comments/floating-composer.js');
-var threadMarkNode = require('./comments/thread-mark-node.js');
-var ThreadPanel = require('./comments/ThreadPanel.js');
 var liveblocksConfig = require('./liveblocks-config.js');
 var liveblocksPluginProvider = require('./liveblocks-plugin-provider.js');
-var mentionComponent = require('./mentions/mention-component.js');
-var mentionNode = require('./mentions/mention-node.js');
 
 core.detectDupes(version.PKG_NAME, version.PKG_VERSION, version.PKG_FORMAT);
 
+exports.useIsThreadActive = commentPluginProvider.useIsThreadActive;
 exports.FloatingComposer = floatingComposer.FloatingComposer;
 exports.OPEN_FLOATING_COMPOSER_COMMAND = floatingComposer.OPEN_FLOATING_COMPOSER_COMMAND;
-exports.ThreadMarkNode = threadMarkNode.ThreadMarkNode;
-exports.ThreadPanel = ThreadPanel.ThreadPanel;
 exports.liveblocksConfig = liveblocksConfig.liveblocksConfig;
 exports.LiveblocksPlugin = liveblocksPluginProvider.LiveblocksPlugin;
-exports.Mention = mentionComponent.Mention;
-exports.MentionNode = mentionNode.MentionNode;
+exports.useEditorStatus = liveblocksPluginProvider.useEditorStatus;
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sources":["../src/index.ts"],"sourcesContent":["import { detectDupes } from \"@liveblocks/core\";\n\nimport { PKG_FORMAT, PKG_NAME, PKG_VERSION } from \"./version\";\n\ndetectDupes(PKG_NAME, PKG_VERSION, PKG_FORMAT);\n\nexport {\n  FloatingComposer,\n  OPEN_FLOATING_COMPOSER_COMMAND,\n} from \"./comments/floating-composer\";\nexport { ThreadMarkNode } from \"./comments/thread-mark-node\";\nexport { ThreadPanel } from \"./comments/ThreadPanel\";\nexport { liveblocksConfig } from \"./liveblocks-config\";\nexport { LiveblocksPlugin } from \"./liveblocks-plugin-provider\";\nexport { Mention } from \"./mentions/mention-component\";\nexport { MentionNode } from \"./mentions/mention-node\";\n"],"names":["detectDupes","PKG_NAME","PKG_VERSION","PKG_FORMAT"],"mappings":";;;;;;;;;;;;AAIAA,gBAAY,CAAAC,gBAAA,EAAUC,qBAAaC,kBAAU,CAAA;;;;;;;;;;;"}
+{"version":3,"file":"index.js","sources":["../src/index.ts"],"sourcesContent":["import { detectDupes } from \"@liveblocks/core\";\n\nimport { PKG_FORMAT, PKG_NAME, PKG_VERSION } from \"./version\";\n\ndetectDupes(PKG_NAME, PKG_VERSION, PKG_FORMAT);\n\nexport { useIsThreadActive } from \"./comments/comment-plugin-provider\";\nexport {\n  FloatingComposer,\n  OPEN_FLOATING_COMPOSER_COMMAND,\n} from \"./comments/floating-composer\";\nexport { liveblocksConfig } from \"./liveblocks-config\";\nexport {\n  LiveblocksPlugin,\n  useEditorStatus,\n} from \"./liveblocks-plugin-provider\";\n"],"names":["detectDupes","PKG_NAME","PKG_VERSION","PKG_FORMAT"],"mappings":";;;;;;;;;AAIAA,gBAAY,CAAAC,gBAAA,EAAUC,qBAAaC,kBAAU,CAAA;;;;;;;;;"}

package/dist/index.mjs

@@ -1,12 +1,9 @@
 import { detectDupes } from '@liveblocks/core';
 import { PKG_NAME, PKG_VERSION, PKG_FORMAT } from './version.mjs';
+export { useIsThreadActive } from './comments/comment-plugin-provider.mjs';
 export { FloatingComposer, OPEN_FLOATING_COMPOSER_COMMAND } from './comments/floating-composer.mjs';
-export { ThreadMarkNode } from './comments/thread-mark-node.mjs';
-export { ThreadPanel } from './comments/ThreadPanel.mjs';
 export { liveblocksConfig } from './liveblocks-config.mjs';
-export { LiveblocksPlugin } from './liveblocks-plugin-provider.mjs';
-export { Mention } from './mentions/mention-component.mjs';
-export { MentionNode } from './mentions/mention-node.mjs';
+export { LiveblocksPlugin, useEditorStatus } from './liveblocks-plugin-provider.mjs';
 
 detectDupes(PKG_NAME, PKG_VERSION, PKG_FORMAT);
 //# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.mjs","sources":["../src/index.ts"],"sourcesContent":["import { detectDupes } from \"@liveblocks/core\";\n\nimport { PKG_FORMAT, PKG_NAME, PKG_VERSION } from \"./version\";\n\ndetectDupes(PKG_NAME, PKG_VERSION, PKG_FORMAT);\n\nexport {\n  FloatingComposer,\n  OPEN_FLOATING_COMPOSER_COMMAND,\n} from \"./comments/floating-composer\";\nexport { ThreadMarkNode } from \"./comments/thread-mark-node\";\nexport { ThreadPanel } from \"./comments/ThreadPanel\";\nexport { liveblocksConfig } from \"./liveblocks-config\";\nexport { LiveblocksPlugin } from \"./liveblocks-plugin-provider\";\nexport { Mention } from \"./mentions/mention-component\";\nexport { MentionNode } from \"./mentions/mention-node\";\n"],"names":[],"mappings":";;;;;;;;;;AAIA,WAAY,CAAA,QAAA,EAAU,aAAa,UAAU,CAAA"}
+{"version":3,"file":"index.mjs","sources":["../src/index.ts"],"sourcesContent":["import { detectDupes } from \"@liveblocks/core\";\n\nimport { PKG_FORMAT, PKG_NAME, PKG_VERSION } from \"./version\";\n\ndetectDupes(PKG_NAME, PKG_VERSION, PKG_FORMAT);\n\nexport { useIsThreadActive } from \"./comments/comment-plugin-provider\";\nexport {\n  FloatingComposer,\n  OPEN_FLOATING_COMPOSER_COMMAND,\n} from \"./comments/floating-composer\";\nexport { liveblocksConfig } from \"./liveblocks-config\";\nexport {\n  LiveblocksPlugin,\n  useEditorStatus,\n} from \"./liveblocks-plugin-provider\";\n"],"names":[],"mappings":";;;;;;;AAIA,WAAY,CAAA,QAAA,EAAU,aAAa,UAAU,CAAA"}

package/dist/liveblocks-config.js.map

@@ -1 +1 @@
-{"version":3,"file":"liveblocks-config.js","sources":["../src/liveblocks-config.ts"],"sourcesContent":["import type { InitialConfigType } from \"@lexical/react/LexicalComposer\";\n\nimport { ThreadMarkNode } from \"./comments/thread-mark-node\";\nimport { MentionNode } from \"./mentions/mention-node\";\n\nexport function liveblocksConfig(\n  editorConfig: Omit<InitialConfigType, \"editorState\">\n) {\n  const nodes = [...(editorConfig.nodes ?? [])];\n\n  nodes.push(ThreadMarkNode, MentionNode);\n\n  return {\n    ...editorConfig,\n    nodes,\n    editorState: null, // explicitly null because CollabProvider requires it\n  };\n}\n"],"names":["ThreadMarkNode","MentionNode"],"mappings":";;;;;AAKO,SAAS,iBACd,YACA,EAAA;AACA,EAAA,MAAM,QAAQ,CAAC,GAAI,YAAa,CAAA,KAAA,IAAS,EAAG,CAAA,CAAA;AAE5C,EAAM,KAAA,CAAA,IAAA,CAAKA,+BAAgBC,uBAAW,CAAA,CAAA;AAEtC,EAAO,OAAA;AAAA,IACL,GAAG,YAAA;AAAA,IACH,KAAA;AAAA,IACA,WAAa,EAAA,IAAA;AAAA,GACf,CAAA;AACF;;;;"}
+{"version":3,"file":"liveblocks-config.js","sources":["../src/liveblocks-config.ts"],"sourcesContent":["import type { InitialConfigType } from \"@lexical/react/LexicalComposer\";\n\nimport { ThreadMarkNode } from \"./comments/thread-mark-node\";\nimport { MentionNode } from \"./mentions/mention-node\";\n\n/**\n * Function that takes a Lexical editor config and modifies it to add the necessary\n * `nodes` and `theme` to make `LiveblocksPlugin` works correctly.\n *\n * @example\n * import { LexicalComposer } from \"@lexical/react/LexicalComposer\";\n * import { RichTextPlugin } from \"@lexical/react/LexicalRichTextPlugin\";\n * import { ContentEditable } from \"@lexical/react/LexicalContentEditable\";\n * import { LexicalErrorBoundary } from \"@lexical/react/LexicalErrorBoundary\";\n * import { liveblocksConfig, LiveblocksPlugin } from \"@liveblocks/react-lexical\";\n *\n * const initialConfig = liveblocksConfig({\n *   namespace: \"MyEditor\",\n *   theme: {},\n *   nodes: [],\n *   onError: (err) => console.error(err),\n * });\n *\n * function Editor() {\n *   return (\n *     <LexicalComposer initialConfig={initialConfig}>\n *       <LiveblocksPlugin />\n *       <RichTextPlugin\n *         contentEditable={<ContentEditable />}\n *         placeholder={<div>Enter some text...</div>}\n *         ErrorBoundary={LexicalErrorBoundary}\n *       />\n *     </LexicalComposer>\n *   );\n * }\n */\nexport function liveblocksConfig(\n  editorConfig: Omit<InitialConfigType, \"editorState\">\n) {\n  const nodes = [...(editorConfig.nodes ?? [])];\n\n  nodes.push(ThreadMarkNode, MentionNode);\n\n  return {\n    ...editorConfig,\n    nodes,\n    editorState: null, // explicitly null because CollabProvider requires it\n  };\n}\n"],"names":["ThreadMarkNode","MentionNode"],"mappings":";;;;;AAoCO,SAAS,iBACd,YACA,EAAA;AACA,EAAA,MAAM,QAAQ,CAAC,GAAI,YAAa,CAAA,KAAA,IAAS,EAAG,CAAA,CAAA;AAE5C,EAAM,KAAA,CAAA,IAAA,CAAKA,+BAAgBC,uBAAW,CAAA,CAAA;AAEtC,EAAO,OAAA;AAAA,IACL,GAAG,YAAA;AAAA,IACH,KAAA;AAAA,IACA,WAAa,EAAA,IAAA;AAAA,GACf,CAAA;AACF;;;;"}

package/dist/liveblocks-config.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"liveblocks-config.mjs","sources":["../src/liveblocks-config.ts"],"sourcesContent":["import type { InitialConfigType } from \"@lexical/react/LexicalComposer\";\n\nimport { ThreadMarkNode } from \"./comments/thread-mark-node\";\nimport { MentionNode } from \"./mentions/mention-node\";\n\nexport function liveblocksConfig(\n  editorConfig: Omit<InitialConfigType, \"editorState\">\n) {\n  const nodes = [...(editorConfig.nodes ?? [])];\n\n  nodes.push(ThreadMarkNode, MentionNode);\n\n  return {\n    ...editorConfig,\n    nodes,\n    editorState: null, // explicitly null because CollabProvider requires it\n  };\n}\n"],"names":[],"mappings":";;;AAKO,SAAS,iBACd,YACA,EAAA;AACA,EAAA,MAAM,QAAQ,CAAC,GAAI,YAAa,CAAA,KAAA,IAAS,EAAG,CAAA,CAAA;AAE5C,EAAM,KAAA,CAAA,IAAA,CAAK,gBAAgB,WAAW,CAAA,CAAA;AAEtC,EAAO,OAAA;AAAA,IACL,GAAG,YAAA;AAAA,IACH,KAAA;AAAA,IACA,WAAa,EAAA,IAAA;AAAA,GACf,CAAA;AACF;;;;"}
+{"version":3,"file":"liveblocks-config.mjs","sources":["../src/liveblocks-config.ts"],"sourcesContent":["import type { InitialConfigType } from \"@lexical/react/LexicalComposer\";\n\nimport { ThreadMarkNode } from \"./comments/thread-mark-node\";\nimport { MentionNode } from \"./mentions/mention-node\";\n\n/**\n * Function that takes a Lexical editor config and modifies it to add the necessary\n * `nodes` and `theme` to make `LiveblocksPlugin` works correctly.\n *\n * @example\n * import { LexicalComposer } from \"@lexical/react/LexicalComposer\";\n * import { RichTextPlugin } from \"@lexical/react/LexicalRichTextPlugin\";\n * import { ContentEditable } from \"@lexical/react/LexicalContentEditable\";\n * import { LexicalErrorBoundary } from \"@lexical/react/LexicalErrorBoundary\";\n * import { liveblocksConfig, LiveblocksPlugin } from \"@liveblocks/react-lexical\";\n *\n * const initialConfig = liveblocksConfig({\n *   namespace: \"MyEditor\",\n *   theme: {},\n *   nodes: [],\n *   onError: (err) => console.error(err),\n * });\n *\n * function Editor() {\n *   return (\n *     <LexicalComposer initialConfig={initialConfig}>\n *       <LiveblocksPlugin />\n *       <RichTextPlugin\n *         contentEditable={<ContentEditable />}\n *         placeholder={<div>Enter some text...</div>}\n *         ErrorBoundary={LexicalErrorBoundary}\n *       />\n *     </LexicalComposer>\n *   );\n * }\n */\nexport function liveblocksConfig(\n  editorConfig: Omit<InitialConfigType, \"editorState\">\n) {\n  const nodes = [...(editorConfig.nodes ?? [])];\n\n  nodes.push(ThreadMarkNode, MentionNode);\n\n  return {\n    ...editorConfig,\n    nodes,\n    editorState: null, // explicitly null because CollabProvider requires it\n  };\n}\n"],"names":[],"mappings":";;;AAoCO,SAAS,iBACd,YACA,EAAA;AACA,EAAA,MAAM,QAAQ,CAAC,GAAI,YAAa,CAAA,KAAA,IAAS,EAAG,CAAA,CAAA;AAE5C,EAAM,KAAA,CAAA,IAAA,CAAK,gBAAgB,WAAW,CAAA,CAAA;AAEtC,EAAO,OAAA;AAAA,IACL,GAAG,YAAA;AAAA,IACH,KAAA;AAAA,IACA,WAAa,EAAA,IAAA;AAAA,GACf,CAAA;AACF;;;;"}