@commercetools/connect-payments-sdk 0.20.1 → 0.22.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @commercetools/connect-payments-sdk
 
+## 0.22.0
+
+### Minor Changes
+
+- 8a98393: Improve logic for managing payment updates
+
+## 0.21.0
+
+### Minor Changes
+
+- 9946b9e: introduces hasTransactionInState method for checking if a payment has a transaction with some set filters, (type and state)
+
 ## 0.20.1
 
 ### Patch Changes

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

@@ -1,5 +1,5 @@
-import { Payment, PaymentDraft, Transaction } from '@commercetools/platform-sdk';
-import { FindPaymentsByInterfaceId, GetPayment, PaymentService, PaymentServiceOptions, TransactionData, UpdatePayment } from '../types/payment.type';
+import { Payment, PaymentDraft, PaymentUpdateAction, Transaction } from '@commercetools/platform-sdk';
+import { FindPaymentsByInterfaceId, FindTransaction, GetPayment, PaymentService, PaymentServiceOptions, TransactionData, UpdatePayment } from '../types/payment.type';
 /**
  * This is the default implementation of the PaymentService interface.
  */
@@ -20,5 +20,11 @@ export declare class DefaultPaymentService implements PaymentService {
     private populateSetCustomType;
     private populateAddInterfaceInteractions;
     findMatchingTransactions(payment: Payment, transaction: TransactionData): Transaction[];
-    private consolidateTransactionChanges;
+    hasTransactionInState(opts: FindTransaction): boolean;
+    consolidateTransactionChanges(payment: Payment, newTransaction: TransactionData): PaymentUpdateAction[];
+    private shouldDiscardTransaction;
+    private handleTransactionUpdates;
+    private shouldUpdateTransactionState;
+    private shouldUpdateInteractionId;
+    private throwMultipleMatchingTransactionsError;
 }

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

@@ -141,33 +141,57 @@ class DefaultPaymentService {
                         tx.state === 'Initial')));
         });
     }
-    consolidateTransactionChanges(payment, transaction) {
+    hasTransactionInState(opts) {
+        return opts.payment.transactions.some((tx) => tx.type === opts.transactionType && opts.states.includes(tx.state));
+    }
+    consolidateTransactionChanges(payment, newTransaction) {
         const actions = [];
-        // If the transaction is in Initial state and has no interactionId, we discard it as it does not provide any value
-        if (transaction.state === 'Initial' && !transaction.interactionId) {
+        // Discard transactions in 'Initial' state without an interactionId as they provide no value
+        if (this.shouldDiscardTransaction(newTransaction)) {
             return [];
         }
-        const matchingTxs = this.findMatchingTransactions(payment, transaction);
+        // Find matching transactions in the payment
+        const matchingTxs = this.findMatchingTransactions(payment, newTransaction);
+        // Handle cases where no matching transactions are found
         if (matchingTxs.length === 0) {
-            actions.push(this.populateAddTransactionAction(transaction));
+            actions.push(this.populateAddTransactionAction(newTransaction));
+            return actions;
         }
-        else {
-            if (matchingTxs.length === 1) {
-                const tx = matchingTxs[0];
-                if ((tx.state !== transaction.state && tx.state === 'Initial') ||
-                    (tx.state === 'Pending' && (transaction.state === 'Success' || transaction.state === 'Failure'))) {
-                    actions.push(this.populateChangeTransactionState(tx.id, transaction.state));
-                    if (!tx.interactionId && transaction.interactionId) {
-                        actions.push(this.populateChangeTransactionInteractionId(tx.id, transaction.interactionId));
-                    }
-                }
-            }
-            else {
-                this.logger.error({ paymentId: payment.id, transaction }, 'Multiple transactions found when consolidating payment changes');
-                throw new Error('Multiple transactions found');
-            }
+        // Handle cases where exactly one matching transaction is found
+        if (matchingTxs.length === 1) {
+            const existingTx = matchingTxs[0];
+            this.handleTransactionUpdates(existingTx, newTransaction, actions);
+            return actions;
         }
-        return actions;
+        // Handle cases where multiple matching transactions are found
+        this.throwMultipleMatchingTransactionsError(payment, newTransaction, matchingTxs);
+    }
+    shouldDiscardTransaction(newTransaction) {
+        return newTransaction.state === 'Initial' && !newTransaction.interactionId;
+    }
+    handleTransactionUpdates(existingTx, newTransaction, actions) {
+        if (this.shouldUpdateTransactionState(existingTx, newTransaction)) {
+            actions.push(this.populateChangeTransactionState(existingTx.id, newTransaction.state));
+        }
+        if (this.shouldUpdateInteractionId(existingTx, newTransaction)) {
+            actions.push(this.populateChangeTransactionInteractionId(existingTx.id, newTransaction.interactionId));
+        }
+    }
+    shouldUpdateTransactionState(existingTx, newTransaction) {
+        return ((existingTx.state !== newTransaction.state && existingTx.state === 'Initial') ||
+            (existingTx.state === 'Pending' && (newTransaction.state === 'Success' || newTransaction.state === 'Failure')) ||
+            (existingTx.state === 'Failure' && newTransaction.state === 'Success'));
+    }
+    shouldUpdateInteractionId(existingTx, newTransaction) {
+        return !existingTx.interactionId && !!newTransaction.interactionId;
+    }
+    throwMultipleMatchingTransactionsError(payment, newTransaction, matchingTxs) {
+        this.logger.error({
+            paymentId: payment.id,
+            transaction: newTransaction,
+            matchingTransactions: matchingTxs,
+        }, 'Multiple matching transactions found when consolidating payment changes');
+        throw new Error(`Multiple matching transactions found for payment ${payment.id} and transaction ${JSON.stringify(newTransaction)}`);
     }
 }
 exports.DefaultPaymentService = DefaultPaymentService;

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

@@ -35,12 +35,18 @@ export type UpdatePayment = {
     paymentMethod?: string;
     customFields?: CustomFieldsDraft;
 };
+export type FindTransaction = {
+    payment: Payment;
+    transactionType: TransactionType;
+    states: TransactionState[];
+};
 /**
  * Payment service interface exposes methods to interact with the commercetools platform API.
  */
 export interface PaymentService {
     getPayment(opts: GetPayment): Promise<Payment>;
     findPaymentsByInterfaceId(opts: FindPaymentsByInterfaceId): Promise<Payment[]>;
+    hasTransactionInState(opts: FindTransaction): boolean;
     createPayment(draft: PaymentDraft): Promise<Payment>;
     updatePayment(opts: UpdatePayment): Promise<Payment>;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@commercetools/connect-payments-sdk",
-  "version": "0.20.1",
+  "version": "0.22.0",
   "description": "Payment SDK for commercetools payment connectors",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -15,8 +15,8 @@
   ],
   "license": "ISC",
   "dependencies": {
-    "@commercetools-backend/loggers": "23.2.0",
-    "@commercetools/platform-sdk": "8.5.0",
+    "@commercetools-backend/loggers": "23.2.2",
+    "@commercetools/platform-sdk": "8.8.0",
     "@commercetools/sdk-client-v2": "2.5.0",
     "jsonwebtoken": "9.0.2",
     "jwks-rsa": "3.2.0",