@misiki/gocommerce-connector 0.31.0 → 0.32.0

package/README.md

@@ -137,7 +137,7 @@ down stays best-effort: the storefront renders from its static record.
 | You may also like | `/api/cross-sells?product_id=` — `productService.listCrossSells({ product })`, curated only; the bag's `/api/carts/{token}/cross-sells` — `cartService.listCrossSells()`, which includes the collection the shop chose for every basket (D134), falling back to the first item's related products |
 | the bag's offers and free delivery | `/api/carts/{token}/offers` — `cartService.getOffers()` and the coupon drawer's `couponService.listCoupons()`: only the codes the shop chose to show; `/api/carts/{token}/free-shipping` — `cartService.getFreeShipping()`, from the store's own rates, null when it cannot say |
 | delivery options | `/api/checkout/rates` |
-| payment methods | `/api/checkout` — cash on delivery, Razorpay, and the first hosted-page gateway (see below) |
+| payment methods | `/api/checkout` — cash on delivery, Razorpay, Cashfree on a rupee store, and the hosted-page gateways (see below) |
 | place order | `POST /api/checkout/{code}` with an `Idempotency-Key` |
 | order lookup | `/api/orders/{number}?token=` (guest), `/x/identity/me/orders` (account) |
 | sign-in, sign-up, profile, password reset | `/x/identity/*` |
@@ -227,13 +227,14 @@ Each of these is a real gap, listed so nobody has to find it in production.
   of a request to exactly `/api/products/<slug>`; the engine's slug route is
   `/api/products/slug/<slug>`, and `/api/products/<slug>` answers 400 for a
   non-numeric id.
-- **Payment.** The storefront drives a fixed list of gateway flows and passes
-  none of them the gateway the shopper chose. Cash on delivery and Razorpay's
-  modal match engine gateways directly. The storefront's redirect flow (which it
+- **Payment.** The storefront drives a fixed list of gateway flows. Cash on delivery and Razorpay's
+  modal match engine gateways directly, and so does Cashfree's on a rupee store,
+  under a neutral card icon. The storefront's redirect flow (which it
   reaches by the code `PAYPAL`) carries the store's first hosted-page gateway —
-  Adyen, Paddle, Lemon Squeezy, Creem, Hyperswitch or RevenueCat — under that
-  gateway's own name and a neutral card icon; a second one cannot be told apart
-  from the first and is not offered. GoCommerce's Stripe is a Payment Element (a
+  PayPal, Adyen, Paddle, Lemon Squeezy, Creem, Hyperswitch or RevenueCat — under that
+  gateway's own name and a neutral card icon. Any further one gets its own code and
+  `redirects: true`, which needs `@misiki/kitcommerce-core` 0.1.60 or later to reach
+  its page. GoCommerce's Stripe is a Payment Element (a
   client secret), which this storefront does not mount. Every method left off is
   reported once in the console, and every one is reachable through
   `checkoutService.checkout(code)` for a storefront that drives its own payment

package/dist/{index-CSqvRZQ4.d.cts → index-BAmkQfij.d.cts}

@@ -862,6 +862,8 @@ type CartExtras = {
         body: string;
         meta?: Record<string, string>;
         attribution?: Record<string, unknown>;
+        /** What placed the order, while its gateway's window can be opened again: see CheckoutService.place. */
+        placed?: Record<string, unknown>;
     } | null;
 };
 
@@ -4721,12 +4723,12 @@ declare class CheckoutService extends BaseService {
     checkoutStripeCapture(): Promise<never>;
     /**
      * The storefront's generic redirect flow, which it reaches through the code
-     * `PAYPAL`. The engine has no PayPal gateway; paymentMethodService puts the
-     * store's first hosted-page gateway — Adyen, Paddle, Lemon Squeezy, Creem,
-     * Hyperswitch or RevenueCat — under that code, with its own name and a
-     * neutral icon, because this is the one storefront flow that sends a shopper
-     * to a URL and back. The shopper returns to the success page; the gateway's
-     * webhook tells the engine the order is paid.
+     * `PAYPAL`. paymentMethodService puts the store's first hosted-page gateway
+     * — PayPal, Adyen, Paddle, Lemon Squeezy, Creem, Hyperswitch or RevenueCat —
+     * under that code, with its own name and a neutral icon, because this is the
+     * one storefront flow that sends a shopper to a URL and back. The shopper
+     * returns to the success page; the gateway's webhook tells the engine the
+     * order is paid. PayPal's webhook is also what captures the approved payment.
      */
     checkoutPaypal({ cartId, origin }?: {
         cartId?: string;
@@ -4750,8 +4752,38 @@ declare class CheckoutService extends BaseService {
         order_no: string | null;
         status: string;
     }>;
-    checkoutCashfree(): Promise<never>;
-    captureCashfreePayment(): Promise<never>;
+    /**
+     * Cashfree's JavaScript checkout. The engine has already created the Cashfree
+     * order; this hands the storefront the session its modal opens. `order_no` is
+     * the store's number, which the storefront prefers over `order_id`, Cashfree's.
+     *
+     * The return URL is for the one case the modal cannot open, an in-app browser,
+     * when Cashfree sends the shopper back to it instead. Only https is sent: every
+     * Cashfree example is, and a plain-http dev origin should not risk the order.
+     */
+    checkoutCashfree({ cartId, origin }?: {
+        cartId?: string;
+        email?: string;
+        origin?: string;
+    }): Promise<{
+        order_no: string;
+        payment_session_id: string;
+        order_id: string;
+        environment: string;
+    }>;
+    /**
+     * Nothing to capture: the signed webhook tells the engine the order is paid.
+     * The storefront calls this on the server, after Cashfree's modal resolves
+     * with any outcome, so it can neither claim the payment nor, without the
+     * browser's order token, check it. Answering sends the shopper to the success
+     * page; throwing would call a payment that may have gone through failed.
+     */
+    captureCashfreePayment({ order_no }?: {
+        order_no?: string;
+    }): Promise<{
+        order_no: string | null;
+        status: string;
+    }>;
     checkoutPhonepe(): Promise<never>;
     createAffirmPayOrder(): Promise<never>;
     confirmAffirmOrder(): Promise<never>;
@@ -4896,7 +4928,7 @@ declare class CheckoutService extends BaseService {
     }>;
     /**
      * What checkout would charge for the cart now, by the storefront's method
-     * code (`COD`, `RAZORPAY`, `PAYPAL`) or none yet (D185). Null until the
+     * code (`COD`, `RAZORPAY`, `CASHFREE`, `PAYPAL`) or none yet (D185). Null until the
      * address step has stored an address, and null from an engine before D185.
      *
      * A refusal is checkout's own: the same GoCommerceError, with the same
@@ -4943,11 +4975,17 @@ declare class CheckoutService extends BaseService {
      * key resumes that order, and without one the shopper is stuck. A changed
      * request — a different address, a different method — gets a new key, since
      * the engine refuses a key replayed with a different body.
+     *
+     * A gateway's modal keeps the key after the order is placed, along with exactly
+     * what placed it. The cart is converted by then, so a shopper who closes the
+     * window can pay again only under this key, and the engine then reopens the same
+     * gateway order rather than risk a second charge on a new one (D232).
      */
     private place;
 }
 /** The engine's gateways that take payment on their own hosted page. */
 declare const REDIRECT_GATEWAYS: Set<string>;
+declare const cashfreeIsTest: () => boolean;
 type Expected = {
     total: number;
     onChange?: (quote: ReturnType<typeof toCheckoutQuote>, message: string) => void;
@@ -8132,4 +8170,4 @@ declare class B2bService extends BaseService {
 }
 declare const b2bService: B2bService;
 
-export { type Faq as $, type AddOn as A, type B2bPlaced as B, type Cart as C, type Company as D, type CompanyOrder as E, ContactService as F, CountryService as G, CouponService as H, type Credentials as I, type Credit as J, CurrencyService as K, type Customer as L, type CustomizerDesign as M, type CustomizerDocument as N, type CustomizerEditor as O, type CustomizerFile as P, type CustomizerLayer as Q, type CustomizerSavedDesign as R, CustomizerService as S, type CustomizerSetup as T, type CustomizerUpload as U, DealService as V, DemoRequestService as W, type EngineRequest as X, EnquiryService as Y, type Envelope as Z, type FacetValue as _, type Address as a, type SiteChrome as a$, FaqService as a0, FeedbackService as a1, type FooterSettings as a2, type FreeShipping as a3, type Fulfillment as a4, GalleryService as a5, type GooglePlace as a6, type GoogleReview as a7, GoogleReviewService as a8, type GoogleReviews as a9, type PageLayout as aA, PageService as aB, type PaymentIntent as aC, PaymentMethodService as aD, type Plugin as aE, PluginService as aF, PopularSearchService as aG, PopularityService as aH, type Postcode as aI, type Product as aJ, type ProductFacets as aK, type ProductOption as aL, ProductService as aM, ProfileService as aN, type Quote as aO, REDIRECT_GATEWAYS as aP, ReelsService as aQ, RegionService as aR, type RejectedLine as aS, type Review as aT, type ReviewPage as aU, ReviewService as aV, type SearchDoc as aW, type SearchResult as aX, SearchService as aY, SettingService as aZ, type ShippingRate as a_, type GoogleSurvey as aa, type HeaderSettings as ab, type HomeLayout as ac, type HomeLayoutSection as ad, HomeService as ae, type IdentityAddress as af, InitService as ag, type Invitation as ah, type LayoutCollection as ai, type LayoutPage as aj, LayoutService as ak, type Lead as al, type ListMeta as am, MeilisearchService as an, type Member as ao, type Menu as ap, type MenuItem as aq, MenuService as ar, type MenuSummary as as, type Money as at, NewsletterService as au, type Offer as av, type OpeningHours as aw, type Order as ax, type OrderLine as ay, OrderService as az, AddressService as b, layoutService as b$, type SiteFooter as b0, type SiteHeader as b1, type SocialLink as b2, StateService as b3, type StoreClosed as b4, type StorePass as b5, type StorePassAnswer as b6, type StoreProfile as b7, StoreService as b8, type StoreUnlock as b9, bannerService as bA, blogService as bB, cartService as bC, categoryService as bD, chatService as bE, checkoutService as bF, collectionService as bG, contactService as bH, countryService as bI, couponService as bJ, currencyExponent as bK, currencyService as bL, customizerService as bM, dealService as bN, demoRequestService as bO, emptyCart as bP, emptyPage as bQ, enquiryService as bR, faqService as bS, feedbackService as bT, fromEngineAddress as bU, fromIdentityAddress as bV, fromSearchDoc as bW, galleryService as bX, googleReviewService as bY, homeService as bZ, initService as b_, type StorefrontCategory as ba, type StorefrontMenu as bb, type StorefrontOrder as bc, type StorefrontProduct as bd, type ThemeSettings as be, type ThemeSettingsResult as bf, UploadService as bg, UserService as bh, type Variant as bi, type VariantImage as bj, VariantService as bk, VarniCustomDesignService as bl, VarniCustomProductService as bm, type Vendor as bn, VendorService as bo, WarrantyService as bp, type WhatsappConsent as bq, type WhatsappConsentOffer as br, WhatsappService as bs, type Wishlist as bt, type WishlistItem as bu, WishlistService as bv, addressService as bw, authService as bx, autocompleteService as by, b2bService as bz, type AppliedDiscount as c, mediaUrl as c0, meilisearchService as c1, menuService as c2, minorToMajor as c3, newsletterService as c4, orderService as c5, ownDomain as c6, pageService as c7, paymentMethodService as c8, pluginService as c9, toCmsPage as cA, toCollection as cB, toEngineAddress as cC, toFreeShipping as cD, toIdentityAddress as cE, toMajor as cF, toMinor as cG, toOrder as cH, toPage as cI, toProduct as cJ, toRating as cK, toStorefrontFacets as cL, toUser as cM, toVariant as cN, toVendor as cO, uploadService as cP, userService as cQ, variantService as cR, varniCustomDesignService as cS, varniCustomProductService as cT, vendorService as cU, warrantyService as cV, whatsappService as cW, wishlistService as cX, pluginsService as ca, popularSearchService as cb, popularityService as cc, priceOf as cd, productImages as ce, productService as cf, productVideos as cg, profileService as ch, qs as ci, reelsService as cj, regionService as ck, reviewService as cl, searchService as cm, setRequestHost as cn, settingService as co, settingsService as cp, stateService as cq, staticStore as cr, storeForHost as cs, storeService as ct, toAddOn as cu, toCart as cv, toCartLine as cw, toCartOffer as cx, toCategory as cy, toCheckoutQuote as cz, type Approval as d, type AuthResponse as e, AuthService as f, AutocompleteService as g, type B2bRole as h, B2bService as i, BannerService as j, BaseService as k, BlogService as l, type CartLine as m, type CartOffer as n, CartService as o, CatalogService as p, type Category as q, CategoryService as r, ChatService as s, type CheckoutOptions as t, type CheckoutQuote as u, type CheckoutResult as v, CheckoutService as w, type CmsPage as x, type Collection as y, CollectionService as z };
+export { type Faq as $, type AddOn as A, type B2bPlaced as B, type Cart as C, type Company as D, type CompanyOrder as E, ContactService as F, CountryService as G, CouponService as H, type Credentials as I, type Credit as J, CurrencyService as K, type Customer as L, type CustomizerDesign as M, type CustomizerDocument as N, type CustomizerEditor as O, type CustomizerFile as P, type CustomizerLayer as Q, type CustomizerSavedDesign as R, CustomizerService as S, type CustomizerSetup as T, type CustomizerUpload as U, DealService as V, DemoRequestService as W, type EngineRequest as X, EnquiryService as Y, type Envelope as Z, type FacetValue as _, type Address as a, type SiteChrome as a$, FaqService as a0, FeedbackService as a1, type FooterSettings as a2, type FreeShipping as a3, type Fulfillment as a4, GalleryService as a5, type GooglePlace as a6, type GoogleReview as a7, GoogleReviewService as a8, type GoogleReviews as a9, type PageLayout as aA, PageService as aB, type PaymentIntent as aC, PaymentMethodService as aD, type Plugin as aE, PluginService as aF, PopularSearchService as aG, PopularityService as aH, type Postcode as aI, type Product as aJ, type ProductFacets as aK, type ProductOption as aL, ProductService as aM, ProfileService as aN, type Quote as aO, REDIRECT_GATEWAYS as aP, ReelsService as aQ, RegionService as aR, type RejectedLine as aS, type Review as aT, type ReviewPage as aU, ReviewService as aV, type SearchDoc as aW, type SearchResult as aX, SearchService as aY, SettingService as aZ, type ShippingRate as a_, type GoogleSurvey as aa, type HeaderSettings as ab, type HomeLayout as ac, type HomeLayoutSection as ad, HomeService as ae, type IdentityAddress as af, InitService as ag, type Invitation as ah, type LayoutCollection as ai, type LayoutPage as aj, LayoutService as ak, type Lead as al, type ListMeta as am, MeilisearchService as an, type Member as ao, type Menu as ap, type MenuItem as aq, MenuService as ar, type MenuSummary as as, type Money as at, NewsletterService as au, type Offer as av, type OpeningHours as aw, type Order as ax, type OrderLine as ay, OrderService as az, AddressService as b, initService as b$, type SiteFooter as b0, type SiteHeader as b1, type SocialLink as b2, StateService as b3, type StoreClosed as b4, type StorePass as b5, type StorePassAnswer as b6, type StoreProfile as b7, StoreService as b8, type StoreUnlock as b9, bannerService as bA, blogService as bB, cartService as bC, cashfreeIsTest as bD, categoryService as bE, chatService as bF, checkoutService as bG, collectionService as bH, contactService as bI, countryService as bJ, couponService as bK, currencyExponent as bL, currencyService as bM, customizerService as bN, dealService as bO, demoRequestService as bP, emptyCart as bQ, emptyPage as bR, enquiryService as bS, faqService as bT, feedbackService as bU, fromEngineAddress as bV, fromIdentityAddress as bW, fromSearchDoc as bX, galleryService as bY, googleReviewService as bZ, homeService as b_, type StorefrontCategory as ba, type StorefrontMenu as bb, type StorefrontOrder as bc, type StorefrontProduct as bd, type ThemeSettings as be, type ThemeSettingsResult as bf, UploadService as bg, UserService as bh, type Variant as bi, type VariantImage as bj, VariantService as bk, VarniCustomDesignService as bl, VarniCustomProductService as bm, type Vendor as bn, VendorService as bo, WarrantyService as bp, type WhatsappConsent as bq, type WhatsappConsentOffer as br, WhatsappService as bs, type Wishlist as bt, type WishlistItem as bu, WishlistService as bv, addressService as bw, authService as bx, autocompleteService as by, b2bService as bz, type AppliedDiscount as c, layoutService as c0, mediaUrl as c1, meilisearchService as c2, menuService as c3, minorToMajor as c4, newsletterService as c5, orderService as c6, ownDomain as c7, pageService as c8, paymentMethodService as c9, toCheckoutQuote as cA, toCmsPage as cB, toCollection as cC, toEngineAddress as cD, toFreeShipping as cE, toIdentityAddress as cF, toMajor as cG, toMinor as cH, toOrder as cI, toPage as cJ, toProduct as cK, toRating as cL, toStorefrontFacets as cM, toUser as cN, toVariant as cO, toVendor as cP, uploadService as cQ, userService as cR, variantService as cS, varniCustomDesignService as cT, varniCustomProductService as cU, vendorService as cV, warrantyService as cW, whatsappService as cX, wishlistService as cY, pluginService as ca, pluginsService as cb, popularSearchService as cc, popularityService as cd, priceOf as ce, productImages as cf, productService as cg, productVideos as ch, profileService as ci, qs as cj, reelsService as ck, regionService as cl, reviewService as cm, searchService as cn, setRequestHost as co, settingService as cp, settingsService as cq, stateService as cr, staticStore as cs, storeForHost as ct, storeService as cu, toAddOn as cv, toCart as cw, toCartLine as cx, toCartOffer as cy, toCategory as cz, type Approval as d, type AuthResponse as e, AuthService as f, AutocompleteService as g, type B2bRole as h, B2bService as i, BannerService as j, BaseService as k, BlogService as l, type CartLine as m, type CartOffer as n, CartService as o, CatalogService as p, type Category as q, CategoryService as r, ChatService as s, type CheckoutOptions as t, type CheckoutQuote as u, type CheckoutResult as v, CheckoutService as w, type CmsPage as x, type Collection as y, CollectionService as z };

package/dist/{index-CSqvRZQ4.d.ts → index-BAmkQfij.d.ts}

@@ -862,6 +862,8 @@ type CartExtras = {
         body: string;
         meta?: Record<string, string>;
         attribution?: Record<string, unknown>;
+        /** What placed the order, while its gateway's window can be opened again: see CheckoutService.place. */
+        placed?: Record<string, unknown>;
     } | null;
 };
 
@@ -4721,12 +4723,12 @@ declare class CheckoutService extends BaseService {
     checkoutStripeCapture(): Promise<never>;
     /**
      * The storefront's generic redirect flow, which it reaches through the code
-     * `PAYPAL`. The engine has no PayPal gateway; paymentMethodService puts the
-     * store's first hosted-page gateway — Adyen, Paddle, Lemon Squeezy, Creem,
-     * Hyperswitch or RevenueCat — under that code, with its own name and a
-     * neutral icon, because this is the one storefront flow that sends a shopper
-     * to a URL and back. The shopper returns to the success page; the gateway's
-     * webhook tells the engine the order is paid.
+     * `PAYPAL`. paymentMethodService puts the store's first hosted-page gateway
+     * — PayPal, Adyen, Paddle, Lemon Squeezy, Creem, Hyperswitch or RevenueCat —
+     * under that code, with its own name and a neutral icon, because this is the
+     * one storefront flow that sends a shopper to a URL and back. The shopper
+     * returns to the success page; the gateway's webhook tells the engine the
+     * order is paid. PayPal's webhook is also what captures the approved payment.
      */
     checkoutPaypal({ cartId, origin }?: {
         cartId?: string;
@@ -4750,8 +4752,38 @@ declare class CheckoutService extends BaseService {
         order_no: string | null;
         status: string;
     }>;
-    checkoutCashfree(): Promise<never>;
-    captureCashfreePayment(): Promise<never>;
+    /**
+     * Cashfree's JavaScript checkout. The engine has already created the Cashfree
+     * order; this hands the storefront the session its modal opens. `order_no` is
+     * the store's number, which the storefront prefers over `order_id`, Cashfree's.
+     *
+     * The return URL is for the one case the modal cannot open, an in-app browser,
+     * when Cashfree sends the shopper back to it instead. Only https is sent: every
+     * Cashfree example is, and a plain-http dev origin should not risk the order.
+     */
+    checkoutCashfree({ cartId, origin }?: {
+        cartId?: string;
+        email?: string;
+        origin?: string;
+    }): Promise<{
+        order_no: string;
+        payment_session_id: string;
+        order_id: string;
+        environment: string;
+    }>;
+    /**
+     * Nothing to capture: the signed webhook tells the engine the order is paid.
+     * The storefront calls this on the server, after Cashfree's modal resolves
+     * with any outcome, so it can neither claim the payment nor, without the
+     * browser's order token, check it. Answering sends the shopper to the success
+     * page; throwing would call a payment that may have gone through failed.
+     */
+    captureCashfreePayment({ order_no }?: {
+        order_no?: string;
+    }): Promise<{
+        order_no: string | null;
+        status: string;
+    }>;
     checkoutPhonepe(): Promise<never>;
     createAffirmPayOrder(): Promise<never>;
     confirmAffirmOrder(): Promise<never>;
@@ -4896,7 +4928,7 @@ declare class CheckoutService extends BaseService {
     }>;
     /**
      * What checkout would charge for the cart now, by the storefront's method
-     * code (`COD`, `RAZORPAY`, `PAYPAL`) or none yet (D185). Null until the
+     * code (`COD`, `RAZORPAY`, `CASHFREE`, `PAYPAL`) or none yet (D185). Null until the
      * address step has stored an address, and null from an engine before D185.
      *
      * A refusal is checkout's own: the same GoCommerceError, with the same
@@ -4943,11 +4975,17 @@ declare class CheckoutService extends BaseService {
      * key resumes that order, and without one the shopper is stuck. A changed
      * request — a different address, a different method — gets a new key, since
      * the engine refuses a key replayed with a different body.
+     *
+     * A gateway's modal keeps the key after the order is placed, along with exactly
+     * what placed it. The cart is converted by then, so a shopper who closes the
+     * window can pay again only under this key, and the engine then reopens the same
+     * gateway order rather than risk a second charge on a new one (D232).
      */
     private place;
 }
 /** The engine's gateways that take payment on their own hosted page. */
 declare const REDIRECT_GATEWAYS: Set<string>;
+declare const cashfreeIsTest: () => boolean;
 type Expected = {
     total: number;
     onChange?: (quote: ReturnType<typeof toCheckoutQuote>, message: string) => void;
@@ -8132,4 +8170,4 @@ declare class B2bService extends BaseService {
 }
 declare const b2bService: B2bService;
 
-export { type Faq as $, type AddOn as A, type B2bPlaced as B, type Cart as C, type Company as D, type CompanyOrder as E, ContactService as F, CountryService as G, CouponService as H, type Credentials as I, type Credit as J, CurrencyService as K, type Customer as L, type CustomizerDesign as M, type CustomizerDocument as N, type CustomizerEditor as O, type CustomizerFile as P, type CustomizerLayer as Q, type CustomizerSavedDesign as R, CustomizerService as S, type CustomizerSetup as T, type CustomizerUpload as U, DealService as V, DemoRequestService as W, type EngineRequest as X, EnquiryService as Y, type Envelope as Z, type FacetValue as _, type Address as a, type SiteChrome as a$, FaqService as a0, FeedbackService as a1, type FooterSettings as a2, type FreeShipping as a3, type Fulfillment as a4, GalleryService as a5, type GooglePlace as a6, type GoogleReview as a7, GoogleReviewService as a8, type GoogleReviews as a9, type PageLayout as aA, PageService as aB, type PaymentIntent as aC, PaymentMethodService as aD, type Plugin as aE, PluginService as aF, PopularSearchService as aG, PopularityService as aH, type Postcode as aI, type Product as aJ, type ProductFacets as aK, type ProductOption as aL, ProductService as aM, ProfileService as aN, type Quote as aO, REDIRECT_GATEWAYS as aP, ReelsService as aQ, RegionService as aR, type RejectedLine as aS, type Review as aT, type ReviewPage as aU, ReviewService as aV, type SearchDoc as aW, type SearchResult as aX, SearchService as aY, SettingService as aZ, type ShippingRate as a_, type GoogleSurvey as aa, type HeaderSettings as ab, type HomeLayout as ac, type HomeLayoutSection as ad, HomeService as ae, type IdentityAddress as af, InitService as ag, type Invitation as ah, type LayoutCollection as ai, type LayoutPage as aj, LayoutService as ak, type Lead as al, type ListMeta as am, MeilisearchService as an, type Member as ao, type Menu as ap, type MenuItem as aq, MenuService as ar, type MenuSummary as as, type Money as at, NewsletterService as au, type Offer as av, type OpeningHours as aw, type Order as ax, type OrderLine as ay, OrderService as az, AddressService as b, layoutService as b$, type SiteFooter as b0, type SiteHeader as b1, type SocialLink as b2, StateService as b3, type StoreClosed as b4, type StorePass as b5, type StorePassAnswer as b6, type StoreProfile as b7, StoreService as b8, type StoreUnlock as b9, bannerService as bA, blogService as bB, cartService as bC, categoryService as bD, chatService as bE, checkoutService as bF, collectionService as bG, contactService as bH, countryService as bI, couponService as bJ, currencyExponent as bK, currencyService as bL, customizerService as bM, dealService as bN, demoRequestService as bO, emptyCart as bP, emptyPage as bQ, enquiryService as bR, faqService as bS, feedbackService as bT, fromEngineAddress as bU, fromIdentityAddress as bV, fromSearchDoc as bW, galleryService as bX, googleReviewService as bY, homeService as bZ, initService as b_, type StorefrontCategory as ba, type StorefrontMenu as bb, type StorefrontOrder as bc, type StorefrontProduct as bd, type ThemeSettings as be, type ThemeSettingsResult as bf, UploadService as bg, UserService as bh, type Variant as bi, type VariantImage as bj, VariantService as bk, VarniCustomDesignService as bl, VarniCustomProductService as bm, type Vendor as bn, VendorService as bo, WarrantyService as bp, type WhatsappConsent as bq, type WhatsappConsentOffer as br, WhatsappService as bs, type Wishlist as bt, type WishlistItem as bu, WishlistService as bv, addressService as bw, authService as bx, autocompleteService as by, b2bService as bz, type AppliedDiscount as c, mediaUrl as c0, meilisearchService as c1, menuService as c2, minorToMajor as c3, newsletterService as c4, orderService as c5, ownDomain as c6, pageService as c7, paymentMethodService as c8, pluginService as c9, toCmsPage as cA, toCollection as cB, toEngineAddress as cC, toFreeShipping as cD, toIdentityAddress as cE, toMajor as cF, toMinor as cG, toOrder as cH, toPage as cI, toProduct as cJ, toRating as cK, toStorefrontFacets as cL, toUser as cM, toVariant as cN, toVendor as cO, uploadService as cP, userService as cQ, variantService as cR, varniCustomDesignService as cS, varniCustomProductService as cT, vendorService as cU, warrantyService as cV, whatsappService as cW, wishlistService as cX, pluginsService as ca, popularSearchService as cb, popularityService as cc, priceOf as cd, productImages as ce, productService as cf, productVideos as cg, profileService as ch, qs as ci, reelsService as cj, regionService as ck, reviewService as cl, searchService as cm, setRequestHost as cn, settingService as co, settingsService as cp, stateService as cq, staticStore as cr, storeForHost as cs, storeService as ct, toAddOn as cu, toCart as cv, toCartLine as cw, toCartOffer as cx, toCategory as cy, toCheckoutQuote as cz, type Approval as d, type AuthResponse as e, AuthService as f, AutocompleteService as g, type B2bRole as h, B2bService as i, BannerService as j, BaseService as k, BlogService as l, type CartLine as m, type CartOffer as n, CartService as o, CatalogService as p, type Category as q, CategoryService as r, ChatService as s, type CheckoutOptions as t, type CheckoutQuote as u, type CheckoutResult as v, CheckoutService as w, type CmsPage as x, type Collection as y, CollectionService as z };
+export { type Faq as $, type AddOn as A, type B2bPlaced as B, type Cart as C, type Company as D, type CompanyOrder as E, ContactService as F, CountryService as G, CouponService as H, type Credentials as I, type Credit as J, CurrencyService as K, type Customer as L, type CustomizerDesign as M, type CustomizerDocument as N, type CustomizerEditor as O, type CustomizerFile as P, type CustomizerLayer as Q, type CustomizerSavedDesign as R, CustomizerService as S, type CustomizerSetup as T, type CustomizerUpload as U, DealService as V, DemoRequestService as W, type EngineRequest as X, EnquiryService as Y, type Envelope as Z, type FacetValue as _, type Address as a, type SiteChrome as a$, FaqService as a0, FeedbackService as a1, type FooterSettings as a2, type FreeShipping as a3, type Fulfillment as a4, GalleryService as a5, type GooglePlace as a6, type GoogleReview as a7, GoogleReviewService as a8, type GoogleReviews as a9, type PageLayout as aA, PageService as aB, type PaymentIntent as aC, PaymentMethodService as aD, type Plugin as aE, PluginService as aF, PopularSearchService as aG, PopularityService as aH, type Postcode as aI, type Product as aJ, type ProductFacets as aK, type ProductOption as aL, ProductService as aM, ProfileService as aN, type Quote as aO, REDIRECT_GATEWAYS as aP, ReelsService as aQ, RegionService as aR, type RejectedLine as aS, type Review as aT, type ReviewPage as aU, ReviewService as aV, type SearchDoc as aW, type SearchResult as aX, SearchService as aY, SettingService as aZ, type ShippingRate as a_, type GoogleSurvey as aa, type HeaderSettings as ab, type HomeLayout as ac, type HomeLayoutSection as ad, HomeService as ae, type IdentityAddress as af, InitService as ag, type Invitation as ah, type LayoutCollection as ai, type LayoutPage as aj, LayoutService as ak, type Lead as al, type ListMeta as am, MeilisearchService as an, type Member as ao, type Menu as ap, type MenuItem as aq, MenuService as ar, type MenuSummary as as, type Money as at, NewsletterService as au, type Offer as av, type OpeningHours as aw, type Order as ax, type OrderLine as ay, OrderService as az, AddressService as b, initService as b$, type SiteFooter as b0, type SiteHeader as b1, type SocialLink as b2, StateService as b3, type StoreClosed as b4, type StorePass as b5, type StorePassAnswer as b6, type StoreProfile as b7, StoreService as b8, type StoreUnlock as b9, bannerService as bA, blogService as bB, cartService as bC, cashfreeIsTest as bD, categoryService as bE, chatService as bF, checkoutService as bG, collectionService as bH, contactService as bI, countryService as bJ, couponService as bK, currencyExponent as bL, currencyService as bM, customizerService as bN, dealService as bO, demoRequestService as bP, emptyCart as bQ, emptyPage as bR, enquiryService as bS, faqService as bT, feedbackService as bU, fromEngineAddress as bV, fromIdentityAddress as bW, fromSearchDoc as bX, galleryService as bY, googleReviewService as bZ, homeService as b_, type StorefrontCategory as ba, type StorefrontMenu as bb, type StorefrontOrder as bc, type StorefrontProduct as bd, type ThemeSettings as be, type ThemeSettingsResult as bf, UploadService as bg, UserService as bh, type Variant as bi, type VariantImage as bj, VariantService as bk, VarniCustomDesignService as bl, VarniCustomProductService as bm, type Vendor as bn, VendorService as bo, WarrantyService as bp, type WhatsappConsent as bq, type WhatsappConsentOffer as br, WhatsappService as bs, type Wishlist as bt, type WishlistItem as bu, WishlistService as bv, addressService as bw, authService as bx, autocompleteService as by, b2bService as bz, type AppliedDiscount as c, layoutService as c0, mediaUrl as c1, meilisearchService as c2, menuService as c3, minorToMajor as c4, newsletterService as c5, orderService as c6, ownDomain as c7, pageService as c8, paymentMethodService as c9, toCheckoutQuote as cA, toCmsPage as cB, toCollection as cC, toEngineAddress as cD, toFreeShipping as cE, toIdentityAddress as cF, toMajor as cG, toMinor as cH, toOrder as cI, toPage as cJ, toProduct as cK, toRating as cL, toStorefrontFacets as cM, toUser as cN, toVariant as cO, toVendor as cP, uploadService as cQ, userService as cR, variantService as cS, varniCustomDesignService as cT, varniCustomProductService as cU, vendorService as cV, warrantyService as cW, whatsappService as cX, wishlistService as cY, pluginService as ca, pluginsService as cb, popularSearchService as cc, popularityService as cd, priceOf as ce, productImages as cf, productService as cg, productVideos as ch, profileService as ci, qs as cj, reelsService as ck, regionService as cl, reviewService as cm, searchService as cn, setRequestHost as co, settingService as cp, settingsService as cq, stateService as cr, staticStore as cs, storeForHost as ct, storeService as cu, toAddOn as cv, toCart as cw, toCartLine as cx, toCartOffer as cy, toCategory as cz, type Approval as d, type AuthResponse as e, AuthService as f, AutocompleteService as g, type B2bRole as h, B2bService as i, BannerService as j, BaseService as k, BlogService as l, type CartLine as m, type CartOffer as n, CartService as o, CatalogService as p, type Category as q, CategoryService as r, ChatService as s, type CheckoutOptions as t, type CheckoutQuote as u, type CheckoutResult as v, CheckoutService as w, type CmsPage as x, type Collection as y, CollectionService as z };

package/dist/index.cjs

@@ -2216,9 +2216,9 @@ var CheckoutService = class extends BaseService {
   }
   // The family's other gateway flows. GoCommerce's Stripe is a Payment
   // Element (a client secret, not a hosted page) — `checkout('stripe')` returns
-  // that secret for a storefront that mounts the element. Cashfree, PhonePe and
-  // Affirm are not engine gateways at all. paymentMethodService never offers
-  // these codes, so they are reached only by a storefront that hard-codes one.
+  // that secret for a storefront that mounts the element. PhonePe and Affirm are
+  // not engine gateways at all. paymentMethodService never offers these codes,
+  // so they are reached only by a storefront that hard-codes one.
   async checkoutStripe() {
     throw unsupported(
       "checkoutStripe",
@@ -2230,18 +2230,18 @@ var CheckoutService = class extends BaseService {
   }
   /**
    * The storefront's generic redirect flow, which it reaches through the code
-   * `PAYPAL`. The engine has no PayPal gateway; paymentMethodService puts the
-   * store's first hosted-page gateway — Adyen, Paddle, Lemon Squeezy, Creem,
-   * Hyperswitch or RevenueCat — under that code, with its own name and a
-   * neutral icon, because this is the one storefront flow that sends a shopper
-   * to a URL and back. The shopper returns to the success page; the gateway's
-   * webhook tells the engine the order is paid.
+   * `PAYPAL`. paymentMethodService puts the store's first hosted-page gateway
+   * — PayPal, Adyen, Paddle, Lemon Squeezy, Creem, Hyperswitch or RevenueCat —
+   * under that code, with its own name and a neutral icon, because this is the
+   * one storefront flow that sends a shopper to a URL and back. The shopper
+   * returns to the success page; the gateway's webhook tells the engine the
+   * order is paid. PayPal's webhook is also what captures the approved payment.
    */
   async checkoutPaypal({ cartId, origin } = {}) {
     const gateway = await this.redirectGateway();
     if (!gateway) throw unsupported("checkoutPaypal", "this store has no hosted-page payment gateway switched on");
     const id2 = cartId || storedCartId() || "";
-    const back = origin ? `${origin.replace(/\/+$/, "")}/checkout/success?cart_id=${encodeURIComponent(id2)}` : void 0;
+    const back = origin ? successUrl(origin, id2) : void 0;
     const result = await this.place(gateway, id2, back ? { return_url: back } : {});
     const url = result.payment.client_data?.url;
     if (!url) throw new GoCommerceError("The payment page did not open. Please try again.", 502);
@@ -2257,11 +2257,40 @@ var CheckoutService = class extends BaseService {
   } = {}) {
     return { order_no: order_no ?? null, status: "processing" };
   }
-  async checkoutCashfree() {
-    throw unsupported("checkoutCashfree", "the engine has no Cashfree gateway");
+  /**
+   * Cashfree's JavaScript checkout. The engine has already created the Cashfree
+   * order; this hands the storefront the session its modal opens. `order_no` is
+   * the store's number, which the storefront prefers over `order_id`, Cashfree's.
+   *
+   * The return URL is for the one case the modal cannot open, an in-app browser,
+   * when Cashfree sends the shopper back to it instead. Only https is sent: every
+   * Cashfree example is, and a plain-http dev origin should not risk the order.
+   */
+  async checkoutCashfree({ cartId, origin } = {}) {
+    const { id: id2, extras, address } = await this.storedCheckout(cartId);
+    if (!extras.phone && !address.phone) throw new GoCommerceError("Add a phone number to pay with Cashfree.", 400);
+    const result = await this.place("cashfree", id2, origin?.startsWith("https:") ? { return_url: successUrl(origin, id2) } : {});
+    const data = result.payment.client_data ?? {};
+    if (result.payment.kind !== "client_action" || !data.payment_session_id) {
+      throw new GoCommerceError("The payment page did not open. Please try again.", 502);
+    }
+    cashfreeEnvironment = data.environment;
+    return {
+      order_no: result.order.number,
+      payment_session_id: data.payment_session_id,
+      order_id: data.order_id,
+      environment: data.environment
+    };
   }
-  async captureCashfreePayment() {
-    throw unsupported("captureCashfreePayment", "the engine has no Cashfree gateway");
+  /**
+   * Nothing to capture: the signed webhook tells the engine the order is paid.
+   * The storefront calls this on the server, after Cashfree's modal resolves
+   * with any outcome, so it can neither claim the payment nor, without the
+   * browser's order token, check it. Answering sends the shopper to the success
+   * page; throwing would call a payment that may have gone through failed.
+   */
+  async captureCashfreePayment({ order_no } = {}) {
+    return { order_no: order_no ?? null, status: "processing" };
   }
   async checkoutPhonepe() {
     throw unsupported("checkoutPhonepe", "the engine has no PhonePe gateway");
@@ -2327,7 +2356,7 @@ var CheckoutService = class extends BaseService {
   }
   /**
    * What checkout would charge for the cart now, by the storefront's method
-   * code (`COD`, `RAZORPAY`, `PAYPAL`) or none yet (D185). Null until the
+   * code (`COD`, `RAZORPAY`, `CASHFREE`, `PAYPAL`) or none yet (D185). Null until the
    * address step has stored an address, and null from an engine before D185.
    *
    * A refusal is checkout's own: the same GoCommerceError, with the same
@@ -2335,7 +2364,7 @@ var CheckoutService = class extends BaseService {
    */
   async getQuote({ cartId, method = "" } = {}) {
     const id2 = cartId || storedCartId();
-    if (!id2 || !cartExtras(id2).shippingAddress) return null;
+    if (!id2 || !cartExtras(id2).shippingAddress || cartExtras(id2).attempt?.placed) return null;
     const { extras, email, address } = await this.storedCheckout(id2);
     const code = method.toLowerCase() === "paypal" ? await this.redirectGateway() : method.toLowerCase();
     try {
@@ -2396,6 +2425,11 @@ var CheckoutService = class extends BaseService {
    * key resumes that order, and without one the shopper is stuck. A changed
    * request — a different address, a different method — gets a new key, since
    * the engine refuses a key replayed with a different body.
+   *
+   * A gateway's modal keeps the key after the order is placed, along with exactly
+   * what placed it. The cart is converted by then, so a shopper who closes the
+   * window can pay again only under this key, and the engine then reopens the same
+   * gateway order rather than risk a second charge on a new one (D232).
    */
   async place(code, cartId, extra = {}) {
     const { id: id2, extras, email, address, currency } = await this.storedCheckout(cartId);
@@ -2412,23 +2446,27 @@ var CheckoutService = class extends BaseService {
     const serialised = JSON.stringify(body);
     const retry = extras.attempt?.body === `${code}:${serialised}`;
     const key = retry ? extras.attempt.key : newKey();
+    const placed = retry ? extras.attempt?.placed : void 0;
     const meta = retry ? extras.attempt?.meta : metaBrowser();
     const attribution = retry ? extras.attempt?.attribution : landingAttribution();
-    saveCartExtras(id2, {
-      attempt: { key, body: `${code}:${serialised}`, ...meta ? { meta } : {}, ...attribution ? { attribution } : {} }
-    });
+    if (!placed) {
+      saveCartExtras(id2, {
+        attempt: { key, body: `${code}:${serialised}`, ...meta ? { meta } : {}, ...attribution ? { attribution } : {} }
+      });
+    }
     const metadata = {
       ...extra.metadata,
       ...meta ? { meta_capi: meta } : {},
       ...attribution ? { attribution } : {}
     };
     const expected = this.expected.get(id2);
+    const sent = placed ?? {
+      ...Object.keys(metadata).length ? { ...body, metadata } : body,
+      ...expected ? { quoted_total_minor: toMinor(expected.total, currency) } : {}
+    };
     const result = await this.data(`/api/checkout/${encodeURIComponent(code)}`, {
       method: "POST",
-      body: {
-        ...Object.keys(metadata).length ? { ...body, metadata } : body,
-        ...expected ? { quoted_total_minor: toMinor(expected.total, currency) } : {}
-      },
+      body: sent,
       headers: { "Idempotency-Key": key }
     }).catch((err) => {
       if (keyAlreadyUsed(err)) {
@@ -2455,11 +2493,18 @@ var CheckoutService = class extends BaseService {
         }).catch(() => void 0);
       }
     }
-    saveCartExtras(id2, { attempt: null });
+    const reopenable = result.payment.kind === "client_action";
+    saveCartExtras(id2, { attempt: reopenable ? { key, body: `${code}:${serialised}`, placed: sent } : null });
+    if (reopenable && result.order.payment_status === "paid") {
+      throw new GoCommerceError(`Order ${result.order.number} is already paid, so there is nothing more to pay.`, 409, "already_paid");
+    }
     return result;
   }
 };
-var REDIRECT_GATEWAYS = /* @__PURE__ */ new Set(["adyen", "paddle", "lemonsqueezy", "creem", "hyperswitch", "revenuecat"]);
+var REDIRECT_GATEWAYS = /* @__PURE__ */ new Set(["paypal", "adyen", "paddle", "lemonsqueezy", "creem", "hyperswitch", "revenuecat"]);
+var cashfreeEnvironment;
+var cashfreeIsTest = () => cashfreeEnvironment === "sandbox";
+var successUrl = (origin, cartId) => `${origin.replace(/\/+$/, "")}/checkout/success?cart_id=${encodeURIComponent(cartId)}`;
 var unsupported = (method, why) => new NotSupportedError("CheckoutService", method, why);
 function keyAlreadyUsed(err) {
   return err instanceof GoCommerceError && err.status === 400 && err.message.includes("Idempotency-Key was already used");
@@ -2486,7 +2531,8 @@ var checkoutService = new CheckoutService();
 // src/services/payment-method-service.ts
 var DRIVABLE = {
   cod: { code: "COD", img: "/payment/cod.svg" },
-  razorpay: { code: "RAZORPAY" }
+  razorpay: { code: "RAZORPAY" },
+  cashfree: { code: "CASHFREE", img: "/payment/card.svg" }
 };
 var reported2 = /* @__PURE__ */ new Set();
 var PaymentMethodService = class extends BaseService {
@@ -2495,7 +2541,12 @@ var PaymentMethodService = class extends BaseService {
     const options = await this.facts.checkoutOptions();
     const methods = options.methods ?? [];
     const redirect = methods.find((m) => REDIRECT_GATEWAYS.has(m.code))?.code;
-    const drive = (code) => DRIVABLE[code] ?? (code === redirect ? { code: "PAYPAL", img: "/payment/card.svg" } : void 0);
+    const drive = (code) => {
+      if (code === "cashfree" && options.currency !== "INR") return void 0;
+      if (DRIVABLE[code]) return DRIVABLE[code];
+      if (code === redirect) return { code: "PAYPAL", img: "/payment/card.svg" };
+      return REDIRECT_GATEWAYS.has(code) ? { code: code.toUpperCase(), img: "/payment/card.svg" } : void 0;
+    };
     const data = methods.filter((m) => {
       if (drive(m.code)) return true;
       if (!reported2.has(m.code)) {
@@ -2505,19 +2556,24 @@ var PaymentMethodService = class extends BaseService {
         );
       }
       return false;
-    }).map((m, i) => ({
-      id: m.code,
-      code: drive(m.code).code,
-      engineCode: m.code,
-      name: m.name,
-      title: m.name,
-      description: "",
-      img: drive(m.code).img ?? null,
-      fee: toMajor(m.fee),
-      rank: i,
-      active: true,
-      isActive: true
-    }));
+    }).map((m, i) => {
+      const method = {
+        id: m.code,
+        code: drive(m.code).code,
+        engineCode: m.code,
+        name: m.name,
+        title: m.name,
+        description: "",
+        img: drive(m.code).img ?? null,
+        fee: toMajor(m.fee),
+        rank: i,
+        active: true,
+        isActive: true
+      };
+      if (REDIRECT_GATEWAYS.has(m.code) && m.code !== redirect) Object.assign(method, { redirects: true });
+      if (m.code === "cashfree") Object.defineProperty(method, "isTest", { get: cashfreeIsTest, enumerable: true });
+      return method;
+    });
     return { data, count: data.length, pageSize: data.length, noOfPage: 1, page: 1 };
   }
 };
@@ -4345,6 +4401,7 @@ exports.b2bService = b2bService;
 exports.bannerService = bannerService;
 exports.blogService = blogService;
 exports.cartService = cartService;
+exports.cashfreeIsTest = cashfreeIsTest;
 exports.categoryService = categoryService;
 exports.chatService = chatService;
 exports.checkoutService = checkoutService;