@kontakto/email-template-editor 2.2.2 → 2.3.0

package/dist/index.d.cts

@@ -1,5 +1,6 @@
 import React, { CSSProperties } from 'react';
 import { z } from 'zod';
+import Handlebars from 'handlebars';
 import * as _mui_material_styles from '@mui/material/styles';
 import { Theme } from '@mui/material/styles';
 
@@ -2160,6 +2161,20 @@ declare function buildBlockConfigurationSchema<T extends BaseZodDictionary>(bloc
  */
 declare function buildBlockConfigurationDictionary<T extends BaseZodDictionary>(blocks: DocumentBlocksDictionary<T>): DocumentBlocksDictionary<T>;
 
+/**
+ * A fresh Handlebars environment scoped to the editor. Pre-registered with
+ * `formatDate` and `formatNumber` helpers. Kept isolated from the global
+ * `Handlebars` default instance so registrations here don't leak into the
+ * consumer's own environment (and vice versa).
+ */
+declare const editorHandlebars: typeof Handlebars;
+type HandlebarsContext = Record<string, unknown>;
+/**
+ * Compile `source` as a Handlebars template and render it with `context`.
+ * Uses the scoped {@link editorHandlebars} instance.
+ */
+declare function evaluateHandlebars(source: string, context: HandlebarsContext): string;
+
 /**
  * Reader component - responsible for rendering an email document
  *
@@ -4446,19 +4461,27 @@ declare function Reader({ document, rootBlockId }: TReaderProps): React.JSX.Elem
  * suitable for sending as an email. It adds the DOCTYPE and wraps everything
  * in basic HTML/body tags.
  *
+ * When `variables` is provided, the rendered HTML is evaluated as a
+ * Handlebars template — conditionals, loops, subpath access, and the
+ * built-in `formatDate` / `formatNumber` helpers all resolve against the
+ * given context. Without `variables`, the output keeps raw `{{name}}`
+ * placeholders in place (the save-time, send-later shape).
+ *
  * @param document The email document structure to render
- * @param options Options including the rootBlockId to start rendering from
+ * @param options Options including the rootBlockId to start rendering from, and optional Handlebars context
  * @returns A complete HTML string representation of the email
  */
 type TOptions$1 = {
     rootBlockId: string;
+    variables?: HandlebarsContext;
 };
-declare function renderToStaticMarkup(document: TReaderDocument, { rootBlockId }: TOptions$1): string;
+declare function renderToStaticMarkup(document: TReaderDocument, { rootBlockId, variables }: TOptions$1): string;
 
 type TOptions = {
     rootBlockId: string;
+    variables?: HandlebarsContext;
 };
-declare function renderToText(document: TReaderDocument, { rootBlockId }: TOptions): string;
+declare function renderToText(document: TReaderDocument, { rootBlockId, variables }: TOptions): string;
 
 declare const ColumnsContainerPropsSchema: z.ZodObject<{
     style: z.ZodNullable<z.ZodOptional<z.ZodObject<{
@@ -6064,9 +6087,14 @@ interface EmailEditorProps {
      */
     copyTemplate?: (templateName: string, content: any) => void;
     /**
-     * Callback to rename a template by ID. Receives the new slug.
+     * Callback to update a template's details. Receives the new slug and an
+     * optional options bag with the full new tag list. Called from the
+     * drawer's Edit-details dialog — the `tags` array replaces the existing
+     * tag list when provided.
      */
-    renameTemplate?: (templateId: string, newSlug: string) => void | Promise<void>;
+    renameTemplate?: (templateId: string, newSlug: string, opts?: {
+        tags?: string[];
+    }) => void | Promise<void>;
     /**
      * Callback to promote/demote a row between `template` and `sample`.
      * When omitted, promote/demote menu items are hidden.
@@ -6104,4 +6132,4 @@ interface EmailEditorProps {
 }
 declare const EmailEditor: React.ForwardRefExoticComponent<EmailEditorProps & React.RefAttributes<EmailEditorRef>>;
 
-export { Avatar, AvatarProps, AvatarPropsDefaults, AvatarPropsSchema, BlockConfiguration, Button, ButtonProps, ButtonPropsDefaults, ButtonPropsSchema, ColumnsContainer, ColumnsContainerProps$1 as ColumnsContainerProps, ColumnsContainerPropsSchema$1 as ColumnsContainerPropsSchema, ColumnsContainerReader, Container, ContainerProps$1 as ContainerProps, ContainerPropsSchema$1 as ContainerPropsSchema, ContainerReader, Divider, DividerProps, DividerPropsDefaults, DividerPropsSchema, DocumentBlocksDictionary, EmailEditor, type EmailEditorContextType, type EmailEditorProps, EmailEditorProvider, type EmailEditorProviderProps, type EmailEditorRef, EmailLayoutPropsSchema, EmailLayoutReader, EmailMarkdown, Heading, HeadingProps, HeadingPropsDefaults, HeadingPropsSchema, Html, HtmlProps, HtmlPropsSchema, Image, type ImageCallbacks, ImageProps, ImagePropsSchema, type LibraryImage, Reader, ReaderBlock, ReaderBlockSchema, ReaderDocumentSchema, type SavePayload, Signature, SignatureProps, SignaturePropsDefaults, SignaturePropsSchema, Spacer, SpacerProps, SpacerPropsDefaults, SpacerPropsSchema, type TReaderBlock, type TReaderBlockProps, type TReaderDocument, type TReaderProps, type TemplateKind, type TemplateListItem, TemplateVariableSchema, Text, TextProps, TextPropsDefaults, TextPropsSchema, type UploadedImage, buildBlockComponent, buildBlockConfigurationDictionary, buildBlockConfigurationSchema, htmlToEditorConfig, renderToStaticMarkup, renderToText, THEME as theme, useEmailEditor };
+export { Avatar, AvatarProps, AvatarPropsDefaults, AvatarPropsSchema, BlockConfiguration, Button, ButtonProps, ButtonPropsDefaults, ButtonPropsSchema, ColumnsContainer, ColumnsContainerProps$1 as ColumnsContainerProps, ColumnsContainerPropsSchema$1 as ColumnsContainerPropsSchema, ColumnsContainerReader, Container, ContainerProps$1 as ContainerProps, ContainerPropsSchema$1 as ContainerPropsSchema, ContainerReader, Divider, DividerProps, DividerPropsDefaults, DividerPropsSchema, DocumentBlocksDictionary, EmailEditor, type EmailEditorContextType, type EmailEditorProps, EmailEditorProvider, type EmailEditorProviderProps, type EmailEditorRef, EmailLayoutPropsSchema, EmailLayoutReader, EmailMarkdown, type HandlebarsContext, Heading, HeadingProps, HeadingPropsDefaults, HeadingPropsSchema, Html, HtmlProps, HtmlPropsSchema, Image, type ImageCallbacks, ImageProps, ImagePropsSchema, type LibraryImage, Reader, ReaderBlock, ReaderBlockSchema, ReaderDocumentSchema, type SavePayload, Signature, SignatureProps, SignaturePropsDefaults, SignaturePropsSchema, Spacer, SpacerProps, SpacerPropsDefaults, SpacerPropsSchema, type TReaderBlock, type TReaderBlockProps, type TReaderDocument, type TReaderProps, type TemplateKind, type TemplateListItem, TemplateVariableSchema, Text, TextProps, TextPropsDefaults, TextPropsSchema, type UploadedImage, buildBlockComponent, buildBlockConfigurationDictionary, buildBlockConfigurationSchema, editorHandlebars, evaluateHandlebars, htmlToEditorConfig, renderToStaticMarkup, renderToText, THEME as theme, useEmailEditor };

package/dist/index.d.ts

@@ -1,5 +1,6 @@
 import React, { CSSProperties } from 'react';
 import { z } from 'zod';
+import Handlebars from 'handlebars';
 import * as _mui_material_styles from '@mui/material/styles';
 import { Theme } from '@mui/material/styles';
 
@@ -2160,6 +2161,20 @@ declare function buildBlockConfigurationSchema<T extends BaseZodDictionary>(bloc
  */
 declare function buildBlockConfigurationDictionary<T extends BaseZodDictionary>(blocks: DocumentBlocksDictionary<T>): DocumentBlocksDictionary<T>;
 
+/**
+ * A fresh Handlebars environment scoped to the editor. Pre-registered with
+ * `formatDate` and `formatNumber` helpers. Kept isolated from the global
+ * `Handlebars` default instance so registrations here don't leak into the
+ * consumer's own environment (and vice versa).
+ */
+declare const editorHandlebars: typeof Handlebars;
+type HandlebarsContext = Record<string, unknown>;
+/**
+ * Compile `source` as a Handlebars template and render it with `context`.
+ * Uses the scoped {@link editorHandlebars} instance.
+ */
+declare function evaluateHandlebars(source: string, context: HandlebarsContext): string;
+
 /**
  * Reader component - responsible for rendering an email document
  *
@@ -4446,19 +4461,27 @@ declare function Reader({ document, rootBlockId }: TReaderProps): React.JSX.Elem
  * suitable for sending as an email. It adds the DOCTYPE and wraps everything
  * in basic HTML/body tags.
  *
+ * When `variables` is provided, the rendered HTML is evaluated as a
+ * Handlebars template — conditionals, loops, subpath access, and the
+ * built-in `formatDate` / `formatNumber` helpers all resolve against the
+ * given context. Without `variables`, the output keeps raw `{{name}}`
+ * placeholders in place (the save-time, send-later shape).
+ *
  * @param document The email document structure to render
- * @param options Options including the rootBlockId to start rendering from
+ * @param options Options including the rootBlockId to start rendering from, and optional Handlebars context
  * @returns A complete HTML string representation of the email
  */
 type TOptions$1 = {
     rootBlockId: string;
+    variables?: HandlebarsContext;
 };
-declare function renderToStaticMarkup(document: TReaderDocument, { rootBlockId }: TOptions$1): string;
+declare function renderToStaticMarkup(document: TReaderDocument, { rootBlockId, variables }: TOptions$1): string;
 
 type TOptions = {
     rootBlockId: string;
+    variables?: HandlebarsContext;
 };
-declare function renderToText(document: TReaderDocument, { rootBlockId }: TOptions): string;
+declare function renderToText(document: TReaderDocument, { rootBlockId, variables }: TOptions): string;
 
 declare const ColumnsContainerPropsSchema: z.ZodObject<{
     style: z.ZodNullable<z.ZodOptional<z.ZodObject<{
@@ -6064,9 +6087,14 @@ interface EmailEditorProps {
      */
     copyTemplate?: (templateName: string, content: any) => void;
     /**
-     * Callback to rename a template by ID. Receives the new slug.
+     * Callback to update a template's details. Receives the new slug and an
+     * optional options bag with the full new tag list. Called from the
+     * drawer's Edit-details dialog — the `tags` array replaces the existing
+     * tag list when provided.
      */
-    renameTemplate?: (templateId: string, newSlug: string) => void | Promise<void>;
+    renameTemplate?: (templateId: string, newSlug: string, opts?: {
+        tags?: string[];
+    }) => void | Promise<void>;
     /**
      * Callback to promote/demote a row between `template` and `sample`.
      * When omitted, promote/demote menu items are hidden.
@@ -6104,4 +6132,4 @@ interface EmailEditorProps {
 }
 declare const EmailEditor: React.ForwardRefExoticComponent<EmailEditorProps & React.RefAttributes<EmailEditorRef>>;
 
-export { Avatar, AvatarProps, AvatarPropsDefaults, AvatarPropsSchema, BlockConfiguration, Button, ButtonProps, ButtonPropsDefaults, ButtonPropsSchema, ColumnsContainer, ColumnsContainerProps$1 as ColumnsContainerProps, ColumnsContainerPropsSchema$1 as ColumnsContainerPropsSchema, ColumnsContainerReader, Container, ContainerProps$1 as ContainerProps, ContainerPropsSchema$1 as ContainerPropsSchema, ContainerReader, Divider, DividerProps, DividerPropsDefaults, DividerPropsSchema, DocumentBlocksDictionary, EmailEditor, type EmailEditorContextType, type EmailEditorProps, EmailEditorProvider, type EmailEditorProviderProps, type EmailEditorRef, EmailLayoutPropsSchema, EmailLayoutReader, EmailMarkdown, Heading, HeadingProps, HeadingPropsDefaults, HeadingPropsSchema, Html, HtmlProps, HtmlPropsSchema, Image, type ImageCallbacks, ImageProps, ImagePropsSchema, type LibraryImage, Reader, ReaderBlock, ReaderBlockSchema, ReaderDocumentSchema, type SavePayload, Signature, SignatureProps, SignaturePropsDefaults, SignaturePropsSchema, Spacer, SpacerProps, SpacerPropsDefaults, SpacerPropsSchema, type TReaderBlock, type TReaderBlockProps, type TReaderDocument, type TReaderProps, type TemplateKind, type TemplateListItem, TemplateVariableSchema, Text, TextProps, TextPropsDefaults, TextPropsSchema, type UploadedImage, buildBlockComponent, buildBlockConfigurationDictionary, buildBlockConfigurationSchema, htmlToEditorConfig, renderToStaticMarkup, renderToText, THEME as theme, useEmailEditor };
+export { Avatar, AvatarProps, AvatarPropsDefaults, AvatarPropsSchema, BlockConfiguration, Button, ButtonProps, ButtonPropsDefaults, ButtonPropsSchema, ColumnsContainer, ColumnsContainerProps$1 as ColumnsContainerProps, ColumnsContainerPropsSchema$1 as ColumnsContainerPropsSchema, ColumnsContainerReader, Container, ContainerProps$1 as ContainerProps, ContainerPropsSchema$1 as ContainerPropsSchema, ContainerReader, Divider, DividerProps, DividerPropsDefaults, DividerPropsSchema, DocumentBlocksDictionary, EmailEditor, type EmailEditorContextType, type EmailEditorProps, EmailEditorProvider, type EmailEditorProviderProps, type EmailEditorRef, EmailLayoutPropsSchema, EmailLayoutReader, EmailMarkdown, type HandlebarsContext, Heading, HeadingProps, HeadingPropsDefaults, HeadingPropsSchema, Html, HtmlProps, HtmlPropsSchema, Image, type ImageCallbacks, ImageProps, ImagePropsSchema, type LibraryImage, Reader, ReaderBlock, ReaderBlockSchema, ReaderDocumentSchema, type SavePayload, Signature, SignatureProps, SignaturePropsDefaults, SignaturePropsSchema, Spacer, SpacerProps, SpacerPropsDefaults, SpacerPropsSchema, type TReaderBlock, type TReaderBlockProps, type TReaderDocument, type TReaderProps, type TemplateKind, type TemplateListItem, TemplateVariableSchema, Text, TextProps, TextPropsDefaults, TextPropsSchema, type UploadedImage, buildBlockComponent, buildBlockConfigurationDictionary, buildBlockConfigurationSchema, editorHandlebars, evaluateHandlebars, htmlToEditorConfig, renderToStaticMarkup, renderToText, THEME as theme, useEmailEditor };