@retiregolden/engine 0.1.0

package/dist/longevity/ssaPeriod2022.js

@@ -0,0 +1,51 @@
+/**
+ * Period life expectancy e(x) — **remaining years** at exact integer age x.
+ * Source: SSA Table 4C6, 2022 (2025 TR), male/female columns.
+ * @see https://www.ssa.gov/oact/STATS/table4c6.html
+ */
+export const MALE = [
+    /* 0–17 */ 74.74, 74.2, 73.23, 72.25, 71.27, 70.29, 69.3, 68.31, 67.32, 66.32, 65.33,
+    64.34, 63.35, 62.36, 61.37, 60.39, 59.42, 58.46,
+    /* 18 */ 57.5, 56.56, 55.63, 54.7, 53.78, 52.86, 51.94, 51.03, 50.12, 49.21, 48.31, 47.41,
+    46.51, 45.62, 44.73, 43.84, 42.96, 42.08, 41.19, 40.31, 39.43, 38.55, 37.67, 36.8, 35.93,
+    35.05, 34.19, 33.32, 32.46, 31.6, 30.75, 29.9, 29.05, 28.22, 27.39, 26.56, 25.75, 24.94,
+    24.15, 23.37, 22.59, 21.83, 21.08, 20.34, 19.61, 18.89, 18.18, 17.48, 16.79, 16.11, 15.43,
+    14.76, 14.09, 13.44, 12.8, 12.16, 11.53, 10.92, 10.32, 9.74, 9.18, 8.64, 8.11, 7.6, 7.11,
+    6.64, 6.18, 5.75, 5.34, 4.94, 4.58, 4.23, 3.91, 3.6, 3.32, 3.06, 2.83, 2.63, 2.44, 2.28,
+    2.13, 2.0, 1.88, 1.76, 1.66, 1.56, 1.47, 1.39, 1.31, 1.23, 1.15, 1.08, 1.01, 0.94, 0.87,
+    0.81, 0.75, 0.7, 0.64, 0.59, 0.54, 0.5,
+];
+export const FEMALE = [
+    /* 0–17 */ 80.18, 79.6, 78.63, 77.65, 76.66, 75.67, 74.68, 73.69, 72.7, 71.71, 70.72, 69.72,
+    68.73, 67.74, 66.75, 65.76, 64.78, 63.8,
+    /* 18 */ 62.82, 61.84, 60.87, 59.9, 58.93, 57.97, 57.0, 56.04, 55.08, 54.12, 53.16, 52.2,
+    51.25, 50.3, 49.35, 48.41, 47.47, 46.53, 45.59, 44.65, 43.72, 42.79, 41.86, 40.93, 40.01,
+    39.09, 38.17, 37.25, 36.34, 35.43, 34.53, 33.63, 32.73, 31.84, 30.96, 30.08, 29.2, 28.34,
+    27.48, 26.63, 25.78, 24.95, 24.12, 23.31, 22.5, 21.7, 20.9, 20.12, 19.34, 18.56, 17.79,
+    17.03, 16.27, 15.53, 14.8, 14.08, 13.37, 12.68, 12.0, 11.35, 10.71, 10.09, 9.49, 8.9, 8.34,
+    7.79, 7.26, 6.76, 6.28, 5.83, 5.4, 5.0, 4.62, 4.27, 3.94, 3.64, 3.36, 3.1, 2.87, 2.66, 2.47,
+    2.3, 2.14, 2.0, 1.87, 1.75, 1.63, 1.52, 1.42, 1.32, 1.23, 1.14, 1.05, 0.97, 0.89, 0.82,
+    0.75, 0.7, 0.64, 0.59, 0.54, 0.5,
+];
+function at(table, age) {
+    const i = Math.round(age);
+    if (i < 0)
+        return table[0];
+    if (i >= table.length)
+        return table[table.length - 1];
+    return table[i];
+}
+/** SSA baseline: remaining years at integer age (linear between ages if fractional). */
+export function baselineRemainingYears(age, sex) {
+    const a = Math.min(Math.max(age, 0), MALE.length - 1 - 1e-9);
+    const lo = Math.floor(a);
+    const hi = Math.ceil(a);
+    const t = a - lo;
+    const m = at(MALE, lo) * (1 - t) + at(MALE, hi) * t;
+    const f = at(FEMALE, lo) * (1 - t) + at(FEMALE, hi) * t;
+    if (sex === 'male')
+        return m;
+    if (sex === 'female')
+        return f;
+    return (m + f) / 2;
+}

package/dist/longevity/types.d.ts

@@ -0,0 +1,39 @@
+export type Sex = 'male' | 'female' | 'average';
+export type BmiCategory = 'underweight' | 'normal' | 'overweight' | 'obese_i' | 'obese_ii_plus';
+export type Smoking = 'never' | 'former_15y' | 'former_lt15y' | 'current_light' | 'current_moderate' | 'current_heavy';
+export type Alcohol = 'never' | 'light' | 'moderate' | 'heavy';
+export type Activity = 'high' | 'moderate' | 'low' | 'sedentary';
+export type Diabetes = 'no' | 'yes_controlled' | 'yes_uncontrolled';
+export type SelfRatedHealth = 'excellent' | 'good' | 'fair' | 'poor' | 'very_poor';
+export type ParentalLongevity = 'both_80' | 'one_80' | 'neither_80' | 'unknown';
+export interface LongevityAnswers {
+    age: number;
+    sex: Sex;
+    bmiCategory: BmiCategory;
+    smoking: Smoking;
+    alcohol: Alcohol;
+    activity: Activity;
+    diabetes: Diabetes;
+    selfRatedHealth: SelfRatedHealth;
+    parentalLongevity: ParentalLongevity;
+}
+export interface LongevityResult {
+    baselineRemainingYears: number;
+    /** Product of lifestyle/health factors (before clamp) */
+    rawMultiplier: number;
+    /** After conservative clamp */
+    appliedMultiplier: number;
+    /** Baseline × appliedMultiplier */
+    centralRemainingYears: number;
+    /** Illustrative band — not statistical confidence */
+    bandLowRemainingYears: number;
+    bandHighRemainingYears: number;
+    /** age + central (rounded) */
+    illustrativePlanningAge: number;
+}
+export interface LongevityPersisted {
+    version: 1;
+    answers: LongevityAnswers;
+    result: LongevityResult;
+    updatedAt: string;
+}

package/dist/longevity/types.js

@@ -0,0 +1 @@
+export {};

package/dist/model/migrations.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Plan schema migrations.
+ *
+ * Every persisted or imported plan passes through `migratePlanToCurrent`
+ * before `parsePlan`. When the schema changes: bump CURRENT_PLAN_SCHEMA_VERSION,
+ * register a pure `fromVersion -> fromVersion+1` step here, and add a fixture
+ * test in migrations.test.ts. Steps must never throw on well-formed input of
+ * their version; unknown shapes fall through to parsePlan's validation.
+ */
+import { type Plan } from './plan.js';
+export type MigrationStep = (raw: Record<string, unknown>) => Record<string, unknown>;
+export type MigrateResult = {
+    ok: true;
+    plan: Plan;
+} | {
+    ok: false;
+    reason: 'not_object' | 'bad_version' | 'newer_than_app' | 'missing_step' | 'invalid_after_migration';
+    issues?: string[];
+};
+export declare function migratePlanToCurrent(input: unknown, registry?: Record<number, MigrationStep>, currentVersion?: number): MigrateResult;

package/dist/model/migrations.js

@@ -0,0 +1,67 @@
+/**
+ * Plan schema migrations.
+ *
+ * Every persisted or imported plan passes through `migratePlanToCurrent`
+ * before `parsePlan`. When the schema changes: bump CURRENT_PLAN_SCHEMA_VERSION,
+ * register a pure `fromVersion -> fromVersion+1` step here, and add a fixture
+ * test in migrations.test.ts. Steps must never throw on well-formed input of
+ * their version; unknown shapes fall through to parsePlan's validation.
+ */
+import { CURRENT_PLAN_SCHEMA_VERSION, parsePlan } from './plan.js';
+/** Keyed by the version the step migrates FROM. v1 is current — empty today. */
+const defaultRegistry = {};
+function normalizeCurrentPlan(raw) {
+    const household = raw['household'];
+    const accounts = raw['accounts'];
+    if (typeof household !== 'object' || household === null || Array.isArray(household) || !Array.isArray(accounts)) {
+        return raw;
+    }
+    const people = household['people'];
+    if (!Array.isArray(people))
+        return raw;
+    const primary = people[0];
+    if (typeof primary !== 'object' || primary === null || Array.isArray(primary))
+        return raw;
+    const primaryId = primary['id'];
+    if (typeof primaryId !== 'string' || primaryId.length === 0)
+        return raw;
+    let changed = false;
+    const normalizedAccounts = accounts.map((account) => {
+        if (typeof account !== 'object' || account === null || Array.isArray(account))
+            return account;
+        const accountRecord = account;
+        if ((accountRecord['type'] === 'traditional' || accountRecord['type'] === 'roth' || accountRecord['type'] === 'hsa') &&
+            accountRecord['ownerPersonId'] === null) {
+            changed = true;
+            return { ...accountRecord, ownerPersonId: primaryId };
+        }
+        return account;
+    });
+    return changed ? { ...raw, accounts: normalizedAccounts } : raw;
+}
+export function migratePlanToCurrent(input, registry = defaultRegistry, currentVersion = CURRENT_PLAN_SCHEMA_VERSION) {
+    if (typeof input !== 'object' || input === null || Array.isArray(input)) {
+        return { ok: false, reason: 'not_object' };
+    }
+    let raw = input;
+    const v = raw['schemaVersion'];
+    if (typeof v !== 'number' || !Number.isInteger(v) || v < 1) {
+        return { ok: false, reason: 'bad_version' };
+    }
+    if (v > currentVersion) {
+        // A backup from a newer app build; never destructively "fix" it.
+        return { ok: false, reason: 'newer_than_app' };
+    }
+    for (let from = v; from < currentVersion; from++) {
+        const step = registry[from];
+        if (!step)
+            return { ok: false, reason: 'missing_step' };
+        raw = { ...step(raw), schemaVersion: from + 1 };
+    }
+    raw = normalizeCurrentPlan(raw);
+    const parsed = parsePlan(raw);
+    if (!parsed.ok) {
+        return { ok: false, reason: 'invalid_after_migration', issues: parsed.issues };
+    }
+    return { ok: true, plan: parsed.plan };
+}