@oxy.so/bloom 4.32.0 → 4.34.0

package/src/locale/common-messages.ts

@@ -0,0 +1,554 @@
+import { useMessages, type MessageCatalog } from './messages';
+
+/**
+ * The words every family says — a close button's name, "Loading", "Back" —
+ * in each Bloom language, so each family does not keep its own English copy.
+ * A family's own catalog holds only what is particular to it.
+ */
+export interface CommonMessages {
+  close: string;
+  /** Names a control that sets something aside: a banner's ✕, a backdrop, a sheet's handle. */
+  dismiss: string;
+  /** A navigation bar's back button. */
+  back: string;
+  /** The same, where it reads as an action rather than a place ("Go back"). */
+  goBack: string;
+  /** Names a busy region or skeleton. */
+  loading: string;
+  /** A compact overflow trigger ("More"). */
+  more: string;
+  moreOptions: string;
+  moreActions: string;
+  /** Names a progress bar. */
+  progress: string;
+  stepOf: (step: number, total: number) => string;
+  /**
+   * A control's name about one item: "More actions for Ana". The connector is
+   * the language's, never an English "for" between translated words.
+   */
+  labelFor: (label: string, subject: string) => string;
+  /** The hint on a sheet's drag handle. */
+  tapToClose: string;
+  cancel: string;
+  done: string;
+  save: string;
+  delete: string;
+  edit: string;
+  remove: string;
+  retry: string;
+  search: string;
+  showMore: string;
+  showLess: string;
+  next: string;
+  previous: string;
+  open: string;
+  menu: string;
+  copy: string;
+  copied: string;
+  send: string;
+  clear: string;
+  seeAll: string;
+}
+
+export const COMMON_MESSAGES: MessageCatalog<CommonMessages> = {
+  en: {
+    close: 'Close',
+    dismiss: 'Dismiss',
+    back: 'Back',
+    goBack: 'Go back',
+    loading: 'Loading',
+    more: 'More',
+    moreOptions: 'More options',
+    moreActions: 'More actions',
+    progress: 'Progress',
+    stepOf: (step, total) => `Step ${step} of ${total}`,
+    labelFor: (label, subject) => `${label} for ${subject}`,
+    tapToClose: 'Tap to close',
+    cancel: 'Cancel',
+    done: 'Done',
+    save: 'Save',
+    delete: 'Delete',
+    edit: 'Edit',
+    remove: 'Remove',
+    retry: 'Retry',
+    search: 'Search',
+    showMore: 'Show more',
+    showLess: 'Show less',
+    next: 'Next',
+    previous: 'Previous',
+    open: 'Open',
+    menu: 'Menu',
+    copy: 'Copy',
+    copied: 'Copied',
+    send: 'Send',
+    clear: 'Clear',
+    seeAll: 'See all',
+  },
+  es: {
+    close: 'Cerrar',
+    dismiss: 'Descartar',
+    back: 'Atrás',
+    goBack: 'Volver',
+    loading: 'Cargando',
+    more: 'Más',
+    moreOptions: 'Más opciones',
+    moreActions: 'Más acciones',
+    progress: 'Progreso',
+    stepOf: (step, total) => `Paso ${step} de ${total}`,
+    labelFor: (label, subject) => `${label} de ${subject}`,
+    tapToClose: 'Toca para cerrar',
+    cancel: 'Cancelar',
+    done: 'Hecho',
+    save: 'Guardar',
+    delete: 'Eliminar',
+    edit: 'Editar',
+    remove: 'Quitar',
+    retry: 'Reintentar',
+    search: 'Buscar',
+    showMore: 'Mostrar más',
+    showLess: 'Mostrar menos',
+    next: 'Siguiente',
+    previous: 'Anterior',
+    open: 'Abrir',
+    menu: 'Menú',
+    copy: 'Copiar',
+    copied: 'Copiado',
+    send: 'Enviar',
+    clear: 'Borrar',
+    seeAll: 'Ver todo',
+  },
+  ca: {
+    close: 'Tanca',
+    dismiss: 'Descarta',
+    back: 'Enrere',
+    goBack: 'Torna enrere',
+    loading: "S'està carregant",
+    more: 'Més',
+    moreOptions: 'Més opcions',
+    moreActions: 'Més accions',
+    progress: 'Progrés',
+    stepOf: (step, total) => `Pas ${step} de ${total}`,
+    labelFor: (label, subject) => `${label} de ${subject}`,
+    tapToClose: 'Toca per tancar',
+    cancel: 'Cancel·la',
+    done: 'Fet',
+    save: 'Desa',
+    delete: 'Suprimeix',
+    edit: 'Edita',
+    remove: 'Treu',
+    retry: 'Torna-ho a provar',
+    search: 'Cerca',
+    showMore: "Mostra'n més",
+    showLess: "Mostra'n menys",
+    next: 'Següent',
+    previous: 'Anterior',
+    open: 'Obre',
+    menu: 'Menú',
+    copy: 'Copia',
+    copied: 'Copiat',
+    send: 'Envia',
+    clear: 'Esborra',
+    seeAll: 'Mostra-ho tot',
+  },
+  de: {
+    close: 'Schließen',
+    dismiss: 'Ausblenden',
+    back: 'Zurück',
+    goBack: 'Zurückgehen',
+    loading: 'Wird geladen',
+    more: 'Mehr',
+    moreOptions: 'Weitere Optionen',
+    moreActions: 'Weitere Aktionen',
+    progress: 'Fortschritt',
+    stepOf: (step, total) => `Schritt ${step} von ${total}`,
+    labelFor: (label, subject) => `${label} für ${subject}`,
+    tapToClose: 'Zum Schließen tippen',
+    cancel: 'Abbrechen',
+    done: 'Fertig',
+    save: 'Speichern',
+    delete: 'Löschen',
+    edit: 'Bearbeiten',
+    remove: 'Entfernen',
+    retry: 'Erneut versuchen',
+    search: 'Suchen',
+    showMore: 'Mehr anzeigen',
+    showLess: 'Weniger anzeigen',
+    next: 'Weiter',
+    previous: 'Vorherige',
+    open: 'Öffnen',
+    menu: 'Menü',
+    copy: 'Kopieren',
+    copied: 'Kopiert',
+    send: 'Senden',
+    clear: 'Leeren',
+    seeAll: 'Alle anzeigen',
+  },
+  fr: {
+    close: 'Fermer',
+    dismiss: 'Ignorer',
+    back: 'Retour',
+    goBack: 'Revenir en arrière',
+    loading: 'Chargement',
+    more: 'Plus',
+    moreOptions: "Plus d'options",
+    moreActions: "Plus d'actions",
+    progress: 'Progression',
+    stepOf: (step, total) => `Étape ${step} sur ${total}`,
+    labelFor: (label, subject) => `${label} pour ${subject}`,
+    tapToClose: 'Touchez pour fermer',
+    cancel: 'Annuler',
+    done: 'Terminé',
+    save: 'Enregistrer',
+    delete: 'Supprimer',
+    edit: 'Modifier',
+    remove: 'Retirer',
+    retry: 'Réessayer',
+    search: 'Rechercher',
+    showMore: 'Afficher plus',
+    showLess: 'Afficher moins',
+    next: 'Suivant',
+    previous: 'Précédent',
+    open: 'Ouvrir',
+    menu: 'Menu',
+    copy: 'Copier',
+    copied: 'Copié',
+    send: 'Envoyer',
+    clear: 'Effacer',
+    seeAll: 'Tout afficher',
+  },
+  it: {
+    close: 'Chiudi',
+    dismiss: 'Ignora',
+    back: 'Indietro',
+    goBack: 'Torna indietro',
+    loading: 'Caricamento',
+    more: 'Altro',
+    moreOptions: 'Altre opzioni',
+    moreActions: 'Altre azioni',
+    progress: 'Avanzamento',
+    stepOf: (step, total) => `Passaggio ${step} di ${total}`,
+    labelFor: (label, subject) => `${label} per ${subject}`,
+    tapToClose: 'Tocca per chiudere',
+    cancel: 'Annulla',
+    done: 'Fine',
+    save: 'Salva',
+    delete: 'Elimina',
+    edit: 'Modifica',
+    remove: 'Rimuovi',
+    retry: 'Riprova',
+    search: 'Cerca',
+    showMore: 'Mostra di più',
+    showLess: 'Mostra di meno',
+    next: 'Avanti',
+    previous: 'Precedente',
+    open: 'Apri',
+    menu: 'Menu',
+    copy: 'Copia',
+    copied: 'Copiato',
+    send: 'Invia',
+    clear: 'Cancella',
+    seeAll: 'Mostra tutto',
+  },
+  pt: {
+    close: 'Fechar',
+    dismiss: 'Dispensar',
+    back: 'Voltar',
+    goBack: 'Voltar atrás',
+    loading: 'Carregando',
+    more: 'Mais',
+    moreOptions: 'Mais opções',
+    moreActions: 'Mais ações',
+    progress: 'Progresso',
+    stepOf: (step, total) => `Etapa ${step} de ${total}`,
+    labelFor: (label, subject) => `${label} de ${subject}`,
+    tapToClose: 'Toque para fechar',
+    cancel: 'Cancelar',
+    done: 'Concluído',
+    save: 'Salvar',
+    delete: 'Excluir',
+    edit: 'Editar',
+    remove: 'Remover',
+    retry: 'Tentar novamente',
+    search: 'Pesquisar',
+    showMore: 'Mostrar mais',
+    showLess: 'Mostrar menos',
+    next: 'Próximo',
+    previous: 'Anterior',
+    open: 'Abrir',
+    menu: 'Menu',
+    copy: 'Copiar',
+    copied: 'Copiado',
+    send: 'Enviar',
+    clear: 'Limpar',
+    seeAll: 'Ver tudo',
+  },
+  ru: {
+    close: 'Закрыть',
+    dismiss: 'Скрыть',
+    back: 'Назад',
+    goBack: 'Вернуться',
+    loading: 'Загрузка',
+    more: 'Ещё',
+    moreOptions: 'Другие параметры',
+    moreActions: 'Другие действия',
+    progress: 'Прогресс',
+    stepOf: (step, total) => `Шаг ${step} из ${total}`,
+    labelFor: (label, subject) => `${label}: ${subject}`,
+    tapToClose: 'Нажмите, чтобы закрыть',
+    cancel: 'Отмена',
+    done: 'Готово',
+    save: 'Сохранить',
+    delete: 'Удалить',
+    edit: 'Изменить',
+    remove: 'Убрать',
+    retry: 'Повторить',
+    search: 'Поиск',
+    showMore: 'Показать больше',
+    showLess: 'Показать меньше',
+    next: 'Далее',
+    previous: 'Предыдущий',
+    open: 'Открыть',
+    menu: 'Меню',
+    copy: 'Копировать',
+    copied: 'Скопировано',
+    send: 'Отправить',
+    clear: 'Очистить',
+    seeAll: 'Показать все',
+  },
+  tr: {
+    close: 'Kapat',
+    dismiss: 'Yoksay',
+    back: 'Geri',
+    goBack: 'Geri dön',
+    loading: 'Yükleniyor',
+    more: 'Daha fazla',
+    moreOptions: 'Diğer seçenekler',
+    moreActions: 'Diğer işlemler',
+    progress: 'İlerleme',
+    stepOf: (step, total) => `Adım ${step}/${total}`,
+    labelFor: (label, subject) => `${subject}: ${label}`,
+    tapToClose: 'Kapatmak için dokunun',
+    cancel: 'İptal',
+    done: 'Bitti',
+    save: 'Kaydet',
+    delete: 'Sil',
+    edit: 'Düzenle',
+    remove: 'Kaldır',
+    retry: 'Yeniden dene',
+    search: 'Ara',
+    showMore: 'Daha fazla göster',
+    showLess: 'Daha az göster',
+    next: 'İleri',
+    previous: 'Önceki',
+    open: 'Aç',
+    menu: 'Menü',
+    copy: 'Kopyala',
+    copied: 'Kopyalandı',
+    send: 'Gönder',
+    clear: 'Temizle',
+    seeAll: 'Tümünü gör',
+  },
+  ja: {
+    close: '閉じる',
+    dismiss: '非表示',
+    back: '戻る',
+    goBack: '前に戻る',
+    loading: '読み込み中',
+    more: 'その他',
+    moreOptions: 'その他のオプション',
+    moreActions: 'その他の操作',
+    progress: '進捗',
+    stepOf: (step, total) => `ステップ ${step}/${total}`,
+    labelFor: (label, subject) => `${subject}の${label}`,
+    tapToClose: 'タップして閉じる',
+    cancel: 'キャンセル',
+    done: '完了',
+    save: '保存',
+    delete: '削除',
+    edit: '編集',
+    remove: '取り除く',
+    retry: '再試行',
+    search: '検索',
+    showMore: 'もっと見る',
+    showLess: '表示を減らす',
+    next: '次へ',
+    previous: '前へ',
+    open: '開く',
+    menu: 'メニュー',
+    copy: 'コピー',
+    copied: 'コピーしました',
+    send: '送信',
+    clear: 'クリア',
+    seeAll: 'すべて表示',
+  },
+  zh: {
+    close: '关闭',
+    dismiss: '忽略',
+    back: '返回',
+    goBack: '返回上一页',
+    loading: '正在加载',
+    more: '更多',
+    moreOptions: '更多选项',
+    moreActions: '更多操作',
+    progress: '进度',
+    stepOf: (step, total) => `第 ${step} 步，共 ${total} 步`,
+    labelFor: (label, subject) => `${subject}的${label}`,
+    tapToClose: '轻触以关闭',
+    cancel: '取消',
+    done: '完成',
+    save: '保存',
+    delete: '删除',
+    edit: '编辑',
+    remove: '移除',
+    retry: '重试',
+    search: '搜索',
+    showMore: '显示更多',
+    showLess: '收起',
+    next: '下一个',
+    previous: '上一个',
+    open: '打开',
+    menu: '菜单',
+    copy: '复制',
+    copied: '已复制',
+    send: '发送',
+    clear: '清除',
+    seeAll: '查看全部',
+  },
+  ar: {
+    close: 'إغلاق',
+    dismiss: 'تجاهل',
+    back: 'رجوع',
+    goBack: 'العودة',
+    loading: 'جارٍ التحميل',
+    more: 'المزيد',
+    moreOptions: 'خيارات إضافية',
+    moreActions: 'إجراءات إضافية',
+    progress: 'التقدم',
+    stepOf: (step, total) => `الخطوة ${step} من ${total}`,
+    labelFor: (label, subject) => `${label}: ${subject}`,
+    tapToClose: 'انقر للإغلاق',
+    cancel: 'إلغاء',
+    done: 'تم',
+    save: 'حفظ',
+    delete: 'حذف',
+    edit: 'تعديل',
+    remove: 'إزالة',
+    retry: 'إعادة المحاولة',
+    search: 'بحث',
+    showMore: 'عرض المزيد',
+    showLess: 'عرض أقل',
+    next: 'التالي',
+    previous: 'السابق',
+    open: 'فتح',
+    menu: 'القائمة',
+    copy: 'نسخ',
+    copied: 'تم النسخ',
+    send: 'إرسال',
+    clear: 'مسح',
+    seeAll: 'عرض الكل',
+  },
+  hi: {
+    close: 'बंद करें',
+    dismiss: 'ख़ारिज करें',
+    back: 'वापस',
+    goBack: 'वापस जाएं',
+    loading: 'लोड हो रहा है',
+    more: 'और',
+    moreOptions: 'और विकल्प',
+    moreActions: 'और कार्रवाइयां',
+    progress: 'प्रगति',
+    stepOf: (step, total) => `चरण ${step} / ${total}`,
+    labelFor: (label, subject) => `${subject} के लिए ${label}`,
+    tapToClose: 'बंद करने के लिए टैप करें',
+    cancel: 'रद्द करें',
+    done: 'हो गया',
+    save: 'सहेजें',
+    delete: 'हटाएं',
+    edit: 'संपादित करें',
+    remove: 'निकालें',
+    retry: 'फिर से कोशिश करें',
+    search: 'खोजें',
+    showMore: 'और दिखाएं',
+    showLess: 'कम दिखाएं',
+    next: 'अगला',
+    previous: 'पिछला',
+    open: 'खोलें',
+    menu: 'मेन्यू',
+    copy: 'कॉपी करें',
+    copied: 'कॉपी हो गया',
+    send: 'भेजें',
+    clear: 'साफ़ करें',
+    seeAll: 'सभी देखें',
+  },
+  bn: {
+    close: 'বন্ধ করুন',
+    dismiss: 'খারিজ করুন',
+    back: 'পিছনে',
+    goBack: 'ফিরে যান',
+    loading: 'লোড হচ্ছে',
+    more: 'আরও',
+    moreOptions: 'আরও বিকল্প',
+    moreActions: 'আরও কাজ',
+    progress: 'অগ্রগতি',
+    stepOf: (step, total) => `ধাপ ${step}/${total}`,
+    labelFor: (label, subject) => `${subject}-এর জন্য ${label}`,
+    tapToClose: 'বন্ধ করতে ট্যাপ করুন',
+    cancel: 'বাতিল',
+    done: 'সম্পন্ন',
+    save: 'সংরক্ষণ করুন',
+    delete: 'মুছুন',
+    edit: 'সম্পাদনা করুন',
+    remove: 'সরান',
+    retry: 'আবার চেষ্টা করুন',
+    search: 'অনুসন্ধান',
+    showMore: 'আরও দেখান',
+    showLess: 'কম দেখান',
+    next: 'পরবর্তী',
+    previous: 'পূর্ববর্তী',
+    open: 'খুলুন',
+    menu: 'মেনু',
+    copy: 'কপি করুন',
+    copied: 'কপি হয়েছে',
+    send: 'পাঠান',
+    clear: 'মুছে ফেলুন',
+    seeAll: 'সব দেখুন',
+  },
+  id: {
+    close: 'Tutup',
+    dismiss: 'Abaikan',
+    back: 'Kembali',
+    goBack: 'Kembali ke sebelumnya',
+    loading: 'Memuat',
+    more: 'Lainnya',
+    moreOptions: 'Opsi lainnya',
+    moreActions: 'Tindakan lainnya',
+    progress: 'Kemajuan',
+    stepOf: (step, total) => `Langkah ${step} dari ${total}`,
+    labelFor: (label, subject) => `${label} untuk ${subject}`,
+    tapToClose: 'Ketuk untuk menutup',
+    cancel: 'Batal',
+    done: 'Selesai',
+    save: 'Simpan',
+    delete: 'Hapus',
+    edit: 'Edit',
+    remove: 'Keluarkan',
+    retry: 'Coba lagi',
+    search: 'Cari',
+    showMore: 'Tampilkan lebih banyak',
+    showLess: 'Tampilkan lebih sedikit',
+    next: 'Berikutnya',
+    previous: 'Sebelumnya',
+    open: 'Buka',
+    menu: 'Menu',
+    copy: 'Salin',
+    copied: 'Disalin',
+    send: 'Kirim',
+    clear: 'Bersihkan',
+    seeAll: 'Lihat semua',
+  },
+};
+
+/** The common words in the locale in effect (prop → `LocaleProvider` → runtime). */
+export function useCommonMessages(locale?: string): CommonMessages {
+  return useMessages(COMMON_MESSAGES, locale).messages;
+}

package/src/locale/context.ts

@@ -0,0 +1,23 @@
+import { createContext, createElement, useContext, type ReactNode } from 'react';
+
+const LocaleContext = createContext<string | undefined>(undefined);
+
+/**
+ * Sets the locale every Bloom component below it formats and speaks in —
+ * month names, dates, and Bloom's own fixed strings (Cancel, Apply, …).
+ * `BloomProvider`'s `locale` prop mounts one; mount another to scope a subtree.
+ * Unset, components follow the runtime's locale.
+ */
+export function LocaleProvider({ locale, children }: { locale?: string; children?: ReactNode }) {
+  return createElement(LocaleContext.Provider, { value: locale }, children);
+}
+
+/**
+ * The locale a component should use: its own `locale` prop, else the nearest
+ * `LocaleProvider`'s, else `undefined` — which `Intl` and the message catalogs
+ * both read as "the runtime's".
+ */
+export function useBloomLocale(locale?: string): string | undefined {
+  const inherited = useContext(LocaleContext);
+  return locale ?? inherited;
+}

package/src/locale/format-date.ts

@@ -0,0 +1,28 @@
+/**
+ * `Intl.DateTimeFormat` pinned to the GREGORIAN calendar, keeping the locale's
+ * language, digits and order.
+ *
+ * Bloom's grids lay out and return Gregorian `Date`s. A locale whose default
+ * calendar is another one — `fa-IR` (Persian, year 1405), `th-TH` (Buddhist,
+ * 2569), some `ar-*` — would otherwise title a Gregorian September with
+ * another calendar's month and year, so the day a reader picks and the day the
+ * app receives disagree. `null` when the runtime cannot format at all (a bad
+ * tag), for the caller's own fallback.
+ */
+export function formatGregorian(
+  date: Date,
+  locale: string | undefined,
+  options: Intl.DateTimeFormatOptions,
+): string | null {
+  try {
+    return new Intl.DateTimeFormat(locale, { ...options, calendar: 'gregory' }).format(date);
+  } catch {
+    // An engine that rejects the `calendar` option still formats the locale's
+    // words; only a tag it cannot read at all falls through to `null`.
+    try {
+      return new Intl.DateTimeFormat(locale, options).format(date);
+    } catch {
+      return null;
+    }
+  }
+}

package/src/locale/index.ts

@@ -0,0 +1,4 @@
+export { LocaleProvider, useBloomLocale } from './context';
+export { BLOOM_LANGUAGES, resolveBloomLanguage, type BloomLanguage } from './languages';
+// `messages.ts` and `plural.ts` are how families localise themselves, not app
+// API: an app speaks through `locale` and each family's `labels` overrides.

package/src/locale/languages.ts

@@ -0,0 +1,45 @@
+/**
+ * The languages Bloom ships its own strings in — the fleet's app languages.
+ * A `MessageCatalog` must name every one of them, so adding a language here
+ * fails the type-check of every catalog until it is translated.
+ */
+export const BLOOM_LANGUAGES = [
+  'en',
+  'es',
+  'ca',
+  'de',
+  'fr',
+  'it',
+  'pt',
+  'ru',
+  'tr',
+  'ja',
+  'zh',
+  'ar',
+  'hi',
+  'bn',
+  'id',
+] as const;
+
+export type BloomLanguage = (typeof BLOOM_LANGUAGES)[number];
+
+const SUPPORTED = new Set<string>(BLOOM_LANGUAGES);
+
+/**
+ * The language a BCP 47 tag asks for, among Bloom's: its primary subtag
+ * (`es-MX` → `es`, `pt_BR` → `pt`, `ca-ES-valencia` → `ca`). Anything Bloom
+ * does not ship, and no tag at all, falls back to English.
+ */
+export function resolveBloomLanguage(locale: string | null | undefined): BloomLanguage {
+  const primary = locale?.split(/[-_]/)[0]?.toLowerCase();
+  return primary && SUPPORTED.has(primary) ? (primary as BloomLanguage) : 'en';
+}
+
+/** The runtime's own locale (the browser's, or the device's through Hermes' `Intl`). */
+export function runtimeLocale(): string | undefined {
+  try {
+    return new Intl.DateTimeFormat().resolvedOptions().locale;
+  } catch {
+    return undefined;
+  }
+}

package/src/locale/messages.ts

@@ -0,0 +1,29 @@
+import { useMemo } from 'react';
+
+import { useBloomLocale } from './context';
+import { resolveBloomLanguage, runtimeLocale, type BloomLanguage } from './languages';
+
+/**
+ * A family's fixed strings in every Bloom language. The type makes each
+ * language REQUIRED and complete, so a missing translation is a type error
+ * rather than an English word inside a translated screen.
+ */
+export type MessageCatalog<M> = Readonly<Record<BloomLanguage, M>>;
+
+/** The catalog entry for `locale`, falling back to English for a language Bloom does not ship. */
+export function pickMessages<M>(catalog: MessageCatalog<M>, locale: string | undefined): M {
+  return catalog[resolveBloomLanguage(locale ?? runtimeLocale())];
+}
+
+/**
+ * The resolved locale (prop → `LocaleProvider` → runtime) and the family's
+ * strings in it. A component still lets its `labels` prop win over these.
+ */
+export function useMessages<M>(
+  catalog: MessageCatalog<M>,
+  localeProp?: string,
+): { locale: string | undefined; messages: M } {
+  const locale = useBloomLocale(localeProp);
+  const messages = useMemo(() => pickMessages(catalog, locale), [catalog, locale]);
+  return { locale, messages };
+}