redsys-easy 3.1.0 → 4.0.2

package/README.md

@@ -1,7 +1,7 @@
 Redsys Easy 
 ---
 
-Node JS interface for Redsys payment gateway
+Node JS client and utilities for implementing a redsys payment gateway
 
 ## Install
 
@@ -9,455 +9,130 @@ Node JS interface for Redsys payment gateway
 npm install redsys-easy
 ```
 
-## Usage
-
-When creating a `Redsys` instance, you are required to pass some options. `secretKey` is your Redsys key. The `urls` property should be an Object with the urls of Redsys endpoints.
-
-```js
-const {
-  SANDBOX_URLS,
-  PRODUCTION_URLS,
-  Redsys
-} = require('redsys-easy')
+## API documentation
 
-const redsys = new Redsys({
-  secretKey: 'sq7HjrUOBfKmC576ILgskD5srU870gJ7',
-  urls: SANDBOX_URLS,
-});
-
-// PRODUCTION_URLS
-{
-  redirect: 'https://sis.redsys.es/sis/realizarPago',
-  ws: 'https://sis.redsys.es/sis/services/SerClsWSEntrada/wsdl/SerClsWSEntrada.wsdl'
-}
-```
+Checkout the [api documentation](./docs/redsys-easy.md) to explore the utilities exported by this package.
 
-### Redirection Requests
+## Usage
 
-Generate the parameters to create a transaction:
+These are the most important utilities that redsys-easy provides.
 
-```js
-const {
-  Redsys,
+<!-- AUTO-GENERATED-CONTENT:START (CODE:src=./examples/__readme__/usage.ts) -->
+<!-- The below code snippet is automatically added from ./examples/__readme__/usage.ts -->
+```ts
+import {
+  createRedsysAPI,
   SANDBOX_URLS,
   PRODUCTION_URLS,
-  TRANSACTION_TYPES,
-  randomTransactionId
-} = require('redsys-easy')
-
-const redsys = new Redsys({
-  secretKey: 'sq7HjrUOBfKmC576ILgskD5srU870gJ7',
-  urls: SANDBOX_URLS, // Also PRODUCTION_URLS
-});
-
-const obj = {
-  // amount in smallest currency unit(cents)
-  // 49.99€
-  amount: 4999,
-  currency: 'EUR',
-  order: randomTransactionId(),
-  merchantName: 'MI COMERCIO',
-  merchantCode: '999008881',
-  terminal: '1',
-  transactionType: TRANSACTION_TYPES.AUTHORIZATION, // '0'
-  merchantURL: 'http://micomercio.com/payments/redsys/notification',
-  successURL: 'http://micomercio.com/compra/success',
-  errorURL: 'http://micomercio.com/compra/error',
-  // Raw parameters
-  raw: {
-    // merchantData
-    DS_MERCHANT_MERCHANTDATA: 'foo',
-  },
-}
-
-const form = redsys.redirectPetition(obj)
-console.log(form);
-```
-
-The above will produce an object similar to
-
-```js
-{
-  url: 'https://sis-t.redsys.es:25443/sis/realizarPago',
-  body: {
-    Ds_MerchantParameters: 'eyJEU19NRVJDSEFOVF9BTU9VTlQiOiIxMDAiLCJEU19NRVJDSEFOVF9PUkRFUiI6IjE1MDg0MjgzNjAiLCJEU19NRVJDSEFOVF9NRVJDSEFOVE5BTUUiOiJUZXN0aW5nIFNob3AiLCJEU19NRVJDSEFOVF9NRVJDSEFOVENPREUiOiIzMjcyMzQ2ODgiLCJEU19NRVJDSEFOVF9DVVJSRU5DWSI6Ijk3OCIsIkRTX01FUkNIQU5UX1RSQU5TQUNUSU9OVFlQRSI6IjAiLCJEU19NRVJDSEFOVF9URVJNSU5BTCI6IjEiLCJEU19NRVJDSEFOVF9NRVJDSEFOVFVSTCI6IiIsIkRTX01FUkNIQU5UX1VSTE9LIjoiaHR0cDovL2xvY2FsaG9zdDo4MDgwL3N1Y2Nlc3MiLCJEU19NRVJDSEFOVF9VUkxLTyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA4MC9lcnJvciJ9',
-    Ds_SignatureVersion: 'HMAC_SHA256_V1',
-    Ds_Signature: 'qkMJMWR6Dq32xwbQuguTv39OvXv4KdD1Xg7pZ8phGZI='
-  }
-}
-```
-
-Which can be used to create a payment form
-
-### Process REST Notifications
+  // Create a new orderId
+  randomTransactionId,
+  // Utilities for 3DS forms
+  create3DSMethodForm,
+  create3DSv1ChallengeForm,
+  create3DSv2ChallengeForm,
+  deserializeThreeDSMethodData,
+  deserializeCres
+} from 'redsys-easy';
 
-```js
 const {
-  Redsys,
-  SANDBOX_URLS,
-  PRODUCTION_URLS,
-  TRANSACTION_TYPES
-} = require('redsys-easy')
-
-const redsys = new Redsys({
+  // REST integration
+  restIniciaPeticion,
+  restTrataPeticion,
+  // Redirect integration
+  createRedirectForm,
+  processRestNotification,
+  processSoapNotification,
+  createSoapNotificationAnswer
+}= createRedsysAPI({
   secretKey: 'sq7HjrUOBfKmC576ILgskD5srU870gJ7',
-  urls: SANDBOX_URLS, // Also PRODUCTION_URLS
+  urls: SANDBOX_URLS
 });
-
-const result = redsys.processNotification(req.body)
-console.log(result)
-```
-
-If the signature is not correct, it will throw an error. Otherwise it will return an object like this.
-
-```js
-{
-  date: '2017-10-20',
-  hour: '18:20',
-  // Already timezone aware
-  timestamp: new Date('2017-10-20 17:20 Z'),
-  securePayment: true,
-  // amount in smallest currency unit(cents)
-  // 49.99€
-  amount: 4999,
-  currency: 'EUR',
-  order: '000079d1Zr9',
-  merchantCode: '327234688',
-  terminal: '001',
-  response: 0,
-  transactionType: '0',
-  authorisationCode: '678746',
-  lang: 'es',
-  cardCountry: 'es',
-  cardBrand: 'VISA',
-  // Raw response parameters
-  raw: {
-    Ds_Date: '20/10/2017',
-    Ds_Hour: '18:20',
-    Ds_SecurePayment: '1',
-    Ds_Amount: '100',
-    Ds_Currency: '978',
-    Ds_Order: '00007921799',
-    Ds_MerchantCode: '327234688',
-    Ds_Terminal: '001',
-    Ds_Response: '0000',
-    Ds_TransactionType: '0',
-    Ds_MerchantData: '',
-    Ds_AuthorisationCode: '678746',
-    Ds_ConsumerLanguage: '1',
-    Ds_Card_Country: '724',
-    Ds_Card_Brand: '1'
-  }
-}
-```
-
-### Response code messages
-
-```js
-const { getResponseCodeMessage } = require('redsys-easy')
-
-getResponseCodeMessage('0180')
-// 'Operación no permitida para ese tipo de tarjeta.'
-
-getResponseCodeMessage('xyz')
-// null
 ```
+<!-- AUTO-GENERATED-CONTENT:END -->
 
-### Web Service Requests
+## Examples
 
-```js
-const {
-  Redsys,
-  TRANSACTION_TYPES,
-  SANDBOX_URLS,
-  PRODUCTION_URLS,
-  randomTransactionId,
-} = require('redsys-easy')
-
-const redsys = new Redsys({
-  secretKey: 'sq7HjrUOBfKmC576ILgskD5srU870gJ7',
-  urls: SANDBOX_URLS, // Also PRODUCTION_URLS
-})
+Despite the name, a redsys payment gateway with 3DS support is quite complex. Don't despair, these examples show how it can be implemented.
+  - [INSITE client](./examples/insite-client) implemented using a [solid](https://github.com/solidjs/solid) web app.
+  - [REST 3DS server](./examples/rest-3ds-server) implemented using a [koa](https://koajs.com/) http server.
 
-const params = {
-  // amount in smallest currency unit(cents)
-  // 33.50€
-  amount: 3350,
-  order: '000079d1Zr9',
-  merchantCode: '999008881',
-  currency: 'EUR',
-  pan: '4548812049400004',
-  cvv: '123',
-  expiryDate: '1220', // MMYY format
-  transactionType: TRANSACTION_TYPES.NO_AUTHENTICATION,
-  terminal: '1',
-  // Raw parameters
-  raw: {
-    // merchantData
-    DS_MERCHANT_MERCHANTDATA: 'foo',
-  },
-}
+Redirection is much simpler but less customizable
+  - [Redirection integration](./examples/redirection)
 
-redsys.wsPetition(params).then(result => {
-  console.log(result);
-})
-```
+## Formatters
 
-Redsys SIS errors will raise errors in Node JS, but failed transactions will not. You can check the transaction status in this way.
+By default, the main functions exported by this package use the API specified by redsys. To smooth out the corners of this API, it's also possible to wrap them with custom formatters.
 
-```js
-const {
-  getResponseCodeMessage,
-} = require('redsys-easy')
+As an example, redsys-easy provides some basic typescript-ready formatters.
 
-// Get response code
-result.response
-result.raw.Ds_Response
+> :warning: **Format has changed**: Previous versions of redsys-easy used a different format, particularly the `amount` field.
 
-// Get code message
-getResponseCodeMessage(response);
-getResponseCodeMessage(result.raw.Ds_Response);
-```
-
-### Basic SOAP Notification functions
-
-```js
-const {
-  Redsys,
+<!-- AUTO-GENERATED-CONTENT:START (CODE:src=./examples/__readme__/formatters.ts) -->
+<!-- The below code snippet is automatically added from ./examples/__readme__/formatters.ts -->
+```ts
+import {
+  createRedsysAPI,
   SANDBOX_URLS,
-  PRODUCTION_URLS,
-} = require('redsys-easy')
-
-const redsys = new Redsys({
-  secretKey: 'sq7HjrUOBfKmC576ILgskD5srU870gJ7',
-  urls: SANDBOX_URLS, // Also PRODUCTION_URLS
-});
-
-// Get the parameters from a message/request xml
-// Throws an error if signature is not valid
-const params = processSoapNotification(requestXml);
-
-// Build your signed answer/response.
-// Second arg dedices whether the transaction is approved
-const answer = soapNotificationAnswer(params.Ds_Order, true);
-```
-
-### Mimic a SOAP Notification server
+  // Formatter utils
+  useSingleInputFormatter,
+  useOutputFormatter,
+  usePromiseOutputFormatter,
+  // Input formatters
+  redirectInputFormatter,
+  restIniciaPeticionInputFormatter,
+  restTrataPeticionInputFormatter,
+  // Output formatters
+  restNotificationOutputFormatter,
+  soapNotificationOutputFormatter,
+  restIniciaPeticionOutputFormatter,
+  restTrataPeticionOutputFormatter
+} from 'redsys-easy';
 
-Now you can receive synchronous notifications and kill the transaction if you want. No need to run a full-fledged SOAP server.
-
-```js
 const {
-  Redsys,
-  SANDBOX_URLS,
-  PRODUCTION_URLS,
-  detectSoapVersion,
-  mimicSoapNotificationReceiver,
-  mimicSoap11NotificationResponse,
-  mimicSoap12NotificationResponse,
-} = require('redsys-easy')
-
-const redsys = new Redsys({
+  restIniciaPeticion: baseRestIniciaPeticion,
+  restTrataPeticion: baseRestTrataPeticion,
+  createRedirectForm: baseCreateRedirectForm,
+  processRestNotification: baseProcessRestNotification,
+  processSoapNotification: baseProcessSoapNotification
+} = createRedsysAPI({
   secretKey: 'sq7HjrUOBfKmC576ILgskD5srU870gJ7',
-  urls: SANDBOX_URLS, // Also PRODUCTION_URLS
-});
-```
-
-In koa
-
-```js
-app.post('/soapNotification', ctx => {
-  // Simulate processing raw xml by a SOAP server
-  const requestXml = mimicSoapNotificationReceiver(ctx.request.body),
-
-  // Throws an error if signature is not valid
-  const params = processSoapNotification(requestXml);
-
-  // Build your answer
-  // Second arg dedices whether the transaction is approved
-  const answer = soapNotificationAnswer(params.order, true);
-
-  // Simulate a full SOAP server response
-  const soapVersion = detectSoapVersion({
-    headers: ctx.request.headers,
-    body: ctx.request.body,
-  });
-
-  if (soapVersion === '1.2') {
-    ctx.type = 'application/soap+xml; charset=utf-8';
-    ctx.body = mimicSoap12NotificationResponse(answer);
-  } else {
-    ctx.type = 'text/xml; charset=utf-8';
-    ctx.body = mimicSoap11NotificationResponse(answer);
-  }
-});
-```
-
-In express
-
-```js
-app.post('/soapNotification', (req, res) => {
-  // Simulate processing raw xml by a SOAP server
-  const requestXml = mimicSoapNotificationReceiver(req.body),
-
-  // Throws an error if signature is not valid
-  const params = processSoapNotification(requestXml);
-
-  // Build your answer
-  // Second arg dedices whether the transaction is approved
-  const answer = soapNotificationAnswer(params.order, true);
-
-  // Simulate a full SOAP server response
-  const soapVersion = detectSoapVersion({
-    headers: req.headers,
-    body: req.body,
-  });
-
-  if (soapVersion === '1.2') {
-    res.set('Content-Type', 'application/soap+xml; charset=utf-8');
-    res.send(mimicSoap12NotificationResponse(answer));
-  } else {
-    res.set('Content-Type', 'text/xml; charset=utf-8');
-    res.send(mimicSoap11NotificationResponse(answer));
-  }
+  urls: SANDBOX_URLS
 });
-```
-
-
-### Accepted parameters for redirectPetition and wsPetition
-
-Numbers
-
-* amount: integer in the smallest currency unit.
-
-Strings
-
-* order
-* merchantCode
-* currency: Uppercase ISO 4217 alpha-3 code, e.g 'EUR'
-* transactionType
-* terminal
-* merchantName
-* merchantURL
-* errorURL
-* successURL
-* dateFrequency
-* chargeExpiryDate
-* sumTotal
-* directPayment
-* identifier
-* group
-* pan: credit card number
-* expiryDate: As printed in your credit card, MMYY, has priority over expiryYear and expiryMonth
-* expiryYear: YY
-* expiryMonth: MM
-* cvv 
-* partialPayment
-* cardCountry: Lowercase ISO 3166 Alpha 2 country code, e.g. 'es'
-* merchantData
-* clientIp
-* lang: Lowercase ISO 639-1 lang code
-* operationId
-* payMethods
-* productDescription
-* taxReference
-* transactionDate
-* merchantDescriptor
-* customerMobile: Mobile phone number
-* customerMail: Email address
-* cardHolder: Name of credit card holder
-* smsTemplate: Paygold sms template like `'@COMERCIO@. Ya puede pagar su recibo de @IMPORTE@ @MONEDA@ en la siguiente url: @URL@'`
-
-Other
-
-* raw: Object with parameters that will not formatted. E.g. `raw: { DS_MERCHANTDATA: 'foo', ... }`
-
-### Response
 
-Numbers
-
-* amount: integer in the smallest currency unit.
-* response: response code
-
-Booleans
-* securePayment
-
-Strings
-
-* hour: HH:MM
-* date: YYYY-MM-DD
-* timestamp: javascript date object, with date and hour information
-* order
-* merchantCode
-* currency: Uppercase ISO 4217 alpha-3 code, e.g 'EUR'
-* transactionType
-* terminal
-* identifier
-* cardNumber: Partial credit card number
-* expiryDate: As printed in your credit card, MMYY
-* expiryYear: YY
-* expiryMonth: MM
-* cardBrand: E.g. 'VISA'
-* cardType: 'C' (Credit) or 'D' (Debit)
-* cardCountry: Lowercase ISO 3166 Alpha 2 country code, e.g. 'es'
-* authorisationCode
-* merchantData
-* clientIp
-* lang: Lowercase ISO 639-1 lang code
-* operationId
-* transactionDate
-* merchantDescriptor
-* payURL: Paygold 2 phase payment URL to send to the client
-
-Other
-
-* raw: Full response as received from the server. E.g. `{ DS_MERCHANTDATA: 'foo', ... }`
-
-### Transaction Types
-
-* AUTHORIZATION: "0"
-* PRE_AUTHORIZATION: "1"
-* CONFIRMATION: "2"
-* AUTO_REFUND: "3"
-* RECURRING_TRANSACTION: "5"
-* SUCCESSIVE_TRANSACTION: "6"
-* PRE_AUTHENTICATION: "7"
-* PRE_AUTHENTICATION_CONFIRMATION: "8"
-* PRE_AUTHORIZATION_CANCEL: "9"
-* DEFERRED_AUTHORIZATION: "O"
-* PAYLINK: "F". Also known as paygold.
-* DEFERRED_AUTHORIZATION_CONFIRMATION: "P"
-* DEFERRED_AUTHORIZATION_CANCEL: "Q"
-* DEFERRED_INITIAL_FEE: "R"
-* DEFERRED_SUCCESSIVE_FEE: "S"
-* NO_AUTHENTICATION: "A"
-* DELETE_REFERENCE: "44"
-
-### Errors
-
-* RedsysError: Super class from which all errors inherit. Unclassified errors.
-* ValidationError: Error validating input parameters.
-* ParseError: Error parsing response.
-* GatewayError: Redsys gateway returned an error code. Note that only webservice requests trigger this error, notification processors don't.
-
-```js
-const {
-  RedsysError,
-  ValidationError,
-  ParseError,
-  GatewayError,
-} = require('redsys-easy');
+/*
+ *            External      Internal
+ * amount      '33.5'  <->   '3350'
+ * currency    'EUR'   <->   '978'
+ *
+ * expiryYear  '34'
+ * expiryMonth '12'
+ *                     <->   '3412'
+ *
+ * lang        'es'    <->   '1'
+ * cardBrand   'VISA'  <-    '1'
+ * cardCountry 'es'    <-    '724'
+ */
+export const createRedirectForm = useSingleInputFormatter(baseCreateRedirectForm, redirectInputFormatter);
+export const restIniciaPeticion = useSingleInputFormatter(
+  usePromiseOutputFormatter(baseRestIniciaPeticion, restIniciaPeticionOutputFormatter),
+  restIniciaPeticionInputFormatter
+)
+export const restTrataPeticion = useSingleInputFormatter(
+  usePromiseOutputFormatter(baseRestTrataPeticion, restTrataPeticionOutputFormatter),
+  restTrataPeticionInputFormatter
+)
+export const processRestNotification = useOutputFormatter(baseProcessRestNotification, restNotificationOutputFormatter);
+export const processSoapNotification = useOutputFormatter(baseProcessSoapNotification, soapNotificationOutputFormatter);
 ```
+<!-- AUTO-GENERATED-CONTENT:END -->
 
 ## FAQ
 
-### What is the smallest unit of a currency?
-
-The smallest unit of a currency, is the smallest integer amount of said currency. For euros, it is cents. So 1.99 EUR would be 199 of the smallest unit.
+### How should I format the amount?
 
-### Why are amounts denominated in the smallest unit of a currency?
+Redsys API uses expects amounts denominated in the smallest unit of a currency. The exported core functions of redsys-easy also follows this convention. The smallest unit of a currency is the smallest integer amount of said currency. For euros, it is cents. So 1.99 EUR would be 199 of the smallest unit.
 
-To avoid floats and precision losses. In javascript `0.1 + 0.2 !== 0.3`, but `1 + 2 === 3`. Also, this is a convention for payment processors and POS terminals.
+However you are free to wrap these core functions with a custom formatter. Particularly, redsys-easy optional formatters expect the amount to be formatted as a decimal string currency unit. For euros, it would be '1.99'.
 
 ## Acknowledgments
 

package/lib/assets/card-brands.d.ts

@@ -1,4 +1,28 @@
+/**
+ * Card brand name
+ *
+ * @public
+ */
 export declare type CardBrand = 'VISA' | 'MASTERCARD' | 'DINERS' | 'PRIVATE' | 'AMEX' | 'JCB' | 'UPI';
-export declare const CARDBRANDS: Record<CardBrand, string>;
-declare const REV_CARDBRANDS: Record<string, CardBrand>;
+/**
+ * Card brand number
+ *
+ * @public
+ */
+export declare type CardBrandNum = '1' | '2' | '6' | '7' | '8' | '9' | '22';
+/**
+ * Card brand name to number
+ *
+ * @public
+ */
+export declare const CARDBRANDS: Record<CardBrand, CardBrandNum>;
+/**
+ * Card brand number to name
+ *
+ * @remarks
+ * @see {@link CARDBRANDS}
+ *
+ * @public
+ */
+declare const REV_CARDBRANDS: Record<CardBrandNum, CardBrand>;
 export { REV_CARDBRANDS };

package/lib/assets/countries.d.ts

@@ -1,4 +1,31 @@
+/**
+ * Country ISO 3166 Alpha 2 code
+ *
+ * @public
+ */
 export declare type Country = 'af' | 'al' | 'aq' | 'dz' | 'as' | 'ad' | 'ao' | 'ag' | 'az' | 'ar' | 'au' | 'at' | 'bs' | 'bh' | 'bd' | 'am' | 'bb' | 'be' | 'bm' | 'bt' | 'bo' | 'ba' | 'bw' | 'bv' | 'br' | 'bz' | 'io' | 'sb' | 'vg' | 'bn' | 'bg' | 'mm' | 'bi' | 'by' | 'kh' | 'cm' | 'ca' | 'cv' | 'ky' | 'cf' | 'lk' | 'td' | 'cl' | 'cn' | 'tw' | 'cx' | 'cc' | 'co' | 'km' | 'yt' | 'cg' | 'cd' | 'ck' | 'cr' | 'hr' | 'cu' | 'cy' | 'cz' | 'bj' | 'dk' | 'dm' | 'do' | 'ec' | 'sv' | 'gq' | 'et' | 'er' | 'ee' | 'fo' | 'fk' | 'gs' | 'fj' | 'fi' | 'ax' | 'fr' | 'gf' | 'pf' | 'tf' | 'dj' | 'ga' | 'ge' | 'gm' | 'ps' | 'de' | 'gh' | 'gi' | 'ki' | 'gr' | 'gl' | 'gd' | 'gp' | 'gu' | 'gt' | 'gn' | 'gy' | 'ht' | 'hm' | 'va' | 'hn' | 'hk' | 'hu' | 'is' | 'in' | 'id' | 'ir' | 'iq' | 'ie' | 'il' | 'it' | 'ci' | 'jm' | 'jp' | 'kz' | 'jo' | 'ke' | 'kp' | 'kr' | 'kw' | 'kg' | 'la' | 'lb' | 'ls' | 'lv' | 'lr' | 'ly' | 'li' | 'lt' | 'lu' | 'mo' | 'mg' | 'mw' | 'my' | 'mv' | 'ml' | 'mt' | 'mq' | 'mr' | 'mu' | 'mx' | 'mc' | 'mn' | 'md' | 'me' | 'ms' | 'ma' | 'mz' | 'om' | 'na' | 'nr' | 'np' | 'nl' | 'cw' | 'aw' | 'sx' | 'bq' | 'nc' | 'vu' | 'nz' | 'ni' | 'ne' | 'ng' | 'nu' | 'nf' | 'no' | 'mp' | 'um' | 'fm' | 'mh' | 'pw' | 'pk' | 'pa' | 'pg' | 'py' | 'pe' | 'ph' | 'pn' | 'pl' | 'pt' | 'gw' | 'tl' | 'pr' | 'qa' | 're' | 'ro' | 'ru' | 'rw' | 'bl' | 'sh' | 'kn' | 'ai' | 'lc' | 'mf' | 'pm' | 'vc' | 'sm' | 'st' | 'sa' | 'sn' | 'rs' | 'sc' | 'sl' | 'sg' | 'sk' | 'vn' | 'si' | 'so' | 'za' | 'zw' | 'es' | 'ss' | 'sd' | 'eh' | 'sr' | 'sj' | 'sz' | 'se' | 'ch' | 'sy' | 'tj' | 'th' | 'tg' | 'tk' | 'to' | 'tt' | 'ae' | 'tn' | 'tr' | 'tm' | 'tc' | 'tv' | 'ug' | 'ua' | 'mk' | 'eg' | 'gb' | 'gg' | 'je' | 'im' | 'tz' | 'us' | 'vi' | 'bf' | 'uy' | 'uz' | 've' | 'wf' | 'ws' | 'ye' | 'zm';
-export declare const COUNTRIES: Record<Country, string>;
-declare const REV_COUNTRIES: Record<string, Country>;
+/**
+ * Country UN M49 number
+ *
+ * @public
+ */
+export declare type CountryNum = '4' | '8' | '10' | '12' | '16' | '20' | '24' | '28' | '31' | '32' | '36' | '40' | '44' | '48' | '50' | '51' | '52' | '56' | '60' | '64' | '68' | '70' | '72' | '74' | '76' | '84' | '86' | '90' | '92' | '96' | '100' | '104' | '108' | '112' | '116' | '120' | '124' | '132' | '136' | '140' | '144' | '148' | '152' | '156' | '158' | '162' | '166' | '170' | '174' | '175' | '178' | '180' | '184' | '188' | '191' | '192' | '196' | '203' | '204' | '208' | '212' | '214' | '218' | '222' | '226' | '231' | '232' | '233' | '234' | '238' | '239' | '242' | '246' | '248' | '250' | '254' | '258' | '260' | '262' | '266' | '268' | '270' | '275' | '276' | '288' | '292' | '296' | '300' | '304' | '308' | '312' | '316' | '320' | '324' | '328' | '332' | '334' | '336' | '340' | '344' | '348' | '352' | '356' | '360' | '364' | '368' | '372' | '376' | '380' | '384' | '388' | '392' | '398' | '400' | '404' | '408' | '410' | '414' | '417' | '418' | '422' | '426' | '428' | '430' | '434' | '438' | '440' | '442' | '446' | '450' | '454' | '458' | '462' | '466' | '470' | '474' | '478' | '480' | '484' | '492' | '496' | '498' | '499' | '500' | '504' | '508' | '512' | '516' | '520' | '524' | '528' | '531' | '533' | '534' | '535' | '540' | '548' | '554' | '558' | '562' | '566' | '570' | '574' | '578' | '580' | '581' | '583' | '584' | '585' | '586' | '591' | '598' | '600' | '604' | '608' | '612' | '616' | '620' | '624' | '626' | '630' | '634' | '638' | '642' | '643' | '646' | '652' | '654' | '659' | '660' | '662' | '663' | '666' | '670' | '674' | '678' | '682' | '686' | '688' | '690' | '694' | '702' | '703' | '704' | '705' | '706' | '710' | '716' | '724' | '728' | '729' | '732' | '740' | '744' | '748' | '752' | '756' | '760' | '762' | '764' | '768' | '772' | '776' | '780' | '784' | '788' | '792' | '795' | '796' | '798' | '800' | '804' | '807' | '818' | '826' | '831' | '832' | '833' | '834' | '840' | '850' | '854' | '858' | '860' | '862' | '876' | '882' | '887' | '894';
+/**
+ * Maps ISO 3166 Alpha 2 codes to UN M49 numbers
+ *
+ * @remarks
+ * [UN M49 to ISO 3166 information](https://unstats.un.org/unsd/methodology/m49/)
+ *
+ * @public
+ */
+export declare const COUNTRIES: Record<Country, CountryNum>;
+/**
+ * Maps UN M49 numbers to ISO 3166 Alpha 2 codes
+ *
+ * @remarks
+ * @see {@link COUNTRIES}
+ *
+ * @public
+ */
+declare const REV_COUNTRIES: Record<CountryNum, Country>;
 export { REV_COUNTRIES };