@ekz/lexical-markdown 0.40.0

package/importTextFormatTransformer.d.ts

@@ -0,0 +1,21 @@
+/**
+ * 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 { TextFormatTransformersIndex } from './MarkdownImport';
+import type { TextFormatTransformer } from './MarkdownTransformers';
+import type { TextNode } from '@ekz/lexical';
+export declare function findOutermostTextFormatTransformer(textNode: TextNode, textFormatTransformersIndex: TextFormatTransformersIndex): {
+    startIndex: number;
+    endIndex: number;
+    transformer: TextFormatTransformer;
+    match: RegExpMatchArray;
+} | null;
+export declare function importTextFormatTransformer(textNode: TextNode, startIndex: number, endIndex: number, transformer: TextFormatTransformer, match: RegExpMatchArray): {
+    transformedNode: TextNode;
+    nodeBefore: TextNode | undefined;
+    nodeAfter: TextNode | undefined;
+};

package/importTextMatchTransformer.d.ts

@@ -0,0 +1,20 @@
+/**
+ * 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 { TextMatchTransformer } from './MarkdownTransformers';
+import { type TextNode } from '@ekz/lexical';
+export declare function findOutermostTextMatchTransformer(textNode_: TextNode, textMatchTransformers: Array<TextMatchTransformer>): {
+    startIndex: number;
+    endIndex: number;
+    transformer: TextMatchTransformer;
+    match: RegExpMatchArray;
+} | null;
+export declare function importFoundTextMatchTransformer(textNode: TextNode, startIndex: number, endIndex: number, transformer: TextMatchTransformer, match: RegExpMatchArray): {
+    transformedNode?: TextNode;
+    nodeBefore: TextNode | undefined;
+    nodeAfter: TextNode | undefined;
+} | null;

package/importTextTransformers.d.ts

@@ -0,0 +1,24 @@
+/**
+ * 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 { TextFormatTransformersIndex } from './MarkdownImport';
+import type { TextMatchTransformer } from './MarkdownTransformers';
+import { type LexicalNode, type TextNode } from '@ekz/lexical';
+/**
+ * Returns true if the node can contain transformable markdown.
+ * Code nodes cannot contain transformable markdown.
+ * For example, `code **bold**` should not be transformed to
+ * <code>code <strong>bold</strong></code>.
+ */
+export declare function canContainTransformableMarkdown(node: LexicalNode | undefined): node is TextNode;
+/**
+ * Handles applying both text format and text match transformers.
+ * It finds the outermost text format or text match and applies it,
+ * then recursively calls itself to apply the next outermost transformer,
+ * until there are no more transformers to apply.
+ */
+export declare function importTextTransformers(textNode: TextNode, textFormatTransformersIndex: TextFormatTransformersIndex, textMatchTransformers: Array<TextMatchTransformer>): void;

package/index.d.ts

@@ -0,0 +1,23 @@
+/**
+ * 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 { ElementTransformer, MultilineElementTransformer, TextFormatTransformer, TextMatchTransformer, Transformer } from './MarkdownTransformers';
+import type { ElementNode } from '@ekz/lexical';
+import { registerMarkdownShortcuts } from './MarkdownShortcuts';
+import { BOLD_ITALIC_STAR, BOLD_ITALIC_UNDERSCORE, BOLD_STAR, BOLD_UNDERSCORE, CHECK_LIST, CODE, ELEMENT_TRANSFORMERS, HEADING, HIGHLIGHT, INLINE_CODE, ITALIC_STAR, ITALIC_UNDERSCORE, LINK, MULTILINE_ELEMENT_TRANSFORMERS, ORDERED_LIST, QUOTE, STRIKETHROUGH, TEXT_FORMAT_TRANSFORMERS, TEXT_MATCH_TRANSFORMERS, TRANSFORMERS, UNORDERED_LIST } from './MarkdownTransformers';
+/**
+ * Renders markdown from a string. The selection is moved to the start after the operation.
+ *
+ *  @param {boolean} [shouldPreserveNewLines] By setting this to true, new lines will be preserved between conversions
+ *  @param {boolean} [shouldMergeAdjacentLines] By setting this to true, adjacent non empty lines will be merged according to commonmark spec: https://spec.commonmark.org/0.24/#example-177. Not applicable if shouldPreserveNewLines = true.
+ */
+declare function $convertFromMarkdownString(markdown: string, transformers?: Array<Transformer>, node?: ElementNode, shouldPreserveNewLines?: boolean, shouldMergeAdjacentLines?: boolean): void;
+/**
+ * Renders string from markdown. The selection is moved to the start after the operation.
+ */
+declare function $convertToMarkdownString(transformers?: Array<Transformer>, node?: ElementNode, shouldPreserveNewLines?: boolean): string;
+export { $convertFromMarkdownString, $convertToMarkdownString, BOLD_ITALIC_STAR, BOLD_ITALIC_UNDERSCORE, BOLD_STAR, BOLD_UNDERSCORE, CHECK_LIST, CODE, ELEMENT_TRANSFORMERS, type ElementTransformer, HEADING, HIGHLIGHT, INLINE_CODE, ITALIC_STAR, ITALIC_UNDERSCORE, LINK, MULTILINE_ELEMENT_TRANSFORMERS, type MultilineElementTransformer, ORDERED_LIST, QUOTE, registerMarkdownShortcuts, STRIKETHROUGH, TEXT_FORMAT_TRANSFORMERS, TEXT_MATCH_TRANSFORMERS, type TextFormatTransformer, type TextMatchTransformer, type Transformer, TRANSFORMERS, UNORDERED_LIST, };

package/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "@ekz/lexical-markdown",
+  "description": "This package contains Markdown helpers and functionality for Lexical.",
+  "keywords": [
+    "lexical",
+    "editor",
+    "rich-text",
+    "markdown"
+  ],
+  "license": "MIT",
+  "version": "0.40.0",
+  "main": "LexicalMarkdown.js",
+  "types": "index.d.ts",
+  "dependencies": {
+    "@ekz/lexical-code": "0.40.0",
+    "@ekz/lexical-link": "0.40.0",
+    "@ekz/lexical-list": "0.40.0",
+    "@ekz/lexical-rich-text": "0.40.0",
+    "@ekz/lexical-text": "0.40.0",
+    "@ekz/lexical-utils": "0.40.0",
+    "@ekz/lexical": "0.40.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/facebook/lexical.git",
+    "directory": "packages/lexical-markdown"
+  },
+  "module": "LexicalMarkdown.mjs",
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./index.d.ts",
+        "development": "./LexicalMarkdown.dev.mjs",
+        "production": "./LexicalMarkdown.prod.mjs",
+        "node": "./LexicalMarkdown.node.mjs",
+        "default": "./LexicalMarkdown.mjs"
+      },
+      "require": {
+        "types": "./index.d.ts",
+        "development": "./LexicalMarkdown.dev.js",
+        "production": "./LexicalMarkdown.prod.js",
+        "default": "./LexicalMarkdown.js"
+      }
+    }
+  }
+}

package/utils.d.ts

@@ -0,0 +1,35 @@
+/**
+ * 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 ElementNode, type LexicalNode, type TextFormatType } from '@ekz/lexical';
+import { ElementTransformer, MultilineElementTransformer, TextFormatTransformer, TextMatchTransformer, Transformer } from './MarkdownTransformers';
+type MarkdownFormatKind = 'noTransformation' | 'paragraphH1' | 'paragraphH2' | 'paragraphH3' | 'paragraphH4' | 'paragraphH5' | 'paragraphH6' | 'paragraphBlockQuote' | 'paragraphUnorderedList' | 'paragraphOrderedList' | 'paragraphCodeBlock' | 'horizontalRule' | 'bold' | 'code' | 'italic' | 'underline' | 'strikethrough' | 'italic_bold' | 'strikethrough_italic' | 'strikethrough_bold' | 'strikethrough_italic_bold' | 'link';
+type MarkdownCriteria = Readonly<{
+    export?: (node: LexicalNode, traverseChildren: (elementNode: ElementNode) => string) => string | null;
+    exportFormat?: TextFormatType;
+    exportTag?: string;
+    exportTagClose?: string;
+    markdownFormatKind: MarkdownFormatKind | null | undefined;
+    regEx: RegExp;
+    regExForAutoFormatting: RegExp;
+    requiresParagraphStart: boolean | null | undefined;
+}>;
+type MarkdownCriteriaArray = Array<MarkdownCriteria>;
+export declare function getAllMarkdownCriteriaForParagraphs(): MarkdownCriteriaArray;
+export declare function getAllMarkdownCriteriaForTextNodes(): MarkdownCriteriaArray;
+export declare function indexBy<T>(list: Array<T>, callback: (arg0: T) => string | undefined): Readonly<Record<string, Array<T>>>;
+export declare function transformersByType(transformers: Array<Transformer>): Readonly<{
+    element: Array<ElementTransformer>;
+    multilineElement: Array<MultilineElementTransformer>;
+    textFormat: Array<TextFormatTransformer>;
+    textMatch: Array<TextMatchTransformer>;
+}>;
+export declare const PUNCTUATION_OR_SPACE: RegExp;
+export declare const WHITESPACE: RegExp;
+export declare const PUNCTUATION: RegExp;
+export declare function isEmptyParagraph(node: LexicalNode): boolean;
+export {};