@company-semantics/contracts 17.0.0 → 18.1.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@company-semantics/contracts",
-  "version": "17.0.0",
+  "version": "18.1.0",
   "private": false,
   "repository": {
     "type": "git",
@@ -112,8 +112,8 @@
     "generate:current": "tsx ../company-semantics-ci/scripts/generate-current.ts",
     "repo-map": "tsx ../company-semantics-ci/scripts/generate-repo-map.ts --roots src --name company-semantics-contracts --write",
     "repo-map:check": "tsx ../company-semantics-ci/scripts/generate-repo-map.ts --roots src --name company-semantics-contracts --check",
-    "readme-api": "tsx ../company-semantics-ci/scripts/generate-readme-api.ts --roots src --write",
-    "readme-api:check": "tsx ../company-semantics-ci/scripts/generate-readme-api.ts --roots src --check"
+    "readme-api": "tsx ../company-semantics-ci/scripts/generate-readme-api.ts --roots src --write --jsdoc",
+    "readme-api:check": "tsx ../company-semantics-ci/scripts/generate-readme-api.ts --roots src --check --jsdoc"
   },
   "packageManager": "pnpm@10.25.0",
   "engines": {

package/src/api/README.md

@@ -31,14 +31,14 @@ The file is committed to the repo (not .gitignored) so consumers can import type
 ## Public API
 
 - `CursorPage` _(type)_
-- `CursorPageSchema`
+- `CursorPageSchema` — Generic factory for cursor-paginated responses.
 - `ErrorResponse` _(type)_
-- `ErrorResponseSchema`
+- `ErrorResponseSchema` — Standard error envelope — matches backend StandardErrorResponse.
 - `SPEC_HASH`
 - `SPEC_HASH_FULL`
 - `components` _(type)_
 - `operations` _(type)_
-- `paths` _(type)_
+- `paths` _(type)_ — This file was auto-generated by openapi-typescript.
 
 <!-- END GENERATED: readme-public-api -->
 

package/src/billing/README.md

@@ -16,8 +16,8 @@ Defines the shared type vocabulary for organization billing status and plan info
 
 ## Public API
 
-- `OrgBillingInfo` _(type)_
-- `OrgPlanStatus` _(type)_
+- `OrgBillingInfo` _(type)_ — Read-only billing information for an organization.
+- `OrgPlanStatus` _(type)_ — Organization plan status.
 
 <!-- END GENERATED: readme-public-api -->
 

package/src/chat/README.md

@@ -17,73 +17,73 @@ Shared types for chat persistence, sharing, real-time events, and runtime profil
 
 ## Public API
 
-- `BaseEvent` _(type)_
+- `BaseEvent` _(type)_ — Base envelope for all SSE events.
 - `BaseEventSchema`
-- `CHAT_RUNTIME_PROFILES`
-- `ChatByInteractionResponse` _(type)_
-- `ChatByInteractionResponseSchema`
-- `ChatChangedField` _(type)_
+- `CHAT_RUNTIME_PROFILES` — Ordered list of available profiles for UI rendering.
+- `ChatByInteractionResponse` _(type)_ — Response for GET /api/chats/by-interaction/:interactionId
+- `ChatByInteractionResponseSchema` — Response for GET /api/chats/by-interaction/:interactionId
+- `ChatChangedField` _(type)_ — Fields that can change on a chat, used in changed array.
 - `ChatChangedFieldSchema`
-- `ChatCreatedEvent` _(type)_
+- `ChatCreatedEvent` _(type)_ — Emitted exactly once after a chat is successfully persisted.
 - `ChatCreatedEventSchema`
-- `ChatDeletedEvent` _(type)_
+- `ChatDeletedEvent` _(type)_ — Emitted when a chat is deleted.
 - `ChatDeletedEventSchema`
-- `ChatDetail` _(type)_
-- `ChatDetailSchema`
-- `ChatDomainEvent` _(type)_
+- `ChatDetail` _(type)_ — Chat detail object in GET /api/chats/:id — includes interactionId for append-on-edit flows.
+- `ChatDetailSchema` — Chat detail object in GET /api/chats/:id response.
+- `ChatDomainEvent` _(type)_ — All domain events that carry full state.
 - `ChatDomainEventSchema`
-- `ChatInvalidationEvent` _(type)_
+- `ChatInvalidationEvent` _(type)_ — All invalidation events that signal staleness.
 - `ChatInvalidationEventSchema`
-- `ChatListFilters` _(type)_
-- `ChatListResponse` _(type)_
-- `ChatListResponseSchema`
-- `ChatMessage` _(type)_
-- `ChatMessageSchema`
-- `ChatRuntimeProfile` _(type)_
-- `ChatRuntimeProfileInfo` _(type)_
-- `ChatShareInfo` _(type)_
+- `ChatListFilters` _(type)_ — Filters for listing chats.
+- `ChatListResponse` _(type)_ — Response for GET /api/chats
+- `ChatListResponseSchema` — Response for GET /api/chats
+- `ChatMessage` _(type)_ — Individual message in a chat response (GET /api/chats/:id).
+- `ChatMessageSchema` — Individual message in a chat, as returned by GET /api/chats/:id.
+- `ChatRuntimeProfile` _(type)_ — Chat runtime profile — user-selectable orchestration strategy.
+- `ChatRuntimeProfileInfo` _(type)_ — Runtime profile metadata for UI rendering.
+- `ChatShareInfo` _(type)_ — Chat share record with snapshot metadata.
 - `ChatShareInfoSchema`
-- `ChatSseEvent` _(type)_
+- `ChatSseEvent` _(type)_ — SSE event types for chat updates.
 - `ChatSseEventSchema`
-- `ChatSuccessResponse` _(type)_
-- `ChatSuccessResponseSchema`
-- `ChatSummary` _(type)_
-- `ChatSummaryExtended` _(type)_
+- `ChatSuccessResponse` _(type)_ — Generic mutation success confirmation.
+- `ChatSuccessResponseSchema` — Generic success confirmation for mutations that return no entity data.
+- `ChatSummary` _(type)_ — Lightweight chat summary for list views.
+- `ChatSummaryExtended` _(type)_ — Extended chat summary with pin/title status.
 - `ChatSummaryExtendedSchema`
 - `ChatSummarySchema`
-- `ChatUpdatedEvent` _(type)_
+- `ChatUpdatedEvent` _(type)_ — Emitted when chat metadata changes (title, pin, etc.) Carries full current state - clients should replace…
 - `ChatUpdatedEventSchema`
-- `ChatVisibility` _(type)_
+- `ChatVisibility` _(type)_ — Chat share visibility. - private: Token exists but access requires authentication as chat owner - public…
 - `ChatVisibilitySchema`
-- `CreateChatResponse` _(type)_
-- `CreateChatResponseSchema`
-- `CreateShareRequest` _(type)_
-- `CreateShareResponse` _(type)_
-- `CreateShareResponseSchema`
-- `DEFAULT_CHAT_RUNTIME_PROFILE`
-- `GetChatResponse` _(type)_
-- `GetChatResponseSchema`
-- `InvalidateChatEvent` _(type)_
+- `CreateChatResponse` _(type)_ — Response for POST /api/chats
+- `CreateChatResponseSchema` — Response for POST /api/chats
+- `CreateShareRequest` _(type)_ — Request to create a new share for a chat.
+- `CreateShareResponse` _(type)_ — Response for POST /api/chats/:chatId/shares
+- `CreateShareResponseSchema` — Response for POST /api/chats/:chatId/shares
+- `DEFAULT_CHAT_RUNTIME_PROFILE` — Default profile when none is specified in the request.
+- `GetChatResponse` _(type)_ — Response for GET /api/chats/:id
+- `GetChatResponseSchema` — Response for GET /api/chats/:id
+- `InvalidateChatEvent` _(type)_ — Single-entity staleness signal.
 - `InvalidateChatEventSchema`
-- `InvalidateChatListEvent` _(type)_
+- `InvalidateChatListEvent` _(type)_ — Collection staleness signal.
 - `InvalidateChatListEventSchema`
-- `InvalidationReason` _(type)_
+- `InvalidationReason` _(type)_ — Reason for cache invalidation.
 - `InvalidationReasonSchema`
-- `IsoDateString`
-- `ListSharesResponse` _(type)_
-- `ListSharesResponseSchema`
-- `SharedChatMessage` _(type)_
+- `IsoDateString` — ISO 8601 datetime string — the runtime safety net for date serialization.
+- `ListSharesResponse` _(type)_ — Response for GET /api/chats/:chatId/shares
+- `ListSharesResponseSchema` — Response for GET /api/chats/:chatId/shares
+- `SharedChatMessage` _(type)_ — Individual message in a shared chat view.
 - `SharedChatMessageSchema`
-- `SharedChatView` _(type)_
+- `SharedChatView` _(type)_ — Shared chat view returned to viewers.
 - `SharedChatViewSchema`
-- `TitleGenerationRequest` _(type)_
-- `TitleGenerationResponse` _(type)_
+- `TitleGenerationRequest` _(type)_ — Request to generate a title for a chat.
+- `TitleGenerationResponse` _(type)_ — Response from title generation.
 - `TitleGenerationResponseSchema`
-- `TitleSource` _(type)_
+- `TitleSource` _(type)_ — Title source - tracks how the title was set. - auto: Generated automatically by LLM - manual: Set by user…
 - `TitleSourceSchema`
-- `UpdateShareRequest` _(type)_
-- `UpdateShareResponse` _(type)_
-- `UpdateShareResponseSchema`
+- `UpdateShareRequest` _(type)_ — Request to update an existing share.
+- `UpdateShareResponse` _(type)_ — Response for PATCH /api/shares/:shareId
+- `UpdateShareResponseSchema` — Response for PATCH /api/shares/:shareId
 
 <!-- END GENERATED: readme-public-api -->
 

package/src/ci-envelope/README.md

@@ -17,19 +17,19 @@ Defines the shared type vocabulary for CI execution envelopes. An envelope is an
 
 ## Public API
 
-- `CIActorInfo` _(type)_
-- `CIAuthorityGrant` _(type)_
-- `CIChangeKind` _(type)_
-- `CIEnvelopeStatus` _(type)_
-- `CIExecutionEnvelope` _(type)_
-- `CIExecutionOutcome` _(type)_
-- `CIExecutionScope` _(type)_
-- `CIGuardPlan` _(type)_
-- `CIGuardViolation` _(type)_
-- `CIIntentDeclaration` _(type)_
-- `CISessionInfo` _(type)_
-- `ENVELOPE_TRANSITIONS`
-- `ExecutionIntent` _(type)_
+- `CIActorInfo` _(type)_ — Actor information for audit trail.
+- `CIAuthorityGrant` _(type)_ — Authority grant documenting permission basis.
+- `CIChangeKind` _(type)_ — Change kind for scope declarations.
+- `CIEnvelopeStatus` _(type)_ — Envelope lifecycle status.
+- `CIExecutionEnvelope` _(type)_ — CI Execution Envelope — the atomic unit of governed execution.
+- `CIExecutionOutcome` _(type)_ — Execution outcome populated on finalization.
+- `CIExecutionScope` _(type)_ — Execution scope defining affected repos and paths.
+- `CIGuardPlan` _(type)_ — Guard execution plan resolved from intent + scope.
+- `CIGuardViolation` _(type)_ — A single guard violation for post-execution audit.
+- `CIIntentDeclaration` _(type)_ — Intent declaration with optional ADR references.
+- `CISessionInfo` _(type)_ — Session context for correlating envelope to conversation.
+- `ENVELOPE_TRANSITIONS` — Valid status transitions (documentation only).
+- `ExecutionIntent` _(type)_ — Execution intent categories.
 
 <!-- END GENERATED: readme-public-api -->
 

package/src/email/README.md

@@ -18,13 +18,13 @@ TypeScript types and registry for transactional email kinds and their metadata.
 
 ## Public API
 
-- `EMAIL_KINDS`
-- `EmailKind` _(type)_
-- `EmailKindDefinition` _(type)_
-- `EmailPayloads` _(type)_
-- `SendEmailInput` _(type)_
-- `getEmailKindDefinition`
-- `isValidEmailKind`
+- `EMAIL_KINDS` — EMAILKINDS is the authoritative registry.
+- `EmailKind` _(type)_ — EmailKind identifies the type of transactional email.
+- `EmailKindDefinition` _(type)_ — Complete definition for an email kind.
+- `EmailPayloads` _(type)_ — Type-safe payload mapping for each email kind.
+- `SendEmailInput` _(type)_ — Type-safe input for sending emails.
+- `getEmailKindDefinition` — Type-safe registry lookup.
+- `isValidEmailKind` — Check if a string is a valid EmailKind.
 
 <!-- END GENERATED: readme-public-api -->
 

package/src/email/__tests__/registry.test.ts

@@ -26,8 +26,8 @@ describe("EMAIL_KINDS golden snapshot", () => {
         plainTextRequired: true,
         htmlSupported: true,
       },
-      "org.leadership_granted": {
-        kind: "org.leadership_granted",
+      "org.unit_owner_granted": {
+        kind: "org.unit_owner_granted",
         subject: "You've been added to a team",
         plainTextRequired: true,
         htmlSupported: true,

package/src/email/registry.ts

@@ -76,8 +76,8 @@ export const EMAIL_KINDS = {
     plainTextRequired: true,
     htmlSupported: true,
   },
-  "org.leadership_granted": {
-    kind: "org.leadership_granted",
+  "org.unit_owner_granted": {
+    kind: "org.unit_owner_granted",
     subject: "You've been added to a team",
     plainTextRequired: true,
     htmlSupported: true,

package/src/email/types.ts

@@ -27,7 +27,7 @@ export type EmailKind =
   | "auth.otp"
   | "auth.magic_link" // future
   | "org.invite" // future
-  | "org.leadership_granted"
+  | "org.unit_owner_granted"
   | "org.ownership_transfer"
   | "org.ownership_transfer_completed"
   | "security.alert" // future
@@ -62,7 +62,7 @@ export interface EmailPayloads {
     acceptUrl: string;
     expiresInDays: number;
   };
-  "org.leadership_granted": {
+  "org.unit_owner_granted": {
     /** Display name of the person who granted access */
     granterName: string;
     /** Display name of the recipient (optional; falls back to a neutral greeting) */

package/src/execution/README.md

@@ -18,62 +18,62 @@ TypeScript types and registry for execution kinds and their governance metadata.
 
 ## Public API
 
-- `ApprovalRequestedMetadata` _(type)_
-- `AuditExportBundle` _(type)_
-- `AuditExportEvent` _(type)_
-- `CancelledMetadata` _(type)_
+- `ApprovalRequestedMetadata` _(type)_ — Metadata for approvalrequested event.
+- `AuditExportBundle` _(type)_ — Top-level audit export bundle for a single execution.
+- `AuditExportEvent` _(type)_ — Per-event shape within an audit export bundle.
+- `CancelledMetadata` _(type)_ — Metadata for cancelled event.
 - `ConfirmExecutionResponse` _(type)_
 - `ConfirmExecutionResponseSchema`
-- `ConfirmationApprovedMetadata` _(type)_
-- `ConfirmationExpiredMetadata` _(type)_
-- `ConfirmationRejectedMetadata` _(type)_
+- `ConfirmationApprovedMetadata` _(type)_ — Metadata for confirmationapproved event.
+- `ConfirmationExpiredMetadata` _(type)_ — Metadata for confirmationexpired event.
+- `ConfirmationRejectedMetadata` _(type)_ — Metadata for confirmationrejected event.
 - `EFFECTIVE_TERMINAL_STATES`
 - `EXECUTION_EVENT_TYPES`
-- `EXECUTION_KINDS`
+- `EXECUTION_KINDS` — EXECUTIONKINDS is the authoritative registry.
 - `EXECUTION_STATES`
-- `EventHashFields` _(type)_
-- `ExecutionCompletedMetadata` _(type)_
-- `ExecutionCreatedMetadata` _(type)_
-- `ExecutionDomain` _(type)_
+- `EventHashFields` _(type)_ — Hash chain fields for tamper-evident execution events.
+- `ExecutionCompletedMetadata` _(type)_ — Metadata for executioncompleted event.
+- `ExecutionCreatedMetadata` _(type)_ — Metadata for executioncreated event.
+- `ExecutionDomain` _(type)_ — Domain categories for execution kinds.
 - `ExecutionError` _(type)_
 - `ExecutionErrorCode` _(type)_
-- `ExecutionEventMetadataMap` _(type)_
+- `ExecutionEventMetadataMap` _(type)_ — Exhaustive mapping from ExecutionEventType to its metadata interface.
 - `ExecutionEventType` _(type)_
-- `ExecutionEventTypeSchema`
-- `ExecutionFailedMetadata` _(type)_
-- `ExecutionInitiator` _(type)_
-- `ExecutionIntent` _(type)_
-- `ExecutionKind` _(type)_
-- `ExecutionKindDefinition` _(type)_
+- `ExecutionEventTypeSchema` — Runtime-validatable form of {@link ExecutionEventType}, derived from the single source.
+- `ExecutionFailedMetadata` _(type)_ — Metadata for executionfailed event.
+- `ExecutionInitiator` _(type)_ — Who initiated the execution.
+- `ExecutionIntent` _(type)_ — Governance requirements for an execution.
+- `ExecutionKind` _(type)_ — ExecutionKind identifies the type of execution action.
+- `ExecutionKindDefinition` _(type)_ — Complete definition for an execution kind.
 - `ExecutionListResponse` _(type)_
 - `ExecutionListResponseSchema`
-- `ExecutionResultDataSchema`
+- `ExecutionResultDataSchema` — Zod mirror of the canonical ExecutionResultData contract (message-parts/execution.ts), authored so GET…
 - `ExecutionResultResponse` _(type)_
 - `ExecutionResultResponseSchema`
 - `ExecutionSseEvent` _(type)_
 - `ExecutionSseEventSchema`
-- `ExecutionStartedMetadata` _(type)_
+- `ExecutionStartedMetadata` _(type)_ — Metadata for executionstarted event.
 - `ExecutionState` _(type)_
-- `ExecutionStateSchema`
-- `ExecutionStatus` _(type)_
-- `ExecutionSummary` _(type)_
+- `ExecutionStateSchema` — Runtime-validatable form of {@link ExecutionState}, derived from the single source.
+- `ExecutionStatus` _(type)_ — Status of an execution.
+- `ExecutionSummary` _(type)_ — ExecutionSummary is a PROJECTION CONTRACT.
 - `ExecutionSummaryProjectionSchema`
 - `ExecutionSummaryResponse` _(type)_
 - `ExecutionSummarySchema`
-- `ExecutionTarget` _(type)_
+- `ExecutionTarget` _(type)_ — Target of an execution action.
 - `ExecutionTimelineResponse` _(type)_
 - `ExecutionTimelineResponseSchema`
-- `FrozenExecutionIntent` _(type)_
+- `FrozenExecutionIntent` _(type)_ — Immutable governance snapshot captured at execution creation time.
 - `GetExecutionSummaryResponse` _(type)_
 - `GetExecutionSummaryResponseSchema`
-- `HASH_ALGORITHM`
-- `HASH_ENCODING`
-- `HashChainVerificationResult` _(type)_
-- `ISO8601Timestamp` _(type)_
-- `IconName` _(type)_
+- `HASH_ALGORITHM` — Hash algorithm used for event chain integrity
+- `HASH_ENCODING` — Encoding for hash output
+- `HashChainVerificationResult` _(type)_ — Result of verifying a hash chain for a single execution.
+- `ISO8601Timestamp` _(type)_ — ISO 8601 timestamp string.
+- `IconName` _(type)_ — Icon names for execution kinds.
 - `LIFECYCLE_DECISIONS`
 - `LifecycleDecision` _(type)_
-- `LifecycleIntent` _(type)_
+- `LifecycleIntent` _(type)_ — Governance requirements for an execution.
 - `RejectExecutionResponse` _(type)_
 - `RejectExecutionResponseSchema`
 - `StartExecutionResponse` _(type)_
@@ -81,18 +81,18 @@ TypeScript types and registry for execution kinds and their governance metadata.
 - `TERMINAL_STATES`
 - `TimelineEvent` _(type)_
 - `TimelineEventSchema`
-- `TimelineIcon` _(type)_
-- `TimelineStatus` _(type)_
-- `TimelineUIEvent` _(type)_
-- `UndoCompletedMetadata` _(type)_
+- `TimelineIcon` _(type)_ — Icon for timeline items.
+- `TimelineStatus` _(type)_ — Status for timeline display.
+- `TimelineUIEvent` _(type)_ — TimelineUIEvent is a PROJECTION CONTRACT.
+- `UndoCompletedMetadata` _(type)_ — Metadata for undocompleted event.
 - `VALID_TRANSITIONS`
 - `applyIntent`
 - `assertValidTransition`
-- `getExecutionKindDefinition`
-- `isConfirmationExpired`
+- `getExecutionKindDefinition` — Type-safe registry lookup.
+- `isConfirmationExpired` — Compares pre-parsed epoch ms to determine if a confirmation has expired.
 - `isExecutionEventType`
-- `isValidExecutionKind`
-- `parseExpiresAt`
+- `isValidExecutionKind` — Check if a string is a valid ExecutionKind.
+- `parseExpiresAt` — Parses an ISO 8601 string to epoch ms.
 
 <!-- END GENERATED: readme-public-api -->
 

package/src/execution/__tests__/registry.test.ts

@@ -178,6 +178,27 @@ describe("EXECUTION_KINDS golden snapshot", () => {
           templateId: "member-change-manager",
         },
       },
+      "companyMd.ingest": {
+        kind: "companyMd.ingest",
+        domain: "data",
+        display: {
+          label: "Ingest Company Knowledge",
+          pastTenseLabel: "Company knowledge ingested",
+          icon: "pencil",
+        },
+        governance: {
+          visibility: "user",
+          requiresAdmin: false,
+        },
+        ui: {
+          showInAdmin: false,
+          showInTimeline: true,
+          confirmBeforeRun: true,
+        },
+        explanation: {
+          templateId: "companyMd.ingest",
+        },
+      },
     });
   });
 });

package/src/execution/kinds.ts

@@ -30,4 +30,5 @@ export type ExecutionKind =
   | "data.ingest"
   | "data.scope"
   | "system.cleanup"
-  | "member.changeManager";
+  | "member.changeManager"
+  | "companyMd.ingest";

package/src/execution/registry.ts

@@ -204,6 +204,27 @@ export const EXECUTION_KINDS = {
       templateId: "member-change-manager",
     },
   },
+  "companyMd.ingest": {
+    kind: "companyMd.ingest",
+    domain: "data",
+    display: {
+      label: "Ingest Company Knowledge",
+      pastTenseLabel: "Company knowledge ingested",
+      icon: "pencil",
+    },
+    governance: {
+      visibility: "user",
+      requiresAdmin: false,
+    },
+    ui: {
+      showInAdmin: false,
+      showInTimeline: true,
+      confirmBeforeRun: true,
+    },
+    explanation: {
+      templateId: "companyMd.ingest",
+    },
+  },
 } as const satisfies Record<ExecutionKind, ExecutionKindDefinition>;
 
 // =============================================================================

package/src/generated/openapi-routes.ts

@@ -96,8 +96,8 @@ export const openApiRoutes = {
   '/api/org-units/{unitId}/relationships': ['GET', 'POST'],
   '/api/org-units/{unitId}/reorder': ['POST'],
   '/api/org-units/{unitId}/reparent': ['POST'],
-  '/api/org-units/{unitId}/structural-leaders': ['POST'],
-  '/api/org-units/{unitId}/structural-leaders/{userId}': ['DELETE'],
+  '/api/org-units/{unitId}/unit-owners': ['POST'],
+  '/api/org-units/{unitId}/unit-owners/{userId}': ['DELETE'],
   '/api/org/cancel-deletion': ['POST'],
   '/api/org/delete': ['POST'],
   '/api/org/deletion-eligibility': ['GET'],

package/src/guards/README.md

@@ -18,50 +18,50 @@ This module exports **types only** — runtime helper functions live in the work
 
 ## Public API
 
-- `AggregateEvolutionConfig` _(type)_
-- `AlertsConfigGuardConfig` _(type)_
-- `BLOCKING_SOC2_CONTROLS`
-- `BackupConfigGuardConfig` _(type)_
-- `BoundGuardCheck` _(type)_
-- `CheckResult` _(type)_
-- `ContractsConsumerBaseline` _(type)_
-- `ContractsFreshnessBaseline` _(type)_
-- `CoverageBaseline` _(type)_
-- `DEFAULT_DOMAIN_SECTIONS`
-- `DEFAULT_INFRA_SECTIONS`
-- `DEFAULT_SKIP_DIRECTORIES`
-- `DomainAggregateBaseline` _(type)_
-- `EvolutionBaselines` _(type)_
-- `FileClusterBaseline` _(type)_
-- `GUARD_SCHEMA_VERSION`
-- `GUARD_TIERS`
-- `GuardCheck` _(type)_
-- `GuardCheckFactory` _(type)_
-- `GuardCheckRegistry` _(type)_
-- `GuardConfig` _(type)_
-- `GuardMessage` _(type)_
-- `GuardOutput` _(type)_
-- `GuardResults` _(type)_
-- `GuardTier` _(type)_
-- `GuardTierResult` _(type)_
-- `KnownVulnerability` _(type)_
-- `MetaBaselines` _(type)_
-- `REQUIRED_SOC2_CONTROLS`
-- `RoleLimit` _(type)_
-- `SOC2_CONTROL_NAMES`
-- `SOC2_SCHEMA_VERSION`
-- `ScriptsDepsBaseline` _(type)_
-- `SecretsDetectionConfig` _(type)_
-- `Soc2Baselines` _(type)_
-- `Soc2ComplianceOutput` _(type)_
-- `Soc2ControlArea` _(type)_
-- `Soc2ControlResult` _(type)_
-- `Soc2ControlStatus` _(type)_
-- `StructuralBaselines` _(type)_
-- `StructuredLoggingConfig` _(type)_
-- `SubdirectoryAffinityBaseline` _(type)_
-- `VulnerabilitiesBaseline` _(type)_
-- `VulnerabilityConfig` _(type)_
+- `AggregateEvolutionConfig` _(type)_ — Configuration for aggregate evolution guard.
+- `AlertsConfigGuardConfig` _(type)_ — Configuration for the alerts config guard.
+- `BLOCKING_SOC2_CONTROLS` — Controls that block CI when status is FAIL.
+- `BackupConfigGuardConfig` _(type)_ — Configuration for the backup config guard.
+- `BoundGuardCheck` _(type)_ — A check that can be run synchronously or asynchronously.
+- `CheckResult` _(type)_ — Result from a single guard check.
+- `ContractsConsumerBaseline` _(type)_ — Contracts consumer guard configuration.
+- `ContractsFreshnessBaseline` _(type)_ — Contracts freshness baseline configuration.
+- `CoverageBaseline` _(type)_ — Coverage baseline configuration.
+- `DEFAULT_DOMAIN_SECTIONS` — Default README sections for domain directories.
+- `DEFAULT_INFRA_SECTIONS` — Default README sections for infrastructure directories.
+- `DEFAULT_SKIP_DIRECTORIES` — Default directories to skip when walking file trees.
+- `DomainAggregateBaseline` _(type)_ — Domain-level aggregate baseline for evolution tracking.
+- `EvolutionBaselines` _(type)_ — Evolution guard baselines.
+- `FileClusterBaseline` _(type)_ — File cluster detection configuration.
+- `GUARD_SCHEMA_VERSION` — Current schema version. v2.0.0: Tiered results (breaking change from v1.x flattened structure)
+- `GUARD_TIERS` — All guard tiers in order.
+- `GuardCheck` _(type)_ — Signature for a guard check function.
+- `GuardCheckFactory` _(type)_ — Signature for a guard check factory.
+- `GuardCheckRegistry` _(type)_ — Registry of checks grouped by tier.
+- `GuardConfig` _(type)_ — Configuration for guard checks.
+- `GuardMessage` _(type)_ — A single guard message (error or warning).
+- `GuardOutput` _(type)_ — JSON output envelope for --json mode.
+- `GuardResults` _(type)_ — Full guard results, organized by tier.
+- `GuardTier` _(type)_ — Guard tier names.
+- `GuardTierResult` _(type)_ — Result for a single tier (errors + warnings).
+- `KnownVulnerability` _(type)_ — A known/accepted vulnerability that should be grandfathered.
+- `MetaBaselines` _(type)_ — Meta guard baselines.
+- `REQUIRED_SOC2_CONTROLS` — All required SOC 2 controls.
+- `RoleLimit` _(type)_ — Role limit for the file-size guard, expressed as fractions of the repo's file-size envelope (envelope =…
+- `SOC2_CONTROL_NAMES` — Human-readable names for SOC 2 control areas.
+- `SOC2_SCHEMA_VERSION` — Current SOC 2 compliance schema version.
+- `ScriptsDepsBaseline` _(type)_ — Scripts-devDependencies guard configuration.
+- `SecretsDetectionConfig` _(type)_ — Configuration for the secrets detection guard.
+- `Soc2Baselines` _(type)_ — SOC 2 compliance baselines.
+- `Soc2ComplianceOutput` _(type)_ — SOC 2 compliance snapshot output.
+- `Soc2ControlArea` _(type)_ — SOC 2 control area identifiers. - CM: Change Management - AC: Access Control - LM: Logging & Monitoring - SD…
+- `Soc2ControlResult` _(type)_ — A single SOC 2 control assertion result.
+- `Soc2ControlStatus` _(type)_ — Control status semantics: - PASS: Control asserted and within bounds - WARN: Control exists but has…
+- `StructuralBaselines` _(type)_ — Structural guard baselines.
+- `StructuredLoggingConfig` _(type)_ — Configuration for the structured logging guard.
+- `SubdirectoryAffinityBaseline` _(type)_ — Subdirectory affinity detection configuration.
+- `VulnerabilitiesBaseline` _(type)_ — Vulnerability guard baseline configuration.
+- `VulnerabilityConfig` _(type)_ — Configuration for the vulnerability guard.
 
 <!-- END GENERATED: readme-public-api -->
 

package/src/identity/README.md

@@ -26,7 +26,7 @@ TypeScript types and functions for user identity and display name resolution.
 - `AccountConfirmDeletionResponseSchema`
 - `AccountDeleteResponse` _(type)_
 - `AccountDeleteResponseSchema`
-- `AccountDeletionEligibility` _(type)_
+- `AccountDeletionEligibility` _(type)_ — Result of an account deletion eligibility check.
 - `AccountDeletionEligibilityResponse` _(type)_
 - `AccountDeletionEligibilityResponseSchema`
 - `AccountSessionList` _(type)_
@@ -37,16 +37,16 @@ TypeScript types and functions for user identity and display name resolution.
 - `AuthStartResponseSchema`
 - `AuthVerifyResponse` _(type)_
 - `AuthVerifyResponseSchema`
-- `AvatarSource` _(type)_
+- `AvatarSource` _(type)_ — Source of the resolved avatar. - 'photo': Using a resolved profile photo - 'initials': Using generated…
 - `BannerDismissResponse` _(type)_
 - `BannerDismissResponseSchema`
 - `BannerDismissedListResponse` _(type)_
 - `BannerDismissedListResponseSchema`
-- `DeletionBlocker` _(type)_
-- `ISODateString` _(type)_
+- `DeletionBlocker` _(type)_ — Conditions that block account deletion.
+- `ISODateString` _(type)_ — ISO 8601 date-time string.
 - `MeResponse` _(type)_
-- `MeResponseSchema`
-- `NameSource` _(type)_
+- `MeResponseSchema` — Full identity context returned by GET /api/me.
+- `NameSource` _(type)_ — Source of the user's name data.
 - `PeopleOrgChartEdge` _(type)_
 - `PeopleOrgChartEdgeSchema`
 - `PeopleOrgChartNode` _(type)_
@@ -59,16 +59,16 @@ TypeScript types and functions for user identity and display name resolution.
 - `ProfileResponseSchema`
 - `ReportingRelationshipType` _(type)_
 - `ReportingRelationshipTypeSchema`
-- `ResolvedAvatar` _(type)_
+- `ResolvedAvatar` _(type)_ — Resolved avatar for UI rendering.
 - `SsoConfigResponse` _(type)_
 - `SsoConfigResponseSchema`
-- `UserIdentity` _(type)_
-- `UserLifecycleStatus` _(type)_
+- `UserIdentity` _(type)_ — User identity information.
+- `UserLifecycleStatus` _(type)_ — User lifecycle status.
 - `deriveFullName`
-- `extractFirstWord`
-- `generateInitials`
-- `resolveAvatar`
-- `resolveDisplayName`
+- `extractFirstWord` — Extract the first word from a full name.
+- `generateInitials` — Generate initials from a full name.
+- `resolveAvatar` — Resolve avatar from user identity.
+- `resolveDisplayName` — Resolve the display name for assistant addressing.
 
 <!-- END GENERATED: readme-public-api -->
 

package/src/ingestion/README.md

@@ -24,13 +24,13 @@ attribute and supported-formats copy from the same data.
 
 ## Public API
 
-- `INGESTION_FORMATS`
-- `INGEST_ACCEPT`
-- `IngestionFormat` _(type)_
-- `SUPPORTED_LABEL`
-- `acceptExtensions`
-- `byMime`
-- `humanLabels`
+- `INGESTION_FORMATS` — The canonical public format registry.
+- `INGEST_ACCEPT` — Comma-joined extension string for a file input's `accept` attribute.
+- `IngestionFormat` _(type)_ — One accepted upload format, keyed by its canonical MIME type.
+- `SUPPORTED_LABEL` — Human-readable supported-formats summary, derived from {@link humanLabels}.
+- `acceptExtensions` — All accepted filename extensions, in registry order.
+- `byMime` — Look up the entry for a canonical MIME; undefined means unsupported.
+- `humanLabels` — Unique group labels for human display, in registry order.
 
 <!-- END GENERATED: readme-public-api -->