@object-ui/react 17.3.0 → 17.5.0

package/dist/utils/i18n.js

@@ -1,9 +1,47 @@
 /**
- * Resolves an I18nLabel to a plain string.
- * I18nLabel can be either a string or an object { key, defaultValue?, params? }.
- * When it's an object, we return the defaultValue or the key as fallback.
+ * Resolves objectui's KEYED i18n label to a plain string.
+ *
+ * The keyed form is `{ key, defaultValue?, params? }` — a reference INTO a
+ * translation bundle. This package has no `t()`, so it resolves the reference
+ * as far as it can without one: `defaultValue`, else the key itself. (The
+ * app-shell twin of this function takes a `t` and resolves the key properly.)
+ *
+ * ## Why this is not called `resolveI18nLabel` (objectui#4167)
+ *
+ * `@objectstack/spec` 17.0.0-rc.6 publishes a function of that exact name from
+ * `@objectstack/spec/ui`, over a DIFFERENT vocabulary: the INLINE LOCALE MAP
+ * (`{ en: 'Owner', 'zh-CN': '负责人' }`), resolved against a BCP-47 locale
+ * (`resolveI18nLabel(label, locale)`). Two resolvers, one name, and neither
+ * accepts the other's shape — which objectstack#4115 calls a planted premise
+ * rather than a naming nit, because the next agent reads the name and builds
+ * on it.
+ *
+ * rc.6 is also what made the clash dangerous rather than merely untidy. It
+ * widened the spec's `I18nLabel` from `string` to
+ * `string | Record< string, string >`, so the SAME authored value can now reach
+ * either function — and each answers wrongly for the other's input, silently:
+ *
+ *   this one, given `{ en: 'Owner' }`      → `undefined` (no `key`, no
+ *                                            `defaultValue`) → renders empty;
+ *   the spec's, given `{ key: 'nav.home' }` → treats `key`/`defaultValue`/
+ *                                            `params` as locale tags and picks
+ *                                            one of them as the display text.
+ *
+ * Neither is a type error at the call site that matters, and both look like a
+ * working render until someone reads the output. PR #4169 met this head-on and
+ * aliased the spec's import as `resolveInlineI18nLabel` in five files, with
+ * hand-written comments explaining the clash at two of them — a review
+ * convention, which is exactly what objectstack#4115 exists to replace with a
+ * rule. `Keyed` is the counterpart of that `Inline`: the name now says which
+ * vocabulary it resolves, at every call site, with no comment required.
+ *
+ * The keyed shape itself is now named too — `KeyedI18nLabel` in
+ * `@object-ui/types` (#4581) — so `BaseSchema.ariaLabel`, this parameter and
+ * the layout twin all state one type instead of three copies of one object
+ * literal. The `Inline`/`Keyed` split above is the naming half of #4167; the
+ * named shape is the declaration half.
  */
-export function resolveI18nLabel(label) {
+export function resolveKeyedI18nLabel(label) {
     if (label === undefined || label === null)
         return undefined;
     if (typeof label === 'string')

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@object-ui/react",
-  "version": "17.3.0",
+  "version": "17.5.0",
   "type": "module",
   "license": "MIT",
   "description": "React bindings and SchemaRenderer component for Object UI",
@@ -24,12 +24,12 @@
     }
   },
   "dependencies": {
-    "@objectstack/spec": "^17.0.0-rc.2",
-    "react-hook-form": "^7.83.0",
-    "@object-ui/core": "17.3.0",
-    "@object-ui/data-objectstack": "17.3.0",
-    "@object-ui/i18n": "17.3.0",
-    "@object-ui/types": "17.3.0"
+    "@objectstack/spec": "^17.0.0-rc.6",
+    "react-hook-form": "^7.84.0",
+    "@object-ui/core": "17.5.0",
+    "@object-ui/data-objectstack": "17.5.0",
+    "@object-ui/i18n": "17.5.0",
+    "@object-ui/types": "17.5.0"
   },
   "peerDependencies": {
     "react": "^18.0.0 || ^19.0.0",
@@ -65,7 +65,7 @@
   "scripts": {
     "build": "tsc",
     "test": "vitest run",
-    "type-check": "tsc --noEmit && tsc -p tsconfig.typetests.json",
+    "type-check": "tsc --noEmit && tsc -p tsconfig.test.json",
     "lint": "eslint ."
   }
 }