@playstack/nest-feedback

@playstack/nest-feedback mounts POST /v1/feedback, the anonymous intake route playstack feedback posts to, and exports the intake for hosts that need it elsewhere.

Install

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

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

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

Configure

import { Module } from '@nestjs/common'
import { PlaystackFeedbackModule } from '@playstack/nest-feedback'
import { PrismaFeedbackStore } from '@playstack/feedback/prisma'

@Module({
  imports: [
    PlaystackFeedbackModule.forRoot({
      store: new PrismaFeedbackStore(prisma, { outbox }),
      limiter: { consume: ({ ip }) => limiter.consume('feedback.ip', { subjects: { ip } }) },
      hashAddress: (ip) => keyedHash(ip),
      // The client address per your reviewed proxy policy; without it the
      // socket address is used and forwarded headers are never trusted.
      clientAddress: (request) => trustedClientAddress(request),
    }),
  ],
})
export class ApplicationModule {}

forRootAsync({ imports, inject, useFactory }) resolves the same options from application providers. The module is not global and exports NEST_FEEDBACK_OPTIONS and PLAYSTACK_FEEDBACK_INTAKE.

HTTP contract

The route reads the client address before the body, so a limited address never costs a parse. The address is hashed with the host's keyed hash before it is stored.

Boundary

The package chooses no proxy policy: supply clientAddress from the host's reviewed number of trusted hops. Authentication is deliberately absent; the CLI submits anonymously and the report's contact field is the only identity.

API entry points and requirements

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