@docubook/core 1.8.0 → 1.8.2

package/README.md

@@ -90,8 +90,8 @@ const tocs = await docsService.getTocsForSlug("getting-started/introduction");
 | `handleCodeExpandableRemark` | Remark plugin that detects `Expandable` meta on code blocks and injects expandable data attributes | transformer function |
 | `handleCodeExpandable` | Rehype plugin that propagates expandable metadata from `<code>` to `<pre>` elements | transformer function |
 | `rehypeMermaid` | Rehype plugin that transforms ` ```mermaid ` fenced code blocks into `<Mermaid chart="...">` elements | transformer function |
-| `serialize` | Re-exported from `next-mdx-remote/serialize` for non-RSC MDX compilation workflows | `MDXRemoteSerializeResult` |
-| `MDXRemote` | Re-exported from `next-mdx-remote` for client-side MDX hydration | React component |
+| `serialize` | Re-exported from `@docubook/mdx-remote/serialize` for non-RSC MDX compilation workflows | `MDXRemoteSerializeResult` |
+| `MDXRemote` | Re-exported from `@docubook/mdx-remote` for client-side MDX hydration | React component |
 | `cn` | Merge class names using `clsx` + `tailwind-merge` | `string` |
 | `parseDate` | Parse `dd-MM-yyyy` or ISO 8601 date strings into a Date object | `Date` |
 | `stringToDate` | Convert a string or Date value to a Date object | `Date` |
@@ -408,7 +408,7 @@ This means app-level users should focus on content and integration. Plugin upgra
 
 - clsx — class name composition for the `cn()` utility
 - tailwind-merge — intelligent Tailwind class merging for the `cn()` utility
-- next-mdx-remote — MDX runtime/compile engine (`serialize`, `MDXRemote`)
+- @docubook/mdx-remote — MDX runtime/compile engine (`serialize`, `MDXRemote`)
 
 The `remark` and `rehype` plugin stack is intentionally owned by this package to avoid dependency drift across apps.
 
@@ -421,11 +421,11 @@ The `remark` and `rehype` plugin stack is intentionally owned by this package to
 
 ## Notes
 
-`@docubook/core` already includes and manages the MDX runtime/compile dependencies (including `next-mdx-remote`) as part of the package contract.
+`@docubook/core` already includes and manages the MDX runtime/compile dependencies (including `@docubook/mdx-remote`) as part of the package contract.
 
 In most integrations, users only need to install `@docubook/core` and use the core APIs.
 
-Only add `next-mdx-remote` directly in your app if your app explicitly imports it in app-level code.
+Only import `@docubook/mdx-remote` directly in your app if your app explicitly needs it in app-level code.
 
 For compile pipeline plugins (especially `remark` and `rehype` plugins), rely on this package and avoid re-declaring them at app level unless you have a specific override requirement.
 

package/dist/chunk-HZJLRYAI.js

@@ -0,0 +1,45 @@
+// src/utils.ts
+import { clsx } from "clsx";
+import { twMerge } from "tailwind-merge";
+function cn(...inputs) {
+  return twMerge(clsx(inputs));
+}
+function parseDate(dateStr) {
+  if (/^\d{4}-/.test(dateStr)) return new Date(dateStr);
+  const [day, month, year] = dateStr.split("-").map(Number);
+  return new Date(year, month - 1, day);
+}
+function stringToDate(date) {
+  return date instanceof Date ? date : parseDate(date);
+}
+function formatDate(dateStrOrDate) {
+  const date = stringToDate(dateStrOrDate);
+  return date.toLocaleDateString("en-US", {
+    weekday: "long",
+    year: "numeric",
+    month: "long",
+    day: "numeric"
+  });
+}
+function formatDate2(dateStrOrDate) {
+  const date = stringToDate(dateStrOrDate);
+  return date.toLocaleDateString("en-US", {
+    month: "short",
+    day: "numeric",
+    year: "numeric"
+  });
+}
+function toIsoDateOnly(dateStrOrDate) {
+  const date = stringToDate(dateStrOrDate);
+  return date.toISOString().slice(0, 10);
+}
+
+export {
+  cn,
+  parseDate,
+  stringToDate,
+  formatDate,
+  formatDate2,
+  toIsoDateOnly
+};
+//# sourceMappingURL=chunk-HZJLRYAI.js.map

package/dist/chunk-HZJLRYAI.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/utils.ts"],"sourcesContent":["import { type ClassValue, clsx } from \"clsx\";\nimport { twMerge } from \"tailwind-merge\";\nimport type { Node } from \"unist\";\n\nexport interface ElementNode extends Node {\n  type: string;\n  tagName?: string;\n  properties?: Record<string, unknown> & {\n    className?: string[] | string;\n    raw?: string;\n  };\n  data?: Record<string, unknown>;\n  children?: Node[];\n  raw?: string;\n  language?: string;\n  codeTitle?: string;\n}\n\nexport function cn(...inputs: ClassValue[]) {\n  return twMerge(clsx(inputs));\n}\n\n/** Parse both `dd-MM-yyyy` and ISO 8601 date strings into a Date object. */\nexport function parseDate(dateStr: string): Date {\n  if (/^\\d{4}-/.test(dateStr)) return new Date(dateStr);\n  const [day, month, year] = dateStr.split(\"-\").map(Number);\n  return new Date(year, month - 1, day);\n}\n\nexport function stringToDate(date: string | Date) {\n  return date instanceof Date ? date : parseDate(date);\n}\n\n/** Format date to long format (e.g. \"Thursday, April 5, 2026\") */\nexport function formatDate(dateStrOrDate: string | Date): string {\n  const date = stringToDate(dateStrOrDate);\n  return date.toLocaleDateString(\"en-US\", {\n    weekday: \"long\",\n    year: \"numeric\",\n    month: \"long\",\n    day: \"numeric\",\n  });\n}\n\n/** Format date to short format (e.g. \"Apr 5, 2026\") */\nexport function formatDate2(dateStrOrDate: string | Date): string {\n  const date = stringToDate(dateStrOrDate);\n  return date.toLocaleDateString(\"en-US\", {\n    month: \"short\",\n    day: \"numeric\",\n    year: \"numeric\",\n  });\n}\n\nexport function toIsoDateOnly(dateStrOrDate: string | Date): string {\n  const date = stringToDate(dateStrOrDate);\n  return date.toISOString().slice(0, 10);\n}\n"],"mappings":";AAAA,SAA0B,YAAY;AACtC,SAAS,eAAe;AAiBjB,SAAS,MAAM,QAAsB;AAC1C,SAAO,QAAQ,KAAK,MAAM,CAAC;AAC7B;AAGO,SAAS,UAAU,SAAuB;AAC/C,MAAI,UAAU,KAAK,OAAO,EAAG,QAAO,IAAI,KAAK,OAAO;AACpD,QAAM,CAAC,KAAK,OAAO,IAAI,IAAI,QAAQ,MAAM,GAAG,EAAE,IAAI,MAAM;AACxD,SAAO,IAAI,KAAK,MAAM,QAAQ,GAAG,GAAG;AACtC;AAEO,SAAS,aAAa,MAAqB;AAChD,SAAO,gBAAgB,OAAO,OAAO,UAAU,IAAI;AACrD;AAGO,SAAS,WAAW,eAAsC;AAC/D,QAAM,OAAO,aAAa,aAAa;AACvC,SAAO,KAAK,mBAAmB,SAAS;AAAA,IACtC,SAAS;AAAA,IACT,MAAM;AAAA,IACN,OAAO;AAAA,IACP,KAAK;AAAA,EACP,CAAC;AACH;AAGO,SAAS,YAAY,eAAsC;AAChE,QAAM,OAAO,aAAa,aAAa;AACvC,SAAO,KAAK,mBAAmB,SAAS;AAAA,IACtC,OAAO;AAAA,IACP,KAAK;AAAA,IACL,MAAM;AAAA,EACR,CAAC;AACH;AAEO,SAAS,cAAc,eAAsC;AAClE,QAAM,OAAO,aAAa,aAAa;AACvC,SAAO,KAAK,YAAY,EAAE,MAAM,GAAG,EAAE;AACvC;","names":[]}

package/dist/index.d.ts

@@ -1,11 +1,118 @@
-export type { TocItem, MdxCompileResult } from "./types";
-export { cn, parseDate, stringToDate, formatDate, formatDate2, toIsoDateOnly } from "./utils";
-export { parseMdx, serialize, MDXRemote, preProcess, postProcess, createDefaultRehypePlugins, createDefaultRemarkPlugins, } from "./compile";
-export { handleCodeTitles } from "./plugins/handleCodeTitles";
-export { handleCodeExpandableRemark, handleCodeExpandable } from "./plugins/handleCodeExpandable";
-export { rehypeMermaid } from "./plugins/rehypeMermaid";
-export { extractFrontmatter, extractFrontmatterWithContent, extractTocsFromRawMdx, sluggify, } from "./extract";
-export type { ParseMdxOptions } from "./compile";
-export { readMdxFileBySlug, parseMdxFile, compileParsedMdxFile, createMdxContentService, } from "./content";
-export type { ReadMdxFileResult, ParsedMdxFile, CompiledMdxFile, CreateMdxContentServiceOptions, } from "./content";
-//# sourceMappingURL=index.d.ts.map
+import { ReactNode } from 'react';
+export { cn, formatDate, formatDate2, parseDate, stringToDate, toIsoDateOnly } from './utils.js';
+import { compileMDX } from '@docubook/mdx-remote/rsc';
+import { Node } from 'unist';
+import { Pluggable } from 'unified';
+export { MDXRemote } from '@docubook/mdx-remote';
+export { serialize } from '@docubook/mdx-remote/serialize';
+import 'clsx';
+
+type TocItem = {
+    level: number;
+    text: string;
+    href: string;
+};
+type MdxCompileResult<Frontmatter> = {
+    content: ReactNode;
+    frontmatter: Frontmatter;
+    scope?: Record<string, unknown>;
+};
+
+type CompileMdxInput = Parameters<typeof compileMDX<Record<string, unknown>>>[0];
+type CompileMdxOptions = NonNullable<CompileMdxInput["options"]>;
+type CompilerMdxOptions = NonNullable<CompileMdxOptions["mdxOptions"]>;
+type ParseMdxOptions = {
+    components?: CompileMdxInput["components"];
+    rehypePlugins?: CompilerMdxOptions["rehypePlugins"];
+    remarkPlugins?: CompilerMdxOptions["remarkPlugins"];
+    /**
+     * Whether to parse frontmatter during MDX compilation.
+     * Set to `false` when frontmatter is already extracted separately
+     * (e.g. via gray-matter) to avoid redundant parsing.
+     * Defaults to `true`.
+     */
+    parseFrontmatter?: boolean;
+};
+declare const preProcess: () => (tree: Node) => Node;
+declare const postProcess: () => (tree: Node) => Node;
+declare function createDefaultRehypePlugins(): Pluggable[];
+declare function createDefaultRemarkPlugins(): Pluggable[];
+declare function parseMdx<Frontmatter>(rawMdx: string, options?: ParseMdxOptions): Promise<MdxCompileResult<Frontmatter>>;
+
+declare const handleCodeTitles: () => (tree: Node) => void;
+
+declare const handleCodeExpandableRemark: () => (tree: Node) => void;
+declare const handleCodeExpandable: () => (tree: Node) => void;
+
+/**
+ * Rehype plugin that transforms `<pre><code class="language-mermaid">` fenced
+ * blocks into `<Mermaid chart="...">` elements.
+ *
+ * This allows Mermaid diagram definitions to be authored via standard fenced
+ * code blocks (````mermaid) which avoids JSX parsing collisions with
+ * Mermaid's `{...}` (decision nodes) and `[...]` (label nodes) syntax.
+ */
+declare const rehypeMermaid: () => (tree: Node) => void;
+
+declare function sluggify(text: string): string;
+declare function extractTocsFromRawMdx(rawMdx: string): TocItem[];
+declare function extractFrontmatter<Frontmatter>(content: string): Frontmatter;
+/**
+ * Extract frontmatter and return both the parsed data and the content
+ * with the frontmatter block stripped. Avoids a second parse by compileMDX.
+ */
+declare function extractFrontmatterWithContent<Frontmatter>(content: string): {
+    frontmatter: Frontmatter;
+    strippedContent: string;
+};
+
+type CacheFn = <T extends (...args: any[]) => any>(fn: T) => T;
+type ReadMdxFileResult = {
+    content: string;
+    /** Relative path used for UI links (e.g. "docs/getting-started/index.mdx"). */
+    filePath: string;
+    /** Absolute path on disk — available when file was read by readMdxFileBySlug. */
+    absoluteFilePath?: string;
+};
+type ParsedMdxFile<Frontmatter, T extends TocItem = TocItem> = {
+    /** Raw content with frontmatter block stripped — ready to pass to compileMDX. */
+    content: string;
+    filePath: string;
+    frontmatter: Frontmatter;
+    tocs: T[];
+};
+type CompiledMdxFile<Frontmatter, T extends TocItem = TocItem> = MdxCompileResult<Frontmatter> & {
+    filePath: string;
+    tocs: T[];
+};
+type ReadMdxBySlugOptions = {
+    rootDir?: string;
+    docsDir?: string;
+};
+declare function readMdxFileBySlug(slug: string, options?: ReadMdxBySlugOptions): Promise<ReadMdxFileResult>;
+type ParseMdxFileOptions<T extends TocItem> = {
+    tocsExtractor?: (rawMdx: string) => T[];
+};
+declare function parseMdxFile<Frontmatter, T extends TocItem = TocItem>(raw: ReadMdxFileResult, options?: ParseMdxFileOptions<T>): ParsedMdxFile<Frontmatter, T>;
+declare function compileParsedMdxFile<Frontmatter, T extends TocItem = TocItem>(parsed: ParsedMdxFile<Frontmatter, T>, options?: ParseMdxOptions): Promise<CompiledMdxFile<Frontmatter, T>>;
+type CreateMdxContentServiceOptions<Frontmatter, T extends TocItem = TocItem> = {
+    parseOptions?: ParseMdxOptions;
+    readOptions?: ReadMdxBySlugOptions;
+    tocsExtractor?: (rawMdx: string) => T[];
+    cacheFn?: CacheFn;
+    /**
+     * Optional hook to enrich or transform frontmatter after parsing.
+     * Called with the parsed frontmatter and the absolute file path.
+     * Runs at build time during static generation — ideal for injecting
+     * fallback values (e.g. git last-modified date when `date` is absent).
+     */
+    frontmatterEnricher?: (frontmatter: Frontmatter, absoluteFilePath: string) => Frontmatter | Promise<Frontmatter>;
+};
+declare function createMdxContentService<Frontmatter, T extends TocItem = TocItem>(options?: CreateMdxContentServiceOptions<Frontmatter, T>): {
+    getParsedForSlug: (slug: string) => Promise<ParsedMdxFile<Frontmatter, T>>;
+    getCompiledForSlug: (slug: string) => Promise<CompiledMdxFile<Frontmatter, T>>;
+    getFrontmatterForSlug: (slug: string) => Promise<Frontmatter>;
+    getTocsForSlug: (slug: string) => Promise<T[]>;
+};
+
+export { type CompiledMdxFile, type CreateMdxContentServiceOptions, type MdxCompileResult, type ParseMdxOptions, type ParsedMdxFile, type ReadMdxFileResult, type TocItem, compileParsedMdxFile, createDefaultRehypePlugins, createDefaultRemarkPlugins, createMdxContentService, extractFrontmatter, extractFrontmatterWithContent, extractTocsFromRawMdx, handleCodeExpandable, handleCodeExpandableRemark, handleCodeTitles, parseMdx, parseMdxFile, postProcess, preProcess, readMdxFileBySlug, rehypeMermaid, sluggify };