@sayren/store-sdk 0.20.0 → 0.22.0

package/src/schemas/saved-option-set.ts

@@ -0,0 +1,168 @@
+import { z } from "zod";
+import { type PageParams, pageQueryShape } from "./common";
+import {
+  MAX_ADDON_GROUPS,
+  MAX_CUSTOM_INPUT_LENGTH,
+  MAX_CUSTOM_INPUTS,
+  MAX_OPTION_GROUPS,
+  MAX_VALUES_PER_GROUP,
+  optionSortSchema,
+} from "./product";
+
+/**
+ * 저장 옵션 (이슈 #59) — 자주 쓰는 옵션 구성을 이름 붙여 두고 상품 등록에서 불러온다.
+ *
+ * **불러오기는 복사다.** 저장 옵션을 고치거나 지워도 이미 불러온 상품의 옵션은 그대로다. 재고·SKU·사용 여부는 상품마다
+ * 달라 저장하지 않는다. 추가금은 조합별이 아니라 **값별**로 둔다 — 조합 옵션으로 불러오면 조합 추가금은 고른 값 추가금의 합이다.
+ */
+
+/** 스토어당 저장 옵션 최대 개수 */
+export const MAX_SAVED_OPTION_SETS = 200;
+/** 저장 옵션 이름 최대 글자 수 */
+export const MAX_SAVED_OPTION_SET_NAME = 50;
+
+/** 옵션명 방식 — `combination`(조합: 값의 조합이 판매 단위가 된다)·`addon`(추가 선택: 재고 없이 추가금만) */
+export const optionGroupKindSchema = z.enum(["combination", "addon"]);
+
+export type OptionGroupKind = z.infer<typeof optionGroupKindSchema>;
+
+const nameSchema = z.string().trim().min(1).max(50);
+
+export const savedOptionValueSchema = z.object({
+  name: z.string(),
+  additionalPrice: z.number().int().describe("값별 추가금(원, 0 이상)"),
+});
+
+export const savedOptionGroupSchema = z.object({
+  name: z.string(),
+  kind: z
+    .string()
+    .describe(
+      "옵션명 방식. 현재 값은 `combination`·`addon`이고 값이 추가될 수 있어 문자열로 받는다",
+    ),
+  required: z.boolean().describe("추가 선택을 구매자가 꼭 고르는가. 조합 옵션명은 항상 false다"),
+  values: z.array(savedOptionValueSchema),
+});
+
+export type SavedOptionGroup = z.infer<typeof savedOptionGroupSchema>;
+
+export const savedCustomInputSchema = z.object({
+  label: z.string(),
+  placeholder: z.string().nullable(),
+  maxLength: z.number().int(),
+  required: z.boolean(),
+});
+
+export type SavedCustomInput = z.infer<typeof savedCustomInputSchema>;
+
+export const savedOptionSetSchema = z.object({
+  optionSetId: z.string(),
+  name: z.string(),
+  optionSort: optionSortSchema,
+  groups: z.array(savedOptionGroupSchema).describe("옵션명. 배열 순서가 입력 순서다"),
+  customInputs: z.array(savedCustomInputSchema),
+  importedProductCount: z
+    .number()
+    .int()
+    .describe("이 저장 옵션을 불러온 상품 수(중복 없이, 지운 상품 제외). 불러오기 기록으로 센다"),
+  createdAt: z.string(),
+  updatedAt: z.string(),
+});
+
+export type SavedOptionSet = z.infer<typeof savedOptionSetSchema>;
+
+export const savedOptionValueRequestSchema = z.object({
+  name: nameSchema,
+  additionalPrice: z.number().int().min(0).default(0),
+});
+
+export const savedOptionGroupRequestSchema = z.object({
+  name: nameSchema,
+  kind: optionGroupKindSchema,
+  required: z
+    .boolean()
+    .default(false)
+    .describe("추가 선택만 쓴다. 조합 옵션명에 true를 주면 400이다"),
+  values: z.array(savedOptionValueRequestSchema).min(1).max(MAX_VALUES_PER_GROUP),
+});
+
+export type SavedOptionGroupRequest = z.infer<typeof savedOptionGroupRequestSchema>;
+
+export const savedCustomInputRequestSchema = z.object({
+  label: z.string().trim().min(1).max(30),
+  placeholder: z.string().trim().max(100).nullish(),
+  maxLength: z.number().int().min(1).max(MAX_CUSTOM_INPUT_LENGTH),
+  required: z.boolean().default(false),
+});
+
+/**
+ * 저장 옵션 만들기·수정 본문. 조합 옵션명은 최대 `MAX_OPTION_GROUPS`개, 추가 선택은 최대 `MAX_ADDON_GROUPS`개이고
+ * 옵션명과 직접 입력 항목이 모두 비면 400이다. 수정(PUT)은 통째로 바꾼다.
+ */
+export const savedOptionSetRequestSchema = z.object({
+  name: z.string().trim().min(1).max(MAX_SAVED_OPTION_SET_NAME),
+  optionSort: optionSortSchema.default("REGISTERED"),
+  groups: z
+    .array(savedOptionGroupRequestSchema)
+    .max(MAX_OPTION_GROUPS + MAX_ADDON_GROUPS)
+    .default([]),
+  customInputs: z.array(savedCustomInputRequestSchema).max(MAX_CUSTOM_INPUTS).default([]),
+});
+
+export type SavedOptionSetRequest = z.infer<typeof savedOptionSetRequestSchema>;
+export type SavedOptionSetRequestInput = z.input<typeof savedOptionSetRequestSchema>;
+
+/**
+ * 상품에서 저장 (`POST /v1/saved-option-sets/from-product`) — 상품의 현재 옵션을 저장 옵션으로 만든다.
+ *
+ * 조합 추가금이 값별 추가금의 합으로 되돌려지면 값별로 저장하고, 조합마다 제각각이면 추가금을 빼고
+ * 응답 `additionalPriceDropped: true`로 알린다. `replaceOptionSetId`를 주면 그 저장 옵션을 덮어쓴다(이름 중복의 덮어쓰기).
+ */
+export const savedOptionSetFromProductRequestSchema = z.object({
+  productId: z.string(),
+  name: z.string().trim().min(1).max(MAX_SAVED_OPTION_SET_NAME),
+  includeOptions: z.boolean().default(true).describe("옵션명(조합·추가 선택)을 저장하는가"),
+  includeCustomInputs: z.boolean().default(true).describe("직접 입력 항목을 저장하는가"),
+  replaceOptionSetId: z.string().optional().describe("덮어쓸 저장 옵션 id. 생략하면 새로 만든다"),
+});
+
+export type SavedOptionSetFromProductRequest = z.infer<
+  typeof savedOptionSetFromProductRequestSchema
+>;
+export type SavedOptionSetFromProductRequestInput = z.input<
+  typeof savedOptionSetFromProductRequestSchema
+>;
+
+export const savedOptionSetFromProductResultSchema = z.object({
+  optionSet: savedOptionSetSchema,
+  additionalPriceDropped: z
+    .boolean()
+    .describe("조합 추가금을 값별 추가금으로 되돌릴 수 없어 추가금을 빼고 저장했는가"),
+});
+
+export type SavedOptionSetFromProductResult = z.infer<typeof savedOptionSetFromProductResultSchema>;
+
+/** 구성 필터 — 조합 옵션명·추가 선택 옵션명·직접 입력 항목을 가진 저장 옵션 */
+export const savedOptionSetCompositionSchema = z.enum(["combination", "addon", "customInput"]);
+
+export const savedOptionSetSortSchema = z.enum([
+  "updatedAt.desc",
+  "name.asc",
+  "importedProductCount.desc",
+]);
+
+export type SavedOptionSetSort = z.infer<typeof savedOptionSetSortSchema>;
+
+export interface SavedOptionSetListParams extends PageParams {
+  keyword?: string;
+  composition?: z.infer<typeof savedOptionSetCompositionSchema>;
+  sort?: SavedOptionSetSort;
+}
+
+/** `GET /v1/saved-option-sets` 쿼리 — OpenAPI 문서용 형태(값은 쿼리 문자열) */
+export const savedOptionSetListQuerySchema = z.object({
+  keyword: z.string().optional().describe("이름 검색 (포함, 대소문자 무시)"),
+  composition: savedOptionSetCompositionSchema.optional().describe("구성 필터"),
+  sort: savedOptionSetSortSchema.optional().describe("정렬 (기본 updatedAt.desc)"),
+  ...pageQueryShape({ defaultSize: 20, maxSize: 200 }),
+});