@molecule/app-locales-react 1.0.0 → 1.0.1

package/README.md

@@ -0,0 +1,72 @@
+<!--
+AUTO-GENERATED — DO NOT EDIT THIS FILE.
+Generated by `mlcl sync-docs` from the package's src/index.ts JSDoc + mlcl/registry.json.
+Edits here are overwritten on the next commit (molecule's pre-commit hook regenerates).
+To change this document, edit the module-level JSDoc in src/index.ts.
+Generated: 2026-08-04T00:40:16.721Z
+-->
+
+# @molecule/app-locales-react
+
+> **Auto-generated, AI-first package reference** for the [molecule.dev](https://molecule.dev) ecosystem.
+> It is written to be read by coding agents as much as by people, and is generated from this
+> package's source — edit `src/index.ts` JSDoc, not this file.
+
+Translations for @molecule/app-react in 79 languages
+
+## Purpose
+
+Provides translations for the `@molecule/app-react` package which has 15 translation keys.
+
+## Languages
+
+79 languages supported: af, am, ar, az, be, bg, bn, bs, ca, cs, cy, da, de, el, en, es, et, eu, fa, fi, fil, fr, ga, gl, gu, ha, he, hi, hr, hu, hy, id, ig, is, it, ja, ka, kk, km, kn, ko, ky, lo, lt, lv, mk, ml, mn, mr, ms, mt, my, nb, ne, nl, pa, pl, pt, ro, ru, si, sk, sl, sq, sr, sv, sw, ta, te, th, tr, uk, ur, uz, vi, yo, zh, zh-TW, zu.
+
+## Quick Start
+
+```typescript
+import { af, am, ar } from '@molecule/app-locales-react'
+import type { ReactTranslationKey, ReactTranslations } from '@molecule/app-locales-react'
+```
+
+## Registration
+
+In an mlcl-scaffolded app, installed locale bonds are registered automatically by the app's i18n setup at startup — installing this package is normally all you need. To register manually (or in a custom app), pass the whole module to `registerLocaleModule` from `@molecule/app-i18n` at startup:
+
+```typescript
+import { registerLocaleModule } from '@molecule/app-i18n'
+import * as locales from '@molecule/app-locales-react'
+
+registerLocaleModule(locales)
+```
+
+## Editing translations
+
+`en.ts` is the canonical key set — every other language file mirrors its keys. To change or add strings, edit the locale files in this package (add new keys to `en.ts` first) or merge overrides at runtime with `addTranslations(locale, map)`. Never hand-write translations inline in feature code: features call `t(key, values, { defaultValue })` and THIS bond supplies the translations — inline strings bypass every other language.
+
+## Translation Keys
+
+| Key                                       | English                                                      |
+| ----------------------------------------- | ------------------------------------------------------------ |
+| `react.error.useAccordionOutsideProvider` | Accordion components must be used within an Accordion        |
+| `react.error.useAuthOutsideProvider`      | useAuthClient must be used within an AuthProvider            |
+| `react.error.useChatOutsideProvider`      | useChatProvider must be used within a ChatProvider           |
+| `react.error.useEditorOutsideProvider`    | useEditorProvider must be used within an EditorProvider      |
+| `react.error.useHttpOutsideProvider`      | useHttpClient must be used within an HttpProvider            |
+| `react.error.useI18nOutsideProvider`      | useI18nProvider must be used within an I18nProvider          |
+| `react.error.useLoggerOutsideProvider`    | useLoggerProvider must be used within a LoggerProvider       |
+| `react.error.usePreviewOutsideProvider`   | usePreviewProvider must be used within a PreviewProvider     |
+| `react.error.useRouterOutsideProvider`    | useRouterInstance must be used within a RouterProvider       |
+| `react.error.useStoreOutsideProvider`     | useStateProvider must be used within a StateProvider         |
+| `react.error.useStorageOutsideProvider`   | useStorageProvider must be used within a StorageProvider     |
+| `react.error.useThemeOutsideProvider`     | useThemeProvider must be used within a ThemeProvider         |
+| `react.error.useToastOutsideProvider`     | useToast must be used within a ToastProvider                 |
+| `react.error.useWorkspaceOutsideProvider` | useWorkspaceProvider must be used within a WorkspaceProvider |
+| `react.error.unsupportedMethod`           | Unsupported method: {{method}}                               |
+
+## Metadata
+
+- **Type:** locales
+- **Category:** i18n
+- **Stack:** app
+- **Translates:** `@molecule/app-react`

package/package.json

@@ -1,7 +1,12 @@
 {
   "name": "@molecule/app-locales-react",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/molecule-dev/molecule.git",
+    "directory": "packages/app/locales/react"
+  },
   "type": "module",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -12,14 +17,15 @@
     }
   },
   "files": [
-    "dist"
+    "dist",
+    "README.md"
   ],
   "scripts": {
     "build": "tsc",
     "test": "vitest run"
   },
   "peerDependencies": {
-    "@molecule/app-i18n": "^1.0.0"
+    "@molecule/app-i18n": "^1.0.1"
   },
   "devDependencies": {
     "typescript": "6.0.3",