redsys-easy 5.2.4 → 5.2.6

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/crypto.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 /**
  * Adds padding to a buffer.
  *

package/lib/formatter-utils.d.ts

@@ -9,7 +9,7 @@
  *
  * @public
  */
-export declare const useSingleInputFormatter: <AF extends (input: any) => B, B, C extends readonly unknown[], D>(fn: (args_0: B, ...args_1: C) => D, inputFormatter: AF) => (input: Parameters<AF>[0], ...otherArgs_0: C) => D;
+export declare const useSingleInputFormatter: <AF extends (input: any) => B, B, C extends readonly unknown[], D>(fn: (...args: [B, ...C]) => D, inputFormatter: AF) => ((input: Parameters<AF>[0], ...otherArgs: [...C]) => D);
 /**
  * Applies an output formatter to a function
  *

package/lib/formatters/output-params.d.ts

@@ -1,7 +1,7 @@
 import type { BaseOutputParams, RestNotificationOutputParams, SoapNotificationOutputParams, RequestOutputParams, RestIniciaPeticionOutputParams, RestTrataPeticionOutputParams, ResolvedTransactionTrait } from '../types/output-params';
 import type { BaseFormatterOutput, NotificationFormatterOutput, RequestFormatterOutput, RestIniciaPeticionFormatterOutput, RestTrataPeticionFormatterOutput, ResolvedTransactionTraitFormatterOutput } from './types';
 export declare const baseOutputFormatter: <RawOutputParams extends BaseOutputParams>(raw: RawOutputParams) => BaseFormatterOutput<RawOutputParams>;
-export declare const formatPrice: (params: Omit<ResolvedTransactionTrait, 'Ds_Response'>) => Omit<ResolvedTransactionTraitFormatterOutput, 'response'>;
+export declare const formatPrice: (params: Omit<ResolvedTransactionTrait, "Ds_Response">) => Omit<ResolvedTransactionTraitFormatterOutput, "response">;
 /**
  * REST notification formatter
  *

package/lib/index.d.ts

@@ -11,6 +11,7 @@ export { RedsysError, ValidationError, ParseError, HTTPError, GatewayError, Resp
 export type { RedirectInputParams, RestIniciaPeticionInputParams, RestTrataPeticionInputParams } from './types/input-params';
 export type { RestIniciaPeticionOutputParams, RestTrataPeticionOutputParams, RestNotificationOutputParams, SoapNotificationOutputParams } from './types/output-params';
 export type { ResponseJSONSuccess, RedirectForm, ThreeDSv2MethodNotificationBody, ThreeDSv1ChallengeNotificationBody, ThreeDSv2ChallengeNotificationBody } from './types/api';
+export { serializeAndSignJSONRequest, deserializeAndVerifyJSONResponse, } from './rest/json';
 export { create3DSMethodForm, create3DSv1ChallengeForm, create3DSv2ChallengeForm, deserializeThreeDSMethodData, deserializeCres } from './rest/3ds';
 export type { ThreeDSBrowserClientInfo, ThreeDSMethodForm, ThreeDSv1ChallengeForm, ThreeDSv2ChallengeForm, ThreeDSMethodData, ThreeDSCres } from './types/3ds-params';
 export { detectSoapVersion, mimicSoapNotificationReceiver, mimicSoap11NotificationResponse, mimicSoap12NotificationResponse } from './soap/utils';

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
@@ -2734,7 +2782,7 @@ for (const [key, value] of Object.entries(CURRENCIES)) {
 const LANGUAGES = {
     es: '1',
     en: '2',
-    ca: '3',
+    ca: '3', // Codigo ISO "ca" compartido por catalan(3) y valenciano(10)
     fr: '4',
     de: '5',
     nl: '6',
@@ -3495,4 +3543,4 @@ const restTrataPeticionOutputFormatter = (raw) => {
     };
 };
 
-export { CARDBRANDS, COUNTRIES, CURRENCIES, GatewayError, HTTPError, LANGUAGES, PRODUCTION_URLS, ParseError, REV_CARDBRANDS, REV_COUNTRIES, REV_CURRENCIES, REV_LANGUAGES, RedsysError, ResponseError, SANDBOX_URLS, TRANSACTION_TYPES, ValidationError, assertSuccessfulResponse, assertSuccessfulResponseCode, create3DSMethodForm, create3DSv1ChallengeForm, create3DSv2ChallengeForm, createRedsysAPI, deserializeCres, deserializeThreeDSMethodData, detectSoapVersion, getResponseCodeMessage, getSISErrorCodeMessage, isResponseCodeOk, mimicSoap11NotificationResponse, mimicSoap12NotificationResponse, mimicSoapNotificationReceiver, randomTransactionId, redirectInputFormatter, restIniciaPeticionInputFormatter, restIniciaPeticionOutputFormatter, restNotificationOutputFormatter, restTrataPeticionInputFormatter, restTrataPeticionOutputFormatter, soapNotificationOutputFormatter, useOutputFormatter, usePromiseOutputFormatter, useSingleInputFormatter };
+export { CARDBRANDS, COUNTRIES, CURRENCIES, GatewayError, HTTPError, LANGUAGES, PRODUCTION_URLS, ParseError, REV_CARDBRANDS, REV_COUNTRIES, REV_CURRENCIES, REV_LANGUAGES, RedsysError, ResponseError, SANDBOX_URLS, TRANSACTION_TYPES, ValidationError, assertSuccessfulResponse, assertSuccessfulResponseCode, create3DSMethodForm, create3DSv1ChallengeForm, create3DSv2ChallengeForm, createRedsysAPI, deserializeAndVerifyJSONResponse, deserializeCres, deserializeThreeDSMethodData, detectSoapVersion, getResponseCodeMessage, getSISErrorCodeMessage, isResponseCodeOk, mimicSoap11NotificationResponse, mimicSoap12NotificationResponse, mimicSoapNotificationReceiver, randomTransactionId, redirectInputFormatter, restIniciaPeticionInputFormatter, restIniciaPeticionOutputFormatter, restNotificationOutputFormatter, restTrataPeticionInputFormatter, restTrataPeticionOutputFormatter, serializeAndSignJSONRequest, soapNotificationOutputFormatter, useOutputFormatter, usePromiseOutputFormatter, useSingleInputFormatter };

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
@@ -2736,7 +2784,7 @@ for (const [key, value] of Object.entries(CURRENCIES)) {
 const LANGUAGES = {
     es: '1',
     en: '2',
-    ca: '3',
+    ca: '3', // Codigo ISO "ca" compartido por catalan(3) y valenciano(10)
     fr: '4',
     de: '5',
     nl: '6',
@@ -3520,6 +3568,7 @@ exports.create3DSMethodForm = create3DSMethodForm;
 exports.create3DSv1ChallengeForm = create3DSv1ChallengeForm;
 exports.create3DSv2ChallengeForm = create3DSv2ChallengeForm;
 exports.createRedsysAPI = createRedsysAPI;
+exports.deserializeAndVerifyJSONResponse = deserializeAndVerifyJSONResponse;
 exports.deserializeCres = deserializeCres;
 exports.deserializeThreeDSMethodData = deserializeThreeDSMethodData;
 exports.detectSoapVersion = detectSoapVersion;
@@ -3536,6 +3585,7 @@ exports.restIniciaPeticionOutputFormatter = restIniciaPeticionOutputFormatter;
 exports.restNotificationOutputFormatter = restNotificationOutputFormatter;
 exports.restTrataPeticionInputFormatter = restTrataPeticionInputFormatter;
 exports.restTrataPeticionOutputFormatter = restTrataPeticionOutputFormatter;
+exports.serializeAndSignJSONRequest = serializeAndSignJSONRequest;
 exports.soapNotificationOutputFormatter = soapNotificationOutputFormatter;
 exports.useOutputFormatter = useOutputFormatter;
 exports.usePromiseOutputFormatter = usePromiseOutputFormatter;

package/lib/rest/3ds.d.ts

@@ -4,7 +4,7 @@ import type { ThreeDSv1ChallengeOutputParams, ThreeDSv2ChallengeOutputParams, Th
  *
  * @public
  */
-export declare const create3DSMethodForm: (emv3dsParams: Pick<ThreeDSv2PreAuthWithMethodOutputParams, 'threeDSServerTransID' | 'threeDSMethodURL'>, notificationURL: string) => ThreeDSMethodForm;
+export declare const create3DSMethodForm: (emv3dsParams: Pick<ThreeDSv2PreAuthWithMethodOutputParams, "threeDSServerTransID" | "threeDSMethodURL">, notificationURL: string) => ThreeDSMethodForm;
 /**
  * Creates parameters for a 3DS v1 challenge form
  *

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/lib/soap/notification-serialization.d.ts

@@ -1,3 +1,3 @@
 import type { ParsedSoapNotifiation, SoapNotificationResponse } from '../types/api';
 export declare const serializeSoapNotificationResponse: ({ allow: allowOperation }: SoapNotificationResponse) => string;
-export declare const deserializeSoapNotification: (xml: string) => ParsedSoapNotifiation['Message'];
+export declare const deserializeSoapNotification: (xml: string) => ParsedSoapNotifiation["Message"];

package/lib/soap/notification-signature.d.ts

@@ -1,3 +1,3 @@
 import type { ParsedSoapNotifiation, SoapNotificationResponse } from '../types/api';
-export declare const verifySoapNotification: (merchantKey: string, xml: string, msg: ParsedSoapNotifiation['Message']) => void;
+export declare const verifySoapNotification: (merchantKey: string, xml: string, msg: ParsedSoapNotifiation["Message"]) => void;
 export declare const signSoapNotificationResponse: (merchantKey: string, serializedResponse: string, response: SoapNotificationResponse) => string;

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.6",
   "author": "Javier Garcia <javiertury@gmail.com>",
   "license": "MIT",
   "keywords": [
@@ -62,6 +62,7 @@
     "@typescript-eslint/eslint-plugin": "^5.62.0",
     "@typescript-eslint/parser": "^5.62.0",
     "cheerio": "1.0.0-rc.12",
+    "commit-and-tag-version": "^12.5.0",
     "eslint": "^8.46.0",
     "eslint-config-prettier": "^8.10.0",
     "eslint-config-standard-with-typescript": "^37.0.0",
@@ -76,10 +77,9 @@
     "lint-staged": "^13.2.3",
     "markdown-magic": "^2.6.1",
     "rimraf": "^5.0.1",
-    "rollup": "^3.27.1",
+    "rollup": "^3.29.5",
     "rollup-plugin-typescript2": "^0.35.0",
     "simple-git-hooks": "^2.9.0",
-    "standard-version": "^9.5.0",
     "ts-expect": "^1.3.0",
     "ts-jest": "^29.1.1",
     "typescript": "^5.1.6"
@@ -118,6 +118,6 @@
     "docs:api": "api-documenter markdown --input-folder ./api/temp --output-folder ./docs",
     "docs:readme": "md-magic --path ./README.md",
     "docs": "pnpm run docs:api && pnpm run docs:readme",
-    "release": "pnpm run test && standard-version --dry-run && pnpm run docs && git add docs CHANGELOG.md && standard-version --commit-all"
+    "release": "pnpm run test && commit-and-tag-version --dry-run && pnpm run docs && git add docs CHANGELOG.md && commit-and-tag-version --commit-all"
   }
 }