opnform-host-nginx/client/composables/forms/initForm.js

131 lines
3.5 KiB
JavaScript
Raw Normal View History

import clonedeep from 'clone-deep'
import { generateUUID } from "~/lib/utils.js"
export const DEFAULT_COLOR = '#3B82F6'
2023-12-20 16:10:32 +01:00
export const initForm = (defaultValue = {}, withDefaultProperties = false) => {
2023-12-20 16:10:32 +01:00
return useForm({
title: "My Form",
visibility: "public",
2023-12-20 16:10:32 +01:00
workspace_id: null,
properties: withDefaultProperties ? getDefaultProperties() : [],
2023-12-20 16:10:32 +01:00
// Customization
language: 'en',
font_family: null,
theme: "default",
width: "centered",
layout_rtl: false,
dark_mode: "auto",
color: DEFAULT_COLOR,
2023-12-20 16:10:32 +01:00
hide_title: false,
no_branding: false,
uppercase_labels: false,
2023-12-20 16:10:32 +01:00
transparent_background: false,
closes_at: null,
closed_text:
"This form has now been closed by its owner and does not accept submissions anymore.",
2023-12-20 16:10:32 +01:00
auto_save: true,
auto_focus: true,
2024-07-01 10:18:35 +02:00
border_radius: 'small',
size: 'md',
2023-12-20 16:10:32 +01:00
// Submission
submit_button_text: "Submit",
2023-12-20 16:10:32 +01:00
re_fillable: false,
re_fill_button_text: "Fill Again",
submitted_text:
"Amazing, we saved your answers. Thank you for your time and have a great day!",
2023-12-20 16:10:32 +01:00
use_captcha: false,
Add reCAPTCHA support and update captcha provider handling (#647) * Add reCAPTCHA support and update captcha provider handling - Introduced reCAPTCHA as an additional captcha provider alongside hCaptcha. - Updated form request validation to handle different captcha providers based on user selection. - Added a new validation rule for reCAPTCHA. - Modified the forms model to include a 'captcha_provider' field. - Created a migration to add the 'captcha_provider' column to the forms table. - Updated frontend components to support dynamic rendering of captcha based on the selected provider. - Enhanced tests to cover scenarios for both hCaptcha and reCAPTCHA. These changes improve the flexibility of captcha options available to users, enhancing form security and user experience. * fix pint * change comment text * Refactor captcha implementation and integrate new captcha components - Removed the old RecaptchaV2 component and replaced it with a new implementation that supports both reCAPTCHA and hCaptcha through a unified CaptchaInput component. - Updated the OpenForm component to utilize the new CaptchaInput for dynamic captcha rendering based on user-selected provider. - Cleaned up the package.json by removing the deprecated @hcaptcha/vue3-hcaptcha dependency. - Enhanced form initialization to set a default captcha provider. - Improved error handling and cleanup for both reCAPTCHA and hCaptcha scripts. These changes streamline captcha integration, improve maintainability, and enhance user experience by providing a more flexible captcha solution. * Refactor captcha error messages and localization support * Refactor registration process to integrate reCAPTCHA - Replaced hCaptcha implementation with reCAPTCHA in RegisterController and related test cases. - Updated validation rules to utilize g-recaptcha-response instead of h-captcha-response. - Modified RegisterForm component to support reCAPTCHA, including changes to the form data structure and component references. - Enhanced test cases to reflect the new reCAPTCHA integration, ensuring proper validation and response handling. These changes improve security and user experience during the registration process by adopting a more widely used captcha solution. * Fix reCAPTCHA configuration and update RegisterForm styling - Corrected the configuration key for reCAPTCHA in RegisterController from 'services.recaptcha.secret_key' to 'services.re_captcha.secret_key'. - Updated the styling of the Captcha input section in RegisterForm.vue to improve layout consistency. These changes ensure proper reCAPTCHA functionality and enhance the user interface during the registration process. * Fix reCAPTCHA configuration in RegisterTest to use the correct key format - Updated the configuration key for reCAPTCHA in RegisterTest from 'services.recaptcha.secret_key' to 'services.re_captcha.secret_key' to ensure proper functionality during tests. This change aligns the test setup with the recent updates in the reCAPTCHA integration, improving the accuracy of the registration process tests. --------- Co-authored-by: Julien Nahum <julien@nahum.net>
2024-12-18 16:35:09 +01:00
captcha_provider: 'recaptcha',
2023-12-20 16:10:32 +01:00
max_submissions_count: null,
max_submissions_reached_text:
"This form has now reached the maximum number of allowed submissions and is now closed.",
editable_submissions_button_text: "Edit submission",
2023-12-20 16:10:32 +01:00
confetti_on_submission: false,
// Security & Privacy
can_be_indexed: true,
// Custom SEO
seo_meta: {},
...defaultValue,
2023-12-20 16:10:32 +01:00
})
}
function getDefaultProperties() {
return [
{
name: "Name",
type: "text",
hidden: false,
required: true,
id: generateUUID(),
},
{
name: "Email",
type: "email",
hidden: false,
id: generateUUID(),
},
{
name: "Message",
type: "text",
hidden: false,
multi_lines: true,
id: generateUUID(),
},
]
}
/**
* Sets default values for form properties if they are not already defined.
* This function ensures that all necessary form fields have a valid initial value,
* which helps maintain consistency and prevents errors due to undefined properties.
*
* @param {Object} formData - The initial form data object
* @returns {Object} A new object with default values applied where necessary
*/
export function setFormDefaults(formData) {
const defaultValues = {
title: 'Untitled Form',
visibility: 'public',
theme: 'default',
width: 'centered',
size: 'md',
border_radius: 'small',
dark_mode: 'light',
color: '#3B82F6',
hide_title: false,
uppercase_labels: false,
no_branding: false,
transparent_background: false,
submit_button_text: 'Submit',
confetti_on_submission: false,
show_progress_bar: false,
bypass_success_page: false,
can_be_indexed: true,
use_captcha: false,
Add reCAPTCHA support and update captcha provider handling (#647) * Add reCAPTCHA support and update captcha provider handling - Introduced reCAPTCHA as an additional captcha provider alongside hCaptcha. - Updated form request validation to handle different captcha providers based on user selection. - Added a new validation rule for reCAPTCHA. - Modified the forms model to include a 'captcha_provider' field. - Created a migration to add the 'captcha_provider' column to the forms table. - Updated frontend components to support dynamic rendering of captcha based on the selected provider. - Enhanced tests to cover scenarios for both hCaptcha and reCAPTCHA. These changes improve the flexibility of captcha options available to users, enhancing form security and user experience. * fix pint * change comment text * Refactor captcha implementation and integrate new captcha components - Removed the old RecaptchaV2 component and replaced it with a new implementation that supports both reCAPTCHA and hCaptcha through a unified CaptchaInput component. - Updated the OpenForm component to utilize the new CaptchaInput for dynamic captcha rendering based on user-selected provider. - Cleaned up the package.json by removing the deprecated @hcaptcha/vue3-hcaptcha dependency. - Enhanced form initialization to set a default captcha provider. - Improved error handling and cleanup for both reCAPTCHA and hCaptcha scripts. These changes streamline captcha integration, improve maintainability, and enhance user experience by providing a more flexible captcha solution. * Refactor captcha error messages and localization support * Refactor registration process to integrate reCAPTCHA - Replaced hCaptcha implementation with reCAPTCHA in RegisterController and related test cases. - Updated validation rules to utilize g-recaptcha-response instead of h-captcha-response. - Modified RegisterForm component to support reCAPTCHA, including changes to the form data structure and component references. - Enhanced test cases to reflect the new reCAPTCHA integration, ensuring proper validation and response handling. These changes improve security and user experience during the registration process by adopting a more widely used captcha solution. * Fix reCAPTCHA configuration and update RegisterForm styling - Corrected the configuration key for reCAPTCHA in RegisterController from 'services.recaptcha.secret_key' to 'services.re_captcha.secret_key'. - Updated the styling of the Captcha input section in RegisterForm.vue to improve layout consistency. These changes ensure proper reCAPTCHA functionality and enhance the user interface during the registration process. * Fix reCAPTCHA configuration in RegisterTest to use the correct key format - Updated the configuration key for reCAPTCHA in RegisterTest from 'services.recaptcha.secret_key' to 'services.re_captcha.secret_key' to ensure proper functionality during tests. This change aligns the test setup with the recent updates in the reCAPTCHA integration, improving the accuracy of the registration process tests. --------- Co-authored-by: Julien Nahum <julien@nahum.net>
2024-12-18 16:35:09 +01:00
captcha_provider: 'recaptcha',
properties: [],
}
const filledFormData = clonedeep(formData)
for (const [key, value] of Object.entries(defaultValues)) {
if (filledFormData[key] === undefined || filledFormData[key] === null || (typeof value === 'string' && filledFormData[key] === '')) {
filledFormData[key] = value
}
}
// Handle required nested properties
if (filledFormData.properties && Array.isArray(filledFormData.properties)) {
filledFormData.properties = filledFormData.properties.map(property => ({
...property,
name: property.name === '' || property.name === null || property.name === undefined ? 'Untitled' : property.name,
}))
}
return filledFormData
}