@spree/cli 2.3.8 → 2.4.0

package/dist/templates/dashboard-starter/.env.example

@@ -0,0 +1,4 @@
+# URL of your Spree API server. No credentials belong in this file —
+# admins sign in with email/password in the dashboard itself, and every
+# VITE_-prefixed value is compiled into the client bundle.
+VITE_SPREE_API_URL=http://localhost:3000

package/dist/templates/dashboard-starter/README.md

@@ -0,0 +1,36 @@
+# Spree Dashboard Starter
+
+The host app for the [Spree React Dashboard](https://spreecommerce.org/docs/developer/dashboard/overview) — the admin for your Spree store. `@spree/dashboard` is the actual app shell (routes, chrome, resource pages); this project is your customization point: plugins, your own pages, theming, and deployment config.
+
+> **Monorepo note.** The canonical source of this template lives at `packages/dashboard-starter` in [spree/spree](https://github.com/spree/spree), where its Spree dependencies resolve via the pnpm workspace and `@spree/dashboard-plugin-example` is installed as a devDependency — booting it here doubles as the end-to-end test for the plugin pipeline. At build time, `@spree/cli` and `create-spree-app` embed a standalone rendering of it (workspace deps rewritten to the published versions — see `scripts/sync-dashboard-starter.mjs`), which is what `spree add dashboard` and the create-spree-app dashboard prompt scaffold from.
+
+## Develop
+
+```bash
+pnpm install
+cp .env.example .env.local   # point VITE_SPREE_API_URL at your Spree API
+pnpm dev                     # http://localhost:5173
+```
+
+Sign in with an admin account — authentication is interactive (JWT + refresh cookie). No API keys belong in `.env.local`: every `VITE_`-prefixed value is compiled into the client bundle.
+
+## Install a dashboard plugin
+
+```bash
+pnpm add @acme/reviews-plugin
+# restart the dev server
+```
+
+That's the whole install. `spreeDashboardPlugin()` (see `vite.config.ts`) discovers any dependency carrying the `spree.dashboard.plugin` marker, activates it through the `virtual:spree-dashboard-plugins` module imported in `src/main.tsx`, and wires its Tailwind classes.
+
+## Customize
+
+`src/plugins.ts` is yours — register nav entries, routes, slot widgets, and table columns with `defineDashboardPlugin` from `@spree/dashboard-core`. Same API the distributed plugins use; see the [customization quickstart](https://spreecommerce.org/docs/developer/dashboard/customization/quickstart).
+
+## Build & deploy
+
+```bash
+pnpm build    # static assets in dist/
+```
+
+Deploy `dist/` to any static host. Set `VITE_SPREE_API_URL` to your production API at build time, and configure the API's CORS/cookie settings for the dashboard origin.

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

@@ -0,0 +1,60 @@
+{
+  "$schema": "https://biomejs.dev/schemas/2.4.13/schema.json",
+  "vcs": {
+    "enabled": true,
+    "clientKind": "git",
+    "useIgnoreFile": true
+  },
+  "linter": {
+    "enabled": true,
+    "rules": {
+      "recommended": true,
+      "correctness": {
+        "noUnusedImports": "warn",
+        "noUnusedVariables": "warn"
+      },
+      "suspicious": {
+        "noExplicitAny": "off"
+      },
+      "style": {
+        "noNonNullAssertion": "off"
+      }
+    }
+  },
+  "formatter": {
+    "enabled": true,
+    "indentStyle": "space",
+    "indentWidth": 2,
+    "lineWidth": 100
+  },
+  "javascript": {
+    "formatter": {
+      "quoteStyle": "single",
+      "semicolons": "asNeeded"
+    }
+  },
+  "css": {
+    "linter": {
+      "enabled": false
+    },
+    "formatter": {
+      "enabled": false
+    }
+  },
+  "assist": {
+    "actions": {
+      "source": {
+        "organizeImports": "on"
+      }
+    }
+  },
+  "files": {
+    "includes": [
+      "src/**",
+      "*.ts",
+      "index.html",
+      "!src/routeTree.gen.ts",
+      "!src/**/*.css"
+    ]
+  }
+}

package/dist/templates/dashboard-starter/gitignore.template

@@ -0,0 +1,6 @@
+node_modules/
+dist/
+.tanstack/
+.env.local
+.env.*.local
+*.log

package/dist/templates/dashboard-starter/index.html

@@ -0,0 +1,27 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Spree Admin</title>
+  </head>
+  <body>
+    <script>
+      (() => {
+        try {
+          const stored = localStorage.getItem('spree-admin-theme');
+          const mode = stored === 'light' || stored === 'dark' ? stored : 'system';
+          const dark =
+            mode === 'dark' ||
+            (mode === 'system' && window.matchMedia('(prefers-color-scheme: dark)').matches);
+          if (dark) document.documentElement.classList.add('dark');
+          document.documentElement.style.colorScheme = dark ? 'dark' : 'light';
+        } catch (_) {
+          /* localStorage unavailable */
+        }
+      })();
+    </script>
+    <div id="root"></div>
+    <script type="module" src="/src/main.tsx"></script>
+  </body>
+</html>

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

@@ -0,0 +1,33 @@
+{
+  "name": "@spree/dashboard-starter",
+  "private": true,
+  "license": "MIT",
+  "version": "0.0.0",
+  "type": "module",
+  "scripts": {
+    "dev": "vite",
+    "build": "vite build",
+    "preview": "vite preview",
+    "typecheck": "tsc --noEmit",
+    "lint": "biome check .",
+    "lint:fix": "biome check --fix ."
+  },
+  "dependencies": {
+    "@spree/admin-sdk": "^0.5.0",
+    "@spree/dashboard": "^0.10.0",
+    "@spree/dashboard-core": "^0.10.0",
+    "@spree/dashboard-ui": "^0.10.0",
+    "@tanstack/react-query": "^5.100.9",
+    "@tanstack/react-router": "^1.169.2",
+    "react": "^19.2.6",
+    "react-dom": "^19.2.6"
+  },
+  "devDependencies": {
+    "@biomejs/biome": "^2.4.14",
+    "@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"
+  }
+}

package/dist/templates/dashboard-starter/src/main.tsx

@@ -0,0 +1,30 @@
+// The shell module runs the i18n/nav/search bootstrap on import — it must
+// execute before the plugin imports below so plugins can call i18n.t at
+// module load. (Side-effect imports are ordering barriers.)
+import { createDashboardRouter, Dashboard } from '@spree/dashboard'
+import { createRoot } from 'react-dom/client'
+// Activate installed dashboard plugins — synthesized by spreeDashboardPlugin()
+// from your package.json deps. `pnpm add <plugin>` + dev-server restart is the
+// whole install; this line never changes.
+import 'virtual:spree-dashboard-plugins'
+// Your own customizations (nav entries, routes, slot widgets, table columns).
+import './plugins'
+import './styles.css'
+// Generated by @spree/dashboard/vite on every dev start and build: the
+// shell's routes composed with every installed plugin's file routes. Commit
+// it — its diff on upgrades shows exactly which admin pages changed.
+import { routeTree } from './routeTree.gen'
+
+// basepath mirrors Vite's `base` so sub-path mounts (/dashboard on the
+// single-node topology) route correctly; '/' in dev and root deploys.
+const router = createDashboardRouter(routeTree, { basepath: import.meta.env.BASE_URL })
+
+// Registers the composed router program-wide so <Link> and navigation are
+// type-checked against the real route tree — shell, host, and plugin routes.
+declare module '@tanstack/react-router' {
+  interface Register {
+    router: typeof router
+  }
+}
+
+createRoot(document.getElementById('root')!).render(<Dashboard router={router} />)

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

@@ -0,0 +1,19 @@
+// Dashboard customizations for this store.
+//
+// Register nav entries, routes, slot widgets, and table columns against the
+// shared registries — the same API distributed plugins use. Imported once
+// from main.tsx, before the dashboard renders.
+//
+// Example:
+//
+//   import { defineDashboardPlugin } from '@spree/dashboard-core'
+//   import { AnalyticsPage } from './pages/analytics'
+//
+//   defineDashboardPlugin({
+//     nav: [{ key: 'analytics', label: 'Analytics', path: '/analytics', position: 60 }],
+//     routes: [{ key: 'analytics', path: '/analytics', component: AnalyticsPage }],
+//   })
+//
+// Docs: https://spreecommerce.org/docs/developer/dashboard/customization/quickstart
+
+export {}