@temelj/mdx 0.8.0 → 0.8.1

package/dist/compiler.d.ts

@@ -1,38 +1,40 @@
-import { type CompileOptions as MdxJsCompileOptions } from "@mdx-js/mdx";
-import remarkFrontmatterPlugin from "remark-frontmatter";
-import remarkGfmPlugin from "remark-gfm";
-import type { Plugin } from "unified";
-import type { z } from "zod";
-import type { HastNode } from "./types";
-export { remarkFrontmatterPlugin, remarkGfmPlugin };
+import { CompileOptions } from '@mdx-js/mdx';
+export { default as remarkFrontmatterPlugin } from 'remark-frontmatter';
+export { default as remarkGfmPlugin } from 'remark-gfm';
+import { Plugin } from 'unified';
+import { z } from 'zod';
+import { Node } from 'hast';
+
 /**
  * Represents the source content for an MDX document.
  */
-export type MdxSource = string | Uint8Array;
+type MdxSource = string | Uint8Array;
 /**
  * Options for compiling an MDX document.
  */
-export interface MdxCompileOptions {
+interface MdxCompileOptions {
     frontmatterOnly?: boolean | undefined;
-    mdxOptions?: MdxJsCompileOptions;
+    mdxOptions?: CompileOptions;
 }
 /**
  * The result of compiling an MDX document.
  * Compiled content is optional, because sometimes we only need the frontmatter.
  */
-export interface MdxArtifact<TFrontmatter = Record<string, unknown>> {
+interface MdxArtifact<TFrontmatter = Record<string, unknown>> {
     compiled?: string | undefined;
     frontmatter: TFrontmatter;
 }
 /**
  * A reusable compiler for compiling MDX.
  */
-export declare class MdxCompiler {
+declare class MdxCompiler {
     private readonly mdxOptions;
     private readonly remarkPlugins;
     private readonly rehypePlugins;
-    constructor(mdxOptions?: MdxJsCompileOptions);
-    withRemarkPlugin<TOptions>(plugin: Plugin<[TOptions?], HastNode, HastNode>, options?: TOptions): MdxCompiler;
-    withRehypePlugin<TOptions>(plugin: Plugin<[TOptions?], HastNode, HastNode>, options?: TOptions): MdxCompiler;
+    constructor(mdxOptions?: CompileOptions);
+    withRemarkPlugin<TOptions>(plugin: Plugin<[TOptions?], Node, Node>, options?: TOptions): MdxCompiler;
+    withRehypePlugin<TOptions>(plugin: Plugin<[TOptions?], Node, Node>, options?: TOptions): MdxCompiler;
     compile<TFrontmatterSchema extends z.ZodSchema>(source: MdxSource, { frontmatterOnly, mdxOptions }?: MdxCompileOptions, frontmatterSchema?: TFrontmatterSchema): Promise<MdxArtifact<z.output<TFrontmatterSchema>>>;
 }
+
+export { type MdxArtifact, type MdxCompileOptions, MdxCompiler, type MdxSource };

package/dist/compiler.js

@@ -1,76 +1,75 @@
-import { compile as compileMdxJs, } from "@mdx-js/mdx";
+import {
+  compile as compileMdxJs
+} from "@mdx-js/mdx";
 import remarkFrontmatterPlugin from "remark-frontmatter";
 import remarkGfmPlugin from "remark-gfm";
 import { VFile } from "vfile";
 import { matter } from "vfile-matter";
-export { remarkFrontmatterPlugin, remarkGfmPlugin };
-/**
- * A reusable compiler for compiling MDX.
- */
-export class MdxCompiler {
-    mdxOptions;
-    remarkPlugins;
-    rehypePlugins;
-    constructor(mdxOptions = {}) {
-        this.mdxOptions = mdxOptions;
-        this.remarkPlugins = [remarkFrontmatterPlugin, remarkGfmPlugin];
-        this.rehypePlugins = [];
+class MdxCompiler {
+  mdxOptions;
+  remarkPlugins;
+  rehypePlugins;
+  constructor(mdxOptions = {}) {
+    this.mdxOptions = mdxOptions;
+    this.remarkPlugins = [remarkFrontmatterPlugin, remarkGfmPlugin];
+    this.rehypePlugins = [];
+  }
+  withRemarkPlugin(plugin, options) {
+    if (options === void 0) {
+      this.remarkPlugins.push(plugin);
+    } else {
+      this.remarkPlugins.push([plugin, options]);
     }
-    withRemarkPlugin(plugin, options) {
-        if (options === undefined) {
-            this.remarkPlugins.push(plugin);
-        }
-        else {
-            this.remarkPlugins.push([plugin, options]);
-        }
-        return this;
+    return this;
+  }
+  withRehypePlugin(plugin, options) {
+    if (options === void 0) {
+      this.rehypePlugins.push(plugin);
+    } else {
+      this.rehypePlugins.push([plugin, options]);
     }
-    withRehypePlugin(plugin, options) {
-        if (options === undefined) {
-            this.rehypePlugins.push(plugin);
-        }
-        else {
-            this.rehypePlugins.push([plugin, options]);
-        }
-        return this;
-    }
-    async compile(source, { frontmatterOnly = false, mdxOptions } = {}, frontmatterSchema) {
-        const vfile = new VFile({
-            value: source,
-            // Needed so vfile doesn't need to access fs.
-            cwd: "/",
-            path: "/",
-            message: {},
-            messages: {},
-        });
-        matter(vfile, { strip: true });
-        const remarkPlugins = [
-            ...this.remarkPlugins,
-            ...(this.mdxOptions?.remarkPlugins ?? []),
-            ...(mdxOptions?.remarkPlugins ?? []),
-        ];
-        const rehypePlugins = [
-            ...this.rehypePlugins,
-            ...(this.mdxOptions?.rehypePlugins ?? []),
-            ...(mdxOptions?.rehypePlugins ?? []),
-        ];
-        let compiled;
-        if (!frontmatterOnly) {
-            const compiledFile = await compileMdxJs(vfile, {
-                outputFormat: "function-body",
-                ...(this.mdxOptions ?? {}),
-                ...(mdxOptions ?? {}),
-                remarkPlugins,
-                rehypePlugins,
-            });
-            compiled = compiledFile.value.toString();
-        }
-        const frontmatter = frontmatterSchema === undefined
-            ? (vfile.data.matter ?? {})
-            : frontmatterSchema.parse(vfile.data.matter ?? {});
-        return {
-            compiled,
-            frontmatter: frontmatter,
-        };
+    return this;
+  }
+  async compile(source, { frontmatterOnly = false, mdxOptions } = {}, frontmatterSchema) {
+    const vfile = new VFile({
+      value: source,
+      // Needed so vfile doesn't need to access fs.
+      cwd: "/",
+      path: "/",
+      message: {},
+      messages: {}
+    });
+    matter(vfile, { strip: true });
+    const remarkPlugins = [
+      ...this.remarkPlugins,
+      ...this.mdxOptions?.remarkPlugins ?? [],
+      ...mdxOptions?.remarkPlugins ?? []
+    ];
+    const rehypePlugins = [
+      ...this.rehypePlugins,
+      ...this.mdxOptions?.rehypePlugins ?? [],
+      ...mdxOptions?.rehypePlugins ?? []
+    ];
+    let compiled;
+    if (!frontmatterOnly) {
+      const compiledFile = await compileMdxJs(vfile, {
+        outputFormat: "function-body",
+        ...this.mdxOptions ?? {},
+        ...mdxOptions ?? {},
+        remarkPlugins,
+        rehypePlugins
+      });
+      compiled = compiledFile.value.toString();
     }
+    const frontmatter = frontmatterSchema === void 0 ? vfile.data.matter ?? {} : frontmatterSchema.parse(vfile.data.matter ?? {});
+    return {
+      compiled,
+      frontmatter
+    };
+  }
 }
+export {
+  MdxCompiler,
+  remarkFrontmatterPlugin,
+  remarkGfmPlugin
+};

package/dist/mod.d.ts

@@ -1,3 +1,13 @@
-export * from "./plugins/mod";
-export * from "./types";
-export * from "./compiler";
+export { MdxArtifact, MdxCompileOptions, MdxCompiler, MdxSource } from './compiler.js';
+export { HeadingIdPluginOptions, headingIdPlugin } from './plugins/heading-id/plugin.js';
+export { SyntaxHighlightPluginOptions, syntaxHighlightPlugin } from './plugins/syntax-highlight/plugin.js';
+export { MdxTreeProcessor, treeProcessorPlugin } from './plugins/tree-processor/plugin.js';
+export { removeImportsExportsPlugin } from './plugins/remove-imports-exports.js';
+export { Element as HastElement, Node as HastNode } from 'hast';
+export { default as remarkFrontmatterPlugin } from 'remark-frontmatter';
+export { default as remarkGfmPlugin } from 'remark-gfm';
+import '@mdx-js/mdx';
+import 'unified';
+import 'zod';
+import 'shiki';
+import '@shikijs/transformers';

package/dist/mod.js

@@ -1,3 +1,3 @@
+export * from "./compiler";
 export * from "./plugins/mod";
 export * from "./types";
-export * from "./compiler";

package/dist/plugins/heading-id/plugin.d.ts

@@ -1,15 +1,18 @@
-import type { Plugin } from "unified";
-import type { HastNode } from "../../types";
+import { Plugin } from 'unified';
+import { Node } from 'hast';
+
 /**
  * Options for {@linkcode headingIdPlugin}.
  */
-export interface HeadingIdPluginOptions {
+interface HeadingIdPluginOptions {
     /** Prefix for title slugs. */
     prefix?: string;
 }
 /**
  * A rehype plugin that adds IDs to heading tags.
  */
-export declare const headingIdPlugin: Plugin<[
+declare const headingIdPlugin: Plugin<[
     HeadingIdPluginOptions?
-], HastNode, HastNode>;
+], Node, Node>;
+
+export { type HeadingIdPluginOptions, headingIdPlugin };

package/dist/plugins/heading-id/plugin.js

@@ -1,19 +1,22 @@
 import GithubSlugger from "github-slugger";
 import { toString as hastToString } from "hast-util-to-string";
 import { visit } from "unist-util-visit";
-/**
- * A rehype plugin that adds IDs to heading tags.
- */
-export const headingIdPlugin = ({ prefix } = {}) => {
-    const slugger = new GithubSlugger();
-    return (tree) => {
-        slugger.reset();
-        visit(tree, "element", function visitor(node, index, parent) {
-            if (!parent || index === null || !node.tagName.startsWith("h"))
-                return;
-            const id = (prefix ?? "") + slugger.slug(hastToString(node));
-            node.properties.id = id;
-        });
-        return tree;
-    };
+const headingIdPlugin = ({ prefix } = {}) => {
+  const slugger = new GithubSlugger();
+  return (tree) => {
+    slugger.reset();
+    visit(
+      tree,
+      "element",
+      function visitor(node, index, parent) {
+        if (!parent || index === null || !node.tagName.startsWith("h")) return;
+        const id = (prefix ?? "") + slugger.slug(hastToString(node));
+        node.properties.id = id;
+      }
+    );
+    return tree;
+  };
+};
+export {
+  headingIdPlugin
 };

package/dist/plugins/mod.d.ts

@@ -1,4 +1,8 @@
-export * from "./heading-id/plugin";
-export * from "./syntax-highlight/plugin";
-export * from "./tree-processor/plugin";
-export * from "./remove-imports-exports";
+export { HeadingIdPluginOptions, headingIdPlugin } from './heading-id/plugin.js';
+export { SyntaxHighlightPluginOptions, syntaxHighlightPlugin } from './syntax-highlight/plugin.js';
+export { MdxTreeProcessor, treeProcessorPlugin } from './tree-processor/plugin.js';
+export { removeImportsExportsPlugin } from './remove-imports-exports.js';
+import 'unified';
+import 'hast';
+import 'shiki';
+import '@shikijs/transformers';

package/dist/plugins/remove-imports-exports.d.ts

@@ -1,8 +1,11 @@
-import type { Plugin } from "unified";
-import type { HastNode } from "../types";
+import { Plugin } from 'unified';
+import { Node } from 'hast';
+
 /**
  * A remark plugin which removes all import and export statements.
  */
-export declare const removeImportsExportsPlugin: Plugin<[
+declare const removeImportsExportsPlugin: Plugin<[
     unknown
-], HastNode, HastNode>;
+], Node, Node>;
+
+export { removeImportsExportsPlugin };

package/dist/plugins/remove-imports-exports.js

@@ -1,10 +1,10 @@
 import { remove } from "unist-util-remove";
-/**
- * A remark plugin which removes all import and export statements.
- */
-export const removeImportsExportsPlugin = () => {
-    return (tree) => {
-        remove(tree, "mdxjsEsm");
-        return tree;
-    };
+const removeImportsExportsPlugin = () => {
+  return (tree) => {
+    remove(tree, "mdxjsEsm");
+    return tree;
+  };
+};
+export {
+  removeImportsExportsPlugin
 };

package/dist/plugins/syntax-highlight/code-meta.d.ts

@@ -1,18 +1,21 @@
-import { type NumericRange } from "@temelj/iterator";
-import type { HastElement } from "../../types";
-export interface MdxCodeMeta {
+import { NumericRange } from '@temelj/iterator';
+import { Element } from 'hast';
+
+interface MdxCodeMeta {
     highlight?: MdxCodeMetaHighlightLine;
     showLineNumbers?: MdxCodeMetaLineNumbers;
     commandLine?: MdxCodeMetaCommandLine;
     fileName?: string;
 }
-export type MdxCodeMetaHighlightLine = {
+type MdxCodeMetaHighlightLine = {
     lineRange: NumericRange;
 };
-export type MdxCodeMetaLineNumbers = {
+type MdxCodeMetaLineNumbers = {
     lineRange: NumericRange;
 };
-export type MdxCodeMetaCommandLine = {
+type MdxCodeMetaCommandLine = {
     commandRange: NumericRange;
 };
-export declare function extractCodeMeta(node: HastElement): MdxCodeMeta;
+declare function extractCodeMeta(node: Element): MdxCodeMeta;
+
+export { type MdxCodeMeta, type MdxCodeMetaCommandLine, type MdxCodeMetaHighlightLine, type MdxCodeMetaLineNumbers, extractCodeMeta };

package/dist/plugins/syntax-highlight/code-meta.js

@@ -1,50 +1,50 @@
 import { parseNumericRange } from "@temelj/iterator";
 import { z } from "zod";
-export function extractCodeMeta(node) {
-    const meta = node?.data?.meta ?? node?.properties?.metastring ?? "";
-    return parseMetaString(meta);
+function extractCodeMeta(node) {
+  const meta = node?.data?.meta ?? node?.properties?.metastring ?? "";
+  return parseMetaString(meta);
 }
 const metaSchema = z.object({
-    highlight: z.optional(z.string()),
-    showLineNumbers: z.optional(z.union([z.boolean(), z.string()])),
-    commandLine: z.optional(z.union([z.boolean(), z.string()])),
-    fileName: z.optional(z.string()),
+  highlight: z.optional(z.string()),
+  showLineNumbers: z.optional(z.union([z.boolean(), z.string()])),
+  commandLine: z.optional(z.union([z.boolean(), z.string()])),
+  fileName: z.optional(z.string())
 });
 function parseMetaString(meta) {
-    let raw;
-    try {
-        raw = JSON.parse(meta.trim());
+  let raw;
+  try {
+    raw = JSON.parse(meta.trim());
+  } catch {
+    return {};
+  }
+  const parsed = metaSchema.parse(raw);
+  const options = {};
+  if (parsed.highlight !== void 0) {
+    options.highlight = { lineRange: parseNumericRange(parsed.highlight) };
+  }
+  if (parsed.showLineNumbers !== void 0) {
+    if (typeof parsed.showLineNumbers === "string") {
+      options.showLineNumbers = {
+        lineRange: parseNumericRange(parsed.showLineNumbers)
+      };
+    } else if (parsed.showLineNumbers) {
+      options.showLineNumbers = { lineRange: [] };
     }
-    catch {
-        return {};
+  }
+  if (parsed.commandLine !== void 0) {
+    if (typeof parsed.commandLine === "string") {
+      options.commandLine = {
+        commandRange: parseNumericRange(parsed.commandLine)
+      };
+    } else if (parsed.commandLine) {
+      options.commandLine = { commandRange: [] };
     }
-    const parsed = metaSchema.parse(raw);
-    const options = {};
-    if (parsed.highlight !== undefined) {
-        options.highlight = { lineRange: parseNumericRange(parsed.highlight) };
-    }
-    if (parsed.showLineNumbers !== undefined) {
-        if (typeof parsed.showLineNumbers === "string") {
-            options.showLineNumbers = {
-                lineRange: parseNumericRange(parsed.showLineNumbers),
-            };
-        }
-        else if (parsed.showLineNumbers) {
-            options.showLineNumbers = { lineRange: [] };
-        }
-    }
-    if (parsed.commandLine !== undefined) {
-        if (typeof parsed.commandLine === "string") {
-            options.commandLine = {
-                commandRange: parseNumericRange(parsed.commandLine),
-            };
-        }
-        else if (parsed.commandLine) {
-            options.commandLine = { commandRange: [] };
-        }
-    }
-    if (parsed.fileName !== undefined) {
-        options.fileName = parsed.fileName.trim();
-    }
-    return options;
+  }
+  if (parsed.fileName !== void 0) {
+    options.fileName = parsed.fileName.trim();
+  }
+  return options;
 }
+export {
+  extractCodeMeta
+};

package/dist/plugins/syntax-highlight/plugin.d.ts

@@ -1,13 +1,14 @@
-import { type BundledLanguage, type BundledTheme, type CodeToHastOptions } from "shiki";
-import { type TransformerNotationHighlightOptions } from "@shikijs/transformers";
-import type { Plugin } from "unified";
-import type { HastNode } from "../../types";
+import { CodeToHastOptions, BundledLanguage, BundledTheme } from 'shiki';
+import { TransformerNotationHighlightOptions } from '@shikijs/transformers';
+import { Plugin } from 'unified';
+import { Node } from 'hast';
+
 type ShikiHastOptions = Partial<CodeToHastOptions<BundledLanguage, BundledTheme>>;
 type SyntaxDataAttribute = "source-code" | "language" | "line-count";
 /**
  * Options for {@linkcode syntaxHighlightPlugin}.
  */
-export interface SyntaxHighlightPluginOptions {
+interface SyntaxHighlightPluginOptions {
     /**
      * Include these data attributes on the `<pre>` element.
      * These might be useful to have when building custom code components.
@@ -50,7 +51,8 @@ export interface SyntaxHighlightPluginOptions {
 /**
  * A plugin that highlights code blocks using Shiki.
  */
-export declare const syntaxHighlightPlugin: Plugin<[
+declare const syntaxHighlightPlugin: Plugin<[
     SyntaxHighlightPluginOptions?
-], HastNode, HastNode>;
-export {};
+], Node, Node>;
+
+export { type SyntaxHighlightPluginOptions, syntaxHighlightPlugin };