@spree/cli 3.2.2 → 3.4.0

package/dist/templates/seller-dashboard-starter/AGENTS.md

@@ -1,13 +1,19 @@
 # Agent Instructions
 
+`CLAUDE.md` only imports this file — edit this one.
+
 This is the Spree seller panel for this marketplace — a Vite + React app. The
 shell ships in `@spree/seller-dashboard`; this project holds your
 customizations. Sellers manage their own catalog and orders here.
 
 Full docs: https://spreecommerce.org/docs/developer/dashboard/overview
 
-The admin dashboard is the reference implementation: when a component is
-useful to both, extract it rather than copying it.
+## Running it
+
+Start the Spree API with `spree dev` from the project root (`../..`) — it is
+only ever run through the Spree CLI; see the project root's `AGENTS.md`. Then
+run this app's own dev server here with `pnpm dev` (or `npm run dev`); the
+Spree CLI does not start the seller panel for you.
 
 ## Imports
 
@@ -15,7 +21,7 @@ Import from `@spree/seller-dashboard` — it re-exports the framework and the de
 system, so there is no need to work out which package an export lives in.
 
 ```ts
-import { defineDashboardPlugin, useStore, Button, ResourceTable } from '@spree/seller-dashboard'
+import { defineDashboardPlugin, sellerClient, Button, ResourceTable } from '@spree/seller-dashboard'
 ```
 
 `@spree/dashboard-core` and `@spree/dashboard-ui` stay importable for the few
@@ -30,26 +36,35 @@ uses internally.
 | Directory | Holds | Naming |
 |---|---|---|
 | `src/plugins.ts` | Registrations only: nav, slots, tables | one file |
-| `src/pages/` | One screen each | `brands.tsx` |
-| `src/hooks/` | Admin API wrappers | `use-brands.ts` |
+| `src/pages/` | Larger components rendered inside slots | `payout-summary.tsx` |
+| `src/hooks/` | Seller API wrappers | `use-payouts.ts` |
 | `src/tables/` | `defineTable` calls | `brands.tsx` |
 | `src/schemas/` | Zod schema + `FormValues` | `brand.ts` |
 | `src/slots/` | Widgets injected into built-in pages | `seller-payout-card.tsx` |
 | `src/locales/` | Your `admin.*` translation keys | `en.json` |
 
-Adding a resource touches one file in each directory. Keep `plugins.ts` a map
-of what exists, not an implementation.
+Keep `plugins.ts` a map of what exists, not an implementation.
+
+The seller panel does not support adding new pages yet: plugins can remove
+built-in navigation entries, add widgets to the slots built-in screens expose,
+and add table columns. A navigation entry pointing at a path the panel does
+not have leads to a "not found" screen.
 
 ## Rules
 
-- **The Admin API is the only data source.** Never reach into the Rails app or
+- **The Seller API is the only data source.** Never reach into the Rails app or
   import server-rendered HTML. Seller endpoints are scoped to the signed-in
   seller by the server, never by the client. A missing endpoint is added to the API first.
-- **Wrap API calls in a hook.** Components never call `adminClient` directly.
-- **Query keys are store-scoped.** Build them with `useResourceKey`; a bare
-  `['brands']` key leaks one store's data into another after a store switch.
-- **Writes go through `useResourceMutation`**, which maps 422 responses onto
-  form fields instead of firing a toast.
+- **Use the Seller API, through a hook.** Hooks call `sellerClient()`;
+  components never call it directly. Never use `adminClient` here — it targets
+  the Admin API, which sellers cannot sign in to.
+- **There is no store context.** The panel's tenant is the signed-in seller, so
+  `useStore()` throws here. Build query keys with `useResourceKey`, which scopes
+  them to the seller.
+- **Writes go through `useResourceMutation`.** It shows a toast for network
+  and server failures but not for 422 validation errors — catch those in the
+  form's submit handler with `mapSpreeErrorsToForm`, which puts each message on
+  its field.
 - **Every visible string goes through i18next** — page titles, column labels,
   buttons, empty states, toasts. Never hardcode English in JSX or in a table
   definition. Add each new key to every locale file the project ships.
@@ -59,12 +74,15 @@ of what exists, not an implementation.
   walks every nested key and the SDK's object graph overflows the TypeScript
   compiler.
 - **A sortable or filterable column must be allowlisted for Ransack** on the
-  model, or the request fails at runtime.
+  model, or the request fails at runtime. That change belongs to the Spree API
+  in `../../server/` — follow `../../server/AGENTS.md`.
 - **Destructive actions that fire straight from a click need a confirm** —
   `useConfirm()` with `variant: 'destructive'`.
 
 ## Checks
 
+Run these with the project's package manager (`pnpm`, `npm run` or `yarn`):
+
 ```bash
 pnpm typecheck
 pnpm lint

package/dist/templates/seller-dashboard-starter/CLAUDE.md

@@ -0,0 +1 @@
+@AGENTS.md

package/dist/templates/seller-dashboard-starter/package.json

@@ -16,24 +16,28 @@
     "lint:fix": "biome check --fix ."
   },
   "dependencies": {
-    "@spree/seller-dashboard": "^1.0.0-rc.2",
-    "@spree/dashboard-core": "^1.0.0-rc.2",
-    "@spree/dashboard-ui": "^1.0.0-rc.2",
-    "@spree/seller-sdk": "^1.0.0-rc.1",
-    "@tanstack/react-query": "^5.100.9",
-    "@tanstack/react-router": "^1.169.2",
-    "react": "^19.2.6",
-    "react-dom": "^19.2.6"
+    "@spree/admin-sdk": "^1.0.0-rc.4",
+    "@spree/dashboard-core": "^1.0.0-rc.4",
+    "@spree/dashboard-ui": "^1.0.0-rc.4",
+    "@spree/seller-dashboard": "^1.0.0-rc.5",
+    "@spree/seller-sdk": "^1.0.0-rc.4",
+    "@tanstack/react-query": "^5.104.3",
+    "@tanstack/react-router": "^1.170.44",
+    "i18next": "^26.4.7",
+    "react": "^19.3.1",
+    "react-dom": "^19.3.1",
+    "react-hook-form": "^7.90.0",
+    "react-i18next": "^17.0.20"
   },
   "devDependencies": {
     "@biomejs/biome": "^2.4.14",
-    "@playwright/test": "^1.59.1",
+    "@playwright/test": "^1.64.1",
     "@types/react": "^19.2.14",
     "@types/react-dom": "^19.2.3",
     "@vitejs/plugin-react": "^6.0.1",
-    "typescript": "~6.0.3",
-    "vite": "^8.0.16",
-    "vitest": "^4.1.5"
+    "typescript": "~7.0.2",
+    "vite": "^8.3.4",
+    "vitest": "^5.0.5"
   },
   "packageManager": "pnpm@11.13.1"
 }

package/dist/templates/seller-dashboard-starter/src/plugins.ts

@@ -7,26 +7,27 @@
 // before the panel renders.
 //
 // Keep this file a map of what you added: the registrations live here, the
-// implementations live in pages/, hooks/, tables/ and schemas/ — one file per
+// implementations live in slots/, pages/, hooks/, tables/ and schemas/ — one file per
 // resource, the same layout the seller panel uses internally. Translations go
 // in locales/ and merge in with `i18n.addResourceBundle`.
 //
-// Example — add a payouts page and drop the built-in team screen:
+// Example — add a card to the team screen and drop the built-in team entry
+// from the navigation (the seller panel does not support new pages yet):
 //
 //   import { defineDashboardPlugin } from '@spree/seller-dashboard'
-//   import { PayoutsPage } from './pages/payouts'
+//   import { TeamAuditCard } from './slots/team-audit-card'
 //
 //   defineDashboardPlugin({
-//     nav: {
-//       add: [{ key: 'payouts', label: 'Payouts', path: '/payouts', position: 300 }],
-//       remove: ['team'],
-//     },
+//     nav: { remove: ['team'] },
 //     slots: {
 //       'seller.team.after': [{ id: 'audit', component: TeamAuditCard }],
 //     },
 //   })
 //
-// Slots the built-in screens expose: `seller.team.actions`, `seller.team.after`.
+// Slots the built-in screens expose: `seller.team.actions`, `seller.team.after`,
+// `seller.product.form_sidebar`, `seller.order.form_sidebar`,
+// `seller.payout.form_sidebar`, `seller.profile.form_main`,
+// `seller.profile.form_sidebar`.
 //
 // `@spree/dashboard-core` and `@spree/dashboard-ui` are already installed —
 // import hooks, providers and UI primitives straight from them.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@spree/cli",
-  "version": "3.2.2",
+  "version": "3.4.0",
   "description": "CLI for managing Spree Commerce projects",
   "type": "module",
   "bin": {
@@ -32,29 +32,30 @@
   },
   "dependencies": {
     "@clack/prompts": "^1.8.0",
-    "commander": "^14.0.3",
+    "commander": "^15.0.0",
     "console-table-printer": "^2.15.0",
-    "execa": "^9.6.1",
+    "execa": "^10.1.1",
     "picocolors": "^1.1.1"
   },
   "devDependencies": {
-    "@changesets/changelog-github": "^0.7.0",
-    "@changesets/cli": "^2.31.0",
-    "@types/node": "^25.6.0",
-    "tsup": "^8.5.1",
-    "typescript": "^6.0.3",
-    "vitest": "^4.1.5",
+    "@changesets/changelog-github": "^1.0.1",
+    "@changesets/cli": "^3.0.3",
+    "@types/node": "^26.6.5",
+    "tsup": "^9.0.0",
+    "typescript": "^7.0.2",
+    "vitest": "^5.0.5",
     "yaml": "^2.8.4",
-    "@spree/admin-sdk": "^1.0.0-rc.1"
+    "@spree/sdk-core": "0.1.0",
+    "@spree/admin-sdk": "^1.0.0-rc.4"
   },
   "engines": {
     "node": ">=20"
   },
   "scripts": {
     "build": "node scripts/bundle-spec.mjs && node ../../scripts/sync-starter.mjs templates/dashboard-starter && node ../../scripts/sync-starter.mjs templates/seller-dashboard-starter seller-dashboard-starter && tsup",
-    "dev": "tsup --watch",
-    "test": "vitest run",
-    "typecheck": "tsc --noEmit",
+    "dev": "node scripts/bundle-spec.mjs && tsup --watch",
+    "test": "node scripts/bundle-spec.mjs && vitest run",
+    "typecheck": "node scripts/bundle-spec.mjs && tsc --noEmit",
     "lint": "biome check src tests",
     "lint:fix": "biome check --fix src tests",
     "format": "biome format --write src tests",