refactor: replace EditDialog with DashboardCrudFormDialog for companies and quick replies
- Removed the EditDialog component from companies and quick replies. - Integrated DashboardCrudFormDialog to handle form submissions and editing for both entities. - Updated the CompanyPicker to utilize the new form dialog for creating companies. - Introduced DashboardCrudFieldControl for rendering form fields dynamically. - Added utility functions for building form values and normalizing submit values. - Updated tests to cover new form utilities and ensure correct behavior for form submissions.
This commit is contained in:
mlogclub
@@ -4,7 +4,7 @@ import { useEffect, useMemo, useState } from "react"
|
||||
import { ChevronsUpDownIcon, PlusIcon } from "lucide-react"
|
||||
import { toast } from "sonner"
|
||||
|
||||
import { EditDialog as CompanyEditDialog } from "@/app/dashboard/companies/_components/edit"
|
||||
import { DashboardCrudFormDialog } from "@/components/dashboard/crud"
|
||||
import { Button } from "@/components/ui/button"
|
||||
import {
|
||||
Command,
|
||||
@@ -233,11 +233,54 @@ export function CompanyPicker({
|
||||
</PopoverContent>
|
||||
</Popover>
|
||||
|
||||
<CompanyEditDialog
|
||||
<DashboardCrudFormDialog<AdminCompany, CreateAdminCompanyPayload>
|
||||
open={createOpen}
|
||||
saving={createSaving}
|
||||
item={null}
|
||||
itemId={null}
|
||||
initialValues={{ name: trimmedKeyword }}
|
||||
fields={[
|
||||
{
|
||||
name: "name",
|
||||
label: t("company.columnName"),
|
||||
placeholder: t("company.namePlaceholder"),
|
||||
defaultValue: trimmedKeyword,
|
||||
required: true,
|
||||
requiredMessage: t("company.nameRequired"),
|
||||
trim: true,
|
||||
},
|
||||
{
|
||||
name: "code",
|
||||
label: t("company.columnCode"),
|
||||
placeholder: t("company.optional"),
|
||||
trim: true,
|
||||
},
|
||||
{
|
||||
name: "remark",
|
||||
label: t("company.columnRemark"),
|
||||
placeholder: t("company.remarkPlaceholder"),
|
||||
type: "textarea",
|
||||
rows: 4,
|
||||
trim: true,
|
||||
},
|
||||
]}
|
||||
transformSubmitValues={(values) => ({
|
||||
name: String(values.name ?? ""),
|
||||
code: String(values.code ?? ""),
|
||||
remark: String(values.remark ?? ""),
|
||||
})}
|
||||
labels={{
|
||||
createTitle: t("company.createTitle"),
|
||||
editTitle: t("company.editTitle"),
|
||||
create: t("company.create"),
|
||||
save: t("company.save"),
|
||||
saving: t("company.saving"),
|
||||
cancel: t("company.cancel"),
|
||||
loadingDetail: t("company.loadingDetail"),
|
||||
required: t("company.nameRequired"),
|
||||
invalidNumber: t("company.nameRequired"),
|
||||
minValue: () => t("company.nameRequired"),
|
||||
maxValue: () => t("company.nameRequired"),
|
||||
}}
|
||||
onOpenChange={setCreateOpen}
|
||||
onSubmit={handleCreateCompany}
|
||||
/>
|
||||
|
||||
@@ -0,0 +1,79 @@
|
||||
"use client"
|
||||
|
||||
import type { FieldError as HookFormFieldError } from "react-hook-form"
|
||||
import { Controller, type Control, type UseFormRegister } from "react-hook-form"
|
||||
|
||||
import { OptionCombobox } from "@/components/option-combobox"
|
||||
import {
|
||||
Field,
|
||||
FieldContent,
|
||||
FieldError,
|
||||
FieldLabel,
|
||||
} from "@/components/ui/field"
|
||||
import { Input } from "@/components/ui/input"
|
||||
import { Textarea } from "@/components/ui/textarea"
|
||||
import { cn } from "@/lib/utils"
|
||||
import type { DashboardCrudFormField } from "./dashboard-crud-utils"
|
||||
|
||||
export function DashboardCrudFieldControl<TItem>({
|
||||
field,
|
||||
control,
|
||||
register,
|
||||
error,
|
||||
}: {
|
||||
field: DashboardCrudFormField<TItem>
|
||||
control: Control<Record<string, string>>
|
||||
register: UseFormRegister<Record<string, string>>
|
||||
error?: HookFormFieldError
|
||||
}) {
|
||||
const inputId = `dashboard-crud-field-${field.name}`
|
||||
|
||||
return (
|
||||
<Field
|
||||
data-invalid={!!error}
|
||||
className={cn(
|
||||
(field.colSpan === 2 || field.type === "textarea") && "md:col-span-2"
|
||||
)}
|
||||
>
|
||||
<FieldLabel htmlFor={field.type === "select" ? undefined : inputId}>
|
||||
{field.label}
|
||||
</FieldLabel>
|
||||
<FieldContent>
|
||||
{field.type === "select" ? (
|
||||
<Controller
|
||||
control={control}
|
||||
name={field.name}
|
||||
render={({ field: controllerField }) => (
|
||||
<OptionCombobox
|
||||
value={controllerField.value}
|
||||
options={[...(field.options ?? [])]}
|
||||
placeholder={field.placeholder ?? field.label}
|
||||
onChange={controllerField.onChange}
|
||||
/>
|
||||
)}
|
||||
/>
|
||||
) : field.type === "textarea" ? (
|
||||
<Textarea
|
||||
id={inputId}
|
||||
rows={field.rows ?? 4}
|
||||
placeholder={field.placeholder}
|
||||
aria-invalid={!!error}
|
||||
{...register(field.name)}
|
||||
/>
|
||||
) : (
|
||||
<Input
|
||||
id={inputId}
|
||||
type={field.type === "number" ? "number" : "text"}
|
||||
min={field.type === "number" ? field.min : undefined}
|
||||
max={field.type === "number" ? field.max : undefined}
|
||||
step={field.type === "number" ? field.step : undefined}
|
||||
placeholder={field.placeholder}
|
||||
aria-invalid={!!error}
|
||||
{...register(field.name)}
|
||||
/>
|
||||
)}
|
||||
<FieldError errors={error ? [error] : []} />
|
||||
</FieldContent>
|
||||
</Field>
|
||||
)
|
||||
}
|
||||
@@ -0,0 +1,218 @@
|
||||
"use client"
|
||||
|
||||
import { useEffect, useMemo, useState } from "react"
|
||||
import { zodResolver } from "@hookform/resolvers/zod"
|
||||
import type { Resolver } from "react-hook-form"
|
||||
import { useForm } from "react-hook-form"
|
||||
import { z } from "zod/v4"
|
||||
|
||||
import { ProjectDialog } from "@/components/project-dialog"
|
||||
import { Button } from "@/components/ui/button"
|
||||
import {
|
||||
buildDashboardCrudFormValues,
|
||||
normalizeDashboardCrudSubmitValues,
|
||||
type DashboardCrudFormField,
|
||||
} from "./dashboard-crud-utils"
|
||||
import { DashboardCrudFieldControl } from "./dashboard-crud-field-control"
|
||||
|
||||
type DashboardCrudFormDialogProps<TItem, TPayload> = {
|
||||
open: boolean
|
||||
saving: boolean
|
||||
item: TItem | null
|
||||
itemId: number | null
|
||||
fields: DashboardCrudFormField<TItem>[]
|
||||
fetchDetail?: (id: number) => Promise<TItem>
|
||||
transformSubmitValues?: (
|
||||
values: Record<string, string | number>,
|
||||
context: { mode: "create" | "edit"; item: TItem | null }
|
||||
) => TPayload
|
||||
labels: {
|
||||
createTitle: string
|
||||
editTitle: string
|
||||
create: string
|
||||
save: string
|
||||
saving: string
|
||||
cancel: string
|
||||
loadingDetail: string
|
||||
required: string
|
||||
invalidNumber: string
|
||||
minValue: (min: number) => string
|
||||
maxValue: (max: number) => string
|
||||
}
|
||||
onOpenChange: (open: boolean) => void
|
||||
onSubmit: (payload: TPayload) => Promise<void>
|
||||
}
|
||||
|
||||
function createFormSchema<TItem>(
|
||||
fields: ReadonlyArray<DashboardCrudFormField<TItem>>,
|
||||
labels: DashboardCrudFormDialogProps<TItem, unknown>["labels"]
|
||||
) {
|
||||
const shape: Record<string, z.ZodType<string>> = {}
|
||||
|
||||
fields.forEach((field) => {
|
||||
let schema = field.trim ? z.string().trim() : z.string()
|
||||
if (field.required) {
|
||||
schema = schema.min(1, field.requiredMessage ?? labels.required)
|
||||
}
|
||||
if (field.pattern) {
|
||||
schema = schema.regex(field.pattern, field.patternMessage ?? labels.required)
|
||||
}
|
||||
if (field.type === "number") {
|
||||
schema = schema.refine((value) => {
|
||||
if (!value.trim()) return !field.required
|
||||
return Number.isFinite(Number(value))
|
||||
}, labels.invalidNumber)
|
||||
if (field.min !== undefined) {
|
||||
schema = schema.refine((value) => !value.trim() || Number(value) >= field.min!, {
|
||||
message: labels.minValue(field.min),
|
||||
})
|
||||
}
|
||||
if (field.max !== undefined) {
|
||||
schema = schema.refine((value) => !value.trim() || Number(value) <= field.max!, {
|
||||
message: labels.maxValue(field.max),
|
||||
})
|
||||
}
|
||||
}
|
||||
shape[field.name] = schema
|
||||
})
|
||||
|
||||
return z.object(shape)
|
||||
}
|
||||
|
||||
function normalizeFormLayoutFields<TItem>(fields: DashboardCrudFormField<TItem>[]) {
|
||||
return fields.map((field) =>
|
||||
field.type === "textarea" ? { ...field, colSpan: field.colSpan ?? 2 } : field
|
||||
)
|
||||
}
|
||||
|
||||
export function DashboardCrudFormDialog<TItem, TPayload>({
|
||||
open,
|
||||
saving,
|
||||
item,
|
||||
itemId,
|
||||
fields,
|
||||
fetchDetail,
|
||||
transformSubmitValues,
|
||||
labels,
|
||||
onOpenChange,
|
||||
onSubmit,
|
||||
}: DashboardCrudFormDialogProps<TItem, TPayload>) {
|
||||
const layoutFields = useMemo(() => normalizeFormLayoutFields(fields), [fields])
|
||||
const initialValues = useMemo(
|
||||
() => buildDashboardCrudFormValues(fields, item),
|
||||
[fields, item]
|
||||
)
|
||||
const schema = useMemo(() => createFormSchema(fields, labels), [fields, labels])
|
||||
const resolver = useMemo(
|
||||
() =>
|
||||
zodResolver(schema as never) as Resolver<
|
||||
Record<string, string>,
|
||||
undefined,
|
||||
Record<string, string>
|
||||
>,
|
||||
[schema]
|
||||
)
|
||||
const [fetchedDetail, setFetchedDetail] = useState<{
|
||||
id: number
|
||||
item: TItem
|
||||
} | null>(null)
|
||||
const form = useForm<Record<string, string>, undefined, Record<string, string>>({
|
||||
resolver,
|
||||
defaultValues: initialValues,
|
||||
})
|
||||
const {
|
||||
control,
|
||||
handleSubmit,
|
||||
register,
|
||||
reset,
|
||||
formState: { errors },
|
||||
} = form
|
||||
const formId = "dashboard-crud-edit-form"
|
||||
const mode = itemId ? "edit" : "create"
|
||||
const loadingDetail = Boolean(
|
||||
itemId && fetchDetail && fetchedDetail?.id !== itemId
|
||||
)
|
||||
const detailItem =
|
||||
itemId && fetchDetail && fetchedDetail?.id === itemId
|
||||
? fetchedDetail.item
|
||||
: item
|
||||
|
||||
useEffect(() => {
|
||||
let cancelled = false
|
||||
|
||||
if (!itemId || !fetchDetail) {
|
||||
reset(initialValues)
|
||||
return
|
||||
}
|
||||
|
||||
void fetchDetail(itemId)
|
||||
.then((detail) => {
|
||||
if (cancelled) return
|
||||
setFetchedDetail({ id: itemId, item: detail })
|
||||
reset(buildDashboardCrudFormValues(fields, detail))
|
||||
})
|
||||
|
||||
return () => {
|
||||
cancelled = true
|
||||
}
|
||||
}, [fetchDetail, fields, initialValues, item, itemId, reset])
|
||||
|
||||
async function submit(values: Record<string, string>) {
|
||||
const normalizedValues = normalizeDashboardCrudSubmitValues(fields, values)
|
||||
const payload = transformSubmitValues
|
||||
? transformSubmitValues(normalizedValues, { mode, item: detailItem })
|
||||
: (normalizedValues as TPayload)
|
||||
await onSubmit(payload)
|
||||
}
|
||||
|
||||
if (!open || fields.length === 0) {
|
||||
return null
|
||||
}
|
||||
|
||||
return (
|
||||
<ProjectDialog
|
||||
open={open}
|
||||
onOpenChange={onOpenChange}
|
||||
title={mode === "edit" ? labels.editTitle : labels.createTitle}
|
||||
size="md"
|
||||
allowFullscreen
|
||||
footer={
|
||||
<>
|
||||
<Button
|
||||
type="button"
|
||||
variant="outline"
|
||||
onClick={() => onOpenChange(false)}
|
||||
disabled={saving}
|
||||
>
|
||||
{labels.cancel}
|
||||
</Button>
|
||||
<Button type="submit" form={formId} disabled={saving || loadingDetail}>
|
||||
{saving ? labels.saving : mode === "edit" ? labels.save : labels.create}
|
||||
</Button>
|
||||
</>
|
||||
}
|
||||
>
|
||||
{loadingDetail ? (
|
||||
<div className="flex items-center justify-center py-12">
|
||||
<div className="text-muted-foreground">{labels.loadingDetail}</div>
|
||||
</div>
|
||||
) : (
|
||||
<form
|
||||
id={formId}
|
||||
onSubmit={handleSubmit(submit)}
|
||||
className="grid gap-4 md:grid-cols-2"
|
||||
>
|
||||
{layoutFields.map((field) => (
|
||||
<DashboardCrudFieldControl
|
||||
key={field.name}
|
||||
field={field}
|
||||
control={control}
|
||||
register={register}
|
||||
error={errors[field.name]}
|
||||
/>
|
||||
))}
|
||||
</form>
|
||||
)}
|
||||
</ProjectDialog>
|
||||
)
|
||||
}
|
||||
@@ -39,10 +39,12 @@ import {
|
||||
import {
|
||||
buildDashboardCrudQuery,
|
||||
normalizeDashboardCrudPageResult,
|
||||
type DashboardCrudFormField,
|
||||
type DashboardCrudPageResult,
|
||||
type DashboardCrudQueryFilter,
|
||||
type DashboardCrudQueryValue,
|
||||
} from "./dashboard-crud-utils"
|
||||
import { DashboardCrudFormDialog } from "./dashboard-crud-form-dialog"
|
||||
|
||||
type DashboardCrudFilter<TValue extends string | number = string> =
|
||||
DashboardCrudQueryFilter & {
|
||||
@@ -84,7 +86,28 @@ type DashboardCrudPageProps<TItem, TPayload> = {
|
||||
fetchList: (
|
||||
query: Record<string, DashboardCrudQueryValue>
|
||||
) => Promise<DashboardCrudPageResult<TItem>>
|
||||
renderEditDialog: (props: DashboardCrudDialogProps<TItem, TPayload>) => ReactNode
|
||||
renderEditDialog?: (props: DashboardCrudDialogProps<TItem, TPayload>) => ReactNode
|
||||
form?: {
|
||||
fields: DashboardCrudFormField<TItem>[]
|
||||
fetchDetail?: (id: number) => Promise<TItem>
|
||||
transformSubmitValues?: (
|
||||
values: Record<string, string | number>,
|
||||
context: { mode: "create" | "edit"; item: TItem | null }
|
||||
) => TPayload
|
||||
labels: {
|
||||
createTitle: string
|
||||
editTitle: string
|
||||
create: string
|
||||
save: string
|
||||
saving: string
|
||||
cancel: string
|
||||
loadingDetail: string
|
||||
required: string
|
||||
invalidNumber: string
|
||||
minValue: (min: number) => string
|
||||
maxValue: (max: number) => string
|
||||
}
|
||||
}
|
||||
getItemId: (item: TItem) => number
|
||||
createItem: (payload: TPayload) => Promise<unknown>
|
||||
updateItem: (item: TItem, payload: TPayload) => Promise<unknown>
|
||||
@@ -117,6 +140,7 @@ export function DashboardCrudPage<TItem, TPayload>({
|
||||
columns,
|
||||
fetchList,
|
||||
renderEditDialog,
|
||||
form,
|
||||
getItemId,
|
||||
createItem,
|
||||
updateItem,
|
||||
@@ -402,14 +426,29 @@ export function DashboardCrudPage<TItem, TPayload>({
|
||||
</Table>
|
||||
</DashboardTableShell>
|
||||
</DashboardPage>
|
||||
{renderEditDialog({
|
||||
open: dialogOpen,
|
||||
saving,
|
||||
item: editingItem,
|
||||
itemId: editingItem ? getItemId(editingItem) : null,
|
||||
onOpenChange: handleDialogOpenChange,
|
||||
onSubmit: handleSubmit,
|
||||
})}
|
||||
{form ? (
|
||||
<DashboardCrudFormDialog
|
||||
open={dialogOpen}
|
||||
saving={saving}
|
||||
item={editingItem}
|
||||
itemId={editingItem ? getItemId(editingItem) : null}
|
||||
fields={form.fields}
|
||||
fetchDetail={form.fetchDetail}
|
||||
transformSubmitValues={form.transformSubmitValues}
|
||||
labels={form.labels}
|
||||
onOpenChange={handleDialogOpenChange}
|
||||
onSubmit={handleSubmit}
|
||||
/>
|
||||
) : (
|
||||
renderEditDialog?.({
|
||||
open: dialogOpen,
|
||||
saving,
|
||||
item: editingItem,
|
||||
itemId: editingItem ? getItemId(editingItem) : null,
|
||||
onOpenChange: handleDialogOpenChange,
|
||||
onSubmit: handleSubmit,
|
||||
})
|
||||
)}
|
||||
</>
|
||||
)
|
||||
}
|
||||
|
||||
@@ -88,3 +88,58 @@ describe("normalizeDashboardCrudPageResult", () => {
|
||||
})
|
||||
})
|
||||
})
|
||||
|
||||
describe("buildDashboardCrudFormValues", () => {
|
||||
it("uses defaults for create forms and item values for edit forms", async () => {
|
||||
const { buildDashboardCrudFormValues } = await loadModule()
|
||||
const fields = [
|
||||
{ name: "title", defaultValue: "Untitled" },
|
||||
{ name: "sortNo", type: "number", defaultValue: "0" },
|
||||
{
|
||||
name: "status",
|
||||
defaultValue: "0",
|
||||
valueFromItem: (item) => String(item.status),
|
||||
},
|
||||
]
|
||||
|
||||
assert.deepEqual(plain(buildDashboardCrudFormValues(fields)), {
|
||||
title: "Untitled",
|
||||
sortNo: "0",
|
||||
status: "0",
|
||||
})
|
||||
assert.deepEqual(
|
||||
plain(buildDashboardCrudFormValues(fields, { title: "Hello", sortNo: 7, status: 1 })),
|
||||
{
|
||||
title: "Hello",
|
||||
sortNo: "7",
|
||||
status: "1",
|
||||
}
|
||||
)
|
||||
})
|
||||
})
|
||||
|
||||
describe("normalizeDashboardCrudSubmitValues", () => {
|
||||
it("trims strings and converts number fields", async () => {
|
||||
const { normalizeDashboardCrudSubmitValues } = await loadModule()
|
||||
const fields = [
|
||||
{ name: "title", trim: true },
|
||||
{ name: "sortNo", type: "number" },
|
||||
{ name: "status", type: "select", valueType: "number" },
|
||||
]
|
||||
|
||||
assert.deepEqual(
|
||||
plain(
|
||||
normalizeDashboardCrudSubmitValues(fields, {
|
||||
title: " Hello ",
|
||||
sortNo: "12",
|
||||
status: "1",
|
||||
})
|
||||
),
|
||||
{
|
||||
title: "Hello",
|
||||
sortNo: 12,
|
||||
status: 1,
|
||||
}
|
||||
)
|
||||
})
|
||||
})
|
||||
|
||||
@@ -16,6 +16,34 @@ export type DashboardCrudPageResult<T> = {
|
||||
}
|
||||
}
|
||||
|
||||
export type DashboardCrudFormValue = string | number | undefined
|
||||
|
||||
export type DashboardCrudFormOption = {
|
||||
value: string
|
||||
label: string
|
||||
}
|
||||
|
||||
export type DashboardCrudFormField<TItem = unknown> = {
|
||||
name: string
|
||||
label: string
|
||||
type?: "text" | "textarea" | "number" | "select"
|
||||
placeholder?: string
|
||||
defaultValue?: DashboardCrudFormValue
|
||||
required?: boolean
|
||||
requiredMessage?: string
|
||||
trim?: boolean
|
||||
valueType?: "string" | "number"
|
||||
min?: number
|
||||
max?: number
|
||||
step?: number
|
||||
pattern?: RegExp
|
||||
patternMessage?: string
|
||||
options?: ReadonlyArray<DashboardCrudFormOption>
|
||||
colSpan?: 1 | 2
|
||||
rows?: number
|
||||
valueFromItem?: (item: TItem) => DashboardCrudFormValue
|
||||
}
|
||||
|
||||
export function buildDashboardCrudQuery({
|
||||
values,
|
||||
filters,
|
||||
@@ -72,3 +100,42 @@ export function normalizeDashboardCrudPageResult<T>(
|
||||
},
|
||||
}
|
||||
}
|
||||
|
||||
export function buildDashboardCrudFormValues<TItem>(
|
||||
fields: ReadonlyArray<DashboardCrudFormField<TItem>>,
|
||||
item?: TItem | null
|
||||
): Record<string, string> {
|
||||
return Object.fromEntries(
|
||||
fields.map((field) => {
|
||||
let value: unknown = field.defaultValue ?? ""
|
||||
if (item) {
|
||||
if (field.valueFromItem) {
|
||||
value = field.valueFromItem(item)
|
||||
} else if (typeof item === "object" && item && field.name in item) {
|
||||
value = (item as Record<string, unknown>)[field.name]
|
||||
}
|
||||
}
|
||||
return [field.name, value === undefined || value === null ? "" : String(value)]
|
||||
})
|
||||
)
|
||||
}
|
||||
|
||||
export function normalizeDashboardCrudSubmitValues<TItem>(
|
||||
fields: ReadonlyArray<DashboardCrudFormField<TItem>>,
|
||||
values: Record<string, string>
|
||||
): Record<string, string | number> {
|
||||
const output: Record<string, string | number> = {}
|
||||
|
||||
fields.forEach((field) => {
|
||||
const rawValue = values[field.name] ?? ""
|
||||
const text = field.trim ? rawValue.trim() : rawValue
|
||||
if (field.type === "number" || field.valueType === "number") {
|
||||
const numberValue = Number(text)
|
||||
output[field.name] = Number.isFinite(numberValue) ? numberValue : 0
|
||||
return
|
||||
}
|
||||
output[field.name] = text
|
||||
})
|
||||
|
||||
return output
|
||||
}
|
||||
|
||||
@@ -1,5 +1,7 @@
|
||||
export { DashboardCrudPage } from "./dashboard-crud-page"
|
||||
export { DashboardCrudFormDialog } from "./dashboard-crud-form-dialog"
|
||||
export type {
|
||||
DashboardCrudFormField,
|
||||
DashboardCrudPageResult,
|
||||
DashboardCrudQueryValue,
|
||||
} from "./dashboard-crud-utils"
|
||||
|
||||
Reference in New Issue
Block a user