@automattic/jetpack-ai-client 0.16.2 → 0.16.3

package/CHANGELOG.md

@@ -5,6 +5,10 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.16.3] - 2024-08-21
+### Fixed
+- Revert recent SVG image optimizations. [#38981]
+
 ## [0.16.2] - 2024-08-19
 ### Changed
 - Update dependencies. [#38861] [#38662] [#38665] [#38893]
@@ -384,6 +388,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Updated package dependencies. [#31659]
 - Updated package dependencies. [#31785]
 
+[0.16.3]: https://github.com/Automattic/jetpack-ai-client/compare/v0.16.2...v0.16.3
 [0.16.2]: https://github.com/Automattic/jetpack-ai-client/compare/v0.16.1...v0.16.2
 [0.16.1]: https://github.com/Automattic/jetpack-ai-client/compare/v0.16.0...v0.16.1
 [0.16.0]: https://github.com/Automattic/jetpack-ai-client/compare/v0.15.0...v0.16.0

package/build/ask-question/index.d.ts

@@ -15,9 +15,9 @@ export type AskQuestionOptionsArgProps = {
  * 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/build/ask-question/index.js

@@ -8,9 +8,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/build/ask-question/sync.d.ts

@@ -7,9 +7,9 @@ export type ResponseData = string;
 /**
  * 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/build/ask-question/sync.js

@@ -10,9 +10,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/build/audio-transcription/index.d.ts

@@ -1,9 +1,9 @@
 /**
  * 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 function transcribeAudio(audio: Blob, feature?: string, requestAbortSignal?: AbortSignal): Promise<string>;

package/build/audio-transcription/index.js

@@ -10,10 +10,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, feature, requestAbortSignal) {
     debug('Transcribing audio: %o. Feature: %o', audio, feature);

package/build/components/ai-control/ai-control.d.ts

@@ -24,7 +24,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, disabled, value, placeholder, isTransparent, state, onChange, banner, error, actions, message, promptUserInputRef, wrapperRef, }: AIControlProps): ReactElement;
 export {};

package/build/components/ai-control/ai-control.js

@@ -13,7 +13,7 @@ import './style.scss';
  * 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, disabled = false, value = '', placeholder = '', isTransparent = false, state = 'init', onChange, banner = null, error = null, actions = null, message = null, promptUserInputRef = null, wrapperRef = null, }) {
     return (_jsxs("div", { className: clsx('jetpack-components-ai-control__container-wrapper', className), ref: wrapperRef, children: [error, _jsxs("div", { className: "jetpack-components-ai-control__container", children: [banner, _jsxs("div", { className: clsx('jetpack-components-ai-control__wrapper', {

package/build/components/ai-control/block-ai-control.d.ts

@@ -28,9 +28,9 @@ type BlockAIControlProps = {
 /**
  * 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 declare function BlockAIControl({ disabled, value, placeholder, showAccept, acceptLabel, showButtonLabels, isTransparent, state, showGuideLine, customFooter, onChange, onSend, onStop, onAccept, onDiscard, showRemove, banner, error, }: BlockAIControlProps, ref: React.MutableRefObject<HTMLInputElement>): ReactElement;
 declare const _default: React.ForwardRefExoticComponent<BlockAIControlProps & React.RefAttributes<HTMLInputElement>>;

package/build/components/ai-control/block-ai-control.js

@@ -19,9 +19,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({ disabled = false, value = '', placeholder = '', showAccept = false, acceptLabel = __('Accept', 'jetpack-ai-client'), showButtonLabels = true, isTransparent = false, state = 'init', showGuideLine = false, customFooter = null, onChange, onSend, onStop, onAccept, onDiscard, showRemove = false, banner = null, error = null, }, ref) {
     const loading = state === 'requesting' || state === 'suggesting';

package/build/components/ai-control/extension-ai-control.d.ts

@@ -30,9 +30,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 declare function ExtensionAIControl({ className, disabled, value, placeholder, showButtonLabels, isTransparent, state, showGuideLine, error, requestsRemaining, showUpgradeMessage, upgradeUrl, wrapperRef, onChange, onSend, onStop, onClose, onUndo, onUpgrade, onTryAgain, }: ExtensionAIControlProps, ref: React.MutableRefObject<HTMLInputElement>): ReactElement;
 declare const _default: React.ForwardRefExoticComponent<ExtensionAIControlProps & React.RefAttributes<HTMLInputElement>>;

package/build/components/ai-control/extension-ai-control.js

@@ -17,9 +17,9 @@ import './style.scss';
 /**
  * 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({ className, disabled = false, value = '', placeholder = '', showButtonLabels = true, isTransparent = false, state = 'init', showGuideLine = false, error, requestsRemaining, showUpgradeMessage = false, upgradeUrl, wrapperRef, onChange, onSend, onStop, onClose, onUndo, onUpgrade, onTryAgain, }, ref) {
     const loading = state === 'requesting' || state === 'suggesting';

package/build/components/ai-status-indicator/index.d.ts

@@ -10,6 +10,6 @@ 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;

package/build/components/ai-status-indicator/index.js

@@ -9,7 +9,7 @@ import './style.scss';
  * AiStatusIndicator component.
  *
  * @param {AiStatusIndicatorProps} props - component props.
- * @returns {React.ReactElement} - rendered component.
+ * @return {React.ReactElement} - rendered component.
  */
 export default function AiStatusIndicator({ state }) {
     return (_jsx("div", { className: clsx('jetpack-ai-status-indicator__icon-wrapper', {

package/build/components/audio-duration-display/index.d.ts

@@ -7,7 +7,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, className, }: AudioDurationDisplayProps): React.ReactElement;
 export {};

package/build/components/audio-duration-display/index.js

@@ -7,7 +7,7 @@ import { formatTime } from './lib/media.js';
  * AudioDurationDisplay component.
  *
  * @param {AudioDurationDisplayProps} props - Component props.
- * @returns {React.ReactElement}              Rendered component.
+ * @return {React.ReactElement}              Rendered component.
  */
 export default function AudioDurationDisplay({ duration, className, }) {
     return _jsx("span", { className: className, children: formatTime(duration, { addDecimalPart: false }) });

package/build/components/audio-duration-display/lib/media.d.ts

@@ -16,9 +16,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/build/components/audio-duration-display/lib/media.js

@@ -2,9 +2,9 @@
  * 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/build/components/message/index.d.ts

@@ -38,27 +38,27 @@ export type ErrorMessageProps = {
  * 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, icon, showSidebarIcon, onSidebarIconClick, children, }: MessageProps): React.ReactElement;
 /**
  * React component to render a guideline message.
  *
- * @returns {React.ReactElement } - Message component.
+ * @return {React.ReactElement } - Message component.
  */
 export declare 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 declare function UpgradeMessage({ requestsRemaining, severity, onUpgradeClick, upgradeUrl, }: UpgradeMessageProps): React.ReactElement;
 /**
  * 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 declare function ErrorMessage({ error, code, onTryAgainClick, onUpgradeClick, upgradeUrl, }: ErrorMessageProps): React.ReactElement;
 export {};

package/build/components/message/index.js

@@ -32,7 +32,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, icon = null, showSidebarIcon = false, onSidebarIconClick = () => { }, children, }) {
     return (_jsxs("div", { className: clsx('jetpack-ai-assistant__message', `jetpack-ai-assistant__message-severity-${severity}`), children: [(messageIconsMap[severity] || icon) && (_jsx(Icon, { icon: messageIconsMap[severity] || icon })), _jsx("div", { className: "jetpack-ai-assistant__message-content", children: children }), showSidebarIcon && (_jsx(Button, { className: "jetpack-ai-assistant__message-sidebar", onClick: onSidebarIconClick, children: _jsx(Icon, { size: 20, icon: arrowRight }) }))] }));
@@ -40,7 +40,7 @@ export default function Message({ severity = MESSAGE_SEVERITY_INFO, icon = null,
 /**
  * React component to render a guideline message.
  *
- * @returns {React.ReactElement } - Message component.
+ * @return {React.ReactElement } - Message component.
  */
 export function GuidelineMessage() {
     return (_jsxs(Message, { children: [_jsx("span", { children: __('AI-generated content could be inaccurate or biased.', 'jetpack-ai-client') }), _jsx(ExternalLink, { href: "https://automattic.com/ai-guidelines", children: __('Learn more', 'jetpack-ai-client') })] }));
@@ -49,7 +49,7 @@ export function GuidelineMessage() {
  * 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, severity, onUpgradeClick, upgradeUrl, }) {
     let messageSeverity = severity;
@@ -64,7 +64,7 @@ export function UpgradeMessage({ requestsRemaining, severity, onUpgradeClick, up
  * 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, code, onTryAgainClick, onUpgradeClick, upgradeUrl, }) {
     const errorMessage = error || __('Something went wrong', 'jetpack-ai-client');

package/build/data-flow/context.d.ts

@@ -25,14 +25,14 @@ type AiDataContextProviderProps = {
 /**
  * AI Data Context
  *
- * @returns {AiDataContextProps} Context.
+ * @return {AiDataContextProps} Context.
  */
 export declare const AiDataContext: React.Context<object | AiDataContextProps>;
 /**
  * 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/build/data-flow/context.js

@@ -6,14 +6,14 @@ import { createContext } from 'react';
 /**
  * AI Data Context
  *
- * @returns {AiDataContextProps} Context.
+ * @return {AiDataContextProps} Context.
  */
 export const AiDataContext = createContext({});
 /**
  * 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/build/data-flow/use-ai-context.d.ts

@@ -19,6 +19,6 @@ 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, onSuggestion, onError, }?: UseAiContextOptions): AiDataContextProps;

package/build/data-flow/use-ai-context.js

@@ -13,7 +13,7 @@ import { AiDataContext } from './index.js';
  * 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, onSuggestion, onError, } = {}) {
     const context = useContext(AiDataContext);

package/build/data-flow/with-ai-assistant-data.d.ts

@@ -4,7 +4,7 @@ import React from 'react';
  * 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.
  */
 declare const withAiDataProvider: (Inner: React.ComponentType<{}>) => (props: any) => import("react/jsx-runtime").JSX.Element;
 export default withAiDataProvider;

package/build/data-flow/with-ai-assistant-data.js

@@ -14,7 +14,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) => {
     return props => {

package/build/hooks/use-ai-suggestions/index.d.ts

@@ -38,14 +38,14 @@ 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 declare function getErrorData(errorCode: SuggestionErrorCode): RequestingErrorProps;
 /**
  * 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 declare function removeLlamaArtifact(suggestion: string): string;
 /**
@@ -53,7 +53,7 @@ export declare 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, autoRequest, askQuestionOptions, initialRequestingState, onSuggestion, onDone, onStop, onError, onAllErrors, }?: useAiSuggestionsOptions): useAiSuggestionsProps;
 export {};

package/build/hooks/use-ai-suggestions/index.js

@@ -12,7 +12,7 @@ import { ERROR_CONTEXT_TOO_LARGE, ERROR_MODERATION, ERROR_NETWORK, ERROR_QUOTA_E
  * 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) {
     switch (errorCode) {
@@ -59,7 +59,7 @@ export function getErrorData(errorCode) {
  * 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) {
     return suggestion.replace(/^<\|start_header_id\|>assistant<\|end_header_id\|>[\n]+/, '');
@@ -69,7 +69,7 @@ export function removeLlamaArtifact(suggestion) {
  * 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, autoRequest = false, askQuestionOptions = {}, initialRequestingState = 'init', onSuggestion, onDone, onStop, onError, onAllErrors, } = {}) {
     const [requestingState, setRequestingState] = useState(initialRequestingState);
@@ -81,7 +81,7 @@ export default function useAiSuggestions({ prompt, autoRequest = false, askQuest
      * onSuggestion function handler.
      *
      * @param {string} suggestion - The suggestion.
-     * @returns {void}
+     * @return {void}
      */
     const handleSuggestion = useCallback((event) => {
         const partialSuggestion = removeLlamaArtifact(event?.detail);
@@ -95,7 +95,7 @@ export default function useAiSuggestions({ prompt, autoRequest = false, askQuest
      * onDone function handler.
      *
      * @param {string} content - The content.
-     * @returns {void}
+     * @return {void}
      */
     const handleDone = useCallback((event) => {
         closeEventSource();
@@ -120,9 +120,9 @@ export default function useAiSuggestions({ prompt, autoRequest = false, askQuest
     /**
      * 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 (promptArg, options = { ...askQuestionOptions }) => {
         // Clear any error.
@@ -157,7 +157,7 @@ export default function useAiSuggestions({ prompt, autoRequest = false, askQuest
     /**
      * Reset the request state.
      *
-     * @returns {void}
+     * @return {void}
      */
     const reset = useCallback(() => {
         setRequestingState('init');
@@ -167,7 +167,7 @@ export default function useAiSuggestions({ prompt, autoRequest = false, askQuest
     /**
      * Close the event source connection.
      *
-     * @returns {void}
+     * @return {void}
      */
     const closeEventSource = useCallback(() => {
         if (!eventSourceRef?.current) {
@@ -198,7 +198,7 @@ export default function useAiSuggestions({ prompt, autoRequest = false, askQuest
     /**
      * Stop suggestion handler.
      *
-     * @returns {void}
+     * @return {void}
      */
     const stopSuggestion = useCallback(() => {
         closeEventSource();

package/build/hooks/use-audio-transcription/index.d.ts

@@ -20,6 +20,6 @@ export type UseAudioTranscriptionProps = {
  * 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, onReady, onError, }: UseAudioTranscriptionProps): UseAudioTranscriptionReturn;

package/build/hooks/use-audio-transcription/index.js

@@ -12,7 +12,7 @@ const debug = debugFactory('jetpack-ai-client:use-audio-transcription');
 /**
  * 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) => {
     if (typeof error === 'string') {
@@ -45,7 +45,7 @@ const mapErrorResponse = (error) => {
  * 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, onReady, onError, }) {
     const [transcriptionResult, setTranscriptionResult] = useState('');

package/build/hooks/use-audio-validation/index.d.ts

@@ -16,6 +16,6 @@ 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;

package/build/hooks/use-audio-validation/index.js

@@ -22,7 +22,7 @@ const ALLOWED_MEDIA_TYPES = [
 /**
  * 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() {
     const [isValidatingAudio, setIsValidatingAudio] = useState(false);

package/build/hooks/use-image-generator/index.js

@@ -10,9 +10,9 @@ import requestJwt from '../../jwt/index.js';
 const debug = debugFactory('ai-client:use-image-generator');
 /**
  * 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, currentPromptLength) => {
     const maxLength = 4000;
@@ -25,8 +25,8 @@ const truncateContent = (content, currentPromptLength) => {
 /**
  * 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, userPrompt) => {
     /**
@@ -77,8 +77,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, userPrompt) => {
     /**
@@ -116,9 +116,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, userPrompt, feature) => {
     const prompt = getStableDiffusionPreProcessingPrompt(postContent, userPrompt);

package/build/hooks/use-media-recording/index.d.ts

@@ -54,7 +54,7 @@ type UseMediaRecordingReturn = {
  * 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, }?: UseMediaRecordingProps): UseMediaRecordingReturn;
 export {};