@tossplace/pos-plugin-sdk 0.0.12 → 0.0.14

package/dist/sdk.d.ts

@@ -500,13 +500,18 @@ declare type NumberInput = BaseInput & {
 export declare interface Order {
     getOrder: (id: string) => Promise<PluginOrder>;
     /**
-     * @param start yyyy-MM-dd
-     * @param end yyyy-MM-dd
+     * @param start ISO 8601 포맷
+     * @param end ISO 8601 포맷
+     * @param page default 1
+     * @param size default 20
      * @description createdAt 기준으로 주문을 조회합니다
      */
-    getOrders: (range: {
+    getOrders: (params: {
         start: string;
         end: string;
+        page?: number;
+        size?: number;
+        orderStates?: PluginOrderState[];
     }) => Promise<PluginOrder[]>;
     /**
      * @deprecated
@@ -922,6 +927,7 @@ export declare interface PluginCatalogItemOptionChoice {
     /** 키오스크에서 표시되는 아이콘 URL */
     imageUrl?: string | null;
     state: CatalogItemOptionChoiceState;
+    quantityInputEnabled: boolean;
 }
 
 /**
@@ -1027,6 +1033,7 @@ export declare type PluginDeliveryOrderDto = Omit<PluginOrderDto, 'lineItems' |
         optionChoices: Array<{
             title: string;
             priceValue: number;
+            quantity: number;
         }>;
         discounts?: Array<PluginDeliveryDiscount>;
     }>;
@@ -1094,7 +1101,7 @@ export declare interface PluginDraftOrderItem {
     /** 요청사항 */
     memo: string;
     /** 선택된 옵션 정보 */
-    optionChoices: PluginCatalogItemOptionChoice[];
+    optionChoices: PluginOrderItemOptionChoice[];
     /** 수량 */
     quantity: number;
     /** 식사 유형 */
@@ -1324,7 +1331,7 @@ export declare type PluginOrderDto = {
     numGuests?: number;
     discounts: PluginDiscount[];
     tableId?: number;
-    lineItems: Omit<PluginOrderItem, 'id' | 'orderId'>[];
+    lineItems: PluginOrderItemDto[];
 };
 
 /**
@@ -1346,11 +1353,48 @@ export declare interface PluginOrderItem {
     chargePrice: {
         value: number;
     };
-    optionChoices: PluginCatalogItemOptionChoice[];
+    optionChoices: PluginOrderItemOptionChoice[];
     discounts?: PluginDiscount[];
     memo?: string;
 }
 
+/**
+ * @publicApi
+ */
+declare interface PluginOrderItemDto {
+    diningOption: PluginOrderDiningOption;
+    item: Pick<PluginCatalogItem, 'id' | 'title' | 'category' | 'code'> & {
+        type: OrderItemType;
+    };
+    quantity: {
+        value: number;
+    };
+    /**
+     * @description 실제 고객이 결제하는 금액에 대한 정보입니다. (할인 적용 금액)
+     */
+    chargePrice: {
+        value: number;
+    };
+    optionChoices: PluginOrderItemItemOptionChoiceDto[];
+    discounts?: PluginDiscount[];
+    memo?: string;
+}
+
+/**
+ * @publicApi
+ */
+declare interface PluginOrderItemItemOptionChoiceDto {
+    id: number;
+    quantity: number;
+}
+
+/**
+ * 주문항목 옵션 선택
+ */
+declare interface PluginOrderItemOptionChoice extends PluginCatalogItemOptionChoice {
+    quantity: number;
+}
+
 declare interface PluginOrderPaymentPrice {
     /** 미납 결제 금액 */
     paymentUnpaidValue: number;
@@ -1361,10 +1405,6 @@ declare interface PluginOrderPaymentPrice {
 /**
  * @publicApi
  * 주문의 결제상태
- * 상태 전이 규칙은 아래 문서를 참조해주세요. (22.09)
- * https://www.notion.so/tossteam/1affab9356d24d2d9256ca21be2db473
- * 또다른 문서도 있어요. (25.03)
- * https://www.notion.so/tossteam/1c3a360d33e380979d4df2a1ba3bfd31
  *
  * OPENED: 결제 전 (초기 상태)
  * PAID: 부분 결제 (일부 금액만 결제된 상태)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tossplace/pos-plugin-sdk",
-  "version": "0.0.12",
+  "version": "0.0.14",
   "description": "포스 플러그인 sdk",
   "main": "dist/index.cjs.js",
   "module": "dist/index.esm.js",

package/types/index.d.ts

@@ -487,13 +487,18 @@ declare type NumberInput = BaseInput & {
 export declare interface Order {
     getOrder: (id: string) => Promise<PluginOrder>;
     /**
-     * @param start yyyy-MM-dd
-     * @param end yyyy-MM-dd
+     * @param start ISO 8601 포맷
+     * @param end ISO 8601 포맷
+     * @param page default 1
+     * @param size default 20
      * @description createdAt 기준으로 주문을 조회합니다
      */
-    getOrders: (range: {
+    getOrders: (params: {
         start: string;
         end: string;
+        page?: number;
+        size?: number;
+        orderStates?: PluginOrderState[];
     }) => Promise<PluginOrder[]>;
     /**
      * @deprecated
@@ -909,6 +914,7 @@ export declare interface PluginCatalogItemOptionChoice {
     /** 키오스크에서 표시되는 아이콘 URL */
     imageUrl?: string | null;
     state: CatalogItemOptionChoiceState;
+    quantityInputEnabled: boolean;
 }
 
 /**
@@ -1014,6 +1020,7 @@ export declare type PluginDeliveryOrderDto = Omit<PluginOrderDto, 'lineItems' |
         optionChoices: Array<{
             title: string;
             priceValue: number;
+            quantity: number;
         }>;
         discounts?: Array<PluginDeliveryDiscount>;
     }>;
@@ -1081,7 +1088,7 @@ export declare interface PluginDraftOrderItem {
     /** 요청사항 */
     memo: string;
     /** 선택된 옵션 정보 */
-    optionChoices: PluginCatalogItemOptionChoice[];
+    optionChoices: PluginOrderItemOptionChoice[];
     /** 수량 */
     quantity: number;
     /** 식사 유형 */
@@ -1311,7 +1318,7 @@ export declare type PluginOrderDto = {
     numGuests?: number;
     discounts: PluginDiscount[];
     tableId?: number;
-    lineItems: Omit<PluginOrderItem, 'id' | 'orderId'>[];
+    lineItems: PluginOrderItemDto[];
 };
 
 /**
@@ -1333,11 +1340,48 @@ export declare interface PluginOrderItem {
     chargePrice: {
         value: number;
     };
-    optionChoices: PluginCatalogItemOptionChoice[];
+    optionChoices: PluginOrderItemOptionChoice[];
     discounts?: PluginDiscount[];
     memo?: string;
 }
 
+/**
+ * @publicApi
+ */
+declare interface PluginOrderItemDto {
+    diningOption: PluginOrderDiningOption;
+    item: Pick<PluginCatalogItem, 'id' | 'title' | 'category' | 'code'> & {
+        type: OrderItemType;
+    };
+    quantity: {
+        value: number;
+    };
+    /**
+     * @description 실제 고객이 결제하는 금액에 대한 정보입니다. (할인 적용 금액)
+     */
+    chargePrice: {
+        value: number;
+    };
+    optionChoices: PluginOrderItemItemOptionChoiceDto[];
+    discounts?: PluginDiscount[];
+    memo?: string;
+}
+
+/**
+ * @publicApi
+ */
+declare interface PluginOrderItemItemOptionChoiceDto {
+    id: number;
+    quantity: number;
+}
+
+/**
+ * 주문항목 옵션 선택
+ */
+declare interface PluginOrderItemOptionChoice extends PluginCatalogItemOptionChoice {
+    quantity: number;
+}
+
 declare interface PluginOrderPaymentPrice {
     /** 미납 결제 금액 */
     paymentUnpaidValue: number;
@@ -1348,10 +1392,6 @@ declare interface PluginOrderPaymentPrice {
 /**
  * @publicApi
  * 주문의 결제상태
- * 상태 전이 규칙은 아래 문서를 참조해주세요. (22.09)
- * https://www.notion.so/tossteam/1affab9356d24d2d9256ca21be2db473
- * 또다른 문서도 있어요. (25.03)
- * https://www.notion.so/tossteam/1c3a360d33e380979d4df2a1ba3bfd31
  *
  * OPENED: 결제 전 (초기 상태)
  * PAID: 부분 결제 (일부 금액만 결제된 상태)