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 packages818 exports6 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.tstypescript
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

58 public symbols

AgentQueueBuilder@purista/coreBuilds an attached PURISTA agent from normal core queue, worker, command, stream definitions, and a provider-neutral agent manifest.AgentRunError@purista/coreError raised when a harness run terminates with a serialized error.AmqpBridge@purista/amqpbridgeEventBridge implementation for AMQP brokers such as RabbitMQ.AWSConfigStore@purista/aws-config-storeConfig store backed by AWS Systems Manager Parameter Store.AWSSecretStore@purista/aws-secret-storeSecret store backed by AWS Secrets Manager.AzureSecretStore@purista/azure-secret-storeSecret store backed by Azure Key Vault.ClientBuilder@purista/coreClientBuilder to generate clients, based on service definitions.CommandDefinitionBuilder@purista/coreCommand 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/coreBase class for config store adapters.DaprClient@purista/dapr-sdkHTTP client for Dapr sidecar APIs used by the Dapr event bridge.DaprConfigStore@purista/dapr-sdkConfig store adapter backed by Dapr configuration components.DaprEventBridge@purista/dapr-sdkEvent bridge that connects PURISTA services to the local Dapr sidecar.DaprSecretStore@purista/dapr-sdkSecret store adapter backed by a Dapr secret component.DaprStateStore@purista/dapr-sdkState store adapter backed by a Dapr state component.DefaultConfigStore@purista/coreProcess-local in-memory config store for development and tests.DefaultEventBridge@purista/coreProcess-local in-memory event bridge for development and tests.DefaultLogger@purista/coreDefaultQueueBridge@purista/coreIn-memory queue bridge for development and unit tests.DefaultSecretStore@purista/coreProcess-local in-memory secret store for development and tests.DefaultStateStore@purista/coreProcess-local in-memory state store for development and tests.EventBridgeBaseClass@purista/coreThe base class to be extended by event bridge implementationsGenericEventEmitter@purista/coreGoogleSecretStore@purista/gcloud-secret-storeSecret store backed by Google Secret Manager.HandledError@purista/coreA 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-serverPURISTA service that exposes command, stream and async queue-backed endpoints through Hono.HttpClient@purista/coreHTTP client with JSON helpers, timeout handling, tracing, metrics, and normalized errors.HttpEventBridge@purista/base-http-bridgeStores 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-storeHTTP client for the Infisical API used by `InfisicalSecretStore`.InfisicalSecretStore@purista/infisical-secret-storeSecret store backed by Infisical.InFlightExecutionTracker@purista/coreTracks active event bridge handler promises for drain and health reporting.Logger@purista/coreMqttBridge@purista/mqttbridgeEventBridge implementation for MQTT 5 brokers.NatsBridge@purista/natsbridgeEventBridge implementation for NATS core messaging with optional JetStream.NatsConfigStore@purista/nats-config-storeConfig store backed by a NATS JetStream key-value bucket.NatsQueueBridge@purista/nats-queue-bridgeStrict QueueBridge implementation backed by NATS JetStream streams and KV.NatsStateStore@purista/nats-state-storeState store backed by a NATS JetStream key-value bucket.

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

Interfaces

20 public symbols

ConfigStore@purista/coreInterface definition for config store adaptersEventBridge@purista/coreEvent transport adapter contract used by PURISTA services.GlobalContext@purista/coreContext passed to all submodulesHttpEventBridgeClient@purista/base-http-bridgeAdapter contract between HttpEventBridge and a sidecar or platform HTTP API.IEmitter@purista/coreILogger@purista/coreMemoryMetricRecord@purista/coreDeterministic metric record captured by the memory recorder.Options@purista/cliOptions used for converting strings to any case.PascalCaseOptions@purista/cliOptions used for converting strings to pascal/camel case.PuristaMetricDefinition@purista/coreDeclares one framework or application metric.PuristaMetricsRecorderInterface@purista/coreA provider-neutral recorder used by framework code and metric contexts.PuristaMetricsRuntimeOptions@purista/coreRuntime metrics options consumed by PURISTA recorders.QueueBridge@purista/coreQueue transport adapter contract used by PURISTA services and queue workers.RestClient@purista/coreREST API client abstraction for JSON-oriented HTTP calls.SecretStore@purista/coreInterface definition for a secret store implementationServiceClass@purista/coreThe ServiceClass interfaceStateStore@purista/coreInterface definition for state store implementationsStreamHandle@purista/coreStreamWriter@purista/coreTransformSchemaObjectOptions@purista/core

Functions

198 public symbols

addPathToOpenApi@purista/hono-http-serveraddPuristaAgent@purista/cliaddPuristaCommand@purista/cliaddPuristaQueue@purista/cliaddPuristaQueueWorker@purista/cliaddPuristaService@purista/cliaddPuristaStream@purista/cliaddPuristaSubscription@purista/cliaddServiceEndpoints@purista/k8s-sdkassertNonArrowFunction@purista/corecamelCase@purista/clicapitalCase@purista/clicollectAggregateStreamResult@purista/hono-http-serverconstantCase@purista/cliconvertEmitValidationsToSchema@purista/coreconvertInvokeValidationsToSchema@purista/coreconvertToCamelCase@purista/coreconvertToKebabCase@purista/coreconvertToPascalCase@purista/coreconvertToProjectFileCasing@purista/cliconvertToSnakeCase@purista/corecreateAgentImplementationFile@purista/clicreateAgentsFile@purista/clicreateAmqpConfigFile@purista/clicreateBiomeConfigFile@purista/clicreateClaudeFile@purista/clicreateCommandContextMock@purista/corecreateCommandTestHarness@purista/corecreateDaprConfigFile@purista/clicreateEntrypointFile@purista/clicreateErrorResponse@purista/corecreateEslintModuleConfigFile@purista/clicreateEventBridgeFile@purista/clicreateGitIgnoreFile@purista/clicreateHttpConfigFile@purista/clicreateHttpFile@purista/cli

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

Types

471 public symbols

addPrefixToObject@purista/coreHelper for better typescript type. All keys of given object must start with the given prefix. Otherwise Typescript will complain.AddPuristaQueueInput@purista/cliInput for generating a queue, its primary worker, and optional producer command.AddPuristaQueueWorkerInput@purista/cliInput for generating an additional worker for an existing queue.AgentDefinition@purista/coreAttached agent definition before expansion into service definitions.AgentDurableWorkspaceStore@purista/coreStructural durable workspace store accepted until the harness package version is bumped.AgentDurableWorkspaceStorePolicy@purista/coreAdapter-neutral durable workspace policy mirrored from `@purista/harness`.AgentExecutionDefinition@purista/coreInternal execution definition selected by exactly one agent execution setter.AgentExecutionKind@purista/coreExecution implementation kind used by an attached agent definition.AgentExecutionPolicy@purista/coreQueue execution policy applied to the generated agent worker and queue.AgentHandler@purista/coreRun function shape accepted by `AgentQueueBuilder.setRunFunction(...)`.AgentHandlerContext@purista/coreContext passed to an attached agent run function.AgentHandlerModelBindings@purista/coreTyped model handles exposed to an agent run function.AgentHarnessWorkflowOptions@purista/coreHarness-local agents registered together with a wrapped harness workflow.AgentHttpExposure@purista/coreHTTP projection metadata for the generated agent command or stream.AgentInvokeMap@purista/coreTyped child-agent invocation map exposed at `context.invoke.agents`.AgentManifest@purista/coreProvider-neutral manifest describing an attached PURISTA agent.AgentModelBinding@purista/coreDeclares a model alias required by an attached PURISTA agent.AgentModelCapability@purista/coreModel capability names supported by `@purista/harness` model bindings.AgentQueueBuilderTypes@purista/coreType accumulator used by `AgentQueueBuilder` to preserve typed schemas, tools, models, and metrics.AgentQueueResultPolicy@purista/coreControls how generated queues persist and/or emit agent worker completion metadata.AgentQueueResultPolicyMode@purista/coreStorage or event side effect used for queued agent run results.AgentResponseMode@purista/corePublic response contract exposed by the generated agent command or stream.AgentResponseModeOptions@purista/coreOptions for long-running agent response contracts.AgentRunEvent@purista/coreHarness run event decorated with PURISTA agent identity metadata.AgentRunIdentity@purista/coreStable run identity propagated through attached agent execution events and results.AgentRunResult@purista/coreAggregate result returned by an attached agent runtime.AgentRuntimeInvocationInput@purista/coreAggregate invocation input passed from generated PURISTA definitions into the agent runtime.AgentRuntimeModelBinding@purista/coreAgentRuntimeModelBindings@purista/coreRuntime model bindings keyed by every model alias declared on an agent builder.AgentRuntimeOptions@purista/coreRuntime options required to initialize attached agents for a service instance.AgentRuntimeRef@purista/coreMutable runtime reference bound when the owning service instance is created.AgentRuntimeStreamInvocationInput@purista/coreStreaming invocation input passed from generated PURISTA stream definitions into the agent runtime.AgentSandboxPolicy@purista/coreOptional sandbox adapter configuration passed through to the agent runtime.AgentSessionPolicy@purista/coreSession behavior used by the harness runtime for each agent run.AgentSkillCatalogEntry@purista/coreMetadata-only skill catalog entry exposed to attached agent handlers.AgentSkillContext@purista/coreHandler helper for resolving declared skill metadata without exposing skill bodies.

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

Enums

10 public symbols

DaprPubSubStatusEnum@purista/dapr-sdkStatus values returned to Dapr Pub/Sub callbacks.EBMessageType@purista/coreType of event bridge messageEventBridgeCommandTransport@purista/coreCommand request/response transport strategy used by an event bridge.EventBridgeLateResponseHandling@purista/corePolicy for command responses that arrive after invocation timeout.EventBridgeResponseConfirmationLevel@purista/coreConfirmation level available for command responses.EventBridgeStreamLateFrameHandling@purista/corePolicy for stream frames that arrive after stream timeout.PuristaSpanName@purista/coreOpentelemetry span names used by PURISTA frameworkPuristaSpanTag@purista/coreOpentelemetry tags set by PURISTA frameworkStatusCode@purista/coreMessage and error status codes. The codes are based on HTTP status codesStoreType@purista/core

Variables

61 public symbols

blueprintIds@purista/cliOrdered list of built-in project blueprint identifiers.CONFIG_FILE_NAME@purista/coreconfigFullSchema@purista/coreconfigRoute@purista/dapr-sdkDapr actor configuration endpoint.configSchema@purista/coreDAPR_API_VERSION@purista/dapr-sdkDefault Dapr HTTP API version used by sidecar requests.DEFAULT_API_MOUNT_PATH@purista/hono-http-serverDefault base path for generated HTTP command and stream endpoints.DEFAULT_DAPR_HOST@purista/dapr-sdkDefault HTTP host of a local Dapr sidecar.DEFAULT_DAPR_PORT@purista/dapr-sdkDefault HTTP port of a local Dapr sidecar.DEFAULT_MAX_REQUEST_BODY_BYTES@purista/hono-http-serverDefault maximum size, in bytes, accepted for an HTTP request body.defaultQueueLifecycleConfig@purista/coreOpinionated defaults for queues so builders can omit lifecycle overrides yet still get resilient behaviour.eventBridgeClientConfigSchema@purista/coreExternalDocumentationObjectSchema@purista/hono-http-serverSchema for OpenAPI external documentation objects.frameworkMetricDefinitions@purista/corePURISTA framework metric catalog.getCommandResponseSubscriptionTopic@purista/mqttbridgeBuilds the MQTT topic filter used to receive command responses for the current bridge instance.getCommandSubscriptionTopic@purista/mqttbridgeBuilds the MQTT topic filter used by command handlers for one service address.getCommandSubscriptionTopic@purista/natsbridgeBuilds the NATS subject used by command handlers for one service address.getQueryDefintion@purista/hono-http-serverBackward-compatible alias for the misspelled query definition helper.getSharedTopicName@purista/mqttbridgeWraps a topic with the configured MQTT shared-subscription prefix and group.getSubscriptionTopic@purista/mqttbridgeBuilds the MQTT topic filter for a PURISTA subscription definition.getSubscriptionTopic@purista/natsbridgeBuilds the NATS subject filter for a PURISTA subscription definition.getTopicName@purista/mqttbridgeCalculates the MQTT topic name for a message which should be sent.getTopicName@purista/natsbridgeCalculates the NATS topic name for a message which should be sent.handleCommandResponse@purista/mqttbridgeHandles MQTT command responses for pending invocations.honoServiceInfo@purista/hono-http-serverService metadata for version 1 of the built-in Hono HTTP service.honoServiceV1ConfigSchema@purista/hono-http-serverRuntime configuration schema for the Hono HTTP service.honoV1Service@purista/hono-http-serverBuilt-in Hono HTTP service definition.honoV1ServiceBuilder@purista/hono-http-serverBuilder for the built-in Hono HTTP service.honoV1ServiceCommandsToRestApiInputPayloadSchema@purista/hono-http-serverSchema for dynamic endpoint metadata received from service definition info messages.httpClientConfigSchema@purista/coreinfoMessageTypes@purista/coreInfoObjectSchema@purista/hono-http-serverSchema for the OpenAPI info object.MIN_CONTENT_SIZE_FOR_COMPRESSION@purista/coreOPENAPI_DEFAULT_INFO@purista/hono-http-serverDefault OpenAPI info block used when no application-specific metadata is supplied.ProblemDetailsObjectSchema@purista/hono-http-serverSchema for RFC 9457 problem details configuration.projectBlueprintRegistry@purista/cliRegistry of built-in project blueprints used by `planProjectGeneration`.

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