nest-profiler-auth

API reference for @eleven-labs/nest-profiler-auth — authentication and JWT claims collector.

AuthCollectorModuleOptions

Options passed to AuthCollectorModule.forRoot().

Prop

Type

SecurityContext

The data structure populated by the auth collector and stored in profile.security. Defined in @eleven-labs/nest-profiler.

interface SecurityContext {
  isAuthenticated: boolean;
  user?: Record<string, unknown>; // request.user, with masked fields
  roles?: string[]; // user.roles or user.role (normalized)
  jwtClaims?: Record<string, unknown>; // decoded JWT payload (no verification)
}

See SecurityContext in the core package reference.

Automatic masking

Public exports

import { AuthCollectorModule } from '@eleven-labs/nest-profiler-auth';
import { AuthCollector } from '@eleven-labs/nest-profiler-auth';

import type { AuthCollectorModuleOptions } from '@eleven-labs/nest-profiler-auth';

Setup

// In AuthModule (or any module that sets request.user):
import { AuthCollectorModule } from '@eleven-labs/nest-profiler-auth';

@Module({
  imports: [
    AuthCollectorModule.forRoot({
      maskUserFields: ['password', 'refreshToken'],
    }),
  ],
})
export class AuthModule {}

Prerequisite: A guard or middleware that sets request.user (Passport, custom JWT guard, etc.). The collector reads request.user and the Authorization header from the per-request CLS context.