sdr-subscription

Reusable Stripe-only subscription capability for API and app clients.

Scope

This package is intentionally split into two surfaces:

• api: shared domain contracts + Stripe status mapping helpers.
• app: typed client for subscription endpoints used by mobile/web app frontends.
• nest: reusable Nest module/service/controllers/entity for API projects.

Package Layout

• src/api/contracts.ts: canonical request/response and status/provider types.
• src/api/stripe.ts: Stripe-to-domain status mapping.
• src/app/client.ts: client methods for user/admin subscription API calls.
• src/nest/*: Nest module + service + controllers + entity for subscription operations.

API Integration (Nest)

In your API project:

1. Import the shared Nest surface:

import { SubscriptionModule } from "@scryan7371/sdr-subscription/nest";

2. Register it in your API module:

SubscriptionModule.forRoot({
  stripeSecretKey: process.env.STRIPE_SECRET_KEY,
  stripeWebhookSecret: process.env.STRIPE_WEBHOOK_SECRET,
});

3. Apply your app-specific guards/auth policies in your API app where needed.

App Integration (React Native / Web)

In your app project:

1. Build client once:

import { app as sdrSubscription } from "@scryan7371/sdr-subscription";

const subscriptionClient = sdrSubscription.createSubscriptionClient({
  baseUrl,
  getAccessToken: () => accessToken,
});

2. Use methods in screens/services:

• getMySubscriptionStatus()
• getMySubscriptions()
• cancelMySubscription(subscriptionId)
• cancelSubscriptionAsAdmin(subscriptionId)
• reactivateSubscriptionAsAdmin(subscriptionId)

Notes

• This is Stripe-only by design.
• Keep versions pinned in consumers.

Database Integration Tests

Real database tests are available with:

npm run test:db

The test loader reads DB values from .env.test or .env.dev (current dir first, then project root), using either:

• SUBSCRIPTION_TEST_DATABASE_URL (or fallback DATABASE_URL), or
• component vars: DB_HOST, DB_PORT, DB_USER, DB_PASSWORD, DB_NAME.

Debug schema helpers:

npm run test:db:keep
npm run test:db:teardown

• test:db:keep keeps schema sdr_subscription_it_debug after the run.
• test:db:teardown runs against the same schema and tears it down.

Publish (npmjs)

1. Configure project-local npm auth (.npmrc):

registry=https://registry.npmjs.org/
@scryan7371:registry=https://registry.npmjs.org/
//registry.npmjs.org/:_authToken=${NPM_TOKEN}

2. Set token, bump version, and publish:

export NPM_TOKEN=xxxx
npm version patch
npm publish --access public --registry=https://registry.npmjs.org --userconfig .npmrc

3. Push commit and tags:

git push
git push --tags

Release Process

Use the built-in release scripts (recommended):

npm run release:patch
npm run release:minor
npm run release:major

Each release script:

1. Validates git working tree is clean.
2. Runs tests.
3. Builds the package.
4. Bumps package.json/package-lock.json.
5. Commits as chore(release): vX.Y.Z.
6. Creates tag sdr-subscription-vX.Y.Z.
7. Pushes commit and tag.

Tag pushes (sdr-subscription-v*) trigger publish workflow in GitHub Actions.

CI Publish (GitHub Actions)

Tag pushes like sdr-subscription-v* trigger .github/workflows/publish.yml.

Required repo secret:

• NPM_TOKEN (npm granular token with read/write + bypass 2FA for automation).

Install

Install a pinned version:

npm install @scryan7371/[email protected]