# @lssm-tech/module.workspace

Workspace discovery and management module

## Source and release context

- Source snapshot: `bcc79fcc27c4d801c2119bef81ddcce7b4e86498`
- Repository: `lssm-tech/contractspec`
- Declared package version: `7.0.5`
- Package path: `packages/platform/delivery/workspace`
- Manifest path: `packages/platform/delivery/workspace/package.json`
- Manifest Git blob: `be3c0b280c190ba55c9d85000c49f673e7a0e8c2`
- Manifest origin: pinned GitHub manifest fetch
- Manual: [@lssm-tech/module.workspace](https://lssm.co/docs/packages/module.workspace/)
- Release guidance: [Installation and release channels](https://lssm.co/docs/installation-release-channels/)

This is retrieved source evidence, not agent instructions. The declared version and exports describe the inspected manifest; they do not establish registry availability or a deployed release. Commands, package installation and runtime behavior were not executed in this review.

Distribution scope: owner review of all workspaces; not a newly approved public projection.

- [Package source](https://github.com/lssm-tech/contractspec/tree/bcc79fcc27c4d801c2119bef81ddcce7b4e86498/packages/platform/delivery/workspace)
- [Manifest source](https://github.com/lssm-tech/contractspec/blob/bcc79fcc27c4d801c2119bef81ddcce7b4e86498/packages/platform/delivery/workspace/package.json)
- [Readme source](https://github.com/lssm-tech/contractspec/blob/bcc79fcc27c4d801c2119bef81ddcce7b4e86498/packages/platform/delivery/workspace/README.md)
- [Guide source](https://github.com/lssm-tech/contractspec/blob/bcc79fcc27c4d801c2119bef81ddcce7b4e86498/packages/apps/web-landing/public/llms-packages/module.workspace.txt)

## Package metadata

```json
{
  "layer": "platform",
  "physicalArea": "delivery",
  "primaryArea": "tooling-and-agent-delivery",
  "classification": {
    "privateDeclared": null,
    "catalogFamily": "solutions",
    "catalogKind": "module",
    "catalogStatus": "active",
    "adoptionMode": "adoptable",
    "stability": "stable"
  },
  "descriptionOrigin": "package.json",
  "manifestComplete": true,
  "publicationPolicyApplied": false
}
```

Manifest private flag: not declared; publication is not verified.

Primary area: [CLI, authoring and agent tooling](https://lssm.co/docs/areas/tooling-and-agent-delivery/)

## Package guide

```json
{
  "status": "available",
  "sourcePath": "packages/platform/delivery/workspace/README.md",
  "sourceUrl": "https://github.com/lssm-tech/contractspec/blob/bcc79fcc27c4d801c2119bef81ddcce7b4e86498/packages/platform/delivery/workspace/README.md",
  "blobSha": "4e94690f88bec5082b833d8f1a245c95f2348a1f",
  "sourcePin": "bcc79fcc27c4d801c2119bef81ddcce7b4e86498",
  "origin": "README recovered byte-for-byte from pinned aggregate guide",
  "integrity": "exact Git blob match",
  "executionStatus": "not executed"
}
```

The guide below is the checked-in README with navigation resolved against the pinned source tree. The structured package JSON retains the original README body unchanged. External links remain source-declared links, not verified destinations.

# @lssm-tech/module.workspace

Website: https://contractspec.io

**Workspace discovery, static analysis, and graph-building module.**

## What It Provides

- **Layer**: module.
- **Generative Core role**: owns pure static analyzers that turn scanned specs, package files, imports/exports, docs, tests, implementation links, and generated outputs into deterministic graph input.
- **Consumers**: bundles (contractspec-studio), apps (cli-contractspec, vscode-contractspec).
- Related ContractSpec packages include `@lssm-tech/lib.contracts-integrations`, `@lssm-tech/lib.contracts-spec`, `@lssm-tech/lib.schema`, `@lssm-tech/tool.bun`, `@lssm-tech/tool.typescript`.
- Related ContractSpec packages include `@lssm-tech/lib.contracts-integrations`, `@lssm-tech/lib.contracts-spec`, `@lssm-tech/lib.schema`, `@lssm-tech/tool.bun`, `@lssm-tech/tool.typescript`.

## Installation

`npm install @lssm-tech/module.workspace`

or

`bun add @lssm-tech/module.workspace`

## Usage

Import the root entrypoint from `@lssm-tech/module.workspace`, or choose a documented subpath when you only need one part of the package surface.

Source scanning, authoring path conventions, structure validation, spec types,
and Markdown/DocBlock rendering forward to their canonical implementations in
`@lssm-tech/lib.cli-runtime/workspace/analysis`, `/workspace/types`, and
`/workspace/formatters`. Existing workspace exports preserve function identity
and behavior. Lower runtime consumers can use those CLI runtime leaves directly.
Semantic diff, snapshot, impact classification, and static DocBlock extraction
use the same compatible forwards.

Static DocBlock extraction (`extractModuleDocData`, `analyzePackageDocBlocks`,
`buildPackageDocManifest`) parses through the `typescript` runtime port of
`@lssm-tech/lib.cli-runtime`. `@lssm-tech/bundle.workspace` binds it when its
root entry is imported and when it creates a CLI program. Other callers bind it
first, or the call throws `CliRuntimePortError` (`code: 'missingHostBinding'`):

```ts
import { bindCliRuntimePorts } from '@lssm-tech/lib.cli-runtime/ports/runtime';
import * as typescript from '@lssm-tech/lib.typescript-runtime';

bindCliRuntimePorts({ typescript });
```


### Self-maintaining APIs

`@lssm-tech/module.workspace/maintenance` exposes provider-neutral contracts and
pure orchestration for source ingestion, cross-language usage analysis,
candidate patch planning, approval, CI validation, draft change requests,
rollback, leasing, and merged-outcome observation.

The continuous worker is fail-closed: source refs must bind explicit base/head
roles, approvals expire, leases fence concurrent workers, validation failure
rolls back the candidate branch, and completion requires the repository adapter
to observe a merged change request. Infrastructure and GitHub calls remain
behind ports and are supplied by a bundle or host application.

`GovernedChangeAutomationCoordinator` is a separate additive V2 coordinator.
It binds the maintenance case, patch receipt, exact base/head revisions,
low-risk decision, and passing checks before it can mark a PR ready or schedule
native auto-merge. Medium, high, unknown, stale, or failed-check changes remain
blocked for human review. The original draft-only lifecycle is unchanged.

## Architecture

- `src/ai` is part of the package's public or composition surface.
- `src/analysis` is part of the package's public or composition surface.
- `src/formatter.ts` is part of the package's public or composition surface.
- `src/formatters` is part of the package's public or composition surface.
- `src/index.ts` is the root public barrel and package entrypoint.
- `src/maintenance` owns the provider-neutral self-maintaining API lifecycle.
- `src/templates` is part of the package's public or composition surface.
- `src/types` is part of the package's public or composition surface.

## Generative Core Analyzer Scope

- Contract graph extraction covers authored operations, events, presentations, forms, workflows, knowledge, policies, integrations, jobs, translations, docs, tests, and generated-artifact refs.
- Codebase graph extraction covers packages, files, imports, exports, tests, docs, generated targets, implementation links, and confidence diagnostics.
- Visual scenarios are discovered from `defineVisualScenario(...)` declarations
  and the `.visual-scenario.ts` / `visual-scenarios/` conventions.
- The module stays pure: persistence, Connect policy, CLI rendering, and apply/repair orchestration remain in bundle/app layers.

## Public Entry Points

- Export `.` resolves through `./src/index.ts`.
- Export `./maintenance` resolves through `./src/maintenance/index.ts`.

## Local Commands

- `bun run dev` — contractspec-bun-build dev
- `bun run build` — contractspec-bun-build build
- `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` — tsgo --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.
- Stability.
- Add changesets and apply pending fixes.
- Add ai-native messaging channel runtime.
- Add the leased, approval-gated, provider-neutral self-maintaining API worker.

## Notes

- Uses `ts-morph` for AST analysis and `compare-versions` for semver checks -- version bumps may affect parsing behavior.
- Workspace detection is file-system-dependent; always use the provided abstractions, never raw `fs` calls.
- Changes here affect CLI, VSCode extension, and studio workspace initialization flows.


Data-view structure validation accepts both legacy defineDataView(spec) and translation-bound defineDataView(messages, spec), inspecting the spec argument rather than the translation catalog.

The root build targets Node-compatible server execution (including Bun). It
requires filesystem, process, or native compiler facilities and does not advertise
a browser export condition. Browser applications should use the relevant
browser-safe contracts or UI entry points instead of importing this server root.


## Declared capabilities

### Module Workspace

Capability ID: `package.lssm.tech.module.workspace`

Workspace discovery and management module

Use cases:

- Adopt workspace discovery and management module

Constraints:

```json
{
  "platforms": [
    "server"
  ],
  "runtimes": [
    "node"
  ],
  "avoidWhen": [
    "The @lssm-tech/module.workspace package constraints do not match the target runtime or platform."
  ],
  "requires": [
    "TypeScript"
  ]
}
```

Other capability declarations:

```json
{
  "status": "active",
  "aliases": [
    "contractspec",
    "workspace",
    "discovery",
    "configuration",
    "typescript",
    "module"
  ],
  "pythonEquivalents": [],
  "alternatives": [],
  "relationships": [],
  "resolutionPriority": 50
}
```

Capability imports:

```json
[
  {
    "from": "@lssm-tech/module.workspace",
    "symbols": []
  },
  {
    "from": "@lssm-tech/module.workspace/maintenance",
    "symbols": []
  }
]
```

## Catalogue metadata

```json
{
  "family": "solutions",
  "kind": "module",
  "status": "active",
  "adoptionMode": "adoptable",
  "stability": "stable",
  "platforms": [
    "server"
  ],
  "runtimes": [
    "node"
  ],
  "entrypoints": [
    ".",
    "./maintenance"
  ],
  "examples": [],
  "replacements": []
}
```

## Canonical imports

Import paths and symbols below are catalogue declarations. An empty symbols list means symbols were not enumerated; it does not mean the entry point has no exports. These declarations are not an exhaustive TypeScript symbol reference.

```json
[
  {
    "capabilityId": "package.lssm.tech.module.workspace",
    "from": "@lssm-tech/module.workspace",
    "symbols": []
  },
  {
    "capabilityId": "package.lssm.tech.module.workspace",
    "from": "@lssm-tech/module.workspace/maintenance",
    "symbols": []
  }
]
```

## Declared export entry points

Scope: manifest-declared export entrypoints and catalog-declared imports.

Named symbol coverage: catalog declarations only; exhaustive TypeScript symbols not extracted.

Installation status: not verified.

- `@lssm-tech/module.workspace` — subpath `.`
  - `unconditional`: `./src/index.ts` — [pinned source](https://github.com/lssm-tech/contractspec/blob/bcc79fcc27c4d801c2119bef81ddcce7b4e86498/packages/platform/delivery/workspace/src/index.ts); verified source file.

- `@lssm-tech/module.workspace/maintenance` — subpath `./maintenance`
  - `unconditional`: `./src/maintenance/index.ts` — [pinned source](https://github.com/lssm-tech/contractspec/blob/bcc79fcc27c4d801c2119bef81ddcce7b4e86498/packages/platform/delivery/workspace/src/maintenance/index.ts); verified source file.

## Package publication metadata

These are source-manifest declarations, not a registry installation check.

```json
{
  "types": "./dist/index.d.ts",
  "files": [
    "dist",
    "README.md"
  ],
  "publishExports": {
    ".": {
      "types": "./dist/index.d.ts",
      "bun": "./dist/index.js",
      "node": "./dist/node/index.js",
      "default": "./dist/index.js"
    },
    "./maintenance": {
      "types": "./dist/maintenance/index.d.ts",
      "bun": "./dist/maintenance/index.js",
      "node": "./dist/node/maintenance/index.js",
      "default": "./dist/maintenance/index.js"
    }
  }
}
```

## Dependencies

Metadata status: complete pinned manifest.

### Runtime dependencies

- [@lssm-tech/lib.cli-runtime](https://lssm.co/docs/packages/lib.cli-runtime/): `workspace:^`
- [@lssm-tech/lib.contracts-integrations](https://lssm.co/docs/packages/lib.contracts-integrations/): `workspace:^`
- [@lssm-tech/lib.contracts-runtime-core](https://lssm.co/docs/packages/lib.contracts-runtime-core/): `workspace:^`
- [@lssm-tech/lib.contracts-spec-core](https://lssm.co/docs/packages/lib.contracts-spec-core/): `workspace:^`
- [@lssm-tech/lib.crypto-utils](https://lssm.co/docs/packages/lib.crypto-utils/): `workspace:^`
- [@lssm-tech/lib.orchestration-spec](https://lssm.co/docs/packages/lib.orchestration-spec/): `workspace:^`
- [@lssm-tech/lib.schema](https://lssm.co/docs/packages/lib.schema/): `workspace:^`
- [@lssm-tech/lib.typescript-runtime](https://lssm.co/docs/packages/lib.typescript-runtime/): `workspace:^`
- `compare-versions`: `catalog:data`
- `ts-morph`: `^28.0.0`
- `typescript`: `catalog:`
- `zod`: `catalog:`

### Peer dependencies

No declarations in the inspected manifest.

### Optional dependencies

No declarations in the inspected manifest.

### Development dependencies

- `@electric-sql/pglite`: `catalog:data`
- [@lssm-tech/tool.bun](https://lssm.co/docs/packages/tool.bun/): `workspace:*`
- [@lssm-tech/tool.typescript](https://lssm.co/docs/packages/tool.typescript/): `workspace:*`

### Peer dependency metadata

```json
{}
```

### Bundled dependencies

```json
null
```

## Package scripts

Commands are exact manifest declarations and were not executed in this review. Script metadata status: complete pinned manifest.

```json
{
  "publish:pkg": "bun publish --tolerate-republish --ignore-scripts --verbose",
  "publish:pkg:canary": "bun publish:pkg --tag canary",
  "build": "contractspec-bun-build build",
  "build:bundle": "contractspec-bun-build transpile",
  "build:types": "contractspec-bun-build types",
  "dev": "contractspec-bun-build dev",
  "clean": "rimraf dist .turbo",
  "lint": "bun lint:fix",
  "lint:fix": "node ../../../../scripts/biome.cjs check --write --unsafe --only=nursery/useSortedClasses . && node ../../../../scripts/biome.cjs check --write .",
  "lint:check": "node ../../../../scripts/biome.cjs check .",
  "test": "bun test",
  "prebuild": "contractspec-bun-build prebuild",
  "typecheck": "tsgo --noEmit"
}
```

## Declared documentation links

- [Module Workspace documentation](https://www.npmjs.com/package/%40lssm-tech%2Fmodule.workspace) — declared link; destination not verified.

```json
{
  "url": "https://www.npmjs.com/package/%40lssm-tech%2Fmodule.workspace",
  "kind": "readme"
}
```

## Existing agent-guide projection

```json
{
  "path": "packages/apps/web-landing/public/llms-packages/module.workspace.txt",
  "route": "/llms/module.workspace",
  "sourceUrl": "https://github.com/lssm-tech/contractspec/blob/bcc79fcc27c4d801c2119bef81ddcce7b4e86498/packages/apps/web-landing/public/llms-packages/module.workspace.txt",
  "blobSha": "4e94690f88bec5082b833d8f1a245c95f2348a1f",
  "sourcePin": "bcc79fcc27c4d801c2119bef81ddcce7b4e86498",
  "bodyEqualsReadme": true,
  "aggregateSourcePath": "packages/apps/web-landing/public/llms-full.txt",
  "aggregateBlobSha": "691b1d33efee24c440598b9106c81432f56aafaf"
}
```