Packages · @purista/dapr-sdk

@purista/dapr-sdk

SDK and helper to run PURISTA services with Dapr.

@purista/dapr-sdk

Signature

@purista/dapr-sdk.tstypescript
@purista/dapr-sdk

Examples

example-1.tstypescript
import { DaprConfigStore, DaprEventBridge, DaprSecretStore, DaprStateStore } from '@purista/dapr-sdk'
const eventBridge = new DaprEventBridge({
   spanProcessor,
   logger,
   serve,
 })

const secretStore = new DaprSecretStore({ logger, secretStoreName: 'local-secret-store' })
const stateStore = new DaprStateStore({ logger, stateStoreName: 'local-state-store' })
const configStore = new DaprConfigStore({ logger, configStoreName: 'local-config-store' })

// start the services ...

await eventBridge.start()

Enumerations

1 entry

DaprPubSubStatusEnum

Enums

Source
DaprPubSubStatusEnum.tstypescript
enum DaprPubSubStatusEnum

Status values returned to Dapr Pub/Sub callbacks.

Classes

4 entries

DaprClient

Classes

Source
DaprClient.tstypescript
class DaprClient

HTTP client for Dapr sidecar APIs used by the Dapr event bridge.

DaprConfigStore

Classes

Source
DaprConfigStore.tstypescript
class DaprConfigStore

Config store adapter backed by Dapr configuration components.

DaprSecretStore

Classes

Source
DaprSecretStore.tstypescript
class DaprSecretStore

Secret store adapter backed by a Dapr secret component.

DaprStateStore

Classes

Source
DaprStateStore.tstypescript
class DaprStateStore

State store adapter backed by a Dapr state component.

Type Aliases

29 entries

BulkSubscribeConfig

Types

Source
BulkSubscribeConfig.tstypescript
type BulkSubscribeConfig = void

BulkSubscribeConfig defines the configuration for a bulk subscription

BulkSubscribeOptions

Types

Source
BulkSubscribeOptions.tstypescript
type BulkSubscribeOptions = void

BulkSubscribeOptions enlists the options for bulk subscribe

BulkSubscribeResponse

Types

Source
BulkSubscribeResponse.tstypescript
type BulkSubscribeResponse = void

BulkSubscribeResponse is the response for a bulk subscribe request

BulkSubscribeResponseEntry

Types

Source
BulkSubscribeResponseEntry.tstypescript
type BulkSubscribeResponseEntry = void

BulkSubscribeResponseEntry is the response entry for a bulk subscribe request

DaprClientConfig

Types

Source
DaprClientConfig.tstypescript
type DaprClientConfig = void

Configuration for clients that call the local Dapr sidecar.

DaprConfigStoreConfig

Types

Source
DaprConfigStoreConfig.tstypescript
type DaprConfigStoreConfig = void

Configuration for DaprConfigStore.

DaprEventBridgeConfig

Types

Source
DaprEventBridgeConfig.tstypescript
type DaprEventBridgeConfig = Prettify<HttpEventBridgeConfig & { clientConfig: DaprClientConfig }>

Configuration for DaprEventBridge.

DaprPubSubRouteType

Types

Source
DaprPubSubRouteType.tstypescript
type DaprPubSubRouteType = void

Rule-based Dapr Pub/Sub route configuration.

DaprPubSubRuleType

Types

Source
DaprPubSubRuleType.tstypescript
type DaprPubSubRuleType = void

DaprPubSubRuleType defines a rule set

DaprPubSubType

Types

Source
DaprPubSubType.tstypescript
type DaprPubSubType = void

DaprPubSubType is the Type used by the Dapr API to interface with its PubSub component

DaprSecretStoreConfig

Types

Source
DaprSecretStoreConfig.tstypescript
type DaprSecretStoreConfig = void

Configuration for DaprSecretStore.

DaprStateStoreConfig

Types

Source
DaprStateStoreConfig.tstypescript
type DaprStateStoreConfig = void

Configuration for DaprStateStore.

KeyValueType

Types

Source
KeyValueType.tstypescript
type KeyValueType = object

Dapr metadata key-value map.

PubSubBulkPublishApiResponse

Types

Source
PubSubBulkPublishApiResponse.tstypescript
type PubSubBulkPublishApiResponse = void

Response from a bulk publish API request.

PubSubBulkPublishApiResponseStatus

Types

Source
PubSubBulkPublishApiResponseStatus.tstypescript
type PubSubBulkPublishApiResponseStatus = void

Failed entry reported by Dapr's bulk publish API response.

PubSubBulkPublishEntry

Types

Source
PubSubBulkPublishEntry.tstypescript
type PubSubBulkPublishEntry = void

PubSubBulkPublishEntry defines an entry in a bulk publish request.

PubSubBulkPublishMessage

Types

Source
PubSubBulkPublishMessage.tstypescript
type PubSubBulkPublishMessage = PubSubBulkPublishMessageExplicit | object | string

PubSubBulkPublishMessage is a message in a bulk publish request.

PubSubBulkPublishMessageExplicit

Types

Source
PubSubBulkPublishMessageExplicit.tstypescript
type PubSubBulkPublishMessageExplicit = void

Explicit Dapr bulk publish message with per-entry metadata.

PubSubBulkPublishResponse

Types

Source
PubSubBulkPublishResponse.tstypescript
type PubSubBulkPublishResponse = void

PubSubBulkPublishResponse defines the response from a bulk publish request.

PubSubBulkPublishResponseFailedEntry

Types

Source
PubSubBulkPublishResponseFailedEntry.tstypescript
type PubSubBulkPublishResponseFailedEntry = void

Failed entry collected while preparing or sending a bulk publish request.

PubSubPublishOptions

Types

Source
PubSubPublishOptions.tstypescript
type PubSubPublishOptions = void

Options forwarded to Dapr Pub/Sub publish operations.

PubSubPublishResponseType

Types

Source
PubSubPublishResponseType.tstypescript
type PubSubPublishResponseType = void

PubSubPublishResponseType defines the response from a publish.

PubSubSubscriptionOptionsType

Types

Source
PubSubSubscriptionOptionsType.tstypescript
type PubSubSubscriptionOptionsType = void

PubSubSubscriptionOptionsType defines the options we can pass while subscribing

PubSubSubscriptionsType

Types

Source
PubSubSubscriptionsType.tstypescript
type PubSubSubscriptionsType = object

This defines the entire object containing pubsubNames

PubSubSubscriptionTopicRoutesType

Types

Source
PubSubSubscriptionTopicRoutesType.tstypescript
type PubSubSubscriptionTopicRoutesType = object

This defines the routes object

PubSubSubscriptionTopicRouteType

Types

Source
PubSubSubscriptionTopicRouteType.tstypescript
type PubSubSubscriptionTopicRouteType = void

This defines the routeName object

PubSubSubscriptionTopicType

Types

Source
PubSubSubscriptionTopicType.tstypescript
type PubSubSubscriptionTopicType = void

This defines the topicName object

PubSubSubscriptionType

Types

Source
PubSubSubscriptionType.tstypescript
type PubSubSubscriptionType = object

This defines the pubsubName object

TypeDaprPubSubCallback

Types

Source
TypeDaprPubSubCallback.tstypescript
type TypeDaprPubSubCallback = (data: unknown, headers: Record<string, string>) => Promise<unknown | undefined>

Callback invoked for Dapr Pub/Sub message delivery.

Variables

5 entries

configRoute

Variables

Source
configRoute.tstypescript
const configRoute: RouterFunction

Dapr actor configuration endpoint.

DAPR_API_VERSION

Variables

Source
DAPR_API_VERSION.tstypescript
const DAPR_API_VERSION: "v1.0"

Default Dapr HTTP API version used by sidecar requests.

DEFAULT_DAPR_HOST

Variables

Source
DEFAULT_DAPR_HOST.tstypescript
const DEFAULT_DAPR_HOST: "http://127.0.0.1"

Default HTTP host of a local Dapr sidecar.

DEFAULT_DAPR_PORT

Variables

Source
DEFAULT_DAPR_PORT.tstypescript
const DEFAULT_DAPR_PORT: "3500"

Default HTTP port of a local Dapr sidecar.

puristaVersion

Variables

Source
puristaVersion.tstypescript
const puristaVersion: "3.2.3"

Functions

2 entries

getDefaultClientConfig

Functions

Source
getDefaultClientConfig.tstypescript
getDefaultClientConfig(): { appPrefix: string; daprApiToken: undefined; daprApiVersion: string; daprHost: string; daprPort: string; isKeepAlive: boolean; ... }

getDefaultConfig

Functions

Source
getDefaultConfig.tstypescript
getDefaultConfig(): { apiPrefix: string; clientConfig: { appPrefix: string; daprApiToken: undefined; daprApiVersion: string; daprHost: string; daprPort: string; isKeepAlive: boolean; ... }; commandPayloadAsCloudEvent: boolean; enableRestApiExpose: boolean; name: string; pathPrefix: string; ... }

Event bridge

1 entry

DaprEventBridge

Classes

Source
DaprEventBridge.tstypescript
class DaprEventBridge

Event bridge that connects PURISTA services to the local Dapr sidecar.