@open-tender/types 0.1.3 → 0.1.5

package/dist/esm/types/api/order.js

@@ -1 +1,12 @@
-export {};
+export const isOrderCustomer = (customer) => {
+    return customer.customer_id !== undefined;
+};
+export const isCreditTender = (tender) => {
+    return tender.tender_type === 'CREDIT';
+};
+export const isGiftCardTender = (tender) => {
+    return tender.tender_type === 'GIFT_CARD';
+};
+export const isHouseAccountTender = (tender) => {
+    return tender.tender_type === 'HOUSE_ACCOUNT';
+};

package/dist/esm/types/api/pos.d.ts

@@ -0,0 +1,163 @@
+import { DateString, ISOStringOffset } from '../datetimes';
+import { ChannelType, Decimal, Money, NegativeMoney, ReceiptType, SurchargeType } from '../global';
+import { PrepStatus, TicketStatus } from './kds';
+import { Order, OrderCart, OrderItem } from './order';
+export interface PosOrderItemGroup {
+    id: number;
+    name: string;
+    options: PosOrderItemOptions;
+    short_name: string;
+}
+export declare type PosOrderItemGroups = PosOrderItemGroup[];
+export interface PosOrderItem extends Omit<OrderItem, 'groups'> {
+    item_no: number;
+    line_no: number;
+    groups: PosOrderItemGroups;
+}
+export declare type PosOrderItemOptions = PosOrderItem[];
+export declare type PosOrderCart = PosOrderItem[];
+export interface OrderTicket {
+    display_order?: number;
+    item_nos: number[];
+    item_type_id: number;
+    item_type_name: string;
+    ticket_no?: number;
+    ticket_status: PrepStatus;
+}
+export declare type OrderTickets = Array<OrderTicket>;
+export interface OrderPos extends Omit<Order, 'cart'> {
+    cart: PosOrderCart;
+}
+export interface OrderKds extends Omit<Order, 'fire_at' | 'tickets' | 'expected_at'> {
+    expected_at: ISOStringOffset;
+    fire_at: ISOStringOffset;
+    tickets: OrderTickets;
+}
+export declare type OrdersKds = Array<OrderKds>;
+export interface FetchOrdersArgs {
+    businessDate?: DateString | null;
+    receiptType?: ReceiptType | 'BOTH';
+    channelType?: Array<ChannelType> | null;
+    prepStatus?: Array<PrepStatus> | null;
+    search?: string | null;
+    sortBy?: 'requested_at' | 'expected_at' | 'fire_at';
+    sortDirection?: 'ASC' | 'DESC';
+    parentOrderId?: string;
+}
+export interface FetchOrdersAPIArgs {
+    business_date?: DateString;
+    receipt_type?: ReceiptType | 'BOTH';
+    channel_type?: string;
+    prep_status?: string;
+    search?: string;
+    sort_by?: 'requested_at' | 'expected_at' | 'fire_at';
+    sort_direction?: 'ASC' | 'DESC';
+    parent_receipt_uuid?: string;
+}
+export interface OrderCounts {
+    current: Record<string, number> | null;
+    future: Record<string, number> | null;
+    qa: Record<string, number> | null;
+    Orders: number;
+}
+export interface OrdersAndCounts {
+    orders: OrdersKds;
+    counts: OrderCounts;
+}
+export interface OrderUpdate {
+    expected_at?: string;
+    prep_status?: PrepStatus;
+}
+export interface OrderBucket {
+    orders: OrdersKds;
+    start: Date;
+    end: Date;
+}
+export declare type OrderBuckets = Array<OrderBucket>;
+export interface OrderTimes {
+    delayed: number;
+    requested: Date;
+    requestedTime: string;
+    expected: Date;
+    expectedDate: string;
+    expectedTime: string;
+    readyBy: Date;
+    readyTime: string;
+    dateStr: string;
+    status: string;
+}
+export interface TicketUpdate {
+    ticket_status: TicketStatus;
+}
+export interface TicketsUpdate {
+    ticket_status?: TicketStatus;
+    ticket_nos?: number[];
+}
+export declare type TicketStatusUpdate = 'done' | 'completed' | 'reset';
+export interface Ticket {
+    item_nos: number[];
+    item_type_id: number;
+    item_type_name: string;
+    ticket_no: number;
+    ticket_status: TicketStatus;
+    items: OrderCart;
+    is_default: boolean;
+    is_grouped: boolean;
+    is_hidden_assembly: boolean;
+    is_hidden_qa: boolean;
+    print_on_completed: boolean;
+}
+export declare type Tickets = Ticket[];
+export declare type TicketGroup = Ticket[];
+export declare type TicketGroups = TicketGroup[];
+export interface OrderKdsStatus {
+    NOT_DONE: boolean;
+    DONE: boolean;
+    COMPLETED: boolean;
+}
+export interface OrderItemCount {
+    item: OrderItem;
+    count: number;
+}
+export interface OrderItemDiscount {
+    discount_id: number;
+    amount: NegativeMoney;
+    amount_total: NegativeMoney;
+}
+export declare type OrderItemDiscounts = Array<OrderItemDiscount>;
+export interface OrderItemTax {
+    tax_id: number;
+    name: string;
+    amount: NegativeMoney;
+    amount_total: NegativeMoney;
+}
+export declare type OrderItemTaxes = Array<OrderItemTax>;
+export interface OrderSurchargeDiscount {
+    amount: NegativeMoney;
+    discount_id: number;
+    employee_id: number | null;
+}
+export interface OrderSurchargeTax {
+    tax_id: number;
+    name: string;
+    amount: NegativeMoney;
+    amount_total: NegativeMoney;
+}
+export interface PosOrderSurcharge {
+    amount: Money;
+    discount: NegativeMoney;
+    discounts: Array<OrderSurchargeDiscount>;
+    description?: string;
+    employee_id: number | null;
+    id: number;
+    surcharge_id?: number;
+    is_optional?: boolean;
+    is_taxed: boolean;
+    label?: string;
+    name: string;
+    percentage: Decimal | null;
+    surcharge_type: SurchargeType;
+    tax: Money;
+    taxes: Array<OrderSurchargeTax>;
+}
+export declare type PosOrderSurcharges = Array<PosOrderSurcharge>;

package/dist/esm/types/api/pos.js

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

package/dist/esm/types/global.d.ts

@@ -1,3 +1,8 @@
+export interface Modal {
+    args: Record<string, unknown> | null;
+    loading?: boolean;
+    type: string | null;
+}
 export declare type Decimal = `${number}.${number}`;
 export declare type Money = `${number}.${number}`;
 export declare type NegativeMoney = `-${number}.${number}`;
@@ -14,13 +19,13 @@ export declare type ServiceType = 'WALKIN' | 'PICKUP' | 'DELIVERY' | 'PORTAL' |
 export declare type ServiceTypeMap = {
     [Property in ServiceType]: string;
 };
-export declare type GratuityType = 'amount' | 'percent';
 export declare type TenderType = 'CASH' | 'CREDIT' | 'HOUSE_ACCOUNT' | 'GIFT_CARD' | 'COMP' | 'LEVELUP' | 'GOOGLE_PAY' | 'APPLE_PAY';
 export declare type TenderTypeMap = {
     [Property in TenderType]: string;
 };
 export declare type CardType = 'VISA' | 'MC' | 'DISC' | 'AMEX' | 'OTHER';
-export declare type DiscountType = 'DOLLAR' | 'PERCENTAGE';
+export declare type CardTypeName = 'Visa' | 'Mastercard' | 'Discover' | 'Amex' | 'Other';
+export declare type DiscountType = 'DOLLAR' | 'PERCENTAGE' | 'LOYALTY';
 export declare type DiscountAuthType = 'ACCOUNT' | 'VERIFIED' | null;
 export declare type SurchargeType = 'DOLLAR' | 'PERCENTAGE' | 'DISTANCE' | 'TRAVEL_TIME';
 export declare type TaxType = 'DOLLAR' | 'PERCENTAGE';
@@ -37,3 +42,5 @@ export interface PicklistOption {
     disabled?: boolean;
 }
 export declare type PicklistOptions = PicklistOption[];
+export declare type DeviceType = 'DESKTOP' | 'KIOSK' | 'MOBILE' | 'NONE' | 'TABLET';
+export declare type PrepType = 'EAT_HERE' | 'TAKE_OUT';

package/dist/esm/types/request.d.ts

@@ -2,13 +2,16 @@ export interface IndexedError {
     index: any;
     [x: string]: string;
 }
-export interface RequestErrorAPI {
+export interface RequestErrorMessage {
     code: string;
-    title: string;
     detail: string;
+    message: string;
+    title: string;
+}
+export declare type RequestErrorParams = Record<string, RequestErrorMessage>;
+export interface RequestErrorAPI extends RequestErrorMessage {
     status: number;
-    params?: Record<string, string>;
-    message?: string;
+    params?: RequestErrorParams;
 }
 export declare type RequestError = RequestErrorAPI | null | undefined;
 export declare type RequestStatus = 'idle' | 'pending';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@open-tender/types",
-  "version": "0.1.3",
+  "version": "0.1.5",
   "description": "A library of types for use with Open Tender applications that utilize our cloud-based Order API.",
   "main": "./dist/cjs/index.js",
   "module": "./dist/esm/index.js",