@contractspec/lib.contracts 0.0.0-canary-20260113162409

package/dist/workspace-config/contractsrc-schema.js

@@ -0,0 +1,421 @@
+import * as z$2 from "zod";
+
+//#region src/workspace-config/contractsrc-schema.ts
+/**
+* ContractSpec configuration schema definitions.
+*
+* These schemas define the structure of .contractsrc.json files
+* and are shared across CLI tools and libraries.
+*/
+/**
+* Schema output format for code generation.
+* Controls how imported/generated schemas are written.
+*/
+const SchemaFormatSchema = z$2.enum([
+	"contractspec",
+	"zod",
+	"json-schema",
+	"graphql"
+]);
+/**
+* OpenAPI source configuration for import/sync/validate operations.
+*/
+const OpenApiSourceConfigSchema = z$2.object({
+	name: z$2.string(),
+	url: z$2.url().optional(),
+	file: z$2.string().optional(),
+	syncMode: z$2.enum([
+		"import",
+		"sync",
+		"validate"
+	]).default("validate"),
+	tags: z$2.array(z$2.string()).optional(),
+	exclude: z$2.array(z$2.string()).optional(),
+	include: z$2.array(z$2.string()).optional(),
+	prefix: z$2.string().optional(),
+	defaultStability: z$2.enum([
+		"experimental",
+		"beta",
+		"stable",
+		"deprecated"
+	]).optional(),
+	defaultAuth: z$2.enum([
+		"anonymous",
+		"user",
+		"admin"
+	]).optional(),
+	defaultOwners: z$2.array(z$2.string()).optional(),
+	schemaFormat: SchemaFormatSchema.default("contractspec")
+});
+const OpenApiExportConfigSchema = z$2.object({
+	outputPath: z$2.string().default("./openapi.json"),
+	format: z$2.enum(["json", "yaml"]).default("json"),
+	title: z$2.string().optional(),
+	version: z$2.string().optional(),
+	description: z$2.string().optional(),
+	servers: z$2.array(z$2.object({
+		url: z$2.string(),
+		description: z$2.string().optional()
+	})).optional()
+});
+/**
+* OpenAPI configuration section.
+*/
+const OpenApiConfigSchema = z$2.object({
+	sources: z$2.array(OpenApiSourceConfigSchema).optional(),
+	export: OpenApiExportConfigSchema.optional()
+});
+/**
+* Grouping strategy for organizing specs.
+*/
+const GroupingStrategySchema = z$2.enum([
+	"by-tag",
+	"by-owner",
+	"by-domain",
+	"by-url-path-single",
+	"by-url-path-multi",
+	"by-feature",
+	"none"
+]);
+/**
+* Grouping rule configuration.
+*/
+const GroupingRuleSchema = z$2.object({
+	strategy: GroupingStrategySchema,
+	urlPathLevel: z$2.number().optional(),
+	pattern: z$2.string().optional()
+});
+/**
+* Output directory conventions for generated specs.
+*/
+const FolderConventionsSchema = z$2.object({
+	models: z$2.string().default("models"),
+	operations: z$2.string().default("operations/commands|queries"),
+	events: z$2.string().default("events"),
+	presentations: z$2.string().default("presentations"),
+	forms: z$2.string().default("forms"),
+	groupByFeature: z$2.boolean().default(true),
+	operationsGrouping: GroupingRuleSchema.optional(),
+	modelsGrouping: GroupingRuleSchema.optional(),
+	eventsGrouping: GroupingRuleSchema.optional()
+});
+/**
+* PR comment configuration for CI/CD.
+*/
+const PrCommentConfigSchema = z$2.object({
+	enabled: z$2.boolean().default(true),
+	template: z$2.enum(["minimal", "detailed"]).default("detailed"),
+	updateExisting: z$2.boolean().default(true)
+});
+/**
+* GitHub check run configuration for CI/CD.
+*/
+const CheckRunConfigSchema = z$2.object({
+	enabled: z$2.boolean().default(true),
+	name: z$2.string().default("ContractSpec Impact"),
+	failOnBreaking: z$2.boolean().default(true),
+	failOnChanges: z$2.boolean().default(false)
+});
+/**
+* Impact detection configuration for CI/CD.
+*/
+const ImpactConfigSchema = z$2.object({
+	baseline: z$2.string().default("default-branch"),
+	include: z$2.array(z$2.string()).optional(),
+	exclude: z$2.array(z$2.string()).optional()
+});
+/**
+* CI/CD configuration section.
+*/
+const CiConfigSchema = z$2.object({
+	checks: z$2.array(z$2.string()).default([
+		"structure",
+		"integrity",
+		"deps"
+	]),
+	skipChecks: z$2.array(z$2.string()).optional(),
+	failOnWarnings: z$2.boolean().default(false),
+	uploadSarif: z$2.boolean().default(true),
+	prComment: PrCommentConfigSchema.optional(),
+	checkRun: CheckRunConfigSchema.optional(),
+	impact: ImpactConfigSchema.optional()
+});
+/**
+* External workspace reference for cross-workspace dependencies in meta-repos.
+*/
+const ExternalWorkspaceSchema = z$2.object({
+	alias: z$2.string(),
+	submodule: z$2.string(),
+	packages: z$2.array(z$2.string()).optional(),
+	autoResolve: z$2.boolean().default(true)
+});
+/**
+* Meta-repo configuration section.
+*/
+const MetaRepoConfigSchema = z$2.object({
+	activeScope: z$2.string().optional(),
+	externalWorkspaces: z$2.array(ExternalWorkspaceSchema).optional(),
+	crossWorkspaceSearch: z$2.boolean().default(false)
+});
+/**
+* Supported formatter tools.
+*/
+const FormatterTypeSchema = z$2.enum([
+	"prettier",
+	"eslint",
+	"biome",
+	"dprint",
+	"custom"
+]);
+/**
+* Formatter configuration for code generation.
+*/
+const FormatterConfigSchema = z$2.object({
+	enabled: z$2.boolean().default(true),
+	type: FormatterTypeSchema.optional(),
+	command: z$2.string().optional(),
+	args: z$2.array(z$2.string()).optional(),
+	timeout: z$2.number().default(3e4)
+});
+/**
+* Bump strategy for version management.
+*/
+const BumpStrategySchema = z$2.enum(["impact", "conventional"]);
+/**
+* Changelog format template.
+*/
+const ChangelogFormatSchema = z$2.enum([
+	"keep-a-changelog",
+	"conventional",
+	"custom"
+]);
+/**
+* Changelog tier configuration.
+*/
+const ChangelogTierSchema = z$2.enum([
+	"spec",
+	"library",
+	"monorepo"
+]);
+/**
+* Versioning configuration for changelog and version management.
+*/
+const VersioningConfigSchema = z$2.object({
+	autoBump: z$2.boolean().default(false),
+	bumpStrategy: BumpStrategySchema.default("impact"),
+	integrateWithChangesets: z$2.boolean().default(false),
+	changelogTiers: z$2.array(ChangelogTierSchema).default([
+		"spec",
+		"library",
+		"monorepo"
+	]),
+	format: ChangelogFormatSchema.default("keep-a-changelog"),
+	commitChanges: z$2.boolean().default(false),
+	commitMessage: z$2.string().default("chore: bump spec versions"),
+	createTags: z$2.boolean().default(false),
+	tagPrefix: z$2.string().default("v"),
+	include: z$2.array(z$2.string()).optional(),
+	exclude: z$2.array(z$2.string()).optional()
+});
+/**
+* Supported rule synchronization targets.
+*/
+const RuleSyncTargetSchema = z$2.enum([
+	"cursor",
+	"windsurf",
+	"cline",
+	"claude-code",
+	"copilot",
+	"subagent",
+	"skill"
+]);
+/**
+* Configuration for AI agent rules synchronization (rulesync).
+*/
+const RuleSyncConfigSchema = z$2.object({
+	enabled: z$2.boolean().default(false),
+	rulesDir: z$2.string().default("./.rules"),
+	rules: z$2.array(z$2.string()).default(["**/*.rule.md"]),
+	targets: z$2.array(RuleSyncTargetSchema).default(["cursor", "windsurf"]),
+	autoSync: z$2.boolean().default(true),
+	ejectMode: z$2.boolean().default(false)
+});
+/**
+* Claude Agent SDK configuration.
+*/
+const ClaudeAgentSDKConfigSchema = z$2.object({
+	enabled: z$2.boolean().default(false),
+	apiKey: z$2.string().optional(),
+	model: z$2.string().default("claude-sonnet-4-20250514"),
+	computerUse: z$2.boolean().default(false),
+	extendedThinking: z$2.boolean().default(false)
+});
+/**
+* OpenCode SDK configuration.
+*/
+const OpenCodeSDKConfigSchema = z$2.object({
+	enabled: z$2.boolean().default(false),
+	serverUrl: z$2.string().optional(),
+	port: z$2.number().optional(),
+	agentType: z$2.enum([
+		"build",
+		"plan",
+		"general",
+		"explore"
+	]).default("general"),
+	model: z$2.string().optional()
+});
+/**
+* External agent SDK configuration section.
+*/
+const ExternalAgentsConfigSchema = z$2.object({
+	claudeAgent: ClaudeAgentSDKConfigSchema.optional(),
+	openCode: OpenCodeSDKConfigSchema.optional()
+});
+/**
+* Rule severity levels (inspired by ESLint).
+*/
+const RuleSeveritySchema = z$2.enum([
+	"off",
+	"warn",
+	"error"
+]);
+/**
+* Contract kinds for per-kind rule overrides.
+*/
+const SpecKindSchema = z$2.enum([
+	"operation",
+	"event",
+	"presentation",
+	"feature",
+	"workflow",
+	"data-view",
+	"migration",
+	"telemetry",
+	"experiment",
+	"app-config"
+]);
+/**
+* Available lint rules with their severity.
+*/
+const LintRulesSchema = z$2.object({
+	"require-acceptance": RuleSeveritySchema.optional(),
+	"require-examples": RuleSeveritySchema.optional(),
+	"require-stability": RuleSeveritySchema.optional(),
+	"require-owners-format": RuleSeveritySchema.optional(),
+	"event-past-tense": RuleSeveritySchema.optional(),
+	"no-todo": RuleSeveritySchema.optional(),
+	"workflow-transitions": RuleSeveritySchema.optional(),
+	"telemetry-privacy": RuleSeveritySchema.optional(),
+	"experiment-allocation": RuleSeveritySchema.optional(),
+	"app-config-appid": RuleSeveritySchema.optional(),
+	"app-config-capabilities": RuleSeveritySchema.optional(),
+	"data-view-fields": RuleSeveritySchema.optional()
+});
+/**
+* Test linking strategy for discovering test coverage.
+*/
+const TestLinkingStrategySchema = z$2.enum([
+	"target-first",
+	"convention-only",
+	"both"
+]);
+/**
+* Test linking configuration for contract-first test discovery.
+*/
+const TestLinkingConfigSchema = z$2.object({
+	strategy: TestLinkingStrategySchema.default("both"),
+	warnOnConvention: z$2.boolean().default(false)
+});
+/**
+* Testing configuration section.
+*/
+const TestingConfigSchema = z$2.object({
+	runner: z$2.enum([
+		"internal",
+		"jest",
+		"vitest",
+		"bun"
+	]).default("internal"),
+	testMatch: z$2.array(z$2.string()).default(["**/*.{test,spec}.{ts,js}"]),
+	autoGenerate: z$2.boolean().default(false),
+	integrity: z$2.object({
+		requireTestsFor: z$2.array(SpecKindSchema).optional(),
+		minCoverage: z$2.number().optional()
+	}).optional(),
+	testLinking: TestLinkingConfigSchema.optional()
+});
+/**
+* Full rules configuration with global defaults and per-kind overrides.
+*/
+const RulesConfigSchema = z$2.object({
+	defaults: LintRulesSchema.optional(),
+	overrides: z$2.record(SpecKindSchema, LintRulesSchema).optional()
+});
+/**
+* Git hooks configuration.
+* Maps hook names (e.g., "pre-commit") to a list of commands or checks to run.
+*/
+const HooksConfigSchema = z$2.record(z$2.string(), z$2.array(z$2.string()));
+/**
+* Full ContractSpec configuration schema (.contractsrc.json).
+*/
+const ContractsrcSchema = z$2.object({
+	aiProvider: z$2.enum([
+		"claude",
+		"openai",
+		"ollama",
+		"custom"
+	]).default("claude"),
+	aiModel: z$2.string().optional(),
+	agentMode: z$2.enum([
+		"simple",
+		"cursor",
+		"claude-code",
+		"openai-codex",
+		"claude-agent-sdk",
+		"opencode-sdk"
+	]).default("simple"),
+	customEndpoint: z$2.url().nullable().optional(),
+	customApiKey: z$2.string().nullable().optional(),
+	outputDir: z$2.string().default("./src"),
+	conventions: FolderConventionsSchema,
+	defaultOwners: z$2.array(z$2.string()).default([]),
+	defaultTags: z$2.array(z$2.string()).default([]),
+	packages: z$2.array(z$2.string()).optional(),
+	excludePackages: z$2.array(z$2.string()).optional(),
+	recursive: z$2.boolean().optional(),
+	openapi: OpenApiConfigSchema.optional(),
+	ci: CiConfigSchema.optional(),
+	metaRepo: MetaRepoConfigSchema.optional(),
+	rules: RulesConfigSchema.optional(),
+	testing: TestingConfigSchema.optional(),
+	hooks: HooksConfigSchema.optional(),
+	schemaFormat: SchemaFormatSchema.default("contractspec"),
+	formatter: FormatterConfigSchema.optional(),
+	versioning: VersioningConfigSchema.optional(),
+	ruleSync: RuleSyncConfigSchema.optional(),
+	externalAgents: ExternalAgentsConfigSchema.optional()
+});
+/**
+* Default configuration values.
+*/
+const DEFAULT_CONTRACTSRC = {
+	aiProvider: "claude",
+	agentMode: "simple",
+	outputDir: "./src",
+	conventions: {
+		models: "models",
+		operations: "interactions/commands|queries",
+		events: "events",
+		presentations: "presentations",
+		forms: "forms",
+		groupByFeature: true
+	},
+	defaultOwners: [],
+	defaultTags: [],
+	schemaFormat: "contractspec"
+};
+
+//#endregion
+export { BumpStrategySchema, ChangelogFormatSchema, ChangelogTierSchema, CheckRunConfigSchema, CiConfigSchema, ClaudeAgentSDKConfigSchema, ContractsrcSchema, DEFAULT_CONTRACTSRC, ExternalAgentsConfigSchema, ExternalWorkspaceSchema, FolderConventionsSchema, FormatterConfigSchema, FormatterTypeSchema, GroupingRuleSchema, GroupingStrategySchema, HooksConfigSchema, ImpactConfigSchema, LintRulesSchema, MetaRepoConfigSchema, OpenApiConfigSchema, OpenApiExportConfigSchema, OpenApiSourceConfigSchema, OpenCodeSDKConfigSchema, PrCommentConfigSchema, RuleSeveritySchema, RuleSyncConfigSchema, RuleSyncTargetSchema, RulesConfigSchema, SchemaFormatSchema, SpecKindSchema, TestLinkingConfigSchema, TestLinkingStrategySchema, TestingConfigSchema, VersioningConfigSchema };

package/dist/workspace-config/index.d.ts

@@ -0,0 +1,2 @@
+import { BumpStrategy, BumpStrategySchema, ChangelogFormat, ChangelogFormatSchema, ChangelogTier, ChangelogTierSchema, ContractsrcConfig, ContractsrcSchema, DEFAULT_CONTRACTSRC, FolderConventions, FolderConventionsSchema, FormatterConfig, FormatterConfigSchema, FormatterType, FormatterTypeSchema, OpenApiConfig, OpenApiConfigSchema, OpenApiExportConfig, OpenApiExportConfigSchema, OpenApiSourceConfig, OpenApiSourceConfigSchema, RuleSyncConfig, RuleSyncConfigSchema, RuleSyncTarget, RuleSyncTargetSchema, SchemaFormat, SchemaFormatSchema, VersioningConfig, VersioningConfigSchema } from "./contractsrc-schema.js";
+export { type BumpStrategy, BumpStrategySchema, type ChangelogFormat, ChangelogFormatSchema, type ChangelogTier, ChangelogTierSchema, type ContractsrcConfig, ContractsrcSchema, DEFAULT_CONTRACTSRC, type FolderConventions, FolderConventionsSchema, type FormatterConfig, FormatterConfigSchema, type FormatterType, FormatterTypeSchema, type OpenApiConfig, OpenApiConfigSchema, type OpenApiExportConfig, OpenApiExportConfigSchema, type OpenApiSourceConfig, OpenApiSourceConfigSchema, type RuleSyncConfig, RuleSyncConfigSchema, type RuleSyncTarget, RuleSyncTargetSchema, type SchemaFormat, SchemaFormatSchema, type VersioningConfig, VersioningConfigSchema };

package/dist/workspace-config/index.js

@@ -0,0 +1,3 @@
+import { BumpStrategySchema, ChangelogFormatSchema, ChangelogTierSchema, ContractsrcSchema, DEFAULT_CONTRACTSRC, FolderConventionsSchema, FormatterConfigSchema, FormatterTypeSchema, OpenApiConfigSchema, OpenApiExportConfigSchema, OpenApiSourceConfigSchema, RuleSyncConfigSchema, RuleSyncTargetSchema, SchemaFormatSchema, VersioningConfigSchema } from "./contractsrc-schema.js";
+
+export { BumpStrategySchema, ChangelogFormatSchema, ChangelogTierSchema, ContractsrcSchema, DEFAULT_CONTRACTSRC, FolderConventionsSchema, FormatterConfigSchema, FormatterTypeSchema, OpenApiConfigSchema, OpenApiExportConfigSchema, OpenApiSourceConfigSchema, RuleSyncConfigSchema, RuleSyncTargetSchema, SchemaFormatSchema, VersioningConfigSchema };

package/dist/workspace-config/workspace-config.docblock.d.ts

@@ -0,0 +1,6 @@
+import { DocBlock } from "@contractspec/lib.contracts/docs";
+
+//#region src/workspace-config/workspace-config.docblock.d.ts
+declare const tech_workspace_config_DocBlocks: DocBlock[];
+//#endregion
+export { tech_workspace_config_DocBlocks };

package/dist/workspace-config/workspace-config.docblock.js

@@ -0,0 +1,45 @@
+import { registerDocBlocks } from "../docs/registry.js";
+
+//#region src/workspace-config/workspace-config.docblock.ts
+const tech_workspace_config_DocBlocks = [{
+	id: "docs.tech.contracts.workspace-config",
+	title: "Workspace Configuration (.contractsrc)",
+	summary: "Configuration-as-code conventions for ContractSpec workspaces (`.contractsrc.json`).",
+	kind: "reference",
+	visibility: "public",
+	route: "/docs/tech/contracts/workspace-config",
+	tags: [
+		"tech",
+		"contracts",
+		"config"
+	],
+	body: `## Workspace Configuration (.contractsrc)
+
+ContractSpec uses a hierarchical configuration system anchored by \`.contractsrc.json\` files. Configuration loader supports standard rc-file discovery (cosmiconfig).
+
+### Schema Formats
+
+The \`schemaFormat\` option controls the output format of schema generation commands (like \`contractspec openapi import\`).
+
+Supported formats:
+- \`contractspec\` (default): Generates standard \`defineSchemaModel\` code.
+- \`zod\`: Generates raw Zod schemas using \`z.object({...})\`.
+- \`json-schema\`: Generates JSON Schema definitions.
+- \`graphql\`: Generates GraphQL SDL type definitions.
+
+### Config Interface
+
+\`\`\`ts
+export interface ContractsrcConfig {
+  // ... existing fields ...
+  schemaFormat?: 'contractspec' | 'zod' | 'json-schema' | 'graphql';
+}
+\`\`\`
+
+Defined in \`@contractspec/lib.contracts/workspace-config\`.
+`
+}];
+registerDocBlocks(tech_workspace_config_DocBlocks);
+
+//#endregion
+export { tech_workspace_config_DocBlocks };