esender-email-editor 1.2.1 → 1.3.1

package/README.md

@@ -11,10 +11,23 @@ A drag-and-drop **MJML email editor** for React 18 + Ant Design 5. The editor re
 The package is published on the public **npm registry**.
 
 ```bash
-npm install esender-email-editor --legacy-peer-deps
+npm install esender-email-editor
 ```
 
-> `--legacy-peer-deps` is required because `react-giphy-searchbox` (a transitive runtime dependency used by the Gif block) still declares an ancient `react@16.x` peer. The runtime works fine on React 18 — only the metadata is stale.
+> A transitive runtime dep (`react-giphy-searchbox`, used by the Gif block) still declares an ancient `react@16.x` peer. To keep npm install clean without `--legacy-peer-deps`, add the following `overrides` block to your **host app's** `package.json`. It pins the stale peer to your real React version — runtime is unaffected.
+>
+> ```json
+> {
+>   "overrides": {
+>     "react-giphy-searchbox": {
+>       "react": "$react",
+>       "react-dom": "$react-dom"
+>     }
+>   }
+> }
+> ```
+>
+> Yarn users: use `"resolutions"` with the same shape. pnpm users: use `"pnpm.overrides"`.
 
 ## Peer dependencies
 
@@ -25,12 +38,13 @@ npm install \
   react@^18 react-dom@^18 \
   antd@^5 @ant-design/icons@^5 @ant-design/pro-components@^2 \
   @reduxjs/toolkit@^2 react-redux@^9 redux-persist@^6 \
-  mjml-browser@^4 cheerio@1.0.0-rc.12 \
   lodash@^4 axios@^1 swr@^2 \
   framer-motion@^12 html2canvas@^1 \
   styled-components@^6 use-sync-external-store@^1
 ```
 
+> `mjml-browser` and `cheerio` are **bundled inside the published package** — you do **not** install them.
+
 ### Supported version ranges
 
 | Package | Declared range | Notes |
@@ -42,7 +56,6 @@ npm install \
 | `@reduxjs/toolkit` | `>=2.0.0 <3.0.0` | |
 | `react-redux` | `>=8.0.0 <10.0.0` | v8 and v9 both work under React 18. |
 | `redux-persist` | `>=6.0.0 <7.0.0` | |
-| `mjml-browser` | `>=4.15.0 <6.0.0` | v5 still requires `cheerio`. |
 | `lodash` | `>=4.17.0 <5.0.0` | |
 | `axios` | `>=1.0.0 <2.0.0` | |
 | `swr` | `>=2.0.0 <3.0.0` | |
@@ -50,7 +63,8 @@ npm install \
 | `html2canvas` | `>=1.0.0 <2.0.0` | |
 | `styled-components` | `>=5.0.0 <7.0.0` | v5 and v6 both work. |
 | `use-sync-external-store` | `>=1.0.0 <2.0.0` | |
-| `cheerio` | `1.0.0-rc.12` | Transitive of `mjml-browser`; host must install. Not declared as a peer. |
+| `mjml-browser` | bundled | Shipped inside `dist/`; host does not install. |
+| `cheerio` | bundled | Shipped inside `dist/` alongside `mjml-browser`; host does not install. |
 
 ### The non-negotiables
 
@@ -58,8 +72,7 @@ npm install \
 |---|---|
 | **React must be 18.x** (not 19) | antd v5 only officially supports React 16–18. Under React 19 you will see `[antd: compatible]` warnings and cascading hook bugs in dropdown / tooltip / message. |
 | **Single React copy** in `node_modules` | Two copies of React → `Invalid hook call`. Run `npm ls react` — it must show exactly one version. For Vite hosts use `resolve.dedupe`. |
-| **`cheerio@1.0.0-rc.12` must be installable** | `mjml-browser`'s UMD wrapper `require`s `cheerio`. Without it, `getHtml()` returns non-string and the canvas renders `errors: please check dev console`. Newer cheerio 1.x is ESM-only and breaks Vite's optimizer. |
-| **`@ant-design/icons` stays on v5** | `@ant-design/pro-components` resolves icons v5. Installing v6 forces `--legacy-peer-deps` everywhere and can cause runtime mismatches. |
+| **`@ant-design/icons` stays on v5** | `@ant-design/pro-components` resolves icons v5. Installing v6 can cause runtime mismatches. |
 
 ## Quick start
 
@@ -163,8 +176,6 @@ The editor does **not** mount its own `<ConfigProvider>` or antd `<App />`. It i
 
 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.
 
-If you want the editor branded purple like the default screenshots, wrap your host app in your own `<ConfigProvider theme={{ token: { colorPrimary: '#7747ff' } }}>` — the editor will inherit it.
-
 ## License handshake
 
 The editor will not render until the eSender license is verified:
@@ -219,7 +230,6 @@ export default defineConfig({
   optimizeDeps: {
     include: [
       'esender-email-editor',
-      'mjml-browser', 'cheerio',
       'antd', '@ant-design/icons', '@ant-design/pro-components',
       'react-is', 'react-redux',
       'use-sync-external-store',
@@ -279,7 +289,7 @@ import Package, {
 | Symptom | Cause / fix |
 |---|---|
 | `Invalid hook call` | Two copies of React are loaded. Run `npm ls react` — must show one version. Vite: add `resolve.dedupe`. |
-| Canvas shows `errors: please check dev console` | `cheerio` is not resolvable in the host. Install `cheerio@1.0.0-rc.12` (newer versions are ESM-only and break Vite). |
+| Canvas shows "Failed to render preview" | You're on an outdated version of the package. Update — current builds bundle `mjml-browser` + `cheerio` so this no longer requires a host install. |
 | Vite: `'classnames' does not provide an export named 'default'` | Vite hasn't pre-bundled antd's CJS transitive deps. Add the `optimizeDeps.include` list above, delete `node_modules/.vite`, and restart with `vite --force`. |
 | antd `[antd: compatible] React is 16 ~ 18` warning + broken dropdowns / tooltips | You are on React 19. Downgrade to React 18.3.1. |
 | Editor shows "Editor unavailable" forever | License verify failed. Check the `/license/verify` network response, confirm `apiKey`, watch `onLicenseError`. |
@@ -287,36 +297,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