@fire-spark/types 0.1.1 → 0.2.0

package/dist/index.d.ts

@@ -37,6 +37,43 @@ interface Category {
   metadata?: Metadata;
 }
 //#endregion
+//#region .flat/src/channel-manifest.d.ts
+type ChannelTemplate = "server" | "web" | "app" | "kiosk" | "pos" | "call-center" | "chat";
+type ChannelPlatform = "server" | "web" | "android" | "ios";
+/** PWA manifest of a web channel. */
+interface ChannelManifestWeb {
+  shortName: string;
+  themeColor: string;
+  backgroundColor: string;
+}
+/** Store identifiers of an Expo channel. */
+interface ChannelManifestNative {
+  /** Null when the channel is Android only (kiosk, POS). */
+  iosBundleIdentifier: string | null;
+  androidPackage: string;
+  /** Deep link scheme, without `://`. */
+  scheme: string;
+}
+/**
+ * `channel-manifest.ts` of each app in a repo generated by the Fire Spark
+ * Builder. Values that templates used to hardcode live here.
+ */
+interface ChannelManifest {
+  /** Fire Spark channel id (not the uid); null for the server. */
+  id: string | null;
+  template: ChannelTemplate;
+  name: string;
+  /** kebab-case name used for packages, folders and services. */
+  slug: string;
+  /** Port of `pnpm start`: 3000 for the server, 3001+ for channels. */
+  port: number;
+  platforms: ChannelPlatform[];
+  /** Default locale first, then up to 2 extra locales. */
+  locales: string[];
+  web?: ChannelManifestWeb;
+  native?: ChannelManifestNative;
+}
+//#endregion
 //#region .flat/src/customer.d.ts
 /** Storefront customer (`GET` / `POST` / identify response `data`). */
 type Customer = {
@@ -1745,6 +1782,7 @@ type OrderLine = {
     quantity: number;
     discount_rate?: number | undefined;
     discount_amount?: number | undefined;
+    before_taxes?: boolean | undefined;
     expires_at?: string | undefined;
   }[];
   quantity: number;
@@ -1773,6 +1811,7 @@ type OrderRedeem = {
   quantity: number;
   discount_rate?: number | undefined;
   discount_amount?: number | undefined;
+  before_taxes?: boolean | undefined;
   expires_at?: string | undefined;
 };
 /** Redeem as sent by callers (`quantity` defaults to 1). */
@@ -1781,6 +1820,7 @@ type OrderRedeemInput = {
   quantity?: number | undefined;
   discount_rate?: number | undefined;
   discount_amount?: number | undefined;
+  before_taxes?: boolean | undefined;
   expires_at?: string | undefined;
 };
 /** Order or line snapshot before/after a redemption step. */
@@ -1866,6 +1906,7 @@ type Order = {
       quantity: number;
       discount_rate?: number | undefined;
       discount_amount?: number | undefined;
+      before_taxes?: boolean | undefined;
       expires_at?: string | undefined;
     }[];
     quantity: number;
@@ -1893,6 +1934,7 @@ type Order = {
     quantity: number;
     discount_rate?: number | undefined;
     discount_amount?: number | undefined;
+    before_taxes?: boolean | undefined;
     expires_at?: string | undefined;
   }[];
   redemption_steps: {
@@ -2157,6 +2199,7 @@ type OrderInsertInput = {
       quantity?: number | undefined;
       discount_rate?: number | undefined;
       discount_amount?: number | undefined;
+      before_taxes?: boolean | undefined;
       expires_at?: string | undefined;
     }[] | undefined;
     quantity: number;
@@ -2184,6 +2227,7 @@ type OrderInsertInput = {
     quantity?: number | undefined;
     discount_rate?: number | undefined;
     discount_amount?: number | undefined;
+    before_taxes?: boolean | undefined;
     expires_at?: string | undefined;
   }[] | undefined;
   redemption_steps?: {
@@ -2323,6 +2367,7 @@ type OrderUpdateInput = {
       quantity?: number | undefined;
       discount_rate?: number | undefined;
       discount_amount?: number | undefined;
+      before_taxes?: boolean | undefined;
       expires_at?: string | undefined;
     }[] | undefined;
     quantity: number;
@@ -2350,6 +2395,7 @@ type OrderUpdateInput = {
     quantity?: number | undefined;
     discount_rate?: number | undefined;
     discount_amount?: number | undefined;
+    before_taxes?: boolean | undefined;
     expires_at?: string | undefined;
   }[] | undefined;
   redemption_steps?: {
@@ -2457,6 +2503,7 @@ type OrderValidateInput = {
       quantity?: number | undefined;
       discount_rate?: number | undefined;
       discount_amount?: number | undefined;
+      before_taxes?: boolean | undefined;
       expires_at?: string | undefined;
     }[] | undefined;
     quantity: number;
@@ -2484,6 +2531,7 @@ type OrderValidateInput = {
     quantity?: number | undefined;
     discount_rate?: number | undefined;
     discount_amount?: number | undefined;
+    before_taxes?: boolean | undefined;
     expires_at?: string | undefined;
   }[] | undefined;
   redemption_steps?: {
@@ -2706,6 +2754,7 @@ type PosOrderInput = {
       quantity?: number | undefined;
       discount_rate?: number | undefined;
       discount_amount?: number | undefined;
+      before_taxes?: boolean | undefined;
       expires_at?: string | undefined;
     }[] | undefined;
     quantity: number;
@@ -3148,4 +3197,4 @@ interface CheckoutResolved {
   billingFields: Record<string, CheckoutMode>;
 }
 //#endregion
-export type { AddressInfo, AndConditions, BillingInfo, BillingProfile, BundledItem, Category, CategoryAvailability, CategoryItem, 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, KioskHealthBatchInput, KioskHealthBatchResult, KioskHealthSample, KioskHeartbeatHealth, KioskHeartbeatInput, KioskHeartbeatResult, KioskOrderPager, KioskPagerSide, KioskPagersOverrides, KioskPagersSettings, KioskRealtimeToken, MatchResult, MatchableRule, Menu, MenuLookup, MerchantPayment, Metadata, ModifierControlType, ModifierGroup, MultiLanguageText, OrConditions, Order, OrderChangedCallback, OrderChangedCallbackError, OrderChangedCheckoutState, OrderChangedError, OrderChangedPayload, OrderChangedRunStatus, OrderFulfillment, OrderInsertInput, OrderLine, OrderListInput, OrderRecordPaymentInput, OrderRedeem, OrderRedeemInput, OrderRedemptionState, OrderRedemptionStep, OrderReorderInput, OrderTotals, OrderUpdateInput, OrderValidateInput, OrderValidateOutput, Payment, PaymentIntent, PaymentIntentInput, PaymentMethod, PaymentProvider, PlaceOrderResult, PosActorKind, PosCashBreakdownItem, PosCatalog, PosDenominationKind, PosDeviceConfigDevice, PosDeviceConfigScope, PosDeviceOverrides, PosErrorCode, PosHealthBatchInput, PosHealthBatchResult, PosHealthSample, PosHeartbeatHealth, PosHeartbeatInput, PosHeartbeatResult, PosKioskOrder, PosKioskSettleInput, PosKioskSettleResult, PosOrderInput, PosOrderResult, PosStaff, 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, 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, KioskHealthBatchInput, KioskHealthBatchResult, KioskHealthSample, KioskHeartbeatHealth, KioskHeartbeatInput, KioskHeartbeatResult, KioskOrderPager, KioskPagerSide, KioskPagersOverrides, KioskPagersSettings, KioskRealtimeToken, MatchResult, MatchableRule, Menu, MenuLookup, MerchantPayment, Metadata, ModifierControlType, ModifierGroup, MultiLanguageText, OrConditions, Order, OrderChangedCallback, OrderChangedCallbackError, OrderChangedCheckoutState, OrderChangedError, OrderChangedPayload, OrderChangedRunStatus, OrderFulfillment, OrderInsertInput, OrderLine, OrderListInput, OrderRecordPaymentInput, OrderRedeem, OrderRedeemInput, OrderRedemptionState, OrderRedemptionStep, OrderReorderInput, OrderTotals, OrderUpdateInput, OrderValidateInput, OrderValidateOutput, Payment, PaymentIntent, PaymentIntentInput, PaymentMethod, PaymentProvider, PlaceOrderResult, PosActorKind, PosCashBreakdownItem, PosCatalog, PosDenominationKind, PosDeviceConfigDevice, PosDeviceConfigScope, PosDeviceOverrides, PosErrorCode, PosHealthBatchInput, PosHealthBatchResult, PosHealthSample, PosHeartbeatHealth, PosHeartbeatInput, PosHeartbeatResult, PosKioskOrder, PosKioskSettleInput, PosKioskSettleResult, PosOrderInput, PosOrderResult, PosStaff, 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, Variant, VariantGroup };

package/package.json

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