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.

Promote delivery confirmation and tracking to card buttons

Damian Legawiec914df8dc31bc
diff --git a/packages/dashboard/src/components/spree/orders/fulfillment-tracking-dialog.tsx b/packages/dashboard/src/components/spree/orders/fulfillment-tracking-dialog.tsx
new file mode 100644
index 0000000000..5bde9fb4fe
--- /dev/null
+++ b/packages/dashboard/src/components/spree/orders/fulfillment-tracking-dialog.tsx
@@ -0,0 +1,111 @@
+import { zodResolver } from '@hookform/resolvers/zod'
+import type { Fulfillment } from '@spree/admin-sdk'
+import { mapSpreeErrorsToForm } from '@spree/dashboard-core'
+import {
+ Button,
+ Dialog,
+ DialogBody,
+ DialogContent,
+ DialogDescription,
+ DialogFooter,
+ DialogHeader,
+ DialogTitle,
+ Field,
+ FieldError,
+ FieldLabel,
+ Input,
+} from '@spree/dashboard-ui'
+import { useForm } from 'react-hook-form'
+import { useTranslation } from 'react-i18next'
+import { z } from 'zod'
+import { useFulfillmentActions } from '../../../hooks/use-fulfillments'
+
+const trackingSchema = z.object({ tracking: z.string() })
+
+type TrackingFormValues = z.infer<typeof trackingSchema>
+
+/**
+ * Adds or edits a fulfillment's tracking number. Separate from the edit
+ * dialog, which is about where a parcel ships from and by which service —
+ * this is the one thing a merchant reaches for after a parcel has gone out.
+ */
+export function FulfillmentTrackingDialog({
+ orderId,
+ fulfillment,
+ open,
+ onOpenChange,
+}: {
+ orderId: string
+ fulfillment: Fulfillment
+ open: boolean
+ onOpenChange: (open: boolean) => void
+}) {
+ const { t } = useTranslation()
+ const { update } = useFulfillmentActions(orderId)
+
+ const form = useForm<TrackingFormValues>({
+ resolver: zodResolver(trackingSchema),
+ defaultValues: { tracking: fulfillment.tracking ?? '' },
+ })
+
+ async function onSubmit(values: TrackingFormValues) {
+ try {
+ await update.mutateAsync({
+ fulfillmentId: fulfillment.id,
+ tracking: values.tracking.trim(),
+ })
+ onOpenChange(false)
+ } catch (err) {
+ if (!mapSpreeErrorsToForm(err, form.setError)) throw err
+ }
+ }
+
+ return (
+ <Dialog open={open} onOpenChange={onOpenChange}>
+ <DialogContent>
+ <form onSubmit={form.handleSubmit(onSubmit)}>
+ <DialogHeader>
+ <DialogTitle>
+ {fulfillment.tracking
+ ? t('admin.orders.detail.fulfillments.edit_tracking_title')
+ : t('admin.orders.detail.fulfillments.add_tracking_title')}
+ </DialogTitle>
+ <DialogDescription>
+ {t('admin.orders.detail.fulfillments.tracking_description')}
+ </DialogDescription>
+ </DialogHeader>
+
+ <DialogBody>
+ {form.formState.errors.root?.message && (
+ <p className="text-sm text-destructive" role="alert">
+ {form.formState.errors.root.message}
+ </p>
+ )}
+
+ <Field>
+ <FieldLabel htmlFor="fulfillment-tracking">
+ {t('admin.orders.fulfill.tracking_label')}
+ </FieldLabel>
+ <Input
+ id="fulfillment-tracking"
+ placeholder={t('admin.orders.fulfill.tracking_placeholder')}
+ aria-invalid={!!form.formState.errors.tracking}
+ {...form.register('tracking')}
+ />
+ <FieldError errors={[form.formState.errors.tracking]} />
+ </Field>
+ </DialogBody>
+
+ <DialogFooter>
+ <Button type="button" variant="outline" onClick={() => onOpenChange(false)}>
+ {t('admin.actions.cancel')}
+ </Button>
+ <Button type="submit" disabled={update.isPending}>
+ {update.isPending ? t('admin.actions.saving') : t('admin.actions.save')}
+ </Button>
+ </DialogFooter>
+ </form>
+ </DialogContent>
+ </Dialog>
+ )
+}
diff --git a/packages/dashboard/src/components/spree/orders/fulfillments-card.tsx b/packages/dashboard/src/components/spree/orders/fulfillments-card.tsx
index 532e393b2f..fec5d27611 100644
--- a/packages/dashboard/src/components/spree/orders/fulfillments-card.tsx
+++ b/packages/dashboard/src/components/spree/orders/fulfillments-card.tsx
@@ -57,6 +57,7 @@ import {
import { FulfillmentEditDialog } from './fulfillment-edit-dialog'
import { FulfillmentFulfillForm } from './fulfillment-fulfill-form'
import { FulfillmentItemList } from './fulfillment-item-list'
+import { FulfillmentTrackingDialog } from './fulfillment-tracking-dialog'
/**
* A unit sitting in one fulfillment. Splitting moves units per variant rather
@@ -399,11 +400,17 @@ function FulfillmentRow({ order, fulfillment }: { order: Order; fulfillment: Ful
const [editOpen, setEditOpen] = useState(false)
const [splitOpen, setSplitOpen] = useState(false)
+ const [trackingOpen, setTrackingOpen] = useState(false)
const [fulfilling, setFulfilling] = useState(false)
const editable = CAN_EDIT.includes(fulfillment.status)
const splittable = editable && unitsOf(fulfillment).length > 0
const shippable = CAN_SHIP.includes(fulfillment.status)
+ // Confirming receipt is the merchant's next move on a parcel that has gone
+ // out, so it sits in the card rather than behind the menu. Adding tracking
+ // joins it as the primary action while the number is still missing.
+ const deliverable = CAN_MARK_DELIVERED.includes(fulfillment.status)
+ const trackable = deliverable && !fulfillment.tracking
return (
<div className="rounded-lg border flex flex-col">
@@ -448,10 +455,10 @@ function FulfillmentRow({ order, fulfillment }: { order: Order; fulfillment: Ful
</DropdownMenuItem>
)}
- {CAN_MARK_DELIVERED.includes(fulfillment.status) && (
- <DropdownMenuItem onClick={() => markDelivered.mutate(fulfillment.id)}>
- <PackageCheckIcon className="size-4" />
- {t('admin.orders.detail.fulfillments.mark_delivered')}
+ {deliverable && fulfillment.tracking && (
+ <DropdownMenuItem onClick={() => setTrackingOpen(true)}>
+ <TruckIcon className="size-4" />
+ {t('admin.orders.detail.fulfillments.edit_tracking_title')}
</DropdownMenuItem>
)}
@@ -535,6 +542,28 @@ function FulfillmentRow({ order, fulfillment }: { order: Order; fulfillment: Ful
</Button>
</div>
)}
+
+ {deliverable && (
+ <div className="flex justify-end gap-2 p-3 border-t">
+ <Button
+ type="button"
+ size="sm"
+ variant={trackable ? 'outline' : 'default'}
+ disabled={markDelivered.isPending}
+ onClick={() => markDelivered.mutate(fulfillment.id)}
+ >
+ <PackageCheckIcon data-icon="inline-start" />
+ {t('admin.orders.detail.fulfillments.mark_delivered')}
+ </Button>
+
+ {trackable && (
+ <Button type="button" size="sm" onClick={() => setTrackingOpen(true)}>
+ <PlusIcon data-icon="inline-start" />
+ {t('admin.orders.detail.fulfillments.add_tracking')}
+ </Button>
+ )}
+ </div>
+ )}
</>
)}
@@ -555,6 +584,15 @@ function FulfillmentRow({ order, fulfillment }: { order: Order; fulfillment: Ful
onOpenChange={setSplitOpen}
/>
)}
+
+ {trackingOpen && (
+ <FulfillmentTrackingDialog
+ orderId={orderId}
+ fulfillment={fulfillment}
+ open={trackingOpen}
+ onOpenChange={setTrackingOpen}
+ />
+ )}
</div>
)
}
diff --git a/packages/dashboard/src/locales/ar.json b/packages/dashboard/src/locales/ar.json
index a2174eab1b..189f783eeb 100644
--- a/packages/dashboard/src/locales/ar.json
+++ b/packages/dashboard/src/locales/ar.json
@@ -1839,7 +1839,11 @@
"split_title": "تقسيم الشحنة",
"split_would_empty": "اترك وحدة واحدة على الأقل، أو غيّر مصدر الشحنة بالكامل بدلاً من ذلك.",
"unfulfilled_other": "غير مُنفَّذ ({{count}})",
- "mark_delivered": "وضع علامة كمُسلَّم"
+ "mark_delivered": "وضع علامة كمُسلَّم",
+ "add_tracking": "إضافة تتبع",
+ "edit_tracking_title": "تعديل التتبع",
+ "add_tracking_title": "إضافة تتبع",
+ "tracking_description": "رقم تتبع شركة الشحن، أو رابط تتبع كامل."
},
"gift_card_section": {
"applied_suffix": "مُطبَّق",
diff --git a/packages/dashboard/src/locales/de.json b/packages/dashboard/src/locales/de.json
index be09d6faea..d7c3562646 100644
--- a/packages/dashboard/src/locales/de.json
+++ b/packages/dashboard/src/locales/de.json
@@ -1829,7 +1829,11 @@
"split_would_empty": "Lassen Sie mindestens eine Einheit zurück oder ändern Sie stattdessen den Ursprung der gesamten Sendung.",
"unfulfilled_one": "Nicht versandt ({{count}})",
"unfulfilled_other": "Nicht versandt ({{count}})",
- "mark_delivered": "Als zugestellt markieren"
+ "mark_delivered": "Als zugestellt markieren",
+ "add_tracking": "Sendungsverfolgung hinzufügen",
+ "edit_tracking_title": "Sendungsverfolgung bearbeiten",
+ "add_tracking_title": "Sendungsverfolgung hinzufügen",
+ "tracking_description": "Die Sendungsnummer des Zustellers oder ein vollständiger Tracking-Link."
},
"gift_card_section": {
"applied_suffix": "angewendet",
diff --git a/packages/dashboard/src/locales/en.json b/packages/dashboard/src/locales/en.json
index 5a44b4b989..9d59724722 100644
--- a/packages/dashboard/src/locales/en.json
+++ b/packages/dashboard/src/locales/en.json
@@ -1829,7 +1829,11 @@
"split_would_empty": "Leave at least one unit behind, or change the origin of the whole fulfillment instead.",
"unfulfilled_one": "Unfulfilled ({{count}})",
"unfulfilled_other": "Unfulfilled ({{count}})",
- "mark_delivered": "Mark as delivered"
+ "mark_delivered": "Mark as delivered",
+ "add_tracking": "Add tracking",
+ "edit_tracking_title": "Edit tracking",
+ "add_tracking_title": "Add tracking",
+ "tracking_description": "The carrier tracking number, or a full tracking link."
},
"gift_card_section": {
"applied_suffix": "applied",
diff --git a/packages/dashboard/src/locales/fr.json b/packages/dashboard/src/locales/fr.json
index c229350c6a..26d4182e0b 100644
--- a/packages/dashboard/src/locales/fr.json
+++ b/packages/dashboard/src/locales/fr.json
@@ -1829,7 +1829,11 @@
"split_would_empty": "Laissez au moins une unité, ou modifiez plutôt l'origine de toute l'expédition.",
"unfulfilled_one": "Non expédié ({{count}})",
"unfulfilled_other": "Non expédiés ({{count}})",
- "mark_delivered": "Marquer comme livré"
+ "mark_delivered": "Marquer comme livré",
+ "add_tracking": "Ajouter un suivi",
+ "edit_tracking_title": "Modifier le suivi",
+ "add_tracking_title": "Ajouter un suivi",
+ "tracking_description": "Le numéro de suivi du transporteur, ou un lien de suivi complet."
},
"gift_card_section": {
"applied_suffix": "appliqué",
diff --git a/packages/dashboard/src/locales/pl.json b/packages/dashboard/src/locales/pl.json
index c94c3e6cca..92fd2ec919 100644
--- a/packages/dashboard/src/locales/pl.json
+++ b/packages/dashboard/src/locales/pl.json
@@ -1847,7 +1847,11 @@
"unfulfilled_many": "Niezrealizowane ({{count}})",
"unfulfilled_one": "Niezrealizowane ({{count}})",
"unfulfilled_other": "Niezrealizowane ({{count}})",
- "mark_delivered": "Oznacz jako dostarczone"
+ "mark_delivered": "Oznacz jako dostarczone",
+ "add_tracking": "Dodaj śledzenie",
+ "edit_tracking_title": "Edytuj śledzenie",
+ "add_tracking_title": "Dodaj śledzenie",
+ "tracking_description": "Numer przesyłki od przewoźnika lub pełny link do śledzenia."
},
"gift_card_section": {
"applied_suffix": "zastosowano",
diff --git a/packages/dashboard/src/locales/zh-CN.json b/packages/dashboard/src/locales/zh-CN.json
index 01fe8abad4..0c4708b2aa 100644
--- a/packages/dashboard/src/locales/zh-CN.json
+++ b/packages/dashboard/src/locales/zh-CN.json
@@ -1825,7 +1825,11 @@
"split_title": "拆分发货单",
"split_would_empty": "请至少保留一件,或改为修改整个发货单的发货地。",
"unfulfilled_other": "未发货({{count}})",
- "mark_delivered": "标记为已送达"
+ "mark_delivered": "标记为已送达",
+ "add_tracking": "添加物流跟踪",
+ "edit_tracking_title": "编辑物流跟踪",
+ "add_tracking_title": "添加物流跟踪",
+ "tracking_description": "承运商的物流单号,或完整的跟踪链接。"
},
"gift_card_section": {
"applied_suffix": "已应用",