@orderingstack/ordering-types 1.0.17 → 1.1.0

package/dist/cjs/index.d.ts

@@ -1,5 +1,5 @@
 export * from "./kiosk";
-export interface Restaurant {
+export interface IRestaurant {
     id: string;
     name: string;
     geoPosition: IGeoPosition;
@@ -36,7 +36,7 @@ export interface ILanguage {
     key: string;
     icon: any;
 }
-export type StringBoolean = "true" | "false";
+export type TStringBoolean = "true" | "false";
 export declare enum EProductKind {
     GROUP = "3e/group",
     PRODUCT = "3e/product",
@@ -70,6 +70,16 @@ export interface IProductAvailability {
     SAT?: [string, string];
     SUN?: [string, string];
 }
+/**
+ * IProductExtra interface
+ *
+ * @interface IProductExtra
+ * @related {string} comma separated related products IDs
+ */
+export interface IProductExtra extends Partial<Record<string, string>> {
+    related?: string;
+    category?: string;
+}
 export interface IProduct {
     availability?: IProductAvailability;
     id: string;
@@ -93,7 +103,7 @@ export interface IProduct {
     emit?: IProductEmit;
     qtyMin?: string;
     qtyMax?: string;
-    _?: Record<string, string>;
+    _?: IProductExtra;
     bom?: Record<string, {
         unit: string;
         qty: string;
@@ -120,16 +130,13 @@ export interface IProductEmit {
 export interface IProductFilter {
     [fltCtx: string]: string[];
 }
-export interface Extra {
-    [propName: string]: any;
-}
-export interface User {
+export interface IUser {
     userId: string;
     roles: string[];
     name?: string;
     phone?: string;
     email?: string;
-    extra?: Extra;
+    extra?: Record<string, string>;
 }
 export declare enum EOrderType {
     TAKE_AWAY = "TAKE_AWAY",
@@ -149,7 +156,7 @@ export declare enum EOrderType {
     WOLT_TAKE_AWAY = "WOLT_TAKE_AWAY",
     WOLT_DINE_IN = "WOLT_DINE_IN"
 }
-export interface OrderDeliveryAddress {
+export interface IOrderDeliveryAddress {
     street: string;
     number: string;
     door?: string;
@@ -170,11 +177,11 @@ export interface IOrder {
     processingStartedTime?: string;
     deliveredTime?: string;
     source: string;
-    users?: User[];
+    users?: IUser[];
     loyaltyId?: string;
     coupons?: IOrderCoupon[];
     orderType: EOrderType;
-    deliveryAddress?: OrderDeliveryAddress;
+    deliveryAddress?: IOrderDeliveryAddress;
     geoPosition?: {
         lat: number;
         lng: number;
@@ -183,10 +190,10 @@ export interface IOrder {
     editTotal: string;
     status: EOrderStatus;
     statusInfo?: string;
-    comments?: OrderComment[];
+    comments?: IOrderComment[];
     claimCode?: string;
     buckets: IOrderInBucket[];
-    payments?: OrderPayment[];
+    payments?: IOrderPayment[];
     fiscal?: IOrderFiscal[];
     tax: ITaxSummary[];
     extra?: IOrderExtra;
@@ -223,12 +230,12 @@ export declare enum EOrderStatus {
     CANCELLED = "CANCELLED",
     PICKED = "PICKED"
 }
-export interface OrderComment {
+export interface IOrderComment {
     id: string;
     creator: string;
     timestamp?: string;
     comment: string;
-    extra?: Extra;
+    extra?: Record<string, string>;
 }
 export interface IOrderInBucket {
     venue: string;
@@ -240,7 +247,7 @@ export interface IOrderInBucket {
     priceList?: string;
     warehouse?: string;
     queuePos?: string;
-    extra?: Extra;
+    extra?: Record<string, string>;
 }
 export interface IOrderPayment {
     id: string;
@@ -250,7 +257,7 @@ export interface IOrderPayment {
     initialAmount?: number;
     user: string;
     timestamp?: string;
-    extra?: Extra;
+    extra?: Record<string, string>;
 }
 export declare enum EOrderPaymentType {
     CASH = "CASH",
@@ -264,16 +271,6 @@ export declare enum EOrderPaymentType {
     RETURN = "RETURN",
     EXTERNAL = "EXTERNAL"
 }
-export interface OrderPayment {
-    id: string;
-    type: EOrderPaymentType;
-    source: string;
-    amount: number;
-    initialAmount?: number;
-    user: string;
-    timestamp?: string;
-    extra?: Extra;
-}
 export interface IOrderFiscal {
     timestamp: string;
     user?: string;
@@ -283,11 +280,11 @@ export interface IOrderFiscal {
     slip: string;
     taxId?: string;
     message?: string;
-    entries: SlipEntry[];
+    entries: ISlipEntry[];
     payments?: {
         [propName: string]: number;
     };
-    subTotalDiscounts?: SubTotalDiscount[];
+    subTotalDiscounts?: ISubTotalDiscount[];
     extra: {
         [propName: string]: number;
     };
@@ -314,8 +311,8 @@ export interface ITaxSummary {
  * @x-agg-id {string} order ID from aggregator
  * @support-order-id {string} order code from aggregator to be used with support and same as seen by customer,
  */
-export interface IOrderExtra {
-    "x-source"?: OrderSource;
+export interface IOrderExtra extends Partial<Record<string, string>> {
+    "x-source"?: EOrderSource;
     "x-source-type"?: "INTEGRATOR";
     "manual-verify"?: string;
     "x-collect-time"?: string;
@@ -328,6 +325,7 @@ export interface IOrderExtra {
     "x-agg-id"?: string;
     "support-order-id"?: string;
     "x-pos-id"?: string;
+    "company-tax-id"?: string;
 }
 export interface IOrderLog {
     timestamp?: string;
@@ -338,11 +336,11 @@ export interface IOrderLog {
 }
 export interface IOrderLine {
     bom?: Object;
-    comments?: OrderComment[];
+    comments?: IOrderComment[];
     created: string;
     creator?: string;
     discounts?: IDiscount[];
-    extra: Extra;
+    extra: Record<string, string>;
     hash: string;
     id: string;
     price: string;
@@ -355,7 +353,7 @@ export interface IOrderLine {
     total: string;
     updated: string;
 }
-export interface SlipEntry {
+export interface ISlipEntry {
     item: string;
     qty: number;
     price: number;
@@ -363,12 +361,12 @@ export interface SlipEntry {
     total: number;
     vat: string;
 }
-export interface SubTotalDiscount {
+export interface ISubTotalDiscount {
     name: string;
     discount: number;
     vat: string;
 }
-export declare enum OrderSource {
+export declare enum EOrderSource {
     KIOSK = "KIOSK",
     WEB = "WEB",
     JUST_EAT_TAKE_AWAY = "JUSTEATTAKEAWAY",
@@ -386,7 +384,7 @@ export interface IOrderProduct {
     img: string;
     quantity: string;
     price: string;
-    extra: Extra;
+    extra: Record<string, string>;
 }
 export declare enum EOrderLineStatus {
     NEW = "NEW",
@@ -418,7 +416,7 @@ export type TSaleChannelWeek = Partial<Record<TWeekDay, {
     from: string;
     to: string;
 }[]>>;
-export interface SaleChannel {
+export interface ISaleChannel {
     active?: boolean;
     minDeliveryTime?: string;
     minOrderValue?: string;
@@ -443,7 +441,7 @@ export interface IVenueConfig {
         postal: string;
         street: string;
     };
-    channelConstraints: Partial<Record<EChannelName, SaleChannel>>;
+    channelConstraints: Partial<Record<EChannelName, ISaleChannel>>;
     device: Record<string, Record<string, string>>;
     extra: Record<string, string>;
     geoPosition: IGeoPosition;

package/dist/cjs/index.js

@@ -14,7 +14,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.EChannelName = exports.EOrderProductKind = exports.EOrderLineStatus = exports.OrderSource = exports.EOrderPaymentType = exports.EOrderStatus = exports.EOrderType = exports.EProductKindBucket = exports.EProductKind = exports.ECouponViewType = void 0;
+exports.EChannelName = exports.EOrderProductKind = exports.EOrderLineStatus = exports.EOrderSource = exports.EOrderPaymentType = exports.EOrderStatus = exports.EOrderType = exports.EProductKindBucket = exports.EProductKind = exports.ECouponViewType = void 0;
 __exportStar(require("./kiosk"), exports);
 var ECouponViewType;
 (function (ECouponViewType) {
@@ -82,17 +82,17 @@ var EOrderPaymentType;
     EOrderPaymentType["RETURN"] = "RETURN";
     EOrderPaymentType["EXTERNAL"] = "EXTERNAL";
 })(EOrderPaymentType = exports.EOrderPaymentType || (exports.EOrderPaymentType = {}));
-var OrderSource;
-(function (OrderSource) {
-    OrderSource["KIOSK"] = "KIOSK";
-    OrderSource["WEB"] = "WEB";
-    OrderSource["JUST_EAT_TAKE_AWAY"] = "JUSTEATTAKEAWAY";
-    OrderSource["GLOVO"] = "GLOVO";
-    OrderSource["PYSZNE"] = "PYSZNE";
-    OrderSource["WOLT"] = "WOLT";
-    OrderSource["UBER"] = "UBER";
-    OrderSource["BOLT"] = "BOLT";
-})(OrderSource = exports.OrderSource || (exports.OrderSource = {}));
+var EOrderSource;
+(function (EOrderSource) {
+    EOrderSource["KIOSK"] = "KIOSK";
+    EOrderSource["WEB"] = "WEB";
+    EOrderSource["JUST_EAT_TAKE_AWAY"] = "JUSTEATTAKEAWAY";
+    EOrderSource["GLOVO"] = "GLOVO";
+    EOrderSource["PYSZNE"] = "PYSZNE";
+    EOrderSource["WOLT"] = "WOLT";
+    EOrderSource["UBER"] = "UBER";
+    EOrderSource["BOLT"] = "BOLT";
+})(EOrderSource = exports.EOrderSource || (exports.EOrderSource = {}));
 var EOrderLineStatus;
 (function (EOrderLineStatus) {
     EOrderLineStatus["NEW"] = "NEW";

package/dist/cjs/kiosk.d.ts

@@ -89,6 +89,13 @@ export interface IMenuBottomNavProps {
     fallbackImg?: string;
     changeQuantity: (line: IOrderLine, quantity: number) => void;
 }
+export interface IMenuUpsizeProps {
+    show: boolean;
+    onClose: () => void;
+    products?: IProduct[];
+    onProductClicked: (prod: IProduct) => void;
+    currency: string;
+}
 export interface IMenuComponents {
     TopNav?: React.FC<IMenuTopNavProps>;
     BottomNav?: React.FC<IMenuBottomNavProps>;
@@ -96,6 +103,7 @@ export interface IMenuComponents {
     CategorySection?: React.FC<IMenuCategorySectionProps>;
     Header?: ReactElement;
     Logo?: ReactElement;
+    Upsize?: React.FC<IMenuUpsizeProps>;
 }
 export interface IProductConfiguratorProps {
     product: IProduct;

package/dist/esm/index.d.ts

@@ -1,5 +1,5 @@
 export * from "./kiosk";
-export interface Restaurant {
+export interface IRestaurant {
     id: string;
     name: string;
     geoPosition: IGeoPosition;
@@ -36,7 +36,7 @@ export interface ILanguage {
     key: string;
     icon: any;
 }
-export type StringBoolean = "true" | "false";
+export type TStringBoolean = "true" | "false";
 export declare enum EProductKind {
     GROUP = "3e/group",
     PRODUCT = "3e/product",
@@ -70,6 +70,16 @@ export interface IProductAvailability {
     SAT?: [string, string];
     SUN?: [string, string];
 }
+/**
+ * IProductExtra interface
+ *
+ * @interface IProductExtra
+ * @related {string} comma separated related products IDs
+ */
+export interface IProductExtra extends Partial<Record<string, string>> {
+    related?: string;
+    category?: string;
+}
 export interface IProduct {
     availability?: IProductAvailability;
     id: string;
@@ -93,7 +103,7 @@ export interface IProduct {
     emit?: IProductEmit;
     qtyMin?: string;
     qtyMax?: string;
-    _?: Record<string, string>;
+    _?: IProductExtra;
     bom?: Record<string, {
         unit: string;
         qty: string;
@@ -120,16 +130,13 @@ export interface IProductEmit {
 export interface IProductFilter {
     [fltCtx: string]: string[];
 }
-export interface Extra {
-    [propName: string]: any;
-}
-export interface User {
+export interface IUser {
     userId: string;
     roles: string[];
     name?: string;
     phone?: string;
     email?: string;
-    extra?: Extra;
+    extra?: Record<string, string>;
 }
 export declare enum EOrderType {
     TAKE_AWAY = "TAKE_AWAY",
@@ -149,7 +156,7 @@ export declare enum EOrderType {
     WOLT_TAKE_AWAY = "WOLT_TAKE_AWAY",
     WOLT_DINE_IN = "WOLT_DINE_IN"
 }
-export interface OrderDeliveryAddress {
+export interface IOrderDeliveryAddress {
     street: string;
     number: string;
     door?: string;
@@ -170,11 +177,11 @@ export interface IOrder {
     processingStartedTime?: string;
     deliveredTime?: string;
     source: string;
-    users?: User[];
+    users?: IUser[];
     loyaltyId?: string;
     coupons?: IOrderCoupon[];
     orderType: EOrderType;
-    deliveryAddress?: OrderDeliveryAddress;
+    deliveryAddress?: IOrderDeliveryAddress;
     geoPosition?: {
         lat: number;
         lng: number;
@@ -183,10 +190,10 @@ export interface IOrder {
     editTotal: string;
     status: EOrderStatus;
     statusInfo?: string;
-    comments?: OrderComment[];
+    comments?: IOrderComment[];
     claimCode?: string;
     buckets: IOrderInBucket[];
-    payments?: OrderPayment[];
+    payments?: IOrderPayment[];
     fiscal?: IOrderFiscal[];
     tax: ITaxSummary[];
     extra?: IOrderExtra;
@@ -223,12 +230,12 @@ export declare enum EOrderStatus {
     CANCELLED = "CANCELLED",
     PICKED = "PICKED"
 }
-export interface OrderComment {
+export interface IOrderComment {
     id: string;
     creator: string;
     timestamp?: string;
     comment: string;
-    extra?: Extra;
+    extra?: Record<string, string>;
 }
 export interface IOrderInBucket {
     venue: string;
@@ -240,7 +247,7 @@ export interface IOrderInBucket {
     priceList?: string;
     warehouse?: string;
     queuePos?: string;
-    extra?: Extra;
+    extra?: Record<string, string>;
 }
 export interface IOrderPayment {
     id: string;
@@ -250,7 +257,7 @@ export interface IOrderPayment {
     initialAmount?: number;
     user: string;
     timestamp?: string;
-    extra?: Extra;
+    extra?: Record<string, string>;
 }
 export declare enum EOrderPaymentType {
     CASH = "CASH",
@@ -264,16 +271,6 @@ export declare enum EOrderPaymentType {
     RETURN = "RETURN",
     EXTERNAL = "EXTERNAL"
 }
-export interface OrderPayment {
-    id: string;
-    type: EOrderPaymentType;
-    source: string;
-    amount: number;
-    initialAmount?: number;
-    user: string;
-    timestamp?: string;
-    extra?: Extra;
-}
 export interface IOrderFiscal {
     timestamp: string;
     user?: string;
@@ -283,11 +280,11 @@ export interface IOrderFiscal {
     slip: string;
     taxId?: string;
     message?: string;
-    entries: SlipEntry[];
+    entries: ISlipEntry[];
     payments?: {
         [propName: string]: number;
     };
-    subTotalDiscounts?: SubTotalDiscount[];
+    subTotalDiscounts?: ISubTotalDiscount[];
     extra: {
         [propName: string]: number;
     };
@@ -314,8 +311,8 @@ export interface ITaxSummary {
  * @x-agg-id {string} order ID from aggregator
  * @support-order-id {string} order code from aggregator to be used with support and same as seen by customer,
  */
-export interface IOrderExtra {
-    "x-source"?: OrderSource;
+export interface IOrderExtra extends Partial<Record<string, string>> {
+    "x-source"?: EOrderSource;
     "x-source-type"?: "INTEGRATOR";
     "manual-verify"?: string;
     "x-collect-time"?: string;
@@ -328,6 +325,7 @@ export interface IOrderExtra {
     "x-agg-id"?: string;
     "support-order-id"?: string;
     "x-pos-id"?: string;
+    "company-tax-id"?: string;
 }
 export interface IOrderLog {
     timestamp?: string;
@@ -338,11 +336,11 @@ export interface IOrderLog {
 }
 export interface IOrderLine {
     bom?: Object;
-    comments?: OrderComment[];
+    comments?: IOrderComment[];
     created: string;
     creator?: string;
     discounts?: IDiscount[];
-    extra: Extra;
+    extra: Record<string, string>;
     hash: string;
     id: string;
     price: string;
@@ -355,7 +353,7 @@ export interface IOrderLine {
     total: string;
     updated: string;
 }
-export interface SlipEntry {
+export interface ISlipEntry {
     item: string;
     qty: number;
     price: number;
@@ -363,12 +361,12 @@ export interface SlipEntry {
     total: number;
     vat: string;
 }
-export interface SubTotalDiscount {
+export interface ISubTotalDiscount {
     name: string;
     discount: number;
     vat: string;
 }
-export declare enum OrderSource {
+export declare enum EOrderSource {
     KIOSK = "KIOSK",
     WEB = "WEB",
     JUST_EAT_TAKE_AWAY = "JUSTEATTAKEAWAY",
@@ -386,7 +384,7 @@ export interface IOrderProduct {
     img: string;
     quantity: string;
     price: string;
-    extra: Extra;
+    extra: Record<string, string>;
 }
 export declare enum EOrderLineStatus {
     NEW = "NEW",
@@ -418,7 +416,7 @@ export type TSaleChannelWeek = Partial<Record<TWeekDay, {
     from: string;
     to: string;
 }[]>>;
-export interface SaleChannel {
+export interface ISaleChannel {
     active?: boolean;
     minDeliveryTime?: string;
     minOrderValue?: string;
@@ -443,7 +441,7 @@ export interface IVenueConfig {
         postal: string;
         street: string;
     };
-    channelConstraints: Partial<Record<EChannelName, SaleChannel>>;
+    channelConstraints: Partial<Record<EChannelName, ISaleChannel>>;
     device: Record<string, Record<string, string>>;
     extra: Record<string, string>;
     geoPosition: IGeoPosition;

package/dist/esm/index.js

@@ -65,17 +65,17 @@ export var EOrderPaymentType;
     EOrderPaymentType["RETURN"] = "RETURN";
     EOrderPaymentType["EXTERNAL"] = "EXTERNAL";
 })(EOrderPaymentType || (EOrderPaymentType = {}));
-export var OrderSource;
-(function (OrderSource) {
-    OrderSource["KIOSK"] = "KIOSK";
-    OrderSource["WEB"] = "WEB";
-    OrderSource["JUST_EAT_TAKE_AWAY"] = "JUSTEATTAKEAWAY";
-    OrderSource["GLOVO"] = "GLOVO";
-    OrderSource["PYSZNE"] = "PYSZNE";
-    OrderSource["WOLT"] = "WOLT";
-    OrderSource["UBER"] = "UBER";
-    OrderSource["BOLT"] = "BOLT";
-})(OrderSource || (OrderSource = {}));
+export var EOrderSource;
+(function (EOrderSource) {
+    EOrderSource["KIOSK"] = "KIOSK";
+    EOrderSource["WEB"] = "WEB";
+    EOrderSource["JUST_EAT_TAKE_AWAY"] = "JUSTEATTAKEAWAY";
+    EOrderSource["GLOVO"] = "GLOVO";
+    EOrderSource["PYSZNE"] = "PYSZNE";
+    EOrderSource["WOLT"] = "WOLT";
+    EOrderSource["UBER"] = "UBER";
+    EOrderSource["BOLT"] = "BOLT";
+})(EOrderSource || (EOrderSource = {}));
 export var EOrderLineStatus;
 (function (EOrderLineStatus) {
     EOrderLineStatus["NEW"] = "NEW";

package/dist/esm/kiosk.d.ts

@@ -89,6 +89,13 @@ export interface IMenuBottomNavProps {
     fallbackImg?: string;
     changeQuantity: (line: IOrderLine, quantity: number) => void;
 }
+export interface IMenuUpsizeProps {
+    show: boolean;
+    onClose: () => void;
+    products?: IProduct[];
+    onProductClicked: (prod: IProduct) => void;
+    currency: string;
+}
 export interface IMenuComponents {
     TopNav?: React.FC<IMenuTopNavProps>;
     BottomNav?: React.FC<IMenuBottomNavProps>;
@@ -96,6 +103,7 @@ export interface IMenuComponents {
     CategorySection?: React.FC<IMenuCategorySectionProps>;
     Header?: ReactElement;
     Logo?: ReactElement;
+    Upsize?: React.FC<IMenuUpsizeProps>;
 }
 export interface IProductConfiguratorProps {
     product: IProduct;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@orderingstack/ordering-types",
-  "version": "1.0.17",
+  "version": "1.1.0",
   "description": "Typescript types for @orderingstack",
   "types": "dist/esm/index.d.ts",
   "main": "dist/cjs/index.js",