@contractspec/example.wealth-snapshot 1.57.0 → 1.58.0

package/dist/browser/docs/index.js

@@ -0,0 +1,93 @@
+// 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 — 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 — 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 — 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/browser/docs/wealth-snapshot.docblock.js

@@ -0,0 +1,93 @@
+// 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 — 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 — 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 — 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/browser/entities/index.js

@@ -0,0 +1,191 @@
+// src/entities/index.ts
+import {
+  defineEntity,
+  defineEntityEnum,
+  field,
+  index
+} from "@contractspec/lib.schema";
+var schema = "lssm_wealth_snapshot";
+var AccountTypeEnum = defineEntityEnum({
+  name: "AccountType",
+  schema,
+  values: ["CHECKING", "SAVINGS", "INVESTMENT", "CREDIT_CARD", "LOAN"],
+  description: "Account categories for holdings and debts."
+});
+var AssetCategoryEnum = defineEntityEnum({
+  name: "AssetCategory",
+  schema,
+  values: ["CASH", "EQUITY", "REAL_ESTATE", "CRYPTO", "OTHER"],
+  description: "Asset categories."
+});
+var LiabilityCategoryEnum = defineEntityEnum({
+  name: "LiabilityCategory",
+  schema,
+  values: ["CREDIT_CARD", "LOAN", "MORTGAGE", "TAX", "OTHER"],
+  description: "Liability categories."
+});
+var GoalStatusEnum = defineEntityEnum({
+  name: "GoalStatus",
+  schema,
+  values: ["ACTIVE", "ON_TRACK", "AT_RISK", "OFF_TRACK", "COMPLETED"],
+  description: "Goal health/status."
+});
+var AccountEntity = defineEntity({
+  name: "Account",
+  description: "Financial account representing holdings or debts.",
+  schema,
+  map: "account",
+  fields: {
+    id: field.id({ description: "Account ID" }),
+    name: field.string({ description: "Account name" }),
+    type: field.enum("AccountType", { description: "Account type" }),
+    currency: field.string({ description: "Currency code", default: '"USD"' }),
+    balance: field.decimal({ description: "Current balance" }),
+    institution: field.string({ description: "Institution", isOptional: true }),
+    orgId: field.string({ description: "Org/household id" }),
+    ownerId: field.string({ description: "Owner user id", isOptional: true }),
+    createdAt: field.createdAt(),
+    updatedAt: field.updatedAt()
+  },
+  enums: [AccountTypeEnum],
+  indexes: [index.on(["orgId"]), index.on(["type"]), index.on(["ownerId"])]
+});
+var AssetEntity = defineEntity({
+  name: "Asset",
+  description: "Individual asset position.",
+  schema,
+  map: "asset",
+  fields: {
+    id: field.id({ description: "Asset ID" }),
+    accountId: field.foreignKey({
+      description: "Holding account",
+      isOptional: true
+    }),
+    name: field.string({ description: "Asset name" }),
+    category: field.enum("AssetCategory", { description: "Asset category" }),
+    value: field.decimal({ description: "Current value" }),
+    currency: field.string({ description: "Currency", default: '"USD"' }),
+    orgId: field.string({ description: "Org/household id" }),
+    metadata: field.json({ description: "Metadata", isOptional: true }),
+    updatedAt: field.updatedAt(),
+    createdAt: field.createdAt(),
+    account: field.belongsTo("Account", ["accountId"], ["id"], {
+      onDelete: "SetNull"
+    })
+  },
+  enums: [AssetCategoryEnum],
+  indexes: [index.on(["orgId"]), index.on(["category"])]
+});
+var LiabilityEntity = defineEntity({
+  name: "Liability",
+  description: "Debt or obligation.",
+  schema,
+  map: "liability",
+  fields: {
+    id: field.id({ description: "Liability ID" }),
+    accountId: field.foreignKey({
+      description: "Liability account",
+      isOptional: true
+    }),
+    name: field.string({ description: "Liability name" }),
+    category: field.enum("LiabilityCategory", {
+      description: "Liability category"
+    }),
+    balance: field.decimal({ description: "Outstanding balance" }),
+    currency: field.string({ description: "Currency", default: '"USD"' }),
+    interestRate: field.decimal({
+      description: "Interest rate (e.g., 0.05 for 5%)",
+      isOptional: true
+    }),
+    orgId: field.string({ description: "Org/household id" }),
+    metadata: field.json({ description: "Metadata", isOptional: true }),
+    updatedAt: field.updatedAt(),
+    createdAt: field.createdAt(),
+    account: field.belongsTo("Account", ["accountId"], ["id"], {
+      onDelete: "SetNull"
+    })
+  },
+  enums: [LiabilityCategoryEnum],
+  indexes: [index.on(["orgId"]), index.on(["category"])]
+});
+var GoalEntity = defineEntity({
+  name: "Goal",
+  description: "Financial goal with target amount/date.",
+  schema,
+  map: "goal",
+  fields: {
+    id: field.id({ description: "Goal ID" }),
+    name: field.string({ description: "Goal name" }),
+    targetAmount: field.decimal({ description: "Target amount" }),
+    currentAmount: field.decimal({
+      description: "Current progress amount",
+      default: 0
+    }),
+    currency: field.string({ description: "Currency", default: '"USD"' }),
+    targetDate: field.dateTime({
+      description: "Target completion date",
+      isOptional: true
+    }),
+    status: field.enum("GoalStatus", {
+      description: "Goal status",
+      default: "ACTIVE"
+    }),
+    orgId: field.string({ description: "Org/household id" }),
+    ownerId: field.string({ description: "Owner user id", isOptional: true }),
+    createdAt: field.createdAt(),
+    updatedAt: field.updatedAt()
+  },
+  enums: [GoalStatusEnum],
+  indexes: [
+    index.on(["orgId"]),
+    index.on(["status"]),
+    index.on(["targetDate"])
+  ]
+});
+var NetWorthSnapshotEntity = defineEntity({
+  name: "NetWorthSnapshot",
+  description: "Aggregated net worth snapshot for a date.",
+  schema,
+  map: "networth_snapshot",
+  fields: {
+    id: field.id({ description: "Snapshot ID" }),
+    asOf: field.dateTime({ description: "Snapshot date" }),
+    totalAssets: field.decimal({ description: "Total assets" }),
+    totalLiabilities: field.decimal({ description: "Total liabilities" }),
+    netWorth: field.decimal({ description: "Net worth" }),
+    currency: field.string({ description: "Currency", default: '"USD"' }),
+    orgId: field.string({ description: "Org/household id" }),
+    createdAt: field.createdAt()
+  },
+  indexes: [index.unique(["orgId", "asOf"], { name: "networth_unique" })]
+});
+var wealthSnapshotEntities = [
+  AccountEntity,
+  AssetEntity,
+  LiabilityEntity,
+  GoalEntity,
+  NetWorthSnapshotEntity
+];
+var wealthSnapshotSchemaContribution = {
+  moduleId: "@contractspec/example.wealth-snapshot",
+  entities: wealthSnapshotEntities,
+  enums: [
+    AccountTypeEnum,
+    AssetCategoryEnum,
+    LiabilityCategoryEnum,
+    GoalStatusEnum
+  ]
+};
+export {
+  wealthSnapshotSchemaContribution,
+  wealthSnapshotEntities,
+  NetWorthSnapshotEntity,
+  LiabilityEntity,
+  LiabilityCategoryEnum,
+  GoalStatusEnum,
+  GoalEntity,
+  AssetEntity,
+  AssetCategoryEnum,
+  AccountTypeEnum,
+  AccountEntity
+};

package/dist/browser/events.js

@@ -0,0 +1,111 @@
+// src/events.ts
+import { ScalarTypeEnum, defineSchemaModel } from "@contractspec/lib.schema";
+import { defineEvent, StabilityEnum } from "@contractspec/lib.contracts";
+var AssetEventPayload = defineSchemaModel({
+  name: "AssetEventPayload",
+  description: "Payload for asset events",
+  fields: {
+    assetId: { 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 },
+    orgId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    timestamp: { type: ScalarTypeEnum.DateTime(), isOptional: false }
+  }
+});
+var LiabilityEventPayload = defineSchemaModel({
+  name: "LiabilityEventPayload",
+  description: "Payload for liability events",
+  fields: {
+    liabilityId: { 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 },
+    orgId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    timestamp: { type: ScalarTypeEnum.DateTime(), isOptional: false }
+  }
+});
+var GoalEventPayload = defineSchemaModel({
+  name: "GoalEventPayload",
+  description: "Payload for goal events",
+  fields: {
+    goalId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    status: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    currentAmount: { type: ScalarTypeEnum.Float_unsecure(), isOptional: false },
+    targetAmount: { type: ScalarTypeEnum.Float_unsecure(), isOptional: false },
+    currency: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    orgId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    timestamp: { type: ScalarTypeEnum.DateTime(), isOptional: false }
+  }
+});
+var AssetAddedEvent = defineEvent({
+  meta: {
+    key: "wealth.asset.added",
+    version: "1.0.0",
+    description: "An asset was added or updated.",
+    stability: StabilityEnum.Experimental,
+    owners: [],
+    tags: []
+  },
+  payload: AssetEventPayload
+});
+var LiabilityAddedEvent = defineEvent({
+  meta: {
+    key: "wealth.liability.added",
+    version: "1.0.0",
+    description: "A liability was added or updated.",
+    stability: StabilityEnum.Experimental,
+    owners: [],
+    tags: []
+  },
+  payload: LiabilityEventPayload
+});
+var GoalUpdatedEvent = defineEvent({
+  meta: {
+    key: "wealth.goal.updated",
+    version: "1.0.0",
+    description: "A goal was updated.",
+    stability: StabilityEnum.Experimental,
+    owners: [],
+    tags: []
+  },
+  payload: GoalEventPayload
+});
+var NetWorthSnapshotCreatedEvent = defineEvent({
+  meta: {
+    key: "wealth.networth.snapshot_created",
+    version: "1.0.0",
+    description: "A net worth snapshot was generated.",
+    stability: StabilityEnum.Experimental,
+    owners: [],
+    tags: []
+  },
+  payload: defineSchemaModel({
+    name: "NetWorthSnapshotEventPayload",
+    description: "Net worth snapshot payload",
+    fields: {
+      netWorth: { type: ScalarTypeEnum.Float_unsecure(), isOptional: false },
+      totalAssets: { type: ScalarTypeEnum.Float_unsecure(), isOptional: false },
+      totalLiabilities: {
+        type: ScalarTypeEnum.Float_unsecure(),
+        isOptional: false
+      },
+      currency: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+      orgId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+      asOf: { type: ScalarTypeEnum.DateTime(), isOptional: false }
+    }
+  })
+});
+var WealthSnapshotEvents = {
+  AssetAddedEvent,
+  LiabilityAddedEvent,
+  GoalUpdatedEvent,
+  NetWorthSnapshotCreatedEvent
+};
+export {
+  WealthSnapshotEvents,
+  NetWorthSnapshotCreatedEvent,
+  LiabilityAddedEvent,
+  GoalUpdatedEvent,
+  AssetAddedEvent
+};

package/dist/browser/example.js

@@ -0,0 +1,42 @@
+// src/example.ts
+import { defineExample } from "@contractspec/lib.contracts";
+var example = defineExample({
+  meta: {
+    key: "wealth-snapshot",
+    version: "1.0.0",
+    title: "Wealth Snapshot",
+    description: "Simple wealth overview with accounts, assets, liabilities, goals, and net-worth snapshots.",
+    kind: "template",
+    visibility: "public",
+    stability: "experimental",
+    owners: ["@platform.core"],
+    tags: ["finance", "net-worth", "goals"]
+  },
+  docs: {
+    rootDocId: "docs.examples.wealth-snapshot",
+    goalDocId: "docs.examples.wealth-snapshot.goal",
+    usageDocId: "docs.examples.wealth-snapshot.usage",
+    constraintsDocId: "docs.examples.wealth-snapshot.constraints"
+  },
+  entrypoints: {
+    packageName: "@contractspec/example.wealth-snapshot",
+    feature: "./feature",
+    contracts: "./contracts",
+    presentations: "./presentations",
+    handlers: "./handlers",
+    docs: "./docs"
+  },
+  surfaces: {
+    templates: true,
+    sandbox: {
+      enabled: true,
+      modes: ["playground", "specs", "builder", "markdown", "evolution"]
+    },
+    studio: { enabled: true, installable: true },
+    mcp: { enabled: true }
+  }
+});
+var example_default = example;
+export {
+  example_default as default
+};

package/dist/browser/handlers/index.js

@@ -0,0 +1,5 @@
+// src/handlers/index.ts
+function registerWealthSnapshotHandlers() {}
+export {
+  registerWealthSnapshotHandlers
+};