@tossplace/pos-plugin-sdk 0.0.16 → 0.0.18

package/types/index.d.ts

@@ -1,5 +1,3 @@
-import { WebView } from '@tossplace-nexus/pos-webview';
-
 declare type AllPaymentCreateDto = PluginCardDto | PluginCashDto | PluginExternalDto;
 
 declare const AvailableLanguageCodes: {
@@ -75,14 +73,9 @@ 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;
 }
 
-declare type CatalogEventCallback = (catalog: PluginCatalogItem) => void;
+declare type CatalogEventCallback = (id: PluginCatalogItem['id']) => void;
 
 /**
  * @publicApi
@@ -95,7 +88,7 @@ export declare type CatalogItemOptionChoiceState = 'ON_SALE' | 'SOLD_OUT';
 export declare interface CategoryTypes {
     getCategories: () => Promise<PluginCatalogCategory[]>;
     getCategory: (categoryId: number) => Promise<PluginCatalogCategory>;
-    on: (event: 'update' | 'add' | 'delete', callback: (category: PluginCatalogCategory) => void) => void;
+    on: (event: 'update' | 'add' | 'delete', callback: (category: PluginCatalogCategory['id']) => void) => void;
 }
 
 /**
@@ -112,6 +105,12 @@ declare type CheckBoxInput = Omit<BaseInput, 'placeholder'> & {
     values: InputValue[];
 };
 
+/**
+ * @publicApi
+ * @param length
+ */
+export declare function createCallbackId(length?: number): string;
+
 /**
  * @publicApi
  */
@@ -151,7 +150,7 @@ export declare interface DeliveryCatalogOption {
 /**
  * @publicApi
  */
-export declare type DeliveryConnectionStatusErrorCode = 'NOT_RUNNING' | 'NOT_LOGGED_IN' | 'UNKNOWN' | 'BAEMIN_NOT_SELECTED_PROGRAM';
+export declare type DeliveryConnectionStatusErrorCode = 'BMPC_NOT_RUNNING' | 'NOT_RUNNING' | 'BMPC_NOT_LOGGED_IN' | 'NOT_LOGGED_IN' | 'BMPC_UNKNOWN' | 'UNKNOWN' | 'BAEMIN_NOT_SELECTED_PROGRAM' | string;
 
 /**
  * @publicApi
@@ -245,6 +244,7 @@ declare type Digit = '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9';
  * @publicApi
  */
 export declare interface DraftOrder {
+    on(event: 'update', callback: (draftOrder: PluginDraftOrder) => void): void;
     clear(): Promise<void>;
     get(): Promise<PluginDraftOrder>;
     addLineItem(lineItem: PluginDraftOrderItemDto): Promise<PluginDraftOrder>;
@@ -258,88 +258,33 @@ export declare interface DraftOrder {
     startPayment(): Promise<void>;
 }
 
-declare type Element_2 = BarcodeElements | InputElements;
-
-declare class ErrorImpl {
-    private readonly webview;
-    constructor(webview: WebView);
-    addErrorListener(handler: (error: Error) => void): void;
-}
-
 /**
  * @publicApi
  */
-declare type FFIAbiType = '__stdcall';
+export declare const draftOrder: DraftOrderImpl;
 
-/**
- * @publicApi
- */
-declare interface FFIApi extends FFIFunction {
-    name: string;
-}
-
-/* Excluded from this release type: FFIDownloadInfo */
-
-/**
- * @publicApi
- */
-declare interface FFIFunction {
-    params?: FFIFunctionParam[];
-    return: FFIFunctionReturn;
-    options?: FFIFunctionOptions;
-    returnData?: any;
-}
-
-/**
- * @publicApi
- */
-declare interface FFIFunctionOptions {
-    /**
-     * Application Binary Interface
-     * - 응용 프로그램 바이너리 인터페이스: 컴파일된 프로그램 모듈들이 바이너리 수준에서 상호작용하는 방식을 정의하는 인터페이스
-     */
-    abi?: FFIAbiType;
+declare class DraftOrderImpl implements DraftOrder {
+    constructor();
+    on(event: 'update', callback: (draftOrder: PluginDraftOrder) => void): void;
+    deleteDiscount(indexOfDiscount: number): Promise<PluginDraftOrder>;
+    updateItemOptionChoice(itemKey: string, choices: PluginCatalogItemOptionChoice[]): Promise<PluginDraftOrder>;
+    updateItemMemo(itemKey: string, memo: string): Promise<PluginDraftOrder>;
+    updateIgnorePrint(ignorePrint: boolean): Promise<PluginDraftOrder>;
+    deleteItemDiscount(itemKey: string, indexOfDiscount: number): Promise<PluginDraftOrder>;
+    clear(): Promise<void>;
+    get(): Promise<PluginDraftOrder>;
+    addLineItem(lineItem: PluginDraftOrderItemDto): Promise<PluginDraftOrder>;
+    deleteLineItem(key: string): Promise<PluginDraftOrder>;
+    startPayment(): Promise<void>;
+    updateItemQuantity(itemKey: string, quantity: number): Promise<PluginDraftOrder>;
 }
 
-/**
- * @publicApi
- */
-declare type FFIFunctionParam = {
-    type: 'str';
-} | {
-    type: 'int';
-} | {
-    type: 'bool';
-} | {
-    type: 'wchar *';
-} | {
-    type: 'callback';
-};
-
-/**
- * @publicApi
- */
-declare type FFIFunctionReturn = 'void' | 'str' | 'int' | 'bool' | 'wchar *' | 'void *';
+declare type Element_2 = BarcodeElements | InputElements;
 
-/**
- * @publicApi
- */
-export declare interface FFITypes {
-    download: (downloadInfo: FFIDownloadInfo) => Promise<{
-        platform: keyof FFIDownloadInfo;
-    }>;
-    load: (filePath: string, apis: FFIApi[]) => Promise<void>;
-    unload: (filePath: string) => Promise<void>;
-    invoke: (filePath: string, apiName: string, params?: any[]) => Promise<any>;
-    registerCallback: (filePath: string, signature: FFIFunction, callback: (...args: any[]) => any) => Promise<{
-        ffiCallbackId: string;
-    }>;
-    unregisterCallback: (filePath: string, callbackId: string) => Promise<void>;
-    addCallbackErrorHandler: (filePath: string, handler: (error: Error) => void) => void;
+declare class ErrorImpl {
+    addErrorListener(handler: (error: Error) => void): void;
 }
 
-declare function getValues<T extends Record<string, number | string | string[] | boolean | undefined>>(): Promise<T>;
-
 declare type HereOrder = Order_2 & {
     type: 'HERE';
     memo: {
@@ -354,23 +299,28 @@ declare type HereOrder = Order_2 & {
  */
 export declare type HttpMethod = 'GET' | 'POST' | 'DELETE' | 'HEAD' | 'OPTIONS' | 'PUT' | 'PATCH';
 
+declare interface HttpOption {
+    timeoutMs?: number;
+}
+
 declare interface HttpRequest {
     method: HttpMethod;
     payload?: string;
     headers: [string, string][];
+    timeoutMs?: number;
 }
 
 /**
  * @publicApi
  */
 export declare interface HttpTypes {
-    get: (url: string, headers?: [string, string][]) => Promise<PluginHttpResponse>;
-    post: (url: string, payload: any, headers?: [string, string][]) => Promise<PluginHttpResponse>;
-    delete: (url: string, headers?: [string, string][]) => Promise<PluginHttpResponse>;
-    head: (url: string, headers?: [string, string][]) => Promise<PluginHttpResponse>;
-    options: (url: string, headers?: [string, string][]) => Promise<PluginHttpResponse>;
-    put: (url: string, payload: any, headers?: [string, string][]) => Promise<PluginHttpResponse>;
-    patch: (url: string, payload: any, headers?: [string, string][]) => Promise<PluginHttpResponse>;
+    get: (url: string, headers?: [string, string][], options?: HttpOption) => Promise<PluginHttpResponse>;
+    post: (url: string, payload: any, headers?: [string, string][], options?: HttpOption) => Promise<PluginHttpResponse>;
+    delete: (url: string, headers?: [string, string][], options?: HttpOption) => Promise<PluginHttpResponse>;
+    head: (url: string, headers?: [string, string][], options?: HttpOption) => Promise<PluginHttpResponse>;
+    options: (url: string, headers?: [string, string][], options?: HttpOption) => Promise<PluginHttpResponse>;
+    put: (url: string, payload: any, headers?: [string, string][], options?: HttpOption) => Promise<PluginHttpResponse>;
+    patch: (url: string, payload: any, headers?: [string, string][], options?: HttpOption) => Promise<PluginHttpResponse>;
 }
 
 declare type InputElements = {
@@ -417,12 +367,7 @@ declare type Languages = Record<PluginLanguageCode, string>;
 export declare interface MenuOption {
     getOptions: () => Promise<PluginCatalogItemOption[]>;
     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;
+    on(event: 'update' | 'add' | 'delete', callback: (id: PluginCatalogItemOption['id']) => void): void;
 }
 
 /**
@@ -440,28 +385,6 @@ export declare interface Merchant {
     getMerchant: () => Promise<TossMerchant>;
 }
 
-/**
- * @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
@@ -485,7 +408,22 @@ declare type NumberInput = BaseInput & {
  * @publicApi
  */
 export declare interface Order {
-    getOrder: (id: string) => Promise<PluginOrder>;
+    getOrder(id: string): Promise<PluginOrder>;
+    /**
+     * @description tableId와 orderState로 주문을 조회합니다 search는 다른 도메인의 인자로 검색이 가능합니다
+     * @param tableId 테이블 id
+     * @param orderState 주문 상태
+     * @param start start 날짜의 00시부터 부터 주문을 검색합니다 (ISO 8601 포맷)
+     * @param end end 날짜 저녁 12시까지 주문을 검색합니다 (ISO 8601 포맷)
+     */
+    search(params: {
+        start: string;
+        end: string;
+        page?: number;
+        size?: number;
+        tableId?: PluginTable['id'];
+        orderState?: PluginOrderState[];
+    }): Promise<PluginOrder[]>;
     /**
      * @param start ISO 8601 포맷
      * @param end ISO 8601 포맷
@@ -493,24 +431,21 @@ export declare interface Order {
      * @param size default 20
      * @description createdAt 기준으로 주문을 조회합니다
      */
-    getOrders: (params: {
+    getOrders(params: {
         start: string;
         end: string;
         page?: number;
         size?: number;
         orderStates?: PluginOrderState[];
-    }) => Promise<PluginOrder[]>;
-    /**
-     * @deprecated
-     */
-    on(event: 'cancel', callback: (order: PluginOrder) => void): void;
-    cancel: (id: string) => Promise<void>;
-    add: (order: PluginOrderDto) => Promise<PluginOrder>;
+    }): Promise<PluginOrder[]>;
+    on(event: 'add' | 'accept' | 'decline' | 'expire' | 'complete' | 'update', callback: (order: PluginOrder['id']) => void): void;
+    cancel(id: string): Promise<void>;
+    add(order: PluginOrderDto): Promise<PluginOrder>;
     /**
      * 새로 추가 된 메뉴만 order에 넣으세요
      */
-    addMenu: (orderId: string, order: PluginOrderDto) => Promise<PluginOrder>;
-    complete: (id: string) => Promise<PluginOrder>;
+    addMenu(orderId: string, order: PluginOrderDto): Promise<PluginOrder>;
+    complete(id: string): Promise<PluginOrder>;
 }
 
 declare type Order_2 = {
@@ -555,7 +490,7 @@ declare type Order_2 = {
     customerChargedPrice: number;
 };
 
-declare type OrderItemType = 'ITEM' | 'DELIVERY_FEE' | 'PREPAID_CARD' | 'MULTI_USE_TICKET';
+declare type OrderItemType = 'ITEM' | 'DELIVERY_FEE' | 'PREPAID_CARD' | 'MULTI_USE_TICKET' | 'COMBO' | 'GIFT_CARD';
 
 /**
  * @publicApi
@@ -585,7 +520,7 @@ export declare interface Payment {
     getPayment: (paymentId: PluginPayment['id']) => Promise<PluginPayment>;
 }
 
-declare type PaymentCallback = (payment: PluginPayment) => void;
+declare type PaymentCallback = (paymentId: PluginPayment['id'], orderId: PluginOrder['id']) => void;
 
 /**
  * @publicApi
@@ -647,7 +582,6 @@ export declare const plugin: PluginImpl;
  * @publicApi
  */
 declare interface Plugin_2 {
-    on(event: 'close', callback: () => Promise<void>): void;
     getPluginInfo(): Promise<{
         name: string;
         version: string;
@@ -888,10 +822,14 @@ export declare interface PluginCatalogItemOption {
     title: string;
     titleI18n?: PluginLanguagePack;
     isRequired: boolean;
+    /**
+     * 토스 포스에서 최소 수량은 선택 불가능하며 필수선택 여부에 따라 0 또는 1로 내려옴
+     * 0 - 필수아님
+     * 1 - 필수
+     */
     minChoices: number;
     /**
      * 최대로 선택가능한 선택 수
-     * -1인 경우 무제한 선택이 가능합니다.
      */
     maxChoices: number;
     choices: PluginCatalogItemOptionChoice[];
@@ -1008,15 +946,21 @@ export declare interface PluginDeliveryDiscount extends PluginDiscount {
  * @publicApi
  * @description order를 만들기 위한 dto
  */
-export declare type PluginDeliveryOrderDto = Omit<PluginOrderDto, 'lineItems' | 'discounts'> & {
+export declare type PluginDeliveryOrderDtoV2 = Omit<PluginOrderDto, 'lineItems' | 'discounts'> & {
     cancelled: boolean;
     delivery: PluginDelivery<'DELIVERY' | 'PICKUP' | 'HERE'>;
     discounts: Array<PluginDeliveryDiscount>;
-    lineItems: Array<Omit<PluginOrderItem, 'id' | 'orderId' | 'item' | 'optionChoices' | 'discounts'> & {
+    lineItems: Array<Omit<PluginOrderItem, 'id' | 'orderId' | 'item' | 'optionChoices' | 'discounts' | 'chargePrice'> & {
         item: {
             title: string;
             type: 'ITEM' | 'DELIVERY_FEE';
         };
+        /**
+         * @description 옵션,할인을 제외한 메뉴 1개의 단일 가격
+         */
+        itemPrice: {
+            value: number;
+        };
         optionChoices: Array<{
             title: string;
             priceValue: number;
@@ -1024,6 +968,9 @@ export declare type PluginDeliveryOrderDto = Omit<PluginOrderDto, 'lineItems' |
         }>;
         discounts?: Array<PluginDeliveryDiscount>;
     }>;
+    metadata?: {
+        bmpc?: boolean;
+    };
 };
 
 /**
@@ -1190,12 +1137,8 @@ export declare type PluginHttpResponse = {
 };
 
 declare class PluginImpl implements Plugin_2 {
-    private readonly webview;
-    private plugin;
-    private pluginCallbacks;
-    constructor(webview: WebView);
+    constructor();
     private initializePlugin;
-    on(event: 'close', callback: () => Promise<void>): void;
     getPluginInfo(): Promise<{
         name: string;
         version: string;
@@ -1218,26 +1161,6 @@ export declare interface PluginLanguagePack {
     languages: Partial<Languages>;
 }
 
-/**
- * @publicApi
- */
-export declare interface PluginMessenger {
-    broadcast<T = any>(message: T): void;
-    on<T = any>(event: 'message', callback: (message: T) => void): void;
-}
-
-/**
- * @publicApi
- */
-export declare const pluginMessenger: PluginMessengerImpl;
-
-declare class PluginMessengerImpl implements PluginMessenger {
-    private readonly webview;
-    constructor(webview: WebView);
-    broadcast<T = any>(message: T): void;
-    on<T = any>(event: 'message', callback: (message: T) => void): void;
-}
-
 /**
  * @publicApi
  * @description pluginOrder orderDto를 서버에 저장 후 가공해서 내려 준 값
@@ -1263,6 +1186,11 @@ export declare interface PluginOrder {
     paymentPrice: PluginOrderPaymentPrice;
     requestedInfo?: PluginOrderRequestInfo;
     source: string;
+    channel: {
+        source: string;
+        /** @memo 생성할 때 source를 넣고 groups를 따로 명시하지 않으면, groups는 source로부터 유도되어 채워집니다 */
+        groups: PluginOrderGroup[];
+    };
     /** 해당 주문의 테이블 인원 수 */
     numGuests?: number;
     memo?: string;
@@ -1319,8 +1247,16 @@ export declare type PluginOrderDto = {
     discounts: PluginDiscount[];
     tableId?: number;
     lineItems: PluginOrderItemDto[];
+    channel?: {
+        /**
+         * 주문의 타입을 지정합니다 아무것도 지정되지 않을 경우 POS로 간주됩니다.
+         */
+        groups: PluginOrderGroup[];
+    };
 };
 
+declare type PluginOrderGroup = 'POS' | 'KIOSK' | 'DELIVERY' | 'TABLE_ORDER' | 'MOBILE_ORDER';
+
 /**
  * @publicApi
  */
@@ -1335,7 +1271,7 @@ export declare interface PluginOrderItem {
         value: number;
     };
     /**
-     * @description 실제 고객이 결제하는 금액에 대한 정보입니다. (할인 적용 금액)
+     * @description 실제 고객이 결제하는 금액에 대한 정보입니다. (할인 적용 금액 + 옵션합산금액)
      */
     chargePrice: {
         value: number;
@@ -1376,6 +1312,7 @@ declare interface PluginOrderItemItemOptionChoiceDto {
 }
 
 /**
+ * @publicApi
  * 주문항목 옵션 선택
  */
 declare interface PluginOrderItemOptionChoice extends PluginCatalogItemOptionChoice {
@@ -1610,6 +1547,7 @@ export declare type PosPluginSdk = {
     catalog: Catalog;
     option: MenuOption;
     storage: StorageTypes;
+    secureStore: SecureStore;
     cashReceipt: CashReceiptTypes;
     order: Order;
     payment: Payment;
@@ -1619,14 +1557,12 @@ export declare type PosPluginSdk = {
     merchant: Merchant;
     paymentMethod: PaymentMethodType;
     websocket: WebsocketTypes;
-    ffi: FFITypes;
     barcode: Barcode;
     plugin: Plugin_2;
-    pluginMessenger: PluginMessenger;
     setting: SettingTypes;
     draftOrder: DraftOrder;
-    navigation: Navigation;
     error: ErrorImpl;
+    powerSaver: PowerSaverTypes;
 };
 
 /**
@@ -1650,6 +1586,24 @@ export declare class PosPluginSdkRateLimitError extends PosPluginSdkError {
     static isPosPluginSdkRateLimitError(error: unknown): error is PosPluginSdkRateLimitError;
 }
 
+/**
+ * @publicApi
+ */
+export declare type PowerSaverTypes = {
+    /**
+     * 절전모드 방지를 시작합니다.
+     */
+    startBlocking(): Promise<void>;
+    /**
+     * 절전모드 방지를 해제합니다.
+     */
+    stopBlocking(): Promise<void>;
+    /**
+     * 절전모드 방지가 활성화 상태인지 확인합니다.
+     */
+    isBlocked(): Promise<boolean>;
+};
+
 /**
  * @publicApi
  * @return string values.id
@@ -1665,17 +1619,22 @@ declare type RadioInput = Omit<BaseInput, 'placeholder'> & {
 
 declare type Response_2 = BarcodeResponse | InputResponse;
 
-declare function setInputs(inputs: Array<PluginInputs>): Promise<void>;
-
-declare const setting: {
-    setInputs: typeof setInputs;
-    getValues: typeof getValues;
-};
+/**
+ * @publicApi
+ */
+export declare interface SecureStore {
+    get: (key: string) => Promise<string | undefined>;
+    set: (key: string, value: string) => Promise<void>;
+    del: (key: string) => Promise<void>;
+}
 
 /**
  * @publicApi
  */
-export declare type SettingTypes = typeof setting;
+export declare type SettingTypes = {
+    setInputs: (inputs: Array<PluginInputs>) => Promise<void>;
+    getValues: <T extends Record<string, number | string | string[] | boolean | undefined>>() => Promise<T>;
+};
 
 /**
  * @publicApi
@@ -1711,14 +1670,12 @@ export declare type StoreStatus = 'NEW' | 'ACCEPTED' | 'REJECTED' | 'PARTIALLY_C
  * @publicApi
  */
 export declare interface Table {
-    getTables: () => Promise<PluginTable[]>;
+    getTables: () => Promise<(PluginTable & {
+        order?: PluginOrder;
+    })[]>;
     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: 'move', callback: (before: PluginTable, after: PluginTable) => void): void;
+    on(event: 'clear' | 'add' | 'delete' | 'update', callback: (id: PluginTable['id']) => void): void;
+    on(event: 'move', callback: (before: PluginTable['id'], after: PluginTable['id']) => void): void;
     clearTable: ({ table, order }: {
         table: PluginTable;
         order?: PluginOrder;
@@ -1817,18 +1774,18 @@ export declare class Websocket {
         followRedirects?: boolean | undefined;
         timeout?: number | undefined;
     } | undefined);
-    connect(): Promise<void>;
-    disconnect(): Promise<void>;
-    send(data: {
+    connect: () => Promise<void>;
+    disconnect: () => Promise<void>;
+    send: (data: {
         data: string;
         option?: {
-            mask?: boolean;
-        };
-    }): void;
-    onMessage(callback: (message: string) => void): void;
-    onError(callback: (errorName?: string, errorMessage?: string) => void): void;
-    onClose(callback: (code: string) => void): void;
-    onOpen(callback: () => void): void;
+            mask?: boolean | undefined;
+        } | undefined;
+    }) => void;
+    onMessage: (callback: (message: string) => void) => void;
+    onError: (callback: (errorName?: string, errorMessage?: string) => void) => void;
+    onClose: (callback: (code: string) => void) => void;
+    onOpen: (callback: () => void) => void;
 }
 
 /**