@commercetools/connect-payments-sdk 0.20.1 → 0.21.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @commercetools/connect-payments-sdk
 
+## 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 { FindPaymentsByInterfaceId, FindTransaction, GetPayment, PaymentService, PaymentServiceOptions, TransactionData, UpdatePayment } from '../types/payment.type';
 /**
  * This is the default implementation of the PaymentService interface.
  */
@@ -20,5 +20,6 @@ export declare class DefaultPaymentService implements PaymentService {
     private populateSetCustomType;
     private populateAddInterfaceInteractions;
     findMatchingTransactions(payment: Payment, transaction: TransactionData): Transaction[];
+    hasTransactionInState(opts: FindTransaction): boolean;
     private consolidateTransactionChanges;
 }

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

@@ -141,6 +141,9 @@ class DefaultPaymentService {
                         tx.state === 'Initial')));
         });
     }
+    hasTransactionInState(opts) {
+        return opts.payment.transactions.some((tx) => tx.type === opts.transactionType && opts.states.includes(tx.state));
+    }
     consolidateTransactionChanges(payment, transaction) {
         const actions = [];
         // If the transaction is in Initial state and has no interactionId, we discard it as it does not provide any value

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.21.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": "23.2.0",
+    "@commercetools-backend/loggers": "23.2.2",
     "@commercetools/platform-sdk": "8.5.0",
     "@commercetools/sdk-client-v2": "2.5.0",
     "jsonwebtoken": "9.0.2",