@molecule/app-home-page-react 1.0.0 → 1.0.2

package/README.md

@@ -0,0 +1,93 @@
+<!--
+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-04T01:50:58.149Z
+-->
+
+# @molecule/app-home-page-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.
+
+`<Home />` — authenticated home page with personalized greeting.
+
+Renders a single H2 of the form `{home.greeting}{name|email|home.world}!`
+using the universal common-locale bond. Used as the default
+post-login landing page when the app has no app-specific dashboard.
+
+Replaces the byte-identical `pages/Home.tsx` shipped by 19 of the 38
+flagship apps that have an authenticated Home route. Apps that
+override `home.greeting` per-app (e.g. note-taking's
+"Hello, {{name}}.") get the override automatically — the page reads
+the resolved translation, which spreads the bond default beneath
+any per-app override.
+
+## Quick Start
+
+```tsx
+import { Home } from '@molecule/app-home-page-react'
+
+;<Route path="/" element={<Home />} />
+```
+
+## Type
+
+`feature`
+
+## Installation
+
+```bash
+npm install @molecule/app-home-page-react @molecule/app-auth @molecule/app-react @molecule/app-ui react
+npm install -D @types/react
+```
+
+## API
+
+### Functions
+
+#### `Home()`
+
+Authenticated home page — a personalized greeting headline.
+
+Renders a single H2 of the form:
+`{home.greeting}{user.name || user.email || home.world}!`
+
+`home.greeting` and `home.world` both come from the universal
+common-locale bond (`@molecule/app-locales-common`), so the page is
+fully translated out of the box. Apps can override `home.greeting`
+per-app (e.g. note-taking's "Hello, {{name}}.") simply by including
+the key in their own locale `ui.ts`.
+
+```typescript
+function Home(): JSX.Element
+```
+
+## Injection Notes
+
+### Requirements
+
+Peer dependencies:
+
+- `@molecule/app-auth` ^1.0.1
+- `@molecule/app-react` ^1.0.1
+- `@molecule/app-ui` ^1.0.1
+- `react` ^18.0.0 || ^19.0.0
+
+### Runtime Dependencies
+
+- `@molecule/app-auth`
+- `@molecule/app-react`
+- `@molecule/app-ui`
+- `react`
+
+- Calls `useAuth()` and `useTranslation()` — both THROW unless the tree is
+  wrapped in `@molecule/app-react`'s `AuthProvider` and `I18nProvider`
+  (scaffolded apps do this in `App.tsx`).
+- `home.greeting` / `home.world` have NO inline English fallback: they
+  resolve from `@molecule/app-locales-common`, which
+  `setupI18nDefault()` (from `@molecule/app-i18n-default-react`) merges
+  automatically. A custom i18n setup must register the common bond or the
+  raw keys render on screen.

package/package.json

@@ -1,7 +1,8 @@
 {
   "name": "@molecule/app-home-page-react",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "Authenticated home page rendering a personalized greeting (h2 with user name or fallback). Reads auth + i18n; styled via ClassMap.",
+  "homepage": "https://www.molecule.dev/packages/app-home-page-react",
   "type": "module",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -17,7 +18,8 @@
     }
   },
   "files": [
-    "dist"
+    "dist",
+    "README.md"
   ],
   "keywords": [
     "molecule",
@@ -26,21 +28,26 @@
     "react"
   ],
   "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/molecule-dev/molecule.git",
+    "directory": "packages/app/features/home-page-react"
+  },
   "devDependencies": {
     "@types/node": "26.1.2",
     "typescript": "6.0.3",
-    "vitest": "4.1.10",
-    "@molecule/app-auth": "1.0.0",
-    "@molecule/app-react": "1.0.0",
-    "@molecule/app-ui": "1.0.0",
-    "@molecule/app-locales-common": "1.0.0",
+    "vitest": "4.1.11",
+    "@molecule/app-auth": "1.1.1",
+    "@molecule/app-react": "1.5.1",
+    "@molecule/app-ui": "1.1.1",
+    "@molecule/app-locales-common": "1.0.3",
     "@types/react": "19.2.17",
     "react": "19.2.8"
   },
   "peerDependencies": {
-    "@molecule/app-auth": "^1.0.0",
-    "@molecule/app-react": "^1.0.0",
-    "@molecule/app-ui": "^1.0.0",
+    "@molecule/app-auth": "^1.0.1",
+    "@molecule/app-react": "^1.0.1",
+    "@molecule/app-ui": "^1.0.1",
     "react": "^18.0.0 || ^19.0.0"
   }
 }