redsys-easy 3.1.0 → 4.0.2

package/lib/assets/currencies.d.ts

@@ -1,12 +1,36 @@
+/**
+ * ISO 4217 currency code
+ *
+ * @public
+ */
 export declare type Currency = 'ALL' | 'DZD' | 'ARS' | 'AUD' | 'BSD' | 'BHD' | 'BDT' | 'AMD' | 'BBD' | 'BMD' | 'BTN' | 'BOB' | 'BWP' | 'BZD' | 'SBD' | 'BND' | 'MMK' | 'BIF' | 'KHR' | 'CAD' | 'CVE' | 'KYD' | 'LKR' | 'CLP' | 'CNY' | 'COP' | 'KMF' | 'CRC' | 'HRK' | 'CUP' | 'CZK' | 'DKK' | 'DOP' | 'SVC' | 'ETB' | 'ERN' | 'FKP' | 'FJD' | 'DJF' | 'GMD' | 'GIP' | 'GTQ' | 'GNF' | 'GYD' | 'HTG' | 'HNL' | 'HKD' | 'HUF' | 'ISK' | 'INR' | 'IDR' | 'IRR' | 'IQD' | 'ILS' | 'JMD' | 'JPY' | 'KZT' | 'JOD' | 'KES' | 'KPW' | 'KRW' | 'KWD' | 'KGS' | 'LAK' | 'LBP' | 'LSL' | 'LRD' | 'LYD' | 'MOP' | 'MWK' | 'MYR' | 'MVR' | 'MUR' | 'MXN' | 'MNT' | 'MDL' | 'MAD' | 'OMR' | 'NAD' | 'NPR' | 'ANG' | 'AWG' | 'VUV' | 'NZD' | 'NIO' | 'NGN' | 'NOK' | 'PKR' | 'PAB' | 'PGK' | 'PYG' | 'PEN' | 'PHP' | 'QAR' | 'RUB' | 'RWF' | 'SHP' | 'SAR' | 'SCR' | 'SLL' | 'SGD' | 'VND' | 'SOS' | 'ZAR' | 'SSP' | 'SZL' | 'SEK' | 'CHF' | 'SYP' | 'THB' | 'TOP' | 'TTD' | 'AED' | 'TND' | 'UGX' | 'MKD' | 'EGP' | 'GBP' | 'TZS' | 'USD' | 'UYU' | 'UZS' | 'WST' | 'YER' | 'TWD' | 'TMT' | 'GHS' | 'RSD' | 'MZN' | 'AZN' | 'RON' | 'TRY' | 'XAF' | 'XCD' | 'XOF' | 'XPF' | 'ZMW' | 'SRD' | 'AFN' | 'TJS' | 'AOA' | 'BGN' | 'CDF' | 'BAM' | 'EUR' | 'UAH' | 'GEL' | 'PLN' | 'BRL';
+/**
+ * ISO 4217 currency number
+ *
+ * @public
+ */
+export declare type CurrencyNum = '8' | '12' | '32' | '36' | '44' | '48' | '50' | '51' | '52' | '60' | '64' | '68' | '72' | '84' | '90' | '96' | '104' | '108' | '116' | '124' | '132' | '136' | '144' | '152' | '156' | '170' | '174' | '188' | '191' | '192' | '203' | '208' | '214' | '222' | '230' | '232' | '238' | '242' | '262' | '270' | '292' | '320' | '324' | '328' | '332' | '340' | '344' | '348' | '352' | '356' | '360' | '364' | '368' | '376' | '388' | '392' | '398' | '400' | '404' | '408' | '410' | '414' | '417' | '418' | '422' | '426' | '430' | '434' | '446' | '454' | '458' | '462' | '480' | '484' | '496' | '498' | '504' | '512' | '516' | '524' | '532' | '533' | '548' | '554' | '558' | '566' | '578' | '586' | '590' | '598' | '600' | '604' | '608' | '634' | '643' | '646' | '654' | '682' | '690' | '694' | '702' | '704' | '706' | '710' | '728' | '748' | '752' | '756' | '760' | '764' | '776' | '780' | '784' | '788' | '800' | '807' | '818' | '826' | '834' | '840' | '858' | '860' | '882' | '886' | '901' | '934' | '936' | '941' | '943' | '944' | '946' | '949' | '950' | '951' | '952' | '953' | '967' | '968' | '971' | '972' | '973' | '975' | '976' | '977' | '978' | '980' | '981' | '985' | '986';
 interface CurrencyData {
-    num: string;
+    num: CurrencyNum;
     decimals: number;
 }
+/**
+ * Maps a ISO 4217 code to a ISO 4217 currency number and decimal positions
+ *
+ * @public
+ */
 export declare const CURRENCIES: Record<Currency, CurrencyData>;
 interface RevCurrencyData {
     code: Currency;
     decimals: number;
 }
-declare const REV_CURRENCIES: Record<string, RevCurrencyData>;
+/**
+ * Maps a ISO 4217 number to a ISO 4217 currency code and decimal positions
+ *
+ * @remarks
+ * @see {@link CURRENCIES}
+ *
+ * @public
+ */
+declare const REV_CURRENCIES: Record<CurrencyNum, RevCurrencyData>;
 export { REV_CURRENCIES };

package/lib/assets/lang-codes.d.ts

@@ -1,4 +1,31 @@
+/**
+ * ISO 639-1 language code
+ *
+ * @public
+ */
 export declare type Language = 'es' | 'en' | 'ca' | 'fr' | 'de' | 'nl' | 'it' | 'sv' | 'pt' | 'pl' | 'gl' | 'eu' | 'bg' | 'zh' | 'hr' | 'cs' | 'da' | 'et' | 'fi' | 'el' | 'hu' | 'ja' | 'lv' | 'lt' | 'mt' | 'ro' | 'ru' | 'sk' | 'sl' | 'tr';
-export declare const LANGUAGES: Record<Language, string>;
-declare const REV_LANGUAGES: Record<string, Language>;
+/**
+ * Redsys language code
+ *
+ * @public
+ */
+export declare type LanguageNum = '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' | '10' | '11' | '12' | '13' | '100' | '156' | '191' | '203' | '208' | '233' | '246' | '300' | '348' | '392' | '428' | '440' | '470' | '642' | '643' | '703' | '705' | '792';
+/**
+ * Maps an ISO 639-1 language code to redsys language number
+ *
+ * @remarks
+ * Some ISO 639-1 language codes may include more more than one redsys language number. In such cases the main redsys language number is used.
+ *
+ * @public
+ */
+export declare const LANGUAGES: Record<Language, LanguageNum>;
+/**
+ * Maps a redsys language code to an ISO 639-1 language code
+ *
+ * @remarks
+ * @see {@link LANGUAGES}
+ *
+ * @public
+ */
+declare const REV_LANGUAGES: Record<LanguageNum, Language>;
 export { REV_LANGUAGES };

package/lib/assets/transaction-types.d.ts

@@ -1,21 +1,56 @@
-export declare type TransactionType = '0' | '1' | '2' | '3' | '5' | '6' | '7' | '8' | '9' | 'O' | 'F' | 'P' | 'Q' | 'R' | 'S' | 'A' | '44';
+/**
+ * Transaction type code
+ *
+ * @public
+ */
+export declare type TransactionType = '0' | '1' | '2' | '3' | '5' | '6' | '7' | '8' | '9' | '15' | '17' | '34' | '37' | '44' | 'O' | 'F' | 'P' | 'Q' | 'R' | 'S' | 'A';
+/**
+ * Transaction type enum
+ *
+ * @public
+ */
 export declare const TRANSACTION_TYPES: {
+    /** Autorización */
     readonly AUTHORIZATION: "0";
+    /** Preautorización */
     readonly PRE_AUTHORIZATION: "1";
+    /** Confirmación de preautorización */
     readonly CONFIRMATION: "2";
+    /** Devolución Automática */
     readonly AUTO_REFUND: "3";
+    /** Transacción Recurrente */
     readonly RECURRING_TRANSACTION: "5";
+    /** Transacción Sucesiva */
     readonly SUCCESSIVE_TRANSACTION: "6";
+    /** Pre-autenticación */
     readonly PRE_AUTHENTICATION: "7";
+    /** Confirmación de pre-autenticación */
     readonly PRE_AUTHENTICATION_CONFIRMATION: "8";
+    /** Anulación de Preautorización */
     readonly PRE_AUTHORIZATION_CANCEL: "9";
+    /** Autorización en diferido */
     readonly DEFERRED_AUTHORIZATION: "O";
+    /** Paygold */
+    readonly PAYGOLD: "15";
+    /** Autenticación Puce */
+    readonly PUCE_AUTH: "17";
+    /** Devolución sin original */
+    readonly RETURN_WITHOUT_ORIGINAL: "34";
+    /** Premio de apuestas */
+    readonly BETTING_PAYOUT: "37";
+    /** Eliminar referencia */
+    readonly DELETE_REFERENCE: "44";
+    /** Operaciones sin autenticacíon */
+    readonly NO_AUTHENTICATION: "A";
+    /** Paygold */
     readonly PAYLINK: "F";
+    /** Confirmación de autorización en diferido */
     readonly DEFERRED_AUTHORIZATION_CONFIRMATION: "P";
+    /** Anulación de autorización en diferido */
     readonly DEFERRED_AUTHORIZATION_CANCEL: "Q";
+    /** Cuota inicial diferido */
     readonly DEFERRED_INITIAL_FEE: "R";
+    /** Cuota sucesiva diferido */
     readonly DEFERRED_SUCCESSIVE_FEE: "S";
-    readonly NO_AUTHENTICATION: "A";
-    readonly DELETE_REFERENCE: "44";
 };
 export default TRANSACTION_TYPES;

package/lib/client.d.ts

@@ -0,0 +1,50 @@
+import type { ResponseJSONSuccess, RedirectForm } from './types/api';
+import type { RestIniciaPeticionInputParams, RestTrataPeticionInputParams, RedirectInputParams } from './types/input-params';
+import type { RestIniciaPeticionOutputParams, RestTrataPeticionOutputParams, RestNotificationOutputParams, SoapNotificationOutputParams } from './types/output-params';
+/**
+ * URLs to configure the API
+ *
+ * @public
+ */
+export interface UrlsConfig {
+    redirect: string;
+    restTrataPeticion: string;
+    restIniciaPeticion: string;
+}
+/**
+ * Redsys production urls
+ *
+ * @public
+ */
+export declare const PRODUCTION_URLS: UrlsConfig;
+/**
+ * Redsys sandbox urls
+ *
+ * @public
+ */
+export declare const SANDBOX_URLS: UrlsConfig;
+/**
+ * Redsys API settings
+ *
+ * @public
+ */
+export interface RedsysConfig {
+    secretKey: string;
+    urls: UrlsConfig;
+}
+/**
+ * Creates Redsys API functions
+ *
+ * @remarks
+ * These API functions are anonymous and can be wrapped by formatters and processors
+ *
+ * @public
+ */
+export declare const createRedsysAPI: (config: RedsysConfig) => {
+    restIniciaPeticion: (paramsInput: RestIniciaPeticionInputParams) => Promise<RestIniciaPeticionOutputParams>;
+    restTrataPeticion: (paramsInput: RestTrataPeticionInputParams) => Promise<RestTrataPeticionOutputParams>;
+    createRedirectForm: (paramsInput: RedirectInputParams) => RedirectForm;
+    processRestNotification: (body: ResponseJSONSuccess) => RestNotificationOutputParams;
+    processSoapNotification: (xml: string) => SoapNotificationOutputParams;
+    createSoapNotificationAnswer: (order: string, allow: boolean) => string;
+};

package/lib/crypto.d.ts

@@ -0,0 +1,25 @@
+/// <reference types="node" />
+/**
+ * Adds padding to a buffer.
+ *
+ * Rounds up the buffer length to the next block and uses 0 as padding.
+ *
+ * @params buf - Input buffer
+ * @params blocksize - Size of block
+ */
+export declare const zeroPad: (buf: Buffer, blocksize: number) => Buffer;
+/**
+ * Encrypt a message using 3DES
+ *
+ * @params key - Key to encrypt message
+ * @params message - Message to be encrypted
+ */
+export declare const encrypt3DES: (key: string, message: string) => Buffer;
+/**
+ * Compute HMAC_SHA256_V1 signature
+ *
+ * @params merchantKey - Key to encrypt message
+ * @params order - Order number
+ * @params params - Payload to sign
+ */
+export declare const sha256Sign: (merchantKey: string, order: string, params: string) => string;

package/lib/errors.d.ts

@@ -1,20 +1,75 @@
+/**
+ * Error superclass for all redsys-easy specific errors
+ *
+ * @public
+ */
 export declare class RedsysError extends Error {
     constructor(message: string);
 }
+/**
+ * Invalid input provided
+ *
+ * @public
+ */
 export declare class ValidationError extends RedsysError {
     value: unknown;
-    field: string;
-    constructor(message: string, value: unknown, field: string);
+    parameters: object;
+    constructor(message: string, parameters: object);
 }
+/**
+ * Response cannot be parsed
+ *
+ * @public
+ */
 export declare class ParseError extends RedsysError {
     value: unknown;
-    text: string | undefined;
-    code: string | undefined;
+    location: unknown | undefined;
     description: string | undefined;
-    constructor(message: string, value?: unknown, text?: string);
+    constructor(message: string, value?: unknown, location?: unknown);
+}
+interface HTTPErrorOptions {
+    message?: string;
+    code: number;
+    response?: unknown;
+}
+/**
+ * HTTP Error
+ *
+ * @public
+ */
+export declare class HTTPError extends RedsysError {
+    code: number | undefined;
+    response: unknown | undefined;
+    constructor({ message, code, response }: HTTPErrorOptions);
 }
+interface GatewayErrorOptions {
+    message?: string;
+    code: string;
+    response?: unknown;
+}
+/**
+ * Request could not be processed by Redsys
+ *
+ * @public
+ */
 export declare class GatewayError extends RedsysError {
+    code: string | undefined;
+    response: unknown | undefined;
+    constructor({ message, code, response }: GatewayErrorOptions);
+}
+interface ResponseErrorOptions {
+    message?: string;
+    code: number;
+    response?: unknown;
+}
+/**
+ * Response contained an error code
+ *
+ * @public
+ */
+export declare class ResponseError extends RedsysError {
     code: number | undefined;
     response: unknown | undefined;
-    constructor(message: string, code?: number, response?: unknown);
+    constructor({ message, code, response }: ResponseErrorOptions);
 }
+export {};

package/lib/formatter-utils.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Applies an input formatter to the first argument of a function
+ *
+ * @remarks
+ * The signature of this function is so complex because tries to suport
+ * formatters with generics that provide a default type. This should remain
+ * until [variadic generics](https://github.com/microsoft/TypeScript/issues/5453)
+ * land in typescript
+ *
+ * @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;
+/**
+ * Applies an output formatter to a function
+ *
+ * @public
+ */
+export declare const useOutputFormatter: <A, B, C>(fn: (a: A) => B, outputFormatter: (b: B) => C) => (a: A) => C;
+/**
+ * Applies an output formatter to the resolved ouput promise of a function
+ *
+ * @public
+ */
+export declare const usePromiseOutputFormatter: <A, B, C>(fn: (a: A) => Promise<B>, outputFormatter: (b: B) => C) => (a: A) => Promise<C>;

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

@@ -0,0 +1,21 @@
+import type { RedirectInputParams, RequestInputParams, RestIniciaPeticionInputParams, RestTrataPeticionInputParams } from '../types/input-params';
+import type { RedirectFormatterInput, RequestFormatterInput, RestIniciaPeticionFormatterInput, RestTrataPeticionFormatterInput } from './types';
+/**
+ * Redirection input formatter
+ *
+ * @public
+ */
+export declare const redirectInputFormatter: <RawInputParams extends Partial<RedirectInputParams> = Partial<RedirectInputParams>>(input: RedirectFormatterInput<RawInputParams>) => RedirectInputParams;
+export declare const requestInputFormatter: <RawInputParams extends Partial<RequestInputParams>>(input: RequestFormatterInput<RawInputParams>) => RequestInputParams;
+/**
+ * REST iniciaPeticion input formatter
+ *
+ * @public
+ */
+export declare const restIniciaPeticionInputFormatter: <RawInputParams extends Partial<RestIniciaPeticionInputParams> = Partial<RestIniciaPeticionInputParams>>(raw: RestIniciaPeticionFormatterInput<RawInputParams>) => RestIniciaPeticionInputParams;
+/**
+ * REST trataPeticion input formatter
+ *
+ * @public
+ */
+export declare const restTrataPeticionInputFormatter: <RawInputParams extends Partial<RestTrataPeticionInputParams> = Partial<RestTrataPeticionInputParams>>(raw: RestTrataPeticionFormatterInput<RawInputParams>) => RestTrataPeticionInputParams;

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

@@ -0,0 +1,29 @@
+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'>;
+/**
+ * REST notification formatter
+ *
+ * @public
+ */
+export declare const restNotificationOutputFormatter: <RawOutputParams extends RestNotificationOutputParams = RestNotificationOutputParams>(raw: RawOutputParams) => NotificationFormatterOutput<RawOutputParams>;
+/**
+ * SOAP notification formatter
+ *
+ * @public
+ */
+export declare const soapNotificationOutputFormatter: <RawOutputParams extends SoapNotificationOutputParams = SoapNotificationOutputParams>(raw: RawOutputParams) => NotificationFormatterOutput<RawOutputParams>;
+export declare const requestOutputFormatter: <RawOutputParams extends RequestOutputParams>(raw: RawOutputParams) => RequestFormatterOutput<RawOutputParams>;
+/**
+ * REST iniciaPeticion output formatter
+ *
+ * @public
+ */
+export declare const restIniciaPeticionOutputFormatter: <RawOutputParams extends RestIniciaPeticionOutputParams = RestIniciaPeticionOutputParams>(raw: RawOutputParams) => RestIniciaPeticionFormatterOutput<RawOutputParams>;
+/**
+ * REST trataPeticion output formatter
+ *
+ * @public
+ */
+export declare const restTrataPeticionOutputFormatter: <RawOutputParams extends RestTrataPeticionOutputParams = RestTrataPeticionOutputParams>(raw: RawOutputParams) => RestTrataPeticionFormatterOutput<RawOutputParams>;