@commercetools/connect-payments-sdk 0.5.0 → 0.7.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @commercetools/connect-payments-sdk
 
+## 0.7.0
+
+### Minor Changes
+
+- e471faf: Adding logs in the status handler
+
+## 0.6.0
+
+### Minor Changes
+
+- 7c751f2: removed validations for payment modifications (capture, refund and cancel)
+
 ## 0.5.0
 
 ### Minor Changes

package/dist/api/handlers/status.handler.d.ts

@@ -1,4 +1,5 @@
 import { CommercetoolsAuthorizationService } from '../../commercetools';
+import { Logger } from '../../logger';
 import { HandlerResponse } from './types/handler.type';
 type HealthCheckStatus = {
     status: 'OK' | 'Partially Available' | 'Unavailable';
@@ -11,13 +12,21 @@ export type HealthCheckResult = {
     name: string;
     status: 'UP' | 'DOWN';
     details?: object;
+    message?: string;
 };
 export type HealthCheck = () => Promise<HealthCheckResult> | HealthCheckResult;
-export declare const statusHandler: (options: {
+export type StatusHandlerOpts = {
     timeout: number;
     checks: HealthCheck[];
     metadataFn?: () => Promise<object> | object;
-}) => () => Promise<HandlerResponse<HealthCheckStatus>>;
+    log: Logger;
+};
+/**
+ * Handler to check the status of the service
+ * @param opts
+ * @returns
+ */
+export declare const statusHandler: (opts: StatusHandlerOpts) => () => Promise<HandlerResponse<HealthCheckStatus>>;
 /**
  * Check if CoCo permissions are available
  * @param opts

package/dist/api/handlers/status.handler.js

@@ -1,19 +1,38 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.healthCheckCommercetoolsPermissions = exports.statusHandler = void 0;
-const statusHandler = (options) => async () => {
+/**
+ * Handler to check the status of the service
+ * @param opts
+ * @returns
+ */
+const statusHandler = (opts) => async () => {
     const status = {
         timestamp: new Date().toISOString(),
         version: process.env.npm_package_version ?? '0.0.0',
     };
-    if (options.metadataFn) {
-        status.metadata = await options.metadataFn();
+    if (opts.metadataFn) {
+        status.metadata = await opts.metadataFn();
     }
     let timeoutId = null;
-    const timeoutPromise = new Promise((_, reject) => (timeoutId = setTimeout(() => reject(new Error('Timeout')), options.timeout)));
+    const timeoutPromise = new Promise((_, reject) => (timeoutId = setTimeout(() => reject(new Error('Timeout')), opts.timeout)));
     try {
-        const results = await Promise.race([Promise.all(options.checks.map((check) => check())), timeoutPromise]);
-        if (results.findIndex((result) => result.status === 'DOWN') !== -1) {
+        const results = await Promise.race([Promise.all(opts.checks.map((check) => check())), timeoutPromise]);
+        let allDown = true;
+        let atLeastOneDown = false;
+        results.forEach((result) => {
+            if (result.status === 'DOWN') {
+                atLeastOneDown = true;
+                opts.log.error({ details: result.details }, result.message ?? `Health check for ${result.name} failed, check details`);
+            }
+            if (result.status === 'UP') {
+                allDown = false;
+            }
+        });
+        if (allDown) {
+            status.status = 'Unavailable';
+        }
+        else if (atLeastOneDown) {
             status.status = 'Partially Available';
         }
         else {
@@ -21,11 +40,14 @@ const statusHandler = (options) => async () => {
         }
         status.checks = results;
         return {
-            status: 200,
+            status: allDown ? 503 : 200,
             body: status,
         };
     }
-    catch (error) {
+    catch (e) {
+        if (e instanceof Error && e.message === 'Timeout') {
+            opts.log.error({ err: e }, 'Health check timed out');
+        }
         status.status = 'Unavailable';
         status.checks = [];
         return {
@@ -60,6 +82,7 @@ const healthCheckCommercetoolsPermissions = (opts) => async () => {
     return {
         name: 'CoCo Permissions',
         status: 'DOWN',
+        message: `CoCo permissions are not correct, expected scopes: ${opts.requiredPermissions.join(' ')}, actual scopes: ${token.scope}`,
         details: {
             expectedScopes: opts.requiredPermissions,
             actualScopes: token.scope,

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

@@ -1,5 +1,5 @@
 import { Payment, PaymentDraft, Transaction } from '@commercetools/platform-sdk';
-import { GetPayment, PaymentCancelAuthorizationValidation, PaymentChargeValidation, PaymentModificationValidationResult, PaymentRefundValidation, PaymentService, PaymentServiceOptions, TransactionData, UpdatePayment } from '../types/payment.type';
+import { GetPayment, PaymentService, PaymentServiceOptions, TransactionData, UpdatePayment } from '../types/payment.type';
 /**
  * This is the default implementation of the PaymentService interface.
  */
@@ -10,9 +10,6 @@ export declare class DefaultPaymentService implements PaymentService {
     getPayment(opts: GetPayment): Promise<Payment>;
     createPayment(draft: PaymentDraft): Promise<Payment>;
     updatePayment(opts: UpdatePayment): Promise<Payment>;
-    validatePaymentCancelAuthorization(opts: PaymentCancelAuthorizationValidation): PaymentModificationValidationResult;
-    validatePaymentCharge(opts: PaymentChargeValidation): PaymentModificationValidationResult;
-    validatePaymentRefund(opts: PaymentRefundValidation): PaymentModificationValidationResult;
     private consolidateUpdateActions;
     private populateSetInterfaceIdAction;
     private populateChangeTransactionInteractionId;
@@ -21,6 +18,4 @@ export declare class DefaultPaymentService implements PaymentService {
     private populateSetPaymentMethod;
     findMatchingTransactions(payment: Payment, transaction: TransactionData): Transaction[];
     private consolidateTransactionChanges;
-    private hasTransactionWithState;
-    private calculateTotalAmount;
 }

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

@@ -47,78 +47,6 @@ class DefaultPaymentService {
         }
         throw err;
     }
-    validatePaymentCancelAuthorization(opts) {
-        if (!this.hasTransactionWithState(opts.payment, 'Authorization', ['Success'])) {
-            return { isValid: false, reason: `No authorization transaction found for resource ${opts.payment.id}.` };
-        }
-        if (this.hasTransactionWithState(opts.payment, 'CancelAuthorization', ['Success'])) {
-            return { isValid: false, reason: `Resource ${opts.payment.id} has already been cancelled.` };
-        }
-        if (this.hasTransactionWithState(opts.payment, 'CancelAuthorization', ['Pending'])) {
-            return { isValid: false, reason: `Resource ${opts.payment.id} is pending to be cancelled.` };
-        }
-        if (this.hasTransactionWithState(opts.payment, 'Charge', ['Success'])) {
-            return { isValid: false, reason: `Resource ${opts.payment.id} has already been charged.` };
-        }
-        if (this.hasTransactionWithState(opts.payment, 'Charge', ['Pending'])) {
-            return { isValid: false, reason: `Resource ${opts.payment.id} is pending to be 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}.` };
-        }
-        if (this.hasTransactionWithState(opts.payment, 'CancelAuthorization', ['Success'])) {
-            return { isValid: false, reason: `Resource ${opts.payment.id} has already been cancelled.` };
-        }
-        if (this.hasTransactionWithState(opts.payment, 'CancelAuthorization', ['Pending'])) {
-            return { isValid: false, reason: `Resource ${opts.payment.id} is pending to be cancelled.` };
-        }
-        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}`,
-            };
-        }
-        if (this.hasTransactionWithState(opts.payment, 'CancelAuthorization', ['Success'])) {
-            return { isValid: false, reason: `Resource ${opts.payment.id} has already been cancelled.` };
-        }
-        if (this.hasTransactionWithState(opts.payment, 'CancelAuthorization', ['Pending'])) {
-            return { isValid: false, reason: `Resource ${opts.payment.id} is pending to be cancelled.` };
-        }
-        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 = [];
         if (!payment.interfaceId && updateInfo.pspReference) {
@@ -209,15 +137,5 @@ class DefaultPaymentService {
         }
         return actions;
     }
-    hasTransactionWithState(payment, type, state) {
-        return payment.transactions.some((transaction) => transaction.type === type && state.includes(transaction.state));
-    }
-    calculateTotalAmount(payment, type, currencyCode) {
-        return payment.transactions
-            .filter((transaction) => transaction.type === type &&
-            transaction.state === 'Success' &&
-            transaction.amount.currencyCode === currencyCode)
-            .reduce((total, transaction) => total + transaction.amount.centAmount, 0);
-    }
 }
 exports.DefaultPaymentService = DefaultPaymentService;

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

@@ -30,21 +30,6 @@ export type UpdatePayment = {
     transaction?: TransactionData;
     paymentMethod?: string;
 };
-export type PaymentCancelAuthorizationValidation = {
-    payment: Payment;
-};
-export type PaymentChargeValidation = {
-    payment: Payment;
-    amount: Money;
-};
-export type PaymentRefundValidation = {
-    payment: Payment;
-    amount: Money;
-};
-export type PaymentModificationValidationResult = {
-    isValid: boolean;
-    reason?: string;
-};
 /**
  * Payment service interface exposes methods to interact with the commercetools platform API.
  */
@@ -52,7 +37,4 @@ export interface PaymentService {
     getPayment(opts: GetPayment): Promise<Payment>;
     createPayment(draft: PaymentDraft): Promise<Payment>;
     updatePayment(opts: UpdatePayment): Promise<Payment>;
-    validatePaymentCancelAuthorization(opts: PaymentCancelAuthorizationValidation): PaymentModificationValidationResult;
-    validatePaymentCharge(opts: PaymentChargeValidation): PaymentModificationValidationResult;
-    validatePaymentRefund(opts: PaymentRefundValidation): PaymentModificationValidationResult;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@commercetools/connect-payments-sdk",
-  "version": "0.5.0",
+  "version": "0.7.0",
   "description": "Payment SDK for commercetools payment connectors",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -15,9 +15,9 @@
   ],
   "license": "ISC",
   "dependencies": {
-    "@commercetools-backend/loggers": "22.23.3",
-    "@commercetools/platform-sdk": "7.7.0",
-    "@commercetools/sdk-client-v2": "2.4.1",
+    "@commercetools-backend/loggers": "22.27.0",
+    "@commercetools/platform-sdk": "7.8.0",
+    "@commercetools/sdk-client-v2": "2.5.0",
     "jsonwebtoken": "9.0.2",
     "jwks-rsa": "3.1.0",
     "lodash": "4.17.21",