@vendure/dashboard 3.4.0-minor-202506250934 → 3.4.0

package/src/lib/providers/auth.tsx

@@ -1,6 +1,6 @@
-import { api } from '@/graphql/api.js';
-import { ResultOf, graphql } from '@/graphql/graphql.js';
-import { useUserSettings } from '@/hooks/use-user-settings.js';
+import { api } from '@/vdb/graphql/api.js';
+import { graphql, ResultOf } from '@/vdb/graphql/graphql.js';
+import { useUserSettings } from '@/vdb/hooks/use-user-settings.js';
 import { useQuery, useQueryClient } from '@tanstack/react-query';
 import * as React from 'react';
 
@@ -14,7 +14,7 @@ import * as React from 'react';
  * @since 3.3.0
  */
 export interface AuthContext {
-    status: 'authenticated' | 'verifying' | 'unauthenticated';
+    status: 'initial' | 'authenticated' | 'verifying' | 'unauthenticated';
     authenticationError?: string;
     isAuthenticated: boolean;
     login: (username: string, password: string, onSuccess?: () => void) => void;
@@ -70,9 +70,10 @@ const CurrentUserQuery = graphql(`
 
 export const AuthContext = React.createContext<AuthContext | null>(null);
 
-export function AuthProvider({ children }: { children: React.ReactNode }) {
-    const [status, setStatus] = React.useState<AuthContext['status']>('unauthenticated');
+export function AuthProvider({ children }: Readonly<{ children: React.ReactNode }>) {
+    const [status, setStatus] = React.useState<AuthContext['status']>('initial');
     const [authenticationError, setAuthenticationError] = React.useState<string | undefined>();
+    const [isLoginLogoutInProgress, setIsLoginLogoutInProgress] = React.useState(false);
     const { settings, setActiveChannelId } = useUserSettings();
     const queryClient = useQueryClient();
 
@@ -84,7 +85,10 @@ export function AuthProvider({ children }: { children: React.ReactNode }) {
         refetch: refetchCurrentUser,
     } = useQuery({
         queryKey: ['currentUser'],
-        queryFn: () => api.query(CurrentUserQuery),
+        queryFn: () => {
+            return api.query(CurrentUserQuery);
+        },
+        retry: false, // Disable retries to avoid waiting for multiple attempts
     });
 
     // Set active channel if needed
@@ -97,6 +101,7 @@ export function AuthProvider({ children }: { children: React.ReactNode }) {
     // Auth actions
     const login = React.useCallback(
         (username: string, password: string, onLoginSuccess?: () => void) => {
+            setIsLoginLogoutInProgress(true);
             setStatus('verifying');
             api.mutate(LoginMutation)({ username, password })
                 .then(async data => {
@@ -106,15 +111,18 @@ export function AuthProvider({ children }: { children: React.ReactNode }) {
                         // Invalidate all queries to ensure fresh data after login
                         await queryClient.invalidateQueries();
                         setStatus('authenticated');
+                        setIsLoginLogoutInProgress(false);
                         onLoginSuccess?.();
                     } else {
                         setAuthenticationError(data?.login.message);
                         setStatus('unauthenticated');
+                        setIsLoginLogoutInProgress(false);
                     }
                 })
                 .catch(error => {
                     setAuthenticationError(error.message);
                     setStatus('unauthenticated');
+                    setIsLoginLogoutInProgress(false);
                 });
         },
         [refetchCurrentUser, queryClient],
@@ -122,6 +130,7 @@ export function AuthProvider({ children }: { children: React.ReactNode }) {
 
     const logout = React.useCallback(
         async (onLogoutSuccess?: () => void) => {
+            setIsLoginLogoutInProgress(true);
             setStatus('verifying');
             api.mutate(LogOutMutation)({}).then(async data => {
                 if (data?.logout.success) {
@@ -131,6 +140,7 @@ export function AuthProvider({ children }: { children: React.ReactNode }) {
                     localStorage.removeItem('vendure-selected-channel');
                     localStorage.removeItem('vendure-selected-channel-token');
                     setStatus('unauthenticated');
+                    setIsLoginLogoutInProgress(false);
                     onLogoutSuccess?.();
                 }
             });
@@ -141,15 +151,28 @@ export function AuthProvider({ children }: { children: React.ReactNode }) {
     // Determine isAuthenticated from currentUserData
     const isAuthenticated = !!currentUserData?.me?.id;
 
-    // Set status based on query result (only if not in the middle of login/logout)
+    // Handle status transitions based on query state
     React.useEffect(() => {
-        if (status === 'verifying') return;
-        if (currentUserError || !currentUserData?.me?.id) {
-            setStatus('unauthenticated');
-        } else {
-            setStatus('authenticated');
+        // Don't change status if we're in the middle of login/logout
+        if (isLoginLogoutInProgress) {
+            return;
+        }
+
+        // If query is loading and we haven't started verifying yet, set to verifying
+        if (isLoading && status === 'initial') {
+            setStatus('verifying');
+            return;
+        }
+
+        // If query has completed (not loading) and we're in verifying state, determine final status
+        if (!isLoading && status === 'verifying') {
+            if (currentUserError || !currentUserData?.me?.id) {
+                setStatus('unauthenticated');
+            } else {
+                setStatus('authenticated');
+            }
         }
-    }, [currentUserData, currentUserError]);
+    }, [isLoading, currentUserData, currentUserError, status, isLoginLogoutInProgress]);
 
     return (
         <AuthContext.Provider

package/src/lib/providers/channel-provider.tsx

@@ -1,6 +1,6 @@
-import { api } from '@/graphql/api.js';
-import { ResultOf, graphql } from '@/graphql/graphql.js';
-import { useAuth } from '@/hooks/use-auth.js';
+import { api } from '@/vdb/graphql/api.js';
+import { ResultOf, graphql } from '@/vdb/graphql/graphql.js';
+import { useAuth } from '@/vdb/hooks/use-auth.js';
 import { useQuery, useQueryClient } from '@tanstack/react-query';
 import * as React from 'react';
 
@@ -13,6 +13,7 @@ const channelFragment = graphql(`
         defaultLanguageCode
         defaultCurrencyCode
         pricesIncludeTax
+        availableLanguageCodes
     }
 `);
 
@@ -65,7 +66,7 @@ export const ChannelContext = React.createContext<ChannelContext | undefined>(un
 const SELECTED_CHANNEL_KEY = 'vendure-selected-channel';
 const SELECTED_CHANNEL_TOKEN_KEY = 'vendure-selected-channel-token';
 
-export function ChannelProvider({ children }: { children: React.ReactNode }) {
+export function ChannelProvider({ children }: Readonly<{ children: React.ReactNode }>) {
     const queryClient = useQueryClient();
     const { channels: userChannels, isAuthenticated } = useAuth();
     const [selectedChannelId, setSelectedChannelId] = React.useState<string | undefined>(() => {
@@ -92,17 +93,18 @@ export function ChannelProvider({ children }: { children: React.ReactNode }) {
         // If user has specific channels assigned (non-superadmin), use those
         if (userChannels && userChannels.length > 0) {
             // Map user channels to match the Channel type structure
-            return userChannels.map(ch => ({
-                id: ch.id,
-                code: ch.code,
-                token: ch.token,
-                defaultLanguageCode:
-                    channelsData?.channels.items.find(c => c.id === ch.id)?.defaultLanguageCode || 'en',
-                defaultCurrencyCode:
-                    channelsData?.channels.items.find(c => c.id === ch.id)?.defaultCurrencyCode || 'USD',
-                pricesIncludeTax:
-                    channelsData?.channels.items.find(c => c.id === ch.id)?.pricesIncludeTax || false,
-            }));
+            return userChannels.map(ch => {
+                const fullChannelData = channelsData?.channels.items.find(c => c.id === ch.id);
+                return {
+                    id: ch.id,
+                    code: ch.code,
+                    token: ch.token,
+                    defaultLanguageCode: fullChannelData?.defaultLanguageCode || 'en',
+                    defaultCurrencyCode: fullChannelData?.defaultCurrencyCode || 'USD',
+                    pricesIncludeTax: fullChannelData?.pricesIncludeTax || false,
+                    availableLanguageCodes: fullChannelData?.availableLanguageCodes || ['en'],
+                };
+            });
         }
         // Otherwise use all channels (superadmin)
         return channelsData?.channels.items || [];

package/src/lib/providers/server-config.tsx

@@ -1,6 +1,6 @@
-import { api } from '@/graphql/api.js';
-import { graphql } from '@/graphql/graphql.js';
-import { useAuth } from '@/hooks/use-auth.js';
+import { api } from '@/vdb/graphql/api.js';
+import { graphql } from '@/vdb/graphql/graphql.js';
+import { useAuth } from '@/vdb/hooks/use-auth.js';
 import { useQuery } from '@tanstack/react-query';
 import { ResultOf } from 'gql.tada';
 import React from 'react';
@@ -270,14 +270,16 @@ export const ServerConfigProvider = ({ children }: { children: React.ReactNode }
         enabled: !!user?.id,
         staleTime: 1000,
     });
-    const value: ServerConfig | null = data?.globalSettings ? {
-        availableLanguages: data?.globalSettings.availableLanguages ?? [],
-        moneyStrategyPrecision: data?.globalSettings.serverConfig.moneyStrategyPrecision ?? 2,
-        orderProcess: data?.globalSettings.serverConfig.orderProcess ?? [],
-        permittedAssetTypes: data?.globalSettings.serverConfig.permittedAssetTypes ?? [],
-        permissions: data?.globalSettings.serverConfig.permissions ?? [],
-        entityCustomFields: data?.globalSettings.serverConfig.entityCustomFields ?? [],
-    } : null;
+    const value: ServerConfig | null = data?.globalSettings
+        ? {
+              availableLanguages: data?.globalSettings.availableLanguages ?? [],
+              moneyStrategyPrecision: data?.globalSettings.serverConfig.moneyStrategyPrecision ?? 2,
+              orderProcess: data?.globalSettings.serverConfig.orderProcess ?? [],
+              permittedAssetTypes: data?.globalSettings.serverConfig.permittedAssetTypes ?? [],
+              permissions: data?.globalSettings.serverConfig.permissions ?? [],
+              entityCustomFields: data?.globalSettings.serverConfig.entityCustomFields ?? [],
+          }
+        : null;
 
     return <ServerConfigContext.Provider value={value}>{children}</ServerConfigContext.Provider>;
 };

package/src/lib/providers/theme-provider.tsx

@@ -1,4 +1,4 @@
-import { createContext, useEffect, useState } from 'react';
+import { createContext, useEffect } from 'react';
 import { useUserSettings } from '../hooks/use-user-settings.js';
 
 export type Theme = 'dark' | 'light' | 'system';
@@ -21,7 +21,7 @@ const initialState: ThemeProviderState = {
 
 export const ThemeProviderContext = createContext<ThemeProviderState>(initialState);
 
-export function ThemeProvider({ children, defaultTheme = 'system', ...props }: ThemeProviderProps) {
+export function ThemeProvider({ children, defaultTheme = 'system', ...props }: Readonly<ThemeProviderProps>) {
     const { settings, setTheme } = useUserSettings();
 
     useEffect(() => {
@@ -51,4 +51,3 @@ export function ThemeProvider({ children, defaultTheme = 'system', ...props }: T
         </ThemeProviderContext.Provider>
     );
 }
-

package/src/lib/providers/user-settings.tsx

@@ -1,6 +1,12 @@
-import React, { createContext, useState, useEffect } from 'react';
-import { Theme } from './theme-provider.js';
+import { QueryClient, useMutation, useQuery } from '@tanstack/react-query';
 import { ColumnFiltersState } from '@tanstack/react-table';
+import React, { createContext, useEffect, useRef, useState } from 'react';
+import { api } from '../graphql/api.js';
+import {
+    getSettingsStoreValueDocument,
+    setSettingsStoreValueDocument,
+} from '../graphql/settings-store-operations.js';
+import { Theme } from './theme-provider.js';
 
 export interface TableSettings {
     columnVisibility?: Record<string, boolean>;
@@ -56,8 +62,14 @@ export interface UserSettingsContextType {
 export const UserSettingsContext = createContext<UserSettingsContextType | undefined>(undefined);
 
 const STORAGE_KEY = 'vendure-user-settings';
+const SETTINGS_STORE_KEY = 'vendure.dashboard.userSettings';
 
-export const UserSettingsProvider: React.FC<React.PropsWithChildren<{}>> = ({ children }) => {
+interface UserSettingsProviderProps {
+    queryClient?: QueryClient;
+    children: React.ReactNode;
+}
+
+export const UserSettingsProvider: React.FC<UserSettingsProviderProps> = ({ queryClient, children }) => {
     // Load settings from localStorage or use defaults
     const loadSettings = (): UserSettings => {
         try {
@@ -72,6 +84,49 @@ export const UserSettingsProvider: React.FC<React.PropsWithChildren<{}>> = ({ ch
     };
 
     const [settings, setSettings] = useState<UserSettings>(loadSettings);
+    const [serverSettings, setServerSettings] = useState<UserSettings | null>(null);
+    const [isReady, setIsReady] = useState(false);
+    const previousContentLanguage = useRef(settings.contentLanguage);
+
+    // Load settings from server on mount
+    const { data: serverSettingsResponse, isSuccess: serverSettingsLoaded } = useQuery({
+        queryKey: ['user-settings', SETTINGS_STORE_KEY],
+        queryFn: () => api.query(getSettingsStoreValueDocument, { key: SETTINGS_STORE_KEY }),
+        retry: false,
+        staleTime: 0,
+    });
+
+    // Mutation to save settings to server
+    const saveToServerMutation = useMutation({
+        mutationFn: (settingsToSave: UserSettings) =>
+            api.mutate(setSettingsStoreValueDocument, {
+                input: { key: SETTINGS_STORE_KEY, value: settingsToSave },
+            }),
+        onError: error => {
+            console.error('Failed to save user settings to server:', error);
+        },
+    });
+
+    // Initialize settings from server if available
+    useEffect(() => {
+        if (serverSettingsLoaded && !isReady) {
+            try {
+                const serverSettingsData =
+                    serverSettingsResponse?.getSettingsStoreValue as UserSettings | null;
+                if (serverSettingsData) {
+                    // Server has settings, use them
+                    const mergedSettings = { ...defaultSettings, ...serverSettingsData };
+                    setSettings(mergedSettings);
+                    setServerSettings(mergedSettings);
+                    setIsReady(true);
+                }
+            } catch (e) {
+                console.error('Failed to parse server settings:', e);
+                setServerSettings(settings);
+                setIsReady(true);
+            }
+        }
+    }, [serverSettingsLoaded, serverSettingsResponse, settings, isReady]);
 
     // Save settings to localStorage whenever they change
     useEffect(() => {
@@ -82,6 +137,26 @@ export const UserSettingsProvider: React.FC<React.PropsWithChildren<{}>> = ({ ch
         }
     }, [settings]);
 
+    // Save to server when settings differ from server state
+    useEffect(() => {
+        if (isReady && serverSettings) {
+            const serverDiffers = JSON.stringify(serverSettings) !== JSON.stringify(settings);
+
+            if (serverDiffers) {
+                saveToServerMutation.mutate(settings);
+                setServerSettings(settings);
+            }
+        }
+    }, [settings, serverSettings, isReady, saveToServerMutation]);
+
+    // Invalidate all queries when content language changes
+    useEffect(() => {
+        if (queryClient && settings.contentLanguage !== previousContentLanguage.current) {
+            void queryClient.invalidateQueries();
+            previousContentLanguage.current = settings.contentLanguage;
+        }
+    }, [settings.contentLanguage, queryClient]);
+
     // Settings updaters
     const updateSetting = <K extends keyof UserSettings>(key: K, value: UserSettings[K]) => {
         setSettings(prev => ({ ...prev, [key]: value }));

package/src/lib/virtual.d.ts

@@ -7,6 +7,30 @@ declare module 'virtual:dashboard-extensions' {
 }
 
 declare module 'virtual:vendure-ui-config' {
-    import { AdminUiConfig } from '@vendure/core';
-    export const uiConfig: AdminUiConfig;
+    import { LanguageCode } from '@vendure/core';
+
+    // TODO: Find a better way to share types between vite plugin and virtual module declaration
+    // Currently we have duplicated type definitions here and in vite-plugin-ui-config.ts
+    interface ResolvedApiConfig {
+        host: string | 'auto';
+        port: number | 'auto';
+        adminApiPath: string;
+        tokenMethod: 'cookie' | 'bearer';
+        authTokenHeaderKey: string;
+        channelTokenKey: string;
+    }
+
+    interface ResolvedI18nConfig {
+        defaultLanguage: LanguageCode;
+        defaultLocale: string | undefined;
+        availableLanguages: LanguageCode[];
+        availableLocales: string[];
+    }
+
+    interface ResolvedUiConfig {
+        api: ResolvedApiConfig;
+        i18n: ResolvedI18nConfig;
+    }
+
+    export const uiConfig: ResolvedUiConfig;
 }

package/src/vite-env.d.ts

@@ -0,0 +1,2 @@
+/// <reference types="vite/client" />
+/// <reference path="./lib/virtual.d.ts" />

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

@@ -0,0 +1,30 @@
+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

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

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

@@ -0,0 +1,8 @@
+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

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

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

@@ -0,0 +1,19 @@
+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

@@ -0,0 +1,20 @@
+"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

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

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

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

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

@@ -0,0 +1,18 @@
+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

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

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

@@ -0,0 +1,8 @@
+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

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

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

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

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

@@ -0,0 +1,8 @@
+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

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

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

@@ -0,0 +1,8 @@
+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

@@ -0,0 +1,20 @@
+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

@@ -0,0 +1,46 @@
+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 },
+    );
+});