@orderingstack/ordering-types 1.19.0 → 1.21.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/cjs/api.d.ts CHANGED
@@ -1,7 +1,7 @@
1
1
  import { EOrderPaymentType, EOrderStatus, EOrderType, IProductState, IStringKeyRecord } from "./index";
2
2
  export declare const aggregators: readonly ["BOLT", "GLOVO", "JUSTEAT", "TAZZ", "UBER", "UPMENU", "WOLT", "_ANY_"];
3
- export type TAggregator = typeof aggregators[number];
4
- type TOrderDir = "DESC" | "ASC";
3
+ export declare type TAggregator = typeof aggregators[number];
4
+ declare type TOrderDir = "DESC" | "ASC";
5
5
  interface ApiParams {
6
6
  query?: any;
7
7
  headers?: IStringKeyRecord<string>;
@@ -39,7 +39,7 @@ export interface ILanguage {
39
39
  key: string;
40
40
  icon: any;
41
41
  }
42
- export type TStringBoolean = "true" | "false";
42
+ export declare type TStringBoolean = "true" | "false";
43
43
  export declare enum EProductKind {
44
44
  GROUP = "3e/group",
45
45
  PRODUCT = "3e/product",
@@ -54,14 +54,14 @@ export declare enum EProductKindBucket {
54
54
  GROUP = "group",
55
55
  PRODUCT = "product"
56
56
  }
57
- export type TLiterals = {
57
+ export declare type TLiterals = {
58
58
  name: string;
59
59
  upsizeName?: string;
60
60
  fiscal?: string;
61
61
  "target-product-id"?: string;
62
62
  description?: string;
63
63
  } & IStringKeyRecord<string | undefined>;
64
- export type TMedia = {
64
+ export declare type TMedia = {
65
65
  url: string;
66
66
  name: string;
67
67
  };
@@ -92,6 +92,7 @@ export interface IProductExtra extends IStringKeyRecord<string | undefined> {
92
92
  */
93
93
  export interface IProductFrontAttributes {
94
94
  isHiddenByEnableKey?: boolean;
95
+ lineExtra?: IStringKeyRecord<string>;
95
96
  }
96
97
  export interface IProduct {
97
98
  availability?: IProductAvailability;
@@ -454,7 +455,7 @@ export interface ISubTotalDiscount {
454
455
  discount: number;
455
456
  vat: string;
456
457
  }
457
- export type IOrderGroupProduct = Pick<IOrderProduct, "kind" | "id" | "literals" | "items" | "extra">;
458
+ export declare type IOrderGroupProduct = Pick<IOrderProduct, "kind" | "id" | "literals" | "items" | "extra">;
458
459
  export interface IOrderProduct {
459
460
  id: string;
460
461
  kind: EOrderProductKind;
@@ -491,8 +492,8 @@ export declare enum EOrderProductKind {
491
492
  export interface IProductLiterals {
492
493
  [propName: string]: any;
493
494
  }
494
- type TWeekDay = "MON" | "TUE" | "WED" | "THU" | "FRI" | "SAT" | "SUN";
495
- export type TSaleChannelWeek = Partial<Record<TWeekDay, {
495
+ declare type TWeekDay = "MON" | "TUE" | "WED" | "THU" | "FRI" | "SAT" | "SUN";
496
+ export declare type TSaleChannelWeek = Partial<Record<TWeekDay, {
496
497
  from: string;
497
498
  to: string;
498
499
  }[]>>;
@@ -566,14 +567,14 @@ export interface IFiscalizeData {
566
567
  };
567
568
  }
568
569
  declare const sizes: readonly [48, 57, 70, 100, 160, 250, 300, 500, 600, 900, 1000, 1920, 1080, 900];
569
- export type TMediaSize = (typeof sizes)[number];
570
+ export declare type TMediaSize = (typeof sizes)[number];
570
571
  export declare enum ENotificationType {
571
572
  ORDER_EVENT_ERROR = "OrderEventError",
572
573
  ORDER_APPLIED_EVENTS = "OrderAppliedEvents",
573
574
  ORDER_EVENT_FISCAL = "OrderEventFiscal",
574
575
  ORDER_UPSELL = "OrderUpsell"
575
576
  }
576
- export type TUpsellKind = "ANY" | "POPUP" | "SIDE" | "BASKET";
577
+ export declare type TUpsellKind = "ANY" | "POPUP" | "SIDE" | "BASKET";
577
578
  export interface IUpsellNotification {
578
579
  details: {
579
580
  literals?: IStringKeyRecord<string>;
@@ -59,6 +59,7 @@ export interface IMenuProps {
59
59
  order?: IOrder;
60
60
  changeQuantity: (line: IOrderLine, quantity: number) => void;
61
61
  components: IMenuComponents;
62
+ onSelectCategory?: (id: string) => void;
62
63
  }
63
64
  export interface IMenuTileProps {
64
65
  product: IProduct;
@@ -138,7 +138,7 @@ export declare const KioskErrors: {
138
138
  x500: string;
139
139
  x501: string;
140
140
  };
141
- export type TErrorCode = keyof typeof KioskErrors;
141
+ export declare type TErrorCode = keyof typeof KioskErrors;
142
142
  export interface IKioskError {
143
143
  errorType: string;
144
144
  errorCode: TErrorCode;
package/dist/esm/api.d.ts CHANGED
@@ -1,7 +1,7 @@
1
1
  import { EOrderPaymentType, EOrderStatus, EOrderType, IProductState, IStringKeyRecord } from "./index";
2
2
  export declare const aggregators: readonly ["BOLT", "GLOVO", "JUSTEAT", "TAZZ", "UBER", "UPMENU", "WOLT", "_ANY_"];
3
- export type TAggregator = typeof aggregators[number];
4
- type TOrderDir = "DESC" | "ASC";
3
+ export declare type TAggregator = typeof aggregators[number];
4
+ declare type TOrderDir = "DESC" | "ASC";
5
5
  interface ApiParams {
6
6
  query?: any;
7
7
  headers?: IStringKeyRecord<string>;
@@ -39,7 +39,7 @@ export interface ILanguage {
39
39
  key: string;
40
40
  icon: any;
41
41
  }
42
- export type TStringBoolean = "true" | "false";
42
+ export declare type TStringBoolean = "true" | "false";
43
43
  export declare enum EProductKind {
44
44
  GROUP = "3e/group",
45
45
  PRODUCT = "3e/product",
@@ -54,14 +54,14 @@ export declare enum EProductKindBucket {
54
54
  GROUP = "group",
55
55
  PRODUCT = "product"
56
56
  }
57
- export type TLiterals = {
57
+ export declare type TLiterals = {
58
58
  name: string;
59
59
  upsizeName?: string;
60
60
  fiscal?: string;
61
61
  "target-product-id"?: string;
62
62
  description?: string;
63
63
  } & IStringKeyRecord<string | undefined>;
64
- export type TMedia = {
64
+ export declare type TMedia = {
65
65
  url: string;
66
66
  name: string;
67
67
  };
@@ -92,6 +92,7 @@ export interface IProductExtra extends IStringKeyRecord<string | undefined> {
92
92
  */
93
93
  export interface IProductFrontAttributes {
94
94
  isHiddenByEnableKey?: boolean;
95
+ lineExtra?: IStringKeyRecord<string>;
95
96
  }
96
97
  export interface IProduct {
97
98
  availability?: IProductAvailability;
@@ -454,7 +455,7 @@ export interface ISubTotalDiscount {
454
455
  discount: number;
455
456
  vat: string;
456
457
  }
457
- export type IOrderGroupProduct = Pick<IOrderProduct, "kind" | "id" | "literals" | "items" | "extra">;
458
+ export declare type IOrderGroupProduct = Pick<IOrderProduct, "kind" | "id" | "literals" | "items" | "extra">;
458
459
  export interface IOrderProduct {
459
460
  id: string;
460
461
  kind: EOrderProductKind;
@@ -491,8 +492,8 @@ export declare enum EOrderProductKind {
491
492
  export interface IProductLiterals {
492
493
  [propName: string]: any;
493
494
  }
494
- type TWeekDay = "MON" | "TUE" | "WED" | "THU" | "FRI" | "SAT" | "SUN";
495
- export type TSaleChannelWeek = Partial<Record<TWeekDay, {
495
+ declare type TWeekDay = "MON" | "TUE" | "WED" | "THU" | "FRI" | "SAT" | "SUN";
496
+ export declare type TSaleChannelWeek = Partial<Record<TWeekDay, {
496
497
  from: string;
497
498
  to: string;
498
499
  }[]>>;
@@ -566,14 +567,14 @@ export interface IFiscalizeData {
566
567
  };
567
568
  }
568
569
  declare const sizes: readonly [48, 57, 70, 100, 160, 250, 300, 500, 600, 900, 1000, 1920, 1080, 900];
569
- export type TMediaSize = (typeof sizes)[number];
570
+ export declare type TMediaSize = (typeof sizes)[number];
570
571
  export declare enum ENotificationType {
571
572
  ORDER_EVENT_ERROR = "OrderEventError",
572
573
  ORDER_APPLIED_EVENTS = "OrderAppliedEvents",
573
574
  ORDER_EVENT_FISCAL = "OrderEventFiscal",
574
575
  ORDER_UPSELL = "OrderUpsell"
575
576
  }
576
- export type TUpsellKind = "ANY" | "POPUP" | "SIDE" | "BASKET";
577
+ export declare type TUpsellKind = "ANY" | "POPUP" | "SIDE" | "BASKET";
577
578
  export interface IUpsellNotification {
578
579
  details: {
579
580
  literals?: IStringKeyRecord<string>;
@@ -59,6 +59,7 @@ export interface IMenuProps {
59
59
  order?: IOrder;
60
60
  changeQuantity: (line: IOrderLine, quantity: number) => void;
61
61
  components: IMenuComponents;
62
+ onSelectCategory?: (id: string) => void;
62
63
  }
63
64
  export interface IMenuTileProps {
64
65
  product: IProduct;
@@ -138,7 +138,7 @@ export declare const KioskErrors: {
138
138
  x500: string;
139
139
  x501: string;
140
140
  };
141
- export type TErrorCode = keyof typeof KioskErrors;
141
+ export declare type TErrorCode = keyof typeof KioskErrors;
142
142
  export interface IKioskError {
143
143
  errorType: string;
144
144
  errorCode: TErrorCode;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@orderingstack/ordering-types",
3
- "version": "1.19.0",
3
+ "version": "1.21.0",
4
4
  "description": "Typescript types for @orderingstack",
5
5
  "types": "dist/esm/index.d.ts",
6
6
  "main": "dist/cjs/index.js",
@@ -1,97 +0,0 @@
1
- import { EOrderPaymentType, EOrderStatus, EOrderType, IProductState, IStringKeyRecord } from "./index";
2
- export declare const aggregators: readonly ["GLOVO", "JUSTEAT", "UBER", "WOLT", "BOLT", "TAZZ", "_ANY_"];
3
- export type TAggregator = typeof aggregators[number];
4
- type TOrderDir = "DESC" | "ASC";
5
- interface ApiParams {
6
- query?: any;
7
- headers?: IStringKeyRecord<string>;
8
- data?: any;
9
- }
10
- export interface IOrderApiGetListParams extends ApiParams {
11
- query: {
12
- _sort?: string;
13
- _order?: TOrderDir;
14
- _start?: number;
15
- _end?: number;
16
- id?: string;
17
- extId?: string;
18
- status?: EOrderStatus;
19
- type?: EOrderType;
20
- completed?: boolean;
21
- closed?: boolean;
22
- phone?: string;
23
- mail?: string;
24
- createdFrom?: string;
25
- createdTo?: string;
26
- completedFrom?: string;
27
- completedTo?: string;
28
- venue?: string;
29
- aggregator?: TAggregator;
30
- payment?: EOrderPaymentType;
31
- };
32
- headers: {
33
- "x-tenant"?: string;
34
- };
35
- }
36
- interface IDiscount {
37
- /**
38
- * Discount layer. It is used to distinguish discounts from loyalty, manual discounts, etc.
39
- * @pattern [a-zA-Z0-9_.-]+
40
- */
41
- layer: string;
42
- /**
43
- * Name that describes this discount
44
- * @minLength 0
45
- * @maxLength 128
46
- */
47
- name?: string;
48
- /** Discount price (subtracted from line total) */
49
- discountPrice: number;
50
- /** Extra params */
51
- extra?: IStringKeyRecord<string>;
52
- type: string;
53
- }
54
- interface ILineDiscount {
55
- /** Applied discounts */
56
- discount: IDiscount;
57
- /** @format date-time */
58
- expires?: string;
59
- /**
60
- * @minLength 0
61
- * @maxLength 128
62
- * @pattern [a-zA-Z0-9_. -]+
63
- */
64
- sign: string;
65
- }
66
- export interface IAppendedLine {
67
- /**
68
- * @format int32
69
- * @min 1
70
- * @max 100000
71
- */
72
- quantity: number;
73
- /**
74
- * 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).
75
- * @min 0
76
- * @exclusiveMin false
77
- */
78
- price?: number;
79
- /** @pattern [a-zA-Z0-9_.-]+ */
80
- productId: string;
81
- /** Configuration of product */
82
- productConfig?: IProductState;
83
- /** @default "NEW" */
84
- status: "NEW" | "CONFIRMED";
85
- /**
86
- * @minLength 0
87
- * @maxLength 255
88
- */
89
- comment?: string;
90
- /**
91
- * @maxItems 10
92
- * @minItems 0
93
- */
94
- discounts?: ILineDiscount[];
95
- extra?: IStringKeyRecord<string>;
96
- }
97
- export {};
@@ -1,12 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.aggregators = void 0;
4
- exports.aggregators = [
5
- "GLOVO",
6
- "JUSTEAT",
7
- "UBER",
8
- "WOLT",
9
- "BOLT",
10
- "TAZZ",
11
- "_ANY_",
12
- ];