Aes256GcmSensitiveValueProtectorOptions — @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 { Aes256GcmSensitiveValueProtectorOptions } from '@gj-kit/toss-payments-postgresql';

Signature, parameters, and return type

interface Aes256GcmSensitiveValueProtectorOptions {
    /**
     * 32-byte AES-256 key — a `Uint8Array`/`Buffer` of exactly 32 bytes or a 64-character hex
     * string. The host generates it (for example `openssl rand -hex 32`), stores it in its secret
     * manager, and owns rotation. The bytes are copied at construction; mutating the caller's
     * buffer afterwards has no effect.
     */
    readonly key: Uint8Array | string;
    /**
     * Optional nonsecret key identifier written to the envelope as `kid` and bound into the AAD.
     * Rows encrypted under a different `kid` (or without one) are rejected with
     * `'key-id-mismatch'` before any decryption, which lets a host route old rows to a
     * previous-key protector during rotation. 1–128 characters.
     */
    readonly keyId?: string;
}

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