actions.ts
2 years ago
constants.ts
2 years ago
index.ts
2 years ago
reducer.ts
2 years ago
types.ts
2 years ago
actions.ts
195 lines
| 1 | /** |
| 2 | * External dependencies |
| 3 | */ |
| 4 | import apiFetch from '@wordpress/api-fetch'; |
| 5 | /** |
| 6 | * Types & Constants |
| 7 | */ |
| 8 | import { |
| 9 | ACTION_DECREASE_NEW_ASYNC_REQUEST_COUNTDOWN, |
| 10 | ACTION_DEQUEUE_ASYNC_REQUEST, |
| 11 | ACTION_ENQUEUE_ASYNC_REQUEST, |
| 12 | ACTION_FETCH_FROM_API, |
| 13 | ACTION_INCREASE_AI_ASSISTANT_REQUESTS_COUNT, |
| 14 | ACTION_REQUEST_AI_ASSISTANT_FEATURE, |
| 15 | ACTION_SET_PLANS, |
| 16 | ACTION_SET_AI_ASSISTANT_FEATURE_REQUIRE_UPGRADE, |
| 17 | ACTION_STORE_AI_ASSISTANT_FEATURE, |
| 18 | ENDPOINT_AI_ASSISTANT_FEATURE, |
| 19 | NEW_ASYNC_REQUEST_TIMER_INTERVAL, |
| 20 | ACTION_SET_TIER_PLANS_ENABLED, |
| 21 | } from './constants'; |
| 22 | import type { Plan } from './types'; |
| 23 | import type { AiFeatureProps } from './types'; |
| 24 | import type { SiteAIAssistantFeatureEndpointResponseProps } from '../../types'; |
| 25 | |
| 26 | /** |
| 27 | * Map the response from the `sites/$site/ai-assistant-feature` |
| 28 | * endpoint to the AI Assistant feature props. |
| 29 | * @param { SiteAIAssistantFeatureEndpointResponseProps } response - The response from the endpoint. |
| 30 | * @returns { AiFeatureProps } The AI Assistant feature props. |
| 31 | */ |
| 32 | export function mapAiFeatureResponseToAiFeatureProps( |
| 33 | response: SiteAIAssistantFeatureEndpointResponseProps |
| 34 | ): AiFeatureProps { |
| 35 | return { |
| 36 | hasFeature: !! response[ 'has-feature' ], |
| 37 | isOverLimit: !! response[ 'is-over-limit' ], |
| 38 | requestsCount: response[ 'requests-count' ], |
| 39 | requestsLimit: response[ 'requests-limit' ], |
| 40 | requireUpgrade: !! response[ 'site-require-upgrade' ], |
| 41 | errorMessage: response[ 'error-message' ], |
| 42 | errorCode: response[ 'error-code' ], |
| 43 | upgradeType: response[ 'upgrade-type' ], |
| 44 | usagePeriod: { |
| 45 | currentStart: response[ 'usage-period' ]?.[ 'current-start' ], |
| 46 | nextStart: response[ 'usage-period' ]?.[ 'next-start' ], |
| 47 | requestsCount: response[ 'usage-period' ]?.[ 'requests-count' ] || 0, |
| 48 | }, |
| 49 | currentTier: response[ 'current-tier' ], |
| 50 | nextTier: response[ 'next-tier' ], |
| 51 | tierPlansEnabled: !! response[ 'tier-plans-enabled' ], |
| 52 | }; |
| 53 | } |
| 54 | |
| 55 | const actions = { |
| 56 | setPlans( plans: Array< Plan > ) { |
| 57 | return { |
| 58 | type: ACTION_SET_PLANS, |
| 59 | plans, |
| 60 | }; |
| 61 | }, |
| 62 | |
| 63 | fetchFromAPI( url: string ) { |
| 64 | return { |
| 65 | type: ACTION_FETCH_FROM_API, |
| 66 | url, |
| 67 | }; |
| 68 | }, |
| 69 | |
| 70 | storeAiAssistantFeature( feature: AiFeatureProps ) { |
| 71 | return { |
| 72 | type: ACTION_STORE_AI_ASSISTANT_FEATURE, |
| 73 | feature, |
| 74 | }; |
| 75 | }, |
| 76 | |
| 77 | /** |
| 78 | * Thunk action to fetch the AI Assistant feature from the API. |
| 79 | * |
| 80 | * @returns {Function} The thunk action. |
| 81 | */ |
| 82 | fetchAiAssistantFeature() { |
| 83 | return async ( { dispatch } ) => { |
| 84 | // Dispatch isFetching action. |
| 85 | dispatch( { type: ACTION_REQUEST_AI_ASSISTANT_FEATURE } ); |
| 86 | |
| 87 | try { |
| 88 | const response: SiteAIAssistantFeatureEndpointResponseProps = await apiFetch( { |
| 89 | path: ENDPOINT_AI_ASSISTANT_FEATURE, |
| 90 | } ); |
| 91 | |
| 92 | // Store the feature in the store. |
| 93 | dispatch( |
| 94 | actions.storeAiAssistantFeature( mapAiFeatureResponseToAiFeatureProps( response ) ) |
| 95 | ); |
| 96 | } catch ( err ) { |
| 97 | // @todo: Handle error. |
| 98 | console.error( err ); // eslint-disable-line no-console |
| 99 | } |
| 100 | }; |
| 101 | }, |
| 102 | |
| 103 | /** |
| 104 | * This thunk action is used to increase |
| 105 | * the requests count for the current usage period. |
| 106 | * @param {number} count - The number of requests to increase. Default is 1. |
| 107 | * @returns {Function} The thunk action. |
| 108 | */ |
| 109 | increaseAiAssistantRequestsCount( count: number = 1 ) { |
| 110 | return ( { dispatch } ) => { |
| 111 | dispatch( { |
| 112 | type: ACTION_INCREASE_AI_ASSISTANT_REQUESTS_COUNT, |
| 113 | count, |
| 114 | } ); |
| 115 | |
| 116 | // Every time the requests count is increased, decrease the countdown |
| 117 | dispatch( actions.decreaseAsyncRequestCountdownValue() ); |
| 118 | }; |
| 119 | }, |
| 120 | |
| 121 | /** |
| 122 | * This thunk action is used to decrease |
| 123 | * the countdown value for the new async request. |
| 124 | * When the countdown reaches 0, enqueue a new async request. |
| 125 | * |
| 126 | * @returns {Function} The thunk action. |
| 127 | */ |
| 128 | decreaseAsyncRequestCountdownValue() { |
| 129 | return async ( { dispatch, select } ) => { |
| 130 | dispatch( { type: ACTION_DECREASE_NEW_ASYNC_REQUEST_COUNTDOWN } ); |
| 131 | |
| 132 | const asyncCoundown = select.getAsyncRequestCountdownValue(); |
| 133 | if ( asyncCoundown <= 0 ) { |
| 134 | dispatch( actions.enqueueAiAssistantFeatureAyncRequest() ); |
| 135 | } |
| 136 | }; |
| 137 | }, |
| 138 | |
| 139 | /** |
| 140 | * This thunk action is used to enqueue a new async request. |
| 141 | * If already exist an enqueue request, clear it and enqueue a new one. |
| 142 | * |
| 143 | * @returns {Function} The thunk action. |
| 144 | */ |
| 145 | enqueueAiAssistantFeatureAyncRequest() { |
| 146 | return ( { dispatch } ) => { |
| 147 | // Check if there is already a timer running |
| 148 | dispatch.dequeueAiAssistantFeatureAyncRequest(); |
| 149 | |
| 150 | const contdownTimerId = setTimeout( () => { |
| 151 | dispatch( actions.fetchAiAssistantFeature() ); |
| 152 | }, NEW_ASYNC_REQUEST_TIMER_INTERVAL ); // backend process requires a delay to be able to see the new value |
| 153 | |
| 154 | dispatch( { type: ACTION_ENQUEUE_ASYNC_REQUEST, timerId: contdownTimerId } ); |
| 155 | }; |
| 156 | }, |
| 157 | |
| 158 | /** |
| 159 | * This thunk action is used to dequeue a new async request. |
| 160 | * It will clear the timer if there is one, |
| 161 | * canceling the enqueue async request. |
| 162 | * |
| 163 | * @returns {Function} The thunk action. |
| 164 | */ |
| 165 | dequeueAiAssistantFeatureAyncRequest() { |
| 166 | return ( { dispatch, select } ) => { |
| 167 | dispatch( { type: ACTION_DEQUEUE_ASYNC_REQUEST, timerId: 0 } ); |
| 168 | |
| 169 | const timerId = select.getAsyncRequestCountdownTimerId(); |
| 170 | // If there is no timer, there is nothing to clear |
| 171 | if ( ! timerId ) { |
| 172 | return; |
| 173 | } |
| 174 | |
| 175 | window?.clearTimeout( timerId ); |
| 176 | }; |
| 177 | }, |
| 178 | |
| 179 | setAiAssistantFeatureRequireUpgrade( requireUpgrade: boolean = true ) { |
| 180 | return { |
| 181 | type: ACTION_SET_AI_ASSISTANT_FEATURE_REQUIRE_UPGRADE, |
| 182 | requireUpgrade, |
| 183 | }; |
| 184 | }, |
| 185 | |
| 186 | setTierPlansEnabled( tierPlansEnabled: boolean = true ) { |
| 187 | return { |
| 188 | type: ACTION_SET_TIER_PLANS_ENABLED, |
| 189 | tierPlansEnabled, |
| 190 | }; |
| 191 | }, |
| 192 | }; |
| 193 | |
| 194 | export default actions; |
| 195 |