@contractspec/bundle.library 3.8.10 → 3.8.11
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/.turbo/turbo-build.log +606 -594
- package/CHANGELOG.md +37 -0
- package/dist/application/context-storage/index.js +1 -28
- package/dist/application/index.js +13 -2133
- package/dist/application/mcp/cliMcp.js +4 -452
- package/dist/application/mcp/common.js +1 -193
- package/dist/application/mcp/contractsMcp.js +2 -549
- package/dist/application/mcp/contractsMcpResources.js +2 -123
- package/dist/application/mcp/contractsMcpTools.js +1 -199
- package/dist/application/mcp/docsMcp.catalog.js +3 -381
- package/dist/application/mcp/docsMcp.data.js +1 -147
- package/dist/application/mcp/docsMcp.js +6 -1039
- package/dist/application/mcp/docsMcp.prompts.js +6 -521
- package/dist/application/mcp/docsMcp.reference.js +3 -235
- package/dist/application/mcp/docsMcp.resources.js +3 -519
- package/dist/application/mcp/docsMcp.tools.js +3 -518
- package/dist/application/mcp/index.js +13 -2106
- package/dist/application/mcp/internalMcp.js +2 -410
- package/dist/application/mcp/normalizeMcpRequest.js +1 -21
- package/dist/application/mcp/providerRankingMcp.js +1 -530
- package/dist/bundles/LibraryBundle.js +1 -138
- package/dist/bundles/index.js +1 -138
- package/dist/components/docs/DocsIndexPage.js +2 -912
- package/dist/components/docs/advanced/AdvancedMCPPage.js +4 -271
- package/dist/components/docs/advanced/AdvancedOverlayEditorPage.js +1 -107
- package/dist/components/docs/advanced/AdvancedRenderersPage.js +2 -118
- package/dist/components/docs/advanced/AdvancedSpecExperimentsPage.js +4 -92
- package/dist/components/docs/advanced/AdvancedTelemetryPage.js +2 -373
- package/dist/components/docs/advanced/AdvancedWorkflowMonitoringPage.js +2 -99
- package/dist/components/docs/advanced/index.js +10 -1055
- package/dist/components/docs/architecture/ArchitectureAppConfigPage.js +6 -243
- package/dist/components/docs/architecture/ArchitectureControlPlanePage.js +3 -160
- package/dist/components/docs/architecture/ArchitectureIntegrationBindingPage.js +7 -259
- package/dist/components/docs/architecture/ArchitectureKnowledgeBindingPage.js +6 -374
- package/dist/components/docs/architecture/ArchitectureMultiTenancyPage.js +2 -166
- package/dist/components/docs/architecture/ArchitectureOverviewPage.js +1 -143
- package/dist/components/docs/architecture/index.js +20 -1340
- package/dist/components/docs/comparison/ComparisonAutomationPlatformsPage.js +1 -245
- package/dist/components/docs/comparison/ComparisonEnterprisePlatformsPage.js +1 -230
- package/dist/components/docs/comparison/ComparisonInternalToolBuildersPage.js +1 -245
- package/dist/components/docs/comparison/ComparisonOverviewPage.js +1 -202
- package/dist/components/docs/comparison/ComparisonWindmillPage.js +1 -254
- package/dist/components/docs/comparison/ComparisonWorkflowEnginesPage.js +1 -339
- package/dist/components/docs/comparison/index.js +1 -1510
- package/dist/components/docs/docsManifest.js +1 -611
- package/dist/components/docs/docsManifest.test.d.ts +1 -0
- package/dist/components/docs/ecosystem/IntegrationsPage.js +2 -103
- package/dist/components/docs/ecosystem/PluginsPage.js +13 -179
- package/dist/components/docs/ecosystem/RegistryPage.js +7 -100
- package/dist/components/docs/ecosystem/TemplatesPage.js +3 -141
- package/dist/components/docs/ecosystem/ecosystem.docblocks.js +2 -48
- package/dist/components/docs/ecosystem/index.js +23 -569
- package/dist/components/docs/examples/DocsExamplesPage.js +4 -124
- package/dist/components/docs/examples/ExampleShowcasePage.js +4 -244
- package/dist/components/docs/examples/exampleShowcaseData.js +4 -39
- package/dist/components/docs/examples/index.js +4 -330
- package/dist/components/docs/generated/docs-index.generated.js +1 -5
- package/dist/components/docs/generated/index.js +1 -74
- package/dist/components/docs/generated/loader.js +1 -74
- package/dist/components/docs/getting-started/CLIPage.js +4 -271
- package/dist/components/docs/getting-started/CompatibilityPage.js +1 -173
- package/dist/components/docs/getting-started/DataViewTutorialPage.js +4 -134
- package/dist/components/docs/getting-started/DeveloperToolsPage.js +1 -194
- package/dist/components/docs/getting-started/HelloWorldPage.js +5 -183
- package/dist/components/docs/getting-started/InstallationPage.js +3 -154
- package/dist/components/docs/getting-started/StartHerePage.js +2 -129
- package/dist/components/docs/getting-started/TroubleshootingPage.js +2 -168
- package/dist/components/docs/getting-started/VSCodeExtensionPage.js +1 -432
- package/dist/components/docs/getting-started/getting-started.docblocks.js +4 -41
- package/dist/components/docs/getting-started/index.js +18 -1869
- package/dist/components/docs/guides/GuideCIDiffGatingPage.js +2 -196
- package/dist/components/docs/guides/GuideConnectInRepoPage.d.ts +1 -0
- package/dist/components/docs/guides/GuideConnectInRepoPage.js +44 -0
- package/dist/components/docs/guides/GuideContractTypesPage.js +6 -541
- package/dist/components/docs/guides/GuideDocsPipelinePage.js +3 -207
- package/dist/components/docs/guides/GuideFirstModuleBundlePage.d.ts +1 -0
- package/dist/components/docs/guides/GuideFirstModuleBundlePage.js +76 -0
- package/dist/components/docs/guides/GuideGenerateDocsClientsSchemasPage.js +2 -209
- package/dist/components/docs/guides/GuideHostBuilderWorkbenchPage.d.ts +1 -0
- package/dist/components/docs/guides/GuideHostBuilderWorkbenchPage.js +70 -0
- package/dist/components/docs/guides/GuideImportExistingCodebasesPage.js +8 -754
- package/dist/components/docs/guides/GuideNextjsOneEndpointPage.js +6 -268
- package/dist/components/docs/guides/GuideSpecValidationTypingPage.js +4 -196
- package/dist/components/docs/guides/GuidesIndexPage.js +2 -169
- package/dist/components/docs/guides/guides.docblocks.js +11 -75
- package/dist/components/docs/guides/index.d.ts +3 -0
- package/dist/components/docs/guides/index.js +213 -2428
- package/dist/components/docs/index.js +542 -24310
- package/dist/components/docs/integrations/IntegrationsCircuitBreakersPage.js +2 -42
- package/dist/components/docs/integrations/IntegrationsElevenLabsPage.js +3 -105
- package/dist/components/docs/integrations/IntegrationsGithubPage.js +3 -142
- package/dist/components/docs/integrations/IntegrationsGmailPage.js +3 -109
- package/dist/components/docs/integrations/IntegrationsGoogleCalendarPage.js +3 -79
- package/dist/components/docs/integrations/IntegrationsHealthRoutingPage.js +3 -146
- package/dist/components/docs/integrations/IntegrationsMistralPage.js +5 -150
- package/dist/components/docs/integrations/IntegrationsOpenAIPage.js +5 -140
- package/dist/components/docs/integrations/IntegrationsOverviewPage.js +1 -160
- package/dist/components/docs/integrations/IntegrationsPostmarkPage.js +4 -218
- package/dist/components/docs/integrations/IntegrationsPowensPage.js +4 -300
- package/dist/components/docs/integrations/IntegrationsQdrantPage.js +5 -111
- package/dist/components/docs/integrations/IntegrationsResendPage.js +3 -102
- package/dist/components/docs/integrations/IntegrationsS3Page.js +4 -124
- package/dist/components/docs/integrations/IntegrationsSlackPage.js +3 -144
- package/dist/components/docs/integrations/IntegrationsSpecModelPage.js +7 -290
- package/dist/components/docs/integrations/IntegrationsStripePage.js +6 -327
- package/dist/components/docs/integrations/IntegrationsTwilioPage.js +3 -128
- package/dist/components/docs/integrations/IntegrationsWhatsappMetaPage.js +2 -146
- package/dist/components/docs/integrations/IntegrationsWhatsappTwilioPage.js +2 -156
- package/dist/components/docs/integrations/index.js +52 -3100
- package/dist/components/docs/intent/ContractFirstApiPage.js +2 -126
- package/dist/components/docs/intent/DeterministicCodegenPage.js +2 -148
- package/dist/components/docs/intent/GenerateClientFromSchemaPage.js +7 -207
- package/dist/components/docs/intent/OpenapiAlternativePage.js +3 -201
- package/dist/components/docs/intent/SchemaValidationTypescriptPage.js +4 -144
- package/dist/components/docs/intent/SpecDrivenDevelopmentPage.js +2 -126
- package/dist/components/docs/intent/index.js +15 -1135
- package/dist/components/docs/intent/intent-pages.docblocks.js +1 -201
- package/dist/components/docs/knowledge/KnowledgeCategoriesPage.js +6 -750
- package/dist/components/docs/knowledge/KnowledgeExamplesPage.js +4 -175
- package/dist/components/docs/knowledge/KnowledgeOverviewPage.js +1 -116
- package/dist/components/docs/knowledge/KnowledgeSourcesPage.js +8 -391
- package/dist/components/docs/knowledge/KnowledgeSpacesPage.js +6 -302
- package/dist/components/docs/knowledge/index.js +21 -1730
- package/dist/components/docs/libraries/LibrariesAccessibilityPage.js +3 -198
- package/dist/components/docs/libraries/LibrariesAiAgentPage.js +3 -141
- package/dist/components/docs/libraries/LibrariesAnalyticsPage.js +4 -80
- package/dist/components/docs/libraries/LibrariesContentGenPage.js +2 -100
- package/dist/components/docs/libraries/LibrariesContractsPage.js +2 -284
- package/dist/components/docs/libraries/LibrariesCostTrackingPage.js +3 -112
- package/dist/components/docs/libraries/LibrariesDataBackendPage.js +2 -166
- package/dist/components/docs/libraries/LibrariesDataViewsPage.js +3 -186
- package/dist/components/docs/libraries/LibrariesDesignSystemPage.js +4 -279
- package/dist/components/docs/libraries/LibrariesEvolutionPage.js +4 -127
- package/dist/components/docs/libraries/LibrariesGraphQLPage.js +2 -173
- package/dist/components/docs/libraries/LibrariesGrowthPage.js +3 -88
- package/dist/components/docs/libraries/LibrariesMultiTenancyPage.js +3 -108
- package/dist/components/docs/libraries/LibrariesObservabilityPage.js +5 -130
- package/dist/components/docs/libraries/LibrariesOverlayEnginePage.js +4 -110
- package/dist/components/docs/libraries/LibrariesOverviewPage.js +1 -170
- package/dist/components/docs/libraries/LibrariesPersonalizationPage.js +4 -114
- package/dist/components/docs/libraries/LibrariesProgressiveDeliveryPage.js +3 -132
- package/dist/components/docs/libraries/LibrariesResiliencePage.js +4 -120
- package/dist/components/docs/libraries/LibrariesRuntimePage.js +2 -200
- package/dist/components/docs/libraries/LibrariesSLOPage.js +3 -116
- package/dist/components/docs/libraries/LibrariesSchemaPage.js +3 -273
- package/dist/components/docs/libraries/LibrariesSupportBotPage.js +3 -134
- package/dist/components/docs/libraries/LibrariesTestingPage.js +3 -133
- package/dist/components/docs/libraries/LibrariesUIKitPage.js +2 -230
- package/dist/components/docs/libraries/LibrariesWorkflowComposerPage.js +3 -88
- package/dist/components/docs/libraries/LibrariesWorkflowsPage.js +2 -181
- package/dist/components/docs/libraries/index.js +54 -4147
- package/dist/components/docs/manifesto/ManifestoPage.js +1 -86
- package/dist/components/docs/ops/AutoEvolutionOpsPage.js +2 -132
- package/dist/components/docs/ops/DistributedTracingOpsPage.js +2 -71
- package/dist/components/docs/ops/index.js +3 -202
- package/dist/components/docs/ops/ops-lifecycle.docblocks.js +3 -38
- package/dist/components/docs/ops/ops-runbooks-a.docblocks.js +3 -94
- package/dist/components/docs/ops/ops-runbooks-b.docblocks.js +3 -76
- package/dist/components/docs/ops/ops-slo-tenant.docblocks.js +3 -76
- package/dist/components/docs/ops/ops-top.docs.js +2 -17
- package/dist/components/docs/ops/ops.docs.js +10 -302
- package/dist/components/docs/product/product.docblocks.js +5 -72
- package/dist/components/docs/reference/DocsMarkdownContent.js +2 -196
- package/dist/components/docs/reference/DocsReferenceContent.js +3 -256
- package/dist/components/docs/reference/DocsReferenceIndexClient.js +2 -127
- package/dist/components/docs/reference/DocsReferenceIndexPage.js +2 -206
- package/dist/components/docs/reference/DocsReferencePage.js +3 -265
- package/dist/components/docs/reference/docsMarkdownParser.js +2 -92
- package/dist/components/docs/reference/index.js +4 -470
- package/dist/components/docs/safety/SafetyAuditingPage.js +2 -350
- package/dist/components/docs/safety/SafetyMigrationsPage.js +2 -359
- package/dist/components/docs/safety/SafetyOverviewPage.js +1 -101
- package/dist/components/docs/safety/SafetyPDPPage.js +2 -301
- package/dist/components/docs/safety/SafetySecurityTrustPage.js +1 -206
- package/dist/components/docs/safety/SafetySigningPage.js +3 -90
- package/dist/components/docs/safety/SafetyTenantIsolationPage.js +2 -79
- package/dist/components/docs/safety/index.js +7 -1480
- package/dist/components/docs/shared/StudioPrompt.js +1 -31
- package/dist/components/docs/specs/SpecsBuilderControlPlanePage.d.ts +1 -0
- package/dist/components/docs/specs/SpecsBuilderControlPlanePage.js +34 -0
- package/dist/components/docs/specs/SpecsCapabilitiesPage.js +2 -158
- package/dist/components/docs/specs/SpecsConnectPage.d.ts +1 -0
- package/dist/components/docs/specs/SpecsConnectPage.js +8 -0
- package/dist/components/docs/specs/SpecsDataViewsPage.js +2 -260
- package/dist/components/docs/specs/SpecsModuleBundlesPage.d.ts +1 -0
- package/dist/components/docs/specs/SpecsModuleBundlesPage.js +67 -0
- package/dist/components/docs/specs/SpecsOverlaysPage.js +2 -372
- package/dist/components/docs/specs/SpecsOverviewPage.js +1 -186
- package/dist/components/docs/specs/SpecsPolicyPage.js +3 -420
- package/dist/components/docs/specs/SpecsWorkflowsPage.js +2 -325
- package/dist/components/docs/specs/index.d.ts +3 -0
- package/dist/components/docs/specs/index.js +109 -1715
- package/dist/components/docs/studio/StudioBYOKPage.js +1 -26
- package/dist/components/docs/studio/StudioDeploymentsPage.js +1 -26
- package/dist/components/docs/studio/StudioGettingStartedPage.js +1 -26
- package/dist/components/docs/studio/StudioIntegrationsPage.js +1 -26
- package/dist/components/docs/studio/StudioOverviewPage.js +1 -157
- package/dist/components/docs/studio/StudioVisualBuilderPage.js +1 -26
- package/dist/components/docs/studio/index.js +1 -282
- package/dist/components/docs/tech/contracts/tech-docs.docblocks.js +2 -19
- package/dist/components/integrations/index.js +2 -600
- package/dist/components/integrations/molecules/IntegrationCard.js +1 -100
- package/dist/components/integrations/organisms/IntegrationMarketplace.js +1 -214
- package/dist/components/integrations/organisms/IntegrationSettings.js +2 -284
- package/dist/components/integrations/organisms/KnowledgeSourceList.js +1 -103
- package/dist/components/legal/PrivacyTemplate.js +1 -1025
- package/dist/components/legal/TermsTemplate.js +1 -941
- package/dist/components/legal/index.js +1 -1963
- package/dist/components/shared/FeatureGateNotice.js +1 -38
- package/dist/components/shared/index.js +1 -38
- package/dist/components/shell/WorkspaceHeader.js +1 -100
- package/dist/components/shell/WorkspaceProjectShellLayout.js +1 -222
- package/dist/components/shell/WorkspaceShellRenderer.js +1 -228
- package/dist/components/shell/WorkspaceSidebar.js +1 -68
- package/dist/components/shell/index.js +1 -287
- package/dist/components/templates/engine/index.js +1 -39
- package/dist/components/templates/index.js +11 -965
- package/dist/components/templates/messaging/ConversationList.js +2 -83
- package/dist/components/templates/messaging/MessageComposer.js +4 -150
- package/dist/components/templates/messaging/MessageThread.js +3 -83
- package/dist/components/templates/messaging/MessagingWorkspace.js +5 -265
- package/dist/components/templates/messaging/index.js +5 -269
- package/dist/components/templates/recipes/LanguageSwitcher.js +1 -16
- package/dist/components/templates/recipes/RecipeCard.js +1 -80
- package/dist/components/templates/recipes/RecipeDetail.js +1 -74
- package/dist/components/templates/recipes/RecipeList.js +3 -245
- package/dist/components/templates/recipes/index.js +3 -248
- package/dist/components/templates/todos/FilterBar.js +1 -107
- package/dist/components/templates/todos/TaskForm.js +2 -158
- package/dist/components/templates/todos/TaskItem.js +1 -77
- package/dist/components/templates/todos/TaskList.js +5 -449
- package/dist/components/templates/todos/index.js +5 -452
- package/dist/config/contractspec-blueprint.js +1 -123
- package/dist/config/contractspec-branding.js +1 -44
- package/dist/config/contractspec-routes.js +1 -24
- package/dist/config/index.js +1 -126
- package/dist/features/contracts-registry.js +1 -178
- package/dist/features/docs/docs.contracts.js +1 -17
- package/dist/features/docs/index.js +1 -17
- package/dist/features/docs.feature.js +1 -33
- package/dist/features/index.js +1 -315
- package/dist/features/mcp.feature.js +1 -30
- package/dist/features/presentations.feature.js +1 -33
- package/dist/features/registry.js +1 -116
- package/dist/index.js +556 -28593
- package/dist/infrastructure/elysia/index.js +1 -35
- package/dist/infrastructure/elysia/logger.js +1 -35
- package/dist/infrastructure/index.js +1 -35
- package/dist/libs/email/client.js +1 -114
- package/dist/libs/email/contact.js +12 -165
- package/dist/libs/email/newsletter.js +6 -167
- package/dist/libs/email/types.js +0 -2
- package/dist/libs/email/utils.js +2 -8
- package/dist/libs/email/waitlist-application.js +28 -209
- package/dist/libs/email/waitlist.js +6 -167
- package/dist/libs/email.js +46 -363
- package/dist/libs/posthog/client.js +1 -63
- package/dist/libs/posthog/native.js +1 -23
- package/dist/libs/posthog/server.js +1 -13
- package/dist/libs/pricing-examples.js +1 -18
- package/dist/node/application/context-storage/index.js +1 -28
- package/dist/node/application/index.js +13 -2133
- package/dist/node/application/mcp/cliMcp.js +4 -452
- package/dist/node/application/mcp/common.js +1 -193
- package/dist/node/application/mcp/contractsMcp.js +2 -549
- package/dist/node/application/mcp/contractsMcpResources.js +2 -123
- package/dist/node/application/mcp/contractsMcpTools.js +1 -199
- package/dist/node/application/mcp/docsMcp.catalog.js +3 -381
- package/dist/node/application/mcp/docsMcp.data.js +1 -147
- package/dist/node/application/mcp/docsMcp.js +6 -1039
- package/dist/node/application/mcp/docsMcp.prompts.js +6 -521
- package/dist/node/application/mcp/docsMcp.reference.js +3 -235
- package/dist/node/application/mcp/docsMcp.resources.js +3 -519
- package/dist/node/application/mcp/docsMcp.tools.js +3 -518
- package/dist/node/application/mcp/index.js +13 -2106
- package/dist/node/application/mcp/internalMcp.js +2 -410
- package/dist/node/application/mcp/normalizeMcpRequest.js +1 -21
- package/dist/node/application/mcp/providerRankingMcp.js +1 -530
- package/dist/node/bundles/LibraryBundle.js +1 -138
- package/dist/node/bundles/index.js +1 -138
- package/dist/node/components/docs/DocsIndexPage.js +2 -912
- package/dist/node/components/docs/advanced/AdvancedMCPPage.js +4 -271
- package/dist/node/components/docs/advanced/AdvancedOverlayEditorPage.js +1 -107
- package/dist/node/components/docs/advanced/AdvancedRenderersPage.js +2 -118
- package/dist/node/components/docs/advanced/AdvancedSpecExperimentsPage.js +4 -92
- package/dist/node/components/docs/advanced/AdvancedTelemetryPage.js +2 -373
- package/dist/node/components/docs/advanced/AdvancedWorkflowMonitoringPage.js +2 -99
- package/dist/node/components/docs/advanced/index.js +10 -1055
- package/dist/node/components/docs/architecture/ArchitectureAppConfigPage.js +6 -243
- package/dist/node/components/docs/architecture/ArchitectureControlPlanePage.js +3 -160
- package/dist/node/components/docs/architecture/ArchitectureIntegrationBindingPage.js +7 -259
- package/dist/node/components/docs/architecture/ArchitectureKnowledgeBindingPage.js +6 -374
- package/dist/node/components/docs/architecture/ArchitectureMultiTenancyPage.js +2 -166
- package/dist/node/components/docs/architecture/ArchitectureOverviewPage.js +1 -143
- package/dist/node/components/docs/architecture/index.js +20 -1340
- package/dist/node/components/docs/comparison/ComparisonAutomationPlatformsPage.js +1 -245
- package/dist/node/components/docs/comparison/ComparisonEnterprisePlatformsPage.js +1 -230
- package/dist/node/components/docs/comparison/ComparisonInternalToolBuildersPage.js +1 -245
- package/dist/node/components/docs/comparison/ComparisonOverviewPage.js +1 -202
- package/dist/node/components/docs/comparison/ComparisonWindmillPage.js +1 -254
- package/dist/node/components/docs/comparison/ComparisonWorkflowEnginesPage.js +1 -339
- package/dist/node/components/docs/comparison/index.js +1 -1510
- package/dist/node/components/docs/docsManifest.js +1 -611
- package/dist/node/components/docs/ecosystem/IntegrationsPage.js +2 -103
- package/dist/node/components/docs/ecosystem/PluginsPage.js +13 -179
- package/dist/node/components/docs/ecosystem/RegistryPage.js +7 -100
- package/dist/node/components/docs/ecosystem/TemplatesPage.js +3 -141
- package/dist/node/components/docs/ecosystem/ecosystem.docblocks.js +2 -48
- package/dist/node/components/docs/ecosystem/index.js +23 -569
- package/dist/node/components/docs/examples/DocsExamplesPage.js +4 -124
- package/dist/node/components/docs/examples/ExampleShowcasePage.js +4 -244
- package/dist/node/components/docs/examples/exampleShowcaseData.js +4 -39
- package/dist/node/components/docs/examples/index.js +4 -330
- package/dist/node/components/docs/generated/docs-index.generated.js +1 -5
- package/dist/node/components/docs/generated/index.js +1 -74
- package/dist/node/components/docs/generated/loader.js +1 -74
- package/dist/node/components/docs/getting-started/CLIPage.js +4 -271
- package/dist/node/components/docs/getting-started/CompatibilityPage.js +1 -173
- package/dist/node/components/docs/getting-started/DataViewTutorialPage.js +4 -134
- package/dist/node/components/docs/getting-started/DeveloperToolsPage.js +1 -194
- package/dist/node/components/docs/getting-started/HelloWorldPage.js +5 -183
- package/dist/node/components/docs/getting-started/InstallationPage.js +3 -154
- package/dist/node/components/docs/getting-started/StartHerePage.js +2 -129
- package/dist/node/components/docs/getting-started/TroubleshootingPage.js +2 -168
- package/dist/node/components/docs/getting-started/VSCodeExtensionPage.js +1 -432
- package/dist/node/components/docs/getting-started/getting-started.docblocks.js +4 -41
- package/dist/node/components/docs/getting-started/index.js +18 -1869
- package/dist/node/components/docs/guides/GuideCIDiffGatingPage.js +2 -196
- package/dist/node/components/docs/guides/GuideConnectInRepoPage.js +43 -0
- package/dist/node/components/docs/guides/GuideContractTypesPage.js +6 -541
- package/dist/node/components/docs/guides/GuideDocsPipelinePage.js +3 -207
- package/dist/node/components/docs/guides/GuideFirstModuleBundlePage.js +75 -0
- package/dist/node/components/docs/guides/GuideGenerateDocsClientsSchemasPage.js +2 -209
- package/dist/node/components/docs/guides/GuideHostBuilderWorkbenchPage.js +69 -0
- package/dist/node/components/docs/guides/GuideImportExistingCodebasesPage.js +8 -754
- package/dist/node/components/docs/guides/GuideNextjsOneEndpointPage.js +6 -268
- package/dist/node/components/docs/guides/GuideSpecValidationTypingPage.js +4 -196
- package/dist/node/components/docs/guides/GuidesIndexPage.js +2 -169
- package/dist/node/components/docs/guides/guides.docblocks.js +11 -75
- package/dist/node/components/docs/guides/index.js +213 -2428
- package/dist/node/components/docs/index.js +542 -24310
- package/dist/node/components/docs/integrations/IntegrationsCircuitBreakersPage.js +2 -42
- package/dist/node/components/docs/integrations/IntegrationsElevenLabsPage.js +3 -105
- package/dist/node/components/docs/integrations/IntegrationsGithubPage.js +3 -142
- package/dist/node/components/docs/integrations/IntegrationsGmailPage.js +3 -109
- package/dist/node/components/docs/integrations/IntegrationsGoogleCalendarPage.js +3 -79
- package/dist/node/components/docs/integrations/IntegrationsHealthRoutingPage.js +3 -146
- package/dist/node/components/docs/integrations/IntegrationsMistralPage.js +5 -150
- package/dist/node/components/docs/integrations/IntegrationsOpenAIPage.js +5 -140
- package/dist/node/components/docs/integrations/IntegrationsOverviewPage.js +1 -160
- package/dist/node/components/docs/integrations/IntegrationsPostmarkPage.js +4 -218
- package/dist/node/components/docs/integrations/IntegrationsPowensPage.js +4 -300
- package/dist/node/components/docs/integrations/IntegrationsQdrantPage.js +5 -111
- package/dist/node/components/docs/integrations/IntegrationsResendPage.js +3 -102
- package/dist/node/components/docs/integrations/IntegrationsS3Page.js +4 -124
- package/dist/node/components/docs/integrations/IntegrationsSlackPage.js +3 -144
- package/dist/node/components/docs/integrations/IntegrationsSpecModelPage.js +7 -290
- package/dist/node/components/docs/integrations/IntegrationsStripePage.js +6 -327
- package/dist/node/components/docs/integrations/IntegrationsTwilioPage.js +3 -128
- package/dist/node/components/docs/integrations/IntegrationsWhatsappMetaPage.js +2 -146
- package/dist/node/components/docs/integrations/IntegrationsWhatsappTwilioPage.js +2 -156
- package/dist/node/components/docs/integrations/index.js +52 -3100
- package/dist/node/components/docs/intent/ContractFirstApiPage.js +2 -126
- package/dist/node/components/docs/intent/DeterministicCodegenPage.js +2 -148
- package/dist/node/components/docs/intent/GenerateClientFromSchemaPage.js +7 -207
- package/dist/node/components/docs/intent/OpenapiAlternativePage.js +3 -201
- package/dist/node/components/docs/intent/SchemaValidationTypescriptPage.js +4 -144
- package/dist/node/components/docs/intent/SpecDrivenDevelopmentPage.js +2 -126
- package/dist/node/components/docs/intent/index.js +15 -1135
- package/dist/node/components/docs/intent/intent-pages.docblocks.js +1 -201
- package/dist/node/components/docs/knowledge/KnowledgeCategoriesPage.js +6 -750
- package/dist/node/components/docs/knowledge/KnowledgeExamplesPage.js +4 -175
- package/dist/node/components/docs/knowledge/KnowledgeOverviewPage.js +1 -116
- package/dist/node/components/docs/knowledge/KnowledgeSourcesPage.js +8 -391
- package/dist/node/components/docs/knowledge/KnowledgeSpacesPage.js +6 -302
- package/dist/node/components/docs/knowledge/index.js +21 -1730
- package/dist/node/components/docs/libraries/LibrariesAccessibilityPage.js +3 -198
- package/dist/node/components/docs/libraries/LibrariesAiAgentPage.js +3 -141
- package/dist/node/components/docs/libraries/LibrariesAnalyticsPage.js +4 -80
- package/dist/node/components/docs/libraries/LibrariesContentGenPage.js +2 -100
- package/dist/node/components/docs/libraries/LibrariesContractsPage.js +2 -284
- package/dist/node/components/docs/libraries/LibrariesCostTrackingPage.js +3 -112
- package/dist/node/components/docs/libraries/LibrariesDataBackendPage.js +2 -166
- package/dist/node/components/docs/libraries/LibrariesDataViewsPage.js +3 -186
- package/dist/node/components/docs/libraries/LibrariesDesignSystemPage.js +4 -279
- package/dist/node/components/docs/libraries/LibrariesEvolutionPage.js +4 -127
- package/dist/node/components/docs/libraries/LibrariesGraphQLPage.js +2 -173
- package/dist/node/components/docs/libraries/LibrariesGrowthPage.js +3 -88
- package/dist/node/components/docs/libraries/LibrariesMultiTenancyPage.js +3 -108
- package/dist/node/components/docs/libraries/LibrariesObservabilityPage.js +5 -130
- package/dist/node/components/docs/libraries/LibrariesOverlayEnginePage.js +4 -110
- package/dist/node/components/docs/libraries/LibrariesOverviewPage.js +1 -170
- package/dist/node/components/docs/libraries/LibrariesPersonalizationPage.js +4 -114
- package/dist/node/components/docs/libraries/LibrariesProgressiveDeliveryPage.js +3 -132
- package/dist/node/components/docs/libraries/LibrariesResiliencePage.js +4 -120
- package/dist/node/components/docs/libraries/LibrariesRuntimePage.js +2 -200
- package/dist/node/components/docs/libraries/LibrariesSLOPage.js +3 -116
- package/dist/node/components/docs/libraries/LibrariesSchemaPage.js +3 -273
- package/dist/node/components/docs/libraries/LibrariesSupportBotPage.js +3 -134
- package/dist/node/components/docs/libraries/LibrariesTestingPage.js +3 -133
- package/dist/node/components/docs/libraries/LibrariesUIKitPage.js +2 -230
- package/dist/node/components/docs/libraries/LibrariesWorkflowComposerPage.js +3 -88
- package/dist/node/components/docs/libraries/LibrariesWorkflowsPage.js +2 -181
- package/dist/node/components/docs/libraries/index.js +54 -4147
- package/dist/node/components/docs/manifesto/ManifestoPage.js +1 -86
- package/dist/node/components/docs/ops/AutoEvolutionOpsPage.js +2 -132
- package/dist/node/components/docs/ops/DistributedTracingOpsPage.js +2 -71
- package/dist/node/components/docs/ops/index.js +3 -202
- package/dist/node/components/docs/ops/ops-lifecycle.docblocks.js +3 -38
- package/dist/node/components/docs/ops/ops-runbooks-a.docblocks.js +3 -94
- package/dist/node/components/docs/ops/ops-runbooks-b.docblocks.js +3 -76
- package/dist/node/components/docs/ops/ops-slo-tenant.docblocks.js +3 -76
- package/dist/node/components/docs/ops/ops-top.docs.js +2 -17
- package/dist/node/components/docs/ops/ops.docs.js +10 -302
- package/dist/node/components/docs/product/product.docblocks.js +5 -72
- package/dist/node/components/docs/reference/DocsMarkdownContent.js +2 -196
- package/dist/node/components/docs/reference/DocsReferenceContent.js +3 -256
- package/dist/node/components/docs/reference/DocsReferenceIndexClient.js +2 -127
- package/dist/node/components/docs/reference/DocsReferenceIndexPage.js +2 -206
- package/dist/node/components/docs/reference/DocsReferencePage.js +3 -265
- package/dist/node/components/docs/reference/docsMarkdownParser.js +2 -92
- package/dist/node/components/docs/reference/index.js +4 -470
- package/dist/node/components/docs/safety/SafetyAuditingPage.js +2 -350
- package/dist/node/components/docs/safety/SafetyMigrationsPage.js +2 -359
- package/dist/node/components/docs/safety/SafetyOverviewPage.js +1 -101
- package/dist/node/components/docs/safety/SafetyPDPPage.js +2 -301
- package/dist/node/components/docs/safety/SafetySecurityTrustPage.js +1 -206
- package/dist/node/components/docs/safety/SafetySigningPage.js +3 -90
- package/dist/node/components/docs/safety/SafetyTenantIsolationPage.js +2 -79
- package/dist/node/components/docs/safety/index.js +7 -1480
- package/dist/node/components/docs/shared/StudioPrompt.js +1 -31
- package/dist/node/components/docs/specs/SpecsBuilderControlPlanePage.js +33 -0
- package/dist/node/components/docs/specs/SpecsCapabilitiesPage.js +2 -158
- package/dist/node/components/docs/specs/SpecsConnectPage.js +7 -0
- package/dist/node/components/docs/specs/SpecsDataViewsPage.js +2 -260
- package/dist/node/components/docs/specs/SpecsModuleBundlesPage.js +66 -0
- package/dist/node/components/docs/specs/SpecsOverlaysPage.js +2 -372
- package/dist/node/components/docs/specs/SpecsOverviewPage.js +1 -186
- package/dist/node/components/docs/specs/SpecsPolicyPage.js +3 -420
- package/dist/node/components/docs/specs/SpecsWorkflowsPage.js +2 -325
- package/dist/node/components/docs/specs/index.js +109 -1715
- package/dist/node/components/docs/studio/StudioBYOKPage.js +1 -26
- package/dist/node/components/docs/studio/StudioDeploymentsPage.js +1 -26
- package/dist/node/components/docs/studio/StudioGettingStartedPage.js +1 -26
- package/dist/node/components/docs/studio/StudioIntegrationsPage.js +1 -26
- package/dist/node/components/docs/studio/StudioOverviewPage.js +1 -157
- package/dist/node/components/docs/studio/StudioVisualBuilderPage.js +1 -26
- package/dist/node/components/docs/studio/index.js +1 -282
- package/dist/node/components/docs/tech/contracts/tech-docs.docblocks.js +2 -19
- package/dist/node/components/integrations/index.js +2 -600
- package/dist/node/components/integrations/molecules/IntegrationCard.js +1 -100
- package/dist/node/components/integrations/organisms/IntegrationMarketplace.js +1 -214
- package/dist/node/components/integrations/organisms/IntegrationSettings.js +2 -284
- package/dist/node/components/integrations/organisms/KnowledgeSourceList.js +1 -103
- package/dist/node/components/legal/PrivacyTemplate.js +1 -1025
- package/dist/node/components/legal/TermsTemplate.js +1 -941
- package/dist/node/components/legal/index.js +1 -1963
- package/dist/node/components/shared/FeatureGateNotice.js +1 -38
- package/dist/node/components/shared/index.js +1 -38
- package/dist/node/components/shell/WorkspaceHeader.js +1 -100
- package/dist/node/components/shell/WorkspaceProjectShellLayout.js +1 -222
- package/dist/node/components/shell/WorkspaceShellRenderer.js +1 -228
- package/dist/node/components/shell/WorkspaceSidebar.js +1 -68
- package/dist/node/components/shell/index.js +1 -287
- package/dist/node/components/templates/engine/index.js +1 -39
- package/dist/node/components/templates/index.js +11 -965
- package/dist/node/components/templates/messaging/ConversationList.js +2 -83
- package/dist/node/components/templates/messaging/MessageComposer.js +4 -150
- package/dist/node/components/templates/messaging/MessageThread.js +3 -83
- package/dist/node/components/templates/messaging/MessagingWorkspace.js +5 -265
- package/dist/node/components/templates/messaging/index.js +5 -269
- package/dist/node/components/templates/recipes/LanguageSwitcher.js +1 -16
- package/dist/node/components/templates/recipes/RecipeCard.js +1 -80
- package/dist/node/components/templates/recipes/RecipeDetail.js +1 -74
- package/dist/node/components/templates/recipes/RecipeList.js +3 -245
- package/dist/node/components/templates/recipes/index.js +3 -248
- package/dist/node/components/templates/todos/FilterBar.js +1 -107
- package/dist/node/components/templates/todos/TaskForm.js +2 -158
- package/dist/node/components/templates/todos/TaskItem.js +1 -77
- package/dist/node/components/templates/todos/TaskList.js +5 -449
- package/dist/node/components/templates/todos/index.js +5 -452
- package/dist/node/config/contractspec-blueprint.js +1 -123
- package/dist/node/config/contractspec-branding.js +1 -44
- package/dist/node/config/contractspec-routes.js +1 -24
- package/dist/node/config/index.js +1 -126
- package/dist/node/features/contracts-registry.js +1 -178
- package/dist/node/features/docs/docs.contracts.js +1 -17
- package/dist/node/features/docs/index.js +1 -17
- package/dist/node/features/docs.feature.js +1 -33
- package/dist/node/features/index.js +1 -315
- package/dist/node/features/mcp.feature.js +1 -30
- package/dist/node/features/presentations.feature.js +1 -33
- package/dist/node/features/registry.js +1 -116
- package/dist/node/index.js +556 -28593
- package/dist/node/infrastructure/elysia/index.js +1 -35
- package/dist/node/infrastructure/elysia/logger.js +1 -35
- package/dist/node/infrastructure/index.js +1 -35
- package/dist/node/libs/email/client.js +1 -114
- package/dist/node/libs/email/contact.js +12 -165
- package/dist/node/libs/email/newsletter.js +6 -167
- package/dist/node/libs/email/types.js +0 -2
- package/dist/node/libs/email/utils.js +2 -8
- package/dist/node/libs/email/waitlist-application.js +28 -209
- package/dist/node/libs/email/waitlist.js +6 -167
- package/dist/node/libs/email.js +46 -363
- package/dist/node/libs/posthog/client.js +1 -63
- package/dist/node/libs/posthog/native.js +1 -23
- package/dist/node/libs/posthog/server.js +1 -13
- package/dist/node/libs/pricing-examples.js +1 -18
- package/dist/node/presentation/features/atoms/FeatureIcon/FeatureIcon.js +1 -97
- package/dist/node/presentation/features/atoms/FeatureIcon/index.js +1 -97
- package/dist/node/presentation/features/atoms/index.js +1 -97
- package/dist/node/presentation/features/hooks/index.js +1 -397
- package/dist/node/presentation/features/hooks/useContractsRegistry.js +1 -289
- package/dist/node/presentation/features/hooks/useFeatureFilters.js +1 -75
- package/dist/node/presentation/features/hooks/useFeatureRegistry.js +1 -147
- package/dist/node/presentation/features/hooks/useRelatedDocs.js +1 -28
- package/dist/node/presentation/features/index.js +1 -3063
- package/dist/node/presentation/features/molecules/FeatureCard/FeatureCard.js +1 -366
- package/dist/node/presentation/features/molecules/FeatureCard/index.js +1 -366
- package/dist/node/presentation/features/molecules/FeatureCategoryHeader/FeatureCategoryHeader.js +1 -50
- package/dist/node/presentation/features/molecules/FeatureCategoryHeader/index.js +1 -50
- package/dist/node/presentation/features/molecules/FeatureFilters/FeatureFilters.js +1 -92
- package/dist/node/presentation/features/molecules/FeatureFilters/index.js +1 -92
- package/dist/node/presentation/features/molecules/FeatureHoverPreview/FeatureHoverPreview.js +1 -176
- package/dist/node/presentation/features/molecules/FeatureHoverPreview/index.js +1 -176
- package/dist/node/presentation/features/molecules/index.js +1 -505
- package/dist/node/presentation/features/organisms/FeatureDataViewsList.js +1 -304
- package/dist/node/presentation/features/organisms/FeatureDetail/FeatureDetail.js +1 -154
- package/dist/node/presentation/features/organisms/FeatureDetail/index.js +1 -154
- package/dist/node/presentation/features/organisms/FeatureDiscovery/FeatureDiscovery.js +1 -909
- package/dist/node/presentation/features/organisms/FeatureDiscovery/index.js +1 -909
- package/dist/node/presentation/features/organisms/FeatureEventsList.js +1 -302
- package/dist/node/presentation/features/organisms/FeatureFormsList.js +1 -302
- package/dist/node/presentation/features/organisms/FeatureOperationsList.js +1 -180
- package/dist/node/presentation/features/organisms/FeaturePresentationsList.js +1 -304
- package/dist/node/presentation/features/organisms/index.js +1 -1359
- package/dist/node/presentation/features/templates/FeatureDataViewDetailTemplate/FeatureDataViewDetailTemplate.js +1 -332
- package/dist/node/presentation/features/templates/FeatureDataViewDetailTemplate/index.js +1 -332
- package/dist/node/presentation/features/templates/FeatureDataViewsTemplate/FeatureDataViewsTemplate.js +1 -342
- package/dist/node/presentation/features/templates/FeatureDataViewsTemplate/index.js +1 -342
- package/dist/node/presentation/features/templates/FeatureEventDetailTemplate/FeatureEventDetailTemplate.js +1 -303
- package/dist/node/presentation/features/templates/FeatureEventDetailTemplate/index.js +1 -303
- package/dist/node/presentation/features/templates/FeatureEventsTemplate/FeatureEventsTemplate.js +1 -340
- package/dist/node/presentation/features/templates/FeatureEventsTemplate/index.js +1 -340
- package/dist/node/presentation/features/templates/FeatureFormDetailTemplate/FeatureFormDetailTemplate.js +1 -329
- package/dist/node/presentation/features/templates/FeatureFormDetailTemplate/index.js +1 -329
- package/dist/node/presentation/features/templates/FeatureFormsTemplate/FeatureFormsTemplate.js +1 -340
- package/dist/node/presentation/features/templates/FeatureFormsTemplate/index.js +1 -340
- package/dist/node/presentation/features/templates/FeatureOperationDetailTemplate/FeatureOperationDetailTemplate.js +1 -302
- package/dist/node/presentation/features/templates/FeatureOperationDetailTemplate/index.js +1 -302
- package/dist/node/presentation/features/templates/FeatureOperationsTemplate/FeatureOperationsTemplate.js +1 -218
- package/dist/node/presentation/features/templates/FeatureOperationsTemplate/index.js +1 -218
- package/dist/node/presentation/features/templates/FeatureOverviewTemplate/FeatureOverviewTemplate.js +1 -187
- package/dist/node/presentation/features/templates/FeatureOverviewTemplate/index.js +1 -187
- package/dist/node/presentation/features/templates/FeaturePresentationDetailTemplate/FeaturePresentationDetailTemplate.js +1 -306
- package/dist/node/presentation/features/templates/FeaturePresentationDetailTemplate/index.js +1 -306
- package/dist/node/presentation/features/templates/FeaturePresentationsTemplate/FeaturePresentationsTemplate.js +1 -342
- package/dist/node/presentation/features/templates/FeaturePresentationsTemplate/index.js +1 -342
- package/dist/presentation/features/atoms/FeatureIcon/FeatureIcon.js +1 -97
- package/dist/presentation/features/atoms/FeatureIcon/index.js +1 -97
- package/dist/presentation/features/atoms/index.js +1 -97
- package/dist/presentation/features/hooks/index.js +1 -397
- package/dist/presentation/features/hooks/useContractsRegistry.js +1 -289
- package/dist/presentation/features/hooks/useFeatureFilters.js +1 -75
- package/dist/presentation/features/hooks/useFeatureRegistry.js +1 -147
- package/dist/presentation/features/hooks/useRelatedDocs.js +1 -28
- package/dist/presentation/features/index.js +1 -3063
- package/dist/presentation/features/molecules/FeatureCard/FeatureCard.js +1 -366
- package/dist/presentation/features/molecules/FeatureCard/index.js +1 -366
- package/dist/presentation/features/molecules/FeatureCategoryHeader/FeatureCategoryHeader.js +1 -50
- package/dist/presentation/features/molecules/FeatureCategoryHeader/index.js +1 -50
- package/dist/presentation/features/molecules/FeatureFilters/FeatureFilters.js +1 -92
- package/dist/presentation/features/molecules/FeatureFilters/index.js +1 -92
- package/dist/presentation/features/molecules/FeatureHoverPreview/FeatureHoverPreview.js +1 -176
- package/dist/presentation/features/molecules/FeatureHoverPreview/index.js +1 -176
- package/dist/presentation/features/molecules/index.js +1 -505
- package/dist/presentation/features/organisms/FeatureDataViewsList.js +1 -304
- package/dist/presentation/features/organisms/FeatureDetail/FeatureDetail.js +1 -154
- package/dist/presentation/features/organisms/FeatureDetail/index.js +1 -154
- package/dist/presentation/features/organisms/FeatureDiscovery/FeatureDiscovery.js +1 -909
- package/dist/presentation/features/organisms/FeatureDiscovery/index.js +1 -909
- package/dist/presentation/features/organisms/FeatureEventsList.js +1 -302
- package/dist/presentation/features/organisms/FeatureFormsList.js +1 -302
- package/dist/presentation/features/organisms/FeatureOperationsList.js +1 -180
- package/dist/presentation/features/organisms/FeaturePresentationsList.js +1 -304
- package/dist/presentation/features/organisms/index.js +1 -1359
- package/dist/presentation/features/templates/FeatureDataViewDetailTemplate/FeatureDataViewDetailTemplate.js +1 -332
- package/dist/presentation/features/templates/FeatureDataViewDetailTemplate/index.js +1 -332
- package/dist/presentation/features/templates/FeatureDataViewsTemplate/FeatureDataViewsTemplate.js +1 -342
- package/dist/presentation/features/templates/FeatureDataViewsTemplate/index.js +1 -342
- package/dist/presentation/features/templates/FeatureEventDetailTemplate/FeatureEventDetailTemplate.js +1 -303
- package/dist/presentation/features/templates/FeatureEventDetailTemplate/index.js +1 -303
- package/dist/presentation/features/templates/FeatureEventsTemplate/FeatureEventsTemplate.js +1 -340
- package/dist/presentation/features/templates/FeatureEventsTemplate/index.js +1 -340
- package/dist/presentation/features/templates/FeatureFormDetailTemplate/FeatureFormDetailTemplate.js +1 -329
- package/dist/presentation/features/templates/FeatureFormDetailTemplate/index.js +1 -329
- package/dist/presentation/features/templates/FeatureFormsTemplate/FeatureFormsTemplate.js +1 -340
- package/dist/presentation/features/templates/FeatureFormsTemplate/index.js +1 -340
- package/dist/presentation/features/templates/FeatureOperationDetailTemplate/FeatureOperationDetailTemplate.js +1 -302
- package/dist/presentation/features/templates/FeatureOperationDetailTemplate/index.js +1 -302
- package/dist/presentation/features/templates/FeatureOperationsTemplate/FeatureOperationsTemplate.js +1 -218
- package/dist/presentation/features/templates/FeatureOperationsTemplate/index.js +1 -218
- package/dist/presentation/features/templates/FeatureOverviewTemplate/FeatureOverviewTemplate.js +1 -187
- package/dist/presentation/features/templates/FeatureOverviewTemplate/index.js +1 -187
- package/dist/presentation/features/templates/FeaturePresentationDetailTemplate/FeaturePresentationDetailTemplate.js +1 -306
- package/dist/presentation/features/templates/FeaturePresentationDetailTemplate/index.js +1 -306
- package/dist/presentation/features/templates/FeaturePresentationsTemplate/FeaturePresentationsTemplate.js +1 -342
- package/dist/presentation/features/templates/FeaturePresentationsTemplate/index.js +1 -342
- package/package.json +103 -31
- package/src/components/docs/DocsIndexPage.tsx +55 -0
- package/src/components/docs/architecture/ArchitectureControlPlanePage.tsx +19 -0
- package/src/components/docs/architecture/ArchitectureOverviewPage.tsx +34 -0
- package/src/components/docs/docsManifest.test.ts +70 -0
- package/src/components/docs/docsManifest.ts +71 -1
- package/src/components/docs/ecosystem/PluginsPage.tsx +24 -10
- package/src/components/docs/ecosystem/RegistryPage.tsx +11 -6
- package/src/components/docs/generated/docs-index._common.json +206 -273
- package/src/components/docs/generated/docs-index.control-plane.json +18 -0
- package/src/components/docs/generated/docs-index.defineExample.json +10 -0
- package/src/components/docs/generated/docs-index.manifest.json +22 -12
- package/src/components/docs/generated/docs-index.platform-acp.json +64 -0
- package/src/components/docs/generated/docs-index.platform-agent.json +89 -1
- package/src/components/docs/generated/docs-index.platform-context.json +48 -0
- package/src/components/docs/generated/docs-index.platform-control-plane.json +72 -0
- package/src/components/docs/generated/docs-index.platform-database.json +40 -0
- package/src/components/docs/generated/docs-index.platform-docs.json +64 -0
- package/src/components/docs/generated/docs-index.platform-provider-ranking.json +89 -1
- package/src/components/docs/generated/docs-index.pocket-family-office.json +8 -0
- package/src/components/docs/generated/docs-index.unknown.json +8 -0
- package/src/components/docs/guides/GuideConnectInRepoPage.tsx +184 -0
- package/src/components/docs/guides/GuideFirstModuleBundlePage.tsx +182 -0
- package/src/components/docs/guides/GuideHostBuilderWorkbenchPage.tsx +230 -0
- package/src/components/docs/guides/GuidesIndexPage.tsx +21 -0
- package/src/components/docs/guides/index.ts +3 -0
- package/src/components/docs/specs/SpecsBuilderControlPlanePage.tsx +210 -0
- package/src/components/docs/specs/SpecsConnectPage.tsx +162 -0
- package/src/components/docs/specs/SpecsModuleBundlesPage.tsx +223 -0
- package/src/components/docs/specs/SpecsOverlaysPage.tsx +20 -0
- package/src/components/docs/specs/SpecsOverviewPage.tsx +44 -0
- package/src/components/docs/specs/index.ts +3 -0
- package/src/components/docs/studio/StudioOverviewPage.tsx +26 -0
- package/src/infrastructure/elysia/logger.ts +11 -3
|
@@ -1,116 +1,5 @@
|
|
|
1
1
|
// @bun
|
|
2
|
-
|
|
3
|
-
import Link from "@contractspec/lib.ui-link";
|
|
4
|
-
import { ChevronRight } from "lucide-react";
|
|
5
|
-
import { jsx, jsxs } from "react/jsx-runtime";
|
|
6
|
-
function AdvancedMCPPage() {
|
|
7
|
-
return /* @__PURE__ */ jsxs("div", {
|
|
8
|
-
className: "space-y-8",
|
|
9
|
-
children: [
|
|
10
|
-
/* @__PURE__ */ jsxs("div", {
|
|
11
|
-
className: "space-y-4",
|
|
12
|
-
children: [
|
|
13
|
-
/* @__PURE__ */ jsx("h1", {
|
|
14
|
-
className: "font-bold text-4xl",
|
|
15
|
-
children: "MCP Adapters"
|
|
16
|
-
}),
|
|
17
|
-
/* @__PURE__ */ jsxs("p", {
|
|
18
|
-
className: "text-muted-foreground",
|
|
19
|
-
children: [
|
|
20
|
-
"The ",
|
|
21
|
-
/* @__PURE__ */ jsx("strong", {
|
|
22
|
-
children: "Model Context Protocol (MCP)"
|
|
23
|
-
}),
|
|
24
|
-
" is an open standard for connecting AI models to external tools and data sources. ContractSpec provides MCP adapters that allow you to expose your capabilities as MCP tools and consume external MCP servers as capabilities."
|
|
25
|
-
]
|
|
26
|
-
})
|
|
27
|
-
]
|
|
28
|
-
}),
|
|
29
|
-
/* @__PURE__ */ jsxs("div", {
|
|
30
|
-
className: "space-y-4",
|
|
31
|
-
children: [
|
|
32
|
-
/* @__PURE__ */ jsx("h2", {
|
|
33
|
-
className: "font-bold text-2xl",
|
|
34
|
-
children: "Why MCP integration matters"
|
|
35
|
-
}),
|
|
36
|
-
/* @__PURE__ */ jsx("p", {
|
|
37
|
-
className: "text-muted-foreground",
|
|
38
|
-
children: "AI agents need access to real-world tools and data to be useful. MCP provides a standardized way to expose these capabilities. By integrating ContractSpec with MCP, you can:"
|
|
39
|
-
}),
|
|
40
|
-
/* @__PURE__ */ jsxs("ul", {
|
|
41
|
-
className: "list-inside list-disc space-y-2 text-muted-foreground",
|
|
42
|
-
children: [
|
|
43
|
-
/* @__PURE__ */ jsx("li", {
|
|
44
|
-
children: "Let AI agents invoke your ContractSpec capabilities safely and securely"
|
|
45
|
-
}),
|
|
46
|
-
/* @__PURE__ */ jsx("li", {
|
|
47
|
-
children: "Use external MCP servers (databases, APIs, search engines) as capability providers in your workflows"
|
|
48
|
-
}),
|
|
49
|
-
/* @__PURE__ */ jsx("li", {
|
|
50
|
-
children: "Build AI-powered features without writing custom integration code"
|
|
51
|
-
}),
|
|
52
|
-
/* @__PURE__ */ jsx("li", {
|
|
53
|
-
children: "Enforce policies on AI agent actions just like any other user"
|
|
54
|
-
})
|
|
55
|
-
]
|
|
56
|
-
})
|
|
57
|
-
]
|
|
58
|
-
}),
|
|
59
|
-
/* @__PURE__ */ jsxs("div", {
|
|
60
|
-
className: "space-y-4",
|
|
61
|
-
children: [
|
|
62
|
-
/* @__PURE__ */ jsx("h2", {
|
|
63
|
-
className: "font-bold text-2xl",
|
|
64
|
-
children: "Exposing capabilities as MCP tools"
|
|
65
|
-
}),
|
|
66
|
-
/* @__PURE__ */ jsxs("p", {
|
|
67
|
-
className: "text-muted-foreground",
|
|
68
|
-
children: [
|
|
69
|
-
"Any",
|
|
70
|
-
" ",
|
|
71
|
-
/* @__PURE__ */ jsx(Link, {
|
|
72
|
-
href: "/docs/specs/capabilities",
|
|
73
|
-
className: "text-violet-400 hover:text-violet-300",
|
|
74
|
-
children: "CapabilitySpec"
|
|
75
|
-
}),
|
|
76
|
-
" ",
|
|
77
|
-
"can be automatically exposed as an MCP tool. ContractSpec generates:"
|
|
78
|
-
]
|
|
79
|
-
}),
|
|
80
|
-
/* @__PURE__ */ jsxs("ul", {
|
|
81
|
-
className: "list-inside list-disc space-y-2 text-muted-foreground",
|
|
82
|
-
children: [
|
|
83
|
-
/* @__PURE__ */ jsx("li", {
|
|
84
|
-
children: "A tool schema describing the capability's inputs, outputs, and purpose"
|
|
85
|
-
}),
|
|
86
|
-
/* @__PURE__ */ jsx("li", {
|
|
87
|
-
children: "An MCP server endpoint that AI agents can connect to"
|
|
88
|
-
}),
|
|
89
|
-
/* @__PURE__ */ jsx("li", {
|
|
90
|
-
children: "Policy enforcement ensuring agents can only invoke capabilities they're authorized to use"
|
|
91
|
-
}),
|
|
92
|
-
/* @__PURE__ */ jsx("li", {
|
|
93
|
-
children: "Audit logging of all agent actions for compliance and debugging"
|
|
94
|
-
})
|
|
95
|
-
]
|
|
96
|
-
})
|
|
97
|
-
]
|
|
98
|
-
}),
|
|
99
|
-
/* @__PURE__ */ jsxs("div", {
|
|
100
|
-
className: "space-y-4",
|
|
101
|
-
children: [
|
|
102
|
-
/* @__PURE__ */ jsx("h2", {
|
|
103
|
-
className: "font-bold text-2xl",
|
|
104
|
-
children: "Example: Exposing a capability"
|
|
105
|
-
}),
|
|
106
|
-
/* @__PURE__ */ jsx("p", {
|
|
107
|
-
className: "text-muted-foreground",
|
|
108
|
-
children: "Here's how to expose ContractSpec operations as MCP tools:"
|
|
109
|
-
}),
|
|
110
|
-
/* @__PURE__ */ jsx("div", {
|
|
111
|
-
className: "overflow-x-auto rounded-lg border border-border bg-background/50 p-4 font-mono text-muted-foreground text-sm",
|
|
112
|
-
children: /* @__PURE__ */ jsx("pre", {
|
|
113
|
-
children: `import { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js';
|
|
2
|
+
import m from"@contractspec/lib.ui-link";import{ChevronRight as v}from"lucide-react";import{jsx as t,jsxs as r}from"react/jsx-runtime";function k(){return r("div",{className:"space-y-8",children:[r("div",{className:"space-y-4",children:[t("h1",{className:"font-bold text-4xl",children:"MCP Adapters"}),r("p",{className:"text-muted-foreground",children:["The ",t("strong",{children:"Model Context Protocol (MCP)"})," is an open standard for connecting AI models to external tools and data sources. ContractSpec provides MCP adapters that allow you to expose your capabilities as MCP tools and consume external MCP servers as capabilities."]})]}),r("div",{className:"space-y-4",children:[t("h2",{className:"font-bold text-2xl",children:"Why MCP integration matters"}),t("p",{className:"text-muted-foreground",children:"AI agents need access to real-world tools and data to be useful. MCP provides a standardized way to expose these capabilities. By integrating ContractSpec with MCP, you can:"}),r("ul",{className:"list-inside list-disc space-y-2 text-muted-foreground",children:[t("li",{children:"Let AI agents invoke your ContractSpec capabilities safely and securely"}),t("li",{children:"Use external MCP servers (databases, APIs, search engines) as capability providers in your workflows"}),t("li",{children:"Build AI-powered features without writing custom integration code"}),t("li",{children:"Enforce policies on AI agent actions just like any other user"})]})]}),r("div",{className:"space-y-4",children:[t("h2",{className:"font-bold text-2xl",children:"Exposing capabilities as MCP tools"}),r("p",{className:"text-muted-foreground",children:["Any"," ",t(m,{href:"/docs/specs/capabilities",className:"text-violet-400 hover:text-violet-300",children:"CapabilitySpec"})," ","can be automatically exposed as an MCP tool. ContractSpec generates:"]}),r("ul",{className:"list-inside list-disc space-y-2 text-muted-foreground",children:[t("li",{children:"A tool schema describing the capability's inputs, outputs, and purpose"}),t("li",{children:"An MCP server endpoint that AI agents can connect to"}),t("li",{children:"Policy enforcement ensuring agents can only invoke capabilities they're authorized to use"}),t("li",{children:"Audit logging of all agent actions for compliance and debugging"})]})]}),r("div",{className:"space-y-4",children:[t("h2",{className:"font-bold text-2xl",children:"Example: Exposing a capability"}),t("p",{className:"text-muted-foreground",children:"Here's how to expose ContractSpec operations as MCP tools:"}),t("div",{className:"overflow-x-auto rounded-lg border border-border bg-background/50 p-4 font-mono text-muted-foreground text-sm",children:t("pre",{children:`import { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js';
|
|
114
3
|
import { StdioServerTransport } from '@modelcontextprotocol/sdk/server/stdio.js';
|
|
115
4
|
import { createMcpServer } from '@contractspec/lib.contracts-runtime-server-mcp/provider-mcp';
|
|
116
5
|
import { registry, resources, prompts } from './lib/registry';
|
|
@@ -127,30 +16,7 @@ createMcpServer(server, registry, resources, prompts, {
|
|
|
127
16
|
});
|
|
128
17
|
|
|
129
18
|
const transport = new StdioServerTransport();
|
|
130
|
-
await server.connect(transport);`
|
|
131
|
-
})
|
|
132
|
-
}),
|
|
133
|
-
/* @__PURE__ */ jsx("p", {
|
|
134
|
-
className: "text-muted-foreground",
|
|
135
|
-
children: "AI agents can now discover and invoke your operations through the MCP protocol. ContractSpec handles authentication, authorization, and execution automatically via the `OperationSpecRegistry`."
|
|
136
|
-
})
|
|
137
|
-
]
|
|
138
|
-
}),
|
|
139
|
-
/* @__PURE__ */ jsxs("div", {
|
|
140
|
-
className: "space-y-4",
|
|
141
|
-
children: [
|
|
142
|
-
/* @__PURE__ */ jsx("h2", {
|
|
143
|
-
className: "font-bold text-2xl",
|
|
144
|
-
children: "Consuming external MCP servers"
|
|
145
|
-
}),
|
|
146
|
-
/* @__PURE__ */ jsx("p", {
|
|
147
|
-
className: "text-muted-foreground",
|
|
148
|
-
children: "You can integrate external MCP servers into your workflows. Define an integration spec and use it in your operations:"
|
|
149
|
-
}),
|
|
150
|
-
/* @__PURE__ */ jsx("div", {
|
|
151
|
-
className: "overflow-x-auto rounded-lg border border-border bg-background/50 p-4 font-mono text-muted-foreground text-sm",
|
|
152
|
-
children: /* @__PURE__ */ jsx("pre", {
|
|
153
|
-
children: `import { defineIntegration } from '@contractspec/lib.contracts-integrations';
|
|
19
|
+
await server.connect(transport);`})}),t("p",{className:"text-muted-foreground",children:"AI agents can now discover and invoke your operations through the MCP protocol. ContractSpec handles authentication, authorization, and execution automatically via the `OperationSpecRegistry`."})]}),r("div",{className:"space-y-4",children:[t("h2",{className:"font-bold text-2xl",children:"Consuming external MCP servers"}),t("p",{className:"text-muted-foreground",children:"You can integrate external MCP servers into your workflows. Define an integration spec and use it in your operations:"}),t("div",{className:"overflow-x-auto rounded-lg border border-border bg-background/50 p-4 font-mono text-muted-foreground text-sm",children:t("pre",{children:`import { defineIntegration } from '@contractspec/lib.contracts-integrations';
|
|
154
20
|
import { SchemaModel, ScalarTypeEnum } from '@contractspec/lib.schema';
|
|
155
21
|
|
|
156
22
|
const SearchProductsIntegration = defineIntegration({
|
|
@@ -179,35 +45,7 @@ const SearchProductsIntegration = defineIntegration({
|
|
|
179
45
|
},
|
|
180
46
|
}),
|
|
181
47
|
},
|
|
182
|
-
});`
|
|
183
|
-
})
|
|
184
|
-
})
|
|
185
|
-
]
|
|
186
|
-
}),
|
|
187
|
-
/* @__PURE__ */ jsxs("div", {
|
|
188
|
-
className: "space-y-4",
|
|
189
|
-
children: [
|
|
190
|
-
/* @__PURE__ */ jsx("h2", {
|
|
191
|
-
className: "font-bold text-2xl",
|
|
192
|
-
children: "Policy enforcement for AI agents"
|
|
193
|
-
}),
|
|
194
|
-
/* @__PURE__ */ jsxs("p", {
|
|
195
|
-
className: "text-muted-foreground",
|
|
196
|
-
children: [
|
|
197
|
-
"AI agents are treated like any other actor in ContractSpec. They must authenticate, and all their actions are subject to",
|
|
198
|
-
" ",
|
|
199
|
-
/* @__PURE__ */ jsx(Link, {
|
|
200
|
-
href: "/docs/specs/policy",
|
|
201
|
-
className: "text-violet-400 hover:text-violet-300",
|
|
202
|
-
children: "PolicySpecs"
|
|
203
|
-
}),
|
|
204
|
-
". You can define specific policies in TypeScript:"
|
|
205
|
-
]
|
|
206
|
-
}),
|
|
207
|
-
/* @__PURE__ */ jsx("div", {
|
|
208
|
-
className: "overflow-x-auto rounded-lg border border-border bg-background/50 p-4 font-mono text-muted-foreground text-sm",
|
|
209
|
-
children: /* @__PURE__ */ jsx("pre", {
|
|
210
|
-
children: `import { definePolicy } from '@contractspec/lib.contracts-spec';
|
|
48
|
+
});`})})]}),r("div",{className:"space-y-4",children:[t("h2",{className:"font-bold text-2xl",children:"Policy enforcement for AI agents"}),r("p",{className:"text-muted-foreground",children:["AI agents are treated like any other actor in ContractSpec. They must authenticate, and all their actions are subject to"," ",t(m,{href:"/docs/specs/policy",className:"text-violet-400 hover:text-violet-300",children:"PolicySpecs"}),". You can define specific policies in TypeScript:"]}),t("div",{className:"overflow-x-auto rounded-lg border border-border bg-background/50 p-4 font-mono text-muted-foreground text-sm",children:t("pre",{children:`import { definePolicy } from '@contractspec/lib.contracts-spec';
|
|
211
49
|
|
|
212
50
|
export const AIAgentRestrictions = definePolicy({
|
|
213
51
|
meta: {
|
|
@@ -230,273 +68,7 @@ export const AIAgentRestrictions = definePolicy({
|
|
|
230
68
|
!ctx.approvalGranted,
|
|
231
69
|
},
|
|
232
70
|
],
|
|
233
|
-
});`
|
|
234
|
-
})
|
|
235
|
-
})
|
|
236
|
-
]
|
|
237
|
-
}),
|
|
238
|
-
/* @__PURE__ */ jsxs("div", {
|
|
239
|
-
className: "space-y-4",
|
|
240
|
-
children: [
|
|
241
|
-
/* @__PURE__ */ jsx("h2", {
|
|
242
|
-
className: "font-bold text-2xl",
|
|
243
|
-
children: "Human-in-the-loop workflows"
|
|
244
|
-
}),
|
|
245
|
-
/* @__PURE__ */ jsx("p", {
|
|
246
|
-
className: "text-muted-foreground",
|
|
247
|
-
children: "For sensitive operations, you can require human approval before an AI agent can proceed. ContractSpec provides built-in approval workflows:"
|
|
248
|
-
}),
|
|
249
|
-
/* @__PURE__ */ jsxs("ul", {
|
|
250
|
-
className: "list-inside list-disc space-y-2 text-muted-foreground",
|
|
251
|
-
children: [
|
|
252
|
-
/* @__PURE__ */ jsx("li", {
|
|
253
|
-
children: "Agent requests permission to invoke a capability"
|
|
254
|
-
}),
|
|
255
|
-
/* @__PURE__ */ jsx("li", {
|
|
256
|
-
children: "Request is sent to designated approvers (via email, Slack, etc.)"
|
|
257
|
-
}),
|
|
258
|
-
/* @__PURE__ */ jsx("li", {
|
|
259
|
-
children: "Approver reviews the request and approves or denies it"
|
|
260
|
-
}),
|
|
261
|
-
/* @__PURE__ */ jsx("li", {
|
|
262
|
-
children: "Agent receives the decision and can proceed if approved"
|
|
263
|
-
})
|
|
264
|
-
]
|
|
265
|
-
}),
|
|
266
|
-
/* @__PURE__ */ jsxs("p", {
|
|
267
|
-
className: "text-muted-foreground",
|
|
268
|
-
children: [
|
|
269
|
-
"All approval decisions are logged in the",
|
|
270
|
-
" ",
|
|
271
|
-
/* @__PURE__ */ jsx(Link, {
|
|
272
|
-
href: "/docs/safety/auditing",
|
|
273
|
-
className: "text-violet-400 hover:text-violet-300",
|
|
274
|
-
children: "audit log"
|
|
275
|
-
}),
|
|
276
|
-
"."
|
|
277
|
-
]
|
|
278
|
-
})
|
|
279
|
-
]
|
|
280
|
-
}),
|
|
281
|
-
/* @__PURE__ */ jsxs("div", {
|
|
282
|
-
className: "space-y-4",
|
|
283
|
-
children: [
|
|
284
|
-
/* @__PURE__ */ jsx("h2", {
|
|
285
|
-
className: "font-bold text-2xl",
|
|
286
|
-
children: "Best practices"
|
|
287
|
-
}),
|
|
288
|
-
/* @__PURE__ */ jsxs("ul", {
|
|
289
|
-
className: "list-inside list-disc space-y-2 text-muted-foreground",
|
|
290
|
-
children: [
|
|
291
|
-
/* @__PURE__ */ jsx("li", {
|
|
292
|
-
children: "Start with read-only capabilities for AI agents\u2014only grant write access when necessary."
|
|
293
|
-
}),
|
|
294
|
-
/* @__PURE__ */ jsx("li", {
|
|
295
|
-
children: "Use human-in-the-loop approval for any capability that modifies critical data or triggers financial transactions."
|
|
296
|
-
}),
|
|
297
|
-
/* @__PURE__ */ jsx("li", {
|
|
298
|
-
children: "Set rate limits to prevent runaway agents from overwhelming your system."
|
|
299
|
-
}),
|
|
300
|
-
/* @__PURE__ */ jsx("li", {
|
|
301
|
-
children: "Provide clear, detailed descriptions for each capability so agents know when to use them."
|
|
302
|
-
}),
|
|
303
|
-
/* @__PURE__ */ jsx("li", {
|
|
304
|
-
children: "Monitor agent actions closely in production and adjust policies as needed."
|
|
305
|
-
}),
|
|
306
|
-
/* @__PURE__ */ jsx("li", {
|
|
307
|
-
children: "Test agent integrations thoroughly with realistic scenarios before deploying."
|
|
308
|
-
})
|
|
309
|
-
]
|
|
310
|
-
})
|
|
311
|
-
]
|
|
312
|
-
}),
|
|
313
|
-
/* @__PURE__ */ jsxs("div", {
|
|
314
|
-
className: "flex items-center gap-4 pt-4",
|
|
315
|
-
children: [
|
|
316
|
-
/* @__PURE__ */ jsx(Link, {
|
|
317
|
-
href: "/docs/advanced/renderers",
|
|
318
|
-
className: "btn-ghost",
|
|
319
|
-
children: "Previous: Custom Renderers"
|
|
320
|
-
}),
|
|
321
|
-
/* @__PURE__ */ jsxs(Link, {
|
|
322
|
-
href: "/docs/advanced/telemetry",
|
|
323
|
-
className: "btn-primary",
|
|
324
|
-
children: [
|
|
325
|
-
"Next: Telemetry ",
|
|
326
|
-
/* @__PURE__ */ jsx(ChevronRight, {
|
|
327
|
-
size: 16
|
|
328
|
-
})
|
|
329
|
-
]
|
|
330
|
-
})
|
|
331
|
-
]
|
|
332
|
-
})
|
|
333
|
-
]
|
|
334
|
-
});
|
|
335
|
-
}
|
|
336
|
-
|
|
337
|
-
// src/components/docs/advanced/AdvancedOverlayEditorPage.tsx
|
|
338
|
-
import Link2 from "@contractspec/lib.ui-link";
|
|
339
|
-
import { jsx as jsx2, jsxs as jsxs2 } from "react/jsx-runtime";
|
|
340
|
-
function AdvancedOverlayEditorPage() {
|
|
341
|
-
return /* @__PURE__ */ jsxs2("div", {
|
|
342
|
-
className: "space-y-8",
|
|
343
|
-
children: [
|
|
344
|
-
/* @__PURE__ */ jsxs2("div", {
|
|
345
|
-
className: "space-y-4",
|
|
346
|
-
children: [
|
|
347
|
-
/* @__PURE__ */ jsx2("h1", {
|
|
348
|
-
className: "font-bold text-4xl",
|
|
349
|
-
children: "Overlay Editor"
|
|
350
|
-
}),
|
|
351
|
-
/* @__PURE__ */ jsx2("p", {
|
|
352
|
-
className: "text-lg text-muted-foreground",
|
|
353
|
-
children: "A Next.js app (`@contractspec/app.overlay-editor`) that lets tenant admins tweak field visibility, labels, and ordering, then sign OverlaySpecs."
|
|
354
|
-
})
|
|
355
|
-
]
|
|
356
|
-
}),
|
|
357
|
-
/* @__PURE__ */ jsxs2("div", {
|
|
358
|
-
className: "space-y-4",
|
|
359
|
-
children: [
|
|
360
|
-
/* @__PURE__ */ jsx2("h2", {
|
|
361
|
-
className: "font-bold text-2xl",
|
|
362
|
-
children: "Features"
|
|
363
|
-
}),
|
|
364
|
-
/* @__PURE__ */ jsxs2("ul", {
|
|
365
|
-
className: "list-disc space-y-2 pl-6",
|
|
366
|
-
children: [
|
|
367
|
-
/* @__PURE__ */ jsx2("li", {
|
|
368
|
-
children: "Toggle visibility and rename labels without touching code."
|
|
369
|
-
}),
|
|
370
|
-
/* @__PURE__ */ jsx2("li", {
|
|
371
|
-
children: "Move fields up/down to define the overlay order."
|
|
372
|
-
}),
|
|
373
|
-
/* @__PURE__ */ jsx2("li", {
|
|
374
|
-
children: "Preview JSON output powered by `@contractspec/lib.overlay-engine`."
|
|
375
|
-
}),
|
|
376
|
-
/* @__PURE__ */ jsx2("li", {
|
|
377
|
-
children: "Server action for PEM signing (Ed25519/RSA-PSS)."
|
|
378
|
-
})
|
|
379
|
-
]
|
|
380
|
-
}),
|
|
381
|
-
/* @__PURE__ */ jsxs2("p", {
|
|
382
|
-
children: [
|
|
383
|
-
"Project path: ",
|
|
384
|
-
/* @__PURE__ */ jsx2("code", {
|
|
385
|
-
children: "packages/apps/overlay-editor"
|
|
386
|
-
})
|
|
387
|
-
]
|
|
388
|
-
})
|
|
389
|
-
]
|
|
390
|
-
}),
|
|
391
|
-
/* @__PURE__ */ jsxs2("div", {
|
|
392
|
-
className: "space-y-4",
|
|
393
|
-
children: [
|
|
394
|
-
/* @__PURE__ */ jsx2("h2", {
|
|
395
|
-
className: "font-bold text-2xl",
|
|
396
|
-
children: "Provisioning flow"
|
|
397
|
-
}),
|
|
398
|
-
/* @__PURE__ */ jsxs2("ol", {
|
|
399
|
-
className: "list-decimal space-y-2 pl-6",
|
|
400
|
-
children: [
|
|
401
|
-
/* @__PURE__ */ jsxs2("li", {
|
|
402
|
-
children: [
|
|
403
|
-
"Clone the repo and run ",
|
|
404
|
-
/* @__PURE__ */ jsx2("code", {
|
|
405
|
-
children: "bun dev"
|
|
406
|
-
}),
|
|
407
|
-
" inside the app."
|
|
408
|
-
]
|
|
409
|
-
}),
|
|
410
|
-
/* @__PURE__ */ jsx2("li", {
|
|
411
|
-
children: "Use the UI to craft the overlay for a tenant."
|
|
412
|
-
}),
|
|
413
|
-
/* @__PURE__ */ jsx2("li", {
|
|
414
|
-
children: "Paste the tenant's PEM private key (stored in Vault/KMS)."
|
|
415
|
-
}),
|
|
416
|
-
/* @__PURE__ */ jsx2("li", {
|
|
417
|
-
children: "Click \u201CSign overlay\u201D to get the final JSON payload."
|
|
418
|
-
}),
|
|
419
|
-
/* @__PURE__ */ jsx2("li", {
|
|
420
|
-
children: "Persist in the `Overlay` table and register with `OverlayRegistry`."
|
|
421
|
-
})
|
|
422
|
-
]
|
|
423
|
-
}),
|
|
424
|
-
/* @__PURE__ */ jsxs2("p", {
|
|
425
|
-
children: [
|
|
426
|
-
"See also:",
|
|
427
|
-
" ",
|
|
428
|
-
/* @__PURE__ */ jsx2(Link2, {
|
|
429
|
-
href: "/docs/ops/tenant-customization",
|
|
430
|
-
className: "text-violet-400 underline",
|
|
431
|
-
children: "Tenant customization runbook"
|
|
432
|
-
}),
|
|
433
|
-
"."
|
|
434
|
-
]
|
|
435
|
-
})
|
|
436
|
-
]
|
|
437
|
-
})
|
|
438
|
-
]
|
|
439
|
-
});
|
|
440
|
-
}
|
|
441
|
-
|
|
442
|
-
// src/components/docs/advanced/AdvancedRenderersPage.tsx
|
|
443
|
-
import Link3 from "@contractspec/lib.ui-link";
|
|
444
|
-
import { ChevronRight as ChevronRight2 } from "lucide-react";
|
|
445
|
-
import { jsx as jsx3, jsxs as jsxs3 } from "react/jsx-runtime";
|
|
446
|
-
function AdvancedRenderersPage() {
|
|
447
|
-
return /* @__PURE__ */ jsxs3("div", {
|
|
448
|
-
className: "space-y-8",
|
|
449
|
-
children: [
|
|
450
|
-
/* @__PURE__ */ jsxs3("div", {
|
|
451
|
-
className: "space-y-2",
|
|
452
|
-
children: [
|
|
453
|
-
/* @__PURE__ */ jsx3("h1", {
|
|
454
|
-
className: "font-bold text-4xl",
|
|
455
|
-
children: "Custom Renderers"
|
|
456
|
-
}),
|
|
457
|
-
/* @__PURE__ */ jsx3("p", {
|
|
458
|
-
className: "text-lg text-muted-foreground",
|
|
459
|
-
children: "ContractSpec ships with React and React Native renderers. You can build custom renderers for any framework."
|
|
460
|
-
})
|
|
461
|
-
]
|
|
462
|
-
}),
|
|
463
|
-
/* @__PURE__ */ jsxs3("div", {
|
|
464
|
-
className: "space-y-6",
|
|
465
|
-
children: [
|
|
466
|
-
/* @__PURE__ */ jsxs3("div", {
|
|
467
|
-
className: "space-y-3",
|
|
468
|
-
children: [
|
|
469
|
-
/* @__PURE__ */ jsx3("h2", {
|
|
470
|
-
className: "font-bold text-2xl",
|
|
471
|
-
children: "Overview"
|
|
472
|
-
}),
|
|
473
|
-
/* @__PURE__ */ jsxs3("p", {
|
|
474
|
-
className: "text-muted-foreground",
|
|
475
|
-
children: [
|
|
476
|
-
"The presentation runtime libraries (",
|
|
477
|
-
/* @__PURE__ */ jsx3("code", {
|
|
478
|
-
children: "@contractspec/lib.presentation-runtime-react"
|
|
479
|
-
}),
|
|
480
|
-
" and",
|
|
481
|
-
/* @__PURE__ */ jsx3("code", {
|
|
482
|
-
children: "@contractspec/lib.presentation-runtime-react-native"
|
|
483
|
-
}),
|
|
484
|
-
") provide hooks and components to render ContractSpec-defined UI like workflows and data views. You can extend these or create custom implementations for other frameworks."
|
|
485
|
-
]
|
|
486
|
-
})
|
|
487
|
-
]
|
|
488
|
-
}),
|
|
489
|
-
/* @__PURE__ */ jsxs3("div", {
|
|
490
|
-
className: "space-y-3",
|
|
491
|
-
children: [
|
|
492
|
-
/* @__PURE__ */ jsx3("h2", {
|
|
493
|
-
className: "font-bold text-2xl",
|
|
494
|
-
children: "Using the React Renderer"
|
|
495
|
-
}),
|
|
496
|
-
/* @__PURE__ */ jsx3("div", {
|
|
497
|
-
className: "overflow-x-auto rounded-lg border border-border bg-background/50 p-4 font-mono text-muted-foreground text-sm",
|
|
498
|
-
children: /* @__PURE__ */ jsx3("pre", {
|
|
499
|
-
children: `import { useWorkflow, WorkflowStepRenderer } from '@contractspec/lib.presentation-runtime-react';
|
|
71
|
+
});`})})]}),r("div",{className:"space-y-4",children:[t("h2",{className:"font-bold text-2xl",children:"Human-in-the-loop workflows"}),t("p",{className:"text-muted-foreground",children:"For sensitive operations, you can require human approval before an AI agent can proceed. ContractSpec provides built-in approval workflows:"}),r("ul",{className:"list-inside list-disc space-y-2 text-muted-foreground",children:[t("li",{children:"Agent requests permission to invoke a capability"}),t("li",{children:"Request is sent to designated approvers (via email, Slack, etc.)"}),t("li",{children:"Approver reviews the request and approves or denies it"}),t("li",{children:"Agent receives the decision and can proceed if approved"})]}),r("p",{className:"text-muted-foreground",children:["All approval decisions are logged in the"," ",t(m,{href:"/docs/safety/auditing",className:"text-violet-400 hover:text-violet-300",children:"audit log"}),"."]})]}),r("div",{className:"space-y-4",children:[t("h2",{className:"font-bold text-2xl",children:"Best practices"}),r("ul",{className:"list-inside list-disc space-y-2 text-muted-foreground",children:[t("li",{children:"Start with read-only capabilities for AI agents\u2014only grant write access when necessary."}),t("li",{children:"Use human-in-the-loop approval for any capability that modifies critical data or triggers financial transactions."}),t("li",{children:"Set rate limits to prevent runaway agents from overwhelming your system."}),t("li",{children:"Provide clear, detailed descriptions for each capability so agents know when to use them."}),t("li",{children:"Monitor agent actions closely in production and adjust policies as needed."}),t("li",{children:"Test agent integrations thoroughly with realistic scenarios before deploying."})]})]}),r("div",{className:"flex items-center gap-4 pt-4",children:[t(m,{href:"/docs/advanced/renderers",className:"btn-ghost",children:"Previous: Custom Renderers"}),r(m,{href:"/docs/advanced/telemetry",className:"btn-primary",children:["Next: Telemetry ",t(v,{size:16})]})]})]})}import f from"@contractspec/lib.ui-link";import{jsx as a,jsxs as c}from"react/jsx-runtime";function A(){return c("div",{className:"space-y-8",children:[c("div",{className:"space-y-4",children:[a("h1",{className:"font-bold text-4xl",children:"Overlay Editor"}),a("p",{className:"text-lg text-muted-foreground",children:"A Next.js app (`@contractspec/app.overlay-editor`) that lets tenant admins tweak field visibility, labels, and ordering, then sign OverlaySpecs."})]}),c("div",{className:"space-y-4",children:[a("h2",{className:"font-bold text-2xl",children:"Features"}),c("ul",{className:"list-disc space-y-2 pl-6",children:[a("li",{children:"Toggle visibility and rename labels without touching code."}),a("li",{children:"Move fields up/down to define the overlay order."}),a("li",{children:"Preview JSON output powered by `@contractspec/lib.overlay-engine`."}),a("li",{children:"Server action for PEM signing (Ed25519/RSA-PSS)."})]}),c("p",{children:["Project path: ",a("code",{children:"packages/apps/overlay-editor"})]})]}),c("div",{className:"space-y-4",children:[a("h2",{className:"font-bold text-2xl",children:"Provisioning flow"}),c("ol",{className:"list-decimal space-y-2 pl-6",children:[c("li",{children:["Clone the repo and run ",a("code",{children:"bun dev"})," inside the app."]}),a("li",{children:"Use the UI to craft the overlay for a tenant."}),a("li",{children:"Paste the tenant's PEM private key (stored in Vault/KMS)."}),a("li",{children:"Click \u201CSign overlay\u201D to get the final JSON payload."}),a("li",{children:"Persist in the `Overlay` table and register with `OverlayRegistry`."})]}),c("p",{children:["See also:"," ",a(f,{href:"/docs/ops/tenant-customization",className:"text-violet-400 underline",children:"Tenant customization runbook"}),"."]})]})]})}import h from"@contractspec/lib.ui-link";import{ChevronRight as y}from"lucide-react";import{jsx as i,jsxs as s}from"react/jsx-runtime";function E(){return s("div",{className:"space-y-8",children:[s("div",{className:"space-y-2",children:[i("h1",{className:"font-bold text-4xl",children:"Custom Renderers"}),i("p",{className:"text-lg text-muted-foreground",children:"ContractSpec ships with React and React Native renderers. You can build custom renderers for any framework."})]}),s("div",{className:"space-y-6",children:[s("div",{className:"space-y-3",children:[i("h2",{className:"font-bold text-2xl",children:"Overview"}),s("p",{className:"text-muted-foreground",children:["The presentation runtime libraries (",i("code",{children:"@contractspec/lib.presentation-runtime-react"})," and",i("code",{children:"@contractspec/lib.presentation-runtime-react-native"}),") provide hooks and components to render ContractSpec-defined UI like workflows and data views. You can extend these or create custom implementations for other frameworks."]})]}),s("div",{className:"space-y-3",children:[i("h2",{className:"font-bold text-2xl",children:"Using the React Renderer"}),i("div",{className:"overflow-x-auto rounded-lg border border-border bg-background/50 p-4 font-mono text-muted-foreground text-sm",children:i("pre",{children:`import { useWorkflow, WorkflowStepRenderer } from '@contractspec/lib.presentation-runtime-react';
|
|
500
72
|
import { MyWorkflowSpec } from './specs';
|
|
501
73
|
|
|
502
74
|
export function WorkflowPage() {
|
|
@@ -511,93 +83,7 @@ export function WorkflowPage() {
|
|
|
511
83
|
</button>
|
|
512
84
|
</div>
|
|
513
85
|
);
|
|
514
|
-
}`
|
|
515
|
-
})
|
|
516
|
-
})
|
|
517
|
-
]
|
|
518
|
-
}),
|
|
519
|
-
/* @__PURE__ */ jsxs3("div", {
|
|
520
|
-
className: "space-y-3",
|
|
521
|
-
children: [
|
|
522
|
-
/* @__PURE__ */ jsx3("h2", {
|
|
523
|
-
className: "font-bold text-2xl",
|
|
524
|
-
children: "Custom Platform Support"
|
|
525
|
-
}),
|
|
526
|
-
/* @__PURE__ */ jsx3("p", {
|
|
527
|
-
className: "text-muted-foreground",
|
|
528
|
-
children: "To support a new platform (e.g., Vue, Svelte), you would:"
|
|
529
|
-
}),
|
|
530
|
-
/* @__PURE__ */ jsxs3("ol", {
|
|
531
|
-
className: "list-inside list-decimal space-y-2 text-muted-foreground",
|
|
532
|
-
children: [
|
|
533
|
-
/* @__PURE__ */ jsxs3("li", {
|
|
534
|
-
children: [
|
|
535
|
-
"Implement the core workflow state machine (from",
|
|
536
|
-
" ",
|
|
537
|
-
/* @__PURE__ */ jsx3("code", {
|
|
538
|
-
children: "@contractspec/lib.presentation-runtime-core"
|
|
539
|
-
}),
|
|
540
|
-
")"
|
|
541
|
-
]
|
|
542
|
-
}),
|
|
543
|
-
/* @__PURE__ */ jsx3("li", {
|
|
544
|
-
children: "Create framework-specific hooks/components for step rendering"
|
|
545
|
-
}),
|
|
546
|
-
/* @__PURE__ */ jsx3("li", {
|
|
547
|
-
children: "Handle validation and submission via the ContractSpec I/O schemas"
|
|
548
|
-
})
|
|
549
|
-
]
|
|
550
|
-
})
|
|
551
|
-
]
|
|
552
|
-
}),
|
|
553
|
-
/* @__PURE__ */ jsx3("div", {
|
|
554
|
-
className: "flex items-center gap-4 pt-4",
|
|
555
|
-
children: /* @__PURE__ */ jsxs3(Link3, {
|
|
556
|
-
href: "/docs",
|
|
557
|
-
className: "btn-primary",
|
|
558
|
-
children: [
|
|
559
|
-
"Back to docs ",
|
|
560
|
-
/* @__PURE__ */ jsx3(ChevronRight2, {
|
|
561
|
-
size: 16
|
|
562
|
-
})
|
|
563
|
-
]
|
|
564
|
-
})
|
|
565
|
-
})
|
|
566
|
-
]
|
|
567
|
-
})
|
|
568
|
-
]
|
|
569
|
-
});
|
|
570
|
-
}
|
|
571
|
-
|
|
572
|
-
// src/components/docs/advanced/AdvancedSpecExperimentsPage.tsx
|
|
573
|
-
import { jsx as jsx4, jsxs as jsxs4 } from "react/jsx-runtime";
|
|
574
|
-
function AdvancedSpecExperimentsPage() {
|
|
575
|
-
return /* @__PURE__ */ jsxs4("div", {
|
|
576
|
-
className: "space-y-8",
|
|
577
|
-
children: [
|
|
578
|
-
/* @__PURE__ */ jsxs4("div", {
|
|
579
|
-
className: "space-y-4",
|
|
580
|
-
children: [
|
|
581
|
-
/* @__PURE__ */ jsx4("h1", {
|
|
582
|
-
className: "font-bold text-4xl",
|
|
583
|
-
children: "Spec Experiments"
|
|
584
|
-
}),
|
|
585
|
-
/* @__PURE__ */ jsx4("p", {
|
|
586
|
-
className: "text-lg text-muted-foreground",
|
|
587
|
-
children: "Run controlled experiments on ContractSpec operations, gradually shift traffic, and roll back automatically when guardrails trip."
|
|
588
|
-
})
|
|
589
|
-
]
|
|
590
|
-
}),
|
|
591
|
-
/* @__PURE__ */ jsxs4("div", {
|
|
592
|
-
className: "space-y-3",
|
|
593
|
-
children: [
|
|
594
|
-
/* @__PURE__ */ jsx4("h2", {
|
|
595
|
-
className: "font-bold text-2xl",
|
|
596
|
-
children: "Define control + variants"
|
|
597
|
-
}),
|
|
598
|
-
/* @__PURE__ */ jsx4("pre", {
|
|
599
|
-
className: "rounded-lg border bg-muted p-4 text-sm",
|
|
600
|
-
children: `import { SpecExperimentRegistry } from '@contractspec/lib.growth/spec-experiments';
|
|
86
|
+
}`})})]}),s("div",{className:"space-y-3",children:[i("h2",{className:"font-bold text-2xl",children:"Custom Platform Support"}),i("p",{className:"text-muted-foreground",children:"To support a new platform (e.g., Vue, Svelte), you would:"}),s("ol",{className:"list-inside list-decimal space-y-2 text-muted-foreground",children:[s("li",{children:["Implement the core workflow state machine (from"," ",i("code",{children:"@contractspec/lib.presentation-runtime-core"}),")"]}),i("li",{children:"Create framework-specific hooks/components for step rendering"}),i("li",{children:"Handle validation and submission via the ContractSpec I/O schemas"})]})]}),i("div",{className:"flex items-center gap-4 pt-4",children:s(h,{href:"/docs",className:"btn-primary",children:["Back to docs ",i(y,{size:16})]})})]})]})}import{jsx as l,jsxs as p}from"react/jsx-runtime";function q(){return p("div",{className:"space-y-8",children:[p("div",{className:"space-y-4",children:[l("h1",{className:"font-bold text-4xl",children:"Spec Experiments"}),l("p",{className:"text-lg text-muted-foreground",children:"Run controlled experiments on ContractSpec operations, gradually shift traffic, and roll back automatically when guardrails trip."})]}),p("div",{className:"space-y-3",children:[l("h2",{className:"font-bold text-2xl",children:"Define control + variants"}),l("pre",{className:"rounded-lg border bg-muted p-4 text-sm",children:`import { SpecExperimentRegistry } from '@contractspec/lib.growth/spec-experiments';
|
|
601
87
|
|
|
602
88
|
const registry = new SpecExperimentRegistry().register({
|
|
603
89
|
target: { name: 'billing.createInvoice', version: 4 },
|
|
@@ -617,38 +103,12 @@ const registry = new SpecExperimentRegistry().register({
|
|
|
617
103
|
],
|
|
618
104
|
rolloutStages: [0.01, 0.1, 0.5, 1],
|
|
619
105
|
guardrails: { errorRateThreshold: 0.02, latencyP99ThresholdMs: 500 },
|
|
620
|
-
});`
|
|
621
|
-
})
|
|
622
|
-
]
|
|
623
|
-
}),
|
|
624
|
-
/* @__PURE__ */ jsxs4("div", {
|
|
625
|
-
className: "space-y-3",
|
|
626
|
-
children: [
|
|
627
|
-
/* @__PURE__ */ jsx4("h2", {
|
|
628
|
-
className: "font-bold text-2xl",
|
|
629
|
-
children: "Attach to runtime"
|
|
630
|
-
}),
|
|
631
|
-
/* @__PURE__ */ jsx4("pre", {
|
|
632
|
-
className: "rounded-lg border bg-muted p-4 text-sm",
|
|
633
|
-
children: `import { createSpecVariantResolver } from '@contractspec/lib.growth/spec-experiments';
|
|
106
|
+
});`})]}),p("div",{className:"space-y-3",children:[l("h2",{className:"font-bold text-2xl",children:"Attach to runtime"}),l("pre",{className:"rounded-lg border bg-muted p-4 text-sm",children:`import { createSpecVariantResolver } from '@contractspec/lib.growth/spec-experiments';
|
|
634
107
|
|
|
635
108
|
adapterContext.specVariantResolver = createSpecVariantResolver({
|
|
636
109
|
adapter,
|
|
637
110
|
resolveUserId: (ctx) => ctx.userId ?? ctx.organizationId ?? 'anon',
|
|
638
|
-
});`
|
|
639
|
-
})
|
|
640
|
-
]
|
|
641
|
-
}),
|
|
642
|
-
/* @__PURE__ */ jsxs4("div", {
|
|
643
|
-
className: "space-y-3",
|
|
644
|
-
children: [
|
|
645
|
-
/* @__PURE__ */ jsx4("h2", {
|
|
646
|
-
className: "font-bold text-2xl",
|
|
647
|
-
children: "Track outcomes + auto-rollback"
|
|
648
|
-
}),
|
|
649
|
-
/* @__PURE__ */ jsx4("pre", {
|
|
650
|
-
className: "rounded-lg border bg-muted p-4 text-sm",
|
|
651
|
-
children: `import {
|
|
111
|
+
});`})]}),p("div",{className:"space-y-3",children:[l("h2",{className:"font-bold text-2xl",children:"Track outcomes + auto-rollback"}),l("pre",{className:"rounded-lg border bg-muted p-4 text-sm",children:`import {
|
|
652
112
|
SpecExperimentAnalyzer,
|
|
653
113
|
SpecExperimentController,
|
|
654
114
|
} from '@contractspec/lib.growth/spec-experiments';
|
|
@@ -658,148 +118,7 @@ const controller = new SpecExperimentController({
|
|
|
658
118
|
registry,
|
|
659
119
|
analyzer,
|
|
660
120
|
onRollback: (target, evaluation) => notifyOps(target, evaluation.reasons),
|
|
661
|
-
});`
|
|
662
|
-
})
|
|
663
|
-
]
|
|
664
|
-
}),
|
|
665
|
-
/* @__PURE__ */ jsx4("div", {
|
|
666
|
-
className: "grid gap-4 md:grid-cols-2",
|
|
667
|
-
children: [
|
|
668
|
-
{
|
|
669
|
-
title: "Deterministic bucketing",
|
|
670
|
-
description: "ExperimentRunner reuses the same hashing logic as growth experiments\u2014every user sticks to a variant."
|
|
671
|
-
},
|
|
672
|
-
{
|
|
673
|
-
title: "Multi-stage rollouts",
|
|
674
|
-
description: "Use `rolloutStages` to shift 1% \u2192 10% \u2192 50% \u2192 100%. Guardrails trigger rollbacks automatically."
|
|
675
|
-
}
|
|
676
|
-
].map((card) => /* @__PURE__ */ jsxs4("div", {
|
|
677
|
-
className: "card-subtle space-y-2 p-4",
|
|
678
|
-
children: [
|
|
679
|
-
/* @__PURE__ */ jsx4("h3", {
|
|
680
|
-
className: "font-semibold text-lg",
|
|
681
|
-
children: card.title
|
|
682
|
-
}),
|
|
683
|
-
/* @__PURE__ */ jsx4("p", {
|
|
684
|
-
className: "text-muted-foreground text-sm",
|
|
685
|
-
children: card.description
|
|
686
|
-
})
|
|
687
|
-
]
|
|
688
|
-
}, card.title))
|
|
689
|
-
})
|
|
690
|
-
]
|
|
691
|
-
});
|
|
692
|
-
}
|
|
693
|
-
|
|
694
|
-
// src/components/docs/advanced/AdvancedTelemetryPage.tsx
|
|
695
|
-
import Link4 from "@contractspec/lib.ui-link";
|
|
696
|
-
import { ChevronRight as ChevronRight3 } from "lucide-react";
|
|
697
|
-
import { jsx as jsx5, jsxs as jsxs5 } from "react/jsx-runtime";
|
|
698
|
-
function AdvancedTelemetryPage() {
|
|
699
|
-
return /* @__PURE__ */ jsxs5("div", {
|
|
700
|
-
className: "space-y-8",
|
|
701
|
-
children: [
|
|
702
|
-
/* @__PURE__ */ jsxs5("div", {
|
|
703
|
-
className: "space-y-4",
|
|
704
|
-
children: [
|
|
705
|
-
/* @__PURE__ */ jsx5("h1", {
|
|
706
|
-
className: "font-bold text-4xl",
|
|
707
|
-
children: "Telemetry"
|
|
708
|
-
}),
|
|
709
|
-
/* @__PURE__ */ jsxs5("p", {
|
|
710
|
-
className: "text-muted-foreground",
|
|
711
|
-
children: [
|
|
712
|
-
"A ",
|
|
713
|
-
/* @__PURE__ */ jsx5("strong", {
|
|
714
|
-
children: "TelemetrySpec"
|
|
715
|
-
}),
|
|
716
|
-
" defines what metrics, logs, and traces to collect for observability. ContractSpec automatically instruments your application based on these specs, ensuring you have the visibility you need to monitor, debug, and optimize your system."
|
|
717
|
-
]
|
|
718
|
-
})
|
|
719
|
-
]
|
|
720
|
-
}),
|
|
721
|
-
/* @__PURE__ */ jsxs5("div", {
|
|
722
|
-
className: "space-y-4",
|
|
723
|
-
children: [
|
|
724
|
-
/* @__PURE__ */ jsx5("h2", {
|
|
725
|
-
className: "font-bold text-2xl",
|
|
726
|
-
children: "Why telemetry matters"
|
|
727
|
-
}),
|
|
728
|
-
/* @__PURE__ */ jsx5("p", {
|
|
729
|
-
className: "text-muted-foreground",
|
|
730
|
-
children: "You can't fix what you can't see. Telemetry provides visibility into how your application is performing, where errors are occurring, and how users are interacting with your system. Without proper instrumentation, you're flying blind in production."
|
|
731
|
-
}),
|
|
732
|
-
/* @__PURE__ */ jsx5("p", {
|
|
733
|
-
className: "text-muted-foreground",
|
|
734
|
-
children: "ContractSpec takes a spec-first approach to telemetry: you declare what you want to observe, and runtime adapters instrument operations automatically. This ensures consistent, comprehensive coverage without manual effort."
|
|
735
|
-
})
|
|
736
|
-
]
|
|
737
|
-
}),
|
|
738
|
-
/* @__PURE__ */ jsxs5("div", {
|
|
739
|
-
className: "space-y-4",
|
|
740
|
-
children: [
|
|
741
|
-
/* @__PURE__ */ jsx5("h2", {
|
|
742
|
-
className: "font-bold text-2xl",
|
|
743
|
-
children: "Three pillars of observability"
|
|
744
|
-
}),
|
|
745
|
-
/* @__PURE__ */ jsxs5("div", {
|
|
746
|
-
className: "space-y-3",
|
|
747
|
-
children: [
|
|
748
|
-
/* @__PURE__ */ jsxs5("div", {
|
|
749
|
-
children: [
|
|
750
|
-
/* @__PURE__ */ jsx5("h3", {
|
|
751
|
-
className: "font-semibold text-lg",
|
|
752
|
-
children: "Metrics"
|
|
753
|
-
}),
|
|
754
|
-
/* @__PURE__ */ jsx5("p", {
|
|
755
|
-
className: "text-muted-foreground",
|
|
756
|
-
children: "Numerical measurements collected over time. Examples: request count, error rate, latency percentiles, active users, queue depth. Metrics are cheap to collect and store, making them ideal for high-level monitoring and alerting."
|
|
757
|
-
})
|
|
758
|
-
]
|
|
759
|
-
}),
|
|
760
|
-
/* @__PURE__ */ jsxs5("div", {
|
|
761
|
-
children: [
|
|
762
|
-
/* @__PURE__ */ jsx5("h3", {
|
|
763
|
-
className: "font-semibold text-lg",
|
|
764
|
-
children: "Logs"
|
|
765
|
-
}),
|
|
766
|
-
/* @__PURE__ */ jsx5("p", {
|
|
767
|
-
className: "text-muted-foreground",
|
|
768
|
-
children: 'Timestamped text records of events. Examples: "User 123 logged in", "Payment failed for order 456", "Database connection pool exhausted". Logs provide detailed context for debugging specific issues.'
|
|
769
|
-
})
|
|
770
|
-
]
|
|
771
|
-
}),
|
|
772
|
-
/* @__PURE__ */ jsxs5("div", {
|
|
773
|
-
children: [
|
|
774
|
-
/* @__PURE__ */ jsx5("h3", {
|
|
775
|
-
className: "font-semibold text-lg",
|
|
776
|
-
children: "Traces"
|
|
777
|
-
}),
|
|
778
|
-
/* @__PURE__ */ jsx5("p", {
|
|
779
|
-
className: "text-muted-foreground",
|
|
780
|
-
children: "Records of requests as they flow through your system. A trace shows the complete path of a request\u2014which services it touched, how long each step took, and where errors occurred. Traces are essential for debugging distributed systems."
|
|
781
|
-
})
|
|
782
|
-
]
|
|
783
|
-
})
|
|
784
|
-
]
|
|
785
|
-
})
|
|
786
|
-
]
|
|
787
|
-
}),
|
|
788
|
-
/* @__PURE__ */ jsxs5("div", {
|
|
789
|
-
className: "space-y-4",
|
|
790
|
-
children: [
|
|
791
|
-
/* @__PURE__ */ jsx5("h2", {
|
|
792
|
-
className: "font-bold text-2xl",
|
|
793
|
-
children: "Example TelemetrySpec"
|
|
794
|
-
}),
|
|
795
|
-
/* @__PURE__ */ jsx5("p", {
|
|
796
|
-
className: "text-muted-foreground",
|
|
797
|
-
children: "Here's how telemetry is configured in TypeScript:"
|
|
798
|
-
}),
|
|
799
|
-
/* @__PURE__ */ jsx5("div", {
|
|
800
|
-
className: "overflow-x-auto rounded-lg border border-border bg-background/50 p-4 font-mono text-muted-foreground text-sm",
|
|
801
|
-
children: /* @__PURE__ */ jsx5("pre", {
|
|
802
|
-
children: `import { defineTelemetry } from '@contractspec/lib.contracts-spec/telemetry';
|
|
121
|
+
});`})]}),l("div",{className:"grid gap-4 md:grid-cols-2",children:[{title:"Deterministic bucketing",description:"ExperimentRunner reuses the same hashing logic as growth experiments\u2014every user sticks to a variant."},{title:"Multi-stage rollouts",description:"Use `rolloutStages` to shift 1% \u2192 10% \u2192 50% \u2192 100%. Guardrails trigger rollbacks automatically."}].map((u)=>p("div",{className:"card-subtle space-y-2 p-4",children:[l("h3",{className:"font-semibold text-lg",children:u.title}),l("p",{className:"text-muted-foreground text-sm",children:u.description})]},u.title))})]})}import g from"@contractspec/lib.ui-link";import{ChevronRight as b}from"lucide-react";import{jsx as e,jsxs as o}from"react/jsx-runtime";function _(){return o("div",{className:"space-y-8",children:[o("div",{className:"space-y-4",children:[e("h1",{className:"font-bold text-4xl",children:"Telemetry"}),o("p",{className:"text-muted-foreground",children:["A ",e("strong",{children:"TelemetrySpec"})," defines what metrics, logs, and traces to collect for observability. ContractSpec automatically instruments your application based on these specs, ensuring you have the visibility you need to monitor, debug, and optimize your system."]})]}),o("div",{className:"space-y-4",children:[e("h2",{className:"font-bold text-2xl",children:"Why telemetry matters"}),e("p",{className:"text-muted-foreground",children:"You can't fix what you can't see. Telemetry provides visibility into how your application is performing, where errors are occurring, and how users are interacting with your system. Without proper instrumentation, you're flying blind in production."}),e("p",{className:"text-muted-foreground",children:"ContractSpec takes a spec-first approach to telemetry: you declare what you want to observe, and runtime adapters instrument operations automatically. This ensures consistent, comprehensive coverage without manual effort."})]}),o("div",{className:"space-y-4",children:[e("h2",{className:"font-bold text-2xl",children:"Three pillars of observability"}),o("div",{className:"space-y-3",children:[o("div",{children:[e("h3",{className:"font-semibold text-lg",children:"Metrics"}),e("p",{className:"text-muted-foreground",children:"Numerical measurements collected over time. Examples: request count, error rate, latency percentiles, active users, queue depth. Metrics are cheap to collect and store, making them ideal for high-level monitoring and alerting."})]}),o("div",{children:[e("h3",{className:"font-semibold text-lg",children:"Logs"}),e("p",{className:"text-muted-foreground",children:'Timestamped text records of events. Examples: "User 123 logged in", "Payment failed for order 456", "Database connection pool exhausted". Logs provide detailed context for debugging specific issues.'})]}),o("div",{children:[e("h3",{className:"font-semibold text-lg",children:"Traces"}),e("p",{className:"text-muted-foreground",children:"Records of requests as they flow through your system. A trace shows the complete path of a request\u2014which services it touched, how long each step took, and where errors occurred. Traces are essential for debugging distributed systems."})]})]})]}),o("div",{className:"space-y-4",children:[e("h2",{className:"font-bold text-2xl",children:"Example TelemetrySpec"}),e("p",{className:"text-muted-foreground",children:"Here's how telemetry is configured in TypeScript:"}),e("div",{className:"overflow-x-auto rounded-lg border border-border bg-background/50 p-4 font-mono text-muted-foreground text-sm",children:e("pre",{children:`import { defineTelemetry } from '@contractspec/lib.contracts-spec/telemetry';
|
|
803
122
|
|
|
804
123
|
export const OrderProcessingTelemetry = defineTelemetry({
|
|
805
124
|
meta: {
|
|
@@ -844,306 +163,7 @@ export const OrderProcessingTelemetry = defineTelemetry({
|
|
|
844
163
|
notify: ['pagerduty', 'slack'],
|
|
845
164
|
},
|
|
846
165
|
],
|
|
847
|
-
});`
|
|
848
|
-
})
|
|
849
|
-
})
|
|
850
|
-
]
|
|
851
|
-
}),
|
|
852
|
-
/* @__PURE__ */ jsxs5("div", {
|
|
853
|
-
className: "space-y-4",
|
|
854
|
-
children: [
|
|
855
|
-
/* @__PURE__ */ jsx5("h2", {
|
|
856
|
-
className: "font-bold text-2xl",
|
|
857
|
-
children: "Automatic instrumentation"
|
|
858
|
-
}),
|
|
859
|
-
/* @__PURE__ */ jsx5("p", {
|
|
860
|
-
className: "text-muted-foreground",
|
|
861
|
-
children: "ContractSpec automatically instruments:"
|
|
862
|
-
}),
|
|
863
|
-
/* @__PURE__ */ jsxs5("ul", {
|
|
864
|
-
className: "list-inside list-disc space-y-2 text-muted-foreground",
|
|
865
|
-
children: [
|
|
866
|
-
/* @__PURE__ */ jsxs5("li", {
|
|
867
|
-
children: [
|
|
868
|
-
/* @__PURE__ */ jsx5("strong", {
|
|
869
|
-
children: "All operations"
|
|
870
|
-
}),
|
|
871
|
-
" \u2013 Request count, latency, error rate per Command/Query"
|
|
872
|
-
]
|
|
873
|
-
}),
|
|
874
|
-
/* @__PURE__ */ jsxs5("li", {
|
|
875
|
-
children: [
|
|
876
|
-
/* @__PURE__ */ jsx5("strong", {
|
|
877
|
-
children: "All workflows"
|
|
878
|
-
}),
|
|
879
|
-
" \u2013 Step execution time, retry counts, compensation events"
|
|
880
|
-
]
|
|
881
|
-
}),
|
|
882
|
-
/* @__PURE__ */ jsxs5("li", {
|
|
883
|
-
children: [
|
|
884
|
-
/* @__PURE__ */ jsx5("strong", {
|
|
885
|
-
children: "All data views"
|
|
886
|
-
}),
|
|
887
|
-
" \u2013 Query execution time, result set size"
|
|
888
|
-
]
|
|
889
|
-
}),
|
|
890
|
-
/* @__PURE__ */ jsxs5("li", {
|
|
891
|
-
children: [
|
|
892
|
-
/* @__PURE__ */ jsx5("strong", {
|
|
893
|
-
children: "All policy decisions"
|
|
894
|
-
}),
|
|
895
|
-
" \u2013 Decision time, permit/deny ratio"
|
|
896
|
-
]
|
|
897
|
-
}),
|
|
898
|
-
/* @__PURE__ */ jsxs5("li", {
|
|
899
|
-
children: [
|
|
900
|
-
/* @__PURE__ */ jsx5("strong", {
|
|
901
|
-
children: "System resources"
|
|
902
|
-
}),
|
|
903
|
-
" \u2013 CPU, memory, disk, network usage"
|
|
904
|
-
]
|
|
905
|
-
})
|
|
906
|
-
]
|
|
907
|
-
}),
|
|
908
|
-
/* @__PURE__ */ jsx5("p", {
|
|
909
|
-
className: "text-muted-foreground",
|
|
910
|
-
children: "You don't need to add instrumentation code manually\u2014the runtime handles it based on your specs."
|
|
911
|
-
})
|
|
912
|
-
]
|
|
913
|
-
}),
|
|
914
|
-
/* @__PURE__ */ jsxs5("div", {
|
|
915
|
-
className: "space-y-4",
|
|
916
|
-
children: [
|
|
917
|
-
/* @__PURE__ */ jsx5("h2", {
|
|
918
|
-
className: "font-bold text-2xl",
|
|
919
|
-
children: "Integration with observability platforms"
|
|
920
|
-
}),
|
|
921
|
-
/* @__PURE__ */ jsx5("p", {
|
|
922
|
-
className: "text-muted-foreground",
|
|
923
|
-
children: "ContractSpec supports multiple observability backends:"
|
|
924
|
-
}),
|
|
925
|
-
/* @__PURE__ */ jsxs5("ul", {
|
|
926
|
-
className: "list-inside list-disc space-y-2 text-muted-foreground",
|
|
927
|
-
children: [
|
|
928
|
-
/* @__PURE__ */ jsxs5("li", {
|
|
929
|
-
children: [
|
|
930
|
-
/* @__PURE__ */ jsx5("strong", {
|
|
931
|
-
children: "Prometheus"
|
|
932
|
-
}),
|
|
933
|
-
" \u2013 For metrics collection and alerting"
|
|
934
|
-
]
|
|
935
|
-
}),
|
|
936
|
-
/* @__PURE__ */ jsxs5("li", {
|
|
937
|
-
children: [
|
|
938
|
-
/* @__PURE__ */ jsx5("strong", {
|
|
939
|
-
children: "Grafana"
|
|
940
|
-
}),
|
|
941
|
-
" \u2013 For dashboards and visualization"
|
|
942
|
-
]
|
|
943
|
-
}),
|
|
944
|
-
/* @__PURE__ */ jsxs5("li", {
|
|
945
|
-
children: [
|
|
946
|
-
/* @__PURE__ */ jsx5("strong", {
|
|
947
|
-
children: "Jaeger / Tempo"
|
|
948
|
-
}),
|
|
949
|
-
" \u2013 For distributed tracing"
|
|
950
|
-
]
|
|
951
|
-
}),
|
|
952
|
-
/* @__PURE__ */ jsxs5("li", {
|
|
953
|
-
children: [
|
|
954
|
-
/* @__PURE__ */ jsx5("strong", {
|
|
955
|
-
children: "Loki"
|
|
956
|
-
}),
|
|
957
|
-
" \u2013 For log aggregation"
|
|
958
|
-
]
|
|
959
|
-
}),
|
|
960
|
-
/* @__PURE__ */ jsxs5("li", {
|
|
961
|
-
children: [
|
|
962
|
-
/* @__PURE__ */ jsx5("strong", {
|
|
963
|
-
children: "Datadog"
|
|
964
|
-
}),
|
|
965
|
-
" \u2013 All-in-one observability platform"
|
|
966
|
-
]
|
|
967
|
-
}),
|
|
968
|
-
/* @__PURE__ */ jsxs5("li", {
|
|
969
|
-
children: [
|
|
970
|
-
/* @__PURE__ */ jsx5("strong", {
|
|
971
|
-
children: "New Relic"
|
|
972
|
-
}),
|
|
973
|
-
" \u2013 Application performance monitoring"
|
|
974
|
-
]
|
|
975
|
-
}),
|
|
976
|
-
/* @__PURE__ */ jsxs5("li", {
|
|
977
|
-
children: [
|
|
978
|
-
/* @__PURE__ */ jsx5("strong", {
|
|
979
|
-
children: "Honeycomb"
|
|
980
|
-
}),
|
|
981
|
-
" \u2013 Observability for complex systems"
|
|
982
|
-
]
|
|
983
|
-
})
|
|
984
|
-
]
|
|
985
|
-
}),
|
|
986
|
-
/* @__PURE__ */ jsx5("p", {
|
|
987
|
-
className: "text-muted-foreground",
|
|
988
|
-
children: "You can configure multiple backends and send telemetry to all of them simultaneously."
|
|
989
|
-
})
|
|
990
|
-
]
|
|
991
|
-
}),
|
|
992
|
-
/* @__PURE__ */ jsxs5("div", {
|
|
993
|
-
className: "space-y-4",
|
|
994
|
-
children: [
|
|
995
|
-
/* @__PURE__ */ jsx5("h2", {
|
|
996
|
-
className: "font-bold text-2xl",
|
|
997
|
-
children: "Sampling and performance"
|
|
998
|
-
}),
|
|
999
|
-
/* @__PURE__ */ jsx5("p", {
|
|
1000
|
-
className: "text-muted-foreground",
|
|
1001
|
-
children: "Collecting telemetry has a cost\u2014CPU, memory, network bandwidth, and storage. ContractSpec provides several mechanisms to control overhead:"
|
|
1002
|
-
}),
|
|
1003
|
-
/* @__PURE__ */ jsxs5("ul", {
|
|
1004
|
-
className: "list-inside list-disc space-y-2 text-muted-foreground",
|
|
1005
|
-
children: [
|
|
1006
|
-
/* @__PURE__ */ jsxs5("li", {
|
|
1007
|
-
children: [
|
|
1008
|
-
/* @__PURE__ */ jsx5("strong", {
|
|
1009
|
-
children: "Sampling"
|
|
1010
|
-
}),
|
|
1011
|
-
" \u2013 Trace only a percentage of requests (e.g., 10%)"
|
|
1012
|
-
]
|
|
1013
|
-
}),
|
|
1014
|
-
/* @__PURE__ */ jsxs5("li", {
|
|
1015
|
-
children: [
|
|
1016
|
-
/* @__PURE__ */ jsx5("strong", {
|
|
1017
|
-
children: "Adaptive sampling"
|
|
1018
|
-
}),
|
|
1019
|
-
" \u2013 Automatically reduce sampling rate under high load"
|
|
1020
|
-
]
|
|
1021
|
-
}),
|
|
1022
|
-
/* @__PURE__ */ jsxs5("li", {
|
|
1023
|
-
children: [
|
|
1024
|
-
/* @__PURE__ */ jsx5("strong", {
|
|
1025
|
-
children: "Tail-based sampling"
|
|
1026
|
-
}),
|
|
1027
|
-
" \u2013 Keep traces for failed requests, sample successful ones"
|
|
1028
|
-
]
|
|
1029
|
-
}),
|
|
1030
|
-
/* @__PURE__ */ jsxs5("li", {
|
|
1031
|
-
children: [
|
|
1032
|
-
/* @__PURE__ */ jsx5("strong", {
|
|
1033
|
-
children: "Field redaction"
|
|
1034
|
-
}),
|
|
1035
|
-
" \u2013 Remove sensitive data from traces and logs"
|
|
1036
|
-
]
|
|
1037
|
-
}),
|
|
1038
|
-
/* @__PURE__ */ jsxs5("li", {
|
|
1039
|
-
children: [
|
|
1040
|
-
/* @__PURE__ */ jsx5("strong", {
|
|
1041
|
-
children: "Aggregation"
|
|
1042
|
-
}),
|
|
1043
|
-
" \u2013 Pre-aggregate metrics before sending to reduce network traffic"
|
|
1044
|
-
]
|
|
1045
|
-
})
|
|
1046
|
-
]
|
|
1047
|
-
})
|
|
1048
|
-
]
|
|
1049
|
-
}),
|
|
1050
|
-
/* @__PURE__ */ jsxs5("div", {
|
|
1051
|
-
className: "space-y-4",
|
|
1052
|
-
children: [
|
|
1053
|
-
/* @__PURE__ */ jsx5("h2", {
|
|
1054
|
-
className: "font-bold text-2xl",
|
|
1055
|
-
children: "Best practices"
|
|
1056
|
-
}),
|
|
1057
|
-
/* @__PURE__ */ jsxs5("ul", {
|
|
1058
|
-
className: "list-inside list-disc space-y-2 text-muted-foreground",
|
|
1059
|
-
children: [
|
|
1060
|
-
/* @__PURE__ */ jsx5("li", {
|
|
1061
|
-
children: "Start with high-level metrics (request rate, error rate, latency) and add more detailed instrumentation as needed."
|
|
1062
|
-
}),
|
|
1063
|
-
/* @__PURE__ */ jsx5("li", {
|
|
1064
|
-
children: "Use structured logging\u2014log events with structured fields, not free-form text."
|
|
1065
|
-
}),
|
|
1066
|
-
/* @__PURE__ */ jsx5("li", {
|
|
1067
|
-
children: "Set up alerts for critical metrics so you're notified when things go wrong."
|
|
1068
|
-
}),
|
|
1069
|
-
/* @__PURE__ */ jsx5("li", {
|
|
1070
|
-
children: "Use traces to debug complex issues\u2014they show the complete picture of a request."
|
|
1071
|
-
}),
|
|
1072
|
-
/* @__PURE__ */ jsx5("li", {
|
|
1073
|
-
children: "Redact sensitive data from logs and traces to comply with privacy regulations."
|
|
1074
|
-
}),
|
|
1075
|
-
/* @__PURE__ */ jsx5("li", {
|
|
1076
|
-
children: "Review dashboards regularly to understand normal behavior\u2014this makes anomalies easier to spot."
|
|
1077
|
-
}),
|
|
1078
|
-
/* @__PURE__ */ jsx5("li", {
|
|
1079
|
-
children: "Use sampling to control costs, but always trace errors and slow requests."
|
|
1080
|
-
})
|
|
1081
|
-
]
|
|
1082
|
-
})
|
|
1083
|
-
]
|
|
1084
|
-
}),
|
|
1085
|
-
/* @__PURE__ */ jsxs5("div", {
|
|
1086
|
-
className: "flex items-center gap-4 pt-4",
|
|
1087
|
-
children: [
|
|
1088
|
-
/* @__PURE__ */ jsx5(Link4, {
|
|
1089
|
-
href: "/docs/advanced/mcp",
|
|
1090
|
-
className: "btn-ghost",
|
|
1091
|
-
children: "Previous: MCP Adapters"
|
|
1092
|
-
}),
|
|
1093
|
-
/* @__PURE__ */ jsxs5(Link4, {
|
|
1094
|
-
href: "/docs/comparison",
|
|
1095
|
-
className: "btn-primary",
|
|
1096
|
-
children: [
|
|
1097
|
-
"Next: Comparison ",
|
|
1098
|
-
/* @__PURE__ */ jsx5(ChevronRight3, {
|
|
1099
|
-
size: 16
|
|
1100
|
-
})
|
|
1101
|
-
]
|
|
1102
|
-
})
|
|
1103
|
-
]
|
|
1104
|
-
})
|
|
1105
|
-
]
|
|
1106
|
-
});
|
|
1107
|
-
}
|
|
1108
|
-
|
|
1109
|
-
// src/components/docs/advanced/AdvancedWorkflowMonitoringPage.tsx
|
|
1110
|
-
import { jsx as jsx6, jsxs as jsxs6 } from "react/jsx-runtime";
|
|
1111
|
-
function AdvancedWorkflowMonitoringPage() {
|
|
1112
|
-
return /* @__PURE__ */ jsxs6("div", {
|
|
1113
|
-
className: "space-y-8",
|
|
1114
|
-
children: [
|
|
1115
|
-
/* @__PURE__ */ jsxs6("div", {
|
|
1116
|
-
className: "space-y-4",
|
|
1117
|
-
children: [
|
|
1118
|
-
/* @__PURE__ */ jsx6("h1", {
|
|
1119
|
-
className: "font-bold text-4xl",
|
|
1120
|
-
children: "Workflow Monitoring"
|
|
1121
|
-
}),
|
|
1122
|
-
/* @__PURE__ */ jsx6("p", {
|
|
1123
|
-
className: "text-lg text-muted-foreground",
|
|
1124
|
-
children: "Production workflows need robust observability. ContractSpec provides SLA monitoring, distributed tracing, and audit logging out of the box."
|
|
1125
|
-
})
|
|
1126
|
-
]
|
|
1127
|
-
}),
|
|
1128
|
-
/* @__PURE__ */ jsxs6("div", {
|
|
1129
|
-
className: "space-y-4",
|
|
1130
|
-
children: [
|
|
1131
|
-
/* @__PURE__ */ jsx6("h2", {
|
|
1132
|
-
className: "font-bold text-2xl",
|
|
1133
|
-
children: "SLA Monitoring"
|
|
1134
|
-
}),
|
|
1135
|
-
/* @__PURE__ */ jsxs6("p", {
|
|
1136
|
-
children: [
|
|
1137
|
-
"Use the ",
|
|
1138
|
-
/* @__PURE__ */ jsx6("code", {
|
|
1139
|
-
children: "SLAMonitor"
|
|
1140
|
-
}),
|
|
1141
|
-
" to detect when workflows or individual steps exceed their budgeted duration."
|
|
1142
|
-
]
|
|
1143
|
-
}),
|
|
1144
|
-
/* @__PURE__ */ jsx6("pre", {
|
|
1145
|
-
className: "rounded-lg border bg-muted p-4 text-sm",
|
|
1146
|
-
children: `import { SLAMonitor } from '@contractspec/lib.contracts-spec/workflow/sla-monitor';
|
|
166
|
+
});`})})]}),o("div",{className:"space-y-4",children:[e("h2",{className:"font-bold text-2xl",children:"Automatic instrumentation"}),e("p",{className:"text-muted-foreground",children:"ContractSpec automatically instruments:"}),o("ul",{className:"list-inside list-disc space-y-2 text-muted-foreground",children:[o("li",{children:[e("strong",{children:"All operations"})," \u2013 Request count, latency, error rate per Command/Query"]}),o("li",{children:[e("strong",{children:"All workflows"})," \u2013 Step execution time, retry counts, compensation events"]}),o("li",{children:[e("strong",{children:"All data views"})," \u2013 Query execution time, result set size"]}),o("li",{children:[e("strong",{children:"All policy decisions"})," \u2013 Decision time, permit/deny ratio"]}),o("li",{children:[e("strong",{children:"System resources"})," \u2013 CPU, memory, disk, network usage"]})]}),e("p",{className:"text-muted-foreground",children:"You don't need to add instrumentation code manually\u2014the runtime handles it based on your specs."})]}),o("div",{className:"space-y-4",children:[e("h2",{className:"font-bold text-2xl",children:"Integration with observability platforms"}),e("p",{className:"text-muted-foreground",children:"ContractSpec supports multiple observability backends:"}),o("ul",{className:"list-inside list-disc space-y-2 text-muted-foreground",children:[o("li",{children:[e("strong",{children:"Prometheus"})," \u2013 For metrics collection and alerting"]}),o("li",{children:[e("strong",{children:"Grafana"})," \u2013 For dashboards and visualization"]}),o("li",{children:[e("strong",{children:"Jaeger / Tempo"})," \u2013 For distributed tracing"]}),o("li",{children:[e("strong",{children:"Loki"})," \u2013 For log aggregation"]}),o("li",{children:[e("strong",{children:"Datadog"})," \u2013 All-in-one observability platform"]}),o("li",{children:[e("strong",{children:"New Relic"})," \u2013 Application performance monitoring"]}),o("li",{children:[e("strong",{children:"Honeycomb"})," \u2013 Observability for complex systems"]})]}),e("p",{className:"text-muted-foreground",children:"You can configure multiple backends and send telemetry to all of them simultaneously."})]}),o("div",{className:"space-y-4",children:[e("h2",{className:"font-bold text-2xl",children:"Sampling and performance"}),e("p",{className:"text-muted-foreground",children:"Collecting telemetry has a cost\u2014CPU, memory, network bandwidth, and storage. ContractSpec provides several mechanisms to control overhead:"}),o("ul",{className:"list-inside list-disc space-y-2 text-muted-foreground",children:[o("li",{children:[e("strong",{children:"Sampling"})," \u2013 Trace only a percentage of requests (e.g., 10%)"]}),o("li",{children:[e("strong",{children:"Adaptive sampling"})," \u2013 Automatically reduce sampling rate under high load"]}),o("li",{children:[e("strong",{children:"Tail-based sampling"})," \u2013 Keep traces for failed requests, sample successful ones"]}),o("li",{children:[e("strong",{children:"Field redaction"})," \u2013 Remove sensitive data from traces and logs"]}),o("li",{children:[e("strong",{children:"Aggregation"})," \u2013 Pre-aggregate metrics before sending to reduce network traffic"]})]})]}),o("div",{className:"space-y-4",children:[e("h2",{className:"font-bold text-2xl",children:"Best practices"}),o("ul",{className:"list-inside list-disc space-y-2 text-muted-foreground",children:[e("li",{children:"Start with high-level metrics (request rate, error rate, latency) and add more detailed instrumentation as needed."}),e("li",{children:"Use structured logging\u2014log events with structured fields, not free-form text."}),e("li",{children:"Set up alerts for critical metrics so you're notified when things go wrong."}),e("li",{children:"Use traces to debug complex issues\u2014they show the complete picture of a request."}),e("li",{children:"Redact sensitive data from logs and traces to comply with privacy regulations."}),e("li",{children:"Review dashboards regularly to understand normal behavior\u2014this makes anomalies easier to spot."}),e("li",{children:"Use sampling to control costs, but always trace errors and slow requests."})]})]}),o("div",{className:"flex items-center gap-4 pt-4",children:[e(g,{href:"/docs/advanced/mcp",className:"btn-ghost",children:"Previous: MCP Adapters"}),o(g,{href:"/docs/comparison",className:"btn-primary",children:["Next: Comparison ",e(b,{size:16})]})]})]})}import{jsx as n,jsxs as d}from"react/jsx-runtime";function B(){return d("div",{className:"space-y-8",children:[d("div",{className:"space-y-4",children:[n("h1",{className:"font-bold text-4xl",children:"Workflow Monitoring"}),n("p",{className:"text-lg text-muted-foreground",children:"Production workflows need robust observability. ContractSpec provides SLA monitoring, distributed tracing, and audit logging out of the box."})]}),d("div",{className:"space-y-4",children:[n("h2",{className:"font-bold text-2xl",children:"SLA Monitoring"}),d("p",{children:["Use the ",n("code",{children:"SLAMonitor"})," to detect when workflows or individual steps exceed their budgeted duration."]}),n("pre",{className:"rounded-lg border bg-muted p-4 text-sm",children:`import { SLAMonitor } from '@contractspec/lib.contracts-spec/workflow/sla-monitor';
|
|
1147
167
|
|
|
1148
168
|
const monitor = new SLAMonitor((event, payload) => {
|
|
1149
169
|
if (event === 'workflow.sla_breach') {
|
|
@@ -1153,69 +173,4 @@ const monitor = new SLAMonitor((event, payload) => {
|
|
|
1153
173
|
});
|
|
1154
174
|
|
|
1155
175
|
// Check periodically
|
|
1156
|
-
monitor.check(currentState, workflowSpec);`
|
|
1157
|
-
})
|
|
1158
|
-
]
|
|
1159
|
-
}),
|
|
1160
|
-
/* @__PURE__ */ jsxs6("div", {
|
|
1161
|
-
className: "space-y-4",
|
|
1162
|
-
children: [
|
|
1163
|
-
/* @__PURE__ */ jsx6("h2", {
|
|
1164
|
-
className: "font-bold text-2xl",
|
|
1165
|
-
children: "Telemetry & Tracing"
|
|
1166
|
-
}),
|
|
1167
|
-
/* @__PURE__ */ jsx6("p", {
|
|
1168
|
-
children: "Workflows automatically generate OpenTelemetry spans for:"
|
|
1169
|
-
}),
|
|
1170
|
-
/* @__PURE__ */ jsxs6("ul", {
|
|
1171
|
-
className: "list-disc space-y-2 pl-6",
|
|
1172
|
-
children: [
|
|
1173
|
-
/* @__PURE__ */ jsx6("li", {
|
|
1174
|
-
children: "Overall workflow execution"
|
|
1175
|
-
}),
|
|
1176
|
-
/* @__PURE__ */ jsx6("li", {
|
|
1177
|
-
children: "Individual steps"
|
|
1178
|
-
}),
|
|
1179
|
-
/* @__PURE__ */ jsx6("li", {
|
|
1180
|
-
children: "Retries and compensation"
|
|
1181
|
-
})
|
|
1182
|
-
]
|
|
1183
|
-
}),
|
|
1184
|
-
/* @__PURE__ */ jsx6("p", {
|
|
1185
|
-
children: "Configure your OpenTelemetry exporter to send traces to Jaeger, Datadog, or Honeycomb."
|
|
1186
|
-
})
|
|
1187
|
-
]
|
|
1188
|
-
}),
|
|
1189
|
-
/* @__PURE__ */ jsxs6("div", {
|
|
1190
|
-
className: "space-y-4",
|
|
1191
|
-
children: [
|
|
1192
|
-
/* @__PURE__ */ jsx6("h2", {
|
|
1193
|
-
className: "font-bold text-2xl",
|
|
1194
|
-
children: "Dashboarding"
|
|
1195
|
-
}),
|
|
1196
|
-
/* @__PURE__ */ jsxs6("p", {
|
|
1197
|
-
children: [
|
|
1198
|
-
"You can build a custom dashboard using ",
|
|
1199
|
-
/* @__PURE__ */ jsx6("code", {
|
|
1200
|
-
children: "DataViews"
|
|
1201
|
-
}),
|
|
1202
|
-
" over your workflow state database. See the DataViews tutorial for how to visualize ",
|
|
1203
|
-
/* @__PURE__ */ jsx6("code", {
|
|
1204
|
-
children: "WorkflowState"
|
|
1205
|
-
}),
|
|
1206
|
-
" records."
|
|
1207
|
-
]
|
|
1208
|
-
})
|
|
1209
|
-
]
|
|
1210
|
-
})
|
|
1211
|
-
]
|
|
1212
|
-
});
|
|
1213
|
-
}
|
|
1214
|
-
export {
|
|
1215
|
-
AdvancedWorkflowMonitoringPage,
|
|
1216
|
-
AdvancedTelemetryPage,
|
|
1217
|
-
AdvancedSpecExperimentsPage,
|
|
1218
|
-
AdvancedRenderersPage,
|
|
1219
|
-
AdvancedOverlayEditorPage,
|
|
1220
|
-
AdvancedMCPPage
|
|
1221
|
-
};
|
|
176
|
+
monitor.check(currentState, workflowSpec);`})]}),d("div",{className:"space-y-4",children:[n("h2",{className:"font-bold text-2xl",children:"Telemetry & Tracing"}),n("p",{children:"Workflows automatically generate OpenTelemetry spans for:"}),d("ul",{className:"list-disc space-y-2 pl-6",children:[n("li",{children:"Overall workflow execution"}),n("li",{children:"Individual steps"}),n("li",{children:"Retries and compensation"})]}),n("p",{children:"Configure your OpenTelemetry exporter to send traces to Jaeger, Datadog, or Honeycomb."})]}),d("div",{className:"space-y-4",children:[n("h2",{className:"font-bold text-2xl",children:"Dashboarding"}),d("p",{children:["You can build a custom dashboard using ",n("code",{children:"DataViews"})," over your workflow state database. See the DataViews tutorial for how to visualize ",n("code",{children:"WorkflowState"})," records."]})]})]})}export{B as AdvancedWorkflowMonitoringPage,_ as AdvancedTelemetryPage,q as AdvancedSpecExperimentsPage,E as AdvancedRenderersPage,A as AdvancedOverlayEditorPage,k as AdvancedMCPPage};
|