@commercetools/connect-payments-sdk 0.18.0 → 0.19.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @commercetools/connect-payments-sdk
 
+## 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
+
+- 1ec3a60: Read logging correlation id from session
+
 ## 0.18.0
 
 ### Minor Changes

package/dist/api/hooks/session-header-auth.hook.js

@@ -16,8 +16,10 @@ class SessionHeaderAuthenticationHook {
         return async (request) => {
             const sessionIdAuthn = new security_1.HeaderBasedAuthentication(request.headers['x-session-id']);
             const authn = await this.authenticationManager.authenticate(sessionIdAuthn);
+            const correlationId = authn.getPrincipal().correlationId;
             this.contextProvider.updateContextData({
                 authentication: authn,
+                ...(correlationId && { correlationId }),
             });
         };
     }

package/dist/api/hooks/session-query-param-auth.hook.js

@@ -16,8 +16,10 @@ class SessionQueryParamAuthenticationHook {
         return async (request) => {
             const sessionIdAuthn = new security_1.QueryParamBasedAuthentication(request.query['ctsid']);
             const authn = await this.authenticationManager.authenticate(sessionIdAuthn);
+            const correlationId = authn.getPrincipal().correlationId;
             this.contextProvider.updateContextData({
                 authentication: authn,
+                ...(correlationId && { correlationId }),
             });
         };
     }

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

@@ -6,3 +6,4 @@ 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 * 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-session.service.d.ts

@@ -22,5 +22,6 @@ export declare class DefaultSessionService implements SessionService {
     getMerchantReturnUrlFromSession(session: Session): string | undefined;
     getFutureOrderNumberFromSession(session: Session): string | undefined;
     getGiftCardPlannedAmountFromSession(session: Session): Money | undefined;
+    getCorrelationIdFromSession(session: Session): string | undefined;
     private getSession;
 }

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

@@ -78,6 +78,9 @@ class DefaultSessionService {
     getGiftCardPlannedAmountFromSession(session) {
         return session.metadata?.giftCardPlannedAmount;
     }
+    getCorrelationIdFromSession(session) {
+        return session.metadata?.correlationId;
+    }
     async getSession(sessionId) {
         return await fetch(`${this.sessionUrl}/${this.projectKey}/sessions/${sessionId}`, {
             method: 'GET',

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

@@ -31,4 +31,5 @@ export interface SessionService {
     getMerchantReturnUrlFromSession(session: Session): string | undefined;
     getFutureOrderNumberFromSession(session: Session): string | undefined;
     getGiftCardPlannedAmountFromSession(session: Session): Money | undefined;
+    getCorrelationIdFromSession(session: Session): string | undefined;
 }

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

@@ -22,6 +22,7 @@ class SessionHeaderAuthenticationManager {
                 merchantReturnUrl: this.sessionService.getMerchantReturnUrlFromSession(session),
                 futureOrderNumber: this.sessionService.getFutureOrderNumberFromSession(session),
                 giftCardPlannedAmount: this.sessionService.getGiftCardPlannedAmountFromSession(session),
+                correlationId: this.sessionService.getCorrelationIdFromSession(session),
             });
         }
         catch (e) {

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

@@ -24,6 +24,7 @@ export type SessionPrincipal = {
     merchantReturnUrl?: string;
     futureOrderNumber?: string;
     giftCardPlannedAmount?: Money;
+    correlationId?: string;
 };
 export type Oauth2Principal = {
     clientId: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@commercetools/connect-payments-sdk",
-  "version": "0.18.0",
+  "version": "0.19.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": "22.39.0",
+    "@commercetools-backend/loggers": "22.41.0",
     "@commercetools/platform-sdk": "8.1.0",
     "@commercetools/sdk-client-v2": "2.5.0",
     "jsonwebtoken": "9.0.2",