@sayren/storefront-sdk 0.10.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.mjs +1 -1
- package/dist/checkout-CHpxo2Ap.mjs +310 -0
- package/dist/{client-DEMo7UZc.mjs → client-CHfCafer.mjs} +40 -6
- package/dist/{index-UeHUNywG.d.mts → index-OqvbJ6Xi.d.mts} +273 -2
- package/dist/index.d.mts +2 -2
- 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/client.ts +16 -0
- package/src/payments/index.ts +11 -1
- package/src/schemas/checkout.ts +192 -1
- package/src/schemas/claim.ts +23 -0
- package/src/schemas/order.ts +40 -7
- package/dist/checkout-JFk3b8RG.mjs +0 -189
package/src/schemas/checkout.ts
CHANGED
|
@@ -17,6 +17,44 @@ export const createCheckoutRequestSchema = z
|
|
|
17
17
|
|
|
18
18
|
export type CreateCheckoutRequest = z.infer<typeof createCheckoutRequestSchema>;
|
|
19
19
|
|
|
20
|
+
/** 지역 추가 배송비 구분 — 우편번호로 판정한다 */
|
|
21
|
+
export const remoteAreaSchema = z.enum(["NONE", "JEJU", "ISOLATED"]);
|
|
22
|
+
|
|
23
|
+
export type RemoteArea = z.infer<typeof remoteAreaSchema>;
|
|
24
|
+
|
|
25
|
+
/**
|
|
26
|
+
* 배송비 내역 (이슈 #29) — 배송비를 **몇 번, 왜** 부과했는지다.
|
|
27
|
+
*
|
|
28
|
+
* 배송비는 **배송 묶음**마다 붙는다. 같은 출고지 + 같은 배송 정책인 상품은 한 묶음이고 한 번만 낸다.
|
|
29
|
+
* 제주·도서산간 추가 배송비는 묶음마다 더하고, 무료배송이어도 붙는다.
|
|
30
|
+
*
|
|
31
|
+
* 주문서를 만들 때는 배송지를 모르므로 `zipCode`가 null이고 `remoteSurcharge`가 0이다.
|
|
32
|
+
* 배송지를 입력하면 `POST /storefront/v1/checkout/{checkoutId}/delivery-quote`로 다시 받고,
|
|
33
|
+
* **결제 시작이 보낸 배송지로 최종 확정한다** — 그래서 주문서 조회 금액과 실제 결제 금액이 다를 수 있다.
|
|
34
|
+
*/
|
|
35
|
+
export const checkoutDeliverySchema = z.object({
|
|
36
|
+
baseFee: z.number().int().describe("기본 배송비 합계. 묶음마다 부과한 금액의 합이다"),
|
|
37
|
+
remoteSurcharge: z
|
|
38
|
+
.number()
|
|
39
|
+
.int()
|
|
40
|
+
.describe("제주·도서산간 추가 배송비 합계. 묶음마다 붙는다. 배송지를 모르면 0"),
|
|
41
|
+
remoteArea: remoteAreaSchema.describe("배송지 지역 구분. 배송지를 모르면 NONE"),
|
|
42
|
+
remoteAreaLabel: z
|
|
43
|
+
.string()
|
|
44
|
+
.nullable()
|
|
45
|
+
.describe("지역 안내 이름(예: 제주특별자치도). 추가 배송비 지역이 아니면 null"),
|
|
46
|
+
bundleCount: z.number().int().describe("배송 묶음 수 — 배송비를 부과한 횟수다"),
|
|
47
|
+
freeByThreshold: z
|
|
48
|
+
.boolean()
|
|
49
|
+
.describe("스토어 전체 무료배송 기준액을 넘겨 기본 배송비를 면제했는가"),
|
|
50
|
+
zipCode: z
|
|
51
|
+
.string()
|
|
52
|
+
.nullable()
|
|
53
|
+
.describe("이 금액에 반영한 배송지 우편번호. null이면 배송지 미반영(추가 배송비 0)이다"),
|
|
54
|
+
});
|
|
55
|
+
|
|
56
|
+
export type CheckoutDelivery = z.infer<typeof checkoutDeliverySchema>;
|
|
57
|
+
|
|
20
58
|
export const checkoutSessionSchema = z.object({
|
|
21
59
|
checkoutId: z.string(),
|
|
22
60
|
items: z.array(
|
|
@@ -36,6 +74,9 @@ export const checkoutSessionSchema = z.object({
|
|
|
36
74
|
deliveryFee: z.number().int(),
|
|
37
75
|
totalAmount: z.number().int(),
|
|
38
76
|
}),
|
|
77
|
+
delivery: checkoutDeliverySchema.describe(
|
|
78
|
+
"배송비 내역. 배송지를 입력하면 금액이 바뀔 수 있다 — 최종 금액은 결제 시작 응답의 `amounts`다",
|
|
79
|
+
),
|
|
39
80
|
expiresAt: z.string(),
|
|
40
81
|
paymentOptions: z
|
|
41
82
|
.lazy(() => paymentOptionListSchema)
|
|
@@ -51,6 +92,28 @@ export const checkoutSessionSchema = z.object({
|
|
|
51
92
|
|
|
52
93
|
export type CheckoutSession = z.infer<typeof checkoutSessionSchema>;
|
|
53
94
|
|
|
95
|
+
/**
|
|
96
|
+
* 배송비 미리보기 요청 — 배송지 우편번호로 배송비를 다시 계산한다. 주문서를 바꾸지 않는다(읽기 계산이다).
|
|
97
|
+
*
|
|
98
|
+
* 구매자가 배송지를 입력하거나 고칠 때 부르면 제주·도서산간 추가 배송비가 반영된 금액을 미리 보여 줄 수 있다.
|
|
99
|
+
*/
|
|
100
|
+
export const deliveryQuoteRequestSchema = z.object({
|
|
101
|
+
zipCode: z
|
|
102
|
+
.string()
|
|
103
|
+
.regex(/^[0-9]{5}$/, "우편번호 5자리를 입력해 주세요")
|
|
104
|
+
.describe("배송지 우편번호 5자리"),
|
|
105
|
+
});
|
|
106
|
+
|
|
107
|
+
export type DeliveryQuoteRequest = z.infer<typeof deliveryQuoteRequestSchema>;
|
|
108
|
+
|
|
109
|
+
/** 배송비 미리보기 응답 — 이 배송지로 결제하면 나갈 금액이다 */
|
|
110
|
+
export const deliveryQuoteSchema = z.object({
|
|
111
|
+
amounts: checkoutSessionSchema.shape.amounts.describe("이 배송지 기준 금액"),
|
|
112
|
+
delivery: checkoutDeliverySchema,
|
|
113
|
+
});
|
|
114
|
+
|
|
115
|
+
export type DeliveryQuoteResult = z.infer<typeof deliveryQuoteSchema>;
|
|
116
|
+
|
|
54
117
|
export const paymentMethodSchema = z.enum([
|
|
55
118
|
"CARD",
|
|
56
119
|
"BANK_TRANSFER",
|
|
@@ -147,6 +210,122 @@ export const guestInfoSchema = z.object({
|
|
|
147
210
|
|
|
148
211
|
export type GuestInfo = z.infer<typeof guestInfoSchema>;
|
|
149
212
|
|
|
213
|
+
/** 현금영수증을 신청할 수 있는 결제수단 — 계좌이체·가상계좌 */
|
|
214
|
+
export const CASH_RECEIPT_METHODS = ["BANK_TRANSFER", "VIRTUAL_ACCOUNT"] as const;
|
|
215
|
+
|
|
216
|
+
/** 이 결제수단으로 현금영수증을 신청할 수 있는가 */
|
|
217
|
+
export function cashReceiptAvailable(method: string): boolean {
|
|
218
|
+
return (CASH_RECEIPT_METHODS as readonly string[]).includes(method);
|
|
219
|
+
}
|
|
220
|
+
|
|
221
|
+
/** 현금영수증 용도 — `INCOME_DEDUCTION` 소득공제(개인) · `EXPENSE_PROOF` 지출증빙(사업자) */
|
|
222
|
+
export const cashReceiptTypeSchema = z.enum(["INCOME_DEDUCTION", "EXPENSE_PROOF"]);
|
|
223
|
+
export type CashReceiptType = z.infer<typeof cashReceiptTypeSchema>;
|
|
224
|
+
|
|
225
|
+
/** 현금영수증 식별 번호 종류 — 휴대폰 번호 · 현금영수증카드 번호 · 사업자등록번호 */
|
|
226
|
+
export type CashReceiptIdentityType = "PHONE" | "CARD" | "BUSINESS";
|
|
227
|
+
|
|
228
|
+
/**
|
|
229
|
+
* 주민등록번호·외국인등록번호 형식인가 — 현금영수증 식별 번호로는 받지 않는다.
|
|
230
|
+
*
|
|
231
|
+
* 현금영수증카드 번호의 아래 끝(13자리)이 주민등록번호 길이와 겹친다. 개인 식별 번호는 최소로 받는다는 원칙이라
|
|
232
|
+
* 주민등록번호로 읽히는 값은 카드 번호 자리로도 받지 않는다.
|
|
233
|
+
*
|
|
234
|
+
* **13자리 숫자 전부를 막지 않는다.** 13자리 현금영수증카드를 쓰는 구매자가 신청할 수 없게 되기 때문이다.
|
|
235
|
+
* 대신 주민등록번호 형식 — 생년월일 6자리(월 01~12, 일 01~31) + 성별·세기 코드(1~8, 5~8은 외국인등록번호) — 으로
|
|
236
|
+
* 판정해 오탐을 줄인다(13자리 숫자 중 이 형식에 걸리는 비율은 약 3%다).
|
|
237
|
+
*
|
|
238
|
+
* 검증번호(뒤 1자리 mod 11)까지는 보지 않는다. 한 자리 오타가 난 주민등록번호도 생년월일을 담고 있어 막아야 하고,
|
|
239
|
+
* 2020년 10월 이후 발급된 외국인등록번호에는 검증번호 규칙이 없다.
|
|
240
|
+
*
|
|
241
|
+
* `cashReceiptIdentityTypeOf`와 같이 하이픈·공백은 빼고 판정한다.
|
|
242
|
+
*/
|
|
243
|
+
export function residentNumberLike(identityNumber: string): boolean {
|
|
244
|
+
const digits = identityNumber.replace(/[\s-]/g, "");
|
|
245
|
+
if (!/^[0-9]{13}$/.test(digits)) return false;
|
|
246
|
+
const month = Number(digits.slice(2, 4));
|
|
247
|
+
const day = Number(digits.slice(4, 6));
|
|
248
|
+
const genderCode = Number(digits[6]);
|
|
249
|
+
return month >= 1 && month <= 12 && day >= 1 && day <= 31 && genderCode >= 1 && genderCode <= 8;
|
|
250
|
+
}
|
|
251
|
+
|
|
252
|
+
/**
|
|
253
|
+
* 식별 번호 → 종류. 하이픈·공백은 빼고 판정한다. 용도에 맞지 않는 번호면 null이다.
|
|
254
|
+
* - 소득공제: 휴대폰 번호(01로 시작하는 10~11자리) 또는 현금영수증카드 번호(13~19자리)
|
|
255
|
+
* - 지출증빙: 사업자등록번호(10자리) 또는 현금영수증카드 번호(13~19자리)
|
|
256
|
+
*
|
|
257
|
+
* 자릿수 근거. PG 문서는 식별 번호의 최대 길이만 정하고 종류별 자릿수는 정하지 않는다
|
|
258
|
+
* (토스페이먼츠 `customerIdentityNumber` "최대 길이는 30자", 소득공제는 휴대폰 번호·현금영수증카드 번호,
|
|
259
|
+
* 지출증빙은 사업자등록번호: https://docs.tosspayments.com/common/apis/cash-receipt /
|
|
260
|
+
* 포트원 V2는 종류만 PHONE·CARD·BUSINESS로 나눈다: https://developers.portone.io/api/rest-v2/payment.cashReceipt).
|
|
261
|
+
* 그래서 자릿수는 국세청이 정하는 발급수단 규격을 따른다 — 홈택스 소비자 발급수단 등록의 카드 번호는
|
|
262
|
+
* 13~19자리 숫자이고(https://thisthatbase.com/cash-receipts-card-registration/ 가 옮긴 홈택스 안내,
|
|
263
|
+
* 원본은 https://www.hometax.go.kr/ 소비자 발급수단 관리), 사업자등록번호는 10자리, 휴대폰 번호는 01X + 7~8자리다.
|
|
264
|
+
* 국세청 자진발급 번호(010-000-1234)도 휴대폰 형식으로 통과한다.
|
|
265
|
+
*/
|
|
266
|
+
export function cashReceiptIdentityTypeOf(
|
|
267
|
+
type: CashReceiptType,
|
|
268
|
+
identityNumber: string,
|
|
269
|
+
): CashReceiptIdentityType | null {
|
|
270
|
+
const digits = identityNumber.replace(/[\s-]/g, "");
|
|
271
|
+
if (!/^[0-9]+$/.test(digits)) return null;
|
|
272
|
+
if (residentNumberLike(digits)) return null;
|
|
273
|
+
if (/^[0-9]{13,19}$/.test(digits)) return "CARD";
|
|
274
|
+
if (type === "INCOME_DEDUCTION") return /^01[016789][0-9]{7,8}$/.test(digits) ? "PHONE" : null;
|
|
275
|
+
return /^[0-9]{10}$/.test(digits) ? "BUSINESS" : null;
|
|
276
|
+
}
|
|
277
|
+
|
|
278
|
+
/**
|
|
279
|
+
* 현금영수증 신청 — 계좌이체·가상계좌 결제에서만 보낼 수 있다. 결제가 승인되면 sayren이 결제한 PG로 발급하고,
|
|
280
|
+
* 환불하면 그만큼 취소한다. 식별 번호는 암호화해 저장하고 응답에는 가린 값만 나간다.
|
|
281
|
+
*/
|
|
282
|
+
export const cashReceiptRequestSchema = z
|
|
283
|
+
.object({
|
|
284
|
+
type: cashReceiptTypeSchema.describe(
|
|
285
|
+
"용도. `INCOME_DEDUCTION` 소득공제(개인) · `EXPENSE_PROOF` 지출증빙(사업자)",
|
|
286
|
+
),
|
|
287
|
+
identityNumber: z
|
|
288
|
+
.string()
|
|
289
|
+
.max(30)
|
|
290
|
+
.describe(
|
|
291
|
+
"식별 번호. 소득공제는 휴대폰 번호(01X + 7~8자리) 또는 현금영수증카드 번호(13~19자리), 지출증빙은 " +
|
|
292
|
+
"사업자등록번호(10자리) 또는 현금영수증카드 번호(13~19자리). 하이픈은 빼고 읽는다. " +
|
|
293
|
+
"주민등록번호는 받지 않는다(`RESIDENT_NUMBER_NOT_ALLOWED`)",
|
|
294
|
+
),
|
|
295
|
+
})
|
|
296
|
+
.superRefine((value, ctx) => {
|
|
297
|
+
// 주민등록번호는 단순 형식 오류와 가른다 — 구매자에게 다른 번호를 입력하라고 안내해야 하고,
|
|
298
|
+
// 셀러·개발자가 필드 오류 코드로 이 경로를 집계할 수 있어야 한다.
|
|
299
|
+
// 필드 오류 코드는 메시지 끝의 `(CODE)`에서 나온다(api `zod-validation.pipe.ts`의 `extractCode`).
|
|
300
|
+
if (residentNumberLike(value.identityNumber)) {
|
|
301
|
+
ctx.addIssue({
|
|
302
|
+
code: "custom",
|
|
303
|
+
path: ["identityNumber"],
|
|
304
|
+
message:
|
|
305
|
+
"주민등록번호는 현금영수증 식별 번호로 쓸 수 없어요. " +
|
|
306
|
+
"휴대폰 번호 또는 현금영수증카드 번호를 입력해주세요 (RESIDENT_NUMBER_NOT_ALLOWED)",
|
|
307
|
+
});
|
|
308
|
+
return;
|
|
309
|
+
}
|
|
310
|
+
if (!cashReceiptIdentityTypeOf(value.type, value.identityNumber)) {
|
|
311
|
+
ctx.addIssue({
|
|
312
|
+
code: "custom",
|
|
313
|
+
path: ["identityNumber"],
|
|
314
|
+
message:
|
|
315
|
+
value.type === "INCOME_DEDUCTION"
|
|
316
|
+
? "휴대폰 번호 또는 현금영수증카드 번호를 입력해주세요"
|
|
317
|
+
: "사업자등록번호(10자리) 또는 현금영수증카드 번호를 입력해주세요",
|
|
318
|
+
});
|
|
319
|
+
}
|
|
320
|
+
});
|
|
321
|
+
export type CashReceiptRequest = z.infer<typeof cashReceiptRequestSchema>;
|
|
322
|
+
|
|
323
|
+
const cashReceiptField = cashReceiptRequestSchema
|
|
324
|
+
.optional()
|
|
325
|
+
.describe(
|
|
326
|
+
"현금영수증 신청. 계좌이체·가상계좌 옵션에서만 보낼 수 있다(그 밖의 옵션이면 400 `CASH_RECEIPT_NOT_AVAILABLE`). 결제가 승인되면 발급한다",
|
|
327
|
+
);
|
|
328
|
+
|
|
150
329
|
/**
|
|
151
330
|
* 결제 시작 — 배송지를 확정하고 고른 결제 옵션으로 결제 시도를 연다. 응답의 `payUrl`(결제 서비스)을 팝업(`mode=popup`)이나
|
|
152
331
|
* 전체 페이지로 열면 결제 서비스가 PG 결제창을 띄우고 승인까지 한다. 리다이렉트 결제가 끝나면 구매자는 `returnUrl`로 돌아온다.
|
|
@@ -162,14 +341,20 @@ export const startPaymentRequestSchema = z.object({
|
|
|
162
341
|
),
|
|
163
342
|
shippingAddress: shippingAddressInputSchema,
|
|
164
343
|
guest: guestInfoSchema.optional(),
|
|
344
|
+
cashReceipt: cashReceiptField,
|
|
165
345
|
});
|
|
166
346
|
|
|
167
347
|
export type StartPaymentRequest = z.infer<typeof startPaymentRequestSchema>;
|
|
168
348
|
|
|
169
|
-
/**
|
|
349
|
+
/**
|
|
350
|
+
* 같은 결제에서 다른 결제 옵션으로 다시 시도. `returnUrl`을 생략하면 결제 시작 때의 복귀 주소를 쓴다.
|
|
351
|
+
* `cashReceipt`를 보내면 현금영수증 신청을 이 값으로 바꾸고, 생략하면 결제 시작 때의 신청을 그대로 둔다
|
|
352
|
+
* (승인된 결제수단이 계좌이체·가상계좌가 아니면 발급하지 않는다)
|
|
353
|
+
*/
|
|
170
354
|
export const retryPaymentRequestSchema = z.object({
|
|
171
355
|
option: paymentOptionSchema,
|
|
172
356
|
returnUrl: startPaymentRequestSchema.shape.returnUrl.optional(),
|
|
357
|
+
cashReceipt: cashReceiptField,
|
|
173
358
|
});
|
|
174
359
|
|
|
175
360
|
export type RetryPaymentRequest = z.infer<typeof retryPaymentRequestSchema>;
|
|
@@ -189,6 +374,12 @@ export const paymentStartSchema = z.object({
|
|
|
189
374
|
.describe(
|
|
190
375
|
"테스트 결제(샌드박스) 여부. true면 실제로 돈이 나가지 않는다 — 결제 화면에 테스트 결제 안내를 표시한다",
|
|
191
376
|
),
|
|
377
|
+
amounts: checkoutSessionSchema.shape.amounts.describe(
|
|
378
|
+
"**확정 결제 금액** — 보낸 배송지로 배송비를 다시 계산한 값이다. 주문서 조회 시점의 `amounts`와 다를 수 있다(제주·도서산간 추가 배송비)",
|
|
379
|
+
),
|
|
380
|
+
delivery: checkoutDeliverySchema.describe(
|
|
381
|
+
"확정 배송비 내역. `zipCode`는 보낸 배송지의 우편번호다",
|
|
382
|
+
),
|
|
192
383
|
});
|
|
193
384
|
|
|
194
385
|
export type PaymentStart = z.infer<typeof paymentStartSchema>;
|
package/src/schemas/claim.ts
CHANGED
|
@@ -56,6 +56,24 @@ export const createClaimResultSchema = z.object({
|
|
|
56
56
|
|
|
57
57
|
export type CreateClaimResult = z.infer<typeof createClaimResultSchema>;
|
|
58
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
|
+
|
|
59
77
|
export const myClaimSchema = z.object({
|
|
60
78
|
claimId: z.string(),
|
|
61
79
|
type: claimTypeSchema,
|
|
@@ -81,6 +99,11 @@ export const myClaimSchema = z.object({
|
|
|
81
99
|
"이 필드가 생기기 전에 접수된 클레임은 null이다",
|
|
82
100
|
),
|
|
83
101
|
rejectReason: z.string().nullable(),
|
|
102
|
+
returnAddress: claimReturnAddressSchema
|
|
103
|
+
.nullable()
|
|
104
|
+
.describe(
|
|
105
|
+
"반품·교환 물건을 보낼 반품지(이슈 #30). 직접 보내는 수거 안내에 쓴다. 취소 클레임은 null",
|
|
106
|
+
),
|
|
84
107
|
requestedAt: z.string(),
|
|
85
108
|
completedAt: z.string().nullable(),
|
|
86
109
|
});
|
package/src/schemas/order.ts
CHANGED
|
@@ -79,18 +79,51 @@ export const myOrderSchema = z.object({
|
|
|
79
79
|
|
|
80
80
|
export type MyOrder = z.infer<typeof myOrderSchema>;
|
|
81
81
|
|
|
82
|
+
/**
|
|
83
|
+
* 택배 추적 단계. 응답에서는 문자열로 받는다(값이 추가될 수 있다) — 현재 값은 `ACCEPTED`(접수)·`IN_TRANSIT`(이동 중)·
|
|
84
|
+
* `OUT_FOR_DELIVERY`(배송 출발)·`DELIVERED`(배송완료)다.
|
|
85
|
+
*/
|
|
86
|
+
export const trackingStageResponseSchema = z.string();
|
|
87
|
+
|
|
82
88
|
export const deliveryTrackingSchema = z.object({
|
|
83
89
|
carrierName: z.string(),
|
|
84
90
|
trackingNumber: z.string(),
|
|
85
91
|
trackingUrl: z.url(),
|
|
86
92
|
status: z.enum(["DISPATCHED", "DELIVERING", "DELIVERED"]),
|
|
87
|
-
trackingEvents: z
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
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
|
+
),
|
|
94
127
|
});
|
|
95
128
|
|
|
96
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 };
|