@payloadcms/plugin-form-builder 1.0.0

package/README.md

@@ -0,0 +1,220 @@
+# Payload Form Builder Plugin
+
+[![NPM](https://img.shields.io/npm/v/@payloadcms/plugin-form-builder)](https://www.npmjs.com/package/@payloadcms/plugin-form-builder)
+
+A plugin for [Payload CMS](https://github.com/payloadcms/payload) to easily allow your admin editors to build and manage forms from the admin panel.
+
+Core features:
+  - Creates a `forms` collection where you can:
+    - Build dynamic forms with any number of fields
+    - Add payment fields that can handle dynamic prices
+    - Build completely custom and dynamic emails
+  - Creates a `formSubmissions` collection that:
+    - Validates and saves the form data submitted by your frontend
+    - Sends emails (if applicable)
+    - Handles payment processing (if applicable)
+
+## Installation
+
+```bash
+  yarn add @payloadcms/plugin-form-builder
+  # OR
+  npm i @payloadcms/plugin-form-builder
+```
+
+## Basic Usage
+
+In the  `plugins` array of your [Payload config](https://payloadcms.com/docs/configuration/overview), call the plugin with [options](#options):
+
+```js
+import { buildConfig } from 'payload/config';
+import formBuilder from '@payloadcms/plugin-form-builder';
+
+const config = buildConfig({
+  collections: [
+    {
+      slug: 'pages',
+      fields: []
+    }
+  ],
+  plugins: [
+    formBuilder()
+  ]
+});
+
+export default config;
+```
+
+### Options
+
+- `fields`
+    An object of field types to allow your admin editors to build forms with. Pass either a boolean value or a partial [Payload Block](https://payloadcms.com/docs/fields/blocks#block-configs) to override default settings. See [Fields](#fields) for more details.
+
+    ```
+    fields: {
+      text: true,
+      select: true,
+      email: true,
+      state: true,
+      country: true,
+      checkbox: true,
+      number: true,
+      message: true,
+      payment: false
+    }
+    ```
+
+    You can also provide your own custom field definitions by passing a new [Payload Block](https://payloadcms.com/docs/fields/blocks#block-configs) object into `fields`.
+
+
+- `redirectRelationships`
+
+    An array of collection slugs that, when enabled, are populated as options in form redirect fields.
+
+    ```
+    redirectRelationships: ['pages']
+    ```
+
+- `handlePayment`
+
+   A [beforeChange]([beforeChange](https://payloadcms.com/docs/hooks/globals#beforechange)) hook that is called upon form submissions. You can integrate into any third-party payment processing API here. There is a `getPaymentTotal` function that will calculate the total cost after all conditions have been applied.
+
+    ```
+    import { getPaymentTotal } from '@payloadcms/plugin-form-builder';
+    ...
+    handlePayment: async ({ form, submissionData }) => {
+      // first calculate the price
+      const paymentField =  form.fields?.find((field) => field.blockType === 'payment');
+      const price = getPaymentTotal({
+        basePrice: paymentField.basePrice,
+        priceConditions: paymentField.priceConditions,
+        fieldValues: submissionData,
+      });
+      // then asynchronously process the payment here
+    }
+    ```
+
+- `beforeEmail`
+
+    A [beforeChange]([beforeChange](https://payloadcms.com/docs/hooks/globals#beforechange)) hook that is called just after emails are prepared, but before they are sent. This is a great place to inject your own HTML template to add custom styles.
+
+    ```
+    beforeEmails: (emailsToSend) => {
+      // modify the emails in any way before they are sent
+      return emails.map((email) => ({
+        ...email,
+        html: email.html // transform the html in any way you'd like (maybe wrap it in an html template?)
+      }))
+    };
+    ```
+
+- `formOverrides`
+
+    Override anything on the form collection by sending a [Payload Collection Config](https://payloadcms.com/docs/configuration/collections). Your overrides will be merged into the default `forms` collection.
+
+    ```
+    formOverrides: {
+      slug: 'contact-forms'
+    }
+    ```
+
+- `formSubmissionOverrides`
+    By default, this plugin relies on [Payload access control](https://payloadcms.com/docs/access-control/collections) to restrict the `update` and `read` operations. This is because anyone should be able to create a form submission, even from a public-facing website - but no one should be able to update a submission one it has been created, or read a submission unless they have permission.
+
+    You can override access control and anything else on the form submission collection by sending a [Payload Collection Config](https://payloadcms.com/docs/configuration/collections). Your overrides will be merged into the default `formSubmissions` collection.
+
+    ```
+    formSubmissionOverrides: {
+      slug: 'leads'
+    }
+    ```
+
+## Fields
+
+Each form field is defined as a [Payload Block](https://payloadcms.com/docs/fields/blocks) with the following subfields:
+
+  - Text
+    - `name`: string
+    - `label`: string
+    - `defaultValue`: string
+    - `width`: string
+    - `required`: checkbox
+  - Select
+    - `name`: string
+    - `label`: string
+    - `defaultValue`: string
+    - `width`: string
+    - `options`: array
+    - `required`: checkbox
+  - Email
+    - `name`: string
+    - `label`: string
+    - `defaultValue`: string
+    - `width`: string
+    - `required`: checkbox
+  - State
+    - `name`: string
+    - `label`: string
+    - `defaultValue`: string
+    - `width`: string
+    - `required`: checkbox
+  - Country
+    - `name`: string
+    - `label`: string
+    - `defaultValue`: string
+    - `width`: string
+    - `required`: checkbox
+  - Checkbox
+    - `name`: string
+    - `label`: string
+    - `defaultValue`: checkbox
+    - `width`: string
+    - `required`: checkbox
+  - Number
+    - `name`: string
+    - `label`: string
+    - `defaultValue`: number
+    - `width`: string
+    - `required`: checkbox
+  - Message
+    - `message`: richText
+  - Payment
+    - `name`: string
+    - `label`: string
+    - `defaultValue`: number
+    - `width`: string
+    - `required`: checkbox
+    - `priceConditions`: array
+        - `fieldToUse`: relationship, dynamically populated based on the fields in your form
+        - `condition`: string - `equals`, `notEquals` | `hasValue`
+        - `valueForOperator`: string - only if `condition` is `equals` or `notEquals`
+        - `operator`: string - `add`, `subtract`, `multiply`, `divide`
+        - `valueType`: string - `static`, `valueOfField`
+        - `value`: string - only if `valueType` is `static`
+
+  ## Email
+
+  This plugin relies on the [email configuration](https://payloadcms.com/docs/email/overview) defined in your `payload.init()`. It will read from your config and attempt to send your emails using the credentials provided.
+
+  ## TypeScript
+
+  All types can be directly imported:
+  ```js
+  import {
+    FormConfig,
+    Form,
+    FormSubmission,
+    FieldsConfig,
+    BeforePayment,
+    HandlePayment
+   } from '@payloadcms/plugin-form-builder/dist/types';
+  ```
+
+  ## Screenshots
+
+  ![screenshot 1](https://github.com/payloadcms/plugin-form-builder/blob/main/images/screenshot-1.jpg?raw=true)
+  ![screenshot 2](https://github.com/payloadcms/plugin-form-builder/blob/main/images/screenshot-2.jpg?raw=true)
+  ![screenshot 3](https://github.com/payloadcms/plugin-form-builder/blob/main/images/screenshot-3.jpg?raw=true)
+  ![screenshot 4](https://github.com/payloadcms/plugin-form-builder/blob/main/images/screenshot-4.jpg?raw=true)
+  ![screenshot 5](https://github.com/payloadcms/plugin-form-builder/blob/main/images/screenshot-5.jpg?raw=true)
+  ![screenshot 6](https://github.com/payloadcms/plugin-form-builder/blob/main/images/screenshot-6.jpg?raw=true)

package/dist/collections/FormSubmissions/hooks/createCharge.d.ts

@@ -0,0 +1,3 @@
+import { FormConfig } from "../../../types";
+declare const createCharge: (beforeChangeData: any, formConfig: FormConfig) => Promise<any>;
+export default createCharge;

package/dist/collections/FormSubmissions/hooks/createCharge.js

@@ -0,0 +1,58 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (_) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var createCharge = function (beforeChangeData, formConfig) { return __awaiter(void 0, void 0, void 0, function () {
+    var operation, data, dataWithPaymentDetails, handlePayment;
+    return __generator(this, function (_a) {
+        switch (_a.label) {
+            case 0:
+                operation = beforeChangeData.operation, data = beforeChangeData.data;
+                dataWithPaymentDetails = data;
+                if (!(operation === 'create')) return [3 /*break*/, 2];
+                handlePayment = (formConfig || {}).handlePayment;
+                if (!(typeof handlePayment === 'function')) return [3 /*break*/, 2];
+                return [4 /*yield*/, handlePayment(beforeChangeData)];
+            case 1:
+                dataWithPaymentDetails = _a.sent();
+                _a.label = 2;
+            case 2: return [2 /*return*/, dataWithPaymentDetails];
+        }
+    });
+}); };
+exports.default = createCharge;
+//# sourceMappingURL=createCharge.js.map

package/dist/collections/FormSubmissions/hooks/createCharge.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"createCharge.js","sourceRoot":"","sources":["../../../../src/collections/FormSubmissions/hooks/createCharge.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEA,IAAM,YAAY,GAAG,UAAO,gBAAqB,EAAE,UAAsB;;;;;gBAErE,SAAS,GAEP,gBAAgB,UAFT,EACT,IAAI,GACF,gBAAgB,KADd,CACe;gBAEjB,sBAAsB,GAAG,IAAI,CAAC;qBAE9B,CAAA,SAAS,KAAK,QAAQ,CAAA,EAAtB,wBAAsB;gBAEtB,aAAa,GACX,CAAA,UAAU,IAAI,EAAE,CAAA,cADL,CACM;qBAEjB,CAAA,OAAO,aAAa,KAAK,UAAU,CAAA,EAAnC,wBAAmC;gBACZ,qBAAM,aAAa,CAAC,gBAAgB,CAAC,EAAA;;gBAA9D,sBAAsB,GAAG,SAAqC,CAAC;;oBAInE,sBAAO,sBAAsB,EAAC;;;KAC/B,CAAC;AAEF,kBAAe,YAAY,CAAA"}

package/dist/collections/FormSubmissions/hooks/sendEmail.d.ts

@@ -0,0 +1,3 @@
+import { FormConfig } from '../../../types';
+declare const sendEmail: (beforeChangeData: any, formConfig: FormConfig) => Promise<any>;
+export default sendEmail;

package/dist/collections/FormSubmissions/hooks/sendEmail.js

@@ -0,0 +1,152 @@
+"use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (_) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var serializeRichText_1 = require("../../../utilities/serializeRichText");
+var replaceDoubleCurlys_1 = require("../../../utilities/replaceDoubleCurlys");
+var sendEmail = function (beforeChangeData, formConfig) { return __awaiter(void 0, void 0, void 0, function () {
+    var operation, data, formSubmissionID, payload_1, _a, formID, submissionData_1, _b, beforeEmail, formOverrides, form, emails, formattedEmails, emailsToSend, log, err_1;
+    return __generator(this, function (_c) {
+        switch (_c.label) {
+            case 0:
+                operation = beforeChangeData.operation, data = beforeChangeData.data;
+                if (!(operation === 'create')) return [3 /*break*/, 10];
+                formSubmissionID = beforeChangeData.data.id, payload_1 = beforeChangeData.req.payload;
+                _a = data || {}, formID = _a.form, submissionData_1 = _a.submissionData;
+                _b = formConfig || {}, beforeEmail = _b.beforeEmail, formOverrides = _b.formOverrides;
+                _c.label = 1;
+            case 1:
+                _c.trys.push([1, 9, , 10]);
+                return [4 /*yield*/, payload_1.findByID({
+                        id: formID,
+                        collection: (formOverrides === null || formOverrides === void 0 ? void 0 : formOverrides.slug) || 'forms',
+                    })];
+            case 2:
+                form = _c.sent();
+                if (!form) return [3 /*break*/, 7];
+                emails = form.emails;
+                if (!emails) return [3 /*break*/, 6];
+                formattedEmails = emails.map(function (email) {
+                    var message = email.message, subject = email.subject, emailTo = email.emailTo, emailFrom = email.emailFrom, emailReplyTo = email.replyTo;
+                    var to = (0, replaceDoubleCurlys_1.replaceDoubleCurlys)(emailTo, submissionData_1);
+                    var from = (0, replaceDoubleCurlys_1.replaceDoubleCurlys)(emailFrom, submissionData_1);
+                    var replyTo = (0, replaceDoubleCurlys_1.replaceDoubleCurlys)(emailReplyTo || emailFrom, submissionData_1);
+                    if (to && from) {
+                        return ({
+                            to: to,
+                            from: from,
+                            replyTo: replyTo,
+                            subject: (0, replaceDoubleCurlys_1.replaceDoubleCurlys)(subject, submissionData_1),
+                            html: "<div>".concat((0, serializeRichText_1.serialize)(message, submissionData_1))
+                        });
+                    }
+                    return null;
+                }).filter(Boolean);
+                emailsToSend = formattedEmails;
+                if (!(typeof beforeEmail === 'function')) return [3 /*break*/, 4];
+                return [4 /*yield*/, beforeEmail(formattedEmails)];
+            case 3:
+                emailsToSend = _c.sent();
+                _c.label = 4;
+            case 4:
+                log = emailsToSend.map(function (_a) {
+                    var html = _a.html, rest = __rest(_a, ["html"]);
+                    return (__assign({}, rest));
+                });
+                return [4 /*yield*/, Promise.all(emailsToSend.map(function (email) { return __awaiter(void 0, void 0, void 0, function () {
+                        var to, emailPromise, err_2;
+                        return __generator(this, function (_a) {
+                            switch (_a.label) {
+                                case 0:
+                                    to = email.to;
+                                    _a.label = 1;
+                                case 1:
+                                    _a.trys.push([1, 3, , 4]);
+                                    return [4 /*yield*/, payload_1.sendEmail(email)];
+                                case 2:
+                                    emailPromise = _a.sent();
+                                    return [2 /*return*/, emailPromise];
+                                case 3:
+                                    err_2 = _a.sent();
+                                    console.error("Error while sending email to address: ".concat(to, ". Email not sent."));
+                                    console.error(err_2);
+                                    return [3 /*break*/, 4];
+                                case 4: return [2 /*return*/];
+                            }
+                        });
+                    }); }))];
+            case 5:
+                _c.sent();
+                _c.label = 6;
+            case 6: return [3 /*break*/, 8];
+            case 7:
+                console.log('No emails to send.');
+                _c.label = 8;
+            case 8: return [3 /*break*/, 10];
+            case 9:
+                err_1 = _c.sent();
+                console.error("Error while sending one or more emails in form submission id: ".concat(formSubmissionID, "."));
+                console.error(err_1);
+                return [3 /*break*/, 10];
+            case 10: return [2 /*return*/, data];
+        }
+    });
+}); };
+exports.default = sendEmail;
+//# sourceMappingURL=sendEmail.js.map

package/dist/collections/FormSubmissions/hooks/sendEmail.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sendEmail.js","sourceRoot":"","sources":["../../../../src/collections/FormSubmissions/hooks/sendEmail.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,0EAAiE;AAEjE,8EAA6E;AAE7E,IAAM,SAAS,GAAG,UAAO,gBAAqB,EAAE,UAAsB;;;;;gBAElE,SAAS,GAEP,gBAAgB,UAFT,EACT,IAAI,GACF,gBAAgB,KADd,CACe;qBAEjB,CAAA,SAAS,KAAK,QAAQ,CAAA,EAAtB,yBAAsB;gBAGhB,gBAAgB,GAKpB,gBAAgB,QALI,EAGpB,YAEA,gBAAgB,YAFT,CAEU;gBAEf,KAGF,IAAI,IAAI,EAAE,EAFN,MAAM,UAAA,EACZ,oCAAc,CACD;gBAET,KAGF,UAAU,IAAI,EAAE,EAFlB,WAAW,iBAAA,EACX,aAAa,mBAAA,CACM;;;;gBAGN,qBAAM,SAAO,CAAC,QAAQ,CAAC;wBAClC,EAAE,EAAE,MAAM;wBACV,UAAU,EAAE,CAAA,aAAa,aAAb,aAAa,uBAAb,aAAa,CAAE,IAAI,KAAI,OAAO;qBAC3C,CAAC,EAAA;;gBAHI,IAAI,GAAG,SAGX;qBAEE,IAAI,EAAJ,wBAAI;gBAEJ,MAAM,GACJ,IAAI,OADA,CACC;qBAEL,MAAM,EAAN,wBAAM;gBACF,eAAe,GAAqB,MAAM,CAAC,GAAG,CAAC,UAAC,KAAY;oBAE9D,IAAA,OAAO,GAKL,KAAK,QALA,EACP,OAAO,GAIL,KAAK,QAJA,EACP,OAAO,GAGL,KAAK,QAHA,EACP,SAAS,GAEP,KAAK,UAFE,EACA,YAAY,GACnB,KAAK,QADc,CACb;oBAEV,IAAM,EAAE,GAAG,IAAA,yCAAmB,EAAC,OAAO,EAAE,gBAAc,CAAC,CAAC;oBACxD,IAAM,IAAI,GAAG,IAAA,yCAAmB,EAAC,SAAS,EAAE,gBAAc,CAAC,CAAC;oBAC5D,IAAM,OAAO,GAAG,IAAA,yCAAmB,EAAC,YAAY,IAAI,SAAS,EAAE,gBAAc,CAAC,CAAC;oBAE/E,IAAI,EAAE,IAAI,IAAI,EAAE;wBACd,OAAO,CAAC;4BACN,EAAE,IAAA;4BACF,IAAI,MAAA;4BACJ,OAAO,SAAA;4BACP,OAAO,EAAE,IAAA,yCAAmB,EAAC,OAAO,EAAE,gBAAc,CAAC;4BACrD,IAAI,EAAE,eAAQ,IAAA,6BAAS,EAAC,OAAO,EAAE,gBAAc,CAAC,CAAE;yBACnD,CAAC,CAAC;qBACJ;oBACD,OAAO,IAAI,CAAA;gBACb,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;gBAEf,YAAY,GAAG,eAAe,CAAA;qBAE9B,CAAA,OAAO,WAAW,KAAK,UAAU,CAAA,EAAjC,wBAAiC;gBACpB,qBAAM,WAAW,CAAC,eAAe,CAAC,EAAA;;gBAAjD,YAAY,GAAG,SAAkC,CAAC;;;gBAG9C,GAAG,GAAG,YAAY,CAAC,GAAG,CAAC,UAAC,EAAiB;oBAAf,IAAA,IAAI,UAAA,EAAK,IAAI,cAAf,QAAiB,CAAF;oBAAO,OAAA,cAAM,IAAI,EAAG,CAAA;iBAAA,CAAC,CAAA;gBAElE,qBAAM,OAAO,CAAC,GAAG,CACf,YAAY,CAAC,GAAG,CAAC,UAAO,KAAK;;;;;oCACnB,EAAE,GAAK,KAAK,GAAV,CAAW;;;;oCAEE,qBAAM,SAAO,CAAC,SAAS,CAAC,KAAK,CAAC,EAAA;;oCAA7C,YAAY,GAAG,SAA8B;oCACnD,sBAAO,YAAY,EAAC;;;oCAEpB,OAAO,CAAC,KAAK,CAAC,gDAAyC,EAAE,sBAAmB,CAAC,CAAC;oCAC9E,OAAO,CAAC,KAAK,CAAC,KAAG,CAAC,CAAC;;;;;yBAEtB,CAAC,CACH,EAAA;;gBAXD,SAWC,CAAC;;;;gBAGJ,OAAO,CAAC,GAAG,CAAC,oBAAoB,CAAC,CAAA;;;;;gBAGnC,OAAO,CAAC,KAAK,CAAC,wEAAiE,gBAAgB,MAAG,CAAC,CAAC;gBACpG,OAAO,CAAC,KAAK,CAAC,KAAG,CAAC,CAAC;;qBAIvB,sBAAO,IAAI,EAAC;;;KACb,CAAC;AAEF,kBAAe,SAAS,CAAC"}

package/dist/collections/FormSubmissions/index.d.ts

@@ -0,0 +1,3 @@
+import { CollectionConfig } from 'payload/types';
+import { FormConfig } from '../../types';
+export declare const generateSubmissionCollection: (formConfig: FormConfig) => CollectionConfig;

package/dist/collections/FormSubmissions/index.js

@@ -0,0 +1,147 @@
+"use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
+    if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
+        if (ar || !(i in from)) {
+            if (!ar) ar = Array.prototype.slice.call(from, 0, i);
+            ar[i] = from[i];
+        }
+    }
+    return to.concat(ar || Array.prototype.slice.call(from));
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateSubmissionCollection = void 0;
+var sendEmail_1 = __importDefault(require("./hooks/sendEmail"));
+var createCharge_1 = __importDefault(require("./hooks/createCharge"));
+// all settings can be overridden by the config
+var generateSubmissionCollection = function (formConfig) {
+    var _a, _b, _c, _d, _e, _f, _g;
+    var newConfig = {
+        slug: ((_a = formConfig === null || formConfig === void 0 ? void 0 : formConfig.formSubmissionOverrides) === null || _a === void 0 ? void 0 : _a.slug) || 'formSubmissions',
+        access: __assign({ create: function () { return true; }, update: function () { return false; }, read: function (_a) {
+                var user = _a.req.user;
+                return !!user;
+            } }, ((_b = formConfig === null || formConfig === void 0 ? void 0 : formConfig.formSubmissionOverrides) === null || _b === void 0 ? void 0 : _b.access) || {}),
+        admin: {
+            enableRichTextRelationship: false
+        },
+        hooks: __assign({ beforeChange: __spreadArray([
+                function (data) { return (0, createCharge_1.default)(data, formConfig); },
+                function (data) { return (0, sendEmail_1.default)(data, formConfig); }
+            ], ((_d = (_c = formConfig === null || formConfig === void 0 ? void 0 : formConfig.formSubmissionOverrides) === null || _c === void 0 ? void 0 : _c.hooks) === null || _d === void 0 ? void 0 : _d.beforeChange) || [], true) }, ((_e = formConfig === null || formConfig === void 0 ? void 0 : formConfig.formSubmissionOverrides) === null || _e === void 0 ? void 0 : _e.hooks) || {}),
+        fields: __spreadArray([
+            {
+                name: 'form',
+                type: 'relationship',
+                relationTo: 'forms',
+                required: true,
+                admin: {
+                    readOnly: true
+                },
+            },
+            {
+                name: 'submissionData',
+                type: 'array',
+                admin: {
+                    readOnly: true
+                },
+                fields: [
+                    {
+                        name: 'field',
+                        type: 'text',
+                        required: true,
+                    },
+                    {
+                        name: 'value',
+                        type: 'text',
+                        required: true,
+                        validate: function (value) {
+                            // TODO:
+                            // create a validation function that dynamically
+                            // relies on the field type and its options as configured.
+                            // How to access sibling data from this field?
+                            // Need the `name` of the field in order to validate it.
+                            // Might not be possible to use this validation function.
+                            // Instead, might need to do all validation in a `beforeValidate` collection hook.
+                            if (typeof value !== 'undefined') {
+                                return true;
+                            }
+                            return 'This field is required.';
+                        },
+                    },
+                ],
+            }
+        ], ((_f = formConfig === null || formConfig === void 0 ? void 0 : formConfig.formSubmissionOverrides) === null || _f === void 0 ? void 0 : _f.fields) || [], true),
+    };
+    var paymentFieldConfig = (_g = formConfig === null || formConfig === void 0 ? void 0 : formConfig.fields) === null || _g === void 0 ? void 0 : _g.payment;
+    if (paymentFieldConfig) {
+        newConfig.fields.push({
+            name: 'payment',
+            type: 'group',
+            admin: {
+                readOnly: true
+            },
+            fields: [
+                {
+                    name: 'field',
+                    label: 'Field',
+                    type: 'text'
+                },
+                {
+                    name: 'status',
+                    label: 'Status',
+                    type: 'text'
+                },
+                {
+                    name: 'amount',
+                    type: 'number',
+                    admin: {
+                        description: 'Amount in cents'
+                    }
+                },
+                {
+                    name: 'paymentProcessor',
+                    type: 'text',
+                },
+                {
+                    name: 'creditCard',
+                    label: 'Credit Card',
+                    type: 'group',
+                    fields: [
+                        {
+                            name: 'token',
+                            label: 'token',
+                            type: 'text'
+                        },
+                        {
+                            name: 'brand',
+                            label: 'Brand',
+                            type: 'text'
+                        },
+                        {
+                            name: 'number',
+                            label: 'Number',
+                            type: 'text'
+                        }
+                    ]
+                }
+            ]
+        });
+    }
+    return newConfig;
+};
+exports.generateSubmissionCollection = generateSubmissionCollection;
+//# sourceMappingURL=index.js.map

package/dist/collections/FormSubmissions/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/collections/FormSubmissions/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAEA,gEAA0C;AAC1C,sEAAgD;AAEhD,+CAA+C;AACxC,IAAM,4BAA4B,GAAG,UAAC,UAAsB;;IACjE,IAAM,SAAS,GAAqB;QAClC,IAAI,EAAE,CAAA,MAAA,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAE,uBAAuB,0CAAE,IAAI,KAAI,iBAAiB;QACpE,MAAM,aACJ,MAAM,EAAE,cAAM,OAAA,IAAI,EAAJ,CAAI,EAClB,MAAM,EAAE,cAAM,OAAA,KAAK,EAAL,CAAK,EACnB,IAAI,EAAE,UAAC,EAAiB;oBAAR,IAAI,cAAA;gBAAS,OAAA,CAAC,CAAC,IAAI;YAAN,CAAM,IAChC,CAAA,MAAA,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAE,uBAAuB,0CAAE,MAAM,KAAI,EAAE,CACrD;QACD,KAAK,EAAE;YACL,0BAA0B,EAAE,KAAK;SAClC;QACD,KAAK,aACH,YAAY;gBACV,UAAC,IAAI,IAAK,OAAA,IAAA,sBAAY,EAAC,IAAI,EAAE,UAAU,CAAC,EAA9B,CAA8B;gBACxC,UAAC,IAAI,IAAK,OAAA,IAAA,mBAAS,EAAC,IAAI,EAAE,UAAU,CAAC,EAA3B,CAA2B;eAClC,CAAA,MAAA,MAAA,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAE,uBAAuB,0CAAE,KAAK,0CAAE,YAAY,KAAI,EAAE,WAEhE,CAAA,MAAA,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAE,uBAAuB,0CAAE,KAAK,KAAI,EAAE,CACpD;QACD,MAAM;YACJ;gBACE,IAAI,EAAE,MAAM;gBACZ,IAAI,EAAE,cAAc;gBACpB,UAAU,EAAE,OAAO;gBACnB,QAAQ,EAAE,IAAI;gBACd,KAAK,EAAE;oBACL,QAAQ,EAAE,IAAI;iBACf;aACF;YACD;gBACE,IAAI,EAAE,gBAAgB;gBACtB,IAAI,EAAE,OAAO;gBACb,KAAK,EAAE;oBACL,QAAQ,EAAE,IAAI;iBACf;gBACD,MAAM,EAAE;oBACN;wBACE,IAAI,EAAE,OAAO;wBACb,IAAI,EAAE,MAAM;wBACZ,QAAQ,EAAE,IAAI;qBACf;oBACD;wBACE,IAAI,EAAE,OAAO;wBACb,IAAI,EAAE,MAAM;wBACZ,QAAQ,EAAE,IAAI;wBACd,QAAQ,EAAE,UAAC,KAAc;4BACvB,QAAQ;4BACR,gDAAgD;4BAChD,0DAA0D;4BAE1D,8CAA8C;4BAC9C,wDAAwD;4BAExD,yDAAyD;4BACzD,kFAAkF;4BAElF,IAAI,OAAO,KAAK,KAAK,WAAW,EAAE;gCAChC,OAAO,IAAI,CAAC;6BACb;4BAED,OAAO,yBAAyB,CAAC;wBACnC,CAAC;qBACF;iBACF;aACF;WACE,CAAA,MAAA,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAE,uBAAuB,0CAAE,MAAM,KAAI,EAAE,OACrD;KACF,CAAC;IAEF,IAAM,kBAAkB,GAAG,MAAA,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAE,MAAM,0CAAE,OAAO,CAAC;IAEvD,IAAI,kBAAkB,EAAE;QACtB,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC;YACpB,IAAI,EAAE,SAAS;YACf,IAAI,EAAE,OAAO;YACb,KAAK,EAAE;gBACL,QAAQ,EAAE,IAAI;aACf;YACD,MAAM,EAAE;gBACN;oBACE,IAAI,EAAE,OAAO;oBACb,KAAK,EAAE,OAAO;oBACd,IAAI,EAAE,MAAM;iBACb;gBACD;oBACE,IAAI,EAAE,QAAQ;oBACd,KAAK,EAAE,QAAQ;oBACf,IAAI,EAAE,MAAM;iBACb;gBACD;oBACE,IAAI,EAAE,QAAQ;oBACd,IAAI,EAAE,QAAQ;oBACd,KAAK,EAAE;wBACL,WAAW,EAAE,iBAAiB;qBAC/B;iBACF;gBACD;oBACE,IAAI,EAAE,kBAAkB;oBACxB,IAAI,EAAE,MAAM;iBACb;gBACD;oBACE,IAAI,EAAE,YAAY;oBAClB,KAAK,EAAE,aAAa;oBACpB,IAAI,EAAE,OAAO;oBACb,MAAM,EAAE;wBACN;4BACE,IAAI,EAAE,OAAO;4BACb,KAAK,EAAE,OAAO;4BACd,IAAI,EAAE,MAAM;yBACb;wBACD;4BACE,IAAI,EAAE,OAAO;4BACb,KAAK,EAAE,OAAO;4BACd,IAAI,EAAE,MAAM;yBACb;wBACD;4BACE,IAAI,EAAE,QAAQ;4BACd,KAAK,EAAE,QAAQ;4BACf,IAAI,EAAE,MAAM;yBACb;qBACF;iBACF;aACF;SACF,CAAC,CAAA;KACH;IAED,OAAO,SAAS,CAAC;AACnB,CAAC,CAAA;AAhIY,QAAA,4BAA4B,gCAgIxC"}

package/dist/collections/Forms/DynamicFieldSelector.d.ts

@@ -0,0 +1,3 @@
+import React from 'react';
+import { TextField } from 'payload/dist/fields/config/types';
+export declare const DynamicFieldSelector: React.FC<TextField>;