@contractspec/example.pocket-family-office 3.7.6 → 3.7.10

package/README.md

@@ -1,43 +1,79 @@
-# Pocket Family Office Vertical
-
-Website: https://contractspec.io/
-
-
-This vertical demonstrates how a spec-first application orchestrates
-financial document automation, payment reminders, and AI summarisation
-using ContractSpec. It is designed for multi-tenant deployments where
-each household configures its own integrations while reusing a shared
-blueprint.
-
-## Contents
-
-- `blueprint.ts` – the global `AppBlueprintSpec` describing required
-  capabilities, integration slots, workflows, and telemetry.
-- `tenant.sample.ts` – example `TenantAppConfig` showing per-tenant
-  bindings to integrations, knowledge spaces, and locales.
-- `connections/` – sample `IntegrationConnection` descriptors for the
-  nine priority providers (Mistral, Qdrant, GCS, Gmail, Google Calendar,
-  Postmark, ElevenLabs, Stripe, Twilio).
-- `knowledge/` – example `KnowledgeSourceConfig` entries wiring Gmail
-  threads and uploaded documents into canonical knowledge spaces.
-- `contracts/` – command specs powering document ingestion, reminders,
-  financial summaries, and Gmail synchronisation.
-- `workflows/` – workflow specs orchestrating end-to-end automation for
-  uploads, reminders, financial overviews, and email ingestion.
-- `tests/` – Vitest scenarios covering blueprint validation, config
-  composition, and a full end-to-end ingestion/query flow.
+# @contractspec/example.pocket-family-office
+
+Website: https://contractspec.io
+
+**Pocket Family Office example - personal finance automation with open banking.**
+
+## What This Demonstrates
+
+- Workflow-driven open banking integration (sync accounts, transactions, balances).
+- Financial summary and overview generation workflows.
+- Document processing and email thread ingestion.
+- Capability and feature definition patterns.
+- Canonical `telemetry` export via `pocketFamilyOfficeTelemetry`.
+- Sample tenant and connection configuration.
+
+## Running Locally
+
+From `packages/examples/pocket-family-office`:
+- `bun run dev`
+- `bun run build`
+- `bun run test`
+- `bun run typecheck`
 
 ## Usage
 
-The files are designed for direct consumption inside tests, CLI
-generators, or documentation tooling. They depend exclusively on the
-public APIs exported by `@contractspec/lib.contracts-spec`, making them safe to copy
-into downstream projects or use as a reference implementation during the
-Pocket Family Office hackathon.
+Use `@contractspec/example.pocket-family-office` as a reference implementation, or import its exported surfaces into a workspace that composes ContractSpec examples and bundles.
+
+## Architecture
+
+- `src/blueprint.ts` is part of the package's public or composition surface.
+- `src/connections` is part of the package's public or composition surface.
+- `src/docs/` contains docblocks and documentation-facing exports.
+- `src/example.ts` is the runnable example entrypoint.
+- `src/index.ts` is the root public barrel and package entrypoint.
+- `src/knowledge` is part of the package's public or composition surface.
+- `src/operations` is part of the package's public or composition surface.
+- `src/telemetry.ts` defines the exported telemetry spec.
+
+## Public Entry Points
 
+- Export `.` resolves through `./src/index.ts`.
+- Export `./blueprint` resolves through `./src/blueprint.ts`.
+- Export `./connections/samples` resolves through `./src/connections/samples.ts`.
+- Export `./docs` resolves through `./src/docs/index.ts`.
+- Export `./docs/pocket-family-office.docblock` resolves through `./src/docs/pocket-family-office.docblock.ts`.
+- Export `./example` resolves through `./src/example.ts`.
+- Export `./knowledge/sources.sample` resolves through `./src/knowledge/sources.sample.ts`.
+- Export `./operations` resolves through `./src/operations/index.ts`.
+- Export `./pocket-family-office.capability` resolves through `./src/pocket-family-office.capability.ts`.
+- Export `./pocket-family-office.feature` resolves through `./src/pocket-family-office.feature.ts`.
+- Export `./telemetry` resolves through `./src/telemetry.ts`.
+- The package publishes 20 total export subpaths; keep docs aligned with `package.json`.
 
+## Local Commands
 
+- `bun run dev` — contractspec-bun-build dev
+- `bun run build` — bun run prebuild && bun run build:bundle && bun run build:types
+- `bun run test` — bun test
+- `bun run lint` — bun lint:fix
+- `bun run lint:check` — biome check .
+- `bun run lint:fix` — biome check --write --unsafe --only=nursery/useSortedClasses . && biome check --write .
+- `bun run typecheck` — tsc --noEmit
+- `bun run publish:pkg` — bun publish --tolerate-republish --ignore-scripts --verbose
+- `bun run publish:pkg:canary` — bun publish:pkg --tag canary
+- `bun run clean` — bun rimraf dist .turbo
+- `bun run build:bundle` — contractspec-bun-build transpile
+- `bun run build:types` — contractspec-bun-build types
+- `bun run prebuild` — contractspec-bun-build prebuild
 
+## Recent Updates
 
+- Replace eslint+prettier by biomejs to optimize speed.
+- Missing contract layers.
+- Resolve lint/test regressions after voice capability updates.
+- Major change to content generation.
 
+## Notes
 
+- Works alongside `@contractspec/lib.contracts-integrations`, `@contractspec/lib.contracts-spec`, `@contractspec/lib.knowledge`, `@contractspec/lib.schema`, `@contractspec/tool.bun`, ...