@company-semantics/contracts 16.0.0 → 17.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.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@company-semantics/contracts",
3
- "version": "16.0.0",
3
+ "version": "17.0.0",
4
4
  "private": false,
5
5
  "repository": {
6
6
  "type": "git",
@@ -111,7 +111,9 @@
111
111
  "generate:api-types:check": "openapi-typescript openapi/backend.yaml -o /tmp/cs-api-types-check.ts && diff -q src/api/generated.ts /tmp/cs-api-types-check.ts",
112
112
  "generate:current": "tsx ../company-semantics-ci/scripts/generate-current.ts",
113
113
  "repo-map": "tsx ../company-semantics-ci/scripts/generate-repo-map.ts --roots src --name company-semantics-contracts --write",
114
- "repo-map:check": "tsx ../company-semantics-ci/scripts/generate-repo-map.ts --roots src --name company-semantics-contracts --check"
114
+ "repo-map:check": "tsx ../company-semantics-ci/scripts/generate-repo-map.ts --roots src --name company-semantics-contracts --check",
115
+ "readme-api": "tsx ../company-semantics-ci/scripts/generate-readme-api.ts --roots src --write",
116
+ "readme-api:check": "tsx ../company-semantics-ci/scripts/generate-readme-api.ts --roots src --check"
115
117
  },
116
118
  "packageManager": "pnpm@10.25.0",
117
119
  "engines": {
package/src/api/README.md CHANGED
@@ -26,14 +26,33 @@ Regenerate with `pnpm generate:api-types`. Check for staleness with `pnpm genera
26
26
 
27
27
  The file is committed to the repo (not .gitignored) so consumers can import types without running the generator, and type changes are visible in code review diffs.
28
28
 
29
+ <!-- BEGIN GENERATED: readme-public-api — derived from code by `pnpm readme-api`. Do not edit. -->
30
+
29
31
  ## Public API
30
32
 
31
- - `buildToolDiscoveryResponse(tools, includeGraph)` — Constructs a `ToolDiscoveryResponse`, optionally including the capability graph derived from tool metadata
32
- - `paths` (type) — OpenAPI route type map for typed fetch clients
33
- - `components` (type) — OpenAPI schema types
34
- - `operations` (type) — OpenAPI operation types keyed by operationId
33
+ - `CursorPage` _(type)_
34
+ - `CursorPageSchema`
35
+ - `ErrorResponse` _(type)_
36
+ - `ErrorResponseSchema`
37
+ - `SPEC_HASH`
38
+ - `SPEC_HASH_FULL`
39
+ - `components` _(type)_
40
+ - `operations` _(type)_
41
+ - `paths` _(type)_
42
+
43
+ <!-- END GENERATED: readme-public-api -->
44
+
45
+ <!-- BEGIN GENERATED: readme-dependencies — derived from code by `pnpm readme-api`. Do not edit. -->
35
46
 
36
47
  ## Dependencies
37
48
 
38
- - `src/mcp/` — `MCPToolDescriptor`, `ToolDiscoveryResponse`, `CapabilityGraph` types and `buildCapabilityGraph` function
39
- - `openapi/backend.yaml` — Source OpenAPI 3.1 spec for type generation
49
+ **Internal domains:**
50
+
51
+ - `mcp`
52
+ - `resource-response`
53
+
54
+ **External packages:**
55
+
56
+ - `zod`
57
+
58
+ <!-- END GENERATED: readme-dependencies -->
@@ -1,3 +1,3 @@
1
1
  // AUTO-GENERATED — do not edit. Run pnpm generate:spec-hash to regenerate.
2
- export const SPEC_HASH = 'bd74b6f7478d' as const;
3
- export const SPEC_HASH_FULL = 'bd74b6f7478dcfb445d1e848ab3b65309f9b602b40c3fe2f0ce29b484e94943f' as const;
2
+ export const SPEC_HASH = '0145da47b329' as const;
3
+ export const SPEC_HASH_FULL = '0145da47b329d350ecef5661168bcdd0a7399c5aa3cacd2ad53f5d76ef2d5908' as const;
@@ -1955,7 +1955,7 @@ export interface paths {
1955
1955
  patch?: never;
1956
1956
  trace?: never;
1957
1957
  };
1958
- "/api/org-units/{unitId}/structural-leaders": {
1958
+ "/api/org-units/{unitId}/unit-owners": {
1959
1959
  parameters: {
1960
1960
  query?: never;
1961
1961
  header?: never;
@@ -1964,15 +1964,15 @@ export interface paths {
1964
1964
  };
1965
1965
  get?: never;
1966
1966
  put?: never;
1967
- /** Assign a user as structural leader of an org unit */
1968
- post: operations["assignOrgUnitStructuralLeader"];
1967
+ /** Assign a user as unit owner of an org unit */
1968
+ post: operations["assignOrgUnitOwner"];
1969
1969
  delete?: never;
1970
1970
  options?: never;
1971
1971
  head?: never;
1972
1972
  patch?: never;
1973
1973
  trace?: never;
1974
1974
  };
1975
- "/api/org-units/{unitId}/structural-leaders/{userId}": {
1975
+ "/api/org-units/{unitId}/unit-owners/{userId}": {
1976
1976
  parameters: {
1977
1977
  query?: never;
1978
1978
  header?: never;
@@ -1982,8 +1982,8 @@ export interface paths {
1982
1982
  get?: never;
1983
1983
  put?: never;
1984
1984
  post?: never;
1985
- /** Remove a user as structural leader of an org unit */
1986
- delete: operations["removeOrgUnitStructuralLeader"];
1985
+ /** Remove a user as unit owner of an org unit */
1986
+ delete: operations["removeOrgUnitOwner"];
1987
1987
  options?: never;
1988
1988
  head?: never;
1989
1989
  patch?: never;
@@ -4628,7 +4628,7 @@ export interface components {
4628
4628
  revokedAt: string | null;
4629
4629
  reason: string | null;
4630
4630
  };
4631
- StructuralLeaderAssignResponse: {
4631
+ UnitOwnerAssignResponse: {
4632
4632
  /** Format: uuid */
4633
4633
  id: string;
4634
4634
  /** Format: uuid */
@@ -8485,7 +8485,7 @@ export interface operations {
8485
8485
  };
8486
8486
  };
8487
8487
  };
8488
- assignOrgUnitStructuralLeader: {
8488
+ assignOrgUnitOwner: {
8489
8489
  parameters: {
8490
8490
  query?: never;
8491
8491
  header?: never;
@@ -8505,18 +8505,18 @@ export interface operations {
8505
8505
  };
8506
8506
  };
8507
8507
  responses: {
8508
- /** @description Created structural-leader overlay row */
8508
+ /** @description Created unit-owner overlay row */
8509
8509
  201: {
8510
8510
  headers: {
8511
8511
  [name: string]: unknown;
8512
8512
  };
8513
8513
  content: {
8514
- "application/json": components["schemas"]["StructuralLeaderAssignResponse"];
8514
+ "application/json": components["schemas"]["UnitOwnerAssignResponse"];
8515
8515
  };
8516
8516
  };
8517
8517
  };
8518
8518
  };
8519
- removeOrgUnitStructuralLeader: {
8519
+ removeOrgUnitOwner: {
8520
8520
  parameters: {
8521
8521
  query?: never;
8522
8522
  header?: never;
@@ -8528,7 +8528,7 @@ export interface operations {
8528
8528
  };
8529
8529
  requestBody?: never;
8530
8530
  responses: {
8531
- /** @description Structural-leader authority revoked */
8531
+ /** @description Unit-owner authority revoked */
8532
8532
  204: {
8533
8533
  headers: {
8534
8534
  [name: string]: unknown;
@@ -9,14 +9,26 @@ Shared types for authentication flows across Company Semantics codebases. Define
9
9
  - AuthStartResponse is a discriminated union on `mode` — consumers must handle all three modes
10
10
  - OTPErrorCode values are stable strings used by both backend (error generation) and frontend (user messaging)
11
11
 
12
+ <!-- BEGIN GENERATED: readme-public-api — derived from code by `pnpm readme-api`. Do not edit. -->
13
+
12
14
  ## Public API
13
15
 
14
- **Types:**
16
+ - `AuthStartMode` _(type)_
17
+ - `AuthStartResponse` _(type)_
18
+ - `OTPErrorCode`
19
+
20
+ <!-- END GENERATED: readme-public-api -->
15
21
 
16
- - `OTPErrorCode` enum: `InvalidCode`, `Expired`, `AlreadyUsed`, `NotFound`
17
- - `AuthStartMode` — `'otp' | 'sso' | 'hybrid'`
18
- - `AuthStartResponse` — discriminated union describing auth flow entry point
22
+ <!-- BEGIN GENERATED: readme-dependenciesderived from code by `pnpm readme-api`. Do not edit. -->
19
23
 
20
24
  ## Dependencies
21
25
 
22
- - None (leaf domain in contracts)
26
+ **Internal domains:**
27
+
28
+ _None._
29
+
30
+ **External packages:**
31
+
32
+ _None._
33
+
34
+ <!-- END GENERATED: readme-dependencies -->
@@ -12,11 +12,25 @@ Defines the shared type vocabulary for organization billing status and plan info
12
12
  - `billingOwnerUserId` must equal `org.ownerUserId` — no separate billing owner concept in v1
13
13
  - `OrgPlanStatus` is a closed union: `active`, `trialing`, `past_due`, `canceled`
14
14
 
15
+ <!-- BEGIN GENERATED: readme-public-api — derived from code by `pnpm readme-api`. Do not edit. -->
16
+
15
17
  ## Public API
16
18
 
17
- - `OrgPlanStatus` — Union type for organization plan states
18
- - `OrgBillingInfo` — Read-only billing information (plan name, status, cadence, seats, billing owner)
19
+ - `OrgBillingInfo` _(type)_
20
+ - `OrgPlanStatus` _(type)_
21
+
22
+ <!-- END GENERATED: readme-public-api -->
23
+
24
+ <!-- BEGIN GENERATED: readme-dependencies — derived from code by `pnpm readme-api`. Do not edit. -->
19
25
 
20
26
  ## Dependencies
21
27
 
22
- - None — leaf domain with no imports from other contracts modules
28
+ **Internal domains:**
29
+
30
+ _None._
31
+
32
+ **External packages:**
33
+
34
+ _None._
35
+
36
+ <!-- END GENERATED: readme-dependencies -->
@@ -13,29 +13,90 @@ Shared types for chat persistence, sharing, real-time events, and runtime profil
13
13
  - Runtime profile labels are vendor-agnostic (no model names in UI)
14
14
  - Default runtime profile is `agentic`
15
15
 
16
+ <!-- BEGIN GENERATED: readme-public-api — derived from code by `pnpm readme-api`. Do not edit. -->
17
+
16
18
  ## Public API
17
19
 
18
- **Types:**
20
+ - `BaseEvent` _(type)_
21
+ - `BaseEventSchema`
22
+ - `CHAT_RUNTIME_PROFILES`
23
+ - `ChatByInteractionResponse` _(type)_
24
+ - `ChatByInteractionResponseSchema`
25
+ - `ChatChangedField` _(type)_
26
+ - `ChatChangedFieldSchema`
27
+ - `ChatCreatedEvent` _(type)_
28
+ - `ChatCreatedEventSchema`
29
+ - `ChatDeletedEvent` _(type)_
30
+ - `ChatDeletedEventSchema`
31
+ - `ChatDetail` _(type)_
32
+ - `ChatDetailSchema`
33
+ - `ChatDomainEvent` _(type)_
34
+ - `ChatDomainEventSchema`
35
+ - `ChatInvalidationEvent` _(type)_
36
+ - `ChatInvalidationEventSchema`
37
+ - `ChatListFilters` _(type)_
38
+ - `ChatListResponse` _(type)_
39
+ - `ChatListResponseSchema`
40
+ - `ChatMessage` _(type)_
41
+ - `ChatMessageSchema`
42
+ - `ChatRuntimeProfile` _(type)_
43
+ - `ChatRuntimeProfileInfo` _(type)_
44
+ - `ChatShareInfo` _(type)_
45
+ - `ChatShareInfoSchema`
46
+ - `ChatSseEvent` _(type)_
47
+ - `ChatSseEventSchema`
48
+ - `ChatSuccessResponse` _(type)_
49
+ - `ChatSuccessResponseSchema`
50
+ - `ChatSummary` _(type)_
51
+ - `ChatSummaryExtended` _(type)_
52
+ - `ChatSummaryExtendedSchema`
53
+ - `ChatSummarySchema`
54
+ - `ChatUpdatedEvent` _(type)_
55
+ - `ChatUpdatedEventSchema`
56
+ - `ChatVisibility` _(type)_
57
+ - `ChatVisibilitySchema`
58
+ - `CreateChatResponse` _(type)_
59
+ - `CreateChatResponseSchema`
60
+ - `CreateShareRequest` _(type)_
61
+ - `CreateShareResponse` _(type)_
62
+ - `CreateShareResponseSchema`
63
+ - `DEFAULT_CHAT_RUNTIME_PROFILE`
64
+ - `GetChatResponse` _(type)_
65
+ - `GetChatResponseSchema`
66
+ - `InvalidateChatEvent` _(type)_
67
+ - `InvalidateChatEventSchema`
68
+ - `InvalidateChatListEvent` _(type)_
69
+ - `InvalidateChatListEventSchema`
70
+ - `InvalidationReason` _(type)_
71
+ - `InvalidationReasonSchema`
72
+ - `IsoDateString`
73
+ - `ListSharesResponse` _(type)_
74
+ - `ListSharesResponseSchema`
75
+ - `SharedChatMessage` _(type)_
76
+ - `SharedChatMessageSchema`
77
+ - `SharedChatView` _(type)_
78
+ - `SharedChatViewSchema`
79
+ - `TitleGenerationRequest` _(type)_
80
+ - `TitleGenerationResponse` _(type)_
81
+ - `TitleGenerationResponseSchema`
82
+ - `TitleSource` _(type)_
83
+ - `TitleSourceSchema`
84
+ - `UpdateShareRequest` _(type)_
85
+ - `UpdateShareResponse` _(type)_
86
+ - `UpdateShareResponseSchema`
87
+
88
+ <!-- END GENERATED: readme-public-api -->
19
89
 
20
- - `ChatVisibility` `'private' | 'public'` share visibility
21
- - `ChatSummary`, `ChatSummaryExtended` — list view models
22
- - `ChatShareInfo`, `SharedChatView`, `SharedChatMessage` — sharing types
23
- - `CreateShareRequest`, `UpdateShareRequest` — share mutation requests
24
- - `TitleSource`, `ChatListFilters`, `TitleGenerationRequest/Response` — lifecycle types
25
- - `ChatRuntimeProfile` — `'fast' | 'balanced' | 'agentic'` orchestration strategy
26
- - `ChatRuntimeProfileInfo` — profile metadata for UI rendering
90
+ <!-- BEGIN GENERATED: readme-dependenciesderived from code by `pnpm readme-api`. Do not edit. -->
27
91
 
28
- **SSE event types:**
92
+ ## Dependencies
29
93
 
30
- - `ChatCreatedEvent`, `ChatUpdatedEvent`, `ChatDeletedEvent` — domain events
31
- - `InvalidateChatEvent`, `InvalidateChatListEvent` — staleness signals
32
- - `ChatSseEvent` — union of all SSE event types
94
+ **Internal domains:**
33
95
 
34
- **Runtime values:**
96
+ _None._
35
97
 
36
- - `CHAT_RUNTIME_PROFILES` — ordered array of profile info for UI rendering
37
- - `DEFAULT_CHAT_RUNTIME_PROFILE` — `'agentic'`
98
+ **External packages:**
38
99
 
39
- ## Dependencies
100
+ - `zod`
40
101
 
41
- - None (leaf domain in contracts)
102
+ <!-- END GENERATED: readme-dependencies -->
@@ -13,24 +13,36 @@ Defines the shared type vocabulary for CI execution envelopes. An envelope is an
13
13
  - `ENVELOPE_TRANSITIONS` documents the state machine but does not enforce it
14
14
  - Terminal states: `blocked` and `finalized` have no outgoing transitions
15
15
 
16
- ## Public API
16
+ <!-- BEGIN GENERATED: readme-public-api — derived from code by `pnpm readme-api`. Do not edit. -->
17
17
 
18
- **Types:**
18
+ ## Public API
19
19
 
20
- - `CIExecutionEnvelope` — Core envelope record (version, id, actor, session, intent, scope, authority, guardPlan, status, outcome)
21
- - `CIEnvelopeStatus` — Lifecycle states: `proposed` → `validated` → `executing` → `finalized` (or `blocked`)
22
- - `ExecutionIntent` — Semantic categories: `feature_extension`, `bug_fix`, `refactor_structural`, `guard_update`, `policy_update`, `schema_change`, `doc_update`, `cleanup`, `experimental`
23
- - `CIIntentDeclaration` — Intent with description and optional ADR references
24
- - `CIExecutionScope` — Affected repos, path globs, and change kinds
25
- - `CIAuthorityGrant` — Permission basis (CLAUDE.md/AI_AUTONOMY.md references)
26
- - `CIGuardPlan` — Required and advisory guard lists
27
- - `CIActorInfo`, `CISessionInfo` — Actor and session metadata
28
- - `CIGuardViolation`, `CIExecutionOutcome` — Post-execution audit data
20
+ - `CIActorInfo` _(type)_
21
+ - `CIAuthorityGrant` _(type)_
22
+ - `CIChangeKind` _(type)_
23
+ - `CIEnvelopeStatus` _(type)_
24
+ - `CIExecutionEnvelope` _(type)_
25
+ - `CIExecutionOutcome` _(type)_
26
+ - `CIExecutionScope` _(type)_
27
+ - `CIGuardPlan` _(type)_
28
+ - `CIGuardViolation` _(type)_
29
+ - `CIIntentDeclaration` _(type)_
30
+ - `CISessionInfo` _(type)_
31
+ - `ENVELOPE_TRANSITIONS`
32
+ - `ExecutionIntent` _(type)_
29
33
 
30
- **Constants:**
34
+ <!-- END GENERATED: readme-public-api -->
31
35
 
32
- - `ENVELOPE_TRANSITIONS` Valid status transition graph (documentation only)
36
+ <!-- BEGIN GENERATED: readme-dependenciesderived from code by `pnpm readme-api`. Do not edit. -->
33
37
 
34
38
  ## Dependencies
35
39
 
36
- - None (leaf module — no imports from other contracts domains)
40
+ **Internal domains:**
41
+
42
+ _None._
43
+
44
+ **External packages:**
45
+
46
+ _None._
47
+
48
+ <!-- END GENERATED: readme-dependencies -->
@@ -14,22 +14,30 @@ TypeScript types and registry for transactional email kinds and their metadata.
14
14
  - Subjects are owned by the registry, never duplicated in templates
15
15
  - Unknown email kinds MUST be rejected at API boundaries via `isValidEmailKind()`
16
16
 
17
- ## Public API
17
+ <!-- BEGIN GENERATED: readme-public-api — derived from code by `pnpm readme-api`. Do not edit. -->
18
18
 
19
- ### Types
19
+ ## Public API
20
20
 
21
- - `EmailKind` — Union of valid email kind identifiers
22
- - `EmailPayloads` — Type-safe payload mapping for each kind
23
- - `SendEmailInput<K>` — Type-safe input for sending emails
24
- - `EmailKindDefinition` — Full definition schema for a kind
21
+ - `EMAIL_KINDS`
22
+ - `EmailKind` _(type)_
23
+ - `EmailKindDefinition` _(type)_
24
+ - `EmailPayloads` _(type)_
25
+ - `SendEmailInput` _(type)_
26
+ - `getEmailKindDefinition`
27
+ - `isValidEmailKind`
25
28
 
26
- ### Registry & Functions
29
+ <!-- END GENERATED: readme-public-api -->
27
30
 
28
- - `EMAIL_KINDS` Registry of all email kinds
29
- - `getEmailKindDefinition(kind)` — Type-safe registry lookup
30
- - `isValidEmailKind(kind)` — Validate string is EmailKind
31
+ <!-- BEGIN GENERATED: readme-dependencies — derived from code by `pnpm readme-api`. Do not edit. -->
31
32
 
32
33
  ## Dependencies
33
34
 
34
- **Imports from:** (none — leaf module)
35
- **Imported by:** company-semantics-backend (email service, templates)
35
+ **Internal domains:**
36
+
37
+ _None._
38
+
39
+ **External packages:**
40
+
41
+ _None._
42
+
43
+ <!-- END GENERATED: readme-dependencies -->
@@ -14,33 +14,98 @@ TypeScript types and registry for execution kinds and their governance metadata.
14
14
  - `visibility` is derived from `EXECUTION_KINDS[kind].governance.visibility`, never independently authored
15
15
  - Unknown execution kinds MUST be rejected at API boundaries via `isValidExecutionKind()`
16
16
 
17
+ <!-- BEGIN GENERATED: readme-public-api — derived from code by `pnpm readme-api`. Do not edit. -->
18
+
17
19
  ## Public API
18
20
 
19
- ### Types
21
+ - `ApprovalRequestedMetadata` _(type)_
22
+ - `AuditExportBundle` _(type)_
23
+ - `AuditExportEvent` _(type)_
24
+ - `CancelledMetadata` _(type)_
25
+ - `ConfirmExecutionResponse` _(type)_
26
+ - `ConfirmExecutionResponseSchema`
27
+ - `ConfirmationApprovedMetadata` _(type)_
28
+ - `ConfirmationExpiredMetadata` _(type)_
29
+ - `ConfirmationRejectedMetadata` _(type)_
30
+ - `EFFECTIVE_TERMINAL_STATES`
31
+ - `EXECUTION_EVENT_TYPES`
32
+ - `EXECUTION_KINDS`
33
+ - `EXECUTION_STATES`
34
+ - `EventHashFields` _(type)_
35
+ - `ExecutionCompletedMetadata` _(type)_
36
+ - `ExecutionCreatedMetadata` _(type)_
37
+ - `ExecutionDomain` _(type)_
38
+ - `ExecutionError` _(type)_
39
+ - `ExecutionErrorCode` _(type)_
40
+ - `ExecutionEventMetadataMap` _(type)_
41
+ - `ExecutionEventType` _(type)_
42
+ - `ExecutionEventTypeSchema`
43
+ - `ExecutionFailedMetadata` _(type)_
44
+ - `ExecutionInitiator` _(type)_
45
+ - `ExecutionIntent` _(type)_
46
+ - `ExecutionKind` _(type)_
47
+ - `ExecutionKindDefinition` _(type)_
48
+ - `ExecutionListResponse` _(type)_
49
+ - `ExecutionListResponseSchema`
50
+ - `ExecutionResultDataSchema`
51
+ - `ExecutionResultResponse` _(type)_
52
+ - `ExecutionResultResponseSchema`
53
+ - `ExecutionSseEvent` _(type)_
54
+ - `ExecutionSseEventSchema`
55
+ - `ExecutionStartedMetadata` _(type)_
56
+ - `ExecutionState` _(type)_
57
+ - `ExecutionStateSchema`
58
+ - `ExecutionStatus` _(type)_
59
+ - `ExecutionSummary` _(type)_
60
+ - `ExecutionSummaryProjectionSchema`
61
+ - `ExecutionSummaryResponse` _(type)_
62
+ - `ExecutionSummarySchema`
63
+ - `ExecutionTarget` _(type)_
64
+ - `ExecutionTimelineResponse` _(type)_
65
+ - `ExecutionTimelineResponseSchema`
66
+ - `FrozenExecutionIntent` _(type)_
67
+ - `GetExecutionSummaryResponse` _(type)_
68
+ - `GetExecutionSummaryResponseSchema`
69
+ - `HASH_ALGORITHM`
70
+ - `HASH_ENCODING`
71
+ - `HashChainVerificationResult` _(type)_
72
+ - `ISO8601Timestamp` _(type)_
73
+ - `IconName` _(type)_
74
+ - `LIFECYCLE_DECISIONS`
75
+ - `LifecycleDecision` _(type)_
76
+ - `LifecycleIntent` _(type)_
77
+ - `RejectExecutionResponse` _(type)_
78
+ - `RejectExecutionResponseSchema`
79
+ - `StartExecutionResponse` _(type)_
80
+ - `StartExecutionResponseSchema`
81
+ - `TERMINAL_STATES`
82
+ - `TimelineEvent` _(type)_
83
+ - `TimelineEventSchema`
84
+ - `TimelineIcon` _(type)_
85
+ - `TimelineStatus` _(type)_
86
+ - `TimelineUIEvent` _(type)_
87
+ - `UndoCompletedMetadata` _(type)_
88
+ - `VALID_TRANSITIONS`
89
+ - `applyIntent`
90
+ - `assertValidTransition`
91
+ - `getExecutionKindDefinition`
92
+ - `isConfirmationExpired`
93
+ - `isExecutionEventType`
94
+ - `isValidExecutionKind`
95
+ - `parseExpiresAt`
96
+
97
+ <!-- END GENERATED: readme-public-api -->
20
98
 
21
- - `ExecutionKind` Union of valid execution kind identifiers
22
- - `ExecutionKindDefinition` — Full definition schema for a kind
23
- - `ExecutionDomain` — Domain category (`integration`, `policy`, `data`, `system`)
24
- - `ISO8601Timestamp` — ISO 8601 timestamp string alias
25
- - `IconName` — Icon identifiers for UI
99
+ <!-- BEGIN GENERATED: readme-dependenciesderived from code by `pnpm readme-api`. Do not edit. -->
26
100
 
27
- ### Projection Contracts
101
+ ## Dependencies
28
102
 
29
- - `ExecutionSummary` — Admin-facing execution view (derived from audit records)
30
- - `ExecutionTarget` — Target of execution (e.g., Slack workspace)
31
- - `ExecutionInitiator` — Who initiated the execution
32
- - `ExecutionStatus` — Execution status (`pending`, `succeeded`, `failed`)
33
- - `TimelineUIEvent` — User-facing timeline entry (derived from audit records)
34
- - `TimelineStatus` — Timeline-specific status mapping
35
- - `TimelineIcon` — Timeline-specific icon subset
103
+ **Internal domains:**
36
104
 
37
- ### Registry & Functions
105
+ - `message-parts`
38
106
 
39
- - `EXECUTION_KINDS` — Registry of all execution kinds
40
- - `getExecutionKindDefinition(kind)` — Type-safe registry lookup
41
- - `isValidExecutionKind(kind)` — Validate string is ExecutionKind
107
+ **External packages:**
42
108
 
43
- ## Dependencies
109
+ - `zod`
44
110
 
45
- **Imports from:** (none leaf module)
46
- **Imported by:** company-semantics-backend, company-semantics-app
111
+ <!-- END GENERATED: readme-dependencies -->
@@ -14,39 +14,67 @@ This module exports **types only** — runtime helper functions live in the work
14
14
  - **Schema alignment**: Types match `schemas/guard-result.schema.json` exactly
15
15
  - **Backward compatibility**: Breaking changes require major version bump
16
16
 
17
- ## Public API
18
-
19
- ### Message Types
20
-
21
- - `GuardMessage` — Single error/warning with file, message, optional line/rule
22
- - `GuardTierResult` — Errors + warnings for one tier
23
- - `GuardResults` — Full results organized by tier
24
- - `GuardOutput` — JSON envelope for `--json` mode
25
-
26
- ### Tier Types
17
+ <!-- BEGIN GENERATED: readme-public-api — derived from code by `pnpm readme-api`. Do not edit. -->
27
18
 
28
- - `GuardTier` — `'structural' | 'behavioral' | 'invariants' | 'evolution'`
29
- - `GUARD_TIERS` — Ordered array for iteration
30
-
31
- ### Check Types
19
+ ## Public API
32
20
 
33
- - `CheckResult` — Return type from individual guard checks
34
- - `GuardCheck` — Function signature `(root, config) => Promise<CheckResult>`
35
- - `GuardCheckFactory` — Factory signature `(overrides?) => GuardCheck`
21
+ - `AggregateEvolutionConfig` _(type)_
22
+ - `AlertsConfigGuardConfig` _(type)_
23
+ - `BLOCKING_SOC2_CONTROLS`
24
+ - `BackupConfigGuardConfig` _(type)_
25
+ - `BoundGuardCheck` _(type)_
26
+ - `CheckResult` _(type)_
27
+ - `ContractsConsumerBaseline` _(type)_
28
+ - `ContractsFreshnessBaseline` _(type)_
29
+ - `CoverageBaseline` _(type)_
30
+ - `DEFAULT_DOMAIN_SECTIONS`
31
+ - `DEFAULT_INFRA_SECTIONS`
32
+ - `DEFAULT_SKIP_DIRECTORIES`
33
+ - `DomainAggregateBaseline` _(type)_
34
+ - `EvolutionBaselines` _(type)_
35
+ - `FileClusterBaseline` _(type)_
36
+ - `GUARD_SCHEMA_VERSION`
37
+ - `GUARD_TIERS`
38
+ - `GuardCheck` _(type)_
39
+ - `GuardCheckFactory` _(type)_
40
+ - `GuardCheckRegistry` _(type)_
41
+ - `GuardConfig` _(type)_
42
+ - `GuardMessage` _(type)_
43
+ - `GuardOutput` _(type)_
44
+ - `GuardResults` _(type)_
45
+ - `GuardTier` _(type)_
46
+ - `GuardTierResult` _(type)_
47
+ - `KnownVulnerability` _(type)_
48
+ - `MetaBaselines` _(type)_
49
+ - `REQUIRED_SOC2_CONTROLS`
50
+ - `RoleLimit` _(type)_
51
+ - `SOC2_CONTROL_NAMES`
52
+ - `SOC2_SCHEMA_VERSION`
53
+ - `ScriptsDepsBaseline` _(type)_
54
+ - `SecretsDetectionConfig` _(type)_
55
+ - `Soc2Baselines` _(type)_
56
+ - `Soc2ComplianceOutput` _(type)_
57
+ - `Soc2ControlArea` _(type)_
58
+ - `Soc2ControlResult` _(type)_
59
+ - `Soc2ControlStatus` _(type)_
60
+ - `StructuralBaselines` _(type)_
61
+ - `StructuredLoggingConfig` _(type)_
62
+ - `SubdirectoryAffinityBaseline` _(type)_
63
+ - `VulnerabilitiesBaseline` _(type)_
64
+ - `VulnerabilityConfig` _(type)_
65
+
66
+ <!-- END GENERATED: readme-public-api -->
67
+
68
+ <!-- BEGIN GENERATED: readme-dependencies — derived from code by `pnpm readme-api`. Do not edit. -->
36
69
 
37
- ### Config Types
70
+ ## Dependencies
38
71
 
39
- - `RoleLimit` — Three-tier limit (target, warning, hard)
40
- - `GuardConfig` — Polymorphic configuration for guards
72
+ **Internal domains:**
41
73
 
42
- ### Constants
74
+ _None._
43
75
 
44
- - `GUARD_SCHEMA_VERSION` — `'2.0.0'` current schema version
45
- - `DEFAULT_SKIP_DIRECTORIES` — Standard dirs to skip
46
- - `DEFAULT_DOMAIN_SECTIONS` — Required README sections for domains
47
- - `DEFAULT_INFRA_SECTIONS` — Required README sections for infra
76
+ **External packages:**
48
77
 
49
- ## Dependencies
78
+ _None._
50
79
 
51
- - No external dependencies (types only)
52
- - Consumed by: backend `scripts/ci/`, site `scripts/ci/`, workspace `scripts/ci/`
80
+ <!-- END GENERATED: readme-dependencies -->