@tossplace/pos-plugin-sdk 0.0.24 → 0.0.26

package/dist/sdk.d.ts

@@ -1,3 +1,12 @@
+/**
+ * @publicApi
+ */
+export declare type AlertTypes = {
+    open(params: {
+        message: string;
+    }): void;
+};
+
 declare type AllPaymentCreateDto = PluginCardDto | PluginCashDto | PluginExternalDto;
 
 declare const AvailableLanguageCodes: {
@@ -430,6 +439,28 @@ declare type MovePayload = {
     };
 };
 
+/**
+ * @publicApi
+ */
+export declare interface Navigation {
+    navigate(page: 'plugin-tab', packageName?: string): void;
+    navigate(page: 'business-type-setting'): void;
+    /**
+     * 포스에서 페이지를 이동합니다.
+     * @param page business-type-setting 업종유형 변경, plugin-tab 플러그인 탭 이동
+     * @param packageName 이동할 탭의 이름, 없는 경우 첫번째 플러그인 탭으로 이동합니다
+     */
+    navigate(page: 'business-type-setting' | 'plugin-tab', packageName?: string): void;
+}
+
+/**
+ * @publicApi
+ */
+export declare class NavigationImpl implements Navigation {
+    navigate(page: 'plugin-tab', packageName?: string): void;
+    navigate(page: 'business-type-setting'): void;
+}
+
 /**
  * @publicApi
  * @return number
@@ -553,7 +584,8 @@ declare type PayCallback = (order: PluginOrder, price: PluginPrice, ui: Ui) => P
  * @publicApi
  */
 export declare interface Payment {
-    on: (event: 'cancel' | 'paid', callback: PaymentCallback) => void;
+    on(event: 'cancel' | 'paid', callback: PaymentCallback): void;
+    on(event: 'before-cancel', callback: PaymentBeforeCancelCallback): void;
     cancel: (order: {
         id: string;
     }, payment: {
@@ -565,6 +597,14 @@ export declare interface Payment {
     getPayment: (paymentId: PluginPayment['id']) => Promise<PluginPayment>;
 }
 
+/**
+ * @publicApi
+ */
+export declare type PaymentBeforeCancelCallback = (payload: {
+    order: PluginOrder;
+    payment: PluginPayment;
+}) => Promise<void>;
+
 declare type PaymentCallback = (paymentId: PluginPayment['id'], orderId: PluginOrder['id']) => void;
 
 /**
@@ -1154,6 +1194,9 @@ export declare interface PluginExternalPayment extends PluginPaymentBase {
     };
 }
 
+/**
+ * @publicApi
+ */
 declare interface PluginGetKdsOrderItemsPayload {
     states?: PluginKdsOrderItemState[];
     page: number;
@@ -1163,6 +1206,9 @@ declare interface PluginGetKdsOrderItemsPayload {
     itemIds?: number[];
 }
 
+/**
+ * @publicApi
+ */
 declare interface PluginGetKdsOrderItemsResult {
     contents: PluginKdsOrderItem[];
     last: boolean;
@@ -1212,6 +1258,9 @@ declare class PluginImpl implements Plugin_2 {
  */
 export declare type PluginInputs = TextInput | PasswordInput | RadioInput | CheckBoxInput | ToggleInput | SliderInput | NumberInput;
 
+/**
+ * @publicApi
+ */
 declare interface PluginKdsLineItem {
     title: string;
     diningOption: PluginOrderDiningOption;
@@ -1245,6 +1294,9 @@ declare interface PluginKdsLineItemOrderPrice {
 declare interface PluginKdsOrder extends Omit<PluginOrder, 'lineItems'> {
 }
 
+/**
+ * @publicApi
+ */
 declare interface PluginKdsOrderItem {
     id: string;
     state: PluginKdsOrderItemState;
@@ -1259,8 +1311,14 @@ declare interface PluginKdsOrderItem {
     updatedAt: string;
 }
 
+/**
+ * @publicApi
+ */
 declare type PluginKdsOrderItemState = 'REQUESTED' | 'OPENED' | 'COMPLETED' | 'CANCELLED';
 
+/**
+ * @publicApi
+ */
 declare type PluginKdsOrderRequestType = 'ADDED' | 'NEW' | 'CHANGED' | 'CANCELLED' | 'MERGED';
 
 declare type PluginLanguageCode = ValueOf<typeof AvailableLanguageCodes>;
@@ -1354,6 +1412,7 @@ export declare type PluginOrderDiningOption = 'HERE' | 'TOGO' | 'DELIVERY' | 'PI
  * @description order를 만들기 위한 dto
  */
 export declare type PluginOrderDto = {
+    orderKey?: string;
     memo?: string;
     numGuests?: number;
     discounts: PluginDiscount[];
@@ -1684,6 +1743,7 @@ declare type PopupType = Element_2['type'];
  * @publicApi
  */
 export declare type PosPluginSdk = {
+    alert: AlertTypes;
     table: Table;
     category: CategoryTypes;
     catalog: Catalog;
@@ -1708,6 +1768,7 @@ export declare type PosPluginSdk = {
     sound: SoundTypes;
     kdsOrder: KdsOrder;
     pluginUnicast: PluginUnicastTypes;
+    navigation: Navigation;
 };
 
 /**
@@ -1863,7 +1924,34 @@ declare type TextInput = BaseInput & {
  * @publicApi
  */
 export declare type ToastTypes = {
+    /**
+     * @deprecated toast.error(), toast.warn(), toast.success() 를 사용하세요
+     */
     open(message: string): void;
+    error(params: {
+        message: string;
+        button?: {
+            text: string;
+            onClick: () => void;
+        };
+    }): void;
+    warn(params: {
+        message: string;
+        button?: {
+            text: string;
+            onClick: () => void;
+        };
+    }): void;
+    success(params: {
+        message: string;
+        button?: {
+            text: string;
+            onClick: () => void;
+        };
+    }): void;
+    /**
+     * @deprecated toast.warn(), toast.error(), toast.success() 의 button.onClick 을 사용하세요
+     */
     on(event: 'click', callback: () => void): () => void;
 };
 

package/package.json

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

package/types/index.d.ts

@@ -1,3 +1,12 @@
+/**
+ * @publicApi
+ */
+export declare type AlertTypes = {
+    open(params: {
+        message: string;
+    }): void;
+};
+
 declare type AllPaymentCreateDto = PluginCardDto | PluginCashDto | PluginExternalDto;
 
 declare const AvailableLanguageCodes: {
@@ -430,6 +439,28 @@ declare type MovePayload = {
     };
 };
 
+/**
+ * @publicApi
+ */
+export declare interface Navigation {
+    navigate(page: 'plugin-tab', packageName?: string): void;
+    navigate(page: 'business-type-setting'): void;
+    /**
+     * 포스에서 페이지를 이동합니다.
+     * @param page business-type-setting 업종유형 변경, plugin-tab 플러그인 탭 이동
+     * @param packageName 이동할 탭의 이름, 없는 경우 첫번째 플러그인 탭으로 이동합니다
+     */
+    navigate(page: 'business-type-setting' | 'plugin-tab', packageName?: string): void;
+}
+
+/**
+ * @publicApi
+ */
+export declare class NavigationImpl implements Navigation {
+    navigate(page: 'plugin-tab', packageName?: string): void;
+    navigate(page: 'business-type-setting'): void;
+}
+
 /**
  * @publicApi
  * @return number
@@ -553,7 +584,8 @@ declare type PayCallback = (order: PluginOrder, price: PluginPrice, ui: Ui) => P
  * @publicApi
  */
 export declare interface Payment {
-    on: (event: 'cancel' | 'paid', callback: PaymentCallback) => void;
+    on(event: 'cancel' | 'paid', callback: PaymentCallback): void;
+    on(event: 'before-cancel', callback: PaymentBeforeCancelCallback): void;
     cancel: (order: {
         id: string;
     }, payment: {
@@ -565,6 +597,14 @@ export declare interface Payment {
     getPayment: (paymentId: PluginPayment['id']) => Promise<PluginPayment>;
 }
 
+/**
+ * @publicApi
+ */
+export declare type PaymentBeforeCancelCallback = (payload: {
+    order: PluginOrder;
+    payment: PluginPayment;
+}) => Promise<void>;
+
 declare type PaymentCallback = (paymentId: PluginPayment['id'], orderId: PluginOrder['id']) => void;
 
 /**
@@ -1154,6 +1194,9 @@ export declare interface PluginExternalPayment extends PluginPaymentBase {
     };
 }
 
+/**
+ * @publicApi
+ */
 declare interface PluginGetKdsOrderItemsPayload {
     states?: PluginKdsOrderItemState[];
     page: number;
@@ -1163,6 +1206,9 @@ declare interface PluginGetKdsOrderItemsPayload {
     itemIds?: number[];
 }
 
+/**
+ * @publicApi
+ */
 declare interface PluginGetKdsOrderItemsResult {
     contents: PluginKdsOrderItem[];
     last: boolean;
@@ -1212,6 +1258,9 @@ declare class PluginImpl implements Plugin_2 {
  */
 export declare type PluginInputs = TextInput | PasswordInput | RadioInput | CheckBoxInput | ToggleInput | SliderInput | NumberInput;
 
+/**
+ * @publicApi
+ */
 declare interface PluginKdsLineItem {
     title: string;
     diningOption: PluginOrderDiningOption;
@@ -1245,6 +1294,9 @@ declare interface PluginKdsLineItemOrderPrice {
 declare interface PluginKdsOrder extends Omit<PluginOrder, 'lineItems'> {
 }
 
+/**
+ * @publicApi
+ */
 declare interface PluginKdsOrderItem {
     id: string;
     state: PluginKdsOrderItemState;
@@ -1259,8 +1311,14 @@ declare interface PluginKdsOrderItem {
     updatedAt: string;
 }
 
+/**
+ * @publicApi
+ */
 declare type PluginKdsOrderItemState = 'REQUESTED' | 'OPENED' | 'COMPLETED' | 'CANCELLED';
 
+/**
+ * @publicApi
+ */
 declare type PluginKdsOrderRequestType = 'ADDED' | 'NEW' | 'CHANGED' | 'CANCELLED' | 'MERGED';
 
 declare type PluginLanguageCode = ValueOf<typeof AvailableLanguageCodes>;
@@ -1354,6 +1412,7 @@ export declare type PluginOrderDiningOption = 'HERE' | 'TOGO' | 'DELIVERY' | 'PI
  * @description order를 만들기 위한 dto
  */
 export declare type PluginOrderDto = {
+    orderKey?: string;
     memo?: string;
     numGuests?: number;
     discounts: PluginDiscount[];
@@ -1677,6 +1736,7 @@ declare type PopupType = Element_2['type'];
  * @publicApi
  */
 export declare type PosPluginSdk = {
+    alert: AlertTypes;
     table: Table;
     category: CategoryTypes;
     catalog: Catalog;
@@ -1701,6 +1761,7 @@ export declare type PosPluginSdk = {
     sound: SoundTypes;
     kdsOrder: KdsOrder;
     pluginUnicast: PluginUnicastTypes;
+    navigation: Navigation;
 };
 
 /**
@@ -1856,7 +1917,34 @@ declare type TextInput = BaseInput & {
  * @publicApi
  */
 export declare type ToastTypes = {
+    /**
+     * @deprecated toast.error(), toast.warn(), toast.success() 를 사용하세요
+     */
     open(message: string): void;
+    error(params: {
+        message: string;
+        button?: {
+            text: string;
+            onClick: () => void;
+        };
+    }): void;
+    warn(params: {
+        message: string;
+        button?: {
+            text: string;
+            onClick: () => void;
+        };
+    }): void;
+    success(params: {
+        message: string;
+        button?: {
+            text: string;
+            onClick: () => void;
+        };
+    }): void;
+    /**
+     * @deprecated toast.warn(), toast.error(), toast.success() 의 button.onClick 을 사용하세요
+     */
     on(event: 'click', callback: () => void): () => void;
 };