@kontakto/email-template-editor 1.5.1 → 2.0.0

package/dist/index.d.cts

@@ -2317,12 +2317,24 @@ declare const ReaderBlockSchema: z.ZodEffects<z.ZodDiscriminatedUnion<"type", an
     }>;
     EmailLayout: z.ZodObject<{
         backdropColor: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        backdropDisabled: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
         borderColor: z.ZodOptional<z.ZodNullable<z.ZodString>>;
         borderRadius: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
         canvasColor: z.ZodOptional<z.ZodNullable<z.ZodString>>;
         textColor: z.ZodOptional<z.ZodNullable<z.ZodString>>;
         fontFamily: z.ZodOptional<z.ZodNullable<z.ZodEnum<["MODERN_SANS", "BOOK_SANS", "ORGANIC_SANS", "GEOMETRIC_SANS", "HEAVY_SANS", "ROUNDED_SANS", "MODERN_SERIF", "BOOK_SERIF", "MONOSPACE"]>>>;
         childrenIds: z.ZodNullable<z.ZodOptional<z.ZodArray<z.ZodString, "many">>>;
+        subject: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        variables: z.ZodNullable<z.ZodOptional<z.ZodArray<z.ZodObject<{
+            name: z.ZodString;
+            description: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        }, "strip", z.ZodTypeAny, {
+            name: string;
+            description?: string | null | undefined;
+        }, {
+            name: string;
+            description?: string | null | undefined;
+        }>, "many">>>;
     }, "strip", z.ZodTypeAny, {
         fontFamily?: "MODERN_SANS" | "BOOK_SANS" | "ORGANIC_SANS" | "GEOMETRIC_SANS" | "HEAVY_SANS" | "ROUNDED_SANS" | "MODERN_SERIF" | "BOOK_SERIF" | "MONOSPACE" | null | undefined;
         borderColor?: string | null | undefined;
@@ -2330,7 +2342,13 @@ declare const ReaderBlockSchema: z.ZodEffects<z.ZodDiscriminatedUnion<"type", an
         textColor?: string | null | undefined;
         childrenIds?: string[] | null | undefined;
         backdropColor?: string | null | undefined;
+        backdropDisabled?: boolean | null | undefined;
         canvasColor?: string | null | undefined;
+        subject?: string | null | undefined;
+        variables?: {
+            name: string;
+            description?: string | null | undefined;
+        }[] | null | undefined;
     }, {
         fontFamily?: "MODERN_SANS" | "BOOK_SANS" | "ORGANIC_SANS" | "GEOMETRIC_SANS" | "HEAVY_SANS" | "ROUNDED_SANS" | "MODERN_SERIF" | "BOOK_SERIF" | "MONOSPACE" | null | undefined;
         borderColor?: string | null | undefined;
@@ -2338,7 +2356,13 @@ declare const ReaderBlockSchema: z.ZodEffects<z.ZodDiscriminatedUnion<"type", an
         textColor?: string | null | undefined;
         childrenIds?: string[] | null | undefined;
         backdropColor?: string | null | undefined;
+        backdropDisabled?: boolean | null | undefined;
         canvasColor?: string | null | undefined;
+        subject?: string | null | undefined;
+        variables?: {
+            name: string;
+            description?: string | null | undefined;
+        }[] | null | undefined;
     }>;
     Avatar: z.ZodObject<{
         style: z.ZodNullable<z.ZodOptional<z.ZodObject<{
@@ -3384,12 +3408,24 @@ declare const ReaderDocumentSchema: z.ZodRecord<z.ZodString, z.ZodEffects<z.ZodD
     }>;
     EmailLayout: z.ZodObject<{
         backdropColor: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        backdropDisabled: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
         borderColor: z.ZodOptional<z.ZodNullable<z.ZodString>>;
         borderRadius: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
         canvasColor: z.ZodOptional<z.ZodNullable<z.ZodString>>;
         textColor: z.ZodOptional<z.ZodNullable<z.ZodString>>;
         fontFamily: z.ZodOptional<z.ZodNullable<z.ZodEnum<["MODERN_SANS", "BOOK_SANS", "ORGANIC_SANS", "GEOMETRIC_SANS", "HEAVY_SANS", "ROUNDED_SANS", "MODERN_SERIF", "BOOK_SERIF", "MONOSPACE"]>>>;
         childrenIds: z.ZodNullable<z.ZodOptional<z.ZodArray<z.ZodString, "many">>>;
+        subject: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        variables: z.ZodNullable<z.ZodOptional<z.ZodArray<z.ZodObject<{
+            name: z.ZodString;
+            description: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        }, "strip", z.ZodTypeAny, {
+            name: string;
+            description?: string | null | undefined;
+        }, {
+            name: string;
+            description?: string | null | undefined;
+        }>, "many">>>;
     }, "strip", z.ZodTypeAny, {
         fontFamily?: "MODERN_SANS" | "BOOK_SANS" | "ORGANIC_SANS" | "GEOMETRIC_SANS" | "HEAVY_SANS" | "ROUNDED_SANS" | "MODERN_SERIF" | "BOOK_SERIF" | "MONOSPACE" | null | undefined;
         borderColor?: string | null | undefined;
@@ -3397,7 +3433,13 @@ declare const ReaderDocumentSchema: z.ZodRecord<z.ZodString, z.ZodEffects<z.ZodD
         textColor?: string | null | undefined;
         childrenIds?: string[] | null | undefined;
         backdropColor?: string | null | undefined;
+        backdropDisabled?: boolean | null | undefined;
         canvasColor?: string | null | undefined;
+        subject?: string | null | undefined;
+        variables?: {
+            name: string;
+            description?: string | null | undefined;
+        }[] | null | undefined;
     }, {
         fontFamily?: "MODERN_SANS" | "BOOK_SANS" | "ORGANIC_SANS" | "GEOMETRIC_SANS" | "HEAVY_SANS" | "ROUNDED_SANS" | "MODERN_SERIF" | "BOOK_SERIF" | "MONOSPACE" | null | undefined;
         borderColor?: string | null | undefined;
@@ -3405,7 +3447,13 @@ declare const ReaderDocumentSchema: z.ZodRecord<z.ZodString, z.ZodEffects<z.ZodD
         textColor?: string | null | undefined;
         childrenIds?: string[] | null | undefined;
         backdropColor?: string | null | undefined;
+        backdropDisabled?: boolean | null | undefined;
         canvasColor?: string | null | undefined;
+        subject?: string | null | undefined;
+        variables?: {
+            name: string;
+            description?: string | null | undefined;
+        }[] | null | undefined;
     }>;
     Avatar: z.ZodObject<{
         style: z.ZodNullable<z.ZodOptional<z.ZodObject<{
@@ -4503,14 +4551,36 @@ type ContainerProps = z.infer<typeof ContainerPropsSchema>;
  */
 declare function ContainerReader({ style, props }: ContainerProps): React.JSX.Element;
 
+declare const TemplateVariableSchema: z.ZodObject<{
+    name: z.ZodString;
+    description: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+}, "strip", z.ZodTypeAny, {
+    name: string;
+    description?: string | null | undefined;
+}, {
+    name: string;
+    description?: string | null | undefined;
+}>;
 declare const EmailLayoutPropsSchema: z.ZodObject<{
     backdropColor: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    backdropDisabled: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
     borderColor: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     borderRadius: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
     canvasColor: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     textColor: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     fontFamily: z.ZodOptional<z.ZodNullable<z.ZodEnum<["MODERN_SANS", "BOOK_SANS", "ORGANIC_SANS", "GEOMETRIC_SANS", "HEAVY_SANS", "ROUNDED_SANS", "MODERN_SERIF", "BOOK_SERIF", "MONOSPACE"]>>>;
     childrenIds: z.ZodNullable<z.ZodOptional<z.ZodArray<z.ZodString, "many">>>;
+    subject: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+    variables: z.ZodNullable<z.ZodOptional<z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        description: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+    }, "strip", z.ZodTypeAny, {
+        name: string;
+        description?: string | null | undefined;
+    }, {
+        name: string;
+        description?: string | null | undefined;
+    }>, "many">>>;
 }, "strip", z.ZodTypeAny, {
     fontFamily?: "MODERN_SANS" | "BOOK_SANS" | "ORGANIC_SANS" | "GEOMETRIC_SANS" | "HEAVY_SANS" | "ROUNDED_SANS" | "MODERN_SERIF" | "BOOK_SERIF" | "MONOSPACE" | null | undefined;
     borderColor?: string | null | undefined;
@@ -4518,7 +4588,13 @@ declare const EmailLayoutPropsSchema: z.ZodObject<{
     textColor?: string | null | undefined;
     childrenIds?: string[] | null | undefined;
     backdropColor?: string | null | undefined;
+    backdropDisabled?: boolean | null | undefined;
     canvasColor?: string | null | undefined;
+    subject?: string | null | undefined;
+    variables?: {
+        name: string;
+        description?: string | null | undefined;
+    }[] | null | undefined;
 }, {
     fontFamily?: "MODERN_SANS" | "BOOK_SANS" | "ORGANIC_SANS" | "GEOMETRIC_SANS" | "HEAVY_SANS" | "ROUNDED_SANS" | "MODERN_SERIF" | "BOOK_SERIF" | "MONOSPACE" | null | undefined;
     borderColor?: string | null | undefined;
@@ -4526,7 +4602,13 @@ declare const EmailLayoutPropsSchema: z.ZodObject<{
     textColor?: string | null | undefined;
     childrenIds?: string[] | null | undefined;
     backdropColor?: string | null | undefined;
+    backdropDisabled?: boolean | null | undefined;
     canvasColor?: string | null | undefined;
+    subject?: string | null | undefined;
+    variables?: {
+        name: string;
+        description?: string | null | undefined;
+    }[] | null | undefined;
 }>;
 type EmailLayoutProps = z.infer<typeof EmailLayoutPropsSchema>;
 
@@ -5339,12 +5421,24 @@ declare const EditorBlockSchema: z.ZodEffects<z.ZodDiscriminatedUnion<"type", an
     }>;
     EmailLayout: z.ZodObject<{
         backdropColor: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        backdropDisabled: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
         borderColor: z.ZodOptional<z.ZodNullable<z.ZodString>>;
         borderRadius: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
         canvasColor: z.ZodOptional<z.ZodNullable<z.ZodString>>;
         textColor: z.ZodOptional<z.ZodNullable<z.ZodString>>;
         fontFamily: z.ZodOptional<z.ZodNullable<z.ZodEnum<["MODERN_SANS", "BOOK_SANS", "ORGANIC_SANS", "GEOMETRIC_SANS", "HEAVY_SANS", "ROUNDED_SANS", "MODERN_SERIF", "BOOK_SERIF", "MONOSPACE"]>>>;
         childrenIds: z.ZodNullable<z.ZodOptional<z.ZodArray<z.ZodString, "many">>>;
+        subject: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        variables: z.ZodNullable<z.ZodOptional<z.ZodArray<z.ZodObject<{
+            name: z.ZodString;
+            description: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        }, "strip", z.ZodTypeAny, {
+            name: string;
+            description?: string | null | undefined;
+        }, {
+            name: string;
+            description?: string | null | undefined;
+        }>, "many">>>;
     }, "strip", z.ZodTypeAny, {
         fontFamily?: "MODERN_SANS" | "BOOK_SANS" | "ORGANIC_SANS" | "GEOMETRIC_SANS" | "HEAVY_SANS" | "ROUNDED_SANS" | "MODERN_SERIF" | "BOOK_SERIF" | "MONOSPACE" | null | undefined;
         borderColor?: string | null | undefined;
@@ -5352,7 +5446,13 @@ declare const EditorBlockSchema: z.ZodEffects<z.ZodDiscriminatedUnion<"type", an
         textColor?: string | null | undefined;
         childrenIds?: string[] | null | undefined;
         backdropColor?: string | null | undefined;
+        backdropDisabled?: boolean | null | undefined;
         canvasColor?: string | null | undefined;
+        subject?: string | null | undefined;
+        variables?: {
+            name: string;
+            description?: string | null | undefined;
+        }[] | null | undefined;
     }, {
         fontFamily?: "MODERN_SANS" | "BOOK_SANS" | "ORGANIC_SANS" | "GEOMETRIC_SANS" | "HEAVY_SANS" | "ROUNDED_SANS" | "MODERN_SERIF" | "BOOK_SERIF" | "MONOSPACE" | null | undefined;
         borderColor?: string | null | undefined;
@@ -5360,7 +5460,13 @@ declare const EditorBlockSchema: z.ZodEffects<z.ZodDiscriminatedUnion<"type", an
         textColor?: string | null | undefined;
         childrenIds?: string[] | null | undefined;
         backdropColor?: string | null | undefined;
+        backdropDisabled?: boolean | null | undefined;
         canvasColor?: string | null | undefined;
+        subject?: string | null | undefined;
+        variables?: {
+            name: string;
+            description?: string | null | undefined;
+        }[] | null | undefined;
     }>;
     Spacer: z.ZodObject<{
         props: z.ZodNullable<z.ZodOptional<z.ZodObject<{
@@ -5603,20 +5709,40 @@ declare const EditorBlockSchema: z.ZodEffects<z.ZodDiscriminatedUnion<"type", an
 type TEditorBlock = z.infer<typeof EditorBlockSchema>;
 type TEditorConfiguration = Record<string, TEditorBlock>;
 
+type TemplateVariable = {
+    name: string;
+    description?: string;
+};
+/**
+ * Payload passed to `onSave` / `saveAs`. The editor renders body HTML and
+ * plain text on every save so consumers don't have to call the renderers
+ * themselves — keeps the consumer's bundle decoupled from a specific
+ * renderer version.
+ */
+type SavePayload = {
+    editorConfig: TEditorConfiguration;
+    subject?: string;
+    variables?: TemplateVariable[];
+    bodyHtml: string;
+    bodyText: string;
+};
+
+type TemplateKind$1 = 'template' | 'sample';
 interface EmailEditorContextType {
     currentTemplateId: string | null;
     currentTemplateName: string | null;
+    currentTemplateKind: TemplateKind$1 | null;
     saveTemplate: () => TEditorConfiguration;
-    loadTemplate: (template: TEditorConfiguration, templateId?: string, templateName?: string) => void;
+    loadTemplate: (template: TEditorConfiguration, templateId?: string, templateName?: string, kind?: TemplateKind$1 | null) => void;
     registerSaveListener: (callback: (template: TEditorConfiguration) => void) => () => void;
-    setCurrentTemplate: (templateId: string | null, templateName: string | null) => void;
+    setCurrentTemplate: (templateId: string | null, templateName: string | null, kind?: TemplateKind$1 | null) => void;
 }
 interface EmailEditorProviderProps {
     children: React.ReactNode;
     initialTemplate?: TEditorConfiguration;
     initialTemplateId?: string;
     initialTemplateName?: string;
-    onSave?: (template: TEditorConfiguration) => void;
+    onSave?: (payload: SavePayload) => void | Promise<void>;
     onChange?: (template: TEditorConfiguration) => void;
 }
 declare const EmailEditorProvider: React.FC<EmailEditorProviderProps>;
@@ -5626,12 +5752,21 @@ declare const useEmailEditor: () => EmailEditorContextType;
  * Wraps a raw HTML string in an editor config with an EmailLayout root + one Html block.
  */
 declare function htmlToEditorConfig(html: string): TEditorConfiguration;
-interface SampleTemplate {
+type TemplateKind = 'template' | 'sample';
+interface TemplateListItem {
     id: string;
-    name: string;
+    slug: string;
+    kind: TemplateKind;
     description?: string;
-    category?: string;
-    thumbnail?: string;
+    subject?: string;
+    variables?: Array<{
+        name: string;
+        description?: string;
+    }>;
+    tags?: string[];
+    thumbnailUrl?: string;
+    createdAt?: string;
+    updatedAt?: string;
 }
 interface EmailEditorRef {
     saveTemplate: () => TEditorConfiguration;
@@ -5647,7 +5782,12 @@ interface EmailEditorProps {
     initialTemplate?: TEditorConfiguration | string;
     initialTemplateId?: string;
     initialTemplateName?: string;
-    onSave?: (template: TEditorConfiguration) => void;
+    /**
+     * Called when the user saves the current template. Receives a `SavePayload`
+     * containing the source `editorConfig` plus pre-rendered `bodyHtml` /
+     * `bodyText` and the editor-managed `subject` / `variables` metadata.
+     */
+    onSave?: (payload: SavePayload) => void | Promise<void>;
     onChange?: (template: TEditorConfiguration) => void;
     /**
      * Duration for drawer enter transition in milliseconds. Set to 0 for instant.
@@ -5684,12 +5824,12 @@ interface EmailEditorProps {
      * Callback to load samples dynamically.
      * This will be called when the samples drawer is opened.
      */
-    loadSamples?: () => Promise<SampleTemplate[]>;
+    loadSamples?: () => Promise<TemplateListItem[]>;
     /**
      * Callback to load existing templates dynamically.
      * This will be called when the samples drawer is opened.
      */
-    loadTemplates?: () => Promise<SampleTemplate[]>;
+    loadTemplates?: () => Promise<TemplateListItem[]>;
     /**
      * Callback to load a specific template by ID.
      * This will be called when a sample is selected from the drawer.
@@ -5704,11 +5844,21 @@ interface EmailEditorProps {
      */
     copyTemplate?: (templateName: string, content: any) => void;
     /**
-     * Callback to save a template with a new name.
+     * Callback to rename a template by ID. Receives the new slug.
+     */
+    renameTemplate?: (templateId: string, newSlug: string) => void | Promise<void>;
+    /**
+     * Callback to promote/demote a row between `template` and `sample`.
+     * When omitted, promote/demote menu items are hidden.
+     */
+    setTemplateKind?: (templateId: string, kind: TemplateKind) => void | Promise<void>;
+    /**
+     * Callback to save a template with a new name. Receives the same
+     * `SavePayload` shape as `onSave`. Returns the new row's `id` and `slug`.
      */
-    saveAs?: (templateName: string, content: any) => Promise<{
+    saveAs?: (templateName: string, payload: SavePayload) => Promise<{
         id: string;
-        name: string;
+        slug: string;
     }>;
     /**
      * Optional theme override. If not provided, the default theme will be used.
@@ -5718,4 +5868,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, ImageProps, ImagePropsSchema, Reader, ReaderBlock, ReaderBlockSchema, ReaderDocumentSchema, Signature, SignatureProps, SignaturePropsDefaults, SignaturePropsSchema, Spacer, SpacerProps, SpacerPropsDefaults, SpacerPropsSchema, type TReaderBlock, type TReaderBlockProps, type TReaderDocument, type TReaderProps, Text, TextProps, TextPropsDefaults, TextPropsSchema, 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, Heading, HeadingProps, HeadingPropsDefaults, HeadingPropsSchema, Html, HtmlProps, HtmlPropsSchema, Image, ImageProps, ImagePropsSchema, 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, buildBlockComponent, buildBlockConfigurationDictionary, buildBlockConfigurationSchema, htmlToEditorConfig, renderToStaticMarkup, renderToText, THEME as theme, useEmailEditor };