Application API
Generated public TypeScript reference for @relkit/app.
Common APIs
For configuration and examples, read Application configuration, Provider bindings, modules.
For a complete workflow, follow upload product images.
Public imports
@relkit/app— 1200 exports@relkit/app/schema— 56 exports@relkit/app/config— 63 exports@relkit/app/routes— 91 exports@relkit/app/functions— 119 exports@relkit/app/events— 44 exports@relkit/app/realtime— 75 exports@relkit/app/agents— 182 exports@relkit/app/jobs— 414 exports@relkit/app/jobs/legacy— 33 exports@relkit/app/tasks— 45 exports@relkit/app/cache— 50 exports@relkit/app/tools— 55 exports@relkit/app/buckets— 48 exports@relkit/app/services— 45 exports
All exported APIs
Names link to their complete contracts. Re-exports share their original contract; legacy exports keep their separate identity. Examples link to the API’s inline sample, a maintained repository usage, or the shared module walkthrough.
| API | Kind | Import from | Example |
|---|---|---|---|
| AcceptControlRequest | Type | @relkit/app, @relkit/app/agents |
Module example |
| AcceptRunReceipt | Type | @relkit/app, @relkit/app/agents |
Module example |
| AcceptRunRequest | Type | @relkit/app, @relkit/app/agents |
Module example |
| AcquirePresenceLease | Type | @relkit/app, @relkit/app/realtime |
API example |
| AdmitContinuationRequest | Type | @relkit/app, @relkit/app/agents |
Module example |
| AGENT_OBSERVABILITY_PROTOCOL | Value | @relkit/app, @relkit/app/agents |
Module example |
| AGENT_OBSERVABILITY_VERSION | Value | @relkit/app, @relkit/app/agents |
Module example |
| AgentApprovalHandler | Type | @relkit/app, @relkit/app/agents |
Module example |
| AgentCapturePolicy | Type | @relkit/app, @relkit/app/agents |
API example |
| AgentCapturePolicyError | Value | @relkit/app, @relkit/app/agents |
Module example |
| AgentCaptureRecord | Type | @relkit/app, @relkit/app/agents |
API example |
| AgentChatMapping | Type | @relkit/app, @relkit/app/agents |
API example |
| AgentClientEvent | Type | @relkit/app, @relkit/app/agents |
Source example |
| agentClientEvents | Value | @relkit/app, @relkit/app/agents |
API example |
| AgentClientEvents | Type | @relkit/app, @relkit/app/agents |
API example |
| agentClientEventsEffect | Value | @relkit/app, @relkit/app/agents |
API example |
| AgentClientFor | Type | @relkit/app, @relkit/app/functions |
API example |
| AgentClientPolicy | Type | @relkit/app, @relkit/app/agents |
API example |
| AgentClientPolicyError | Value | @relkit/app, @relkit/app/agents |
Module example |
| AgentClients | Type | @relkit/app, @relkit/app/functions |
API example |
| AgentContentSink | Type | @relkit/app, @relkit/app/agents |
Module example |
| AgentControl | Type | @relkit/app, @relkit/app/agents |
API example |
| AgentConversationMessage | Type | @relkit/app, @relkit/app/agents |
Module example |
| AgentDescriptor | Type | @relkit/app, @relkit/app/agents |
Module example |
| AgentEdgeRelationship | Type | @relkit/app, @relkit/app/agents |
API example |
| AgentExecutionEvent | Type | @relkit/app, @relkit/app/agents |
Source example |
| AgentExecutionSnapshot | Type | @relkit/app, @relkit/app/agents |
Module example |
| AgentInstructions | Type | @relkit/app, @relkit/app/agents |
Module example |
| AgentLimits | Type | @relkit/app, @relkit/app/agents |
Module example |
| AgentObservabilitySink | Type | @relkit/app, @relkit/app/agents |
API example |
| AgentObservation | Type | @relkit/app, @relkit/app/agents |
Source example |
| AgentObservedEdge | Type | @relkit/app, @relkit/app/agents |
API example |
| AgentOperation | Type | @relkit/app, @relkit/app/agents |
API example |
| AgentProgressEvent | Type | @relkit/app, @relkit/app/agents |
Module example |
| AgentProgressScope | Type | @relkit/app, @relkit/app/agents |
Module example |
| AgentRef | Type | @relkit/app, @relkit/app/functions |
API example |
| AgentRefAny | Type | @relkit/app, @relkit/app/functions |
API example |
| AgentRequestScope | Type | @relkit/app, @relkit/app/agents |
Source example |
| AgentRuntimeHooks | Type | @relkit/app, @relkit/app/agents |
API example |
| AgentSpanCapture | Type | @relkit/app, @relkit/app/agents |
API example |
| AgentStateLimits | Type | @relkit/app, @relkit/app/agents |
Source example |
| AgentStateProvider | Type | @relkit/app, @relkit/app/agents |
Source example |
| AgentSteeringSource | Type | @relkit/app, @relkit/app/agents |
Module example |
| AgentTelemetry | Value | @relkit/app, @relkit/app/agents |
API example |
| AgentTelemetryLive | Value | @relkit/app, @relkit/app/agents |
API example |
| AgentTelemetryService | Type | @relkit/app, @relkit/app/agents |
Module example |
| AgentToolEvent | Type | @relkit/app, @relkit/app/agents |
Module example |
| AgentToolReferences | Type | @relkit/app, @relkit/app/agents |
Module example |
| AgentTransitionError | Type | @relkit/app, @relkit/app/agents |
Module example |
| AgentWaitingRequest | Type | @relkit/app, @relkit/app/agents |
Module example |
| AgentWaitingState | Type | @relkit/app, @relkit/app/agents |
Module example |
| ApiDocsConfig | Type | @relkit/app, @relkit/app/config |
API example |
| APP_PROVIDER_CAPABILITIES | Value | @relkit/app, @relkit/app/config |
Module example |
| AppCompatibilityConfig | Type | @relkit/app, @relkit/app/config |
API example |
| AppConstantRunner | Value | @relkit/app |
API example |
| AppConstantRunnerLive | Value | @relkit/app |
API example |
| AppDeploymentConfig | Type | @relkit/app, @relkit/app/config |
API example |
| AppendChannelEvent | Type | @relkit/app, @relkit/app/realtime |
API example |
| AppendJournalRequest | Type | @relkit/app, @relkit/app/agents |
Module example |
| AppendReceiptLookup | Type | @relkit/app, @relkit/app/realtime |
API example |
| ApplicationContextOptions | Type | @relkit/app |
API example |
| ApplicationContextResolver | Type | @relkit/app |
API example |
| ApplicationDescriptor | Type | @relkit/app, @relkit/app/config |
API example |
| ApplicationResolveOptions | Type | @relkit/app |
API example |
| AppProviderCapability | Type | @relkit/app, @relkit/app/config |
API example |
| AppProviderDefaults | Type | @relkit/app, @relkit/app/config |
API example |
| AppProviderInputs | Type | @relkit/app, @relkit/app/config |
API example |
| APPROVAL_STATES | Value | @relkit/app, @relkit/app/agents |
Module example |
| ApprovalDeniedError | Value | @relkit/app, @relkit/app/agents |
API example |
| ApprovalEffectError | Value | @relkit/app, @relkit/app/agents |
Module example |
| ApprovalMetadata | Type | @relkit/app, @relkit/app/agents |
Module example |
| ApprovalOptions | Type | @relkit/app, @relkit/app/agents |
Module example |
| ApprovalPolicy | Type | @relkit/app, @relkit/app/agents |
Module example |
| ApprovalRecord | Type | @relkit/app, @relkit/app/agents |
Module example |
| ApprovalRequiredError | Value | @relkit/app, @relkit/app/agents |
API example |
| ApprovalSideEffect | Type | @relkit/app, @relkit/app/agents |
Module example |
| ApprovalState | Type | @relkit/app, @relkit/app/agents |
Module example |
| ApprovalStateError | Value | @relkit/app, @relkit/app/agents |
API example |
| approveApproval | Value | @relkit/app, @relkit/app/agents |
API example |
| approveApprovalEffect | Value | @relkit/app, @relkit/app/agents |
API example |
| ApprovedApproval | Type | @relkit/app, @relkit/app/agents |
Module example |
| AppTelemetry | Value | @relkit/app, @relkit/app/config |
API example |
| AppTelemetryConfig | Type | @relkit/app, @relkit/app/config |
API example |
| AppTelemetryLive | Value | @relkit/app, @relkit/app/config |
API example |
| AppValidationFailure | Value | @relkit/app, @relkit/app/config |
API example |
| asProvider | Value | @relkit/app, @relkit/app/buckets |
API example |
| asProviderEffect | Value | @relkit/app, @relkit/app/buckets |
API example |
| assertAdapterMethods | Value | @relkit/app, @relkit/app/jobs |
API example |
| assertAdapterMethodsEffect | Value | @relkit/app, @relkit/app/jobs |
API example |
| assertAgentDescriptor | Value | @relkit/app, @relkit/app/agents |
API example |
| assertApprovalGranted | Value | @relkit/app, @relkit/app/agents |
API example |
| assertApprovalGrantedEffect | Value | @relkit/app, @relkit/app/agents |
API example |
| assertAuthorizedOperation | Value | @relkit/app, @relkit/app/jobs |
API example |
| assertAuthorizedOperationEffect | Value | @relkit/app, @relkit/app/jobs |
API example |
| assertBoundedString | Value | @relkit/app, @relkit/app/jobs |
API example |
| assertBoundedStringEffect | Value | @relkit/app, @relkit/app/jobs |
API example |
| assertBucketDescriptor | Value | @relkit/app, @relkit/app/buckets |
API example |
| assertBucketDescriptorEffect | Value | @relkit/app, @relkit/app/buckets |
API example |
| assertCacheDescriptor | Value | @relkit/app, @relkit/app/cache |
API example |
| assertCacheDescriptorEffect | Value | @relkit/app, @relkit/app/cache |
API example |
| assertCanonicalScalarKey | Value | @relkit/app, @relkit/app/jobs |
API example |
| assertCanonicalScalarKeyEffect | Value | @relkit/app, @relkit/app/jobs |
API example |
| assertEventDescriptor | Value | @relkit/app, @relkit/app/events |
API example |
| assertExclusiveAlias | Value | @relkit/app, @relkit/app/config |
API example |
| assertExclusiveAliasEffect | Value | @relkit/app, @relkit/app/config |
API example |
| assertFieldName | Value | @relkit/app, @relkit/app/jobs |
API example |
| assertFieldNameEffect | Value | @relkit/app, @relkit/app/jobs |
API example |
| assertJobDescriptor | Value | @relkit/app, @relkit/app/jobs |
API example |
| assertJobDescriptorEffect | Value | @relkit/app, @relkit/app/jobs |
API example |
| assertJobGrant | Value | @relkit/app, @relkit/app/jobs |
API example |
| assertJobGrantEffect | Value | @relkit/app, @relkit/app/jobs |
API example |
| assertJobName | Value | @relkit/app, @relkit/app/jobs |
API example |
| assertJobNameEffect | Value | @relkit/app, @relkit/app/jobs |
API example |
| assertJobsAdapterRuntime | Value | @relkit/app, @relkit/app/jobs |
API example |
| assertJobsAdapterRuntimeEffect | Value | @relkit/app, @relkit/app/jobs |
API example |
| assertJobsCapability | Value | @relkit/app, @relkit/app/jobs |
API example |
| assertJobsCapabilityEffect | Value | @relkit/app, @relkit/app/jobs |
API example |
| assertRequestMapping | Value | @relkit/app, @relkit/app/routes |
API example |
| assertRequestMappingEffect | Value | @relkit/app, @relkit/app/routes |
API example |
| assertResponse | Value | @relkit/app, @relkit/app/routes |
API example |
| assertResponseEffect | Value | @relkit/app, @relkit/app/routes |
API example |
| assertRfc3339Instant | Value | @relkit/app, @relkit/app/jobs |
API example |
| assertRfc3339InstantEffect | Value | @relkit/app, @relkit/app/jobs |
API example |
| assertServiceDescriptor | Value | @relkit/app, @relkit/app/services |
API example |
| assertServiceDescriptorEffect | Value | @relkit/app, @relkit/app/services |
API example |
| assertServiceMemberName | Value | @relkit/app, @relkit/app/services |
API example |
| assertServiceMemberNameEffect | Value | @relkit/app, @relkit/app/services |
API example |
| assertServiceRef | Value | @relkit/app, @relkit/app/services |
API example |
| assertServiceRefEffect | Value | @relkit/app, @relkit/app/services |
API example |
| assertSupportedJobsServiceOptions | Value | @relkit/app, @relkit/app/jobs |
API example |
| assertSupportedJobsServiceOptionsEffect | Value | @relkit/app, @relkit/app/jobs |
API example |
| assertTaskDescriptor | Value | @relkit/app, @relkit/app/jobs, @relkit/app/tasks |
API example |
| assertTaskDescriptorEffect | Value | @relkit/app, @relkit/app/jobs |
API example |
| assertToolDescriptor | Value | @relkit/app, @relkit/app/tools |
API example |
| assertToolDescriptorEffect | Value | @relkit/app, @relkit/app/tools |
API example |
| AuthContext | Type | @relkit/app, @relkit/app/functions |
API example |
| authorize | Value | @relkit/app, @relkit/app/jobs |
API example |
| authorizeJobAccess | Value | @relkit/app, @relkit/app/jobs |
API example |
| authorizeJobAccessEffect | Value | @relkit/app, @relkit/app/jobs |
API example |
| bindDescriptorIdentity | Value | @relkit/app |
API example |
| bindFunctionEvents | Value | @relkit/app, @relkit/app/events |
API example |
| BindingSource | Type | @relkit/app, @relkit/app/jobs |
Module example |
| BindingValueRef | Type | @relkit/app, @relkit/app/config |
Module example |
| BrowserMessage | Type | @relkit/app, @relkit/app/agents |
Source example |
| BrowserMessagePart | Type | @relkit/app, @relkit/app/agents |
Module example |
| BucketBridgeOptions | Type | @relkit/app, @relkit/app/buckets |
API example |
| BucketCapabilities | Type | @relkit/app, @relkit/app/buckets |
API example |
| BucketCapability | Type | @relkit/app, @relkit/app/buckets |
API example |
| BucketCapabilityError | Value | @relkit/app, @relkit/app/buckets |
API example |
| BucketClient | Type | @relkit/app, @relkit/app/functions, @relkit/app/buckets |
API example |
| BucketClientFor | Type | @relkit/app, @relkit/app/functions |
API example |
| BucketClientOptions | Type | @relkit/app, @relkit/app/buckets |
API example |
| BucketClients | Type | @relkit/app, @relkit/app/functions |
API example |
| BucketDependencyError | Value | @relkit/app, @relkit/app/buckets |
API example |
| BucketDescriptor | Type | @relkit/app, @relkit/app/buckets |
API example |
| BucketDescriptorAny | Type | @relkit/app, @relkit/app/buckets |
API example |
| BucketInvocationBridge | Type | @relkit/app, @relkit/app/buckets |
API example |
| BucketObjectMetadata | Type | @relkit/app, @relkit/app/functions, @relkit/app/buckets |
API example |
| BucketObservedEdge | Type | @relkit/app, @relkit/app/buckets |
API example |
| BucketOperation | Type | @relkit/app, @relkit/app/buckets |
API example |
| BucketOperationCancelledError | Value | @relkit/app, @relkit/app/buckets |
API example |
| BucketOperationContext | Type | @relkit/app, @relkit/app/buckets |
API example |
| BucketOperationObservation | Type | @relkit/app, @relkit/app/buckets |
API example |
| BucketOperationOutcome | Type | @relkit/app, @relkit/app/buckets |
Module example |
| BucketOperationTimeoutError | Value | @relkit/app, @relkit/app/buckets |
API example |
| BucketProvider | Type | @relkit/app, @relkit/app/buckets |
API example |
| BucketProviderError | Value | @relkit/app, @relkit/app/buckets |
API example |
| BucketProviderFailureError | Value | @relkit/app, @relkit/app/buckets |
API example |
| BucketPutOptions | Type | @relkit/app, @relkit/app/buckets |
API example |
| BucketRef | Type | @relkit/app, @relkit/app/functions |
API example |
| BucketRefAny | Type | @relkit/app, @relkit/app/functions |
API example |
| BucketRuntime | Value | @relkit/app, @relkit/app/buckets |
API example |
| bucketRuntimeLayer | Value | @relkit/app, @relkit/app/buckets |
API example |
| BucketTelemetry | Value | @relkit/app, @relkit/app/buckets |
API example |
| BucketTelemetryLive | Value | @relkit/app, @relkit/app/buckets |
API example |
| BucketValidationError | Value | @relkit/app, @relkit/app/buckets |
API example |
| BucketVisibility | Type | @relkit/app, @relkit/app/buckets |
API example |
| buildSchemaEffect | Value | @relkit/app/schema |
API example |
| CacheBridgeOptions | Type | @relkit/app, @relkit/app/cache |
API example |
| CacheCapabilities | Type | @relkit/app, @relkit/app/cache |
API example |
| CacheCapability | Type | @relkit/app, @relkit/app/cache |
API example |
| CacheCapabilityError | Value | @relkit/app, @relkit/app/cache |
API example |
| CacheClient | Type | @relkit/app, @relkit/app/functions, @relkit/app/cache |
API example |
| CacheClientBase | Type | @relkit/app, @relkit/app/cache |
API example |
| CacheClientFor | Type | @relkit/app, @relkit/app/functions |
API example |
| CacheClientOptions | Type | @relkit/app, @relkit/app/cache |
API example |
| CacheClients | Type | @relkit/app, @relkit/app/functions |
API example |
| CacheDependencyError | Value | @relkit/app, @relkit/app/cache |
API example |
| CacheDescriptor | Type | @relkit/app, @relkit/app/cache |
API example |
| CacheDescriptorAny | Type | @relkit/app, @relkit/app/cache |
API example |
| CacheDescriptorError | Value | @relkit/app, @relkit/app/cache |
API example |
| CacheDescriptorPolicy | Type | @relkit/app, @relkit/app/cache |
API example |
| CacheEffectClient | Type | @relkit/app, @relkit/app/cache |
API example |
| CacheIncrementUnsupportedError | Value | @relkit/app, @relkit/app/cache |
API example |
| CacheInvocationBridge | Type | @relkit/app, @relkit/app/cache |
API example |
| CacheNumericClient | Type | @relkit/app, @relkit/app/cache |
API example |
| CacheObservedEdge | Type | @relkit/app, @relkit/app/cache |
API example |
| CacheOperation | Type | @relkit/app, @relkit/app/cache |
API example |
| CacheOperationCancelledError | Value | @relkit/app, @relkit/app/cache |
API example |
| CacheOperationContext | Type | @relkit/app, @relkit/app/cache |
API example |
| CacheOperationError | Type | @relkit/app, @relkit/app/cache |
API example |
| CacheOperationObservation | Type | @relkit/app, @relkit/app/cache |
API example |
| CacheOperationOptions | Type | @relkit/app, @relkit/app/functions, @relkit/app/cache |
API example |
| CacheOperationOutcome | Type | @relkit/app, @relkit/app/cache |
API example |
| CacheOperationTimeoutError | Value | @relkit/app, @relkit/app/cache |
API example |
| CacheProvider | Type | @relkit/app, @relkit/app/cache |
API example |
| CacheProviderError | Value | @relkit/app, @relkit/app/cache |
API example |
| CacheProviderFailureError | Value | @relkit/app, @relkit/app/cache |
API example |
| CacheRef | Type | @relkit/app, @relkit/app/functions |
API example |
| CacheRefAny | Type | @relkit/app, @relkit/app/functions |
API example |
| CacheRuntime | Value | @relkit/app, @relkit/app/cache |
API example |
| cacheRuntimeLayer | Value | @relkit/app, @relkit/app/cache |
API example |
| CacheSchemaValidationError | Value | @relkit/app, @relkit/app/cache |
API example |
| CacheTelemetry | Value | @relkit/app, @relkit/app/cache |
API example |
| CacheTelemetryLive | Value | @relkit/app, @relkit/app/cache |
API example |
| CacheTtlPolicyError | Value | @relkit/app, @relkit/app/cache |
API example |
| CacheValidationError | Value | @relkit/app, @relkit/app/cache |
API example |
| cancelRun | Value | @relkit/app, @relkit/app/jobs |
API example |
| cancelRunEffect | Value | @relkit/app, @relkit/app/jobs |
API example |
| CanonicalTaskSubmissionOptions | Type | @relkit/app, @relkit/app/jobs |
Module example |
| captureAgentContent | Value | @relkit/app, @relkit/app/agents |
API example |
| captureAgentContentEffect | Value | @relkit/app, @relkit/app/agents |
API example |
| ChannelCheckpoint | Type | @relkit/app, @relkit/app/realtime |
API example |
| ChannelClientPolicy | Type | @relkit/app, @relkit/app/realtime |
API example |
| ChannelDescriptor | Type | @relkit/app, @relkit/app/realtime |
API example |
| ChannelDescriptorAny | Type | @relkit/app, @relkit/app/realtime |
API example |
| ChannelDescriptorData | Type | @relkit/app, @relkit/app/realtime |
API example |
| ChannelEventPage | Type | @relkit/app, @relkit/app/realtime |
API example |
| ChannelEventRecord | Type | @relkit/app, @relkit/app/realtime |
API example |
| ChannelGrant | Type | @relkit/app, @relkit/app/realtime |
API example |
| ChannelGuard | Type | @relkit/app, @relkit/app/realtime |
API example |
| ChannelPresence | Type | @relkit/app, @relkit/app/realtime |
API example |
| ChannelReplay | Type | @relkit/app, @relkit/app/realtime |
API example |
| ChannelTriggerOptions | Type | @relkit/app, @relkit/app/realtime |
API example |
| ChannelValidationError | Value | @relkit/app, @relkit/app/realtime |
API example |
| ClaimControlRequest | Type | @relkit/app, @relkit/app/agents |
Module example |
| ClaimRunRequest | Type | @relkit/app, @relkit/app/agents |
Module example |
| clientPolicyCount | Value | @relkit/app, @relkit/app/agents |
Module example |
| clientPolicyFailures | Value | @relkit/app, @relkit/app/agents |
Module example |
| CompleteRunRequest | Type | @relkit/app, @relkit/app/agents |
Module example |
| CompletionReceipt | Type | @relkit/app, @relkit/app/agents |
Module example |
| ConfigOperation | Type | @relkit/app, @relkit/app/config |
Source example |
| ConfigTelemetry | Value | @relkit/app, @relkit/app/config |
API example |
| ConfigTelemetryLive | Value | @relkit/app, @relkit/app/config |
API example |
| ConfigTelemetryService | Type | @relkit/app, @relkit/app/config |
Module example |
| ConfigValidationError | Value | @relkit/app, @relkit/app/config |
API example |
| ConstantResolver | Type | @relkit/app |
API example |
| ConstantsDescriptor | Type | @relkit/app |
API example |
| ConstantsShape | Type | @relkit/app |
API example |
| ConstantValue | Type | @relkit/app |
API example |
| ContextDescriptorFailure | Value | @relkit/app |
API example |
| ContextDescriptorOptions | Type | @relkit/app |
API example |
| ContextResolutionFailure | Value | @relkit/app |
API example |
| ContextResolverOptions | Type | @relkit/app |
API example |
| ContinuationIdentity | Type | @relkit/app, @relkit/app/agents |
Module example |
| ContinuationReceipt | Type | @relkit/app, @relkit/app/agents |
Module example |
| ContinuationReceiptLookup | Type | @relkit/app, @relkit/app/agents |
Module example |
| ContinueMapping | Type | @relkit/app, @relkit/app/routes |
API example |
| ControlClaim | Type | @relkit/app, @relkit/app/agents |
Module example |
| ControlEffectOutcome | Type | @relkit/app, @relkit/app/agents |
Module example |
| ControlLimits | Type | @relkit/app, @relkit/app/agents |
Module example |
| ControlPage | Type | @relkit/app, @relkit/app/agents |
Module example |
| ControlReceipt | Type | @relkit/app, @relkit/app/agents |
Module example |
| ControlReceiptLookup | Type | @relkit/app, @relkit/app/agents |
Module example |
| ControlRecord | Type | @relkit/app, @relkit/app/agents |
Module example |
| ControlStatus | Type | @relkit/app, @relkit/app/agents |
Module example |
| copyAgentChat | Value | @relkit/app, @relkit/app/agents |
API example |
| copyAgentChatEffect | Value | @relkit/app, @relkit/app/agents |
API example |
| copyAgentClientPolicy | Value | @relkit/app, @relkit/app/agents |
API example |
| copyAgentClientPolicyEffect | Value | @relkit/app, @relkit/app/agents |
API example |
| copyAgentControls | Value | @relkit/app, @relkit/app/agents |
API example |
| copyAgentControlsEffect | Value | @relkit/app, @relkit/app/agents |
API example |
| copyAgentLimits | Value | @relkit/app, @relkit/app/agents |
API example |
| copyAgentLimitsEffect | Value | @relkit/app, @relkit/app/agents |
API example |
| copyConcurrency | Value | @relkit/app, @relkit/app/jobs |
API example |
| copyConcurrencyEffect | Value | @relkit/app, @relkit/app/jobs |
API example |
| copyFunctionToolHooks | Value | @relkit/app, @relkit/app/functions |
API example |
| copyFunctionToolHooksEffect | Value | @relkit/app, @relkit/app/functions |
API example |
| copyLogging | Value | @relkit/app, @relkit/app/jobs |
API example |
| copyLoggingEffect | Value | @relkit/app, @relkit/app/jobs |
API example |
| copyResources | Value | @relkit/app, @relkit/app/jobs |
API example |
| copyResourcesEffect | Value | @relkit/app, @relkit/app/jobs |
API example |
| copyTaskTags | Value | @relkit/app, @relkit/app/jobs |
API example |
| copyTaskTagsEffect | Value | @relkit/app, @relkit/app/jobs |
API example |
| copyTriggerOptions | Value | @relkit/app, @relkit/app/jobs |
API example |
| CountPresence | Type | @relkit/app, @relkit/app/realtime |
API example |
| createAgentCapturePolicy | Value | @relkit/app, @relkit/app/agents |
API example |
| createAgentCapturePolicyEffect | Value | @relkit/app, @relkit/app/agents |
API example |
| createAgentSpanCapture | Value | @relkit/app, @relkit/app/agents |
API example |
| createAgentSpanCaptureEffect | Value | @relkit/app, @relkit/app/agents |
API example |
| createApplicationContextResolver | Value | @relkit/app |
API example |
| createApplicationContextResolverEffect | Value | @relkit/app |
API example |
| createApproval | Value | @relkit/app, @relkit/app/agents |
API example |
| createApprovalEffect | Value | @relkit/app, @relkit/app/agents |
API example |
| createBucketClient | Value | @relkit/app, @relkit/app/buckets |
API example |
| createBucketClientEffect | Value | @relkit/app, @relkit/app/buckets |
API example |
| createBucketReadUrlEffect | Value | @relkit/app, @relkit/app/buckets |
API example |
| createBucketWriteUrlEffect | Value | @relkit/app, @relkit/app/buckets |
API example |
| createCacheClient | Value | @relkit/app, @relkit/app/cache |
API example |
| createCacheClientEffect | Value | @relkit/app, @relkit/app/cache |
API example |
| createCursor | Value | @relkit/app, @relkit/app/jobs |
API example |
| createEnvRefEffect | Value | @relkit/app, @relkit/app/config |
API example |
| createEventClient | Value | @relkit/app, @relkit/app/events |
API example |
| createFunctionGraphNode | Value | @relkit/app, @relkit/app/functions |
API example |
| createFunctionGraphNodeEffect | Value | @relkit/app, @relkit/app/functions |
API example |
| createFunctionToolInvoker | Value | @relkit/app, @relkit/app/functions |
API example |
| createFunctionToolInvokerEffect | Value | @relkit/app, @relkit/app/functions |
API example |
| createGeneratedAgentFunction | Value | @relkit/app, @relkit/app/agents |
API example |
| createGeneratedAgentFunctionEffect | Value | @relkit/app, @relkit/app/agents |
API example |
| createJobClient | Value | @relkit/app/jobs/legacy |
API example |
| createJobClientEffect | Value | @relkit/app/jobs/legacy |
API example |
| createJobCursor | Value | @relkit/app, @relkit/app/jobs |
API example |
| createJobCursorEffect | Value | @relkit/app, @relkit/app/jobs |
API example |
| createJobsControls | Value | @relkit/app, @relkit/app/jobs |
API example |
| createJobsControlsEffect | Value | @relkit/app, @relkit/app/jobs |
API example |
| createJobsRuntime | Value | @relkit/app, @relkit/app/jobs |
API example |
| createJobsRuntimeEffect | Value | @relkit/app, @relkit/app/jobs |
API example |
| createOperationId | Value | @relkit/app, @relkit/app/realtime |
API example |
| createOperationIdEffect | Value | @relkit/app, @relkit/app/realtime |
API example |
| createProviderRealtimeDispatcher | Value | @relkit/app, @relkit/app/realtime |
API example |
| createProviderRealtimeDispatcherEffect | Value | @relkit/app, @relkit/app/realtime |
API example |
| createRunLocator | Value | @relkit/app, @relkit/app/jobs |
API example |
| createRunLocatorEffect | Value | @relkit/app, @relkit/app/jobs |
API example |
| createScheduleControls | Value | @relkit/app, @relkit/app/jobs |
API example |
| createScheduleControlsEffect | Value | @relkit/app, @relkit/app/jobs |
API example |
| createSubmissionPipeline | Value | @relkit/app, @relkit/app/jobs |
API example |
| createSubmissionPipelineEffect | Value | @relkit/app, @relkit/app/jobs |
API example |
| createTaskProgressEmitter | Value | @relkit/app, @relkit/app/jobs |
API example |
| createTaskProgressEmitterEffect | Value | @relkit/app, @relkit/app/jobs |
API example |
| createTaskStreamEmitter | Value | @relkit/app, @relkit/app/jobs |
API example |
| createTaskStreamEmitterEffect | Value | @relkit/app, @relkit/app/jobs |
API example |
| CreateThreadReceipt | Type | @relkit/app, @relkit/app/agents |
Module example |
| CreateThreadRequest | Type | @relkit/app, @relkit/app/agents |
Module example |
| createToolRuntime | Value | @relkit/app, @relkit/app/tools |
API example |
| createToolRuntimeEffect | Value | @relkit/app, @relkit/app/tools |
API example |
| currentJobsRuntime | Value | @relkit/app, @relkit/app/jobs |
API example |
| currentJobsRuntimeEffect | Value | @relkit/app, @relkit/app/jobs |
API example |
| currentRealtimeDispatcher | Value | @relkit/app, @relkit/app/realtime |
API example |
| currentRealtimeDispatcherEffect | Value | @relkit/app, @relkit/app/realtime |
API example |
| decideThreadTransition | Value | @relkit/app, @relkit/app/agents |
Source example |
| decideThreadTransitionEffect | Value | @relkit/app, @relkit/app/agents |
Source example |
| DeclaredError | Value | @relkit/app, @relkit/app/functions |
API example |
| DeclaredErrorOf | Type | @relkit/app, @relkit/app/functions |
API example |
| DeclaredErrorsOf | Type | @relkit/app, @relkit/app/functions |
API example |
| decodeCursor | Value | @relkit/app, @relkit/app/jobs |
API example |
| decodeJobWire | Value | @relkit/app, @relkit/app/jobs |
API example |
| decodeJobWireEffect | Value | @relkit/app, @relkit/app/jobs |
API example |
| decodeRunLocator | Value | @relkit/app, @relkit/app/jobs |
API example |
| defineAgent | Value | @relkit/app, @relkit/app/agents |
API example |
| defineAgentEffect | Value | @relkit/app, @relkit/app/agents |
Module example |
| DefineAgentOptions | Type | @relkit/app, @relkit/app/agents |
Module example |
| defineApp | Value | @relkit/app, @relkit/app/config |
API example |
| defineAppEffect | Value | @relkit/app, @relkit/app/config |
API example |
| DefineAppOptions | Type | @relkit/app, @relkit/app/config |
API example |
| defineBucket | Value | @relkit/app, @relkit/app/buckets |
API example |
| defineBucketEffect | Value | @relkit/app, @relkit/app/buckets |
API example |
| DefineBucketOptions | Type | @relkit/app, @relkit/app/buckets |
API example |
| defineCache | Value | @relkit/app, @relkit/app/cache |
API example |
| defineCacheEffect | Value | @relkit/app, @relkit/app/cache |
API example |
| DefineCacheOptions | Type | @relkit/app, @relkit/app/cache |
API example |
| defineChannel | Value | @relkit/app, @relkit/app/realtime |
API example |
| defineChannelEffect | Value | @relkit/app, @relkit/app/realtime |
API example |
| DefineChannelOptions | Type | @relkit/app, @relkit/app/realtime |
API example |
| defineConstants | Value | @relkit/app |
API example |
| defineConstantsEffect | Value | @relkit/app |
API example |
| defineEnv | Value | @relkit/app, @relkit/app/config |
API example |
| defineEnvEffect | Value | @relkit/app, @relkit/app/config |
API example |
| defineError | Value | @relkit/app, @relkit/app/functions |
API example |
| defineErrorEffect | Value | @relkit/app, @relkit/app/functions |
API example |
| DefineErrorOptions | Type | @relkit/app, @relkit/app/functions |
API example |
| defineEvent | Value | @relkit/app, @relkit/app/events |
API example |
| defineEventFunction | Value | @relkit/app, @relkit/app/events |
API example |
| DefineEventFunctionOptions | Type | @relkit/app, @relkit/app/events |
API example |
| DefineEventOptions | Type | @relkit/app, @relkit/app/events |
API example |
| defineFunction | Value | @relkit/app, @relkit/app/functions |
API example |
| defineFunctionEffect | Value | @relkit/app, @relkit/app/functions |
API example |
| DefineFunctionOptions | Type | @relkit/app, @relkit/app/functions |
API example |
| defineJob | Value | @relkit/app, @relkit/app/jobs |
API example |
| defineJob | Value | @relkit/app/jobs/legacy |
API example |
| defineJobEffect | Value | @relkit/app, @relkit/app/jobs |
API example |
| defineJobEffect | Value | @relkit/app/jobs/legacy |
API example |
| DefineJobOptions | Type | @relkit/app, @relkit/app/jobs |
Module example |
| DefineJobOptions | Type | @relkit/app/jobs/legacy |
Module example |
| defineMiddleware | Value | @relkit/app, @relkit/app/routes |
API example |
| defineMiddlewareEffect | Value | @relkit/app, @relkit/app/routes |
API example |
| definePrompt | Value | @relkit/app |
API example |
| definePromptEffect | Value | @relkit/app |
API example |
| defineRequestTransform | Value | @relkit/app, @relkit/app/routes |
API example |
| defineRequestTransformEffect | Value | @relkit/app, @relkit/app/routes |
API example |
| defineRoute | Value | @relkit/app, @relkit/app/routes |
API example |
| defineRouteEffect | Value | @relkit/app, @relkit/app/routes |
API example |
| defineService | Value | @relkit/app, @relkit/app/services |
API example |
| DefineService | Type | @relkit/app, @relkit/app/services |
API example |
| defineServiceEffect | Value | @relkit/app, @relkit/app/services |
API example |
| DefineServiceOptions | Type | @relkit/app, @relkit/app/services |
API example |
| defineServiceRoutes | Value | @relkit/app, @relkit/app/routes |
API example |
| defineServiceRoutesEffect | Value | @relkit/app, @relkit/app/routes |
API example |
| defineTask | Value | @relkit/app, @relkit/app/jobs, @relkit/app/tasks |
API example |
| defineTaskEffect | Value | @relkit/app, @relkit/app/jobs |
API example |
| DefineTaskOptions | Type | @relkit/app, @relkit/app/jobs, @relkit/app/tasks |
Module example |
| defineTool | Value | @relkit/app, @relkit/app/tools |
API example |
| defineToolEffect | Value | @relkit/app, @relkit/app/tools |
API example |
| DefineToolOptions | Type | @relkit/app, @relkit/app/tools |
API example |
| defineTransform | Value | @relkit/app, @relkit/app/routes |
API example |
| defineTransformEffect | Value | @relkit/app, @relkit/app/routes |
API example |
| DefineTransformOptions | Type | @relkit/app, @relkit/app/routes |
API example |
| deleteBucketEffect | Value | @relkit/app, @relkit/app/buckets |
API example |
| deleteCacheEffect | Value | @relkit/app, @relkit/app/cache |
API example |
| DeniedApproval | Type | @relkit/app, @relkit/app/agents |
Module example |
| denyApproval | Value | @relkit/app, @relkit/app/agents |
API example |
| denyApprovalEffect | Value | @relkit/app, @relkit/app/agents |
API example |
| deriveApplicationId | Value | @relkit/app, @relkit/app/config |
API example |
| deriveApplicationIdEffect | Value | @relkit/app, @relkit/app/config |
API example |
| DescriptorRef | Type | @relkit/app, @relkit/app/functions |
API example |
| deserializeJobsServiceOptions | Value | @relkit/app, @relkit/app/jobs |
API example |
| deserializeJobsServiceOptionsEffect | Value | @relkit/app, @relkit/app/jobs |
API example |
| diagnoseJobMigration | Value | @relkit/app, @relkit/app/jobs |
API example |
| diagnoseJobMigrationEffect | Value | @relkit/app, @relkit/app/jobs |
API example |
| diagnoseLegacyCompatibility | Value | @relkit/app, @relkit/app/jobs |
API example |
| diagnoseLegacyCompatibilityEffect | Value | @relkit/app, @relkit/app/jobs |
API example |
| DurationInput | Type | @relkit/app, @relkit/app/jobs |
Module example |
| durationToMillis | Value | @relkit/app, @relkit/app/jobs |
API example |
| durationToMillisEffect | Value | @relkit/app, @relkit/app/jobs |
API example |
| DurationUnit | Type | @relkit/app, @relkit/app/jobs |
Module example |
| DurationValidationError | Value | @relkit/app, @relkit/app/jobs |
API example |
| EffectJobClient | Type | @relkit/app/jobs/legacy |
Module example |
| EffectTaskEmitter | Type | @relkit/app, @relkit/app/jobs |
Module example |
| emitAgentEdge | Value | @relkit/app, @relkit/app/agents |
API example |
| emitAgentEdgeEffect | Value | @relkit/app, @relkit/app/agents |
API example |
| encodeJobWire | Value | @relkit/app, @relkit/app/jobs |
API example |
| encodeJobWireEffect | Value | @relkit/app, @relkit/app/jobs |
API example |
| encodeRunLocator | Value | @relkit/app, @relkit/app/jobs |
API example |
| encodeTaskInput | Value | @relkit/app, @relkit/app/jobs |
API example |
| encodeTaskInputEffect | Value | @relkit/app, @relkit/app/jobs |
API example |
| encodeTaskOutput | Value | @relkit/app, @relkit/app/jobs |
API example |
| encodeTaskOutputEffect | Value | @relkit/app, @relkit/app/jobs |
API example |
| env | Value | @relkit/app, @relkit/app/config |
API example |
| EnvBuilder | Type | @relkit/app, @relkit/app/config |
API example |
| EnvBuilderBase | Type | @relkit/app, @relkit/app/config |
API example |
| EnvBuilderFactory | Type | @relkit/app, @relkit/app/config |
API example |
| EnvDefinition | Type | @relkit/app, @relkit/app/config |
API example |
| EnvIssue | Type | @relkit/app, @relkit/app/config |
API example |
| EnvMetadata | Type | @relkit/app, @relkit/app/config |
API example |
| EnvMetadataMap | Type | @relkit/app, @relkit/app/config |
API example |
| EnvProjection | Type | @relkit/app, @relkit/app/config |
API example |
| EnvRef | Type | @relkit/app, @relkit/app/config |
API example |
| EnvResolutionError | Value | @relkit/app, @relkit/app/config |
API example |
| EnvShape | Type | @relkit/app, @relkit/app/config |
API example |
| EnvSource | Type | @relkit/app, @relkit/app/config |
API example |
| EnvValueType | Type | @relkit/app, @relkit/app/config |
API example |
| ErrorDescriptor | Type | @relkit/app, @relkit/app/functions |
API example |
| ErrorDescriptorAny | Type | @relkit/app, @relkit/app/functions |
Module example |
| ErrorHttpMapping | Type | @relkit/app, @relkit/app/functions |
API example |
| ErrorRef | Type | @relkit/app, @relkit/app/functions |
API example |
| ErrorRetry | Type | @relkit/app, @relkit/app/functions |
API example |
| ErrorRetryInput | Type | @relkit/app, @relkit/app/functions |
API example |
| EventAttributeValue | Type | @relkit/app, @relkit/app/functions, @relkit/app/events |
API example |
| EventClient | Type | @relkit/app, @relkit/app/events |
API example |
| EventClientFor | Type | @relkit/app, @relkit/app/functions |
API example |
| EventClientOptions | Type | @relkit/app, @relkit/app/events |
API example |
| EventClients | Type | @relkit/app, @relkit/app/functions |
API example |
| EventDeclaredEdge | Type | @relkit/app, @relkit/app/events |
API example |
| EventDelivery | Type | @relkit/app, @relkit/app/events |
API example |
| EventDependencyError | Value | @relkit/app, @relkit/app/events |
API example |
| EventDescriptor | Type | @relkit/app, @relkit/app/events |
API example |
| EventDescriptorAny | Type | @relkit/app, @relkit/app/events |
API example |
| EventDescriptorByName | Type | @relkit/app, @relkit/app/events |
API example |
| EventEnvelope | Type | @relkit/app, @relkit/app/events |
API example |
| EventEnvelopeFor | Type | @relkit/app, @relkit/app/events |
API example |
| EventFunctionContext | Type | @relkit/app, @relkit/app/events |
API example |
| EventFunctionDescriptor | Type | @relkit/app, @relkit/app/events |
API example |
| EventFunctionDescriptorAny | Type | @relkit/app, @relkit/app/events |
API example |
| EventFunctionHandler | Type | @relkit/app, @relkit/app/events |
API example |
| EventFunctionTrigger | Type | @relkit/app, @relkit/app/events |
API example |
| EventInputByName | Type | @relkit/app, @relkit/app/events |
API example |
| EventInvocationBridge | Type | @relkit/app, @relkit/app/events |
API example |
| EventInvocationBridgeOptions | Type | @relkit/app, @relkit/app/events |
API example |
| EventName | Type | @relkit/app, @relkit/app/events |
API example |
| EventObservedEdge | Type | @relkit/app, @relkit/app/events |
API example |
| EventOperationCancelledError | Value | @relkit/app, @relkit/app/events |
API example |
| EventOperationContext | Type | @relkit/app, @relkit/app/events |
API example |
| EventOperationTimeoutError | Value | @relkit/app, @relkit/app/events |
API example |
| EventPayloadValidationError | Value | @relkit/app, @relkit/app/events |
API example |
| EventProfileError | Value | @relkit/app, @relkit/app/events |
API example |
| EventProvider | Type | @relkit/app, @relkit/app/events |
API example |
| EventProviderError | Value | @relkit/app, @relkit/app/events |
API example |
| EventProviderResult | Type | @relkit/app, @relkit/app/events |
API example |
| EventPublishOptions | Type | @relkit/app, @relkit/app/functions, @relkit/app/events |
API example |
| EventPublishResult | Type | @relkit/app, @relkit/app/functions, @relkit/app/events |
API example |
| EventRef | Type | @relkit/app, @relkit/app/functions |
API example |
| EventRefAny | Type | @relkit/app, @relkit/app/functions |
API example |
| EventRegistry | Type | @relkit/app, @relkit/app/events |
API example |
| EventRetryPolicy | Type | @relkit/app, @relkit/app/events |
API example |
| EventVersionByName | Type | @relkit/app, @relkit/app/events |
API example |
| ExecutionClaim | Type | @relkit/app, @relkit/app/agents |
Source example |
| existsBucketEffect | Value | @relkit/app, @relkit/app/buckets |
API example |
| fail | Value | @relkit/app, @relkit/app/functions |
API example |
| failEffect | Value | @relkit/app, @relkit/app/functions |
API example |
| FileSchema | Type | @relkit/app/schema |
API example |
| FileSchemaOptions | Type | @relkit/app/schema |
API example |
| freezeServiceContextValue | Value | @relkit/app, @relkit/app/services |
API example |
| freezeServiceContextValueEffect | Value | @relkit/app, @relkit/app/services |
API example |
| freezeServiceDescriptor | Value | @relkit/app, @relkit/app/services |
API example |
| freezeServiceDescriptorEffect | Value | @relkit/app, @relkit/app/services |
API example |
| FunctionAsGraphNode | Type | @relkit/app, @relkit/app/functions |
API example |
| functionAttempt | Value | @relkit/app, @relkit/app/functions |
API example |
| FunctionContext | Type | @relkit/app, @relkit/app/functions |
API example |
| FunctionDependencies | Type | @relkit/app, @relkit/app/functions |
API example |
| FunctionDescriptor | Type | @relkit/app, @relkit/app/functions |
API example |
| FunctionEffectValue | Type | @relkit/app, @relkit/app/functions |
API example |
| FunctionFailure | Type | @relkit/app, @relkit/app/functions |
API example |
| FunctionGraphNodeDescriptor | Type | @relkit/app, @relkit/app/functions |
API example |
| FunctionGraphNodeOptions | Type | @relkit/app, @relkit/app/functions |
API example |
| FunctionHandlerResult | Type | @relkit/app, @relkit/app/functions |
API example |
| FunctionHandlerValidation | Type | @relkit/app, @relkit/app/functions |
API example |
| FunctionOperation | Type | @relkit/app, @relkit/app/functions |
API example |
| FunctionOperationError | Value | @relkit/app, @relkit/app/functions |
API example |
| FunctionRef | Type | @relkit/app, @relkit/app/functions |
API example |
| FunctionRefAny | Type | @relkit/app, @relkit/app/functions |
API example |
| FunctionRouteDescriptor | Type | @relkit/app, @relkit/app/routes |
API example |
| FunctionRouteOptions | Type | @relkit/app, @relkit/app/routes |
API example |
| FunctionTelemetry | Value | @relkit/app, @relkit/app/functions |
API example |
| FunctionTelemetryLive | Value | @relkit/app, @relkit/app/functions |
API example |
| FunctionTelemetryService | Type | @relkit/app, @relkit/app/functions |
API example |
| FunctionToolApproval | Type | @relkit/app, @relkit/app/functions |
API example |
| FunctionToolApprovalDecision | Type | @relkit/app, @relkit/app/functions |
API example |
| FunctionToolApprovalDeniedError | Value | @relkit/app, @relkit/app/functions |
API example |
| FunctionToolApprovalDeniedFailure | Value | @relkit/app, @relkit/app/functions |
API example |
| FunctionToolApprovalRequest | Type | @relkit/app, @relkit/app/functions |
API example |
| FunctionToolApprovalRequiredError | Value | @relkit/app, @relkit/app/functions |
API example |
| FunctionToolApprovalRequiredFailure | Value | @relkit/app, @relkit/app/functions |
API example |
| FunctionToolApprovalResolver | Type | @relkit/app, @relkit/app/functions |
API example |
| FunctionToolArgumentFailure | Value | @relkit/app, @relkit/app/functions |
API example |
| FunctionToolArgumentValidationError | Value | @relkit/app, @relkit/app/functions |
API example |
| FunctionToolCancelledFailure | Value | @relkit/app, @relkit/app/functions |
API example |
| FunctionToolContext | Type | @relkit/app, @relkit/app/functions |
API example |
| FunctionToolDescriptor | Type | @relkit/app, @relkit/app/functions |
API example |
| FunctionToolHook | Type | @relkit/app, @relkit/app/functions |
API example |
| FunctionToolInvokeOptions | Type | @relkit/app, @relkit/app/functions |
API example |
| FunctionToolMetadata | Type | @relkit/app, @relkit/app/functions |
API example |
| FunctionToolOperationCancelledError | Value | @relkit/app, @relkit/app/functions |
API example |
| FunctionToolOptions | Type | @relkit/app, @relkit/app/functions |
API example |
| FunctionToolSideEffect | Type | @relkit/app, @relkit/app/functions |
API example |
| FunctionToolTarget | Type | @relkit/app, @relkit/app/functions |
API example |
| functionTry | Value | @relkit/app, @relkit/app/functions |
API example |
| GENERATED_AGENT_FUNCTION_PREFIX | Value | @relkit/app, @relkit/app/agents |
Module example |
| GENERATED_AGENT_FUNCTION_SUFFIX | Value | @relkit/app, @relkit/app/agents |
Module example |
| GeneratedAgentExecutor | Type | @relkit/app, @relkit/app/agents |
Module example |
| GeneratedAgentFunction | Type | @relkit/app, @relkit/app/agents |
Module example |
| generatedAgentFunctionId | Value | @relkit/app, @relkit/app/agents |
API example |
| generatedAgentFunctionIdEffect | Value | @relkit/app, @relkit/app/agents |
API example |
| GeneratedAgentFunctionMarker | Type | @relkit/app, @relkit/app/agents |
Module example |
| GeneratedAgentFunctionUnboundError | Value | @relkit/app, @relkit/app/agents |
Module example |
| getBucketEffect | Value | @relkit/app, @relkit/app/buckets |
API example |
| getCacheEffect | Value | @relkit/app, @relkit/app/cache |
API example |
| getChannelPresenceEffect | Value | @relkit/app, @relkit/app/realtime |
API example |
| getJsonSchema | Value | @relkit/app/schema |
API example |
| getJsonSchemaEffect | Value | @relkit/app/schema |
API example |
| getOrSetCacheEffect | Value | @relkit/app, @relkit/app/cache |
API example |
| getRun | Value | @relkit/app, @relkit/app/jobs |
API example |
| getRunEffect | Value | @relkit/app, @relkit/app/jobs |
API example |
| getScheduleEffect | Value | @relkit/app, @relkit/app/jobs |
API example |
| getSchemaMetadata | Value | @relkit/app/schema |
API example |
| getSchemaMetadataEffect | Value | @relkit/app/schema |
API example |
| hasCacheEffect | Value | @relkit/app, @relkit/app/cache |
API example |
| headBucketEffect | Value | @relkit/app, @relkit/app/buckets |
API example |
| http | Value | @relkit/app, @relkit/app/routes |
API example |
| HttpBodyMapping | Type | @relkit/app, @relkit/app/routes |
API example |
| HttpConstantMapping | Type | @relkit/app, @relkit/app/routes |
API example |
| HttpCookieMapping | Type | @relkit/app, @relkit/app/routes |
API example |
| HttpDefaultMapping | Type | @relkit/app, @relkit/app/routes |
API example |
| HttpDsl | Type | @relkit/app, @relkit/app/routes |
API example |
| httpEffects | Value | @relkit/app, @relkit/app/routes |
API example |
| HttpHeaderMapping | Type | @relkit/app, @relkit/app/routes |
API example |
| HttpInputMapping | Type | @relkit/app, @relkit/app/routes |
API example |
| HttpMapping | Type | @relkit/app, @relkit/app/routes |
API example |
| HttpMappingNode | Type | @relkit/app, @relkit/app/routes |
API example |
| HttpMappingOutput | Type | @relkit/app, @relkit/app/routes |
API example |
| HttpMappingShape | Type | @relkit/app, @relkit/app/routes |
API example |
| HttpMethod | Type | @relkit/app, @relkit/app/routes |
API example |
| HttpMultipartAllMapping | Type | @relkit/app, @relkit/app/routes |
API example |
| HttpMultipartMapping | Type | @relkit/app, @relkit/app/routes |
API example |
| HttpNestedMapping | Type | @relkit/app, @relkit/app/routes |
API example |
| HttpOptionalMapping | Type | @relkit/app, @relkit/app/routes |
API example |
| HttpPathMapping | Type | @relkit/app, @relkit/app/routes |
API example |
| HttpPathSegmentsMapping | Type | @relkit/app, @relkit/app/routes |
API example |
| HttpQueryMapping | Type | @relkit/app, @relkit/app/routes |
API example |
| HttpRateLimitKey | Type | @relkit/app, @relkit/app/routes |
API example |
| HttpRequestContentType | Type | @relkit/app, @relkit/app/routes |
API example |
| HttpRequestMapping | Type | @relkit/app, @relkit/app/routes |
API example |
| HttpResponseMapping | Type | @relkit/app, @relkit/app/routes |
API example |
| HttpSourceOptions | Type | @relkit/app, @relkit/app/routes |
API example |
| HttpTransformDescriptor | Type | @relkit/app, @relkit/app/routes |
API example |
| HttpTransformMapping | Type | @relkit/app, @relkit/app/routes |
API example |
| HttpTransformRef | Type | @relkit/app, @relkit/app/routes |
API example |
| HttpWholeBodyMapping | Type | @relkit/app, @relkit/app/routes |
API example |
| IdempotencyDefinition | Type | @relkit/app/jobs/legacy |
Module example |
| incrementCacheEffect | Value | @relkit/app, @relkit/app/cache |
API example |
| InferEnvValue | Type | @relkit/app, @relkit/app/config |
API example |
| InferEnvValues | Type | @relkit/app, @relkit/app/config |
API example |
| InferInput | Type | @relkit/app/schema |
Source example |
| InferOutput | Type | @relkit/app/schema |
Source example |
| InputOf | Type | @relkit/app, @relkit/app/jobs |
Module example |
| InspectorConfig | Type | @relkit/app, @relkit/app/config |
API example |
| InstantValidationError | Value | @relkit/app, @relkit/app/jobs |
API example |
| InterruptionReceipt | Type | @relkit/app, @relkit/app/agents |
Module example |
| InterruptOwnedRunRequest | Type | @relkit/app, @relkit/app/agents |
Module example |
| InvocationMetadata | Type | @relkit/app, @relkit/app/functions |
API example |
| InvocationSource | Type | @relkit/app, @relkit/app/functions |
API example |
| invokeFunctionGraphNodeEffect | Value | @relkit/app, @relkit/app/functions |
API example |
| invokeFunctionToolEffect | Value | @relkit/app, @relkit/app/functions |
API example |
| invokeTool | Value | @relkit/app, @relkit/app/tools |
API example |
| invokeToolEffect | Value | @relkit/app, @relkit/app/tools |
API example |
| isAgentDescriptor | Value | @relkit/app, @relkit/app/agents |
API example |
| isApprovalRecord | Value | @relkit/app, @relkit/app/agents |
API example |
| isApprovalRecordEffect | Value | @relkit/app, @relkit/app/agents |
API example |
| isBindingValueRef | Value | @relkit/app, @relkit/app/config |
API example |
| isBucketDescriptor | Value | @relkit/app, @relkit/app/buckets |
API example |
| isBucketDescriptorEffect | Value | @relkit/app, @relkit/app/buckets |
API example |
| isCacheDescriptor | Value | @relkit/app, @relkit/app/cache |
API example |
| isCacheDescriptorEffect | Value | @relkit/app, @relkit/app/cache |
API example |
| isChannelDescriptor | Value | @relkit/app, @relkit/app/realtime |
API example |
| isChannelDescriptorEffect | Value | @relkit/app, @relkit/app/realtime |
API example |
| isDurationInput | Value | @relkit/app, @relkit/app/jobs |
API example |
| isDurationInputEffect | Value | @relkit/app, @relkit/app/jobs |
API example |
| isEnvDefinition | Value | @relkit/app, @relkit/app/config |
API example |
| isEnvDefinitionEffect | Value | @relkit/app, @relkit/app/config |
API example |
| isEnvRef | Value | @relkit/app, @relkit/app/config |
API example |
| isEnvRefEffect | Value | @relkit/app, @relkit/app/config |
API example |
| isErrorDescriptor | Value | @relkit/app, @relkit/app/functions |
API example |
| isErrorDescriptorEffect | Value | @relkit/app, @relkit/app/functions |
API example |
| isEventDescriptor | Value | @relkit/app, @relkit/app/events |
API example |
| isEventFunctionDescriptor | Value | @relkit/app, @relkit/app/events |
API example |
| isFunctionDescriptor | Value | @relkit/app, @relkit/app/services |
API example |
| isFunctionDescriptorEffect | Value | @relkit/app, @relkit/app/services |
API example |
| isFunctionGraphNode | Value | @relkit/app, @relkit/app/functions |
API example |
| isFunctionGraphNodeEffect | Value | @relkit/app, @relkit/app/functions |
API example |
| isGeneratedAgentFunction | Value | @relkit/app, @relkit/app/agents |
API example |
| isGeneratedAgentFunctionEffect | Value | @relkit/app, @relkit/app/agents |
API example |
| isHttpMapping | Value | @relkit/app, @relkit/app/routes |
API example |
| isHttpMappingEffect | Value | @relkit/app, @relkit/app/routes |
API example |
| isHttpRequestMapping | Value | @relkit/app, @relkit/app/routes |
API example |
| isHttpRequestMappingEffect | Value | @relkit/app, @relkit/app/routes |
API example |
| isHttpResponseMapping | Value | @relkit/app, @relkit/app/routes |
API example |
| isHttpResponseMappingEffect | Value | @relkit/app, @relkit/app/routes |
API example |
| isJobDescriptor | Value | @relkit/app, @relkit/app/jobs |
API example |
| isJobDescriptorEffect | Value | @relkit/app, @relkit/app/jobs |
API example |
| isJobName | Value | @relkit/app, @relkit/app/jobs |
API example |
| isJobNameEffect | Value | @relkit/app, @relkit/app/jobs |
API example |
| isJobsAdapterRuntime | Value | @relkit/app, @relkit/app/jobs |
API example |
| isJobsAdapterRuntimeEffect | Value | @relkit/app, @relkit/app/jobs |
API example |
| isJsonSchemaAvailable | Value | @relkit/app/schema |
API example |
| isMiddlewareDecision | Value | @relkit/app, @relkit/app/routes |
API example |
| isMiddlewareDecisionEffect | Value | @relkit/app, @relkit/app/routes |
API example |
| isMiddlewareDescriptor | Value | @relkit/app, @relkit/app/routes |
API example |
| isMiddlewareDescriptorEffect | Value | @relkit/app, @relkit/app/routes |
API example |
| isMiddlewarePath | Value | @relkit/app, @relkit/app/routes |
API example |
| isMiddlewarePathEffect | Value | @relkit/app, @relkit/app/routes |
API example |
| isReservedServiceMemberName | Value | @relkit/app, @relkit/app/services |
API example |
| isReservedServiceMemberNameEffect | Value | @relkit/app, @relkit/app/services |
API example |
| isRfc3339Instant | Value | @relkit/app, @relkit/app/jobs |
API example |
| isRfc3339InstantEffect | Value | @relkit/app, @relkit/app/jobs |
API example |
| isSchemaTransformed | Value | @relkit/app/schema |
API example |
| isSchemaTransformedEffect | Value | @relkit/app/schema |
API example |
| isServiceDescriptor | Value | @relkit/app, @relkit/app/services |
API example |
| isServiceDescriptorEffect | Value | @relkit/app, @relkit/app/services |
API example |
| isServiceRef | Value | @relkit/app, @relkit/app/services |
API example |
| isServiceRefEffect | Value | @relkit/app, @relkit/app/services |
API example |
| isStreamOutputSchema | Value | @relkit/app, @relkit/app/functions |
API example |
| isStreamOutputSchemaEffect | Value | @relkit/app, @relkit/app/functions |
API example |
| isTaskDescriptor | Value | @relkit/app, @relkit/app/jobs, @relkit/app/tasks |
API example |
| isTaskDescriptorEffect | Value | @relkit/app, @relkit/app/jobs |
API example |
| isToolDescriptor | Value | @relkit/app, @relkit/app/tools |
API example |
| isToolDescriptorEffect | Value | @relkit/app, @relkit/app/tools |
API example |
| isToolRef | Value | @relkit/app, @relkit/app/tools |
API example |
| isToolRefEffect | Value | @relkit/app, @relkit/app/tools |
API example |
| isTransformRef | Value | @relkit/app, @relkit/app/routes |
API example |
| isTransformRefEffect | Value | @relkit/app, @relkit/app/routes |
API example |
| isValidJobName | Value | @relkit/app, @relkit/app/jobs |
API example |
| JOB_NAME_MAX_LENGTH | Value | @relkit/app, @relkit/app/jobs |
Module example |
| JOB_NAME_PATTERN | Value | @relkit/app, @relkit/app/jobs |
API example |
| JOB_NAME_RESERVED | Value | @relkit/app, @relkit/app/jobs |
API example |
| JOB_PROFILE_DEPRECATED_CODE | Value | @relkit/app, @relkit/app/jobs |
API example |
| JobAccessGrant | Type | @relkit/app, @relkit/app/jobs |
Module example |
| JobAccessRequest | Type | @relkit/app, @relkit/app/jobs |
Module example |
| JobAdmission | Type | @relkit/app, @relkit/app/jobs |
Module example |
| JobAuthorizationContext | Type | @relkit/app, @relkit/app/jobs |
Module example |
| JobAuthorizationError | Value | @relkit/app, @relkit/app/jobs |
API example |
| JobAuthorizationFailure | Value | @relkit/app, @relkit/app/jobs |
API example |
| JobBindingErrorCode | Type | @relkit/app, @relkit/app/jobs |
Module example |
| JobBindingFailure | Value | @relkit/app, @relkit/app/jobs |
API example |
| JobBindingMigration | Type | @relkit/app, @relkit/app/jobs |
Module example |
| JobBindingResolutionError | Value | @relkit/app, @relkit/app/jobs |
API example |
| JobCancelOptions | Type | @relkit/app, @relkit/app/jobs |
Module example |
| JobClient | Type | @relkit/app/jobs/legacy |
Module example |
| JobClientAccess | Type | @relkit/app, @relkit/app/jobs |
Module example |
| JobClientFailure | Value | @relkit/app/jobs/legacy |
API example |
| JobClientField | Type | @relkit/app, @relkit/app/jobs |
Module example |
| JobClientFor | Type | @relkit/app, @relkit/app/functions |
API example |
| JobClientOperation | Type | @relkit/app, @relkit/app/jobs |
Module example |
| JobClientOptions | Type | @relkit/app/jobs/legacy |
Module example |
| JobClients | Type | @relkit/app, @relkit/app/functions |
API example |
| JobControlFailure | Value | @relkit/app, @relkit/app/jobs |
API example |
| JobControlUnknownError | Value | @relkit/app, @relkit/app/jobs |
API example |
| JobCursorBinding | Type | @relkit/app, @relkit/app/jobs |
Module example |
| JobCursorError | Value | @relkit/app, @relkit/app/jobs |
API example |
| JobCursorFailure | Value | @relkit/app, @relkit/app/jobs |
API example |
| JobCursorOptions | Type | @relkit/app, @relkit/app/jobs |
Module example |
| JobDeclaredEdge | Type | @relkit/app/jobs/legacy |
Module example |
| JobDefinitionFailure | Value | @relkit/app, @relkit/app/jobs |
API example |
| JobDependencyError | Value | @relkit/app/jobs/legacy |
API example |
| JobDescriptor | Type | @relkit/app, @relkit/app/jobs |
Module example |
| JobDescriptor | Type | @relkit/app/jobs/legacy |
Module example |
| JobDescriptorAny | Type | @relkit/app, @relkit/app/jobs |
Source example |
| JobDescriptorForThisTask | Type | @relkit/app, @relkit/app/jobs, @relkit/app/tasks |
Module example |
| JobEnqueueOptions | Type | @relkit/app, @relkit/app/functions, @relkit/app/jobs/legacy |
API example |
| JobEnqueueResult | Type | @relkit/app, @relkit/app/functions, @relkit/app/jobs/legacy |
API example |
| JobErrorEnvelope | Type | @relkit/app, @relkit/app/jobs |
Module example |
| JobIdentityError | Value | @relkit/app, @relkit/app/jobs |
API example |
| JobInputValidationError | Value | @relkit/app/jobs/legacy |
API example |
| JobInvocationBridge | Type | @relkit/app/jobs/legacy |
Module example |
| JobInvocationBridgeOptions | Type | @relkit/app/jobs/legacy |
Module example |
| JobMigrationDiagnostic | Type | @relkit/app, @relkit/app/jobs |
Module example |
| JobMigrationSeverity | Type | @relkit/app, @relkit/app/jobs |
Module example |
| JobMigrationSnapshot | Type | @relkit/app, @relkit/app/jobs |
Module example |
| JobName | Type | @relkit/app, @relkit/app/jobs |
Module example |
| JobNameValidationError | Value | @relkit/app, @relkit/app/jobs |
API example |
| JobObservationTimeoutError | Value | @relkit/app, @relkit/app/jobs |
API example |
| JobObservedEdge | Type | @relkit/app/jobs/legacy |
Module example |
| JobObserveOptions | Type | @relkit/app, @relkit/app/jobs |
Module example |
| JobOperationCancelledError | Value | @relkit/app/jobs/legacy |
API example |
| JobOperationContext | Type | @relkit/app/jobs/legacy |
Source example |
| JobOperationTimeoutError | Value | @relkit/app/jobs/legacy |
API example |
| JobProfileError | Value | @relkit/app/jobs/legacy |
API example |
| JobProvider | Type | @relkit/app/jobs/legacy |
Source example |
| JobProviderError | Value | @relkit/app/jobs/legacy |
API example |
| JobProviderResult | Type | @relkit/app/jobs/legacy |
Module example |
| JobReceiptError | Value | @relkit/app, @relkit/app/jobs |
API example |
| JobRef | Type | @relkit/app, @relkit/app/functions |
Module example |
| JobRefAny | Type | @relkit/app, @relkit/app/functions |
Module example |
| JobResultUnavailableError | Value | @relkit/app, @relkit/app/jobs |
API example |
| JobRetryOptions | Type | @relkit/app, @relkit/app/jobs |
Module example |
| JobRunResultOptions | Type | @relkit/app, @relkit/app/jobs |
Module example |
| JobRunStatus | Type | @relkit/app, @relkit/app/jobs |
Module example |
| JOBS_ADAPTER_PROTOCOL_VERSION | Value | @relkit/app, @relkit/app/jobs |
API example |
| JobsAdapterRuntime | Type | @relkit/app, @relkit/app/jobs |
Source example |
| JobsAdapterValidationError | Value | @relkit/app, @relkit/app/jobs |
API example |
| JobsCapability | Type | @relkit/app, @relkit/app/jobs |
Module example |
| JobsCapabilityError | Value | @relkit/app, @relkit/app/jobs |
API example |
| JobsCapabilityFailure | Value | @relkit/app, @relkit/app/jobs |
API example |
| JobsCapabilityName | Type | @relkit/app, @relkit/app/jobs |
Module example |
| JobsCapabilityReport | Type | @relkit/app, @relkit/app/jobs |
Module example |
| JobsCapabilitySupport | Type | @relkit/app, @relkit/app/jobs |
Module example |
| JobScheduleClient | Type | @relkit/app, @relkit/app/jobs |
Module example |
| JobScheduleControlFailure | Value | @relkit/app, @relkit/app/jobs |
API example |
| JobsControls | Type | @relkit/app, @relkit/app/jobs |
Module example |
| JobServiceSelection | Type | @relkit/app, @relkit/app/jobs |
Module example |
| JobsManifestLike | Type | @relkit/app, @relkit/app/jobs |
Module example |
| JobsOperationOptions | Type | @relkit/app, @relkit/app/jobs |
Module example |
| JobsRuntime | Type | @relkit/app, @relkit/app/jobs |
Source example |
| JobsRuntimeBinding | Type | @relkit/app, @relkit/app/jobs |
Source example |
| JobsRuntimeCallbackError | Value | @relkit/app, @relkit/app/jobs |
API example |
| JobsRuntimeError | Value | @relkit/app, @relkit/app/jobs |
API example |
| JobsRuntimeOptions | Type | @relkit/app, @relkit/app/jobs |
Module example |
| JobsServiceBehavior | Type | @relkit/app, @relkit/app/jobs |
Module example |
| JobsServiceOptionName | Type | @relkit/app, @relkit/app/jobs |
Module example |
| JobsServiceOptions | Type | @relkit/app, @relkit/app/jobs |
Source example |
| JobsServiceOptionsError | Value | @relkit/app, @relkit/app/jobs |
API example |
| JobState | Type | @relkit/app, @relkit/app/functions, @relkit/app/jobs/legacy |
API example |
| JobStatus | Type | @relkit/app, @relkit/app/functions, @relkit/app/jobs/legacy |
API example |
| JobsTelemetry | Value | @relkit/app, @relkit/app/jobs |
API example |
| JobsTelemetryLive | Value | @relkit/app, @relkit/app/jobs |
API example |
| JobSubmissionCancelledError | Value | @relkit/app, @relkit/app/jobs |
API example |
| JobSubmissionError | Value | @relkit/app, @relkit/app/jobs |
API example |
| JobSubmissionPipelineFailure | Value | @relkit/app, @relkit/app/jobs |
API example |
| JobSubmissionUnknownError | Value | @relkit/app, @relkit/app/jobs |
API example |
| JobTriggerClients | Type | @relkit/app, @relkit/app/jobs |
Module example |
| JobUnknownOutcome | Type | @relkit/app, @relkit/app/jobs |
Module example |
| JobWireEnvelope | Type | @relkit/app, @relkit/app/jobs |
Module example |
| JournalCheckpoint | Type | @relkit/app, @relkit/app/agents |
Source example |
| JournalPage | Type | @relkit/app, @relkit/app/agents |
Module example |
| JournalReceipt | Type | @relkit/app, @relkit/app/agents |
Module example |
| JournalRecord | Type | @relkit/app, @relkit/app/agents |
Source example |
| JSON_SCHEMA_UNAVAILABLE | Value | @relkit/app/schema |
Source example |
| JsonSchema | Type | @relkit/app/schema |
API example |
| JsonSchemaAvailable | Type | @relkit/app/schema |
API example |
| JsonSchemaDirection | Type | @relkit/app/schema |
API example |
| JsonSchemaFactory | Type | @relkit/app/schema |
API example |
| JsonSchemaOptions | Type | @relkit/app/schema |
API example |
| JsonSchemaResult | Type | @relkit/app/schema |
API example |
| JsonSchemaUnavailable | Type | @relkit/app/schema |
API example |
| JsonSchemaUnavailableError | Value | @relkit/app/schema |
API example |
| JsonValue | Type | @relkit/app, @relkit/app/config |
API example |
| JsonWireEnvelope | Type | @relkit/app, @relkit/app/jobs |
Module example |
| LegacyCompatibilitySnapshot | Type | @relkit/app, @relkit/app/jobs |
Module example |
| LegacyJobValidationError | Value | @relkit/app/jobs/legacy |
API example |
| limitsForEffect | Value | @relkit/app, @relkit/app/realtime |
API example |
| listBucketEffect | Value | @relkit/app, @relkit/app/buckets |
API example |
| listRuns | Value | @relkit/app, @relkit/app/jobs |
API example |
| listRunsEffect | Value | @relkit/app, @relkit/app/jobs |
API example |
| listSchedulesEffect | Value | @relkit/app, @relkit/app/jobs |
API example |
| ListThreadsRequest | Type | @relkit/app, @relkit/app/agents |
Module example |
| LiteralValue | Type | @relkit/app, @relkit/app/config |
API example |
| LoadThreadRequest | Type | @relkit/app, @relkit/app/agents |
Module example |
| LookupAppendReceipt | Type | @relkit/app, @relkit/app/realtime |
API example |
| LookupContinuationReceiptRequest | Type | @relkit/app, @relkit/app/agents |
Module example |
| LookupControlReceiptRequest | Type | @relkit/app, @relkit/app/agents |
Module example |
| LookupRunReceiptRequest | Type | @relkit/app, @relkit/app/agents |
Module example |
| MappingShapeOutput | Type | @relkit/app, @relkit/app/routes |
API example |
| MarkControlEffectStartedRequest | Type | @relkit/app, @relkit/app/agents |
Module example |
| MemberPresence | Type | @relkit/app, @relkit/app/realtime |
API example |
| MemberPresenceDescriptor | Type | @relkit/app, @relkit/app/realtime |
API example |
| memoryBytes | Value | @relkit/app, @relkit/app/jobs |
API example |
| memoryBytesEffect | Value | @relkit/app, @relkit/app/jobs |
API example |
| MemoryInput | Type | @relkit/app, @relkit/app/jobs |
Module example |
| MiddlewareContext | Type | @relkit/app, @relkit/app/routes |
API example |
| MiddlewareDecisionMapping | Type | @relkit/app, @relkit/app/routes |
API example |
| MiddlewareDescriptor | Type | @relkit/app, @relkit/app/routes |
API example |
| MiddlewareHandler | Type | @relkit/app, @relkit/app/routes |
API example |
| ModelProviderConfiguration | Type | @relkit/app, @relkit/app/agents |
Module example |
| ModelSelectionEffectError | Value | @relkit/app, @relkit/app/agents |
Module example |
| ModelSelectionError | Value | @relkit/app, @relkit/app/agents |
API example |
| ModelSelectionErrorCode | Type | @relkit/app, @relkit/app/agents |
Module example |
| NamedStreamFrame | Type | @relkit/app, @relkit/app/jobs |
Module example |
| namespaceHash | Value | @relkit/app, @relkit/app/jobs |
API example |
| namespaceHashEffect | Value | @relkit/app, @relkit/app/jobs |
API example |
| NativeCancelRequest | Type | @relkit/app, @relkit/app/jobs |
Module example |
| NativeControlReceipt | Type | @relkit/app, @relkit/app/jobs |
Module example |
| NativeDurableSleep | Type | @relkit/app, @relkit/app/jobs |
Module example |
| NativeLocator | Type | @relkit/app, @relkit/app/jobs |
Module example |
| NativeObservation | Type | @relkit/app, @relkit/app/jobs |
Module example |
| NativeOwnedScheduleRecord | Type | @relkit/app, @relkit/app/jobs |
Module example |
| NativeProgressWriter | Type | @relkit/app, @relkit/app/jobs |
Module example |
| NativeReceipt | Type | @relkit/app, @relkit/app/jobs |
Module example |
| NativeRetryRequest | Type | @relkit/app, @relkit/app/jobs |
Module example |
| NativeRun | Type | @relkit/app, @relkit/app/jobs |
Module example |
| NativeRunPage | Type | @relkit/app, @relkit/app/jobs |
Module example |
| NativeRunQuery | Type | @relkit/app, @relkit/app/jobs |
Module example |
| nativeScheduleLayer | Value | @relkit/app, @relkit/app/jobs |
API example |
| NativeScheduleOperations | Type | @relkit/app, @relkit/app/jobs |
Source example |
| NativeScheduleService | Value | @relkit/app, @relkit/app/jobs |
API example |
| NativeStreamFormat | Type | @relkit/app, @relkit/app/routes |
API example |
| NativeStreamWriter | Type | @relkit/app, @relkit/app/jobs |
Module example |
| NativeStreamWriters | Type | @relkit/app, @relkit/app/jobs |
Module example |
| NativeSubmission | Type | @relkit/app, @relkit/app/jobs |
Source example |
| NativeTaskWork | Type | @relkit/app, @relkit/app/jobs |
Source example |
| NativeTaskWorker | Type | @relkit/app, @relkit/app/jobs |
Module example |
| NativeWatchRequest | Type | @relkit/app, @relkit/app/jobs |
Module example |
| normalizeCompatibility | Value | @relkit/app, @relkit/app/config |
API example |
| normalizeCompatibilityEffect | Value | @relkit/app, @relkit/app/config |
API example |
| NormalizedAppProviderDefaults | Type | @relkit/app, @relkit/app/config |
API example |
| NormalizedErrorRetry | Type | @relkit/app, @relkit/app/functions |
API example |
| NormalizedTaskRetryPolicy | Type | @relkit/app, @relkit/app/jobs, @relkit/app/tasks |
Source example |
| normalizeJobName | Value | @relkit/app, @relkit/app/jobs |
API example |
| normalizeModelSelector | Value | @relkit/app, @relkit/app/agents |
API example |
| normalizeModelSelectorEffect | Value | @relkit/app, @relkit/app/agents |
API example |
| normalizeServiceMemberName | Value | @relkit/app, @relkit/app/services |
API example |
| normalizeServiceMemberNameEffect | Value | @relkit/app, @relkit/app/services |
API example |
| NumberSchema | Type | @relkit/app/schema |
API example |
| observeAgent | Value | @relkit/app, @relkit/app/agents |
API example |
| observeBucket | Value | @relkit/app, @relkit/app/buckets |
API example |
| observeFunction | Value | @relkit/app, @relkit/app/functions |
API example |
| observeRealtime | Value | @relkit/app, @relkit/app/realtime |
API example |
| observeRun | Value | @relkit/app, @relkit/app/jobs |
API example |
| observeRunEffect | Value | @relkit/app, @relkit/app/jobs |
API example |
| observeService | Value | @relkit/app, @relkit/app/services |
API example |
| observeTool | Value | @relkit/app, @relkit/app/tools |
API example |
| OperationContext | Type | @relkit/app, @relkit/app/jobs |
Source example |
| OperationIdEntropy | Value | @relkit/app, @relkit/app/realtime |
API example |
| OperationIdEntropyLive | Value | @relkit/app, @relkit/app/realtime |
API example |
| OperationIdError | Value | @relkit/app, @relkit/app/realtime |
API example |
| OperationIdFailure | Value | @relkit/app, @relkit/app/realtime |
API example |
| operationIdTimestamp | Value | @relkit/app, @relkit/app/realtime |
API example |
| operationIdTimestampEffect | Value | @relkit/app, @relkit/app/realtime |
API example |
| OutputOf | Type | @relkit/app, @relkit/app/jobs |
Module example |
| parseDuration | Value | @relkit/app, @relkit/app/jobs |
API example |
| parseEnvBuilderEffect | Value | @relkit/app, @relkit/app/config |
API example |
| parseModelProviderConfiguration | Value | @relkit/app, @relkit/app/agents |
API example |
| parseModelProviderConfigurationEffect | Value | @relkit/app, @relkit/app/agents |
API example |
| parseOperationId | Value | @relkit/app, @relkit/app/realtime |
API example |
| parseOperationIdEffect | Value | @relkit/app, @relkit/app/realtime |
API example |
| PendingApproval | Type | @relkit/app, @relkit/app/agents |
Source example |
| prepareCanonicalSubmission | Value | @relkit/app, @relkit/app/jobs |
API example |
| prepareCanonicalSubmissionEffect | Value | @relkit/app, @relkit/app/jobs |
API example |
| prepareSubmission | Value | @relkit/app, @relkit/app/jobs |
API example |
| prepareSubmissionEffect | Value | @relkit/app, @relkit/app/jobs |
API example |
| PresenceLeaseRequest | Type | @relkit/app, @relkit/app/realtime |
API example |
| PresenceMember | Type | @relkit/app, @relkit/app/realtime |
API example |
| PresenceSnapshot | Type | @relkit/app, @relkit/app/realtime |
API example |
| ProgressEmitReceipt | Type | @relkit/app, @relkit/app/jobs |
Module example |
| projectEnv | Value | @relkit/app, @relkit/app/config |
API example |
| projectEnvEffect | Value | @relkit/app, @relkit/app/config |
API example |
| projectRun | Value | @relkit/app, @relkit/app/jobs |
API example |
| projectRunPage | Value | @relkit/app, @relkit/app/jobs |
API example |
| projectRunPageEffect | Value | @relkit/app, @relkit/app/jobs |
API example |
| projectRunSnapshot | Value | @relkit/app, @relkit/app/jobs |
API example |
| projectRunSnapshotEffect | Value | @relkit/app, @relkit/app/jobs |
API example |
| PromptDescriptor | Type | @relkit/app |
API example |
| PromptInstructions | Type | @relkit/app, @relkit/app/agents |
Module example |
| PromptTemplate | Type | @relkit/app, @relkit/app/agents |
Module example |
| PromptValue | Type | @relkit/app |
API example |
| ProviderRealtimeDispatcherOptions | Type | @relkit/app, @relkit/app/realtime |
API example |
| providerSourceLayer | Value | @relkit/app, @relkit/app/realtime |
API example |
| PublicClock | Type | @relkit/app, @relkit/app/functions |
API example |
| PublicLogger | Type | @relkit/app, @relkit/app/functions |
API example |
| PublishedEventName | Type | @relkit/app, @relkit/app/jobs |
Module example |
| putBucketEffect | Value | @relkit/app, @relkit/app/buckets |
API example |
| RawHttpHandler | Type | @relkit/app, @relkit/app/routes |
API example |
| RawRouteDescriptor | Type | @relkit/app, @relkit/app/routes |
API example |
| RawRouteOptions | Type | @relkit/app, @relkit/app/routes |
API example |
| ReadChannelEvents | Type | @relkit/app, @relkit/app/realtime |
API example |
| ReadControlsRequest | Type | @relkit/app, @relkit/app/agents |
Module example |
| readJobCursor | Value | @relkit/app, @relkit/app/jobs |
API example |
| readJobCursorEffect | Value | @relkit/app, @relkit/app/jobs |
API example |
| ReadJournalRequest | Type | @relkit/app, @relkit/app/agents |
Module example |
| ReadPresenceRequest | Type | @relkit/app, @relkit/app/realtime |
API example |
| readProviderPresenceEffect | Value | @relkit/app, @relkit/app/realtime |
API example |
| ReadSnapshotHistoryRequest | Type | @relkit/app, @relkit/app/agents |
Module example |
| RealtimeActionError | Value | @relkit/app, @relkit/app/realtime |
API example |
| RealtimeDispatcher | Type | @relkit/app, @relkit/app/realtime |
API example |
| RealtimeDispatcherError | Value | @relkit/app, @relkit/app/realtime |
API example |
| RealtimeDispatcherLive | Value | @relkit/app, @relkit/app/realtime |
API example |
| RealtimeDispatcherService | Value | @relkit/app, @relkit/app/realtime |
API example |
| RealtimeLimits | Type | @relkit/app, @relkit/app/realtime |
API example |
| RealtimeOperation | Type | @relkit/app, @relkit/app/realtime |
API example |
| RealtimeProvider | Type | @relkit/app, @relkit/app/realtime |
API example |
| RealtimeProviderError | Value | @relkit/app, @relkit/app/realtime |
API example |
| RealtimeProviderSource | Value | @relkit/app, @relkit/app/realtime |
API example |
| RealtimeProviderSourceService | Type | @relkit/app, @relkit/app/realtime |
API example |
| RealtimeScope | Type | @relkit/app, @relkit/app/realtime |
API example |
| RealtimeTelemetry | Value | @relkit/app, @relkit/app/realtime |
API example |
| RealtimeTelemetryLive | Value | @relkit/app, @relkit/app/realtime |
API example |
| RealtimeTelemetryService | Type | @relkit/app, @relkit/app/realtime |
API example |
| reconcileNativeSchedules | Value | @relkit/app, @relkit/app/jobs |
API example |
| reconcileNativeSchedulesEffect | Value | @relkit/app, @relkit/app/jobs |
API example |
| RecoverAbandonedControlRequest | Type | @relkit/app, @relkit/app/agents |
Module example |
| ReleasePresenceLease | Type | @relkit/app, @relkit/app/realtime |
API example |
| RELKIT_FUNCTION_GRAPH_NODE | Value | @relkit/app, @relkit/app/functions |
API example |
| RelkitSchema | Type | @relkit/app/schema |
API example |
| RenewControlClaimRequest | Type | @relkit/app, @relkit/app/agents |
Module example |
| RenewPresenceLease | Type | @relkit/app, @relkit/app/realtime |
API example |
| RenewRunClaimRequest | Type | @relkit/app, @relkit/app/agents |
Module example |
| requireJobsRuntime | Value | @relkit/app, @relkit/app/jobs |
API example |
| requireJobsRuntimeEffect | Value | @relkit/app, @relkit/app/jobs |
API example |
| requiresApproval | Value | @relkit/app, @relkit/app/agents |
API example |
| requiresApprovalEffect | Value | @relkit/app, @relkit/app/agents |
API example |
| RESERVED_SERVICE_MEMBER_NAMES | Value | @relkit/app, @relkit/app/services |
Module example |
| resolveBinding | Value | @relkit/app, @relkit/app/jobs |
API example |
| ResolveBindingOptions | Type | @relkit/app, @relkit/app/jobs |
Module example |
| ResolvedApplicationContext | Type | @relkit/app |
API example |
| ResolvedApplicationEnv | Type | @relkit/app, @relkit/app/functions |
API example |
| ResolvedConstants | Type | @relkit/app |
API example |
| ResolvedEnv | Type | @relkit/app, @relkit/app/config |
API example |
| ResolvedModelSelection | Type | @relkit/app, @relkit/app/agents |
Module example |
| ResolvedPrompt | Type | @relkit/app |
API example |
| ResolvedTaskBinding | Type | @relkit/app, @relkit/app/jobs |
Module example |
| ResolvedToolTarget | Type | @relkit/app, @relkit/app/tools |
API example |
| resolveEnv | Value | @relkit/app, @relkit/app/config |
API example |
| resolveEnvEffect | Value | @relkit/app, @relkit/app/config |
API example |
| ResolveEnvOptions | Type | @relkit/app, @relkit/app/config |
API example |
| resolveModelSelector | Value | @relkit/app, @relkit/app/agents |
API example |
| resolveModelSelectorEffect | Value | @relkit/app, @relkit/app/agents |
API example |
| resolveTaskBinding | Value | @relkit/app, @relkit/app/jobs |
API example |
| resolveTaskBindingEffect | Value | @relkit/app, @relkit/app/jobs |
API example |
| resolveToolTarget | Value | @relkit/app, @relkit/app/tools |
API example |
| resolveToolTargetEffect | Value | @relkit/app, @relkit/app/tools |
API example |
| RespondMapping | Type | @relkit/app, @relkit/app/routes |
API example |
| ResultAvailability | Type | @relkit/app, @relkit/app/jobs |
Module example |
| retryDelayMillis | Value | @relkit/app, @relkit/app/jobs |
API example |
| retryDelayMillisEffect | Value | @relkit/app, @relkit/app/jobs |
API example |
| RetryJitter | Type | @relkit/app, @relkit/app/jobs |
Module example |
| RetryJitter | Type | @relkit/app/jobs/legacy |
Module example |
| retryOperationIdentity | Value | @relkit/app, @relkit/app/jobs |
API example |
| retryOperationIdentityEffect | Value | @relkit/app, @relkit/app/jobs |
API example |
| RetryPolicy | Type | @relkit/app, @relkit/app/jobs |
Module example |
| RetryPolicy | Type | @relkit/app/jobs/legacy |
Source example |
| retryRun | Value | @relkit/app, @relkit/app/jobs |
API example |
| retryRunEffect | Value | @relkit/app, @relkit/app/jobs |
API example |
| rotateRunLocatorKeys | Value | @relkit/app, @relkit/app/jobs |
API example |
| rotateRunLocatorKeysEffect | Value | @relkit/app, @relkit/app/jobs |
API example |
| RouteClientPolicy | Type | @relkit/app, @relkit/app/routes |
API example |
| RouteDescriptor | Type | @relkit/app, @relkit/app/routes |
API example |
| RouteInputError | Value | @relkit/app, @relkit/app/routes |
API example |
| RouteModuleContract | Type | @relkit/app, @relkit/app/routes |
Source example |
| RouteModuleMethod | Type | @relkit/app, @relkit/app/routes |
Module example |
| RouteOperation | Type | @relkit/app, @relkit/app/routes |
API example |
| RouteOperationError | Value | @relkit/app, @relkit/app/routes |
API example |
| RouteRateLimit | Type | @relkit/app, @relkit/app/routes |
API example |
| RouteTelemetry | Value | @relkit/app, @relkit/app/routes |
API example |
| RouteTelemetryLive | Value | @relkit/app, @relkit/app/routes |
API example |
| RouteTelemetryService | Type | @relkit/app, @relkit/app/routes |
API example |
| RUN_LOCATOR_MAX_BYTES | Value | @relkit/app, @relkit/app/jobs |
API example |
| RUN_LOCATOR_VERSION | Value | @relkit/app, @relkit/app/jobs |
API example |
| RunAvailability | Type | @relkit/app, @relkit/app/jobs |
Module example |
| RunCancellationReceipt | Type | @relkit/app, @relkit/app/jobs |
Module example |
| RunConnection | Type | @relkit/app, @relkit/app/jobs |
Module example |
| runFunctionPromise | Value | @relkit/app, @relkit/app/functions |
API example |
| runFunctionSync | Value | @relkit/app, @relkit/app/functions |
API example |
| RunHandle | Type | @relkit/app, @relkit/app/jobs |
Source example |
| runInJobsRuntime | Value | @relkit/app, @relkit/app/jobs |
API example |
| runInJobsRuntimeEffect | Value | @relkit/app, @relkit/app/jobs |
API example |
| RunListQuery | Type | @relkit/app, @relkit/app/jobs |
Module example |
| RunLocatorCreateOptions | Type | @relkit/app, @relkit/app/jobs |
Module example |
| RunLocatorError | Value | @relkit/app, @relkit/app/jobs |
API example |
| RunLocatorFailure | Value | @relkit/app, @relkit/app/jobs |
API example |
| RunLocatorGeneration | Type | @relkit/app, @relkit/app/jobs |
Module example |
| RunLocatorGenerationStorage | Value | @relkit/app, @relkit/app/jobs |
API example |
| RunLocatorGenerationStore | Type | @relkit/app, @relkit/app/jobs |
Module example |
| RunLocatorKeyRing | Type | @relkit/app, @relkit/app/jobs |
Module example |
| RunLocatorKeyRingStore | Type | @relkit/app, @relkit/app/jobs |
Module example |
| RunLocatorPayload | Type | @relkit/app, @relkit/app/jobs |
Module example |
| RunLocatorRouter | Value | @relkit/app, @relkit/app/jobs |
API example |
| RunLocatorStoreFailure | Value | @relkit/app, @relkit/app/jobs |
API example |
| runLocatorStoreLayer | Value | @relkit/app, @relkit/app/jobs |
API example |
| RunLocatorVerifyOptions | Type | @relkit/app, @relkit/app/jobs |
Module example |
| RunOwner | Type | @relkit/app, @relkit/app/agents |
Module example |
| RunPage | Type | @relkit/app, @relkit/app/jobs |
Source example |
| RunReceiptLookup | Type | @relkit/app, @relkit/app/agents |
Module example |
| RunResultOptions | Type | @relkit/app, @relkit/app/jobs, @relkit/app/tasks |
Module example |
| RunRetryReceipt | Type | @relkit/app, @relkit/app/jobs |
Module example |
| runServiceSync | Value | @relkit/app, @relkit/app/services |
API example |
| RunSnapshot | Type | @relkit/app, @relkit/app/jobs |
Source example |
| RunStatus | Type | @relkit/app, @relkit/app/agents |
Module example |
| RunStatus | Type | @relkit/app/jobs |
Module example |
| RunWatchFrame | Type | @relkit/app, @relkit/app/jobs |
Source example |
| runWithJobsRuntime | Value | @relkit/app, @relkit/app/jobs |
API example |
| runWithJobsRuntimeEffect | Value | @relkit/app, @relkit/app/jobs |
API example |
| runWithRealtimeDispatcher | Value | @relkit/app, @relkit/app/realtime |
API example |
| runWithRealtimeDispatcherEffect | Value | @relkit/app, @relkit/app/realtime |
API example |
| ScheduleDefinition | Type | @relkit/app, @relkit/app/jobs |
Source example |
| ScheduleDefinition | Type | @relkit/app/jobs/legacy |
Module example |
| ScheduleListOptions | Type | @relkit/app, @relkit/app/jobs |
Module example |
| ScheduleMisfire | Type | @relkit/app, @relkit/app/jobs |
Module example |
| scheduleOccurrenceIdentity | Value | @relkit/app, @relkit/app/jobs |
API example |
| scheduleOccurrenceIdentityEffect | Value | @relkit/app, @relkit/app/jobs |
API example |
| scheduleOperationId | Value | @relkit/app, @relkit/app/jobs |
API example |
| scheduleOperationIdEffect | Value | @relkit/app, @relkit/app/jobs |
API example |
| ScheduleOverlap | Type | @relkit/app, @relkit/app/jobs |
Module example |
| ScheduleOverlap | Type | @relkit/app/jobs/legacy |
Module example |
| scheduleOwner | Value | @relkit/app, @relkit/app/jobs |
API example |
| scheduleOwnerEffect | Value | @relkit/app, @relkit/app/jobs |
API example |
| ScheduleReadReceipt | Type | @relkit/app, @relkit/app/jobs |
Module example |
| ScheduleReconciliationFailure | Value | @relkit/app, @relkit/app/jobs |
API example |
| ScheduleReconciliationOptions | Type | @relkit/app, @relkit/app/jobs |
Module example |
| ScheduleReconciliationResult | Type | @relkit/app, @relkit/app/jobs |
Module example |
| ScheduleRecord | Type | @relkit/app, @relkit/app/jobs |
Module example |
| ScheduleWriteOptions | Type | @relkit/app, @relkit/app/jobs |
Module example |
| ScheduleWriteOutcome | Type | @relkit/app, @relkit/app/jobs |
Module example |
| ScheduleWriteReceipt | Type | @relkit/app, @relkit/app/jobs |
Module example |
| Schema | Type | @relkit/app/schema |
API example |
| SchemaAsyncError | Value | @relkit/app/schema |
API example |
| SchemaBuilderError | Value | @relkit/app/schema |
API example |
| SchemaExecutionError | Value | @relkit/app/schema |
API example |
| SchemaInvalidError | Value | @relkit/app/schema |
API example |
| SchemaIssuesError | Value | @relkit/app/schema |
API example |
| SchemaProjector | Value | @relkit/app/schema |
API example |
| SchemaProjectorLive | Value | @relkit/app/schema |
API example |
| SchemaProjectorService | Type | @relkit/app/schema |
API example |
| SchemaTelemetry | Value | @relkit/app/schema |
API example |
| SchemaTelemetryLive | Value | @relkit/app/schema |
API example |
| SchemaTelemetryService | Type | @relkit/app/schema |
API example |
| SchemaValidationError | Value | @relkit/app/schema |
API example |
| SchemaValidator | Value | @relkit/app/schema |
API example |
| SchemaValidatorLive | Value | @relkit/app/schema |
API example |
| SchemaValidatorService | Type | @relkit/app/schema |
API example |
| serializeJobsServiceOptions | Value | @relkit/app, @relkit/app/jobs |
API example |
| serializeJobsServiceOptionsEffect | Value | @relkit/app, @relkit/app/jobs |
API example |
| ServerConfig | Type | @relkit/app, @relkit/app/config |
API example |
| ServerTriggerOptions | Type | @relkit/app, @relkit/app/jobs, @relkit/app/tasks |
Module example |
| SERVICE_RESERVED_MEMBER_NAMES | Value | @relkit/app, @relkit/app/services |
Module example |
| SERVICE_ROUTE_METHODS | Value | @relkit/app, @relkit/app/routes |
Source example |
| ServiceDescriptor | Type | @relkit/app, @relkit/app/services |
API example |
| ServiceDescriptorAny | Type | @relkit/app, @relkit/app/services |
API example |
| ServiceEventMap | Type | @relkit/app, @relkit/app/services |
API example |
| ServiceEvents | Type | @relkit/app, @relkit/app/services |
API example |
| ServiceFunctionMap | Type | @relkit/app, @relkit/app/services |
API example |
| ServiceFunctions | Type | @relkit/app, @relkit/app/services |
API example |
| ServiceJobMap | Type | @relkit/app, @relkit/app/services |
API example |
| ServiceJobs | Type | @relkit/app, @relkit/app/services |
API example |
| serviceMemberEntries | Value | @relkit/app, @relkit/app/services |
API example |
| serviceMemberEntriesEffect | Value | @relkit/app, @relkit/app/services |
API example |
| ServiceRef | Type | @relkit/app, @relkit/app/services |
API example |
| ServiceRefAny | Type | @relkit/app, @relkit/app/services |
API example |
| ServiceRouteEntry | Type | @relkit/app, @relkit/app/routes |
API example |
| ServiceRouteMethod | Type | @relkit/app, @relkit/app/routes |
API example |
| ServiceRouteOptions | Type | @relkit/app, @relkit/app/routes |
API example |
| ServiceRoutesOptions | Type | @relkit/app, @relkit/app/routes |
API example |
| ServiceRoutesResult | Type | @relkit/app, @relkit/app/routes |
API example |
| ServiceTaskMap | Type | @relkit/app, @relkit/app/services |
API example |
| ServiceTasks | Type | @relkit/app, @relkit/app/services |
API example |
| ServiceTelemetry | Value | @relkit/app, @relkit/app/services |
API example |
| ServiceTelemetryLive | Value | @relkit/app, @relkit/app/services |
API example |
| ServiceValidationError | Value | @relkit/app, @relkit/app/services |
API example |
| setActiveRealtimeDispatcher | Value | @relkit/app, @relkit/app/realtime |
API example |
| setActiveRealtimeDispatcherEffect | Value | @relkit/app, @relkit/app/realtime |
API example |
| setCacheEffect | Value | @relkit/app, @relkit/app/cache |
API example |
| SettleControlRequest | Type | @relkit/app, @relkit/app/agents |
Module example |
| SnapshotHistoryPage | Type | @relkit/app, @relkit/app/agents |
Module example |
| stableIdentityTuple | Value | @relkit/app, @relkit/app/jobs |
API example |
| stableIdentityTupleEffect | Value | @relkit/app, @relkit/app/jobs |
API example |
| StandardFailure | Type | @relkit/app/schema |
API example |
| StandardIssue | Type | @relkit/app/schema |
API example |
| StandardJSONSchemaV1 | Type | @relkit/app/schema |
API example |
| StandardPathSegment | Type | @relkit/app/schema |
API example |
| StandardResult | Type | @relkit/app/schema |
API example |
| StandardSchemaOptions | Type | @relkit/app/schema |
API example |
| StandardSchemaTypes | Type | @relkit/app/schema |
API example |
| StandardSchemaV1 | Type | @relkit/app/schema |
API example |
| StandardSuccess | Type | @relkit/app/schema |
API example |
| StoredApproval | Type | @relkit/app, @relkit/app/agents |
Module example |
| StoredRun | Type | @relkit/app, @relkit/app/agents |
Module example |
| StoredRunRouting | Type | @relkit/app, @relkit/app/agents |
Module example |
| StoredThread | Type | @relkit/app, @relkit/app/agents |
Module example |
| StreamIdentity | Type | @relkit/app, @relkit/app/jobs |
Module example |
| StreamItem | Type | @relkit/app, @relkit/app/jobs |
Module example |
| streamOf | Value | @relkit/app, @relkit/app/functions |
API example |
| streamOfEffect | Value | @relkit/app, @relkit/app/functions |
API example |
| StreamOutputSchema | Type | @relkit/app, @relkit/app/functions |
API example |
| StringSchema | Type | @relkit/app/schema |
API example |
| SubmissionAdmission | Type | @relkit/app, @relkit/app/jobs |
Module example |
| SubmissionPipeline | Type | @relkit/app, @relkit/app/jobs |
Module example |
| submitCanonicalTask | Value | @relkit/app, @relkit/app/jobs |
API example |
| submitCanonicalTaskEffect | Value | @relkit/app, @relkit/app/jobs |
API example |
| submitJob | Value | @relkit/app, @relkit/app/jobs |
API example |
| submitJobEffect | Value | @relkit/app, @relkit/app/jobs |
API example |
| submitPreparedSubmission | Value | @relkit/app, @relkit/app/jobs |
API example |
| submitTask | Value | @relkit/app, @relkit/app/jobs |
API example |
| submitTaskEffect | Value | @relkit/app, @relkit/app/jobs |
API example |
| SuspendRunRequest | Type | @relkit/app, @relkit/app/agents |
Module example |
| SuspensionReceipt | Type | @relkit/app, @relkit/app/agents |
Module example |
| TASK_INPUT_MAX_BYTES | Value | @relkit/app, @relkit/app/jobs |
API example |
| TASK_ITEM_MAX_BYTES | Value | @relkit/app, @relkit/app/jobs |
API example |
| TASK_KEY_MAX_BYTES | Value | @relkit/app, @relkit/app/jobs |
API example |
| TASK_MAX_TAGS | Value | @relkit/app, @relkit/app/jobs |
API example |
| TASK_OUTPUT_MAX_BYTES | Value | @relkit/app, @relkit/app/jobs |
API example |
| TASK_REASON_MAX_BYTES | Value | @relkit/app, @relkit/app/jobs |
API example |
| TaskAuthContext | Type | @relkit/app, @relkit/app/jobs, @relkit/app/tasks |
Module example |
| TaskBlockingWaitError | Value | @relkit/app, @relkit/app/jobs |
API example |
| TaskCallerInput | Type | @relkit/app, @relkit/app/jobs, @relkit/app/tasks |
Source example |
| TaskCanonicalInput | Type | @relkit/app, @relkit/app/jobs, @relkit/app/tasks |
Source example |
| TaskClientFor | Type | @relkit/app, @relkit/app/jobs |
Module example |
| TaskClientFor | Type | @relkit/app/functions |
API example |
| TaskClients | Type | @relkit/app, @relkit/app/jobs |
Module example |
| TaskClients | Type | @relkit/app/functions |
API example |
| TaskConcurrency | Type | @relkit/app, @relkit/app/jobs, @relkit/app/tasks |
Module example |
| TaskContext | Type | @relkit/app, @relkit/app/jobs, @relkit/app/tasks |
Module example |
| TaskContextBase | Type | @relkit/app, @relkit/app/jobs, @relkit/app/tasks |
Module example |
| TaskDefinitionFailure | Value | @relkit/app, @relkit/app/jobs |
API example |
| TaskDependencies | Type | @relkit/app, @relkit/app/jobs, @relkit/app/tasks |
Module example |
| TaskDescriptor | Type | @relkit/app, @relkit/app/jobs, @relkit/app/tasks |
Module example |
| TaskDescriptorAny | Type | @relkit/app, @relkit/app/jobs, @relkit/app/tasks |
Source example |
| TaskEmissionError | Value | @relkit/app, @relkit/app/jobs |
API example |
| TaskEmissionErrorCode | Type | @relkit/app, @relkit/app/jobs |
Module example |
| TaskEmissionFailure | Value | @relkit/app, @relkit/app/jobs |
API example |
| TaskEmissionSink | Type | @relkit/app, @relkit/app/jobs |
Module example |
| TaskEmitterOptions | Type | @relkit/app, @relkit/app/jobs |
Module example |
| TaskExecution | Type | @relkit/app, @relkit/app/jobs, @relkit/app/tasks |
Module example |
| TaskExecutionBinding | Type | @relkit/app, @relkit/app/jobs |
Module example |
| TaskExecutionEnvelope | Type | @relkit/app, @relkit/app/jobs |
Module example |
| TaskExecutor | Type | @relkit/app, @relkit/app/jobs |
Module example |
| TaskFailureHook | Type | @relkit/app, @relkit/app/jobs, @relkit/app/tasks |
Module example |
| TaskHandler | Type | @relkit/app, @relkit/app/jobs, @relkit/app/tasks |
Source example |
| TaskHandlerResult | Type | @relkit/app, @relkit/app/jobs, @relkit/app/tasks |
Module example |
| TaskHookContext | Type | @relkit/app, @relkit/app/jobs, @relkit/app/tasks |
Module example |
| TaskInput | Type | @relkit/app, @relkit/app/jobs, @relkit/app/tasks |
Module example |
| TaskLogging | Type | @relkit/app, @relkit/app/jobs, @relkit/app/tasks |
Module example |
| TaskObservation | Type | @relkit/app, @relkit/app/jobs |
Module example |
| taskOperationIdentity | Value | @relkit/app, @relkit/app/jobs |
API example |
| taskOperationIdentityEffect | Value | @relkit/app, @relkit/app/jobs |
API example |
| TaskOutput | Type | @relkit/app, @relkit/app/jobs, @relkit/app/tasks |
Module example |
| TaskPolicyRandom | Value | @relkit/app, @relkit/app/jobs |
API example |
| taskPolicyRandomLayer | Value | @relkit/app, @relkit/app/jobs |
API example |
| TaskProgressEmitter | Type | @relkit/app, @relkit/app/jobs, @relkit/app/tasks |
Module example |
| TaskProgressInput | Type | @relkit/app, @relkit/app/jobs, @relkit/app/tasks |
Source example |
| TaskProgressOutput | Type | @relkit/app, @relkit/app/jobs, @relkit/app/tasks |
Source example |
| TaskRawHandlerOutput | Type | @relkit/app, @relkit/app/jobs, @relkit/app/tasks |
Source example |
| TaskResources | Type | @relkit/app, @relkit/app/jobs, @relkit/app/tasks |
Module example |
| TaskRetryPolicy | Type | @relkit/app, @relkit/app/jobs, @relkit/app/tasks |
Module example |
| TaskRunContext | Type | @relkit/app, @relkit/app/jobs, @relkit/app/tasks |
Module example |
| TaskSleepOptions | Type | @relkit/app, @relkit/app/jobs, @relkit/app/tasks |
Module example |
| TaskStartHook | Type | @relkit/app, @relkit/app/jobs, @relkit/app/tasks |
Module example |
| TaskStreamEmitter | Type | @relkit/app, @relkit/app/jobs, @relkit/app/tasks |
Module example |
| TaskStreamEmitterOptions | Type | @relkit/app, @relkit/app/jobs |
Module example |
| TaskStreamEmitters | Type | @relkit/app, @relkit/app/jobs, @relkit/app/tasks |
Module example |
| TaskStreamFrames | Type | @relkit/app, @relkit/app/jobs, @relkit/app/tasks |
Module example |
| TaskStreamInput | Type | @relkit/app, @relkit/app/jobs, @relkit/app/tasks |
Source example |
| TaskStreamItem | Type | @relkit/app, @relkit/app/jobs, @relkit/app/tasks |
Module example |
| TaskStreamOutput | Type | @relkit/app, @relkit/app/jobs, @relkit/app/tasks |
Source example |
| TaskStreamSchemas | Type | @relkit/app, @relkit/app/jobs, @relkit/app/tasks |
Module example |
| TaskStreamSink | Type | @relkit/app, @relkit/app/jobs |
Module example |
| TaskSubmissionMetadata | Type | @relkit/app, @relkit/app/jobs |
Source example |
| TaskSuccessHook | Type | @relkit/app, @relkit/app/jobs, @relkit/app/tasks |
Source example |
| TaskTriggerOptions | Type | @relkit/app, @relkit/app/jobs, @relkit/app/tasks |
Module example |
| TaskTriggerOptions | Type | @relkit/app/functions |
API example |
| TaskValidatedOutput | Type | @relkit/app, @relkit/app/jobs, @relkit/app/tasks |
Source example |
| TaskWireErrorCode | Type | @relkit/app, @relkit/app/jobs |
Module example |
| TaskWireFailure | Value | @relkit/app, @relkit/app/jobs |
API example |
| TaskWireValidationError | Value | @relkit/app, @relkit/app/jobs |
API example |
| ThreadAction | Type | @relkit/app, @relkit/app/agents |
Source example |
| ThreadList | Type | @relkit/app, @relkit/app/agents |
Module example |
| ThreadListItem | Type | @relkit/app, @relkit/app/agents |
Module example |
| ThreadSnapshot | Type | @relkit/app, @relkit/app/agents |
Source example |
| ThreadStatus | Type | @relkit/app, @relkit/app/agents |
Source example |
| ThreadTransition | Type | @relkit/app, @relkit/app/agents |
Module example |
| toJsonSchema | Value | @relkit/app/schema |
API example |
| ToolAllowlistEntry | Type | @relkit/app, @relkit/app/tools |
API example |
| ToolApproval | Type | @relkit/app, @relkit/app/tools |
Module example |
| ToolApprovalDecision | Type | @relkit/app, @relkit/app/tools |
Module example |
| ToolApprovalDeniedError | Value | @relkit/app, @relkit/app/tools |
API example |
| ToolApprovalRequest | Type | @relkit/app, @relkit/app/tools |
Module example |
| ToolApprovalRequiredError | Value | @relkit/app, @relkit/app/tools |
API example |
| ToolApprovalResolver | Type | @relkit/app, @relkit/app/tools |
Module example |
| ToolArgumentsFailure | Value | @relkit/app, @relkit/app/tools |
API example |
| ToolArgumentValidationError | Value | @relkit/app, @relkit/app/tools |
API example |
| ToolCancelledFailure | Value | @relkit/app, @relkit/app/tools |
API example |
| ToolDescriptor | Type | @relkit/app, @relkit/app/tools |
API example |
| ToolEffectOptions | Type | @relkit/app, @relkit/app/tools |
API example |
| ToolEngine | Type | @relkit/app, @relkit/app/tools |
API example |
| ToolEngineFailure | Value | @relkit/app, @relkit/app/tools |
API example |
| ToolEngineInvocation | Type | @relkit/app, @relkit/app/tools |
API example |
| ToolEngineLive | Value | @relkit/app, @relkit/app/tools |
API example |
| ToolEngineLiveEffect | Value | @relkit/app, @relkit/app/tools |
API example |
| ToolEngineService | Value | @relkit/app, @relkit/app/tools |
API example |
| ToolInvocationContext | Type | @relkit/app, @relkit/app/tools |
API example |
| ToolInvocationRequest | Type | @relkit/app, @relkit/app/tools |
API example |
| ToolInvokeOptions | Type | @relkit/app, @relkit/app/tools |
Module example |
| ToolNotAllowedError | Value | @relkit/app, @relkit/app/tools |
API example |
| ToolNotAllowedFailure | Value | @relkit/app, @relkit/app/tools |
API example |
| ToolOperation | Type | @relkit/app, @relkit/app/tools |
API example |
| ToolOperationCancelledError | Value | @relkit/app, @relkit/app/tools |
API example |
| ToolOperationFailure | Value | @relkit/app, @relkit/app/tools |
API example |
| ToolPartState | Type | @relkit/app, @relkit/app/agents |
Source example |
| ToolRef | Type | @relkit/app, @relkit/app/tools |
API example |
| ToolRefAny | Type | @relkit/app, @relkit/app/tools |
Module example |
| ToolRuntime | Type | @relkit/app, @relkit/app/tools |
API example |
| ToolRuntimeOptions | Type | @relkit/app, @relkit/app/tools |
API example |
| ToolSideEffect | Type | @relkit/app, @relkit/app/tools |
Module example |
| ToolSource | Type | @relkit/app, @relkit/app/tools |
API example |
| ToolTarget | Type | @relkit/app, @relkit/app/tools |
API example |
| ToolTelemetry | Value | @relkit/app, @relkit/app/tools |
API example |
| ToolTelemetryLive | Value | @relkit/app, @relkit/app/tools |
API example |
| ToolTelemetryService | Type | @relkit/app, @relkit/app/tools |
Module example |
| ToolUnknownError | Value | @relkit/app, @relkit/app/tools |
API example |
| ToolUnknownFailure | Value | @relkit/app, @relkit/app/tools |
API example |
| TransformOutput | Type | @relkit/app, @relkit/app/routes |
API example |
| TransformReference | Type | @relkit/app, @relkit/app/routes |
API example |
| triggerChannelEffect | Value | @relkit/app, @relkit/app/realtime |
API example |
| TriggerOptions | Type | @relkit/app, @relkit/app/jobs, @relkit/app/tasks |
Source example |
| triggerProviderEffect | Value | @relkit/app, @relkit/app/realtime |
API example |
| TriggerReceipt | Type | @relkit/app, @relkit/app/realtime |
API example |
| TrustedJobScope | Type | @relkit/app, @relkit/app/jobs |
API example |
| UnknownEventEnvelope | Type | @relkit/app, @relkit/app/events |
API example |
| utf8Bytes | Value | @relkit/app, @relkit/app/jobs |
API example |
| utf8BytesEffect | Value | @relkit/app, @relkit/app/jobs |
API example |
| validate | Value | @relkit/app/schema |
API example |
| validateCanonicalInput | Value | @relkit/app, @relkit/app/jobs |
API example |
| validateCanonicalInputEffect | Value | @relkit/app, @relkit/app/jobs |
API example |
| validateCanonicalOutput | Value | @relkit/app, @relkit/app/jobs |
API example |
| validateCanonicalOutputEffect | Value | @relkit/app, @relkit/app/jobs |
API example |
| validateDuration | Value | @relkit/app, @relkit/app/jobs |
API example |
| validateEffect | Value | @relkit/app/schema |
API example |
| validateJobName | Value | @relkit/app, @relkit/app/jobs |
API example |
| validateJobNameEffect | Value | @relkit/app, @relkit/app/jobs |
API example |
| validateJobsCapabilityReport | Value | @relkit/app, @relkit/app/jobs |
API example |
| validateJobsCapabilityReportEffect | Value | @relkit/app, @relkit/app/jobs |
API example |
| validateJobsServiceOptions | Value | @relkit/app, @relkit/app/jobs |
API example |
| validateJobsServiceOptionsEffect | Value | @relkit/app, @relkit/app/jobs |
API example |
| validateResultOptions | Value | @relkit/app, @relkit/app/jobs |
API example |
| validateRunLocatorKeyRing | Value | @relkit/app, @relkit/app/jobs |
API example |
| validateRunLocatorKeyRingEffect | Value | @relkit/app, @relkit/app/jobs |
API example |
| validateSync | Value | @relkit/app/schema |
API example |
| validateSyncEffect | Value | @relkit/app/schema |
API example |
| validateTaskInput | Value | @relkit/app, @relkit/app/jobs |
API example |
| validateTaskInputEffect | Value | @relkit/app, @relkit/app/jobs |
API example |
| validateTaskOutput | Value | @relkit/app, @relkit/app/jobs |
API example |
| validateTaskOutputEffect | Value | @relkit/app, @relkit/app/jobs |
API example |
| ValidJobName | Type | @relkit/app, @relkit/app/jobs |
Module example |
| VerifiedRunLocator | Type | @relkit/app, @relkit/app/jobs |
Module example |
| verifyRunLocator | Value | @relkit/app, @relkit/app/jobs |
API example |
| verifyRunLocatorEffect | Value | @relkit/app, @relkit/app/jobs |
API example |
| VoidWireEnvelope | Type | @relkit/app, @relkit/app/jobs |
Module example |
| WaitForChannelEvents | Type | @relkit/app, @relkit/app/realtime |
API example |
| WaitForControlsRequest | Type | @relkit/app, @relkit/app/agents |
Module example |
| WaitForJournalRequest | Type | @relkit/app, @relkit/app/agents |
Module example |
| waitForResult | Value | @relkit/app, @relkit/app/jobs |
API example |
| waitForResultEffect | Value | @relkit/app, @relkit/app/jobs |
API example |
| writeScheduleEffect | Value | @relkit/app, @relkit/app/jobs |
API example |
| z | Value | @relkit/app/schema |
API example |
| ZBuilder | Type | @relkit/app/schema |
API example |
agents.ts
“@relkit/agents” (namespace export)
Re-exports all named exports from the “@relkit/agents” module.
Signature
export * from "@relkit/agents";app-config.types.ts
Declares server exposure and optional HTTP capability selection without loading native SDKs. Compiler validation supplies defaults before runtime generation; inspector settings select only the development bridge, independently of a tool.
ApiDocsConfig (interface)
API documentation visibility and domain exclusions.
Example
const docs: ApiDocsConfig = { enabledInProduction: false };Signature
export interface ApiDocsConfig {
/** Explicitly selects Scalar; omitted/false keeps JSON OpenAPI only. */
readonly ui?: "scalar" | false;
readonly enabledInProduction?: boolean;
readonly excludeDomains?: readonly string[];
}AppCompatibilityConfig (interface)
Transitional compatibility switches for application authoring.
Example
const compatibility: AppCompatibilityConfig = { legacyJobs: true };Signature
export interface AppCompatibilityConfig {
readonly legacyJobs?: boolean;
}InspectorConfig (interface)
Development bridge selection; installing or running the UI is independent.
Example
const inspector: InspectorConfig = { enabled: true };Signature
export interface InspectorConfig extends InspectorConfigurationInput {}ServerConfig (interface)
HTTP server settings attached to an application descriptor.
Example
const server: ServerConfig = { port: 3000, apiDocs: { enabledInProduction: false } };Signature
export interface ServerConfig {
readonly port?: number;
readonly maxBodyBytes?: number;
readonly apiDocs?: ApiDocsConfig;
readonly clientContract?: boolean;
readonly mcp?: boolean;
/** Explicitly selects the optional AG-UI HTTP protocol independently of agent RPC. */
readonly agUi?: boolean;
}app-observability.ts
AppTelemetry (class)
Injectable observer for application authoring operations.
Example
Effect.provide(defineAppEffect(options), AppTelemetryLive);Signature
declare class AppTelemetryAppTelemetryLive
Live spans, counts, failures, and durations for application operations.
Example
Effect.provide(defineAppEffect(options), AppTelemetryLive);Signature
declare const AppTelemetryLive: Layer.Layer<AppTelemetry, never, never>;observeApp
Applies an injected observer or the live observer to one operation.
Example
observeApp("define", Effect.succeed(app));Signature
declare const observeApp: <A, E, R>(
operation: AppOperation,
effect: Effect.Effect<A, E, R>,
) => Effect.Effect<A, E, R>;app-observability.types.ts
Defines bounded application-authoring operation labels and the injectable observer contract. Observers preserve each operation’s success/error/services while the live implementation records its spans and outcomes.
AppOperation (type alias)
Fixed operation labels used for application authoring telemetry.
Example
const operation: AppOperation = "define";Signature
type AppOperation =
| "define"
| "env.isDefinition"
| "id.derive"
| "compatibility.normalize"
| "runtimeMetadata.normalize"
| "alias.assertExclusive"
| "constants.define"
| "prompt.define"
| "context.create"
| "context.resolve";AppTelemetryService (interface)
A replaceable observer for application authoring operations.
Example
const observer: AppTelemetryService = { observe: (_name, effect) => effect };Signature
export interface AppTelemetryService {
/** Surrounds one operation without changing its result.
* @param operation - A fixed operation label.
* @param effect - The operation to observe.
* @returns The observed Effect with its success and error channels intact.
* @example observer.observe("define", Effect.succeed(app));
*/
readonly observe: <A, E, R>(
operation: AppOperation,
effect: Effect.Effect<A, E, R>,
) => Effect.Effect<A, E, R>;
}app-provider-capabilities.ts
Provider capabilities accepted by application descriptors.
APP_PROVIDER_CAPABILITIES
Provider capabilities accepted by application descriptors.
Signature
declare const APP_PROVIDER_CAPABILITIES: readonly [
"bucket",
"cache",
"job",
"event",
"model",
"realtime",
"agent-state",
];app-provider-normalization.ts
copyEffect
Copies a serializable configuration value through RELKIT’s serializer.
Example
Effect.runSync(copyEffect({ port: 3000 }));Signature
declare const copyEffect: <Value>(
value: Value,
) => Effect.Effect<Value, AppValidationFailure, never>;normalizeDefaultsEffect
Checks default profile selections and returns an immutable copy.
Example
Effect.runSync(normalizeDefaultsEffect({}, undefined));Signature
declare const normalizeDefaultsEffect: <Providers extends AppProviderInputs>(
providers: Partial<
Record<
"bucket" | "cache" | "job" | "event" | "model" | "realtime" | "agent-state",
NormalizedProviderProfiles<ProviderAdapter>
>
>,
defaults: AppProviderDefaults<Providers> | undefined,
) => Effect.Effect<
Readonly<{
bucket?: ProfileFor<Providers, "bucket">;
cache?: ProfileFor<Providers, "cache">;
job?: ProfileFor<Providers, "job">;
event?: ProfileFor<Providers, "event">;
model?: ProfileFor<Providers, "model">;
realtime?: ProfileFor<Providers, "realtime">;
"agent-state"?: ProfileFor<Providers, "agent-state">;
}>,
AppValidationFailure,
never
>;normalizeProvidersEffect
Normalizes configured provider profiles in capability order.
Example
Effect.runSync(normalizeProvidersEffect({}));Signature
declare const normalizeProvidersEffect: (
options: AppProviderInputs,
) => Effect.Effect<
Partial<
Record<
"bucket" | "cache" | "job" | "event" | "model" | "realtime" | "agent-state",
NormalizedProviderProfiles<ProviderAdapter>
>
>,
AppValidationFailure,
never
>;app-provider.types.ts
AppProviderCapability (type alias)
Provider capabilities accepted by the application descriptor.
Example
const capability: AppProviderCapability = "cache";Signature
type AppProviderCapability = (typeof APP_PROVIDER_CAPABILITIES)[number];AppProviderDefaults (type alias)
Public default-profile spellings; normalized descriptors use job.
Example
const defaults: AppProviderDefaults<typeof providers> = { cache: "default" };Signature
type AppProviderDefaults<Providers extends AppProviderInputs> = Readonly<{
[Capability in Exclude<AppProviderCapability, "job">]?: ProfileFor<Providers, Capability>;
}> & {
readonly jobs?: ProfileFor<Providers, "job">;
/** @deprecated Use `jobs`. */
readonly job?: ProfileFor<Providers, "job">;
};AppProviderInputs (interface)
Optional provider bindings for every supported capability.
Example
const providers: AppProviderInputs = { cache: redisAdapter };Signature
export interface AppProviderInputs {
readonly bucket?: CapabilityInput<"bucket">;
readonly cache?: CapabilityInput<"cache">;
/** Public plural spelling for the jobs provider capability. */
readonly jobs?: CapabilityInput<"job">;
/** @deprecated Use `jobs`. */
readonly job?: CapabilityInput<"job">;
readonly event?: CapabilityInput<"event">;
readonly model?: CapabilityInput<"model">;
readonly realtime?: CapabilityInput<"realtime">;
readonly "agent-state"?: CapabilityInput<"agent-state">;
}NormalizedAppProviderDefaults (type alias)
Validated default profiles keyed by normalized capability names.
Example
const defaults: NormalizedAppProviderDefaults<typeof providers> = { cache: "default" };Signature
type NormalizedAppProviderDefaults<Providers extends AppProviderInputs> = Readonly<{
[Capability in AppProviderCapability]?: ProfileFor<Providers, Capability>;
}>;NormalizedProviders (type alias)
Provider profiles inferred from the authored provider bindings.
Example
type Profiles = NormalizedProviders<typeof providers>;Signature
type NormalizedProviders<Providers extends AppProviderInputs> = {
readonly [
Capability in AppProviderCapability as [ProviderInputFor<Providers, Capability>] extends [never]
? never
: Capability
]: NormalizedProviderProfiles<AdapterOf<ProviderInputFor<Providers, Capability>>>;
};app-runtime-metadata.ts
Copies application server/deployment metadata and validates optional inspection selection before descriptor freezing. These pure authoring effects acquire no listeners or providers; invalid input retains the public validation cause.
normalizeAppRuntimeMetadataEffect
Normalizes immutable runtime policy without starting its selected features.
Signature
declare const normalizeAppRuntimeMetadataEffect: (
options: Pick<ApplicationDescriptor, "server" | "inspector" | "deployment">,
) => Effect.Effect<
{
server: ServerConfig | undefined;
inspector: InspectorConfiguration | undefined;
deployment: Readonly<Record<string, JsonValue>> | undefined;
},
AppValidationFailure,
never
>;app-validation.ts
AppValidationFailure (class)
Expected invalid application input with the original cause preserved.
Example
if (error._tag === "AppValidationFailure") console.error(error.message);Signature
declare class AppValidationFailureassertExclusiveAlias
Synchronous alias exclusivity adapter.
Throws
TypeError when both aliases are present.
Example
assertExclusiveAlias(options, "jobs", "job", "defineApp");Signature
declare const assertExclusiveAlias: (
value: Record<string, unknown>,
primary: string,
legacy: string,
label: string,
) => void;assertExclusiveAliasEffect
Rejects simultaneous current and legacy aliases in Effect.
Example
Effect.runSync(assertExclusiveAliasEffect(options, "jobs", "job", "defineApp"));Signature
declare const assertExclusiveAliasEffect: (
value: Record<string, unknown>,
primary: string,
legacy: string,
label: string,
) => Effect.Effect<void, AppValidationFailure, never>;deriveApplicationId
Synchronous package-name ID adapter.
Throws
The original normalization error for invalid input.
Example
deriveApplicationId("@acme/orders");Signature
declare const deriveApplicationId: (packageName: string) => string;deriveApplicationIdEffect
Derives an application ID from a package name in Effect.
Example
Effect.runSync(deriveApplicationIdEffect("@acme/orders"));Signature
declare const deriveApplicationIdEffect: (
packageName: string,
) => Effect.Effect<StableId, AppValidationFailure, never>;isEnvDefinition
Synchronous environment descriptor guard.
Example
if (isEnvDefinition(value)) console.log(value.shape);Signature
declare const isEnvDefinition: (value: unknown) => value is EnvDefinition<EnvShape>;isEnvDefinitionEffect
Checks the complete environment descriptor shape in Effect.
Example
Effect.runSync(isEnvDefinitionEffect(value));Signature
declare const isEnvDefinitionEffect: (value: unknown) => Effect.Effect<boolean, never, never>;normalizeCompatibility
Synchronous compatibility normalizer.
Throws
TypeError for an invalid compatibility flag.
Example
normalizeCompatibility({ legacyJobs: true });Signature
declare const normalizeCompatibility: (value: AppCompatibilityConfig | undefined) => {
readonly legacyJobs: boolean;
};normalizeCompatibilityEffect
Normalizes the legacy jobs compatibility flag in Effect.
Example
Effect.runSync(normalizeCompatibilityEffect({ legacyJobs: true }));Signature
declare const normalizeCompatibilityEffect: (
value: AppCompatibilityConfig | undefined,
) => Effect.Effect<Readonly<{ legacyJobs: boolean }>, AppValidationFailure, never>;buckets.ts
“@relkit/buckets” (namespace export)
Re-exports all named exports from the “@relkit/buckets” module.
Signature
export * from "@relkit/buckets";cache.ts
“@relkit/cache” (namespace export)
Re-exports all named exports from the “@relkit/cache” module.
Signature
export * from "@relkit/cache";config.ts
“./app-validation.js” (namespace export)
Re-exports all named exports from the “./app-validation.js” module.
Signature
export * from "./app-validation.js";“./define-app.js” (namespace export)
Re-exports all named exports from the “./define-app.js” module.
Signature
export * from "./define-app.js";“@relkit/config” (namespace export)
Re-exports all named exports from the “@relkit/config” module.
Signature
export * from "@relkit/config";AppTelemetry
Signature
declare const AppTelemetry: typeof AppTelemetry;AppTelemetryLive
Signature
declare const AppTelemetryLive: Layer<AppTelemetry, never, never>;context-descriptors.ts
“./context-descriptors.types.js” (namespace export)
Re-exports all named exports from the “./context-descriptors.types.js” module.
Signature
export * from "./context-descriptors.types.js";ContextDescriptorFailure (class)
Expected invalid constant or prompt descriptor input.
Example
if (error._tag === "ContextDescriptorFailure") console.error(error.message);Signature
declare class ContextDescriptorFailuredefineConstants
Synchronous constants descriptor adapter.
Throws
The original validation error for invalid values.
Example
import { defineConstants, defineEnv, env } from "@relkit/app";
const environment = defineEnv({ REGION: env.string() });
const limits = defineConstants({ maxItems: 20, region: environment.REGION });
// Literal values are immutable; the environment reference resolves with the context.See
Signature
declare const defineConstants: <const Values extends ConstantsShape>(
values: Values,
options?: ContextDescriptorOptions,
) => ConstantsDescriptor<Values>;defineConstantsEffect
Defines a frozen constants descriptor in Effect.
Example
Effect.runSync(defineConstantsEffect({ region: "eu" }));Signature
declare const defineConstantsEffect: <const Values extends ConstantsShape>(
values: Values,
options?: ContextDescriptorOptions | undefined,
) => Effect.Effect<ConstantsDescriptor<Values>, ContextDescriptorFailure, never>;definePrompt
Synchronous prompt descriptor adapter.
Throws
The original validation error for invalid text.
Example
import { definePrompt } from "@relkit/app";
const support = definePrompt(["Use the order details.", "Do not invent delivery dates."]);
// support.value preserves the two fragments in order.See
Signature
declare const definePrompt: <const Value extends PromptValue>(
value: Value,
options?: ContextDescriptorOptions,
) => PromptDescriptor<Value>;definePromptEffect
Defines a frozen prompt descriptor in Effect.
Example
Effect.runSync(definePromptEffect("Be concise."));Signature
declare const definePromptEffect: <const Value extends PromptValue>(
value: Value,
options?: ContextDescriptorOptions | undefined,
) => Effect.Effect<PromptDescriptor<Value>, ContextDescriptorFailure, never>;context-descriptors.types.ts
ConstantResolver (type alias)
Computes one constant for each context resolution.
Example
const region: ConstantResolver<string> = ({ env }) => String(env.REGION);Signature
type ConstantResolver<Value = unknown> = (options: ContextResolverOptions) => MaybePromise<Value>;ConstantValue (type alias)
Accepted static, environment, or dynamic constant input.
Example
const value: ConstantValue = "eu-west-1";Signature
type ConstantValue = JsonValue | EnvRef | ConstantResolver;ConstantsDescriptor (interface)
Immutable descriptor for one set of constants.
Example
const descriptor: ConstantsDescriptor = defineConstants({ region: "eu" });Signature
export interface ConstantsDescriptor<
Values extends ConstantsShape = ConstantsShape,
> extends DescriptorBase<"constants", string> {
readonly values: Values;
}ConstantsShape (type alias)
Named constant inputs for one descriptor.
Example
const values: ConstantsShape = { region: "eu-west-1" };Signature
type ConstantsShape = Readonly<Record<string, ConstantValue>>;ContextDescriptorOptions (interface)
Optional stable identity for a context descriptor.
Example
const options: ContextDescriptorOptions = { id: "support.prompt" };Signature
export interface ContextDescriptorOptions {
readonly id?: string;
}ContextResolverOptions (interface)
Inputs available to a dynamic constant resolver.
Example
const options: ContextResolverOptions = { env: {}, signal, log };Signature
export interface ContextResolverOptions {
readonly env: Readonly<Record<string, unknown>>;
readonly signal: AbortSignal;
readonly log: PublicLogger;
}PromptDescriptor (interface)
Immutable descriptor for one prompt.
Example
const descriptor: PromptDescriptor = definePrompt("Be concise.");Signature
export interface PromptDescriptor<Value extends PromptValue = PromptValue> extends DescriptorBase<
"prompt",
string
> {
readonly value: Value;
}PromptValue (type alias)
Prompt text or an ordered list of prompt fragments.
Example
const prompt: PromptValue = ["Be concise.", "Use tools."];Signature
type PromptValue = string | readonly string[];ResolvedConstants (type alias)
Resolved values inferred from a constants descriptor.
Example
type Values = ResolvedConstants<typeof constants>;Signature
type ResolvedConstants<Descriptor extends ConstantsDescriptor> = {
readonly [Key in keyof Descriptor["values"]]: ResolveConstant<Descriptor["values"][Key]>;
};ResolvedPrompt (type alias)
Resolved prompt text inferred from a prompt descriptor.
Example
type Text = ResolvedPrompt<typeof prompt>;Signature
type ResolvedPrompt<Descriptor extends PromptDescriptor> = Descriptor["value"];context-resolution-service.ts
AppConstantRunner (class)
Replaceable boundary for dynamic constant callback execution.
Example
Effect.provide(resolver.resolveEffect(context), AppConstantRunnerLive);Signature
declare class AppConstantRunnerAppConstantRunnerLive
Live runner that propagates Effect interruption into callback AbortSignals.
Example
Effect.provide(resolver.resolveEffect(context), AppConstantRunnerLive);Signature
declare const AppConstantRunnerLive: Layer.Layer<AppConstantRunner, never, never>;AppConstantRunnerPromiseLive
Compatibility runner that passes the caller’s exact signal to callbacks.
Signature
declare const AppConstantRunnerPromiseLive: Layer.Layer<AppConstantRunner, never, never>;AppConstantRunnerService
Signature
declare const AppConstantRunnerService: AppConstantRunnerService;context-resolution-service.types.ts
AppConstantRunnerService (interface)
Replaceable execution boundary for dynamic constant callbacks.
Example
const runner: AppConstantRunnerService = { run: () => Effect.succeed("eu") };Signature
export interface AppConstantRunnerService {
/** Invokes a dynamic constant resolver.
* @param resolver - User supplied constant callback.
* @param options - Environment, logger, and caller signal available to the callback.
* @returns The callback result or ContextResolutionFailure.
* @example runner.run(() => "eu", { env: {}, log });
*/
readonly run: (
resolver: ConstantResolver,
options: {
readonly env: Readonly<Record<string, unknown>>;
readonly log: PublicLogger;
readonly signal: AbortSignal;
},
) => Effect.Effect<unknown, ContextResolutionFailure>;
}context-resolver.ts
“./context-resolver.types.js” (namespace export)
Re-exports all named exports from the “./context-resolver.types.js” module.
Signature
export * from "./context-resolver.types.js";ContextResolutionFailure (class)
Expected context registration or resolution failure with its original cause.
Example
if (error._tag === "ContextResolutionFailure") console.error(error.message);Signature
declare class ContextResolutionFailurecreateApplicationContextResolver
Builds a context resolver synchronously for existing application callers.
Throws
TypeError when constant names collide.
Example
createApplicationContextResolver({ env: {} });Signature
declare const createApplicationContextResolver: (
options: ApplicationContextOptions,
) => ApplicationContextResolver;createApplicationContextResolverEffect
Builds an application context resolver in Effect.
Example
Effect.runSync(createApplicationContextResolverEffect({ env: {} }));Signature
declare const createApplicationContextResolverEffect: (
options: ApplicationContextOptions,
) => Effect.Effect<ApplicationContextResolver, ContextResolutionFailure, never>;context-resolver.types.ts
ApplicationContextOptions (interface)
Static and dynamic descriptor inputs for one context resolver.
Example
const options: ApplicationContextOptions = { env: {} };Signature
export interface ApplicationContextOptions {
readonly constants?: Readonly<Record<string, ConstantsDescriptor>>;
readonly prompts?: Readonly<Record<string, PromptDescriptor>>;
readonly env: Readonly<Record<string, unknown>>;
}ApplicationContextResolver (interface)
Resolves the current application constants and prompts.
Example
const resolver: ApplicationContextResolver = createApplicationContextResolver({ env: {} });Signature
export interface ApplicationContextResolver {
/** Resolves values in Effect with a replaceable constant runner.
* @param options - Logger and cancellation signal.
* @returns Resolved values or ContextResolutionFailure; requires AppConstantRunner.
* @example Effect.runPromise(resolver.resolveEffect(context).pipe(Effect.provide(AppConstantRunnerLive)));
*/
readonly resolveEffect: (
options: ApplicationResolveOptions,
) => Effect.Effect<ResolvedApplicationContext, ContextResolutionFailure, AppConstantRunner>;
/** Promise compatibility adapter for application handlers.
* @param options - Logger and cancellation signal.
* @returns Resolved values or a rejection with the original resolver error.
* @example await resolver.resolve({ signal, log });
*/
readonly resolve: (options: ApplicationResolveOptions) => Promise<ResolvedApplicationContext>;
}ApplicationResolveOptions (interface)
Invocation inputs required to resolve dynamic constants.
Example
const context: ApplicationResolveOptions = { signal, log };Signature
export interface ApplicationResolveOptions {
readonly signal: AbortSignal;
readonly log: PublicLogger;
}ResolvedApplicationContext (interface)
Context values produced by a resolver invocation.
Example
const constants = resolved.constants;Signature
export interface ResolvedApplicationContext {
readonly constants: Readonly<Record<string, unknown>>;
readonly prompts: Readonly<Record<string, PromptValue>>;
}define-app.ts
Constructs immutable application descriptors without acquiring providers or optional tools. Shared bridge validation rejects obsolete inspection settings; the synchronous facade preserves original validation errors for authors.
defineApp
Defines one immutable application topology synchronously.
Throws
The original validation error for invalid options.
Example
import { defineApp } from "@relkit/app";
import { defineEnv } from "@relkit/config";
const app = defineApp({ env: defineEnv({}), server: { port: 3000 } });Signature
declare const defineApp: <
const Shape extends EnvShape,
const Providers extends AppProviderInputs,
const Exporters extends TelemetryExporterMap = Readonly<
Record<string, TelemetryExporterDescriptor<string, string, object>>
>,
>(
options: DefineAppOptions<Shape, Providers, Exporters>,
) => ApplicationDescriptor<Shape, Providers, Exporters>;Since v0.2.0
“./define-app.types.js” (namespace export)
Re-exports all named exports from the “./define-app.types.js” module.
Signature
export * from "./define-app.types.js";APP_PROVIDER_CAPABILITIES
Signature
declare const APP_PROVIDER_CAPABILITIES: readonly [
"bucket",
"cache",
"job",
"event",
"model",
"realtime",
"agent-state",
];defineAppEffect
Defines one immutable application topology in Effect.
Example
Effect.runSync(defineAppEffect({ env: defineEnv({}) }));Signature
declare const defineAppEffect: <
const Shape extends EnvShape,
const Providers extends AppProviderInputs,
const Exporters extends TelemetryExporterMap = Readonly<
Record<string, TelemetryExporterDescriptor<string, string, object>>
>,
>(
options: DefineAppOptions<Shape, Providers, Exporters>,
) => Effect.Effect<ApplicationDescriptor<Shape, Providers, Exporters>, AppValidationFailure, never>;define-app.types.ts
ApiDocsConfig
Signature
declare const ApiDocsConfig: ApiDocsConfig;AppCompatibilityConfig
Signature
declare const AppCompatibilityConfig: AppCompatibilityConfig;AppDeploymentConfig (type alias)
JSON deployment metadata attached to the application descriptor.
Example
const deployment: AppDeploymentConfig = { engine: "pulumi" };Signature
type AppDeploymentConfig = Readonly<Record<string, JsonValue>>;AppProviderCapability
Signature
declare const AppProviderCapability:
"bucket" | "cache" | "job" | "event" | "model" | "realtime" | "agent-state";AppProviderDefaults
Signature
declare const AppProviderDefaults: AppProviderDefaults<Providers>;AppProviderInputs
Signature
declare const AppProviderInputs: AppProviderInputs;AppTelemetryConfig (type alias)
Application telemetry settings parameterized by exporters.
Example
const telemetry: AppTelemetryConfig = { redaction: { mode: "off" } };Signature
type AppTelemetryConfig<Exporters extends TelemetryExporterMap = TelemetryExporterMap> =
TelemetryConfiguration<Exporters>;ApplicationDescriptor (type alias)
Immutable normalized application descriptor returned by defineApp.
Example
const descriptor: ApplicationDescriptor = defineApp({ env: defineEnv({}) });Signature
type ApplicationDescriptor<
Shape extends EnvShape = EnvShape,
Providers extends AppProviderInputs = AppProviderInputs,
Exporters extends TelemetryExporterMap = TelemetryExporterMap,
> = DescriptorBase<"app", string> &
NormalizedProviders<Providers> & {
readonly env: EnvDefinition<Shape>;
readonly defaults: NormalizedAppProviderDefaults<Providers>;
readonly compatibility: { readonly legacyJobs: boolean };
readonly telemetry?: AppTelemetryConfig<Exporters>;
readonly server?: ServerConfig;
readonly inspector?: InspectorConfig;
readonly deployment?: AppDeploymentConfig;
};DefineAppOptions (type alias)
Authored application topology and runtime settings.
Example
const options: DefineAppOptions<{}, {}> = { env: defineEnv({}) };Signature
type DefineAppOptions<
Shape extends EnvShape,
Providers extends AppProviderInputs,
Exporters extends TelemetryExporterMap = TelemetryExporterMap,
> = DescriptorMetadata &
Providers & {
readonly id?: string;
readonly env: EnvDefinition<Shape>;
readonly defaults?: AppProviderDefaults<Providers>;
readonly compatibility?: AppCompatibilityConfig;
readonly telemetry?: AppTelemetryConfig<Exporters>;
readonly server?: ServerConfig;
readonly inspector?: InspectorConfig;
readonly deployment?: AppDeploymentConfig;
};InspectorConfig
Signature
declare const InspectorConfig: InspectorConfig;NormalizedAppProviderDefaults
Signature
declare const NormalizedAppProviderDefaults: Readonly<{
bucket?: ProfileFor<Providers, "bucket">;
cache?: ProfileFor<Providers, "cache">;
job?: ProfileFor<Providers, "job">;
event?: ProfileFor<Providers, "event">;
model?: ProfileFor<Providers, "model">;
realtime?: ProfileFor<Providers, "realtime">;
"agent-state"?: ProfileFor<Providers, "agent-state">;
}>;ServerConfig
Signature
declare const ServerConfig: ServerConfig;events.ts
“@relkit/events” (namespace export)
Re-exports all named exports from the “@relkit/events” module.
Signature
export * from "@relkit/events";functions.ts
“@relkit/functions” (namespace export)
Re-exports all named exports from the “@relkit/functions” module.
Signature
export * from "@relkit/functions";index.ts
“./config.js” (namespace export)
Re-exports all named exports from the “./config.js” module.
Signature
export * from "./config.js";“./context-descriptors.js” (namespace export)
Re-exports all named exports from the “./context-descriptors.js” module.
Signature
export * from "./context-descriptors.js";“./context-resolver.js” (namespace export)
Re-exports all named exports from the “./context-resolver.js” module.
Signature
export * from "./context-resolver.js";“./tasks.js” (namespace export)
Re-exports all named exports from the “./tasks.js” module.
Signature
export * from "./tasks.js";“@relkit/agents” (namespace export)
Re-exports all named exports from the “@relkit/agents” module.
Signature
export * from "@relkit/agents";“@relkit/buckets” (namespace export)
Re-exports all named exports from the “@relkit/buckets” module.
Signature
export * from "@relkit/buckets";“@relkit/cache” (namespace export)
Re-exports all named exports from the “@relkit/cache” module.
Signature
export * from "@relkit/cache";“@relkit/events” (namespace export)
Re-exports all named exports from the “@relkit/events” module.
Signature
export * from "@relkit/events";“@relkit/functions” (namespace export)
Re-exports all named exports from the “@relkit/functions” module.
Signature
export * from "@relkit/functions";“@relkit/jobs” (namespace export)
Re-exports all named exports from the “@relkit/jobs” module.
Signature
export * from "@relkit/jobs";“@relkit/realtime” (namespace export)
Re-exports all named exports from the “@relkit/realtime” module.
Signature
export * from "@relkit/realtime";“@relkit/routes” (namespace export)
Re-exports all named exports from the “@relkit/routes” module.
Signature
export * from "@relkit/routes";“@relkit/services” (namespace export)
Re-exports all named exports from the “@relkit/services” module.
Signature
export * from "@relkit/services";“@relkit/tools” (namespace export)
Re-exports all named exports from the “@relkit/tools” module.
Signature
export * from "@relkit/tools";AppConstantRunner
Signature
declare const AppConstantRunner: typeof AppConstantRunner;AppConstantRunnerLive
Signature
declare const AppConstantRunnerLive: Layer<AppConstantRunner, never, never>;EventAttributeValue
Signature
declare const EventAttributeValue: EventAttributeValue;EventPublishOptions
Signature
declare const EventPublishOptions: EventPublishOptions;EventPublishResult
Signature
declare const EventPublishResult: EventPublishResult<Id, Version, Payload>;TaskClientFor
Signature
declare const TaskClientFor: TaskClientFor<T>;TaskClients
Signature
declare const TaskClients: TaskClients<M>;TaskTriggerOptions
Signature
declare const TaskTriggerOptions: TaskTriggerOptions<Task>;bindDescriptorIdentity
Signature
declare const bindDescriptorIdentity: <T extends object>(descriptor: T, id: string) => T;internal-runtime.ts
Exposes the framework-owned descriptor identity and application context wiring needed by emitted hosts, including selected dependency preflight. Re-exports preserve identity while resolving framework dependencies from their owning app.
SelectedDependenciesLive
Signature
declare const SelectedDependenciesLive: Layer<SelectedDependencies, never, never>;bindDescriptorIdentity
Signature
declare const bindDescriptorIdentity: <T extends object>(descriptor: T, id: string) => T;checkIntegrationDependencies
Signature
declare const checkIntegrationDependencies: (
plan: RuntimeIntegrationPlan,
options: {
readonly projectRoot: string;
readonly phase: IntegrationDependencyPhase;
readonly manager?: DependencyPackageManager;
},
) => Effect<
import("@relkit/provider/internal/dependencies").InstalledPackageIdentity[][],
| import("@relkit/provider/internal/dependencies").DependencyResolutionFailure
| import("@relkit/provider/internal/dependencies").SelectedDependencyFailure,
SelectedDependencies
>;createApplicationContextResolver
Signature
declare const createApplicationContextResolver: (
options: ApplicationContextOptions,
) => ApplicationContextResolver;initializeIntegration
Signature
declare const initializeIntegration: <Module>(
packageName: string,
load: () => Promise<Module>,
) => Effect<Module, SelectedDependencyInitializationFailure, never>;jobs-legacy.ts
“@relkit/jobs/legacy” (namespace export)
Re-exports all named exports from the “@relkit/jobs/legacy” module.
Signature
export * from "@relkit/jobs/legacy";jobs.ts
“@relkit/jobs” (namespace export)
Re-exports all named exports from the “@relkit/jobs” module.
Signature
export * from "@relkit/jobs";RunStatus
Signature
declare const RunStatus: JobRunStatus;realtime.ts
“@relkit/realtime” (namespace export)
Re-exports all named exports from the “@relkit/realtime” module.
Signature
export * from "@relkit/realtime";routes.ts
“@relkit/routes” (namespace export)
Re-exports all named exports from the “@relkit/routes” module.
Signature
export * from "@relkit/routes";schema.ts
“@relkit/schema” (namespace export)
Re-exports all named exports from the “@relkit/schema” module.
Signature
export * from "@relkit/schema";services.ts
“@relkit/services” (namespace export)
Re-exports all named exports from the “@relkit/services” module.
Signature
export * from "@relkit/services";tasks.ts
DefineTaskOptions
Signature
declare const DefineTaskOptions: DefineTaskOptions<
Id,
Version,
InputSchema,
OutputSchema,
Dependencies,
Errors,
Publishes,
ProgressSchema,
Streams,
Execution
>;JobDescriptorForThisTask
Signature
declare const JobDescriptorForThisTask: JobDescriptorForThisTask<Task>;NormalizedTaskRetryPolicy
Signature
declare const NormalizedTaskRetryPolicy: NormalizedTaskRetryPolicy;RunResultOptions
Signature
declare const RunResultOptions: RunResultOptions;ServerTriggerOptions
Signature
declare const ServerTriggerOptions: ServerTriggerOptions;TaskAuthContext
Signature
declare const TaskAuthContext: TaskAuthContext<Session>;TaskCallerInput
Signature
declare const TaskCallerInput: TaskCallerInput<T>;TaskCanonicalInput
Signature
declare const TaskCanonicalInput: TaskCanonicalInput<T>;TaskConcurrency
Signature
declare const TaskConcurrency: TaskConcurrency<InputKey>;TaskContext
Signature
declare const TaskContext: TaskContext<Execution, Dependencies, ProgressSchema, Streams, Publishes>;TaskContextBase
Signature
declare const TaskContextBase: TaskContextBase<Dependencies, Publishes>;TaskDependencies
Signature
declare const TaskDependencies: TaskDependencies;TaskDescriptor
Signature
declare const TaskDescriptor: TaskDescriptor<
Id,
Version,
InputSchema,
OutputSchema,
Dependencies,
Errors,
Publishes,
ProgressSchema,
Streams,
Execution
>;TaskDescriptorAny
Signature
declare const TaskDescriptorAny: TaskDescriptorAny;TaskExecution
Signature
declare const TaskExecution: TaskExecution;TaskFailureHook
Signature
declare const TaskFailureHook: TaskFailureHook<Dependencies, Publishes>;TaskHandler
Signature
declare const TaskHandler: TaskHandler<
InputSchema,
OutputSchema,
Execution,
Dependencies,
Errors,
ProgressSchema,
Streams,
Publishes
>;TaskHandlerResult
Signature
declare const TaskHandlerResult: TaskHandlerResult<Output, Errors>;TaskHookContext
Signature
declare const TaskHookContext: TaskHookContext<Dependencies, Publishes>;TaskInput
Signature
declare const TaskInput: TaskInput<T>;TaskLogging
Signature
declare const TaskLogging: TaskLogging;TaskOutput
Signature
declare const TaskOutput: TaskOutput<T>;TaskProgressEmitter
Signature
declare const TaskProgressEmitter: TaskProgressEmitter<Value>;TaskProgressInput
Signature
declare const TaskProgressInput: TaskProgressInput<Schema>;TaskProgressOutput
Signature
declare const TaskProgressOutput: TaskProgressOutput<Schema>;TaskRawHandlerOutput
Signature
declare const TaskRawHandlerOutput: TaskRawHandlerOutput<T>;TaskResources
Signature
declare const TaskResources: TaskResources;TaskRetryPolicy
Signature
declare const TaskRetryPolicy: TaskRetryPolicy;TaskRunContext
Signature
declare const TaskRunContext: TaskRunContext;TaskSleepOptions
Signature
declare const TaskSleepOptions: TaskSleepOptions;TaskStartHook
Signature
declare const TaskStartHook: TaskStartHook<InputSchema, Dependencies, Publishes>;TaskStreamEmitter
Signature
declare const TaskStreamEmitter: TaskStreamEmitter<Value>;TaskStreamEmitters
Signature
declare const TaskStreamEmitters: TaskStreamEmitters<Streams>;TaskStreamFrames
Signature
declare const TaskStreamFrames: TaskStreamFrames<Streams>;TaskStreamInput
Signature
declare const TaskStreamInput: TaskStreamInput<Schema>;TaskStreamItem
Signature
declare const TaskStreamItem: TaskStreamItem<Schema>;TaskStreamOutput
Signature
declare const TaskStreamOutput: TaskStreamOutput<Schema>;TaskStreamSchemas
Signature
declare const TaskStreamSchemas: Readonly<Record<string, StandardSchemaV1<unknown, unknown>>>;TaskSuccessHook
Signature
declare const TaskSuccessHook: TaskSuccessHook<OutputSchema, Dependencies, Publishes>;TaskTriggerOptions
Signature
declare const TaskTriggerOptions: TaskTriggerOptions<Task>;TaskValidatedOutput
Signature
declare const TaskValidatedOutput: TaskValidatedOutput<T>;TriggerOptions
Signature
declare const TriggerOptions: TriggerOptions;assertTaskDescriptor
Signature
declare const assertTaskDescriptor: (value: unknown) => asserts value is TaskDescriptorAny;defineTask
Signature
declare const defineTask: <
const Id extends string,
const Version extends string,
const InputSchema extends StandardSchemaV1,
const OutputSchema extends StandardSchemaV1,
const Dependencies extends TaskDependencies = {},
const Errors extends readonly ErrorDescriptorAny[] = readonly [],
const Publishes extends readonly PublishedEventName[] = readonly [],
const ProgressSchema extends StandardSchemaV1 | undefined = undefined,
const Streams extends TaskStreamSchemas = {},
const Execution extends TaskExecution = "durable",
>(
options: DefineTaskOptions<
Id,
Version,
InputSchema,
OutputSchema,
Dependencies,
Errors,
Publishes,
ProgressSchema,
Streams,
Execution
>,
) => TaskDescriptor<
Id,
Version,
InputSchema,
OutputSchema,
Dependencies,
Errors,
Publishes,
ProgressSchema,
Streams,
Execution
>;isTaskDescriptor
Signature
declare const isTaskDescriptor: (value: unknown) => value is TaskDescriptorAny;tools.ts
“@relkit/tools” (namespace export)
Re-exports all named exports from the “@relkit/tools” module.
Signature
export * from "@relkit/tools";agent-content.ts
Browser-safe message snapshot shown for one agent run.
AgentProgressScope (type alias)
Identifies whether progress belongs to a run or a particular tool call.
Signature
type AgentProgressScope =
| { readonly scope: "run"; readonly toolCallId?: never; readonly toolId?: never }
| { readonly scope: "tool"; readonly toolCallId: string; readonly toolId: string };BrowserMessage (interface)
Browser-safe message snapshot shown for one agent run.
Signature
export interface BrowserMessage {
readonly messageId: string;
readonly runId?: string;
readonly role: "user" | "assistant" | "tool";
readonly parts: readonly BrowserMessagePart[];
readonly createdAt: string;
}BrowserMessagePart (type alias)
Text, tool, or progress content carried by a browser message.
Signature
type BrowserMessagePart =
| {
readonly partId: string;
readonly kind: "text";
readonly text: string;
readonly state?: "streaming" | "complete";
}
| {
readonly partId: string;
readonly kind: "tool";
readonly toolCallId: string;
readonly toolId: string;
readonly state: ToolPartState;
readonly inputText?: string;
readonly input?: unknown;
readonly output?: unknown;
readonly value?: unknown;
}
| ({
readonly partId: string;
readonly kind: "progress";
readonly value: unknown;
} & AgentProgressScope);ToolPartState (type alias)
Lifecycle state of a tool part in a streamed browser message.
Signature
type ToolPartState =
| "started"
| "input-streaming"
| "input-ready"
| "approval-required"
| "running"
| "succeeded"
| "failed"
| "denied";agent-events.ts
AgentClientEvent (type alias)
All event variants understood by an agent client.
Signature
type AgentClientEvent =
| (AgentClientEventBase & { readonly kind: "message-updated"; readonly message: BrowserMessage })
| AgentProgressEvent
| AgentToolEvent
| (AgentClientEventBase & {
readonly kind: "execution-event";
readonly value: AgentExecutionEvent;
})
| (AgentClientEventBase & {
readonly kind: "approval" | "control" | "run-finished" | "run-interrupted";
readonly value: unknown;
});AgentObservation (type alias)
Event, current snapshot, or continuity gap returned by observation.
Signature
type AgentObservation =
| { readonly kind: "event"; readonly event: AgentClientEvent }
| { readonly kind: "snapshot"; readonly snapshot: ThreadSnapshot }
| {
readonly kind: "gap";
readonly reason: "expired" | "foreign" | "future" | "session" | "provider-reset";
readonly snapshot: ThreadSnapshot;
};AgentProgressEvent (type alias)
Progress event scoped to a run or tool invocation.
Signature
type AgentProgressEvent = AgentClientEventBase & {
readonly kind: "progress";
readonly progressId: string;
readonly messageId?: string;
readonly value: unknown;
} & AgentProgressScope;AgentToolEvent (type alias)
Tool lifecycle event delivered to an agent client.
Signature
type AgentToolEvent = AgentClientEventBase & {
readonly messageId: string;
readonly partId: string;
readonly toolCallId: string;
readonly toolId: string;
} & (
| { readonly kind: "tool-started" }
| { readonly kind: "tool-input"; readonly input: string }
| { readonly kind: "tool-input-ready"; readonly input: unknown }
| { readonly kind: "tool-approval-required" }
| { readonly kind: "tool-executing" }
| { readonly kind: "tool-succeeded"; readonly output: unknown }
| { readonly kind: "tool-failed" }
| { readonly kind: "tool-denied" }
);agent-execution.ts
One ordered native execution event within an agent run.
AgentExecutionEvent (interface)
One ordered native execution event within an agent run.
Signature
export interface AgentExecutionEvent {
readonly nativeSequence: number;
readonly kind: string;
readonly scope: readonly string[];
readonly occurredAt: string;
readonly agent?: string;
readonly parent?: {
readonly kind: "tool";
readonly toolCallId: string;
readonly toolId: string;
};
readonly node?: string;
readonly value?: unknown;
}AgentExecutionSnapshot (interface)
Latest public state of a native execution scope.
Signature
export interface AgentExecutionSnapshot {
readonly scope: readonly string[];
readonly agent?: string;
readonly parent?: AgentExecutionEvent["parent"];
readonly node?: string;
readonly values?: unknown;
readonly status: "running" | "waiting" | "succeeded" | "failed" | "cancelled";
readonly lastEventSequence: number;
}agent-state-control-requests.types.ts
Defines scoped control claims, settlement, and continuation admission requests.
AcceptControlRequest (interface)
Signature
export interface AcceptControlRequest extends AgentRequestScope {
readonly operationId: OperationId;
readonly semanticDigest: string;
readonly threadId: string;
readonly runId: string;
readonly kind: "steer" | "follow-up" | "stop" | "approve";
readonly publicPayload: unknown;
readonly acceptedAt: string;
readonly receiptExpiresAt: string;
readonly limits: ControlLimits;
}AdmitContinuationRequest (type alias)
Signature
type AdmitContinuationRequest = ContinuationAdmission &
(
| {
readonly kind: "approval";
readonly decisions: Readonly<Record<string, "approve" | "deny">>;
}
| { readonly kind: "resume"; readonly waitingRevision: string }
);ClaimControlRequest (interface)
Signature
export interface ClaimControlRequest extends AgentRequestScope {
readonly threadId: string;
readonly runId: string;
readonly operationId: OperationId;
readonly workerId: string;
readonly generationId: string;
readonly expiresAt: string;
}ContinuationIdentity (interface)
Signature
export interface ContinuationIdentity {
readonly threadId: string;
readonly interruptedRunId: string;
readonly interruptSetDigest: string;
}ControlLimits (interface)
Signature
export interface ControlLimits {
readonly maxQueuedPerRun: number;
readonly maxQueuedPerApplication: number;
}ControlPage (interface)
Signature
export interface ControlPage {
readonly operationIds: readonly OperationId[];
readonly nextSequence: string;
readonly hasMore: boolean;
}LookupContinuationReceiptRequest (interface)
Signature
export interface LookupContinuationReceiptRequest extends AgentRequestScope {
readonly operationId: OperationId;
readonly threadId: string;
readonly interruptedRunId?: string;
readonly interruptSetDigest?: string;
readonly semanticDigest: string;
readonly now: string;
}LookupControlReceiptRequest (interface)
Signature
export interface LookupControlReceiptRequest extends AgentRequestScope {
readonly operationId: OperationId;
readonly threadId: string;
readonly runId: string;
readonly semanticDigest: string;
readonly now: string;
}MarkControlEffectStartedRequest (interface)
Signature
export interface MarkControlEffectStartedRequest extends AgentRequestScope {
readonly threadId: string;
readonly runId: string;
readonly claim: ControlClaim;
readonly operationId: OperationId;
readonly downstreamOperationId?: OperationId;
}ReadControlsRequest (interface)
Signature
export interface ReadControlsRequest extends AgentRequestScope {
readonly threadId: string;
readonly runId: string;
readonly afterSequence?: string;
readonly limit: number;
}RecoverAbandonedControlRequest (interface)
Signature
export interface RecoverAbandonedControlRequest extends AgentRequestScope {
readonly threadId: string;
readonly runId: string;
readonly operationId: OperationId;
readonly expectedClaimId: string;
readonly expectedFence: number;
readonly recoveredAt: string;
}RenewControlClaimRequest (interface)
Signature
export interface RenewControlClaimRequest extends AgentRequestScope {
readonly threadId: string;
readonly runId: string;
readonly claim: ControlClaim;
readonly expiresAt: string;
}SettleControlRequest (interface)
Signature
export interface SettleControlRequest extends AgentRequestScope {
readonly threadId: string;
readonly runId: string;
readonly claim: ControlClaim;
readonly operationId: OperationId;
readonly status: "applied" | "rejected" | "cancelled";
readonly effect: "not-started" | "confirmed" | "unknown";
readonly downstreamOperationId?: OperationId;
readonly settledAt: string;
}WaitForControlsRequest (interface)
Signature
export interface WaitForControlsRequest extends AgentRequestScope {
readonly threadId: string;
readonly runId: string;
readonly afterSequence: string;
readonly deadlineMs: number;
readonly signal: AbortSignal;
}agent-state-provider.types.ts
Defines the SDK-independent durable thread, journal, control, and continuation provider port.
AgentStateProvider (interface)
Signature
export interface AgentStateProvider {
getEpoch(): Promise<string>;
createThread(request: CreateThreadRequest): Promise<CreateThreadReceipt>;
listThreads(request: ListThreadsRequest): Promise<ThreadList>;
loadThread(request: LoadThreadRequest): Promise<ThreadSnapshot>;
readSnapshotHistory(request: ReadSnapshotHistoryRequest): Promise<SnapshotHistoryPage>;
acceptRun(request: AcceptRunRequest): Promise<AcceptRunReceipt>;
lookupRunReceipt(request: LookupRunReceiptRequest): Promise<RunReceiptLookup>;
readJournal(request: ReadJournalRequest): Promise<JournalPage>;
waitForJournal(request: WaitForJournalRequest): Promise<void>;
claimRun(request: ClaimRunRequest): Promise<ExecutionClaim>;
renewRunClaim(request: RenewRunClaimRequest): Promise<ExecutionClaim>;
appendJournal(request: AppendJournalRequest): Promise<JournalReceipt>;
completeRun(request: CompleteRunRequest): Promise<CompletionReceipt>;
suspendRun(request: SuspendRunRequest): Promise<SuspensionReceipt>;
interruptOwnedRun(request: InterruptOwnedRunRequest): Promise<InterruptionReceipt>;
acceptControl(request: AcceptControlRequest): Promise<ControlReceipt>;
lookupControlReceipt(request: LookupControlReceiptRequest): Promise<ControlReceiptLookup>;
readControls(request: ReadControlsRequest): Promise<ControlPage>;
waitForControls(request: WaitForControlsRequest): Promise<void>;
claimControl(request: ClaimControlRequest): Promise<ControlClaim>;
renewControlClaim(request: RenewControlClaimRequest): Promise<ControlClaim>;
markControlEffectStarted(request: MarkControlEffectStartedRequest): Promise<ControlReceipt>;
settleControl(request: SettleControlRequest): Promise<ControlReceipt>;
recoverAbandonedControl(request: RecoverAbandonedControlRequest): Promise<ControlReceipt>;
admitContinuation(request: AdmitContinuationRequest): Promise<ContinuationReceipt>;
lookupContinuationReceipt(
request: LookupContinuationReceiptRequest,
): Promise<ContinuationReceiptLookup>;
}agent-state-receipts.types.ts
Defines durable thread, run, journal, control, and continuation operation receipts.
AcceptRunReceipt (interface)
Signature
export interface AcceptRunReceipt {
readonly operationId: OperationId;
readonly threadId: string;
readonly runId: string;
readonly status: "accepted";
readonly duplicate: boolean;
}CompletionReceipt (interface)
Signature
export interface CompletionReceipt {
readonly operationId: OperationId;
readonly threadId: string;
readonly runId: string;
readonly status: Extract<RunStatus, "succeeded" | "failed" | "cancelled">;
readonly checkpoint: JournalCheckpoint;
readonly duplicate: boolean;
}ContinuationReceipt (interface)
Signature
export interface ContinuationReceipt {
readonly operationId: OperationId;
readonly threadId: string;
readonly interruptedRunId: string;
readonly runId: string;
readonly interruptSetDigest: string;
readonly waitingRevision?: string;
readonly duplicate: boolean;
}ContinuationReceiptLookup (type alias)
Signature
type ContinuationReceiptLookup = ReceiptLookup<ContinuationReceipt>;ControlReceipt (interface)
Signature
export interface ControlReceipt {
readonly operationId: OperationId;
readonly threadId: string;
readonly runId: string;
readonly status: ControlStatus;
readonly effect: ControlEffectOutcome;
readonly duplicate: boolean;
}ControlReceiptLookup (type alias)
Signature
type ControlReceiptLookup = ReceiptLookup<ControlReceipt>;CreateThreadReceipt (interface)
Signature
export interface CreateThreadReceipt {
readonly threadId: string;
readonly ownerScope: string;
readonly createdAt: string;
}InterruptionReceipt (interface)
Signature
export interface InterruptionReceipt {
readonly threadId: string;
readonly runId: string;
readonly status: "worker-interrupted";
readonly checkpoint: JournalCheckpoint;
readonly changed: boolean;
}JournalReceipt (interface)
Signature
export interface JournalReceipt {
readonly recordId: string;
readonly checkpoint: JournalCheckpoint;
readonly duplicate: boolean;
}RunReceiptLookup (type alias)
Signature
type RunReceiptLookup = ReceiptLookup<AcceptRunReceipt | CompletionReceipt>;SuspensionReceipt (interface)
Signature
export interface SuspensionReceipt {
readonly threadId: string;
readonly runId: string;
readonly status: "waiting";
readonly checkpoint: JournalCheckpoint;
readonly waiting: AgentWaitingState;
}agent-state-thread-requests.types.ts
Defines bounded thread, history, journal, and execution-claim requests for state providers.
AcceptRunRequest (interface)
Signature
export interface AcceptRunRequest extends AgentRequestScope {
readonly operationId: OperationId;
readonly semanticDigest: string;
readonly threadId: string;
readonly owner: RunOwner;
readonly input: unknown;
readonly inputDigest: string;
readonly acceptedAt: string;
readonly receiptExpiresAt: string;
readonly limits: AgentStateLimits;
}AgentStateLimits (interface)
Signature
export interface AgentStateLimits {
readonly maxSnapshotBytes: number;
readonly maxHistoryPageBytes: number;
readonly maxJournalRecordBytes: number;
readonly maxJournalBytesPerThread: number;
readonly maxStateBytesPerApplication: number;
readonly maxThreadsPerPrincipal: number;
readonly maxActiveRunsPerPrincipal: number;
readonly maxActiveRunsPerApplication: number;
readonly terminalReserveBytes: number;
readonly terminalReserveRecords: number;
}AppendJournalRequest (interface)
Signature
export interface AppendJournalRequest extends AgentRequestScope {
readonly threadId: string;
readonly runId: string;
readonly claim: ExecutionClaim;
readonly operationId: OperationId;
readonly semanticDigest: string;
readonly record: Omit<JournalRecord, "checkpoint">;
readonly limits: AgentStateLimits;
}ClaimRunRequest (interface)
Signature
export interface ClaimRunRequest extends AgentRequestScope {
readonly threadId: string;
readonly runId: string;
readonly workerId: string;
readonly generationId: string;
readonly expiresAt: string;
}CompleteRunRequest (interface)
Signature
export interface CompleteRunRequest extends AgentRequestScope {
readonly operationId: OperationId;
readonly semanticDigest: string;
readonly threadId: string;
readonly runId: string;
readonly claim: ExecutionClaim;
readonly outcome: "succeeded" | "failed" | "cancelled";
readonly terminalRecord: Omit<JournalRecord, "checkpoint">;
readonly settledAt: string;
readonly receiptExpiresAt: string;
}CreateThreadRequest (interface)
Signature
export interface CreateThreadRequest extends AgentRequestScope {
readonly operationId: OperationId;
readonly threadId: string;
readonly semanticDigest: string;
readonly now: string;
readonly limits: AgentStateLimits;
}InterruptOwnedRunRequest (interface)
Signature
export interface InterruptOwnedRunRequest extends AgentRequestScope {
readonly operationId: OperationId;
readonly threadId: string;
readonly runId: string;
readonly expectedOwner: RunOwner;
readonly expectedClaimId: string;
readonly expectedFence: number;
readonly reason: "claim-expired" | "generation-unavailable" | "process-lost";
readonly interruptedAt: string;
}JournalPage (interface)
Signature
export interface JournalPage {
readonly records: readonly JournalRecord[];
readonly checkpoint: JournalCheckpoint;
readonly hasMore: boolean;
readonly gap?: "expired" | "foreign" | "future" | "session" | "provider-reset";
}ListThreadsRequest (interface)
Signature
export interface ListThreadsRequest extends AgentRequestScope {
readonly limit: number;
}LoadThreadRequest (interface)
Signature
export interface LoadThreadRequest extends AgentRequestScope {
readonly threadId: string;
readonly maxEncodedBytes: number;
}LookupRunReceiptRequest (interface)
Signature
export interface LookupRunReceiptRequest extends AgentRequestScope {
readonly operationId: OperationId;
readonly threadId?: string;
readonly runId?: string;
readonly semanticDigest: string;
readonly now: string;
}ReadJournalRequest (interface)
Signature
export interface ReadJournalRequest extends AgentRequestScope {
readonly threadId: string;
readonly after: JournalCheckpoint;
readonly limit: number;
readonly maxEncodedBytes: number;
}ReadSnapshotHistoryRequest (interface)
Signature
export interface ReadSnapshotHistoryRequest extends AgentRequestScope {
readonly threadId: string;
readonly snapshotId: string;
readonly cursor: string;
readonly maxEncodedBytes: number;
}RenewRunClaimRequest (interface)
Signature
export interface RenewRunClaimRequest extends AgentRequestScope {
readonly threadId: string;
readonly runId: string;
readonly claim: ExecutionClaim;
readonly expiresAt: string;
}SnapshotHistoryPage (interface)
Signature
export interface SnapshotHistoryPage {
readonly messages: readonly BrowserMessage[];
readonly nextCursor?: string;
}SuspendRunRequest (interface)
Signature
export interface SuspendRunRequest extends AgentRequestScope {
readonly operationId: OperationId;
readonly threadId: string;
readonly runId: string;
readonly claim: ExecutionClaim;
readonly waiting: Omit<AgentWaitingState, "revision">;
readonly suspendedAt: string;
}ThreadList (interface)
Signature
export interface ThreadList {
readonly threads: readonly ThreadListItem[];
}WaitForJournalRequest (interface)
Signature
export interface WaitForJournalRequest extends AgentRequestScope {
readonly threadId: string;
readonly after: JournalCheckpoint;
readonly deadlineMs: number;
readonly signal: AbortSignal;
}agent-state.ts
AgentRequestScope (interface)
Authorization and provider scope carried by an agent request.
Signature
export interface AgentRequestScope extends ExpectedClientIdentity {
readonly applicationId: string;
readonly environment: string;
readonly profile: string;
readonly providerEpoch: string;
readonly agentId: string;
readonly ownerScope: string;
readonly authorizationGrantId: string;
}AgentRunCompatibility (interface)
Compatibility level available when replaying a run.
Signature
export interface AgentRunCompatibility {
readonly runtime: "native" | "ai-sdk";
readonly access: "read-write" | "read-only";
readonly resumableCheckpoint: boolean;
readonly protocolVersion?: number;
readonly schemaVersion?: number;
}AgentWaitingRequest (interface)
Input and expected response for a paused execution node.
Signature
export interface AgentWaitingRequest {
readonly node: string;
readonly value?: unknown;
readonly response: JsonValue;
}AgentWaitingState (interface)
Durable collection of requests awaiting external responses.
Signature
export interface AgentWaitingState {
readonly revision: string;
readonly runId: string;
readonly response: JsonValue;
readonly requests: readonly AgentWaitingRequest[];
}ControlClaim (interface)
Fenced worker lease for applying one control request.
Signature
export interface ControlClaim {
readonly claimId: string;
readonly controlId: OperationId;
readonly workerId: string;
readonly generationId: string;
readonly fence: number;
readonly expiresAt: string;
}ControlEffectOutcome (type alias)
Whether a control’s external effect is known to have occurred.
Signature
type ControlEffectOutcome = "not-started" | "confirmed" | "unknown";ControlRecord (interface)
Durable idempotent control request and its application outcome.
Signature
export interface ControlRecord {
readonly controlId: OperationId;
readonly runId: string;
readonly kind: "steer" | "follow-up" | "stop" | "approve";
readonly semanticDigest: string;
readonly publicPayload?: unknown;
readonly status: ControlStatus;
readonly effect: ControlEffectOutcome;
readonly acceptedAt: string;
readonly settledAt?: string;
}ControlStatus (type alias)
Persistence lifecycle of a control request.
Signature
type ControlStatus = "accepted" | "processing" | "applied" | "rejected" | "cancelled";ExecutionClaim (interface)
Fenced worker lease for executing one run.
Signature
export interface ExecutionClaim {
readonly claimId: string;
readonly runId: string;
readonly workerId: string;
readonly generationId: string;
readonly fence: number;
readonly expiresAt: string;
}JournalCheckpoint (interface)
Provider-scoped cursor for replaying the agent journal.
Signature
export interface JournalCheckpoint {
readonly applicationId: string;
readonly environment: string;
readonly profile: string;
readonly providerEpoch: string;
readonly threadId: string;
readonly sequence: string;
}JournalRecord (interface)
One encoded public record in the agent journal.
Signature
export interface JournalRecord {
readonly recordId: string;
readonly runId: string;
readonly kind:
"message" | "progress" | "approval" | "control" | "terminal" | "interruption" | "event";
readonly publicValue: unknown;
readonly checkpoint: JournalCheckpoint;
readonly encodedBytes: number;
readonly createdAt: string;
}RunOwner (interface)
Runtime generation and provider scope that own a run.
Signature
export interface RunOwner {
readonly generationId: string;
readonly publicFingerprint: string;
readonly protocolVersion: number;
readonly schemaVersion: number;
readonly providerScope: string;
}RunStatus (type alias)
Persisted lifecycle state of an agent run.
Signature
type RunStatus =
| "accepted"
| "running"
| "waiting"
| "approval-interrupted"
| "stopping"
| "succeeded"
| "failed"
| "cancelled"
| "worker-interrupted";StoredApproval (interface)
Durable approval decision associated with a run interruption.
Signature
export interface StoredApproval {
readonly approvalId: string;
readonly runId: string;
readonly interruptSetDigest: string;
readonly interruptSetSize?: number;
readonly status: "open" | "approved" | "denied" | "cancelled";
readonly publicRequest: unknown;
}StoredRun (interface)
Durable run state and idempotent submission identity.
Signature
export interface StoredRun extends StoredRunRouting {
readonly operationId: OperationId;
readonly status: RunStatus;
readonly inputDigest: string;
readonly acceptedAt: string;
readonly settledAt?: string;
readonly outcome?: "succeeded" | "failed" | "cancelled" | "worker-interrupted";
}StoredRunRouting (interface)
Minimal routing data needed to locate a stored run.
Signature
export interface StoredRunRouting {
readonly runId: string;
readonly threadId: string;
readonly owner: RunOwner;
}StoredThread (interface)
Durable thread metadata stored by the state provider.
Signature
export interface StoredThread {
readonly threadId: string;
readonly agentId: string;
readonly ownerScope: string;
readonly status: ThreadStatus;
readonly revision: string;
readonly createdAt: string;
readonly updatedAt: string;
}ThreadListItem (interface)
Thread metadata enriched with a client-facing preview.
Signature
export interface ThreadListItem extends StoredThread {
readonly preview?: string;
}ThreadSnapshot (interface)
Public thread view rebuilt from current state and journal data.
Signature
export interface ThreadSnapshot {
readonly snapshotId: string;
readonly thread: StoredThread;
readonly activeRun: StoredRunRouting | undefined;
readonly currentRuns: readonly StoredRun[];
readonly currentMessages: readonly BrowserMessage[];
readonly values?: unknown;
readonly output?: unknown;
readonly executions: readonly AgentExecutionSnapshot[];
readonly approvals: readonly StoredApproval[];
readonly controls: readonly ControlRecord[];
readonly waiting?: AgentWaitingState;
readonly checkpoint: JournalCheckpoint;
readonly providerEpoch: string;
readonly hasOlderHistory: boolean;
readonly olderHistoryCursor?: string;
readonly compatibility?: AgentRunCompatibility;
}ThreadStatus (type alias)
Current scheduling state of an agent thread.
Signature
type ThreadStatus =
"idle" | "running" | "waiting" | "approval-interrupted" | "stopping" | "worker-interrupted";agent-thread-transition.types.ts
Defines agent-thread actions, accepted transitions, and stable rejection codes.
AgentTransitionError (type alias)
Stable rejection codes returned for invalid thread actions.
Signature
type AgentTransitionError =
| "AGENT_BUSY"
| "AGENT_APPROVAL_REQUIRED"
| "AGENT_STOPPING"
| "AGENT_WORKER_INTERRUPTED"
| "AGENT_INVALID_CONTROL";ThreadAction (type alias)
Actions that a caller may request for an agent thread.
Signature
type ThreadAction = "send" | "steer" | "follow-up" | "stop" | "approve" | "deny";ThreadTransition (type alias)
The accepted next state or the reason the current state cannot advance.
Signature
type ThreadTransition =
| { readonly accepted: true; readonly nextStatus: ThreadStatus; readonly idempotent: boolean }
| {
readonly accepted: false;
readonly status: ThreadStatus;
readonly code: AgentTransitionError;
};jobs-access.ts
JobAccessGrant (interface)
Scope and optional expiry returned by the access provider.
Signature
export interface JobAccessGrant {
readonly scope: string;
readonly expiresAt?: string;
}JobAccessRequest (interface)
Resource and optional input presented for job authorization.
Signature
export interface JobAccessRequest {
readonly operation: JobClientOperation;
readonly jobId: string;
readonly runId?: string;
readonly stream?: string;
readonly input?: JsonValue;
}JobClientOperation (type alias)
Client action requiring a job access grant.
Signature
type JobClientOperation = "trigger" | "get" | "list" | "watch" | "cancel" | "retry" | "stream";JobUnknownOutcome (interface)
Recoverable uncertainty after a job submission or control request.
Signature
export interface JobUnknownOutcome {
readonly code: "RELKIT_JOB_SUBMISSION_UNKNOWN" | "RELKIT_JOB_CONTROL_UNKNOWN";
readonly outcome: "unknown";
readonly operationId: string;
readonly idempotencyKey?: string;
readonly recovery: {
readonly action: "retry-with-same-key" | "inspect-native" | "unavailable";
readonly expiresAt?: string;
};
}jobs-progress.ts
ProgressEmitReceipt (interface)
Receipt returned after progress is persisted or sent.
Signature
export interface ProgressEmitReceipt {
readonly outcome: ProgressOutcome;
readonly sequence?: number;
readonly generation?: string;
readonly reason?: string;
}ProgressOutcome (type alias)
Delivery outcome of an emitted progress item.
Signature
type ProgressOutcome = "persisted" | "sent" | "dropped" | "unavailable";StreamItem (type alias)
JSON-safe item carried by a named job stream.
Signature
type StreamItem = JsonValue;StreamSchemaDescriptor (interface)
Name and version of a typed job stream schema.
Signature
export interface StreamSchemaDescriptor<Name extends string = string> {
readonly name: Name;
readonly schemaVersion: string;
}jobs-refs.ts
JobRef (interface)
Browser-safe reference to a job and its underlying task.
Signature
export interface JobRef<
Id extends string = string,
InputSchema = unknown,
OutputSchema = unknown,
Task extends TaskRef = TaskRef,
> {
readonly ref: Ref<"job", Id>;
readonly input: InputSchema;
readonly output?: OutputSchema;
readonly task?: Task;
readonly name?: string;
readonly profile?: string;
}JobRefAny (type alias)
Job reference with unconstrained type parameters.
Signature
type JobRefAny = JobRef;SchemaInput (type alias)
Input type inferred from a structural Standard Schema reference.
Signature
type SchemaInput<S> = S extends {
readonly "~standard": { readonly types?: SchemaTypeParameters<infer Input, unknown> };
}
? Input
: unknown;SchemaLike (interface)
Structural schema shape used by browser-safe references.
Signature
export interface SchemaLike<Input = unknown, Output = Input> {
readonly "~standard": {
readonly types?: SchemaTypeParameters<Input, Output>;
};
}SchemaOutput (type alias)
Output type inferred from a structural Standard Schema reference.
Signature
type SchemaOutput<S> = S extends {
readonly "~standard": { readonly types?: SchemaTypeParameters<unknown, infer Output> };
}
? Output
: unknown;SchemaTypeParameters (interface)
Standard Schema type parameters captured by a browser-safe reference.
Signature
export interface SchemaTypeParameters<Input = unknown, Output = Input> {
readonly input: Input;
readonly output: Output;
}TaskRef (interface)
Browser-safe reference to a task and its input, output, and errors.
Signature
export interface TaskRef<
Id extends string = string,
InputSchema = unknown,
OutputSchema = unknown,
Errors extends readonly unknown[] = readonly unknown[],
> {
readonly ref: Ref<"task", Id>;
readonly input: InputSchema;
readonly output: OutputSchema;
readonly errors?: Errors;
}TaskRefAny (type alias)
Task reference with unconstrained type parameters.
Signature
type TaskRefAny = TaskRef;jobs-run-stream.ts
NamedStreamFrame (type alias)
Lifecycle or item frame produced by a named job stream.
Signature
type NamedStreamFrame<Item = JsonValue> =
| (StreamIdentity & { readonly kind: "start" })
| (StreamIdentity & {
readonly kind: "chunk";
readonly sequence: number;
readonly item: Item;
readonly cursor?: string;
})
| (StreamIdentity & {
readonly kind: "reset";
readonly reason: "reconnected" | "cursor-expired" | "overflow";
})
| (StreamIdentity & { readonly kind: "end" });RunConnection (type alias)
Connection state reported while observing a job run.
Signature
type RunConnection =
| "idle"
| "connecting"
| "connected"
| "reconnecting"
| "disconnected"
| "completed"
| "unauthorized"
| "error"
| "disposed";RunWatchFrame (type alias)
Snapshot, update, or continuity reset sent to a run watcher.
Signature
type RunWatchFrame<Run = RunSnapshot> =
| {
readonly kind: "snapshot";
readonly run: Run;
readonly observedAt: string;
readonly epoch: string;
readonly sequence: number;
readonly cursor?: string;
readonly continuity: "state" | "history";
}
| {
readonly kind: "update";
readonly run: Run;
readonly observedAt: string;
readonly epoch: string;
readonly sequence: number;
readonly cursor?: string;
}
| {
readonly kind: "reset";
readonly run: Run;
readonly observedAt: string;
readonly epoch: string;
readonly sequence: number;
readonly reason: "reconnected" | "cursor-expired" | "history-unavailable" | "overflow";
readonly cursor?: string;
};StreamIdentity (interface)
Identity of a named stream within one run attempt and generation.
Signature
export interface StreamIdentity {
readonly runId: string;
readonly name: string;
readonly attempt: number;
readonly generation: string;
readonly schemaVersion: string;
}jobs-run.ts
JobErrorEnvelope (interface)
Public error details safe to return from a job run.
Signature
export interface JobErrorEnvelope {
readonly code: string;
readonly message: string;
readonly details?: JsonValue;
readonly retry?: "never" | "later";
readonly afterMs?: number;
}JobRunStatus (type alias)
Persisted lifecycle state of a job run.
Signature
type JobRunStatus =
| "queued"
| "delayed"
| "running"
| "sleeping"
| "retrying"
| "completed"
| "failed"
| "cancelled"
| "timed-out"
| "unknown";NamedStreamFrame
Signature
declare const NamedStreamFrame: NamedStreamFrame<Item>;ResultAvailability (type alias)
Availability of a run result after retention and policy checks.
Signature
type ResultAvailability =
| "pending"
| "available"
| "void"
| "redacted"
| "expired"
| "not-selected"
| "version-incompatible"
| "unavailable";RunAvailability (interface)
Per-service availability reported with a run page.
Signature
export interface RunAvailability {
readonly service: string;
readonly state: "available" | "unavailable";
readonly reason?: string;
}RunCancellationReceipt (interface)
Outcome of requesting cancellation for a job run.
Signature
export interface RunCancellationReceipt {
readonly runId: string;
readonly operationId: string;
readonly outcome: "requested" | "already-terminal" | "unsupported";
readonly requestedAt?: string;
readonly run?: RunSnapshot;
}RunConnection
Signature
declare const RunConnection: RunConnection;RunHandle (interface)
Identity and acceptance metadata returned after triggering a run.
Signature
export interface RunHandle {
readonly accepted: true;
readonly runId: string;
readonly jobId: string;
readonly taskId: string;
readonly taskVersion: string;
readonly acceptedAt: string;
readonly duplicate?: boolean;
readonly idempotencyExpiresAt?: string;
}RunListQuery (interface)
Filters and pagination inputs for listing job runs.
Signature
export interface RunListQuery {
readonly status?: readonly JobRunStatus[];
readonly jobId?: string;
readonly taskId?: string;
readonly taskVersion?: string;
readonly buildId?: string;
readonly service?: string;
readonly acceptedFrom?: string;
readonly acceptedTo?: string;
readonly startedFrom?: string;
readonly startedTo?: string;
readonly completedFrom?: string;
readonly completedTo?: string;
readonly tags?: readonly string[];
readonly tagMatch?: "all" | "any";
readonly correlationId?: string;
readonly parentRunId?: string;
readonly runId?: string;
readonly limit?: number;
readonly cursor?: string;
}RunPage (interface)
Paginated run results and provider availability.
Signature
export interface RunPage<Run = RunSnapshot> {
readonly items: readonly Run[];
readonly nextCursor?: string;
readonly hasMore: boolean;
readonly availability: readonly RunAvailability[];
readonly count?: { readonly value: number; readonly accuracy: "exact" | "approximate" };
}RunRetryReceipt (interface)
Acceptance receipt linking a retry to its original run.
Signature
export interface RunRetryReceipt extends RunHandle {
readonly retryOfRunId: string;
}RunSnapshot (type alias)
Discriminated run snapshot whose output exists only when available.
Signature
type RunSnapshot<
Input = unknown,
Output = unknown,
Progress = unknown,
Failure = JobErrorEnvelope,
> =
| (RunSnapshotBase<Input, Progress, Failure> & {
readonly status: "completed";
readonly resultAvailability: "available";
readonly output: Output;
})
| (RunSnapshotBase<Input, Progress, Failure> & {
readonly status: "completed";
readonly resultAvailability: Exclude<ResultAvailability, "available">;
readonly output?: never;
})
| (RunSnapshotBase<Input, Progress, Failure> & {
readonly status: Exclude<JobRunStatus, "completed">;
readonly output?: never;
});RunStatus (type alias)
Backward-compatible alias for a job run status.
Signature
type RunStatus = JobRunStatus;RunWatchFrame
Signature
declare const RunWatchFrame: RunWatchFrame<Run>;StreamIdentity
Signature
declare const StreamIdentity: StreamIdentity;jobs-wire.types.ts
JobWireEnvelope (type alias)
Versioned result representation on the jobs wire.
Signature
type JobWireEnvelope = JsonWireEnvelope | VoidWireEnvelope;JsonWireEnvelope (interface)
Wire envelope carrying a JSON result.
Signature
export interface JsonWireEnvelope {
readonly version: typeof JOBS_WIRE_VERSION;
readonly kind: "json";
readonly value: JsonValue;
}VoidWireEnvelope (interface)
Wire envelope carrying no result value.
Signature
export interface VoidWireEnvelope {
readonly version: typeof JOBS_WIRE_VERSION;
readonly kind: "void";
}jobs.ts
“./jobs-contracts.js” (namespace export)
Re-exports all named exports from the “./jobs-contracts.js” module.
Signature
export * from "./jobs-contracts.js";JOBS_MANIFEST_PROTOCOL
Signature
declare const JOBS_MANIFEST_PROTOCOL: "relkit.jobs-manifest";JOBS_MANIFEST_VERSION
Signature
declare const JOBS_MANIFEST_VERSION: 1;JOBS_PROTOCOL
Signature
declare const JOBS_PROTOCOL: "relkit.jobs";JOBS_PROTOCOL_VERSION
Signature
declare const JOBS_PROTOCOL_VERSION: 1;JOB_NAME_MAX_LENGTH
Signature
declare const JOB_NAME_MAX_LENGTH: 64;