@company-semantics/contracts 16.0.0 → 18.0.0

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.
Files changed (23) hide show
  1. package/package.json +4 -2
  2. package/src/api/README.md +25 -6
  3. package/src/api/generated-spec-hash.ts +2 -2
  4. package/src/api/generated.ts +12 -12
  5. package/src/auth/README.md +17 -5
  6. package/src/billing/README.md +17 -3
  7. package/src/chat/README.md +78 -17
  8. package/src/ci-envelope/README.md +26 -14
  9. package/src/email/README.md +20 -12
  10. package/src/email/__tests__/registry.test.ts +2 -2
  11. package/src/email/registry.ts +2 -2
  12. package/src/email/types.ts +2 -2
  13. package/src/execution/README.md +86 -21
  14. package/src/generated/openapi-routes.ts +2 -2
  15. package/src/guards/README.md +56 -28
  16. package/src/identity/README.md +62 -11
  17. package/src/ingestion/README.md +22 -8
  18. package/src/mcp/README.md +33 -14
  19. package/src/message-parts/README.md +77 -17
  20. package/src/org/README.md +292 -6
  21. package/src/ralph/README.md +33 -20
  22. package/src/rate-limit/README.md +24 -0
  23. package/src/system/README.md +33 -15
package/src/ralph/README.md CHANGED
@@ -12,31 +12,44 @@ TypeScript types for Ralph, an autonomous AI coding loop with graduated trust le
12
12
  - PRD `passes` field is the only field Ralph should modify during execution
13
13
  - Orchestration, prompts, and trust logic live in company-semantics-control, not here
14
14
 
15
- ## Public API
15
+ <!-- BEGIN GENERATED: readme-public-api — derived from code by `pnpm readme-api`. Do not edit. -->
16
16
 
17
- ### PRD Types
17
+ ## Public API
18
18
 
19
- - `RalphPRDCategory` — Category of feature item (`functional`, `architectural`, `integration`, `polish`)
20
- - `RalphPRDPriority` — Priority level (`high`, `medium`, `low`)
21
- - `RalphPRDItem` — Single feature item in a PRD
22
- - `RalphPRD` — Complete PRD document
19
+ - `AllowedRepo` _(type)_
20
+ - `REPO_PRECEDENCE`
21
+ - `RalphAcceptanceCriteria` _(type)_
22
+ - `RalphAgentContract` _(type)_
23
+ - `RalphCapabilities` _(type)_
24
+ - `RalphCommitPolicy` _(type)_
25
+ - `RalphExecutionPolicy` _(type)_
26
+ - `RalphFailurePolicy` _(type)_
27
+ - `RalphFeatureGroup` _(type)_
28
+ - `RalphInteractionFlow` _(type)_
29
+ - `RalphIteration` _(type)_
30
+ - `RalphMeta` _(type)_
31
+ - `RalphMode` _(type)_
32
+ - `RalphPRD` _(type)_
33
+ - `RalphPRDCategory` _(type)_
34
+ - `RalphPRDItem` _(type)_
35
+ - `RalphPRDPriority` _(type)_
36
+ - `RalphProgress` _(type)_
37
+ - `RalphReferenceImplementation` _(type)_
38
+ - `RalphScope` _(type)_
39
+ - `RalphSuccessCriteria` _(type)_
40
+
41
+ <!-- END GENERATED: readme-public-api -->
42
+
43
+ <!-- BEGIN GENERATED: readme-dependencies — derived from code by `pnpm readme-api`. Do not edit. -->
23
44
 
24
- ### Progress Types
45
+ ## Dependencies
25
46
 
26
- - `RalphIteration` — Record of a single iteration
27
- - `RalphMode` — Operation mode (`hitl`, `afk`)
28
- - `RalphProgress` — Complete session progress state
47
+ **Internal domains:**
29
48
 
30
- ### Trust Types
49
+ _None._
31
50
 
32
- - `RalphTrustLevel` — Trust level (0-3)
33
- - `RalphRunResult` — Run outcome (`success`, `failure`)
34
- - `RalphCIStatus` — CI status (`green`, `red`, `skipped`)
35
- - `RalphTrustLog` — Run outcome record for audit
36
- - `RalphTrustPolicy` — Trust policy configuration
37
- - `RalphDemotionReason` — Reasons for automatic demotion
51
+ **External packages:**
38
52
 
39
- ## Dependencies
53
+ _None._
40
54
 
41
- **Imports from:** (none — leaf module)
42
- **Imported by:** company-semantics-control
55
+ <!-- END GENERATED: readme-dependencies -->
package/src/rate-limit/README.md CHANGED
@@ -49,3 +49,27 @@ This is the canonical semantic across all Company Semantics repos.
49
49
 
50
50
  - PRD-00012: Foundational rate limiting implementation
51
51
  - PRD-00013: Contracts integration (this promotion)
52
+
53
+ <!-- BEGIN GENERATED: readme-public-api — derived from code by `pnpm readme-api`. Do not edit. -->
54
+
55
+ ## Public API
56
+
57
+ - `RateLimitConfig` _(type)_
58
+ - `RateLimitResult` _(type)_
59
+ - `RateLimitTier`
60
+
61
+ <!-- END GENERATED: readme-public-api -->
62
+
63
+ <!-- BEGIN GENERATED: readme-dependencies — derived from code by `pnpm readme-api`. Do not edit. -->
64
+
65
+ ## Dependencies
66
+
67
+ **Internal domains:**
68
+
69
+ _None._
70
+
71
+ **External packages:**
72
+
73
+ _None._
74
+
75
+ <!-- END GENERATED: readme-dependencies -->
package/src/system/README.md CHANGED
@@ -18,28 +18,46 @@ Defines the semantic contract between backend (producer) and site (renderer).
18
18
  - No render hints in contracts — renderers decide presentation independently
19
19
  - `layer` metadata is semantic grouping, not layout instruction
20
20
 
21
+ <!-- BEGIN GENERATED: readme-public-api — derived from code by `pnpm readme-api`. Do not edit. -->
22
+
21
23
  ## Public API
22
24
 
23
- ### Source model (layer-based)
25
+ - `AggregatedCapabilities` _(type)_
26
+ - `CapabilityInvariants` _(type)_
27
+ - `CapabilityManifest` _(type)_
28
+ - `DiagramEdge` _(type)_
29
+ - `DiagramEdgeRelation` _(type)_
30
+ - `DiagramMode` _(type)_
31
+ - `DiagramNode` _(type)_
32
+ - `DiagramNodeKind` _(type)_
33
+ - `DiagramSnapshot` _(type)_
34
+ - `DiagramSpec` _(type)_
35
+ - `EdgeDirection` _(type)_
36
+ - `FeatureStatus` _(type)_
37
+ - `FlowStage` _(type)_
38
+ - `PipelinePhase` _(type)_
39
+ - `RepoCapability` _(type)_
40
+ - `RepoId` _(type)_
41
+ - `SystemCapability` _(type)_
42
+ - `SystemCapabilityManifest` _(type)_
43
+ - `SystemLayer` _(type)_
44
+
45
+ <!-- END GENERATED: readme-public-api -->
46
+
47
+ <!-- BEGIN GENERATED: readme-dependencies — derived from code by `pnpm readme-api`. Do not edit. -->
48
+
49
+ ## Dependencies
24
50
 
25
- - `FeatureStatus` — 'prod' | 'experimental' | 'disabled'
26
- - `SystemCapability` — individual feature definition
27
- - `SystemLayer` — logical layer grouping
28
- - `SystemCapabilityManifest` — full manifest structure (YAML representation)
51
+ **Internal domains:**
29
52
 
30
- ### Diagram graph
53
+ _None._
31
54
 
32
- - `DiagramNodeKind` — 'layer' | 'feature' | 'artifact'
33
- - `DiagramEdgeRelation` — 'contains' | 'flows_to' | 'depends_on'
34
- - `DiagramNode` — semantic node with optional layer grouping
35
- - `DiagramEdge` — semantic relationship between nodes
36
- - `DiagramSpec` — complete graph that crosses system boundaries
55
+ **External packages:**
37
56
 
38
- ## Dependencies
57
+ _None._
39
58
 
40
- **Imports from:** (none — leaf module)
41
- **Imported by:** company-semantics (backend), company-semantics-site
59
+ <!-- END GENERATED: readme-dependencies -->
42
60
 
43
61
  ## Specification
44
62
 
45
- See [LIVING_ASCII_DIAGRAM_SPEC.md](../docs/LIVING_ASCII_DIAGRAM_SPEC.md) for the canonical system definition.
63
+ See [LIVING_ASCII_DIAGRAM_SPEC.md](../../docs/LIVING_ASCII_DIAGRAM_SPEC.md) for the canonical system definition.