redsys-easy 5.2.4 → 5.2.5

package/lib/client.d.ts

@@ -87,6 +87,8 @@ export interface RedsysAPI {
     restIniciaPeticion: RestIniciaPeticion;
     restTrataPeticion: RestTrataPeticion;
     createRedirectForm: CreateRedirectForm;
+    processRedirectNotification: ProcessRestNotification;
+    processDirectRestNotification: ProcessRestNotification;
     processRestNotification: ProcessRestNotification;
     processSoapNotification: ProcessSoapNotification;
     createSoapNotificationAnswer: CreateSoapNotificationAnswer;

package/lib/index.esm.js

@@ -1927,7 +1927,7 @@ const deserializeJSONMerchantParams = (strPayload) => {
     if (typeof strPayload !== 'string') {
         throw new ParseError('Payload must be a base-64 encoded string');
     }
-    const payload = JSON.parse(decodeURIComponent(Buffer.from(strPayload, 'base64').toString('utf8')));
+    const payload = JSON.parse(Buffer.from(strPayload, 'base64').toString('utf8'));
     if (typeof payload !== 'object' || payload == null) {
         throw new ParseError('Cannot parse notification payload');
     }
@@ -2126,6 +2126,22 @@ const serializeAndSignJSONRequest = (merchantKey, requestParams) => {
     return sha256SignJSONRequest(merchantKey, serializedParams, requestParams);
 };
 
+/**
+ * Tries to decode x-www-form-urlencoded values of an object
+ */
+const decodeUrlEntries = (params) => {
+    return Object.fromEntries(Object.entries(params).map((entry) => {
+        let processedValue = entry[1];
+        if (typeof entry[1] === 'string') {
+            try {
+                processedValue = decodeURIComponent(entry[1].replaceAll('+', ' '));
+            }
+            catch (_) { }
+        }
+        return [entry[0], processedValue];
+    }));
+};
+
 const serializeSoapNotificationResponse = ({ allow: allowOperation }) => {
     const answer = allowOperation ? 'OK' : 'KO';
     return `<Response Ds_Version="0.0"><Ds_Response_Merchant>${answer}</Ds_Response_Merchant></Response>`;
@@ -2270,14 +2286,44 @@ const createRedsysAPI = (config) => {
         };
     };
     /**
-     * Processes a JSON REST notification
+     * Processes a URLOK/URLKO query notification
      */
-    const processRestNotification = (
+    const processRedirectNotification = (
+    /** Body of JSON notification, as a POJO (Plain Old Javascript Object) */
+    body) => {
+        // A notification can't contain a gateway error, it didn't initiate the request
+        const params = deserializeAndVerifyJSONResponse(config.secretKey, body);
+        return decodeUrlEntries(params);
+    };
+    /**
+     * Processes a direct JSON REST notification
+     */
+    const processDirectRestNotification = (
     /** Body of JSON notification, as a POJO (Plain Old Javascript Object) */
     body) => {
         // A notification can't contain a gateway error, it didn't initiate the request
         return deserializeAndVerifyJSONResponse(config.secretKey, body);
     };
+    /**
+     * Processes either a URLOK/URLKO query or a JSON REST notification
+     *
+     * @remarks
+     * This utility exists only for backwards compatibility. Users are adviced
+     * not to rely on the autodetection of this tool and use specific functions
+     * @see {@link processRedirectNotification}
+     * @see {@link processDirectRestNotification}
+     *
+     * @deprecated
+     */
+    const processRestNotification = (
+    /** Body of JSON notification, as a POJO (Plain Old Javascript Object) */
+    body) => {
+        // A notification can't contain a gateway error, it didn't initiate the request
+        const params = deserializeAndVerifyJSONResponse(config.secretKey, body);
+        return typeof params.Ds_Date === 'string' && params.Ds_Date.includes('%2F')
+            ? decodeUrlEntries(params)
+            : params;
+    };
     /**
      * Parses and verifies the body of a SOAP notification
      */
@@ -2303,6 +2349,8 @@ const createRedsysAPI = (config) => {
         restIniciaPeticion,
         restTrataPeticion,
         createRedirectForm,
+        processRedirectNotification,
+        processDirectRestNotification,
         processRestNotification,
         processSoapNotification,
         createSoapNotificationAnswer

package/lib/index.js

@@ -1929,7 +1929,7 @@ const deserializeJSONMerchantParams = (strPayload) => {
     if (typeof strPayload !== 'string') {
         throw new ParseError('Payload must be a base-64 encoded string');
     }
-    const payload = JSON.parse(decodeURIComponent(Buffer.from(strPayload, 'base64').toString('utf8')));
+    const payload = JSON.parse(Buffer.from(strPayload, 'base64').toString('utf8'));
     if (typeof payload !== 'object' || payload == null) {
         throw new ParseError('Cannot parse notification payload');
     }
@@ -2128,6 +2128,22 @@ const serializeAndSignJSONRequest = (merchantKey, requestParams) => {
     return sha256SignJSONRequest(merchantKey, serializedParams, requestParams);
 };
 
+/**
+ * Tries to decode x-www-form-urlencoded values of an object
+ */
+const decodeUrlEntries = (params) => {
+    return Object.fromEntries(Object.entries(params).map((entry) => {
+        let processedValue = entry[1];
+        if (typeof entry[1] === 'string') {
+            try {
+                processedValue = decodeURIComponent(entry[1].replaceAll('+', ' '));
+            }
+            catch (_) { }
+        }
+        return [entry[0], processedValue];
+    }));
+};
+
 const serializeSoapNotificationResponse = ({ allow: allowOperation }) => {
     const answer = allowOperation ? 'OK' : 'KO';
     return `<Response Ds_Version="0.0"><Ds_Response_Merchant>${answer}</Ds_Response_Merchant></Response>`;
@@ -2272,14 +2288,44 @@ const createRedsysAPI = (config) => {
         };
     };
     /**
-     * Processes a JSON REST notification
+     * Processes a URLOK/URLKO query notification
      */
-    const processRestNotification = (
+    const processRedirectNotification = (
+    /** Body of JSON notification, as a POJO (Plain Old Javascript Object) */
+    body) => {
+        // A notification can't contain a gateway error, it didn't initiate the request
+        const params = deserializeAndVerifyJSONResponse(config.secretKey, body);
+        return decodeUrlEntries(params);
+    };
+    /**
+     * Processes a direct JSON REST notification
+     */
+    const processDirectRestNotification = (
     /** Body of JSON notification, as a POJO (Plain Old Javascript Object) */
     body) => {
         // A notification can't contain a gateway error, it didn't initiate the request
         return deserializeAndVerifyJSONResponse(config.secretKey, body);
     };
+    /**
+     * Processes either a URLOK/URLKO query or a JSON REST notification
+     *
+     * @remarks
+     * This utility exists only for backwards compatibility. Users are adviced
+     * not to rely on the autodetection of this tool and use specific functions
+     * @see {@link processRedirectNotification}
+     * @see {@link processDirectRestNotification}
+     *
+     * @deprecated
+     */
+    const processRestNotification = (
+    /** Body of JSON notification, as a POJO (Plain Old Javascript Object) */
+    body) => {
+        // A notification can't contain a gateway error, it didn't initiate the request
+        const params = deserializeAndVerifyJSONResponse(config.secretKey, body);
+        return typeof params.Ds_Date === 'string' && params.Ds_Date.includes('%2F')
+            ? decodeUrlEntries(params)
+            : params;
+    };
     /**
      * Parses and verifies the body of a SOAP notification
      */
@@ -2305,6 +2351,8 @@ const createRedsysAPI = (config) => {
         restIniciaPeticion,
         restTrataPeticion,
         createRedirectForm,
+        processRedirectNotification,
+        processDirectRestNotification,
         processRestNotification,
         processSoapNotification,
         createSoapNotificationAnswer

package/lib/rest/utils.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Tries to decode x-www-form-urlencoded values of an object
+ */
+export declare const decodeUrlEntries: <T extends object>(params: T) => T;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "redsys-easy",
   "description": "Node JS interface for Redsys payment gateway",
-  "version": "5.2.4",
+  "version": "5.2.5",
   "author": "Javier Garcia <javiertury@gmail.com>",
   "license": "MIT",
   "keywords": [