@vendure/dashboard 3.3.6-master-202507021511 → 3.3.6-master-202507030234

package/src/lib/index.ts

@@ -130,21 +130,15 @@ export * from './components/ui/tooltip.js';
 export * from './framework/alert/alert-extensions.js';
 export * from './framework/alert/alert-item.js';
 export * from './framework/alert/alerts-indicator.js';
-export * from './framework/alert/types.js';
 export * from './framework/component-registry/component-registry.js';
 export * from './framework/component-registry/dynamic-component.js';
 export * from './framework/dashboard-widget/base-widget.js';
-export * from './framework/dashboard-widget/latest-orders-widget/index.js';
 export * from './framework/dashboard-widget/latest-orders-widget/latest-orders-widget.graphql.js';
 export * from './framework/dashboard-widget/metrics-widget/chart.js';
-export * from './framework/dashboard-widget/metrics-widget/index.js';
 export * from './framework/dashboard-widget/metrics-widget/metrics-widget.graphql.js';
-export * from './framework/dashboard-widget/orders-summary/index.js';
 export * from './framework/dashboard-widget/orders-summary/order-summary-widget.graphql.js';
-export * from './framework/dashboard-widget/types.js';
 export * from './framework/dashboard-widget/widget-extensions.js';
 export * from './framework/data-table/data-table-extensions.js';
-export * from './framework/data-table/data-table-types.js';
 export * from './framework/defaults.js';
 export * from './framework/document-extension/extend-detail-form-query.js';
 export * from './framework/document-extension/extend-document.js';
@@ -159,7 +153,6 @@ export * from './framework/extension-api/logic/alerts.js';
 export * from './framework/extension-api/logic/data-table.js';
 export * from './framework/extension-api/logic/detail-forms.js';
 export * from './framework/extension-api/logic/form-components.js';
-export * from './framework/extension-api/logic/index.js';
 export * from './framework/extension-api/logic/layout.js';
 export * from './framework/extension-api/logic/navigation.js';
 export * from './framework/extension-api/logic/widgets.js';
@@ -167,7 +160,6 @@ export * from './framework/extension-api/types/alerts.js';
 export * from './framework/extension-api/types/data-table.js';
 export * from './framework/extension-api/types/detail-forms.js';
 export * from './framework/extension-api/types/form-components.js';
-export * from './framework/extension-api/types/index.js';
 export * from './framework/extension-api/types/layout.js';
 export * from './framework/extension-api/types/navigation.js';
 export * from './framework/extension-api/types/widgets.js';

package/src/lib/lib/trans.tsx

@@ -1,10 +1,10 @@
 /**
- * This is a temporary work-around because the Lingui macros do not 
+ * This is a temporary work-around because the Lingui macros do not
  * currently work when the dashboard is packaged in an npm
  * module. Related issue: https://github.com/kentcdodds/babel-plugin-macros/issues/87
  */
-export function Trans({ children }: { children: React.ReactNode }) {
-    return <>{children}</>
+export function Trans({ children }: Readonly<{ children: React.ReactNode; context?: string }>) {
+    return <>{children}</>;
 }
 
 export function useLingui() {

package/src/lib/providers/auth.tsx

@@ -70,7 +70,7 @@ const CurrentUserQuery = graphql(`
 
 export const AuthContext = React.createContext<AuthContext | null>(null);
 
-export function AuthProvider({ children }: { children: React.ReactNode }) {
+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);

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

@@ -65,7 +65,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>(() => {

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/vite/vite-plugin-config.ts

@@ -8,7 +8,7 @@ export function viteConfigPlugin({ packageRoot }: { packageRoot: string }): Plug
             // Only set the vite `root` to the dashboard package when running the dev server.
             // During a production build we still need to reference the dashboard source which
             // lives in `node_modules`, but we don't want the build output to be emitted in there.
-            // Therefore we set `root` only for `serve` and, for `build`, we instead make sure that
+            // Therefore, we set `root` only for `serve` and, for `build`, we instead make sure that
             // an `outDir` **outside** of `node_modules` is used (defaulting to the current working
             // directory if the user did not provide one already).
             config.root = packageRoot;
@@ -37,6 +37,7 @@ export function viteConfigPlugin({ packageRoot }: { packageRoot: string }): Plug
             config.resolve = {
                 alias: {
                     ...(config.resolve?.alias ?? {}),
+                    // See the readme for an explanation of this alias.
                     '@/vdb': path.resolve(packageRoot, './src/lib'),
                     '@/graphql': path.resolve(packageRoot, './src/lib/graphql'),
                 },

package/src/lib/framework/alert/types.ts

@@ -1,13 +0,0 @@
-export interface DashboardAlertDefinition<TResponse = any> {
-    id: string;
-    title: string | ((data: TResponse) => string);
-    description?: string | ((data: TResponse) => string);
-    severity: 'info' | 'warning' | 'error';
-    check: () => Promise<TResponse> | TResponse;
-    recheckInterval?: number;
-    shouldShow?: (data: TResponse) => boolean;
-    actions?: Array<{
-        label: string;
-        onClick: (data: TResponse) => void;
-    }>;
-}

package/src/lib/framework/dashboard-widget/types.ts

@@ -1,22 +0,0 @@
-import { DashboardBaseWidgetProps } from './base-widget.js';
-
-export type DashboardWidgetInstance = {
-    id: string;
-    widgetId: string;
-    layout: {
-        x: number;
-        y: number;
-        w: number;
-        h: number;
-    };
-    config?: Record<string, unknown>;
-};
-
-export type DashboardWidgetDefinition = {
-    id: string;
-    name: string;
-    component: React.ComponentType<DashboardBaseWidgetProps>;
-    defaultSize: { w: number; h: number; x?: number; y?: number };
-    minSize?: { w: number; h: number };
-    maxSize?: { w: number; h: number };
-};

package/src/lib/framework/data-table/data-table-types.ts

@@ -1,25 +0,0 @@
-import { Table } from '@tanstack/react-table';
-
-export type BulkActionContext<Item extends { id: string } & Record<string, any>> = {
-    selection: Item[];
-    table: Table<Item>;
-};
-
-export type BulkActionComponent<Item extends { id: string } & Record<string, any>> = React.FunctionComponent<
-    BulkActionContext<Item>
->;
-
-/**
- * @description
- * **Status: Developer Preview**
- *
- * A bulk action is a component that will be rendered in the bulk actions dropdown.
- *
- * @docsCategory components
- * @docsPage DataTableBulkActions
- * @since 3.4.0
- */
-export type BulkAction = {
-    order?: number;
-    component: BulkActionComponent<any>;
-};