@emailmaker/emailmaker 1.0.116 → 1.0.117-alpha.1

package/README.md

@@ -4,59 +4,125 @@
 
 # Установка
 
-Выполните этот код в командной строке:
+Установите пакет из npm:
 
-```cmd
-$ npm i @emailmaker/emailmaker@1.0.116 -save
+```bash
+npm install @emailmaker/emailmaker@1.0.117-alpha.1
 ```
 
-Добавьте EmailMaker plugin в ваш App config.
+### Полезные ссылки
 
-### Для сборщика Webpack
+- Каталог пакета на npm: [@emailmaker/emailmaker](https://www.npmjs.com/package/@emailmaker/emailmaker)
+- Справка на сайте EmailMaker: [Подключение редактора](https://emailmaker.ru/docs/help/plugin/connecting-the-editor/)
 
-Импорт пакета:
+Добавьте плагин сборки EmailMaker в конфигурацию приложения (он копирует статику пакета и задаёт **`EmailmakerEnvironment.publicPath`** для загрузки чанков). Без Webpack/Vite-плагина вручную нужно обеспечить корректный базовый путь к бандлу.
 
-```javascript
-const emailMakerPlugin = require('@emailmaker/emailmaker/webpack');
-```
+## Чеклист для агентов и автоматизации
+
+Используйте таблицу при генерации кода интеграции или ревью. Источник типов — **`emailmaker.d.ts`** в пакете (**`ExportedApi`**); не подставляйте вымышленные поля API.
+
+Подробнее о том, как в `.d.ts` сливаются **`ExportedApi.Options` / `Instance`**, что такое **`AppEvent`** и **`SaveEventPayload`**, и как читать исключения (**`handleSubjectChanged`** и др.): в репозитории EmailMaker — **`docs/plugin-types-agents.md`**.
+
+| Правило | Детали |
+| --- | --- |
+| **`init`** | Обязательно **`content`**. Сигнатура: **`init(options)` → `Promise<Instance>`**. |
+| Namespace vs **instance** | У модуля **`emailmaker`** — в основном **`init`** (+ именованные ESM-экспорты). **`setConfig`**, **`show`**, **`save`**, **`destroy`** — у **экземпляра** после **`init`**. |
+| Повтор на том же DOM | Повторный **`init`** на тот же узел ведёт к **`reset`** — не запускайте два параллельных **`init`** на один контейнер. |
+| События | **`instance.handle*(…)`** обычно возвращает **отписку**. **`handleSubjectChanged`** / **`handlePreheaderChanged`** — другая сигнатура (см. типы). |
+| Async | Колбэки и **`getAuthToken`** могут быть **`async`**; ошибки — через **`handleError`** или свою логику. |
+| Сборка | Без штатного плагина Webpack/Vite задайте **`publicPath`** (**`EmailmakerEnvironment`**). Бандл крупный (React, Monaco и др.). |
+| Авторизация | **`getAuthToken`** или **`jwtAuth`**; **`client_secret`** только на сервере. |
+| Файловый менеджер | **`storageProvider`**, **`config.imageCenterFileManagerView: true`**, при необходимости секция **`config.fileManager`** (**`ExportedApi.FileManagerOptions`**). Контракт **`StorageProvider`** объёмен — сверяйтесь с типами. |
+| **`baseUrl`** | Базовый URL API приложения (**`AppInitMixin`**), если бэкенд не стандартный. |
+| **`standaloneKey`** | Режимы с прокси файлов через события (см. код плагина); редкие сценарии. |
+| **`commonStyles`** | Опционально на **`init` / `reset`**: объект стилей контента (частичный merge с **`COMMON_STYLES`**). Подробности — **`docs/plugin-content-styles.md`**. |
+
+Примеры в репозитории: **`src/pluginExamples/`** (например **`plugin_default.html`**).
+
+### Для сборщика Webpack
 
-Определение пакета в приложении:
+Импортируйте класс и передайте его в `plugins` под тем же именем:
 
 ```javascript
+const EmailmakerWebpackPlugin = require('@emailmaker/emailmaker/webpack');
+
 module.exports = {
-  plugins: [new EmailmakerWebpackPlugin()],
+  plugins: [
+    new EmailmakerWebpackPlugin({
+      // По желанию: outputFolder, modulesPath, publicPath — см. пакет.
+    }),
+  ],
 };
 ```
 
 ### Для сборщика Vite
 
-Импорт пакета:
+Импорт только из **scoped-пакета**. Функция возвращает **массив из двух плагинов** — его нужно распаковать:
 
 ```javascript
-import emailMakerPlugin from 'emailmaker/vite';
-```
-
-Определение пакета в приложении:
+import { defineConfig } from 'vite';
+import emailmakerVite from '@emailmaker/emailmaker/vite';
 
-```javascript
 export default defineConfig({
-  plugins: [emailMakerPlugin()],
+  plugins: [
+    ...emailmakerVite({
+      // По желанию: outputFolder, modulesPath, publicPath — см. пакет.
+    }),
+  ],
 });
 ```
 
+## `EmailmakerEnvironment`
+
+Плагины Webpack/Vite добавляют в бандл объект **`EmailmakerEnvironment = { publicPath: '...' }`** с базовым URL к чанкам пакета. Вручную менять его обычно не нужно; без штатного плагина задайте **`publicPath`** самостоятельно так, чтобы загрузчик нашёл собранные **`emailmaker.js`** / **`emailmaker-esm.js`**.
+
+Имя класса Webpack-плагина строится из имени приложения в `package.json` (для **`@emailmaker/emailmaker`** это **`EmailmakerWebpackPlugin`**).
+
 # Инициализация
 
-Импортируйте EmailMaker plugin в вашем компоненте:
+Импортируйте плагин в коде приложения:
 
 ```javascript
 import * as emailmaker from '@emailmaker/emailmaker';
 ```
 
-Параметры инициализации плагина содержат параметр `getAuthToken`. В него должна быть передана функция, которая запрашивает авторизационный OAuth токен по Client ID и Client Secret.
+У **`init`** обязательное поле — **`content`** (HTML-строка или объект письма / шаблона). После успешной инициализации методы **`setConfig`**, **`updateConfig`**, **`show`**, **`save`** и др. доступны у **экземпляра**, возвращённого из **`init`** (не у объекта `emailmaker`).
+
+Частые поля верхнего уровня — в таблице; детали конфигурации и содержимого см. ниже в разделе **«Конфигурация»**.
+
+| Поле | Назначение |
+| --- | --- |
+| **`getAuthToken`** или **`jwtAuth`** | OAuth-колбэк **или** вход по логину/паролю (**`ExportedApi.JWTMixin`** / **`jwtAuth`**). Не смешивайте сценарии без необходимости. |
+| **`element`** | Контейнер монтирования (селектор, узел или фрагмент). |
+| **`content`** | Обязательно: HTML-строка или объект письма/шаблона. |
+| **`config`** | Настройки UI редактора (**`ExportedApi.Config`**). |
+| **`project`** | Идентификатор проекта в вашей системе / в EmailMaker. |
+| **`baseUrl`** | Базовый URL API при кастомном бэкенде (**`AppInitMixin.Options`**). |
+| **`storageProvider`** | Реализация **`StorageProvider`** для файлового менеджера. |
+| **`standaloneKey`** | Редкие режимы прокси файлов (**`instance.handleFileProxy`** / **`handleUrlProxy`**). |
+| **`commonStyles`** | Объект стилей контента (частичный **merge** с **`COMMON_STYLES`**). См. **`docs/plugin-content-styles.md`**. |
+
+- **`getAuthToken`** — функция **`(user?, project?, prevToken?) => string | Promise<string>`**, возвращающая OAuth access token. **`client_secret`** получайте **только на сервере**.
+- **`jwtAuth`** — **`{ email, password, remember? }`** вместо **`getAuthToken`** (см. **`ExportedApi.JWTMixin`** в **`emailmaker.d.ts`**).
+
+Именованные экспорты в ESM-сборке (**`emailmaker-esm.js`**):
+
+```javascript
+import { init, parseAMP, COMMON_STYLES, version, helpers, errors } from '@emailmaker/emailmaker';
+```
+
+| Экспорт | Назначение |
+| --- | --- |
+| **`init`** | То же, что **`emailmaker.init`**, с ленивой подгрузкой ядра (**`Promise<Instance>`**). |
+| **`parseAMP`** | Разбор AMP: вход — строка или **`{ code }`**, результат **`ParsedAMP`** (html / ampHtml и т.д.). |
+| **`COMMON_STYLES`** | Дефолтный пресет стилей контента текущей сборки EmailMaker. Для **`init({ commonStyles: { ...COMMON_STYLES, … } })`**. Исходник с JSDoc: **`src/constants/commonStyles.defaults.ts`**. |
+| **`version`** | Строка версии сборки. |
+| **`helpers`** | Вспомогательные утилиты (например, соответствие HTTP-статусов кодам ошибок). |
+| **`errors`** | Ошибки API, в т.ч. **`errors.FileManagerApiError`** для контракта с файловым менеджером. |
 
 ### Получение OAuth токена на бэкенде
 
-```curl
+```bash
 curl --location 'https://api.emailmaker.ru/oauth/token' \
 --header 'Content-Type: application/x-www-form-urlencoded' \
 --data-urlencode 'client_id=*******' \
@@ -64,15 +130,27 @@ curl --location 'https://api.emailmaker.ru/oauth/token' \
 --data-urlencode 'grant_type=client_credentials'
 ```
 
+Пример **клиентской** функции: токен отдаёт ваш бэкенд (секрет не уходит в браузер):
+
+```javascript
+async function getAuthToken(user, project, prevToken) {
+  const res = await fetch('/api/your-backend/emailmaker-token', { method: 'POST' });
+  const data = await res.json();
+  return data.access_token;
+}
+```
+
 ### Создание сущности EmailMaker plugin
 
+Простейший вариант — HTML письма и тема:
+
 ```javascript
 emailmaker
   .init({
-    getAuthToken: getAuthToken,
+    getAuthToken,
     element: '#test',
     content: {
-      title: 'Email subject',
+      subject: 'Тема письма',
       html: `КОД_ПИСЬМА`,
     },
     config: {},
@@ -80,52 +158,129 @@ emailmaker
   .then((instance) => {});
 ```
 
+Вариант с **шаблоном** и внешним id письма:
+
+```javascript
+emailmaker
+  .init({
+    getAuthToken,
+    element: '#editor',
+    project: 'ключ-проекта-в-вашей-системе',
+    content: {
+      templateId: 22304,
+      email: {
+        id: 'crm-email-id-123',
+      },
+      blocks: [],
+    },
+    config: {
+      theme: 'light',
+      // advancedConfigs: { editor: { … }, pro: { … } },
+    },
+  })
+  .then((instance) => {});
+```
+
 КОД_ПИСЬМА можно взять из <a href="https://emcdn.ru/plugin/new-email.html" target="_blank">нашего образца</a> или вставить HTML-код своего письма.
 
+### React (обёртка)
+
+Минимальный каркас: монтирование, **`destroy`** при размонтировании.
+
+```tsx
+import { useEffect, useRef } from 'react';
+import * as emailmaker from '@emailmaker/emailmaker';
+
+export function EmailmakerEditor({
+  project,
+  templateId,
+  getAuthToken,
+}: {
+  project: string | number;
+  templateId: number;
+  getAuthToken: NonNullable<Parameters<typeof emailmaker.init>[0]['getAuthToken']>;
+}) {
+  const rootRef = useRef<HTMLDivElement>(null);
+
+  useEffect(() => {
+    let instance: Awaited<ReturnType<typeof emailmaker.init>> | undefined;
+
+    (async () => {
+      instance = await emailmaker.init({
+        getAuthToken,
+        element: rootRef.current ?? '#emailmaker-root',
+        project,
+        content: { email: { id: 'new' }, templateId },
+        config: { theme: 'light' },
+      });
+    })();
+
+    return () => {
+      instance?.destroy();
+    };
+  }, [project, templateId, getAuthToken]);
+
+  return <div id="emailmaker-root" ref={rootRef} style={{ height: '100vh' }} />;
+}
+```
+
 # Конфигурация
 
-Конфигурация плагина представляет собой JSON с несколькими уровнями вложенности. В конфигурации вы можете настроить внешний вид, содержимое, с которым будет работать плагин и логику.
+Конфигурация задаётся объектом с несколькими уровнями вложенности: внешний вид редактора, стартовое содержимое и обработчики событий.
+
+Повторный вызов **`init`** на **тот же DOM-элемент** внутри приводит к **`reset`** с новыми опциями — не запускайте параллельно два **`init`** на один контейнер.
 
 ### element
 
-Вы можете передать строку `element` в конфигурацию плагина. Это селектор DOM-элемента, внутри которого нужно инициализировать плагин. Если элемент не определен, приложение будет запущено в фоновом режиме.
+Строка-селектор, **`Element`** или **`DocumentFragment`**: контейнер, куда монтируется редактор. Если элемент не задан, приложение может работать в фоновом режиме без видимого контейнера.
 
 ### content
 
-Секция `content` содержит параметры письма, которое нужно отобразить в редакторе.
-В этот параметр может быть передано:
+Секция **`content`** задаёт данные для редактора. Варианты:
 
 #### {string}
 
-HTML верстка письма.
+HTML-разметка письма.
 
-#### {object} email options
+#### {object} параметры письма
 
 ```javascript
 {
-	id?: string; // Уникальный ID проекта в вашей системе.
-	html?: string; // HTML верстка письма.
+	id?: string; // Уникальный ID письма в вашей системе.
+	html?: string; // HTML письма.
 	subject?: string; // Тема письма.
-	preheader?: string; // Прехедер письма.
+	preheader?: string; // Прехедер.
 }
 ```
 
-#### {object} full description
+#### {object} шаблон, блоки, комментарии
 
 ```javascript
 {
-	temlateId?: string; // ID шаблона внутри EmailMaker.
-	email?: object; // email options.
-	blocks?: []; // Дополнительные блоки.
-	comments?: []; // Комментарии в письме.
+	templateId?: string | number; // ID шаблона в EmailMaker.
+	email?: object; // параметры письма (см. выше).
+	blocks?: []; // блоки.
+	comments?: []; // комментарии к письму.
 }
 ```
 
-Можно изменить содержимое в любой момент после инициализации с помощью метода `instance.show(content)`.
+Сменить контент после инициализации: **`instance.show(content)`**.
+
+### Стили контента (`commonStyles`)
+
+Не путать с **`config`**: объект **`commonStyles`** передаётся **на верхнем уровне** **`init`** / **`reset`** (тип **`ExportedApi.AppConfigMixin.Options`**).
+
+- **Дефолт из сборки:** именованный экспорт **`COMMON_STYLES`** (см. исходник **`src/constants/commonStyles.defaults.ts`**, там же подробный **JSDoc** для IDE).
+- **Частичное переопределение:** можно передать только нужные ветки (например `{ block: { backgroundColor: '#000' } }`) — приложение **сливает** их с **`COMMON_STYLES`**, чтобы панель «Стили контента», iframe и список общих блоков не ломались на «дырах» в объекте.
+- **Приоритет:** сохранённое **`email.common_styles`** важнее, чем **`init.commonStyles`**.
+- **Сброс** сохранённого в сторе плагина override: **`commonStyles: undefined`** в **`reset`** или **`updateConfig`** (с ключом).
+- **Вкладка в UI:** флаг **`config.commonStylesEnabled`** (часто `true` по умолчанию).
+
+Полное описание: **`docs/plugin-content-styles.md`** в репозитории EmailMaker.
 
 ### config
 
-Раздел для настройки внешнего вида и настроек редактора. Вы можете изменить конфигурацию этого раздела после инициализации, используя `emailmaker.setConfig` или `emailmaker.updateConfig`.
+Настройки UI редактора. После **`init`** используйте **`instance.setConfig`**, **`instance.updateConfig`** и **`instance.getConfig`** — не методы объекта **`emailmaker`**.
 
 ##### Список параметров секции config
 | Параметр                               | Описание                                                                    | Значение по умолчанию |
@@ -135,7 +290,7 @@ HTML верстка письма.
 | mergeTags                              | JSON со списком динамических переменных.                                    | undefined             |
 | styles                                 | Строка со стилями в формате CSS.                                            | ''                    |
 |                                        |                                                                             |                       |
-| headerShow                             | Ппоказ шапки.                                                               | true                  |
+| headerShow                             | Показ шапки.                                                                | true                  |
 | headerArrowBackVisible                 | Показ стрелки "Назад".                                                      | true                  |
 | headerTitleVisible                     | Показ поля "Тема".                                                          | true                  |
 | headerPreheaderVisible                 | Показ поля "Прехедер".                                                      | true                  |
@@ -172,7 +327,7 @@ HTML верстка письма.
 | nextButtonEnabled                      | Показ второстепенной кнопки.                                                | false                 |
 | nextButtonText                         | Текст на второстепенной кнопке.                                             | ''                    |
 | saveButtonEnabled                      | Показ основной кнопки.                                                      | true                  |
-| saveButtonText                         | Текст основной кнопки.                                                      | true                  |
+| saveButtonText                         | Текст основной кнопки.                                                      | ''                    |
 | commandButtonsEnabled                  | Показ основной и второстепенной кнопки.                                     | true                  |
 |                                        |                                                                             |                       |
 | sidePanelFloating                      | Плавающая боковая панель.                                                   | true                  |
@@ -263,92 +418,103 @@ HTML верстка письма.
 | imageCenterStockEnabled                | Таб Стока фотографий.                                                       | true                  |
 | imageCenterGifEnabled                  | Таб Стока гифок.                                                            | true                  |
 | imageCenterEditorEnabled               | Таб редактора изображений.                                                  | true                  |
-| compressMaxSize                        | Макс. вес картинки после оптимизации, Мб.                                   | true                  |
-| compressMaxWidthOrHeight               | Макс. ширина картинки после оптимизации, px.                                | true                  |
-### Обработка событий
+| compressMaxSize                        | Макс. размер файла для клиентского сжатия в файловом менеджере, байт (по умолчанию порядка 5 MiB). | см. типы |
+| compressMaxWidthOrHeight               | Макс. ширина/высота после ресайза, px (по умолчанию 2000).                   | см. типы |
 
-События могут быть переданы в конфигурации или добавлены после при работе с экземпляром плагина. Все подписчики событий могут быть асинхронными функциями.
+### Обработка событий
 
-#### Пример
+Обработчики передаются в **`init({ ... })`** или подписываются на экземпляре: **`instance.handle*(listener, priority?)`**. Подписка обычно возвращает **функцию отписки**. Обработчики могут быть **`async`**.
 
-```javascript
-emailmaker.init({
-	....,
-	// Подписка на события в инициализации.
-	handleReadEmail: (e) => {},
-	handleSaveEmail: async (e) => {}
-}).then((instance) => {
-	// Подписка на события после инициализации.
-	const dispose = instance.handleReadEmail(e => {});
-	const dispose = instance.handleSaveEmail(async (e) => {});
-});
-```
+События **`handleSaveEmail`**, **`handleSaveBlock`**, **`handleSaveComment`** получают **не сырой объект**, а **`SaveEventPayload`**: **`{ patch, value, prev?, source? }`** — полезно сравнивать **`patch`** и итоговое **`value`**.
 
-Передавая асинхронную функцию, вы можете реализовать асинхронную загрузку данных.
+**`handleSubjectChanged`** и **`handlePreheaderChanged`** оформлены иначе: через них подписываются на строковые значения темы и прехедера — см. **`emailmaker.d.ts`**.
 
 #### Пример
 
 ```javascript
 emailmaker.init({
-	element: "#test",
-	content: {
-		id: "1"
-	}
-	handleReadEmail: async (id) => {
-		return await  fetchData(id); // Ваша функция получения данных.
-	}
+  element: '#test',
+  content: { email: { id: '1' } },
+  getAuthToken,
+  handleReadEmail: async (id) => fetchEmail(id),
+  handleSaveEmail: async (payload) => saveEmail(payload.value),
 }).then((instance) => {
-	setTimeout(() => instance.show({ id: "2" }), 1000)
+  const unsubscribe = instance.handleEmailChanged(async () => {
+    /* ... */
+  });
+  /* unsubscribe(); */
 });
 ```
 
 ### События
 
-| Обработчик события        | Описание                                   |
-| ------------------------- | ------------------------------------------ |
-| handleReadEmail           | Чтение письма                              |
-| handleSaveEmail           | Сохранение / обновление письма             |
-| handleReadEmailRevisions  | Чтение списка автосохранений               |
-| handleEmailAutosave       | Автосохранение                             |
-| handleReadBlocks          | Чтение списка блоков проекта               |
-| handleSaveBlock           | Сохранение / обновление блока проекта      |
-| handleRemoveBlock         | Удаление блока проекта                     |
-| handleReadComments        | Чтение списка комментариев письма          |
-| handleSaveComment         | Сохранение / обновление комментария        |
-| handleRemoveComment       | Удаление комментария письма                |
-| handleSaveButtonClick     | Нажатие кнопки сохранения письма           |
-| handleNextButtonClick     | Нажатие кнопки Далее                       |
-| handlePreviousButtonClick | Нажатие кнопки Назад                       |
-| handleEmailChanged        | Изменение любого параметра письма          |
-| handleHtmlChanged         | Изменение кода письма                      |
-| handleDestroy             | Деструкция плагина                         |
-| handleLoad                | Окончание инициализации экземпляра плагина |
-| handleLoadImage           | Загрузка изображений                       |
-| handleNotify              | Уведомление                                |
-| handleError               | Уведомление типа Ошибка                    |
-| handleSuccess             | Уведомление типа Успех                     |
-| handleTestEmailSend       | Отправка тестового письма                  |
-| handleTestEmailModal      | Открытие модального окна тестового письма  |
+| Обработчик | Описание |
+| ---------- | -------- |
+| handleReadEmail | Загрузка письма по id с вашего API (**аргумент — строка id**). |
+| handleSaveEmail | Сохранение письма; полезная нагрузка — **`SaveEventPayload`** с **`value`** и **`patch`**. |
+| handleRemoveEmail | Удаление письма. |
+| handleReadEmailRevisions | Список автосохранений / ревизий для письма. |
+| handleEmailAutosave | Создано автосохранение (**`EmailRevision`**). |
+| handleRemoveEmailAutoSave | Удалено автосохранение. |
+| handleReadBlocks | Список блоков проекта. |
+| handleReadCommonBlocks | Общие блоки. |
+| handleReadTemplateBlocks | Блоки шаблона в контексте письма. |
+| handleSaveBlock | Сохранение блока (**`SaveEventPayload`**). |
+| handleRemoveBlock | Удаление блока. |
+| handleReadComments | Комментарии к письму. |
+| handleSaveComment | Сохранение комментария. |
+| handleRemoveComment | Удаление комментария. |
+| handleSaveButtonClick | Клик по основной кнопке (например «Сохранить»). |
+| handleNextButtonClick | Клик по «Далее». |
+| handlePreviousButtonClick | Клик «Назад» в шапке. |
+| handleEmailInit | Инициализирован контур письма. |
+| handleEmailChanged | Изменился параметр письма. |
+| handleHtmlChanged | Изменился HTML-код. |
+| handleSubjectChanged | Изменилась тема (особая подпись — см. типы). |
+| handlePreheaderChanged | Изменился прехедер (особая подпись — см. типы). |
+| handleCloneEmail | Клонирование письма. |
+| handleShareEmail | Поделиться. |
+| handleLivePreviewEmail | Живой предпросмотр. |
+| handlePreviewEmail | Предпросмотр. |
+| handleValidate | Результат проверки кода (**`CodeError[]`**). |
+| handleTestEmailSend | Отправка тестового письма. |
+| handleTestEmailModal | Открыто окно тестовой отправки. |
+| handleDestroy | Перед уничтожением экземпляра. |
+| handleLoad | Завершена загрузка экземпляра; можно безопасно вызывать **`getEmail`** и др. |
+| handleLoadImage | Загрузка изображения пользователем; **`handleFileProxy`**, **`handleUrlProxy`** — прокси файлов/URL при необходимости. |
+| handleNotify | Произвольное уведомление. |
+| handleError | Ошибка (можно переопределить UI). |
+| handleSuccess | Успешная операция. |
+| handleReadLocale | Язык интерфейса (**`AppConfigMixin`**). |
+| handleTranslate | Пользовательский перевод строк. |
+| handleLimitUsage | Отображение квот / лимитов. |
+
+Полный перечень и сигнатуры — в **`emailmaker.d.ts`** (**`ExportedApi.DataMixin.Events`** и смежные миксины).
 
 ### Методы
 
-| Метод             | Описание                                  |
-| ----------------- | ----------------------------------------- |
-| init              | Инициализация (async)                     |
-| show              | Изменение содержимого после инициализации |
-| destroy           | Деструкция экземпляра                     |
-| reset             | Сброс всей конфигурации                   |
-| getEmail          | Получение текущего письма                 |
-| getConfig         | Получение конфигурации                    |
-| getBlocks         | Получение блоков проекта                  |
-| getComments       | Получение комментариев письма             |
-| getEmailRevisions | Получение списка контроля версий          |
-| setConfig         | Установка новых парамеров config          |
-| updateConfig      | Добавление к параметрам config            |
-| notify            | Показ уведомлений                         |
-| getElement        | Получение элемента инициализации          |
-| save              | Сохраенние письма.                        |
-| compileEmail      | Получение скопмилированного письма        |
+Модуль экспортирует **`init`** (и именованные символы в ESM). Остальное — методы **экземпляра** после **`await emailmaker.init(...)`**.
+
+| Метод | Описание |
+| ----- | -------- |
+| init | Асинхронная инициализация: **`Promise<Instance>`**. |
+| show | Подмена контента (**строка или объект `Content`**). |
+| save | Сохранить текущее письмо по цепочке приложения. |
+| getEmail | Текущее письмо; для скомпилированных полей см. **`compileEmail`** / **`CompiledEmail`**. |
+| compileEmail | Явная компиляция HTML/AMP/текста; опционально **`email`** и флаги форматов. |
+| setEmailMeta | Обновить **`meta`** текущего письма без полной замены. |
+| getBlocks | Блоки в текущем контексте. |
+| getComments | Комментарии. |
+| getEmailRevisions | Ревизии / автосохранения. |
+| getCodeErrors | Ошибки линтера кода в редакторе. |
+| getConfig | Текущий **`config`**. |
+| setConfig | Полная замена настроек UI. |
+| updateConfig | Глубокое слияние с текущим **`config`**. |
+| notify | Показать уведомление (строка или объект). |
+| getElement | DOM-узел или фрагмент монтирования. |
+| destroy | Уничтожить экземпляр (вызывайте при размонтировании в SPA). |
+| reset | Переинициализация с новыми **`Options`** (**`Promise<Instance>`**). |
+| undoRedoService | Сервис отмены/повтора (**`undo`**, **`redo`**, снимки истории и др.). |
 
 ### 📂 Файловый менеджер