@tossplace/pos-plugin-sdk 0.0.6 → 0.0.7

package/types/index.d.ts

@@ -7,6 +7,13 @@ declare const AvailableLanguageCodes: {
     readonly English: "en-US";
 };
 
+declare interface Barcode {
+    send(barcode: string): Promise<void>;
+    on(event: 'scan', callback: (barcode: string) => void): void;
+    useBarcodeScan(): void;
+    unUseBarcodeScan(): void;
+}
+
 /**
  */
 declare type BarcodeElements = {
@@ -35,12 +42,6 @@ declare type BaseInput = {
     required: boolean;
 };
 
-declare type BaseInput_2 = {
-    label: string;
-    required: boolean;
-    id: string;
-};
-
 declare type CancelCallback = (order: PluginOrder, payment: PluginPayment, ui: Ui) => Promise<PluginCancelledPaymentDto | undefined>;
 
 /**
@@ -71,9 +72,14 @@ export declare interface CashReceiptTypes {
  * @publicApi
  */
 export declare interface Catalog {
+    getCatalog: (catalogId: number) => Promise<PluginCatalogItem>;
     getCatalogs: () => Promise<PluginCatalogItem[]>;
+    on(event: 'update' | 'add' | 'delete', callback: CatalogEventCallback): void;
+    /**
+     * @deprecated 다음 버전에서 제거 예정입니다
+     */
+    on(event: 'sold-out' | 'on-sale', callback: CatalogEventCallback): void;
     on(event: 'sold-out' | 'on-sale' | 'update' | 'add' | 'delete', callback: CatalogEventCallback): void;
-    on(event: 'before-add', callback: CatalogRequiredResponseEventCallback): void;
 }
 
 declare type CatalogEventCallback = (catalog: PluginCatalogItem) => void;
@@ -83,22 +89,17 @@ declare type CatalogEventCallback = (catalog: PluginCatalogItem) => void;
  */
 export declare type CatalogItemOptionChoiceState = 'ON_SALE' | 'SOLD_OUT';
 
-declare type CatalogRequiredResponseEventCallback = (payload: {
-    payload: Partial<PluginCatalogItemDto>;
-    ui: Ui;
-}) => Promise<{
-    initialValue?: PluginCatalogItemDto;
-}>;
-
 /**
  * @publicApi
  */
 export declare interface CategoryTypes {
     getCategories: () => Promise<PluginCatalogCategory[]>;
+    getCategory: (categoryId: number) => Promise<PluginCatalogCategory>;
     on: (event: 'update' | 'add' | 'delete', callback: (category: PluginCatalogCategory) => void) => void;
 }
 
 /**
+ * @publicApi
  * @return 선택된 values id의 배열 string[]
  * @example ['option1', 'option2']
  */
@@ -112,25 +113,20 @@ declare type CheckBoxInput = Omit<BaseInput, 'placeholder'> & {
 };
 
 /**
- * @return 선택된 values id의 배열 string[]
- * @example ['option1', 'option2']
+ * @publicApi
  */
-declare type CheckBoxInput_2 = Omit<BaseInput_2, 'placeholder'> & {
-    type: 'checkbox';
-    /**
-     * @description 선택된 value의 id의 배열
-     */
-    default: string[];
-    values: InputValue_2[];
-};
-
 declare type CtaInput = {
     type: 'cta';
     id: string;
     text: string;
-    ctaType: 'primary' | 'danger' | 'weak';
+    ctaType: 'primary' | 'danger' | 'dark';
 };
 
+/**
+ * @publicApi
+ */
+export declare type DeliveryConnectionStatusErrorCode = 'NOT_RUNNING' | 'NOT_LOGGED_IN' | 'UNKNOWN' | 'BAEMIN_NOT_SELECTED_PROGRAM';
+
 declare type DeliveryOrder = Order_2 & {
     type: 'DELIVERY';
     /**
@@ -181,7 +177,7 @@ export declare type DeviceInfo = {
     osVersion?: string;
     businessType: {
         business: {
-            type: 'CARE' | 'RESTAURANT';
+            type: 'CAFE' | 'RESTAURANT';
         };
         operation: {
             payment: {
@@ -366,32 +362,30 @@ declare type InputResponse = {
     errorMessage: string;
 };
 
+/**
+ * @publicApi
+ */
 declare type InputValue = {
     id: string;
     label: string;
 };
 
-declare type InputValue_2 = {
-    id: string;
-    label: string;
-};
-
 declare type Join<T extends string, U extends string> = `${T}${U}` | '0';
 
 declare type Languages = Record<PluginLanguageCode, string>;
 
-/**
- * @publicApi
- * @deprecated
- */
-declare type LegacyPluginInputType = PluginInputsLegacy['type'];
-
 /**
  * @publicApi
  */
 export declare interface MenuOption {
     getOptions: () => Promise<PluginCatalogItemOption[]>;
-    on: (event: 'sold-out' | 'on-sale' | 'update' | 'add' | 'delete', callback: (option: PluginCatalogItemOption) => void) => void;
+    getOption: (optionId: number) => Promise<PluginCatalogItemOption>;
+    /**
+     * @deprecated 다음 버전에서 제거 예정입니다
+     */
+    on(event: 'sold-out' | 'on-sale', callback: (option: PluginCatalogItemOption) => void): void;
+    on(event: 'update' | 'add' | 'delete', callback: (option: PluginCatalogItemOption) => void): void;
+    on(event: 'sold-out' | 'on-sale' | 'update' | 'add' | 'delete', callback: (option: PluginCatalogItemOption) => void): void;
 }
 
 /**
@@ -424,6 +418,7 @@ export declare class NavigationImpl implements Navigation {
 }
 
 /**
+ * @publicApi
  * @return number
  */
 declare type NumberInput = BaseInput & {
@@ -447,8 +442,8 @@ declare type NumberInput = BaseInput & {
 export declare interface Order {
     getOrder: (id: string) => Promise<PluginOrder>;
     /**
-     * @param start yyyyMMdd
-     * @param end yyyyMMdd
+     * @param start yyyy-MM-dd
+     * @param end yyyy-MM-dd
      * @description createdAt 기준으로 주문을 조회합니다
      */
     getOrders: (range: {
@@ -456,9 +451,9 @@ export declare interface Order {
         end: string;
     }) => Promise<PluginOrder[]>;
     /**
-     * 토스 포스에서 카드결제를 취소하면 무조건 카드리딩해야함 그래서 on cancel은 늘 환불까지 된 상태임
+     * @deprecated
      */
-    on: (event: 'cancel', callback: (order: PluginOrder) => void) => void;
+    on(event: 'cancel', callback: (order: PluginOrder) => void): void;
     cancel: (id: string) => Promise<void>;
     add: (order: PluginOrderDto) => Promise<PluginOrder>;
     /**
@@ -513,6 +508,7 @@ declare type Order_2 = {
 declare type OrderItemType = 'ITEM' | 'DELIVERY_FEE' | 'PREPAID_CARD' | 'MULTI_USE_TICKET';
 
 /**
+ * @publicApi
  * @return string
  */
 declare type PasswordInput = BaseInput & {
@@ -521,15 +517,6 @@ declare type PasswordInput = BaseInput & {
     placeholder?: string;
 };
 
-/**
- * @return string
- */
-declare type PasswordInput_2 = BaseInput_2 & {
-    type: 'password';
-    default: string;
-    placeholder?: string;
-};
-
 declare type PayCallback = (order: PluginOrder, price: PluginPrice, ui: Ui) => Promise<PaymentMethodResponse | undefined>;
 
 /**
@@ -545,9 +532,10 @@ export declare interface Payment {
     add: (order: {
         id: string;
     }, paymentDto: PluginPaymentDto) => Promise<PluginPaymentOf<'CARD'> | PluginPaymentOf<'CASH'> | PluginPaymentOf<'EXTERNAL'>>;
+    getPayment: (paymentId: PluginPayment['id']) => Promise<PluginPayment>;
 }
 
-declare type PaymentCallback = (payment: PluginPayment, order: PluginOrder) => void;
+declare type PaymentCallback = (payment: PluginPayment) => void;
 
 /**
  * @publicApi
@@ -882,7 +870,6 @@ export declare interface PluginCatalogItemOptionChoice {
  * @publicApi
  */
 export declare interface PluginCatalogItemPrice {
-    id: number;
     /** 상품 가격명 */
     title: string;
     /** 기본 가격 여부 */
@@ -959,6 +946,34 @@ export declare type PluginDelivery<T extends 'PICKUP' | 'HERE' | 'DELIVERY'> = E
     type: T;
 }>;
 
+/**
+ * @publicApi
+ * */
+export declare interface PluginDeliveryDiscount extends PluginDiscount {
+    discountBy: 'OWNER' | 'PLATFORM';
+}
+
+/**
+ * @publicApi
+ * @description order를 만들기 위한 dto
+ */
+export declare type PluginDeliveryOrderDto = Omit<PluginOrderDto, 'lineItems' | 'discounts'> & {
+    cancelled: boolean;
+    delivery: PluginDelivery<'DELIVERY' | 'PICKUP' | 'HERE'>;
+    discounts: Array<PluginDeliveryDiscount>;
+    lineItems: Array<Omit<PluginOrderItem, 'id' | 'orderId' | 'item' | 'optionChoices' | 'discounts'> & {
+        item: {
+            title: string;
+            type: 'ITEM' | 'DELIVERY_FEE';
+        };
+        optionChoices: Array<{
+            title: string;
+            priceValue: number;
+        }>;
+        discounts?: Array<PluginDeliveryDiscount>;
+    }>;
+};
+
 /**
  * @publicApi
  * 할인 정보
@@ -998,6 +1013,8 @@ export declare interface PluginDraftOrder {
      * 기본값은 false입니다.
      */
     ignorePrint: boolean;
+    /** 해당 주문의 테이블 인원 수 */
+    numGuests?: number;
 }
 
 /**
@@ -1013,7 +1030,7 @@ export declare interface PluginDraftOrderItem {
         type: OrderItemType;
     };
     /** 상품 가격 정보 */
-    itemPrice: Pick<PluginCatalogItemPrice, 'id' | 'isTaxFree' | 'priceType' | 'priceUnit' | 'priceValue' | 'sku' | 'title'>;
+    itemPrice: Pick<PluginCatalogItemPrice, 'isTaxFree' | 'priceType' | 'priceUnit' | 'priceValue' | 'sku' | 'title'>;
     /** 적용된 할인 목록 */
     discount: PluginDiscount[];
     /** 요청사항 */
@@ -1138,15 +1155,6 @@ declare class PluginImpl implements Plugin_2 {
  */
 export declare type PluginInputs = TextInput | PasswordInput | RadioInput | CheckBoxInput | ToggleInput | SliderInput | NumberInput;
 
-/**
- * @publicApi
- * @deprecated
- * @see https://deus.toss.im/projects/1057/pages/8gKjmG0l@1
- */
-declare type PluginInputsLegacy<T extends LegacyPluginInputType = any> = Extract<TextInput_2 | PasswordInput_2 | RadioInput_2 | CheckBoxInput_2 | ToggleInput_2 | SliderInput_2, {
-    type: T;
-}>;
-
 declare type PluginLanguageCode = ValueOf<typeof AvailableLanguageCodes>;
 
 /**
@@ -1202,6 +1210,8 @@ export declare interface PluginOrder {
     paymentPrice: PluginOrderPaymentPrice;
     requestedInfo?: PluginOrderRequestInfo;
     source: string;
+    /** 해당 주문의 테이블 인원 수 */
+    numGuests?: number;
     memo?: string;
     /**
      * @description 주문시각
@@ -1394,11 +1404,18 @@ export declare type PluginPaymentDto<S extends PluginPaymentSourceType = PluginP
     sourceType: S;
 }>;
 
-declare type PluginPaymentDtoBase = Pick<PluginPayment, 
+declare interface PluginPaymentDtoBase extends Pick<PluginPayment, 
 /**
 * orderId 그냥 열어두면 이상한 값 넣을가봐 걱정... 방어코드 필요
 */
-'orderId' | 'sourceType' | 'amountMoney' | 'taxMoney' | 'approvedNo' | 'approvedAt' | 'paymentKey' | 'supplyMoney' | 'tipMoney' | 'taxExemptMoney'>;
+'orderId' | 'sourceType' | 'amountMoney' | 'taxMoney' | 'approvedNo' | 'approvedAt' | 'paymentKey' | 'supplyMoney' | 'tipMoney' | 'taxExemptMoney'> {
+    /**
+     * default: true
+     * false로 설정 시, 결제 등록 후 자동으로 주문이 완료되지 않습니다.
+     * 테이블의 주문인 경우 autocomplete를 false로 설정하면, 테이블이 비워지지 않습니다
+     */
+    autocomplete?: boolean;
+}
 
 /**
  * @publicApi
@@ -1450,6 +1467,8 @@ export declare type PluginPrice = {
     taxExemptMoney: number;
 };
 
+/* Excluded from this release type: PluginServerOnHttpRequest */
+
 /**
  * @publicApi
  */
@@ -1459,6 +1478,8 @@ export declare interface PluginTable {
     hallId: number;
     /** 테이블명 */
     title: string;
+    /** 인원수 */
+    capacity?: number;
     group?: PluginTableGroup;
 }
 
@@ -1512,6 +1533,7 @@ export declare type PosPluginSdk = {
     paymentMethod: PaymentMethodType;
     websocket: WebsocketTypes;
     ffi: FFITypes;
+    barcode: Barcode;
     plugin: Plugin_2;
     pluginMessenger: PluginMessenger;
     setting: SettingTypes;
@@ -1533,32 +1555,29 @@ export declare class PosPluginSdkError extends Error {
 }
 
 /**
- * @return string values.id
+ * @publicApi
  */
-declare type RadioInput = Omit<BaseInput, 'placeholder'> & {
-    type: 'radio';
-    /**
-     * @desciption 선택된 value의 id
-     */
-    default: string;
-    values: InputValue[];
-};
+export declare class PosPluginSdkRateLimitError extends PosPluginSdkError {
+    constructor(message: string);
+    static isPosPluginSdkRateLimitError(error: unknown): error is PosPluginSdkRateLimitError;
+}
 
 /**
+ * @publicApi
  * @return string values.id
  */
-declare type RadioInput_2 = Omit<BaseInput_2, 'placeholder'> & {
+declare type RadioInput = Omit<BaseInput, 'placeholder'> & {
     type: 'radio';
     /**
      * @desciption 선택된 value의 id
      */
     default: string;
-    values: InputValue_2[];
+    values: InputValue[];
 };
 
 declare type Response_2 = BarcodeResponse | InputResponse;
 
-declare function setInputs(inputs: Array<PluginInputsLegacy>): void;
+declare function setInputs(inputs: Array<PluginInputs>): void;
 
 declare const setting: {
     setInputs: typeof setInputs;
@@ -1571,6 +1590,7 @@ declare const setting: {
 export declare type SettingTypes = typeof setting;
 
 /**
+ * @publicApi
  * @return number 0 25 50 75 100
  */
 declare type SliderInput = Omit<BaseInput, 'placeholder'> & {
@@ -1581,17 +1601,6 @@ declare type SliderInput = Omit<BaseInput, 'placeholder'> & {
     step: number;
 };
 
-/**
- * @return number 0 25 50 75 100
- */
-declare type SliderInput_2 = Omit<BaseInput_2, 'placeholder'> & {
-    type: 'slider';
-    default: number;
-    min: number;
-    max: number;
-    step: number;
-};
-
 /**
  * @publicApi
  */
@@ -1614,20 +1623,22 @@ declare type StoreStatus = 'NEW' | 'ACCEPTED' | 'REJECTED' | 'PARTIALLY_CANCELLE
  * @publicApi
  */
 export declare interface Table {
-    getTables: () => Promise<{
-        table: PluginTable;
-        order?: PluginOrder;
-    }[]>;
+    getTables: () => Promise<PluginTable[]>;
+    getTable: (tableId: number) => Promise<PluginTable>;
+    /**
+     * @deprecated 다음버전에서 제거 예정. order.on 사용 권장
+     */
     on(event: 'order-update' | 'order-add', callback: (order: PluginOrder) => void): void;
     on(event: 'clear' | 'add' | 'delete' | 'update', callback: (table: PluginTable) => void): void;
-    on(event: 'swap' | 'move' | 'merge', callback: (before: PluginTable, after: PluginTable) => void): void;
-    clearTable: (payload: {
+    on(event: 'move', callback: (before: PluginTable, after: PluginTable) => void): void;
+    clearTable: ({ table, order }: {
         table: PluginTable;
         order?: PluginOrder;
     }) => Promise<void>;
 }
 
 /**
+ * @publicApi
  * @return string
  */
 declare type TextInput = BaseInput & {
@@ -1645,15 +1656,6 @@ declare type TextInput = BaseInput & {
     }[];
 };
 
-/**
- * @return string
- */
-declare type TextInput_2 = BaseInput_2 & {
-    type: 'text';
-    default: string;
-    placeholder?: string;
-};
-
 /**
  * @publicApi
  */
@@ -1662,6 +1664,7 @@ export declare type ToastTypes = {
 };
 
 /**
+ * @publicApi
  * @return boolean
  */
 declare type ToggleInput = Omit<BaseInput, 'placeholder'> & {
@@ -1669,14 +1672,6 @@ declare type ToggleInput = Omit<BaseInput, 'placeholder'> & {
     default: boolean;
 };
 
-/**
- * @return boolean
- */
-declare type ToggleInput_2 = Omit<BaseInput_2, 'placeholder'> & {
-    type: 'toggle';
-    default: boolean;
-};
-
 /**
  * @publicApi
  * @description 추후에 필요한 정보 더 추가될 예정
@@ -1685,11 +1680,6 @@ export declare type TossMerchant = {
     name: string;
     id: number;
     businessNumber: string;
-    /**
-     * @deprecated
-     * @see DeviceInfo.serialNumber
-     */
-    serialNumber: string;
     franchise?: {
         id: string;
         name: string;
@@ -1704,6 +1694,18 @@ export declare type Ui = {
     openInputModal(message: Omit<PopupElement<'input'>, 'type'>): Promise<PopupActionResponse<'input'>>;
 };
 
+/**
+ * @publicApi
+ */
+export declare const ui: UiImpl;
+
+declare class UiImpl implements Ui {
+    openBarcode(data: {
+        productName: string;
+    }): Promise<PopupActionResponse<'barcode'>>;
+    openInputModal(data: Omit<PopupElement<'input'>, 'type'>): Promise<PopupActionResponse<'input'>>;
+}
+
 declare type ValueOf<ObjectType, ValueType extends keyof ObjectType = keyof ObjectType> = ObjectType[ValueType];
 
 /**
@@ -1711,7 +1713,10 @@ declare type ValueOf<ObjectType, ValueType extends keyof ObjectType = keyof Obje
  */
 export declare type VanType = 'NICE' | 'KIS' | 'SMARTRO' | 'KOVAN';
 
-declare class Websocket {
+/**
+ * @publicApi
+ */
+export declare class Websocket {
     private readonly url;
     private readonly headers;
     private readonly options?;