@tossplace/pos-plugin-sdk 0.0.26 → 0.0.28

package/types/index.d.ts

@@ -60,7 +60,7 @@ export declare type CashReceipt = {
     orderId: string;
     /** 현금영수증 발행 금액입니다 */
     amount: number;
-    /** 현금영수증 발행 날짜입니다 yyyyMMddHHmmss */
+    /** 현금영수증 발행 날짜입니다 yyyy-MM-ddTHH:mm:ss */
     issueDate: string;
     /** 현금영수증 발행 번호입니다 */
     issueNumber: string;
@@ -82,8 +82,19 @@ export declare interface Catalog {
     getCatalog: (catalogId: number) => Promise<PluginCatalogItem>;
     getCatalogs: () => Promise<PluginCatalogItem[]>;
     on(event: 'update' | 'add' | 'delete', callback: CatalogEventCallback): void;
+    on(event: 'before-add', callback: CatalogBeforeAddCallback): void;
 }
 
+/**
+ * @publicApi
+ */
+export declare type CatalogBeforeAddCallback = (payload: {
+    payload: Partial<PluginCatalogItemDto>;
+    ui: Ui;
+}) => Promise<{
+    initialValue?: PluginCatalogItemDto;
+}>;
+
 declare type CatalogEventCallback = (id: PluginCatalogItem['id']) => void;
 
 /**
@@ -163,11 +174,23 @@ export declare interface DeliveryCatalogOption {
  */
 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
+ */
+export declare interface DeliveryDispatch {
+    on(event: 'update', callback: (payload: DispatchChangePayload) => void): void;
+    getDispatch(params: {
+        orderId: PluginOrder['id'];
+    }): Promise<Dispatch | null>;
+}
+
 /**
  * @publicApi
  */
 export declare type DeliveryItemStatus = 'sold-out' | 'hide' | 'active' | 'invisible';
 
+/* Excluded from this release type: DeliveryOperationStatus */
+
 declare type DeliveryOrder = Order_2 & {
     type: 'DELIVERY';
     /**
@@ -186,6 +209,8 @@ declare type DeliveryOrder = Order_2 & {
     status: DeliveryStatus;
 };
 
+/* Excluded from this release type: DeliveryPauseDuration */
+
 /**
  * @publicApi
  */
@@ -198,6 +223,41 @@ export declare interface Device {
     getDeviceInfo(): Promise<DeviceInfo>;
 }
 
+/**
+ * @publicApi
+ */
+declare type DeviceBusinessType = {
+    business: {
+        type: 'CAFE' | 'RESTAURANT';
+    };
+    operation: {
+        payment: {
+            type: 'PAY_FIRST' | 'PAY_LATER';
+        };
+        table: {
+            enabled: boolean;
+        };
+        booking: {
+            enabled: boolean;
+        };
+    };
+} | {
+    business: {
+        type: 'RETAIL' | 'SERVICE';
+    };
+    operation: {
+        payment: {
+            type: 'PAY_FIRST';
+        };
+        table: {
+            enabled: false;
+        };
+        booking: {
+            enabled: boolean;
+        };
+    };
+};
+
 /**
  * @publicApi
  */
@@ -216,41 +276,50 @@ export declare type DeviceInfo = {
      * Windows와 macos에서만 지원됩니다
      */
     osVersion?: string;
-    businessType: {
-        business: {
-            type: 'CAFE' | 'RESTAURANT';
-        };
-        operation: {
-            payment: {
-                type: 'PAY_FIRST' | 'PAY_LATER';
-            };
-            table: {
-                enabled: boolean;
-            };
-            booking: {
-                enabled: boolean;
-            };
-        };
-    } | {
-        business: {
-            type: 'RETAIL' | 'SERVICE';
-        };
-        operation: {
-            payment: {
-                type: 'PAY_FIRST';
-            };
-            table: {
-                enabled: false;
-            };
-            booking: {
-                enabled: boolean;
-            };
-        };
-    };
+    /**
+     * @deprecated device.setting.request의 DeviceSetting을 사용해주세요
+     */
+    businessType: DeviceBusinessType;
 };
 
 declare type Digit = '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9';
 
+/**
+ * @publicApi
+ */
+export declare interface Dispatch {
+    dispatchId: number;
+    orderId: string;
+    status: DispatchStatus;
+    riderStatus: DispatchDeliveryStatus;
+    provider: DispatchProvider;
+}
+
+/**
+ * @publicApi
+ */
+export declare type DispatchChangePayload = Pick<Dispatch, 'orderId' | 'dispatchId'>;
+
+/**
+ * @publicApi
+ */
+export declare type DispatchDeliveryStatus = 'NOT_ALLOCATION' | 'ASSIGNED' | 'PICKUP_COMPLETED' | 'DELIVERY_COMPLETED';
+
+/**
+ * @publicApi
+ */
+export declare interface DispatchProvider {
+    type: 'SELF' | 'AGENCY';
+    id: number;
+    code: string;
+    name: string;
+}
+
+/**
+ * @publicApi
+ */
+export declare type DispatchStatus = 'WAITING_ALLOCATION' | 'ALLOCATION_COMPLETED' | 'CANCEL_WAITING' | 'CANCEL_COMPLETED' | 'COMPLETED';
+
 /**
  * @publicApi
  */
@@ -445,12 +514,13 @@ declare type MovePayload = {
 export declare interface Navigation {
     navigate(page: 'plugin-tab', packageName?: string): void;
     navigate(page: 'business-type-setting'): void;
+    navigate(page: 'delivery-connection'): void;
     /**
      * 포스에서 페이지를 이동합니다.
-     * @param page business-type-setting 업종유형 변경, plugin-tab 플러그인 탭 이동
+     * @param page business-type-setting 업종유형 변경, delivery-connection 설정 > 배달앱, plugin-tab 플러그인 탭 이동
      * @param packageName 이동할 탭의 이름, 없는 경우 첫번째 플러그인 탭으로 이동합니다
      */
-    navigate(page: 'business-type-setting' | 'plugin-tab', packageName?: string): void;
+    navigate(page: 'business-type-setting' | 'delivery-connection' | 'plugin-tab', packageName?: string): void;
 }
 
 /**
@@ -459,6 +529,7 @@ export declare interface Navigation {
 export declare class NavigationImpl implements Navigation {
     navigate(page: 'plugin-tab', packageName?: string): void;
     navigate(page: 'business-type-setting'): void;
+    navigate(page: 'delivery-connection'): void;
 }
 
 /**
@@ -586,6 +657,7 @@ declare type PayCallback = (order: PluginOrder, price: PluginPrice, ui: Ui) => P
 export declare interface Payment {
     on(event: 'cancel' | 'paid', callback: PaymentCallback): void;
     on(event: 'before-cancel', callback: PaymentBeforeCancelCallback): void;
+    on(event: 'before-cancel-all', callback: PaymentBeforeCancelAllCallback): void;
     cancel: (order: {
         id: string;
     }, payment: {
@@ -597,6 +669,14 @@ export declare interface Payment {
     getPayment: (paymentId: PluginPayment['id']) => Promise<PluginPayment>;
 }
 
+/**
+ * @publicApi
+ */
+export declare type PaymentBeforeCancelAllCallback = (payload: {
+    order: PluginOrder;
+    payments: PluginPayment[];
+}) => Promise<void>;
+
 /**
  * @publicApi
  */
@@ -931,6 +1011,7 @@ export declare interface PluginCatalogItemOption {
 export declare interface PluginCatalogItemOptionChoice {
     id: number;
     title: string;
+    code?: string;
     titleI18n?: PluginLanguagePack;
     /** 옵션에 딸린 가격이 없는 경우 0 */
     priceValue: number;
@@ -1036,8 +1117,7 @@ export declare type PluginDeliveryOrderDtoV2 = Omit<PluginOrderDto, 'lineItems'
     delivery: PluginDelivery<'DELIVERY' | 'PICKUP' | 'HERE'>;
     discounts: Array<PluginDeliveryDiscount>;
     lineItems: Array<Omit<PluginOrderItem, 'id' | 'orderId' | 'item' | 'optionChoices' | 'discounts' | 'chargePrice'> & {
-        item: {
-            title: string;
+        item: Pick<PluginCatalogItem, 'title' | 'code'> & {
             type: 'ITEM' | 'DELIVERY_FEE';
         };
         /**
@@ -1046,9 +1126,7 @@ export declare type PluginDeliveryOrderDtoV2 = Omit<PluginOrderDto, 'lineItems'
         itemPrice: {
             value: number;
         };
-        optionChoices: Array<{
-            title: string;
-            priceValue: number;
+        optionChoices: Array<Pick<PluginCatalogItemOptionChoice, 'title' | 'code' | 'priceValue'> & {
             quantity: number;
         }>;
         discounts?: Array<PluginDeliveryDiscount>;
@@ -1180,6 +1258,22 @@ declare interface PluginExternalDto extends PluginPaymentDtoBase {
     sourceType: 'EXTERNAL';
 }
 
+/**
+ * @publicApi
+ */
+declare interface PluginExternalLoyaltyPointDetails {
+    source: '제휴사포인트';
+    sourceId: 'EXTERNAL_LOYALTY_POINT';
+    /** 제휴사 구분자 */
+    provider: 'OKCASHBAG' | 'LPOINT';
+    /** 포인트 카드 번호 */
+    code: string;
+    approvalNo: string;
+    amount: number;
+    /** 포인트 잔액 */
+    balance: number;
+}
+
 /**
  * @publicApi
  */
@@ -1331,6 +1425,26 @@ export declare interface PluginLanguagePack {
     languages: Partial<Languages>;
 }
 
+/**
+ * @publicApi
+ */
+declare interface PluginMobileVoucherDetails {
+    /** 상품권 소스 */
+    source: '모바일 상품권' | string;
+    /** 상품권 구분자 */
+    sourceId: 'MOBILE_VOUCHER' | string;
+    /** 상품권 번호 */
+    code: string;
+    /** 상품권 발행사 */
+    provider?: 'COOP_MARKETING' | 'KPC' | 'UNKNOWN' | '페이코' | string;
+    approvalNo?: string;
+    amount?: number;
+    /** 상품권 PIN (오프라인 상품권이나 PIN 입력이 강제되는 온라인 상품권의 경우에만 사용) */
+    pin?: string;
+    /** 상품권 잔액 */
+    balance?: number;
+}
+
 /**
  * @publicApi
  * @description pluginOrder orderDto를 서버에 저장 후 가공해서 내려 준 값
@@ -1540,7 +1654,7 @@ export declare type PluginOrderState = 'REQUESTED' | 'OPENED' | 'COMPLETED' | 'C
 /**
  * @publicApi
  */
-export declare type PluginPayment = (PluginCardPayment | PluginCashPayment | PluginExternalPayment | PluginAccountTransferPayment | PluginBarcodePayment) & {
+export declare type PluginPayment = (PluginCardPayment | PluginCashPayment | PluginExternalPayment | PluginAccountTransferPayment | PluginBarcodePayment | PluginPrepaidValuePayment) & {
     paymentKey: string;
 };
 
@@ -1638,14 +1752,29 @@ export declare type PluginPaymentOf<S extends PluginPaymentSourceType> = Extract
  * CASH: 현금
  * BARCODE: 바코드/QR을 사용하는 간편결제
  * EXTERNAL: 기타결제(쿠폰, 외상 등)
+ * PREPAID_VALUE: 상품권/제휴사포인트
  */
-export declare type PluginPaymentSourceType = 'CARD' | 'CASH' | 'EXTERNAL' | 'BARCODE' | 'ACCOUNT_TRANSFER';
+export declare type PluginPaymentSourceType = 'CARD' | 'CASH' | 'EXTERNAL' | 'BARCODE' | 'ACCOUNT_TRANSFER' | 'PREPAID_VALUE';
 
 /**
  * @publicApi
  */
 export declare type PluginPaymentState = 'APPROVED' | 'COMPLETED' | 'CANCELLED';
 
+/**
+ * @publicApi
+ */
+declare type PluginPrepaidValueDetails = PluginMobileVoucherDetails | PluginExternalLoyaltyPointDetails;
+
+/**
+ * @publicApi
+ * 상품권/제휴사포인트 결제
+ */
+declare interface PluginPrepaidValuePayment extends PluginPaymentBase {
+    sourceType: 'PREPAID_VALUE';
+    prepaidValueDetails: PluginPrepaidValueDetails;
+}
+
 /**
  * @publicApi
  */
@@ -1762,6 +1891,9 @@ export declare type PosPluginSdk = {
     kdsOrder: KdsOrder;
     pluginUnicast: PluginUnicastTypes;
     navigation: Navigation;
+    delivery: {
+        dispatch: DeliveryDispatch;
+    };
 };
 
 /**
@@ -1793,14 +1925,20 @@ export declare const PosRateLimiter: () => MethodDecorator;
 export declare type PowerSaverTypes = {
     /**
      * 절전모드 방지를 시작합니다.
+     *
+     * windows, macos에서만 지원되며, 그 외 플랫폼에서는 에러가 발생합니다.
      */
     startBlocking(): Promise<void>;
     /**
      * 절전모드 방지를 해제합니다.
+     *
+     * windows, macos에서만 지원되며, 그 외 플랫폼에서는 에러가 발생합니다.
      */
     stopBlocking(): Promise<void>;
     /**
      * 절전모드 방지가 활성화 상태인지 확인합니다.
+     *
+     * windows, macos에서만 지원되며, 그 외 플랫폼에서는 에러가 발생합니다.
      */
     isBlocked(): Promise<boolean>;
 };
@@ -1998,7 +2136,7 @@ declare type ValueOf<ObjectType, ValueType extends keyof ObjectType = keyof Obje
 /**
  * @publicApi
  */
-export declare type VanType = 'NICE' | 'KIS' | 'SMARTRO' | 'KOVAN';
+export declare type VanType = 'NICE' | 'KIS' | 'SMARTRO' | 'KOVAN' | 'DAOU' | 'KSNET' | 'SECTA9' | 'KPN' | 'KOCES';
 
 /**
  * @publicApi