---
title: "@playstack/nest-delivery"
description: "NestJS delivery queue consumer and safe one-click unsubscribe endpoints."
tags: ["package","communication","delivery","nestjs","unsubscribe","free"]
---

{/* package-access:start */}

> **Free.** MIT licensed. Check preview availability before installing. See [package access](/docs/packages#access-policy).

{/* package-access:end */}

`@playstack/nest-delivery` binds the portable delivery service to a validated Nest queue consumer and unsubscribe controller. It does not configure providers, own templates, authenticate users, or render preference pages.

{/* package-install:start */}

## Install

After confirming [preview access](/docs/packages#access-policy), install the package at your application's shared Playstack version:

```sh
npm install --save-exact @playstack/nest-delivery@0.1.0-beta.1
```

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

{/* package-install:end */}

## Configure

```ts
PlaystackDeliveryModule.forRoot({
  delivery,
  tokens: unsubscribeTokens,
})
```

Use `forRootAsync({ imports, inject, useFactory })` for Nest-managed composition. The module remains non-global.

## Worker and routes

Bind the `playstack.delivery.dispatch` queue job to the consumer selected by the application:

```ts
await deliveryConsumer.handle(job.data)
```

`PlaystackDeliveryConsumer` validates the untrusted job before calling the core worker operation.

The module also registers:

| Route | Behavior |
| --- | --- |
| `GET /delivery/unsubscribe/:token` | Verifies the token and returns a read-only render model. |
| `POST /delivery/unsubscribe/:token` | Requires RFC 8058 one-click data or `{ confirm: true }`, then adds the exact suppression. |

`tokens.verify()` is an application seam responsible for signature, purpose, and expiry validation. Inject `DELIVERY_SERVICE` for the core facade or `NEST_DELIVERY_OPTIONS` for the configured verifier.

{/* package-reference:start */}

## API entry points and requirements

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

| Public entry point | Declaration file |
| --- | --- |
| `@playstack/nest-delivery` | `./dist/index.d.ts` |
| `@playstack/nest-delivery/package.json` | No TypeScript declaration (asset or metadata export). |

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.

| Peer | Compatible range | When needed |
| --- | --- | --- |
| `@nestjs/common` | `^10.0.0 \|\| ^11.0.0` | Required by the package. |
| `@playstack/delivery` | `0.1.0-beta.1` | Required by the package. |
| `reflect-metadata` | `^0.1.13 \|\| ^0.2.0` | Required by the package. |
| `rxjs` | `^7.0.0` | Required by the package. |

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

{/* package-reference:end */}