@fire-spark/types 0.4.1 → 0.6.0

package/dist/index.d.ts

@@ -48,7 +48,7 @@ interface ChannelManifestWeb {
 }
 /** Store identifiers of an Expo channel. */
 interface ChannelManifestNative {
-  /** Null when the channel is Android only (kiosk, POS). */
+  /** Null when the template does not target iOS. */
   iosBundleIdentifier: string | null;
   androidPackage: string;
   /** Deep link scheme, without `://`. */
@@ -65,7 +65,11 @@ interface ChannelManifest {
   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 assigned to the app. The server uses 3000 and each Next.js channel
+   * uses the next port for `pnpm start`. Expo channels keep the number for
+   * the builder's static screen checks; Metro chooses its own port.
+   */
   port: number;
   platforms: ChannelPlatform[];
   /**
@@ -1797,12 +1801,10 @@ type OrderLine = {
   redeem: {
     reward_id: string;
     quantity: number;
-    discount_rate?: number | undefined;
-    discount_amount?: number | undefined;
     before_taxes?: boolean | undefined;
     expires_at?: string | undefined;
-    payment_id?: string | undefined;
-    amount?: number | undefined;
+    payment_id: string;
+    amount: number;
   }[];
   quantity: number;
   tax_rate: number | null;
@@ -1824,39 +1826,45 @@ type OrderLine = {
   group_tax_total: number;
   group_total: number;
 };
-/** Reward redeemed on an order or line (Masivo-style). */
+/**
+ * Redeem applied to an order or a root line (points, voucher, free
+ * product…): `payment_id` and `amount` are required. `amount` is the
+ * discount shown to the customer and is paid by the REDEMPTION tender of
+ * `payment_id`; line and order totals keep their full value.
+ */
 type OrderRedeem = {
   reward_id: string;
   quantity: number;
-  discount_rate?: number | undefined;
-  discount_amount?: number | undefined;
   before_taxes?: boolean | undefined;
   expires_at?: string | undefined;
-  payment_id?: string | undefined;
-  amount?: number | undefined;
+  payment_id: string;
+  amount: number;
 };
 /** Redeem as sent by callers (`quantity` defaults to 1). */
 type OrderRedeemInput = {
   reward_id: string;
   quantity?: number | undefined;
-  discount_rate?: number | undefined;
-  discount_amount?: number | undefined;
   before_taxes?: boolean | undefined;
   expires_at?: string | undefined;
-  payment_id?: string | undefined;
-  amount?: number | undefined;
+  payment_id: string;
+  amount: number;
 };
-/** Order or line snapshot before/after a redemption step. */
+/** Order or line at one redemption step (what is left and covered). */
 type OrderRedemptionState = {
   value: number;
   quantity: number;
   discount_amount: number;
   discount_rate: number;
 };
-/** One applied redeem, persisted in application order. */
+/**
+ * One applied redeem, in application order. `discount_amount` equals the
+ * capped redeem `amount` its REDEMPTION tender pays.
+ */
 type OrderRedemptionStep = {
   reward_id: string;
   reward_quantity: number;
+  payment_id: string;
+  before_taxes: boolean;
   target: "LINE" | "ORDER";
   target_id?: string | undefined;
   action: "CREATE" | "DELETE" | "READ" | "UPDATE";
@@ -1927,12 +1935,10 @@ type Order = {
     redeem: {
       reward_id: string;
       quantity: number;
-      discount_rate?: number | undefined;
-      discount_amount?: number | undefined;
       before_taxes?: boolean | undefined;
       expires_at?: string | undefined;
-      payment_id?: string | undefined;
-      amount?: number | undefined;
+      payment_id: string;
+      amount: number;
     }[];
     quantity: number;
     tax_rate: number | null;
@@ -1957,16 +1963,16 @@ type Order = {
   redeem: {
     reward_id: string;
     quantity: number;
-    discount_rate?: number | undefined;
-    discount_amount?: number | undefined;
     before_taxes?: boolean | undefined;
     expires_at?: string | undefined;
-    payment_id?: string | undefined;
-    amount?: number | undefined;
+    payment_id: string;
+    amount: number;
   }[];
   redemption_steps: {
     reward_id: string;
     reward_quantity: number;
+    payment_id: string;
+    before_taxes: boolean;
     target: "LINE" | "ORDER";
     target_id?: string | undefined;
     action: "CREATE" | "DELETE" | "READ" | "UPDATE";
@@ -2079,13 +2085,6 @@ type Order = {
       status: "CANCELLED" | "FAILED" | "IDLE" | "PAID" | "PENDING" | "REFUNDED";
       amount: {
         currency: string;
-        subtotal: number;
-        discount_total: number;
-        tax_total: number;
-        fees: number;
-        tip: number;
-        delivery: number;
-        redemptions_applied: number;
         total: number;
       };
       refunded_total: number;
@@ -2098,16 +2097,10 @@ type Order = {
         amounts: {
           line_uid: string;
           units?: number | undefined;
-          subtotal: number;
-          discount: number;
-          tax: number;
           total: number;
           children: {
             line_uid: string;
             quantity: number;
-            subtotal: number;
-            discount: number;
-            tax: number;
             total: number;
           }[];
         }[];
@@ -2264,13 +2257,6 @@ type PaymentIntent = {
     status: "CANCELLED" | "FAILED" | "IDLE" | "PAID" | "PENDING" | "REFUNDED";
     amount: {
       currency: string;
-      subtotal: number;
-      discount_total: number;
-      tax_total: number;
-      fees: number;
-      tip: number;
-      delivery: number;
-      redemptions_applied: number;
       total: number;
     };
     refunded_total: number;
@@ -2283,16 +2269,10 @@ type PaymentIntent = {
       amounts: {
         line_uid: string;
         units?: number | undefined;
-        subtotal: number;
-        discount: number;
-        tax: number;
         total: number;
         children: {
           line_uid: string;
           quantity: number;
-          subtotal: number;
-          discount: number;
-          tax: number;
           total: number;
         }[];
       }[];
@@ -2401,13 +2381,6 @@ type PaymentIntentInput = {
     status: "CANCELLED" | "FAILED" | "IDLE" | "PAID" | "PENDING" | "REFUNDED";
     amount: {
       currency: string;
-      subtotal: number;
-      discount_total: number;
-      tax_total: number;
-      fees?: number | undefined;
-      tip?: number | undefined;
-      delivery?: number | undefined;
-      redemptions_applied?: number | undefined;
       total: number;
     };
     refunded_total?: number | undefined;
@@ -2420,16 +2393,10 @@ type PaymentIntentInput = {
       amounts?: {
         line_uid: string;
         units?: number | undefined;
-        subtotal: number;
-        discount: number;
-        tax: number;
         total: number;
         children?: {
           line_uid: string;
           quantity: number;
-          subtotal: number;
-          discount: number;
-          tax: number;
           total: number;
         }[] | undefined;
       }[] | undefined;
@@ -2514,13 +2481,6 @@ type PaymentTender = {
   status: "CANCELLED" | "FAILED" | "IDLE" | "PAID" | "PENDING" | "REFUNDED";
   amount: {
     currency: string;
-    subtotal: number;
-    discount_total: number;
-    tax_total: number;
-    fees: number;
-    tip: number;
-    delivery: number;
-    redemptions_applied: number;
     total: number;
   };
   refunded_total: number;
@@ -2533,16 +2493,10 @@ type PaymentTender = {
     amounts: {
       line_uid: string;
       units?: number | undefined;
-      subtotal: number;
-      discount: number;
-      tax: number;
       total: number;
       children: {
         line_uid: string;
         quantity: number;
-        subtotal: number;
-        discount: number;
-        tax: number;
         total: number;
       }[];
     }[];
@@ -2613,13 +2567,6 @@ type PaymentTender = {
 /** Money one tender charges. */
 type TenderAmount = {
   currency: string;
-  subtotal: number;
-  discount_total: number;
-  tax_total: number;
-  fees: number;
-  tip: number;
-  delivery: number;
-  redemptions_applied: number;
   total: number;
 };
 /** Lines / fees a tender covers, with server-computed amounts. */
@@ -2632,16 +2579,10 @@ type TenderAllocation = {
   amounts: {
     line_uid: string;
     units?: number | undefined;
-    subtotal: number;
-    discount: number;
-    tax: number;
     total: number;
     children: {
       line_uid: string;
       quantity: number;
-      subtotal: number;
-      discount: number;
-      tax: number;
       total: number;
     }[];
   }[];
@@ -2895,7 +2836,7 @@ type MixedPaymentsEffect = {
   }>>;
 };
 /** `details.code` of intent / tender API errors. */
-type PaymentErrorCode = "MIXED_PAYMENTS_DISABLED" | "PAYMENT_AMOUNT_EXCEEDED" | "PAYMENT_INTENT_LOCKED" | "PAYMENT_INTENT_STALE" | "PAYMENT_INVALID_ALLOCATION" | "PAYMENT_INVALID_COMBINATION" | "PAYMENT_INVALID_PRIMARY" | "PAYMENT_LINE_NOT_SPLITTABLE" | "PAYMENT_METHOD_UNAVAILABLE" | "PAYMENT_REDEMPTION_EXCEEDED" | "PAYMENT_REDEMPTION_MISMATCH" | "PAYMENT_TOO_MANY_ITEMS" | "PAYMENT_TOO_MANY_METHODS" | "PAYMENT_UNALLOCATED_LINES" | "REDEEM_PAYMENT_METHOD_NOT_CONFIGURED";
+type PaymentErrorCode = "MIXED_PAYMENTS_DISABLED" | "PAYMENT_AMOUNT_EXCEEDED" | "PAYMENT_INTENT_LOCKED" | "PAYMENT_INTENT_STALE" | "PAYMENT_INVALID_ALLOCATION" | "PAYMENT_INVALID_COMBINATION" | "PAYMENT_INVALID_PRIMARY" | "PAYMENT_LINE_NOT_SPLITTABLE" | "PAYMENT_METHOD_UNAVAILABLE" | "PAYMENT_REDEMPTION_EXCEEDED" | "PAYMENT_REDEMPTION_MISMATCH" | "PAYMENT_REQUIRED" | "PAYMENT_TOO_MANY_ITEMS" | "PAYMENT_TOO_MANY_METHODS" | "PAYMENT_UNALLOCATED_LINES" | "REDEEM_PAYMENT_METHOD_NOT_CONFIGURED";
 /** `POST /storefront/v1/orders` body. */
 type OrderInsertInput = {
   id: string;
@@ -2967,12 +2908,10 @@ type OrderInsertInput = {
     redeem?: {
       reward_id: string;
       quantity?: number | undefined;
-      discount_rate?: number | undefined;
-      discount_amount?: number | undefined;
       before_taxes?: boolean | undefined;
       expires_at?: string | undefined;
-      payment_id?: string | undefined;
-      amount?: number | undefined;
+      payment_id: string;
+      amount: number;
     }[] | undefined;
     quantity: number;
     tax_rate: number | null;
@@ -2997,16 +2936,16 @@ type OrderInsertInput = {
   redeem?: {
     reward_id: string;
     quantity?: number | undefined;
-    discount_rate?: number | undefined;
-    discount_amount?: number | undefined;
     before_taxes?: boolean | undefined;
     expires_at?: string | undefined;
-    payment_id?: string | undefined;
-    amount?: number | undefined;
+    payment_id: string;
+    amount: number;
   }[] | undefined;
   redemption_steps?: {
     reward_id: string;
     reward_quantity: number;
+    payment_id: string;
+    before_taxes: boolean;
     target: "LINE" | "ORDER";
     target_id?: string | undefined;
     action: "CREATE" | "DELETE" | "READ" | "UPDATE";
@@ -3117,12 +3056,10 @@ type OrderUpdateInput = {
     redeem?: {
       reward_id: string;
       quantity?: number | undefined;
-      discount_rate?: number | undefined;
-      discount_amount?: number | undefined;
       before_taxes?: boolean | undefined;
       expires_at?: string | undefined;
-      payment_id?: string | undefined;
-      amount?: number | undefined;
+      payment_id: string;
+      amount: number;
     }[] | undefined;
     quantity: number;
     tax_rate: number | null;
@@ -3147,16 +3084,16 @@ type OrderUpdateInput = {
   redeem?: {
     reward_id: string;
     quantity?: number | undefined;
-    discount_rate?: number | undefined;
-    discount_amount?: number | undefined;
     before_taxes?: boolean | undefined;
     expires_at?: string | undefined;
-    payment_id?: string | undefined;
-    amount?: number | undefined;
+    payment_id: string;
+    amount: number;
   }[] | undefined;
   redemption_steps?: {
     reward_id: string;
     reward_quantity: number;
+    payment_id: string;
+    before_taxes: boolean;
     target: "LINE" | "ORDER";
     target_id?: string | undefined;
     action: "CREATE" | "DELETE" | "READ" | "UPDATE";
@@ -3235,12 +3172,10 @@ type OrderValidateInput = {
     redeem?: {
       reward_id: string;
       quantity?: number | undefined;
-      discount_rate?: number | undefined;
-      discount_amount?: number | undefined;
       before_taxes?: boolean | undefined;
       expires_at?: string | undefined;
-      payment_id?: string | undefined;
-      amount?: number | undefined;
+      payment_id: string;
+      amount: number;
     }[] | undefined;
     quantity: number;
     tax_rate: number | null;
@@ -3265,16 +3200,16 @@ type OrderValidateInput = {
   redeem?: {
     reward_id: string;
     quantity?: number | undefined;
-    discount_rate?: number | undefined;
-    discount_amount?: number | undefined;
     before_taxes?: boolean | undefined;
     expires_at?: string | undefined;
-    payment_id?: string | undefined;
-    amount?: number | undefined;
+    payment_id: string;
+    amount: number;
   }[] | undefined;
   redemption_steps?: {
     reward_id: string;
     reward_quantity: number;
+    payment_id: string;
+    before_taxes: boolean;
     target: "LINE" | "ORDER";
     target_id?: string | undefined;
     action: "CREATE" | "DELETE" | "READ" | "UPDATE";
@@ -3525,12 +3460,10 @@ type PosOrderInput = {
     redeem?: {
       reward_id: string;
       quantity?: number | undefined;
-      discount_rate?: number | undefined;
-      discount_amount?: number | undefined;
       before_taxes?: boolean | undefined;
       expires_at?: string | undefined;
-      payment_id?: string | undefined;
-      amount?: number | undefined;
+      payment_id: string;
+      amount: number;
     }[] | undefined;
     quantity: number;
     tax_rate: number | null;

package/package.json

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