@contractspec/example.wealth-snapshot 1.57.0 → 1.58.0

package/dist/browser/operations/index.js

@@ -0,0 +1,238 @@
+// src/operations/index.ts
+import { ScalarTypeEnum, defineSchemaModel } from "@contractspec/lib.schema";
+import { defineCommand, defineQuery } from "@contractspec/lib.contracts";
+var OWNERS = ["examples.wealth-snapshot"];
+var AccountModel = defineSchemaModel({
+  name: "Account",
+  description: "Account model",
+  fields: {
+    id: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    name: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    type: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    currency: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    balance: { type: ScalarTypeEnum.Float_unsecure(), isOptional: false }
+  }
+});
+var AssetModel = defineSchemaModel({
+  name: "Asset",
+  description: "Asset model",
+  fields: {
+    id: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    name: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    category: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    value: { type: ScalarTypeEnum.Float_unsecure(), isOptional: false },
+    currency: { type: ScalarTypeEnum.String_unsecure(), isOptional: false }
+  }
+});
+var LiabilityModel = defineSchemaModel({
+  name: "Liability",
+  description: "Liability model",
+  fields: {
+    id: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    name: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    category: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    balance: { type: ScalarTypeEnum.Float_unsecure(), isOptional: false },
+    currency: { type: ScalarTypeEnum.String_unsecure(), isOptional: false }
+  }
+});
+var GoalModel = defineSchemaModel({
+  name: "Goal",
+  description: "Goal model",
+  fields: {
+    id: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    name: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    targetAmount: { type: ScalarTypeEnum.Float_unsecure(), isOptional: false },
+    currentAmount: { type: ScalarTypeEnum.Float_unsecure(), isOptional: false },
+    currency: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    status: { type: ScalarTypeEnum.String_unsecure(), isOptional: false }
+  }
+});
+var NetWorthSnapshotModel = defineSchemaModel({
+  name: "NetWorthSnapshot",
+  description: "Net worth snapshot model",
+  fields: {
+    asOf: { type: ScalarTypeEnum.DateTime(), isOptional: false },
+    totalAssets: { type: ScalarTypeEnum.Float_unsecure(), isOptional: false },
+    totalLiabilities: {
+      type: ScalarTypeEnum.Float_unsecure(),
+      isOptional: false
+    },
+    netWorth: { type: ScalarTypeEnum.Float_unsecure(), isOptional: false },
+    currency: { type: ScalarTypeEnum.String_unsecure(), isOptional: false }
+  }
+});
+var CreateAccountInput = defineSchemaModel({
+  name: "CreateAccountInput",
+  description: "Create account input",
+  fields: {
+    name: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    type: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    currency: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
+    balance: { type: ScalarTypeEnum.Float_unsecure(), isOptional: true },
+    orgId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false }
+  }
+});
+var AddAssetInput = defineSchemaModel({
+  name: "AddAssetInput",
+  description: "Add asset input",
+  fields: {
+    accountId: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
+    name: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    category: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    value: { type: ScalarTypeEnum.Float_unsecure(), isOptional: false },
+    currency: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
+    orgId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false }
+  }
+});
+var AddLiabilityInput = defineSchemaModel({
+  name: "AddLiabilityInput",
+  description: "Add liability input",
+  fields: {
+    accountId: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
+    name: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    category: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    balance: { type: ScalarTypeEnum.Float_unsecure(), isOptional: false },
+    currency: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
+    orgId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false }
+  }
+});
+var UpdateGoalInput = defineSchemaModel({
+  name: "UpdateGoalInput",
+  description: "Update goal progress",
+  fields: {
+    goalId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    currentAmount: { type: ScalarTypeEnum.Float_unsecure(), isOptional: false },
+    status: { type: ScalarTypeEnum.String_unsecure(), isOptional: true }
+  }
+});
+var CreateGoalInput = defineSchemaModel({
+  name: "CreateGoalInput",
+  description: "Create goal input",
+  fields: {
+    name: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    targetAmount: { type: ScalarTypeEnum.Float_unsecure(), isOptional: false },
+    currency: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
+    targetDate: { type: ScalarTypeEnum.DateTime(), isOptional: true },
+    orgId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false }
+  }
+});
+var NetWorthQueryInput = defineSchemaModel({
+  name: "NetWorthQueryInput",
+  description: "Filter for net worth snapshots",
+  fields: {
+    orgId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    from: { type: ScalarTypeEnum.DateTime(), isOptional: true },
+    to: { type: ScalarTypeEnum.DateTime(), isOptional: true }
+  }
+});
+var CreateAccountContract = defineCommand({
+  meta: {
+    key: "wealth.account.create",
+    version: "1.0.0",
+    stability: "stable",
+    owners: [...OWNERS],
+    tags: ["wealth", "account", "create"],
+    description: "Create a financial account.",
+    goal: "Track account balances.",
+    context: "Onboarding/import."
+  },
+  io: { input: CreateAccountInput, output: AccountModel },
+  policy: { auth: "user" }
+});
+var AddAssetContract = defineCommand({
+  meta: {
+    key: "wealth.asset.add",
+    version: "1.0.0",
+    stability: "stable",
+    owners: [...OWNERS],
+    tags: ["wealth", "asset", "add"],
+    description: "Add an asset position.",
+    goal: "Track holdings.",
+    context: "Asset onboarding/update."
+  },
+  io: { input: AddAssetInput, output: AssetModel },
+  policy: { auth: "user" }
+});
+var AddLiabilityContract = defineCommand({
+  meta: {
+    key: "wealth.liability.add",
+    version: "1.0.0",
+    stability: "stable",
+    owners: [...OWNERS],
+    tags: ["wealth", "liability", "add"],
+    description: "Add a liability.",
+    goal: "Track debts.",
+    context: "Debt onboarding/update."
+  },
+  io: { input: AddLiabilityInput, output: LiabilityModel },
+  policy: { auth: "user" }
+});
+var CreateGoalContract = defineCommand({
+  meta: {
+    key: "wealth.goal.create",
+    version: "1.0.0",
+    stability: "stable",
+    owners: [...OWNERS],
+    tags: ["wealth", "goal", "create"],
+    description: "Create a financial goal.",
+    goal: "Track progress toward goals.",
+    context: "Planning."
+  },
+  io: { input: CreateGoalInput, output: GoalModel },
+  policy: { auth: "user" }
+});
+var UpdateGoalContract = defineCommand({
+  meta: {
+    key: "wealth.goal.update",
+    version: "1.0.0",
+    stability: "stable",
+    owners: [...OWNERS],
+    tags: ["wealth", "goal", "update"],
+    description: "Update goal progress.",
+    goal: "Keep progress current.",
+    context: "Periodic update."
+  },
+  io: { input: UpdateGoalInput, output: GoalModel },
+  policy: { auth: "user" }
+});
+var GetNetWorthContract = defineQuery({
+  meta: {
+    key: "wealth.networth.get",
+    version: "1.0.0",
+    stability: "stable",
+    owners: [...OWNERS],
+    tags: ["wealth", "networth"],
+    description: "Get net worth snapshots for a period.",
+    goal: "Render charts and indicators.",
+    context: "Dashboard."
+  },
+  io: {
+    input: NetWorthQueryInput,
+    output: defineSchemaModel({
+      name: "NetWorthQueryOutput",
+      description: "Snapshots + latest indicators",
+      fields: {
+        snapshots: {
+          type: NetWorthSnapshotModel,
+          isArray: true,
+          isOptional: false
+        },
+        latest: { type: NetWorthSnapshotModel, isOptional: true }
+      }
+    })
+  },
+  policy: { auth: "user" }
+});
+export {
+  UpdateGoalContract,
+  NetWorthSnapshotModel,
+  LiabilityModel,
+  GoalModel,
+  GetNetWorthContract,
+  CreateGoalContract,
+  CreateAccountContract,
+  AssetModel,
+  AddLiabilityContract,
+  AddAssetContract,
+  AccountModel
+};

package/dist/browser/presentations/index.js

@@ -0,0 +1,11 @@
+// src/presentations/index.ts
+var WealthSnapshotPresentations = [
+  "wealth-snapshot.dashboard",
+  "wealth-snapshot.accounts.list",
+  "wealth-snapshot.assets.list",
+  "wealth-snapshot.liabilities.list",
+  "wealth-snapshot.goals.list"
+];
+export {
+  WealthSnapshotPresentations
+};

package/dist/browser/presentations.js

@@ -0,0 +1,124 @@
+// src/presentations.ts
+import { definePresentation, StabilityEnum } from "@contractspec/lib.contracts";
+var WealthDashboardPresentation = definePresentation({
+  meta: {
+    key: "wealth-snapshot.dashboard",
+    version: "1.0.0",
+    title: "Wealth Dashboard",
+    description: "Wealth snapshot dashboard with net worth overview",
+    domain: "finance",
+    owners: ["@wealth-snapshot"],
+    tags: ["finance", "wealth", "dashboard"],
+    stability: StabilityEnum.Experimental,
+    goal: "Overview of wealth",
+    context: "Dashboard"
+  },
+  source: {
+    type: "component",
+    framework: "react",
+    componentKey: "WealthDashboard"
+  },
+  targets: ["react", "markdown"],
+  policy: {
+    flags: ["wealth.dashboard.enabled"]
+  }
+});
+var AccountsListPresentation = definePresentation({
+  meta: {
+    key: "wealth-snapshot.accounts.list",
+    version: "1.0.0",
+    title: "Accounts List",
+    description: "List of financial accounts",
+    domain: "finance",
+    owners: ["@wealth-snapshot"],
+    tags: ["finance", "accounts", "list"],
+    stability: StabilityEnum.Experimental,
+    goal: "List accounts",
+    context: "Overview"
+  },
+  source: {
+    type: "component",
+    framework: "react",
+    componentKey: "AccountsList"
+  },
+  targets: ["react", "markdown"],
+  policy: {
+    flags: ["wealth.accounts.enabled"]
+  }
+});
+var AssetsListPresentation = definePresentation({
+  meta: {
+    key: "wealth-snapshot.assets.list",
+    version: "1.0.0",
+    title: "Assets List",
+    description: "List of assets with valuations",
+    domain: "finance",
+    owners: ["@wealth-snapshot"],
+    tags: ["finance", "assets", "list"],
+    stability: StabilityEnum.Experimental,
+    goal: "List assets",
+    context: "Overview"
+  },
+  source: {
+    type: "component",
+    framework: "react",
+    componentKey: "AssetsList"
+  },
+  targets: ["react", "markdown"],
+  policy: {
+    flags: ["wealth.assets.enabled"]
+  }
+});
+var LiabilitiesListPresentation = definePresentation({
+  meta: {
+    key: "wealth-snapshot.liabilities.list",
+    version: "1.0.0",
+    title: "Liabilities List",
+    description: "List of liabilities and debts",
+    domain: "finance",
+    owners: ["@wealth-snapshot"],
+    tags: ["finance", "liabilities", "list"],
+    stability: StabilityEnum.Experimental,
+    goal: "List liabilities",
+    context: "Overview"
+  },
+  source: {
+    type: "component",
+    framework: "react",
+    componentKey: "LiabilitiesList"
+  },
+  targets: ["react", "markdown"],
+  policy: {
+    flags: ["wealth.liabilities.enabled"]
+  }
+});
+var GoalsListPresentation = definePresentation({
+  meta: {
+    key: "wealth-snapshot.goals.list",
+    version: "1.0.0",
+    title: "Goals List",
+    description: "List of financial goals with progress",
+    domain: "finance",
+    owners: ["@wealth-snapshot"],
+    tags: ["finance", "goals", "list"],
+    stability: StabilityEnum.Experimental,
+    goal: "List goals",
+    context: "Overview"
+  },
+  source: {
+    type: "component",
+    framework: "react",
+    componentKey: "GoalsList"
+  },
+  targets: ["react", "markdown"],
+  policy: {
+    flags: ["wealth.goals.enabled"]
+  }
+});
+export {
+  WealthDashboardPresentation,
+  LiabilitiesListPresentation,
+  GoalsListPresentation,
+  AssetsListPresentation,
+  AccountsListPresentation
+};

package/dist/browser/wealth-snapshot.capability.js

@@ -0,0 +1,40 @@
+// src/wealth-snapshot.capability.ts
+import { defineCapability, StabilityEnum } from "@contractspec/lib.contracts";
+var AccountsCapability = defineCapability({
+  meta: {
+    key: "accounts",
+    version: "1.0.0",
+    kind: "data",
+    stability: StabilityEnum.Experimental,
+    description: "Financial accounts tracking and aggregation",
+    owners: ["platform.finance"],
+    tags: ["accounts", "finance", "wealth"]
+  }
+});
+var NetWorthCapability = defineCapability({
+  meta: {
+    key: "net-worth",
+    version: "1.0.0",
+    kind: "ui",
+    stability: StabilityEnum.Experimental,
+    description: "Net worth visualization and tracking",
+    owners: ["platform.finance"],
+    tags: ["net-worth", "wealth", "dashboard"]
+  }
+});
+var GoalsCapability = defineCapability({
+  meta: {
+    key: "goals",
+    version: "1.0.0",
+    kind: "ui",
+    stability: StabilityEnum.Experimental,
+    description: "Financial goal setting and progress tracking",
+    owners: ["platform.finance"],
+    tags: ["goals", "planning", "wealth"]
+  }
+});
+export {
+  NetWorthCapability,
+  GoalsCapability,
+  AccountsCapability
+};

package/dist/browser/wealth-snapshot.feature.js

@@ -0,0 +1,72 @@
+// src/wealth-snapshot.feature.ts
+import { defineFeature } from "@contractspec/lib.contracts";
+var WealthSnapshotFeature = defineFeature({
+  meta: {
+    key: "wealth-snapshot",
+    version: "1.0.0",
+    title: "Wealth Snapshot",
+    description: "Mini-app for accounts, assets, liabilities, goals, and net worth.",
+    domain: "finance",
+    owners: ["@wealth-snapshot"],
+    tags: ["finance", "net-worth", "goals"],
+    stability: "experimental"
+  },
+  operations: [
+    { key: "wealth.account.create", version: "1.0.0" },
+    { key: "wealth.asset.add", version: "1.0.0" },
+    { key: "wealth.liability.add", version: "1.0.0" },
+    { key: "wealth.goal.create", version: "1.0.0" },
+    { key: "wealth.goal.update", version: "1.0.0" },
+    { key: "wealth.networth.get", version: "1.0.0" }
+  ],
+  events: [
+    { key: "wealth.asset.added", version: "1.0.0" },
+    { key: "wealth.liability.added", version: "1.0.0" },
+    { key: "wealth.goal.updated", version: "1.0.0" },
+    { key: "wealth.networth.snapshot_created", version: "1.0.0" }
+  ],
+  presentations: [
+    { key: "wealth-snapshot.dashboard", version: "1.0.0" },
+    { key: "wealth-snapshot.accounts.list", version: "1.0.0" },
+    { key: "wealth-snapshot.assets.list", version: "1.0.0" },
+    { key: "wealth-snapshot.liabilities.list", version: "1.0.0" },
+    { key: "wealth-snapshot.goals.list", version: "1.0.0" }
+  ],
+  presentationsTargets: [
+    {
+      key: "wealth-snapshot.dashboard",
+      version: "1.0.0",
+      targets: ["react", "markdown"]
+    },
+    {
+      key: "wealth-snapshot.assets.list",
+      version: "1.0.0",
+      targets: ["react", "markdown"]
+    },
+    {
+      key: "wealth-snapshot.liabilities.list",
+      version: "1.0.0",
+      targets: ["react", "markdown"]
+    },
+    {
+      key: "wealth-snapshot.goals.list",
+      version: "1.0.0",
+      targets: ["react", "markdown"]
+    }
+  ],
+  capabilities: {
+    requires: [
+      { key: "identity", version: "1.0.0" },
+      { key: "audit-trail", version: "1.0.0" },
+      { key: "notifications", version: "1.0.0" }
+    ],
+    provides: [
+      { key: "accounts", version: "1.0.0" },
+      { key: "net-worth", version: "1.0.0" },
+      { key: "goals", version: "1.0.0" }
+    ]
+  }
+});
+export {
+  WealthSnapshotFeature
+};

package/dist/docs/index.d.ts

@@ -1 +1,2 @@
-export { };
+import './wealth-snapshot.docblock';
+//# sourceMappingURL=index.d.ts.map

package/dist/docs/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/docs/index.ts"],"names":[],"mappings":"AAAA,OAAO,4BAA4B,CAAC"}

package/dist/docs/index.js

@@ -1 +1,94 @@
-import "./wealth-snapshot.docblock.js";
+// @bun
+// src/docs/wealth-snapshot.docblock.ts
+import { registerDocBlocks } from "@contractspec/lib.contracts/docs";
+var wealthSnapshotDocBlocks = [
+  {
+    id: "docs.examples.wealth-snapshot",
+    title: "Wealth Snapshot",
+    summary: "Simple wealth overview with accounts, assets, liabilities, goals, and net-worth snapshots.",
+    kind: "reference",
+    visibility: "public",
+    route: "/docs/examples/wealth-snapshot",
+    tags: ["finance", "net-worth", "goals"],
+    body: `## Features
+
+- Accounts with balances/currencies.
+- Assets & liabilities categorized for net worth.
+- Goals with target amounts/dates and status.
+- Net worth snapshots for charting; events emitted for analytics.
+
+## Modules reused
+- Identity/RBAC for scoping to household/org
+- Notifications for threshold crossings/goal reminders
+- Audit trail for financial changes
+
+## Presentations
+- Dashboard, accounts list, assets list, liabilities list, goals list (React + Markdown targets).
+`
+  },
+  {
+    id: "docs.examples.wealth-snapshot.goal",
+    title: "Wealth Snapshot \u2014 Goal",
+    summary: "Why this personal/household finance template exists.",
+    kind: "goal",
+    visibility: "public",
+    route: "/docs/examples/wealth-snapshot/goal",
+    tags: ["finance", "goal"],
+    body: `## Why it matters
+- Provides a regenerable net-worth and goals view without bespoke finance code.
+- Keeps accounts/assets/liabilities/goals consistent across surfaces with PII care.
+
+## Business/Product goal
+- Deliver clear net-worth visibility, goal tracking, and alerting for thresholds.
+- Support safe regeneration while keeping currency/units explicit.
+
+## Success criteria
+- Spec changes to assets/liabilities/goals regenerate UI/API/events cleanly.
+- PII and sensitive values are marked and redacted where needed.`
+  },
+  {
+    id: "docs.examples.wealth-snapshot.usage",
+    title: "Wealth Snapshot \u2014 Usage",
+    summary: "How to seed, extend, and regenerate wealth tracking safely.",
+    kind: "usage",
+    visibility: "public",
+    route: "/docs/examples/wealth-snapshot/usage",
+    tags: ["finance", "usage"],
+    body: `## Setup
+1) Seed (if provided) or add accounts/assets/liabilities/goals via UI.
+2) Configure Notifications for goal reminders/threshold alerts; Audit for changes.
+
+## Extend & regenerate
+1) Adjust schemas for asset classes, liability terms, goal metrics; keep currency/units explicit.
+2) Regenerate to update dashboards and events; mark PII paths (account numbers, holder names).
+3) Use Feature Flags to trial new indicators or alerting rules.
+
+## Guardrails
+- Emit events for asset/liability/goal changes; log in Audit Trail.
+- Redact sensitive identifiers in presentations.
+- Keep calculations (net worth) transparent and driven by spec fields.`
+  },
+  {
+    id: "docs.examples.wealth-snapshot.constraints",
+    title: "Wealth Snapshot \u2014 Constraints & Safety",
+    summary: "Internal guardrails for finance data, PII, and regeneration semantics.",
+    kind: "reference",
+    visibility: "internal",
+    route: "/docs/examples/wealth-snapshot/constraints",
+    tags: ["finance", "constraints", "internal"],
+    body: `## Constraints
+- Net worth and goal calculations must stay spec-driven; avoid hidden math.
+- Events to emit: asset.created/updated, liability.created/updated, goal.created/updated, snapshot.recorded.
+- Regeneration should not alter currency/unit semantics without explicit spec change.
+
+## PII & Sensitivity
+- Mark account identifiers, holder names, and addresses as PII; redact in presentations.
+- Avoid exposing raw balances in MCP/web without policy checks; prefer summaries.
+
+## Verification
+- Add fixtures for currency/unit changes and snapshot calculations.
+- Ensure Audit Trail covers all financial mutations; Notifications optional for goals/thresholds.
+- Use Feature Flags for new indicators/alert rules; default safe/off.`
+  }
+];
+registerDocBlocks(wealthSnapshotDocBlocks);

package/dist/docs/wealth-snapshot.docblock.d.ts

@@ -1 +1,2 @@
-export { };
+export {};
+//# sourceMappingURL=wealth-snapshot.docblock.d.ts.map

package/dist/docs/wealth-snapshot.docblock.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"wealth-snapshot.docblock.d.ts","sourceRoot":"","sources":["../../src/docs/wealth-snapshot.docblock.ts"],"names":[],"mappings":""}