mirror of
https://github.com/woocommerce/woocommerce-paypal-payments.git
synced 2025-09-05 08:59:14 +08:00
109 lines
2.7 KiB
JavaScript
109 lines
2.7 KiB
JavaScript
/**
|
|
* 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 apiFetch from '@wordpress/api-fetch';
|
|
|
|
import ACTION_TYPES from './action-types';
|
|
import { REST_PERSIST_PATH } from './constants';
|
|
|
|
/**
|
|
* @typedef {Object} Action An action object that is handled by a reducer or control.
|
|
* @property {string} type - The action type.
|
|
* @property {Object?} payload - Optional payload for the action.
|
|
*/
|
|
|
|
/**
|
|
* Special. Resets all values in the store to initial defaults.
|
|
*
|
|
* @return {Action} The action.
|
|
*/
|
|
export const reset = () => ( { type: ACTION_TYPES.RESET } );
|
|
|
|
/**
|
|
* Persistent. Set the full store details during app initialization.
|
|
*
|
|
* @param {{data: {}, flags?: {}}} payload
|
|
* @return {Action} The action.
|
|
*/
|
|
export const hydrate = ( payload ) => ( {
|
|
type: ACTION_TYPES.HYDRATE,
|
|
payload,
|
|
} );
|
|
|
|
/**
|
|
* Generic transient-data updater.
|
|
*
|
|
* @param {string} prop Name of the property to update.
|
|
* @param {any} value The new value of the property.
|
|
* @return {Action} The action.
|
|
*/
|
|
export const setTransient = ( prop, value ) => ( {
|
|
type: ACTION_TYPES.SET_TRANSIENT,
|
|
payload: { [ prop ]: value },
|
|
} );
|
|
|
|
/**
|
|
* Generic persistent-data updater.
|
|
*
|
|
* @param {string} prop Name of the property to update.
|
|
* @param {any} value The new value of the property.
|
|
* @return {Action} The action.
|
|
*/
|
|
export const setPersistent = ( prop, value ) => ( {
|
|
type: ACTION_TYPES.SET_PERSISTENT,
|
|
payload: { [ prop ]: value },
|
|
} );
|
|
|
|
/**
|
|
* Transient. Marks the store as "ready", i.e., fully initialized.
|
|
*
|
|
* @param {boolean} isReady
|
|
* @return {Action} The action.
|
|
*/
|
|
export const setIsReady = ( isReady ) => setTransient( 'isReady', isReady );
|
|
|
|
/**
|
|
* Modify properties of a specific payment method.
|
|
*
|
|
* @param {string} id The payment method ID.
|
|
* @param {Object} props New props.
|
|
* @return {Action} The action.
|
|
*/
|
|
export const changePaymentSettings = ( id, props ) => ( {
|
|
type: ACTION_TYPES.CHANGE_PAYMENT_SETTING,
|
|
payload: { id, props },
|
|
} );
|
|
|
|
/**
|
|
* Thunk action creator. Triggers the persistence of store data to the server.
|
|
*
|
|
* @return {Function} The thunk function.
|
|
*/
|
|
export function persist() {
|
|
return async ( { select } ) => {
|
|
await apiFetch( {
|
|
path: REST_PERSIST_PATH,
|
|
method: 'POST',
|
|
data: select.persistentData(),
|
|
} );
|
|
};
|
|
}
|
|
|
|
/**
|
|
* Thunk action creator. Forces a data refresh from the REST API, replacing the current Redux values.
|
|
*
|
|
* @return {Function} The thunk function.
|
|
*/
|
|
export function refresh() {
|
|
return ( { dispatch, select } ) => {
|
|
dispatch.invalidateResolutionForStoreSelector( 'persistentData' );
|
|
|
|
select.persistentData();
|
|
};
|
|
}
|
