@automattic/wpcom-checkout/src/processor-specific.ts

Functions and components used by WordPress.com checkout.

import { isValid as isValidCnpj } from '@fnando/cnpj';
import { isValid as isValidCpf } from '@fnando/cpf';
import i18n from 'i18n-calypso';
import { PAYMENT_PROCESSOR_COUNTRIES_FIELDS } from './payment-processor-countries-fields';
import {
	translateWpcomPaymentMethodToCheckoutPaymentMethod,
	isPaymentMethodEnabled,
} from './index';
import type { WPCOMPaymentMethod } from './types';
import type { ResponseCart } from '@automattic/shopping-cart';

/**
 * Returns whether we should Ebanx credit card processing for a particular country
 * @param {string} countryCode - a two-letter country code, e.g., 'DE', 'BR'
 * @param {import('@automattic/shopping-cart').ResponseCart} cart - The shopping cart
 * @returns {boolean} Whether the country code requires ebanx payment processing
 */
export function isEbanxCreditCardProcessingEnabledForCountry(
	countryCode: string,
	cart: ResponseCart
): boolean {
	return (
		typeof PAYMENT_PROCESSOR_COUNTRIES_FIELDS[ countryCode ] !== 'undefined' &&
		isPaymentMethodEnabled(
			'ebanx',
			cart.allowed_payment_methods?.map( ( method ) =>
				translateWpcomPaymentMethodToCheckoutPaymentMethod( method as WPCOMPaymentMethod )
			)
		)
	);
}

/**
 * CPF number (Cadastrado de Pessoas Físicas) is the Brazilian tax identification number.
 * Total of 11 digits: 9 numbers followed by 2 verification numbers . E.g., 188.247.019-22
 * @param {string} cpf - a Brazilian tax identification number
 * @returns {boolean} Whether the cpf is valid or not
 */
export function isValidCPF( cpf: string ): boolean {
	return isValidCpf( cpf );
}

/**
 * CNPJ number (Cadastro Nacional da Pessoa Jurídica ) is the Brazilian tax identification number for companies.
 * Total of 14 digits: 8 digits identify the company, a slash, 4 digit to identify the branch, followed by 2 verification numbers . E.g., 67.762.675/0001-49
 * @param {string} cnpj - a Brazilian company tax identification number
 * @returns {boolean} Whether the cnpj is valid or not
 */
export function isValidCNPJ( cnpj: string ): boolean {
	return isValidCnpj( cnpj );
}

export function fullAddressFieldsRules() {
	return {
		'street-number': {
			description: i18n.translate( 'Street Number' ),
			rules: [ 'required', 'validStreetNumber' ],
		},

		'address-1': {
			description: i18n.translate( 'Address' ),
			rules: [ 'required' ],
		},

		state: {
			description: i18n.translate( 'State' ),
			rules: [ 'required' ],
		},

		city: {
			description: i18n.translate( 'City' ),
			rules: [ 'required' ],
		},

		'postal-code': {
			description: i18n.translate( 'Postal Code' ),
			rules: [ 'required' ],
		},
	};
}

export interface FieldRule {
	description: string;
	rules: string[];
}
export type FieldRuleCollection = Record< string, FieldRule >;

/**
 * Returns country/processor specific validation rule sets for defined fields.
 * @param {string} country two-letter country code to determine the required fields
 */
export function countrySpecificFieldRules( country: string ): FieldRuleCollection {
	const countryFields = PAYMENT_PROCESSOR_COUNTRIES_FIELDS[ country ]?.fields ?? [];

	const allFields: FieldRuleCollection = Object.assign(
		{
			document: {
				description: i18n.translate( 'Taxpayer Identification Number', { textOnly: true } ),
				rules: [ 'validBrazilTaxId' ],
			},

			'phone-number': {
				description: i18n.translate( 'Phone Number', { textOnly: true } ),
				rules: [ 'required' ],
			},
			name: {
				description: i18n.translate( 'Your Name', { textOnly: true } ),
				rules: [ 'required' ],
			},
			nik: {
				description: i18n.translate( 'NIK - Indonesia Identity Card Number', {
					comment: 'NIK - Indonesia Identity Card Number required for Indonesian payment methods.',
					textOnly: true,
				} ),
				rules: [ 'validIndonesiaNik' ],
			},

			pan: {
				description: i18n.translate( 'PAN - Permanent account number', { textOnly: true } ),
				rules: [ 'validIndiaPan' ],
			},
			gstin: {
				description: i18n.translate( 'GSTIN - GST identification number', {
					comment: 'GSTIN: India specific tax id number',
					textOnly: true,
				} ),
				rules: [ 'validIndiaGstin' ],
			},
			'postal-code': {
				description: i18n.translate( 'Postal Code', { textOnly: true } ),
				rules: [ 'required' ],
			},
		},
		fullAddressFieldsRules()
	);

	return Object.keys( allFields ).reduce( ( filteredFields, fieldName ) => {
		if ( countryFields.includes( fieldName ) ) {
			filteredFields[ fieldName ] = allFields[ fieldName ];
		}
		return filteredFields;
	}, {} as FieldRuleCollection );
}

export function translatedEbanxError( error: { status_code: string; message?: string } ) {
	// It's unclear if this property still exists
	switch ( error.status_code ) {
		case 'BP-DR-55':
			return i18n.translate( 'Invalid credit card CVV number' );
		case 'BP-DR-51':
		case 'BP-DR-95':
			return i18n.translate( 'Please enter your name.' );
	}

	if ( error.message ) {
		return error.message;
	}

	return i18n.translate(
		'Your payment was not processed this time due to an error, please try to submit it again.'
	);
}