@orderingstack/ordering-types 1.29.0 → 1.30.0

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 type TAggregator = typeof aggregators[number];
-type TOrderDir = "DESC" | "ASC";
+export declare type TAggregator = typeof aggregators[number];
+declare 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 type TStringBoolean = "true" | "false";
+export declare type TStringBoolean = "true" | "false";
 export declare enum EProductKind {
     GROUP = "3e/group",
     PRODUCT = "3e/product",
@@ -55,18 +55,18 @@ export declare enum EProductKindBucket {
     GROUP = "group",
     PRODUCT = "product"
 }
-export type TLiterals = {
+export declare type TLiterals = {
     name: string;
     upsizeName?: string;
     fiscal?: string;
     "target-product-id"?: string;
     description?: string;
 } & IStringKeyRecord<string | undefined>;
-export type TMedia = {
+export declare type TMedia = {
     url: string;
     name: string;
 };
-type TDetails = {
+declare type TDetails = {
     literals?: TLiterals;
     media?: TMedia[];
 };
@@ -173,7 +173,7 @@ export interface IMenuCategory extends Pick<IMenuItem, "id" | "kind" | "_" | "__
 export interface IMenuProduct extends IMenuItem {
     kind: EProductKind.PRODUCT;
 }
-export type MenuProduct = IMenuCategory | ICmsReference | IStatic | IGroupConfig | IGroupOptions | IMenuProduct;
+export declare type MenuProduct = IMenuCategory | ICmsReference | IStatic | IGroupConfig | IGroupOptions | IMenuProduct;
 /**
  * IProductFrontAttributes
  *
@@ -377,6 +377,7 @@ export interface IOrderCoupon {
         categoryId?: string;
         productId?: string;
         enableKey?: string | string[];
+        couponKey?: string;
         userId?: string;
         extra?: IStringKeyRecord<string>;
     };
@@ -550,7 +551,7 @@ export interface ISubTotalDiscount {
     discount: number;
     vat: string;
 }
-export type IOrderGroupProduct = Pick<IOrderProduct, "kind" | "id" | "literals" | "items" | "extra">;
+export declare type IOrderGroupProduct = Pick<IOrderProduct, "kind" | "id" | "literals" | "items" | "extra">;
 export interface IOrderProduct {
     id: string;
     kind: EOrderProductKind;
@@ -587,8 +588,8 @@ export declare enum EOrderProductKind {
 export interface IProductLiterals {
     [propName: string]: any;
 }
-type TWeekDay = "MON" | "TUE" | "WED" | "THU" | "FRI" | "SAT" | "SUN";
-export type TSaleChannelWeek = Partial<Record<TWeekDay, {
+declare type TWeekDay = "MON" | "TUE" | "WED" | "THU" | "FRI" | "SAT" | "SUN";
+export declare type TSaleChannelWeek = Partial<Record<TWeekDay, {
     from: string;
     to: string;
 }[]>>;
@@ -662,7 +663,7 @@ export interface IFiscalizeData {
     };
 }
 export declare const sizes: readonly [48, 57, 70, 100, 160, 250, 300, 500, 600, 900, 1000, 1920, 1080, 900];
-export type TMediaSize = (typeof sizes)[number];
+export declare type TMediaSize = (typeof sizes)[number];
 export declare enum ENotificationType {
     ORDER_MESSAGE = "OrderMessage",
     ORDER_EVENT_ERROR = "OrderEventError",
@@ -670,7 +671,7 @@ export declare enum ENotificationType {
     ORDER_EVENT_FISCAL = "OrderEventFiscal",
     ORDER_UPSELL = "OrderUpsell"
 }
-export type TUpsellKind = "ANY" | "POPUP" | "SIDE" | "BASKET";
+export declare type TUpsellKind = "ANY" | "POPUP" | "SIDE" | "BASKET";
 export interface IUpsellNotification {
     details: {
         literals?: IStringKeyRecord<string>;
@@ -723,7 +724,7 @@ export interface ISteeringCommand {
     properties?: Record<string, string>;
 }
 export declare const modules: readonly ["POS_INTEGRATOR", "KIOSK", "BI_CONNECTOR", "AGGREGATOR", "KDS", "STATUS_SCREEN", "LOYALTY_INTEGRATOR", "LOYALTY", "MOBILE_APP_LOYALTY", "ORDERING_WEB", "DELIVERY_PANEL"];
-export type TModuleType = (typeof modules)[number];
+export declare type TModuleType = (typeof modules)[number];
 export interface IModule {
     id: string;
     type: TModuleType;
@@ -745,7 +746,7 @@ export interface IModuleCommonConfig {
         [key: string]: string;
     };
 }
-export type ISODateTimeString = `${number}-${number}-${number}T${number}:${number}:${number}Z`;
+export declare type ISODateTimeString = `${number}-${number}-${number}T${number}:${number}:${number}Z`;
 export interface IUserData {
     active: boolean;
     authStrategies: any[];

package/dist/cjs/kioskErrors.d.ts

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

package/dist/esm/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 type TAggregator = typeof aggregators[number];
-type TOrderDir = "DESC" | "ASC";
+export declare type TAggregator = typeof aggregators[number];
+declare type TOrderDir = "DESC" | "ASC";
 interface ApiParams {
     query?: any;
     headers?: IStringKeyRecord<string>;

package/dist/esm/index.d.ts

@@ -39,7 +39,7 @@ export interface ILanguage {
     key: string;
     icon: any;
 }
-export type TStringBoolean = "true" | "false";
+export declare type TStringBoolean = "true" | "false";
 export declare enum EProductKind {
     GROUP = "3e/group",
     PRODUCT = "3e/product",
@@ -55,18 +55,18 @@ export declare enum EProductKindBucket {
     GROUP = "group",
     PRODUCT = "product"
 }
-export type TLiterals = {
+export declare type TLiterals = {
     name: string;
     upsizeName?: string;
     fiscal?: string;
     "target-product-id"?: string;
     description?: string;
 } & IStringKeyRecord<string | undefined>;
-export type TMedia = {
+export declare type TMedia = {
     url: string;
     name: string;
 };
-type TDetails = {
+declare type TDetails = {
     literals?: TLiterals;
     media?: TMedia[];
 };
@@ -173,7 +173,7 @@ export interface IMenuCategory extends Pick<IMenuItem, "id" | "kind" | "_" | "__
 export interface IMenuProduct extends IMenuItem {
     kind: EProductKind.PRODUCT;
 }
-export type MenuProduct = IMenuCategory | ICmsReference | IStatic | IGroupConfig | IGroupOptions | IMenuProduct;
+export declare type MenuProduct = IMenuCategory | ICmsReference | IStatic | IGroupConfig | IGroupOptions | IMenuProduct;
 /**
  * IProductFrontAttributes
  *
@@ -377,6 +377,7 @@ export interface IOrderCoupon {
         categoryId?: string;
         productId?: string;
         enableKey?: string | string[];
+        couponKey?: string;
         userId?: string;
         extra?: IStringKeyRecord<string>;
     };
@@ -550,7 +551,7 @@ export interface ISubTotalDiscount {
     discount: number;
     vat: string;
 }
-export type IOrderGroupProduct = Pick<IOrderProduct, "kind" | "id" | "literals" | "items" | "extra">;
+export declare type IOrderGroupProduct = Pick<IOrderProduct, "kind" | "id" | "literals" | "items" | "extra">;
 export interface IOrderProduct {
     id: string;
     kind: EOrderProductKind;
@@ -587,8 +588,8 @@ export declare enum EOrderProductKind {
 export interface IProductLiterals {
     [propName: string]: any;
 }
-type TWeekDay = "MON" | "TUE" | "WED" | "THU" | "FRI" | "SAT" | "SUN";
-export type TSaleChannelWeek = Partial<Record<TWeekDay, {
+declare type TWeekDay = "MON" | "TUE" | "WED" | "THU" | "FRI" | "SAT" | "SUN";
+export declare type TSaleChannelWeek = Partial<Record<TWeekDay, {
     from: string;
     to: string;
 }[]>>;
@@ -662,7 +663,7 @@ export interface IFiscalizeData {
     };
 }
 export declare const sizes: readonly [48, 57, 70, 100, 160, 250, 300, 500, 600, 900, 1000, 1920, 1080, 900];
-export type TMediaSize = (typeof sizes)[number];
+export declare type TMediaSize = (typeof sizes)[number];
 export declare enum ENotificationType {
     ORDER_MESSAGE = "OrderMessage",
     ORDER_EVENT_ERROR = "OrderEventError",
@@ -670,7 +671,7 @@ export declare enum ENotificationType {
     ORDER_EVENT_FISCAL = "OrderEventFiscal",
     ORDER_UPSELL = "OrderUpsell"
 }
-export type TUpsellKind = "ANY" | "POPUP" | "SIDE" | "BASKET";
+export declare type TUpsellKind = "ANY" | "POPUP" | "SIDE" | "BASKET";
 export interface IUpsellNotification {
     details: {
         literals?: IStringKeyRecord<string>;
@@ -723,7 +724,7 @@ export interface ISteeringCommand {
     properties?: Record<string, string>;
 }
 export declare const modules: readonly ["POS_INTEGRATOR", "KIOSK", "BI_CONNECTOR", "AGGREGATOR", "KDS", "STATUS_SCREEN", "LOYALTY_INTEGRATOR", "LOYALTY", "MOBILE_APP_LOYALTY", "ORDERING_WEB", "DELIVERY_PANEL"];
-export type TModuleType = (typeof modules)[number];
+export declare type TModuleType = (typeof modules)[number];
 export interface IModule {
     id: string;
     type: TModuleType;
@@ -745,7 +746,7 @@ export interface IModuleCommonConfig {
         [key: string]: string;
     };
 }
-export type ISODateTimeString = `${number}-${number}-${number}T${number}:${number}:${number}Z`;
+export declare type ISODateTimeString = `${number}-${number}-${number}T${number}:${number}:${number}Z`;
 export interface IUserData {
     active: boolean;
     authStrategies: any[];

package/dist/esm/kioskErrors.d.ts

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

package/package.json

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

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

@@ -1,97 +0,0 @@
-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

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