@open-tender/types 0.1.4 → 0.1.6

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

@@ -1,2 +1,19 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.isHouseAccountTender = exports.isGiftCardTender = exports.isCreditTender = exports.isOrderCustomer = void 0;
+const isOrderCustomer = (customer) => {
+    return customer.customer_id !== undefined;
+};
+exports.isOrderCustomer = isOrderCustomer;
+const isCreditTender = (tender) => {
+    return tender.tender_type === 'CREDIT';
+};
+exports.isCreditTender = isCreditTender;
+const isGiftCardTender = (tender) => {
+    return tender.tender_type === 'GIFT_CARD';
+};
+exports.isGiftCardTender = isGiftCardTender;
+const isHouseAccountTender = (tender) => {
+    return tender.tender_type === 'HOUSE_ACCOUNT';
+};
+exports.isHouseAccountTender = isHouseAccountTender;

package/dist/cjs/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/cjs/types/api/pos.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/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/cjs/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/dist/esm/types/api/checkout.d.ts

@@ -1,39 +1,9 @@
-import { ISOString, TimezonePython } from '../datetimes';
-import { DiscountType, GratuityType, Money, OrderType, ServiceType, TenderType } from '../global';
-import { Address, Customer, CustomerGiftCard, LoyaltyPoints } from './customer';
-import { OrderDetails, OrderDiscounts, OrderFulfillment, OrderItem, OrderRevenueCenter, OrderShipment, OrderSurcharges, OrderTaxes, OrderTenders, OrderTotals } from './order';
-export interface CustomerIdentifier {
-    card_token?: string;
-    phone?: string;
-    qr_code?: string;
-}
-export interface IdentifyCustomer {
-    data: CustomerIdentifier;
-    callback?: () => void;
-    showError?: boolean;
-}
-export interface CustomerDiscount {
-    customer_loyalty_id: number;
-    loyalty_program_id: number;
-    order_type: OrderType;
-    amount: Money;
-    name: string;
-    discount_id: number;
-    discount_type: DiscountType;
-    description: string;
-    before_surcharge: boolean;
-    is_taxed: boolean;
-    is_promo_code: boolean;
-    is_auto: boolean;
-    is_loyalty: boolean;
-}
-export declare type CustomerDiscounts = Array<CustomerDiscount>;
-export interface CustomerCheckout {
-    customer: Customer;
-    discounts: CustomerDiscounts;
-    points: any;
-    discount: any;
-}
+import { RequestedAt } from '../datetimes';
+import { CardType, CardTypeName, DeviceType, DiscountType, Money, OrderType, PrepType, ServiceType, TenderType } from '../global';
+import { RequestErrorParams } from '../request';
+import { Cart } from './cart';
+import { Address, Customer } from './customer';
+import { Order, OrderDiscounts, OrderFulfillment, OrderSurcharge } from './order';
 export interface SimpleCartOption {
     id: number;
     quantity: number;
@@ -61,13 +31,70 @@ export interface SimpleCartLookupOption {
 export interface SimpleCartLookupGroup {
     options: Record<string, SimpleCartLookupOption>;
 }
+export declare type CheckoutConfigFieldAddress = 'company' | 'contact' | 'phone' | 'unit';
+export declare type CheckoutConfigFieldCustomer = 'company';
+export declare type CheckoutConfigFieldDetails = 'count' | 'eatingUtensils' | 'notes' | 'servingUtensils';
+export interface CheckoutConfigFields {
+    address: CheckoutConfigFieldAddress[];
+    customer: CheckoutConfigFieldCustomer[];
+    details: CheckoutConfigFieldDetails[];
+}
+export interface CheckoutConfigGratuityAmount {
+    amount: Money;
+    percent: Money;
+}
+export interface CheckoutConfigGratuity {
+    default: CheckoutConfigGratuityAmount | null;
+    has_tip: boolean;
+    max_gratuity: CheckoutConfigGratuityAmount | null;
+    options: CheckoutConfigGratuityAmount[];
+}
+export interface CheckoutConfigCurbsideField {
+    label: string;
+    name: keyof OrderFulfillment;
+    placeholder: string;
+}
+export declare type CheckoutConfigCurbsideFields = CheckoutConfigCurbsideField[];
+export interface CheckoutConfigCurbside {
+    description: string;
+    fields: CheckoutConfigCurbsideFields;
+    title: string;
+}
+export interface CheckoutConfigLoyalty {
+    balance: number;
+    name: string;
+    per: 5;
+    remaining: number;
+}
+export interface CheckoutConfigSurcharge extends OrderSurcharge {
+    label: string;
+}
+export declare type CheckoutConfigSurcharges = CheckoutConfigSurcharge[];
+export interface CheckoutConfig {
+    allow_tax_exempt: boolean;
+    discounts: OrderDiscounts;
+    displayed: CheckoutConfigFields;
+    gratuity: CheckoutConfigGratuity;
+    order_fulfillment: CheckoutConfigCurbside | null;
+    points: CheckoutConfigLoyalty | null;
+    promo_code_limit: number;
+    required: CheckoutConfigFields;
+    surcharges: CheckoutConfigSurcharges;
+    tender_types: TenderType[];
+}
+export interface CheckoutCheck extends Order {
+    config: CheckoutConfig;
+    errors: RequestErrorParams;
+}
 export interface OrderCreateDetails {
+    cart_id?: number | null;
+    device_type?: DeviceType | null;
     eating_utensils?: boolean;
-    serving_utensils?: boolean;
-    person_count?: number | null;
     notes?: string | null;
+    notes_internal?: string | null;
+    person_count?: number | null;
+    serving_utensils?: boolean;
     tax_exempt_id?: string | null;
-    cart_id?: number | null;
 }
 export interface OrderCreateGiftCard {
     id: number;
@@ -80,108 +107,157 @@ export interface OrderCreateGiftCard {
 export interface OrderCreateSurcharge {
     id: number;
 }
+export declare type OrderCreateSurcharges = OrderCreateSurcharge[];
 export interface OrderCreateDiscount {
     id: number;
     ext_id?: string | null;
 }
+export declare type OrderCreateDiscounts = OrderCreateDiscount[];
 export interface OrderCreateTax {
     id: number;
 }
-export interface OrderCreatePoints {
+export declare type OrderCreateTaxes = OrderCreateTax[];
+export interface OrderCreatePointsItem {
     index: number;
     points: number;
 }
-export interface Tender {
+export declare type OrderCreatePoints = OrderCreatePointsItem[];
+export interface CheckoutFormAddress {
+    company?: string;
+    contact?: string;
+    phone?: string;
+    unit?: string;
+}
+export interface CheckoutFormCustomer {
+    company?: string;
+    customer_id?: number;
+    email?: string;
+    first_name?: string;
+    phone?: string;
+    last_name?: string;
+}
+export interface CheckoutTenderCreditGuest {
+    acct: string;
+    cvv: string;
+    amount: Money;
+    card_type_name: CardTypeName;
+    exp: string;
+    is_default: false;
+    last4: string;
+    masked: string;
+    tender_type: TenderType;
+    zip: string;
+}
+export interface CheckoutTenderCreditCustomer {
+    tender_type: TenderType;
+    amount: Money;
+    card_type: CardType;
+    card_type_name: CardTypeName;
+    customer_card_id: number;
+    last4: string;
+    masked: string;
+    is_default: false;
+}
+export interface CheckoutTenderGiftCard {
+    amount: Money;
+    balance?: Money;
+    card_number: string;
+    tender_type: TenderType;
+}
+export interface CheckoutTenderHouseAccount {
+    amount: Money;
+    approved_contact: boolean;
+    domain: string | null;
+    house_account_id: number;
+    name: string;
+    order_type: OrderType | null;
+    pin: string;
+    revenue_centers: number[];
+    service_type: ServiceType | null;
     tender_type: TenderType;
-    amount?: Money;
-    cash_back?: Money;
-    customer_card_id?: string;
-    acct?: string;
-    cvv?: string;
-    exp?: string;
-    zip?: string;
-    save?: boolean;
+}
+export declare type CheckoutTender = CheckoutTenderCreditGuest | CheckoutTenderCreditCustomer | CheckoutTenderGiftCard | CheckoutTenderHouseAccount;
+export declare type CheckoutTenders = CheckoutTender[];
+export declare type CheckoutPromoCodes = string[];
+export interface CheckoutForm {
+    address: CheckoutFormAddress;
+    customer: CheckoutFormCustomer;
+    details: OrderCreateDetails;
+    discounts: OrderCreateDiscounts;
+    points: OrderCreatePoints;
+    promoCodes: CheckoutPromoCodes;
+    surcharges: OrderCreateSurcharges;
+    tenders: CheckoutTenders;
+    tip: Money | null;
+}
+export interface OrderData {
+    address: Address | null;
+    cart: Cart;
+    cartId: number | null;
+    customer: CheckoutFormCustomer;
+    details: OrderCreateDetails | null;
+    deviceType: DeviceType | null;
+    discounts: OrderCreateDiscounts | null;
+    orderId: number | null;
+    points: OrderCreatePoints | null;
+    prepType: PrepType | null;
+    promoCodes: CheckoutPromoCodes | null;
+    requestedAt: RequestedAt;
+    revenueCenterId: number;
+    serviceType: ServiceType;
+    surcharges: OrderCreateSurcharges | null;
+    table: string | null;
+    tenders: CheckoutTenders | null;
+    tip: Money | null;
 }
 export interface OrderCreate {
     address?: Address | null;
     cart: SimpleCart;
-    customer?: Customer | null;
+    cart_id?: number;
+    customer?: CheckoutFormCustomer | null;
     details?: OrderCreateDetails | null;
-    discounts?: Array<OrderCreateDiscount>;
-    gift_cards?: Array<OrderCreateGiftCard>;
-    is_tax_exempt?: boolean;
-    made_for?: string;
-    order_type?: OrderType;
-    order_uuid?: string;
-    points?: Array<OrderCreatePoints>;
-    promo_codes?: string[];
-    requested_at: ISOString | 'asap';
-    revenue_center_id?: number;
+    discounts?: OrderCreateDiscounts;
+    order_id?: number;
+    points?: OrderCreatePoints;
+    promo_codes?: CheckoutPromoCodes;
+    requested_at: RequestedAt;
+    revenue_center_id: number;
     service_type: ServiceType;
     shipment_id?: string;
-    surcharges?: Array<OrderCreateSurcharge>;
-    taxes?: Array<OrderCreateTax>;
-    tenders?: Array<Tender>;
+    surcharges?: OrderCreateSurcharges;
+    taxes?: OrderCreateTaxes;
+    tenders?: CheckoutTenders;
     tip?: Money;
 }
-export interface CheckoutConfigDisplayed {
-    address: string[];
-    customer: string[];
-    details: string[];
-}
-export interface CheckoutConfigGratuity {
-    default: {
-        [key in GratuityType]: string;
-    } | null;
-    has_tip: boolean;
-    max_gratuity: {
-        [key in GratuityType]: string;
-    } | null;
-    options: {
-        [key in GratuityType]: string;
-    }[];
+export interface CustomerIdentifier {
+    card_token?: string;
+    phone?: string;
+    qr_code?: string;
 }
-export interface CheckoutConfig {
-    allow_tax_exempt: boolean;
-    discounts: OrderDiscounts;
-    displayed: CheckoutConfigDisplayed;
-    gratuity: CheckoutConfigGratuity;
-    order_fulfillment: OrderFulfillment;
-    points: LoyaltyPoints | null;
-    promo_code_limit: number;
-    required: CheckoutConfigDisplayed;
-    surcharges: OrderSurcharges;
-    tender_types: Array<TenderType>;
+export interface IdentifyCustomer {
+    data: CustomerIdentifier;
+    callback?: () => void;
+    showError?: boolean;
 }
-export interface CheckoutForm {
-    address: Partial<Address> | null;
-    customer: Customer;
-    details: Partial<OrderDetails>;
-    discounts: OrderDiscounts;
-    points: Array<LoyaltyPoints>;
-    promoCodes: any;
-    surcharges: OrderSurcharges;
-    tenders: OrderTenders;
-    tip: any;
+export interface CustomerDiscount {
+    customer_loyalty_id: number;
+    loyalty_program_id: number;
+    order_type: OrderType;
+    amount: Money;
+    name: string;
+    discount_id: number;
+    discount_type: DiscountType;
+    description: string;
+    before_surcharge: boolean;
+    is_taxed: boolean;
+    is_promo_code: boolean;
+    is_auto: boolean;
+    is_loyalty: boolean;
 }
-export interface CheckoutCheck {
-    address: Address | null;
-    order_id?: string | number;
-    cart: Array<OrderItem>;
-    config: CheckoutConfig;
+export declare type CustomerDiscounts = Array<CustomerDiscount>;
+export interface CustomerCheckout {
     customer: Customer;
-    details: OrderDetails;
-    discounts: OrderDiscounts;
-    order_type: OrderType;
-    requested_at: ISOString;
-    revenue_center: OrderRevenueCenter;
-    service_type: ServiceType;
-    shipment: OrderShipment | null;
-    surcharges: OrderSurcharges;
-    taxes: OrderTaxes;
-    tenders: OrderTenders;
-    timezone: TimezonePython;
-    totals: OrderTotals;
-    gift_cards: Array<Partial<CustomerGiftCard>>;
-    errors: any;
+    discounts: CustomerDiscounts;
+    points: any;
+    discount: any;
 }

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

@@ -528,6 +528,9 @@ export interface ConfigCountColors {
     weight: string;
 }
 export declare type ConfigFontSizes = 'big' | 'giga' | 'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6' | 'main' | 'mega' | 'small' | 'tera' | 'xBig' | 'xSmall' | 'xxBig' | 'xxSmall';
+export declare type ConfigThemeFontSizes = Record<string, string> & {
+    [keys in ConfigFontSizes]: string;
+};
 export interface ConfigFont {
     color: string;
     family: string;
@@ -535,9 +538,7 @@ export interface ConfigFont {
     fontSmoothing: string;
     letterSpacing: string;
     lineHeight: number;
-    lineHeights: {
-        [keys in ConfigFontSizes]: string;
-    };
+    lineHeights: ConfigThemeFontSizes;
     textTransform: string;
     url: string;
     weight: string;
@@ -559,13 +560,10 @@ export interface ConfigThemeFont {
     body: ConfigFont;
     headings: ConfigFont;
     headline: ConfigFont;
-    lineHeights: {
-        [keys in ConfigFontSizes]: string;
-    };
+    lineHeights: ConfigThemeFontSizes;
     preface: ConfigFont;
-    sizes: {
-        [keys in ConfigFontSizes]: string;
-    };
+    sizes: ConfigThemeFontSizes;
+    sizesMobile: ConfigThemeFontSizes;
 }
 export interface ConfigThemeInputLabel {
     fontSize: string;
@@ -705,24 +703,25 @@ export interface ConfigThemeWelcome {
     titleSize: string;
     mobile?: ConfigThemeWelcome;
 }
+export interface ConfigThemeColors extends Record<string, string> {
+    alert: string;
+    allergens: string;
+    dark: string;
+    error: string;
+    highlight: string;
+    light: string;
+    primary: string;
+    secondary: string;
+    success: string;
+    tertiary: string;
+    toast: string;
+}
 export interface ConfigTheme {
     alert: {
         bgColor: string;
         color: string;
     };
-    bgColors: {
-        alert: string;
-        allergens: string;
-        dark: string;
-        error: string;
-        highlight: string;
-        light: string;
-        primary: string;
-        secondary: string;
-        success: string;
-        tertiary: string;
-        toast: string;
-    };
+    bgColors: ConfigThemeColors;
     boldWeight: string;
     border: ConfigThemeBorder;
     boxShadow: {
@@ -739,20 +738,7 @@ export interface ConfigTheme {
     };
     buttons: ConfigThemeButtons;
     cards: ConfigThemeCards;
-    colors: {
-        alert: string;
-        allergens: string;
-        dark: string;
-        error: string;
-        light: string;
-        primary: string;
-        secondary: string;
-        success: string;
-        tags: string;
-        tertiary: string;
-        title: string;
-        toast: string;
-    };
+    colors: ConfigThemeColors;
     counts: ConfigThemeCounts;
     error: {
         bgColor: string;