@tossplace/pos-plugin-sdk 0.0.3 → 0.0.5

package/dist/sdk.d.ts

@@ -0,0 +1,1245 @@
+declare type AllPaymentCreateDto = PluginCardDto | PluginCashDto | PluginExternalDto;
+
+declare type AllPopupElements = BarcodeElements;
+
+declare type AllPopupResponse = BarcodeResponse;
+
+/**
+ * @publicApi
+ */
+declare type AllPopupType = AllPopupElements['type'];
+
+declare const AvailableLanguageCodes: {
+    readonly Korean: "ko-KR";
+    readonly English: "en-US";
+};
+
+/**
+ */
+declare type BarcodeElements = {
+    type: 'barcode';
+    productName: string;
+};
+
+declare type BarcodeResponse = {
+    type: 'barcode';
+    complete: true;
+    data: {
+        barcode: string;
+        result: 'SUCCESS';
+    } | {
+        result: 'CANCELLED';
+    };
+} | {
+    type: 'barcode';
+    complete: false;
+    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 = {
+    /** 현금영수증이 발행 된 order id입니다 */
+    orderId: string;
+    /** 현금영수증 발행 금액입니다 */
+    amount: number;
+    /** 현금영수증 발행 날짜입니다 yyyyMMddHHmmss */
+    issueDate: string;
+    /** 현금영수증 발행 번호입니다 */
+    issueNumber: string;
+    /** 현금영수증 발행 카드 번호입니다 */
+    cardNumber: string;
+};
+
+declare interface CashReceiptTypes {
+    add: (receipt: CashReceipt) => Promise<void>;
+}
+
+/**
+ * @publicApi
+ */
+export declare interface Catalog {
+    getCatalogs: () => Promise<PluginCatalogItem[]>;
+    on: (event: 'sold-out' | 'on-sale' | 'update' | 'add' | 'delete', callback: (menu: PluginCatalogItem) => void) => void;
+}
+
+/**
+ * @publicApi
+ */
+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;
+}
+
+/**
+ * @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
+ */
+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
+ */
+declare type FFIAbiType = '__stdcall';
+
+/**
+ * @publicApi
+ */
+declare interface FFIApi extends FFIFunction {
+    name: string;
+}
+
+/**
+ * @internal
+ * @publicApi
+ */
+declare interface FFIDownloadInfo {
+    win32: {
+        filePath: string;
+        downloadUrl: string;
+    };
+    win64: {
+        filePath: string;
+        downloadUrl: string;
+    };
+}
+
+/**
+ * @publicApi
+ */
+declare interface FFIFunction {
+    params?: FFIFunctionParam[];
+    return: FFIFunctionReturn;
+    options?: FFIFunctionOptions;
+    returnData?: any;
+}
+
+/**
+ * @publicApi
+ */
+declare interface FFIFunctionOptions {
+    /**
+     * Application Binary Interface
+     * - 응용 프로그램 바이너리 인터페이스: 컴파일된 프로그램 모듈들이 바이너리 수준에서 상호작용하는 방식을 정의하는 인터페이스
+     */
+    abi?: FFIAbiType;
+}
+
+/**
+ * @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 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 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
+ */
+export declare type HttpMethod = 'GET' | 'POST' | 'DELETE' | 'HEAD' | 'OPTIONS' | 'PUT' | 'PATCH';
+
+declare interface HttpRequest {
+    method: HttpMethod;
+    payload?: string;
+    headers: [string, string][];
+}
+
+/**
+ * @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>;
+}
+
+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>;
+
+/**
+ * @publicApi
+ */
+export declare interface MenuOption {
+    getOptions: () => Promise<PluginCatalogItemOption[]>;
+    on: (event: 'sold-out' | 'on-sale' | 'update' | 'add' | 'delete', callback: (option: PluginCatalogItemOption) => void) => void;
+}
+
+/**
+ * @publicApi
+ */
+export declare interface MerchantTypes {
+    getMerchant: () => Promise<TossMerchant>;
+}
+
+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
+ */
+export declare interface OrderTypes {
+    getOrder: (id: string) => Promise<PluginOrder>;
+    /**
+     * 토스 포스에서 카드결제를 취소하면 무조건 카드리딩해야함 그래서 on cancel은 늘 환불까지 된 상태임
+     */
+    on: (event: 'cancel', callback: (order: PluginOrder) => 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>;
+}
+
+/**
+ * @return string
+ */
+declare type PasswordInput = BaseInput & {
+    type: 'password';
+    default: string;
+    placeholder?: string;
+};
+
+declare type PayCallback = (order: PluginOrder, price: PluginPrice) => Promise<PaymentMethodResponse | undefined>;
+
+/**
+ * @publicApi
+ * @description 포스에 원장이 생기는 payment
+ * @see https://tossteam.slack.com/archives/C037HM4QJ0L/p1740547954237879?thread_ts=1740500512.811309&cid=C037HM4QJ0L
+ */
+export declare type PaymentMethodResponse = {
+    /**
+     * 승인일시
+     * @example 2022-01-27T11:42:33
+     */
+    approvedAt: string;
+    paymentKey: string;
+};
+
+declare type PaymentMethodType = {
+    add: (payload: {
+        data: {
+            /**
+             * @description 결제수단의 id (unique)
+             * @description 결제수단이 여러개인 경우 필요하 것 같아 추가함
+             */
+            id: string;
+            paymentName: string;
+            /**
+             * @description 결제수단의 이미지 url
+             * @description 30x30
+             */
+            image: string;
+        };
+        payCallback: PayCallback;
+        cancelCallback: CancelCallback;
+    }) => void;
+};
+
+declare interface PaymentTypes {
+    on: (event: 'cancel', callback: (payload: PluginPaymentOf<'CASH'> | PluginPaymentOf<'CARD'> | PluginPaymentOf<'EXTERNAL'>) => void) => void;
+    cancel: (order: {
+        id: string;
+    }, payment: {
+        id: string;
+    }) => Promise<void>;
+    add: (order: {
+        id: string;
+    }, 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
+ */
+export declare type PluginCancelledPaymentDto = {
+    cancelledAt: string;
+};
+
+declare interface PluginCardDto extends PluginPaymentDtoBase {
+    sourceType: 'CARD';
+    cardDetails: PluginPaymentOf<'CARD'>['cardDetails'];
+}
+
+/**
+ * @publicApi
+ */
+export declare interface PluginCardPayment extends PluginPaymentBase {
+    sourceType: 'CARD';
+    cardDetails: {
+        installmentMonth: PluginPaymentInstallment;
+        cardType: PluginPaymentCardType;
+        /** 발급사명 */
+        cardBrand: string;
+        /** 발급사 코드 */
+        cardBrandId?: string;
+        /** 카드번호 */
+        cardNo: string;
+        /** 매입사명 */
+        source?: string;
+        /** 매입사 코드 */
+        sourceId?: string;
+        /** 선불카드일 때 잔액 */
+        balance?: number;
+        /** VAN사 */
+        van?: VanType;
+    };
+}
+
+declare interface PluginCashDto extends PluginPaymentDtoBase {
+    sourceType: 'CASH';
+    cashReceipt?: PluginCashReceipt;
+}
+
+/**
+ * @publicApi
+ */
+export declare interface PluginCashPayment extends PluginPaymentBase {
+    sourceType: 'CASH';
+}
+
+/**
+ * @publicApi
+ * 현금영수증
+ */
+export declare interface PluginCashReceipt {
+    /** 현금영수증 식별번호 */
+    identityNumber: string;
+    issuerType: PluginCashReceiptIssuerType;
+    issuanceType: PluginCashReceiptIssuanceType;
+    /** 자진 발급 여부 */
+    selfIssuance: boolean;
+}
+
+/**
+ * @publicApi
+ * 현금영수증 발행 유형
+ * PHONE: 휴대폰번호
+ * BUSINESS_NUMBER: 사업자번호
+ * CARD: 현금영수증 카드
+ */
+export declare type PluginCashReceiptIssuanceType = 'PHONE' | 'BUSINESS_NUMBER' | 'CARD';
+
+/**
+ * @publicApi
+ * 현금영수증 발급 유형
+ * CONSUMER: 개인
+ * BUSINESSES: 사업자
+ */
+export declare type PluginCashReceiptIssuerType = 'CONSUMER' | 'BUSINESSES';
+
+/**
+ * @publicApi
+ */
+export declare interface PluginCatalogCategory {
+    id: number;
+    title: string;
+    titleI18n?: PluginLanguagePack;
+}
+
+/**
+ * @publicApi
+ * response
+ * 포스에 있는 메뉴를 조회할 때
+ */
+export declare interface PluginCatalogItem {
+    /**
+     * @description 토스 포스에 등록된 메뉴의 고유 아이디
+     */
+    id: number;
+    /**
+     * @description 포스 내에서 보여주는 타이틀
+     * @description 사장님께만 보입니다
+     */
+    title: string;
+    /**
+     * @description 다국어지원을 위해 추가된 필드입니다
+     */
+    titleI18n?: PluginLanguagePack;
+    /**
+     * @description 메뉴의 상태입니다
+     * @description ON_SALE: 현재 판매중
+     * @description SOLD_OUT: 품절
+     * @description UNAVAILABLE: 기타 판매불가
+     * @description DELETED: 제거됨
+     */
+    state: PluginCatalogItemState;
+    description?: string;
+    descriptionI18n?: PluginLanguagePack;
+    /**
+     * @description 메뉴의 카테고리입니다
+     */
+    category: PluginCatalogCategory;
+    /**
+     * @description 메뉴에 달린 벳지입니다
+     */
+    labels: PluginCatalogItemLabel[];
+    imageUrl: string | null;
+    /**
+     * @description 상품의 가격정보
+     */
+    price: PluginCatalogItemPrice;
+    /**
+     * @description 상품에서 사용가능한 옵션 리스트
+     */
+    options: PluginCatalogItemOption[];
+}
+
+/**
+ * @publicApi
+ * request
+ * 포스에 메뉴를 만들때 update아니다 생성할 때만 사용한다
+ * update할때는 다른 api 사용하시라
+ * 생성할 때 state는 무조건 on_sale
+ */
+export declare interface PluginCatalogItemDto {
+    title: string;
+    titleI18n?: PluginLanguagePack;
+    description?: string;
+    descriptionI18n?: PluginLanguagePack;
+    categoryId: number;
+    price: PluginCatalogItemPrice;
+    labels: PluginCatalogItemLabel[];
+    imageUrl: string | null;
+    /**
+     * @description 옵션을 먼저 만들고 id를 넣어달라
+     */
+    options: Pick<PluginCatalogItemOption, 'id'>[];
+    kioskTitle?: string;
+}
+
+/**
+ * @publicApi
+ * @description 메뉴에 인기/신규/쿠폰 등의 뱃지를 단다
+ */
+export declare interface PluginCatalogItemLabel {
+    title: string;
+    color: string;
+}
+
+/**
+ * @publicApi
+ * @description 아직 dto는 정의되지 않았음
+ * @todo option dto 만들어야함
+ */
+export declare interface PluginCatalogItemOption {
+    id: number;
+    title: string;
+    titleI18n?: PluginLanguagePack;
+    isRequired: boolean;
+    minChoices: number;
+    /**
+     * 최대로 선택가능한 선택 수
+     * -1인 경우 무제한 선택이 가능합니다.
+     */
+    maxChoices: number;
+    choices: PluginCatalogItemOptionChoice[];
+    /**
+     * 기본으로 선택되어 있는 CatalogItemOptionChoice['id'] 리스트
+     * 기본값이 없다면 빈 배열입니다.
+     */
+    defaultChoices: number[];
+}
+
+/**
+ * @publicApi
+ */
+export declare interface PluginCatalogItemOptionChoice {
+    id: number;
+    title: string;
+    titleI18n?: PluginLanguagePack;
+    /** 옵션에 딸린 가격이 없는 경우 0 */
+    priceValue: number;
+    /** 키오스크에서 표시되는 아이콘 URL */
+    imageUrl?: string | null;
+    state: CatalogItemOptionChoiceState;
+}
+
+/**
+ * @publicApi
+ */
+export declare interface PluginCatalogItemPrice {
+    id: number;
+    /** 상품 가격명 */
+    title: string;
+    /** 기본 가격 여부 */
+    isDefault: boolean;
+    /** 상품 가격 상태 */
+    state: PluginCatalogItemState;
+    /**
+     * 재고 관리 코드
+     * @see https://en.wikipedia.org/wiki/Stock_keeping_unit
+     */
+    sku: string | null;
+    /** 상품 가격의 바코드 정보 */
+    barcode: string | null;
+    /** 가격 유형 */
+    priceType: PluginCatalogItemPriceType;
+    /** 가격의 기본 개수 */
+    priceUnit: number;
+    /**
+     * 부가가치세(VAT)가 포함된 가격
+     */
+    priceValue: number;
+    /** 비과세 여부 */
+    isTaxFree: boolean;
+    /** 재고 관리여부 */
+    isStockable: boolean;
+    /** 현재 남아있는 재고 수 */
+    stockQuantity: {
+        remainQuantity: number;
+        lastChangeDateTime: string;
+    } | null;
+}
+
+/**
+ * @publicApi
+ * FIXED: 고정 가격
+ * VARIABLE: 시가(예: 수산시장 방어회)
+ * UNIT: 단위 가격(예: 1kg당 가격, 1L당 가격 등)
+ */
+export declare type PluginCatalogItemPriceType = 'FIXED' | 'VARIABLE' | 'UNIT';
+
+/**
+ * 상품 상태
+ * ON_SALE: 현재 판매중
+ * SOLD_OUT: 품절
+ * UNAVAILABLE: 기타 판매불가
+ * DELETED: 제거됨
+ */
+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
+ * 할인 정보
+ * */
+export declare interface PluginDiscount {
+    /**
+     * 할인 금액
+     * 퍼센티지 할인인 경우 계산된 금액 입니다.
+     */
+    amountMoney: {
+        value: number;
+    };
+    /** 할인 명칭 */
+    title: string;
+    titleI18n?: PluginLanguagePack;
+}
+
+declare interface PluginExternalDto extends PluginPaymentDtoBase {
+    sourceType: 'EXTERNAL';
+}
+
+/**
+ * @publicApi
+ */
+export declare interface PluginExternalPayment extends PluginPaymentBase {
+    sourceType: 'EXTERNAL';
+    externalDetails: {
+        /**
+         * 기타 결제 수단의 소스
+         */
+        source?: string;
+        sourceId?: string;
+    };
+}
+
+/**
+ * @publicApi
+ * 테이블이 놓여진 공간
+ * */
+export declare interface PluginHall {
+    id: number;
+    title: string;
+    /** 순서값. 오름차순 정렬 합니다. */
+    order: number;
+}
+
+/**
+ * @publicApi
+ */
+export declare interface PluginHttpRequest extends HttpRequest {
+    url: string;
+}
+
+/**
+ * @publicApi
+ */
+export declare type PluginHttpResponse = {
+    body: string;
+    headers: [string, string][];
+    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>;
+
+/**
+ * @publicApi
+ */
+export declare interface PluginLanguagePack {
+    key?: string;
+    languages: Partial<Languages>;
+}
+
+/**
+ * @publicApi
+ * @description pluginOrder orderDto를 서버에 저장 후 가공해서 내려 준 값
+ */
+export declare interface PluginOrder {
+    id: string;
+    /** 테이블 주문.  */
+    tableId?: number;
+    table?: PluginTable;
+    orderKey: string;
+    /**
+     * 결제상태
+     */
+    paymentState: PluginOrderPaymentState;
+    /**
+     * 주문상태
+     */
+    orderState: PluginOrderState;
+    lineItems: PluginOrderItem[];
+    discounts?: PluginDiscount[];
+    payments: PluginPayment[];
+    chargePrice: PluginOrderChargePrice;
+    paymentPrice: PluginOrderPaymentPrice;
+    requestedInfo?: PluginOrderRequestInfo;
+    source: string;
+    memo?: string;
+    /**
+     * 해당값이 있다면 createdAt 대신 사용해주세요.
+     */
+    openedAt?: string;
+    createdAt: string;
+    updatedAt?: string;
+    cancelledAt?: string;
+    completedAt?: string;
+}
+
+declare interface PluginOrderChargePrice {
+    /** 청구 할인 금액 = 할인 금액 + 할인 취소 금액 */
+    chargeDiscountValue: number;
+    /** 청구 원주문 금액 = 원주문 금액 + 환불 원주문 금액 */
+    chargeListPriceValue: number;
+    /**
+     * 청구 금액 = 청구 원주문 금액 + 청구 할인 금액 + 청구 봉사료
+     */
+    chargePriceValue: number;
+    /** 청구 공급 가액 = 청구 금액 - 청구 세액 */
+    chargeSupplyValue: number;
+    /**
+     * 청구 세액(부가가치세) = 청구 금액 / (1+VAT)
+     * VAT=10
+     */
+    chargeTaxValue: number;
+    /** 청구 봉사료 = 봉사료 + 환불 봉사료 */
+    chargeTipValue: number;
+}
+
+/**
+ * @publicApi
+ * HERE: 매장내
+ * TOGO: 포장
+ * DELIVERY: 배달
+ * PICKUP: 픽업
+ */
+export declare type PluginOrderDiningOption = 'HERE' | 'TOGO' | 'DELIVERY' | 'PICKUP';
+
+/**
+ * @publicApi
+ * @description order를 만들기 위한 dto
+ */
+export declare type PluginOrderDto = {
+    memo?: string;
+    discounts: PluginDiscount[];
+    tableId?: number;
+    lineItems: Omit<PluginOrderItem, 'id' | 'orderId'>[];
+};
+
+/**
+ * @publicApi
+ */
+export declare interface PluginOrderItem {
+    id: string;
+    orderId: string;
+    diningOption: PluginOrderDiningOption;
+    item: Pick<PluginCatalogItem, 'id' | 'title' | 'category'> & {
+        type: OrderItemType;
+    };
+    quantity: {
+        value: number;
+    };
+    /**
+     * @description 실제 고객이 결제하는 금액에 대한 정보입니다.
+     */
+    chargePrice: {
+        value: number;
+    };
+    optionChoices: PluginCatalogItemOptionChoice[];
+    discounts?: PluginDiscount[];
+    memo?: string;
+}
+
+declare interface PluginOrderPaymentPrice {
+    /** 미납 결제 금액 */
+    paymentUnpaidValue: number;
+    /** 완납 결제 금액 */
+    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;
+    /** 만료 시간 */
+    expiredAt: string;
+    /** 픽업 시간 */
+    expectedReadyAt: string;
+    /** 예상 완료 시간 */
+    estimatedReadyAt?: string;
+    /** 접수 시간 */
+    acceptedAt?: string;
+    /** 거부 시간 */
+    declinedAt?: string;
+    /** 거부 사유 */
+    declinedReason?: string;
+}
+
+/**
+ * @publicApi
+ * 주문 상태
+ *
+ * - REQUEST: 주문 접수 (requestedInfo가 있는 주문의 초기 상태)
+ * - OPENED: 주문 진행중 (포스 등 일반적인 환경에서 주문의 초기 상태)
+ * - COMPLETED: 주문 완료
+ * - CANCELLED: 주문 취소
+ */
+export declare type PluginOrderState = 'REQUESTED' | 'OPENED' | 'COMPLETED' | 'CANCELLED';
+
+/**
+ * @publicApi
+ */
+export declare type PluginPayment = (PluginCardPayment | PluginCashPayment | PluginExternalPayment) & {
+    paymentKey: string;
+};
+
+/**
+ * @publicApi
+ */
+export declare interface PluginPaymentBase {
+    id: string;
+    orderId: string;
+    /** 결제상태 */
+    state: PluginPaymentState;
+    /** 결제수단 */
+    sourceType: PluginPaymentSourceType;
+    /** 지불액 */
+    amountMoney: number;
+    /** 부가가치세 */
+    taxMoney: number;
+    /** 공급가액 */
+    supplyMoney: number;
+    /** 봉사료 */
+    tipMoney: number;
+    /** 면세 금액. 값을 지정하지 않으면 기본으로 0원이 지정됨 */
+    taxExemptMoney?: number;
+    /** 승인번호 */
+    approvedNo: string;
+    /**
+     * 승인일시
+     * @example 2022-01-27T11:42:35
+     */
+    approvedAt: string;
+    /**
+     * 취소일시
+     * 취소거래인 경우에만 값 존재
+     */
+    cancelledAt?: string;
+    /** 현금영수증 정보
+     * 계좌이체가 추가되면서 현금 결제가 아니어도 현금영수증 발행이 가능함
+     * */
+    cashReceipt?: PluginCashReceipt;
+}
+
+/**
+ * @publicApi
+ * CREDIT: 신용카드
+ * DEBIT: 체크카드
+ * PREPAID: 선불카드
+ * FOREIGN: 해외카드
+ */
+export declare type PluginPaymentCardType = 'CREDIT' | 'DEBIT' | 'PREPAID' | 'FOREIGN';
+
+/**
+ * @publicApi
+ * @description 파트너사에 원장이 생기는 payment
+ */
+export declare type PluginPaymentDto<S extends PluginPaymentSourceType = PluginPaymentSourceType> = Extract<AllPaymentCreateDto, {
+    sourceType: S;
+}>;
+
+declare type PluginPaymentDtoBase = Pick<PluginPayment, 
+/**
+* orderId 그냥 열어두면 이상한 값 넣을가봐 걱정... 방어코드 필요
+*/
+'orderId' | 'sourceType' | 'amountMoney' | 'taxMoney' | 'approvedNo' | 'approvedAt' | 'paymentKey' | 'supplyMoney' | 'tipMoney' | 'taxExemptMoney'>;
+
+/**
+ * @publicApi
+ * 할부개월 수
+ * 00: 일시불. 현금IC의 경우 일반거래
+ * 01: 현금IC의 경우 간소화 거래(비밀번호 입력생략)
+ */
+export declare type PluginPaymentInstallment = Join<Digit, Digit>;
+
+/**
+ * @publicApi
+ */
+export declare type PluginPaymentOf<S extends PluginPaymentSourceType> = Extract<PluginPayment, {
+    sourceType: S;
+}>;
+
+/**
+ * @publicApi
+ * CARD: 신용카드
+ * CASH: 현금
+ * BARCODE: 바코드/QR을 사용하는 간편결제
+ * EXTERNAL: 기타결제(쿠폰, 외상 등)
+ */
+export declare type PluginPaymentSourceType = 'CARD' | 'CASH' | 'EXTERNAL';
+
+/**
+ * @publicApi
+ */
+export declare type PluginPaymentState = 'APPROVED' | 'COMPLETED' | 'CANCELLED';
+
+/**
+ * @publicApi
+ */
+export declare type PluginPrice = {
+    /** 지불액 */
+    amountMoney: number;
+    /** 부가가치세 */
+    taxMoney: number;
+    /** 공급가액 */
+    supplyMoney: number;
+    /** 봉사료 */
+    tipMoney: number;
+    /** 면세금액 */
+    taxExemptMoney: number;
+};
+
+/**
+ * @publicApi
+ */
+export declare interface PluginTable {
+    id: number;
+    /** 테이블이 놓여진 공간 id */
+    hallId: number;
+    /** 테이블명 */
+    title: string;
+    group?: PluginTableGroup;
+}
+
+/**
+ * @publicApi
+ */
+export declare interface PluginTableGroup {
+    id: number;
+    color: string;
+    merchantId: number;
+    /** 공간에 속한 테이블 리스트 */
+    tableIds: number[];
+}
+
+declare type PluginTypes = typeof plugin;
+
+/**
+ * @publicApi
+ */
+export declare type PopupActionResponse<T extends AllPopupType> = Extract<AllPopupResponse, {
+    type: T;
+}>;
+
+/**
+ * @publicApi
+ */
+export declare type PopupElements<T extends AllPopupType> = Extract<AllPopupElements, {
+    type: T;
+}>;
+
+/**
+ * @publicApi
+ */
+export declare type PosPluginSdk = {
+    table: Table;
+    category: CategoryTypes;
+    catalog: Catalog;
+    option: MenuOption;
+    storage: StorageTypes;
+    cashReceipt: CashReceiptTypes;
+    order: OrderTypes;
+    payment: PaymentTypes;
+    http: HttpTypes;
+    toast: ToastTypes;
+    merchant: MerchantTypes;
+    ui: UiType;
+    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;
+};
+
+/**
+ * @publicApi
+ */
+export declare interface StorageTypes {
+    get: (key: string) => Promise<string | undefined>;
+    set: (key: string, value: string) => Promise<void>;
+    del: (key: string) => Promise<void>;
+}
+
+/**
+ * @publicApi
+ */
+declare type StoreStatus = 'NEW' | 'ACCEPTED' | 'REJECTED' | 'PARTIALLY_CANCELLED' | 'CANCELLED'
+/**
+* 손님이 가져감
+*/
+| 'DONE';
+
+declare interface Table {
+    getTables: () => Promise<{
+        table: PluginTable;
+        order?: PluginOrder;
+    }[]>;
+    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;
+        order?: PluginOrder;
+    }) => 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 추후에 필요한 정보 더 추가될 예정
+ */
+export declare type TossMerchant = {
+    name: string;
+    id: number;
+    businessNumber: string;
+    serialNumber: string;
+    franchise?: {
+        id: string;
+        name: string;
+    };
+};
+
+declare type UiType = {
+    openPopup<T extends AllPopupType>(message: PopupElements<T>): Promise<PopupActionResponse<T>>;
+};
+
+declare type ValueOf<ObjectType, ValueType extends keyof ObjectType = keyof ObjectType> = ObjectType[ValueType];
+
+/**
+ * @publicApi
+ */
+export declare type VanType = 'NICE' | 'KIS' | 'SMARTRO' | 'KOVAN';
+
+declare class Websocket {
+    private readonly url;
+    private readonly headers;
+    private readonly options?;
+    onMessageCallback: ((message: string) => void) | undefined;
+    onErrorCallback: ((errorName?: string, errorMessage?: string) => void) | undefined;
+    onCloseCallback: ((code: string) => void) | undefined;
+    onOpenCallback: (() => void) | undefined;
+    constructor(url: string, headers: Record<string, string>, options?: {
+        rejectUnauthorized?: boolean | undefined;
+        followRedirects?: boolean | undefined;
+        timeout?: number | undefined;
+    } | undefined);
+    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;
+}
+
+declare type WebsocketTypes = {
+    create: (url: string, headers: Record<string, string>, options?: {
+        rejectUnauthorized?: boolean;
+        followRedirects?: boolean;
+        timeout?: number;
+    }) => Promise<Websocket>;
+};
+
+export { }