redsys-easy 4.0.2 → 5.0.0

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

@@ -1,158 +1,158 @@
-import type { TransactionType } from '../assets/transaction-types';
-import type { CountryNum } from '../assets/countries';
-import type { CardBrandNum } from '../assets/card-brands';
-import type { CurrencyNum } from '../assets/currencies';
-import type { LanguageNum } from '../assets/lang-codes';
-import type { ThreeDSv1PreAuthOutputParams, ThreeDSv2PreAuthOutputParams, ThreeDSv1ChallengeOutputParams, ThreeDSv2ChallengeOutputParams } from './3ds-params';
-/**
- * Common output parameters
- */
-export interface BaseOutputParams {
-    /** Order identifier */
-    Ds_Order: string;
-    /** Merchant code number */
-    Ds_MerchantCode: string;
-    /** Terminal number */
-    Ds_Terminal: string;
-    /** Transaction type */
-    Ds_TransactionType: TransactionType;
-    /** Secure payment indicator */
-    Ds_SecurePayment?: '0' | '1' | '2';
-    /** Card country */
-    Ds_Card_Country?: CountryNum;
-    /** Authorization transaction code, refunds */
-    Ds_AuthorisationCode?: string;
-    /** Card type */
-    Ds_Card_Type?: 'C' | 'D';
-    /** Merchant data */
-    Ds_MerchantData?: string;
-    /** Card brand */
-    Ds_Card_Brand?: CardBrandNum;
-    /** Card is under PSD2 */
-    Ds_Card_PSD2?: 'Y' | 'N';
-    /**
-     * PDS2 exemptions
-     *
-     * @example
-     * `'LWV;TRA[30.0];COR;MIT;ATD;WHL'`
-     */
-    Ds_Excep_SCA?: string;
-    /** Payment method number */
-    Ds_ProcessedPayMethod?: string;
-    /** Credential On File transaction identifier */
-    Ds_Merchant_Cof_Txnid?: string;
-    /**
-     * Card number with some digits replaced with asterisks
-     * @deprecated
-     */
-    Ds_CardNumber?: string;
-    /** Card number with some digits replaced with asterisks */
-    Ds_Card_Number?: string;
-    /** Card expiry date, YYmm */
-    Ds_ExpiryDate?: string;
-    /** Stored payment method reference number */
-    Ds_Merchant_Identifier?: string;
-}
-/**
- * Common output parameters of resolved requests or notifications
- */
-export interface ResolvedTransactionTrait {
-    /**
-     * Amount designated as an integer in the smallest currency division
-     *
-     * @example
-     * `'199'` (1.99 EUR)
-     */
-    Ds_Amount: string;
-    /** Currency number, ISO-4217 */
-    Ds_Currency: CurrencyNum;
-    /** Response code */
-    Ds_Response: string;
-}
-/**
- * Common output parameters of a all requests
- */
-export interface RequestOutputParams extends BaseOutputParams {
-    /** Payment link, paygold */
-    Ds_UrlPago2Fases?: string;
-    /** Language */
-    Ds_Language?: LanguageNum;
-}
-/**
- * Output parameters of a IniciaPeticion HTTP request
- *
- * @public
- */
-export interface RestIniciaPeticionOutputParams extends RequestOutputParams {
-    /** EMV3DS data in json format */
-    Ds_EMV3DS?: ThreeDSv1PreAuthOutputParams | ThreeDSv2PreAuthOutputParams;
-    /** Dynamic Currency Conversion data, json */
-    Ds_DCC?: {
-        InfoMonedaTarjeta: {
-            /** Card currency number, ISO-4217 */
-            monedaDCC: string;
-            /** Card currency name */
-            litMonedaDCC: string;
-            /** Card currency 3-letter code */
-            litMonedaRDCC: string;
-            /** Amount in card currency, decimal number */
-            importeDCC: string;
-            /** Exchange rate, decimal number */
-            cambioDCC: string;
-            /** Exchange date, YYYY-MM-DD */
-            fechaCambioDCC: string;
-            /** Markup, decimal number */
-            markUp: number;
-        };
-        InfoMonedaComercio: {
-            /** Currency number, ISO-4217 */
-            monedaCome: string;
-            /** Currency 3-letter code */
-            litMonedaCome: string;
-            /** Amount, decimal number */
-            importeCome: string;
-        };
-    };
-}
-/**
- * Output parameters of a TrataPeticion HTTP request
- *
- * @public
- */
-export interface RestTrataPeticionOutputParams extends RequestOutputParams, Omit<ResolvedTransactionTrait, 'Ds_Response'> {
-    /** Response code */
-    Ds_Response?: ResolvedTransactionTrait['Ds_Response'];
-    /** EMV3DS data in json format */
-    Ds_EMV3DS?: ThreeDSv1ChallengeOutputParams | ThreeDSv2ChallengeOutputParams;
-}
-/**
- * Common parameters for notifications
- */
-export interface NotificationOutputParams extends BaseOutputParams, ResolvedTransactionTrait {
-    /** Language */
-    Ds_ConsumerLanguage?: LanguageNum;
-    /** Error code */
-    Ds_ErrorCode?: string;
-}
-/**
- * Parameters of a redsys REST notification
- *
- * @public
- */
-export interface RestNotificationOutputParams extends NotificationOutputParams {
-    /** Transaction date, DD/MM/YYYY */
-    Ds_Date: string;
-    /** Transaction time, hh:mm */
-    Ds_Hour: string;
-}
-/**
- * Parameters of a redsys SOAP notification
- *
- * @public
- */
-export interface SoapNotificationOutputParams extends NotificationOutputParams {
-    /** Transaction date, DD/MM/YYYY */
-    Fecha: string;
-    /** Transaction time, hh:mm */
-    Hora: string;
-}
+import type { TransactionType } from '../assets/transaction-types';
+import type { CountryNum } from '../assets/countries';
+import type { CardBrandNum } from '../assets/card-brands';
+import type { CurrencyNum } from '../assets/currencies';
+import type { LanguageNum } from '../assets/lang-codes';
+import type { ThreeDSv1PreAuthOutputParams, ThreeDSv2PreAuthOutputParams, ThreeDSv1ChallengeOutputParams, ThreeDSv2ChallengeOutputParams } from './3ds-params';
+/**
+ * Common output parameters
+ */
+export interface BaseOutputParams {
+    /** Order identifier */
+    Ds_Order: string;
+    /** Merchant code number */
+    Ds_MerchantCode: string;
+    /** Terminal number */
+    Ds_Terminal: string;
+    /** Transaction type */
+    Ds_TransactionType: TransactionType;
+    /** Secure payment indicator */
+    Ds_SecurePayment?: '0' | '1' | '2';
+    /** Card country */
+    Ds_Card_Country?: CountryNum;
+    /** Authorization transaction code, refunds */
+    Ds_AuthorisationCode?: string;
+    /** Card type */
+    Ds_Card_Type?: 'C' | 'D';
+    /** Merchant data */
+    Ds_MerchantData?: string;
+    /** Card brand */
+    Ds_Card_Brand?: CardBrandNum;
+    /** Card is under PSD2 */
+    Ds_Card_PSD2?: 'Y' | 'N';
+    /**
+     * PDS2 exemptions
+     *
+     * @example
+     * `'LWV;TRA[30.0];COR;MIT;ATD;WHL'`
+     */
+    Ds_Excep_SCA?: string;
+    /** Payment method number */
+    Ds_ProcessedPayMethod?: string;
+    /** Credential On File transaction identifier */
+    Ds_Merchant_Cof_Txnid?: string;
+    /**
+     * Card number with some digits replaced with asterisks
+     * @deprecated
+     */
+    Ds_CardNumber?: string;
+    /** Card number with some digits replaced with asterisks */
+    Ds_Card_Number?: string;
+    /** Card expiry date, YYmm */
+    Ds_ExpiryDate?: string;
+    /** Stored payment method reference number */
+    Ds_Merchant_Identifier?: string;
+}
+/**
+ * Common output parameters of resolved requests or notifications
+ */
+export interface ResolvedTransactionTrait {
+    /**
+     * Amount designated as an integer in the smallest currency division
+     *
+     * @example
+     * `'199'` (1.99 EUR)
+     */
+    Ds_Amount: string;
+    /** Currency number, ISO-4217 */
+    Ds_Currency: CurrencyNum;
+    /** Response code */
+    Ds_Response: string;
+}
+/**
+ * Common output parameters of a all requests
+ */
+export interface RequestOutputParams extends BaseOutputParams {
+    /** Payment link, paygold */
+    Ds_UrlPago2Fases?: string;
+    /** Language */
+    Ds_Language?: LanguageNum;
+}
+/**
+ * Output parameters of a IniciaPeticion HTTP request
+ *
+ * @public
+ */
+export interface RestIniciaPeticionOutputParams extends RequestOutputParams {
+    /** EMV3DS data in json format */
+    Ds_EMV3DS?: ThreeDSv1PreAuthOutputParams | ThreeDSv2PreAuthOutputParams;
+    /** Dynamic Currency Conversion data, json */
+    Ds_DCC?: {
+        InfoMonedaTarjeta: {
+            /** Card currency number, ISO-4217 */
+            monedaDCC: string;
+            /** Card currency name */
+            litMonedaDCC: string;
+            /** Card currency 3-letter code */
+            litMonedaRDCC: string;
+            /** Amount in card currency, decimal number */
+            importeDCC: string;
+            /** Exchange rate, decimal number */
+            cambioDCC: string;
+            /** Exchange date, YYYY-MM-DD */
+            fechaCambioDCC: string;
+            /** Markup, decimal number */
+            markUp: number;
+        };
+        InfoMonedaComercio: {
+            /** Currency number, ISO-4217 */
+            monedaCome: string;
+            /** Currency 3-letter code */
+            litMonedaCome: string;
+            /** Amount, decimal number */
+            importeCome: string;
+        };
+    };
+}
+/**
+ * Output parameters of a TrataPeticion HTTP request
+ *
+ * @public
+ */
+export interface RestTrataPeticionOutputParams extends RequestOutputParams, Omit<ResolvedTransactionTrait, 'Ds_Response'> {
+    /** Response code */
+    Ds_Response?: ResolvedTransactionTrait['Ds_Response'];
+    /** EMV3DS data in json format */
+    Ds_EMV3DS?: ThreeDSv1ChallengeOutputParams | ThreeDSv2ChallengeOutputParams;
+}
+/**
+ * Common parameters for notifications
+ */
+export interface NotificationOutputParams extends BaseOutputParams, ResolvedTransactionTrait {
+    /** Language */
+    Ds_ConsumerLanguage?: LanguageNum;
+    /** Error code */
+    Ds_ErrorCode?: string;
+}
+/**
+ * Parameters of a redsys REST notification
+ *
+ * @public
+ */
+export interface RestNotificationOutputParams extends NotificationOutputParams {
+    /** Transaction date, DD/MM/YYYY */
+    Ds_Date: string;
+    /** Transaction time, hh:mm */
+    Ds_Hour: string;
+}
+/**
+ * Parameters of a redsys SOAP notification
+ *
+ * @public
+ */
+export interface SoapNotificationOutputParams extends NotificationOutputParams {
+    /** Transaction date, DD/MM/YYYY */
+    Fecha: string;
+    /** Transaction time, hh:mm */
+    Hora: string;
+}

package/lib/utils/codes.d.ts

@@ -1,13 +1,13 @@
-/**
- * Returns the message corresponding to a response code, in spanish
- *
- * @public
- */
-export declare const getResponseCodeMessage: (code: string | number) => string | undefined;
-/**
- * Returns the message corresponding to a gateway error code
- *
- * @public
- */
-export declare const getSISErrorCodeMessage: (code: string) => string | undefined;
-export declare const getHTTPErrorCodeMessage: (code: number) => string | undefined;
+/**
+ * Returns the message corresponding to a response code, in spanish
+ *
+ * @public
+ */
+export declare const getResponseCodeMessage: (code: string | number) => string | undefined;
+/**
+ * Returns the message corresponding to a gateway error code
+ *
+ * @public
+ */
+export declare const getSISErrorCodeMessage: (code: string) => string | undefined;
+export declare const getHTTPErrorCodeMessage: (code: number) => string | undefined;

package/lib/utils/misc.d.ts

@@ -1,24 +1,30 @@
-import type { CommonRawRequestParams, CommonRawResponseParams } from '../types/api';
-/**
- * Generates a random order ID following redsys requirements
- *
- * @public
- */
-export declare const randomTransactionId: () => string;
-export declare const extractAndAssertOrderFromRequestParams: (requestParams: CommonRawRequestParams) => string;
-export declare const extractAndAssertOrderFromResponseParams: (responseParams: CommonRawResponseParams) => string;
-/**
- * Indicates if a response code signals success
- *
- * @public
- */
-export declare const isResponseCodeOk: (responseCode: string) => boolean;
-/**
- * Asserts that response has a code that indicates success
- *
- * @public
- */
-export declare const assertSuccessfulResponseCode: (responseParams: {
-    Ds_Response?: string;
-}) => void;
-export declare const isStringNotEmpty: <T extends string>(str: T | undefined) => str is T;
+import type { CommonRawRequestParams, CommonRawResponseParams } from '../types/api';
+/**
+ * Generates a random order ID following redsys requirements
+ *
+ * @public
+ */
+export declare const randomTransactionId: () => string;
+export declare const extractAndAssertOrderFromRequestParams: (requestParams: CommonRawRequestParams) => string;
+export declare const extractAndAssertOrderFromResponseParams: (responseParams: CommonRawResponseParams) => string;
+/**
+ * Indicates if a response code signals success
+ *
+ * @public
+ */
+export declare const isResponseCodeOk: (responseCode: string | number) => boolean;
+/**
+ * Asserts that a response code indicates success
+ *
+ * @public
+ */
+export declare const assertSuccessfulResponseCode: (responseCode: string | number | undefined) => void;
+/**
+ * Asserts that response has a code indicating success
+ *
+ * @public
+ */
+export declare const assertSuccessfulResponse: (responseParams: {
+    Ds_Response?: string;
+}) => void;
+export declare const isStringNotEmpty: <T extends string>(str: T | undefined) => str is T;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "redsys-easy",
   "description": "Node JS interface for Redsys payment gateway",
-  "version": "4.0.2",
+  "version": "5.0.0",
   "author": "Javier Garcia <javiertury@gmail.com>",
   "license": "MIT",
   "keywords": [
@@ -36,54 +36,53 @@
     "*.{js,ts}": "eslint"
   },
   "simple-git-hooks": {
-    "pre-commit": "pnpx lint-staged",
-    "commit-msg": "pnpx commitlint -e"
+    "pre-commit": "pnpm exec lint-staged",
+    "commit-msg": "pnpm exec commitlint -e"
   },
   "dependencies": {
-    "@types/node-fetch": "^2.5.11",
     "base64url": "^3.0.1",
-    "dayjs": "^1.10.6",
-    "decimal.js": "^10.3.1",
-    "fast-xml-parser": "^4.0.0",
-    "node-fetch": "^2.6.1",
-    "tslib": "^2.3.0"
+    "dayjs": "^1.11.9",
+    "decimal.js": "^10.4.3",
+    "fast-xml-parser": "^4.2.7",
+    "tslib": "^2.6.1",
+    "undici": "^5.23.0"
   },
   "devDependencies": {
-    "@commitlint/cli": "^12.1.4",
-    "@commitlint/config-conventional": "^12.1.4",
-    "@koa/router": "^10.0.0",
-    "@microsoft/api-documenter": "^7.13.33",
-    "@microsoft/api-extractor": "^7.18.4",
-    "@rollup/plugin-node-resolve": "^13.0.2",
-    "@types/bluebird": "^3.5.36",
-    "@types/cheerio": "^0.22.30",
-    "@types/jest": "^26.0.24",
-    "@types/koa": "^2.13.4",
-    "@types/koa-bodyparser": "^4.3.2",
-    "@types/koa__router": "^8.0.7",
-    "@typescript-eslint/eslint-plugin": "^4.28.3",
-    "@typescript-eslint/parser": "^4.28.3",
-    "cheerio": "^1.0.0-rc.10",
-    "eslint": "^7.30.0",
-    "eslint-config-standard-with-typescript": "^20.0.0",
-    "eslint-plugin-html": "^6.1.2",
-    "eslint-plugin-import": "^2.23.4",
-    "eslint-plugin-jest": "^24.3.6",
+    "@commitlint/cli": "^17.6.7",
+    "@commitlint/config-conventional": "^17.6.7",
+    "@koa/router": "^12.0.0",
+    "@microsoft/api-documenter": "^7.22.32",
+    "@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/koa-bodyparser": "^4.3.10",
+    "@types/koa__router": "^12.0.0",
+    "@typescript-eslint/eslint-plugin": "^5.62.0",
+    "@typescript-eslint/parser": "^5.62.0",
+    "cheerio": "1.0.0-rc.12",
+    "eslint": "^8.46.0",
+    "eslint-config-prettier": "^8.10.0",
+    "eslint-config-standard-with-typescript": "^37.0.0",
+    "eslint-plugin-html": "^7.1.0",
+    "eslint-plugin-import": "^2.28.0",
+    "eslint-plugin-jest": "^27.2.3",
     "eslint-plugin-node": "^11.1.0",
-    "eslint-plugin-promise": "^5.1.0",
-    "jest": "^27.0.6",
-    "koa": "^2.13.1",
-    "koa-bodyparser": "^4.3.0",
-    "lint-staged": "^11.0.1",
-    "markdown-magic": "^2.3.2",
-    "rimraf": "^3.0.2",
-    "rollup": "^2.53.2",
-    "rollup-plugin-typescript2": "^0.30.0",
-    "simple-git-hooks": "^2.5.1",
-    "standard-version": "^9.3.1",
+    "eslint-plugin-promise": "^6.1.1",
+    "jest": "^29.6.2",
+    "koa": "^2.14.2",
+    "koa-bodyparser": "^4.4.1",
+    "lint-staged": "^13.2.3",
+    "markdown-magic": "^2.6.1",
+    "rimraf": "^5.0.1",
+    "rollup": "^3.27.1",
+    "rollup-plugin-typescript2": "^0.35.0",
+    "simple-git-hooks": "^2.9.0",
+    "standard-version": "^9.5.0",
     "ts-expect": "^1.3.0",
-    "ts-jest": "^27.0.3",
-    "typescript": "^4.3.5"
+    "ts-jest": "^29.1.1",
+    "typescript": "^5.1.6"
   },
   "jest": {
     "preset": "ts-jest/presets/js-with-ts",
@@ -108,7 +107,7 @@
   "scripts": {
     "lint": "eslint --ext js,ts .",
     "build:clean": "rimraf lib",
-    "build:code": "rollup -c rollup.config.js",
+    "build:code": "rollup -c rollup.config.mjs",
     "build:api": "api-extractor run --local",
     "build": "pnpm run build:clean && pnpm run lint && pnpm run build:code && pnpm run build:api",
     "test:unit": "jest ./src/*.test.ts ./src/**/*.test.ts",
@@ -119,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 && standard-version --commit-all"
+    "release": "pnpm run test && standard-version --dry-run && pnpm run docs && git add docs CHANGELOG.md && standard-version --commit-all"
   }
 }