@commercetools/connect-payments-sdk 0.0.7 → 0.1.0

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # @commercetools/connect-payments-sdk
 
+## 0.1.0
+
+### Minor Changes
+
+- f782132: Added validations for the different payment modification operations
+  Improved logic for calculating the cart payment amount
+
 ## 0.0.7
 
 ### Patch Changes

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

@@ -9,6 +9,8 @@ export declare class DefaultCartService implements CartService {
     private ctAPI;
     constructor(opts: CartServiceOptions);
     getCart(opts: GetCart): Promise<Cart>;
-    getPaymentAmount(opts: GetPaymentAmount): PaymentAmount;
+    getPaymentAmount(opts: GetPaymentAmount): Promise<PaymentAmount>;
     addPayment(opts: AddPayment): Promise<Cart>;
+    private calculateTotalPaidAmount;
+    private calculatePaymentAmount;
 }

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

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DefaultCartService = void 0;
 const ct_api_error_1 = require("../errors/ct-api.error");
+const __1 = require("../..");
 /**
  * Default implementation of the CartService interface.
  */
@@ -13,17 +14,36 @@ class DefaultCartService {
     async getCart(opts) {
         return await this.ctAPI.cart.getCartById(opts.id);
     }
-    getPaymentAmount(opts) {
+    async getPaymentAmount(opts) {
+        const paidAmount = await this.calculateTotalPaidAmount(opts.cart);
+        let cartAmount;
         if (opts.cart.taxedPrice) {
-            return {
+            cartAmount = {
                 currencyCode: opts.cart.taxedPrice.totalGross.currencyCode,
                 centAmount: opts.cart.taxedPrice.totalGross.centAmount,
             };
         }
-        return {
-            currencyCode: opts.cart.totalPrice.currencyCode,
-            centAmount: opts.cart.totalPrice.centAmount,
-        };
+        else {
+            cartAmount = {
+                currencyCode: opts.cart.totalPrice.currencyCode,
+                centAmount: opts.cart.totalPrice.centAmount,
+            };
+        }
+        if (paidAmount >= cartAmount.centAmount) {
+            throw new __1.ErrorInvalidOperation('The cart has already been paid in full', {
+                fields: {
+                    resource: opts.cart.id,
+                    paidAmount,
+                    cartAmount,
+                },
+            });
+        }
+        else {
+            return {
+                currencyCode: cartAmount.currencyCode,
+                centAmount: cartAmount.centAmount - paidAmount,
+            };
+        }
     }
     async addPayment(opts) {
         const maxRetries = 6;
@@ -50,5 +70,18 @@ class DefaultCartService {
         }
         throw err;
     }
+    async calculateTotalPaidAmount(cart) {
+        if (!cart.paymentInfo || cart.paymentInfo.payments.length === 0) {
+            return 0;
+        }
+        const payments = await Promise.all(cart.paymentInfo.payments.map((p) => this.ctAPI.payment.getPaymentById(p.id)));
+        return payments.reduce((total, payment) => total + this.calculatePaymentAmount(payment), 0);
+    }
+    calculatePaymentAmount(payment) {
+        return payment.transactions
+            .filter((transaction) => (transaction.state === 'Success' || transaction.state === 'Pending') &&
+            (transaction.type === 'Authorization' || transaction.type === 'Charge'))
+            .reduce((total, transaction) => total + transaction.amount.centAmount, 0);
+    }
 }
 exports.DefaultCartService = DefaultCartService;

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

@@ -1,5 +1,5 @@
 import { Payment, PaymentDraft } from '@commercetools/platform-sdk';
-import { GetPayment, PaymentModificationValidation, PaymentModificationValidationResult, PaymentService, PaymentServiceOptions, UpdatePayment } from '../types/payment.type';
+import { GetPayment, PaymentCancelAuthorizationValidation, PaymentChargeValidation, PaymentModificationValidationResult, PaymentRefundValidation, PaymentService, PaymentServiceOptions, UpdatePayment } from '../types/payment.type';
 /**
  * This is the default implementation of the PaymentService interface.
  */
@@ -9,7 +9,9 @@ export declare class DefaultPaymentService implements PaymentService {
     getPayment(opts: GetPayment): Promise<Payment>;
     createPayment(draft: PaymentDraft): Promise<Payment>;
     updatePayment(opts: UpdatePayment): Promise<Payment>;
-    validatePaymentModification(opts: PaymentModificationValidation): PaymentModificationValidationResult;
+    validatePaymentCancelAuthorization(opts: PaymentCancelAuthorizationValidation): PaymentModificationValidationResult;
+    validatePaymentCharge(opts: PaymentChargeValidation): PaymentModificationValidationResult;
+    validatePaymentRefund(opts: PaymentRefundValidation): PaymentModificationValidationResult;
     private consolidateUpdateActions;
     private populateSetInterfaceIdAction;
     private populateChangeTransactionInteractionId;
@@ -18,8 +20,5 @@ export declare class DefaultPaymentService implements PaymentService {
     private populateSetPaymentMethod;
     private findMatchingTransactions;
     private consolidateTransactionChanges;
-    private validateCancelAuthorization;
-    private validateCapturePayment;
-    private validateRefundPayment;
     private calculateTotalAmount;
 }

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

@@ -44,17 +44,58 @@ class DefaultPaymentService {
         }
         throw err;
     }
-    validatePaymentModification(opts) {
-        switch (opts.type) {
-            case 'cancelAuthorization':
-                return this.validateCancelAuthorization(opts.payment);
-            case 'capturePayment':
-                return this.validateCapturePayment(opts.payment, opts.amount);
-            case 'refundPayment':
-                return this.validateRefundPayment(opts.payment, opts.amount);
-            default:
-                throw new Error(`Invalid payment modification type: ${opts.type}`);
+    validatePaymentCancelAuthorization(opts) {
+        const totalAuthorized = this.calculateTotalAmount(opts.payment, 'Authorization', opts.payment.amountPlanned.currencyCode);
+        if (totalAuthorized === 0) {
+            return { isValid: false, reason: `No authorization transaction found for resource ${opts.payment.id}.` };
+        }
+        const totalCaptured = this.calculateTotalAmount(opts.payment, 'Charge', opts.payment.amountPlanned.currencyCode);
+        if (totalCaptured > 0) {
+            return { isValid: false, reason: `Resource ${opts.payment.id} has already been charged.` };
         }
+        return { isValid: true };
+    }
+    validatePaymentCharge(opts) {
+        if (opts.payment.amountPlanned.currencyCode !== opts.amount.currencyCode) {
+            return {
+                isValid: false,
+                reason: `Invalid currency ${opts.amount.currencyCode} for resource ${opts.payment.id}, expected ${opts.payment.amountPlanned.currencyCode}`,
+            };
+        }
+        const totalAuthorized = this.calculateTotalAmount(opts.payment, 'Authorization', opts.amount.currencyCode);
+        if (totalAuthorized === 0) {
+            return { isValid: false, reason: `No authorization transaction found for resource ${opts.payment.id}.` };
+        }
+        const totalCaptured = this.calculateTotalAmount(opts.payment, 'Charge', opts.amount.currencyCode);
+        const allowedAmount = totalAuthorized - totalCaptured;
+        if (opts.amount.centAmount > allowedAmount) {
+            return {
+                isValid: false,
+                reason: `The amount to capture ${opts.amount.centAmount} exceeds the allowed amount [${allowedAmount}]`,
+            };
+        }
+        return { isValid: true };
+    }
+    validatePaymentRefund(opts) {
+        if (opts.payment.amountPlanned.currencyCode !== opts.amount.currencyCode) {
+            return {
+                isValid: false,
+                reason: `Invalid currency ${opts.amount.currencyCode} for resource ${opts.payment.id}, expected ${opts.payment.amountPlanned.currencyCode}`,
+            };
+        }
+        const totalCaptured = this.calculateTotalAmount(opts.payment, 'Charge', opts.amount.currencyCode);
+        if (totalCaptured === 0) {
+            return { isValid: false, reason: `No charge transaction found for resource ${opts.payment.id}.` };
+        }
+        const totalRefunded = this.calculateTotalAmount(opts.payment, 'Refund', opts.amount.currencyCode);
+        const allowedAmount = totalCaptured - totalRefunded;
+        if (opts.amount.centAmount > allowedAmount) {
+            return {
+                isValid: false,
+                reason: `The amount to refund ${opts.amount.centAmount} exceeds the allowed amount [${allowedAmount}]`,
+            };
+        }
+        return { isValid: true };
     }
     consolidateUpdateActions(payment, updateInfo) {
         const actions = [];
@@ -137,59 +178,6 @@ class DefaultPaymentService {
         }
         return actions;
     }
-    validateCancelAuthorization(payment) {
-        const totalAuthorized = this.calculateTotalAmount(payment, 'Authorization', payment.amountPlanned.currencyCode);
-        if (totalAuthorized === 0) {
-            return { isValid: false, reason: `No authorization transaction found for resource ${payment.id}.` };
-        }
-        const totalCaptured = this.calculateTotalAmount(payment, 'Charge', payment.amountPlanned.currencyCode);
-        if (totalCaptured > 0) {
-            return { isValid: false, reason: `Resource ${payment.id} has already been charged.` };
-        }
-        return { isValid: true };
-    }
-    validateCapturePayment(payment, amount) {
-        if (payment.amountPlanned.currencyCode !== amount.currencyCode) {
-            return {
-                isValid: false,
-                reason: `Invalid currency ${amount.currencyCode} for resource ${payment.id}, expected ${payment.amountPlanned.currencyCode}`,
-            };
-        }
-        const totalAuthorized = this.calculateTotalAmount(payment, 'Authorization', amount.currencyCode);
-        if (totalAuthorized === 0) {
-            return { isValid: false, reason: `No authorization transaction found for resource ${payment.id}.` };
-        }
-        const totalCaptured = this.calculateTotalAmount(payment, 'Charge', amount.currencyCode);
-        const allowedAmount = totalAuthorized - totalCaptured;
-        if (amount.centAmount > allowedAmount) {
-            return {
-                isValid: false,
-                reason: `The amount to capture ${amount.centAmount} exceeds the allowed amount [${allowedAmount}]`,
-            };
-        }
-        return { isValid: true };
-    }
-    validateRefundPayment(payment, amount) {
-        if (payment.amountPlanned.currencyCode !== amount.currencyCode) {
-            return {
-                isValid: false,
-                reason: `Invalid currency ${amount.currencyCode} for resource ${payment.id}, expected ${payment.amountPlanned.currencyCode}`,
-            };
-        }
-        const totalCaptured = this.calculateTotalAmount(payment, 'Charge', amount.currencyCode);
-        if (totalCaptured === 0) {
-            return { isValid: false, reason: `No charge transaction found for resource ${payment.id}.` };
-        }
-        const totalRefunded = this.calculateTotalAmount(payment, 'Refund', amount.currencyCode);
-        const allowedAmount = totalCaptured - totalRefunded;
-        if (amount.centAmount > allowedAmount) {
-            return {
-                isValid: false,
-                reason: `The amount to refund ${amount.centAmount} exceeds the allowed amount [${allowedAmount}]`,
-            };
-        }
-        return { isValid: true };
-    }
     calculateTotalAmount(payment, type, currencyCode) {
         return payment.transactions
             .filter((transaction) => transaction.type === type &&

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

@@ -13,4 +13,5 @@ export declare class DefaultSessionService implements SessionService {
     verifySession(sessionId: string): Promise<Session>;
     getCartFromSession(session: Session): string;
     getAllowedPaymentMethodsFromSession(session: Session): string[];
+    getPaymentInterfaceFromSession(session: Session): string | undefined;
 }

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

@@ -41,5 +41,8 @@ class DefaultSessionService {
     getAllowedPaymentMethodsFromSession(session) {
         return session.metadata?.allowedPaymentMethods || [];
     }
+    getPaymentInterfaceFromSession(session) {
+        return session.metadata?.paymentInterface;
+    }
 }
 exports.DefaultSessionService = DefaultSessionService;

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

@@ -16,6 +16,6 @@ export type CartServiceOptions = {
  */
 export interface CartService {
     getCart(opts: GetCart): Promise<Cart>;
-    getPaymentAmount(opts: GetPaymentAmount): PaymentAmount;
+    getPaymentAmount(opts: GetPaymentAmount): Promise<PaymentAmount>;
     addPayment(opts: AddPayment): Promise<Cart>;
 }

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

@@ -28,10 +28,16 @@ export type UpdatePayment = {
     transaction?: TransactionData;
     paymentMethod?: string;
 };
-export type PaymentModificationValidation = {
+export type PaymentCancelAuthorizationValidation = {
+    payment: Payment;
+};
+export type PaymentChargeValidation = {
+    payment: Payment;
+    amount: Money;
+};
+export type PaymentRefundValidation = {
     payment: Payment;
     amount: Money;
-    type: TransactionType;
 };
 export type PaymentModificationValidationResult = {
     isValid: boolean;
@@ -44,5 +50,7 @@ export interface PaymentService {
     getPayment(opts: GetPayment): Promise<Payment>;
     createPayment(draft: PaymentDraft): Promise<Payment>;
     updatePayment(opts: UpdatePayment): Promise<Payment>;
-    validatePaymentModification(opts: PaymentModificationValidation): PaymentModificationValidationResult;
+    validatePaymentCancelAuthorization(opts: PaymentCancelAuthorizationValidation): PaymentModificationValidationResult;
+    validatePaymentCharge(opts: PaymentChargeValidation): PaymentModificationValidationResult;
+    validatePaymentRefund(opts: PaymentRefundValidation): PaymentModificationValidationResult;
 }

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

@@ -25,4 +25,5 @@ export interface SessionService {
     verifySession(sessionId: string): Promise<Session>;
     getCartFromSession(session: Session): string;
     getAllowedPaymentMethodsFromSession(session: Session): string[];
+    getPaymentInterfaceFromSession(session: Session): string | undefined;
 }

package/dist/security/authn/session-authn-manager.js

@@ -15,6 +15,7 @@ class SessionAuthenticationManager {
             return new authns_1.SessionAuthentication(principal.authHeader, {
                 cartId: this.sessionService.getCartFromSession(session),
                 allowedPaymentMethods: this.sessionService.getAllowedPaymentMethodsFromSession(session),
+                paymentInterface: this.sessionService.getPaymentInterfaceFromSession(session),
             });
         }
         catch (e) {

package/dist/security/authn/types/authn.type.d.ts

@@ -15,6 +15,7 @@ export type HeaderPrincipal = {
 export type SessionPrincipal = {
     cartId: string;
     allowedPaymentMethods: string[];
+    paymentInterface?: string;
 };
 export type Oauth2Principal = {
     clientId: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@commercetools/connect-payments-sdk",
-  "version": "0.0.7",
+  "version": "0.1.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/platform-sdk": "7.2.0-alpha.4",
+    "@commercetools/platform-sdk": "7.3.0",
     "@commercetools/sdk-client-v2": "2.3.0",
     "jsonwebtoken": "9.0.2",
     "jwks-rsa": "3.1.0"