@qazuor/qzpay-nestjs

NestJS integration for the QZPay billing library.

Installation

pnpm add @qazuor/qzpay-nestjs @nestjs/common @nestjs/core

Features

• Module Configuration: Easy setup with NestJS modules
• Service Injection: Injectable billing service
• Decorators: Custom decorators for billing operations
• Guards: Protection guards for billing routes
• TypeScript: Full type safety

Usage

Module Setup

import { Module } from '@nestjs/common';
import { QZPayModule } from '@qazuor/qzpay-nestjs';
import { createQZPayBilling } from '@qazuor/qzpay-core';
import { createQZPayStripeAdapter } from '@qazuor/qzpay-stripe';
import { createQZPayDrizzleAdapter } from '@qazuor/qzpay-drizzle';

// Create billing instance first
const billing = createQZPayBilling({
  storage: createQZPayDrizzleAdapter({ db }),
  paymentAdapter: createQZPayStripeAdapter({
    secretKey: process.env.STRIPE_SECRET_KEY!,
    webhookSecret: process.env.STRIPE_WEBHOOK_SECRET!,
  }),
  livemode: true,
});

@Module({
  imports: [
    QZPayModule.forRoot({ billing })
  ]
})
export class AppModule {}

Async Configuration

import { Module } from '@nestjs/common';
import { QZPayModule } from '@qazuor/qzpay-nestjs';
import { ConfigModule, ConfigService } from '@nestjs/config';
import { createQZPayBilling } from '@qazuor/qzpay-core';
import { createQZPayStripeAdapter } from '@qazuor/qzpay-stripe';
import { createQZPayDrizzleAdapter } from '@qazuor/qzpay-drizzle';

@Module({
  imports: [
    QZPayModule.forRootAsync({
      imports: [ConfigModule],
      inject: [ConfigService],
      useFactory: (config: ConfigService) => ({
        billing: createQZPayBilling({
          storage: createQZPayDrizzleAdapter({ db }),
          paymentAdapter: createQZPayStripeAdapter({
            secretKey: config.get('STRIPE_SECRET_KEY')!,
            webhookSecret: config.get('STRIPE_WEBHOOK_SECRET')!,
          }),
          livemode: config.get('NODE_ENV') === 'production',
        }),
      })
    })
  ]
})
export class AppModule {}

Service Injection

import { Injectable } from '@nestjs/common';
import { QZPayService } from '@qazuor/qzpay-nestjs';

@Injectable()
export class BillingService {
  constructor(private readonly qzpay: QZPayService) {}

  async createCustomer(email: string, name: string) {
    return this.qzpay.customers.create({ email, name });
  }

  async createSubscription(customerId: string, planId: string) {
    return this.qzpay.subscriptions.create({ customerId, planId });
  }

  async processPayment(customerId: string, amount: number) {
    return this.qzpay.payments.process({
      customerId,
      amount,
      currency: 'USD'
    });
  }
}

Controller Example

import { Controller, Post, Body, Get, Param } from '@nestjs/common';
import { QZPayService } from '@qazuor/qzpay-nestjs';

@Controller('billing')
export class BillingController {
  constructor(private readonly qzpay: QZPayService) {}

  @Post('customers')
  async createCustomer(@Body() data: { email: string; name: string }) {
    return this.qzpay.customers.create(data);
  }

  @Get('customers/:id')
  async getCustomer(@Param('id') id: string) {
    return this.qzpay.customers.get(id);
  }

  @Post('subscriptions')
  async createSubscription(
    @Body() data: { customerId: string; planId: string }
  ) {
    return this.qzpay.subscriptions.create(data);
  }
}

Guards

import { Controller, UseGuards } from '@nestjs/common';
import { QZPayLivemodeGuard } from '@qazuor/qzpay-nestjs';

@Controller('billing')
@UseGuards(QZPayLivemodeGuard)
export class BillingController {
  // Only accessible in livemode
}

Decorators

import { Controller } from '@nestjs/common';
import { InjectQZPay } from '@qazuor/qzpay-nestjs';
import type { QZPayBilling } from '@qazuor/qzpay-core';

@Controller('billing')
export class BillingController {
  constructor(
    @InjectQZPay() private readonly billing: QZPayBilling
  ) {}
}

Module Options

interface QZPayModuleOptions {
  /**
   * The QZPayBilling instance to use
   */
  billing: QZPayBilling;
}

Testing

import { Test } from '@nestjs/testing';
import { QZPayModule, QZPayService } from '@qazuor/qzpay-nestjs';
import { createQZPayBilling } from '@qazuor/qzpay-core';

describe('BillingService', () => {
  let service: QZPayService;

  beforeEach(async () => {
    const mockBilling = createQZPayBilling({
      storage: mockStorageAdapter,
      paymentAdapter: mockPaymentAdapter,
      livemode: false,
    });

    const module = await Test.createTestingModule({
      imports: [
        QZPayModule.forRoot({ billing: mockBilling })
      ]
    }).compile();

    service = module.get<QZPayService>(QZPayService);
  });

  it('should create customer', async () => {
    const customer = await service.customers.create({
      email: '[email protected]',
      name: 'Test User'
    });
    expect(customer.id).toBeDefined();
  });
});

License

MIT