@gj-kit/toss-payments-postgresql

@gj-kit/toss-payments를 위한 PostgreSQL store, migration, inbox, 암호화 seam입니다.

현재 npm 최신판: 0.5.1

사용할 때

앱이 connection lifecycle과 key custody를 유지하면서 Toss payment store에 검증된 PostgreSQL 구현이 필요할 때 사용합니다.

사용하지 않을 때

migration을 request 또는 앱 시작 시 실행하거나 production에서 plaintext protector를 사용하지 마세요.

Golden path

완료 상태: 명시적인 migration 단계 하나를 갖는 PostgreSQL 기반 Toss store를 만듭니다.

1. 설치

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

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

fromPgPool로 pool을 adapter에 연결하고 실제 암호화 sensitiveValueProtector를 사용하며, migration은 배포 중에 실행합니다.

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

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

import { createTossPaymentsPostgres, fromPgPool, type PgPoolLike, type SensitiveValueProtector } from '@gj-kit/toss-payments-postgresql';

declare const pool: PgPoolLike;
declare const sensitiveValueProtector: SensitiveValueProtector; // App KMS/encryption boundary.

export const stores = createTossPaymentsPostgres({
  sql: fromPgPool(pool),
  sensitiveValueProtector,
});

// Run await stores.migrate() once in deployment, never per request.

환경과 peer

엔진: node >=20

Peer	지원 범위	필요한 위치
`@gj-kit/toss-payments`	`^0.5.0
`@nestjs/common`	`^10
`reflect-metadata`	`^0.1.13
`rxjs`	`^7`	문서화된 optional subpath에서만

공개 subpath

Entry	Exported symbols
`Root entry`	55
`./nestjs`	14
`./testing`	30

안전 경계

민감값에는 앱 소유 KMS 또는 key-management 경계를 사용하고, 명시적 migration은 한 번 실행하며, 정리 작업은 멱등적으로 유지하세요.

API reference

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