@fire-spark/core 0.0.2 → 0.0.3

package/dist/index.d.ts

@@ -1,11 +1,16 @@
-import { AndConditions, CheckoutMode, CheckoutResolved, Condition, CustomerIdentifyInput, CustomerRegisterInput, CustomerUpdateInput, FulfillmentListInput, GroupDisplayType, KioskDeviceConfig, KioskDeviceOverrides, KioskHealthBatchInput, KioskHealthBatchResult, KioskHeartbeatInput, KioskHeartbeatResult, KioskRealtimeToken, MatchResult, MatchableRule, Menu, Menu as Menu$1, MenuLookup, MenuLookup as MenuLookup$1, ModifierControlType, ModifierGroup, OrConditions, Order as Order$1, Order as Order$2, OrderInsertInput, OrderLine, OrderListInput, OrderRedeem, OrderRedemptionStep, OrderReorderInput, OrderTotals, OrderUpdateInput, OrderValidateInput, OrderValidateOutput, PaymentIntentInput, PaymentMethod, PaymentProvider, PricingModifier, Product, Product as Product$1, Recommendation, RecurringDateCronResult, RecurringDateCronValues, RulesEngineOrderLine, RulesEngineParams, RulesEngineRuntime, Schedule, StoreListInput, StoreNearbyInput, StorefrontAvailability, StorefrontMenuScope, StorefrontMenuStreamOptions, StorefrontPaymentsListInput } from "@fire-spark/types";
+import { AndConditions, CheckoutMode, CheckoutResolved, Condition, CustomerIdentifyInput, CustomerRegisterInput, CustomerUpdateInput, FulfillmentListInput, GroupDisplayType, KioskDeviceConfig, KioskDeviceOverrides, KioskHealthBatchInput, KioskHealthBatchResult, KioskHeartbeatInput, KioskHeartbeatResult, KioskRealtimeToken, MatchResult, MatchableRule, Menu, Menu as Menu$1, MenuLookup, MenuLookup as MenuLookup$1, ModifierControlType, ModifierGroup, OrConditions, Order as Order$1, Order as Order$2, OrderInsertInput, OrderLine, OrderListInput, OrderRedeem, OrderRedemptionStep, OrderReorderInput, OrderTotals, OrderUpdateInput, OrderValidateInput, OrderValidateOutput, PaymentIntentInput, PaymentMethod, PaymentProvider, PricingModifier, Product, Product as Product$1, Recommendation, RecurringDateCronResult, RecurringDateCronValues, RulesEngineOrderLine, RulesEngineParams, RulesEngineRuntime, Schedule, StoreGetInput, StoreListInput, StoreNearbyInput, StorefrontAvailability, StorefrontMenuScope, StorefrontMenuStreamOptions, StorefrontPaymentsListInput, Variant, VariantGroup } from "@fire-spark/types";
+import { Big } from "big.js";
 //#region src/productCustomization/types.d.ts
 type SelectionStatus = "IDLE" | "INCOMPLETE" | "VALID" | "INVALID";
+type StartingPriceCache = Map<string, Big>;
 type CustomizationPath = string;
 type QuantitiesByPath = Record<CustomizationPath, number>;
+type SelectionsByPath = Record<CustomizationPath, VariantSelection>;
 interface Snapshot {
   productId: string;
   quantities: QuantitiesByPath;
+  /** Variant picks of modifiers whose product is a variant base. */
+  variants?: SelectionsByPath;
 }
 interface CreateSessionOptions {
   initial?: QuantitiesByPath;
@@ -50,12 +55,40 @@ interface ModifierCtx {
   status: SelectionStatus;
   data: Product;
   type: ModifierControlType;
+  /** Nested customization; for a variant base, the resolved variant (or the
+   * base while options are pending). */
   product: ProductCtx | null;
+  /** Variant questions when `data` is a variant base; empty otherwise. */
+  variants: VariantGroupCtx[];
+  /** Product that is ordered: `data`, the resolved variant, or null while a
+   * variant base still has unanswered options. */
+  resolved: Product | null;
   onChange: (quantity: number) => void;
   linePrice: number;
 }
+/** Variant group id → chosen variant (option) id. */
+type VariantSelection = Record<string, string>;
+interface VariantOptionCtx {
+  path: CustomizationPath;
+  data: Variant;
+  selected: boolean;
+  disabled: boolean;
+  select: () => void;
+}
+interface VariantGroupCtx {
+  path: CustomizationPath;
+  data: VariantGroup;
+  selectedId: string | null;
+  status: SelectionStatus;
+  options: VariantOptionCtx[];
+}
 interface CustomizationSession {
+  /** Resolved product; the base selector until every variant group is chosen. */
   root: ProductCtx;
+  /** Product carrying variant_group_ids, or null for plain products. */
+  base: Product | null;
+  /** Rendered before modifier groups; empty for plain products. */
+  variants: VariantGroupCtx[];
   subscribe: (listener: () => void) => () => void;
   snapshot: () => Snapshot;
   totalPrice: () => number;
@@ -100,10 +133,18 @@ declare const fromOrderLines: (root: OrderLine, lines: OrderLine[], lookup: Menu
 //#region src/productCustomization/menu.d.ts
 declare const indexMenu: (menu: Menu$1) => MenuLookup$1;
 //#endregion
+//#region src/productCustomization/startingPrice.d.ts
+/** Lowest unit price reachable while satisfying every required modifier.
+ * For a variant base, the cheapest of its variant products. */
+declare const computeStartingPrice: (lookup: MenuLookup$1, product: Product$1, cache?: StartingPriceCache) => number;
+//#endregion
 //#region src/productCustomization/toOrderLines.d.ts
 /** Flatten a customized product tree into priced OrderLine rows. */
 declare const toOrderLines: (root: ProductCtx, locale: string) => OrderLine[];
 //#endregion
+//#region src/productCustomization/variants.d.ts
+declare const isVariantBase: (product: Product$1) => boolean;
+//#endregion
 //#region src/shared/baseUrl.d.ts
 declare const resolveBaseUrl: (baseUrl?: string) => string;
 //#endregion
@@ -2016,7 +2057,7 @@ declare const milestoneTrack: (workflow: TrackWorkflow) => MilestoneTrackItem[];
 declare const milestoneSteps: (workflow: TrackWorkflow, currentNodeIds: string[]) => MilestoneSteps | null;
 //#endregion
 //#region src/order/validate.d.ts
-type OrderLineIssueCode = "PRODUCT_NOT_FOUND" | "HIDDEN" | "OUT_OF_STOCK" | "OUTSIDE_HOURS" | "MODIFIER_NOT_FOUND" | "MODIFIER_RULES_INVALID" | "PRICE_MISMATCH" | "TAX_MISMATCH" | "DISCOUNT_MISMATCH" | "QUANTITY_MISMATCH" | "QUANTITY_BELOW_MINIMUM" | "QUANTITY_ABOVE_MAXIMUM" | "STRUCTURE_MISMATCH" | "FEE_MISMATCH" | "REDEEM_EXPIRED" | "REDEMPTION_STEPS_MISMATCH";
+type OrderLineIssueCode = "PRODUCT_NOT_FOUND" | "HIDDEN" | "OUT_OF_STOCK" | "OUTSIDE_HOURS" | "MODIFIER_NOT_FOUND" | "MODIFIER_RULES_INVALID" | "VARIANT_BASE_NOT_ORDERABLE" | "VARIANT_NOT_OFFERED" | "PRICE_MISMATCH" | "TAX_MISMATCH" | "DISCOUNT_MISMATCH" | "QUANTITY_MISMATCH" | "QUANTITY_BELOW_MINIMUM" | "QUANTITY_ABOVE_MAXIMUM" | "STRUCTURE_MISMATCH" | "FEE_MISMATCH" | "REDEEM_EXPIRED" | "REDEMPTION_STEPS_MISMATCH";
 type OrderIssueCode = "NO_MENU" | "MENU_CLOSED" | "SCOPE_INACTIVE" | "TOTALS_MISMATCH" | "REDEEM_EXPIRED" | "REDEMPTION_STEPS_MISMATCH" | "REDEMPTION_MISMATCH" | "EMPTY_ORDER" | "ITEMS_BELOW_MINIMUM" | "ITEMS_ABOVE_MAXIMUM" | "TOTAL_BELOW_MINIMUM" | "TOTAL_ABOVE_MAXIMUM" | "REDEEMS_ABOVE_MAXIMUM" | "REDEEMS_TOTAL_ABOVE_MAXIMUM" | "SHIPPING_REQUIRED" | "BILLING_REQUIRED" | "SHIPPING_FIELD_REQUIRED" | "BILLING_FIELD_REQUIRED";
 type OrderLineIssue = {
   code: OrderLineIssueCode;
@@ -2734,6 +2775,7 @@ declare const listMenus: (scope?: StorefrontMenuScope, options?: ServiceHttpOpti
       price: number;
       anchor_price?: number | undefined;
       anchor_price_percentage?: number | undefined;
+      starting_price?: number | null | undefined;
       modifiers: {
         modifier_group_id: string;
         default_quantity: number;
@@ -2752,6 +2794,11 @@ declare const listMenus: (scope?: StorefrontMenuScope, options?: ServiceHttpOpti
         anchor_price_percentage?: number | undefined;
       }[];
       modifier_group_ids: string[];
+      variants: {
+        product_id: string;
+        variant_group_option_ids: string[];
+      }[];
+      variant_group_ids: string[];
       recommendations: {
         recommendation_id: string;
         default_quantity: number;
@@ -2839,6 +2886,22 @@ declare const listMenus: (scope?: StorefrontMenuScope, options?: ServiceHttpOpti
     charge_above_quantity?: number | null | undefined;
     metadata: Record<string, unknown>;
   }[];
+  variant_groups: {
+    id: string;
+    title: Record<string, string>;
+    description?: Record<string, string> | null | undefined;
+    display_type?: "GRID" | "LIST" | null | undefined;
+    variants: {
+      id: string;
+      name: Record<string, string>;
+      description?: Record<string, string> | null | undefined;
+      image_url?: string | null | undefined;
+      image_origin_url?: string | null | undefined;
+      product_ids: string[];
+      metadata: Record<string, unknown>;
+    }[];
+    metadata: Record<string, unknown>;
+  }[];
   recommendations: ({
     id: string;
     title: Record<string, string>;
@@ -2929,6 +2992,7 @@ declare const listMenusStream: (scope?: StorefrontMenuScope, options?: ListMenus
       price: number;
       anchor_price?: number | undefined;
       anchor_price_percentage?: number | undefined;
+      starting_price?: number | null | undefined;
       modifiers: {
         modifier_group_id: string;
         default_quantity: number;
@@ -2947,6 +3011,11 @@ declare const listMenusStream: (scope?: StorefrontMenuScope, options?: ListMenus
         anchor_price_percentage?: number | undefined;
       }[];
       modifier_group_ids: string[];
+      variants: {
+        product_id: string;
+        variant_group_option_ids: string[];
+      }[];
+      variant_group_ids: string[];
       recommendations: {
         recommendation_id: string;
         default_quantity: number;
@@ -3034,6 +3103,22 @@ declare const listMenusStream: (scope?: StorefrontMenuScope, options?: ListMenus
     charge_above_quantity?: number | null | undefined;
     metadata: Record<string, unknown>;
   }[];
+  variant_groups: {
+    id: string;
+    title: Record<string, string>;
+    description?: Record<string, string> | null | undefined;
+    display_type?: "GRID" | "LIST" | null | undefined;
+    variants: {
+      id: string;
+      name: Record<string, string>;
+      description?: Record<string, string> | null | undefined;
+      image_url?: string | null | undefined;
+      image_origin_url?: string | null | undefined;
+      product_ids: string[];
+      metadata: Record<string, unknown>;
+    }[];
+    metadata: Record<string, unknown>;
+  }[];
   recommendations: ({
     id: string;
     title: Record<string, string>;
@@ -3305,6 +3390,8 @@ declare const listStores: (input?: StoreListInput, options?: ServiceHttpOptions)
     temporary_closed_until?: string | null | undefined;
     status: "CLOSED" | "OPEN" | "TEMPORARILY_CLOSED";
   };
+  channel_ids: string[];
+  fulfillment_ids: string[];
   tags: Record<string, string | number | boolean>;
   cms_template_id?: string | null | undefined;
   status: string;
@@ -3399,6 +3486,8 @@ declare const listNearbyStores: (input: StoreNearbyInput, options?: ServiceHttpO
     temporary_closed_until?: string | null | undefined;
     status: "CLOSED" | "OPEN" | "TEMPORARILY_CLOSED";
   };
+  channel_ids: string[];
+  fulfillment_ids: string[];
   tags: Record<string, string | number | boolean>;
   cms_template_id?: string | null | undefined;
   status: string;
@@ -3454,7 +3543,7 @@ declare const listNearbyStores: (input: StoreNearbyInput, options?: ServiceHttpO
   } | null | undefined;
   labels: string[];
 }[]>;
-declare const getStore: (id: string, options?: ServiceHttpOptions) => Promise<{
+declare const getStore: (id: string, input?: StoreGetInput, options?: ServiceHttpOptions) => Promise<{
   id: string;
   uid: string;
   merchant_id: string;
@@ -3493,6 +3582,8 @@ declare const getStore: (id: string, options?: ServiceHttpOptions) => Promise<{
     temporary_closed_until?: string | null | undefined;
     status: "CLOSED" | "OPEN" | "TEMPORARILY_CLOSED";
   };
+  channel_ids: string[];
+  fulfillment_ids: string[];
   tags: Record<string, string | number | boolean>;
   cms_template_id?: string | null | undefined;
   status: string;
@@ -3766,4 +3857,4 @@ declare const paymentMatchesClientConditions: (conditions: OrConditions | null |
   now?: string;
 }) => boolean;
 //#endregion
-export { type ApplyRedeemInput, type AuthConfigureOptions, type CreateOrderOptions, type CreateSessionOptions, type CustomizationPath, type CustomizationSession, DEFAULT_RECOMMENDATION_TYPES, type ExchangeOptions, type FlatMenuCategory, type GroupDisplayType, type IdBuilder, type ListMenusStreamOptions, type Menu, type MenuCategoryNode, type MenuLookup, type MilestoneSteps, type MilestoneTrackItem, type ModifierControlType, type ModifierCtx, type ModifierGroupCtx, type NestedMenuCategory, Order, type OrderCustomerSource, type OrderDraft, type OrderIssue, type OrderIssueCode, type OrderLineDiff, type OrderLineIssue, type OrderLineIssueCode, type OrderScope, OrderSyncPendingError, OrderValidationError, type OrderValidationResult, type PricingModifier, type Product, type ProductCtx, type QuantitiesByPath, type RecommendationType, RecurringDateCron, type RemoveRedeemInput, type ReorderOrderOptions, type ResetOptions, RulesEngine, type ScheduleWindow, type SelectionStatus, type ServiceHttpOptions, type Snapshot, type StorefrontAccessToken, StorefrontHttpError, type TrackWorkflow, type ValidateOptions, type ValidateOrderAgainstMenuInput, type VisitedState, addLines, auth, buildCustomerSnapshot, collectOrderLineDiffs, countCartProducts, createSession, currentNodes, defaultConditionError, flattenMenuCategories, fromOrderLines, genId, genOrderId, getScheduleWindow, indexMenu, isCheckoutFieldFilled, isDeviceNotLinked, isKioskUnauthorized, isMilestoneStepDone, isOnSchedule, isOrderValidationError, isStorefrontNotFound, listMenusStream, matchAbsoluteDateOperator, matchBooleanOperator, matchCurrencyOperator, matchEnumOperator, matchNumberOperator, matchRecurringDateOperator, matchRelativeDateOperator, matchStringOperator, milestoneSteps, milestoneTrack, nestMenuCategories, paymentMatchesClientConditions, recomputeRedemptions, recomputeTotals, resolveCheckout, services, storefrontJson, toOrderLines, validateOrderAgainstMenu, visitedStates };
+export { type ApplyRedeemInput, type AuthConfigureOptions, type CreateOrderOptions, type CreateSessionOptions, type CustomizationPath, type CustomizationSession, DEFAULT_RECOMMENDATION_TYPES, type ExchangeOptions, type FlatMenuCategory, type GroupDisplayType, type IdBuilder, type ListMenusStreamOptions, type Menu, type MenuCategoryNode, type MenuLookup, type MilestoneSteps, type MilestoneTrackItem, type ModifierControlType, type ModifierCtx, type ModifierGroupCtx, type NestedMenuCategory, Order, type OrderCustomerSource, type OrderDraft, type OrderIssue, type OrderIssueCode, type OrderLineDiff, type OrderLineIssue, type OrderLineIssueCode, type OrderScope, OrderSyncPendingError, OrderValidationError, type OrderValidationResult, type PricingModifier, type Product, type ProductCtx, type QuantitiesByPath, type RecommendationType, RecurringDateCron, type RemoveRedeemInput, type ReorderOrderOptions, type ResetOptions, RulesEngine, type ScheduleWindow, type SelectionStatus, type SelectionsByPath, type ServiceHttpOptions, type Snapshot, type StorefrontAccessToken, StorefrontHttpError, type TrackWorkflow, type ValidateOptions, type ValidateOrderAgainstMenuInput, type Variant, type VariantGroup, type VariantGroupCtx, type VariantOptionCtx, type VariantSelection, type VisitedState, addLines, auth, buildCustomerSnapshot, collectOrderLineDiffs, computeStartingPrice, countCartProducts, createSession, currentNodes, defaultConditionError, flattenMenuCategories, fromOrderLines, genId, genOrderId, getScheduleWindow, indexMenu, isCheckoutFieldFilled, isDeviceNotLinked, isKioskUnauthorized, isMilestoneStepDone, isOnSchedule, isOrderValidationError, isStorefrontNotFound, isVariantBase, listMenusStream, matchAbsoluteDateOperator, matchBooleanOperator, matchCurrencyOperator, matchEnumOperator, matchNumberOperator, matchRecurringDateOperator, matchRelativeDateOperator, matchStringOperator, milestoneSteps, milestoneTrack, nestMenuCategories, paymentMatchesClientConditions, recomputeRedemptions, recomputeTotals, resolveCheckout, services, storefrontJson, toOrderLines, validateOrderAgainstMenu, visitedStates };