OSS-first docs
These docs teach the open system first: contracts, generated surfaces, runtimes, governance, and incremental adoption. Studio shows up as the operating layer on top, not as the source of truth.
Reference
Generated reference material for public contract surfaces, versions, owners, and example-backed implementations. Use this when you need the repo truth, not just the narrative docs layer.
field.summary.labelPerform file system access within an ACP session.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Tags**: filesystem
- **File**: `packages/libs/contracts-spec/src/acp/commands/acpFsAccess.command.ts`field.route.label/docs/reference/_common/acp.fs.access
referencepublic
field.summary.labelExecute a prompt turn within an ACP session.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Tags**: prompt
- **File**: `packages/libs/contracts-spec/src/acp/commands/acpPromptTurn.command.ts`
Run ACP prompt turns with tool calls and structured outputs.field.route.label/docs/reference/_common/acp.prompt.turn
referencepublic
field.summary.labelInitialize a new ACP session.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Tags**: session
- **File**: `packages/libs/contracts-spec/src/acp/commands/acpSessionInit.command.ts`
Start a governed ACP session with configured tools and policies.field.route.label/docs/reference/_common/acp.session.init
referencepublic
field.summary.labelResume an existing ACP session.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Tags**: session
- **File**: `packages/libs/contracts-spec/src/acp/commands/acpSessionResume.command.ts`
Continue a previously initialized ACP session with full context.field.route.label/docs/reference/_common/acp.session.resume
referencepublic
field.summary.labelStop an active ACP session.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Tags**: session
- **File**: `packages/libs/contracts-spec/src/acp/commands/acpSessionStop.command.ts`
Terminate ACP sessions cleanly with audit trails.field.route.label/docs/reference/_common/acp.session.stop
referencepublic
field.summary.labelExecute a terminal command within an ACP session.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Tags**: terminal
- **File**: `packages/libs/contracts-spec/src/acp/commands/acpTerminalExec.command.ts`field.route.label/docs/reference/_common/acp.terminal.exec
referencepublic
field.summary.labelExecute tool calls within an ACP session.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Tags**: tools
- **File**: `packages/libs/contracts-spec/src/acp/commands/acpToolCalls.command.ts`
Run tool calls with safe governance and telemetry.field.route.label/docs/reference/_common/acp.tool.calls
referencepublic
field.summary.labelAgent Client Protocol transport surfaces.
- **Type**: capability (capability)
- **Version**: 1.0.0
- **Tags**: transport
- **File**: `packages/libs/contracts-spec/src/acp/capabilities/acpTransport.capability.ts`field.route.label/docs/reference/_common/acp.transport
referencepublic
field.summary.label- **Type**: operation (command)
- **Version**: 1.0.0
- **File**: `packages/libs/contracts-spec/src/tests/spec.ts`
```typescript
import { compareVersions } from 'compare-versions';
import type { DocBlock } from '../docs/types';field.route.label/docs/reference/_common/AddNumbersSpec
referencepublic
field.summary.labelEmitted when an approval is required for an agent action.
- **Type**: event (event)
- **Version**: 1.0.0
- **Tags**: approval
- **File**: `packages/libs/contracts-spec/src/agent/events/agentApprovalRequested.event.ts`field.route.label/docs/reference/_common/agent.approval.requested
referencepublic
field.summary.labelApprove or reject an agent step or run.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Tags**: approval
- **File**: `packages/libs/contracts-spec/src/agent/commands/agentApprovals.command.ts`
Provide governed human-in-the-loop control for risky steps.field.route.label/docs/reference/_common/agent.approvals
referencepublic
field.summary.labelList artifacts produced by an agent run.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Tags**: artifacts
- **File**: `packages/libs/contracts-spec/src/agent/queries/agentArtifacts.query.ts`
Provide traceable outputs for audits and UI surfaces.field.route.label/docs/reference/_common/agent.artifacts
referencepublic
field.summary.labelCancel an in-flight agent run.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Tags**: run, cancel
- **File**: `packages/libs/contracts-spec/src/agent/commands/agentCancel.command.ts`
Provide safe operator control to stop background agents.field.route.label/docs/reference/_common/agent.cancel
referencepublic
field.summary.labelBackground agent execution, approvals, and artifacts.
- **Type**: capability (capability)
- **Version**: 1.0.0
- **Tags**: execution
- **File**: `packages/libs/contracts-spec/src/agent/capabilities/agentExecution.capability.ts`field.route.label/docs/reference/_common/agent.execution
referencepublic
field.summary.labelSubmit a background agent run with a context snapshot.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Tags**: run
- **File**: `packages/libs/contracts-spec/src/agent/commands/agentRun.command.ts`field.route.label/docs/reference/_common/agent.run
referencepublic
field.summary.labelAudit layout for agent runs and artifacts.
- **Type**: presentation (presentation)
- **Version**: 1.0.0
- **Tags**: audit
- **File**: `packages/libs/contracts-spec/src/agent/presentations/agentRunAudit.presentation.ts`field.route.label/docs/reference/_common/agent.run.audit
referencepublic
field.summary.labelEmitted when an agent run completes successfully.
- **Type**: event (event)
- **Version**: 1.0.0
- **Tags**: run
- **File**: `packages/libs/contracts-spec/src/agent/events/agentRunCompleted.event.ts`
```typescriptfield.route.label/docs/reference/_common/agent.run.completed
referencepublic
field.summary.labelEmitted when an agent run fails.
- **Type**: event (event)
- **Version**: 1.0.0
- **Tags**: run
- **File**: `packages/libs/contracts-spec/src/agent/events/agentRunFailed.event.ts`
```typescript
export const AgentRunFailedEvent = defineEvent({field.route.label/docs/reference/_common/agent.run.failed
referencepublic
field.summary.labelEmitted when an agent run starts executing.
- **Type**: event (event)
- **Version**: 1.0.0
- **Tags**: run
- **File**: `packages/libs/contracts-spec/src/agent/events/agentRunStarted.event.ts`
```typescript
export const AgentRunStartedEvent = defineEvent({field.route.label/docs/reference/_common/agent.run.started
referencepublic
field.summary.labelGet status for agent runs.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Tags**: status
- **File**: `packages/libs/contracts-spec/src/agent/queries/agentStatus.query.ts`
Provide status and progress visibility for background agents.field.route.label/docs/reference/_common/agent.status
referencepublic
field.summary.labelDescribe a context pack and its sources.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Tags**: pack, describe
- **File**: `packages/libs/contracts-spec/src/context/queries/contextPackDescribe.query.ts`field.route.label/docs/reference/_common/context.pack.describe
referencepublic
field.summary.labelSearch and filter context packs and snapshots.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Tags**: pack, search
- **File**: `packages/libs/contracts-spec/src/context/queries/contextPackSearch.query.ts`field.route.label/docs/reference/_common/context.pack.search
referencepublic
field.summary.labelCreate an immutable snapshot from a context pack.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Tags**: snapshot, create
- **File**: `packages/libs/contracts-spec/src/context/commands/contextPackSnapshot.command.ts`field.route.label/docs/reference/_common/context.pack.snapshot
referencepublic
field.summary.labelEmitted when a context snapshot is created.
- **Type**: event (event)
- **Version**: 1.0.0
- **Tags**: snapshot
- **File**: `packages/libs/contracts-spec/src/context/events/contextSnapshotCreated.event.ts`field.route.label/docs/reference/_common/context.snapshot.created
referencepublic
field.summary.labelSummary layout for context snapshots.
- **Type**: presentation (presentation)
- **Version**: 1.0.0
- **Tags**: snapshot, summary
- **File**: `packages/libs/contracts-spec/src/context/presentations/contextSnapshot.presentation.ts`field.route.label/docs/reference/_common/context.snapshot.summary
referencepublic
field.summary.labelContext packs, snapshots, and discovery surfaces.
- **Type**: capability (capability)
- **Version**: 1.0.0
- **Tags**: system
- **File**: `packages/libs/contracts-spec/src/context/capabilities/contextSystem.capability.ts`field.route.label/docs/reference/_common/context.system
referencepublic
field.summary.labelComprehensive documentation system for ContractSpec
- **Type**: feature
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @platform.docs
- **Tags**: documentation, guides, api-reference
- **File**: `/Users/tboutron/Documents/clients/lssm/monorepo-lssm/packages/contractspec/packages/bundles/library/src/features/docs.feature.ts`field.route.label/docs/reference/_common/contractspec.docs
referencepublic
field.summary.labelModel Context Protocol server for AI agent integration
- **Type**: feature
- **Version**: 1.0.0
- **Stability**: beta
- **Owners**: @platform.mcp
- **Tags**: mcp, ai-agents, tooling
- **File**: `/Users/tboutron/Documents/clients/lssm/monorepo-lssm/packages/contractspec/packages/bundles/library/src/features/mcp.feature.ts`field.route.label/docs/reference/_common/contractspec.mcp
referencepublic
field.summary.labelCross-platform rendering of contract-driven UI
- **Type**: feature
- **Version**: 1.0.0
- **Stability**: beta
- **Owners**: @platform.presentations
- **Tags**: presentations, ui, rendering, cross-platform
- **File**: `/Users/tboutron/Documents/clients/lssm/monorepo-lssm/packages/contractspec/packages/bundles/library/src/features/presentations.feature.ts`field.route.label/docs/reference/_common/contractspec.presentations
referencepublic
field.summary.labelHuman approval and rejection gates for execution steps.
- **Type**: capability (capability)
- **Version**: 1.0.0
- **Tags**: approval
- **File**: `packages/libs/contracts-spec/src/control-plane/capabilities/controlPlaneApproval.capability.ts`field.route.label/docs/reference/_common/control-plane.approval
referencepublic
field.summary.labelTrace, policy explanation, and replay-grade observability.
- **Type**: capability (capability)
- **Version**: 1.0.0
- **Tags**: audit
- **File**: `packages/libs/contracts-spec/src/control-plane/capabilities/controlPlaneAudit.capability.ts`field.route.label/docs/reference/_common/control-plane.audit
referencepublic
field.summary.labelChannel-facing runtime surfaces for controlled execution.
- **Type**: capability (capability)
- **Version**: 1.0.0
- **Tags**: channels
- **File**: `packages/libs/contracts-spec/src/control-plane/capabilities/controlPlaneChannelRuntime.capability.ts`field.route.label/docs/reference/_common/control-plane.channel-runtime
referencepublic
field.summary.labelCore intent, planning, and execution surfaces.
- **Type**: capability (capability)
- **Version**: 1.0.0
- **Tags**: core
- **File**: `packages/libs/contracts-spec/src/control-plane/capabilities/controlPlaneCore.capability.ts`field.route.label/docs/reference/_common/control-plane.core
referencepublic
field.summary.labelSigned skill lifecycle and compatibility governance.
- **Type**: capability (capability)
- **Version**: 1.0.0
- **Tags**: skills
- **File**: `packages/libs/contracts-spec/src/control-plane/capabilities/controlPlaneSkillRegistry.capability.ts`field.route.label/docs/reference/_common/control-plane.skill-registry
referencepublic
field.summary.labelApprove a pending execution step for continuation.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Tags**: approval
- **File**: `packages/libs/contracts-spec/src/control-plane/commands/controlPlaneExecutionApprove.command.ts`field.route.label/docs/reference/_common/controlPlane.execution.approve
referencepublic
field.summary.labelCancel an execution run and transition to terminal state.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Tags**: execution, approval
- **File**: `packages/libs/contracts-spec/src/control-plane/commands/controlPlaneExecutionCancel.command.ts`field.route.label/docs/reference/_common/controlPlane.execution.cancel
referencepublic
field.summary.labelEmitted when an execution run finishes successfully.
- **Type**: event (event)
- **Version**: 1.0.0
- **Tags**: execution
- **File**: `packages/libs/contracts-spec/src/control-plane/events/controlPlaneExecutionCompleted.event.ts`field.route.label/docs/reference/_common/controlPlane.execution.completed
referencepublic
field.summary.labelEmitted when an execution run fails.
- **Type**: event (event)
- **Version**: 1.0.0
- **Tags**: execution, failure
- **File**: `packages/libs/contracts-spec/src/control-plane/events/controlPlaneExecutionFailed.event.ts`field.route.label/docs/reference/_common/controlPlane.execution.failed
referencepublic
field.summary.labelFetch the latest state for one execution.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Tags**: execution
- **File**: `packages/libs/contracts-spec/src/control-plane/queries/controlPlaneExecutionGet.query.ts`field.route.label/docs/reference/_common/controlPlane.execution.get
referencepublic
field.summary.labelList execution runs with filtering and pagination.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Tags**: execution
- **File**: `packages/libs/contracts-spec/src/control-plane/queries/controlPlaneExecutionList.query.ts`field.route.label/docs/reference/_common/controlPlane.execution.list
referencepublic
field.summary.labelReject a pending execution step.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Tags**: approval
- **File**: `packages/libs/contracts-spec/src/control-plane/commands/controlPlaneExecutionReject.command.ts`field.route.label/docs/reference/_common/controlPlane.execution.reject
referencepublic
field.summary.labelStart executing an approved compiled plan.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Tags**: execution
- **File**: `packages/libs/contracts-spec/src/control-plane/commands/controlPlaneExecutionStart.command.ts`field.route.label/docs/reference/_common/controlPlane.execution.start
referencepublic
field.summary.labelEmitted when policy blocks an execution step.
- **Type**: event (event)
- **Version**: 1.0.0
- **Tags**: execution, blocked
- **File**: `packages/libs/contracts-spec/src/control-plane/events/controlPlaneExecutionStepBlocked.event.ts`field.route.label/docs/reference/_common/controlPlane.execution.step.blocked
referencepublic
field.summary.labelEmitted when an execution step completes.
- **Type**: event (event)
- **Version**: 1.0.0
- **Tags**: execution
- **File**: `packages/libs/contracts-spec/src/control-plane/events/controlPlaneExecutionStepCompleted.event.ts`field.route.label/docs/reference/_common/controlPlane.execution.step.completed
referencepublic
field.summary.labelEmitted when an execution step starts.
- **Type**: event (event)
- **Version**: 1.0.0
- **Tags**: execution
- **File**: `packages/libs/contracts-spec/src/control-plane/events/controlPlaneExecutionStepStarted.event.ts`field.route.label/docs/reference/_common/controlPlane.execution.step.started
referencepublic
field.summary.labelEmitted when a new control plane intent is accepted.
- **Type**: event (event)
- **Version**: 1.0.0
- **Tags**: intent
- **File**: `packages/libs/contracts-spec/src/control-plane/events/controlPlaneIntentReceived.event.ts`field.route.label/docs/reference/_common/controlPlane.intent.received
referencepublic
field.summary.labelSubmit a natural-language intent to the control plane.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Tags**: intent
- **File**: `packages/libs/contracts-spec/src/control-plane/commands/controlPlaneIntentSubmit.command.ts`field.route.label/docs/reference/_common/controlPlane.intent.submit
referencepublic
field.summary.labelCompile an intent into a deterministic plan DAG.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Tags**: plan
- **File**: `packages/libs/contracts-spec/src/control-plane/commands/controlPlanePlanCompile.command.ts`field.route.label/docs/reference/_common/controlPlane.plan.compile
referencepublic
field.summary.labelEmitted when an intent is compiled into an executable plan.
- **Type**: event (event)
- **Version**: 1.0.0
- **Tags**: plan
- **File**: `packages/libs/contracts-spec/src/control-plane/events/controlPlanePlanCompiled.event.ts`field.route.label/docs/reference/_common/controlPlane.plan.compiled
referencepublic
field.summary.labelEmitted when a plan fails verification or governance checks.
- **Type**: event (event)
- **Version**: 1.0.0
- **Tags**: plan, governance
- **File**: `packages/libs/contracts-spec/src/control-plane/events/controlPlanePlanRejected.event.ts`field.route.label/docs/reference/_common/controlPlane.plan.rejected
referencepublic
field.summary.labelRun policy and risk validation against a compiled plan.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Tags**: plan, governance
- **File**: `packages/libs/contracts-spec/src/control-plane/commands/controlPlanePlanVerify.command.ts`field.route.label/docs/reference/_common/controlPlane.plan.verify
referencepublic
field.summary.labelExplain policy outcomes for an execution or step.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Tags**: policy, audit
- **File**: `packages/libs/contracts-spec/src/control-plane/queries/controlPlanePolicyExplain.query.ts`field.route.label/docs/reference/_common/controlPlane.policy.explain
referencepublic
field.summary.labelDisable an installed skill in the control plane registry.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Tags**: skills, governance
- **File**: `packages/libs/contracts-spec/src/control-plane/commands/controlPlaneSkillDisable.command.ts`field.route.label/docs/reference/_common/controlPlane.skill.disable
referencepublic
field.summary.labelInstall a signed skill artifact after verification checks.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Tags**: skills
- **File**: `packages/libs/contracts-spec/src/control-plane/commands/controlPlaneSkillInstall.command.ts`field.route.label/docs/reference/_common/controlPlane.skill.install
referencepublic
field.summary.labelEmitted when a skill artifact is verified and installed.
- **Type**: event (event)
- **Version**: 1.0.0
- **Tags**: skills
- **File**: `packages/libs/contracts-spec/src/control-plane/events/controlPlaneSkillInstalled.event.ts`field.route.label/docs/reference/_common/controlPlane.skill.installed
referencepublic
field.summary.labelList installed and available skill artifacts.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Tags**: skills
- **File**: `packages/libs/contracts-spec/src/control-plane/queries/controlPlaneSkillList.query.ts`field.route.label/docs/reference/_common/controlPlane.skill.list
referencepublic
field.summary.labelEmitted when a skill install attempt is rejected.
- **Type**: event (event)
- **Version**: 1.0.0
- **Tags**: skills, governance
- **File**: `packages/libs/contracts-spec/src/control-plane/events/controlPlaneSkillRejected.event.ts`field.route.label/docs/reference/_common/controlPlane.skill.rejected
referencepublic
field.summary.labelVerify skill signature and compatibility constraints.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Tags**: skills, governance
- **File**: `packages/libs/contracts-spec/src/control-plane/queries/controlPlaneSkillVerify.query.ts`field.route.label/docs/reference/_common/controlPlane.skill.verify
referencepublic
field.summary.labelReturn the replayable trace timeline for one execution.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Tags**: trace, audit
- **File**: `packages/libs/contracts-spec/src/control-plane/queries/controlPlaneTraceGet.query.ts`field.route.label/docs/reference/_common/controlPlane.trace.get
referencepublic
field.summary.label- **Type**: operation (command)
- **Version**: 1.0.0
- **File**: `packages/libs/video-gen/src/docs/rendering.docblock.ts`
```typescript
export const createUser = defineCommand({...})
```field.route.label/docs/reference/_common/createUser
referencepublic
field.summary.labelSchema, migration, dictionary, and read-only query surfaces.
- **Type**: capability (capability)
- **Version**: 1.0.0
- **Tags**: context
- **File**: `packages/libs/contracts-spec/src/database/capabilities/databaseContext.capability.ts`field.route.label/docs/reference/_common/database.context
referencepublic
field.summary.labelRetrieve a data dictionary entry for a schema field.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Tags**: dictionary
- **File**: `packages/libs/contracts-spec/src/database/queries/databaseDictionaryGet.query.ts`field.route.label/docs/reference/_common/database.dictionary.get
referencepublic
field.summary.labelList registered database migrations and statuses.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Tags**: migrations
- **File**: `packages/libs/contracts-spec/src/database/queries/databaseMigrationsList.query.ts`field.route.label/docs/reference/_common/database.migrations.list
referencepublic
field.summary.labelExecute a governed read-only query via a data view.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Tags**: query, readonly
- **File**: `packages/libs/contracts-spec/src/database/queries/databaseQueryReadonly.query.ts`field.route.label/docs/reference/_common/database.query.readonly
referencepublic
field.summary.labelDescribe database schemas and models with PII indicators.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Tags**: describe
- **File**: `packages/libs/contracts-spec/src/database/queries/databaseSchemaDescribe.query.ts`field.route.label/docs/reference/_common/database.schema.describe
referencepublic
field.summary.labelResolve a contract into a documentation-ready reference.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Tags**: reference
- **File**: `packages/libs/contracts-spec/src/docs/queries/contractReference.query.ts`field.route.label/docs/reference/_common/docs.contract.reference
referencepublic
field.summary.labelGenerate documentation artifacts from ContractSpecs.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Tags**: generation
- **File**: `packages/libs/contracts-spec/src/docs/commands/docsGenerate.command.ts`field.route.label/docs/reference/_common/docs.generate
referencepublic
field.summary.labelEmitted when documentation artifacts are generated.
- **Type**: event (event)
- **Version**: 1.0.0
- **Tags**: generation
- **File**: `packages/libs/contracts-spec/src/docs/events/docsGenerated.event.ts`
```typescriptfield.route.label/docs/reference/_common/docs.generated
referencepublic
field.summary.labelShared layout shell for documentation pages.
- **Type**: presentation (presentation)
- **Version**: 1.0.0
- **Tags**: layout
- **File**: `packages/libs/contracts-spec/src/docs/presentations/docsLayout.presentation.ts`field.route.label/docs/reference/_common/docs.layout
referencepublic
field.summary.labelPublish generated documentation artifacts.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Tags**: publish
- **File**: `packages/libs/contracts-spec/src/docs/commands/docsPublish.command.ts`
Deploy docs to the public docs surface with consistent versioning.field.route.label/docs/reference/_common/docs.publish
referencepublic
field.summary.labelEmitted when documentation is published.
- **Type**: event (event)
- **Version**: 1.0.0
- **Tags**: publish
- **File**: `packages/libs/contracts-spec/src/docs/events/docsPublished.event.ts`
```typescript
export const DocsPublishedEvent = defineEvent({field.route.label/docs/reference/_common/docs.published
referencepublic
field.summary.labelReference page layout for contract documentation.
- **Type**: presentation (presentation)
- **Version**: 1.0.0
- **Tags**: reference
- **File**: `packages/libs/contracts-spec/src/docs/presentations/docsReferencePage.presentation.ts`field.route.label/docs/reference/_common/docs.reference.page
referencepublic
field.summary.labelSearch and filter DocBlocks by query, tag, or visibility.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Tags**: search, index
- **File**: `packages/libs/contracts-spec/src/docs/queries/docsIndex.query.ts`field.route.label/docs/reference/_common/docs.search
referencepublic
field.summary.labelEnd-to-end docs generation, indexing, and presentation.
- **Type**: capability (capability)
- **Version**: 1.0.0
- **Tags**: system
- **File**: `packages/libs/contracts-spec/src/docs/capabilities/documentationSystem.capability.ts`field.route.label/docs/reference/_common/docs.system
referencepublic
field.summary.labelCapabilities are **module interfaces** that define:
1. What operations, events, and presentations a module exposes (`provides`)
2. What other capabilities it depends on (`requires`)
3. Inheritance hierarchies via `extends`field.route.label/docs/reference/_common/docs.tech.contracts.capabilities
referencepublic
field.summary.labelUse `TestSpec` to describe end-to-end scenarios for contracts and workflows. Specs live alongside your contracts and exercise the same OperationSpecRegistry handlers the app uses.
- Types & registry: `packages/libs/contracts/src/tests/spec.ts`field.route.label/docs/reference/_common/docs.tech.contracts.tests
referencepublic
field.summary.labelWorkflowSpec provides a declarative, versioned format for long-running flows that mix automation and human review. Specs stay inside `@lssm-tech/lib.contracts-spec` (`src/workflow/spec.ts`) so the same definition powers runtime execution, documentation, and future generation.field.route.label/docs/reference/_common/docs.tech.workflows.overview
referencepublic
field.summary.labelCanonical showcase for readonly, password, autocomplete, address, phone, temporal, and repeated grouped fields.
- **Type**: form (form)
- **Version**: 1.0.0
- **Tags**: forms, showcase
- **File**: `packages/libs/contracts-spec/src/forms/richFieldsShowcase.form.ts`field.route.label/docs/reference/_common/forms.rich-fields-showcase
referencepublic
field.summary.labelSets up ContractSpec in a project (config, VSCode settings, etc.)
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @lssm/core
- **Tags**: cli, setup
- **File**: `packages/bundles/workspace/src/contracts/operations/init.operation.ts`field.route.label/docs/reference/_common/init
referencepublic
field.summary.labelEcho a prompt for the OpenCode CLI example.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @lssm-tech/examples
- **Tags**: opencode, example, echo
- **File**: `packages/examples/opencode-cli/src/contracts/opencode.contracts.ts`field.route.label/docs/reference/_common/opencode.example.echo
referencepublic
field.summary.labelEmitted when a custom benchmark run finishes.
- **Type**: event (event)
- **Version**: 1.0.0
- **Tags**: custom, eval
- **File**: `packages/libs/contracts-spec/src/provider-ranking/events/benchmarkCustomCompleted.event.ts`field.route.label/docs/reference/_common/provider-ranking.benchmark.custom.completed
referencepublic
field.summary.labelTrigger ingestion of external benchmark data from a public source.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Tags**: ingest
- **File**: `packages/libs/contracts-spec/src/provider-ranking/commands/benchmarkIngest.command.ts`field.route.label/docs/reference/_common/provider-ranking.benchmark.ingest
referencepublic
field.summary.labelEmitted after external benchmark data is ingested.
- **Type**: event (event)
- **Version**: 1.0.0
- **Tags**: ingest
- **File**: `packages/libs/contracts-spec/src/provider-ranking/events/benchmarkIngested.event.ts`field.route.label/docs/reference/_common/provider-ranking.benchmark.ingested
referencepublic
field.summary.labelList raw benchmark results with pagination, filterable by source, model, and dimension.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Tags**: results
- **File**: `packages/libs/contracts-spec/src/provider-ranking/queries/benchmarkResultsList.query.ts`field.route.label/docs/reference/_common/provider-ranking.benchmark.results.list
referencepublic
field.summary.labelLaunch a custom benchmark evaluation against a specific model.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Tags**: custom, eval
- **File**: `packages/libs/contracts-spec/src/provider-ranking/commands/benchmarkRunCustom.command.ts`field.route.label/docs/reference/_common/provider-ranking.benchmark.run-custom
referencepublic
field.summary.labelSide-by-side comparison of AI model scores and capabilities.
- **Type**: presentation (presentation)
- **Version**: 1.0.0
- **Tags**: comparison
- **File**: `packages/libs/contracts-spec/src/provider-ranking/presentations/modelComparison.presentation.ts`field.route.label/docs/reference/_common/provider-ranking.model.comparison
referencepublic
field.summary.labelGet detailed profile for a single model including all scores, metadata, cost, and capabilities.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Tags**: model, profile
- **File**: `packages/libs/contracts-spec/src/provider-ranking/queries/modelProfileGet.query.ts`field.route.label/docs/reference/_common/provider-ranking.model.profile.get
referencepublic
field.summary.labelGet ranked list of providers/models with composite scores, filterable by dimension.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Tags**: leaderboard
- **File**: `packages/libs/contracts-spec/src/provider-ranking/queries/providerRankingGet.query.ts`field.route.label/docs/reference/_common/provider-ranking.ranking.get
referencepublic
field.summary.labelRecompute composite rankings from latest benchmark data.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Tags**: refresh
- **File**: `packages/libs/contracts-spec/src/provider-ranking/commands/rankingRefresh.command.ts`field.route.label/docs/reference/_common/provider-ranking.ranking.refresh
referencepublic
field.summary.labelEmitted when composite rankings are recomputed.
- **Type**: event (event)
- **Version**: 1.0.0
- **Tags**: refresh
- **File**: `packages/libs/contracts-spec/src/provider-ranking/events/rankingUpdated.event.ts`field.route.label/docs/reference/_common/provider-ranking.ranking.updated
referencepublic
field.summary.labelBenchmark ingestion, scoring, and ranking for AI providers and models.
- **Type**: capability (capability)
- **Version**: 1.0.0
- **Tags**: system
- **File**: `packages/libs/contracts-spec/src/provider-ranking/capabilities/providerRanking.capability.ts`field.route.label/docs/reference/_common/provider-ranking.system
referencepublic
field.summary.labelRetrieves per-contract verification status for the impact report.
- **Type**: operation (query)
- **Version**: 1.0.0
- **File**: `packages/libs/contracts-spec/src/operations/report/getContractVerificationStatus.ts`field.route.label/docs/reference/_common/report.getContractVerificationStatus
referencepublic
field.summary.labelReal-time messaging primitives for template applications, including conversations, participants, and delivery events.
- **Type**: capability (capability)
- **Version**: 1.0.0
- **Owners**: platform.contractspec-studiofield.route.label/docs/reference/_common/template.messaging.core
referencepublic
field.summary.labelInternationalized recipe browsing, search, and detail operations for template applications.
- **Type**: capability (capability)
- **Version**: 1.0.0
- **Owners**: platform.contractspec-studio
- **Tags**: templates, recipes, i18n, contentfield.route.label/docs/reference/_common/template.recipes.browse
referencepublic
field.summary.labelCreate, read, update, delete, and toggle template tasks with categories and priorities.
- **Type**: capability (capability)
- **Version**: 1.0.0
- **Owners**: platform.contractspec-studio
- **Tags**: templates, todos, productivityfield.route.label/docs/reference/_common/template.todos.crud
referencepublic
field.summary.labelRun tests defined in contract specs
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @lssm/core
- **Tags**: cli, test
- **File**: `packages/bundles/workspace/src/contracts/operations/test.operation.ts`field.route.label/docs/reference/_common/test
referencepublic
field.summary.labelCreate a new user account with the provided email
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @team
- **Tags**: user
- **File**: `packages/examples/minimal/src/contracts/user.ts`field.route.label/docs/reference/_common/user.create
referencepublic
field.summary.labelValidate a contract spec file structure and optionally its implementation
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @lssm/core
- **Tags**: cli, validation
- **File**: `packages/bundles/workspace/src/contracts/operations/validate.operation.ts`field.route.label/docs/reference/_common/validate
referencepublic
field.summary.label> **Goal:** Ship interfaces that are usable by everyone, by default. This spec sets non‑negotiable rules, checklists, and CI gates to meet **WCAG 2.2 AA** (aim for AAA where low‑cost), align with **EN 301 549** (EU), and keep parity on **web (Next.js)** and **mobile (Expo/React Native)**.field.route.label/docs/accessibility_wcag_compliance_specs
referencepublic
field.summary.labelHow to author goal/how/usage DocBlocks close to code.field.route.label/docs/meta/docblocks-process
referencemixed
field.summary.labelAccess file system through ACP.field.route.label/docs/tech/acp/fs/access
referencepublic
field.summary.labelExecute a prompt turn within a session.field.route.label/docs/tech/acp/prompt/turn
referencepublic
field.summary.labelInitialize a new ACP session.field.route.label/docs/tech/acp/session/init
referencepublic
field.summary.labelResume an existing ACP session.field.route.label/docs/tech/acp/session/resume
referencepublic
field.summary.labelStop an ACP session.field.route.label/docs/tech/acp/session/stop
referencepublic
field.summary.labelExecute terminal commands via ACP.field.route.label/docs/tech/acp/terminal/exec
referencepublic
field.summary.labelExecute ACP tool calls.field.route.label/docs/tech/acp/tool/calls
referencepublic
field.summary.labelAgent Client Protocol transport surfaces.field.route.label/docs/tech/acp/transport
referencepublic
field.summary.labelEmitted when approval is required.field.route.label/docs/tech/agent/approval/requested
referencepublic
field.summary.labelResolve an agent approval request.field.route.label/docs/tech/agent/approvals
referencepublic
field.summary.labelList artifacts produced by an agent run.field.route.label/docs/tech/agent/artifacts
referencepublic
field.summary.labelCancel an in-flight agent run.field.route.label/docs/tech/agent/cancel
referencepublic
field.summary.labelBackground agent execution, approvals, and artifacts.field.route.label/docs/tech/agent/execution
referencepublic
field.summary.labelModel-accessible CRUD for agent memory and ephemeral knowledge.field.route.label/docs/tech/agent/memory-tools
referencepublic
field.summary.labelReference ContractSpec operations as agent tools. One contract to many surfaces.field.route.label/docs/tech/agent/operations-as-tools
referencepublic
field.summary.labelSubmit a background agent run.field.route.label/docs/tech/agent/run
referencepublic
field.summary.labelPresentation spec for agent run audit views.field.route.label/docs/tech/agent/run/audit
referencepublic
field.summary.labelEmitted when an agent run completes.field.route.label/docs/tech/agent/run/completed
referencepublic
field.summary.labelEmitted when an agent run fails.field.route.label/docs/tech/agent/run/failed
referencepublic
field.summary.labelForm specification for launching an agent run.field.route.label/docs/tech/agent/run/form
referencepublic
field.summary.labelData view for listing agent runs.field.route.label/docs/tech/agent/run/index
referencepublic
field.summary.labelEmitted when an agent run starts.field.route.label/docs/tech/agent/run/started
referencepublic
field.summary.labelQuery agent run status.field.route.label/docs/tech/agent/status
referencepublic
field.summary.labelDelegate tasks to subagents with streaming and isolated context.field.route.label/docs/tech/agent/subagents
referencepublic
field.summary.labelPatterns for orchestrator-worker, workflow steps, and evaluator loops.field.route.label/docs/tech/agent/workflow-integration
referencepublic
field.summary.labelDescribe a context pack and its sources.field.route.label/docs/tech/context/pack/describe
referencepublic
field.summary.labelSearch and filter context packs and snapshots.field.route.label/docs/tech/context/pack/search
referencepublic
field.summary.labelForm used to search context packs in UI surfaces.field.route.label/docs/tech/context/pack/search-form
referencepublic
field.summary.labelCreate an immutable context snapshot from a pack.field.route.label/docs/tech/context/pack/snapshot
referencepublic
field.summary.labelEmitted when a context snapshot is created.field.route.label/docs/tech/context/snapshot/created
referencepublic
field.summary.labelData view for listing context snapshots.field.route.label/docs/tech/context/snapshot/index
referencepublic
field.summary.labelPresentation spec for snapshot summaries.field.route.label/docs/tech/context/snapshot/presentation
referencepublic
field.summary.labelContext packs, snapshots, and discovery surfaces.field.route.label/docs/tech/context/system
referencepublic
field.summary.labelApp orchestration is split into three explicit layers:field.route.label/docs/tech/contracts/app-config
referencepublic
field.summary.labelCapability specs define what a module provides (operations, events, presentations) and requires (dependencies). They enable bidirectional linking, inheritance, runtime enforcement, and automated validation.field.route.label/docs/tech/contracts/capabilities
referencepublic
field.summary.label`DataViewSpec` is the declarative contract for projecting entities into list/detail/table/grid experiences. Each spec ties to contract operations (`source.primary`, `source.item`) and describes how the UI should present, sort, filter, paginate, and pin records. Host applications use the spec to render UI with shared components (`DataViewRenderer`, `DataViewList`, `DataViewTable`, `DataViewDetail`) while keeping presentation logic in a single source of truth.field.route.label/docs/tech/contracts/data-views
referencepublic
field.summary.labelExampleSpec defines complete, demonstrable ContractSpec applications.field.route.label/docs/tech/contracts/examples
referencepublic
field.summary.labelUse experiments to test alternative workflows, data views, or themes with controlled allocations and measurable outcomes.field.route.label/docs/tech/contracts/experiments
referencepublic
field.summary.labelThis document defines the canonical contracts for declarative forms.field.route.label/docs/tech/contracts/forms
referencepublic
field.summary.labelThe knowledge layer turns unstructured inputs (uploads, email threads,field.route.label/docs/tech/contracts/knowledge
referencepublic
field.summary.labelProvider-backed knowledge syncs Gmail and Google Drive through explicit provider delta and mutation governance evidence.field.route.label/docs/tech/contracts/knowledge-provider-backed
referencepublic
field.summary.label`MigrationSpec` provides a declarative plan for schema/data/validation steps so migrations can be generated, reviewed, and executed safely by tooling. Each spec captures ownership metadata, ordered up/down steps, and optional dependency information. Runtime tooling can consume the spec to run SQL/data scripts with pre/post checks and produce audit logs.field.route.label/docs/tech/contracts/migrations
referencepublic
field.summary.labelGenerate a deterministic OpenAPI document from a OperationSpecRegistry using jsonSchemaForSpec + REST transport metadata.field.route.label/docs/tech/contracts/openapi-export
referencepublic
field.summary.labelThis document explains how operations (OperationSpec) are linked to Presentations (PresentationSpec) via Feature modules.field.route.label/docs/tech/contracts/ops-to-presentation-linking
referencepublic
field.summary.label`PolicySpec` gives a declarative, typed home for access-control logic covering:field.route.label/docs/tech/contracts/policy
referencepublic
field.summary.labelHow PresentationSpec and TransformEngine keep docs/renderers consistent.field.route.label/docs/tech/contracts/presentations
referencepublic
field.summary.label- Always provide `meta.description` (≥ 3 chars) — used by a11y/docs/agents.field.route.label/docs/tech/contracts/presentations-conventions
referencepublic
field.summary.labelConfigure frontend update checks with app defaults and release overrides.field.route.label/docs/tech/contracts/pwa-updates
referencepublic
field.summary.label- `packages/lssm/libs/contracts` defines the contracts core (OperationSpecRegistry, OperationSpec, PresentationSpec, install helpers, REST/MCP adapters, ...).field.route.label/docs/tech/contracts/README
referencepublic
field.summary.labelThe Regenerator daemon observes telemetry, error, and behavior streams, then suggests spec-level changes (not code patches) that can be reviewed and applied through the App Studio.field.route.label/docs/tech/contracts/regenerator
referencepublic
field.summary.labelTelemetry specs describe product analytics in a durable, type-safe way. They reference existing `EventSpec`s (same name/version) but layer on privacy classification, retention, sampling, and anomaly detection so instrumentation stays compliant and observable.field.route.label/docs/tech/contracts/telemetry
referencepublic
field.summary.labelUse `TestSpec` to describe end-to-end scenarios for contracts and workflows. Specs live alongside your contracts and exercise the same OperationSpecRegistry handlers the app uses.field.route.label/docs/tech/contracts/tests
referencepublic
field.summary.label`ThemeSpec` defines a structured, versioned source of truth for design tokens, component variants, and scoped overrides. Use it to describe how tenants or individual users should experience the design system without hand-maintaining ad-hoc theme files. Specs live in `@lssm-tech/lib.contracts-spec`, making them accessible to generators, docs, and runtime tooling.field.route.label/docs/tech/contracts/themes
referencepublic
field.summary.labelConfiguration-as-code conventions for ContractSpec workspaces (`.contractsrc.json`).field.route.label/docs/tech/contracts/workspace-config
referencepublic
field.summary.labelSchema, migrations, dictionary, and read-only query surfaces.field.route.label/docs/tech/database/context
referencepublic
field.summary.labelRetrieve a dictionary entry for a schema field.field.route.label/docs/tech/database/dictionary/get
referencepublic
field.summary.labelList migration history for a database.field.route.label/docs/tech/database/migrations/list
referencepublic
field.summary.labelPerform a governed read-only query via data views.field.route.label/docs/tech/database/query/readonly
referencepublic
field.summary.labelDescribe schemas and models with PII signals.field.route.label/docs/tech/database/schema/describe
referencepublic
field.summary.labelData view for listing schemas and model counts.field.route.label/docs/tech/database/schema/index
referencepublic
field.summary.labelDocument and surface example projects with sandbox support.field.route.label/docs/tech/docs/examples
referencepublic
field.summary.labelGenerate reference docs and metadata from ContractSpecs.field.route.label/docs/tech/docs/generator
howpublic
field.summary.labelPublish generated artifacts to the docs host.field.route.label/docs/tech/docs/publish
howpublic
field.summary.labelResolve any spec into a docs-ready reference payload.field.route.label/docs/tech/docs/reference
referencepublic
field.summary.labelSearch DocBlocks by query, tag, kind, or visibility.field.route.label/docs/tech/docs/search
referencepublic
field.summary.labelHow ContractSpec generates, indexes, and presents documentation.field.route.label/docs/tech/docs/system
referencepublic
field.summary.labelEmitted when a custom benchmark run finishes.field.route.label/docs/tech/provider-ranking/benchmark/custom/completed
referencepublic
field.summary.labelTrigger ingestion of external benchmark data.field.route.label/docs/tech/provider-ranking/benchmark/ingest
referencepublic
field.summary.labelForm specification for triggering benchmark ingestion.field.route.label/docs/tech/provider-ranking/benchmark/ingest/form
referencepublic
field.summary.labelEmitted after external benchmark data is ingested.field.route.label/docs/tech/provider-ranking/benchmark/ingested
referencepublic
field.summary.labelData view for raw benchmark results.field.route.label/docs/tech/provider-ranking/benchmark/results/index
referencepublic
field.summary.labelList raw benchmark results.field.route.label/docs/tech/provider-ranking/benchmark/results/list
referencepublic
field.summary.labelLaunch a custom benchmark evaluation against a model.field.route.label/docs/tech/provider-ranking/benchmark/run-custom
referencepublic
field.summary.labelForm specification for launching custom benchmarks.field.route.label/docs/tech/provider-ranking/benchmark/run-custom/form
referencepublic
field.summary.labelPresentation spec for side-by-side model comparison.field.route.label/docs/tech/provider-ranking/model/comparison
referencepublic
field.summary.labelGet detailed profile for a single model.field.route.label/docs/tech/provider-ranking/model/profile/get
referencepublic
field.summary.labelGet ranked list of providers and models.field.route.label/docs/tech/provider-ranking/ranking/get
referencepublic
field.summary.labelData view for the model leaderboard.field.route.label/docs/tech/provider-ranking/ranking/index
referencepublic
field.summary.labelRecompute composite rankings from latest benchmark data.field.route.label/docs/tech/provider-ranking/ranking/refresh
referencepublic
field.summary.labelEmitted when composite rankings are recomputed.field.route.label/docs/tech/provider-ranking/ranking/updated
referencepublic
field.summary.labelBenchmark ingestion, scoring, and ranking for AI providers and models.field.route.label/docs/tech/provider-ranking/system
referencepublic
field.summary.labelHow the impact report renders per-contract verification status.field.route.label/docs/tech/report/verification-table
howpublic
field.summary.labelWorkflowSpec provides a declarative, versioned format for long-running flows that mix automation and human review, including runtime adapter capabilities/ports for checkpointing, suspend-resume orchestration, and explicit waiting/retry states. Specs stay inside `@lssm-tech/lib.contracts-spec` (`src/workflow/spec.ts`) so the same definition powers runtime execution, documentation, and future generation.field.route.label/docs/tech/workflows/overview
referencepublic
field.summary.labelAI agent management and console capability
- **Type**: capability (capability)
- **Version**: 1.0.0
- **Owners**: platform.core
- **Tags**: agent, ai, console
- **File**: `packages/examples/agent-console/src/agent.capability.ts`field.route.label/docs/reference/agent-console/agent
referencepublic
field.summary.labelAI agent orchestration with tools, runs, and logs management
- **Type**: feature
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @agent-console-team
- **Tags**: ai, agents, orchestration
- **File**: `packages/examples/agent-console/src/agent.feature.ts`field.route.label/docs/reference/agent-console/agent-console
referencepublic
field.summary.labelAssigns a tool to an agent with optional configuration.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @agent-console-team
- **Tags**: agent, tool, assign
- **File**: `packages/examples/agent-console/src/agent/agent.operation.ts`field.route.label/docs/reference/agent-console/agent-console.agent.assignTool
referencepublic
field.summary.labelCreates a new AI agent configuration.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @agent-console-team
- **Tags**: agent, create
- **File**: `packages/examples/agent-console/src/agent/agent.operation.ts`field.route.label/docs/reference/agent-console/agent-console.agent.create
referencepublic
field.summary.labelA new AI agent was configured.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @agent-console-team
- **Tags**: agent, created
- **File**: `packages/examples/agent-console/src/agent/agent.event.ts`field.route.label/docs/reference/agent-console/agent-console.agent.created
referencepublic
field.summary.labelDetailed view of an AI agent with configuration, tools, and recent runs
- **Type**: presentation (presentation)
- **Version**: 1.0.0
- **Owners**: @agent-console-team
- **Tags**: agent, detail
- **File**: `packages/examples/agent-console/src/agent/agent.presentation.ts`field.route.label/docs/reference/agent-console/agent-console.agent.detail
referencepublic
field.summary.labelRetrieves an agent by its ID.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @agent-console-team
- **Tags**: agent, get
- **File**: `packages/examples/agent-console/src/agent/agent.operation.ts`field.route.label/docs/reference/agent-console/agent-console.agent.get
referencepublic
field.summary.labelLists agents for an organization with optional filtering.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @agent-console-team
- **Tags**: agent, list
- **File**: `packages/examples/agent-console/src/agent/agent.operation.ts`field.route.label/docs/reference/agent-console/agent-console.agent.list
referencepublic
field.summary.labelRemoves a tool assignment from an agent.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @agent-console-team
- **Tags**: agent, tool, remove
- **File**: `packages/examples/agent-console/src/agent/agent.operation.ts`field.route.label/docs/reference/agent-console/agent-console.agent.removeTool
referencepublic
field.summary.labelA tool was assigned to an agent.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @agent-console-team
- **Tags**: agent, tool, assigned
- **File**: `packages/examples/agent-console/src/agent/agent.event.ts`field.route.label/docs/reference/agent-console/agent-console.agent.toolAssigned
referencepublic
field.summary.labelA tool was removed from an agent.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @agent-console-team
- **Tags**: agent, tool, removed
- **File**: `packages/examples/agent-console/src/agent/agent.event.ts`field.route.label/docs/reference/agent-console/agent-console.agent.toolRemoved
referencepublic
field.summary.labelUpdates an existing AI agent configuration.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @agent-console-team
- **Tags**: agent, update
- **File**: `packages/examples/agent-console/src/agent/agent.operation.ts`field.route.label/docs/reference/agent-console/agent-console.agent.update
referencepublic
field.summary.labelAn AI agent configuration was updated.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @agent-console-team
- **Tags**: agent, updated
- **File**: `packages/examples/agent-console/src/agent/agent.event.ts`field.route.label/docs/reference/agent-console/agent-console.agent.updated
referencepublic
field.summary.labelList view of AI agents with status, model provider, and version info
- **Type**: presentation (presentation)
- **Version**: 1.0.0
- **Owners**: @agent-console-team
- **Tags**: agent, list, dashboard
- **File**: `packages/examples/agent-console/src/agent/agent.presentation.ts`field.route.label/docs/reference/agent-console/agent-console.agent.viewList
referencepublic
field.summary.labelDashboard overview of AI agents, runs, and tools
- **Type**: presentation (presentation)
- **Version**: 1.0.0
- **Owners**: @agent-console-team
- **Tags**: dashboard, overview
- **File**: `packages/examples/agent-console/src/agent/agent.presentation.ts`field.route.label/docs/reference/agent-console/agent-console.dashboard
referencepublic
field.summary.labelDetailed view of an agent run with steps, logs, and metrics
- **Type**: presentation (presentation)
- **Version**: 1.0.0
- **Owners**: @agent-console-team
- **Tags**: run, detail
- **File**: `packages/examples/agent-console/src/run/run.presentation.ts`field.route.label/docs/reference/agent-console/agent-console.run.detail
referencepublic
field.summary.labelList view of agent runs with status, tokens, and duration info
- **Type**: presentation (presentation)
- **Version**: 1.0.0
- **Owners**: @agent-console-team
- **Tags**: run, list, dashboard
- **File**: `packages/examples/agent-console/src/run/run.presentation.ts`field.route.label/docs/reference/agent-console/agent-console.run.list
referencepublic
field.summary.labelDetailed view of an AI tool with configuration and test panel
- **Type**: presentation (presentation)
- **Version**: 1.0.0
- **Owners**: @agent-console-team
- **Tags**: tool, detail
- **File**: `packages/examples/agent-console/src/tool/tool.presentation.ts`field.route.label/docs/reference/agent-console/agent-console.tool.detail
referencepublic
field.summary.labelList view of AI tools with category, status, and version info
- **Type**: presentation (presentation)
- **Version**: 1.0.0
- **Owners**: @agent-console-team
- **Tags**: tool, list, dashboard
- **File**: `packages/examples/agent-console/src/tool/tool.presentation.ts`field.route.label/docs/reference/agent-console/agent-console.tool.list
referencepublic
field.summary.labelCancels an in-progress agent run.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @agent-console-team
- **Tags**: run, cancel
- **File**: `packages/examples/agent-console/src/run/run.operation.ts`field.route.label/docs/reference/agent-console/agent.run.cancel
referencepublic
field.summary.labelAn agent run was cancelled by the user.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @agent-console-team
- **Tags**: run, cancelled
- **File**: `packages/examples/agent-console/src/run/run.event.ts`field.route.label/docs/reference/agent-console/agent.run.cancelled
referencepublic
field.summary.labelAn agent run completed successfully.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @agent-console-team
- **Tags**: run, completed
- **File**: `packages/examples/agent-console/src/run/run.event.ts`field.route.label/docs/reference/agent-console/agent.run.completed
referencepublic
field.summary.labelStarts a new agent run with the given input.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @agent-console-team
- **Tags**: run, execute
- **File**: `packages/examples/agent-console/src/run/run.operation.ts`field.route.label/docs/reference/agent-console/agent.run.execute
referencepublic
field.summary.labelAn agent run encountered an error.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @agent-console-team
- **Tags**: run, failed
- **File**: `packages/examples/agent-console/src/run/run.event.ts`field.route.label/docs/reference/agent-console/agent.run.failed
referencepublic
field.summary.labelRetrieves a run by its ID with optional details.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @agent-console-team
- **Tags**: run, get
- **File**: `packages/examples/agent-console/src/run/run.operation.ts`field.route.label/docs/reference/agent-console/agent.run.get
referencepublic
field.summary.labelRetrieves all logs for a specific run.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @agent-console-team
- **Tags**: run, logs
- **File**: `packages/examples/agent-console/src/run/run.operation.ts`field.route.label/docs/reference/agent-console/agent.run.getLogs
referencepublic
field.summary.labelRetrieves aggregated metrics for runs within a time period.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @agent-console-team
- **Tags**: run, metrics
- **File**: `packages/examples/agent-console/src/run/run.operation.ts`field.route.label/docs/reference/agent-console/agent.run.getMetrics
referencepublic
field.summary.labelRetrieves all steps for a specific run.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @agent-console-team
- **Tags**: run, steps
- **File**: `packages/examples/agent-console/src/run/run.operation.ts`field.route.label/docs/reference/agent-console/agent.run.getSteps
referencepublic
field.summary.labelLists runs with optional filtering.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @agent-console-team
- **Tags**: run, list
- **File**: `packages/examples/agent-console/src/run/run.operation.ts`field.route.label/docs/reference/agent-console/agent.run.list
referencepublic
field.summary.labelAn agent generated a message during a run.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @agent-console-team
- **Tags**: run, message, generated
- **File**: `packages/examples/agent-console/src/run/run.event.ts`field.route.label/docs/reference/agent-console/agent.run.messageGenerated
referencepublic
field.summary.labelAn agent run was started.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @agent-console-team
- **Tags**: run, started
- **File**: `packages/examples/agent-console/src/run/run.event.ts`field.route.label/docs/reference/agent-console/agent.run.started
referencepublic
field.summary.labelA tool invocation completed during an agent run.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @agent-console-team
- **Tags**: run, tool, completed
- **File**: `packages/examples/agent-console/src/run/run.event.ts`field.route.label/docs/reference/agent-console/agent.run.toolCompleted
referencepublic
field.summary.labelA tool was invoked during an agent run.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @agent-console-team
- **Tags**: run, tool, invoked
- **File**: `packages/examples/agent-console/src/run/run.event.ts`field.route.label/docs/reference/agent-console/agent.run.toolInvoked
referencepublic
field.summary.labelCreates a new AI tool definition.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @agent-console-team
- **Tags**: tool, create
- **File**: `packages/examples/agent-console/src/tool/tool.operation.ts`field.route.label/docs/reference/agent-console/agent.tool.create
referencepublic
field.summary.labelA new AI tool was created.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @agent-console-team
- **Tags**: tool, created
- **File**: `packages/examples/agent-console/src/tool/tool.event.ts`field.route.label/docs/reference/agent-console/agent.tool.created
referencepublic
field.summary.labelRetrieves a tool by its ID.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @agent-console-team
- **Tags**: tool, get
- **File**: `packages/examples/agent-console/src/tool/tool.operation.ts`field.route.label/docs/reference/agent-console/agent.tool.get
referencepublic
field.summary.labelLists tools for an organization with optional filtering.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @agent-console-team
- **Tags**: tool, list
- **File**: `packages/examples/agent-console/src/tool/tool.operation.ts`field.route.label/docs/reference/agent-console/agent.tool.list
referencepublic
field.summary.labelAn AI tool status was changed (activated, deprecated, disabled).
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @agent-console-team
- **Tags**: tool, status
- **File**: `packages/examples/agent-console/src/tool/tool.event.ts`field.route.label/docs/reference/agent-console/agent.tool.statusChanged
referencepublic
field.summary.labelTests a tool with sample input to verify it works correctly.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @agent-console-team
- **Tags**: tool, test
- **File**: `packages/examples/agent-console/src/tool/tool.operation.ts`field.route.label/docs/reference/agent-console/agent.tool.test
referencepublic
field.summary.labelUpdates an existing AI tool definition.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @agent-console-team
- **Tags**: tool, update
- **File**: `packages/examples/agent-console/src/tool/tool.operation.ts`field.route.label/docs/reference/agent-console/agent.tool.update
referencepublic
field.summary.labelAn AI tool configuration was updated.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @agent-console-team
- **Tags**: tool, updated
- **File**: `packages/examples/agent-console/src/tool/tool.event.ts`field.route.label/docs/reference/agent-console/agent.tool.updated
referencepublic
field.summary.labelTest for getting agent
- **Type**: test-spec (test-spec)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @agent-console-team
- **Tags**: test
- **File**: `packages/examples/agent-console/src/agent/agent.test-spec.ts`field.route.label/docs/reference/agent-console/test.agent-console.agent.get
referencepublic
field.summary.labelTest for listing agents
- **Type**: test-spec (test-spec)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @agent-console-team
- **Tags**: test
- **File**: `packages/examples/agent-console/src/agent/agent.test-spec.ts`field.route.label/docs/reference/agent-console/test.agent-console.agent.list
referencepublic
field.summary.labelTest for getting run
- **Type**: test-spec (test-spec)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @agent-console-team
- **Tags**: test
- **File**: `packages/examples/agent-console/src/run/run.test-spec.ts`field.route.label/docs/reference/agent-console/test.agent.run.get
referencepublic
field.summary.labelTest for listing runs
- **Type**: test-spec (test-spec)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @agent-console-team
- **Tags**: test
- **File**: `packages/examples/agent-console/src/run/run.test-spec.ts`field.route.label/docs/reference/agent-console/test.agent.run.list
referencepublic
field.summary.labelTest for getting tool
- **Type**: test-spec (test-spec)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @agent-console-team
- **Tags**: test
- **File**: `packages/examples/agent-console/src/tool/tool.test-spec.ts`field.route.label/docs/reference/agent-console/test.agent.tool.get
referencepublic
field.summary.labelTest for listing tools
- **Type**: test-spec (test-spec)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @agent-console-team
- **Tags**: test
- **File**: `packages/examples/agent-console/src/tool/tool.test-spec.ts`field.route.label/docs/reference/agent-console/test.agent.tool.list
referencepublic
field.summary.labelAI-powered conversational coding assistant with full workspace context
- **Type**: feature
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @platform.ai
- **Tags**: ai, chat, llm, vibe-coding, assistantfield.route.label/docs/reference/ai-chat/ai-chat
referencepublic
field.summary.labelScan workspace context.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @ai-team
- **Tags**: chat, context
- **File**: `packages/modules/ai-chat/src/ai-chat.operations.ts`field.route.label/docs/reference/ai-chat/ai-chat.context.scan
referencepublic
field.summary.labelNew conversation created
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @ai-chat
- **Tags**: ai-chat, conversation, created
- **File**: `packages/modules/ai-chat/src/events.ts`field.route.label/docs/reference/ai-chat/ai-chat.conversation.created
referencepublic
field.summary.labelConversation deleted
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @ai-chat
- **Tags**: ai-chat, conversation, deleted
- **File**: `packages/modules/ai-chat/src/events.ts`field.route.label/docs/reference/ai-chat/ai-chat.conversation.deleted
referencepublic
field.summary.labelDelete a conversation.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @ai-team
- **Tags**: chat, delete
- **File**: `packages/modules/ai-chat/src/ai-chat.operations.ts`field.route.label/docs/reference/ai-chat/ai-chat.conversations.delete
referencepublic
field.summary.labelGet a specific conversation.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @ai-team
- **Tags**: chat, get
- **File**: `packages/modules/ai-chat/src/ai-chat.operations.ts`field.route.label/docs/reference/ai-chat/ai-chat.conversations.get
referencepublic
field.summary.labelList user conversations.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @ai-team
- **Tags**: chat, list
- **File**: `packages/modules/ai-chat/src/ai-chat.operations.ts`field.route.label/docs/reference/ai-chat/ai-chat.conversations.list
referencepublic
field.summary.labelChat error occurred
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @ai-chat
- **Tags**: ai-chat, error
- **File**: `packages/modules/ai-chat/src/events.ts`
```typescript
import { defineEvent } from '@lssm-tech/lib.contracts-spec';field.route.label/docs/reference/ai-chat/ai-chat.error
referencepublic
field.summary.labelMessage received from AI
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @ai-chat
- **Tags**: ai-chat, message, received
- **File**: `packages/modules/ai-chat/src/events.ts`field.route.label/docs/reference/ai-chat/ai-chat.message.received
referencepublic
field.summary.labelMessage sent by user
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @ai-chat
- **Tags**: ai-chat, message, sent
- **File**: `packages/modules/ai-chat/src/events.ts`
```typescriptfield.route.label/docs/reference/ai-chat/ai-chat.message.sent
referencepublic
field.summary.labelList available AI providers.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @ai-team
- **Tags**: chat, providers
- **File**: `packages/modules/ai-chat/src/ai-chat.operations.ts`field.route.label/docs/reference/ai-chat/ai-chat.providers.list
referencepublic
field.summary.labelSend a message to the AI chat.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @ai-team
- **Tags**: chat, send
- **File**: `packages/modules/ai-chat/src/ai-chat.operations.ts`field.route.label/docs/reference/ai-chat/ai-chat.send
referencepublic
field.summary.labelStream a message response from the AI chat.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @ai-team
- **Tags**: chat, stream
- **File**: `packages/modules/ai-chat/src/ai-chat.operations.ts`field.route.label/docs/reference/ai-chat/ai-chat.stream
referencepublic
field.summary.labelFocused assistant example with chat UX and search-backed retrieval.
- **Type**: feature
- **Version**: 1.0.0
- **Stability**: beta
- **Owners**: @platform.core
- **Tags**: ai, chat, assistant, example
- **File**: `packages/examples/ai-chat-assistant/src/ai-chat-assistant.feature.ts`field.route.label/docs/reference/ai-chat-assistant/ai-chat-assistant
referencepublic
field.summary.labelSearch for content within the assistant context.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @example.ai-chat-assistant
- **Tags**: assistant, search, chatfield.route.label/docs/reference/ai-chat-assistant/assistant.search
referencepublic
field.summary.labelAI support ticket classification and resolution using grounded knowledge
- **Type**: feature
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @examples
- **Tags**: ai, support, knowledge, ticketsfield.route.label/docs/reference/ai-support-bot/ai-support-bot
referencepublic
field.summary.labelAnalytics dashboards with customizable widgets and queries
- **Type**: feature
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @analytics-dashboard
- **Tags**: analytics, dashboards, widgets, queriesfield.route.label/docs/reference/analytics-dashboard/analytics-dashboard
referencepublic
field.summary.labelCreate a new analytics dashboard.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @example.analytics-dashboard
- **Tags**: analytics, dashboard, create
- **File**: `packages/examples/analytics-dashboard/src/dashboard/dashboard.operation.ts`field.route.label/docs/reference/analytics-dashboard/analytics.dashboard.create
referencepublic
field.summary.labelVerifies dashboard creation flow
- **Type**: test-spec (test-spec)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @example.analytics-dashboard
- **Tags**: analytics, dashboard, test
- **File**: `packages/examples/analytics-dashboard/src/dashboard/dashboard.test-spec.ts`field.route.label/docs/reference/analytics-dashboard/analytics.dashboard.create.test
referencepublic
field.summary.labelA dashboard was created.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @analytics-team
- **Tags**: dashboard
- **File**: `packages/examples/analytics-dashboard/src/events.ts`field.route.label/docs/reference/analytics-dashboard/analytics.dashboard.created
referencepublic
field.summary.labelEdit dashboard configuration and widgets
- **Type**: presentation (presentation)
- **Version**: 1.0.0
- **Owners**: @analytics-dashboard
- **Tags**: analytics, dashboard, editor
- **File**: `packages/examples/analytics-dashboard/src/dashboard/dashboard.presentation.ts`field.route.label/docs/reference/analytics-dashboard/analytics.dashboard.editor
referencepublic
field.summary.labelGet a dashboard with widgets.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @example.analytics-dashboard
- **Tags**: analytics, dashboard, get
- **File**: `packages/examples/analytics-dashboard/src/dashboard/dashboard.operation.ts`field.route.label/docs/reference/analytics-dashboard/analytics.dashboard.get
referencepublic
field.summary.labelVerifies dashboard retrieval
- **Type**: test-spec (test-spec)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @example.analytics-dashboard
- **Tags**: analytics, dashboard, test
- **File**: `packages/examples/analytics-dashboard/src/dashboard/dashboard.test-spec.ts`field.route.label/docs/reference/analytics-dashboard/analytics.dashboard.get.test
referencepublic
field.summary.labelList dashboards.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @example.analytics-dashboard
- **Tags**: analytics, dashboard, list
- **File**: `packages/examples/analytics-dashboard/src/dashboard/dashboard.operation.ts`field.route.label/docs/reference/analytics-dashboard/analytics.dashboard.list
referencepublic
field.summary.labelVerifies dashboard listing
- **Type**: test-spec (test-spec)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @example.analytics-dashboard
- **Tags**: analytics, dashboard, test
- **File**: `packages/examples/analytics-dashboard/src/dashboard/dashboard.test-spec.ts`field.route.label/docs/reference/analytics-dashboard/analytics.dashboard.list.test
referencepublic
field.summary.labelView a single dashboard with widgets
- **Type**: presentation (presentation)
- **Version**: 1.0.0
- **Owners**: @analytics-dashboard
- **Tags**: analytics, dashboard, view
- **File**: `packages/examples/analytics-dashboard/src/dashboard/dashboard.presentation.ts`field.route.label/docs/reference/analytics-dashboard/analytics.dashboard.view
referencepublic
field.summary.labelList of analytics dashboards
- **Type**: presentation (presentation)
- **Version**: 1.0.0
- **Owners**: @analytics-dashboard
- **Tags**: analytics, dashboards, list
- **File**: `packages/examples/analytics-dashboard/src/dashboard/dashboard.presentation.ts`field.route.label/docs/reference/analytics-dashboard/analytics.dashboard.viewList
referencepublic
field.summary.labelVisual query builder interface
- **Type**: presentation (presentation)
- **Version**: 1.0.0
- **Owners**: @analytics-dashboard
- **Tags**: analytics, query, builder
- **File**: `packages/examples/analytics-dashboard/src/query/query.presentation.ts`field.route.label/docs/reference/analytics-dashboard/analytics.query.builder
referencepublic
field.summary.labelCreate a data query.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @example.analytics-dashboard
- **Tags**: analytics, query, create
- **File**: `packages/examples/analytics-dashboard/src/query/query.operation.ts`field.route.label/docs/reference/analytics-dashboard/analytics.query.create
referencepublic
field.summary.labelVerifies query creation flow
- **Type**: test-spec (test-spec)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @example.analytics-dashboard
- **Tags**: analytics, query, test
- **File**: `packages/examples/analytics-dashboard/src/query/query.test-spec.ts`field.route.label/docs/reference/analytics-dashboard/analytics.query.create.test
referencepublic
field.summary.labelA query was created.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @analytics-team
- **Tags**: dashboard
- **File**: `packages/examples/analytics-dashboard/src/events.ts`field.route.label/docs/reference/analytics-dashboard/analytics.query.created
referencepublic
field.summary.labelExecute a data query.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @example.analytics-dashboard
- **Tags**: analytics, query, execute
- **File**: `packages/examples/analytics-dashboard/src/query/query.operation.ts`field.route.label/docs/reference/analytics-dashboard/analytics.query.execute
referencepublic
field.summary.labelVerifies query execution
- **Type**: test-spec (test-spec)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @example.analytics-dashboard
- **Tags**: analytics, query, test
- **File**: `packages/examples/analytics-dashboard/src/query/query.test-spec.ts`field.route.label/docs/reference/analytics-dashboard/analytics.query.execute.test
referencepublic
field.summary.labelList of saved queries
- **Type**: presentation (presentation)
- **Version**: 1.0.0
- **Owners**: @analytics-dashboard
- **Tags**: analytics, queries, list
- **File**: `packages/examples/analytics-dashboard/src/query/query.presentation.ts`field.route.label/docs/reference/analytics-dashboard/analytics.query.list
referencepublic
field.summary.labelAdd a widget to a dashboard.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @example.analytics-dashboard
- **Tags**: analytics, widget, add
- **File**: `packages/examples/analytics-dashboard/src/dashboard/dashboard.operation.ts`field.route.label/docs/reference/analytics-dashboard/analytics.widget.add
referencepublic
field.summary.labelVerifies adding widget to dashboard
- **Type**: test-spec (test-spec)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @example.analytics-dashboard
- **Tags**: analytics, widget, test
- **File**: `packages/examples/analytics-dashboard/src/dashboard/dashboard.test-spec.ts`field.route.label/docs/reference/analytics-dashboard/analytics.widget.add.test
referencepublic
field.summary.labelA widget was added to a dashboard.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @analytics-team
- **Tags**: dashboard
- **File**: `packages/examples/analytics-dashboard/src/events.ts`field.route.label/docs/reference/analytics-dashboard/analytics.widget.added
referencepublic
field.summary.labelA new tenant config draft was created.
- **Type**: event (event)
- **Version**: 1.0.0
- **File**: `packages/libs/contracts-spec/src/app-config/events.ts`
```typescript
import { ScalarTypeEnum, SchemaModel } from '@lssm-tech/lib.schema';field.route.label/docs/reference/app-config/app_config.draft_created
referencepublic
field.summary.labelA tenant config draft was promoted to preview.
- **Type**: event (event)
- **Version**: 1.0.0
- **File**: `packages/libs/contracts-spec/src/app-config/events.ts`
```typescript
import { ScalarTypeEnum, SchemaModel } from '@lssm-tech/lib.schema';field.route.label/docs/reference/app-config/app_config.promoted_to_preview
referencepublic
field.summary.labelA tenant config version was published to production.
- **Type**: event (event)
- **Version**: 1.0.0
- **File**: `packages/libs/contracts-spec/src/app-config/events.ts`
```typescript
import { ScalarTypeEnum, SchemaModel } from '@lssm-tech/lib.schema';field.route.label/docs/reference/app-config/app_config.published
referencepublic
field.summary.labelA tenant config was rolled back to a previous version.
- **Type**: event (event)
- **Version**: 1.0.0
- **File**: `packages/libs/contracts-spec/src/app-config/events.ts`
```typescript
import { ScalarTypeEnum, SchemaModel } from '@lssm-tech/lib.schema';field.route.label/docs/reference/app-config/app_config.rolled_back
referencepublic
field.summary.labelTenant app configuration lifecycle management with draft, preview, and publish stages
- **Type**: feature
- **Version**: 1.0.0
- **Stability**: beta
- **Owners**: @platform.sigil
- **Tags**: app-config, lifecycle, configuration, tenantfield.route.label/docs/reference/app-config/app-config
referencepublic
field.summary.labelReturns the resolved branding for a tenant/app/environment.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Tags**: branding
- **File**: `packages/libs/contracts-spec/src/app-config/app-config.contracts.ts`field.route.label/docs/reference/app-config/appConfig.getResolvedBranding
referencepublic
field.summary.labelCreates a new draft tenant config version.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Tags**: app-config
- **File**: `packages/libs/contracts-spec/src/app-config/lifecycle-contracts.ts`
Allow operators to start editing a new tenant config version.field.route.label/docs/reference/app-config/appConfig.lifecycle.createDraft
referencepublic
field.summary.labelFetches a single tenant config version by id.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Tags**: app-config
- **File**: `packages/libs/contracts-spec/src/app-config/lifecycle-contracts.ts`
Allow detail drill-down for lifecycle entries.field.route.label/docs/reference/app-config/appConfig.lifecycle.getVersion
referencepublic
field.summary.labelLists all versions of a tenant configuration.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Tags**: app-config
- **File**: `packages/libs/contracts-spec/src/app-config/lifecycle-contracts.ts`
Support lifecycle views and change audit tooling.field.route.label/docs/reference/app-config/appConfig.lifecycle.listVersions
referencepublic
field.summary.labelPromotes a draft tenant config to preview/testing state.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Tags**: app-config
- **File**: `packages/libs/contracts-spec/src/app-config/lifecycle-contracts.ts`field.route.label/docs/reference/app-config/appConfig.lifecycle.promoteToPreview
referencepublic
field.summary.labelPublishes a preview tenant config to production.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Tags**: app-config
- **File**: `packages/libs/contracts-spec/src/app-config/lifecycle-contracts.ts`field.route.label/docs/reference/app-config/appConfig.lifecycle.publish
referencepublic
field.summary.labelRolls back to a previously published tenant config version.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Tags**: app-config
- **File**: `packages/libs/contracts-spec/src/app-config/lifecycle-contracts.ts`field.route.label/docs/reference/app-config/appConfig.lifecycle.rollback
referencepublic
field.summary.labelResolves a translation key for a tenant in the requested locale.
- **Type**: operation (query)
- **Version**: 1.0.0
- **File**: `packages/libs/contracts-spec/src/app-config/app-config.contracts.ts`
Expose a server-side API for resolving message keys on demand.field.route.label/docs/reference/app-config/appConfig.resolveMessage
referencepublic
field.summary.labelRegisters or updates translation entries for a blueprint.
- **Type**: operation (command)
- **Version**: 1.0.0
- **File**: `packages/libs/contracts-spec/src/app-config/app-config.contracts.ts`
Keep blueprint translation catalogs in sync with shipped copy.field.route.label/docs/reference/app-config/appConfig.updateBlueprintTranslationCatalog
referencepublic
field.summary.labelApplies tenant branding overrides (names, assets, domains).
- **Type**: operation (command)
- **Version**: 1.0.0
- **Tags**: branding
- **File**: `packages/libs/contracts-spec/src/app-config/app-config.contracts.ts`field.route.label/docs/reference/app-config/appConfig.updateTenantBranding
referencepublic
field.summary.labelApplies tenant-specific translation entries.
- **Type**: operation (command)
- **Version**: 1.0.0
- **File**: `packages/libs/contracts-spec/src/app-config/app-config.contracts.ts`
Allow tenants to override selected message keys.field.route.label/docs/reference/app-config/appConfig.updateTenantTranslations
referencepublic
field.summary.labelValidates DNS ownership for tenant custom domains.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Tags**: branding
- **File**: `packages/libs/contracts-spec/src/app-config/app-config.contracts.ts`field.route.label/docs/reference/app-config/appConfig.verifyCustomDomain
referencepublic
field.summary.labelBlueprint that surfaces canonical product knowledge to agents and workflows.
- **Type**: app-config (app-config)
- **Version**: 1.0.0
- **Tags**: knowledge, product-canon
- **File**: `packages/examples/knowledge-canon/src/blueprint.ts`field.route.label/docs/reference/artisan.knowledge.product/artisan.knowledge.product
referencepublic
field.summary.labelCurated product knowledge space with blueprint, tenant config, and FAQ workflow
- **Type**: feature
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @examples
- **Tags**: knowledge, canon, faqfield.route.label/docs/reference/artisan.knowledge.product/knowledge-canon
referencepublic
field.summary.labelBlueprint enabling card payments for ArtisanOS merchants via the Stripe integration.
- **Type**: app-config (app-config)
- **Version**: 1.0.0
- **Tags**: stripe, payments
- **File**: `packages/examples/integration-stripe/src/blueprint.ts`field.route.label/docs/reference/artisan.payments.stripe/artisan.payments.stripe
referencepublic
field.summary.labelStripe payments integration with blueprint, workflow, and tenant configuration
- **Type**: feature
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @integration-team
- **Tags**: integration, stripe, paymentsfield.route.label/docs/reference/artisan.payments.stripe/integration-stripe
referencepublic
field.summary.labelIntegration contract for managed or BYOK Stripe card processing.
- **Type**: integration (integration)
- **Version**: 1.0.0
- **Tags**: stripe, payments
- **File**: `packages/examples/integration-stripe/src/integration.ts`field.route.label/docs/reference/artisan.payments.stripe/integration-stripe.integration.psp
referencepublic
field.summary.labelCharge a customer using the tenant Stripe connection and record settlement details.
- **Type**: workflow (workflow)
- **Version**: 1.0.0
- **Tags**: stripe
- **File**: `packages/examples/integration-stripe/src/workflow.ts`field.route.label/docs/reference/artisan.payments.stripe/integration-stripe.workflow.payment
referencepublic
field.summary.labelAudit logging, querying, export, and compliance reporting
- **Type**: feature
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @platform.audit-trail
- **Tags**: audit, compliance, logging, securityfield.route.label/docs/reference/audit-trail/audit-trail
referencepublic
field.summary.labelExport audit logs for compliance reporting.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: platform.audit-trail
- **Tags**: audit, logs, export
- **File**: `packages/modules/audit-trail/src/contracts/index.ts`field.route.label/docs/reference/audit-trail/audit.logs.export
referencepublic
field.summary.labelGet a specific audit log by ID.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: platform.audit-trail
- **Tags**: audit, logs, get
- **File**: `packages/modules/audit-trail/src/contracts/index.ts`field.route.label/docs/reference/audit-trail/audit.logs.get
referencepublic
field.summary.labelQuery audit logs with filters.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: platform.audit-trail
- **Tags**: audit, logs, query
- **File**: `packages/modules/audit-trail/src/contracts/index.ts`field.route.label/docs/reference/audit-trail/audit.logs.query
referencepublic
field.summary.labelGet audit log statistics.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: platform.audit-trail
- **Tags**: audit, stats
- **File**: `packages/modules/audit-trail/src/contracts/index.ts`field.route.label/docs/reference/audit-trail/audit.stats
referencepublic
field.summary.labelGet all audit logs for a trace.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: platform.audit-trail
- **Tags**: audit, trace, get
- **File**: `packages/modules/audit-trail/src/contracts/index.ts`field.route.label/docs/reference/audit-trail/audit.trace.get
referencepublic
field.summary.labelGoogle Calendar integration with OAuth, event listing, and sync
- **Type**: feature
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @examples
- **Tags**: calendar, google, integration, oauthfield.route.label/docs/reference/calendar-google/calendar-google
referencepublic
field.summary.labelAI content generation for blog posts, landing pages, emails, and social media
- **Type**: feature
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @examples
- **Tags**: content, ai, generationfield.route.label/docs/reference/content-generation/content-generation
referencepublic
field.summary.labelCanonical generated feature reference:
- `generated/docs/platform.control-plane/platform.control-plane.md`
Canonical generated operation references:
- `generated/docs/platform.control-plane/controlPlane.intent.submit.md`field.route.label/docs/reference/control-plane/control-plane
referencepublic
field.summary.labelThis directory exists to satisfy the implementation-plan path `generated/docs/control-plane/`.
The canonical generated control-plane reference docs currently live under:
- `generated/docs/platform.control-plane/`field.route.label/docs/reference/control-plane/README
referencepublic
field.summary.labelA new contact has been created.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @crm-team
- **Tags**: contact, created
- **File**: `packages/examples/crm-pipeline/src/events/contact.event.ts`field.route.label/docs/reference/crm-pipeline/contact.created
referencepublic
field.summary.labelCRM and sales pipeline management with deals, contacts, and companies
- **Type**: feature
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @crm-team
- **Tags**: crm, sales, pipeline, deals
- **File**: `packages/examples/crm-pipeline/src/crm-pipeline.feature.ts`field.route.label/docs/reference/crm-pipeline/crm-pipeline
referencepublic
field.summary.labelMain CRM dashboard with pipeline overview, deal stats, and activities
- **Type**: presentation (presentation)
- **Version**: 1.0.0
- **Owners**: @crm-team
- **Tags**: dashboard, overview
- **File**: `packages/examples/crm-pipeline/src/presentations/dashboard.presentation.ts`field.route.label/docs/reference/crm-pipeline/crm.dashboard
referencepublic
field.summary.labelCompact deal card for kanban board display
- **Type**: presentation (presentation)
- **Version**: 1.0.0
- **Owners**: @crm-team
- **Tags**: deal, card, kanban
- **File**: `packages/examples/crm-pipeline/src/presentations/pipeline.presentation.ts`field.route.label/docs/reference/crm-pipeline/crm.deal.card
referencepublic
field.summary.labelCreate a new deal in the pipeline.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @example.crm-pipeline
- **Tags**: crm, deal, create
- **File**: `packages/examples/crm-pipeline/src/deal/deal.operation.ts`field.route.label/docs/reference/crm-pipeline/crm.deal.create
referencepublic
field.summary.labelDetailed view of a deal with activities, contacts, and history
- **Type**: presentation (presentation)
- **Version**: 1.0.0
- **Owners**: @crm-team
- **Tags**: deal, detail
- **File**: `packages/examples/crm-pipeline/src/presentations/pipeline.presentation.ts`field.route.label/docs/reference/crm-pipeline/crm.deal.detail
referencepublic
field.summary.labelList deals with filters.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @example.crm-pipeline
- **Tags**: crm, deal, list
- **File**: `packages/examples/crm-pipeline/src/deal/deal.operation.ts`field.route.label/docs/reference/crm-pipeline/crm.deal.list
referencepublic
field.summary.labelMark a deal as lost.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @example.crm-pipeline
- **Tags**: crm, deal, lost
- **File**: `packages/examples/crm-pipeline/src/deal/deal.operation.ts`field.route.label/docs/reference/crm-pipeline/crm.deal.lose
referencepublic
field.summary.labelMove a deal to a different stage.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @example.crm-pipeline
- **Tags**: crm, deal, move, kanban
- **File**: `packages/examples/crm-pipeline/src/deal/deal.operation.ts`field.route.label/docs/reference/crm-pipeline/crm.deal.move
referencepublic
field.summary.labelList view of deals with value, status, and owner info
- **Type**: presentation (presentation)
- **Version**: 1.0.0
- **Owners**: @crm-team
- **Tags**: deal, list
- **File**: `packages/examples/crm-pipeline/src/presentations/pipeline.presentation.ts`field.route.label/docs/reference/crm-pipeline/crm.deal.viewList
referencepublic
field.summary.labelMark a deal as won.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @example.crm-pipeline
- **Tags**: crm, deal, won
- **File**: `packages/examples/crm-pipeline/src/deal/deal.operation.ts`field.route.label/docs/reference/crm-pipeline/crm.deal.win
referencepublic
field.summary.labelKanban board view of deals organized by stage
- **Type**: presentation (presentation)
- **Version**: 1.0.0
- **Owners**: @crm-team
- **Tags**: pipeline, kanban, deals
- **File**: `packages/examples/crm-pipeline/src/presentations/pipeline.presentation.ts`field.route.label/docs/reference/crm-pipeline/crm.pipeline.kanban
referencepublic
field.summary.labelPipeline metrics and forecasting view
- **Type**: presentation (presentation)
- **Version**: 1.0.0
- **Owners**: @crm-team
- **Tags**: pipeline, metrics, forecast
- **File**: `packages/examples/crm-pipeline/src/presentations/dashboard.presentation.ts`field.route.label/docs/reference/crm-pipeline/crm.pipeline.metrics
referencepublic
field.summary.labelA new deal has been created.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @crm-team
- **Tags**: deal, created
- **File**: `packages/examples/crm-pipeline/src/events/deal.event.ts`field.route.label/docs/reference/crm-pipeline/deal.created
referencepublic
field.summary.labelA deal has been lost.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @crm-team
- **Tags**: deal, lost
- **File**: `packages/examples/crm-pipeline/src/events/deal.event.ts`field.route.label/docs/reference/crm-pipeline/deal.lost
referencepublic
field.summary.labelA deal has been moved to a different stage.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @crm-team
- **Tags**: deal, moved
- **File**: `packages/examples/crm-pipeline/src/events/deal.event.ts`field.route.label/docs/reference/crm-pipeline/deal.moved
referencepublic
field.summary.labelA deal has been won.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @crm-team
- **Tags**: deal, won
- **File**: `packages/examples/crm-pipeline/src/events/deal.event.ts`field.route.label/docs/reference/crm-pipeline/deal.won
referencepublic
field.summary.labelA task has been completed.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @crm-team
- **Tags**: task, lifecycle
- **File**: `packages/examples/crm-pipeline/src/events/task.event.ts`field.route.label/docs/reference/crm-pipeline/task.completed
referencepublic
field.summary.labelTest for listing deals
- **Type**: test-spec (test-spec)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @example.crm-pipeline
- **Tags**: test
- **File**: `packages/examples/crm-pipeline/src/deal/deal.test-spec.ts`field.route.label/docs/reference/crm-pipeline/test.crm.deal.list
referencepublic
field.summary.labelTest for moving deal
- **Type**: test-spec (test-spec)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @example.crm-pipeline
- **Tags**: test
- **File**: `packages/examples/crm-pipeline/src/deal/deal.test-spec.ts`field.route.label/docs/reference/crm-pipeline/test.crm.deal.move
referencepublic
field.summary.labelCanonical ContractSpec table example spanning contracts-spec, ui-kit, ui-kit-web, and design-system surfaces.
- **Type**: feature
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @platform.corefield.route.label/docs/reference/data-grid-showcase/data-grid-showcase
referencepublic
field.summary.labelLists the demo rows used by the data-grid showcase.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @platform.core
- **Tags**: examples, table, data-grid
- **File**: `packages/examples/data-grid-showcase/src/contracts/data-grid-showcase.operation.ts`field.route.label/docs/reference/data-grid-showcase/examples.data-grid-showcase.rows.list
referencepublic
field.summary.labelDeclarative DataViewSpec for the ContractSpec table showcase.
- **Type**: data-view (data-view)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @platform.core
- **Tags**: examples, table, data-gridfield.route.label/docs/reference/data-grid-showcase/examples.data-grid-showcase.table
referencepublic
field.summary.labelExampleSpec is a contract for defining complete, demonstrable ContractSpec applications. Examples integrate with AppBlueprintSpec and FeatureModuleSpec to provide a full application specification.
An `ExampleSpec` captures:field.route.label/docs/reference/defineExample/docs.tech.contracts.examples
referencepublic
field.summary.labelGmail integration with OAuth, inbound thread reading, and outbound messaging
- **Type**: feature
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @examples
- **Tags**: email, gmail, integration, oauthfield.route.label/docs/reference/email-gmail/email-gmail
referencepublic
field.summary.labelCreate an A/B test experiment.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: platform.feature-flags
- **Tags**: feature-flags, experiment, create
- **File**: `packages/libs/feature-flags/src/contracts/index.ts`field.route.label/docs/reference/feature-flags/experiment.create
referencepublic
field.summary.labelAn experiment has been created.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @platform.feature-flags
- **Tags**: feature-flags, experiment, create
- **File**: `packages/libs/feature-flags/src/events.ts`field.route.label/docs/reference/feature-flags/experiment.created
referencepublic
field.summary.labelGet experiment details.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: platform.feature-flags
- **Tags**: feature-flags, experiment, get
- **File**: `packages/libs/feature-flags/src/contracts/index.ts`field.route.label/docs/reference/feature-flags/experiment.get
referencepublic
field.summary.labelStart an experiment.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: platform.feature-flags
- **Tags**: feature-flags, experiment, start
- **File**: `packages/libs/feature-flags/src/contracts/index.ts`field.route.label/docs/reference/feature-flags/experiment.start
referencepublic
field.summary.labelAn experiment has started.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @platform.feature-flags
- **Tags**: feature-flags, experiment, start
- **File**: `packages/libs/feature-flags/src/events.ts`field.route.label/docs/reference/feature-flags/experiment.started
referencepublic
field.summary.labelStop an experiment.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: platform.feature-flags
- **Tags**: feature-flags, experiment, stop
- **File**: `packages/libs/feature-flags/src/contracts/index.ts`field.route.label/docs/reference/feature-flags/experiment.stop
referencepublic
field.summary.labelAn experiment has stopped.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @platform.feature-flags
- **Tags**: feature-flags, experiment, stop
- **File**: `packages/libs/feature-flags/src/events.ts`field.route.label/docs/reference/feature-flags/experiment.stopped
referencepublic
field.summary.labelA subject has been assigned to an experiment variant.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @platform.feature-flags
- **Tags**: feature-flags, experiment, variantfield.route.label/docs/reference/feature-flags/experiment.variant_assigned
referencepublic
field.summary.labelA/B testing and experimentation platform
- **Type**: capability (capability)
- **Version**: 1.0.0
- **Owners**: @platform.featureflags
- **Tags**: experiments, ab-testing
- **File**: `packages/libs/feature-flags/src/feature-flags.capability.ts`field.route.label/docs/reference/feature-flags/experiments
referencepublic
field.summary.labelFeature flag management and evaluation
- **Type**: capability (capability)
- **Version**: 1.0.0
- **Owners**: @platform.featureflags
- **Tags**: feature-flags, configuration
- **File**: `packages/libs/feature-flags/src/feature-flags.capability.ts`field.route.label/docs/reference/feature-flags/feature-flag
referencepublic
field.summary.labelFeature flag management with targeting rules and A/B experiments
- **Type**: feature
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @platform.feature-flags
- **Tags**: feature-flags, experiments, targetingfield.route.label/docs/reference/feature-flags/feature-flags
referencepublic
field.summary.labelCreate a new feature flag.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: platform.feature-flags
- **Tags**: feature-flags, create
- **File**: `packages/libs/feature-flags/src/contracts/index.ts`field.route.label/docs/reference/feature-flags/flag.create
referencepublic
field.summary.labelA feature flag has been created.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @platform.feature-flags
- **Tags**: feature-flags, create
- **File**: `packages/libs/feature-flags/src/events.ts`field.route.label/docs/reference/feature-flags/flag.created
referencepublic
field.summary.labelDelete a feature flag.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: platform.feature-flags
- **Tags**: feature-flags, delete
- **File**: `packages/libs/feature-flags/src/contracts/index.ts`field.route.label/docs/reference/feature-flags/flag.delete
referencepublic
field.summary.labelA feature flag has been deleted.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @platform.feature-flags
- **Tags**: feature-flags, delete
- **File**: `packages/libs/feature-flags/src/events.ts`field.route.label/docs/reference/feature-flags/flag.deleted
referencepublic
field.summary.labelEvaluate a feature flag for a given context.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: platform.feature-flags
- **Tags**: feature-flags, evaluate
- **File**: `packages/libs/feature-flags/src/contracts/index.ts`field.route.label/docs/reference/feature-flags/flag.evaluate
referencepublic
field.summary.labelA feature flag has been evaluated.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @platform.feature-flags
- **Tags**: feature-flags, evaluate
- **File**: `packages/libs/feature-flags/src/events.ts`field.route.label/docs/reference/feature-flags/flag.evaluated
referencepublic
field.summary.labelGet a feature flag by key.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: platform.feature-flags
- **Tags**: feature-flags, get
- **File**: `packages/libs/feature-flags/src/contracts/index.ts`field.route.label/docs/reference/feature-flags/flag.get
referencepublic
field.summary.labelList all feature flags.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: platform.feature-flags
- **Tags**: feature-flags, list
- **File**: `packages/libs/feature-flags/src/contracts/index.ts`field.route.label/docs/reference/feature-flags/flag.list
referencepublic
field.summary.labelA targeting rule has been created.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @platform.feature-flags
- **Tags**: feature-flags, rule, create
- **File**: `packages/libs/feature-flags/src/events.ts`field.route.label/docs/reference/feature-flags/flag.rule_created
referencepublic
field.summary.labelA targeting rule has been deleted.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @platform.feature-flags
- **Tags**: feature-flags, rule, delete
- **File**: `packages/libs/feature-flags/src/events.ts`field.route.label/docs/reference/feature-flags/flag.rule_deleted
referencepublic
field.summary.labelCreate a targeting rule for a flag.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: platform.feature-flags
- **Tags**: feature-flags, rule, create
- **File**: `packages/libs/feature-flags/src/contracts/index.ts`field.route.label/docs/reference/feature-flags/flag.rule.create
referencepublic
field.summary.labelDelete a targeting rule.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: platform.feature-flags
- **Tags**: feature-flags, rule, delete
- **File**: `packages/libs/feature-flags/src/contracts/index.ts`field.route.label/docs/reference/feature-flags/flag.rule.delete
referencepublic
field.summary.labelToggle a feature flag status.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: platform.feature-flags
- **Tags**: feature-flags, toggle
- **File**: `packages/libs/feature-flags/src/contracts/index.ts`field.route.label/docs/reference/feature-flags/flag.toggle
referencepublic
field.summary.labelA feature flag status has been toggled.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @platform.feature-flags
- **Tags**: feature-flags, toggle
- **File**: `packages/libs/feature-flags/src/events.ts`field.route.label/docs/reference/feature-flags/flag.toggled
referencepublic
field.summary.labelUpdate an existing feature flag.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: platform.feature-flags
- **Tags**: feature-flags, update
- **File**: `packages/libs/feature-flags/src/contracts/index.ts`field.route.label/docs/reference/feature-flags/flag.update
referencepublic
field.summary.labelA feature flag has been updated.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @platform.feature-flags
- **Tags**: feature-flags, update
- **File**: `packages/libs/feature-flags/src/events.ts`field.route.label/docs/reference/feature-flags/flag.updated
referencepublic
field.summary.labelAttach a file to an entity.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: platform.files
- **Tags**: files, attachment, attach
- **File**: `packages/libs/files/src/contracts/index.ts`field.route.label/docs/reference/files/attachment.attach
referencepublic
field.summary.labelA file has been attached to an entity.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @platform.files
- **Tags**: files, attachment, attach
- **File**: `packages/libs/files/src/events.ts`field.route.label/docs/reference/files/attachment.attached
referencepublic
field.summary.labelDetach a file from an entity.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: platform.files
- **Tags**: files, attachment, detach
- **File**: `packages/libs/files/src/contracts/index.ts`field.route.label/docs/reference/files/attachment.detach
referencepublic
field.summary.labelA file has been detached from an entity.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @platform.files
- **Tags**: files, attachment, detach
- **File**: `packages/libs/files/src/events.ts`field.route.label/docs/reference/files/attachment.detached
referencepublic
field.summary.labelList attachments for an entity.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: platform.files
- **Tags**: files, attachment, list
- **File**: `packages/libs/files/src/contracts/index.ts`field.route.label/docs/reference/files/attachment.list
referencepublic
field.summary.labelFile attachments for entities
- **Type**: capability (capability)
- **Version**: 1.0.0
- **Owners**: @platform.core
- **Tags**: attachments, files
- **File**: `packages/libs/files/src/files.capability.ts`
```typescriptfield.route.label/docs/reference/files/attachments
referencepublic
field.summary.labelDelete a file.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: platform.files
- **Tags**: files, delete
- **File**: `packages/libs/files/src/contracts/index.ts`
Remove a file and all its versions and attachments.field.route.label/docs/reference/files/file.delete
referencepublic
field.summary.labelA file has been deleted.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @platform.files
- **Tags**: files, delete
- **File**: `packages/libs/files/src/events.ts`
```typescriptfield.route.label/docs/reference/files/file.deleted
referencepublic
field.summary.labelGet a presigned download URL.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: platform.files
- **Tags**: files, download
- **File**: `packages/libs/files/src/contracts/index.ts`field.route.label/docs/reference/files/file.downloadUrl
referencepublic
field.summary.labelGet a file by ID.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: platform.files
- **Tags**: files, get
- **File**: `packages/libs/files/src/contracts/index.ts`
Retrieve file metadata.field.route.label/docs/reference/files/file.get
referencepublic
field.summary.labelList files with filtering.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: platform.files
- **Tags**: files, list
- **File**: `packages/libs/files/src/contracts/index.ts`field.route.label/docs/reference/files/file.list
referencepublic
field.summary.labelCreate a presigned URL for direct upload.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: platform.files
- **Tags**: files, presigned, upload
- **File**: `packages/libs/files/src/contracts/index.ts`field.route.label/docs/reference/files/file.presignedUrl.create
referencepublic
field.summary.labelUpdate file metadata.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: platform.files
- **Tags**: files, update
- **File**: `packages/libs/files/src/contracts/index.ts`field.route.label/docs/reference/files/file.update
referencepublic
field.summary.labelA file has been updated.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @platform.files
- **Tags**: files, update
- **File**: `packages/libs/files/src/events.ts`
```typescriptfield.route.label/docs/reference/files/file.updated
referencepublic
field.summary.labelUpload a new file.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: platform.files
- **Tags**: files, upload
- **File**: `packages/libs/files/src/contracts/index.ts`field.route.label/docs/reference/files/file.upload
referencepublic
field.summary.labelA file has been uploaded.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @platform.files
- **Tags**: files, upload
- **File**: `packages/libs/files/src/events.ts`
```typescriptfield.route.label/docs/reference/files/file.uploaded
referencepublic
field.summary.labelA new file version has been created.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @platform.files
- **Tags**: files, version, create
- **File**: `packages/libs/files/src/events.ts`field.route.label/docs/reference/files/file.version_created
referencepublic
field.summary.labelCreate a new version of a file.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: platform.files
- **Tags**: files, version, create
- **File**: `packages/libs/files/src/contracts/index.ts`field.route.label/docs/reference/files/file.version.create
referencepublic
field.summary.labelGet file version history.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: platform.files
- **Tags**: files, version, list
- **File**: `packages/libs/files/src/contracts/index.ts`field.route.label/docs/reference/files/file.version.list
referencepublic
field.summary.labelFile storage, attachments, and media processing with presigned URLs
- **Type**: feature
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @platform.files
- **Tags**: files, upload, attachments, storagefield.route.label/docs/reference/files/files
referencepublic
field.summary.labelAn upload session has completed.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @platform.files
- **Tags**: files, upload, session, complete
- **File**: `packages/libs/files/src/events.ts`field.route.label/docs/reference/files/upload.session_completed
referencepublic
field.summary.labelAn upload session has started.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @platform.files
- **Tags**: files, upload, session, start
- **File**: `packages/libs/files/src/events.ts`field.route.label/docs/reference/files/upload.session_started
referencepublic
field.summary.labelFocused harness example for deterministic sandbox and browser evaluation flows.
- **Type**: feature
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @examples
- **Tags**: harness, runtime, evaluationfield.route.label/docs/reference/harness-lab/harness-lab
referencepublic
field.summary.labelUnified health and wearable data sync for activities, workouts, sleep, biometrics, nutrition, and webhooks.
- **Type**: feature
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @platform.integrationsfield.route.label/docs/reference/health/health
referencepublic
field.summary.labelList normalized activity entries synced from health integrations.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @platform.integrations
- **Tags**: health, activities, wearablesfield.route.label/docs/reference/health/health.activities.list
referencepublic
field.summary.labelSynchronize activity entries from the configured health provider.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @platform.integrations
- **Tags**: health, activities, wearablesfield.route.label/docs/reference/health/health.activities.sync
referencepublic
field.summary.labelList normalized biometrics synced from connected health providers.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @platform.integrations
- **Tags**: health, biometrics, wearablesfield.route.label/docs/reference/health/health.biometrics.list
referencepublic
field.summary.labelSynchronize biometric datapoints from provider sources.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @platform.integrations
- **Tags**: health, biometrics, wearablesfield.route.label/docs/reference/health/health.biometrics.sync
referencepublic
field.summary.labelList normalized nutrition and hydration records from connected providers.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @platform.integrations
- **Tags**: health, nutrition, wearablesfield.route.label/docs/reference/health/health.nutrition.list
referencepublic
field.summary.labelSynchronize nutrition records from provider sources.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @platform.integrations
- **Tags**: health, nutrition, wearablesfield.route.label/docs/reference/health/health.nutrition.sync
referencepublic
field.summary.labelList normalized sleep intervals synced from health providers.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @platform.integrations
- **Tags**: health, sleep, wearablesfield.route.label/docs/reference/health/health.sleep.list
referencepublic
field.summary.labelSynchronize sleep intervals from connected providers.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @platform.integrations
- **Tags**: health, sleep, wearablesfield.route.label/docs/reference/health/health.sleep.sync
referencepublic
field.summary.labelIngest and normalize health provider webhook payloads.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @platform.integrations
- **Tags**: health, webhooks, integrationsfield.route.label/docs/reference/health/health.webhooks.ingest
referencepublic
field.summary.labelList normalized workout entries synced from health integrations.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @platform.integrations
- **Tags**: health, workouts, wearablesfield.route.label/docs/reference/health/health.workouts.list
referencepublic
field.summary.labelSynchronize workouts from configured health providers.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @platform.integrations
- **Tags**: health, workouts, wearablesfield.route.label/docs/reference/health/health.workouts.sync
referencepublic
field.summary.labelUser identity and authentication
- **Type**: capability (capability)
- **Version**: 1.0.0
- **Owners**: @platform.core
- **Tags**: identity, auth
- **File**: `packages/libs/identity-rbac/src/identity-rbac.capability.ts`field.route.label/docs/reference/identity-rbac/identity
referencepublic
field.summary.labelUser identity, organization management, and role-based access control
- **Type**: feature
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @platform.identity-rbac
- **Tags**: identity, rbac, users, organizations, permissionsfield.route.label/docs/reference/identity-rbac/identity-rbac
referencepublic
field.summary.labelCreate a new organization.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: platform.identity-rbac
- **Tags**: identity, org, create
- **File**: `packages/libs/identity-rbac/src/contracts/organization.ts`field.route.label/docs/reference/identity-rbac/identity.org.create
referencepublic
field.summary.labelGet organization details.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: platform.identity-rbac
- **Tags**: identity, org, get
- **File**: `packages/libs/identity-rbac/src/contracts/organization.ts`field.route.label/docs/reference/identity-rbac/identity.org.get
referencepublic
field.summary.labelInvite a user to join the organization.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: platform.identity-rbac
- **Tags**: identity, org, invite, member
- **File**: `packages/libs/identity-rbac/src/contracts/organization.ts`field.route.label/docs/reference/identity-rbac/identity.org.invite
referencepublic
field.summary.labelAccept an organization invitation.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: platform.identity-rbac
- **Tags**: identity, org, invite, accept
- **File**: `packages/libs/identity-rbac/src/contracts/organization.ts`field.route.label/docs/reference/identity-rbac/identity.org.invite.accept
referencepublic
field.summary.labelList organizations the current user belongs to.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: platform.identity-rbac
- **Tags**: identity, org, list
- **File**: `packages/libs/identity-rbac/src/contracts/organization.ts`field.route.label/docs/reference/identity-rbac/identity.org.list
referencepublic
field.summary.labelRemove a member from the organization.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: platform.identity-rbac
- **Tags**: identity, org, member, remove
- **File**: `packages/libs/identity-rbac/src/contracts/organization.ts`field.route.label/docs/reference/identity-rbac/identity.org.member.remove
referencepublic
field.summary.labelList organization members.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: platform.identity-rbac
- **Tags**: identity, org, member, list
- **File**: `packages/libs/identity-rbac/src/contracts/organization.ts`field.route.label/docs/reference/identity-rbac/identity.org.members.list
referencepublic
field.summary.labelUpdate organization details.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: platform.identity-rbac
- **Tags**: identity, org, update
- **File**: `packages/libs/identity-rbac/src/contracts/organization.ts`field.route.label/docs/reference/identity-rbac/identity.org.update
referencepublic
field.summary.labelAssign a role to a user or organization.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @platform.identity-rbac
- **Tags**: identity, rbac, assign
- **File**: `packages/libs/identity-rbac/src/contracts/rbac.ts`field.route.label/docs/reference/identity-rbac/identity.rbac.assign
referencepublic
field.summary.labelCheck if a user has a specific permission.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @platform.identity-rbac
- **Tags**: identity, rbac, check, permission
- **File**: `packages/libs/identity-rbac/src/contracts/rbac.ts`field.route.label/docs/reference/identity-rbac/identity.rbac.check
referencepublic
field.summary.labelList all permissions for a user in a context.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @platform.identity-rbac
- **Tags**: identity, rbac, permissions, user
- **File**: `packages/libs/identity-rbac/src/contracts/rbac.ts`field.route.label/docs/reference/identity-rbac/identity.rbac.permissions
referencepublic
field.summary.labelRevoke a role from a user or organization.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @platform.identity-rbac
- **Tags**: identity, rbac, revoke
- **File**: `packages/libs/identity-rbac/src/contracts/rbac.ts`field.route.label/docs/reference/identity-rbac/identity.rbac.revoke
referencepublic
field.summary.labelCreate a new role with permissions.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @platform.identity-rbac
- **Tags**: identity, rbac, role, create
- **File**: `packages/libs/identity-rbac/src/contracts/rbac.ts`field.route.label/docs/reference/identity-rbac/identity.rbac.role.create
referencepublic
field.summary.labelDelete an existing role.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @platform.identity-rbac
- **Tags**: identity, rbac, role, delete
- **File**: `packages/libs/identity-rbac/src/contracts/rbac.ts`field.route.label/docs/reference/identity-rbac/identity.rbac.role.delete
referencepublic
field.summary.labelList all available roles.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @platform.identity-rbac
- **Tags**: identity, rbac, role, list
- **File**: `packages/libs/identity-rbac/src/contracts/rbac.ts`field.route.label/docs/reference/identity-rbac/identity.rbac.role.list
referencepublic
field.summary.labelUpdate an existing role.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @platform.identity-rbac
- **Tags**: identity, rbac, role, update
- **File**: `packages/libs/identity-rbac/src/contracts/rbac.ts`field.route.label/docs/reference/identity-rbac/identity.rbac.role.update
referencepublic
field.summary.labelCreate a new user account.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: platform.identity-rbac
- **Tags**: identity, user, create
- **File**: `packages/libs/identity-rbac/src/contracts/user.ts`field.route.label/docs/reference/identity-rbac/identity.user.create
referencepublic
field.summary.labelDelete user account and all associated data.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: platform.identity-rbac
- **Tags**: identity, user, delete
- **File**: `packages/libs/identity-rbac/src/contracts/user.ts`field.route.label/docs/reference/identity-rbac/identity.user.delete
referencepublic
field.summary.labelList all users (admin only).
- **Type**: operation (query)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: platform.identity-rbac
- **Tags**: identity, user, admin, list
- **File**: `packages/libs/identity-rbac/src/contracts/user.ts`field.route.label/docs/reference/identity-rbac/identity.user.list
referencepublic
field.summary.labelGet the current authenticated user profile.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: platform.identity-rbac
- **Tags**: identity, user, profile
- **File**: `packages/libs/identity-rbac/src/contracts/user.ts`field.route.label/docs/reference/identity-rbac/identity.user.me
referencepublic
field.summary.labelUpdate user profile information.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: platform.identity-rbac
- **Tags**: identity, user, update
- **File**: `packages/libs/identity-rbac/src/contracts/user.ts`field.route.label/docs/reference/identity-rbac/identity.user.update
referencepublic
field.summary.labelA new organization has been created.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @platform.identity-rbac
- **Tags**: org, created, identity
- **File**: `packages/libs/identity-rbac/src/events.ts`field.route.label/docs/reference/identity-rbac/org.created
referencepublic
field.summary.labelAn organization has been deleted.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @platform.identity-rbac
- **Tags**: org, deleted, identity
- **File**: `packages/libs/identity-rbac/src/events.ts`field.route.label/docs/reference/identity-rbac/org.deleted
referencepublic
field.summary.labelAn invitation has been accepted.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @platform.identity-rbac
- **Tags**: org, invite, accepted, identity
- **File**: `packages/libs/identity-rbac/src/events.ts`field.route.label/docs/reference/identity-rbac/org.invite.accepted
referencepublic
field.summary.labelAn invitation has been declined.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @platform.identity-rbac
- **Tags**: org, invite, declined, identity
- **File**: `packages/libs/identity-rbac/src/events.ts`field.route.label/docs/reference/identity-rbac/org.invite.declined
referencepublic
field.summary.labelAn invitation to join an organization has been sent.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @platform.identity-rbac
- **Tags**: org, invite, sent, identity
- **File**: `packages/libs/identity-rbac/src/events.ts`field.route.label/docs/reference/identity-rbac/org.invite.sent
referencepublic
field.summary.labelA user has joined an organization.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @platform.identity-rbac
- **Tags**: org, member, added, identity
- **File**: `packages/libs/identity-rbac/src/events.ts`field.route.label/docs/reference/identity-rbac/org.member.added
referencepublic
field.summary.labelA user has left or been removed from an organization.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @platform.identity-rbac
- **Tags**: org, member, removed, identity
- **File**: `packages/libs/identity-rbac/src/events.ts`field.route.label/docs/reference/identity-rbac/org.member.removed
referencepublic
field.summary.labelA member
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @platform.identity-rbac
- **Tags**: org, member, role, changed, identity
- **File**: `packages/libs/identity-rbac/src/events.ts`field.route.label/docs/reference/identity-rbac/org.member.role_changed
referencepublic
field.summary.labelAn organization has been updated.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @platform.identity-rbac
- **Tags**: org, updated, identity
- **File**: `packages/libs/identity-rbac/src/events.ts`field.route.label/docs/reference/identity-rbac/org.updated
referencepublic
field.summary.labelRole-based access control
- **Type**: capability (capability)
- **Version**: 1.0.0
- **Owners**: @platform.core
- **Tags**: rbac, permissions, auth
- **File**: `packages/libs/identity-rbac/src/identity-rbac.capability.ts`field.route.label/docs/reference/identity-rbac/rbac
referencepublic
field.summary.labelA role has been assigned.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @platform.identity-rbac
- **Tags**: role, assigned, identity
- **File**: `packages/libs/identity-rbac/src/events.ts`field.route.label/docs/reference/identity-rbac/role.assigned
referencepublic
field.summary.labelA role has been revoked.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @platform.identity-rbac
- **Tags**: role, revoked, identity
- **File**: `packages/libs/identity-rbac/src/events.ts`field.route.label/docs/reference/identity-rbac/role.revoked
referencepublic
field.summary.labelA new user has been created.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @platform.identity-rbac
- **Tags**: user, created, identity
- **File**: `packages/libs/identity-rbac/src/events.ts`field.route.label/docs/reference/identity-rbac/user.created
referencepublic
field.summary.labelA user account has been deleted.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @platform.identity-rbac
- **Tags**: user, deleted, identity
- **File**: `packages/libs/identity-rbac/src/events.ts`field.route.label/docs/reference/identity-rbac/user.deleted
referencepublic
field.summary.labelA user has verified their email address.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @platform.identity-rbac
- **Tags**: user, verified, identity
- **File**: `packages/libs/identity-rbac/src/events.ts`field.route.label/docs/reference/identity-rbac/user.email_verified
referencepublic
field.summary.labelA user profile has been updated.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @platform.identity-rbac
- **Tags**: user, updated, identity
- **File**: `packages/libs/identity-rbac/src/events.ts`field.route.label/docs/reference/identity-rbac/user.updated
referencepublic
field.summary.labelDocBlock-based in-app documentation viewer for non-technical users
- **Type**: feature
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @examples
- **Tags**: docs, in-app, viewer
- **File**: `packages/examples/in-app-docs/src/in-app-docs.feature.ts`field.route.label/docs/reference/in-app-docs/in-app-docs
referencepublic
field.summary.labelExtract, transform, load data pipelines
- **Type**: capability (capability)
- **Version**: 1.0.0
- **Owners**: platform.core
- **Tags**: etl, data, pipeline
- **File**: `packages/examples/integration-hub/src/integration-hub.capability.ts`field.route.label/docs/reference/integration-hub/etl
referencepublic
field.summary.labelThird-party integration connections
- **Type**: capability (capability)
- **Version**: 1.0.0
- **Owners**: platform.core
- **Tags**: integration, connections
- **File**: `packages/examples/integration-hub/src/integration-hub.capability.ts`field.route.label/docs/reference/integration-hub/integration
referencepublic
field.summary.labelConnect and sync data with external systems through configurable integrations
- **Type**: feature
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @integration-team
- **Tags**: integration, sync, etl, connectorsfield.route.label/docs/reference/integration-hub/integration-hub
referencepublic
field.summary.labelCreate a connection to an external system.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @example.integration-hub
- **Tags**: integration, connection, create
- **File**: `packages/examples/integration-hub/src/connection/connection.operation.ts`field.route.label/docs/reference/integration-hub/integration.connection.create
referencepublic
field.summary.labelFired when a new connection is established
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @integration-team
- **Tags**: integration, connection
- **File**: `packages/examples/integration-hub/src/events.ts`field.route.label/docs/reference/integration-hub/integration.connection.created
referencepublic
field.summary.labelList of integration connections
- **Type**: presentation (presentation)
- **Version**: 1.0.0
- **Owners**: @integration-team
- **Tags**: integration, connection, list
- **File**: `packages/examples/integration-hub/src/connection/connection.presentation.ts`field.route.label/docs/reference/integration-hub/integration.connection.list
referencepublic
field.summary.labelSetup wizard for creating integration connections
- **Type**: presentation (presentation)
- **Version**: 1.0.0
- **Owners**: @integration-team
- **Tags**: integration, connection, setup
- **File**: `packages/examples/integration-hub/src/connection/connection.presentation.ts`field.route.label/docs/reference/integration-hub/integration.connection.setup
referencepublic
field.summary.labelFired when a connection status changes
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @integration-team
- **Tags**: integration, connection
- **File**: `packages/examples/integration-hub/src/events.ts`field.route.label/docs/reference/integration-hub/integration.connection.statusChanged
referencepublic
field.summary.labelCreate a new integration.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @example.integration-hub
- **Tags**: integration, create
- **File**: `packages/examples/integration-hub/src/integration/integration.operations.ts`field.route.label/docs/reference/integration-hub/integration.create
referencepublic
field.summary.labelFired when a new integration is created
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @integration-team
- **Tags**: integration
- **File**: `packages/examples/integration-hub/src/events.ts`field.route.label/docs/reference/integration-hub/integration.created
referencepublic
field.summary.labelDetailed view of an integration
- **Type**: presentation (presentation)
- **Version**: 1.0.0
- **Owners**: @integration-team
- **Tags**: integration, detail
- **File**: `packages/examples/integration-hub/src/integration/integration.presentation.ts`field.route.label/docs/reference/integration-hub/integration.detail
referencepublic
field.summary.labelAdd a field mapping to a sync config.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @example.integration-hub
- **Tags**: integration, mapping, field
- **File**: `packages/examples/integration-hub/src/sync/sync.operations.ts`field.route.label/docs/reference/integration-hub/integration.fieldMapping.add
referencepublic
field.summary.labelTest for adding field mapping
- **Type**: test-spec (test-spec)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @example.integration-hub
- **Tags**: test
- **File**: `packages/examples/integration-hub/src/tests/operations.test-spec.ts`field.route.label/docs/reference/integration-hub/integration.fieldMapping.add.test
referencepublic
field.summary.labelFired when a field mapping is added to a sync config
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @integration-team
- **Tags**: integration, sync
- **File**: `packages/examples/integration-hub/src/events.ts`field.route.label/docs/reference/integration-hub/integration.fieldMapping.added
referencepublic
field.summary.labelVisual field mapping editor
- **Type**: presentation (presentation)
- **Version**: 1.0.0
- **Owners**: @integration-team
- **Tags**: integration, field-mapping, editor
- **File**: `packages/examples/integration-hub/src/sync/sync.presentation.ts`field.route.label/docs/reference/integration-hub/integration.fieldMapping.editor
referencepublic
field.summary.labelIntegration health monitoring dashboard
- **Type**: presentation (presentation)
- **Version**: 1.0.0
- **Owners**: @integration-team
- **Tags**: integration, health, monitoring
- **File**: `packages/examples/integration-hub/src/integration/integration.presentation.ts`field.route.label/docs/reference/integration-hub/integration.health
referencepublic
field.summary.labelList of available integrations
- **Type**: presentation (presentation)
- **Version**: 1.0.0
- **Owners**: @integration-team
- **Tags**: integration, list
- **File**: `packages/examples/integration-hub/src/integration/integration.presentation.ts`field.route.label/docs/reference/integration-hub/integration.list
referencepublic
field.summary.labelFired when a single record is synced
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @integration-team
- **Tags**: integration, sync
- **File**: `packages/examples/integration-hub/src/events.ts`field.route.label/docs/reference/integration-hub/integration.record.synced
referencepublic
field.summary.labelReal-time sync activity monitor
- **Type**: presentation (presentation)
- **Version**: 1.0.0
- **Owners**: @integration-team
- **Tags**: integration, sync, activity, realtime
- **File**: `packages/examples/integration-hub/src/sync/sync.presentation.ts`field.route.label/docs/reference/integration-hub/integration.sync.activity
referencepublic
field.summary.labelFired when a sync run completes successfully
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @integration-team
- **Tags**: integration, sync
- **File**: `packages/examples/integration-hub/src/events.ts`field.route.label/docs/reference/integration-hub/integration.sync.completed
referencepublic
field.summary.labelFired when a sync run fails
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @integration-team
- **Tags**: integration, sync
- **File**: `packages/examples/integration-hub/src/events.ts`field.route.label/docs/reference/integration-hub/integration.sync.failed
referencepublic
field.summary.labelFired when a sync run starts
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @integration-team
- **Tags**: integration, sync
- **File**: `packages/examples/integration-hub/src/events.ts`field.route.label/docs/reference/integration-hub/integration.sync.started
referencepublic
field.summary.labelTrigger a manual sync.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @example.integration-hub
- **Tags**: integration, sync, trigger
- **File**: `packages/examples/integration-hub/src/sync/sync.operations.ts`field.route.label/docs/reference/integration-hub/integration.sync.trigger
referencepublic
field.summary.labelCreate a sync configuration.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @example.integration-hub
- **Tags**: integration, sync, config, create
- **File**: `packages/examples/integration-hub/src/sync/sync.operations.ts`field.route.label/docs/reference/integration-hub/integration.syncConfig.create
referencepublic
field.summary.labelTest for creating sync config
- **Type**: test-spec (test-spec)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @example.integration-hub
- **Tags**: test
- **File**: `packages/examples/integration-hub/src/tests/operations.test-spec.ts`field.route.label/docs/reference/integration-hub/integration.syncConfig.create.test
referencepublic
field.summary.labelFired when a sync configuration is created
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @integration-team
- **Tags**: integration, sync
- **File**: `packages/examples/integration-hub/src/events.ts`field.route.label/docs/reference/integration-hub/integration.syncConfig.created
referencepublic
field.summary.labelEditor for sync configuration settings
- **Type**: presentation (presentation)
- **Version**: 1.0.0
- **Owners**: @integration-team
- **Tags**: integration, sync, config, editor
- **File**: `packages/examples/integration-hub/src/sync/sync.presentation.ts`field.route.label/docs/reference/integration-hub/integration.syncConfig.editor
referencepublic
field.summary.labelList of sync configurations
- **Type**: presentation (presentation)
- **Version**: 1.0.0
- **Owners**: @integration-team
- **Tags**: integration, sync, config, list
- **File**: `packages/examples/integration-hub/src/sync/sync.presentation.ts`field.route.label/docs/reference/integration-hub/integration.syncConfig.list
referencepublic
field.summary.labelDetailed view of a sync run with logs
- **Type**: presentation (presentation)
- **Version**: 1.0.0
- **Owners**: @integration-team
- **Tags**: integration, sync, run, detail
- **File**: `packages/examples/integration-hub/src/sync/sync.presentation.ts`field.route.label/docs/reference/integration-hub/integration.syncRun.detail
referencepublic
field.summary.labelList sync run history.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @example.integration-hub
- **Tags**: integration, sync, run, list
- **File**: `packages/examples/integration-hub/src/sync/sync.operations.ts`field.route.label/docs/reference/integration-hub/integration.syncRun.list
referencepublic
field.summary.labelTest for listing sync runs
- **Type**: test-spec (test-spec)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @example.integration-hub
- **Tags**: test
- **File**: `packages/examples/integration-hub/src/tests/operations.test-spec.ts`field.route.label/docs/reference/integration-hub/integration.syncRun.list.test
referencepublic
field.summary.labelHistory of sync runs
- **Type**: presentation (presentation)
- **Version**: 1.0.0
- **Owners**: @integration-team
- **Tags**: integration, sync, runs, history
- **File**: `packages/examples/integration-hub/src/sync/sync.presentation.ts`field.route.label/docs/reference/integration-hub/integration.syncRun.viewList
referencepublic
field.summary.labelData synchronization between systems
- **Type**: capability (capability)
- **Version**: 1.0.0
- **Owners**: platform.core
- **Tags**: sync, data
- **File**: `packages/examples/integration-hub/src/integration-hub.capability.ts`field.route.label/docs/reference/integration-hub/sync
referencepublic
field.summary.labelPostHog analytics integration with event capture, HogQL, and feature flags
- **Type**: feature
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @examples
- **Tags**: integration, posthog, analytics, feature-flagsfield.route.label/docs/reference/integration-posthog/integration-posthog
referencepublic
field.summary.labelStripe payments integration with blueprint, workflow, and tenant configuration
- **Type**: feature
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @integration-team
- **Tags**: integration, stripe, paymentsfield.route.label/docs/reference/integration-stripe/integration-stripe
referencepublic
field.summary.labelSupabase integration with vector store and Postgres database wiring
- **Type**: feature
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @integration-team
- **Tags**: integration, supabase, vector-store, postgresfield.route.label/docs/reference/integration-supabase/integration-supabase
referencepublic
field.summary.labelA job has been cancelled.
- **Type**: event (event)
- **Version**: 1.0.0
- **Owners**: @contractspec.libs.jobs
- **Tags**: job-queue, lifecycle
- **File**: `packages/libs/jobs/src/events.ts`
```typescript
import { defineEvent, StabilityEnum } from '@lssm-tech/lib.contracts-spec';field.route.label/docs/reference/jobs/job.cancelled
referencepublic
field.summary.labelA job has completed successfully.
- **Type**: event (event)
- **Version**: 1.0.0
- **Owners**: @contractspec.libs.jobs
- **Tags**: job-queue, lifecycle
- **File**: `packages/libs/jobs/src/events.ts`
```typescriptfield.route.label/docs/reference/jobs/job.completed
referencepublic
field.summary.labelA job has exhausted all retries and moved to dead letter queue.
- **Type**: event (event)
- **Version**: 1.0.0
- **Owners**: @contractspec.libs.jobs
- **Tags**: job-queue, lifecycle, error
- **File**: `packages/libs/jobs/src/events.ts`field.route.label/docs/reference/jobs/job.dead_lettered
referencepublic
field.summary.labelA job has been added to the queue.
- **Type**: event (event)
- **Version**: 1.0.0
- **Owners**: @contractspec.libs.jobs
- **Tags**: job-queue, lifecycle
- **File**: `packages/libs/jobs/src/events.ts`
```typescriptfield.route.label/docs/reference/jobs/job.enqueued
referencepublic
field.summary.labelA job attempt has failed.
- **Type**: event (event)
- **Version**: 1.0.0
- **Owners**: @contractspec.libs.jobs
- **Tags**: job-queue, lifecycle, error
- **File**: `packages/libs/jobs/src/events.ts`
```typescriptfield.route.label/docs/reference/jobs/job.failed
referencepublic
field.summary.labelA job is being scheduled for retry.
- **Type**: event (event)
- **Version**: 1.0.0
- **Owners**: @contractspec.libs.jobs
- **Tags**: job-queue, lifecycle, retry
- **File**: `packages/libs/jobs/src/events.ts`field.route.label/docs/reference/jobs/job.retrying
referencepublic
field.summary.labelA job has started processing.
- **Type**: event (event)
- **Version**: 1.0.0
- **Owners**: @contractspec.libs.jobs
- **Tags**: job-queue, lifecycle
- **File**: `packages/libs/jobs/src/events.ts`
```typescriptfield.route.label/docs/reference/jobs/job.started
referencepublic
field.summary.labelBackground job processing, scheduling, and queue management
- **Type**: feature
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @platform.jobs
- **Tags**: jobs, queue, background, scheduler
- **File**: `packages/libs/jobs/src/jobs.feature.ts`field.route.label/docs/reference/jobs/jobs
referencepublic
field.summary.labelCancel a pending job.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: platform.jobs
- **Tags**: jobs, cancel
- **File**: `packages/libs/jobs/src/contracts/index.ts`field.route.label/docs/reference/jobs/jobs.cancel
referencepublic
field.summary.labelEnqueue a background job for async processing.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: platform.jobs
- **Tags**: jobs, enqueue
- **File**: `packages/libs/jobs/src/contracts/index.ts`field.route.label/docs/reference/jobs/jobs.enqueue
referencepublic
field.summary.labelGet a job by ID.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: platform.jobs
- **Tags**: jobs, get
- **File**: `packages/libs/jobs/src/contracts/index.ts`
Check job status and result.field.route.label/docs/reference/jobs/jobs.get
referencepublic
field.summary.labelCreate a scheduled/recurring job.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: platform.jobs
- **Tags**: jobs, schedule, create
- **File**: `packages/libs/jobs/src/contracts/index.ts`field.route.label/docs/reference/jobs/jobs.schedule.create
referencepublic
field.summary.labelList all scheduled jobs.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: platform.jobs
- **Tags**: jobs, schedule, list
- **File**: `packages/libs/jobs/src/contracts/index.ts`field.route.label/docs/reference/jobs/jobs.schedule.list
referencepublic
field.summary.labelEnable or disable a scheduled job.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: platform.jobs
- **Tags**: jobs, schedule, toggle
- **File**: `packages/libs/jobs/src/contracts/index.ts`field.route.label/docs/reference/jobs/jobs.schedule.toggle
referencepublic
field.summary.labelGet job queue statistics.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: platform.jobs
- **Tags**: jobs, stats, admin
- **File**: `packages/libs/jobs/src/contracts/index.ts`field.route.label/docs/reference/jobs/jobs.stats
referencepublic
field.summary.labelScheduled job execution
- **Type**: capability (capability)
- **Version**: 1.0.0
- **Owners**: @platform.core
- **Tags**: scheduler, cron, jobs
- **File**: `packages/libs/jobs/src/jobs.capability.ts`
```typescriptfield.route.label/docs/reference/jobs/scheduler
referencepublic
field.summary.labelA scheduled job has been triggered.
- **Type**: event (event)
- **Version**: 1.0.0
- **Owners**: @contractspec.libs.jobs
- **Tags**: job-queue, scheduler
- **File**: `packages/libs/jobs/src/events.ts`
```typescriptfield.route.label/docs/reference/jobs/scheduler.job_triggered
referencepublic
field.summary.labelAutomation proposes KB patches; humans verify; publishing is blocked until approvals are complete.
- **Type**: feature
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @examples
- **Tags**: knowledge, pipeline, hitl, audit, notificationsfield.route.label/docs/reference/kb-update-pipeline/kb-update-pipeline
referencepublic
field.summary.labelKB source change detected.
- **Type**: event (event)
- **Version**: 1.0.0
- **File**: `packages/examples/kb-update-pipeline/src/events.ts`
```typescript
import { defineEvent, StabilityEnum } from '@lssm-tech/lib.contracts-spec';field.route.label/docs/reference/kb-update-pipeline/kb.change.detected
referencepublic
field.summary.labelKB change summarized.
- **Type**: event (event)
- **Version**: 1.0.0
- **File**: `packages/examples/kb-update-pipeline/src/events.ts`
```typescript
import { defineEvent, StabilityEnum } from '@lssm-tech/lib.contracts-spec';field.route.label/docs/reference/kb-update-pipeline/kb.change.summarized
referencepublic
field.summary.labelOverview of KB change candidates and review tasks.
- **Type**: presentation (presentation)
- **Version**: 1.0.0
- **Owners**: @examples
- **Tags**: dashboard, knowledge
- **File**: `packages/examples/kb-update-pipeline/src/presentations.ts`field.route.label/docs/reference/kb-update-pipeline/kb.dashboard
referencepublic
field.summary.labelKB rule patch proposed (draft versions created).
- **Type**: event (event)
- **Version**: 1.0.0
- **File**: `packages/examples/kb-update-pipeline/src/events.ts`
```typescript
import { defineEvent, StabilityEnum } from '@lssm-tech/lib.contracts-spec';field.route.label/docs/reference/kb-update-pipeline/kb.patch.proposed
referencepublic
field.summary.labelKB review decided.
- **Type**: event (event)
- **Version**: 1.0.0
- **File**: `packages/examples/kb-update-pipeline/src/events.ts`
```typescript
import { defineEvent, StabilityEnum } from '@lssm-tech/lib.contracts-spec';field.route.label/docs/reference/kb-update-pipeline/kb.review.decided
referencepublic
field.summary.labelForm to approve or reject a KB change candidate.
- **Type**: presentation (presentation)
- **Version**: 1.0.0
- **Owners**: @examples
- **Tags**: form, review
- **File**: `packages/examples/kb-update-pipeline/src/presentations.ts`field.route.label/docs/reference/kb-update-pipeline/kb.review.form
referencepublic
field.summary.labelList of pending review tasks for the current user.
- **Type**: presentation (presentation)
- **Version**: 1.0.0
- **Owners**: @examples
- **Tags**: list, review
- **File**: `packages/examples/kb-update-pipeline/src/presentations.ts`field.route.label/docs/reference/kb-update-pipeline/kb.review.list
referencepublic
field.summary.labelKB review requested.
- **Type**: event (event)
- **Version**: 1.0.0
- **File**: `packages/examples/kb-update-pipeline/src/events.ts`
```typescript
import { defineEvent, StabilityEnum } from '@lssm-tech/lib.contracts-spec';field.route.label/docs/reference/kb-update-pipeline/kb.review.requested
referencepublic
field.summary.labelCreate a review task for a detected change.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @examples
- **Tags**: knowledge, pipeline, hitl
- **File**: `packages/examples/kb-update-pipeline/src/operations/pipeline.ts`field.route.label/docs/reference/kb-update-pipeline/kbPipeline.createReviewTask
referencepublic
field.summary.labelTest for creating review task
- **Type**: test-spec (test-spec)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @example.kb-update-pipeline
- **Tags**: test
- **File**: `packages/examples/kb-update-pipeline/src/tests/operations.test-spec.ts`field.route.label/docs/reference/kb-update-pipeline/kbPipeline.createReviewTask.test
referencepublic
field.summary.labelPublish snapshot if ready (all approvals satisfied).
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @examples
- **Tags**: knowledge, pipeline, publishing
- **File**: `packages/examples/kb-update-pipeline/src/operations/pipeline.ts`field.route.label/docs/reference/kb-update-pipeline/kbPipeline.publishIfReady
referencepublic
field.summary.labelDetect source changes and create change candidates.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @examples
- **Tags**: knowledge, pipeline, jobs
- **File**: `packages/examples/kb-update-pipeline/src/operations/pipeline.ts`field.route.label/docs/reference/kb-update-pipeline/kbPipeline.runWatch
referencepublic
field.summary.labelTest for run watch operation
- **Type**: test-spec (test-spec)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @example.kb-update-pipeline
- **Tags**: test
- **File**: `packages/examples/kb-update-pipeline/src/tests/operations.test-spec.ts`field.route.label/docs/reference/kb-update-pipeline/kbPipeline.runWatch.test
referencepublic
field.summary.labelSubmit approve/reject decision for a review task.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @examples
- **Tags**: knowledge, pipeline, hitl, rbac
- **File**: `packages/examples/kb-update-pipeline/src/operations/pipeline.ts`field.route.label/docs/reference/kb-update-pipeline/kbPipeline.submitDecision
referencepublic
field.summary.labelTest for submitting decision
- **Type**: test-spec (test-spec)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @example.kb-update-pipeline
- **Tags**: test
- **File**: `packages/examples/kb-update-pipeline/src/tests/operations.test-spec.ts`field.route.label/docs/reference/kb-update-pipeline/kbPipeline.submitDecision.test
referencepublic
field.summary.labelCurated product knowledge space with blueprint, tenant config, and FAQ workflow
- **Type**: feature
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @examples
- **Tags**: knowledge, canon, faqfield.route.label/docs/reference/knowledge-canon/knowledge-canon
referencepublic
field.summary.labelAn achievement has been unlocked.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Tags**: learning, gamification, achievement
- **File**: `packages/modules/learning-journey/src/events.ts`field.route.label/docs/reference/learning-journey/achievement.unlocked
referencepublic
field.summary.labelA certificate has been issued.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Tags**: learning, certificate
- **File**: `packages/modules/learning-journey/src/events.ts`
```typescriptfield.route.label/docs/reference/learning-journey/certificate.issued
referencepublic
field.summary.labelA learner has completed a course.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Tags**: learning, progress, course
- **File**: `packages/modules/learning-journey/src/events.ts`
```typescriptfield.route.label/docs/reference/learning-journey/course.completed
referencepublic
field.summary.labelA course has been published.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Tags**: learning, course
- **File**: `packages/modules/learning-journey/src/events.ts`
```typescript
import { defineEvent } from '@lssm-tech/lib.contracts-spec';field.route.label/docs/reference/learning-journey/course.published
referencepublic
field.summary.labelA daily goal has been completed.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Tags**: learning, gamification, goal
- **File**: `packages/modules/learning-journey/src/events.ts`field.route.label/docs/reference/learning-journey/daily_goal.completed
referencepublic
field.summary.labelA learner has enrolled in a course.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Tags**: learning, enrollment
- **File**: `packages/modules/learning-journey/src/events.ts`
```typescriptfield.route.label/docs/reference/learning-journey/enrollment.created
referencepublic
field.summary.labelA flashcard has been reviewed.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Tags**: learning, flashcards
- **File**: `packages/modules/learning-journey/src/events.ts`
```typescriptfield.route.label/docs/reference/learning-journey/flashcard.reviewed
referencepublic
field.summary.labelGamification elements like badges, points, and achievements
- **Type**: capability (capability)
- **Version**: 1.0.0
- **Owners**: platform.core
- **Tags**: gamification, engagement, ui
- **File**: `packages/modules/learning-journey/src/learning-journey.capability.ts`field.route.label/docs/reference/learning-journey/gamification
referencepublic
field.summary.labelLearning platform with courses, onboarding, flashcards, and gamification
- **Type**: feature
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @platform.learning-journey
- **Tags**: learning, onboarding, courses, flashcards, gamificationfield.route.label/docs/reference/learning-journey/learning-journey
referencepublic
field.summary.labelMark a lesson as completed.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: stable
- **Tags**: learning, progress
- **File**: `packages/modules/learning-journey/src/contracts/operations.ts`field.route.label/docs/reference/learning-journey/learning.completeLesson
referencepublic
field.summary.labelEnroll in a course.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: stable
- **Tags**: learning, enrollment
- **File**: `packages/modules/learning-journey/src/contracts/operations.ts`
Start learning a new course.field.route.label/docs/reference/learning-journey/learning.enroll
referencepublic
field.summary.labelGet learner dashboard data.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Stability**: stable
- **Tags**: learning, dashboard
- **File**: `packages/modules/learning-journey/src/contracts/operations.ts`field.route.label/docs/reference/learning-journey/learning.getDashboard
referencepublic
field.summary.labelGet flashcards due for review.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Stability**: stable
- **Tags**: learning, flashcards
- **File**: `packages/modules/learning-journey/src/contracts/operations.ts`field.route.label/docs/reference/learning-journey/learning.getDueCards
referencepublic
field.summary.labelProject the latest adaptive journey progress for one track.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Stability**: stable
- **Tags**: adaptive-learning, journey, progress
- **File**: `packages/modules/learning-journey/src/contracts/journey.ts`field.route.label/docs/reference/learning-journey/learning.journey.getProgress
referencepublic
field.summary.labelList adaptive learning journeys for a learner or product.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Stability**: stable
- **Tags**: adaptive-learning, journey, learning
- **File**: `packages/modules/learning-journey/src/contracts/journey.ts`field.route.label/docs/reference/learning-journey/learning.journey.listTracks
referencepublic
field.summary.labelRecord a domain event and re-evaluate an adaptive journey.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: stable
- **Tags**: adaptive-learning, journey, events
- **File**: `packages/modules/learning-journey/src/contracts/journey.ts`field.route.label/docs/reference/learning-journey/learning.journey.recordEvent
referencepublic
field.summary.labelFetch onboarding progress for a specific track.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Stability**: stable
- **Tags**: learning, onboarding, journey
- **File**: `packages/modules/learning-journey/src/contracts/onboarding.ts`field.route.label/docs/reference/learning-journey/learning.onboarding.getProgress
referencepublic
field.summary.labelList onboarding tracks available to a learner or product.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Stability**: stable
- **Tags**: learning, onboarding, journey
- **File**: `packages/modules/learning-journey/src/contracts/onboarding.ts`field.route.label/docs/reference/learning-journey/learning.onboarding.listTracks
referencepublic
field.summary.labelRecord a domain event to evaluate onboarding step completion conditions.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: stable
- **Tags**: learning, onboarding, events
- **File**: `packages/modules/learning-journey/src/contracts/onboarding.ts`field.route.label/docs/reference/learning-journey/learning.onboarding.recordEvent
referencepublic
field.summary.labelSubmit a flashcard review.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: stable
- **Tags**: learning, flashcards
- **File**: `packages/modules/learning-journey/src/contracts/operations.ts`field.route.label/docs/reference/learning-journey/learning.submitCardReview
referencepublic
field.summary.labelA learner has completed a lesson.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Tags**: learning, progress, lesson
- **File**: `packages/modules/learning-journey/src/events.ts`
```typescriptfield.route.label/docs/reference/learning-journey/lesson.completed
referencepublic
field.summary.labelA learner has leveled up.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Tags**: learning, gamification, level
- **File**: `packages/modules/learning-journey/src/events.ts`
```typescriptfield.route.label/docs/reference/learning-journey/level.up
referencepublic
field.summary.labelUser onboarding and first-time experience flows
- **Type**: capability (capability)
- **Version**: 1.0.0
- **Owners**: platform.core
- **Tags**: onboarding, ux, ui
- **File**: `packages/modules/learning-journey/src/learning-journey.capability.ts`field.route.label/docs/reference/learning-journey/onboarding
referencepublic
field.summary.labelA learner has completed onboarding.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Tags**: learning, onboarding
- **File**: `packages/modules/learning-journey/src/events.ts`
```typescriptfield.route.label/docs/reference/learning-journey/onboarding.completed
referencepublic
field.summary.labelA learner has started onboarding.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Tags**: learning, onboarding
- **File**: `packages/modules/learning-journey/src/events.ts`
```typescriptfield.route.label/docs/reference/learning-journey/onboarding.started
referencepublic
field.summary.labelAn onboarding step has been completed.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Tags**: learning, onboarding
- **File**: `packages/modules/learning-journey/src/events.ts`
```typescriptfield.route.label/docs/reference/learning-journey/onboarding.step_completed
referencepublic
field.summary.labelA quiz attempt has been completed.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Tags**: learning, quiz
- **File**: `packages/modules/learning-journey/src/events.ts`
```typescriptfield.route.label/docs/reference/learning-journey/quiz.completed
referencepublic
field.summary.labelA quiz attempt has started.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Tags**: learning, quiz
- **File**: `packages/modules/learning-journey/src/events.ts`
```typescript
import { defineEvent } from '@lssm-tech/lib.contracts-spec';field.route.label/docs/reference/learning-journey/quiz.started
referencepublic
field.summary.labelA streak has been updated.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Tags**: learning, gamification, streak
- **File**: `packages/modules/learning-journey/src/events.ts`
```typescriptfield.route.label/docs/reference/learning-journey/streak.updated
referencepublic
field.summary.labelXP has been earned.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Tags**: learning, gamification, xp
- **File**: `packages/modules/learning-journey/src/events.ts`
```typescript
import { defineEvent } from '@lssm-tech/lib.contracts-spec';field.route.label/docs/reference/learning-journey/xp.earned
referencepublic
field.summary.labelContextual coaching track with ambient tips and follow-up actions
- **Type**: feature
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @examples
- **Tags**: learning, coaching, ambient, journeyfield.route.label/docs/reference/learning-journey-ambient-coach/learning-journey-ambient-coach
referencepublic
field.summary.labelCRM first-win onboarding journey with step-by-step guidance for new CRM users
- **Type**: feature
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @examples.learning-journey.crm-onboarding
- **Tags**: learning, crm, onboarding, journeyfield.route.label/docs/reference/learning-journey-crm-onboarding/learning-journey-crm-onboarding
referencepublic
field.summary.labelCRM first win track detail
- **Type**: presentation (presentation)
- **Version**: 1.0.0
- **File**: `packages/examples/learning-journey-crm-onboarding/src/presentations/index.ts`
```typescript
import {
definePresentation,field.route.label/docs/reference/learning-journey-crm-onboarding/learning.journey.crm.track
referencepublic
field.summary.labelCompact widget for CRM onboarding progress
- **Type**: presentation (presentation)
- **Version**: 1.0.0
- **File**: `packages/examples/learning-journey-crm-onboarding/src/presentations/index.ts`
```typescriptfield.route.label/docs/reference/learning-journey-crm-onboarding/learning.journey.crm.widget
referencepublic
field.summary.labelFetch CRM first win track definition.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: examples.learning-journey.crm-onboarding
- **Tags**: learning, crm, onboardingfield.route.label/docs/reference/learning-journey-crm-onboarding/learningJourney.crmOnboarding.getTrack
referencepublic
field.summary.labelTest for getting CRM onboarding track
- **Type**: test-spec (test-spec)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @example.learning-journey-crm-onboarding
- **Tags**: test
- **File**: `packages/examples/learning-journey-crm-onboarding/src/tests/operations.test-spec.ts`field.route.label/docs/reference/learning-journey-crm-onboarding/learningJourney.crmOnboarding.getTrack.test
referencepublic
field.summary.labelRecord an event to advance CRM onboarding progress.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: examples.learning-journey.crm-onboarding
- **Tags**: learning, crm, onboardingfield.route.label/docs/reference/learning-journey-crm-onboarding/learningJourney.crmOnboarding.recordEvent
referencepublic
field.summary.labelDrill-based learning with spaced repetition, XP, and streaks
- **Type**: feature
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @examples
- **Tags**: learning, drills, srs, gamification
- **File**: `packages/examples/learning-journey-duo-drills/src/learning-journey-duo-drills.feature.ts`field.route.label/docs/reference/learning-journey-duo-drills/learning-journey-duo-drills
referencepublic
field.summary.labelPlatform primitives tour journey for exploring ContractSpec core features
- **Type**: feature
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @examples.learning-journey.platform-tour
- **Tags**: learning, platform, tour, journeyfield.route.label/docs/reference/learning-journey-platform-tour/learning-journey-platform-tour
referencepublic
field.summary.labelPlatform primitives tour track detail
- **Type**: presentation (presentation)
- **Version**: 1.0.0
- **File**: `packages/examples/learning-journey-platform-tour/src/presentations/index.ts`
```typescript
import {field.route.label/docs/reference/learning-journey-platform-tour/learning.journey.platform.track
referencepublic
field.summary.labelCompact widget for platform tour progress
- **Type**: presentation (presentation)
- **Version**: 1.0.0
- **File**: `packages/examples/learning-journey-platform-tour/src/presentations/index.ts`
```typescriptfield.route.label/docs/reference/learning-journey-platform-tour/learning.journey.platform.widget
referencepublic
field.summary.labelFetch platform primitives tour track definition.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: examples.learning-journey.platform-tour
- **Tags**: learning, platform, tourfield.route.label/docs/reference/learning-journey-platform-tour/learningJourney.platformTour.getTrack
referencepublic
field.summary.labelTest for getting platform tour track
- **Type**: test-spec (test-spec)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @example.learning-journey-platform-tour
- **Tags**: test
- **File**: `packages/examples/learning-journey-platform-tour/src/tests/operations.test-spec.ts`field.route.label/docs/reference/learning-journey-platform-tour/learningJourney.platformTour.getTrack.test
referencepublic
field.summary.labelRecord an event to advance platform tour progress.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: examples.learning-journey.platform-tour
- **Tags**: learning, platform, tourfield.route.label/docs/reference/learning-journey-platform-tour/learningJourney.platformTour.recordEvent
referencepublic
field.summary.labelQuest and challenge-based learning with deadlines and completion tracking
- **Type**: feature
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @examples
- **Tags**: learning, quests, challenges, gamificationfield.route.label/docs/reference/learning-journey-quest-challenges/learning-journey-quest-challenges
referencepublic
field.summary.labelShared registry and presentations for learning journey tracks
- **Type**: feature
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @learning-team
- **Tags**: learning, journey, onboarding, registryfield.route.label/docs/reference/learning-journey-registry/learning-journey-registry
referencepublic
field.summary.labelCompact widget showing progress for active track.
- **Type**: presentation (presentation)
- **Version**: 1.0.0
- **File**: `packages/examples/learning-journey-registry/src/presentations/index.ts`
```typescriptfield.route.label/docs/reference/learning-journey-registry/learning.journey.progress_widget
referencepublic
field.summary.labelTrack detail with steps and progress state.
- **Type**: presentation (presentation)
- **Version**: 1.0.0
- **File**: `packages/examples/learning-journey-registry/src/presentations/index.ts`
```typescript
import {field.route.label/docs/reference/learning-journey-registry/learning.journey.track_detail
referencepublic
field.summary.labelList of learning journeys available to the learner.
- **Type**: presentation (presentation)
- **Version**: 1.0.0
- **File**: `packages/examples/learning-journey-registry/src/presentations/index.ts`
```typescriptfield.route.label/docs/reference/learning-journey-registry/learning.journey.track_list
referencepublic
field.summary.labelStudio onboarding journey for getting started with ContractSpec Studio
- **Type**: feature
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @examples.learning-journey.studio-onboarding
- **Tags**: learning, onboarding, studio, journeyfield.route.label/docs/reference/learning-journey-studio-onboarding/learning-journey-studio-onboarding
referencepublic
field.summary.labelStudio onboarding track detail
- **Type**: presentation (presentation)
- **Version**: 1.0.0
- **File**: `packages/examples/learning-journey-studio-onboarding/src/presentations/index.ts`
Visualize the onboarding track for the user.field.route.label/docs/reference/learning-journey-studio-onboarding/learning.journey.studio.track
referencepublic
field.summary.labelCompact widget for Studio onboarding progress
- **Type**: presentation (presentation)
- **Version**: 1.0.0
- **File**: `packages/examples/learning-journey-studio-onboarding/src/presentations/index.ts`
Show quick progress summary.field.route.label/docs/reference/learning-journey-studio-onboarding/learning.journey.studio.widget
referencepublic
field.summary.labelFetch the Studio onboarding track definition.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: examples.learning-journey.studio-onboarding
- **Tags**: learning, onboarding, studiofield.route.label/docs/reference/learning-journey-studio-onboarding/learningJourney.studioOnboarding.getTrack
referencepublic
field.summary.labelTest for getting studio onboarding track
- **Type**: test-spec (test-spec)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @example.learning-journey-studio-onboarding
- **Tags**: test
- **File**: `packages/examples/learning-journey-studio-onboarding/src/tests/operations.test-spec.ts`field.route.label/docs/reference/learning-journey-studio-onboarding/learningJourney.studioOnboarding.getTrack.test
referencepublic
field.summary.labelRecord an event to advance Studio onboarding progress.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: examples.learning-journey.studio-onboarding
- **Tags**: learning, onboarding, studiofield.route.label/docs/reference/learning-journey-studio-onboarding/learningJourney.studioOnboarding.recordEvent
referencepublic
field.summary.labelCoaching UI with tip cards, engagement tracking, and multi-view navigation
- **Type**: feature
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @examples
- **Tags**: learning, ui, coaching, tipsfield.route.label/docs/reference/learning-journey-ui-coaching/learning-journey-ui-coaching
referencepublic
field.summary.labelGamified learning UI with drills, quests, flash cards, and mastery rings
- **Type**: feature
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @examples
- **Tags**: learning, ui, gamified, drillsfield.route.label/docs/reference/learning-journey-ui-gamified/learning-journey-ui-gamified
referencepublic
field.summary.labelDeveloper onboarding UI with checklists, journey maps, and step-by-step progress
- **Type**: feature
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @examples
- **Tags**: learning, ui, onboarding, checklistsfield.route.label/docs/reference/learning-journey-ui-onboarding/learning-journey-ui-onboarding
referencepublic
field.summary.labelShared learning-journey UI components including XpBar, StreakCounter, and BadgeDisplay
- **Type**: feature
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @examples
- **Tags**: learning, ui, shared, componentsfield.route.label/docs/reference/learning-journey-ui-shared/learning-journey-ui-shared
referencepublic
field.summary.labelLearning archetypes (drills, ambient-coach, quests) via event-driven track specs
- **Type**: feature
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @examples
- **Tags**: learning, patterns, archetypes, tracksfield.route.label/docs/reference/learning-patterns/learning-patterns
referencepublic
field.summary.labelCLI-based lifecycle assessment using the lifecycle-managed bundle
- **Type**: feature
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @examples
- **Tags**: lifecycle, cli, assessment
- **File**: `packages/examples/lifecycle-cli/src/lifecycle-cli.feature.ts`field.route.label/docs/reference/lifecycle-cli/lifecycle-cli
referencepublic
field.summary.labelLifecycle API usage snippet with status cards and lifecycle-managed endpoints
- **Type**: feature
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @examples
- **Tags**: lifecycle, dashboard, statusfield.route.label/docs/reference/lifecycle-dashboard/lifecycle-dashboard
referencepublic
field.summary.labelAnswer a user question using a KB snapshot with strict locale/jurisdiction gating.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @examples
- **Tags**: assistant, policy, locale, jurisdiction, knowledgefield.route.label/docs/reference/locale-jurisdiction-gate/assistant.answer
referencepublic
field.summary.labelAssistant answer blocked (fail-closed).
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @examples
- **Tags**: assistant, policy, blocked
- **File**: `packages/examples/locale-jurisdiction-gate/src/events.ts`field.route.label/docs/reference/locale-jurisdiction-gate/assistant.answer.blocked
referencepublic
field.summary.labelAssistant answer delivered (must include KB snapshot citations).
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @examples
- **Tags**: assistant, policy, deliveredfield.route.label/docs/reference/locale-jurisdiction-gate/assistant.answer.delivered
referencepublic
field.summary.labelAssistant answer requested (policy gate will run).
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @examples
- **Tags**: assistant, policy
- **File**: `packages/examples/locale-jurisdiction-gate/src/events.ts`field.route.label/docs/reference/locale-jurisdiction-gate/assistant.answer.requested
referencepublic
field.summary.labelExplain a concept using a KB snapshot with strict locale/jurisdiction gating.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @examples
- **Tags**: assistant, policy, knowledge, conceptsfield.route.label/docs/reference/locale-jurisdiction-gate/assistant.explainConcept
referencepublic
field.summary.labelFail-closed gating for assistant calls requiring locale/jurisdiction/snapshot/scope and citations.
- **Type**: feature
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @examples
- **Tags**: assistant, policy, locale, jurisdiction, knowledgefield.route.label/docs/reference/locale-jurisdiction-gate/locale-jurisdiction-gate
referencepublic
field.summary.labelCollects the explicit locale, jurisdiction, scope, and knowledge snapshot required by the assistant gate.
- **Type**: form (form)
- **Version**: 1.0.0
- **Tags**: assistant, form, policy
- **File**: `packages/examples/locale-jurisdiction-gate/src/forms/assistant-context.form.ts`field.route.label/docs/reference/locale-jurisdiction-gate/locale-jurisdiction-gate.form.assistant-context
referencepublic
field.summary.labelRequires explicit locale, jurisdiction, knowledge snapshot, and allowed scope before assistant requests may proceed.
- **Type**: policy (policy)
- **Version**: 1.0.0
- **Tags**: assistant, policy, jurisdictionfield.route.label/docs/reference/locale-jurisdiction-gate/locale-jurisdiction-gate.policy.gate
referencepublic
field.summary.labelE-commerce operations and product catalog
- **Type**: capability (capability)
- **Version**: 1.0.0
- **Owners**: platform.marketplace
- **Tags**: ecommerce, products
- **File**: `packages/examples/marketplace/src/marketplace.capability.ts`field.route.label/docs/reference/marketplace/ecommerce
referencepublic
field.summary.labelFull-featured marketplace with stores, products, orders, payouts, and reviews
- **Type**: feature
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @marketplace-team
- **Tags**: marketplace, ecommerce, multi-vendor, paymentsfield.route.label/docs/reference/marketplace/marketplace
referencepublic
field.summary.labelCheckout flow with cart and payment
- **Type**: presentation (presentation)
- **Version**: 1.0.0
- **Owners**: @marketplace-team
- **Tags**: marketplace, checkout, cart
- **File**: `packages/examples/marketplace/src/order/order.presentation.ts`field.route.label/docs/reference/marketplace/marketplace.checkout
referencepublic
field.summary.labelProduct inventory has been updated.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @marketplace-team
- **Tags**: marketplace, product, inventory
- **File**: `packages/examples/marketplace/src/product/product.event.ts`field.route.label/docs/reference/marketplace/marketplace.inventory.updated
referencepublic
field.summary.labelAn order has been completed.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @marketplace-team
- **Tags**: marketplace, order
- **File**: `packages/examples/marketplace/src/order/order.event.ts`field.route.label/docs/reference/marketplace/marketplace.order.completed
referencepublic
field.summary.labelCreate a new order.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @example.marketplace
- **Tags**: marketplace, order, create
- **File**: `packages/examples/marketplace/src/order/order.operations.ts`field.route.label/docs/reference/marketplace/marketplace.order.create
referencepublic
field.summary.labelTest for creating order
- **Type**: test-spec (test-spec)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @example.marketplace
- **Tags**: test
- **File**: `packages/examples/marketplace/src/tests/operations.test-spec.ts`field.route.label/docs/reference/marketplace/marketplace.order.create.test
referencepublic
field.summary.labelA new order has been created.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @marketplace-team
- **Tags**: marketplace, order
- **File**: `packages/examples/marketplace/src/order/order.event.ts`field.route.label/docs/reference/marketplace/marketplace.order.created
referencepublic
field.summary.labelOrder detail with items and shipping info
- **Type**: presentation (presentation)
- **Version**: 1.0.0
- **Owners**: @marketplace-team
- **Tags**: marketplace, order, detail
- **File**: `packages/examples/marketplace/src/order/order.presentation.ts`field.route.label/docs/reference/marketplace/marketplace.order.detail
referencepublic
field.summary.labelList of orders with status and tracking
- **Type**: presentation (presentation)
- **Version**: 1.0.0
- **Owners**: @marketplace-team
- **Tags**: marketplace, order, list
- **File**: `packages/examples/marketplace/src/order/order.presentation.ts`field.route.label/docs/reference/marketplace/marketplace.order.list
referencepublic
field.summary.labelAn order has been paid.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @marketplace-team
- **Tags**: marketplace, order
- **File**: `packages/examples/marketplace/src/order/order.event.ts`field.route.label/docs/reference/marketplace/marketplace.order.paid
referencepublic
field.summary.labelAn order has been shipped.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @marketplace-team
- **Tags**: marketplace, order
- **File**: `packages/examples/marketplace/src/order/order.event.ts`field.route.label/docs/reference/marketplace/marketplace.order.shipped
referencepublic
field.summary.labelAn order status has been updated.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @marketplace-team
- **Tags**: marketplace, order
- **File**: `packages/examples/marketplace/src/order/order.event.ts`field.route.label/docs/reference/marketplace/marketplace.order.statusUpdated
referencepublic
field.summary.labelUpdate order status.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @example.marketplace
- **Tags**: marketplace, order, status
- **File**: `packages/examples/marketplace/src/order/order.operations.ts`field.route.label/docs/reference/marketplace/marketplace.order.updateStatus
referencepublic
field.summary.labelA payout has been created.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @marketplace-team
- **Tags**: marketplace, payout
- **File**: `packages/examples/marketplace/src/payout/payout.event.ts`field.route.label/docs/reference/marketplace/marketplace.payout.created
referencepublic
field.summary.labelPayout detail with breakdown
- **Type**: presentation (presentation)
- **Version**: 1.0.0
- **Owners**: @marketplace-team
- **Tags**: marketplace, payout, detail
- **File**: `packages/examples/marketplace/src/payout/payout.presentation.ts`field.route.label/docs/reference/marketplace/marketplace.payout.detail
referencepublic
field.summary.labelList payouts for a store.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @example.marketplace
- **Tags**: marketplace, payout, list
- **File**: `packages/examples/marketplace/src/payout/payout.operations.ts`field.route.label/docs/reference/marketplace/marketplace.payout.list
referencepublic
field.summary.labelTest for listing payouts
- **Type**: test-spec (test-spec)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @example.marketplace
- **Tags**: test
- **File**: `packages/examples/marketplace/src/tests/operations.test-spec.ts`field.route.label/docs/reference/marketplace/marketplace.payout.list.test
referencepublic
field.summary.labelA payout has been sent.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @marketplace-team
- **Tags**: marketplace, payout
- **File**: `packages/examples/marketplace/src/payout/payout.event.ts`field.route.label/docs/reference/marketplace/marketplace.payout.paid
referencepublic
field.summary.labelList of payouts for sellers
- **Type**: presentation (presentation)
- **Version**: 1.0.0
- **Owners**: @marketplace-team
- **Tags**: marketplace, payout, list
- **File**: `packages/examples/marketplace/src/payout/payout.presentation.ts`field.route.label/docs/reference/marketplace/marketplace.payout.viewList
referencepublic
field.summary.labelProduct catalog with search and filters
- **Type**: presentation (presentation)
- **Version**: 1.0.0
- **Owners**: @marketplace-team
- **Tags**: marketplace, product, catalog
- **File**: `packages/examples/marketplace/src/product/product.presentation.ts`field.route.label/docs/reference/marketplace/marketplace.product.catalog
referencepublic
field.summary.labelCreate a new product listing.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @example.marketplace
- **Tags**: marketplace, product, create
- **File**: `packages/examples/marketplace/src/product/product.operations.ts`field.route.label/docs/reference/marketplace/marketplace.product.create
referencepublic
field.summary.labelA new product has been created.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @marketplace-team
- **Tags**: marketplace, product
- **File**: `packages/examples/marketplace/src/product/product.event.ts`field.route.label/docs/reference/marketplace/marketplace.product.created
referencepublic
field.summary.labelProduct detail page with images and reviews
- **Type**: presentation (presentation)
- **Version**: 1.0.0
- **Owners**: @marketplace-team
- **Tags**: marketplace, product, detail
- **File**: `packages/examples/marketplace/src/product/product.presentation.ts`field.route.label/docs/reference/marketplace/marketplace.product.detail
referencepublic
field.summary.labelProduct editor for sellers
- **Type**: presentation (presentation)
- **Version**: 1.0.0
- **Owners**: @marketplace-team
- **Tags**: marketplace, product, editor
- **File**: `packages/examples/marketplace/src/product/product.presentation.ts`field.route.label/docs/reference/marketplace/marketplace.product.editor
referencepublic
field.summary.labelList products with filters.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @example.marketplace
- **Tags**: marketplace, product, list
- **File**: `packages/examples/marketplace/src/product/product.operations.ts`field.route.label/docs/reference/marketplace/marketplace.product.list
referencepublic
field.summary.labelTest for listing products
- **Type**: test-spec (test-spec)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @example.marketplace
- **Tags**: test
- **File**: `packages/examples/marketplace/src/tests/operations.test-spec.ts`field.route.label/docs/reference/marketplace/marketplace.product.list.test
referencepublic
field.summary.labelA product has been published.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @marketplace-team
- **Tags**: marketplace, product
- **File**: `packages/examples/marketplace/src/product/product.event.ts`field.route.label/docs/reference/marketplace/marketplace.product.published
referencepublic
field.summary.labelCreate a product/store review.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @example.marketplace
- **Tags**: marketplace, review, create
- **File**: `packages/examples/marketplace/src/review/review.operations.ts`field.route.label/docs/reference/marketplace/marketplace.review.create
referencepublic
field.summary.labelTest for creating review
- **Type**: test-spec (test-spec)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @example.marketplace
- **Tags**: test
- **File**: `packages/examples/marketplace/src/tests/operations.test-spec.ts`field.route.label/docs/reference/marketplace/marketplace.review.create.test
referencepublic
field.summary.labelA review has been created.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @marketplace-team
- **Tags**: marketplace, review
- **File**: `packages/examples/marketplace/src/review/review.event.ts`field.route.label/docs/reference/marketplace/marketplace.review.created
referencepublic
field.summary.labelForm for submitting product reviews
- **Type**: presentation (presentation)
- **Version**: 1.0.0
- **Owners**: @marketplace-team
- **Tags**: marketplace, review, form
- **File**: `packages/examples/marketplace/src/review/review.presentation.ts`field.route.label/docs/reference/marketplace/marketplace.review.form
referencepublic
field.summary.labelList reviews with filters.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @example.marketplace
- **Tags**: marketplace, review, list
- **File**: `packages/examples/marketplace/src/review/review.operations.ts`field.route.label/docs/reference/marketplace/marketplace.review.list
referencepublic
field.summary.labelTest for listing reviews
- **Type**: test-spec (test-spec)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @example.marketplace
- **Tags**: test
- **File**: `packages/examples/marketplace/src/tests/operations.test-spec.ts`field.route.label/docs/reference/marketplace/marketplace.review.list.test
referencepublic
field.summary.labelA seller has responded to a review.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @marketplace-team
- **Tags**: marketplace, review
- **File**: `packages/examples/marketplace/src/review/review.event.ts`field.route.label/docs/reference/marketplace/marketplace.review.responded
referencepublic
field.summary.labelList of product reviews
- **Type**: presentation (presentation)
- **Version**: 1.0.0
- **Owners**: @marketplace-team
- **Tags**: marketplace, review, list
- **File**: `packages/examples/marketplace/src/review/review.presentation.ts`field.route.label/docs/reference/marketplace/marketplace.review.viewList
referencepublic
field.summary.labelSeller dashboard with sales and analytics
- **Type**: presentation (presentation)
- **Version**: 1.0.0
- **Owners**: @marketplace-team
- **Tags**: marketplace, seller, dashboard
- **File**: `packages/examples/marketplace/src/store/store.presentation.ts`field.route.label/docs/reference/marketplace/marketplace.seller.dashboard
referencepublic
field.summary.labelCreate a new seller store.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @example.marketplace
- **Tags**: marketplace, store, create
- **File**: `packages/examples/marketplace/src/store/store.operations.ts`field.route.label/docs/reference/marketplace/marketplace.store.create
referencepublic
field.summary.labelA new seller store has been created.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @marketplace-team
- **Tags**: marketplace, store
- **File**: `packages/examples/marketplace/src/store/store.event.ts`field.route.label/docs/reference/marketplace/marketplace.store.created
referencepublic
field.summary.labelPublic store profile page
- **Type**: presentation (presentation)
- **Version**: 1.0.0
- **Owners**: @marketplace-team
- **Tags**: marketplace, store, profile
- **File**: `packages/examples/marketplace/src/store/store.presentation.ts`field.route.label/docs/reference/marketplace/marketplace.store.profile
referencepublic
field.summary.labelA store status has changed.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @marketplace-team
- **Tags**: marketplace, store
- **File**: `packages/examples/marketplace/src/store/store.event.ts`field.route.label/docs/reference/marketplace/marketplace.store.statusChanged
referencepublic
field.summary.labelPayment processing and payouts
- **Type**: capability (capability)
- **Version**: 1.0.0
- **Owners**: platform.finance
- **Tags**: payments, finance
- **File**: `packages/examples/marketplace/src/marketplace.capability.ts`field.route.label/docs/reference/marketplace/payments
referencepublic
field.summary.labelMeeting metadata, transcript retrieval, and webhook ingestion for meeting recorder providers.
- **Type**: feature
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @platform.integrations
- **Tags**: meeting-recorder, transcripts, integrationsfield.route.label/docs/reference/meeting-recorder/meeting-recorder
referencepublic
field.summary.labelRetrieve metadata for a single meeting recording.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @platform.integrations
- **Tags**: meeting-recorder, meetingsfield.route.label/docs/reference/meeting-recorder/meeting-recorder.meetings.get
referencepublic
field.summary.labelList meetings recorded by the configured meeting provider.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @platform.integrations
- **Tags**: meeting-recorder, meetings, transcriptsfield.route.label/docs/reference/meeting-recorder/meeting-recorder.meetings.list
referencepublic
field.summary.labelFetch the transcript for a specific meeting recording.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @platform.integrations
- **Tags**: meeting-recorder, transcriptsfield.route.label/docs/reference/meeting-recorder/meeting-recorder.transcripts.get
referencepublic
field.summary.labelTrigger a transcript sync from the meeting recorder provider.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @platform.integrations
- **Tags**: meeting-recorder, transcripts, syncfield.route.label/docs/reference/meeting-recorder/meeting-recorder.transcripts.sync
referencepublic
field.summary.labelIngest a webhook from a meeting recorder provider.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @platform.integrations
- **Tags**: meeting-recorder, webhooks, transcriptsfield.route.label/docs/reference/meeting-recorder/meeting-recorder.webhooks.ingest
referencepublic
field.summary.labelMeeting recorder provider integration with transcripts and webhook handling
- **Type**: feature
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @examples
- **Tags**: meeting, recorder, transcripts, webhooksfield.route.label/docs/reference/meeting-recorder-providers/meeting-recorder-providers
referencepublic
field.summary.labelSafe messaging automation with fixed intents, allowlisted actions, and workflow dispatch.
- **Type**: feature
- **Version**: 1.0.0
- **Stability**: beta
- **Owners**: @platform.messaging
- **Tags**: messaging, agents, actions, workflowfield.route.label/docs/reference/messaging-agent-actions/messaging-agent-actions
referencepublic
field.summary.labelClassify an inbound message into a fixed allowlisted action or workflow path and return a safe confirmation reply.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: beta
- **Owners**: @platform.messagingfield.route.label/docs/reference/messaging-agent-actions/messaging.agentActions.process
referencepublic
field.summary.labelUsage metering and tracking
- **Type**: capability (capability)
- **Version**: 1.0.0
- **Owners**: @platform.finance
- **Tags**: metering, usage, billing
- **File**: `packages/libs/metering/src/metering.capability.ts`field.route.label/docs/reference/metrics/metering
referencepublic
field.summary.labelDefine a new usage metric.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: platform.metering
- **Tags**: metering, metric, define
- **File**: `packages/libs/metering/src/contracts/index.ts`field.route.label/docs/reference/metrics/metric.define
referencepublic
field.summary.labelA metric has been defined.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @platform.metering
- **Tags**: metering, metric
- **File**: `packages/libs/metering/src/events.ts`field.route.label/docs/reference/metrics/metric.defined
referencepublic
field.summary.labelDelete a metric definition.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: platform.metering
- **Tags**: metering, metric, delete
- **File**: `packages/libs/metering/src/contracts/index.ts`field.route.label/docs/reference/metrics/metric.delete
referencepublic
field.summary.labelGet a metric by key.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: platform.metering
- **Tags**: metering, metric, get
- **File**: `packages/libs/metering/src/contracts/index.ts`field.route.label/docs/reference/metrics/metric.get
referencepublic
field.summary.labelList all metrics.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: platform.metering
- **Tags**: metering, metric, list
- **File**: `packages/libs/metering/src/contracts/index.ts`field.route.label/docs/reference/metrics/metric.list
referencepublic
field.summary.labelUpdate a metric definition.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: platform.metering
- **Tags**: metering, metric, update
- **File**: `packages/libs/metering/src/contracts/index.ts`field.route.label/docs/reference/metrics/metric.update
referencepublic
field.summary.labelA metric has been updated.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @platform.metering
- **Tags**: metering, metric
- **File**: `packages/libs/metering/src/events.ts`field.route.label/docs/reference/metrics/metric.updated
referencepublic
field.summary.labelUsage metering, metric definitions, and threshold alerting
- **Type**: feature
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @platform.metering
- **Tags**: metering, usage, billing, thresholds
- **File**: `packages/libs/metering/src/metering.feature.ts`field.route.label/docs/reference/metrics/metrics
referencepublic
field.summary.labelAn AI model has been selected via ranking-driven selection.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @platform.metering
- **Tags**: metering, ai, model-selectionfield.route.label/docs/reference/metrics/model.selected
referencepublic
field.summary.labelUsage is approaching a threshold.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @platform.metering
- **Tags**: metering, threshold
- **File**: `packages/libs/metering/src/events.ts`field.route.label/docs/reference/metrics/threshold.approaching
referencepublic
field.summary.labelCreate a usage threshold.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: platform.metering
- **Tags**: metering, threshold, create
- **File**: `packages/libs/metering/src/contracts/index.ts`field.route.label/docs/reference/metrics/threshold.create
referencepublic
field.summary.labelA usage threshold has been created.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @platform.metering
- **Tags**: metering, threshold
- **File**: `packages/libs/metering/src/events.ts`field.route.label/docs/reference/metrics/threshold.created
referencepublic
field.summary.labelDelete a threshold.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: platform.metering
- **Tags**: metering, threshold, delete
- **File**: `packages/libs/metering/src/contracts/index.ts`field.route.label/docs/reference/metrics/threshold.delete
referencepublic
field.summary.labelUsage has exceeded a threshold.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @platform.metering
- **Tags**: metering, threshold
- **File**: `packages/libs/metering/src/events.ts`field.route.label/docs/reference/metrics/threshold.exceeded
referencepublic
field.summary.labelList usage thresholds.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: platform.metering
- **Tags**: metering, threshold, list
- **File**: `packages/libs/metering/src/contracts/index.ts`field.route.label/docs/reference/metrics/threshold.list
referencepublic
field.summary.labelUpdate a threshold.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: platform.metering
- **Tags**: metering, threshold, update
- **File**: `packages/libs/metering/src/contracts/index.ts`field.route.label/docs/reference/metrics/threshold.update
referencepublic
field.summary.labelUsage threshold alerts and limits
- **Type**: capability (capability)
- **Version**: 1.0.0
- **Owners**: @platform.finance
- **Tags**: thresholds, limits, metering
- **File**: `packages/libs/metering/src/metering.capability.ts`field.route.label/docs/reference/metrics/thresholds
referencepublic
field.summary.labelUsage has been aggregated into a summary.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @platform.metering
- **Tags**: metering, usage
- **File**: `packages/libs/metering/src/events.ts`field.route.label/docs/reference/metrics/usage.aggregated
referencepublic
field.summary.labelA batch of usage has been recorded.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @platform.metering
- **Tags**: metering, usage
- **File**: `packages/libs/metering/src/events.ts`field.route.label/docs/reference/metrics/usage.batch_recorded
referencepublic
field.summary.labelGet usage records for a subject.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: platform.metering
- **Tags**: metering, usage, get
- **File**: `packages/libs/metering/src/contracts/index.ts`field.route.label/docs/reference/metrics/usage.get
referencepublic
field.summary.labelGet aggregated usage summary.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: platform.metering
- **Tags**: metering, usage, summary
- **File**: `packages/libs/metering/src/contracts/index.ts`field.route.label/docs/reference/metrics/usage.getSummary
referencepublic
field.summary.labelRecord a usage event.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: platform.metering
- **Tags**: metering, usage, record
- **File**: `packages/libs/metering/src/contracts/index.ts`field.route.label/docs/reference/metrics/usage.record
referencepublic
field.summary.labelRecord multiple usage events.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: platform.metering
- **Tags**: metering, usage, batch
- **File**: `packages/libs/metering/src/contracts/index.ts`field.route.label/docs/reference/metrics/usage.recordBatch
referencepublic
field.summary.labelUsage has been recorded.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @platform.metering
- **Tags**: metering, usage
- **File**: `packages/libs/metering/src/events.ts`field.route.label/docs/reference/metrics/usage.recorded
referencepublic
field.summary.labelBare-minimum contract definition showing the simplest possible setup
- **Type**: feature
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @team
- **Tags**: minimal, example
- **File**: `packages/examples/minimal/src/minimal.feature.ts`field.route.label/docs/reference/minimal/minimal
referencepublic
field.summary.labelCreate a new user account with the provided email
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @team
- **Tags**: user
- **File**: `packages/examples/minimal/src/contracts/user.ts`field.route.label/docs/reference/minimal/user.create
referencepublic
field.summary.labelExpo Router companion for the shared ContractSpec OSS-first product story and public navigation.
- **Type**: feature
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @platform.core
- **Tags**: mobile, expo, landing, marketingfield.route.label/docs/reference/mobile-monolith.landing/mobile-monolith.landing
referencepublic
field.summary.labelResolve a landing companion CTA id to a native route or URL.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @platform.core
- **Tags**: mobile, expo, landing, ctafield.route.label/docs/reference/mobile-monolith.landing/mobileLanding.cta.resolve
referencepublic
field.summary.labelList native navigation items for the Expo landing companion.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @platform.core
- **Tags**: mobile, expo, landing, navigationfield.route.label/docs/reference/mobile-monolith.landing/mobileLanding.navigation.list
referencepublic
field.summary.labelGet content for a native landing companion route.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @platform.core
- **Tags**: mobile, expo, landing, page
- **File**: `packages/apps/mobile-monolith/src/contracts/mobile-landing.contract.ts`field.route.label/docs/reference/mobile-monolith.landing/mobileLanding.page.get
referencepublic
field.summary.labelGet the shared ContractSpec landing story for Expo.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @platform.core
- **Tags**: mobile, expo, landing, marketingfield.route.label/docs/reference/mobile-monolith.landing/mobileLanding.story.get
referencepublic
field.summary.labelMulti-channel notification delivery with preference management
- **Type**: feature
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @platform.notifications
- **Tags**: notifications, email, push, in-appfield.route.label/docs/reference/notifications/notifications
referencepublic
field.summary.labelDelete a notification.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: platform.notifications
- **Tags**: notifications, delete
- **File**: `packages/modules/notifications/src/contracts/index.ts`field.route.label/docs/reference/notifications/notifications.delete
referencepublic
field.summary.labelList notifications for the current user.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: platform.notifications
- **Tags**: notifications, list
- **File**: `packages/modules/notifications/src/contracts/index.ts`field.route.label/docs/reference/notifications/notifications.list
referencepublic
field.summary.labelMark all notifications as read.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: platform.notifications
- **Tags**: notifications, read
- **File**: `packages/modules/notifications/src/contracts/index.ts`field.route.label/docs/reference/notifications/notifications.markAllRead
referencepublic
field.summary.labelMark a notification as read.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: platform.notifications
- **Tags**: notifications, read
- **File**: `packages/modules/notifications/src/contracts/index.ts`field.route.label/docs/reference/notifications/notifications.markRead
referencepublic
field.summary.labelGet notification preferences for current user.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: platform.notifications
- **Tags**: notifications, preferences, get
- **File**: `packages/modules/notifications/src/contracts/index.ts`field.route.label/docs/reference/notifications/notifications.preferences.get
referencepublic
field.summary.labelUpdate notification preferences.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: platform.notifications
- **Tags**: notifications, preferences, update
- **File**: `packages/modules/notifications/src/contracts/index.ts`field.route.label/docs/reference/notifications/notifications.preferences.update
referencepublic
field.summary.labelSend a notification to a user.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: platform.notifications
- **Tags**: notifications, send
- **File**: `packages/modules/notifications/src/contracts/index.ts`field.route.label/docs/reference/notifications/notifications.send
referencepublic
field.summary.labelOpen banking account sync, balance refresh, and transaction synchronization
- **Type**: feature
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @platform.finance
- **Tags**: open-banking, powens, finance, bankingfield.route.label/docs/reference/openbanking/openbanking
referencepublic
field.summary.labelRetrieve the canonical bank account record for the given account identifier.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @platform.finance
- **Tags**: open-banking, powens, accountsfield.route.label/docs/reference/openbanking/openbanking.accounts.get
referencepublic
field.summary.labelList bank accounts available to a tenant/user via Powens Open Banking.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @platform.finance
- **Tags**: open-banking, powens, accountsfield.route.label/docs/reference/openbanking/openbanking.accounts.list
referencepublic
field.summary.labelInitiate a synchronisation run to refresh bank account metadata from Powens.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @platform.finance
- **Tags**: open-banking, powens, accountsfield.route.label/docs/reference/openbanking/openbanking.accounts.sync
referencepublic
field.summary.labelRetrieve the latest cached balances for a bank account.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @platform.finance
- **Tags**: open-banking, powens, balancesfield.route.label/docs/reference/openbanking/openbanking.balances.get
referencepublic
field.summary.labelRefresh balances for a bank account via the configured open banking provider.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @platform.finance
- **Tags**: open-banking, powens, balancesfield.route.label/docs/reference/openbanking/openbanking.balances.refresh
referencepublic
field.summary.labelList bank transactions that have been normalised into the canonical ledger.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @platform.finance
- **Tags**: open-banking, powens, transactionsfield.route.label/docs/reference/openbanking/openbanking.transactions.list
referencepublic
field.summary.labelSynchronise transactions for a bank account by calling the configured open banking provider.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @platform.financefield.route.label/docs/reference/openbanking/openbanking.transactions.sync
referencepublic
field.summary.labelPowens open banking OAuth callback and webhook handler patterns
- **Type**: feature
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @examples
- **Tags**: openbanking, powens, oauth, webhooksfield.route.label/docs/reference/openbanking-powens/openbanking-powens
referencepublic
field.summary.labelAgent-mode contract building and validation for the OpenCode CLI
- **Type**: feature
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @lssm-tech/examples
- **Tags**: opencode, example, cli
- **File**: `packages/examples/opencode-cli/src/opencode-cli.feature.ts`field.route.label/docs/reference/opencode-cli/opencode-cli
referencepublic
field.summary.labelEcho a prompt for the OpenCode CLI example.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @lssm-tech/examples
- **Tags**: opencode, example, echo
- **File**: `packages/examples/opencode-cli/src/contracts/opencode.contracts.ts`field.route.label/docs/reference/opencode-cli/opencode.example.echo
referencepublic
field.summary.labelBehavior tracking, overlay customization, and workflow extension patterns
- **Type**: feature
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @examples
- **Tags**: personalization, behavior, overlay, workflowfield.route.label/docs/reference/personalization/personalization
referencepublic
field.summary.labelPerform file system access within an ACP session.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Tags**: filesystem
- **File**: `packages/libs/contracts-spec/src/acp/commands/acpFsAccess.command.ts`field.route.label/docs/reference/platform.acp/acp.fs.access
referencepublic
field.summary.labelExecute a prompt turn within an ACP session.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Tags**: prompt
- **File**: `packages/libs/contracts-spec/src/acp/commands/acpPromptTurn.command.ts`
Run ACP prompt turns with tool calls and structured outputs.field.route.label/docs/reference/platform.acp/acp.prompt.turn
referencepublic
field.summary.labelInitialize a new ACP session.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Tags**: session
- **File**: `packages/libs/contracts-spec/src/acp/commands/acpSessionInit.command.ts`
Start a governed ACP session with configured tools and policies.field.route.label/docs/reference/platform.acp/acp.session.init
referencepublic
field.summary.labelResume an existing ACP session.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Tags**: session
- **File**: `packages/libs/contracts-spec/src/acp/commands/acpSessionResume.command.ts`
Continue a previously initialized ACP session with full context.field.route.label/docs/reference/platform.acp/acp.session.resume
referencepublic
field.summary.labelStop an active ACP session.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Tags**: session
- **File**: `packages/libs/contracts-spec/src/acp/commands/acpSessionStop.command.ts`
Terminate ACP sessions cleanly with audit trails.field.route.label/docs/reference/platform.acp/acp.session.stop
referencepublic
field.summary.labelExecute a terminal command within an ACP session.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Tags**: terminal
- **File**: `packages/libs/contracts-spec/src/acp/commands/acpTerminalExec.command.ts`field.route.label/docs/reference/platform.acp/acp.terminal.exec
referencepublic
field.summary.labelExecute tool calls within an ACP session.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Tags**: tools
- **File**: `packages/libs/contracts-spec/src/acp/commands/acpToolCalls.command.ts`
Run tool calls with safe governance and telemetry.field.route.label/docs/reference/platform.acp/acp.tool.calls
referencepublic
field.summary.labelAgent Client Protocol transport surfaces.
- **Type**: capability (capability)
- **Version**: 1.0.0
- **Tags**: transport
- **File**: `packages/libs/contracts-spec/src/acp/capabilities/acpTransport.capability.ts`field.route.label/docs/reference/platform.acp/acp.transport
referencepublic
field.summary.labelPerforms file system access with policy gating.field.route.label/docs/reference/platform.acp/docs.tech.acp.fs.access
referencepublic
field.summary.labelRuns a prompt turn and returns structured outputs and tool calls.field.route.label/docs/reference/platform.acp/docs.tech.acp.prompt.turn
referencepublic
field.summary.labelCreates a new ACP session and returns session metadata.field.route.label/docs/reference/platform.acp/docs.tech.acp.session.init
referencepublic
field.summary.labelResumes a previously initialized ACP session.field.route.label/docs/reference/platform.acp/docs.tech.acp.session.resume
referencepublic
field.summary.labelStops an active ACP session with audit trails.field.route.label/docs/reference/platform.acp/docs.tech.acp.session.stop
referencepublic
field.summary.labelExecutes terminal commands in a governed ACP session.field.route.label/docs/reference/platform.acp/docs.tech.acp.terminal.exec
referencepublic
field.summary.labelExecutes tool calls with governance and telemetry.field.route.label/docs/reference/platform.acp/docs.tech.acp.tool.calls
referencepublic
field.summary.labelDefines the ContractSpec ACP server + client surfaces for HTTP streamable transport.field.route.label/docs/reference/platform.acp/docs.tech.acp.transport
referencepublic
field.summary.labelSession management and transport operations for agent communication (prompt turns, tool calls, terminal exec, fs access)
- **Type**: feature
- **Version**: 1.0.0
- **File**: `packages/libs/contracts-spec/src/acp/acp.feature.ts`field.route.label/docs/reference/platform.acp/platform.acp
referencepublic
field.summary.labelEmitted when an approval is required for an agent action.
- **Type**: event (event)
- **Version**: 1.0.0
- **Tags**: approval
- **File**: `packages/libs/contracts-spec/src/agent/events/agentApprovalRequested.event.ts`field.route.label/docs/reference/platform.agent/agent.approval.requested
referencepublic
field.summary.labelApprove or reject an agent step or run.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Tags**: approval
- **File**: `packages/libs/contracts-spec/src/agent/commands/agentApprovals.command.ts`
Provide governed human-in-the-loop control for risky steps.field.route.label/docs/reference/platform.agent/agent.approvals
referencepublic
field.summary.labelList artifacts produced by an agent run.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Tags**: artifacts
- **File**: `packages/libs/contracts-spec/src/agent/queries/agentArtifacts.query.ts`
Provide traceable outputs for audits and UI surfaces.field.route.label/docs/reference/platform.agent/agent.artifacts
referencepublic
field.summary.labelCancel an in-flight agent run.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Tags**: run, cancel
- **File**: `packages/libs/contracts-spec/src/agent/commands/agentCancel.command.ts`
Provide safe operator control to stop background agents.field.route.label/docs/reference/platform.agent/agent.cancel
referencepublic
field.summary.labelBackground agent execution, approvals, and artifacts.
- **Type**: capability (capability)
- **Version**: 1.0.0
- **Tags**: execution
- **File**: `packages/libs/contracts-spec/src/agent/capabilities/agentExecution.capability.ts`field.route.label/docs/reference/platform.agent/agent.execution
referencepublic
field.summary.labelSubmit a background agent run with a context snapshot.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Tags**: run
- **File**: `packages/libs/contracts-spec/src/agent/commands/agentRun.command.ts`field.route.label/docs/reference/platform.agent/agent.run
referencepublic
field.summary.labelAudit layout for agent runs and artifacts.
- **Type**: presentation (presentation)
- **Version**: 1.0.0
- **Tags**: audit
- **File**: `packages/libs/contracts-spec/src/agent/presentations/agentRunAudit.presentation.ts`field.route.label/docs/reference/platform.agent/agent.run.audit
referencepublic
field.summary.labelEmitted when an agent run completes successfully.
- **Type**: event (event)
- **Version**: 1.0.0
- **Tags**: run
- **File**: `packages/libs/contracts-spec/src/agent/events/agentRunCompleted.event.ts`
```typescriptfield.route.label/docs/reference/platform.agent/agent.run.completed
referencepublic
field.summary.labelEmitted when an agent run fails.
- **Type**: event (event)
- **Version**: 1.0.0
- **Tags**: run
- **File**: `packages/libs/contracts-spec/src/agent/events/agentRunFailed.event.ts`
```typescript
import { ScalarTypeEnum, SchemaModel } from '@lssm-tech/lib.schema';field.route.label/docs/reference/platform.agent/agent.run.failed
referencepublic
field.summary.labelForm to launch a background agent run.
- **Type**: form (form)
- **Version**: 1.0.0
- **Tags**: run
- **File**: `packages/libs/contracts-spec/src/agent/forms/agentRun.form.ts`
```typescript
import { ScalarTypeEnum, SchemaModel } from '@lssm-tech/lib.schema';field.route.label/docs/reference/platform.agent/agent.run.form
referencepublic
field.summary.labelEmitted when an agent run starts executing.
- **Type**: event (event)
- **Version**: 1.0.0
- **Tags**: run
- **File**: `packages/libs/contracts-spec/src/agent/events/agentRunStarted.event.ts`
```typescript
import { ScalarTypeEnum, SchemaModel } from '@lssm-tech/lib.schema';field.route.label/docs/reference/platform.agent/agent.run.started
referencepublic
field.summary.labelGet status for agent runs.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Tags**: status
- **File**: `packages/libs/contracts-spec/src/agent/queries/agentStatus.query.ts`
Provide status and progress visibility for background agents.field.route.label/docs/reference/platform.agent/agent.status
referencepublic
field.summary.labelEmitted when an approval gate is triggered.field.route.label/docs/reference/platform.agent/docs.tech.agent.approval.requested
referencepublic
field.summary.labelApprove or reject a pending agent action.field.route.label/docs/reference/platform.agent/docs.tech.agent.approvals
referencepublic
field.summary.labelLists files, diffs, and outputs produced during agent execution.field.route.label/docs/reference/platform.agent/docs.tech.agent.artifacts
referencepublic
field.summary.labelStops an active agent run and records cancellation metadata.field.route.label/docs/reference/platform.agent/docs.tech.agent.cancel
referencepublic
field.summary.labelDefines the core operations, events, and UI surfaces for background agent runs with auditability and approvals.field.route.label/docs/reference/platform.agent/docs.tech.agent.execution
referencepublic
field.summary.labelCreates a new agent run with a context snapshot and execution metadata.field.route.label/docs/reference/platform.agent/docs.tech.agent.run
referencepublic
field.summary.labelPresentation surface used to inspect run provenance, tools, approvals, and outputs.field.route.label/docs/reference/platform.agent/docs.tech.agent.run.audit
referencepublic
field.summary.labelEmitted when a run completes successfully.field.route.label/docs/reference/platform.agent/docs.tech.agent.run.completed
referencepublic
field.summary.labelEmitted when a run terminates with failure.field.route.label/docs/reference/platform.agent/docs.tech.agent.run.failed
referencepublic
field.summary.labelForm surface used by Studio to submit agent runs.field.route.label/docs/reference/platform.agent/docs.tech.agent.run.form
referencepublic
field.summary.labelEmitted when an agent run begins execution.field.route.label/docs/reference/platform.agent/docs.tech.agent.run.started
referencepublic
field.summary.labelReturns status summaries for one or many agent runs.field.route.label/docs/reference/platform.agent/docs.tech.agent.status
referencepublic
field.summary.labelRun, cancel, and approve AI agent executions with full audit trail
- **Type**: feature
- **Version**: 1.0.0
- **Tags**: agent, execution
- **File**: `packages/libs/contracts-spec/src/agent/agent.feature.ts`field.route.label/docs/reference/platform.agent/platform.agent
referencepublic
field.summary.labelDescribe a context pack and its sources.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Tags**: pack, describe
- **File**: `packages/libs/contracts-spec/src/context/queries/contextPackDescribe.query.ts`field.route.label/docs/reference/platform.context/context.pack.describe
referencepublic
field.summary.labelSearch and filter context packs and snapshots.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Tags**: pack, search
- **File**: `packages/libs/contracts-spec/src/context/queries/contextPackSearch.query.ts`field.route.label/docs/reference/platform.context/context.pack.search
referencepublic
field.summary.labelSearch form for context packs and snapshots.
- **Type**: form (form)
- **Version**: 1.0.0
- **Tags**: search
- **File**: `packages/libs/contracts-spec/src/context/forms/contextPackSearch.form.ts`
```typescriptfield.route.label/docs/reference/platform.context/context.pack.search.form
referencepublic
field.summary.labelCreate an immutable snapshot from a context pack.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Tags**: snapshot, create
- **File**: `packages/libs/contracts-spec/src/context/commands/contextPackSnapshot.command.ts`field.route.label/docs/reference/platform.context/context.pack.snapshot
referencepublic
field.summary.labelEmitted when a context snapshot is created.
- **Type**: event (event)
- **Version**: 1.0.0
- **Tags**: snapshot
- **File**: `packages/libs/contracts-spec/src/context/events/contextSnapshotCreated.event.ts`field.route.label/docs/reference/platform.context/context.snapshot.created
referencepublic
field.summary.labelSummary layout for context snapshots.
- **Type**: presentation (presentation)
- **Version**: 1.0.0
- **Tags**: snapshot, summary
- **File**: `packages/libs/contracts-spec/src/context/presentations/contextSnapshot.presentation.ts`field.route.label/docs/reference/platform.context/context.snapshot.summary
referencepublic
field.summary.labelContext packs, snapshots, and discovery surfaces.
- **Type**: capability (capability)
- **Version**: 1.0.0
- **Tags**: system
- **File**: `packages/libs/contracts-spec/src/context/capabilities/contextSystem.capability.ts`field.route.label/docs/reference/platform.context/context.system
referencepublic
field.summary.labelReturns a canonical view of a context pack, including sources and ownership metadata.field.route.label/docs/reference/platform.context/docs.tech.context.pack.describe
referencepublic
field.summary.labelSearch context packs and surface their latest snapshot details for discovery and UI lists.field.route.label/docs/reference/platform.context/docs.tech.context.pack.search
referencepublic
field.summary.labelForm specification for searching context packs by query, tag, or owner.field.route.label/docs/reference/platform.context/docs.tech.context.pack.search.form
referencepublic
field.summary.labelCreates a versioned snapshot that is used as the immutable context for agent execution.field.route.label/docs/reference/platform.context/docs.tech.context.pack.snapshot
referencepublic
field.summary.labelEmitted when a new snapshot has been persisted and is ready for use.field.route.label/docs/reference/platform.context/docs.tech.context.snapshot.created
referencepublic
field.summary.labelDefines the presentation surface for snapshot summaries across UI channels.field.route.label/docs/reference/platform.context/docs.tech.context.snapshot.presentation
referencepublic
field.summary.labelThe context system defines how ContractSpec bundles DocBlocks, contracts, knowledge spaces, and data views into deterministic snapshots.field.route.label/docs/reference/platform.context/docs.tech.context.system
referencepublic
field.summary.labelSnapshot, search, and describe context packs for AI-driven workflows
- **Type**: feature
- **Version**: 1.0.0
- **File**: `packages/libs/contracts-spec/src/context/context.feature.ts`
- `context.pack.snapshot` (v1.0.0)field.route.label/docs/reference/platform.context/platform.context
referencepublic
field.summary.labelApplies contract-backed blocked, assist, and autonomous routing for inbound messaging events.
- **Type**: policy (policy)
- **Version**: 2.0.0
- **Tags**: policy, messaging
- **File**: `packages/libs/contracts-spec/src/control-plane/policies/controlPlaneMessaging.policy.ts`field.route.label/docs/reference/platform.control-plane/channel.messaging-policy
referencepublic
field.summary.labelHuman approval and rejection gates for execution steps.
- **Type**: capability (capability)
- **Version**: 1.0.0
- **Tags**: approval
- **File**: `packages/libs/contracts-spec/src/control-plane/capabilities/controlPlaneApproval.capability.ts`field.route.label/docs/reference/platform.control-plane/control-plane.approval
referencepublic
field.summary.labelTrace, policy explanation, and replay-grade observability.
- **Type**: capability (capability)
- **Version**: 1.0.0
- **Tags**: audit
- **File**: `packages/libs/contracts-spec/src/control-plane/capabilities/controlPlaneAudit.capability.ts`field.route.label/docs/reference/platform.control-plane/control-plane.audit
referencepublic
field.summary.labelChannel-facing runtime surfaces for controlled execution.
- **Type**: capability (capability)
- **Version**: 1.0.0
- **Tags**: channels
- **File**: `packages/libs/contracts-spec/src/control-plane/capabilities/controlPlaneChannelRuntime.capability.ts`field.route.label/docs/reference/platform.control-plane/control-plane.channel-runtime
referencepublic
field.summary.labelCore intent, planning, and execution surfaces.
- **Type**: capability (capability)
- **Version**: 1.0.0
- **Tags**: core
- **File**: `packages/libs/contracts-spec/src/control-plane/capabilities/controlPlaneCore.capability.ts`field.route.label/docs/reference/platform.control-plane/control-plane.core
referencepublic
field.summary.labelSigned skill lifecycle and compatibility governance.
- **Type**: capability (capability)
- **Version**: 1.0.0
- **Tags**: skills
- **File**: `packages/libs/contracts-spec/src/control-plane/capabilities/controlPlaneSkillRegistry.capability.ts`field.route.label/docs/reference/platform.control-plane/control-plane.skill-registry
referencepublic
field.summary.labelAbort an execution-lane run immediately.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Tags**: execution, lane
- **File**: `packages/libs/contracts-spec/src/control-plane/commands/controlPlaneExecutionAbort.command.ts`field.route.label/docs/reference/platform.control-plane/controlPlane.execution.abort
referencepublic
field.summary.labelApprove a pending execution step for continuation.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Tags**: approval
- **File**: `packages/libs/contracts-spec/src/control-plane/commands/controlPlaneExecutionApprove.command.ts`field.route.label/docs/reference/platform.control-plane/controlPlane.execution.approve
referencepublic
field.summary.labelCancel an execution run and transition to terminal state.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Tags**: execution, approval
- **File**: `packages/libs/contracts-spec/src/control-plane/commands/controlPlaneExecutionCancel.command.ts`field.route.label/docs/reference/platform.control-plane/controlPlane.execution.cancel
referencepublic
field.summary.labelEmitted when an execution run finishes successfully.
- **Type**: event (event)
- **Version**: 1.0.0
- **Tags**: execution
- **File**: `packages/libs/contracts-spec/src/control-plane/events/controlPlaneExecutionCompleted.event.ts`field.route.label/docs/reference/platform.control-plane/controlPlane.execution.completed
referencepublic
field.summary.labelExport the evidence set attached to an execution-lane run.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Tags**: execution, evidence
- **File**: `packages/libs/contracts-spec/src/control-plane/commands/controlPlaneExecutionEvidenceExport.command.ts`field.route.label/docs/reference/platform.control-plane/controlPlane.execution.evidence.export
referencepublic
field.summary.labelEmitted when an execution run fails.
- **Type**: event (event)
- **Version**: 1.0.0
- **Tags**: execution, failure
- **File**: `packages/libs/contracts-spec/src/control-plane/events/controlPlaneExecutionFailed.event.ts`field.route.label/docs/reference/platform.control-plane/controlPlane.execution.failed
referencepublic
field.summary.labelFetch the latest state for one execution.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Tags**: execution
- **File**: `packages/libs/contracts-spec/src/control-plane/queries/controlPlaneExecutionGet.query.ts`field.route.label/docs/reference/platform.control-plane/controlPlane.execution.get
referencepublic
field.summary.labelFetch the current state of one execution-lane run.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Tags**: execution, lane
- **File**: `packages/libs/contracts-spec/src/control-plane/queries/controlPlaneExecutionLaneGet.query.ts`field.route.label/docs/reference/platform.control-plane/controlPlane.execution.lane.get
referencepublic
field.summary.labelList execution-lane runs with lane-focused filters.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Tags**: execution, lane
- **File**: `packages/libs/contracts-spec/src/control-plane/queries/controlPlaneExecutionLaneList.query.ts`field.route.label/docs/reference/platform.control-plane/controlPlane.execution.lane.list
referencepublic
field.summary.labelList execution runs with filtering and pagination.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Tags**: execution
- **File**: `packages/libs/contracts-spec/src/control-plane/queries/controlPlaneExecutionList.query.ts`field.route.label/docs/reference/platform.control-plane/controlPlane.execution.list
referencepublic
field.summary.labelPause an active execution-lane run.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Tags**: execution, lane
- **File**: `packages/libs/contracts-spec/src/control-plane/commands/controlPlaneExecutionPause.command.ts`field.route.label/docs/reference/platform.control-plane/controlPlane.execution.pause
referencepublic
field.summary.labelReject a pending execution step.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Tags**: approval
- **File**: `packages/libs/contracts-spec/src/control-plane/commands/controlPlaneExecutionReject.command.ts`field.route.label/docs/reference/platform.control-plane/controlPlane.execution.reject
referencepublic
field.summary.labelResume a paused execution-lane run.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Tags**: execution, lane
- **File**: `packages/libs/contracts-spec/src/control-plane/commands/controlPlaneExecutionResume.command.ts`field.route.label/docs/reference/platform.control-plane/controlPlane.execution.resume
referencepublic
field.summary.labelRetry the current lane execution phase.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Tags**: execution, lane
- **File**: `packages/libs/contracts-spec/src/control-plane/commands/controlPlaneExecutionRetry.command.ts`field.route.label/docs/reference/platform.control-plane/controlPlane.execution.retry
referencepublic
field.summary.labelShutdown an execution-lane run and move it to a terminal state.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Tags**: execution, lane
- **File**: `packages/libs/contracts-spec/src/control-plane/commands/controlPlaneExecutionShutdown.command.ts`field.route.label/docs/reference/platform.control-plane/controlPlane.execution.shutdown
referencepublic
field.summary.labelStart executing an approved compiled plan.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Tags**: execution
- **File**: `packages/libs/contracts-spec/src/control-plane/commands/controlPlaneExecutionStart.command.ts`field.route.label/docs/reference/platform.control-plane/controlPlane.execution.start
referencepublic
field.summary.labelEmitted when policy blocks an execution step.
- **Type**: event (event)
- **Version**: 1.0.0
- **Tags**: execution, blocked
- **File**: `packages/libs/contracts-spec/src/control-plane/events/controlPlaneExecutionStepBlocked.event.ts`field.route.label/docs/reference/platform.control-plane/controlPlane.execution.step.blocked
referencepublic
field.summary.labelEmitted when an execution step completes.
- **Type**: event (event)
- **Version**: 1.0.0
- **Tags**: execution
- **File**: `packages/libs/contracts-spec/src/control-plane/events/controlPlaneExecutionStepCompleted.event.ts`field.route.label/docs/reference/platform.control-plane/controlPlane.execution.step.completed
referencepublic
field.summary.labelEmitted when an execution step starts.
- **Type**: event (event)
- **Version**: 1.0.0
- **Tags**: execution
- **File**: `packages/libs/contracts-spec/src/control-plane/events/controlPlaneExecutionStepStarted.event.ts`field.route.label/docs/reference/platform.control-plane/controlPlane.execution.step.started
referencepublic
field.summary.labelEmitted when a new control plane intent is accepted.
- **Type**: event (event)
- **Version**: 1.0.0
- **Tags**: intent
- **File**: `packages/libs/contracts-spec/src/control-plane/events/controlPlaneIntentReceived.event.ts`field.route.label/docs/reference/platform.control-plane/controlPlane.intent.received
referencepublic
field.summary.labelSubmit a natural-language intent to the control plane.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Tags**: intent
- **File**: `packages/libs/contracts-spec/src/control-plane/commands/controlPlaneIntentSubmit.command.ts`field.route.label/docs/reference/platform.control-plane/controlPlane.intent.submit
referencepublic
field.summary.labelCompile an intent into a deterministic plan DAG.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Tags**: plan
- **File**: `packages/libs/contracts-spec/src/control-plane/commands/controlPlanePlanCompile.command.ts`field.route.label/docs/reference/platform.control-plane/controlPlane.plan.compile
referencepublic
field.summary.labelEmitted when an intent is compiled into an executable plan.
- **Type**: event (event)
- **Version**: 1.0.0
- **Tags**: plan
- **File**: `packages/libs/contracts-spec/src/control-plane/events/controlPlanePlanCompiled.event.ts`field.route.label/docs/reference/platform.control-plane/controlPlane.plan.compiled
referencepublic
field.summary.labelEmitted when a plan fails verification or governance checks.
- **Type**: event (event)
- **Version**: 1.0.0
- **Tags**: plan, governance
- **File**: `packages/libs/contracts-spec/src/control-plane/events/controlPlanePlanRejected.event.ts`field.route.label/docs/reference/platform.control-plane/controlPlane.plan.rejected
referencepublic
field.summary.labelRun policy and risk validation against a compiled plan.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Tags**: plan, governance
- **File**: `packages/libs/contracts-spec/src/control-plane/commands/controlPlanePlanVerify.command.ts`field.route.label/docs/reference/platform.control-plane/controlPlane.plan.verify
referencepublic
field.summary.labelExplain policy outcomes for an execution or step.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Tags**: policy, audit
- **File**: `packages/libs/contracts-spec/src/control-plane/queries/controlPlanePolicyExplain.query.ts`field.route.label/docs/reference/platform.control-plane/controlPlane.policy.explain
referencepublic
field.summary.labelDisable an installed skill in the control plane registry.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Tags**: skills, governance
- **File**: `packages/libs/contracts-spec/src/control-plane/commands/controlPlaneSkillDisable.command.ts`field.route.label/docs/reference/platform.control-plane/controlPlane.skill.disable
referencepublic
field.summary.labelInstall a signed skill artifact after verification checks.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Tags**: skills
- **File**: `packages/libs/contracts-spec/src/control-plane/commands/controlPlaneSkillInstall.command.ts`field.route.label/docs/reference/platform.control-plane/controlPlane.skill.install
referencepublic
field.summary.labelEmitted when a skill artifact is verified and installed.
- **Type**: event (event)
- **Version**: 1.0.0
- **Tags**: skills
- **File**: `packages/libs/contracts-spec/src/control-plane/events/controlPlaneSkillInstalled.event.ts`field.route.label/docs/reference/platform.control-plane/controlPlane.skill.installed
referencepublic
field.summary.labelList installed and available skill artifacts.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Tags**: skills
- **File**: `packages/libs/contracts-spec/src/control-plane/queries/controlPlaneSkillList.query.ts`field.route.label/docs/reference/platform.control-plane/controlPlane.skill.list
referencepublic
field.summary.labelEmitted when a skill install attempt is rejected.
- **Type**: event (event)
- **Version**: 1.0.0
- **Tags**: skills, governance
- **File**: `packages/libs/contracts-spec/src/control-plane/events/controlPlaneSkillRejected.event.ts`field.route.label/docs/reference/platform.control-plane/controlPlane.skill.rejected
referencepublic
field.summary.labelVerify skill signature and compatibility constraints.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Tags**: skills, governance
- **File**: `packages/libs/contracts-spec/src/control-plane/queries/controlPlaneSkillVerify.query.ts`field.route.label/docs/reference/platform.control-plane/controlPlane.skill.verify
referencepublic
field.summary.labelReturn the replayable trace timeline for one execution.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Tags**: trace, audit
- **File**: `packages/libs/contracts-spec/src/control-plane/queries/controlPlaneTraceGet.query.ts`field.route.label/docs/reference/platform.control-plane/controlPlane.trace.get
referencepublic
field.summary.labelDeterministic intent, planning, execution, approvals, audit, and skill governance surfaces.
- **Type**: feature
- **Version**: 1.0.0
- **File**: `packages/libs/contracts-spec/src/control-plane/control-plane.feature.ts`field.route.label/docs/reference/platform.control-plane/platform.control-plane
referencepublic
field.summary.labelSchema, migration, dictionary, and read-only query surfaces.
- **Type**: capability (capability)
- **Version**: 1.0.0
- **Tags**: context
- **File**: `packages/libs/contracts-spec/src/database/capabilities/databaseContext.capability.ts`field.route.label/docs/reference/platform.database/database.context
referencepublic
field.summary.labelRetrieve a data dictionary entry for a schema field.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Tags**: dictionary
- **File**: `packages/libs/contracts-spec/src/database/queries/databaseDictionaryGet.query.ts`field.route.label/docs/reference/platform.database/database.dictionary.get
referencepublic
field.summary.labelList registered database migrations and statuses.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Tags**: migrations
- **File**: `packages/libs/contracts-spec/src/database/queries/databaseMigrationsList.query.ts`field.route.label/docs/reference/platform.database/database.migrations.list
referencepublic
field.summary.labelExecute a governed read-only query via a data view.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Tags**: query, readonly
- **File**: `packages/libs/contracts-spec/src/database/queries/databaseQueryReadonly.query.ts`field.route.label/docs/reference/platform.database/database.query.readonly
referencepublic
field.summary.labelDescribe database schemas and models with PII indicators.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Tags**: describe
- **File**: `packages/libs/contracts-spec/src/database/queries/databaseSchemaDescribe.query.ts`field.route.label/docs/reference/platform.database/database.schema.describe
referencepublic
field.summary.labelDatabase context covers schema descriptions, migrations, data dictionary entries, and governed read-only access.field.route.label/docs/reference/platform.database/docs.tech.database.context
referencepublic
field.summary.labelReturns semantic descriptions and PII tags for fields.field.route.label/docs/reference/platform.database/docs.tech.database.dictionary.get
referencepublic
field.summary.labelReturns migration registry entries and statuses for auditability.field.route.label/docs/reference/platform.database/docs.tech.database.migrations.list
referencepublic
field.summary.labelExecutes read-only data access using data views with policy and redaction.field.route.label/docs/reference/platform.database/docs.tech.database.query.readonly
referencepublic
field.summary.labelReturns deterministic schema summaries for agents and operators.field.route.label/docs/reference/platform.database/docs.tech.database.schema.describe
referencepublic
field.summary.labelDescribe schemas, list migrations, query data dictionaries, and execute read-only queries
- **Type**: feature
- **Version**: 1.0.0
- **File**: `packages/libs/contracts-spec/src/database/database.feature.ts`field.route.label/docs/reference/platform.database/platform.database
referencepublic
field.summary.label- **Type**: operation (command)
- **Version**: 1.0.0
- **File**: `packages/libs/contracts-spec/src/docs/docblocks.manifest.generated.ts`
```typescript
export const AddNumbersSpec = defineCommand({\n meta: { name: 'math.add', version: '1.0.0', /* … */ },\n io: {\n input: AddNumbersInput,\n output: AddNumbersOutput,\n },\n policy: { auth: 'user' },\n});field.route.label/docs/reference/platform.docs/AddNumbersSpec
referencepublic
field.summary.labelSearch and filter DocBlocks by query, tag, or visibility.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Tags**: search, index
- **File**: `packages/libs/contracts-spec/src/docs/queries/docsIndex.query.ts`field.route.label/docs/reference/platform.docs/docs_search
referencepublic
field.summary.labelSearch form for documentation discovery.
- **Type**: form (form)
- **Version**: 1.0.0
- **Tags**: search
- **File**: `packages/libs/contracts-spec/src/docs/forms/docsSearch.form.ts`
```typescript
import { ScalarTypeEnum, SchemaModel } from '@lssm-tech/lib.schema';field.route.label/docs/reference/platform.docs/docs_search.form
referencepublic
field.summary.label> **Goal:** Ship interfaces that are usable by everyone, by default. This spec sets non‑negotiable rules, checklists, and CI gates to meet **WCAG 2.2 AA** (aim for AAA where low‑cost), align with **EN 301 549** (EU), and keep parity on **web (Next.js)** and **mobile (Expo/React Native)**.field.route.label/docs/reference/platform.docs/docs.accessibility_wcag_compliance_specs
referencepublic
field.summary.labelResolve a contract into a documentation-ready reference.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Tags**: reference
- **File**: `packages/libs/contracts-spec/src/docs/queries/contractReference.query.ts`field.route.label/docs/reference/platform.docs/docs.contract.reference
referencepublic
field.summary.labelGenerate documentation artifacts from ContractSpecs.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Tags**: generation
- **File**: `packages/libs/contracts-spec/src/docs/commands/docsGenerate.command.ts`field.route.label/docs/reference/platform.docs/docs.generate
referencepublic
field.summary.labelEmitted when documentation artifacts are generated.
- **Type**: event (event)
- **Version**: 1.0.0
- **Tags**: generation
- **File**: `packages/libs/contracts-spec/src/docs/events/docsGenerated.event.ts`
```typescriptfield.route.label/docs/reference/platform.docs/docs.generated
referencepublic
field.summary.labelShared layout shell for documentation pages.
- **Type**: presentation (presentation)
- **Version**: 1.0.0
- **Tags**: layout
- **File**: `packages/libs/contracts-spec/src/docs/presentations/docsLayout.presentation.ts`field.route.label/docs/reference/platform.docs/docs.layout
referencepublic
field.summary.label- Colocate docs beside implementation; avoid barrel /docs folders.
- Split intent:
- **goal**: why this exists (before implementation).
- **how**: operational/runbook steps.
- **usage**: quick checklist for consumers.field.route.label/docs/reference/platform.docs/docs.meta.docblocks-process
referencepublic
field.summary.labelPublish generated documentation artifacts.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Tags**: publish
- **File**: `packages/libs/contracts-spec/src/docs/commands/docsPublish.command.ts`
Deploy docs to the public docs surface with consistent versioning.field.route.label/docs/reference/platform.docs/docs.publish
referencepublic
field.summary.labelEmitted when documentation is published.
- **Type**: event (event)
- **Version**: 1.0.0
- **Tags**: publish
- **File**: `packages/libs/contracts-spec/src/docs/events/docsPublished.event.ts`
```typescript
import { ScalarTypeEnum, SchemaModel } from '@lssm-tech/lib.schema';field.route.label/docs/reference/platform.docs/docs.published
referencepublic
field.summary.labelReference page layout for contract documentation.
- **Type**: presentation (presentation)
- **Version**: 1.0.0
- **Tags**: reference
- **File**: `packages/libs/contracts-spec/src/docs/presentations/docsReferencePage.presentation.ts`field.route.label/docs/reference/platform.docs/docs.reference.page
referencepublic
field.summary.labelSearch and filter DocBlocks by query, tag, or visibility.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Tags**: search, index
- **File**: `packages/libs/contracts-spec/src/docs/queries/docsIndex.query.ts`field.route.label/docs/reference/platform.docs/docs.search
referencepublic
field.summary.labelEnd-to-end docs generation, indexing, and presentation.
- **Type**: capability (capability)
- **Version**: 1.0.0
- **Tags**: system
- **File**: `packages/libs/contracts-spec/src/docs/capabilities/documentationSystem.capability.ts`field.route.label/docs/reference/platform.docs/docs.system
referencepublic
field.summary.labelThe generator produces documentation artifacts, search metadata, and reference pages from ContractSpecs and DocBlocks.field.route.label/docs/reference/platform.docs/docs.tech.docs-generator
referencepublic
field.summary.labelPublishing moves generated artifacts to a hosting target with versioning and release metadata.field.route.label/docs/reference/platform.docs/docs.tech.docs-publish
referencepublic
field.summary.labelContract reference pages are generated from spec metadata plus schema details and exposed as a docs-ready payload.field.route.label/docs/reference/platform.docs/docs.tech.docs-reference
referencepublic
field.summary.labelThe docs index is the canonical list of DocBlocks exposed to UI, CLI, and MCP surfaces for filtering and retrieval.field.route.label/docs/reference/platform.docs/docs.tech.docs-search
referencepublic
field.summary.labelContractSpec treats documentation as a first-class output of your specs. The docs system combines contracts, DocBlocks, manifests, and presentations into a consistent docs surface.field.route.label/docs/reference/platform.docs/docs.tech.docs-system
referencepublic
field.summary.labelGenerate, publish, search, and reference contract documentation and DocBlocks
- **Type**: feature
- **Version**: 1.0.0
- **File**: `packages/libs/contracts-spec/src/docs/docs.feature.ts`
- `docs.generate` (v1.0.0)field.route.label/docs/reference/platform.docs/platform.docs
referencepublic
field.summary.labelRun scenario evaluations and inspect assertion outcomes.
- **Type**: capability (capability)
- **Version**: 1.0.0
- **Tags**: evaluation
- **File**: `packages/libs/contracts-spec/src/harness/capabilities/harnessEvaluation.capability.ts`field.route.label/docs/reference/platform.harness/harness.evaluation
referencepublic
field.summary.labelEmitted when a harness evaluation completes.
- **Type**: event (event)
- **Version**: 1.0.0
- **Tags**: evaluation, completed
- **File**: `packages/libs/contracts-spec/src/harness/events/harnessEvaluationCompleted.event.ts`field.route.label/docs/reference/platform.harness/harness.evaluation.completed
referencepublic
field.summary.labelFetch one evaluation and its assertion results.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Tags**: evaluation
- **File**: `packages/libs/contracts-spec/src/harness/queries/harnessEvaluationGet.query.ts`field.route.label/docs/reference/platform.harness/harness.evaluation.get
referencepublic
field.summary.labelRun a harness scenario or suite as an evaluation.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Tags**: evaluation, run
- **File**: `packages/libs/contracts-spec/src/harness/commands/harnessEvaluationRun.command.ts`field.route.label/docs/reference/platform.harness/harness.evaluation.run
referencepublic
field.summary.labelCapture and retrieve normalized evidence artifacts.
- **Type**: capability (capability)
- **Version**: 1.0.0
- **Tags**: evidence
- **File**: `packages/libs/contracts-spec/src/harness/capabilities/harnessEvidence.capability.ts`field.route.label/docs/reference/platform.harness/harness.evidence
referencepublic
field.summary.labelEmitted when a harness artifact is captured.
- **Type**: event (event)
- **Version**: 1.0.0
- **Tags**: evidence
- **File**: `packages/libs/contracts-spec/src/harness/events/harnessEvidenceCaptured.event.ts`field.route.label/docs/reference/platform.harness/harness.evidence.captured
referencepublic
field.summary.labelFetch one evidence artifact by id.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Tags**: evidence
- **File**: `packages/libs/contracts-spec/src/harness/queries/harnessEvidenceGet.query.ts`
Support evidence drill-down and replay inputs.field.route.label/docs/reference/platform.harness/harness.evidence.get
referencepublic
field.summary.labelList normalized evidence artifacts for one run.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Tags**: evidence, list
- **File**: `packages/libs/contracts-spec/src/harness/queries/harnessEvidenceList.query.ts`field.route.label/docs/reference/platform.harness/harness.evidence.list
referencepublic
field.summary.labelRun, inspect, and cancel harness sessions.
- **Type**: capability (capability)
- **Version**: 1.0.0
- **Tags**: execution
- **File**: `packages/libs/contracts-spec/src/harness/capabilities/harnessExecution.capability.ts`field.route.label/docs/reference/platform.harness/harness.execution
referencepublic
field.summary.labelAudit view for harness runs, steps, evidence, and assertions.
- **Type**: presentation (presentation)
- **Version**: 1.0.0
- **Tags**: audit
- **File**: `packages/libs/contracts-spec/src/harness/presentations/harnessRunAudit.presentation.ts`field.route.label/docs/reference/platform.harness/harness.run.audit
referencepublic
field.summary.labelCancel an in-flight harness run.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Tags**: run, cancel
- **File**: `packages/libs/contracts-spec/src/harness/commands/harnessRunCancel.command.ts`
Stop execution while preserving evidence and audit state.field.route.label/docs/reference/platform.harness/harness.run.cancel
referencepublic
field.summary.labelEmitted when a harness run completes.
- **Type**: event (event)
- **Version**: 1.0.0
- **Tags**: run, completed
- **File**: `packages/libs/contracts-spec/src/harness/events/harnessRunCompleted.event.ts`
```typescriptfield.route.label/docs/reference/platform.harness/harness.run.completed
referencepublic
field.summary.labelEmitted when a harness run fails.
- **Type**: event (event)
- **Version**: 1.0.0
- **Tags**: run, failed
- **File**: `packages/libs/contracts-spec/src/harness/events/harnessRunFailed.event.ts`
```typescriptfield.route.label/docs/reference/platform.harness/harness.run.failed
referencepublic
field.summary.labelFetch one harness run with step metadata.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Tags**: run
- **File**: `packages/libs/contracts-spec/src/harness/queries/harnessRunGet.query.ts`
Support audit, debugging, and run tracking.field.route.label/docs/reference/platform.harness/harness.run.get
referencepublic
field.summary.labelStart a harness run for a scenario or suite.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Tags**: run, start
- **File**: `packages/libs/contracts-spec/src/harness/commands/harnessRunStart.command.ts`field.route.label/docs/reference/platform.harness/harness.run.start
referencepublic
field.summary.labelEmitted when a harness run starts.
- **Type**: event (event)
- **Version**: 1.0.0
- **Tags**: run, started
- **File**: `packages/libs/contracts-spec/src/harness/events/harnessRunStarted.event.ts`
```typescriptfield.route.label/docs/reference/platform.harness/harness.run.started
referencepublic
field.summary.labelEmitted when a harness step is blocked by policy.
- **Type**: event (event)
- **Version**: 1.0.0
- **Tags**: step, blocked
- **File**: `packages/libs/contracts-spec/src/harness/events/harnessStepBlocked.event.ts`field.route.label/docs/reference/platform.harness/harness.step.blocked
referencepublic
field.summary.labelEmitted when a harness step completes.
- **Type**: event (event)
- **Version**: 1.0.0
- **Tags**: step, completed
- **File**: `packages/libs/contracts-spec/src/harness/events/harnessStepCompleted.event.ts`field.route.label/docs/reference/platform.harness/harness.step.completed
referencepublic
field.summary.labelEmitted when a harness step starts.
- **Type**: event (event)
- **Version**: 1.0.0
- **Tags**: step, started
- **File**: `packages/libs/contracts-spec/src/harness/events/harnessStepStarted.event.ts`
```typescriptfield.route.label/docs/reference/platform.harness/harness.step.started
referencepublic
field.summary.labelResolve the isolated target used for a harness run.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Tags**: target
- **File**: `packages/libs/contracts-spec/src/harness/queries/harnessTargetResolve.query.ts`field.route.label/docs/reference/platform.harness/harness.target.resolve
referencepublic
field.summary.labelResolve preview, task, shared, and sandbox harness targets.
- **Type**: capability (capability)
- **Version**: 1.0.0
- **Tags**: targeting
- **File**: `packages/libs/contracts-spec/src/harness/capabilities/harnessTargeting.capability.ts`field.route.label/docs/reference/platform.harness/harness.targeting
referencepublic
field.summary.labelControlled application inspection, testing, validation, and proof generation.
- **Type**: feature
- **Version**: 1.0.0
- **File**: `packages/libs/contracts-spec/src/harness/harness.feature.ts`
- `harness.target.resolve` (v1.0.0)field.route.label/docs/reference/platform.harness/platform.harness
referencepublic
field.summary.labelFal integration for AI image generation using Flux and Stable Diffusion models.
- **Type**: integration (integration)
- **Version**: 1.0.0
- **Owners**: platform.ai
- **Tags**: image, generation, flux, stable-diffusionfield.route.label/docs/reference/platform.integrations/ai-image.fal
referencepublic
field.summary.labelOpenAI integration for AI image generation using DALL-E and gpt-image models.
- **Type**: integration (integration)
- **Version**: 1.0.0
- **Owners**: platform.ai
- **Tags**: image, generation, dall-e, gpt-imagefield.route.label/docs/reference/platform.integrations/ai-image.openai
referencepublic
field.summary.labelMistral integration providing chat completions and embedding generation.
- **Type**: integration (integration)
- **Version**: 1.0.0
- **Owners**: platform.ai
- **Tags**: ai, llm, embeddings
- **File**: `packages/libs/contracts-integrations/src/integrations/providers/mistral.ts`field.route.label/docs/reference/platform.integrations/ai-llm.mistral
referencepublic
field.summary.labelMistral conversational voice integration using conversation sessions and speech models for bidirectional interactions.
- **Type**: integration (integration)
- **Version**: 1.0.0
- **Owners**: platform.ai
- **Tags**: voice, conversational, mistral, agents, sessionsfield.route.label/docs/reference/platform.integrations/ai-voice-conv.mistral
referencepublic
field.summary.labelOpenAI Realtime API integration for bidirectional conversational voice with GPT models.
- **Type**: integration (integration)
- **Version**: 1.0.0
- **Owners**: platform.ai
- **Tags**: voice, conversational, realtime, openaifield.route.label/docs/reference/platform.integrations/ai-voice-conv.openai
referencepublic
field.summary.labelDeepgram integration for real-time and batch speech-to-text transcription with speaker diarization.
- **Type**: integration (integration)
- **Version**: 1.0.0
- **Owners**: platform.ai
- **Tags**: voice, stt, transcription, diarizationfield.route.label/docs/reference/platform.integrations/ai-voice-stt.deepgram
referencepublic
field.summary.labelMistral audio transcription integration for batch and streaming speech-to-text use cases.
- **Type**: integration (integration)
- **Version**: 1.0.0
- **Owners**: platform.ai
- **Tags**: voice, stt, transcription, mistral, voxtralfield.route.label/docs/reference/platform.integrations/ai-voice-stt.mistral
referencepublic
field.summary.labelElevenLabs integration for neural voice synthesis and voice catalog access.
- **Type**: integration (integration)
- **Version**: 1.0.0
- **Owners**: platform.ai
- **Tags**: voice, tts, stt
- **File**: `packages/libs/contracts-integrations/src/integrations/providers/elevenlabs.ts`field.route.label/docs/reference/platform.integrations/ai-voice.elevenlabs
referencepublic
field.summary.labelFal integration for voice synthesis using Chatterbox text-to-speech models.
- **Type**: integration (integration)
- **Version**: 1.0.0
- **Owners**: platform.ai
- **Tags**: voice, tts, chatterbox
- **File**: `packages/libs/contracts-integrations/src/integrations/providers/fal.ts`field.route.label/docs/reference/platform.integrations/ai-voice.fal
referencepublic
field.summary.labelGradium integration for low-latency voice synthesis and voice catalog access.
- **Type**: integration (integration)
- **Version**: 1.0.0
- **Owners**: platform.ai
- **Tags**: voice, tts, realtime
- **File**: `packages/libs/contracts-integrations/src/integrations/providers/gradium.ts`field.route.label/docs/reference/platform.integrations/ai-voice.gradium
referencepublic
field.summary.labelPostHog integration for product analytics, feature flags, HogQL queries, and LLM analytics with evaluations.
- **Type**: integration (integration)
- **Version**: 1.1.0
- **Owners**: @platform.integrationsfield.route.label/docs/reference/platform.integrations/analytics.posthog
referencepublic
field.summary.labelGoogle Calendar integration for event creation, updates, and scheduling automations.
- **Type**: integration (integration)
- **Version**: 1.0.0
- **Owners**: platform.messaging
- **Tags**: calendar, googlefield.route.label/docs/reference/platform.integrations/calendar.google
referencepublic
field.summary.labelSupabase Postgres integration for SQL query execution and transactional workloads.
- **Type**: integration (integration)
- **Version**: 1.0.0
- **Owners**: platform.infrastructure
- **Tags**: database, postgres, supabasefield.route.label/docs/reference/platform.integrations/database.supabase
referencepublic
field.summary.labelGmail integration supporting inbound thread ingestion and outbound transactional email.
- **Type**: integration (integration)
- **Version**: 1.0.0
- **Owners**: platform.messaging
- **Tags**: email, gmail
- **File**: `packages/libs/contracts-integrations/src/integrations/providers/gmail.ts`field.route.label/docs/reference/platform.integrations/email.gmail
referencepublic
field.summary.labelPostmark integration for transactional email delivery.
- **Type**: integration (integration)
- **Version**: 1.0.0
- **Owners**: platform.messaging
- **Tags**: email, transactional
- **File**: `packages/libs/contracts-integrations/src/integrations/providers/postmark.ts`field.route.label/docs/reference/platform.integrations/email.postmark
referencepublic
field.summary.labelComposio integration platform providing 850+ toolkits as a universal fallback for unsupported provider keys.
- **Type**: integration (integration)
- **Version**: 1.0.0
- **Owners**: platform.integrations
- **Tags**: composio, fallback, mcp, universalfield.route.label/docs/reference/platform.integrations/fallback.composio
referencepublic
field.summary.labelCore integrations capability for third-party connections
- **Type**: capability (capability)
- **Version**: 1.0.0
- **Owners**: @platform.core
- **Tags**: integrations, platform
- **File**: `packages/libs/contracts-integrations/src/integrations/integrations.capability.ts`field.route.label/docs/reference/platform.integrations/integrations
referencepublic
field.summary.labelCreate a new integration connection for a tenant.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @platform.integrations
- **Tags**: integration, connectionsfield.route.label/docs/reference/platform.integrations/integrations.connection.create
referencepublic
field.summary.labelDelete an integration connection for a tenant.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @platform.integrations
- **Tags**: integration, connections
- **File**: `packages/libs/contracts-integrations/src/integrations/operations.ts`field.route.label/docs/reference/platform.integrations/integrations.connection.delete
referencepublic
field.summary.labelList integration connections for a tenant.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @platform.integrations
- **Tags**: integration, connections
- **File**: `packages/libs/contracts-integrations/src/integrations/operations.ts`field.route.label/docs/reference/platform.integrations/integrations.connection.list
referencepublic
field.summary.labelRun a health check against a configured integration connection.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @platform.integrations
- **Tags**: integration, connectionsfield.route.label/docs/reference/platform.integrations/integrations.connection.test
referencepublic
field.summary.labelUpdate metadata or credentials for an integration connection.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @platform.integrations
- **Tags**: integration, connectionsfield.route.label/docs/reference/platform.integrations/integrations.connection.update
referencepublic
field.summary.labelFathom External API for meetings, transcripts, and webhook events.
- **Type**: integration (integration)
- **Version**: 1.0.0
- **Owners**: platform.integrations
- **Tags**: meeting-recorder, fathom, transcriptsfield.route.label/docs/reference/platform.integrations/meeting-recorder.fathom
referencepublic
field.summary.labelFireflies GraphQL API for meeting transcripts, metadata, and webhook events.
- **Type**: integration (integration)
- **Version**: 1.0.0
- **Owners**: platform.integrations
- **Tags**: meeting-recorder, fireflies, transcriptsfield.route.label/docs/reference/platform.integrations/meeting-recorder.fireflies
referencepublic
field.summary.labelGranola meeting notes and transcripts via Enterprise API or MCP transport.
- **Type**: integration (integration)
- **Version**: 1.0.0
- **Owners**: platform.integrations
- **Tags**: meeting-recorder, granola, transcriptsfield.route.label/docs/reference/platform.integrations/meeting-recorder.granola
referencepublic
field.summary.labeltl;dv Public API for meeting recordings, transcripts, and webhook events.
- **Type**: integration (integration)
- **Version**: 1.0.0
- **Owners**: platform.integrations
- **Tags**: meeting-recorder, tldv, transcriptsfield.route.label/docs/reference/platform.integrations/meeting-recorder.tldv
referencepublic
field.summary.labelGitHub integration for issue and pull request comment workflows backed by webhook events.
- **Type**: integration (integration)
- **Version**: 1.0.0
- **Owners**: platform.messaging
- **Tags**: messaging, github, pull-requestsfield.route.label/docs/reference/platform.integrations/messaging.github
referencepublic
field.summary.labelSlack integration for inbound events, threaded responses, and interactive messaging workflows.
- **Type**: integration (integration)
- **Version**: 1.0.0
- **Owners**: platform.messaging
- **Tags**: messaging, slackfield.route.label/docs/reference/platform.integrations/messaging.slack
referencepublic
field.summary.labelTelegram messaging integration for inbound webhook updates, threaded topic messages, and outbound bot replies.
- **Type**: integration (integration)
- **Version**: 1.0.0
- **Owners**: platform.messaging
- **Tags**: messaging, telegramfield.route.label/docs/reference/platform.integrations/messaging.telegram
referencepublic
field.summary.labelMeta WhatsApp Cloud API integration for inbound message processing and outbound replies.
- **Type**: integration (integration)
- **Version**: 1.0.0
- **Owners**: platform.messaging
- **Tags**: messaging, whatsapp, metafield.route.label/docs/reference/platform.integrations/messaging.whatsapp.meta
referencepublic
field.summary.labelTwilio-powered WhatsApp integration for inbound webhooks and outbound conversational messaging.
- **Type**: integration (integration)
- **Version**: 1.0.0
- **Owners**: platform.messaging
- **Tags**: messaging, whatsapp, twiliofield.route.label/docs/reference/platform.integrations/messaging.whatsapp.twilio
referencepublic
field.summary.labelRead-only Open Banking integration powered by Powens, exposing accounts, transactions, and balances.
- **Type**: integration (integration)
- **Version**: 1.0.0
- **Owners**: platform.finance
- **Tags**: open-banking, powens, financefield.route.label/docs/reference/platform.integrations/openbanking.powens
referencepublic
field.summary.labelStripe integration for payment processing, charges, and payouts.
- **Type**: integration (integration)
- **Version**: 1.0.0
- **Owners**: platform.payments
- **Tags**: payments, psp
- **File**: `packages/libs/contracts-integrations/src/integrations/providers/stripe.ts`field.route.label/docs/reference/platform.integrations/payments.stripe
referencepublic
field.summary.labelManage integration connections to external providers (e.g., Stripe, Qdrant)
- **Type**: feature
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @platform.integrations
- **Tags**: integrations, connections, platformfield.route.label/docs/reference/platform.integrations/platform.integrations
referencepublic
field.summary.labelJira Cloud integration for creating and tracking work items.
- **Type**: integration (integration)
- **Version**: 1.0.0
- **Owners**: @platform.integrations
- **Tags**: project-management, jira
- **File**: `packages/libs/contracts-integrations/src/integrations/providers/jira.ts`field.route.label/docs/reference/platform.integrations/project-management.jira
referencepublic
field.summary.labelLinear integration for issue tracking and project management workflows.
- **Type**: integration (integration)
- **Version**: 1.0.0
- **Owners**: @platform.integrations
- **Tags**: project-management, linearfield.route.label/docs/reference/platform.integrations/project-management.linear
referencepublic
field.summary.labelNotion integration for creating shared project summaries and task entries.
- **Type**: integration (integration)
- **Version**: 1.0.0
- **Owners**: @platform.integrations
- **Tags**: project-management, notionfield.route.label/docs/reference/platform.integrations/project-management.notion
referencepublic
field.summary.labelTwilio SMS integration for transactional and notification messaging.
- **Type**: integration (integration)
- **Version**: 1.0.0
- **Owners**: platform.messaging
- **Tags**: sms, messaging
- **File**: `packages/libs/contracts-integrations/src/integrations/providers/twilio-sms.ts`field.route.label/docs/reference/platform.integrations/sms.twilio
referencepublic
field.summary.labelGoogle Cloud Storage integration for object storage and retrieval.
- **Type**: integration (integration)
- **Version**: 1.0.0
- **Owners**: platform.infrastructure
- **Tags**: storage, gcs, google-cloud
- **File**: `packages/libs/contracts-integrations/src/integrations/providers/gcs-storage.ts`field.route.label/docs/reference/platform.integrations/storage.gcs
referencepublic
field.summary.labelQdrant integration for vector search and embeddings storage.
- **Type**: integration (integration)
- **Version**: 1.0.0
- **Owners**: platform.ai
- **Tags**: vector-db, search
- **File**: `packages/libs/contracts-integrations/src/integrations/providers/qdrant.ts`field.route.label/docs/reference/platform.integrations/vectordb.qdrant
referencepublic
field.summary.labelSupabase integration for embedding storage and vector similarity search using pgvector.
- **Type**: integration (integration)
- **Version**: 1.0.0
- **Owners**: platform.ai
- **Tags**: vector-db, supabase, pgvectorfield.route.label/docs/reference/platform.integrations/vectordb.supabase
referencepublic
field.summary.labelKnowledge base and content management capability
- **Type**: capability (capability)
- **Version**: 1.0.0
- **Owners**: @platform.content
- **Tags**: knowledge, content, data
- **File**: `packages/libs/contracts-spec/src/knowledge/knowledge.capability.ts`field.route.label/docs/reference/platform.knowledge/knowledge
referencepublic
field.summary.labelCreate a knowledge source binding for a tenant.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @platform.knowledge
- **Tags**: knowledge, sources
- **File**: `packages/libs/contracts-spec/src/knowledge/operations.ts`field.route.label/docs/reference/platform.knowledge/knowledge.source.create
referencepublic
field.summary.labelDelete a knowledge source binding for a tenant.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @platform.knowledge
- **Tags**: knowledge, sources
- **File**: `packages/libs/contracts-spec/src/knowledge/operations.ts`field.route.label/docs/reference/platform.knowledge/knowledge.source.delete
referencepublic
field.summary.labelList knowledge sources configured for a tenant.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @platform.knowledge
- **Tags**: knowledge, sources
- **File**: `packages/libs/contracts-spec/src/knowledge/operations.ts`field.route.label/docs/reference/platform.knowledge/knowledge.source.list
referencepublic
field.summary.labelTrigger an immediate sync for a knowledge source.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @platform.knowledge
- **Tags**: knowledge, sources
- **File**: `packages/libs/contracts-spec/src/knowledge/operations.ts`field.route.label/docs/reference/platform.knowledge/knowledge.source.triggerSync
referencepublic
field.summary.labelUpdate metadata or configuration for a knowledge source.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @platform.knowledge
- **Tags**: knowledge, sources
- **File**: `packages/libs/contracts-spec/src/knowledge/operations.ts`field.route.label/docs/reference/platform.knowledge/knowledge.source.update
referencepublic
field.summary.labelManage knowledge source bindings for ingestion (e.g., Notion, uploads)
- **Type**: feature
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @platform.knowledge
- **Tags**: knowledge, sources, platform, ingestionfield.route.label/docs/reference/platform.knowledge/platform.knowledge
referencepublic
field.summary.labelEmitted when a custom evaluation run completes execution.field.route.label/docs/reference/platform.provider-ranking/docs.tech.provider-ranking.benchmark.custom.completed
referencepublic
field.summary.labelImports and normalizes benchmark scores from external leaderboards.field.route.label/docs/reference/platform.provider-ranking/docs.tech.provider-ranking.benchmark.ingest
referencepublic
field.summary.labelForm surface used by Studio to trigger benchmark data ingestion.field.route.label/docs/reference/platform.provider-ranking/docs.tech.provider-ranking.benchmark.ingest.form
referencepublic
field.summary.labelEmitted when external benchmark data is successfully imported and stored.field.route.label/docs/reference/platform.provider-ranking/docs.tech.provider-ranking.benchmark.ingested
referencepublic
field.summary.labelReturns individual benchmark data points filterable by source, model, and dimension.field.route.label/docs/reference/platform.provider-ranking/docs.tech.provider-ranking.benchmark.results.list
referencepublic
field.summary.labelEvaluates model performance using internal eval suites with configurable parameters.field.route.label/docs/reference/platform.provider-ranking/docs.tech.provider-ranking.benchmark.run-custom
referencepublic
field.summary.labelForm surface used by Studio to launch custom benchmark evaluations.field.route.label/docs/reference/platform.provider-ranking/docs.tech.provider-ranking.benchmark.run-custom.form
referencepublic
field.summary.labelPresentation surface for comparing two or more models across all ranking dimensions.field.route.label/docs/reference/platform.provider-ranking/docs.tech.provider-ranking.model.comparison
referencepublic
field.summary.labelReturns comprehensive model information including scores, metadata, cost, context window, and capabilities.field.route.label/docs/reference/platform.provider-ranking/docs.tech.provider-ranking.model.profile.get
referencepublic
field.summary.labelReturns a paginated, filterable leaderboard of AI models ranked by composite or per-dimension scores.field.route.label/docs/reference/platform.provider-ranking/docs.tech.provider-ranking.ranking.get
referencepublic
field.summary.labelRecomputes weighted composite scores across all dimensions and updates the leaderboard.field.route.label/docs/reference/platform.provider-ranking/docs.tech.provider-ranking.ranking.refresh
referencepublic
field.summary.labelEmitted when the leaderboard is refreshed with new composite scores.field.route.label/docs/reference/platform.provider-ranking/docs.tech.provider-ranking.ranking.updated
referencepublic
field.summary.labelDefines the core operations, events, and UI surfaces for ingesting benchmark data, computing composite rankings, and comparing AI models across dimensions.field.route.label/docs/reference/platform.provider-ranking/docs.tech.provider-ranking.system
referencepublic
field.summary.labelBenchmark ingestion, custom benchmark runs, and AI model ranking with leaderboards
- **Type**: feature
- **Version**: 1.0.0
- **Tags**: ai, ranking, benchmark
- **File**: `packages/libs/contracts-spec/src/provider-ranking/provider-ranking.feature.ts`field.route.label/docs/reference/platform.provider-ranking/platform.provider-ranking
referencepublic
field.summary.labelEmitted when a custom benchmark run finishes.
- **Type**: event (event)
- **Version**: 1.0.0
- **Tags**: custom, eval
- **File**: `packages/libs/contracts-spec/src/provider-ranking/events/benchmarkCustomCompleted.event.ts`field.route.label/docs/reference/platform.provider-ranking/provider-ranking.benchmark.custom.completed
referencepublic
field.summary.labelTrigger ingestion of external benchmark data from a public source.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Tags**: ingest
- **File**: `packages/libs/contracts-spec/src/provider-ranking/commands/benchmarkIngest.command.ts`field.route.label/docs/reference/platform.provider-ranking/provider-ranking.benchmark.ingest
referencepublic
field.summary.labelForm to trigger benchmark data ingestion from external sources.
- **Type**: form (form)
- **Version**: 1.0.0
- **Tags**: ingest
- **File**: `packages/libs/contracts-spec/src/provider-ranking/forms/benchmarkIngest.form.ts`field.route.label/docs/reference/platform.provider-ranking/provider-ranking.benchmark.ingest.form
referencepublic
field.summary.labelEmitted after external benchmark data is ingested.
- **Type**: event (event)
- **Version**: 1.0.0
- **Tags**: ingest
- **File**: `packages/libs/contracts-spec/src/provider-ranking/events/benchmarkIngested.event.ts`field.route.label/docs/reference/platform.provider-ranking/provider-ranking.benchmark.ingested
referencepublic
field.summary.labelList raw benchmark results with pagination, filterable by source, model, and dimension.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Tags**: results
- **File**: `packages/libs/contracts-spec/src/provider-ranking/queries/benchmarkResultsList.query.ts`field.route.label/docs/reference/platform.provider-ranking/provider-ranking.benchmark.results.list
referencepublic
field.summary.labelLaunch a custom benchmark evaluation against a specific model.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Tags**: custom, eval
- **File**: `packages/libs/contracts-spec/src/provider-ranking/commands/benchmarkRunCustom.command.ts`field.route.label/docs/reference/platform.provider-ranking/provider-ranking.benchmark.run-custom
referencepublic
field.summary.labelForm to launch a custom benchmark evaluation against a model.
- **Type**: form (form)
- **Version**: 1.0.0
- **Tags**: custom, eval
- **File**: `packages/libs/contracts-spec/src/provider-ranking/forms/benchmarkRunCustom.form.ts`field.route.label/docs/reference/platform.provider-ranking/provider-ranking.benchmark.run-custom.form
referencepublic
field.summary.labelSide-by-side comparison of AI model scores and capabilities.
- **Type**: presentation (presentation)
- **Version**: 1.0.0
- **Tags**: comparison
- **File**: `packages/libs/contracts-spec/src/provider-ranking/presentations/modelComparison.presentation.ts`field.route.label/docs/reference/platform.provider-ranking/provider-ranking.model.comparison
referencepublic
field.summary.labelGet detailed profile for a single model including all scores, metadata, cost, and capabilities.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Tags**: model, profile
- **File**: `packages/libs/contracts-spec/src/provider-ranking/queries/modelProfileGet.query.ts`field.route.label/docs/reference/platform.provider-ranking/provider-ranking.model.profile.get
referencepublic
field.summary.labelGet ranked list of providers/models with composite scores, filterable by dimension.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Tags**: leaderboard
- **File**: `packages/libs/contracts-spec/src/provider-ranking/queries/providerRankingGet.query.ts`field.route.label/docs/reference/platform.provider-ranking/provider-ranking.ranking.get
referencepublic
field.summary.labelRecompute composite rankings from latest benchmark data.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Tags**: refresh
- **File**: `packages/libs/contracts-spec/src/provider-ranking/commands/rankingRefresh.command.ts`field.route.label/docs/reference/platform.provider-ranking/provider-ranking.ranking.refresh
referencepublic
field.summary.labelEmitted when composite rankings are recomputed.
- **Type**: event (event)
- **Version**: 1.0.0
- **Tags**: refresh
- **File**: `packages/libs/contracts-spec/src/provider-ranking/events/rankingUpdated.event.ts`field.route.label/docs/reference/platform.provider-ranking/provider-ranking.ranking.updated
referencepublic
field.summary.labelBenchmark ingestion, scoring, and ranking for AI providers and models.
- **Type**: capability (capability)
- **Version**: 1.0.0
- **Tags**: system
- **File**: `packages/libs/contracts-spec/src/provider-ranking/capabilities/providerRanking.capability.ts`field.route.label/docs/reference/platform.provider-ranking/provider-ranking.system
referencepublic
field.summary.labelPocket Family Office is a ContractSpec reference vertical that
demonstrates finance automation atop the integration and knowledge
layers. It is optimised for the hackathon stack (Google Cloud, Mistral,
Qdrant, ElevenLabs) while remaining provider-agnostic.field.route.label/docs/reference/pocket-family-office/docs.tech.contracts.vertical-pocket-family-office
referencepublic
field.summary.labelStores an object in tenant storage and schedules ingestion into the knowledge base.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Tags**: documents, ingestion
- **File**: `packages/examples/pocket-family-office/src/operations/index.ts`field.route.label/docs/reference/pocket-family-office/pfo.documents.upload
referencepublic
field.summary.labelTriggers ingestion of Gmail threads into the operational knowledge space.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Tags**: gmail, knowledge
- **File**: `packages/examples/pocket-family-office/src/operations/index.ts`field.route.label/docs/reference/pocket-family-office/pfo.email.sync-threads
referencepublic
field.summary.labelAggregates balances and transactions into a derived financial overview stored in the knowledge layer.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Tags**: open-banking, summary
- **File**: `packages/examples/pocket-family-office/src/operations/index.ts`field.route.label/docs/reference/pocket-family-office/pfo.openbanking.generate-overview
referencepublic
field.summary.labelQueues outbound email/SMS reminders for upcoming bills and adds an optional calendar hold.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Tags**: payments, reminders
- **File**: `packages/examples/pocket-family-office/src/operations/index.ts`field.route.label/docs/reference/pocket-family-office/pfo.reminders.schedule-payment
referencepublic
field.summary.labelDelivers the generated summary via email and optionally synthesises a voice note.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Tags**: summary, communications
- **File**: `packages/examples/pocket-family-office/src/operations/index.ts`field.route.label/docs/reference/pocket-family-office/pfo.summary.dispatch
referencepublic
field.summary.labelRuns RAG over financial documents and email threads to provide a natural-language summary with key metrics.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Tags**: summary, ai
- **File**: `packages/examples/pocket-family-office/src/operations/index.ts`field.route.label/docs/reference/pocket-family-office/pfo.summary.generate
referencepublic
field.summary.labelRetrieves the latest financial signals, generates an AI summary, and optionally distributes it by voice or email.
- **Type**: workflow (workflow)
- **Version**: 1.0.0
- **Tags**: summary, ai
- **File**: `packages/examples/pocket-family-office/src/workflows/generate-financial-summary.ts`field.route.label/docs/reference/pocket-family-office/pfo.workflow.generate-financial-summary
referencepublic
field.summary.labelProduces a derived financial overview and stores it in the operational knowledge space.
- **Type**: workflow (workflow)
- **Version**: 1.0.0
- **Tags**: open-banking, summary
- **File**: `packages/examples/pocket-family-office/src/workflows/generate-openbanking-overview.ts`field.route.label/docs/reference/pocket-family-office/pfo.workflow.generate-openbanking-overview
referencepublic
field.summary.labelSynchronises Gmail threads tagged with finance labels and indexes them into operational knowledge spaces.
- **Type**: workflow (workflow)
- **Version**: 1.0.0
- **Tags**: gmail, knowledge
- **File**: `packages/examples/pocket-family-office/src/workflows/ingest-email-threads.ts`field.route.label/docs/reference/pocket-family-office/pfo.workflow.ingest-email-threads
referencepublic
field.summary.labelStores an uploaded invoice/contract, queues ingestion, and records any follow-up reminders.
- **Type**: workflow (workflow)
- **Version**: 1.0.0
- **Tags**: documents, ingestion
- **File**: `packages/examples/pocket-family-office/src/workflows/process-uploaded-document.ts`field.route.label/docs/reference/pocket-family-office/pfo.workflow.process-uploaded-document
referencepublic
field.summary.labelRefreshes balances for synced accounts to surface the latest cash positions in dashboards.
- **Type**: workflow (workflow)
- **Version**: 1.0.0
- **Tags**: open-banking, powens
- **File**: `packages/examples/pocket-family-office/src/workflows/refresh-openbanking-balances.ts`field.route.label/docs/reference/pocket-family-office/pfo.workflow.refresh-openbanking-balances
referencepublic
field.summary.labelValidates Powens connectivity and synchronises bank account metadata into the canonical ledger.
- **Type**: workflow (workflow)
- **Version**: 1.0.0
- **Tags**: open-banking, powens
- **File**: `packages/examples/pocket-family-office/src/workflows/sync-openbanking-accounts.ts`field.route.label/docs/reference/pocket-family-office/pfo.workflow.sync-openbanking-accounts
referencepublic
field.summary.labelFetches recent transactions from Powens for each linked account and stores them in the canonical ledger.
- **Type**: workflow (workflow)
- **Version**: 1.0.0
- **Tags**: open-banking, powens
- **File**: `packages/examples/pocket-family-office/src/workflows/sync-openbanking-transactions.ts`field.route.label/docs/reference/pocket-family-office/pfo.workflow.sync-openbanking-transactions
referencepublic
field.summary.labelCollects payment metadata and schedules multi-channel reminders for bills that are due soon.
- **Type**: workflow (workflow)
- **Version**: 1.0.0
- **Tags**: payments, reminders
- **File**: `packages/examples/pocket-family-office/src/workflows/upcoming-payments-reminder.ts`field.route.label/docs/reference/pocket-family-office/pfo.workflow.upcoming-payments-reminder
referencepublic
field.summary.labelPersonal finance automation with document ingestion, open banking, and AI summaries
- **Type**: feature
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @platform.finance
- **Tags**: finance, open-banking, documents, automation, family-officefield.route.label/docs/reference/pocket-family-office/pocket-family-office
referencepublic
field.summary.labelAll-in-one example composing locale/jurisdiction gate + versioned KB + HITL pipeline + learning hub.
- **Type**: feature
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @examples
- **Tags**: assistant, knowledge, policy, hitl, learningfield.route.label/docs/reference/policy-safe-knowledge-assistant/policy-safe-knowledge-assistant
referencepublic
field.summary.labelEvidence ingestion, PostHog signals, and transcript-to-tickets discovery workflow
- **Type**: feature
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @examples
- **Tags**: product, intent, evidence, posthogfield.route.label/docs/reference/product-intent/product-intent
referencepublic
field.summary.labelCreate work items in Linear, Jira, and Notion from contract definitions
- **Type**: feature
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @examples
- **Tags**: project-management, sync, linear, jira, notionfield.route.label/docs/reference/project-management-sync/project-management-sync
referencepublic
field.summary.labelUsage limit has been reached for a feature.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @saas-team
- **Tags**: billing, limit, reached
- **File**: `packages/examples/saas-boilerplate/src/billing/billing.event.ts`field.route.label/docs/reference/saas-boilerplate/billing.limit.reached
referencepublic
field.summary.labelSubscription status has changed.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @saas-team
- **Tags**: billing, subscription, changed
- **File**: `packages/examples/saas-boilerplate/src/billing/billing.event.ts`field.route.label/docs/reference/saas-boilerplate/billing.subscription.changed
referencepublic
field.summary.labelFeature usage has been recorded.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @saas-team
- **Tags**: billing, usage, recorded
- **File**: `packages/examples/saas-boilerplate/src/billing/billing.event.ts`field.route.label/docs/reference/saas-boilerplate/billing.usage.recorded
referencepublic
field.summary.labelA project has been archived.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @saas-team
- **Tags**: project, archived
- **File**: `packages/examples/saas-boilerplate/src/project/project.event.ts`field.route.label/docs/reference/saas-boilerplate/project.archived
referencepublic
field.summary.labelA new project has been created.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @saas-team
- **Tags**: project, created
- **File**: `packages/examples/saas-boilerplate/src/project/project.event.ts`field.route.label/docs/reference/saas-boilerplate/project.created
referencepublic
field.summary.labelA project has been deleted.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @saas-team
- **Tags**: project, deleted
- **File**: `packages/examples/saas-boilerplate/src/project/project.event.ts`field.route.label/docs/reference/saas-boilerplate/project.deleted
referencepublic
field.summary.labelA project has been updated.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @saas-team
- **Tags**: project, updated
- **File**: `packages/examples/saas-boilerplate/src/project/project.event.ts`field.route.label/docs/reference/saas-boilerplate/project.updated
referencepublic
field.summary.labelSaaS application foundation with projects, billing, and settings
- **Type**: feature
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @saas-team
- **Tags**: saas, projects, billing
- **File**: `packages/examples/saas-boilerplate/src/saas-boilerplate.feature.ts`field.route.label/docs/reference/saas-boilerplate/saas-boilerplate
referencepublic
field.summary.labelCheck if organization has access to a feature.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @example.saas-boilerplate
- **Tags**: saas, billing, feature
- **File**: `packages/examples/saas-boilerplate/src/billing/billing.operations.ts`field.route.label/docs/reference/saas-boilerplate/saas.billing.feature.check
referencepublic
field.summary.labelSubscription status with plan info, limits, and current usage
- **Type**: presentation (presentation)
- **Version**: 1.0.0
- **Owners**: @saas-team
- **Tags**: billing, subscription
- **File**: `packages/examples/saas-boilerplate/src/billing/billing.presentation.ts`field.route.label/docs/reference/saas-boilerplate/saas.billing.subscription
referencepublic
field.summary.labelGet organization subscription status.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @example.saas-boilerplate
- **Tags**: saas, billing, subscription
- **File**: `packages/examples/saas-boilerplate/src/billing/billing.operations.ts`field.route.label/docs/reference/saas-boilerplate/saas.billing.subscription.get
referencepublic
field.summary.labelTest for getting subscription
- **Type**: test-spec (test-spec)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @example.saas-boilerplate
- **Tags**: test
- **File**: `packages/examples/saas-boilerplate/src/tests/operations.test-spec.ts`field.route.label/docs/reference/saas-boilerplate/saas.billing.subscription.get.test
referencepublic
field.summary.labelUsage metrics and breakdown by resource type
- **Type**: presentation (presentation)
- **Version**: 1.0.0
- **Owners**: @saas-team
- **Tags**: billing, usage, metrics
- **File**: `packages/examples/saas-boilerplate/src/billing/billing.presentation.ts`field.route.label/docs/reference/saas-boilerplate/saas.billing.usage
referencepublic
field.summary.labelRecord usage of a metered feature.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @example.saas-boilerplate
- **Tags**: saas, billing, usage
- **File**: `packages/examples/saas-boilerplate/src/billing/billing.operations.ts`field.route.label/docs/reference/saas-boilerplate/saas.billing.usage.record
referencepublic
field.summary.labelGet usage summary for the current billing period.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @example.saas-boilerplate
- **Tags**: saas, billing, usage
- **File**: `packages/examples/saas-boilerplate/src/billing/billing.operations.ts`field.route.label/docs/reference/saas-boilerplate/saas.billing.usage.summary
referencepublic
field.summary.labelTest for getting usage summary
- **Type**: test-spec (test-spec)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @example.saas-boilerplate
- **Tags**: test
- **File**: `packages/examples/saas-boilerplate/src/tests/operations.test-spec.ts`field.route.label/docs/reference/saas-boilerplate/saas.billing.usage.summary.test
referencepublic
field.summary.labelMain SaaS dashboard with project overview, usage stats, and quick actions
- **Type**: presentation (presentation)
- **Version**: 1.0.0
- **Owners**: @saas-team
- **Tags**: dashboard, overview
- **File**: `packages/examples/saas-boilerplate/src/dashboard/dashboard.presentation.ts`field.route.label/docs/reference/saas-boilerplate/saas.dashboard
referencepublic
field.summary.labelCreate a new project in the organization.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: example.saas-boilerplate
- **Tags**: saas, project, create
- **File**: `packages/examples/saas-boilerplate/src/project/project.operations.ts`field.route.label/docs/reference/saas-boilerplate/saas.project.create
referencepublic
field.summary.labelDelete a project (soft delete).
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: example.saas-boilerplate
- **Tags**: saas, project, delete
- **File**: `packages/examples/saas-boilerplate/src/project/project.operations.ts`field.route.label/docs/reference/saas-boilerplate/saas.project.delete
referencepublic
field.summary.labelDetailed view of a project with settings and activity
- **Type**: presentation (presentation)
- **Version**: 1.0.0
- **Owners**: @saas-team
- **Tags**: project, detail
- **File**: `packages/examples/saas-boilerplate/src/project/project.presentation.ts`field.route.label/docs/reference/saas-boilerplate/saas.project.detail
referencepublic
field.summary.labelGet a project by ID.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: example.saas-boilerplate
- **Tags**: saas, project, get
- **File**: `packages/examples/saas-boilerplate/src/project/project.operations.ts`field.route.label/docs/reference/saas-boilerplate/saas.project.get
referencepublic
field.summary.labelTest for getting project
- **Type**: test-spec (test-spec)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @example.saas-boilerplate
- **Tags**: test
- **File**: `packages/examples/saas-boilerplate/src/tests/operations.test-spec.ts`field.route.label/docs/reference/saas-boilerplate/saas.project.get.test
referencepublic
field.summary.labelList view of projects with status, tags, and last updated info
- **Type**: presentation (presentation)
- **Version**: 1.0.0
- **Owners**: @saas-team
- **Tags**: project, list, dashboard
- **File**: `packages/examples/saas-boilerplate/src/project/project.presentation.ts`field.route.label/docs/reference/saas-boilerplate/saas.project.list
referencepublic
field.summary.labelTest for listing projects
- **Type**: test-spec (test-spec)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @example.saas-boilerplate
- **Tags**: test
- **File**: `packages/examples/saas-boilerplate/src/tests/operations.test-spec.ts`field.route.label/docs/reference/saas-boilerplate/saas.project.list.test
referencepublic
field.summary.labelUpdate project details.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: example.saas-boilerplate
- **Tags**: saas, project, update
- **File**: `packages/examples/saas-boilerplate/src/project/project.operations.ts`field.route.label/docs/reference/saas-boilerplate/saas.project.update
referencepublic
field.summary.labelOrganization and user settings panel
- **Type**: presentation (presentation)
- **Version**: 1.0.0
- **Owners**: @saas-team
- **Tags**: settings, config
- **File**: `packages/examples/saas-boilerplate/src/dashboard/dashboard.presentation.ts`field.route.label/docs/reference/saas-boilerplate/saas.settings
referencepublic
field.summary.labelInvoice creation and payment tracking
- **Type**: capability (capability)
- **Version**: 1.0.0
- **Owners**: platform.finance
- **Tags**: invoices, billing
- **File**: `packages/examples/service-business-os/src/service-business-os.capability.ts`field.route.label/docs/reference/service-business-os/invoices
referencepublic
field.summary.labelQuote generation and management for service businesses
- **Type**: capability (capability)
- **Version**: 1.0.0
- **Owners**: platform.core
- **Tags**: quotes, service, business
- **File**: `packages/examples/service-business-os/src/service-business-os.capability.ts`field.route.label/docs/reference/service-business-os/quotes
referencepublic
field.summary.labelQuotes → jobs → invoices → payments for field services and agencies.
- **Type**: feature
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @service-os
- **Tags**: services, quotes, jobs, invoices, paymentsfield.route.label/docs/reference/service-business-os/service-business-os
referencepublic
field.summary.labelList of service clients
- **Type**: presentation (presentation)
- **Version**: 1.0.0
- **Owners**: @service-os
- **Tags**: services, clients, list
- **File**: `packages/examples/service-business-os/src/presentations.ts`field.route.label/docs/reference/service-business-os/service-business-os.client.list
referencepublic
field.summary.labelService business dashboard with overview metrics
- **Type**: presentation (presentation)
- **Version**: 1.0.0
- **Owners**: @service-os
- **Tags**: services, dashboard
- **File**: `packages/examples/service-business-os/src/presentations.ts`field.route.label/docs/reference/service-business-os/service-business-os.dashboard
referencepublic
field.summary.labelList of invoices with payment status
- **Type**: presentation (presentation)
- **Version**: 1.0.0
- **Owners**: @service-os
- **Tags**: services, invoices, list
- **File**: `packages/examples/service-business-os/src/presentations.ts`field.route.label/docs/reference/service-business-os/service-business-os.invoice.list
referencepublic
field.summary.labelJob board with kanban view
- **Type**: presentation (presentation)
- **Version**: 1.0.0
- **Owners**: @service-os
- **Tags**: services, jobs, board, kanban
- **File**: `packages/examples/service-business-os/src/presentations.ts`field.route.label/docs/reference/service-business-os/service-business-os.job.board
referencepublic
field.summary.labelList of payments received
- **Type**: presentation (presentation)
- **Version**: 1.0.0
- **Owners**: @service-os
- **Tags**: services, payments, list
- **File**: `packages/examples/service-business-os/src/presentations.ts`field.route.label/docs/reference/service-business-os/service-business-os.payment.list
referencepublic
field.summary.labelQuote detail with line items
- **Type**: presentation (presentation)
- **Version**: 1.0.0
- **Owners**: @service-os
- **Tags**: services, quote, detail
- **File**: `packages/examples/service-business-os/src/presentations.ts`field.route.label/docs/reference/service-business-os/service-business-os.quote.detail
referencepublic
field.summary.labelList of quotes with status
- **Type**: presentation (presentation)
- **Version**: 1.0.0
- **Owners**: @service-os
- **Tags**: services, quotes, list
- **File**: `packages/examples/service-business-os/src/presentations.ts`field.route.label/docs/reference/service-business-os/service-business-os.quote.list
referencepublic
field.summary.labelCreate a new client.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @examples.service-business-os
- **Tags**: service-business-os, client, create
- **File**: `packages/examples/service-business-os/src/client/client.operations.ts`field.route.label/docs/reference/service-business-os/service.client.create
referencepublic
field.summary.labelIssue an invoice for a job.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @examples.service-business-os
- **Tags**: service-business-os, invoice, issue
- **File**: `packages/examples/service-business-os/src/invoice/invoice.operations.ts`field.route.label/docs/reference/service-business-os/service.invoice.issue
referencepublic
field.summary.labelAn invoice was issued.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @service-os
- **Tags**: service, invoice, issued
- **File**: `packages/examples/service-business-os/src/events.ts`field.route.label/docs/reference/service-business-os/service.invoice.issued
referencepublic
field.summary.labelMark a job as complete.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @examples.service-business-os
- **Tags**: service-business-os, job, complete
- **File**: `packages/examples/service-business-os/src/job/job.operations.ts`field.route.label/docs/reference/service-business-os/service.job.complete
referencepublic
field.summary.labelA job was completed.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @service-os
- **Tags**: service, job, completed
- **File**: `packages/examples/service-business-os/src/events.ts`field.route.label/docs/reference/service-business-os/service.job.completed
referencepublic
field.summary.labelList all jobs with filtering
- **Type**: operation (query)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @examples.service-business-os
- **Tags**: service-business-os, job, list, query
- **File**: `packages/examples/service-business-os/src/job/job.operations.ts`field.route.label/docs/reference/service-business-os/service.job.list
referencepublic
field.summary.labelSchedule a job.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @examples.service-business-os
- **Tags**: service-business-os, job, schedule
- **File**: `packages/examples/service-business-os/src/job/job.operations.ts`field.route.label/docs/reference/service-business-os/service.job.schedule
referencepublic
field.summary.labelA job was scheduled.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @service-os
- **Tags**: service, job, scheduled
- **File**: `packages/examples/service-business-os/src/events.ts`field.route.label/docs/reference/service-business-os/service.job.scheduled
referencepublic
field.summary.labelA payment was recorded.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @service-os
- **Tags**: service, payment, received
- **File**: `packages/examples/service-business-os/src/events.ts`field.route.label/docs/reference/service-business-os/service.payment.received
referencepublic
field.summary.labelRecord a payment.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @examples.service-business-os
- **Tags**: service-business-os, payment, record
- **File**: `packages/examples/service-business-os/src/payment/payment.operations.ts`field.route.label/docs/reference/service-business-os/service.payment.record
referencepublic
field.summary.labelAccept a quote.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @examples.service-business-os
- **Tags**: service-business-os, quote, accept
- **File**: `packages/examples/service-business-os/src/quote/quote.operations.ts`field.route.label/docs/reference/service-business-os/service.quote.accept
referencepublic
field.summary.labelA quote was accepted.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @service-os
- **Tags**: service, quote, accepted
- **File**: `packages/examples/service-business-os/src/events.ts`field.route.label/docs/reference/service-business-os/service.quote.accepted
referencepublic
field.summary.labelCreate a quote/proposal.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @examples.service-business-os
- **Tags**: service-business-os, quote, create
- **File**: `packages/examples/service-business-os/src/quote/quote.operations.ts`field.route.label/docs/reference/service-business-os/service.quote.create
referencepublic
field.summary.labelA quote was sent to the client.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @service-os
- **Tags**: service, quote, sent
- **File**: `packages/examples/service-business-os/src/events.ts`field.route.label/docs/reference/service-business-os/service.quote.sent
referencepublic
field.summary.labelTeam announcements and communications
- **Type**: capability (capability)
- **Version**: 1.0.0
- **Owners**: platform.messaging
- **Tags**: announcements, messaging
- **File**: `packages/examples/team-hub/src/team-hub.capability.ts`field.route.label/docs/reference/team-hub/announcements
referencepublic
field.summary.labelTeam rituals like standups and retrospectives
- **Type**: capability (capability)
- **Version**: 1.0.0
- **Owners**: platform.core
- **Tags**: rituals, team, meetings
- **File**: `packages/examples/team-hub/src/team-hub.capability.ts`field.route.label/docs/reference/team-hub/rituals
referencepublic
field.summary.labelTask management for teams
- **Type**: capability (capability)
- **Version**: 1.0.0
- **Owners**: platform.core
- **Tags**: tasks, collaboration
- **File**: `packages/examples/team-hub/src/team-hub.capability.ts`field.route.label/docs/reference/team-hub/tasks
referencepublic
field.summary.labelTasks, rituals, and announcements for internal teams with ceremonies.
- **Type**: feature
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @team-hub
- **Tags**: tasks, rituals, announcementsfield.route.label/docs/reference/team-hub/team-hub
referencepublic
field.summary.labelFeed of team announcements.
- **Type**: presentation (presentation)
- **Version**: 1.0.0
- **Owners**: @team-hub
- **Tags**: announcement, feed
- **File**: `packages/examples/team-hub/src/presentations/team-hub.presentation.ts`field.route.label/docs/reference/team-hub/team-hub.announcement.feed
referencepublic
field.summary.labelMain team hub dashboard.
- **Type**: presentation (presentation)
- **Version**: 1.0.0
- **Owners**: @team-hub
- **Tags**: dashboard, team
- **File**: `packages/examples/team-hub/src/presentations/team-hub.presentation.ts`field.route.label/docs/reference/team-hub/team-hub.dashboard
referencepublic
field.summary.labelCalendar of team rituals and events.
- **Type**: presentation (presentation)
- **Version**: 1.0.0
- **Owners**: @team-hub
- **Tags**: ritual, calendar
- **File**: `packages/examples/team-hub/src/presentations/team-hub.presentation.ts`field.route.label/docs/reference/team-hub/team-hub.ritual.calendar
referencepublic
field.summary.labelList of team spaces.
- **Type**: presentation (presentation)
- **Version**: 1.0.0
- **Owners**: @team-hub
- **Tags**: space, list
- **File**: `packages/examples/team-hub/src/presentations/team-hub.presentation.ts`field.route.label/docs/reference/team-hub/team-hub.space.list
referencepublic
field.summary.labelKanban board for team tasks.
- **Type**: presentation (presentation)
- **Version**: 1.0.0
- **Owners**: @team-hub
- **Tags**: task, board
- **File**: `packages/examples/team-hub/src/presentations/team-hub.presentation.ts`field.route.label/docs/reference/team-hub/team-hub.task.board
referencepublic
field.summary.labelDetailed view of a task.
- **Type**: presentation (presentation)
- **Version**: 1.0.0
- **Owners**: @team-hub
- **Tags**: task, detail
- **File**: `packages/examples/team-hub/src/presentations/team-hub.presentation.ts`field.route.label/docs/reference/team-hub/team-hub.task.detail
referencepublic
field.summary.labelPost an announcement.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @examples.team-hub
- **Tags**: team-hub, announcement, post
- **File**: `packages/examples/team-hub/src/announcement/announcement.operations.ts`field.route.label/docs/reference/team-hub/team.announcement.post
referencepublic
field.summary.labelAn announcement was posted.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @team-hub
- **Tags**: team, announcement, posted
- **File**: `packages/examples/team-hub/src/events.ts`field.route.label/docs/reference/team-hub/team.announcement.posted
referencepublic
field.summary.labelLog a ritual occurrence.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @examples.team-hub
- **Tags**: team-hub, ritual, log
- **File**: `packages/examples/team-hub/src/ritual/ritual.operations.ts`field.route.label/docs/reference/team-hub/team.ritual.logOccurrence
referencepublic
field.summary.labelA ritual occurrence was logged.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @team-hub
- **Tags**: team, ritual, occurred
- **File**: `packages/examples/team-hub/src/events.ts`field.route.label/docs/reference/team-hub/team.ritual.occurred
referencepublic
field.summary.labelSchedule a recurring ritual.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @examples.team-hub
- **Tags**: team-hub, ritual, schedule
- **File**: `packages/examples/team-hub/src/ritual/ritual.operations.ts`field.route.label/docs/reference/team-hub/team.ritual.schedule
referencepublic
field.summary.labelA ritual was scheduled.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @team-hub
- **Tags**: team, ritual, scheduled
- **File**: `packages/examples/team-hub/src/events.ts`field.route.label/docs/reference/team-hub/team.ritual.scheduled
referencepublic
field.summary.labelCreate a new team space.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @examples.team-hub
- **Tags**: team-hub, space, create
- **File**: `packages/examples/team-hub/src/space/space.operations.ts`field.route.label/docs/reference/team-hub/team.space.create
referencepublic
field.summary.labelA space was created.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @team-hub
- **Tags**: team, space, created
- **File**: `packages/examples/team-hub/src/events.ts`
```typescriptfield.route.label/docs/reference/team-hub/team.space.created
referencepublic
field.summary.labelCreate a task.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @examples.team-hub
- **Tags**: team-hub, task, create
- **File**: `packages/examples/team-hub/src/task/task.operations.ts`field.route.label/docs/reference/team-hub/team.task.create
referencepublic
field.summary.labelA task was created.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @team-hub
- **Tags**: team, task, created
- **File**: `packages/examples/team-hub/src/events.ts`
```typescriptfield.route.label/docs/reference/team-hub/team.task.created
referencepublic
field.summary.labelList all tasks with filtering
- **Type**: operation (query)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @examples.team-hub
- **Tags**: team-hub, task, list, query
- **File**: `packages/examples/team-hub/src/task/task.operations.ts`field.route.label/docs/reference/team-hub/team.task.list
referencepublic
field.summary.labelA task status changed.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @team-hub
- **Tags**: team, task, status_changed
- **File**: `packages/examples/team-hub/src/events.ts`field.route.label/docs/reference/team-hub/team.task.status_changed
referencepublic
field.summary.labelUpdate task status.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @examples.team-hub
- **Tags**: team-hub, task, status
- **File**: `packages/examples/team-hub/src/task/task.operations.ts`field.route.label/docs/reference/team-hub/team.task.updateStatus
referencepublic
field.summary.labelMistral integration providing chat completions and embedding generation.
- **Type**: integration (integration)
- **Version**: 1.0.0
- **Owners**: platform.ai
- **Tags**: ai, llm, embeddings
- **File**: `packages/libs/contracts-spec/src/integrations/providers/mistral.ts`field.route.label/docs/reference/unknown/ai-llm.mistral
referencepublic
field.summary.labelElevenLabs integration for neural voice synthesis and voice catalog access.
- **Type**: integration (integration)
- **Version**: 1.0.0
- **Owners**: platform.ai
- **Tags**: voice, tts
- **File**: `packages/libs/contracts-spec/src/integrations/providers/elevenlabs.ts`field.route.label/docs/reference/unknown/ai-voice.elevenlabs
referencepublic
field.summary.labelFal integration for voice synthesis using Chatterbox text-to-speech models.
- **Type**: integration (integration)
- **Version**: 1.0.0
- **Owners**: platform.ai
- **Tags**: voice, tts, chatterbox
- **File**: `packages/libs/contracts-spec/src/integrations/providers/fal.ts`field.route.label/docs/reference/unknown/ai-voice.fal
referencepublic
field.summary.labelGradium integration for low-latency voice synthesis and voice catalog access.
- **Type**: integration (integration)
- **Version**: 1.0.0
- **Owners**: platform.ai
- **Tags**: voice, tts, realtime
- **File**: `packages/libs/contracts-spec/src/integrations/providers/gradium.ts`field.route.label/docs/reference/unknown/ai-voice.gradium
referencepublic
field.summary.labelPostHog integration for product analytics, feature flags, HogQL queries, and LLM analytics with evaluations.
- **Type**: integration (integration)
- **Version**: 1.1.0
- **Owners**: @platform.integrationsfield.route.label/docs/reference/unknown/analytics.posthog
referencepublic
field.summary.labelComplete onboarding and finalize user/organization setup
- **Type**: operation (command)
- **Version**: 1.0.0
- **Tags**: onboarding
- **File**: `packages/libs/contracts-spec/src/onboarding-base.ts`
Transition from draft to active profilefield.route.label/docs/reference/unknown/base.onboarding.complete
referencepublic
field.summary.labelDelete onboarding draft for active organization
- **Type**: operation (command)
- **Version**: 1.0.0
- **Tags**: onboarding, draft
- **File**: `packages/libs/contracts-spec/src/onboarding-base.ts`
Clear draft after completion or if user wants to restartfield.route.label/docs/reference/unknown/base.onboarding.deleteDraft
referencepublic
field.summary.labelGet onboarding draft for active organization
- **Type**: operation (query)
- **Version**: 1.0.0
- **Tags**: onboarding, draft
- **File**: `packages/libs/contracts-spec/src/onboarding-base.ts`
Retrieve saved onboarding progressfield.route.label/docs/reference/unknown/base.onboarding.getDraft
referencepublic
field.summary.labelSave or update onboarding draft for active organization
- **Type**: operation (command)
- **Version**: 1.0.0
- **Tags**: onboarding, draft
- **File**: `packages/libs/contracts-spec/src/onboarding-base.ts`
Persist onboarding progress incrementally for resumption and safetyfield.route.label/docs/reference/unknown/base.onboarding.saveDraft
referencepublic
field.summary.labelGoogle Calendar integration for event creation, updates, and scheduling automations.
- **Type**: integration (integration)
- **Version**: 1.0.0
- **Owners**: platform.messaging
- **Tags**: calendar, googlefield.route.label/docs/reference/unknown/calendar.google
referencepublic
field.summary.labelSupabase Postgres integration for SQL query execution and transactional workloads.
- **Type**: integration (integration)
- **Version**: 1.0.0
- **Owners**: platform.infrastructure
- **Tags**: database, postgres, supabasefield.route.label/docs/reference/unknown/database.supabase
referencepublic
field.summary.labelResolve a contract into a documentation-ready reference.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Tags**: reference
- **File**: `packages/libs/contracts-spec/src/docs/queries/contractReference.query.ts`field.route.label/docs/reference/unknown/docs.contract.reference
referencepublic
field.summary.labelGenerate documentation artifacts from ContractSpecs.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Tags**: generation
- **File**: `packages/libs/contracts-spec/src/docs/commands/docsGenerate.command.ts`field.route.label/docs/reference/unknown/docs.generate
referencepublic
field.summary.labelEmitted when documentation artifacts are generated.
- **Type**: event (event)
- **Version**: 1.0.0
- **Tags**: generation
- **File**: `packages/libs/contracts-spec/src/docs/events/docsGenerated.event.ts`
```typescriptfield.route.label/docs/reference/unknown/docs.generated
referencepublic
field.summary.labelShared layout shell for documentation pages.
- **Type**: presentation (presentation)
- **Version**: 1.0.0
- **Tags**: layout
- **File**: `packages/libs/contracts-spec/src/docs/presentations/docsLayout.presentation.ts`field.route.label/docs/reference/unknown/docs.layout
referencepublic
field.summary.labelPublish generated documentation artifacts.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Tags**: publish
- **File**: `packages/libs/contracts-spec/src/docs/commands/docsPublish.command.ts`
Deploy docs to the public docs surface with consistent versioning.field.route.label/docs/reference/unknown/docs.publish
referencepublic
field.summary.labelEmitted when documentation is published.
- **Type**: event (event)
- **Version**: 1.0.0
- **Tags**: publish
- **File**: `packages/libs/contracts-spec/src/docs/events/docsPublished.event.ts`
```typescript
export const DocsPublishedEvent = defineEvent({field.route.label/docs/reference/unknown/docs.published
referencepublic
field.summary.labelReference page layout for contract documentation.
- **Type**: presentation (presentation)
- **Version**: 1.0.0
- **Tags**: reference
- **File**: `packages/libs/contracts-spec/src/docs/presentations/docsReferencePage.presentation.ts`field.route.label/docs/reference/unknown/docs.reference.page
referencepublic
field.summary.labelSearch and filter DocBlocks by query, tag, or visibility.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Tags**: search, index
- **File**: `packages/libs/contracts-spec/src/docs/queries/docsIndex.query.ts`field.route.label/docs/reference/unknown/docs.search
referencepublic
field.summary.labelEnd-to-end docs generation, indexing, and presentation.
- **Type**: capability (capability)
- **Version**: 1.0.0
- **Tags**: system
- **File**: `packages/libs/contracts-spec/src/docs/capabilities/documentationSystem.capability.ts`field.route.label/docs/reference/unknown/docs.system
referencepublic
field.summary.labelThis document explains how operations (OperationSpec) are linked to Presentations (PresentationSpec) via Feature modules.
- Location: `@lssm-tech/lib.contracts-spec/src/features.ts`
- Field: `FeatureModuleSpec.opToPresentation?: { op: { name; version }; pres: { name; version } }[]`field.route.label/docs/reference/unknown/docs.tech.contracts.ops-to-presentation-linking
referencepublic
field.summary.labelGmail integration supporting inbound thread ingestion and outbound transactional email.
- **Type**: integration (integration)
- **Version**: 1.0.0
- **Owners**: platform.messaging
- **Tags**: email, gmail
- **File**: `packages/libs/contracts-spec/src/integrations/providers/gmail.ts`field.route.label/docs/reference/unknown/email.gmail
referencepublic
field.summary.labelPostmark integration for transactional email delivery.
- **Type**: integration (integration)
- **Version**: 1.0.0
- **Owners**: platform.messaging
- **Tags**: email, transactional
- **File**: `packages/libs/contracts-spec/src/integrations/providers/postmark.ts`field.route.label/docs/reference/unknown/email.postmark
referencepublic
field.summary.labelCore integrations capability for third-party connections
- **Type**: capability (capability)
- **Version**: 1.0.0
- **Owners**: @platform.core
- **Tags**: integrations, platform
- **File**: `packages/libs/contracts-spec/src/integrations/integrations.capability.ts`field.route.label/docs/reference/unknown/integrations
referencepublic
field.summary.labelCreate a new integration connection for a tenant.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @platform.integrations
- **Tags**: integration, connectionsfield.route.label/docs/reference/unknown/integrations.connection.create
referencepublic
field.summary.labelDelete an integration connection for a tenant.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @platform.integrations
- **Tags**: integration, connections
- **File**: `packages/libs/contracts-spec/src/integrations/operations.ts`field.route.label/docs/reference/unknown/integrations.connection.delete
referencepublic
field.summary.labelList integration connections for a tenant.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @platform.integrations
- **Tags**: integration, connections
- **File**: `packages/libs/contracts-spec/src/integrations/operations.ts`field.route.label/docs/reference/unknown/integrations.connection.list
referencepublic
field.summary.labelRun a health check against a configured integration connection.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @platform.integrations
- **Tags**: integration, connectionsfield.route.label/docs/reference/unknown/integrations.connection.test
referencepublic
field.summary.labelUpdate metadata or credentials for an integration connection.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @platform.integrations
- **Tags**: integration, connectionsfield.route.label/docs/reference/unknown/integrations.connection.update
referencepublic
field.summary.labelKnowledge base and content management capability
- **Type**: capability (capability)
- **Version**: 1.0.0
- **Owners**: @platform.content
- **Tags**: knowledge, content, data
- **File**: `packages/libs/contracts-spec/src/knowledge/knowledge.capability.ts`field.route.label/docs/reference/unknown/knowledge
referencepublic
field.summary.labelCreate a knowledge source binding for a tenant.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @platform.knowledge
- **Tags**: knowledge, sources
- **File**: `packages/libs/contracts-spec/src/knowledge/operations.ts`field.route.label/docs/reference/unknown/knowledge.source.create
referencepublic
field.summary.labelDelete a knowledge source binding for a tenant.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @platform.knowledge
- **Tags**: knowledge, sources
- **File**: `packages/libs/contracts-spec/src/knowledge/operations.ts`field.route.label/docs/reference/unknown/knowledge.source.delete
referencepublic
field.summary.labelList knowledge sources configured for a tenant.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @platform.knowledge
- **Tags**: knowledge, sources
- **File**: `packages/libs/contracts-spec/src/knowledge/operations.ts`field.route.label/docs/reference/unknown/knowledge.source.list
referencepublic
field.summary.labelTrigger an immediate sync for a knowledge source.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @platform.knowledge
- **Tags**: knowledge, sources
- **File**: `packages/libs/contracts-spec/src/knowledge/operations.ts`field.route.label/docs/reference/unknown/knowledge.source.triggerSync
referencepublic
field.summary.labelUpdate metadata or configuration for a knowledge source.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @platform.knowledge
- **Tags**: knowledge, sources
- **File**: `packages/libs/contracts-spec/src/knowledge/operations.ts`field.route.label/docs/reference/unknown/knowledge.source.update
referencepublic
field.summary.labelMeeting recorder integrations capability
- **Type**: capability (capability)
- **Version**: 1.0.0
- **Owners**: @platform.integrations
- **Tags**: meeting-recorder, transcripts, integrations
- **File**: `packages/libs/contracts-spec/src/integrations/meeting-recorder/meeting-recorder.capability.ts`field.route.label/docs/reference/unknown/meeting-recorder
referencepublic
field.summary.labelFathom External API for meetings, transcripts, and webhook events.
- **Type**: integration (integration)
- **Version**: 1.0.0
- **Owners**: platform.integrations
- **Tags**: meeting-recorder, fathom, transcriptsfield.route.label/docs/reference/unknown/meeting-recorder.fathom
referencepublic
field.summary.labelFireflies GraphQL API for meeting transcripts, metadata, and webhook events.
- **Type**: integration (integration)
- **Version**: 1.0.0
- **Owners**: platform.integrations
- **Tags**: meeting-recorder, fireflies, transcriptsfield.route.label/docs/reference/unknown/meeting-recorder.fireflies
referencepublic
field.summary.labelGranola meeting notes and transcripts via Enterprise API or MCP transport.
- **Type**: integration (integration)
- **Version**: 1.0.0
- **Owners**: platform.integrations
- **Tags**: meeting-recorder, granola, transcriptsfield.route.label/docs/reference/unknown/meeting-recorder.granola
referencepublic
field.summary.labelRetrieve metadata for a single meeting recording.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @platform.integrations
- **Tags**: meeting-recorder, meetingsfield.route.label/docs/reference/unknown/meeting-recorder.meetings.get
referencepublic
field.summary.labelList meetings recorded by the configured meeting provider.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @platform.integrations
- **Tags**: meeting-recorder, meetings, transcriptsfield.route.label/docs/reference/unknown/meeting-recorder.meetings.list
referencepublic
field.summary.labeltl;dv Public API for meeting recordings, transcripts, and webhook events.
- **Type**: integration (integration)
- **Version**: 1.0.0
- **Owners**: platform.integrations
- **Tags**: meeting-recorder, tldv, transcriptsfield.route.label/docs/reference/unknown/meeting-recorder.tldv
referencepublic
field.summary.labelFetch the transcript for a specific meeting recording.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @platform.integrations
- **Tags**: meeting-recorder, transcriptsfield.route.label/docs/reference/unknown/meeting-recorder.transcripts.get
referencepublic
field.summary.labelTrigger a transcript sync from the meeting recorder provider.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @platform.integrations
- **Tags**: meeting-recorder, transcripts, syncfield.route.label/docs/reference/unknown/meeting-recorder.transcripts.sync
referencepublic
field.summary.labelIngest a webhook from a meeting recorder provider.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @platform.integrations
- **Tags**: meeting-recorder, webhooks, transcriptsfield.route.label/docs/reference/unknown/meeting-recorder.webhooks.ingest
referencepublic
field.summary.labelOpen Banking integrations capability
- **Type**: capability (capability)
- **Version**: 1.0.0
- **Owners**: @platform.finance
- **Tags**: openbanking, finance, integrations
- **File**: `packages/libs/contracts-spec/src/integrations/openbanking/openbanking.capability.ts`field.route.label/docs/reference/unknown/openbanking
referencepublic
field.summary.labelRetrieve the canonical bank account record for the given account identifier.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @platform.finance
- **Tags**: open-banking, powens, accountsfield.route.label/docs/reference/unknown/openbanking.accounts.get
referencepublic
field.summary.labelList bank accounts available to a tenant/user via Powens Open Banking.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @platform.finance
- **Tags**: open-banking, powens, accountsfield.route.label/docs/reference/unknown/openbanking.accounts.list
referencepublic
field.summary.labelInitiate a synchronisation run to refresh bank account metadata from Powens.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @platform.finance
- **Tags**: open-banking, powens, accountsfield.route.label/docs/reference/unknown/openbanking.accounts.sync
referencepublic
field.summary.labelRetrieve the latest cached balances for a bank account.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @platform.finance
- **Tags**: open-banking, powens, balancesfield.route.label/docs/reference/unknown/openbanking.balances.get
referencepublic
field.summary.labelRefresh balances for a bank account via the configured open banking provider.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @platform.finance
- **Tags**: open-banking, powens, balancesfield.route.label/docs/reference/unknown/openbanking.balances.refresh
referencepublic
field.summary.labelRead-only Open Banking integration powered by Powens, exposing accounts, transactions, and balances.
- **Type**: integration (integration)
- **Version**: 1.0.0
- **Owners**: platform.finance
- **Tags**: open-banking, powens, financefield.route.label/docs/reference/unknown/openbanking.powens
referencepublic
field.summary.labelList bank transactions that have been normalised into the canonical ledger.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @platform.finance
- **Tags**: open-banking, powens, transactionsfield.route.label/docs/reference/unknown/openbanking.transactions.list
referencepublic
field.summary.labelSynchronise transactions for a bank account by calling the configured open banking provider.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @platform.financefield.route.label/docs/reference/unknown/openbanking.transactions.sync
referencepublic
field.summary.labelStripe integration for payment processing, charges, and payouts.
- **Type**: integration (integration)
- **Version**: 1.0.0
- **Owners**: platform.payments
- **Tags**: payments, psp
- **File**: `packages/libs/contracts-spec/src/integrations/providers/stripe.ts`field.route.label/docs/reference/unknown/payments.stripe
referencepublic
field.summary.labelManage integration connections to external providers (e.g., Stripe, Qdrant)
- **Type**: feature
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @platform.integrations
- **Tags**: integrations, connections, platformfield.route.label/docs/reference/unknown/platform.integrations
referencepublic
field.summary.labelManage knowledge source bindings for ingestion (e.g., Notion, uploads)
- **Type**: feature
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @platform.knowledge
- **Tags**: knowledge, sources, platform, ingestionfield.route.label/docs/reference/unknown/platform.knowledge
referencepublic
field.summary.labelJira Cloud integration for creating and tracking work items.
- **Type**: integration (integration)
- **Version**: 1.0.0
- **Owners**: @platform.integrations
- **Tags**: project-management, jira
- **File**: `packages/libs/contracts-spec/src/integrations/providers/jira.ts`field.route.label/docs/reference/unknown/project-management.jira
referencepublic
field.summary.labelLinear integration for issue tracking and project management workflows.
- **Type**: integration (integration)
- **Version**: 1.0.0
- **Owners**: @platform.integrations
- **Tags**: project-management, linearfield.route.label/docs/reference/unknown/project-management.linear
referencepublic
field.summary.labelNotion integration for creating shared project summaries and task entries.
- **Type**: integration (integration)
- **Version**: 1.0.0
- **Owners**: @platform.integrations
- **Tags**: project-management, notionfield.route.label/docs/reference/unknown/project-management.notion
referencepublic
field.summary.labelRetrieves per-contract verification status for the impact report.
- **Type**: operation (query)
- **Version**: 1.0.0
- **File**: `packages/libs/contracts-spec/src/operations/report/getContractVerificationStatus.ts`field.route.label/docs/reference/unknown/report.getContractVerificationStatus
referencepublic
field.summary.labelTwilio SMS integration for transactional and notification messaging.
- **Type**: integration (integration)
- **Version**: 1.0.0
- **Owners**: platform.messaging
- **Tags**: sms, messaging
- **File**: `packages/libs/contracts-spec/src/integrations/providers/twilio-sms.ts`field.route.label/docs/reference/unknown/sms.twilio
referencepublic
field.summary.labelGoogle Cloud Storage integration for object storage and retrieval.
- **Type**: integration (integration)
- **Version**: 1.0.0
- **Owners**: platform.infrastructure
- **Tags**: storage, gcs, google-cloud
- **File**: `packages/libs/contracts-spec/src/integrations/providers/gcs-storage.ts`field.route.label/docs/reference/unknown/storage.gcs
referencepublic
field.summary.labelQdrant integration for vector search and embeddings storage.
- **Type**: integration (integration)
- **Version**: 1.0.0
- **Owners**: platform.ai
- **Tags**: vector-db, search
- **File**: `packages/libs/contracts-spec/src/integrations/providers/qdrant.ts`field.route.label/docs/reference/unknown/vectordb.qdrant
referencepublic
field.summary.labelSupabase integration for embedding storage and vector similarity search using pgvector.
- **Type**: integration (integration)
- **Version**: 1.0.0
- **Owners**: platform.ai
- **Tags**: vector-db, supabase, pgvectorfield.route.label/docs/reference/unknown/vectordb.supabase
referencepublic
field.summary.labelApprove a draft rule version.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @examples
- **Tags**: knowledge, rules, approval
- **File**: `packages/examples/versioned-knowledge-base/src/operations/kb.ts`field.route.label/docs/reference/versioned-knowledge-base/kb.approveRuleVersion
referencepublic
field.summary.labelIngest immutable source document metadata.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @examples
- **Tags**: knowledge, sources, ingestion
- **File**: `packages/examples/versioned-knowledge-base/src/operations/kb.ts`field.route.label/docs/reference/versioned-knowledge-base/kb.ingestSource
referencepublic
field.summary.labelPublish a KB snapshot for a jurisdiction.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @examples
- **Tags**: knowledge, snapshots, publishing
- **File**: `packages/examples/versioned-knowledge-base/src/operations/kb.ts`field.route.label/docs/reference/versioned-knowledge-base/kb.publishSnapshot
referencepublic
field.summary.labelRule version approved (human verified).
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @examples
- **Tags**: knowledge
- **File**: `packages/examples/versioned-knowledge-base/src/events.ts`field.route.label/docs/reference/versioned-knowledge-base/kb.ruleVersion.approved
referencepublic
field.summary.labelRule version created (draft).
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @examples
- **Tags**: knowledge
- **File**: `packages/examples/versioned-knowledge-base/src/events.ts`field.route.label/docs/reference/versioned-knowledge-base/kb.ruleVersion.created
referencepublic
field.summary.labelSearch within a published KB snapshot.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @examples
- **Tags**: knowledge, search, snapshots
- **File**: `packages/examples/versioned-knowledge-base/src/operations/kb.ts`field.route.label/docs/reference/versioned-knowledge-base/kb.search
referencepublic
field.summary.labelKB snapshot published.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @examples
- **Tags**: knowledge
- **File**: `packages/examples/versioned-knowledge-base/src/events.ts`field.route.label/docs/reference/versioned-knowledge-base/kb.snapshot.published
referencepublic
field.summary.labelSource document ingested (immutable).
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @examples
- **Tags**: knowledge
- **File**: `packages/examples/versioned-knowledge-base/src/events.ts`field.route.label/docs/reference/versioned-knowledge-base/kb.source.ingested
referencepublic
field.summary.labelCreate a new draft rule version with source references.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @examples
- **Tags**: knowledge, rules, versioning
- **File**: `packages/examples/versioned-knowledge-base/src/operations/kb.ts`field.route.label/docs/reference/versioned-knowledge-base/kb.upsertRuleVersion
referencepublic
field.summary.labelCurated KB with immutable sources, rule versions, and published snapshots.
- **Type**: feature
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @examples
- **Tags**: knowledge, versioning, snapshotsfield.route.label/docs/reference/versioned-knowledge-base/versioned-knowledge-base
referencepublic
field.summary.label- **Type**: operation (command)
- **Version**: 1.0.0
- **File**: `packages/examples/video-api-showcase/src/sample-specs.ts`
```typescript
export const createUser = defineCommand({
meta: {
name: "CreateUser",field.route.label/docs/reference/video-api-showcase/createUser
referencepublic
field.summary.label- **Type**: operation (query)
- **Version**: 1.0.0
- **File**: `packages/examples/video-api-showcase/src/sample-specs.ts`
```typescript
export const listTransactions = defineQuery({
meta: {
name: "ListTransactions",field.route.label/docs/reference/video-api-showcase/listTransactions
referencepublic
field.summary.label- **Type**: operation (command)
- **Version**: 1.0.0
- **File**: `packages/examples/video-api-showcase/src/sample-specs.ts`
```typescript
export const sendNotification = defineCommand({
meta: {
name: "SendNotification",field.route.label/docs/reference/video-api-showcase/sendNotification
referencepublic
field.summary.labelGenerate API documentation videos from contract spec metadata
- **Type**: feature
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @examples
- **Tags**: video, api, documentation, showcase
- **File**: `packages/examples/video-api-showcase/src/video-api-showcase.feature.ts`field.route.label/docs/reference/video-api-showcase/video-api-showcase
referencepublic
field.summary.labelGenerate terminal demo videos from CLI walkthroughs with narration
- **Type**: feature
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @examples
- **Tags**: video, terminal, docs, tutorial
- **File**: `packages/examples/video-docs-terminal/src/video-docs-terminal.feature.ts`field.route.label/docs/reference/video-docs-terminal/video-docs-terminal
referencepublic
field.summary.labelGenerate short-form marketing videos from content briefs
- **Type**: feature
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @examples
- **Tags**: video, marketing, clips, content
- **File**: `packages/examples/video-marketing-clip/src/video-marketing-clip.feature.ts`field.route.label/docs/reference/video-marketing-clip/video-marketing-clip
referencepublic
field.summary.labelContractSpec visualization primitives rendered through shared design-system wrappers.
- **Type**: feature
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @platform.core
- **Tags**: visualization, charts, showcasefield.route.label/docs/reference/visualization-showcase/visualization-showcase
referencepublic
field.summary.labelFocused showcase of ContractSpec visualization primitives.
- **Type**: presentation (presentation)
- **Version**: 1.0.0
- **Owners**: @platform.core
- **Tags**: visualization, charts, showcase
- **File**: `packages/examples/visualization-showcase/src/visualization-showcase.presentation.ts`field.route.label/docs/reference/visualization-showcase/visualization-showcase.gallery
referencepublic
field.summary.labelVoice provider integration for TTS synthesis with multiple providers
- **Type**: feature
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @examples
- **Tags**: voice, tts, providers, synthesisfield.route.label/docs/reference/voice-providers/voice-providers
referencepublic
field.summary.labelFinancial accounts tracking and aggregation
- **Type**: capability (capability)
- **Version**: 1.0.0
- **Owners**: platform.finance
- **Tags**: accounts, finance, wealth
- **File**: `packages/examples/wealth-snapshot/src/wealth-snapshot.capability.ts`field.route.label/docs/reference/wealth-snapshot/accounts
referencepublic
field.summary.labelFinancial goal setting and progress tracking
- **Type**: capability (capability)
- **Version**: 1.0.0
- **Owners**: platform.finance
- **Tags**: goals, planning, wealth
- **File**: `packages/examples/wealth-snapshot/src/wealth-snapshot.capability.ts`field.route.label/docs/reference/wealth-snapshot/goals
referencepublic
field.summary.labelNet worth visualization and tracking
- **Type**: capability (capability)
- **Version**: 1.0.0
- **Owners**: platform.finance
- **Tags**: net-worth, wealth, dashboard
- **File**: `packages/examples/wealth-snapshot/src/wealth-snapshot.capability.ts`field.route.label/docs/reference/wealth-snapshot/net-worth
referencepublic
field.summary.labelMini-app for accounts, assets, liabilities, goals, and net worth.
- **Type**: feature
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @wealth-snapshot
- **Tags**: finance, net-worth, goals
- **File**: `packages/examples/wealth-snapshot/src/wealth-snapshot.feature.ts`field.route.label/docs/reference/wealth-snapshot/wealth-snapshot
referencepublic
field.summary.labelList of financial accounts
- **Type**: presentation (presentation)
- **Version**: 1.0.0
- **Owners**: @wealth-snapshot
- **Tags**: finance, accounts, list
- **File**: `packages/examples/wealth-snapshot/src/presentations.ts`field.route.label/docs/reference/wealth-snapshot/wealth-snapshot.accounts.list
referencepublic
field.summary.labelList of assets with valuations
- **Type**: presentation (presentation)
- **Version**: 1.0.0
- **Owners**: @wealth-snapshot
- **Tags**: finance, assets, list
- **File**: `packages/examples/wealth-snapshot/src/presentations.ts`field.route.label/docs/reference/wealth-snapshot/wealth-snapshot.assets.list
referencepublic
field.summary.labelWealth snapshot dashboard with net worth overview
- **Type**: presentation (presentation)
- **Version**: 1.0.0
- **Owners**: @wealth-snapshot
- **Tags**: finance, wealth, dashboard
- **File**: `packages/examples/wealth-snapshot/src/presentations.ts`field.route.label/docs/reference/wealth-snapshot/wealth-snapshot.dashboard
referencepublic
field.summary.labelList of financial goals with progress
- **Type**: presentation (presentation)
- **Version**: 1.0.0
- **Owners**: @wealth-snapshot
- **Tags**: finance, goals, list
- **File**: `packages/examples/wealth-snapshot/src/presentations.ts`field.route.label/docs/reference/wealth-snapshot/wealth-snapshot.goals.list
referencepublic
field.summary.labelList of liabilities and debts
- **Type**: presentation (presentation)
- **Version**: 1.0.0
- **Owners**: @wealth-snapshot
- **Tags**: finance, liabilities, list
- **File**: `packages/examples/wealth-snapshot/src/presentations.ts`field.route.label/docs/reference/wealth-snapshot/wealth-snapshot.liabilities.list
referencepublic
field.summary.labelCreate a financial account.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: examples.wealth-snapshot
- **Tags**: wealth, account, create
- **File**: `packages/examples/wealth-snapshot/src/operations/index.ts`field.route.label/docs/reference/wealth-snapshot/wealth.account.create
referencepublic
field.summary.labelAdd an asset position.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: examples.wealth-snapshot
- **Tags**: wealth, asset, add
- **File**: `packages/examples/wealth-snapshot/src/operations/index.ts`field.route.label/docs/reference/wealth-snapshot/wealth.asset.add
referencepublic
field.summary.labelAn asset was added or updated.
- **Type**: event (event)
- **Version**: 1.0.0
- **File**: `packages/examples/wealth-snapshot/src/events.ts`
```typescript
import { defineEvent, StabilityEnum } from '@lssm-tech/lib.contracts-spec';field.route.label/docs/reference/wealth-snapshot/wealth.asset.added
referencepublic
field.summary.labelCreate a financial goal.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: examples.wealth-snapshot
- **Tags**: wealth, goal, create
- **File**: `packages/examples/wealth-snapshot/src/operations/index.ts`field.route.label/docs/reference/wealth-snapshot/wealth.goal.create
referencepublic
field.summary.labelUpdate goal progress.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: examples.wealth-snapshot
- **Tags**: wealth, goal, update
- **File**: `packages/examples/wealth-snapshot/src/operations/index.ts`field.route.label/docs/reference/wealth-snapshot/wealth.goal.update
referencepublic
field.summary.labelA goal was updated.
- **Type**: event (event)
- **Version**: 1.0.0
- **File**: `packages/examples/wealth-snapshot/src/events.ts`
```typescript
import { defineEvent, StabilityEnum } from '@lssm-tech/lib.contracts-spec';field.route.label/docs/reference/wealth-snapshot/wealth.goal.updated
referencepublic
field.summary.labelAdd a liability.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: examples.wealth-snapshot
- **Tags**: wealth, liability, add
- **File**: `packages/examples/wealth-snapshot/src/operations/index.ts`field.route.label/docs/reference/wealth-snapshot/wealth.liability.add
referencepublic
field.summary.labelA liability was added or updated.
- **Type**: event (event)
- **Version**: 1.0.0
- **File**: `packages/examples/wealth-snapshot/src/events.ts`
```typescript
import { defineEvent, StabilityEnum } from '@lssm-tech/lib.contracts-spec';field.route.label/docs/reference/wealth-snapshot/wealth.liability.added
referencepublic
field.summary.labelGet net worth snapshots for a period.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: examples.wealth-snapshot
- **Tags**: wealth, networth
- **File**: `packages/examples/wealth-snapshot/src/operations/index.ts`field.route.label/docs/reference/wealth-snapshot/wealth.networth.get
referencepublic
field.summary.labelA net worth snapshot was generated.
- **Type**: event (event)
- **Version**: 1.0.0
- **File**: `packages/examples/wealth-snapshot/src/events.ts`
```typescript
import { defineEvent, StabilityEnum } from '@lssm-tech/lib.contracts-spec';field.route.label/docs/reference/wealth-snapshot/wealth.networth.snapshot_created
referencepublic
field.summary.labelApproval workflows and user decisions
- **Type**: capability (capability)
- **Version**: 1.0.0
- **Owners**: platform.core
- **Tags**: approval, workflow
- **File**: `packages/examples/workflow-system/src/workflow-system.capability.ts`field.route.label/docs/reference/workflow-system/approval
referencepublic
field.summary.labelState machine orchestration and transitions
- **Type**: capability (capability)
- **Version**: 1.0.0
- **Owners**: platform.core
- **Tags**: state-machine, workflow
- **File**: `packages/examples/workflow-system/src/workflow-system.capability.ts`field.route.label/docs/reference/workflow-system/state-machine
referencepublic
field.summary.labelWorkflow definitions and orchestration
- **Type**: capability (capability)
- **Version**: 1.0.0
- **Owners**: platform.core
- **Tags**: workflow, automation
- **File**: `packages/examples/workflow-system/src/workflow-system.capability.ts`field.route.label/docs/reference/workflow-system/workflow
referencepublic
field.summary.labelState machine-based workflow engine with role-based approvals, delegation, and escalation
- **Type**: feature
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @workflow-team
- **Tags**: workflow, approval, state-machine, automationfield.route.label/docs/reference/workflow-system/workflow-system
referencepublic
field.summary.labelBadge showing count of pending approvals
- **Type**: presentation (presentation)
- **Version**: 1.0.0
- **Owners**: @workflow-team
- **Tags**: workflow, approval, badge, widget
- **File**: `packages/examples/workflow-system/src/presentations/index.ts`field.route.label/docs/reference/workflow-system/workflow.approval.badge
referencepublic
field.summary.labelAdd a comment to an approval request.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @example.workflow-system
- **Tags**: workflow, approval, comment
- **File**: `packages/examples/workflow-system/src/approval/approval.operations.ts`field.route.label/docs/reference/workflow-system/workflow.approval.comment.add
referencepublic
field.summary.labelSubmit an approval decision (approve/reject).
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @example.workflow-system
- **Tags**: workflow, approval, decision
- **File**: `packages/examples/workflow-system/src/approval/approval.operations.ts`field.route.label/docs/reference/workflow-system/workflow.approval.decide
referencepublic
field.summary.labelTest for deciding on approval
- **Type**: test-spec (test-spec)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @example.workflow-system
- **Tags**: test
- **File**: `packages/examples/workflow-system/src/tests/operations.test-spec.ts`field.route.label/docs/reference/workflow-system/workflow.approval.decide.test
referencepublic
field.summary.labelAn approval decision has been made.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @workflow-team
- **Tags**: workflow, approval, decided
- **File**: `packages/examples/workflow-system/src/approval/approval.event.ts`field.route.label/docs/reference/workflow-system/workflow.approval.decided
referencepublic
field.summary.labelDelegate an approval request to another user.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @example.workflow-system
- **Tags**: workflow, approval, delegate
- **File**: `packages/examples/workflow-system/src/approval/approval.operations.ts`field.route.label/docs/reference/workflow-system/workflow.approval.delegate
referencepublic
field.summary.labelAn approval has been delegated.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @workflow-team
- **Tags**: workflow, approval, delegated
- **File**: `packages/examples/workflow-system/src/approval/approval.event.ts`field.route.label/docs/reference/workflow-system/workflow.approval.delegated
referencepublic
field.summary.labelDetailed approval request view with context and actions
- **Type**: presentation (presentation)
- **Version**: 1.0.0
- **Owners**: @workflow-team
- **Tags**: workflow, approval, detail
- **File**: `packages/examples/workflow-system/src/presentations/index.ts`field.route.label/docs/reference/workflow-system/workflow.approval.detail
referencepublic
field.summary.labelAn approval has been escalated.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @workflow-team
- **Tags**: workflow, approval, escalated
- **File**: `packages/examples/workflow-system/src/approval/approval.event.ts`field.route.label/docs/reference/workflow-system/workflow.approval.escalated
referencepublic
field.summary.labelForm for submitting approval decisions
- **Type**: presentation (presentation)
- **Version**: 1.0.0
- **Owners**: @workflow-team
- **Tags**: workflow, approval, form
- **File**: `packages/examples/workflow-system/src/presentations/index.ts`field.route.label/docs/reference/workflow-system/workflow.approval.form
referencepublic
field.summary.labelGet an approval request with details.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @example.workflow-system
- **Tags**: workflow, approval, get
- **File**: `packages/examples/workflow-system/src/approval/approval.operations.ts`field.route.label/docs/reference/workflow-system/workflow.approval.get
referencepublic
field.summary.labelInbox showing pending approval requests for current user
- **Type**: presentation (presentation)
- **Version**: 1.0.0
- **Owners**: @workflow-team
- **Tags**: workflow, approval, inbox
- **File**: `packages/examples/workflow-system/src/presentations/index.ts`field.route.label/docs/reference/workflow-system/workflow.approval.inbox
referencepublic
field.summary.labelList approval requests assigned to current user.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @example.workflow-system
- **Tags**: workflow, approval, list, inboxfield.route.label/docs/reference/workflow-system/workflow.approval.list.mine
referencepublic
field.summary.labelTest for listing my approvals
- **Type**: test-spec (test-spec)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @example.workflow-system
- **Tags**: test
- **File**: `packages/examples/workflow-system/src/tests/operations.test-spec.ts`field.route.label/docs/reference/workflow-system/workflow.approval.list.mine.test
referencepublic
field.summary.labelAn approval has been requested.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @workflow-team
- **Tags**: workflow, approval, requested
- **File**: `packages/examples/workflow-system/src/approval/approval.event.ts`field.route.label/docs/reference/workflow-system/workflow.approval.requested
referencepublic
field.summary.labelCreate a new workflow definition.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @example.workflow-system
- **Tags**: workflow, definition, create
- **File**: `packages/examples/workflow-system/src/workflow/workflow.operations.ts`field.route.label/docs/reference/workflow-system/workflow.definition.create
referencepublic
field.summary.labelA new workflow definition has been created.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @workflow-team
- **Tags**: workflow, definition, created
- **File**: `packages/examples/workflow-system/src/workflow/workflow.event.ts`field.route.label/docs/reference/workflow-system/workflow.definition.created
referencepublic
field.summary.labelDetailed view of a workflow definition with steps
- **Type**: presentation (presentation)
- **Version**: 1.0.0
- **Owners**: @workflow-team
- **Tags**: workflow, detail
- **File**: `packages/examples/workflow-system/src/presentations/index.ts`field.route.label/docs/reference/workflow-system/workflow.definition.detail
referencepublic
field.summary.labelGet a workflow definition with all steps.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @example.workflow-system
- **Tags**: workflow, definition, get
- **File**: `packages/examples/workflow-system/src/workflow/workflow.operations.ts`field.route.label/docs/reference/workflow-system/workflow.definition.get
referencepublic
field.summary.labelList workflow definitions with filtering.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @example.workflow-system
- **Tags**: workflow, definition, list
- **File**: `packages/examples/workflow-system/src/workflow/workflow.operations.ts`field.route.label/docs/reference/workflow-system/workflow.definition.list
referencepublic
field.summary.labelTest for listing workflow definitions
- **Type**: test-spec (test-spec)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @example.workflow-system
- **Tags**: test
- **File**: `packages/examples/workflow-system/src/tests/operations.test-spec.ts`field.route.label/docs/reference/workflow-system/workflow.definition.list.test
referencepublic
field.summary.labelPublish a workflow definition to make it available for use.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @example.workflow-system
- **Tags**: workflow, definition, publishfield.route.label/docs/reference/workflow-system/workflow.definition.publish
referencepublic
field.summary.labelA workflow definition has been published and is now active.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @workflow-team
- **Tags**: workflow, definition, published
- **File**: `packages/examples/workflow-system/src/workflow/workflow.event.ts`field.route.label/docs/reference/workflow-system/workflow.definition.published
referencepublic
field.summary.labelUpdate an existing workflow definition.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @example.workflow-system
- **Tags**: workflow, definition, update
- **File**: `packages/examples/workflow-system/src/workflow/workflow.operations.ts`field.route.label/docs/reference/workflow-system/workflow.definition.update
referencepublic
field.summary.labelA workflow definition has been updated.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @workflow-team
- **Tags**: workflow, definition, updated
- **File**: `packages/examples/workflow-system/src/workflow/workflow.event.ts`field.route.label/docs/reference/workflow-system/workflow.definition.updated
referencepublic
field.summary.labelList of workflow definitions with status and actions
- **Type**: presentation (presentation)
- **Version**: 1.0.0
- **Owners**: @workflow-team
- **Tags**: workflow, list, admin
- **File**: `packages/examples/workflow-system/src/presentations/index.ts`field.route.label/docs/reference/workflow-system/workflow.definition.viewList
referencepublic
field.summary.labelVisual workflow designer with drag-and-drop steps
- **Type**: presentation (presentation)
- **Version**: 1.0.0
- **Owners**: @workflow-team
- **Tags**: workflow, designer, admin
- **File**: `packages/examples/workflow-system/src/presentations/index.ts`field.route.label/docs/reference/workflow-system/workflow.designer
referencepublic
field.summary.labelCancel a workflow instance.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @example.workflow-system
- **Tags**: workflow, instance, cancel
- **File**: `packages/examples/workflow-system/src/instance/instance.operations.ts`field.route.label/docs/reference/workflow-system/workflow.instance.cancel
referencepublic
field.summary.labelA workflow instance has been cancelled.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @workflow-team
- **Tags**: workflow, instance, cancelled
- **File**: `packages/examples/workflow-system/src/instance/instance.event.ts`field.route.label/docs/reference/workflow-system/workflow.instance.cancelled
referencepublic
field.summary.labelA workflow instance has completed.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @workflow-team
- **Tags**: workflow, instance, completed
- **File**: `packages/examples/workflow-system/src/instance/instance.event.ts`field.route.label/docs/reference/workflow-system/workflow.instance.completed
referencepublic
field.summary.labelDetailed view of a workflow instance with step timeline
- **Type**: presentation (presentation)
- **Version**: 1.0.0
- **Owners**: @workflow-team
- **Tags**: workflow, instance, detail, timeline
- **File**: `packages/examples/workflow-system/src/presentations/index.ts`field.route.label/docs/reference/workflow-system/workflow.instance.detail
referencepublic
field.summary.labelA workflow instance has failed.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @workflow-team
- **Tags**: workflow, instance, failed
- **File**: `packages/examples/workflow-system/src/instance/instance.event.ts`field.route.label/docs/reference/workflow-system/workflow.instance.failed
referencepublic
field.summary.labelGet a workflow instance with details.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @example.workflow-system
- **Tags**: workflow, instance, get
- **File**: `packages/examples/workflow-system/src/instance/instance.operations.ts`field.route.label/docs/reference/workflow-system/workflow.instance.get
referencepublic
field.summary.labelList workflow instances with filtering.
- **Type**: operation (query)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @example.workflow-system
- **Tags**: workflow, instance, list
- **File**: `packages/examples/workflow-system/src/instance/instance.operations.ts`field.route.label/docs/reference/workflow-system/workflow.instance.list
referencepublic
field.summary.labelTest for listing workflow instances
- **Type**: test-spec (test-spec)
- **Version**: 1.0.0
- **Stability**: experimental
- **Owners**: @example.workflow-system
- **Tags**: test
- **File**: `packages/examples/workflow-system/src/tests/operations.test-spec.ts`field.route.label/docs/reference/workflow-system/workflow.instance.list.test
referencepublic
field.summary.labelPause a running workflow instance.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @example.workflow-system
- **Tags**: workflow, instance, pause
- **File**: `packages/examples/workflow-system/src/instance/instance.operations.ts`field.route.label/docs/reference/workflow-system/workflow.instance.pause
referencepublic
field.summary.labelA workflow instance has been paused.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @workflow-team
- **Tags**: workflow, instance, paused
- **File**: `packages/examples/workflow-system/src/instance/instance.event.ts`field.route.label/docs/reference/workflow-system/workflow.instance.paused
referencepublic
field.summary.labelVisual progress tracker showing current step in workflow
- **Type**: presentation (presentation)
- **Version**: 1.0.0
- **Owners**: @workflow-team
- **Tags**: workflow, progress, widget
- **File**: `packages/examples/workflow-system/src/presentations/index.ts`field.route.label/docs/reference/workflow-system/workflow.instance.progress
referencepublic
field.summary.labelResume a paused workflow instance.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @example.workflow-system
- **Tags**: workflow, instance, resume
- **File**: `packages/examples/workflow-system/src/instance/instance.operations.ts`field.route.label/docs/reference/workflow-system/workflow.instance.resume
referencepublic
field.summary.labelA workflow instance has been resumed.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @workflow-team
- **Tags**: workflow, instance, resumed
- **File**: `packages/examples/workflow-system/src/instance/instance.event.ts`field.route.label/docs/reference/workflow-system/workflow.instance.resumed
referencepublic
field.summary.labelStart a new workflow instance.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @example.workflow-system
- **Tags**: workflow, instance, start
- **File**: `packages/examples/workflow-system/src/instance/instance.operations.ts`field.route.label/docs/reference/workflow-system/workflow.instance.start
referencepublic
field.summary.labelA new workflow instance has been started.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @workflow-team
- **Tags**: workflow, instance, started
- **File**: `packages/examples/workflow-system/src/instance/instance.event.ts`field.route.label/docs/reference/workflow-system/workflow.instance.started
referencepublic
field.summary.labelA workflow instance has timed out.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @workflow-team
- **Tags**: workflow, instance, timeout
- **File**: `packages/examples/workflow-system/src/instance/instance.event.ts`field.route.label/docs/reference/workflow-system/workflow.instance.timedOut
referencepublic
field.summary.labelTransition a workflow instance to the next step.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @example.workflow-system
- **Tags**: workflow, instance, transition, state-machinefield.route.label/docs/reference/workflow-system/workflow.instance.transition
referencepublic
field.summary.labelList of workflow instances with status and progress
- **Type**: presentation (presentation)
- **Version**: 1.0.0
- **Owners**: @workflow-team
- **Tags**: workflow, instance, list
- **File**: `packages/examples/workflow-system/src/presentations/index.ts`field.route.label/docs/reference/workflow-system/workflow.instance.viewList
referencepublic
field.summary.labelDashboard widget showing workflow metrics and statistics
- **Type**: presentation (presentation)
- **Version**: 1.0.0
- **Owners**: @workflow-team
- **Tags**: workflow, metrics, dashboard
- **File**: `packages/examples/workflow-system/src/presentations/index.ts`field.route.label/docs/reference/workflow-system/workflow.metrics
referencepublic
field.summary.labelAdd a step to a workflow definition.
- **Type**: operation (command)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @example.workflow-system
- **Tags**: workflow, step, add
- **File**: `packages/examples/workflow-system/src/workflow/workflow.operations.ts`field.route.label/docs/reference/workflow-system/workflow.step.add
referencepublic
field.summary.labelA step has been added to a workflow definition.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @workflow-team
- **Tags**: workflow, step, added
- **File**: `packages/examples/workflow-system/src/workflow/workflow.event.ts`field.route.label/docs/reference/workflow-system/workflow.step.added
referencepublic
field.summary.labelA workflow instance has entered a new step.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @workflow-team
- **Tags**: workflow, step, entered
- **File**: `packages/examples/workflow-system/src/instance/instance.event.ts`field.route.label/docs/reference/workflow-system/workflow.step.entered
referencepublic
field.summary.labelA workflow instance has exited a step.
- **Type**: event (event)
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @workflow-team
- **Tags**: workflow, step, exited
- **File**: `packages/examples/workflow-system/src/instance/instance.event.ts`field.route.label/docs/reference/workflow-system/workflow.step.exited
referencepublic
field.summary.labelCore CLI operations for managing ContractSpec workspaces
- **Type**: feature
- **Version**: 1.0.0
- **Stability**: stable
- **Owners**: @lssm/core
- **Tags**: cli, core
- **File**: `packages/bundles/workspace/src/contracts/features/cli.feature.ts`field.route.label/docs/reference/workspace-cli/workspace-cli
referencepublic
OSS docsreferenceStart with OSS. Adopt Studio when you want the operating layer.
Previous
GitHub integration
Push execution context into GitHub workflows and automation surfaces without hidden glue.
Next
Examples
Explore runnable examples and use them as reference implementations for new systems.
Why ContractSpec
Keep educational and comparison content reachable without letting it define the primary OSS learning path.