@react-email/render 0.0.6 → 0.0.8

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,12 @@
1
+ interface Options {
2
+ pretty?: boolean;
3
+ plainText?: boolean;
4
+ }
5
+ declare const render: (component: React.ReactElement, options?: Options) => string;
6
+
7
+ declare const renderAsync: (component: React.ReactElement, options?: {
8
+ pretty?: boolean;
9
+ plainText?: boolean;
10
+ }) => Promise<string>;
11
+
12
+ export { Options, render, renderAsync };
package/dist/index.d.ts CHANGED
@@ -4,4 +4,9 @@ interface Options {
4
4
  }
5
5
  declare const render: (component: React.ReactElement, options?: Options) => string;
6
6
 
7
- export { Options, render };
7
+ declare const renderAsync: (component: React.ReactElement, options?: {
8
+ pretty?: boolean;
9
+ plainText?: boolean;
10
+ }) => Promise<string>;
11
+
12
+ export { Options, render, renderAsync };
package/dist/index.js CHANGED
@@ -5,6 +5,11 @@ var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
5
5
  var __getOwnPropNames = Object.getOwnPropertyNames;
6
6
  var __getProtoOf = Object.getPrototypeOf;
7
7
  var __hasOwnProp = Object.prototype.hasOwnProperty;
8
+ var __knownSymbol = (name, symbol) => {
9
+ if (symbol = Symbol[name])
10
+ return symbol;
11
+ throw Error("Symbol." + name + " is not defined");
12
+ };
8
13
  var __export = (target, all) => {
9
14
  for (var name in all)
10
15
  __defProp(target, name, { get: all[name], enumerable: true });
@@ -18,15 +23,41 @@ var __copyProps = (to, from, except, desc) => {
18
23
  return to;
19
24
  };
20
25
  var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
26
+ // If the importer is in node compatibility mode or this is not an ESM
27
+ // file that has been converted to a CommonJS file using a Babel-
28
+ // compatible transform (i.e. "__esModule" has not been set), then set
29
+ // "default" to the CommonJS "module.exports" for node compatibility.
21
30
  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
22
31
  mod
23
32
  ));
24
33
  var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
34
+ var __async = (__this, __arguments, generator) => {
35
+ return new Promise((resolve, reject) => {
36
+ var fulfilled = (value) => {
37
+ try {
38
+ step(generator.next(value));
39
+ } catch (e) {
40
+ reject(e);
41
+ }
42
+ };
43
+ var rejected = (value) => {
44
+ try {
45
+ step(generator.throw(value));
46
+ } catch (e) {
47
+ reject(e);
48
+ }
49
+ };
50
+ var step = (x) => x.done ? resolve(x.value) : Promise.resolve(x.value).then(fulfilled, rejected);
51
+ step((generator = generator.apply(__this, __arguments)).next());
52
+ });
53
+ };
54
+ var __forAwait = (obj, it, method) => (it = obj[__knownSymbol("asyncIterator")]) ? it.call(obj) : (obj = obj[__knownSymbol("iterator")](), it = {}, method = (key, fn) => (fn = obj[key]) && (it[key] = (arg) => new Promise((yes, no, done) => (arg = fn.call(obj, arg), done = arg.done, Promise.resolve(arg.value).then((value) => yes({ value, done }), no)))), method("next"), method("return"), it);
25
55
 
26
56
  // src/index.ts
27
57
  var src_exports = {};
28
58
  __export(src_exports, {
29
- render: () => render
59
+ render: () => render,
60
+ renderAsync: () => renderAsync
30
61
  });
31
62
  module.exports = __toCommonJS(src_exports);
32
63
 
@@ -54,7 +85,68 @@ var renderAsPlainText = (component, _options) => {
54
85
  ]
55
86
  });
56
87
  };
88
+
89
+ // src/render-async.ts
90
+ var import_html_to_text2 = require("html-to-text");
91
+ var import_pretty2 = __toESM(require("pretty"));
92
+ var import_server = __toESM(require("react-dom/server"));
93
+ var { renderToStaticMarkup: renderToStaticMarkup2 } = import_server.default;
94
+ var renderToStream = (
95
+ // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
96
+ import_server.default.renderToReadableStream || import_server.default.renderToPipeableStream
97
+ );
98
+ function renderToString(children) {
99
+ return __async(this, null, function* () {
100
+ const stream = yield renderToStream(children);
101
+ const html = yield readableStreamToString(
102
+ // ReactDOMServerReadableStream behaves like ReadableStream
103
+ // in modern edge runtimes but the types are not compatible
104
+ stream
105
+ );
106
+ return html.replace(/^<!DOCTYPE html>/, "").replace(/<!-- -->/g, "");
107
+ });
108
+ }
109
+ function readableStreamToString(readableStream) {
110
+ return __async(this, null, function* () {
111
+ let result = "";
112
+ const decoder = new TextDecoder();
113
+ try {
114
+ for (var iter = __forAwait(readableStream), more, temp, error; more = !(temp = yield iter.next()).done; more = false) {
115
+ const chunk = temp.value;
116
+ result += decoder.decode(chunk);
117
+ }
118
+ } catch (temp) {
119
+ error = [temp];
120
+ } finally {
121
+ try {
122
+ more && (temp = iter.return) && (yield temp.call(iter));
123
+ } finally {
124
+ if (error)
125
+ throw error[0];
126
+ }
127
+ }
128
+ return result;
129
+ });
130
+ }
131
+ var renderAsync = (component, options) => __async(void 0, null, function* () {
132
+ const markup = typeof renderToStaticMarkup2 === "undefined" ? yield renderToString(component) : renderToStaticMarkup2(component);
133
+ if (options == null ? void 0 : options.plainText) {
134
+ return (0, import_html_to_text2.convert)(markup, {
135
+ selectors: [
136
+ { selector: "img", format: "skip" },
137
+ { selector: "#__react-email-preview", format: "skip" }
138
+ ]
139
+ });
140
+ }
141
+ const doctype = '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">';
142
+ const document = `${doctype}${markup}`;
143
+ if (options == null ? void 0 : options.pretty) {
144
+ return (0, import_pretty2.default)(document);
145
+ }
146
+ return document;
147
+ });
57
148
  // Annotate the CommonJS export names for ESM import in node:
58
149
  0 && (module.exports = {
59
- render
150
+ render,
151
+ renderAsync
60
152
  });
package/dist/index.mjs CHANGED
@@ -1,3 +1,30 @@
1
+ var __knownSymbol = (name, symbol) => {
2
+ if (symbol = Symbol[name])
3
+ return symbol;
4
+ throw Error("Symbol." + name + " is not defined");
5
+ };
6
+ var __async = (__this, __arguments, generator) => {
7
+ return new Promise((resolve, reject) => {
8
+ var fulfilled = (value) => {
9
+ try {
10
+ step(generator.next(value));
11
+ } catch (e) {
12
+ reject(e);
13
+ }
14
+ };
15
+ var rejected = (value) => {
16
+ try {
17
+ step(generator.throw(value));
18
+ } catch (e) {
19
+ reject(e);
20
+ }
21
+ };
22
+ var step = (x) => x.done ? resolve(x.value) : Promise.resolve(x.value).then(fulfilled, rejected);
23
+ step((generator = generator.apply(__this, __arguments)).next());
24
+ });
25
+ };
26
+ var __forAwait = (obj, it, method) => (it = obj[__knownSymbol("asyncIterator")]) ? it.call(obj) : (obj = obj[__knownSymbol("iterator")](), it = {}, method = (key, fn) => (fn = obj[key]) && (it[key] = (arg) => new Promise((yes, no, done) => (arg = fn.call(obj, arg), done = arg.done, Promise.resolve(arg.value).then((value) => yes({ value, done }), no)))), method("next"), method("return"), it);
27
+
1
28
  // src/render.ts
2
29
  import * as ReactDomServer from "react-dom/server";
3
30
  import { convert } from "html-to-text";
@@ -22,6 +49,67 @@ var renderAsPlainText = (component, _options) => {
22
49
  ]
23
50
  });
24
51
  };
52
+
53
+ // src/render-async.ts
54
+ import { convert as convert2 } from "html-to-text";
55
+ import pretty2 from "pretty";
56
+ import react from "react-dom/server";
57
+ var { renderToStaticMarkup: renderToStaticMarkup2 } = react;
58
+ var renderToStream = (
59
+ // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
60
+ react.renderToReadableStream || react.renderToPipeableStream
61
+ );
62
+ function renderToString(children) {
63
+ return __async(this, null, function* () {
64
+ const stream = yield renderToStream(children);
65
+ const html = yield readableStreamToString(
66
+ // ReactDOMServerReadableStream behaves like ReadableStream
67
+ // in modern edge runtimes but the types are not compatible
68
+ stream
69
+ );
70
+ return html.replace(/^<!DOCTYPE html>/, "").replace(/<!-- -->/g, "");
71
+ });
72
+ }
73
+ function readableStreamToString(readableStream) {
74
+ return __async(this, null, function* () {
75
+ let result = "";
76
+ const decoder = new TextDecoder();
77
+ try {
78
+ for (var iter = __forAwait(readableStream), more, temp, error; more = !(temp = yield iter.next()).done; more = false) {
79
+ const chunk = temp.value;
80
+ result += decoder.decode(chunk);
81
+ }
82
+ } catch (temp) {
83
+ error = [temp];
84
+ } finally {
85
+ try {
86
+ more && (temp = iter.return) && (yield temp.call(iter));
87
+ } finally {
88
+ if (error)
89
+ throw error[0];
90
+ }
91
+ }
92
+ return result;
93
+ });
94
+ }
95
+ var renderAsync = (component, options) => __async(void 0, null, function* () {
96
+ const markup = typeof renderToStaticMarkup2 === "undefined" ? yield renderToString(component) : renderToStaticMarkup2(component);
97
+ if (options == null ? void 0 : options.plainText) {
98
+ return convert2(markup, {
99
+ selectors: [
100
+ { selector: "img", format: "skip" },
101
+ { selector: "#__react-email-preview", format: "skip" }
102
+ ]
103
+ });
104
+ }
105
+ const doctype = '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">';
106
+ const document = `${doctype}${markup}`;
107
+ if (options == null ? void 0 : options.pretty) {
108
+ return pretty2(document);
109
+ }
110
+ return document;
111
+ });
25
112
  export {
26
- render
113
+ render,
114
+ renderAsync
27
115
  };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@react-email/render",
3
- "version": "0.0.6",
3
+ "version": "0.0.8",
4
4
  "description": "Transform React components into HTML email templates",
5
5
  "sideEffects": false,
6
6
  "main": "./dist/index.js",
@@ -9,16 +9,26 @@
9
9
  "files": [
10
10
  "dist/**"
11
11
  ],
12
+ "exports": {
13
+ ".": {
14
+ "import": {
15
+ "types": "./dist/index.d.ts",
16
+ "default": "./dist/index.mjs"
17
+ },
18
+ "require": {
19
+ "types": "./dist/index.d.ts",
20
+ "default": "./dist/index.js"
21
+ }
22
+ }
23
+ },
12
24
  "license": "MIT",
13
25
  "scripts": {
14
26
  "build": "tsup src/index.ts --format esm,cjs --dts --external react",
15
- "dev": "tsup src/index.ts --format esm,cjs --dts --external react --watch",
16
- "lint": "eslint",
17
27
  "clean": "rm -rf dist",
18
- "test": "jest",
19
- "test:watch": "jest --watch",
20
- "format:check": "prettier --ignore-path ./../../.prettierignore --check \"**/*.{ts,tsx,md}\"",
21
- "format": "prettier --ignore-path ./../../.prettierignore --write \"**/*.{ts,tsx,md}\""
28
+ "dev": "tsup src/index.ts --format esm,cjs --dts --external react --watch",
29
+ "lint": "eslint .",
30
+ "test:watch": "vitest",
31
+ "test": "vitest run"
22
32
  },
23
33
  "repository": {
24
34
  "type": "git",
@@ -30,29 +40,21 @@
30
40
  "email"
31
41
  ],
32
42
  "engines": {
33
- "node": ">=16.0.0"
43
+ "node": ">=18.0.0"
34
44
  },
35
45
  "dependencies": {
36
- "html-to-text": "9.0.3",
46
+ "html-to-text": "9.0.5",
37
47
  "pretty": "2.0.0",
38
48
  "react": "18.2.0",
39
49
  "react-dom": "18.2.0"
40
50
  },
41
51
  "devDependencies": {
42
- "@babel/preset-react": "7.18.6",
43
- "@types/html-to-text": "9.0.0",
44
- "@types/jest": "28.1.7",
52
+ "@babel/preset-react": "7.22.5",
53
+ "@types/html-to-text": "9.0.1",
45
54
  "@types/pretty": "2.0.1",
46
- "@types/react": "18.0.20",
47
- "@types/react-dom": "18.0.6",
48
- "babel-jest": "28.1.3",
49
- "eslint": "8.23.1",
50
- "eslint-config-custom": "*",
51
- "jest": "28.1.3",
52
- "ts-jest": "28.0.8",
53
- "tsconfig": "*",
54
- "tsup": "6.2.3",
55
- "typescript": "4.8.3"
55
+ "eslint-config-custom": "workspace:*",
56
+ "tsconfig": "workspace:*",
57
+ "typescript": "5.1.6"
56
58
  },
57
59
  "publishConfig": {
58
60
  "access": "public"
package/readme.md CHANGED
@@ -32,8 +32,8 @@ npm install @react-email/render -E
32
32
  Convert React components into a HTML string.
33
33
 
34
34
  ```jsx
35
- import { MyTemplate } from '../components/MyTemplate';
36
- import { render } from '@react-email/render';
35
+ import { MyTemplate } from "../components/MyTemplate";
36
+ import { render } from "@react-email/render";
37
37
 
38
38
  const html = render(<MyTemplate firstName="Jim" />);
39
39
  ```