Settings UI: Move Todos config data to a dedicated REST endpoint. Add payment method - todo state sync.

modules/ppcp-settings/resources/js/data/debug.js

@@ -4,6 +4,7 @@ import {
 	PaymentStoreName,
 	SettingsStoreName,
 	StylingStoreName,
+	TodosStoreName,
 } from './index';
 import { setCompleted } from './onboarding/actions';
 
@@ -56,6 +57,7 @@ export const addDebugTools = ( context, modules ) => {
 			stores.push( PaymentStoreName );
 			stores.push( SettingsStoreName );
 			stores.push( StylingStoreName );
+			stores.push( TodosStoreName );
 		} else {
 			// Only reset the common & onboarding stores to restart the onboarding wizard.
 			stores.push( CommonStoreName );

modules/ppcp-settings/resources/js/data/index.js

@@ -4,8 +4,9 @@ import * as Common from './common';
 import * as Payment from './payment';
 import * as Settings from './settings';
 import * as Styling from './styling';
+import * as Todos from './todos';
 
-const stores = [ Onboarding, Common, Payment, Settings, Styling ];
+const stores = [ Onboarding, Common, Payment, Settings, Styling, Todos ];
 
 stores.forEach( ( store ) => {
 	try {
@@ -28,12 +29,14 @@ export const CommonHooks = Common.hooks;
 export const PaymentHooks = Payment.hooks;
 export const SettingsHooks = Settings.hooks;
 export const StylingHooks = Styling.hooks;
+export const TodosHooks = Todos.hooks;
 
 export const OnboardingStoreName = Onboarding.STORE_NAME;
 export const CommonStoreName = Common.STORE_NAME;
 export const PaymentStoreName = Payment.STORE_NAME;
 export const SettingsStoreName = Settings.STORE_NAME;
 export const StylingStoreName = Styling.STORE_NAME;
+export const TodosStoreName = Todos.STORE_NAME;
 
 export * from './configuration';
 

modules/ppcp-settings/resources/js/data/payment/index.js

@@ -8,6 +8,7 @@ import * as actions from './actions';
 import * as hooks from './hooks';
 import { resolvers } from './resolvers';
 import { controls } from './controls';
+import { initTodoSync } from '../sync/todo-state-sync';
 
 /**
  * Initializes and registers the settings store with WordPress data layer.
@@ -26,6 +27,9 @@ export const initStore = () => {
 
 	register( store );
 
+	// Initialize todo sync after store registration. Potentially should be moved elsewhere.
+	initTodoSync();
+
 	return Boolean( wp.data.select( STORE_NAME ) );
 };
 

modules/ppcp-settings/resources/js/data/sync/todo-state-sync.js

@@ -0,0 +1,67 @@
+import { subscribe, select, dispatch } from '@wordpress/data';
+
+const TODO_TRIGGERS = {
+	'ppcp-applepay': 'enable_apple_pay',
+	'ppcp-googlepay': 'enable_google_pay',
+	'ppcp-axo-gateway': 'enable_fastlane',
+	'ppcp-card-button-gateway': 'enable_credit_debit_cards',
+};
+
+/**
+ * Initialize todo synchronization
+ */
+export const initTodoSync = () => {
+	let previousPaymentState = null;
+	let isProcessing = false;
+
+	subscribe( () => {
+		if ( isProcessing ) {
+			return;
+		}
+
+		isProcessing = true;
+
+		try {
+			const paymentState = select( 'wc/paypal/payment' ).persistentData();
+			const todosState = select( 'wc/paypal/todos' ).getTodos();
+
+			// Skip if states haven't been initialized yet
+			if ( ! paymentState || ! todosState || ! previousPaymentState ) {
+				previousPaymentState = paymentState;
+				return;
+			}
+
+			Object.entries( TODO_TRIGGERS ).forEach(
+				( [ paymentMethod, todoId ] ) => {
+					const wasEnabled =
+						previousPaymentState[ paymentMethod ]?.enabled;
+					const isEnabled = paymentState[ paymentMethod ]?.enabled;
+
+					if ( wasEnabled !== isEnabled ) {
+						const todoToUpdate = todosState.find(
+							( todo ) => todo.id === todoId
+						);
+
+						if ( todoToUpdate ) {
+							const updatedTodos = todosState.map( ( todo ) =>
+								todo.id === todoId
+									? { ...todo, isCompleted: isEnabled }
+									: todo
+							);
+
+							dispatch( 'wc/paypal/todos' ).setTodos(
+								updatedTodos
+							);
+						}
+					}
+				}
+			);
+
+			previousPaymentState = paymentState;
+		} catch ( error ) {
+			console.error( 'Error in todo sync:', error );
+		} finally {
+			isProcessing = false;
+		}
+	} );
+};

modules/ppcp-settings/resources/js/data/todos/action-types.js

@@ -0,0 +1,16 @@
+/**
+ * Action Types: Define unique identifiers for actions across all store modules.
+ *
+ * @file
+ */
+
+export default {
+	// Transient data
+	SET_TRANSIENT: 'TODOS:SET_TRANSIENT',
+
+	// Persistent data
+	SET_TODOS: 'TODOS:SET_TODOS',
+
+	// Controls
+	DO_FETCH_TODOS: 'TODOS:DO_FETCH_TODOS',
+};

modules/ppcp-settings/resources/js/data/todos/actions.js

@@ -0,0 +1,24 @@
+/**
+ * Action Creators: Define functions to create action objects.
+ *
+ * These functions update state or trigger side effects (e.g., async operations).
+ * Actions are categorized as Transient, Persistent, or Side effect.
+ *
+ * @file
+ */
+
+import ACTION_TYPES from './action-types';
+
+export const setIsReady = ( isReady ) => ( {
+	type: ACTION_TYPES.SET_TRANSIENT,
+	payload: { isReady },
+} );
+
+export const setTodos = ( todos ) => ( {
+	type: ACTION_TYPES.SET_TODOS,
+	payload: todos,
+} );
+
+export const fetchTodos = function* () {
+	yield { type: ACTION_TYPES.DO_FETCH_TODOS };
+};

modules/ppcp-settings/resources/js/data/todos/constants.js

@@ -0,0 +1,8 @@
+/**
+ * Constants: Define store configuration values.
+ *
+ * @file
+ */
+
+export const STORE_NAME = 'wc/paypal/todos';
+export const REST_PATH = '/wc/v3/wc_paypal/todos';

modules/ppcp-settings/resources/js/data/todos/controls.js

@@ -0,0 +1,22 @@
+/**
+ * Controls: Implement side effects, typically asynchronous operations.
+ *
+ * Controls use ACTION_TYPES keys as identifiers.
+ * They are triggered by corresponding actions and handle external interactions.
+ *
+ * @file
+ */
+
+import apiFetch from '@wordpress/api-fetch';
+import { REST_PATH } from './constants';
+import ACTION_TYPES from './action-types';
+
+export const controls = {
+	async [ ACTION_TYPES.DO_FETCH_TODOS ]() {
+		const response = await apiFetch( {
+			path: REST_PATH,
+			method: 'GET',
+		} );
+		return response?.data || [];
+	},
+};

modules/ppcp-settings/resources/js/data/todos/hooks.js

@@ -0,0 +1,33 @@
+/**
+ * Hooks: Provide the main API for components to interact with the store.
+ *
+ * These encapsulate store interactions, offering a consistent interface.
+ * Hooks simplify data access and manipulation for components.
+ *
+ * @file
+ */
+
+import { useSelect, useDispatch } from '@wordpress/data';
+import { STORE_NAME } from './constants';
+
+const useTransient = ( key ) =>
+	useSelect(
+		( select ) => select( STORE_NAME ).transientData()?.[ key ],
+		[ key ]
+	);
+
+export const useTodos = () => {
+	const todos = useSelect(
+		( select ) => select( STORE_NAME ).getTodos(),
+		[]
+	);
+	const isReady = useTransient( 'isReady' );
+
+	const { fetchTodos } = useDispatch( STORE_NAME );
+
+	return {
+		todos,
+		isReady,
+		fetchTodos,
+	};
+};

modules/ppcp-settings/resources/js/data/todos/index.js

@@ -0,0 +1,32 @@
+import { createReduxStore, register } from '@wordpress/data';
+import { controls as wpControls } from '@wordpress/data-controls';
+
+import { STORE_NAME } from './constants';
+import reducer from './reducer';
+import * as selectors from './selectors';
+import * as actions from './actions';
+import * as hooks from './hooks';
+import { resolvers } from './resolvers';
+import { controls } from './controls';
+
+/**
+ * Initializes and registers the todos store with WordPress data layer.
+ * Combines custom controls with WordPress data controls.
+ *
+ * @return {boolean} True if initialization succeeded, false otherwise.
+ */
+export const initStore = () => {
+	const store = createReduxStore( STORE_NAME, {
+		reducer,
+		controls: { ...wpControls, ...controls },
+		actions,
+		selectors,
+		resolvers,
+	} );
+
+	register( store );
+
+	return Boolean( wp.data.select( STORE_NAME ) );
+};
+
+export { hooks, selectors, STORE_NAME };

modules/ppcp-settings/resources/js/data/todos/reducer.js

@@ -0,0 +1,90 @@
+/**
+ * Reducer: Defines store structure and state updates for todos module.
+ *
+ * Manages both transient (temporary) and persistent (saved) state.
+ * The initial state must define all properties, as dynamic additions are not supported.
+ *
+ * @file
+ */
+
+import { createReducer, createReducerSetters } from '../utils';
+import ACTION_TYPES from './action-types';
+
+// Store structure.
+
+/**
+ * Transient: Values that are _not_ saved to the DB (like app lifecycle-flags).
+ * These reset on page reload.
+ */
+const defaultTransient = Object.freeze( {
+	isReady: false,
+} );
+
+/**
+ * Persistent: Values that are loaded from and saved to the DB.
+ * These represent the core todos configuration.
+ */
+const defaultPersistent = Object.freeze( {
+	todos: [],
+} );
+
+// Reducer logic.
+
+const [ changeTransient, changePersistent ] = createReducerSetters(
+	defaultTransient,
+	defaultPersistent
+);
+
+/**
+ * Reducer implementation mapping actions to state updates.
+ */
+const reducer = createReducer( defaultTransient, defaultPersistent, {
+	/**
+	 * Updates temporary state values
+	 *
+	 * @param {Object} state   Current state
+	 * @param {Object} payload Update payload
+	 * @return {Object} Updated state
+	 */
+	[ ACTION_TYPES.SET_TRANSIENT ]: ( state, payload ) =>
+		changeTransient( state, payload ),
+
+	/**
+	 * Updates todos list
+	 *
+	 * @param {Object} state   Current state
+	 * @param {Object} payload Update payload
+	 * @return {Object} Updated state
+	 */
+	[ ACTION_TYPES.SET_TODOS ]: ( state, payload ) => {
+		return changePersistent( state, { todos: payload } );
+	},
+
+	/**
+	 * Resets state to defaults while maintaining initialization status
+	 *
+	 * @param {Object} state Current state
+	 * @return {Object} Reset state
+	 */
+	[ ACTION_TYPES.RESET ]: ( state ) => {
+		const cleanState = changeTransient(
+			changePersistent( state, defaultPersistent ),
+			defaultTransient
+		);
+		cleanState.isReady = true; // Keep initialization flag
+		return cleanState;
+	},
+
+	/**
+	 * Initializes persistent state with data from the server
+	 *
+	 * @param {Object} state        Current state
+	 * @param {Object} payload      Hydration payload containing server data
+	 * @param {Object} payload.data The todos data to hydrate
+	 * @return {Object} Hydrated state
+	 */
+	[ ACTION_TYPES.HYDRATE ]: ( state, payload ) =>
+		changePersistent( state, payload.data ),
+} );
+
+export default reducer;

modules/ppcp-settings/resources/js/data/todos/resolvers.js

@@ -0,0 +1,35 @@
+/**
+ * Resolvers: Handle asynchronous data fetching for the store.
+ *
+ * These functions update store state with data from external sources.
+ * Each resolver corresponds to a specific selector (selector with same name must exist).
+ * Resolvers are called automatically when selectors request unavailable data.
+ *
+ * @file
+ */
+
+import { dispatch } from '@wordpress/data';
+import { __ } from '@wordpress/i18n';
+import { apiFetch } from '@wordpress/data-controls';
+import { STORE_NAME, REST_PATH } from './constants';
+
+export const resolvers = {
+	*getTodos() {
+		try {
+			const response = yield apiFetch( { path: REST_PATH } );
+
+			// Make sure we're accessing the correct part of the response
+			const todos = response?.data || [];
+
+			yield dispatch( STORE_NAME ).setTodos( todos );
+			yield dispatch( STORE_NAME ).setIsReady( true );
+
+		} catch ( e ) {
+			console.error( 'Resolver error:', e );
+			yield dispatch( STORE_NAME ).setIsReady( false );
+			yield dispatch( 'core/notices' ).createErrorNotice(
+				__( 'Error retrieving todos.', 'woocommerce-paypal-payments' )
+			);
+		}
+	},
+};

modules/ppcp-settings/resources/js/data/todos/selectors.js

@@ -0,0 +1,28 @@
+/**
+ * Selectors: Extract specific pieces of state from the store.
+ *
+ * These functions provide a consistent interface for accessing store data.
+ * They allow components to retrieve data without knowing the store structure.
+ *
+ * @file
+ */
+
+const EMPTY_OBJ = Object.freeze( {} );
+const EMPTY_ARR = Object.freeze( [] );
+
+const getState = ( state ) => state || EMPTY_OBJ;
+
+export const persistentData = ( state ) => {
+	return getState( state ).data || EMPTY_OBJ;
+};
+
+export const transientData = ( state ) => {
+	const { data, ...transientState } = getState( state );
+	return transientState || EMPTY_OBJ;
+};
+
+export const getTodos = ( state ) => {
+	// Access todos directly from state first
+	const todos = state?.todos || persistentData( state ).todos || EMPTY_ARR;
+	return todos;
+};