CAPABILITIES - common/src/index.ts - Setu-TS documentation

variable CAPABILITIES

Since 0.1.0

Standard capability tokens provided by the first-party plugins.

Consumers must reference tokens through this constant rather than repeating string literals:

Examples

Example 1

import { CAPABILITIES } from '@setu-ts/common';

const logger = ctx.services.get<ILogger>(CAPABILITIES.LOGGER);

Properties



RUNTIME: string

Runtime services provided by the RuntimePlugin. Mandatory in every application.



LOGGER: string

Structured logger.



CONFIG: string

Configuration access.



VALIDATION: string

Request/data validation.



DATABASE: string

Database access (repositories, unit of work).



CACHE: string

Key/value caching.



EVENTS: string

In-memory domain event bus.



MESSAGING: string

Message broker for integration events.



AUTH: string

Authentication service.



AUTHORIZATION: string

Authorization service (RBAC, permissions).



JWT: string

JWT sign/verify service.



SCHEDULER: string

Job scheduling (cron, delayed, recurring).



METRICS: string

Metrics collection.



HEALTH: string

Health checks.



OPENAPI: string

OpenAPI spec contribution and generation.



TELEMETRY: string

Distributed tracing.



SECRETS: string

Secret management.



AUDIT: string

Audit trail logging.



RESILIENCE: string

Resilience patterns (circuit breaker, retry, timeout, bulkhead).



STORAGE: string

File storage.



MAIL: string

Email sending.



NOTIFICATION: string

Multi-channel notifications.



FEATURE_FLAGS: string

Feature flag evaluation.



QUEUE: string

Background job queue.



CQRS: string

CQRS facade.



COMMAND_BUS: string

Command bus (CQRS).



QUERY_BUS: string

Query bus (CQRS).



MULTI_TENANCY: string

Multi-tenancy service.



WORKER_POOL: string

Worker-thread pool for CPU-bound tasks.



DI_CONTAINER: string

Optional dependency injection container.



HTTP_ADAPTER: string

HTTP server adapter — the runtime plugin registers its IHttpAdapter here.



SSE: string

Server-Sent Events (SSE) hub for in-process real-time broadcasting.



WEBSOCKET: string

WebSocket hub for bidirectional real-time messaging.



REALTIME_BACKPLANE: string

Pub/sub transport carrying real-time broadcasts between application instances, so WebSocket rooms and SSE channels fan out across replicas. Consumed optionally — absent means purely in-process broadcasting.



SSR: string

Server-side rendering (SSR) — React Router or similar framework.



SESSION: string

Cookie-backed sessions for server-rendered applications.



SERVICE_DISCOVERY: string

Service discovery — logical service name to reachable instances.



HEALTH_INDICATOR: string

Health indicator contributions (multi-provider).



METRIC_REGISTRATION: string

Metric registration contributions (multi-provider).



OPENAPI_SCHEMA: string

OpenAPI schema contributions (multi-provider).



CLI_COMMAND: string

CLI command contributions (multi-provider).



DECORATOR_HANDLER: string

Decorator handler contributions (multi-provider).



METADATA_STORE: string

Decorator metadata store (from the DecoratorPlugin, when registered).



GRPC: string

gRPC plugin — server-side Connect/gRPC/gRPC-Web co-serving.



CLOUDFLARE: string

Cloudflare Workers platform bindings (KV, R2, D1, Queues, service and Durable Object namespaces) published as one typed accessor.



GRAPHQL: string

GraphQL plugin — schema-first and code-first GraphQL-over-HTTP.



STATIC_FILES: string

Static file serving plugin.



VIEW: string

View rendering (server-rendered HTML) — an IViewEngine that turns a view component and its props into an HTML string, so a handler can answer with markup it did not concatenate by hand.

Examples

Example 1

Properties

Usage