@godxjp/markdown 33.21.0 → 33.22.1

package/dist/index.d.ts

@@ -1,218 +1,15 @@
 import * as React from 'react';
-import { Options as Options$1, Components } from 'react-markdown';
-import { Root } from 'hast';
-import { Options } from 'rehype-sanitize';
+import { f as MarkdownProps } from './fixtures-CKcZEUes.js';
+export { D as DirectiveBlock, a as DirectiveRenderProps, b as DirectiveRenderer, H as HeadingIdResolver, c as HeadingInfo, M as MARKDOWN_FIXTURES, d as MARKDOWN_FORMAT, e as MarkdownFixture, g as MermaidDiagram, h as MermaidDiagramProps, i as MermaidSvgCheck, R as RENDERER_VERSION, S as SchemaExtension, j as checkMermaidSvg, k as extendSchema, m as markdownSchema, r as rehypeHeadingIds, s as safeUrl } from './fixtures-CKcZEUes.js';
+import 'react-markdown';
+import 'hast';
+import 'rehype-sanitize';
 
-/** What a host is told about each heading, in document order. */
-type HeadingInfo = {
-    depth: number;
-    text: string;
-    index: number;
-};
 /**
- * Chooses a heading's anchor. Return `undefined` to give the heading no id.
- *
- * The default is GitHub's slug (`github-slugger`, the same rule `rehype-slug` uses), de-duplicated
- * in document order (`a`, `a-1`, `a-2`). A host whose server already assigned anchors (godx-task
- * keeps its outline server-side, so a link and the page agree) passes its own: computing "the same"
- * slug in two languages is one rule written twice, and it drifts.
+ * THE ONE RENDERER (gh#1108) — the deterministic entry: math and code colour are drawn in the same
+ * synchronous render, on a server, in a Worker and in a browser alike. `@godxjp/markdown/lazy` is
+ * the same component with those two engines loaded only when a body needs them.
  */
-type HeadingIdResolver = (heading: HeadingInfo) => string | undefined;
-/** rehype plugin: an `id` on every heading. Runs BEFORE the sanitiser, which allows `id` on h1–h6. */
-declare function rehypeHeadingIds(options?: {
-    resolve?: HeadingIdResolver;
-}): (tree: Root) => void;
+declare function Markdown(props: MarkdownProps): React.JSX.Element;
 
-/**
- * THE ONE SANITISER SCHEMA (gh#1108). godx-task and godx-content each carried their own copy of
- * this; every consumer now renders through this one, so a policy change happens once.
- *
- * Built on `rehype-sanitize`'s `defaultSchema` (GitHub's), with three deliberate changes:
- *
- * - `clobberPrefix: ""`. The default re-prefixes every `id`, but remark-gfm already writes footnote
- *   ids and their `href`s as a matched `user-content-` pair, so the second prefix split the pair and
- *   footnote links went nowhere (measured in godx-task). The clobber exists to stop a body minting
- *   an id that collides with the host's; this renderer never parses raw HTML (no `rehype-raw`), so
- *   the only ids in the tree are the ones the pipeline generated. `raw-html.test` pins that.
- * - `protocols`: links and images allow only `http`, `https`, `mailto` (links) and relative URLs.
- *   `javascript:`, `data:`, `vbscript:` and every other scheme are dropped.
- * - Task-list checkboxes stay `disabled` (the default): ticking one would be a write to the body.
- * - KaTeX's output (math.ts `katexSchema`: MathML, its own classes, geometry-only inline styles,
- *   `svg` paths for radicals and stretchy arrows) and the code tokens (`data-code-token`, the kit's
- *   twelve names) — both produced by the pipeline before this schema judges them (renderer v6).
- *
- * Hosts extend it with `extendSchema`, never by editing a copy.
- */
-declare const markdownSchema: Options;
-/** Extra tags / attributes a host needs (a callout marker, a section element). Additive only. */
-type SchemaExtension = {
-    tagNames?: string[];
-    attributes?: Record<string, NonNullable<Options["attributes"]>[string]>;
-};
-/**
- * The schema plus a host's additions. ADDITIVE: an extension can allow a tag or an attribute, never
- * widen `protocols` or bring raw HTML back, so a consumer cannot loosen the URL policy by accident.
- *
- * A rule for an attribute the base ALREADY constrains is MERGED into that rule (gh#1116): the
- * sanitiser reads the first rule it finds for an attribute, so appending `["className",
- * "math-inline"]` beside the default `["className", /^language-./]` was silently ignored and the
- * formula class stripped. Merged, it is one rule allowing both. An attribute the base allows with
- * no value constraint stays unconstrained.
- */
-declare function extendSchema(extension?: SchemaExtension): Options;
-/**
- * react-markdown's `urlTransform`, with the same allow-list as the schema, so a URL is checked
- * where it is written as well as where it is sanitised. Relative URLs (`/x`, `x`, `#a`, `?q`) pass;
- * a scheme outside the list becomes `""`. A host scheme such as `asset:` is resolved by the host's
- * `resolveUrl` BEFORE this check, so it can only turn into an allowed URL or be dropped.
- */
-declare function safeUrl(url: string, key: string): string;
-
-/** GitHub alert kinds, the only callouts v1 knows. Serialized uppercase. */
-declare const CALLOUT_KINDS: readonly ["note", "tip", "important", "warning", "caution"];
-type CalloutKind = (typeof CALLOUT_KINDS)[number];
-
-type PluggableList = NonNullable<Options$1["remarkPlugins"]>;
-/**
- * The stored body's format, and the renderer generation that produced its output. A consumer
- * records both on every saved version (content-media contracts § 6.6) and never re-interprets an
- * old version under a different format. `RENDERER_VERSION` moves when the SAME input renders
- * differently — a schema change, a new default plugin — not on every release.
- */
-declare const MARKDOWN_FORMAT = "md";
-declare const RENDERER_VERSION = 6;
-type MarkdownProps = {
-    /** The Markdown source. */
-    children: string;
-    /**
-     * remark plugins run after GFM (a callout or embed marker plugin). Whatever they emit still goes
-     * through the sanitiser, so a marker attribute must be allowed with `schema`.
-     */
-    remarkPlugins?: PluggableList;
-    /**
-     * rehype plugins run AFTER the sanitiser, on a tree that is already safe. Presentation only: a
-     * plugin here must not introduce URLs, raw HTML or event handlers — it is past the gate.
-     */
-    rehypePlugins?: PluggableList;
-    /** Tags / attributes a host plugin needs. Additive; cannot widen the URL policy. */
-    schema?: SchemaExtension;
-    /**
-     * Element overrides (react-markdown `components`). A host `pre` renders every fence EXCEPT
-     * ```mermaid, which is drawn through the gate first; `mermaid={false}` hands those to it too.
-     */
-    components?: Components;
-    /**
-     * Resolves a host-specific URL (`asset:…`, a wiki link) to a real one. Runs before the sanitiser
-     * and the scheme allow-list, so whatever it returns is still checked; `undefined` keeps the URL.
-     */
-    resolveUrl?: (url: string, key: "href" | "src" | string) => string | undefined;
-    /** Heading anchors: GitHub slugs by default; a host with server-side anchors supplies its own. */
-    headingId?: HeadingIdResolver;
-    /**
-     * Render ```mermaid fences as gated diagrams (default true). They are drawn BEFORE a host `pre`
-     * is consulted, so a host code renderer keeps Mermaid; `false` hands mermaid fences to the host
-     * `pre` (or plain code) as well (gh#1116).
-     */
-    mermaid?: boolean;
-    /**
-     * Tokenise fenced code in a known language as `<span data-code-token="keyword">` … (default
-     * true), which `Prose` colours. `false` leaves the code as plain text — a host `pre` that runs
-     * its own highlighter.
-     */
-    highlight?: boolean;
-    /**
-     * NARROW the elements a body may produce — an activity feed that shows only inline formatting.
-     * react-markdown's own options, applied after the sanitiser; they can only remove, never allow
-     * what the schema strips (gh#1116).
-     */
-    allowedElements?: Options$1["allowedElements"];
-    disallowedElements?: Options$1["disallowedElements"];
-    allowElement?: Options$1["allowElement"];
-    /** With an element filter: keep a removed element's children (its text) instead of dropping it. */
-    unwrapDisallowed?: boolean;
-    /**
-     * A table cell whose trimmed text has no whitespace and at most this many characters — a code,
-     * an id, a date, 優先度 — is stamped `data-short`, and `Prose` keeps it on one line: CJK otherwise
-     * breaks between any two ideographs in a narrow column (gh#1150). A sentence still wraps.
-     * Characters are user-perceived (grapheme clusters). Default 24; `false` stamps nothing.
-     */
-    shortCellLength?: number | false;
-    /**
-     * Visible callout titles per kind when a callout has none of its own (`> [!WARNING]`). English by
-     * default — this package carries no i18n; a host passes its localized strings.
-     */
-    calloutTitles?: Partial<Record<CalloutKind, string>>;
-    /**
-     * Where an EXTERNAL link opens. An external link is an absolute http(s) URL whose origin differs
-     * from `origin`. `"new-tab"` gives it `target="_blank"` and `rel="noopener noreferrer"`. Relative
-     * links, `#anchors`, wikilinks resolved to a path, and `mailto:` stay in the tab. The default,
-     * `"same-tab"`, changes nothing. Markdown has no syntax for `target`, so this is a renderer policy.
-     */
-    externalLinks?: "same-tab" | "new-tab";
-    /**
-     * The page origin that `externalLinks` compares against. Defaults to `location.origin`. Pass it
-     * when rendering on the server, or every absolute link counts as external there and hydration
-     * disagrees on same-origin ones.
-     */
-    origin?: string;
-};
-/**
- * THE ONE RENDERER (gh#1108). GFM — tables, task lists, fenced code, autolinks, footnotes,
- * strikethrough — plus heading anchors, KaTeX math, highlighted code, sanitised by `markdownSchema`, with ```mermaid drawn only
- * through the SVG gate. Raw HTML in the source is never parsed into elements (no `rehype-raw`): it
- * stays visible text. Output matches `react-markdown` + `remark-gfm` + `rehype-sanitize`, which is
- * what godx-task and godx-content rendered before, so the swap is drop-in.
- *
- * Renders bare elements; the host wraps it (`<Prose>` from `@godxjp/ui/data-display`), so this
- * package carries no UI-kit dependency.
- */
-declare function Markdown({ children, remarkPlugins, rehypePlugins, schema, components, resolveUrl, headingId, mermaid, highlight, allowedElements, disallowedElements, allowElement, unwrapDisallowed, shortCellLength, calloutTitles, externalLinks, origin, }: MarkdownProps): React.JSX.Element;
-
-type MermaidSvgCheck = {
-    ok: true;
-    svg: SVGSVGElement;
-} | {
-    ok: false;
-    reason: string;
-};
-/**
- * Parses `svg` as XML and checks every element and attribute. On success returns the PARSED root,
- * which the caller inserts as a node — never re-serialised into HTML, so what was checked is what
- * is shown (an HTML re-parse of an SVG string can differ from the XML parse: mutation XSS).
- */
-declare function checkMermaidSvg(svg: string): MermaidSvgCheck;
-type MermaidDiagramProps = {
-    /** The fence's text. */
-    source: string;
-    /** Accessible name of the rendered diagram (the figure). */
-    label?: string;
-};
-/**
- * A ```mermaid fence. Shows the code until the diagram has rendered AND passed `checkMermaidSvg`,
- * and keeps showing it if either fails — so the page is never blank and never unsafe.
- */
-declare function MermaidDiagram({ source, label }: MermaidDiagramProps): React.JSX.Element;
-
-/**
- * THE SHARED FIXTURE CORPUS (gh#1108). Input Markdown → the exact sanitised HTML this renderer
- * produces with its defaults. Browser, server and export paths (a PHP exporter included) conform to
- * these rather than to each other: "same output" is checked against one list, not argued about.
- *
- * `hostile` fixtures carry an attack; `forbidden` lists substrings that must never appear in their
- * output, so a schema change that re-opens one fails even if somebody re-blesses the HTML.
- *
- * Changing an expected `html` for an existing input is a renderer change: bump `RENDERER_VERSION`.
- *
- * The HTML is the renderer's, not React's: compare after removing the `<link rel="preload">` React's
- * static renderer adds for each image (`normalizeFixtureHtml` in the tests).
- */
-type MarkdownFixture = {
-    name: string;
-    markdown: string;
-    html: string;
-    hostile?: boolean;
-    forbidden?: string[];
-};
-declare const MARKDOWN_FIXTURES: MarkdownFixture[];
-
-export { type HeadingIdResolver, type HeadingInfo, MARKDOWN_FIXTURES, MARKDOWN_FORMAT, Markdown, type MarkdownFixture, type MarkdownProps, MermaidDiagram, type MermaidDiagramProps, type MermaidSvgCheck, RENDERER_VERSION, type SchemaExtension, checkMermaidSvg, extendSchema, markdownSchema, rehypeHeadingIds, safeUrl };
+export { Markdown, MarkdownProps };