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

package/vite/tests/barrel-exports.spec.ts

@@ -1,30 +0,0 @@
-import { rm } from 'node:fs/promises';
-import { join } from 'node:path';
-import { describe, expect, it } from 'vitest';
-
-import { compile } from '../utils/compiler.js';
-import { debugLogger, noopLogger } from '../utils/logger.js';
-
-describe('detecting plugins in barrel exports', () => {
-    it(
-        'should detect plugins in barrel exports',
-        async () => {
-            const tempDir = join(__dirname, './__temp/barrel-exports');
-            await rm(tempDir, { recursive: true, force: true });
-            const result = await compile({
-                outputPath: tempDir,
-                vendureConfigPath: join(__dirname, 'fixtures-barrel-exports', 'vendure-config.ts'),
-                logger: process.env.LOG ? debugLogger : noopLogger,
-            });
-
-            expect(result.pluginInfo).toHaveLength(1);
-            expect(result.pluginInfo[0].name).toBe('MyPlugin');
-            expect(result.pluginInfo[0].dashboardEntryPath).toBe('./dashboard/index.tsx');
-            expect(result.pluginInfo[0].sourcePluginPath).toBe(
-                join(__dirname, 'fixtures-barrel-exports', 'my-plugin', 'src', 'my.plugin.ts'),
-            );
-            expect(result.pluginInfo[0].pluginPath).toBe(join(tempDir, 'my-plugin', 'src', 'my.plugin.js'));
-        },
-        { timeout: 10_000 },
-    );
-});

package/vite/tests/fixtures-barrel-exports/my-plugin/index.ts

@@ -1 +0,0 @@
-export * from './src/my.plugin';

package/vite/tests/fixtures-barrel-exports/my-plugin/src/my.plugin.ts

@@ -1,8 +0,0 @@
-import { PluginCommonModule, VendurePlugin } from '@vendure/core';
-
-@VendurePlugin({
-    imports: [PluginCommonModule],
-    providers: [],
-    dashboard: './dashboard/index.tsx',
-})
-export class MyPlugin {}

package/vite/tests/fixtures-barrel-exports/package.json

@@ -1,6 +0,0 @@
-{
-    "type": "commonjs",
-    "name": "barrel-exports",
-    "version": "0.0.1", 
-    "main": "index.ts"
-}

package/vite/tests/fixtures-barrel-exports/vendure-config.ts

@@ -1,19 +0,0 @@
-import { VendureConfig } from '@vendure/core';
-
-import { MyPlugin } from './my-plugin';
-
-export const config: VendureConfig = {
-    apiOptions: {
-        port: 3000,
-    },
-    authOptions: {
-        tokenMethod: 'bearer',
-    },
-    dbConnectionOptions: {
-        type: 'postgres',
-    },
-    paymentOptions: {
-        paymentMethodHandlers: [],
-    },
-    plugins: [MyPlugin],
-};

package/vite/tests/fixtures-npm-plugin/fake_node_modules/test-plugin/index.js

@@ -1,20 +0,0 @@
-"use strict";
-var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
-    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
-    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
-    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
-    return c > 3 && r && Object.defineProperty(target, key, r), r;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.TestPlugin = void 0;
-const core_1 = require("@vendure/core");
-let TestPlugin = class TestPlugin {
-};
-exports.TestPlugin = TestPlugin;
-exports.TestPlugin = TestPlugin = __decorate([
-    (0, core_1.VendurePlugin)({
-        imports: [core_1.PluginCommonModule],
-        dashboard: './dashboard/index.tsx',
-    })
-], TestPlugin);
-//# sourceMappingURL=reviews-plugin.js.map

package/vite/tests/fixtures-npm-plugin/fake_node_modules/test-plugin/package.json

@@ -1,8 +0,0 @@
-{
-  "name": "test-plugin",
-  "version": "1.0.0",
-  "main": "index.js",
-  "scripts": {
-    "build": "echo 'Building test-plugin'"
-  }
-}

package/vite/tests/fixtures-npm-plugin/package.json

@@ -1,6 +0,0 @@
-{
-    "type": "commonjs",
-    "name": "npm-plugin",
-    "version": "0.0.1", 
-    "main": "index.ts"
-}

package/vite/tests/fixtures-npm-plugin/vendure-config.ts

@@ -1,18 +0,0 @@
-import { VendureConfig } from '@vendure/core';
-import { TestPlugin } from 'test-plugin';
-
-export const config: VendureConfig = {
-    apiOptions: {
-        port: 3000,
-    },
-    authOptions: {
-        tokenMethod: 'bearer',
-    },
-    dbConnectionOptions: {
-        type: 'postgres',
-    },
-    paymentOptions: {
-        paymentMethodHandlers: [],
-    },
-    plugins: [TestPlugin],
-};

package/vite/tests/fixtures-path-alias/js-aliased/index.ts

@@ -1 +0,0 @@
-export * from './src/js-aliased.plugin';

package/vite/tests/fixtures-path-alias/js-aliased/src/js-aliased.plugin.ts

@@ -1,8 +0,0 @@
-import { PluginCommonModule, VendurePlugin } from '@vendure/core';
-
-@VendurePlugin({
-    imports: [PluginCommonModule],
-    providers: [],
-    dashboard: './dashboard/index.tsx',
-})
-export class JsAliasedPlugin {}

package/vite/tests/fixtures-path-alias/package.json

@@ -1,6 +0,0 @@
-{
-    "type": "commonjs",
-    "name": "aliased-plugin",
-    "version": "0.0.1", 
-    "main": "index.ts"
-}

package/vite/tests/fixtures-path-alias/star-aliased/index.ts

@@ -1 +0,0 @@
-export * from './src/star-aliased.plugin';

package/vite/tests/fixtures-path-alias/star-aliased/src/star-aliased.plugin.ts

@@ -1,8 +0,0 @@
-import { PluginCommonModule, VendurePlugin } from '@vendure/core';
-
-@VendurePlugin({
-    imports: [PluginCommonModule],
-    providers: [],
-    dashboard: './dashboard/index.tsx',
-})
-export class StarAliasedPlugin {}

package/vite/tests/fixtures-path-alias/ts-aliased/index.ts

@@ -1 +0,0 @@
-export * from './src/ts-aliased.plugin';

package/vite/tests/fixtures-path-alias/ts-aliased/src/ts-aliased.plugin.ts

@@ -1,8 +0,0 @@
-import { PluginCommonModule, VendurePlugin } from '@vendure/core';
-
-@VendurePlugin({
-    imports: [PluginCommonModule],
-    providers: [],
-    dashboard: './dashboard/index.tsx',
-})
-export class TsAliasedPlugin {}

package/vite/tests/fixtures-path-alias/vendure-config.ts

@@ -1,20 +0,0 @@
-import { JsAliasedPlugin } from '@other/js-aliased';
-import { TsAliasedPlugin } from '@other/ts-aliased';
-import { StarAliasedPlugin } from '@plugins/star-aliased';
-import { VendureConfig } from '@vendure/core';
-
-export const config: VendureConfig = {
-    apiOptions: {
-        port: 3000,
-    },
-    authOptions: {
-        tokenMethod: 'bearer',
-    },
-    dbConnectionOptions: {
-        type: 'postgres',
-    },
-    paymentOptions: {
-        paymentMethodHandlers: [],
-    },
-    plugins: [StarAliasedPlugin, TsAliasedPlugin, JsAliasedPlugin],
-};

package/vite/tests/npm-plugin.spec.ts

@@ -1,46 +0,0 @@
-import { rm } from 'node:fs/promises';
-import { join } from 'node:path';
-import tsconfigPaths from 'tsconfig-paths';
-import { describe, expect, it } from 'vitest';
-
-import { compile } from '../utils/compiler.js';
-import { debugLogger, noopLogger } from '../utils/logger.js';
-
-describe('detecting plugins in npm packages', () => {
-    it(
-        'should detect plugins in npm packages',
-        async () => {
-            const tempDir = join(__dirname, './__temp/npm-plugin');
-            await rm(tempDir, { recursive: true, force: true });
-            const fakeNodeModules = join(__dirname, 'fixtures-npm-plugin', 'fake_node_modules');
-
-            // For this test to work, we need to use tsconfigPaths to point
-            // the `test-plugin` package to the `fake_node_modules` directory.
-            // This is because the `test-plugin` package is not installed in
-            // the `node_modules` directory, but in the `fake_node_modules`
-            // directory.
-            tsconfigPaths.register({
-                baseUrl: fakeNodeModules,
-                paths: {
-                    'test-plugin': [join(fakeNodeModules, 'test-plugin')],
-                },
-            });
-
-            const result = await compile({
-                outputPath: tempDir,
-                vendureConfigPath: join(__dirname, 'fixtures-npm-plugin', 'vendure-config.ts'),
-                logger: process.env.LOG ? debugLogger : noopLogger,
-                pluginPackageScanner: {
-                    nodeModulesRoot: fakeNodeModules,
-                },
-            });
-
-            expect(result.pluginInfo).toHaveLength(1);
-            expect(result.pluginInfo[0].name).toBe('TestPlugin');
-            expect(result.pluginInfo[0].dashboardEntryPath).toBe('./dashboard/index.tsx');
-            expect(result.pluginInfo[0].sourcePluginPath).toBeUndefined();
-            expect(result.pluginInfo[0].pluginPath).toBe(join(fakeNodeModules, 'test-plugin', 'index.js'));
-        },
-        { timeout: 10_000 },
-    );
-});

package/vite/tests/path-alias.spec.ts

@@ -1,61 +0,0 @@
-import { rm } from 'node:fs/promises';
-import { join } from 'node:path';
-import { describe, expect, it } from 'vitest';
-
-import { compile } from '../utils/compiler.js';
-import { debugLogger, noopLogger } from '../utils/logger.js';
-
-describe('detecting plugins using tsconfig path aliases', () => {
-    it(
-        'should detect plugins using tsconfig path aliases',
-        async () => {
-            const tempDir = join(__dirname, './__temp/path-alias');
-            await rm(tempDir, { recursive: true, force: true });
-
-            const result = await compile({
-                outputPath: tempDir,
-                vendureConfigPath: join(__dirname, 'fixtures-path-alias', 'vendure-config.ts'),
-                logger: process.env.LOG ? debugLogger : noopLogger,
-                pathAdapter: {
-                    transformTsConfigPathMappings: ({ phase, patterns }) => {
-                        if (phase === 'loading') {
-                            return patterns.map(pattern => {
-                                return pattern.replace(/\/fixtures-path-alias/, '').replace(/.ts$/, '.js');
-                            });
-                        } else {
-                            return patterns;
-                        }
-                    },
-                },
-            });
-
-            const plugins = result.pluginInfo.sort((a, b) => a.name.localeCompare(b.name));
-
-            expect(plugins).toHaveLength(3);
-
-            expect(plugins[0].name).toBe('JsAliasedPlugin');
-            expect(plugins[0].dashboardEntryPath).toBe('./dashboard/index.tsx');
-            expect(plugins[0].sourcePluginPath).toBe(
-                join(__dirname, 'fixtures-path-alias', 'js-aliased', 'src', 'js-aliased.plugin.ts'),
-            );
-            expect(plugins[0].pluginPath).toBe(join(tempDir, 'js-aliased', 'src', 'js-aliased.plugin.js'));
-
-            expect(plugins[1].name).toBe('StarAliasedPlugin');
-            expect(plugins[1].dashboardEntryPath).toBe('./dashboard/index.tsx');
-            expect(plugins[1].sourcePluginPath).toBe(
-                join(__dirname, 'fixtures-path-alias', 'star-aliased', 'src', 'star-aliased.plugin.ts'),
-            );
-            expect(plugins[1].pluginPath).toBe(
-                join(tempDir, 'star-aliased', 'src', 'star-aliased.plugin.js'),
-            );
-
-            expect(plugins[2].name).toBe('TsAliasedPlugin');
-            expect(plugins[2].dashboardEntryPath).toBe('./dashboard/index.tsx');
-            expect(plugins[2].sourcePluginPath).toBe(
-                join(__dirname, 'fixtures-path-alias', 'ts-aliased', 'src', 'ts-aliased.plugin.ts'),
-            );
-            expect(plugins[2].pluginPath).toBe(join(tempDir, 'ts-aliased', 'src', 'ts-aliased.plugin.js'));
-        },
-        { timeout: 10_000 },
-    );
-});

package/vite/tests/tsconfig.json

@@ -1,21 +0,0 @@
-{
-  "compilerOptions": {
-    "module": "NodeNext",
-    "sourceMap": true,
-    "jsx": "react-jsx",
-    "paths": {
-      "@plugins/*": [
-        "./fixtures-path-alias/*"
-      ],
-      "@other/ts-aliased": [
-        "./fixtures-path-alias/ts-aliased/index.ts"
-      ],
-      "@other/js-aliased": [
-        "./fixtures-path-alias/js-aliased/index.js"
-      ]
-    }
-  },
-  "exclude": [
-    "node_modules"
-  ]
-}

package/vite/types.ts

@@ -1,44 +0,0 @@
-export type Logger = {
-    info: (message: string) => void;
-    warn: (message: string) => void;
-    debug: (message: string) => void;
-    error: (message: string) => void;
-};
-
-export type PluginInfo = {
-    name: string;
-    pluginPath: string;
-    dashboardEntryPath: string | undefined;
-    /** The original source path of the plugin, only set for local plugins that are compiled */
-    sourcePluginPath?: string;
-};
-
-export type GetCompiledConfigPathFn = (params: {
-    inputRootDir: string;
-    outputPath: string;
-    configFileName: string;
-}) => string;
-
-export type TransformTsConfigPathMappingsFn = (params: {
-    phase: 'compiling' | 'loading';
-    alias: string;
-    patterns: string[];
-}) => string[];
-
-/**
- * @description
- * The PathAdapter interface allows customization of how paths are handled
- * when compiling the Vendure config and its imports.
- */
-export interface PathAdapter {
-    /**
-     * @description
-     * A function to determine the path to the compiled Vendure config file.
-     */
-    getCompiledConfigPath?: GetCompiledConfigPathFn;
-    /**
-     * If your project makes use of the TypeScript `paths` configuration, the compiler will
-     * attempt to use these paths when compiling the Vendure config and its imports.
-     */
-    transformTsConfigPathMappings?: TransformTsConfigPathMappingsFn;
-}

package/vite/utils/ast-utils.spec.ts

@@ -1,49 +0,0 @@
-import ts from 'typescript';
-import { describe, expect, it } from 'vitest';
-
-import { findConfigExport } from './ast-utils.js';
-
-describe('findConfigExport', () => {
-    it('should return undefined when no VendureConfig export is found', () => {
-        const sourceText = `
-            export const notConfig = {
-                some: 'value'
-            };
-        `;
-        const sourceFile = ts.createSourceFile('path/to/test.ts', sourceText, ts.ScriptTarget.Latest, true);
-        const result = findConfigExport(sourceFile);
-        expect(result).toBeUndefined();
-    });
-
-    it('should find exported variable with VendureConfig type', () => {
-        const sourceText = `
-            import { VendureConfig } from '@vendure/core';
-
-            export const config: VendureConfig = {
-                authOptions: {
-                    tokenMethod: 'bearer'
-                }
-            };
-        `;
-        const sourceFile = ts.createSourceFile('path/to/test.ts', sourceText, ts.ScriptTarget.Latest, true);
-        const result = findConfigExport(sourceFile);
-        expect(result).toBe('config');
-    });
-
-    it('should find exported variable with VendureConfig type among other exports', () => {
-        const sourceText = `
-            import { VendureConfig } from '@vendure/core';
-
-            export const otherExport = 'value';
-            export const config: VendureConfig = {
-                authOptions: {
-                    tokenMethod: 'bearer'
-                }
-            };
-            export const anotherExport = 123;
-        `;
-        const sourceFile = ts.createSourceFile('path/to/test.ts', sourceText, ts.ScriptTarget.Latest, true);
-        const result = findConfigExport(sourceFile);
-        expect(result).toBe('config');
-    });
-});

package/vite/utils/ast-utils.ts

@@ -1,33 +0,0 @@
-import ts from 'typescript';
-
-/**
- * Given the AST of a TypeScript file, finds the name of the variable exported as VendureConfig.
- */
-export function findConfigExport(sourceFile: ts.SourceFile): string | undefined {
-    let exportedSymbolName: string | undefined;
-
-    function visit(node: ts.Node) {
-        if (
-            ts.isVariableStatement(node) &&
-            node.modifiers?.some(m => m.kind === ts.SyntaxKind.ExportKeyword)
-        ) {
-            node.declarationList.declarations.forEach(declaration => {
-                if (ts.isVariableDeclaration(declaration)) {
-                    const typeNode = declaration.type;
-                    if (typeNode && ts.isTypeReferenceNode(typeNode)) {
-                        const typeName = typeNode.typeName;
-                        if (ts.isIdentifier(typeName) && typeName.text === 'VendureConfig') {
-                            if (ts.isIdentifier(declaration.name)) {
-                                exportedSymbolName = declaration.name.text;
-                            }
-                        }
-                    }
-                }
-            });
-        }
-        ts.forEachChild(node, visit);
-    }
-
-    visit(sourceFile);
-    return exportedSymbolName;
-}