@orderingstack/ordering-types 1.23.0 → 1.24.1

package/dist/cjs/api.d.ts

@@ -1,7 +1,7 @@
 import { EOrderPaymentType, EOrderStatus, EOrderType, IProductState, IStringKeyRecord } from "./index";
 export declare const aggregators: readonly ["BOLT", "GLOVO", "JUSTEAT", "TAZZ", "UBER", "UPMENU", "WOLT", "_ANY_"];
-export declare type TAggregator = typeof aggregators[number];
-declare type TOrderDir = "DESC" | "ASC";
+export type TAggregator = typeof aggregators[number];
+type TOrderDir = "DESC" | "ASC";
 interface ApiParams {
     query?: any;
     headers?: IStringKeyRecord<string>;

package/dist/cjs/index.d.ts

@@ -39,7 +39,7 @@ export interface ILanguage {
     key: string;
     icon: any;
 }
-export declare type TStringBoolean = "true" | "false";
+export type TStringBoolean = "true" | "false";
 export declare enum EProductKind {
     GROUP = "3e/group",
     PRODUCT = "3e/product",
@@ -48,20 +48,21 @@ export declare enum EProductKind {
     CONFIG = "3e/group/config",
     STATIC = "3e/static",
     REF = "3e/ref",
-    QUERY = "3e/query"
+    QUERY = "3e/query",
+    CMS = "3e/cms"
 }
 export declare enum EProductKindBucket {
     GROUP = "group",
     PRODUCT = "product"
 }
-export declare type TLiterals = {
+export type TLiterals = {
     name: string;
     upsizeName?: string;
     fiscal?: string;
     "target-product-id"?: string;
     description?: string;
 } & IStringKeyRecord<string | undefined>;
-export declare type TMedia = {
+export type TMedia = {
     url: string;
     name: string;
 };
@@ -81,8 +82,38 @@ export interface IProductAvailability {
  * @related {string} comma separated related products IDs
  */
 export interface IProductExtra extends IStringKeyRecord<string | undefined> {
+    /**
+     * comma separated values
+     */
+    tags?: string;
+    /**
+     * stringified nutrients object
+     */
+    nutrients?: string;
     related?: string;
     category?: string;
+    "ALLOW-MULTIPLE-LINE"?: "true" | "false";
+    "rbi-reward"?: "true" | "false";
+    "rbi-offer"?: "true" | "false";
+    "rbi-rewards-cat"?: "true" | "false";
+    "rbi-offers-cat"?: "true" | "false";
+    "rbi-reward-points"?: string;
+    /**
+     * CSS column span of ui item in grid
+     */
+    viewCols?: string;
+    /**
+     *  CSS column span of ui item in grid
+     */
+    viewRows?: string;
+    /**
+     *  CSS column start of ui item in grid
+     */
+    "col-start"?: string;
+    /**
+     *  CSS row start of ui item in grid
+     */
+    "row-start"?: string;
 }
 /**
  * IProductFrontAttributes
@@ -93,11 +124,13 @@ export interface IProductExtra extends IStringKeyRecord<string | undefined> {
 export interface IProductFrontAttributes {
     isHiddenByEnableKey?: boolean;
     lineExtra?: IStringKeyRecord<string>;
+    cmsData?: any;
 }
 export interface IProduct {
     availability?: IProductAvailability;
     id: string;
     img?: string;
+    cmsId?: string;
     items?: IProduct[];
     kind: EProductKind | EProductKindBucket;
     literals?: TLiterals;
@@ -166,7 +199,7 @@ export interface IUser {
 export declare enum EOrderUserRole {
     CREATOR = "CREATOR",
     CUSTOMER = "CUSTOMER",
-    COUPON = "COUPON",
+    COUPONS = "COUPON",
     KIOSK = "KIOSK",
     WAITER = "WAITER",
     MANAGER = "MANAGER",
@@ -326,6 +359,7 @@ export interface IOrderPayment {
     user: string;
     timestamp?: string;
     extra?: IStringKeyRecord<string>;
+    deferred?: boolean;
 }
 export declare enum EOrderPaymentType {
     CASH = "CASH",
@@ -455,7 +489,7 @@ export interface ISubTotalDiscount {
     discount: number;
     vat: string;
 }
-export declare type IOrderGroupProduct = Pick<IOrderProduct, "kind" | "id" | "literals" | "items" | "extra">;
+export type IOrderGroupProduct = Pick<IOrderProduct, "kind" | "id" | "literals" | "items" | "extra">;
 export interface IOrderProduct {
     id: string;
     kind: EOrderProductKind;
@@ -465,7 +499,7 @@ export interface IOrderProduct {
     quantity: string;
     price: string;
     vat?: string;
-    extra?: IStringKeyRecord<string>;
+    extra?: IProductExtra;
 }
 export declare enum EOrderLineStatus {
     NEW = "NEW",
@@ -492,8 +526,8 @@ export declare enum EOrderProductKind {
 export interface IProductLiterals {
     [propName: string]: any;
 }
-declare type TWeekDay = "MON" | "TUE" | "WED" | "THU" | "FRI" | "SAT" | "SUN";
-export declare type TSaleChannelWeek = Partial<Record<TWeekDay, {
+type TWeekDay = "MON" | "TUE" | "WED" | "THU" | "FRI" | "SAT" | "SUN";
+export type TSaleChannelWeek = Partial<Record<TWeekDay, {
     from: string;
     to: string;
 }[]>>;
@@ -567,14 +601,14 @@ export interface IFiscalizeData {
     };
 }
 export declare const sizes: readonly [48, 57, 70, 100, 160, 250, 300, 500, 600, 900, 1000, 1920, 1080, 900];
-export declare type TMediaSize = (typeof sizes)[number];
+export type TMediaSize = (typeof sizes)[number];
 export declare enum ENotificationType {
     ORDER_EVENT_ERROR = "OrderEventError",
     ORDER_APPLIED_EVENTS = "OrderAppliedEvents",
     ORDER_EVENT_FISCAL = "OrderEventFiscal",
     ORDER_UPSELL = "OrderUpsell"
 }
-export declare type TUpsellKind = "ANY" | "POPUP" | "SIDE" | "BASKET";
+export type TUpsellKind = "ANY" | "POPUP" | "SIDE" | "BASKET";
 export interface IUpsellNotification {
     details: {
         literals?: IStringKeyRecord<string>;

package/dist/cjs/index.js

@@ -35,6 +35,7 @@ var EProductKind;
     EProductKind["STATIC"] = "3e/static";
     EProductKind["REF"] = "3e/ref";
     EProductKind["QUERY"] = "3e/query";
+    EProductKind["CMS"] = "3e/cms";
 })(EProductKind = exports.EProductKind || (exports.EProductKind = {}));
 var EProductKindBucket;
 (function (EProductKindBucket) {
@@ -45,7 +46,7 @@ var EOrderUserRole;
 (function (EOrderUserRole) {
     EOrderUserRole["CREATOR"] = "CREATOR";
     EOrderUserRole["CUSTOMER"] = "CUSTOMER";
-    EOrderUserRole["COUPON"] = "COUPON";
+    EOrderUserRole["COUPONS"] = "COUPON";
     EOrderUserRole["KIOSK"] = "KIOSK";
     EOrderUserRole["WAITER"] = "WAITER";
     EOrderUserRole["MANAGER"] = "MANAGER";

package/dist/cjs/kioskErrors.d.ts

@@ -138,7 +138,7 @@ export declare const KioskErrors: {
     x500: string;
     x501: string;
 };
-export declare type TErrorCode = keyof typeof KioskErrors;
+export type TErrorCode = keyof typeof KioskErrors;
 export interface IKioskError {
     errorType: string;
     errorCode: TErrorCode;

package/dist/cjs/src/api.d.ts

@@ -0,0 +1,97 @@
+import { EOrderPaymentType, EOrderStatus, EOrderType, IProductState, IStringKeyRecord } from "./index";
+export declare const aggregators: readonly ["GLOVO", "JUSTEAT", "UBER", "WOLT", "BOLT", "TAZZ", "_ANY_"];
+export type TAggregator = typeof aggregators[number];
+type TOrderDir = "DESC" | "ASC";
+interface ApiParams {
+    query?: any;
+    headers?: IStringKeyRecord<string>;
+    data?: any;
+}
+export interface IOrderApiGetListParams extends ApiParams {
+    query: {
+        _sort?: string;
+        _order?: TOrderDir;
+        _start?: number;
+        _end?: number;
+        id?: string;
+        extId?: string;
+        status?: EOrderStatus;
+        type?: EOrderType;
+        completed?: boolean;
+        closed?: boolean;
+        phone?: string;
+        mail?: string;
+        createdFrom?: string;
+        createdTo?: string;
+        completedFrom?: string;
+        completedTo?: string;
+        venue?: string;
+        aggregator?: TAggregator;
+        payment?: EOrderPaymentType;
+    };
+    headers: {
+        "x-tenant"?: string;
+    };
+}
+interface IDiscount {
+    /**
+     * Discount layer. It is used to distinguish discounts from loyalty, manual discounts, etc.
+     * @pattern [a-zA-Z0-9_.-]+
+     */
+    layer: string;
+    /**
+     * Name that describes this discount
+     * @minLength 0
+     * @maxLength 128
+     */
+    name?: string;
+    /** Discount price (subtracted from line total) */
+    discountPrice: number;
+    /** Extra params */
+    extra?: IStringKeyRecord<string>;
+    type: string;
+}
+interface ILineDiscount {
+    /** Applied discounts */
+    discount: IDiscount;
+    /** @format date-time */
+    expires?: string;
+    /**
+     * @minLength 0
+     * @maxLength 128
+     * @pattern [a-zA-Z0-9_. -]+
+     */
+    sign: string;
+}
+export interface IAppendedLine {
+    /**
+     * @format int32
+     * @min 1
+     * @max 100000
+     */
+    quantity: number;
+    /**
+     * One should not provide price - it will be automatically calculated. If user is privileged (internal system user or has role 'SU' or 'ALTERPRICE') OrderingStack will use provided price and override one from menu. Please be careful when providing value '0' as privileged user here! If you do not want to override price - do not provide 'price' attribute at all (null).
+     * @min 0
+     * @exclusiveMin false
+     */
+    price?: number;
+    /** @pattern [a-zA-Z0-9_.-]+ */
+    productId: string;
+    /** Configuration of product */
+    productConfig?: IProductState;
+    /** @default "NEW" */
+    status: "NEW" | "CONFIRMED";
+    /**
+     * @minLength 0
+     * @maxLength 255
+     */
+    comment?: string;
+    /**
+     * @maxItems 10
+     * @minItems 0
+     */
+    discounts?: ILineDiscount[];
+    extra?: IStringKeyRecord<string>;
+}
+export {};

package/dist/cjs/src/api.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.aggregators = void 0;
+exports.aggregators = [
+    "GLOVO",
+    "JUSTEAT",
+    "UBER",
+    "WOLT",
+    "BOLT",
+    "TAZZ",
+    "_ANY_",
+];