@tossplace/pos-plugin-sdk 0.0.18 → 0.0.20

package/dist/sdk.d.ts

@@ -91,6 +91,8 @@ export declare interface CategoryTypes {
     on: (event: 'update' | 'add' | 'delete', callback: (category: PluginCatalogCategory['id']) => void) => void;
 }
 
+declare type ChangeCallback = () => void;
+
 /**
  * @publicApi
  * @return 선택된 values id의 배열 string[]
@@ -359,6 +361,14 @@ declare type InputValue = {
 
 declare type Join<T extends string, U extends string> = `${T}${U}` | '0';
 
+/**
+ * @publicApi
+ */
+declare interface KdsOrder {
+    on(event: 'open' | 'complete' | 'cancel', callback: (id: PluginKdsOrderItem['id']) => void): void;
+    getKdsOrderItems(payload: PluginGetKdsOrderItemsPayload): Promise<PluginGetKdsOrderItemsResult>;
+}
+
 declare type Languages = Record<PluginLanguageCode, string>;
 
 /**
@@ -1109,6 +1119,21 @@ export declare interface PluginExternalPayment extends PluginPaymentBase {
     };
 }
 
+declare interface PluginGetKdsOrderItemsPayload {
+    states?: PluginKdsOrderItemState[];
+    page: number;
+    size: number;
+    orderIds?: string[];
+    categoryIds?: number[];
+    itemIds?: number[];
+}
+
+declare interface PluginGetKdsOrderItemsResult {
+    contents: PluginKdsOrderItem[];
+    last: boolean;
+    totalElements: number;
+}
+
 /**
  * @publicApi
  * 테이블이 놓여진 공간
@@ -1151,6 +1176,57 @@ declare class PluginImpl implements Plugin_2 {
  */
 export declare type PluginInputs = TextInput | PasswordInput | RadioInput | CheckBoxInput | ToggleInput | SliderInput | NumberInput;
 
+declare interface PluginKdsLineItem {
+    title: string;
+    diningOption: PluginOrderDiningOption;
+    id: string;
+    itemId: PluginOrderItem['id'];
+    memo: string;
+    optionChoices: PluginOrderItem['optionChoices'];
+    orderPrice: PluginKdsLineItemOrderPrice;
+    quantity: {
+        previous: number;
+        current: number;
+    };
+    appliedDiscounts: PluginDiscount[];
+    item: {
+        id: number;
+        category: {
+            id: number;
+            order: number;
+        };
+    };
+    createdAt: string;
+    updatedAt: string;
+}
+
+declare interface PluginKdsLineItemOrderPrice {
+    orderDiscountValue: number;
+    orderListPriceValue: number;
+    orderPriceValue: number;
+}
+
+declare interface PluginKdsOrder extends Omit<PluginOrder, 'lineItems'> {
+}
+
+declare interface PluginKdsOrderItem {
+    id: string;
+    state: PluginKdsOrderItemState;
+    order: PluginKdsOrder;
+    lineItems: PluginKdsLineItem[];
+    diningOption: PluginOrderDiningOption;
+    totalQuantity: number;
+    orderRequestType: PluginKdsOrderRequestType;
+    cancelledAt: string;
+    completedAt: string;
+    createdAt: string;
+    updatedAt: string;
+}
+
+declare type PluginKdsOrderItemState = 'OPENED' | 'COMPLETED' | 'CANCELLED';
+
+declare type PluginKdsOrderRequestType = 'ADDED' | 'NEW' | 'CHANGED' | 'CANCELLED' | 'MERGED';
+
 declare type PluginLanguageCode = ValueOf<typeof AvailableLanguageCodes>;
 
 /**
@@ -1570,6 +1646,8 @@ export declare type PosPluginSdk = {
     draftOrder: DraftOrder;
     error: ErrorImpl;
     powerSaver: PowerSaverTypes;
+    sound: SoundTypes;
+    kdsOrder: KdsOrder;
 };
 
 /**
@@ -1593,6 +1671,8 @@ export declare class PosPluginSdkRateLimitError extends PosPluginSdkError {
     static isPosPluginSdkRateLimitError(error: unknown): error is PosPluginSdkRateLimitError;
 }
 
+export declare const PosRateLimiter: () => MethodDecorator;
+
 /**
  * @publicApi
  */
@@ -1641,6 +1721,7 @@ export declare interface SecureStore {
 export declare type SettingTypes = {
     setInputs: (inputs: Array<PluginInputs>) => Promise<void>;
     getValues: <T extends Record<string, number | string | string[] | boolean | undefined>>() => Promise<T>;
+    on: (event: 'change', callback: ChangeCallback) => void;
 };
 
 /**
@@ -1655,6 +1736,18 @@ declare type SliderInput = Omit<BaseInput, 'placeholder'> & {
     step: number;
 };
 
+/**
+ * @publicApi
+ */
+export declare type SoundTypes = {
+    play: (args: {
+        url: string;
+        volume: number;
+        repeat?: number;
+        durationMs?: number;
+    }) => void;
+};
+
 /**
  * @publicApi
  */
@@ -1677,6 +1770,7 @@ export declare type StoreStatus = 'NEW' | 'ACCEPTED' | 'REJECTED' | 'PARTIALLY_C
  * @publicApi
  */
 export declare interface Table {
+    getHalls: () => Promise<PluginHall[]>;
     getTables: () => Promise<(PluginTable & {
         order?: PluginOrder;
     })[]>;
@@ -1713,6 +1807,7 @@ declare type TextInput = BaseInput & {
  */
 export declare type ToastTypes = {
     open(message: string): void;
+    on(event: 'click', callback: () => void): () => void;
 };
 
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tossplace/pos-plugin-sdk",
-  "version": "0.0.18",
+  "version": "0.0.20",
   "description": "포스 플러그인 sdk",
   "main": "dist/index.cjs.js",
   "module": "dist/index.esm.js",

package/types/index.d.ts

@@ -91,6 +91,8 @@ export declare interface CategoryTypes {
     on: (event: 'update' | 'add' | 'delete', callback: (category: PluginCatalogCategory['id']) => void) => void;
 }
 
+declare type ChangeCallback = () => void;
+
 /**
  * @publicApi
  * @return 선택된 values id의 배열 string[]
@@ -359,6 +361,14 @@ declare type InputValue = {
 
 declare type Join<T extends string, U extends string> = `${T}${U}` | '0';
 
+/**
+ * @publicApi
+ */
+declare interface KdsOrder {
+    on(event: 'open' | 'complete' | 'cancel', callback: (id: PluginKdsOrderItem['id']) => void): void;
+    getKdsOrderItems(payload: PluginGetKdsOrderItemsPayload): Promise<PluginGetKdsOrderItemsResult>;
+}
+
 declare type Languages = Record<PluginLanguageCode, string>;
 
 /**
@@ -1109,6 +1119,21 @@ export declare interface PluginExternalPayment extends PluginPaymentBase {
     };
 }
 
+declare interface PluginGetKdsOrderItemsPayload {
+    states?: PluginKdsOrderItemState[];
+    page: number;
+    size: number;
+    orderIds?: string[];
+    categoryIds?: number[];
+    itemIds?: number[];
+}
+
+declare interface PluginGetKdsOrderItemsResult {
+    contents: PluginKdsOrderItem[];
+    last: boolean;
+    totalElements: number;
+}
+
 /**
  * @publicApi
  * 테이블이 놓여진 공간
@@ -1151,6 +1176,57 @@ declare class PluginImpl implements Plugin_2 {
  */
 export declare type PluginInputs = TextInput | PasswordInput | RadioInput | CheckBoxInput | ToggleInput | SliderInput | NumberInput;
 
+declare interface PluginKdsLineItem {
+    title: string;
+    diningOption: PluginOrderDiningOption;
+    id: string;
+    itemId: PluginOrderItem['id'];
+    memo: string;
+    optionChoices: PluginOrderItem['optionChoices'];
+    orderPrice: PluginKdsLineItemOrderPrice;
+    quantity: {
+        previous: number;
+        current: number;
+    };
+    appliedDiscounts: PluginDiscount[];
+    item: {
+        id: number;
+        category: {
+            id: number;
+            order: number;
+        };
+    };
+    createdAt: string;
+    updatedAt: string;
+}
+
+declare interface PluginKdsLineItemOrderPrice {
+    orderDiscountValue: number;
+    orderListPriceValue: number;
+    orderPriceValue: number;
+}
+
+declare interface PluginKdsOrder extends Omit<PluginOrder, 'lineItems'> {
+}
+
+declare interface PluginKdsOrderItem {
+    id: string;
+    state: PluginKdsOrderItemState;
+    order: PluginKdsOrder;
+    lineItems: PluginKdsLineItem[];
+    diningOption: PluginOrderDiningOption;
+    totalQuantity: number;
+    orderRequestType: PluginKdsOrderRequestType;
+    cancelledAt: string;
+    completedAt: string;
+    createdAt: string;
+    updatedAt: string;
+}
+
+declare type PluginKdsOrderItemState = 'OPENED' | 'COMPLETED' | 'CANCELLED';
+
+declare type PluginKdsOrderRequestType = 'ADDED' | 'NEW' | 'CHANGED' | 'CANCELLED' | 'MERGED';
+
 declare type PluginLanguageCode = ValueOf<typeof AvailableLanguageCodes>;
 
 /**
@@ -1563,6 +1639,8 @@ export declare type PosPluginSdk = {
     draftOrder: DraftOrder;
     error: ErrorImpl;
     powerSaver: PowerSaverTypes;
+    sound: SoundTypes;
+    kdsOrder: KdsOrder;
 };
 
 /**
@@ -1586,6 +1664,8 @@ export declare class PosPluginSdkRateLimitError extends PosPluginSdkError {
     static isPosPluginSdkRateLimitError(error: unknown): error is PosPluginSdkRateLimitError;
 }
 
+export declare const PosRateLimiter: () => MethodDecorator;
+
 /**
  * @publicApi
  */
@@ -1634,6 +1714,7 @@ export declare interface SecureStore {
 export declare type SettingTypes = {
     setInputs: (inputs: Array<PluginInputs>) => Promise<void>;
     getValues: <T extends Record<string, number | string | string[] | boolean | undefined>>() => Promise<T>;
+    on: (event: 'change', callback: ChangeCallback) => void;
 };
 
 /**
@@ -1648,6 +1729,18 @@ declare type SliderInput = Omit<BaseInput, 'placeholder'> & {
     step: number;
 };
 
+/**
+ * @publicApi
+ */
+export declare type SoundTypes = {
+    play: (args: {
+        url: string;
+        volume: number;
+        repeat?: number;
+        durationMs?: number;
+    }) => void;
+};
+
 /**
  * @publicApi
  */
@@ -1670,6 +1763,7 @@ export declare type StoreStatus = 'NEW' | 'ACCEPTED' | 'REJECTED' | 'PARTIALLY_C
  * @publicApi
  */
 export declare interface Table {
+    getHalls: () => Promise<PluginHall[]>;
     getTables: () => Promise<(PluginTable & {
         order?: PluginOrder;
     })[]>;
@@ -1706,6 +1800,7 @@ declare type TextInput = BaseInput & {
  */
 export declare type ToastTypes = {
     open(message: string): void;
+    on(event: 'click', callback: () => void): () => void;
 };
 
 /**

package/types/callback/createCallbackId.d.ts

@@ -1 +0,0 @@
-export declare function createCallbackId(length?: number): string;

package/types/cash-receipt/cash-receipt.d.ts

@@ -1,5 +0,0 @@
-import { CashReceipt } from '@tossplace-nexus/plugin-types';
-export interface CashReceiptTypes {
-    add: (receipt: CashReceipt) => Promise<void>;
-}
-export declare const cashReceipt: CashReceiptTypes;

package/types/catalog/catalog.d.ts

@@ -1,9 +0,0 @@
-import { PluginCatalogItem } from '@tossplace-nexus/plugin-types';
-/**
- * @publicApi
- */
-export interface CatalogTypes {
-    getCatalogs: () => Promise<PluginCatalogItem[]>;
-    on: (event: 'sold-out' | 'on-sale', callback: (menu: PluginCatalogItem) => void) => void;
-}
-export declare const catalog: CatalogTypes;

package/types/category/category.d.ts

@@ -1,8 +0,0 @@
-import { PluginCatalogCategory } from '@tossplace-nexus/plugin-types';
-/**
- * @publicApi
- */
-export interface CategoryTypes {
-    getCategories: () => Promise<PluginCatalogCategory[]>;
-}
-export declare const category: CategoryTypes;

package/types/error/PosPluginSdkError.d.ts

@@ -1,7 +0,0 @@
-/**
- * @publicApi
-*/
-export declare class PosPluginSdkError extends Error {
-    constructor(message: string);
-    static isPosPluginSdkError(error: unknown): error is PosPluginSdkError;
-}

package/types/error/__test__/PosPluginSdkError.test.d.ts

@@ -1 +0,0 @@
-export {};

package/types/http/http.d.ts

@@ -1,14 +0,0 @@
-import { PluginHttpResponse } from '@tossplace-nexus/plugin-types';
-/**
- * @publicApi
- */
-export 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>;
-}
-export declare const http: HttpTypes;

package/types/log/log.d.ts

@@ -1,4 +0,0 @@
-export declare type LogTypes = {
-    send(log: string): void;
-};
-export declare const log: LogTypes;

package/types/merchant/merchant.d.ts

@@ -1,9 +0,0 @@
-import { TossMerchant } from '@tossplace-nexus/plugin-types';
-export declare function getMerchant(): Promise<TossMerchant>;
-/**
- * @publicApi
- */
-export interface MerchantTypes {
-    getMerchant: () => Promise<TossMerchant>;
-}
-export declare const merchant: MerchantTypes;

package/types/option/option.d.ts

@@ -1,9 +0,0 @@
-import { PluginCatalogItemOption } from '@tossplace-nexus/plugin-types';
-/**
- * @publicApi
- */
-export interface MenuOptionTypes {
-    getOptions: () => Promise<PluginCatalogItemOption[]>;
-    on: (event: 'sold-out' | 'on-sale', callback: (option: PluginCatalogItemOption) => void) => void;
-}
-export declare const option: MenuOptionTypes;

package/types/order/order.d.ts

@@ -1,19 +0,0 @@
-import { PluginOrder, PluginOrderDto } from '@tossplace-nexus/plugin-types';
-/**
- * @publicApi
- */
-export 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>;
-}
-export declare const order: OrderTypes;

package/types/payment/assertPayment.d.ts

@@ -1,2 +0,0 @@
-import { PluginPaymentDto } from '@tossplace-nexus/plugin-types';
-export declare function assertPayment(paymentDto: PluginPaymentDto): void;

package/types/payment/payment.d.ts

@@ -1,13 +0,0 @@
-import { PluginPaymentDto, PluginPaymentOf } from '@tossplace-nexus/plugin-types';
-export interface PaymentTypes {
-    on: (event: 'cancel' | 'paid', 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'>>;
-}
-export declare const payment: PaymentTypes;

package/types/payment-method/payment-method.d.ts

@@ -1,12 +0,0 @@
-import { PaymentMethodResponse, PluginCancelledPaymentDto, PluginMessage, PluginOrder, PluginPayment, PluginPrice } from '@tossplace-nexus/plugin-types';
-declare type PayCallback = (order: PluginOrder, price: PluginPrice) => Promise<PaymentMethodResponse | undefined>;
-declare type CancelCallback = (order: PluginOrder, payment: PluginPayment) => Promise<PluginCancelledPaymentDto | undefined>;
-export declare type PaymentMethodType = {
-    add: (payload: {
-        data: PluginMessage<'payment.method.add'>['data'];
-        payCallback: PayCallback;
-        cancelCallback: CancelCallback;
-    }) => void;
-};
-export declare const paymentMethod: PaymentMethodType;
-export {};

package/types/pos/sdk.d.ts

@@ -1,37 +0,0 @@
-import { CashReceiptTypes } from '../cash-receipt/cash-receipt';
-import { StorageTypes } from '../storage/storage';
-import { TableTypes } from '../table/table';
-import { CategoryTypes } from '../category/category';
-import { CatalogTypes } from '../catalog/catalog';
-import { MenuOptionTypes } from '../option/option';
-import { OrderTypes } from '../order/order';
-import { HttpTypes } from '../http/http';
-import { PaymentTypes } from '../payment/payment';
-import { ToastTypes } from '../toast/toast';
-import { MerchantTypes } from '../merchant/merchant';
-import { UiType } from '../ui/ui';
-import { PaymentMethodType } from '../payment-method/payment-method';
-import { WebsocketTypes } from '../websocket/websocket';
-/**
- * @publicApi
- */
-export declare type Sdk = {
-    table: TableTypes;
-    category: CategoryTypes;
-    catalog: CatalogTypes;
-    option: MenuOptionTypes;
-    storage: StorageTypes;
-    cashReceipt: CashReceiptTypes;
-    order: OrderTypes;
-    payment: PaymentTypes;
-    http: HttpTypes;
-    toast: ToastTypes;
-    merchant: MerchantTypes;
-    ui: UiType;
-    paymentMethod: PaymentMethodType;
-    websocket: WebsocketTypes;
-};
-/**
- * @publicApi
- */
-export declare const pos: Sdk;

package/types/printer/printer.d.ts

@@ -1,5 +0,0 @@
-import { PluginOrder, PluginTable } from '@tossplace-nexus/plugin-types';
-export interface PrinterTypes {
-    print: (order: PluginOrder, previousOrder?: PluginOrder, table?: PluginTable) => Promise<void>;
-}
-export declare const printer: PrinterTypes;

package/types/storage/storage.d.ts

@@ -1,17 +0,0 @@
-declare function get(key: string): Promise<string | undefined>;
-declare function set(key: string, value: any): Promise<void>;
-declare function del(key: string): Promise<void>;
-/**
- * @publicApi
- */
-export interface StorageTypes {
-    get: (key: string) => Promise<string | undefined>;
-    set: (key: string, value: string) => Promise<void>;
-    del: (key: string) => Promise<void>;
-}
-export declare const storage: {
-    get: typeof get;
-    set: typeof set;
-    del: typeof del;
-};
-export {};

package/types/table/table.d.ts

@@ -1,14 +0,0 @@
-import { PluginOrder, PluginTable } from '@tossplace-nexus/plugin-types';
-export interface TableTypes {
-    getTables: () => Promise<{
-        table: PluginTable;
-        order?: PluginOrder;
-    }[]>;
-    on(event: 'order-update' | 'add' | 'clear', 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>;
-}
-export declare const table: TableTypes;

package/types/toast/toast.d.ts

@@ -1,8 +0,0 @@
-declare function open(message: string): void;
-export declare type ToastTypes = {
-    open(message: string): void;
-};
-export declare const toast: {
-    open: typeof open;
-};
-export {};

package/types/ui/popup/popup.d.ts

@@ -1,2 +0,0 @@
-import { AllPopupType, PopupActionResponse, PopupElements } from '@tossplace-nexus/plugin-types';
-export declare function openPopup<T extends AllPopupType>(data: PopupElements<T>): Promise<PopupActionResponse<T>>;

package/types/ui/ui.d.ts

@@ -1,5 +0,0 @@
-import { AllPopupType, PopupActionResponse, PopupElements } from '@tossplace-nexus/plugin-types/src/ui/popup';
-export declare type UiType = {
-    openPopup<T extends AllPopupType>(message: PopupElements<T>): Promise<PopupActionResponse<T>>;
-};
-export declare const ui: UiType;

package/types/websocket/websocket.d.ts

@@ -1,34 +0,0 @@
-export 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;
-}
-export declare type WebsocketTypes = {
-    create: (url: string, headers: Record<string, string>, options?: {
-        rejectUnauthorized?: boolean;
-        followRedirects?: boolean;
-        timeout?: number;
-    }) => Promise<Websocket>;
-};
-export declare const websocket: WebsocketTypes;