@tossplace/pos-plugin-sdk 0.0.19 → 0.0.21

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>;
 
 /**
@@ -1527,6 +1601,29 @@ export declare interface PluginTableGroup {
     tableIds: number[];
 }
 
+declare class PluginUnicast implements PluginUnicastTypes {
+    private pluginName;
+    private readonly sendBuffer;
+    private readonly sendEventBuffer;
+    private readonly listenHandlers;
+    constructor();
+    send: <T = any>(message: T, to: string) => void;
+    listen: <T = any>(event: UnicastEvent, callback: (message: T, from: string) => void) => (() => void);
+    private sendToWebview;
+    private flushSendBuffer;
+    private flushSendEventBuffer;
+}
+
+export declare const pluginUnicast: PluginUnicast;
+
+/**
+ * @publicApi
+ */
+export declare type PluginUnicastTypes = {
+    send<T = any>(message: T, to: string): void;
+    listen<T = any>(event: 'message', callback: (message: T, from: string) => void): () => void;
+};
+
 /**
  * @publicApi
  */
@@ -1573,6 +1670,8 @@ export declare type PosPluginSdk = {
     error: ErrorImpl;
     powerSaver: PowerSaverTypes;
     sound: SoundTypes;
+    kdsOrder: KdsOrder;
+    pluginUnicast: PluginUnicastTypes;
 };
 
 /**
@@ -1732,6 +1831,7 @@ declare type TextInput = BaseInput & {
  */
 export declare type ToastTypes = {
     open(message: string): void;
+    on(event: 'click', callback: () => void): () => void;
 };
 
 /**
@@ -1777,6 +1877,8 @@ declare class UiImpl implements Ui {
     openInputModal(data: Omit<PopupElement<'input'>, 'type'>): Promise<PopupActionResponse<'input'>>;
 }
 
+declare type UnicastEvent = 'message';
+
 declare type ValueOf<ObjectType, ValueType extends keyof ObjectType = keyof ObjectType> = ObjectType[ValueType];
 
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tossplace/pos-plugin-sdk",
-  "version": "0.0.19",
+  "version": "0.0.21",
   "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>;
 
 /**
@@ -1520,6 +1594,29 @@ export declare interface PluginTableGroup {
     tableIds: number[];
 }
 
+declare class PluginUnicast implements PluginUnicastTypes {
+    private pluginName;
+    private readonly sendBuffer;
+    private readonly sendEventBuffer;
+    private readonly listenHandlers;
+    constructor();
+    send: <T = any>(message: T, to: string) => void;
+    listen: <T = any>(event: UnicastEvent, callback: (message: T, from: string) => void) => (() => void);
+    private sendToWebview;
+    private flushSendBuffer;
+    private flushSendEventBuffer;
+}
+
+export declare const pluginUnicast: PluginUnicast;
+
+/**
+ * @publicApi
+ */
+export declare type PluginUnicastTypes = {
+    send<T = any>(message: T, to: string): void;
+    listen<T = any>(event: 'message', callback: (message: T, from: string) => void): () => void;
+};
+
 /**
  * @publicApi
  */
@@ -1566,6 +1663,8 @@ export declare type PosPluginSdk = {
     error: ErrorImpl;
     powerSaver: PowerSaverTypes;
     sound: SoundTypes;
+    kdsOrder: KdsOrder;
+    pluginUnicast: PluginUnicastTypes;
 };
 
 /**
@@ -1725,6 +1824,7 @@ declare type TextInput = BaseInput & {
  */
 export declare type ToastTypes = {
     open(message: string): void;
+    on(event: 'click', callback: () => void): () => void;
 };
 
 /**
@@ -1770,6 +1870,8 @@ declare class UiImpl implements Ui {
     openInputModal(data: Omit<PopupElement<'input'>, 'type'>): Promise<PopupActionResponse<'input'>>;
 }
 
+declare type UnicastEvent = 'message';
+
 declare type ValueOf<ObjectType, ValueType extends keyof ObjectType = keyof ObjectType> = ObjectType[ValueType];
 
 /**