@mirrordown/core 0.1.1 → 0.1.2

package/dist/mermaid-pele-BMyyDozN.mjs

@@ -0,0 +1,92 @@
+// src/mermaid-pele.ts
+/** The class a fenced `mermaid` block's `<code>` takes. */
+const MERMAID_LANGUAGE_CLASS = `language-mermaid`;
+/** The class a `<pre>` holding a diagram written as HTML takes, as Mermaid reads it in the browser. */
+const MERMAID_PRE_CLASS = `mermaid`;
+const hash = (str) => {
+	let h = 2166136261;
+	for (let i = 0; i < str.length; i++) h = Math.imul(h ^ str.charCodeAt(i), 16777619) >>> 0;
+	return h.toString(36);
+};
+/** A diagram's source as Pele reads it: line endings normalized, as markdown-it already has them. */
+const mermaidSource = (text) => text.replace(/\r\n?/g, `\n`);
+/**
+* A document's id prefixes, one per diagram in document order: `prefix`, then a hash of the diagram's source, so a diagram's ids don't change when others are edited, with `-2`, `-3`… for repeats of one diagram. Pele namespaces every id it writes (an accessible title, a gradient) under it. Create one per document.
+*/
+const mermaidIdPrefixes = (prefix) => {
+	const seen = /* @__PURE__ */ new Map();
+	return (source) => {
+		const id = `${prefix}-${hash(source)}`;
+		const count = (seen.get(id) ?? 0) + 1;
+		seen.set(id, count);
+		return count === 1 ? id : `${id}-${count}`;
+	};
+};
+const escapeAttribute = (value) => value.replace(/&/g, `&amp;`).replace(/"/g, `&quot;`);
+const classes = (value) => value.split(/\s+/).filter((name) => name !== `` && name !== MERMAID_LANGUAGE_CLASS && name !== MERMAID_PRE_CLASS);
+/**
+* Pele's `<svg>` with the attributes the diagram's element had (from an attribute block such as `{#id .class}`): classes are added after Pele's, a style after Pele's (whose theme variables the diagram needs), and anything else is set, replacing Pele's value. The class that marked the element as a diagram is dropped.
+*/
+const mermaidSvg = (svg, attributes) => {
+	const open = /^<svg\b[^>]*>/.exec(svg)?.[0];
+	if (!open || attributes.length === 0) return svg;
+	const own = [...open.slice(4, -1).matchAll(/\s([^\s=]+)="([^"]*)"/g)].map(([, name = ``, value = ``]) => [name, value]);
+	const merged = new Map(own);
+	for (const [name, value] of attributes) {
+		const escaped = escapeAttribute(value);
+		const current = merged.get(name);
+		if (name === `class`) {
+			const added = classes(value).map(escapeAttribute).join(` `);
+			if (added) merged.set(name, current ? `${current} ${added}` : added);
+		} else if (name === `style` && current) merged.set(name, `${current.replace(/;$/, ``)};${escaped}`);
+		else merged.set(name, escaped);
+	}
+	return `<svg${[...merged].map(([name, value]) => ` ${name}="${value}"`).join(``)}>${svg.slice(open.length)}`;
+};
+/** A hast element's properties as attributes; `className` becomes `class`, and other names are kept as the attribute plugins write them. */
+const hastAttributes = (properties) => {
+	const text = (value) => typeof value === `string` ? value : typeof value === `number` ? String(value) : value === true ? `` : Array.isArray(value) ? value.map((item) => text(item) ?? ``).join(` `) : void 0;
+	const attributes = [];
+	for (const [key, value] of Object.entries(properties ?? {})) {
+		const written = text(value);
+		if (written !== void 0) attributes.push([key === `className` ? `class` : key, written]);
+	}
+	return attributes;
+};
+const hasClass = (node, name) => {
+	const value = node.properties?.className;
+	return Array.isArray(value) ? value.includes(name) : typeof value === `string` && value.split(/\s+/).includes(name);
+};
+const textOf = (node) => node.type === `text` ? node.value ?? `` : (node.children ?? []).map(textOf).join(``);
+/**
+* The diagram a `<pre>` holds, as rehype-mermaid finds them: a `<pre>` whose only content (besides whitespace) is a `<code class="language-mermaid">`, which is how a fenced `mermaid` block renders, or a `<pre class="mermaid">`. `element` is the one whose attributes the `<svg>` takes. `undefined` for anything else.
+*/
+const mermaidDiagram = (pre) => {
+	if (pre.tagName !== `pre`) return void 0;
+	if (hasClass(pre, MERMAID_PRE_CLASS)) return {
+		source: mermaidSource(textOf(pre)),
+		element: pre
+	};
+	let code;
+	for (const child of pre.children ?? []) {
+		if (child.type === `text` && /^\s*$/.test(child.value ?? ``)) continue;
+		if (code || child.tagName !== `code`) return void 0;
+		code = child;
+	}
+	return code && hasClass(code, MERMAID_LANGUAGE_CLASS) ? {
+		source: mermaidSource(textOf(code)),
+		element: code
+	} : void 0;
+};
+/**
+* The error a diagram that failed to render throws: Pele's message, at the document line Pele located the problem on (counting from `line`, the line the diagram's element starts on), or at `line` itself when Pele has no location. The original error is the `cause`.
+*/
+const mermaidFailure = (error, line) => {
+	const reason = error instanceof Error ? error.message : String(error);
+	const within = error instanceof Error && `line` in error && typeof error.line === `number` && error.line > 0 ? error.line : 0;
+	const at = line === void 0 ? `` : ` on line ${String(line + within)}`;
+	return new Error(`Could not render the mermaid diagram${at}: ${reason}`, { cause: error });
+};
+export { mermaidSource as a, mermaidIdPrefixes as i, mermaidDiagram as n, mermaidSvg as o, mermaidFailure as r, hastAttributes as t };
+
+//# sourceMappingURL=mermaid-pele-BMyyDozN.mjs.map

package/dist/mermaid-pele-BMyyDozN.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"mermaid-pele-BMyyDozN.mjs","names":[],"sources":["../src/mermaid-pele.ts"],"sourcesContent":["// Rendering mermaid diagrams with Pele, shared by the markdown-it, rehype and Sätteri plugins: which elements hold a diagram, each diagram's id prefix, the attributes its `<svg>` takes, and the error a failed diagram throws. Rendering itself stays in the plugins, which depend on Pele, so this module has no dependencies.\n\nimport type { HastLike } from \"./hast.js\";\n\n/** An HTML attribute, as markdown-it's tokens hold them. */\nexport type MermaidAttribute = [name: string, value: string];\n\n/** The class a fenced `mermaid` block's `<code>` takes. */\nconst MERMAID_LANGUAGE_CLASS = `language-mermaid`;\n/** The class a `<pre>` holding a diagram written as HTML takes, as Mermaid reads it in the browser. */\nconst MERMAID_PRE_CLASS = `mermaid`;\n\nconst hash = (str: string): string => {\n  let h = 2166136261;\n  for (let i = 0; i < str.length; i++) {\n    h = Math.imul(h ^ str.charCodeAt(i), 16777619) >>> 0;\n  }\n  return h.toString(36);\n};\n\n/** A diagram's source as Pele reads it: line endings normalized, as markdown-it already has them. */\nexport const mermaidSource = (text: string): string =>\n  text.replace(/\\r\\n?/g, `\\n`);\n\n/**\n * A document's id prefixes, one per diagram in document order: `prefix`, then a hash of the diagram's source, so a diagram's ids don't change when others are edited, with `-2`, `-3`… for repeats of one diagram. Pele namespaces every id it writes (an accessible title, a gradient) under it. Create one per document.\n */\nexport const mermaidIdPrefixes = (\n  prefix: string\n): ((source: string) => string) => {\n  const seen = new Map<string, number>();\n  return (source) => {\n    const id = `${prefix}-${hash(source)}`;\n    const count = (seen.get(id) ?? 0) + 1;\n    seen.set(id, count);\n    return count === 1 ? id : `${id}-${count}`;\n  };\n};\n\nconst escapeAttribute = (value: string): string =>\n  value.replace(/&/g, `&amp;`).replace(/\"/g, `&quot;`);\n\nconst classes = (value: string): string[] =>\n  value\n    .split(/\\s+/)\n    .filter(\n      (name) =>\n        name !== `` &&\n        name !== MERMAID_LANGUAGE_CLASS &&\n        name !== MERMAID_PRE_CLASS\n    );\n\n/**\n * Pele's `<svg>` with the attributes the diagram's element had (from an attribute block such as `{#id .class}`): classes are added after Pele's, a style after Pele's (whose theme variables the diagram needs), and anything else is set, replacing Pele's value. The class that marked the element as a diagram is dropped.\n */\nexport const mermaidSvg = (\n  svg: string,\n  attributes: readonly MermaidAttribute[]\n): string => {\n  const open = /^<svg\\b[^>]*>/.exec(svg)?.[0];\n  if (!open || attributes.length === 0) return svg;\n  const own = [...open.slice(4, -1).matchAll(/\\s([^\\s=]+)=\"([^\"]*)\"/g)].map(\n    ([, name = ``, value = ``]): MermaidAttribute => [name, value]\n  );\n  const merged = new Map<string, string>(own);\n  for (const [name, value] of attributes) {\n    const escaped = escapeAttribute(value);\n    const current = merged.get(name);\n    if (name === `class`) {\n      const added = classes(value).map(escapeAttribute).join(` `);\n      if (added) merged.set(name, current ? `${current} ${added}` : added);\n    } else if (name === `style` && current) {\n      merged.set(name, `${current.replace(/;$/, ``)};${escaped}`);\n    } else {\n      merged.set(name, escaped);\n    }\n  }\n  const tag = [...merged]\n    .map(([name, value]) => ` ${name}=\"${value}\"`)\n    .join(``);\n  return `<svg${tag}>${svg.slice(open.length)}`;\n};\n\n/** A hast element's properties as attributes; `className` becomes `class`, and other names are kept as the attribute plugins write them. */\nexport const hastAttributes = (\n  properties: Record<string, unknown> | undefined\n): MermaidAttribute[] => {\n  // hast's property values: a string, a number, a boolean (present or absent) or a list.\n  const text = (value: unknown): string | undefined =>\n    typeof value === `string`\n      ? value\n      : typeof value === `number`\n        ? String(value)\n        : value === true\n          ? ``\n          : Array.isArray(value)\n            ? value.map((item) => text(item) ?? ``).join(` `)\n            : undefined;\n  const attributes: MermaidAttribute[] = [];\n  for (const [key, value] of Object.entries(properties ?? {})) {\n    const written = text(value);\n    if (written !== undefined)\n      attributes.push([key === `className` ? `class` : key, written]);\n  }\n  return attributes;\n};\n\nconst hasClass = (node: HastLike, name: string): boolean => {\n  const value = node.properties?.className;\n  return Array.isArray(value)\n    ? value.includes(name)\n    : typeof value === `string` && value.split(/\\s+/).includes(name);\n};\n\nconst textOf = (node: HastLike): string =>\n  node.type === `text`\n    ? (node.value ?? ``)\n    : (node.children ?? []).map(textOf).join(``);\n\n/**\n * The diagram a `<pre>` holds, as rehype-mermaid finds them: a `<pre>` whose only content (besides whitespace) is a `<code class=\"language-mermaid\">`, which is how a fenced `mermaid` block renders, or a `<pre class=\"mermaid\">`. `element` is the one whose attributes the `<svg>` takes. `undefined` for anything else.\n */\nexport const mermaidDiagram = (\n  pre: HastLike\n): { source: string; element: HastLike } | undefined => {\n  if (pre.tagName !== `pre`) return undefined;\n  if (hasClass(pre, MERMAID_PRE_CLASS))\n    return { source: mermaidSource(textOf(pre)), element: pre };\n  let code: HastLike | undefined;\n  for (const child of pre.children ?? []) {\n    if (child.type === `text` && /^\\s*$/.test(child.value ?? ``)) continue;\n    if (code || child.tagName !== `code`) return undefined;\n    code = child;\n  }\n  return code && hasClass(code, MERMAID_LANGUAGE_CLASS)\n    ? { source: mermaidSource(textOf(code)), element: code }\n    : undefined;\n};\n\n/**\n * The error a diagram that failed to render throws: Pele's message, at the document line Pele located the problem on (counting from `line`, the line the diagram's element starts on), or at `line` itself when Pele has no location. The original error is the `cause`.\n */\nexport const mermaidFailure = (\n  error: unknown,\n  line: number | undefined\n): Error => {\n  const reason = error instanceof Error ? error.message : String(error);\n  const within =\n    error instanceof Error &&\n    `line` in error &&\n    typeof error.line === `number` &&\n    error.line > 0\n      ? error.line\n      : 0;\n  const at = line === undefined ? `` : ` on line ${String(line + within)}`;\n  return new Error(`Could not render the mermaid diagram${at}: ${reason}`, {\n    cause: error\n  });\n};\n"],"mappings":";;AAQA,MAAM,yBAAyB;;AAE/B,MAAM,oBAAoB;AAE1B,MAAM,QAAQ,QAAwB;CACpC,IAAI,IAAI;CACR,KAAK,IAAI,IAAI,GAAG,IAAI,IAAI,QAAQ,KAC9B,IAAI,KAAK,KAAK,IAAI,IAAI,WAAW,CAAC,GAAG,QAAQ,MAAM;CAErD,OAAO,EAAE,SAAS,EAAE;AACtB;;AAGA,MAAa,iBAAiB,SAC5B,KAAK,QAAQ,UAAU,IAAI;;;;AAK7B,MAAa,qBACX,WACiC;CACjC,MAAM,uBAAO,IAAI,IAAoB;CACrC,QAAQ,WAAW;EACjB,MAAM,KAAK,GAAG,OAAO,GAAG,KAAK,MAAM;EACnC,MAAM,SAAS,KAAK,IAAI,EAAE,KAAK,KAAK;EACpC,KAAK,IAAI,IAAI,KAAK;EAClB,OAAO,UAAU,IAAI,KAAK,GAAG,GAAG,GAAG;CACrC;AACF;AAEA,MAAM,mBAAmB,UACvB,MAAM,QAAQ,MAAM,OAAO,CAAC,CAAC,QAAQ,MAAM,QAAQ;AAErD,MAAM,WAAW,UACf,MACG,MAAM,KAAK,CAAC,CACZ,QACE,SACC,SAAS,MACT,SAAS,0BACT,SAAS,iBACb;;;;AAKJ,MAAa,cACX,KACA,eACW;CACX,MAAM,OAAO,gBAAgB,KAAK,GAAG,CAAC,GAAG;CACzC,IAAI,CAAC,QAAQ,WAAW,WAAW,GAAG,OAAO;CAC7C,MAAM,MAAM,CAAC,GAAG,KAAK,MAAM,GAAG,EAAE,CAAC,CAAC,SAAS,wBAAwB,CAAC,CAAC,CAAC,KACnE,GAAG,OAAO,IAAI,QAAQ,QAA0B,CAAC,MAAM,KAAK,CAC/D;CACA,MAAM,SAAS,IAAI,IAAoB,GAAG;CAC1C,KAAK,MAAM,CAAC,MAAM,UAAU,YAAY;EACtC,MAAM,UAAU,gBAAgB,KAAK;EACrC,MAAM,UAAU,OAAO,IAAI,IAAI;EAC/B,IAAI,SAAS,SAAS;GACpB,MAAM,QAAQ,QAAQ,KAAK,CAAC,CAAC,IAAI,eAAe,CAAC,CAAC,KAAK,GAAG;GAC1D,IAAI,OAAO,OAAO,IAAI,MAAM,UAAU,GAAG,QAAQ,GAAG,UAAU,KAAK;EACrE,OAAO,IAAI,SAAS,WAAW,SAC7B,OAAO,IAAI,MAAM,GAAG,QAAQ,QAAQ,MAAM,EAAE,EAAE,GAAG,SAAS;OAE1D,OAAO,IAAI,MAAM,OAAO;CAE5B;CAIA,OAAO,OAHK,CAAC,GAAG,MAAM,CAAC,CACpB,KAAK,CAAC,MAAM,WAAW,IAAI,KAAK,IAAI,MAAM,EAAE,CAAC,CAC7C,KAAK,EACQ,EAAE,GAAG,IAAI,MAAM,KAAK,MAAM;AAC5C;;AAGA,MAAa,kBACX,eACuB;CAEvB,MAAM,QAAQ,UACZ,OAAO,UAAU,WACb,QACA,OAAO,UAAU,WACf,OAAO,KAAK,IACZ,UAAU,OACR,KACA,MAAM,QAAQ,KAAK,IACjB,MAAM,KAAK,SAAS,KAAK,IAAI,KAAK,EAAE,CAAC,CAAC,KAAK,GAAG,IAC9C,KAAA;CACZ,MAAM,aAAiC,CAAC;CACxC,KAAK,MAAM,CAAC,KAAK,UAAU,OAAO,QAAQ,cAAc,CAAC,CAAC,GAAG;EAC3D,MAAM,UAAU,KAAK,KAAK;EAC1B,IAAI,YAAY,KAAA,GACd,WAAW,KAAK,CAAC,QAAQ,cAAc,UAAU,KAAK,OAAO,CAAC;CAClE;CACA,OAAO;AACT;AAEA,MAAM,YAAY,MAAgB,SAA0B;CAC1D,MAAM,QAAQ,KAAK,YAAY;CAC/B,OAAO,MAAM,QAAQ,KAAK,IACtB,MAAM,SAAS,IAAI,IACnB,OAAO,UAAU,YAAY,MAAM,MAAM,KAAK,CAAC,CAAC,SAAS,IAAI;AACnE;AAEA,MAAM,UAAU,SACd,KAAK,SAAS,SACT,KAAK,SAAS,MACd,KAAK,YAAY,CAAC,EAAA,CAAG,IAAI,MAAM,CAAC,CAAC,KAAK,EAAE;;;;AAK/C,MAAa,kBACX,QACsD;CACtD,IAAI,IAAI,YAAY,OAAO,OAAO,KAAA;CAClC,IAAI,SAAS,KAAK,iBAAiB,GACjC,OAAO;EAAE,QAAQ,cAAc,OAAO,GAAG,CAAC;EAAG,SAAS;CAAI;CAC5D,IAAI;CACJ,KAAK,MAAM,SAAS,IAAI,YAAY,CAAC,GAAG;EACtC,IAAI,MAAM,SAAS,UAAU,QAAQ,KAAK,MAAM,SAAS,EAAE,GAAG;EAC9D,IAAI,QAAQ,MAAM,YAAY,QAAQ,OAAO,KAAA;EAC7C,OAAO;CACT;CACA,OAAO,QAAQ,SAAS,MAAM,sBAAsB,IAChD;EAAE,QAAQ,cAAc,OAAO,IAAI,CAAC;EAAG,SAAS;CAAK,IACrD,KAAA;AACN;;;;AAKA,MAAa,kBACX,OACA,SACU;CACV,MAAM,SAAS,iBAAiB,QAAQ,MAAM,UAAU,OAAO,KAAK;CACpE,MAAM,SACJ,iBAAiB,SACjB,UAAU,SACV,OAAO,MAAM,SAAS,YACtB,MAAM,OAAO,IACT,MAAM,OACN;CACN,MAAM,KAAK,SAAS,KAAA,IAAY,KAAK,YAAY,OAAO,OAAO,MAAM;CACrE,OAAO,IAAI,MAAM,uCAAuC,GAAG,IAAI,UAAU,EACvE,OAAO,MACT,CAAC;AACH"}

package/dist/tab-icons.d.mts

@@ -0,0 +1,54 @@
+/**
+ * An icon: SVG markup, or a light and dark pair that the color scheme picks between. Pairs render both SVGs, and the stylesheet shows one; icons that adapt to the color scheme themselves (with `light-dark()`) can be single SVGs.
+ */
+type TabIcon = string | {
+  light: string;
+  dark: string;
+};
+/** Options shared by the tab-icons plugins for every engine. */
+interface TabIconsOptions {
+  /**
+   * Your own icons, by keyword (a whole word of a label, such as `deno`) or file name and extension (a key with a `.`, such as `.astro` or `deno.json`). They're checked before the built-in ones, and replace one with the same key.
+   */
+  icons?: Record<string, TabIcon> | undefined;
+  /**
+   * Include the icons Mirrordown ships (the set vitepress-plugin-group-icons matches).
+   *
+   * @default true
+   */
+  builtin?: boolean | undefined;
+  /**
+   * Match a label's text to an icon when it has no `[!keyword]` marker.
+   *
+   * @default true
+   */
+  match?: boolean | undefined;
+  /**
+   * The tabs plugin's `containerClass`, when you changed it.
+   *
+   * @default "markdown-tabs"
+   */
+  containerClass?: string | undefined;
+}
+/** The icons tab-icons ships, by keyword (a whole word of a label) or file name and extension (keys with a `.`). */
+export declare const BUILTIN_TAB_ICONS: Record<string, TabIcon>;
+/** The class each icon's `<svg>` takes. */
+export declare const TAB_ICON_CLASS = "markdown-tab-icon";
+/** What a tab label becomes: its icon, if it has one, and its text without its marker. */
+export interface TabLabelIcon {
+  icon: TabIcon | undefined;
+  /** The marker at the start of the label's text (`[!npm] `), to remove from it, or `""`. */
+  marker: string;
+  /** The label's text without its marker: the marker's keyword when nothing else is left. */
+  label: string;
+}
+/**
+ * A resolver for tab labels' icons under a plugin's options. Given a label's plain text, it returns the icon for its `[!keyword]` marker (an unknown keyword isn't a marker; `[!none]` gives no icon), or, without one, the icon its text matches: the longest keyword that is a whole word of the label (case-insensitive, also after splitting camelCase), else the longest file name or extension it ends with, else one in it. Your icons come before the built-in ones.
+ */
+export declare const createTabIconResolver: (options?: TabIconsOptions) => ((label: string) => TabLabelIcon);
+/**
+ * The markup for a tab icon, to go before the label's text: the `<svg>` with the icon class and `aria-hidden` (the label names the tab), or, for a light and dark pair, both, marked `data-scheme="light"` and `"dark"` for the stylesheet to show one.
+ */
+export declare const tabIconMarkup: (icon: TabIcon) => string;
+export type { TabIcon, TabIconsOptions };
+//# sourceMappingURL=tab-icons.d.mts.map

package/dist/tab-icons.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tab-icons.d.mts","names":[],"sources":["../src/tab-icons/types.ts","../src/tab-icons/builtin.ts","../src/tab-icons/index.ts"],"mappings":";;;KAGY;EAAqB;EAAe;;;UAG/B;;;;EAIf,QAAQ,eAAe;;;;;;EAMvB;;;;;;EAMA;;;;;;EAMA;;;qBC6IW,mBAAmB,eAAe;;qBChKlC;;iBA0BI;EACf,MAAM;;EAEN;;EAEA;;;;;qBAMW,wBACX,UAAS,sBACN,kBAAkB;;;;qBAoEV,gBAAiB,MAAM"}