@meowdown/core 0.68.3 → 0.70.0

package/dist/index.d.ts

@@ -8,7 +8,9 @@ import { EditorView } from "@prosekit/pm/view";
 import { EditorNode, Mark, ProseMirrorNode } from "@prosekit/pm/model";
 import { ListAttrs } from "@prosekit/extensions/list";
 import { HorizontalRuleExtension } from "@prosekit/extensions/horizontal-rule";
+import { Resolver } from "@post-embed/elements/x";
 import { render } from "katex";
+import { XPost, YouTubeVideo } from "@post-embed/types";
 import { VirtualElement } from "@floating-ui/dom";
 //#region src/converters/check-roundtrip.d.ts
 /**
@@ -202,6 +204,10 @@ interface MdImageAttrs {
    * Display height in CSS pixels from the trailing comment, or `null`.
    */
   height: number | null;
+  /**
+   * The saved post-embed snapshot from the trailing comment, or `null`.
+   */
+  snapshot: object | null;
   /**
    * `wikiEmbed` when the source is `![[target]]`; otherwise `null`.
    */
@@ -513,6 +519,7 @@ interface ReferenceDefinitionIndex {
   definitions: ReferenceDefinitions;
   nodes: ReadonlySet<EditorNode>;
 }
+export declare function isReferenceDefinitionNode(node: EditorNode, parent: EditorNode | null, index: number): boolean;
 export declare function collectReferenceDefinitions(doc: EditorNode): ReferenceDefinitionIndex;
 //#endregion
 //#region src/extensions/wiki-embed.d.ts
@@ -1033,62 +1040,6 @@ export declare const codeBlockLanguages: ReadonlyArray<LanguageItem>;
  */
 export declare function defineEmbedPaste(): PlainExtension;
 //#endregion
-//#region src/extensions/embed-types.d.ts
-/**
- * A framework-agnostic description of an embed iframe. Both the editor's DOM
- * mark view and the static React renderer build their own `<iframe>` from it, so
- * the URL/attribute logic lives in one place while each side renders natively.
- */
-interface EmbedDescriptor {
-  readonly kind: 'tweet' | 'youtube';
-  /**
-   * Stable identity for the widget, unique per rendered embed (e.g. the video or
-   * tweet id). Keeps ProseMirror from rebuilding the iframe on every edit, and
-   * keys the React element, so the embed never reloads.
-   */
-  readonly key: string;
-  /**
-   * The iframe `src`.
-   */
-  readonly src: string;
-  /**
-   * The iframe `title`.
-   */
-  readonly title: string;
-  /**
-   * The iframe `class`, e.g. `md-embed md-embed-tweet`.
-   */
-  readonly className: string;
-  /**
-   * The iframe `data-testid`.
-   */
-  readonly testid: string;
-  /**
-   * The iframe `allow` policy, when the embed needs one.
-   */
-  readonly allow?: string;
-  /**
-   * Whether the iframe is fullscreen-capable.
-   */
-  readonly allowFullscreen?: boolean;
-}
-//#endregion
-//#region src/extensions/tweet.d.ts
-/**
- * `Tweet.html` reports its rendered height via `postMessage`; size the iframe to
- * fit and pass each reported height to `onHeight`. Returns a cleanup that
- * removes the listener. The cleanup also runs once the iframe leaves the DOM, so
- * the editor's DOM mark view (which has no destroy hook) is covered, while a
- * React caller can call it on unmount.
- */
-export declare function listenForTweetHeight(iframe: HTMLIFrameElement, onHeight?: (height: number) => void): () => void;
-//#endregion
-//#region src/extensions/embed.d.ts
-/**
- * Detect a tweet/YouTube embed in an image `src`, or `undefined` for a plain image.
- */
-export declare function matchEmbed(src: string): EmbedDescriptor | undefined;
-//#endregion
 //#region src/extensions/exit-boundary.d.ts
 /**
  * Payload for {@link ExitBoundaryHandler}.
@@ -1362,6 +1313,39 @@ interface FollowLinkHandlers {
  */
 export declare function defineFollowLinkHandler(handlers: FollowLinkHandlers): PlainExtension;
 //#endregion
+//#region src/extensions/post-embed.d.ts
+type XPostResolver = Resolver<XPost>;
+type YouTubeVideoResolver = Resolver<YouTubeVideo>;
+type PostEmbedKind = 'x-post' | 'youtube-video';
+/**
+ * The post id of an X status URL, or `undefined` for any other `src`.
+ */
+export declare function parseXPostId(src: string): string | undefined;
+/**
+ * The post-embed card an image `src` renders as, or `undefined` for a plain image.
+ */
+export declare function matchPostEmbed(src: string): PostEmbedKind | undefined;
+export declare const defaultResolveXPost: XPostResolver;
+export declare const defaultResolveYouTubeVideo: YouTubeVideoResolver;
+/**
+ * The `snapshot` field of an image's magic comment: the card kind and the
+ * data post-embed renders. The kind is stored explicitly, so a saved snapshot
+ * is validated once, against the schema it names.
+ */
+type PostEmbedSnapshot = {
+  kind: 'x-post';
+  data: XPost;
+} | {
+  kind: 'youtube-video';
+  data: YouTubeVideo;
+};
+/**
+ * The snapshot a card renders from a saved JSON object, or `undefined` when
+ * the object does not validate. Unknown fields are dropped, so a persisted
+ * snapshot is exactly what the card needs.
+ */
+export declare function parsePostEmbedSnapshot(value: unknown): PostEmbedSnapshot | undefined;
+//#endregion
 //#region src/extensions/image.d.ts
 type ImageUrlResolver = (src: string) => string | undefined;
 /**
@@ -1374,12 +1358,17 @@ interface ImageOptions {
    */
   resolveImageUrl?: ImageUrlResolver;
   /**
-   * Whether to write the height a tweet embed reports back into the trailing
-   * size comment, so the next load can seed the iframe at its final height.
-   * Defaults to `true`; disable when the document must never change without a
-   * user edit (e.g. deterministic tests).
+   * Resolve the data behind an X post URL, rendered as a `post-embed-x-post`
+   * card. Defaults to `defaultResolveXPost`, which fetches through
+   * react-tweet's hosted proxy.
+   */
+  resolveXPost?: XPostResolver;
+  /**
+   * Resolve the data behind a YouTube video URL, rendered as a
+   * `post-embed-youtube-video` card. Defaults to `defaultResolveYouTubeVideo`,
+   * which reads YouTube's oEmbed endpoint.
    */
-  persistTweetHeight?: boolean;
+  resolveYouTubeVideo?: YouTubeVideoResolver;
 }
 /**
  * Show an `src` as-is when it is an http(s) URL, otherwise skip rendering it.
@@ -1640,4 +1629,4 @@ 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 EditorExtension, type EditorExtensionOptions, type EmbedDescriptor, 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 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, 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, defineCodeBlockPreviewPlugin, definePlaceholder, defineReadonly, defineSearchStatusHandler, getSearchStatus, isCodeBlockPreviewHiddenDecoration, withPriority };
+export { type AcceptPendingReplacementOptions, type CheckRoundTripOptions, type CodeBlockAttrs, type CodeBlockFenceStyle, type CodeToken, type DocToMarkdownOptions, 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 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 PostEmbedKind, 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 XPostResolver, type YouTubeVideoResolver, defineCodeBlockPreviewPlugin, definePlaceholder, defineReadonly, defineSearchStatusHandler, getSearchStatus, isCodeBlockPreviewHiddenDecoration, withPriority };