@salesmind-ai/design-system 0.2.1 → 0.3.0

package/dist/i18n/index.d.ts

@@ -0,0 +1,855 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import React__default from 'react';
+import { IntlConfig, PrimitiveType, MessageDescriptor } from 'react-intl';
+export { FormattedDate, FormattedMessage, FormattedNumber, MessageDescriptor, defineMessages } from 'react-intl';
+
+interface DSIntlProviderProps {
+    /**
+     * Locale identifier (e.g., 'en', 'fr', 'de')
+     * @default 'en'
+     */
+    locale?: string;
+    /**
+     * Translated messages for the locale.
+     * If not provided, defaults to English messages.
+     */
+    messages?: Record<string, string>;
+    /**
+     * Additional IntlProvider configuration
+     */
+    intlConfig?: Partial<IntlConfig>;
+    /**
+     * Child components
+     */
+    children: React__default.ReactNode;
+}
+/**
+ * Design System IntlProvider
+ *
+ * Provides internationalization context to all design system components.
+ * Wrap your app with this provider to enable i18n support.
+ */
+declare function DSIntlProvider({ locale, messages, intlConfig, children, }: DSIntlProviderProps): react_jsx_runtime.JSX.Element;
+
+/**
+ * Design System Message Hooks
+ *
+ * Provides hooks for accessing internationalized messages in components.
+ * These hooks are optional - components can still accept string props directly.
+ *
+ * @example
+ * ```tsx
+ * import { useMessage, commonMessages } from '@salesmind-ai/design-system';
+ *
+ * function MyComponent() {
+ *   const t = useMessage();
+ *   return <button>{t(commonMessages.save)}</button>;
+ * }
+ * ```
+ */
+
+/**
+ * Format message values type
+ */
+type MessageValues = Record<string, PrimitiveType>;
+/**
+ * Hook to get a message formatter function
+ *
+ * @returns A function that formats messages
+ *
+ * @example
+ * ```tsx
+ * const t = useMessage();
+ * return <span>{t(commonMessages.loading)}</span>;
+ * ```
+ */
+declare function useMessage(): (descriptor: MessageDescriptor, values?: MessageValues) => string;
+/**
+ * Hook to get the current locale
+ *
+ * @returns The current locale string (e.g., 'en', 'fr')
+ *
+ * @example
+ * ```tsx
+ * const locale = useLocale();
+ * console.log(locale); // 'en'
+ * ```
+ */
+declare function useLocale(): string;
+/**
+ * Hook to check if RTL is needed for current locale
+ *
+ * @returns true if the current locale is RTL
+ *
+ * @example
+ * ```tsx
+ * const isRTL = useIsRTL();
+ * return <div style={{ direction: isRTL ? 'rtl' : 'ltr' }}>...</div>;
+ * ```
+ */
+declare function useIsRTL(): boolean;
+/**
+ * Hook to get the current text direction
+ *
+ * @returns 'rtl' or 'ltr' based on locale
+ *
+ * @example
+ * ```tsx
+ * const dir = useTextDirection();
+ * return <div dir={dir}>...</div>;
+ * ```
+ */
+declare function useTextDirection(): 'rtl' | 'ltr';
+/**
+ * Hook to format a number according to locale
+ *
+ * @returns A number formatter function
+ *
+ * @example
+ * ```tsx
+ * const formatNumber = useNumberFormat();
+ * return <span>{formatNumber(1234.56)}</span>; // "1,234.56" in en-US
+ * ```
+ */
+declare function useNumberFormat(): (value: number, options?: Intl.NumberFormatOptions) => string;
+/**
+ * Hook to format a date according to locale
+ *
+ * @returns A date formatter function
+ *
+ * @example
+ * ```tsx
+ * const formatDate = useDateFormat();
+ * return <span>{formatDate(new Date())}</span>;
+ * ```
+ */
+declare function useDateFormat(): (value: Date | number, options?: Intl.DateTimeFormatOptions) => string;
+/**
+ * Hook to format a relative time (e.g., "2 days ago")
+ *
+ * @returns A relative time formatter function
+ *
+ * @example
+ * ```tsx
+ * const formatRelative = useRelativeTime();
+ * return <span>{formatRelative(-2, 'day')}</span>; // "2 days ago"
+ * ```
+ */
+declare function useRelativeTime(): (value: number, unit: Intl.RelativeTimeFormatUnit, options?: Intl.RelativeTimeFormatOptions) => string;
+
+/**
+ * Design System Default Messages
+ *
+ * This file contains all user-facing strings used by design system components.
+ * Components accept message props but fall back to these defaults.
+ *
+ * Format: react-intl MessageDescriptor
+ * @see https://formatjs.io/docs/react-intl/api#message-descriptor
+ */
+/**
+ * Common messages used across multiple components
+ */
+declare const commonMessages: {
+    loading: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    error: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    retry: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    cancel: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    confirm: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    close: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    save: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    delete: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    edit: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    submit: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    required: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    optional: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+};
+/**
+ * Alert component messages
+ */
+declare const alertMessages: {
+    dismissLabel: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    successTitle: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    errorTitle: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    warningTitle: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    infoTitle: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+};
+/**
+ * Toast notification messages
+ */
+declare const toastMessages: {
+    dismissLabel: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+};
+/**
+ * Dialog component messages
+ */
+declare const dialogMessages: {
+    closeLabel: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+};
+/**
+ * Form component messages
+ */
+declare const formMessages: {
+    showPassword: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    hidePassword: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    clearInput: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    invalidEmail: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    passwordRequired: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+};
+/**
+ * Auth component messages
+ */
+declare const authMessages: {
+    loginTitle: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    signupTitle: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    forgotPasswordTitle: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    emailLabel: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    passwordLabel: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    rememberMe: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    forgotPassword: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    signIn: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    signUp: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    sendResetLink: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    backToLogin: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+};
+/**
+ * Navigation component messages
+ */
+declare const navigationMessages: {
+    menuLabel: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    toggleSidebar: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    expandSubmenu: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    collapseSubmenu: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+};
+/**
+ * Report Engine component messages
+ */
+declare const reportMessages: {
+    confidenceLabel: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    dataCoverageLabel: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    insufficientData: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    exportPdf: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    exportCsv: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    exportPptx: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+};
+/**
+ * Appearance/Theme component messages
+ */
+declare const appearanceMessages: {
+    themeLabel: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    darkTheme: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    lightTheme: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    highContrastTheme: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    densityLabel: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    comfortableDensity: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    compactDensity: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+};
+/**
+ * Pagination component messages
+ */
+declare const paginationMessages: {
+    previous: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    next: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    goToPreviousPage: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    goToNextPage: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+};
+/**
+ * Calendar component messages
+ */
+declare const calendarMessages: {
+    previousMonth: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    nextMonth: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+};
+/**
+ * Carousel component messages
+ */
+declare const carouselMessages: {
+    previousSlide: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    nextSlide: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+};
+/**
+ * Methodology component messages
+ */
+declare const methodologyMessages: {
+    title: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    sampleSize: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    dataSources: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    calculation: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+};
+/**
+ * All messages combined for easy export
+ */
+declare const allMessages: {
+    title: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    sampleSize: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    dataSources: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    calculation: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    previousSlide: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    nextSlide: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    previousMonth: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    nextMonth: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    previous: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    next: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    goToPreviousPage: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    goToNextPage: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    themeLabel: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    darkTheme: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    lightTheme: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    highContrastTheme: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    densityLabel: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    comfortableDensity: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    compactDensity: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    confidenceLabel: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    dataCoverageLabel: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    insufficientData: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    exportPdf: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    exportCsv: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    exportPptx: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    menuLabel: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    toggleSidebar: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    expandSubmenu: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    collapseSubmenu: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    loginTitle: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    signupTitle: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    forgotPasswordTitle: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    emailLabel: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    passwordLabel: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    rememberMe: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    forgotPassword: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    signIn: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    signUp: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    sendResetLink: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    backToLogin: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    showPassword: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    hidePassword: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    clearInput: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    invalidEmail: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    passwordRequired: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    closeLabel: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    dismissLabel: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    successTitle: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    errorTitle: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    warningTitle: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    infoTitle: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    loading: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    error: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    retry: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    cancel: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    confirm: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    close: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    save: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    delete: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    edit: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    submit: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    required: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    optional: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+};
+
+export { DSIntlProvider, type DSIntlProviderProps, type MessageValues, alertMessages, allMessages, appearanceMessages, authMessages, calendarMessages, carouselMessages, commonMessages, dialogMessages, formMessages, methodologyMessages, navigationMessages, paginationMessages, reportMessages, toastMessages, useDateFormat, useIsRTL, useLocale, useMessage, useNumberFormat, useRelativeTime, useTextDirection };