@fire-spark/types 0.11.0 → 0.12.0

package/dist/index.d.ts

@@ -614,7 +614,7 @@ type Store = {
   };
   channel_ids: string[];
   fulfillment_ids: string[];
-  tags: Record<string, string | number | boolean>;
+  tags: Record<string, string | number | boolean | (string | number | boolean)[]>;
   cms_template_id?: string | null | undefined;
   status: string;
   coverage_zones: {
@@ -643,7 +643,7 @@ type Store = {
       }[];
     }[] | null;
     labels: string[];
-    tags: Record<string, string | number | boolean>;
+    tags: Record<string, string | number | boolean | (string | number | boolean)[]>;
     status: string;
   }[];
   cms?: {
@@ -798,9 +798,9 @@ type OrderFulfillment = {
           brand_id: string;
           primitive: "string";
           type: "Failure message" | "Order includes product with tag" | "Request path";
-          operator: "contains" | "ends with" | "equal to" | "not equal to" | "starts with";
+          operator: "contains" | "ends with" | "equal to" | "is all of" | "is any of" | "is none of" | "not equal to" | "starts with";
           caseInsensitive?: boolean | undefined;
-          value: string;
+          value: string | string[];
           invalidMessage?: string | undefined;
         } | {
           interpretation?: "both" | "client" | "server" | undefined;
@@ -812,8 +812,8 @@ type OrderFulfillment = {
           brand_id: string;
           primitive: "number";
           type: "API error rate" | "Accumulated events" | "Cart product count" | "Customer age" | "HTTP status" | "Order includes product" | "Order includes product with tag";
-          operator: "equal to" | "greater than" | "greater than or equal to" | "less than" | "less than or equal to" | "not equal to";
-          value: number;
+          operator: "equal to" | "greater than" | "greater than or equal to" | "is all of" | "is any of" | "is none of" | "less than" | "less than or equal to" | "not equal to";
+          value: number | number[];
           include_modifiers?: boolean | undefined;
           window_minutes?: number | undefined;
           invalidMessage?: string | undefined;
@@ -956,9 +956,9 @@ type MerchantPayment = {
     brand_id: string;
     primitive: "string";
     type: "Failure message" | "Order includes product with tag" | "Request path";
-    operator: "contains" | "ends with" | "equal to" | "not equal to" | "starts with";
+    operator: "contains" | "ends with" | "equal to" | "is all of" | "is any of" | "is none of" | "not equal to" | "starts with";
     caseInsensitive?: boolean | undefined;
-    value: string;
+    value: string | string[];
     invalidMessage?: string | undefined;
   } | {
     interpretation?: "both" | "client" | "server" | undefined;
@@ -970,8 +970,8 @@ type MerchantPayment = {
     brand_id: string;
     primitive: "number";
     type: "API error rate" | "Accumulated events" | "Cart product count" | "Customer age" | "HTTP status" | "Order includes product" | "Order includes product with tag";
-    operator: "equal to" | "greater than" | "greater than or equal to" | "less than" | "less than or equal to" | "not equal to";
-    value: number;
+    operator: "equal to" | "greater than" | "greater than or equal to" | "is all of" | "is any of" | "is none of" | "less than" | "less than or equal to" | "not equal to";
+    value: number | number[];
     include_modifiers?: boolean | undefined;
     window_minutes?: number | undefined;
     invalidMessage?: string | undefined;
@@ -1420,7 +1420,7 @@ type StorefrontMenu = {
     };
     image_origin_url?: string | null | undefined;
     labels: string[];
-    tags: Record<string, string | number | boolean>;
+    tags: Record<string, string | number | boolean | (string | number | boolean)[]>;
     metadata: Record<string, unknown>;
   }[];
   categories: {
@@ -1471,7 +1471,7 @@ type StorefrontMenu = {
     image_url: string | null;
     image_origin_url?: string | null | undefined;
     labels: string[];
-    tags: Record<string, string | number | boolean>;
+    tags: Record<string, string | number | boolean | (string | number | boolean)[]>;
     metadata: Record<string, unknown>;
   }[];
   modifier_groups: {
@@ -4132,9 +4132,9 @@ type Condition = {
   brand_id: string;
   primitive: "string";
   type: "Failure message" | "Order includes product with tag" | "Request path";
-  operator: "contains" | "ends with" | "equal to" | "not equal to" | "starts with";
+  operator: "contains" | "ends with" | "equal to" | "is all of" | "is any of" | "is none of" | "not equal to" | "starts with";
   caseInsensitive?: boolean | undefined;
-  value: string;
+  value: string | string[];
   invalidMessage?: string | undefined;
 } | {
   interpretation?: "both" | "client" | "server" | undefined;
@@ -4146,8 +4146,8 @@ type Condition = {
   brand_id: string;
   primitive: "number";
   type: "API error rate" | "Accumulated events" | "Cart product count" | "Customer age" | "HTTP status" | "Order includes product" | "Order includes product with tag";
-  operator: "equal to" | "greater than" | "greater than or equal to" | "less than" | "less than or equal to" | "not equal to";
-  value: number;
+  operator: "equal to" | "greater than" | "greater than or equal to" | "is all of" | "is any of" | "is none of" | "less than" | "less than or equal to" | "not equal to";
+  value: number | number[];
   include_modifiers?: boolean | undefined;
   window_minutes?: number | undefined;
   invalidMessage?: string | undefined;
@@ -4228,9 +4228,9 @@ type AndConditions = ({
   brand_id: string;
   primitive: "string";
   type: "Failure message" | "Order includes product with tag" | "Request path";
-  operator: "contains" | "ends with" | "equal to" | "not equal to" | "starts with";
+  operator: "contains" | "ends with" | "equal to" | "is all of" | "is any of" | "is none of" | "not equal to" | "starts with";
   caseInsensitive?: boolean | undefined;
-  value: string;
+  value: string | string[];
   invalidMessage?: string | undefined;
 } | {
   interpretation?: "both" | "client" | "server" | undefined;
@@ -4242,8 +4242,8 @@ type AndConditions = ({
   brand_id: string;
   primitive: "number";
   type: "API error rate" | "Accumulated events" | "Cart product count" | "Customer age" | "HTTP status" | "Order includes product" | "Order includes product with tag";
-  operator: "equal to" | "greater than" | "greater than or equal to" | "less than" | "less than or equal to" | "not equal to";
-  value: number;
+  operator: "equal to" | "greater than" | "greater than or equal to" | "is all of" | "is any of" | "is none of" | "less than" | "less than or equal to" | "not equal to";
+  value: number | number[];
   include_modifiers?: boolean | undefined;
   window_minutes?: number | undefined;
   invalidMessage?: string | undefined;
@@ -4324,9 +4324,9 @@ type OrConditions = ({
   brand_id: string;
   primitive: "string";
   type: "Failure message" | "Order includes product with tag" | "Request path";
-  operator: "contains" | "ends with" | "equal to" | "not equal to" | "starts with";
+  operator: "contains" | "ends with" | "equal to" | "is all of" | "is any of" | "is none of" | "not equal to" | "starts with";
   caseInsensitive?: boolean | undefined;
-  value: string;
+  value: string | string[];
   invalidMessage?: string | undefined;
 } | {
   interpretation?: "both" | "client" | "server" | undefined;
@@ -4338,8 +4338,8 @@ type OrConditions = ({
   brand_id: string;
   primitive: "number";
   type: "API error rate" | "Accumulated events" | "Cart product count" | "Customer age" | "HTTP status" | "Order includes product" | "Order includes product with tag";
-  operator: "equal to" | "greater than" | "greater than or equal to" | "less than" | "less than or equal to" | "not equal to";
-  value: number;
+  operator: "equal to" | "greater than" | "greater than or equal to" | "is all of" | "is any of" | "is none of" | "less than" | "less than or equal to" | "not equal to";
+  value: number | number[];
   include_modifiers?: boolean | undefined;
   window_minutes?: number | undefined;
   invalidMessage?: string | undefined;
@@ -4415,12 +4415,14 @@ type RulesEngineRuntime = "client" | "server";
 interface StringMatchCaseOptions {
   caseInsensitive?: boolean;
 }
+type RulesEngineTagValue = boolean | string | number;
 interface RulesEngineOrderLine {
   id: string;
   quantity: number;
   parent_uid?: string | null;
   type?: string;
-  tags?: Record<string, boolean | string | number>;
+  /** A tag holds one value or a list of values (see the tag condition docs). */
+  tags?: Record<string, RulesEngineTagValue | RulesEngineTagValue[]>;
 }
 interface MatchableRule {
   conditions?: OrConditions | null;
@@ -4502,4 +4504,4 @@ interface CheckoutResolved {
   billingFields: Record<string, CheckoutMode>;
 }
 //#endregion
-export type { AddressInfo, AndConditions, BillingInfo, BillingProfile, BundledItem, Category, CategoryAvailability, CategoryItem, ChannelManifest, ChannelManifestNative, ChannelManifestWeb, ChannelPlatform, ChannelTemplate, CheckoutMode, CheckoutResolved, CmsBlock, CmsBlockItem, Condition, Customer, CustomerGender, CustomerIdentifyInput, CustomerRegisterInput, CustomerUpdateInput, DayOfWeek, DeliveryAddress, Fulfillment, FulfillmentListInput, GroupDisplayType, KioskAdminGesture, KioskAppState, KioskCommandPayload, KioskCommandType, KioskConfigChangedPayload, KioskDeviceConfig, KioskDeviceConfigDevice, KioskDeviceConfigPayment, KioskDeviceConfigScope, KioskDeviceConfigSettings, KioskDeviceOverrides, KioskDevicePaymentSettings, KioskHealthBatchInput, KioskHealthBatchResult, KioskHealthSample, KioskHeartbeatHealth, KioskHeartbeatInput, KioskHeartbeatResult, KioskOrderPager, KioskPagerSide, KioskPagersOverrides, KioskPagersSettings, KioskRealtimeToken, MatchResult, MatchableRule, Menu, MenuLookup, MerchantPayment, Metadata, MixedPaymentsEffect, MixedPaymentsLimits, ModifierControlType, ModifierGroup, MultiLanguageText, OrConditions, Order, OrderCancelInput, OrderCancelType, OrderChangedCallback, OrderChangedCallbackError, OrderChangedCheckoutState, OrderChangedDeviceReversal, OrderChangedDeviceReversalTender, OrderChangedError, OrderChangedPayload, OrderChangedRunStatus, OrderDeviceCredential, OrderDeviceKind, OrderDeviceListInput, OrderDeviceListResult, OrderFulfillment, OrderInsertInput, OrderLine, OrderListInput, OrderRecordPaymentInput, OrderRedeem, OrderRedeemInput, OrderRedemptionState, OrderRedemptionStep, OrderReorderInput, OrderReportedTender, OrderTotals, OrderUpdateInput, OrderValidateInput, OrderValidateOutput, Payment, PaymentCollectAt, PaymentErrorCode, PaymentIntent, PaymentIntentInput, PaymentIntentPutInput, PaymentIntentStatus, PaymentMethod, PaymentProvider, PaymentScope, PaymentStatus, PaymentTender, PaymentTenderInput, PlaceOrderResult, PosActorKind, PosCashBreakdownItem, PosCatalog, PosDenominationKind, PosDeviceConfigDevice, PosDeviceConfigScope, PosDeviceOverrides, PosErrorCode, PosFloor, PosFloorChangedPayload, PosFloorElement, PosFloorInput, PosFloorLayout, PosFloorOccupancy, PosFloorPlan, PosFloorRealtimeToken, PosFloorTable, PosHealthBatchInput, PosHealthBatchResult, PosHealthSample, PosHeartbeatHealth, PosHeartbeatInput, PosHeartbeatResult, PosKioskOrder, PosKioskSettleInput, PosKioskSettleResult, PosOrderInput, PosOrderResult, PosReservationHold, PosReservationHoldStatus, PosStaff, PosTableAttachOrderInput, PosTableCloseInput, PosTableJoinInput, PosTableSeatInput, PosTableSeatReservationInput, PosTableSession, PosTableSessionOrder, PosTableSessionStatus, PosTableSplitInput, PricingModifier, PricingVariant, Product, ProductAvailability, ProductPricing, ProductRecommendationLink, Recommendation, RecurringDateCronExpression, RecurringDateCronRepeat, RecurringDateCronResult, RecurringDateCronValues, RuleInterpretation, RulesEngineMonitoring, RulesEngineOrder, RulesEngineOrderLine, RulesEngineParams, RulesEngineRuntime, Schedule, ScheduleDay, SchedulePeriod, SdkLogContext, SdkLogEntry, SdkLogErrorInfo, SdkLogIngestResult, SdkLogLevel, SdkLogOptions, Store, StoreAvailabilityFilters, StoreGetInput, StoreListInput, StoreNearbyInput, StorefrontAvailability, StorefrontAvailabilityChangedPayload, StorefrontAvailabilityInput, StorefrontAvailabilityRule, StorefrontCmsChangedPayload, StorefrontMenu, StorefrontMenuChangedPayload, StorefrontMenuScope, StorefrontMenuStreamOptions, StorefrontPaymentsListInput, StorefrontPreferences, StorefrontPreferencesInput, StorefrontRealtimeToken, StorefrontRealtimeTokenInput, StorefrontWorkspaceChangedPayload, StringMatchCaseOptions, TenderAllocation, TenderAllocationInput, TenderAmount, TenderDetails, TenderRefundInput, TenderReplaceInput, TenderVoidInput, Variant, VariantGroup };
+export type { AddressInfo, AndConditions, BillingInfo, BillingProfile, BundledItem, Category, CategoryAvailability, CategoryItem, ChannelManifest, ChannelManifestNative, ChannelManifestWeb, ChannelPlatform, ChannelTemplate, CheckoutMode, CheckoutResolved, CmsBlock, CmsBlockItem, Condition, Customer, CustomerGender, CustomerIdentifyInput, CustomerRegisterInput, CustomerUpdateInput, DayOfWeek, DeliveryAddress, Fulfillment, FulfillmentListInput, GroupDisplayType, KioskAdminGesture, KioskAppState, KioskCommandPayload, KioskCommandType, KioskConfigChangedPayload, KioskDeviceConfig, KioskDeviceConfigDevice, KioskDeviceConfigPayment, KioskDeviceConfigScope, KioskDeviceConfigSettings, KioskDeviceOverrides, KioskDevicePaymentSettings, KioskHealthBatchInput, KioskHealthBatchResult, KioskHealthSample, KioskHeartbeatHealth, KioskHeartbeatInput, KioskHeartbeatResult, KioskOrderPager, KioskPagerSide, KioskPagersOverrides, KioskPagersSettings, KioskRealtimeToken, MatchResult, MatchableRule, Menu, MenuLookup, MerchantPayment, Metadata, MixedPaymentsEffect, MixedPaymentsLimits, ModifierControlType, ModifierGroup, MultiLanguageText, OrConditions, Order, OrderCancelInput, OrderCancelType, OrderChangedCallback, OrderChangedCallbackError, OrderChangedCheckoutState, OrderChangedDeviceReversal, OrderChangedDeviceReversalTender, OrderChangedError, OrderChangedPayload, OrderChangedRunStatus, OrderDeviceCredential, OrderDeviceKind, OrderDeviceListInput, OrderDeviceListResult, OrderFulfillment, OrderInsertInput, OrderLine, OrderListInput, OrderRecordPaymentInput, OrderRedeem, OrderRedeemInput, OrderRedemptionState, OrderRedemptionStep, OrderReorderInput, OrderReportedTender, OrderTotals, OrderUpdateInput, OrderValidateInput, OrderValidateOutput, Payment, PaymentCollectAt, PaymentErrorCode, PaymentIntent, PaymentIntentInput, PaymentIntentPutInput, PaymentIntentStatus, PaymentMethod, PaymentProvider, PaymentScope, PaymentStatus, PaymentTender, PaymentTenderInput, PlaceOrderResult, PosActorKind, PosCashBreakdownItem, PosCatalog, PosDenominationKind, PosDeviceConfigDevice, PosDeviceConfigScope, PosDeviceOverrides, PosErrorCode, PosFloor, PosFloorChangedPayload, PosFloorElement, PosFloorInput, PosFloorLayout, PosFloorOccupancy, PosFloorPlan, PosFloorRealtimeToken, PosFloorTable, PosHealthBatchInput, PosHealthBatchResult, PosHealthSample, PosHeartbeatHealth, PosHeartbeatInput, PosHeartbeatResult, PosKioskOrder, PosKioskSettleInput, PosKioskSettleResult, PosOrderInput, PosOrderResult, PosReservationHold, PosReservationHoldStatus, PosStaff, PosTableAttachOrderInput, PosTableCloseInput, PosTableJoinInput, PosTableSeatInput, PosTableSeatReservationInput, PosTableSession, PosTableSessionOrder, PosTableSessionStatus, PosTableSplitInput, PricingModifier, PricingVariant, Product, ProductAvailability, ProductPricing, ProductRecommendationLink, Recommendation, RecurringDateCronExpression, RecurringDateCronRepeat, RecurringDateCronResult, RecurringDateCronValues, RuleInterpretation, RulesEngineMonitoring, RulesEngineOrder, RulesEngineOrderLine, RulesEngineParams, RulesEngineRuntime, RulesEngineTagValue, Schedule, ScheduleDay, SchedulePeriod, SdkLogContext, SdkLogEntry, SdkLogErrorInfo, SdkLogIngestResult, SdkLogLevel, SdkLogOptions, Store, StoreAvailabilityFilters, StoreGetInput, StoreListInput, StoreNearbyInput, StorefrontAvailability, StorefrontAvailabilityChangedPayload, StorefrontAvailabilityInput, StorefrontAvailabilityRule, StorefrontCmsChangedPayload, StorefrontMenu, StorefrontMenuChangedPayload, StorefrontMenuScope, StorefrontMenuStreamOptions, StorefrontPaymentsListInput, StorefrontPreferences, StorefrontPreferencesInput, StorefrontRealtimeToken, StorefrontRealtimeTokenInput, StorefrontWorkspaceChangedPayload, StringMatchCaseOptions, TenderAllocation, TenderAllocationInput, TenderAmount, TenderDetails, TenderRefundInput, TenderReplaceInput, TenderVoidInput, Variant, VariantGroup };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fire-spark/types",
-  "version": "0.11.0",
+  "version": "0.12.0",
   "description": "Fire Spark public TypeScript types",
   "type": "module",
   "sideEffects": false,