@commercetools/connect-payments-sdk 0.16.1 → 0.17.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @commercetools/connect-payments-sdk
 
+## 0.17.0
+
+### Minor Changes
+
+- 02d2994: creating getPlannedPaymentAmount which takes into account giftcard amount to create session
+
 ## 0.16.1
 
 ### Patch Changes

package/dist/commercetools/services/ct-cart.service.d.ts

@@ -12,6 +12,7 @@ export declare class DefaultCartService implements CartService {
     constructor(opts: CartServiceOptions);
     getCartByPaymentId(opts: GetCartByPaymentIdRequest): Promise<Cart>;
     getCart(opts: GetCart): Promise<Cart>;
+    getPlannedPaymentAmount(opts: GetPaymentAmount): Promise<PaymentAmount>;
     getPaymentAmount(opts: GetPaymentAmount): Promise<PaymentAmount>;
     /**
      * Get only one shipping address from the cart. If the cart has multiple shipping addresses, it returns the first one.

package/dist/commercetools/services/ct-cart.service.js

@@ -32,7 +32,7 @@ class DefaultCartService {
     async getCart(opts) {
         return await this.ctAPI.cart.getCartById(opts.id);
     }
-    async getPaymentAmount(opts) {
+    async getPlannedPaymentAmount(opts) {
         const giftCardPlannedAmount = (0, __1.getGiftCardPlannedAmountFromContext)(this.contextProvider.getContextData());
         const paidAmount = await this.calculateTotalPaidAmount(opts.cart);
         let cartAmount;
@@ -71,6 +71,42 @@ class DefaultCartService {
             fractionDigits: cartAmount.fractionDigits,
         };
     }
+    async getPaymentAmount(opts) {
+        const paidAmount = await this.calculateTotalPaidAmount(opts.cart);
+        let cartAmount;
+        if (opts.cart.taxedPrice) {
+            cartAmount = {
+                currencyCode: opts.cart.taxedPrice.totalGross.currencyCode,
+                centAmount: opts.cart.taxedPrice.totalGross.centAmount,
+                fractionDigits: opts.cart.taxedPrice.totalGross.fractionDigits,
+            };
+        }
+        else {
+            cartAmount = {
+                currencyCode: opts.cart.totalPrice.currencyCode,
+                centAmount: opts.cart.totalPrice.centAmount,
+                fractionDigits: opts.cart.totalPrice.fractionDigits,
+            };
+        }
+        if (paidAmount >= cartAmount.centAmount) {
+            throw new __1.ErrorInvalidOperation('The cart has already been paid in full', {
+                fields: {
+                    resource: opts.cart.id,
+                    paidAmount,
+                    cartAmount,
+                },
+            });
+        }
+        const currentAmountToPay = cartAmount.centAmount - paidAmount;
+        this.logger.info({
+            currentAmountToPay,
+        }, 'current amount to pay');
+        return {
+            currencyCode: cartAmount.currencyCode,
+            centAmount: currentAmountToPay,
+            fractionDigits: cartAmount.fractionDigits,
+        };
+    }
     /**
      * Get only one shipping address from the cart. If the cart has multiple shipping addresses, it returns the first one.
      * @param cart

package/dist/commercetools/types/cart.type.d.ts

@@ -41,6 +41,18 @@ export type GetCartByPaymentIdRequest = {
 export interface CartService {
     getCartByPaymentId(opts: GetCartByPaymentIdRequest): Promise<Cart>;
     getCart(opts: GetCart): Promise<Cart>;
+    /**
+     * Get payment amount for a cart. This method is used to calculate the payment amount for a cart.
+     * It takes into account existing successful payments.
+     * @param opts
+     */
     getPaymentAmount(opts: GetPaymentAmount): Promise<PaymentAmount>;
+    /**
+     * Get payment amount for a cart. This method is used to calculate the payment amount for a cart.
+     * It takes into account existing successful payments and giftcards connectors.
+     * This method is specifically used for calculating the payment amount for a cart when a giftcard is applied and the payment session is created upfront.
+     * @param opts
+     */
+    getPlannedPaymentAmount(opts: GetPaymentAmount): Promise<PaymentAmount>;
     addPayment(opts: AddPayment): Promise<Cart>;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@commercetools/connect-payments-sdk",
-  "version": "0.16.1",
+  "version": "0.17.0",
   "description": "Payment SDK for commercetools payment connectors",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -15,7 +15,7 @@
   ],
   "license": "ISC",
   "dependencies": {
-    "@commercetools-backend/loggers": "22.38.1",
+    "@commercetools-backend/loggers": "22.39.0",
     "@commercetools/platform-sdk": "8.1.0",
     "@commercetools/sdk-client-v2": "2.5.0",
     "jsonwebtoken": "9.0.2",