POC - Centralized payment method definitions

changelog/poc-centralized-payment-method-definitions

@@ -0,0 +1,4 @@
+Significance: minor
+Type: dev
+
+Add centralized payment method definitions to streamline implementation and maintenance of payment methods.

client/globals.d.ts

@@ -161,6 +161,11 @@ declare global {
 		timeFormat: string;
 	};
 
+	const woopaymentsPaymentMethodDefinitions: Record<
+		string,
+		PaymentMethodDefinition
+	>;
+
 	const wc: {
 		wcSettings: typeof wcSettingsModule;
 		tracks: {

client/payment-methods-map.tsx

@@ -1,7 +1,9 @@
 /**
  * External dependencies
  */
+import React from 'react';
 import { __ } from '@wordpress/i18n';
+import classNames from 'classnames';
 
 /**
  * Internal dependencies
@@ -29,17 +31,41 @@ import {
 
 const accountCountry = window.wcpaySettings?.accountStatus?.country || 'US';
 
-export interface PaymentMethodMapEntry {
-	id: string;
-	label: string;
-	description: string;
-	icon: ReactImgFuncComponent;
-	currencies: string[];
-	stripe_key: string;
-	allows_manual_capture: boolean;
-	allows_pay_later: boolean;
-	accepts_only_domestic_payment: boolean;
-}
+import type { PaymentMethodMapEntry } from './types/payment-methods';
+
+// Get any payment method definitions from the client.
+const PaymentMethodDefinitions =
+	typeof woopaymentsPaymentMethodDefinitions !== 'undefined'
+		? woopaymentsPaymentMethodDefinitions
+		: {};
+
+const convertedPaymentMethodDefinitions = Object.fromEntries<
+	PaymentMethodMapEntry
+>(
+	Object.entries( PaymentMethodDefinitions ).map( ( [ key, value ] ) => [
+		key,
+		{
+			id: value.id,
+			label: value.title,
+			description: value.description,
+			icon: ( { className } ) => (
+				<img
+					src={ value.icon }
+					alt={ value.title }
+					className={ classNames(
+						'payment-method__icon',
+						className
+					) }
+				/>
+			),
+			currencies: value.currencies,
+			stripe_key: value.stripeId,
+			allows_manual_capture: value.allows_manual_capture,
+			allows_pay_later: value.allows_pay_later,
+			accepts_only_domestic_payment: value.accepts_only_domestic_payment,
+		},
+	] )
+);
 
 const PaymentMethodInformationObject: Record<
 	string,
@@ -292,6 +318,7 @@ const PaymentMethodInformationObject: Record<
 		allows_pay_later: false,
 		accepts_only_domestic_payment: false,
 	},
+	...convertedPaymentMethodDefinitions,
 };
 
 export default PaymentMethodInformationObject;

client/types/payment-methods.d.ts

@@ -20,6 +20,16 @@ export type PaymentMethod =
 	| 'ideal'
 	| 'p24'
 	| 'sepa_debit'
-	| 'sofort'
-	| 'affirm'
-	| 'afterpay_clearpay';
+	| 'sofort';
+
+export interface PaymentMethodMapEntry {
+	id: string;
+	label: string;
+	description: string;
+	icon: ReactImgFuncComponent;
+	currencies: string[];
+	stripe_key: string;
+	allows_manual_capture: boolean;
+	allows_pay_later: boolean;
+	accepts_only_domestic_payment: boolean;
+}

composer.json

@@ -90,6 +90,7 @@
     "autoload": {
         "psr-4": {
             "WCPay\\MultiCurrency\\": "includes/multi-currency",
+            "WCPay\\PaymentMethods\\Configs\\": "includes/payment-methods/Configs",
             "WCPay\\Vendor\\": "lib/packages",
             "WCPay\\": "src"
         },

includes/admin/class-wc-payments-admin.php

@@ -11,6 +11,7 @@
 use WCPay\Database_Cache;
 use WCPay\Logger;
 use WCPay\WooPay\WooPay_Utilities;
+use WCPay\PaymentMethods\Configs\Utils\PaymentMethodUtils;
 
 defined( 'ABSPATH' ) || exit;
 
@@ -659,6 +660,13 @@ public function enqueue_payments_scripts() {
 				$this->get_js_settings()
 			);
 
+			$payment_method_definitions = rawurlencode( PaymentMethodUtils::get_payment_method_definitions_json() );
+			wp_add_inline_script(
+				'WCPAY_ADMIN_SETTINGS',
+				"window.woopaymentsPaymentMethodDefinitions = JSON.parse( decodeURIComponent( '" . esc_js( $payment_method_definitions ) . "' ) );",
+				'before'
+			);
+
 			// Output the settings JS and CSS only on the settings page.
 			wp_enqueue_script( 'WCPAY_ADMIN_SETTINGS' );
 			wp_enqueue_style( 'WCPAY_ADMIN_SETTINGS' );
@@ -684,6 +692,13 @@ public function enqueue_payments_scripts() {
 				$this->get_js_settings()
 			);
 
+			$payment_method_definitions = rawurlencode( PaymentMethodUtils::get_payment_method_definitions_json() );
+			wp_add_inline_script(
+				'WCPAY_DASH_APP',
+				"const woopaymentsPaymentMethodDefinitions = JSON.parse( decodeURIComponent( '" . esc_js( $payment_method_definitions ) . "' ) );",
+				'before'
+			);
+
 			wp_enqueue_script( 'WCPAY_DASH_APP' );
 			wp_enqueue_style( 'WCPAY_DASH_APP' );
 		}

includes/class-duplicates-detection-service.php

@@ -25,6 +25,7 @@
 use WCPay\Payment_Methods\Sepa_Payment_Method;
 use WCPay\Payment_Methods\Grabpay_Payment_Method;
 use WCPay\Payment_Methods\Wechatpay_Payment_Method;
+use WCPay\PaymentMethods\Configs\Registry\PaymentMethodDefinitionRegistry;
 
 /**
  * Class handling detection of payment methods enabled by multiple plugins simultaneously.
@@ -94,6 +95,8 @@ private function search_for_cc() {
 	 * @return Duplicates_Detection_Service
 	 */
 	private function search_for_additional_payment_methods() {
+		// Get all payment method definitions.
+
 		$keywords = [
 			'bancontact' => Bancontact_Payment_Method::PAYMENT_METHOD_STRIPE_ID,
 			'sepa'       => Sepa_Payment_Method::PAYMENT_METHOD_STRIPE_ID,
@@ -111,6 +114,16 @@ private function search_for_additional_payment_methods() {
 			'wechatpay'  => Wechatpay_Payment_Method::PAYMENT_METHOD_STRIPE_ID,
 		];
 
+		$payment_method_definitions = PaymentMethodDefinitionRegistry::instance()->get_all_payment_method_definitions();
+
+		// This gets all the registered payment method definitions. As new payment methods are converted from the legacy style, they need to be removed from the list above.
+		foreach ( $payment_method_definitions as $definition_class ) {
+			$definition_keywords = $definition_class::get_keywords();
+			foreach ( $definition_keywords as $keyword ) {
+				$keywords[ $keyword ] = $definition_class::get_id();
+			}
+		}
+
 		foreach ( $this->get_enabled_gateways() as $gateway ) {
 			foreach ( $keywords as $keyword => $payment_method ) {
 				if ( strpos( $gateway->id, $keyword ) !== false ) {

includes/class-wc-payment-gateway-wcpay.php

@@ -69,6 +69,7 @@
 use WCPay\Payment_Methods\UPE_Payment_Method;
 use WCPay\Payment_Methods\Grabpay_Payment_Method;
 use WCPay\Payment_Methods\Wechatpay_Payment_Method;
+use WCPay\PaymentMethods\Configs\Registry\PaymentMethodDefinitionRegistry;
 
 /**
  * Gateway class for WooPayments
@@ -3988,6 +3989,13 @@ public function get_upe_available_payment_methods() {
 		$available_methods[] = Grabpay_Payment_Method::PAYMENT_METHOD_STRIPE_ID;
 		$available_methods[] = Wechatpay_Payment_Method::PAYMENT_METHOD_STRIPE_ID;
 
+		// This gets all the registered payment method definitions. As new payment methods are converted from the legacy style, they need to be removed from the list above.
+		$payment_method_definitions = PaymentMethodDefinitionRegistry::instance()->get_all_payment_method_definitions();
+
+		foreach ( $payment_method_definitions as $definition_class ) {
+			$available_methods[] = $definition_class::get_id();
+		}
+
 		$available_methods = array_values(
 			apply_filters(
 				'wcpay_upe_available_payment_methods',

includes/class-wc-payments.php

@@ -46,6 +46,7 @@
 use WCPay\Duplicates_Detection_Service;
 use WCPay\Payment_Methods\Grabpay_Payment_Method;
 use WCPay\WC_Payments_Currency_Manager;
+use WCPay\PaymentMethods\Configs\Registry\PaymentMethodDefinitionRegistry;
 
 /**
  * Main class for the WooPayments extension. Its responsibility is to initialize the extension.
@@ -585,6 +586,15 @@ public static function init() {
 			Wechatpay_Payment_Method::class,
 		];
 
+		// Initialize and get payment method classes from the registry for those that have been converted.
+		$registry = PaymentMethodDefinitionRegistry::instance();
+		$registry->init();
+		$payment_method_definitions = $registry->get_all_payment_method_definitions();
+
+		foreach ( $payment_method_definitions as $definition_class ) {
+			$payment_method_classes[] = $definition_class::get_payment_method_class();
+		}
+
 		$payment_methods = [];
 		foreach ( $payment_method_classes as $payment_method_class ) {
 			$payment_method                               = new $payment_method_class( self::$token_service );

includes/payment-methods/Configs/Constants/PaymentMethodCapability.php

@@ -0,0 +1,55 @@
+<?php
+/**
+ * Payment Method Capability Constants
+ *
+ * @package WCPay\PaymentMethods\Configs\Constants
+ */
+
+namespace WCPay\PaymentMethods\Configs\Constants;
+
+/**
+ * Class defining payment method capability constants.
+ */
+class PaymentMethodCapability {
+	/**
+	 * Payment method can be saved and reused
+	 *
+	 * @var string
+	 */
+	public const TOKENIZATION = 'tokenization';
+
+	/**
+	 * Payment method supports refunds
+	 *
+	 * @var string
+	 */
+	public const REFUNDS = 'refunds';
+
+	/**
+	 * Payment method supports capturing payment later
+	 *
+	 * @var string
+	 */
+	public const CAPTURE_LATER = 'capture_later';
+
+	/**
+	 * Payment method supports multiple currencies
+	 *
+	 * @var string
+	 */
+	public const MULTI_CURRENCY = 'multi_currency';
+
+	/**
+	 * Payment method is a Buy Now Pay Later method
+	 *
+	 * @var string
+	 */
+	public const BUY_NOW_PAY_LATER = 'buy_now_pay_later';
+
+	/**
+	 * Payment method only accepts domestic transactions
+	 *
+	 * @var string
+	 */
+	public const DOMESTIC_TRANSACTIONS_ONLY = 'domestic_transactions_only';
+}