@contractspec/bundle.workspace 3.7.5 → 4.0.0

package/README.md

@@ -1,83 +1,72 @@
 # @contractspec/bundle.workspace
 
-Website: https://contractspec.io/
+Website: https://contractspec.io
 
+**Core workspace bundle that powers ContractSpec CLI, validation, code generation, AI workflows, and repository setup.**
 
-Reusable use-cases and services for ContractSpec workspace operations.
+## What It Provides
 
-## Purpose
+- Provides the service layer behind the CLI, editor integrations, drift detection, diagnostics, and setup flows.
+- Owns workspace-oriented AI agents, prompts, templates, fixers, and validation/reporting services.
+- Acts as the main orchestration bundle for repository lifecycle and codegen workflows.
+- `src/adapters/` contains runtime, provider, or environment-specific adapters.
+- `src/contracts/` contains contract specs, operations, entities, and registry exports.
+- `src/services/` contains business logic services and workflows.
 
-This bundle provides platform-agnostic services that can be used by:
+## Installation
 
-- CLI tools (`@contractspec/app.cli-contractspec`)
-- Web applications
-- VS Code extensions
-- API servers
+`npm install @contractspec/bundle.workspace`
 
-## Architecture
+or
 
-```
-bundle.contractspec-workspace
-├── services/          # Use-case implementations
-│   ├── build.ts       # Build deterministic artifacts from specs (templates-first)
-│   ├── validate.ts    # Validate spec structure (and, later, implementation checks)
-│   ├── diff.ts        # Compare specs (semantic diff)
-│   ├── deps.ts        # Analyze dependencies
-│   ├── list.ts        # Discover specs by glob
-│   └── config.ts      # Load + merge workspace config (.contractsrc.json)
-│   ├── sync.ts        # Sync all specs (validate/build across a workspace)
-│   ├── watch.ts       # Watch specs and trigger validate/build
-│   ├── clean.ts       # Safe-by-default cleanup of generated artifacts
-│   ├── test.ts        # Run TestSpec scenarios (pure runner wrapper)
-│   ├── regenerator.ts # Regenerator service wrapper (no module loading)
-│   ├── integrity.ts   # Analyze spec/feature integrity and coverage
-│   ├── layer-discovery.ts # Discover features, examples, app-configs
-│   ├── doctor/        # Health checks and auto-fixes
-│   └── ci-check/      # CI/CD validation checks
-├── adapters/          # Runtime adapters (Node defaults)
-│   ├── fs.ts          # Filesystem operations
-│   ├── git.ts         # Git operations
-│   ├── watcher.ts     # File watching
-│   ├── ai.ts          # AI providers
-│   └── logger.ts      # Logging/progress
-└── ports/             # Adapter interfaces
-    └── index.ts       # Port type definitions
-```
-
-## Design Principles
-
-- **Adapter pattern**: All I/O goes through explicit ports/adapters
-- **Testable**: Services can be tested with mock adapters
-- **Reusable**: Same services work across CLI, web, and extensions
-- **No CLI dependencies**: No `chalk`, `ora`, `commander`, or `inquirer`
+`bun add @contractspec/bundle.workspace`
 
 ## Usage
 
-```typescript
-import {
-  createNodeAdapters,
-  loadWorkspaceConfig,
-  buildSpec,
-} from '@contractspec/bundle.workspace';
-
-// Create adapters for Node.js runtime
-const adapters = createNodeAdapters();
+Import the root entrypoint from `@contractspec/bundle.workspace`, or choose a documented subpath when you only need one part of the package surface.
 
-// Load workspace config (or use defaults)
-const config = await loadWorkspaceConfig(adapters.fs);
+## Architecture
 
-// Build deterministic artifacts from a spec (templates-first)
-const result = await buildSpec(
-  './my-spec.operation.ts',
-  { fs: adapters.fs, logger: adapters.logger },
-  config
-);
-```
+- `src/services/` contains the core use-cases for build, validate, doctor, diff, setup, examples, and CI flows.
+- `src/adapters/` and `src/ports/` isolate filesystem, git, AI, and workspace integration boundaries.
+- `src/ai/` contains workspace-specific agent definitions, prompts, and model-aware helpers.
+- `src/templates/`, `src/contracts/`, `src/formatters/`, `src.types/`, and `src.utils/` support generated outputs and reporting.
+- `src/index.ts` is the root public barrel and package entrypoint.
+- `src/types.ts` is shared public type definitions.
+
+## Public Entry Points
+
+- Root bundle export with namespaced services, adapters, ports, formatters, templates, contracts, AI helpers, and utilities.
+- Export `.` resolves through `./src/index.ts`.
+
+## Local Commands
+
+- `bun run dev` — contractspec-bun-build dev
+- `bun run build` — bun run prebuild && bun run build:bundle && bun run build:types
+- `bun run test` — bun test
+- `bun run lint` — bun lint:fix
+- `bun run lint:check` — biome check .
+- `bun run lint:fix` — biome check --write --unsafe --only=nursery/useSortedClasses . && biome check --write .
+- `bun run typecheck` — tsc --noEmit
+- `bun run publish:pkg` — bun publish --tolerate-republish --ignore-scripts --verbose
+- `bun run publish:pkg:canary` — bun publish:pkg --tag canary
+- `bun run clean` — rimraf dist .turbo
+- `bun run build:bundle` — contractspec-bun-build transpile
+- `bun run build:types` — contractspec-bun-build types
+- `bun run prebuild` — contractspec-bun-build prebuild
+
+## Recent Updates
+
+- Replace eslint+prettier by biomejs to optimize speed.
+- Add table capabilities.
+- Stability.
+- Package exports.
+- Add latest models and align defaults.
+- Standardize tool naming to underscore notation.
 
 ## Notes
 
-- `sync` / `watch` accept optional overrides so CLI (or an extension) can inject
-  richer build/validate behavior while reusing the deterministic orchestration.
-- `test` and `regenerator` deliberately avoid TypeScript module loading; callers
-  pass already-loaded specs/contexts/rules/sinks.
-
+- Largest bundle in the monorepo (~280 source files); prefer editing existing services over adding new top-level directories.
+- Adapters must implement port interfaces; no direct infrastructure calls from services.
+- AI agent definitions must stay provider-agnostic via the `ai` SDK abstraction.
+- Template changes affect generated code across all consumers; test thoroughly.

package/dist/adapters/ai.d.ts

@@ -1,8 +1,8 @@
 /**
  * Node.js AI adapter implementation using Vercel AI SDK.
  */
-import type { AiAdapter } from '../ports/ai';
 import type { ResolvedContractsrcConfig } from '@contractspec/lib.contracts-spec';
+import type { AiAdapter } from '../ports/ai';
 /**
  * Create a Node.js AI adapter using Vercel AI SDK.
  */

package/dist/adapters/factory.d.ts

@@ -1,8 +1,8 @@
 /**
  * Factory for creating workspace adapters.
  */
-import type { WorkspaceAdapters } from '../ports/logger';
 import { type ResolvedContractsrcConfig } from '@contractspec/lib.contracts-spec/workspace-config';
+import type { WorkspaceAdapters } from '../ports/logger';
 /**
  * Options for creating adapters.
  */

package/dist/adapters/index.d.ts

@@ -1,12 +1,12 @@
 /**
  * Node.js adapter implementations.
  */
-export * from './fs.node';
-export * from './fs.bun';
+export * from './ai';
+export * from './factory';
 export * from './fs';
+export * from './fs.bun';
+export * from './fs.node';
 export * from './git';
-export * from './watcher';
-export * from './ai';
 export * from './logger';
-export * from './factory';
+export * from './watcher';
 export * from './workspace';

package/dist/ai/agents/index.d.ts

@@ -1,9 +1,9 @@
 /**
  * Agent system exports
  */
-export { AgentOrchestrator } from './orchestrator';
-export { SimpleAgent } from './simple-agent';
-export { CursorAgent } from './cursor-agent';
 export { ClaudeCodeAgent } from './claude-code-agent';
+export { CursorAgent } from './cursor-agent';
 export { OpenAICodexAgent } from './openai-codex-agent';
-export type { AgentTask, AgentResult, AgentConfig } from './types';
+export { AgentOrchestrator } from './orchestrator';
+export { SimpleAgent } from './simple-agent';
+export type { AgentConfig, AgentResult, AgentTask } from './types';

package/dist/ai/agents/orchestrator.d.ts

@@ -2,8 +2,8 @@
  * Agent Orchestrator - Coordinates between different AI agents
  * Selects the appropriate agent based on config and task requirements
  */
-import type { AgentResult, AgentTask } from './types';
 import type { AgentMode, ResolvedContractsrcConfig } from '@contractspec/lib.contracts-spec';
+import type { AgentResult, AgentTask } from './types';
 export declare class AgentOrchestrator {
     private config;
     private readonly agents;

package/dist/ai/agents/simple-agent.d.ts

@@ -2,8 +2,8 @@
  * Simple LLM-based agent using direct API calls
  * This is the default fallback for basic code generation
  */
-import type { AgentProvider, AgentResult, AgentTask } from './types';
 import type { ResolvedContractsrcConfig } from '@contractspec/lib.contracts-spec';
+import type { AgentProvider, AgentResult, AgentTask } from './types';
 export declare class SimpleAgent implements AgentProvider {
     private config;
     name: "simple";

package/dist/ai/agents/unified-adapter.d.ts

@@ -1,10 +1,10 @@
 /**
  * Adapter for UnifiedAgent to work with Workspace AgentOrchestrator.
  */
-import type { AgentProvider, AgentResult, AgentTask } from './types';
-import type { AgentMode } from '@contractspec/lib.contracts-spec';
 import { type UnifiedAgentConfig } from '@contractspec/lib.ai-agent/agent/unified-agent';
 import type { AgentSpec } from '@contractspec/lib.ai-agent/spec';
+import type { AgentMode } from '@contractspec/lib.contracts-spec';
+import type { AgentProvider, AgentResult, AgentTask } from './types';
 export declare class UnifiedAgentAdapter implements AgentProvider {
     readonly name: AgentMode;
     private agent;

package/dist/ai/index.d.ts

@@ -1,6 +1,6 @@
 /**
  * AI services for ContractSpec.
  */
-export * from './providers';
 export * from './agents';
 export * as prompts from './prompts';
+export * from './providers';

package/dist/ai/providers.d.ts

@@ -3,8 +3,8 @@
  *
  * Re-exports from @contractspec/lib.ai-providers with workspace-specific additions.
  */
-import type { LanguageModel } from 'ai';
 import type { ResolvedContractsrcConfig } from '@contractspec/lib.contracts-spec';
+import type { LanguageModel } from 'ai';
 /**
  * Initialize AI provider based on configuration
  *

package/dist/contracts/operations/init.operation.d.ts

@@ -3,8 +3,8 @@ export declare const initOperation: import("@contractspec/lib.contracts-spec").O
     yes: z.ZodDefault<z.ZodBoolean>;
     targets: z.ZodOptional<z.ZodArray<z.ZodEnum<{
         cursor: "cursor";
-        mcp: "mcp";
         cli: "cli";
+        mcp: "mcp";
         vscode: "vscode";
         agents: "agents";
         github: "github";
@@ -21,8 +21,8 @@ export declare const initOperation: import("@contractspec/lib.contracts-spec").O
         filePath: z.ZodString;
         action: z.ZodEnum<{
             error: "error";
-            skipped: "skipped";
             created: "created";
+            skipped: "skipped";
             merged: "merged";
         }>;
         message: z.ZodString;

package/dist/formatters/index.d.ts

@@ -1,6 +1,6 @@
 /**
  * Output formatters for CI check results.
  */
-export * from './sarif';
 export * from './json';
+export * from './sarif';
 export * from './text';

package/dist/index.d.ts

@@ -4,12 +4,12 @@
  * Reusable use-cases and services for ContractSpec workspace operations.
  */
 export * as module from '@contractspec/module.workspace';
-export * from './ports/index';
 export * from './adapters/index';
-export * from './services/index';
-export type { FixStrategyType, FixableIssue } from './services/fix/types';
-export * from './registry';
+export * from './ai';
 export * as formatters from './formatters/index';
+export * from './ports/index';
+export * from './registry';
+export type { FixableIssue, FixStrategyType } from './services/fix/types';
+export * from './services/index';
 export * as templates from './templates';
-export * from './ai';
 export * as utils from './utils/index';