@nuxtjs/mdc 0.8.0 → 0.8.2

package/README.md

@@ -76,7 +76,7 @@ This component will take the result of [`parseMarkdown`](#parsing-markdown) func
 <script setup lang="ts">
 import { parseMarkdown } from '@nuxtjs/mdc/runtime'
 
-const ast = await useAsyncData('markdown', () => parseMarkdown('::alert\nMissing markdown input\n::'))
+const { data: ast } = await useAsyncData('markdown', () => parseMarkdown('::alert\nMissing markdown input\n::'))
 </script>
 
 <template>
@@ -196,7 +196,7 @@ The `parseMarkdown` function is a universal helper, and you can also use it in t
 <script setup lang="ts">
 import { parseMarkdown } from '@nuxtjs/mdc/runtime'
 
-const ast = await useAsyncData('markdown', () => parseMarkdown('::alert\nMissing markdown input\n::'))
+const { data: ast } = await useAsyncData('markdown', () => parseMarkdown('::alert\nMissing markdown input\n::'))
 </script>
 
 <template>
@@ -367,7 +367,7 @@ Now import the `useMarkdownParser` composable we just created along with an expo
 import { onBeforeMount, ref, watch } from 'vue'
 // Import package exports
 import MDCRenderer from '@nuxtjs/mdc/runtime/components/MDCRenderer.vue'
-import type { MDCParserResult } from '@nuxtjs/mdc/runtime/types/index'
+import type { MDCParserResult } from '@nuxtjs/mdc'
 import useMarkdownParser from './composables/useMarkdownParser';
 
 const md = ref(`

package/dist/config.d.mts

@@ -1,5 +1,6 @@
-import { MdcConfig } from '../dist/runtime/types/config.js';
-
-declare function defineConfig(config: MdcConfig): MdcConfig;
-
-export { defineConfig };
+export { defineConfig } from './module.mjs';
+import '@nuxt/schema';
+import 'shiki';
+import 'remark-rehype';
+import 'unified';
+import 'hast';

package/dist/config.d.ts

@@ -1,5 +1,6 @@
-import { MdcConfig } from '../dist/runtime/types/config.js';
-
-declare function defineConfig(config: MdcConfig): MdcConfig;
-
-export { defineConfig };
+export { defineConfig } from './module.js';
+import '@nuxt/schema';
+import 'shiki';
+import 'remark-rehype';
+import 'unified';
+import 'hast';

package/dist/config.mjs

@@ -1,5 +1,7 @@
-function defineConfig(config) {
-  return config;
-}
-
-export { defineConfig };
+export { defineConfig } from './module.mjs';
+import 'node:fs';
+import '@nuxt/kit';
+import 'defu';
+import 'pathe';
+import 'node:fs/promises';
+import 'scule';

package/dist/module.d.mts

@@ -1,6 +1,141 @@
 import * as _nuxt_schema from '@nuxt/schema';
-import { BundledLanguage, LanguageRegistration, BundledTheme, ThemeRegistrationAny } from 'shiki';
-import { MdcThemeOptions } from '../dist/runtime/highlighter/types.js';
+import { BuiltinTheme, Highlighter as Highlighter$1, ShikiTransformer, HighlighterCore, BundledLanguage, LanguageRegistration, BundledTheme, ThemeRegistrationAny } from 'shiki';
+import { Options } from 'remark-rehype';
+import { Processor } from 'unified';
+import { ElementContent as ElementContent$1 } from 'hast';
+
+type MDCText = {
+    type: 'text';
+    value: string;
+};
+type MDCComment = {
+    type: 'comment';
+    value: string;
+};
+type MDCElement = {
+    type: 'element';
+    tag: string;
+    props: Record<string, any> | undefined;
+    children: Array<MDCElement | MDCText | MDCComment>;
+};
+type MDCNode = MDCElement | MDCText | MDCComment;
+type MDCRoot = {
+    type: 'root';
+    children: Array<MDCNode>;
+};
+interface MDCData extends Record<string, any> {
+    title: string;
+    description: string;
+}
+
+type MdcThemeOptions = BuiltinTheme | string | Record<string, BuiltinTheme | string>;
+interface HighlighterOptions {
+    highlights?: number[];
+    meta?: string;
+}
+interface HighlightResult {
+    tree: ElementContent$1[];
+    className?: string;
+    style?: string;
+    inlineStyle?: string;
+}
+type Highlighter = (code: string, lang: string, theme: MdcThemeOptions, options: Partial<HighlighterOptions>) => Promise<HighlightResult>;
+interface RehypeHighlightOption {
+    theme?: MdcThemeOptions;
+    highlighter?: Highlighter;
+}
+
+type Awaitable<T> = T | Promise<T>;
+interface MdcConfig {
+    /**
+     * Hooks for the unified markdown pipeline
+     */
+    unified?: {
+        /**
+         * Custom setup for unified processor before other plugins
+         */
+        pre?: (processor: Processor) => Awaitable<void | Processor>;
+        /**
+         * Custom setup for unified processor after remark but before rehype
+         */
+        remark?: (processor: Processor) => Awaitable<void | Processor>;
+        /**
+         * Custom setup for unified processor after rehype
+         */
+        rehype?: (processor: Processor) => Awaitable<void | Processor>;
+        /**
+         * Custom setup for unified processor after all plugins
+         */
+        post?: (processor: Processor) => Awaitable<void | Processor>;
+    };
+    /**
+     * Custom hightlighter, available when `highlighter` is set to `custom`
+     */
+    highlighter?: Highlighter$1;
+    /**
+     * Hooks for shiki
+     */
+    shiki?: {
+        /**
+         * Get transformers for shiki
+         */
+        transformers?: ShikiTransformer[] | ((code: string, lang: string, theme: MdcThemeOptions, options: Partial<HighlighterOptions>) => Awaitable<ShikiTransformer[]>);
+        /**
+         * Custom setup for shiki instance, only called once on server or client
+         */
+        setup?: (highlighter: HighlighterCore) => Awaitable<void>;
+    };
+}
+
+interface TocLink {
+    id: string;
+    text: string;
+    depth: number;
+    children?: TocLink[];
+}
+interface Toc {
+    title: string;
+    depth: number;
+    searchDepth: number;
+    links: TocLink[];
+}
+
+interface RemarkPlugin {
+    instance?: any;
+    options?: Array<any> | Record<string, any>;
+}
+interface RehypePlugin {
+    instance?: any;
+    options?: Array<any> | Record<string, any>;
+}
+interface MDCParseOptions {
+    remark?: {
+        plugins?: Record<string, false | RemarkPlugin>;
+    };
+    rehype?: {
+        options?: Options;
+        plugins?: Record<string, false | RehypePlugin>;
+    };
+    highlight?: RehypeHighlightOption | false;
+    toc?: {
+        /**
+         * Maximum heading depth to include in the table of contents.
+         */
+        depth?: number;
+        searchDepth?: number;
+    };
+    keepComments?: boolean;
+    /**
+     * Inline mdc.config.ts
+     */
+    configs?: MdcConfig[];
+}
+interface MDCParserResult {
+    data: MDCData;
+    body: MDCRoot;
+    excerpt: MDCRoot | undefined;
+    toc: Toc | undefined;
+}
 
 interface UnistPlugin {
     src?: string;
@@ -69,6 +204,370 @@ interface ModuleOptions {
     };
 }
 
+/**
+ * Info associated with nodes by the ecosystem.
+ *
+ * This space is guaranteed to never be specified by unist or specifications
+ * implementing unist.
+ * But you can use it in utilities and plugins to store data.
+ *
+ * This type can be augmented to register custom data.
+ * For example:
+ *
+ * ```ts
+ * declare module 'unist' {
+ *   interface Data {
+ *     // `someNode.data.myId` is typed as `number | undefined`
+ *     myId?: number | undefined
+ *   }
+ * }
+ * ```
+ */
+interface Data$1 {
+}
+/**
+ * One place in a source file.
+ */
+interface Point {
+    /**
+     * Line in a source file (1-indexed integer).
+     */
+    line: number;
+    /**
+     * Column in a source file (1-indexed integer).
+     */
+    column: number;
+    /**
+     * Character in a source file (0-indexed integer).
+     */
+    offset?: number | undefined;
+}
+/**
+ * Position of a node in a source document.
+ *
+ * A position is a range between two points.
+ */
+interface Position {
+    /**
+     * Place of the first character of the parsed source region.
+     */
+    start: Point;
+    /**
+     * Place of the first character after the parsed source region.
+     */
+    end: Point;
+}
+/**
+ * Abstract unist node that contains the smallest possible value.
+ *
+ * This interface is supposed to be extended.
+ *
+ * For example, in HTML, a `text` node is a leaf that contains text.
+ */
+interface Literal$1 extends Node$1 {
+    /**
+     * Plain value.
+     */
+    value: unknown;
+}
+/**
+ * Abstract unist node.
+ *
+ * The syntactic unit in unist syntax trees are called nodes.
+ *
+ * This interface is supposed to be extended.
+ * If you can use {@link Literal} or {@link Parent}, you should.
+ * But for example in markdown, a `thematicBreak` (`***`), is neither literal
+ * nor parent, but still a node.
+ */
+interface Node$1 {
+    /**
+     * Node type.
+     */
+    type: string;
+    /**
+     * Info from the ecosystem.
+     */
+    data?: Data$1 | undefined;
+    /**
+     * Position of a node in a source document.
+     *
+     * Nodes that are generated (not in the original source document) must not
+     * have a position.
+     */
+    position?: Position | undefined;
+}
+/**
+ * Abstract unist node that contains other nodes (*children*).
+ *
+ * This interface is supposed to be extended.
+ *
+ * For example, in XML, an element is a parent of different things, such as
+ * comments, text, and further elements.
+ */
+interface Parent$1 extends Node$1 {
+    /**
+     * List of children.
+     */
+    children: Node$1[];
+}
+
+/**
+ * Info associated with hast nodes by the ecosystem.
+ *
+ * This space is guaranteed to never be specified by unist or hast.
+ * But you can use it in utilities and plugins to store data.
+ *
+ * This type can be augmented to register custom data.
+ * For example:
+ *
+ * ```ts
+ * declare module 'hast' {
+ *   interface Data {
+ *     // `someNode.data.myId` is typed as `number | undefined`
+ *     myId?: number | undefined
+ *   }
+ * }
+ * ```
+ */
+interface Data extends Data$1 {
+}
+/**
+ * Info associated with an element.
+ */
+interface Properties {
+    [PropertyName: string]: boolean | number | string | null | undefined | Array<string | number>;
+}
+/**
+ * Union of registered hast nodes that can occur in {@link Element}.
+ *
+ * To register mote custom hast nodes, add them to {@link ElementContentMap}.
+ * They will be automatically added here.
+ */
+type ElementContent = ElementContentMap[keyof ElementContentMap];
+/**
+ * Registry of all hast nodes that can occur as children of {@link Element}.
+ *
+ * For a union of all {@link Element} children, see {@link ElementContent}.
+ */
+interface ElementContentMap {
+    comment: Comment;
+    element: Element;
+    text: Text;
+}
+/**
+ * Union of registered hast nodes that can occur in {@link Root}.
+ *
+ * To register custom hast nodes, add them to {@link RootContentMap}.
+ * They will be automatically added here.
+ */
+type RootContent = RootContentMap[keyof RootContentMap];
+/**
+ * Registry of all hast nodes that can occur as children of {@link Root}.
+ *
+ * > 👉 **Note**: {@link Root} does not need to be an entire document.
+ * > it can also be a fragment.
+ *
+ * For a union of all {@link Root} children, see {@link RootContent}.
+ */
+interface RootContentMap {
+    comment: Comment;
+    doctype: Doctype;
+    element: Element;
+    text: Text;
+}
+/**
+ * Union of registered hast nodes that can occur in {@link Root}.
+ *
+ * @deprecated Use {@link RootContent} instead.
+ */
+type Content = RootContent;
+/**
+ * Union of registered hast literals.
+ *
+ * To register custom hast nodes, add them to {@link RootContentMap} and other
+ * places where relevant.
+ * They will be automatically added here.
+ */
+type Literals = Extract<Nodes, Literal$1>;
+/**
+ * Union of registered hast nodes.
+ *
+ * To register custom hast nodes, add them to {@link RootContentMap} and other
+ * places where relevant.
+ * They will be automatically added here.
+ */
+type Nodes = Root | RootContent;
+/**
+ * Union of registered hast parents.
+ *
+ * To register custom hast nodes, add them to {@link RootContentMap} and other
+ * places where relevant.
+ * They will be automatically added here.
+ */
+type Parents = Extract<Nodes, Parent$1>;
+/**
+ * Abstract hast node.
+ *
+ * This interface is supposed to be extended.
+ * If you can use {@link Literal} or {@link Parent}, you should.
+ * But for example in HTML, a `Doctype` is neither literal nor parent, but
+ * still a node.
+ *
+ * To register custom hast nodes, add them to {@link RootContentMap} and other
+ * places where relevant (such as {@link ElementContentMap}).
+ *
+ * For a union of all registered hast nodes, see {@link Nodes}.
+ */
+interface Node extends Node$1 {
+    /**
+     * Info from the ecosystem.
+     */
+    data?: Data | undefined;
+}
+/**
+ * Abstract hast node that contains the smallest possible value.
+ *
+ * This interface is supposed to be extended if you make custom hast nodes.
+ *
+ * For a union of all registered hast literals, see {@link Literals}.
+ */
+interface Literal extends Node {
+    /**
+     * Plain-text value.
+     */
+    value: string;
+}
+/**
+ * Abstract hast node that contains other hast nodes (*children*).
+ *
+ * This interface is supposed to be extended if you make custom hast nodes.
+ *
+ * For a union of all registered hast parents, see {@link Parents}.
+ */
+interface Parent extends Node {
+    /**
+     * List of children.
+     */
+    children: RootContent[];
+}
+/**
+ * HTML comment.
+ */
+interface Comment extends Literal {
+    /**
+     * Node type of HTML comments in hast.
+     */
+    type: 'comment';
+    /**
+     * Data associated with the comment.
+     */
+    data?: CommentData | undefined;
+}
+/**
+ * Info associated with hast comments by the ecosystem.
+ */
+interface CommentData extends Data {
+}
+/**
+ * HTML document type.
+ */
+interface Doctype extends Node$1 {
+    /**
+     * Node type of HTML document types in hast.
+     */
+    type: 'doctype';
+    /**
+     * Data associated with the doctype.
+     */
+    data?: DoctypeData | undefined;
+}
+/**
+ * Info associated with hast doctypes by the ecosystem.
+ */
+interface DoctypeData extends Data {
+}
+/**
+ * HTML element.
+ */
+interface Element extends Parent {
+    /**
+     * Node type of elements.
+     */
+    type: 'element';
+    /**
+     * Tag name (such as `'body'`) of the element.
+     */
+    tagName: string;
+    /**
+     * Info associated with the element.
+     */
+    properties: Properties;
+    /**
+     * Children of element.
+     */
+    children: ElementContent[];
+    /**
+     * When the `tagName` field is `'template'`, a `content` field can be
+     * present.
+     */
+    content?: Root | undefined;
+    /**
+     * Data associated with the element.
+     */
+    data?: ElementData | undefined;
+}
+/**
+ * Info associated with hast elements by the ecosystem.
+ */
+interface ElementData extends Data {
+}
+/**
+ * Document fragment or a whole document.
+ *
+ * Should be used as the root of a tree and must not be used as a child.
+ *
+ * Can also be used as the value for the content field on a `'template'` element.
+ */
+interface Root extends Parent {
+    /**
+     * Node type of hast root.
+     */
+    type: 'root';
+    /**
+     * Children of root.
+     */
+    children: RootContent[];
+    /**
+     * Data associated with the hast root.
+     */
+    data?: RootData | undefined;
+}
+/**
+ * Info associated with hast root nodes by the ecosystem.
+ */
+interface RootData extends Data {
+}
+/**
+ * HTML character data (plain text).
+ */
+interface Text extends Literal {
+    /**
+     * Node type of HTML character data (plain text) in hast.
+     */
+    type: 'text';
+    /**
+     * Data associated with the text.
+     */
+    data?: TextData | undefined;
+}
+/**
+ * Info associated with hast texts by the ecosystem.
+ */
+interface TextData extends Data {
+}
+
+declare function defineConfig(config: MdcConfig): MdcConfig;
 declare const DefaultHighlightLangs: BundledLanguage[];
 declare const _default: _nuxt_schema.NuxtModule<ModuleOptions>;
 
@@ -101,4 +600,4 @@ declare module '@nuxt/schema' {
     }
 }
 
-export { DefaultHighlightLangs, _default as default };
+export { type Awaitable, type Comment, type CommentData, type Content, type Data, DefaultHighlightLangs, type Doctype, type DoctypeData, type Element, type ElementContent, type ElementContentMap, type ElementData, type HighlightResult, type Highlighter, type HighlighterOptions, type Literal, type Literals, type MDCComment, type MDCData, type MDCElement, type MDCNode, type MDCParseOptions, type MDCParserResult, type MDCRoot, type MDCText, type MdcConfig, type MdcThemeOptions, type ModuleOptions, type Node, type Nodes, type Parent, type Parents, type Properties, type RehypeHighlightOption, type RehypePlugin, type RemarkPlugin, type Root, type RootContent, type RootContentMap, type RootData, type Text, type TextData, type Toc, type TocLink, type UnistPlugin, _default as default, defineConfig };