@commercetools/connect-payments-sdk 0.14.0 → 0.15.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @commercetools/connect-payments-sdk
 
+## 0.15.0
+
+### Minor Changes
+
+- 36738ad: subtract gift card planned amount from cart amount to compute required payment amount
+
 ## 0.14.0
 
 ### Minor Changes

package/dist/api/context/request-context.helper.d.ts

@@ -0,0 +1,9 @@
+import { Money, RequestContextData } from '../..';
+export declare function getGiftCardPlannedAmountFromContext(context: RequestContextData): Money | undefined;
+export declare function getCtSessionIdFromContext(context: RequestContextData): string | undefined;
+export declare function getCartIdFromContext(context: RequestContextData): string | undefined;
+export declare function getAllowedPaymentMethodsFromContext(context: RequestContextData): string[] | undefined;
+export declare function getPaymentInterfaceFromContext(context: RequestContextData): string | undefined;
+export declare function getProcessorUrlFromContext(context: RequestContextData): string | undefined;
+export declare function getMerchantReturnUrlFromContext(context: RequestContextData): string | undefined;
+export declare function getFutureOrderNumberFromContext(context: RequestContextData): string | undefined;

package/dist/api/context/request-context.helper.js

@@ -0,0 +1,59 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getGiftCardPlannedAmountFromContext = getGiftCardPlannedAmountFromContext;
+exports.getCtSessionIdFromContext = getCtSessionIdFromContext;
+exports.getCartIdFromContext = getCartIdFromContext;
+exports.getAllowedPaymentMethodsFromContext = getAllowedPaymentMethodsFromContext;
+exports.getPaymentInterfaceFromContext = getPaymentInterfaceFromContext;
+exports.getProcessorUrlFromContext = getProcessorUrlFromContext;
+exports.getMerchantReturnUrlFromContext = getMerchantReturnUrlFromContext;
+exports.getFutureOrderNumberFromContext = getFutureOrderNumberFromContext;
+const __1 = require("../..");
+function getGiftCardPlannedAmountFromContext(context) {
+    const authentication = context.authentication;
+    if (authentication && authentication instanceof __1.SessionAuthentication) {
+        return authentication?.getPrincipal().giftCardPlannedAmount;
+    }
+}
+function getCtSessionIdFromContext(context) {
+    const authentication = context.authentication;
+    if (authentication && authentication instanceof __1.SessionAuthentication) {
+        return authentication?.getCredentials();
+    }
+}
+function getCartIdFromContext(context) {
+    const authentication = context.authentication;
+    if (authentication && authentication instanceof __1.SessionAuthentication) {
+        return authentication?.getPrincipal().cartId;
+    }
+}
+function getAllowedPaymentMethodsFromContext(context) {
+    const authentication = context.authentication;
+    if (authentication && authentication instanceof __1.SessionAuthentication) {
+        return authentication?.getPrincipal().allowedPaymentMethods;
+    }
+}
+function getPaymentInterfaceFromContext(context) {
+    const authentication = context.authentication;
+    if (authentication && authentication instanceof __1.SessionAuthentication) {
+        return authentication?.getPrincipal().paymentInterface;
+    }
+}
+function getProcessorUrlFromContext(context) {
+    const authentication = context.authentication;
+    if (authentication && authentication instanceof __1.SessionAuthentication) {
+        return authentication?.getPrincipal().processorUrl;
+    }
+}
+function getMerchantReturnUrlFromContext(context) {
+    const authentication = context.authentication;
+    if (authentication && authentication instanceof __1.SessionAuthentication) {
+        return authentication?.getPrincipal().merchantReturnUrl;
+    }
+}
+function getFutureOrderNumberFromContext(context) {
+    const authentication = context.authentication;
+    if (authentication && authentication instanceof __1.SessionAuthentication) {
+        return authentication?.getPrincipal().futureOrderNumber;
+    }
+}

package/dist/api/index.d.ts

@@ -1,4 +1,5 @@
 export * from './context/request-context.provider';
+export * from './context/request-context.helper';
 export * from './context/types/request-context.type';
 export * from './handlers/config.handler';
 export * from './handlers/status.handler';

package/dist/api/index.js

@@ -15,6 +15,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./context/request-context.provider"), exports);
+__exportStar(require("./context/request-context.helper"), exports);
 __exportStar(require("./context/types/request-context.type"), exports);
 __exportStar(require("./handlers/config.handler"), exports);
 __exportStar(require("./handlers/status.handler"), exports);

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

@@ -8,6 +8,7 @@ import { PaymentAmount } from '../types/payment.type';
 export declare class DefaultCartService implements CartService {
     private ctAPI;
     private logger;
+    private contextProvider;
     constructor(opts: CartServiceOptions);
     getCartByPaymentId(opts: GetCartByPaymentIdRequest): Promise<Cart>;
     getCart(opts: GetCart): Promise<Cart>;

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

@@ -9,9 +9,11 @@ const ct_api_error_1 = require("../errors/ct-api.error");
 class DefaultCartService {
     ctAPI;
     logger;
+    contextProvider;
     constructor(opts) {
         this.ctAPI = opts.ctAPI;
         this.logger = opts.logger;
+        this.contextProvider = opts.contextProvider;
     }
     async getCartByPaymentId(opts) {
         const queryPredicate = `paymentInfo(payments(id = "${opts.paymentId}"))`;
@@ -31,6 +33,7 @@ class DefaultCartService {
         return await this.ctAPI.cart.getCartById(opts.id);
     }
     async getPaymentAmount(opts) {
+        const giftCardPlannedAmount = (0, __1.getGiftCardPlannedAmountFromContext)(this.contextProvider.getContextData());
         const paidAmount = await this.calculateTotalPaidAmount(opts.cart);
         let cartAmount;
         if (opts.cart.taxedPrice) {
@@ -56,13 +59,17 @@ class DefaultCartService {
                 },
             });
         }
-        else {
-            return {
-                currencyCode: cartAmount.currencyCode,
-                centAmount: cartAmount.centAmount - paidAmount,
-                fractionDigits: cartAmount.fractionDigits,
-            };
-        }
+        const currentAmountToPay = giftCardPlannedAmount && giftCardPlannedAmount.currencyCode === cartAmount.currencyCode
+            ? cartAmount.centAmount - giftCardPlannedAmount.centAmount
+            : cartAmount.centAmount;
+        this.logger.info({
+            currentAmountToPay,
+        }, 'current amount to pay after gift card amount deduction');
+        return {
+            currencyCode: cartAmount.currencyCode,
+            centAmount: currentAmountToPay - paidAmount,
+            fractionDigits: cartAmount.fractionDigits,
+        };
     }
     /**
      * Get only one shipping address from the cart. If the cart has multiple shipping addresses, it returns the first one.

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

@@ -1,3 +1,4 @@
+import { Money } from '@commercetools/platform-sdk';
 import { Logger } from '../..';
 import { AuthorizationService, CommercetoolsToken } from '../types/authorization.type';
 import { Session, SessionService } from '../types/session.type';
@@ -20,5 +21,6 @@ export declare class DefaultSessionService implements SessionService {
     getPaymentInterfaceFromSession(session: Session): string | undefined;
     getMerchantReturnUrlFromSession(session: Session): string | undefined;
     getFutureOrderNumberFromSession(session: Session): string | undefined;
+    getGiftCardPlannedAmountFromSession(session: Session): Money | undefined;
     private getSession;
 }

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

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

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

@@ -2,6 +2,7 @@ import { Address, Cart, ShippingInfo } from '@commercetools/platform-sdk';
 import { Logger } from '../../logger';
 import { AddPayment, CommercetoolsAPI } from './api.type';
 import { PaymentAmount } from './payment.type';
+import { ContextProvider, RequestContextData } from '../../api';
 export type GetCart = {
     id: string;
     version?: number;
@@ -29,6 +30,7 @@ export type ShippingAmounts = {
 export type CartServiceOptions = {
     ctAPI: CommercetoolsAPI;
     logger: Logger;
+    contextProvider: ContextProvider<RequestContextData>;
 };
 export type GetCartByPaymentIdRequest = {
     paymentId: string;

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

@@ -1,3 +1,4 @@
+import { Money } from '@commercetools/platform-sdk';
 export type Session = {
     id: string;
     version: number;
@@ -29,4 +30,5 @@ export interface SessionService {
     getPaymentInterfaceFromSession(session: Session): string | undefined;
     getMerchantReturnUrlFromSession(session: Session): string | undefined;
     getFutureOrderNumberFromSession(session: Session): string | undefined;
+    getGiftCardPlannedAmountFromSession(session: Session): Money | undefined;
 }

package/dist/index.js

@@ -48,9 +48,6 @@ const setupPaymentSDK = (opts) => {
         contextProvider,
         logger,
     });
-    const ctCartService = new ct_cart_service_1.DefaultCartService({ ctAPI, logger });
-    const ctOrderService = new ct_order_service_1.DefaultOrderService({ ctAPI, logger });
-    const ctPaymentService = new ct_payment_service_1.DefaultPaymentService({ ctAPI, logger });
     const ctAuthorizationService = new ct_authorization_service_1.DefaultAuthorizationService({
         authUrl: opts.authUrl,
         clientId: opts.clientId,
@@ -64,6 +61,9 @@ const setupPaymentSDK = (opts) => {
         projectKey: opts.projectKey,
         logger,
     });
+    const ctCartService = new ct_cart_service_1.DefaultCartService({ ctAPI, logger, contextProvider });
+    const ctOrderService = new ct_order_service_1.DefaultOrderService({ ctAPI, logger });
+    const ctPaymentService = new ct_payment_service_1.DefaultPaymentService({ ctAPI, logger });
     const oauth2Service = new security_1.DefaultOauth2Service({ logger });
     const jwtService = new security_1.DefaultJWTService({
         jwksUrl: opts.jwksUrl,

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

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

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

@@ -1,3 +1,4 @@
+import { Money } from '@commercetools/platform-sdk';
 export interface AuthenticationManager {
     authenticate(authentication: Authentication): Promise<Authentication> | Authentication;
 }
@@ -22,6 +23,7 @@ export type SessionPrincipal = {
     paymentInterface?: string;
     merchantReturnUrl?: string;
     futureOrderNumber?: string;
+    giftCardPlannedAmount?: Money;
 };
 export type Oauth2Principal = {
     clientId: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@commercetools/connect-payments-sdk",
-  "version": "0.14.0",
+  "version": "0.15.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.37.0",
-    "@commercetools/platform-sdk": "7.25.1",
+    "@commercetools-backend/loggers": "22.38.1",
+    "@commercetools/platform-sdk": "8.0.0",
     "@commercetools/sdk-client-v2": "2.5.0",
     "jsonwebtoken": "9.0.2",
     "jwks-rsa": "3.1.0",