@tossplace/pos-plugin-sdk 0.0.19 → 0.0.20

package/dist/sdk.d.ts

@@ -361,6 +361,14 @@ declare type InputValue = {
 
 declare type Join<T extends string, U extends string> = `${T}${U}` | '0';
 
+/**
+ * @publicApi
+ */
+declare interface KdsOrder {
+    on(event: 'open' | 'complete' | 'cancel', callback: (id: PluginKdsOrderItem['id']) => void): void;
+    getKdsOrderItems(payload: PluginGetKdsOrderItemsPayload): Promise<PluginGetKdsOrderItemsResult>;
+}
+
 declare type Languages = Record<PluginLanguageCode, string>;
 
 /**
@@ -1111,6 +1119,21 @@ export declare interface PluginExternalPayment extends PluginPaymentBase {
     };
 }
 
+declare interface PluginGetKdsOrderItemsPayload {
+    states?: PluginKdsOrderItemState[];
+    page: number;
+    size: number;
+    orderIds?: string[];
+    categoryIds?: number[];
+    itemIds?: number[];
+}
+
+declare interface PluginGetKdsOrderItemsResult {
+    contents: PluginKdsOrderItem[];
+    last: boolean;
+    totalElements: number;
+}
+
 /**
  * @publicApi
  * 테이블이 놓여진 공간
@@ -1153,6 +1176,57 @@ declare class PluginImpl implements Plugin_2 {
  */
 export declare type PluginInputs = TextInput | PasswordInput | RadioInput | CheckBoxInput | ToggleInput | SliderInput | NumberInput;
 
+declare interface PluginKdsLineItem {
+    title: string;
+    diningOption: PluginOrderDiningOption;
+    id: string;
+    itemId: PluginOrderItem['id'];
+    memo: string;
+    optionChoices: PluginOrderItem['optionChoices'];
+    orderPrice: PluginKdsLineItemOrderPrice;
+    quantity: {
+        previous: number;
+        current: number;
+    };
+    appliedDiscounts: PluginDiscount[];
+    item: {
+        id: number;
+        category: {
+            id: number;
+            order: number;
+        };
+    };
+    createdAt: string;
+    updatedAt: string;
+}
+
+declare interface PluginKdsLineItemOrderPrice {
+    orderDiscountValue: number;
+    orderListPriceValue: number;
+    orderPriceValue: number;
+}
+
+declare interface PluginKdsOrder extends Omit<PluginOrder, 'lineItems'> {
+}
+
+declare interface PluginKdsOrderItem {
+    id: string;
+    state: PluginKdsOrderItemState;
+    order: PluginKdsOrder;
+    lineItems: PluginKdsLineItem[];
+    diningOption: PluginOrderDiningOption;
+    totalQuantity: number;
+    orderRequestType: PluginKdsOrderRequestType;
+    cancelledAt: string;
+    completedAt: string;
+    createdAt: string;
+    updatedAt: string;
+}
+
+declare type PluginKdsOrderItemState = 'OPENED' | 'COMPLETED' | 'CANCELLED';
+
+declare type PluginKdsOrderRequestType = 'ADDED' | 'NEW' | 'CHANGED' | 'CANCELLED' | 'MERGED';
+
 declare type PluginLanguageCode = ValueOf<typeof AvailableLanguageCodes>;
 
 /**
@@ -1573,6 +1647,7 @@ export declare type PosPluginSdk = {
     error: ErrorImpl;
     powerSaver: PowerSaverTypes;
     sound: SoundTypes;
+    kdsOrder: KdsOrder;
 };
 
 /**
@@ -1732,6 +1807,7 @@ declare type TextInput = BaseInput & {
  */
 export declare type ToastTypes = {
     open(message: string): void;
+    on(event: 'click', callback: () => void): () => void;
 };
 
 /**

package/package.json

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

package/types/index.d.ts

@@ -361,6 +361,14 @@ declare type InputValue = {
 
 declare type Join<T extends string, U extends string> = `${T}${U}` | '0';
 
+/**
+ * @publicApi
+ */
+declare interface KdsOrder {
+    on(event: 'open' | 'complete' | 'cancel', callback: (id: PluginKdsOrderItem['id']) => void): void;
+    getKdsOrderItems(payload: PluginGetKdsOrderItemsPayload): Promise<PluginGetKdsOrderItemsResult>;
+}
+
 declare type Languages = Record<PluginLanguageCode, string>;
 
 /**
@@ -1111,6 +1119,21 @@ export declare interface PluginExternalPayment extends PluginPaymentBase {
     };
 }
 
+declare interface PluginGetKdsOrderItemsPayload {
+    states?: PluginKdsOrderItemState[];
+    page: number;
+    size: number;
+    orderIds?: string[];
+    categoryIds?: number[];
+    itemIds?: number[];
+}
+
+declare interface PluginGetKdsOrderItemsResult {
+    contents: PluginKdsOrderItem[];
+    last: boolean;
+    totalElements: number;
+}
+
 /**
  * @publicApi
  * 테이블이 놓여진 공간
@@ -1153,6 +1176,57 @@ declare class PluginImpl implements Plugin_2 {
  */
 export declare type PluginInputs = TextInput | PasswordInput | RadioInput | CheckBoxInput | ToggleInput | SliderInput | NumberInput;
 
+declare interface PluginKdsLineItem {
+    title: string;
+    diningOption: PluginOrderDiningOption;
+    id: string;
+    itemId: PluginOrderItem['id'];
+    memo: string;
+    optionChoices: PluginOrderItem['optionChoices'];
+    orderPrice: PluginKdsLineItemOrderPrice;
+    quantity: {
+        previous: number;
+        current: number;
+    };
+    appliedDiscounts: PluginDiscount[];
+    item: {
+        id: number;
+        category: {
+            id: number;
+            order: number;
+        };
+    };
+    createdAt: string;
+    updatedAt: string;
+}
+
+declare interface PluginKdsLineItemOrderPrice {
+    orderDiscountValue: number;
+    orderListPriceValue: number;
+    orderPriceValue: number;
+}
+
+declare interface PluginKdsOrder extends Omit<PluginOrder, 'lineItems'> {
+}
+
+declare interface PluginKdsOrderItem {
+    id: string;
+    state: PluginKdsOrderItemState;
+    order: PluginKdsOrder;
+    lineItems: PluginKdsLineItem[];
+    diningOption: PluginOrderDiningOption;
+    totalQuantity: number;
+    orderRequestType: PluginKdsOrderRequestType;
+    cancelledAt: string;
+    completedAt: string;
+    createdAt: string;
+    updatedAt: string;
+}
+
+declare type PluginKdsOrderItemState = 'OPENED' | 'COMPLETED' | 'CANCELLED';
+
+declare type PluginKdsOrderRequestType = 'ADDED' | 'NEW' | 'CHANGED' | 'CANCELLED' | 'MERGED';
+
 declare type PluginLanguageCode = ValueOf<typeof AvailableLanguageCodes>;
 
 /**
@@ -1566,6 +1640,7 @@ export declare type PosPluginSdk = {
     error: ErrorImpl;
     powerSaver: PowerSaverTypes;
     sound: SoundTypes;
+    kdsOrder: KdsOrder;
 };
 
 /**
@@ -1725,6 +1800,7 @@ declare type TextInput = BaseInput & {
  */
 export declare type ToastTypes = {
     open(message: string): void;
+    on(event: 'click', callback: () => void): () => void;
 };
 
 /**