Merge pull request #25 from klarna/release-26.1.0

Release 26.1.0

Author: manuel-jimenez-klarna

CHANGELOG.md

@@ -1,5 +1,12 @@
 # CHANGELOG
 
+## 26.1.0
+* Upgraded Onsite Messaging (OSM) to use Klarna Web SDK version 2.
+* Added Klarna Express Checkout (KEC) one-step payments for direct merchants.
+* Added metadata (integrator and originator) in every request sent to Klarna both in Web SDK initialization and also in API calls.
+* Updated interoperability data storage to use a custom object instead of session storage.
+* Enhanced OSM installment messaging to dynamically refresh on the checkout page when the purchase amount changes.
+
 ## 25.5.0
 * When Klarna payments are integrated through a PSP, the interoperability_data is required by the PSP for payment processing and order finalization. As part of this release, we have added interoperability_data to the session. This data includes the order amount and the order lines for which the payment was initiated. The PSP will be able to retrieve this information from the session for further processing.
 

cartridges/int_klarna_payments/cartridge/scripts/common/klarnaPaymentsHttpService.js

@@ -84,6 +84,16 @@ KlarnaPaymentsHttpService.prototype.call = function( serviceID, urlPath, httpVer
     service.addHeader( 'Accept', 'application/json' );
     service.addHeader( 'User-Agent', SERVICE_HEADER );
 
+    // Add X-Klarna-Integration-Metadata header
+    var KlarnaConstants = require( '*/cartridge/scripts/util/klarnaPaymentsConstants' );
+    if ( KlarnaConstants.integrator && KlarnaConstants.originators ) {
+        var integrationMetadata = {
+            integrator: KlarnaConstants.integrator,
+            originators: KlarnaConstants.originators
+        };
+        service.addHeader( 'X-Klarna-Integration-Metadata', JSON.stringify( integrationMetadata ) );
+    }
+
     if ( !empty( klarnaIdempotencyKey ) && klarnaIdempotencyKey !== 'undefined' ) {
         service.addHeader( 'Klarna-Idempotency-Key', klarnaIdempotencyKey );
     }

cartridges/int_klarna_payments/cartridge/scripts/common/klarnaSignInHttpService.js

@@ -70,6 +70,16 @@ KlarnaSignInsHttpService.prototype.call = function( serviceID, urlPath, httpVerb
     service.addHeader( 'Content-Type', contentType ? contentType : 'application/json' );
     service.addHeader( 'Accept', 'application/json' );
     service.addHeader( 'User-Agent', SERVICE_HEADER );
+
+    // Add X-Klarna-Integration-Metadata header
+    var KlarnaConstants = require( '*/cartridge/scripts/util/klarnaPaymentsConstants' );
+    if ( KlarnaConstants.integrator && KlarnaConstants.originators ) {
+        var integrationMetadata = {
+            integrator: KlarnaConstants.integrator,
+            originators: KlarnaConstants.originators
+        };
+        service.addHeader( 'X-Klarna-Integration-Metadata', JSON.stringify( integrationMetadata ) );
+    }
     if ( !empty( httpVerb ) && this.isValidHttpVerb( httpVerb ) ) {
         service.setRequestMethod( httpVerb );
     }

cartridges/int_klarna_payments/cartridge/scripts/common/klarnaWebhookHttpService.js

@@ -58,6 +58,16 @@ KlarnaWebhookHttpService.prototype.call = function( serviceId, urlPath, httpVerb
     service.addHeader( 'Accept', 'application/json' );
     service.addHeader( 'User-Agent', SERVICE_HEADER );
 
+    // Add X-Klarna-Integration-Metadata header
+    var KlarnaConstants = require( '*/cartridge/scripts/util/klarnaPaymentsConstants' );
+    if ( KlarnaConstants.integrator && KlarnaConstants.originators ) {
+        var integrationMetadata = {
+            integrator: KlarnaConstants.integrator,
+            originators: KlarnaConstants.originators
+        };
+        service.addHeader( 'X-Klarna-Integration-Metadata', JSON.stringify( integrationMetadata ) );
+    }
+
     if ( !empty( httpVerb ) && this.isValidHttpVerb( httpVerb ) ) {
         service.setRequestMethod( httpVerb );
     }

cartridges/int_klarna_payments/cartridge/scripts/job/CleanupKlarnaInteroperabilityData.js

@@ -0,0 +1,36 @@
+'use strict';
+
+/**
+ * Script to cleanup expired Klarna interoperability data from custom objects
+ * This job should run daily to remove records older than 24 hours
+ */
+
+var Status = require('dw/system/Status');
+var Logger = require('dw/system/Logger');
+
+/**
+ * Function called by job to clean up expired interoperability data
+ * @param {Object} parameters Job parameters
+ * @return {dw.system.Status} execution status
+ */
+exports.execute = function (parameters) {
+    try {
+        var siteID = dw.system.Site.getCurrent().getID();
+        var KlarnaInteroperabilityDataManager = require('*/cartridge/scripts/common/klarnaInteroperabilityDataManager');
+
+        Logger.info('[' + siteID + '] Starting cleanup of expired Klarna interoperability data');
+
+        var count = KlarnaInteroperabilityDataManager.cleanupExpiredData();
+
+        if (count > 0) {
+            Logger.info('[' + siteID + '] Successfully cleaned up ' + count + ' expired interoperability data records');
+        } else {
+            Logger.debug('[' + siteID + '] No expired interoperability data records found');
+        }
+
+        return new Status(Status.OK);
+    } catch (e) {
+        Logger.error('Error cleaning up Klarna interoperability data: {0}', e.message + e.stack);
+        return new Status(Status.ERROR);
+    }
+};

cartridges/int_klarna_payments/cartridge/scripts/klarnaPaymentsCancelAuthorization.js

@@ -40,6 +40,7 @@ function execute( args )
 function cancelAuthorization( klarnaAuthorizationToken, localeObject ) {
     if ( klarnaAuthorizationToken ) {
         var StringUtils = require( 'dw/util/StringUtils' );
+        var Logger = require('dw/system/Logger');
         var klarnaPaymentsHttpService = new KlarnaPayments.httpService();
         var klarnaApiContext = new KlarnaPayments.apiContext();
         var requestUrl = StringUtils.format( klarnaApiContext.getFlowApiUrls().get( 'cancelAuthorization' ), klarnaAuthorizationToken );
@@ -50,7 +51,7 @@ function cancelAuthorization( klarnaAuthorizationToken, localeObject ) {
             session.privacy.KlarnaPaymentsFinalizeRequired = null;
             return response;
         } catch ( e ) {
-            logger.error( 'Error in canceling Klarna Payments Authorization: {0}', e.message + e.stack );
+            Logger.error( 'Error in canceling Klarna Payments Authorization: {0}', e.message + e.stack );
         }
     }
     return null;

cartridges/int_klarna_payments/cartridge/scripts/marketing/klarnaOSM.js

@@ -291,8 +291,14 @@ var KlarnaOSM = {
         return !empty( currentSite.getCustomPreferenceValue( 'kec_enable' ) ) ? ( this.isKlarnaEnabled() && currentSite.getCustomPreferenceValue( 'kec_enable' ) ) :
             ( currentSite.getCustomPreferenceValue( 'kpECEnabled' ) || false );
     },
-    isKECSingleStepEnabled: function() {
-        return ( this.isKlarnaEnabled() && currentSite.getCustomPreferenceValue( 'kec_enable' ) && currentSite.getCustomPreferenceValue( 'kpIntegrationViaPSP' ) ) || false;
+    isKECSingleStepWithPSPIntegration: function() {
+        var isPSPIntegrated = currentSite.getCustomPreferenceValue( 'kpIntegrationViaPSP' );
+        return ( this.isKlarnaEnabled() && currentSite.getCustomPreferenceValue( 'kec_enable' ) && isPSPIntegrated ) || false;
+    },
+    isKECSingleStepForDirectMerchant: function() {
+        var isPSPIntegrated = currentSite.getCustomPreferenceValue( 'kpIntegrationViaPSP' );
+        var isSingleStepMode = currentSite.getCustomPreferenceValue( 'kec_useOneStepCheckout' );
+        return ( this.isKlarnaEnabled() && currentSite.getCustomPreferenceValue( 'kec_enable' ) && isSingleStepMode && !isPSPIntegrated ) || false;
     },
     showExpressCheckoutButton: function() {
         var showECButton = currentSite.getCustomPreferenceValue( 'kec_placement' );
@@ -415,6 +421,20 @@ var KlarnaOSM = {
             } );
         }
         return showSignInButtonObj;
+    },
+    getKlarnaClientIDForSDK : function() {
+        var osmClientId = this.isEnabled() ? this.getUCI() : null;
+        var expressCheckoutClientId = this.isKlarnExpressCheckoutEnabled() && ( this.isKECSingleStepWithPSPIntegration() || this.isKECSingleStepForDirectMerchant() ) ? this.getKlarnExpressCheckoutClientKey() : null;
+        var signInClientId = this.isKlarnaSignInEnabled() ? this.getKlarnaSignInClientId() : null;
+        var clientId = {};
+        if ( osmClientId === expressCheckoutClientId && osmClientId === signInClientId) {
+            clientId.clientId = osmClientId;
+        } else {
+            clientId.osmClientId = osmClientId;
+            clientId.expressCheckoutClientId = expressCheckoutClientId;
+            clientId.signInClientId = signInClientId;
+        }
+        return clientId;
     }
 };
 

cartridges/int_klarna_payments/cartridge/scripts/payments/model/request/singleStepKec.js

@@ -8,6 +8,8 @@
     function singleStepKECModel() {
         this.amount = '';
         this.currency = '';
+        this.shipping_config = {};
+        this.collect_customer_profile = [];
         this.customer_interaction_config = {};
         this.supplementary_purchase_data = {};
     }

cartridges/int_klarna_payments/cartridge/scripts/payments/requestBuilder/singleStepKec.js

@@ -267,6 +267,30 @@
         return this;
     };
 
+    KlarnaSingleStepCheckoutRequestBuilder.prototype.buildShippingConfigs = function() {
+        var localeObject = this.getLocaleObject();
+        var supportedCountries = [];
+
+        if ( !empty( localeObject ) && !empty( localeObject.country ) ) {
+            supportedCountries.push( localeObject.country );
+        }
+
+        this.context.shipping_config = {
+            mode: "EDITABLE",
+            supported_countries: supportedCountries
+        };
+        return this;
+    };
+
+    KlarnaSingleStepCheckoutRequestBuilder.prototype.collectCustomerProfile = function( basket ) {
+        this.context.collect_customer_profile = [
+            "profile:email",
+            "profile:phone",
+            "profile:billing_address"
+        ];
+        return this;
+    };
+
     KlarnaSingleStepCheckoutRequestBuilder.prototype.build = function() {
         var basket = this.params.basket;
         var kpAttachmentsPreferenceValue = Site.getCurrent().getCustomPreferenceValue( 'kpEMD' ) || null;
@@ -282,6 +306,8 @@
         this.buildOrderLines( basket );
         this.buildTotalAmount( basket );
         this.buildReturnUrl( basket );
+        this.buildShippingConfigs();
+        this.collectCustomerProfile();
 
         // Validate the built data using the context and line items
         this.validateBuildAmounts( basket );

cartridges/int_klarna_payments/cartridge/scripts/util/klarnaHelper.js

@@ -520,7 +520,7 @@ function mapKlarnaExpressAddress( collectedAddress ) {
     addressData.address1 = collectedAddress.street_address || '';
     addressData.address2 = collectedAddress.street_address_2 || '';
     addressData.city = collectedAddress.city || '';
-    addressData.postalCode = collectedAddress.postal_code || '';
+    addressData.postalCode = collectedAddress.postal_code || collectedAddress.postalCode || '';
     addressData.stateCode = collectedAddress.region || '';
     addressData.countryCode = { value: collectedAddress.country || '' };
     addressData.phone = collectedAddress.phone || '';