TossPaymentsPostgres — @gj-kit/toss-payments-postgresql

A public interface from @gj-kit/toss-payments-postgresql. The signature below is taken directly from the 0.5.1 release declaration.

Verified import example

import { TossPaymentsPostgres } from '@gj-kit/toss-payments-postgresql';

Signature, parameters, and return type

interface TossPaymentsPostgres {
    readonly orders: OrderStore;
    readonly depositSecrets: DepositSecretStore;
    /**
     * 코어 BillingKeyStore + PostgreSQL conditional compare-and-mutate 확장.
     *
     * `deleteIfBillingKeyMatches`/`replaceIfBillingKeyMatches`는 stale BILLING_DELETED와
     * projection 보상 경합에서 무조건 delete/save 대신 사용하는 원자적 API다.
     */
    readonly billingKeys: PgBillingKeyStore;
    readonly cancelRetries: CancelRetryStore;
    readonly webhookDedupe: WebhookDedupeStore;
    readonly audit: AuditSink & {
        flush(): Promise<void>;
    };
    readonly inbox: WebhookInboxStore;
    /**
     * 앱이 만든 nonsecret HMAC/blind-index key로 짧은 host lifecycle을 인스턴스 간
     * 순서화하는 PostgreSQL advisory transaction lock facility.
     *
     * 이 API는 다른 ORM connection의 transaction과 2PC 원자성을 만들지 않는다. provider
     * network I/O가 아니라 local durable finalization만 callback에 넣어야 한다.
     */
    readonly opaqueLocks: PgOpaqueAdvisoryLocks;
    /** 명시 호출 전용 — 부팅 시 자동 실행 없음. `app.listen` 전에 await하는 것이 골든 패스. */
    migrate(): Promise<MigrationResult>;
    /**
     * TTL 행 정리 — 명시 호출 전용(자동 타이머 없음). audit_entries·webhook_inbox·
     * orders·deposit_secrets는 지우지 않는다 — 보관 정책은 소비자 책임.
     */
    cleanup(): Promise<CleanupResult>;
}

This declaration is the source of truth for parameters, optionality, generics, return values, and public union/type contracts. Check the package golden path and this subpath’s import conditions for required environment, permission, and error boundaries before calling it.

Release context

• Package: @gj-kit/toss-payments-postgresql
• Version: 0.5.1
• Public entry: .
• Source: GitHub