VendureDashboardPlugin

function vendureDashboardPlugin(options: VitePluginVendureDashboardOptions): PluginOption[]

type VitePluginVendureDashboardOptions = {    /**     * @description     * The path to the Vendure server configuration file.     */    vendureConfigPath: string | URL;    /**     * @description     * The {@link PathAdapter} allows you to customize the resolution of paths     * in the compiled Vendure source code which is used as part of the     * introspection step of building the dashboard.     *     * It enables support for more complex repository structures, such as     * monorepos, where the Vendure server configuration file may not     * be located in the root directory of the project.     *     * If you get compilation errors like "Error loading Vendure config: Cannot find module",     * you probably need to provide a custom `pathAdapter` to resolve the paths correctly.     *     * @example     * ```ts     * vendureDashboardPlugin({     *     tempCompilationDir: join(__dirname, './__vendure-dashboard-temp'),     *     pathAdapter: {     *         getCompiledConfigPath: ({ inputRootDir, outputPath, configFileName }) => {     *             const projectName = inputRootDir.split('/libs/')[1].split('/')[0];     *             const pathAfterProject = inputRootDir.split(`/libs/${projectName}`)[1];     *             const compiledConfigFilePath = `${outputPath}/${projectName}${pathAfterProject}`;     *             return path.join(compiledConfigFilePath, configFileName);     *         },     *         transformTsConfigPathMappings: ({ phase, patterns }) => {     *             // "loading" phase is when the compiled Vendure code is being loaded by     *             // the plugin, in order to introspect the configuration of your app.     *             if (phase === 'loading') {     *                 return patterns.map((p) =>     *                     p.replace('libs/', '').replace(/.ts$/, '.js'),     *                 );     *             }     *             return patterns;     *         },     *     },     *     // ...     * }),     * ```     */    pathAdapter?: PathAdapter;    /**     * @description     * The name of the exported variable from the Vendure server configuration file, e.g. `config`.     * This is only required if the plugin is unable to auto-detect the name of the exported variable.     */    vendureConfigExport?: string;    /**     * @description     * The path to the directory where the generated GraphQL Tada files will be output.     */    gqlOutputPath?: string;    /**     * @description     * The directory into which the VendureConfig is transpiled and loaded in order     * to introspect the configuration during the dashboard build.     *     * Defaults to `<project>/node_modules/.cache/vendure-dashboard-temp`. It must     * not be located inside a `"type": "module"` package (such as     * `@vendure/dashboard` itself), because the config is compiled to CommonJS and     * Node would then load it as ESM, failing with     * `exports is not defined in ES module scope`.     */    tempCompilationDir?: string;    /**     * @description     * Options passed to the underlying TanStack Router Vite plugin (`tanstackRouter()`). These are     * merged on top of the Dashboard's own defaults, letting you override most aspects of the router     * plugin's configuration. The `routesDirectory`, `generatedRouteTree` and `routeFileIgnorePattern`     * settings are managed by the Dashboard and cannot be overridden (attempts are ignored with a warning).     *     * A common use case is setting `tmpDir` when your deployment's default temp directory is on a     * different device than the checked-out code (e.g. `node_modules` on a separate volume), which     * otherwise causes the build to fail with `EXDEV: cross-device link not permitted` during     * route-tree generation.     *     * @example     * ```ts     * vendureDashboardPlugin({     *   vendureConfigPath: './vendure-config.ts',     *   tanstackRouterPluginOptions: {     *     tmpDir: path.join(packageRoot, '.tanstack-tmp'),     *   },     * })     * ```     *     * @since 3.7.0     */    tanstackRouterPluginOptions?: TanstackRouterPluginOptions;    /**     * @description     * Allows you to customize the location of node_modules & glob patterns used to scan for potential     * Vendure plugins installed as npm packages. If not provided, the compiler will attempt to guess     * the location based on the location of the `@vendure/core` package.     */    pluginPackageScanner?: PackageScannerConfig;    /**     * @description     * Allows you to specify the module system to use when compiling and loading your Vendure config.     * By default, the compiler will use CommonJS, but you can set it to `esm` if you are using     * ES Modules in your Vendure project.     *     * **Status** Developer preview. If you are using ESM please try this out and provide us with feedback!     *     * @since 3.5.1     * @default 'commonjs'     */    module?: 'commonjs' | 'esm';    /**     * @description     * Allows you to selectively disable individual plugins.     * @example     * ```ts     * vendureDashboardPlugin({     *   vendureConfigPath: './config.ts',     *   disablePlugins: {     *     react: true,     *     lingui: true,     *   }     * })     * ```     */    disablePlugins?: {        tanstackRouter?: boolean;        linguiBabel?: boolean;        react?: boolean;        lingui?: boolean;        themeVariables?: boolean;        tailwindSource?: boolean;        tailwindcss?: boolean;        configLoader?: boolean;        viteConfig?: boolean;        bundleEntry?: boolean;        adminApiSchema?: boolean;        dashboardMetadata?: boolean;        uiConfig?: boolean;        gqlTada?: boolean;        transformIndexHtml?: boolean;        translations?: boolean;        hmr?: boolean;    };    /**     * @description     * **EXPERIMENTAL** — Opt into the pre-bundled dashboard architecture.     *     * When `true`, the dashboard is loaded from a pre-built ESM bundle     * (`@vendure/dashboard/dist/publishable/`) shipped inside the npm package,     * instead of being compiled from TypeScript source by your Vite dev server.     * This dramatically reduces the number of HTTP requests during `vite dev`     * (~3000 raw module fetches → ~40 bundled chunks) which avoids the     * Chromium renderer crash reported in issue #4715.     *     * Trade-offs while this is experimental:     * - Some dashboard internals are now opaque to your `vite dev` (no per-file HMR     *   for the dashboard itself; extension HMR still works)     * - Reports of behavioural regressions are very welcome — this flag exists so     *   the bundled mode can be tested in real-world projects alongside the stable     *   source-shipping mode.     *     * This flag will be removed (and the bundled mode will become the default)     * once it has been validated across enough real-world setups.     *     * @default false     * @since 3.7.0     */    useExperimentalBundle?: boolean;    /**     * @description     * Customizes the dashboard's appearance. Override design-token colours for     * the `light` and `dark` themes, and/or layer in additional stylesheets via     * `additionalStylesheets`.     *     * @example     * ```ts     * vendureDashboardPlugin({     *     theme: {     *         light: { brand: '#1a1a1a' },     *         additionalStylesheets: [resolve(__dirname, 'src/dashboard.css')],     *     },     * })     * ```     */    theme?: DashboardThemeOptions;} & UiConfigPluginOptions

vendureDashboardPlugin({    pathAdapter: {        getCompiledConfigPath: ({ inputRootDir, outputPath, configFileName }) => {            const projectName = inputRootDir.split('/libs/')[1].split('/')[0];            const pathAfterProject = inputRootDir.split(`/libs/${projectName}`)[1];            const compiledConfigFilePath = `${outputPath}/${projectName}${pathAfterProject}`;            return path.join(compiledConfigFilePath, configFileName);        },        transformTsConfigPathMappings: ({ phase, patterns }) => {            // "loading" phase is when the compiled Vendure code is being loaded by            // the plugin, in order to introspect the configuration of your app.            if (phase === 'loading') {                return patterns.map((p) =>                    p.replace('libs/', '').replace(/.ts$/, '.js'),                );            }            return patterns;        },    },    // ...}),

interface PathAdapter {    getCompiledConfigPath?: GetCompiledConfigPathFn;    transformTsConfigPathMappings?: TransformTsConfigPathMappingsFn;    sourceRoot?: string;}

interface DashboardThemeOptions extends ThemeVariables {    additionalStylesheets?: string | string[];}

interface ApiConfig {    host?: string | 'auto';    port?: number | 'auto';    adminApiPath?: string;    tokenMethod?: 'cookie' | 'bearer';    authTokenHeaderKey?: string;    channelTokenKey?: string;}

interface I18nConfig {    defaultLanguage?: LanguageCode;    defaultLocale?: string;    availableLanguages?: LanguageCode[];    availableLocales?: string[];}

interface OrdersConfig {    refundReasons?: Array<{ value: string; label: string }>;}

interface UiConfigPluginOptions {    api?: ApiConfig;    i18n?: I18nConfig;    orders?: OrdersConfig;}