Open Source Platform for DTC, B2B Commerce, Marketplaces & Omnichannel. REST APIs, TypeScript SDKs, and production-ready Next.js storefront. Self-host it. Own your data. No vendor lock-in. Zero platform fees.
Ruby b2b-commercee-commerceecommerceecommerce-apiecommerce-frameworkecommerce-platformheadlessheadless-commerceheadless-ecommercemarketplacemulti-tenantmulti-vendormulti-vendor-ecommerceopen-sourcespree-commerce
Let operators compose the seller checklist from the dashboard
Damian Legawiec59573768106f
diff --git a/packages/dashboard-starter/src/routeTree.gen.ts b/packages/dashboard-starter/src/routeTree.gen.tsindex ce5f4ea481..669d6555b5 100644--- a/packages/dashboard-starter/src/routeTree.gen.ts+++ b/packages/dashboard-starter/src/routeTree.gen.ts@@ -37,6 +37,7 @@ import { Route as SettingsTaxCategoriesRouteImport } from './../../dashboard/srcimport { Route as SettingsStoreRouteImport } from './../../dashboard/src/routes/_authenticated/$storeId/settings/store'import { Route as SettingsStockLocationsRouteImport } from './../../dashboard/src/routes/_authenticated/$storeId/settings/stock-locations'import { Route as SettingsStaffRouteImport } from './../../dashboard/src/routes/_authenticated/$storeId/settings/staff'+import { Route as SettingsSellerRequirementsRouteImport } from './../../dashboard/src/routes/_authenticated/$storeId/settings/seller-requirements'import { Route as SettingsRolesRouteImport } from './../../dashboard/src/routes/_authenticated/$storeId/settings/roles'import { Route as SettingsReasonsRouteImport } from './../../dashboard/src/routes/_authenticated/$storeId/settings/reasons'import { Route as SettingsProductTypesRouteImport } from './../../dashboard/src/routes/_authenticated/$storeId/settings/product-types'@@ -223,6 +224,12 @@ const SettingsStaffRoute = SettingsStaffRouteImport.update({path: '/staff',getParentRoute: () => SettingsRoute,} as any)+const SettingsSellerRequirementsRoute =+ SettingsSellerRequirementsRouteImport.update({+ id: '/seller-requirements',+ path: '/seller-requirements',+ getParentRoute: () => SettingsRoute,+ } as any)const SettingsRolesRoute = SettingsRolesRouteImport.update({id: '/roles',path: '/roles',@@ -501,6 +508,7 @@ export interface FileRoutesByFullPath {'/$storeId/settings/product-types': typeof SettingsProductTypesRoute'/$storeId/settings/reasons': typeof SettingsReasonsRoute'/$storeId/settings/roles': typeof SettingsRolesRoute+ '/$storeId/settings/seller-requirements': typeof SettingsSellerRequirementsRoute'/$storeId/settings/staff': typeof SettingsStaffRoute'/$storeId/settings/stock-locations': typeof SettingsStockLocationsRoute'/$storeId/settings/store': typeof SettingsStoreRoute@@ -573,6 +581,7 @@ export interface FileRoutesByTo {'/$storeId/settings/product-types': typeof SettingsProductTypesRoute'/$storeId/settings/reasons': typeof SettingsReasonsRoute'/$storeId/settings/roles': typeof SettingsRolesRoute+ '/$storeId/settings/seller-requirements': typeof SettingsSellerRequirementsRoute'/$storeId/settings/staff': typeof SettingsStaffRoute'/$storeId/settings/stock-locations': typeof SettingsStockLocationsRoute'/$storeId/settings/store': typeof SettingsStoreRoute@@ -649,6 +658,7 @@ export interface FileRoutesById {'/_authenticated/$storeId/settings/product-types': typeof SettingsProductTypesRoute'/_authenticated/$storeId/settings/reasons': typeof SettingsReasonsRoute'/_authenticated/$storeId/settings/roles': typeof SettingsRolesRoute+ '/_authenticated/$storeId/settings/seller-requirements': typeof SettingsSellerRequirementsRoute'/_authenticated/$storeId/settings/staff': typeof SettingsStaffRoute'/_authenticated/$storeId/settings/stock-locations': typeof SettingsStockLocationsRoute'/_authenticated/$storeId/settings/store': typeof SettingsStoreRoute@@ -725,6 +735,7 @@ export interface FileRouteTypes {| '/$storeId/settings/product-types'| '/$storeId/settings/reasons'| '/$storeId/settings/roles'+ | '/$storeId/settings/seller-requirements'| '/$storeId/settings/staff'| '/$storeId/settings/stock-locations'| '/$storeId/settings/store'@@ -797,6 +808,7 @@ export interface FileRouteTypes {| '/$storeId/settings/product-types'| '/$storeId/settings/reasons'| '/$storeId/settings/roles'+ | '/$storeId/settings/seller-requirements'| '/$storeId/settings/staff'| '/$storeId/settings/stock-locations'| '/$storeId/settings/store'@@ -872,6 +884,7 @@ export interface FileRouteTypes {| '/_authenticated/$storeId/settings/product-types'| '/_authenticated/$storeId/settings/reasons'| '/_authenticated/$storeId/settings/roles'+ | '/_authenticated/$storeId/settings/seller-requirements'| '/_authenticated/$storeId/settings/staff'| '/_authenticated/$storeId/settings/stock-locations'| '/_authenticated/$storeId/settings/store'@@ -1113,6 +1126,13 @@ declare module '@tanstack/react-router' {preLoaderRoute: typeof SettingsStaffRouteImportparentRoute: typeof SettingsRoute}+ '/_authenticated/$storeId/settings/seller-requirements': {+ id: '/_authenticated/$storeId/settings/seller-requirements'+ path: '/seller-requirements'+ fullPath: '/$storeId/settings/seller-requirements'+ preLoaderRoute: typeof SettingsSellerRequirementsRouteImport+ parentRoute: typeof SettingsRoute+ }'/_authenticated/$storeId/settings/roles': {id: '/_authenticated/$storeId/settings/roles'path: '/roles'@@ -1444,6 +1464,7 @@ interface SettingsRouteChildren {SettingsProductTypesRoute: typeof SettingsProductTypesRouteSettingsReasonsRoute: typeof SettingsReasonsRouteSettingsRolesRoute: typeof SettingsRolesRoute+ SettingsSellerRequirementsRoute: typeof SettingsSellerRequirementsRouteSettingsStaffRoute: typeof SettingsStaffRouteSettingsStockLocationsRoute: typeof SettingsStockLocationsRouteSettingsStoreRoute: typeof SettingsStoreRoute@@ -1472,6 +1493,7 @@ const SettingsRouteChildren: SettingsRouteChildren = {SettingsProductTypesRoute: SettingsProductTypesRoute,SettingsReasonsRoute: SettingsReasonsRoute,SettingsRolesRoute: SettingsRolesRoute,+ SettingsSellerRequirementsRoute: SettingsSellerRequirementsRoute,SettingsStaffRoute: SettingsStaffRoute,SettingsStockLocationsRoute: SettingsStockLocationsRoute,SettingsStoreRoute: SettingsStoreRoute,diff --git a/packages/dashboard/src/hooks/use-custom-field-definitions.ts b/packages/dashboard/src/hooks/use-custom-field-definitions.tsnew file mode 100644index 0000000000..80545f3f47--- /dev/null+++ b/packages/dashboard/src/hooks/use-custom-field-definitions.ts@@ -0,0 +1,40 @@+import type { CustomFieldDefinition } from '@spree/admin-sdk'+import { adminClient } from '@spree/dashboard-core'+import i18n from 'i18next'++/**+ * A definition's own label, falling back to the key an operator typed when+ * they never gave it one, with the namespaced key alongside — two fields can+ * share a label across namespaces, and the key is what tells them apart.+ */+export function customFieldDefinitionLabel(definition: CustomFieldDefinition): string {+ const key = `${definition.namespace}.${definition.key}`++ return definition.label ? `${definition.label} (${key})` : key+}++/**+ * Autocomplete over the custom fields defined for one resource — the shared+ * config a `<ResourceMultiAutocomplete>` needs bar the value/onChange the+ * form supplies.+ *+ * Scoped by `resource_type` so a picker for seller onboarding cannot offer a+ * field defined for products, which a seller has nowhere to answer.+ */+export function customFieldDefinitionAutocompleteProps(resourceType: string) {+ return (queryKey: string) => ({+ queryKey,+ search: (q: string) =>+ adminClient.customFieldDefinitions.list({+ resource_type_eq: resourceType,+ label_or_key_cont: q,+ limit: 20,+ sort: 'key',+ }),+ hydrate: (ids: string[]) =>+ adminClient.customFieldDefinitions.list({ id_in: ids, limit: ids.length }),+ getOptionLabel: customFieldDefinitionLabel,+ placeholder: i18n.t('admin.seller_requirements.fields.custom_fields.placeholder'),+ emptyText: i18n.t('admin.seller_requirements.fields.custom_fields.empty'),+ })+}diff --git a/packages/dashboard/src/hooks/use-seller-requirements.ts b/packages/dashboard/src/hooks/use-seller-requirements.tsnew file mode 100644index 0000000000..a057ed19ef--- /dev/null+++ b/packages/dashboard/src/hooks/use-seller-requirements.ts@@ -0,0 +1,126 @@+import type {+ SellerOnboarding,+ SellerRequirement,+ SellerRequirementCreateParams,+ SellerRequirementReviewParams,+ SellerRequirementSubmission,+ SellerRequirementUpdateParams,+ SellerRequirementWaiveParams,+} from '@spree/admin-sdk'+import {+ adminClient,+ useResourceKey,+ useResourceKeyBuilder,+ useResourceMutation,+} from '@spree/dashboard-core'+import { useQuery, useQueryClient } from '@tanstack/react-query'+import i18n from 'i18next'++/**+ * The requirement kinds an operator can add, with each one's configuration+ * shape. Store-scoped because the response says which single-instance kinds+ * this store already has.+ */+export function useSellerRequirementTypes() {+ return useQuery({+ queryKey: useResourceKey('seller-requirements', 'types'),+ queryFn: () => adminClient.sellerRequirements.types(),+ })+}++export function useSellerRequirements({ page = 1, limit = 100 } = {}) {+ return useQuery({+ queryKey: useResourceKey('seller-requirements', { page, limit }),+ queryFn: () => adminClient.sellerRequirements.list({ page, limit }),+ })+}++export function useCreateSellerRequirement() {+ // The types list carries a `configured` flag per kind, so it goes stale the+ // moment a single-instance kind is added.+ return useResourceMutation<SellerRequirement, Error, SellerRequirementCreateParams>({+ mutationFn: (params) => adminClient.sellerRequirements.create(params),+ invalidate: [['seller-requirements'], ['seller-requirements', 'types']],+ successMessage: i18n.t('admin.seller_requirements.messages.created'),+ errorMessage: i18n.t('admin.errors.failed_to_create'),+ })+}++export function useUpdateSellerRequirement(id: string) {+ return useResourceMutation<SellerRequirement, Error, SellerRequirementUpdateParams>({+ mutationFn: (params) => adminClient.sellerRequirements.update(id, params),+ invalidate: [['seller-requirements'], ['seller-requirements', id]],+ successMessage: i18n.t('admin.seller_requirements.messages.updated'),+ errorMessage: i18n.t('admin.errors.failed_to_update'),+ })+}++export function useDeleteSellerRequirement() {+ const queryClient = useQueryClient()+ const buildKey = useResourceKeyBuilder()++ return useResourceMutation<void, Error, string>({+ mutationFn: (id) => adminClient.sellerRequirements.delete(id),+ invalidate: [['seller-requirements'], ['seller-requirements', 'types']],+ successMessage: i18n.t('admin.seller_requirements.messages.deleted'),+ errorMessage: i18n.t('admin.errors.failed_to_delete'),+ onSuccess: (_data, id) => {+ queryClient.removeQueries({ queryKey: buildKey('seller-requirements', id) })+ },+ })+}++/** Where one seller stands against the marketplace's checklist. */+export function useSellerOnboarding(sellerId: string | undefined) {+ return useQuery<SellerOnboarding>({+ queryKey: useResourceKey('sellers', sellerId ?? 'noop', 'onboarding'),+ queryFn: () => adminClient.sellers.onboarding(sellerId as string),+ enabled: !!sellerId,+ })+}++export function useAcceptSellerRequirementSubmission(sellerId: string) {+ return useResourceMutation<+ SellerRequirementSubmission,+ Error,+ { id: string; params?: SellerRequirementReviewParams }+ >({+ mutationFn: ({ id, params }) =>+ adminClient.sellers.requirementSubmissions.accept(sellerId, id, params),+ invalidate: [+ ['sellers', sellerId, 'onboarding'],+ ['sellers', sellerId],+ ],+ successMessage: i18n.t('admin.seller_requirements.messages.submission_accepted'),+ errorMessage: i18n.t('admin.errors.failed_to_update'),+ })+}++export function useRejectSellerRequirementSubmission(sellerId: string) {+ return useResourceMutation<+ SellerRequirementSubmission,+ Error,+ { id: string; params?: SellerRequirementReviewParams }+ >({+ mutationFn: ({ id, params }) =>+ adminClient.sellers.requirementSubmissions.reject(sellerId, id, params),+ invalidate: [+ ['sellers', sellerId, 'onboarding'],+ ['sellers', sellerId],+ ],+ successMessage: i18n.t('admin.seller_requirements.messages.submission_rejected'),+ errorMessage: i18n.t('admin.errors.failed_to_update'),+ })+}++export function useWaiveSellerRequirement(sellerId: string) {+ return useResourceMutation<SellerRequirementSubmission, Error, SellerRequirementWaiveParams>({+ mutationFn: (params) => adminClient.sellers.requirementSubmissions.waive(sellerId, params),+ invalidate: [+ ['sellers', sellerId, 'onboarding'],+ ['sellers', sellerId],+ ],+ successMessage: i18n.t('admin.seller_requirements.messages.waived'),+ errorMessage: i18n.t('admin.errors.failed_to_update'),+ })+}diff --git a/packages/dashboard/src/nav/settings.ts b/packages/dashboard/src/nav/settings.tsindex 6f695c951c..f803bb059e 100644--- a/packages/dashboard/src/nav/settings.ts+++ b/packages/dashboard/src/nav/settings.ts@@ -1,5 +1,6 @@import { Subject, settingsNav } from '@spree/dashboard-core'import {+ ClipboardCheckIcon,CreditCardIcon,GlobeIcon,GlobeLockIcon,@@ -114,6 +115,16 @@ settingsNav.add({subject: Subject.CommissionRate,})+settingsNav.add({+ key: 'settings.seller-requirements',+ labelKey: 'admin.settings_nav.items.seller_requirements',+ path: '/seller-requirements',+ icon: ClipboardCheckIcon,+ group: 'payments',+ position: 280,+ subject: Subject.Seller,+})+settingsNav.add({key: 'settings.markets',labelKey: 'admin.settings_nav.items.markets',diff --git a/packages/dashboard/src/routeTree.gen.ts b/packages/dashboard/src/routeTree.gen.tsindex 15669a5071..6e0846e241 100644--- a/packages/dashboard/src/routeTree.gen.ts+++ b/packages/dashboard/src/routeTree.gen.ts@@ -36,6 +36,7 @@ import { Route as SettingsTaxCategoriesRouteImport } from './routes/_authenticatimport { Route as SettingsStoreRouteImport } from './routes/_authenticated/$storeId/settings/store'import { Route as SettingsStockLocationsRouteImport } from './routes/_authenticated/$storeId/settings/stock-locations'import { Route as SettingsStaffRouteImport } from './routes/_authenticated/$storeId/settings/staff'+import { Route as SettingsSellerRequirementsRouteImport } from './routes/_authenticated/$storeId/settings/seller-requirements'import { Route as SettingsRolesRouteImport } from './routes/_authenticated/$storeId/settings/roles'import { Route as SettingsReasonsRouteImport } from './routes/_authenticated/$storeId/settings/reasons'import { Route as SettingsProductTypesRouteImport } from './routes/_authenticated/$storeId/settings/product-types'@@ -216,6 +217,12 @@ const SettingsStaffRoute = SettingsStaffRouteImport.update({path: '/staff',getParentRoute: () => SettingsRoute,} as any)+const SettingsSellerRequirementsRoute =+ SettingsSellerRequirementsRouteImport.update({+ id: '/seller-requirements',+ path: '/seller-requirements',+ getParentRoute: () => SettingsRoute,+ } as any)const SettingsRolesRoute = SettingsRolesRouteImport.update({id: '/roles',path: '/roles',@@ -488,6 +495,7 @@ export interface FileRoutesByFullPath {'/$storeId/settings/product-types': typeof SettingsProductTypesRoute'/$storeId/settings/reasons': typeof SettingsReasonsRoute'/$storeId/settings/roles': typeof SettingsRolesRoute+ '/$storeId/settings/seller-requirements': typeof SettingsSellerRequirementsRoute'/$storeId/settings/staff': typeof SettingsStaffRoute'/$storeId/settings/stock-locations': typeof SettingsStockLocationsRoute'/$storeId/settings/store': typeof SettingsStoreRoute@@ -558,6 +566,7 @@ export interface FileRoutesByTo {'/$storeId/settings/product-types': typeof SettingsProductTypesRoute'/$storeId/settings/reasons': typeof SettingsReasonsRoute'/$storeId/settings/roles': typeof SettingsRolesRoute+ '/$storeId/settings/seller-requirements': typeof SettingsSellerRequirementsRoute'/$storeId/settings/staff': typeof SettingsStaffRoute'/$storeId/settings/stock-locations': typeof SettingsStockLocationsRoute'/$storeId/settings/store': typeof SettingsStoreRoute@@ -632,6 +641,7 @@ export interface FileRoutesById {'/_authenticated/$storeId/settings/product-types': typeof SettingsProductTypesRoute'/_authenticated/$storeId/settings/reasons': typeof SettingsReasonsRoute'/_authenticated/$storeId/settings/roles': typeof SettingsRolesRoute+ '/_authenticated/$storeId/settings/seller-requirements': typeof SettingsSellerRequirementsRoute'/_authenticated/$storeId/settings/staff': typeof SettingsStaffRoute'/_authenticated/$storeId/settings/stock-locations': typeof SettingsStockLocationsRoute'/_authenticated/$storeId/settings/store': typeof SettingsStoreRoute@@ -706,6 +716,7 @@ export interface FileRouteTypes {| '/$storeId/settings/product-types'| '/$storeId/settings/reasons'| '/$storeId/settings/roles'+ | '/$storeId/settings/seller-requirements'| '/$storeId/settings/staff'| '/$storeId/settings/stock-locations'| '/$storeId/settings/store'@@ -776,6 +787,7 @@ export interface FileRouteTypes {| '/$storeId/settings/product-types'| '/$storeId/settings/reasons'| '/$storeId/settings/roles'+ | '/$storeId/settings/seller-requirements'| '/$storeId/settings/staff'| '/$storeId/settings/stock-locations'| '/$storeId/settings/store'@@ -849,6 +861,7 @@ export interface FileRouteTypes {| '/_authenticated/$storeId/settings/product-types'| '/_authenticated/$storeId/settings/reasons'| '/_authenticated/$storeId/settings/roles'+ | '/_authenticated/$storeId/settings/seller-requirements'| '/_authenticated/$storeId/settings/staff'| '/_authenticated/$storeId/settings/stock-locations'| '/_authenticated/$storeId/settings/store'@@ -1082,6 +1095,13 @@ declare module '@tanstack/react-router' {preLoaderRoute: typeof SettingsStaffRouteImportparentRoute: typeof SettingsRoute}+ '/_authenticated/$storeId/settings/seller-requirements': {+ id: '/_authenticated/$storeId/settings/seller-requirements'+ path: '/seller-requirements'+ fullPath: '/$storeId/settings/seller-requirements'+ preLoaderRoute: typeof SettingsSellerRequirementsRouteImport+ parentRoute: typeof SettingsRoute+ }'/_authenticated/$storeId/settings/roles': {id: '/_authenticated/$storeId/settings/roles'path: '/roles'@@ -1406,6 +1426,7 @@ interface SettingsRouteChildren {SettingsProductTypesRoute: typeof SettingsProductTypesRouteSettingsReasonsRoute: typeof SettingsReasonsRouteSettingsRolesRoute: typeof SettingsRolesRoute+ SettingsSellerRequirementsRoute: typeof SettingsSellerRequirementsRouteSettingsStaffRoute: typeof SettingsStaffRouteSettingsStockLocationsRoute: typeof SettingsStockLocationsRouteSettingsStoreRoute: typeof SettingsStoreRoute@@ -1434,6 +1455,7 @@ const SettingsRouteChildren: SettingsRouteChildren = {SettingsProductTypesRoute: SettingsProductTypesRoute,SettingsReasonsRoute: SettingsReasonsRoute,SettingsRolesRoute: SettingsRolesRoute,+ SettingsSellerRequirementsRoute: SettingsSellerRequirementsRoute,SettingsStaffRoute: SettingsStaffRoute,SettingsStockLocationsRoute: SettingsStockLocationsRoute,SettingsStoreRoute: SettingsStoreRoute,diff --git a/packages/dashboard/src/routes/_authenticated/$storeId/settings/seller-requirements.tsx b/packages/dashboard/src/routes/_authenticated/$storeId/settings/seller-requirements.tsxnew file mode 100644index 0000000000..e8de2a8618--- /dev/null+++ b/packages/dashboard/src/routes/_authenticated/$storeId/settings/seller-requirements.tsx@@ -0,0 +1,583 @@+import type { PreferenceField, SellerRequirement, SellerRequirementType } from '@spree/admin-sdk'+import type { ResourceFilterConfig } from '@spree/dashboard-core'+import {+ adminClient,+ Can,+ defaultPreferences,+ PreferencesForm,+ ResourceMultiAutocomplete,+ ResourceTable,+ resourceSearchSchema,+ Subject,+ usePermissions,+} from '@spree/dashboard-core'+import {+ Button,+ Field,+ FieldGroup,+ FieldLabel,+ Input,+ RowActions,+ Select,+ SelectContent,+ SelectItem,+ SelectTrigger,+ SelectValue,+ Sheet,+ SheetContent,+ SheetFooter,+ SheetHeader,+ SheetTitle,+ Switch,+ Textarea,+ useConfirm,+ useRowClickBridge,+} from '@spree/dashboard-ui'+import { useQueryClient } from '@tanstack/react-query'+import { createFileRoute, useNavigate } from '@tanstack/react-router'+import { PlusIcon } from 'lucide-react'+import { useMemo, useState } from 'react'+import { useTranslation } from 'react-i18next'+import { z } from 'zod'+import { customFieldDefinitionAutocompleteProps } from '../../../../hooks/use-custom-field-definitions'+import {+ useCreateSellerRequirement,+ useDeleteSellerRequirement,+ useSellerRequirements,+ useSellerRequirementTypes,+ useUpdateSellerRequirement,+} from '../../../../hooks/use-seller-requirements'+import '../../../../tables/seller-requirements'++const searchSchema = resourceSearchSchema.extend({+ edit: z.string().optional(),+ new: z.coerce.boolean().optional(),+})++export const Route = createFileRoute('/_authenticated/$storeId/settings/seller-requirements')({+ validateSearch: searchSchema,+ component: SellerRequirementsPage,+})++/**+ * What this marketplace asks of a seller before it will let them trade.+ * The operator composes the checklist here: add a requirement, word it, order+ * it, and decide whether it blocks approval or is merely recommended.+ */+function SellerRequirementsPage() {+ const { t } = useTranslation()+ const search = Route.useSearch() as z.infer<typeof searchSchema>+ const navigate = useNavigate()+ const queryClient = useQueryClient()+ const confirm = useConfirm()+ const deleteMutation = useDeleteSellerRequirement()+ const { permissions } = usePermissions()++ const editId = search.edit+ const isCreating = !!search.new++ const closeSheet = () =>+ navigate({+ search: (prev: Record<string, unknown>) => {+ const { edit: _e, new: _n, ...rest } = prev+ return rest as never+ },+ })++ const openCreate = () =>+ navigate({ search: (prev: Record<string, unknown>) => ({ ...prev, new: true }) as never })++ const openEdit = (id: string) =>+ navigate({ search: (prev: Record<string, unknown>) => ({ ...prev, edit: id }) as never })++ useRowClickBridge('data-seller-requirement-id', openEdit)++ async function handleDelete(requirement: SellerRequirement) {+ const ok = await confirm({+ title: t('admin.seller_requirements.delete_confirm.title'),+ message: t('admin.seller_requirements.delete_confirm.message', {+ name: requirement.name ?? '',+ }),+ variant: 'destructive',+ confirmLabel: t('admin.actions.delete'),+ })+ if (!ok) return+ await deleteMutation.mutateAsync(requirement.id).catch(() => undefined)+ }++ return (+ <>+ <ResourceTable<SellerRequirement>+ tableKey="seller-requirements"+ queryKey="seller-requirements"+ queryFn={(params) => adminClient.sellerRequirements.list(params)}+ searchParams={search}+ rowActions={(requirement) => (+ <RowActions+ actions={[+ { key: 'edit', onSelect: () => openEdit(requirement.id) },+ {+ key: 'delete',+ destructive: true,+ visible: permissions.can('destroy', Subject.Seller),+ disabled: deleteMutation.isPending,+ onSelect: () => handleDelete(requirement),+ },+ ]}+ />+ )}+ actions={+ <Can I="create" a={Subject.Seller}>+ <Button size="sm" className="h-[2.125rem]" onClick={openCreate}>+ <PlusIcon className="size-4" />+ {t('admin.seller_requirements.add_cta')}+ </Button>+ </Can>+ }+ reorder={{+ onReorder: async (id, position) => {+ await adminClient.sellerRequirements.update(id, { position })+ queryClient.invalidateQueries({ queryKey: ['seller-requirements'] })+ },+ }}+ />++ {isCreating && <CreateRequirementSheet open onOpenChange={(o) => !o && closeSheet()} />}+ {editId && <EditRequirementSheet id={editId} open onOpenChange={(o) => !o && closeSheet()} />}+ </>+ )+}++function CreateRequirementSheet({+ open,+ onOpenChange,+}: {+ open: boolean+ onOpenChange: (open: boolean) => void+}) {+ const { t } = useTranslation()+ const createMutation = useCreateSellerRequirement()+ const { data: typesResponse, isLoading } = useSellerRequirementTypes()+ const types = useMemo(() => typesResponse?.data ?? [], [typesResponse])++ const [type, setType] = useState<string>('')+ const [name, setName] = useState('')+ const [description, setDescription] = useState('')+ const [required, setRequired] = useState(true)+ const [preferences, setPreferences] = useState<Record<string, unknown>>({})+ const [associationIds, setAssociationIds] = useState<string[]>([])+ const [saveError, setSaveError] = useState<string | null>(null)++ const selected: SellerRequirementType | undefined = useMemo(+ () => types.find((entry) => entry.type === type),+ [types, type],+ )++ // The server decides what can be added — a kind that answers one question is+ // offered once — so the picker reads `addable` rather than restating the rule.+ const available = useMemo(() => types.filter((entry) => entry.addable), [types])++ // Base UI renders the trigger label from `items`, not from the selected+ // <SelectItem>'s children — without these pairs the trigger shows the slug.+ const selectItems = useMemo(+ () => available.map((entry) => ({ label: entry.name, value: entry.type })),+ [available],+ )++ function handleTypeChange(value: string) {+ setType(value)+ const entry = types.find((candidate) => candidate.type === value)+ setPreferences(+ entry ? defaultPreferences(entry.preference_schema as unknown as PreferenceField[]) : {},+ )+ }++ async function handleSave() {+ if (!type) return++ setSaveError(null)+ try {+ await createMutation.mutateAsync({+ type,+ name: name || undefined,+ description: description || undefined,+ required,+ preferences,+ ...associationParams(selected, associationIds),+ })+ onOpenChange(false)+ } catch (error) {+ // The sheet stays open carrying what the operator typed: a validation+ // failure is something to correct, not a reason to lose the form.+ // `useResourceMutation` suppresses its own toast for 422s, expecting+ // the form to show the message.+ setSaveError(error instanceof Error ? error.message : String(error))+ }+ }++ return (+ <Sheet open={open} onOpenChange={onOpenChange}>+ <SheetContent>+ <SheetHeader>+ <SheetTitle>{t('admin.seller_requirements.add_title')}</SheetTitle>+ </SheetHeader>+ <div className="flex flex-1 flex-col gap-4 overflow-y-auto p-4">+ {saveError && (+ // `role="alert"`: the message appears after a failed save, so a+ // screen reader has to be told rather than the operator being+ // expected to notice new text.+ <p role="alert" className="text-destructive text-sm">+ {saveError}+ </p>+ )}+ <FieldGroup>+ <Field>+ <FieldLabel>{t('admin.seller_requirements.fields.kind.label')}</FieldLabel>+ <Select items={selectItems} value={type} onValueChange={handleTypeChange}>+ <SelectTrigger disabled={isLoading}>+ <SelectValue+ placeholder={t('admin.seller_requirements.fields.kind.placeholder')}+ />+ </SelectTrigger>+ <SelectContent>+ {available.map((entry) => (+ <SelectItem key={entry.type} value={entry.type}>+ {entry.name}+ </SelectItem>+ ))}+ </SelectContent>+ </Select>+ {selected?.description && (+ <p className="text-muted-foreground text-xs">{selected.description}</p>+ )}+ </Field>++ {selected && (+ <RequirementFields+ kindEntry={selected}+ values={{ name, description, required, preferences, associationIds }}+ onChange={{+ setName,+ setDescription,+ setRequired,+ setPreferences,+ setAssociationIds,+ }}+ />+ )}+ </FieldGroup>+ </div>+ <SheetFooter>+ <Button variant="outline" onClick={() => onOpenChange(false)}>+ {t('admin.actions.cancel')}+ </Button>+ <Button onClick={handleSave} disabled={!type || createMutation.isPending}>+ {t('admin.actions.save')}+ </Button>+ </SheetFooter>+ </SheetContent>+ </Sheet>+ )+}++function EditRequirementSheet({+ id,+ open,+ onOpenChange,+}: {+ id: string+ open: boolean+ onOpenChange: (open: boolean) => void+}) {+ const { data: typesResponse } = useSellerRequirementTypes()+ // Reads the list already in cache rather than firing a request for one row.+ const { data: listResponse } = useSellerRequirements()++ const requirement = useMemo(+ () => listResponse?.data?.find((row: SellerRequirement) => row.id === id),+ [listResponse, id],+ )+ const kindEntry = useMemo(+ () => typesResponse?.data?.find((entry) => entry.type === requirement?.kind),+ [typesResponse, requirement],+ )++ // The form seeds its fields from the record once, so it must not mount+ // before the record is there — a form seeded from `undefined` would render+ // blank and then save those blanks over the requirement.+ if (!requirement) return null++ return (+ <EditRequirementForm+ requirement={requirement}+ kindEntry={kindEntry}+ open={open}+ onOpenChange={onOpenChange}+ />+ )+}++function EditRequirementForm({+ requirement,+ kindEntry,+ open,+ onOpenChange,+}: {+ requirement: SellerRequirement+ kindEntry: SellerRequirementType | undefined+ open: boolean+ onOpenChange: (open: boolean) => void+}) {+ const { t } = useTranslation()+ const updateMutation = useUpdateSellerRequirement(requirement.id)++ const [name, setName] = useState(requirement?.name ?? '')+ const [description, setDescription] = useState(requirement?.description ?? '')+ const [required, setRequired] = useState(requirement?.required ?? true)+ const [active, setActive] = useState(requirement?.active ?? true)+ const [preferences, setPreferences] = useState<Record<string, unknown>>(+ (requirement?.preferences as Record<string, unknown>) ?? {},+ )+ const [associationIds, setAssociationIds] = useState<string[]>(+ requirement?.custom_field_definition_ids ?? [],+ )+ const [saveError, setSaveError] = useState<string | null>(null)++ async function handleSave() {+ setSaveError(null)+ try {+ await updateMutation.mutateAsync({+ name: name || undefined,+ description: description || undefined,+ required,+ active,+ preferences,+ ...associationParams(kindEntry, associationIds),+ })+ onOpenChange(false)+ } catch (error) {+ setSaveError(error instanceof Error ? error.message : String(error))+ }+ }++ return (+ <Sheet open={open} onOpenChange={onOpenChange}>+ <SheetContent>+ <SheetHeader>+ <SheetTitle>{requirement?.name ?? t('admin.seller_requirements.edit_title')}</SheetTitle>+ </SheetHeader>+ <div className="flex flex-1 flex-col gap-4 overflow-y-auto p-4">+ {saveError && (+ // `role="alert"`: the message appears after a failed save, so a+ // screen reader has to be told rather than the operator being+ // expected to notice new text.+ <p role="alert" className="text-destructive text-sm">+ {saveError}+ </p>+ )}+ <FieldGroup>+ {kindEntry && (+ <RequirementFields+ kindEntry={kindEntry}+ values={{ name, description, required, preferences, associationIds }}+ onChange={{+ setName,+ setDescription,+ setRequired,+ setPreferences,+ setAssociationIds,+ }}+ />+ )}++ <SettingSwitch+ label={t('admin.seller_requirements.fields.active.label')}+ description={t('admin.seller_requirements.fields.active.help')}+ value={active}+ onChange={setActive}+ />+ </FieldGroup>+ </div>+ <SheetFooter>+ <Button variant="outline" onClick={() => onOpenChange(false)}>+ {t('admin.actions.cancel')}+ </Button>+ <Button onClick={handleSave} disabled={updateMutation.isPending}>+ {t('admin.actions.save')}+ </Button>+ </SheetFooter>+ </SheetContent>+ </Sheet>+ )+}++// Which picker an association-backed field gets. Keyed by the field name the+// types endpoint reports, so a kind that names records is configured with a+// real picker rather than a text box — and a kind the dashboard has not been+// taught about still renders its preference schema.+// eslint-disable-next-line @typescript-eslint/no-explicit-any+const ASSOCIATION_PICKERS: Record<string, (queryKey: string) => ResourceFilterConfig<any>> = {+ custom_field_definition_ids: customFieldDefinitionAutocompleteProps('Spree::Seller'),+}++/**+ * Sends the chosen records under the field name the kind declared, so a new+ * kind naming a different association needs no change here.+ */+function associationParams(+ kindEntry: SellerRequirementType | undefined,+ ids: string[],+): Record<string, string[]> {+ const field = kindEntry?.association_fields?.[0]+ if (!field || !ASSOCIATION_PICKERS[field]) return {}++ return { [field]: ids }+}++const CONTENT_TYPE_LABELS: Record<string, string> = {+ 'application/pdf': 'PDF',+ 'image/jpeg': 'JPEG',+ 'image/png': 'PNG',+ 'image/heic': 'HEIC',+ 'image/webp': 'WebP',+ 'application/msword': 'Word',+ 'application/vnd.openxmlformats-officedocument.wordprocessingml.document': 'Word',+}++/** MIME types as a person would name them, in order, without repeats. */+function formatContentTypes(types: string[]): string {+ const labels = types.map((type) => CONTENT_TYPE_LABELS[type] ?? type)++ return [...new Set(labels)].join(', ')+}++interface RequirementValues {+ name: string+ description: string+ required: boolean+ preferences: Record<string, unknown>+ associationIds: string[]+}++interface RequirementSetters {+ setName: (value: string) => void+ setDescription: (value: string) => void+ setRequired: (value: boolean) => void+ setPreferences: (value: Record<string, unknown>) => void+ setAssociationIds: (value: string[]) => void+}++/**+ * The part of the form both sheets share: how the requirement is worded, what+ * its kind takes as configuration, and whether it blocks approval.+ */+function RequirementFields({+ kindEntry,+ values,+ onChange,+}: {+ kindEntry: SellerRequirementType+ values: RequirementValues+ onChange: RequirementSetters+}) {+ const { t } = useTranslation()+ const associationPicker = ASSOCIATION_PICKERS[kindEntry.association_fields?.[0] ?? '']++ return (+ <>+ <Field>+ {/* A kind that can appear more than once has nothing else to tell it+ apart by, so its label is the operator's own wording. */}+ <FieldLabel>+ {kindEntry.allow_multiple+ ? t('admin.seller_requirements.fields.name.label_required')+ : t('admin.seller_requirements.fields.name.label')}+ </FieldLabel>+ <Input+ value={values.name}+ onChange={(event) => onChange.setName(event.target.value)}+ placeholder={kindEntry.name}+ />+ <p className="text-muted-foreground text-xs">+ {t('admin.seller_requirements.fields.name.help')}+ </p>+ </Field>++ <Field>+ <FieldLabel>{t('admin.seller_requirements.fields.description.label')}</FieldLabel>+ <Textarea+ value={values.description}+ onChange={(event) => onChange.setDescription(event.target.value)}+ placeholder={t('admin.seller_requirements.fields.description.placeholder')}+ />+ </Field>++ {kindEntry.preference_schema.length > 0 && (+ <PreferencesForm+ schema={kindEntry.preference_schema as unknown as PreferenceField[]}+ values={values.preferences}+ onChange={onChange.setPreferences}+ />+ )}++ {associationPicker && (+ <Field>+ <FieldLabel>{t('admin.seller_requirements.fields.custom_fields.label')}</FieldLabel>+ <ResourceMultiAutocomplete+ {...associationPicker(`seller-requirement-${kindEntry.type}`)}+ value={values.associationIds}+ onChange={onChange.setAssociationIds}+ />+ <p className="text-muted-foreground text-xs">+ {t('admin.seller_requirements.fields.custom_fields.help')}+ </p>+ </Field>+ )}++ {/* Stated, not asked: what a scan or a certificate arrives as is the+ same for every marketplace, and typing MIME types is a way to get+ `image/jpg` wrong and accept nothing. */}+ {kindEntry.accepted_content_types.length > 0 && (+ <Field>+ <FieldLabel>{t('admin.seller_requirements.fields.accepted_files.label')}</FieldLabel>+ <p className="text-muted-foreground text-xs">+ {t('admin.seller_requirements.fields.accepted_files.help', {+ types: formatContentTypes(kindEntry.accepted_content_types),+ })}+ </p>+ </Field>+ )}++ {/* Optional requirements are shown to the seller and counted in their+ progress, but never stand between them and approval. */}+ <SettingSwitch+ label={t('admin.seller_requirements.fields.required.label')}+ description={t('admin.seller_requirements.fields.required.help')}+ value={values.required}+ onChange={onChange.setRequired}+ />+ </>+ )+}++function SettingSwitch({+ label,+ description,+ value,+ onChange,+}: {+ label: string+ description: string+ value: boolean+ onChange: (value: boolean) => void+}) {+ return (+ <div className="flex items-center justify-between gap-3">+ <div className="flex flex-col">+ <span className="font-medium text-sm">{label}</span>+ <span className="text-muted-foreground text-xs">{description}</span>+ </div>+ <Switch checked={value} onCheckedChange={onChange} />+ </div>+ )+}diff --git a/packages/dashboard/src/tables/seller-requirements.tsx b/packages/dashboard/src/tables/seller-requirements.tsxnew file mode 100644index 0000000000..6c5271af61--- /dev/null+++ b/packages/dashboard/src/tables/seller-requirements.tsx@@ -0,0 +1,65 @@+import type { SellerRequirement } from '@spree/admin-sdk'+import { defineTable } from '@spree/dashboard-core'+import { ActiveBadge, Badge, ResourceNameCell } from '@spree/dashboard-ui'+import i18n from 'i18next'+import { ClipboardCheckIcon } from 'lucide-react'++defineTable<SellerRequirement>('seller-requirements', {+ title: i18n.t('admin.seller_requirements.title'),+ searchParam: 'name_cont',+ searchPlaceholder: i18n.t('admin.seller_requirements.search_placeholder'),+ defaultSort: { field: 'position', direction: 'asc' },+ emptyIcon: <ClipboardCheckIcon className="size-8 text-muted-foreground" />,+ emptyMessage: i18n.t('admin.seller_requirements.empty'),+ columns: [+ {+ key: 'name',+ label: i18n.t('admin.fields.name.label'),+ default: true,+ render: (requirement) => (+ <ResourceNameCell+ id={requirement.id}+ dataAttr="data-seller-requirement-id"+ name={requirement.name}+ secondary={requirement.description ?? undefined}+ />+ ),+ },+ {+ key: 'kind',+ label: i18n.t('admin.seller_requirements.columns.kind'),+ default: true,+ render: (requirement) => (+ <Badge variant="outline">+ {i18n.t(`admin.seller_requirements.kinds.${requirement.kind}`, {+ defaultValue: requirement.kind,+ })}+ </Badge>+ ),+ },+ {+ key: 'required',+ label: i18n.t('admin.seller_requirements.columns.required'),+ default: true,+ render: (requirement) => (+ <ActiveBadge+ active={requirement.required}+ activeLabel={i18n.t('admin.seller_requirements.required.yes')}+ inactiveLabel={i18n.t('admin.seller_requirements.required.no')}+ />+ ),+ },+ {+ key: 'active',+ label: i18n.t('admin.fields.status.label'),+ default: true,+ render: (requirement) => (+ <ActiveBadge+ active={requirement.active}+ activeLabel={i18n.t('admin.fields.active.label')}+ inactiveLabel={i18n.t('admin.seller_requirements.status.disabled')}+ />+ ),+ },+ ],+})