@automattic/jetpack-ai-client 0.16.1 → 0.16.3

package/build/hooks/use-media-recording/index.js

@@ -12,7 +12,7 @@ const MEDIA_TYPE_WEBM = 'audio/webm';
  * 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, } = {}) {
     // Reference to the media recorder instance
@@ -35,7 +35,7 @@ export default function useMediaRecording({ onDone, } = {}) {
     /**
      * Get the recorded blob.
      *
-     * @returns {Blob} The recorded blob
+     * @return {Blob} The recorded blob
      */
     function getBlob() {
         if (MediaRecorder.isTypeSupported(MEDIA_TYPE_MP4_MP4A)) {
@@ -158,7 +158,7 @@ export default function useMediaRecording({ onDone, } = {}) {
      * `stop` event listener for the media recorder instance.
      * Happens after the last `dataavailable` event.
      *
-     * @returns {void}
+     * @return {void}
      */
     function onStopListener() {
         const lastBlob = getBlob();
@@ -182,7 +182,7 @@ export default function useMediaRecording({ onDone, } = {}) {
      * `dataavailable` event listener for the media recorder instance.
      *
      * @param {MediaRecorderEvent} event - The event object
-     * @returns {void}
+     * @return {void}
      */
     function onDataAvailableListener(event) {
         const { data } = event;

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

@@ -1,7 +1,7 @@
 /**
  * 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(): {
     isLoading: boolean;

package/build/hooks/use-save-to-media-library/index.js

@@ -9,7 +9,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/build/hooks/use-transcription-post-processing/index.d.ts

@@ -26,6 +26,6 @@ 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, onReady, onError, onUpdate, }: UseTranscriptionPostProcessingProps): UseTranscriptionPostProcessingReturn;

package/build/hooks/use-transcription-post-processing/index.js

@@ -16,7 +16,7 @@ export const TRANSCRIPTION_POST_PROCESSING_ACTION_SIMPLE_DRAFT = 'voice-to-conte
  * 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, onReady, onError, onUpdate, }) {
     const [postProcessingResult, setPostProcessingResult] = useState('');

package/build/jwt/index.d.ts

@@ -13,7 +13,7 @@ type TokenDataProps = {
  * 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 function requestJwt({ apiNonce, siteId, expirationTime, }?: RequestTokenOptions): Promise<TokenDataProps>;
 export {};

package/build/jwt/index.js

@@ -14,7 +14,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, siteId, expirationTime, } = {}) {
     // Default values

package/build/libs/markdown/html-to-markdown.d.ts

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

package/build/libs/markdown/html-to-markdown.js

@@ -34,7 +34,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 }) {
         const rendered = this.turndownService.turndown(content);

package/build/libs/markdown/markdown-to-html.d.ts

@@ -18,11 +18,11 @@ export default class MarkdownToHTML {
     constructor(options?: Options);
     /**
      * 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, rules, extension, }: {
         content: string;

package/build/libs/markdown/markdown-to-html.js

@@ -65,11 +65,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, rules = assistantBlockRules, extension = false, }) {
         const rendered = this.markdownConverter.render(content);

package/build/logo-generator/lib/logo-storage.d.ts

@@ -6,53 +6,53 @@ import { RemoveFromStorageProps, SaveToStorageProps, UpdateInStorageProps } from
 /**
  * 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 declare function stashLogo({ siteId, url, description, mediaId }: SaveToStorageProps): Logo;
 /**
  * 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 declare function updateLogo({ siteId, url, newUrl, mediaId }: UpdateInStorageProps): Logo;
 /**
  * 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 declare function getSiteLogoHistory(siteId: string): Logo[];
 /**
  * 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 declare function isLogoHistoryEmpty(siteId: string): boolean;
 /**
  * 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 declare function removeLogo({ siteId, mediaId }: RemoveFromStorageProps): void;
 /**
  * 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 declare function clearDeletedMedia(siteId: string): Promise<void>;

package/build/logo-generator/lib/logo-storage.js

@@ -3,13 +3,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 }) {
     const storedContent = getSiteLogoHistory(siteId);
@@ -25,12 +25,12 @@ export function stashLogo({ siteId, url, description, mediaId }) {
 /**
  * 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 }) {
     const storedContent = getSiteLogoHistory(siteId);
@@ -46,7 +46,7 @@ export function updateLogo({ siteId, url, newUrl, mediaId }) {
  * 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) {
     const storedString = localStorage.getItem(`logo-history-${siteId}`);
@@ -74,8 +74,8 @@ export function getSiteLogoHistory(siteId) {
 /**
  * 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) {
     const storedContent = getSiteLogoHistory(siteId);
@@ -84,10 +84,10 @@ export function isLogoHistoryEmpty(siteId) {
 /**
  * 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 }) {
     const storedContent = getSiteLogoHistory(siteId);
@@ -102,7 +102,7 @@ export function removeLogo({ siteId, mediaId }) {
  * 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) {
     const storedContent = getSiteLogoHistory(siteId);

package/build/logo-generator/lib/media-exists.d.ts

@@ -5,8 +5,8 @@ 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 declare function mediaExists({ mediaId }: CheckMediaProps): Promise<boolean>;

package/build/logo-generator/lib/media-exists.js

@@ -5,9 +5,9 @@ import apiFetch from '../../api-fetch/index.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 }) {
     const id = Number(mediaId);

package/build/logo-generator/lib/set-site-logo.d.ts

@@ -5,9 +5,9 @@ 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 declare function setSiteLogo({ siteId, imageId }: SetSiteLogoProps): Promise<SetSiteLogoResponseProps>;

package/build/logo-generator/lib/set-site-logo.js

@@ -5,10 +5,10 @@ import wpcomLimitedRequest from './wpcom-limited-request.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 }) {
     const body = {

package/build/logo-generator/lib/wpcom-limited-request.d.ts

@@ -1,7 +1,7 @@
 /**
  * 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 function wpcomLimitedRequest<T>(params: object): Promise<T>;

package/build/logo-generator/lib/wpcom-limited-request.js

@@ -10,7 +10,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(params) {

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

@@ -4,7 +4,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 declare function mapAiFeatureResponseToAiFeatureProps(response: AiAssistantFeatureEndpointResponseProps): AiFeatureProps;
 declare const actions: {
@@ -14,7 +14,7 @@ declare const actions: {
     };
     /**
      * Thunk action to fetch the AI Assistant feature from the API.
-     * @returns {Function} The thunk action.
+     * @return {Function} The thunk action.
      */
     fetchAiAssistantFeature(): ({ dispatch }: {
         dispatch: any;
@@ -23,7 +23,7 @@ declare 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): ({ dispatch }: {
         dispatch: any;

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

@@ -11,7 +11,7 @@ import { ACTION_INCREASE_AI_ASSISTANT_REQUESTS_COUNT, ACTION_REQUEST_AI_ASSISTAN
  * 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) {
     return {
@@ -43,7 +43,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
@@ -68,7 +68,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 = 1) {
         // eslint-disable-next-line @typescript-eslint/no-explicit-any

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

@@ -3,28 +3,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: LogoGeneratorStateProp, action: {
     type: string;

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

@@ -7,28 +7,28 @@ import INITIAL_STATE from './initial-state.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, action) {
     switch (action.type) {