@emailmaker/extensions-sandbox 1.1.85-dev.9 → 1.1.93
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +9 -166
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -79,7 +79,7 @@ npm install @emailmaker/emailmaker @emailmaker/extensions-app @emailmaker/extens
|
|
|
79
79
|
|
|
80
80
|
| Пакет | Назначение | Что экспортирует |
|
|
81
81
|
|-------|------------|------------------|
|
|
82
|
-
| `@emailmaker/emailmaker` | Основной пакет | `init()`, `
|
|
82
|
+
| `@emailmaker/emailmaker` | Основной пакет | `init()`, `prefetch()`, типы `IPlugin`, `Instance`; runtime React/Ant Design — subpath `@emailmaker/emailmaker/runtime/*` (отдельный npm не нужен) |
|
|
83
83
|
| `@emailmaker/extensions-app` | API для app-плагинов | `pluginRegistry`, `DomComponentRegistry`, `ElementsApi`, `SettingsPanelApi`, `ModalApi` |
|
|
84
84
|
| `@emailmaker/extensions-react` | React API для плагинов | `ComponentRegistry`, `createComponentIdentifier()` |
|
|
85
85
|
| `@emailmaker/extensions-sandbox` | API для sandbox-плагинов | `App`, `MessageService`, `SyncService` |
|
|
@@ -205,11 +205,6 @@ module.exports = {
|
|
|
205
205
|
- `встраиваемый bundle` -> `globals`
|
|
206
206
|
- `advanced` -> только если host уже требует async/globals контракт Webpack
|
|
207
207
|
|
|
208
|
-
`globals` читает зависимости из глобального реестра **синхронно**, когда выполняется скрипт
|
|
209
|
-
плагина. Хост готовит реестр сам, если грузит плагин по URL через `init()` или `useAsync()`; при
|
|
210
|
-
ручной вставке `<script>` дождитесь `preload()` — подробности в разделе
|
|
211
|
-
`Подключение плагина`.
|
|
212
|
-
|
|
213
208
|
Для `встраиваемый bundle` и `advanced` рекомендуемый runtime-контракт — descriptor вида `{ type: 'umd', url, name, resolve: 'registry' }`, где `name` совпадает с ключом из `PluginTypeMap`.
|
|
214
209
|
|
|
215
210
|
### Ручная настройка (без PluginDev)
|
|
@@ -217,16 +212,9 @@ module.exports = {
|
|
|
217
212
|
Нужна только для продвинутой интеграции или собственного бандлерного пайплайна. Основной сценарий для внешнего плагина — отдельный пакет с `PluginDev`.
|
|
218
213
|
|
|
219
214
|
- `resolve.alias`: `react` → `@emailmaker/emailmaker/runtime/react` (и т.д.) для `esm` / dev; локальные shared internals идут через compat facades runtime; UI-kit (`@emailmaker/ui-kit`) → **`@emailmaker/emailmaker/ui-kit`** (singleton bytes на main, не `runtime/@scope/ui-kit`)
|
|
220
|
-
- `externals`: `@emailmaker/emailmaker/runtime
|
|
215
|
+
- `externals`: `@emailmaker/emailmaker/runtime/core`, runtime npm-модули; ui-kit external → **`@emailmaker/emailmaker/ui-kit`** (глобальный ключ `UiKit` в `runtimeExports`, см. манифест)
|
|
221
216
|
- Список модулей: `@emailmaker/emailmaker/runtime/plugin-dev-manifest.json` → `runtimeModules`
|
|
222
217
|
|
|
223
|
-
**Иконки — особый случай.** Общим (singleton) обязан быть только класс
|
|
224
|
-
`@ant-design/icons/es/components/AntdIcon`: он вычисляет иконку, читая `IconContext`, и вторая его
|
|
225
|
-
копия сломает тему. Сам каталог из восьми с лишним сотен определений singleton'ом не является —
|
|
226
|
-
каждый потребитель берёт его себе и вытрясает неиспользуемое. Поэтому обычный
|
|
227
|
-
`import { UserOutlined } from '@ant-design/icons'` в плагине законен: в сборку попадут только взятые
|
|
228
|
-
иконки, а общая машинерия придёт из продукта. `PluginDev` разводит эти два случая сам.
|
|
229
|
-
|
|
230
218
|
Если release bundle неожиданно стал толстым или target `встраиваемый bundle` не загружается, начните с раздела `Troubleshooting`.
|
|
231
219
|
|
|
232
220
|
Типы для плагина всё равно собираются отдельно: CLI-шаблон запускает `build:types` и кладёт `dist/public-types.d.ts` рядом с JS bundle, поэтому TypeScript support сохраняется и для browser/advanced targets.
|
|
@@ -260,114 +248,6 @@ import { ComponentRegistry } from '@emailmaker/extensions-react';
|
|
|
260
248
|
> Обычно достаточно использовать готовый шаблон CLI и не настраивать alias/external вручную.
|
|
261
249
|
|
|
262
250
|
|
|
263
|
-
---
|
|
264
|
-
|
|
265
|
-
# Совместимость: как плагин встречается с редактором
|
|
266
|
-
|
|
267
|
-
Одна страница на вопрос «что с чем работает». Всё остальное в этом разделе — подробности.
|
|
268
|
-
|
|
269
|
-
## Главное правило
|
|
270
|
-
|
|
271
|
-
Плагин и редактор обязаны использовать **один экземпляр** React, antd и ui-kit. Не потому, что так
|
|
272
|
-
аккуратнее: компоненты плагина рисуются внутри дерева редактора, и если экземпляры разные, хуки
|
|
273
|
-
вызываются против чужого диспетчера. На странице это выглядит как
|
|
274
|
-
`Cannot read properties of null (reading 'useState')` — падает не панель плагина, а весь интерфейс.
|
|
275
|
-
|
|
276
|
-
Сводить их вручную не нужно: этим занимается `PluginDev` в сборке плагина.
|
|
277
|
-
|
|
278
|
-
## Формат плагина × способ подключения
|
|
279
|
-
|
|
280
|
-
| Формат плагина | Как подключается | Где берёт React, antd, ui-kit |
|
|
281
|
-
|---|---|---|
|
|
282
|
-
| **ESM** (npm-пакет, собирается вместе с хостом) | импортом: `plugins: [MyPlugin]` или `useAsync(() => import(…))` | `PluginDev` переписывает импорты на подпути продукта |
|
|
283
|
-
| **UMD / globals** (файл по URL) | `{ type: 'umd', url, name, resolve: 'registry' }` | из реестра `window.emailmaker.modules` на странице |
|
|
284
|
-
| ~~**ESM по URL**~~ | **не поддерживается** | — |
|
|
285
|
-
|
|
286
|
-
**Почему `{ type: 'esm', url }` не работает.** В собранном ESM-плагине остаются имена подпутей
|
|
287
|
-
продукта (`@emailmaker/emailmaker/runtime/*`). Браузеру разрешать их нечем: карту импортов
|
|
288
|
-
продукт не выдаёт. Плагин в формате ESM подключают как npm-пакет, собирая вместе с хостом.
|
|
289
|
-
|
|
290
|
-
## Что приходит из продукта, а что собирается в плагин
|
|
291
|
-
|
|
292
|
-
| Зависимость | Откуда берётся | Почему так |
|
|
293
|
-
|---|---|---|
|
|
294
|
-
| `react`, `react-dom` | из продукта (`@emailmaker/emailmaker/runtime/react`) | один диспетчер хуков на страницу |
|
|
295
|
-
| `antd` | из продукта | контексты темы и формы общие |
|
|
296
|
-
| `@emailmaker/ui-kit` | из продукта (`@emailmaker/emailmaker/ui-kit`) | общий `ThemeProvider`, стили вставляются один раз |
|
|
297
|
-
| `@ant-design/icons` — **класс `AntdIcon`** | из продукта | читает `IconContext`; вторая копия ломает тему |
|
|
298
|
-
| `@ant-design/icons` — **каталог иконок** | собирается в плагин | каждый берёт только те иконки, что использует |
|
|
299
|
-
| всё остальное | собирается в плагин | к общему состоянию отношения не имеет |
|
|
300
|
-
|
|
301
|
-
## Как проверить, что всё сошлось
|
|
302
|
-
|
|
303
|
-
Сборка хоста сама скажет, если в граф попала вторая копия React или ui-kit: плагин хоста
|
|
304
|
-
(Vite/webpack) печатает предупреждение с именем файла-виновника и обоими путями. Молчание на сборке
|
|
305
|
-
— признак того, что копии сведены.
|
|
306
|
-
|
|
307
|
-
Плагин **на глобалах** при этом ничего не импортирует и в графе не появляется: он берёт зависимости
|
|
308
|
-
из реестра уже на странице, и проверять там нечего.
|
|
309
|
-
|
|
310
|
-
## Вход редактора тоже участвует
|
|
311
|
-
|
|
312
|
-
Редактор подключают двумя способами, и не с каждым работает ESM-плагин:
|
|
313
|
-
|
|
314
|
-
| Вход редактора | ESM-плагин | Плагин на глобалах |
|
|
315
|
-
|---|---|---|
|
|
316
|
-
| **ESM** (собирается вместе с хостом) | да | да |
|
|
317
|
-
| **UMD** (`<script>` на странице) | **нет** | да |
|
|
318
|
-
|
|
319
|
-
**Почему UMD-вход и ESM-плагин не сходятся.** UMD-вход несёт React внутри себя и объявляет его на
|
|
320
|
-
странице сам. ESM-плагин собирает ваш сборщик, и подпуть `@emailmaker/emailmaker/runtime/react`
|
|
321
|
-
он разрешает в копию внутри пакета. Это два разных файла с двумя диспетчерами хуков — тот самый
|
|
322
|
-
`Cannot read properties of null (reading 'useState')`, падающий вместе со всем интерфейсом.
|
|
323
|
-
|
|
324
|
-
Сборка про это молчать обязана: UMD-редактор подключён скриптом и в граф сборки хоста не входит, а
|
|
325
|
-
в момент сборки плагина ещё неизвестно, какой вход выберет хост. Поэтому **редактор говорит сам** —
|
|
326
|
-
при инициализации он сверяет копии и, найдя вторую, пишет в консоль, что нашёл и как это чинить.
|
|
327
|
-
|
|
328
|
-
Чинится любым из двух способов: собрать плагин **на глобалах** — тогда он возьмёт React из реестра
|
|
329
|
-
`window.emailmaker.modules` на странице, — либо подключить **ESM-вход** редактора и
|
|
330
|
-
собрать оба одним сборщиком.
|
|
331
|
-
|
|
332
|
-
## Что бывает, если собрать плагин без `PluginDev`
|
|
333
|
-
|
|
334
|
-
Плагин соберётся, сборка хоста пройдёт — и редактор упадёт на странице. Ровно этот случай:
|
|
335
|
-
|
|
336
|
-
- в плагине остались `import 'react'` и `import '@emailmaker/ui-kit'` как есть;
|
|
337
|
-
- сборщик хоста разрешил их из `node_modules` проекта — это **вторые** копии;
|
|
338
|
-
- редактор при этом работает на своих, вендоренных.
|
|
339
|
-
|
|
340
|
-
Лечится добавлением `PluginDev` в конфигурацию сборки плагина (`externals: 'esm'`) либо сборкой
|
|
341
|
-
плагина на глобалах.
|
|
342
|
-
|
|
343
|
-
## Ваши настройки резолва редактора не касаются
|
|
344
|
-
|
|
345
|
-
Внутри пакета React адресуется **путём** к копии, которая лежит в нём же, а не именем `react`.
|
|
346
|
-
Следствий два, и оба в вашу пользу:
|
|
347
|
-
|
|
348
|
-
- `resolve.dedupe`, `resolve.alias`, `resolve.modules` и Module Federation `shared` работают у вас
|
|
349
|
-
так, как вы их написали. Мы не занимаем имя `react` и ничего у вас не перехватываем.
|
|
350
|
-
- Редактор не зависит от того, что вы с этим именем делаете: своя копия достаётся ему при любой
|
|
351
|
-
конфигурации сборки, в том числе если наш плагин у вас не подключён.
|
|
352
|
-
|
|
353
|
-
Одно исключение — `sharedReact` ниже: им вы просите обратного.
|
|
354
|
-
|
|
355
|
-
## Общий React (необязательно)
|
|
356
|
-
|
|
357
|
-
Плагин хоста умеет обратное: отдать редактору **ваш** React вместо вендоренного —
|
|
358
|
-
`VitePlugin({ sharedReact: true })` или `new WebpackPlugin({ sharedReact: true })`.
|
|
359
|
-
|
|
360
|
-
| | по умолчанию | `sharedReact: true` |
|
|
361
|
-
|---|---|---|
|
|
362
|
-
| React редактора | свой, внутри пакета | ваш |
|
|
363
|
-
| требования к вашему React | нет | мажорная версия 19 |
|
|
364
|
-
| Strict Mode и dev-сборка React | не касаются редактора | касаются |
|
|
365
|
-
| antd | свой, внутри пакета | свой, внутри пакета |
|
|
366
|
-
| вес поставки | как есть | меньше примерно на 98 КБ gzip |
|
|
367
|
-
|
|
368
|
-
Версия проверяется до сборки: несовпадение мажора будет названо в предупреждении.
|
|
369
|
-
|
|
370
|
-
|
|
371
251
|
---
|
|
372
252
|
|
|
373
253
|
## 📂 PublicPath
|
|
@@ -564,17 +444,12 @@ emailmaker.init({
|
|
|
564
444
|
```ts
|
|
565
445
|
emailmaker.init({
|
|
566
446
|
plugins: [
|
|
447
|
+
{ type: 'esm', url: 'https://cdn.example.com/my-plugin.js' },
|
|
567
448
|
{ type: 'umd', url: 'https://cdn.example.com/my-plugin.umd.js', name: 'MyPlugin', resolve: 'registry' },
|
|
568
449
|
]
|
|
569
450
|
});
|
|
570
451
|
```
|
|
571
452
|
|
|
572
|
-
> **По URL работает `umd` с `resolve: 'registry'`.** Вариант `{ type: 'esm', url }` в браузере не
|
|
573
|
-
> поддерживается: в собранном ESM-плагине остаются имена подпутей продукта
|
|
574
|
-
> (`@emailmaker/emailmaker/runtime/*`), а разрешить их браузеру нечем — карту импортов
|
|
575
|
-
> продукт не выдаёт. ESM-плагин подключают как npm-пакет: способами 1 и 2 выше, собирая его вместе
|
|
576
|
-
> с хостом.
|
|
577
|
-
|
|
578
453
|
| Параметр | Описание |
|
|
579
454
|
|----------|----------|
|
|
580
455
|
| `type` | `'esm'` — ESM модуль (`import()`), `'umd'` — UMD/IIFE (`<script>`) |
|
|
@@ -582,30 +457,6 @@ emailmaker.init({
|
|
|
582
457
|
| `name` | Для `resolve: 'registry'` — строковый ключ из `PluginTypeMap`; для legacy `umd`/`window` — ключ в `window` |
|
|
583
458
|
| `resolve` | Опционально. `'module'` (default ESM), `'window'` (legacy default UMD), `'registry'` |
|
|
584
459
|
|
|
585
|
-
#### Кто готовит runtime до запуска скрипта
|
|
586
|
-
|
|
587
|
-
Плагин, собранный под `globals` (targets `встраиваемый bundle` и `advanced`), читает
|
|
588
|
-
`window.__emailmaker__.modules.Antd` **синхронно** — в момент, когда выполняется его скрипт.
|
|
589
|
-
До этого момента в реестре лежат ожидания: часть runtime приезжает по требованию, чтобы первый
|
|
590
|
-
экран не платил за то, чем не пользуется.
|
|
591
|
-
|
|
592
|
-
Если плагин подключён через `init({ plugins: [...] })` или `useAsync(...)`, делать ничего не
|
|
593
|
-
нужно: хост сам дожидается готовности runtime перед тем, как выполнить скрипт. Тормозится только
|
|
594
|
-
загрузка такого плагина, остальное приложение работает своим ходом.
|
|
595
|
-
|
|
596
|
-
Если же вы вставляете `<script>` с плагином сами, мимо API — дождитесь `preload()`:
|
|
597
|
-
|
|
598
|
-
```ts
|
|
599
|
-
import { preload } from '@emailmaker/emailmaker';
|
|
600
|
-
|
|
601
|
-
await preload();
|
|
602
|
-
document.head.appendChild(Object.assign(document.createElement('script'), {
|
|
603
|
-
src: 'https://cdn.example.com/my-plugin.umd.js',
|
|
604
|
-
}));
|
|
605
|
-
```
|
|
606
|
-
|
|
607
|
-
Плагинов на `esm` это не касается: их импорты разрешает сборщик, ждать им нечего.
|
|
608
|
-
|
|
609
460
|
### 4. Регистрация по имени (связь между плагинами)
|
|
610
461
|
|
|
611
462
|
Если плагин A должен обращаться к плагину B через `editor.use('PluginB')` — используйте `pluginRegistry.add`:
|
|
@@ -653,6 +504,10 @@ const myPlugin = await this.editor.useAsync(
|
|
|
653
504
|
() => import('my-plugin').then(m => m.MyPlugin)
|
|
654
505
|
);
|
|
655
506
|
|
|
507
|
+
const myPlugin = await this.editor.useAsync(
|
|
508
|
+
{ type: 'esm', url: '/plugins/analytics.js' }
|
|
509
|
+
);
|
|
510
|
+
|
|
656
511
|
const myPluginByKey = await this.editor.useAsync(
|
|
657
512
|
{ type: 'umd', url: '/plugins/my-plugin.umd.js', name: 'MyPlugin', resolve: 'registry' }
|
|
658
513
|
);
|
|
@@ -1165,7 +1020,7 @@ settingsPanel.showSettingsPanel({
|
|
|
1165
1020
|
|
|
1166
1021
|
### `--dev` / `--dev-packages`
|
|
1167
1022
|
|
|
1168
|
-
**Самый частый флаг для разработки:**
|
|
1023
|
+
**Самый частый флаг для разработки:** подставляет **dev**-версии внутренних npm-пакетов (`@emailmaker-internal/*`), которые в шаблонах задаются с dist-tag `dev` вместо `latest`. Используйте, когда нужны свежие предрелизные сборки экосистемы.
|
|
1169
1024
|
|
|
1170
1025
|
```bash
|
|
1171
1026
|
npx @emailmaker/cli my-plugin --kind plugin --preset advanced --bundler vite --target npm-package --dev --output-dir ./my-plugin
|
|
@@ -1281,18 +1136,6 @@ npm run start:release
|
|
|
1281
1136
|
- что release bundle собран под target `встраиваемый bundle`
|
|
1282
1137
|
- что sandbox и main bundle публикуются по ожидаемым URL
|
|
1283
1138
|
|
|
1284
|
-
### Плагин на `globals` падает: вместо `antd` приходит объект с `then`
|
|
1285
|
-
|
|
1286
|
-
Значит скрипт плагина выполнился раньше, чем хост подготовил реестр runtime. Часть runtime
|
|
1287
|
-
приезжает по требованию, и до этого момента в `window.__emailmaker__.modules` лежат
|
|
1288
|
-
ожидания, а не значения.
|
|
1289
|
-
|
|
1290
|
-
Проверьте:
|
|
1291
|
-
|
|
1292
|
-
- плагин подключён через `init({ plugins: [{ type, url, ... }] })` или `useAsync(...)` — тогда
|
|
1293
|
-
хост дожидается готовности сам;
|
|
1294
|
-
- если `<script>` вставляете вы, перед вставкой вызван `await preload()`.
|
|
1295
|
-
|
|
1296
1139
|
### Duplicate React / hooks error
|
|
1297
1140
|
|
|
1298
1141
|
Почти всегда это значит, что React попал в bundle плагина вместо runtime externals.
|
|
@@ -1319,7 +1162,7 @@ npm run start:release
|
|
|
1319
1162
|
## ❓ FAQ / Типичные ошибки
|
|
1320
1163
|
|
|
1321
1164
|
- **«Invalid hook call» или два React на странице**
|
|
1322
|
-
> Для обычного плагина используйте стандартные импорты `react` / `antd` и собирайте проект через `PluginDev` с `alias: true` (по умолчанию). Не смешивайте обычные импорты с прямыми импортами из runtime в одном
|
|
1165
|
+
> Для обычного плагина используйте стандартные импорты `react` / `antd` и собирайте проект через `PluginDev` с `alias: true` (по умолчанию). Не смешивайте обычные импорты с прямыми импортами из runtime в одном plugin UI.
|
|
1323
1166
|
|
|
1324
1167
|
- **Externals не работают в dev server**
|
|
1325
1168
|
> В serve-режиме externals должны быть отключены: `PluginDev({ externals: false })`. Зависимости резолвятся из runtime через alias.
|
package/package.json
CHANGED