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.

Simplify and standardise handling Customers and Admin staff users initials/full name/avatars

Damian Legawiec4066d3dfcff7
diff --git a/packages/admin-sdk/src/admin-client.ts b/packages/admin-sdk/src/admin-client.ts
index 2f068ecd6e..fca9476f60 100644
--- a/packages/admin-sdk/src/admin-client.ts
+++ b/packages/admin-sdk/src/admin-client.ts
@@ -35,12 +35,7 @@ export interface DashboardAnalytics {
export interface AuthTokens {
/** Short-lived JWT access token. Goes in `Authorization: Bearer`. Keep in memory only. */
token: string
- user: {
- id: string
- email: string
- first_name: string | null
- last_name: string | null
- }
+ user: AdminUser
}
export interface LoginCredentials {
diff --git a/packages/admin-sdk/src/types/generated/AdminUser.ts b/packages/admin-sdk/src/types/generated/AdminUser.ts
index 3f956c9052..e3fdb2984c 100644
--- a/packages/admin-sdk/src/types/generated/AdminUser.ts
+++ b/packages/admin-sdk/src/types/generated/AdminUser.ts
@@ -1,4 +1,4 @@
-// Typelizer digest 6933e1740c01636ff3f3edaf9171393d
+// Typelizer digest d3883b43172cd1d461cd22716869ac2f
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
@@ -7,6 +7,7 @@ interface AdminUser {
email: string;
first_name: string | null;
last_name: string | null;
+ full_name: string | null;
created_at: string;
updated_at: string;
roles: Array<{ id: string; name: string }>;
diff --git a/packages/admin/src/components/spree/promotion-editors/promotion-form.tsx b/packages/admin/src/components/spree/promotion-editors/promotion-form.tsx
index c18865d8b6..66fe658b83 100644
--- a/packages/admin/src/components/spree/promotion-editors/promotion-form.tsx
+++ b/packages/admin/src/components/spree/promotion-editors/promotion-form.tsx
@@ -1,4 +1,5 @@
import type {
+ Customer,
Promotion,
PromotionAction,
PromotionActionDraft,
@@ -803,11 +804,8 @@ function defaultLabel(o: unknown): string {
return ''
}
-function customerLabel(c: unknown): string {
- if (!c || typeof c !== 'object') return ''
- const o = c as { first_name?: string; last_name?: string; email?: string }
- const full = [o.first_name, o.last_name].filter(Boolean).join(' ').trim()
- return full || o.email || ''
+function customerLabel(c: Customer): string {
+ return c.full_name || c.email || ''
}
function RulePickerSheet({
diff --git a/packages/admin/src/components/spree/top-bar.tsx b/packages/admin/src/components/spree/top-bar.tsx
index 6c26809a96..1866a4013a 100644
--- a/packages/admin/src/components/spree/top-bar.tsx
+++ b/packages/admin/src/components/spree/top-bar.tsx
@@ -20,6 +20,7 @@ import {
import { SidebarTrigger } from '@/components/ui/sidebar'
import { useAuth } from '@/hooks/use-auth'
import { useCommandPalette } from '@/hooks/use-command-palette'
+import { getInitials } from '@/lib/formatters'
import { useStore } from '@/providers/store-provider'
const IS_MAC = typeof navigator !== 'undefined' && /Mac|iPhone|iPad/.test(navigator.platform ?? '')
@@ -100,14 +101,7 @@ function TopBarUser() {
const { user, logout } = useAuth()
if (!user) return null
- const initials =
- [user.first_name, user.last_name]
- .filter(Boolean)
- .map((n) => n![0])
- .join('')
- .toUpperCase() || user.email[0]!.toUpperCase()
-
- const displayName = [user.first_name, user.last_name].filter(Boolean).join(' ') || user.email
+ const initials = getInitials(user.full_name, user.email)
return (
<DropdownMenu>
@@ -132,7 +126,7 @@ function TopBarUser() {
</AvatarFallback>
</Avatar>
<div className="grid min-w-0 flex-1 text-sm leading-tight">
- <span className="truncate font-medium text-foreground">{displayName}</span>
+ <span className="truncate font-medium text-foreground">{user.full_name}</span>
<span className="truncate text-xs text-muted-foreground">{user.email}</span>
</div>
</div>
diff --git a/packages/admin/src/components/ui/avatar.tsx b/packages/admin/src/components/ui/avatar.tsx
index 5288e9388e..0829431334 100644
--- a/packages/admin/src/components/ui/avatar.tsx
+++ b/packages/admin/src/components/ui/avatar.tsx
@@ -41,7 +41,7 @@ function AvatarFallback({
<AvatarPrimitive.Fallback
data-slot="avatar-fallback"
className={cn(
- 'flex size-full items-center justify-center rounded-lg bg-muted text-sm text-muted-foreground group-data-[size=sm]/avatar:text-xs',
+ 'flex size-full items-center justify-center rounded-lg bg-muted text-sm text-muted-foreground group-data-[size=sm]/avatar:text-xs uppercase',
className,
)}
{...props}
diff --git a/packages/admin/src/lib/formatters.ts b/packages/admin/src/lib/formatters.ts
index daba0c1648..e66795899f 100644
--- a/packages/admin/src/lib/formatters.ts
+++ b/packages/admin/src/lib/formatters.ts
@@ -4,3 +4,10 @@ export function formatPrice(price: Pick<Price, 'amount' | 'currency' | 'display_
if (!price) return '—'
return price.display_amount ?? `${price.currency} ${price.amount}`
}
+
+export function getInitials(fullName: string | null | undefined, fallback: string): string {
+ const parts = (fullName ?? '').trim().split(/\s+/).filter(Boolean)
+ if (parts.length === 0) return fallback.charAt(0)
+ if (parts.length === 1) return parts[0].charAt(0)
+ return parts[0].charAt(0) + parts[parts.length - 1].charAt(0)
+}
diff --git a/packages/admin/src/providers/auth-provider.tsx b/packages/admin/src/providers/auth-provider.tsx
index 3fb0ff8220..f9da2a3ba2 100644
--- a/packages/admin/src/providers/auth-provider.tsx
+++ b/packages/admin/src/providers/auth-provider.tsx
@@ -1,16 +1,9 @@
-import type { AuthTokens, InvitationAcceptParams } from '@spree/admin-sdk'
+import type { AdminUser, AuthTokens, InvitationAcceptParams } from '@spree/admin-sdk'
import { createContext, type ReactNode, useCallback, useEffect, useRef, useState } from 'react'
import { adminClient } from '@/client'
-interface AuthUser {
- id: string
- email: string
- first_name: string | null
- last_name: string | null
-}
-
interface AuthContextValue {
- user: AuthUser | null
+ user: AdminUser | null
token: string | null
isAuthenticated: boolean
isInitializing: boolean
@@ -27,7 +20,7 @@ const REFRESH_INTERVAL_MS = 4 * 60 * 1000 + 30 * 1000
export function AuthProvider({ children }: { children: ReactNode }) {
const [token, setToken] = useState<string | null>(null)
- const [user, setUser] = useState<AuthUser | null>(null)
+ const [user, setUser] = useState<AdminUser | null>(null)
const [isInitializing, setIsInitializing] = useState(true)
const [isLoading, setIsLoading] = useState(false)
const refreshTimerRef = useRef<ReturnType<typeof setTimeout> | null>(null)
@@ -41,7 +34,7 @@ export function AuthProvider({ children }: { children: ReactNode }) {
}
}, [])
- const applySession = useCallback((accessToken: string, authUser: AuthUser) => {
+ const applySession = useCallback((accessToken: string, authUser: AdminUser) => {
adminClient.setToken(accessToken)
setToken(accessToken)
setUser(authUser)
diff --git a/packages/admin/src/routes/_authenticated/$storeId/customers/$customerId.tsx b/packages/admin/src/routes/_authenticated/$storeId/customers/$customerId.tsx
index 8670919e16..9d080cd4db 100644
--- a/packages/admin/src/routes/_authenticated/$storeId/customers/$customerId.tsx
+++ b/packages/admin/src/routes/_authenticated/$storeId/customers/$customerId.tsx
@@ -660,9 +660,7 @@ function AddressesCard({ customer }: { customer: Customer }) {
>
<div className="text-sm">
<div className="font-medium">
- {[addr.first_name, addr.last_name].filter(Boolean).join(' ').trim() ||
- addr.label ||
- '—'}
+ {addr.full_name ?? '—'}
<span className="ml-2 inline-flex gap-1">
{addr.is_default_billing && <Badge variant="outline">Default billing</Badge>}
{addr.is_default_shipping && (
diff --git a/packages/admin/src/routes/_authenticated/$storeId/orders/$orderId.tsx b/packages/admin/src/routes/_authenticated/$storeId/orders/$orderId.tsx
index 7f43269729..7064483aa1 100644
--- a/packages/admin/src/routes/_authenticated/$storeId/orders/$orderId.tsx
+++ b/packages/admin/src/routes/_authenticated/$storeId/orders/$orderId.tsx
@@ -30,6 +30,7 @@ import { RelativeTime } from '@/components/spree/relative-time'
import { ResourceLayout } from '@/components/spree/resource-layout'
import { ErrorState } from '@/components/spree/route-error-boundary'
import { TagCombobox } from '@/components/spree/tag-combobox'
+import { Avatar, AvatarFallback } from '@/components/ui/avatar'
import { Badge, StatusBadge } from '@/components/ui/badge'
import { Button } from '@/components/ui/button'
import { Card, CardAction, CardContent, CardHeader, CardTitle } from '@/components/ui/card'
@@ -72,7 +73,7 @@ import { Switch } from '@/components/ui/switch'
import { Textarea } from '@/components/ui/textarea'
import { orderQueryKey, useOrder, useOrderMutation } from '@/hooks/use-order'
import { useResourceMutation } from '@/hooks/use-resource-mutation'
-import { formatPrice } from '@/lib/formatters'
+import { formatPrice, getInitials } from '@/lib/formatters'
import { cn } from '@/lib/utils'
export const Route = createFileRoute('/_authenticated/$storeId/orders/$orderId')({
@@ -1220,14 +1221,6 @@ function SummaryRow({
)
}
-function customerDisplayName(
- customer?: { first_name: string | null; last_name: string | null; email: string } | null,
-): string {
- if (!customer) return '—'
- const name = [customer.first_name, customer.last_name].filter(Boolean).join(' ').trim()
- return name || customer.email
-}
-
function OrderSummaryCard({ order }: { order: Order }) {
const outstandingBalance = Number.parseFloat(order.amount_due ?? '0')
@@ -1237,9 +1230,7 @@ function OrderSummaryCard({ order }: { order: Order }) {
<CardTitle>Summary</CardTitle>
</CardHeader>
<div className="py-1">
- {order.created_by && (
- <SummaryRow label="Created by" value={customerDisplayName(order.created_by)} />
- )}
+ {order.created_by && <SummaryRow label="Created by" value={order.created_by.full_name} />}
<SummaryRow label="Created at" value={formatDate(order.created_at)} />
{order.completed_at && (
@@ -1249,14 +1240,12 @@ function OrderSummaryCard({ order }: { order: Order }) {
{order.canceled_at && (
<>
<SummaryRow label="Canceled at" value={formatDate(order.canceled_at)} />
- {order.canceler && (
- <SummaryRow label="Canceler" value={customerDisplayName(order.canceler)} />
- )}
+ {order.canceler && <SummaryRow label="Canceler" value={order.canceler.full_name} />}
</>
)}
{order.approved_at && order.approver && (
- <SummaryRow label="Approved by" value={customerDisplayName(order.approver)} />
+ <SummaryRow label="Approved by" value={order.approver.full_name} />
)}
<Separator />
@@ -1494,7 +1483,7 @@ function ApplyGiftCardDialog({
function CustomerCard({ order }: { order: Order }) {
const { orderId } = Route.useParams()
const queryClient = useQueryClient()
- const user = order.customer
+ const customer = order.customer
const [editAddress, setEditAddress] = useState<'shipping_address' | 'billing_address' | null>(
null,
)
@@ -1540,20 +1529,14 @@ function CustomerCard({ order }: { order: Order }) {
</CardHeader>
<CardContent className="flex flex-col gap-5">
{/* Contact info */}
- {user ? (
+ {customer ? (
<div className="flex items-center gap-3 rounded-xl bg-muted p-3">
- <div className="flex size-9 items-center justify-center rounded-lg bg-primary text-primary-foreground text-xs font-medium dark:bg-accent dark:text-foreground">
- {[user.first_name, user.last_name]
- .filter(Boolean)
- .map((n) => n![0])
- .join('')
- .toUpperCase() || user.email[0]!.toUpperCase()}
- </div>
+ <Avatar>
+ <AvatarFallback>{getInitials(customer.full_name, customer.email)}</AvatarFallback>
+ </Avatar>
<div className="min-w-0 flex-1">
- <div className="truncate text-sm font-medium">
- {[user.first_name, user.last_name].filter(Boolean).join(' ') || user.email}
- </div>
- <div className="truncate text-xs text-muted-foreground">{user.email}</div>
+ <div className="truncate text-sm font-medium">{customer.full_name}</div>
+ <div className="truncate text-xs text-muted-foreground">{customer.email}</div>
</div>
</div>
) : order.email ? (
diff --git a/packages/admin/src/routes/_authenticated/$storeId/settings/staff.tsx b/packages/admin/src/routes/_authenticated/$storeId/settings/staff.tsx
index bd24782492..876b43a7c1 100644
--- a/packages/admin/src/routes/_authenticated/$storeId/settings/staff.tsx
+++ b/packages/admin/src/routes/_authenticated/$storeId/settings/staff.tsx
@@ -68,6 +68,7 @@ import {
useStaff,
useUpdateStaff,
} from '@/hooks/use-staff'
+import { getInitials } from '@/lib/formatters'
export const Route = createFileRoute('/_authenticated/$storeId/settings/staff')({
component: StaffSettingsPage,
@@ -162,19 +163,12 @@ function StaffRow({ member }: { member: AdminUser }) {
const removeMutation = useRemoveStaff()
const confirm = useConfirm()
- const fullName = [member.first_name, member.last_name].filter(Boolean).join(' ').trim()
- const initials = (fullName || member.email)
- .split(/\s+/)
- .map((s) => s[0])
- .filter(Boolean)
- .slice(0, 2)
- .join('')
- .toUpperCase()
+ const initials = getInitials(member.full_name, member.email)
async function handleRemove() {
const ok = await confirm({
title: 'Remove from store?',
- message: `${fullName || member.email} will lose access to this store. Their account stays — they keep access to any other stores they belong to.`,
+ message: `${member.full_name || member.email} will lose access to this store. Their account stays — they keep access to any other stores they belong to.`,
variant: 'destructive',
confirmLabel: 'Remove',
})
@@ -197,8 +191,12 @@ function StaffRow({ member }: { member: AdminUser }) {
<AvatarFallback className="bg-muted text-xs">{initials}</AvatarFallback>
</Avatar>
<div className="flex flex-col leading-tight">
- <span className="font-medium text-foreground">{fullName || member.email}</span>
- {fullName && <span className="text-xs text-muted-foreground">{member.email}</span>}
+ <span className="font-medium text-foreground">
+ {member.full_name || member.email}
+ </span>
+ {member.full_name && (
+ <span className="text-xs text-muted-foreground">{member.email}</span>
+ )}
</div>
</div>
</TableCell>
diff --git a/packages/admin/src/tables/customers.tsx b/packages/admin/src/tables/customers.tsx
index 6aca957ede..6959c42611 100644
--- a/packages/admin/src/tables/customers.tsx
+++ b/packages/admin/src/tables/customers.tsx
@@ -35,10 +35,7 @@ defineTable('customers', {
sortable: true,
filterable: true,
default: true,
- render: (c) => {
- const name = [c.first_name, c.last_name].filter(Boolean).join(' ').trim()
- return name || '—'
- },
+ render: (c) => c.full_name ?? '—',
},
{
key: 'phone',
diff --git a/spree/api/app/serializers/spree/api/v3/admin/admin_user_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/admin_user_serializer.rb
index bd2e9e69fc..2d8fabc52c 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/admin_user_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/admin_user_serializer.rb
@@ -6,9 +6,10 @@ module Spree
typelize email: :string,
first_name: [:string, nullable: true],
last_name: [:string, nullable: true],
+ full_name: [:string, nullable: true],
roles: 'Array<{ id: string; name: string }>'
- attributes :email, :first_name, :last_name,
+ attributes :email, :first_name, :last_name, :full_name,
created_at: :iso8601, updated_at: :iso8601
# Roles assigned to this user *for the current store*. Each store