# PURISTA API Documentation

Markdown index for the handbook-native PURISTA TypeScript API reference.

---
Canonical: /handbook/api/
Source: web/src/generated/purista-api.json
Format: Markdown for agents
---

Project: PURISTA API

Total exports: 799

## Packages

- [@purista/amqpbridge](/handbook/api/modules/_purista_amqpbridge.md)
- [@purista/aws-config-store](/handbook/api/modules/_purista_aws-config-store.md)
- [@purista/aws-secret-store](/handbook/api/modules/_purista_aws-secret-store.md)
- [@purista/azure-secret-store](/handbook/api/modules/_purista_azure-secret-store.md)
- [@purista/base-http-bridge](/handbook/api/modules/_purista_base-http-bridge.md)
- [@purista/cli](/handbook/api/modules/_purista_cli.md)
- [@purista/core](/handbook/api/modules/_purista_core.md)
- [@purista/dapr-sdk](/handbook/api/modules/_purista_dapr-sdk.md)
- [@purista/gcloud-secret-store](/handbook/api/modules/_purista_gcloud-secret-store.md)
- [@purista/hono-http-server](/handbook/api/modules/_purista_hono-http-server.md)
- [@purista/infisical-secret-store](/handbook/api/modules/_purista_infisical-secret-store.md)
- [@purista/k8s-sdk](/handbook/api/modules/_purista_k8s-sdk.md)
- [@purista/mqttbridge](/handbook/api/modules/_purista_mqttbridge.md)
- [@purista/nats-config-store](/handbook/api/modules/_purista_nats-config-store.md)
- [@purista/nats-queue-bridge](/handbook/api/modules/_purista_nats-queue-bridge.md)
- [@purista/nats-state-store](/handbook/api/modules/_purista_nats-state-store.md)
- [@purista/natsbridge](/handbook/api/modules/_purista_natsbridge.md)
- [@purista/redis-config-store](/handbook/api/modules/_purista_redis-config-store.md)
- [@purista/redis-queue-bridge](/handbook/api/modules/_purista_redis-queue-bridge.md)
- [@purista/redis-state-store](/handbook/api/modules/_purista_redis-state-store.md)
- [@purista/vault-secret-store](/handbook/api/modules/_purista_vault-secret-store.md)

## Classes

- [AgentQueueBuilder](/handbook/api/classes/_purista_core.AgentQueueBuilder.md) — Builds an attached PURISTA agent from normal core queue, worker, command,
stream definitions, and a provider-neutral agent manifest.
- [AmqpBridge](/handbook/api/classes/_purista_amqpbridge.AmqpBridge.md) — EventBridge implementation for AMQP brokers such as RabbitMQ.
- [AWSConfigStore](/handbook/api/classes/_purista_aws-config-store.AWSConfigStore.md) — Config store backed by AWS Systems Manager Parameter Store.
- [AWSSecretStore](/handbook/api/classes/_purista_aws-secret-store.AWSSecretStore.md) — Secret store backed by AWS Secrets Manager.
- [AzureSecretStore](/handbook/api/classes/_purista_azure-secret-store.AzureSecretStore.md) — Secret store backed by Azure Key Vault.
- [ClientBuilder](/handbook/api/classes/_purista_core.ClientBuilder.md) — ClientBuilder to generate clients, based on service definitions.
- [CommandDefinitionBuilder](/handbook/api/classes/_purista_core.CommandDefinitionBuilder.md) — Command definition builder is a helper to create and define a command for a service.
It helps to set all needed information like schemas and hooks.
With these information, the types are automatically set and extended.
- [ConfigStoreBaseClass](/handbook/api/classes/_purista_core.ConfigStoreBaseClass.md) — Base class for config store adapters.
- [DaprClient](/handbook/api/classes/_purista_dapr-sdk.DaprClient.md) — HTTP client for Dapr sidecar APIs used by the Dapr event bridge.
- [DaprConfigStore](/handbook/api/classes/_purista_dapr-sdk.DaprConfigStore.md) — Config store adapter backed by Dapr configuration components.
- [DaprEventBridge](/handbook/api/classes/_purista_dapr-sdk.DaprEventBridge.md) — Event bridge that connects PURISTA services to the local Dapr sidecar.
- [DaprSecretStore](/handbook/api/classes/_purista_dapr-sdk.DaprSecretStore.md) — Secret store adapter backed by a Dapr secret component.
- [DaprStateStore](/handbook/api/classes/_purista_dapr-sdk.DaprStateStore.md) — State store adapter backed by a Dapr state component.
- [DefaultConfigStore](/handbook/api/classes/_purista_core.DefaultConfigStore.md) — Process-local in-memory config store for development and tests.
- [DefaultEventBridge](/handbook/api/classes/_purista_core.DefaultEventBridge.md) — Process-local in-memory event bridge for development and tests.
- [DefaultLogger](/handbook/api/classes/_purista_core.DefaultLogger.md) — @purista/core
- [DefaultQueueBridge](/handbook/api/classes/_purista_core.DefaultQueueBridge.md) — In-memory queue bridge for development and unit tests.
- [DefaultSecretStore](/handbook/api/classes/_purista_core.DefaultSecretStore.md) — Process-local in-memory secret store for development and tests.
- [DefaultStateStore](/handbook/api/classes/_purista_core.DefaultStateStore.md) — Process-local in-memory state store for development and tests.
- [EventBridgeBaseClass](/handbook/api/classes/_purista_core.EventBridgeBaseClass.md) — The base class to be extended by event bridge implementations
- [GenericEventEmitter](/handbook/api/classes/_purista_core.GenericEventEmitter.md) — @purista/core
- [GoogleSecretStore](/handbook/api/classes/_purista_gcloud-secret-store.GoogleSecretStore.md) — Secret store backed by Google Secret Manager.
- [HandledError](/handbook/api/classes/_purista_core.HandledError.md) — A handled error is an error which is handled or thrown by business logic.
It is wanted to expose it the outside world.
Scenarios are input validation failures or "404 Not Found" errors which should be returned to the caller.
- [HonoServiceClass](/handbook/api/classes/_purista_hono-http-server.HonoServiceClass.md) — PURISTA service that exposes command, stream and async queue-backed endpoints through Hono.
- [HttpClient](/handbook/api/classes/_purista_core.HttpClient.md) — HTTP client with JSON helpers, timeout handling, tracing, metrics, and normalized errors.
- [HttpEventBridge](/handbook/api/classes/_purista_base-http-bridge.HttpEventBridge.md) — Stores the app value exposed by HttpEventBridge.
Start the bridge before registering services and stop it during graceful shutdown.
Expose only schemas and metadata that are safe for clients to inspect.
Treat this property as runtime state unless the concrete API documents a stronger guarantee.
- [InfisicalClient](/handbook/api/classes/_purista_infisical-secret-store.InfisicalClient.md) — HTTP client for the Infisical API used by `InfisicalSecretStore`.
- [InfisicalSecretStore](/handbook/api/classes/_purista_infisical-secret-store.InfisicalSecretStore.md) — Secret store backed by Infisical.
- [InFlightExecutionTracker](/handbook/api/classes/_purista_core.InFlightExecutionTracker.md) — Tracks active event bridge handler promises for drain and health reporting.
- [Logger](/handbook/api/classes/_purista_core.Logger.md) — @purista/core
- [MqttBridge](/handbook/api/classes/_purista_mqttbridge.MqttBridge.md) — EventBridge implementation for MQTT 5 brokers.
- [NatsBridge](/handbook/api/classes/_purista_natsbridge.NatsBridge.md) — EventBridge implementation for NATS core messaging with optional JetStream.
- [NatsConfigStore](/handbook/api/classes/_purista_nats-config-store.NatsConfigStore.md) — Config store backed by a NATS JetStream key-value bucket.
- [NatsQueueBridge](/handbook/api/classes/_purista_nats-queue-bridge.NatsQueueBridge.md) — Strict QueueBridge implementation backed by NATS JetStream streams and KV.
- [NatsStateStore](/handbook/api/classes/_purista_nats-state-store.NatsStateStore.md) — State store backed by a NATS JetStream key-value bucket.
- [PendingInvocationRegistry](/handbook/api/classes/_purista_core.PendingInvocationRegistry.md) — Registry for command invocations awaiting correlated responses.
- [PendingStreamRegistry](/handbook/api/classes/_purista_core.PendingStreamRegistry.md) — Registry for stream invocations awaiting correlated frames.
- [PuristaCliError](/handbook/api/classes/_purista_cli.PuristaCliError.md) — Base error type thrown by the programmatic CLI API.
- [PuristaCliPromptError](/handbook/api/classes/_purista_cli.PuristaCliPromptError.md) — Error thrown by prompt adapters when interactive input cannot be collected.
- [PuristaCliValidationError](/handbook/api/classes/_purista_cli.PuristaCliValidationError.md) — Error thrown when command input or project state cannot be resolved.
- [PuristaMetricsRecorder](/handbook/api/classes/_purista_core.PuristaMetricsRecorder.md) — OpenTelemetry API backed PURISTA metrics recorder.
- [QueueDefinitionBuilder](/handbook/api/classes/_purista_core.QueueDefinitionBuilder.md) — Builds a durable queue contract for background work.
- [QueueWorkerBuilder](/handbook/api/classes/_purista_core.QueueWorkerBuilder.md) — Builds a queue worker definition for one queue.
- [RedisConfigStore](/handbook/api/classes/_purista_redis-config-store.RedisConfigStore.md) — Config store backed by Redis string keys.
- [RedisQueueBridge](/handbook/api/classes/_purista_redis-queue-bridge.RedisQueueBridge.md) — Strict QueueBridge implementation backed by Redis data structures.
- [RedisStateStore](/handbook/api/classes/_purista_redis-state-store.RedisStateStore.md) — State store backed by Redis string keys.
- [ScheduleDefinitionBuilder](/handbook/api/classes/_purista_core.ScheduleDefinitionBuilder.md) — Builds a schedule contract for an external scheduler.
- [SecretStoreBaseClass](/handbook/api/classes/_purista_core.SecretStoreBaseClass.md) — Base class for secret store adapters.
- [Service](/handbook/api/classes/_purista_core.Service.md) — Base class for all services.
This class provides base functions to work with the event bridge, logging and so on
- [ServiceBuilder](/handbook/api/classes/_purista_core.ServiceBuilder.md) — This class is used to build a service.

## Interfaces

- [ConfigStore](/handbook/api/interfaces/_purista_core.ConfigStore.md) — Interface definition for config store adapters
- [EventBridge](/handbook/api/interfaces/_purista_core.EventBridge.md) — Event transport adapter contract used by PURISTA services.
- [GlobalContext](/handbook/api/interfaces/_purista_core.GlobalContext.md) — Context passed to all submodules
- [HttpEventBridgeClient](/handbook/api/interfaces/_purista_base-http-bridge.HttpEventBridgeClient.md) — Adapter contract between HttpEventBridge and a sidecar or platform HTTP API.
- [IEmitter](/handbook/api/interfaces/_purista_core.IEmitter.md) — @purista/core
- [ILogger](/handbook/api/interfaces/_purista_core.ILogger.md) — @purista/core
- [MemoryMetricRecord](/handbook/api/interfaces/_purista_core.MemoryMetricRecord.md) — Deterministic metric record captured by the memory recorder.
- [Options](/handbook/api/interfaces/_purista_cli.Options.md) — Options used for converting strings to any case.
- [PascalCaseOptions](/handbook/api/interfaces/_purista_cli.PascalCaseOptions.md) — Options used for converting strings to pascal/camel case.
- [PuristaMetricDefinition](/handbook/api/interfaces/_purista_core.PuristaMetricDefinition.md) — Declares one framework or application metric.
- [PuristaMetricsRecorderInterface](/handbook/api/interfaces/_purista_core.PuristaMetricsRecorderInterface.md) — A provider-neutral recorder used by framework code and metric contexts.
- [PuristaMetricsRuntimeOptions](/handbook/api/interfaces/_purista_core.PuristaMetricsRuntimeOptions.md) — Runtime metrics options consumed by PURISTA recorders.
- [QueueBridge](/handbook/api/interfaces/_purista_core.QueueBridge.md) — Queue transport adapter contract used by PURISTA services and queue workers.
- [RestClient](/handbook/api/interfaces/_purista_core.RestClient.md) — REST API client abstraction for JSON-oriented HTTP calls.
- [SecretStore](/handbook/api/interfaces/_purista_core.SecretStore.md) — Interface definition for a secret store implementation
- [ServiceClass](/handbook/api/interfaces/_purista_core.ServiceClass.md) — The ServiceClass interface
- [StateStore](/handbook/api/interfaces/_purista_core.StateStore.md) — Interface definition for state store implementations
- [StreamHandle](/handbook/api/interfaces/_purista_core.StreamHandle.md) — @purista/core
- [StreamWriter](/handbook/api/interfaces/_purista_core.StreamWriter.md) — @purista/core
- [TransformSchemaObjectOptions](/handbook/api/interfaces/_purista_core.TransformSchemaObjectOptions.md) — @purista/core

## Functions

- [addPathToOpenApi](/handbook/api/functions/_purista_hono-http-server.addPathToOpenApi.md) — @purista/hono-http-server
- [addPuristaAgent](/handbook/api/functions/_purista_cli.addPuristaAgent.md) — @purista/cli
- [addPuristaCommand](/handbook/api/functions/_purista_cli.addPuristaCommand.md) — @purista/cli
- [addPuristaQueue](/handbook/api/functions/_purista_cli.addPuristaQueue.md) — @purista/cli
- [addPuristaQueueWorker](/handbook/api/functions/_purista_cli.addPuristaQueueWorker.md) — @purista/cli
- [addPuristaService](/handbook/api/functions/_purista_cli.addPuristaService.md) — @purista/cli
- [addPuristaStream](/handbook/api/functions/_purista_cli.addPuristaStream.md) — @purista/cli
- [addPuristaSubscription](/handbook/api/functions/_purista_cli.addPuristaSubscription.md) — @purista/cli
- [addServiceEndpoints](/handbook/api/functions/_purista_k8s-sdk.addServiceEndpoints.md) — @purista/k8s-sdk
- [assertNonArrowFunction](/handbook/api/functions/_purista_core.assertNonArrowFunction.md) — @purista/core
- [camelCase](/handbook/api/functions/_purista_cli.camelCase.md) — @purista/cli
- [capitalCase](/handbook/api/functions/_purista_cli.capitalCase.md) — @purista/cli
- [collectAggregateStreamResult](/handbook/api/functions/_purista_hono-http-server.collectAggregateStreamResult.md) — @purista/hono-http-server
- [constantCase](/handbook/api/functions/_purista_cli.constantCase.md) — @purista/cli
- [convertEmitValidationsToSchema](/handbook/api/functions/_purista_core.convertEmitValidationsToSchema.md) — @purista/core
- [convertInvokeValidationsToSchema](/handbook/api/functions/_purista_core.convertInvokeValidationsToSchema.md) — @purista/core
- [convertToCamelCase](/handbook/api/functions/_purista_core.convertToCamelCase.md) — @purista/core
- [convertToKebabCase](/handbook/api/functions/_purista_core.convertToKebabCase.md) — @purista/core
- [convertToPascalCase](/handbook/api/functions/_purista_core.convertToPascalCase.md) — @purista/core
- [convertToProjectFileCasing](/handbook/api/functions/_purista_cli.convertToProjectFileCasing.md) — @purista/cli
- [convertToSnakeCase](/handbook/api/functions/_purista_core.convertToSnakeCase.md) — @purista/core
- [createAmqpConfigFile](/handbook/api/functions/_purista_cli.createAmqpConfigFile.md) — @purista/cli
- [createBiomeConfigFile](/handbook/api/functions/_purista_cli.createBiomeConfigFile.md) — @purista/cli
- [createCommandContextMock](/handbook/api/functions/_purista_core.createCommandContextMock.md) — @purista/core
- [createCommandTestHarness](/handbook/api/functions/_purista_core.createCommandTestHarness.md) — @purista/core
- [createDaprConfigFile](/handbook/api/functions/_purista_cli.createDaprConfigFile.md) — @purista/cli
- [createDefinitionsFile](/handbook/api/functions/_purista_cli.createDefinitionsFile.md) — @purista/cli
- [createEntrypointFile](/handbook/api/functions/_purista_cli.createEntrypointFile.md) — @purista/cli
- [createErrorResponse](/handbook/api/functions/_purista_core.createErrorResponse.md) — @purista/core
- [createEslintModuleConfigFile](/handbook/api/functions/_purista_cli.createEslintModuleConfigFile.md) — @purista/cli
- [createEventBridgeFile](/handbook/api/functions/_purista_cli.createEventBridgeFile.md) — @purista/cli
- [createExportDefinitionsFile](/handbook/api/functions/_purista_cli.createExportDefinitionsFile.md) — @purista/cli
- [createGitIgnoreFile](/handbook/api/functions/_purista_cli.createGitIgnoreFile.md) — @purista/cli
- [createHttpConfigFile](/handbook/api/functions/_purista_cli.createHttpConfigFile.md) — @purista/cli
- [createHttpFile](/handbook/api/functions/_purista_cli.createHttpFile.md) — @purista/cli
- [createInfoMessage](/handbook/api/functions/_purista_core.createInfoMessage.md) — @purista/core
- [createInvokeFunctionProxy](/handbook/api/functions/_purista_core.createInvokeFunctionProxy.md) — @purista/core
- [createMemoryMetricsRecorder](/handbook/api/functions/_purista_core.createMemoryMetricsRecorder.md) — @purista/core
- [createMetricContext](/handbook/api/functions/_purista_core.createMetricContext.md) — @purista/core
- [createMqttConfigFile](/handbook/api/functions/_purista_cli.createMqttConfigFile.md) — @purista/cli
- [createNatsConfigFile](/handbook/api/functions/_purista_cli.createNatsConfigFile.md) — @purista/cli
- [createNoopMetricsRecorder](/handbook/api/functions/_purista_core.createNoopMetricsRecorder.md) — @purista/core
- [createOpenStreamFunctionProxy](/handbook/api/functions/_purista_core.createOpenStreamFunctionProxy.md) — @purista/core
- [createProjectSnapshot](/handbook/api/functions/_purista_cli.createProjectSnapshot.md) — @purista/cli
- [createPublicIndexHtml](/handbook/api/functions/_purista_cli.createPublicIndexHtml.md) — @purista/cli
- [createPuristaCliEngine](/handbook/api/functions/_purista_cli.createPuristaCliEngine.md) — @purista/cli
- [createQueueEnqueueProxy](/handbook/api/functions/_purista_core.createQueueEnqueueProxy.md) — @purista/core
- [createQueueScheduleProxy](/handbook/api/functions/_purista_core.createQueueScheduleProxy.md) — @purista/core
- [createQueueWorkerContextMock](/handbook/api/functions/_purista_core.createQueueWorkerContextMock.md) — @purista/core
- [createQueueWorkerTestHarness](/handbook/api/functions/_purista_core.createQueueWorkerTestHarness.md) — @purista/core

## Types

- [addPrefixToObject](/handbook/api/types/_purista_core.addPrefixToObject.md) — Helper for better typescript type.
All keys of given object must start with the given prefix. Otherwise Typescript will complain.
- [AddPuristaQueueInput](/handbook/api/types/_purista_cli.AddPuristaQueueInput.md) — Input for generating a queue, its primary worker, and optional producer command.
- [AddPuristaQueueWorkerInput](/handbook/api/types/_purista_cli.AddPuristaQueueWorkerInput.md) — Input for generating an additional worker for an existing queue.
- [AgentDefinition](/handbook/api/types/_purista_core.AgentDefinition.md) — Attached agent definition before expansion into service definitions.
- [AgentExecutionDefinition](/handbook/api/types/_purista_core.AgentExecutionDefinition.md) — Internal execution definition selected by exactly one agent execution setter.
- [AgentExecutionKind](/handbook/api/types/_purista_core.AgentExecutionKind.md) — Execution implementation kind used by an attached agent definition.
- [AgentExecutionPolicy](/handbook/api/types/_purista_core.AgentExecutionPolicy.md) — Queue execution policy applied to the generated agent worker and queue.
- [AgentHandler](/handbook/api/types/_purista_core.AgentHandler.md) — Run function shape accepted by `AgentQueueBuilder.setRunFunction(...)`.
- [AgentHandlerContext](/handbook/api/types/_purista_core.AgentHandlerContext.md) — Context passed to an attached agent run function.
- [AgentHandlerModelBindings](/handbook/api/types/_purista_core.AgentHandlerModelBindings.md) — Typed model handles exposed to an agent run function.
- [AgentHttpExposure](/handbook/api/types/_purista_core.AgentHttpExposure.md) — HTTP projection metadata for the generated agent command or stream.
- [AgentInvokeMap](/handbook/api/types/_purista_core.AgentInvokeMap.md) — Typed child-agent invocation map exposed at `context.invoke.agents`.
- [AgentManifest](/handbook/api/types/_purista_core.AgentManifest.md) — Provider-neutral manifest describing an attached PURISTA agent.
- [AgentModelBinding](/handbook/api/types/_purista_core.AgentModelBinding.md) — Declares a model alias required by an attached PURISTA agent.
- [AgentModelCapability](/handbook/api/types/_purista_core.AgentModelCapability.md) — Model capability names supported by `@purista/harness` model bindings.
- [AgentQueueBuilderTypes](/handbook/api/types/_purista_core.AgentQueueBuilderTypes.md) — Type accumulator used by `AgentQueueBuilder` to preserve typed schemas, tools, models, and metrics.
- [AgentQueueResultPolicy](/handbook/api/types/_purista_core.AgentQueueResultPolicy.md) — Controls how generated queues persist and/or emit agent worker completion metadata.
- [AgentQueueResultPolicyMode](/handbook/api/types/_purista_core.AgentQueueResultPolicyMode.md) — Storage or event side effect used for queued agent run results.
- [AgentResponseMode](/handbook/api/types/_purista_core.AgentResponseMode.md) — Public response contract exposed by the generated agent command or stream.
- [AgentResponseModeOptions](/handbook/api/types/_purista_core.AgentResponseModeOptions.md) — Options for long-running agent response contracts.
- [AgentRunEvent](/handbook/api/types/_purista_core.AgentRunEvent.md) — Harness run event decorated with PURISTA agent identity metadata.
- [AgentRunIdentity](/handbook/api/types/_purista_core.AgentRunIdentity.md) — Stable run identity propagated through attached agent execution events and results.
- [AgentRunResult](/handbook/api/types/_purista_core.AgentRunResult.md) — Aggregate result returned by an attached agent runtime.
- [AgentRuntimeInvocationInput](/handbook/api/types/_purista_core.AgentRuntimeInvocationInput.md) — Aggregate invocation input passed from generated PURISTA definitions into the agent runtime.
- [AgentRuntimeModelBinding](/handbook/api/types/_purista_core.AgentRuntimeModelBinding.md) — @purista/core
- [AgentRuntimeModelBindings](/handbook/api/types/_purista_core.AgentRuntimeModelBindings.md) — Runtime model bindings keyed by every model alias declared on an agent builder.
- [AgentRuntimeOptions](/handbook/api/types/_purista_core.AgentRuntimeOptions.md) — Runtime options required to initialize attached agents for a service instance.
- [AgentRuntimeRef](/handbook/api/types/_purista_core.AgentRuntimeRef.md) — Mutable runtime reference bound when the owning service instance is created.
- [AgentRuntimeStreamInvocationInput](/handbook/api/types/_purista_core.AgentRuntimeStreamInvocationInput.md) — Streaming invocation input passed from generated PURISTA stream definitions into the agent runtime.
- [AgentSandboxPolicy](/handbook/api/types/_purista_core.AgentSandboxPolicy.md) — Optional sandbox adapter configuration passed through to the agent runtime.
- [AgentSessionPolicy](/handbook/api/types/_purista_core.AgentSessionPolicy.md) — Session behavior used by the harness runtime for each agent run.
- [AllowedAgentDefinition](/handbook/api/types/_purista_core.AllowedAgentDefinition.md) — Declares one attached agent that this attached agent may call.
- [AllowedCommandToolDefinition](/handbook/api/types/_purista_core.AllowedCommandToolDefinition.md) — Declares one service command that an attached agent may call as a typed tool.
- [AmqpBridgeConfig](/handbook/api/types/_purista_amqpbridge.AmqpBridgeConfig.md) — Configuration for AmqpBridge.
- [AnyAgentQueueBuilderTypes](/handbook/api/types/_purista_core.AnyAgentQueueBuilderTypes.md) — Broad agent builder type used where any attached agent definition is accepted.
- [AnyService](/handbook/api/types/_purista_hono-http-server.AnyService.md) — Service instance accepted by the Hono HTTP projection registry.
- [AttachedAgentDefinition](/handbook/api/types/_purista_core.AttachedAgentDefinition.md) — Agent plus the generated queue, worker, command, and stream definitions added to a service.
- [AttachedCoreDefinition](/handbook/api/types/_purista_core.AttachedCoreDefinition.md) — Core definition metadata attached to generated queue, worker, command, and stream artifacts.
- [AuthCredentials](/handbook/api/types/_purista_core.AuthCredentials.md) — HTTP authentication information kept in memory by HttpClient.
- [AWSConfigStoreConfig](/handbook/api/types/_purista_aws-config-store.AWSConfigStoreConfig.md) — AWS Systems Manager Parameter Store configuration.
- [AWSSecretStoreConfig](/handbook/api/types/_purista_aws-secret-store.AWSSecretStoreConfig.md) — AWS Secrets Manager store configuration.
- [AzureSecretStoreConfig](/handbook/api/types/_purista_azure-secret-store.AzureSecretStoreConfig.md) — Azure Key Vault secret store configuration.
- [BasePromptRequest](/handbook/api/types/_purista_cli.BasePromptRequest.md) — Shared fields used by prompt requests.
- [BindingsBase](/handbook/api/types/_purista_hono-http-server.BindingsBase.md) — Base Hono bindings type used by the Hono HTTP service.
- [BlueprintId](/handbook/api/types/_purista_cli.BlueprintId.md) — Built-in project blueprint identifiers understood by the generator.
- [BrokerHeaderCommandMsg](/handbook/api/types/_purista_core.BrokerHeaderCommandMsg.md) — @purista/core
- [BrokerHeaderCommandResponseMsg](/handbook/api/types/_purista_core.BrokerHeaderCommandResponseMsg.md) — @purista/core
- [BrokerHeaderCustomMsg](/handbook/api/types/_purista_core.BrokerHeaderCustomMsg.md) — @purista/core
- [BulkSubscribeConfig](/handbook/api/types/_purista_dapr-sdk.BulkSubscribeConfig.md) — BulkSubscribeConfig defines the configuration for a bulk subscription
- [BulkSubscribeOptions](/handbook/api/types/_purista_dapr-sdk.BulkSubscribeOptions.md) — BulkSubscribeOptions enlists the options for bulk subscribe

## Enums

- [DaprPubSubStatusEnum](/handbook/api/enums/_purista_dapr-sdk.DaprPubSubStatusEnum.md) — Status values returned to Dapr Pub/Sub callbacks.
- [EBMessageType](/handbook/api/enums/_purista_core.EBMessageType.md) — Type of event bridge message
- [EventBridgeCommandTransport](/handbook/api/enums/_purista_core.EventBridgeCommandTransport.md) — Command request/response transport strategy used by an event bridge.
- [EventBridgeLateResponseHandling](/handbook/api/enums/_purista_core.EventBridgeLateResponseHandling.md) — Policy for command responses that arrive after invocation timeout.
- [EventBridgeResponseConfirmationLevel](/handbook/api/enums/_purista_core.EventBridgeResponseConfirmationLevel.md) — Confirmation level available for command responses.
- [EventBridgeStreamLateFrameHandling](/handbook/api/enums/_purista_core.EventBridgeStreamLateFrameHandling.md) — Policy for stream frames that arrive after stream timeout.
- [PuristaSpanName](/handbook/api/enums/_purista_core.PuristaSpanName.md) — Opentelemetry span names used by PURISTA framework
- [PuristaSpanTag](/handbook/api/enums/_purista_core.PuristaSpanTag.md) — Opentelemetry tags set by PURISTA framework
- [StatusCode](/handbook/api/enums/_purista_core.StatusCode.md) — Message and error status codes.
The codes are based on HTTP status codes
- [StoreType](/handbook/api/enums/_purista_core.StoreType.md) — @purista/core

## Variables

- [blueprintIds](/handbook/api/variables/_purista_cli.blueprintIds.md) — Ordered list of built-in project blueprint identifiers.
- [CONFIG_FILE_NAME](/handbook/api/variables/_purista_core.CONFIG_FILE_NAME.md) — @purista/core
- [configFullSchema](/handbook/api/variables/_purista_core.configFullSchema.md) — @purista/core
- [configRoute](/handbook/api/variables/_purista_dapr-sdk.configRoute.md) — Dapr actor configuration endpoint.
- [configSchema](/handbook/api/variables/_purista_core.configSchema.md) — @purista/core
- [DAPR_API_VERSION](/handbook/api/variables/_purista_dapr-sdk.DAPR_API_VERSION.md) — Default Dapr HTTP API version used by sidecar requests.
- [DEFAULT_API_MOUNT_PATH](/handbook/api/variables/_purista_hono-http-server.DEFAULT_API_MOUNT_PATH.md) — Default base path for generated HTTP command and stream endpoints.
- [DEFAULT_DAPR_HOST](/handbook/api/variables/_purista_dapr-sdk.DEFAULT_DAPR_HOST.md) — Default HTTP host of a local Dapr sidecar.
- [DEFAULT_DAPR_PORT](/handbook/api/variables/_purista_dapr-sdk.DEFAULT_DAPR_PORT.md) — Default HTTP port of a local Dapr sidecar.
- [defaultQueueLifecycleConfig](/handbook/api/variables/_purista_core.defaultQueueLifecycleConfig.md) — Opinionated defaults for queues so builders can omit lifecycle overrides
yet still get resilient behaviour.
- [eventBridgeClientConfigSchema](/handbook/api/variables/_purista_core.eventBridgeClientConfigSchema.md) — @purista/core
- [ExternalDocumentationObjectSchema](/handbook/api/variables/_purista_hono-http-server.ExternalDocumentationObjectSchema.md) — Schema for OpenAPI external documentation objects.
- [frameworkMetricDefinitions](/handbook/api/variables/_purista_core.frameworkMetricDefinitions.md) — PURISTA framework metric catalog.
- [getCommandResponseSubscriptionTopic](/handbook/api/variables/_purista_mqttbridge.getCommandResponseSubscriptionTopic.md) — Builds the MQTT topic filter used to receive command responses for the
current bridge instance.
- [getCommandSubscriptionTopic](/handbook/api/variables/_purista_mqttbridge.getCommandSubscriptionTopic.md) — Builds the MQTT topic filter used by command handlers for one service
address.
- [getCommandSubscriptionTopic](/handbook/api/variables/_purista_natsbridge.getCommandSubscriptionTopic.md) — Builds the NATS subject used by command handlers for one service address.
- [getQueryDefintion](/handbook/api/variables/_purista_hono-http-server.getQueryDefintion.md) — Backward-compatible alias for the misspelled query definition helper.
- [getSharedTopicName](/handbook/api/variables/_purista_mqttbridge.getSharedTopicName.md) — Wraps a topic with the configured MQTT shared-subscription prefix and group.
- [getSubscriptionTopic](/handbook/api/variables/_purista_mqttbridge.getSubscriptionTopic.md) — Builds the MQTT topic filter for a PURISTA subscription definition.
- [getSubscriptionTopic](/handbook/api/variables/_purista_natsbridge.getSubscriptionTopic.md) — Builds the NATS subject filter for a PURISTA subscription definition.
- [getTopicName](/handbook/api/variables/_purista_mqttbridge.getTopicName.md) — Calculates the MQTT topic name for a message which should be sent.
- [getTopicName](/handbook/api/variables/_purista_natsbridge.getTopicName.md) — Calculates the NATS topic name for a message which should be sent.
- [handleCommandResponse](/handbook/api/variables/_purista_mqttbridge.handleCommandResponse.md) — Handles MQTT command responses for pending invocations.
- [honoServiceInfo](/handbook/api/variables/_purista_hono-http-server.honoServiceInfo.md) — Service metadata for version 1 of the built-in Hono HTTP service.
- [honoServiceV1ConfigSchema](/handbook/api/variables/_purista_hono-http-server.honoServiceV1ConfigSchema.md) — Runtime configuration schema for the Hono HTTP service.
- [honoV1Service](/handbook/api/variables/_purista_hono-http-server.honoV1Service.md) — Built-in Hono HTTP service definition.
- [honoV1ServiceBuilder](/handbook/api/variables/_purista_hono-http-server.honoV1ServiceBuilder.md) — Builder for the built-in Hono HTTP service.
- [honoV1ServiceCommandsToRestApiInputPayloadSchema](/handbook/api/variables/_purista_hono-http-server.honoV1ServiceCommandsToRestApiInputPayloadSchema.md) — Schema for dynamic endpoint metadata received from service definition info messages.
- [httpClientConfigSchema](/handbook/api/variables/_purista_core.httpClientConfigSchema.md) — @purista/core
- [infoMessageTypes](/handbook/api/variables/_purista_core.infoMessageTypes.md) — @purista/core
- [InfoObjectSchema](/handbook/api/variables/_purista_hono-http-server.InfoObjectSchema.md) — Schema for the OpenAPI info object.
- [MIN_CONTENT_SIZE_FOR_COMPRESSION](/handbook/api/variables/_purista_core.MIN_CONTENT_SIZE_FOR_COMPRESSION.md) — @purista/core
- [OPENAPI_DEFAULT_INFO](/handbook/api/variables/_purista_hono-http-server.OPENAPI_DEFAULT_INFO.md) — Default OpenAPI info block used when no application-specific metadata is supplied.
- [ProblemDetailsObjectSchema](/handbook/api/variables/_purista_hono-http-server.ProblemDetailsObjectSchema.md) — Schema for RFC 9457 problem details configuration.
- [projectBlueprintRegistry](/handbook/api/variables/_purista_cli.projectBlueprintRegistry.md) — Registry of built-in project blueprints used by `planProjectGeneration`.
- [puristaCommandIds](/handbook/api/variables/_purista_cli.puristaCommandIds.md) — Ordered list of command identifiers supported by the programmatic CLI engine.
- [puristaConfigSchema](/handbook/api/variables/_purista_cli.puristaConfigSchema.md) — Zod schema for the `purista.json` configuration file consumed by the CLI.
- [puristaVersion](/handbook/api/variables/_purista_amqpbridge.puristaVersion.md) — The PURISTA package version embedded in the published runtime build.
- [puristaVersion](/handbook/api/variables/_purista_aws-config-store.puristaVersion.md) — The PURISTA package version embedded in the published runtime build.
- [puristaVersion](/handbook/api/variables/_purista_aws-secret-store.puristaVersion.md) — The PURISTA package version embedded in the published runtime build.
- [puristaVersion](/handbook/api/variables/_purista_azure-secret-store.puristaVersion.md) — The PURISTA package version embedded in the published runtime build.
- [puristaVersion](/handbook/api/variables/_purista_base-http-bridge.puristaVersion.md) — The PURISTA package version embedded in the published runtime build.
- [puristaVersion](/handbook/api/variables/_purista_core.puristaVersion.md) — The PURISTA package version embedded in the published runtime build.
- [puristaVersion](/handbook/api/variables/_purista_dapr-sdk.puristaVersion.md) — The PURISTA package version embedded in the published runtime build.
- [puristaVersion](/handbook/api/variables/_purista_gcloud-secret-store.puristaVersion.md) — The PURISTA package version embedded in the published runtime build.
- [puristaVersion](/handbook/api/variables/_purista_hono-http-server.puristaVersion.md) — The PURISTA package version embedded in the published runtime build.
- [puristaVersion](/handbook/api/variables/_purista_infisical-secret-store.puristaVersion.md) — The PURISTA package version embedded in the published runtime build.
- [puristaVersion](/handbook/api/variables/_purista_k8s-sdk.puristaVersion.md) — The PURISTA package version embedded in the published runtime build.
- [puristaVersion](/handbook/api/variables/_purista_mqttbridge.puristaVersion.md) — The PURISTA package version embedded in the published runtime build.
- [puristaVersion](/handbook/api/variables/_purista_nats-config-store.puristaVersion.md) — The PURISTA package version embedded in the published runtime build.