@company-semantics/contracts 18.0.0 → 18.1.1

package/src/mcp/README.md

@@ -21,10 +21,10 @@ Type vocabulary for MCP (Model Context Protocol) tool discovery, invocation meta
 
 - `CapabilityGraph` _(type)_
 - `CapabilityGraphEdge` _(type)_
-- `FailureContext` _(type)_
+- `FailureContext` _(type)_ — Structured recovery context emitted when an MCP tool call fails.
 - `MCPToolDescriptor` _(type)_
-- `RecoveryAction` _(type)_
-- `ResourceType` _(type)_
+- `RecoveryAction` _(type)_ — A recovery action the agent may take.
+- `ResourceType` _(type)_ — Resource type vocabulary for MCP tool resource flow.
 - `ToolCategory` _(type)_
 - `ToolComplexity` _(type)_
 - `ToolDiscoveryResponse` _(type)_
@@ -38,7 +38,7 @@ Type vocabulary for MCP (Model Context Protocol) tool discovery, invocation meta
 - `ToolStability` _(type)_
 - `ToolVisibility` _(type)_
 - `ToolWorkflow` _(type)_
-- `buildCapabilityGraph`
+- `buildCapabilityGraph` — Build a capability graph from tool resource flow metadata.
 
 <!-- END GENERATED: readme-public-api -->
 

package/src/message-parts/README.md

@@ -19,69 +19,69 @@ Canonical vocabulary for structured assistant message output. Defines the type s
 
 ## Public API
 
-- `AddPartResult` _(type)_
-- `AssistantMessagePart` _(type)_
-- `CONFIRMATION_LABELS`
-- `CandidateSource` _(type)_
-- `ChartDataPoint` _(type)_
-- `ChartPart` _(type)_
-- `ConfirmationChoice` _(type)_
+- `AddPartResult` _(type)_ — Result of adding a part to the builder.
+- `AssistantMessagePart` _(type)_ — All assistant message part types.
+- `CONFIRMATION_LABELS` — Human-readable confirmation dialog titles for each execution kind.
+- `CandidateSource` _(type)_ — How the frontend sources candidate values for an editable field. - `inline`: the options are shipped with the…
+- `ChartDataPoint` _(type)_ — Single data point for charts.
+- `ChartPart` _(type)_ — Chart surface part.
+- `ConfirmationChoice` _(type)_ — Choice options for confirmation.
 - `ConfirmationData` _(type)_
-- `ConfirmationDataPart` _(type)_
+- `ConfirmationDataPart` _(type)_ — Confirmation request data part (wire format).
 - `ConfirmationPart` _(type)_
-- `ConfirmationResponseData` _(type)_
-- `ConfirmationRiskLevel` _(type)_
-- `ExecutionArtifactStatus` _(type)_
-- `ExecutionResultData` _(type)_
-- `ExecutionResultDataPart` _(type)_
-- `ExecutionResultPart` _(type)_
-- `ExecutionResultSummary` _(type)_
-- `ExecutionUndoCapability` _(type)_
-- `IntegrationArtifactContent` _(type)_
-- `IntegrationKey` _(type)_
-- `IntegrationProvider` _(type)_
-- `InteractiveFieldDescriptor` _(type)_
-- `InteractiveFieldType` _(type)_
-- `InteractiveTaskData` _(type)_
-- `InteractiveTaskDataPart` _(type)_
-- `InteractiveTaskKind` _(type)_
-- `InteractiveTaskPart` _(type)_
-- `InteractiveTaskSubject` _(type)_
-- `MessageCompleteDataPart` _(type)_
-- `MessageCompleteEvent` _(type)_
-- `MessageDeltaDataPart` _(type)_
-- `MessageDeltaEvent` _(type)_
-- `MessageLifecycleEvent` _(type)_
-- `MessageLifecycleEventType` _(type)_
-- `MessageStartDataPart` _(type)_
-- `MessageStartEvent` _(type)_
-- `PartBuilderState` _(type)_
-- `PreviewArtifact` _(type)_
-- `PreviewArtifactKind` _(type)_
-- `PreviewData` _(type)_
-- `PreviewDataPart` _(type)_
-- `PreviewPart` _(type)_
-- `StatusPanelEntry` _(type)_
-- `StatusPanelPart` _(type)_
-- `StreamPhase` _(type)_
-- `SurfacePart` _(type)_
-- `TablePart` _(type)_
-- `TextPart` _(type)_
-- `ToolListPart` _(type)_
-- `ToolResultPart` _(type)_
-- `ToolResultRenderClass` _(type)_
-- `UndoResultData` _(type)_
-- `UndoResultDataPart` _(type)_
-- `WireSurfaceBuilder`
-- `addPart`
-- `addSurface`
-- `addText`
-- `buildParts`
-- `createPartBuilder`
-- `getConfirmationLabel`
-- `getDroppedCount`
-- `isSurfacePart`
-- `isTextPart`
+- `ConfirmationResponseData` _(type)_ — Data sent by the client to confirm or cancel a proposed action.
+- `ConfirmationRiskLevel` _(type)_ — Risk level for confirmation prompts.
+- `ExecutionArtifactStatus` _(type)_ — Status of a single artifact's execution.
+- `ExecutionResultData` _(type)_ — Execution result data payload.
+- `ExecutionResultDataPart` _(type)_ — Execution result data part (wire format).
+- `ExecutionResultPart` _(type)_ — Execution result message part (semantic type).
+- `ExecutionResultSummary` _(type)_ — Structured summary for generic UI rendering (executor-provided).
+- `ExecutionUndoCapability` _(type)_ — Undo capability descriptor.
+- `IntegrationArtifactContent` _(type)_ — Content structure for integration artifacts.
+- `IntegrationKey` _(type)_ — Application-level composite integration identifier.
+- `IntegrationProvider` _(type)_ — Integration provider types.
+- `InteractiveFieldDescriptor` _(type)_ — One editable field within an interactive task.
+- `InteractiveFieldType` _(type)_ — The input shape of an editable field. - `member-ref`: a workspace member id (backed by a member picker). -…
+- `InteractiveTaskData` _(type)_ — Interactive task surface data payload.
+- `InteractiveTaskDataPart` _(type)_ — Interactive task data part (wire format).
+- `InteractiveTaskKind` _(type)_ — The set of editable tasks the assistant can present inline.
+- `InteractiveTaskPart` _(type)_ — Interactive task message part (semantic type).
+- `InteractiveTaskSubject` _(type)_ — Read-only subject the task acts upon (e.g. the member being edited).
+- `MessageCompleteDataPart` _(type)_ — Wire format for message complete event.
+- `MessageCompleteEvent` _(type)_ — Message complete event.
+- `MessageDeltaDataPart` _(type)_ — Wire format for message delta event.
+- `MessageDeltaEvent` _(type)_ — Message delta event.
+- `MessageLifecycleEvent` _(type)_ — Base interface for all message lifecycle events.
+- `MessageLifecycleEventType` _(type)_ — Lifecycle event type discriminator.
+- `MessageStartDataPart` _(type)_ — Wire format for message start event.
+- `MessageStartEvent` _(type)_ — Message start event.
+- `PartBuilderState` _(type)_ — Immutable state for the part builder.
+- `PreviewArtifact` _(type)_ — A single artifact within a preview.
+- `PreviewArtifactKind` _(type)_ — Preview artifact kinds.
+- `PreviewData` _(type)_ — Preview surface data payload.
+- `PreviewDataPart` _(type)_ — Preview data part (wire format).
+- `PreviewPart` _(type)_ — Preview message part (semantic type).
+- `StatusPanelEntry` _(type)_ — Single entry in a status panel.
+- `StatusPanelPart` _(type)_ — Status panel surface part.
+- `StreamPhase` _(type)_ — Derived stream phase for UI state management.
+- `SurfacePart` _(type)_ — Surface parts are rendered atomically (never streamed).
+- `TablePart` _(type)_ — Table surface part.
+- `TextPart` _(type)_ — Text content part.
+- `ToolListPart` _(type)_ — Re-export ToolListMessagePart as ToolListPart for consistency.
+- `ToolResultPart` _(type)_ — Tool result part with rendering classification.
+- `ToolResultRenderClass` _(type)_ — Tool result rendering classification.
+- `UndoResultData` _(type)_ — Undo result data payload.
+- `UndoResultDataPart` _(type)_ — Undo result data part (wire format).
+- `WireSurfaceBuilder` — Factory for creating wire-format surface parts.
+- `addPart` — Add any message part to the builder.
+- `addSurface` — Add a surface part to the builder.
+- `addText` — Add a text part to the builder.
+- `buildParts` — Extract the final parts array from the builder.
+- `createPartBuilder` — Create a new part builder state.
+- `getConfirmationLabel` — Look up the human-readable confirmation label for an execution kind.
+- `getDroppedCount` — Get count of dropped parts (useful for logging/metrics).
+- `isSurfacePart` — Type guard for SurfacePart.
+- `isTextPart` — Type guard for TextPart.
 
 <!-- END GENERATED: readme-public-api -->
 

package/src/message-parts/__tests__/confirmation.test.ts

@@ -120,6 +120,7 @@ describe("CONFIRMATION_LABELS", () => {
       "data.scope": "Update Scope",
       "system.cleanup": "Cleanup Connections",
       "member.changeManager": "Change Reporting Manager",
+      "companyMd.ingest": "Ingest Company Knowledge",
     });
   });
 });

package/src/message-parts/confirmation.ts

@@ -48,6 +48,7 @@ export const CONFIRMATION_LABELS: Record<ExecutionKind, string> = {
   "data.scope": "Update Scope",
   "system.cleanup": "Cleanup Connections",
   "member.changeManager": "Change Reporting Manager",
+  "companyMd.ingest": "Ingest Company Knowledge",
 };
 
 /**

package/src/org/README.md

@@ -16,51 +16,51 @@ Shared type vocabulary for organization ownership, type classification, and tran
 
 ## Public API
 
-- `AcceptInviteRequest` _(type)_
-- `AccessExplanation` _(type)_
-- `AccessLevel` _(type)_
+- `AcceptInviteRequest` _(type)_ — Request payload for accepting an organization invite.
+- `AccessExplanation` _(type)_ — Full access explanation with evaluation trace.
+- `AccessLevel` _(type)_ — Document access level.
 - `AccessReason` _(type)_
-- `AccessSource` _(type)_
+- `AccessSource` _(type)_ — Source of an access grant.
 - `AcknowledgeSystemEventResponse` _(type)_
 - `AcknowledgeSystemEventResponseSchema`
 - `AclEntry` _(type)_
 - `ActionCapability` _(type)_
-- `ActionCapabilitySchema`
-- `AuthMethodConfig` _(type)_
+- `ActionCapabilitySchema` — An action's gate: allowed, or blocked with the scope that would unlock it.
+- `AuthMethodConfig` _(type)_ — Authentication method configuration.
 - `AuthorityConfidence` _(type)_
 - `AuthorityConfidenceSchema`
 - `AuthorityLocality` _(type)_
-- `AuthorityLocalitySchema`
+- `AuthorityLocalitySchema` — Whether the grant lives on the target unit or is inherited from an ancestor.
 - `AuthorityMechanism` _(type)_
-- `AuthorityMechanismSchema`
+- `AuthorityMechanismSchema` — How the authority arose.
 - `AuthorityMutability` _(type)_
-- `AuthorityMutabilitySchema`
+- `AuthorityMutabilitySchema` — Whether the user can change this authority from this surface. - `derived`: change the upstream source instead…
 - `AuthorityOrigin` _(type)_
 - `AuthorityOriginSchema`
 - `AuthoritySource` _(type)_
-- `AuthoritySourceSchema`
-- `AuthorizableView` _(type)_
+- `AuthoritySourceSchema` — Engine-internal authority source.
+- `AuthorizableView` _(type)_ — Type for views that can be checked against VIEWSCOPEMAP.
 - `CapabilitiesResponse` _(type)_
-- `CapabilitiesResponseSchema`
-- `ChangeMemberRoleRequest` _(type)_
+- `CapabilitiesResponseSchema` — The single validated capability surface the UI reads.
+- `ChangeMemberRoleRequest` _(type)_ — Request payload for changing a member's role.
 - `ChangeMemberRoleResponse` _(type)_
 - `ChangeMemberRoleResponseSchema`
-- `CompanyMdContextBankItem` _(type)_
+- `CompanyMdContextBankItem` _(type)_ — A context bank item — a company.md doc associated with one or more parent nodes.
 - `CompanyMdDependency` _(type)_
 - `CompanyMdDoc` _(type)_
 - `CompanyMdDocCollaborators` _(type)_
 - `CompanyMdDocCore` _(type)_
-- `CompanyMdDocKind` _(type)_
+- `CompanyMdDocKind` _(type)_ — Structural discriminator for a Company.md document. - `'root'`: the single org-wide doc (one per org). -…
 - `CompanyMdDocLevel` _(type)_
 - `CompanyMdDocRelations` _(type)_
 - `CompanyMdNodeIdentity` _(type)_
-- `CompanyMdNodeType` _(type)_
+- `CompanyMdNodeType` _(type)_ — Semantic node type used by the Company.md tree.
 - `CompanyMdSource` _(type)_
 - `CompanyMdTreeNode` _(type)_
-- `CompanyMdVisibility` _(type)_
+- `CompanyMdVisibility` _(type)_ — Visibility band for a Company.md document — the canonical AUTH `entity_visibility` vocabulary (, backend ). -…
 - `CreateDelegationRequest` _(type)_
 - `CreateDelegationRequestSchema`
-- `CreateInviteRequest` _(type)_
+- `CreateInviteRequest` _(type)_ — Request payload for creating an organization invite.
 - `CreateOpenRoleRequest` _(type)_
 - `CreateOpenRoleRequestSchema`
 - `Delegation` _(type)_
@@ -71,28 +71,28 @@ Shared type vocabulary for organization ownership, type classification, and tran
 - `DomainListResponseSchema`
 - `DomainResponse` _(type)_
 - `DomainResponseSchema`
-- `DomainStatus` _(type)_
-- `DomainVerificationMethod` _(type)_
-- `EffectiveAccess` _(type)_
-- `EvaluationStep` _(type)_
-- `ExecutionScope` _(type)_
-- `FACT_SOURCE_TIER_PRECEDENCE`
+- `DomainStatus` _(type)_ — Status of a domain claim within an organization. - 'pending': Domain claimed but not yet verified -…
+- `DomainVerificationMethod` _(type)_ — Method used to verify domain ownership. - 'dnstxt': DNS TXT record verification (primary method) - 'email'…
+- `EffectiveAccess` _(type)_ — Effective access for a user on a document.
+- `EvaluationStep` _(type)_ — Single step in the access evaluation trace.
+- `ExecutionScope` _(type)_ — Execution scope determines whose identity is used when executing actions. - 'self': Actions execute under the…
+- `FACT_SOURCE_TIER_PRECEDENCE` — Truth hierarchy, highest precedence first.
 - `FactProvenance` _(type)_
-- `FactProvenanceSchema`
+- `FactProvenanceSchema` — Provenance envelope attached to a structural fact (reporting edge, org unit, membership, home assignment).
 - `FactSourceTier` _(type)_
-- `FactSourceTierSchema`
+- `FactSourceTierSchema` — The precedence axis for a fact.
 - `FieldCapability` _(type)_
-- `FieldCapabilitySchema`
+- `FieldCapabilitySchema` — A mutable field's gate: editable, or locked with attribution (sso vs rbac).
 - `FillOpenRoleRequest` _(type)_
-- `FillOpenRoleRequestSchema`
+- `FillOpenRoleRequestSchema` — Fill an open role by seating an existing org member (`userId`) or inviting a new person by email.
 - `HomeAssignment` _(type)_
-- `HomeAssignmentSchema`
+- `HomeAssignmentSchema` — A person's single structural home unit — at most one per person per org.
 - `HomeUnitRole` _(type)_
-- `HomeUnitRoleSchema`
+- `HomeUnitRoleSchema` — Role the invitee takes in their home unit on acceptance.
 - `IDENTITY_TRUST_LEVEL_LABELS`
-- `IdentityTrustLevel` _(type)_
-- `IntegrationRequest` _(type)_
-- `IntegrationRequestStatus` _(type)_
+- `IdentityTrustLevel` _(type)_ — Identity Trust Level — org's identity posture
+- `IntegrationRequest` _(type)_ — Advisory integration request created by a member.
+- `IntegrationRequestStatus` _(type)_ — Status of an integration request from a member.
 - `InviteListResponse` _(type)_
 - `InviteListResponseSchema`
 - `InviteResponse` _(type)_
@@ -101,23 +101,23 @@ Shared type vocabulary for organization ownership, type classification, and tran
 - `LeaveOrgResponseSchema`
 - `ListOrgUnitPermissionsResponse` _(type)_
 - `ListOrgUnitPermissionsResponseSchema`
-- `MemberRecentAction` _(type)_
+- `MemberRecentAction` _(type)_ — Recent audit action attached to a member-detail response.
 - `MissingAtNextLevel` _(type)_
-- `MissingAtNextLevelSchema`
-- `ORG_UNITS_ROUTES`
-- `OidcValidationResult` _(type)_
-- `OidcValidationResultDto` _(type)_
+- `MissingAtNextLevelSchema` — Active users home directly at this unit who have no level-(depth+1) home assignment within its subtree.
+- `ORG_UNITS_ROUTES` — Canonical route path constants for the `/api/org-units` surface.
+- `OidcValidationResult` _(type)_ — Result of validating an OIDC discovery URL.
+- `OidcValidationResultDto` _(type)_ — Result of validating an OIDC discovery URL.
 - `OidcValidationResultSchema`
 - `OpenRole` _(type)_
 - `OpenRoleListResponse` _(type)_
 - `OpenRoleListResponseSchema`
 - `OpenRoleResponse` _(type)_
 - `OpenRoleResponseSchema`
-- `OpenRoleSchema`
-- `OpenRoleStatus` _(type)_
-- `OpenRoleStatusSchema`
-- `OrgAuthPolicy` _(type)_
-- `OrgAuthPolicyDto` _(type)_
+- `OpenRoleSchema` — An open role — a persisted placeholder for the person who will sit in a unit.
+- `OpenRoleStatus` _(type)_ — Hiring lifecycle of an open role — a persisted placeholder for the person who will sit in an org unit (PRD…
+- `OpenRoleStatusSchema` — Hiring lifecycle of an open role.
+- `OrgAuthPolicy` _(type)_ — Organization authentication policy.
+- `OrgAuthPolicyDto` _(type)_ — Organization authentication policy.
 - `OrgAuthPolicySchema`
 - `OrgBillingResponse` _(type)_
 - `OrgBillingResponseSchema`
@@ -125,9 +125,9 @@ Shared type vocabulary for organization ownership, type classification, and tran
 - `OrgBudgetConfigSchema`
 - `OrgDeletionStatus` _(type)_
 - `OrgDeletionStatusSchema`
-- `OrgDomain` _(type)_
-- `OrgInvite` _(type)_
-- `OrgInviteStatus` _(type)_
+- `OrgDomain` _(type)_ — Organization domain claim and verification status.
+- `OrgInvite` _(type)_ — Organization invite for the workspace invites list.
+- `OrgInviteStatus` _(type)_ — Status of an organization invite.
 - `OrgLevelConfig` _(type)_
 - `OrgLevelConfigResponse` _(type)_
 - `OrgLevelConfigResponseSchema`
@@ -135,24 +135,24 @@ Shared type vocabulary for organization ownership, type classification, and tran
 - `OrgLevelIcon` _(type)_
 - `OrgLevelIconSchema`
 - `OrgOwnerIcon` _(type)_
-- `OrgOwnerIconSchema`
-- `OrgScopedContext` _(type)_
+- `OrgOwnerIconSchema` — Icon options for the `owner` org-chart role.
+- `OrgScopedContext` _(type)_ — Validated organization-scoped context for policy implementations.
 - `OrgSystemEventsList` _(type)_
 - `OrgSystemEventsListSchema`
 - `OrgTreeResponse` _(type)_
-- `OrgType` _(type)_
+- `OrgType` _(type)_ — Organization type distinguishes personal workspaces from shared organizations. - 'personal': Single-user…
 - `OrgUnit` _(type)_
 - `OrgUnitAncestorsResponse` _(type)_
 - `OrgUnitAncestorsResponseSchema`
 - `OrgUnitChildrenResponse` _(type)_
 - `OrgUnitChildrenResponseSchema`
-- `OrgUnitClassification` _(type)_
+- `OrgUnitClassification` _(type)_ — Semantic classification — projection-only, never drives traversal.
 - `OrgUnitClassificationSchema`
 - `OrgUnitDescendantsResponse` _(type)_
 - `OrgUnitDescendantsResponseSchema`
 - `OrgUnitDesignation` _(type)_
-- `OrgUnitDesignationSchema`
-- `OrgUnitErrorCode` _(type)_
+- `OrgUnitDesignationSchema` — Designation a member holds over a unit they manage.
+- `OrgUnitErrorCode` _(type)_ — Error codes returned by `POST /api/org-units/:id/reparent` and related mutation endpoints.
 - `OrgUnitErrorCodeSchema`
 - `OrgUnitMembership` _(type)_
 - `OrgUnitMembershipListResponse` _(type)_
@@ -160,56 +160,56 @@ Shared type vocabulary for organization ownership, type classification, and tran
 - `OrgUnitMembershipResponse` _(type)_
 - `OrgUnitMembershipResponseSchema`
 - `OrgUnitMembershipSchema`
-- `OrgUnitMembershipSource` _(type)_
+- `OrgUnitMembershipSource` _(type)_ — External directory origin of a membership row.
 - `OrgUnitMembershipSourceSchema`
-- `OrgUnitMembershipStatus` _(type)_
+- `OrgUnitMembershipStatus` _(type)_ — Active/pending/removed lifecycle for a unit membership.
 - `OrgUnitMembershipStatusSchema`
 - `OrgUnitOwner` _(type)_
 - `OrgUnitOwnerSchema`
 - `OrgUnitOwnersResponse` _(type)_
 - `OrgUnitOwnersResponseSchema`
 - `OrgUnitPermissionsEntry` _(type)_
-- `OrgUnitPermissionsEntrySchema`
+- `OrgUnitPermissionsEntrySchema` — Effective manager of an org unit — a user whose membership (direct or inherited from an ancestor) grants the…
 - `OrgUnitRelationship` _(type)_
-- `OrgUnitRelationshipRole` _(type)_
+- `OrgUnitRelationshipRole` _(type)_ — Edge role — refines the collaboration nature on a graph edge.
 - `OrgUnitRelationshipRoleSchema`
 - `OrgUnitRelationshipSchema`
-- `OrgUnitRelationshipType` _(type)_
+- `OrgUnitRelationshipType` _(type)_ — Edge classification for `org_unit_relationships`.
 - `OrgUnitRelationshipTypeSchema`
 - `OrgUnitRelationshipsResponse` _(type)_
 - `OrgUnitRelationshipsResponseSchema`
 - `OrgUnitResponse` _(type)_
 - `OrgUnitResponseSchema`
 - `OrgUnitSchema`
-- `OrgUnitSyncMode` _(type)_
+- `OrgUnitSyncMode` _(type)_ — External directory reconciliation policy for a unit.
 - `OrgUnitSyncModeSchema`
 - `OrgUnitTreeNode` _(type)_
 - `OrgUnitTreeNodeSchema`
 - `OrgUnitTreeResponse` _(type)_
 - `OrgUnitTreeResponseSchema`
-- `OrgUnitVisibility` _(type)_
+- `OrgUnitVisibility` _(type)_ — Default visibility inherited by new docs under this unit.
 - `OrgUnitVisibilitySchema`
 - `OrgUsageResponse` _(type)_
 - `OrgUsageResponseSchema`
-- `OrganizationInfo` _(type)_
+- `OrganizationInfo` _(type)_ — Public organization information suitable for API responses.
 - `OwnerAuthority` _(type)_
 - `OwnerAuthoritySchema`
-- `OwnerIdentityInfo` _(type)_
+- `OwnerIdentityInfo` _(type)_ — Owner identity information for the SSO readiness surface.
 - `OwnershipTransferPreview` _(type)_
 - `OwnershipTransferPreviewSchema`
-- `OwnershipTransferRequest` _(type)_
+- `OwnershipTransferRequest` _(type)_ — Request payload for initiating ownership transfer.
 - `OwnershipTransferResponse` _(type)_
 - `OwnershipTransferResponseSchema`
-- `OwnershipTransferStatus` _(type)_
-- `PermissionAuditEntry` _(type)_
-- `Phase3AuditAction` _(type)_
-- `Phase4AuditAction` _(type)_
-- `ProviderStatus` _(type)_
-- `ProviderSuggestion` _(type)_
-- `RemoveMemberRequest` _(type)_
+- `OwnershipTransferStatus` _(type)_ — Status of pending ownership transfer for an organization.
+- `PermissionAuditEntry` _(type)_ — Single entry in the permission change audit log.
+- `Phase3AuditAction` _(type)_ — Audit actions for Phase 3 workspace expansion features.
+- `Phase4AuditAction` _(type)_ — Audit actions for Phase 4 enterprise identity features.
+- `ProviderStatus` _(type)_ — Provider-level configuration lifecycle.
+- `ProviderSuggestion` _(type)_ — MX-based provider suggestion for SSO setup.
+- `RemoveMemberRequest` _(type)_ — Request payload for removing a member from the workspace.
 - `RemoveMemberResponse` _(type)_
 - `RemoveMemberResponseSchema`
-- `RoleCatalogEntry` _(type)_
+- `RoleCatalogEntry` _(type)_ — Entry in the RBAC roles catalog (GET /api/rbac/roles).
 - `RoleCatalogEntrySchema`
 - `RoleCatalogResponseSchema`
 - `ScopeCheckBatchResponse` _(type)_
@@ -219,78 +219,78 @@ Shared type vocabulary for organization ownership, type classification, and tran
 - `SetActiveOrgResponse` _(type)_
 - `SetActiveOrgResponseSchema`
 - `SetMemberManagerResponse` _(type)_
-- `SetMemberManagerResponseSchema`
-- `SharePolicy` _(type)_
-- `ShareState` _(type)_
-- `SsoCredentialStatus` _(type)_
-- `SsoDiscoveryConfig` _(type)_
-- `SsoEnforcementStatus` _(type)_
-- `SsoOperationalState` _(type)_
-- `SsoReadiness` _(type)_
-- `SsoReadinessCheck` _(type)_
-- `SsoSetupInfo` _(type)_
-- `SsoStepperStep` _(type)_
+- `SetMemberManagerResponseSchema` — Response for setting (PATCH) or clearing (DELETE) a member's solid-line manager — the person-to-person…
+- `SharePolicy` _(type)_ — Document sharing policy. - restricted: Only explicit ACL + owning unit + org admins - orgread: All org…
+- `ShareState` _(type)_ — Complete sharing state for a document.
+- `SsoCredentialStatus` _(type)_ — Boolean credential presence indicators (never expose actual values).
+- `SsoDiscoveryConfig` _(type)_ — OIDC discovery configuration for the SSO provider.
+- `SsoEnforcementStatus` _(type)_ — SSO enforcement status for the workspace.
+- `SsoOperationalState` _(type)_ — Provider lifecycle and operational state.
+- `SsoReadiness` _(type)_ — SSO readiness assessment aggregating individual checks.
+- `SsoReadinessCheck` _(type)_ — Individual readiness check for SSO activation.
+- `SsoSetupInfo` _(type)_ — SSO setup information for admin configuration UI.
+- `SsoStepperStep` _(type)_ — Backend-authoritative stepper step.
 - `SubmitInteractiveTaskResponse` _(type)_
-- `SubmitInteractiveTaskResponseSchema`
-- `TRANSFER_RESPONSIBILITIES`
-- `TestSsoInitiation` _(type)_
-- `TestSsoInitiationDto` _(type)_
+- `SubmitInteractiveTaskResponseSchema` — Response for submitting a filled-in interactive chat task surface (e.g. the editable "change reporting…
+- `TRANSFER_RESPONSIBILITIES` — Responsibility checklist items shown on the acceptance page.
+- `TestSsoInitiation` _(type)_ — Initiation payload for a test SSO login attempt.
+- `TestSsoInitiationDto` _(type)_ — Initiation payload for a test SSO login attempt.
 - `TestSsoInitiationSchema`
-- `TestSsoResult` _(type)_
-- `TestSsoResultDto` _(type)_
+- `TestSsoResult` _(type)_ — Result of a test SSO login attempt.
+- `TestSsoResultDto` _(type)_ — Result of a test SSO login attempt.
 - `TestSsoResultSchema`
-- `TransferAcceptanceView` _(type)_
-- `TransferEligibilityResult` _(type)_
-- `TransferInitiateRequest` _(type)_
-- `TransferMemberEligibility` _(type)_
+- `TransferAcceptanceView` _(type)_ — Read-only view for the transfer acceptance page.
+- `TransferEligibilityResult` _(type)_ — Transfer eligibility result with ITL context
+- `TransferInitiateRequest` _(type)_ — Request body for initiating ownership transfer (extends existing to include optional note).
+- `TransferMemberEligibility` _(type)_ — Per-member eligibility for transfer recipient picker
 - `TransferResponsibility` _(type)_
-- `TransferStatusResponse` _(type)_
-- `TreeOrderableNode` _(type)_
+- `TransferStatusResponse` _(type)_ — Response for transfer status queries — extends existing OwnershipTransferStatus.
+- `TreeOrderableNode` _(type)_ — Canonical per-parent sibling ordering for OrgUnit trees.
 - `UnitMembershipRole` _(type)_
-- `UnitMembershipRoleSchema`
-- `UpdateAuthPolicyRequest` _(type)_
+- `UnitMembershipRoleSchema` — Positional slot a member holds in the org-unit tree.
+- `UpdateAuthPolicyRequest` _(type)_ — Request payload for updating organization auth policy.
 - `UpdateDelegationRequest` _(type)_
-- `UpdateDelegationRequestSchema`
+- `UpdateDelegationRequestSchema` — Change a delegation's expiry without revoking it: extend, shorten, or clear (set `expiresAt: null` to make it…
 - `UpdateOpenRoleStatusRequest` _(type)_
-- `UpdateOpenRoleStatusRequestSchema`
+- `UpdateOpenRoleStatusRequestSchema` — Only the non-terminal client transitions are accepted; `fill` is its own endpoint and `open` is the seeded…
 - `UpdateOrgUnitRequest` _(type)_
 - `UpdateOrgUnitRequestSchema`
 - `UpdateOrgUnitResponse` _(type)_
 - `UpdateOrgUnitResponseSchema`
-- `UserOrgMembership` _(type)_
+- `UserOrgMembership` _(type)_ — User organization membership summary.
 - `UserOrgsResponse` _(type)_
 - `UserOrgsResponseSchema`
-- `VIEW_SCOPE_MAP`
+- `VIEW_SCOPE_MAP` — View-to-scope mapping for frontend authorization. - Views with string values require that scope for access -…
 - `WorkspaceAccessResponse` _(type)_
 - `WorkspaceAccessResponseSchema`
-- `WorkspaceAuditEvent` _(type)_
-- `WorkspaceAuditEventDto` _(type)_
+- `WorkspaceAuditEvent` _(type)_ — Audit event for the workspace audit log.
+- `WorkspaceAuditEventDto` _(type)_ — Audit event for the workspace audit log.
 - `WorkspaceAuditEventSchema`
 - `WorkspaceAuditResponseSchema`
-- `WorkspaceAuthConfig` _(type)_
-- `WorkspaceAuthConfigDto` _(type)_
+- `WorkspaceAuthConfig` _(type)_ — Workspace authentication configuration.
+- `WorkspaceAuthConfigDto` _(type)_ — Workspace authentication configuration.
 - `WorkspaceAuthConfigSchema`
-- `WorkspaceInfoOverview` _(type)_
-- `WorkspaceMember` _(type)_
-- `WorkspaceMemberDetail` _(type)_
+- `WorkspaceInfoOverview` _(type)_ — Read-only workspace overview for the Info surface.
+- `WorkspaceMember` _(type)_ — Workspace member for the members list.
+- `WorkspaceMemberDetail` _(type)_ — Full member detail (GET /api/workspace/members/:userId and /api/me self-view).
 - `WorkspaceMemberDetailSchema`
-- `WorkspaceMemberInviteStatus` _(type)_
+- `WorkspaceMemberInviteStatus` _(type)_ — Invite status for a workspace member row.
 - `WorkspaceMemberUnitDesignationEntry` _(type)_
 - `WorkspaceMemberUnitDesignationEntrySchema`
-- `WorkspaceMemberUnitSummary` _(type)_
+- `WorkspaceMemberUnitSummary` _(type)_ — Single OrgUnit membership summary attached to a WorkspaceMember row.
 - `WorkspaceMembersResponse` _(type)_
 - `WorkspaceMembersResponseSchema`
-- `WorkspaceOverview` _(type)_
-- `WorkspaceOverviewDto` _(type)_
+- `WorkspaceOverview` _(type)_ — Workspace overview for the control plane UI.
+- `WorkspaceOverviewDto` _(type)_ — Workspace overview for the control plane UI.
 - `WorkspaceOverviewSchema`
 - `WorkspaceResolvePathResponse` _(type)_
 - `WorkspaceResolvePathResponseSchema`
 - `WorkspaceResyncSlackLogoResponse` _(type)_
 - `WorkspaceResyncSlackLogoResponseSchema`
-- `WorkspaceSettingsOverview` _(type)_
-- `WorkspaceSsoState` _(type)_
-- `WorkspaceSurface` _(type)_
-- `getViewScope`
+- `WorkspaceSettingsOverview` _(type)_ — Full workspace overview for the Settings surface.
+- `WorkspaceSsoState` _(type)_ — Workspace SSO state derived from provider status + policy.
+- `WorkspaceSurface` _(type)_ — Discriminator for workspace surface routing. - 'info': Read-only surface, any member, org.view capabilities -…
+- `getViewScope` — Get the required scope for a view, or null if public.
 - `orderTreeNodes`
 
 <!-- END GENERATED: readme-public-api -->

package/src/org/schemas.ts

@@ -599,7 +599,7 @@ export type ScopeCheckBatchResponse = z.infer<
 
 /**
  * Role the invitee takes in their home unit on acceptance. `unit_owner` is a
- * deferred structural-leadership grant applied at accept time. Source of truth
+ * deferred unit-ownership grant applied at accept time. Source of truth
  * for the hand-mirrored `OrgInvite`/`CreateInviteRequest` interface unions in
  * `org/types.ts` (enforced by the `schema-type-mirror` guard).
  */
@@ -617,7 +617,7 @@ const OrgInviteSchema = z.object({
   // Optional/nullable: legacy invites predate this field.
   homeUnitId: z.string().uuid().optional(),
   // Role the invitee takes in homeUnitId on acceptance ('unit_owner' is a
-  // deferred structural-leadership grant). Optional/'member' for legacy +
+  // deferred unit-ownership grant). Optional/'member' for legacy +
   // unit-less invites.
   homeUnitRole: HomeUnitRoleSchema.optional(),
   createdAt: z.string(),
@@ -1086,7 +1086,7 @@ export const OwnerAuthoritySchema = z.object({
   derivedFromUnitName: z.string().min(1).optional(),
   /**
    * True when this authority derives from the org ROOT unit — i.e. the holder
-   * is a CEO (a structural leader of the org root, observed locally on the root
+   * is a CEO (a unit owner of the org root, observed locally on the root
    * or as inherited authority on a descendant). Lets consumers classify CEO
    * without a separate org-tree lookup, the same way `mechanism === 'rbac'`
    * identifies an org admin. Omitted (falsy) for non-root derivations.

package/src/permissions/orgchart-roles.ts

@@ -37,7 +37,7 @@ export const OrgChartRoleSchema = z.enum(ORG_CHART_ROLES);
  * org-chart standing) renders as "Member" via {@link orgChartRoleLabel}.
  *
  * `owner` is the organization's highest-authority individual (the account
- * owner, or a structural leader of the root unit). Its DEFAULT label is
+ * owner, or a unit owner of the root unit). Its DEFAULT label is
  * "CEO" — what every new org sees — and is org-renamable via the
  * `owner_title` org setting (ADR-CONTRACTS-061); pass the org's resolved
  * title through {@link orgChartRoleLabel}'s `ownerTitle` option to apply it.