vue-intlayer 8.12.2 → 8.12.4-canary.0

package/dist/cjs/markdown/compiler.cjs

@@ -1 +1 @@
-Object.defineProperty(exports,Symbol.toStringTag,{value:`Module`});const e=require("./runtime.cjs");let t=require("@intlayer/core/markdown");var n=(n=``,r={})=>{let{components:i,namedCodesToUnicode:a,sanitizer:o,slugify:s,...c}=r;return(0,t.parseMarkdown)(n,{runtime:e.default,components:i,namedCodesToUnicode:a,sanitizer:o,slugify:s},c)},r=(n=``,r={})=>{if(typeof n==`string`)return(0,t.compileWithOptions)(n,e.default,r);let{components:i,namedCodesToUnicode:a,sanitizer:o,slugify:s,...c}=r;return(0,t.renderMarkdownAst)(n,{runtime:e.default,components:i,namedCodesToUnicode:a,sanitizer:o,slugify:s},c)},i=r,a=r;exports.RuleType=t.RuleType,exports.compile=a,exports.compileMarkdown=r,exports.compiler=i,exports.parseMarkdown=n,exports.sanitizer=t.sanitizer,exports.slugify=t.slugify;
+Object.defineProperty(exports,Symbol.toStringTag,{value:`Module`});const e=require("./runtime.cjs");let t=require("@intlayer/core/markdown");var n=(n=``,r={})=>{let{components:i,namedCodesToUnicode:a,sanitizer:o,slugify:s,...c}=r;return(0,t.parseMarkdown)(n,{runtime:e.default,components:i,namedCodesToUnicode:a,sanitizer:o,slugify:s},c)},r=(n=``,r={})=>{if(typeof n==`string`)return(0,t.compileWithOptions)(n,e.default,r);let{components:i,namedCodesToUnicode:a,sanitizer:o,slugify:s,...c}=r;return(0,t.renderMarkdownAst)(n,{runtime:e.default,components:i,namedCodesToUnicode:a,sanitizer:o,slugify:s},c)};exports.compileMarkdown=r,exports.parseMarkdown=n;

package/dist/cjs/markdown/index.cjs

@@ -1 +1 @@
-Object.defineProperty(exports,Symbol.toStringTag,{value:`Module`});const e=require("./compiler.cjs"),t=require("./installIntlayerMarkdown.cjs"),n=require("./MarkdownRenderer.cjs");let r=require("@intlayer/core/markdown");exports.MarkdownRenderer=n.MarkdownRenderer,exports.RuleType=r.RuleType,exports.compile=e.compile,exports.compileMarkdown=e.compileMarkdown,exports.compiler=e.compiler,exports.installIntlayerMarkdown=t.installIntlayerMarkdown,exports.intlayerMarkdown=t.intlayerMarkdown,exports.parseMarkdown=e.parseMarkdown,exports.renderMarkdown=n.renderMarkdown,exports.sanitizer=r.sanitizer,exports.slugify=r.slugify,exports.useMarkdown=t.useMarkdown,exports.useMarkdownRenderer=n.useMarkdownRenderer;
+Object.defineProperty(exports,Symbol.toStringTag,{value:`Module`});const e=require("./compiler.cjs"),t=require("./installIntlayerMarkdown.cjs"),n=require("./MarkdownRenderer.cjs");exports.MarkdownRenderer=n.MarkdownRenderer,exports.compileMarkdown=e.compileMarkdown,exports.installIntlayerMarkdown=t.installIntlayerMarkdown,exports.intlayerMarkdown=t.intlayerMarkdown,exports.parseMarkdown=e.parseMarkdown,exports.renderMarkdown=n.renderMarkdown,exports.useMarkdown=t.useMarkdown,exports.useMarkdownRenderer=n.useMarkdownRenderer;

package/dist/esm/markdown/compiler.mjs

@@ -1,25 +1,25 @@
 import e from "./runtime.mjs";
-import { RuleType as t, compileWithOptions as n, parseMarkdown as r, renderMarkdownAst as i, sanitizer as a, slugify as o } from "@intlayer/core/markdown";
+import { compileWithOptions as t, parseMarkdown as n, renderMarkdownAst as r } from "@intlayer/core/markdown";
 //#region src/markdown/compiler.ts
-var s = (t = "", n = {}) => {
-	let { components: i, namedCodesToUnicode: a, sanitizer: o, slugify: s, ...c } = n;
-	return r(t, {
+var i = (t = "", r = {}) => {
+	let { components: i, namedCodesToUnicode: a, sanitizer: o, slugify: s, ...c } = r;
+	return n(t, {
 		runtime: e,
 		components: i,
 		namedCodesToUnicode: a,
 		sanitizer: o,
 		slugify: s
 	}, c);
-}, c = (t = "", r = {}) => {
-	if (typeof t == "string") return n(t, e, r);
-	let { components: a, namedCodesToUnicode: o, sanitizer: s, slugify: c, ...l } = r;
-	return i(t, {
+}, a = (n = "", i = {}) => {
+	if (typeof n == "string") return t(n, e, i);
+	let { components: a, namedCodesToUnicode: o, sanitizer: s, slugify: c, ...l } = i;
+	return r(n, {
 		runtime: e,
 		components: a,
 		namedCodesToUnicode: o,
 		sanitizer: s,
 		slugify: c
 	}, l);
-}, l = c, u = c;
+};
 //#endregion
-export { t as RuleType, u as compile, c as compileMarkdown, l as compiler, s as parseMarkdown, a as sanitizer, o as slugify };
+export { a as compileMarkdown, i as parseMarkdown };

package/dist/esm/markdown/index.mjs

@@ -1,4 +1,4 @@
-import { RuleType as e, compile as t, compileMarkdown as n, compiler as r, parseMarkdown as i, sanitizer as a, slugify as o } from "./compiler.mjs";
-import { installIntlayerMarkdown as s, intlayerMarkdown as c, useMarkdown as l } from "./installIntlayerMarkdown.mjs";
-import { MarkdownRenderer as u, renderMarkdown as d, useMarkdownRenderer as f } from "./MarkdownRenderer.mjs";
-export { u as MarkdownRenderer, e as RuleType, t as compile, n as compileMarkdown, r as compiler, s as installIntlayerMarkdown, c as intlayerMarkdown, i as parseMarkdown, d as renderMarkdown, a as sanitizer, o as slugify, l as useMarkdown, f as useMarkdownRenderer };
+import { compileMarkdown as e, parseMarkdown as t } from "./compiler.mjs";
+import { installIntlayerMarkdown as n, intlayerMarkdown as r, useMarkdown as i } from "./installIntlayerMarkdown.mjs";
+import { MarkdownRenderer as a, renderMarkdown as o, useMarkdownRenderer as s } from "./MarkdownRenderer.mjs";
+export { a as MarkdownRenderer, e as compileMarkdown, n as installIntlayerMarkdown, r as intlayerMarkdown, t as parseMarkdown, o as renderMarkdown, i as useMarkdown, s as useMarkdownRenderer };

package/dist/types/markdown/MarkdownRenderer.d.ts

@@ -4,6 +4,22 @@ import { ParsedMarkdown } from './compiler';
 import { MarkdownPluginOptions, RenderMarkdownFunction } from './installIntlayerMarkdown';
 /**
  * Props for rendering markdown content.
+ *
+ * @example
+ * ```tsx
+ * const props: RenderMarkdownProps = {
+ *   components: {
+ *     h1: ({ children }) => <h1 className="text-3xl">{children}</h1>,
+ *     p: ({ children }) => <p className="text-gray-700">{children}</p>,
+ *   },
+ *   wrapper: ({ children }) => <article>{children}</article>,
+ *   options: {
+ *     forceBlock: true,
+ *     preserveFrontmatter: false,
+ *     tagfilter: true,
+ *   },
+ * };
+ * ```
  */
 export type RenderMarkdownProps = MarkdownPluginOptions & {
     /** Component overrides for HTML tags. */
@@ -16,6 +32,25 @@ export type RenderMarkdownProps = MarkdownPluginOptions & {
  *
  * This function does not use context from MarkdownProvider. Use `useMarkdownRenderer`
  * hook if you want to leverage provider context.
+ *
+ * @param content - The markdown string to render
+ * @param props - Configuration options for rendering
+ * @param props.components - Component overrides for HTML tags
+ * @param props.wrapper - Wrapper component for multiple children
+ * @returns Vue VNodes representing the rendered markdown
+ *
+ * @example
+ * ```ts
+ * import { renderMarkdown } from 'vue-intlayer/markdown';
+ *
+ * const markdown = '# Hello World\n\nThis is **bold** text.';
+ * const vnodes = await renderMarkdown(markdown, {
+ *   components: {
+ *     h1: ({ children }) => h('h1', { class: 'title' }, children),
+ *   },
+ *   forceBlock: true,
+ * });
+ * ```
  */
 export declare const renderMarkdown: (content: string | ParsedMarkdown, { components, wrapper, forceBlock, forceInline, preserveFrontmatter, tagfilter, }?: RenderMarkdownProps) => Promise<VNodeChild>;
 /**
@@ -23,12 +58,79 @@ export declare const renderMarkdown: (content: string | ParsedMarkdown, { compon
  *
  * This hook considers the configuration from the `MarkdownProvider` context if available,
  * falling back to the provided props or default behavior.
+ *
+ * @param props - Optional configuration that will override context values
+ * @param props.components - Component overrides for HTML tags (overrides context)
+ * @param props.wrapper - Wrapper component (overrides context)
+ * @returns A function that takes markdown content and returns VNodes
+ *
+ * @example
+ * ```vue
+ * <script setup>
+ * import { useMarkdownRenderer } from 'vue-intlayer/markdown';
+ *
+ * const renderMarkdown = useMarkdownRenderer({
+ *   components: {
+ *     h1: (props) => h('h1', { class: 'custom' }, props.children),
+ *   },
+ * });
+ * </script>
+ *
+ * <template>
+ *   <component :is="renderMarkdown('# Hello\n\nThis is **markdown**')" />
+ * </template>
+ * ```
  */
 export declare const useMarkdownRenderer: ({ components, wrapper, forceBlock, forceInline, preserveFrontmatter, tagfilter, }?: RenderMarkdownProps) => (content: string | ParsedMarkdown) => VNodeChild | Promise<VNodeChild>;
+/**
+ * Props for the MarkdownRenderer component.
+ *
+ * @example
+ * ```vue
+ * <script setup>
+ * const props = {
+ *   content: '# Hello World\n\nThis is **bold** text.',
+ *   components: {
+ *     h1: (props) => h('h1', { class: 'title' }, props.children),
+ *   },
+ *   forceBlock: true,
+ * };
+ * </script>
+ * ```
+ */
 export type MarkdownRendererProps = RenderMarkdownProps & {
+    /**
+     * The markdown content to render as a string.
+     */
     content?: string | ParsedMarkdown;
+    /**
+     * Custom render function for markdown.
+     * If provided, it will overwrite context and default rendering.
+     */
     renderMarkdown?: RenderMarkdownFunction;
 };
+/**
+ * Vue component that renders markdown content to VNodes.
+ *
+ * This component uses the `renderMarkdown` function from the `intlayerMarkdown` plugin
+ * if available. Otherwise, it falls back to the default compiler with provided components
+ * and options. You can also provide a custom `renderMarkdown` function prop to override
+ * all rendering behavior.
+ *
+ * @example
+ * ```vue
+ * <script setup>
+ * import { MarkdownRenderer } from 'vue-intlayer/markdown';
+ * </script>
+ *
+ * <template>
+ *   <MarkdownRenderer
+ *     content="# Hello World"
+ *     :forceBlock="true"
+ *   />
+ * </template>
+ * ```
+ */
 export declare const MarkdownRenderer: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
     content: {
         type: PropType<string | ParsedMarkdown>;

package/dist/types/markdown/compiler.d.ts

@@ -1,12 +1,51 @@
-import { CompileOptions, sanitizer as defaultSanitizer, slugify as defaultSlugify, ParsedMarkdown, RuleType } from '@intlayer/core/markdown';
-export { defaultSanitizer as sanitizer, defaultSlugify as slugify, RuleType };
+import { CompileOptions, ParsedMarkdown } from '@intlayer/core/markdown';
+/**
+ * Options accepted by `compileMarkdown` and `parseMarkdown` to customise
+ * rendering behaviour (custom components, sanitizer, slugify, rule hooks, …).
+ */
 export type MarkdownCompilerOptions = CompileOptions;
 /**
- * Compile markdown to Vue VNodes.
- * This is the primary export - use this for new code.
+ * Alias for `MarkdownCompilerOptions` to align with other frameworks.
+ */
+export type MarkdownRendererOptions = MarkdownCompilerOptions;
+/**
+ * Intermediate AST produced by `parseMarkdown`.
+ * Pass this to `compileMarkdown` to skip re-parsing when the same content is
+ * rendered multiple times.
  */
 export type { ParsedMarkdown };
+/**
+ * **Step 1 of 2 — parse only.**
+ * Converts a raw markdown string into a `ParsedMarkdown` AST without rendering
+ * any Vue VNodes. Use this when you need to:
+ * - Cache the parsed result and render it several times with different options.
+ * - Inspect or transform the AST before rendering.
+ * - Defer the render step to a later point.
+ *
+ * @param markdown - The markdown source string.
+ * @param options - Options that affect parsing (sanitizer, slugify, …).
+ * @returns A `ParsedMarkdown` AST ready to be passed to `compileMarkdown`.
+ *
+ * @example
+ * ```ts
+ * const ast = parseMarkdown('# Hello **world**');
+ * const vnodes = compileMarkdown(ast, { forceBlock: true });
+ * ```
+ */
 export declare const parseMarkdown: (markdown?: string, options?: MarkdownCompilerOptions) => ParsedMarkdown;
+/**
+ * **Steps 1 + 2 — parse and render in one shot.**
+ * Accepts a raw markdown string or a pre-parsed `ParsedMarkdown` AST and
+ * returns Vue VNodes. Use `parseMarkdown` first when you need to reuse the
+ * same AST with different options.
+ *
+ * @param input - Markdown string or pre-parsed AST.
+ * @param options - Rendering options (custom components, sanitizer, slugify, …).
+ * @returns Vue VNodes representing the rendered markdown.
+ *
+ * @example
+ * ```ts
+ * const vnodes = compileMarkdown('# Hello **world**', { forceBlock: true });
+ * ```
+ */
 export declare const compileMarkdown: (input?: string | ParsedMarkdown, options?: MarkdownCompilerOptions) => unknown;
-export declare const compiler: (input?: string | ParsedMarkdown, options?: MarkdownCompilerOptions) => unknown;
-export declare const compile: (input?: string | ParsedMarkdown, options?: MarkdownCompilerOptions) => unknown;

package/dist/types/markdown/index.d.ts

@@ -1,3 +1,3 @@
-export * from './compiler';
+export { compileMarkdown, type MarkdownCompilerOptions, type MarkdownRendererOptions, type ParsedMarkdown, parseMarkdown, } from './compiler';
 export { type IntlayerMarkdownPluginOptions, type IntlayerMarkdownProvider, installIntlayerMarkdown, intlayerMarkdown, type MarkdownProviderOptions, type RenderMarkdownFunction, useMarkdown, } from './installIntlayerMarkdown';
 export { MarkdownRenderer, type MarkdownRendererProps, type RenderMarkdownProps, renderMarkdown, useMarkdownRenderer, } from './MarkdownRenderer';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vue-intlayer",
-  "version": "8.12.2",
+  "version": "8.12.4-canary.0",
   "private": false,
   "description": "Easily internationalize i18n your Vue applications with type-safe multilingual content management.",
   "keywords": [
@@ -102,14 +102,14 @@
     "typecheck": "vue-tsc --noEmit --project tsconfig.types.json"
   },
   "dependencies": {
-    "@intlayer/api": "8.12.2",
-    "@intlayer/config": "8.12.2",
-    "@intlayer/core": "8.12.2",
-    "@intlayer/editor": "8.12.2",
-    "@intlayer/types": "8.12.2"
+    "@intlayer/api": "8.12.4-canary.0",
+    "@intlayer/config": "8.12.4-canary.0",
+    "@intlayer/core": "8.12.4-canary.0",
+    "@intlayer/editor": "8.12.4-canary.0",
+    "@intlayer/types": "8.12.4-canary.0"
   },
   "devDependencies": {
-    "@types/node": "25.9.1",
+    "@types/node": "25.9.2",
     "@utils/ts-config": "1.0.4",
     "@utils/ts-config-types": "1.0.4",
     "@utils/tsdown-config": "1.0.4",
@@ -117,15 +117,15 @@
     "ajv": "8.18.0",
     "fast-glob": "3.3.3",
     "rimraf": "6.1.3",
-    "tsdown": "0.22.1",
+    "tsdown": "0.21.10",
     "typescript": "6.0.3",
     "vite": "8.0.16",
-    "vite-plugin-dts": "5.0.1",
+    "vite-plugin-dts": "5.0.2",
     "vitest": "4.1.8",
     "vue-tsc": "3.1.8"
   },
   "peerDependencies": {
-    "intlayer": "8.12.2",
+    "intlayer": "8.12.4-canary.0",
     "vue": ">=3.0.0"
   },
   "peerDependenciesMeta": {