Setu-TS
    Preparing search index...

    Variable CAPABILITIESConst

    CAPABILITIES: {
        AUDIT: "audit";
        AUTH: "authentication";
        AUTH_SESSION: "auth-session";
        AUTHORIZATION: "authorization";
        AUTHORIZATION_DIAGNOSTICS: "authorization-diagnostics";
        AUTHORIZATION_POLICIES: "authorization-policies";
        CACHE: "cache";
        CACHE_DIAGNOSTICS: "cache-diagnostics";
        CLI_COMMAND: "cli-command";
        CLOUDFLARE: "cloudflare";
        COMMAND_BUS: "command-bus";
        CONFIG: "config";
        CONFIG_DIAGNOSTICS: "config-diagnostics";
        CQRS: "cqrs";
        DATABASE: "database";
        DECORATOR_HANDLER: "decorator-handler";
        DI_CONTAINER: "di-container";
        EVENTS: "events";
        EVENTS_DIAGNOSTICS: "event-diagnostics";
        FEATURE_FLAGS: "feature-flags";
        GRAPHQL: "graphql";
        GRPC: "grpc";
        HEALTH: "health";
        HEALTH_DIAGNOSTICS: "health-diagnostics";
        HEALTH_INDICATOR: "health-indicator";
        HTTP_ADAPTER: "http-adapter";
        IDEMPOTENCY: "idempotency";
        INBOX: "inbox";
        JWT: "jwt";
        LOCAL_DIAGNOSTICS_LISTENER: "local-diagnostics-listener";
        LOCALIZATION: "localization";
        LOGGER: "logger";
        MAIL: "mail";
        MESSAGING: "messaging";
        METADATA_STORE: "metadata-store";
        METRIC_REGISTRATION: "metric-registration";
        METRICS: "metrics";
        MULTI_TENANCY: "multi-tenancy";
        NOTIFICATION: "notification";
        OPENAPI: "openapi";
        OPENAPI_SCHEMA: "openapi-schema";
        OUTBOUND_HTTP_DIAGNOSTICS: "outbound-http-diagnostics";
        OUTBOX: "outbox";
        QUERY_BUS: "query-bus";
        QUEUE: "queue";
        QUEUE_DIAGNOSTICS: "queue-diagnostics";
        REALTIME_BACKPLANE: "realtime-backplane";
        REALTIME_DIAGNOSTICS: "realtime-diagnostics";
        RESILIENCE: "resilience";
        RUNTIME: "runtime";
        SCHEDULER: "scheduler";
        SCHEDULER_DIAGNOSTICS: "scheduler-diagnostics";
        SECRETS: "secrets";
        SERVICE_DISCOVERY: "service-discovery";
        SESSION: "session";
        SSE: "sse";
        SSR: "ssr";
        STATIC_FILES: "static-files";
        STORAGE: "storage";
        STORAGE_DIAGNOSTICS: "storage-diagnostics";
        TELEMETRY: "telemetry";
        TRACE_DIAGNOSTICS: "trace-diagnostics";
        VALIDATION: "validation";
        VIEW: "view";
        WEBSOCKET: "websocket";
        WORKER_POOL: "worker-pool";
    } = ...

    Standard capability tokens provided by the first-party plugins.

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

    Type Declaration

    • ReadonlyAUDIT: "audit"

      Audit trail logging.

    • ReadonlyAUTH: "authentication"

      Authentication service.

    • ReadonlyAUTH_SESSION: "auth-session"

      The single owner of "this session is signed in as this principal" — an IAuthSessionService the AuthPlugin registers when its signIn option is configured. Every later authentication feature (second factor, passkeys, SAML) creates, holds back, or promotes that one record through this token, instead of each keeping a private copy of the same session write.

      0.8.0

    • ReadonlyAUTHORIZATION: "authorization"

      Authorization service (RBAC, permissions).

    • ReadonlyAUTHORIZATION_DIAGNOSTICS: "authorization-diagnostics"

      Authorization decision explanations (M98h) — an IAuthorizationDiagnosticsSource the AuthPlugin always registers under this token (a disabled-answering one when observation was not opted into; an unsupported-answering one when RBAC is absent, the registry lacks the non-resolving identity predicate, or the authorization provider was replaced). The DiagnosticsPlugin consumes it optionally to serve GET /v1/authorization. A read never evaluates a role, permission or wildcard, and never resolves a service.

    • ReadonlyAUTHORIZATION_POLICIES: "authorization-policies"

      Authorization policies — an IAuthorizationPolicyService the AuthPlugin always registers: an asynchronous, target-aware check over named policies, beside (never replacing) the synchronous RBAC service under AUTHORIZATION. Consumed by the requirePolicy guard and by DecoratorPlugin's @RequirePolicy and class-form policies.

      0.9.0

    • ReadonlyCACHE: "cache"

      Key/value caching.

    • ReadonlyCACHE_DIAGNOSTICS: "cache-diagnostics"

      Minimized cache operation counters (M98i) — an ICacheDiagnosticsSource every CachePlugin instance registers under this token with { multi: true }, without claiming it in provides, so named cache instances never collide. The DiagnosticsPlugin reads every source to serve GET /v1/cache. A read never performs a cache operation.

    • ReadonlyCLI_COMMAND: "cli-command"

      CLI command contributions (multi-provider).

    • ReadonlyCLOUDFLARE: "cloudflare"

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

    • ReadonlyCOMMAND_BUS: "command-bus"

      Command bus (CQRS).

    • ReadonlyCONFIG: "config"

      Configuration access.

    • ReadonlyCONFIG_DIAGNOSTICS: "config-diagnostics"

      Value-free configuration provenance (M98e) — an IConfigDiagnosticsSource the ConfigPlugin registers under this token and the DiagnosticsPlugin consumes optionally to serve GET /v1/config. Absent means the connector answers a typed unsupported snapshot; it never reads a configuration value, enumerates keys, or invokes a custom IConfig implementation.

    • ReadonlyCQRS: "cqrs"

      CQRS facade.

    • ReadonlyDATABASE: "database"

      Database access (repositories, unit of work).

    • ReadonlyDECORATOR_HANDLER: "decorator-handler"

      Decorator handler contributions (multi-provider).

    • ReadonlyDI_CONTAINER: "di-container"

      Optional dependency injection container.

    • ReadonlyEVENTS: "events"

      In-memory domain event bus.

    • ReadonlyEVENTS_DIAGNOSTICS: "event-diagnostics"

      Minimized event-dispatch observations (M98j) — an IEventDiagnosticsSource every EventsPlugin instance registers under this token with { multi: true }, without claiming it in provides, so multiple bus instances never collide. The DiagnosticsPlugin reads every source to serve GET /v1/event; no registered source means the connector answers a typed unsupported response. A read never publishes an event or invokes a handler.

    • ReadonlyFEATURE_FLAGS: "feature-flags"

      Feature flag evaluation.

    • ReadonlyGRAPHQL: "graphql"

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

    • ReadonlyGRPC: "grpc"

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

    • ReadonlyHEALTH: "health"

      Health checks.

    • ReadonlyHEALTH_DIAGNOSTICS: "health-diagnostics"

      Minimized health observations (M98d) — an IHealthDiagnosticsSource the HealthPlugin registers under this token and the DiagnosticsPlugin consumes optionally to serve GET /v1/health. Absent means the connector answers a typed unsupported snapshot; it never runs an indicator itself.

    • ReadonlyHEALTH_INDICATOR: "health-indicator"

      Health indicator contributions (multi-provider).

    • ReadonlyHTTP_ADAPTER: "http-adapter"

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

    • ReadonlyIDEMPOTENCY: "idempotency"

      Idempotency — an IIdempotencyService whose middleware and behavior members build the HTTP and ingress idempotency paths over one store. The request/reply types and the entry points live in @setu-ts/idempotency-plugin; only the port, the service contract, the option types and this token live in common.

    • ReadonlyINBOX: "inbox"

      Consumer inbox — the IInbox the messaging plugin registers when its inbox option is set (inbox.<name> for a named messaging instance). Records each handled integration event in the handler's own database transaction, so a duplicate delivery is acknowledged without running the handler again.

      0.9.0

    • ReadonlyJWT: "jwt"

      JWT sign/verify service.

    • ReadonlyLOCAL_DIAGNOSTICS_LISTENER: "local-diagnostics-listener"

      Runtime-owned local diagnostics listener — the single IPv4-loopback port the RuntimePlugin can bind for the local diagnostics connector (ILocalDiagnosticsListenerFactory). Provided by the RuntimePlugin; consumed by the DiagnosticsPlugin. Not a generic second HTTP server API.

    • ReadonlyLOCALIZATION: "localization"

      Localization — an ILocalizer holding the application's message catalogues per locale, bound to a request's resolved IRequest.locale through the localization plugin's localizerFor(ctx).

    • ReadonlyLOGGER: "logger"

      Structured logger.

    • ReadonlyMAIL: "mail"

      Email sending.

    • ReadonlyMESSAGING: "messaging"

      Message broker for integration events.

    • ReadonlyMETADATA_STORE: "metadata-store"

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

    • ReadonlyMETRIC_REGISTRATION: "metric-registration"

      Metric registration contributions (multi-provider).

    • ReadonlyMETRICS: "metrics"

      Metrics collection.

    • ReadonlyMULTI_TENANCY: "multi-tenancy"

      Multi-tenancy service.

    • ReadonlyNOTIFICATION: "notification"

      Multi-channel notifications.

    • ReadonlyOPENAPI: "openapi"

      OpenAPI spec contribution and generation.

    • ReadonlyOPENAPI_SCHEMA: "openapi-schema"

      OpenAPI schema contributions (multi-provider).

    • ReadonlyOUTBOUND_HTTP_DIAGNOSTICS: "outbound-http-diagnostics"

      Minimized outbound HTTP attempt observations (M98n) — an IOutboundHttpDiagnosticsSource the SDK's createObservedFetch helper registers, through its returned plugin, under this token with { multi: true } and without claiming it in provides. The SDK writes this value as a literal (so its common imports stay type-only), pinned by a test. The DiagnosticsPlugin reads every source to serve GET /v1/outbound-http; no registered source means a typed unsupported response. A read never performs a request.

    • ReadonlyOUTBOX: "outbox"

      Transactional outbox — the IOutbox the messaging plugin registers when its outbox option is set (outbox.<name> for a named messaging instance). Writes an integration event in the caller's own database transaction and relays it to the broker afterwards.

      0.9.0

    • ReadonlyQUERY_BUS: "query-bus"

      Query bus (CQRS).

    • ReadonlyQUEUE: "queue"

      Background job queue.

    • ReadonlyQUEUE_DIAGNOSTICS: "queue-diagnostics"

      Minimized queue observations (M98f) — an IQueueDiagnosticsSource every QueuePlugin instance registers under this token with { multi: true }, without claiming it in provides, so named queue instances never collide. The DiagnosticsPlugin reads every source to serve GET /v1/queues; no registered source means the connector answers a typed unsupported batch. A read never reserves, settles or counts a job.

    • ReadonlyREALTIME_BACKPLANE: "realtime-backplane"

      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.

    • ReadonlyREALTIME_DIAGNOSTICS: "realtime-diagnostics"

      Minimized realtime lifecycle observations (M98l) — an IRealtimeDiagnosticsSource the WebSocket, SSE and realtime-backplane plugins each register under this token with { multi: true }, without claiming it in provides. The DiagnosticsPlugin reads every source to serve GET /v1/realtime; no registered source means the connector answers a typed unsupported response. A read never sends, closes, publishes, subscribes, or creates or enumerates a room or channel.

    • ReadonlyRESILIENCE: "resilience"

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

    • ReadonlyRUNTIME: "runtime"

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

    • ReadonlySCHEDULER: "scheduler"

      Job scheduling (cron, delayed, recurring).

    • ReadonlySCHEDULER_DIAGNOSTICS: "scheduler-diagnostics"

      Scheduler execution observations (M98k) — an ISchedulerDiagnosticsSource every SchedulerPlugin instance registers under this token with { multi: true }, without claiming it in provides, so the diagnostics token never collides with another provider of it (an application registers at most one SchedulerPlugin — its plugin name is fixed — but other code may contribute a source). The DiagnosticsPlugin reads every source to serve GET /v1/scheduler. A read never acquires a lock, invokes a handler, or claims cluster completeness — a skipped local fire is not a globally missed execution.

    • ReadonlySECRETS: "secrets"

      Secret management.

    • ReadonlySERVICE_DISCOVERY: "service-discovery"

      Service discovery — logical service name to reachable instances.

    • ReadonlySESSION: "session"

      Cookie-backed sessions for server-rendered applications.

    • ReadonlySSE: "sse"

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

    • ReadonlySSR: "ssr"

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

    • ReadonlySTATIC_FILES: "static-files"

      Static file serving plugin.

    • ReadonlySTORAGE: "storage"

      File storage.

    • ReadonlySTORAGE_DIAGNOSTICS: "storage-diagnostics"

      Minimized storage operation observations (M98m) — an IStorageDiagnosticsSource every StoragePlugin instance registers under this token with { multi: true }, without claiming it in provides, so multiple storage instances never collide. The DiagnosticsPlugin reads every source to serve GET /v1/storage; no registered source means the connector answers a typed unsupported response. A read never performs a storage operation, resolves the storage capability, or probes a backend.

    • ReadonlyTELEMETRY: "telemetry"

      Distributed tracing.

    • ReadonlyTRACE_DIAGNOSTICS: "trace-diagnostics"

      Minimized distributed-tracing observations (M98g) — an ITraceDiagnosticsSource the TelemetryPlugin always registers under this token (a disabled or unsupported-answering one when observation was not opted into or the tracing stack cannot supply completed spans). The DiagnosticsPlugin consumes it optionally to serve GET /v1/traces. A read never starts, exports or flushes a span.

    • ReadonlyVALIDATION: "validation"

      Request/data validation.

    • ReadonlyVIEW: "view"

      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.

    • ReadonlyWEBSOCKET: "websocket"

      WebSocket hub for bidirectional real-time messaging.

    • ReadonlyWORKER_POOL: "worker-pool"

      Worker-thread pool for CPU-bound tasks.

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

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

    0.1.0