@react-email/render 1.0.2 → 1.0.3-alpha-f49712983-20241115

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.
@@ -0,0 +1,27 @@
1
+ import { HtmlToTextOptions, SelectorDefinition } from 'html-to-text';
2
+
3
+ type Options = {
4
+ pretty?: boolean;
5
+ } & ({
6
+ plainText?: false;
7
+ } | {
8
+ plainText?: true;
9
+ /**
10
+ * These are options you can pass down directly to the library we use for
11
+ * converting the rendered email's HTML into plain text.
12
+ *
13
+ * @see https://github.com/html-to-text/node-html-to-text
14
+ */
15
+ htmlToTextOptions?: HtmlToTextOptions;
16
+ });
17
+
18
+ declare const render: (element: React.ReactElement, options?: Options) => Promise<string>;
19
+
20
+ /**
21
+ * @deprecated use `render`
22
+ */
23
+ declare const renderAsync: (element: React.ReactElement, options?: Options) => Promise<string>;
24
+
25
+ declare const plainTextSelectors: SelectorDefinition[];
26
+
27
+ export { Options, plainTextSelectors, render, renderAsync };
@@ -0,0 +1,27 @@
1
+ import { HtmlToTextOptions, SelectorDefinition } from 'html-to-text';
2
+
3
+ type Options = {
4
+ pretty?: boolean;
5
+ } & ({
6
+ plainText?: false;
7
+ } | {
8
+ plainText?: true;
9
+ /**
10
+ * These are options you can pass down directly to the library we use for
11
+ * converting the rendered email's HTML into plain text.
12
+ *
13
+ * @see https://github.com/html-to-text/node-html-to-text
14
+ */
15
+ htmlToTextOptions?: HtmlToTextOptions;
16
+ });
17
+
18
+ declare const render: (element: React.ReactElement, options?: Options) => Promise<string>;
19
+
20
+ /**
21
+ * @deprecated use `render`
22
+ */
23
+ declare const renderAsync: (element: React.ReactElement, options?: Options) => Promise<string>;
24
+
25
+ declare const plainTextSelectors: SelectorDefinition[];
26
+
27
+ export { Options, plainTextSelectors, render, renderAsync };
package/dist/index.js ADDED
@@ -0,0 +1,144 @@
1
+ "use strict";
2
+ var __create = Object.create;
3
+ var __defProp = Object.defineProperty;
4
+ var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
5
+ var __getOwnPropNames = Object.getOwnPropertyNames;
6
+ var __getOwnPropSymbols = Object.getOwnPropertySymbols;
7
+ var __getProtoOf = Object.getPrototypeOf;
8
+ var __hasOwnProp = Object.prototype.hasOwnProperty;
9
+ var __propIsEnum = Object.prototype.propertyIsEnumerable;
10
+ var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
11
+ var __spreadValues = (a, b) => {
12
+ for (var prop in b || (b = {}))
13
+ if (__hasOwnProp.call(b, prop))
14
+ __defNormalProp(a, prop, b[prop]);
15
+ if (__getOwnPropSymbols)
16
+ for (var prop of __getOwnPropSymbols(b)) {
17
+ if (__propIsEnum.call(b, prop))
18
+ __defNormalProp(a, prop, b[prop]);
19
+ }
20
+ return a;
21
+ };
22
+ var __export = (target, all) => {
23
+ for (var name in all)
24
+ __defProp(target, name, { get: all[name], enumerable: true });
25
+ };
26
+ var __copyProps = (to, from, except, desc) => {
27
+ if (from && typeof from === "object" || typeof from === "function") {
28
+ for (let key of __getOwnPropNames(from))
29
+ if (!__hasOwnProp.call(to, key) && key !== except)
30
+ __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
31
+ }
32
+ return to;
33
+ };
34
+ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
35
+ // If the importer is in node compatibility mode or this is not an ESM
36
+ // file that has been converted to a CommonJS file using a Babel-
37
+ // compatible transform (i.e. "__esModule" has not been set), then set
38
+ // "default" to the CommonJS "module.exports" for node compatibility.
39
+ isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
40
+ mod
41
+ ));
42
+ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
43
+ var __async = (__this, __arguments, generator) => {
44
+ return new Promise((resolve, reject) => {
45
+ var fulfilled = (value) => {
46
+ try {
47
+ step(generator.next(value));
48
+ } catch (e) {
49
+ reject(e);
50
+ }
51
+ };
52
+ var rejected = (value) => {
53
+ try {
54
+ step(generator.throw(value));
55
+ } catch (e) {
56
+ reject(e);
57
+ }
58
+ };
59
+ var step = (x) => x.done ? resolve(x.value) : Promise.resolve(x.value).then(fulfilled, rejected);
60
+ step((generator = generator.apply(__this, __arguments)).next());
61
+ });
62
+ };
63
+
64
+ // src/index.ts
65
+ var src_exports = {};
66
+ __export(src_exports, {
67
+ plainTextSelectors: () => plainTextSelectors,
68
+ render: () => render,
69
+ renderAsync: () => renderAsync
70
+ });
71
+ module.exports = __toCommonJS(src_exports);
72
+
73
+ // src/render.tsx
74
+ var import_html_to_text = require("html-to-text");
75
+ var import_react_markup = require("react-markup");
76
+ var import_react = require("react");
77
+
78
+ // src/shared/utils/pretty.ts
79
+ var import_js_beautify = __toESM(require("js-beautify"));
80
+ var defaults = {
81
+ unformatted: ["code", "pre", "em", "strong", "span"],
82
+ indent_inner_html: true,
83
+ indent_char: " ",
84
+ indent_size: 2,
85
+ sep: "\n"
86
+ };
87
+ var pretty = (str, options = {}) => {
88
+ return import_js_beautify.default.html(str, __spreadValues(__spreadValues({}, defaults), options));
89
+ };
90
+
91
+ // src/shared/plain-text-selectors.ts
92
+ var plainTextSelectors = [
93
+ { selector: "img", format: "skip" },
94
+ { selector: "#__react-email-preview", format: "skip" },
95
+ {
96
+ selector: "a",
97
+ options: { linkBrackets: false }
98
+ }
99
+ ];
100
+
101
+ // src/render.tsx
102
+ var import_jsx_runtime = require("react/jsx-runtime");
103
+ var render = (element, options) => __async(void 0, null, function* () {
104
+ const suspendedElement = /* @__PURE__ */ (0, import_jsx_runtime.jsx)(import_react.Suspense, { children: element });
105
+ const html = yield (0, import_react_markup.experimental_renderToHTML)(suspendedElement);
106
+ if (options == null ? void 0 : options.plainText) {
107
+ return (0, import_html_to_text.convert)(html, __spreadValues({
108
+ selectors: plainTextSelectors
109
+ }, options.htmlToTextOptions));
110
+ }
111
+ const doctype = '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">';
112
+ const document = `${doctype}${html.replace(/<!DOCTYPE.*?>/, "")}`;
113
+ if (options == null ? void 0 : options.pretty) {
114
+ return pretty(document);
115
+ }
116
+ return document;
117
+ });
118
+
119
+ // src/render-async.tsx
120
+ var import_html_to_text2 = require("html-to-text");
121
+ var import_react2 = require("react");
122
+ var import_react_markup2 = require("react-markup");
123
+ var import_jsx_runtime2 = require("react/jsx-runtime");
124
+ var renderAsync = (element, options) => __async(void 0, null, function* () {
125
+ const suspendedElement = /* @__PURE__ */ (0, import_jsx_runtime2.jsx)(import_react2.Suspense, { children: element });
126
+ const html = yield (0, import_react_markup2.experimental_renderToHTML)(suspendedElement);
127
+ if (options == null ? void 0 : options.plainText) {
128
+ return (0, import_html_to_text2.convert)(html, __spreadValues({
129
+ selectors: plainTextSelectors
130
+ }, options.htmlToTextOptions));
131
+ }
132
+ const doctype = '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">';
133
+ const document = `${doctype}${html.replace(/<!DOCTYPE.*?>/, "")}`;
134
+ if (options == null ? void 0 : options.pretty) {
135
+ return pretty(document);
136
+ }
137
+ return document;
138
+ });
139
+ // Annotate the CommonJS export names for ESM import in node:
140
+ 0 && (module.exports = {
141
+ plainTextSelectors,
142
+ render,
143
+ renderAsync
144
+ });
package/dist/index.mjs ADDED
@@ -0,0 +1,108 @@
1
+ var __defProp = Object.defineProperty;
2
+ var __getOwnPropSymbols = Object.getOwnPropertySymbols;
3
+ var __hasOwnProp = Object.prototype.hasOwnProperty;
4
+ var __propIsEnum = Object.prototype.propertyIsEnumerable;
5
+ var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
6
+ var __spreadValues = (a, b) => {
7
+ for (var prop in b || (b = {}))
8
+ if (__hasOwnProp.call(b, prop))
9
+ __defNormalProp(a, prop, b[prop]);
10
+ if (__getOwnPropSymbols)
11
+ for (var prop of __getOwnPropSymbols(b)) {
12
+ if (__propIsEnum.call(b, prop))
13
+ __defNormalProp(a, prop, b[prop]);
14
+ }
15
+ return a;
16
+ };
17
+ var __async = (__this, __arguments, generator) => {
18
+ return new Promise((resolve, reject) => {
19
+ var fulfilled = (value) => {
20
+ try {
21
+ step(generator.next(value));
22
+ } catch (e) {
23
+ reject(e);
24
+ }
25
+ };
26
+ var rejected = (value) => {
27
+ try {
28
+ step(generator.throw(value));
29
+ } catch (e) {
30
+ reject(e);
31
+ }
32
+ };
33
+ var step = (x) => x.done ? resolve(x.value) : Promise.resolve(x.value).then(fulfilled, rejected);
34
+ step((generator = generator.apply(__this, __arguments)).next());
35
+ });
36
+ };
37
+
38
+ // src/render.tsx
39
+ import { convert } from "html-to-text";
40
+ import { experimental_renderToHTML as renderToHTML } from "react-markup";
41
+ import { Suspense } from "react";
42
+
43
+ // src/shared/utils/pretty.ts
44
+ import jsBeautify from "js-beautify";
45
+ var defaults = {
46
+ unformatted: ["code", "pre", "em", "strong", "span"],
47
+ indent_inner_html: true,
48
+ indent_char: " ",
49
+ indent_size: 2,
50
+ sep: "\n"
51
+ };
52
+ var pretty = (str, options = {}) => {
53
+ return jsBeautify.html(str, __spreadValues(__spreadValues({}, defaults), options));
54
+ };
55
+
56
+ // src/shared/plain-text-selectors.ts
57
+ var plainTextSelectors = [
58
+ { selector: "img", format: "skip" },
59
+ { selector: "#__react-email-preview", format: "skip" },
60
+ {
61
+ selector: "a",
62
+ options: { linkBrackets: false }
63
+ }
64
+ ];
65
+
66
+ // src/render.tsx
67
+ import { jsx } from "react/jsx-runtime";
68
+ var render = (element, options) => __async(void 0, null, function* () {
69
+ const suspendedElement = /* @__PURE__ */ jsx(Suspense, { children: element });
70
+ const html = yield renderToHTML(suspendedElement);
71
+ if (options == null ? void 0 : options.plainText) {
72
+ return convert(html, __spreadValues({
73
+ selectors: plainTextSelectors
74
+ }, options.htmlToTextOptions));
75
+ }
76
+ const doctype = '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">';
77
+ const document = `${doctype}${html.replace(/<!DOCTYPE.*?>/, "")}`;
78
+ if (options == null ? void 0 : options.pretty) {
79
+ return pretty(document);
80
+ }
81
+ return document;
82
+ });
83
+
84
+ // src/render-async.tsx
85
+ import { convert as convert2 } from "html-to-text";
86
+ import { Suspense as Suspense2 } from "react";
87
+ import { experimental_renderToHTML as renderToHTML2 } from "react-markup";
88
+ import { jsx as jsx2 } from "react/jsx-runtime";
89
+ var renderAsync = (element, options) => __async(void 0, null, function* () {
90
+ const suspendedElement = /* @__PURE__ */ jsx2(Suspense2, { children: element });
91
+ const html = yield renderToHTML2(suspendedElement);
92
+ if (options == null ? void 0 : options.plainText) {
93
+ return convert2(html, __spreadValues({
94
+ selectors: plainTextSelectors
95
+ }, options.htmlToTextOptions));
96
+ }
97
+ const doctype = '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">';
98
+ const document = `${doctype}${html.replace(/<!DOCTYPE.*?>/, "")}`;
99
+ if (options == null ? void 0 : options.pretty) {
100
+ return pretty(document);
101
+ }
102
+ return document;
103
+ });
104
+ export {
105
+ plainTextSelectors,
106
+ render,
107
+ renderAsync
108
+ };
package/package.json CHANGED
@@ -1,65 +1,23 @@
1
1
  {
2
2
  "name": "@react-email/render",
3
- "version": "1.0.2",
3
+ "version": "1.0.3-alpha-f49712983-20241115",
4
4
  "description": "Transform React components into HTML email templates",
5
5
  "sideEffects": false,
6
- "main": "./dist/browser/index.js",
7
- "module": "./dist/browser/index.mjs",
8
- "types": "./dist/browser/index.d.ts",
6
+ "main": "./dist/index.js",
7
+ "module": "./dist/index.mjs",
8
+ "types": "./dist/index.d.ts",
9
9
  "files": [
10
10
  "dist/**"
11
11
  ],
12
12
  "exports": {
13
- ".": {
14
- "node": {
15
- "import": {
16
- "types": "./dist/node/index.d.mts",
17
- "default": "./dist/node/index.mjs"
18
- },
19
- "require": {
20
- "types": "./dist/node/index.d.ts",
21
- "default": "./dist/node/index.js"
22
- }
13
+ "default": {
14
+ "import": {
15
+ "types": "./dist/index.d.mts",
16
+ "default": "./dist/index.mjs"
23
17
  },
24
- "deno": {
25
- "import": {
26
- "types": "./dist/browser/index.d.mts",
27
- "default": "./dist/browser/index.mjs"
28
- },
29
- "require": {
30
- "types": "./dist/browser/index.d.ts",
31
- "default": "./dist/browser/index.js"
32
- }
33
- },
34
- "worker": {
35
- "import": {
36
- "types": "./dist/browser/index.d.mts",
37
- "default": "./dist/browser/index.mjs"
38
- },
39
- "require": {
40
- "types": "./dist/browser/index.d.ts",
41
- "default": "./dist/browser/index.js"
42
- }
43
- },
44
- "browser": {
45
- "import": {
46
- "types": "./dist/browser/index.d.mts",
47
- "default": "./dist/browser/index.mjs"
48
- },
49
- "require": {
50
- "types": "./dist/browser/index.d.ts",
51
- "default": "./dist/browser/index.js"
52
- }
53
- },
54
- "default": {
55
- "import": {
56
- "types": "./dist/node/index.d.mts",
57
- "default": "./dist/node/index.mjs"
58
- },
59
- "require": {
60
- "types": "./dist/node/index.d.ts",
61
- "default": "./dist/node/index.js"
62
- }
18
+ "require": {
19
+ "types": "./dist/index.d.ts",
20
+ "default": "./dist/index.js"
63
21
  }
64
22
  }
65
23
  },
@@ -79,18 +37,16 @@
79
37
  "dependencies": {
80
38
  "html-to-text": "9.0.5",
81
39
  "js-beautify": "^1.14.11",
82
- "react-promise-suspense": "0.3.4"
83
- },
84
- "peerDependencies": {
85
40
  "react": "^18.0 || ^19.0 || ^19.0.0-rc",
86
- "react-dom": "^18.0 || ^19.0 || ^19.0.0-rc"
41
+ "react-markup": "0.0.0-experimental-b01722d5-20241114",
42
+ "react-promise-suspense": "0.3.4"
87
43
  },
88
44
  "devDependencies": {
89
- "@types/react": "npm:types-react@19.0.0-rc.1",
90
- "@types/react-dom": "npm:types-react-dom@19.0.0-rc.1",
91
45
  "@edge-runtime/vm": "3.1.8",
92
46
  "@types/html-to-text": "9.0.4",
93
47
  "@types/js-beautify": "1.14.3",
48
+ "@types/react": "npm:types-react@19.0.0-rc.1",
49
+ "@types/react-dom": "npm:types-react-dom@19.0.0-rc.1",
94
50
  "jsdom": "23.0.1",
95
51
  "tsup": "7.2.0",
96
52
  "typescript": "5.1.6",