@go-mailer/easy-email-extensions 5.0.4 → 5.0.5

package/lib/hooks/useAIContext.d.ts

@@ -0,0 +1,48 @@
+import { EditorContent } from '@go-mailer/easy-email-editor';
+export interface AIBlockSummary {
+    /** Dot-path index into the email JSON tree, e.g. `"content.children.[0].children.[1]"`. */
+    idx: string;
+    /** MJML block type string, e.g. `"advanced_text"`, `"advanced_image"`. */
+    type: string;
+    /** Human-readable title if set on the block. */
+    title?: string;
+    /** Plain text extracted from HTML content fields (text blocks). */
+    plainText: string;
+    /** Alt text for image blocks, empty for others. */
+    alt: string;
+    /** Href for button/link blocks, empty for others. */
+    href: string;
+}
+export interface AIEmailContext extends EditorContent {
+    /** Flat list of every block in the email with key content fields. */
+    blockSummaries: AIBlockSummary[];
+    /** Plain text of the entire email (all text blocks concatenated). */
+    emailPlainText: string;
+    /** Plain text of the currently focused block only. */
+    focusBlockPlainText: string;
+    /** The text the user has highlighted in the canvas right now. */
+    selectedText: string;
+}
+/**
+ * Returns a comprehensive snapshot of the current editor state, designed to
+ * be passed to an AI assistant.  The returned object includes:
+ *
+ * - `emailTemplate`       — full JSON tree (`IEmailTemplate`)
+ * - `focusIdx`            — dot-path of the selected block
+ * - `focusBlock`          — the selected block node
+ * - `focusBlockPlainText` — plain text extracted from the selected block
+ * - `selection`           — `{ text, blockIdx }` for the highlighted text
+ * - `selectedText`        — convenience alias for `selection.text`
+ * - `blockSummaries`      — flat list of all blocks with extracted content
+ * - `emailPlainText`      — full email as plain text (all blocks joined)
+ *
+ * Mount this inside `<EmailEditorProvider>`. The return value is memoized
+ * and only recalculates when relevant state changes.
+ *
+ * @example
+ * ```tsx
+ * const ctx = useAIContext();
+ * // Pass ctx to your AI panel, or send ctx.emailPlainText to your LLM API.
+ * ```
+ */
+export declare function useAIContext(): AIEmailContext;

package/lib/index.d.ts

@@ -17,3 +17,5 @@ export { getContextMergeTags } from './utils/getContextMergeTags';
 export { getIconNameByBlockType, setIconsMap } from './utils/getIconNameByBlockType';
 export { getBlockTitle } from './utils/getBlockTitle';
 export { MjmlToJson } from './utils/MjmlToJson';
+export { useAIContext } from './hooks/useAIContext';
+export type { AIEmailContext, AIBlockSummary } from './hooks/useAIContext';

package/lib/index.js

@@ -1,4 +1,4 @@
-export { e as Align, A as AttributePanel, f as AttributesPanelWrapper, ae as AutoCompleteField, l as Background, o as BackgroundColor, d as BlockAttributeConfigurationManager, B as BlockLayer, O as BlockMarketManager, Q as BlockMaskWrapper, r as Border, u as BorderColor, x as BorderStyle, z as BorderWidth, ah as CheckboxField, I as ClassName, h as CollapseWrapper, C as Color, al as ColorPickerField, i as Condition, j as ContainerBackgroundColor, D as Decoration, P as DefaultPageConfigPanel, p as Direction, aj as EditGridTabField, ai as EditTabField, a0 as ExtensionContext, a1 as ExtensionProvider, F as FontFamily, v as FontSize, y as FontStyle, E as FontWeight, _ as GoMailerLayout, H as Height, ab as ImageUploaderField, ak as InlineTextField, a5 as InputWithUnitField, U as InteractivePrompt, L as LetterSpacing, m as LineHeight, q as Link, t as Margin, $ as MergeTagBadgePrompt, w as MergeTags, M as MjmlToJson, N as NavbarLinkPadding, a8 as NumberField, G as Padding, J as PresetColorsProvider, a3 as RICH_TEXT_TOOL_BAR, af as RadioGroupField, an as RichTextField, a6 as SearchField, ac as SelectField, S as SelectionRangeProvider, ao as ShadowDom, K as ShortcutToolbar, X as SimpleLayout, a9 as SliderField, R as SourceCodePanel, Y as StandardLayout, ag as SwitchField, T as TextAlign, a7 as TextAreaField, k as TextDecoration, a4 as TextField, n as TextTransform, ad as TreeSelectField, Z as TwoColumnLayout, aa as UploadField, V as VerticalAlign, W as Width, am as enhancer, b as getBlockTitle, g as getContextMergeTags, a as getIconNameByBlockType, s as setIconsMap, a2 as useExtensionProps } from "./index2.js";
+export { e as Align, A as AttributePanel, f as AttributesPanelWrapper, af as AutoCompleteField, l as Background, o as BackgroundColor, d as BlockAttributeConfigurationManager, B as BlockLayer, Q as BlockMarketManager, R as BlockMaskWrapper, r as Border, v as BorderColor, y as BorderStyle, E as BorderWidth, ai as CheckboxField, J as ClassName, h as CollapseWrapper, C as Color, am as ColorPickerField, i as Condition, j as ContainerBackgroundColor, D as Decoration, P as DefaultPageConfigPanel, p as Direction, ak as EditGridTabField, aj as EditTabField, a1 as ExtensionContext, a2 as ExtensionProvider, F as FontFamily, w as FontSize, z as FontStyle, G as FontWeight, $ as GoMailerLayout, H as Height, ac as ImageUploaderField, al as InlineTextField, a6 as InputWithUnitField, X as InteractivePrompt, L as LetterSpacing, m as LineHeight, q as Link, t as Margin, a0 as MergeTagBadgePrompt, x as MergeTags, M as MjmlToJson, N as NavbarLinkPadding, a9 as NumberField, I as Padding, K as PresetColorsProvider, a4 as RICH_TEXT_TOOL_BAR, ag as RadioGroupField, ao as RichTextField, a7 as SearchField, ad as SelectField, S as SelectionRangeProvider, ap as ShadowDom, O as ShortcutToolbar, Y as SimpleLayout, aa as SliderField, U as SourceCodePanel, Z as StandardLayout, ah as SwitchField, T as TextAlign, a8 as TextAreaField, k as TextDecoration, a5 as TextField, n as TextTransform, ae as TreeSelectField, _ as TwoColumnLayout, ab as UploadField, V as VerticalAlign, W as Width, an as enhancer, b as getBlockTitle, g as getContextMergeTags, a as getIconNameByBlockType, s as setIconsMap, u as useAIContext, a3 as useExtensionProps } from "./index2.js";
 import "react";
 import "@go-mailer/easy-email-editor";
 import "@go-mailer/easy-email-core";