@object-ui/i18n 3.0.3 → 3.1.0

package/src/__tests__/useObjectLabel.test.tsx

@@ -0,0 +1,131 @@
+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/index.ts

@@ -37,6 +37,9 @@ export { createI18n, getDirection, getAvailableLanguages, type I18nConfig, type
 // React integration
 export { I18nProvider, useObjectTranslation, useI18nContext, type I18nProviderProps } from './provider';
 
+// 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';

package/src/locales/ar.ts

@@ -70,6 +70,24 @@ const ar = {
     selectAllRows: 'تحديد جميع الصفوف',
     expandRow: 'توسيع الصف',
     collapseRow: 'طي الصف',
+    hideColumn: 'إخفاء العمود',
+    freezeColumn: 'تجميد العمود',
+    unfreezeColumn: 'إلغاء تجميد العمود',
+    pageInfo: 'صفحة {{current}} من {{total}}',
+    totalRecords: '{{count}} إجمالي',
+  },
+  grid: {
+    actions: 'إجراءات',
+    edit: 'تعديل',
+    delete: 'حذف',
+    export: 'تصدير',
+    exportAs: 'تصدير كـ {{format}}',
+    loading: 'جاري تحميل الشبكة...',
+    errorLoading: 'خطأ في تحميل الشبكة',
+    pullToRefresh: 'اسحب للتحديث',
+    refreshing: 'جاري التحديث…',
+    openRecord: 'فتح السجل',
+    rowHeight: 'ارتفاع الصف: {{mode}}',
   },
   calendar: {
     today: 'اليوم',
@@ -80,6 +98,31 @@ const ar = {
     allDay: 'طوال اليوم',
     noEvents: 'لا توجد أحداث',
     newEvent: 'حدث جديد',
+    moreEvents: '+{{count}} المزيد',
+  },
+  list: {
+    recordCount: '{{count}} سجلات',
+    recordCountOne: '{{count}} سجل',
+    addRecord: 'إضافة سجل',
+    tabs: 'علامات التبويب',
+    allRecords: 'جميع السجلات',
+    search: 'بحث',
+    filter: 'تصفية',
+    filterRecords: 'تصفية السجلات',
+    sort: 'ترتيب',
+    sortRecords: 'ترتيب السجلات',
+    group: 'تجميع',
+    groupBy: 'تجميع حسب',
+    export: 'تصدير',
+    exportAs: 'تصدير كـ {{format}}',
+    color: 'لون',
+    rowColor: 'لون الصف',
+    colorByField: 'تلوين حسب الحقل',
+    clear: 'مسح',
+    none: 'لا شيء',
+    hideFields: 'إخفاء الحقول',
+    noItems: 'لم يتم العثور على عناصر',
+    noItemsMessage: 'لا توجد سجلات للعرض. حاول تعديل الفلاتر أو إضافة بيانات جديدة.',
   },
   kanban: {
     addCard: 'إضافة بطاقة',
@@ -88,6 +131,41 @@ const ar = {
     deleteCard: 'حذف بطاقة',
     deleteColumn: 'حذف عمود',
   },
+  detail: {
+    back: 'رجوع',
+    edit: 'تحرير',
+    editInline: 'تحرير مباشر',
+    save: 'حفظ',
+    saveChanges: 'حفظ التغييرات',
+    editFieldsInline: 'تحرير الحقول مباشرة',
+    share: 'مشاركة',
+    duplicate: 'نسخ',
+    export: 'تصدير',
+    viewHistory: 'عرض السجل',
+    delete: 'حذف',
+    moreActions: 'المزيد من الإجراءات',
+    addToFavorites: 'إضافة إلى المفضلة',
+    removeFromFavorites: 'إزالة من المفضلة',
+    previousRecord: 'السجل السابق',
+    nextRecord: 'السجل التالي',
+    recordOf: '{{current}} من {{total}}',
+    recordNotFound: 'لم يتم العثور على السجل',
+    recordNotFoundDescription: 'السجل الذي تبحث عنه غير موجود أو ربما تم حذفه.',
+    goBack: 'رجوع',
+    details: 'التفاصيل',
+    related: 'ذات صلة',
+    relatedRecords: '{{count}} سجلات',
+    relatedRecordOne: '{{count}} سجل',
+    noRelatedRecords: 'لا توجد سجلات ذات صلة',
+    loading: 'جاري التحميل...',
+    copyToClipboard: 'نسخ إلى الحافظة',
+    copied: 'تم النسخ!',
+    deleteConfirmation: 'هل أنت متأكد أنك تريد حذف هذا السجل؟',
+    editRecord: 'تحرير السجل',
+    viewAll: 'عرض الكل',
+    new: 'جديد',
+    emptyValue: '—',
+  },
   chart: {
     noData: 'لا تتوفر بيانات للرسم البياني',
     loading: 'جاري تحميل الرسم البياني...',
@@ -99,9 +177,162 @@ const ar = {
     saveLayout: 'حفظ التخطيط',
     resetLayout: 'إعادة تعيين التخطيط',
   },
+  configPanel: {
+    save: 'حفظ',
+    discard: 'تجاهل',
+    close: 'إغلاق',
+    layout: 'التخطيط',
+    columns: 'الأعمدة',
+    gap: 'المسافة',
+    rowHeight: 'ارتفاع الصف',
+    data: 'البيانات',
+    refreshInterval: 'فترة التحديث',
+    appearance: 'المظهر',
+    title: 'العنوان',
+    showDescription: 'إظهار الوصف',
+    theme: 'السمة',
+    configuration: 'الإعداد',
+    general: 'عام',
+    advanced: 'متقدم',
+  },
+  appDesigner: {
+    createApp: 'Create Application',
+    editApp: 'Edit Application',
+    basicInfo: 'Basic Info',
+    objects: 'Objects',
+    navigation: 'Navigation',
+    branding: 'Branding',
+    appName: 'App Name',
+    appTitle: 'Title',
+    appDescription: 'Description',
+    appIcon: 'Icon',
+    template: 'Template',
+    layout: 'Layout',
+    layoutSidebar: 'Sidebar',
+    layoutHeader: 'Header',
+    layoutEmpty: 'Empty',
+    selectObjects: 'Select Objects',
+    searchObjects: 'Search objects…',
+    selectAll: 'Select All',
+    deselectAll: 'Deselect All',
+    navBuilder: 'Navigation Builder',
+    addGroup: 'Add Group',
+    addUrl: 'Add URL',
+    addSeparator: 'Add Separator',
+    noNavItems: 'No navigation items yet.',
+    logoUrl: 'Logo URL',
+    primaryColor: 'Primary Color',
+    faviconUrl: 'Favicon URL',
+    preview: 'Preview',
+    complete: 'Complete',
+    snakeCaseHint: 'Must be snake_case (e.g. my_app)',
+    modeEdit: 'Edit',
+    modePreview: 'Preview',
+    modeCode: 'Code',
+    addWidget: 'Add Widget',
+    widgetProperties: 'Widget Properties',
+    dataSource: 'Data Source',
+    valueField: 'Value Field',
+    aggregate: 'Aggregate',
+    colorVariant: 'Color Variant',
+    addComponent: 'Add Component',
+    componentProperties: 'Component Properties',
+    viewType: 'View Type',
+    fields: 'Fields',
+    toolbar: 'Toolbar',
+    showSearch: 'Show Search',
+    showFilters: 'Show Filters',
+    showSort: 'Show Sort',
+    appearance: 'Appearance',
+    rowHeight: 'Row Height',
+    stripedRows: 'Striped Rows',
+    bordered: 'Bordered',
+    livePreview: 'Live Preview',
+    stepBasicDesc: 'الاسم والعنوان والتخطيط',
+    stepObjectsDesc: 'اختيار كائنات الأعمال',
+    stepNavigationDesc: 'بناء شجرة التنقل',
+    stepBrandingDesc: 'الشعار والألوان والأيقونة',
+    noObjectsFound: 'لم يتم العثور على كائنات.',
+    noNavItemsHint: 'لا توجد عناصر تنقل بعد. حدد كائنات في الخطوة السابقة أو أضف عناصر يدويًا.',
+    separator: 'فاصل',
+    separatorLabel: '— فاصل —',
+    newGroup: 'مجموعة جديدة',
+    newLink: 'رابط جديد',
+    saveDraft: 'حفظ المسودة',
+    cancelConfirmTitle: 'تجاهل التغييرات؟',
+    cancelConfirmMessage: 'لديك تغييرات غير محفوظة. هل أنت متأكد من الإلغاء؟',
+    confirmDiscard: 'تجاهل',
+    keepEditing: 'متابعة التحرير',
+    navNoItems: 'لا توجد عناصر تنقل. انقر على الأزرار أعلاه لإضافة عناصر.',
+    navNoPreviewItems: 'لا توجد عناصر',
+    navLivePreview: 'معاينة مباشرة',
+    navCollapseGroup: 'طي المجموعة',
+    navExpandGroup: 'توسيع المجموعة',
+    navAddChild: 'إضافة عنصر فرعي',
+    navMoveUp: 'نقل لأعلى',
+    navMoveDown: 'نقل لأسفل',
+    navRemove: 'إزالة',
+    navObjectPage: 'صفحة الكائن',
+    navDashboard: 'لوحة القيادة',
+    navPage: 'صفحة',
+    navReport: 'تقرير',
+    navGroup: 'مجموعة',
+    navUrl: 'رابط',
+    navSeparator: 'فاصل',
+    navTypeObject: 'كائن',
+    navTypeDashboard: 'لوحة القيادة',
+    navTypePage: 'صفحة',
+    navTypeReport: 'تقرير',
+    navTypeUrl: 'رابط',
+    navTypeGroup: 'مجموعة',
+    navTypeSeparator: 'فاصل',
+    navTypeAction: 'إجراء',
+    navEditIcon: 'تعديل الأيقونة',
+    navToggleVisible: 'تبديل الظهور',
+    navHidden: 'مخفي',
+    navExportSchema: 'تصدير JSON',
+    navImportSchema: 'استيراد JSON',
+    navExportSuccess: 'تم تصدير هيكل التنقل',
+    navImportSuccess: 'تم استيراد هيكل التنقل',
+    navImportError: 'ملف JSON تنقل غير صالح',
+    navIconPlaceholder: 'اسم الأيقونة (مثل Users)',
+    dashboardEditor: 'محرر لوحة المعلومات',
+    noWidgets: 'لا توجد عناصر. انقر على زر أعلاه لإضافة واحد.',
+    widgetLayoutSize: 'حجم التخطيط',
+    widgetWidth: 'العرض',
+    widgetHeight: 'الارتفاع',
+    dashboardPreview: 'معاينة لوحة المعلومات',
+    noWidgetsPreview: 'لا توجد عناصر للمعاينة',
+    pageCanvasEditor: 'محرر لوحة الصفحة',
+    emptyPage: 'صفحة فارغة. انقر على زر أعلاه لإضافة مكون.',
+    pagePreview: 'معاينة الصفحة',
+    noComponentsPreview: 'لا توجد مكونات للمعاينة',
+    modePage: 'صفحة',
+    modeDashboard: 'لوحة المعلومات',
+    undo: 'تراجع',
+    redo: 'إعادة',
+    brandingEditor: 'محرر العلامة التجارية',
+    brandingExport: 'تصدير JSON',
+    brandingImport: 'استيراد JSON',
+    brandingPreview: 'معاينة',
+    brandingSampleButton: 'زر نموذجي',
+    brandingSampleText: 'هكذا سيبدو موضوع علامتك التجارية.',
+    colorPalette: 'لوحة الألوان',
+    fontFamily: 'الخط',
+    fontDefault: 'افتراضي (النظام)',
+    modeLight: 'فاتح',
+    modeDark: 'داكن',
+    mobilePreview: 'معاينة الجوال',
+  },
   console: {
     title: 'وحدة تحكم ObjectStack',
     initializing: 'جاري تهيئة التطبيق...',
+    breadcrumb: {
+      dashboards: 'لوحات المعلومات',
+      pages: 'الصفحات',
+      reports: 'التقارير',
+      system: 'النظام',
+    },
     loadingSteps: {
       connecting: 'جاري الاتصال بمصدر البيانات',
       loadingConfig: 'جاري تحميل الإعدادات',
@@ -136,6 +367,7 @@ const ar = {
       systemTheme: 'مظهر النظام',
       actions: 'الإجراءات',
       openFullSearch: 'فتح صفحة البحث الكاملة',
+      createApp: 'إنشاء تطبيق جديد',
     },
     errors: {
       somethingWentWrong: 'حدث خطأ ما',
@@ -162,6 +394,88 @@ const ar = {
       addView: 'إضافة عرض',
       designTools: 'أدوات التصميم',
       new: 'جديد',
+      configureView: 'تكوين العرض',
+      closePanel: 'إغلاق اللوحة',
+      page: 'الصفحة',
+      pageConfigHint: 'شريط الأدوات والتنقل وإعدادات غلاف العرض',
+      listConfigHint: 'عرض البيانات والأعمدة والمظهر لهذا النوع من القائمة',
+      general: 'عام',
+      generalHint: 'عنوان العرض والوصف والنوع',
+      toolbar: 'شريط الأدوات',
+      toolbarHint: 'البحث والتصفية والفرز والتجميع ومفاتيح الكثافة',
+      toolbarEnabledCount: '{{count}} of {{total}} enabled',
+      navigationSection: 'التنقل',
+      navigationHint: 'سلوك النقر على الصف وإعدادات العرض التفصيلي',
+      records: 'السجلات',
+      recordsHint: 'وضع التحديد وإضافة سجل والتحرير المباشر',
+      exportPrint: 'التصدير والطباعة',
+      exportPrintHint: 'صيغ التصدير والطباعة وعرض عدد السجلات',
+      showAllFields: 'إظهار الكل',
+      hideAllFields: 'إخفاء الكل',
+      searchFields: 'البحث في الحقول...',
+      title: 'العنوان',
+      description: 'الوصف',
+      data: 'البيانات',
+      source: 'المصدر',
+      columns: 'الأعمدة',
+      filterBy: 'تصفية حسب',
+      sortBy: 'ترتيب حسب',
+      appearance: 'المظهر',
+      showDescription: 'عرض الوصف',
+      viewType: 'نوع العرض',
+      userFilters: 'مرشحات المستخدم',
+      enableSearch: 'تفعيل البحث',
+      enableFilter: 'تفعيل التصفية',
+      enableSort: 'تفعيل الترتيب',
+      enableHideFields: 'تفعيل إخفاء الحقول',
+      enableGroup: 'تفعيل التجميع',
+      enableColor: 'تفعيل اللون',
+      enableDensity: 'تفعيل الكثافة',
+      userActions: 'إجراءات المستخدم',
+      addRecordViaForm: 'إضافة سجلات عبر النموذج',
+      advanced: 'متقدم',
+      allowExport: 'السماح بالتصدير',
+      recordCount: '{{count}} سجل',
+      noDescription: 'لا يوجد وصف',
+      none: 'لا شيء',
+      columnsConfigured: '{{count}} أعمدة',
+      save: 'حفظ',
+      discard: 'تجاهل',
+      createView: 'إنشاء عرض',
+      newView: 'عرض جديد',
+      typeOptions: 'خيارات النوع',
+      groupByField: 'حقل التجميع',
+      startDateField: 'حقل تاريخ البدء',
+      titleField: 'حقل العنوان',
+      latitudeField: 'حقل خط العرض',
+      longitudeField: 'حقل خط الطول',
+      imageField: 'حقل الصورة',
+      dateField: 'حقل التاريخ',
+      selectField: 'اختر حقلاً...',
+      gridOptionsHint: 'يستخدم عرض الشبكة الأعمدة المكونة أعلاه.',
+      groupBy: 'تجميع حسب',
+      prefixField: 'حقل البادئة',
+      fields: 'الحقول',
+      fieldsVisible: '{{count}} مرئي',
+      sortsCount: '{{count}} ترتيبات',
+      filtersCount: '{{count}} مرشحات',
+      endDateField: 'حقل تاريخ الانتهاء',
+      color: 'اللون',
+      fieldTextColor: 'لون نص الحقل',
+      rowHeight: 'ارتفاع الصف',
+      wrapHeaders: 'التفاف العناوين',
+      showFieldDescriptions: 'إظهار أوصاف الحقول',
+      collapseAllByDefault: 'طي الكل افتراضياً',
+      striped: 'صفوف مخططة',
+      bordered: 'خلايا محاطة بحدود',
+      inlineEdit: 'تحرير السجلات مباشرة',
+      addDeleteRecordsInline: 'إضافة/حذف السجلات مباشرة',
+      clickIntoRecordDetails: 'انقر لعرض تفاصيل السجل',
+      navigationMode: 'وضع التنقل',
+      navigationWidth: 'عرض التنقل',
+      navigationWidthHint: 'متاح لأوضاع التنقل: الدرج والنافذة المنبثقة والعرض المقسم',
+      openNewTab: 'فتح في علامة تبويب جديدة',
+      openNewTabHint: 'متاح لأوضاع التنقل: الصفحة والنافذة الجديدة',
     },
     localeSwitcher: {
       label: 'اللغة',