@automattic/jetpack-ai-client 0.16.1 → 0.16.3

package/src/hooks/use-ai-suggestions/index.ts

@@ -134,7 +134,7 @@ type useAiSuggestionsProps = {
  * Get the error data for a given error code.
  *
  * @param {SuggestionErrorCode} errorCode - The error code.
- * @returns {RequestingErrorProps}          The error data.
+ * @return {RequestingErrorProps}          The error data.
  */
 export function getErrorData( errorCode: SuggestionErrorCode ): RequestingErrorProps {
 	switch ( errorCode ) {
@@ -194,7 +194,7 @@ export function getErrorData( errorCode: SuggestionErrorCode ): RequestingErrorP
  * Remove the llama artifact from a suggestion.
  *
  * @param {string} suggestion - The suggestion.
- * @returns {string}            The suggestion without the llama artifact.
+ * @return {string}            The suggestion without the llama artifact.
  */
 export function removeLlamaArtifact( suggestion: string ): string {
 	return suggestion.replace( /^<\|start_header_id\|>assistant<\|end_header_id\|>[\n]+/, '' );
@@ -205,7 +205,7 @@ export function removeLlamaArtifact( suggestion: string ): string {
  * by hitting the query endpoint.
  *
  * @param {useAiSuggestionsOptions} options - The options for the hook.
- * @returns {useAiSuggestionsProps}           The props for the hook.
+ * @return {useAiSuggestionsProps}           The props for the hook.
  */
 export default function useAiSuggestions( {
 	prompt,
@@ -230,7 +230,7 @@ export default function useAiSuggestions( {
 	 * onSuggestion function handler.
 	 *
 	 * @param {string} suggestion - The suggestion.
-	 * @returns {void}
+	 * @return {void}
 	 */
 	const handleSuggestion = useCallback(
 		( event: CustomEvent ) => {
@@ -250,7 +250,7 @@ export default function useAiSuggestions( {
 	 * onDone function handler.
 	 *
 	 * @param {string} content - The content.
-	 * @returns {void}
+	 * @return {void}
 	 */
 	const handleDone = useCallback(
 		( event: CustomEvent ) => {
@@ -300,9 +300,9 @@ export default function useAiSuggestions( {
 	/**
 	 * Request handler.
 	 *
-	 * @param {PromptProp} promptArg               - The messages array of the prompt.
-	 * @param {AskQuestionOptionsArgProps} options - The options for the askQuestion request. Uses the hook's askQuestionOptions by default.
-	 * @returns {Promise<void>} The promise.
+	 * @param {PromptProp}                 promptArg - The messages array of the prompt.
+	 * @param {AskQuestionOptionsArgProps} options   - The options for the askQuestion request. Uses the hook's askQuestionOptions by default.
+	 * @return {Promise<void>} The promise.
 	 */
 	const request = useCallback(
 		async (
@@ -352,7 +352,7 @@ export default function useAiSuggestions( {
 	/**
 	 * Reset the request state.
 	 *
-	 * @returns {void}
+	 * @return {void}
 	 */
 	const reset = useCallback( () => {
 		setRequestingState( 'init' );
@@ -363,7 +363,7 @@ export default function useAiSuggestions( {
 	/**
 	 * Close the event source connection.
 	 *
-	 * @returns {void}
+	 * @return {void}
 	 */
 	const closeEventSource = useCallback( () => {
 		if ( ! eventSourceRef?.current ) {
@@ -400,7 +400,7 @@ export default function useAiSuggestions( {
 	/**
 	 * Stop suggestion handler.
 	 *
-	 * @returns {void}
+	 * @return {void}
 	 */
 	const stopSuggestion = useCallback( () => {
 		closeEventSource();

package/src/hooks/use-audio-transcription/index.ts

@@ -49,7 +49,7 @@ type AudioTranscriptionErrorResponse = {
 /**
  * Map error response to a string.
  * @param {Error | string | AudioTranscriptionErrorResponse} error - The error response from the audio transcription service.
- * @returns {string} the translated error message
+ * @return {string} the translated error message
  */
 const mapErrorResponse = ( error: Error | string | AudioTranscriptionErrorResponse ): string => {
 	if ( typeof error === 'string' ) {
@@ -92,7 +92,7 @@ const mapErrorResponse = ( error: Error | string | AudioTranscriptionErrorRespon
  * A hook to handle audio transcription.
  *
  * @param {string} feature - The feature name that is calling the transcription.
- * @returns {UseAudioTranscriptionReturn} - Object with properties to get the transcription data.
+ * @return {UseAudioTranscriptionReturn} - Object with properties to get the transcription data.
  */
 export default function useAudioTranscription( {
 	feature,

package/src/hooks/use-audio-validation/index.ts

@@ -45,7 +45,7 @@ export type ValidatedAudioInformation = {
 /**
  * Hook to handle the validation of an audio file.
  *
- * @returns {UseAudioValidationReturn} - Object with the audio validation state and the function to validate the audio.
+ * @return {UseAudioValidationReturn} - Object with the audio validation state and the function to validate the audio.
  */
 export default function useAudioValidation(): UseAudioValidationReturn {
 	const [ isValidatingAudio, setIsValidatingAudio ] = useState< boolean >( false );

package/src/hooks/use-image-generator/index.ts

@@ -19,9 +19,9 @@ type ImageGenerationResponse = {
 
 /**
  * Cut the post content on a given lenght so the total length of the prompt is not longer than 4000 characters.
- * @param {string} content - the content to be truncated
+ * @param {string} content             - the content to be truncated
  * @param {number} currentPromptLength - the length of the prompt already in use
- * @returns {string} a truncated version of the content respecting the prompt length limit
+ * @return {string} a truncated version of the content respecting the prompt length limit
  */
 const truncateContent = ( content: string, currentPromptLength: number ): string => {
 	const maxLength = 4000;
@@ -35,8 +35,8 @@ const truncateContent = ( content: string, currentPromptLength: number ): string
 /**
  * Create the prompt string based on the provided context.
  * @param {string} postContent - the content of the post
- * @param {string} userPrompt - the user prompt for the image generation, if provided. Max length is 1000 characters, will be truncated.
- * @returns {string} the prompt string
+ * @param {string} userPrompt  - the user prompt for the image generation, if provided. Max length is 1000 characters, will be truncated.
+ * @return {string} the prompt string
  */
 const getDalleImageGenerationPrompt = ( postContent: string, userPrompt?: string ): string => {
 	/**
@@ -89,8 +89,8 @@ This is the post content:
 /**
  * Create the Stable Diffusion pre-processing prompt based on the provided context.
  * @param {string} postContent - the content of the post.
- * @param {string} userPrompt - the user prompt for the image generation, if provided. Max length is 1000 characters, will be truncated.
- * @returns {string} the prompt string to be fed to the AI Assistant model.
+ * @param {string} userPrompt  - the user prompt for the image generation, if provided. Max length is 1000 characters, will be truncated.
+ * @return {string} the prompt string to be fed to the AI Assistant model.
  */
 const getStableDiffusionPreProcessingPrompt = (
 	postContent: string,
@@ -134,9 +134,9 @@ Return just the prompt, without comments. The content is:
 /**
  * Uses the Jetpack AI query endpoint to produce a prompt for the stable diffusion model.
  * @param {string} postContent - the content of the post.
- * @param {string} userPrompt - the user prompt for the image generation, if provided. Max length is 1000 characters, will be truncated
- * @param {string} feature - the feature to be used for the image generation.
- * @returns {string} the prompt string to be used on stable diffusion image generation.
+ * @param {string} userPrompt  - the user prompt for the image generation, if provided. Max length is 1000 characters, will be truncated
+ * @param {string} feature     - the feature to be used for the image generation.
+ * @return {string} the prompt string to be used on stable diffusion image generation.
  */
 const getStableDiffusionImageGenerationPrompt = async (
 	postContent: string,

package/src/hooks/use-media-recording/index.ts

@@ -84,7 +84,7 @@ type MediaRecorderEvent = {
  * react custom hook to handle media recording.
  *
  * @param {UseMediaRecordingProps} props - The props
- * @returns {UseMediaRecordingReturn} The media recorder instance
+ * @return {UseMediaRecordingReturn} The media recorder instance
  */
 export default function useMediaRecording( {
 	onDone,
@@ -118,7 +118,7 @@ export default function useMediaRecording( {
 	/**
 	 * Get the recorded blob.
 	 *
-	 * @returns {Blob} The recorded blob
+	 * @return {Blob} The recorded blob
 	 */
 	function getBlob() {
 		if ( MediaRecorder.isTypeSupported( MEDIA_TYPE_MP4_MP4A ) ) {
@@ -265,7 +265,7 @@ export default function useMediaRecording( {
 	 * `stop` event listener for the media recorder instance.
 	 * Happens after the last `dataavailable` event.
 	 *
-	 * @returns {void}
+	 * @return {void}
 	 */
 	function onStopListener(): void {
 		const lastBlob = getBlob();
@@ -293,7 +293,7 @@ export default function useMediaRecording( {
 	 * `dataavailable` event listener for the media recorder instance.
 	 *
 	 * @param {MediaRecorderEvent} event - The event object
-	 * @returns {void}
+	 * @return {void}
 	 */
 	function onDataAvailableListener( event: MediaRecorderEvent ): void {
 		const { data } = event;

package/src/hooks/use-save-to-media-library/index.ts

@@ -15,7 +15,7 @@ const debug = debugFactory( 'ai-client:save-to-media-library' );
 /**
  * Hook to save an image to the media library.
  *
- * @returns {object} Object with the loading state and the function to save the image to the media library.
+ * @return {object} Object with the loading state and the function to save the image to the media library.
  */
 export default function useSaveToMediaLibrary() {
 	const [ isLoading, setIsLoading ] = useState( false );

package/src/hooks/use-transcription-post-processing/index.ts

@@ -42,7 +42,7 @@ export type UseTranscriptionPostProcessingProps = {
  * A hook to handle transcription post-processing.
  *
  * @param {string} feature - The feature name that is calling the post-processing actions.
- * @returns {UseTranscriptionPostProcessingReturn} - Object with properties to get the post-processing results.
+ * @return {UseTranscriptionPostProcessingReturn} - Object with properties to get the post-processing results.
  */
 export default function useTranscriptionPostProcessing( {
 	feature,

package/src/jwt/index.ts

@@ -37,7 +37,7 @@ const JWT_TOKEN_EXPIRATION_TIME = 2 * 60 * 1000; // 2 minutes
  * Request a token from the Jetpack site.
  *
  * @param {RequestTokenOptions} options - Options
- * @returns {Promise<TokenDataProps>}     The token and the blogId
+ * @return {Promise<TokenDataProps>}     The token and the blogId
  */
 export default async function requestJwt( {
 	apiNonce,

package/src/libs/markdown/html-to-markdown.ts

@@ -61,7 +61,7 @@ export default class HTMLToMarkdown {
 	 * Renders HTML from Markdown content with specified processing rules.
 	 * @param {object} options         - The options to use when rendering the Markdown content
 	 * @param {string} options.content - The HTML content to render
-	 * @returns {string}                 The rendered Markdown content
+	 * @return {string}                 The rendered Markdown content
 	 */
 	render( { content }: { content: string } ): string {
 		const rendered = this.turndownService.turndown( content );

package/src/libs/markdown/markdown-to-html.ts

@@ -96,11 +96,11 @@ export default class MarkdownToHTML {
 
 	/**
 	 * Renders HTML from Markdown content with specified processing rules.
-	 * @param {object} options            - The options to use when rendering the HTML content
-	 * @param {string} options.content    - The Markdown content to render
-	 * @param {string} options.rules      - The rules to apply to the rendered content
+	 * @param {object}  options           - The options to use when rendering the HTML content
+	 * @param {string}  options.content   - The Markdown content to render
+	 * @param {string}  options.rules     - The rules to apply to the rendered content
 	 * @param {boolean} options.extension - Whether to apply the extension-specific rules
-	 * @returns {string}                    The rendered HTML content
+	 * @return {string}                    The rendered HTML content
 	 */
 	render( {
 		content,

package/src/logo-generator/lib/logo-storage.ts

@@ -10,13 +10,13 @@ const MAX_LOGOS = 10;
 /**
  * Add an entry to the site's logo history.
  *
- * @param {SaveToStorageProps} saveToStorageProps - The properties to save to storage
- * @param {SaveToStorageProps.siteId} saveToStorageProps.siteId - The site ID
- * @param {SaveToStorageProps.url} saveToStorageProps.url - The URL of the logo
+ * @param {SaveToStorageProps}             saveToStorageProps             - The properties to save to storage
+ * @param {SaveToStorageProps.siteId}      saveToStorageProps.siteId      - The site ID
+ * @param {SaveToStorageProps.url}         saveToStorageProps.url         - The URL of the logo
  * @param {SaveToStorageProps.description} saveToStorageProps.description - The description of the logo, based on the prompt used to generate it
- * @param {SaveToStorageProps.mediaId} saveToStorageProps.mediaId - The media ID of the logo on the backend
+ * @param {SaveToStorageProps.mediaId}     saveToStorageProps.mediaId     - The media ID of the logo on the backend
  *
- * @returns {Logo} The logo that was saved
+ * @return {Logo} The logo that was saved
  */
 export function stashLogo( { siteId, url, description, mediaId }: SaveToStorageProps ) {
 	const storedContent = getSiteLogoHistory( siteId );
@@ -40,12 +40,12 @@ export function stashLogo( { siteId, url, description, mediaId }: SaveToStorageP
 /**
  * Update an entry in the site's logo history.
  *
- * @param {UpdateInStorageProps} updateInStorageProps - The properties to update in storage
- * @param {UpdateInStorageProps.siteId} updateInStorageProps.siteId - The site ID
- * @param {UpdateInStorageProps.url} updateInStorageProps.url - The URL of the logo to update
- * @param {UpdateInStorageProps.newUrl} updateInStorageProps.newUrl - The new URL of the logo
+ * @param {UpdateInStorageProps}         updateInStorageProps         - The properties to update in storage
+ * @param {UpdateInStorageProps.siteId}  updateInStorageProps.siteId  - The site ID
+ * @param {UpdateInStorageProps.url}     updateInStorageProps.url     - The URL of the logo to update
+ * @param {UpdateInStorageProps.newUrl}  updateInStorageProps.newUrl  - The new URL of the logo
  * @param {UpdateInStorageProps.mediaId} updateInStorageProps.mediaId - The new media ID of the logo
- * @returns {Logo} The logo that was updated
+ * @return {Logo} The logo that was updated
  */
 export function updateLogo( { siteId, url, newUrl, mediaId }: UpdateInStorageProps ) {
 	const storedContent = getSiteLogoHistory( siteId );
@@ -69,7 +69,7 @@ export function updateLogo( { siteId, url, newUrl, mediaId }: UpdateInStoragePro
  * Get the logo history for a site.
  *
  * @param {string} siteId - The site ID to get the logo history for
- * @returns {Logo[]} The logo history for the site
+ * @return {Logo[]} The logo history for the site
  */
 export function getSiteLogoHistory( siteId: string ) {
 	const storedString = localStorage.getItem( `logo-history-${ siteId }` );
@@ -104,8 +104,8 @@ export function getSiteLogoHistory( siteId: string ) {
 /**
  * Check if the logo history for a site is empty.
  *
- * @param {string }siteId - The site ID to check the logo history for
- * @returns {boolean} Whether the logo history for the site is empty
+ * @param {string } siteId - The site ID to check the logo history for
+ * @return {boolean} Whether the logo history for the site is empty
  */
 export function isLogoHistoryEmpty( siteId: string ) {
 	const storedContent = getSiteLogoHistory( siteId );
@@ -116,10 +116,10 @@ export function isLogoHistoryEmpty( siteId: string ) {
 /**
  * Remove an entry from the site's logo history.
  *
- * @param {RemoveFromStorageProps} removeFromStorageProps - The properties to remove from storage
- * @param {RemoveFromStorageProps.siteId} removeFromStorageProps.siteId - The site ID
+ * @param {RemoveFromStorageProps}         removeFromStorageProps         - The properties to remove from storage
+ * @param {RemoveFromStorageProps.siteId}  removeFromStorageProps.siteId  - The site ID
  * @param {RemoveFromStorageProps.mediaId} removeFromStorageProps.mediaId - The media ID of the logo to remove
- * @returns {void}
+ * @return {void}
  */
 export function removeLogo( { siteId, mediaId }: RemoveFromStorageProps ) {
 	const storedContent = getSiteLogoHistory( siteId );
@@ -137,7 +137,7 @@ export function removeLogo( { siteId, mediaId }: RemoveFromStorageProps ) {
  * Clear deleted media from the site's logo history, checking if the media still exists on the backend.
  *
  * @param {string} siteId - The site ID to clear deleted media for
- * @returns {Promise<void>}
+ * @return {Promise<void>}
  */
 export async function clearDeletedMedia( siteId: string ) {
 	const storedContent = getSiteLogoHistory( siteId );

package/src/logo-generator/lib/media-exists.ts

@@ -10,9 +10,9 @@ import type { CheckMediaProps } from '../types.js';
 /**
  * Uses the media information to confirm it exists or not on the server.
  *
- * @param {CheckMediaProps} checkMediaProps - the media details to check
+ * @param {CheckMediaProps}         checkMediaProps         - the media details to check
  * @param {CheckMediaProps.mediaId} checkMediaProps.mediaId - the id of the media to check
- * @returns {Promise<boolean>} - true if the media exists, false otherwise
+ * @return {Promise<boolean>} - true if the media exists, false otherwise
  */
 export async function mediaExists( { mediaId }: CheckMediaProps ): Promise< boolean > {
 	const id = Number( mediaId );

package/src/logo-generator/lib/set-site-logo.ts

@@ -10,10 +10,10 @@ import type { SetSiteLogoProps, SetSiteLogoResponseProps } from '../types.js';
 /**
  * Set the site logo using a backend request.
  *
- * @param {SetSiteLogoProps} setSiteLogoProps - The properties to set the site logo
- * @param {SetSiteLogoProps.siteId} setSiteLogoProps.siteId - The site ID
+ * @param {SetSiteLogoProps}         setSiteLogoProps         - The properties to set the site logo
+ * @param {SetSiteLogoProps.siteId}  setSiteLogoProps.siteId  - The site ID
  * @param {SetSiteLogoProps.imageId} setSiteLogoProps.imageId - The image ID to set as the site logo
- * @returns {Promise<SetSiteLogoResponseProps>} The response from the request
+ * @return {Promise<SetSiteLogoResponseProps>} The response from the request
  */
 export async function setSiteLogo( { siteId, imageId }: SetSiteLogoProps ) {
 	const body = {

package/src/logo-generator/lib/wpcom-limited-request.ts

@@ -13,7 +13,7 @@ let concurrentCounter = 0;
 /**
  * Concurrency-limited request to wpcom-proxy-request.
  * @param { object } params - The request params, as expected by apiFetch.
- * @returns { Promise }                   The response.
+ * @return { Promise }                   The response.
  * @throws { Error }                      If there are too many concurrent requests.
  */
 export default async function wpcomLimitedRequest< T >( params: object ): Promise< T > {

package/src/logo-generator/store/actions.ts

@@ -41,7 +41,7 @@ import type { SiteDetails } from '../types.js';
  * Map the response from the `sites/$site/ai-assistant-feature`
  * endpoint to the AI Assistant feature props.
  * @param { AiAssistantFeatureEndpointResponseProps } response - The response from the endpoint.
- * @returns { AiFeatureProps }                                       The AI Assistant feature props.
+ * @return { AiFeatureProps }                                       The AI Assistant feature props.
  */
 export function mapAiFeatureResponseToAiFeatureProps(
 	response: AiAssistantFeatureEndpointResponseProps
@@ -77,7 +77,7 @@ const actions = {
 
 	/**
 	 * Thunk action to fetch the AI Assistant feature from the API.
-	 * @returns {Function} The thunk action.
+	 * @return {Function} The thunk action.
 	 */
 	fetchAiAssistantFeature() {
 		// eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -106,7 +106,7 @@ const actions = {
 	 * This thunk action is used to increase
 	 * the requests count for the current usage period.
 	 * @param {number} count - The number of requests to increase. Default is 1.
-	 * @returns {Function}     The thunk action.
+	 * @return {Function}     The thunk action.
 	 */
 	increaseAiAssistantRequestsCount( count: number = 1 ) {
 		// eslint-disable-next-line @typescript-eslint/no-explicit-any

package/src/logo-generator/store/reducer.ts

@@ -40,28 +40,28 @@ import type { SiteDetails } from '../types.js';
 /**
  * Reducer for the Logo Generator store.
  *
- * @param {LogoGeneratorStateProp} state - The current state
- * @param {object} action - The action to apply, as described by the properties below
- * @param {string} action.type - The action type
- * @param {AiFeatureStateProps} action.feature - The AI Assistant feature state
- * @param {number} action.count - The number of requests to increase the counter by
- * @param {boolean} action.requireUpgrade - Whether an upgrade is required
- * @param {boolean} action.tierPlansEnabled - Whether tier plans are enabled
- * @param {SiteDetails} action.siteDetails - The site details
- * @param {number} action.selectedLogoIndex - The selected logo index
- * @param {boolean} action.isSavingLogoToLibrary - Whether a logo is being saved to the library
- * @param {boolean} action.isApplyingLogo - Whether a logo is being applied
- * @param {object} action.logo - The logo to save, as described by the properties below
- * @param {string} action.logo.url - The logo URL
- * @param {string} action.logo.description - The logo description
- * @param {number} action.mediaId - The media ID from backend
- * @param {string} action.url - The URL to save
- * @param {boolean} action.isRequestingImage - Whether an image is being requested
- * @param {boolean} action.isEnhancingPrompt - Whether a prompt enhancement is being requested
- * @param {Array< { url: string; description: string; mediaId?: number } >} action.history - The logo history
- * @param {RequestError} action.error - The error to set
- * @param {string} action.context - The context where the tool is being used
- * @returns {LogoGeneratorStateProp} The new state
+ * @param {LogoGeneratorStateProp}                                          state                        - The current state
+ * @param {object}                                                          action                       - The action to apply, as described by the properties below
+ * @param {string}                                                          action.type                  - The action type
+ * @param {AiFeatureStateProps}                                             action.feature               - The AI Assistant feature state
+ * @param {number}                                                          action.count                 - The number of requests to increase the counter by
+ * @param {boolean}                                                         action.requireUpgrade        - Whether an upgrade is required
+ * @param {boolean}                                                         action.tierPlansEnabled      - Whether tier plans are enabled
+ * @param {SiteDetails}                                                     action.siteDetails           - The site details
+ * @param {number}                                                          action.selectedLogoIndex     - The selected logo index
+ * @param {boolean}                                                         action.isSavingLogoToLibrary - Whether a logo is being saved to the library
+ * @param {boolean}                                                         action.isApplyingLogo        - Whether a logo is being applied
+ * @param {object}                                                          action.logo                  - The logo to save, as described by the properties below
+ * @param {string}                                                          action.logo.url              - The logo URL
+ * @param {string}                                                          action.logo.description      - The logo description
+ * @param {number}                                                          action.mediaId               - The media ID from backend
+ * @param {string}                                                          action.url                   - The URL to save
+ * @param {boolean}                                                         action.isRequestingImage     - Whether an image is being requested
+ * @param {boolean}                                                         action.isEnhancingPrompt     - Whether a prompt enhancement is being requested
+ * @param {Array< { url: string; description: string; mediaId?: number } >} action.history               - The logo history
+ * @param {RequestError}                                                    action.error                 - The error to set
+ * @param {string}                                                          action.context               - The context where the tool is being used
+ * @return {LogoGeneratorStateProp} The new state
  */
 export default function reducer(
 	state = INITIAL_STATE,

package/src/logo-generator/store/selectors.ts

@@ -9,7 +9,7 @@ const selectors = {
 	/**
 	 * Return the AI Assistant feature.
 	 * @param {LogoGeneratorStateProp} state - The app state tree.
-	 * @returns {Partial<AiFeatureProps>}      The AI Assistant feature data.
+	 * @return {Partial<AiFeatureProps>}      The AI Assistant feature data.
 	 */
 	getAiAssistantFeature( state: LogoGeneratorStateProp ): Partial< AiFeatureProps > {
 		// Clean up the _meta property.
@@ -21,8 +21,8 @@ const selectors = {
 
 	/**
 	 * Return the site details.
-	 * @param {LogoGeneratorStateProp} state       - The app state tree.
-	 * @returns {Partial<SiteDetails> | undefined}   The site details.
+	 * @param {LogoGeneratorStateProp} state - The app state tree.
+	 * @return {Partial<SiteDetails> | undefined}   The site details.
 	 */
 	getSiteDetails( state: LogoGeneratorStateProp ): Partial< SiteDetails > | undefined {
 		return state.siteDetails;
@@ -31,7 +31,7 @@ const selectors = {
 	/**
 	 * Get the isRequesting flag for the AI Assistant feature.
 	 * @param {LogoGeneratorStateProp} state - The app state tree.
-	 * @returns {boolean}                      The isRequesting flag.
+	 * @return {boolean}                      The isRequesting flag.
 	 */
 	getIsRequestingAiAssistantFeature( state: LogoGeneratorStateProp ): boolean {
 		return state.features.aiAssistantFeature?._meta?.isRequesting ?? false;
@@ -40,7 +40,7 @@ const selectors = {
 	/**
 	 * Get the logos history.
 	 * @param {LogoGeneratorStateProp} state - The app state tree.
-	 * @returns {Array<Logo>}                  The logos history array.
+	 * @return {Array<Logo>}                  The logos history array.
 	 */
 	getLogos( state: LogoGeneratorStateProp ): Array< Logo > {
 		return state.history ?? [];
@@ -49,7 +49,7 @@ const selectors = {
 	/**
 	 * Get the selected logo index.
 	 * @param {LogoGeneratorStateProp} state - The app state tree.
-	 * @returns {number | null}                The selected logo index.
+	 * @return {number | null}                The selected logo index.
 	 */
 	getSelectedLogoIndex( state: LogoGeneratorStateProp ): number | null {
 		return state.selectedLogoIndex ?? null;
@@ -58,7 +58,7 @@ const selectors = {
 	/**
 	 * Get the selected logo.
 	 * @param {LogoGeneratorStateProp} state - The app state tree.
-	 * @returns {Logo}                         The selected logo.
+	 * @return {Logo}                         The selected logo.
 	 */
 	getSelectedLogo( state: LogoGeneratorStateProp ): Logo {
 		return state.history?.[ state.selectedLogoIndex ] ?? null;
@@ -67,7 +67,7 @@ const selectors = {
 	/**
 	 * Get the isSavingToLibrary flag.
 	 * @param {LogoGeneratorStateProp} state - The app state tree.
-	 * @returns {boolean}                      The isSavingToLibrary flag.
+	 * @return {boolean}                      The isSavingToLibrary flag.
 	 */
 	getIsSavingLogoToLibrary( state: LogoGeneratorStateProp ): boolean {
 		return state._meta?.isSavingLogoToLibrary ?? false;
@@ -76,7 +76,7 @@ const selectors = {
 	/**
 	 * Get the isApplyingLogo flag.
 	 * @param {LogoGeneratorStateProp} state - The app state tree.
-	 * @returns {boolean}                      The isApplyingLogo flag.
+	 * @return {boolean}                      The isApplyingLogo flag.
 	 */
 	getIsApplyingLogo( state: LogoGeneratorStateProp ): boolean {
 		return state._meta?.isApplyingLogo ?? false;
@@ -85,7 +85,7 @@ const selectors = {
 	/**
 	 * Get the isEnhancingPrompt flag.
 	 * @param {LogoGeneratorStateProp} state - The app state tree.
-	 * @returns {boolean}                      The isEnhancingPrompt flag.
+	 * @return {boolean}                      The isEnhancingPrompt flag.
 	 */
 	getIsEnhancingPrompt( state: LogoGeneratorStateProp ): boolean {
 		return state._meta?.isEnhancingPrompt ?? false;
@@ -94,7 +94,7 @@ const selectors = {
 	/**
 	 * Get the isRequestingImage flag.
 	 * @param {LogoGeneratorStateProp} state - The app state tree.
-	 * @returns {boolean}                      The isRequestingImage flag.
+	 * @return {boolean}                      The isRequestingImage flag.
 	 */
 	getIsRequestingImage( state: LogoGeneratorStateProp ): boolean {
 		return state._meta?.isRequestingImage ?? false;
@@ -103,7 +103,7 @@ const selectors = {
 	/**
 	 * Get an aggregated isBusy flag, based on the loading states of the app.
 	 * @param {LogoGeneratorStateProp} state - The app state tree.
-	 * @returns {boolean}                      The isBusy flag.
+	 * @return {boolean}                      The isBusy flag.
 	 */
 	getIsBusy( state: LogoGeneratorStateProp ): boolean {
 		return (
@@ -117,7 +117,7 @@ const selectors = {
 	/**
 	 * Get the requireUpgrade value from aiAssistantFeature
 	 * @param {LogoGeneratorStateProp} state - The app state tree.
-	 * @returns {boolean}                      The requireUpgrade flag.
+	 * @return {boolean}                      The requireUpgrade flag.
 	 */
 	getRequireUpgrade( state: LogoGeneratorStateProp ): boolean {
 		const feature = state.features.aiAssistantFeature;
@@ -137,7 +137,7 @@ const selectors = {
 	/**
 	 * Get the featureFetchError value.
 	 * @param {LogoGeneratorStateProp} state - The app state tree.
-	 * @returns {RequestError}                 The featureFetchError value.
+	 * @return {RequestError}                 The featureFetchError value.
 	 */
 	getFeatureFetchError( state: LogoGeneratorStateProp ): RequestError {
 		return state._meta?.featureFetchError ?? null;
@@ -146,7 +146,7 @@ const selectors = {
 	/**
 	 * Get the firstLogoPromptFetchError value.
 	 * @param {LogoGeneratorStateProp} state - The app state tree.
-	 * @returns {RequestError}                 The firstLogoPromptFetchError value.
+	 * @return {RequestError}                 The firstLogoPromptFetchError value.
 	 */
 	getFirstLogoPromptFetchError( state: LogoGeneratorStateProp ): RequestError {
 		return state._meta?.firstLogoPromptFetchError ?? null;
@@ -155,7 +155,7 @@ const selectors = {
 	/**
 	 * Get the enhancePromptFetchError value.
 	 * @param {LogoGeneratorStateProp} state - The app state tree.
-	 * @returns {RequestError}                 The enhancePromptFetchError value.
+	 * @return {RequestError}                 The enhancePromptFetchError value.
 	 */
 	getEnhancePromptFetchError( state: LogoGeneratorStateProp ): RequestError {
 		return state._meta?.enhancePromptFetchError ?? null;
@@ -164,7 +164,7 @@ const selectors = {
 	/**
 	 * Get the logoFetchError value.
 	 * @param {LogoGeneratorStateProp} state - The app state tree.
-	 * @returns {RequestError}                 The logoFetchError value.
+	 * @return {RequestError}                 The logoFetchError value.
 	 */
 	getLogoFetchError( state: LogoGeneratorStateProp ): RequestError {
 		return state._meta?.logoFetchError ?? null;
@@ -173,7 +173,7 @@ const selectors = {
 	/**
 	 * Get the saveToLibraryError value.
 	 * @param {LogoGeneratorStateProp} state - The app state tree.
-	 * @returns {RequestError}                 The saveToLibraryError value.
+	 * @return {RequestError}                 The saveToLibraryError value.
 	 */
 	getSaveToLibraryError( state: LogoGeneratorStateProp ): RequestError {
 		return state._meta?.saveToLibraryError ?? null;
@@ -182,7 +182,7 @@ const selectors = {
 	/**
 	 * Get the logoUpdateError value.
 	 * @param {LogoGeneratorStateProp} state - The app state tree.
-	 * @returns {RequestError}                 The logoUpdateError value.
+	 * @return {RequestError}                 The logoUpdateError value.
 	 */
 	getLogoUpdateError( state: LogoGeneratorStateProp ): RequestError {
 		return state._meta?.logoUpdateError ?? null;
@@ -191,7 +191,7 @@ const selectors = {
 	/**
 	 * Get the context value.
 	 * @param {LogoGeneratorStateProp} state - The app state tree.
-	 * @returns {string}                       The context value.
+	 * @return {string}                       The context value.
 	 */
 	getContext( state: LogoGeneratorStateProp ): string {
 		return state._meta?.context ?? '';

package/src/suggestions-event-source/index.ts

@@ -53,7 +53,7 @@ const debug = debugFactory( 'jetpack-ai-client:suggestions-event-source' );
  * when the stream is closed.
  * It also emits a 'suggestion' event with the full suggestion received so far
  *
- * @returns {EventSource} The event source
+ * @return {EventSource} The event source
  * @fires SuggestionsEventSource#suggestion                - The full suggestion has been received so far
  * @fires SuggestionsEventSource#message                   - A message has been received
  * @fires SuggestionsEventSource#chunk                     - A chunk of data has been received