@open-tender/types 0.2.0 → 0.2.2

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

@@ -1,4 +1,19 @@
 import { NutritionalInfo } from './menu';
+import { OrderItemPoints } from './order';
+export interface BaseItemGroup {
+    id: number;
+    name: string;
+    options: BaseItem[];
+}
+export declare type BaseItemGroups = BaseItemGroup[];
+export interface BaseItem {
+    id: number;
+    name: string;
+    quantity: number;
+    price: string | number;
+    groups: BaseItemGroups;
+}
+export declare type BaseItems = BaseItem[];
 export interface CartItemOption {
     allergens: string[];
     cals: number | null;
@@ -25,6 +40,7 @@ export interface CartItemOption {
     totalPoints: number | null;
     totalPrice: number | null;
 }
+export declare type CartItemOptions = CartItemOption[];
 export interface CartItemOptionWithIndex extends CartItemOption {
     index: number;
 }
@@ -38,7 +54,10 @@ export interface CartItem extends Omit<CartItemOption, 'isDefault'> {
     similarItems: number[];
     upsellItems: number[];
 }
-export declare type CartItemOptions = CartItemOption[];
+export interface CartItemWithPoints extends Omit<CartItem, 'points'> {
+    points: OrderItemPoints | null;
+}
+export declare type CartWithPoints = CartItemWithPoints[];
 export interface CartItemGroup {
     description: string | null;
     id: number;
@@ -61,6 +80,17 @@ export declare type CartItemGroupLookupOptions = Omit<CartItemGroup, 'options'>
     options: CartItemOptionLookup;
 };
 export declare type CartItemGroupLookup = Record<string, CartItemGroupLookupOptions>;
+export interface CartItemWithErrors extends CartItem {
+    missingGroups: CartItemGroupLookupOptions[];
+    invalidGroups: CartItemGroups;
+    missingOptions: CartItemOptions;
+    invalidOptions: CartItemOptions;
+}
+export declare type CartWithErrors = CartItemWithErrors[];
+export interface CartErrors {
+    missingItems: Cart;
+    invalidItems: CartWithErrors;
+}
 export interface PosCartItem extends CartItem {
     item_no: number;
     line_no: number;

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

@@ -21,8 +21,14 @@ export interface CreditCardData {
     is_default?: boolean;
     token?: string;
 }
+export interface CreditCardErrors {
+    acct?: string;
+    exp?: string;
+    cvv?: string;
+    zip?: string;
+}
 export interface CreditCardValidate {
     card: CreditCardData;
     cardType: CardType;
-    errors: Partial<CreditCardData> | null;
+    errors: CreditCardErrors | null;
 }

package/dist/cjs/types/api/customer/account.d.ts

@@ -1,4 +1,3 @@
-import { CustomerLoyalty } from './loyalty';
 export interface Auth {
     access_token: string;
     expires_in: number;
@@ -16,7 +15,6 @@ export interface Profile {
     is_verified: boolean;
     last_name: string;
     phone: string;
-    program: CustomerLoyalty;
 }
 export interface LoginData {
     email: string;

package/dist/cjs/types/api/customer/loyalty.d.ts

@@ -37,6 +37,12 @@ export interface LoyaltyThreshold {
     points: number;
     description: string;
 }
+export declare type LoyaltyThresholds = LoyaltyThreshold[];
+export interface LoyaltyThresholdAugmented extends LoyaltyThreshold {
+    percentage: number;
+    isFilled: boolean;
+}
+export declare type LoyaltyThresholdsAugmented = LoyaltyThresholdAugmented[];
 export interface LoyaltyDiscount {
     amount: string;
     description: string;
@@ -54,6 +60,7 @@ export interface LoyaltyTier {
     points: any;
     value: any;
 }
+export declare type LoyaltyTiers = LoyaltyTier[];
 export interface CustomerLoyalty {
     credit: LoyaltyCredit | null;
     description: string;
@@ -64,8 +71,8 @@ export interface CustomerLoyalty {
     remaining: string | null;
     spend: LoyaltySpend;
     status: LoyaltyStatus;
-    thresholds: Array<LoyaltyThreshold>;
-    tiers: Array<LoyaltyTier>;
+    thresholds: LoyaltyThresholds;
+    tiers: LoyaltyTiers;
     towards: string | null;
 }
-export declare type CustomerLoyalties = Array<CustomerLoyalty>;
+export declare type CustomerLoyalties = CustomerLoyalty[];

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

@@ -1,5 +1,6 @@
 import { RequestedAt } from '../datetimes';
 import { Decimal, Money, ServiceType, TaxTypeInt, Temperature } from '../global';
+import { Cart, CartErrors } from './cart';
 export interface NutritionalInfo {
     calories: number;
     cholesterol: number;
@@ -145,6 +146,10 @@ export interface MenuVars {
     serviceType: ServiceType;
     requestedAt: RequestedAt;
 }
+export interface MenuCartErrors {
+    newCart: Cart;
+    errors: CartErrors | null;
+}
 export interface DiscountedItem {
     id: number;
     category_id: number;

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

@@ -4,6 +4,13 @@ import { CreditCard } from './creditCards';
 import { Address } from './customer';
 import { PrepStatus } from './kds';
 import { NutritionalInfo } from './menu';
+export interface OrderItemPoints {
+    applied: number;
+    available: number;
+    index?: number;
+    per: number;
+    total: number;
+}
 export interface OrderItem {
     allergens: string[];
     description: string | null;
@@ -15,7 +22,7 @@ export interface OrderItem {
     name: string;
     notes?: string | null;
     nutritional_info: NutritionalInfo | null;
-    points?: number | null;
+    points?: OrderItemPoints | null;
     price: Money;
     price_total: Money;
     quantity: number;
@@ -138,6 +145,13 @@ export interface OrderRating {
     comments: string | null;
     rating: number;
 }
+export interface OrderRating {
+    comments: string | null;
+    rating: number;
+}
+export interface OrderRatingWithOrder extends OrderRating {
+    order_id: number;
+}
 export interface OrderRevenueCenterAddress {
     city: string;
     lat: number;

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

@@ -7,7 +7,7 @@ export interface RevenueCenterParams {
     lng?: number;
     requestedAt?: string;
 }
-export declare type RevenueCenterType = 'POS' | 'OLO' | 'CATERING';
+export declare type RevenueCenterType = 'OLO' | 'CATERING';
 export interface RevenueCenterAddress {
     city: string;
     cross_streets: string;

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

@@ -354,6 +354,7 @@ export interface ThemeLink extends Record<string, string> {
     color: string;
     hover: string;
 }
+export declare type ThemeLinkType = 'customize' | 'dark' | 'light' | 'primary';
 export interface ThemeLinks extends Record<string, string | ThemeLink> {
     customize: ThemeLink;
     dark: ThemeLink;

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

@@ -15,7 +15,7 @@ export interface Input {
     autoComplete?: string;
     children?: JSX.Element;
     disabled?: boolean;
-    error?: string;
+    error?: string | null;
     icon?: JSX.Element;
     label?: string;
     max?: number;
@@ -34,7 +34,7 @@ export interface Input {
 }
 export interface Select {
     disabled?: boolean;
-    error: string;
+    error?: string | null;
     label: string;
     name: string;
     onChange?: React.ChangeEventHandler<HTMLSelectElement>;
@@ -59,7 +59,7 @@ export interface Switch {
 }
 export interface Textarea {
     disabled?: boolean;
-    error?: string;
+    error?: string | null;
     icon?: JSX.Element;
     label: string;
     name: string;

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

@@ -1,4 +1,19 @@
 import { NutritionalInfo } from './menu';
+import { OrderItemPoints } from './order';
+export interface BaseItemGroup {
+    id: number;
+    name: string;
+    options: BaseItem[];
+}
+export declare type BaseItemGroups = BaseItemGroup[];
+export interface BaseItem {
+    id: number;
+    name: string;
+    quantity: number;
+    price: string | number;
+    groups: BaseItemGroups;
+}
+export declare type BaseItems = BaseItem[];
 export interface CartItemOption {
     allergens: string[];
     cals: number | null;
@@ -25,6 +40,7 @@ export interface CartItemOption {
     totalPoints: number | null;
     totalPrice: number | null;
 }
+export declare type CartItemOptions = CartItemOption[];
 export interface CartItemOptionWithIndex extends CartItemOption {
     index: number;
 }
@@ -38,7 +54,10 @@ export interface CartItem extends Omit<CartItemOption, 'isDefault'> {
     similarItems: number[];
     upsellItems: number[];
 }
-export declare type CartItemOptions = CartItemOption[];
+export interface CartItemWithPoints extends Omit<CartItem, 'points'> {
+    points: OrderItemPoints | null;
+}
+export declare type CartWithPoints = CartItemWithPoints[];
 export interface CartItemGroup {
     description: string | null;
     id: number;
@@ -61,6 +80,17 @@ export declare type CartItemGroupLookupOptions = Omit<CartItemGroup, 'options'>
     options: CartItemOptionLookup;
 };
 export declare type CartItemGroupLookup = Record<string, CartItemGroupLookupOptions>;
+export interface CartItemWithErrors extends CartItem {
+    missingGroups: CartItemGroupLookupOptions[];
+    invalidGroups: CartItemGroups;
+    missingOptions: CartItemOptions;
+    invalidOptions: CartItemOptions;
+}
+export declare type CartWithErrors = CartItemWithErrors[];
+export interface CartErrors {
+    missingItems: Cart;
+    invalidItems: CartWithErrors;
+}
 export interface PosCartItem extends CartItem {
     item_no: number;
     line_no: number;

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

@@ -21,8 +21,14 @@ export interface CreditCardData {
     is_default?: boolean;
     token?: string;
 }
+export interface CreditCardErrors {
+    acct?: string;
+    exp?: string;
+    cvv?: string;
+    zip?: string;
+}
 export interface CreditCardValidate {
     card: CreditCardData;
     cardType: CardType;
-    errors: Partial<CreditCardData> | null;
+    errors: CreditCardErrors | null;
 }

package/dist/esm/types/api/customer/account.d.ts

@@ -1,4 +1,3 @@
-import { CustomerLoyalty } from './loyalty';
 export interface Auth {
     access_token: string;
     expires_in: number;
@@ -16,7 +15,6 @@ export interface Profile {
     is_verified: boolean;
     last_name: string;
     phone: string;
-    program: CustomerLoyalty;
 }
 export interface LoginData {
     email: string;

package/dist/esm/types/api/customer/loyalty.d.ts

@@ -37,6 +37,12 @@ export interface LoyaltyThreshold {
     points: number;
     description: string;
 }
+export declare type LoyaltyThresholds = LoyaltyThreshold[];
+export interface LoyaltyThresholdAugmented extends LoyaltyThreshold {
+    percentage: number;
+    isFilled: boolean;
+}
+export declare type LoyaltyThresholdsAugmented = LoyaltyThresholdAugmented[];
 export interface LoyaltyDiscount {
     amount: string;
     description: string;
@@ -54,6 +60,7 @@ export interface LoyaltyTier {
     points: any;
     value: any;
 }
+export declare type LoyaltyTiers = LoyaltyTier[];
 export interface CustomerLoyalty {
     credit: LoyaltyCredit | null;
     description: string;
@@ -64,8 +71,8 @@ export interface CustomerLoyalty {
     remaining: string | null;
     spend: LoyaltySpend;
     status: LoyaltyStatus;
-    thresholds: Array<LoyaltyThreshold>;
-    tiers: Array<LoyaltyTier>;
+    thresholds: LoyaltyThresholds;
+    tiers: LoyaltyTiers;
     towards: string | null;
 }
-export declare type CustomerLoyalties = Array<CustomerLoyalty>;
+export declare type CustomerLoyalties = CustomerLoyalty[];

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

@@ -1,5 +1,6 @@
 import { RequestedAt } from '../datetimes';
 import { Decimal, Money, ServiceType, TaxTypeInt, Temperature } from '../global';
+import { Cart, CartErrors } from './cart';
 export interface NutritionalInfo {
     calories: number;
     cholesterol: number;
@@ -145,6 +146,10 @@ export interface MenuVars {
     serviceType: ServiceType;
     requestedAt: RequestedAt;
 }
+export interface MenuCartErrors {
+    newCart: Cart;
+    errors: CartErrors | null;
+}
 export interface DiscountedItem {
     id: number;
     category_id: number;

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

@@ -4,6 +4,13 @@ import { CreditCard } from './creditCards';
 import { Address } from './customer';
 import { PrepStatus } from './kds';
 import { NutritionalInfo } from './menu';
+export interface OrderItemPoints {
+    applied: number;
+    available: number;
+    index?: number;
+    per: number;
+    total: number;
+}
 export interface OrderItem {
     allergens: string[];
     description: string | null;
@@ -15,7 +22,7 @@ export interface OrderItem {
     name: string;
     notes?: string | null;
     nutritional_info: NutritionalInfo | null;
-    points?: number | null;
+    points?: OrderItemPoints | null;
     price: Money;
     price_total: Money;
     quantity: number;
@@ -138,6 +145,13 @@ export interface OrderRating {
     comments: string | null;
     rating: number;
 }
+export interface OrderRating {
+    comments: string | null;
+    rating: number;
+}
+export interface OrderRatingWithOrder extends OrderRating {
+    order_id: number;
+}
 export interface OrderRevenueCenterAddress {
     city: string;
     lat: number;

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

@@ -7,7 +7,7 @@ export interface RevenueCenterParams {
     lng?: number;
     requestedAt?: string;
 }
-export declare type RevenueCenterType = 'POS' | 'OLO' | 'CATERING';
+export declare type RevenueCenterType = 'OLO' | 'CATERING';
 export interface RevenueCenterAddress {
     city: string;
     cross_streets: string;

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

@@ -354,6 +354,7 @@ export interface ThemeLink extends Record<string, string> {
     color: string;
     hover: string;
 }
+export declare type ThemeLinkType = 'customize' | 'dark' | 'light' | 'primary';
 export interface ThemeLinks extends Record<string, string | ThemeLink> {
     customize: ThemeLink;
     dark: ThemeLink;

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

@@ -15,7 +15,7 @@ export interface Input {
     autoComplete?: string;
     children?: JSX.Element;
     disabled?: boolean;
-    error?: string;
+    error?: string | null;
     icon?: JSX.Element;
     label?: string;
     max?: number;
@@ -34,7 +34,7 @@ export interface Input {
 }
 export interface Select {
     disabled?: boolean;
-    error: string;
+    error?: string | null;
     label: string;
     name: string;
     onChange?: React.ChangeEventHandler<HTMLSelectElement>;
@@ -59,7 +59,7 @@ export interface Switch {
 }
 export interface Textarea {
     disabled?: boolean;
-    error?: string;
+    error?: string | null;
     icon?: JSX.Element;
     label: string;
     name: string;

package/package.json

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