@retiregolden/planner-ui 0.1.0 → 0.2.0

package/src/planner/home/useHomeMode.ts

@@ -1,7 +1,7 @@
 import { useCallback, useState } from 'react'
 
 import { readLocal, STORAGE_KEYS, writeLocal } from '../../data/localStore'
-import type { PlanSummary } from '../../data/planStore'
+import type { PlanSummary } from '../../data/planStoreContext'
 
 export const WELCOME_DISMISSED_KEY = STORAGE_KEYS.homeWelcomeDismissed
 

package/src/report/ReportBrandingProvider.tsx

@@ -0,0 +1,14 @@
+import type { ReactNode } from 'react'
+
+import { ReportBrandingContext } from './brandingContext'
+import type { ReportBranding } from './reportHtml'
+
+/**
+ * Supplies report branding to hosts that mount the exported route groups
+ * directly instead of `<PlannerApp/>` (whose `reportBranding` prop does the
+ * same thing). Omit `branding` (or the provider) and downloaded reports keep
+ * the RetireGolden defaults.
+ */
+export function ReportBrandingProvider({ branding, children }: { branding?: ReportBranding; children: ReactNode }) {
+  return <ReportBrandingContext.Provider value={branding ?? null}>{children}</ReportBrandingContext.Provider>
+}

package/src/routes/groups.tsx

@@ -0,0 +1,75 @@
+/**
+ * Route-level exports: the planner's route table split into host-mountable
+ * groups. `<PlannerApp/>` composes all three; a host that owns its own
+ * plans-management chrome mounts the workspace (and usually content) groups
+ * under its router and omits the home group entirely.
+ *
+ * The groups are react-router v7 `RouteObject[]` arrays — the shape that
+ * spreads into `useRoutes` or feeds `createBrowserRouter` — rather than
+ * `<Route>` fragments, which can't cross a component boundary (`<Routes>`
+ * only reads `<Route>` children it can see literally).
+ *
+ * **Mount the groups at the host router's root.** To serve the planner under
+ * a URL prefix, put the prefix in the router's `basename` — the planner's
+ * pages navigate with root-absolute paths (`/plan/:id/…`, `/compare`,
+ * `/learn/…`), which react-router resolves against the basename. Nesting the
+ * groups under a parent route path (e.g. `path: 'planner/*'`) is NOT
+ * supported: the initial deep link would render, but the first in-app
+ * navigation would escape the prefix.
+ *
+ * Everything here stays chrome-free: pages only, no header/nav/footer and no
+ * document.title management for non-plan routes (plan routes retitle
+ * themselves in PlanWorkspace). The host owns that, as `<PlannerApp/>` does
+ * for the web app.
+ */
+
+import { Suspense, type ReactNode } from 'react'
+import { Navigate, type RouteObject } from 'react-router-dom'
+
+import { PlanPickerPage } from '../planner/PlanPickerPage'
+import { DisclaimerPage } from '../planner/DisclaimerPage'
+import { RouteFallback } from './RouteFallback'
+import { ComparePlansPage, ExamplesPage, HowTestedPage, ImportPage, LearnRoutes, PlanRoutes } from './lazyPages'
+
+function suspended(children: ReactNode) {
+  return <Suspense fallback={<RouteFallback />}>{children}</Suspense>
+}
+
+/**
+ * The plan workspace: everything under `/plan/:planId/*` (entry sections,
+ * results, Monte Carlo, scenarios, survivor, relocation, the optimizers, the
+ * report) plus cross-plan Compare. Deep links work when this group is
+ * mounted alone. Workspace pages link to `/` ("Your plans") and into the
+ * content group (`/disclaimer`, `/how-tested`, Learn) — a host mounts or
+ * redirects those paths as it sees fit.
+ */
+export const plannerWorkspaceRoutes: RouteObject[] = [
+  { path: 'plan/*', element: suspended(<PlanRoutes />) },
+  { path: 'compare', element: suspended(<ComparePlansPage />) },
+]
+
+/**
+ * Storage-independent content: the example library, the Learning Center,
+ * the disclaimer, and the "How RetireGolden is tested" trust page (linked
+ * from Results and the Disclaimer, so hosts mounting the workspace want it).
+ */
+export const plannerContentRoutes: RouteObject[] = [
+  { path: 'examples', element: suspended(<ExamplesPage />) },
+  { path: 'learn/*', element: suspended(<LearnRoutes />) },
+  { path: 'disclaimer', element: <DisclaimerPage /> },
+  { path: 'how-tested', element: suspended(<HowTestedPage />) },
+]
+
+/**
+ * The web app's plans-management surfaces: the home page (plan list, backup
+ * download/import, clear-all) and the file-import wizard, plus redirects for
+ * retired v1 routes. Hosts with their own library chrome omit this group.
+ */
+export const plannerHomeRoutes: RouteObject[] = [
+  { index: true, element: <PlanPickerPage /> },
+  { path: 'import', element: suspended(<ImportPage />) },
+  // Retired v1 routes now redirect into the planner.
+  { path: 'legacy', element: <Navigate to="/" replace /> },
+  { path: 'longevity', element: <Navigate to="/" replace /> },
+  { path: 'social-security', element: <Navigate to="/" replace /> },
+]

package/src/routes/lazyPages.tsx

@@ -0,0 +1,18 @@
+/**
+ * Lazy page bindings for the route groups (routes/groups.tsx), split out so
+ * each file exports only components (react-refresh boundary rule).
+ */
+
+import { lazy } from 'react'
+
+export const PlanRoutes = lazy(() => import('./PlanRoutes'))
+export const LearnRoutes = lazy(() => import('./LearnRoutes'))
+// Lazy like /plan and /learn: Examples pulls in all example builders + the Zod
+// schema, Compare pulls in the whole engine via projectPlan — eager imports
+// here would drag both into the landing entry chunk.
+export const ExamplesPage = lazy(() => import('../planner/examples/ExamplesPage').then((m) => ({ default: m.ExamplesPage })))
+export const ComparePlansPage = lazy(() => import('../planner/ComparePlansPage').then((m) => ({ default: m.ComparePlansPage })))
+// Lazy so the glob-derived test-suite manifests it embeds stay out of the landing chunk.
+export const HowTestedPage = lazy(() => import('../planner/HowTestedPage').then((m) => ({ default: m.HowTestedPage })))
+// Lazy: the import wizard pulls in the per-source mappers and the Zod schema.
+export const ImportPage = lazy(() => import('../import/ImportPage').then((m) => ({ default: m.ImportPage })))