@playstack/nest-audit

@playstack/nest-audit makes route-level audit intent visible in NestJS metadata while reusing an existing @playstack/audit recorder and retention policy.

Install

After confirming preview access, install the package at your application's shared Playstack version:

npm install --save-exact @playstack/nest-audit@0.1.0-beta.1

Check the peer requirements below before choosing a runtime or provider.

Compose explicit route audit

PlaystackAuditModule.forRoot({
  audit,
  onFailure: (error) => errors.captureError(error),
})

@UseInterceptors(PlaystackAuditInterceptor)
@Audited({
  map: (request, response) => ({
    scopeType: 'account',
    scopeId: request.playstackAccount.accountId,
    actorType: 'user',
    actorId: request.playstackSession.userId,
    action: 'project.created',
    resourceType: 'project',
    resourceId: response.id,
  }),
})
@Post('/projects')
create() {}

Configuration and bridge properties

Module construction validates that the recorder carries an immutable AuditRetentionPolicy, failing before startup when it is absent or malformed. forRootAsync({ imports, inject, useFactory }) supports DI-based composition.

The interceptor records successful responses only. It is queued/best effort: failures reach onFailure and never turn an already-committed mutation into an HTTP failure.

Boundary

Use transactional @playstack/events audit handlers for security-critical package operations. This adapter does not infer important operations, replace domain events, install itself globally, or own persistence; application routes opt in explicitly.

API entry points and requirements

Reference snapshot: @playstack/nest-audit@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.