Skip to content

armgit / spree

Public Imported from GitHub
0

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.

Added metadata to every admin dashboard record that carries it (#15004)

Damian Legawiec6116abf1ef31
diff --git a/.changeset/dashboard-metadata-everywhere.md b/.changeset/dashboard-metadata-everywhere.md
new file mode 100644
index 0000000000..f890805d4f
--- /dev/null
+++ b/.changeset/dashboard-metadata-everywhere.md
@@ -0,0 +1,7 @@
+---
+"@spree/dashboard": patch
+"@spree/dashboard-core": patch
+"@spree/dashboard-ui": patch
+---
+
+The admin dashboard now shows metadata on every record that has it. Detail pages end their main column with Custom fields and Metadata, both folded to a header that counts what they hold, so the page leads with the record itself. Records listed inside another page (payments, fulfillments, returns, claims, exchanges, store credits, shipping labels, discounts, fees and seller requirement submissions) get a "View metadata" item in their row menu, and settings records edited in a side panel show it in a collapsed section; both appear only when the record has metadata.
diff --git a/packages/admin-sdk/src/types/generated/SellerPayout.ts b/packages/admin-sdk/src/types/generated/SellerPayout.ts
index bf4192ecde..2d36ed126d 100644
--- a/packages/admin-sdk/src/types/generated/SellerPayout.ts
+++ b/packages/admin-sdk/src/types/generated/SellerPayout.ts
@@ -1,4 +1,4 @@
-// Typelizer digest 3d1e66c9099bace2f5dd3496ef77ea54
+// Typelizer digest c794c23df28c76a559dd37001ca5047e
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
import type {SellerPayoutStatus, CurrencyCode} from '@/types'
@@ -8,7 +8,7 @@ interface SellerPayout {
status: SellerPayoutStatus;
currency: CurrencyCode;
reference: string | null;
- metadata: unknown;
+ metadata: Record<string, unknown>;
period_start: string | null;
period_end: string | null;
created_at: string;
diff --git a/packages/admin-sdk/src/zod/generated/SellerPayout.ts b/packages/admin-sdk/src/zod/generated/SellerPayout.ts
index 9412ca4610..e4a11e7cc4 100644
--- a/packages/admin-sdk/src/zod/generated/SellerPayout.ts
+++ b/packages/admin-sdk/src/zod/generated/SellerPayout.ts
@@ -6,7 +6,7 @@ export const SellerPayoutSchema = z.object({
status: z.string(),
currency: z.string(),
reference: z.string().nullable(),
- metadata: z.unknown(),
+ metadata: z.record(z.string(), z.unknown()),
period_start: z.string().nullable(),
period_end: z.string().nullable(),
created_at: z.string(),
diff --git a/packages/dashboard-core/src/api-client.ts b/packages/dashboard-core/src/api-client.ts
index 693b32e325..8cdc27b60f 100644
--- a/packages/dashboard-core/src/api-client.ts
+++ b/packages/dashboard-core/src/api-client.ts
@@ -362,6 +362,8 @@ export interface PanelPackageType extends PanelNamedRecord {
* editable.
*/
editable?: boolean
+ /** Operator-only; the seller panel's serializer leaves it out. */
+ metadata?: Record<string, unknown> | null
/** Whose packaging this is; null is the marketplace's own. */
seller_id?: string | null
seller_name?: string | null
diff --git a/packages/dashboard-core/src/components/record-metadata.tsx b/packages/dashboard-core/src/components/record-metadata.tsx
new file mode 100644
index 0000000000..84737b9789
--- /dev/null
+++ b/packages/dashboard-core/src/components/record-metadata.tsx
@@ -0,0 +1,95 @@
+import { DropdownMenuItem, hasMetadata, MetadataCard, MetadataSheet } from '@spree/dashboard-ui'
+import { BracesIcon } from '@spree/dashboard-ui/icons'
+import { useState } from 'react'
+import { useTranslation } from 'react-i18next'
+
+type Metadata = Record<string, unknown> | null | undefined
+
+/** Metadata card for the main column of a record's detail page. */
+export function RecordMetadataCard({ metadata }: { metadata: Metadata }) {
+ const { t } = useTranslation()
+ return (
+ <MetadataCard
+ metadata={metadata}
+ title={t('admin.components.metadata_card.title')}
+ emptyTitle={t('admin.components.metadata_card.empty_title')}
+ emptyDescription={t('admin.components.metadata_card.empty_description')}
+ />
+ )
+}
+
+/** Metadata of a row inside another page; pair with {@link ViewMetadataMenuItem}. */
+function RecordMetadataSheet({
+ metadata,
+ open,
+ onOpenChange,
+ description,
+}: {
+ metadata: Metadata
+ open: boolean
+ onOpenChange: (open: boolean) => void
+ /** Names the record, e.g. "Payment P123". */
+ description?: string
+}) {
+ const { t } = useTranslation()
+ return (
+ <MetadataSheet
+ open={open}
+ onOpenChange={onOpenChange}
+ metadata={metadata}
+ title={t('admin.components.metadata_card.title')}
+ description={description}
+ emptyTitle={t('admin.components.metadata_card.empty_title')}
+ emptyDescription={t('admin.components.metadata_card.empty_description')}
+ />
+ )
+}
+
+/**
+ * One metadata sheet for a list of rows: `show` it from a row's menu and render
+ * `sheet` once beside the list. The record stays set while the sheet animates
+ * closed, so it never flashes the empty state on the way out.
+ */
+export function useMetadataSheet() {
+ const [viewing, setViewing] = useState<{ metadata: Metadata; description?: string }>()
+ const [open, setOpen] = useState(false)
+
+ return {
+ show(metadata: Metadata, description?: string) {
+ setViewing({ metadata, description })
+ setOpen(true)
+ },
+ sheet: (
+ <RecordMetadataSheet
+ metadata={viewing?.metadata}
+ description={viewing?.description}
+ open={open}
+ onOpenChange={setOpen}
+ />
+ ),
+ }
+}
+
+/** Renders nothing when the record has no metadata, so a menu needs no check of its own. */
+export function ViewMetadataMenuItem({
+ metadata,
+ onClick,
+}: {
+ metadata: Metadata
+ onClick: () => void
+}) {
+ const { t } = useTranslation()
+ if (!hasMetadata(metadata)) return null
+
+ return (
+ <DropdownMenuItem onClick={onClick}>
+ <BracesIcon className="size-4" />
+ {t('admin.components.metadata_card.view')}
+ </DropdownMenuItem>
+ )
+}
+
+/** Metadata at the bottom of a record's edit sheet; renders nothing when there is none. */
+export function RecordMetadataSection({ metadata }: { metadata: Metadata }) {
+ return hasMetadata(metadata) ? <RecordMetadataCard metadata={metadata} /> : null
+}
diff --git a/packages/dashboard-core/src/index.ts b/packages/dashboard-core/src/index.ts
index acc082ddb1..38bc451835 100644
--- a/packages/dashboard-core/src/index.ts
+++ b/packages/dashboard-core/src/index.ts
@@ -50,6 +50,7 @@ export * from './components/nav-main'
export * from './components/page-header'
export * from './components/page-tabs'
export * from './components/preferences-form'
+export * from './components/record-metadata'
export * from './components/resource-combobox'
export * from './components/resource-multi-autocomplete'
export * from './components/resource-picker-sheet'
diff --git a/packages/dashboard-core/src/locales/ar.json b/packages/dashboard-core/src/locales/ar.json
index 12e41757c3..a07f2bbba5 100644
--- a/packages/dashboard-core/src/locales/ar.json
+++ b/packages/dashboard-core/src/locales/ar.json
@@ -368,7 +368,8 @@
"metadata_card": {
"empty_description": "تملأ التطبيقات والتكاملات هذا تلقائيًا.",
"empty_title": "لا توجد بيانات وصفية",
- "title": "البيانات الوصفية"
+ "title": "البيانات الوصفية",
+ "view": "عرض البيانات الوصفية"
},
"page_header": {
"copy_id": "نسخ ID",
diff --git a/packages/dashboard-core/src/locales/de.json b/packages/dashboard-core/src/locales/de.json
index 1fbf871397..54b44b62e3 100644
--- a/packages/dashboard-core/src/locales/de.json
+++ b/packages/dashboard-core/src/locales/de.json
@@ -368,7 +368,8 @@
"metadata_card": {
"empty_description": "Apps und Integrationen füllen dies automatisch.",
"empty_title": "Keine Metadaten",
- "title": "Metadaten"
+ "title": "Metadaten",
+ "view": "Metadaten anzeigen"
},
"page_header": {
"copy_id": "ID kopieren",
diff --git a/packages/dashboard-core/src/locales/en.json b/packages/dashboard-core/src/locales/en.json
index f2f76b4a00..0c5eea689f 100644
--- a/packages/dashboard-core/src/locales/en.json
+++ b/packages/dashboard-core/src/locales/en.json
@@ -370,7 +370,8 @@
"metadata_card": {
"empty_description": "Apps and integrations populate this automatically.",
"empty_title": "No metadata",
- "title": "Metadata"
+ "title": "Metadata",
+ "view": "View metadata"
},
"page_header": {
"copy_id": "Copy ID",
diff --git a/packages/dashboard-core/src/locales/es.json b/packages/dashboard-core/src/locales/es.json
index 9695f5fc4c..e955bd38d6 100644
--- a/packages/dashboard-core/src/locales/es.json
+++ b/packages/dashboard-core/src/locales/es.json
@@ -181,7 +181,8 @@
"metadata_card": {
"empty_description": "Las aplicaciones e integraciones lo completan automáticamente.",
"empty_title": "Sin metadatos",
- "title": "Metadatos"
+ "title": "Metadatos",
+ "view": "Ver metadatos"
},
"page_header": {
"copy_id": "Copiar ID",
diff --git a/packages/dashboard-core/src/locales/fr.json b/packages/dashboard-core/src/locales/fr.json
index 1b16d7f83c..5c6cdcc75b 100644
--- a/packages/dashboard-core/src/locales/fr.json
+++ b/packages/dashboard-core/src/locales/fr.json
@@ -368,7 +368,8 @@
"metadata_card": {
"empty_description": "Les applications et intégrations remplissent ceci automatiquement.",
"empty_title": "Aucune métadonnée",
- "title": "Métadonnées"
+ "title": "Métadonnées",
+ "view": "Voir les métadonnées"
},
"page_header": {
"copy_id": "Copier l'ID",
diff --git a/packages/dashboard-core/src/locales/pl.json b/packages/dashboard-core/src/locales/pl.json
index fe6719b844..154cdeea4e 100644
--- a/packages/dashboard-core/src/locales/pl.json
+++ b/packages/dashboard-core/src/locales/pl.json
@@ -369,7 +369,8 @@
"metadata_card": {
"empty_description": "Aplikacje i integracje wypełniają to automatycznie.",
"empty_title": "Brak metadanych",
- "title": "Metadane"
+ "title": "Metadane",
+ "view": "Pokaż metadane"
},
"page_header": {
"copy_id": "Kopiuj ID",
diff --git a/packages/dashboard-core/src/locales/zh-CN.json b/packages/dashboard-core/src/locales/zh-CN.json
index 7856007299..110d926ac5 100644
--- a/packages/dashboard-core/src/locales/zh-CN.json
+++ b/packages/dashboard-core/src/locales/zh-CN.json
@@ -368,7 +368,8 @@
"metadata_card": {
"empty_description": "应用和集成会自动填充此内容。",
"empty_title": "暂无元数据",
- "title": "元数据"
+ "title": "元数据",
+ "view": "查看元数据"
},
"page_header": {
"copy_id": "复制 ID",
diff --git a/packages/dashboard-core/src/pages/package-types.tsx b/packages/dashboard-core/src/pages/package-types.tsx
index 23c8cc7cfd..4a84b4695e 100644
--- a/packages/dashboard-core/src/pages/package-types.tsx
+++ b/packages/dashboard-core/src/pages/package-types.tsx
@@ -32,6 +32,7 @@ import { useTranslation } from 'react-i18next'
import { z } from 'zod/v4'
import type { PanelPackageType } from '../api-client'
import { Can } from '../components/can'
+import { RecordMetadataSection } from '../components/record-metadata'
import { ResourceTable, resourceSearchSchema } from '../components/resource-table'
import { HostFormSlot } from '../components/slot'
import {
@@ -338,6 +339,7 @@ function EditPackageTypeSheet({
name={`${formKey}.form_fields`}
context={{ packageType, mode: 'edit' }}
/>
+ <RecordMetadataSection metadata={packageType?.metadata} />
</div>
<SheetFooter>
<Button type="submit" disabled={updateMutation.isPending}>
diff --git a/packages/dashboard-ui/src/index.ts b/packages/dashboard-ui/src/index.ts
index a31f743a9a..93542b1501 100644
--- a/packages/dashboard-ui/src/index.ts
+++ b/packages/dashboard-ui/src/index.ts
@@ -39,6 +39,7 @@ export * from './spree/bulk-price-table'
export * from './spree/bulk-variants-table'
export * from './spree/calculator-summary'
export * from './spree/claim-resolve-dialog'
+export * from './spree/collapsible-card'
export * from './spree/color-picker'
export * from './spree/confirm-dialog'
export * from './spree/copy-to-clipboard-button'
diff --git a/packages/dashboard-ui/src/spree/collapsible-card.tsx b/packages/dashboard-ui/src/spree/collapsible-card.tsx
new file mode 100644
index 0000000000..8222dbf772
--- /dev/null
+++ b/packages/dashboard-ui/src/spree/collapsible-card.tsx
@@ -0,0 +1,66 @@
+import { type ReactNode, useState } from 'react'
+import { cn } from '../lib/utils'
+import { Badge } from '../ui/badge'
+import { Card, CardContent, CardHeader } from '../ui/card'
+import { Collapsible, CollapsibleContent, CollapsibleTrigger } from '../ui/collapsible'
+import { ChevronRightIcon } from './icons'
+
+interface CollapsibleCardProps {
+ title: ReactNode
+ icon?: ReactNode
+ /** Shown as a badge beside the title when above zero, so a closed card still says whether it holds anything. */
+ count?: number
+ /** Header controls kept outside the toggle, e.g. an Edit button. */
+ actions?: ReactNode
+ open?: boolean
+ defaultOpen?: boolean
+ onOpenChange?: (open: boolean) => void
+ children: ReactNode
+}
+
+/** A secondary card that starts folded to its header, for content most visits don't need. */
+export function CollapsibleCard({
+ title,
+ icon,
+ count = 0,
+ actions,
+ open,
+ defaultOpen = false,
+ onOpenChange,
+ children,
+}: CollapsibleCardProps) {
+ const [uncontrolledOpen, setUncontrolledOpen] = useState(defaultOpen)
+ const isOpen = open ?? uncontrolledOpen
+
+ function setOpen(next: boolean) {
+ if (open === undefined) setUncontrolledOpen(next)
+ onOpenChange?.(next)
+ }
+
+ return (
+ <Card>
+ <Collapsible open={isOpen} onOpenChange={setOpen}>
+ <CardHeader
+ className={cn('flex flex-row items-center gap-2 py-1.5', !isOpen && 'border-b-0')}
+ >
+ <CollapsibleTrigger className="group -mx-1 flex min-w-0 flex-1 cursor-pointer items-center gap-2 rounded-md px-1 py-1 text-left hover:bg-accent/50">
+ <ChevronRightIcon className="size-4 shrink-0 text-muted-foreground transition-transform group-data-[panel-open]:rotate-90 motion-reduce:transition-none" />
+ {/* CardTitle's styling on a span: a button may only hold phrasing content. */}
+ <span
+ data-slot="card-title"
+ className="flex items-center gap-2 text-base font-semibold"
+ >
+ {icon}
+ {title}
+ </span>
+ {count > 0 && <Badge variant="secondary">{count}</Badge>}
+ </CollapsibleTrigger>
+ {actions}
+ </CardHeader>
+ <CollapsibleContent>
+ <CardContent>{children}</CardContent>
+ </CollapsibleContent>
+ </Collapsible>
+ </Card>
+ )
+}
diff --git a/packages/dashboard-ui/src/spree/metadata/metadata-card.tsx b/packages/dashboard-ui/src/spree/metadata/metadata-card.tsx
index 1f90d58205..96958b1e8c 100644
--- a/packages/dashboard-ui/src/spree/metadata/metadata-card.tsx
+++ b/packages/dashboard-ui/src/spree/metadata/metadata-card.tsx
@@ -1,59 +1,99 @@
import { Fragment } from 'react'
-import { Card, CardContent, CardHeader, CardTitle } from '../../ui/card'
import { Empty, EmptyDescription, EmptyHeader, EmptyMedia, EmptyTitle } from '../../ui/empty'
+import { Sheet, SheetContent, SheetDescription, SheetHeader, SheetTitle } from '../../ui/sheet'
+import { CollapsibleCard } from '../collapsible-card'
import { BracesIcon } from '../icons'
-interface MetadataCardProps {
- /**
- * Free-form metadata stored on the record. Read-only — apps and integrations
- * write to this; admins just see what's there. Always an object (possibly
- * empty); the API never returns `null`.
- */
- metadata: Record<string, unknown>
- /** Translated copy (passed by the app — this component stays headless). */
- title: string
+/**
+ * Free-form metadata stored on a record. Read-only — apps and integrations
+ * write to it; admins just see what's there.
+ */
+type Metadata = Record<string, unknown> | null | undefined
+
+interface MetadataListProps {
+ metadata: Metadata
+ /** Translated copy (passed by the app — these components stay headless). */
emptyTitle: string
emptyDescription: string
}
-export function MetadataCard({ metadata, title, emptyTitle, emptyDescription }: MetadataCardProps) {
- const entries = Object.entries(metadata)
+export function hasMetadata(metadata: Metadata): metadata is Record<string, unknown> {
+ return !!metadata && Object.keys(metadata).length > 0
+}
+
+export function MetadataList({ metadata, emptyTitle, emptyDescription }: MetadataListProps) {
+ if (!hasMetadata(metadata)) {
+ return (
+ <Empty className="border-0 p-0">
+ <EmptyHeader>
+ <EmptyMedia variant="icon">
+ <BracesIcon />
+ </EmptyMedia>
+ <EmptyTitle>{emptyTitle}</EmptyTitle>
+ <EmptyDescription>{emptyDescription}</EmptyDescription>
+ </EmptyHeader>
+ </Empty>
+ )
+ }
+
+ return (
+ <dl className="grid grid-cols-[minmax(160px,1fr)_2fr] gap-x-4 gap-y-2 text-sm">
+ {Object.entries(metadata).map(([key, value]) => (
+ <Fragment key={key}>
+ <dt>
+ <code className="text-xs text-muted-foreground">{key}</code>
+ </dt>
+ <dd className="text-foreground/90 break-words font-mono text-xs">{formatValue(value)}</dd>
+ </Fragment>
+ ))}
+ </dl>
+ )
+}
+
+interface MetadataCardProps extends MetadataListProps {
+ title: string
+}
+
+/** Folded by default: metadata is for integrations, and the key count says whether there is any. */
+export function MetadataCard({ title, ...listProps }: MetadataCardProps) {
+ return (
+ <CollapsibleCard
+ title={title}
+ icon={<BracesIcon className="size-4" />}
+ count={Object.keys(listProps.metadata ?? {}).length}
+ >
+ <MetadataList {...listProps} />
+ </CollapsibleCard>
+ )
+}
+
+interface MetadataSheetProps extends MetadataListProps {
+ open: boolean
+ onOpenChange: (open: boolean) => void
+ title: string
+ description?: string
+}
+/** Metadata of a record listed inside another page, opened from its row menu. */
+export function MetadataSheet({
+ open,
+ onOpenChange,
+ title,
+ description,
+ ...listProps
+}: MetadataSheetProps) {
return (
- <Card>
- <CardHeader>
- <CardTitle>
- <BracesIcon className="size-4" />
- {title}
- </CardTitle>
- </CardHeader>
- <CardContent>
- {entries.length === 0 ? (
- <Empty className="border-0 p-0">
- <EmptyHeader>
- <EmptyMedia variant="icon">
- <BracesIcon />
- </EmptyMedia>
- <EmptyTitle>{emptyTitle}</EmptyTitle>
- <EmptyDescription>{emptyDescription}</EmptyDescription>
- </EmptyHeader>
- </Empty>
- ) : (
- <dl className="grid grid-cols-[minmax(160px,1fr)_2fr] gap-x-4 gap-y-2 text-sm">
- {entries.map(([key, value]) => (
- <Fragment key={key}>
- <dt>
- <code className="text-xs text-muted-foreground">{key}</code>
- </dt>
- <dd className="text-foreground/90 break-words font-mono text-xs">
- {formatValue(value)}
- </dd>
- </Fragment>
- ))}
- </dl>
- )}
- </CardContent>
- </Card>
+ <Sheet open={open} onOpenChange={onOpenChange}>
+ <SheetContent>
+ <SheetHeader>
+ <SheetTitle>{title}</SheetTitle>
+ {description && <SheetDescription>{description}</SheetDescription>}
+ </SheetHeader>
+ <div className="flex-1 overflow-y-auto p-4">
+ <MetadataList {...listProps} />
+ </div>
+ </SheetContent>
+ </Sheet>
)
}
diff --git a/packages/dashboard/e2e/custom-field-definitions.spec.ts b/packages/dashboard/e2e/custom-field-definitions.spec.ts
index c3bb99bc8d..535ff3e3ac 100644
--- a/packages/dashboard/e2e/custom-field-definitions.spec.ts
+++ b/packages/dashboard/e2e/custom-field-definitions.spec.ts
@@ -1,5 +1,5 @@
import { expect, type Page, test } from '@playwright/test'
-import { gotoIndex, login, openRowMenu, rowButton } from './helpers'
+import { expandCustomFieldsCard, gotoIndex, login, openRowMenu, rowButton } from './helpers'
const PATH = (storeId: string) => `/${storeId}/settings/custom-field-definitions`
const CTA = /add custom field/i
@@ -116,6 +116,7 @@ test.describe('custom field definitions', () => {
const customFields = page
.locator('[data-slot="card"]')
.filter({ has: page.locator('[data-slot="card-title"]', { hasText: /^custom fields$/i }) })
+ await expandCustomFieldsCard(page)
const input = customFields.getByLabel(new RegExp(`^${label}$`, 'i'))
await expect(input).toBeVisible({ timeout: 15_000 })
await input.fill('Aisle 7')
@@ -123,6 +124,7 @@ test.describe('custom field definitions', () => {
await expect(page.getByRole('button', { name: /^save$/i })).toBeDisabled({ timeout: 15_000 })
await page.reload()
+ await expandCustomFieldsCard(page)
await expect(customFields.getByLabel(new RegExp(`^${label}$`, 'i'))).toHaveValue('Aisle 7', {
timeout: 15_000,
})
@@ -153,6 +155,7 @@ test.describe('custom field definitions', () => {
await expect(page.getByText(/custom fields saved/i)).toBeVisible({ timeout: 15_000 })
await page.reload()
+ await expandCustomFieldsCard(page)
await expect(customFields.getByText('Gold')).toBeVisible({ timeout: 15_000 })
})
diff --git a/packages/dashboard/e2e/helpers.ts b/packages/dashboard/e2e/helpers.ts
index 1f46056b11..1e30c5d71c 100644
--- a/packages/dashboard/e2e/helpers.ts
+++ b/packages/dashboard/e2e/helpers.ts
@@ -494,6 +494,17 @@ function customFieldsCardOn(page: Page) {
.filter({ has: page.locator('[data-slot="card-title"]', { hasText: /^Custom fields$/ }) })
}
+/**
+ * Unfolds the custom fields card where a detail page folds it. A no-op on
+ * surfaces that always show it open, such as sheets and the new-product page.
+ */
+export async function expandCustomFieldsCard(page: Page) {
+ const card = customFieldsCardOn(page)
+ await expect(card).toBeVisible({ timeout: 15_000 })
+ const toggle = card.locator('[data-slot="card-header"] button[aria-expanded="false"]')
+ if (await toggle.count()) await toggle.click()
+}
+
/**
* Sets a value through a custom fields card that edits and saves itself (a
* detail page with no form of its own), and checks it survives a reload.
@@ -506,6 +517,7 @@ export async function saveCustomFieldOnCard(page: Page, label: string, value: st
await expect(card.getByText(value)).toBeVisible({ timeout: 15_000 })
await page.reload()
+ await expandCustomFieldsCard(page)
await expect(customFieldsCardOn(page).getByText(value)).toBeVisible({ timeout: 15_000 })
}
@@ -514,12 +526,14 @@ export async function saveCustomFieldOnCard(page: Page, label: string, value: st
* checks it survives a reload. A custom field alone must enable that Save.
*/
export async function saveCustomFieldWithPage(page: Page, label: string, value: string) {
+ await expandCustomFieldsCard(page)
await page.getByLabel(label).fill(value)
const save = page.getByRole('button', { name: /^save$/i })
await save.click()
await expect(save).toBeDisabled({ timeout: 15_000 })
await page.reload()
+ await expandCustomFieldsCard(page)
await expect(page.getByLabel(label)).toHaveValue(value, { timeout: 15_000 })
}
diff --git a/packages/dashboard/e2e/metadata.spec.ts b/packages/dashboard/e2e/metadata.spec.ts
new file mode 100644
index 0000000000..7bd059d825
--- /dev/null
+++ b/packages/dashboard/e2e/metadata.spec.ts
@@ -0,0 +1,89 @@
+import { expect, test } from '@playwright/test'
+import {
+ adminRequest,
+ createPlacedOrder,
+ deleteSeededRecords,
+ type E2ELoginSession,
+ gotoIndex,
+ login,
+ rowButton,
+ seedRecord,
+} from './helpers'
+
+// Metadata is written by apps and integrations, never in the dashboard, so
+// every record here is seeded with it through the Admin API.
+const METADATA = { erp_id: 'ERP-4711' }
+
+async function seedCompany(page: Parameters<typeof login>[0], session: E2ELoginSession) {
+ return seedRecord(page, session, '/companies', {
+ name: `E2E Metadata Co ${Date.now()}`,
+ metadata: METADATA,
+ })
+}
+
+test.describe('metadata', () => {
+ test.afterEach(({ page }) => deleteSeededRecords(page))
+
+ test('a detail page folds metadata to a counted header', async ({ page }) => {
+ const session = await login(page)
+ const company = await seedCompany(page, session)
+
+ await page.goto(`/${session.store_id}/companies/${company.id}`)
+
+ const toggle = page.getByRole('button', { name: /^metadata\s*1$/i })
+ await expect(toggle).toBeVisible({ timeout: 15_000 })
+ await expect(page.getByText('ERP-4711')).toBeHidden()
+
+ await toggle.click()
+ await expect(page.getByText('erp_id')).toBeVisible()
+ await expect(page.getByText('ERP-4711')).toBeVisible()
+ })
+
+ test('a row menu opens the metadata of a nested record', async ({ page }) => {
+ const session = await login(page)
+ const order = await createPlacedOrder(page, session.accessToken)
+ const fulfillments = await adminRequest<{
+ data: { fulfillment_items: { id: string }[] }[]
+ }>(page, session, 'get', `/orders/${order.id}/fulfillments?expand=fulfillment_items`)
+ const orderReturn = await adminRequest<{ id: string; number: string }>(
+ page,
+ session,
+ 'post',
+ `/orders/${order.id}/returns`,
+ {
+ items: [{ fulfillment_item_id: fulfillments.data[0].fulfillment_items[0].id, quantity: 1 }],
+ },
+ )
+ await adminRequest(page, session, 'patch', `/orders/${order.id}/returns/${orderReturn.id}`, {
+ metadata: METADATA,
+ })
+
+ await page.goto(`/${session.store_id}/orders/${order.id}`)
+ const returns = page.locator('[data-slot="card"]').filter({ hasText: /^returns/i })
+ await expect(returns.getByText(orderReturn.number)).toBeVisible({ timeout: 15_000 })
+ await returns.getByRole('button', { name: /actions/i }).click()
+ await page.getByRole('menuitem', { name: /view metadata/i }).click()
+
+ const sheet = page.getByRole('dialog')
+ await expect(sheet.getByText('erp_id')).toBeVisible()
+ await expect(sheet.getByText('ERP-4711')).toBeVisible()
+ })
+
+ test('an edit sheet keeps metadata collapsed until opened', async ({ page }) => {
+ const session = await login(page)
+ const name = `E2E Metadata Supplier ${Date.now()}`
+ await seedRecord(page, session, '/suppliers', { name, metadata: METADATA })
+
+ await gotoIndex(page, `/${session.store_id}/suppliers`, /new supplier/i)
+ await rowButton(page, name).click()
+
+ const sheet = page.getByRole('dialog')
+ const section = sheet.getByRole('button', { name: /^metadata\s*1$/i })
+ await expect(section).toBeVisible({ timeout: 15_000 })
+ await expect(sheet.getByText('ERP-4711')).toBeHidden()
+
+ await section.click()
+ await expect(sheet.getByText('erp_id')).toBeVisible()
+ await expect(sheet.getByText('ERP-4711')).toBeVisible()
+ })
+})
diff --git a/packages/dashboard/e2e/products-custom-fields.spec.ts b/packages/dashboard/e2e/products-custom-fields.spec.ts
index fdd50ea2fc..4d77974cd2 100644
--- a/packages/dashboard/e2e/products-custom-fields.spec.ts
+++ b/packages/dashboard/e2e/products-custom-fields.spec.ts
@@ -1,5 +1,5 @@
import { expect, type Page, test } from '@playwright/test'
-import { gotoIndex, login } from './helpers'
+import { expandCustomFieldsCard, gotoIndex, login } from './helpers'
import { customFieldsCard, PRODUCTS_PATH } from './products-helpers'
const DEFINITIONS_PATH = (storeId: string) => `/${storeId}/settings/custom-field-definitions`
@@ -44,6 +44,7 @@ test.describe('product custom fields — new product', () => {
await expect(page).toHaveURL(new RegExp(`/${creds.store_id}/products/prod_[^/]+$`), {
timeout: 30_000,
})
+ await expandCustomFieldsCard(page)
await expect(customFieldsCard(page).getByLabel(new RegExp(`^${fieldLabel}$`, 'i'))).toHaveValue(
'Cotton',
@@ -68,6 +69,7 @@ test.describe('product custom fields — existing product', () => {
timeout: 30_000,
})
+ await expandCustomFieldsCard(page)
const cfCard = customFieldsCard(page)
const input = cfCard.getByLabel(new RegExp(`^${fieldLabel}$`, 'i'))
await expect(input).toBeVisible({ timeout: 15_000 })
@@ -81,6 +83,7 @@ test.describe('product custom fields — existing product', () => {
await expect(saveButton).toBeDisabled({ timeout: 30_000 })
await page.reload()
+ await expandCustomFieldsCard(page)
await expect(customFieldsCard(page).getByLabel(new RegExp(`^${fieldLabel}$`, 'i'))).toHaveValue(
'Slim',
diff --git a/packages/dashboard/src/components/spree/categories/category-form.tsx b/packages/dashboard/src/components/spree/categories/category-form.tsx
index 745359b5cd..8f6c27dead 100644
--- a/packages/dashboard/src/components/spree/categories/category-form.tsx
+++ b/packages/dashboard/src/components/spree/categories/category-form.tsx
@@ -1,5 +1,5 @@
import type { Category } from '@spree/admin-sdk'
-import { ResourceCombobox } from '@spree/dashboard-core'
+import { RecordMetadataCard, ResourceCombobox } from '@spree/dashboard-core'
import {
Card,
CardContent,
@@ -10,7 +10,6 @@ import {
FieldGroup,
FieldLabel,
Input,
- MetadataCard,
Textarea,
} from '@spree/dashboard-ui'
import type { UseFormReturn } from 'react-hook-form'
@@ -89,20 +88,15 @@ export function CategoryMain({
{category && (
<>
<CategoryProductsCard categoryId={category.id} />
+ <ResourceTranslationsCard resourceType="category" resourceId={category.id} />
{/*
Form-backed: custom field values ride along in the category form and
persist on the page's Save.
*/}
<FormBackedCustomFieldsProvider form={form} resourceType="category">
- <CustomFieldsInlineCard />
+ <CustomFieldsInlineCard collapsible />
</FormBackedCustomFieldsProvider>
- <ResourceTranslationsCard resourceType="category" resourceId={category.id} />
- <MetadataCard
- metadata={category.metadata}
- title={t('admin.components.metadata_card.title')}
- emptyTitle={t('admin.components.metadata_card.empty_title')}
- emptyDescription={t('admin.components.metadata_card.empty_description')}
- />
+ <RecordMetadataCard metadata={category.metadata} />
</>
)}
</>
diff --git a/packages/dashboard/src/components/spree/collections/collection-form.tsx b/packages/dashboard/src/components/spree/collections/collection-form.tsx
index fddf01276d..07236141b5 100644
--- a/packages/dashboard/src/components/spree/collections/collection-form.tsx
+++ b/packages/dashboard/src/components/spree/collections/collection-form.tsx
@@ -1,5 +1,6 @@
import type { Collection } from '@spree/admin-sdk'
import { COLLECTION_SORT_ORDERS } from '@spree/core'
+import { RecordMetadataCard } from '@spree/dashboard-core'
import {
Card,
CardContent,
@@ -11,7 +12,6 @@ import {
FieldGroup,
FieldLabel,
Input,
- MetadataCard,
Select,
SelectContent,
SelectItem,
@@ -93,16 +93,11 @@ export function CollectionMain({
{collection && (
<>
<CollectionProductsCard collectionId={collection.id} automatic={automatic} />
+ <ResourceTranslationsCard resourceType="collection" resourceId={collection.id} />
<FormBackedCustomFieldsProvider form={form} resourceType="collection">
- <CustomFieldsInlineCard />
+ <CustomFieldsInlineCard collapsible />
</FormBackedCustomFieldsProvider>
- <ResourceTranslationsCard resourceType="collection" resourceId={collection.id} />
- <MetadataCard
- metadata={collection.metadata}
- title={t('admin.components.metadata_card.title')}
- emptyTitle={t('admin.components.metadata_card.empty_title')}
- emptyDescription={t('admin.components.metadata_card.empty_description')}
- />
+ <RecordMetadataCard metadata={collection.metadata} />
</>
)}
</>
diff --git a/packages/dashboard/src/components/spree/custom-fields/custom-fields-inline.tsx b/packages/dashboard/src/components/spree/custom-fields/custom-fields-inline.tsx
index 308ec777ff..7c19c31d61 100644
--- a/packages/dashboard/src/components/spree/custom-fields/custom-fields-inline.tsx
+++ b/packages/dashboard/src/components/spree/custom-fields/custom-fields-inline.tsx
@@ -43,6 +43,7 @@ import {
CardContent,
CardHeader,
CardTitle,
+ CollapsibleCard,
Empty,
EmptyContent,
EmptyDescription,
@@ -72,7 +73,15 @@ import {
TagIcon,
} from '@spree/dashboard-ui/icons'
import { Link, useParams } from '@tanstack/react-router'
-import { createContext, type ReactNode, useCallback, useContext, useMemo, useState } from 'react'
+import {
+ createContext,
+ type ReactNode,
+ useCallback,
+ useContext,
+ useEffect,
+ useMemo,
+ useState,
+} from 'react'
import { type UseFormReturn, useForm } from 'react-hook-form'
import { useTranslation } from 'react-i18next'
import {
@@ -575,10 +584,12 @@ export function ApiCustomFieldsCard({
ownerType,
ownerId,
hideWhenEmpty,
+ collapsible,
}: {
ownerType: CustomFieldOwnerType
ownerId: string
hideWhenEmpty?: boolean
+ collapsible?: boolean
}) {
return (
<EditableApiCustomFieldsProvider
@@ -586,7 +597,7 @@ export function ApiCustomFieldsCard({
ownerId={ownerId}
resourceType={ownerType}
>
- <CustomFieldsInlineCard hideWhenEmpty={hideWhenEmpty} />
+ <CustomFieldsInlineCard hideWhenEmpty={hideWhenEmpty} collapsible={collapsible} />
</EditableApiCustomFieldsProvider>
)
}
@@ -595,13 +606,15 @@ export function ApiCustomFieldsCard({
export function DraftCustomFieldsCard({
draft,
hideWhenEmpty,
+ collapsible,
}: {
draft: CustomFieldsDraft
hideWhenEmpty?: boolean
+ collapsible?: boolean
}) {
return (
<DraftCustomFieldsProvider draft={draft}>
- <CustomFieldsInlineCard hideWhenEmpty={hideWhenEmpty} />
+ <CustomFieldsInlineCard hideWhenEmpty={hideWhenEmpty} collapsible={collapsible} />
</DraftCustomFieldsProvider>
)
}
@@ -617,13 +630,28 @@ interface CustomFieldsInlineCardProps {
* defined in Settings, which offers every resource with an edit surface.
*/
hideWhenEmpty?: boolean
+ /** Folds the card to its header, with a count of filled fields. For the end of a detail page's main column. */
+ collapsible?: boolean
}
-export function CustomFieldsInlineCard({ hideWhenEmpty = false }: CustomFieldsInlineCardProps) {
+export function CustomFieldsInlineCard({
+ hideWhenEmpty = false,
+ collapsible = false,
+}: CustomFieldsInlineCardProps) {
const { t } = useTranslation()
const [createOpen, setCreateOpen] = useState(false)
+ const [open, setOpen] = useState(false)
const {
- meta: { isLoading, definitions, resourceType, resourceLabel, canEdit, loadFailed },
+ state: { values },
+ meta: {
+ isLoading,
+ definitions,
+ resourceType,
+ resourceLabel,
+ canEdit,
+ loadFailed,
+ requiredDefinitionIds,
+ },
mode,
} = useCustomFieldsContext()
@@ -632,46 +660,92 @@ export function CustomFieldsInlineCard({ hideWhenEmpty = false }: CustomFieldsIn
const hasDefinitions = definitions.length > 0
const openCreate = useCallback(() => setCreateOpen(true), [])
+ const requiredMissing = definitions.some(
+ (definition) =>
+ requiredDefinitionIds?.includes(definition.id) && isBlankValue(values[definition.id]),
+ )
+
+ // Opens once rather than tracking the flags, so the card does not fold away
+ // the moment the merchant fills the last required field in. A failed load
+ // opens it too: the error lives in the body, out of sight while folded.
+ useEffect(() => {
+ if (requiredMissing || loadFailed) setOpen(true)
+ }, [requiredMissing, loadFailed])
+
if (canEdit === false || (hideWhenEmpty && !hasDefinitions)) return null
+ const title = t('admin.components.custom_fields.section_title')
+ const icon = <SquareTextIcon className="size-4" />
+ const actions = !isLoading && !loadFailed && hasDefinitions && (
+ <EditableHeaderActions onStartEdit={() => setOpen(true)} />
+ )
+ const body = isLoading ? (
+ <LoadingRows />
+ ) : loadFailed ? (
+ <p className="text-sm text-destructive" role="alert">
+ {t('admin.components.custom_fields.errors.failed_to_load')}
+ </p>
+ ) : !hasDefinitions ? (
+ <CustomFieldsEmptyState onSetUp={openCreate} />
+ ) : editing ? (
+ <FieldsEditor onSetUp={openCreate} />
+ ) : (
+ <FieldsDisplay />
+ )
+ const createSheet = (
+ <CreateDefinitionSheet
+ open={createOpen}
+ onOpenChange={setCreateOpen}
+ resourceType={resourceType}
+ resourceLabel={resourceLabel}
+ />
+ )
+
+ if (collapsible) {
+ return (
+ <>
+ <CollapsibleCard
+ title={title}
+ icon={icon}
+ count={definitions.filter((definition) => !isBlankValue(values[definition.id])).length}
+ actions={actions}
+ open={open}
+ onOpenChange={setOpen}
+ >
+ {body}
+ </CollapsibleCard>
+ {createSheet}
+ </>
+ )
+ }
+
return (
<Card>
<CardHeader className="flex flex-row items-center justify-between gap-3 space-y-0">
<CardTitle>
- <SquareTextIcon className="size-4" />
- {t('admin.components.custom_fields.section_title')}
+ {icon}
+ {title}
</CardTitle>
- {!isLoading && !loadFailed && hasDefinitions && <EditableHeaderActions />}
+ {actions}
</CardHeader>
- <CardContent>
- {isLoading ? (
- <LoadingRows />
- ) : loadFailed ? (
- <p className="text-sm text-destructive" role="alert">
- {t('admin.components.custom_fields.errors.failed_to_load')}
- </p>
- ) : !hasDefinitions ? (
- <CustomFieldsEmptyState onSetUp={openCreate} />
- ) : editing ? (
- <FieldsEditor onSetUp={openCreate} />
- ) : (
- <FieldsDisplay />
- )}
- </CardContent>
-
- <CreateDefinitionSheet
- open={createOpen}
- onOpenChange={setCreateOpen}
- resourceType={resourceType}
- resourceLabel={resourceLabel}
- />
+ <CardContent>{body}</CardContent>
+ {createSheet}
</Card>
)
}
+function isBlankValue(value: unknown) {
+ return (
+ value === null ||
+ value === undefined ||
+ (typeof value === 'string' && value.trim() === '') ||
+ (Array.isArray(value) && value.length === 0)
+ )
+}
+
// Edit / Cancel+Save buttons — only rendered in editable mode. Reads the mode
// off context so the card body stays a thin selector.
-function EditableHeaderActions() {
+function EditableHeaderActions({ onStartEdit }: { onStartEdit: () => void }) {
const { t } = useTranslation()
const { mode } = useCustomFieldsContext()
if (mode.kind !== 'editable') return null
@@ -682,7 +756,10 @@ function EditableHeaderActions() {
variant="ghost"
size="icon-sm"
type="button"
- onClick={mode.startEdit}
+ onClick={() => {
+ onStartEdit()
+ mode.startEdit()
+ }}
aria-label={t('admin.actions.edit')}
>
<PencilIcon className="size-4" />
diff --git a/packages/dashboard/src/components/spree/customers/customer-store-credits-card.tsx b/packages/dashboard/src/components/spree/customers/customer-store-credits-card.tsx
index e35e9b373f..1d983a1d96 100644
--- a/packages/dashboard/src/components/spree/customers/customer-store-credits-card.tsx
+++ b/packages/dashboard/src/components/spree/customers/customer-store-credits-card.tsx
@@ -1,5 +1,5 @@
import type { Customer, StoreCredit } from '@spree/admin-sdk'
-import { Money } from '@spree/dashboard-core'
+import { Money, useMetadataSheet, ViewMetadataMenuItem } from '@spree/dashboard-core'
import {
Badge,
Button,
@@ -31,6 +31,7 @@ export function CustomerStoreCreditsCard({ customer }: { customer: Customer }) {
const { t } = useTranslation()
const [addOpen, setAddOpen] = useState(false)
const [editing, setEditing] = useState<StoreCredit | null>(null)
+ const metadataSheet = useMetadataSheet()
const confirm = useConfirm()
const credits = customer.store_credits ?? []
@@ -95,6 +96,10 @@ export function CustomerStoreCreditsCard({ customer }: { customer: Customer }) {
<PencilIcon className="size-4" />
{t('admin.actions.edit')}
</DropdownMenuItem>
+ <ViewMetadataMenuItem
+ metadata={sc.metadata}
+ onClick={() => metadataSheet.show(sc.metadata)}
+ />
<DropdownMenuItem
variant="destructive"
onClick={async () => {
@@ -135,6 +140,7 @@ export function CustomerStoreCreditsCard({ customer }: { customer: Customer }) {
}}
/>
)}
+ {metadataSheet.sheet}
</>
)
}
diff --git a/packages/dashboard/src/components/spree/order-post-sale-cards.tsx b/packages/dashboard/src/components/spree/order-post-sale-cards.tsx
index 9bf24463a2..39d88811be 100644
--- a/packages/dashboard/src/components/spree/order-post-sale-cards.tsx
+++ b/packages/dashboard/src/components/spree/order-post-sale-cards.tsx
@@ -1,6 +1,12 @@
import type { Claim, Exchange, Order } from '@spree/admin-sdk'
import { CLAIM_STATUSES, EXCHANGE_STATUSES, subsetOf } from '@spree/core'
-import { isPositiveMoney, Money, usePermissions } from '@spree/dashboard-core'
+import {
+ isPositiveMoney,
+ Money,
+ useMetadataSheet,
+ usePermissions,
+ ViewMetadataMenuItem,
+} from '@spree/dashboard-core'
import {
Badge,
Button,
@@ -15,6 +21,7 @@ import {
DropdownMenuItem,
DropdownMenuSeparator,
DropdownMenuTrigger,
+ hasMetadata,
StatusBadge,
useConfirm,
} from '@spree/dashboard-ui'
@@ -64,6 +71,7 @@ export function OrderExchangesCard({ order }: { order: Order }) {
const { permissionKeys } = usePermissions()
const canRefund = permissionKeys.includes('write_refunds')
const [creating, setCreating] = useState(false)
+ const metadataSheet = useMetadataSheet()
const exchanges = data?.data ?? []
const canCreate = fulfilledUnits(order).length > 0
@@ -106,7 +114,8 @@ export function OrderExchangesCard({ order }: { order: Order }) {
<span className="text-sm font-medium">{exchange.number}</span>
</CardTitle>
- {EXCHANGE_ACTIONABLE.includes(exchange.status) && (
+ {(EXCHANGE_ACTIONABLE.includes(exchange.status) ||
+ hasMetadata(exchange.metadata)) && (
<CardAction>
<DropdownMenu>
<DropdownMenuTrigger asChild>
@@ -155,6 +164,10 @@ export function OrderExchangesCard({ order }: { order: Order }) {
{t('admin.pages.orders.detail.exchanges.actions.fulfill')}
</DropdownMenuItem>
)}
+ <ViewMetadataMenuItem
+ metadata={exchange.metadata}
+ onClick={() => metadataSheet.show(exchange.metadata, exchange.number)}
+ />
{EXCHANGE_CANCELABLE.includes(exchange.status) && (
<>
<DropdownMenuSeparator />
@@ -224,6 +237,8 @@ export function OrderExchangesCard({ order }: { order: Order }) {
}}
/>
)}
+
+ {metadataSheet.sheet}
</>
)
}
@@ -241,6 +256,7 @@ export function OrderClaimsCard({ order }: { order: Order }) {
const canRefund = permissionKeys.includes('write_refunds')
const [creatingClaim, setCreatingClaim] = useState(false)
const [resolving, setResolving] = useState<Claim | null>(null)
+ const metadataSheet = useMetadataSheet()
const claims = data?.data ?? []
// A claim is about ordered items, so it never depends on anything shipping.
@@ -281,7 +297,7 @@ export function OrderClaimsCard({ order }: { order: Order }) {
<span className="text-sm font-medium">{claim.number}</span>
</CardTitle>
- {CLAIM_ACTIONABLE.includes(claim.status) && (
+ {(CLAIM_ACTIONABLE.includes(claim.status) || hasMetadata(claim.metadata)) && (
<CardAction>
<DropdownMenu>
<DropdownMenuTrigger asChild>
@@ -303,6 +319,10 @@ export function OrderClaimsCard({ order }: { order: Order }) {
{t('admin.pages.orders.detail.claims.actions.resolve')}
</DropdownMenuItem>
)}
+ <ViewMetadataMenuItem
+ metadata={claim.metadata}
+ onClick={() => metadataSheet.show(claim.metadata, claim.number)}
+ />
{CLAIM_ACTIONABLE.includes(claim.status) && <DropdownMenuSeparator />}
{claim.status === 'open' && (
<DropdownMenuItem
@@ -407,6 +427,8 @@ export function OrderClaimsCard({ order }: { order: Order }) {
}}
/>
)}
+
+ {metadataSheet.sheet}
</>
)
}
diff --git a/packages/dashboard/src/components/spree/order-returns-card.tsx b/packages/dashboard/src/components/spree/order-returns-card.tsx
index e61f98feb5..900e86b965 100644
--- a/packages/dashboard/src/components/spree/order-returns-card.tsx
+++ b/packages/dashboard/src/components/spree/order-returns-card.tsx
@@ -6,8 +6,10 @@ import {
isPositiveMoney,
returnOwesNothing,
returnRefundSummary,
+ useMetadataSheet,
useMoneyLocale,
usePermissions,
+ ViewMetadataMenuItem,
} from '@spree/dashboard-core'
import {
Badge,
@@ -23,6 +25,7 @@ import {
DropdownMenuItem,
DropdownMenuSeparator,
DropdownMenuTrigger,
+ hasMetadata,
type RefundMethod,
ReturnReceiveDialog,
ReturnRefundDialog,
@@ -76,6 +79,7 @@ export function OrderReturnsCard({ order }: { order: Order }) {
const [creating, setCreating] = useState(false)
const [receiving, setReceiving] = useState<Return | null>(null)
const [refunding, setRefunding] = useState<Return | null>(null)
+ const metadataSheet = useMetadataSheet()
const returns = data?.data ?? []
const canCreate = fulfilledUnits(order).length > 0
@@ -118,7 +122,8 @@ export function OrderReturnsCard({ order }: { order: Order }) {
<span className="text-sm font-medium">{returnRecord.number}</span>
</CardTitle>
- {RETURN_ACTIONABLE.includes(returnRecord.status) && (
+ {(RETURN_ACTIONABLE.includes(returnRecord.status) ||
+ hasMetadata(returnRecord.metadata)) && (
<CardAction>
<DropdownMenu>
<DropdownMenuTrigger asChild>
@@ -155,6 +160,12 @@ export function OrderReturnsCard({ order }: { order: Order }) {
)}
</DropdownMenuItem>
)}
+ <ViewMetadataMenuItem
+ metadata={returnRecord.metadata}
+ onClick={() =>
+ metadataSheet.show(returnRecord.metadata, returnRecord.number)
+ }
+ />
{RETURN_CANCELABLE.includes(returnRecord.status) && (
<>
<DropdownMenuSeparator />
@@ -249,6 +260,8 @@ export function OrderReturnsCard({ order }: { order: Order }) {
}}
/>
)}
+
+ {metadataSheet.sheet}
</>
)
}
diff --git a/packages/dashboard/src/components/spree/orders/fulfillments-card.tsx b/packages/dashboard/src/components/spree/orders/fulfillments-card.tsx
index b4a96677f4..79a2ce0382 100644
--- a/packages/dashboard/src/components/spree/orders/fulfillments-card.tsx
+++ b/packages/dashboard/src/components/spree/orders/fulfillments-card.tsx
@@ -7,8 +7,10 @@ import {
isPositiveMoney,
Money,
unfulfilledItemRows,
+ useMetadataSheet,
useMoneyLocale,
useStockLocations,
+ ViewMetadataMenuItem,
} from '@spree/dashboard-core'
import {
Badge,
@@ -431,6 +433,7 @@ function FulfillmentRow({ order, fulfillment }: { order: Order; fulfillment: Ful
const [editingDelivery, setEditingDelivery] = useState<Delivery | undefined>()
const [uploadOpen, setUploadOpen] = useState(false)
const [fulfilling, setFulfilling] = useState(false)
+ const metadataSheet = useMetadataSheet()
const editable = CAN_EDIT.includes(fulfillment.status)
const splittable = editable && unitsOf(fulfillment).length > 0
@@ -515,6 +518,11 @@ function FulfillmentRow({ order, fulfillment }: { order: Order; fulfillment: Ful
</DropdownMenuItem>
)}
+ <ViewMetadataMenuItem
+ metadata={fulfillment.metadata}
+ onClick={() => metadataSheet.show(fulfillment.metadata)}
+ />
+
{CAN_CANCEL.includes(fulfillment.status) && (
<>
<DropdownMenuSeparator />
@@ -733,6 +741,8 @@ function FulfillmentRow({ order, fulfillment }: { order: Order; fulfillment: Ful
onOpenChange={setUploadOpen}
/>
)}
+
+ {metadataSheet.sheet}
</FulfillmentPanel>
)
}
diff --git a/packages/dashboard/src/components/spree/orders/order-adjustments-cards.tsx b/packages/dashboard/src/components/spree/orders/order-adjustments-cards.tsx
index 3752839299..2084134ea7 100644
--- a/packages/dashboard/src/components/spree/orders/order-adjustments-cards.tsx
+++ b/packages/dashboard/src/components/spree/orders/order-adjustments-cards.tsx
@@ -7,7 +7,15 @@ import {
isZeroMoney,
sumMoney,
} from '@spree/core'
-import { adminClient, currencyParts, formatMoney, Money, percentOf } from '@spree/dashboard-core'
+import {
+ adminClient,
+ currencyParts,
+ formatMoney,
+ Money,
+ percentOf,
+ useMetadataSheet,
+ ViewMetadataMenuItem,
+} from '@spree/dashboard-core'
import {
Badge,
Button,
@@ -30,6 +38,7 @@ import {
Field,
FieldGroup,
FieldLabel,
+ hasMetadata,
Input,
InputGroup,
InputGroupAddon,
@@ -79,17 +88,21 @@ function feeKindLabel(kind: string) {
: kind
}
-/** Trailing action cell — renders empty (keeping column width) for undeletable rows. */
-function AdjustmentDeleteCell({
+/** Trailing action cell — renders empty (keeping column width) for rows with no actions. */
+function AdjustmentActionsCell({
+ metadata,
+ onViewMetadata,
onDelete,
deleting,
}: {
+ metadata: Record<string, unknown> | null
+ onViewMetadata: () => void
onDelete?: () => void
deleting?: boolean
}) {
return (
<TableCell className="w-10 text-right">
- {onDelete && (
+ {(onDelete || hasMetadata(metadata)) && (
<DropdownMenu>
<DropdownMenuTrigger asChild>
<Button
@@ -102,10 +115,13 @@ function AdjustmentDeleteCell({
</Button>
</DropdownMenuTrigger>
<DropdownMenuContent align="end">
- <DropdownMenuItem variant="destructive" onClick={onDelete}>
- <TrashIcon className="size-4" />
- {i18n.t('admin.actions.delete')}
- </DropdownMenuItem>
+ <ViewMetadataMenuItem metadata={metadata} onClick={onViewMetadata} />
+ {onDelete && (
+ <DropdownMenuItem variant="destructive" onClick={onDelete}>
+ <TrashIcon className="size-4" />
+ {i18n.t('admin.actions.delete')}
+ </DropdownMenuItem>
+ )}
</DropdownMenuContent>
</DropdownMenu>
)}
@@ -206,6 +222,7 @@ export function OrderDiscountsCard({ order }: { order: Order }) {
const orderId = order.id
const confirm = useConfirm()
const [addDiscountOpen, setAddDiscountOpen] = useState(false)
+ const metadataSheet = useMetadataSheet()
const { data: discounts } = useOrderDiscounts(orderId)
const deleteDiscountMutation = useOrderAdjustmentLinesMutation(orderId, (id: string) =>
@@ -278,7 +295,9 @@ export function OrderDiscountsCard({ order }: { order: Order }) {
<TableCell className="text-right tabular-nums">
<Money amount={row.amount} currency={order.currency} />
</TableCell>
- <AdjustmentDeleteCell
+ <AdjustmentActionsCell
+ metadata={row.metadata}
+ onViewMetadata={() => metadataSheet.show(row.metadata)}
onDelete={row.kind === 'promotion' ? undefined : () => handleDeleteDiscount(row)}
deleting={deleteDiscountMutation.isPending}
/>
@@ -289,6 +308,7 @@ export function OrderDiscountsCard({ order }: { order: Order }) {
)}
<AddDiscountDialog order={order} open={addDiscountOpen} onOpenChange={setAddDiscountOpen} />
+ {metadataSheet.sheet}
</Card>
)
}
@@ -298,6 +318,7 @@ export function FeesCard({ order }: { order: Order }) {
const orderId = order.id
const confirm = useConfirm()
const [addFeeOpen, setAddFeeOpen] = useState(false)
+ const metadataSheet = useMetadataSheet()
const { data: fees } = useOrderFees(orderId)
const deleteFeeMutation = useOrderAdjustmentLinesMutation(orderId, (id: string) =>
@@ -359,7 +380,9 @@ export function FeesCard({ order }: { order: Order }) {
<TableCell className="text-right tabular-nums">
<Money amount={row.amount} currency={order.currency} />
</TableCell>
- <AdjustmentDeleteCell
+ <AdjustmentActionsCell
+ metadata={row.metadata}
+ onViewMetadata={() => metadataSheet.show(row.metadata)}
onDelete={() => handleDeleteFee(row)}
deleting={deleteFeeMutation.isPending}
/>
@@ -370,6 +393,7 @@ export function FeesCard({ order }: { order: Order }) {
)}
<AddFeeDialog order={order} open={addFeeOpen} onOpenChange={setAddFeeOpen} />
+ {metadataSheet.sheet}
</Card>
)
}
diff --git a/packages/dashboard/src/components/spree/orders/order-payments-card.tsx b/packages/dashboard/src/components/spree/orders/order-payments-card.tsx
index de92afb85f..2d5e835ee8 100644
--- a/packages/dashboard/src/components/spree/orders/order-payments-card.tsx
+++ b/packages/dashboard/src/components/spree/orders/order-payments-card.tsx
@@ -1,5 +1,11 @@
import type { Order, Payment } from '@spree/admin-sdk'
-import { adminClient, currencyParts, Money } from '@spree/dashboard-core'
+import {
+ adminClient,
+ currencyParts,
+ Money,
+ useMetadataSheet,
+ ViewMetadataMenuItem,
+} from '@spree/dashboard-core'
import {
Badge,
Button,
@@ -249,6 +255,7 @@ function PaymentActionsMenu({
}) {
const { t } = useTranslation()
const [detailsOpen, setDetailsOpen] = useState(false)
+ const metadataSheet = useMetadataSheet()
const dashboardUrl = payment.gateway_dashboard_payment_url
return (
@@ -275,6 +282,10 @@ function PaymentActionsMenu({
</a>
</DropdownMenuItem>
)}
+ <ViewMetadataMenuItem
+ metadata={payment.metadata}
+ onClick={() => metadataSheet.show(payment.metadata, payment.number)}
+ />
{canCapture && (
<DropdownMenuItem onClick={onCapture}>
<CreditCardIcon className="size-4" />
@@ -295,6 +306,7 @@ function PaymentActionsMenu({
open={detailsOpen}
onOpenChange={setDetailsOpen}
/>
+ {metadataSheet.sheet}
</>
)
}
diff --git a/packages/dashboard/src/components/spree/orders/shipping-label-row.tsx b/packages/dashboard/src/components/spree/orders/shipping-label-row.tsx
index 14cd8b1482..48352fcea2 100644
--- a/packages/dashboard/src/components/spree/orders/shipping-label-row.tsx
+++ b/packages/dashboard/src/components/spree/orders/shipping-label-row.tsx
@@ -1,5 +1,12 @@
import type { ShippingLabel } from '@spree/admin-sdk'
-import { downloadFromApi, getApiClient, Money, useAuth } from '@spree/dashboard-core'
+import {
+ downloadFromApi,
+ getApiClient,
+ Money,
+ useAuth,
+ useMetadataSheet,
+ ViewMetadataMenuItem,
+} from '@spree/dashboard-core'
import {
Badge,
Button,
@@ -8,6 +15,7 @@ import {
DropdownMenuContent,
DropdownMenuItem,
DropdownMenuTrigger,
+ hasMetadata,
toastManager,
useConfirm,
} from '@spree/dashboard-ui'
@@ -37,6 +45,7 @@ export function ShippingLabelRow({
const { t } = useTranslation()
const confirm = useConfirm()
const { token } = useAuth()
+ const metadataSheet = useMetadataSheet()
// Mirrors Spree::ShippingLabel#refundable? — a label the carrier is still
// deciding on stays askable, because re-filing is the only way to re-drive a
@@ -126,7 +135,7 @@ export function ShippingLabelRow({
</Button>
)}
- {deletable && (
+ {(deletable || hasMetadata(label.metadata)) && (
<DropdownMenu>
<DropdownMenuTrigger asChild>
<Button type="button" variant="ghost" size="icon-xs">
@@ -135,27 +144,34 @@ export function ShippingLabelRow({
</Button>
</DropdownMenuTrigger>
<DropdownMenuContent align="end">
- <DropdownMenuItem
- variant="destructive"
- onClick={async () => {
- if (
- await confirm({
- message: t('admin.orders.detail.fulfillments.confirm_delete_label'),
- variant: 'destructive',
- confirmLabel: t('admin.actions.delete'),
- })
- ) {
- onDelete()
- }
- }}
- >
- <TrashIcon className="size-4" />
- {t('admin.orders.detail.fulfillments.delete_label')}
- </DropdownMenuItem>
+ <ViewMetadataMenuItem
+ metadata={label.metadata}
+ onClick={() => metadataSheet.show(label.metadata)}
+ />
+ {deletable && (
+ <DropdownMenuItem
+ variant="destructive"
+ onClick={async () => {
+ if (
+ await confirm({
+ message: t('admin.orders.detail.fulfillments.confirm_delete_label'),
+ variant: 'destructive',
+ confirmLabel: t('admin.actions.delete'),
+ })
+ ) {
+ onDelete()
+ }
+ }}
+ >
+ <TrashIcon className="size-4" />
+ {t('admin.orders.detail.fulfillments.delete_label')}
+ </DropdownMenuItem>
+ )}
</DropdownMenuContent>
</DropdownMenu>
)}
</div>
+ {metadataSheet.sheet}
</CardContent>
)
}
diff --git a/packages/dashboard/src/components/spree/payment-method-editors/payment-method-sheets.tsx b/packages/dashboard/src/components/spree/payment-method-editors/payment-method-sheets.tsx
index ce2fdbc36b..8e0803518a 100644
--- a/packages/dashboard/src/components/spree/payment-method-editors/payment-method-sheets.tsx
+++ b/packages/dashboard/src/components/spree/payment-method-editors/payment-method-sheets.tsx
@@ -1,6 +1,11 @@
import { zodResolver } from '@hookform/resolvers/zod'
import type { PaymentMethodType, PreferenceSchema } from '@spree/admin-sdk'
-import { defaultPreferences, mapSpreeErrorsToForm, useStore } from '@spree/dashboard-core'
+import {
+ defaultPreferences,
+ mapSpreeErrorsToForm,
+ RecordMetadataSection,
+ useStore,
+} from '@spree/dashboard-core'
import {
Button,
Sheet,
@@ -281,6 +286,7 @@ export function EditPaymentMethodSheet({
onPreferencesChange={setPreferences}
/>
<DraftCustomFieldsCard draft={customFields} hideWhenEmpty />
+ <RecordMetadataSection metadata={paymentMethod?.metadata} />
</div>
<SheetFooter>
<Button
diff --git a/packages/dashboard/src/components/spree/promotion-editors/promotion-form.tsx b/packages/dashboard/src/components/spree/promotion-editors/promotion-form.tsx
index 659a3976d6..94e9df7cf1 100644
--- a/packages/dashboard/src/components/spree/promotion-editors/promotion-form.tsx
+++ b/packages/dashboard/src/components/spree/promotion-editors/promotion-form.tsx
@@ -9,7 +9,13 @@ import type {
ResourceTypeDefinition,
} from '@spree/admin-sdk'
import { MATCH_POLICIES, type MatchPolicy } from '@spree/core'
-import { Can, PageHeader, PreferencesForm, StoreDatePicker } from '@spree/dashboard-core'
+import {
+ Can,
+ PageHeader,
+ PreferencesForm,
+ RecordMetadataCard,
+ StoreDatePicker,
+} from '@spree/dashboard-core'
import {
Alert,
AlertDescription,
@@ -351,6 +357,8 @@ export function PromotionForm({
matchPolicy={form.watch('match_policy')}
/>
<ActionsCard form={form} actionsArray={actionsArray} />
+ {mode === 'edit' && <DraftCustomFieldsCard draft={customFields} collapsible />}
+ {promotion && <RecordMetadataCard metadata={promotion.metadata} />}
</>
}
sidebar={
@@ -358,7 +366,6 @@ export function PromotionForm({
<BasicsCard form={form} />
<TriggerCard mode={mode} form={form} promotion={promotion} />
<ScheduleCard form={form} />
- {mode === 'edit' && <DraftCustomFieldsCard draft={customFields} />}
<Slot name="promotion.form_sidebar" context={{ promotion, mode }} />
</>
}
diff --git a/packages/dashboard/src/components/spree/reasons/reason-section.tsx b/packages/dashboard/src/components/spree/reasons/reason-section.tsx
index 21e4b05854..7054574358 100644
--- a/packages/dashboard/src/components/spree/reasons/reason-section.tsx
+++ b/packages/dashboard/src/components/spree/reasons/reason-section.tsx
@@ -1,5 +1,11 @@
import { zodResolver } from '@hookform/resolvers/zod'
-import { Can, mapSpreeErrorsToForm, Subject, usePermissions } from '@spree/dashboard-core'
+import {
+ Can,
+ mapSpreeErrorsToForm,
+ RecordMetadataSection,
+ Subject,
+ usePermissions,
+} from '@spree/dashboard-core'
import {
ActiveBadge,
Badge,
@@ -317,6 +323,7 @@ function EditReasonSheet({
<form onSubmit={form.handleSubmit(onSubmit)} className="flex min-h-0 flex-1 flex-col">
<div className="flex flex-1 flex-col gap-4 overflow-y-auto p-4">
<ReasonFormFields form={form} withCode={withCode} />
+ {'metadata' in reason && <RecordMetadataSection metadata={reason.metadata} />}
</div>
<SheetFooter>
<Button type="button" variant="outline" onClick={onClose}>
diff --git a/packages/dashboard/src/components/spree/sellers/seller-onboarding-card.tsx b/packages/dashboard/src/components/spree/sellers/seller-onboarding-card.tsx
index 1b3e5f5154..766527691d 100644
--- a/packages/dashboard/src/components/spree/sellers/seller-onboarding-card.tsx
+++ b/packages/dashboard/src/components/spree/sellers/seller-onboarding-card.tsx
@@ -1,5 +1,5 @@
import type { Seller, SellerRequirementStatus } from '@spree/admin-sdk'
-import { progressPercentage } from '@spree/dashboard-core'
+import { progressPercentage, useMetadataSheet, ViewMetadataMenuItem } from '@spree/dashboard-core'
import {
Badge,
Button,
@@ -12,6 +12,7 @@ import {
DropdownMenuContent,
DropdownMenuItem,
DropdownMenuTrigger,
+ hasMetadata,
Progress,
StatusBadge as SharedStatusBadge,
Sheet,
@@ -123,6 +124,7 @@ function RequirementRow({
const { t } = useTranslation()
const confirm = useConfirm()
const [policyOpen, setPolicyOpen] = useState(false)
+ const metadataSheet = useMetadataSheet()
const acceptMutation = useAcceptSellerRequirementSubmission(sellerId)
const rejectMutation = useRejectSellerRequirementSubmission(sellerId)
const waiveMutation = useWaiveSellerRequirement(sellerId)
@@ -156,6 +158,8 @@ function RequirementRow({
}
const policy = requirement.published_policy
+ const canWaive = canEdit && requirement.status !== 'complete'
+ const submissionHasMetadata = hasMetadata(submission?.metadata)
return (
<li className="flex items-start justify-between gap-3 py-3 first:pt-0 last:pb-0">
@@ -224,22 +228,35 @@ function RequirementRow({
</>
)}
- {canEdit && requirement.status !== 'complete' && (
+ {(canWaive || submissionHasMetadata) && (
<DropdownMenu>
<DropdownMenuTrigger asChild>
- <Button size="icon-sm" variant="ghost" disabled={busy}>
+ <Button
+ size="icon-sm"
+ variant="ghost"
+ disabled={busy}
+ aria-label={t('admin.actions.actions_menu')}
+ >
<EllipsisVerticalIcon className="size-4" />
</Button>
</DropdownMenuTrigger>
<DropdownMenuContent align="end">
- <DropdownMenuItem onClick={handleWaive}>
- {t('admin.sellers.onboarding.actions.waive')}
- </DropdownMenuItem>
+ <ViewMetadataMenuItem
+ metadata={submission?.metadata}
+ onClick={() => metadataSheet.show(submission?.metadata, requirement.name)}
+ />
+ {canWaive && (
+ <DropdownMenuItem onClick={handleWaive}>
+ {t('admin.sellers.onboarding.actions.waive')}
+ </DropdownMenuItem>
+ )}
</DropdownMenuContent>
</DropdownMenu>
)}
</div>
+ {metadataSheet.sheet}
+
{/* Read-only: the operator approves or sends back a seller, they do not
rewrite the seller's legal text. Rendered as sanitized markup, the
same way the storefront serves it. */}
diff --git a/packages/dashboard/src/components/spree/supplier-sheet.tsx b/packages/dashboard/src/components/spree/supplier-sheet.tsx
index 942ad96ae9..e4694875cb 100644
--- a/packages/dashboard/src/components/spree/supplier-sheet.tsx
+++ b/packages/dashboard/src/components/spree/supplier-sheet.tsx
@@ -1,5 +1,10 @@
import type { Supplier } from '@spree/admin-sdk'
-import { CountryCombobox, StateCombobox, useCountryStates } from '@spree/dashboard-core'
+import {
+ CountryCombobox,
+ RecordMetadataSection,
+ StateCombobox,
+ useCountryStates,
+} from '@spree/dashboard-core'
import {
Button,
Field,
@@ -257,6 +262,7 @@ export function SupplierSheet({
/>
</Field>
</FieldGroup>
+ {id && <RecordMetadataSection metadata={supplier?.metadata} />}
</div>
<SheetFooter>
diff --git a/packages/dashboard/src/routes/_authenticated/$storeId/companies/$companyId.tsx b/packages/dashboard/src/routes/_authenticated/$storeId/companies/$companyId.tsx
index 32e053fcf2..0360f67a22 100644
--- a/packages/dashboard/src/routes/_authenticated/$storeId/companies/$companyId.tsx
+++ b/packages/dashboard/src/routes/_authenticated/$storeId/companies/$companyId.tsx
@@ -5,6 +5,7 @@ import {
adminClient,
mapSpreeErrorsToForm,
PageHeader,
+ RecordMetadataCard,
Slot,
Subject,
usePermissions,
@@ -157,6 +158,8 @@ function CompanyBody({ company }: { company: Company }) {
<SubUnitsCard company={company} canEdit={canEdit} />
<MembersCard company={company} canEdit={canEdit} />
{!isDivision && <TaxExemptionCertificatesCard companyId={company.id} canEdit={canEdit} />}
+ <ApiCustomFieldsCard ownerType="company" ownerId={company.id} collapsible />
+ <RecordMetadataCard metadata={company.metadata} />
{/* Company-wide panels an extension owns: roles, purchase limits,
approval settings (docs: Enterprise b2b-companies plan). */}
<Slot name="company.form_main" context={{ company, kind: company.kind, canEdit }} />
@@ -171,7 +174,6 @@ function CompanyBody({ company }: { company: Company }) {
) : (
<CompanyTaxIdentifiersCard companyId={company.id} canEdit={canEdit} />
)}
- <ApiCustomFieldsCard ownerType="company" ownerId={company.id} />
<Slot name="company.form_sidebar" context={{ company, kind: company.kind, canEdit }} />
</>
}
diff --git a/packages/dashboard/src/routes/_authenticated/$storeId/customers/$customerId.tsx b/packages/dashboard/src/routes/_authenticated/$storeId/customers/$customerId.tsx
index 8e76a0392c..ad23c8c6b2 100644
--- a/packages/dashboard/src/routes/_authenticated/$storeId/customers/$customerId.tsx
+++ b/packages/dashboard/src/routes/_authenticated/$storeId/customers/$customerId.tsx
@@ -1,6 +1,6 @@
import type { Customer } from '@spree/admin-sdk'
-import { PageHeader, Slot } from '@spree/dashboard-core'
-import { Badge, ErrorState, MetadataCard, ResourceLayout } from '@spree/dashboard-ui'
+import { PageHeader, RecordMetadataCard, Slot } from '@spree/dashboard-core'
+import { Badge, ErrorState, ResourceLayout } from '@spree/dashboard-ui'
import { createFileRoute } from '@tanstack/react-router'
import { useTranslation } from 'react-i18next'
import {
@@ -115,14 +115,9 @@ function CustomerBody({ customer }: { customer: Customer }) {
resourceType="customer"
resourceLabel={t('admin.nav.customers').toLowerCase()}
>
- <CustomFieldsInlineCard />
+ <CustomFieldsInlineCard collapsible />
</EditableApiCustomFieldsProvider>
- <MetadataCard
- metadata={customer.metadata}
- title={t('admin.components.metadata_card.title')}
- emptyTitle={t('admin.components.metadata_card.empty_title')}
- emptyDescription={t('admin.components.metadata_card.empty_description')}
- />
+ <RecordMetadataCard metadata={customer.metadata} />
<Slot name="customer.form_main" context={{ customer }} />
</>
}
diff --git a/packages/dashboard/src/routes/_authenticated/$storeId/orders/$orderId/index.tsx b/packages/dashboard/src/routes/_authenticated/$storeId/orders/$orderId/index.tsx
index 1e91f79fbd..30bdbd915f 100644
--- a/packages/dashboard/src/routes/_authenticated/$storeId/orders/$orderId/index.tsx
+++ b/packages/dashboard/src/routes/_authenticated/$storeId/orders/$orderId/index.tsx
@@ -1,5 +1,5 @@
-import { Slot } from '@spree/dashboard-core'
-import { ErrorState, MetadataCard, ResourceLayout } from '@spree/dashboard-ui'
+import { RecordMetadataCard, Slot } from '@spree/dashboard-core'
+import { ErrorState, ResourceLayout } from '@spree/dashboard-ui'
import { createFileRoute } from '@tanstack/react-router'
import { useTranslation } from 'react-i18next'
import {
@@ -88,14 +88,9 @@ function OrderDetailPage() {
resourceType="order"
resourceLabel={t('admin.nav.orders').toLowerCase()}
>
- <CustomFieldsInlineCard />
+ <CustomFieldsInlineCard collapsible />
</EditableApiCustomFieldsProvider>
- <MetadataCard
- metadata={order.metadata}
- title={t('admin.components.metadata_card.title')}
- emptyTitle={t('admin.components.metadata_card.empty_title')}
- emptyDescription={t('admin.components.metadata_card.empty_description')}
- />
+ <RecordMetadataCard metadata={order.metadata} />
<Slot name="order.form_main" context={{ order }} />
</>
}
diff --git a/packages/dashboard/src/routes/_authenticated/$storeId/products/$productId.tsx b/packages/dashboard/src/routes/_authenticated/$storeId/products/$productId.tsx
index b95ac9fc24..2680014e58 100644
--- a/packages/dashboard/src/routes/_authenticated/$storeId/products/$productId.tsx
+++ b/packages/dashboard/src/routes/_authenticated/$storeId/products/$productId.tsx
@@ -17,6 +17,7 @@ import {
prepareVariantsTaxForProductSave,
productFormSchema,
productToFormValues,
+ RecordMetadataCard,
SEOCard,
Slot,
StatusCard,
@@ -29,7 +30,6 @@ import {
import {
ErrorState,
FormActions,
- MetadataCard,
ResourceLayout,
Skeleton,
StatusBadge,
@@ -320,16 +320,11 @@ function ProductForm({ product }: { product: Product }) {
}
/>
<DigitalAssetsCard productId={productId} variants={assignableVariants} />
+ <ResourceTranslationsCard resourceType="product" resourceId={productId} />
<ProductCustomFieldsProvider form={form} productTypeId={selectedProductTypeId}>
- <CustomFieldsInlineCard />
+ <CustomFieldsInlineCard collapsible />
</ProductCustomFieldsProvider>
- <ResourceTranslationsCard resourceType="product" resourceId={productId} />
- <MetadataCard
- metadata={product.metadata}
- title={t('admin.components.metadata_card.title')}
- emptyTitle={t('admin.components.metadata_card.empty_title')}
- emptyDescription={t('admin.components.metadata_card.empty_description')}
- />
+ <RecordMetadataCard metadata={product.metadata} />
<Slot name="product.form_main" context={{ product, mode: 'edit' }} />
</>
}
diff --git a/packages/dashboard/src/routes/_authenticated/$storeId/products/catalogs/$catalogId.tsx b/packages/dashboard/src/routes/_authenticated/$storeId/products/catalogs/$catalogId.tsx
index 750d7165c6..9eb543d2a2 100644
--- a/packages/dashboard/src/routes/_authenticated/$storeId/products/catalogs/$catalogId.tsx
+++ b/packages/dashboard/src/routes/_authenticated/$storeId/products/catalogs/$catalogId.tsx
@@ -7,6 +7,7 @@ import {
extensionSubmitValues,
mapSpreeErrorsToForm,
PageHeader,
+ RecordMetadataCard,
Slot,
Subject,
usePermissions,
@@ -393,6 +394,7 @@ function CatalogBody({ catalog }: { catalog: Catalog }) {
)
}
/>
+ <RecordMetadataCard metadata={catalog.metadata} />
</>
}
sidebar={
diff --git a/packages/dashboard/src/routes/_authenticated/$storeId/products/options.tsx b/packages/dashboard/src/routes/_authenticated/$storeId/products/options.tsx
index f65d9b288d..e051c03047 100644
--- a/packages/dashboard/src/routes/_authenticated/$storeId/products/options.tsx
+++ b/packages/dashboard/src/routes/_authenticated/$storeId/products/options.tsx
@@ -24,6 +24,7 @@ import {
extensionSubmitValues,
HostFormSlot,
mapSpreeErrorsToForm,
+ RecordMetadataSection,
ResourceTable,
resourceSearchSchema,
runtimeListParams,
@@ -398,6 +399,7 @@ function EditOptionTypeSheet({
/>
<OptionValuesFieldArray form={form} />
<DraftCustomFieldsCard draft={customFields} hideWhenEmpty />
+ <RecordMetadataSection metadata={optionType?.metadata} />
</div>
<SheetFooter>
<Button
diff --git a/packages/dashboard/src/routes/_authenticated/$storeId/purchase-orders/$purchaseOrderId/index.tsx b/packages/dashboard/src/routes/_authenticated/$storeId/purchase-orders/$purchaseOrderId/index.tsx
index 4b0e64b98f..99f2805a1d 100644
--- a/packages/dashboard/src/routes/_authenticated/$storeId/purchase-orders/$purchaseOrderId/index.tsx
+++ b/packages/dashboard/src/routes/_authenticated/$storeId/purchase-orders/$purchaseOrderId/index.tsx
@@ -4,6 +4,7 @@ import {
Can,
Money,
PageHeader,
+ RecordMetadataCard,
Slot,
Subject,
useResourceKey,
@@ -97,13 +98,14 @@ function PurchaseOrderDetailPage() {
purchaseOrderId={purchaseOrder.id}
title={t('admin.purchase_orders.history_title')}
/>
+ <ApiCustomFieldsCard ownerType="purchase_order" ownerId={purchaseOrder.id} collapsible />
+ <RecordMetadataCard metadata={purchaseOrder.metadata} />
<Slot name="purchase_order.form_main" context={{ purchaseOrder }} />
</>
}
sidebar={
<>
<SummaryCard purchaseOrder={purchaseOrder} />
- <ApiCustomFieldsCard ownerType="purchase_order" ownerId={purchaseOrder.id} />
<Slot name="purchase_order.form_sidebar" context={{ purchaseOrder }} />
</>
}
diff --git a/packages/dashboard/src/routes/_authenticated/$storeId/sellers/$sellerId.tsx b/packages/dashboard/src/routes/_authenticated/$storeId/sellers/$sellerId.tsx
index 0d9cab95d3..9a6dfd294c 100644
--- a/packages/dashboard/src/routes/_authenticated/$storeId/sellers/$sellerId.tsx
+++ b/packages/dashboard/src/routes/_authenticated/$storeId/sellers/$sellerId.tsx
@@ -1,6 +1,13 @@
import type { Seller } from '@spree/admin-sdk'
import { SELLER_STATUSES, subsetOf } from '@spree/core'
-import { adminClient, PageHeader, Slot, Subject, usePermissions } from '@spree/dashboard-core'
+import {
+ adminClient,
+ PageHeader,
+ RecordMetadataCard,
+ Slot,
+ Subject,
+ usePermissions,
+} from '@spree/dashboard-core'
import {
Badge,
Button,
@@ -287,6 +294,8 @@ function SellerBody({ seller }: { seller: Seller }) {
/>
<SellerOnboardingCard seller={seller} canEdit={canEdit} />
<SellerTeamCard seller={seller} onInvite={() => setInviting(true)} />
+ <ApiCustomFieldsCard ownerType="seller" ownerId={seller.id} collapsible />
+ <RecordMetadataCard metadata={seller.metadata} />
<Slot name="seller.form_main" context={{ seller, canEdit }} />
</>
}
@@ -307,7 +316,6 @@ function SellerBody({ seller }: { seller: Seller }) {
canEdit={canEdit}
onEdit={() => setEditingSettlement(true)}
/>
- <ApiCustomFieldsCard ownerType="seller" ownerId={seller.id} />
<EnterprisePreviewNote previewKey="sellers.shopify" />
<Slot name="seller.form_sidebar" context={{ seller, canEdit }} />
</>
diff --git a/packages/dashboard/src/routes/_authenticated/$storeId/sellers/commission-rates.tsx b/packages/dashboard/src/routes/_authenticated/$storeId/sellers/commission-rates.tsx
index 863ea2505a..f1e415cca4 100644
--- a/packages/dashboard/src/routes/_authenticated/$storeId/sellers/commission-rates.tsx
+++ b/packages/dashboard/src/routes/_authenticated/$storeId/sellers/commission-rates.tsx
@@ -10,6 +10,7 @@ import {
Can,
mapSpreeErrorsToForm,
PreferencesForm,
+ RecordMetadataSection,
ResourceMultiAutocomplete,
ResourceTable,
resourceSearchSchema,
@@ -301,6 +302,7 @@ function EditCommissionRateSheet({
<form onSubmit={form.handleSubmit(onSubmit)} className="flex min-h-0 flex-1 flex-col">
<div className="flex flex-1 flex-col gap-4 overflow-y-auto p-4">
<CommissionRateFormFields form={form} />
+ <RecordMetadataSection metadata={rate?.metadata} />
</div>
<SheetFooter>
<Button
diff --git a/packages/dashboard/src/routes/_authenticated/$storeId/sellers/payouts/$payoutId.tsx b/packages/dashboard/src/routes/_authenticated/$storeId/sellers/payouts/$payoutId.tsx
index 8baf0e86b8..2855370a78 100644
--- a/packages/dashboard/src/routes/_authenticated/$storeId/sellers/payouts/$payoutId.tsx
+++ b/packages/dashboard/src/routes/_authenticated/$storeId/sellers/payouts/$payoutId.tsx
@@ -3,6 +3,7 @@ import {
formatStoreDateTime,
Money,
PageHeader,
+ RecordMetadataCard,
Slot,
Subject,
usePermissions,
@@ -180,6 +181,7 @@ function PayoutDetailPage() {
<Pagination meta={transfers.meta} onPageChange={setPage} />
)}
</Card>
+ <RecordMetadataCard metadata={payout.metadata} />
<Slot name="seller_payout.form_main" context={{ payout }} />
</>
}
diff --git a/packages/dashboard/src/routes/_authenticated/$storeId/settings/seller-requirements.tsx b/packages/dashboard/src/routes/_authenticated/$storeId/settings/seller-requirements.tsx
index d51e0332b0..88042db26b 100644
--- a/packages/dashboard/src/routes/_authenticated/$storeId/settings/seller-requirements.tsx
+++ b/packages/dashboard/src/routes/_authenticated/$storeId/settings/seller-requirements.tsx
@@ -5,6 +5,7 @@ import {
Can,
defaultPreferences,
PreferencesForm,
+ RecordMetadataSection,
ResourceMultiAutocomplete,
ResourceTable,
resourceSearchSchema,
@@ -410,6 +411,7 @@ function EditRequirementForm({
onChange={setActive}
/>
</FieldGroup>
+ <RecordMetadataSection metadata={requirement?.metadata} />
</div>
<SheetFooter>
<Button variant="outline" onClick={() => onOpenChange(false)}>
diff --git a/packages/dashboard/src/routes/_authenticated/$storeId/settings/taxes/rates.tsx b/packages/dashboard/src/routes/_authenticated/$storeId/settings/taxes/rates.tsx
index 0fe0142786..5801297ec8 100644
--- a/packages/dashboard/src/routes/_authenticated/$storeId/settings/taxes/rates.tsx
+++ b/packages/dashboard/src/routes/_authenticated/$storeId/settings/taxes/rates.tsx
@@ -7,6 +7,7 @@ import {
extensionSubmitValues,
HostFormSlot,
mapSpreeErrorsToForm,
+ RecordMetadataSection,
StateCombobox,
Subject,
useCountryStates,
@@ -345,6 +346,7 @@ function EditTaxRateSheet({
context={{ taxRate, mode: 'edit' }}
/>
<DraftCustomFieldsCard draft={customFields} hideWhenEmpty />
+ <RecordMetadataSection metadata={taxRate?.metadata} />
</div>
<SheetFooter>
<Button
diff --git a/packages/dashboard/src/routes/_authenticated/$storeId/transfers/$transferId/index.tsx b/packages/dashboard/src/routes/_authenticated/$storeId/transfers/$transferId/index.tsx
index 1c93c7c3e5..4d24da06e7 100644
--- a/packages/dashboard/src/routes/_authenticated/$storeId/transfers/$transferId/index.tsx
+++ b/packages/dashboard/src/routes/_authenticated/$storeId/transfers/$transferId/index.tsx
@@ -3,6 +3,7 @@ import {
adminClient,
Can,
PageHeader,
+ RecordMetadataCard,
Slot,
Subject,
useResourceKey,
@@ -105,13 +106,14 @@ function StockTransferDetailPage() {
stockTransferId={transfer.id}
title={t('admin.stock_transfers.history_title')}
/>
+ <ApiCustomFieldsCard ownerType="stock_transfer" ownerId={transfer.id} collapsible />
+ <RecordMetadataCard metadata={transfer.metadata} />
<Slot name="stock_transfer.form_main" context={{ transfer }} />
</>
}
sidebar={
<>
<SummaryCard transfer={transfer} />
- <ApiCustomFieldsCard ownerType="stock_transfer" ownerId={transfer.id} />
<Slot name="stock_transfer.form_sidebar" context={{ transfer }} />
</>
}
diff --git a/spree/api/app/serializers/spree/api/v3/admin/seller_payout_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/seller_payout_serializer.rb
index 409972c8e6..4a3f4b5229 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/seller_payout_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/seller_payout_serializer.rb
@@ -17,7 +17,8 @@ module Spree
reference: 'string | null',
period_start: 'string | null',
period_end: 'string | null',
- transfers_count: :number
+ transfers_count: :number,
+ metadata: 'Record<string, unknown>'
attributes :status, :currency, :reference, :metadata,
period_start: :iso8601, period_end: :iso8601,