@astryx-vue/core 0.2.3 → 0.2.4

package/dist/{index-DfgHJE7H.d.ts → index-z3uLM1O6.d.ts}

@@ -1,9 +1,94 @@
 import { Component, PropType, VNode, VNodeChild } from "vue";
+//#region src/Markdown/ast.d.ts
+interface MdPoint {
+  offset?: number | null;
+  line?: number;
+  column?: number;
+}
+interface MdPosition {
+  start?: MdPoint;
+  end?: MdPoint;
+}
+interface MdNode {
+  type: string;
+  value?: string;
+  children?: MdNode[];
+  depth?: 1 | 2 | 3 | 4 | 5 | 6;
+  ordered?: boolean;
+  start?: number | null;
+  spread?: boolean | null;
+  checked?: boolean | null;
+  lang?: string | null;
+  url?: string;
+  alt?: string | null;
+  title?: string | null;
+  align?: Array<'left' | 'right' | 'center' | null> | null;
+  identifier?: string;
+  label?: string | null;
+  /** Parser offsets. Used to tell a bare autolink from an explicit link. */
+  position?: MdPosition;
+  /**
+   * Set on `type: 'extension'` nodes a plugin inserts.
+   * `plugin` matches `MarkdownPlugin.name` or `MarkdownInlinePlugin.name`.
+   */
+  plugin?: string;
+  /** Name of an extension node within its plugin. */
+  name?: string;
+  /** `block` extension nodes are rendered as their own block. */
+  display?: 'inline' | 'block';
+  /** Extra fields a plugin wants the renderer to read. Keep values plain. */
+  data?: Readonly<Record<string, string | number | boolean | null>>;
+}
+declare function isMarkdownExtensionNode(node: MdNode, plugin?: string, name?: string): node is MdNode & {
+  type: 'extension';
+  plugin: string;
+  name: string;
+};
+//#endregion
+//#region src/Markdown/plugins.d.ts
+interface MarkdownTransformContext {
+  /** Record a problem. The document still renders. */
+  report: (message: string) => void;
+}
+interface MarkdownPluginRenderContext {
+  /** Render this node's children with the normal Markdown renderers. */
+  renderChildren: () => VNodeChild[];
+}
+/**
+ * A document plugin. `transform` receives the parsed root and returns the next
+ * root. Return the same root when nothing changed so a streaming render can
+ * reuse settled blocks. `render` draws `extension` nodes whose `plugin` equals
+ * `name`.
+ */
+interface MarkdownPlugin {
+  name: string;
+  transform?: (root: MdNode, context: MarkdownTransformContext) => MdNode;
+  render?: (node: MdNode, context: MarkdownPluginRenderContext) => VNodeChild | null;
+}
+/**
+ * A text-node plugin. `pattern` needs the `g` flag. Matches inside inline
+ * code and fenced code never run, because those nodes are not text.
+ * `replace` returns the node for the match, or `null` to skip it.
+ * `render` draws an extension node whose `plugin` equals `name`.
+ */
+interface MarkdownInlinePlugin {
+  name?: string;
+  pattern: RegExp;
+  getEndIndex?: (text: string, match: RegExpMatchArray) => number | false;
+  replace: (match: RegExpMatchArray) => MdNode | null;
+  render?: (node: MdNode, context: MarkdownPluginRenderContext) => VNodeChild | null;
+}
+declare function defineMarkdownPlugin<Plugin extends MarkdownPlugin>(plugin: Plugin): Plugin;
+declare function applyMarkdownPlugins(root: MdNode, plugins?: readonly MarkdownPlugin[]): MdNode;
+declare function applyInlinePlugins(root: MdNode, plugins?: readonly MarkdownInlinePlugin[]): MdNode;
+//#endregion
 //#region src/Markdown/types.d.ts
 type MarkdownDisplay = 'block' | 'inline';
 type MarkdownDensity = 'default' | 'compact';
 type MarkdownAlign = 'start' | 'center';
 type MarkdownHeadingLevel = 1 | 2 | 3 | 4 | 5 | 6;
+type MarkdownAutolink = 'gfm';
+type MarkdownCitationStyle = 'label' | 'number';
 interface MarkdownHeadingProps {
   level: MarkdownHeadingLevel;
   id: string;
@@ -98,9 +183,29 @@ interface MarkdownProps {
    * Called when a link is activated. Return `false` to cancel navigation.
    */
   onLinkClick?: (href: string, event: MouseEvent) => void | false;
+  /**
+   * Document plugins. Each one may replace the parsed tree and draw the
+   * extension nodes it owns. An empty list leaves the document unchanged.
+   */
+  plugins?: readonly MarkdownPlugin[];
+  /**
+   * Patterns matched against text nodes, in order. The first match at a
+   * position wins. Inline code and fenced code are left alone.
+   */
+  inlinePlugins?: readonly MarkdownInlinePlugin[];
+  /**
+   * `'gfm'` links bare `https://` URLs, `www.` hosts, and emails.
+   * Omit it and those stay text. `<https://…>` and `<email>` stay links.
+   */
+  autolink?: MarkdownAutolink;
+  /**
+   * `label` is a chip with the source title. `number` is a compact badge.
+   * @default 'label'
+   */
+  citationStyle?: MarkdownCitationStyle;
   /**
    * Citation sources keyed by id. `[id]` and `【id】` that match a key render
-   * as a label chip instead of literal text.
+   * as a citation chip instead of literal text.
    */
   sources?: Record<string, MarkdownSource>;
 }
@@ -147,6 +252,22 @@ declare const __VLS_export: import("vue").DefineComponent<import("vue").ExtractP
     type: PropType<MarkdownProps["onLinkClick"]>;
     default: undefined;
   };
+  plugins: {
+    type: PropType<MarkdownProps["plugins"]>;
+    default: undefined;
+  };
+  inlinePlugins: {
+    type: PropType<MarkdownProps["inlinePlugins"]>;
+    default: undefined;
+  };
+  autolink: {
+    type: PropType<MarkdownProps["autolink"]>;
+    default: undefined;
+  };
+  citationStyle: {
+    type: PropType<MarkdownProps["citationStyle"]>;
+    default: string;
+  };
   sources: {
     type: PropType<MarkdownProps["sources"]>;
     default: undefined;
@@ -190,44 +311,52 @@ declare const __VLS_export: import("vue").DefineComponent<import("vue").ExtractP
     type: PropType<MarkdownProps["onLinkClick"]>;
     default: undefined;
   };
+  plugins: {
+    type: PropType<MarkdownProps["plugins"]>;
+    default: undefined;
+  };
+  inlinePlugins: {
+    type: PropType<MarkdownProps["inlinePlugins"]>;
+    default: undefined;
+  };
+  autolink: {
+    type: PropType<MarkdownProps["autolink"]>;
+    default: undefined;
+  };
+  citationStyle: {
+    type: PropType<MarkdownProps["citationStyle"]>;
+    default: string;
+  };
   sources: {
     type: PropType<MarkdownProps["sources"]>;
     default: undefined;
   };
 }>> & Readonly<{}>, {
   density: MarkdownDensity | undefined;
-  display: MarkdownDisplay | undefined;
   content: string;
-  contentAlign: MarkdownAlign | undefined;
+  display: MarkdownDisplay | undefined;
   contentWidth: string | number | undefined;
+  contentAlign: MarkdownAlign | undefined;
   components: MarkdownComponents | undefined;
   headingLevelStart: MarkdownHeadingLevel | undefined;
   onLinkClick: ((href: string, event: MouseEvent) => void | false) | undefined;
+  plugins: readonly MarkdownPlugin[] | undefined;
+  inlinePlugins: readonly MarkdownInlinePlugin[] | undefined;
+  autolink: "gfm" | undefined;
+  citationStyle: MarkdownCitationStyle | undefined;
   sources: Record<string, MarkdownSource> | undefined;
   isStreaming: boolean;
 }, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
 //#endregion
-//#region src/Markdown/ast.d.ts
-interface MdNode {
-  type: string;
-  value?: string;
-  children?: MdNode[];
-  depth?: 1 | 2 | 3 | 4 | 5 | 6;
-  ordered?: boolean;
-  start?: number | null;
-  spread?: boolean | null;
-  checked?: boolean | null;
-  lang?: string | null;
-  url?: string;
-  alt?: string | null;
-  title?: string | null;
-  align?: Array<'left' | 'right' | 'center' | null> | null;
-  identifier?: string;
-  label?: string | null;
-}
-//#endregion
 //#region src/Markdown/parse.d.ts
-declare function parseMarkdown(source: string): MdNode;
+interface ParseMarkdownOptions {
+  /**
+   * `'gfm'` keeps GitHub-style bare URLs, `www.` hosts, and emails as links.
+   * Omit it and those stay text. Angle-bracket autolinks stay either way.
+   */
+  autolink?: 'gfm';
+}
+declare function parseMarkdown(source: string, options?: ParseMarkdownOptions): MdNode;
 //#endregion
 //#region src/Markdown/slug.d.ts
 /** URL slug for a heading. Letters and numbers from any language are kept. */
@@ -238,4 +367,4 @@ declare function slugify(value: string): string;
  */
 declare function uniqueSlug(baseSlug: string, counts: Map<string, number>): string;
 //#endregion
-export { MarkdownSlots as _, MarkdownAlign as a, MarkdownDensity as c, MarkdownHeadingProps as d, MarkdownImageProps as f, MarkdownProps as g, MarkdownListProps as h, _default as i, MarkdownDisplay as l, MarkdownLinkProps as m, uniqueSlug as n, MarkdownCodeProps as o, MarkdownInlineCodeProps as p, parseMarkdown as r, MarkdownComponents as s, slugify as t, MarkdownHeadingLevel as u };
+export { MarkdownPlugin as C, applyMarkdownPlugins as D, applyInlinePlugins as E, defineMarkdownPlugin as O, MarkdownInlinePlugin as S, MarkdownTransformContext as T, MarkdownLinkProps as _, _default as a, MarkdownSlots as b, MarkdownCitationStyle as c, MarkdownDensity as d, MarkdownDisplay as f, MarkdownInlineCodeProps as g, MarkdownImageProps as h, parseMarkdown as i, isMarkdownExtensionNode as k, MarkdownCodeProps as l, MarkdownHeadingProps as m, uniqueSlug as n, MarkdownAlign as o, MarkdownHeadingLevel as p, ParseMarkdownOptions as r, MarkdownAutolink as s, slugify as t, MarkdownComponents as u, MarkdownListProps as v, MarkdownPluginRenderContext as w, MarkdownSource as x, MarkdownProps as y };