@commercetools/connect-payments-sdk 0.13.1 → 0.14.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @commercetools/connect-payments-sdk
 
+## 0.14.0
+
+### Minor Changes
+
+- 012a346: Add currency conversion utility functions
+
 ## 0.13.1
 
 ### Patch Changes

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

@@ -0,0 +1,52 @@
+/**
+ * Applies the fraction digit to the given amount.
+ * Positive fraction digit moves the decimal to the right, negative to the left. (i.e. adding or removing zeros from either end)
+ *
+ * @example (10, -2) => 0.1
+ * @example (10, -1) => 1
+ * @example (10, 0) => 10
+ * @example (10, 1) => 100
+ * @example (10, 2) => 1000
+ * @example (12345, -3) => 12,345
+ * @example (12345, -2) => 123,45
+ * @example (12345, -1) => 1234,5
+ * @example (12345, 0) => 12345
+ * @example (12345, 1) => 123450
+ * @example (12345, 2) => 1234500
+ * @example (12345, 3) => 12345000
+ *
+ * @throws an Error if the given fraction digit (either via mapping or directly) is not a integer value
+ */
+declare const convert: (amount: number, fractionDigit: number) => number;
+type ConvertWithMappingOptions = {
+    /**
+     * A mapping where the key is the ISO 4217 currency code value and the value is the fraction digit (integer value) to apply.
+     */
+    mapping: Map<string, number>;
+    /**
+     * The amount to apply the fraction digit to
+     */
+    amount: number;
+    /**
+     * The currency code that belongs to this amount. This is used to lookup the value in the mapping to see if it needs to be overruled
+     */
+    currencyCode: string;
+    /**
+     * The fraction digit
+     */
+    fractionDigit?: number;
+};
+/**
+ * Applies the given fraction digit to the amount with the possibility to overrule the fraction digit via the supplied mapping.
+ *
+ * @param options The options to use with converting
+ *
+ * @function convert for more information how the fractionDigit is applied
+ *
+ * @returns The original value if neither the overruling fraction digit is found or no fraction digit is given, otherwise returns the converted value based on either the overruling fraction digit or fraction digit
+ *
+ * @throws an Error if the given fraction digit (either via mapping or directly) is not a integer value
+ */
+declare const convertWithMapping: (options: ConvertWithMappingOptions) => number;
+export { convert, convertWithMapping };
+export type { ConvertWithMappingOptions };

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

@@ -0,0 +1,57 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.convertWithMapping = exports.convert = void 0;
+const validateFractionDigit = (fractionDigit) => {
+    if (!Number.isInteger(fractionDigit)) {
+        throw new Error(`The given fraction digit of "${fractionDigit}" is not a integer. Fraction digit must be an integer value.`);
+    }
+};
+/**
+ * Applies the fraction digit to the given amount.
+ * Positive fraction digit moves the decimal to the right, negative to the left. (i.e. adding or removing zeros from either end)
+ *
+ * @example (10, -2) => 0.1
+ * @example (10, -1) => 1
+ * @example (10, 0) => 10
+ * @example (10, 1) => 100
+ * @example (10, 2) => 1000
+ * @example (12345, -3) => 12,345
+ * @example (12345, -2) => 123,45
+ * @example (12345, -1) => 1234,5
+ * @example (12345, 0) => 12345
+ * @example (12345, 1) => 123450
+ * @example (12345, 2) => 1234500
+ * @example (12345, 3) => 12345000
+ *
+ * @throws an Error if the given fraction digit (either via mapping or directly) is not a integer value
+ */
+const convert = (amount, fractionDigit) => {
+    validateFractionDigit(fractionDigit);
+    return amount * (1 * Math.pow(10, fractionDigit));
+};
+exports.convert = convert;
+/**
+ * Applies the given fraction digit to the amount with the possibility to overrule the fraction digit via the supplied mapping.
+ *
+ * @param options The options to use with converting
+ *
+ * @function convert for more information how the fractionDigit is applied
+ *
+ * @returns The original value if neither the overruling fraction digit is found or no fraction digit is given, otherwise returns the converted value based on either the overruling fraction digit or fraction digit
+ *
+ * @throws an Error if the given fraction digit (either via mapping or directly) is not a integer value
+ */
+const convertWithMapping = (options) => {
+    const { amount, currencyCode, mapping, fractionDigit: fractionDigits } = options;
+    const overrulingFractionDigits = mapping.get(currencyCode);
+    if (overrulingFractionDigits) {
+        validateFractionDigit(overrulingFractionDigits);
+        return convert(amount, overrulingFractionDigits);
+    }
+    if (fractionDigits) {
+        validateFractionDigit(fractionDigits);
+        return convert(amount, fractionDigits);
+    }
+    return amount;
+};
+exports.convertWithMapping = convertWithMapping;

package/dist/commercetools/index.d.ts

@@ -5,3 +5,4 @@ export { AuthorizationService as CommercetoolsAuthorizationService } from './typ
 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';

package/dist/commercetools/index.js

@@ -1,2 +1,37 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.CurrencyConverters = void 0;
+exports.CurrencyConverters = __importStar(require("./helpers/currency.converter"));

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

@@ -37,12 +37,14 @@ class DefaultCartService {
             cartAmount = {
                 currencyCode: opts.cart.taxedPrice.totalGross.currencyCode,
                 centAmount: opts.cart.taxedPrice.totalGross.centAmount,
+                fractionDigits: opts.cart.taxedPrice.totalGross.fractionDigits,
             };
         }
         else {
             cartAmount = {
                 currencyCode: opts.cart.totalPrice.currencyCode,
                 centAmount: opts.cart.totalPrice.centAmount,
+                fractionDigits: opts.cart.totalPrice.fractionDigits,
             };
         }
         if (paidAmount >= cartAmount.centAmount) {
@@ -58,6 +60,7 @@ class DefaultCartService {
             return {
                 currencyCode: cartAmount.currencyCode,
                 centAmount: cartAmount.centAmount - paidAmount,
+                fractionDigits: cartAmount.fractionDigits,
             };
         }
     }

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

@@ -4,6 +4,7 @@ import { Logger } from '../../logger';
 export type PaymentAmount = {
     centAmount: number;
     currencyCode: string;
+    fractionDigits: number;
 };
 export type PaymentServiceOptions = {
     ctAPI: CommercetoolsAPI;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@commercetools/connect-payments-sdk",
-  "version": "0.13.1",
+  "version": "0.14.0",
   "description": "Payment SDK for commercetools payment connectors",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -16,7 +16,7 @@
   "license": "ISC",
   "dependencies": {
     "@commercetools-backend/loggers": "22.37.0",
-    "@commercetools/platform-sdk": "7.23.0",
+    "@commercetools/platform-sdk": "7.25.1",
     "@commercetools/sdk-client-v2": "2.5.0",
     "jsonwebtoken": "9.0.2",
     "jwks-rsa": "3.1.0",