API Reference

Public PURISTA API

Generated from TypeDoc and rendered inside the handbook shell. Use this section when you know the PURISTA concept and need package exports, method signatures, source links, and public TypeScript contracts.

21 packages 799 exports 6 symbol groups

Packages

Start with a package when you are wiring runtime infrastructure, stores, bridges, adapters, or core builders. The package pages keep the same handbook navigation and link onward to classes, interfaces, functions, types, and enums.

service.ts typescript 
import { ServiceBuilder } from '@purista/core'

const service = new ServiceBuilder({
  serviceName: 'account',
  serviceVersion: '1',
  serviceDescription: 'Account capability',
})

@purista/amqpbridge

Package for using a AMQP broker like rabbitMQ as event bridge.

@purista/aws-config-store

AWS Systems Manager Parameter Store adapter for PURISTA config values.

@purista/aws-secret-store

AWS Secrets Manager adapter for PURISTA secret values.

@purista/azure-secret-store

Azure Key Vault adapter for PURISTA secret values.

@purista/base-http-bridge

Public exports and TypeScript contracts for this PURISTA package.

@purista/cli

Public exports and TypeScript contracts for this PURISTA package.

@purista/core

This is the main package of PURISTA.

@purista/dapr-sdk

SDK and helper to run PURISTA services with Dapr.

@purista/gcloud-secret-store

Google Secret Manager adapter for PURISTA secret values.

@purista/hono-http-server

Package for using a Hono as webserver.

@purista/infisical-secret-store

Infisical adapter for PURISTA secret values.

@purista/k8s-sdk

SDK and helper to run PURISTA services in Kubernetes.

@purista/mqttbridge

Package for using an MQTT broker as event bridge.

@purista/nats-config-store

NATS JetStream key-value adapter for PURISTA config values.

@purista/nats-queue-bridge

Public exports and TypeScript contracts for this PURISTA package.

@purista/nats-state-store

NATS JetStream key-value adapter for PURISTA state values.

@purista/natsbridge

Package for using a [NATS](https://nats.io/) broker as event bridge. The event bridge supports brokers with and without JetStream enabled.

@purista/redis-config-store

Redis adapter for PURISTA config values.

@purista/redis-queue-bridge

Public exports and TypeScript contracts for this PURISTA package.

@purista/redis-state-store

Redis adapter for PURISTA state values.

@purista/vault-secret-store

HashiCorp Vault KV v2 adapter for PURISTA secret values.

Classes

57 public symbols

AgentQueueBuilder @purista/core Builds an attached PURISTA agent from normal core queue, worker, command, stream definitions, and a provider-neutral agent manifest. AmqpBridge @purista/amqpbridge EventBridge implementation for AMQP brokers such as RabbitMQ. AWSConfigStore @purista/aws-config-store Config store backed by AWS Systems Manager Parameter Store. AWSSecretStore @purista/aws-secret-store Secret store backed by AWS Secrets Manager. AzureSecretStore @purista/azure-secret-store Secret store backed by Azure Key Vault. ClientBuilder @purista/core ClientBuilder to generate clients, based on service definitions. CommandDefinitionBuilder @purista/core 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 @purista/core Base class for config store adapters. DaprClient @purista/dapr-sdk HTTP client for Dapr sidecar APIs used by the Dapr event bridge. DaprConfigStore @purista/dapr-sdk Config store adapter backed by Dapr configuration components. DaprEventBridge @purista/dapr-sdk Event bridge that connects PURISTA services to the local Dapr sidecar. DaprSecretStore @purista/dapr-sdk Secret store adapter backed by a Dapr secret component. DaprStateStore @purista/dapr-sdk State store adapter backed by a Dapr state component. DefaultConfigStore @purista/core Process-local in-memory config store for development and tests. DefaultEventBridge @purista/core Process-local in-memory event bridge for development and tests. DefaultLogger @purista/core DefaultQueueBridge @purista/core In-memory queue bridge for development and unit tests. DefaultSecretStore @purista/core Process-local in-memory secret store for development and tests. DefaultStateStore @purista/core Process-local in-memory state store for development and tests. EventBridgeBaseClass @purista/core The base class to be extended by event bridge implementations GenericEventEmitter @purista/core GoogleSecretStore @purista/gcloud-secret-store Secret store backed by Google Secret Manager. HandledError @purista/core 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 @purista/hono-http-server PURISTA service that exposes command, stream and async queue-backed endpoints through Hono. HttpClient @purista/core HTTP client with JSON helpers, timeout handling, tracing, metrics, and normalized errors. HttpEventBridge @purista/base-http-bridge 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 @purista/infisical-secret-store HTTP client for the Infisical API used by `InfisicalSecretStore`. InfisicalSecretStore @purista/infisical-secret-store Secret store backed by Infisical. InFlightExecutionTracker @purista/core Tracks active event bridge handler promises for drain and health reporting. Logger @purista/core MqttBridge @purista/mqttbridge EventBridge implementation for MQTT 5 brokers. NatsBridge @purista/natsbridge EventBridge implementation for NATS core messaging with optional JetStream. NatsConfigStore @purista/nats-config-store Config store backed by a NATS JetStream key-value bucket. NatsQueueBridge @purista/nats-queue-bridge Strict QueueBridge implementation backed by NATS JetStream streams and KV. NatsStateStore @purista/nats-state-store State store backed by a NATS JetStream key-value bucket. PendingInvocationRegistry @purista/core Registry for command invocations awaiting correlated responses.

Showing the first 36 entries. Use package pages to browse the full export set.

Interfaces

20 public symbols

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

Functions

197 public symbols

addPathToOpenApi @purista/hono-http-server addPuristaAgent @purista/cli addPuristaCommand @purista/cli addPuristaQueue @purista/cli addPuristaQueueWorker @purista/cli addPuristaService @purista/cli addPuristaStream @purista/cli addPuristaSubscription @purista/cli addServiceEndpoints @purista/k8s-sdk assertNonArrowFunction @purista/core camelCase @purista/cli capitalCase @purista/cli collectAggregateStreamResult @purista/hono-http-server constantCase @purista/cli convertEmitValidationsToSchema @purista/core convertInvokeValidationsToSchema @purista/core convertToCamelCase @purista/core convertToKebabCase @purista/core convertToPascalCase @purista/core convertToProjectFileCasing @purista/cli convertToSnakeCase @purista/core createAmqpConfigFile @purista/cli createBiomeConfigFile @purista/cli createCommandContextMock @purista/core createCommandTestHarness @purista/core createDaprConfigFile @purista/cli createDefinitionsFile @purista/cli createEntrypointFile @purista/cli createErrorResponse @purista/core createEslintModuleConfigFile @purista/cli createEventBridgeFile @purista/cli createExportDefinitionsFile @purista/cli createGitIgnoreFile @purista/cli createHttpConfigFile @purista/cli createHttpFile @purista/cli createInfoMessage @purista/core

Showing the first 36 entries. Use package pages to browse the full export set.

Types

455 public symbols

addPrefixToObject @purista/core Helper for better typescript type. All keys of given object must start with the given prefix. Otherwise Typescript will complain. AddPuristaQueueInput @purista/cli Input for generating a queue, its primary worker, and optional producer command. AddPuristaQueueWorkerInput @purista/cli Input for generating an additional worker for an existing queue. AgentDefinition @purista/core Attached agent definition before expansion into service definitions. AgentExecutionDefinition @purista/core Internal execution definition selected by exactly one agent execution setter. AgentExecutionKind @purista/core Execution implementation kind used by an attached agent definition. AgentExecutionPolicy @purista/core Queue execution policy applied to the generated agent worker and queue. AgentHandler @purista/core Run function shape accepted by `AgentQueueBuilder.setRunFunction(...)`. AgentHandlerContext @purista/core Context passed to an attached agent run function. AgentHandlerModelBindings @purista/core Typed model handles exposed to an agent run function. AgentHttpExposure @purista/core HTTP projection metadata for the generated agent command or stream. AgentInvokeMap @purista/core Typed child-agent invocation map exposed at `context.invoke.agents`. AgentManifest @purista/core Provider-neutral manifest describing an attached PURISTA agent. AgentModelBinding @purista/core Declares a model alias required by an attached PURISTA agent. AgentModelCapability @purista/core Model capability names supported by `@purista/harness` model bindings. AgentQueueBuilderTypes @purista/core Type accumulator used by `AgentQueueBuilder` to preserve typed schemas, tools, models, and metrics. AgentQueueResultPolicy @purista/core Controls how generated queues persist and/or emit agent worker completion metadata. AgentQueueResultPolicyMode @purista/core Storage or event side effect used for queued agent run results. AgentResponseMode @purista/core Public response contract exposed by the generated agent command or stream. AgentResponseModeOptions @purista/core Options for long-running agent response contracts. AgentRunEvent @purista/core Harness run event decorated with PURISTA agent identity metadata. AgentRunIdentity @purista/core Stable run identity propagated through attached agent execution events and results. AgentRunResult @purista/core Aggregate result returned by an attached agent runtime. AgentRuntimeInvocationInput @purista/core Aggregate invocation input passed from generated PURISTA definitions into the agent runtime. AgentRuntimeModelBinding @purista/core AgentRuntimeModelBindings @purista/core Runtime model bindings keyed by every model alias declared on an agent builder. AgentRuntimeOptions @purista/core Runtime options required to initialize attached agents for a service instance. AgentRuntimeRef @purista/core Mutable runtime reference bound when the owning service instance is created. AgentRuntimeStreamInvocationInput @purista/core Streaming invocation input passed from generated PURISTA stream definitions into the agent runtime. AgentSandboxPolicy @purista/core Optional sandbox adapter configuration passed through to the agent runtime. AgentSessionPolicy @purista/core Session behavior used by the harness runtime for each agent run. AllowedAgentDefinition @purista/core Declares one attached agent that this attached agent may call. AllowedCommandToolDefinition @purista/core Declares one service command that an attached agent may call as a typed tool. AmqpBridgeConfig @purista/amqpbridge Configuration for AmqpBridge. AnyAgentQueueBuilderTypes @purista/core Broad agent builder type used where any attached agent definition is accepted. AnyService @purista/hono-http-server Service instance accepted by the Hono HTTP projection registry.

Showing the first 36 entries. Use package pages to browse the full export set.

Enums

10 public symbols

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

Variables

60 public symbols

blueprintIds @purista/cli Ordered list of built-in project blueprint identifiers. CONFIG_FILE_NAME @purista/core configFullSchema @purista/core configRoute @purista/dapr-sdk Dapr actor configuration endpoint. configSchema @purista/core DAPR_API_VERSION @purista/dapr-sdk Default Dapr HTTP API version used by sidecar requests. DEFAULT_API_MOUNT_PATH @purista/hono-http-server Default base path for generated HTTP command and stream endpoints. DEFAULT_DAPR_HOST @purista/dapr-sdk Default HTTP host of a local Dapr sidecar. DEFAULT_DAPR_PORT @purista/dapr-sdk Default HTTP port of a local Dapr sidecar. defaultQueueLifecycleConfig @purista/core Opinionated defaults for queues so builders can omit lifecycle overrides yet still get resilient behaviour. eventBridgeClientConfigSchema @purista/core ExternalDocumentationObjectSchema @purista/hono-http-server Schema for OpenAPI external documentation objects. frameworkMetricDefinitions @purista/core PURISTA framework metric catalog. getCommandResponseSubscriptionTopic @purista/mqttbridge Builds the MQTT topic filter used to receive command responses for the current bridge instance. getCommandSubscriptionTopic @purista/mqttbridge Builds the MQTT topic filter used by command handlers for one service address. getCommandSubscriptionTopic @purista/natsbridge Builds the NATS subject used by command handlers for one service address. getQueryDefintion @purista/hono-http-server Backward-compatible alias for the misspelled query definition helper. getSharedTopicName @purista/mqttbridge Wraps a topic with the configured MQTT shared-subscription prefix and group. getSubscriptionTopic @purista/mqttbridge Builds the MQTT topic filter for a PURISTA subscription definition. getSubscriptionTopic @purista/natsbridge Builds the NATS subject filter for a PURISTA subscription definition. getTopicName @purista/mqttbridge Calculates the MQTT topic name for a message which should be sent. getTopicName @purista/natsbridge Calculates the NATS topic name for a message which should be sent. handleCommandResponse @purista/mqttbridge Handles MQTT command responses for pending invocations. honoServiceInfo @purista/hono-http-server Service metadata for version 1 of the built-in Hono HTTP service. honoServiceV1ConfigSchema @purista/hono-http-server Runtime configuration schema for the Hono HTTP service. honoV1Service @purista/hono-http-server Built-in Hono HTTP service definition. honoV1ServiceBuilder @purista/hono-http-server Builder for the built-in Hono HTTP service. honoV1ServiceCommandsToRestApiInputPayloadSchema @purista/hono-http-server Schema for dynamic endpoint metadata received from service definition info messages. httpClientConfigSchema @purista/core infoMessageTypes @purista/core InfoObjectSchema @purista/hono-http-server Schema for the OpenAPI info object. MIN_CONTENT_SIZE_FOR_COMPRESSION @purista/core OPENAPI_DEFAULT_INFO @purista/hono-http-server Default OpenAPI info block used when no application-specific metadata is supplied. ProblemDetailsObjectSchema @purista/hono-http-server Schema for RFC 9457 problem details configuration. projectBlueprintRegistry @purista/cli Registry of built-in project blueprints used by `planProjectGeneration`. puristaCommandIds @purista/cli Ordered list of command identifiers supported by the programmatic CLI engine.

Showing the first 36 entries. Use package pages to browse the full export set.