@one-million-lines/email-builder 0.3.0 → 0.4.0

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { EmailDocument, Theme } from './core/types';
+import { EmailDocument, Theme, MergeTag } from './core/types';
 import { documentSchema } from './core/validation';
 import { renderEmailHtml } from './core/renderer';
 import { ModuleDefinition } from './modules/registry';
@@ -31,6 +31,20 @@ export interface EmailBuilderProps {
      * Ignored when `voucherProvider` is provided.
      */
     voucherEndpoint?: string | VoucherOptions;
+    /**
+     * List of merge tags (personalisation tokens) available in the text element
+     * sidebar. When configured, a "Insert merge tag" dropdown appears allowing
+     * the user to insert `{attribute}` placeholders into text content.
+     *
+     * Example:
+     * ```ts
+     * mergeTags={[
+     *   { attribute: "user.firstname", title: "First name" },
+     *   { attribute: "user.lastname",  title: "Last name" },
+     * ]}
+     * ```
+     */
+    mergeTags?: MergeTag[];
     onChange?: (doc: EmailDocument) => void;
     onExportHtml?: (html: string) => void;
 }
@@ -47,7 +61,7 @@ export interface VanillaInstance {
     exportJson: () => string;
 }
 export declare function createEmailBuilder(opts: VanillaOptions): VanillaInstance;
-export type { Plugin, ModuleDefinition, AIProvider, EmailDocument, Theme };
+export type { Plugin, ModuleDefinition, AIProvider, EmailDocument, Theme, MergeTag };
 export { registerPlugin, renderEmailHtml, documentSchema };
 export { imageUploaderPlugin } from './plugins/imageUploader';
 export type { ImageUploaderOptions } from './plugins/imageUploader';

package/dist/modules/helpers.d.ts

@@ -1,4 +1,4 @@
-import { EmailElement, EmailModule, Product, ProductGridElement } from '../core/types';
+import { EmailElement, EmailModule, Product, ProductGridElement, SpecialLinkType } from '../core/types';
 export declare const text: (content: string, opts?: Partial<{
     role: "headline" | "subheadline" | "body" | "caption" | "voucherCode";
     fontSize: number;
@@ -13,6 +13,7 @@ export declare const text: (content: string, opts?: Partial<{
     lineHeight: number;
     letterSpacing: number;
     link: string;
+    linkType: SpecialLinkType;
     mobile: Record<string, unknown>;
 }>) => EmailElement;
 export declare const image: (src: string, alt: string, opts?: Partial<{
@@ -33,6 +34,7 @@ export declare const button: (label: string, link?: string, opts?: Partial<{
     borderRadius: number;
     paddingTop: number;
     paddingBottom: number;
+    linkType: SpecialLinkType;
     mobile: Record<string, unknown>;
 }>) => EmailElement;
 export declare const spacer: (height?: number) => EmailElement;
@@ -62,6 +64,7 @@ export declare const muted: (content: string, opts?: {
     paddingBottom?: number;
     lineHeight?: number;
     link?: string;
+    linkType?: SpecialLinkType;
     letterSpacing?: number;
 }) => EmailElement;
 export declare const voucherCode: (code: string, opts?: {
@@ -92,3 +95,27 @@ export declare const productGrid: (products: Product[], opts?: Partial<{
     paddingLeft: number;
     paddingRight: number;
 }>) => ProductGridElement;
+/**
+ * Creates a text element whose content is a series of inline `<a>` links,
+ * each carrying a `data-link-type` attribute so backend processors can
+ * identify and replace the placeholder href with a real per-recipient URL.
+ *
+ * Usage:
+ * ```ts
+ * footerLinks([
+ *   { label: "Unsubscribe", type: "unsubscribe" },
+ *   { label: "View in browser", type: "view_in_browser" },
+ * ], { align: "center", fontSize: 12 })
+ * ```
+ */
+export declare const footerLinks: (links: {
+    label: string;
+    type: SpecialLinkType;
+}[], opts?: {
+    align?: "left" | "center" | "right";
+    fontSize?: number;
+    color?: string;
+    paddingTop?: number;
+    paddingBottom?: number;
+    separator?: string;
+}) => EmailElement;

package/dist/plugins/mergeTags/state.d.ts

@@ -0,0 +1,8 @@
+import { MergeTag } from '../../core/types';
+interface MergeTagsState {
+    mergeTags: MergeTag[];
+    setMergeTags: (tags: MergeTag[]) => void;
+}
+export declare const useMergeTagsStore: import('zustand').UseBoundStore<import('zustand').StoreApi<MergeTagsState>>;
+export declare function setMergeTagsGlobal(tags: MergeTag[]): void;
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@one-million-lines/email-builder",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "description": "Embeddable visual email builder (React + vanilla JS) that composes modular marketing emails from a JSON model and exports table-based HTML.",
   "type": "module",
   "license": "MIT",