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.

Refresh the sidebar count after acting, and drop empty dropdowns

Damian Legawiecbfdf3e241d95
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 caca0af8d6..8dc3eebc01 100644
--- a/packages/dashboard/src/components/spree/order-post-sale-cards.tsx
+++ b/packages/dashboard/src/components/spree/order-post-sale-cards.tsx
@@ -41,6 +41,11 @@ import {
ResolveClaimDialog,
} from './post-sale-create-dialogs'
+// Statuses that still offer an action. A terminal record would otherwise
+// show a menu button that opens onto nothing.
+const EXCHANGE_ACTIONABLE = ['requested', 'approved', 'received']
+const CLAIM_ACTIONABLE = ['open', 'approved']
+
/** Exchanges on an order, with the actions available at each status. */
export function OrderExchangesCard({ order }: { order: Order }) {
const orderId = order.id
@@ -91,55 +96,61 @@ export function OrderExchangesCard({ order }: { order: Order }) {
<span className="text-sm font-medium">{exchange.number}</span>
</div>
- <DropdownMenu>
- <DropdownMenuTrigger asChild>
- <Button variant="ghost" size="icon-xs">
- <EllipsisVerticalIcon className="size-4" />
- </Button>
- </DropdownMenuTrigger>
- <DropdownMenuContent align="end">
- {exchange.status === 'requested' && (
- <DropdownMenuItem onClick={() => approve.mutate(exchange.id)}>
- <CheckCircleIcon className="size-4" />
- {t('admin.pages.orders.detail.returns.actions.approve')}
- </DropdownMenuItem>
- )}
- {exchange.status === 'approved' && (
- <DropdownMenuItem onClick={() => receive.mutate({ exchangeId: exchange.id })}>
- <PackageCheckIcon className="size-4" />
- {t('admin.pages.orders.detail.returns.actions.receive')}
- </DropdownMenuItem>
- )}
- {exchange.status === 'received' && (
- <DropdownMenuItem onClick={() => fulfill.mutate({ exchangeId: exchange.id })}>
- <TruckIcon className="size-4" />
- {t('admin.pages.orders.detail.exchanges.actions.fulfill')}
- </DropdownMenuItem>
- )}
- {['requested', 'approved'].includes(exchange.status) && (
- <>
- <DropdownMenuSeparator />
+ {EXCHANGE_ACTIONABLE.includes(exchange.status) && (
+ <DropdownMenu>
+ <DropdownMenuTrigger asChild>
+ <Button variant="ghost" size="icon-xs">
+ <EllipsisVerticalIcon className="size-4" />
+ </Button>
+ </DropdownMenuTrigger>
+ <DropdownMenuContent align="end">
+ {exchange.status === 'requested' && (
+ <DropdownMenuItem onClick={() => approve.mutate(exchange.id)}>
+ <CheckCircleIcon className="size-4" />
+ {t('admin.pages.orders.detail.returns.actions.approve')}
+ </DropdownMenuItem>
+ )}
+ {exchange.status === 'approved' && (
<DropdownMenuItem
- className="text-destructive focus:text-destructive"
- onClick={async () => {
- if (
- await confirm({
- message: t('admin.pages.orders.detail.returns.confirm.cancel'),
- variant: 'destructive',
- confirmLabel: t('admin.actions.cancel'),
- })
- ) {
- cancel.mutate({ exchangeId: exchange.id })
- }
- }}
+ onClick={() => receive.mutate({ exchangeId: exchange.id })}
>
- <XCircleIcon className="size-4" />
- {t('admin.actions.cancel')}
+ <PackageCheckIcon className="size-4" />
+ {t('admin.pages.orders.detail.returns.actions.receive')}
</DropdownMenuItem>
- </>
- )}
- </DropdownMenuContent>
- </DropdownMenu>
+ )}
+ {exchange.status === 'received' && (
+ <DropdownMenuItem
+ onClick={() => fulfill.mutate({ exchangeId: exchange.id })}
+ >
+ <TruckIcon className="size-4" />
+ {t('admin.pages.orders.detail.exchanges.actions.fulfill')}
+ </DropdownMenuItem>
+ )}
+ {['requested', 'approved'].includes(exchange.status) && (
+ <>
+ <DropdownMenuSeparator />
+ <DropdownMenuItem
+ className="text-destructive focus:text-destructive"
+ onClick={async () => {
+ if (
+ await confirm({
+ message: t('admin.pages.orders.detail.returns.confirm.cancel'),
+ variant: 'destructive',
+ confirmLabel: t('admin.actions.cancel'),
+ })
+ ) {
+ cancel.mutate({ exchangeId: exchange.id })
+ }
+ }}
+ >
+ <XCircleIcon className="size-4" />
+ {t('admin.actions.cancel')}
+ </DropdownMenuItem>
+ </>
+ )}
+ </DropdownMenuContent>
+ </DropdownMenu>
+ )}
</div>
<div className="flex flex-col gap-1.5">
@@ -236,55 +247,57 @@ export function OrderClaimsCard({ order }: { order: Order }) {
</Badge>
</div>
- <DropdownMenu>
- <DropdownMenuTrigger asChild>
- <Button variant="ghost" size="icon-xs">
- <EllipsisVerticalIcon className="size-4" />
- </Button>
- </DropdownMenuTrigger>
- <DropdownMenuContent align="end">
- {claim.status === 'open' && (
- <DropdownMenuItem onClick={() => approve.mutate(claim.id)}>
- <CheckCircleIcon className="size-4" />
- {t('admin.pages.orders.detail.returns.actions.approve')}
- </DropdownMenuItem>
- )}
- {claim.status === 'approved' && (
- <DropdownMenuItem onClick={() => setResolving(claim)}>
- <BanknoteIcon className="size-4" />
- {t('admin.pages.orders.detail.claims.actions.resolve')}
- </DropdownMenuItem>
- )}
- {claim.status === 'open' && (
- <DropdownMenuItem onClick={() => deny.mutate({ claimId: claim.id })}>
- <XCircleIcon className="size-4" />
- {t('admin.pages.orders.detail.claims.actions.deny')}
- </DropdownMenuItem>
- )}
- {['open', 'approved'].includes(claim.status) && (
- <>
- <DropdownMenuSeparator />
- <DropdownMenuItem
- className="text-destructive focus:text-destructive"
- onClick={async () => {
- if (
- await confirm({
- message: t('admin.pages.orders.detail.returns.confirm.cancel'),
- variant: 'destructive',
- confirmLabel: t('admin.actions.cancel'),
- })
- ) {
- cancel.mutate({ claimId: claim.id })
- }
- }}
- >
+ {CLAIM_ACTIONABLE.includes(claim.status) && (
+ <DropdownMenu>
+ <DropdownMenuTrigger asChild>
+ <Button variant="ghost" size="icon-xs">
+ <EllipsisVerticalIcon className="size-4" />
+ </Button>
+ </DropdownMenuTrigger>
+ <DropdownMenuContent align="end">
+ {claim.status === 'open' && (
+ <DropdownMenuItem onClick={() => approve.mutate(claim.id)}>
+ <CheckCircleIcon className="size-4" />
+ {t('admin.pages.orders.detail.returns.actions.approve')}
+ </DropdownMenuItem>
+ )}
+ {claim.status === 'approved' && (
+ <DropdownMenuItem onClick={() => setResolving(claim)}>
+ <BanknoteIcon className="size-4" />
+ {t('admin.pages.orders.detail.claims.actions.resolve')}
+ </DropdownMenuItem>
+ )}
+ {claim.status === 'open' && (
+ <DropdownMenuItem onClick={() => deny.mutate({ claimId: claim.id })}>
<XCircleIcon className="size-4" />
- {t('admin.actions.cancel')}
+ {t('admin.pages.orders.detail.claims.actions.deny')}
</DropdownMenuItem>
- </>
- )}
- </DropdownMenuContent>
- </DropdownMenu>
+ )}
+ {['open', 'approved'].includes(claim.status) && (
+ <>
+ <DropdownMenuSeparator />
+ <DropdownMenuItem
+ className="text-destructive focus:text-destructive"
+ onClick={async () => {
+ if (
+ await confirm({
+ message: t('admin.pages.orders.detail.returns.confirm.cancel'),
+ variant: 'destructive',
+ confirmLabel: t('admin.actions.cancel'),
+ })
+ ) {
+ cancel.mutate({ claimId: claim.id })
+ }
+ }}
+ >
+ <XCircleIcon className="size-4" />
+ {t('admin.actions.cancel')}
+ </DropdownMenuItem>
+ </>
+ )}
+ </DropdownMenuContent>
+ </DropdownMenu>
+ )}
</div>
<div className="flex flex-col gap-1.5">
diff --git a/packages/dashboard/src/components/spree/order-returns-card.tsx b/packages/dashboard/src/components/spree/order-returns-card.tsx
index 6b5ffb4136..1fba6325ae 100644
--- a/packages/dashboard/src/components/spree/order-returns-card.tsx
+++ b/packages/dashboard/src/components/spree/order-returns-card.tsx
@@ -46,6 +46,10 @@ import { CreateReturnDialog, fulfilledUnits } from './post-sale-create-dialogs'
type ReceiptRow = { quantity: number; resellable: boolean }
+// Statuses that still offer an action; refunded and canceled are done and
+// would render a menu button that opens onto nothing.
+const RETURN_ACTIONABLE = ['requested', 'approved', 'received']
+
/** "Product — Small / Blue", falling back to the SKU or the raw id. */
function variantLabel(line: ReturnLineItem): string {
const variant = line.variant
@@ -113,55 +117,57 @@ export function OrderReturnsCard({ order }: { order: Order }) {
<span className="text-sm font-medium">{returnRecord.number}</span>
</div>
- <DropdownMenu>
- <DropdownMenuTrigger asChild>
- <Button variant="ghost" size="icon-xs">
- <EllipsisVerticalIcon className="size-4" />
- </Button>
- </DropdownMenuTrigger>
- <DropdownMenuContent align="end">
- {returnRecord.status === 'requested' && (
- <DropdownMenuItem onClick={() => approve.mutate(returnRecord.id)}>
- <CheckCircleIcon className="size-4" />
- {t('admin.pages.orders.detail.returns.actions.approve')}
- </DropdownMenuItem>
- )}
- {returnRecord.status === 'approved' && (
- <DropdownMenuItem onClick={() => setReceiving(returnRecord)}>
- <PackageCheckIcon className="size-4" />
- {t('admin.pages.orders.detail.returns.actions.receive')}
- </DropdownMenuItem>
- )}
- {returnRecord.status === 'received' && (
- <DropdownMenuItem onClick={() => setRefunding(returnRecord)}>
- <BanknoteIcon className="size-4" />
- {t('admin.pages.orders.detail.returns.actions.refund')}
- </DropdownMenuItem>
- )}
- {['requested', 'approved'].includes(returnRecord.status) && (
- <>
- <DropdownMenuSeparator />
- <DropdownMenuItem
- className="text-destructive focus:text-destructive"
- onClick={async () => {
- if (
- await confirm({
- message: t('admin.pages.orders.detail.returns.confirm.cancel'),
- variant: 'destructive',
- confirmLabel: t('admin.actions.cancel'),
- })
- ) {
- cancel.mutate({ returnId: returnRecord.id })
- }
- }}
- >
- <XCircleIcon className="size-4" />
- {t('admin.actions.cancel')}
+ {RETURN_ACTIONABLE.includes(returnRecord.status) && (
+ <DropdownMenu>
+ <DropdownMenuTrigger asChild>
+ <Button variant="ghost" size="icon-xs">
+ <EllipsisVerticalIcon className="size-4" />
+ </Button>
+ </DropdownMenuTrigger>
+ <DropdownMenuContent align="end">
+ {returnRecord.status === 'requested' && (
+ <DropdownMenuItem onClick={() => approve.mutate(returnRecord.id)}>
+ <CheckCircleIcon className="size-4" />
+ {t('admin.pages.orders.detail.returns.actions.approve')}
+ </DropdownMenuItem>
+ )}
+ {returnRecord.status === 'approved' && (
+ <DropdownMenuItem onClick={() => setReceiving(returnRecord)}>
+ <PackageCheckIcon className="size-4" />
+ {t('admin.pages.orders.detail.returns.actions.receive')}
+ </DropdownMenuItem>
+ )}
+ {returnRecord.status === 'received' && (
+ <DropdownMenuItem onClick={() => setRefunding(returnRecord)}>
+ <BanknoteIcon className="size-4" />
+ {t('admin.pages.orders.detail.returns.actions.refund')}
</DropdownMenuItem>
- </>
- )}
- </DropdownMenuContent>
- </DropdownMenu>
+ )}
+ {['requested', 'approved'].includes(returnRecord.status) && (
+ <>
+ <DropdownMenuSeparator />
+ <DropdownMenuItem
+ className="text-destructive focus:text-destructive"
+ onClick={async () => {
+ if (
+ await confirm({
+ message: t('admin.pages.orders.detail.returns.confirm.cancel'),
+ variant: 'destructive',
+ confirmLabel: t('admin.actions.cancel'),
+ })
+ ) {
+ cancel.mutate({ returnId: returnRecord.id })
+ }
+ }}
+ >
+ <XCircleIcon className="size-4" />
+ {t('admin.actions.cancel')}
+ </DropdownMenuItem>
+ </>
+ )}
+ </DropdownMenuContent>
+ </DropdownMenu>
+ )}
</div>
<div className="flex flex-col gap-1.5">
diff --git a/packages/dashboard/src/components/spree/post-sale-nav-badges.tsx b/packages/dashboard/src/components/spree/post-sale-nav-badges.tsx
index ddf0c9ce50..e7f1bacdcf 100644
--- a/packages/dashboard/src/components/spree/post-sale-nav-badges.tsx
+++ b/packages/dashboard/src/components/spree/post-sale-nav-badges.tsx
@@ -19,9 +19,8 @@ function usePendingCount(
const { data } = useQuery({
queryKey: useResourceKey(`${resourceKey}-pending`),
queryFn: () => list({ limit: 1, status_in: statuses }),
- // The sidebar is always mounted; without this it would refetch on every
- // navigation.
- staleTime: 60_000,
+ // Deliberately no staleTime: acting on a record invalidates this key, and
+ // a stale window would hold the old count past that invalidation.
})
return data?.meta?.count ?? 0
diff --git a/packages/dashboard/src/hooks/use-post-sale.ts b/packages/dashboard/src/hooks/use-post-sale.ts
index 0840728d01..23eb837833 100644
--- a/packages/dashboard/src/hooks/use-post-sale.ts
+++ b/packages/dashboard/src/hooks/use-post-sale.ts
@@ -39,6 +39,7 @@ export function useOrderClaims(orderId: string) {
function usePostSaleMutation<TParams>(
orderId: string,
resourceKey: string,
+ countKey: string,
mutationFn: (params: TParams) => Promise<unknown>,
) {
const queryClient = useQueryClient()
@@ -49,6 +50,10 @@ function usePostSaleMutation<TParams>(
onSuccess: () => {
queryClient.invalidateQueries({ queryKey: buildKey(resourceKey, orderId) })
queryClient.invalidateQueries({ queryKey: buildKey('orders', orderId) })
+ // The sidebar count is keyed separately and would otherwise keep a
+ // stale figure until a page reload — resolving a claim is exactly what
+ // takes it out of the count.
+ queryClient.invalidateQueries({ queryKey: buildKey(`${countKey}-pending`) })
},
onError: (error) => {
// Without this a rejected workflow — a claim with nothing to refund, a
@@ -62,19 +67,24 @@ export function useExchangeActions(orderId: string) {
const create = usePostSaleMutation(
orderId,
'order-exchanges',
+ 'exchanges',
(params: {
items: Array<{ fulfillment_item_id: string; new_variant_id: string; quantity: number }>
memo?: string
}) => adminClient.orders.exchanges.create(orderId, params),
)
- const approve = usePostSaleMutation(orderId, 'order-exchanges', (exchangeId: string) =>
- adminClient.orders.exchanges.approve(orderId, exchangeId),
+ const approve = usePostSaleMutation(
+ orderId,
+ 'order-exchanges',
+ 'exchanges',
+ (exchangeId: string) => adminClient.orders.exchanges.approve(orderId, exchangeId),
)
const receive = usePostSaleMutation(
orderId,
'order-exchanges',
+ 'exchanges',
({
exchangeId,
items,
@@ -87,6 +97,7 @@ export function useExchangeActions(orderId: string) {
const fulfill = usePostSaleMutation(
orderId,
'order-exchanges',
+ 'exchanges',
({
exchangeId,
refundMethod,
@@ -100,6 +111,7 @@ export function useExchangeActions(orderId: string) {
const cancel = usePostSaleMutation(
orderId,
'order-exchanges',
+ 'exchanges',
({ exchangeId, reason }: { exchangeId: string; reason?: string }) =>
adminClient.orders.exchanges.cancel(orderId, exchangeId, { reason }),
)
@@ -111,6 +123,7 @@ export function useClaimActions(orderId: string) {
const create = usePostSaleMutation(
orderId,
'order-claims',
+ 'claims',
(params: {
items: Array<{
line_item_id: string
@@ -123,13 +136,14 @@ export function useClaimActions(orderId: string) {
}) => adminClient.orders.claims.create(orderId, params),
)
- const approve = usePostSaleMutation(orderId, 'order-claims', (claimId: string) =>
+ const approve = usePostSaleMutation(orderId, 'order-claims', 'claims', (claimId: string) =>
adminClient.orders.claims.approve(orderId, claimId),
)
const resolve = usePostSaleMutation(
orderId,
'order-claims',
+ 'claims',
({
claimId,
resolution,
@@ -154,6 +168,7 @@ export function useClaimActions(orderId: string) {
const deny = usePostSaleMutation(
orderId,
'order-claims',
+ 'claims',
({ claimId, reason }: { claimId: string; reason?: string }) =>
adminClient.orders.claims.deny(orderId, claimId, { reason }),
)
@@ -161,6 +176,7 @@ export function useClaimActions(orderId: string) {
const cancel = usePostSaleMutation(
orderId,
'order-claims',
+ 'claims',
({ claimId, reason }: { claimId: string; reason?: string }) =>
adminClient.orders.claims.cancel(orderId, claimId, { reason }),
)
diff --git a/packages/dashboard/src/hooks/use-returns.ts b/packages/dashboard/src/hooks/use-returns.ts
index 352657083a..976a73a3b5 100644
--- a/packages/dashboard/src/hooks/use-returns.ts
+++ b/packages/dashboard/src/hooks/use-returns.ts
@@ -33,6 +33,9 @@ function useReturnMutation<TParams>(
onSuccess: () => {
queryClient.invalidateQueries({ queryKey: buildKey('order-returns', orderId) })
queryClient.invalidateQueries({ queryKey: buildKey('orders', orderId) })
+ // Keyed separately from the per-order list, so the sidebar count would
+ // otherwise stay stale until a page reload.
+ queryClient.invalidateQueries({ queryKey: buildKey('returns-pending') })
},
onError: (error) => {
// Without this a rejected workflow — a claim with nothing to refund, a