@propeller-commerce/propeller-v2-react-ui 0.4.13 → 0.4.15

package/dist/index.d.cts

@@ -673,14 +673,32 @@ interface UseCheckoutOptions {
 interface PlaceOrderOptions {
     /** Id of the cart to convert. */
     cartId: string;
-    /** Order status to set — `'NEW'` for an order, `'REQUEST'` for a quote request. */
-    orderStatus: 'NEW' | 'REQUEST';
+    /**
+     * Order status to set. `'NEW'` for a completed order, `'REQUEST'` for a quote
+     * request, `'UNFINISHED'` for an order awaiting an external payment (PSP) — the
+     * payment webhook promotes it to its final status later. Any other backend
+     * status string is also accepted.
+     */
+    orderStatus: 'NEW' | 'REQUEST' | 'UNFINISHED' | (string & {});
     /** Customer reference printed on the order. */
     reference?: string;
     /** Free-text order notes. */
     notes?: string;
     /** When `true`, treats this as a quote: suppresses confirmation email/PDF and triggers a quote-send request. */
     isQuoteMode?: boolean;
+    /**
+     * Whether this placement *finalizes* the order — i.e. sends the order
+     * confirmation email, fires the confirm event, attaches the order PDF, and
+     * clears the cart. Defaults to `true` for a normal order and `false` for a
+     * quote.
+     *
+     * Set this to `false` for an order that still awaits an external payment
+     * (e.g. `'UNFINISHED'` orders handed off to a PSP). The confirmation/cart
+     * deletion should then happen when the payment is confirmed (the PSP webhook),
+     * not at placement — otherwise the shopper is emailed and the cart cleared
+     * before they've paid.
+     */
+    finalizeOrder?: boolean;
 }
 /** State and checkout actions returned by {@link useCheckout}. */
 interface UseCheckoutReturn {

package/dist/index.d.ts

@@ -673,14 +673,32 @@ interface UseCheckoutOptions {
 interface PlaceOrderOptions {
     /** Id of the cart to convert. */
     cartId: string;
-    /** Order status to set — `'NEW'` for an order, `'REQUEST'` for a quote request. */
-    orderStatus: 'NEW' | 'REQUEST';
+    /**
+     * Order status to set. `'NEW'` for a completed order, `'REQUEST'` for a quote
+     * request, `'UNFINISHED'` for an order awaiting an external payment (PSP) — the
+     * payment webhook promotes it to its final status later. Any other backend
+     * status string is also accepted.
+     */
+    orderStatus: 'NEW' | 'REQUEST' | 'UNFINISHED' | (string & {});
     /** Customer reference printed on the order. */
     reference?: string;
     /** Free-text order notes. */
     notes?: string;
     /** When `true`, treats this as a quote: suppresses confirmation email/PDF and triggers a quote-send request. */
     isQuoteMode?: boolean;
+    /**
+     * Whether this placement *finalizes* the order — i.e. sends the order
+     * confirmation email, fires the confirm event, attaches the order PDF, and
+     * clears the cart. Defaults to `true` for a normal order and `false` for a
+     * quote.
+     *
+     * Set this to `false` for an order that still awaits an external payment
+     * (e.g. `'UNFINISHED'` orders handed off to a PSP). The confirmation/cart
+     * deletion should then happen when the payment is confirmed (the PSP webhook),
+     * not at placement — otherwise the shopper is emailed and the cart cleared
+     * before they've paid.
+     */
+    finalizeOrder?: boolean;
 }
 /** State and checkout actions returned by {@link useCheckout}. */
 interface UseCheckoutReturn {

package/dist/index.js

@@ -995,6 +995,8 @@ function useCheckout(options) {
         const cartService = createServices(graphqlClient).cart;
         const orderService = createServices(graphqlClient).order;
         const { cartId, orderStatus, reference, notes, isQuoteMode } = opts;
+        const finalizeOrder = opts.finalizeOrder ?? true;
+        const sendConfirmation = finalizeOrder && !isQuoteMode;
         if (reference || notes) {
           await cartService.updateCart({
             id: cartId,
@@ -1016,10 +1018,13 @@ function useCheckout(options) {
           orderId,
           status: orderStatus,
           payStatus: PaymentStatuses.OPEN,
-          sendOrderConfirmationEmail: !isQuoteMode,
-          addPDFAttachment: !isQuoteMode,
-          triggerOrderSendConfirmEvent: !isQuoteMode,
-          deleteCart: true
+          sendOrderConfirmationEmail: sendConfirmation,
+          addPDFAttachment: sendConfirmation,
+          triggerOrderSendConfirmEvent: sendConfirmation,
+          // Keep the cart only for an unfinalized (PSP-pending) order so the
+          // shopper can retry payment; clear it once the order is finalized
+          // (a normal order or a quote).
+          deleteCart: finalizeOrder
         });
         if (isQuoteMode) {
           await orderService.triggerQuoteSendRequest({ orderId, language });