@gj-kit/toss-payments-nestjs

@gj-kit/toss-payments를 위한 NestJS DI 및 raw-body 웹훅 조합 패키지입니다.

현재 npm 최신판: 0.4.4

사용할 때

Nest 앱에서 core payment kit의 타입과 안전 경계를 의존성 주입까지 유지해야 할 때 사용합니다.

사용하지 않을 때

controller에서 결제 검증을 다시 구현하거나 웹훅 검증에 raw bytes가 필요한데 파싱된 JSON에 의존하지 마세요.

Golden path

완료 상태: typed payment kit을 주입하는 Nest provider 하나를 만듭니다.

1. 설치

pnpm add @gj-kit/toss-payments-nestjs

2. 앱이 소유할 경계를 정합니다

core payment config을 만들고 한 번만 등록하며, webhook route에서는 원본 request bytes를 보존합니다.

3. 최소 연결부터 시작합니다

먼저 아래 코드를 복사한 뒤, 위에서 언급한 앱 소유 값만 교체하세요.

import { orThrow } from '@gj-kit/toss-payments';
import { defineTossPaymentsConfig, parseApiSecretKey } from '@gj-kit/toss-payments/server';
import { TossPaymentsModule } from '@gj-kit/toss-payments-nestjs';

declare const apiSecretFromEnv: string; // Read this once from your server environment.

const config = defineTossPaymentsConfig({
  secretKey: orThrow(parseApiSecretKey(apiSecretFromEnv)),
});

export const payments = TossPaymentsModule.forRoot(config);

환경과 peer

엔진: node >=20

Peer	지원 범위	필요한 위치
`@gj-kit/toss-payments`	`^0.2.0
`@nestjs/common`	`^10
`reflect-metadata`	`^0.1.13
`rxjs`	`^7`	패키지 통합

공개 subpath

Entry	Exported symbols
`Root entry`	14

안전 경계

검증되는 웹훅은 원본 request bytes를 보존하고, 모든 store 의존성을 host Nest module에 명시하세요.

API reference

전체 API reference에는 선언 파일에서 생성한 모든 공개 함수, 클래스, 타입, 상수, 오류 계약이 있습니다. 각 항목은 import path, release signature, package version을 표시합니다.