@carsayo/types 1.1.892072 → 1.1.892074

package/dist/types/providers/nicepayment/dto.js

@@ -0,0 +1,9 @@
+"use strict";
+/** DTO는 서버단에 요청을 보낼 때 사용하는 클래스 유형으로 서버단에서 이 곳에 정의된 대로 유효성 검사를 처리합니다. */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PaymentIntervalTarget = void 0;
+exports.PaymentIntervalTarget = {
+    created_at: "생성일시",
+    paid_at: "결제완료일시",
+    canceled_at: "결제취소일시",
+};

package/dist/types/providers/nicepayment/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./dto";
+export * from "./interface";
+export * from "./type";

package/dist/types/providers/nicepayment/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./dto"), exports);
+__exportStar(require("./interface"), exports);
+__exportStar(require("./type"), exports);

package/dist/types/providers/nicepayment/interface.d.ts

@@ -0,0 +1,168 @@
+import { MemberShort } from "../../modules";
+import { PaymentMethod, PaymentState } from "./type";
+/**
+ * @interface NicepaymentInitData
+ * @description 나이스 결제 시스템을 위한 초기화 데이터 인터페이스입니다.
+ * @url https://developers.nicepay.co.kr/manual-auth.php
+ */
+export interface NicepaymentInitData {
+    /**
+     * @property {string} GoodsName - 결제상품명 (euc-kr).
+     */
+    GoodsName: string;
+    /**
+     * @property {number} Amt - 금액 (숫자만 입력).
+     */
+    Amt: number;
+    /**
+     * @property {string} MID - 상점아이디.
+     */
+    MID: string;
+    /**
+     * @property {string} EdiDate - 요청 시간 (YYYYMMDDHHMISS).
+     */
+    EdiDate: string;
+    /**
+     * @property {string} Moid - 상품주문번호.
+     */
+    Moid: string;
+    /**
+     * @property {string} SignData - hex(sha256(EdiDate + MID + Amt + MerchantKey)), 위변조 검증 데이터.
+     */
+    SignData: string;
+    /**
+     * @property {PaymentMethod} [PayMethod] - 상품 주문 방법 (""는 모두 다 넣는것).
+     */
+    PayMethod?: PaymentMethod;
+    /**
+     * @property {string} ReturnURL - ReturnURL 요청 응답 URL (절대 경로).
+     */
+    ReturnURL: string;
+    /**
+     * @property {string} [BuyerName] - 구매자명 (euc-kr).
+     */
+    BuyerName?: string;
+    /**
+     * @property {string} [BuyerTel] - 구매자연락처 (숫자만 입력).
+     */
+    BuyerTel?: string;
+    /**
+     * @property {string} [BuyerEmail] - 구매자 메일주소.
+     */
+    BuyerEmail?: string;
+    /**
+     * @property {string} [VbankExpDate] - 가상계좌 추가 파라미터 가상계좌입금만료일 (YYYYMMDDHHMM).
+     */
+    VbankExpDate?: string;
+    /**
+     * @property {"utf-8"} CharSet - 문자셋 ("utf-8").
+     */
+    CharSet: "utf-8";
+}
+/**
+ * @interface NicePaymentInfo
+ * @description 나이스 결제 정보 인터페이스입니다.
+ */
+export interface NicePaymentInfo {
+    /**
+     * @property {string} id - 결제 고유 ID.
+     */
+    id: string;
+    /**
+     * @property {string} name - 결제자 이름.
+     */
+    name: string;
+    /**
+     * @property {number} amount - 결제 금액.
+     */
+    amount: number;
+    /**
+     * @property {PaymentMethod} method - 결제 방법.
+     */
+    method: PaymentMethod;
+    /**
+     * @property {PaymentState} status - 결제 상태.
+     */
+    status: PaymentState;
+    /**
+     * @property {object} [card] - Method: CARD일 때 정의됩니다.
+     * @property {string} card.cardName - 카드 이름.
+     * @property {string} card.cardNumber - 카드 번호.
+     */
+    card?: {
+        cardName: string;
+        cardNumber: string;
+    };
+    virtualBank?: PaymentVirtualBankInfo;
+    /**
+     * @property {object} [bank] - Method: BANK일 때 정의됩니다.
+     * @property {string} bank.bankName - 은행 이름.
+     */
+    bank?: {
+        bankName: string;
+    };
+    /**
+     * @property {Date} created_at - 생성 일자.
+     */
+    created_at: Date;
+    /**
+     * @property {Date} updated_at - 수정 일자.
+     */
+    updated_at: Date;
+    /**
+     * @property {Date | null} paid_at - 결제일.
+     */
+    paid_at: Date | null;
+    /**
+     * @property {Date | null} stopped_at - 결제 도중 취소한 일자.
+     */
+    stopped_at: Date | null;
+    /**
+     * @property {Date | null} canceled_at - 취소일자.
+     */
+    canceled_at: Date | null;
+}
+export interface PaymentVirtualBankInfo {
+    bankName: string;
+    accountNumber: string;
+    /** YYYYMMDD */
+    expireDate: string;
+    /** hhmmss (UTC 0 기준입니다) */
+    expireTime: string;
+}
+/** 결제 리스트 검색 결과 */
+export interface PaymentSearchList {
+    totalCount: number;
+    data: NicePaymentInfo[];
+    additionalInfo: {
+        /** 요청시 totalPrice: true일 경우 정의됩니다 */
+        totalPrice?: number;
+        /** 요청시 orderState: true일 경우 정의됩니다 */
+        paymentState?: PaymentSearchListStateCount;
+    };
+}
+/** 결제 리스트 검색 결과 */
+export interface Admin_PaymentSearchList {
+    totalCount: number;
+    data: (NicePaymentInfo & {
+        member: MemberShort;
+    })[];
+    additionalInfo: {
+        /** 요청시 totalPrice: true일 경우 정의됩니다 */
+        totalPrice?: number;
+        /** 요청시 orderState: true일 경우 정의됩니다 */
+        paymentState?: PaymentSearchListStateCount;
+    };
+}
+export interface PaymentSearchListStateCount {
+    /** [가상계좌 대기] */
+    virtualAccountWaiting: number;
+    /** [미사용] */
+    paid: number;
+    /** [결제 완료] */
+    used: number;
+    /** [결제 취소] */
+    canceled: number;
+    /** [취소 실패] */
+    cancelFailed: number;
+}

package/dist/types/providers/nicepayment/interface.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/providers/nicepayment/type.d.ts

@@ -0,0 +1,36 @@
+/**
+ * @init [주문 시작]
+ * @stopped [취소] (결제가 완료된 적 없음)
+ * @virtualAccountWaiting [가상계좌 대기] 가상계좌 입금 대기중
+ * @paid [미사용] 결제는 완료되었으나, 사용하지 않았습니다.
+ * @used [결제 완료] 결제가 완료되었으며 사용하였습니다.
+ * @canceled [결제 취소] 나이스 페이에 결제 취소 요청이 정상적으로 접수되었습니다.
+ * @cancelFailed [취소 실패] 결제 취소 요청 실패(가상계좌라던가, 결제 완료 후 오랜 기간이 지났다던지 등)
+ */
+export declare const PaymentState: {
+    readonly init: "init";
+    readonly stopped: "stopped";
+    readonly virtualAccountWaiting: "virtualAccountWaiting";
+    readonly paid: "paid";
+    readonly used: "used";
+    readonly canceled: "canceled";
+    readonly cancelFailed: "cancelFailed";
+};
+export type PaymentState = keyof typeof PaymentState;
+/**
+ * @"" 모든 결제 방법이 포함
+ * @CARD 신용카드 결제
+ * @BANK 계좌이체
+ * @VBANK 가상계좌 결제
+ * @CELLPHONE 휴대전화 결제
+ * @CARD,BANK,VBANK 카드, 계좌이체, 가상계좌 결제
+ */
+export declare const PaymentMethod: {
+    readonly CARD: "CARD";
+    readonly BANK: "BANK";
+    readonly VBANK: "VBANK";
+    readonly CELLPHONE: "CELLPHONE";
+    readonly "CARD,BANK,VBANK": "CARD,BANK,VBANK";
+    readonly "": "";
+};
+export type PaymentMethod = keyof typeof PaymentMethod;

package/dist/types/providers/nicepayment/type.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PaymentMethod = exports.PaymentState = void 0;
+/**
+ * @init [주문 시작]
+ * @stopped [취소] (결제가 완료된 적 없음)
+ * @virtualAccountWaiting [가상계좌 대기] 가상계좌 입금 대기중
+ * @paid [미사용] 결제는 완료되었으나, 사용하지 않았습니다.
+ * @used [결제 완료] 결제가 완료되었으며 사용하였습니다.
+ * @canceled [결제 취소] 나이스 페이에 결제 취소 요청이 정상적으로 접수되었습니다.
+ * @cancelFailed [취소 실패] 결제 취소 요청 실패(가상계좌라던가, 결제 완료 후 오랜 기간이 지났다던지 등)
+ */
+exports.PaymentState = {
+    init: "init",
+    stopped: "stopped",
+    virtualAccountWaiting: "virtualAccountWaiting",
+    paid: "paid",
+    used: "used",
+    canceled: "canceled",
+    cancelFailed: "cancelFailed",
+};
+/**
+ * @"" 모든 결제 방법이 포함
+ * @CARD 신용카드 결제
+ * @BANK 계좌이체
+ * @VBANK 가상계좌 결제
+ * @CELLPHONE 휴대전화 결제
+ * @CARD,BANK,VBANK 카드, 계좌이체, 가상계좌 결제
+ */
+exports.PaymentMethod = {
+    CARD: "CARD",
+    BANK: "BANK",
+    VBANK: "VBANK",
+    CELLPHONE: "CELLPHONE",
+    "CARD,BANK,VBANK": "CARD,BANK,VBANK",
+    "": "",
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@carsayo/types",
-  "version": "1.1.892072",
+  "version": "1.1.892074",
   "description": "Carsayo app type",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",