@aglyn/plugins-forms 1.0.0-beta.143

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.
Files changed (45) hide show
  1. package/LICENSE +201 -0
  2. package/README.md +35 -0
  3. package/package.json +52 -0
  4. package/src/index.d.ts +18 -0
  5. package/src/index.js +19 -0
  6. package/src/index.js.map +1 -0
  7. package/src/lib/components/form-design-preview.component.d.ts +68 -0
  8. package/src/lib/components/form-design-preview.component.js +238 -0
  9. package/src/lib/components/form-design-preview.component.js.map +1 -0
  10. package/src/lib/components/form-detail-card.d.ts +53 -0
  11. package/src/lib/components/form-detail-card.js +827 -0
  12. package/src/lib/components/form-detail-card.js.map +1 -0
  13. package/src/lib/components/form-metrics-card.component.d.ts +67 -0
  14. package/src/lib/components/form-metrics-card.component.js +298 -0
  15. package/src/lib/components/form-metrics-card.component.js.map +1 -0
  16. package/src/lib/components/form-submissions-card.component.d.ts +40 -0
  17. package/src/lib/components/form-submissions-card.component.js +104 -0
  18. package/src/lib/components/form-submissions-card.component.js.map +1 -0
  19. package/src/lib/components/form-zones.d.ts +52 -0
  20. package/src/lib/components/form-zones.js +20 -0
  21. package/src/lib/components/form-zones.js.map +1 -0
  22. package/src/lib/components/form.d.ts +186 -0
  23. package/src/lib/components/form.js +1014 -0
  24. package/src/lib/components/form.js.map +1 -0
  25. package/src/lib/components/forms-console-page.d.ts +22 -0
  26. package/src/lib/components/forms-console-page.js +55 -0
  27. package/src/lib/components/forms-console-page.js.map +1 -0
  28. package/src/lib/components/host-forms-card.component.d.ts +56 -0
  29. package/src/lib/components/host-forms-card.component.js +533 -0
  30. package/src/lib/components/host-forms-card.component.js.map +1 -0
  31. package/src/lib/components/use-form-promote-api.d.ts +48 -0
  32. package/src/lib/components/use-form-promote-api.js +63 -0
  33. package/src/lib/components/use-form-promote-api.js.map +1 -0
  34. package/src/lib/constants/bundle-common.d.ts +31 -0
  35. package/src/lib/constants/bundle-common.js +31 -0
  36. package/src/lib/constants/bundle-common.js.map +1 -0
  37. package/src/lib/plugin.d.ts +25 -0
  38. package/src/lib/plugin.js +76 -0
  39. package/src/lib/plugin.js.map +1 -0
  40. package/src/lib/site.d.ts +53 -0
  41. package/src/lib/site.js +83 -0
  42. package/src/lib/site.js.map +1 -0
  43. package/src/lib/utils/generate-preset-id.d.ts +25 -0
  44. package/src/lib/utils/generate-preset-id.js +30 -0
  45. package/src/lib/utils/generate-preset-id.js.map +1 -0
package/LICENSE ADDED
@@ -0,0 +1,201 @@
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 [yyyy] [name of copyright owner]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
package/README.md ADDED
@@ -0,0 +1,35 @@
1
+ # @aglyn/plugins-forms
2
+
3
+ The Forms feature plugin: both halves of a capability that has both.
4
+
5
+ - **Canvas** — the `form` and `formField` elements, registered into
6
+ `FORMS_BUNDLE` and offered in the besigner's element picker.
7
+ - **Console** — the Forms catalog and one form's own surface (declaration,
8
+ metrics, versions, promotion, design preview), contributed through the
9
+ `ConsoleExtension` registry and rendered by the shell's generic plugin
10
+ route at `/{orgSlug}/hosts/{host}/forms`.
11
+
12
+ ## Ids
13
+
14
+ `componentId` is a bare string and is persisted in every screen document:
15
+ `form` and `formField` never change. `pluginId` is persisted beside it and is
16
+ `forms` — see `src/lib/constants/bundle-common.ts` for why that field is not
17
+ cosmetic, and `tools/scripts/backfill-node-plugin-ids.mjs` for the script that
18
+ keeps saved nodes agreeing with it.
19
+
20
+ ## What is NOT here
21
+
22
+ The MODEL and the CONTRACT stay in core — `libs/aglyn/src/lib/app-utils/
23
+ forms.ts` and `form-contract.ts`. `apps/tenant/app/api/forms/submit/route.ts`
24
+ resolves a form at request time through `@aglyn/tenant-runtime`, which is
25
+ tagged `scope:aglyn` and so may depend only on `scope:aglyn` and
26
+ `scope:shared`; a plugin carries `aglyn:addons` alone, so no core lib can
27
+ reach it. The submit route, the publish-time contract check and the besigner
28
+ editor route are all on the core side of that line.
29
+
30
+ Form SUBMISSIONS are read in the Inbox, which is `@aglyn/plugins-inbox`: this
31
+ plugin owns what a form IS, and the inbox owns what it collected.
32
+
33
+ ## Running unit tests
34
+
35
+ `nx test plugins-forms`.
package/package.json ADDED
@@ -0,0 +1,52 @@
1
+ {
2
+ "name": "@aglyn/plugins-forms",
3
+ "version": "1.0.0-beta.143",
4
+ "license": "Apache-2.0",
5
+ "homepage": "https://aglyn.com",
6
+ "repository": {
7
+ "type": "git",
8
+ "url": "https://github.com/aglyn/aglyn.git",
9
+ "directory": "libs/plugins/forms"
10
+ },
11
+ "publishConfig": {
12
+ "access": "public",
13
+ "provenance": true
14
+ },
15
+ "type": "module",
16
+ "exports": {
17
+ ".": {
18
+ "types": "./src/index.d.ts",
19
+ "default": "./src/index.js"
20
+ },
21
+ "./*": {
22
+ "types": "./src/lib/*.d.ts",
23
+ "default": "./src/lib/*.js"
24
+ },
25
+ "./package.json": "./package.json"
26
+ },
27
+ "dependencies": {
28
+ "@aglyn/aglyn": "1.0.0-beta.143",
29
+ "@aglyn/shared-data-enums": "1.0.0-beta.143",
30
+ "@aglyn/shared-data-mdi": "1.0.0-beta.143",
31
+ "@aglyn/shared-ui-email-campaigns": "1.0.0-beta.143",
32
+ "@aglyn/shared-ui-jsx": "1.0.0-beta.143",
33
+ "@aglyn/shared-ui-jsx-forms": "1.0.0-beta.143",
34
+ "@aglyn/shared-ui-snackstack": "1.0.0-beta.143",
35
+ "@aglyn/shared-util-http": "1.0.0-beta.143",
36
+ "@aglyn/shared-util-timestamp": "1.0.0-beta.143",
37
+ "@aglyn/shared-util-tools": "1.0.0-beta.143",
38
+ "@aglyn/tenant-feature-instance": "1.0.0-beta.143",
39
+ "@swc/helpers": "0.5.23"
40
+ },
41
+ "peerDependencies": {
42
+ "@mui/material": "^9.3.1",
43
+ "@mui/x-data-grid": "^9.12.0",
44
+ "firebase": "^12.18.0",
45
+ "next": "16.3.3",
46
+ "react": "^19.2.8"
47
+ },
48
+ "sideEffects": false,
49
+ "types": "./src/index.d.ts",
50
+ "module": "./src/index.js",
51
+ "main": "./src/index.js"
52
+ }
package/src/index.d.ts ADDED
@@ -0,0 +1,18 @@
1
+ /**
2
+ * @license
3
+ * Copyright 2026 Aglyn LLC
4
+ *
5
+ * Licensed under the Apache License, Version 2.0 (the "License");
6
+ * you may not use this file except in compliance with the License.
7
+ * You may obtain a copy of the License at
8
+ *
9
+ * http://www.apache.org/licenses/LICENSE-2.0
10
+ *
11
+ * Unless required by applicable law or agreed to in writing, software
12
+ * distributed under the License is distributed on an "AS IS" BASIS,
13
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ * See the License for the specific language governing permissions and
15
+ * limitations under the License.
16
+ */
17
+ export * from './lib/constants/bundle-common';
18
+ export * from './lib/plugin';
package/src/index.js ADDED
@@ -0,0 +1,19 @@
1
+ /**
2
+ * @license
3
+ * Copyright 2026 Aglyn LLC
4
+ *
5
+ * Licensed under the Apache License, Version 2.0 (the "License");
6
+ * you may not use this file except in compliance with the License.
7
+ * You may obtain a copy of the License at
8
+ *
9
+ * http://www.apache.org/licenses/LICENSE-2.0
10
+ *
11
+ * Unless required by applicable law or agreed to in writing, software
12
+ * distributed under the License is distributed on an "AS IS" BASIS,
13
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ * See the License for the specific language governing permissions and
15
+ * limitations under the License.
16
+ */ export * from "./lib/constants/bundle-common.js";
17
+ export * from "./lib/plugin.js";
18
+
19
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["../../../../../libs/plugins/forms/src/index.ts"],"sourcesContent":["/**\n * @license\n * Copyright 2026 Aglyn LLC\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nexport * from './lib/constants/bundle-common'\nexport * from './lib/plugin'\n"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;CAeC,GAED,cAAc,mCAA+B;AAC7C,cAAc,kBAAc"}
@@ -0,0 +1,68 @@
1
+ import * as Aglyn from '@aglyn/aglyn';
2
+ export interface FormDesignPreviewProps {
3
+ formId: string;
4
+ /** The form document's PUBLISHED `nodes` — what a visitor is served today. */
5
+ nodes: unknown;
6
+ /** Which field the document names as the marketing opt-in. */
7
+ consentFieldName?: string;
8
+ /** The document has not arrived yet, as against having no design. */
9
+ loading?: boolean;
10
+ }
11
+ /**
12
+ * Builds the standalone document the frame is given.
13
+ *
14
+ * Exported for the spec: the property that matters — that no author-supplied
15
+ * string can become markup — is a property of this string, and asserting it
16
+ * through a rendered component would be asserting it through React's escaping
17
+ * as well as this function's.
18
+ */
19
+ export declare function buildFormPreviewDocument(options: {
20
+ fields: Aglyn.FormFieldDecl[];
21
+ consentFieldName?: string;
22
+ }): string;
23
+ /**
24
+ * THE FORM AS THE SUBMIT ROUTE WILL READ IT, DRAWN SAFELY.
25
+ *
26
+ * ## What is being previewed
27
+ *
28
+ * A form has two halves and they fail differently. The DESIGN — fonts,
29
+ * spacing, the theme the site draws it in — is previewed by
30
+ * `Route.FORM_PREVIEW`, which renders the stored nodes through
31
+ * `AglynNodeRenderer`, the same component tree the published page mounts. That
32
+ * is a whole-page surface and it stays where it is.
33
+ *
34
+ * This is the other half: the CONTRACT. `/api/forms/submit` never sees a
35
+ * pixel. It sees `FormData` keys, and every coupling it depends on — which
36
+ * field is the address a lead is created from, which field is the marketing
37
+ * opt-in — is resolved by NAME. So the question this frame answers is the one
38
+ * an author cannot answer by looking at the canvas: what names will arrive,
39
+ * and which of them carry meaning.
40
+ *
41
+ * The field list is NOT re-derived here. `formFieldDeclsFromNodes` is the same
42
+ * function the publish path calls to write the document's `fields` and the
43
+ * same one adoption uses, including its two rules that are easy to get wrong
44
+ * — an unnamed field is dropped, and a duplicate name keeps its first
45
+ * occurrence — so this frame drops and keeps exactly what a real submission
46
+ * does. A second implementation would be a preview of something else.
47
+ *
48
+ * ## Sandboxed, because every string in it is tenant-authored
49
+ *
50
+ * Labels, option text and field names are typed by a site's own editors, or
51
+ * arrive on a marketplace template. They are escaped on the way into the
52
+ * document AND the document is rendered into an iframe with an EMPTY `sandbox`
53
+ * attribute — the maximally restrictive form: no scripts, no forms, no popups,
54
+ * no top-level navigation and, critically, no same-origin. The frame gets an
55
+ * opaque origin, so nothing inside it can reach the console's cookies, storage
56
+ * or DOM. `srcDoc` rather than a URL keeps the markup from ever being served
57
+ * from the console's own origin, where the sandbox attribute would be the only
58
+ * thing between tenant content and a live session.
59
+ *
60
+ * The escaping and the sandbox are not redundant: the escaping is what keeps
61
+ * the preview a preview of the author's text rather than of their markup, and
62
+ * the sandbox is what makes being wrong about the escaping survivable.
63
+ */
64
+ export declare function FormDesignPreview(props: FormDesignPreviewProps): import("react").JSX.Element;
65
+ export declare namespace FormDesignPreview {
66
+ var displayName: string;
67
+ }
68
+ export default FormDesignPreview;
@@ -0,0 +1,238 @@
1
+ /**
2
+ * @license
3
+ * Copyright 2026 Aglyn LLC
4
+ *
5
+ * Licensed under the Apache License, Version 2.0 (the "License");
6
+ * you may not use this file except in compliance with the License.
7
+ * You may obtain a copy of the License at
8
+ *
9
+ * http://www.apache.org/licenses/LICENSE-2.0
10
+ *
11
+ * Unless required by applicable law or agreed to in writing, software
12
+ * distributed under the License is distributed on an "AS IS" BASIS,
13
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ * See the License for the specific language governing permissions and
15
+ * limitations under the License.
16
+ */ 'use client';
17
+ import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
18
+ import * as Aglyn from "@aglyn/aglyn";
19
+ // Every character that could close an attribute or open a tag, escaped by the
20
+ // one implementation rather than a fifth copy of it. Subpath, not the library
21
+ // index — see the note there.
22
+ import { escapeHtml } from "@aglyn/shared-util-tools/escape-html";
23
+ import { Box, Stack, Typography } from "@mui/material";
24
+ import { useMemo } from "react";
25
+ /**
26
+ * The `form` node inside a published design.
27
+ *
28
+ * A form document's tree holds exactly one, because the document IS that form
29
+ * — but the tree is a flat map, so the node has to be found rather than
30
+ * assumed to be the root.
31
+ */ function findFormNodeId(nodes) {
32
+ return Object.keys(nodes != null ? nodes : {}).find((id)=>{
33
+ var _nodes_id;
34
+ return (nodes == null ? void 0 : (_nodes_id = nodes[id]) == null ? void 0 : _nodes_id.componentId) === 'form';
35
+ });
36
+ }
37
+ /**
38
+ * One field, as the browser will submit it.
39
+ *
40
+ * The `name` attribute is the whole point: it is the key `/api/forms/submit`
41
+ * reads out of the `FormData`, and it is the coupling `checkFormContract`
42
+ * guards. Rendering the control WITH its name is what makes this a preview of
43
+ * the contract rather than a picture of some inputs.
44
+ */ function renderField(field, consentFieldName) {
45
+ var _field_options;
46
+ const name = escapeHtml(field.fieldName);
47
+ const label = escapeHtml(field.label || field.fieldName);
48
+ const required = field.required ? ' required' : '';
49
+ const isConsent = Boolean(consentFieldName) && field.fieldName === consentFieldName;
50
+ const badge = isConsent ? '<span class="badge">marketing consent</span>' : field.required ? '<span class="badge">required</span>' : '';
51
+ const options = ((_field_options = field.options) != null ? _field_options : []).map((option)=>escapeHtml(option));
52
+ let control;
53
+ switch(field.fieldType){
54
+ case 'textarea':
55
+ control = `<textarea name="${name}" rows="3"${required}></textarea>`;
56
+ break;
57
+ case 'select':
58
+ control = `<select name="${name}"${required}>${options.map((option)=>`<option value="${option}">${option}</option>`).join('')}</select>`;
59
+ break;
60
+ case 'radio':
61
+ control = `<div class="choices">${options.map((option)=>`<label class="choice"><input type="radio" name="${name}" value="${option}"${required}> ${option}</label>`).join('')}</div>`;
62
+ break;
63
+ case 'checkbox':
64
+ control = `<label class="choice"><input type="checkbox" name="${name}" value="on"${required}> ${label}</label>`;
65
+ break;
66
+ case 'rating':
67
+ // The runtime submits a number; a range says so without pretending to be
68
+ // the star control the site draws.
69
+ control = `<input type="range" name="${name}" min="1" max="5"${required}>`;
70
+ break;
71
+ case 'email':
72
+ control = `<input type="email" name="${name}"${required}>`;
73
+ break;
74
+ default:
75
+ control = `<input type="text" name="${name}"${required}>`;
76
+ }
77
+ return [
78
+ '<div class="field">',
79
+ `<div class="label">${label}${badge}</div>`,
80
+ control,
81
+ `<div class="key">name="${name}"</div>`,
82
+ '</div>'
83
+ ].join('');
84
+ }
85
+ /** The style block, kept out of the builder so the markup reads as markup. */ const PREVIEW_CSS = `
86
+ :root { color-scheme: light; }
87
+ body {
88
+ margin: 0; padding: 16px;
89
+ font: 14px/1.5 system-ui, -apple-system, "Segoe UI", sans-serif;
90
+ color: #1a1a1a; background: #ffffff;
91
+ }
92
+ form { display: grid; gap: 16px; max-width: 520px; }
93
+ .field { display: grid; gap: 4px; }
94
+ .label { font-weight: 600; display: flex; align-items: center; gap: 8px; }
95
+ .badge {
96
+ font-weight: 500; font-size: 11px; letter-spacing: .04em;
97
+ text-transform: uppercase; padding: 1px 6px; border-radius: 999px;
98
+ background: #eceff4; color: #55606e;
99
+ }
100
+ .key { font-family: ui-monospace, SFMono-Regular, Menlo, monospace;
101
+ font-size: 11px; color: #6b7280; }
102
+ input[type=text], input[type=email], textarea, select {
103
+ width: 100%; box-sizing: border-box; padding: 8px;
104
+ border: 1px solid #c8cdd4; border-radius: 6px; font: inherit;
105
+ background: #ffffff; color: inherit;
106
+ }
107
+ .choices { display: grid; gap: 4px; }
108
+ .choice { font-weight: 400; display: flex; align-items: center; gap: 6px; }
109
+ button {
110
+ justify-self: start; padding: 8px 16px; border-radius: 6px;
111
+ border: 1px solid #c8cdd4; background: #f4f6f8; font: inherit;
112
+ }
113
+ .none { color: #6b7280; }
114
+ `;
115
+ /**
116
+ * Builds the standalone document the frame is given.
117
+ *
118
+ * Exported for the spec: the property that matters — that no author-supplied
119
+ * string can become markup — is a property of this string, and asserting it
120
+ * through a rendered component would be asserting it through React's escaping
121
+ * as well as this function's.
122
+ */ export function buildFormPreviewDocument(options) {
123
+ const { fields, consentFieldName } = options;
124
+ const body = fields.length ? fields.map((field)=>renderField(field, consentFieldName)).join('') : '<p class="none">This design declares no named fields.</p>';
125
+ return [
126
+ '<!doctype html><html lang="en"><head><meta charset="utf-8">',
127
+ '<meta name="viewport" content="width=device-width,initial-scale=1">',
128
+ `<style>${PREVIEW_CSS}</style></head><body>`,
129
+ // `action` is deliberately absent and the frame is sandboxed, so this
130
+ // cannot post anywhere even if a reader hits Return in a text field.
131
+ `<form>${body}<button type="button">Submit</button></form>`,
132
+ '</body></html>'
133
+ ].join('');
134
+ }
135
+ /**
136
+ * THE FORM AS THE SUBMIT ROUTE WILL READ IT, DRAWN SAFELY.
137
+ *
138
+ * ## What is being previewed
139
+ *
140
+ * A form has two halves and they fail differently. The DESIGN — fonts,
141
+ * spacing, the theme the site draws it in — is previewed by
142
+ * `Route.FORM_PREVIEW`, which renders the stored nodes through
143
+ * `AglynNodeRenderer`, the same component tree the published page mounts. That
144
+ * is a whole-page surface and it stays where it is.
145
+ *
146
+ * This is the other half: the CONTRACT. `/api/forms/submit` never sees a
147
+ * pixel. It sees `FormData` keys, and every coupling it depends on — which
148
+ * field is the address a lead is created from, which field is the marketing
149
+ * opt-in — is resolved by NAME. So the question this frame answers is the one
150
+ * an author cannot answer by looking at the canvas: what names will arrive,
151
+ * and which of them carry meaning.
152
+ *
153
+ * The field list is NOT re-derived here. `formFieldDeclsFromNodes` is the same
154
+ * function the publish path calls to write the document's `fields` and the
155
+ * same one adoption uses, including its two rules that are easy to get wrong
156
+ * — an unnamed field is dropped, and a duplicate name keeps its first
157
+ * occurrence — so this frame drops and keeps exactly what a real submission
158
+ * does. A second implementation would be a preview of something else.
159
+ *
160
+ * ## Sandboxed, because every string in it is tenant-authored
161
+ *
162
+ * Labels, option text and field names are typed by a site's own editors, or
163
+ * arrive on a marketplace template. They are escaped on the way into the
164
+ * document AND the document is rendered into an iframe with an EMPTY `sandbox`
165
+ * attribute — the maximally restrictive form: no scripts, no forms, no popups,
166
+ * no top-level navigation and, critically, no same-origin. The frame gets an
167
+ * opaque origin, so nothing inside it can reach the console's cookies, storage
168
+ * or DOM. `srcDoc` rather than a URL keeps the markup from ever being served
169
+ * from the console's own origin, where the sandbox attribute would be the only
170
+ * thing between tenant content and a live session.
171
+ *
172
+ * The escaping and the sandbox are not redundant: the escaping is what keeps
173
+ * the preview a preview of the author's text rather than of their markup, and
174
+ * the sandbox is what makes being wrong about the escaping survivable.
175
+ */ export function FormDesignPreview(props) {
176
+ const { formId, nodes: rawNodes, consentFieldName, loading } = props;
177
+ const fields = useMemo(()=>{
178
+ const decoded = Aglyn.decodeStoredNodes(rawNodes);
179
+ if (!decoded || !Object.keys(decoded).length) return null;
180
+ const formNodeId = findFormNodeId(decoded);
181
+ if (!formNodeId) return null;
182
+ return Aglyn.formFieldDeclsFromNodes(decoded, formNodeId);
183
+ }, [
184
+ rawNodes
185
+ ]);
186
+ const previewDocument = useMemo(()=>fields ? buildFormPreviewDocument({
187
+ fields,
188
+ consentFieldName
189
+ }) : null, [
190
+ fields,
191
+ consentFieldName
192
+ ]);
193
+ if (!previewDocument) {
194
+ return /*#__PURE__*/ _jsx(Typography, {
195
+ variant: "body2",
196
+ color: "text.secondary",
197
+ children: loading ? 'Loading this form…' : 'Nothing published yet — open this form in the besigner, then ' + 'publish a version to see what it will collect.'
198
+ });
199
+ }
200
+ return /*#__PURE__*/ _jsxs(Stack, {
201
+ spacing: 1,
202
+ children: [
203
+ /*#__PURE__*/ _jsx(Box, {
204
+ component: "iframe",
205
+ title: `Preview of form ${formId}`,
206
+ /*
207
+ * EMPTY sandbox — every restriction on, nothing allowed back. The
208
+ * strings below are authored outside this console, so the document is
209
+ * rendered with no scripts, no form submission, no navigation and an
210
+ * opaque origin: it cannot reach the console's session, storage or DOM
211
+ * even though it is drawn inside the console.
212
+ */ sandbox: "",
213
+ referrerPolicy: "no-referrer",
214
+ srcDoc: previewDocument,
215
+ sx: {
216
+ width: '100%',
217
+ // Fixed, with the frame's own scrollbar. A sandbox with no scripts
218
+ // is a frame that cannot measure or report its content height, and
219
+ // an iframe cannot size to its content on its own.
220
+ height: 420,
221
+ border: 1,
222
+ borderColor: 'divider',
223
+ borderRadius: 1,
224
+ bgcolor: 'common.white'
225
+ }
226
+ }),
227
+ /*#__PURE__*/ _jsx(Typography, {
228
+ variant: "caption",
229
+ color: "text.secondary",
230
+ children: 'These are the names a submission arrives under, read off the ' + 'published design by the same function that writes the form’s ' + 'declared fields. The site’s own styling is not applied here — ' + 'use Preview for that.'
231
+ })
232
+ ]
233
+ });
234
+ }
235
+ FormDesignPreview.displayName = 'FormDesignPreview';
236
+ export default FormDesignPreview;
237
+
238
+ //# sourceMappingURL=form-design-preview.component.js.map