@contractspec/example.pocket-family-office 0.0.0-canary-20260113162409

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.
Files changed (48) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +43 -0
  3. package/dist/blueprint.d.ts +4 -0
  4. package/dist/blueprint.d.ts.map +1 -0
  5. package/dist/connections/samples.d.ts +4 -0
  6. package/dist/connections/samples.d.ts.map +1 -0
  7. package/dist/docs/index.d.ts +2 -0
  8. package/dist/docs/index.d.ts.map +1 -0
  9. package/dist/docs/pocket-family-office.docblock.d.ts +2 -0
  10. package/dist/docs/pocket-family-office.docblock.d.ts.map +1 -0
  11. package/dist/example.d.ts +3 -0
  12. package/dist/example.d.ts.map +1 -0
  13. package/dist/index.d.ts +11 -0
  14. package/dist/index.d.ts.map +1 -0
  15. package/dist/index.js +2020 -0
  16. package/dist/knowledge/sources.sample.d.ts +3 -0
  17. package/dist/knowledge/sources.sample.d.ts.map +1 -0
  18. package/dist/operations/index.d.ts +717 -0
  19. package/dist/operations/index.d.ts.map +1 -0
  20. package/dist/pocket-family-office.capability.d.ts +2 -0
  21. package/dist/pocket-family-office.capability.d.ts.map +1 -0
  22. package/dist/pocket-family-office.feature.d.ts +6 -0
  23. package/dist/pocket-family-office.feature.d.ts.map +1 -0
  24. package/dist/telemetry.d.ts +4 -0
  25. package/dist/telemetry.d.ts.map +1 -0
  26. package/dist/tenant.sample.d.ts +3 -0
  27. package/dist/tenant.sample.d.ts.map +1 -0
  28. package/dist/tests/pocket-family-office.test.d.ts +2 -0
  29. package/dist/tests/pocket-family-office.test.d.ts.map +1 -0
  30. package/dist/workflows/generate-financial-summary.d.ts +2 -0
  31. package/dist/workflows/generate-financial-summary.d.ts.map +1 -0
  32. package/dist/workflows/generate-openbanking-overview.d.ts +2 -0
  33. package/dist/workflows/generate-openbanking-overview.d.ts.map +1 -0
  34. package/dist/workflows/index.d.ts +9 -0
  35. package/dist/workflows/index.d.ts.map +1 -0
  36. package/dist/workflows/ingest-email-threads.d.ts +2 -0
  37. package/dist/workflows/ingest-email-threads.d.ts.map +1 -0
  38. package/dist/workflows/process-uploaded-document.d.ts +2 -0
  39. package/dist/workflows/process-uploaded-document.d.ts.map +1 -0
  40. package/dist/workflows/refresh-openbanking-balances.d.ts +2 -0
  41. package/dist/workflows/refresh-openbanking-balances.d.ts.map +1 -0
  42. package/dist/workflows/sync-openbanking-accounts.d.ts +2 -0
  43. package/dist/workflows/sync-openbanking-accounts.d.ts.map +1 -0
  44. package/dist/workflows/sync-openbanking-transactions.d.ts +2 -0
  45. package/dist/workflows/sync-openbanking-transactions.d.ts.map +1 -0
  46. package/dist/workflows/upcoming-payments-reminder.d.ts +2 -0
  47. package/dist/workflows/upcoming-payments-reminder.d.ts.map +1 -0
  48. package/package.json +98 -0
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2025 Chaman Ventures, SASU
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md ADDED
@@ -0,0 +1,43 @@
1
+ # Pocket Family Office Vertical
2
+
3
+ Website: https://contractspec.io/
4
+
5
+
6
+ This vertical demonstrates how a spec-first application orchestrates
7
+ financial document automation, payment reminders, and AI summarisation
8
+ using ContractSpec. It is designed for multi-tenant deployments where
9
+ each household configures its own integrations while reusing a shared
10
+ blueprint.
11
+
12
+ ## Contents
13
+
14
+ - `blueprint.ts` – the global `AppBlueprintSpec` describing required
15
+ capabilities, integration slots, workflows, and telemetry.
16
+ - `tenant.sample.ts` – example `TenantAppConfig` showing per-tenant
17
+ bindings to integrations, knowledge spaces, and locales.
18
+ - `connections/` – sample `IntegrationConnection` descriptors for the
19
+ nine priority providers (Mistral, Qdrant, GCS, Gmail, Google Calendar,
20
+ Postmark, ElevenLabs, Stripe, Twilio).
21
+ - `knowledge/` – example `KnowledgeSourceConfig` entries wiring Gmail
22
+ threads and uploaded documents into canonical knowledge spaces.
23
+ - `contracts/` – command specs powering document ingestion, reminders,
24
+ financial summaries, and Gmail synchronisation.
25
+ - `workflows/` – workflow specs orchestrating end-to-end automation for
26
+ uploads, reminders, financial overviews, and email ingestion.
27
+ - `tests/` – Vitest scenarios covering blueprint validation, config
28
+ composition, and a full end-to-end ingestion/query flow.
29
+
30
+ ## Usage
31
+
32
+ The files are designed for direct consumption inside tests, CLI
33
+ generators, or documentation tooling. They depend exclusively on the
34
+ public APIs exported by `@contractspec/lib.contracts`, making them safe to copy
35
+ into downstream projects or use as a reference implementation during the
36
+ Pocket Family Office hackathon.
37
+
38
+
39
+
40
+
41
+
42
+
43
+
@@ -0,0 +1,4 @@
1
+ import type { AppBlueprintRegistry, AppBlueprintSpec } from '@contractspec/lib.contracts/app-config/spec';
2
+ export declare const pocketFamilyOfficeBlueprint: AppBlueprintSpec;
3
+ export declare function registerPocketFamilyOfficeBlueprint(registry: AppBlueprintRegistry): AppBlueprintRegistry;
4
+ //# sourceMappingURL=blueprint.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"blueprint.d.ts","sourceRoot":"","sources":["../src/blueprint.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,oBAAoB,EACpB,gBAAgB,EACjB,MAAM,6CAA6C,CAAC;AAUrD,eAAO,MAAM,2BAA2B,EAAE,gBAgMzC,CAAC;AAEF,wBAAgB,mCAAmC,CACjD,QAAQ,EAAE,oBAAoB,GAC7B,oBAAoB,CAEtB"}
@@ -0,0 +1,4 @@
1
+ import type { IntegrationConnection } from '@contractspec/lib.contracts/integrations/connection';
2
+ export declare const pocketFamilyOfficeConnections: IntegrationConnection[];
3
+ export declare function getPocketFamilyOfficeConnection(connectionId: string): IntegrationConnection | undefined;
4
+ //# sourceMappingURL=samples.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"samples.d.ts","sourceRoot":"","sources":["../../src/connections/samples.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,qDAAqD,CAAC;AAUjG,eAAO,MAAM,6BAA6B,EAAE,qBAAqB,EAgMhE,CAAC;AAEF,wBAAgB,+BAA+B,CAC7C,YAAY,EAAE,MAAM,GACnB,qBAAqB,GAAG,SAAS,CAInC"}
@@ -0,0 +1,2 @@
1
+ import './pocket-family-office.docblock';
2
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/docs/index.ts"],"names":[],"mappings":"AAAA,OAAO,iCAAiC,CAAC"}
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=pocket-family-office.docblock.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"pocket-family-office.docblock.d.ts","sourceRoot":"","sources":["../../src/docs/pocket-family-office.docblock.ts"],"names":[],"mappings":""}
@@ -0,0 +1,3 @@
1
+ declare const example: import("@contractspec/lib.contracts").ExampleSpec;
2
+ export default example;
3
+ //# sourceMappingURL=example.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"example.d.ts","sourceRoot":"","sources":["../src/example.ts"],"names":[],"mappings":"AAEA,QAAA,MAAM,OAAO,mDAoCX,CAAC;AAEH,eAAe,OAAO,CAAC"}
@@ -0,0 +1,11 @@
1
+ export * from './blueprint';
2
+ export * from './tenant.sample';
3
+ export * from './connections/samples';
4
+ export * from './knowledge/sources.sample';
5
+ export * from './operations';
6
+ export * from './workflows';
7
+ export * from './telemetry';
8
+ export * from './pocket-family-office.feature';
9
+ export { default as example } from './example';
10
+ import './docs';
11
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC;AAC5B,cAAc,iBAAiB,CAAC;AAChC,cAAc,uBAAuB,CAAC;AACtC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,cAAc,CAAC;AAC7B,cAAc,aAAa,CAAC;AAC5B,cAAc,aAAa,CAAC;AAC5B,cAAc,gCAAgC,CAAC;AAC/C,OAAO,EAAE,OAAO,IAAI,OAAO,EAAE,MAAM,WAAW,CAAC;AAE/C,OAAO,QAAQ,CAAC"}