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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -940,6 +940,123 @@ var PocketFamilyOfficeFeature = defineFeature({
940
940
  "docs.examples.pocket-family-office.reference"
941
941
  ]
942
942
  });
943
+ var tech_contracts_vertical_pocket_family_office_DocBlocks = [
944
+ {
945
+ id: "docs.tech.contracts.vertical-pocket-family-office",
946
+ title: "Pocket Family Office Vertical",
947
+ summary: "Pocket Family Office is a ContractSpec reference vertical that",
948
+ kind: "reference",
949
+ visibility: "public",
950
+ route: "/docs/tech/contracts/vertical-pocket-family-office",
951
+ tags: ["tech", "contracts", "vertical-pocket-family-office"],
952
+ body: `# Pocket Family Office Vertical
953
+
954
+ Pocket Family Office is a ContractSpec reference vertical that
955
+ demonstrates finance automation atop the integration and knowledge
956
+ layers. It is optimised for the hackathon stack (Google Cloud, Mistral,
957
+ Qdrant, ElevenLabs) while remaining provider-agnostic.
958
+
959
+ ## Goals
960
+
961
+ - Ingest household financial documents (uploads + Gmail threads).
962
+ - Generate AI summaries and optionally deliver them as voice notes.
963
+ - Schedule multi-channel reminders for upcoming bills.
964
+ - Showcase spec-first composition of integrations, knowledge spaces, and
965
+ workflows.
966
+
967
+ ## Blueprint Overview
968
+
969
+ Source: \`packages/examples/pocket-family-office/blueprint.ts\`
970
+
971
+ - **Integration slots**
972
+ - \`primaryLLM\` → Mistral chat/embeddings
973
+ - \`primaryVectorDb\` → Qdrant
974
+ - \`primaryStorage\` → Google Cloud Storage
975
+ - \`primaryOpenBanking\` → Powens BYOK project for account aggregation
976
+ - \`emailInbound\` / \`emailOutbound\` → Gmail + Postmark
977
+ - \`calendarScheduling\` → Google Calendar
978
+ - \`voicePlayback\` → ElevenLabs (optional)
979
+ - \`smsNotifications\` → Twilio (optional)
980
+ - \`paymentsProcessing\` → Stripe (optional)
981
+ - **Workflows**
982
+ - \`process-uploaded-document\`
983
+ - \`upcoming-payments-reminder\`
984
+ - \`generate-financial-summary\`
985
+ - \`ingest-email-threads\`
986
+ - \`sync-openbanking-accounts\`
987
+ - \`sync-openbanking-transactions\`
988
+ - \`refresh-openbanking-balances\`
989
+ - \`generate-openbanking-overview\`
990
+ - **Policies/Telemetry** – references tenant policy specs and
991
+ \`pfo.telemetry\` for observability.
992
+
993
+ ## Tenant Sample
994
+
995
+ \`tenant.sample.ts\` binds each slot to sample connections defined in
996
+ \`connections/samples.ts\`. Key details:
997
+
998
+ - Uses Google Cloud Secret Manager URIs for all credentials.
999
+ - Enables knowledge spaces \`knowledge.financial-docs\` and
1000
+ \`knowledge.email-threads\`, plus the derived summaries space
1001
+ \`knowledge.financial-overview\` populated by open banking workflows.
1002
+ - Keeps \`voicePlayback\` and \`paymentsProcessing\` optional so tenants can
1003
+ enable them incrementally.
1004
+
1005
+ ## Contracts
1006
+
1007
+ \`contracts/index.ts\` defines command/query specs that power the
1008
+ workflows:
1009
+
1010
+ - \`pfo.documents.upload\` – store object + enqueue ingestion.
1011
+ - \`pfo.reminders.schedule-payment\` – send email/SMS/calendar reminders.
1012
+ - \`pfo.summary.generate\` – run RAG over knowledge spaces.
1013
+ - \`pfo.summary.dispatch\` – deliver summaries via email / voice.
1014
+ - \`pfo.email.sync-threads\` – ingest Gmail threads.
1015
+
1016
+ ## Workflows
1017
+
1018
+ - **Process Uploaded Document**
1019
+ 1. Upload to storage / queue ingestion.
1020
+ 2. Optional human review step.
1021
+ - **Upcoming Payments Reminder**
1022
+ 1. Human review (confirm due date / channel).
1023
+ 2. Automation schedules reminders (email/SMS/calendar).
1024
+ - **Generate Financial Summary**
1025
+ 1. Run RAG to produce Markdown summary.
1026
+ 2. Dispatch summary (email + optional ElevenLabs voice note).
1027
+ - **Ingest Email Threads**
1028
+ 1. Sync Gmail threads into knowledge space.
1029
+ 2. Triage step for operators when nothing new is ingested.
1030
+
1031
+ ## Knowledge & Jobs
1032
+
1033
+ - Knowledge spaces registered via
1034
+ \`registerFinancialDocsKnowledgeSpace\` and
1035
+ \`registerEmailThreadsKnowledgeSpace\`.
1036
+ - Ingestion adapters (\`GmailIngestionAdapter\`, \`StorageIngestionAdapter\`)
1037
+ and job handlers (\`createGmailSyncHandler\`,
1038
+ \`createStorageDocumentHandler\`) wire Gmail labels & GCS prefixes into
1039
+ Qdrant.
1040
+ - \`KnowledgeQueryService\` provides summarisation + references for the
1041
+ summary generation workflow.
1042
+
1043
+ ## Tests & Usage
1044
+
1045
+ \`tests/pocket-family-office.test.ts\` exercises:
1046
+
1047
+ - Blueprint validation + config composition.
1048
+ - In-memory ingestion of a sample invoice.
1049
+ - Retrieval augmented generation producing a summary with references.
1050
+
1051
+ Use these files as scaffolding for new tenants or as a template for the
1052
+ hackathon deliverable. Replace the sample connection metadata with
1053
+ tenant-specific IDs/secret references before deploying.
1054
+
1055
+
1056
+
1057
+ `
1058
+ }
1059
+ ];
943
1060
 
944
1061
  // src/telemetry.ts
945
1062
  import {
@@ -1643,6 +1760,7 @@ var upcomingPaymentsReminderWorkflow = defineWorkflow8({
1643
1760
  export {
1644
1761
  uploadDocumentContract,
1645
1762
  upcomingPaymentsReminderWorkflow,
1763
+ tech_contracts_vertical_pocket_family_office_DocBlocks,
1646
1764
  syncOpenBankingTransactionsWorkflow,
1647
1765
  syncOpenBankingAccountsWorkflow,
1648
1766
  syncEmailThreadsContract,
@@ -67,6 +67,124 @@ var PocketFamilyOfficeFeature = defineFeature({
67
67
  "docs.examples.pocket-family-office.reference"
68
68
  ]
69
69
  });
70
+ var tech_contracts_vertical_pocket_family_office_DocBlocks = [
71
+ {
72
+ id: "docs.tech.contracts.vertical-pocket-family-office",
73
+ title: "Pocket Family Office Vertical",
74
+ summary: "Pocket Family Office is a ContractSpec reference vertical that",
75
+ kind: "reference",
76
+ visibility: "public",
77
+ route: "/docs/tech/contracts/vertical-pocket-family-office",
78
+ tags: ["tech", "contracts", "vertical-pocket-family-office"],
79
+ body: `# Pocket Family Office Vertical
80
+
81
+ Pocket Family Office is a ContractSpec reference vertical that
82
+ demonstrates finance automation atop the integration and knowledge
83
+ layers. It is optimised for the hackathon stack (Google Cloud, Mistral,
84
+ Qdrant, ElevenLabs) while remaining provider-agnostic.
85
+
86
+ ## Goals
87
+
88
+ - Ingest household financial documents (uploads + Gmail threads).
89
+ - Generate AI summaries and optionally deliver them as voice notes.
90
+ - Schedule multi-channel reminders for upcoming bills.
91
+ - Showcase spec-first composition of integrations, knowledge spaces, and
92
+ workflows.
93
+
94
+ ## Blueprint Overview
95
+
96
+ Source: \`packages/examples/pocket-family-office/blueprint.ts\`
97
+
98
+ - **Integration slots**
99
+ - \`primaryLLM\` → Mistral chat/embeddings
100
+ - \`primaryVectorDb\` → Qdrant
101
+ - \`primaryStorage\` → Google Cloud Storage
102
+ - \`primaryOpenBanking\` → Powens BYOK project for account aggregation
103
+ - \`emailInbound\` / \`emailOutbound\` → Gmail + Postmark
104
+ - \`calendarScheduling\` → Google Calendar
105
+ - \`voicePlayback\` → ElevenLabs (optional)
106
+ - \`smsNotifications\` → Twilio (optional)
107
+ - \`paymentsProcessing\` → Stripe (optional)
108
+ - **Workflows**
109
+ - \`process-uploaded-document\`
110
+ - \`upcoming-payments-reminder\`
111
+ - \`generate-financial-summary\`
112
+ - \`ingest-email-threads\`
113
+ - \`sync-openbanking-accounts\`
114
+ - \`sync-openbanking-transactions\`
115
+ - \`refresh-openbanking-balances\`
116
+ - \`generate-openbanking-overview\`
117
+ - **Policies/Telemetry** – references tenant policy specs and
118
+ \`pfo.telemetry\` for observability.
119
+
120
+ ## Tenant Sample
121
+
122
+ \`tenant.sample.ts\` binds each slot to sample connections defined in
123
+ \`connections/samples.ts\`. Key details:
124
+
125
+ - Uses Google Cloud Secret Manager URIs for all credentials.
126
+ - Enables knowledge spaces \`knowledge.financial-docs\` and
127
+ \`knowledge.email-threads\`, plus the derived summaries space
128
+ \`knowledge.financial-overview\` populated by open banking workflows.
129
+ - Keeps \`voicePlayback\` and \`paymentsProcessing\` optional so tenants can
130
+ enable them incrementally.
131
+
132
+ ## Contracts
133
+
134
+ \`contracts/index.ts\` defines command/query specs that power the
135
+ workflows:
136
+
137
+ - \`pfo.documents.upload\` – store object + enqueue ingestion.
138
+ - \`pfo.reminders.schedule-payment\` – send email/SMS/calendar reminders.
139
+ - \`pfo.summary.generate\` – run RAG over knowledge spaces.
140
+ - \`pfo.summary.dispatch\` – deliver summaries via email / voice.
141
+ - \`pfo.email.sync-threads\` – ingest Gmail threads.
142
+
143
+ ## Workflows
144
+
145
+ - **Process Uploaded Document**
146
+ 1. Upload to storage / queue ingestion.
147
+ 2. Optional human review step.
148
+ - **Upcoming Payments Reminder**
149
+ 1. Human review (confirm due date / channel).
150
+ 2. Automation schedules reminders (email/SMS/calendar).
151
+ - **Generate Financial Summary**
152
+ 1. Run RAG to produce Markdown summary.
153
+ 2. Dispatch summary (email + optional ElevenLabs voice note).
154
+ - **Ingest Email Threads**
155
+ 1. Sync Gmail threads into knowledge space.
156
+ 2. Triage step for operators when nothing new is ingested.
157
+
158
+ ## Knowledge & Jobs
159
+
160
+ - Knowledge spaces registered via
161
+ \`registerFinancialDocsKnowledgeSpace\` and
162
+ \`registerEmailThreadsKnowledgeSpace\`.
163
+ - Ingestion adapters (\`GmailIngestionAdapter\`, \`StorageIngestionAdapter\`)
164
+ and job handlers (\`createGmailSyncHandler\`,
165
+ \`createStorageDocumentHandler\`) wire Gmail labels & GCS prefixes into
166
+ Qdrant.
167
+ - \`KnowledgeQueryService\` provides summarisation + references for the
168
+ summary generation workflow.
169
+
170
+ ## Tests & Usage
171
+
172
+ \`tests/pocket-family-office.test.ts\` exercises:
173
+
174
+ - Blueprint validation + config composition.
175
+ - In-memory ingestion of a sample invoice.
176
+ - Retrieval augmented generation producing a summary with references.
177
+
178
+ Use these files as scaffolding for new tenants or as a template for the
179
+ hackathon deliverable. Replace the sample connection metadata with
180
+ tenant-specific IDs/secret references before deploying.
181
+
182
+
183
+
184
+ `
185
+ }
186
+ ];
70
187
  export {
188
+ tech_contracts_vertical_pocket_family_office_DocBlocks,
71
189
  PocketFamilyOfficeFeature
72
190
  };
package/dist/index.js CHANGED
@@ -941,6 +941,123 @@ var PocketFamilyOfficeFeature = defineFeature({
941
941
  "docs.examples.pocket-family-office.reference"
942
942
  ]
943
943
  });
944
+ var tech_contracts_vertical_pocket_family_office_DocBlocks = [
945
+ {
946
+ id: "docs.tech.contracts.vertical-pocket-family-office",
947
+ title: "Pocket Family Office Vertical",
948
+ summary: "Pocket Family Office is a ContractSpec reference vertical that",
949
+ kind: "reference",
950
+ visibility: "public",
951
+ route: "/docs/tech/contracts/vertical-pocket-family-office",
952
+ tags: ["tech", "contracts", "vertical-pocket-family-office"],
953
+ body: `# Pocket Family Office Vertical
954
+
955
+ Pocket Family Office is a ContractSpec reference vertical that
956
+ demonstrates finance automation atop the integration and knowledge
957
+ layers. It is optimised for the hackathon stack (Google Cloud, Mistral,
958
+ Qdrant, ElevenLabs) while remaining provider-agnostic.
959
+
960
+ ## Goals
961
+
962
+ - Ingest household financial documents (uploads + Gmail threads).
963
+ - Generate AI summaries and optionally deliver them as voice notes.
964
+ - Schedule multi-channel reminders for upcoming bills.
965
+ - Showcase spec-first composition of integrations, knowledge spaces, and
966
+ workflows.
967
+
968
+ ## Blueprint Overview
969
+
970
+ Source: \`packages/examples/pocket-family-office/blueprint.ts\`
971
+
972
+ - **Integration slots**
973
+ - \`primaryLLM\` \u2192 Mistral chat/embeddings
974
+ - \`primaryVectorDb\` \u2192 Qdrant
975
+ - \`primaryStorage\` \u2192 Google Cloud Storage
976
+ - \`primaryOpenBanking\` \u2192 Powens BYOK project for account aggregation
977
+ - \`emailInbound\` / \`emailOutbound\` \u2192 Gmail + Postmark
978
+ - \`calendarScheduling\` \u2192 Google Calendar
979
+ - \`voicePlayback\` \u2192 ElevenLabs (optional)
980
+ - \`smsNotifications\` \u2192 Twilio (optional)
981
+ - \`paymentsProcessing\` \u2192 Stripe (optional)
982
+ - **Workflows**
983
+ - \`process-uploaded-document\`
984
+ - \`upcoming-payments-reminder\`
985
+ - \`generate-financial-summary\`
986
+ - \`ingest-email-threads\`
987
+ - \`sync-openbanking-accounts\`
988
+ - \`sync-openbanking-transactions\`
989
+ - \`refresh-openbanking-balances\`
990
+ - \`generate-openbanking-overview\`
991
+ - **Policies/Telemetry** \u2013 references tenant policy specs and
992
+ \`pfo.telemetry\` for observability.
993
+
994
+ ## Tenant Sample
995
+
996
+ \`tenant.sample.ts\` binds each slot to sample connections defined in
997
+ \`connections/samples.ts\`. Key details:
998
+
999
+ - Uses Google Cloud Secret Manager URIs for all credentials.
1000
+ - Enables knowledge spaces \`knowledge.financial-docs\` and
1001
+ \`knowledge.email-threads\`, plus the derived summaries space
1002
+ \`knowledge.financial-overview\` populated by open banking workflows.
1003
+ - Keeps \`voicePlayback\` and \`paymentsProcessing\` optional so tenants can
1004
+ enable them incrementally.
1005
+
1006
+ ## Contracts
1007
+
1008
+ \`contracts/index.ts\` defines command/query specs that power the
1009
+ workflows:
1010
+
1011
+ - \`pfo.documents.upload\` \u2013 store object + enqueue ingestion.
1012
+ - \`pfo.reminders.schedule-payment\` \u2013 send email/SMS/calendar reminders.
1013
+ - \`pfo.summary.generate\` \u2013 run RAG over knowledge spaces.
1014
+ - \`pfo.summary.dispatch\` \u2013 deliver summaries via email / voice.
1015
+ - \`pfo.email.sync-threads\` \u2013 ingest Gmail threads.
1016
+
1017
+ ## Workflows
1018
+
1019
+ - **Process Uploaded Document**
1020
+ 1. Upload to storage / queue ingestion.
1021
+ 2. Optional human review step.
1022
+ - **Upcoming Payments Reminder**
1023
+ 1. Human review (confirm due date / channel).
1024
+ 2. Automation schedules reminders (email/SMS/calendar).
1025
+ - **Generate Financial Summary**
1026
+ 1. Run RAG to produce Markdown summary.
1027
+ 2. Dispatch summary (email + optional ElevenLabs voice note).
1028
+ - **Ingest Email Threads**
1029
+ 1. Sync Gmail threads into knowledge space.
1030
+ 2. Triage step for operators when nothing new is ingested.
1031
+
1032
+ ## Knowledge & Jobs
1033
+
1034
+ - Knowledge spaces registered via
1035
+ \`registerFinancialDocsKnowledgeSpace\` and
1036
+ \`registerEmailThreadsKnowledgeSpace\`.
1037
+ - Ingestion adapters (\`GmailIngestionAdapter\`, \`StorageIngestionAdapter\`)
1038
+ and job handlers (\`createGmailSyncHandler\`,
1039
+ \`createStorageDocumentHandler\`) wire Gmail labels & GCS prefixes into
1040
+ Qdrant.
1041
+ - \`KnowledgeQueryService\` provides summarisation + references for the
1042
+ summary generation workflow.
1043
+
1044
+ ## Tests & Usage
1045
+
1046
+ \`tests/pocket-family-office.test.ts\` exercises:
1047
+
1048
+ - Blueprint validation + config composition.
1049
+ - In-memory ingestion of a sample invoice.
1050
+ - Retrieval augmented generation producing a summary with references.
1051
+
1052
+ Use these files as scaffolding for new tenants or as a template for the
1053
+ hackathon deliverable. Replace the sample connection metadata with
1054
+ tenant-specific IDs/secret references before deploying.
1055
+
1056
+
1057
+
1058
+ `
1059
+ }
1060
+ ];
944
1061
 
945
1062
  // src/telemetry.ts
946
1063
  import {
@@ -1644,6 +1761,7 @@ var upcomingPaymentsReminderWorkflow = defineWorkflow8({
1644
1761
  export {
1645
1762
  uploadDocumentContract,
1646
1763
  upcomingPaymentsReminderWorkflow,
1764
+ tech_contracts_vertical_pocket_family_office_DocBlocks,
1647
1765
  syncOpenBankingTransactionsWorkflow,
1648
1766
  syncOpenBankingAccountsWorkflow,
1649
1767
  syncEmailThreadsContract,
@@ -940,6 +940,123 @@ var PocketFamilyOfficeFeature = defineFeature({
940
940
  "docs.examples.pocket-family-office.reference"
941
941
  ]
942
942
  });
943
+ var tech_contracts_vertical_pocket_family_office_DocBlocks = [
944
+ {
945
+ id: "docs.tech.contracts.vertical-pocket-family-office",
946
+ title: "Pocket Family Office Vertical",
947
+ summary: "Pocket Family Office is a ContractSpec reference vertical that",
948
+ kind: "reference",
949
+ visibility: "public",
950
+ route: "/docs/tech/contracts/vertical-pocket-family-office",
951
+ tags: ["tech", "contracts", "vertical-pocket-family-office"],
952
+ body: `# Pocket Family Office Vertical
953
+
954
+ Pocket Family Office is a ContractSpec reference vertical that
955
+ demonstrates finance automation atop the integration and knowledge
956
+ layers. It is optimised for the hackathon stack (Google Cloud, Mistral,
957
+ Qdrant, ElevenLabs) while remaining provider-agnostic.
958
+
959
+ ## Goals
960
+
961
+ - Ingest household financial documents (uploads + Gmail threads).
962
+ - Generate AI summaries and optionally deliver them as voice notes.
963
+ - Schedule multi-channel reminders for upcoming bills.
964
+ - Showcase spec-first composition of integrations, knowledge spaces, and
965
+ workflows.
966
+
967
+ ## Blueprint Overview
968
+
969
+ Source: \`packages/examples/pocket-family-office/blueprint.ts\`
970
+
971
+ - **Integration slots**
972
+ - \`primaryLLM\` → Mistral chat/embeddings
973
+ - \`primaryVectorDb\` → Qdrant
974
+ - \`primaryStorage\` → Google Cloud Storage
975
+ - \`primaryOpenBanking\` → Powens BYOK project for account aggregation
976
+ - \`emailInbound\` / \`emailOutbound\` → Gmail + Postmark
977
+ - \`calendarScheduling\` → Google Calendar
978
+ - \`voicePlayback\` → ElevenLabs (optional)
979
+ - \`smsNotifications\` → Twilio (optional)
980
+ - \`paymentsProcessing\` → Stripe (optional)
981
+ - **Workflows**
982
+ - \`process-uploaded-document\`
983
+ - \`upcoming-payments-reminder\`
984
+ - \`generate-financial-summary\`
985
+ - \`ingest-email-threads\`
986
+ - \`sync-openbanking-accounts\`
987
+ - \`sync-openbanking-transactions\`
988
+ - \`refresh-openbanking-balances\`
989
+ - \`generate-openbanking-overview\`
990
+ - **Policies/Telemetry** – references tenant policy specs and
991
+ \`pfo.telemetry\` for observability.
992
+
993
+ ## Tenant Sample
994
+
995
+ \`tenant.sample.ts\` binds each slot to sample connections defined in
996
+ \`connections/samples.ts\`. Key details:
997
+
998
+ - Uses Google Cloud Secret Manager URIs for all credentials.
999
+ - Enables knowledge spaces \`knowledge.financial-docs\` and
1000
+ \`knowledge.email-threads\`, plus the derived summaries space
1001
+ \`knowledge.financial-overview\` populated by open banking workflows.
1002
+ - Keeps \`voicePlayback\` and \`paymentsProcessing\` optional so tenants can
1003
+ enable them incrementally.
1004
+
1005
+ ## Contracts
1006
+
1007
+ \`contracts/index.ts\` defines command/query specs that power the
1008
+ workflows:
1009
+
1010
+ - \`pfo.documents.upload\` – store object + enqueue ingestion.
1011
+ - \`pfo.reminders.schedule-payment\` – send email/SMS/calendar reminders.
1012
+ - \`pfo.summary.generate\` – run RAG over knowledge spaces.
1013
+ - \`pfo.summary.dispatch\` – deliver summaries via email / voice.
1014
+ - \`pfo.email.sync-threads\` – ingest Gmail threads.
1015
+
1016
+ ## Workflows
1017
+
1018
+ - **Process Uploaded Document**
1019
+ 1. Upload to storage / queue ingestion.
1020
+ 2. Optional human review step.
1021
+ - **Upcoming Payments Reminder**
1022
+ 1. Human review (confirm due date / channel).
1023
+ 2. Automation schedules reminders (email/SMS/calendar).
1024
+ - **Generate Financial Summary**
1025
+ 1. Run RAG to produce Markdown summary.
1026
+ 2. Dispatch summary (email + optional ElevenLabs voice note).
1027
+ - **Ingest Email Threads**
1028
+ 1. Sync Gmail threads into knowledge space.
1029
+ 2. Triage step for operators when nothing new is ingested.
1030
+
1031
+ ## Knowledge & Jobs
1032
+
1033
+ - Knowledge spaces registered via
1034
+ \`registerFinancialDocsKnowledgeSpace\` and
1035
+ \`registerEmailThreadsKnowledgeSpace\`.
1036
+ - Ingestion adapters (\`GmailIngestionAdapter\`, \`StorageIngestionAdapter\`)
1037
+ and job handlers (\`createGmailSyncHandler\`,
1038
+ \`createStorageDocumentHandler\`) wire Gmail labels & GCS prefixes into
1039
+ Qdrant.
1040
+ - \`KnowledgeQueryService\` provides summarisation + references for the
1041
+ summary generation workflow.
1042
+
1043
+ ## Tests & Usage
1044
+
1045
+ \`tests/pocket-family-office.test.ts\` exercises:
1046
+
1047
+ - Blueprint validation + config composition.
1048
+ - In-memory ingestion of a sample invoice.
1049
+ - Retrieval augmented generation producing a summary with references.
1050
+
1051
+ Use these files as scaffolding for new tenants or as a template for the
1052
+ hackathon deliverable. Replace the sample connection metadata with
1053
+ tenant-specific IDs/secret references before deploying.
1054
+
1055
+
1056
+
1057
+ `
1058
+ }
1059
+ ];
943
1060
 
944
1061
  // src/telemetry.ts
945
1062
  import {
@@ -1643,6 +1760,7 @@ var upcomingPaymentsReminderWorkflow = defineWorkflow8({
1643
1760
  export {
1644
1761
  uploadDocumentContract,
1645
1762
  upcomingPaymentsReminderWorkflow,
1763
+ tech_contracts_vertical_pocket_family_office_DocBlocks,
1646
1764
  syncOpenBankingTransactionsWorkflow,
1647
1765
  syncOpenBankingAccountsWorkflow,
1648
1766
  syncEmailThreadsContract,
@@ -67,6 +67,124 @@ var PocketFamilyOfficeFeature = defineFeature({
67
67
  "docs.examples.pocket-family-office.reference"
68
68
  ]
69
69
  });
70
+ var tech_contracts_vertical_pocket_family_office_DocBlocks = [
71
+ {
72
+ id: "docs.tech.contracts.vertical-pocket-family-office",
73
+ title: "Pocket Family Office Vertical",
74
+ summary: "Pocket Family Office is a ContractSpec reference vertical that",
75
+ kind: "reference",
76
+ visibility: "public",
77
+ route: "/docs/tech/contracts/vertical-pocket-family-office",
78
+ tags: ["tech", "contracts", "vertical-pocket-family-office"],
79
+ body: `# Pocket Family Office Vertical
80
+
81
+ Pocket Family Office is a ContractSpec reference vertical that
82
+ demonstrates finance automation atop the integration and knowledge
83
+ layers. It is optimised for the hackathon stack (Google Cloud, Mistral,
84
+ Qdrant, ElevenLabs) while remaining provider-agnostic.
85
+
86
+ ## Goals
87
+
88
+ - Ingest household financial documents (uploads + Gmail threads).
89
+ - Generate AI summaries and optionally deliver them as voice notes.
90
+ - Schedule multi-channel reminders for upcoming bills.
91
+ - Showcase spec-first composition of integrations, knowledge spaces, and
92
+ workflows.
93
+
94
+ ## Blueprint Overview
95
+
96
+ Source: \`packages/examples/pocket-family-office/blueprint.ts\`
97
+
98
+ - **Integration slots**
99
+ - \`primaryLLM\` → Mistral chat/embeddings
100
+ - \`primaryVectorDb\` → Qdrant
101
+ - \`primaryStorage\` → Google Cloud Storage
102
+ - \`primaryOpenBanking\` → Powens BYOK project for account aggregation
103
+ - \`emailInbound\` / \`emailOutbound\` → Gmail + Postmark
104
+ - \`calendarScheduling\` → Google Calendar
105
+ - \`voicePlayback\` → ElevenLabs (optional)
106
+ - \`smsNotifications\` → Twilio (optional)
107
+ - \`paymentsProcessing\` → Stripe (optional)
108
+ - **Workflows**
109
+ - \`process-uploaded-document\`
110
+ - \`upcoming-payments-reminder\`
111
+ - \`generate-financial-summary\`
112
+ - \`ingest-email-threads\`
113
+ - \`sync-openbanking-accounts\`
114
+ - \`sync-openbanking-transactions\`
115
+ - \`refresh-openbanking-balances\`
116
+ - \`generate-openbanking-overview\`
117
+ - **Policies/Telemetry** – references tenant policy specs and
118
+ \`pfo.telemetry\` for observability.
119
+
120
+ ## Tenant Sample
121
+
122
+ \`tenant.sample.ts\` binds each slot to sample connections defined in
123
+ \`connections/samples.ts\`. Key details:
124
+
125
+ - Uses Google Cloud Secret Manager URIs for all credentials.
126
+ - Enables knowledge spaces \`knowledge.financial-docs\` and
127
+ \`knowledge.email-threads\`, plus the derived summaries space
128
+ \`knowledge.financial-overview\` populated by open banking workflows.
129
+ - Keeps \`voicePlayback\` and \`paymentsProcessing\` optional so tenants can
130
+ enable them incrementally.
131
+
132
+ ## Contracts
133
+
134
+ \`contracts/index.ts\` defines command/query specs that power the
135
+ workflows:
136
+
137
+ - \`pfo.documents.upload\` – store object + enqueue ingestion.
138
+ - \`pfo.reminders.schedule-payment\` – send email/SMS/calendar reminders.
139
+ - \`pfo.summary.generate\` – run RAG over knowledge spaces.
140
+ - \`pfo.summary.dispatch\` – deliver summaries via email / voice.
141
+ - \`pfo.email.sync-threads\` – ingest Gmail threads.
142
+
143
+ ## Workflows
144
+
145
+ - **Process Uploaded Document**
146
+ 1. Upload to storage / queue ingestion.
147
+ 2. Optional human review step.
148
+ - **Upcoming Payments Reminder**
149
+ 1. Human review (confirm due date / channel).
150
+ 2. Automation schedules reminders (email/SMS/calendar).
151
+ - **Generate Financial Summary**
152
+ 1. Run RAG to produce Markdown summary.
153
+ 2. Dispatch summary (email + optional ElevenLabs voice note).
154
+ - **Ingest Email Threads**
155
+ 1. Sync Gmail threads into knowledge space.
156
+ 2. Triage step for operators when nothing new is ingested.
157
+
158
+ ## Knowledge & Jobs
159
+
160
+ - Knowledge spaces registered via
161
+ \`registerFinancialDocsKnowledgeSpace\` and
162
+ \`registerEmailThreadsKnowledgeSpace\`.
163
+ - Ingestion adapters (\`GmailIngestionAdapter\`, \`StorageIngestionAdapter\`)
164
+ and job handlers (\`createGmailSyncHandler\`,
165
+ \`createStorageDocumentHandler\`) wire Gmail labels & GCS prefixes into
166
+ Qdrant.
167
+ - \`KnowledgeQueryService\` provides summarisation + references for the
168
+ summary generation workflow.
169
+
170
+ ## Tests & Usage
171
+
172
+ \`tests/pocket-family-office.test.ts\` exercises:
173
+
174
+ - Blueprint validation + config composition.
175
+ - In-memory ingestion of a sample invoice.
176
+ - Retrieval augmented generation producing a summary with references.
177
+
178
+ Use these files as scaffolding for new tenants or as a template for the
179
+ hackathon deliverable. Replace the sample connection metadata with
180
+ tenant-specific IDs/secret references before deploying.
181
+
182
+
183
+
184
+ `
185
+ }
186
+ ];
70
187
  export {
188
+ tech_contracts_vertical_pocket_family_office_DocBlocks,
71
189
  PocketFamilyOfficeFeature
72
190
  };
@@ -1,5 +1,12 @@
1
+ /**
2
+ * Pocket Family Office Feature Module Specification
3
+ *
4
+ * Defines the feature module for personal finance automation.
5
+ */
1
6
  /**
2
7
  * Pocket Family Office feature module that bundles financial document
3
8
  * management, open banking integration, and automated summaries.
4
9
  */
10
+ import type { DocBlock } from '@contractspec/lib.contracts-spec';
5
11
  export declare const PocketFamilyOfficeFeature: import("@contractspec/lib.contracts-spec").FeatureModuleSpec;
12
+ export declare const tech_contracts_vertical_pocket_family_office_DocBlocks: DocBlock[];
@@ -68,6 +68,124 @@ var PocketFamilyOfficeFeature = defineFeature({
68
68
  "docs.examples.pocket-family-office.reference"
69
69
  ]
70
70
  });
71
+ var tech_contracts_vertical_pocket_family_office_DocBlocks = [
72
+ {
73
+ id: "docs.tech.contracts.vertical-pocket-family-office",
74
+ title: "Pocket Family Office Vertical",
75
+ summary: "Pocket Family Office is a ContractSpec reference vertical that",
76
+ kind: "reference",
77
+ visibility: "public",
78
+ route: "/docs/tech/contracts/vertical-pocket-family-office",
79
+ tags: ["tech", "contracts", "vertical-pocket-family-office"],
80
+ body: `# Pocket Family Office Vertical
81
+
82
+ Pocket Family Office is a ContractSpec reference vertical that
83
+ demonstrates finance automation atop the integration and knowledge
84
+ layers. It is optimised for the hackathon stack (Google Cloud, Mistral,
85
+ Qdrant, ElevenLabs) while remaining provider-agnostic.
86
+
87
+ ## Goals
88
+
89
+ - Ingest household financial documents (uploads + Gmail threads).
90
+ - Generate AI summaries and optionally deliver them as voice notes.
91
+ - Schedule multi-channel reminders for upcoming bills.
92
+ - Showcase spec-first composition of integrations, knowledge spaces, and
93
+ workflows.
94
+
95
+ ## Blueprint Overview
96
+
97
+ Source: \`packages/examples/pocket-family-office/blueprint.ts\`
98
+
99
+ - **Integration slots**
100
+ - \`primaryLLM\` \u2192 Mistral chat/embeddings
101
+ - \`primaryVectorDb\` \u2192 Qdrant
102
+ - \`primaryStorage\` \u2192 Google Cloud Storage
103
+ - \`primaryOpenBanking\` \u2192 Powens BYOK project for account aggregation
104
+ - \`emailInbound\` / \`emailOutbound\` \u2192 Gmail + Postmark
105
+ - \`calendarScheduling\` \u2192 Google Calendar
106
+ - \`voicePlayback\` \u2192 ElevenLabs (optional)
107
+ - \`smsNotifications\` \u2192 Twilio (optional)
108
+ - \`paymentsProcessing\` \u2192 Stripe (optional)
109
+ - **Workflows**
110
+ - \`process-uploaded-document\`
111
+ - \`upcoming-payments-reminder\`
112
+ - \`generate-financial-summary\`
113
+ - \`ingest-email-threads\`
114
+ - \`sync-openbanking-accounts\`
115
+ - \`sync-openbanking-transactions\`
116
+ - \`refresh-openbanking-balances\`
117
+ - \`generate-openbanking-overview\`
118
+ - **Policies/Telemetry** \u2013 references tenant policy specs and
119
+ \`pfo.telemetry\` for observability.
120
+
121
+ ## Tenant Sample
122
+
123
+ \`tenant.sample.ts\` binds each slot to sample connections defined in
124
+ \`connections/samples.ts\`. Key details:
125
+
126
+ - Uses Google Cloud Secret Manager URIs for all credentials.
127
+ - Enables knowledge spaces \`knowledge.financial-docs\` and
128
+ \`knowledge.email-threads\`, plus the derived summaries space
129
+ \`knowledge.financial-overview\` populated by open banking workflows.
130
+ - Keeps \`voicePlayback\` and \`paymentsProcessing\` optional so tenants can
131
+ enable them incrementally.
132
+
133
+ ## Contracts
134
+
135
+ \`contracts/index.ts\` defines command/query specs that power the
136
+ workflows:
137
+
138
+ - \`pfo.documents.upload\` \u2013 store object + enqueue ingestion.
139
+ - \`pfo.reminders.schedule-payment\` \u2013 send email/SMS/calendar reminders.
140
+ - \`pfo.summary.generate\` \u2013 run RAG over knowledge spaces.
141
+ - \`pfo.summary.dispatch\` \u2013 deliver summaries via email / voice.
142
+ - \`pfo.email.sync-threads\` \u2013 ingest Gmail threads.
143
+
144
+ ## Workflows
145
+
146
+ - **Process Uploaded Document**
147
+ 1. Upload to storage / queue ingestion.
148
+ 2. Optional human review step.
149
+ - **Upcoming Payments Reminder**
150
+ 1. Human review (confirm due date / channel).
151
+ 2. Automation schedules reminders (email/SMS/calendar).
152
+ - **Generate Financial Summary**
153
+ 1. Run RAG to produce Markdown summary.
154
+ 2. Dispatch summary (email + optional ElevenLabs voice note).
155
+ - **Ingest Email Threads**
156
+ 1. Sync Gmail threads into knowledge space.
157
+ 2. Triage step for operators when nothing new is ingested.
158
+
159
+ ## Knowledge & Jobs
160
+
161
+ - Knowledge spaces registered via
162
+ \`registerFinancialDocsKnowledgeSpace\` and
163
+ \`registerEmailThreadsKnowledgeSpace\`.
164
+ - Ingestion adapters (\`GmailIngestionAdapter\`, \`StorageIngestionAdapter\`)
165
+ and job handlers (\`createGmailSyncHandler\`,
166
+ \`createStorageDocumentHandler\`) wire Gmail labels & GCS prefixes into
167
+ Qdrant.
168
+ - \`KnowledgeQueryService\` provides summarisation + references for the
169
+ summary generation workflow.
170
+
171
+ ## Tests & Usage
172
+
173
+ \`tests/pocket-family-office.test.ts\` exercises:
174
+
175
+ - Blueprint validation + config composition.
176
+ - In-memory ingestion of a sample invoice.
177
+ - Retrieval augmented generation producing a summary with references.
178
+
179
+ Use these files as scaffolding for new tenants or as a template for the
180
+ hackathon deliverable. Replace the sample connection metadata with
181
+ tenant-specific IDs/secret references before deploying.
182
+
183
+
184
+
185
+ `
186
+ }
187
+ ];
71
188
  export {
189
+ tech_contracts_vertical_pocket_family_office_DocBlocks,
72
190
  PocketFamilyOfficeFeature
73
191
  };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@contractspec/example.pocket-family-office",
3
- "version": "3.7.10",
3
+ "version": "3.7.12",
4
4
  "description": "Pocket Family Office example - personal finance automation with open banking",
5
5
  "keywords": [
6
6
  "contractspec",
@@ -29,15 +29,15 @@
29
29
  "typecheck": "tsc --noEmit"
30
30
  },
31
31
  "dependencies": {
32
- "@contractspec/lib.knowledge": "3.7.10",
33
- "@contractspec/lib.contracts-spec": "4.1.2",
34
- "@contractspec/lib.contracts-integrations": "3.8.2",
35
- "@contractspec/lib.schema": "3.7.8"
32
+ "@contractspec/lib.knowledge": "3.7.12",
33
+ "@contractspec/lib.contracts-spec": "5.0.0",
34
+ "@contractspec/lib.contracts-integrations": "3.8.4",
35
+ "@contractspec/lib.schema": "3.7.10"
36
36
  },
37
37
  "devDependencies": {
38
- "@contractspec/tool.typescript": "3.7.8",
38
+ "@contractspec/tool.typescript": "3.7.9",
39
39
  "typescript": "^5.9.3",
40
- "@contractspec/tool.bun": "3.7.8"
40
+ "@contractspec/tool.bun": "3.7.9"
41
41
  },
42
42
  "exports": {
43
43
  ".": {