@automattic/jetpack-ai-client 0.14.6 → 0.15.0

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

@@ -0,0 +1,105 @@
+import type { AiFeatureProps, AiAssistantFeatureEndpointResponseProps, Logo, RequestError } from './types.js';
+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.
+ */
+export declare function mapAiFeatureResponseToAiFeatureProps(response: AiAssistantFeatureEndpointResponseProps): AiFeatureProps;
+declare const actions: {
+    storeAiAssistantFeature(feature: AiFeatureProps): {
+        type: string;
+        feature: AiFeatureProps;
+    };
+    /**
+     * Thunk action to fetch the AI Assistant feature from the API.
+     * @returns {Function} The thunk action.
+     */
+    fetchAiAssistantFeature(): ({ dispatch }: {
+        dispatch: any;
+    }) => Promise<void>;
+    /**
+     * 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.
+     */
+    increaseAiAssistantRequestsCount(count?: number): ({ dispatch }: {
+        dispatch: any;
+    }) => void;
+    setAiAssistantFeatureRequireUpgrade(requireUpgrade?: boolean): {
+        type: string;
+        requireUpgrade: boolean;
+    };
+    setTierPlansEnabled(tierPlansEnabled?: boolean): {
+        type: string;
+        tierPlansEnabled: boolean;
+    };
+    setSiteDetails(siteDetails: SiteDetails): {
+        type: string;
+        siteDetails: SiteDetails;
+    };
+    setSelectedLogoIndex(selectedLogoIndex: number): {
+        type: string;
+        selectedLogoIndex: number;
+    };
+    addLogoToHistory(logo: Logo): {
+        type: string;
+        logo: Logo;
+    };
+    setIsSavingLogoToLibrary(isSavingLogoToLibrary: boolean): {
+        type: string;
+        isSavingLogoToLibrary: boolean;
+    };
+    setIsApplyingLogo(isApplyingLogo: boolean): {
+        type: string;
+        isApplyingLogo: boolean;
+    };
+    updateSelectedLogo(mediaId: string, url: string): {
+        type: string;
+        mediaId: string;
+        url: string;
+    };
+    setIsRequestingImage(isRequestingImage: boolean): {
+        type: string;
+        isRequestingImage: boolean;
+    };
+    setIsEnhancingPrompt(isEnhancingPrompt: boolean): {
+        type: string;
+        isEnhancingPrompt: boolean;
+    };
+    loadLogoHistory(siteId: string): {
+        type: string;
+        history: Logo[];
+    };
+    setFeatureFetchError(error: RequestError): {
+        type: string;
+        error: RequestError;
+    };
+    setFirstLogoPromptFetchError(error: RequestError): {
+        type: string;
+        error: RequestError;
+    };
+    setEnhancePromptFetchError(error: RequestError): {
+        type: string;
+        error: RequestError;
+    };
+    setLogoFetchError(error: RequestError): {
+        type: string;
+        error: RequestError;
+    };
+    setSaveToLibraryError(error: RequestError): {
+        type: string;
+        error: RequestError;
+    };
+    setLogoUpdateError(error: RequestError): {
+        type: string;
+        error: RequestError;
+    };
+    setContext(context: string): {
+        type: string;
+        context: string;
+    };
+};
+export default actions;

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

@@ -0,0 +1,193 @@
+/**
+ * Internal dependencies
+ */
+import { getSiteLogoHistory } from '../lib/logo-storage.js';
+import wpcomLimitedRequest from '../lib/wpcom-limited-request.js';
+/**
+ * Types & Constants
+ */
+import { ACTION_INCREASE_AI_ASSISTANT_REQUESTS_COUNT, ACTION_REQUEST_AI_ASSISTANT_FEATURE, ACTION_SET_AI_ASSISTANT_FEATURE_REQUIRE_UPGRADE, ACTION_SET_SITE_DETAILS, ACTION_STORE_AI_ASSISTANT_FEATURE, ACTION_SET_TIER_PLANS_ENABLED, ACTION_SET_SELECTED_LOGO_INDEX, ACTION_ADD_LOGO_TO_HISTORY, ACTION_SET_IS_SAVING_LOGO_TO_LIBRARY, ACTION_SAVE_SELECTED_LOGO, ACTION_SET_IS_REQUESTING_IMAGE, ACTION_SET_IS_APPLYING_LOGO, ACTION_SET_IS_ENHANCING_PROMPT, ACTION_SET_SITE_HISTORY, ACTION_SET_FEATURE_FETCH_ERROR, ACTION_SET_FIRST_LOGO_PROMPT_FETCH_ERROR, ACTION_SET_ENHANCE_PROMPT_FETCH_ERROR, ACTION_SET_LOGO_FETCH_ERROR, ACTION_SET_LOGO_UPDATE_ERROR, ACTION_SET_SAVE_TO_LIBRARY_ERROR, ACTION_SET_CONTEXT, } from './constants.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.
+ */
+export function mapAiFeatureResponseToAiFeatureProps(response) {
+    return {
+        hasFeature: !!response['has-feature'],
+        isOverLimit: !!response['is-over-limit'],
+        requestsCount: response['requests-count'],
+        requestsLimit: response['requests-limit'],
+        requireUpgrade: !!response['site-require-upgrade'],
+        errorMessage: response['error-message'],
+        errorCode: response['error-code'],
+        upgradeType: response['upgrade-type'],
+        usagePeriod: {
+            currentStart: response['usage-period']?.['current-start'],
+            nextStart: response['usage-period']?.['next-start'],
+            requestsCount: response['usage-period']?.['requests-count'] || 0,
+        },
+        currentTier: response['current-tier'],
+        nextTier: response['next-tier'],
+        tierPlansEnabled: !!response['tier-plans-enabled'],
+        costs: response.costs,
+    };
+}
+const actions = {
+    storeAiAssistantFeature(feature) {
+        return {
+            type: ACTION_STORE_AI_ASSISTANT_FEATURE,
+            feature,
+        };
+    },
+    /**
+     * Thunk action to fetch the AI Assistant feature from the API.
+     * @returns {Function} The thunk action.
+     */
+    fetchAiAssistantFeature() {
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        return async ({ dispatch }) => {
+            // Dispatch isFetching action.
+            dispatch({ type: ACTION_REQUEST_AI_ASSISTANT_FEATURE });
+            try {
+                const response = await wpcomLimitedRequest({
+                    path: '/wpcom/v2/jetpack-ai/ai-assistant-feature',
+                    query: 'force=wpcom',
+                });
+                // Store the feature in the store.
+                dispatch(actions.storeAiAssistantFeature(mapAiFeatureResponseToAiFeatureProps(response)));
+            }
+            catch (err) {
+                // Mark the fetch as failed.
+                dispatch({ type: ACTION_SET_FEATURE_FETCH_ERROR, error: err });
+            }
+        };
+    },
+    /**
+     * 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.
+     */
+    increaseAiAssistantRequestsCount(count = 1) {
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        return ({ dispatch }) => {
+            dispatch({
+                type: ACTION_INCREASE_AI_ASSISTANT_REQUESTS_COUNT,
+                count,
+            });
+        };
+    },
+    setAiAssistantFeatureRequireUpgrade(requireUpgrade = true) {
+        return {
+            type: ACTION_SET_AI_ASSISTANT_FEATURE_REQUIRE_UPGRADE,
+            requireUpgrade,
+        };
+    },
+    setTierPlansEnabled(tierPlansEnabled = true) {
+        return {
+            type: ACTION_SET_TIER_PLANS_ENABLED,
+            tierPlansEnabled,
+        };
+    },
+    setSiteDetails(siteDetails) {
+        return {
+            type: ACTION_SET_SITE_DETAILS,
+            siteDetails,
+        };
+    },
+    setSelectedLogoIndex(selectedLogoIndex) {
+        return {
+            type: ACTION_SET_SELECTED_LOGO_INDEX,
+            selectedLogoIndex,
+        };
+    },
+    addLogoToHistory(logo) {
+        return {
+            type: ACTION_ADD_LOGO_TO_HISTORY,
+            logo,
+        };
+    },
+    setIsSavingLogoToLibrary(isSavingLogoToLibrary) {
+        return {
+            type: ACTION_SET_IS_SAVING_LOGO_TO_LIBRARY,
+            isSavingLogoToLibrary,
+        };
+    },
+    setIsApplyingLogo(isApplyingLogo) {
+        return {
+            type: ACTION_SET_IS_APPLYING_LOGO,
+            isApplyingLogo,
+        };
+    },
+    updateSelectedLogo(mediaId, url) {
+        return {
+            type: ACTION_SAVE_SELECTED_LOGO,
+            mediaId,
+            url,
+        };
+    },
+    setIsRequestingImage(isRequestingImage) {
+        return {
+            type: ACTION_SET_IS_REQUESTING_IMAGE,
+            isRequestingImage,
+        };
+    },
+    setIsEnhancingPrompt(isEnhancingPrompt) {
+        return {
+            type: ACTION_SET_IS_ENHANCING_PROMPT,
+            isEnhancingPrompt,
+        };
+    },
+    loadLogoHistory(siteId) {
+        const history = getSiteLogoHistory(siteId);
+        return {
+            type: ACTION_SET_SITE_HISTORY,
+            history,
+        };
+    },
+    setFeatureFetchError(error) {
+        return {
+            type: ACTION_SET_FEATURE_FETCH_ERROR,
+            error,
+        };
+    },
+    setFirstLogoPromptFetchError(error) {
+        return {
+            type: ACTION_SET_FIRST_LOGO_PROMPT_FETCH_ERROR,
+            error,
+        };
+    },
+    setEnhancePromptFetchError(error) {
+        return {
+            type: ACTION_SET_ENHANCE_PROMPT_FETCH_ERROR,
+            error,
+        };
+    },
+    setLogoFetchError(error) {
+        return {
+            type: ACTION_SET_LOGO_FETCH_ERROR,
+            error,
+        };
+    },
+    setSaveToLibraryError(error) {
+        return {
+            type: ACTION_SET_SAVE_TO_LIBRARY_ERROR,
+            error,
+        };
+    },
+    setLogoUpdateError(error) {
+        return {
+            type: ACTION_SET_LOGO_UPDATE_ERROR,
+            error,
+        };
+    },
+    setContext(context) {
+        return {
+            type: ACTION_SET_CONTEXT,
+            context,
+        };
+    },
+};
+export default actions;

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

@@ -0,0 +1,44 @@
+/**
+ * AI Assistant feature actions
+ */
+export declare const ACTION_STORE_AI_ASSISTANT_FEATURE = "STORE_AI_ASSISTANT_FEATURE";
+export declare const ACTION_REQUEST_AI_ASSISTANT_FEATURE = "REQUEST_AI_ASSISTANT_FEATURE";
+export declare const ACTION_INCREASE_AI_ASSISTANT_REQUESTS_COUNT = "INCREASE_AI_ASSISTANT_REQUESTS_COUNT";
+export declare const ACTION_SET_AI_ASSISTANT_FEATURE_REQUIRE_UPGRADE = "SET_AI_ASSISTANT_FEATURE_REQUIRE_UPGRADE";
+export declare const ACTION_SET_TIER_PLANS_ENABLED = "SET_TIER_PLANS_ENABLED";
+export declare const ACTION_SET_SITE_DETAILS = "SET_SITE_DETAILS";
+/**
+ * Endpoints
+ */
+export declare const ENDPOINT_AI_ASSISTANT_FEATURE = "/wpcom/v2/jetpack-ai/ai-assistant-feature";
+/**
+ * New AI Assistant feature async request
+ */
+export declare const FREE_PLAN_REQUESTS_LIMIT = 20;
+export declare const UNLIMITED_PLAN_REQUESTS_LIMIT = 999999999;
+export declare const ASYNC_REQUEST_COUNTDOWN_INIT_VALUE = 3;
+export declare const NEW_ASYNC_REQUEST_TIMER_INTERVAL = 5000;
+export declare const ACTION_DECREASE_NEW_ASYNC_REQUEST_COUNTDOWN = "DECREASE_NEW_ASYNC_REQUEST_COUNTDOWN";
+export declare const ACTION_ENQUEUE_ASYNC_REQUEST = "ENQUEUE_ASYNC_COUNTDOWN_REQUEST";
+export declare const ACTION_DEQUEUE_ASYNC_REQUEST = "DEQUEUE_ASYNC_COUNTDOWN_REQUEST";
+/**
+ * Logo generator actions
+ */
+export declare const ACTION_SET_CONTEXT = "SET_CONTEXT";
+export declare const ACTION_SET_SELECTED_LOGO_INDEX = "SET_SELECTED_LOGO_INDEX";
+export declare const ACTION_ADD_LOGO_TO_HISTORY = "ADD_LOGO_TO_HISTORY";
+export declare const ACTION_SET_IS_SAVING_LOGO_TO_LIBRARY = "SET_IS_SAVING_LOGO_TO_LIBRARY";
+export declare const ACTION_SET_IS_APPLYING_LOGO = "SET_IS_APPLYING_LOGO";
+export declare const ACTION_SAVE_SELECTED_LOGO = "SAVE_SELECTED_LOGO";
+export declare const ACTION_SET_IS_REQUESTING_IMAGE = "SET_IS_REQUESTING_IMAGE";
+export declare const ACTION_SET_IS_ENHANCING_PROMPT = "SET_IS_ENHANCING_PROMPT";
+export declare const ACTION_SET_SITE_HISTORY = "SET_SITE_HISTORY";
+/**
+ * Logo generator error actions
+ */
+export declare const ACTION_SET_FEATURE_FETCH_ERROR = "SET_FEATURE_FETCH_ERROR";
+export declare const ACTION_SET_FIRST_LOGO_PROMPT_FETCH_ERROR = "SET_FIRST_LOGO_PROMPT_FETCH_ERROR";
+export declare const ACTION_SET_ENHANCE_PROMPT_FETCH_ERROR = "SET_ENHANCE_PROMPT_FETCH_ERROR";
+export declare const ACTION_SET_LOGO_FETCH_ERROR = "SET_LOGO_FETCH_ERROR";
+export declare const ACTION_SET_SAVE_TO_LIBRARY_ERROR = "SET_SAVE_TO_LIBRARY_ERROR";
+export declare const ACTION_SET_LOGO_UPDATE_ERROR = "SET_LOGO_UPDATE_ERROR";

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

@@ -0,0 +1,44 @@
+/**
+ * AI Assistant feature actions
+ */
+export const ACTION_STORE_AI_ASSISTANT_FEATURE = 'STORE_AI_ASSISTANT_FEATURE';
+export const ACTION_REQUEST_AI_ASSISTANT_FEATURE = 'REQUEST_AI_ASSISTANT_FEATURE';
+export const ACTION_INCREASE_AI_ASSISTANT_REQUESTS_COUNT = 'INCREASE_AI_ASSISTANT_REQUESTS_COUNT';
+export const ACTION_SET_AI_ASSISTANT_FEATURE_REQUIRE_UPGRADE = 'SET_AI_ASSISTANT_FEATURE_REQUIRE_UPGRADE';
+export const ACTION_SET_TIER_PLANS_ENABLED = 'SET_TIER_PLANS_ENABLED';
+export const ACTION_SET_SITE_DETAILS = 'SET_SITE_DETAILS';
+/**
+ * Endpoints
+ */
+export const ENDPOINT_AI_ASSISTANT_FEATURE = '/wpcom/v2/jetpack-ai/ai-assistant-feature';
+/**
+ * New AI Assistant feature async request
+ */
+export const FREE_PLAN_REQUESTS_LIMIT = 20;
+export const UNLIMITED_PLAN_REQUESTS_LIMIT = 999999999;
+export const ASYNC_REQUEST_COUNTDOWN_INIT_VALUE = 3;
+export const NEW_ASYNC_REQUEST_TIMER_INTERVAL = 5000;
+export const ACTION_DECREASE_NEW_ASYNC_REQUEST_COUNTDOWN = 'DECREASE_NEW_ASYNC_REQUEST_COUNTDOWN';
+export const ACTION_ENQUEUE_ASYNC_REQUEST = 'ENQUEUE_ASYNC_COUNTDOWN_REQUEST';
+export const ACTION_DEQUEUE_ASYNC_REQUEST = 'DEQUEUE_ASYNC_COUNTDOWN_REQUEST';
+/**
+ * Logo generator actions
+ */
+export const ACTION_SET_CONTEXT = 'SET_CONTEXT';
+export const ACTION_SET_SELECTED_LOGO_INDEX = 'SET_SELECTED_LOGO_INDEX';
+export const ACTION_ADD_LOGO_TO_HISTORY = 'ADD_LOGO_TO_HISTORY';
+export const ACTION_SET_IS_SAVING_LOGO_TO_LIBRARY = 'SET_IS_SAVING_LOGO_TO_LIBRARY';
+export const ACTION_SET_IS_APPLYING_LOGO = 'SET_IS_APPLYING_LOGO';
+export const ACTION_SAVE_SELECTED_LOGO = 'SAVE_SELECTED_LOGO';
+export const ACTION_SET_IS_REQUESTING_IMAGE = 'SET_IS_REQUESTING_IMAGE';
+export const ACTION_SET_IS_ENHANCING_PROMPT = 'SET_IS_ENHANCING_PROMPT';
+export const ACTION_SET_SITE_HISTORY = 'SET_SITE_HISTORY';
+/**
+ * Logo generator error actions
+ */
+export const ACTION_SET_FEATURE_FETCH_ERROR = 'SET_FEATURE_FETCH_ERROR';
+export const ACTION_SET_FIRST_LOGO_PROMPT_FETCH_ERROR = 'SET_FIRST_LOGO_PROMPT_FETCH_ERROR';
+export const ACTION_SET_ENHANCE_PROMPT_FETCH_ERROR = 'SET_ENHANCE_PROMPT_FETCH_ERROR';
+export const ACTION_SET_LOGO_FETCH_ERROR = 'SET_LOGO_FETCH_ERROR';
+export const ACTION_SET_SAVE_TO_LIBRARY_ERROR = 'SET_SAVE_TO_LIBRARY_ERROR';
+export const ACTION_SET_LOGO_UPDATE_ERROR = 'SET_LOGO_UPDATE_ERROR';

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

@@ -0,0 +1 @@
+export declare const STORE_NAME = "jetpack-ai/logo-generator";

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

@@ -0,0 +1,19 @@
+/**
+ * External dependencies
+ */
+import { createReduxStore, register } from '@wordpress/data';
+/**
+ * Internal dependencies
+ */
+import actions from './actions.js';
+import reducer from './reducer.js';
+import selectors from './selectors.js';
+export const STORE_NAME = 'jetpack-ai/logo-generator';
+const jetpackAiLogoGeneratorStore = createReduxStore(STORE_NAME, {
+    // @ts-expect-error -- TSCONVERSION
+    __experimentalUseThunks: true,
+    actions,
+    reducer,
+    selectors,
+});
+register(jetpackAiLogoGeneratorStore);

package/build/logo-generator/store/initial-state.d.ts

@@ -0,0 +1,3 @@
+import { LogoGeneratorStateProp } from './types.js';
+declare const INITIAL_STATE: LogoGeneratorStateProp;
+export default INITIAL_STATE;

package/build/logo-generator/store/initial-state.js

@@ -0,0 +1,40 @@
+/**
+ * Types & Constants
+ */
+import { ASYNC_REQUEST_COUNTDOWN_INIT_VALUE, FREE_PLAN_REQUESTS_LIMIT } from './constants.js';
+const INITIAL_STATE = {
+    siteDetails: {},
+    features: {
+        aiAssistantFeature: {
+            hasFeature: true,
+            isOverLimit: false,
+            requestsCount: 0,
+            requestsLimit: FREE_PLAN_REQUESTS_LIMIT,
+            requireUpgrade: false,
+            errorMessage: '',
+            errorCode: '',
+            upgradeType: 'default',
+            currentTier: {
+                slug: 'ai-assistant-tier-free',
+                value: 0,
+                limit: 20,
+            },
+            usagePeriod: {
+                currentStart: '',
+                nextStart: '',
+                requestsCount: 0,
+            },
+            nextTier: null,
+            tierPlansEnabled: false,
+            _meta: {
+                isRequesting: false,
+                asyncRequestCountdown: ASYNC_REQUEST_COUNTDOWN_INIT_VALUE,
+                asyncRequestTimerId: 0,
+                isRequestingImage: false,
+            },
+        },
+    },
+    history: [],
+    selectedLogoIndex: 0,
+};
+export default INITIAL_STATE;