Beautiful Open-Source Form Builder
import { useQueryClient, useQuery, useMutation } from '@tanstack/vue-query'
import { computed, toValue } from 'vue'
import { formsApi } from '~/api/forms'
import { useIsAuthenticated } from '~/composables/useIsAuthenticated.js'
import { useFormsListCache } from './useFormsList'
export function useForms() {
const nuxtApp = useNuxtApp()
const queryClient = useQueryClient()
const { isAuthenticated } = useIsAuthenticated()
const formsListCache = useFormsListCache()
const detailKey = (scope, slug) => ['forms', scope, 'slug', slug]
const detailByIdKey = (scope, id) => ['forms', scope, id]
const scopeFor = (usePrivate) => usePrivate ? 'private' : 'public'
const isQueryEnabled = (id, optionEnabled, usePrivate) => computed(() => {
return !!toValue(id) && !!toValue(optionEnabled) && (!usePrivate || isAuthenticated.value)
})
const detail = (slug, options = {}) => {
const { usePrivate = false, enabled = true, requestOptions = {}, ...queryOptions } = options
const scope = scopeFor(usePrivate)
return useQuery({
queryKey: detailKey(scope, slug),
queryFn: () => nuxtApp.runWithContext(() => {
if (usePrivate) {
return formsApi.get(slug, requestOptions)
}
return formsApi.publicGet(slug, requestOptions)
}),
enabled: isQueryEnabled(slug, enabled, usePrivate),
onSuccess: (form) => {
if (form) {
queryClient.setQueryData(['forms', form.id], form)
queryClient.setQueryData(detailKey(scope, form.slug), form)
}
},
...queryOptions,
})
}
const detailById = (id, options = {}) => {
const { usePrivate = false, enabled = true, ...queryOptions } = options
const scope = scopeFor(usePrivate)
return useQuery({
queryKey: detailByIdKey(scope, id),
queryFn: () => {
if (usePrivate) {
return formsApi.getById(toValue(id), queryOptions)
}
return formsApi.publicGetById(toValue(id), queryOptions)
},
enabled: isQueryEnabled(id, enabled, usePrivate),
onSuccess: (form) => {
if (form) {
queryClient.setQueryData(['forms', form.id], form)
queryClient.setQueryData(detailByIdKey(scope, form.id), form)
queryClient.setQueryData(detailKey(scope, form.slug), form)
}
},
...queryOptions,
})
}
// Form Mutations
const create = (options = {}) => {
return useMutation({
mutationFn: (data) => formsApi.create(data),
onSuccess: (response) => {
const newForm = response.form
formsListCache.add(newForm.workspace_id, newForm)
// Cache the new form
queryClient.setQueryData(['forms', newForm.id], newForm)
queryClient.setQueryData(detailKey('private', newForm.slug), newForm)
},
...options
})
}
const update = (formId, options = {}) => {
return useMutation({
mutationFn: (data) => formsApi.update(toValue(formId), data),
onSuccess: (updatedForm) => {
const form = updatedForm.form
const currentFormId = toValue(formId)
// Update individual form cache
queryClient.setQueryData(['forms', currentFormId], form)
if (form.slug) {
queryClient.setQueryData(detailKey('private', form.slug), form)
}
// Update in workspace lists
formsListCache.update(form.workspace_id, form)
},
...options
})
}
const remove = (options = {}) => {
return useMutation({
mutationFn: (id) => formsApi.delete(id),
onSuccess: (_, deletedId) => {
const deletedForm = queryClient.getQueryData(['forms', deletedId])
if (!deletedForm) return
invalidateDetail(deletedForm)
// Remove from workspace lists
formsListCache.remove(deletedForm.workspace_id, deletedId)
},
...options
})
}
const duplicate = (options = {}) => {
return useMutation({
mutationFn: (id) => formsApi.duplicate(id),
onSuccess: (response) => {
const duplicatedForm = response.new_form
// Add to workspace forms list
formsListCache.add(duplicatedForm.workspace_id, duplicatedForm)
// Cache the duplicated form
queryClient.setQueryData(['forms', duplicatedForm.id], duplicatedForm)
queryClient.setQueryData(detailKey('private', duplicatedForm.slug), duplicatedForm)
},
...options
})
}
const regenerateLink = (options = {}) => {
return useMutation({
mutationFn: ({ id, option, data }) => formsApi.regenerateLink(id, option, data),
onSuccess: (updatedForm, { id }) => {
queryClient.setQueryData(['forms', id], (old) => {
return old ? { ...old, ...updatedForm } : updatedForm
})
if (updatedForm.slug) {
queryClient.setQueryData(detailKey('private', updatedForm.slug), (old) => {
return old ? { ...old, ...updatedForm } : updatedForm
})
}
},
...options
})
}
const updateWorkspace = (options = {}) => {
return useMutation({
mutationFn: ({ id, workspaceId, data }) => formsApi.updateWorkspace(id, workspaceId, data),
onSuccess: (updatedForm, { id, workspaceId: newWorkspaceId }) => {
const oldForm = queryClient.getQueryData(['forms', id])
const oldWorkspaceId = oldForm?.workspace_id
// Update form cache
queryClient.setQueryData(['forms', id], updatedForm)
if (updatedForm.slug) {
queryClient.setQueryData(detailKey('private', updatedForm.slug), updatedForm)
}
// Remove from old workspace list
if (oldWorkspaceId) {
formsListCache.remove(oldWorkspaceId, id)
}
// Add to new workspace list
formsListCache.add(newWorkspaceId, updatedForm)
},
...options
})
}
// Asset Upload Mutation
const uploadAsset = (options = {}) => {
return useMutation({
mutationFn: (data) => formsApi.assets.upload(data, options),
...options
})
}
// Zapier Webhook Mutations
const createZapierWebhook = (options = {}) => {
return useMutation({
mutationFn: (data) => formsApi.zapier.store(data),
...options
})
}
const deleteZapierWebhook = (options = {}) => {
return useMutation({
mutationFn: (id) => formsApi.zapier.delete(id),
...options
})
}
const invalidateAll = () => {
queryClient.removeQueries({ queryKey: ['forms', 'list'], exact: false })
}
const invalidateDetail = (form) => {
if (form.id) {
queryClient.removeQueries({ queryKey: ['forms', form.id] })
queryClient.removeQueries({ queryKey: detailByIdKey('public', form.id) })
queryClient.removeQueries({ queryKey: detailByIdKey('private', form.id) })
}
if (form.slug) {
queryClient.removeQueries({ queryKey: detailKey('public', form.slug) })
queryClient.removeQueries({ queryKey: detailKey('private', form.slug) })
}
}
return {
// Queries
detail,
detailById,
// Form Mutations
create,
update,
remove,
duplicate,
regenerateLink,
updateWorkspace,
// Other Mutations
uploadAsset,
createZapierWebhook,
deleteZapierWebhook,
// Utilities
invalidateAll,
invalidateDetail
}
}