@retiregolden/planner-ui 0.1.0 → 0.3.0

package/src/planner/examples/loadExample.ts

@@ -3,7 +3,15 @@
  */
 
 import { exampleStorageId } from '../../data/planOrigin'
-import { convertExampleToUserPlan, loadPlan, savePlan, type SavePlanResult } from '../../data/planStore'
+import {
+  convertExampleToUserPlan,
+  convertedFromExample,
+  deletePlan,
+  loadPlan,
+  savePlan,
+  type SavePlanResult,
+} from '../../data/planStore'
+import { indexedDbPlanStore, type PlanStore } from '../../data/planStoreContext'
 import type { Plan } from '@retiregolden/engine/model/plan'
 import { exampleFixedNow } from './buildContext'
 import { getExampleById, type ExamplePlan } from './registry'
@@ -81,10 +89,34 @@ export async function openExampleFresh(exampleId: string): Promise<{ ok: true; p
 
 export async function saveExampleToMyPlans(
   plan: Plan,
-  opts: { newId?: () => string } = {},
+  opts: { newId?: () => string; store?: PlanStore } = {},
 ): Promise<SavePlanResult> {
   if (plan.origin !== 'example') {
     return { ok: false, issues: ['Only library examples can be converted.'] }
   }
-  return convertExampleToUserPlan(plan, opts)
+  const { store } = opts
+  if (store === undefined || store === indexedDbPlanStore) {
+    // Demo records live in the browser store, so when the user-plan store is
+    // that same database the swap is a single atomic transaction.
+    return convertExampleToUserPlan(plan, opts)
+  }
+  // Host-provided store: land the converted user plan there first, then drop
+  // the browser-local demo record — an interrupted convert can leave both
+  // copies (recoverable), never neither.
+  const converted = convertedFromExample(plan, opts)
+  if (!converted.ok) return converted
+  try {
+    await store.savePlan(converted.plan)
+  } catch {
+    // A store rejection must surface through the same result channel as a
+    // validation failure — callers show issues in a dialog, not a crash.
+    return { ok: false, issues: ['The plan store could not save the converted plan.'] }
+  }
+  try {
+    await deletePlan(plan.id)
+  } catch {
+    // Non-fatal: the user plan landed; a surviving demo record is the
+    // recoverable half of the both-copies-never-neither invariant.
+  }
+  return converted
 }

package/src/planner/home/DataAndPrivacyCard.tsx

@@ -1,6 +1,6 @@
 import type { RefObject } from 'react'
 
-import type { PlanSummary } from '../../data/planStore'
+import type { PlanSummary } from '../../data/planStoreContext'
 
 type DataAndPrivacyCardProps = {
   plans: PlanSummary[] | null

package/src/planner/home/YourPlans.tsx

@@ -1,6 +1,6 @@
 import type { ReactNode } from 'react'
 
-import type { PlanSummary } from '../../data/planStore'
+import type { PlanSummary } from '../../data/planStoreContext'
 
 function fmtUpdated(iso: string): string {
   const d = new Date(iso)

package/src/planner/home/useHomeData.ts

@@ -1,15 +1,18 @@
 import { useCallback, useEffect, useRef, useState } from 'react'
 import { useNavigate } from 'react-router-dom'
 
+import { clearAllPlans } from '../../data/planStore'
 import {
-  clearAllPlans,
-  duplicatePlan,
-  listUserPlanSummaries,
-  loadPlan,
-  savePlan,
-  deletePlan,
+  deletePlanVia,
+  duplicatePlanVia,
+  indexedDbPlanStore,
+  listKnownPlanIdsVia,
+  listPlansVia,
+  loadPlanVia,
+  savePlanVia,
+  usePlanStore,
   type PlanSummary,
-} from '../../data/planStore'
+} from '../../data/planStoreContext'
 import { normalizePlansForImport, parseV2Backup, serializeV2Backup } from '../../data/v2Backup'
 import { type Plan } from '@retiregolden/engine/model/plan'
 import { useDialogs } from '../dialogs'
@@ -17,6 +20,7 @@ import { importErrorMessage } from './importErrorMessage'
 
 export function useHomeData() {
   const navigate = useNavigate()
+  const store = usePlanStore()
   const [plans, setPlans] = useState<PlanSummary[] | null>(null)
   const [notice, setNotice] = useState<string | null>(null)
   // A just-deleted plan, held in memory for a brief undo window. The delete is
@@ -28,8 +32,8 @@ export function useHomeData() {
   const { confirm, prompt, dialogs } = useDialogs()
 
   const refresh = useCallback(() => {
-    void listUserPlanSummaries().then(setPlans)
-  }, [])
+    void listPlansVia(store).then(setPlans)
+  }, [store])
 
   const clearUndoTimer = () => {
     if (undoTimer.current !== null) {
@@ -47,16 +51,16 @@ export function useHomeData() {
   const openPlan = (id: string) => navigate(`/plan/${id}`)
 
   const createAndOpen = async (plan: Plan) => {
-    const r = await savePlan(plan)
+    const r = await savePlanVia(store, plan)
     if (r.ok) openPlan(r.plan.id)
     else setNotice(`Could not save the new plan: ${r.issues.join('; ')}`)
   }
 
   const handleExportAll = async () => {
-    const summaries = await listUserPlanSummaries()
+    const summaries = await listPlansVia(store)
     const loaded: Plan[] = []
     for (const s of summaries) {
-      const r = await loadPlan(s.id)
+      const r = await loadPlanVia(store, s.id)
       if (r.ok) loaded.push(r.plan)
     }
     const blob = new Blob([serializeV2Backup(loaded)], { type: 'application/json' })
@@ -73,8 +77,8 @@ export function useHomeData() {
       setNotice(importErrorMessage(r.reason))
       return
     }
-    const normalized = await normalizePlansForImport(r.plans)
-    for (const p of normalized) await savePlan(p)
+    const normalized = await normalizePlansForImport(r.plans, await listKnownPlanIdsVia(store))
+    for (const p of normalized) await savePlanVia(store, p)
     setNotice(
       `Imported ${normalized.length} plan${normalized.length === 1 ? '' : 's'}.` +
         (r.warnings.length > 0 ? ` Skipped: ${r.warnings.join('; ')}` : ''),
@@ -90,7 +94,7 @@ export function useHomeData() {
       confirmLabel: 'Duplicate',
     })
     if (name === null) return
-    const r = await duplicatePlan(s.id, { name })
+    const r = await duplicatePlanVia(store, s.id, { name })
     if (r.ok) {
       setNotice(`Duplicated "${s.name}" as "${r.plan.name}".`)
       refresh()
@@ -107,8 +111,8 @@ export function useHomeData() {
       danger: true,
     })
     if (!ok) return
-    const loaded = await loadPlan(s.id)
-    await deletePlan(s.id)
+    const loaded = await loadPlanVia(store, s.id)
+    await deletePlanVia(store, s.id)
     refresh()
     if (loaded.ok) {
       clearUndoTimer()
@@ -125,7 +129,7 @@ export function useHomeData() {
     // lands — if the save fails, the user must not lose both the plan and
     // the affordance at once.
     try {
-      const r = await savePlan(restored)
+      const r = await savePlanVia(store, restored)
       if (r.ok) {
         setUndoPlan(null)
         refresh()
@@ -157,6 +161,13 @@ export function useHomeData() {
     // A pending delete-undo would let "Undo" resurrect a plan after the
     // erasure — drop it before clearing so "erases ALL data" stays true.
     dismissUndo()
+    // With a host-provided store, this surface's plan list lives there —
+    // honor the dialog's "every plan" promise through the seam before the
+    // device-local wipe. (The default web path is untouched: clearAllPlans
+    // already clears the browser database in one call.)
+    if (store !== indexedDbPlanStore) {
+      for (const s of await store.listPlans()) await deletePlanVia(store, s.id)
+    }
     await clearAllPlans()
     try {
       for (const key of Object.keys(localStorage)) {

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/planner/insights/InsightCardView.tsx

@@ -119,7 +119,7 @@ export function InsightCardView({ card, onDismiss }: { card: InsightCard; onDism
               }
             }
           } else {
-            setPreviewError(`This suggestion can't be applied to your plan: ${applied.issues.join('; ')}`)
+            setPreviewError(`This insight can't be applied to your plan: ${applied.issues.join('; ')}`)
           }
         }
       } catch (err) {
@@ -136,7 +136,7 @@ export function InsightCardView({ card, onDismiss }: { card: InsightCard; onDism
     if (action.kind !== 'preview-scenario') return
     const applied = applyScenarioPatch(plan, action.patch)
     if (!applied.ok) {
-      setPreviewError(`This suggestion can't be applied to your plan: ${applied.issues.join('; ')}`)
+      setPreviewError(`This insight can't be applied to your plan: ${applied.issues.join('; ')}`)
       return
     }
     const name = uniqueScenarioName(action.scenarioName, plan)
@@ -198,8 +198,8 @@ export function InsightCardView({ card, onDismiss }: { card: InsightCard; onDism
         type="button"
         className="btn-ghost insight-dismiss"
         onClick={onDismiss}
-        aria-label="Dismiss this recommendation"
-        title="Dismiss this recommendation"
+        aria-label="Dismiss this insight"
+        title="Dismiss this insight"
       >
         <svg
           viewBox="0 0 24 24"
@@ -319,7 +319,7 @@ export function InsightCardView({ card, onDismiss }: { card: InsightCard; onDism
             </>
           )}
           {card.action.kind === 'advisory' && (
-            <span className="insight-advisory-note">Advisory only</span>
+            <span className="insight-advisory-note">Informational only</span>
           )}
           {card.action.kind === 'apply-toggle' && (
             <>

package/src/planner/insights/InsightsPage.tsx

@@ -102,12 +102,13 @@ export function InsightsPage() {
     <section>
       <LiveStatus message={liveMessage} />
       <div className="card">
-        <h2>Insights & Recommendations</h2>
+        <h2>Insights</h2>
         <p className="card-hint">
-          RetireGolden scans your plan to identify personalized planning opportunities. These recommendations update live as you edit.
+          RetireGolden scans your plan for modeled opportunities worth comparing. These findings update live as you
+          edit, and each one can be previewed as a scenario before anything in your plan changes.
         </p>
         <div className="callout callout--info">
-          <strong>Educational only.</strong> These suggestions are for educational purposes based on the rules and assumptions modeled. They do not constitute financial, tax, or legal advice.
+          <strong>Educational only.</strong> These findings are for educational purposes based on the rules and assumptions modeled. They do not constitute financial, tax, or legal advice.
         </div>
       </div>
 
@@ -115,7 +116,7 @@ export function InsightsPage() {
         <div className="card">
           <h2>Roth & Tax Optimizer</h2>
           <p className="card-hint">
-            Compare candidate Roth-conversion schedules on your full year-by-year projection and see the best result found for your plan.
+            Compare candidate Roth-conversion schedules on your full year-by-year projection, ranked by the objective you select.
           </p>
           <Link to={`/plan/${plan.id}/optimize`} className="btn btn-primary btn-small">
             Run optimizer →
@@ -126,7 +127,7 @@ export function InsightsPage() {
           <div className="card">
             <h2>Social Security Optimizer</h2>
             <p className="card-hint">
-              Analyze every claiming age combination side-by-side to find the schedule that maximizes your ending estate.
+              Run every claiming-age combination through your full plan and rank them by the objective you choose.
             </p>
             <Link to={`/plan/${plan.id}/social-security-analysis`} className="btn btn-secondary btn-small">
               Run SS sweep →

package/src/planner/marketModelPicker.ts

@@ -41,7 +41,7 @@ export interface ModelPreset {
 export const MODEL_PRESETS: ReadonlyArray<ModelPreset> = [
   {
     id: 'smooth',
-    label: 'Smooth randomness (recommended)',
+    label: 'Smooth randomness (default)',
     description: 'Each year varies around your expected return, like a bell curve.',
     kind: 'lognormal',
   },

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>
+}