@raypx-kit/email-preview 0.0.0-alpha.0

package/CHANGELOG.md

@@ -0,0 +1,13 @@
+# @raypx-kit/email-preview
+
+## 0.0.0-alpha.0
+
+Initial prerelease.
+
+- Add the `emailPreview()` Vite plugin with a prebuilt client-side interface.
+- Discover React Email TSX and JSX templates and render their `PreviewProps`.
+- Refresh previews when templates, imported sources or local assets change.
+- Inspect desktop/mobile layouts and copy or download HTML and plain text.
+- Show the HTML source indented by Prettier, with line numbers.
+- Reuse Kit UI primitives and persist light, dark or system theme preferences.
+- Verify the installed archive under Bun and Node with consumer-owned templates.

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Zack <heyloyep@gmail.com>
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,214 @@
+# @raypx-kit/email-preview
+
+A preview workspace for React Email templates, added to a Vite dev server as a
+plugin. Browse templates, inspect desktop
+and mobile layouts, and copy or download the rendered HTML and plain text. Saving
+a template, imported helper or local asset updates the preview automatically.
+
+## Install
+
+Install the preview and its peers in the project that owns your templates:
+
+```sh
+bun add -d @raypx-kit/email-preview@0.0.0-alpha.0 vite@^8
+bun add react@^19 react-dom@^19 @react-email/components
+```
+
+It supports Node 22.21+ and Bun. The interface is prebuilt into the package; your
+project does not build it or configure Tailwind for it.
+
+## Use with Vite
+
+Add the plugin to the Vite configuration of an existing app:
+
+```ts
+import { defineConfig } from "vite";
+import { emailPreview } from "@raypx-kit/email-preview";
+
+export default defineConfig({
+  plugins: [emailPreview({ dir: "src/emails" })],
+});
+```
+
+Run `vite` and open `/__email/` on the dev server, for example
+`http://localhost:5173/__email/`. Options:
+
+| Option            | Default    | Description                                                |
+| ----------------- | ---------- | ---------------------------------------------------------- |
+| `dir`             | `emails`   | Template directory, relative to the Vite root or absolute. |
+| `base`            | `/__email` | URL prefix for the interface and its API.                  |
+| `renderTimeoutMs` | `10000`    | Reports renders that do not settle within this time.       |
+
+The plugin applies to `vite dev` only; production builds never include templates
+or the interface. Templates are evaluated in a dedicated Vite environment with its
+own module graph, so previews do not load into or invalidate the application's
+server rendering. They use the project's React, dependencies and Vite resolution,
+including its aliases: enable `resolve.tsconfigPaths` in the host configuration when
+templates import tsconfig path aliases. The interface follows the dev server's
+`server.host` and `server.allowedHosts`. Paths below `base` that the preview does
+not serve continue to the host app, so `base: "/"` suits a dev server dedicated to
+previews.
+
+## Preview without an app
+
+A project that only owns templates needs a small Vite configuration of its own.
+`base: "/"` serves the preview at the server root:
+
+```ts
+// vite.config.ts
+import { defineConfig } from "vite";
+import { emailPreview } from "@raypx-kit/email-preview";
+
+export default defineConfig({
+  resolve: { tsconfigPaths: true },
+  server: { host: "127.0.0.1", port: 3001 },
+  plugins: [emailPreview({ dir: "emails", base: "/" })],
+});
+```
+
+```json
+{
+  "scripts": {
+    "email:dev": "vite dev"
+  }
+}
+```
+
+Run `bun run email:dev` and open `http://127.0.0.1:3001`. Vite reports an occupied
+port or invalid configuration as usual; a missing template directory shows an
+empty library until you create it.
+
+## Template contract
+
+Export a React component as the default export of a `.tsx` or `.jsx` file. Attach
+sample data to that component's `PreviewProps` property:
+
+```tsx
+import { Body, Container, Heading, Html, Text } from "@react-email/components";
+
+type WelcomeProps = { name: string };
+
+export default function Welcome({ name }: WelcomeProps) {
+  return (
+    <Html>
+      <Body>
+        <Container>
+          <Heading>Welcome, {name}</Heading>
+          <Text>Your workspace is ready.</Text>
+        </Container>
+      </Body>
+    </Html>
+  );
+}
+
+Welcome.PreviewProps = { name: "Alex" } satisfies WelcomeProps;
+```
+
+Templates without `PreviewProps` receive an empty props object. Keep imports,
+components and data in your own project. React 19 and React DOM 19 are peer
+dependencies and must be compatible with each other. If you install them while the
+preview runs, the next render picks them up. Imported packages resolve from the
+consumer project.
+
+Nested directories appear in the template list. Hidden entries, names starting
+with `_`, and the `static` directory are excluded from template discovery:
+
+```text
+emails/
+  welcome.tsx
+  account/
+    password-reset.jsx
+  _components/
+    footer.tsx
+  static/
+    logo.svg
+```
+
+Serve local assets from `emails/static` and reference them as `/static/logo.svg`.
+These URLs work in the local preview, including below a plugin prefix such as
+`/__email/`; copied and downloaded HTML keeps the original URLs. Before sending exported email HTML through
+your own delivery service, use absolute publicly accessible asset URLs.
+
+## Preview workflow
+
+- Select a template from the searchable list. The selection stays in the URL so
+  you can return to a specific preview.
+- Switch between desktop and mobile widths to inspect responsive email markup.
+- Choose light, dark or system appearance. The preference persists between visits.
+- Open HTML or plain text to inspect, copy or download the rendered content.
+- HTML is indented with Prettier and shown with line numbers. Formatting affects
+  the source view only; the visual preview, clipboard and downloads keep the
+  original rendered HTML.
+
+- Save a template or imported source file to refresh its output. Creating or
+  removing templates also updates the list.
+- Fix compilation or rendering errors in your editor; the preview recovers when
+  you save. Errors do not prevent browsing other templates.
+
+The interface is a client-side TanStack Router application using the Base UI/shadcn
+primitives from `@raypx-kit/ui` and theme tokens and preferences from
+`@raypx-kit/themes`. These are prebuilt into the package; template projects do not
+install these workspace packages.
+
+The preview executes trusted local template code with the permissions of the
+dev server process. A render that never settles is reported after
+`renderTimeoutMs`, but a synchronous infinite loop blocks the dev server until you
+fix the template and restart it. It is a development tool without deployment,
+authentication or email delivery commands. Browser preview widths help inspect
+layouts; they do not emulate individual email clients.
+
+## Package interface and development
+
+The public interface is the `emailPreview()` Vite plugin exported from the package
+root. There is no command-line tool or public JavaScript rendering API. The
+[Vite plugin design](../../docs/email-preview/vite-plugin.md) records the
+architecture and its remaining isolation work.
+
+Repository examples live in [examples](examples), including a TSX welcome email,
+a JSX password reset email, a local SVG asset and the `vite.config.ts` that previews
+them. From the repository root:
+
+```sh
+bun run --cwd packages/email-preview dev
+```
+
+Tests cover discovery, rendering, live updates and HTTP behavior. The repository's
+archive checks install the actual package outside the workspace and run `vite dev`
+with the plugin under Bun and Node, including consumer dependencies and shared
+imports.
+See the [development guide](../../docs/development/README.md) for repository checks.
+
+## Licenses
+
+[LICENSE](LICENSE) contains this package's Apache-2.0 terms. The prebuilt application
+includes third-party code, including React, TanStack Router and the shared UI
+and theme packages. Its complete licenses, copyright statements and source notices
+are generated from build inputs into `dist/THIRD_PARTY_LICENSES.txt` and included in
+the npm archive. Generated build notices are not committed to Git.
+
+The direct external runtime dependencies below remain separate npm packages with
+their own license files. This index records installed versions and links to their
+licenses without copying the texts. Transitive dependencies retain their notices
+in their respective packages. Run `bun run licenses:update` after dependency
+changes; `bun run licenses:check` checks this index without requiring build output.
+
+<!-- BEGIN GENERATED DEPENDENCY LICENSE INDEX -->
+
+| Package             | Installed version | License | License text                                                            |
+| ------------------- | ----------------- | ------- | ----------------------------------------------------------------------- |
+| @react-email/render | 2.1.1             | MIT     | [license.md](https://unpkg.com/@react-email/render@2.1.1/license.md)    |
+| prettier            | 3.9.10            | MIT     | [LICENSE](https://unpkg.com/prettier@3.9.10/LICENSE)                    |
+| react               | 19.3.1            | MIT     | [LICENSE](https://unpkg.com/react@19.3.1/LICENSE)                       |
+| react-dom           | 19.3.1            | MIT     | [LICENSE](https://unpkg.com/react-dom@19.3.1/LICENSE)                   |
+| vite                | 1.3.0             | MIT     | [LICENSE](https://unpkg.com/@voidzero-dev/vite-plus-core@1.3.0/LICENSE) |
+
+<!-- END GENERATED DEPENDENCY LICENSE INDEX -->
+
+## Browser E2E
+
+The built plugin in a Vite server, navigation, sandbox previews, source actions and live template recovery.
+
+Run `bun run test:e2e:install` once at the repository root, then
+`bun run --cwd packages/email-preview test:e2e`. The package owns its scenarios in
+`e2e/`; see the [browser test guide](../../docs/development/README.md#browser-e2e-by-workspace)
+for project selection, reports and CI behavior.