@commercetools/connect-payments-sdk 0.18.1 → 0.20.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @commercetools/connect-payments-sdk
 
+## 0.20.0
+
+### Minor Changes
+
+- 772d5be: Add support for updating payment interface interactions. It introduces a breaking change, the CustomFieldsData type has been removed.
+
+## 0.19.0
+
+### Minor Changes
+
+- 16d7341: feat(sdk): add and export function to convert coco line item tax rate into minor units
+
 ## 0.18.1
 
 ### Patch Changes

package/dist/commercetools/helpers/taxrate.converter.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Convert the CoCo tax percentage, for example found on "lineItems", which ranges from 0-1 as floating point numbers to the minor units.
+ *
+ * @example CoCo taxRate of 0.21, normalized is 21%, in minor-units = 2100
+ * @example CoCo taxRate of 0.07, normalized is 7%, in minor-units = 700
+ * @example CoCo taxRate of 0.489, normalized is 48.9%, in minor-units = 4891
+ *
+ * @param decimalTaxRate the tax rate expressed in decimals between 0-1 as floating point numbers taken from the CoCo taxRate (see docs below).
+ *
+ * @throw "Error" if the provided value is not between 0 and 1;
+ *
+ * @returns 0 if undefined is provided
+ *
+ * @see https://docs.commercetools.com/api/projects/taxCategories#ctp:api:type:TaxRate
+ */
+declare const convertCoCoTaxPercentage: (decimalTaxRate?: number) => number;
+export { convertCoCoTaxPercentage };

package/dist/commercetools/helpers/taxrate.converter.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.convertCoCoTaxPercentage = void 0;
+/**
+ * Convert the CoCo tax percentage, for example found on "lineItems", which ranges from 0-1 as floating point numbers to the minor units.
+ *
+ * @example CoCo taxRate of 0.21, normalized is 21%, in minor-units = 2100
+ * @example CoCo taxRate of 0.07, normalized is 7%, in minor-units = 700
+ * @example CoCo taxRate of 0.489, normalized is 48.9%, in minor-units = 4891
+ *
+ * @param decimalTaxRate the tax rate expressed in decimals between 0-1 as floating point numbers taken from the CoCo taxRate (see docs below).
+ *
+ * @throw "Error" if the provided value is not between 0 and 1;
+ *
+ * @returns 0 if undefined is provided
+ *
+ * @see https://docs.commercetools.com/api/projects/taxCategories#ctp:api:type:TaxRate
+ */
+const convertCoCoTaxPercentage = (decimalTaxRate) => {
+    if (!decimalTaxRate) {
+        return 0;
+    }
+    if (decimalTaxRate < 0 || decimalTaxRate > 1) {
+        throw new Error(`The provided decimal tax rate of ${decimalTaxRate} is invalid. Only allowed values between 0 and 1.0`);
+    }
+    // First go from the range of 0 - 1 decimal value, to value expressed as a "normal" percentage. I.e. 0.15% from CoCo becomes 15.
+    const taxRateNormalized = decimalTaxRate * Math.pow(10, 2);
+    // Apply conversion to make it a minor unit "minor-units" format. I.e. 15 becomes 1500.
+    const taxRateMinorUnitsFormat = taxRateNormalized * Math.pow(10, 2);
+    const taxRateMinorUnit = taxRateMinorUnitsFormat.toFixed(0);
+    return parseInt(taxRateMinorUnit);
+};
+exports.convertCoCoTaxPercentage = convertCoCoTaxPercentage;

package/dist/commercetools/index.d.ts

@@ -4,5 +4,6 @@ export { SessionService as CommercetoolsSessionService, Session } from './types/
 export { AuthorizationService as CommercetoolsAuthorizationService } from './types/authorization.type';
 export { OrderService as CommercetoolsOrderService } from './types/order.type';
 export { CommercetoolsClient } from './types/api.type';
-export { Cart, Order, OrderPagedQueryResponse, Payment, PaymentDraft, Money, LineItem, CustomLineItem, Address, Transaction, TransactionType, TransactionState, ShippingInfo, } from '@commercetools/platform-sdk';
+export { CustomFields, Cart, Order, OrderPagedQueryResponse, Payment, PaymentDraft, Money, LineItem, CustomLineItem, Address, Transaction, TransactionType, TransactionState, ShippingInfo, } from '@commercetools/platform-sdk';
 export * as CurrencyConverters from './helpers/currency.converter';
+export * as TaxRateConverter from './helpers/taxrate.converter';

package/dist/commercetools/index.js

@@ -33,5 +33,6 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CurrencyConverters = void 0;
+exports.TaxRateConverter = exports.CurrencyConverters = void 0;
 exports.CurrencyConverters = __importStar(require("./helpers/currency.converter"));
+exports.TaxRateConverter = __importStar(require("./helpers/taxrate.converter"));

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

@@ -18,6 +18,7 @@ export declare class DefaultPaymentService implements PaymentService {
     private populateChangeTransactionState;
     private populateSetPaymentMethod;
     private populateSetCustomType;
+    private populateAddInterfaceInteractions;
     findMatchingTransactions(payment: Payment, transaction: TransactionData): Transaction[];
     private consolidateTransactionChanges;
 }

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

@@ -76,6 +76,9 @@ class DefaultPaymentService {
         if (updateInfo.customFields) {
             actions.push(this.populateSetCustomType(updateInfo.customFields));
         }
+        if (updateInfo.pspInteractions && updateInfo.pspInteractions.length > 0) {
+            actions.push(...this.populateAddInterfaceInteractions(updateInfo.pspInteractions));
+        }
         return actions;
     }
     populateSetInterfaceIdAction(interfaceId) {
@@ -116,13 +119,17 @@ class DefaultPaymentService {
     populateSetCustomType(customFields) {
         return {
             action: 'setCustomType',
-            type: {
-                typeId: 'type',
-                key: customFields.typeKey,
-            },
-            fields: customFields.fields,
+            ...customFields,
         };
     }
+    populateAddInterfaceInteractions(pspInteractions) {
+        return pspInteractions.map((interaction) => {
+            return {
+                action: 'addInterfaceInteraction',
+                ...interaction,
+            };
+        });
+    }
     findMatchingTransactions(payment, transaction) {
         return payment.transactions.filter((tx) => {
             return (tx.type === transaction.type &&

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

@@ -1,4 +1,4 @@
-import { Money, Payment, PaymentDraft, TransactionState, TransactionType } from '@commercetools/platform-sdk';
+import { CustomFields, Money, Payment, PaymentDraft, TransactionState, TransactionType } from '@commercetools/platform-sdk';
 import { CommercetoolsAPI } from './api.type';
 import { Logger } from '../../logger';
 export type PaymentAmount = {
@@ -27,17 +27,13 @@ export type TransactionData = {
     interactionId?: string;
     state: TransactionState;
 };
-export type CustomFieldsData = {
-    typeKey: string;
-    fields: Record<string, unknown>;
-};
 export type UpdatePayment = {
     id: string;
     pspReference?: string;
-    pspInteraction?: PSPInteraction;
+    pspInteractions?: CustomFields[];
     transaction?: TransactionData;
     paymentMethod?: string;
-    customFields?: CustomFieldsData;
+    customFields?: CustomFields;
 };
 /**
  * Payment service interface exposes methods to interact with the commercetools platform API.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@commercetools/connect-payments-sdk",
-  "version": "0.18.1",
+  "version": "0.20.0",
   "description": "Payment SDK for commercetools payment connectors",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -15,11 +15,11 @@
   ],
   "license": "ISC",
   "dependencies": {
-    "@commercetools-backend/loggers": "22.39.1",
-    "@commercetools/platform-sdk": "8.1.0",
+    "@commercetools-backend/loggers": "23.2.0",
+    "@commercetools/platform-sdk": "8.5.0",
     "@commercetools/sdk-client-v2": "2.5.0",
     "jsonwebtoken": "9.0.2",
-    "jwks-rsa": "3.1.0",
+    "jwks-rsa": "3.2.0",
     "lodash": "4.17.21",
     "logform": "2.7.0"
   }