@vendure/dashboard 3.4.1-master-202508020237 → 3.4.1-master-202508040248

package/vite/vite-plugin-theme.ts

@@ -1,195 +0,0 @@
-import { Plugin } from 'vite';
-
-type ThemeColors = {
-    background?: string;
-    foreground?: string;
-    card?: string;
-    'card-foreground'?: string;
-    popover?: string;
-    'popover-foreground'?: string;
-    primary?: string;
-    'primary-foreground'?: string;
-    secondary?: string;
-    'secondary-foreground'?: string;
-    muted?: string;
-    'muted-foreground'?: string;
-    accent?: string;
-    'accent-foreground'?: string;
-    destructive?: string;
-    'destructive-foreground'?: string;
-    success?: string;
-    'success-foreground'?: string;
-    'dev-mode'?: string;
-    'dev-mode-foreground'?: string;
-    border?: string;
-    input?: string;
-    ring?: string;
-    'chart-1'?: string;
-    'chart-2'?: string;
-    'chart-3'?: string;
-    'chart-4'?: string;
-    'chart-5'?: string;
-    radius?: string;
-    sidebar?: string;
-    'sidebar-foreground'?: string;
-    'sidebar-primary'?: string;
-    'sidebar-primary-foreground'?: string;
-    'sidebar-accent'?: string;
-    'sidebar-accent-foreground'?: string;
-    'sidebar-border'?: string;
-    'sidebar-ring'?: string;
-    brand?: string;
-    'brand-lighter'?: string;
-    'brand-darker'?: string;
-    'font-sans'?: string;
-    'font-mono'?: string;
-    [key: string]: string | undefined;
-};
-
-export interface ThemeVariables {
-    light?: ThemeColors;
-    dark?: ThemeColors;
-}
-
-const defaultVariables: ThemeVariables = {
-    light: {
-        background: 'oklch(1.0000 0 0)',
-        foreground: 'oklch(0.2103 0.0059 285.8852)',
-        card: 'oklch(1.0000 0 0)',
-        'card-foreground': 'oklch(0.2103 0.0059 285.8852)',
-        popover: 'oklch(1.0000 0 0)',
-        'popover-foreground': 'oklch(0.2103 0.0059 285.8852)',
-        primary: 'oklch(0.7613 0.1503 231.1314)',
-        'primary-foreground': 'oklch(0.1408 0.0044 285.8229)',
-        secondary: 'oklch(0.9674 0.0013 286.3752)',
-        'secondary-foreground': 'oklch(0.2103 0.0059 285.8852)',
-        muted: 'oklch(0.9674 0.0013 286.3752)',
-        'muted-foreground': 'oklch(0.5517 0.0138 285.9385)',
-        accent: 'oklch(0.9674 0.0013 286.3752)',
-        'accent-foreground': 'oklch(0.2103 0.0059 285.8852)',
-        destructive: 'oklch(0.5771 0.2152 27.3250)',
-        'destructive-foreground': 'oklch(0.9851 0 0)',
-        success: 'hsl(100, 81%, 35%)',
-        'success-foreground': 'hsl(0 0% 98%)',
-        'dev-mode': 'hsl(204, 76%, 62%)',
-        'dev-mode-foreground': 'hsl(0 0% 98%)',
-        border: 'oklch(0.9197 0.0040 286.3202)',
-        input: 'oklch(0.9197 0.0040 286.3202)',
-        ring: 'oklch(0.7613 0.1503 231.1314)',
-        'chart-1': 'oklch(0.7613 0.1503 231.1314)',
-        'chart-2': 'oklch(0.5575 0.2525 302.3212)',
-        'chart-3': 'oklch(0.5858 0.2220 17.5846)',
-        'chart-4': 'oklch(0.6658 0.1574 58.3183)',
-        'chart-5': 'oklch(0.6271 0.1699 149.2138)',
-        radius: '0.375rem',
-        sidebar: 'oklch(0.9674 0.0013 286.3752)',
-        'sidebar-foreground': 'oklch(0.2103 0.0059 285.8852)',
-        'sidebar-primary': 'oklch(0.7613 0.1503 231.1314)',
-        'sidebar-primary-foreground': 'oklch(0.1408 0.0044 285.8229)',
-        'sidebar-accent': 'oklch(1.0000 0 0)',
-        'sidebar-accent-foreground': 'oklch(0.2103 0.0059 285.8852)',
-        'sidebar-border': 'oklch(0.9197 0.0040 286.3202)',
-        'sidebar-ring': 'oklch(0.7613 0.1503 231.1314)',
-        brand: '#17c1ff',
-        'brand-lighter': '#e6f9ff',
-        'brand-darker': '#0099ff',
-        'font-sans': 'Inter, sans-serif',
-        'font-mono': 'Geist Mono, monospace',
-    },
-    dark: {
-        background: 'oklch(0.1408 0.0044 285.8229)',
-        foreground: 'oklch(0.9851 0 0)',
-        card: 'oklch(0.2103 0.0059 285.8852)',
-        'card-foreground': 'oklch(0.9851 0 0)',
-        popover: 'oklch(0.2103 0.0059 285.8852)',
-        'popover-foreground': 'oklch(0.9851 0 0)',
-        primary: 'oklch(0.7613 0.1503 231.1314)',
-        'primary-foreground': 'oklch(0.1408 0.0044 285.8229)',
-        secondary: 'oklch(0.2739 0.0055 286.0326)',
-        'secondary-foreground': 'oklch(0.9851 0 0)',
-        muted: 'oklch(0.2739 0.0055 286.0326)',
-        'muted-foreground': 'oklch(0.7118 0.0129 286.0665)',
-        accent: 'oklch(0.2739 0.0055 286.0326)',
-        'accent-foreground': 'oklch(0.9851 0 0)',
-        destructive: 'oklch(0.6368 0.2078 25.3313)',
-        'destructive-foreground': 'oklch(0.9851 0 0)',
-        success: 'hsl(100, 100%, 35%)',
-        'success-foreground': 'hsl(0 0% 98%)',
-        'dev-mode': 'hsl(204, 86%, 53%)',
-        'dev-mode-foreground': 'hsl(0 0% 98%)',
-        border: 'oklch(0.2739 0.0055 286.0326)',
-        input: 'oklch(0.2739 0.0055 286.0326)',
-        ring: 'oklch(0.7613 0.1503 231.1314)',
-        'chart-1': 'oklch(0.7613 0.1503 231.1314)',
-        'chart-2': 'oklch(0.6268 0.2325 303.9004)',
-        'chart-3': 'oklch(0.6450 0.2154 16.4393)',
-        'chart-4': 'oklch(0.7686 0.1647 70.0804)',
-        'chart-5': 'oklch(0.7227 0.1920 149.5793)',
-        sidebar: 'oklch(0.1408 0.0044 285.8229)',
-        'sidebar-foreground': 'oklch(0.9851 0 0)',
-        'sidebar-primary': 'oklch(0.7613 0.1503 231.1314)',
-        'sidebar-primary-foreground': 'oklch(0.1408 0.0044 285.8229)',
-        'sidebar-accent': 'oklch(0.2739 0.0055 286.0326)',
-        'sidebar-accent-foreground': 'oklch(0.9851 0 0)',
-        'sidebar-border': 'oklch(0.2739 0.0055 286.0326)',
-        'sidebar-ring': 'oklch(0.7613 0.1503 231.1314)',
-        brand: '#17c1ff',
-        'brand-lighter': '#e6f9ff',
-        'brand-darker': '#0099ff',
-        'font-sans': 'Inter, sans-serif',
-        'font-mono': 'Geist Mono, monospace',
-    },
-};
-
-export type ThemeVariablesPluginOptions = {
-    theme?: ThemeVariables;
-};
-
-export function themeVariablesPlugin(options: ThemeVariablesPluginOptions): Plugin {
-    const virtualModuleId = 'virtual:admin-theme';
-    const resolvedVirtualModuleId = `\0${virtualModuleId}`;
-
-    return {
-        name: 'vendure:admin-theme',
-        enforce: 'pre', // This ensures our plugin runs before other CSS processors
-        transform(code, id) {
-            // Only transform CSS files
-            if (!id.endsWith('styles.css')) {
-                return null;
-            }
-
-            // Replace the @import 'virtual:admin-theme'; with our theme variables
-            if (
-                code.includes('@import "virtual:admin-theme";') ||
-                code.includes("@import 'virtual:admin-theme';")
-            ) {
-                const lightTheme = options.theme?.light || {};
-                const darkTheme = options.theme?.dark || {};
-
-                // Merge default themes with custom themes
-                const mergedLightTheme = { ...defaultVariables.light, ...lightTheme };
-                const mergedDarkTheme = { ...defaultVariables.dark, ...darkTheme };
-
-                const themeCSS = `
-                    :root {
-                        ${Object.entries(mergedLightTheme)
-                            .filter(([key, value]) => value !== undefined)
-                            .map(([key, value]) => `--${key}: ${value as string};`)
-                            .join('\n')}
-                    }
-
-                    .dark {
-                        ${Object.entries(mergedDarkTheme)
-                            .filter(([key, value]) => value !== undefined)
-                            .map(([key, value]) => `--${key}: ${value as string};`)
-                            .join('\n')}
-                    }
-                `;
-
-                return code.replace(/@import ['"]virtual:admin-theme['"];?/, themeCSS);
-            }
-
-            return null;
-        },
-    };
-}

package/vite/vite-plugin-transform-index.ts

@@ -1,40 +0,0 @@
-import { Plugin, ResolvedConfig } from 'vite';
-
-/**
- * @description
- * This Vite plugin handles the scenario where the `base` path is set in the Vite config.
- * The default Vite behavior is to prepend the `base` path to all `href` and `src` attributes in the HTML,
- * but this causes the Vendure Dashboard not to load its assets correctly.
- *
- * This plugin removes the `base` path from all `href` and `src` attributes in the HTML,
- * and adds a `<base>` tag to the `<head>` of the HTML document.
- */
-export function transformIndexHtmlPlugin(): Plugin {
-    let config: ResolvedConfig;
-    return {
-        name: 'vendure:vite-config-transform-index-html',
-        configResolved(resolvedConfig) {
-            // store the resolved config
-            config = resolvedConfig;
-        },
-        // Only apply this plugin during the build phase
-        apply: 'build',
-        transformIndexHtml(html) {
-            if (config.base && config.base !== '/') {
-                // Remove the base path from hrefs and srcs
-                const basePath = config.base.replace(/\/$/, ''); // Remove trailing slash
-
-                // Single regex to handle both href and src attributes with any quote type
-                const attributeRegex = new RegExp(`(href|src)=(["'])${basePath}/?`, 'g');
-                let transformedHtml = html.replace(attributeRegex, '$1=$2');
-
-                // Add base tag to head
-                const baseTag = `        <base href="${config.base}">\n`;
-                transformedHtml = transformedHtml.replace(/<head>/, `<head>\n${baseTag}`);
-
-                return transformedHtml;
-            }
-            return html;
-        },
-    };
-}

package/vite/vite-plugin-ui-config.ts

@@ -1,163 +0,0 @@
-import { LanguageCode, VendureConfig } from '@vendure/core';
-import { Plugin } from 'vite';
-
-import { getUiConfig } from './utils/ui-config.js';
-import { ConfigLoaderApi, getConfigLoaderApi } from './vite-plugin-config-loader.js';
-
-const virtualModuleId = 'virtual:vendure-ui-config';
-const resolvedVirtualModuleId = `\0${virtualModuleId}`;
-
-export interface ApiConfig {
-    /**
-     * @description
-     * The hostname of the Vendure server which the admin UI will be making API calls
-     * to. If set to "auto", the Admin UI app will determine the hostname from the
-     * current location (i.e. `window.location.hostname`).
-     *
-     * @default 'auto'
-     */
-    host?: string | 'auto';
-    /**
-     * @description
-     * The port of the Vendure server which the admin UI will be making API calls
-     * to. If set to "auto", the Admin UI app will determine the port from the
-     * current location (i.e. `window.location.port`).
-     *
-     * @default 'auto'
-     */
-    port?: number | 'auto';
-    /**
-     * @description
-     * The path to the GraphQL Admin API.
-     *
-     * @default 'admin-api'
-     */
-    adminApiPath?: string;
-    /**
-     * @description
-     * Whether to use cookies or bearer tokens to track sessions.
-     * Should match the setting of in the server's `tokenMethod` config
-     * option.
-     *
-     * @default 'cookie'
-     */
-    tokenMethod?: 'cookie' | 'bearer';
-    /**
-     * @description
-     * The header used when using the 'bearer' auth method. Should match the
-     * setting of the server's `authOptions.authTokenHeaderKey` config option.
-     *
-     * @default 'vendure-auth-token'
-     */
-    authTokenHeaderKey?: string;
-    /**
-     * @description
-     * The name of the header which contains the channel token. Should match the
-     * setting of the server's `apiOptions.channelTokenKey` config option.
-     *
-     * @default 'vendure-token'
-     */
-    channelTokenKey?: string;
-}
-
-export interface I18nConfig {
-    /**
-     * @description
-     * The default language for the Admin UI. Must be one of the
-     * items specified in the `availableLanguages` property.
-     *
-     * @default LanguageCode.en
-     */
-    defaultLanguage?: LanguageCode;
-    /**
-     * @description
-     * The default locale for the Admin UI. The locale affects the formatting of
-     * currencies & dates. Must be one of the items specified
-     * in the `availableLocales` property.
-     *
-     * If not set, the browser default locale will be used.
-     *
-     * @since 2.2.0
-     */
-    defaultLocale?: string;
-    /**
-     * @description
-     * An array of languages for which translations exist for the Admin UI.
-     */
-    availableLanguages?: LanguageCode[];
-    /**
-     * @description
-     * An array of locales to be used on Admin UI.
-     *
-     * @since 2.2.0
-     */
-    availableLocales?: string[];
-}
-
-export interface UiConfigPluginOptions {
-    /**
-     * @description
-     * Configuration for API connection settings
-     */
-    api?: ApiConfig;
-    /**
-     * @description
-     * Configuration for internationalization settings
-     */
-    i18n?: I18nConfig;
-}
-
-/**
- * @description
- * The resolved UI configuration with all defaults applied.
- * This is the type of the configuration object available at runtime.
- */
-export interface ResolvedUiConfig {
-    /**
-     * @description
-     * API connection settings with all defaults applied
-     */
-    api: Required<ApiConfig>;
-    /**
-     * @description
-     * Internationalization settings with all defaults applied.
-     * Note: defaultLocale remains optional as it can be undefined.
-     */
-    i18n: Required<Omit<I18nConfig, 'defaultLocale'>> & Pick<I18nConfig, 'defaultLocale'>;
-}
-
-/**
- * This Vite plugin scans the configured plugins for any dashboard extensions and dynamically
- * generates an import statement for each one, wrapped up in a `runDashboardExtensions()`
- * function which can then be imported and executed in the Dashboard app.
- */
-export function uiConfigPlugin(options: UiConfigPluginOptions = {}): Plugin {
-    let configLoaderApi: ConfigLoaderApi;
-    let vendureConfig: VendureConfig;
-
-    return {
-        name: 'vendure:dashboard-ui-config',
-        configResolved({ plugins }) {
-            configLoaderApi = getConfigLoaderApi(plugins);
-        },
-        resolveId(id) {
-            if (id === virtualModuleId) {
-                return resolvedVirtualModuleId;
-            }
-        },
-        async load(id) {
-            if (id === resolvedVirtualModuleId) {
-                if (!vendureConfig) {
-                    const result = await configLoaderApi.getVendureConfig();
-                    vendureConfig = result.vendureConfig;
-                }
-
-                const config = getUiConfig(vendureConfig, options);
-
-                return `
-                    export const uiConfig = ${JSON.stringify(config)}
-                `;
-            }
-        },
-    };
-}

package/vite/vite-plugin-vendure-dashboard.ts

@@ -1,174 +0,0 @@
-import tailwindcss from '@tailwindcss/vite';
-import { TanStackRouterVite } from '@tanstack/router-plugin/vite';
-import react from '@vitejs/plugin-react';
-import path from 'path';
-import { PluginOption } from 'vite';
-
-import { PathAdapter } from './types.js';
-import { PackageScannerConfig } from './utils/compiler.js';
-import { adminApiSchemaPlugin } from './vite-plugin-admin-api-schema.js';
-import { configLoaderPlugin } from './vite-plugin-config-loader.js';
-import { viteConfigPlugin } from './vite-plugin-config.js';
-import { dashboardMetadataPlugin } from './vite-plugin-dashboard-metadata.js';
-import { gqlTadaPlugin } from './vite-plugin-gql-tada.js';
-import { dashboardTailwindSourcePlugin } from './vite-plugin-tailwind-source.js';
-import { themeVariablesPlugin, ThemeVariablesPluginOptions } from './vite-plugin-theme.js';
-import { transformIndexHtmlPlugin } from './vite-plugin-transform-index.js';
-import { uiConfigPlugin, UiConfigPluginOptions } from './vite-plugin-ui-config.js';
-
-/**
- * @description
- * Options for the {@link vendureDashboardPlugin} Vite plugin.
- */
-export 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;
-    tempCompilationDir?: string;
-    disableTansStackRouterPlugin?: boolean;
-    /**
-     * @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;
-} & UiConfigPluginOptions &
-    ThemeVariablesPluginOptions;
-
-/**
- * @description
- * This is a Vite plugin which configures a set of plugins required to build the Vendure Dashboard.
- */
-export function vendureDashboardPlugin(options: VitePluginVendureDashboardOptions): PluginOption[] {
-    const tempDir = options.tempCompilationDir ?? path.join(import.meta.dirname, './.vendure-dashboard-temp');
-    const normalizedVendureConfigPath = getNormalizedVendureConfigPath(options.vendureConfigPath);
-    const packageRoot = getDashboardPackageRoot();
-    const linguiConfigPath = path.join(packageRoot, 'lingui.config.js');
-
-    if (process.env.IS_LOCAL_DEV !== 'true') {
-        process.env.LINGUI_CONFIG = linguiConfigPath;
-    }
-
-    return [
-        // TODO: solve https://github.com/kentcdodds/babel-plugin-macros/issues/87
-        // lingui(),
-        ...(options.disableTansStackRouterPlugin
-            ? []
-            : [
-                  TanStackRouterVite({
-                      autoCodeSplitting: true,
-                      routeFileIgnorePattern: '.graphql.ts|components|hooks|utils',
-                      routesDirectory: path.join(packageRoot, 'src/app/routes'),
-                      generatedRouteTree: path.join(packageRoot, 'src/app/routeTree.gen.ts'),
-                  }),
-              ]),
-        react({
-            // babel: {
-            //     plugins: ['@lingui/babel-plugin-lingui-macro'],
-            // },
-        }),
-        themeVariablesPlugin({ theme: options.theme }),
-        dashboardTailwindSourcePlugin(),
-        tailwindcss(),
-        configLoaderPlugin({
-            vendureConfigPath: normalizedVendureConfigPath,
-            outputPath: tempDir,
-            pathAdapter: options.pathAdapter,
-            pluginPackageScanner: options.pluginPackageScanner,
-        }),
-        viteConfigPlugin({ packageRoot }),
-        adminApiSchemaPlugin(),
-        dashboardMetadataPlugin(),
-        uiConfigPlugin(options),
-        ...(options.gqlOutputPath
-            ? [gqlTadaPlugin({ gqlTadaOutputPath: options.gqlOutputPath, tempDir, packageRoot })]
-            : []),
-        transformIndexHtmlPlugin(),
-    ];
-}
-
-/**
- * @description
- * Returns the path to the root of the `@vendure/dashboard` package.
- */
-function getDashboardPackageRoot(): string {
-    const fileUrl = import.meta.resolve('@vendure/dashboard');
-    const packagePath = fileUrl.startsWith('file:') ? new URL(fileUrl).pathname : fileUrl;
-    return fixWindowsPath(path.join(packagePath, '../../../'));
-}
-
-/**
- * Get the normalized path to the Vendure config file given either a string or URL.
- */
-export function getNormalizedVendureConfigPath(vendureConfigPath: string | URL): string {
-    const stringPath = typeof vendureConfigPath === 'string' ? vendureConfigPath : vendureConfigPath.href;
-    if (stringPath.startsWith('file:')) {
-        return fixWindowsPath(new URL(stringPath).pathname);
-    }
-    return fixWindowsPath(stringPath);
-}
-
-function fixWindowsPath(filePath: string): string {
-    // Fix Windows paths that might start with a leading slash
-    if (process.platform === 'win32') {
-        // Remove leading slash before drive letter on Windows
-        if (/^[/\\][A-Za-z]:/.test(filePath)) {
-            return filePath.substring(1);
-        }
-    }
-    return filePath;
-}