@vendure/dashboard 3.3.6-master-202507120238 → 3.3.6

package/dist/plugin/utils/plugin-discovery.js

@@ -0,0 +1,343 @@
+import { parse } from 'acorn';
+import { simple as walkSimple } from 'acorn-walk';
+import glob from 'fast-glob';
+import fs from 'fs-extra';
+import { open } from 'fs/promises';
+import path from 'path';
+import * as ts from 'typescript';
+import { fileURLToPath } from 'url';
+import { findTsConfigPaths } from './tsconfig-utils.js';
+export async function discoverPlugins({ vendureConfigPath, transformTsConfigPathMappings, logger, outputPath, pluginPackageScanner, }) {
+    const plugins = [];
+    // Analyze source files to find local plugins and package imports
+    const { localPluginLocations, packageImports } = await analyzeSourceFiles(vendureConfigPath, logger, transformTsConfigPathMappings);
+    logger.debug(`[discoverPlugins] Found ${localPluginLocations.size} local plugins: ${JSON.stringify([...localPluginLocations.entries()], null, 2)}`);
+    logger.debug(`[discoverPlugins] Found ${packageImports.length} package imports: ${JSON.stringify(packageImports, null, 2)}`);
+    const filePaths = await findVendurePluginFiles({
+        logger,
+        nodeModulesRoot: pluginPackageScanner === null || pluginPackageScanner === void 0 ? void 0 : pluginPackageScanner.nodeModulesRoot,
+        packageGlobs: packageImports.map(pkg => pkg + '/**/*.js'),
+        outputPath,
+        vendureConfigPath,
+    });
+    for (const filePath of filePaths) {
+        const content = await fs.readFile(filePath, 'utf-8');
+        logger.debug(`[discoverPlugins] Checking file ${filePath}`);
+        // First check if this file imports from @vendure/core
+        if (!content.includes('@vendure/core')) {
+            continue;
+        }
+        try {
+            const ast = parse(content, {
+                ecmaVersion: 'latest',
+                sourceType: 'module',
+            });
+            let hasVendurePlugin = false;
+            let pluginName;
+            let dashboardPath;
+            // Walk the AST to find the plugin class and its decorator
+            walkSimple(ast, {
+                CallExpression(node) {
+                    // Look for __decorate calls
+                    const calleeName = node.callee.name;
+                    const nodeArgs = node.arguments;
+                    const isDecoratorWithArgs = calleeName === '__decorate' && nodeArgs.length >= 2;
+                    if (isDecoratorWithArgs) {
+                        // Check the decorators array (first argument)
+                        const decorators = nodeArgs[0];
+                        if (decorators.type === 'ArrayExpression') {
+                            for (const decorator of decorators.elements) {
+                                const props = getDecoratorObjectProps(decorator);
+                                for (const prop of props) {
+                                    const isDashboardProd = prop.key.name === 'dashboard' && prop.value.type === 'Literal';
+                                    if (isDashboardProd) {
+                                        dashboardPath = prop.value.value;
+                                        hasVendurePlugin = true;
+                                    }
+                                }
+                            }
+                        }
+                        // Get the plugin class name (second argument)
+                        const targetClass = nodeArgs[1];
+                        if (targetClass.type === 'Identifier') {
+                            pluginName = targetClass.name;
+                        }
+                    }
+                },
+            });
+            if (hasVendurePlugin && pluginName && dashboardPath) {
+                logger.debug(`[discoverPlugins] Found plugin "${pluginName}" in file: ${filePath}`);
+                // Keep the dashboard path relative to the plugin file
+                const resolvedDashboardPath = dashboardPath.startsWith('.')
+                    ? dashboardPath // Keep the relative path as-is
+                    : './' + path.relative(path.dirname(filePath), dashboardPath); // Make absolute path relative
+                // Check if this is a local plugin we found earlier
+                const sourcePluginPath = localPluginLocations.get(pluginName);
+                plugins.push(Object.assign({ name: pluginName, pluginPath: filePath, dashboardEntryPath: resolvedDashboardPath }, (sourcePluginPath && { sourcePluginPath })));
+            }
+        }
+        catch (e) {
+            logger.error(`Failed to parse ${filePath}: ${e instanceof Error ? e.message : String(e)}`);
+        }
+    }
+    return plugins;
+}
+function getDecoratorObjectProps(decorator) {
+    var _a;
+    if (decorator.type === 'CallExpression' &&
+        decorator.arguments.length === 1 &&
+        decorator.arguments[0].type === 'ObjectExpression') {
+        // Look for the dashboard property in the decorator config
+        return (_a = decorator.arguments[0].properties) !== null && _a !== void 0 ? _a : [];
+    }
+    return [];
+}
+/**
+ * Analyzes TypeScript source files starting from the config file to discover:
+ * 1. Local Vendure plugins
+ * 2. All non-local package imports that could contain plugins
+ */
+export async function analyzeSourceFiles(vendureConfigPath, logger, transformTsConfigPathMappings) {
+    const localPluginLocations = new Map();
+    const visitedFiles = new Set();
+    const packageImportsSet = new Set();
+    // Get tsconfig paths for resolving aliases
+    const tsConfigInfo = await findTsConfigPaths(vendureConfigPath, logger, 'compiling', transformTsConfigPathMappings);
+    async function processFile(filePath) {
+        if (visitedFiles.has(filePath)) {
+            return;
+        }
+        visitedFiles.add(filePath);
+        try {
+            // First check if this is a directory
+            const stat = await fs.stat(filePath);
+            if (stat.isDirectory()) {
+                // If it's a directory, try to find the plugin file
+                const indexFilePath = path.join(filePath, 'index.ts');
+                if (await fs.pathExists(indexFilePath)) {
+                    await processFile(indexFilePath);
+                }
+                return;
+            }
+            const content = await fs.readFile(filePath, 'utf-8');
+            const sourceFile = ts.createSourceFile(filePath, content, ts.ScriptTarget.Latest, true);
+            // Track imports to follow
+            const importsToFollow = [];
+            function visit(node) {
+                // Look for VendurePlugin decorator
+                const vendurePluginClassName = getVendurePluginClassName(node);
+                if (vendurePluginClassName) {
+                    localPluginLocations.set(vendurePluginClassName, filePath);
+                    logger.debug(`Found plugin "${vendurePluginClassName}" at ${filePath}`);
+                }
+                // Handle both imports and exports
+                const isImportOrExport = ts.isImportDeclaration(node) || ts.isExportDeclaration(node);
+                if (isImportOrExport) {
+                    const moduleSpecifier = node.moduleSpecifier;
+                    if (moduleSpecifier && ts.isStringLiteral(moduleSpecifier)) {
+                        const importPath = moduleSpecifier.text;
+                        // Track non-local imports (packages)
+                        const npmPackageName = getNpmPackageNameFromImport(importPath);
+                        if (npmPackageName) {
+                            packageImportsSet.add(npmPackageName);
+                        }
+                        // Handle path aliases and local imports
+                        const pathAliasImports = getPotentialPathAliasImportPaths(importPath, tsConfigInfo);
+                        if (pathAliasImports.length) {
+                            importsToFollow.push(...pathAliasImports);
+                        }
+                        // Also handle local imports
+                        if (importPath.startsWith('.')) {
+                            const resolvedPath = path.resolve(path.dirname(filePath), importPath);
+                            importsToFollow.push(resolvedPath);
+                        }
+                    }
+                }
+                ts.forEachChild(node, visit);
+            }
+            visit(sourceFile);
+            // Follow imports
+            for (const importPath of importsToFollow) {
+                // Try all possible file paths
+                const possiblePaths = [
+                    importPath + '.ts',
+                    importPath + '.js',
+                    path.join(importPath, 'index.ts'),
+                    path.join(importPath, 'index.js'),
+                ];
+                // Try each possible path
+                let found = false;
+                for (const possiblePath of possiblePaths) {
+                    const possiblePathExists = await fs.pathExists(possiblePath);
+                    if (possiblePathExists) {
+                        await processFile(possiblePath);
+                        found = true;
+                        break;
+                    }
+                }
+                // If none of the file paths worked, try the raw import path
+                // (it might be a directory)
+                const tryRawPath = !found && (await fs.pathExists(importPath));
+                if (tryRawPath) {
+                    await processFile(importPath);
+                }
+            }
+        }
+        catch (e) {
+            const message = e instanceof Error ? e.message : String(e);
+            logger.error(`Failed to process ${filePath}: ${message}`);
+        }
+    }
+    await processFile(vendureConfigPath);
+    return {
+        localPluginLocations,
+        packageImports: Array.from(packageImportsSet),
+    };
+}
+/**
+ * If this is a class declaration that is decorated with the `VendurePlugin` decorator,
+ * we want to return that class name, as we have found a local Vendure plugin.
+ */
+function getVendurePluginClassName(node) {
+    var _a;
+    if (ts.isClassDeclaration(node)) {
+        const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined;
+        if (decorators === null || decorators === void 0 ? void 0 : decorators.length) {
+            for (const decorator of decorators) {
+                const decoratorName = getDecoratorName(decorator);
+                if (decoratorName === 'VendurePlugin') {
+                    const className = (_a = node.name) === null || _a === void 0 ? void 0 : _a.text;
+                    if (className) {
+                        return className;
+                    }
+                }
+            }
+        }
+    }
+}
+function getNpmPackageNameFromImport(importPath) {
+    if (!importPath.startsWith('.') && !importPath.startsWith('/')) {
+        // Get the root package name (e.g. '@scope/package/subpath' -> '@scope/package')
+        const packageName = importPath.startsWith('@')
+            ? importPath.split('/').slice(0, 2).join('/')
+            : importPath.split('/')[0];
+        return packageName;
+    }
+}
+function getPotentialPathAliasImportPaths(importPath, tsConfigInfo) {
+    const importsToFollow = [];
+    if (!tsConfigInfo) {
+        return importsToFollow;
+    }
+    for (const [alias, patterns] of Object.entries(tsConfigInfo.paths)) {
+        const aliasPattern = alias.replace(/\*$/, '');
+        if (importPath.startsWith(aliasPattern)) {
+            const relativePart = importPath.slice(aliasPattern.length);
+            // Try each pattern
+            for (const pattern of patterns) {
+                const resolvedPattern = pattern.replace(/\*$/, '');
+                const resolvedPath = path.resolve(tsConfigInfo.baseUrl, resolvedPattern, relativePart);
+                importsToFollow.push(resolvedPath);
+            }
+        }
+    }
+    return importsToFollow;
+}
+function getDecoratorName(decorator) {
+    if (ts.isCallExpression(decorator.expression)) {
+        const expression = decorator.expression.expression;
+        // Handle both direct usage and imported usage
+        if (ts.isIdentifier(expression)) {
+            return expression.text;
+        }
+        // Handle property access like `Decorators.VendurePlugin`
+        if (ts.isPropertyAccessExpression(expression)) {
+            return expression.name.text;
+        }
+    }
+    return undefined;
+}
+export async function findVendurePluginFiles({ outputPath, vendureConfigPath, logger, nodeModulesRoot: providedNodeModulesRoot, packageGlobs, }) {
+    let nodeModulesRoot = providedNodeModulesRoot;
+    const readStart = Date.now();
+    if (!nodeModulesRoot) {
+        // If the node_modules root path has not been explicitly
+        // specified, we will try to guess it by resolving the
+        // `@vendure/core` package.
+        try {
+            const coreUrl = import.meta.resolve('@vendure/core');
+            logger.debug(`Found core URL: ${coreUrl}`);
+            const corePath = fileURLToPath(coreUrl);
+            logger.debug(`Found core path: ${corePath}`);
+            nodeModulesRoot = path.join(path.dirname(corePath), '..', '..');
+        }
+        catch (e) {
+            logger.warn(`Failed to resolve @vendure/core: ${e instanceof Error ? e.message : String(e)}`);
+            nodeModulesRoot = path.dirname(vendureConfigPath);
+        }
+    }
+    const patterns = [
+        // Local compiled plugins in temp dir
+        path.join(outputPath, '**/*.js'),
+        // Node modules patterns
+        ...packageGlobs.map(pattern => path.join(nodeModulesRoot, pattern)),
+    ];
+    logger.debug(`Finding Vendure plugins using patterns: ${patterns.join('\n')}`);
+    const globStart = Date.now();
+    const files = await glob(patterns, {
+        ignore: [
+            // Standard test & doc files
+            '**/node_modules/**/node_modules/**',
+            '**/*.spec.js',
+            '**/*.test.js',
+        ],
+        onlyFiles: true,
+        absolute: true,
+        followSymbolicLinks: false,
+        stats: false,
+    });
+    logger.debug(`Glob found ${files.length} files in ${Date.now() - globStart}ms`);
+    // Read files in larger parallel batches
+    const batchSize = 100; // Increased batch size
+    const potentialPluginFiles = [];
+    for (let i = 0; i < files.length; i += batchSize) {
+        const batch = files.slice(i, i + batchSize);
+        const results = await Promise.all(batch.map(async (file) => {
+            try {
+                // Try reading just first 3000 bytes first - most imports are at the top
+                const fileHandle = await open(file, 'r');
+                try {
+                    const buffer = Buffer.alloc(3000);
+                    const { bytesRead } = await fileHandle.read(buffer, 0, 3000, 0);
+                    let content = buffer.toString('utf8', 0, bytesRead);
+                    // Quick check for common indicators
+                    if (content.includes('@vendure/core')) {
+                        return file;
+                    }
+                    // If we find a promising indicator but no definitive match,
+                    // read more of the file
+                    if (content.includes('@vendure') || content.includes('VendurePlugin')) {
+                        const largerBuffer = Buffer.alloc(5000);
+                        const { bytesRead: moreBytes } = await fileHandle.read(largerBuffer, 0, 5000, 0);
+                        content = largerBuffer.toString('utf8', 0, moreBytes);
+                        if (content.includes('@vendure/core')) {
+                            return file;
+                        }
+                    }
+                }
+                finally {
+                    await fileHandle.close();
+                }
+            }
+            catch (e) {
+                logger.warn(`Failed to read file ${file}: ${e instanceof Error ? e.message : String(e)}`);
+            }
+            return null;
+        }));
+        const validResults = results.filter((f) => f !== null);
+        potentialPluginFiles.push(...validResults);
+    }
+    logger.info(`Found ${potentialPluginFiles.length} potential plugin files in ${Date.now() - readStart}ms ` +
+        `(scanned ${files.length} files)`);
+    return potentialPluginFiles;
+}

package/dist/plugin/utils/tsconfig-utils.d.ts

@@ -0,0 +1,9 @@
+import { Logger, TransformTsConfigPathMappingsFn } from '../types.js';
+export interface TsConfigPathsConfig {
+    baseUrl: string;
+    paths: Record<string, string[]>;
+}
+/**
+ * Finds and parses tsconfig files in the given directory and its parent directories.
+ */
+export declare function findTsConfigPaths(configPath: string, logger: Logger, phase: 'compiling' | 'loading', transformTsConfigPathMappings: TransformTsConfigPathMappingsFn): Promise<TsConfigPathsConfig | undefined>;

package/dist/plugin/utils/tsconfig-utils.js

@@ -0,0 +1,50 @@
+import fs from 'fs-extra';
+import path from 'path';
+/**
+ * Finds and parses tsconfig files in the given directory and its parent directories.
+ */
+export async function findTsConfigPaths(configPath, logger, phase, transformTsConfigPathMappings) {
+    let currentDir = path.dirname(configPath);
+    while (currentDir !== path.parse(currentDir).root) {
+        try {
+            const files = await fs.readdir(currentDir);
+            const tsConfigFiles = files.filter(file => /^tsconfig(\..*)?\.json$/.test(file));
+            for (const fileName of tsConfigFiles) {
+                const tsConfigFilePath = path.join(currentDir, fileName);
+                try {
+                    const { paths, baseUrl } = await getCompilerOptionsFromFile(tsConfigFilePath);
+                    if (paths) {
+                        const tsConfigBaseUrl = path.resolve(currentDir, baseUrl || '.');
+                        const pathMappings = getTransformedPathMappings(paths, phase, transformTsConfigPathMappings);
+                        return { baseUrl: tsConfigBaseUrl, paths: pathMappings };
+                    }
+                }
+                catch (e) {
+                    logger.warn(`Could not read or parse tsconfig file ${tsConfigFilePath}: ${e instanceof Error ? e.message : String(e)}`);
+                }
+            }
+        }
+        catch (e) {
+            logger.warn(`Could not read directory ${currentDir}: ${e instanceof Error ? e.message : String(e)}`);
+        }
+        currentDir = path.dirname(currentDir);
+    }
+    return undefined;
+}
+async function getCompilerOptionsFromFile(tsConfigFilePath) {
+    const tsConfigContent = await fs.readFile(tsConfigFilePath, 'utf-8');
+    const tsConfig = JSON.parse(tsConfigContent);
+    return tsConfig.compilerOptions || {};
+}
+function getTransformedPathMappings(paths, phase, transformTsConfigPathMappings) {
+    const pathMappings = {};
+    for (const [alias, patterns] of Object.entries(paths)) {
+        const normalizedPatterns = patterns.map(pattern => pattern.replace(/\\/g, '/'));
+        pathMappings[alias] = transformTsConfigPathMappings({
+            phase,
+            alias,
+            patterns: normalizedPatterns,
+        });
+    }
+    return pathMappings;
+}

package/dist/plugin/vite-plugin-config-loader.d.ts

@@ -1,14 +1,14 @@
 import { Plugin } from 'vite';
-import { ConfigLoaderOptions, LoadVendureConfigResult } from './utils/config-loader.js';
+import { CompileResult, CompilerOptions } from './utils/compiler.js';
 export interface ConfigLoaderApi {
-    getVendureConfig(): Promise<LoadVendureConfigResult>;
+    getVendureConfig(): Promise<CompileResult>;
 }
 export declare const configLoaderName = "vendure:config-loader";
 /**
  * This Vite plugin loads the VendureConfig from the specified file path, and
  * makes it available to other plugins via the `ConfigLoaderApi`.
  */
-export declare function configLoaderPlugin(options: ConfigLoaderOptions): Plugin;
+export declare function configLoaderPlugin(options: CompilerOptions): Plugin;
 /**
  * Inter-plugin dependencies implemented following the pattern given here:
  * https://rollupjs.org/plugin-development/#direct-plugin-communication

package/dist/plugin/vite-plugin-config-loader.js

@@ -1,4 +1,5 @@
-import { loadVendureConfig } from './utils/config-loader.js';
+import { compile } from './utils/compiler.js';
+import { debugLogger } from './utils/logger.js';
 export const configLoaderName = 'vendure:config-loader';
 /**
  * This Vite plugin loads the VendureConfig from the specified file path, and
@@ -13,20 +14,19 @@ export function configLoaderPlugin(options) {
             this.info(`Loading Vendure config. This can take a short while depending on the size of your project...`);
             try {
                 const startTime = Date.now();
-                result = await loadVendureConfig({
-                    pathAdapter: options.pathAdapter,
-                    tempDir: options.tempDir,
-                    vendureConfigPath: options.vendureConfigPath,
-                    vendureConfigExport: options.vendureConfigExport,
-                    logger: {
-                        info: (message) => this.info(message),
-                        warn: (message) => this.warn(message),
-                        debug: (message) => this.debug(message),
-                    },
-                });
+                result = await compile(Object.assign(Object.assign({}, options), { logger: process.env.LOG
+                        ? debugLogger
+                        : {
+                            info: (message) => this.info(message),
+                            warn: (message) => this.warn(message),
+                            debug: (message) => this.debug(message),
+                            error: (message) => this.error(message),
+                        } }));
                 const endTime = Date.now();
                 const duration = endTime - startTime;
-                const pluginNames = result.pluginInfo.map(p => p.name).join(', ');
+                const pluginNames = result.pluginInfo
+                    .map(p => `${p.name} ${p.sourcePluginPath ? '(local)' : '(npm)'}`)
+                    .join(', ');
                 this.info(`Found ${result.pluginInfo.length} plugins: ${pluginNames}`);
                 this.info(`Vendure config loaded (using export "${result.exportedSymbolName}") in ${duration}ms`);
             }

package/dist/plugin/vite-plugin-dashboard-metadata.js

@@ -23,12 +23,29 @@ export function dashboardMetadataPlugin() {
         async load(id) {
             var _a;
             if (id === resolvedVirtualModuleId) {
+                const startTime = Date.now();
+                this.debug('Loading dashboard extensions...');
                 if (!loadVendureConfigResult) {
+                    const configStart = Date.now();
                     loadVendureConfigResult = await configLoaderApi.getVendureConfig();
+                    this.debug(`Loaded Vendure config in ${Date.now() - configStart}ms`);
                 }
                 const { pluginInfo } = loadVendureConfigResult;
-                const pluginsWithExtensions = (_a = pluginInfo === null || pluginInfo === void 0 ? void 0 : pluginInfo.map(({ dashboardEntryPath, pluginPath }) => dashboardEntryPath && path.join(pluginPath, dashboardEntryPath)).filter(x => x != null)) !== null && _a !== void 0 ? _a : [];
-                this.info(`Found ${pluginsWithExtensions.length} Dashboard extensions`);
+                const resolveStart = Date.now();
+                const pluginsWithExtensions = (_a = pluginInfo === null || pluginInfo === void 0 ? void 0 : pluginInfo.map(({ dashboardEntryPath, pluginPath, sourcePluginPath }) => {
+                    if (!dashboardEntryPath) {
+                        return null;
+                    }
+                    // For local plugins, use the sourcePluginPath to resolve the dashboard extension
+                    const basePath = sourcePluginPath
+                        ? path.dirname(sourcePluginPath)
+                        : path.dirname(pluginPath);
+                    const resolved = path.resolve(basePath, dashboardEntryPath);
+                    this.debug(`Resolved extension path: ${resolved}`);
+                    return resolved;
+                }).filter(x => x != null)) !== null && _a !== void 0 ? _a : [];
+                this.info(`Found ${pluginsWithExtensions.length} Dashboard extensions in ${Date.now() - resolveStart}ms`);
+                this.debug(`Total dashboard extension loading completed in ${Date.now() - startTime}ms`);
                 return `
                     export async function runDashboardExtensions() {
                         ${pluginsWithExtensions

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

@@ -1,5 +1,6 @@
 import { PluginOption } from 'vite';
-import { PathAdapter } from './utils/config-loader.js';
+import { PathAdapter } from './types.js';
+import { PackageScannerConfig } from './utils/compiler.js';
 import { ThemeVariablesPluginOptions } from './vite-plugin-theme.js';
 import { UiConfigPluginOptions } from './vite-plugin-ui-config.js';
 /**
@@ -54,7 +55,7 @@ export type VitePluginVendureDashboardOptions = {
     pathAdapter?: PathAdapter;
     /**
      * @description
-     * The name of the exported variable from the Vendure server configuration file.
+     * 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;
@@ -67,12 +68,11 @@ export type VitePluginVendureDashboardOptions = {
     disableTansStackRouterPlugin?: boolean;
     /**
      * @description
-     * If set to `true`, compilation errors during the build process will be reported and
-     * the build will fail.
-     *
-     * @default false
+     * 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.
      */
-    reportCompilationErrors?: boolean;
+    pluginPackageScanner?: PackageScannerConfig;
 } & UiConfigPluginOptions & ThemeVariablesPluginOptions;
 /**
  * @description

package/dist/plugin/vite-plugin-vendure-dashboard.js

@@ -47,9 +47,9 @@ export function vendureDashboardPlugin(options) {
         tailwindcss(),
         configLoaderPlugin({
             vendureConfigPath: normalizedVendureConfigPath,
-            tempDir,
-            reportCompilationErrors: options.reportCompilationErrors,
+            outputPath: tempDir,
             pathAdapter: options.pathAdapter,
+            pluginPackageScanner: options.pluginPackageScanner,
         }),
         viteConfigPlugin({ packageRoot }),
         adminApiSchemaPlugin(),