@elevasis/core 0.7.1 → 0.8.0
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.
- package/package.json +1 -1
- package/src/README.md +41 -41
- package/src/__tests__/publish.test.ts +18 -18
- package/src/__tests__/{template-foundations-compatibility.test.ts → template-core-compatibility.test.ts} +99 -99
- package/src/_gen/__tests__/__snapshots__/contracts.md.snap +1135 -1131
- package/src/_gen/__tests__/scaffold-contracts.test.ts +53 -53
- package/src/_gen/scaffold-contracts.ts +45 -45
- package/src/auth/multi-tenancy/credentials/README.md +38 -38
- package/src/auth/multi-tenancy/credentials/index.ts +6 -6
- package/src/auth/multi-tenancy/credentials/server/encryption.ts +39 -39
- package/src/auth/multi-tenancy/credentials/server/service.ts +60 -60
- package/src/auth/multi-tenancy/index.ts +17 -17
- package/src/auth/multi-tenancy/invitations/api-schemas.ts +107 -107
- package/src/auth/multi-tenancy/invitations/index.ts +37 -37
- package/src/auth/multi-tenancy/invitations/invitation.ts +86 -86
- package/src/auth/multi-tenancy/invitations/server/index.ts +25 -25
- package/src/auth/multi-tenancy/invitations/server/transforms.ts +24 -24
- package/src/auth/multi-tenancy/invitations/server/workos.ts +24 -24
- package/src/auth/multi-tenancy/invitations/supabase.ts +50 -50
- package/src/auth/multi-tenancy/memberships/api-schemas.ts +126 -126
- package/src/auth/multi-tenancy/memberships/index.ts +21 -21
- package/src/auth/multi-tenancy/memberships/membership.ts +138 -138
- package/src/auth/multi-tenancy/memberships/server/index.ts +15 -15
- package/src/auth/multi-tenancy/memberships/server/transforms.ts +32 -32
- package/src/auth/multi-tenancy/memberships/server/workos.ts +21 -21
- package/src/auth/multi-tenancy/memberships/supabase.ts +46 -46
- package/src/auth/multi-tenancy/organizations/api-schemas.ts +128 -128
- package/src/auth/multi-tenancy/organizations/index.ts +23 -23
- package/src/auth/multi-tenancy/organizations/organization.ts +24 -24
- package/src/auth/multi-tenancy/organizations/server/index.ts +10 -10
- package/src/auth/multi-tenancy/organizations/server/transforms.ts +35 -35
- package/src/auth/multi-tenancy/organizations/server/workos.ts +20 -20
- package/src/auth/multi-tenancy/types.ts +83 -83
- package/src/auth/multi-tenancy/users/api-schemas.ts +194 -194
- package/src/auth/multi-tenancy/users/index.ts +27 -27
- package/src/auth/multi-tenancy/users/server/index.ts +19 -19
- package/src/auth/multi-tenancy/users/server/transforms.ts +21 -21
- package/src/auth/multi-tenancy/users/server/workos.ts +16 -16
- package/src/auth/multi-tenancy/users/user.ts +65 -65
- package/src/business/README.md +52 -52
- package/src/business/__tests__/entities-published.test.ts +33 -33
- package/src/business/acquisition/api-schemas.ts +759 -759
- package/src/business/acquisition/index.ts +109 -109
- package/src/business/acquisition/types.ts +402 -402
- package/src/business/base-entities.test.ts +481 -481
- package/src/business/base-entities.ts +241 -241
- package/src/business/entities-published.ts +24 -24
- package/src/business/index.ts +15 -15
- package/src/business/pdf/browser/pdfmake-browser.ts +229 -229
- package/src/business/pdf/index.ts +10 -10
- package/src/business/pdf/server/index.ts +21 -21
- package/src/business/pdf/server/themes/default.ts +8 -8
- package/src/business/pdf/server/themes/index.ts +9 -9
- package/src/business/pdf/server/themes/types.ts +8 -8
- package/src/business/pdf/types.ts +272 -272
- package/src/business/projects/index.ts +2 -2
- package/src/business/projects/sse-events.ts +21 -21
- package/src/business/projects/types.ts +89 -89
- package/src/business/sales/api-schemas.ts +75 -75
- package/src/business/seo/__tests__/linking.test.ts +549 -549
- package/src/business/seo/__tests__/types.test.ts +404 -404
- package/src/business/seo/index.ts +2 -2
- package/src/business/seo/linking.ts +281 -281
- package/src/business/seo/types.ts +199 -199
- package/src/commands/queue/index.ts +3 -3
- package/src/commands/queue/schemas.test.ts +593 -593
- package/src/commands/queue/schemas.ts +125 -125
- package/src/commands/queue/sse-events.ts +61 -61
- package/src/commands/queue/types/action.ts +52 -52
- package/src/commands/queue/types/checkpoint.ts +44 -44
- package/src/commands/queue/types/index.ts +7 -7
- package/src/commands/queue/types/task.ts +116 -116
- package/src/commands/queue/types.ts +14 -14
- package/src/content/distribution-metadata.ts +61 -61
- package/src/content/index.ts +10 -10
- package/src/deployments/index.ts +22 -22
- package/src/execution/core/__tests__/archived-logs.test.ts +72 -72
- package/src/execution/core/index.ts +11 -11
- package/src/execution/core/runner-types.ts +80 -80
- package/src/execution/core/server/environment.ts +31 -31
- package/src/execution/core/sse-executions.ts +119 -119
- package/src/execution/core/types.ts +29 -29
- package/src/execution/engine/__tests__/fixtures/test-agents.ts +4 -4
- package/src/execution/engine/__tests__/timeout.test.ts +565 -565
- package/src/execution/engine/agent/__tests__/errors.test.ts +508 -508
- package/src/execution/engine/agent/actions/__tests__/processor.test.ts +531 -531
- package/src/execution/engine/agent/actions/executor.ts +205 -205
- package/src/execution/engine/agent/actions/navigate-knowledge-executor.ts +230 -230
- package/src/execution/engine/agent/actions/processor.ts +116 -116
- package/src/execution/engine/agent/actions/types.ts +70 -70
- package/src/execution/engine/agent/core/agent.ts +810 -810
- package/src/execution/engine/agent/core/types.ts +155 -155
- package/src/execution/engine/agent/errors.ts +251 -251
- package/src/execution/engine/agent/index.ts +78 -78
- package/src/execution/engine/agent/knowledge-map/types.ts +106 -106
- package/src/execution/engine/agent/knowledge-map/utils.ts +101 -101
- package/src/execution/engine/agent/memory/__tests__/manager.test.ts +754 -754
- package/src/execution/engine/agent/memory/domains.ts +99 -99
- package/src/execution/engine/agent/memory/manager.ts +365 -365
- package/src/execution/engine/agent/memory/processor.ts +66 -66
- package/src/execution/engine/agent/memory/types.ts +90 -90
- package/src/execution/engine/agent/memory/utils.ts +134 -134
- package/src/execution/engine/agent/observability/logging.ts +467 -467
- package/src/execution/engine/agent/observability/types.ts +64 -64
- package/src/execution/engine/agent/reasoning/adapters/agent-adapter-helpers.ts +349 -349
- package/src/execution/engine/agent/reasoning/processor.ts +92 -92
- package/src/execution/engine/agent/reasoning/prompt-sections/base-actions.ts +134 -134
- package/src/execution/engine/agent/reasoning/prompt-sections/completion.ts +49 -49
- package/src/execution/engine/agent/reasoning/prompt-sections/knowledge-map.ts +93 -93
- package/src/execution/engine/agent/reasoning/prompt-sections/memory.ts +65 -65
- package/src/execution/engine/agent/reasoning/prompt-sections/tools.ts +44 -44
- package/src/execution/engine/agent/reasoning/request-builder.ts +169 -169
- package/src/execution/engine/agent/reasoning/types.ts +18 -18
- package/src/execution/engine/base/errors.ts +118 -118
- package/src/execution/engine/base/index.ts +2 -2
- package/src/execution/engine/base/logging.ts +31 -31
- package/src/execution/engine/base/serialization.ts +324 -324
- package/src/execution/engine/base/types.ts +126 -126
- package/src/execution/engine/base/utils.ts +41 -41
- package/src/execution/engine/index.ts +434 -434
- package/src/execution/engine/interface/index.ts +1 -1
- package/src/execution/engine/interface/types.ts +62 -62
- package/src/execution/engine/llm/__tests__/model-info.test.ts +50 -50
- package/src/execution/engine/llm/__tests__/model-validation.test.ts +321 -321
- package/src/execution/engine/llm/__tests__/response-schema-validator.test.ts +115 -115
- package/src/execution/engine/llm/adapters/__tests__/adapter-factory.test.ts +375 -375
- package/src/execution/engine/llm/adapters/__tests__/anthropic-adapter.test.ts +463 -463
- package/src/execution/engine/llm/adapters/__tests__/anthropic.integration.test.ts +177 -177
- package/src/execution/engine/llm/adapters/__tests__/google-adapter.test.ts +722 -722
- package/src/execution/engine/llm/adapters/__tests__/google.integration.test.ts +376 -376
- package/src/execution/engine/llm/adapters/__tests__/openai-adapter.test.ts +551 -551
- package/src/execution/engine/llm/adapters/__tests__/openrouter-adapter.test.ts +563 -563
- package/src/execution/engine/llm/adapters/__tests__/openrouter.integration.test.ts +105 -105
- package/src/execution/engine/llm/adapters/__tests__/universal-adapter.test.ts +537 -537
- package/src/execution/engine/llm/adapters/circuit-breaker.ts +147 -147
- package/src/execution/engine/llm/adapters/index.ts +17 -17
- package/src/execution/engine/llm/adapters/mock-adapter.ts +116 -116
- package/src/execution/engine/llm/adapters/server/adapter-factory.ts +130 -130
- package/src/execution/engine/llm/adapters/server/anthropic.ts +137 -137
- package/src/execution/engine/llm/adapters/server/google.ts +283 -283
- package/src/execution/engine/llm/adapters/server/index.ts +12 -12
- package/src/execution/engine/llm/adapters/server/openai.ts +206 -206
- package/src/execution/engine/llm/adapters/server/openrouter.ts +235 -235
- package/src/execution/engine/llm/adapters/universal-adapter.ts +230 -230
- package/src/execution/engine/llm/errors.ts +186 -186
- package/src/execution/engine/llm/model-info.ts +332 -332
- package/src/execution/engine/llm/response-schema-validator.ts +113 -113
- package/src/execution/engine/llm/types.ts +86 -86
- package/src/execution/engine/test-utils/index.ts +6 -6
- package/src/execution/engine/test-utils/mocks.ts +56 -56
- package/src/execution/engine/tools/integration/base-integration-adapter.ts +50 -50
- package/src/execution/engine/tools/integration/index.ts +53 -53
- package/src/execution/engine/tools/integration/server/adapters/anymailfinder/anymailfinder-adapter.ts +73 -73
- package/src/execution/engine/tools/integration/server/adapters/anymailfinder/anymailfinder-tools.ts +209 -209
- package/src/execution/engine/tools/integration/server/adapters/anymailfinder/fetch/find-company-email/index.ts +82 -82
- package/src/execution/engine/tools/integration/server/adapters/anymailfinder/fetch/find-decision-maker-email/index.ts +122 -122
- package/src/execution/engine/tools/integration/server/adapters/anymailfinder/fetch/find-person-email/index.ts +89 -89
- package/src/execution/engine/tools/integration/server/adapters/anymailfinder/fetch/verify-email/index.ts +84 -84
- package/src/execution/engine/tools/integration/server/adapters/anymailfinder/index.ts +16 -16
- package/src/execution/engine/tools/integration/server/adapters/apify/__tests__/apify-run-actor.integration.test.ts +293 -293
- package/src/execution/engine/tools/integration/server/adapters/apify/apify-adapter.ts +100 -100
- package/src/execution/engine/tools/integration/server/adapters/apify/apify-tools.ts +217 -217
- package/src/execution/engine/tools/integration/server/adapters/apify/fetch/get-dataset-items/index.ts +92 -92
- package/src/execution/engine/tools/integration/server/adapters/apify/fetch/run-actor/index.ts +218 -218
- package/src/execution/engine/tools/integration/server/adapters/apify/fetch/start-actor/index.ts +87 -87
- package/src/execution/engine/tools/integration/server/adapters/apify/index.ts +11 -11
- package/src/execution/engine/tools/integration/server/adapters/attio/__tests__/attio-crud.integration.test.ts +361 -361
- package/src/execution/engine/tools/integration/server/adapters/attio/attio-adapter.ts +162 -162
- package/src/execution/engine/tools/integration/server/adapters/attio/attio-tools.ts +594 -594
- package/src/execution/engine/tools/integration/server/adapters/attio/fetch/create-attribute/index.ts +214 -214
- package/src/execution/engine/tools/integration/server/adapters/attio/fetch/create-note/index.ts +152 -152
- package/src/execution/engine/tools/integration/server/adapters/attio/fetch/create-record/index.ts +141 -141
- package/src/execution/engine/tools/integration/server/adapters/attio/fetch/delete-note/index.ts +86 -86
- package/src/execution/engine/tools/integration/server/adapters/attio/fetch/delete-record/index.ts +105 -105
- package/src/execution/engine/tools/integration/server/adapters/attio/fetch/get-record/index.ts +118 -118
- package/src/execution/engine/tools/integration/server/adapters/attio/fetch/list-attributes/index.ts +165 -165
- package/src/execution/engine/tools/integration/server/adapters/attio/fetch/list-notes/index.ts +96 -96
- package/src/execution/engine/tools/integration/server/adapters/attio/fetch/list-objects/index.ts +104 -104
- package/src/execution/engine/tools/integration/server/adapters/attio/fetch/list-records/index.ts +156 -156
- package/src/execution/engine/tools/integration/server/adapters/attio/fetch/update-attribute/index.ts +220 -220
- package/src/execution/engine/tools/integration/server/adapters/attio/fetch/update-record/index.ts +140 -140
- package/src/execution/engine/tools/integration/server/adapters/attio/fetch/utils/types.ts +146 -146
- package/src/execution/engine/tools/integration/server/adapters/attio/index.ts +31 -31
- package/src/execution/engine/tools/integration/server/adapters/gmail/gmail-adapter.ts +210 -210
- package/src/execution/engine/tools/integration/server/adapters/gmail/gmail-tools.ts +104 -104
- package/src/execution/engine/tools/integration/server/adapters/google-sheets/__tests__/google-sheets.integration.test.ts +261 -261
- package/src/execution/engine/tools/integration/server/adapters/google-sheets/google-sheets-adapter.ts +1189 -1189
- package/src/execution/engine/tools/integration/server/adapters/google-sheets/google-sheets-tools.ts +641 -641
- package/src/execution/engine/tools/integration/server/adapters/google-sheets/index.ts +18 -18
- package/src/execution/engine/tools/integration/server/adapters/instantly/fetch/activate-campaign/index.ts +86 -86
- package/src/execution/engine/tools/integration/server/adapters/instantly/fetch/add-to-campaign/__tests__/index.test.ts +289 -289
- package/src/execution/engine/tools/integration/server/adapters/instantly/fetch/add-to-campaign/index.ts +154 -154
- package/src/execution/engine/tools/integration/server/adapters/instantly/fetch/bulk-add-leads/__tests__/index.test.ts +325 -325
- package/src/execution/engine/tools/integration/server/adapters/instantly/fetch/bulk-add-leads/index.ts +153 -153
- package/src/execution/engine/tools/integration/server/adapters/instantly/fetch/bulk-delete-leads/index.ts +84 -84
- package/src/execution/engine/tools/integration/server/adapters/instantly/fetch/create-campaign/index.ts +125 -125
- package/src/execution/engine/tools/integration/server/adapters/instantly/fetch/create-inbox-test/index.ts +107 -107
- package/src/execution/engine/tools/integration/server/adapters/instantly/fetch/delete-campaign/index.ts +85 -85
- package/src/execution/engine/tools/integration/server/adapters/instantly/fetch/get-account-health/index.ts +91 -91
- package/src/execution/engine/tools/integration/server/adapters/instantly/fetch/get-campaign/index.ts +92 -92
- package/src/execution/engine/tools/integration/server/adapters/instantly/fetch/get-campaign-analytics/__tests__/index.test.ts +195 -195
- package/src/execution/engine/tools/integration/server/adapters/instantly/fetch/get-campaign-analytics/index.ts +113 -113
- package/src/execution/engine/tools/integration/server/adapters/instantly/fetch/get-daily-campaign-analytics/index.ts +104 -104
- package/src/execution/engine/tools/integration/server/adapters/instantly/fetch/get-emails/index.ts +155 -155
- package/src/execution/engine/tools/integration/server/adapters/instantly/fetch/get-step-analytics/__tests__/index.test.ts +196 -196
- package/src/execution/engine/tools/integration/server/adapters/instantly/fetch/get-step-analytics/index.ts +102 -102
- package/src/execution/engine/tools/integration/server/adapters/instantly/fetch/list-campaigns/__tests__/index.test.ts +189 -189
- package/src/execution/engine/tools/integration/server/adapters/instantly/fetch/list-campaigns/index.ts +87 -87
- package/src/execution/engine/tools/integration/server/adapters/instantly/fetch/list-leads/index.ts +112 -112
- package/src/execution/engine/tools/integration/server/adapters/instantly/fetch/patch-lead/index.ts +76 -76
- package/src/execution/engine/tools/integration/server/adapters/instantly/fetch/pause-campaign/index.ts +86 -86
- package/src/execution/engine/tools/integration/server/adapters/instantly/fetch/remove-from-subsequence/index.ts +98 -98
- package/src/execution/engine/tools/integration/server/adapters/instantly/fetch/send-reply/index.ts +126 -126
- package/src/execution/engine/tools/integration/server/adapters/instantly/fetch/update-campaign/__tests__/index.test.ts +193 -193
- package/src/execution/engine/tools/integration/server/adapters/instantly/fetch/update-campaign/index.ts +99 -99
- package/src/execution/engine/tools/integration/server/adapters/instantly/fetch/update-interest-status/__tests__/index.test.ts +621 -621
- package/src/execution/engine/tools/integration/server/adapters/instantly/fetch/update-interest-status/index.ts +125 -125
- package/src/execution/engine/tools/integration/server/adapters/instantly/index.ts +29 -29
- package/src/execution/engine/tools/integration/server/adapters/instantly/instantly-adapter.ts +178 -178
- package/src/execution/engine/tools/integration/server/adapters/instantly/instantly-tools.ts +1473 -1473
- package/src/execution/engine/tools/integration/server/adapters/millionverifier/fetch/check-credits/index.ts +59 -59
- package/src/execution/engine/tools/integration/server/adapters/millionverifier/fetch/verify-email/index.ts +102 -102
- package/src/execution/engine/tools/integration/server/adapters/millionverifier/index.ts +17 -17
- package/src/execution/engine/tools/integration/server/adapters/millionverifier/millionverifier-adapter.ts +80 -80
- package/src/execution/engine/tools/integration/server/adapters/millionverifier/millionverifier-tools.ts +102 -102
- package/src/execution/engine/tools/integration/server/adapters/resend/fetch/get-email/index.ts +102 -102
- package/src/execution/engine/tools/integration/server/adapters/resend/fetch/send-email/index.ts +134 -134
- package/src/execution/engine/tools/integration/server/adapters/resend/fetch/utils/types.ts +75 -75
- package/src/execution/engine/tools/integration/server/adapters/resend/index.ts +27 -27
- package/src/execution/engine/tools/integration/server/adapters/resend/resend-adapter.ts +108 -108
- package/src/execution/engine/tools/integration/server/adapters/resend/resend-tools.ts +132 -132
- package/src/execution/engine/tools/integration/server/adapters/signature-api/fetch/create-envelope/index.ts +274 -274
- package/src/execution/engine/tools/integration/server/adapters/signature-api/fetch/download-document/index.ts +230 -230
- package/src/execution/engine/tools/integration/server/adapters/signature-api/fetch/get-envelope/index.ts +133 -133
- package/src/execution/engine/tools/integration/server/adapters/signature-api/fetch/void-envelope/index.ts +90 -90
- package/src/execution/engine/tools/integration/server/adapters/stripe/fetch/utils/types.ts +210 -210
- package/src/execution/engine/tools/integration/server/adapters/stripe/stripe-adapter.ts +517 -517
- package/src/execution/engine/tools/integration/server/adapters/stripe/stripe-tools.ts +309 -309
- package/src/execution/engine/tools/integration/server/adapters/tomba/fetch/domain-search/index.ts +133 -133
- package/src/execution/engine/tools/integration/server/adapters/tomba/fetch/email-finder/index.ts +122 -122
- package/src/execution/engine/tools/integration/server/adapters/tomba/fetch/email-verifier/index.ts +111 -111
- package/src/execution/engine/tools/integration/server/adapters/tomba/index.ts +11 -11
- package/src/execution/engine/tools/integration/server/adapters/tomba/tomba-adapter.ts +78 -78
- package/src/execution/engine/tools/integration/server/adapters/tomba/tomba-tools.ts +222 -222
- package/src/execution/engine/tools/integration/server/index.ts +61 -61
- package/src/execution/engine/tools/integration/service.ts +161 -161
- package/src/execution/engine/tools/integration/tool.ts +253 -253
- package/src/execution/engine/tools/integration/types/anymailfinder.ts +74 -74
- package/src/execution/engine/tools/integration/types/apify.ts +92 -92
- package/src/execution/engine/tools/integration/types/index.ts +19 -19
- package/src/execution/engine/tools/integration/types/instantly.ts +557 -557
- package/src/execution/engine/tools/integration/types/millionverifier.ts +56 -56
- package/src/execution/engine/tools/integration/types/stripe.ts +162 -162
- package/src/execution/engine/tools/integration/types/tomba.ts +94 -94
- package/src/execution/engine/tools/lead-service-types.ts +884 -884
- package/src/execution/engine/tools/llm/index.ts +11 -11
- package/src/execution/engine/tools/llm/server/index.ts +8 -8
- package/src/execution/engine/tools/llm/server/llm-call-tool.ts +118 -118
- package/src/execution/engine/tools/platform/__tests__/pdf.test.ts +441 -441
- package/src/execution/engine/tools/platform/acquisition/company-tools.ts +248 -248
- package/src/execution/engine/tools/platform/acquisition/contact-tools.ts +319 -319
- package/src/execution/engine/tools/platform/acquisition/index.ts +43 -43
- package/src/execution/engine/tools/platform/acquisition/list-tools.ts +148 -148
- package/src/execution/engine/tools/platform/acquisition/types.ts +260 -260
- package/src/execution/engine/tools/platform/email/index.ts +122 -122
- package/src/execution/engine/tools/platform/email/types.ts +96 -96
- package/src/execution/engine/tools/platform/index.ts +157 -157
- package/src/execution/engine/tools/platform/notification.ts +81 -81
- package/src/execution/engine/tools/platform/pdf/index.ts +110 -110
- package/src/execution/engine/tools/platform/pdf/types.ts +77 -77
- package/src/execution/engine/tools/platform/scheduler.ts +87 -87
- package/src/execution/engine/tools/platform/storage/index.ts +370 -370
- package/src/execution/engine/tools/platform/types.ts +148 -148
- package/src/execution/engine/tools/registry.ts +700 -700
- package/src/execution/engine/tools/tool-maps.ts +786 -786
- package/src/execution/engine/tools/types.ts +233 -233
- package/src/execution/engine/workflow/__tests__/errors.test.ts +139 -139
- package/src/execution/engine/workflow/errors.ts +63 -63
- package/src/execution/engine/workflow/helpers/index.ts +11 -11
- package/src/execution/engine/workflow/helpers/server/index.ts +8 -8
- package/src/execution/engine/workflow/helpers/server/llm-call.ts +93 -93
- package/src/execution/engine/workflow/index.ts +19 -19
- package/src/execution/engine/workflow/log-truncate.ts +26 -26
- package/src/execution/engine/workflow/logging.ts +191 -191
- package/src/execution/engine/workflow/types.ts +182 -182
- package/src/execution/engine/workflow/utils.ts +280 -280
- package/src/execution/engine/workflow/workflow.ts +168 -168
- package/src/execution/index.ts +3 -3
- package/src/execution/scheduler/__tests__/api-schemas.test.ts +733 -733
- package/src/execution/scheduler/__tests__/utils.test.ts +1009 -1009
- package/src/execution/scheduler/api-schemas.ts +296 -296
- package/src/execution/scheduler/index.ts +50 -50
- package/src/execution/scheduler/schemas.ts +264 -264
- package/src/execution/scheduler/types.ts +111 -111
- package/src/execution/scheduler/utils.ts +364 -364
- package/src/forms/index.ts +7 -7
- package/src/forms/schemas.ts +69 -69
- package/src/forms/types.ts +70 -70
- package/src/index.ts +71 -60
- package/src/integrations/credentials/__tests__/schemas.test.ts +82 -82
- package/src/integrations/credentials/__tests__/utils.test.ts +144 -144
- package/src/integrations/credentials/api-schemas.ts +143 -143
- package/src/integrations/credentials/index.ts +32 -32
- package/src/integrations/credentials/schemas.ts +164 -164
- package/src/integrations/credentials/utils.ts +59 -59
- package/src/integrations/oauth/__tests__/provider-registry.test.ts +59 -59
- package/src/integrations/oauth/api-schemas.ts +92 -92
- package/src/integrations/oauth/index.ts +19 -19
- package/src/integrations/oauth/provider-registry.ts +61 -61
- package/src/integrations/oauth/server/__tests__/refresh-concurrent.test.ts +183 -183
- package/src/integrations/oauth/server/__tests__/refresh.test.ts +577 -577
- package/src/integrations/oauth/server/credentials.ts +39 -39
- package/src/integrations/oauth/server/refresh.ts +214 -214
- package/src/integrations/oauth/types.ts +34 -34
- package/src/integrations/webhook-endpoints/__tests__/api-schemas.test.ts +318 -318
- package/src/integrations/webhook-endpoints/api-schemas.ts +102 -102
- package/src/integrations/webhook-endpoints/index.ts +28 -28
- package/src/integrations/webhook-endpoints/types.ts +51 -51
- package/src/operations/activities/api-schemas.ts +79 -79
- package/src/operations/activities/index.ts +9 -9
- package/src/operations/activities/sse-events.ts +30 -30
- package/src/operations/activities/types.ts +63 -63
- package/src/operations/debug-logs/client.ts +60 -60
- package/src/operations/debug-logs/debug-logger.ts +83 -83
- package/src/operations/debug-logs/index.ts +8 -8
- package/src/operations/debug-logs/server.ts +19 -19
- package/src/operations/debug-logs/types.ts +33 -33
- package/src/operations/index.ts +50 -50
- package/src/operations/notifications/api-schemas.ts +91 -91
- package/src/operations/notifications/index.ts +3 -3
- package/src/operations/notifications/sse-events.ts +21 -21
- package/src/operations/notifications/types.ts +47 -47
- package/src/operations/observability/__tests__/openrouter-cost-flow.test.ts +297 -297
- package/src/operations/observability/__tests__/utils.test.ts +54 -54
- package/src/operations/observability/ai-usage-collector.ts +64 -64
- package/src/operations/observability/index.ts +13 -13
- package/src/operations/observability/metrics-collector.ts +49 -49
- package/src/operations/observability/schemas.ts +39 -39
- package/src/operations/observability/types.ts +463 -463
- package/src/operations/observability/utils.ts +77 -77
- package/src/operations/sessions/__tests__/manager.test.ts +821 -821
- package/src/operations/sessions/index.ts +26 -26
- package/src/operations/sessions/server/manager.ts +90 -90
- package/src/operations/sessions/server/session.ts +180 -180
- package/src/operations/sessions/types.ts +98 -98
- package/src/operations/triggers/index.ts +12 -12
- package/src/operations/triggers/webhook/definitions/instantly-account-error.ts +44 -44
- package/src/operations/triggers/webhook/definitions/instantly-auto-reply-received.ts +51 -51
- package/src/operations/triggers/webhook/definitions/instantly-campaign-completed.ts +45 -45
- package/src/operations/triggers/webhook/definitions/instantly-email-bounced.ts +49 -49
- package/src/operations/triggers/webhook/definitions/instantly-lead-unsubscribed.ts +45 -45
- package/src/operations/triggers/webhook/definitions/instantly-reply-received.ts +54 -54
- package/src/operations/triggers/webhook/index.ts +35 -35
- package/src/operations/triggers/webhook/types.ts +74 -74
- package/src/organization-model/README.md +97 -97
- package/src/organization-model/__tests__/defaults.test.ts +175 -175
- package/src/organization-model/__tests__/domains/customers.test.ts +295 -295
- package/src/organization-model/__tests__/domains/goals.test.ts +479 -479
- package/src/organization-model/__tests__/domains/identity.test.ts +279 -279
- package/src/organization-model/__tests__/domains/navigation.test.ts +212 -212
- package/src/organization-model/__tests__/domains/offerings.test.ts +419 -419
- package/src/organization-model/__tests__/domains/operations.test.ts +203 -203
- package/src/organization-model/__tests__/domains/resource-mappings.test.ts +362 -362
- package/src/organization-model/__tests__/domains/roles.test.ts +347 -347
- package/src/organization-model/__tests__/domains/statuses.test.ts +243 -243
- package/src/organization-model/__tests__/foundation.test.ts +105 -105
- package/src/organization-model/__tests__/graph.test.ts +894 -894
- package/src/organization-model/__tests__/resolve.test.ts +690 -690
- package/src/organization-model/__tests__/schema.test.ts +407 -407
- package/src/organization-model/contracts.ts +14 -14
- package/src/organization-model/defaults.ts +148 -148
- package/src/organization-model/domains/branding.ts +22 -22
- package/src/organization-model/domains/customers.ts +75 -75
- package/src/organization-model/domains/features.ts +22 -22
- package/src/organization-model/domains/goals.ts +80 -80
- package/src/organization-model/domains/identity.ts +94 -94
- package/src/organization-model/domains/navigation.ts +391 -391
- package/src/organization-model/domains/offerings.ts +66 -66
- package/src/organization-model/domains/operations.ts +85 -85
- package/src/organization-model/domains/projects.ts +48 -48
- package/src/organization-model/domains/prospecting.ts +33 -33
- package/src/organization-model/domains/roles.ts +55 -55
- package/src/organization-model/domains/sales.ts +94 -94
- package/src/organization-model/domains/shared.ts +62 -62
- package/src/organization-model/domains/statuses.ts +130 -130
- package/src/organization-model/foundation.ts +97 -97
- package/src/organization-model/graph/build.ts +399 -399
- package/src/organization-model/graph/index.ts +4 -4
- package/src/organization-model/graph/schema.ts +48 -48
- package/src/organization-model/graph/types.ts +40 -40
- package/src/organization-model/index.ts +13 -13
- package/src/organization-model/organization-graph.mdx +272 -272
- package/src/organization-model/organization-model.mdx +320 -320
- package/src/organization-model/published.ts +85 -85
- package/src/organization-model/resolve.ts +66 -66
- package/src/organization-model/schema.ts +287 -287
- package/src/organization-model/types.ts +46 -46
- package/src/platform/api/index.ts +1 -1
- package/src/platform/api/types.ts +35 -35
- package/src/platform/constants/http.ts +37 -37
- package/src/platform/constants/index.ts +5 -5
- package/src/platform/constants/limits.ts +32 -32
- package/src/platform/constants/resilience.ts +51 -51
- package/src/platform/constants/timeouts.ts +20 -20
- package/src/platform/constants/versions.ts +3 -3
- package/src/platform/registry/__tests__/resource-registry-static.test.ts +347 -347
- package/src/platform/registry/__tests__/resource-registry.integration.test.ts +1028 -1028
- package/src/platform/registry/__tests__/resource-registry.list-executable.test.ts +393 -393
- package/src/platform/registry/__tests__/resource-registry.test.ts +2005 -2005
- package/src/platform/registry/__tests__/serialization.test.ts +1127 -1127
- package/src/platform/registry/command-view.ts +180 -180
- package/src/platform/registry/domains.ts +165 -165
- package/src/platform/registry/index.ts +93 -93
- package/src/platform/registry/reserved.ts +24 -24
- package/src/platform/registry/resource-metadata.ts +59 -59
- package/src/platform/registry/resource-registry.command-queue-groups.test.ts +129 -129
- package/src/platform/registry/resource-registry.ts +876 -876
- package/src/platform/registry/serialization.ts +273 -273
- package/src/platform/registry/serialized-types.ts +231 -231
- package/src/platform/registry/stats-types.ts +66 -66
- package/src/platform/registry/types.ts +404 -404
- package/src/platform/registry/validation.ts +513 -513
- package/src/platform/resilience/__tests__/rate-limiter.test.ts +471 -471
- package/src/platform/resilience/circuit-breaker.ts +164 -164
- package/src/platform/resilience/errors.ts +68 -68
- package/src/platform/resilience/http-error-mapper.ts +129 -129
- package/src/platform/resilience/index.ts +93 -93
- package/src/platform/resilience/rate-limiter-types.ts +46 -46
- package/src/platform/resilience/rate-limiter.ts +140 -140
- package/src/platform/resilience/retry.ts +89 -89
- package/src/platform/resilience/timeout.ts +63 -63
- package/src/platform/sse/events.ts +37 -37
- package/src/platform/sse/index.ts +7 -7
- package/src/platform/utils/__tests__/validation.test.ts +1083 -1083
- package/src/platform/utils/currency.ts +96 -96
- package/src/platform/utils/debounce.ts +52 -52
- package/src/platform/utils/error.ts +41 -41
- package/src/platform/utils/hmac.test.ts +97 -97
- package/src/platform/utils/index.ts +32 -32
- package/src/platform/utils/server/betterstack-logger.ts +210 -210
- package/src/platform/utils/server/hmac.ts +44 -44
- package/src/platform/utils/server/unsubscribe.ts +111 -111
- package/src/platform/utils/token-counter.ts +96 -96
- package/src/platform/utils/validation.ts +425 -425
- package/src/projects/api-schemas.ts +268 -268
- package/src/published.ts +1 -1
- package/src/reference/_generated/contracts.md +607 -607
- package/src/reference/glossary.md +105 -105
- package/src/requests/__tests__/api-schemas.test.ts +277 -277
- package/src/requests/api-schemas.ts +83 -83
- package/src/requests/index.ts +1 -1
- package/src/scaffold-registry/__tests__/index.test.ts +17 -0
- package/src/scaffold-registry/__tests__/schema.test.ts +329 -230
- package/src/scaffold-registry/index.ts +205 -189
- package/src/scaffold-registry/schema.ts +196 -128
- package/src/server.ts +272 -272
- package/src/supabase/database.types.ts +2719 -2719
- package/src/supabase/helpers.ts +20 -20
- package/src/supabase/index.ts +52 -52
- package/src/supabase/server/client.ts +58 -58
- package/src/test-utils/README.md +38 -38
- package/src/test-utils/browser-mocks.ts +54 -54
- package/src/test-utils/fixtures/api-keys.ts +52 -52
- package/src/test-utils/fixtures/index.ts +4 -4
- package/src/test-utils/fixtures/memberships.ts +80 -80
- package/src/test-utils/fixtures/organizations.ts +69 -69
- package/src/test-utils/fixtures/users.ts +79 -79
- package/src/test-utils/index.ts +11 -11
- package/src/test-utils/mocks/index.ts +2 -2
- package/src/test-utils/mocks/supabase.ts +142 -142
- package/src/test-utils/mocks/workos.ts +108 -108
- package/src/test-utils/rls/RLSTestContext.ts +556 -556
- package/src/test-utils/rls/index.ts +1 -1
|
@@ -1,320 +1,320 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: Organization Model
|
|
3
|
-
description: Organization OS Model layer documentation for the semantic organization contract, covering domains, features, navigation surfaces, resource mappings, and the curated @elevasis/core public API.
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
## Overview
|
|
7
|
-
|
|
8
|
-
Within Organization OS, the organization model is the **Model** layer and part of the cross-cutting **Public API** layer. It is the semantic contract that maps an organization's full organizational reality to domains, features, navigation surfaces and groups, domain-specific semantics (sales pipeline, prospecting lifecycle, projects status), and resource mappings. It is schema-first, versioned, and validated.
|
|
9
|
-
|
|
10
|
-
The model is authored in `@repo/core` and published as a curated external package `@elevasis/core`. It is consumed by:
|
|
11
|
-
|
|
12
|
-
- `@repo/ui`'s feature-shell provider to resolve nav labels, surface paths, and feature state at runtime
|
|
13
|
-
- command-center's root shell as its canonical organization model
|
|
14
|
-
- `external/_template/foundations` and downstream derivatives as the adapter-backed source of organization truth
|
|
15
|
-
|
|
16
|
-
The model does **not** replace the shared feature-provider system. It enriches and constrains it.
|
|
17
|
-
|
|
18
|
-
## Source of Truth
|
|
19
|
-
|
|
20
|
-
- `packages/core/src/organization-model/schema.ts` -- `OrganizationModelSchema`
|
|
21
|
-
- `packages/core/src/organization-model/types.ts` -- exported TypeScript types
|
|
22
|
-
- `packages/core/src/organization-model/defaults.ts` -- `DEFAULT_ORGANIZATION_MODEL`
|
|
23
|
-
- `packages/core/src/organization-model/resolve.ts` -- `defineOrganizationModel`, `resolveOrganizationModel`
|
|
24
|
-
- `packages/core/src/organization-model/domains/*.ts` -- feature schema, navigation surfaces, sales/prospecting/projects semantics, and the 8 reality domains (identity, customers, offerings, roles, goals, statuses, operations, shared/techStack)
|
|
25
|
-
- `packages/core/src/published.ts` -- curated root barrel for the published package
|
|
26
|
-
- `packages/core/src/organization-model/published.ts` -- curated organization-model barrel
|
|
27
|
-
- `packages/core/src/__tests__/template-foundations-compatibility.test.ts` -- adapter-baseline guard
|
|
28
|
-
|
|
29
|
-
## Contract Shape
|
|
30
|
-
|
|
31
|
-
Top-level fields on `OrganizationModel`:
|
|
32
|
-
|
|
33
|
-
- `version`
|
|
34
|
-
- `features` -- unified feature array (`OrganizationModelFeature[]`); each entry combines access gating, semantic grouping, and display metadata
|
|
35
|
-
- `branding` -- display identity (org name, product name, logos)
|
|
36
|
-
- `navigation` -- surfaces, groups, `defaultSurfaceId`
|
|
37
|
-
- `sales` -- pipeline stages and stage semantics (formerly `crm`)
|
|
38
|
-
- `prospecting` -- company/contact lifecycle stages (formerly `leadGen`)
|
|
39
|
-
- `projects` -- project/milestone/task statuses (formerly `delivery`)
|
|
40
|
-
- `identity` -- legal identity, mission/vision, industry, geography, and temporal anchors
|
|
41
|
-
- `customers` -- customer segments with jobs-to-be-done, firmographics, and value propositions
|
|
42
|
-
- `offerings` -- products and services with pricing model and segment/feature references
|
|
43
|
-
- `roles` -- role chart with responsibilities, reporting lines, and role holders
|
|
44
|
-
- `goals` -- organizational goals with period and measurable outcomes
|
|
45
|
-
- `statuses` -- flat registry of all status entries across delivery, queue, execution, schedule, and request semantic classes
|
|
46
|
-
- `operations` -- catalog of stateful runtime entities (HITL queue, executions, sessions, notifications, schedules)
|
|
47
|
-
- `resourceMappings` -- deployable resource links, each optionally extended with `techStack` metadata
|
|
48
|
-
|
|
49
|
-
### Domain Rename Wave
|
|
50
|
-
|
|
51
|
-
Three legacy domain names were renamed in the 2026-04-20 expansion to align developer-facing code with user-visible labels:
|
|
52
|
-
|
|
53
|
-
| Old name | New name | Notes |
|
|
54
|
-
| ---------- | ------------- | ------------------------------------------------------------------------------------ |
|
|
55
|
-
| `crm` | `sales` | Domain files, feature IDs, surface IDs, imports, and sidebar labels all updated |
|
|
56
|
-
| `leadGen` | `prospecting` | Same scope as above |
|
|
57
|
-
| `delivery` | `projects` | Aligns with the "Projects" sidebar label; `projects` feature ID was already in place |
|
|
58
|
-
|
|
59
|
-
Any reference to `crm`, `leadGen`, or `delivery` in domain files, imports, or surface IDs should be treated as a historical artifact unless explicitly annotated otherwise.
|
|
60
|
-
|
|
61
|
-
### Branding Shape
|
|
62
|
-
|
|
63
|
-
`OrganizationModelBranding` holds display identity for the organization:
|
|
64
|
-
|
|
65
|
-
- `organizationName` -- the human-readable org name (required)
|
|
66
|
-
- `productName` -- the product label shown in the shell (required)
|
|
67
|
-
- `shortName` -- abbreviated name, max 40 chars (required)
|
|
68
|
-
- `description` -- optional long-form description
|
|
69
|
-
- `logos` -- optional object with `light` and `dark` URL strings (each max 2048 chars); defaults to `{}`
|
|
70
|
-
|
|
71
|
-
### ModelId Format Rules
|
|
72
|
-
|
|
73
|
-
All `id` fields, `parentId`, `defaultSurfaceId`, and reference ID arrays use `ModelIdSchema`:
|
|
74
|
-
|
|
75
|
-
- Regex: `/^[a-z0-9]+(?:[-._][a-z0-9]+)*$/`
|
|
76
|
-
- Max length: 100 chars
|
|
77
|
-
- Allowed separators: `-`, `_`, `.`
|
|
78
|
-
- Examples: `sales.pipeline`, `prospecting.lists`, `operations.organization-graph`
|
|
79
|
-
|
|
80
|
-
This applies to domain IDs, surface IDs, navigation group IDs, and resource mapping IDs.
|
|
81
|
-
|
|
82
|
-
### Default Features
|
|
83
|
-
|
|
84
|
-
Eight features ship by default in `DEFAULT_ORGANIZATION_MODEL.features`:
|
|
85
|
-
|
|
86
|
-
- `crm` -- enabled; sales pipeline and deal management (feature ID unchanged; domain renamed to `sales`)
|
|
87
|
-
- `lead-gen` -- enabled; prospecting, qualification, and outreach (feature ID unchanged; domain renamed to `prospecting`)
|
|
88
|
-
- `projects` -- enabled; projects, milestones, and client work execution
|
|
89
|
-
- `operations` -- enabled; organizational topology and orchestration visibility
|
|
90
|
-
- `monitoring` -- enabled; execution monitoring
|
|
91
|
-
- `settings` -- enabled; organization settings
|
|
92
|
-
- `submitted-requests` -- enabled; submitted-request lifecycle surface
|
|
93
|
-
- `seo` -- disabled by default; SEO surface
|
|
94
|
-
|
|
95
|
-
Note: the feature IDs (`crm`, `lead-gen`) are consumer-facing identifiers that have not changed. The underlying domain key on `OrganizationModel` was renamed (`crm` → `sales`, `leadGen` → `prospecting`). Adapters that already use the feature ID constants (`CRM_FEATURE_ID`, `LEAD_GEN_FEATURE_ID`) require no change.
|
|
96
|
-
|
|
97
|
-
Each feature entry (`OrganizationModelFeature`) combines what were previously three separate concepts: an access/gating key (the former `OrganizationModelFeatureKey`), a semantic domain (the former `SemanticDomainSchema` entry), and display metadata. The `features` field is now `z.array(FeatureSchema)` -- there is no separate `domains` array and no separate `enabled`/`labels` map.
|
|
98
|
-
|
|
99
|
-
`FeatureModule.featureId` on the UI side maps directly to one of these IDs. No alias layer is needed. See [Feature Shell](../ui/feature-shell.mdx) for how the provider resolves feature access from this array.
|
|
100
|
-
|
|
101
|
-
### ResourceMapping Shape
|
|
102
|
-
|
|
103
|
-
`OrganizationModelResourceMapping` links a deployable resource into the semantic model:
|
|
104
|
-
|
|
105
|
-
- `id` -- unique mapping ID (ModelId format)
|
|
106
|
-
- `resourceId` -- the actual resource identifier (string, max 255 chars)
|
|
107
|
-
- `resourceType` -- one of `'workflow' | 'agent' | 'trigger' | 'integration' | 'external' | 'human_checkpoint'`
|
|
108
|
-
- `label`, `description`, `color`, `icon` -- display metadata (from `DisplayMetadataSchema`)
|
|
109
|
-
- `featureIds` -- features this resource belongs to (replaces the former `domainIds`)
|
|
110
|
-
- `entityIds` -- entities this resource operates on
|
|
111
|
-
- `surfaceIds` -- surfaces this resource is exposed in
|
|
112
|
-
- `capabilityIds` -- capabilities this resource fulfills
|
|
113
|
-
- `techStack` (optional) -- external-SaaS integration metadata; see TechStack Extension below
|
|
114
|
-
|
|
115
|
-
All four ID arrays are bidirectionally validated against their counterparts (see Referential Integrity).
|
|
116
|
-
|
|
117
|
-
### TechStack Extension
|
|
118
|
-
|
|
119
|
-
`techStack` is an optional nested object on `ResourceMappingSchema` defined in `domains/shared.ts`. It captures external-SaaS integration metadata without introducing a tenth top-level domain. Fields:
|
|
120
|
-
|
|
121
|
-
- `platform` -- name of the external platform (e.g. "HubSpot", "Stripe", "Notion")
|
|
122
|
-
- `purpose` -- free-form description of what this integration does
|
|
123
|
-
- `credentialStatus` -- one of `'configured' | 'pending' | 'expired' | 'missing'`
|
|
124
|
-
- `isSystemOfRecord` -- boolean; whether this integration is the primary source of truth for its domain (defaults to `false`)
|
|
125
|
-
|
|
126
|
-
Backward-compatible: existing resource mappings without `techStack` parse cleanly. The extension flows through `ResourceMappingSchema` automatically with no changes to `schema.ts` composition.
|
|
127
|
-
|
|
128
|
-
### Default Navigation
|
|
129
|
-
|
|
130
|
-
Surfaces such as `sales.pipeline`, `prospecting.lists`, `projects.index`, `operations.organization-graph`, and `operations.command-view`. Groups include `primary-workspace` and `primary-operations`. The model can shape shell meaning even when route files stay app-local.
|
|
131
|
-
|
|
132
|
-
### SurfaceDefinition Shape
|
|
133
|
-
|
|
134
|
-
`OrganizationModelSurface` (inferred from `SurfaceDefinitionSchema`) defines a navigable view:
|
|
135
|
-
|
|
136
|
-
- `id` -- ModelId (e.g. `sales.pipeline`)
|
|
137
|
-
- `label` -- display name
|
|
138
|
-
- `path` -- route path, must start with `/`, max 300 chars
|
|
139
|
-
- `surfaceType` -- `'page' | 'dashboard' | 'graph' | 'detail' | 'list' | 'settings'`
|
|
140
|
-
- `description` -- optional
|
|
141
|
-
- `icon` -- optional icon name token (max 80 chars)
|
|
142
|
-
- `featureId` -- optional feature ID that gates this surface (replaces the former `featureKey` field); must match a feature `id` in the features array
|
|
143
|
-
- `parentId` -- optional ModelId referencing a parent surface; validated to exist
|
|
144
|
-
- `featureIds` -- features this surface belongs to (bidirectionally validated; replaces the former `domainIds`)
|
|
145
|
-
- `entityIds` -- entity IDs relevant to this surface
|
|
146
|
-
- `resourceIds` -- resources exposed on this surface (bidirectionally validated against resource mappings)
|
|
147
|
-
- `capabilityIds` -- capabilities this surface fulfills
|
|
148
|
-
|
|
149
|
-
### NavigationGroup Placement
|
|
150
|
-
|
|
151
|
-
`NavigationGroupSchema` has a `placement` field with three allowed values:
|
|
152
|
-
|
|
153
|
-
- `'primary'` -- main workspace or operations nav rail
|
|
154
|
-
- `'secondary'` -- secondary grouping (below primary)
|
|
155
|
-
- `'bottom'` -- pinned to the bottom of the nav rail
|
|
156
|
-
|
|
157
|
-
The default groups (`primary-workspace`, `primary-operations`) both use `placement: 'primary'`.
|
|
158
|
-
|
|
159
|
-
### Feature-Specific Semantics
|
|
160
|
-
|
|
161
|
-
Three renamed top-level domain fields carry feature-specific semantic shapes (pipeline stages, lifecycle stages, project statuses). These are named fields on `OrganizationModel`, not embedded in per-feature config:
|
|
162
|
-
|
|
163
|
-
- `sales` -- pipeline stages and stage semantics (formerly `crm`)
|
|
164
|
-
- `prospecting` -- company and contact lifecycle stages (formerly `leadGen`)
|
|
165
|
-
- `projects` -- project, milestone, and task statuses (formerly `delivery`)
|
|
166
|
-
|
|
167
|
-
This is why the organization model is semantic, not just nav config -- it owns product meaning for the business objects the shell surfaces expose.
|
|
168
|
-
|
|
169
|
-
### Reality Domains (New in 2026-04-20 Expansion)
|
|
170
|
-
|
|
171
|
-
Five new domains capture organizational reality that was absent from the original model. They sit alongside the existing platform-configuration domains and follow the same `domains/*.ts` pattern:
|
|
172
|
-
|
|
173
|
-
**`identity`** -- legal identity distinct from `branding` (which is display identity). Fields: `mission`, `vision`, `legalName`, `entityType`, `jurisdiction`, `industryCategory`, `geographicFocus`, `timeZone`, `businessHours`. All fields default to empty strings; `timeZone` defaults to `'UTC'`; `businessHours` defaults to `{}`.
|
|
174
|
-
|
|
175
|
-
**`customers`** -- customer segments. Each `CustomerSegment` entry has: `id`, `name`, `description`, `jobsToBeDone`, `pains`, `gains`, `valueProp` (all plain-language strings), and `firmographics` (optional object with `companySize`, `industry`, `revenue`, `geography`). Domain defaults to `{ segments: [] }`.
|
|
176
|
-
|
|
177
|
-
**`offerings`** -- products and services. Each `Product` entry has: `id`, `name`, `description`, `pricingModel` (enum: `'one-time' | 'subscription' | 'usage-based' | 'custom'`), `price` (optional number), `currency` (optional string), `targetSegmentIds` (cross-ref validated against `customers.segments[].id`), `deliveryFeatureId` (optional cross-ref validated against `features[].id`). Domain defaults to `{ products: [] }`.
|
|
178
|
-
|
|
179
|
-
**`roles`** -- role chart. Each `Role` entry has: `id`, `title`, `responsibilities` (string array, default `[]`), `reportsToId` (optional, cross-ref validated within the same collection), `heldBy` (optional name or email string). All field names are plain-language; no EOS jargon (`seats`, `accountabilities`) survives. Domain defaults to `{ roles: [] }`.
|
|
180
|
-
|
|
181
|
-
**`goals`** -- organizational goals. Each `Objective` entry has: `id`, `description`, `periodStart` (ISO 8601 date), `periodEnd` (ISO 8601 date, must be strictly after `periodStart`), `keyResults` (array of `{ id, description, targetValue?, currentValue?, unit? }`). User-facing text uses "goals" and "measurable outcomes" -- never "OKR" or "key results". Domain defaults to `{ objectives: [] }`.
|
|
182
|
-
|
|
183
|
-
### Statuses and Operations Domains (Vibe Layer)
|
|
184
|
-
|
|
185
|
-
Two domains support the ambient vibe layer's plain-language rendering:
|
|
186
|
-
|
|
187
|
-
**`statuses`** -- flat registry of `StatusEntry` objects. Each entry: `id`, `label`, `semanticClass` (one of `'delivery.task' | 'delivery.project' | 'delivery.milestone' | 'queue' | 'execution' | 'schedule' | 'schedule.run' | 'request'`), optional `category`. Labels are vibe-readable: the ambient classifier narrates state using `label` from the model, never hardcoded strings. `QueueTaskStatus` in the queue domain routes through this registry. Defaults to a seed set covering all semantic classes.
|
|
188
|
-
|
|
189
|
-
**`operations`** -- catalog of stateful runtime entities. Each `OperationEntry`: `id`, `label`, `semanticClass` (one of `'queue' | 'executions' | 'sessions' | 'notifications' | 'schedules'`), optional `featureId`, optional `supportedStatusSemanticClass` (ties an operation entry back to which status semantic classes apply). Default entries: `operations.queue` (HITL queue), `operations.executions`, `operations.sessions`, `operations.notifications`, `operations.schedules`.
|
|
190
|
-
|
|
191
|
-
## Authoring & Resolution
|
|
192
|
-
|
|
193
|
-
- `defineOrganizationModel()` -- typed authoring helper; returns the input unchanged but constrains the type.
|
|
194
|
-
- `resolveOrganizationModel(partial)` -- deep-merges a partial override into `DEFAULT_ORGANIZATION_MODEL` and validates the result against `OrganizationModelSchema`.
|
|
195
|
-
|
|
196
|
-
Merge semantics:
|
|
197
|
-
|
|
198
|
-
- plain objects merge recursively
|
|
199
|
-
- arrays **replace** defaults (no element-by-element merge)
|
|
200
|
-
- if `navigation.surfaces` is replaced without also supplying `navigation.groups`, inherited groups are normalized so they only keep still-valid surface IDs and any now-empty groups are dropped
|
|
201
|
-
- missing fields fall back to defaults
|
|
202
|
-
|
|
203
|
-
### Referential Integrity
|
|
204
|
-
|
|
205
|
-
`OrganizationModelSchema` validates more than top-level shape. The `superRefine` pass enforces:
|
|
206
|
-
|
|
207
|
-
**Uniqueness checks** -- IDs must be unique within their respective collections:
|
|
208
|
-
|
|
209
|
-
- `features[].id`
|
|
210
|
-
- `navigation.surfaces[].id`
|
|
211
|
-
- `navigation.groups[].id`
|
|
212
|
-
- `resourceMappings[].id`
|
|
213
|
-
- `resourceMappings[].resourceId` (separate uniqueness check -- two mappings cannot share a `resourceId`)
|
|
214
|
-
|
|
215
|
-
**Dangling reference detection** -- every cross-reference must resolve:
|
|
216
|
-
|
|
217
|
-
- `navigation.defaultSurfaceId` must point at a declared surface
|
|
218
|
-
- every `surfaceId` in a navigation group must resolve to a declared surface
|
|
219
|
-
- every `surfaceId` in a feature must resolve to a declared surface
|
|
220
|
-
- every `resourceId` in a feature must resolve to a declared resource mapping (by `resourceId`)
|
|
221
|
-
- surface `parentId` must reference an existing surface
|
|
222
|
-
- every `featureId` on a surface must resolve to a declared feature
|
|
223
|
-
- every `resourceId` on a surface must resolve to a declared resource mapping
|
|
224
|
-
- every `featureId` on a resource mapping must resolve to a declared feature
|
|
225
|
-
- every `surfaceId` on a resource mapping must resolve to a declared surface
|
|
226
|
-
|
|
227
|
-
**Bidirectional reference enforcement** -- cross-references must be mutual, not one-sided:
|
|
228
|
-
|
|
229
|
-
- a feature listing `surfaceId` S requires surface S to list that feature's ID in its `featureIds`
|
|
230
|
-
- a surface listing `featureId` F requires feature F to list that surface's ID in its `surfaceIds`
|
|
231
|
-
- a feature listing `resourceId` R requires resource mapping R to list that feature's ID in its `featureIds`
|
|
232
|
-
- a resource mapping listing `featureId` F requires feature F to list that resource's `resourceId` in its `resourceIds`
|
|
233
|
-
- a surface listing `resourceId` R requires resource mapping R to list that surface's ID in its `surfaceIds`
|
|
234
|
-
- a resource mapping listing `surfaceId` S requires surface S to list that resource's `resourceId` in its `resourceIds`
|
|
235
|
-
|
|
236
|
-
This bidirectional enforcement is what keeps the organization model semantically consistent rather than loosely structured config.
|
|
237
|
-
|
|
238
|
-
**Reality domain cross-refs** (validated in the same `superRefine` pass):
|
|
239
|
-
|
|
240
|
-
- each `offerings.products[].targetSegmentIds[]` must resolve to a `customers.segments[].id`
|
|
241
|
-
- each `offerings.products[].deliveryFeatureId` (when present) must resolve to a `features[].id`
|
|
242
|
-
- each `roles.roles[].reportsToId` (when present) must resolve to another `roles.roles[].id` in the same collection
|
|
243
|
-
- each `goals.objectives[].periodEnd` must be strictly after `periodStart` (ISO 8601 string comparison)
|
|
244
|
-
|
|
245
|
-
## Provider Integration
|
|
246
|
-
|
|
247
|
-
`ElevasisFeaturesProvider` uses the organization model in three ways:
|
|
248
|
-
|
|
249
|
-
1. **Feature resolution** -- the provider looks up each manifest's `featureId` in `organizationModel.features` to determine `access.enabled`. If no matching feature entry is found, `access.enabled` defaults to `false`.
|
|
250
|
-
2. **Nav label and path resolution** -- when `organizationModel` is present, feature labels resolve from the matching feature entry's `label` field, and surface labels and paths resolve from `organizationModel.navigation.surfaces`. Semantic customization without changing manifest code.
|
|
251
|
-
3. **Organization-graph bridge** -- the `operationsManifest` declares `organizationGraph.surfaceId = 'operations.organization-graph'`. The provider resolves that against organization-model surfaces and exposes the result as `organizationGraph` in context. See [Organization Graph](./organization-graph.mdx).
|
|
252
|
-
|
|
253
|
-
## Published Package: `@elevasis/core`
|
|
254
|
-
|
|
255
|
-
`@elevasis/core` is a curated publish wrapper around `packages/core`, released through `$sdk release-core`. It exists so external foundations (`_template/foundations`, `nirvana-marketing/foundations`, `ZentaraHQ/foundations`) can depend on a stable, browser-safe organization-model contract without reaching into monorepo-only `@repo/core`.
|
|
256
|
-
|
|
257
|
-
### Published surface
|
|
258
|
-
|
|
259
|
-
Intentionally narrow:
|
|
260
|
-
|
|
261
|
-
- `.` -- curated root barrel (`packages/core/src/published.ts`)
|
|
262
|
-
- `./organization-model` -- curated organization-model barrel (`packages/core/src/organization-model/published.ts`)
|
|
263
|
-
|
|
264
|
-
Exports on the first published surface:
|
|
265
|
-
|
|
266
|
-
- `OrganizationModelSchema`
|
|
267
|
-
- top-level organization-model types
|
|
268
|
-
- `DEFAULT_ORGANIZATION_MODEL`
|
|
269
|
-
- `defineOrganizationModel`
|
|
270
|
-
- `resolveOrganizationModel`
|
|
271
|
-
|
|
272
|
-
### Intentionally excluded
|
|
273
|
-
|
|
274
|
-
- wider `@repo/core` browser barrel
|
|
275
|
-
- organization-graph types/builder (`buildOrganizationGraph`, DTO types) -- graph work remains monorepo-first; external consumers should not assume graph contracts are published
|
|
276
|
-
|
|
277
|
-
### Build
|
|
278
|
-
|
|
279
|
-
- `pnpm --filter @repo/core build:publish` emits `dist/index.{js,d.ts}` and `dist/organization-model/index.{js,d.ts}` via tsup + `rollup-plugin-dts`.
|
|
280
|
-
- Shipped types are browser-safe and verified to contain no `@repo/*` imports.
|
|
281
|
-
|
|
282
|
-
### Release
|
|
283
|
-
|
|
284
|
-
- `.claude/sub-commands/sdk/release-core.md` -- dedicated publish flow
|
|
285
|
-
- `$sdk verify` -- covers publish metadata, bundled declarations, and the first template-foundation compatibility guard
|
|
286
|
-
|
|
287
|
-
## Downstream Adoption
|
|
288
|
-
|
|
289
|
-
External foundations consume `@elevasis/core/organization-model` via an **adapter**, not a fork. The adapter pattern in `external/_template/foundations/config/organization-model.ts`:
|
|
290
|
-
|
|
291
|
-
1. Define a canonical override with `defineOrganizationModel(...)`.
|
|
292
|
-
2. Resolve it with `resolveOrganizationModel(...)`.
|
|
293
|
-
3. Adapt the result into a template-local helper shape that adds consumer-only fields (`homeLabel`, `quickAccessSurfaceIds`, icon aliases, `getOrganizationSurface()`).
|
|
294
|
-
|
|
295
|
-
Exports the foundations module provides to consumers:
|
|
296
|
-
|
|
297
|
-
- `canonicalOrganizationModel` -- passed to `ElevasisFeaturesProvider`
|
|
298
|
-
- `organizationModel` -- widened adapter shape for template-local helpers
|
|
299
|
-
- `FoundationFeatureKey`, `FoundationSurfaceIcon`, `FoundationNavigationSurface`, `FoundationOrganizationModel`
|
|
300
|
-
- `homeLabel`, `quickAccessSurfaceIds`, `getOrganizationSurface(surfaceId)`
|
|
301
|
-
|
|
302
|
-
Downstream template shells pass `canonicalOrganizationModel` into `ElevasisFeaturesProvider`, preserving host-local dashboard/nav customizations alongside the shared runtime. Feature IDs are direct matches -- `crm`, `lead-gen`, `projects` in the org model correspond directly to the same IDs on `FeatureModule.featureId`. No alias layer is needed. The domain rename wave (crm→sales, leadGen→prospecting, delivery→projects) affects the schema field names, not the feature ID constants; adapters using `CRM_FEATURE_ID`, `LEAD_GEN_FEATURE_ID`, etc. require no changes.
|
|
303
|
-
|
|
304
|
-
Adapters that override the new reality domains (`identity`, `customers`, `offerings`, `roles`, `goals`) or add `techStack` metadata to resource mappings should use `/configure` as the structured entry point for those edits in external projects. `/configure` runs a layered QA flow, proposes changes, and gates the write through `resolveOrganizationModel()` + `OrganizationModelSchema.parse()` before committing.
|
|
305
|
-
|
|
306
|
-
Derivative projects (`external/nirvana-marketing`, `external/ZentaraHQ`) follow the same adapter + provider-wiring baseline with their own project-local customizations.
|
|
307
|
-
|
|
308
|
-
## Verification
|
|
309
|
-
|
|
310
|
-
- `pnpm --filter @repo/core build:publish` -- published bundle
|
|
311
|
-
- `pnpm --filter @repo/core test -- publish template-foundations-compatibility` -- published surface + adapter guard
|
|
312
|
-
- `pnpm -C external/_template/foundations test` -- foundations adapter and import-boundary guard
|
|
313
|
-
- `pnpm -C external/_template/ui test -- src/routes/__tests__/__root.test.tsx` -- provider-level `organizationModel` wiring in the template shell
|
|
314
|
-
|
|
315
|
-
## Design Constraints
|
|
316
|
-
|
|
317
|
-
- `@elevasis/core` must stay browser-safe. Build output inlines or eliminates `@repo/*` references from shipped types.
|
|
318
|
-
- The published surface stays curated -- do not reflexively re-export new `@repo/core` internals. Widening the surface is a deliberate decision, not a default.
|
|
319
|
-
- Organization-graph helpers remain internal until a concrete external consumer needs them.
|
|
320
|
-
- Foundations adapters preserve the semantic contract; they do not fork it. If a template needs a concept the canonical model can't express, extend the canonical model first.
|
|
1
|
+
---
|
|
2
|
+
title: Organization Model
|
|
3
|
+
description: Organization OS Model layer documentation for the semantic organization contract, covering domains, features, navigation surfaces, resource mappings, and the curated @elevasis/core public API.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
## Overview
|
|
7
|
+
|
|
8
|
+
Within Organization OS, the organization model is the **Model** layer and part of the cross-cutting **Public API** layer. It is the semantic contract that maps an organization's full organizational reality to domains, features, navigation surfaces and groups, domain-specific semantics (sales pipeline, prospecting lifecycle, projects status), and resource mappings. It is schema-first, versioned, and validated.
|
|
9
|
+
|
|
10
|
+
The model is authored in `@repo/core` and published as a curated external package `@elevasis/core`. It is consumed by:
|
|
11
|
+
|
|
12
|
+
- `@repo/ui`'s feature-shell provider to resolve nav labels, surface paths, and feature state at runtime
|
|
13
|
+
- command-center's root shell as its canonical organization model
|
|
14
|
+
- `external/_template/foundations` and downstream derivatives as the adapter-backed source of organization truth
|
|
15
|
+
|
|
16
|
+
The model does **not** replace the shared feature-provider system. It enriches and constrains it.
|
|
17
|
+
|
|
18
|
+
## Source of Truth
|
|
19
|
+
|
|
20
|
+
- `packages/core/src/organization-model/schema.ts` -- `OrganizationModelSchema`
|
|
21
|
+
- `packages/core/src/organization-model/types.ts` -- exported TypeScript types
|
|
22
|
+
- `packages/core/src/organization-model/defaults.ts` -- `DEFAULT_ORGANIZATION_MODEL`
|
|
23
|
+
- `packages/core/src/organization-model/resolve.ts` -- `defineOrganizationModel`, `resolveOrganizationModel`
|
|
24
|
+
- `packages/core/src/organization-model/domains/*.ts` -- feature schema, navigation surfaces, sales/prospecting/projects semantics, and the 8 reality domains (identity, customers, offerings, roles, goals, statuses, operations, shared/techStack)
|
|
25
|
+
- `packages/core/src/published.ts` -- curated root barrel for the published package
|
|
26
|
+
- `packages/core/src/organization-model/published.ts` -- curated organization-model barrel
|
|
27
|
+
- `packages/core/src/__tests__/template-foundations-compatibility.test.ts` -- adapter-baseline guard
|
|
28
|
+
|
|
29
|
+
## Contract Shape
|
|
30
|
+
|
|
31
|
+
Top-level fields on `OrganizationModel`:
|
|
32
|
+
|
|
33
|
+
- `version`
|
|
34
|
+
- `features` -- unified feature array (`OrganizationModelFeature[]`); each entry combines access gating, semantic grouping, and display metadata
|
|
35
|
+
- `branding` -- display identity (org name, product name, logos)
|
|
36
|
+
- `navigation` -- surfaces, groups, `defaultSurfaceId`
|
|
37
|
+
- `sales` -- pipeline stages and stage semantics (formerly `crm`)
|
|
38
|
+
- `prospecting` -- company/contact lifecycle stages (formerly `leadGen`)
|
|
39
|
+
- `projects` -- project/milestone/task statuses (formerly `delivery`)
|
|
40
|
+
- `identity` -- legal identity, mission/vision, industry, geography, and temporal anchors
|
|
41
|
+
- `customers` -- customer segments with jobs-to-be-done, firmographics, and value propositions
|
|
42
|
+
- `offerings` -- products and services with pricing model and segment/feature references
|
|
43
|
+
- `roles` -- role chart with responsibilities, reporting lines, and role holders
|
|
44
|
+
- `goals` -- organizational goals with period and measurable outcomes
|
|
45
|
+
- `statuses` -- flat registry of all status entries across delivery, queue, execution, schedule, and request semantic classes
|
|
46
|
+
- `operations` -- catalog of stateful runtime entities (HITL queue, executions, sessions, notifications, schedules)
|
|
47
|
+
- `resourceMappings` -- deployable resource links, each optionally extended with `techStack` metadata
|
|
48
|
+
|
|
49
|
+
### Domain Rename Wave
|
|
50
|
+
|
|
51
|
+
Three legacy domain names were renamed in the 2026-04-20 expansion to align developer-facing code with user-visible labels:
|
|
52
|
+
|
|
53
|
+
| Old name | New name | Notes |
|
|
54
|
+
| ---------- | ------------- | ------------------------------------------------------------------------------------ |
|
|
55
|
+
| `crm` | `sales` | Domain files, feature IDs, surface IDs, imports, and sidebar labels all updated |
|
|
56
|
+
| `leadGen` | `prospecting` | Same scope as above |
|
|
57
|
+
| `delivery` | `projects` | Aligns with the "Projects" sidebar label; `projects` feature ID was already in place |
|
|
58
|
+
|
|
59
|
+
Any reference to `crm`, `leadGen`, or `delivery` in domain files, imports, or surface IDs should be treated as a historical artifact unless explicitly annotated otherwise.
|
|
60
|
+
|
|
61
|
+
### Branding Shape
|
|
62
|
+
|
|
63
|
+
`OrganizationModelBranding` holds display identity for the organization:
|
|
64
|
+
|
|
65
|
+
- `organizationName` -- the human-readable org name (required)
|
|
66
|
+
- `productName` -- the product label shown in the shell (required)
|
|
67
|
+
- `shortName` -- abbreviated name, max 40 chars (required)
|
|
68
|
+
- `description` -- optional long-form description
|
|
69
|
+
- `logos` -- optional object with `light` and `dark` URL strings (each max 2048 chars); defaults to `{}`
|
|
70
|
+
|
|
71
|
+
### ModelId Format Rules
|
|
72
|
+
|
|
73
|
+
All `id` fields, `parentId`, `defaultSurfaceId`, and reference ID arrays use `ModelIdSchema`:
|
|
74
|
+
|
|
75
|
+
- Regex: `/^[a-z0-9]+(?:[-._][a-z0-9]+)*$/`
|
|
76
|
+
- Max length: 100 chars
|
|
77
|
+
- Allowed separators: `-`, `_`, `.`
|
|
78
|
+
- Examples: `sales.pipeline`, `prospecting.lists`, `operations.organization-graph`
|
|
79
|
+
|
|
80
|
+
This applies to domain IDs, surface IDs, navigation group IDs, and resource mapping IDs.
|
|
81
|
+
|
|
82
|
+
### Default Features
|
|
83
|
+
|
|
84
|
+
Eight features ship by default in `DEFAULT_ORGANIZATION_MODEL.features`:
|
|
85
|
+
|
|
86
|
+
- `crm` -- enabled; sales pipeline and deal management (feature ID unchanged; domain renamed to `sales`)
|
|
87
|
+
- `lead-gen` -- enabled; prospecting, qualification, and outreach (feature ID unchanged; domain renamed to `prospecting`)
|
|
88
|
+
- `projects` -- enabled; projects, milestones, and client work execution
|
|
89
|
+
- `operations` -- enabled; organizational topology and orchestration visibility
|
|
90
|
+
- `monitoring` -- enabled; execution monitoring
|
|
91
|
+
- `settings` -- enabled; organization settings
|
|
92
|
+
- `submitted-requests` -- enabled; submitted-request lifecycle surface
|
|
93
|
+
- `seo` -- disabled by default; SEO surface
|
|
94
|
+
|
|
95
|
+
Note: the feature IDs (`crm`, `lead-gen`) are consumer-facing identifiers that have not changed. The underlying domain key on `OrganizationModel` was renamed (`crm` → `sales`, `leadGen` → `prospecting`). Adapters that already use the feature ID constants (`CRM_FEATURE_ID`, `LEAD_GEN_FEATURE_ID`) require no change.
|
|
96
|
+
|
|
97
|
+
Each feature entry (`OrganizationModelFeature`) combines what were previously three separate concepts: an access/gating key (the former `OrganizationModelFeatureKey`), a semantic domain (the former `SemanticDomainSchema` entry), and display metadata. The `features` field is now `z.array(FeatureSchema)` -- there is no separate `domains` array and no separate `enabled`/`labels` map.
|
|
98
|
+
|
|
99
|
+
`FeatureModule.featureId` on the UI side maps directly to one of these IDs. No alias layer is needed. See [Feature Shell](../ui/feature-shell.mdx) for how the provider resolves feature access from this array.
|
|
100
|
+
|
|
101
|
+
### ResourceMapping Shape
|
|
102
|
+
|
|
103
|
+
`OrganizationModelResourceMapping` links a deployable resource into the semantic model:
|
|
104
|
+
|
|
105
|
+
- `id` -- unique mapping ID (ModelId format)
|
|
106
|
+
- `resourceId` -- the actual resource identifier (string, max 255 chars)
|
|
107
|
+
- `resourceType` -- one of `'workflow' | 'agent' | 'trigger' | 'integration' | 'external' | 'human_checkpoint'`
|
|
108
|
+
- `label`, `description`, `color`, `icon` -- display metadata (from `DisplayMetadataSchema`)
|
|
109
|
+
- `featureIds` -- features this resource belongs to (replaces the former `domainIds`)
|
|
110
|
+
- `entityIds` -- entities this resource operates on
|
|
111
|
+
- `surfaceIds` -- surfaces this resource is exposed in
|
|
112
|
+
- `capabilityIds` -- capabilities this resource fulfills
|
|
113
|
+
- `techStack` (optional) -- external-SaaS integration metadata; see TechStack Extension below
|
|
114
|
+
|
|
115
|
+
All four ID arrays are bidirectionally validated against their counterparts (see Referential Integrity).
|
|
116
|
+
|
|
117
|
+
### TechStack Extension
|
|
118
|
+
|
|
119
|
+
`techStack` is an optional nested object on `ResourceMappingSchema` defined in `domains/shared.ts`. It captures external-SaaS integration metadata without introducing a tenth top-level domain. Fields:
|
|
120
|
+
|
|
121
|
+
- `platform` -- name of the external platform (e.g. "HubSpot", "Stripe", "Notion")
|
|
122
|
+
- `purpose` -- free-form description of what this integration does
|
|
123
|
+
- `credentialStatus` -- one of `'configured' | 'pending' | 'expired' | 'missing'`
|
|
124
|
+
- `isSystemOfRecord` -- boolean; whether this integration is the primary source of truth for its domain (defaults to `false`)
|
|
125
|
+
|
|
126
|
+
Backward-compatible: existing resource mappings without `techStack` parse cleanly. The extension flows through `ResourceMappingSchema` automatically with no changes to `schema.ts` composition.
|
|
127
|
+
|
|
128
|
+
### Default Navigation
|
|
129
|
+
|
|
130
|
+
Surfaces such as `sales.pipeline`, `prospecting.lists`, `projects.index`, `operations.organization-graph`, and `operations.command-view`. Groups include `primary-workspace` and `primary-operations`. The model can shape shell meaning even when route files stay app-local.
|
|
131
|
+
|
|
132
|
+
### SurfaceDefinition Shape
|
|
133
|
+
|
|
134
|
+
`OrganizationModelSurface` (inferred from `SurfaceDefinitionSchema`) defines a navigable view:
|
|
135
|
+
|
|
136
|
+
- `id` -- ModelId (e.g. `sales.pipeline`)
|
|
137
|
+
- `label` -- display name
|
|
138
|
+
- `path` -- route path, must start with `/`, max 300 chars
|
|
139
|
+
- `surfaceType` -- `'page' | 'dashboard' | 'graph' | 'detail' | 'list' | 'settings'`
|
|
140
|
+
- `description` -- optional
|
|
141
|
+
- `icon` -- optional icon name token (max 80 chars)
|
|
142
|
+
- `featureId` -- optional feature ID that gates this surface (replaces the former `featureKey` field); must match a feature `id` in the features array
|
|
143
|
+
- `parentId` -- optional ModelId referencing a parent surface; validated to exist
|
|
144
|
+
- `featureIds` -- features this surface belongs to (bidirectionally validated; replaces the former `domainIds`)
|
|
145
|
+
- `entityIds` -- entity IDs relevant to this surface
|
|
146
|
+
- `resourceIds` -- resources exposed on this surface (bidirectionally validated against resource mappings)
|
|
147
|
+
- `capabilityIds` -- capabilities this surface fulfills
|
|
148
|
+
|
|
149
|
+
### NavigationGroup Placement
|
|
150
|
+
|
|
151
|
+
`NavigationGroupSchema` has a `placement` field with three allowed values:
|
|
152
|
+
|
|
153
|
+
- `'primary'` -- main workspace or operations nav rail
|
|
154
|
+
- `'secondary'` -- secondary grouping (below primary)
|
|
155
|
+
- `'bottom'` -- pinned to the bottom of the nav rail
|
|
156
|
+
|
|
157
|
+
The default groups (`primary-workspace`, `primary-operations`) both use `placement: 'primary'`.
|
|
158
|
+
|
|
159
|
+
### Feature-Specific Semantics
|
|
160
|
+
|
|
161
|
+
Three renamed top-level domain fields carry feature-specific semantic shapes (pipeline stages, lifecycle stages, project statuses). These are named fields on `OrganizationModel`, not embedded in per-feature config:
|
|
162
|
+
|
|
163
|
+
- `sales` -- pipeline stages and stage semantics (formerly `crm`)
|
|
164
|
+
- `prospecting` -- company and contact lifecycle stages (formerly `leadGen`)
|
|
165
|
+
- `projects` -- project, milestone, and task statuses (formerly `delivery`)
|
|
166
|
+
|
|
167
|
+
This is why the organization model is semantic, not just nav config -- it owns product meaning for the business objects the shell surfaces expose.
|
|
168
|
+
|
|
169
|
+
### Reality Domains (New in 2026-04-20 Expansion)
|
|
170
|
+
|
|
171
|
+
Five new domains capture organizational reality that was absent from the original model. They sit alongside the existing platform-configuration domains and follow the same `domains/*.ts` pattern:
|
|
172
|
+
|
|
173
|
+
**`identity`** -- legal identity distinct from `branding` (which is display identity). Fields: `mission`, `vision`, `legalName`, `entityType`, `jurisdiction`, `industryCategory`, `geographicFocus`, `timeZone`, `businessHours`. All fields default to empty strings; `timeZone` defaults to `'UTC'`; `businessHours` defaults to `{}`.
|
|
174
|
+
|
|
175
|
+
**`customers`** -- customer segments. Each `CustomerSegment` entry has: `id`, `name`, `description`, `jobsToBeDone`, `pains`, `gains`, `valueProp` (all plain-language strings), and `firmographics` (optional object with `companySize`, `industry`, `revenue`, `geography`). Domain defaults to `{ segments: [] }`.
|
|
176
|
+
|
|
177
|
+
**`offerings`** -- products and services. Each `Product` entry has: `id`, `name`, `description`, `pricingModel` (enum: `'one-time' | 'subscription' | 'usage-based' | 'custom'`), `price` (optional number), `currency` (optional string), `targetSegmentIds` (cross-ref validated against `customers.segments[].id`), `deliveryFeatureId` (optional cross-ref validated against `features[].id`). Domain defaults to `{ products: [] }`.
|
|
178
|
+
|
|
179
|
+
**`roles`** -- role chart. Each `Role` entry has: `id`, `title`, `responsibilities` (string array, default `[]`), `reportsToId` (optional, cross-ref validated within the same collection), `heldBy` (optional name or email string). All field names are plain-language; no EOS jargon (`seats`, `accountabilities`) survives. Domain defaults to `{ roles: [] }`.
|
|
180
|
+
|
|
181
|
+
**`goals`** -- organizational goals. Each `Objective` entry has: `id`, `description`, `periodStart` (ISO 8601 date), `periodEnd` (ISO 8601 date, must be strictly after `periodStart`), `keyResults` (array of `{ id, description, targetValue?, currentValue?, unit? }`). User-facing text uses "goals" and "measurable outcomes" -- never "OKR" or "key results". Domain defaults to `{ objectives: [] }`.
|
|
182
|
+
|
|
183
|
+
### Statuses and Operations Domains (Vibe Layer)
|
|
184
|
+
|
|
185
|
+
Two domains support the ambient vibe layer's plain-language rendering:
|
|
186
|
+
|
|
187
|
+
**`statuses`** -- flat registry of `StatusEntry` objects. Each entry: `id`, `label`, `semanticClass` (one of `'delivery.task' | 'delivery.project' | 'delivery.milestone' | 'queue' | 'execution' | 'schedule' | 'schedule.run' | 'request'`), optional `category`. Labels are vibe-readable: the ambient classifier narrates state using `label` from the model, never hardcoded strings. `QueueTaskStatus` in the queue domain routes through this registry. Defaults to a seed set covering all semantic classes.
|
|
188
|
+
|
|
189
|
+
**`operations`** -- catalog of stateful runtime entities. Each `OperationEntry`: `id`, `label`, `semanticClass` (one of `'queue' | 'executions' | 'sessions' | 'notifications' | 'schedules'`), optional `featureId`, optional `supportedStatusSemanticClass` (ties an operation entry back to which status semantic classes apply). Default entries: `operations.queue` (HITL queue), `operations.executions`, `operations.sessions`, `operations.notifications`, `operations.schedules`.
|
|
190
|
+
|
|
191
|
+
## Authoring & Resolution
|
|
192
|
+
|
|
193
|
+
- `defineOrganizationModel()` -- typed authoring helper; returns the input unchanged but constrains the type.
|
|
194
|
+
- `resolveOrganizationModel(partial)` -- deep-merges a partial override into `DEFAULT_ORGANIZATION_MODEL` and validates the result against `OrganizationModelSchema`.
|
|
195
|
+
|
|
196
|
+
Merge semantics:
|
|
197
|
+
|
|
198
|
+
- plain objects merge recursively
|
|
199
|
+
- arrays **replace** defaults (no element-by-element merge)
|
|
200
|
+
- if `navigation.surfaces` is replaced without also supplying `navigation.groups`, inherited groups are normalized so they only keep still-valid surface IDs and any now-empty groups are dropped
|
|
201
|
+
- missing fields fall back to defaults
|
|
202
|
+
|
|
203
|
+
### Referential Integrity
|
|
204
|
+
|
|
205
|
+
`OrganizationModelSchema` validates more than top-level shape. The `superRefine` pass enforces:
|
|
206
|
+
|
|
207
|
+
**Uniqueness checks** -- IDs must be unique within their respective collections:
|
|
208
|
+
|
|
209
|
+
- `features[].id`
|
|
210
|
+
- `navigation.surfaces[].id`
|
|
211
|
+
- `navigation.groups[].id`
|
|
212
|
+
- `resourceMappings[].id`
|
|
213
|
+
- `resourceMappings[].resourceId` (separate uniqueness check -- two mappings cannot share a `resourceId`)
|
|
214
|
+
|
|
215
|
+
**Dangling reference detection** -- every cross-reference must resolve:
|
|
216
|
+
|
|
217
|
+
- `navigation.defaultSurfaceId` must point at a declared surface
|
|
218
|
+
- every `surfaceId` in a navigation group must resolve to a declared surface
|
|
219
|
+
- every `surfaceId` in a feature must resolve to a declared surface
|
|
220
|
+
- every `resourceId` in a feature must resolve to a declared resource mapping (by `resourceId`)
|
|
221
|
+
- surface `parentId` must reference an existing surface
|
|
222
|
+
- every `featureId` on a surface must resolve to a declared feature
|
|
223
|
+
- every `resourceId` on a surface must resolve to a declared resource mapping
|
|
224
|
+
- every `featureId` on a resource mapping must resolve to a declared feature
|
|
225
|
+
- every `surfaceId` on a resource mapping must resolve to a declared surface
|
|
226
|
+
|
|
227
|
+
**Bidirectional reference enforcement** -- cross-references must be mutual, not one-sided:
|
|
228
|
+
|
|
229
|
+
- a feature listing `surfaceId` S requires surface S to list that feature's ID in its `featureIds`
|
|
230
|
+
- a surface listing `featureId` F requires feature F to list that surface's ID in its `surfaceIds`
|
|
231
|
+
- a feature listing `resourceId` R requires resource mapping R to list that feature's ID in its `featureIds`
|
|
232
|
+
- a resource mapping listing `featureId` F requires feature F to list that resource's `resourceId` in its `resourceIds`
|
|
233
|
+
- a surface listing `resourceId` R requires resource mapping R to list that surface's ID in its `surfaceIds`
|
|
234
|
+
- a resource mapping listing `surfaceId` S requires surface S to list that resource's `resourceId` in its `resourceIds`
|
|
235
|
+
|
|
236
|
+
This bidirectional enforcement is what keeps the organization model semantically consistent rather than loosely structured config.
|
|
237
|
+
|
|
238
|
+
**Reality domain cross-refs** (validated in the same `superRefine` pass):
|
|
239
|
+
|
|
240
|
+
- each `offerings.products[].targetSegmentIds[]` must resolve to a `customers.segments[].id`
|
|
241
|
+
- each `offerings.products[].deliveryFeatureId` (when present) must resolve to a `features[].id`
|
|
242
|
+
- each `roles.roles[].reportsToId` (when present) must resolve to another `roles.roles[].id` in the same collection
|
|
243
|
+
- each `goals.objectives[].periodEnd` must be strictly after `periodStart` (ISO 8601 string comparison)
|
|
244
|
+
|
|
245
|
+
## Provider Integration
|
|
246
|
+
|
|
247
|
+
`ElevasisFeaturesProvider` uses the organization model in three ways:
|
|
248
|
+
|
|
249
|
+
1. **Feature resolution** -- the provider looks up each manifest's `featureId` in `organizationModel.features` to determine `access.enabled`. If no matching feature entry is found, `access.enabled` defaults to `false`.
|
|
250
|
+
2. **Nav label and path resolution** -- when `organizationModel` is present, feature labels resolve from the matching feature entry's `label` field, and surface labels and paths resolve from `organizationModel.navigation.surfaces`. Semantic customization without changing manifest code.
|
|
251
|
+
3. **Organization-graph bridge** -- the `operationsManifest` declares `organizationGraph.surfaceId = 'operations.organization-graph'`. The provider resolves that against organization-model surfaces and exposes the result as `organizationGraph` in context. See [Organization Graph](./organization-graph.mdx).
|
|
252
|
+
|
|
253
|
+
## Published Package: `@elevasis/core`
|
|
254
|
+
|
|
255
|
+
`@elevasis/core` is a curated publish wrapper around `packages/core`, released through `$sdk release-core`. It exists so external foundations (`_template/foundations`, `nirvana-marketing/foundations`, `ZentaraHQ/foundations`) can depend on a stable, browser-safe organization-model contract without reaching into monorepo-only `@repo/core`.
|
|
256
|
+
|
|
257
|
+
### Published surface
|
|
258
|
+
|
|
259
|
+
Intentionally narrow:
|
|
260
|
+
|
|
261
|
+
- `.` -- curated root barrel (`packages/core/src/published.ts`)
|
|
262
|
+
- `./organization-model` -- curated organization-model barrel (`packages/core/src/organization-model/published.ts`)
|
|
263
|
+
|
|
264
|
+
Exports on the first published surface:
|
|
265
|
+
|
|
266
|
+
- `OrganizationModelSchema`
|
|
267
|
+
- top-level organization-model types
|
|
268
|
+
- `DEFAULT_ORGANIZATION_MODEL`
|
|
269
|
+
- `defineOrganizationModel`
|
|
270
|
+
- `resolveOrganizationModel`
|
|
271
|
+
|
|
272
|
+
### Intentionally excluded
|
|
273
|
+
|
|
274
|
+
- wider `@repo/core` browser barrel
|
|
275
|
+
- organization-graph types/builder (`buildOrganizationGraph`, DTO types) -- graph work remains monorepo-first; external consumers should not assume graph contracts are published
|
|
276
|
+
|
|
277
|
+
### Build
|
|
278
|
+
|
|
279
|
+
- `pnpm --filter @repo/core build:publish` emits `dist/index.{js,d.ts}` and `dist/organization-model/index.{js,d.ts}` via tsup + `rollup-plugin-dts`.
|
|
280
|
+
- Shipped types are browser-safe and verified to contain no `@repo/*` imports.
|
|
281
|
+
|
|
282
|
+
### Release
|
|
283
|
+
|
|
284
|
+
- `.claude/sub-commands/sdk/release-core.md` -- dedicated publish flow
|
|
285
|
+
- `$sdk verify` -- covers publish metadata, bundled declarations, and the first template-foundation compatibility guard
|
|
286
|
+
|
|
287
|
+
## Downstream Adoption
|
|
288
|
+
|
|
289
|
+
External foundations consume `@elevasis/core/organization-model` via an **adapter**, not a fork. The adapter pattern in `external/_template/foundations/config/organization-model.ts`:
|
|
290
|
+
|
|
291
|
+
1. Define a canonical override with `defineOrganizationModel(...)`.
|
|
292
|
+
2. Resolve it with `resolveOrganizationModel(...)`.
|
|
293
|
+
3. Adapt the result into a template-local helper shape that adds consumer-only fields (`homeLabel`, `quickAccessSurfaceIds`, icon aliases, `getOrganizationSurface()`).
|
|
294
|
+
|
|
295
|
+
Exports the foundations module provides to consumers:
|
|
296
|
+
|
|
297
|
+
- `canonicalOrganizationModel` -- passed to `ElevasisFeaturesProvider`
|
|
298
|
+
- `organizationModel` -- widened adapter shape for template-local helpers
|
|
299
|
+
- `FoundationFeatureKey`, `FoundationSurfaceIcon`, `FoundationNavigationSurface`, `FoundationOrganizationModel`
|
|
300
|
+
- `homeLabel`, `quickAccessSurfaceIds`, `getOrganizationSurface(surfaceId)`
|
|
301
|
+
|
|
302
|
+
Downstream template shells pass `canonicalOrganizationModel` into `ElevasisFeaturesProvider`, preserving host-local dashboard/nav customizations alongside the shared runtime. Feature IDs are direct matches -- `crm`, `lead-gen`, `projects` in the org model correspond directly to the same IDs on `FeatureModule.featureId`. No alias layer is needed. The domain rename wave (crm→sales, leadGen→prospecting, delivery→projects) affects the schema field names, not the feature ID constants; adapters using `CRM_FEATURE_ID`, `LEAD_GEN_FEATURE_ID`, etc. require no changes.
|
|
303
|
+
|
|
304
|
+
Adapters that override the new reality domains (`identity`, `customers`, `offerings`, `roles`, `goals`) or add `techStack` metadata to resource mappings should use `/configure` as the structured entry point for those edits in external projects. `/configure` runs a layered QA flow, proposes changes, and gates the write through `resolveOrganizationModel()` + `OrganizationModelSchema.parse()` before committing.
|
|
305
|
+
|
|
306
|
+
Derivative projects (`external/nirvana-marketing`, `external/ZentaraHQ`) follow the same adapter + provider-wiring baseline with their own project-local customizations.
|
|
307
|
+
|
|
308
|
+
## Verification
|
|
309
|
+
|
|
310
|
+
- `pnpm --filter @repo/core build:publish` -- published bundle
|
|
311
|
+
- `pnpm --filter @repo/core test -- publish template-foundations-compatibility` -- published surface + adapter guard
|
|
312
|
+
- `pnpm -C external/_template/foundations test` -- foundations adapter and import-boundary guard
|
|
313
|
+
- `pnpm -C external/_template/ui test -- src/routes/__tests__/__root.test.tsx` -- provider-level `organizationModel` wiring in the template shell
|
|
314
|
+
|
|
315
|
+
## Design Constraints
|
|
316
|
+
|
|
317
|
+
- `@elevasis/core` must stay browser-safe. Build output inlines or eliminates `@repo/*` references from shipped types.
|
|
318
|
+
- The published surface stays curated -- do not reflexively re-export new `@repo/core` internals. Widening the surface is a deliberate decision, not a default.
|
|
319
|
+
- Organization-graph helpers remain internal until a concrete external consumer needs them.
|
|
320
|
+
- Foundations adapters preserve the semantic contract; they do not fork it. If a template needs a concept the canonical model can't express, extend the canonical model first.
|