@playstack/nest-errors

@playstack/nest-errors attaches an existing @playstack/errors reporter to NestJS dependency injection and exception boundaries.

Install

npm install @playstack/core @playstack/errors @playstack/nest-errors @nestjs/common @nestjs/core reflect-metadata rxjs

Compose it in the application module

import { Module } from '@nestjs/common'
import {
  PlaystackErrorsFilter,
  PlaystackErrorsModule,
} from '@playstack/nest-errors'

@Module({
  imports: [
    PlaystackErrorsModule.forRoot({
      errors,
      captureHttpExceptions: false,
      resolveCaptureOptions(exception, host) {
        const request = host.switchToHttp().getRequest<AuthenticatedRequest>()
        return {
          accountId: request.account?.id,
          userId: request.user?.id,
          tags: { route: request.route?.path ?? 'unknown' },
        }
      },
    }),
  ],
})
export class AppModule {}

const app = await NestFactory.create(AppModule)
app.useGlobalFilters(app.get(PlaystackErrorsFilter))

The module exports the filter instead of installing an APP_FILTER implicitly. Apply it globally, to a controller, or to an individual route. Nest’s original HTTP response still passes through BaseExceptionFilter after capture.

Configuration reference

Unknown exceptions and HTTP responses of 500 or greater are captured by default. Default metadata includes framework, transport type, status code, and an appropriate warning or error severity.

For configuration that depends on other Nest providers, use PlaystackErrorsModule.forRootAsync({ imports, inject, useFactory }).

Injection bridge

Inject PLAYSTACK_ERROR_REPORTER to receive the exact configured reporter in another provider:

@Injectable()
class JobRunner {
  constructor(
    @Inject(PLAYSTACK_ERROR_REPORTER)
    private readonly errors: ErrorReporter,
  ) {}
}

NEST_ERRORS_OPTIONS, PLAYSTACK_ERROR_REPORTER, and PlaystackErrorsFilter are exported from the dynamic module.

Boundary

The adapter never reads request bodies, headers, cookies, or URLs automatically. The application decides which opaque identity and route metadata are safe to attach. It also owns reporting drivers, vendor SDK lifecycle, filter placement, and every Nest peer dependency.

Host-owned responses

A response-free capture helper and pure exception mapping allow the host to keep its HTTP envelope. Capture must not double-send or turn expected domain/tenancy errors into 500s. Rate-limit custom bodies retain library-owned status and headers. Use application integration tests for sanitized unknown errors, expected 4xx responses and reporter failure.

API entry points and requirements

Reference snapshot: @playstack/nest-errors@0.1.0-beta.1. Import only the entry point your runtime needs. Paths below are relative to the installed package; use Go to Definition in your editor to inspect exact parameters, return types and overloads. Do not import the declaration-file paths directly.

Node.js engine requirement: >=20. This is not a claim that every entry point works in browsers or Workers.

Peer dependencies

Keep existing framework versions that satisfy these ranges. Install optional peers only when using the corresponding adapter. The package manager resolves ordinary dependencies separately.

For a complete first program, start with Getting started. For API lookup and partial-example conventions, see Reading the reference. Provider failures, lifecycle requirements and application responsibilities remain described in the guide above; types alone do not establish production safety.