@vendure/dashboard 3.2.0 → 3.2.2

package/vite/ui-config.ts

@@ -1,60 +1,60 @@
-import {
-    DEFAULT_AUTH_TOKEN_HEADER_KEY,
-    DEFAULT_CHANNEL_TOKEN_KEY,
-    ADMIN_API_PATH,
-} from '@vendure/common/lib/shared-constants';
-import { AdminUiConfig } from '@vendure/common/lib/shared-types';
-import { VendureConfig } from '@vendure/core';
-
-import { defaultAvailableLocales } from './constants.js';
-import { defaultLocale, defaultLanguage, defaultAvailableLanguages } from './constants.js';
-
-export function getAdminUiConfig(
-    config: VendureConfig,
-    adminUiConfig?: Partial<AdminUiConfig>,
-): AdminUiConfig {
-    const { authOptions, apiOptions } = config;
-
-    const propOrDefault = <Prop extends keyof AdminUiConfig>(
-        prop: Prop,
-        defaultVal: AdminUiConfig[Prop],
-        isArray: boolean = false,
-    ): AdminUiConfig[Prop] => {
-        if (isArray) {
-            const isValidArray = !!adminUiConfig
-                ? !!((adminUiConfig as AdminUiConfig)[prop] as any[])?.length
-                : false;
-
-            return !!adminUiConfig && isValidArray ? (adminUiConfig as AdminUiConfig)[prop] : defaultVal;
-        } else {
-            return adminUiConfig ? (adminUiConfig as AdminUiConfig)[prop] || defaultVal : defaultVal;
-        }
-    };
-
-    return {
-        adminApiPath: propOrDefault('adminApiPath', apiOptions.adminApiPath || ADMIN_API_PATH),
-        apiHost: propOrDefault('apiHost', 'auto'),
-        apiPort: propOrDefault('apiPort', 'auto'),
-        tokenMethod: propOrDefault('tokenMethod', authOptions.tokenMethod === 'bearer' ? 'bearer' : 'cookie'),
-        authTokenHeaderKey: propOrDefault(
-            'authTokenHeaderKey',
-            authOptions.authTokenHeaderKey || DEFAULT_AUTH_TOKEN_HEADER_KEY,
-        ),
-        channelTokenKey: propOrDefault(
-            'channelTokenKey',
-            apiOptions.channelTokenKey || DEFAULT_CHANNEL_TOKEN_KEY,
-        ),
-        defaultLanguage: propOrDefault('defaultLanguage', defaultLanguage),
-        defaultLocale: propOrDefault('defaultLocale', defaultLocale),
-        availableLanguages: propOrDefault('availableLanguages', defaultAvailableLanguages, true),
-        availableLocales: propOrDefault('availableLocales', defaultAvailableLocales, true),
-        brand: adminUiConfig?.brand,
-        hideVendureBranding: propOrDefault(
-            'hideVendureBranding',
-            adminUiConfig?.hideVendureBranding || false,
-        ),
-        hideVersion: propOrDefault('hideVersion', adminUiConfig?.hideVersion || false),
-        loginImageUrl: adminUiConfig?.loginImageUrl,
-        cancellationReasons: propOrDefault('cancellationReasons', undefined),
-    };
-}
+import {
+    DEFAULT_AUTH_TOKEN_HEADER_KEY,
+    DEFAULT_CHANNEL_TOKEN_KEY,
+    ADMIN_API_PATH,
+} from '@vendure/common/lib/shared-constants';
+import { AdminUiConfig } from '@vendure/common/lib/shared-types';
+import { VendureConfig } from '@vendure/core';
+
+import { defaultAvailableLocales } from './constants.js';
+import { defaultLocale, defaultLanguage, defaultAvailableLanguages } from './constants.js';
+
+export function getAdminUiConfig(
+    config: VendureConfig,
+    adminUiConfig?: Partial<AdminUiConfig>,
+): AdminUiConfig {
+    const { authOptions, apiOptions } = config;
+
+    const propOrDefault = <Prop extends keyof AdminUiConfig>(
+        prop: Prop,
+        defaultVal: AdminUiConfig[Prop],
+        isArray: boolean = false,
+    ): AdminUiConfig[Prop] => {
+        if (isArray) {
+            const isValidArray = !!adminUiConfig
+                ? !!((adminUiConfig as AdminUiConfig)[prop] as any[])?.length
+                : false;
+
+            return !!adminUiConfig && isValidArray ? (adminUiConfig as AdminUiConfig)[prop] : defaultVal;
+        } else {
+            return adminUiConfig ? (adminUiConfig as AdminUiConfig)[prop] || defaultVal : defaultVal;
+        }
+    };
+
+    return {
+        adminApiPath: propOrDefault('adminApiPath', apiOptions.adminApiPath || ADMIN_API_PATH),
+        apiHost: propOrDefault('apiHost', 'auto'),
+        apiPort: propOrDefault('apiPort', 'auto'),
+        tokenMethod: propOrDefault('tokenMethod', authOptions.tokenMethod === 'bearer' ? 'bearer' : 'cookie'),
+        authTokenHeaderKey: propOrDefault(
+            'authTokenHeaderKey',
+            authOptions.authTokenHeaderKey || DEFAULT_AUTH_TOKEN_HEADER_KEY,
+        ),
+        channelTokenKey: propOrDefault(
+            'channelTokenKey',
+            apiOptions.channelTokenKey || DEFAULT_CHANNEL_TOKEN_KEY,
+        ),
+        defaultLanguage: propOrDefault('defaultLanguage', defaultLanguage),
+        defaultLocale: propOrDefault('defaultLocale', defaultLocale),
+        availableLanguages: propOrDefault('availableLanguages', defaultAvailableLanguages, true),
+        availableLocales: propOrDefault('availableLocales', defaultAvailableLocales, true),
+        brand: adminUiConfig?.brand,
+        hideVendureBranding: propOrDefault(
+            'hideVendureBranding',
+            adminUiConfig?.hideVendureBranding || false,
+        ),
+        hideVersion: propOrDefault('hideVersion', adminUiConfig?.hideVersion || false),
+        loginImageUrl: adminUiConfig?.loginImageUrl,
+        cancellationReasons: propOrDefault('cancellationReasons', undefined),
+    };
+}

package/vite/vite-plugin-admin-api-schema.ts

@@ -1,141 +1,141 @@
-import { GraphQLTypesLoader } from '@nestjs/graphql';
-import {
-    getConfig,
-    getFinalVendureSchema,
-    resetConfig,
-    runPluginConfigurations,
-    setConfig,
-    VENDURE_ADMIN_API_TYPE_PATHS,
-} from '@vendure/core';
-import {
-    buildSchema,
-    GraphQLList,
-    GraphQLNonNull,
-    GraphQLObjectType,
-    GraphQLSchema,
-    GraphQLType,
-    isEnumType,
-    isInputObjectType,
-    isObjectType,
-    isScalarType,
-} from 'graphql';
-import { Plugin } from 'vite';
-
-import { generateSchema } from './schema-generator.js';
-import { ConfigLoaderApi, getConfigLoaderApi } from './vite-plugin-config-loader.js';
-
-export type FieldInfoTuple = readonly [
-    type: string,
-    nullable: boolean,
-    list: boolean,
-    isPaginatedList: boolean,
-];
-
-export interface SchemaInfo {
-    types: {
-        [typename: string]: {
-            [fieldname: string]: FieldInfoTuple;
-        };
-    };
-    inputs: {
-        [typename: string]: {
-            [fieldname: string]: FieldInfoTuple;
-        };
-    };
-    scalars: string[];
-    enums: {
-        [typename: string]: string[];
-    };
-}
-
-const virtualModuleId = 'virtual:admin-api-schema';
-const resolvedVirtualModuleId = `\0${virtualModuleId}`;
-
-export function adminApiSchemaPlugin(): Plugin {
-    let configLoaderApi: ConfigLoaderApi;
-    let schemaInfo: SchemaInfo;
-
-    return {
-        name: 'vendure:admin-api-schema',
-        configResolved({ plugins }) {
-            configLoaderApi = getConfigLoaderApi(plugins);
-        },
-        async buildStart() {
-            const vendureConfig = await configLoaderApi.getVendureConfig();
-            if (!schemaInfo) {
-                const safeSchema = await generateSchema({ vendureConfig });
-                schemaInfo = generateSchemaInfo(safeSchema);
-            }
-        },
-        resolveId(id) {
-            if (id === virtualModuleId) {
-                return resolvedVirtualModuleId;
-            }
-        },
-        load(id) {
-            if (id === resolvedVirtualModuleId) {
-                return `
-                    export const schemaInfo = ${JSON.stringify(schemaInfo)};
-                `;
-            }
-        },
-    };
-}
-
-function getTypeInfo(type: GraphQLType) {
-    let nullable = true;
-    let list = false;
-    let isPaginatedList = false;
-
-    // Unwrap NonNull
-    if (type instanceof GraphQLNonNull) {
-        nullable = false;
-        type = type.ofType;
-    }
-
-    // Unwrap List
-    if (type instanceof GraphQLList) {
-        list = true;
-        type = type.ofType;
-    }
-
-    if (type instanceof GraphQLObjectType) {
-        if (type.getInterfaces().some(i => i.name === 'PaginatedList')) {
-            isPaginatedList = true;
-        }
-    }
-
-    return [type.toString().replace(/!$/, ''), nullable, list, isPaginatedList] as const;
-}
-
-function generateSchemaInfo(schema: GraphQLSchema): SchemaInfo {
-    const types = schema.getTypeMap();
-    const result: SchemaInfo = { types: {}, inputs: {}, scalars: [], enums: {} };
-
-    Object.values(types).forEach(type => {
-        if (isObjectType(type)) {
-            const fields = type.getFields();
-            result.types[type.name] = {};
-
-            Object.entries(fields).forEach(([fieldName, field]) => {
-                result.types[type.name][fieldName] = getTypeInfo(field.type);
-            });
-        }
-        if (isInputObjectType(type)) {
-            const fields = type.getFields();
-            result.inputs[type.name] = {};
-
-            Object.entries(fields).forEach(([fieldName, field]) => {
-                result.inputs[type.name][fieldName] = getTypeInfo(field.type);
-            });
-        }
-        if (isScalarType(type)) {
-            result.scalars.push(type.name);
-        }
-        if (isEnumType(type)) {
-            result.enums[type.name] = type.getValues().map(v => v.value);
-        }
-    });
-
-    return result;
-}
+import { GraphQLTypesLoader } from '@nestjs/graphql';
+import {
+    getConfig,
+    getFinalVendureSchema,
+    resetConfig,
+    runPluginConfigurations,
+    setConfig,
+    VENDURE_ADMIN_API_TYPE_PATHS,
+} from '@vendure/core';
+import {
+    buildSchema,
+    GraphQLList,
+    GraphQLNonNull,
+    GraphQLObjectType,
+    GraphQLSchema,
+    GraphQLType,
+    isEnumType,
+    isInputObjectType,
+    isObjectType,
+    isScalarType,
+} from 'graphql';
+import { Plugin } from 'vite';
+
+import { generateSchema } from './schema-generator.js';
+import { ConfigLoaderApi, getConfigLoaderApi } from './vite-plugin-config-loader.js';
+
+export type FieldInfoTuple = readonly [
+    type: string,
+    nullable: boolean,
+    list: boolean,
+    isPaginatedList: boolean,
+];
+
+export interface SchemaInfo {
+    types: {
+        [typename: string]: {
+            [fieldname: string]: FieldInfoTuple;
+        };
+    };
+    inputs: {
+        [typename: string]: {
+            [fieldname: string]: FieldInfoTuple;
+        };
+    };
+    scalars: string[];
+    enums: {
+        [typename: string]: string[];
+    };
+}
+
+const virtualModuleId = 'virtual:admin-api-schema';
+const resolvedVirtualModuleId = `\0${virtualModuleId}`;
+
+export function adminApiSchemaPlugin(): Plugin {
+    let configLoaderApi: ConfigLoaderApi;
+    let schemaInfo: SchemaInfo;
+
+    return {
+        name: 'vendure:admin-api-schema',
+        configResolved({ plugins }) {
+            configLoaderApi = getConfigLoaderApi(plugins);
+        },
+        async buildStart() {
+            const vendureConfig = await configLoaderApi.getVendureConfig();
+            if (!schemaInfo) {
+                const safeSchema = await generateSchema({ vendureConfig });
+                schemaInfo = generateSchemaInfo(safeSchema);
+            }
+        },
+        resolveId(id) {
+            if (id === virtualModuleId) {
+                return resolvedVirtualModuleId;
+            }
+        },
+        load(id) {
+            if (id === resolvedVirtualModuleId) {
+                return `
+                    export const schemaInfo = ${JSON.stringify(schemaInfo)};
+                `;
+            }
+        },
+    };
+}
+
+function getTypeInfo(type: GraphQLType) {
+    let nullable = true;
+    let list = false;
+    let isPaginatedList = false;
+
+    // Unwrap NonNull
+    if (type instanceof GraphQLNonNull) {
+        nullable = false;
+        type = type.ofType;
+    }
+
+    // Unwrap List
+    if (type instanceof GraphQLList) {
+        list = true;
+        type = type.ofType;
+    }
+
+    if (type instanceof GraphQLObjectType) {
+        if (type.getInterfaces().some(i => i.name === 'PaginatedList')) {
+            isPaginatedList = true;
+        }
+    }
+
+    return [type.toString().replace(/!$/, ''), nullable, list, isPaginatedList] as const;
+}
+
+function generateSchemaInfo(schema: GraphQLSchema): SchemaInfo {
+    const types = schema.getTypeMap();
+    const result: SchemaInfo = { types: {}, inputs: {}, scalars: [], enums: {} };
+
+    Object.values(types).forEach(type => {
+        if (isObjectType(type)) {
+            const fields = type.getFields();
+            result.types[type.name] = {};
+
+            Object.entries(fields).forEach(([fieldName, field]) => {
+                result.types[type.name][fieldName] = getTypeInfo(field.type);
+            });
+        }
+        if (isInputObjectType(type)) {
+            const fields = type.getFields();
+            result.inputs[type.name] = {};
+
+            Object.entries(fields).forEach(([fieldName, field]) => {
+                result.inputs[type.name][fieldName] = getTypeInfo(field.type);
+            });
+        }
+        if (isScalarType(type)) {
+            result.scalars.push(type.name);
+        }
+        if (isEnumType(type)) {
+            result.enums[type.name] = type.getValues().map(v => v.value);
+        }
+    });
+
+    return result;
+}

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

@@ -1,64 +1,64 @@
-import { VendureConfig } from '@vendure/core';
-import { Plugin } from 'vite';
-
-import { ConfigLoaderOptions, loadVendureConfig } from './config-loader.js';
-
-export interface ConfigLoaderApi {
-    getVendureConfig(): Promise<VendureConfig>;
-}
-
-export 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 function configLoaderPlugin(options: ConfigLoaderOptions): Plugin {
-    let vendureConfig: VendureConfig;
-    const onConfigLoaded: Array<() => void> = [];
-    return {
-        name: configLoaderName,
-        async buildStart() {
-            this.info(`Loading Vendure config...`);
-            try {
-                const result = await loadVendureConfig({
-                    tempDir: options.tempDir,
-                    vendureConfigPath: options.vendureConfigPath,
-                    vendureConfigExport: options.vendureConfigExport,
-                });
-                vendureConfig = result.vendureConfig;
-                this.info(`Vendure config loaded (using export "${result.exportedSymbolName}")`);
-            } catch (e: unknown) {
-                if (e instanceof Error) {
-                    this.error(`Error loading Vendure config: ${e.message}`);
-                }
-            }
-            onConfigLoaded.forEach(fn => fn());
-        },
-        api: {
-            getVendureConfig(): Promise<VendureConfig> {
-                if (vendureConfig) {
-                    return Promise.resolve(vendureConfig);
-                } else {
-                    return new Promise<VendureConfig>(resolve => {
-                        onConfigLoaded.push(() => {
-                            resolve(vendureConfig);
-                        });
-                    });
-                }
-            },
-        } satisfies ConfigLoaderApi,
-    };
-}
-
-/**
- * Inter-plugin dependencies implemented following the pattern given here:
- * https://rollupjs.org/plugin-development/#direct-plugin-communication
- */
-export function getConfigLoaderApi(plugins: readonly Plugin[]): ConfigLoaderApi {
-    const parentPlugin = plugins.find(plugin => plugin.name === configLoaderName);
-    if (!parentPlugin) {
-        throw new Error(`This plugin depends on the "${configLoaderName}" plugin.`);
-    }
-    return parentPlugin.api as ConfigLoaderApi;
-}
+import { VendureConfig } from '@vendure/core';
+import { Plugin } from 'vite';
+
+import { ConfigLoaderOptions, loadVendureConfig } from './config-loader.js';
+
+export interface ConfigLoaderApi {
+    getVendureConfig(): Promise<VendureConfig>;
+}
+
+export 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 function configLoaderPlugin(options: ConfigLoaderOptions): Plugin {
+    let vendureConfig: VendureConfig;
+    const onConfigLoaded: Array<() => void> = [];
+    return {
+        name: configLoaderName,
+        async buildStart() {
+            this.info(`Loading Vendure config...`);
+            try {
+                const result = await loadVendureConfig({
+                    tempDir: options.tempDir,
+                    vendureConfigPath: options.vendureConfigPath,
+                    vendureConfigExport: options.vendureConfigExport,
+                });
+                vendureConfig = result.vendureConfig;
+                this.info(`Vendure config loaded (using export "${result.exportedSymbolName}")`);
+            } catch (e: unknown) {
+                if (e instanceof Error) {
+                    this.error(`Error loading Vendure config: ${e.message}`);
+                }
+            }
+            onConfigLoaded.forEach(fn => fn());
+        },
+        api: {
+            getVendureConfig(): Promise<VendureConfig> {
+                if (vendureConfig) {
+                    return Promise.resolve(vendureConfig);
+                } else {
+                    return new Promise<VendureConfig>(resolve => {
+                        onConfigLoaded.push(() => {
+                            resolve(vendureConfig);
+                        });
+                    });
+                }
+            },
+        } satisfies ConfigLoaderApi,
+    };
+}
+
+/**
+ * Inter-plugin dependencies implemented following the pattern given here:
+ * https://rollupjs.org/plugin-development/#direct-plugin-communication
+ */
+export function getConfigLoaderApi(plugins: readonly Plugin[]): ConfigLoaderApi {
+    const parentPlugin = plugins.find(plugin => plugin.name === configLoaderName);
+    if (!parentPlugin) {
+        throw new Error(`This plugin depends on the "${configLoaderName}" plugin.`);
+    }
+    return parentPlugin.api as ConfigLoaderApi;
+}

package/vite/vite-plugin-config.ts

@@ -1,42 +1,42 @@
-import path from 'path';
-import { Plugin, UserConfig } from 'vite';
-
-export function viteConfigPlugin({ packageRoot }: { packageRoot: string }): Plugin {
-    return {
-        name: 'vendure:vite-config-plugin',
-        config: (config: UserConfig) => {
-            config.root = packageRoot;
-            config.resolve = {
-                alias: {
-                    '@': path.resolve(packageRoot, './src/lib'),
-                },
-            };
-            // This is required to prevent Vite from pre-bundling the
-            // dashboard source when it resides in node_modules.
-            config.optimizeDeps = {
-                ...config.optimizeDeps,
-                exclude: [
-                    ...(config.optimizeDeps?.exclude || []),
-                    '@vendure/dashboard',
-                    '@/providers',
-                    '@/framework',
-                    '@/lib',
-                    '@/components',
-                    '@/hooks',
-                    'virtual:vendure-ui-config',
-                    'virtual:admin-api-schema',
-                    'virtual:dashboard-extensions',
-                ],
-                // We however do want to pre-bundle recharts, as it depends
-                // on lodash which is a CJS packages and _does_ require
-                // pre-bundling.
-                include: [
-                    ...(config.optimizeDeps?.include || []),
-                    '@/components > recharts',
-                    '@/components > react-dropzone',
-                ],
-            };
-            return config;
-        },
-    };
-}
+import path from 'path';
+import { Plugin, UserConfig } from 'vite';
+
+export function viteConfigPlugin({ packageRoot }: { packageRoot: string }): Plugin {
+    return {
+        name: 'vendure:vite-config-plugin',
+        config: (config: UserConfig) => {
+            config.root = packageRoot;
+            config.resolve = {
+                alias: {
+                    '@': path.resolve(packageRoot, './src/lib'),
+                },
+            };
+            // This is required to prevent Vite from pre-bundling the
+            // dashboard source when it resides in node_modules.
+            config.optimizeDeps = {
+                ...config.optimizeDeps,
+                exclude: [
+                    ...(config.optimizeDeps?.exclude || []),
+                    '@vendure/dashboard',
+                    '@/providers',
+                    '@/framework',
+                    '@/lib',
+                    '@/components',
+                    '@/hooks',
+                    'virtual:vendure-ui-config',
+                    'virtual:admin-api-schema',
+                    'virtual:dashboard-extensions',
+                ],
+                // We however do want to pre-bundle recharts, as it depends
+                // on lodash which is a CJS packages and _does_ require
+                // pre-bundling.
+                include: [
+                    ...(config.optimizeDeps?.include || []),
+                    '@/components > recharts',
+                    '@/components > react-dropzone',
+                ],
+            };
+            return config;
+        },
+    };
+}