redsys-easy 5.2.11 → 5.3.1

package/README.md

@@ -17,8 +17,7 @@ Checkout the [api documentation](./docs/redsys-easy.md) to explore the utilities
 
 These are the most important utilities that redsys-easy provides.
 
-<!-- AUTO-GENERATED-CONTENT:START (CODE:src=./examples/__readme__/usage.ts) -->
-<!-- The below code snippet is automatically added from ./examples/__readme__/usage.ts -->
+<!-- docs CODE src="./examples/__readme__/usage.ts" -->
 ```ts
 import {
   createRedsysAPI,
@@ -48,7 +47,7 @@ const {
   urls: SANDBOX_URLS
 });
 ```
-<!-- AUTO-GENERATED-CONTENT:END -->
+<!-- /docs -->
 
 ## Examples
 
@@ -67,8 +66,7 @@ As an example, redsys-easy provides some basic typescript-ready formatters.
 
 > :warning: **Format has changed**: Previous versions of redsys-easy used a different format, particularly the `amount` field.
 
-<!-- AUTO-GENERATED-CONTENT:START (CODE:src=./examples/__readme__/formatters.ts) -->
-<!-- The below code snippet is automatically added from ./examples/__readme__/formatters.ts -->
+<!-- docs CODE src="./examples/__readme__/formatters.ts" -->
 ```ts
 import {
   createRedsysAPI,
@@ -124,7 +122,7 @@ export const restTrataPeticion = useSingleInputFormatter(
 export const processRestNotification = useOutputFormatter(baseProcessRestNotification, restNotificationOutputFormatter);
 export const processSoapNotification = useOutputFormatter(baseProcessSoapNotification, soapNotificationOutputFormatter);
 ```
-<!-- AUTO-GENERATED-CONTENT:END -->
+<!-- /docs -->
 
 ## FAQ
 

package/lib/formatters/types.d.ts

@@ -265,6 +265,10 @@ export interface RequestFormatterOutput<RawOutputParams extends RequestOutputPar
      * @see {@link RestTrataPeticionOutputParams.Ds_Card_Number}
      */
     cardNumber?: string;
+    /**
+     * @see {@link RestTrataPeticionOutputParams.Ds_Card_Last4}
+     */
+    cardNumberLast4?: string;
     /**
      * @see {@link RestTrataPeticionOutputParams.Ds_UrlPago2Fases}
      */

package/lib/index.esm.js

@@ -4755,11 +4755,12 @@ const soapNotificationOutputFormatter = (raw) => {
 const requestOutputFormatter = (raw) => {
     const { 
     // eslint-disable-next-line @typescript-eslint/no-deprecated -- robust to old format
-    Ds_CardNumber: deprecatedCardNumber, Ds_Card_Number: newCardNumber, Ds_Merchant_Identifier: identifier, Ds_ExpiryDate: rawExpiryDate, Ds_UrlPago2Fases: payURL, Ds_Language: rawLang } = raw;
+    Ds_CardNumber: deprecatedCardNumber, Ds_Card_Number: newCardNumber, Ds_Card_Last4: cardNumberLast4, Ds_Merchant_Identifier: identifier, Ds_ExpiryDate: rawExpiryDate, Ds_UrlPago2Fases: payURL, Ds_Language: rawLang } = raw;
     const cardNumber = newCardNumber !== null && newCardNumber !== void 0 ? newCardNumber : deprecatedCardNumber;
     return {
         ...baseOutputFormatter(raw),
         ...(isStringNotEmpty(cardNumber) ? { cardNumber } : undefined),
+        ...(isStringNotEmpty(cardNumberLast4) ? { cardNumberLast4 } : undefined),
         ...(isStringNotEmpty(identifier) ? { identifier } : undefined),
         ...(isStringNotEmpty(payURL) ? { payURL } : undefined),
         ...(isStringNotEmpty(rawExpiryDate)

package/lib/index.js

@@ -4757,11 +4757,12 @@ const soapNotificationOutputFormatter = (raw) => {
 const requestOutputFormatter = (raw) => {
     const { 
     // eslint-disable-next-line @typescript-eslint/no-deprecated -- robust to old format
-    Ds_CardNumber: deprecatedCardNumber, Ds_Card_Number: newCardNumber, Ds_Merchant_Identifier: identifier, Ds_ExpiryDate: rawExpiryDate, Ds_UrlPago2Fases: payURL, Ds_Language: rawLang } = raw;
+    Ds_CardNumber: deprecatedCardNumber, Ds_Card_Number: newCardNumber, Ds_Card_Last4: cardNumberLast4, Ds_Merchant_Identifier: identifier, Ds_ExpiryDate: rawExpiryDate, Ds_UrlPago2Fases: payURL, Ds_Language: rawLang } = raw;
     const cardNumber = newCardNumber !== null && newCardNumber !== void 0 ? newCardNumber : deprecatedCardNumber;
     return {
         ...baseOutputFormatter(raw),
         ...(isStringNotEmpty(cardNumber) ? { cardNumber } : undefined),
+        ...(isStringNotEmpty(cardNumberLast4) ? { cardNumberLast4 } : undefined),
         ...(isStringNotEmpty(identifier) ? { identifier } : undefined),
         ...(isStringNotEmpty(payURL) ? { payURL } : undefined),
         ...(isStringNotEmpty(rawExpiryDate)

package/lib/types/input-params.d.ts

@@ -91,12 +91,14 @@ export interface RedirectInputParams extends BaseInputParams {
  * @public
  */
 export interface RequestInputParams extends BaseInputParams, Pick<RedirectInputParams, 'DS_MERCHANT_MERCHANTURL' | 'DS_MERCHANT_URLOK' | 'DS_MERCHANT_URLKO' | 'DS_MERCHANT_CONSUMERLANGUAGE' | 'DS_MERCHANT_PAYMETHODS' | 'DS_MERCHANT_PERSOCODE' | 'DS_MERCHANT_SHIPPINGADDRESSPYP'> {
-    /** xPay data, hex */
+    /** xPay data in base64 format, mutually exclusive with DS_XPAYDECODEDDATA */
     DS_XPAYDATA?: string | undefined;
+    /** xPay data in json format, mutually exclusive with DS_XPAYDATA */
+    DS_XPAYDECODEDDATA?: Record<string, unknown> | undefined;
     /** xPay origin */
-    DS_XPAYORIGEN?: 'Google' | 'Apple' | undefined;
+    DS_XPAYORIGEN?: 'WEB' | 'InApp' | undefined;
     /** xPay type */
-    DS_XPAYTYPE?: 'WEB' | 'InApp' | undefined;
+    DS_XPAYTYPE?: 'Google' | 'Apple' | undefined;
     /** PUC identifier, number */
     DS_ACQUIRER_IDENTIFIER?: string | undefined;
     /** Matching data */

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

@@ -28,6 +28,8 @@ export interface BaseOutputParams {
     Ds_MerchantData?: string;
     /** Card brand */
     Ds_Card_Brand?: CardBrandNum;
+    /** Card typology */
+    Ds_Card_Typology?: string | undefined;
     /** Card is under PSD2 */
     Ds_Card_PSD2?: 'Y' | 'N';
     /**
@@ -48,10 +50,14 @@ export interface BaseOutputParams {
     Ds_CardNumber?: string;
     /** Card number with some digits replaced with asterisks */
     Ds_Card_Number?: string;
+    /** Last 4 digits of card number */
+    Ds_Card_Last4?: string;
     /** Card expiry date, YYmm */
     Ds_ExpiryDate?: string;
     /** Stored payment method reference number */
     Ds_Merchant_Identifier?: string;
+    /** Electronic Commerce Indicator */
+    Ds_ECI?: string | undefined;
 }
 /**
  * Common output parameters of resolved requests or notifications
@@ -68,6 +74,10 @@ export interface ResolvedTransactionTrait {
     Ds_Currency: CurrencyNum;
     /** Response code */
     Ds_Response: string;
+    /** Response description */
+    Ds_Response_Description?: string | undefined;
+    /** Response subcode indicating motive, it appears in denials with code 190 */
+    Ds_ResponseInt?: string | undefined;
 }
 /**
  * Common output parameters of a all requests

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "redsys-easy",
   "description": "Node JS interface for Redsys payment gateway",
-  "version": "5.2.11",
+  "version": "5.3.1",
   "author": "Javier Garcia <javiertury@gmail.com>",
   "license": "MIT",
   "keywords": [
@@ -51,30 +51,30 @@
     "@commitlint/cli": "^17.6.7",
     "@commitlint/config-conventional": "^17.6.7",
     "@koa/router": "^12.0.0",
-    "@microsoft/api-documenter": "^7.22.32",
+    "@microsoft/api-documenter": "^7.28.0",
     "@microsoft/api-extractor": "^7.36.3",
     "@rollup/plugin-node-resolve": "^15.1.0",
     "@types/cheerio": "^0.22.31",
-    "@types/jest": "^29.5.3",
-    "@types/koa": "^2.13.8",
+    "@types/jest": "^30.0.0",
+    "@types/koa": "^3.0.0",
     "@types/koa-bodyparser": "^4.3.10",
     "@types/koa__router": "^12.0.0",
     "cheerio": "1.0.0-rc.12",
     "commit-and-tag-version": "^12.5.0",
-    "eslint": "^9.17.0",
+    "eslint": "^9.39.1",
     "eslint-config-love": "^114.0.0",
-    "eslint-plugin-jest": "^28.10.0",
-    "jest": "^29.6.2",
-    "koa": "^2.14.2",
+    "eslint-plugin-jest": "^28.14.0",
+    "jest": "^30.2.0",
+    "koa": "^3.0.0",
     "koa-bodyparser": "^4.4.1",
     "lint-staged": "^15.3.0",
-    "markdown-magic": "^2.6.1",
-    "rimraf": "^5.0.1",
+    "markdown-magic": "^4.0.4",
+    "rimraf": "^6.1.2",
     "rollup": "^3.29.5",
     "rollup-plugin-typescript2": "^0.35.0",
     "simple-git-hooks": "^2.9.0",
     "ts-expect": "^1.3.0",
-    "ts-jest": "^29.1.1",
+    "ts-jest": "^29.4.5",
     "typescript": "^5.1.6"
   },
   "jest": {
@@ -88,10 +88,13 @@
     "setupFilesAfterEnv": [
       "./test/jest.setup.ts"
     ],
-    "globals": {
-      "ts-jest": {
-        "tsconfig": "./tsconfig.test.json"
-      }
+    "transform": {
+      "^.+\\.tsx?$": [
+        "ts-jest",
+        {
+          "tsconfig": "tsconfig.test.json"
+        }
+      ]
     },
     "moduleNameMapper": {
       "redsys-easy": "<rootDir>/src"
@@ -109,7 +112,7 @@
     "test:readme": "tsc -p ./tsconfig.readme.json",
     "test": "pnpm run test:code && pnpm run test:readme",
     "docs:api": "api-documenter markdown --input-folder ./api/temp --output-folder ./docs",
-    "docs:readme": "md-magic --path ./README.md",
+    "docs:readme": "md-magic --files ./README.md",
     "docs": "pnpm run docs:api && pnpm run docs:readme",
     "release": "pnpm run test && commit-and-tag-version --dry-run && pnpm run docs && git add docs CHANGELOG.md && commit-and-tag-version --commit-all"
   }