@sayren/storefront-sdk 0.9.0 → 0.11.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/auth/index.d.mts +12 -3
- package/dist/auth/index.mjs +13 -4
- package/dist/checkout-CHpxo2Ap.mjs +310 -0
- package/dist/{client-D9iQIWnV.mjs → client-CHfCafer.mjs} +134 -13
- package/dist/{http-BbFHVGBf.d.mts → http-CeRVoUGu.d.mts} +19 -1
- package/dist/{index-DvHOQm2-.d.mts → index-OqvbJ6Xi.d.mts} +459 -3
- package/dist/index.d.mts +3 -3
- package/dist/index.mjs +3 -3
- package/dist/payments/index.d.mts +5 -1
- package/dist/payments/index.mjs +4 -2
- package/package.json +1 -1
- package/src/auth/index.ts +18 -3
- package/src/client.ts +28 -0
- package/src/index.ts +1 -0
- package/src/payments/index.ts +11 -1
- package/src/schemas/auth.ts +16 -0
- package/src/schemas/checkout.ts +192 -1
- package/src/schemas/claim.ts +63 -3
- package/src/schemas/consent.ts +72 -0
- package/src/schemas/member.ts +6 -0
- package/src/schemas/order.ts +52 -8
- package/dist/checkout-JFk3b8RG.mjs +0 -189
package/src/schemas/claim.ts
CHANGED
|
@@ -22,6 +22,14 @@ export const createClaimRequestSchema = z.object({
|
|
|
22
22
|
reasonDetail: z.string().max(1000).optional(),
|
|
23
23
|
evidenceImages: z.array(z.url()).max(5).optional(),
|
|
24
24
|
exchangeOptionId: z.string().optional(),
|
|
25
|
+
quantity: z
|
|
26
|
+
.number()
|
|
27
|
+
.int()
|
|
28
|
+
.min(1)
|
|
29
|
+
.optional()
|
|
30
|
+
.describe(
|
|
31
|
+
"취소·반품·교환할 수량. 생략하면 남은 수량 전체다. 남은 수량보다 크면 400 `INVALID_QUANTITY`",
|
|
32
|
+
),
|
|
25
33
|
});
|
|
26
34
|
|
|
27
35
|
export type CreateClaimRequest = z.infer<typeof createClaimRequestSchema>;
|
|
@@ -29,21 +37,73 @@ export type CreateClaimRequest = z.infer<typeof createClaimRequestSchema>;
|
|
|
29
37
|
export const createClaimResultSchema = z.object({
|
|
30
38
|
claimId: z.string(),
|
|
31
39
|
status: z.literal("REQUESTED"),
|
|
32
|
-
expectedRefundAmount: z
|
|
33
|
-
|
|
40
|
+
expectedRefundAmount: z
|
|
41
|
+
.number()
|
|
42
|
+
.int()
|
|
43
|
+
.nullable()
|
|
44
|
+
.describe(
|
|
45
|
+
"예상 환불액 — 수량 비율 상품 금액 − 반품 배송비. **배송비 환불은 여기 포함되지 않고 " +
|
|
46
|
+
"`deliveryFeeRefundAmount`로 따로 온다**(승인 시점의 배송 묶음 상태로 확정되기 때문이다). " +
|
|
47
|
+
"교환은 환불이 없어 null이다",
|
|
48
|
+
),
|
|
49
|
+
claimDeliveryFee: z.number().int().describe("구매자가 부담하는 반품·교환 배송비. 원 단위"),
|
|
50
|
+
quantity: z.number().int().describe("접수된 수량. 요청에서 생략하면 남은 수량 전체다"),
|
|
51
|
+
deliveryFeeRefundAmount: z
|
|
52
|
+
.number()
|
|
53
|
+
.int()
|
|
54
|
+
.describe("환불 예정 배송비. 배송 묶음이 모두 취소되거나 판매자 귀책일 때만 0보다 크다"),
|
|
34
55
|
});
|
|
35
56
|
|
|
36
57
|
export type CreateClaimResult = z.infer<typeof createClaimResultSchema>;
|
|
37
58
|
|
|
59
|
+
/**
|
|
60
|
+
* 반품지 (이슈 #30) — 반품·교환 수거가 안내하는 주소다. 스토어 주소록의 기본 반품지이거나,
|
|
61
|
+
* 상품이 반품지를 따로 지정했으면 그 주소다.
|
|
62
|
+
*
|
|
63
|
+
* 취소 클레임은 보낼 물건이 없어 null이고, 반품지를 등록하지 않은 스토어도 null이다.
|
|
64
|
+
* 구매자가 직접 보내는 수거(`BUYER_SEND`)에 이 주소가 필요하다.
|
|
65
|
+
*/
|
|
66
|
+
export const claimReturnAddressSchema = z.object({
|
|
67
|
+
name: z.string().describe("주소 이름(셀러가 붙인 별칭). 예: 본사 물류센터"),
|
|
68
|
+
contactName: z.string().describe("수취인 이름"),
|
|
69
|
+
phone: z.string().describe("연락처"),
|
|
70
|
+
zipCode: z.string(),
|
|
71
|
+
address1: z.string(),
|
|
72
|
+
address2: z.string().nullable(),
|
|
73
|
+
});
|
|
74
|
+
|
|
75
|
+
export type ClaimReturnAddress = z.infer<typeof claimReturnAddressSchema>;
|
|
76
|
+
|
|
38
77
|
export const myClaimSchema = z.object({
|
|
39
78
|
claimId: z.string(),
|
|
40
79
|
type: claimTypeSchema,
|
|
41
80
|
status: claimStatusSchema,
|
|
42
81
|
orderItemId: z.string(),
|
|
43
82
|
productName: z.string(),
|
|
83
|
+
quantity: z.number().int().describe("접수된 수량"),
|
|
44
84
|
reason: z.string(),
|
|
45
|
-
expectedRefundAmount: z
|
|
85
|
+
expectedRefundAmount: z
|
|
86
|
+
.number()
|
|
87
|
+
.int()
|
|
88
|
+
.nullable()
|
|
89
|
+
.describe(
|
|
90
|
+
"예상 환불액 — 수량 비율 상품 금액 − 반품 배송비 − 조건부 무료배송 미달 차감. " +
|
|
91
|
+
"**배송비 환불은 포함되지 않고 `expectedDeliveryFeeRefundAmount`로 따로 온다.** 교환은 null이다",
|
|
92
|
+
),
|
|
93
|
+
expectedDeliveryFeeRefundAmount: z
|
|
94
|
+
.number()
|
|
95
|
+
.int()
|
|
96
|
+
.nullable()
|
|
97
|
+
.describe(
|
|
98
|
+
"예상 배송비 환불액. 배송 묶음이 모두 취소되거나 판매자 귀책일 때만 0보다 크다. " +
|
|
99
|
+
"이 필드가 생기기 전에 접수된 클레임은 null이다",
|
|
100
|
+
),
|
|
46
101
|
rejectReason: z.string().nullable(),
|
|
102
|
+
returnAddress: claimReturnAddressSchema
|
|
103
|
+
.nullable()
|
|
104
|
+
.describe(
|
|
105
|
+
"반품·교환 물건을 보낼 반품지(이슈 #30). 직접 보내는 수거 안내에 쓴다. 취소 클레임은 null",
|
|
106
|
+
),
|
|
47
107
|
requestedAt: z.string(),
|
|
48
108
|
completedAt: z.string().nullable(),
|
|
49
109
|
});
|
|
@@ -0,0 +1,72 @@
|
|
|
1
|
+
import { z } from "zod";
|
|
2
|
+
|
|
3
|
+
/**
|
|
4
|
+
* 동의 종류 — 이용약관(`TERMS`)·개인정보 수집이용(`PRIVACY`)은 가입 필수, 마케팅 수신(`MARKETING`)은 선택이다.
|
|
5
|
+
* 필수 동의는 철회할 수 없다(철회 = 탈퇴).
|
|
6
|
+
*/
|
|
7
|
+
export const consentKindSchema = z.enum(["TERMS", "PRIVACY", "MARKETING"]);
|
|
8
|
+
export type ConsentKind = z.infer<typeof consentKindSchema>;
|
|
9
|
+
|
|
10
|
+
/** 동의 이력의 한 줄이 무엇인가 — 동의했거나 철회했다 */
|
|
11
|
+
export const consentActionSchema = z.enum(["AGREED", "WITHDRAWN"]);
|
|
12
|
+
export type ConsentAction = z.infer<typeof consentActionSchema>;
|
|
13
|
+
|
|
14
|
+
/**
|
|
15
|
+
* 동의가 일어난 경로. 값이 추가될 수 있어 모르는 값은 그대로 보여 준다.
|
|
16
|
+
* `SIGNUP` 비밀번호 가입 · `SOCIAL_SIGNUP` 소셜 가입 · `DELEGATED` 셀러 자체 회원 연동 ·
|
|
17
|
+
* `RECONSENT` 약관 개정 재동의 · `MEMBER_UPDATE` 구매자가 직접 변경 · `SELLER` 셀러가 처리
|
|
18
|
+
*/
|
|
19
|
+
export const consentSourceSchema = z.enum([
|
|
20
|
+
"SIGNUP",
|
|
21
|
+
"SOCIAL_SIGNUP",
|
|
22
|
+
"DELEGATED",
|
|
23
|
+
"RECONSENT",
|
|
24
|
+
"MEMBER_UPDATE",
|
|
25
|
+
"SELLER",
|
|
26
|
+
]);
|
|
27
|
+
export type ConsentSource = z.infer<typeof consentSourceSchema>;
|
|
28
|
+
|
|
29
|
+
/** 종류별 현재 동의 상태 */
|
|
30
|
+
export const consentStateSchema = z.object({
|
|
31
|
+
kind: consentKindSchema,
|
|
32
|
+
agreed: z.boolean(),
|
|
33
|
+
/** 동의한 약관 버전. 마케팅은 버전이 없어 null이고, 동의 이력이 없으면 null이다 */
|
|
34
|
+
agreedVersion: z.string().nullable(),
|
|
35
|
+
/** 스토어의 현재 약관 버전. 마케팅은 null */
|
|
36
|
+
currentVersion: z.string().nullable(),
|
|
37
|
+
/**
|
|
38
|
+
* 스토어가 정한 현재 약관 문서 주소. 재동의 화면에서 이 주소를 보여 준다.
|
|
39
|
+
* 스토어가 정하지 않았거나 마케팅이면 null이다(동의한 시점의 주소는 셀러가 보는 이력에 남는다).
|
|
40
|
+
*/
|
|
41
|
+
currentDocumentUrl: z.string().nullable(),
|
|
42
|
+
/** 마지막으로 동의·철회한 시각. 이력이 없으면 null */
|
|
43
|
+
updatedAt: z.string().nullable(),
|
|
44
|
+
/** 약관이 개정돼 다시 받아야 하는가. 마케팅은 항상 false */
|
|
45
|
+
reconsentRequired: z.boolean(),
|
|
46
|
+
});
|
|
47
|
+
export type ConsentState = z.infer<typeof consentStateSchema>;
|
|
48
|
+
|
|
49
|
+
/** `GET /storefront/v1/me/consents` 응답 */
|
|
50
|
+
export const memberConsentsSchema = z.object({
|
|
51
|
+
terms: consentStateSchema,
|
|
52
|
+
privacy: consentStateSchema,
|
|
53
|
+
marketing: consentStateSchema,
|
|
54
|
+
/** 필수 동의 중 하나라도 다시 받아야 하면 true — `POST /me/consents`로 받는다 */
|
|
55
|
+
reconsentRequired: z.boolean(),
|
|
56
|
+
});
|
|
57
|
+
export type MemberConsents = z.infer<typeof memberConsentsSchema>;
|
|
58
|
+
|
|
59
|
+
/**
|
|
60
|
+
* `POST /storefront/v1/me/consents` 본문 — 바꿀 항목만 보낸다.
|
|
61
|
+
* 필수 동의는 동의(`true`)만 보낼 수 있다. 이미 현재 버전에 동의한 항목은 이력을 더 남기지 않는다.
|
|
62
|
+
*/
|
|
63
|
+
export const consentUpdateRequestSchema = z
|
|
64
|
+
.object({
|
|
65
|
+
terms: z.literal(true).optional().describe("이용약관 재동의"),
|
|
66
|
+
privacy: z.literal(true).optional().describe("개인정보 수집이용 재동의"),
|
|
67
|
+
marketing: z.boolean().optional().describe("마케팅 수신 동의(false면 철회)"),
|
|
68
|
+
})
|
|
69
|
+
.refine((value) => Object.values(value).some((v) => v !== undefined), {
|
|
70
|
+
message: "최소 1개 항목이 필요합니다",
|
|
71
|
+
});
|
|
72
|
+
export type ConsentUpdateRequest = z.infer<typeof consentUpdateRequestSchema>;
|
package/src/schemas/member.ts
CHANGED
|
@@ -9,6 +9,12 @@ export const memberSchema = z.object({
|
|
|
9
9
|
point: z.number().int(),
|
|
10
10
|
marketingAgreed: z.boolean(),
|
|
11
11
|
joinedAt: z.string(),
|
|
12
|
+
reconsentRequired: z
|
|
13
|
+
.boolean()
|
|
14
|
+
.describe(
|
|
15
|
+
"약관이 개정돼 필수 동의를 다시 받아야 하는가. true면 `GET /me/consents`로 어떤 항목인지 확인하고 " +
|
|
16
|
+
"`POST /me/consents`로 받는다. 받기 전에도 스토어 이용은 막히지 않는다",
|
|
17
|
+
),
|
|
12
18
|
});
|
|
13
19
|
|
|
14
20
|
export type Member = z.infer<typeof memberSchema>;
|
package/src/schemas/order.ts
CHANGED
|
@@ -8,7 +8,18 @@ export const myOrderItemSchema = z.object({
|
|
|
8
8
|
productName: z.string(),
|
|
9
9
|
thumbnailUrl: z.url().nullable().describe("주문 시점의 대표 이미지. 없었으면 null"),
|
|
10
10
|
optionName: z.string().nullable(),
|
|
11
|
-
quantity: z.number().int(),
|
|
11
|
+
quantity: z.number().int().describe("주문 수량"),
|
|
12
|
+
// 두 수량은 서버가 언제나 함께 싣는다. `store-sdk`의 `orderItemSchema`와 같은 규칙으로 **둘 다 필수**다 —
|
|
13
|
+
// 응답 스키마는 OpenAPI 계약이기도 해서 기본값을 두면 선택 필드로 문서화되고, 필드가 빠진 응답이
|
|
14
|
+
// 조용히 0으로 읽혀 남은 수량을 잘못 계산한다
|
|
15
|
+
canceledQuantity: z
|
|
16
|
+
.number()
|
|
17
|
+
.int()
|
|
18
|
+
.describe("취소·반품으로 환불된 누적 수량. 부분 취소가 없었으면 0이다"),
|
|
19
|
+
activeQuantity: z
|
|
20
|
+
.number()
|
|
21
|
+
.int()
|
|
22
|
+
.describe("남은 수량 (`quantity` − `canceledQuantity`). 취소·반품·교환 요청 수량의 상한이다"),
|
|
12
23
|
totalPrice: z.number().int(),
|
|
13
24
|
status: orderItemStatusSchema,
|
|
14
25
|
claimStatus: z.string().nullable(),
|
|
@@ -68,18 +79,51 @@ export const myOrderSchema = z.object({
|
|
|
68
79
|
|
|
69
80
|
export type MyOrder = z.infer<typeof myOrderSchema>;
|
|
70
81
|
|
|
82
|
+
/**
|
|
83
|
+
* 택배 추적 단계. 응답에서는 문자열로 받는다(값이 추가될 수 있다) — 현재 값은 `ACCEPTED`(접수)·`IN_TRANSIT`(이동 중)·
|
|
84
|
+
* `OUT_FOR_DELIVERY`(배송 출발)·`DELIVERED`(배송완료)다.
|
|
85
|
+
*/
|
|
86
|
+
export const trackingStageResponseSchema = z.string();
|
|
87
|
+
|
|
71
88
|
export const deliveryTrackingSchema = z.object({
|
|
72
89
|
carrierName: z.string(),
|
|
73
90
|
trackingNumber: z.string(),
|
|
74
91
|
trackingUrl: z.url(),
|
|
75
92
|
status: z.enum(["DISPATCHED", "DELIVERING", "DELIVERED"]),
|
|
76
|
-
trackingEvents: z
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
93
|
+
trackingEvents: z
|
|
94
|
+
.array(
|
|
95
|
+
z.object({
|
|
96
|
+
status: z.string().describe("택배사가 알려 준 처리 내용(예: 집화처리, 배송출발)"),
|
|
97
|
+
location: z.string().describe("처리 장소. 모르면 빈 문자열"),
|
|
98
|
+
occurredAt: z.string(),
|
|
99
|
+
stage: trackingStageResponseSchema
|
|
100
|
+
.nullable()
|
|
101
|
+
.optional()
|
|
102
|
+
.default(null)
|
|
103
|
+
.describe(
|
|
104
|
+
"이 이벤트의 추적 단계. 배달 실패처럼 단계로 나눌 수 없는 이벤트는 null. 서버는 항상 싣는다. " +
|
|
105
|
+
"현재 값은 `ACCEPTED`·`IN_TRANSIT`·`OUT_FOR_DELIVERY`·`DELIVERED`이고 값이 추가될 수 있어 문자열로 받는다",
|
|
106
|
+
),
|
|
107
|
+
}),
|
|
108
|
+
)
|
|
109
|
+
.describe("배송 추적 이력. 시각 오름차순(오래된 것부터)"),
|
|
110
|
+
trackingStage: trackingStageResponseSchema
|
|
111
|
+
.nullable()
|
|
112
|
+
.optional()
|
|
113
|
+
.default(null)
|
|
114
|
+
.describe(
|
|
115
|
+
"현재 추적 단계. 택배 발송이 아니거나, 아직 조회되지 않았거나, 택배사 전산에 송장이 없으면 null. 서버는 항상 싣는다. " +
|
|
116
|
+
"현재 값은 `ACCEPTED`(접수)·`IN_TRANSIT`(이동 중)·`OUT_FOR_DELIVERY`(배송 출발)·`DELIVERED`(배송완료)이고 " +
|
|
117
|
+
"값이 추가될 수 있어 문자열로 받는다",
|
|
118
|
+
),
|
|
119
|
+
trackingCheckedAt: z
|
|
120
|
+
.string()
|
|
121
|
+
.nullable()
|
|
122
|
+
.optional()
|
|
123
|
+
.default(null)
|
|
124
|
+
.describe(
|
|
125
|
+
"택배사에서 추적 정보를 마지막으로 받아 온 시각(ISO 8601). 받아 온 적이 없으면 null. 서버는 항상 싣는다",
|
|
126
|
+
),
|
|
83
127
|
});
|
|
84
128
|
|
|
85
129
|
export type DeliveryTracking = z.infer<typeof deliveryTrackingSchema>;
|
|
@@ -1,189 +0,0 @@
|
|
|
1
|
-
import { z } from "zod";
|
|
2
|
-
//#region src/schemas/checkout.ts
|
|
3
|
-
const createCheckoutRequestSchema = z.object({
|
|
4
|
-
cartItemIds: z.array(z.string()).min(1).optional(),
|
|
5
|
-
directItem: z.object({
|
|
6
|
-
productId: z.string(),
|
|
7
|
-
optionId: z.string().optional(),
|
|
8
|
-
quantity: z.number().int().min(1)
|
|
9
|
-
}).optional()
|
|
10
|
-
}).refine((value) => value.cartItemIds ? !value.directItem : !!value.directItem, { message: "cartItemIds와 directItem 중 하나만 전달해야 합니다" });
|
|
11
|
-
const checkoutSessionSchema = z.object({
|
|
12
|
-
checkoutId: z.string(),
|
|
13
|
-
items: z.array(z.object({
|
|
14
|
-
productId: z.string(),
|
|
15
|
-
productName: z.string(),
|
|
16
|
-
/** variantId. 옵션 없는 상품은 default variant id */
|
|
17
|
-
optionId: z.string().nullable(),
|
|
18
|
-
optionName: z.string().nullable(),
|
|
19
|
-
quantity: z.number().int(),
|
|
20
|
-
unitPrice: z.number().int(),
|
|
21
|
-
totalPrice: z.number().int()
|
|
22
|
-
})),
|
|
23
|
-
amounts: z.object({
|
|
24
|
-
productAmount: z.number().int(),
|
|
25
|
-
deliveryFee: z.number().int(),
|
|
26
|
-
totalAmount: z.number().int()
|
|
27
|
-
}),
|
|
28
|
-
expiresAt: z.string(),
|
|
29
|
-
paymentOptions: z.lazy(() => paymentOptionListSchema).describe("이 주문서에서 고를 수 있는 결제 옵션, PG 우선순위순. 셀러가 켠 PG·결제수단·간편결제만 담긴다. 비어 있으면 지금 결제할 수 없다"),
|
|
30
|
-
testPayment: z.boolean().describe("지금 결제하면 테스트 결제(샌드박스)인가. true면 실제로 돈이 나가지 않아요 — 주문서에 테스트 결제 안내를 표시해요. 결제 요청 시점에 스토어 결제 설정으로 다시 정해지니 최종 값은 결제 요청 응답의 `testPayment`예요")
|
|
31
|
-
});
|
|
32
|
-
const paymentMethodSchema = z.enum([
|
|
33
|
-
"CARD",
|
|
34
|
-
"BANK_TRANSFER",
|
|
35
|
-
"VIRTUAL_ACCOUNT",
|
|
36
|
-
"MOBILE",
|
|
37
|
-
"EASY_PAY"
|
|
38
|
-
]);
|
|
39
|
-
/** 결제를 처리하는 PG. 셀러가 직접 계약하고 콘솔 설정 › 결제에서 연결한다 */
|
|
40
|
-
const pgProviderSchema = z.enum(["tosspayments", "portone"]);
|
|
41
|
-
/** 간편결제사. 토스페이먼츠·포트원 모두 같은 코드를 쓴다 */
|
|
42
|
-
const easyPayProviderSchema = z.enum([
|
|
43
|
-
"NAVERPAY",
|
|
44
|
-
"KAKAOPAY",
|
|
45
|
-
"TOSSPAY",
|
|
46
|
-
"PAYCO"
|
|
47
|
-
]);
|
|
48
|
-
/**
|
|
49
|
-
* 응답에 실리는 간편결제사 — 서버가 간편결제사를 추가해도 파싱이 깨지지 않게 문자열로 받는다
|
|
50
|
-
* (`pgProvider`·결제 상태와 같은 방식). 요청과 결제 옵션은 값을 골라 보내는 자리라 enum 그대로다.
|
|
51
|
-
*/
|
|
52
|
-
const easyPayProviderResponseSchema = z.string();
|
|
53
|
-
const pg = pgProviderSchema.describe("결제를 처리할 PG");
|
|
54
|
-
/**
|
|
55
|
-
* 결제 옵션 — 어느 PG로 어떤 결제수단을 쓸지. `method`로 좁히면 필요한 필드가 타입으로 정해진다
|
|
56
|
-
* (`EASY_PAY`만 `provider`가 있다). 주문서의 `paymentOptions` 항목을 그대로 넘기거나 직접 써도 된다.
|
|
57
|
-
* 셀러가 켜지 않은 조합이면 서버가 409 `PAYMENT_OPTION_UNAVAILABLE`로 거절한다.
|
|
58
|
-
*/
|
|
59
|
-
const paymentOptionSchema = z.discriminatedUnion("method", [
|
|
60
|
-
z.object({
|
|
61
|
-
pg,
|
|
62
|
-
method: z.literal("CARD")
|
|
63
|
-
}),
|
|
64
|
-
z.object({
|
|
65
|
-
pg,
|
|
66
|
-
method: z.literal("EASY_PAY"),
|
|
67
|
-
provider: easyPayProviderSchema.describe("간편결제사 — 이 간편결제 결제창을 바로 연다")
|
|
68
|
-
}),
|
|
69
|
-
z.object({
|
|
70
|
-
pg,
|
|
71
|
-
method: z.literal("BANK_TRANSFER")
|
|
72
|
-
}),
|
|
73
|
-
z.object({
|
|
74
|
-
pg,
|
|
75
|
-
method: z.literal("VIRTUAL_ACCOUNT")
|
|
76
|
-
}),
|
|
77
|
-
z.object({
|
|
78
|
-
pg,
|
|
79
|
-
method: z.literal("MOBILE")
|
|
80
|
-
})
|
|
81
|
-
]);
|
|
82
|
-
/** 주문서가 내려주는 결제 옵션 — 결제 옵션 + 표시 이름 */
|
|
83
|
-
const availablePaymentOptionSchema = paymentOptionSchema.and(z.object({
|
|
84
|
-
label: z.string().describe("결제수단 표시 이름 (예: 신용·체크카드, 네이버페이)"),
|
|
85
|
-
pgName: z.string().describe("PG 표시 이름 (예: 토스페이먼츠)")
|
|
86
|
-
}));
|
|
87
|
-
/**
|
|
88
|
-
* 결제 옵션 목록 — 서버가 나중에 추가한 결제수단·PG를 이 SDK가 모르면 **그 항목만 빼고** 읽는다(목록 파싱은 깨지지 않는다).
|
|
89
|
-
*
|
|
90
|
-
* 모르는 항목을 버리는 일은 `preprocess`가 하고 항목 타입은 그대로 남는다 — OpenAPI 문서에 `items` 없는
|
|
91
|
-
* 배열로 나가지 않게 하기 위해서다(`z.array(z.unknown()).transform(...)`은 출력 타입을 표현하지 못한다).
|
|
92
|
-
*/
|
|
93
|
-
const paymentOptionListSchema = z.preprocess((value) => Array.isArray(value) ? value.filter((item) => availablePaymentOptionSchema.safeParse(item).success) : value, z.array(availablePaymentOptionSchema));
|
|
94
|
-
/** 결제 옵션을 화면 키로 — 라디오 value·React key. 예: `tosspayments:CARD`, `portone:EASY_PAY:NAVERPAY` */
|
|
95
|
-
function paymentOptionKey(option) {
|
|
96
|
-
return option.method === "EASY_PAY" ? `${option.pg}:EASY_PAY:${option.provider}` : `${option.pg}:${option.method}`;
|
|
97
|
-
}
|
|
98
|
-
const shippingAddressInputSchema = z.object({
|
|
99
|
-
addressId: z.string().optional(),
|
|
100
|
-
receiverName: z.string().min(1, "수령인명을 입력해주세요").max(50),
|
|
101
|
-
phone: z.string().regex(/^01[0-9]{8,9}$/, "연락처 형식이 아닙니다 (예: 01012345678)"),
|
|
102
|
-
zipCode: z.string().regex(/^[0-9]{5}$/, "우편번호는 5자리 숫자입니다"),
|
|
103
|
-
address1: z.string().min(1, "기본 주소를 입력해주세요"),
|
|
104
|
-
address2: z.string().optional(),
|
|
105
|
-
deliveryMemo: z.string().max(100).optional(),
|
|
106
|
-
entranceCode: z.string().max(20).optional()
|
|
107
|
-
});
|
|
108
|
-
const guestInfoSchema = z.object({
|
|
109
|
-
name: z.string().min(1),
|
|
110
|
-
phone: z.string().regex(/^01[0-9]{8,9}$/),
|
|
111
|
-
email: z.email(),
|
|
112
|
-
orderPassword: z.string().min(6, "주문 조회 비밀번호는 6자 이상이어야 합니다")
|
|
113
|
-
});
|
|
114
|
-
/**
|
|
115
|
-
* 결제 시작 — 배송지를 확정하고 고른 결제 옵션으로 결제 시도를 연다. 응답의 `payUrl`(결제 서비스)을 팝업(`mode=popup`)이나
|
|
116
|
-
* 전체 페이지로 열면 결제 서비스가 PG 결제창을 띄우고 승인까지 한다. 리다이렉트 결제가 끝나면 구매자는 `returnUrl`로 돌아온다.
|
|
117
|
-
* `returnUrl`의 도메인은 스토어 결제 도메인(콘솔 설정 › 결제)에 등록돼 있어야 한다(테스트 결제는 localhost 허용).
|
|
118
|
-
*/
|
|
119
|
-
const startPaymentRequestSchema = z.object({
|
|
120
|
-
option: paymentOptionSchema,
|
|
121
|
-
returnUrl: z.url().max(2048).describe("결제를 마치면 돌아올 스토어프론트 주소. 스토어 결제 도메인에 등록된 도메인이어야 한다"),
|
|
122
|
-
shippingAddress: shippingAddressInputSchema,
|
|
123
|
-
guest: guestInfoSchema.optional()
|
|
124
|
-
});
|
|
125
|
-
/** 같은 결제에서 다른 결제 옵션으로 다시 시도. `returnUrl`을 생략하면 결제 시작 때의 복귀 주소를 쓴다 */
|
|
126
|
-
const retryPaymentRequestSchema = z.object({
|
|
127
|
-
option: paymentOptionSchema,
|
|
128
|
-
returnUrl: startPaymentRequestSchema.shape.returnUrl.optional()
|
|
129
|
-
});
|
|
130
|
-
const paymentStartSchema = z.object({
|
|
131
|
-
paymentId: z.string().describe("결제 id. 상태 조회·재시도의 키다"),
|
|
132
|
-
attemptId: z.string().describe("결제 시도 id. PG 주문번호(토스 orderId, 포트원 paymentId)다"),
|
|
133
|
-
option: paymentOptionSchema.describe("이 시도의 결제 옵션"),
|
|
134
|
-
payUrl: z.string().describe("결제 서비스 주소. 팝업으로 열려면 쿼리 `mode=popup`을 붙이고, 그대로 이동하면 리다이렉트 결제다"),
|
|
135
|
-
expiresAt: z.string().describe("결제 요청 만료 시각"),
|
|
136
|
-
testPayment: z.boolean().describe("테스트 결제(샌드박스) 여부. true면 실제로 돈이 나가지 않는다 — 결제 화면에 테스트 결제 안내를 표시한다")
|
|
137
|
-
});
|
|
138
|
-
/** 결제창에서 결제하지 못한 이유 */
|
|
139
|
-
const paymentFailureCategorySchema = z.enum([
|
|
140
|
-
"PREPARE_FAILURE",
|
|
141
|
-
"DECLINED",
|
|
142
|
-
"USER_CANCELED"
|
|
143
|
-
]);
|
|
144
|
-
/**
|
|
145
|
-
* 결제 상태 조회의 현재 상태 값 — 응답 스키마는 서버가 상태를 추가해도 파싱이 깨지지 않게 문자열로 받는다
|
|
146
|
-
* (`pgProvider`와 같은 방식). 화면 분기는 이 목록으로 하고 모르는 값은 확인 중으로 다룬다.
|
|
147
|
-
*/
|
|
148
|
-
const PAYMENT_STATUS_VALUES = [
|
|
149
|
-
"pending",
|
|
150
|
-
"processing",
|
|
151
|
-
"completed",
|
|
152
|
-
"failed",
|
|
153
|
-
"expired"
|
|
154
|
-
];
|
|
155
|
-
/** 결제 결과 구분 — 결제 서비스가 스토어프론트에 돌려주는 값과 같다 */
|
|
156
|
-
const PAYMENT_RESULT_VALUES = [
|
|
157
|
-
"COMPLETED",
|
|
158
|
-
"PROCESSING",
|
|
159
|
-
"CANCELED",
|
|
160
|
-
"FAILED",
|
|
161
|
-
"EXPIRED",
|
|
162
|
-
"PENDING"
|
|
163
|
-
];
|
|
164
|
-
const paymentStatusSchema = z.object({
|
|
165
|
-
paymentId: z.string(),
|
|
166
|
-
status: z.string().describe("결제 상태. 현재 값은 `pending` 결제 대기 · `processing` 승인 확인 중 · `completed` 결제 완료(주문 생성) · `failed` 실패 · `expired` 만료예요. 상태가 추가될 수 있어 문자열로 받아요 — 모르는 값은 `processing`처럼 다루고 계속 조회하세요"),
|
|
167
|
-
result: z.string().describe("화면 분기용 결과. `COMPLETED` 결제 완료 · `PROCESSING` 결과 확인 중 · `CANCELED` 구매자가 결제창을 닫음 · `FAILED` 결제 실패(다른 결제 옵션으로 재시도 가능) · `EXPIRED` 결제 요청 만료 · `PENDING` 결제 전이에요. 값이 추가될 수 있어 문자열로 받아요 — 모르는 값은 `PROCESSING`처럼 다루세요"),
|
|
168
|
-
orderId: z.string().nullable().describe("결제가 완료됐으면 주문 번호, 그 외에는 null"),
|
|
169
|
-
lastFailure: z.object({
|
|
170
|
-
attemptId: z.string(),
|
|
171
|
-
category: z.string().describe("`PREPARE_FAILURE`·`DECLINED`·`USER_CANCELED`(값이 추가될 수 있다)"),
|
|
172
|
-
code: z.string().nullable().describe("PG가 준 실패 코드. 내부 사유는 null이에요. 화면 분기는 `category`로 하세요"),
|
|
173
|
-
message: z.string().nullable().describe("구매자에게 보여 줄 안내 문구")
|
|
174
|
-
}).nullable().describe("현재 결제 시도가 실패·취소로 끝났으면 그 내용, 아니면 null"),
|
|
175
|
-
testPayment: z.boolean().describe("테스트 결제(샌드박스)인가. true면 실제로 돈이 나가지 않았어요"),
|
|
176
|
-
expiresAt: z.string().describe("결제 요청 만료 시각")
|
|
177
|
-
});
|
|
178
|
-
/**
|
|
179
|
-
* 결제 서비스가 팝업 opener에 보내는 메시지 — `type`으로 거르고 결과의 원천은 결제 상태 조회다.
|
|
180
|
-
* 안내 문구는 싣지 않는다. 화면 문구는 상태 조회의 `lastFailure`를 쓴다
|
|
181
|
-
*/
|
|
182
|
-
const paymentMessageSchema = z.object({
|
|
183
|
-
type: z.literal("sayren:payment"),
|
|
184
|
-
paymentId: z.string(),
|
|
185
|
-
result: z.string(),
|
|
186
|
-
orderId: z.string().optional()
|
|
187
|
-
});
|
|
188
|
-
//#endregion
|
|
189
|
-
export { pgProviderSchema as _, createCheckoutRequestSchema as a, startPaymentRequestSchema as b, guestInfoSchema as c, paymentMethodSchema as d, paymentOptionKey as f, paymentStatusSchema as g, paymentStartSchema as h, checkoutSessionSchema as i, paymentFailureCategorySchema as l, paymentOptionSchema as m, PAYMENT_STATUS_VALUES as n, easyPayProviderResponseSchema as o, paymentOptionListSchema as p, availablePaymentOptionSchema as r, easyPayProviderSchema as s, PAYMENT_RESULT_VALUES as t, paymentMessageSchema as u, retryPaymentRequestSchema as v, shippingAddressInputSchema as y };
|