@automattic/jetpack-ai-client 0.16.1 → 0.16.3

package/build/logo-generator/store/selectors.d.ts

@@ -4,115 +4,115 @@ declare 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>;
     /**
      * 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;
     /**
      * 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;
     /**
      * 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>;
     /**
      * 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;
     /**
      * 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;
     /**
      * 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;
     /**
      * 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;
     /**
      * 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;
     /**
      * 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;
     /**
      * 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;
     /**
      * 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;
     /**
      * 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;
     /**
      * 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;
     /**
      * 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;
     /**
      * 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;
     /**
      * 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;
     /**
      * 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;
     /**
      * 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;
 };

package/build/logo-generator/store/selectors.js

@@ -6,7 +6,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) {
         // Clean up the _meta property.
@@ -16,8 +16,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) {
         return state.siteDetails;
@@ -25,7 +25,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) {
         return state.features.aiAssistantFeature?._meta?.isRequesting ?? false;
@@ -33,7 +33,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) {
         return state.history ?? [];
@@ -41,7 +41,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) {
         return state.selectedLogoIndex ?? null;
@@ -49,7 +49,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) {
         return state.history?.[state.selectedLogoIndex] ?? null;
@@ -57,7 +57,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) {
         return state._meta?.isSavingLogoToLibrary ?? false;
@@ -65,7 +65,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) {
         return state._meta?.isApplyingLogo ?? false;
@@ -73,7 +73,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) {
         return state._meta?.isEnhancingPrompt ?? false;
@@ -81,7 +81,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) {
         return state._meta?.isRequestingImage ?? false;
@@ -89,7 +89,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) {
         return (selectors.getIsApplyingLogo(state) ||
@@ -100,7 +100,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) {
         const feature = state.features.aiAssistantFeature;
@@ -116,7 +116,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) {
         return state._meta?.featureFetchError ?? null;
@@ -124,7 +124,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) {
         return state._meta?.firstLogoPromptFetchError ?? null;
@@ -132,7 +132,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) {
         return state._meta?.enhancePromptFetchError ?? null;
@@ -140,7 +140,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) {
         return state._meta?.logoFetchError ?? null;
@@ -148,7 +148,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) {
         return state._meta?.saveToLibraryError ?? null;
@@ -156,7 +156,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) {
         return state._meta?.logoUpdateError ?? null;
@@ -164,7 +164,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) {
         return state._meta?.context ?? '';

package/build/suggestions-event-source/index.d.ts

@@ -25,7 +25,7 @@ type FunctionCallProps = {
  * 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

package/build/suggestions-event-source/index.js

@@ -19,7 +19,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

package/package.json

@@ -1,7 +1,7 @@
 {
 	"private": false,
 	"name": "@automattic/jetpack-ai-client",
-	"version": "0.16.1",
+	"version": "0.16.3",
 	"description": "A JS client for consuming Jetpack AI services",
 	"homepage": "https://github.com/Automattic/jetpack/tree/HEAD/projects/js-packages/ai-client/#readme",
 	"bugs": {
@@ -23,14 +23,15 @@
 	},
 	"type": "module",
 	"devDependencies": {
-		"@storybook/addon-actions": "8.1.6",
-		"@storybook/blocks": "8.1.6",
-		"@storybook/preview-api": "8.1.6",
-		"@storybook/react": "8.1.6",
-		"@types/markdown-it": "14.0.1",
-		"@types/turndown": "5.0.4",
+		"@storybook/addon-actions": "8.2.9",
+		"@storybook/blocks": "8.2.9",
+		"@storybook/preview-api": "8.2.9",
+		"@storybook/react": "8.2.9",
+		"@types/markdown-it": "14.1.2",
+		"@types/turndown": "5.0.5",
 		"jest": "^29.6.2",
 		"jest-environment-jsdom": "29.7.0",
+		"storybook": "8.2.9",
 		"typescript": "5.0.4"
 	},
 	"exports": {
@@ -42,21 +43,21 @@
 	"main": "./build/index.js",
 	"types": "./build/index.d.ts",
 	"dependencies": {
-		"@automattic/jetpack-base-styles": "^0.6.28",
-		"@automattic/jetpack-connection": "^0.34.1",
-		"@automattic/jetpack-shared-extension-utils": "^0.15.1",
+		"@automattic/jetpack-base-styles": "^0.6.29",
+		"@automattic/jetpack-connection": "^0.35.3",
+		"@automattic/jetpack-shared-extension-utils": "^0.15.4",
 		"@microsoft/fetch-event-source": "2.0.1",
-		"@types/react": "18.3.1",
-		"@types/wordpress__block-editor": "11.5.14",
-		"@wordpress/api-fetch": "7.2.0",
-		"@wordpress/blob": "4.2.0",
-		"@wordpress/block-editor": "13.2.0",
-		"@wordpress/components": "28.2.0",
-		"@wordpress/compose": "7.2.0",
-		"@wordpress/data": "10.2.0",
-		"@wordpress/element": "6.2.0",
-		"@wordpress/i18n": "5.2.0",
-		"@wordpress/icons": "10.2.0",
+		"@types/react": "18.3.3",
+		"@types/wordpress__block-editor": "11.5.15",
+		"@wordpress/api-fetch": "7.5.0",
+		"@wordpress/blob": "4.5.0",
+		"@wordpress/block-editor": "14.0.0",
+		"@wordpress/components": "28.5.0",
+		"@wordpress/compose": "7.5.0",
+		"@wordpress/data": "10.5.0",
+		"@wordpress/element": "6.5.0",
+		"@wordpress/i18n": "5.5.0",
+		"@wordpress/icons": "10.5.0",
 		"clsx": "2.1.1",
 		"debug": "4.3.4",
 		"markdown-it": "14.0.0",

package/src/ask-question/index.ts

@@ -46,9 +46,9 @@ const debug = debugFactory( 'jetpack-ai-client:ask-question' );
  * An asynchronous function that asks a question
  * and returns an event source with suggestions.
  *
- * @param {PromptProp} question - The question to ask. It can be a simple string or an array of PromptMessageItemProps objects.
- * @param {AskQuestionOptionsArgProps} options - An optional object for additional configuration:
- * @returns {Promise<SuggestionsEventSource>}    A promise that resolves to an instance of the SuggestionsEventSource
+ * @param {PromptProp}                 question - The question to ask. It can be a simple string or an array of PromptMessageItemProps objects.
+ * @param {AskQuestionOptionsArgProps} options  - An optional object for additional configuration:
+ * @return {Promise<SuggestionsEventSource>}    A promise that resolves to an instance of the SuggestionsEventSource
  * @example
  *  const question = "What is the meaning of life?";
  *  const options = {

package/src/ask-question/sync.ts

@@ -19,9 +19,9 @@ const debug = debugFactory( 'jetpack-ai-client:ask-question-sync' );
 /**
  * A function that asks a question without streaming.
  *
- * @param {PromptProp} question - The question to ask. It can be a simple string or an array of PromptMessageItemProps objects.
- * @param {AskQuestionOptionsArgProps} options - An optional object for additional configuration: postId, feature, model.
- * @returns {Promise<ResponseData>} - A promise that resolves to an instance of the ResponseData
+ * @param {PromptProp}                 question - The question to ask. It can be a simple string or an array of PromptMessageItemProps objects.
+ * @param {AskQuestionOptionsArgProps} options  - An optional object for additional configuration: postId, feature, model.
+ * @return {Promise<ResponseData>} - A promise that resolves to an instance of the ResponseData
  * @example
  * const question = "What is the meaning of life?";
  * const options = {

package/src/audio-transcription/index.ts

@@ -12,10 +12,10 @@ const debug = debugFactory( 'jetpack-ai-client:audio-transcription' );
 /**
  * A function that takes an audio blob and transcribes it.
  *
- * @param {Blob} audio - The audio to be transcribed, from a recording or from a file.
- * @param {string} feature - The feature name that is calling the transcription.
+ * @param {Blob}        audio              - The audio to be transcribed, from a recording or from a file.
+ * @param {string}      feature            - The feature name that is calling the transcription.
  * @param {AbortSignal} requestAbortSignal - The signal to abort the request.
- * @returns {Promise<string>} - The promise of a string containing the transcribed audio.
+ * @return {Promise<string>} - The promise of a string containing the transcribed audio.
  */
 export default async function transcribeAudio(
 	audio: Blob,

package/src/components/ai-control/ai-control.tsx

@@ -35,7 +35,7 @@ type AIControlProps = {
  * Base AIControl component. Contains the main structure of the control component and slots for banner, error, actions and message.
  *
  * @param {AIControlProps} props - Component props
- * @returns {ReactElement}       Rendered component
+ * @return {ReactElement}       Rendered component
  */
 export default function AIControl( {
 	className,

package/src/components/ai-control/block-ai-control.tsx

@@ -53,9 +53,9 @@ const debug = debugFactory( 'jetpack-ai-client:block-ai-control' );
 /**
  * BlockAIControl component. Used by the AI Assistant block, adding logic and components to the base AIControl component.
  *
- * @param {BlockAIControlProps} props  - Component props
- * @param {React.MutableRefObject} ref - Ref to the component
- * @returns {ReactElement}             Rendered component
+ * @param {BlockAIControlProps}    props - Component props
+ * @param {React.MutableRefObject} ref   - Ref to the component
+ * @return {ReactElement}             Rendered component
  */
 export function BlockAIControl(
 	{

package/src/components/ai-control/extension-ai-control.tsx

@@ -45,9 +45,9 @@ type ExtensionAIControlProps = {
 /**
  * ExtensionAIControl component. Used by the AI Assistant inline extensions, adding logic and components to the base AIControl component.
  *
- * @param {ExtensionAIControlProps} props  - Component props
- * @param {React.MutableRefObject} ref     - Ref to the component
- * @returns {ReactElement}                 Rendered component
+ * @param {ExtensionAIControlProps} props - Component props
+ * @param {React.MutableRefObject}  ref   - Ref to the component
+ * @return {ReactElement}                 Rendered component
  */
 export function ExtensionAIControl(
 	{

package/src/components/ai-status-indicator/index.tsx

@@ -21,7 +21,7 @@ export type AiStatusIndicatorProps = {
  * AiStatusIndicator component.
  *
  * @param {AiStatusIndicatorProps} props - component props.
- * @returns {React.ReactElement} - rendered component.
+ * @return {React.ReactElement} - rendered component.
  */
 export default function AiStatusIndicator( { state }: AiStatusIndicatorProps ): React.ReactElement {
 	return (

package/src/components/audio-duration-display/index.tsx

@@ -16,7 +16,7 @@ type AudioDurationDisplayProps = {
  * AudioDurationDisplay component.
  *
  * @param {AudioDurationDisplayProps} props - Component props.
- * @returns {React.ReactElement}              Rendered component.
+ * @return {React.ReactElement}              Rendered component.
  */
 export default function AudioDurationDisplay( {
 	duration,

package/src/components/audio-duration-display/lib/media.ts

@@ -19,9 +19,9 @@ type FormatTimeOptions = {
  * Formats the given time in milliseconds into a string with the format HH:MM:SS.DD,
  * adding hours and minutes only when needed.
  *
- * @param {number} time               - The time in milliseconds to format.
+ * @param {number}            time    - The time in milliseconds to format.
  * @param {FormatTimeOptions} options - The arguments.
- * @returns {string}                    The formatted time string.
+ * @return {string}                    The formatted time string.
  * @example
  * const formattedTime1 = formatTime( 1234567, { addDecimalPart: true } ); // Returns "20:34.56"
  * const formattedTime2 = formatTime( 45123 );                             // Returns "00.45"

package/src/components/message/index.tsx

@@ -67,7 +67,7 @@ const messageIconsMap = {
  * React component to render a block message.
  *
  * @param {MessageProps} props - Component props.
- * @returns {React.ReactElement }    Banner component.
+ * @return {React.ReactElement }    Banner component.
  */
 export default function Message( {
 	severity = MESSAGE_SEVERITY_INFO,
@@ -99,7 +99,7 @@ export default function Message( {
 /**
  * React component to render a guideline message.
  *
- * @returns {React.ReactElement } - Message component.
+ * @return {React.ReactElement } - Message component.
  */
 export function GuidelineMessage(): React.ReactElement {
 	return (
@@ -118,7 +118,7 @@ export function GuidelineMessage(): React.ReactElement {
  * React component to render an upgrade message for free tier users
  *
  * @param {number} requestsRemaining - Number of requests remaining.
- * @returns {React.ReactElement } - Message component.
+ * @return {React.ReactElement } - Message component.
  */
 export function UpgradeMessage( {
 	requestsRemaining,
@@ -157,7 +157,7 @@ export function UpgradeMessage( {
  * React component to render an error message
  *
  * @param {number} requestsRemaining - Number of requests remaining.
- * @returns {React.ReactElement } - Message component.
+ * @return {React.ReactElement } - Message component.
  */
 export function ErrorMessage( {
 	error,

package/src/data-flow/context.tsx

@@ -58,7 +58,7 @@ type AiDataContextProviderProps = {
 /**
  * AI Data Context
  *
- * @returns {AiDataContextProps} Context.
+ * @return {AiDataContextProps} Context.
  */
 export const AiDataContext = createContext< AiDataContextProps | object >( {} );
 
@@ -66,7 +66,7 @@ export const AiDataContext = createContext< AiDataContextProps | object >( {} );
  * AI Data Context Provider
  *
  * @param {AiDataContextProviderProps} props - Component props.
- * @returns {React.ReactElement}                           Context provider.
+ * @return {React.ReactElement}                           Context provider.
  * @example
  * <AiDataContextProvider value={ value }>
  * 	{ children }

package/src/data-flow/use-ai-context.ts

@@ -41,7 +41,7 @@ export type UseAiContextOptions = {
  * and to subscribe to the request events (onDone, onSuggestion).
  *
  * @param {UseAiContextOptions} options - the hook options.
- * @returns {AiDataContextProps}          the AI Assistant data context.
+ * @return {AiDataContextProps}          the AI Assistant data context.
  */
 export default function useAiContext( {
 	onDone,

package/src/data-flow/with-ai-assistant-data.tsx

@@ -15,7 +15,7 @@ import { AiDataContextProvider } from './index.js';
  * AI Assistant Data context to the wrapped component.
  *
  * @param {React.ReactElement} WrappedComponent - component to wrap.
- * @returns {React.ReactElement}          		  Wrapped component, with the AI Assistant Data context.
+ * @return {React.ReactElement} Wrapped component, with the AI Assistant Data context.
  */
 const withAiDataProvider = createHigherOrderComponent(
 	( WrappedComponent: React.ComponentType ) => {