@open-tender/types 0.4.158 → 0.4.160

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

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

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

@@ -0,0 +1,52 @@
+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 interface TimeInterval {
+    label: string;
+    value: string;
+}
+export interface TimeOption {
+    name: string;
+    value: string | number | null;
+    disabled: boolean;
+}
+export interface DatePickerTimes {
+    excludeTimes: Array<Date>;
+    interval: number;
+}
+export {};

package/dist/esm/types/datetimes.js

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

package/dist/esm/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/esm/types/errors.js

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

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

@@ -0,0 +1,58 @@
+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}` | '0.00';
+export declare type Percentage = `${number}.${number}%`;
+export declare type IpAddress = `${number}.${number}.${number}.${number}`;
+export declare type Url = `https://${string}`;
+export declare type LatLng = {
+    lat: number;
+    lng: number;
+};
+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';
+export declare type ServiceTypeMap = {
+    [Property in ServiceType]: string;
+};
+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 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';
+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' | 'PENDING';
+export declare type TenderStatus = 'AUTHORIZED' | 'PAID' | 'REFUNDED' | 'VOID' | 'FAILED';
+export declare type EntityType = 'DEVICES' | 'DISCOUNT' | 'EMPLOYEE' | 'HOUSE_ACCOUNT' | 'ITEM_COLORS' | 'ITEM_TYPE' | 'KIOSK_CONFIG' | 'LEVELUP' | 'MENU' | 'POS_MESSAGE' | 'POS_PAGE' | 'QRCODE' | 'SELECT_OPTION' | 'STORE' | 'SURCHARGE' | 'TAX';
+export interface PicklistOption {
+    name: string;
+    value: string | number;
+    disabled?: boolean;
+}
+export declare type PicklistOptions = PicklistOption[];
+export declare type DeviceType = 'DESKTOP' | 'KIOSK' | 'MOBILE' | 'NONE' | 'TABLET';
+export declare type PrepType = 'EAT_HERE' | 'TAKE_OUT';
+export declare type ImageType = 'APP_IMAGE' | 'LARGE_IMAGE' | 'SMALL_IMAGE';
+export interface Image {
+    type: ImageType;
+    url: string;
+}
+export declare type Images = Image[];
+export declare type OrderNotifications = 'ALL' | 'EMAIL' | 'NEW' | 'NONE' | 'SMS';
+export declare type Gender = 'MALE' | 'FEMALE' | 'DECLINED';

package/dist/esm/types/global.js

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

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

@@ -0,0 +1,8 @@
+export * from './api';
+export * from './datetimes';
+export * from './global';
+export * from './inputs';
+export * from './pizzaBuilder';
+export * from './request';
+export * from './themePos';
+export * from './errors';

package/dist/esm/types/index.js

@@ -0,0 +1,8 @@
+export * from './api';
+export * from './datetimes';
+export * from './global';
+export * from './inputs';
+export * from './pizzaBuilder';
+export * from './request';
+export * from './themePos';
+export * from './errors';

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

@@ -0,0 +1,82 @@
+/// <reference types="react" />
+export interface Checkbox {
+    description?: string;
+    disabled?: boolean;
+    id?: string;
+    label?: string;
+    name: string;
+    on?: boolean;
+    onChange?: React.ChangeEventHandler<HTMLInputElement>;
+    required?: boolean;
+    showLabel?: boolean;
+    type: string;
+}
+export interface Input {
+    autoComplete?: string;
+    children?: JSX.Element;
+    disabled?: boolean;
+    error?: string | null;
+    icon?: JSX.Element;
+    label?: string;
+    max?: number;
+    min?: number;
+    name: string;
+    onChange?: React.ChangeEventHandler<HTMLInputElement> | undefined;
+    onBlur?: (evt: any) => void;
+    pattern?: string;
+    placeholder?: string;
+    readOnly?: boolean;
+    required?: boolean;
+    showLabel?: boolean;
+    style?: React.CSSProperties;
+    type: string;
+    value?: string | number;
+    maxLength?: number | undefined;
+}
+export interface Select {
+    disabled?: boolean;
+    error?: string | null;
+    label: string;
+    name: string;
+    onChange?: React.ChangeEventHandler<HTMLSelectElement>;
+    options: {
+        name: string;
+        value: string;
+        disabled?: boolean;
+    }[];
+    required?: boolean;
+    showLabel?: boolean;
+    type: string;
+    value?: string | number;
+}
+export interface Switch {
+    disabled?: boolean;
+    id?: string;
+    label: string;
+    name: string;
+    on?: boolean;
+    onChange?: React.ChangeEventHandler<HTMLInputElement>;
+    type: string;
+}
+export interface Textarea {
+    disabled?: boolean;
+    error?: string | null;
+    icon?: JSX.Element;
+    label: string;
+    name: string;
+    onChange?: React.ChangeEventHandler<HTMLTextAreaElement>;
+    placeholder?: string;
+    readOnly?: boolean;
+    required?: boolean;
+    showLabel?: boolean;
+    style?: React.CSSProperties;
+    type: string;
+    value?: string;
+}
+export declare type FormFieldType = Checkbox | Input | Select | Switch | Textarea;
+export declare const isCheckbox: (field: FormFieldType) => field is Checkbox;
+export declare const isSelect: (field: FormFieldType) => field is Select;
+export declare const isSwitch: (field: FormFieldType) => field is Switch;
+export declare const isTextarea: (field: FormFieldType) => field is Textarea;
+export declare const isInput: (field: FormFieldType) => field is Input;
+export declare type FormFields = FormFieldType[];

package/dist/esm/types/inputs.js

@@ -0,0 +1,15 @@
+export const isCheckbox = (field) => {
+    return field.type === 'checkbox';
+};
+export const isSelect = (field) => {
+    return field.type === 'select';
+};
+export const isSwitch = (field) => {
+    return field.type === 'switch';
+};
+export const isTextarea = (field) => {
+    return field.type === 'textarea';
+};
+export const isInput = (field) => {
+    return !['checkbox', 'select', 'switch', 'textarea'].includes(field.type);
+};

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

@@ -0,0 +1,7 @@
+import { CartItemGroup, CartItemOption } from './api';
+export declare type Coverage = '1st-half' | 'whole' | '2nd-half';
+export declare type Amount = 'normal' | 'extra' | 'light' | 'triple';
+export interface GroupOption {
+    group: CartItemGroup;
+    option: CartItemOption;
+}

package/dist/esm/types/pizzaBuilder.js

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

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

@@ -0,0 +1,27 @@
+export declare type Version = number | null;
+export declare type RequestStatus = 'idle' | 'pending';
+export interface IndexedError {
+    index: any;
+    [x: string]: string;
+}
+export interface RequestErrorMessage {
+    code: string;
+    detail: string;
+    message?: string;
+    title: string;
+}
+export declare type RequestErrorParams = Record<string, string>;
+export interface RequestErrorAPI extends RequestErrorMessage {
+    status: number;
+    params?: RequestErrorParams;
+}
+export declare type RequestError = RequestErrorAPI | null | undefined;
+export declare type CheckoutErrorParams = Record<string, RequestErrorMessage>;
+export interface CheckoutErrorAPI extends RequestErrorMessage {
+    status: number;
+    params?: CheckoutErrorParams;
+}
+export declare type CheckoutError = CheckoutErrorAPI | null | undefined;
+export interface CheckoutErrorMessages {
+    [name: string]: string | CheckoutErrorMessages;
+}

package/dist/esm/types/request.js

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

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

@@ -0,0 +1,117 @@
+/// <reference types="react" />
+export declare type Layout = {
+    padding: string;
+    margin: string;
+    headerHeight: string;
+    footerHeight: string;
+    sidebarWidth: string;
+    gutter: string;
+    paddingLessGutter: string;
+    marginLessGutter: string;
+    aside: {
+        width: string;
+        buttonHeight: string;
+    };
+    bigButton: {
+        width: string;
+        height: string;
+    };
+    tallButton: {
+        width: string;
+        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/esm/types/themePos.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@open-tender/types",
-  "version": "0.4.158",
+  "version": "0.4.160",
   "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",