@orderingstack/ordering-types 1.31.0 → 1.32.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.
@@ -3,6 +3,7 @@ export * from "./kiosk";
3
3
  export * from "./kioskErrors";
4
4
  export * from "./api";
5
5
  export * from "./loyalty";
6
+ export { type IStringKeyRecord } from "./utils";
6
7
  export interface IRestaurant {
7
8
  id: string;
8
9
  name: string;
@@ -326,6 +327,8 @@ export interface IOrderDeliveryAddress {
326
327
  city: string;
327
328
  country: string;
328
329
  }
330
+ export declare const TEST_VARIANTS: readonly ["A", "B"];
331
+ export type TestVariant = typeof TEST_VARIANTS[number];
329
332
  export interface IOrder {
330
333
  tenant: string;
331
334
  id: string;
@@ -367,6 +370,7 @@ export interface IOrder {
367
370
  completed?: boolean;
368
371
  verified?: boolean;
369
372
  closed?: boolean;
373
+ variant?: TestVariant;
370
374
  }
371
375
  export interface IOrderCoupon {
372
376
  coupon: string;
@@ -724,6 +728,10 @@ export interface ISteeringCommand {
724
728
  }
725
729
  export declare const modules: readonly ["POS_INTEGRATOR", "KIOSK", "BI_CONNECTOR", "AGGREGATOR", "KDS", "STATUS_SCREEN", "LOYALTY_INTEGRATOR", "LOYALTY", "MOBILE_APP_LOYALTY", "ORDERING_WEB", "DELIVERY_PANEL"];
726
730
  export type TModuleType = (typeof modules)[number];
731
+ interface IModuleConfig extends Partial<Record<`variantRatio_${TestVariant}`, number>> {
732
+ abTestingEnabled?: boolean;
733
+ [key: string]: any;
734
+ }
727
735
  export interface IModule {
728
736
  id: string;
729
737
  type: TModuleType;
@@ -735,9 +743,7 @@ export interface IModule {
735
743
  updatedBy?: string;
736
744
  user?: string;
737
745
  extra?: IStringKeyRecord<string>;
738
- config?: {
739
- [key: string]: any;
740
- };
746
+ config?: IModuleConfig;
741
747
  }
742
748
  export interface IModuleCommonConfig {
743
749
  type: TModuleType;
package/dist/cjs/index.js CHANGED
@@ -14,7 +14,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
14
  for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
15
  };
16
16
  Object.defineProperty(exports, "__esModule", { value: true });
17
- exports.modules = exports.ENotificationType = exports.sizes = exports.EOrderProductKind = exports.EOrderLineStatus = exports.ERbiOrderExtra = exports.EOrderPaymentType = exports.EOrderStatus = exports.EChannelName = exports.CHANNEL_NAMES = exports.EOrderSource = exports.EOrderType = exports.EOrderUserRole = exports.EProductKindBucket = exports.EProductKind = exports.ECouponViewType = void 0;
17
+ exports.modules = exports.ENotificationType = exports.sizes = exports.EOrderProductKind = exports.EOrderLineStatus = exports.ERbiOrderExtra = exports.EOrderPaymentType = exports.EOrderStatus = exports.TEST_VARIANTS = exports.EChannelName = exports.CHANNEL_NAMES = exports.EOrderSource = exports.EOrderType = exports.EOrderUserRole = exports.EProductKindBucket = exports.EProductKind = exports.ECouponViewType = void 0;
18
18
  __exportStar(require("./kiosk"), exports);
19
19
  __exportStar(require("./kioskErrors"), exports);
20
20
  __exportStar(require("./api"), exports);
@@ -120,6 +120,7 @@ var EChannelName;
120
120
  EChannelName["TAZZ"] = "TAZZ";
121
121
  EChannelName["UPMENU"] = "UPMENU";
122
122
  })(EChannelName = exports.EChannelName || (exports.EChannelName = {}));
123
+ exports.TEST_VARIANTS = ['A', 'B'];
123
124
  var EOrderStatus;
124
125
  (function (EOrderStatus) {
125
126
  EOrderStatus["NEW"] = "NEW";
@@ -3,6 +3,7 @@ export * from "./kiosk";
3
3
  export * from "./kioskErrors";
4
4
  export * from "./api";
5
5
  export * from "./loyalty";
6
+ export { type IStringKeyRecord } from "./utils";
6
7
  export interface IRestaurant {
7
8
  id: string;
8
9
  name: string;
@@ -326,6 +327,8 @@ export interface IOrderDeliveryAddress {
326
327
  city: string;
327
328
  country: string;
328
329
  }
330
+ export declare const TEST_VARIANTS: readonly ["A", "B"];
331
+ export type TestVariant = typeof TEST_VARIANTS[number];
329
332
  export interface IOrder {
330
333
  tenant: string;
331
334
  id: string;
@@ -367,6 +370,7 @@ export interface IOrder {
367
370
  completed?: boolean;
368
371
  verified?: boolean;
369
372
  closed?: boolean;
373
+ variant?: TestVariant;
370
374
  }
371
375
  export interface IOrderCoupon {
372
376
  coupon: string;
@@ -724,6 +728,10 @@ export interface ISteeringCommand {
724
728
  }
725
729
  export declare const modules: readonly ["POS_INTEGRATOR", "KIOSK", "BI_CONNECTOR", "AGGREGATOR", "KDS", "STATUS_SCREEN", "LOYALTY_INTEGRATOR", "LOYALTY", "MOBILE_APP_LOYALTY", "ORDERING_WEB", "DELIVERY_PANEL"];
726
730
  export type TModuleType = (typeof modules)[number];
731
+ interface IModuleConfig extends Partial<Record<`variantRatio_${TestVariant}`, number>> {
732
+ abTestingEnabled?: boolean;
733
+ [key: string]: any;
734
+ }
727
735
  export interface IModule {
728
736
  id: string;
729
737
  type: TModuleType;
@@ -735,9 +743,7 @@ export interface IModule {
735
743
  updatedBy?: string;
736
744
  user?: string;
737
745
  extra?: IStringKeyRecord<string>;
738
- config?: {
739
- [key: string]: any;
740
- };
746
+ config?: IModuleConfig;
741
747
  }
742
748
  export interface IModuleCommonConfig {
743
749
  type: TModuleType;
package/dist/esm/index.js CHANGED
@@ -103,6 +103,7 @@ export var EChannelName;
103
103
  EChannelName["TAZZ"] = "TAZZ";
104
104
  EChannelName["UPMENU"] = "UPMENU";
105
105
  })(EChannelName || (EChannelName = {}));
106
+ export const TEST_VARIANTS = ['A', 'B'];
106
107
  export var EOrderStatus;
107
108
  (function (EOrderStatus) {
108
109
  EOrderStatus["NEW"] = "NEW";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@orderingstack/ordering-types",
3
- "version": "1.31.0",
3
+ "version": "1.32.0",
4
4
  "description": "Typescript types for @orderingstack",
5
5
  "types": "dist/esm/index.d.ts",
6
6
  "main": "dist/cjs/index.js",