@playstack/fulfillment
Encrypted, provider-neutral fulfillment requests and physical-order delivery progress.
Pro. Covered by the Playstack Pro License. Registry access is required; check preview availability before installing. See package access.
@playstack/fulfillment projects paid physical lines into fulfillment work while keeping personally identifiable address data encrypted and out of domain events.
import { createFulfillment } from '@playstack/fulfillment'
import { createManualFulfillmentProvider } from '@playstack/fulfillment/manual'
const fulfillment = createFulfillment({
persistence,
addresses: crypto,
providers: [createManualFulfillmentProvider()],
events,
ids,
clock,
})The addresses codec can be implemented by @playstack/crypto. Persistence receives ciphertext, an opaque digest, and routing-safe country code. Explicit application operations control decryption.
The manual provider is a production headless staff workflow with start, partial work, ship, deliver, fail, and pre-shipment cancel transitions. @playstack/fulfillment/prisma provides the PostgreSQL adapter and can share a transaction with @playstack/commerce.
Install
After confirming preview access, install the package at your application's shared Playstack version:
npm install --save-exact @playstack/fulfillment@0.1.0-beta.1Check the peer requirements below before choosing a runtime or provider.
API entry points and requirements
Reference snapshot: @playstack/fulfillment@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/fulfillment | ./dist/index.d.ts |
@playstack/fulfillment/errors | ./dist/errors.d.ts |
@playstack/fulfillment/manual | ./dist/manual.d.ts |
@playstack/fulfillment/prisma | ./dist/prisma.d.ts |
@playstack/fulfillment/testing | ./dist/testing.d.ts |
@playstack/fulfillment/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
This package declares no peer dependencies. Its ordinary dependencies are resolved by the package manager.
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.