@contractspec/bundle.library 3.8.12 → 3.9.2
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 +614 -602
- package/CHANGELOG.md +97 -0
- package/dist/application/context-storage/index.js +1 -1
- package/dist/application/index.js +11 -11
- package/dist/application/mcp/cliMcp.js +6 -6
- package/dist/application/mcp/cliMcp.onboarding.d.ts +4 -0
- package/dist/application/mcp/cliMcp.onboarding.js +2 -0
- package/dist/application/mcp/cliMcp.test.d.ts +1 -0
- package/dist/application/mcp/common.js +1 -1
- package/dist/application/mcp/contractsMcp.js +2 -2
- package/dist/application/mcp/contractsMcp.test.d.ts +1 -0
- package/dist/application/mcp/contractsMcpAdoptionTools.d.ts +3 -0
- package/dist/application/mcp/contractsMcpAdoptionTools.js +2 -0
- package/dist/application/mcp/contractsMcpResources.js +2 -2
- package/dist/application/mcp/contractsMcpTools.js +1 -1
- package/dist/application/mcp/contractsMcpTypes.d.ts +16 -0
- package/dist/application/mcp/docsMcp.catalog.js +2 -2
- package/dist/application/mcp/docsMcp.data.js +1 -1
- package/dist/application/mcp/docsMcp.js +3 -3
- package/dist/application/mcp/docsMcp.prompts.js +3 -3
- package/dist/application/mcp/docsMcp.reference.js +2 -2
- package/dist/application/mcp/docsMcp.resources.js +2 -2
- package/dist/application/mcp/docsMcp.tools.js +2 -2
- package/dist/application/mcp/index.js +11 -11
- package/dist/application/mcp/internalMcp.js +2 -2
- package/dist/application/mcp/normalizeMcpRequest.js +1 -1
- package/dist/application/mcp/providerRankingMcp.js +1 -1
- package/dist/bundles/LibraryBundle.d.ts +19 -111
- package/dist/bundles/LibraryBundle.js +1 -1
- package/dist/bundles/index.js +1 -1
- package/dist/components/docs/DocsIndexPage.js +2 -2
- package/dist/components/docs/advanced/AdvancedMCPPage.js +3 -3
- package/dist/components/docs/advanced/AdvancedOverlayEditorPage.js +1 -1
- package/dist/components/docs/advanced/AdvancedRenderersPage.js +2 -2
- package/dist/components/docs/advanced/AdvancedSpecExperimentsPage.js +4 -4
- package/dist/components/docs/advanced/AdvancedTelemetryPage.js +2 -2
- package/dist/components/docs/advanced/AdvancedWorkflowMonitoringPage.js +2 -2
- package/dist/components/docs/advanced/index.js +9 -9
- package/dist/components/docs/architecture/ArchitectureAppConfigPage.js +6 -6
- package/dist/components/docs/architecture/ArchitectureControlPlanePage.js +3 -3
- package/dist/components/docs/architecture/ArchitectureIntegrationBindingPage.js +7 -7
- package/dist/components/docs/architecture/ArchitectureKnowledgeBindingPage.js +6 -6
- package/dist/components/docs/architecture/ArchitectureMultiTenancyPage.js +2 -2
- package/dist/components/docs/architecture/ArchitectureOverviewPage.js +1 -1
- package/dist/components/docs/architecture/index.js +20 -20
- package/dist/components/docs/comparison/ComparisonAutomationPlatformsPage.js +1 -1
- package/dist/components/docs/comparison/ComparisonEnterprisePlatformsPage.js +1 -1
- package/dist/components/docs/comparison/ComparisonInternalToolBuildersPage.js +1 -1
- package/dist/components/docs/comparison/ComparisonOverviewPage.js +1 -1
- package/dist/components/docs/comparison/ComparisonWindmillPage.js +1 -1
- package/dist/components/docs/comparison/ComparisonWorkflowEnginesPage.js +1 -1
- package/dist/components/docs/comparison/index.js +1 -1
- package/dist/components/docs/docsManifest.js +1 -1
- package/dist/components/docs/ecosystem/IntegrationsPage.js +2 -2
- package/dist/components/docs/ecosystem/PluginsPage.js +4 -4
- package/dist/components/docs/ecosystem/RegistryPage.js +4 -4
- package/dist/components/docs/ecosystem/TemplatesPage.js +3 -3
- package/dist/components/docs/ecosystem/index.js +11 -11
- package/dist/components/docs/examples/DocsExamplesPage.js +1 -17
- package/dist/components/docs/examples/ExampleShowcasePage.d.ts +1 -1
- package/dist/components/docs/examples/ExampleShowcasePage.js +2 -17
- package/dist/components/docs/examples/exampleShowcaseData.d.ts +2 -2
- package/dist/components/docs/examples/exampleShowcaseData.js +2 -17
- package/dist/components/docs/examples/exampleShowcaseData.test.d.ts +1 -0
- package/dist/components/docs/examples/index.js +2 -17
- package/dist/components/docs/generated/docs-index.generated.js +1 -1
- package/dist/components/docs/generated/index.d.ts +7 -1
- package/dist/components/docs/generated/index.js +1 -1
- package/dist/components/docs/generated/loader.js +1 -1
- package/dist/components/docs/getting-started/CLIPage.js +6 -5
- package/dist/components/docs/getting-started/CompatibilityPage.js +1 -1
- package/dist/components/docs/getting-started/DataViewTutorialPage.js +44 -67
- package/dist/components/docs/getting-started/DeveloperToolsPage.js +1 -1
- package/dist/components/docs/getting-started/HelloWorldPage.js +5 -5
- package/dist/components/docs/getting-started/InstallationPage.js +3 -3
- package/dist/components/docs/getting-started/StartHerePage.js +4 -2
- package/dist/components/docs/getting-started/TroubleshootingPage.js +2 -2
- package/dist/components/docs/getting-started/VSCodeExtensionPage.js +1 -1
- package/dist/components/docs/getting-started/getting-started.docblocks.js +2 -2
- package/dist/components/docs/getting-started/index.js +60 -80
- package/dist/components/docs/guides/GuideCIDiffGatingPage.js +2 -2
- package/dist/components/docs/guides/GuideConnectInRepoPage.js +30 -5
- package/dist/components/docs/guides/GuideContractTypesPage.js +6 -6
- package/dist/components/docs/guides/GuideDocsPipelinePage.js +3 -3
- package/dist/components/docs/guides/GuideFirstModuleBundlePage.js +4 -4
- package/dist/components/docs/guides/GuideGenerateDocsClientsSchemasPage.js +2 -2
- package/dist/components/docs/guides/GuideHostBuilderWorkbenchPage.js +21 -6
- package/dist/components/docs/guides/GuideImportExistingCodebasesPage.js +8 -8
- package/dist/components/docs/guides/GuideNextjsOneEndpointPage.js +6 -6
- package/dist/components/docs/guides/GuideReleaseCapsulesPage.d.ts +1 -0
- package/dist/components/docs/guides/GuideReleaseCapsulesPage.js +16 -0
- package/dist/components/docs/guides/GuideSpecValidationTypingPage.js +4 -4
- package/dist/components/docs/guides/GuidesIndexPage.js +2 -2
- package/dist/components/docs/guides/index.d.ts +1 -0
- package/dist/components/docs/guides/index.js +93 -39
- package/dist/components/docs/index.js +690 -419
- package/dist/components/docs/integrations/IntegrationsCircuitBreakersPage.js +2 -2
- package/dist/components/docs/integrations/IntegrationsElevenLabsPage.js +3 -3
- package/dist/components/docs/integrations/IntegrationsGithubPage.js +2 -2
- package/dist/components/docs/integrations/IntegrationsGmailPage.js +3 -3
- package/dist/components/docs/integrations/IntegrationsGoogleCalendarPage.js +3 -3
- package/dist/components/docs/integrations/IntegrationsHealthRoutingPage.js +2 -2
- package/dist/components/docs/integrations/IntegrationsMistralPage.js +2 -2
- package/dist/components/docs/integrations/IntegrationsOpenAIPage.js +2 -2
- package/dist/components/docs/integrations/IntegrationsOverviewPage.js +1 -1
- package/dist/components/docs/integrations/IntegrationsPostmarkPage.js +2 -2
- package/dist/components/docs/integrations/IntegrationsPowensPage.js +2 -2
- package/dist/components/docs/integrations/IntegrationsQdrantPage.js +5 -5
- package/dist/components/docs/integrations/IntegrationsResendPage.js +3 -3
- package/dist/components/docs/integrations/IntegrationsS3Page.js +4 -4
- package/dist/components/docs/integrations/IntegrationsSlackPage.js +2 -2
- package/dist/components/docs/integrations/IntegrationsSpecModelPage.js +2 -2
- package/dist/components/docs/integrations/IntegrationsStripePage.js +2 -2
- package/dist/components/docs/integrations/IntegrationsTwilioPage.js +3 -3
- package/dist/components/docs/integrations/IntegrationsWhatsappMetaPage.js +2 -2
- package/dist/components/docs/integrations/IntegrationsWhatsappTwilioPage.js +2 -2
- package/dist/components/docs/integrations/index.js +39 -39
- package/dist/components/docs/intent/ContractFirstApiPage.js +2 -2
- package/dist/components/docs/intent/DeterministicCodegenPage.js +2 -2
- package/dist/components/docs/intent/GenerateClientFromSchemaPage.js +7 -7
- package/dist/components/docs/intent/OpenapiAlternativePage.js +3 -3
- package/dist/components/docs/intent/SchemaValidationTypescriptPage.js +4 -4
- package/dist/components/docs/intent/SpecDrivenDevelopmentPage.js +2 -2
- package/dist/components/docs/intent/index.js +15 -15
- package/dist/components/docs/intent/intent-pages.docblocks.js +1 -1
- package/dist/components/docs/knowledge/KnowledgeCategoriesPage.js +2 -2
- package/dist/components/docs/knowledge/KnowledgeExamplesPage.js +2 -2
- package/dist/components/docs/knowledge/KnowledgeOverviewPage.js +1 -1
- package/dist/components/docs/knowledge/KnowledgeSourcesPage.js +2 -2
- package/dist/components/docs/knowledge/KnowledgeSpacesPage.js +2 -2
- package/dist/components/docs/knowledge/index.js +5 -5
- package/dist/components/docs/libraries/LibrariesAccessibilityPage.js +3 -3
- package/dist/components/docs/libraries/LibrariesAiAgentPage.js +3 -3
- package/dist/components/docs/libraries/LibrariesAnalyticsPage.js +4 -4
- package/dist/components/docs/libraries/LibrariesContentGenPage.js +2 -2
- package/dist/components/docs/libraries/LibrariesContractsPage.js +43 -18
- package/dist/components/docs/libraries/LibrariesCostTrackingPage.js +3 -3
- package/dist/components/docs/libraries/LibrariesCrossPlatformUIPage.content.d.ts +67 -0
- package/dist/components/docs/libraries/LibrariesCrossPlatformUIPage.content.js +86 -0
- package/dist/components/docs/libraries/LibrariesCrossPlatformUIPage.d.ts +1 -0
- package/dist/components/docs/libraries/LibrariesCrossPlatformUIPage.js +86 -0
- package/dist/components/docs/libraries/LibrariesDataBackendPage.js +2 -2
- package/dist/components/docs/libraries/LibrariesDataViewsPage.js +3 -3
- package/dist/components/docs/libraries/LibrariesDesignSystemPage.js +77 -29
- package/dist/components/docs/libraries/LibrariesEvolutionPage.js +4 -4
- package/dist/components/docs/libraries/LibrariesGraphQLPage.js +2 -2
- package/dist/components/docs/libraries/LibrariesGrowthPage.js +3 -3
- package/dist/components/docs/libraries/LibrariesMultiTenancyPage.js +3 -3
- package/dist/components/docs/libraries/LibrariesObservabilityPage.js +5 -5
- package/dist/components/docs/libraries/LibrariesOverlayEnginePage.js +4 -4
- package/dist/components/docs/libraries/LibrariesOverviewPage.js +1 -1
- package/dist/components/docs/libraries/LibrariesPersonalizationPage.js +4 -4
- package/dist/components/docs/libraries/LibrariesProgressiveDeliveryPage.js +3 -3
- package/dist/components/docs/libraries/LibrariesResiliencePage.js +4 -4
- package/dist/components/docs/libraries/LibrariesRuntimePage.js +2 -2
- package/dist/components/docs/libraries/LibrariesSLOPage.js +3 -3
- package/dist/components/docs/libraries/LibrariesSchemaPage.js +3 -3
- package/dist/components/docs/libraries/LibrariesSupportBotPage.js +3 -3
- package/dist/components/docs/libraries/LibrariesTestingPage.js +3 -3
- package/dist/components/docs/libraries/LibrariesUIKitPage.js +42 -16
- package/dist/components/docs/libraries/LibrariesUIKitWebPage.d.ts +1 -0
- package/dist/components/docs/libraries/LibrariesUIKitWebPage.js +47 -0
- package/dist/components/docs/libraries/LibrariesWorkflowComposerPage.js +3 -3
- package/dist/components/docs/libraries/LibrariesWorkflowsPage.js +2 -2
- package/dist/components/docs/libraries/index.d.ts +2 -0
- package/dist/components/docs/libraries/index.js +338 -110
- package/dist/components/docs/manifesto/ManifestoPage.js +1 -1
- package/dist/components/docs/ops/AutoEvolutionOpsPage.js +2 -2
- package/dist/components/docs/ops/DistributedTracingOpsPage.js +2 -2
- package/dist/components/docs/ops/index.js +3 -3
- package/dist/components/docs/ops/ops-lifecycle.docblocks.js +2 -2
- package/dist/components/docs/ops/ops-runbooks-a.docblocks.js +2 -2
- package/dist/components/docs/ops/ops-runbooks-b.docblocks.js +2 -2
- package/dist/components/docs/ops/ops-slo-tenant.docblocks.js +2 -2
- package/dist/components/docs/ops/ops-top.docs.js +2 -2
- package/dist/components/docs/ops/ops.docs.js +6 -6
- package/dist/components/docs/product/product.docblocks.js +2 -2
- package/dist/components/docs/reference/DocsMarkdownContent.js +2 -2
- package/dist/components/docs/reference/DocsReferenceContent.js +3 -3
- package/dist/components/docs/reference/DocsReferenceIndexClient.js +2 -2
- package/dist/components/docs/reference/DocsReferenceIndexPage.js +2 -2
- package/dist/components/docs/reference/DocsReferencePage.js +3 -3
- package/dist/components/docs/reference/docsMarkdownParser.js +2 -2
- package/dist/components/docs/reference/index.js +4 -4
- package/dist/components/docs/safety/SafetyAuditingPage.js +2 -2
- package/dist/components/docs/safety/SafetyMigrationsPage.js +2 -2
- package/dist/components/docs/safety/SafetyOverviewPage.js +1 -1
- package/dist/components/docs/safety/SafetyPDPPage.js +2 -2
- package/dist/components/docs/safety/SafetySecurityTrustPage.js +1 -1
- package/dist/components/docs/safety/SafetySigningPage.js +3 -3
- package/dist/components/docs/safety/SafetyTenantIsolationPage.js +2 -2
- package/dist/components/docs/safety/index.js +7 -7
- package/dist/components/docs/shared/StudioPrompt.js +1 -1
- package/dist/components/docs/specs/SpecsBuilderControlPlanePage.js +18 -3
- package/dist/components/docs/specs/SpecsCapabilitiesPage.js +2 -2
- package/dist/components/docs/specs/SpecsConnectPage.js +4 -2
- package/dist/components/docs/specs/SpecsDataViewsPage.js +39 -32
- package/dist/components/docs/specs/SpecsModuleBundlesPage.js +3 -3
- package/dist/components/docs/specs/SpecsOverlaysPage.js +2 -2
- package/dist/components/docs/specs/SpecsOverviewPage.js +1 -1
- package/dist/components/docs/specs/SpecsPolicyPage.js +3 -3
- package/dist/components/docs/specs/SpecsWorkflowsPage.js +2 -2
- package/dist/components/docs/specs/index.js +66 -42
- package/dist/components/docs/studio/StudioBYOKPage.js +1 -1
- package/dist/components/docs/studio/StudioDeploymentsPage.js +1 -1
- package/dist/components/docs/studio/StudioGettingStartedPage.js +1 -1
- package/dist/components/docs/studio/StudioIntegrationsPage.js +1 -1
- package/dist/components/docs/studio/StudioOverviewPage.js +1 -1
- package/dist/components/docs/studio/StudioVisualBuilderPage.js +1 -1
- package/dist/components/docs/studio/index.js +1 -1
- package/dist/components/docs/tech/contracts/tech-docs.docblocks.js +2 -2
- package/dist/components/integrations/index.js +2 -2
- package/dist/components/integrations/molecules/IntegrationCard.js +1 -1
- package/dist/components/integrations/organisms/IntegrationMarketplace.js +1 -1
- package/dist/components/integrations/organisms/IntegrationSettings.js +2 -2
- package/dist/components/integrations/organisms/KnowledgeSourceList.js +1 -1
- package/dist/components/legal/PrivacyTemplate.js +1 -1
- package/dist/components/legal/TermsTemplate.js +1 -1
- package/dist/components/legal/index.js +1 -1
- package/dist/components/shared/FeatureGateNotice.js +1 -1
- package/dist/components/shared/index.js +1 -1
- package/dist/components/shell/WorkspaceHeader.js +1 -1
- package/dist/components/shell/WorkspaceProjectShellLayout.js +1 -1
- package/dist/components/shell/WorkspaceShellRenderer.js +1 -1
- package/dist/components/shell/WorkspaceSidebar.js +1 -1
- package/dist/components/shell/index.js +1 -1
- package/dist/components/templates/engine/index.js +1 -1
- package/dist/components/templates/index.js +11 -11
- package/dist/components/templates/messaging/ConversationList.js +2 -2
- package/dist/components/templates/messaging/MessageComposer.js +4 -4
- package/dist/components/templates/messaging/MessageThread.js +3 -3
- package/dist/components/templates/messaging/MessagingWorkspace.js +5 -5
- package/dist/components/templates/messaging/index.js +5 -5
- package/dist/components/templates/recipes/LanguageSwitcher.js +1 -1
- package/dist/components/templates/recipes/RecipeCard.js +1 -1
- package/dist/components/templates/recipes/RecipeDetail.js +1 -1
- package/dist/components/templates/recipes/RecipeList.js +3 -3
- package/dist/components/templates/recipes/index.js +3 -3
- package/dist/components/templates/todos/FilterBar.js +1 -1
- package/dist/components/templates/todos/TaskForm.js +2 -2
- package/dist/components/templates/todos/TaskItem.js +1 -1
- package/dist/components/templates/todos/TaskList.js +5 -5
- package/dist/components/templates/todos/index.js +5 -5
- package/dist/config/contractspec-blueprint.js +1 -1
- package/dist/config/contractspec-branding.js +1 -1
- package/dist/config/contractspec-routes.js +1 -1
- package/dist/config/index.js +1 -1
- package/dist/features/contracts-registry.js +1 -1
- package/dist/features/docs/docs.contracts.js +1 -1
- package/dist/features/docs/index.js +1 -1
- package/dist/features/docs.feature.js +1 -1
- package/dist/features/index.js +1 -1
- package/dist/features/mcp.feature.js +1 -1
- package/dist/features/presentations.feature.js +1 -1
- package/dist/features/registry.js +1 -1
- package/dist/index.d.ts +1 -0
- package/dist/index.js +701 -430
- package/dist/infrastructure/elysia/index.js +1 -1
- package/dist/infrastructure/elysia/logger.js +1 -1
- package/dist/infrastructure/index.js +1 -1
- package/dist/libs/email/client.js +1 -1
- package/dist/libs/email/contact.js +3 -3
- package/dist/libs/email/newsletter.js +3 -3
- package/dist/libs/email/utils.js +2 -2
- package/dist/libs/email/waitlist-application.js +3 -3
- package/dist/libs/email/waitlist.js +3 -3
- package/dist/libs/email.js +6 -6
- package/dist/libs/posthog/client.js +1 -1
- package/dist/libs/posthog/native.js +1 -1
- package/dist/libs/posthog/server.js +1 -1
- package/dist/libs/pricing-examples.js +1 -1
- package/dist/node/application/context-storage/index.js +1 -1
- package/dist/node/application/index.js +11 -11
- package/dist/node/application/mcp/cliMcp.js +6 -6
- package/dist/node/application/mcp/cliMcp.onboarding.js +1 -0
- package/dist/node/application/mcp/common.js +1 -1
- package/dist/node/application/mcp/contractsMcp.js +2 -2
- package/dist/node/application/mcp/contractsMcpAdoptionTools.js +1 -0
- package/dist/node/application/mcp/contractsMcpResources.js +2 -2
- package/dist/node/application/mcp/contractsMcpTools.js +1 -1
- package/dist/node/application/mcp/docsMcp.catalog.js +2 -2
- package/dist/node/application/mcp/docsMcp.data.js +1 -1
- package/dist/node/application/mcp/docsMcp.js +3 -3
- package/dist/node/application/mcp/docsMcp.prompts.js +3 -3
- package/dist/node/application/mcp/docsMcp.reference.js +2 -2
- package/dist/node/application/mcp/docsMcp.resources.js +2 -2
- package/dist/node/application/mcp/docsMcp.tools.js +2 -2
- package/dist/node/application/mcp/index.js +11 -11
- package/dist/node/application/mcp/internalMcp.js +2 -2
- package/dist/node/application/mcp/normalizeMcpRequest.js +1 -1
- package/dist/node/application/mcp/providerRankingMcp.js +1 -1
- package/dist/node/bundles/LibraryBundle.js +1 -1
- package/dist/node/bundles/index.js +1 -1
- package/dist/node/components/docs/DocsIndexPage.js +2 -2
- package/dist/node/components/docs/advanced/AdvancedMCPPage.js +3 -3
- package/dist/node/components/docs/advanced/AdvancedOverlayEditorPage.js +1 -1
- package/dist/node/components/docs/advanced/AdvancedRenderersPage.js +2 -2
- package/dist/node/components/docs/advanced/AdvancedSpecExperimentsPage.js +4 -4
- package/dist/node/components/docs/advanced/AdvancedTelemetryPage.js +2 -2
- package/dist/node/components/docs/advanced/AdvancedWorkflowMonitoringPage.js +2 -2
- package/dist/node/components/docs/advanced/index.js +9 -9
- package/dist/node/components/docs/architecture/ArchitectureAppConfigPage.js +6 -6
- package/dist/node/components/docs/architecture/ArchitectureControlPlanePage.js +3 -3
- package/dist/node/components/docs/architecture/ArchitectureIntegrationBindingPage.js +7 -7
- package/dist/node/components/docs/architecture/ArchitectureKnowledgeBindingPage.js +6 -6
- package/dist/node/components/docs/architecture/ArchitectureMultiTenancyPage.js +2 -2
- package/dist/node/components/docs/architecture/ArchitectureOverviewPage.js +1 -1
- package/dist/node/components/docs/architecture/index.js +20 -20
- package/dist/node/components/docs/comparison/ComparisonAutomationPlatformsPage.js +1 -1
- package/dist/node/components/docs/comparison/ComparisonEnterprisePlatformsPage.js +1 -1
- package/dist/node/components/docs/comparison/ComparisonInternalToolBuildersPage.js +1 -1
- package/dist/node/components/docs/comparison/ComparisonOverviewPage.js +1 -1
- package/dist/node/components/docs/comparison/ComparisonWindmillPage.js +1 -1
- package/dist/node/components/docs/comparison/ComparisonWorkflowEnginesPage.js +1 -1
- package/dist/node/components/docs/comparison/index.js +1 -1
- package/dist/node/components/docs/docsManifest.js +1 -1
- package/dist/node/components/docs/ecosystem/IntegrationsPage.js +2 -2
- package/dist/node/components/docs/ecosystem/PluginsPage.js +4 -4
- package/dist/node/components/docs/ecosystem/RegistryPage.js +4 -4
- package/dist/node/components/docs/ecosystem/TemplatesPage.js +3 -3
- package/dist/node/components/docs/ecosystem/index.js +11 -11
- package/dist/node/components/docs/examples/DocsExamplesPage.js +1 -17
- package/dist/node/components/docs/examples/ExampleShowcasePage.js +2 -17
- package/dist/node/components/docs/examples/exampleShowcaseData.js +2 -17
- package/dist/node/components/docs/examples/index.js +2 -17
- package/dist/node/components/docs/generated/docs-index.generated.js +1 -1
- package/dist/node/components/docs/generated/index.js +1 -1
- package/dist/node/components/docs/generated/loader.js +1 -1
- package/dist/node/components/docs/getting-started/CLIPage.js +6 -5
- package/dist/node/components/docs/getting-started/CompatibilityPage.js +1 -1
- package/dist/node/components/docs/getting-started/DataViewTutorialPage.js +44 -67
- package/dist/node/components/docs/getting-started/DeveloperToolsPage.js +1 -1
- package/dist/node/components/docs/getting-started/HelloWorldPage.js +5 -5
- package/dist/node/components/docs/getting-started/InstallationPage.js +3 -3
- package/dist/node/components/docs/getting-started/StartHerePage.js +4 -2
- package/dist/node/components/docs/getting-started/TroubleshootingPage.js +2 -2
- package/dist/node/components/docs/getting-started/VSCodeExtensionPage.js +1 -1
- package/dist/node/components/docs/getting-started/getting-started.docblocks.js +2 -2
- package/dist/node/components/docs/getting-started/index.js +60 -80
- package/dist/node/components/docs/guides/GuideCIDiffGatingPage.js +2 -2
- package/dist/node/components/docs/guides/GuideConnectInRepoPage.js +30 -5
- package/dist/node/components/docs/guides/GuideContractTypesPage.js +6 -6
- package/dist/node/components/docs/guides/GuideDocsPipelinePage.js +3 -3
- package/dist/node/components/docs/guides/GuideFirstModuleBundlePage.js +4 -4
- package/dist/node/components/docs/guides/GuideGenerateDocsClientsSchemasPage.js +2 -2
- package/dist/node/components/docs/guides/GuideHostBuilderWorkbenchPage.js +21 -6
- package/dist/node/components/docs/guides/GuideImportExistingCodebasesPage.js +8 -8
- package/dist/node/components/docs/guides/GuideNextjsOneEndpointPage.js +6 -6
- package/dist/node/components/docs/guides/GuideReleaseCapsulesPage.js +15 -0
- package/dist/node/components/docs/guides/GuideSpecValidationTypingPage.js +4 -4
- package/dist/node/components/docs/guides/GuidesIndexPage.js +2 -2
- package/dist/node/components/docs/guides/index.js +93 -39
- package/dist/node/components/docs/index.js +690 -419
- package/dist/node/components/docs/integrations/IntegrationsCircuitBreakersPage.js +2 -2
- package/dist/node/components/docs/integrations/IntegrationsElevenLabsPage.js +3 -3
- package/dist/node/components/docs/integrations/IntegrationsGithubPage.js +2 -2
- package/dist/node/components/docs/integrations/IntegrationsGmailPage.js +3 -3
- package/dist/node/components/docs/integrations/IntegrationsGoogleCalendarPage.js +3 -3
- package/dist/node/components/docs/integrations/IntegrationsHealthRoutingPage.js +2 -2
- package/dist/node/components/docs/integrations/IntegrationsMistralPage.js +2 -2
- package/dist/node/components/docs/integrations/IntegrationsOpenAIPage.js +2 -2
- package/dist/node/components/docs/integrations/IntegrationsOverviewPage.js +1 -1
- package/dist/node/components/docs/integrations/IntegrationsPostmarkPage.js +2 -2
- package/dist/node/components/docs/integrations/IntegrationsPowensPage.js +2 -2
- package/dist/node/components/docs/integrations/IntegrationsQdrantPage.js +5 -5
- package/dist/node/components/docs/integrations/IntegrationsResendPage.js +3 -3
- package/dist/node/components/docs/integrations/IntegrationsS3Page.js +4 -4
- package/dist/node/components/docs/integrations/IntegrationsSlackPage.js +2 -2
- package/dist/node/components/docs/integrations/IntegrationsSpecModelPage.js +2 -2
- package/dist/node/components/docs/integrations/IntegrationsStripePage.js +2 -2
- package/dist/node/components/docs/integrations/IntegrationsTwilioPage.js +3 -3
- package/dist/node/components/docs/integrations/IntegrationsWhatsappMetaPage.js +2 -2
- package/dist/node/components/docs/integrations/IntegrationsWhatsappTwilioPage.js +2 -2
- package/dist/node/components/docs/integrations/index.js +39 -39
- package/dist/node/components/docs/intent/ContractFirstApiPage.js +2 -2
- package/dist/node/components/docs/intent/DeterministicCodegenPage.js +2 -2
- package/dist/node/components/docs/intent/GenerateClientFromSchemaPage.js +7 -7
- package/dist/node/components/docs/intent/OpenapiAlternativePage.js +3 -3
- package/dist/node/components/docs/intent/SchemaValidationTypescriptPage.js +4 -4
- package/dist/node/components/docs/intent/SpecDrivenDevelopmentPage.js +2 -2
- package/dist/node/components/docs/intent/index.js +15 -15
- package/dist/node/components/docs/intent/intent-pages.docblocks.js +1 -1
- package/dist/node/components/docs/knowledge/KnowledgeCategoriesPage.js +2 -2
- package/dist/node/components/docs/knowledge/KnowledgeExamplesPage.js +2 -2
- package/dist/node/components/docs/knowledge/KnowledgeOverviewPage.js +1 -1
- package/dist/node/components/docs/knowledge/KnowledgeSourcesPage.js +2 -2
- package/dist/node/components/docs/knowledge/KnowledgeSpacesPage.js +2 -2
- package/dist/node/components/docs/knowledge/index.js +5 -5
- package/dist/node/components/docs/libraries/LibrariesAccessibilityPage.js +3 -3
- package/dist/node/components/docs/libraries/LibrariesAiAgentPage.js +3 -3
- package/dist/node/components/docs/libraries/LibrariesAnalyticsPage.js +4 -4
- package/dist/node/components/docs/libraries/LibrariesContentGenPage.js +2 -2
- package/dist/node/components/docs/libraries/LibrariesContractsPage.js +43 -18
- package/dist/node/components/docs/libraries/LibrariesCostTrackingPage.js +3 -3
- package/dist/node/components/docs/libraries/LibrariesCrossPlatformUIPage.content.js +85 -0
- package/dist/node/components/docs/libraries/LibrariesCrossPlatformUIPage.js +85 -0
- package/dist/node/components/docs/libraries/LibrariesDataBackendPage.js +2 -2
- package/dist/node/components/docs/libraries/LibrariesDataViewsPage.js +3 -3
- package/dist/node/components/docs/libraries/LibrariesDesignSystemPage.js +77 -29
- package/dist/node/components/docs/libraries/LibrariesEvolutionPage.js +4 -4
- package/dist/node/components/docs/libraries/LibrariesGraphQLPage.js +2 -2
- package/dist/node/components/docs/libraries/LibrariesGrowthPage.js +3 -3
- package/dist/node/components/docs/libraries/LibrariesMultiTenancyPage.js +3 -3
- package/dist/node/components/docs/libraries/LibrariesObservabilityPage.js +5 -5
- package/dist/node/components/docs/libraries/LibrariesOverlayEnginePage.js +4 -4
- package/dist/node/components/docs/libraries/LibrariesOverviewPage.js +1 -1
- package/dist/node/components/docs/libraries/LibrariesPersonalizationPage.js +4 -4
- package/dist/node/components/docs/libraries/LibrariesProgressiveDeliveryPage.js +3 -3
- package/dist/node/components/docs/libraries/LibrariesResiliencePage.js +4 -4
- package/dist/node/components/docs/libraries/LibrariesRuntimePage.js +2 -2
- package/dist/node/components/docs/libraries/LibrariesSLOPage.js +3 -3
- package/dist/node/components/docs/libraries/LibrariesSchemaPage.js +3 -3
- package/dist/node/components/docs/libraries/LibrariesSupportBotPage.js +3 -3
- package/dist/node/components/docs/libraries/LibrariesTestingPage.js +3 -3
- package/dist/node/components/docs/libraries/LibrariesUIKitPage.js +42 -16
- package/dist/node/components/docs/libraries/LibrariesUIKitWebPage.js +46 -0
- package/dist/node/components/docs/libraries/LibrariesWorkflowComposerPage.js +3 -3
- package/dist/node/components/docs/libraries/LibrariesWorkflowsPage.js +2 -2
- package/dist/node/components/docs/libraries/index.js +338 -110
- package/dist/node/components/docs/manifesto/ManifestoPage.js +1 -1
- package/dist/node/components/docs/ops/AutoEvolutionOpsPage.js +2 -2
- package/dist/node/components/docs/ops/DistributedTracingOpsPage.js +2 -2
- package/dist/node/components/docs/ops/index.js +3 -3
- package/dist/node/components/docs/ops/ops-lifecycle.docblocks.js +2 -2
- package/dist/node/components/docs/ops/ops-runbooks-a.docblocks.js +2 -2
- package/dist/node/components/docs/ops/ops-runbooks-b.docblocks.js +2 -2
- package/dist/node/components/docs/ops/ops-slo-tenant.docblocks.js +2 -2
- package/dist/node/components/docs/ops/ops-top.docs.js +2 -2
- package/dist/node/components/docs/ops/ops.docs.js +6 -6
- package/dist/node/components/docs/product/product.docblocks.js +2 -2
- package/dist/node/components/docs/reference/DocsMarkdownContent.js +2 -2
- package/dist/node/components/docs/reference/DocsReferenceContent.js +3 -3
- package/dist/node/components/docs/reference/DocsReferenceIndexClient.js +2 -2
- package/dist/node/components/docs/reference/DocsReferenceIndexPage.js +2 -2
- package/dist/node/components/docs/reference/DocsReferencePage.js +3 -3
- package/dist/node/components/docs/reference/docsMarkdownParser.js +2 -2
- package/dist/node/components/docs/reference/index.js +4 -4
- package/dist/node/components/docs/safety/SafetyAuditingPage.js +2 -2
- package/dist/node/components/docs/safety/SafetyMigrationsPage.js +2 -2
- package/dist/node/components/docs/safety/SafetyOverviewPage.js +1 -1
- package/dist/node/components/docs/safety/SafetyPDPPage.js +2 -2
- package/dist/node/components/docs/safety/SafetySecurityTrustPage.js +1 -1
- package/dist/node/components/docs/safety/SafetySigningPage.js +3 -3
- package/dist/node/components/docs/safety/SafetyTenantIsolationPage.js +2 -2
- package/dist/node/components/docs/safety/index.js +7 -7
- package/dist/node/components/docs/shared/StudioPrompt.js +1 -1
- package/dist/node/components/docs/specs/SpecsBuilderControlPlanePage.js +18 -3
- package/dist/node/components/docs/specs/SpecsCapabilitiesPage.js +2 -2
- package/dist/node/components/docs/specs/SpecsConnectPage.js +4 -2
- package/dist/node/components/docs/specs/SpecsDataViewsPage.js +39 -32
- package/dist/node/components/docs/specs/SpecsModuleBundlesPage.js +3 -3
- package/dist/node/components/docs/specs/SpecsOverlaysPage.js +2 -2
- package/dist/node/components/docs/specs/SpecsOverviewPage.js +1 -1
- package/dist/node/components/docs/specs/SpecsPolicyPage.js +3 -3
- package/dist/node/components/docs/specs/SpecsWorkflowsPage.js +2 -2
- package/dist/node/components/docs/specs/index.js +66 -42
- package/dist/node/components/docs/studio/StudioBYOKPage.js +1 -1
- package/dist/node/components/docs/studio/StudioDeploymentsPage.js +1 -1
- package/dist/node/components/docs/studio/StudioGettingStartedPage.js +1 -1
- package/dist/node/components/docs/studio/StudioIntegrationsPage.js +1 -1
- package/dist/node/components/docs/studio/StudioOverviewPage.js +1 -1
- package/dist/node/components/docs/studio/StudioVisualBuilderPage.js +1 -1
- package/dist/node/components/docs/studio/index.js +1 -1
- package/dist/node/components/docs/tech/contracts/tech-docs.docblocks.js +2 -2
- package/dist/node/components/integrations/index.js +2 -2
- package/dist/node/components/integrations/molecules/IntegrationCard.js +1 -1
- package/dist/node/components/integrations/organisms/IntegrationMarketplace.js +1 -1
- package/dist/node/components/integrations/organisms/IntegrationSettings.js +2 -2
- package/dist/node/components/integrations/organisms/KnowledgeSourceList.js +1 -1
- package/dist/node/components/legal/PrivacyTemplate.js +1 -1
- package/dist/node/components/legal/TermsTemplate.js +1 -1
- package/dist/node/components/legal/index.js +1 -1
- package/dist/node/components/shared/FeatureGateNotice.js +1 -1
- package/dist/node/components/shared/index.js +1 -1
- package/dist/node/components/shell/WorkspaceHeader.js +1 -1
- package/dist/node/components/shell/WorkspaceProjectShellLayout.js +1 -1
- package/dist/node/components/shell/WorkspaceShellRenderer.js +1 -1
- package/dist/node/components/shell/WorkspaceSidebar.js +1 -1
- package/dist/node/components/shell/index.js +1 -1
- package/dist/node/components/templates/engine/index.js +1 -1
- package/dist/node/components/templates/index.js +11 -11
- package/dist/node/components/templates/messaging/ConversationList.js +2 -2
- package/dist/node/components/templates/messaging/MessageComposer.js +4 -4
- package/dist/node/components/templates/messaging/MessageThread.js +3 -3
- package/dist/node/components/templates/messaging/MessagingWorkspace.js +5 -5
- package/dist/node/components/templates/messaging/index.js +5 -5
- package/dist/node/components/templates/recipes/LanguageSwitcher.js +1 -1
- package/dist/node/components/templates/recipes/RecipeCard.js +1 -1
- package/dist/node/components/templates/recipes/RecipeDetail.js +1 -1
- package/dist/node/components/templates/recipes/RecipeList.js +3 -3
- package/dist/node/components/templates/recipes/index.js +3 -3
- package/dist/node/components/templates/todos/FilterBar.js +1 -1
- package/dist/node/components/templates/todos/TaskForm.js +2 -2
- package/dist/node/components/templates/todos/TaskItem.js +1 -1
- package/dist/node/components/templates/todos/TaskList.js +5 -5
- package/dist/node/components/templates/todos/index.js +5 -5
- package/dist/node/config/contractspec-blueprint.js +1 -1
- package/dist/node/config/contractspec-branding.js +1 -1
- package/dist/node/config/contractspec-routes.js +1 -1
- package/dist/node/config/index.js +1 -1
- package/dist/node/features/contracts-registry.js +1 -1
- package/dist/node/features/docs/docs.contracts.js +1 -1
- package/dist/node/features/docs/index.js +1 -1
- package/dist/node/features/docs.feature.js +1 -1
- package/dist/node/features/index.js +1 -1
- package/dist/node/features/mcp.feature.js +1 -1
- package/dist/node/features/presentations.feature.js +1 -1
- package/dist/node/features/registry.js +1 -1
- package/dist/node/index.js +701 -430
- package/dist/node/infrastructure/elysia/index.js +1 -1
- package/dist/node/infrastructure/elysia/logger.js +1 -1
- package/dist/node/infrastructure/index.js +1 -1
- package/dist/node/libs/email/client.js +1 -1
- package/dist/node/libs/email/contact.js +3 -3
- package/dist/node/libs/email/newsletter.js +3 -3
- package/dist/node/libs/email/utils.js +2 -2
- package/dist/node/libs/email/waitlist-application.js +3 -3
- package/dist/node/libs/email/waitlist.js +3 -3
- package/dist/node/libs/email.js +6 -6
- package/dist/node/libs/posthog/client.js +1 -1
- package/dist/node/libs/posthog/native.js +1 -1
- package/dist/node/libs/posthog/server.js +1 -1
- package/dist/node/libs/pricing-examples.js +1 -1
- package/dist/node/presentation/features/atoms/FeatureIcon/FeatureIcon.js +1 -1
- package/dist/node/presentation/features/atoms/FeatureIcon/index.js +1 -1
- package/dist/node/presentation/features/atoms/index.js +1 -1
- package/dist/node/presentation/features/hooks/index.js +1 -1
- package/dist/node/presentation/features/hooks/useContractsRegistry.js +1 -1
- package/dist/node/presentation/features/hooks/useFeatureFilters.js +1 -1
- package/dist/node/presentation/features/hooks/useFeatureRegistry.js +1 -1
- package/dist/node/presentation/features/hooks/useRelatedDocs.js +1 -1
- package/dist/node/presentation/features/index.js +1 -1
- package/dist/node/presentation/features/molecules/FeatureCard/FeatureCard.js +1 -1
- package/dist/node/presentation/features/molecules/FeatureCard/index.js +1 -1
- package/dist/node/presentation/features/molecules/FeatureCategoryHeader/FeatureCategoryHeader.js +1 -1
- package/dist/node/presentation/features/molecules/FeatureCategoryHeader/index.js +1 -1
- package/dist/node/presentation/features/molecules/FeatureFilters/FeatureFilters.js +1 -1
- package/dist/node/presentation/features/molecules/FeatureFilters/index.js +1 -1
- package/dist/node/presentation/features/molecules/FeatureHoverPreview/FeatureHoverPreview.js +1 -1
- package/dist/node/presentation/features/molecules/FeatureHoverPreview/index.js +1 -1
- package/dist/node/presentation/features/molecules/index.js +1 -1
- package/dist/node/presentation/features/organisms/FeatureDataViewsList.js +1 -1
- package/dist/node/presentation/features/organisms/FeatureDetail/FeatureDetail.js +1 -1
- package/dist/node/presentation/features/organisms/FeatureDetail/index.js +1 -1
- package/dist/node/presentation/features/organisms/FeatureDiscovery/FeatureDiscovery.js +1 -1
- package/dist/node/presentation/features/organisms/FeatureDiscovery/index.js +1 -1
- package/dist/node/presentation/features/organisms/FeatureEventsList.js +1 -1
- package/dist/node/presentation/features/organisms/FeatureFormsList.js +1 -1
- package/dist/node/presentation/features/organisms/FeatureOperationsList.js +1 -1
- package/dist/node/presentation/features/organisms/FeaturePresentationsList.js +1 -1
- package/dist/node/presentation/features/organisms/index.js +1 -1
- package/dist/node/presentation/features/templates/FeatureDataViewDetailTemplate/FeatureDataViewDetailTemplate.js +1 -1
- package/dist/node/presentation/features/templates/FeatureDataViewDetailTemplate/index.js +1 -1
- package/dist/node/presentation/features/templates/FeatureDataViewsTemplate/FeatureDataViewsTemplate.js +1 -1
- package/dist/node/presentation/features/templates/FeatureDataViewsTemplate/index.js +1 -1
- package/dist/node/presentation/features/templates/FeatureEventDetailTemplate/FeatureEventDetailTemplate.js +1 -1
- package/dist/node/presentation/features/templates/FeatureEventDetailTemplate/index.js +1 -1
- package/dist/node/presentation/features/templates/FeatureEventsTemplate/FeatureEventsTemplate.js +1 -1
- package/dist/node/presentation/features/templates/FeatureEventsTemplate/index.js +1 -1
- package/dist/node/presentation/features/templates/FeatureFormDetailTemplate/FeatureFormDetailTemplate.js +1 -1
- package/dist/node/presentation/features/templates/FeatureFormDetailTemplate/index.js +1 -1
- package/dist/node/presentation/features/templates/FeatureFormsTemplate/FeatureFormsTemplate.js +1 -1
- package/dist/node/presentation/features/templates/FeatureFormsTemplate/index.js +1 -1
- package/dist/node/presentation/features/templates/FeatureOperationDetailTemplate/FeatureOperationDetailTemplate.js +1 -1
- package/dist/node/presentation/features/templates/FeatureOperationDetailTemplate/index.js +1 -1
- package/dist/node/presentation/features/templates/FeatureOperationsTemplate/FeatureOperationsTemplate.js +1 -1
- package/dist/node/presentation/features/templates/FeatureOperationsTemplate/index.js +1 -1
- package/dist/node/presentation/features/templates/FeatureOverviewTemplate/FeatureOverviewTemplate.js +1 -1
- package/dist/node/presentation/features/templates/FeatureOverviewTemplate/index.js +1 -1
- package/dist/node/presentation/features/templates/FeaturePresentationDetailTemplate/FeaturePresentationDetailTemplate.js +1 -1
- package/dist/node/presentation/features/templates/FeaturePresentationDetailTemplate/index.js +1 -1
- package/dist/node/presentation/features/templates/FeaturePresentationsTemplate/FeaturePresentationsTemplate.js +1 -1
- package/dist/node/presentation/features/templates/FeaturePresentationsTemplate/index.js +1 -1
- package/dist/presentation/features/atoms/FeatureIcon/FeatureIcon.js +1 -1
- package/dist/presentation/features/atoms/FeatureIcon/index.js +1 -1
- package/dist/presentation/features/atoms/index.js +1 -1
- package/dist/presentation/features/hooks/index.js +1 -1
- package/dist/presentation/features/hooks/useContractsRegistry.js +1 -1
- package/dist/presentation/features/hooks/useFeatureFilters.js +1 -1
- package/dist/presentation/features/hooks/useFeatureRegistry.js +1 -1
- package/dist/presentation/features/hooks/useRelatedDocs.js +1 -1
- package/dist/presentation/features/index.js +1 -1
- package/dist/presentation/features/molecules/FeatureCard/FeatureCard.js +1 -1
- package/dist/presentation/features/molecules/FeatureCard/index.js +1 -1
- package/dist/presentation/features/molecules/FeatureCategoryHeader/FeatureCategoryHeader.js +1 -1
- package/dist/presentation/features/molecules/FeatureCategoryHeader/index.js +1 -1
- package/dist/presentation/features/molecules/FeatureFilters/FeatureFilters.js +1 -1
- package/dist/presentation/features/molecules/FeatureFilters/index.js +1 -1
- package/dist/presentation/features/molecules/FeatureHoverPreview/FeatureHoverPreview.js +1 -1
- package/dist/presentation/features/molecules/FeatureHoverPreview/index.js +1 -1
- package/dist/presentation/features/molecules/index.js +1 -1
- package/dist/presentation/features/organisms/FeatureDataViewsList.js +1 -1
- package/dist/presentation/features/organisms/FeatureDetail/FeatureDetail.js +1 -1
- package/dist/presentation/features/organisms/FeatureDetail/index.js +1 -1
- package/dist/presentation/features/organisms/FeatureDiscovery/FeatureDiscovery.js +1 -1
- package/dist/presentation/features/organisms/FeatureDiscovery/index.js +1 -1
- package/dist/presentation/features/organisms/FeatureEventsList.js +1 -1
- package/dist/presentation/features/organisms/FeatureFormsList.js +1 -1
- package/dist/presentation/features/organisms/FeatureOperationsList.js +1 -1
- package/dist/presentation/features/organisms/FeaturePresentationsList.js +1 -1
- package/dist/presentation/features/organisms/index.js +1 -1
- package/dist/presentation/features/templates/FeatureDataViewDetailTemplate/FeatureDataViewDetailTemplate.js +1 -1
- package/dist/presentation/features/templates/FeatureDataViewDetailTemplate/index.js +1 -1
- package/dist/presentation/features/templates/FeatureDataViewsTemplate/FeatureDataViewsTemplate.js +1 -1
- package/dist/presentation/features/templates/FeatureDataViewsTemplate/index.js +1 -1
- package/dist/presentation/features/templates/FeatureEventDetailTemplate/FeatureEventDetailTemplate.js +1 -1
- package/dist/presentation/features/templates/FeatureEventDetailTemplate/index.js +1 -1
- package/dist/presentation/features/templates/FeatureEventsTemplate/FeatureEventsTemplate.js +1 -1
- package/dist/presentation/features/templates/FeatureEventsTemplate/index.js +1 -1
- package/dist/presentation/features/templates/FeatureFormDetailTemplate/FeatureFormDetailTemplate.js +1 -1
- package/dist/presentation/features/templates/FeatureFormDetailTemplate/index.js +1 -1
- package/dist/presentation/features/templates/FeatureFormsTemplate/FeatureFormsTemplate.js +1 -1
- package/dist/presentation/features/templates/FeatureFormsTemplate/index.js +1 -1
- package/dist/presentation/features/templates/FeatureOperationDetailTemplate/FeatureOperationDetailTemplate.js +1 -1
- package/dist/presentation/features/templates/FeatureOperationDetailTemplate/index.js +1 -1
- package/dist/presentation/features/templates/FeatureOperationsTemplate/FeatureOperationsTemplate.js +1 -1
- package/dist/presentation/features/templates/FeatureOperationsTemplate/index.js +1 -1
- package/dist/presentation/features/templates/FeatureOverviewTemplate/FeatureOverviewTemplate.js +1 -1
- package/dist/presentation/features/templates/FeatureOverviewTemplate/index.js +1 -1
- package/dist/presentation/features/templates/FeaturePresentationDetailTemplate/FeaturePresentationDetailTemplate.js +1 -1
- package/dist/presentation/features/templates/FeaturePresentationDetailTemplate/index.js +1 -1
- package/dist/presentation/features/templates/FeaturePresentationsTemplate/FeaturePresentationsTemplate.js +1 -1
- package/dist/presentation/features/templates/FeaturePresentationsTemplate/index.js +1 -1
- package/package.json +96 -23
- package/src/application/mcp/cliMcp.onboarding.ts +297 -0
- package/src/application/mcp/cliMcp.test.ts +99 -0
- package/src/application/mcp/cliMcp.ts +30 -3
- package/src/application/mcp/contractsMcp.test.ts +65 -0
- package/src/application/mcp/contractsMcpAdoptionTools.ts +131 -0
- package/src/application/mcp/contractsMcpResources.ts +49 -0
- package/src/application/mcp/contractsMcpTools.ts +2 -0
- package/src/application/mcp/contractsMcpTypes.ts +16 -0
- package/src/bundles/LibraryBundle.ts +19 -130
- package/src/components/docs/docsManifest.test.ts +14 -0
- package/src/components/docs/docsManifest.ts +22 -0
- package/src/components/docs/examples/DocsExamplesPage.tsx +6 -14
- package/src/components/docs/examples/ExampleShowcasePage.tsx +22 -18
- package/src/components/docs/examples/exampleShowcaseData.test.ts +22 -0
- package/src/components/docs/examples/exampleShowcaseData.ts +75 -50
- package/src/components/docs/generated/docs-index._common.json +9 -1
- package/src/components/docs/generated/docs-index.ai-chat.json +1 -1
- package/src/components/docs/generated/docs-index.app-config.json +4 -4
- package/src/components/docs/generated/docs-index.data-grid-showcase.json +9 -1
- package/src/components/docs/generated/docs-index.jobs.json +1 -1
- package/src/components/docs/generated/docs-index.kb-update-pipeline.json +5 -5
- package/src/components/docs/generated/docs-index.learning-journey-crm-onboarding.json +1 -1
- package/src/components/docs/generated/docs-index.learning-journey-platform-tour.json +1 -1
- package/src/components/docs/generated/docs-index.learning-journey-registry.json +1 -1
- package/src/components/docs/generated/docs-index.learning-journey.json +27 -3
- package/src/components/docs/generated/docs-index.locale-jurisdiction-gate.json +8 -0
- package/src/components/docs/generated/docs-index.manifest.json +13 -13
- package/src/components/docs/generated/docs-index.mobile-demo-landing.json +42 -0
- package/src/components/docs/generated/docs-index.platform-agent.json +18 -2
- package/src/components/docs/generated/docs-index.platform-context.json +16 -0
- package/src/components/docs/generated/docs-index.platform-docs.json +9 -1
- package/src/components/docs/generated/docs-index.platform-provider-ranking.json +32 -0
- package/src/components/docs/generated/docs-index.wealth-snapshot.json +4 -4
- package/src/components/docs/generated/index.ts +20 -5
- package/src/components/docs/generated/loader.ts +15 -8
- package/src/components/docs/getting-started/CLIPage.tsx +10 -2
- package/src/components/docs/getting-started/CompatibilityPage.tsx +14 -0
- package/src/components/docs/getting-started/DataViewTutorialPage.tsx +63 -70
- package/src/components/docs/getting-started/StartHerePage.tsx +10 -9
- package/src/components/docs/guides/GuideConnectInRepoPage.tsx +52 -3
- package/src/components/docs/guides/GuideHostBuilderWorkbenchPage.tsx +55 -6
- package/src/components/docs/guides/GuideReleaseCapsulesPage.tsx +147 -0
- package/src/components/docs/guides/GuidesIndexPage.tsx +7 -0
- package/src/components/docs/guides/index.ts +1 -0
- package/src/components/docs/libraries/LibrariesContractsPage.tsx +72 -27
- package/src/components/docs/libraries/LibrariesCrossPlatformUIPage.content.ts +252 -0
- package/src/components/docs/libraries/LibrariesCrossPlatformUIPage.tsx +232 -0
- package/src/components/docs/libraries/LibrariesDesignSystemPage.tsx +140 -55
- package/src/components/docs/libraries/LibrariesOverviewPage.tsx +13 -1
- package/src/components/docs/libraries/LibrariesRuntimePage.tsx +15 -0
- package/src/components/docs/libraries/LibrariesUIKitPage.tsx +78 -25
- package/src/components/docs/libraries/LibrariesUIKitWebPage.tsx +129 -0
- package/src/components/docs/libraries/index.ts +2 -0
- package/src/components/docs/reference/DocsReferenceIndexPage.tsx +1 -1
- package/src/components/docs/specs/SpecsBuilderControlPlanePage.tsx +58 -3
- package/src/components/docs/specs/SpecsConnectPage.tsx +30 -0
- package/src/components/docs/specs/SpecsDataViewsPage.tsx +63 -42
- package/src/index.ts +1 -1
- package/src/components/docs/generated/docs-index.mobile-demo-tasks.json +0 -34
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
// @bun
|
|
2
|
-
|
|
2
|
+
var l=Object.defineProperty;var p=(a)=>a;function m(a,i){this[a]=p.bind(null,i)}var w=(a,i)=>{for(var s in i)l(a,s,{get:i[s],enumerable:!0,configurable:!0,set:m.bind(i,s)})};var C=(a,i)=>()=>(a&&(i=a(a=0)),i);import u from"@contractspec/lib.ui-link";import{jsx as o,jsxs as y}from"react/jsx-runtime";function n({title:a="Need the operating layer on top of OSS ContractSpec?",body:i="ContractSpec Studio helps teams turn evidence into proposed spec changes, governed delivery loops, and execution-ready task packs while keeping the open contract system as the source of truth.",ctaLabel:s="See what Studio adds",href:d="https://www.contractspec.studio/docs"}){return y("div",{className:"card-subtle space-y-3 p-6",children:[o("h3",{className:"font-semibold text-lg",children:a}),o("p",{className:"text-muted-foreground text-sm",children:i}),o(u,{href:d,className:"btn-primary",children:s})]})}import{CodeBlock as r}from"@contractspec/lib.design-system";import c from"@contractspec/lib.ui-link";import{ChevronRight as f,Globe as h,Layers as b,Shield as g,Zap as v}from"lucide-react";import{jsx as e,jsxs as t}from"react/jsx-runtime";var N=[{name:"Operations",factory:"defineCommand / defineQuery",description:"API endpoints with input/output schemas, validation, and policy.",icon:v,color:"text-blue-400"},{name:"Events",factory:"defineEvent",description:"Domain events with typed payloads and PII handling.",icon:b,color:"text-green-400"},{name:"Capabilities",factory:"defineCapability",description:"Feature groupings that link operations, events, and UIs.",icon:g,color:"text-purple-400"},{name:"Presentations",factory:"definePresentation",description:"UI specifications for rendering data and handling interactions.",icon:h,color:"text-orange-400"}];function A(){return t("div",{className:"space-y-8",children:[t("div",{className:"space-y-3",children:[e("h1",{className:"font-bold text-4xl",children:"Contract Types Overview"}),e("p",{className:"text-lg text-muted-foreground",children:"Learn about the different contract types in ContractSpec and when to use each one when you are making the system boundary explicit."})]}),t("div",{className:"card-subtle space-y-4 p-6",children:[e("h2",{className:"font-bold text-2xl",children:"Core Contract Types"}),e("div",{className:"grid gap-3 md:grid-cols-2",children:N.map((a)=>t("div",{className:"flex items-start gap-3 rounded-lg border border-white/10 p-4",children:[e(a.icon,{className:a.color,size:20}),t("div",{className:"space-y-1",children:[e("h3",{className:"font-semibold",children:a.name}),e("p",{className:"text-muted-foreground text-xs",children:a.description}),e("code",{className:"text-violet-400 text-xs",children:a.factory})]})]},a.name))})]}),t("div",{className:"space-y-6",children:[t("div",{className:"space-y-3",children:[e("h2",{className:"font-bold text-2xl",children:"1) Operations (Commands & Queries)"}),e("p",{className:"text-muted-foreground text-sm",children:"Operations are the backbone of your API. Commands mutate state, queries read state. Both have typed input/output schemas."}),e(r,{language:"typescript",filename:"src/contracts/user.operation.ts",code:`import { defineCommand, defineQuery } from "@contractspec/lib.contracts-spec";
|
|
3
3
|
import { SchemaModel, ScalarTypeEnum } from "@contractspec/lib.schema";
|
|
4
4
|
|
|
5
5
|
// Command: Mutates state (creates a user)
|
|
@@ -65,7 +65,7 @@ export const GetUserQuery = defineQuery({
|
|
|
65
65
|
}),
|
|
66
66
|
},
|
|
67
67
|
policy: { auth: "user" },
|
|
68
|
-
});`})]}),t("div",{className:"space-y-3",children:[e("h2",{className:"font-bold text-2xl",children:"2) Events"}),e("p",{className:"text-muted-foreground text-sm",children:"Events represent domain occurrences. They have typed payloads with PII field marking for compliance."}),e(
|
|
68
|
+
});`})]}),t("div",{className:"space-y-3",children:[e("h2",{className:"font-bold text-2xl",children:"2) Events"}),e("p",{className:"text-muted-foreground text-sm",children:"Events represent domain occurrences. They have typed payloads with PII field marking for compliance."}),e(r,{language:"typescript",filename:"src/contracts/user.event.ts",code:`import { defineEvent } from "@contractspec/lib.contracts-spec";
|
|
69
69
|
import { SchemaModel, ScalarTypeEnum } from "@contractspec/lib.schema";
|
|
70
70
|
|
|
71
71
|
export const UserCreatedEvent = defineEvent({
|
|
@@ -106,7 +106,7 @@ export const UserDeletedEvent = defineEvent({
|
|
|
106
106
|
reason: { type: ScalarTypeEnum.String(), isOptional: true },
|
|
107
107
|
},
|
|
108
108
|
}),
|
|
109
|
-
});`})]}),t("div",{className:"space-y-3",children:[e("h2",{className:"font-bold text-2xl",children:"3) Capabilities"}),e("p",{className:"text-muted-foreground text-sm",children:"Capabilities group related operations, events, and presentations. They define feature boundaries and dependencies."}),e(
|
|
109
|
+
});`})]}),t("div",{className:"space-y-3",children:[e("h2",{className:"font-bold text-2xl",children:"3) Capabilities"}),e("p",{className:"text-muted-foreground text-sm",children:"Capabilities group related operations, events, and presentations. They define feature boundaries and dependencies."}),e(r,{language:"typescript",filename:"src/contracts/user-management.capability.ts",code:`import { defineCapability } from "@contractspec/lib.contracts-spec";
|
|
110
110
|
|
|
111
111
|
export const UserManagementCapability = defineCapability({
|
|
112
112
|
meta: {
|
|
@@ -149,7 +149,7 @@ export const AdminUserCapability = defineCapability({
|
|
|
149
149
|
{ surface: "operation", key: "user.ban", version: "1.0.0" },
|
|
150
150
|
{ surface: "operation", key: "user.impersonate", version: "1.0.0" },
|
|
151
151
|
],
|
|
152
|
-
});`})]}),t("div",{className:"space-y-3",children:[e("h2",{className:"font-bold text-2xl",children:"4) Presentations"}),e("p",{className:"text-muted-foreground text-sm",children:"Presentations define UI specifications. They link to capabilities and specify how data should be displayed."}),e(
|
|
152
|
+
});`})]}),t("div",{className:"space-y-3",children:[e("h2",{className:"font-bold text-2xl",children:"4) Presentations"}),e("p",{className:"text-muted-foreground text-sm",children:"Presentations define UI specifications. They link to capabilities and specify how data should be displayed."}),e(r,{language:"typescript",filename:"src/contracts/user-list.presentation.ts",code:`import { definePresentation } from "@contractspec/lib.contracts-spec";
|
|
153
153
|
|
|
154
154
|
export const UserListPresentation = definePresentation({
|
|
155
155
|
meta: {
|
|
@@ -171,7 +171,7 @@ export const UserListPresentation = definePresentation({
|
|
|
171
171
|
pagination: { defaultPageSize: 25 },
|
|
172
172
|
search: { fields: ["name", "email"] },
|
|
173
173
|
},
|
|
174
|
-
});`})]}),t("div",{className:"space-y-3",children:[e("h2",{className:"font-bold text-2xl",children:"5) Additional Contract Types"}),e("p",{className:"text-muted-foreground text-sm",children:"ContractSpec provides specialized contracts for different concerns:"}),t("div",{className:"grid gap-4 md:grid-cols-2",children:[t("div",{className:"card-subtle space-y-2 p-4",children:[e("h3",{className:"font-semibold",children:"Policy"}),e("code",{className:"text-violet-400 text-xs",children:"definePolicy"}),e("p",{className:"text-muted-foreground text-xs",children:"RBAC/ABAC rules, rate limits, and access control."})]}),t("div",{className:"card-subtle space-y-2 p-4",children:[e("h3",{className:"font-semibold",children:"Workflow"}),e("code",{className:"text-violet-400 text-xs",children:"defineWorkflow"}),e("p",{className:"text-muted-foreground text-xs",children:"Multi-step processes with states, transitions, and SLAs."})]}),t("div",{className:"card-subtle space-y-2 p-4",children:[e("h3",{className:"font-semibold",children:"Translation"}),e("code",{className:"text-violet-400 text-xs",children:"defineTranslation"}),e("p",{className:"text-muted-foreground text-xs",children:"i18n messages with ICU format and locale fallbacks."})]}),t("div",{className:"card-subtle space-y-2 p-4",children:[e("h3",{className:"font-semibold",children:"Integration"}),e("code",{className:"text-violet-400 text-xs",children:"defineIntegration"}),e("p",{className:"text-muted-foreground text-xs",children:"External service connections and API adapters."})]}),t("div",{className:"card-subtle space-y-2 p-4",children:[e("h3",{className:"font-semibold",children:"Form"}),e("code",{className:"text-violet-400 text-xs",children:"defineFormSpec"}),e("p",{className:"text-muted-foreground text-xs",children:"Form definitions with fields, validation, and layouts."})]}),t("div",{className:"card-subtle space-y-2 p-4",children:[e("h3",{className:"font-semibold",children:"Data View"}),e("code",{className:"text-violet-400 text-xs",children:"defineDataView"}),e("p",{className:"text-muted-foreground text-xs",children:"Read-only data projections and aggregations."})]}),t("div",{className:"card-subtle space-y-2 p-4",children:[e("h3",{className:"font-semibold",children:"Feature"}),e("code",{className:"text-violet-400 text-xs",children:"defineFeature"}),e("p",{className:"text-muted-foreground text-xs",children:"Feature flags and progressive rollout configurations."})]}),t("div",{className:"card-subtle space-y-2 p-4",children:[e("h3",{className:"font-semibold",children:"Test"}),e("code",{className:"text-violet-400 text-xs",children:"defineTestSpec"}),e("p",{className:"text-muted-foreground text-xs",children:"Contract-driven test scenarios and fixtures."})]})]})]}),t("div",{className:"space-y-3",children:[e("h2",{className:"font-bold text-2xl",children:"6) Registering Contracts"}),e("p",{className:"text-muted-foreground text-sm",children:"Each contract type has a registry for lookup and validation."}),e(
|
|
174
|
+
});`})]}),t("div",{className:"space-y-3",children:[e("h2",{className:"font-bold text-2xl",children:"5) Additional Contract Types"}),e("p",{className:"text-muted-foreground text-sm",children:"ContractSpec provides specialized contracts for different concerns:"}),t("div",{className:"grid gap-4 md:grid-cols-2",children:[t("div",{className:"card-subtle space-y-2 p-4",children:[e("h3",{className:"font-semibold",children:"Policy"}),e("code",{className:"text-violet-400 text-xs",children:"definePolicy"}),e("p",{className:"text-muted-foreground text-xs",children:"RBAC/ABAC rules, rate limits, and access control."})]}),t("div",{className:"card-subtle space-y-2 p-4",children:[e("h3",{className:"font-semibold",children:"Workflow"}),e("code",{className:"text-violet-400 text-xs",children:"defineWorkflow"}),e("p",{className:"text-muted-foreground text-xs",children:"Multi-step processes with states, transitions, and SLAs."})]}),t("div",{className:"card-subtle space-y-2 p-4",children:[e("h3",{className:"font-semibold",children:"Translation"}),e("code",{className:"text-violet-400 text-xs",children:"defineTranslation"}),e("p",{className:"text-muted-foreground text-xs",children:"i18n messages with ICU format and locale fallbacks."})]}),t("div",{className:"card-subtle space-y-2 p-4",children:[e("h3",{className:"font-semibold",children:"Integration"}),e("code",{className:"text-violet-400 text-xs",children:"defineIntegration"}),e("p",{className:"text-muted-foreground text-xs",children:"External service connections and API adapters."})]}),t("div",{className:"card-subtle space-y-2 p-4",children:[e("h3",{className:"font-semibold",children:"Form"}),e("code",{className:"text-violet-400 text-xs",children:"defineFormSpec"}),e("p",{className:"text-muted-foreground text-xs",children:"Form definitions with fields, validation, and layouts."})]}),t("div",{className:"card-subtle space-y-2 p-4",children:[e("h3",{className:"font-semibold",children:"Data View"}),e("code",{className:"text-violet-400 text-xs",children:"defineDataView"}),e("p",{className:"text-muted-foreground text-xs",children:"Read-only data projections and aggregations."})]}),t("div",{className:"card-subtle space-y-2 p-4",children:[e("h3",{className:"font-semibold",children:"Feature"}),e("code",{className:"text-violet-400 text-xs",children:"defineFeature"}),e("p",{className:"text-muted-foreground text-xs",children:"Feature flags and progressive rollout configurations."})]}),t("div",{className:"card-subtle space-y-2 p-4",children:[e("h3",{className:"font-semibold",children:"Test"}),e("code",{className:"text-violet-400 text-xs",children:"defineTestSpec"}),e("p",{className:"text-muted-foreground text-xs",children:"Contract-driven test scenarios and fixtures."})]})]})]}),t("div",{className:"space-y-3",children:[e("h2",{className:"font-bold text-2xl",children:"6) Registering Contracts"}),e("p",{className:"text-muted-foreground text-sm",children:"Each contract type has a registry for lookup and validation."}),e(r,{language:"typescript",filename:"src/contracts/registry.ts",code:`import {
|
|
175
175
|
OperationSpecRegistry,
|
|
176
176
|
installOp,
|
|
177
177
|
} from "@contractspec/lib.contracts-spec/operations";
|
|
@@ -201,4 +201,4 @@ installOp(operationRegistry, GetUserQuery, async (input) => {
|
|
|
201
201
|
|
|
202
202
|
// Register events and capabilities
|
|
203
203
|
eventRegistry.register(UserCreatedEvent);
|
|
204
|
-
capabilityRegistry.register(UserManagementCapability);`})]}),t("div",{className:"card-subtle space-y-3 p-6",children:[e("h3",{className:"font-semibold text-lg",children:"Contract Type Decision Guide"}),t("table",{className:"w-full text-sm",children:[e("thead",{children:t("tr",{className:"border-white/10 border-b",children:[e("th",{className:"py-2 text-left",children:"When you need..."}),e("th",{className:"py-2 text-left",children:"Use this contract"})]})}),t("tbody",{className:"text-muted-foreground",children:[t("tr",{className:"border-white/5 border-b",children:[e("td",{className:"py-2",children:"An API endpoint that changes data"}),e("td",{className:"py-2",children:e("code",{children:"defineCommand"})})]}),t("tr",{className:"border-white/5 border-b",children:[e("td",{className:"py-2",children:"An API endpoint that reads data"}),e("td",{className:"py-2",children:e("code",{children:"defineQuery"})})]}),t("tr",{className:"border-white/5 border-b",children:[e("td",{className:"py-2",children:"Async notification of something that happened"}),e("td",{className:"py-2",children:e("code",{children:"defineEvent"})})]}),t("tr",{className:"border-white/5 border-b",children:[e("td",{className:"py-2",children:"Group related specs under a feature"}),e("td",{className:"py-2",children:e("code",{children:"defineCapability"})})]}),t("tr",{className:"border-white/5 border-b",children:[e("td",{className:"py-2",children:"Define UI rendering specifications"}),e("td",{className:"py-2",children:e("code",{children:"definePresentation"})})]}),t("tr",{className:"border-white/5 border-b",children:[e("td",{className:"py-2",children:"Access control and rate limiting"}),e("td",{className:"py-2",children:e("code",{children:"definePolicy"})})]}),t("tr",{children:[e("td",{className:"py-2",children:"Multi-step business processes"}),e("td",{className:"py-2",children:e("code",{children:"defineWorkflow"})})]})]})]})]}),e(
|
|
204
|
+
capabilityRegistry.register(UserManagementCapability);`})]}),t("div",{className:"card-subtle space-y-3 p-6",children:[e("h3",{className:"font-semibold text-lg",children:"Contract Type Decision Guide"}),t("table",{className:"w-full text-sm",children:[e("thead",{children:t("tr",{className:"border-white/10 border-b",children:[e("th",{className:"py-2 text-left",children:"When you need..."}),e("th",{className:"py-2 text-left",children:"Use this contract"})]})}),t("tbody",{className:"text-muted-foreground",children:[t("tr",{className:"border-white/5 border-b",children:[e("td",{className:"py-2",children:"An API endpoint that changes data"}),e("td",{className:"py-2",children:e("code",{children:"defineCommand"})})]}),t("tr",{className:"border-white/5 border-b",children:[e("td",{className:"py-2",children:"An API endpoint that reads data"}),e("td",{className:"py-2",children:e("code",{children:"defineQuery"})})]}),t("tr",{className:"border-white/5 border-b",children:[e("td",{className:"py-2",children:"Async notification of something that happened"}),e("td",{className:"py-2",children:e("code",{children:"defineEvent"})})]}),t("tr",{className:"border-white/5 border-b",children:[e("td",{className:"py-2",children:"Group related specs under a feature"}),e("td",{className:"py-2",children:e("code",{children:"defineCapability"})})]}),t("tr",{className:"border-white/5 border-b",children:[e("td",{className:"py-2",children:"Define UI rendering specifications"}),e("td",{className:"py-2",children:e("code",{children:"definePresentation"})})]}),t("tr",{className:"border-white/5 border-b",children:[e("td",{className:"py-2",children:"Access control and rate limiting"}),e("td",{className:"py-2",children:e("code",{children:"definePolicy"})})]}),t("tr",{children:[e("td",{className:"py-2",children:"Multi-step business processes"}),e("td",{className:"py-2",children:e("code",{children:"defineWorkflow"})})]})]})]})]}),e(n,{title:"Need to decide which contract should change next?",body:"Studio uses evidence and focus constraints to generate decision briefs, patch intents, and execution-ready task packs."})]}),t("div",{className:"flex items-center gap-4 pt-4",children:[t(c,{href:"/docs/guides/nextjs-one-endpoint",className:"btn-primary",children:["Next: Add your first endpoint ",e(f,{size:16})]}),e(c,{href:"/docs/guides",className:"btn-ghost",children:"Back to guides"})]})]})}export{A as GuideContractTypesPage};
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
// @bun
|
|
2
|
-
|
|
2
|
+
var l=Object.defineProperty;var p=(o)=>o;function u(o,a){this[o]=p.bind(null,a)}var h=(o,a)=>{for(var d in a)l(o,d,{get:a[d],enumerable:!0,configurable:!0,set:u.bind(a,d)})};var N=(o,a)=>()=>(o&&(a=o(o=0)),a);import m from"@contractspec/lib.ui-link";import{jsx as c,jsxs as g}from"react/jsx-runtime";function r({title:o="Need the operating layer on top of OSS ContractSpec?",body:a="ContractSpec Studio helps teams turn evidence into proposed spec changes, governed delivery loops, and execution-ready task packs while keeping the open contract system as the source of truth.",ctaLabel:d="See what Studio adds",href:s="https://www.contractspec.studio/docs"}){return g("div",{className:"card-subtle space-y-3 p-6",children:[c("h3",{className:"font-semibold text-lg",children:o}),c("p",{className:"text-muted-foreground text-sm",children:a}),c(m,{href:s,className:"btn-primary",children:d})]})}import{CodeBlock as n}from"@contractspec/lib.design-system";import i from"@contractspec/lib.ui-link";import{ChevronRight as f}from"lucide-react";import{jsx as e,jsxs as t}from"react/jsx-runtime";function D(){return t("div",{className:"space-y-8",children:[t("div",{className:"space-y-3",children:[e("h1",{className:"font-bold text-4xl",children:"Build the docs pipeline"}),e("p",{className:"text-lg text-muted-foreground",children:"Generate reference docs, chunk the index, and wire the docs pages the same way this repo does."})]}),t("div",{className:"card-subtle space-y-4 p-6",children:[e("h2",{className:"font-bold text-2xl",children:"What you'll build"}),t("ul",{className:"space-y-2 text-muted-foreground text-sm",children:[e("li",{children:"Generated Markdown and a chunked index manifest."}),e("li",{children:"Reference routes powered by the docs loader."}),e("li",{children:"Versioned outputs you can publish per release."})]})]}),t("div",{className:"space-y-6",children:[t("div",{className:"space-y-3",children:[e("h2",{className:"font-bold text-2xl",children:"1) Generate contract docs"}),e(n,{language:"bash",filename:"generate-contract-docs",code:"contractspec generate"}),t("p",{className:"text-muted-foreground text-sm",children:["Expected output: Markdown in ",e("code",{children:"generated/docs"}),"."]})]}),t("div",{className:"space-y-3",children:[e("h2",{className:"font-bold text-2xl",children:"2) Build the docs index"}),e(n,{language:"bash",filename:"docs-generate",code:`bun docs:generate
|
|
3
3
|
# versioned output
|
|
4
|
-
bun docs:generate -- --version v1.0.0`}),t("p",{className:"text-muted-foreground text-sm",children:["This writes ",e("code",{children:"docs-index.manifest.json"})," and chunked",e("code",{children:"docs-index.*.json"})," files in the generated docs bundle."]})]}),t("div",{className:"space-y-3",children:[e("h2",{className:"font-bold text-2xl",children:"3) Wire reference routes"}),e(
|
|
4
|
+
bun docs:generate -- --version v1.0.0`}),t("p",{className:"text-muted-foreground text-sm",children:["This writes ",e("code",{children:"docs-index.manifest.json"})," and chunked",e("code",{children:"docs-index.*.json"})," files in the generated docs bundle."]})]}),t("div",{className:"space-y-3",children:[e("h2",{className:"font-bold text-2xl",children:"3) Wire reference routes"}),e(n,{language:"tsx",filename:"docs-reference-route",code:`import { notFound } from "next/navigation";
|
|
5
5
|
import {
|
|
6
6
|
DocsReferenceIndexPage,
|
|
7
7
|
DocsReferencePage,
|
|
@@ -19,4 +19,4 @@ export default async function Page({ params }: { params: { slug?: string[] } })
|
|
|
19
19
|
const doc = await getGeneratedDocById(slug);
|
|
20
20
|
if (!doc) notFound();
|
|
21
21
|
return <DocsReferencePage entry={doc.entry} content={doc.content} />;
|
|
22
|
-
}`}),t("p",{className:"text-muted-foreground text-sm",children:["Use the index page on ",e("code",{children:"/docs/reference"})," to render the searchable list."]})]}),t("div",{className:"card-subtle space-y-3 p-6",children:[e("h3",{className:"font-semibold text-lg",children:"Repo reference"}),t("p",{className:"text-muted-foreground text-sm",children:["This repo wires docs under"," ",e("code",{children:"packages/apps/web-landing/src/app/docs/reference"}),"."]})]}),e(
|
|
22
|
+
}`}),t("p",{className:"text-muted-foreground text-sm",children:["Use the index page on ",e("code",{children:"/docs/reference"})," to render the searchable list."]})]}),t("div",{className:"card-subtle space-y-3 p-6",children:[e("h3",{className:"font-semibold text-lg",children:"Repo reference"}),t("p",{className:"text-muted-foreground text-sm",children:["This repo wires docs under"," ",e("code",{children:"packages/apps/web-landing/src/app/docs/reference"}),"."]})]}),e(r,{title:"Need decision-to-export automation?",body:"Studio exports evidence-backed spec changes and task packs to Linear, Jira, Notion, and GitHub."})]}),t("div",{className:"flex items-center gap-4 pt-4",children:[t(i,{href:"/docs/guides/ci-contract-diff-gating",className:"btn-primary",children:["Next: CI gating ",e(f,{size:16})]}),e(i,{href:"/docs/guides",className:"btn-ghost",children:"Back to guides"})]})]})}export{D as GuideDocsPipelinePage};
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
// @bun
|
|
2
|
-
import{CodeBlock as
|
|
2
|
+
var d=Object.defineProperty;var l=(a)=>a;function i(a,r){this[a]=l.bind(null,r)}var u=(a,r)=>{for(var o in r)d(a,o,{get:r[o],enumerable:!0,configurable:!0,set:i.bind(r,o)})};var p=(a,r)=>()=>(a&&(r=a(a=0)),r);import{CodeBlock as n}from"@contractspec/lib.design-system";import s from"@contractspec/lib.ui-link";import{ChevronRight as c}from"lucide-react";import{jsx as e,jsxs as t}from"react/jsx-runtime";function y(){return t("div",{className:"space-y-8",children:[t("div",{className:"space-y-3",children:[e("h1",{className:"font-bold text-4xl",children:"Build a first module bundle"}),e("p",{className:"text-lg text-muted-foreground",children:"Define one bundle spec, resolve it for a real route and preference profile, then render the resulting surface plan through the React host layer."})]}),t("div",{className:"card-subtle space-y-4 p-6",children:[e("h2",{className:"font-bold text-2xl",children:"What you'll build"}),t("ul",{className:"space-y-2 text-muted-foreground text-sm",children:[e("li",{children:"One `ModuleBundleSpec` with a route and workbench surface."}),e("li",{children:"One `ResolvedSurfacePlan` from `resolveBundle`."}),e("li",{children:"One React host using `BundleProvider` and `BundleRenderer`."})]})]}),t("div",{className:"space-y-6",children:[t("div",{className:"space-y-3",children:[e("h2",{className:"font-bold text-2xl",children:"1) Define the bundle spec"}),e("p",{className:"text-muted-foreground text-sm",children:"The bundle spec is the durable contract. It owns route selection, surface shape, layouts, data recipes, and verification coverage for all seven preference dimensions."}),e(n,{language:"typescript",filename:"src/bundles/support.workbench.bundle.ts",code:`import { defineModuleBundle } from "@contractspec/lib.surface-runtime/spec/define-module-bundle";
|
|
3
3
|
|
|
4
4
|
export const SupportWorkbenchBundle = defineModuleBundle({
|
|
5
5
|
meta: {
|
|
@@ -41,7 +41,7 @@ export const SupportWorkbenchBundle = defineModuleBundle({
|
|
|
41
41
|
},
|
|
42
42
|
},
|
|
43
43
|
},
|
|
44
|
-
});`}),e("p",{className:"text-muted-foreground text-sm",children:"Expected output: `defineModuleBundle` validates the route, surface, and verification dimensions at runtime."})]}),t("div",{className:"space-y-3",children:[e("h2",{className:"font-bold text-2xl",children:"2) Resolve the plan"}),e("p",{className:"text-muted-foreground text-sm",children:"Resolve against a real route, device, and preference profile. This is where the runtime chooses the surface, layout, bindings, and audit reasons."}),e(
|
|
44
|
+
});`}),e("p",{className:"text-muted-foreground text-sm",children:"Expected output: `defineModuleBundle` validates the route, surface, and verification dimensions at runtime."})]}),t("div",{className:"space-y-3",children:[e("h2",{className:"font-bold text-2xl",children:"2) Resolve the plan"}),e("p",{className:"text-muted-foreground text-sm",children:"Resolve against a real route, device, and preference profile. This is where the runtime chooses the surface, layout, bindings, and audit reasons."}),e(n,{language:"typescript",filename:"src/runtime/resolve-support-workbench.ts",code:`import { resolveBundle } from "@contractspec/lib.surface-runtime/runtime/resolve-bundle";
|
|
45
45
|
|
|
46
46
|
export const supportWorkbenchPlan = await resolveBundle(
|
|
47
47
|
SupportWorkbenchBundle,
|
|
@@ -65,7 +65,7 @@ export const supportWorkbenchPlan = await resolveBundle(
|
|
|
65
65
|
},
|
|
66
66
|
capabilities: ["tickets.read", "tickets.update"],
|
|
67
67
|
}
|
|
68
|
-
);`}),e("p",{className:"text-muted-foreground text-sm",children:"Expected output: a `ResolvedSurfacePlan` with `bundleKey`, `surfaceId`, `layoutId`, `bindings`, `adaptation`, and audit reasons."})]}),t("div",{className:"space-y-3",children:[e("h2",{className:"font-bold text-2xl",children:"3) Render the plan"}),e("p",{className:"text-muted-foreground text-sm",children:"The host app renders the resolved plan, not the raw spec. That keeps layout selection, overlays, and AI proposals downstream of the declared bundle contract."}),e(
|
|
68
|
+
);`}),e("p",{className:"text-muted-foreground text-sm",children:"Expected output: a `ResolvedSurfacePlan` with `bundleKey`, `surfaceId`, `layoutId`, `bindings`, `adaptation`, and audit reasons."})]}),t("div",{className:"space-y-3",children:[e("h2",{className:"font-bold text-2xl",children:"3) Render the plan"}),e("p",{className:"text-muted-foreground text-sm",children:"The host app renders the resolved plan, not the raw spec. That keeps layout selection, overlays, and AI proposals downstream of the declared bundle contract."}),e(n,{language:"tsx",filename:"src/app/support/SurfaceHost.tsx",code:`import { BundleProvider, BundleRenderer } from "@contractspec/lib.surface-runtime/react";
|
|
69
69
|
|
|
70
70
|
export function SurfaceHost() {
|
|
71
71
|
return (
|
|
@@ -73,4 +73,4 @@ export function SurfaceHost() {
|
|
|
73
73
|
<BundleRenderer assistantSlotId="assistant" />
|
|
74
74
|
</BundleProvider>
|
|
75
75
|
);
|
|
76
|
-
}`}),e("p",{className:"text-muted-foreground text-sm",children:"Expected output: the route renders according to the resolved layout root and slot plan instead of bespoke page assembly."})]}),t("div",{className:"card-subtle space-y-3 p-6",children:[e("h3",{className:"font-semibold text-lg",children:"Verification checks"}),t("ul",{className:"space-y-2 text-muted-foreground text-sm",children:[e("li",{children:"The resolved `surfaceId` matches the route you expected."}),e("li",{children:"The `layoutId` is stable for the active view and preferences."}),e("li",{children:"The plan carries audit reasons and all seven adaptation dimensions."}),e("li",{children:"Assistant or overlay work stays within declared slots."})]})]})]}),t("div",{className:"flex items-center gap-4 pt-4",children:[t(
|
|
76
|
+
}`}),e("p",{className:"text-muted-foreground text-sm",children:"Expected output: the route renders according to the resolved layout root and slot plan instead of bespoke page assembly."})]}),t("div",{className:"card-subtle space-y-3 p-6",children:[e("h3",{className:"font-semibold text-lg",children:"Verification checks"}),t("ul",{className:"space-y-2 text-muted-foreground text-sm",children:[e("li",{children:"The resolved `surfaceId` matches the route you expected."}),e("li",{children:"The `layoutId` is stable for the active view and preferences."}),e("li",{children:"The plan carries audit reasons and all seven adaptation dimensions."}),e("li",{children:"Assistant or overlay work stays within declared slots."})]})]})]}),t("div",{className:"flex items-center gap-4 pt-4",children:[t(s,{href:"/docs/specs/module-bundles",className:"btn-primary",children:["Back to module bundles ",e(c,{size:16})]}),e(s,{href:"/docs/specs/overlays",className:"btn-ghost",children:"Next: overlays"})]})]})}export{y as GuideFirstModuleBundlePage};
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
// @bun
|
|
2
|
-
|
|
2
|
+
var d=Object.defineProperty;var l=(o)=>o;function m(o,a){this[o]=l.bind(null,a)}var f=(o,a)=>{for(var r in a)d(o,r,{get:a[r],enumerable:!0,configurable:!0,set:m.bind(a,r)})};var v=(o,a)=>()=>(o&&(a=o(o=0)),a);import u from"@contractspec/lib.ui-link";import{jsx as i,jsxs as g}from"react/jsx-runtime";function n({title:o="Need the operating layer on top of OSS ContractSpec?",body:a="ContractSpec Studio helps teams turn evidence into proposed spec changes, governed delivery loops, and execution-ready task packs while keeping the open contract system as the source of truth.",ctaLabel:r="See what Studio adds",href:p="https://www.contractspec.studio/docs"}){return g("div",{className:"card-subtle space-y-3 p-6",children:[i("h3",{className:"font-semibold text-lg",children:o}),i("p",{className:"text-muted-foreground text-sm",children:a}),i(u,{href:p,className:"btn-primary",children:r})]})}import{CodeBlock as c}from"@contractspec/lib.design-system";import s from"@contractspec/lib.ui-link";import{ChevronRight as h}from"lucide-react";import{jsx as e,jsxs as t}from"react/jsx-runtime";function E(){return t("div",{className:"space-y-8",children:[t("div",{className:"space-y-3",children:[e("h1",{className:"font-bold text-4xl",children:"Generate docs + client schemas"}),e("p",{className:"text-lg text-muted-foreground",children:"Generate docs and OpenAPI output from ContractSpec operations to power SDKs, docs sites, and tooling."})]}),t("div",{className:"card-subtle space-y-4 p-6",children:[e("h2",{className:"font-bold text-2xl",children:"What you'll build"}),t("ul",{className:"space-y-2 text-muted-foreground text-sm",children:[e("li",{children:"Export docs from your specs."}),e("li",{children:"Emit OpenAPI 3.1 for client SDK generation."}),e("li",{children:"Keep outputs deterministic with CI validation."})]})]}),t("div",{className:"space-y-6",children:[t("div",{className:"space-y-3",children:[e("h2",{className:"font-bold text-2xl",children:"1) Generate docs"}),e("p",{className:"text-muted-foreground text-sm",children:"Use the generator to emit docs from your contracts."}),e(c,{language:"bash",filename:"generate-docs",code:"contractspec generate"}),t("p",{className:"text-muted-foreground text-sm",children:["Expected output: ",e("code",{children:"Generate X doc files in generated/docs"}),"."]})]}),t("div",{className:"space-y-3",children:[e("h2",{className:"font-bold text-2xl",children:"2) Export OpenAPI"}),e("p",{className:"text-muted-foreground text-sm",children:"Export an OpenAPI document from your registry module."}),e(c,{language:"bash",filename:"openapi-export",code:"contractspec openapi export --registry ./src/contracts/registry.ts --out ./generated/openapi.json"}),t("p",{className:"text-muted-foreground text-sm",children:["Expected output:"," ",e("code",{children:"OpenAPI written to .../generated/openapi.json"}),"."]})]}),t("div",{className:"space-y-3",children:[e("h2",{className:"font-bold text-2xl",children:"3) Validate specs"}),e(c,{language:"bash",filename:"validate-specs",code:"contractspec validate"}),t("p",{className:"text-muted-foreground text-sm",children:["Expected output: ",e("code",{children:"Validation passed"}),"."]})]}),t("div",{className:"card-subtle space-y-3 p-6",children:[e("h3",{className:"font-semibold text-lg",children:"Example package"}),e("p",{className:"text-muted-foreground text-sm",children:"The Integration Hub example provides a full registry of operations and is a good source for OpenAPI exports."}),e(c,{language:"bash",filename:"integration-hub-example",code:`contractspec examples show integration-hub
|
|
3
3
|
|
|
4
4
|
# openapi export against your registry module
|
|
5
|
-
contractspec openapi export --registry ./src/contracts/registry.ts --out ./generated/openapi.json`})]}),e(
|
|
5
|
+
contractspec openapi export --registry ./src/contracts/registry.ts --out ./generated/openapi.json`})]}),e(n,{title:"Want exports tied to product decisions?",body:"Studio compiles approved changes into deliverables and pushes them to your execution stack with full evidence context."})]}),t("div",{className:"flex items-center gap-4 pt-4",children:[t(s,{href:"/docs/guides/docs-generation-pipeline",className:"btn-primary",children:["Next: Docs pipeline ",e(h,{size:16})]}),e(s,{href:"/docs/guides",className:"btn-ghost",children:"Back to guides"})]})]})}export{E as GuideGenerateDocsClientsSchemasPage};
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
// @bun
|
|
2
|
-
import{CodeBlock as
|
|
2
|
+
var s=Object.defineProperty;var l=(o)=>o;function d(o,a){this[o]=l.bind(null,a)}var m=(o,a)=>{for(var n in a)s(o,n,{get:a[n],enumerable:!0,configurable:!0,set:d.bind(a,n)})};var h=(o,a)=>()=>(o&&(a=o(o=0)),a);import{CodeBlock as r}from"@contractspec/lib.design-system";import i from"@contractspec/lib.ui-link";import{ChevronRight as p}from"lucide-react";import{jsx as e,jsxs as t}from"react/jsx-runtime";var c=["builder.workspace.bootstrap","builder.channel.receiveInbound","builder.blueprint.generate","builder.plan.compile","builder.preview.create","builder.preview.runHarness","builder.export.prepare","builder.export.approve","builder.export.execute"],u=["local runtime trust and lease details","channel-action posture for mobile/operator follow-up","comparison posture and export readiness from the shared snapshot"];function k(){return t("div",{className:"space-y-8",children:[t("div",{className:"space-y-3",children:[e("h1",{className:"font-bold text-4xl",children:"Host the Builder workbench"}),e("p",{className:"text-lg text-muted-foreground",children:"Use the reusable Builder workbench as the desktop control surface for snapshot loading, guided authoring, preview, readiness, export, and mobile review handoff."})]}),t("div",{className:"card-subtle space-y-4 p-6",children:[e("h2",{className:"font-bold text-2xl",children:"What you'll build"}),t("ul",{className:"space-y-2 text-muted-foreground text-sm",children:[e("li",{children:"A workspace snapshot fetch path."}),e("li",{children:"A `BuilderWorkbench` host with action callbacks."}),e("li",{children:"Runtime-mode aware preview/export controls plus mobile review links."})]})]}),t("div",{className:"space-y-6",children:[t("div",{className:"space-y-3",children:[e("h2",{className:"font-bold text-2xl",children:"1) Fetch the workspace snapshot"}),e("p",{className:"text-muted-foreground text-sm",children:"The web shell already exposes a query path for the current Builder workspace snapshot. Your host should load it first, then refresh it after each successful command."}),e(r,{language:"typescript",filename:"builder-workbench-controller.ts",code:`export async function fetchBuilderSnapshot(workspaceId: string) {
|
|
3
3
|
const response = await fetch(
|
|
4
4
|
\`/api/operate/builder/queries/builder.workspace.snapshot?workspaceId=\${encodeURIComponent(workspaceId)}\`,
|
|
5
5
|
{ cache: "no-store" }
|
|
@@ -15,7 +15,7 @@ import{CodeBlock as o}from"@contractspec/lib.design-system";import a from"@contr
|
|
|
15
15
|
throw new Error("Builder workspace snapshot query returned an error.");
|
|
16
16
|
}
|
|
17
17
|
return payload.result;
|
|
18
|
-
}`}),e("p",{className:"text-muted-foreground text-sm",children:"Expected output: one `BuilderWorkspaceSnapshot` containing workspace, plan, providers, runtime targets, preview, export,
|
|
18
|
+
}`}),e("p",{className:"text-muted-foreground text-sm",children:"Expected output: one `BuilderWorkspaceSnapshot` containing workspace, plan, providers, runtime targets, preview, export, mobile review state, and the operator posture needed for local trust, lease, and comparison status."})]}),t("div",{className:"space-y-3",children:[e("h2",{className:"font-bold text-2xl",children:"2) Host the workbench and refresh on action"}),e("p",{className:"text-muted-foreground text-sm",children:"The simplest host pattern is local state plus a small action wrapper that executes one Builder command and then refreshes the snapshot."}),e(r,{language:"tsx",filename:"BuilderWorkbenchHost.tsx",code:`import {
|
|
19
19
|
BuilderWorkbench,
|
|
20
20
|
useBuilderWorkbenchState,
|
|
21
21
|
} from "@contractspec/module.builder-workbench/presentation";
|
|
@@ -46,14 +46,29 @@ async function runAction(commandKey: string, payload?: Record<string, unknown>)
|
|
|
46
46
|
onApproveExport={() => runAction("builder.export.approve")}
|
|
47
47
|
onExecuteExport={() => runAction("builder.export.execute")}
|
|
48
48
|
selectedExportRuntimeMode="hybrid"
|
|
49
|
-
/>;`}),e("p",{className:"text-muted-foreground text-sm",children:"Expected output: each successful action leaves the host with a fresh snapshot and keeps the workbench tabs aligned with current runtime state."})]}),t("div",{className:"space-y-3",children:[e("h2",{className:"font-bold text-2xl",children:"3)
|
|
49
|
+
/>;`}),e("p",{className:"text-muted-foreground text-sm",children:"Expected output: each successful action leaves the host with a fresh snapshot and keeps the workbench tabs aligned with current runtime state."})]}),t("div",{className:"space-y-3",children:[e("h2",{className:"font-bold text-2xl",children:"3) Persist Builder defaults in workspace config"}),e("p",{className:"text-muted-foreground text-sm",children:"The host should agree with the CLI and setup flows on the same control-plane defaults. For local or hybrid setups, keep the Builder API base URL, token env var, and local runtime metadata in `.contractsrc.json`."}),e(r,{language:"json",filename:".contractsrc.json",code:`{
|
|
50
|
+
"builder": {
|
|
51
|
+
"enabled": true,
|
|
52
|
+
"runtimeMode": "local",
|
|
53
|
+
"bootstrapPreset": "local_daemon_mvp",
|
|
54
|
+
"api": {
|
|
55
|
+
"baseUrl": "https://api.contractspec.io",
|
|
56
|
+
"controlPlaneTokenEnvVar": "CONTROL_PLANE_API_TOKEN"
|
|
57
|
+
},
|
|
58
|
+
"localRuntime": {
|
|
59
|
+
"runtimeId": "rt_local_daemon",
|
|
60
|
+
"grantedTo": "local:operator",
|
|
61
|
+
"providerIds": ["provider.codex", "provider.local.model"]
|
|
62
|
+
}
|
|
63
|
+
}
|
|
64
|
+
}`})]}),t("div",{className:"space-y-3",children:[e("h2",{className:"font-bold text-2xl",children:"4) Bootstrap providers and routing policy explicitly"}),e("p",{className:"text-muted-foreground text-sm",children:"Builder v3 treats provider routing as policy, not heuristic. Use the workspace bootstrap command as the single managed-first setup path instead of orchestrating provider registration in the app shell."}),e(r,{language:"typescript",filename:"builder-bootstrap.ts",code:`await executeBuilderCommand({
|
|
50
65
|
commandKey: "builder.workspace.bootstrap",
|
|
51
66
|
workspaceId,
|
|
52
67
|
payload: {
|
|
53
68
|
preset: "managed_mvp",
|
|
54
69
|
includeLocalHelperProvider: true,
|
|
55
70
|
},
|
|
56
|
-
});`})]}),t("div",{className:"card-subtle space-y-3 p-6",children:[e("h3",{className:"font-semibold text-lg",children:"Common command keys"}),e("ul",{className:"space-y-2 text-muted-foreground text-sm",children:
|
|
71
|
+
});`})]}),t("div",{className:"card-subtle space-y-3 p-6",children:[e("h3",{className:"font-semibold text-lg",children:"Common command keys"}),e("ul",{className:"space-y-2 text-muted-foreground text-sm",children:c.map((o)=>e("li",{children:e("code",{children:o})},o))})]}),t("div",{className:"card-subtle space-y-3 p-6",children:[e("h3",{className:"font-semibold text-lg",children:"Snapshot-backed operator details"}),e("ul",{className:"space-y-2 text-muted-foreground text-sm",children:u.map((o)=>e("li",{children:o},o))})]}),t("div",{className:"space-y-3",children:[e("h2",{className:"font-bold text-2xl",children:"5) Keep runtime mode explicit"}),e("p",{className:"text-muted-foreground text-sm",children:"Preview and export flows are runtime-mode aware. The host chooses between `managed`, `local`, and `hybrid` and passes that choice into preview or export commands instead of hiding it behind provider selection heuristics."}),e(r,{language:"typescript",filename:"runtime-mode",code:`const [selectedExportRuntimeMode, setSelectedExportRuntimeMode] =
|
|
57
72
|
React.useState(resolveBuilderExportRuntimeMode(initialSnapshot));
|
|
58
73
|
|
|
59
74
|
await executeBuilderCommand({
|
|
@@ -62,9 +77,9 @@ await executeBuilderCommand({
|
|
|
62
77
|
payload: {
|
|
63
78
|
runtimeMode: selectedExportRuntimeMode,
|
|
64
79
|
},
|
|
65
|
-
});`})]}),t("div",{className:"space-y-3",children:[e("h2",{className:"font-bold text-2xl",children:"
|
|
80
|
+
});`})]}),t("div",{className:"space-y-3",children:[e("h2",{className:"font-bold text-2xl",children:"6) Link mobile review flows"}),e("p",{className:"text-muted-foreground text-sm",children:"When a patch proposal, approval ticket, or incident needs operator follow-up away from the desktop workbench, deep-link into the mobile review route instead of inventing a separate data model."}),e(r,{language:"typescript",filename:"mobile-review-path.ts",code:`export function buildBuilderMobileReviewPath(
|
|
66
81
|
workspaceId: string,
|
|
67
82
|
cardId: string
|
|
68
83
|
) {
|
|
69
84
|
return \`/operate/builder/workspaces/\${encodeURIComponent(workspaceId)}/mobile-review/\${encodeURIComponent(cardId)}\`;
|
|
70
|
-
}`}),e("p",{className:"text-muted-foreground text-sm",children:"Expected output: the same Builder workspace state stays visible from desktop workbench and mobile review surfaces."})]}),t("div",{className:"space-y-3",children:[e("h2",{className:"font-bold text-2xl",children:"
|
|
85
|
+
}`}),e("p",{className:"text-muted-foreground text-sm",children:"Expected output: the same Builder workspace state stays visible from desktop workbench and mobile review surfaces."})]}),t("div",{className:"space-y-3",children:[e("h2",{className:"font-bold text-2xl",children:"7) Keep Connect adjacent, not embedded"}),e("p",{className:"text-muted-foreground text-sm",children:"Builder owns the authoring control plane. When Builder delegates into coding repositories, enable Connect in those target workspaces for context packs, mutation verification, replay, and review packets, but do not replace Builder contracts with Connect artifacts."}),e(r,{language:"bash",filename:"connect-init.sh",code:"contractspec connect init --scope workspace"})]})]}),t("div",{className:"flex items-center gap-4 pt-4",children:[t(i,{href:"/docs/specs/builder-control-plane",className:"btn-primary",children:["Back to Builder control plane ",e(p,{size:16})]}),e(i,{href:"/docs/studio",className:"btn-ghost",children:"Studio overview"})]})]})}export{k as GuideHostBuilderWorkbenchPage};
|
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
// @bun
|
|
2
|
-
|
|
2
|
+
var y=Object.defineProperty;var g=(p)=>p;function i(p,a){this[p]=g.bind(null,a)}var q=(p,a)=>{for(var h in a)y(p,h,{get:a[h],enumerable:!0,configurable:!0,set:i.bind(a,h)})};var z=(p,a)=>()=>(p&&(a=p(p=0)),a);import v from"@contractspec/lib.ui-link";import{jsx as d,jsxs as N}from"react/jsx-runtime";function m({title:p="Need the operating layer on top of OSS ContractSpec?",body:a="ContractSpec Studio helps teams turn evidence into proposed spec changes, governed delivery loops, and execution-ready task packs while keeping the open contract system as the source of truth.",ctaLabel:h="See what Studio adds",href:o="https://www.contractspec.studio/docs"}){return N("div",{className:"card-subtle space-y-3 p-6",children:[d("h3",{className:"font-semibold text-lg",children:p}),d("p",{className:"text-muted-foreground text-sm",children:a}),d(v,{href:o,className:"btn-primary",children:h})]})}import{CodeBlock as r}from"@contractspec/lib.design-system";import u from"@contractspec/lib.ui-link";import{AlertCircle as P,ChevronRight as b,FileCode as c,Scan as n,Settings as f}from"lucide-react";import{jsx as t,jsxs as e}from"react/jsx-runtime";var L=[{name:"NestJS",flag:"nestjs",description:"Controllers, decorators, DTOs"},{name:"Express",flag:"express",description:"Router methods, middleware"},{name:"Fastify",flag:"fastify",description:"Route definitions, schemas"},{name:"Hono",flag:"hono",description:"Route handlers, validators"},{name:"Elysia",flag:"elysia",description:"Type-safe routes, schemas"},{name:"tRPC",flag:"trpc",description:"Procedure definitions"},{name:"Next.js",flag:"next-api",description:"API routes (app/api, pages/api)"}];function O(){return e("div",{className:"space-y-8",children:[e("div",{className:"space-y-3",children:[t("h1",{className:"font-bold text-4xl",children:"Import Existing Codebases"}),t("p",{className:"text-lg text-muted-foreground",children:"Convert your existing API endpoints into ContractSpec contracts. Auto-detect frameworks, extract schemas, and generate explicit contract definitions from your code."})]}),e("div",{className:"card-subtle space-y-4 p-6",children:[t("h2",{className:"font-bold text-2xl",children:"What you'll learn"}),e("ul",{className:"space-y-2 text-muted-foreground text-sm",children:[t("li",{children:"How to import existing API endpoints as ContractSpec contracts."}),t("li",{children:"Framework-specific patterns and auto-detection."}),t("li",{children:"Customizing imports with scopes, dry-run, and output options."}),t("li",{children:"Registering imported contracts and adding handlers."})]})]}),e("div",{className:"space-y-6",children:[e("div",{className:"space-y-3",children:[t("h2",{className:"font-bold text-2xl",children:"Why import existing code?"}),t("p",{className:"text-muted-foreground text-sm",children:"Instead of writing contracts from scratch, the import command extracts endpoint patterns from your existing codebase. This gives you:"}),e("ul",{className:"list-disc space-y-1 pl-5 text-muted-foreground text-sm",children:[t("li",{children:"Instant spec coverage for existing APIs"}),t("li",{children:"Type-safe schemas derived from your existing types"}),t("li",{children:"A foundation to iterate and refine contracts"}),t("li",{children:"Gradual adoption without rewriting code"})]})]}),e("div",{className:"space-y-3",children:[t("h2",{className:"font-bold text-2xl",children:"Supported frameworks"}),t("div",{className:"grid gap-3 md:grid-cols-2 lg:grid-cols-3",children:L.map((p)=>e("div",{className:"flex items-start gap-3 rounded-lg border border-white/10 p-4",children:[t(c,{className:"text-violet-400",size:18}),e("div",{className:"space-y-1",children:[t("h3",{className:"font-semibold",children:p.name}),t("p",{className:"text-muted-foreground text-xs",children:p.description}),e("code",{className:"text-violet-400 text-xs",children:["--framework ",p.flag]})]})]},p.flag))})]}),e("div",{className:"space-y-3",children:[t("h2",{className:"font-bold text-2xl",children:"1) Quick start"}),t("p",{className:"text-muted-foreground text-sm",children:"Run the import command to auto-detect your framework and extract endpoints:"}),t(r,{language:"bash",filename:"import-quickstart",code:`# Auto-detect framework and import all endpoints
|
|
3
3
|
contractspec import ./src
|
|
4
4
|
|
|
5
5
|
# Preview what would be imported (dry-run)
|
|
6
6
|
contractspec import ./src --dry-run
|
|
7
7
|
|
|
8
8
|
# Force a specific framework
|
|
9
|
-
contractspec import ./src --framework nestjs`}),t("p",{className:"text-muted-foreground text-sm",children:"Expected output: A summary of endpoints found, schemas extracted, and files generated."})]}),e("div",{className:"space-y-3",children:[t("h2",{className:"font-bold text-2xl",children:"2) Framework-specific patterns"}),t("p",{className:"text-muted-foreground text-sm",children:"The import command recognizes these patterns in each framework:"})]}),e("div",{className:"space-y-3",children:[e("h3",{className:"flex items-center gap-2 font-semibold text-xl",children:[t(
|
|
9
|
+
contractspec import ./src --framework nestjs`}),t("p",{className:"text-muted-foreground text-sm",children:"Expected output: A summary of endpoints found, schemas extracted, and files generated."})]}),e("div",{className:"space-y-3",children:[t("h2",{className:"font-bold text-2xl",children:"2) Framework-specific patterns"}),t("p",{className:"text-muted-foreground text-sm",children:"The import command recognizes these patterns in each framework:"})]}),e("div",{className:"space-y-3",children:[e("h3",{className:"flex items-center gap-2 font-semibold text-xl",children:[t(n,{size:18,className:"text-blue-400"}),"NestJS"]}),t(r,{language:"typescript",filename:"src/users/users.controller.ts (before)",code:`@Controller('users')
|
|
10
10
|
export class UsersController {
|
|
11
11
|
@Get(':id')
|
|
12
12
|
async getUser(@Param('id') id: string): Promise<UserDto> {
|
|
@@ -18,7 +18,7 @@ export class UsersController {
|
|
|
18
18
|
async createUser(@Body() dto: CreateUserDto): Promise<UserDto> {
|
|
19
19
|
return this.usersService.create(dto);
|
|
20
20
|
}
|
|
21
|
-
}`}),e("p",{className:"text-muted-foreground text-sm",children:["Detected: ",t("code",{children:"@Controller"}),", ",t("code",{children:"@Get"}),","," ",t("code",{children:"@Post"}),", ",t("code",{children:"@Body"}),", ",t("code",{children:"@Param"}),","," ",t("code",{children:"@UseGuards"})," decorators."]})]}),e("div",{className:"space-y-3",children:[e("h3",{className:"flex items-center gap-2 font-semibold text-xl",children:[t(
|
|
21
|
+
}`}),e("p",{className:"text-muted-foreground text-sm",children:["Detected: ",t("code",{children:"@Controller"}),", ",t("code",{children:"@Get"}),","," ",t("code",{children:"@Post"}),", ",t("code",{children:"@Body"}),", ",t("code",{children:"@Param"}),","," ",t("code",{children:"@UseGuards"})," decorators."]})]}),e("div",{className:"space-y-3",children:[e("h3",{className:"flex items-center gap-2 font-semibold text-xl",children:[t(n,{size:18,className:"text-green-400"}),"Express"]}),t(r,{language:"typescript",filename:"src/routes/users.ts (before)",code:`const router = express.Router();
|
|
22
22
|
|
|
23
23
|
router.get('/users/:id', async (req, res) => {
|
|
24
24
|
const user = await getUserById(req.params.id);
|
|
@@ -28,7 +28,7 @@ router.get('/users/:id', async (req, res) => {
|
|
|
28
28
|
router.post('/users', validateBody(CreateUserSchema), async (req, res) => {
|
|
29
29
|
const user = await createUser(req.body);
|
|
30
30
|
res.status(201).json(user);
|
|
31
|
-
});`}),e("p",{className:"text-muted-foreground text-sm",children:["Detected: ",t("code",{children:"router.get"}),", ",t("code",{children:"router.post"}),", validation middleware, Zod schemas."]})]}),e("div",{className:"space-y-3",children:[e("h3",{className:"flex items-center gap-2 font-semibold text-xl",children:[t(
|
|
31
|
+
});`}),e("p",{className:"text-muted-foreground text-sm",children:["Detected: ",t("code",{children:"router.get"}),", ",t("code",{children:"router.post"}),", validation middleware, Zod schemas."]})]}),e("div",{className:"space-y-3",children:[e("h3",{className:"flex items-center gap-2 font-semibold text-xl",children:[t(n,{size:18,className:"text-purple-400"}),"Next.js API Routes"]}),t(r,{language:"typescript",filename:"app/api/users/[id]/route.ts (before)",code:`export async function GET(
|
|
32
32
|
request: Request,
|
|
33
33
|
{ params }: { params: { id: string } }
|
|
34
34
|
) {
|
|
@@ -40,7 +40,7 @@ export async function POST(request: Request) {
|
|
|
40
40
|
const body = await request.json();
|
|
41
41
|
const user = await createUser(body);
|
|
42
42
|
return Response.json(user, { status: 201 });
|
|
43
|
-
}`}),e("p",{className:"text-muted-foreground text-sm",children:["Detected: ",t("code",{children:"GET"}),", ",t("code",{children:"POST"})," exports in"," ",t("code",{children:"app/api/**/route.ts"})," and ",t("code",{children:"pages/api/**/*.ts"}),"."]})]}),e("div",{className:"space-y-3",children:[t("h2",{className:"font-bold text-2xl",children:"3) Understanding generated contracts"}),t("p",{className:"text-muted-foreground text-sm",children:"The import command generates ContractSpec operations with TODO placeholders for fields it cannot infer:"}),t(
|
|
43
|
+
}`}),e("p",{className:"text-muted-foreground text-sm",children:["Detected: ",t("code",{children:"GET"}),", ",t("code",{children:"POST"})," exports in"," ",t("code",{children:"app/api/**/route.ts"})," and ",t("code",{children:"pages/api/**/*.ts"}),"."]})]}),e("div",{className:"space-y-3",children:[t("h2",{className:"font-bold text-2xl",children:"3) Understanding generated contracts"}),t("p",{className:"text-muted-foreground text-sm",children:"The import command generates ContractSpec operations with TODO placeholders for fields it cannot infer:"}),t(r,{language:"typescript",filename:".contractspec/generated/users.operation.ts",code:`import { defineQuery, defineCommand } from "@contractspec/lib.contracts-spec";
|
|
44
44
|
import { SchemaModel, ScalarTypeEnum } from "@contractspec/lib.schema";
|
|
45
45
|
|
|
46
46
|
export const GetUserQuery = defineQuery({
|
|
@@ -100,7 +100,7 @@ export const CreateUserCommand = defineCommand({
|
|
|
100
100
|
transport: {
|
|
101
101
|
rest: { method: "POST", path: "/users" },
|
|
102
102
|
},
|
|
103
|
-
});`})]}),e("div",{className:"space-y-3",children:[t("h2",{className:"font-bold text-2xl",children:"4) Customizing imports"}),e("div",{className:"flex items-center gap-2",children:[t(
|
|
103
|
+
});`})]}),e("div",{className:"space-y-3",children:[t("h2",{className:"font-bold text-2xl",children:"4) Customizing imports"}),e("div",{className:"flex items-center gap-2",children:[t(f,{size:18,className:"text-violet-400"}),t("h3",{className:"font-semibold text-lg",children:"Available options"})]}),t("div",{className:"overflow-x-auto",children:e("table",{className:"w-full text-sm",children:[t("thead",{children:e("tr",{className:"border-white/10 border-b",children:[t("th",{className:"py-2 pr-4 text-left",children:"Option"}),t("th",{className:"py-2 pr-4 text-left",children:"Description"}),t("th",{className:"py-2 text-left",children:"Example"})]})}),e("tbody",{className:"text-muted-foreground",children:[e("tr",{className:"border-white/5 border-b",children:[t("td",{className:"py-2 pr-4",children:t("code",{children:"--scope"})}),t("td",{className:"py-2 pr-4",children:"Limit to specific directories"}),t("td",{className:"py-2",children:t("code",{children:"--scope src/users src/auth"})})]}),e("tr",{className:"border-white/5 border-b",children:[t("td",{className:"py-2 pr-4",children:t("code",{children:"--framework"})}),t("td",{className:"py-2 pr-4",children:"Force a specific framework"}),t("td",{className:"py-2",children:t("code",{children:"--framework express"})})]}),e("tr",{className:"border-white/5 border-b",children:[t("td",{className:"py-2 pr-4",children:t("code",{children:"--output"})}),t("td",{className:"py-2 pr-4",children:"Output directory"}),t("td",{className:"py-2",children:t("code",{children:"--output ./contracts"})})]}),e("tr",{className:"border-white/5 border-b",children:[t("td",{className:"py-2 pr-4",children:t("code",{children:"--dry-run"})}),t("td",{className:"py-2 pr-4",children:"Preview without writing files"}),t("td",{className:"py-2",children:t("code",{children:"--dry-run"})})]}),e("tr",{className:"border-white/5 border-b",children:[t("td",{className:"py-2 pr-4",children:t("code",{children:"--analyze"})}),t("td",{className:"py-2 pr-4",children:"Analysis only, no code generation"}),t("td",{className:"py-2",children:t("code",{children:"--analyze"})})]}),e("tr",{children:[t("td",{className:"py-2 pr-4",children:t("code",{children:"--json"})}),t("td",{className:"py-2 pr-4",children:"Output as JSON for scripting"}),t("td",{className:"py-2",children:t("code",{children:"--json"})})]})]})]})}),t(r,{language:"bash",filename:"import-options",code:`# Import only specific modules
|
|
104
104
|
contractspec import ./src --scope src/users src/orders
|
|
105
105
|
|
|
106
106
|
# Preview with analysis
|
|
@@ -110,7 +110,7 @@ contractspec import ./src --dry-run --analyze
|
|
|
110
110
|
contractspec import ./src --output ./src/contracts/generated
|
|
111
111
|
|
|
112
112
|
# Get JSON for CI/scripting
|
|
113
|
-
contractspec import ./src --json > import-result.json`})]}),e("div",{className:"space-y-3",children:[t("h2",{className:"font-bold text-2xl",children:"5) Registering imported contracts"}),t("p",{className:"text-muted-foreground text-sm",children:"After import, register contracts and add handlers:"}),t(
|
|
113
|
+
contractspec import ./src --json > import-result.json`})]}),e("div",{className:"space-y-3",children:[t("h2",{className:"font-bold text-2xl",children:"5) Registering imported contracts"}),t("p",{className:"text-muted-foreground text-sm",children:"After import, register contracts and add handlers:"}),t(r,{language:"typescript",filename:"src/contracts/registry.ts",code:`import {
|
|
114
114
|
OperationSpecRegistry,
|
|
115
115
|
installOp,
|
|
116
116
|
} from "@contractspec/lib.contracts-spec/operations";
|
|
@@ -130,4 +130,4 @@ installOp(registry, GetUserQuery, async (input) => {
|
|
|
130
130
|
installOp(registry, CreateUserCommand, async (input) => {
|
|
131
131
|
const user = await db.user.create({ data: input });
|
|
132
132
|
return { id: user.id };
|
|
133
|
-
});`})]}),e("div",{className:"space-y-3",children:[t("h2",{className:"font-bold text-2xl",children:"6) After importing"}),e("ol",{className:"list-decimal space-y-2 pl-5 text-muted-foreground text-sm",children:[e("li",{children:[t("strong",{children:"Review generated contracts"})," \u2014 Check the TODO placeholders and fill in descriptions, owners, and tags."]}),e("li",{children:[t("strong",{children:"Refine schemas"})," \u2014 Add proper types, validation rules, and error definitions."]}),e("li",{children:[t("strong",{children:"Run validation"})," \u2014"," ",t("code",{children:"contractspec validate"})," to ensure contracts are valid."]}),e("li",{children:[t("strong",{children:"Register and wire handlers"})," \u2014 Connect contracts to your existing business logic."]}),e("li",{children:[t("strong",{children:"Iterate"})," \u2014 The imported contracts are a starting point. Refine them as your spec matures."]})]})]}),e("div",{className:"space-y-3",children:[e("h2",{className:"flex items-center gap-2 font-bold text-2xl",children:[t(
|
|
133
|
+
});`})]}),e("div",{className:"space-y-3",children:[t("h2",{className:"font-bold text-2xl",children:"6) After importing"}),e("ol",{className:"list-decimal space-y-2 pl-5 text-muted-foreground text-sm",children:[e("li",{children:[t("strong",{children:"Review generated contracts"})," \u2014 Check the TODO placeholders and fill in descriptions, owners, and tags."]}),e("li",{children:[t("strong",{children:"Refine schemas"})," \u2014 Add proper types, validation rules, and error definitions."]}),e("li",{children:[t("strong",{children:"Run validation"})," \u2014"," ",t("code",{children:"contractspec validate"})," to ensure contracts are valid."]}),e("li",{children:[t("strong",{children:"Register and wire handlers"})," \u2014 Connect contracts to your existing business logic."]}),e("li",{children:[t("strong",{children:"Iterate"})," \u2014 The imported contracts are a starting point. Refine them as your spec matures."]})]})]}),e("div",{className:"space-y-3",children:[e("h2",{className:"flex items-center gap-2 font-bold text-2xl",children:[t(P,{size:20,className:"text-yellow-400"}),"Troubleshooting"]}),e("div",{className:"space-y-4",children:[e("div",{className:"card-subtle space-y-2 p-4",children:[t("h3",{className:"font-semibold",children:"Framework not detected"}),e("p",{className:"text-muted-foreground text-sm",children:["Use ",t("code",{children:"--framework <name>"})," to force a specific framework. Check that your entry files follow standard patterns."]})]}),e("div",{className:"card-subtle space-y-2 p-4",children:[t("h3",{className:"font-semibold",children:"Missing schemas"}),e("p",{className:"text-muted-foreground text-sm",children:["Schema inference works best with explicit types. If using"," ",t("code",{children:"any"})," or dynamic types, you'll see TODO placeholders. Fill them in manually."]})]}),e("div",{className:"card-subtle space-y-2 p-4",children:[t("h3",{className:"font-semibold",children:"Partial imports"}),e("p",{className:"text-muted-foreground text-sm",children:["Some endpoints may not be detected if they use unconventional patterns. Use ",t("code",{children:"--analyze"})," to see what was found, then add missing contracts manually."]})]})]})]}),t(m,{title:"Want evidence-driven migration priorities?",body:"Studio clusters product signals into scored patterns, then proposes contract changes and execution-ready work for the highest-impact areas."})]}),e("div",{className:"flex items-center gap-4 pt-4",children:[e(u,{href:"/docs/guides/spec-validation-and-typing",className:"btn-primary",children:["Next: Spec validation + typing ",t(b,{size:16})]}),t(u,{href:"/docs/guides",className:"btn-ghost",children:"Back to guides"})]})]})}export{O as GuideImportExistingCodebasesPage};
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
// @bun
|
|
2
|
-
|
|
3
|
-
bun add @contractspec/lib.contracts-spec @contractspec/lib.contracts-runtime-server-rest @contractspec/lib.schema`}),t("p",{className:"text-muted-foreground text-sm",children:["Expected output: ",e("code",{children:"added 3 packages"})," and a lockfile update."]})]}),t("div",{className:"space-y-3",children:[e("h2",{className:"font-bold text-2xl",children:"2) Define the operation spec"}),t("p",{className:"text-muted-foreground text-sm",children:["Create ",e("code",{children:"src/contracts/healthcheck.operation.ts"}),":"]}),e(
|
|
2
|
+
var l=Object.defineProperty;var d=(a)=>a;function m(a,o){this[a]=d.bind(null,o)}var f=(a,o)=>{for(var r in o)l(a,r,{get:o[r],enumerable:!0,configurable:!0,set:m.bind(o,r)})};var y=(a,o)=>()=>(a&&(o=a(a=0)),o);import h from"@contractspec/lib.ui-link";import{jsx as i,jsxs as u}from"react/jsx-runtime";function n({title:a="Need the operating layer on top of OSS ContractSpec?",body:o="ContractSpec Studio helps teams turn evidence into proposed spec changes, governed delivery loops, and execution-ready task packs while keeping the open contract system as the source of truth.",ctaLabel:r="See what Studio adds",href:p="https://www.contractspec.studio/docs"}){return u("div",{className:"card-subtle space-y-3 p-6",children:[i("h3",{className:"font-semibold text-lg",children:a}),i("p",{className:"text-muted-foreground text-sm",children:o}),i(h,{href:p,className:"btn-primary",children:r})]})}import{CodeBlock as c}from"@contractspec/lib.design-system";import s from"@contractspec/lib.ui-link";import{ChevronRight as g}from"lucide-react";import{jsx as e,jsxs as t}from"react/jsx-runtime";function E(){return t("div",{className:"space-y-8",children:[t("div",{className:"space-y-3",children:[e("h1",{className:"font-bold text-4xl",children:"Next.js: add one endpoint"}),e("p",{className:"text-lg text-muted-foreground",children:"Add ContractSpec to an existing Next.js App Router project by wiring a single operation end-to-end with validation and types."})]}),t("div",{className:"card-subtle space-y-4 p-6",children:[e("h2",{className:"font-bold text-2xl",children:"What you'll build"}),t("ul",{className:"space-y-2 text-muted-foreground text-sm",children:[e("li",{children:"One OperationSpec with SchemaModel validation."}),e("li",{children:"A registry wiring the operation to its handler."}),e("li",{children:"A Next.js route handler that exposes the operation."})]})]}),t("div",{className:"space-y-6",children:[t("div",{className:"space-y-3",children:[e("h2",{className:"font-bold text-2xl",children:"1) Install core packages"}),e(c,{language:"bash",filename:"nextjs-install",code:`bun add -D contractspec
|
|
3
|
+
bun add @contractspec/lib.contracts-spec @contractspec/lib.contracts-runtime-server-rest @contractspec/lib.schema`}),t("p",{className:"text-muted-foreground text-sm",children:["Expected output: ",e("code",{children:"added 3 packages"})," and a lockfile update."]})]}),t("div",{className:"space-y-3",children:[e("h2",{className:"font-bold text-2xl",children:"2) Define the operation spec"}),t("p",{className:"text-muted-foreground text-sm",children:["Create ",e("code",{children:"src/contracts/healthcheck.operation.ts"}),":"]}),e(c,{language:"typescript",filename:"src/contracts/healthcheck.operation.ts",code:`import { defineQuery } from "@contractspec/lib.contracts-spec/operations";
|
|
4
4
|
import { SchemaModel, ScalarTypeEnum } from "@contractspec/lib.schema";
|
|
5
5
|
|
|
6
6
|
const HealthcheckOutput = new SchemaModel({
|
|
@@ -31,7 +31,7 @@ export const HealthcheckQuery = defineQuery({
|
|
|
31
31
|
gql: { field: "healthcheck_get" },
|
|
32
32
|
mcp: { toolName: "healthcheck_get-v1" },
|
|
33
33
|
},
|
|
34
|
-
});`})]}),t("div",{className:"space-y-3",children:[e("h2",{className:"font-bold text-2xl",children:"3) Register the operation"}),t("p",{className:"text-muted-foreground text-sm",children:["Create ",e("code",{children:"src/contracts/registry.ts"}),":"]}),e(
|
|
34
|
+
});`})]}),t("div",{className:"space-y-3",children:[e("h2",{className:"font-bold text-2xl",children:"3) Register the operation"}),t("p",{className:"text-muted-foreground text-sm",children:["Create ",e("code",{children:"src/contracts/registry.ts"}),":"]}),e(c,{language:"typescript",filename:"src/contracts/registry.ts",code:`import {
|
|
35
35
|
OperationSpecRegistry,
|
|
36
36
|
installOp,
|
|
37
37
|
} from "@contractspec/lib.contracts-spec/operations";
|
|
@@ -42,7 +42,7 @@ export const registry = new OperationSpecRegistry();
|
|
|
42
42
|
installOp(registry, HealthcheckQuery, async () => ({
|
|
43
43
|
status: "ok",
|
|
44
44
|
checkedAt: new Date().toISOString(),
|
|
45
|
-
}));`})]}),t("div",{className:"space-y-3",children:[e("h2",{className:"font-bold text-2xl",children:"4) Add the Next.js handler"}),t("p",{className:"text-muted-foreground text-sm",children:["Create ",e("code",{children:"app/api/ops/[...route]/route.ts"}),":"]}),e(
|
|
45
|
+
}));`})]}),t("div",{className:"space-y-3",children:[e("h2",{className:"font-bold text-2xl",children:"4) Add the Next.js handler"}),t("p",{className:"text-muted-foreground text-sm",children:["Create ",e("code",{children:"app/api/ops/[...route]/route.ts"}),":"]}),e(c,{language:"typescript",filename:"app/api/ops/[...route]/route.ts",code:`import { makeNextAppHandler } from "@contractspec/lib.contracts-runtime-server-rest/rest-next-app";
|
|
46
46
|
import { registry } from "@/contracts/registry";
|
|
47
47
|
|
|
48
48
|
const handler = makeNextAppHandler(registry, async () => ({
|
|
@@ -50,8 +50,8 @@ const handler = makeNextAppHandler(registry, async () => ({
|
|
|
50
50
|
tenantId: "public",
|
|
51
51
|
}));
|
|
52
52
|
|
|
53
|
-
export { handler as GET, handler as POST };`}),t("p",{className:"text-muted-foreground text-sm",children:["Expected output: the route responds at",e("code",{children:" /api/ops/healthcheck.get"}),"."]})]}),t("div",{className:"space-y-3",children:[e("h2",{className:"font-bold text-2xl",children:"5) Validate the spec"}),e(
|
|
53
|
+
export { handler as GET, handler as POST };`}),t("p",{className:"text-muted-foreground text-sm",children:["Expected output: the route responds at",e("code",{children:" /api/ops/healthcheck.get"}),"."]})]}),t("div",{className:"space-y-3",children:[e("h2",{className:"font-bold text-2xl",children:"5) Validate the spec"}),e(c,{language:"bash",filename:"nextjs-validate",code:"contractspec validate src/contracts/healthcheck.operation.ts"}),t("p",{className:"text-muted-foreground text-sm",children:["Expected output: ",e("code",{children:"Validation passed"}),"."]})]}),t("div",{className:"card-subtle space-y-3 p-6",children:[e("h3",{className:"font-semibold text-lg",children:"Example package"}),t("p",{className:"text-muted-foreground text-sm",children:["Use ",e("code",{children:"@contractspec/example.lifecycle-dashboard"})," as a lightweight Next.js snippet reference."]}),e(c,{language:"bash",filename:"nextjs-example",code:`# Inspect the example docs
|
|
54
54
|
contractspec examples show lifecycle-dashboard
|
|
55
55
|
|
|
56
56
|
# Validate all example manifests in this repo
|
|
57
|
-
contractspec examples validate --repo-root .`})]}),e(
|
|
57
|
+
contractspec examples validate --repo-root .`})]}),e(n,{title:"Want real product evidence behind endpoint changes?",body:"Studio correlates meetings, support, analytics, and code signals before compiling endpoint decisions into spec diffs."})]}),t("div",{className:"flex items-center gap-4 pt-4",children:[t(s,{href:"/docs/guides/spec-validation-and-typing",className:"btn-primary",children:["Next: Spec validation + typing ",e(g,{size:16})]}),e(s,{href:"/docs/guides",className:"btn-ghost",children:"Back to guides"})]})]})}export{E as GuideNextjsOneEndpointPage};
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export declare function GuideReleaseCapsulesPage(): import("react/jsx-runtime").JSX.Element;
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
// @bun
|
|
2
|
+
var n=Object.defineProperty;var o=(t)=>t;function i(t,s){this[t]=o.bind(null,s)}var m=(t,s)=>{for(var r in s)n(t,r,{get:s[r],enumerable:!0,configurable:!0,set:i.bind(s,r)})};var h=(t,s)=>()=>(t&&(s=t(t=0)),s);import{CodeBlock as c}from"@contractspec/lib.design-system";import l from"@contractspec/lib.ui-link";import{ChevronRight as d}from"lucide-react";import{jsx as e,jsxs as a}from"react/jsx-runtime";var u=["root `README.md` and generated root `AGENTS.md` inputs when contributor or operator workflow changes","the nearest package `README.md` and `AGENTS.md` for any touched public package surface","website docs and `/llms*` summaries when the release changes how users or contributors should work"];function v(){return a("div",{className:"space-y-8",children:[a("div",{className:"space-y-3",children:[e("h1",{className:"font-bold text-4xl",children:"Author release capsules"}),e("p",{className:"text-lg text-muted-foreground",children:"Pair each publishable changeset with a structured release capsule so changelog, upgrade, and docs surfaces all read from the same release source of truth."})]}),a("div",{className:"card-subtle space-y-4 p-6",children:[e("h2",{className:"font-bold text-2xl",children:"What you'll build"}),a("ul",{className:"space-y-2 text-muted-foreground text-sm",children:[a("li",{children:["A ",e("code",{children:".changeset/<slug>.md"})," file for package/version intent."]}),a("li",{children:["A ",e("code",{children:".changeset/<slug>.release.yaml"})," companion for audiences, migrations, validation, and evidence."]}),e("li",{children:"Generated release artifacts that the website changelog and upgrade flows can consume safely."})]})]}),a("div",{className:"space-y-6",children:[a("div",{className:"space-y-3",children:[e("h2",{className:"font-bold text-2xl",children:"1) Create the paired changeset files"}),e("p",{className:"text-muted-foreground text-sm",children:"The Markdown file states the package bumps and reader-facing change intent. The YAML file carries the structured release metadata."}),e(c,{language:"yaml",filename:".changeset/contract-dx-first-slice.release.yaml",code:`schemaVersion: "1"
|
|
3
|
+
slug: contract-dx-first-slice
|
|
4
|
+
summary: Improve app-config, theme, and feature authoring with explicit validation and shared setup alignment.
|
|
5
|
+
isBreaking: false
|
|
6
|
+
packages:
|
|
7
|
+
- name: "@contractspec/lib.contracts-spec"
|
|
8
|
+
releaseType: minor
|
|
9
|
+
validation:
|
|
10
|
+
commands:
|
|
11
|
+
- "cd packages/libs/contracts-spec && bun run test && bun run typecheck"
|
|
12
|
+
evidence:
|
|
13
|
+
- "Package-level validation entrypoints now back setup, docs, and CLI authoring flows."`}),e("p",{className:"text-muted-foreground text-sm",children:"Expected output: every publishable slug has both the human-facing changeset and the structured release capsule beside it."})]}),a("div",{className:"space-y-3",children:[e("h2",{className:"font-bold text-2xl",children:"2) Use the release authoring commands instead of raw drift-prone edits"}),e(c,{language:"bash",filename:"release-authoring",code:`contractspec release init --summary "Improve app-config, theme, and feature authoring"
|
|
14
|
+
|
|
15
|
+
# Or revise an existing capsule with the guided flow
|
|
16
|
+
contractspec release edit contract-dx-first-slice`}),e("p",{className:"text-muted-foreground text-sm",children:"Expected output: the CLI scaffolds or revises the paired files with the current release schema instead of leaving maintainers to hand-roll YAML structure."})]}),a("div",{className:"space-y-3",children:[e("h2",{className:"font-bold text-2xl",children:"3) Build the generated release artifacts before consuming them"}),e(c,{language:"bash",filename:"release-build",code:"contractspec release build"}),e("p",{className:"text-muted-foreground text-sm",children:"Expected output: `generated/releases/manifest.json`, `generated/releases/upgrade-manifest.json`, and the related customer/maintainer guidance files are refreshed from the release capsules."})]}),a("div",{className:"space-y-3",children:[e("h2",{className:"font-bold text-2xl",children:"4) Enforce completeness before publishing or building the changelog"}),e(c,{language:"bash",filename:"release-check",code:"contractspec release check --strict"}),e("p",{className:"text-muted-foreground text-sm",children:"Expected output: missing capsules, incomplete migration guidance, or stale generated release artifacts are flagged before the website changelog or publish workflow treats the release data as canonical."})]}),a("div",{className:"card-subtle space-y-3 p-6",children:[e("h3",{className:"font-semibold text-lg",children:"5) Sync the public docs if workflow expectations changed"}),e("ul",{className:"space-y-2 text-muted-foreground text-sm",children:u.map((t)=>e("li",{children:t},t))})]})]}),a("div",{className:"flex items-center gap-4 pt-4",children:[a(l,{href:"/docs/guides/connect-in-a-repo",className:"btn-primary",children:["Connect guide ",e(d,{size:16})]}),e(l,{href:"/changelog",className:"btn-ghost",children:"Website changelog"})]})]})}export{v as GuideReleaseCapsulesPage};
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
// @bun
|
|
2
|
-
|
|
2
|
+
var p=Object.defineProperty;var d=(a)=>a;function m(a,o){this[a]=d.bind(null,o)}var g=(a,o)=>{for(var i in o)p(a,i,{get:o[i],enumerable:!0,configurable:!0,set:m.bind(o,i)})};var y=(a,o)=>()=>(a&&(o=a(a=0)),o);import u from"@contractspec/lib.ui-link";import{jsx as c,jsxs as h}from"react/jsx-runtime";function r({title:a="Need the operating layer on top of OSS ContractSpec?",body:o="ContractSpec Studio helps teams turn evidence into proposed spec changes, governed delivery loops, and execution-ready task packs while keeping the open contract system as the source of truth.",ctaLabel:i="See what Studio adds",href:l="https://www.contractspec.studio/docs"}){return h("div",{className:"card-subtle space-y-3 p-6",children:[c("h3",{className:"font-semibold text-lg",children:a}),c("p",{className:"text-muted-foreground text-sm",children:o}),c(u,{href:l,className:"btn-primary",children:i})]})}import{CodeBlock as n}from"@contractspec/lib.design-system";import s from"@contractspec/lib.ui-link";import{ChevronRight as f}from"lucide-react";import{jsx as e,jsxs as t}from"react/jsx-runtime";function O(){return t("div",{className:"space-y-8",children:[t("div",{className:"space-y-3",children:[e("h1",{className:"font-bold text-4xl",children:"Spec-driven validation + typing"}),e("p",{className:"text-lg text-muted-foreground",children:"Define a single operation with SchemaModel, generate validation, and keep your existing handler logic."})]}),t("div",{className:"card-subtle space-y-4 p-6",children:[e("h2",{className:"font-bold text-2xl",children:"What you'll build"}),t("ul",{className:"space-y-2 text-muted-foreground text-sm",children:[e("li",{children:"One command spec with explicit input/output models."}),e("li",{children:"Validation + typing without rewriting your service layer."}),e("li",{children:"Clear acceptance scenarios for regression safety."})]})]}),t("div",{className:"space-y-6",children:[t("div",{className:"space-y-3",children:[e("h2",{className:"font-bold text-2xl",children:"1) Define the spec"}),t("p",{className:"text-muted-foreground text-sm",children:["Create ",e("code",{children:"src/contracts/contact-create.operation.ts"}),":"]}),e(n,{language:"typescript",filename:"src/contracts/contact-create.operation.ts",code:`import { defineCommand } from "@contractspec/lib.contracts-spec/operations";
|
|
3
3
|
import { SchemaModel, ScalarTypeEnum } from "@contractspec/lib.schema";
|
|
4
4
|
|
|
5
5
|
const ContactInput = new SchemaModel({
|
|
@@ -45,7 +45,7 @@ export const ContactCreateCommand = defineCommand({
|
|
|
45
45
|
},
|
|
46
46
|
],
|
|
47
47
|
},
|
|
48
|
-
});`})]}),t("div",{className:"space-y-3",children:[e("h2",{className:"font-bold text-2xl",children:"2) Wire the handler"}),e("p",{className:"text-muted-foreground text-sm",children:"Keep your existing code. Just ensure the handler returns the output shape defined above."}),e(
|
|
48
|
+
});`})]}),t("div",{className:"space-y-3",children:[e("h2",{className:"font-bold text-2xl",children:"2) Wire the handler"}),e("p",{className:"text-muted-foreground text-sm",children:"Keep your existing code. Just ensure the handler returns the output shape defined above."}),e(n,{language:"typescript",filename:"src/handlers/contact-create.ts",code:`import { ContactCreateCommand } from "@/contracts/contact-create.operation";
|
|
49
49
|
|
|
50
50
|
export async function handleContactCreate(
|
|
51
51
|
input: (typeof ContactCreateCommand)["io"]["input"],
|
|
@@ -57,8 +57,8 @@ export const ContactCreateCommand = defineCommand({
|
|
|
57
57
|
email: input.email,
|
|
58
58
|
createdAt: new Date().toISOString(),
|
|
59
59
|
};
|
|
60
|
-
}`})]}),t("div",{className:"space-y-3",children:[e("h2",{className:"font-bold text-2xl",children:"3) Validate"}),e(
|
|
60
|
+
}`})]}),t("div",{className:"space-y-3",children:[e("h2",{className:"font-bold text-2xl",children:"3) Validate"}),e(n,{language:"bash",filename:"spec-validation",code:"contractspec validate src/contracts/contact-create.operation.ts"}),t("p",{className:"text-muted-foreground text-sm",children:["Expected output: ",e("code",{children:"Validation passed"}),"."]})]}),t("div",{className:"card-subtle space-y-3 p-6",children:[e("h3",{className:"font-semibold text-lg",children:"Example package"}),e("p",{className:"text-muted-foreground text-sm",children:"The CRM Pipeline example includes real specs, handlers, and presentations for contact + deal flows."}),e(n,{language:"bash",filename:"crm-example",code:`# Build + validate the CRM pipeline example
|
|
61
61
|
cd packages/examples/crm-pipeline
|
|
62
62
|
bun install
|
|
63
63
|
bun run build
|
|
64
|
-
bun run validate`})]}),e(
|
|
64
|
+
bun run validate`})]}),e(r,{title:"Need validation tied to real outcomes?",body:"Studio links checks to evidence, focus decisions, and post-release verification so specs evolve with product truth."})]}),t("div",{className:"flex items-center gap-4 pt-4",children:[t(s,{href:"/docs/guides/generate-docs-clients-schemas",className:"btn-primary",children:["Next: Generate docs + clients ",e(f,{size:16})]}),e(s,{href:"/docs/guides",className:"btn-ghost",children:"Back to guides"})]})]})}export{O as GuideSpecValidationTypingPage};
|