@commercetools/connect-payments-sdk 0.4.4 → 0.5.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @commercetools/connect-payments-sdk
 
+## 0.5.0
+
+### Minor Changes
+
+- 67c0581: added a common logger
+
 ## 0.4.4
 
 ### Patch Changes

package/dist/api/hooks/authorize.hook.d.ts

@@ -1,12 +1,27 @@
+import { Logger } from '../..';
 import { AuthorityAuthorizationManager } from '../../security/authz/authorization-manager';
 import { ContextProvider, RequestContextData } from '../context/types/request-context.type';
 import { AuthorizationHook } from './types/hook.type';
+/**
+ * Represents an authorization hook that verifies the authority of a request.
+ */
 export declare class AuthorityAuthorizationHook implements AuthorizationHook {
     private authorizationManager;
     private contextProvider;
+    private logger;
+    /**
+     * Constructs a new instance of the AuthorityAuthorizationHook class.
+     * @param opts - The options for configuring the hook.
+     */
     constructor(opts: {
         authorizationManager: AuthorityAuthorizationManager;
         contextProvider: ContextProvider<RequestContextData>;
+        logger: Logger;
     });
+    /**
+     * Authorizes the request based on the provided authorities.
+     * @param authorities - The authorities to verify.
+     * @returns A function that performs the authorization check.
+     */
     authorize(...authorities: string[]): () => Promise<void>;
 }

package/dist/api/hooks/authorize.hook.js

@@ -2,18 +2,34 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.AuthorityAuthorizationHook = void 0;
 const errorx_1 = require("../../errorx");
+/**
+ * Represents an authorization hook that verifies the authority of a request.
+ */
 class AuthorityAuthorizationHook {
     authorizationManager;
     contextProvider;
+    logger;
+    /**
+     * Constructs a new instance of the AuthorityAuthorizationHook class.
+     * @param opts - The options for configuring the hook.
+     */
     constructor(opts) {
         this.authorizationManager = opts.authorizationManager;
         this.contextProvider = opts.contextProvider;
+        this.logger = opts.logger;
     }
+    /**
+     * Authorizes the request based on the provided authorities.
+     * @param authorities - The authorities to verify.
+     * @returns A function that performs the authorization check.
+     */
     authorize(...authorities) {
         return async () => {
             const authn = this.contextProvider.getContextData().authentication;
             if (!authn) {
-                throw new errorx_1.ErrorAuthErrorResponse('Authentication is required.');
+                throw new errorx_1.ErrorAuthErrorResponse('Authentication is required.', {
+                    privateMessage: 'Not able to authenticate the request. Missing authentication information in context.',
+                });
             }
             this.authorizationManager.verify(authn, authorities);
         };

package/dist/api/hooks/jwt-auth.hook.d.ts

@@ -3,13 +3,27 @@ import { IncomingHttpHeaders } from 'node:http';
 import { JWTAuthenticationManager } from '../../security/authn/jwt-authn-manager';
 import { ContextProvider, RequestContextData } from '../context/types/request-context.type';
 import { AuthenticationHook } from './types/hook.type';
+import { Logger } from '../..';
+/**
+ * Represents a JWT Authentication Hook.
+ */
 export declare class JWTAuthenticationHook implements AuthenticationHook {
     private authenticationManager;
     private contextProvider;
+    private logger;
+    /**
+     * Constructs a new instance of the JWTAuthenticationHook class.
+     * @param opts - The options for the JWTAuthenticationHook.
+     */
     constructor(opts: {
         authenticationManager: JWTAuthenticationManager;
         contextProvider: ContextProvider<RequestContextData>;
+        logger: Logger;
     });
+    /**
+     * Authenticates the request.
+     * @returns A function that performs the authentication.
+     */
     authenticate(): (request: {
         headers: IncomingHttpHeaders;
         query?: any;

package/dist/api/hooks/jwt-auth.hook.js

@@ -2,13 +2,26 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.JWTAuthenticationHook = void 0;
 const security_1 = require("../../security");
+/**
+ * Represents a JWT Authentication Hook.
+ */
 class JWTAuthenticationHook {
     authenticationManager;
     contextProvider;
+    logger;
+    /**
+     * Constructs a new instance of the JWTAuthenticationHook class.
+     * @param opts - The options for the JWTAuthenticationHook.
+     */
     constructor(opts) {
         this.authenticationManager = opts.authenticationManager;
         this.contextProvider = opts.contextProvider;
+        this.logger = opts.logger;
     }
+    /**
+     * Authenticates the request.
+     * @returns A function that performs the authentication.
+     */
     authenticate() {
         // eslint-disable-next-line @typescript-eslint/no-explicit-any
         return async (request) => {

package/dist/api/hooks/oauth2-auth.hook.d.ts

@@ -3,12 +3,15 @@ import { IncomingHttpHeaders } from 'node:http';
 import { Oauth2AuthenticationManager } from '../../security/authn/oauth2-authn-manager';
 import { ContextProvider, RequestContextData } from '../context/types/request-context.type';
 import { AuthenticationHook } from './types/hook.type';
+import { Logger } from '../..';
 export declare class Oauth2AuthenticationHook implements AuthenticationHook {
     private authenticationManager;
     private contextProvider;
+    private logger;
     constructor(opts: {
         authenticationManager: Oauth2AuthenticationManager;
         contextProvider: ContextProvider<RequestContextData>;
+        logger: Logger;
     });
     authenticate(): (request: {
         headers: IncomingHttpHeaders;

package/dist/api/hooks/oauth2-auth.hook.js

@@ -5,9 +5,11 @@ const security_1 = require("../../security");
 class Oauth2AuthenticationHook {
     authenticationManager;
     contextProvider;
+    logger;
     constructor(opts) {
         this.authenticationManager = opts.authenticationManager;
         this.contextProvider = opts.contextProvider;
+        this.logger = opts.logger;
     }
     authenticate() {
         // eslint-disable-next-line @typescript-eslint/no-explicit-any

package/dist/api/hooks/session-header-auth.hook.d.ts

@@ -3,12 +3,15 @@ import { IncomingHttpHeaders } from 'node:http';
 import { ContextProvider, RequestContextData } from '../context/types/request-context.type';
 import { SessionHeaderAuthenticationManager } from '../../security';
 import { AuthenticationHook } from './types/hook.type';
+import { Logger } from '../..';
 export declare class SessionHeaderAuthenticationHook implements AuthenticationHook {
     private authenticationManager;
     private contextProvider;
+    private logger;
     constructor(opts: {
         authenticationManager: SessionHeaderAuthenticationManager;
         contextProvider: ContextProvider<RequestContextData>;
+        logger: Logger;
     });
     authenticate(): (request: {
         headers: IncomingHttpHeaders;

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

@@ -5,9 +5,11 @@ const security_1 = require("../../security");
 class SessionHeaderAuthenticationHook {
     authenticationManager;
     contextProvider;
+    logger;
     constructor(opts) {
         this.authenticationManager = opts.authenticationManager;
         this.contextProvider = opts.contextProvider;
+        this.logger = opts.logger;
     }
     authenticate() {
         // eslint-disable-next-line @typescript-eslint/no-explicit-any

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

@@ -3,12 +3,15 @@ import { IncomingHttpHeaders } from 'node:http';
 import { ContextProvider, RequestContextData } from '../context/types/request-context.type';
 import { SessionQueryParamAuthenticationManager } from '../../security';
 import { AuthenticationHook } from './types/hook.type';
+import { Logger } from '../..';
 export declare class SessionQueryParamAuthenticationHook implements AuthenticationHook {
     private authenticationManager;
     private contextProvider;
+    private logger;
     constructor(opts: {
         authenticationManager: SessionQueryParamAuthenticationManager;
         contextProvider: ContextProvider<RequestContextData>;
+        logger: Logger;
     });
     authenticate(): (request: {
         headers: IncomingHttpHeaders;

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

@@ -5,9 +5,11 @@ const security_1 = require("../../security");
 class SessionQueryParamAuthenticationHook {
     authenticationManager;
     contextProvider;
+    logger;
     constructor(opts) {
         this.authenticationManager = opts.authenticationManager;
         this.contextProvider = opts.contextProvider;
+        this.logger = opts.logger;
     }
     authenticate() {
         // eslint-disable-next-line @typescript-eslint/no-explicit-any

package/dist/commercetools/api/root-api.d.ts

@@ -1,9 +1,11 @@
 import { ContextProvider, RequestContextData } from '../../api';
 import { CartAPI, CommercetoolsAPI, CommercetoolsClient, PaymentAPI } from '../types/api.type';
+import { Logger } from '../..';
 export declare class DefaultCommercetoolsAPI implements CommercetoolsAPI {
     client: CommercetoolsClient;
     cart: CartAPI;
     payment: PaymentAPI;
+    private logger;
     constructor(opts: {
         clientId: string;
         clientSecret: string;
@@ -11,5 +13,6 @@ export declare class DefaultCommercetoolsAPI implements CommercetoolsAPI {
         apiUrl: string;
         projectKey: string;
         contextProvider: ContextProvider<RequestContextData>;
+        logger: Logger;
     });
 }

package/dist/commercetools/api/root-api.js

@@ -9,10 +9,12 @@ class DefaultCommercetoolsAPI {
     client;
     cart;
     payment;
+    logger;
     constructor(opts) {
         this.client = createClient(opts);
         this.cart = new cart_api_1.CommercetoolsCartAPI({ client: this.client });
         this.payment = new payment_api_1.CommercetoolsPaymentAPI({ client: this.client });
+        this.logger = opts.logger;
     }
 }
 exports.DefaultCommercetoolsAPI = DefaultCommercetoolsAPI;

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

@@ -6,13 +6,13 @@ export declare class DefaultAuthorizationService implements AuthorizationService
     private clientId;
     private clientSecret;
     private fetch;
-    private logger?;
+    private logger;
     constructor(opts: {
         authUrl: string;
         clientId: string;
         clientSecret: string;
         fetch: Fetch;
-        logger?: Logger;
+        logger: Logger;
     });
     getAccessToken(): Promise<CommercetoolsToken>;
 }

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

@@ -7,6 +7,7 @@ import { AddPayment } from '../types/api.type';
  */
 export declare class DefaultCartService implements CartService {
     private ctAPI;
+    private logger;
     constructor(opts: CartServiceOptions);
     getCart(opts: GetCart): Promise<Cart>;
     getPaymentAmount(opts: GetPaymentAmount): Promise<PaymentAmount>;

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

@@ -8,8 +8,10 @@ const __1 = require("../..");
  */
 class DefaultCartService {
     ctAPI;
+    logger;
     constructor(opts) {
         this.ctAPI = opts.ctAPI;
+        this.logger = opts.logger;
     }
     async getCart(opts) {
         return await this.ctAPI.cart.getCartById(opts.id);

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

@@ -1,10 +1,11 @@
-import { Payment, PaymentDraft } from '@commercetools/platform-sdk';
-import { GetPayment, PaymentCancelAuthorizationValidation, PaymentChargeValidation, PaymentModificationValidationResult, PaymentRefundValidation, PaymentService, PaymentServiceOptions, UpdatePayment } from '../types/payment.type';
+import { Payment, PaymentDraft, Transaction } from '@commercetools/platform-sdk';
+import { GetPayment, PaymentCancelAuthorizationValidation, PaymentChargeValidation, PaymentModificationValidationResult, PaymentRefundValidation, PaymentService, PaymentServiceOptions, TransactionData, UpdatePayment } from '../types/payment.type';
 /**
  * This is the default implementation of the PaymentService interface.
  */
 export declare class DefaultPaymentService implements PaymentService {
     private ctAPI;
+    private logger;
     constructor(opts: PaymentServiceOptions);
     getPayment(opts: GetPayment): Promise<Payment>;
     createPayment(draft: PaymentDraft): Promise<Payment>;
@@ -18,7 +19,7 @@ export declare class DefaultPaymentService implements PaymentService {
     private populateAddTransactionAction;
     private populateChangeTransactionState;
     private populateSetPaymentMethod;
-    private findMatchingTransactions;
+    findMatchingTransactions(payment: Payment, transaction: TransactionData): Transaction[];
     private consolidateTransactionChanges;
     private hasTransactionWithState;
     private calculateTotalAmount;

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

@@ -7,8 +7,10 @@ const ct_api_error_1 = require("../errors/ct-api.error");
  */
 class DefaultPaymentService {
     ctAPI;
+    logger;
     constructor(opts) {
         this.ctAPI = opts.ctAPI;
+        this.logger = opts.logger;
     }
     async getPayment(opts) {
         return await this.ctAPI.payment.getPaymentById(opts.id);
@@ -22,6 +24,7 @@ class DefaultPaymentService {
         for (let retries = 0; retries < maxRetries; retries++) {
             const payment = await this.getPayment({ id: opts.id });
             const actions = this.consolidateUpdateActions(payment, opts);
+            this.logger.info({ paymentId: payment.id, actions }, 'Updating payment with actions');
             try {
                 const updatedPayment = await this.ctAPI.payment.updatePayment({
                     resource: {
@@ -48,12 +51,18 @@ class DefaultPaymentService {
         if (!this.hasTransactionWithState(opts.payment, 'Authorization', ['Success'])) {
             return { isValid: false, reason: `No authorization transaction found for resource ${opts.payment.id}.` };
         }
-        if (this.hasTransactionWithState(opts.payment, 'CancelAuthorization', ['Success', 'Pending'])) {
+        if (this.hasTransactionWithState(opts.payment, 'CancelAuthorization', ['Success'])) {
             return { isValid: false, reason: `Resource ${opts.payment.id} has already been cancelled.` };
         }
+        if (this.hasTransactionWithState(opts.payment, 'CancelAuthorization', ['Pending'])) {
+            return { isValid: false, reason: `Resource ${opts.payment.id} is pending to be cancelled.` };
+        }
         if (this.hasTransactionWithState(opts.payment, 'Charge', ['Success'])) {
             return { isValid: false, reason: `Resource ${opts.payment.id} has already been charged.` };
         }
+        if (this.hasTransactionWithState(opts.payment, 'Charge', ['Pending'])) {
+            return { isValid: false, reason: `Resource ${opts.payment.id} is pending to be charged.` };
+        }
         return { isValid: true };
     }
     validatePaymentCharge(opts) {
@@ -67,9 +76,12 @@ class DefaultPaymentService {
         if (totalAuthorized === 0) {
             return { isValid: false, reason: `No authorization transaction found for resource ${opts.payment.id}.` };
         }
-        if (this.hasTransactionWithState(opts.payment, 'CancelAuthorization', ['Success', 'Pending'])) {
+        if (this.hasTransactionWithState(opts.payment, 'CancelAuthorization', ['Success'])) {
             return { isValid: false, reason: `Resource ${opts.payment.id} has already been cancelled.` };
         }
+        if (this.hasTransactionWithState(opts.payment, 'CancelAuthorization', ['Pending'])) {
+            return { isValid: false, reason: `Resource ${opts.payment.id} is pending to be cancelled.` };
+        }
         const totalCaptured = this.calculateTotalAmount(opts.payment, 'Charge', opts.amount.currencyCode);
         const allowedAmount = totalAuthorized - totalCaptured;
         if (opts.amount.centAmount > allowedAmount) {
@@ -87,9 +99,12 @@ class DefaultPaymentService {
                 reason: `Invalid currency ${opts.amount.currencyCode} for resource ${opts.payment.id}, expected ${opts.payment.amountPlanned.currencyCode}`,
             };
         }
-        if (this.hasTransactionWithState(opts.payment, 'CancelAuthorization', ['Success', 'Pending'])) {
+        if (this.hasTransactionWithState(opts.payment, 'CancelAuthorization', ['Success'])) {
             return { isValid: false, reason: `Resource ${opts.payment.id} has already been cancelled.` };
         }
+        if (this.hasTransactionWithState(opts.payment, 'CancelAuthorization', ['Pending'])) {
+            return { isValid: false, reason: `Resource ${opts.payment.id} is pending to be cancelled.` };
+        }
         const totalCaptured = this.calculateTotalAmount(opts.payment, 'Charge', opts.amount.currencyCode);
         if (totalCaptured === 0) {
             return { isValid: false, reason: `No charge transaction found for resource ${opts.payment.id}.` };
@@ -158,10 +173,12 @@ class DefaultPaymentService {
     findMatchingTransactions(payment, transaction) {
         return payment.transactions.filter((tx) => {
             return (tx.type === transaction.type &&
-                tx.amount.centAmount === transaction.amount.centAmount &&
-                tx.amount.currencyCode === transaction.amount.currencyCode &&
                 transaction.interactionId &&
-                (tx.interactionId || (!tx.interactionId && tx.state === 'Initial')));
+                (tx.interactionId === transaction.interactionId ||
+                    (tx.amount.centAmount === transaction.amount.centAmount &&
+                        tx.amount.currencyCode === transaction.amount.currencyCode &&
+                        !tx.interactionId &&
+                        tx.state === 'Initial')));
         });
     }
     consolidateTransactionChanges(payment, transaction) {
@@ -186,6 +203,7 @@ class DefaultPaymentService {
                 }
             }
             else {
+                this.logger.error({ paymentId: payment.id, transaction }, 'Multiple transactions found when consolidating payment changes');
                 throw new Error('Multiple transactions found');
             }
         }

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

@@ -1,3 +1,4 @@
+import { Logger } from '../..';
 import { AuthorizationService, CommercetoolsToken } from '../types/authorization.type';
 import { Session, SessionService } from '../types/session.type';
 export declare class DefaultSessionService implements SessionService {
@@ -5,10 +6,12 @@ export declare class DefaultSessionService implements SessionService {
     private sessionUrl;
     private projectKey;
     protected token: CommercetoolsToken;
+    private logger;
     constructor(opts: {
         authorizationService: AuthorizationService;
         sessionUrl: string;
         projectKey: string;
+        logger: Logger;
     });
     verifySession(sessionId: string): Promise<Session>;
     getCartFromSession(session: Session): string;

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

@@ -7,10 +7,12 @@ class DefaultSessionService {
     sessionUrl;
     projectKey;
     token;
+    logger;
     constructor(opts) {
         this.authorizationService = opts.authorizationService;
         this.sessionUrl = opts.sessionUrl;
         this.projectKey = opts.projectKey;
+        this.logger = opts.logger;
     }
     async verifySession(sessionId) {
         if (!this.token) {

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

@@ -1,6 +1,7 @@
 import { Cart } from '@commercetools/platform-sdk';
 import { AddPayment, CommercetoolsAPI } from './api.type';
 import { PaymentAmount } from './payment.type';
+import { Logger } from '../../logger';
 export type GetCart = {
     id: string;
     version?: number;
@@ -10,6 +11,7 @@ export type GetPaymentAmount = {
 };
 export type CartServiceOptions = {
     ctAPI: CommercetoolsAPI;
+    logger: Logger;
 };
 /**
  * Cart service interface exposes methods to interact with the commercetools platform API.

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

@@ -1,11 +1,13 @@
 import { Money, Payment, PaymentDraft, TransactionState, TransactionType } from '@commercetools/platform-sdk';
 import { CommercetoolsAPI } from './api.type';
+import { Logger } from '../../logger';
 export type PaymentAmount = {
     centAmount: number;
     currencyCode: string;
 };
 export type PaymentServiceOptions = {
     ctAPI: CommercetoolsAPI;
+    logger: Logger;
 };
 export type GetPayment = {
     id: string;

package/dist/index.js

@@ -23,6 +23,7 @@ const ct_payment_service_1 = require("./commercetools/services/ct-payment.servic
 const ct_session_service_1 = require("./commercetools/services/ct-session.service");
 const base_decorator_1 = require("./fetch/decorators/base.decorator");
 const monitoring_decorator_1 = require("./fetch/decorators/monitoring.decorator");
+const logger_1 = require("./logger");
 const security_1 = require("./security");
 __exportStar(require("./api"), exports);
 __exportStar(require("./commercetools"), exports);
@@ -34,6 +35,7 @@ const setupPaymentSDK = (opts) => {
         getContextFn: opts.getContextFn,
         updateContextFn: opts.updateContextFn,
     });
+    const logger = opts.logger || new logger_1.CommercetoolsLogger({ contextProvider, projectKey: opts.projectKey });
     const fetcher = new monitoring_decorator_1.MonitoringFetcherDecorator(new base_decorator_1.BasicFetcher(), contextProvider);
     const decoratedFetch = fetcher.run.bind(fetcher);
     const ctAPI = new root_api_1.DefaultCommercetoolsAPI({
@@ -43,62 +45,86 @@ const setupPaymentSDK = (opts) => {
         clientSecret: opts.clientSecret,
         projectKey: opts.projectKey,
         contextProvider,
+        logger,
     });
-    const ctCartService = new ct_cart_service_1.DefaultCartService({ ctAPI });
-    const ctPaymentService = new ct_payment_service_1.DefaultPaymentService({ ctAPI });
+    const ctCartService = new ct_cart_service_1.DefaultCartService({ 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,
         clientSecret: opts.clientSecret,
         fetch: decoratedFetch,
+        logger,
     });
     const sessionService = new ct_session_service_1.DefaultSessionService({
         authorizationService: ctAuthorizationService,
         sessionUrl: opts.sessionUrl,
         projectKey: opts.projectKey,
+        logger,
     });
-    const oauth2Service = new security_1.DefaultOauth2Service();
+    const oauth2Service = new security_1.DefaultOauth2Service({ logger });
     const jwtService = new security_1.DefaultJWTService({
         jwksUrl: opts.jwksUrl,
+        logger,
     });
     const sessionHeaderAuthenticationManager = new security_1.SessionHeaderAuthenticationManager({
         sessionService,
+        logger,
     });
     const sessionQueryParamAuthenticationManager = new security_1.SessionQueryParamAuthenticationManager({
         sessionService,
+        logger,
     });
     const oauth2AuthenticationManager = new security_1.Oauth2AuthenticationManager({
         oauth2Service,
         clientId: opts.clientId,
         clientSecret: opts.clientSecret,
         authUrl: opts.authUrl,
+        logger,
+    });
+    const authorityAuthorizationManager = new security_1.AuthorityAuthorizationManager({
+        logger,
     });
-    const authorityAuthorizationManager = new security_1.AuthorityAuthorizationManager();
     const jwtAuthenticationManager = new security_1.JWTAuthenticationManager({
         jwtService,
         iss: opts.jwtIssuer,
         projectKey: opts.projectKey,
+        logger,
     });
     const sessionHeaderAuthHookFn = new api_1.SessionHeaderAuthenticationHook({
         authenticationManager: sessionHeaderAuthenticationManager,
         contextProvider,
+        logger,
     });
     const sessionQueryParamAuthHookFn = new api_1.SessionQueryParamAuthenticationHook({
         authenticationManager: sessionQueryParamAuthenticationManager,
         contextProvider,
+        logger,
     });
     const jwtAuthHookFn = new api_1.JWTAuthenticationHook({
         authenticationManager: jwtAuthenticationManager,
         contextProvider,
+        logger,
     });
     const oauth2AuthHookFn = new api_1.Oauth2AuthenticationHook({
         authenticationManager: oauth2AuthenticationManager,
         contextProvider,
+        logger,
     });
     const authorityAuthorizationHookFn = new api_1.AuthorityAuthorizationHook({
         authorizationManager: authorityAuthorizationManager,
         contextProvider,
+        logger,
     });
+    logger.info({
+        projectKey: opts.projectKey,
+        apiUrl: opts.apiUrl,
+        authUrl: opts.authUrl,
+        sessionUrl: opts.sessionUrl,
+        jwksUrl: opts.jwksUrl,
+        jwtIssuer: opts.jwtIssuer,
+        clientId: opts.clientId,
+    }, 'payment-sdk initialized');
     return {
         ctAPI,
         ctCartService,

package/dist/logger/commercetools-logger.d.ts

@@ -0,0 +1,17 @@
+import { RequestContextProvider } from '..';
+type DefaultFields = {
+    [key: string]: undefined | string | object | (() => object | string | undefined);
+};
+export declare const defaultFieldsFormatter: (defaults: DefaultFields) => import("logform").Format;
+export declare class CommercetoolsLogger {
+    private logger;
+    constructor(opts: {
+        contextProvider: RequestContextProvider;
+        projectKey: string;
+    });
+    debug(obj: object, message: string): void;
+    info(obj: object, message: string): void;
+    warn(obj: object, message: string): void;
+    error(obj: object, message: string): void;
+}
+export {};

package/dist/logger/commercetools-logger.js

@@ -0,0 +1,57 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CommercetoolsLogger = exports.defaultFieldsFormatter = void 0;
+const cloneDeep_1 = __importDefault(require("lodash/cloneDeep"));
+const set_1 = __importDefault(require("lodash/set"));
+const logform_1 = require("logform");
+const loggers_1 = require("@commercetools-backend/loggers");
+const defaultFieldsFormatter = (defaults) => {
+    return (0, logform_1.format)((info) => {
+        const clone = (0, cloneDeep_1.default)(info);
+        Object.entries(defaults).forEach(([key, value]) => {
+            if (value === undefined) {
+                // Do nothing
+            }
+            else if (typeof value === 'object' || typeof value === 'string') {
+                (0, set_1.default)(clone, key, value);
+            }
+            else if (typeof value === 'function') {
+                const evaluated = value();
+                if (evaluated !== undefined) {
+                    (0, set_1.default)(clone, key, evaluated);
+                }
+            }
+        });
+        return clone;
+    })(defaults);
+};
+exports.defaultFieldsFormatter = defaultFieldsFormatter;
+class CommercetoolsLogger {
+    logger;
+    constructor(opts) {
+        this.logger = (0, loggers_1.createApplicationLogger)({
+            formatters: [
+                (0, exports.defaultFieldsFormatter)({
+                    projectKey: opts.projectKey,
+                    correlationId: () => opts.contextProvider.getContextData().correlationId,
+                }),
+            ],
+        });
+    }
+    debug(obj, message) {
+        this.logger.debug(message, obj);
+    }
+    info(obj, message) {
+        this.logger.info(message, obj);
+    }
+    warn(obj, message) {
+        this.logger.warn(message, obj);
+    }
+    error(obj, message) {
+        this.logger.error(message, obj);
+    }
+}
+exports.CommercetoolsLogger = CommercetoolsLogger;

package/dist/logger/index.d.ts

@@ -1 +1,2 @@
 export * from './logger';
+export * from './commercetools-logger';

package/dist/logger/index.js

@@ -15,3 +15,4 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./logger"), exports);
+__exportStar(require("./commercetools-logger"), exports);

package/dist/security/authn/jwt-authn-manager.d.ts

@@ -1,3 +1,4 @@
+import { Logger } from '../..';
 import { JWTService } from '../services/types/jwt.type';
 import { HeaderBasedAuthentication, JWTAuthentication } from './authns';
 import { AuthenticationManager } from './types/authn.type';
@@ -5,10 +6,12 @@ export declare class JWTAuthenticationManager implements AuthenticationManager {
     private jwtService;
     private iss;
     private projectKey;
+    private logger;
     constructor(opts: {
         jwtService: JWTService;
         iss: string;
         projectKey: string;
+        logger: Logger;
     });
     authenticate(authentication: HeaderBasedAuthentication): Promise<JWTAuthentication>;
 }

package/dist/security/authn/jwt-authn-manager.js

@@ -8,10 +8,12 @@ class JWTAuthenticationManager {
     jwtService;
     iss;
     projectKey;
+    logger;
     constructor(opts) {
         this.jwtService = opts.jwtService;
         this.iss = opts.iss;
         this.projectKey = opts.projectKey;
+        this.logger = opts.logger;
     }
     async authenticate(authentication) {
         const principal = authentication.getPrincipal();

package/dist/security/authn/oauth2-authn-manager.d.ts

@@ -1,3 +1,4 @@
+import { Logger } from '../..';
 import { Oauth2Service } from '../services/types/oauth2.type';
 import { HeaderBasedAuthentication, Oauth2Authentication } from './authns';
 import { AuthenticationManager } from './types/authn.type';
@@ -6,11 +7,13 @@ export declare class Oauth2AuthenticationManager implements AuthenticationManage
     private clientId;
     private clientSecret;
     private authUrl;
+    private logger;
     constructor(opts: {
         oauth2Service: Oauth2Service;
         clientId: string;
         clientSecret: string;
         authUrl: string;
+        logger: Logger;
     });
     authenticate(authentication: HeaderBasedAuthentication): Promise<Oauth2Authentication>;
     private searchPermission;

package/dist/security/authn/oauth2-authn-manager.js

@@ -9,11 +9,13 @@ class Oauth2AuthenticationManager {
     clientId;
     clientSecret;
     authUrl;
+    logger;
     constructor(opts) {
         this.oauth2Service = opts.oauth2Service;
         this.clientId = opts.clientId;
         this.clientSecret = opts.clientSecret;
         this.authUrl = opts.authUrl;
+        this.logger = opts.logger;
     }
     async authenticate(authentication) {
         const principal = authentication.getPrincipal();

package/dist/security/authn/session-header-authn-manager.d.ts

@@ -1,10 +1,13 @@
 import { AuthenticationManager } from './types/authn.type';
 import { HeaderBasedAuthentication, SessionAuthentication } from './authns';
 import { CommercetoolsSessionService } from '../../commercetools';
+import { Logger } from '../..';
 export declare class SessionHeaderAuthenticationManager implements AuthenticationManager {
     private sessionService;
+    private logger;
     constructor(opts: {
         sessionService: CommercetoolsSessionService;
+        logger: Logger;
     });
     authenticate(authentication: HeaderBasedAuthentication): Promise<SessionAuthentication>;
 }

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

@@ -5,8 +5,10 @@ const authns_1 = require("./authns");
 const errorx_1 = require("../../errorx");
 class SessionHeaderAuthenticationManager {
     sessionService;
+    logger;
     constructor(opts) {
         this.sessionService = opts.sessionService;
+        this.logger = opts.logger;
     }
     async authenticate(authentication) {
         const principal = authentication.getPrincipal();

package/dist/security/authn/session-query-param-authn-manager.d.ts

@@ -1,10 +1,13 @@
 import { AuthenticationManager } from './types/authn.type';
 import { QueryParamBasedAuthentication, SessionAuthentication } from './authns';
 import { CommercetoolsSessionService } from '../../commercetools';
+import { Logger } from '../..';
 export declare class SessionQueryParamAuthenticationManager implements AuthenticationManager {
     private sessionService;
+    private logger;
     constructor(opts: {
         sessionService: CommercetoolsSessionService;
+        logger: Logger;
     });
     authenticate(authentication: QueryParamBasedAuthentication): Promise<SessionAuthentication>;
 }

package/dist/security/authn/session-query-param-authn-manager.js

@@ -5,8 +5,10 @@ const authns_1 = require("./authns");
 const errorx_1 = require("../../errorx");
 class SessionQueryParamAuthenticationManager {
     sessionService;
+    logger;
     constructor(opts) {
         this.sessionService = opts.sessionService;
+        this.logger = opts.logger;
     }
     async authenticate(authentication) {
         const principal = authentication.getPrincipal();

package/dist/security/authz/authorization-manager.d.ts

@@ -1,6 +1,11 @@
+import { Logger } from '../..';
 import { Authentication } from '../authn/types/authn.type';
 import { AuthorizationManager } from './types/authz.type';
 export declare class AuthorityAuthorizationManager implements AuthorizationManager<string[]> {
+    private logger;
+    constructor(opts: {
+        logger: Logger;
+    });
     verify(authentication: Authentication, authorities: string[]): void;
     check(authentication: Authentication, authorities: string[]): boolean;
 }

package/dist/security/authz/authorization-manager.js

@@ -3,6 +3,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.AuthorityAuthorizationManager = void 0;
 const errorx_1 = require("../../errorx");
 class AuthorityAuthorizationManager {
+    logger;
+    constructor(opts) {
+        this.logger = opts.logger;
+    }
     verify(authentication, authorities) {
         const isAuthorized = this.check(authentication, authorities);
         if (!isAuthorized) {

package/dist/security/services/jwt.service.d.ts

@@ -1,8 +1,11 @@
 import { JWTService } from './types/jwt.type';
+import { Logger } from '../..';
 export declare class DefaultJWTService implements JWTService {
     private client;
+    private logger;
     constructor(opts: {
         jwksUrl: string;
+        logger: Logger;
     });
     verify(opts: {
         token: string | undefined;

package/dist/security/services/jwt.service.js

@@ -9,10 +9,12 @@ const jwks_rsa_1 = __importDefault(require("jwks-rsa"));
 const errorx_1 = require("../../errorx");
 class DefaultJWTService {
     client;
+    logger;
     constructor(opts) {
         this.client = (0, jwks_rsa_1.default)({
             jwksUri: opts.jwksUrl,
         });
+        this.logger = opts.logger;
     }
     async verify(opts) {
         const getKey = (header, callback) => {

package/dist/security/services/oauth2.service.d.ts

@@ -1,5 +1,10 @@
+import { Logger } from '../..';
 import { Oauth2Service, TokenInfo } from './types/oauth2.type';
 export declare class DefaultOauth2Service implements Oauth2Service {
+    private logger;
+    constructor(opts: {
+        logger: Logger;
+    });
     introspectToken(opts: {
         url: string;
         clientId: string;

package/dist/security/services/oauth2.service.js

@@ -3,6 +3,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.DefaultOauth2Service = void 0;
 const errorx_1 = require("../../errorx");
 class DefaultOauth2Service {
+    logger;
+    constructor(opts) {
+        this.logger = opts.logger;
+    }
     async introspectToken(opts) {
         const urlencoded = new URLSearchParams();
         urlencoded.append('token', opts.token);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@commercetools/connect-payments-sdk",
-  "version": "0.4.4",
+  "version": "0.5.0",
   "description": "Payment SDK for commercetools payment connectors",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -15,9 +15,12 @@
   ],
   "license": "ISC",
   "dependencies": {
+    "@commercetools-backend/loggers": "22.23.3",
     "@commercetools/platform-sdk": "7.7.0",
     "@commercetools/sdk-client-v2": "2.4.1",
     "jsonwebtoken": "9.0.2",
-    "jwks-rsa": "3.1.0"
+    "jwks-rsa": "3.1.0",
+    "lodash": "4.17.21",
+    "logform": "2.6.0"
   }
 }