svelte-intlayer 8.12.1 → 8.12.3

package/dist/markdown/compiler.d.ts

@@ -1,7 +1,41 @@
 import { type ParsedMarkdown } from '@intlayer/core/markdown';
 /**
- * Compile markdown to HTML strings for Svelte.
+ * 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 HTML. 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 html = compileMarkdown(ast);
+ * ```
+ */
 export declare const parseMarkdown: (markdown?: string, options?: any) => ParsedMarkdown;
+/**
+ * **Steps 1 + 2 — parse and render in one shot.**
+ * Accepts a raw markdown string or a pre-parsed `ParsedMarkdown` AST and
+ * returns an HTML string suitable for Svelte's `{@html}` tag.
+ *
+ * @param input - Markdown string or pre-parsed AST.
+ * @param options - Rendering options (components, sanitizer, slugify, …).
+ * @returns An HTML string representing the rendered markdown.
+ *
+ * @example
+ * ```svelte
+ * <div>{@html compileMarkdown('# Hello **World**')}</div>
+ * ```
+ */
 export declare const compileMarkdown: (input?: string | ParsedMarkdown, options?: any) => unknown;

package/dist/markdown/compiler.js

@@ -1,5 +1,23 @@
 import { compileWithOptions, parseMarkdown as coreParseMarkdown, renderMarkdownAst as coreRenderMarkdownAst, } from '@intlayer/core/markdown';
 import { svelteHtmlRuntime } from './runtime';
+/**
+ * **Step 1 of 2 — parse only.**
+ * Converts a raw markdown string into a `ParsedMarkdown` AST without rendering
+ * any HTML. 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 html = compileMarkdown(ast);
+ * ```
+ */
 export const parseMarkdown = (markdown = '', options = {}) => {
     const { components, namedCodesToUnicode, sanitizer, slugify, ...compilerOptions } = options;
     const ctx = {
@@ -11,6 +29,20 @@ export const parseMarkdown = (markdown = '', options = {}) => {
     };
     return coreParseMarkdown(markdown, ctx, compilerOptions);
 };
+/**
+ * **Steps 1 + 2 — parse and render in one shot.**
+ * Accepts a raw markdown string or a pre-parsed `ParsedMarkdown` AST and
+ * returns an HTML string suitable for Svelte's `{@html}` tag.
+ *
+ * @param input - Markdown string or pre-parsed AST.
+ * @param options - Rendering options (components, sanitizer, slugify, …).
+ * @returns An HTML string representing the rendered markdown.
+ *
+ * @example
+ * ```svelte
+ * <div>{@html compileMarkdown('# Hello **World**')}</div>
+ * ```
+ */
 export const compileMarkdown = (input = '', options = {}) => {
     if (typeof input === 'string') {
         return compileWithOptions(input, svelteHtmlRuntime, options);

package/dist/markdown/index.d.ts

@@ -1,10 +1,31 @@
-export { getMarkdownContext, type MarkdownContext, type RenderMarkdownOptions, setMarkdownContext, setMarkdownContext as setIntlayerMarkdown, } from './context';
 import { type ParsedMarkdown } from './compiler';
 import { type RenderMarkdownOptions } from './context';
-export * from './compiler';
+export { compileMarkdown, type ParsedMarkdown, parseMarkdown, } from './compiler';
+export { getMarkdownContext, type MarkdownContext, type MarkdownProviderOptions, type RenderMarkdownOptions, setMarkdownContext, setMarkdownContext as setIntlayerMarkdown, } from './context';
 export { default as MarkdownMetadataRenderer } from './MarkdownMetadataRenderer.svelte';
 export { default as MarkdownProvider } from './MarkdownProvider.svelte';
 export { default as MarkdownRenderer } from './MarkdownRenderer.svelte';
 export type RenderMarkdownProps = RenderMarkdownOptions;
+/**
+ * Context-aware render function. Equivalent to `compileMarkdown` when called
+ * outside a `<MarkdownProvider>`; delegates to the provider's render function
+ * when one is active.
+ */
 export declare const renderMarkdown: (input?: string | ParsedMarkdown, options?: any) => unknown;
-export declare const useMarkdownRenderer: (options?: RenderMarkdownProps) => (content: string | ParsedMarkdown) => string | Promise<string>;
+/**
+ * Returns a render function bound to the current `<MarkdownProvider>` context.
+ * The returned function forwards its call to whichever `renderMarkdown`
+ * implementation was injected by the nearest provider.
+ *
+ * @param options - Default rendering options applied on every call.
+ * @returns A function that accepts markdown content and returns an HTML string.
+ *
+ * @example
+ * ```svelte
+ * <script>
+ *   const render = useMarkdownRenderer({ forceBlock: true });
+ * </script>
+ * <div>{@html render(markdownString)}</div>
+ * ```
+ */
+export declare const useMarkdownRenderer: (options?: RenderMarkdownOptions) => (content: string | ParsedMarkdown) => string | Promise<string>;

package/dist/markdown/index.js

@@ -1,11 +1,32 @@
-export { getMarkdownContext, setMarkdownContext, setMarkdownContext as setIntlayerMarkdown, } from './context';
 import { compileMarkdown } from './compiler';
 import { getMarkdownContext } from './context';
-export * from './compiler';
+export { compileMarkdown, parseMarkdown, } from './compiler';
+export { getMarkdownContext, setMarkdownContext, setMarkdownContext as setIntlayerMarkdown, } from './context';
 export { default as MarkdownMetadataRenderer } from './MarkdownMetadataRenderer.svelte';
 export { default as MarkdownProvider } from './MarkdownProvider.svelte';
 export { default as MarkdownRenderer } from './MarkdownRenderer.svelte';
+/**
+ * Context-aware render function. Equivalent to `compileMarkdown` when called
+ * outside a `<MarkdownProvider>`; delegates to the provider's render function
+ * when one is active.
+ */
 export const renderMarkdown = compileMarkdown;
+/**
+ * Returns a render function bound to the current `<MarkdownProvider>` context.
+ * The returned function forwards its call to whichever `renderMarkdown`
+ * implementation was injected by the nearest provider.
+ *
+ * @param options - Default rendering options applied on every call.
+ * @returns A function that accepts markdown content and returns an HTML string.
+ *
+ * @example
+ * ```svelte
+ * <script>
+ *   const render = useMarkdownRenderer({ forceBlock: true });
+ * </script>
+ * <div>{@html render(markdownString)}</div>
+ * ```
+ */
 export const useMarkdownRenderer = (options = {}) => {
     const context = getMarkdownContext();
     return (content) => context.renderMarkdown(content, options);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "svelte-intlayer",
-  "version": "8.12.1",
+  "version": "8.12.3",
   "description": "Easily internationalize i18n your Svelte applications with type-safe multilingual content management.",
   "keywords": [
     "intlayer",
@@ -82,24 +82,24 @@
     "typecheck": "tsc --noEmit --project tsconfig.types.json"
   },
   "dependencies": {
-    "@intlayer/api": "8.12.1",
-    "@intlayer/config": "8.12.1",
-    "@intlayer/core": "8.12.1",
-    "@intlayer/editor": "8.12.1",
-    "@intlayer/types": "8.12.1"
+    "@intlayer/api": "8.12.3",
+    "@intlayer/config": "8.12.3",
+    "@intlayer/core": "8.12.3",
+    "@intlayer/editor": "8.12.3",
+    "@intlayer/types": "8.12.3"
   },
   "devDependencies": {
     "@sveltejs/adapter-auto": "7.0.1",
     "@sveltejs/package": "2.5.7",
     "@sveltejs/vite-plugin-svelte": "7.1.2",
-    "@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",
     "rimraf": "6.1.3",
     "svelte": "5.55.8",
     "svelte-check": "4.4.8",
-    "tsdown": "0.22.1",
+    "tsdown": "0.21.10",
     "typescript": "6.0.3",
     "vite": "8.0.16",
     "vitest": "4.1.8"