Skip to content

Beautiful Open-Source Form Builder

5.7 KB
Raw Blame
import clonedeep from 'clone-deep'
import { isReadonly } from 'vue'
import { generateUUID } from "../../lib/utils.js"
export const DEFAULT_COLOR = '#3B82F6'

// Apply these before taking an editor's clean snapshot as well as on mount.
export function applyEditorFieldDefaults(properties) {
  return properties.map((field) => {
    field.placeholder = field.placeholder || null
    field.prefill = field.prefill || null
    field.help = field.help || null
    field.help_position = field.help_position || 'below_input'
    return field
  })
}

// Settings panels add these values on mount. Include them in the clean baseline.
export function applyEditorSettingsDefaults(formData) {
  const defaults = {
    seo_meta: { page_title: null, page_description: null, page_thumbnail: null, page_favicon: null },
    analytics: { provider: null, tracking_id: null },
    translations: {},
  }
  for (const [key, values] of Object.entries(defaults)) {
    const current = formData[key]
    formData[key] = { ...values, ...(current && typeof current === 'object' && !Array.isArray(current) ? current : {}) }
  }
  return formData
}

export const initForm = (defaultValue = {}, withDefaultProperties = false) => {
  return useForm({
    title: "Contact Form",
    visibility: "public",
    workspace_id: null,
    properties: withDefaultProperties ? getDefaultProperties() : [],

    // Customization
    presentation_style: 'classic',
    language: 'en',
    font_family: null,
    theme: "default",
    width: "centered",
    layout_rtl: false,
    dark_mode: "auto",
    color: DEFAULT_COLOR,
    no_branding: false,
    uppercase_labels: false,
    transparent_background: false,
    closes_at: null,
    closed_text:
      "This form has now been closed by its owner and does not accept submissions anymore.",
    auto_save: true,
    auto_focus: true,
    border_radius: 'small',
    size: 'md',

    // Submission
    submit_button_text: null,
    re_fillable: false,
    re_fill_button_text: null,
    submitted_text:
      "Amazing, we saved your answers. Thank you for your time and have a great day!",
    use_captcha: false,
    captcha_provider: 'recaptcha',
    max_submissions_count: null,
    max_submissions_reached_text:
      "This form has now reached the maximum number of allowed submissions and is now closed.",
    submission_retention_value: null,
    submission_retention_unit: null,
    editable_submissions_button_text: "Edit submission",
    confetti_on_submission: false,

    // Security & Privacy
    can_be_indexed: true,

    // Custom SEO
    seo_meta: {},
    
    // Settings for various features
    settings: {},

    ...defaultValue,
  })
}

function getDefaultProperties() {
  return [
    {
      type: "nf-text",
      content: "<h1>Contact Form</h1><p>Please fill out this form to contact us.</p>",
      name: "Title",
      id: generateUUID(),
    },
    {
      name: "Name",
      type: "text",
      hidden: false,
      required: true,
      placeholder: "Enter your full name",
      id: generateUUID(),
    },
    {
      name: "Email",
      type: "email",
      hidden: false,
      placeholder: "Enter your email address",
      id: generateUUID(),
    },
    {
      name: "Message",
      type: "text",
      hidden: false,
      multi_lines: true,
      placeholder: "Type your message here",
      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',
    uppercase_labels: false,
    no_branding: false,
    transparent_background: false,
    submit_button_text: null,
    confetti_on_submission: false,
    show_progress_bar: false,
    bypass_success_page: false,
    can_be_indexed: true,
    use_captcha: false,
    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
    }
  }

  // Entries that are not objects cannot represent form blocks. Discarding
  // them prevents legacy malformed data from breaking the editor while real
  // blocks remain available for localized validation.
  const properties = Array.isArray(filledFormData.properties) ? filledFormData.properties : []
  filledFormData.properties = properties.filter(property => {
    return property !== null && typeof property === 'object' && !Array.isArray(property)
  })

  // Ensure settings object exists and is a plain object (not a readonly proxy)
  ensureSettingsObject(filledFormData)

  return filledFormData
}

/**
 * Ensures the settings object exists and is a writable plain object.
 * This is crucial for reactive forms where settings might be undefined or a readonly proxy.
 * 
 * @param {Object} formData - The form data object
 */
export function ensureSettingsObject(formData) {
  if (!formData) return
  
  const s = formData.settings
  if (!s || typeof s !== 'object' || Array.isArray(s)) {
    formData.settings = {}
  } else if (Object.isFrozen(s) || !Object.isExtensible(s) || isReadonly(s)) {
    // If settings is readonly/frozen, create a new writable copy
    formData.settings = { ...s }
  }
}