@open-tender/types 0.0.2 → 0.0.3

package/dist/cjs/types/api/revenueCenter.d.ts

@@ -0,0 +1,52 @@
+import { TimeString } from '../datetimes';
+import { Decimal, Money, OrderType, ServiceType, TaxType, Weekday } from '../global';
+import { PunchAuthType } from './employee';
+import { PaymentProcessing } from './store';
+export interface RevenueCenterTax {
+    amount: Decimal;
+    display_order: number;
+    is_active: boolean;
+    is_optional: boolean;
+    name: string;
+    tax_id: number;
+    tax_type: TaxType;
+}
+export interface RevenueCenter {
+    credit: PaymentProcessing;
+    dine_in_prompt: boolean;
+    dine_in_show: boolean;
+    end_of_day: TimeString;
+    greeting: string;
+    has_loyalty: boolean;
+    is_closed: boolean;
+    is_outpost: boolean;
+    is_temporarily_closed: boolean;
+    item_discount_approval: boolean;
+    name: string;
+    olo_print_device_id: number;
+    olo_print_order_type: 'BOTH_OLO_CATERING' | 'OLO_ONLY' | 'CATERING_ONLY';
+    olo_print_server_id: number;
+    olo_print_stage: 'PLACED' | 'FIRED' | 'CONFIRMED';
+    order_page_swipe: boolean;
+    overtime_threshold: number;
+    overtime_threshold_daily: number;
+    page_timeout: number;
+    punch_type: PunchAuthType;
+    receipt_footer: string;
+    receipt_header: string;
+    receipt_phone: boolean;
+    revenue_center_id: number;
+    revenue_center_type: OrderType;
+    send_offline_alerts: boolean;
+    service_types: Array<ServiceType>;
+    short_name: string;
+    slug: string;
+    starting_cash: Money;
+    tax_exempt_approval: boolean;
+    taxes: Array<RevenueCenterTax>;
+    week_start_day: Weekday;
+    delivery_wait_time_id: number | null;
+    temporary_delivery_wait_time_id: number | null;
+    pickup_wait_time_id: number | null;
+    temporary_pickup_wait_time_id: number | null;
+}

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

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

package/dist/cjs/types/api/settings.d.ts

@@ -0,0 +1,10 @@
+import { EntityType } from '../global';
+export interface Settings {
+    entity_type: EntityType;
+    object_id: number;
+    version: number;
+    data: Record<string, unknown>;
+}
+export interface InternalSettings {
+    is_offline: boolean;
+}

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

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

package/dist/cjs/types/api/store.d.ts

@@ -0,0 +1,111 @@
+import { TimeString, TimezonePython } from '../datetimes';
+import { Decimal, Money, ServiceType, TenderType, Url, Weekday } from '../global';
+export declare type PaymentProcessor = 'NONE' | 'CARDCONNECT' | 'VANTIV' | 'CLOVER' | 'NMI';
+export interface PaymentProcessing {
+    integration: PaymentProcessor;
+    is_testing: boolean;
+    merchant_api_key: string;
+    merchant_id: string;
+    merchant_password: string;
+    merchant_username: string;
+    offline_limit: Money | null;
+    saved_cards: boolean;
+    signature_threshold: Money | null;
+}
+export interface StoreTax {
+    amount: Decimal;
+    display_order: number;
+    id: number;
+    is_active: boolean;
+    is_optional: boolean;
+    name: string;
+    tax_id: number;
+    tax_type: number;
+}
+export interface StoreTenderTypes {
+    DELIVERY: Array<TenderType>;
+    PICKUP: Array<TenderType>;
+    WALKIN: Array<TenderType>;
+}
+export interface StoreAddress {
+    city: string;
+    cross_streets: string;
+    directions_link: string;
+    fax: string | null;
+    latitude: Decimal;
+    longitude: Decimal;
+    phone: string | null;
+    postal_code: string;
+    state: string;
+    street: string;
+}
+export interface LevelUp {
+    discount_id: number;
+    location_id: number;
+    merchant_id: number;
+    merchant_token: string;
+    sandbox: boolean;
+}
+export interface StoreMessage {
+    pos_message_id: number;
+    name: string;
+    message_above: string | null;
+    message_below: string | null;
+    message_url: string | null;
+    is_active: boolean;
+}
+export interface Store {
+    address: StoreAddress;
+    auth_type: 'PIN' | 'CARD';
+    alert_minutes: number;
+    closed: boolean;
+    credit: PaymentProcessing;
+    delivery_minutes: number;
+    dine_in_prompt: boolean;
+    dine_in_show: boolean;
+    disable_complete: boolean;
+    display_promised_at: boolean;
+    display_ready_at: boolean;
+    display_revenue_center: boolean;
+    done_on_print: boolean;
+    end_of_day: TimeString;
+    greeting: string;
+    has_loyalty: boolean;
+    hide_default_mods: boolean;
+    hide_delay: boolean;
+    is_closed: boolean;
+    is_outpost: boolean;
+    is_temporarily_closed: boolean;
+    item_discount_approval: boolean;
+    levelup?: LevelUp;
+    messages: Array<StoreMessage> | null;
+    name: string;
+    number: string;
+    order_page_swipe: boolean;
+    origin: Url | null;
+    overtime_threshold: number;
+    overtime_threshold_daily: number;
+    page_timeout: number;
+    pickup_minutes: number;
+    prep_minutes: number;
+    print_on_completed: boolean;
+    punch_type: 'PIN' | 'CARD';
+    receipt_footer: string;
+    receipt_header: string;
+    receipt_phone: boolean;
+    revenue_center_id: number;
+    revenue_center_type: 'POS' | 'OLO' | 'CATERING';
+    service_types: Array<ServiceType>;
+    short_name: string;
+    slug: string;
+    starting_cash: Decimal;
+    store_id: number;
+    tax_exempt_approval: boolean;
+    taxes: Array<StoreTax>;
+    tender_types: StoreTenderTypes;
+    timezone: TimezonePython;
+    walkin_minutes: number;
+    walkin_prep_minutes: number;
+    warning_minutes: number;
+    week_start_day: Weekday;
+}

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

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

package/dist/cjs/types/api/surcharges.d.ts

@@ -0,0 +1,15 @@
+import { Money, SurchargeType } from '../global';
+export interface Surcharge {
+    id: number;
+    name: string;
+    surcharge_type: SurchargeType;
+    position: number;
+    amount: Money;
+    min_amount: Money;
+    max_amount: Money;
+    is_active: boolean;
+    is_taxed: boolean;
+    requires_approval: boolean;
+    version: number;
+}
+export declare type Surcharges = Array<Surcharge>;

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

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

package/dist/cjs/types/api/taxes.d.ts

@@ -0,0 +1,15 @@
+import { Money, OrderType, ServiceType, TaxType } from '../global';
+export interface Tax {
+    id: number;
+    name: string;
+    tax_type: TaxType;
+    position: number;
+    amount: Money;
+    min_amount: Money;
+    max_amount: Money;
+    requires_approval: boolean;
+    service_type: ServiceType | null;
+    order_type: OrderType | null;
+    version: number;
+}
+export declare type Taxes = Array<Tax>;

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

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

package/dist/cjs/types/datetimes.d.ts

@@ -0,0 +1,39 @@
+declare type Year = `${number}${number}${number}${number}`;
+declare type Month = `${number}${number}`;
+declare type Day = `${number}${number}`;
+declare type Hours = `${number}${number}`;
+declare type Minutes = `${number}${number}`;
+declare type Seconds = `${number}${number}`;
+declare type Milliseconds = `${number}${number}${number}`;
+/**
+ * Represent a string like `2021-01-08`
+ */
+export declare type DateString = `${Year}-${Month}-${Day}`;
+/**
+ * Represent a string like `14:42:34.678`
+ */
+export declare type TimeString = `${Hours}:${Minutes}:${Seconds}`;
+export declare type TimeStringPrecise = `${Hours}:${Minutes}:${Seconds}.${Milliseconds}`;
+export declare type Time24 = `${Hours}:${Minutes}`;
+export declare type TimeHuman = `${Hours}:${Minutes} ${'AM' | 'PM'}`;
+/**
+ * Represent a timezone offset like `-05:00`
+ */
+export declare type TimezoneOffset = `${'+' | '-'}${Hours}:${Minutes}`;
+/**
+ * Represent a string like `2021-01-08T14:42:34.678Z` (format: ISO 8601).
+ *
+ * It is not possible to type more precisely (list every possible values for months, hours etc) as
+ * it would result in a warning from TypeScript:
+ *   "Expression produces a union type that is too complex to represent. ts(2590)
+ */
+export declare type ISOString = `${DateString}T${TimeString}Z`;
+export declare type ISOStringPrecise = `${DateString}T${TimeStringPrecise}Z`;
+export declare type ISOStringOffset = `${DateString}T${TimeString}${TimezoneOffset}`;
+export declare type TimezonePython = 'US/Eastern' | 'US/Central' | 'US/Mountain' | 'US/Pacific';
+export declare type Timezone = 'America/New_York' | 'America/Chicago' | 'America/Denver' | 'America/Los_Angeles';
+export declare type TimezoneMap = {
+    [Property in TimezonePython]: Timezone;
+};
+export declare type RequestedAt = ISOString | 'asap';
+export {};

package/dist/cjs/types/datetimes.js

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

package/dist/cjs/types/errors.d.ts

@@ -0,0 +1,2 @@
+export declare const MISSING_CUSTOMER = "Missing Customer";
+export declare const MISSING_CUSTOMER_TOKEN = "Missing Customer Token";

package/dist/cjs/types/errors.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MISSING_CUSTOMER_TOKEN = exports.MISSING_CUSTOMER = void 0;
+exports.MISSING_CUSTOMER = 'Missing Customer';
+exports.MISSING_CUSTOMER_TOKEN = 'Missing Customer Token';

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

@@ -0,0 +1,39 @@
+export declare type Decimal = `${number}.${number}`;
+export declare type Money = `${number}.${number}`;
+export declare type NegativeMoney = `-${number}.${number}`;
+export declare type Percentage = `${number}.${number}%`;
+export declare type IpAddress = `${number}.${number}.${number}.${number}`;
+export declare type Url = `https://${string}`;
+export declare type Weekday = 'SUNDAY' | 'MONDAY' | 'TUESDAY' | 'WEDNESDAY' | 'THURSDAY' | 'FRIDAY' | 'SATURDAY';
+export declare type OrderType = 'OLO' | 'CATERING' | 'MERCH';
+export declare type FullOrderType = OrderType | 'MAIN_MENU' | 'ECOMMERCE';
+export declare type OrderTypeMap = {
+    [Property in OrderType]: string;
+};
+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';
+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 SurchargeType = 'DOLLAR' | 'PERCENTAGE' | 'DISTANCE' | 'TRAVEL_TIME';
+export declare type TaxType = 'DOLLAR' | 'PERCENTAGE';
+export declare type TaxTypeInt = 1 | 2;
+export declare type Temperature = 'Hot' | 'Cold';
+export declare type ReceiptType = 'SALE' | 'REFUND';
+export declare type ChannelType = 'POS' | 'ONLINE' | 'APP' | 'PHONE' | 'KIOSK' | 'PORTAL';
+export declare type OrderStatus = 'OPEN' | 'HELD' | 'CLOSED' | 'VOID';
+export declare type TenderStatus = 'AUTHORIZED' | 'PAID' | 'REFUNDED' | 'VOID' | 'FAILED';
+export declare type EntityType = 'TIME_PUNCH' | 'CASH_EVENT' | 'ORDER' | 'DEPARTMENT' | 'DEVICES' | 'DISCOUNT' | 'EMPLOYEE' | 'HOUSE_ACCOUNT' | 'LOCATION' | 'MENU' | 'MENU_PAGE' | 'SELECT_OPTION' | 'SURCHARGE' | 'TAX' | 'STORE' | 'REVENUE_CENTER' | 'ITEM_TYPE' | 'QRCODE';
+export interface PicklistOption {
+    name: string;
+    value: string | number;
+    disabled?: boolean;
+}
+export declare type PicklistOptions = PicklistOption[];
+export declare type DisplayPage = 'GUEST' | 'ACCOUNT';

package/dist/cjs/types/global.js

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

package/dist/cjs/types/index.d.ts

@@ -0,0 +1,6 @@
+export * from './api';
+export * from './datetimes';
+export * from './global';
+export * from './request';
+export * from './theme';
+export * from './errors';

package/dist/cjs/types/index.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./api"), exports);
+tslib_1.__exportStar(require("./datetimes"), exports);
+tslib_1.__exportStar(require("./global"), exports);
+tslib_1.__exportStar(require("./request"), exports);
+tslib_1.__exportStar(require("./theme"), exports);
+tslib_1.__exportStar(require("./errors"), exports);

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

@@ -0,0 +1,14 @@
+export interface IndexedError {
+    index: any;
+    [x: string]: string;
+}
+export interface RequestErrorAPI {
+    code: string;
+    title: string;
+    detail: string;
+    status: number;
+    params?: Record<string, string>;
+}
+export declare type RequestError = RequestErrorAPI | null | undefined;
+export declare type RequestStatus = 'idle' | 'pending';
+export declare type Version = number | null;

package/dist/cjs/types/request.js

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

package/dist/cjs/types/theme.d.ts

@@ -0,0 +1,109 @@
+/// <reference types="react" />
+export declare type Layout = {
+    padding: string;
+    margin: string;
+    headerHeight: string;
+    footerHeight: string;
+    asideWidth: string;
+    sidebarWidth: string;
+    gutter: string;
+    paddingLessGutter: string;
+    marginLessGutter: string;
+    bigButton: {
+        height: string;
+    };
+    nav: {
+        width: string;
+        height: string;
+    };
+    cards: {
+        padding: string;
+        tktMinHeight: string;
+    };
+};
+export declare type Font = {
+    fontFamily: string;
+    fontWeight: string;
+    fontStyle: string;
+    lineHeight: string;
+    letterSpacing: string;
+};
+export declare type FontSizes = {
+    xxxsmall: string;
+    xxsmall: string;
+    xsmall: string;
+    small: string;
+    medium: string;
+    large: string;
+    xlarge: string;
+    xxlarge: string;
+    xxxlarge: string;
+    mega: string;
+    giga: string;
+    tera: string;
+};
+export declare type Color = {
+    primary: string;
+    secondary: string;
+    tertiary: string;
+};
+export declare type Colors = {
+    text: Color;
+    background: Color;
+    border: Color;
+    link: Color;
+    error: Color;
+    success: Color;
+    alert: Color;
+};
+export declare type HeaderColor = {
+    text: string;
+    timer: string;
+    background: string;
+    border: string;
+};
+export declare type HeaderColors = {
+    default: HeaderColor;
+    alert: HeaderColor;
+    error: HeaderColor;
+};
+export declare type AlertColors = {
+    text: string;
+    default: string;
+    warning: string;
+    error: string;
+    success: string;
+};
+export declare type ButtonColor = {
+    color: string;
+    bgColor: string;
+    borderColor: string;
+};
+export declare type ButtonColors = {
+    primary: ButtonColor;
+    secondary: ButtonColor;
+    invisible: ButtonColor;
+    black: ButtonColor;
+    white: ButtonColor;
+    error: ButtonColor;
+    success: ButtonColor;
+    alert: ButtonColor;
+};
+export declare type ButtonSize = {
+    fontSize: string;
+    padding: string;
+    height: string;
+};
+export declare type ButtonSizes = {
+    xsmall: ButtonSize;
+    small: ButtonSize;
+    medium: ButtonSize;
+    large: ButtonSize;
+    xlarge: ButtonSize;
+};
+export interface NavButtonProps {
+    text: string;
+    icon: React.ReactNode;
+    onClick: () => void;
+    isActive: boolean;
+}

package/dist/cjs/types/theme.js

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

package/dist/esm/index.d.ts

@@ -0,0 +1 @@
+export * from './types';

package/dist/esm/index.js

@@ -0,0 +1 @@
+export * from './types';

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

@@ -0,0 +1,5 @@
+export interface Alert {
+    message: string;
+    id: string;
+}
+export declare type Alerts = Array<Alert>;

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

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

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

@@ -0,0 +1,7 @@
+export interface Allergen {
+    allergen_id: number;
+    description?: string;
+    images?: string[];
+    name?: string;
+}
+export declare type Allergens = Array<Allergen>;

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

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

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

@@ -0,0 +1,47 @@
+import { DisplayPage } from '../global';
+export interface Announcement {
+    announcement_id: number;
+    display_order: number;
+    hide_text: boolean;
+    hide_text_mobile: boolean;
+    horizontal: string;
+    images: string[];
+    overlay_color: string;
+    overlay_opacity: number;
+    show_overlay: boolean;
+    subtitle: string;
+    subtitle_color: string;
+    subtitle_size: number | string | null;
+    text_color: string;
+    title: string;
+    title_color: string;
+    title_size: number | string | null;
+    url: string | null;
+    url_text: string | null;
+    vertical: string;
+}
+export interface AnnouncementSettings {
+    announcement_page_id: number;
+    arrows_horizontal: string;
+    arrows_vertical: string;
+    autoplay: boolean;
+    duration: number;
+    duration_mobile: number;
+    page: DisplayPage;
+    show_arrows: boolean;
+    show_arrows_mobile: boolean;
+    show_dots: boolean;
+    show_dots_mobile: boolean;
+    subtitle: string | null;
+    title: string | null;
+    transition: number;
+    transition_mobile: number;
+    transition_type: string;
+}
+export declare type Announcements = Array<Announcement>;
+export interface AnnouncementPage {
+    entities: Announcements;
+    page: DisplayPage;
+    settings: AnnouncementSettings;
+}
+export declare type AnnouncementPages = Array<AnnouncementPage>;

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

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

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

@@ -0,0 +1,14 @@
+import { ISOStringOffset } from '../datetimes';
+import { Customer } from './customer';
+export interface Arrival {
+    arrived_utc: ISOStringOffset;
+    arrival_info: string | null;
+    customer?: Customer | null;
+    has_arrived: boolean;
+    order_id: number;
+    order_uuid: string;
+    vehicle_type: string | null;
+    vehicle_color: string | null;
+    vehicle_id: string | null;
+}
+export declare type Arrivals = Array<Arrival>;

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

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

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

@@ -0,0 +1,76 @@
+import { NutritionalInfo } from './menu';
+export interface GuestItem {
+    cart_guest_id?: number | null;
+    customer_id?: number | null;
+    made_for: string | null;
+    notes: string | null;
+}
+export interface CartItemOption {
+    id: number;
+    name: string;
+    shortName: string;
+    description: string | null;
+    imageUrl: string | null;
+    allergens: string[];
+    tags: string[];
+    ingredients: string | null;
+    nutritionalInfo: NutritionalInfo | null;
+    cals: number | null;
+    price: number;
+    quantity: number;
+    isDefault: boolean;
+    increment: number;
+    max: number;
+    min: number;
+    isSoldOut: boolean;
+    points: number;
+    totalPrice: number;
+    totalPoints: number | null;
+    totalCals: number | null;
+}
+export declare type CartItemOptions = Array<CartItemOption>;
+export interface CartItemGroup {
+    id: number;
+    name: string;
+    description: string | null;
+    imageUrl: string | null;
+    included: number;
+    max: number;
+    min: number;
+    isSize: boolean;
+    options: CartItemOptions;
+}
+export declare type CartItemGroups = Array<CartItemGroup>;
+export interface CartItem {
+    index?: number;
+    id: number;
+    name: string;
+    shortName: string;
+    cart_guest_id?: number | null;
+    category: string;
+    customer_id?: number | null;
+    description: string | null;
+    imageUrl: string | null;
+    slug: string;
+    allergens: string[];
+    tags: string[];
+    ingredients: string | null;
+    madeFor?: string | null;
+    notes?: string | null;
+    nutritionalInfo: NutritionalInfo | null;
+    cals: number | null;
+    groups: CartItemGroups;
+    quantity: number;
+    price: number;
+    increment: number;
+    max: number;
+    min: number;
+    points: number | null;
+    upsellItems: number[];
+    similarItems: number[];
+    totalPrice: number;
+    totalPoints: number | null;
+    totalCals: number | null;
+}
+export declare type Cart = Array<CartItem>;
+export declare type CartCounts = Record<string, number>;

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

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