@tossplace/pos-plugin-sdk 0.0.0

package/types/merchant/merchant.d.ts

@@ -0,0 +1,9 @@
+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

@@ -0,0 +1,9 @@
+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

@@ -0,0 +1,19 @@
+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

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

package/types/payment/payment.d.ts

@@ -0,0 +1,13 @@
+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

@@ -0,0 +1,12 @@
+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

@@ -0,0 +1,37 @@
+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

@@ -0,0 +1,5 @@
+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

@@ -0,0 +1,17 @@
+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

@@ -0,0 +1,14 @@
+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

@@ -0,0 +1,8 @@
+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

@@ -0,0 +1,2 @@
+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

@@ -0,0 +1,5 @@
+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

@@ -0,0 +1,34 @@
+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;