@tossplace/pos-plugin-sdk 0.0.4 → 0.0.5

package/types/index.d.ts

@@ -1,20 +1,8 @@
-declare type AlertElements = {
-    type: 'alert';
-    title: string;
-    description: string;
-    image: string;
-    cta: string;
-};
-
-declare type AlertResponse = {
-    type: 'alert';
-};
-
 declare type AllPaymentCreateDto = PluginCardDto | PluginCashDto | PluginExternalDto;
 
-declare type AllPopupElements = AlertElements | BarcodeElements;
+declare type AllPopupElements = BarcodeElements;
 
-declare type AllPopupResponse = AlertResponse | BarcodeResponse;
+declare type AllPopupResponse = BarcodeResponse;
 
 /**
  * @publicApi
@@ -48,9 +36,16 @@ declare type BarcodeResponse = {
     errorMessage: string;
 };
 
+declare type BaseInput = {
+    label: string;
+    required: boolean;
+    id: string;
+};
+
 declare type CancelCallback = (order: PluginOrder, payment: PluginPayment) => Promise<PluginCancelledPaymentDto | undefined>;
 
 /**
+ * @schema
  * @publicApi
  */
 export declare type CashReceipt = {
@@ -73,31 +68,61 @@ declare interface CashReceiptTypes {
 /**
  * @publicApi
  */
-export declare type CatalogItemOptionChoiceState = 'ON_SALE' | 'SOLD_OUT';
+export declare interface Catalog {
+    getCatalogs: () => Promise<PluginCatalogItem[]>;
+    on: (event: 'sold-out' | 'on-sale' | 'update' | 'add' | 'delete', callback: (menu: PluginCatalogItem) => void) => void;
+}
 
 /**
  * @publicApi
  */
-export declare interface CatalogTypes {
-    getCatalogs: () => Promise<PluginCatalogItem[]>;
-    on: (event: 'sold-out' | 'on-sale', callback: (menu: PluginCatalogItem) => void) => void;
-}
+export declare type CatalogItemOptionChoiceState = 'ON_SALE' | 'SOLD_OUT';
 
 /**
  * @publicApi
  */
 export declare interface CategoryTypes {
     getCategories: () => Promise<PluginCatalogCategory[]>;
+    on: (event: 'update' | 'add' | 'delete', callback: (category: PluginCatalogCategory) => void) => void;
 }
 
-declare type Digit = '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9';
+/**
+ * @return 선택된 values id의 배열 string[]
+ * @example ['option1', 'option2']
+ */
+declare type CheckBoxInput = Omit<BaseInput, 'placeholder'> & {
+    type: 'checkbox';
+    /**
+     * @description 선택된 value의 id의 배열
+     */
+    default: string[];
+    values: InputValue[];
+};
+
+declare type DeliveryOrder = Order & {
+    type: 'DELIVERY';
+    /**
+     * 배달 주체
+     */
+    deliveryBy: 'DELIVERY_COMPANY' | 'STORE' | 'AGENCY';
+    memo: {
+        store?: string;
+        delivery?: string;
+    };
+    address: {
+        road?: string;
+        lot?: string;
+    };
+    phone?: string;
+    status: DeliveryStatus;
+};
 
 /**
  * @publicApi
  */
-export declare type ExternalPaymentMethodResponse = PaymentMethodResponse & {
-    sourceType: 'EXTERNAL';
-};
+declare type DeliveryStatus = 'NEW' | 'ACCEPTED' | 'REJECTED' | 'PARTIALLY_CANCELLED' | 'CANCELLED' | 'RIDER_ASSIGNED' | 'RIDER_ARRIVE_SOON' | 'RIDER_PICKUP_COMPLETED' | 'DONE';
+
+declare type Digit = '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9';
 
 /**
  * @publicApi
@@ -111,6 +136,8 @@ declare interface FFIApi extends FFIFunction {
     name: string;
 }
 
+/* Excluded from this release type: FFIDownloadInfo */
+
 /**
  * @publicApi
  */
@@ -118,6 +145,7 @@ declare interface FFIFunction {
     params?: FFIFunctionParam[];
     return: FFIFunctionReturn;
     options?: FFIFunctionOptions;
+    returnData?: any;
 }
 
 /**
@@ -152,15 +180,35 @@ declare type FFIFunctionParam = {
 declare type FFIFunctionReturn = 'void' | 'str' | 'int' | 'bool' | 'wchar *' | 'void *';
 
 declare interface FFITypes {
-    download: (downloadUrl: string, filePath: string) => Promise<void>;
+    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 function getPluginInfo(): Promise<{
+    name: string;
+    version: string;
+}>;
+
+declare function getValues<T extends Record<string, number | string | string[] | boolean | undefined>>(): Promise<T>;
+
+declare type HereOrder = Order & {
+    type: 'HERE';
+    memo: {
+        store?: string;
+    };
+    phone?: string;
+    status: StoreStatus;
+};
+
 /**
  * @publicApi
  */
@@ -185,6 +233,11 @@ export declare interface HttpTypes {
     patch: (url: string, payload: any, headers?: [string, string][]) => Promise<PluginHttpResponse>;
 }
 
+declare type InputValue = {
+    id: string;
+    label: string;
+};
+
 declare type Join<T extends string, U extends string> = `${T}${U}` | '0';
 
 declare type Languages = Record<PluginLanguageCode, string>;
@@ -192,9 +245,9 @@ declare type Languages = Record<PluginLanguageCode, string>;
 /**
  * @publicApi
  */
-export declare interface MenuOptionTypes {
+export declare interface MenuOption {
     getOptions: () => Promise<PluginCatalogItemOption[]>;
-    on: (event: 'sold-out' | 'on-sale', callback: (option: PluginCatalogItemOption) => void) => void;
+    on: (event: 'sold-out' | 'on-sale' | 'update' | 'add' | 'delete', callback: (option: PluginCatalogItemOption) => void) => void;
 }
 
 /**
@@ -204,7 +257,51 @@ export declare interface MerchantTypes {
     getMerchant: () => Promise<TossMerchant>;
 }
 
-declare type OrderItemType = 'ITEM' | 'DELIVERY_FEE' | 'PREPAID_CARD';
+declare function on(event: 'close', callback: () => Promise<void>): void;
+
+declare type Order = {
+    /**
+     * 포스(사장님)에게 보여줄 주문유형
+     * @example 가게배달, 장보기/쇼핑, 픽업, 배민1 등등
+     */
+    serviceName: string;
+    /**
+     * 주문서에서 라이더에게 보여줄 배달 타입 (배민1, 배달의민족)
+     */
+    deliveryName: string;
+    /**
+     * @description 주문 시간 (yyyy-MM-dd'T'HH:mm:ss)
+     * @example 2025-04-08T16:11:13.000+09:00
+     */
+    orderAt: string;
+    /**
+     * @description 아이콘 url
+     */
+    icon: string;
+    /**
+     * @description 준비시간(분)
+     */
+    preparationTimeMin?: number;
+    /**
+     * 픽업/배달이 실행될 예약주문 시간 (yyyy-MM-dd'T'HH:mm:ss)
+     * @description 예약주문인 경우에만 값이 존재
+     * @example 2025-04-08T16:11:13.000+09:00
+     */
+    reservedDateTime?: string;
+    deliveryId: string;
+    origin?: string;
+    shop: {
+        id: string;
+        name: string;
+    };
+    paymentMethod: '결제완료' | '만나서 카드결제' | '만나서 현금결제' | '선불결제' | '기타결제';
+    /**
+     * @description 고객이 결제한 금액
+     */
+    customerChargedPrice: number;
+};
+
+declare type OrderItemType = 'ITEM' | 'DELIVERY_FEE' | 'PREPAID_CARD' | 'MULTI_USE_TICKET';
 
 /**
  * @publicApi
@@ -224,6 +321,15 @@ export declare interface OrderTypes {
     complete: (id: string) => Promise<PluginOrder>;
 }
 
+/**
+ * @return string
+ */
+declare type PasswordInput = BaseInput & {
+    type: 'password';
+    default: string;
+    placeholder?: string;
+};
+
 declare type PayCallback = (order: PluginOrder, price: PluginPrice) => Promise<PaymentMethodResponse | undefined>;
 
 /**
@@ -237,7 +343,6 @@ export declare type PaymentMethodResponse = {
      * @example 2022-01-27T11:42:33
      */
     approvedAt: string;
-    approvedNo: string;
     paymentKey: string;
 };
 
@@ -262,7 +367,7 @@ declare type PaymentMethodType = {
 };
 
 declare interface PaymentTypes {
-    on: (event: 'cancel' | 'paid', callback: (payload: PluginPaymentOf<'CASH'> | PluginPaymentOf<'CARD'> | PluginPaymentOf<'EXTERNAL'>) => void) => void;
+    on: (event: 'cancel', callback: (payload: PluginPaymentOf<'CASH'> | PluginPaymentOf<'CARD'> | PluginPaymentOf<'EXTERNAL'>) => void) => void;
     cancel: (order: {
         id: string;
     }, payment: {
@@ -273,6 +378,20 @@ declare interface PaymentTypes {
     }, paymentDto: PluginPaymentDto) => Promise<PluginPaymentOf<'CARD'> | PluginPaymentOf<'CASH'> | PluginPaymentOf<'EXTERNAL'>>;
 }
 
+declare type PickupOrder = Order & {
+    type: 'PICKUP';
+    memo: {
+        store?: string;
+    };
+    phone?: string;
+    status: StoreStatus;
+};
+
+declare const plugin: {
+    on: typeof on;
+    getPluginInfo: typeof getPluginInfo;
+};
+
 /**
  * @publicApi
  */
@@ -520,8 +639,9 @@ export declare interface PluginCatalogItemPrice {
  * @publicApi
  * FIXED: 고정 가격
  * VARIABLE: 시가(예: 수산시장 방어회)
+ * UNIT: 단위 가격(예: 1kg당 가격, 1L당 가격 등)
  */
-export declare type PluginCatalogItemPriceType = 'FIXED' | 'VARIABLE';
+export declare type PluginCatalogItemPriceType = 'FIXED' | 'VARIABLE' | 'UNIT';
 
 /**
  * 상품 상태
@@ -532,6 +652,13 @@ export declare type PluginCatalogItemPriceType = 'FIXED' | 'VARIABLE';
  */
 declare type PluginCatalogItemState = 'ON_SALE' | 'SOLD_OUT' | 'UNAVAILABLE' | 'DELETED';
 
+/**
+ * @publicApi
+ */
+export declare type PluginDelivery<T extends 'PICKUP' | 'HERE' | 'DELIVERY'> = Extract<DeliveryOrder | PickupOrder | HereOrder, {
+    type: T;
+}>;
+
 /**
  * @publicApi
  * 할인 정보
@@ -594,6 +721,19 @@ export declare type PluginHttpResponse = {
     code: number;
 };
 
+/**
+ * @publicApi
+ * @see https://deus.toss.im/projects/1057/pages/8gKjmG0l@1
+ */
+export declare type PluginInputs<T extends PluginInputType = any> = Extract<TextInput | PasswordInput | RadioInput | CheckBoxInput | ToggleInput | SliderInput, {
+    type: T;
+}>;
+
+/**
+ * @publicApi
+ */
+declare type PluginInputType = PluginInputs['type'];
+
 declare type PluginLanguageCode = ValueOf<typeof AvailableLanguageCodes>;
 
 /**
@@ -614,7 +754,14 @@ export declare interface PluginOrder {
     tableId?: number;
     table?: PluginTable;
     orderKey: string;
-    state: PluginOrderState;
+    /**
+     * 결제상태
+     */
+    paymentState: PluginOrderPaymentState;
+    /**
+     * 주문상태
+     */
+    orderState: PluginOrderState;
     lineItems: PluginOrderItem[];
     discounts?: PluginDiscount[];
     payments: PluginPayment[];
@@ -704,6 +851,22 @@ declare interface PluginOrderPaymentPrice {
     paymentPaidValue: number;
 }
 
+/**
+ * @publicApi
+ * 주문의 결제상태
+ * 상태 전이 규칙은 아래 문서를 참조해주세요. (22.09)
+ * https://www.notion.so/tossteam/1affab9356d24d2d9256ca21be2db473
+ * 또다른 문서도 있어요. (25.03)
+ * https://www.notion.so/tossteam/1c3a360d33e380979d4df2a1ba3bfd31
+ *
+ * OPENED: 결제 전 (초기 상태)
+ * PAID: 부분 결제 (일부 금액만 결제된 상태)
+ * CANCELLED: 취소
+ * COMPLETED: 결제 완료 (주문 금액이 모두 결제된 경우)
+ * REFUNDED: 환불 (모든 결제가 취소된 상태)
+ */
+declare type PluginOrderPaymentState = 'OPENED' | 'PAID' | 'CANCELLED' | 'COMPLETED' | 'REFUNDED';
+
 declare interface PluginOrderRequestInfo {
     /** 요청 시간 */
     requestAt: string;
@@ -724,16 +887,13 @@ declare interface PluginOrderRequestInfo {
 /**
  * @publicApi
  * 주문 상태
- * 상태 전이 규칙은 아래 문서를 참조해주세요.
- * https://www.notion.so/tossteam/1affab9356d24d2d9256ca21be2db473
  *
- * OPENED: 주문시작
- * PAID: 분할결제 중
- * CANCELLED: 주문취소
- * COMPLETED: 주문완료. 결제까지 완료된 상태
- * REFUNDED: 환불
+ * - REQUEST: 주문 접수 (requestedInfo가 있는 주문의 초기 상태)
+ * - OPENED: 주문 진행중 (포스 등 일반적인 환경에서 주문의 초기 상태)
+ * - COMPLETED: 주문 완료
+ * - CANCELLED: 주문 취소
  */
-export declare type PluginOrderState = 'OPENED' | 'PAID' | 'CANCELLED' | 'COMPLETED' | 'REFUNDED';
+export declare type PluginOrderState = 'REQUESTED' | 'OPENED' | 'COMPLETED' | 'CANCELLED';
 
 /**
  * @publicApi
@@ -871,6 +1031,8 @@ export declare interface PluginTableGroup {
     tableIds: number[];
 }
 
+declare type PluginTypes = typeof plugin;
+
 /**
  * @publicApi
  */
@@ -888,24 +1050,11 @@ export declare type PopupElements<T extends AllPopupType> = Extract<AllPopupElem
 /**
  * @publicApi
  */
-export declare const pos: Sdk;
-
-/**
- * @publicApi
- */
-export declare class PosPluginSdkError extends Error {
-    constructor(message: string);
-    static isPosPluginSdkError(error: unknown): error is PosPluginSdkError;
-}
-
-/**
- * @publicApi
- */
-export declare type Sdk = {
-    table: TableTypes;
+export declare type PosPluginSdk = {
+    table: Table;
     category: CategoryTypes;
-    catalog: CatalogTypes;
-    option: MenuOptionTypes;
+    catalog: Catalog;
+    option: MenuOption;
     storage: StorageTypes;
     cashReceipt: CashReceiptTypes;
     order: OrderTypes;
@@ -917,6 +1066,53 @@ export declare type Sdk = {
     paymentMethod: PaymentMethodType;
     websocket: WebsocketTypes;
     ffi: FFITypes;
+    plugin: PluginTypes;
+    setting: SettingTypes;
+};
+
+/**
+ * @publicApi
+ */
+export declare const posPluginSdk: PosPluginSdk;
+
+/**
+ * @publicApi
+ */
+export declare class PosPluginSdkError extends Error {
+    constructor(message: string);
+    static isPosPluginSdkError(error: unknown): error is PosPluginSdkError;
+}
+
+/**
+ * @return string values.id
+ */
+declare type RadioInput = Omit<BaseInput, 'placeholder'> & {
+    type: 'radio';
+    /**
+     * @desciption 선택된 value의 id
+     */
+    default: string;
+    values: InputValue[];
+};
+
+declare function setInputs(inputs: Array<PluginInputs>): void;
+
+declare const setting: {
+    setInputs: typeof setInputs;
+    getValues: typeof getValues;
+};
+
+declare type SettingTypes = typeof setting;
+
+/**
+ * @return number 0 25 50 75 100
+ */
+declare type SliderInput = Omit<BaseInput, 'placeholder'> & {
+    type: 'slider';
+    default: number;
+    min: number;
+    max: number;
+    step: number;
 };
 
 /**
@@ -928,12 +1124,22 @@ export declare interface StorageTypes {
     del: (key: string) => Promise<void>;
 }
 
-declare interface TableTypes {
+/**
+ * @publicApi
+ */
+declare type StoreStatus = 'NEW' | 'ACCEPTED' | 'REJECTED' | 'PARTIALLY_CANCELLED' | 'CANCELLED'
+/**
+* 손님이 가져감
+*/
+| 'DONE';
+
+declare interface Table {
     getTables: () => Promise<{
         table: PluginTable;
         order?: PluginOrder;
     }[]>;
-    on(event: 'order-update' | 'add' | 'clear', callback: (table: PluginTable) => void): void;
+    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: {
         table: PluginTable;
@@ -941,10 +1147,27 @@ declare interface TableTypes {
     }) => Promise<void>;
 }
 
+/**
+ * @return string
+ */
+declare type TextInput = BaseInput & {
+    type: 'text';
+    default: string;
+    placeholder?: string;
+};
+
 declare type ToastTypes = {
     open(message: string): void;
 };
 
+/**
+ * @return boolean
+ */
+declare type ToggleInput = Omit<BaseInput, 'placeholder'> & {
+    type: 'toggle';
+    default: boolean;
+};
+
 /**
  * @publicApi
  * @description 추후에 필요한 정보 더 추가될 예정
@@ -952,9 +1175,12 @@ declare type ToastTypes = {
 export declare type TossMerchant = {
     name: string;
     id: number;
+    businessNumber: string;
     serialNumber: string;
-    franchiseId?: string;
-    franchiseName?: string;
+    franchise?: {
+        id: string;
+        name: string;
+    };
 };
 
 declare type UiType = {