example.pocket-family-office
Pocket Family Office example - personal finance automation with open banking
@lssm-tech/example.pocket-family-officebun add @lssm-tech/example.pocket-family-officeManifest declarations describe the current workspace; they do not verify registry publication or runtime execution.
Package guide
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
telemetryexport viapocketFamilyOfficeTelemetry. - Sample tenant and connection configuration.
- An inline
PocketFamilyOfficePreviewUI for template and example browsers.
Running Locally
From examples/pocket-family-office:
bun run devbun run buildbun run testbun run typecheck
Usage
Use @lssm-tech/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.tsis part of the package's public or composition surface.src/connectionsis part of the package's public or composition surface.src/docs/contains docblocks and documentation-facing exports.src/example.tsis the runnable example entrypoint.src/index.tsis the root public barrel and package entrypoint.src/knowledgeis part of the package's public or composition surface.src/operationsis part of the package's public or composition surface.src/telemetry.tsdefines the exported telemetry spec.src/ui/contains the inline preview surface for catalog and template browsers.
Public Entry Points
- Export
.resolves through./src/index.ts. - Export
./blueprintresolves through./src/blueprint.ts. - Export
./connections/samplesresolves through./src/connections/samples.ts. - Export
./docsresolves through./src/docs/index.ts. - Export
./docs/pocket-family-office.docblockis an alias of./docsand resolves through./src/docs/index.ts. - Export
./exampleresolves through./src/example.ts. - Export
./knowledge/sources.sampleresolves through./src/knowledge/sources.sample.ts. - Export
./operationsresolves through./src/operations/index.ts. - Export
./pocket-family-office.capabilityresolves through./src/pocket-family-office.capability.ts. - Export
./pocket-family-office.featureresolves through./src/pocket-family-office.feature.ts. - Export
./telemetryresolves through./src/telemetry.ts. - Export
./tenant.sampleresolves through./src/tenant.sample.ts. - Export
./uiresolves through./src/ui/index.ts. - Export
./ui/PocketFamilyOfficePreviewresolves through./src/ui/PocketFamilyOfficePreview.tsx. - Export
./ui/pocket-family-office-preview.dataresolves through./src/ui/pocket-family-office-preview.data.ts. - Export
./workflowsresolves through./src/workflows/index.ts. - The package publishes 24 total export subpaths; keep docs aligned with
package.json.
Local Commands
bun run dev— contractspec-bun-build devbun run build— contractspec-bun-build buildbun run test— bun testbun run lint— bun lint:fixbun run lint:check— biome check .bun run lint:fix— biome check --write --unsafe --only=nursery/useSortedClasses . && biome check --write .bun run typecheck— tsgo --noEmitbun run publish:pkg— bun publish --tolerate-republish --ignore-scripts --verbosebun run publish:pkg:canary— bun publish:pkg --tag canarybun run clean— bun rimraf dist .turbobun run build:bundle— contractspec-bun-build transpilebun run build:types— contractspec-bun-build typesbun 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
@lssm-tech/lib.contracts-integrations,@lssm-tech/lib.contracts-spec,@lssm-tech/lib.knowledge,@lssm-tech/lib.schema,@lssm-tech/tool.bun, ...
Relationships
Arrows point from a package to its direct dependency. Counts are derived from captured workspace manifests.
7 declarations
@lssm-tech/lib.contracts-integrationsworkspace:^
Read the package manual ↗@lssm-tech/lib.contracts-specworkspace:^
Read the package manual ↗@lssm-tech/lib.design-systemworkspace:^
Read the package manual ↗@lssm-tech/lib.knowledgeworkspace:^
Read the package manual ↗@lssm-tech/lib.schemaworkspace:^
Read the package manual ↗reactcatalog:
Declared capabilities
This manifest does not declare a capability catalogue. Use the guide, import map and source to assess the package.
Scripts
publish:pkgbun publish --tolerate-republish --ignore-scripts --verbosepublish:pkg:canarybun publish:pkg --tag canarybuildcontractspec-bun-build buildbuild:bundlecontractspec-bun-build transpilebuild:typescontractspec-bun-build typesdevcontractspec-bun-build devcleanbun rimraf dist .turbolintbun lint:fixlint:fixnode ../../scripts/biome.cjs check --write --unsafe --only=nursery/useSortedClasses . && node ../../scripts/biome.cjs check --write .lint:checknode ../../scripts/biome.cjs check .prebuildcontractspec-bun-build prebuildtestbun testtypechecktsgo --noEmit