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.
Ruby b2b-commercee-commerceecommerceecommerce-apiecommerce-frameworkecommerce-platformheadlessheadless-commerceheadless-ecommercemarketplacemulti-tenantmulti-vendormulti-vendor-ecommerceopen-sourcespree-commerce
/* Vite integration for hosts building on the full `@spree/dashboard` shell.
*
* Extends `@spree/dashboard-core/vite` (Tailwind wiring, plugin discovery,
* the `virtual:spree-dashboard-plugins` activation module) with route-tree
* composition: the TanStack Router generator runs in the HOST build over a
* virtual route config that mounts the shell's route files plus every
* discovered plugin's file-routes directory. The composed `routeTree.gen.ts`
* lands in the host (default `src/routeTree.gen.ts`), so typed links cover
* shell, host, and plugin routes in one program — and regenerate from the
* installed package versions on every dev start and build.
*
* Custom dashboards built directly on `dashboard-core` + `dashboard-ui`
* should import `@spree/dashboard-core/vite` instead — no shell, no shell
* routes to compose.
*/
import path from 'node:path'
import {
type SpreeDashboardPluginOptions as CoreOptions,
spreeDashboardPlugin as spreeDashboardCorePlugin,
} from '@spree/dashboard-core/vite'
import {
discoverDashboardPluginManifests,
resolveShellRoutesDir,
} from '@spree/dashboard-core/vite/discover'
import { TanStackRouterVite } from '@tanstack/router-plugin/vite'
import { index, layout, physical, rootRoute, route } from '@tanstack/virtual-file-routes'
import type { PluginOption } from 'vite'
// Explicit .js extension: this entry ships compiled (dist/vite-plugin), where
// the specifier must name the real emitted file — tsup transpiles 1:1 without
// rewriting import paths. Bundlers map .js back to the .ts source.
import { assertNoRouteCollisions, type RouteSource } from './route-collisions.js'
export interface SpreeDashboardPluginOptions extends CoreOptions {
/**
* Where the composed route tree is generated, relative to the host root.
* Commit this file: it regenerates on every dev start/build, and its diff
* on a `@spree/dashboard` (or plugin) upgrade shows exactly which admin
* pages the upgrade added or moved.
*/
generatedRouteTree?: string
/**
* Host project root. Defaults to `process.cwd()` — correct when Vite runs
* from the package directory, which is how the starter and every
* create-spree-app project operate. Pass explicitly when running Vite
* with a different `root`.
*/
root?: string
}
export function spreeDashboardPlugin(options: SpreeDashboardPluginOptions = {}): PluginOption[] {
const hostRoot = options.root ?? process.cwd()
return [...spreeDashboardCorePlugin(options), dashboardRouterPlugin(hostRoot, options)]
}
/**
* The TanStack Router generator, configured with a virtual route config that
* mirrors the shell's top-level layout skeleton and physically mounts:
*
* - the shell's `_authenticated/$storeId` pages,
* - each plugin's store pages (the `spree.dashboard.routes` marker), under
* the same authenticated store scope,
* - each plugin's signed-in pages outside a store
* (`spree.dashboard.authenticatedRoutes`), inside the `_authenticated`
* layout, and
* - each plugin's public pages (`spree.dashboard.publicRoutes`), at the root.
*
* The skeleton names the shell's top-level route files explicitly; when the
* shell grows a new top-level route it must be added here. The shell's own
* Vite config uses this same composition, so a missed file breaks the
* shell's dev/e2e in-repo rather than silently in hosts.
*/
function dashboardRouterPlugin(hostRoot: string, options: SpreeDashboardPluginOptions) {
const shellRoutesDir = resolveShellRoutesDir(hostRoot, '@spree/dashboard')
const manifests = discoverDashboardPluginManifests(
{ root: hostRoot, onWarn: (msg) => console.warn(`[@spree/dashboard/vite] ${msg}`) },
options.plugins,
)
const routeDirs = (key: 'routesDir' | 'authenticatedRoutesDir' | 'publicRoutesDir') =>
manifests.flatMap((m): RouteSource[] => {
const routesDir = m[key]
return routesDir ? [{ label: m.name, routesDir }] : []
})
const storeSources = routeDirs('routesDir')
const authenticatedSources = routeDirs('authenticatedRoutesDir')
const publicSources = routeDirs('publicRoutesDir')
// Pre-flight: fail on route-path collisions with an error naming the
// offending packages (the shell counts as `@spree/dashboard`), before the
// generator's file-path-only error would fire.
const sources: RouteSource[] = [
{ label: '@spree/dashboard', routesDir: shellRoutesDir },
...storeSources,
...authenticatedSources,
...publicSources,
]
assertNoRouteCollisions(sources)
// POSIX-normalize: the generator expects forward slashes; path.relative
// emits backslashes on Windows.
const mount = (list: RouteSource[]) =>
list.map((source) =>
physical('', path.relative(shellRoutesDir, source.routesDir).split(path.sep).join('/')),
)
const virtualRouteConfig = rootRoute('__root.tsx', [
route('/login', 'login.tsx'),
route('/setup', 'setup.tsx'),
route('/forgot-password', 'forgot-password.tsx'),
route('/reset-password', 'reset-password.tsx'),
route('/accept-invitation/$invitationId', 'accept-invitation.$invitationId.tsx'),
...mount(publicSources),
layout('_authenticated.tsx', [
index('_authenticated/index.tsx'),
...mount(authenticatedSources),
route('/$storeId', '_authenticated/$storeId.tsx', [
physical('', '_authenticated/$storeId'),
...mount(storeSources),
]),
]),
])
return TanStackRouterVite({
target: 'react',
virtualRouteConfig,
routesDirectory: shellRoutesDir,
generatedRouteTree: path.resolve(
hostRoot,
options.generatedRouteTree ?? 'src/routeTree.gen.ts',
),
})
}