├── .github
├── assets
│ ├── reactables-diagram.png
│ └── reactables-wasm.png
└── workflows
│ ├── core-reactable.yml
│ └── release.yml
├── .gitignore
├── LICENSE
├── README.md
├── esbuild.js
├── examples
├── render.cs
├── render.ex
├── render.go
├── render.java
├── render.js
├── render.py
└── render.rb
├── package-lock.json
├── package.json
├── shrinkwrap.sh
├── src
├── index.d.ts
├── index.jsx
└── prelude.js
└── test2.json
/.github/assets/reactables-diagram.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/dylibso/reactables/bf6c64cd043fb9083f880267961105baa4a251a4/.github/assets/reactables-diagram.png
--------------------------------------------------------------------------------
/.github/assets/reactables-wasm.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/dylibso/reactables/bf6c64cd043fb9083f880267961105baa4a251a4/.github/assets/reactables-wasm.png
--------------------------------------------------------------------------------
/.github/workflows/core-reactable.yml:
--------------------------------------------------------------------------------
1 | name: build-reactables-core
2 | run-name: ${{ github.actor }} is building the core reactable
3 | on:
4 | workflow_dispatch:
5 |
6 | jobs:
7 | get-extism:
8 | runs-on: ubuntu-latest
9 | env:
10 | TAG: v1.0.0-rc3
11 | steps:
12 | - uses: actions/checkout@v4
13 |
14 | - name: Setup wasm-merge and wasm-opt
15 | run: |
16 | curl -L https://github.com/WebAssembly/binaryen/releases/download/version_116/binaryen-version_116-x86_64-linux.tar.gz > binaryen.tar.gz
17 | tar xvzf binaryen.tar.gz
18 | sudo cp binaryen-version_116/bin/wasm-merge /usr/local/bin
19 | sudo cp binaryen-version_116/bin/wasm-opt /usr/local/bin
20 | # test it out
21 | wasm-merge
22 |
23 | - name: Setup Extism JS-PDK
24 | run: |
25 | curl -L -O "https://github.com/extism/js-pdk/releases/download/$TAG/extism-js-x86_64-linux-$TAG.gz"
26 | gunzip extism-js*.gz
27 | sudo mv extism-js-* /usr/local/bin/extism-js
28 | chmod +x /usr/local/bin/extism-js
29 | extism-js
30 |
--------------------------------------------------------------------------------
/.github/workflows/release.yml:
--------------------------------------------------------------------------------
1 | on:
2 | workflow_dispatch:
3 | release:
4 | types: [created]
5 |
6 | jobs:
7 | release:
8 | env:
9 | EXTISM_JS_TAG: v1.0.0-rc3
10 | name: Build and Release Reactables
11 | runs-on: ubuntu-latest
12 | steps:
13 | - name: Checkout
14 | uses: actions/checkout@v3
15 |
16 | - name: Setup wasm-merge
17 | run: |
18 | curl -L https://github.com/WebAssembly/binaryen/releases/download/version_116/binaryen-version_116-x86_64-linux.tar.gz > binaryen.tar.gz
19 | tar xvzf binaryen.tar.gz
20 | sudo cp binaryen-version_116/bin/wasm-merge /usr/local/bin
21 | sudo cp binaryen-version_116/bin/wasm-opt /usr/local/bin
22 | wasm-merge --version
23 |
24 | - name: Setup Extism JS-PDK
25 | run: |
26 | curl -L -O "https://github.com/extism/js-pdk/releases/download/$EXTISM_JS_TAG/extism-js-x86_64-linux-$EXTISM_JS_TAG.gz"
27 | gunzip extism-js*.gz
28 | sudo mv extism-js-* /usr/local/bin/extism-js
29 | chmod +x /usr/local/bin/extism-js
30 | extism-js --version
31 |
32 | - name: Build
33 | run: |
34 | npm i
35 | npm run build
36 | cp dist/plugin.wasm ./reactable.core.wasm
37 |
38 | - name: Upload Artifact to Release
39 | uses: softprops/action-gh-release@v1
40 | with:
41 | if-no-files-found: error
42 | files: |
43 | *.wasm
44 | if: startsWith(github.ref, 'refs/tags/')
45 |
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | node_modules
2 | dist
3 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | Apache License
2 | Version 2.0, January 2004
3 | http://www.apache.org/licenses/
4 |
5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6 |
7 | 1. Definitions.
8 |
9 | "License" shall mean the terms and conditions for use, reproduction,
10 | and distribution as defined by Sections 1 through 9 of this document.
11 |
12 | "Licensor" shall mean the copyright owner or entity authorized by
13 | the copyright owner that is granting the License.
14 |
15 | "Legal Entity" shall mean the union of the acting entity and all
16 | other entities that control, are controlled by, or are under common
17 | control with that entity. For the purposes of this definition,
18 | "control" means (i) the power, direct or indirect, to cause the
19 | direction or management of such entity, whether by contract or
20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the
21 | outstanding shares, or (iii) beneficial ownership of such entity.
22 |
23 | "You" (or "Your") shall mean an individual or Legal Entity
24 | exercising permissions granted by this License.
25 |
26 | "Source" form shall mean the preferred form for making modifications,
27 | including but not limited to software source code, documentation
28 | source, and configuration files.
29 |
30 | "Object" form shall mean any form resulting from mechanical
31 | transformation or translation of a Source form, including but
32 | not limited to compiled object code, generated documentation,
33 | and conversions to other media types.
34 |
35 | "Work" shall mean the work of authorship, whether in Source or
36 | Object form, made available under the License, as indicated by a
37 | copyright notice that is included in or attached to the work
38 | (an example is provided in the Appendix below).
39 |
40 | "Derivative Works" shall mean any work, whether in Source or Object
41 | form, that is based on (or derived from) the Work and for which the
42 | editorial revisions, annotations, elaborations, or other modifications
43 | represent, as a whole, an original work of authorship. For the purposes
44 | of this License, Derivative Works shall not include works that remain
45 | separable from, or merely link (or bind by name) to the interfaces of,
46 | the Work and Derivative Works thereof.
47 |
48 | "Contribution" shall mean any work of authorship, including
49 | the original version of the Work and any modifications or additions
50 | to that Work or Derivative Works thereof, that is intentionally
51 | submitted to Licensor for inclusion in the Work by the copyright owner
52 | or by an individual or Legal Entity authorized to submit on behalf of
53 | the copyright owner. For the purposes of this definition, "submitted"
54 | means any form of electronic, verbal, or written communication sent
55 | to the Licensor or its representatives, including but not limited to
56 | communication on electronic mailing lists, source code control systems,
57 | and issue tracking systems that are managed by, or on behalf of, the
58 | Licensor for the purpose of discussing and improving the Work, but
59 | excluding communication that is conspicuously marked or otherwise
60 | designated in writing by the copyright owner as "Not a Contribution."
61 |
62 | "Contributor" shall mean Licensor and any individual or Legal Entity
63 | on behalf of whom a Contribution has been received by Licensor and
64 | subsequently incorporated within the Work.
65 |
66 | 2. Grant of Copyright License. Subject to the terms and conditions of
67 | this License, each Contributor hereby grants to You a perpetual,
68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69 | copyright license to reproduce, prepare Derivative Works of,
70 | publicly display, publicly perform, sublicense, and distribute the
71 | Work and such Derivative Works in Source or Object form.
72 |
73 | 3. Grant of Patent License. Subject to the terms and conditions of
74 | this License, each Contributor hereby grants to You a perpetual,
75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76 | (except as stated in this section) patent license to make, have made,
77 | use, offer to sell, sell, import, and otherwise transfer the Work,
78 | where such license applies only to those patent claims licensable
79 | by such Contributor that are necessarily infringed by their
80 | Contribution(s) alone or by combination of their Contribution(s)
81 | with the Work to which such Contribution(s) was submitted. If You
82 | institute patent litigation against any entity (including a
83 | cross-claim or counterclaim in a lawsuit) alleging that the Work
84 | or a Contribution incorporated within the Work constitutes direct
85 | or contributory patent infringement, then any patent licenses
86 | granted to You under this License for that Work shall terminate
87 | as of the date such litigation is filed.
88 |
89 | 4. Redistribution. You may reproduce and distribute copies of the
90 | Work or Derivative Works thereof in any medium, with or without
91 | modifications, and in Source or Object form, provided that You
92 | meet the following conditions:
93 |
94 | (a) You must give any other recipients of the Work or
95 | Derivative Works a copy of this License; and
96 |
97 | (b) You must cause any modified files to carry prominent notices
98 | stating that You changed the files; and
99 |
100 | (c) You must retain, in the Source form of any Derivative Works
101 | that You distribute, all copyright, patent, trademark, and
102 | attribution notices from the Source form of the Work,
103 | excluding those notices that do not pertain to any part of
104 | the Derivative Works; and
105 |
106 | (d) If the Work includes a "NOTICE" text file as part of its
107 | distribution, then any Derivative Works that You distribute must
108 | include a readable copy of the attribution notices contained
109 | within such NOTICE file, excluding those notices that do not
110 | pertain to any part of the Derivative Works, in at least one
111 | of the following places: within a NOTICE text file distributed
112 | as part of the Derivative Works; within the Source form or
113 | documentation, if provided along with the Derivative Works; or,
114 | within a display generated by the Derivative Works, if and
115 | wherever such third-party notices normally appear. The contents
116 | of the NOTICE file are for informational purposes only and
117 | do not modify the License. You may add Your own attribution
118 | notices within Derivative Works that You distribute, alongside
119 | or as an addendum to the NOTICE text from the Work, provided
120 | that such additional attribution notices cannot be construed
121 | as modifying the License.
122 |
123 | You may add Your own copyright statement to Your modifications and
124 | may provide additional or different license terms and conditions
125 | for use, reproduction, or distribution of Your modifications, or
126 | for any such Derivative Works as a whole, provided Your use,
127 | reproduction, and distribution of the Work otherwise complies with
128 | the conditions stated in this License.
129 |
130 | 5. Submission of Contributions. Unless You explicitly state otherwise,
131 | any Contribution intentionally submitted for inclusion in the Work
132 | by You to the Licensor shall be under the terms and conditions of
133 | this License, without any additional terms or conditions.
134 | Notwithstanding the above, nothing herein shall supersede or modify
135 | the terms of any separate license agreement you may have executed
136 | with Licensor regarding such Contributions.
137 |
138 | 6. Trademarks. This License does not grant permission to use the trade
139 | names, trademarks, service marks, or product names of the Licensor,
140 | except as required for reasonable and customary use in describing the
141 | origin of the Work and reproducing the content of the NOTICE file.
142 |
143 | 7. Disclaimer of Warranty. Unless required by applicable law or
144 | agreed to in writing, Licensor provides the Work (and each
145 | Contributor provides its Contributions) on an "AS IS" BASIS,
146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147 | implied, including, without limitation, any warranties or conditions
148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149 | PARTICULAR PURPOSE. You are solely responsible for determining the
150 | appropriateness of using or redistributing the Work and assume any
151 | risks associated with Your exercise of permissions under this License.
152 |
153 | 8. Limitation of Liability. In no event and under no legal theory,
154 | whether in tort (including negligence), contract, or otherwise,
155 | unless required by applicable law (such as deliberate and grossly
156 | negligent acts) or agreed to in writing, shall any Contributor be
157 | liable to You for damages, including any direct, indirect, special,
158 | incidental, or consequential damages of any character arising as a
159 | result of this License or out of the use or inability to use the
160 | Work (including but not limited to damages for loss of goodwill,
161 | work stoppage, computer failure or malfunction, or any and all
162 | other commercial damages or losses), even if such Contributor
163 | has been advised of the possibility of such damages.
164 |
165 | 9. Accepting Warranty or Additional Liability. While redistributing
166 | the Work or Derivative Works thereof, You may choose to offer,
167 | and charge a fee for, acceptance of support, warranty, indemnity,
168 | or other liability obligations and/or rights consistent with this
169 | License. However, in accepting such obligations, You may act only
170 | on Your own behalf and on Your sole responsibility, not on behalf
171 | of any other Contributor, and only if You agree to indemnify,
172 | defend, and hold each Contributor harmless for any liability
173 | incurred by, or claims asserted against, such Contributor by reason
174 | of your accepting any such warranty or additional liability.
175 |
176 | END OF TERMS AND CONDITIONS
177 |
178 | APPENDIX: How to apply the Apache License to your work.
179 |
180 | To apply the Apache License to your work, attach the following
181 | boilerplate notice, with the fields enclosed by brackets "{}"
182 | replaced with your own identifying information. (Don't include
183 | the brackets!) The text should be enclosed in the appropriate
184 | comment syntax for the file format. We also recommend that a
185 | file or class name and description of purpose be included on the
186 | same "printed page" as the copyright notice for easier
187 | identification within third-party archives.
188 |
189 | Copyright 2023-present Dylibso, Inc.
190 | Licensed under the Apache License, Version 2.0 (the "License");
191 | you may not use this file except in compliance with the License.
192 | You may obtain a copy of the License at
193 |
194 | http://www.apache.org/licenses/LICENSE-2.0
195 |
196 | Unless required by applicable law or agreed to in writing, software
197 | distributed under the License is distributed on an "AS IS" BASIS,
198 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
199 | See the License for the specific language governing permissions and
200 | limitations under the License.
201 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 |
13 |
14 | Reactables bring the power of React and JSX to everyone's programming language of choice.
15 | Compile and render JSX templates securely from over 15 different programming languages including Python, Go, Java, Ruby, .NET, PHP, and more!
16 |
17 |
18 |
19 |
20 |
21 |
22 |
23 |
24 | ## Why Reactables?
25 |
26 | There are many embeddable templating languages (e.g., Handlebars.js, Mustache, Liquid, etc.) in the world today, but all suffer from a few shortcomings:
27 |
28 | - They lack expressivity and complexity turns messy (ie. non Turing-complete languages)
29 | - They can be unfamiliar to many users and come with a non-zero learning curve
30 | - They require users to leave all of their pre-built components behind and start from scratch
31 | - They are incompatible with popular web development tools (e.g. Webpack, ESBuild, etc.)
32 |
33 | In an ideal world, React/JSX could be used as a general purpose template engine and all of the above limitations would fade
34 | away, but alas:
35 |
36 | - You can only embed in JavaScript. What if your code base is written in something else or you have multiple languages?
37 | - What if your JSX templates are provided by a third party? That's not very secure...
38 |
39 | Enter Reactables! These happen to be the two primary problems that [Extism](https://extism.org) aims to solve.
40 | Reactables is distributed as an [Extism Plug-in](https://extism.org/docs/concepts/plug-in), so you can now compile and render React/JSX **safely** from within your programming language of choice.
41 |
42 | ## Use Cases
43 |
44 | 1. Your entire codebase is written in `` but you really want/need to render templates with JSX
45 | 2. You're a SaaS platform and you want to give your customers the ability to customize various artifacts and touch points such as hosted pages, emails, and PDFs.
46 |
47 | ## Features
48 |
49 | - Run arbritrary JavaScript / JSX in your code **securely**!
50 | - Suport for over 15 different host programming languages
51 | - Incorporate your favorite tooling, styling, and NPM packages (experimental)
52 | - Package up a full blown JSX app using ESBuild or Webpack
53 | - Build and distribute new Reactables from your component library. They're customizable and portable!
54 |
55 | ## Ready to Consume
56 |
57 | **Choose from pre-built Reactables that are ready to go out-of-the-box for your immediate enjoyment.** Each Reactable is implemented as
58 | a WebAssembly Module in the form of an [Extism Plugin](https://extism.org/docs/concepts/plug-in) that embeds React and other dependencies along with an interface to compile JSX templates and render them with supplied props.
59 |
60 | - **Reactable Core** provides a foundational plugin with React securely embedded to provide the core JSX compilation and rendering capabilities. Get it [here](https://github.com/dylibso/reactables/releases)
61 |
62 | ### Coming Soon
63 | - **Reactable Email** extends Reactable Core with components from [react-email](https://github.com/resendlabs/react-email)
64 | - **Reactable PDF** extends Reactable Core with components from [react-pdf](https://github.com/diegomura/react-pdf)
65 |
66 | ## Usage
67 |
68 | 1. Include the appropriate [Extism SDK](https://extism.org/docs/quickstart/host-quickstart) into your application
69 | 2. Instantiate your Reactable of choice as a new Extism Plugin
70 | 3. Call the `compileTemplate` function with your JSX template
71 | 4. Call the `render` function with your props
72 | 5. Voila!
73 |
74 | ### Example (Python)
75 |
76 | The following example embeds Reactable Core in a Python program to render a simple a JSX template with a customer name property.
77 | See the [examples directory](examples/) for examples in more languages.
78 |
79 | ```python
80 | import extism
81 | import json
82 |
83 | plugin_url = "https://github.com/dylibso/reactables/releases/latest/download/reactable.core.wasm"
84 | manifest = { "wasm": [ { "url": plugin_url } ] }
85 | reactable = extism.Plugin(manifest, wasi=True)
86 |
87 | # Take our JSX code as a string
88 | jsx_code = """
89 | function App(props) {
90 | return
Hello, {props.customerName}!
91 | }
92 | """
93 |
94 | # Compile the template and register it by name
95 | reactable.call('compileTemplate', json.dumps({
96 | "name": "greeting-template",
97 | "code": jsx_code,
98 | }))
99 |
100 | # Render template by name, passing in some props
101 | props = { "customerName": "Benjamin" }
102 | html = reactable.call('render', json.dumps({
103 | "name": "greeting-template",
104 | "props": props,
105 | }))
106 |
107 | print(html)
108 | #
Hello, Benjamin!
109 | ```
110 |
111 | ## Build your own
112 |
113 | Reactable Core can be extended to create new and novel Reactables that incorporate other components, styles, packages, etc.
114 |
115 |
--------------------------------------------------------------------------------
/esbuild.js:
--------------------------------------------------------------------------------
1 | const esbuild = require('esbuild');
2 | const { NodeModulesPolyfillPlugin } = require('@esbuild-plugins/node-modules-polyfill')
3 |
4 | esbuild
5 | .build({
6 | entryPoints: ['src/index.jsx'],
7 | outdir: 'dist',
8 | bundle: true,
9 | sourcemap: true,
10 | minify: false, // might want to use true for production build
11 | format: 'cjs', // needs to be CJS for now
12 | target: ['es2020'], // don't go over es2020 because quickjs doesn't support it
13 | plugins: [NodeModulesPolyfillPlugin()]
14 | })
15 |
16 |
--------------------------------------------------------------------------------
/examples/render.cs:
--------------------------------------------------------------------------------
1 | using System;
2 | using Extism.Sdk;
3 | using System.Text.Json;
4 |
5 | namespace SerializeBasic
6 | {
7 | public class Template
8 | {
9 | public string Name { get; set; }
10 | public string Code { get; set; }
11 | }
12 |
13 | public class Invocation
14 | {
15 | public string Name { get; set; }
16 | public Dictionary Props { get; set; }
17 | }
18 |
19 | public class Program
20 | {
21 | public static void Main()
22 | {
23 | var manifest = new Manifest(new UrlWasmSource("https://github.com/dylibso/reactables/releases/latest/download/reactable.core.wasm"));
24 | using var reactable = new Plugin(manifest, new HostFunction[] { }, withWasi: true);
25 |
26 | var template = new Template
27 | {
28 | Name = "greeting-template",
29 | Code = @"
30 | function App(props) {
31 | return
6 | 
21 |