@ox-content/unplugin 2.8.0 → 2.10.0

package/dist/esbuild.d.mts

@@ -1,7 +1,7 @@
-import { a as OxContentOptions, d as ResolvedOptions, f as TocEntry, p as TransformResult, t as unplugin } from "./index.mjs";
+import { C as ResolvedDocsConfig, D as UnifiedPreset, E as TransformResult, S as RemarkPlugin, T as TocEntry, _ as OxContentMdastPlugin, a as extractTocFromMdast, b as PluginConfig, c as toUnifiedMdastPlugin, d as MarkdownItPlugin, f as MdastNode, g as MdastTransformer, h as MdastRoot, i as defineMdastPlugin, l as transformMarkdown, m as MdastPluginContext, n as OxContentMdastOptions, o as oxContentMdast, p as MdastPlugin, r as createMdastPluginContext, s as parseMarkdownToMdast, t as unplugin, u as DocsConfig, v as OxContentOptions, w as ResolvedOptions, x as RehypePlugin, y as OxContentPlugin } from "./index.mjs";
 import * as unplugin$1 from "unplugin";
 
 //#region src/esbuild.d.ts
 declare const _default: (options?: OxContentOptions | undefined) => unplugin$1.EsbuildPlugin;
 //#endregion
-export { type OxContentOptions, type ResolvedOptions, type TocEntry, type TransformResult, _default as default, unplugin };
+export { DocsConfig, MarkdownItPlugin, MdastNode, MdastPlugin, MdastPluginContext, MdastRoot, MdastTransformer, OxContentMdastOptions, OxContentMdastPlugin, OxContentOptions, OxContentPlugin, PluginConfig, RehypePlugin, RemarkPlugin, ResolvedDocsConfig, ResolvedOptions, TocEntry, TransformResult, UnifiedPreset, createMdastPluginContext, _default as default, defineMdastPlugin, extractTocFromMdast, oxContentMdast, parseMarkdownToMdast, toUnifiedMdastPlugin, transformMarkdown, unplugin };

package/dist/esbuild.mjs

@@ -1,8 +1,8 @@
-import { t as unplugin } from "./src.mjs";
+import { a as extractTocFromMdast, c as toUnifiedMdastPlugin, i as defineMdastPlugin, n as transformMarkdown, o as oxContentMdast, r as createMdastPluginContext, s as parseMarkdownToMdast, t as unplugin } from "./src.mjs";
 //#region src/esbuild.ts
 /**
 * esbuild plugin export for @ox-content/unplugin
 */
 var esbuild_default = unplugin.esbuild;
 //#endregion
-export { esbuild_default as default, unplugin };
+export { createMdastPluginContext, esbuild_default as default, defineMdastPlugin, extractTocFromMdast, oxContentMdast, parseMarkdownToMdast, toUnifiedMdastPlugin, transformMarkdown, unplugin };

package/dist/index.d.mts

@@ -10,16 +10,135 @@ type MarkdownItPluginFn = (md: MarkdownIt, ...options: unknown[]) => void;
  * Can be a single plugin or a tuple of [plugin, ...options].
  */
 type MarkdownItPlugin = MarkdownItPluginFn | [MarkdownItPluginFn, ...unknown[]];
+/**
+ * mdast node aligned with the unified ecosystem.
+ *
+ * This is intentionally structural so Ox Content can expose mdast-shaped trees
+ * without forcing consumers into a separate type package.
+ */
+interface MdastNode {
+  type: string;
+  children?: MdastNode[];
+  value?: string;
+  position?: {
+    start: {
+      line: number;
+      column: number;
+      offset: number;
+    };
+    end: {
+      line: number;
+      column: number;
+      offset: number;
+    };
+  };
+  depth?: number;
+  url?: string;
+  title?: string;
+  lang?: string;
+  meta?: string;
+  alt?: string;
+  ordered?: boolean;
+  spread?: boolean;
+  checked?: boolean;
+  start?: number;
+  align?: Array<"left" | "center" | "right" | null>;
+  identifier?: string;
+  label?: string;
+  [key: string]: unknown;
+}
+/**
+ * mdast root node.
+ */
+interface MdastRoot extends MdastNode {
+  type: "root";
+  children: MdastNode[];
+}
+/**
+ * Context passed to Ox Content mdast plugins.
+ */
+interface MdastPluginContext {
+  /**
+   * Markdown file path being processed.
+   */
+  filePath: string;
+  /**
+   * Original markdown source passed into the unified stage.
+   */
+  source: string;
+  /**
+   * Parsed frontmatter data.
+   */
+  frontmatter: Record<string, unknown>;
+  /**
+   * Position of the markdown content slice within the original source.
+   *
+   * This is present when frontmatter or other pre-processing strips bytes
+   * before the mdast stage runs.
+   */
+  sourceOffset?: {
+    byteOffset: number;
+    offset: number;
+    line: number;
+    column: number;
+  };
+  /**
+   * Resolved plugin options.
+   */
+  options: ResolvedOptions;
+}
+/**
+ * Ox Content-native mdast transformer.
+ */
+type MdastTransformer = (tree: MdastRoot, context: MdastPluginContext) => MdastRoot | void | Promise<MdastRoot | void>;
+/**
+ * Ox Content mdast plugin descriptor.
+ *
+ * Existing unified/remark plugins can also be passed through `plugin.mdast`,
+ * but this object form gives a more mdast-native authoring experience.
+ */
+interface OxContentMdastPlugin {
+  /**
+   * Optional plugin name for debugging.
+   */
+  name?: string;
+  /**
+   * Tree transformer.
+   */
+  transform: MdastTransformer;
+}
+/**
+ * Unified attacher function type.
+ */
+type UnifiedAttacher = (this: unknown, ...args: never[]) => unknown;
+/**
+ * Unified preset object type.
+ */
+interface UnifiedPreset {
+  plugins?: unknown[];
+  settings?: Record<string, unknown>;
+}
+/**
+ * Unified plugin tuple type.
+ */
+type UnifiedPluginTuple = [UnifiedAttacher, ...unknown[]];
 /**
  * Remark plugin type.
- * Can be a single plugin or a tuple of [plugin, options].
+ * Can be a single plugin, a plugin tuple, or a unified preset.
  */
-type RemarkPlugin = [unknown, unknown] | unknown;
+type RemarkPlugin = UnifiedAttacher | UnifiedPluginTuple | UnifiedPreset;
+/**
+ * mdast plugin type.
+ *
+ * Accepts both Ox Content-native mdast plugins and existing unified/remark
+ * plugins so existing ecosystem plugins can run unchanged.
+ */
+type MdastPlugin = OxContentMdastPlugin | RemarkPlugin;
 /**
  * Rehype plugin type.
- * Can be a single plugin or a tuple of [plugin, options].
+ * Can be a single plugin, a plugin tuple, or a unified preset.
  */
-type RehypePlugin = [unknown, unknown] | unknown;
+type RehypePlugin = UnifiedAttacher | UnifiedPluginTuple | UnifiedPreset;
 /**
  * Ox-content native plugin type.
  * Transforms HTML after rendering.
@@ -92,8 +211,14 @@ interface PluginConfig {
    * @see https://www.npmjs.com/search?q=markdown-it-plugin
    */
   markdownIt?: MarkdownItPlugin[];
+  /**
+   * mdast plugins.
+   * Accepts both Ox Content-native mdast plugins and existing remark plugins.
+   */
+  mdast?: MdastPlugin[];
   /**
    * Remark plugins (unified ecosystem).
+   * Kept for compatibility; runs in the same mdast stage as `plugin.mdast`.
    * @see https://github.com/remarkjs/remark/blob/main/doc/plugins.md
    */
   remark?: RemarkPlugin[];
@@ -256,17 +381,84 @@ interface TocEntry {
 //#region src/transform.d.ts
 /**
  * Transforms Markdown content into a JavaScript module.
- * Uses Rust-based renderer via NAPI bindings for optimal performance.
+ * Uses Rust-based parsing, and switches to a unified/mdast pipeline when
+ * JavaScript mdast/remark/rehype plugins are configured.
  *
  * Note: This requires the @ox-content/napi package to be built.
- * NAPI bindings are loaded dynamically to support both Node.js and build-time execution.
  */
 declare function transformMarkdown(source: string, filePath: string, options: ResolvedOptions): Promise<TransformResult>;
 //#endregion
+//#region src/mdast.d.ts
+/**
+ * Parser options for the Ox Content mdast unified plugin.
+ */
+interface OxContentMdastOptions {
+  /**
+   * Enable GitHub Flavored Markdown extensions.
+   * @default true
+   */
+  gfm?: boolean;
+  /**
+   * Enable footnotes.
+   * @default true
+   */
+  footnotes?: boolean;
+  /**
+   * Enable task lists.
+   * @default true
+   */
+  taskLists?: boolean;
+  /**
+   * Enable tables.
+   * @default true
+   */
+  tables?: boolean;
+  /**
+   * Enable strikethrough.
+   * @default true
+   */
+  strikethrough?: boolean;
+  /**
+   * Enable autolinks.
+   * @default true
+   */
+  autolinks?: boolean;
+}
+type ProcessorWithParser = {
+  parser?: (document: string) => MdastRoot;
+};
+/**
+ * Unified parser plugin backed by Ox Content's native mdast parser.
+ *
+ * This lets existing remark/unified plugins run on top of Ox Content's parser
+ * while keeping a more mdast-native integration point.
+ */
+declare function oxContentMdast(this: ProcessorWithParser, options?: OxContentMdastOptions): void;
+/**
+ * Defines an Ox Content-native mdast plugin.
+ */
+declare function defineMdastPlugin(name: string, transform: MdastTransformer): OxContentMdastPlugin;
+/**
+ * Parses markdown source into an mdast-compatible tree using the native parser.
+ */
+declare function parseMarkdownToMdast(source: string, options?: OxContentMdastOptions): MdastRoot;
+/**
+ * Wraps an Ox Content-native mdast plugin as a standard unified transformer.
+ */
+declare function toUnifiedMdastPlugin(plugin: OxContentMdastPlugin, context: MdastPluginContext): () => (tree: MdastRoot) => MdastRoot | Promise<MdastRoot>;
+/**
+ * Extracts a nested TOC tree from mdast after mdast-stage plugins have run.
+ */
+declare function extractTocFromMdast(root: MdastRoot, maxDepth: number): TocEntry[];
+/**
+ * Creates the context passed to Ox Content-native mdast plugins.
+ */
+declare function createMdastPluginContext(filePath: string, source: string, frontmatter: Record<string, unknown>, options: ResolvedOptions, sourceOffset?: MdastPluginContext["sourceOffset"]): MdastPluginContext;
+//#endregion
 //#region src/index.d.ts
 /**
  * The unplugin instance.
  */
 declare const unplugin: unplugin.UnpluginInstance<OxContentOptions | undefined, boolean>;
 //#endregion
-export { OxContentOptions as a, RehypePlugin as c, ResolvedOptions as d, TocEntry as f, MarkdownItPlugin as i, RemarkPlugin as l, transformMarkdown as n, OxContentPlugin as o, TransformResult as p, DocsConfig as r, PluginConfig as s, unplugin as t, ResolvedDocsConfig as u };
+export { ResolvedDocsConfig as C, UnifiedPreset as D, TransformResult as E, RemarkPlugin as S, TocEntry as T, OxContentMdastPlugin as _, extractTocFromMdast as a, PluginConfig as b, toUnifiedMdastPlugin as c, MarkdownItPlugin as d, MdastNode as f, MdastTransformer as g, MdastRoot as h, defineMdastPlugin as i, transformMarkdown as l, MdastPluginContext as m, OxContentMdastOptions as n, oxContentMdast as o, MdastPlugin as p, createMdastPluginContext as r, parseMarkdownToMdast as s, unplugin as t, DocsConfig as u, OxContentOptions as v, ResolvedOptions as w, RehypePlugin as x, OxContentPlugin as y };

package/dist/index.mjs

@@ -1,2 +1,2 @@
-import { n as transformMarkdown, t as unplugin } from "./src.mjs";
-export { unplugin as default, unplugin, transformMarkdown };
+import { a as extractTocFromMdast, c as toUnifiedMdastPlugin, i as defineMdastPlugin, n as transformMarkdown, o as oxContentMdast, r as createMdastPluginContext, s as parseMarkdownToMdast, t as unplugin } from "./src.mjs";
+export { createMdastPluginContext, unplugin as default, unplugin, defineMdastPlugin, extractTocFromMdast, oxContentMdast, parseMarkdownToMdast, toUnifiedMdastPlugin, transformMarkdown };

package/dist/index2.d.mts

@@ -1,2 +1,2 @@
-import { a as OxContentOptions, c as RehypePlugin, d as ResolvedOptions, f as TocEntry, i as MarkdownItPlugin, l as RemarkPlugin, n as transformMarkdown, o as OxContentPlugin, p as TransformResult, r as DocsConfig, s as PluginConfig, t as unplugin, u as ResolvedDocsConfig } from "./index.mjs";
-export { DocsConfig, MarkdownItPlugin, OxContentOptions, OxContentPlugin, PluginConfig, RehypePlugin, RemarkPlugin, ResolvedDocsConfig, ResolvedOptions, TocEntry, TransformResult, unplugin as default, unplugin, transformMarkdown };
+import { C as ResolvedDocsConfig, D as UnifiedPreset, E as TransformResult, S as RemarkPlugin, T as TocEntry, _ as OxContentMdastPlugin, a as extractTocFromMdast, b as PluginConfig, c as toUnifiedMdastPlugin, d as MarkdownItPlugin, f as MdastNode, g as MdastTransformer, h as MdastRoot, i as defineMdastPlugin, l as transformMarkdown, m as MdastPluginContext, n as OxContentMdastOptions, o as oxContentMdast, p as MdastPlugin, r as createMdastPluginContext, s as parseMarkdownToMdast, t as unplugin, u as DocsConfig, v as OxContentOptions, w as ResolvedOptions, x as RehypePlugin, y as OxContentPlugin } from "./index.mjs";
+export { DocsConfig, MarkdownItPlugin, MdastNode, MdastPlugin, MdastPluginContext, MdastRoot, MdastTransformer, OxContentMdastOptions, OxContentMdastPlugin, OxContentOptions, OxContentPlugin, PluginConfig, RehypePlugin, RemarkPlugin, ResolvedDocsConfig, ResolvedOptions, TocEntry, TransformResult, UnifiedPreset, createMdastPluginContext, unplugin as default, unplugin, defineMdastPlugin, extractTocFromMdast, oxContentMdast, parseMarkdownToMdast, toUnifiedMdastPlugin, transformMarkdown };

package/dist/rollup.d.mts

@@ -1,7 +1,7 @@
-import { a as OxContentOptions, d as ResolvedOptions, f as TocEntry, p as TransformResult, t as unplugin } from "./index.mjs";
+import { C as ResolvedDocsConfig, D as UnifiedPreset, E as TransformResult, S as RemarkPlugin, T as TocEntry, _ as OxContentMdastPlugin, a as extractTocFromMdast, b as PluginConfig, c as toUnifiedMdastPlugin, d as MarkdownItPlugin, f as MdastNode, g as MdastTransformer, h as MdastRoot, i as defineMdastPlugin, l as transformMarkdown, m as MdastPluginContext, n as OxContentMdastOptions, o as oxContentMdast, p as MdastPlugin, r as createMdastPluginContext, s as parseMarkdownToMdast, t as unplugin, u as DocsConfig, v as OxContentOptions, w as ResolvedOptions, x as RehypePlugin, y as OxContentPlugin } from "./index.mjs";
 import * as unplugin$1 from "unplugin";
 
 //#region src/rollup.d.ts
 declare const _default: (options?: OxContentOptions | undefined) => unplugin$1.RollupPlugin<any> | unplugin$1.RollupPlugin<any>[];
 //#endregion
-export { type OxContentOptions, type ResolvedOptions, type TocEntry, type TransformResult, _default as default, unplugin };
+export { DocsConfig, MarkdownItPlugin, MdastNode, MdastPlugin, MdastPluginContext, MdastRoot, MdastTransformer, OxContentMdastOptions, OxContentMdastPlugin, OxContentOptions, OxContentPlugin, PluginConfig, RehypePlugin, RemarkPlugin, ResolvedDocsConfig, ResolvedOptions, TocEntry, TransformResult, UnifiedPreset, createMdastPluginContext, _default as default, defineMdastPlugin, extractTocFromMdast, oxContentMdast, parseMarkdownToMdast, toUnifiedMdastPlugin, transformMarkdown, unplugin };

package/dist/rollup.mjs

@@ -1,8 +1,8 @@
-import { t as unplugin } from "./src.mjs";
+import { a as extractTocFromMdast, c as toUnifiedMdastPlugin, i as defineMdastPlugin, n as transformMarkdown, o as oxContentMdast, r as createMdastPluginContext, s as parseMarkdownToMdast, t as unplugin } from "./src.mjs";
 //#region src/rollup.ts
 /**
 * Rollup plugin export for @ox-content/unplugin
 */
 var rollup_default = unplugin.rollup;
 //#endregion
-export { rollup_default as default, unplugin };
+export { createMdastPluginContext, rollup_default as default, defineMdastPlugin, extractTocFromMdast, oxContentMdast, parseMarkdownToMdast, toUnifiedMdastPlugin, transformMarkdown, unplugin };

package/dist/rspack.d.mts

@@ -1,6 +1,6 @@
-import { a as OxContentOptions, d as ResolvedOptions, f as TocEntry, p as TransformResult, t as unplugin } from "./index.mjs";
+import { C as ResolvedDocsConfig, D as UnifiedPreset, E as TransformResult, S as RemarkPlugin, T as TocEntry, _ as OxContentMdastPlugin, a as extractTocFromMdast, b as PluginConfig, c as toUnifiedMdastPlugin, d as MarkdownItPlugin, f as MdastNode, g as MdastTransformer, h as MdastRoot, i as defineMdastPlugin, l as transformMarkdown, m as MdastPluginContext, n as OxContentMdastOptions, o as oxContentMdast, p as MdastPlugin, r as createMdastPluginContext, s as parseMarkdownToMdast, t as unplugin, u as DocsConfig, v as OxContentOptions, w as ResolvedOptions, x as RehypePlugin, y as OxContentPlugin } from "./index.mjs";
 
 //#region src/rspack.d.ts
 declare const _default: (options?: OxContentOptions | undefined) => RspackPluginInstance;
 //#endregion
-export { type OxContentOptions, type ResolvedOptions, type TocEntry, type TransformResult, _default as default, unplugin };
+export { DocsConfig, MarkdownItPlugin, MdastNode, MdastPlugin, MdastPluginContext, MdastRoot, MdastTransformer, OxContentMdastOptions, OxContentMdastPlugin, OxContentOptions, OxContentPlugin, PluginConfig, RehypePlugin, RemarkPlugin, ResolvedDocsConfig, ResolvedOptions, TocEntry, TransformResult, UnifiedPreset, createMdastPluginContext, _default as default, defineMdastPlugin, extractTocFromMdast, oxContentMdast, parseMarkdownToMdast, toUnifiedMdastPlugin, transformMarkdown, unplugin };

package/dist/rspack.mjs

@@ -1,8 +1,8 @@
-import { t as unplugin } from "./src.mjs";
+import { a as extractTocFromMdast, c as toUnifiedMdastPlugin, i as defineMdastPlugin, n as transformMarkdown, o as oxContentMdast, r as createMdastPluginContext, s as parseMarkdownToMdast, t as unplugin } from "./src.mjs";
 //#region src/rspack.ts
 /**
 * Rspack plugin export for @ox-content/unplugin
 */
 var rspack_default = unplugin.rspack;
 //#endregion
-export { rspack_default as default, unplugin };
+export { createMdastPluginContext, rspack_default as default, defineMdastPlugin, extractTocFromMdast, oxContentMdast, parseMarkdownToMdast, toUnifiedMdastPlugin, transformMarkdown, unplugin };