@spree/dashboard-core 1.0.0-beta.2 → 1.0.0-beta.4

package/src/lib/fulfillment-items.ts

@@ -9,6 +9,7 @@
 /** The line-item fields the grouping reads. */
 export interface GroupableLineItem {
   id: string
+  variant_id?: string | null
   name: string
   options_text?: string | null
   quantity: number
@@ -37,7 +38,10 @@ export interface GroupableFulfillment {
  * line item it descends from, plus how many of its units this group holds.
  */
 export interface FulfillmentItemRow {
-  /** Stable within one group — a line item appears at most once per group. */
+  /**
+   * Stable within one group — a line item appears at most once per group,
+   * plus once per replacement variant an exchange ships against it.
+   */
   key: string
   lineItem: GroupableLineItem | null
   /** Falls back to the fulfillment item's own copy when the line item is gone. */
@@ -94,20 +98,39 @@ export function fulfilledQuantities(fulfillments: GroupableFulfillment[]): Map<s
   return fulfilled
 }
 
-/** Builds a row, preferring the line item's own copy over the fulfillment item's. */
+/**
+ * An exchange ships its replacement against the original line item, so the
+ * unit's variant is the only thing that names what is actually in the box.
+ */
+function isReplacement(
+  lineItem: GroupableLineItem | undefined,
+  item: Pick<GroupableFulfillmentItem, 'variant_id'> | null,
+): boolean {
+  return Boolean(
+    lineItem?.variant_id && item?.variant_id && lineItem.variant_id !== item.variant_id,
+  )
+}
+
+/**
+ * Builds a row, preferring the line item's own copy over the fulfillment
+ * item's — unless the unit is a replacement, whose name, image and price the
+ * line item does not describe.
+ */
 function buildRow(
   key: string,
   lineItem: GroupableLineItem | undefined,
-  fallback: Pick<GroupableFulfillmentItem, 'name' | 'options_text'> | null,
+  fallback: Pick<GroupableFulfillmentItem, 'variant_id' | 'name' | 'options_text'> | null,
   quantity: number,
 ): FulfillmentItemRow {
+  const copy = isReplacement(lineItem, fallback) ? undefined : lineItem
+
   return {
     key,
     lineItem: lineItem ?? null,
-    name: lineItem?.name ?? fallback?.name ?? '',
-    optionsText: lineItem?.options_text ?? fallback?.options_text ?? null,
-    thumbnailUrl: lineItem?.thumbnail_url ?? null,
-    displayPrice: lineItem?.display_price ?? null,
+    name: copy?.name ?? fallback?.name ?? '',
+    optionsText: copy?.options_text ?? fallback?.options_text ?? null,
+    thumbnailUrl: copy?.thumbnail_url ?? null,
+    displayPrice: copy?.display_price ?? null,
     quantity,
   }
 }
@@ -128,7 +151,10 @@ export function fulfillmentItemRows(
   for (const item of fulfillment.fulfillment_items ?? []) {
     // A fulfillment item with no line item still ships; key it by variant so
     // it renders rather than vanishing.
-    const key = item.line_item_id ?? item.variant_id
+    const lineItem = item.line_item_id ? byId.get(item.line_item_id) : undefined
+    const key = isReplacement(lineItem, item)
+      ? `${item.line_item_id}:${item.variant_id}`
+      : (item.line_item_id ?? item.variant_id)
     if (!key) continue
 
     const existing = rows.get(key)
@@ -137,15 +163,7 @@ export function fulfillmentItemRows(
       continue
     }
 
-    rows.set(
-      key,
-      buildRow(
-        key,
-        item.line_item_id ? byId.get(item.line_item_id) : undefined,
-        item,
-        item.quantity,
-      ),
-    )
+    rows.set(key, buildRow(key, lineItem, item, item.quantity))
   }
 
   return [...rows.values()]

package/src/lib/i18n.ts

@@ -1,5 +1,6 @@
 import i18n from 'i18next'
 import { initReactI18next } from 'react-i18next'
+import { intlDisplayName } from '../hooks/use-display-name'
 // Relative path, not `@/...`: dashboard-core ships source; the consuming
 // project's `@/*` alias is theirs alone (see Phase 1's rationale).
 import en from '../locales/en.json'
@@ -126,10 +127,84 @@ const coreLocales = import.meta.glob<{ default: Record<string, unknown> }>(
 
 /** Admin-UI locale codes the framework ships a bundle for (including `en`). */
 export function coreLocaleCodes(): string[] {
-  return [
-    'en',
-    ...Object.keys(coreLocales).map((p) => p.replace('../locales/', '').replace('.json', '')),
-  ]
+  return localeCodesFromBundlePaths(Object.keys(coreLocales))
+}
+
+/**
+ * Turns a panel's locale-bundle paths into the `{ code, name }` pairs its
+ * language pickers render, with `en` always first.
+ *
+ * The glob itself has to stay in the calling package — `import.meta.glob` is a
+ * compile-time transform resolved against the file that writes it, so hoisting
+ * it here would scan the framework's own locales instead of the panel's. What
+ * IS shared is everything after that: stripping the path down to a code, and
+ * naming each language in its own words.
+ *
+ * @param paths bundle paths from the caller's `import.meta.glob`, e.g.
+ *   `./locales/de.json`
+ */
+export function localesFromBundlePaths(paths: string[]): Array<{ code: string; name: string }> {
+  return localeCodesFromBundlePaths(paths).map((code) => ({ code, name: localeEndonym(code) }))
+}
+
+// `en` first, then a code per bundle path. The glob hands back whatever prefix
+// the calling file used (`./locales/`, `../locales/`), so match either.
+function localeCodesFromBundlePaths(paths: string[]): string[] {
+  return ['en', ...paths.map((path) => path.replace(/^.*\/locales\//, '').replace('.json', ''))]
+}
+
+// Each language's endonym (its own name: `Deutsch`, `中文`). `Intl.DisplayNames`
+// answers in the language's own convention, so some come back lowercase
+// (`français`, `polski`); capitalize the first letter by THAT language's casing
+// rules rather than the current locale's. Scripts without case are unaffected,
+// and an unknown code falls back to itself.
+function localeEndonym(code: string): string {
+  const name = intlDisplayName('language', code, code) ?? code
+
+  return name.charAt(0).toLocaleUpperCase(code) + name.slice(1)
+}
+
+// The languages the running panel can display, as it declared them. `null`
+// until a panel does, which accepts every code — the behaviour before panels
+// declared anything.
+let uiLocaleCodes: readonly string[] | null = null
+
+/**
+ * Declares the languages this panel can display, so a saved preference for one
+ * it does not ship is never applied.
+ *
+ * The account's language is shared by every panel a person signs in to, and
+ * panels ship different sets: a language picked in one may not exist in the
+ * other. Applied anyway, the framework's own strings would switch while the
+ * panel's stayed in English. Call once at boot with the panel's own list.
+ *
+ * @param codes locale codes the panel ships a bundle for, e.g. `['en', 'de']`
+ */
+export function setUiLocales(codes: readonly string[]): void {
+  uiLocaleCodes = codes
+}
+
+/** @returns whether the running panel can display `code` */
+export function isUiLocale(code: string): boolean {
+  return uiLocaleCodes === null || uiLocaleCodes.includes(code)
+}
+
+/**
+ * The language a new session should switch the page to, or `null` when the
+ * page is already right.
+ *
+ * The account's saved language wins when the panel can display it. When it
+ * cannot, the page keeps the language it booted in — unless that one is not
+ * displayable either, which a panel reached before this check existed can be
+ * left in, and then it goes back to English.
+ *
+ * @param saved the account's `selected_locale`
+ * @param stored the language the page booted in
+ */
+export function sessionLocale(saved: string | null | undefined, stored: string): string | null {
+  const target = saved && isUiLocale(saved) ? saved : isUiLocale(stored) ? stored : 'en'
+
+  return target === stored ? null : target
 }
 
 /**

package/src/lib/permissions.ts

@@ -15,7 +15,7 @@ export const Subject = {
   Order: 'Spree::Order',
   SavedReport: 'Spree::SavedReport',
   ReportExport: 'Spree::Exports::Report',
-  Customer: 'Spree::User',
+  Customer: 'Spree::Customer',
   CustomerGroup: 'Spree::CustomerGroup',
   AdminUser: 'Spree::AdminUser',
   ApiKey: 'Spree::ApiKey',

package/src/lib/settings-nav-registry.ts

@@ -23,6 +23,16 @@ export interface SettingsNavEntry {
   label?: string
   /** i18n key passed to `t(...)` at render time. Takes precedence over `label`. */
   labelKey?: string
+  /**
+   * What the breadcrumb calls this page, when the sidebar label alone would
+   * read badly there. The sidebar shows an entry beneath its group header, so
+   * it can be named relative to that header ("Settings" under Marketplace);
+   * the breadcrumb has no such header and would repeat itself. Falls back to
+   * the sidebar label when unset, which is the case for nearly every entry.
+   */
+  breadcrumbLabel?: string
+  /** i18n key for `breadcrumbLabel`, resolved at render. Takes precedence over it. */
+  breadcrumbLabelKey?: string
   /**
    * One-line summary of what the page is for. Shown on the settings landing
    * page under the entry's label; the sidebar ignores it.
@@ -166,6 +176,23 @@ export function useSettingsNav() {
   return useSyncExternalStore(subscribe, getSnapshot, getSnapshot)
 }
 
+/**
+ * What the breadcrumb calls a settings entry: its own breadcrumb label when it
+ * declares one, otherwise the sidebar label.
+ *
+ * @param entry Entry from the settings nav registry.
+ * @param t Translation function used to resolve the key form.
+ * @returns The label to render in the trail.
+ */
+export function resolveSettingsBreadcrumbLabel(
+  entry: SettingsNavEntry,
+  t: (key: string) => string,
+): string {
+  if (entry.breadcrumbLabelKey) return t(entry.breadcrumbLabelKey)
+  if (entry.breadcrumbLabel) return entry.breadcrumbLabel
+  return resolveNavLabel(entry, t)
+}
+
 /**
  * Whether a settings entry matches a search term. Label, description and the
  * entry's own `keywords` all count, so the word a merchant knows ("VAT",

package/src/lib/slot-registry.ts

@@ -1,3 +1,4 @@
+import type { AdminUser } from '@spree/admin-sdk'
 import type { ComponentType } from 'react'
 import { useSyncExternalStore } from 'react'
 
@@ -26,6 +27,23 @@ export interface SlotEntry<TContext = unknown> {
   if?: (ctx: TContext & SlotAmbientContext) => boolean
 }
 
+// ============================================================================
+// Built-in slot names shared with plugins
+// ============================================================================
+
+/**
+ * The screen a signed-in admin sees when they hold a role on no store — not
+ * yet invited to one, or removed from all of them. Registering an entry
+ * replaces the built-in message, for example to render a different call to
+ * action or send the user elsewhere from an effect.
+ */
+export const NO_STORE_ACCESS_SLOT = 'no_store_access'
+
+export interface NoStoreAccessSlotContext {
+  user: AdminUser
+  signOut: () => Promise<void>
+}
+
 // ============================================================================
 // Registry — module-singleton keyed by slot name
 // ============================================================================

package/src/lib/table-registry.ts

@@ -85,13 +85,13 @@ export interface ResourceFilterConfig<R extends { id: string } = { id: string }>
 
 /**
  * Models that `TagCombobox` can target for tag autocomplete. The three
- * first-class taggables (Product, User, Order) get autocomplete hints, but
+ * first-class taggables (Product, Customer, Order) get autocomplete hints, but
  * the union is open — apps can pass any Ruby class string the backend's
  * `TagsController#allowed_taggable_types` accepts (override that method
  * server-side to extend). Use `Subject.Product` etc. to avoid stringly-typed
  * callsites for the built-ins.
  */
-export type TaggableType = 'Spree::Product' | 'Spree::User' | 'Spree::Order' | (string & {})
+export type TaggableType = 'Spree::Product' | 'Spree::Customer' | 'Spree::Order' | (string & {})
 
 /**
  * Column definition. Discriminated union on `filterType`:

package/src/locales/ar.json

@@ -125,6 +125,11 @@
         "title": "مرحبًا بعودتك"
       },
       "logout": "تسجيل الخروج",
+      "no_store_access": {
+        "description": "لقد سجّلت الدخول، لكن حسابك ليس عضوًا في أي متجر بعد. اطلب من مسؤول المتجر دعوتك، أو سجّل الدخول بحساب آخر.",
+        "signed_in_as": "تم تسجيل الدخول باسم {{email}}",
+        "title": "ليس لديك صلاحية الوصول إلى أي متجر"
+      },
       "reset_password": {
         "confirm_password_label": "تأكيد كلمة المرور الجديدة",
         "error": "حدث خطأ ما. يرجى المحاولة مرة أخرى.",
@@ -429,7 +434,6 @@
         "filter_select_placeholder": "اختر…",
         "filter_text_placeholder": "تصفية…",
         "filter_to_placeholder": "التصفية إلى…",
-        "more_conditions": "شروط إضافية",
         "operators": {
           "after": "بعد",
           "before": "قبل",
@@ -686,6 +690,32 @@
       "quantity": {
         "label": "الكمية"
       },
+      "setup": {
+        "country_code": {
+          "help": "من أين تشحن. يمكن لمتجرك البيع في جميع أنحاء العالم — هذا يحدد فقط العملة والمستودع ومناطق التوصيل الأولية، ويمكن تغييرها لاحقًا.",
+          "label": "البلد",
+          "placeholder": "ابحث عن البلدان"
+        },
+        "currency": {
+          "help": "عملتك الافتراضية. أضف المزيد في أي وقت.",
+          "label": "العملة",
+          "placeholder": "ابحث عن العملات"
+        },
+        "locale": {
+          "help": "لغتك الافتراضية. أضف المزيد في أي وقت.",
+          "label": "اللغة"
+        },
+        "password_confirmation": {
+          "label": "تأكيد كلمة المرور"
+        },
+        "sample_data": {
+          "help": "يضيف في الخلفية منتجات وفئات وعملاء وطلبات تجريبية لاستكشاف لوحة التحكم. يستغرق بضع دقائق ويقوم بتنزيل صور المنتجات.",
+          "label": "تحميل بيانات تجريبية"
+        },
+        "store_name": {
+          "label": "اسم المتجر"
+        }
+      },
       "shipping": {
         "label": "الشحن"
       },
@@ -1887,7 +1917,7 @@
         },
         "create_line_items": {
           "name": "إنشاء عناصر سطرية",
-          "description": "تعبئة سلة التسوق بالكمية المحددة من المتغير"
+          "description": "يضيف الكمية المحددة من المتغير إلى السلة مجانًا"
         },
         "free_shipping": {
           "name": "الشحن مجانًا",

package/src/locales/de.json

@@ -125,6 +125,11 @@
         "title": "Willkommen zurück"
       },
       "logout": "Abmelden",
+      "no_store_access": {
+        "description": "Sie sind angemeldet, aber Ihr Konto gehört noch keinem Store an. Bitten Sie einen Store-Administrator um eine Einladung oder melden Sie sich mit einem anderen Konto an.",
+        "signed_in_as": "Angemeldet als {{email}}",
+        "title": "Sie haben keinen Zugriff auf einen Store"
+      },
       "reset_password": {
         "confirm_password_label": "Neues Passwort bestätigen",
         "error": "Etwas ist schiefgelaufen. Bitte versuchen Sie es erneut.",
@@ -429,7 +434,6 @@
         "filter_select_placeholder": "Auswählen…",
         "filter_text_placeholder": "Filtern…",
         "filter_to_placeholder": "Filtern auf…",
-        "more_conditions": "Weitere Bedingungen",
         "operators": {
           "after": "nach",
           "before": "vor",
@@ -686,6 +690,32 @@
       "quantity": {
         "label": "Menge"
       },
+      "setup": {
+        "country_code": {
+          "help": "Von wo Sie versenden. Ihr Shop kann weltweit verkaufen — dies legt nur Startwährung, Lager und Liefergebiete fest, alle später änderbar.",
+          "label": "Land",
+          "placeholder": "Länder durchsuchen"
+        },
+        "currency": {
+          "help": "Ihre Standardwährung. Jederzeit erweiterbar.",
+          "label": "Währung",
+          "placeholder": "Währungen durchsuchen"
+        },
+        "locale": {
+          "help": "Ihre Standardsprache. Jederzeit erweiterbar.",
+          "label": "Sprache"
+        },
+        "password_confirmation": {
+          "label": "Passwort bestätigen"
+        },
+        "sample_data": {
+          "help": "Fügt im Hintergrund Demo-Produkte, Kategorien, Kunden und Bestellungen hinzu, damit Sie das Dashboard erkunden können. Dauert einige Minuten und lädt Produktbilder herunter.",
+          "label": "Beispieldaten laden"
+        },
+        "store_name": {
+          "label": "Shopname"
+        }
+      },
       "shipping": {
         "label": "Versand"
       },
@@ -1882,7 +1912,7 @@
         },
         "create_line_items": {
           "name": "Bestellpositionen erstellen",
-          "description": "Fügt dem Warenkorb die angegebene Menge der Variante hinzu"
+          "description": "Fügt dem Warenkorb die angegebene Menge der Variante kostenlos hinzu"
         },
         "free_shipping": {
           "name": "Kostenloser Versand",

package/src/locales/en.json

@@ -125,6 +125,11 @@
         "title": "Welcome back"
       },
       "logout": "Sign out",
+      "no_store_access": {
+        "description": "You're signed in, but your account isn't a member of any store yet. Ask a store administrator to invite you, or sign in with a different account.",
+        "signed_in_as": "Signed in as {{email}}",
+        "title": "You don't have access to any store"
+      },
       "reset_password": {
         "confirm_password_label": "Confirm new password",
         "error": "Something went wrong. Please try again.",
@@ -431,7 +436,6 @@
         "filter_select_placeholder": "Select…",
         "filter_text_placeholder": "Filter…",
         "filter_to_placeholder": "Filter to…",
-        "more_conditions": "More conditions",
         "operators": {
           "after": "after",
           "before": "before",
@@ -688,6 +692,32 @@
       "quantity": {
         "label": "Quantity"
       },
+      "setup": {
+        "country_code": {
+          "help": "Where you ship from. Your store can sell worldwide — this just sets the starting currency, warehouse and delivery zones, all editable later.",
+          "label": "Country",
+          "placeholder": "Search countries"
+        },
+        "currency": {
+          "help": "Your default currency. Add more anytime.",
+          "label": "Currency",
+          "placeholder": "Search currencies"
+        },
+        "locale": {
+          "help": "Your default language. Add more anytime.",
+          "label": "Language"
+        },
+        "password_confirmation": {
+          "label": "Confirm password"
+        },
+        "sample_data": {
+          "help": "Adds demo products, categories, customers and orders in the background so you can explore the dashboard. Takes a few minutes and downloads product images.",
+          "label": "Load sample data"
+        },
+        "store_name": {
+          "label": "Store name"
+        }
+      },
       "shipping": {
         "label": "Shipping"
       },
@@ -1884,7 +1914,7 @@
         },
         "create_line_items": {
           "name": "Create line items",
-          "description": "Populates the cart with the specified quantity of variant"
+          "description": "Adds the specified quantity of a variant to the cart free of charge"
         },
         "free_shipping": {
           "name": "Free shipping",