@templatical/renderer 0.10.0 → 0.10.2

package/dist/index.d.ts

@@ -1,56 +1,59 @@
-import { CustomFont, Block, ColumnLayout, SpacingValue, CustomBlock, TemplateContent } from '@templatical/types';
+import { Block, ColumnLayout, CustomBlock, CustomFont, SpacingValue, TemplateContent } from "@templatical/types";
 
+//#region src/render-context.d.ts
 declare const DEFAULT_SOCIAL_ICONS_BASE_URL: string;
 /**
  * Immutable context passed through the block rendering chain.
  */
 declare class RenderContext {
-    readonly containerWidth: number;
-    readonly customFonts: CustomFont[];
-    readonly defaultFallbackFont: string;
-    readonly allowHtmlBlocks: boolean;
-    /**
-     * Map of custom block id → pre-rendered HTML, populated by `renderToMjml`
-     * before the synchronous render pass. Set when the consumer provides a
-     * `renderCustomBlock` option. Empty by default.
-     */
-    readonly customBlockHtml: ReadonlyMap<string, string>;
-    /**
-     * Base URL (no trailing slash) for the social icon PNG assets. Resolved to
-     * `${baseUrl}/${style}/${platform}.png`. Outlook desktop has no SVG support
-     * and rejects base64 data URIs in `<img src>`, so PNGs must be served over
-     * HTTP. Default points at the version-pinned unpkg mirror of this
-     * package; consumers can override to self-host.
-     */
-    readonly socialIconsBaseUrl: string;
-    constructor(containerWidth: number, customFonts: CustomFont[], defaultFallbackFont: string, allowHtmlBlocks: boolean, 
-    /**
-     * Map of custom block id → pre-rendered HTML, populated by `renderToMjml`
-     * before the synchronous render pass. Set when the consumer provides a
-     * `renderCustomBlock` option. Empty by default.
-     */
-    customBlockHtml?: ReadonlyMap<string, string>, 
-    /**
-     * Base URL (no trailing slash) for the social icon PNG assets. Resolved to
-     * `${baseUrl}/${style}/${platform}.png`. Outlook desktop has no SVG support
-     * and rejects base64 data URIs in `<img src>`, so PNGs must be served over
-     * HTTP. Default points at the version-pinned unpkg mirror of this
-     * package; consumers can override to self-host.
-     */
-    socialIconsBaseUrl?: string);
-    /**
-     * Create a new context with a different container width.
-     * Used when rendering columns with narrower widths.
-     */
-    withContainerWidth(width: number): RenderContext;
-    /**
-     * Resolve a font family name to include custom font fallbacks.
-     * If the font matches a custom font, returns `'FontName', fallback`.
-     * Otherwise returns the original font family string.
-     */
-    resolveFontFamily(fontFamily: string): string;
-}
+  readonly containerWidth: number;
+  readonly customFonts: CustomFont[];
+  readonly defaultFallbackFont: string;
+  readonly allowHtmlBlocks: boolean;
+  /**
+   * Map of custom block id → pre-rendered HTML, populated by `renderToMjml`
+   * before the synchronous render pass. Set when the consumer provides a
+   * `renderCustomBlock` option. Empty by default.
+   */
+  readonly customBlockHtml: ReadonlyMap<string, string>;
+  /**
+   * Base URL (no trailing slash) for the social icon PNG assets. Resolved to
+   * `${baseUrl}/${style}/${platform}.png`. Outlook desktop has no SVG support
+   * and rejects base64 data URIs in `<img src>`, so PNGs must be served over
+   * HTTP. Default points at the version-pinned unpkg mirror of this
+   * package; consumers can override to self-host.
+   */
+  readonly socialIconsBaseUrl: string;
+  constructor(containerWidth: number, customFonts: CustomFont[], defaultFallbackFont: string, allowHtmlBlocks: boolean,
+  /**
+   * Map of custom block id → pre-rendered HTML, populated by `renderToMjml`
+   * before the synchronous render pass. Set when the consumer provides a
+   * `renderCustomBlock` option. Empty by default.
+   */
 
+  customBlockHtml?: ReadonlyMap<string, string>,
+  /**
+   * Base URL (no trailing slash) for the social icon PNG assets. Resolved to
+   * `${baseUrl}/${style}/${platform}.png`. Outlook desktop has no SVG support
+   * and rejects base64 data URIs in `<img src>`, so PNGs must be served over
+   * HTTP. Default points at the version-pinned unpkg mirror of this
+   * package; consumers can override to self-host.
+   */
+  socialIconsBaseUrl?: string);
+  /**
+   * Create a new context with a different container width.
+   * Used when rendering columns with narrower widths.
+   */
+  withContainerWidth(width: number): RenderContext;
+  /**
+   * Resolve a font family name to include custom font fallbacks.
+   * If the font matches a custom font, returns `'FontName', fallback`.
+   * Otherwise returns the original font family string.
+   */
+  resolveFontFamily(fontFamily: string): string;
+}
+//#endregion
+//#region src/escape.d.ts
 /**
  * Escape HTML special characters (& < > " ').
  * Equivalent to PHP htmlspecialchars with ENT_QUOTES | ENT_HTML5.
@@ -73,7 +76,8 @@ declare function escapeAttr(text: string): string;
  * `indexOf('>')`, keeping the work strictly O(n).
  */
 declare function convertMergeTagsToValues(html: string): string;
-
+//#endregion
+//#region src/visibility.d.ts
 /**
  * Check if a block is hidden on all viewports.
  */
@@ -87,7 +91,8 @@ declare function getCssClassAttr(block: Block): string;
  * Get the CSS classes for visibility hiding.
  */
 declare function getCssClasses(block: Block): string;
-
+//#endregion
+//#region src/columns.d.ts
 /**
  * Get width percentages for each column in a layout.
  */
@@ -96,68 +101,72 @@ declare function getWidthPercentages(layout: ColumnLayout): string[];
  * Get width in pixels for each column in a layout.
  */
 declare function getWidthPixels(layout: ColumnLayout, containerWidth: number): number[];
-
+//#endregion
+//#region src/padding.d.ts
 /**
  * Convert a SpacingValue to a CSS padding string like "10px 10px 10px 10px".
  */
 declare function toPaddingString(padding: SpacingValue): string;
-
+//#endregion
+//#region src/renderers/index.d.ts
 /**
  * Render a single block to MJML markup.
  * Dispatches to the appropriate block-type renderer.
  */
 declare function renderBlock(block: Block, context: RenderContext): string;
-
+//#endregion
+//#region src/renderers/section.d.ts
 /**
  * A function type that renders a single block to MJML markup.
  */
 type BlockRenderer = (block: Block, context: RenderContext) => string;
-
+//#endregion
+//#region src/index.d.ts
 interface RenderOptions {
-    customFonts?: CustomFont[];
-    defaultFallbackFont?: string;
-    allowHtmlBlocks?: boolean;
-    /**
-     * Resolves custom blocks to their HTML representation. Called once per
-     * custom block in the content tree before MJML rendering. The renderer
-     * has no built-in knowledge of how to render custom blocks; consumers
-     * provide this function.
-     *
-     * Editor consumers: pass `editor.renderCustomBlock`.
-     *
-     * Headless consumers (Node.js, server, CLI): provide your own resolver,
-     * typically using the same liquid template + field values pipeline as
-     * the editor uses. If omitted, custom blocks fall back to
-     * `block.renderedHtml` (if present) and otherwise are omitted from the
-     * output.
-     */
-    renderCustomBlock?: (block: CustomBlock) => Promise<string>;
-    /**
-     * Resolves the definition-level CSS for a custom block type. Called once
-     * per unique `customType` present in the content tree (not per instance).
-     * The non-empty results are deduped by content and emitted as additional
-     * `<mj-style>` blocks inside `<mj-head>` alongside the built-in visibility
-     * media queries.
-     *
-     * Editor consumers: pass a function that reads
-     * `blockRegistry.getDefinition(customType)?.stylesheet`.
-     *
-     * Headless consumers: provide your own resolver, typically from the same
-     * definitions map used by `renderCustomBlock`. Return `undefined` or `null`
-     * for definitions without a stylesheet — those are skipped.
-     */
-    getCustomBlockStylesheet?: (customType: string) => string | undefined | null;
-    /**
-     * Base URL (no trailing slash) for the social icon PNG assets. Resolved to
-     * `${baseUrl}/${style}/${platform}.png` per icon. Defaults to the
-     * version-pinned unpkg mirror of this package. Override to self-host
-     * (e.g., behind your own CDN or for air-gapped environments).
-     *
-     * Why PNGs: Outlook desktop (Word rendering engine) does not support SVG
-     * and rejects base64 data URIs in `<img src>`, so social icons must be
-     * served as raster images over HTTP for cross-client compatibility.
-     */
-    socialIconsBaseUrl?: string;
+  customFonts?: CustomFont[];
+  defaultFallbackFont?: string;
+  allowHtmlBlocks?: boolean;
+  /**
+   * Resolves custom blocks to their HTML representation. Called once per
+   * custom block in the content tree before MJML rendering. The renderer
+   * has no built-in knowledge of how to render custom blocks; consumers
+   * provide this function.
+   *
+   * Editor consumers: pass `editor.renderCustomBlock`.
+   *
+   * Headless consumers (Node.js, server, CLI): provide your own resolver,
+   * typically using the same liquid template + field values pipeline as
+   * the editor uses. If omitted, custom blocks fall back to
+   * `block.renderedHtml` (if present) and otherwise are omitted from the
+   * output.
+   */
+  renderCustomBlock?: (block: CustomBlock) => Promise<string>;
+  /**
+   * Resolves the definition-level CSS for a custom block type. Called once
+   * per unique `customType` present in the content tree (not per instance).
+   * The non-empty results are deduped by content and emitted as additional
+   * `<mj-style>` blocks inside `<mj-head>` alongside the built-in visibility
+   * media queries.
+   *
+   * Editor consumers: pass a function that reads
+   * `blockRegistry.getDefinition(customType)?.stylesheet`.
+   *
+   * Headless consumers: provide your own resolver, typically from the same
+   * definitions map used by `renderCustomBlock`. Return `undefined` or `null`
+   * for definitions without a stylesheet — those are skipped.
+   */
+  getCustomBlockStylesheet?: (customType: string) => string | undefined | null;
+  /**
+   * Base URL (no trailing slash) for the social icon PNG assets. Resolved to
+   * `${baseUrl}/${style}/${platform}.png` per icon. Defaults to the
+   * version-pinned unpkg mirror of this package. Override to self-host
+   * (e.g., behind your own CDN or for air-gapped environments).
+   *
+   * Why PNGs: Outlook desktop (Word rendering engine) does not support SVG
+   * and rejects base64 data URIs in `<img src>`, so social icons must be
+   * served as raster images over HTTP for cross-client compatibility.
+   */
+  socialIconsBaseUrl?: string;
 }
 /**
  * Render template content to an MJML string.
@@ -169,5 +178,6 @@ interface RenderOptions {
  * synchronously — i.e., it always returns a Promise.
  */
 declare function renderToMjml(content: TemplateContent, options?: RenderOptions): Promise<string>;
-
-export { type BlockRenderer, DEFAULT_SOCIAL_ICONS_BASE_URL, RenderContext, type RenderOptions, convertMergeTagsToValues, escapeAttr, escapeHtml, getCssClassAttr, getCssClasses, getWidthPercentages, getWidthPixels, isHiddenOnAll, renderBlock, renderToMjml, toPaddingString };
+//#endregion
+export { type BlockRenderer, DEFAULT_SOCIAL_ICONS_BASE_URL, RenderContext, RenderOptions, convertMergeTagsToValues, escapeAttr, escapeHtml, getCssClassAttr, getCssClasses, getWidthPercentages, getWidthPixels, isHiddenOnAll, renderBlock, renderToMjml, toPaddingString };
+//# sourceMappingURL=index.d.ts.map