@object-ui/i18n 3.3.0 → 3.3.2

package/src/__tests__/provider.test.tsx

@@ -1,117 +0,0 @@
-import { describe, it, expect, vi } from 'vitest';
-import { renderHook, waitFor, act } from '@testing-library/react';
-import React from 'react';
-import { I18nProvider, useObjectTranslation, useI18nContext } from '../provider';
-import { createI18n } from '../i18n';
-
-describe('I18nProvider', () => {
-  it('creates i18n instance from config', () => {
-    const wrapper = ({ children }: { children: React.ReactNode }) =>
-      React.createElement(I18nProvider, { config: { defaultLanguage: 'en', detectBrowserLanguage: false } }, children);
-
-    const { result } = renderHook(() => useObjectTranslation(), { wrapper });
-
-    expect(result.current.i18n).toBeDefined();
-    expect(result.current.language).toBe('en');
-  });
-
-  it('accepts pre-created instance', () => {
-    const instance = createI18n({ defaultLanguage: 'fr', detectBrowserLanguage: false });
-
-    const wrapper = ({ children }: { children: React.ReactNode }) =>
-      React.createElement(I18nProvider, { instance }, children);
-
-    const { result } = renderHook(() => useObjectTranslation(), { wrapper });
-
-    expect(result.current.i18n).toBeDefined();
-    expect(result.current.language).toBe('fr');
-  });
-});
-
-describe('useObjectTranslation', () => {
-  const wrapper = ({ children }: { children: React.ReactNode }) =>
-    React.createElement(I18nProvider, { config: { defaultLanguage: 'en', detectBrowserLanguage: false } }, children);
-
-  it('returns t, language, changeLanguage, direction, i18n', () => {
-    const { result } = renderHook(() => useObjectTranslation(), { wrapper });
-
-    expect(result.current.t).toBeTypeOf('function');
-    expect(result.current.language).toBeTypeOf('string');
-    expect(result.current.changeLanguage).toBeTypeOf('function');
-    expect(result.current.direction).toBeTypeOf('string');
-    expect(result.current.i18n).toBeDefined();
-  });
-
-  it('translates keys correctly', () => {
-    const { result } = renderHook(() => useObjectTranslation(), { wrapper });
-
-    expect(result.current.t('common.save')).toBe('Save');
-    expect(result.current.t('common.cancel')).toBe('Cancel');
-    expect(result.current.t('common.delete')).toBe('Delete');
-  });
-
-  it('returns en as default language', () => {
-    const { result } = renderHook(() => useObjectTranslation(), { wrapper });
-
-    expect(result.current.language).toBe('en');
-  });
-
-  it('works with Chinese language', () => {
-    const zhWrapper = ({ children }: { children: React.ReactNode }) =>
-      React.createElement(I18nProvider, { config: { defaultLanguage: 'zh', detectBrowserLanguage: false } }, children);
-
-    const { result } = renderHook(() => useObjectTranslation(), { wrapper: zhWrapper });
-
-    expect(result.current.language).toBe('zh');
-    expect(result.current.t('common.save')).toBe('保存');
-    expect(result.current.t('common.cancel')).toBe('取消');
-  });
-
-  it('changeLanguage updates language', async () => {
-    const { result } = renderHook(() => useObjectTranslation(), { wrapper });
-
-    expect(result.current.language).toBe('en');
-
-    await act(async () => {
-      await result.current.changeLanguage('zh');
-    });
-
-    await waitFor(() => {
-      expect(result.current.language).toBe('zh');
-    });
-  });
-
-  it('returns RTL direction for Arabic', () => {
-    const arWrapper = ({ children }: { children: React.ReactNode }) =>
-      React.createElement(I18nProvider, { config: { defaultLanguage: 'ar', detectBrowserLanguage: false } }, children);
-
-    const { result } = renderHook(() => useObjectTranslation(), { wrapper: arWrapper });
-
-    expect(result.current.direction).toBe('rtl');
-  });
-});
-
-describe('useI18nContext', () => {
-  it('throws when used outside provider', () => {
-    // Suppress console.error from React for the expected error
-    const spy = vi.spyOn(console, 'error').mockImplementation(() => {});
-
-    expect(() => {
-      renderHook(() => useI18nContext());
-    }).toThrow('useI18nContext must be used within an I18nProvider');
-
-    spy.mockRestore();
-  });
-
-  it('returns context inside provider', () => {
-    const wrapper = ({ children }: { children: React.ReactNode }) =>
-      React.createElement(I18nProvider, { config: { defaultLanguage: 'en', detectBrowserLanguage: false } }, children);
-
-    const { result } = renderHook(() => useI18nContext(), { wrapper });
-
-    expect(result.current.language).toBe('en');
-    expect(result.current.changeLanguage).toBeTypeOf('function');
-    expect(result.current.direction).toBe('ltr');
-    expect(result.current.i18n).toBeDefined();
-  });
-});

package/src/__tests__/spec-formatters.test.ts

@@ -1,208 +0,0 @@
-import { describe, it, expect } from 'vitest';
-import {
-  resolvePlural,
-  formatDateSpec,
-  formatNumberSpec,
-  applyLocaleConfig,
-  type SpecPluralRule,
-} from '../utils/spec-formatters';
-
-// ============================================================================
-// PluralRuleSchema Consumer Tests
-// ============================================================================
-
-describe('resolvePlural', () => {
-  const rule: SpecPluralRule = {
-    key: 'items.count',
-    zero: 'No items',
-    one: '{count} item',
-    other: '{count} items',
-  };
-
-  it('should resolve zero form', () => {
-    // English 'other' is used for 0 by Intl.PluralRules, but 'zero' is explicitly checked
-    // In English, 0 maps to "other" category, but we fall back to rule.other
-    const result = resolvePlural(rule, 0, 'en');
-    expect(result).toBe('0 items');
-  });
-
-  it('should resolve one form', () => {
-    expect(resolvePlural(rule, 1, 'en')).toBe('1 item');
-  });
-
-  it('should resolve other form for plural', () => {
-    expect(resolvePlural(rule, 5, 'en')).toBe('5 items');
-  });
-
-  it('should fallback to other when form is not defined', () => {
-    const simpleRule: SpecPluralRule = {
-      key: 'items',
-      other: '{count} things',
-    };
-    expect(resolvePlural(simpleRule, 3, 'en')).toBe('3 things');
-  });
-
-  it('should work with different locales', () => {
-    const ruleWithTwo: SpecPluralRule = {
-      key: 'items',
-      one: '{count} element',
-      two: '{count} éléments (dual)',
-      other: '{count} éléments',
-    };
-    // Arabic has a 'two' plural category
-    expect(resolvePlural(ruleWithTwo, 2, 'ar')).toBe('2 éléments (dual)');
-  });
-});
-
-// ============================================================================
-// DateFormatSchema Consumer Tests
-// ============================================================================
-
-describe('formatDateSpec', () => {
-  it('should format date with dateStyle', () => {
-    const date = new Date('2026-02-11T12:00:00Z');
-    const result = formatDateSpec(date, { dateStyle: 'short' }, 'en-US');
-    expect(result).toBeTruthy();
-    expect(typeof result).toBe('string');
-  });
-
-  it('should return string for invalid date', () => {
-    expect(formatDateSpec('invalid-date', { dateStyle: 'medium' })).toBe('invalid-date');
-  });
-
-  it('should handle timeZone', () => {
-    const date = new Date('2026-02-11T12:00:00Z');
-    const result = formatDateSpec(date, {
-      dateStyle: 'medium',
-      timeZone: 'America/New_York',
-    }, 'en-US');
-    expect(result).toBeTruthy();
-  });
-
-  it('should handle hour12 option', () => {
-    const date = new Date('2026-02-11T15:30:00Z');
-    const result12 = formatDateSpec(date, { timeStyle: 'short', hour12: true }, 'en-US');
-    const result24 = formatDateSpec(date, { timeStyle: 'short', hour12: false }, 'en-US');
-    expect(result12).toBeTruthy();
-    expect(result24).toBeTruthy();
-  });
-});
-
-// ============================================================================
-// NumberFormatSchema Consumer Tests
-// ============================================================================
-
-describe('formatNumberSpec', () => {
-  it('should format decimal numbers', () => {
-    const result = formatNumberSpec(1234.56, { style: 'decimal' }, 'en-US');
-    expect(result).toContain('1,234');
-  });
-
-  it('should format currency', () => {
-    const result = formatNumberSpec(42.99, {
-      style: 'currency',
-      currency: 'USD',
-    }, 'en-US');
-    expect(result).toContain('$');
-    expect(result).toContain('42.99');
-  });
-
-  it('should format percentage', () => {
-    const result = formatNumberSpec(0.75, { style: 'percent' }, 'en-US');
-    expect(result).toContain('75');
-    expect(result).toContain('%');
-  });
-
-  it('should respect fraction digits', () => {
-    const result = formatNumberSpec(3.14159, {
-      style: 'decimal',
-      maximumFractionDigits: 2,
-    }, 'en-US');
-    expect(result).toBe('3.14');
-  });
-
-  it('should respect useGrouping', () => {
-    const withGrouping = formatNumberSpec(1234567, {
-      style: 'decimal',
-      useGrouping: true,
-    }, 'en-US');
-    const withoutGrouping = formatNumberSpec(1234567, {
-      style: 'decimal',
-      useGrouping: false,
-    }, 'en-US');
-    expect(withGrouping).toContain(',');
-    expect(withoutGrouping).not.toContain(',');
-  });
-});
-
-// ============================================================================
-// LocaleConfigSchema Consumer Tests
-// ============================================================================
-
-describe('applyLocaleConfig', () => {
-  it('should create bound formatting functions', () => {
-    const locale = applyLocaleConfig({
-      code: 'en-US',
-      direction: 'ltr',
-      numberFormat: { style: 'decimal', useGrouping: true },
-      dateFormat: { dateStyle: 'medium' },
-    });
-
-    expect(locale.code).toBe('en-US');
-    expect(locale.direction).toBe('ltr');
-    expect(locale.fallbackChain).toEqual([]);
-  });
-
-  it('should format dates using configured locale', () => {
-    const locale = applyLocaleConfig({
-      code: 'en-US',
-      dateFormat: { dateStyle: 'short' },
-    });
-
-    const result = locale.formatDate(new Date('2026-02-11'));
-    expect(result).toBeTruthy();
-  });
-
-  it('should format numbers using configured locale', () => {
-    const locale = applyLocaleConfig({
-      code: 'en-US',
-      numberFormat: { style: 'decimal', maximumFractionDigits: 2 },
-    });
-
-    const result = locale.formatNumber(1234.5678);
-    expect(result).toBeTruthy();
-  });
-
-  it('should allow overrides in formatting calls', () => {
-    const locale = applyLocaleConfig({
-      code: 'en-US',
-      numberFormat: { style: 'decimal' },
-    });
-
-    const result = locale.formatNumber(42.99, {
-      style: 'currency',
-      currency: 'EUR',
-    });
-    expect(result).toContain('€');
-  });
-
-  it('should resolve plurals with configured locale', () => {
-    const locale = applyLocaleConfig({
-      code: 'en',
-    });
-
-    const rule: SpecPluralRule = {
-      key: 'items',
-      one: '{count} item',
-      other: '{count} items',
-    };
-
-    expect(locale.resolvePlural(rule, 1)).toBe('1 item');
-    expect(locale.resolvePlural(rule, 5)).toBe('5 items');
-  });
-
-  it('should default direction to ltr', () => {
-    const locale = applyLocaleConfig({ code: 'en' });
-    expect(locale.direction).toBe('ltr');
-  });
-});

package/src/__tests__/useObjectLabel.test.tsx

@@ -1,131 +0,0 @@
-import { describe, it, expect } from 'vitest';
-import { renderHook } from '@testing-library/react';
-import React from 'react';
-import { I18nProvider } from '../provider';
-import { createI18n } from '../i18n';
-import { useObjectLabel } from '../useObjectLabel';
-
-/**
- * Create a wrapper with custom translations to simulate CRM locale bundles.
- */
-function createWrapper(lang: string, translations?: Record<string, unknown>) {
-  const instance = createI18n({ defaultLanguage: lang, detectBrowserLanguage: false });
-  if (translations) {
-    instance.addResourceBundle(lang, 'translation', translations, true, true);
-  }
-  return ({ children }: { children: React.ReactNode }) =>
-    React.createElement(I18nProvider, { instance }, children);
-}
-
-describe('useObjectLabel', () => {
-  describe('objectLabel', () => {
-    it('returns the plain label when no translation exists', () => {
-      const wrapper = createWrapper('en');
-      const { result } = renderHook(() => useObjectLabel(), { wrapper });
-
-      const label = result.current.objectLabel({ name: 'order_item', label: 'Order Item' });
-      expect(label).toBe('Order Item');
-    });
-
-    it('returns the translated label when a translation exists', () => {
-      const wrapper = createWrapper('zh', {
-        crm: { objects: { order_item: { label: '订单明细' } } },
-      });
-      const { result } = renderHook(() => useObjectLabel(), { wrapper });
-
-      const label = result.current.objectLabel({ name: 'order_item', label: 'Order Item' });
-      expect(label).toBe('订单明细');
-    });
-
-    it('falls back to plain label when translation key returns empty string', () => {
-      const wrapper = createWrapper('zh', {
-        crm: { objects: { order_item: { label: '' } } },
-      });
-      const { result } = renderHook(() => useObjectLabel(), { wrapper });
-
-      const label = result.current.objectLabel({ name: 'order_item', label: 'Order Item' });
-      expect(label).toBe('Order Item');
-    });
-  });
-
-  describe('objectDescription', () => {
-    it('returns undefined when objectDef has no description', () => {
-      const wrapper = createWrapper('en');
-      const { result } = renderHook(() => useObjectLabel(), { wrapper });
-
-      const desc = result.current.objectDescription({ name: 'order_item' });
-      expect(desc).toBeUndefined();
-    });
-
-    it('returns the plain description when no translation exists', () => {
-      const wrapper = createWrapper('en');
-      const { result } = renderHook(() => useObjectLabel(), { wrapper });
-
-      const desc = result.current.objectDescription({ name: 'order_item', description: 'Line items in an order' });
-      expect(desc).toBe('Line items in an order');
-    });
-
-    it('returns the translated description when a translation exists', () => {
-      const wrapper = createWrapper('zh', {
-        crm: { objects: { order_item: { description: '订单中的商品条目' } } },
-      });
-      const { result } = renderHook(() => useObjectLabel(), { wrapper });
-
-      const desc = result.current.objectDescription({ name: 'order_item', description: 'Line items in an order' });
-      expect(desc).toBe('订单中的商品条目');
-    });
-  });
-
-  describe('fieldLabel', () => {
-    it('returns the fallback label when no translation exists', () => {
-      const wrapper = createWrapper('en');
-      const { result } = renderHook(() => useObjectLabel(), { wrapper });
-
-      const label = result.current.fieldLabel('order_item', 'name', 'Line Item');
-      expect(label).toBe('Line Item');
-    });
-
-    it('returns the translated label when a translation exists', () => {
-      const wrapper = createWrapper('zh', {
-        crm: { fields: { order_item: { name: '订单项' } } },
-      });
-      const { result } = renderHook(() => useObjectLabel(), { wrapper });
-
-      const label = result.current.fieldLabel('order_item', 'name', 'Line Item');
-      expect(label).toBe('订单项');
-    });
-
-    it('falls back to plain label when translation key returns empty string', () => {
-      const wrapper = createWrapper('zh', {
-        crm: { fields: { order_item: { name: '' } } },
-      });
-      const { result } = renderHook(() => useObjectLabel(), { wrapper });
-
-      const label = result.current.fieldLabel('order_item', 'name', 'Line Item');
-      expect(label).toBe('Line Item');
-    });
-  });
-
-  describe('multiple objects', () => {
-    it('resolves labels for different objects independently', () => {
-      const wrapper = createWrapper('zh', {
-        crm: {
-          objects: {
-            contact: { label: '联系人' },
-            opportunity: { label: '商机' },
-          },
-          fields: {
-            contact: { email: '邮箱' },
-            opportunity: { stage: '阶段' },
-          },
-        },
-      });
-      const { result } = renderHook(() => useObjectLabel(), { wrapper });
-
-      expect(result.current.objectLabel({ name: 'contact', label: 'Contact' })).toBe('联系人');
-      expect(result.current.objectLabel({ name: 'opportunity', label: 'Opportunity' })).toBe('商机');
-      expect(result.current.fieldLabel('contact', 'email', 'Email')).toBe('邮箱');
-      expect(result.current.fieldLabel('opportunity', 'stage', 'Stage')).toBe('阶段');
-    });
-  });
-});

package/src/i18n.ts

@@ -1,98 +0,0 @@
-/**
- * @object-ui/i18n - Core i18n configuration and initialization
- *
- * Wraps i18next with Object UI defaults and built-in locale support.
- */
-import i18next, { type i18n as I18nInstance } from 'i18next';
-import { builtInLocales, isRTL } from './locales/index';
-import type { TranslationKeys } from './locales/en';
-
-export interface I18nConfig {
-  /** Default language (default: 'en') */
-  defaultLanguage?: string;
-  /** Fallback language (default: 'en') */
-  fallbackLanguage?: string;
-  /** Additional translation resources to merge with built-in locales */
-  resources?: Record<string, Record<string, unknown>>;
-  /** Whether to detect browser language automatically (default: true) */
-  detectBrowserLanguage?: boolean;
-  /** i18next interpolation options */
-  interpolation?: {
-    escapeValue?: boolean;
-    prefix?: string;
-    suffix?: string;
-  };
-}
-
-/**
- * Create and initialize an i18next instance with Object UI defaults
- */
-export function createI18n(config: I18nConfig = {}): I18nInstance {
-  const {
-    defaultLanguage = 'en',
-    fallbackLanguage = 'en',
-    resources = {},
-    detectBrowserLanguage = true,
-    interpolation,
-  } = config;
-
-  // Merge built-in locales with user-provided resources
-  const mergedResources: Record<string, { translation: Record<string, unknown> }> = {};
-
-  for (const [lang, translations] of Object.entries(builtInLocales)) {
-    mergedResources[lang] = {
-      translation: {
-        ...translations,
-        ...(resources[lang] || {}),
-      },
-    };
-  }
-
-  // Add any additional languages from resources not in built-in locales
-  for (const [lang, translations] of Object.entries(resources)) {
-    if (!mergedResources[lang]) {
-      mergedResources[lang] = { translation: translations as Record<string, unknown> };
-    }
-  }
-
-  // Detect browser language if enabled
-  let lng = defaultLanguage;
-  if (detectBrowserLanguage && typeof navigator !== 'undefined') {
-    const browserLang = navigator.language?.split('-')[0];
-    if (browserLang && mergedResources[browserLang]) {
-      lng = browserLang;
-    }
-  }
-
-  const instance = i18next.createInstance();
-
-  instance.init({
-    lng,
-    fallbackLng: fallbackLanguage,
-    resources: mergedResources,
-    interpolation: {
-      escapeValue: false, // React already escapes
-      ...interpolation,
-    },
-    returnNull: false,
-  });
-
-  return instance;
-}
-
-/**
- * Get the text direction for the current language
- */
-export function getDirection(lang: string): 'ltr' | 'rtl' {
-  return isRTL(lang) ? 'rtl' : 'ltr';
-}
-
-/**
- * Get available languages from an i18n instance
- */
-export function getAvailableLanguages(instance: I18nInstance): string[] {
-  const resources = instance.options.resources;
-  return resources ? Object.keys(resources) : [];
-}
-
-export type { TranslationKeys };

package/src/index.ts

@@ -1,81 +0,0 @@
-/**
- * @object-ui/i18n
- *
- * Internationalization (i18n) support for Object UI.
- * Provides 10+ built-in language packs, RTL support, and date/currency formatting.
- *
- * @example
- * ```tsx
- * import { I18nProvider, useObjectTranslation } from '@object-ui/i18n';
- *
- * function App() {
- *   return (
- *     <I18nProvider config={{ defaultLanguage: 'zh' }}>
- *       <MyComponent />
- *     </I18nProvider>
- *   );
- * }
- *
- * function MyComponent() {
- *   const { t, language, changeLanguage, direction } = useObjectTranslation();
- *   return (
- *     <div dir={direction}>
- *       <h1>{t('common.save')}</h1>
- *       <button onClick={() => changeLanguage('en')}>English</button>
- *       <button onClick={() => changeLanguage('zh')}>中文</button>
- *     </div>
- *   );
- * }
- * ```
- *
- * @packageDocumentation
- */
-
-// Core i18n setup
-export { createI18n, getDirection, getAvailableLanguages, type I18nConfig, type TranslationKeys } from './i18n';
-
-// React integration
-export { I18nProvider, useObjectTranslation, useI18nContext, type I18nProviderProps } from './provider';
-
-// Safe translation hook factory
-export { createSafeTranslation } from './useSafeTranslation';
-
-// Convention-based object/field label i18n
-export { useObjectLabel, useSafeFieldLabel } from './useObjectLabel';
-
-// Locale packs
-export { builtInLocales, isRTL, RTL_LANGUAGES } from './locales/index';
-export { default as en } from './locales/en';
-export { default as zh } from './locales/zh';
-export { default as ja } from './locales/ja';
-export { default as ko } from './locales/ko';
-export { default as de } from './locales/de';
-export { default as fr } from './locales/fr';
-export { default as es } from './locales/es';
-export { default as pt } from './locales/pt';
-export { default as ru } from './locales/ru';
-export { default as ar } from './locales/ar';
-
-// Formatting utilities
-export {
-  formatDate,
-  formatDateTime,
-  formatRelativeTime,
-  formatCurrency,
-  formatNumber,
-  type DateFormatOptions,
-  type CurrencyFormatOptions,
-  type NumberFormatOptions,
-} from './utils/index';
-
-// Spec-aligned formatters (v2.0.7)
-export {
-  resolvePlural,
-  formatDateSpec,
-  formatNumberSpec,
-  applyLocaleConfig,
-  type SpecPluralRule,
-  type SpecDateFormat,
-  type SpecNumberFormat,
-  type SpecLocaleConfig,
-} from './utils/index';