@wilshop/dashboard 3.5.5 → 3.5.7

package/src/lib/graphql/schema-enums.ts

@@ -0,0 +1,13 @@
+import { schemaInfo } from 'virtual:admin-api-schema';
+
+/**
+ * @description
+ * Runtime access to the LanguageCode enum values defined in the GraphQL schema.
+ */
+export const schemaLanguageCodes = schemaInfo.enums.LanguageCode ?? [];
+
+/**
+ * @description
+ * Runtime access to the CurrencyCode enum values defined in the GraphQL schema.
+ */
+export const schemaCurrencyCodes = schemaInfo.enums.CurrencyCode ?? [];

package/src/lib/hooks/use-alerts-context.ts

@@ -0,0 +1,10 @@
+import { AlertsContext } from '@/vdb/providers/alerts-provider.js';
+import { useContext } from 'react';
+
+export function useAlertsContext() {
+    const context = useContext(AlertsContext);
+    if (!context) {
+        throw new Error('useAlertsContext must be used within AlertsProvider');
+    }
+    return context;
+}

package/src/lib/hooks/use-alerts.ts

@@ -1,5 +1,5 @@
 import { AlertSeverity, DashboardAlertDefinition } from '@/vdb/framework/extension-api/types/alerts.js';
-import { useAlertsContext } from '@/vdb/providers/alerts-provider.js';
+import { useAlertsContext } from '@/vdb/hooks/use-alerts-context.js';
 import { useMemo } from 'react';
 
 /**

package/src/lib/hooks/use-data-table-context.ts

@@ -0,0 +1,11 @@
+'use client';
+import { DataTableContext } from '@/vdb/components/data-table/data-table-context.js';
+import { useContext } from 'react';
+
+export function useDataTableContext() {
+    const context = useContext(DataTableContext);
+    if (context === undefined) {
+        throw new Error('useDataTableContext must be used within a DataTableProvider');
+    }
+    return context;
+}

package/src/lib/hooks/use-dynamic-translations.ts

@@ -36,11 +36,18 @@ export function useDynamicTranslations() {
         return translatedDisplay !== stateTranslationId ? translatedDisplay : camelCaseToTitleCase(state);
     };
 
+    const getTranslatedRefundReason = (reason: string) => {
+        const reasonTranslationId = `refundReason.${reason}`;
+        const translatedDisplay = i18n.t(reasonTranslationId);
+        return translatedDisplay === reasonTranslationId ? camelCaseToTitleCase(reason) : translatedDisplay;
+    };
+
     return {
         getTranslatedFieldName,
         getTranslatedOrderState,
         getTranslatedFulfillmentState,
         getTranslatedPaymentState,
         getTranslatedRefundState,
+        getTranslatedRefundReason,
     };
 }

package/src/lib/hooks/use-job-queue-polling.ts

@@ -0,0 +1,160 @@
+import { api } from '@/vdb/graphql/api.js';
+import { graphql } from '@/vdb/graphql/graphql.js';
+import { useQuery } from '@tanstack/react-query';
+import { useCallback, useEffect, useRef, useState } from 'react';
+
+const JOB_LOOKBACK_MS = 5000; // Look back 5 seconds to catch jobs created before mutation returned
+const MAX_POLLING_TIMEOUT_MS = 30000;
+const INITIAL_POLL_INTERVAL_MS = 500;
+const MAX_POLL_INTERVAL_MS = 4000;
+const STORAGE_KEY_PREFIX = 'job-queue-polling:';
+
+interface StoredPollingState {
+    startTime: string;
+    expiresAt: number;
+}
+
+const jobListForPollingDocument = graphql(`
+    query JobListForPolling($options: JobListOptions) {
+        jobs(options: $options) {
+            items {
+                id
+                createdAt
+                state
+            }
+            totalItems
+        }
+    }
+`);
+
+const getStorageKey = (queueName: string) => `${STORAGE_KEY_PREFIX}${queueName}`;
+const getStoredState = (queueName: string) => {
+    try {
+        const stored = sessionStorage.getItem(getStorageKey(queueName));
+        if (stored) {
+            return JSON.parse(stored) as StoredPollingState;
+        }
+    } catch {
+        // Ignore parsing errors
+    }
+    return null;
+};
+const setStoredState = (queueName: string, state: StoredPollingState) =>
+    sessionStorage.setItem(getStorageKey(queueName), JSON.stringify(state));
+const clearStoredState = (queueName: string) => sessionStorage.removeItem(getStorageKey(queueName));
+
+/**
+ * Hook to poll a job queue until jobs complete.
+ * Waits for jobs created after polling starts to settle before calling onComplete.
+ *
+ * Polling state is persisted in sessionStorage, allowing it to survive navigation
+ * (e.g., after creating an entity) and page refresh while maintaining the correct
+ * time window for finding relevant jobs.
+ */
+export function useJobQueuePolling(queueName: string, onComplete: () => void) {
+    const [isPolling, setIsPolling] = useState(false);
+    const [pollCount, setPollCount] = useState(0);
+    const startTimeRef = useRef<string | null>(null);
+    const timeoutRef = useRef<ReturnType<typeof setTimeout> | null>(null);
+    const onCompleteRef = useRef(onComplete);
+    const hasResumedRef = useRef(false);
+
+    useEffect(() => {
+        onCompleteRef.current = onComplete;
+    }, [onComplete]);
+
+    // On mount, check for pending polling state
+    useEffect(() => {
+        if (hasResumedRef.current) return;
+        hasResumedRef.current = true;
+
+        const stored = getStoredState(queueName);
+        if (stored && Date.now() < stored.expiresAt) {
+            startTimeRef.current = stored.startTime;
+            setPollCount(0);
+            setIsPolling(true);
+
+            const remainingTime = stored.expiresAt - Date.now();
+            timeoutRef.current = setTimeout(() => {
+                setIsPolling(false);
+                startTimeRef.current = null;
+                clearStoredState(queueName);
+                onCompleteRef.current();
+            }, remainingTime);
+        } else if (stored) {
+            clearStoredState(queueName);
+        }
+    }, [queueName]);
+
+    // Calculate exponential backoff interval
+    const pollInterval = isPolling
+        ? Math.min(INITIAL_POLL_INTERVAL_MS * Math.pow(1.75, pollCount), MAX_POLL_INTERVAL_MS)
+        : false;
+
+    const { data: jobsData } = useQuery({
+        queryKey: ['jobQueuePolling', queueName],
+        queryFn: () => {
+            setPollCount(c => c + 1);
+            return api.query(jobListForPollingDocument, {
+                options: {
+                    filter: { queueName: { eq: queueName } },
+                    sort: { createdAt: 'DESC' as const },
+                    take: 10,
+                },
+            });
+        },
+        enabled: isPolling,
+        refetchInterval: pollInterval,
+    });
+
+    // Detect job completion
+    useEffect(() => {
+        const startTime = startTimeRef.current;
+        if (!isPolling || !startTime) return;
+
+        const relevantJobs = jobsData?.jobs.items.filter(j => j.createdAt >= startTime) ?? [];
+        const hasSettledJob =
+            relevantJobs.length > 0 &&
+            relevantJobs.every(j => j.state !== 'PENDING' && j.state !== 'RUNNING' && j.state !== 'RETRYING');
+
+        if (hasSettledJob) {
+            setIsPolling(false);
+            startTimeRef.current = null;
+            clearStoredState(queueName);
+            if (timeoutRef.current) {
+                clearTimeout(timeoutRef.current);
+                timeoutRef.current = null;
+            }
+            onCompleteRef.current();
+        }
+    }, [jobsData, isPolling, queueName]);
+
+    useEffect(() => {
+        return () => {
+            if (timeoutRef.current) clearTimeout(timeoutRef.current);
+        };
+    }, []);
+
+    const startPolling = useCallback(() => {
+        if (timeoutRef.current) clearTimeout(timeoutRef.current);
+
+        const startTime = new Date(Date.now() - JOB_LOOKBACK_MS).toISOString();
+        const expiresAt = Date.now() + MAX_POLLING_TIMEOUT_MS;
+
+        // Store in sessionStorage so polling can resume after navigation
+        setStoredState(queueName, { startTime, expiresAt });
+
+        startTimeRef.current = startTime;
+        setPollCount(0);
+        setIsPolling(true);
+
+        timeoutRef.current = setTimeout(() => {
+            setIsPolling(false);
+            startTimeRef.current = null;
+            clearStoredState(queueName);
+            onCompleteRef.current();
+        }, MAX_POLLING_TIMEOUT_MS);
+    }, [queueName]);
+
+    return { isPolling, startPolling };
+}

package/src/lib/hooks/use-paginated-list.ts

@@ -0,0 +1,28 @@
+import { PaginatedListContext } from '@/vdb/components/shared/paginated-list-context.js';
+import * as React from 'react';
+
+/**
+ * @description
+ * Returns the context for the paginated list data table. Must be used within a PaginatedListDataTable.
+ *
+ * @example
+ * ```ts
+ * const { refetchPaginatedList } = usePaginatedList();
+ *
+ * const mutation = useMutation({
+ *     mutationFn: api.mutate(updateFacetValueDocument),
+ *     onSuccess: () => {
+ *         refetchPaginatedList();
+ *     },
+ * });
+ * ```
+ * @docsCategory hooks
+ * @since 3.4.0
+ */
+export function usePaginatedList() {
+    const context = React.useContext(PaginatedListContext);
+    if (!context) {
+        throw new Error('usePaginatedList must be used within a PaginatedListDataTable');
+    }
+    return context;
+}

package/src/lib/hooks/use-widget-dimensions.ts

@@ -0,0 +1,12 @@
+import { WidgetContentContext } from '@/vdb/framework/dashboard-widget/base-widget.js';
+import { useLingui } from '@lingui/react/macro';
+import { useContext } from 'react';
+
+export const useWidgetDimensions = () => {
+    const { t } = useLingui();
+    const context = useContext(WidgetContentContext);
+    if (!context) {
+        throw new Error(t`useWidgetDimensions must be used within a DashboardBaseWidget`);
+    }
+    return context;
+};

package/src/lib/hooks/use-widget-filters.ts

@@ -0,0 +1,21 @@
+'use client';
+import { WidgetFiltersContext } from '@/vdb/framework/dashboard-widget/widget-filters-context.js';
+import { useLingui } from '@lingui/react/macro';
+import { useContext } from 'react';
+
+/**
+ * @description
+ * Exposes a context object for use in building Insights page widgets.
+ *
+ * @docsCategory hooks
+ * @docsPage useWidgetFilters
+ * @since 3.5.0
+ */
+export function useWidgetFilters() {
+    const { t } = useLingui();
+    const context = useContext(WidgetFiltersContext);
+    if (context === undefined) {
+        throw new Error(t`useWidgetFilters must be used within a WidgetFiltersProvider`);
+    }
+    return context;
+}

package/src/lib/index.ts

@@ -23,6 +23,7 @@ export * from './components/data-input/relation-selector.js';
 export * from './components/data-input/rich-text-input.js';
 export * from './components/data-input/select-with-options.js';
 export * from './components/data-input/slug-input.js';
+export * from './components/data-input/string-list-input.js';
 export * from './components/data-input/struct-form-input.js';
 export * from './components/data-input/text-input.js';
 export * from './components/data-input/textarea-input.js';
@@ -85,7 +86,9 @@ export * from './components/shared/asset/asset-preview.js';
 export * from './components/shared/asset/asset-properties.js';
 export * from './components/shared/assign-to-channel-bulk-action.js';
 export * from './components/shared/assign-to-channel-dialog.js';
+export * from './components/shared/assigned-channels.js';
 export * from './components/shared/assigned-facet-values.js';
+export * from './components/shared/channel-chip.js';
 export * from './components/shared/channel-code-label.js';
 export * from './components/shared/channel-selector.js';
 export * from './components/shared/configurable-operation-arg-input.js';
@@ -121,6 +124,7 @@ export * from './components/shared/logo-mark.js';
 export * from './components/shared/multi-select.js';
 export * from './components/shared/navigation-confirmation.js';
 export * from './components/shared/option-value-input.js';
+export * from './components/shared/paginated-list-context.js';
 export * from './components/shared/paginated-list-data-table.js';
 export * from './components/shared/permission-guard.js';
 export * from './components/shared/product-variant-selector.js';
@@ -267,12 +271,16 @@ export * from './graphql/api.js';
 export * from './graphql/common-operations.js';
 export * from './graphql/fragments.js';
 export * from './graphql/graphql.js';
+export * from './graphql/schema-enums.js';
 export * from './graphql/settings-store-operations.js';
+export * from './hooks/use-alerts-context.js';
 export * from './hooks/use-alerts.js';
 export * from './hooks/use-auth.js';
 export * from './hooks/use-channel.js';
 export * from './hooks/use-custom-field-config.js';
+export * from './hooks/use-data-table-context.js';
 export * from './hooks/use-display-locale.js';
+export * from './hooks/use-drag-and-drop.js';
 export * from './hooks/use-dynamic-translations.js';
 export * from './hooks/use-extended-detail-query.js';
 export * from './hooks/use-extended-list-query.js';
@@ -282,12 +290,16 @@ export * from './hooks/use-local-format.js';
 export * from './hooks/use-mobile.js';
 export * from './hooks/use-page-block.js';
 export * from './hooks/use-page.js';
+export * from './hooks/use-paginated-list.js';
 export * from './hooks/use-permissions.js';
 export * from './hooks/use-saved-views.js';
 export * from './hooks/use-server-config.js';
+export * from './hooks/use-sorted-languages.js';
 export * from './hooks/use-theme.js';
 export * from './hooks/use-ui-language-loader.js';
 export * from './hooks/use-user-settings.js';
+export * from './hooks/use-widget-dimensions.js';
+export * from './hooks/use-widget-filters.js';
 export * from './lib/load-i18n-messages.js';
 export * from './lib/trans.js';
 export * from './lib/utils.js';

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

@@ -1,9 +1,9 @@
 import { getAlertRegistry } from '@/vdb/framework/alert/alert-extensions.js';
 import { DashboardAlertDefinition } from '@/vdb/framework/extension-api/types/alerts.js';
 import { useQueries, UseQueryOptions } from '@tanstack/react-query';
-import { createContext, ReactNode, useContext, useEffect, useState } from 'react';
+import { createContext, ReactNode, useEffect, useState } from 'react';
 
-interface AlertsContextValue {
+export interface AlertsContextValue {
     alertDefs: DashboardAlertDefinition[];
     rawResults: any[];
     dismissedAlerts: Map<string, number>;
@@ -11,7 +11,7 @@ interface AlertsContextValue {
     enabledQueries: boolean;
 }
 
-const AlertsContext = createContext<AlertsContextValue | undefined>(undefined);
+export const AlertsContext = createContext<AlertsContextValue | undefined>(undefined);
 
 export function AlertsProvider({ children }: { children: ReactNode }) {
     const initialDelayMs = 5_000;
@@ -50,11 +50,3 @@ export function AlertsProvider({ children }: { children: ReactNode }) {
         </AlertsContext.Provider>
     );
 }
-
-export function useAlertsContext() {
-    const context = useContext(AlertsContext);
-    if (!context) {
-        throw new Error('useAlertsContext must be used within AlertsProvider');
-    }
-    return context;
-}

package/src/lib/virtual.d.ts

@@ -30,9 +30,14 @@ declare module 'virtual:vendure-ui-config' {
         availableLocales: string[];
     }
 
+    interface ResolvedOrdersConfig {
+        refundReasons: Array<{ value: string; label: string }>;
+    }
+
     interface ResolvedUiConfig {
         api: ResolvedApiConfig;
         i18n: ResolvedI18nConfig;
+        orders: ResolvedOrdersConfig;
     }
 
     export const uiConfig: ResolvedUiConfig;

package/src/lib/utils/global-languages.ts

@@ -1,268 +0,0 @@
-export const globalLanguageCodes = [
-    /** Afrikaans */
-    'af',
-    /** Akan */
-    'ak',
-    /** Amharic */
-    'am',
-    /** Arabic */
-    'ar',
-    /** Assamese */
-    'as',
-    /** Azerbaijani */
-    'az',
-    /** Belarusian */
-    'be',
-    /** Bulgarian */
-    'bg',
-    /** Bambara */
-    'bm',
-    /** Bangla */
-    'bn',
-    /** Breton */
-    'br',
-    /** Bosnian */
-    'bs',
-    /** Catalan */
-    'ca',
-    /** Chechen */
-    'co',
-    /** Czech */
-    'cs',
-    /** Welsh */
-    'cy',
-    /** Danish */
-    'da',
-    /** German */
-    'de',
-    /** Ewe */
-    'ee',
-    /** Greek */
-    'el',
-    /** English */
-    'en',
-    /** Esperanto */
-    'eo',
-    /** Spanish */
-    'es',
-    /** European Spanish */
-    'es_ES',
-    /** Mexican Spanish */
-    'es_MX',
-    /** Estonian */
-    'et',
-    /** Basque */
-    'eu',
-    /** Persian */
-    'fa',
-    /** Dari */
-    'fa_AF',
-    /** Finnish */
-    'fi',
-    /** Faroese */
-    'fo',
-    /** French */
-    'fr',
-    /** Canadian French */
-    'fr_CA',
-    /** Swiss French */
-    'fr_CH',
-    /** Western Frisian */
-    'fy',
-    /** Irish */
-    'ga',
-    /** Scottish Gaelic */
-    'gd',
-    /** Galician */
-    'gl',
-    /** Gujarati */
-    'gu',
-    /** Hausa */
-    'ha',
-    /** Hebrew */
-    'he',
-    /** Hindi */
-    'hi',
-    /** Croatian */
-    'hr',
-    /** Haitian Creole */
-    'ht',
-    /** Hungarian */
-    'hu',
-    /** Armenian */
-    'hy',
-    /** Interlingua */
-    'ia',
-    /** Indonesian */
-    'id',
-    /** Igbo */
-    'ig',
-    /** Icelandic */
-    'is',
-    /** Italian */
-    'it',
-    /** Japanese */
-    'ja',
-    /** Javanese */
-    'jv',
-    /** Georgian */
-    'ka',
-    /** Kazakh */
-    'kk',
-    /** Khmer */
-    'km',
-    /** Kannada */
-    'kn',
-    /** Korean */
-    'ko',
-    /** Kurdish */
-    'ku',
-    /** Kyrgyz */
-    'ky',
-    /** Latin */
-    'la',
-    /** Luxembourgish */
-    'lb',
-    /** Ganda */
-    'lg',
-    /** Lingala */
-    'ln',
-    /** Lao */
-    'lo',
-    /** Lithuanian */
-    'lt',
-    /** Latvian */
-    'lv',
-    /** Malagasy */
-    'mg',
-    /** Maori */
-    'mi',
-    /** Macedonian */
-    'mk',
-    /** Malayalam */
-    'ml',
-    /** Mongolian */
-    'mn',
-    /** Marathi */
-    'mr',
-    /** Malay */
-    'ms',
-    /** Maltese */
-    'mt',
-    /** Burmese */
-    'my',
-    /** Norwegian Bokmål */
-    'nb',
-    /** Nepali */
-    'ne',
-    /** Dutch */
-    'nl',
-    /** Flemish */
-    'nl_BE',
-    /** Norwegian Nynorsk */
-    'nn',
-    /** Nyanja */
-    'ny',
-    /** Oromo */
-    'om',
-    /** Odia */
-    'or',
-    /** Punjabi */
-    'pa',
-    /** Polish */
-    'pl',
-    /** Pashto */
-    'ps',
-    /** Portuguese */
-    'pt',
-    /** Brazilian Portuguese */
-    'pt_BR',
-    /** European Portuguese */
-    'pt_PT',
-    /** Quechua */
-    'qu',
-    /** Romansh */
-    'rm',
-    /** Romanian */
-    'ro',
-    /** Moldavian */
-    'ro_MD',
-    /** Russian */
-    'ru',
-    /** Kinyarwanda */
-    'rw',
-    /** Sanskrit */
-    'sa',
-    /** Sindhi */
-    'sd',
-    /** Sinhala */
-    'si',
-    /** Slovak */
-    'sk',
-    /** Slovenian */
-    'sl',
-    /** Samoan */
-    'sm',
-    /** Shona */
-    'sn',
-    /** Somali */
-    'so',
-    /** Albanian */
-    'sq',
-    /** Serbian */
-    'sr',
-    /** Southern Sotho */
-    'st',
-    /** Sundanese */
-    'su',
-    /** Swedish */
-    'sv',
-    /** Swahili */
-    'sw',
-    /** Congo Swahili */
-    'sw_CD',
-    /** Tamil */
-    'ta',
-    /** Telugu */
-    'te',
-    /** Tajik */
-    'tg',
-    /** Thai */
-    'th',
-    /** Tigrinya */
-    'ti',
-    /** Turkmen */
-    'tk',
-    /** Tongan */
-    'to',
-    /** Turkish */
-    'tr',
-    /** Tatar */
-    'tt',
-    /** Uyghur */
-    'ug',
-    /** Ukrainian */
-    'uk',
-    /** Urdu */
-    'ur',
-    /** Uzbek */
-    'uz',
-    /** Vietnamese */
-    'vi',
-    /** Wolof */
-    'wo',
-    /** Xhosa */
-    'xh',
-    /** Yiddish */
-    'yi',
-    /** Yoruba */
-    'yo',
-    /** Chinese */
-    'zh',
-    /** Simplified Chinese */
-    'zh_Hans',
-    /** Traditional Chinese */
-    'zh_Hant',
-    /** Zulu */
-    'zu',
-];