@commercetools/connect-payments-sdk 0.12.0 → 0.13.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @commercetools/connect-payments-sdk
 
+## 0.13.0
+
+### Minor Changes
+
+- 0e117d0: utilities to support multiple shipments
+
 ## 0.12.0
 
 ### Minor Changes

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

@@ -1,7 +1,7 @@
-import { CartService, CartServiceOptions, GetCart, GetCartByPaymentIdRequest, GetPaymentAmount } from '../types/cart.type';
-import { Cart } from '@commercetools/platform-sdk';
-import { PaymentAmount } from '../types/payment.type';
+import { Address, Cart } from '@commercetools/platform-sdk';
 import { AddPayment } from '../types/api.type';
+import { CartService, CartServiceOptions, GetCart, GetCartByPaymentIdRequest, GetNormalizedShipping, GetOneShippingAddress, GetPaymentAmount, NormalizedShipping } from '../types/cart.type';
+import { PaymentAmount } from '../types/payment.type';
 /**
  * Default implementation of the CartService interface.
  */
@@ -12,6 +12,19 @@ export declare class DefaultCartService implements CartService {
     getCartByPaymentId(opts: GetCartByPaymentIdRequest): Promise<Cart>;
     getCart(opts: GetCart): Promise<Cart>;
     getPaymentAmount(opts: GetPaymentAmount): Promise<PaymentAmount>;
+    /**
+     * Get only one shipping address from the cart. If the cart has multiple shipping addresses, it returns the first one.
+     * @param cart
+     * @returns
+     */
+    getOneShippingAddress(opts: GetOneShippingAddress): Address | undefined;
+    /**
+     * Normalizes the shipping info from the cart. If the cart has a single shipping info, it returns an array with that shipping info.
+     * When the cart has multiple shipping infos, it returns an array with all the shipping infos.
+     * @param opts
+     * @returns
+     */
+    getNormalizedShipping(opts: GetNormalizedShipping): NormalizedShipping[];
     addPayment(opts: AddPayment): Promise<Cart>;
     private calculateTotalPaidAmount;
     private calculatePaymentAmount;

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

@@ -1,8 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DefaultCartService = void 0;
-const ct_api_error_1 = require("../errors/ct-api.error");
 const __1 = require("../..");
+const ct_api_error_1 = require("../errors/ct-api.error");
 /**
  * Default implementation of the CartService interface.
  */
@@ -61,6 +61,44 @@ class DefaultCartService {
             };
         }
     }
+    /**
+     * Get only one shipping address from the cart. If the cart has multiple shipping addresses, it returns the first one.
+     * @param cart
+     * @returns
+     */
+    getOneShippingAddress(opts) {
+        if (opts.cart.shippingMode === 'Single') {
+            return opts.cart.shippingAddress;
+        }
+        if (opts.cart.shippingMode === 'Multiple' && opts.cart.shipping && opts.cart.shipping.length > 0) {
+            return opts.cart.shipping[0].shippingAddress;
+        }
+    }
+    /**
+     * Normalizes the shipping info from the cart. If the cart has a single shipping info, it returns an array with that shipping info.
+     * When the cart has multiple shipping infos, it returns an array with all the shipping infos.
+     * @param opts
+     * @returns
+     */
+    getNormalizedShipping(opts) {
+        if (opts.cart.shippingMode === 'Single' && opts.cart.shippingInfo) {
+            return opts.cart.shippingInfo && opts.cart.shippingAddress
+                ? [
+                    {
+                        shippingAddress: opts.cart.shippingAddress,
+                        shippingInfo: opts.cart.shippingInfo,
+                    },
+                ]
+                : [];
+        }
+        if (opts.cart.shippingMode === 'Multiple' && opts.cart.shipping && opts.cart.shipping.length > 0) {
+            return opts.cart.shipping.map((shipping) => ({
+                shippingAddress: shipping.shippingAddress,
+                shippingInfo: shipping.shippingInfo,
+            }));
+        }
+        return [];
+    }
     async addPayment(opts) {
         const maxRetries = 6;
         let cartVersion = opts.resource.version;

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

@@ -1,7 +1,7 @@
-import { Cart } from '@commercetools/platform-sdk';
+import { Address, Cart, ShippingInfo } from '@commercetools/platform-sdk';
+import { Logger } from '../../logger';
 import { AddPayment, CommercetoolsAPI } from './api.type';
 import { PaymentAmount } from './payment.type';
-import { Logger } from '../../logger';
 export type GetCart = {
     id: string;
     version?: number;
@@ -9,6 +9,23 @@ export type GetCart = {
 export type GetPaymentAmount = {
     cart: Cart;
 };
+export type GetOneShippingAddress = {
+    cart: Pick<Cart, 'shippingAddress' | 'shipping' | 'shippingMode'>;
+};
+export type GetNormalizedShipping = {
+    cart: Pick<Cart, 'shippingInfo' | 'shipping' | 'shippingMode' | 'shippingAddress'>;
+};
+export type NormalizedShipping = {
+    shippingAddress: Address;
+    shippingInfo: ShippingInfo;
+};
+export type ShippingAmounts = {
+    priceCentAmount: number;
+    taxRateAmount: number;
+    totalNetCentAmount: number;
+    totalGrossCentAmount: number;
+    totalTaxCentAmount: number;
+};
 export type CartServiceOptions = {
     ctAPI: CommercetoolsAPI;
     logger: Logger;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@commercetools/connect-payments-sdk",
-  "version": "0.12.0",
+  "version": "0.13.0",
   "description": "Payment SDK for commercetools payment connectors",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -15,8 +15,8 @@
   ],
   "license": "ISC",
   "dependencies": {
-    "@commercetools-backend/loggers": "22.35.1",
-    "@commercetools/platform-sdk": "7.21.0",
+    "@commercetools-backend/loggers": "22.37.0",
+    "@commercetools/platform-sdk": "7.23.0",
     "@commercetools/sdk-client-v2": "2.5.0",
     "jsonwebtoken": "9.0.2",
     "jwks-rsa": "3.1.0",