@open-tender/types 0.0.2 → 0.0.3

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

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

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

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

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

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

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

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

package/package.json

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