@automattic/jetpack-ai-client 0.33.32 → 0.34.1

package/build/chrome-ai/suggestions.js

@@ -1,160 +0,0 @@
-import debugFactory from 'debug';
-import { PROMPT_TYPE_CHANGE_LANGUAGE, PROMPT_TYPE_SUMMARIZE } from "../constants.js";
-import { getErrorData } from "../hooks/use-ai-suggestions/index.js";
-import { renderHTMLFromMarkdown, renderMarkdownFromHTML } from "../libs/markdown/index.js";
-import { ERROR_RESPONSE, ERROR_NETWORK } from "../types.js";
-const debug = debugFactory('ai-client:chrome-ai-suggestions');
-export default class ChromeAISuggestionsEventSource extends EventTarget {
-    fullMessage;
-    fullFunctionCall;
-    isPromptClear;
-    controller;
-    errorUnclearPromptTriggered;
-    constructor(data) {
-        super();
-        this.fullMessage = '';
-        this.fullFunctionCall = {
-            name: '',
-            arguments: '',
-        };
-        this.isPromptClear = false;
-        this.controller = new AbortController();
-        this.initSource(data);
-    }
-    initSource({ content, promptType, options = {}, }) {
-        debug('initSource', content, promptType, options);
-        if (promptType === PROMPT_TYPE_CHANGE_LANGUAGE) {
-            this.translate(content, options.targetLanguage, options.sourceLanguage);
-        }
-        if (promptType === PROMPT_TYPE_SUMMARIZE) {
-            this.summarize(content, options.tone, options.wordCount);
-        }
-    }
-    async initEventSource() { }
-    close() { }
-    checkForUnclearPrompt() { }
-    processEvent(e) {
-        let data;
-        debug('processEvent', e);
-        try {
-            data = JSON.parse(e.data);
-        }
-        catch (err) {
-            this.processErrorEvent(err);
-            return;
-        }
-        if (e.event === 'translation' || e.event === 'summary') {
-            this.dispatchEvent(new CustomEvent('suggestion', { detail: data.message }));
-        }
-        if (data.complete) {
-            this.dispatchEvent(new CustomEvent('done', { detail: { message: data.message, source: 'chromeAI' } }));
-        }
-    }
-    processErrorEvent(e) {
-        debug('processErrorEvent', e);
-        // Dispatch a generic network error event
-        this.dispatchEvent(new CustomEvent(ERROR_NETWORK, { detail: e }));
-        this.dispatchEvent(new CustomEvent(ERROR_RESPONSE, {
-            detail: getErrorData(ERROR_NETWORK),
-        }));
-    }
-    // use the Chrome AI translator
-    async translate(text, target, source = '') {
-        if (!('Translator' in self)) {
-            return;
-        }
-        const translatorAvailability = await self.Translator.availability({
-            sourceLanguage: source,
-            targetLanguage: target,
-        });
-        if (translatorAvailability === 'unavailable') {
-            debug('awaiting translator ready');
-            this.processErrorEvent({
-                message: 'Translator is unavailable',
-            });
-            return;
-        }
-        const translator = await self.Translator.create({
-            sourceLanguage: source,
-            targetLanguage: target,
-        });
-        if (!translator) {
-            this.processErrorEvent({
-                message: 'Translator failed to initialize',
-            });
-            return;
-        }
-        try {
-            const translation = await translator.translate(renderHTMLFromMarkdown({ content: text }));
-            this.processEvent({
-                id: '',
-                event: 'translation',
-                data: JSON.stringify({
-                    message: renderMarkdownFromHTML({ content: translation }),
-                    complete: true,
-                }),
-            });
-        }
-        catch (error) {
-            this.processErrorEvent(error);
-        }
-    }
-    // Helper function to format summarizer options
-    getSummarizerOptions(tone, wordCount) {
-        let sharedContext = `The summary you write should contain strictly less than ${wordCount ?? 50} words. Strive for precision in word count without compromising clarity and significance`;
-        if (tone) {
-            sharedContext += `\n - Write with a ${tone} tone.\n`;
-        }
-        const options = {
-            sharedContext: sharedContext,
-            type: 'teaser',
-            format: 'plain-text',
-            length: 'medium',
-        };
-        return options;
-    }
-    // use the Chrome AI summarizer
-    async summarize(text, tone, wordCount) {
-        debug('summarize', text, tone, wordCount);
-        if (!('Summarizer' in self)) {
-            return;
-        }
-        const availability = await self.Summarizer.availability();
-        if (availability === 'unavailable') {
-            this.processErrorEvent({
-                data: { message: 'Summarizer is unavailable' },
-            });
-            return;
-        }
-        const summarizerOptions = this.getSummarizerOptions(tone, wordCount);
-        const summarizer = await self.Summarizer.create(summarizerOptions);
-        if (availability !== 'available') {
-            debug('awaiting summarizer ready');
-            await summarizer.ready;
-        }
-        try {
-            const context = `Write with a ${tone} tone.`;
-            debug('context', context);
-            let summary = await summarizer.summarize(text, { context: context });
-            debug('summary', summary);
-            wordCount = wordCount ?? 50;
-            // gemini-nano has a tendency to exceed the word count, so we need to check and summarize again if necessary
-            if (summary.split(' ').length > wordCount) {
-                debug('summary exceeds word count');
-                summary = await summarizer.summarize(summary, { context: context });
-            }
-            this.processEvent({
-                id: '',
-                event: 'summary',
-                data: JSON.stringify({
-                    message: summary,
-                    complete: true,
-                }),
-            });
-        }
-        catch (error) {
-            debug('error', error);
-            this.processErrorEvent(error);
-        }
-    }
-}

package/src/chrome-ai/factory.ts

@@ -1,199 +0,0 @@
-import debugFactory from 'debug';
-import { PROMPT_TYPE_CHANGE_LANGUAGE, PROMPT_TYPE_SUMMARIZE } from '../constants.ts';
-import { PromptProp, PromptItemProps } from '../types.ts';
-import { isChromeAIAvailable } from './get-availability.ts';
-import ChromeAISuggestionsEventSource from './suggestions.ts';
-
-const debug = debugFactory( 'ai-client:chrome-ai-factory' );
-
-interface PromptContext {
-	type?: string;
-	content?: string;
-	language?: string;
-	tone?: string;
-	words?: number;
-}
-
-/**
- * This will return an instance of ChromeAISuggestionsEventSource or false.
- *
- * @param promptArg - The messages array of the prompt.
- * @return ChromeAISuggestionsEventSource | bool
- */
-export default async function ChromeAIFactory( promptArg: PromptProp ) {
-	if ( ! ( await isChromeAIAvailable() ) ) {
-		debug( 'Chrome AI is not available' );
-		return false;
-	}
-
-	const context = {
-		content: '',
-		language: '',
-	};
-
-	let promptType = '';
-	let tone = null;
-	let wordCount = null;
-
-	debug( 'promptArg', promptArg );
-	if ( Array.isArray( promptArg ) ) {
-		for ( let i = 0; i < promptArg.length; i++ ) {
-			const prompt: PromptItemProps = promptArg[ i ];
-			if ( prompt.content ) {
-				context.content = prompt.content;
-			}
-
-			if ( ! ( 'context' in prompt ) ) {
-				continue;
-			}
-
-			const promptContext: PromptContext = prompt.context;
-
-			if ( promptContext.type ) {
-				promptType = promptContext.type;
-			}
-
-			if ( promptContext.language ) {
-				context.language = promptContext.language;
-			}
-
-			if ( promptContext.content ) {
-				context.content = promptContext.content;
-			}
-
-			if ( promptContext.tone ) {
-				tone = promptContext.tone;
-			}
-
-			if ( promptContext.words ) {
-				wordCount = promptContext.words;
-			}
-		}
-	}
-
-	debug( 'promptType', promptType );
-	// Early return if the prompt type is not supported.
-	if (
-		! promptType.startsWith( 'ai-assistant-change-language' ) &&
-		! promptType.startsWith( 'ai-content-lens' )
-	) {
-		debug( 'promptType is not supported' );
-		return false;
-	}
-
-	// If the languageDetector is not available, we can't use the translation or summary features—it's safer to fall back
-	// to the default AI model than to risk an unexpected error.
-	if (
-		! ( 'LanguageDetector' in self ) ||
-		! self.LanguageDetector.create ||
-		! self.LanguageDetector.availability
-	) {
-		debug( 'LanguageDetector is not available' );
-		return false;
-	}
-
-	const languageDetectorAvailability = await self.LanguageDetector.availability();
-	if ( languageDetectorAvailability === 'unavailable' ) {
-		debug( 'LanguageDetector is unavailable' );
-		return false;
-	}
-
-	const detector = await self.LanguageDetector.create();
-	if ( languageDetectorAvailability !== 'available' ) {
-		debug( 'awaiting detector ready' );
-		await detector.ready;
-	}
-
-	if ( promptType.startsWith( 'ai-assistant-change-language' ) ) {
-		const [ language ] = context.language.split( ' ' );
-
-		if (
-			! ( 'Translator' in self ) ||
-			! self.Translator.create ||
-			! self.Translator.availability
-		) {
-			debug( 'Translator is not available' );
-			return false;
-		}
-
-		const languageOpts = {
-			sourceLanguage: 'en',
-			targetLanguage: language,
-		};
-
-		const confidences = await detector.detect( context.content );
-
-		for ( const confidence of confidences ) {
-			// 75% confidence is just a value that was picked. Generally
-			// 80% of higher is pretty safe, but the source language is
-			// required for the translator to work at all, which is also
-			// why en is the default language.
-			if ( confidence.confidence > 0.75 ) {
-				languageOpts.sourceLanguage = confidence.detectedLanguage;
-				break;
-			}
-		}
-
-		debug( 'languageOpts', languageOpts );
-		const translationAvailability = await self.Translator.availability( languageOpts );
-
-		debug( 'translationAvailability', translationAvailability );
-		if ( translationAvailability === 'unavailable' ) {
-			debug( 'Translator is unavailable' );
-			return false;
-		}
-
-		const chromeAI = new ChromeAISuggestionsEventSource( {
-			content: context.content,
-			promptType: PROMPT_TYPE_CHANGE_LANGUAGE,
-			options: languageOpts,
-		} );
-
-		return chromeAI;
-	}
-
-	if ( promptType.startsWith( 'ai-content-lens' ) ) {
-		if ( ! ( 'Summarizer' in self ) ) {
-			debug( 'Summarizer is not available' );
-			return false;
-		}
-
-		if ( context.language && context.language !== 'en (English)' ) {
-			debug( 'Summary is not English' );
-			return false;
-		}
-
-		debug( 'awaiting detector detect' );
-		const confidences = await detector.detect( context.content );
-
-		// if it doesn't look like the content is in English, we can't use the summary feature
-		for ( const confidence of confidences ) {
-			// 75% confidence is just a value that was picked. Generally
-			// 80% of higher is pretty safe, but the source language is
-			// required for the translator to work at all, which is also
-			// why en is the default language.
-			if ( confidence.confidence > 0.75 && confidence.detectedLanguage !== 'en' ) {
-				debug( 'Confidence for non-English content' );
-				return false;
-			}
-		}
-
-		const summaryOpts = {
-			tone: tone,
-			wordCount: wordCount,
-		};
-
-		debug( 'summaryOpts', summaryOpts );
-
-		const chromeAiEventSourceOpts = {
-			content: context.content,
-			promptType: PROMPT_TYPE_SUMMARIZE,
-			options: summaryOpts,
-		};
-
-		debug( 'chromeAiEventSourceOpts', chromeAiEventSourceOpts );
-		return new ChromeAISuggestionsEventSource( chromeAiEventSourceOpts );
-	}
-
-	return false;
-}

package/src/chrome-ai/get-availability.ts

@@ -1,105 +0,0 @@
-/**
- * External dependencies
- */
-import { initializeExPlat, createExPlatClient } from '@automattic/jetpack-explat';
-import { select } from '@wordpress/data';
-import { addQueryArgs } from '@wordpress/url';
-import debugFactory from 'debug';
-/**
- * Internal dependencies
- */
-import apiFetch from '../api-fetch/index.ts';
-
-/**
- * Types
- */
-type FeatureControl = {
-	enabled: boolean;
-};
-
-type PlansSelect = {
-	getAiAssistantFeature: () => {
-		currentTier?: { value: number };
-		featuresControl?: Record< string, FeatureControl >;
-	};
-};
-
-const debug = debugFactory( 'ai-client:chrome-ai-availability' );
-
-/**
- * Get the AI Assistant feature.
- *
- * @return {object} The AI Assistant feature.
- */
-function getAiAssistantFeature() {
-	const { getAiAssistantFeature: getFeature } = select( 'wordpress-com/plans' ) as PlansSelect;
-	return getFeature();
-}
-
-/**
- * Fetch an experiment assignment.
- *
- * @param {boolean} asConnectedUser - Whether the user is connected.
- * @return {Function} A function that fetches an experiment assignment.
- */
-const fetchExperimentAssignmentWithConnectedUser = async ( {
-	experimentName,
-}: {
-	experimentName: string;
-} ): Promise< unknown > => {
-	const params = {
-		experiment_name: experimentName,
-		anon_id: undefined,
-		as_connected_user: true,
-	};
-
-	debug( 'params', params );
-
-	const assignmentsRequestUrl = addQueryArgs(
-		'https://public-api.wordpress.com/wpcom/v2/experiments/0.1.0/assignments/jetpack',
-		params
-	);
-
-	debug( 'assignmentsRequestUrl', assignmentsRequestUrl );
-
-	return apiFetch( {
-		url: assignmentsRequestUrl,
-		credentials: 'include',
-		mode: 'cors',
-		global: true,
-	} );
-};
-
-/**
- * Check if Chrome AI can be enabled.
- *
- * @return {boolean} Whether Chrome AI can be enabled.
- */
-export async function isChromeAIAvailable() {
-	const { featuresControl } = getAiAssistantFeature();
-
-	// Extra check if we want to control this via the feature flag for now
-	if ( featuresControl?.[ 'chrome-ai' ]?.enabled !== true ) {
-		debug( 'feature is disabled for this site/user' );
-		return false;
-	}
-
-	initializeExPlat();
-
-	const { loadExperimentAssignment: loadExperimentAssignmentWithAuth } = createExPlatClient( {
-		fetchExperimentAssignment: fetchExperimentAssignmentWithConnectedUser,
-		getAnonId: async () => null,
-		logError: debug,
-		isDevelopmentMode: false,
-	} );
-
-	const { variationName } = await loadExperimentAssignmentWithAuth(
-		'calypso_jetpack_ai_gemini_api_202503_v2'
-	);
-
-	debug( 'variationName', variationName );
-
-	return variationName === 'treatment';
-}
-
-export default isChromeAIAvailable;

package/src/chrome-ai/index.ts

@@ -1,2 +0,0 @@
-export { default as ChromeAIFactory } from './factory.ts';
-export { default as ChromeAISuggestionsEventSource } from './suggestions.ts';

package/src/chrome-ai/suggestions.ts

@@ -1,235 +0,0 @@
-import { EventSourceMessage } from '@microsoft/fetch-event-source';
-import debugFactory from 'debug';
-import { PROMPT_TYPE_CHANGE_LANGUAGE, PROMPT_TYPE_SUMMARIZE } from '../constants.ts';
-import { getErrorData } from '../hooks/use-ai-suggestions/index.ts';
-import { renderHTMLFromMarkdown, renderMarkdownFromHTML } from '../libs/markdown/index.ts';
-import { AiModelTypeProp, ERROR_RESPONSE, ERROR_NETWORK } from '../types.ts';
-
-type ChromeAISuggestionsEventSourceConstructorArgs = {
-	content: string;
-	promptType: string;
-	options?: {
-		postId?: number | string;
-		feature?: 'ai-assistant-experimental' | string | undefined;
-
-		// translation
-		sourceLanguage?: string;
-		targetLanguage?: string;
-
-		// summarization
-		tone?: string;
-		wordCount?: number;
-
-		// not sure if we need these
-		functions?: Array< object >;
-		model?: AiModelTypeProp;
-	};
-};
-
-type ChromeAIEvent = {
-	type: string;
-	message: string;
-	complete?: boolean;
-};
-
-type FunctionCallProps = {
-	name?: string;
-	arguments?: string;
-};
-
-const debug = debugFactory( 'ai-client:chrome-ai-suggestions' );
-
-export default class ChromeAISuggestionsEventSource extends EventTarget {
-	fullMessage: string;
-	fullFunctionCall: FunctionCallProps;
-	isPromptClear: boolean;
-	controller: AbortController;
-
-	errorUnclearPromptTriggered: boolean;
-
-	constructor( data: ChromeAISuggestionsEventSourceConstructorArgs ) {
-		super();
-		this.fullMessage = '';
-		this.fullFunctionCall = {
-			name: '',
-			arguments: '',
-		};
-		this.isPromptClear = false;
-
-		this.controller = new AbortController();
-
-		this.initSource( data );
-	}
-
-	initSource( {
-		content,
-		promptType,
-		options = {},
-	}: ChromeAISuggestionsEventSourceConstructorArgs ) {
-		debug( 'initSource', content, promptType, options );
-		if ( promptType === PROMPT_TYPE_CHANGE_LANGUAGE ) {
-			this.translate( content, options.targetLanguage, options.sourceLanguage );
-		}
-
-		if ( promptType === PROMPT_TYPE_SUMMARIZE ) {
-			this.summarize( content, options.tone, options.wordCount );
-		}
-	}
-
-	async initEventSource() {}
-
-	close() {}
-
-	checkForUnclearPrompt() {}
-
-	processEvent( e: EventSourceMessage ) {
-		let data: ChromeAIEvent;
-		debug( 'processEvent', e );
-		try {
-			data = JSON.parse( e.data );
-		} catch ( err ) {
-			this.processErrorEvent( err );
-			return;
-		}
-
-		if ( e.event === 'translation' || e.event === 'summary' ) {
-			this.dispatchEvent( new CustomEvent( 'suggestion', { detail: data.message } ) );
-		}
-
-		if ( data.complete ) {
-			this.dispatchEvent(
-				new CustomEvent( 'done', { detail: { message: data.message, source: 'chromeAI' } } )
-			);
-		}
-	}
-
-	processErrorEvent( e ) {
-		debug( 'processErrorEvent', e );
-		// Dispatch a generic network error event
-		this.dispatchEvent( new CustomEvent( ERROR_NETWORK, { detail: e } ) );
-		this.dispatchEvent(
-			new CustomEvent( ERROR_RESPONSE, {
-				detail: getErrorData( ERROR_NETWORK ),
-			} )
-		);
-	}
-
-	// use the Chrome AI translator
-	async translate( text: string, target: string, source: string = '' ) {
-		if ( ! ( 'Translator' in self ) ) {
-			return;
-		}
-
-		const translatorAvailability = await self.Translator.availability( {
-			sourceLanguage: source,
-			targetLanguage: target,
-		} );
-
-		if ( translatorAvailability === 'unavailable' ) {
-			debug( 'awaiting translator ready' );
-			this.processErrorEvent( {
-				message: 'Translator is unavailable',
-			} );
-			return;
-		}
-
-		const translator = await self.Translator.create( {
-			sourceLanguage: source,
-			targetLanguage: target,
-		} );
-
-		if ( ! translator ) {
-			this.processErrorEvent( {
-				message: 'Translator failed to initialize',
-			} );
-			return;
-		}
-
-		try {
-			const translation = await translator.translate( renderHTMLFromMarkdown( { content: text } ) );
-
-			this.processEvent( {
-				id: '',
-				event: 'translation',
-				data: JSON.stringify( {
-					message: renderMarkdownFromHTML( { content: translation } ),
-					complete: true,
-				} ),
-			} );
-		} catch ( error ) {
-			this.processErrorEvent( error );
-		}
-	}
-
-	// Helper function to format summarizer options
-	private getSummarizerOptions( tone?: string, wordCount?: number ) {
-		let sharedContext = `The summary you write should contain strictly less than ${
-			wordCount ?? 50
-		} words. Strive for precision in word count without compromising clarity and significance`;
-
-		if ( tone ) {
-			sharedContext += `\n - Write with a ${ tone } tone.\n`;
-		}
-
-		const options = {
-			sharedContext: sharedContext,
-			type: 'teaser',
-			format: 'plain-text',
-			length: 'medium',
-		};
-
-		return options;
-	}
-
-	// use the Chrome AI summarizer
-	async summarize( text: string, tone?: string, wordCount?: number ) {
-		debug( 'summarize', text, tone, wordCount );
-		if ( ! ( 'Summarizer' in self ) ) {
-			return;
-		}
-
-		const availability = await self.Summarizer.availability();
-
-		if ( availability === 'unavailable' ) {
-			this.processErrorEvent( {
-				data: { message: 'Summarizer is unavailable' },
-			} );
-			return;
-		}
-
-		const summarizerOptions = this.getSummarizerOptions( tone, wordCount );
-
-		const summarizer = await self.Summarizer.create( summarizerOptions );
-
-		if ( availability !== 'available' ) {
-			debug( 'awaiting summarizer ready' );
-			await summarizer.ready;
-		}
-
-		try {
-			const context = `Write with a ${ tone } tone.`;
-			debug( 'context', context );
-			let summary = await summarizer.summarize( text, { context: context } );
-			debug( 'summary', summary );
-			wordCount = wordCount ?? 50;
-
-			// gemini-nano has a tendency to exceed the word count, so we need to check and summarize again if necessary
-			if ( summary.split( ' ' ).length > wordCount ) {
-				debug( 'summary exceeds word count' );
-				summary = await summarizer.summarize( summary, { context: context } );
-			}
-
-			this.processEvent( {
-				id: '',
-				event: 'summary',
-				data: JSON.stringify( {
-					message: summary,
-					complete: true,
-				} ),
-			} );
-		} catch ( error ) {
-			debug( 'error', error );
-			this.processErrorEvent( error );
-		}
-	}
-}