@meowdown/core 0.77.0 → 0.78.1

package/README.md

@@ -81,10 +81,6 @@ over a selection wraps it into an open wikilink (`[[selection`) with the
 wikilink menu searching it. `EDITOR_KEY_BINDINGS` exports this table as a
 literal object for host settings UIs.
 
-## Round-trip fidelity
-
-[`checkRoundTrip(markdown)`](https://npmx.dev/package-docs/@meowdown%2Fcore#function-checkRoundTrip) reports how faithfully Markdown survives a parse-then-serialize round trip: `'exact'`, `'normalizing'`, or `'lossy'`.
-
 ## Styling
 
 `@meowdown/core/style.css` ships a default theme. Colors use `light-dark()`, so they follow the page's `color-scheme` (set `color-scheme: light dark` on `:root` for automatic dark mode). Override the `--meowdown-*` variables on `:root` or any ancestor; the full list, with a one-line description and default for each, lives in the commented `:root` block at the top of `style.css`, which is the single source of truth.

package/dist/index.d.ts

@@ -1,8 +1,9 @@
+import { CheckRoundTripOptions, RoundTripFidelity, checkRoundTrip } from "@meowdown/markdown";
 import { Editor, Extension, ExtractMarkBuilders, ExtractNodeBuilders, PlainExtension, Priority, Union, withPriority } from "@prosekit/core";
 import { CodeBlockAttrs, CodeBlockAttrs as CodeBlockAttrs$1, defineCodeBlockPreviewPlugin, isCodeBlockPreviewHiddenDecoration } from "@prosekit/extensions/code-block";
 import { PlaceholderOptions, PlaceholderOptions as PlaceholderOptions$1, definePlaceholder } from "@prosekit/extensions/placeholder";
-import { Command, EditorState, PluginKey } from "@prosekit/pm/state";
 import { SearchStatus, SearchStatusHandler, defineSearchStatusHandler, getSearchStatus } from "@prosekit/extensions/search";
+import { Command, EditorState, PluginKey } from "@prosekit/pm/state";
 import { EditorView } from "@prosekit/pm/view";
 import { EditorNode, Mark, ProseMirrorNode } from "@prosekit/pm/model";
 import { ListAttrs } from "@prosekit/extensions/list";
@@ -12,35 +13,6 @@ import { YouTubeVideoClickEvent } from "@meowdown/embed/youtube";
 import { render } from "katex";
 import { XPost, YouTubeVideo } from "@post-embed/types";
 import { VirtualElement } from "@floating-ui/dom";
-//#region src/extensions/readonly.d.ts
-export declare function defineReadonly(getReadonly?: (state: EditorState) => boolean): PlainExtension;
-//#endregion
-//#region src/converters/check-roundtrip.d.ts
-/**
- * How faithfully markdown survives a parse-then-serialize round trip:
- * - `exact`: byte-identical (modulo the trailing newline).
- * - `normalizing`: bytes differ, but only as layout the parser reads back
- *   through - every content line survives and the output re-parses to the same
- *   document (e.g. a lazy continuation re-indented, or `>>>>>>> x` respaced to
- *   the seven blockquotes it already meant).
- * - `lossy`: content changed - a content line differs or disappeared, or the
- *   output re-parses to a different document.
- */
-type RoundTripFidelity = 'exact' | 'normalizing' | 'lossy';
-/**
- * Options for {@link checkRoundTrip}.
- */
-interface CheckRoundTripOptions {
-  /**
-   * Whether to handle a leading `---` frontmatter block. Off by default.
-   */
-  frontmatter?: boolean;
-}
-/**
- * Classify how `markdown` survives the editor's parse-then-serialize round trip.
- */
-export declare function checkRoundTrip(markdown: string, options?: CheckRoundTripOptions): RoundTripFidelity;
-//#endregion
 //#region src/extensions/frontmatter.d.ts
 /**
  * The raw YAML frontmatter body, stored verbatim (the text between the opening
@@ -1039,7 +1011,12 @@ interface FileLinkOptions {
 /**
  * Host options that influence source-backed inline atom parsing.
  */
-type InlineMarkOptions = FileLinkOptions & WikiEmbedOptions & WikilinkOptions;
+type InlineMarkOptions = FileLinkOptions & WikiEmbedOptions & WikilinkOptions & {
+  /**
+   * Definitions supplied by the containing document.
+   */
+  referenceDefinitions?: ReferenceDefinitions;
+};
 interface InlineMarkContext {
   /**
    * Effective document-wide definitions, keyed by normalized reference label.
@@ -1153,7 +1130,7 @@ declare function defineEditorExtensionImpl(options: EditorExtensionOptions): imp
 }>, import("@prosekit/core").Extension<{
   Nodes: {
     list: {
-      taskMarker?: TaskMarker;
+      taskMarker?: "x" | "X" | null;
     };
   };
 }>, import("@prosekit/core").Extension<{
@@ -1362,19 +1339,7 @@ interface DocToMarkdownOptions {
   frontmatter?: boolean;
 }
 /**
- * Convert a ProseMirror document into a Markdown string.
- *
- * Performance design:
- * - Output accumulates in a `string[]` buffer; joined once at the end.
- *   Avoids per-block intermediate strings while keeping the
- *   function-per-node-type readability of a switch dispatch.
- * - Indent stack lives as a mutable `linePrefix` on the buffer object,
- *   restored via local variables across nested calls - no fresh
- *   context objects per recursion.
- * - Inline content is walked directly (not via `node.textContent`) to
- *   skip one intermediate string allocation per leaf block.
- * - Backtick fence width and cell escaping use single linear loops, no
- *   regex on the hot path.
+ * Convert persisted editor content to Markdown through the shared block serializer.
  */
 export declare function docToMarkdown(node: ProseMirrorNode, options?: DocToMarkdownOptions): string;
 //#endregion
@@ -1549,6 +1514,9 @@ declare const NODE_NAMES: readonly ["doc", "text", "paragraph", "heading", "bloc
 type NodeName = (typeof NODE_NAMES)[number];
 export declare function isNodeOfType(node: ProseMirrorNode, name: NodeName): boolean;
 //#endregion
+//#region src/extensions/readonly.d.ts
+export declare function defineReadonly(getReadonly?: (state: EditorState) => boolean): PlainExtension;
+//#endregion
 //#region src/extensions/substitution.d.ts
 /**
  * Apply the editor's automatic plain-text substitutions.
@@ -1689,4 +1657,37 @@ export declare function getSelectedText(state: EditorState): string;
  */
 export declare function getVirtualElementFromRange(view: EditorView, range: PositionRange): VirtualElement;
 //#endregion
-export { type AcceptPendingReplacementOptions, type CheckRoundTripOptions, type CodeBlockAttrs, type CodeBlockFenceStyle, type CodeToken, type DocToMarkdownOptions, type EditorConfig, type EditorExtension, type EditorExtensionOptions, type ExitBoundaryHandler, type ExitBoundaryOptions, type FileClickHandler, type FileClickPayload, type FileInfo, type FileInfoResolver, type FileLinkOptions, type FileLinkPayload, type FileLinkResolver, type FilePasteHandler, type FilePasteOptions, type FileSaveErrorHandler, type FileViewOptions, type FollowLinkHandlers, type ImageClickHandler, type ImageClickPayload, type ImageOptions, type ImageUrlResolver, type InlineMarkContext, type InlineMarkOptions, type KaTeXRender, type LanguageItem, type LinkAttrs, type LinkClickHandler, type LinkClickPayload, type LinkCopyHandler, type LinkCopyPayload, type LinkEditHandler, type LinkEditOptions, type LinkHoverHandler, type LinkHoverOptions, type LinkPreview, type LinkPreviewResolver, type LinkUnit, type ListMarker, type MarkChunk, type MarkMode, type MarkName, type MarkdownToDocOptions, type MdFileAttrs, type MdImageAttrs, type MdLinkTextAttrs, type MdMathAttrs, type MdWikilinkAttrs, type MeowdownCodeBlockAttrs, type MeowdownHTMLCommentAttrs, type MeowdownListAttrs, type MeowdownTableCellAttrs, type NodeName, type ParsedWikiEmbed, type PendingReplacement, type PendingReplacementEvent, type PendingReplacementHandler, type PendingReplacementMode, type PendingReplacementOutcome, type PlaceholderOptions, type PositionRange, type PostEmbedSnapshot, Priority, type ReferenceDefinition, type ReferenceDefinitionIndex, type ReferenceDefinitions, type RoundTripFidelity, type SearchStatus, type SearchStatusHandler, type StartPendingReplacementOptions, type TableColumnAlign, type TagClickHandler, type TagClickPayload, type TypedEditor, type TypedMarkBuilders, type VirtualElement, type WikiEmbedOptions, type WikiEmbedResolution, type WikiEmbedResolver, type WikilinkClickHandler, type WikilinkClickPayload, type WikilinkHoverHandler, type WikilinkHoverHit, type WikilinkOptions, type WikilinkPayload, type WikilinkResolution, type WikilinkResolver, type XPostMediaClickHandler, type XPostResolver, type YouTubeVideoClickHandler, type YouTubeVideoResolver, defineCodeBlockPreviewPlugin, definePlaceholder, defineSearchStatusHandler, getSearchStatus, isCodeBlockPreviewHiddenDecoration, withPriority };
+//#region src/converters/paragraph.d.ts
+/**
+ * Build one paragraph without interpreting block-opening Markdown.
+ */
+export declare function paragraphMarkdownToDoc(markdown: string, nodes?: TypedNodeBuilders): ProseMirrorNode;
+/**
+ * Flatten textblocks into one paragraph's source content.
+ */
+export declare function docToParagraphMarkdown(doc: ProseMirrorNode): string;
+//#endregion
+//#region src/extensions/single-paragraph.d.ts
+/**
+ * Keep editing and pasted content within one paragraph.
+ * Opt into this extension for inline Markdown fields such as task paragraphs.
+ * Register it alongside `defineMeowdown`, seed content with
+ * `paragraphMarkdownToDoc`, and read edits with `docToParagraphMarkdown`.
+ * Ordinary note editors should keep their full document behavior.
+ *
+ * Text input stays literal, before block input rules can consume prefixes.
+ * Transactions and pasted blocks flatten to paragraph text separated by soft
+ * lines. Reference definitions come from `referenceDefinitions` in the editor
+ * config; definition-looking content in the field remains visible literal text.
+ * Enter/submit, focus, and persistence remain the caller's responsibility.
+ *
+ * @example
+ * const editor = createEditor({
+ *   extension: union(defineMeowdown({ referenceDefinitions }), defineSingleParagraph()),
+ *   defaultContent: paragraphMarkdownToDoc('Buy **milk**'),
+ * })
+ * const markdown = docToParagraphMarkdown(editor.state.doc)
+ */
+export declare function defineSingleParagraph(): PlainExtension;
+//#endregion
+export { type AcceptPendingReplacementOptions, type CheckRoundTripOptions, type CodeBlockAttrs, type CodeBlockFenceStyle, type CodeToken, type DocToMarkdownOptions, type EditorConfig, type EditorExtension, type EditorExtensionOptions, type ExitBoundaryHandler, type ExitBoundaryOptions, type FileClickHandler, type FileClickPayload, type FileInfo, type FileInfoResolver, type FileLinkOptions, type FileLinkPayload, type FileLinkResolver, type FilePasteHandler, type FilePasteOptions, type FileSaveErrorHandler, type FileViewOptions, type FollowLinkHandlers, type ImageClickHandler, type ImageClickPayload, type ImageOptions, type ImageUrlResolver, type InlineMarkContext, type InlineMarkOptions, type KaTeXRender, type LanguageItem, type LinkAttrs, type LinkClickHandler, type LinkClickPayload, type LinkCopyHandler, type LinkCopyPayload, type LinkEditHandler, type LinkEditOptions, type LinkHoverHandler, type LinkHoverOptions, type LinkPreview, type LinkPreviewResolver, type LinkUnit, type ListMarker, type MarkChunk, type MarkMode, type MarkName, type MarkdownToDocOptions, type MdFileAttrs, type MdImageAttrs, type MdLinkTextAttrs, type MdMathAttrs, type MdWikilinkAttrs, type MeowdownCodeBlockAttrs, type MeowdownHTMLCommentAttrs, type MeowdownListAttrs, type MeowdownTableCellAttrs, type NodeName, type ParsedWikiEmbed, type PendingReplacement, type PendingReplacementEvent, type PendingReplacementHandler, type PendingReplacementMode, type PendingReplacementOutcome, type PlaceholderOptions, type PositionRange, type PostEmbedSnapshot, Priority, type ReferenceDefinition, type ReferenceDefinitionIndex, type ReferenceDefinitions, type RoundTripFidelity, type SearchStatus, type SearchStatusHandler, type StartPendingReplacementOptions, type TableColumnAlign, type TagClickHandler, type TagClickPayload, type TypedEditor, type TypedMarkBuilders, type VirtualElement, type WikiEmbedOptions, type WikiEmbedResolution, type WikiEmbedResolver, type WikilinkClickHandler, type WikilinkClickPayload, type WikilinkHoverHandler, type WikilinkHoverHit, type WikilinkOptions, type WikilinkPayload, type WikilinkResolution, type WikilinkResolver, type XPostMediaClickHandler, type XPostResolver, type YouTubeVideoClickHandler, type YouTubeVideoResolver, checkRoundTrip, defineCodeBlockPreviewPlugin, definePlaceholder, defineSearchStatusHandler, getSearchStatus, isCodeBlockPreviewHiddenDecoration, withPriority };