redsys-easy 5.0.0 → 5.2.0

package/lib/client.d.ts

@@ -36,36 +36,53 @@ export interface RedsysConfig {
 }
 /**
  * Sends a iniciaPeticion request using REST interface
+ *
+ * @public
  */
 export type RestIniciaPeticion = (paramsInput: RestIniciaPeticionInputParams) => Promise<RestIniciaPeticionOutputParams>;
 /**
  * Sends a trataPeticion request using REST interface
+ *
+ * @public
  */
 export type RestTrataPeticion = (paramsInput: RestTrataPeticionInputParams) => Promise<RestTrataPeticionOutputParams>;
 /**
  * Creates the parameters needed for a redirect form
+ *
+ * @public
  */
 export type CreateRedirectForm = (paramsInput: RedirectInputParams) => RedirectForm;
 /**
  * Processes a JSON REST notification
+ *
+ * @public
  */
 export type ProcessRestNotification = (
 /** Body of JSON notification, as a POJO (Plain Old Javascript Object) */
 body: ResponseJSONSuccess) => RestNotificationOutputParams;
 /**
  * Parses and verifies the body of a SOAP notification
+ *
+ * @public
  */
 export type ProcessSoapNotification = (
 /** SOAP notification as a XML string */
 xml: string) => SoapNotificationOutputParams;
 /**
  * Creates an answer for a SOAP notification, serializes and signs it
+ *
+ * @public
  */
 export type CreateSoapNotificationAnswer = (
 /** Order identifier */
 order: string, 
 /** Indicates if the payment is allowed to proceed */
 allow: boolean) => string;
+/**
+ * Redsys API
+ *
+ * @public
+ */
 export interface RedsysAPI {
     restIniciaPeticion: RestIniciaPeticion;
     restTrataPeticion: RestTrataPeticion;

package/lib/errors.d.ts

@@ -25,12 +25,12 @@ export declare class ParseError extends RedsysError {
     value: unknown;
     location: unknown | undefined;
     description: string | undefined;
-    constructor(message: string, value?: unknown, location?: unknown);
+    constructor(message: string, value?: unknown | undefined, location?: unknown | undefined);
 }
 interface HTTPErrorOptions {
-    message?: string;
+    message?: string | undefined;
     code: number;
-    response?: unknown;
+    response?: unknown | undefined;
 }
 /**
  * HTTP Error
@@ -43,9 +43,9 @@ export declare class HTTPError extends RedsysError {
     constructor({ message, code, response }: HTTPErrorOptions);
 }
 interface GatewayErrorOptions {
-    message?: string;
+    message?: string | undefined;
     code: string;
-    response?: unknown;
+    response?: unknown | undefined;
 }
 /**
  * Request could not be processed by Redsys
@@ -58,9 +58,9 @@ export declare class GatewayError extends RedsysError {
     constructor({ message, code, response }: GatewayErrorOptions);
 }
 interface ResponseErrorOptions {
-    message?: string;
+    message?: string | undefined;
     code: number;
-    response?: unknown;
+    response?: unknown | undefined;
 }
 /**
  * Response contained an error code

package/lib/formatters/types.d.ts

@@ -31,77 +31,77 @@ export interface BaseFormatterInput<RawInputParams extends Partial<BaseInputPara
      * @remarks
      * @see {@link RestTrataPeticionInputParams.DS_MERCHANT_AMOUNT}
      */
-    amount?: string;
+    amount?: string | undefined;
     /**
      * @see {@link RestTrataPeticionInputParams.DS_MERCHANT_CURRENCY}
      */
-    currency?: Currency;
+    currency?: Currency | undefined;
     /**
      * @see {@link RestTrataPeticionInputParams.DS_MERCHANT_PAN}
      */
-    pan?: string;
+    pan?: string | undefined;
     /**
      * Card expiry year, YY
      *
      * @remarks
      * @see {@link RestTrataPeticionInputParams.DS_MERCHANT_EXPIRYDATE}
      */
-    expiryYear?: string;
+    expiryYear?: string | undefined;
     /**
      * Card expiry month, MM
      *
      * @remarks
      * @see {@link RestTrataPeticionInputParams.DS_MERCHANT_EXPIRYDATE}
      */
-    expiryMonth?: string;
+    expiryMonth?: string | undefined;
     /**
      * @see {@link RestTrataPeticionInputParams.DS_MERCHANT_CVV2}
      */
-    cvv?: string;
+    cvv?: string | undefined;
     /**
      * @see {@link RestTrataPeticionInputParams.DS_MERCHANT_MERCHANTNAME}
      */
-    merchantName?: string;
+    merchantName?: string | undefined;
     /**
      * @see {@link RestTrataPeticionInputParams.DS_MERCHANT_IDENTIFIER}
      */
-    identifier?: string;
+    identifier?: string | undefined;
     /**
      * @see {@link RestTrataPeticionInputParams.DS_MERCHANT_GROUP}
      */
-    group?: string;
+    group?: string | undefined;
     /**
      * @see {@link RestTrataPeticionInputParams.DS_MERCHANT_DIRECTPAYMENT}
      */
-    directPayment?: BaseInputParams['DS_MERCHANT_DIRECTPAYMENT'];
+    directPayment?: BaseInputParams['DS_MERCHANT_DIRECTPAYMENT'] | undefined;
     /**
      * @see {@link RestTrataPeticionInputParams.DS_MERCHANT_MERCHANTDATA}
      */
-    merchantData?: string;
+    merchantData?: string | undefined;
     /**
      * @see {@link RestTrataPeticionInputParams.DS_MERCHANT_IDOPER}
      */
-    operationId?: string;
+    operationId?: string | undefined;
     /**
      * @see {@link RestTrataPeticionInputParams.DS_MERCHANT_PRODUCTDESCRIPTION}
      */
-    productDescription?: string;
+    productDescription?: string | undefined;
     /**
      * @see {@link RestTrataPeticionInputParams.DS_MERCHANT_TAX_REFERENCE}
      */
-    taxReference?: string;
+    taxReference?: string | undefined;
     /**
      * @see {@link RestTrataPeticionInputParams.DS_MERCHANT_TRANSACTIONDATE}
      */
-    transactionDate?: string;
+    transactionDate?: string | undefined;
     /**
      * @see {@link RestTrataPeticionInputParams.DS_MERCHANT_TITULAR}
      */
-    cardHolder?: string;
+    cardHolder?: string | undefined;
     /**
      * @see {@link RestTrataPeticionInputParams}
      */
-    raw?: RawInputParams;
+    raw?: RawInputParams | undefined;
 }
 /**
  * Input parameters for the redirect input formatter
@@ -112,37 +112,37 @@ export interface RedirectFormatterInput<RawInputParams extends Partial<RedirectI
     /**
      * @see {@link RedirectInputParams.DS_MERCHANT_MERCHANTURL}
      */
-    merchantURL?: string;
+    merchantURL?: string | undefined;
     /**
      * @see {@link RedirectInputParams.DS_MERCHANT_URLOK}
      */
-    successURL?: string;
+    successURL?: string | undefined;
     /**
      * @see {@link RedirectInputParams.DS_MERCHANT_URLKO}
      */
-    errorURL?: string;
+    errorURL?: string | undefined;
     /**
      * @see {@link RedirectInputParams.DS_MERCHANT_PAYMETHODS}
      */
-    payMethods?: string;
+    payMethods?: string | undefined;
     /**
      * @see {@link RedirectInputParams.DS_MERCHANT_CONSUMERLANGUAGE}
      */
-    lang?: Language;
+    lang?: Language | undefined;
 }
 export interface RequestFormatterInput<RawInputParams extends Partial<RequestInputParams>> extends BaseFormatterInput<RawInputParams> {
     /**
      * @see {@link RestTrataPeticionInputParams.DS_MERCHANT_CUSTOMER_MOBILE}
      */
-    customerMobile?: string;
+    customerMobile?: string | undefined;
     /**
      * @see {@link RestTrataPeticionInputParams.DS_MERCHANT_CUSTOMER_MAIL}
      */
-    customerMail?: string;
+    customerMail?: string | undefined;
     /**
      * @see {@link RestTrataPeticionInputParams.DS_MERCHANT_CUSTOMER_SMS_TEXT}
      */
-    smsTemplate?: string;
+    smsTemplate?: string | undefined;
 }
 /**
  * Input parameters for the REST iniciaPeticion input formatter
@@ -153,7 +153,7 @@ export interface RestIniciaPeticionFormatterInput<RawInputParams extends Partial
     /**
      * @see {@link RestIniciaPeticionInputParams.DS_MERCHANT_EMV3DS}
      */
-    emv3ds?: RestIniciaPeticionInputParams['DS_MERCHANT_EMV3DS'];
+    emv3ds?: RestIniciaPeticionInputParams['DS_MERCHANT_EMV3DS'] | undefined;
 }
 /**
  * Input parameters for the REST trataPeticion input formatter
@@ -164,7 +164,7 @@ export interface RestTrataPeticionFormatterInput<RawInputParams extends Partial<
     /**
      * @see {@link RestTrataPeticionInputParams.DS_MERCHANT_EMV3DS}
      */
-    emv3ds?: RestTrataPeticionInputParams['DS_MERCHANT_EMV3DS'];
+    emv3ds?: RestTrataPeticionInputParams['DS_MERCHANT_EMV3DS'] | undefined;
 }
 export interface BaseFormatterOutput<RawOutputParams extends BaseOutputParams> {
     /**

package/lib/index.esm.js

@@ -1779,6 +1779,18 @@ class RedsysError extends Error {
 class ValidationError extends RedsysError {
     constructor(message, parameters) {
         super(message);
+        Object.defineProperty(this, "value", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "parameters", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
         this.name = 'RedsysValidationError';
         this.parameters = parameters;
     }
@@ -1791,6 +1803,24 @@ class ValidationError extends RedsysError {
 class ParseError extends RedsysError {
     constructor(message, value, location) {
         super(message);
+        Object.defineProperty(this, "value", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "location", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "description", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
         this.name = 'RedsysParseError';
         this.value = value;
         this.location = location;
@@ -1810,6 +1840,18 @@ class HTTPError extends RedsysError {
         const augmentationLine = message != null && message ? `\n${message}` : '';
         const augmentedMessage = `HTTP error${codeInfo}${augmentationLine}`;
         super(augmentedMessage);
+        Object.defineProperty(this, "code", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "response", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
         this.name = 'RedsysHTTPError';
         this.code = code;
         this.response = response;
@@ -1829,6 +1871,18 @@ class GatewayError extends RedsysError {
         const augmentationLine = message != null && message ? `\n${message}` : '';
         const augmentedMessage = `Gateway error${codeInfo}${augmentationLine}`;
         super(augmentedMessage);
+        Object.defineProperty(this, "code", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "response", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
         this.name = 'RedsysGatewayError';
         this.code = code;
         this.response = response;
@@ -1848,6 +1902,18 @@ class ResponseError extends RedsysError {
         const augmentationLine = message != null && message ? `\n${message}` : '';
         const augmentedMessage = `Response error${codeInfo}${augmentationLine}`;
         super(augmentedMessage);
+        Object.defineProperty(this, "code", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "response", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
         this.name = 'RedsysResponseError';
         this.code = code;
         this.response = response;
@@ -2015,6 +2081,16 @@ const assertSuccessfulResponse = (responseParams) => {
     }
 };
 const isStringNotEmpty = (str) => str != null && str.length > 0;
+/**
+ * Map over maybe monad
+ *
+ * If value is defined apply function and return output, otherwise return undefined.
+ */
+const mapMaybeMonad = (value, fn) => {
+    return value !== undefined
+        ? fn(value)
+        : undefined;
+};
 
 const sha256VerifyJSONResponse = (merchantKey, response, responseParams) => {
     if (response.Ds_SignatureVersion !== 'HMAC_SHA256_V1') {
@@ -3292,10 +3368,10 @@ const baseOutputFormatter = (raw) => {
             ? { securePayment: rawSecurePayment === '1' || rawSecurePayment === '2' }
             : undefined),
         ...(isStringNotEmpty(rawCardCountry)
-            ? { cardCountry: formatCountry(rawCardCountry) }
+            ? mapMaybeMonad(formatCountry(rawCardCountry), cardCountry => ({ cardCountry }))
             : undefined),
         ...(isStringNotEmpty(rawCardBrand)
-            ? { cardBrand: formatCardBrand(rawCardBrand) }
+            ? mapMaybeMonad(formatCardBrand(rawCardBrand), cardBrand => ({ cardBrand }))
             : undefined),
         ...(isStringNotEmpty(rawCardPSD2)
             ? { cardPSD2: rawCardPSD2 === 'Y' }
@@ -3333,7 +3409,7 @@ const notificationOutputFormatter = (raw) => {
         ...formatPrice(raw),
         response: formatResponse(rawResponse),
         ...(isStringNotEmpty(rawConsumerLanguage)
-            ? { lang: formatLang(rawConsumerLanguage) }
+            ? mapMaybeMonad(formatLang(rawConsumerLanguage), lang => ({ lang }))
             : undefined)
     };
 };
@@ -3385,7 +3461,9 @@ const requestOutputFormatter = (raw) => {
                 expiryMonth: rawExpiryDate.slice(2, 4)
             }
             : undefined),
-        ...(isStringNotEmpty(rawLang) ? { lang: formatLang(rawLang) } : undefined)
+        ...(isStringNotEmpty(rawLang)
+            ? mapMaybeMonad(formatLang(rawLang), lang => ({ lang }))
+            : undefined)
     };
 };
 /**

package/lib/index.js

@@ -1781,6 +1781,18 @@ class RedsysError extends Error {
 class ValidationError extends RedsysError {
     constructor(message, parameters) {
         super(message);
+        Object.defineProperty(this, "value", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "parameters", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
         this.name = 'RedsysValidationError';
         this.parameters = parameters;
     }
@@ -1793,6 +1805,24 @@ class ValidationError extends RedsysError {
 class ParseError extends RedsysError {
     constructor(message, value, location) {
         super(message);
+        Object.defineProperty(this, "value", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "location", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "description", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
         this.name = 'RedsysParseError';
         this.value = value;
         this.location = location;
@@ -1812,6 +1842,18 @@ class HTTPError extends RedsysError {
         const augmentationLine = message != null && message ? `\n${message}` : '';
         const augmentedMessage = `HTTP error${codeInfo}${augmentationLine}`;
         super(augmentedMessage);
+        Object.defineProperty(this, "code", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "response", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
         this.name = 'RedsysHTTPError';
         this.code = code;
         this.response = response;
@@ -1831,6 +1873,18 @@ class GatewayError extends RedsysError {
         const augmentationLine = message != null && message ? `\n${message}` : '';
         const augmentedMessage = `Gateway error${codeInfo}${augmentationLine}`;
         super(augmentedMessage);
+        Object.defineProperty(this, "code", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "response", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
         this.name = 'RedsysGatewayError';
         this.code = code;
         this.response = response;
@@ -1850,6 +1904,18 @@ class ResponseError extends RedsysError {
         const augmentationLine = message != null && message ? `\n${message}` : '';
         const augmentedMessage = `Response error${codeInfo}${augmentationLine}`;
         super(augmentedMessage);
+        Object.defineProperty(this, "code", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "response", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
         this.name = 'RedsysResponseError';
         this.code = code;
         this.response = response;
@@ -2017,6 +2083,16 @@ const assertSuccessfulResponse = (responseParams) => {
     }
 };
 const isStringNotEmpty = (str) => str != null && str.length > 0;
+/**
+ * Map over maybe monad
+ *
+ * If value is defined apply function and return output, otherwise return undefined.
+ */
+const mapMaybeMonad = (value, fn) => {
+    return value !== undefined
+        ? fn(value)
+        : undefined;
+};
 
 const sha256VerifyJSONResponse = (merchantKey, response, responseParams) => {
     if (response.Ds_SignatureVersion !== 'HMAC_SHA256_V1') {
@@ -3294,10 +3370,10 @@ const baseOutputFormatter = (raw) => {
             ? { securePayment: rawSecurePayment === '1' || rawSecurePayment === '2' }
             : undefined),
         ...(isStringNotEmpty(rawCardCountry)
-            ? { cardCountry: formatCountry(rawCardCountry) }
+            ? mapMaybeMonad(formatCountry(rawCardCountry), cardCountry => ({ cardCountry }))
             : undefined),
         ...(isStringNotEmpty(rawCardBrand)
-            ? { cardBrand: formatCardBrand(rawCardBrand) }
+            ? mapMaybeMonad(formatCardBrand(rawCardBrand), cardBrand => ({ cardBrand }))
             : undefined),
         ...(isStringNotEmpty(rawCardPSD2)
             ? { cardPSD2: rawCardPSD2 === 'Y' }
@@ -3335,7 +3411,7 @@ const notificationOutputFormatter = (raw) => {
         ...formatPrice(raw),
         response: formatResponse(rawResponse),
         ...(isStringNotEmpty(rawConsumerLanguage)
-            ? { lang: formatLang(rawConsumerLanguage) }
+            ? mapMaybeMonad(formatLang(rawConsumerLanguage), lang => ({ lang }))
             : undefined)
     };
 };
@@ -3387,7 +3463,9 @@ const requestOutputFormatter = (raw) => {
                 expiryMonth: rawExpiryDate.slice(2, 4)
             }
             : undefined),
-        ...(isStringNotEmpty(rawLang) ? { lang: formatLang(rawLang) } : undefined)
+        ...(isStringNotEmpty(rawLang)
+            ? mapMaybeMonad(formatLang(rawLang), lang => ({ lang }))
+            : undefined)
     };
 };
 /**

package/lib/soap/utils.d.ts

@@ -2,9 +2,9 @@ export declare const unescapeXML: (str: string) => string;
 export declare const escapeXML: (str: string) => string;
 type SoapRequest = {
     headers: Record<string, string>;
-    body?: string;
+    body?: string | undefined;
 } | {
-    headers?: Record<string, string>;
+    headers?: Record<string, string> | undefined;
     body: string;
 };
 /**

package/lib/types/3ds-params.d.ts

@@ -14,11 +14,11 @@ export interface ThreeDSRequestorAuthenticationInfo {
 }
 export interface ThreeDSRequestorPriorAuthenticationInfo {
     /** Reference */
-    threeDSReqPriorRef?: string;
+    threeDSReqPriorRef?: string | undefined;
     /** Authentication method code */
-    threeDSReqPriorAuthMethod?: string;
+    threeDSReqPriorAuthMethod?: string | undefined;
     /** Authentication timestamp, yyyymmddHHMM */
-    threeDSReqPriorAuthTimestamp?: string;
+    threeDSReqPriorAuthTimestamp?: string | undefined;
 }
 export interface BaseThreeDSAuthenticationDataParams {
     /** 3DSecure protocol version */
@@ -80,117 +80,117 @@ export interface BaseThreeDSAuthenticationDataParams {
     /** Browser Accept Header */
     browserAcceptHeader: string;
     /** Browser IP Address, ipv4 or ipv6 */
-    browserIP?: string;
+    browserIP?: string | undefined;
     /** Additional account information, max 64 characters */
-    acctID?: string;
+    acctID?: string | undefined;
     /** Account information, json */
     acctInfo?: {
         /** Account creation ellapsed time code */
-        chAccAgeInd?: '01' | '02' | '03' | '04' | '05';
+        chAccAgeInd?: '01' | '02' | '03' | '04' | '05' | undefined;
         /** Account modification date, yyyymmdd */
-        chAccChange?: string;
+        chAccChange?: string | undefined;
         /** Account modification ellapsed time code */
-        chAccChangeInd?: '01' | '02' | '03' | '04';
+        chAccChangeInd?: '01' | '02' | '03' | '04' | undefined;
         /** Account creation date, yyyymmdd */
-        chAccDate?: string;
+        chAccDate?: string | undefined;
         /** Last password change date, yyyymmdd */
-        chAccPwChange?: string;
+        chAccPwChange?: string | undefined;
         /** Password change ellapsed time code */
-        chAccPwChangeInd?: '01' | '02' | '03' | '04' | '05';
+        chAccPwChangeInd?: '01' | '02' | '03' | '04' | '05' | undefined;
         /** Number of purchases during the last 6 months */
-        nbPurchaseAccount?: string;
+        nbPurchaseAccount?: string | undefined;
         /** Attemps to add a card during the last 24 hours */
-        provisionAttemptsDay?: string;
+        provisionAttemptsDay?: string | undefined;
         /** Number of transactions attempted during the last 24 hours */
-        txnActivityDay?: string;
+        txnActivityDay?: string | undefined;
         /** Number of transactions attempted last year */
-        txnActivityYear?: string;
+        txnActivityYear?: string | undefined;
         /** Card registration date, yyyymmdd */
-        paymentAccAge?: string;
+        paymentAccAge?: string | undefined;
         /** Card registration ellapsed time code */
-        paymentAccInd?: '01' | '02' | '03' | '04' | '05';
+        paymentAccInd?: '01' | '02' | '03' | '04' | '05' | undefined;
         /** First usage of shipping address date, yyyymmdd */
-        shipAddressUsage?: string;
+        shipAddressUsage?: string | undefined;
         /** First usage of shipping address ellapsed time code */
-        shipAddressUsageInd?: '01' | '02' | '03' | '04' | '05';
+        shipAddressUsageInd?: '01' | '02' | '03' | '04' | '05' | undefined;
         /** Cardholder shipping name indicator code */
-        shipNameIndicator?: '01' | '02';
+        shipNameIndicator?: '01' | '02' | undefined;
         /** Suspicious activity code */
-        suspiciousAccActivity?: '01' | '02';
-    };
+        suspiciousAccActivity?: '01' | '02' | undefined;
+    } | undefined;
     /** Matching shipping and billing addresses indicator */
-    addrMatch?: 'Y' | 'N';
+    addrMatch?: 'Y' | 'N' | undefined;
     /** Billing address city */
-    billAddrCity?: string;
+    billAddrCity?: string | undefined;
     /** Billing address line 1 */
-    billAddrLine1?: string;
+    billAddrLine1?: string | undefined;
     /** Billing address line 2 */
-    billAddrLine2?: string;
+    billAddrLine2?: string | undefined;
     /** Billing address line 3 */
-    billAddrLine3?: string;
+    billAddrLine3?: string | undefined;
     /** Billing address postal code */
-    billAddrPostCode?: string;
+    billAddrPostCode?: string | undefined;
     /** Billing address state code, ISO 3166-2 */
-    billAddrState?: string;
+    billAddrState?: string | undefined;
     /** Billing address country code, ISO 3166-1 */
-    billAddrCountry?: string;
+    billAddrCountry?: string | undefined;
     /** Cardholder name */
-    cardholderName?: string;
+    cardholderName?: string | undefined;
     /** Challenge window size */
-    challengeWindowSize?: string;
+    challengeWindowSize?: string | undefined;
     /** Account email address */
-    email?: string;
+    email?: string | undefined;
     /** Account landline phone number */
-    homePhone?: ThreeDSPhone;
+    homePhone?: ThreeDSPhone | undefined;
     /** Account mobile phone number */
-    mobilePhone?: ThreeDSPhone;
+    mobilePhone?: ThreeDSPhone | undefined;
     /** Account work phone number */
-    workPhone?: ThreeDSPhone;
+    workPhone?: ThreeDSPhone | undefined;
     /** Merchant risk indicator, json */
     merchantRiskIndicator?: {
         /** Delivery email address */
-        deliveryEmailAddress?: string;
+        deliveryEmailAddress?: string | undefined;
         /** Delivery time code */
-        deliveryTimeframe?: '01' | '02' | '03' | '04';
+        deliveryTimeframe?: '01' | '02' | '03' | '04' | undefined;
         /** Gift card amount */
-        giftCardAmount?: string;
+        giftCardAmount?: string | undefined;
         /** Count of gift cards used */
-        giftCardCount?: string;
+        giftCardCount?: string | undefined;
         /** Gift card currency number, ISO-4217 */
-        giftCardCurr?: string;
+        giftCardCurr?: string | undefined;
         /** Preorder availability date, yyyymmdd */
-        preOrderDate?: string;
+        preOrderDate?: string | undefined;
         /** Preorder availability indicator code */
-        preOrderPurchaseInd?: '01' | '02';
+        preOrderPurchaseInd?: '01' | '02' | undefined;
         /** Reorder indicator code */
-        reorderItemsInd?: '01' | '02';
+        reorderItemsInd?: '01' | '02' | undefined;
         /** Shipping indicator code */
-        shipIndicator?: '01' | '02' | '03' | '04' | '05' | '06' | '07';
-    };
+        shipIndicator?: '01' | '02' | '03' | '04' | '05' | '06' | '07' | undefined;
+    } | undefined;
     /** Number of purchase installments */
-    purchaseInstalData?: string;
+    purchaseInstalData?: string | undefined;
     /** Recurring payments expiration date, yyyymmdd */
-    recurringExpiry?: string;
+    recurringExpiry?: string | undefined;
     /** Minimum number of days between recurring payments */
-    recurringFrequency?: string;
+    recurringFrequency?: string | undefined;
     /** Shipping address city */
-    shipAddrCity?: string;
+    shipAddrCity?: string | undefined;
     /** Shipping address line 1 */
-    shipAddrLine1?: string;
+    shipAddrLine1?: string | undefined;
     /** Shipping address line 2 */
-    shipAddrLine2?: string;
+    shipAddrLine2?: string | undefined;
     /** Shipping address line 3 */
-    shipAddrLine3?: string;
+    shipAddrLine3?: string | undefined;
     /** Shipping address postal code */
-    shipAddrPostCode?: string;
+    shipAddrPostCode?: string | undefined;
     /** Shipping address state code, ISO 3166-2 */
-    shipAddrState?: string;
+    shipAddrState?: string | undefined;
     /** Shipping address country code, ISO 3166-1 */
-    shipAddrCountry?: string;
+    shipAddrCountry?: string | undefined;
     /** Authentication information, json */
-    threeDSRequestorAuthenticationInfo?: ThreeDSRequestorAuthenticationInfo;
+    threeDSRequestorAuthenticationInfo?: ThreeDSRequestorAuthenticationInfo | undefined;
     /** Previous authentication information, json */
-    threeDSRequestorPriorAuthenticationInfo?: ThreeDSRequestorPriorAuthenticationInfo;
+    threeDSRequestorPriorAuthenticationInfo?: ThreeDSRequestorPriorAuthenticationInfo | undefined;
 }
 /**
  * Browser information required by 3DS

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

@@ -15,52 +15,52 @@ export interface BaseInputParams {
     /** Terminal number */
     DS_MERCHANT_TERMINAL: string;
     /** Stored payment method reference number */
-    DS_MERCHANT_IDENTIFIER?: string;
+    DS_MERCHANT_IDENTIFIER?: string | undefined;
     /** Merchant group number */
-    DS_MERCHANT_GROUP?: string;
+    DS_MERCHANT_GROUP?: string | undefined;
     /**
      * Amount designated as an integer in the smallest currency division
      *
      * @example
      * `'199'` (1.99 EUR)
      */
-    DS_MERCHANT_AMOUNT?: string;
+    DS_MERCHANT_AMOUNT?: string | undefined;
     /** Currency number, ISO-4217 */
-    DS_MERCHANT_CURRENCY?: CurrencyNum;
+    DS_MERCHANT_CURRENCY?: CurrencyNum | undefined;
     /** Card PAN, number */
-    DS_MERCHANT_PAN?: string;
+    DS_MERCHANT_PAN?: string | undefined;
     /** Card expiry date, YYMM */
-    DS_MERCHANT_EXPIRYDATE?: string;
+    DS_MERCHANT_EXPIRYDATE?: string | undefined;
     /** Card CVV2 code */
-    DS_MERCHANT_CVV2?: string;
+    DS_MERCHANT_CVV2?: string | undefined;
     /** PDS2 exemptions */
-    DS_MERCHANT_EXCEP_SCA?: string;
+    DS_MERCHANT_EXCEP_SCA?: string | undefined;
     /** Merchant data */
-    DS_MERCHANT_MERCHANTDATA?: string;
+    DS_MERCHANT_MERCHANTDATA?: string | undefined;
     /** Merchant name */
-    DS_MERCHANT_MERCHANTNAME?: string;
+    DS_MERCHANT_MERCHANTNAME?: string | undefined;
     /** Product description */
-    DS_MERCHANT_PRODUCTDESCRIPTION?: string;
+    DS_MERCHANT_PRODUCTDESCRIPTION?: string | undefined;
     /** Cardholder name and surname */
-    DS_MERCHANT_TITULAR?: string;
+    DS_MERCHANT_TITULAR?: string | undefined;
     /** Authorization transaction code, refunds */
-    DS_MERCHANT_AUTHORISATIONCODE?: string;
+    DS_MERCHANT_AUTHORISATIONCODE?: string | undefined;
     /** Transaction date, YYYY-MM-DD */
-    DS_MERCHANT_TRANSACTIONDATE?: string;
+    DS_MERCHANT_TRANSACTIONDATE?: string | undefined;
     /** Direct payment */
-    DS_MERCHANT_DIRECTPAYMENT?: 'true' | 'moto';
+    DS_MERCHANT_DIRECTPAYMENT?: 'true' | 'moto' | undefined;
     /** INSITE operation identifier */
-    DS_MERCHANT_IDOPER?: string;
+    DS_MERCHANT_IDOPER?: string | undefined;
     /** Tax code number */
-    DS_MERCHANT_TAX_REFERENCE?: string;
+    DS_MERCHANT_TAX_REFERENCE?: string | undefined;
     /** Online Travel Agency indicator */
-    DS_MERCHANT_OTA?: 'S';
+    DS_MERCHANT_OTA?: 'S' | undefined;
     /** Initial Credential On File transaction indicator */
-    DS_MERCHANT_COF_INI?: 'S' | 'N';
+    DS_MERCHANT_COF_INI?: 'S' | 'N' | undefined;
     /** Credential On File transaction identifier */
-    DS_MERCHANT_COF_TXNID?: string;
+    DS_MERCHANT_COF_TXNID?: string | undefined;
     /** Credential On File transaction type */
-    DS_MERCHANT_COF_TYPE?: 'I' | 'R' | 'H' | 'E' | 'D' | 'M' | 'N' | 'C';
+    DS_MERCHANT_COF_TYPE?: 'I' | 'R' | 'H' | 'E' | 'D' | 'M' | 'N' | 'C' | undefined;
 }
 /**
  * Input parameters for a redsys redirect request
@@ -69,21 +69,21 @@ export interface BaseInputParams {
  */
 export interface RedirectInputParams extends BaseInputParams {
     /** EMV3DS data in json format */
-    DS_MERCHANT_EMV3DS?: ThreeDSRedirectInputParams;
+    DS_MERCHANT_EMV3DS?: ThreeDSRedirectInputParams | undefined;
     /** Notification url */
-    DS_MERCHANT_MERCHANTURL?: string;
+    DS_MERCHANT_MERCHANTURL?: string | undefined;
     /** Success redirection url */
-    DS_MERCHANT_URLOK?: string;
+    DS_MERCHANT_URLOK?: string | undefined;
     /** Failure redirection url */
-    DS_MERCHANT_URLKO?: string;
+    DS_MERCHANT_URLKO?: string | undefined;
     /** Language */
-    DS_MERCHANT_CONSUMERLANGUAGE?: LanguageNum;
+    DS_MERCHANT_CONSUMERLANGUAGE?: LanguageNum | undefined;
     /** Payment methods */
-    DS_MERCHANT_PAYMETHODS?: string;
+    DS_MERCHANT_PAYMETHODS?: string | undefined;
     /** Customization code number */
-    DS_MERCHANT_PERSOCODE?: string;
+    DS_MERCHANT_PERSOCODE?: string | undefined;
     /** Obtain paypal address */
-    DS_MERCHANT_SHIPPINGADDRESSPYP?: 'S' | 'N';
+    DS_MERCHANT_SHIPPINGADDRESSPYP?: 'S' | 'N' | undefined;
 }
 /**
  * Common input parameters for redsys request
@@ -92,33 +92,33 @@ export interface RedirectInputParams extends BaseInputParams {
  */
 export interface RequestInputParams extends BaseInputParams {
     /** xPay data, hex */
-    DS_XPAYDATA?: string;
+    DS_XPAYDATA?: string | undefined;
     /** xPay origin */
-    DS_XPAYORIGEN?: 'Google' | 'Apple';
+    DS_XPAYORIGEN?: 'Google' | 'Apple' | undefined;
     /** xPay type */
-    DS_XPAYTYPE?: 'WEB' | 'InApp';
+    DS_XPAYTYPE?: 'WEB' | 'InApp' | undefined;
     /** PUC identifier, number */
-    DS_ACQUIRER_IDENTIFIER?: string;
+    DS_ACQUIRER_IDENTIFIER?: string | undefined;
     /** Matching data */
-    DS_MERCHANT_MATCHINGDATA?: string;
+    DS_MERCHANT_MATCHINGDATA?: string | undefined;
     /** Customer phone, paygold */
-    DS_MERCHANT_CUSTOMER_MOBILE?: string;
+    DS_MERCHANT_CUSTOMER_MOBILE?: string | undefined;
     /** Customer email address, paygold */
-    DS_MERCHANT_CUSTOMER_MAIL?: string;
+    DS_MERCHANT_CUSTOMER_MAIL?: string | undefined;
     /** Expiration date for paygold links, YYYY-MM-DD-hh:mm:ss.sss or number of minutes */
-    DS_MERCHANT_P2F_EXPIRYDATE?: string;
+    DS_MERCHANT_P2F_EXPIRYDATE?: string | undefined;
     /**
      * SMS text content, paygold
      *
      * Parameters: @URL@, @COMERCIO@, @IMPORTE@ and @MONEDA@
      */
-    DS_MERCHANT_CUSTOMER_SMS_TEXT?: string;
+    DS_MERCHANT_CUSTOMER_SMS_TEXT?: string | undefined;
     /**
      * Email text content, paygold
      *
      * Parameters: nombreComprador, direccionComprador and textoLibre1.
      */
-    DS_MERCHANT_P2F_XMLDATA?: string;
+    DS_MERCHANT_P2F_XMLDATA?: string | undefined;
 }
 export interface CommonRestInputParams extends RequestInputParams {
     /** MPI External parameters, json */
@@ -145,7 +145,7 @@ export interface CommonRestInputParams extends RequestInputParams {
         authenticationType: string;
         /** Authentication flow */
         authenticationFlow: 'F' | 'C';
-    };
+    } | undefined;
 }
 /**
  * Input parameters for a IniciaPeticion HTTP request
@@ -154,9 +154,9 @@ export interface CommonRestInputParams extends RequestInputParams {
  */
 export interface RestIniciaPeticionInputParams extends CommonRestInputParams {
     /** EMV3DS data in json format */
-    DS_MERCHANT_EMV3DS?: ThreeDSPreAuthInputParams;
+    DS_MERCHANT_EMV3DS?: ThreeDSPreAuthInputParams | undefined;
     /** Dynamic Currency Conversion data, json */
-    DS_MERCHANT_DCC?: 'Y' | 'N';
+    DS_MERCHANT_DCC?: 'Y' | 'N' | undefined;
 }
 /**
  * Input parameters for a TrataPeticion Peticion HTTP request
@@ -165,12 +165,12 @@ export interface RestIniciaPeticionInputParams extends CommonRestInputParams {
  */
 export interface RestTrataPeticionInputParams extends CommonRestInputParams {
     /** EMV3DS data in json format */
-    DS_MERCHANT_EMV3DS?: ThreeDSv1AuthDataInputParams | ThreeDSv2AuthDataInputParams | ThreeDSv1ChallengeResponseInputParams | ThreeDSv2ChallengeResponseInputParams;
+    DS_MERCHANT_EMV3DS?: ThreeDSv1AuthDataInputParams | ThreeDSv2AuthDataInputParams | ThreeDSv1ChallengeResponseInputParams | ThreeDSv2ChallengeResponseInputParams | undefined;
     /** Dynamic Currency Conversion data, json */
     DS_MERCHANT_DCC?: {
         /** Card currency number, ISO-4217 */
         monedaDCC: string;
         /** Amount in card currency, decimal number */
         importeDCC: string;
-    };
+    } | undefined;
 }

package/lib/utils/misc.d.ts

@@ -25,6 +25,12 @@ export declare const assertSuccessfulResponseCode: (responseCode: string | numbe
  * @public
  */
 export declare const assertSuccessfulResponse: (responseParams: {
-    Ds_Response?: string;
+    Ds_Response?: string | undefined;
 }) => void;
 export declare const isStringNotEmpty: <T extends string>(str: T | undefined) => str is T;
+/**
+ * Map over maybe monad
+ *
+ * If value is defined apply function and return output, otherwise return undefined.
+ */
+export declare const mapMaybeMonad: <V, Out>(value: V | undefined, fn: (value: V) => Out) => Out | undefined;

package/package.json

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