@object-ui/i18n 6.2.3 → 7.0.0

package/CHANGELOG.md

@@ -1,5 +1,127 @@
 # @object-ui/i18n
 
+## 7.0.0
+
+### Minor Changes
+
+- 89e113c: ADR-0044 send-back-for-revision in the approvals inbox (framework #1744/#1769). Approvers get a "Send back" action (violet, with its own dialog) that ends the round as `returned` and unlocks the record; the submitter sees a revision panel on the returned request — edit-record link, optional comment, Resubmit (opens round N+1) and Recall (abandons the revision). New `returned` status badge/filter, Round-N chips (list + drawer), timeline rendering for `revise`/`resubmit` actions, `approvalsApi.sendBack/resubmit`, and ten-locale `approvalsInbox` strings.
+- 18d0339: Relabel metadata-driven UI on a language switch without a page refresh (#1319)
+
+  Switching the UI language left server-resolved metadata labels (object/field/
+  view labels, action-dialog text) in the old language until a hard refresh,
+  because renderers cache those labels by object name and never refetch on a
+  language change.
+
+  **`@object-ui/auth`** — `createAuthenticatedFetch` now folds the active
+  `<html lang>` into `Accept-Language` on API calls (never clobbering an explicit
+  header), so a switch carries the new locale on every subsequent request.
+
+  **`@object-ui/app-shell`** — `ConnectedShellInner` drops the adapter's
+  locale-blind metadata cache in the render phase and remounts the metadata
+  subtree via `key={language}`, so every renderer refetches in the new locale.
+  The adapter and its connection sit above the key and are preserved — an in-app
+  relabel, not a reconnect.
+
+  **`@object-ui/i18n`** — dev-mode missing-key warnings: `createI18n` gains
+  `warnMissingKeys` (default on outside production) wiring a deduped i18next
+  `missingKeyHandler`. `useObjectLabel`'s convention-key probes are flagged so
+  their intentional misses (which fall back to server metadata) stay silent.
+
+  Pairs with the framework-side locale-aware metadata changes in
+  `@objectstack/client` / `@objectstack/objectql` / `@objectstack/rest`.
+
+### Patch Changes
+
+- 77cc6bb: Cloud Connection bind v2 UX (cloud ADR runtime-identity-binding §2.3): the binding flow becomes one click. `CloudConnectionPanel` drops the environment-id input entirely (registration happens cloud-side at approval), auto-opens the approval page in a popup on Connect (user-code display stays as the popup-blocked fallback), and shows the registered runtime name + runtime id once bound. `DeviceAuthPage` displays the requesting device's context (`runtime_name` / `runtime_version` from the verification URL) plus an "only approve if you started this" warning — the informed-consent surface for the RFC 8628 flow. Two new `auth.device.*` keys across all locales.
+- 97c6831: Localize AI workspace, shell navigation, startup, connection, toast, and chatbot affordance text across core console screens.
+- c09f44e: Docs: mermaid diagrams + long-doc table of contents (ADR-0046).
+
+  - **plugin-markdown** renders ```mermaid fenced blocks as diagrams (`<Mermaid>`: lazy-loaded mermaid, `securityLevel: 'strict'`, rendered post-`rehype-sanitize`by a trusted component, degrades to the raw source on error). Mermaid is text → SVG, so it stays within the v1 image/binary ban. Adds`extractToc(markdown)`— a TOC builder whose slugs are generated with the same`github-slugger` `rehype-slug`uses, so`#id` links resolve to the rendered heading anchors.
+  - **console** `DocPage` shows a sticky right-rail table of contents (h2–h3) for docs with ≥3 headings, plus an app-independent `/apps/:packageId/docs` index already added earlier.
+  - **i18n** adds `help.onThisPage` (en/zh; other locales fall back).
+
+- 6cfa330: feat(dashboard): drill "Open in list" escape hatch + unify report drill
+
+  Adopts the mainstream BI peek-then-escalate drill model. Drill-through opens an
+  in-place drawer (keep context) and offers an "Open in list →" affordance to
+  escalate to the object's full list page (sort / bulk-select / export / shareable
+  URL) — the Looker / Power BI "see records → open in page" pattern.
+
+  - New `DrillNavigationContext` (`@object-ui/react`): the app shell provides
+    `openRecordList`; the renderer stays decoupled from console routing.
+  - The drill drawers (pivot / dataset / chart / KPI) render the escape hatch when
+    a host navigation handler is present, and hide it otherwise (self-contained
+    peek). `DashboardView` provides the handler via `useOpenRecordList`.
+  - `DrillDownConfig.target` gains `'navigate'` — skip the drawer and open the
+    list directly; degrades to `'drawer'` when no host handler is available.
+  - `ReportView` drill-through now opens the same in-place drawer (peek records →
+    click a row to open a record) instead of navigating away; the escape hatch
+    preserves the previous navigate-to-list behavior. Dashboard and report drill
+    are now unified.
+  - i18n: `dashboard.openInList` (en / zh).
+
+- 0ad72a6: fix: pass full gantt config to renderer, render multi-value lookups in gantt tooltips, persist `bodyExtra` on dataSource actions, and complete zh/en gantt labels
+
+  Four platform gaps that the EHR app previously worked around with `node_modules` patches:
+
+  - **app-shell / ObjectView** — the `config.gantt → renderer props` adapter was a hardcoded 6-field whitelist, so `parentField`/`typeField` (and `baseline*`, `groupByField`, `resourceView`, `tooltipFields`, `quickFilters`, …) never reached the renderer and the chart degraded to a flat list. It now spreads the full `viewDef.gantt` first, then applies the three required defaults last (mirroring the gallery branch).
+  - **plugin-gantt / ObjectGantt** — the tooltip value formatter only handled single-object lookups, so a multi-value lookup (a populated `[{name},{name}]` array) fell through to `'—'`. It now maps each array element to its display value and joins them.
+  - **app-shell / useConsoleActionRuntime** — `bodyExtra` was merged only on the absolute-HTTP path; the generic `dataSource.update` path ignored it, so a pure-confirmation action (no params array) left an empty payload and persisted nothing. `bodyExtra` is now merged last on that path too, matching the documented semantics.
+  - **i18n** — added the gantt labels the 9.x renderer references but the bundles lacked: `toolbar.thisWeek/thisMonth/exportPdf/saveLayout`, `viewMode.year`, `menu.add*/removeDependency/noCandidates`, the `linkType.*` and `conflict.*` blocks, and `readOnly*` — in both `en` (canonical key source) and `zh`.
+
+- 3fa23a7: feat(header): context-aware Help & Documentation menu + app-scoped docs index
+
+  The top-right "?" was a bare external link to `docs.objectstack.ai`, duplicating
+  the left sidebar's in-product `/docs` entry and ignoring the ADR-0046 docs hub.
+  It is now an aggregated, context-aware menu:
+
+  - **This app's docs** — shown only when the current app's package owns docs
+    (matched by `_packageId`). A single-doc app deep-links straight to the
+    viewer; a multi-doc app lands on the new app-scoped index.
+  - **All documentation** — the in-product `/docs` portal.
+  - **Online documentation** — `docs.objectstack.ai` (opens in a new tab).
+
+  Docs are lazily fetched once on first menu open (names/labels only), so the menu
+  adds no cost until used; a failed fetch soft-degrades to the static entries.
+
+  Also adds the app-scoped docs index route **`/apps/:packageId/docs`**
+  (`AppDocsIndex`) — the package-scoped sibling of `/docs`, listing just that
+  app's docs — which the "This app's docs" entry targets when an app ships more
+  than one. New `help.*` strings added to the `en` and `zh` bundles (other
+  locales fall back to `en`).
+
+- 59b6bbb: i18n the managed-by empty states for system / append-only / better-auth object lists.
+
+  `resolveManagedByEmptyState` previously hardcoded English titles and messages (e.g. "No identity records", "No events recorded"), so list views for managed objects (identity, audit logs, system-generated records) rendered English regardless of locale. It now takes the `t` translator and resolves `list.managedBy.{system,appendOnly,betterAuth}.{title,message}` (English kept as `defaultValue` fallbacks); `ObjectView` passes its `t` through. Added the keys to the `en` and `zh` locale packs.
+
+- bd8b054: fix(currency): resolve the tenant default currency across the long-tail renderers
+
+  Phase 2b of the currency-resolution work (ADR-0053). The cell/field renderers
+  already funnelled through `resolveFieldCurrency` + `useLocalization` (#1856),
+  but the rest of the renderers still hard-coded `USD` or read only one of
+  `currency`/`defaultCurrency`. They now share the same resolution chain — explicit
+  field currency -> `currencyConfig.defaultCurrency` -> legacy `defaultCurrency` ->
+  tenant `localization.currency` -> plain number:
+
+  - `plugin-dashboard` `ObjectMetricWidget` (inferred currency), `ObjectDataTable`
+    (symbol-format fallback).
+  - `plugin-grid` `useColumnSummary` (footer agrees with the cells) and
+    `ObjectGrid` (compact amount + name-inferred currency cells).
+  - `plugin-detail` `DetailView` summary metrics.
+  - `plugin-gantt` `ObjectGantt` currency tooltips.
+  - `components` `element:number` (`format: 'currency'`) — tenant default instead
+    of a baked-in `USD`, and renders with the tenant locale.
+
+  `resolveFieldCurrency` now lives in `@object-ui/i18n` (co-located with
+  `useLocalization`, which supplies the tenant default); `@object-ui/fields`
+  re-exports it, so the existing import path is unchanged. No behavior change when
+  no tenant currency is configured — a field that declares its own currency, or a
+  deployment with no `localization.currency`, renders exactly as before.
+
+- 2f31406: Refine Studio package-scoped navigation and home overview.
+
+  Studio now treats the selected package as the home overview scope, flattens the root Overview sidebar group, hides the duplicate all-metadata sidebar entry, redirects the invalid package metadata route to package management, preserves the selected package across package-management navigation, and adds a localized package-management sidebar label.
+
 ## 6.2.3
 
 ## 6.2.2

package/README.md

@@ -42,7 +42,7 @@ function MyComponent() {
   return (
     <div dir={direction}>
       <h1>{t('common.save')}</h1>
-      <button onClick={() => changeLanguage('zh')}>中文</button>
+      <button onClick={() => changeLanguage('zh')}>Chinese</button>
       <button onClick={() => changeLanguage('ar')}>العربية</button>
     </div>
   );

package/dist/LocalizationContext.d.ts

@@ -0,0 +1,39 @@
+/**
+ * ObjectUI
+ * Copyright (c) 2024-present ObjectStack Inc.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+/**
+ * LocalizationContext — the tenant's resolved REGIONAL defaults (currency,
+ * locale) for the current request, surfaced to every renderer.
+ *
+ * This is the client half of ADR-0053: the framework resolves a workspace
+ * `localization.currency` / `locale` onto each request's ExecutionContext and
+ * exposes them at `GET /api/v1/auth/me/localization`. A fetching wrapper (in
+ * app-shell) loads them once and feeds this PURE context, so low-level field /
+ * measure renderers can resolve a currency code down to the org default —
+ * instead of hard-coding `$`/`¥`/`USD` or degrading to a bare number — without
+ * any of them depending on app-shell or making their own fetch.
+ *
+ * Undefined values mean "no tenant default known" → consumers render a plain
+ * number (the existing safe behavior).
+ */
+import * as React from 'react';
+export interface LocalizationValue {
+    /** Tenant default currency (ISO 4217), or undefined when unconfigured. */
+    currency?: string;
+    /** Tenant/display locale (BCP-47) for Intl formatting, or undefined. */
+    locale?: string;
+}
+/** Pure provider — the fetching/loading concern lives in the app shell. */
+export declare function LocalizationProvider({ value, children, }: {
+    value: LocalizationValue;
+    children: React.ReactNode;
+}): React.JSX.Element;
+/**
+ * Read the tenant regional defaults. Safe outside a provider — returns `{}`
+ * (no tenant default), so a renderer mounted standalone degrades gracefully.
+ */
+export declare function useLocalization(): LocalizationValue;

package/dist/LocalizationContext.js

@@ -0,0 +1,38 @@
+import { jsx as _jsx } from "react/jsx-runtime";
+/**
+ * ObjectUI
+ * Copyright (c) 2024-present ObjectStack Inc.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+/**
+ * LocalizationContext — the tenant's resolved REGIONAL defaults (currency,
+ * locale) for the current request, surfaced to every renderer.
+ *
+ * This is the client half of ADR-0053: the framework resolves a workspace
+ * `localization.currency` / `locale` onto each request's ExecutionContext and
+ * exposes them at `GET /api/v1/auth/me/localization`. A fetching wrapper (in
+ * app-shell) loads them once and feeds this PURE context, so low-level field /
+ * measure renderers can resolve a currency code down to the org default —
+ * instead of hard-coding `$`/`¥`/`USD` or degrading to a bare number — without
+ * any of them depending on app-shell or making their own fetch.
+ *
+ * Undefined values mean "no tenant default known" → consumers render a plain
+ * number (the existing safe behavior).
+ */
+import * as React from 'react';
+const LocalizationCtx = React.createContext({});
+/** Pure provider — the fetching/loading concern lives in the app shell. */
+export function LocalizationProvider({ value, children, }) {
+    // Stable identity unless the resolved values actually change.
+    const memo = React.useMemo(() => ({ currency: value.currency, locale: value.locale }), [value.currency, value.locale]);
+    return _jsx(LocalizationCtx.Provider, { value: memo, children: children });
+}
+/**
+ * Read the tenant regional defaults. Safe outside a provider — returns `{}`
+ * (no tenant default), so a renderer mounted standalone degrades gracefully.
+ */
+export function useLocalization() {
+    return React.useContext(LocalizationCtx);
+}

package/dist/currency.d.ts

@@ -0,0 +1,28 @@
+/**
+ * ObjectUI
+ * Copyright (c) 2024-present ObjectStack Inc.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+/**
+ * Resolve the display currency code for a currency-typed field, in precedence
+ * order: the field's explicit `currency` -> its `currencyConfig.defaultCurrency`
+ * (fixed mode) -> a legacy top-level `defaultCurrency` -> the tenant default
+ * (`localization.currency`, ADR-0053, surfaced via {@link useLocalization}).
+ * Returns `undefined` when none is known, so the renderer shows a plain number
+ * rather than guessing a symbol.
+ *
+ * This is the single resolution every field / measure / cell renderer shares -
+ * ending the per-renderer drift where some read only `currency`, others only
+ * `defaultCurrency`, and others `currencyConfig`. It lives in `@object-ui/i18n`
+ * (alongside `useLocalization`) because the tenant default is a localization
+ * concern; `@object-ui/fields` re-exports it for backward compatibility.
+ */
+export declare function resolveFieldCurrency(field: {
+    currency?: string;
+    defaultCurrency?: string;
+    currencyConfig?: {
+        defaultCurrency?: string;
+    };
+} | null | undefined, tenantDefault?: string): string | undefined;

package/dist/currency.js

@@ -0,0 +1,28 @@
+/**
+ * ObjectUI
+ * Copyright (c) 2024-present ObjectStack Inc.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+/**
+ * Resolve the display currency code for a currency-typed field, in precedence
+ * order: the field's explicit `currency` -> its `currencyConfig.defaultCurrency`
+ * (fixed mode) -> a legacy top-level `defaultCurrency` -> the tenant default
+ * (`localization.currency`, ADR-0053, surfaced via {@link useLocalization}).
+ * Returns `undefined` when none is known, so the renderer shows a plain number
+ * rather than guessing a symbol.
+ *
+ * This is the single resolution every field / measure / cell renderer shares -
+ * ending the per-renderer drift where some read only `currency`, others only
+ * `defaultCurrency`, and others `currencyConfig`. It lives in `@object-ui/i18n`
+ * (alongside `useLocalization`) because the tenant default is a localization
+ * concern; `@object-ui/fields` re-exports it for backward compatibility.
+ */
+export function resolveFieldCurrency(field, tenantDefault) {
+    return (field?.currency ||
+        field?.currencyConfig?.defaultCurrency ||
+        field?.defaultCurrency ||
+        tenantDefault ||
+        undefined);
+}

package/dist/i18n.d.ts

@@ -20,7 +20,25 @@ export interface I18nConfig {
         prefix?: string;
         suffix?: string;
     };
+    /**
+     * Warn (once per key) in the dev console when a translation key is missing
+     * and the UI falls back to the key/defaultValue. Helps catch un-translated
+     * static strings while iterating. Defaults to ON outside production builds.
+     *
+     * Convention-key probes from `useObjectLabel` (object/field/view labels that
+     * intentionally fall back to server metadata) are excluded — they are not
+     * real "missing keys", just speculative lookups.
+     */
+    warnMissingKeys?: boolean;
 }
+/**
+ * Internal `t()` option flag set by `useObjectLabel` on its convention-key
+ * probes. The missing-key handler skips any lookup carrying this flag, so the
+ * deliberate object/field/view label probes (which usually miss and fall back
+ * to server metadata) never surface as dev warnings. Not part of the public
+ * API — shared between `i18n.ts` and `useObjectLabel.ts` to avoid drift.
+ */
+export declare const I18N_PROBE_FLAG = "__ouiLabelProbe";
 /**
  * Create and initialize an i18next instance with Object UI defaults
  */

package/dist/i18n.js

@@ -6,11 +6,43 @@
 import i18next from 'i18next';
 import { initReactI18next } from 'react-i18next';
 import { builtInLocales, isRTL } from './locales/index';
+/**
+ * Internal `t()` option flag set by `useObjectLabel` on its convention-key
+ * probes. The missing-key handler skips any lookup carrying this flag, so the
+ * deliberate object/field/view label probes (which usually miss and fall back
+ * to server metadata) never surface as dev warnings. Not part of the public
+ * API — shared between `i18n.ts` and `useObjectLabel.ts` to avoid drift.
+ */
+export const I18N_PROBE_FLAG = '__ouiLabelProbe';
+/** True outside production builds (bundlers statically replace this). */
+function isDevEnv() {
+    return typeof process === 'undefined' || process.env.NODE_ENV !== 'production';
+}
+/**
+ * Build a dev-only i18next `missingKeyHandler`. Dedupes by language+key so a
+ * missing string warns once, not on every re-render, and stays silent for the
+ * convention-key probes flagged with {@link I18N_PROBE_FLAG}.
+ */
+function createMissingKeyHandler() {
+    const seen = new Set();
+    return (lngs, _ns, key, fallbackValue, _updateMissing, options) => {
+        if (options && options[I18N_PROBE_FLAG])
+            return;
+        const lng = Array.isArray(lngs) ? lngs[0] : String(lngs ?? '');
+        const dedupeKey = `${lng}:${key}`;
+        if (seen.has(dedupeKey))
+            return;
+        seen.add(dedupeKey);
+        const fb = fallbackValue ? `"${fallbackValue}"` : 'the key itself';
+        // eslint-disable-next-line no-console
+        console.warn(`[object-ui i18n] Missing translation for "${key}" (language "${lng}") — falling back to ${fb}.`);
+    };
+}
 /**
  * Create and initialize an i18next instance with Object UI defaults
  */
 export function createI18n(config = {}) {
-    const { defaultLanguage = 'en', fallbackLanguage = 'en', resources = {}, detectBrowserLanguage = true, interpolation, } = config;
+    const { defaultLanguage = 'en', fallbackLanguage = 'en', resources = {}, detectBrowserLanguage = true, interpolation, warnMissingKeys = isDevEnv(), } = config;
     // Merge built-in locales with user-provided resources
     const mergedResources = {};
     for (const [lang, translations] of Object.entries(builtInLocales)) {
@@ -50,6 +82,10 @@ export function createI18n(config = {}) {
             ...interpolation,
         },
         returnNull: false,
+        // Dev-only: surface un-translated static keys in the console (deduped,
+        // and silent for useObjectLabel's intentional convention-key probes).
+        saveMissing: warnMissingKeys,
+        missingKeyHandler: warnMissingKeys ? createMissingKeyHandler() : undefined,
         react: {
             useSuspense: false,
         },

package/dist/index.d.ts

@@ -32,7 +32,7 @@
  */
 export { createI18n, getDirection, getAvailableLanguages, type I18nConfig, type TranslationKeys } from './i18n';
 export { I18nProvider, useObjectTranslation, useI18nContext, type I18nProviderProps } from './provider';
-export { createSafeTranslation } from './useSafeTranslation';
+export { createSafeTranslation, useSafeTranslate } from './useSafeTranslation';
 export { useObjectLabel, useSafeFieldLabel } from './useObjectLabel';
 export { builtInLocales, isRTL, RTL_LANGUAGES } from './locales/index';
 export { default as en } from './locales/en';
@@ -48,3 +48,6 @@ export { default as ar } from './locales/ar';
 export { formatDate, formatDateTime, formatRelativeTime, formatCurrency, formatNumber, type DateFormatOptions, type CurrencyFormatOptions, type NumberFormatOptions, } from './utils/index';
 export { resolvePlural, formatDateSpec, formatNumberSpec, applyLocaleConfig, type SpecPluralRule, type SpecDateFormat, type SpecNumberFormat, type SpecLocaleConfig, } from './utils/index';
 export { isSpecTranslationData, transformSpecTranslations, type SpecTranslationData, } from './utils/index';
+export { pickLocalized } from './pickLocalized';
+export { LocalizationProvider, useLocalization, type LocalizationValue } from './LocalizationContext';
+export { resolveFieldCurrency } from './currency';

package/dist/index.js

@@ -35,7 +35,7 @@ export { createI18n, getDirection, getAvailableLanguages } from './i18n';
 // React integration
 export { I18nProvider, useObjectTranslation, useI18nContext } from './provider';
 // Safe translation hook factory
-export { createSafeTranslation } from './useSafeTranslation';
+export { createSafeTranslation, useSafeTranslate } from './useSafeTranslation';
 // Convention-based object/field label i18n
 export { useObjectLabel, useSafeFieldLabel } from './useObjectLabel';
 // Locale packs
@@ -58,3 +58,6 @@ export { resolvePlural, formatDateSpec, formatNumberSpec, applyLocaleConfig, } f
 // `useObjectLabel`). Exposed so apps don't have to copy/paste — see
 // `apps/console/src/loadLanguage.ts` for the canonical consumer.
 export { isSpecTranslationData, transformSpecTranslations, } from './utils/index';
+export { pickLocalized } from './pickLocalized';
+export { LocalizationProvider, useLocalization } from './LocalizationContext';
+export { resolveFieldCurrency } from './currency';