# Changelog

# 4.1.16 2024-04-04

# Changes

• Updated the CSRF input to send nocache headers when rendering.

# Fixes

• Fixed a bug where Freeform was opening unnecessary sessions.

# 4.1.15.1 2024-03-01

# Fixes

• Fixed a bug where Automatic Spam Purge Craft queue jobs would fail when using a database prefix.

# 4.1.15 2024-03-01

# Additions

• Added support for Automatic Spam Purging in the Lite edition of Freeform.

# Changes

• Refactored the Submission Purge functionality to use the Craft queue.

# Fixes

• Fixed a bug where the Fill Form Values from the GET Query String setting was not being respected.

# 4.1.14 2024-02-09

# Fixes

• Fixed a bug where Dynamic Recipients fields were not correctly selecting the option chosen when viewing submissions in the CP detail page.
• Fixed a bug where the Field Manager would force camelCase without exceptions for field handles.

# 4.1.13 2023-11-23

# Changes

• Updated all references to field names in the control panel and exported files to use the default field label as a fallback if the field label is blank in the form settings. To preserve legacy functionality, rendering forms on the front end will continue showing the field label blank.

# 4.1.12.1 2023-11-15

# Fixes

• Fixed a bug where some Freeform widgets would error in the Craft dashboard due to a change in the previous version (4.1.12).

# 4.1.12 2023-11-09

# Changes

• Updated GraphQL mutations to support multiple email marketing mailing list fields.

# Fixes

• Fixed an issue where submission purge logic was not always working reliably.
• Fixed a bug where form heading Success and Error messages were not being escaped.
• Fixed a bug where removing a field from a form was not automatically removing it from any configured export profiles for that form.

# 4.1.11 2023-10-24

# Changes

• Updated the GraphQL submission mutation to no longer require the custom header.

# Fixes

• Fixed a bug where locales were not working correctly when using more than one Date & Time field in the same form.

# 4.1.10 2023-10-05

# Changes

• Updated File Upload fields to be realigned with Craft's file kind/extensions defaults. Removed the custom Freeform MIME type checks.
• Updated existing feature announcement integrations to be visible to Admins only.

# 4.1.9 2023-09-29

# Changes

• Updated the Salesforce integration to allow mapping to encrypted fields in Salesforce.
• Updated the Craft compatibility check in the Diagnostics page to include Craft 4.5.x.

# Fixes

• Fixed a bug where hCaptcha was not working correctly.

# 4.1.8 2023-09-15

# Changes

• Updated stripe/stripe-php dependency to align with Craft Commerce.
• Updated the Stripe Payments integration to support mapping Phone field types.

# 4.1.7 2023-09-08

# Additions

• Added support for .stl files in the Freeform file helper validation.

# Changes

• Updated the Pipedrive Leads integration to use the new Notes endpoint.

# Fixes

• Fixed a bug where not all Stripe validation errors were accounted for and could cause the form to break.
• Fixed a bug where CRM integration errors were sometimes too long to be logged in Freeform. Updated the column size to resolve this.

# 4.1.6 2023-07-20

# Additions

• Exposed all remaining form settings/properties for GraphQL queries, including successMessage and errorMessage.

# Changes

• Refactored the Freeform lock service to use Yii's cache to prevent performance issues.

# Fixes

• Fixed issues with reCAPTCHA when querying forms via GraphQL.

# 4.1.5 2023-07-11

# Additions

• Added conditional rule logic for form fields in GraphQL.

# 4.1.4 2023-07-05

# Additions

• Added support for mapping to multiple groups/interests in the Mailchimp integration.

# Fixes

• Fixed a bug where the element query was being executed before Craft was fully initialized.

# 4.1.3 2023-06-28

# Fixes

• Fixed a bug where server-side field validation error messages were replaced with a GraphQL query error in production mode.

# 4.1.2 2023-06-26

# Fixes

• Fixed a bug where forms using reCAPTCHA v2 Checkbox or hCaptcha Checkbox could behave incorrectly.

# 4.1.1 2023-06-22

# Changes

• Updated the Diagnostics page to still show when the allowAdminChanges setting is set to false.

# Fixes

• Fixed a bug where the Submission Purge console commands were not working correctly.
• Fixed a bug where the Submission Purge feature was not removing associated Asset files as well.
• Fixed a bug where an error would occur when dynamically creating a sub-directory for file uploads upon submission of form.

# 4.1.0 2023-06-13

# Additions

• Added support for GraphQL Mutations.
• Added interactive demos for Vue.js, React JS, and Next.js frameworks.

# Changes

• Changed the way reCAPTCHA is handled in headless setups.

# Deprecations

• Deprecated FormInterface for GraphQL. Please use FreeformFormInterface instead.
• Deprecated FieldInterface for GraphQL. Please use FreeformFieldInterface instead.
• Deprecated PageInterface for GraphQL. Please use FreeformPageInterface instead.
• Deprecated RowInterface for GraphQL. Please use FreeformRowInterface instead.
• Deprecated OptionsInterface for GraphQL. Please use FreeformOptionInterface instead.
• Deprecated ScalesInterface for GraphQL. Please use FreeformOpinionScaleInterface instead.
• Deprecated KeyValueMapInterface for GraphQL. Please use FreeformAttributeInterface instead.
• Deprecated hash and timestamp in FreeformHoneypotInterface for GraphQL. Please do not use.

# 4.0.26 2023-06-12

# Fixes

• Fixed a bug that could cause issues when using the JS Honeypot enhancement.
• Fixed a bug where an error would sometimes occur when opening the Diagnostics page.

# 4.0.25 2023-06-05

# Fixes

• Fixed a bug where the Field Values Chart widget would error when attempting to add to the dashboard.

# 4.0.24.1 2023-05-18

# Fixes

• Fixed a bug where an error would occur when attempting to submit a form that has the "Store Submission Data" setting disabled on sites using the Freeform 4.0.24 version.

# 4.0.24 2023-05-16

# Additions

• Added the ability to limit forms to be submitted once per email address only.
• Added a setting to the Mailchimp integration to allow choosing between appending existing Contact Tags with new ones when updating an existing contact.

# Fixes

• Fixed a bug where attempting to Allow a spam submission for a Payment form would result in an error.

# 4.0.23 2023-04-28

# Additions

• Added the ability to map submission data to postDate and expiryDate for Craft Entries.
• Added the ability to preparse Twig for the "Predefined Assets" setting in email notification templates. This allows for things like dynamically attaching an asset to the email notification based on a user's selection, etc.

# Changes

• Updated Freeform template path settings to now include template folder autosuggestions.

# Fixes

• Fixed a bug where the hidden input for File Upload Drag & Drop fields was not getting an ID attribute applied to it.
• Fixed some minor issues with demo templates.

# 4.0.22 2023-04-14

# Additions

• Added a "Floating Labels" basic formatting template. Ready-to-go and does not require any frameworks or toolkits.
• Added support for dwg, dxf, stp, step, sia mime types in Freeform's internal file validation helper.

# Changes

• Overhauled and refreshed demo templates area. Easily try on a wide range of sample formatting templates for your forms, view submission data, check out advanced setups, etc.

# Fixes

• Fixed a bug where the Submission and Spam Purge features were not always working correctly.
• Fixed a few minor styling issues in most of the sample formatting templates.

# 4.0.21 2023-03-29

# Fixes

• Fixed a bug where the Honeypot could trigger an unserialization error in some cases.

# 4.0.20 2023-03-23

# Changes

• Updated the JS Honeypot Enhancement feature to use the encrypted payload instead of PHP sessions when the 'Form Session Context' setting is 'Encrypted Payload'.
• Various improvements and adjustments to the Basic Light and Dark example formatting template examples.

# Fixes

• Fixed a bug where the Constant Contact integration could timeout when connecting if there were too many lists.

# 4.0.19 2023-03-21

# Additions

• Added two basic formatting template examples (dark and light modes) that are self-contained and complete to be added to any page. Does not require any frameworks or toolkits.
• Added setup guides directly into API integration settings pages.

# Changes

• Updated the form_posted cookie to only be created for users if a form uses a cookie check for limiting how many times a user can submit the form.

# 4.0.18 2023-03-10

# Changes

• Addressed some minor Craft 4.4 compatibility issues in the control panel.
• Made some minor adjustments to the CP Submission detail view.
• Improved Dutch (NL) language translations.

# Fixes

• Fixed a bug where the "Email Template" dropdowns in the form builder displayed both Database and File groups even if just one was selected.

# 4.0.17 2023-03-01

# Additions

• Added support for .eps files in the Freeform file helper validation.
• Added support for .webp files in the Freeform file helper validation.

# Changes

• Updated English and Dutch (NL) translations to include all missing items.
• Updated default Freeform formatting templates to no longer include lineHeight for Stripe fields.
• Updated Signature field data to be included in exports.

# Fixes

• Fixed a bug where many items were not translatable in the Freeform control panel.
• Fixed a bug where using "Database Tables" for session storage context would result in an error when submitting forms.
• Fixed a bug where some migrations and integrations could error when using Guzzle JSON calls.

# 4.0.16 2023-02-23

# Fixes

• Fixed a bug where an erroneous database index existed for email marketing integrations that would sometimes cause an error.

# 4.0.15 2023-02-14

# Additions

• Added an example Conversational style formatting template that displays one field at a time and smoothly scrolls down to the next question until complete.

# Fixes

• Fixed a bug where AJAX errors were not displaying correctly for Opinion Scale and Table fields.

# 4.0.14 2023-02-08

# Fixes

• Fixed a bug where unfinalized files were not immediately being cleared upon successful submit of forms that are set not to store submission data.
• Fixed a bug where POST Forwarding was not being triggered when approving submissions in the Spam Folder.
• Fixed a bug where the initHoneypot function was triggering error warnings about premature initiation.
• Fixed a bug where Multi-Select fields were missing some styles inside the form builder.

# 4.0.13 2023-01-26

# Fixes

• Fixed a bug where single checkboxes were always being checked by default (as of 4.0.11).
• Fixed a bug where custom table attributes were firing on all element types.

# 4.0.12 2023-01-25

# Additions

• Added additional data to the AJAX submit response payload for multi-page forms.
• Added an example Bootstrap 5 formatting template that includes a preview/review of all fields across all pages.

# 4.0.11 2023-01-19

# Fixes

• Fixed a bug where the opt-in data storage checkbox was not saving submission data when checked.
• Fixed a bug where Dynamic Recipient fields would not export with labels when the "Use Option Labels when Exporting" setting was enabled.

# 4.0.10 2023-01-17

# Fixes

• Fixed a bug where the "Once per logged in Users only" option for duplicate checking wasn't preventing guests from submitting the form.
• Fixed a bug where extra returns were being inserted above H2s inside Rich Text fields (in the builder) when they were clicked on.
• Fixed a bug where deleting a spam submission from the CP detail view was not working.

# 4.0.9 2022-12-09

# Additions

• Added back Excel support for exporting submissions.
• Added submissionLimitReached to the Form object, allowing you to check if the user has already submitted the form when using the Limit Form Submission Rate setting (hide form and/or display an error message to the user instead of waiting until they attempt to submit the form).

# Changes

• Updated to only load reCAPTCHA scripts when form(s) have reCAPTCHA enabled.
• Updated to support Craft's sameSiteCookieValue.

# Fixes

• Fixed a bug where the Submissions/Spam CP index includes an "Edit Submission" option that isn't usable.

# 4.0.8 2022-11-21

# Changes

• Refactored the submission delete process to use batching.

# Fixes

• Fixed a bug where links to view/edit individual submissions in the CP disappeared in Craft 4.3.2+.
• Fixed a bug where the Freeform Form element field type was not sorting form options alphabetically.
• Fixed a bug where email notifications were sometimes not being fetched when fetched by handle.
• Fixed a bug where two sets of "set status" actions would appear in CP submissions index.
• Fixed a bug where fetching existing tags for the ActiveCampaign integration was not working correctly.

# 4.0.7 2022-10-25

# Additions

• Verified compatibility with Craft 4.3.

# Fixes

• Fixed a bug where database notification templates were not being loaded properly in the form builder.
• Fixed a bug where a warning was output in the Craft logs when loading dashboard widgets.
• Fixed a bug where the "All Submissions" filter in Submissions and Spam Folder CP indexes would crash when there were more than 60 forms present.

# 4.0.6 2022-10-12

# Additions

• Added a "Floating Labels" version of the Bootstrap 5 example formatting template.

# Fixes

• Fixed a bug where garbage collection was not working on Freeform submissions.
• Fixed a bug where the "Send Additional Notification" feature was not working correctly.
• Fixed a bug where searching freeform.submissions across multiple forms was not working correctly.

# 4.0.5 2022-10-05

# Additions

• Added success events for AJAX forms with redirect-to-url behavior.

# Fixes

• Fixed a bug that would prevent some integrations with OAuth 2.0 from being able to authorize.
• Fixed a bug where the Email Template dropdown select in the form builder would not show all templates if using a mix of database and file templates.
• Fixed a bug where users could create file-based email notification templates in the form builder when the setting for it is disabled.
• Fixed a bug where using the back button in multi-page forms could potentially cause issues when using default browser validation.

# 4.0.4 2022-09-28

# Additions

• Added a setting to disable the creating and editing of File-based email notification templates.

# Changes

• Updated the AJAX response payload to include posted values.

# Fixes

• Fixed a bug where attempting to create a new status would not work.
• Fixed a bug where some field types would not correctly store updates with empty values in multi-page forms.
• Fixed a bug where users without permissions to Freeform could add Freeform widgets to the Craft dashboard.
• Fixed a bug where the form reserved keyword was being allowed for field handles.

# 4.0.3 2022-09-12

# Changes

• Updated the Google Tag Manager event to include the AJAX response.

# Fixes

• Fixed a race condition issue where loading values when editing an element would sometimes not work.
• Fixed a bug where duplicating forms could cause an error when more than one user group has permission to manage it.
• Fixed a bug where the Tailwind 3 sample formatting template was not including custom input attributes when rendering Select fields.

# 4.0.2 2022-08-24

# Fixes

• Fixed a bug where non-latin characters were being allowed in field handles in the field manager area.
• Fixed a bug where predefined assets in email notifications showed a full file path instead of just the filename.
• Fixed a bug where multiple instances of the same form are added when moving the form instance around the DOM.

# 4.0.1 2022-08-23

# Additions

• Added a v3 version of the Tailwind example formatting template.
• Added a new version of the HubSpot API integration to address new Private App token requirement. This is a required change for any existing HubSpot users.

# Changes

• Updated the Campaign third party plugin email marketing integration to use new FormsService::createAndSubscribeContact method.

# Fixes

• Fixed a bug where attempting to sort submissions in the CP submissions index page was not working.
• Fixed a bug where non-latin characters were being allowed in field and form handles.
• Fixed a bug where attempting to view a related Freeform submission element in the slideout in another element could error.
• Fixed a bug where attempting to attach a Predefined Asset to an email notification template would give an Internal server error.

# 4.0.0 2022-08-05

# Additions

• Added compatibility with Craft 4.x.
• Added Export Email Notifications feature. Allows you to send exports as email notifications automatically.
• Added more information to email notification error logging. It now includes the email notification approach and the Email field name (if applicable) to track down where the issue is coming from.
• Added setting to have CSV exports use field handles for headings instead of field labels.
• Added support for permanently deleting soft-deleted submissions.
• Added data-skip-html-reload form attribute option to bypass HTML reload for AJAX forms (when not using render method).
• Added EVENT_GET_CUSTOM_PROPERTY developer event, which lets you inject your own properties on forms to expand their application.
• Added EVENT_CONFIGURE_CORS developer event, which lets you modify the CORS headers that will be sent with the request.
• Added a check in the diagnostics, install welcome screen, and settings pages to alert users if the "Freeform Script Insert Type" setting will not work as Static URLs (and needs to be switched to Files).
• Added the ability to map Mailchimp Interests to a form field. Limited to finding and passing a single Interest based on first match within Interest names part of a List.
• Added support for date fields in the Campaign Monitor integration.

# Changes

• Changed all existing forms with the Success Behavior setting set to No Effect to now be Reload Form with Success Message. This will behave somewhat similarly to old behavior, but will no longer automatically redirect to a different URL upon success. Please review all forms and set the desired behavior for each in the Success Behavior setting. If you wish to continue to override the behavior at template level, you can do that as well.
• Changed all sample formatting templates to include a library version number on them and also end with the .twig extension (e.g. foundation.html is now foundation-6.twig). Freeform 4 will automatically migrate all existing forms using sample formatting templates to use the new file names. You shouldn't need to change anything. Where this might become an issue is if you are using the formattingTemplate: 'template-name.html' parameter at template level and relying on an older version of the sample template name.
• Changed all sample formatting templates use |t('freeform') only (instead of a mix of |t and |t('freeform')). If you're using static translations on sample formatting templates, you'll need to move site.php translations over to freeform.php.
• Changed the rendering of single checkboxes to now use the value set inside the form builder. No action should be necessary here. If you have a custom module in place to override this behavior, you can likely undo that now.
• Changed Email fields to no longer store data as an array. The migration will comb through your database and convert all values of Email field types (e.g. ["test@x.x"] will become test@x.x). If you were relying on this feature to collect more than one email address, only the first email address will be kept (e.g. ["a@x.x","b@x.x"] will become a@x.x). No action is necessary here, but if you relied on this functionality, it is a breaking change with no alternative option currently (aside from adding multiple Email fields to your forms, one for each email address). If you have a custom module that is working around this in any way, you should be able to disable it now.
• Updated newly created email notification templates' "From" email address and name to default to the newer way (via Project Config), e.g. craft.app.projectConfig.get('email.fromEmail')). If you are using the older approach in existing email notification templates, be sure to update them.
• Changed the way form submission data is stored. A new table for each form is now created and updated rather than storing all forms' submission data in a single shared database table. This solves several issues, including running out of fields and paves the way for more exciting future improvements to the form builder. Fields are still global and available to every form. No action should be necessary by the admin, as Freeform includes a migration script that automatically converts the data to be split into multiple database tables. This process may take a little longer if you have a very large site.
• All Freeform fields are now stored as the TEXT MySQL type instead of a combination of TEXT, VARCHAR(100) and VARCHAR(255). This is a change that is applied to all existing fields as well since they are recreated in the migration. No action should be necessary here. In the rare case where your site has some kind of customization that relies on a MySQL type other than TEXT, you may have to adjust the database manually.
• Updated Dashboard, Forms listing and Survey & Polls dashboard to hide forms for users that do not have any form or submission access permissions to them.
• Switched over CP scripts to use local copies of external scripts.
• Upgraded the GraphQL interface calls to use the new Craft GraphQL API.
• Updated the "Use Return URL" success behavior to skip reloading the form (briefly) when using AJAX.
• Updated the sample formatting templates to include ff-fieldtype-FIELDTYPE classes to field-surrounding divs.
• Updated league/flysystem, symfony/property-access, symfony/finder and symfony/filesystem dependency version requirements to resolve some conflicts.

# Fixes

• Fixed a bug where POST Forwarding would still send through spammy submissions.
• Fixed a bug where the form builder tutorial would show an error if the allowAdminChanges setting was disabled.
• Fixed a bug where Drag & Drop File Upload fields would not respect all site URL setups.
• Fixed a bug where users with permissions to Create New Forms would encounter issues in the New Form wizard modal.
• Fixed a bug where users without Create New Forms permission would see the New Form button in the CP Forms page.
• Fixed a bug where Number fields with a minimum value above 0 would still allow 0 as a valid value.
• Fixed a bug where an error could sometimes occur on the Form Behavior settings page.
• Fixed a bug with conditional Post Forwarding options check.
• Fixed a bug where the Drag & Drop File Upload field type was requiring a file to be selected even when hidden by the Conditional Rules feature.
• Fixed a bug where the predefined "Yesterday" option for Export Profiles returned yesterday 0:00 until now instead of yesterday 0:00 to 23:59.
• Fixed a bug where the form builder would not show an error message when creating a new notification template if the email notification template directory path was not set.
• Fixed a bug where the Save & Continue Later field was not available in GraphQL schema.
• Fixed a bug where Dynamic Recipient fields would still send email notifications while hidden via Conditional Rules.
• Fixed a bug where uploaded file attachments in email notifications showed a full file path instead of just the filename.
• Fixed a bug where Stripe subscription plan names could possibly show up blank if no price plan description was provided. If so, Freeform will now autogenerate plan names.
• Fixed a bug where the form builder didn't warn that author is a reserved handle name.
• Adjusted the NL translation word for any in the conditional rules feature.
• Fixed a bug where incorrectly including a twig file in the Success Template Directory path would break settings and form builder.
• Fixed a bug where the Stripe Payments integration could be causing a customer as well as guest account in Stripe for the same transaction.
• Fixed a bug where credit card numbers were not showing up in Stripe's payment methods for customer accounts.

# Security

• Addressed some potential XSS vulnerabilities.

# Removals

• Removed the old Pardot CRM and Constant Contact email marketing API integrations. Please switch to the newer Pardot and Constant Contact integrations if you haven't already, and delete the old legacy ones before upgrading to Freeform 4.
• Removed the phpoffice/phpspreadsheet dependency to prevent install conflicts. Excel exporting inside Freeform is temporarily disabled until a new library is implemented.
• Removed the league/flysystem dependency as it is not needed.