esender-email-editor 1.1.2 → 1.3.0

package/README.md

@@ -134,7 +134,8 @@ export const Composer = () => {
 |---|---|---|
 | `getJson()` | `string` | Stringified MJML JSON tree (export-ready). |
 | `getHtml()` | `string` | Compiled email HTML via `mjml-browser`. Triggers `onHtmlExport`. |
-| `loadJson(json, raw?)` | `void` | Load a previously saved template. `json` is the same string `getJson()` produced. Pass `null` to clear. |
+| `loadJson(json, raw?)` | `void` | Load a previously saved template. `json` accepts either the stringified output of `getJson()` or a deserialized object. Pass `null` to clear the canvas. |
+| `loadHtml(html)` | `void` | Load raw HTML into the editor. The HTML is wrapped in an MJML `mj-raw` block and rendered verbatim. The editor cannot break arbitrary HTML back into editable blocks — for full editability, prefer `loadJson` with a previously saved template. |
 | `saveTemplate({ projectId, templateId? })` | `Promise<TemplateApiResponse>` | Create or update a template. Omit `templateId` to create; include it to update. POSTs to `https://esender.in/api/license/template/create`. |
 | `loadTemplate({ projectId, templateId? })` | `Promise<TemplateApiResponse>` | GET from `https://esender.in/api/license/template/:projectId[/:templateId]` and pipe the JSON back into `loadJson(...)`. |
 
@@ -158,13 +159,9 @@ Callbacks are stored internally in a ref, so inline arrow functions are safe —
 
 ## Theme isolation
 
-The editor mounts its own `<ConfigProvider>` with the eSender primary color and uses an internal `getPopupContainer` so antd portals (Tooltip, Dropdown, Select, Drawer, Popover) render inside the editor's root rather than escaping to `document.body`. As a result:
+The editor does **not** mount its own `<ConfigProvider>` or antd `<App />`. It inherits the host application's antd theme, locale, and static-method context — nothing the editor renders will override your colors, components, or token configuration.
 
-- The editor will **not** restyle your host app's antd components.
-- Your host app's `<ConfigProvider theme={…}>` will **not** restyle the editor.
-- Antd's `message` / `notification` / `Modal.useApp` are scoped via `<App />` inside the editor.
-
-You can safely nest `<Package />` inside a host app that already uses antd with a different theme.
+All editor-specific CSS lives under a single `.aee-root` class scope (the wrapper div around the editor), so SCSS overrides and resets cannot reach host components either.
 
 ## License handshake
 
@@ -266,6 +263,12 @@ import Package, {
   type SaveEvent,
   type LoadEvent,
   type MediaUploadEvent,
+  // convenience aliases
+  type EditorInstance,        // = EditorHandle
+  type TemplateData,          // = TemplateDocument
+  type TemplateJson,          // shape of getJson()/loadJson() payload
+  type SaveTemplatePayload,   // = SaveTemplateOptions
+  type LoadTemplatePayload,   // = LoadTemplateOptions
 } from 'esender-email-editor';
 ```
 
@@ -282,36 +285,6 @@ import Package, {
 | `You cannot render a <Router> inside another <Router>` | You're on an outdated version. Update — current package uses `MemoryRouter` internally. |
 | Renders during SSR throw | Mount the component client-side only (see Next.js example above). |
 
-## Publishing (maintainers)
-
-```bash
-# 1. Bump version (semver)
-npm version patch  # or minor / major
-
-# 2. prepublishOnly chains: check-secrets → typecheck → rollup (clean + bundle + obfuscate + bundle check)
-npm publish
-```
-
-Pre-publish hooks:
-- `check-secrets` — scans for forbidden files (`.env`, `.pem`, `.key`) and provider-prefixed key strings (AWS / OpenAI / SendGrid / Google / GitHub / Slack / private-key blocks).
-- `typecheck` — `tsc --noEmit`.
-- `rollup` — produces `dist/index.js`, `dist/index.cjs`, `dist/index.d.ts`, `dist/styles.css`, then runs `scripts/obfuscate.js` and `scripts/check-bundle.js`.
-
-Inspect the publish tarball before pushing:
-
-```bash
-npm pack --dry-run
-```
-
-Only the contents of `dist/`, `README.md`, `LICENSE`, and `package.json` ship.
-
-## Versioning
-
-Strict semver:
-- **PATCH** — bug fixes, no API changes.
-- **MINOR** — additive features, no breakage.
-- **MAJOR** — breaking changes to `<Package />` props or `EditorHandle`.
-
 ## Author
 
 bitbeast private limited