@open-tender/types 0.4.59 → 0.4.61

package/LICENSE.md

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2020 Open Tender Inc.
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2020 Open Tender Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,3 @@
-# Open Tender Types
-
+# Open Tender Types
+
 A library of types for use with Open Tender applications that utilize our cloud-based Order API.

package/dist/cjs/index.d.ts

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

package/dist/cjs/index.js

@@ -1,4 +1,4 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-tslib_1.__exportStar(require("./types"), exports);
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./types"), exports);

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

@@ -1,5 +1,5 @@
-export interface Alert {
-    message: string;
-    id: string;
-}
-export declare type Alerts = Alert[];
+export interface Alert {
+    message: string;
+    id: string;
+}
+export declare type Alerts = Alert[];

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

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

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

@@ -1,13 +1,13 @@
-import { Images } from '../global';
-export interface Allergen {
-    allergen_id: number;
-    description: string | null;
-    images: Images | null;
-    name: string;
-}
-export declare type Allergens = Allergen[];
-export declare type AllergenLookup = Record<string, Allergen>;
-export interface AllergenEnhanced extends Allergen {
-    imageUrl: string;
-}
-export declare type AllergenLookupEnhanced = Record<string, AllergenEnhanced>;
+import { Images } from '../global';
+export interface Allergen {
+    allergen_id: number;
+    description: string | null;
+    images: Images | null;
+    name: string;
+}
+export declare type Allergens = Allergen[];
+export declare type AllergenLookup = Record<string, Allergen>;
+export interface AllergenEnhanced extends Allergen {
+    imageUrl: string;
+}
+export declare type AllergenLookupEnhanced = Record<string, AllergenEnhanced>;

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

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

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

@@ -1,57 +1,57 @@
-export interface ContentImage {
-    type: 'SECONDARY_IMAGE' | 'FEATURED_IMAGE';
-    url: string | null;
-}
-export declare type ContentImages = ContentImage[];
-export declare type AnnouncementVertical = 'TOP' | 'BOTTOM' | 'CENTER';
-export declare type AnnouncementHorizontal = 'LEFT' | 'RIGHT' | 'CENTER';
-export interface Announcement {
-    announcement_id: number;
-    display_order: number;
-    hide_text: boolean;
-    hide_text_mobile: boolean;
-    horizontal: AnnouncementHorizontal;
-    images: ContentImages;
-    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: AnnouncementVertical;
-    imageUrl?: string | null;
-}
-export declare type AnnouncementPageType = 'ABOUT' | 'ACCOUNT' | 'CATERING' | 'CHECKOUT' | 'GUEST' | 'HOME' | 'MENU' | 'ORDER_TYPE';
-export interface AnnouncementSettings {
-    announcement_page_id: number;
-    arrows_horizontal: string;
-    arrows_vertical: string;
-    autoplay: boolean;
-    duration: number;
-    duration_mobile: number;
-    hide_text: boolean;
-    hide_text_mobile: boolean;
-    page: AnnouncementPageType;
-    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 = Announcement[];
-export interface AnnouncementPage {
-    entities: Announcements;
-    page: AnnouncementPageType;
-    settings: AnnouncementSettings;
-}
-export declare type AnnouncementPages = AnnouncementPage[];
+export interface ContentImage {
+    type: 'SECONDARY_IMAGE' | 'FEATURED_IMAGE';
+    url: string | null;
+}
+export declare type ContentImages = ContentImage[];
+export declare type AnnouncementVertical = 'TOP' | 'BOTTOM' | 'CENTER';
+export declare type AnnouncementHorizontal = 'LEFT' | 'RIGHT' | 'CENTER';
+export interface Announcement {
+    announcement_id: number;
+    display_order: number;
+    hide_text: boolean;
+    hide_text_mobile: boolean;
+    horizontal: AnnouncementHorizontal;
+    images: ContentImages;
+    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: AnnouncementVertical;
+    imageUrl?: string | null;
+}
+export declare type AnnouncementPageType = 'ABOUT' | 'ACCOUNT' | 'CATERING' | 'CHECKOUT' | 'GUEST' | 'HOME' | 'MENU' | 'ORDER_TYPE';
+export interface AnnouncementSettings {
+    announcement_page_id: number;
+    arrows_horizontal: string;
+    arrows_vertical: string;
+    autoplay: boolean;
+    duration: number;
+    duration_mobile: number;
+    hide_text: boolean;
+    hide_text_mobile: boolean;
+    page: AnnouncementPageType;
+    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 = Announcement[];
+export interface AnnouncementPage {
+    entities: Announcements;
+    page: AnnouncementPageType;
+    settings: AnnouncementSettings;
+}
+export declare type AnnouncementPages = AnnouncementPage[];

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

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

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

@@ -1,14 +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>;
+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/cjs/types/api/arrivals.js

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

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

@@ -1,106 +1,106 @@
-import { MenuItemAllergens, MenuItemTags, 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[];
-    allergens_list?: MenuItemAllergens;
-    cals: number | null;
-    description: string | null;
-    groups: CartItemGroups;
-    id: number;
-    imageUrl: string | null;
-    increment: number;
-    ingredients: string | null;
-    isDefault: boolean;
-    isSoldOut: boolean;
-    max: number;
-    min: number;
-    name: string;
-    nutritionalInfo: NutritionalInfo | null;
-    points: number | null;
-    price: number;
-    quantity: number;
-    shorthand: string | null;
-    shortDescription: string | null;
-    shortName: string;
-    slug: string;
-    tags: string[];
-    tags_list?: MenuItemTags;
-    totalAllergens: string[];
-    totalCals: number | null;
-    totalPoints: number | null;
-    totalPrice: number | null;
-}
-export declare type CartItemOptions = CartItemOption[];
-export interface CartItemOptionWithGroup extends CartItemOption {
-    group: CartItemGroup;
-}
-export declare type CartItemOptionsWithGroup = CartItemOptionWithGroup[];
-export interface CartItemOptionWithIndex extends CartItemOption {
-    index: number;
-}
-export interface CartItem extends Omit<CartItemOption, 'isDefault'> {
-    cartGuestId: number | null;
-    customerId: number | null;
-    index?: number;
-    madeFor: string | null;
-    notes: string | null;
-    signature?: string;
-    similarItems: number[];
-    upsellItems: number[];
-}
-export interface CartItemWithPoints extends Omit<CartItem, 'points'> {
-    points: OrderItemPoints | null;
-}
-export declare type CartWithPoints = CartItemWithPoints[];
-export interface CartItemGroup {
-    description: string | null;
-    id: number;
-    imageUrl: string | null;
-    included: number;
-    isPizza: boolean;
-    isSize: boolean;
-    max: number;
-    min: number;
-    name: string;
-    options: CartItemOptions;
-    quantity: number;
-}
-export declare type CartItemGroups = CartItemGroup[];
-export declare type Cart = CartItem[];
-export declare type CartLevels = number[][];
-export declare type CartCounts = Record<string, number>;
-export declare type CartItemOptionLookup = Record<string, CartItemOption>;
-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;
-}
-export declare type PosCart = PosCartItem[];
+import { MenuItemAllergens, MenuItemTags, 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[];
+    allergens_list?: MenuItemAllergens;
+    cals: number | null;
+    description: string | null;
+    groups: CartItemGroups;
+    id: number;
+    imageUrl: string | null;
+    increment: number;
+    ingredients: string | null;
+    isDefault: boolean;
+    isSoldOut: boolean;
+    max: number;
+    min: number;
+    name: string;
+    nutritionalInfo: NutritionalInfo | null;
+    points: number | null;
+    price: number;
+    quantity: number;
+    shorthand: string | null;
+    shortDescription: string | null;
+    shortName: string;
+    slug: string;
+    tags: string[];
+    tags_list?: MenuItemTags;
+    totalAllergens: string[];
+    totalCals: number | null;
+    totalPoints: number | null;
+    totalPrice: number | null;
+}
+export declare type CartItemOptions = CartItemOption[];
+export interface CartItemOptionWithGroup extends CartItemOption {
+    group: CartItemGroup;
+}
+export declare type CartItemOptionsWithGroup = CartItemOptionWithGroup[];
+export interface CartItemOptionWithIndex extends CartItemOption {
+    index: number;
+}
+export interface CartItem extends Omit<CartItemOption, 'isDefault'> {
+    cartGuestId: number | null;
+    customerId: number | null;
+    index?: number;
+    madeFor: string | null;
+    notes: string | null;
+    signature?: string;
+    similarItems: number[];
+    upsellItems: number[];
+}
+export interface CartItemWithPoints extends Omit<CartItem, 'points'> {
+    points: OrderItemPoints | null;
+}
+export declare type CartWithPoints = CartItemWithPoints[];
+export interface CartItemGroup {
+    description: string | null;
+    id: number;
+    imageUrl: string | null;
+    included: number;
+    isPizza: boolean;
+    isSize: boolean;
+    max: number;
+    min: number;
+    name: string;
+    options: CartItemOptions;
+    quantity: number;
+}
+export declare type CartItemGroups = CartItemGroup[];
+export declare type Cart = CartItem[];
+export declare type CartLevels = number[][];
+export declare type CartCounts = Record<string, number>;
+export declare type CartItemOptionLookup = Record<string, CartItemOption>;
+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;
+}
+export declare type PosCart = PosCartItem[];

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

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