@automattic/jetpack-ai-client 0.14.6 → 0.15.0

package/src/logo-generator/store/types.ts

@@ -0,0 +1,207 @@
+import type { SiteDetails } from '../types.js';
+
+/**
+ * Types for the AI Assistant feature.
+ */
+export type Plan = {
+	product_id: number;
+	product_name: string;
+	product_slug: string;
+};
+// AI Assistant feature props
+export type UpgradeTypeProp = 'vip' | 'default';
+
+export type TierUnlimitedProps = {
+	slug: 'ai-assistant-tier-unlimited';
+	limit: 999999999;
+	value: 1;
+	readableLimit: string;
+};
+
+export type TierFreeProps = {
+	slug: 'ai-assistant-tier-free';
+	limit: 20;
+	value: 0;
+};
+
+export type Tier100Props = {
+	slug: 'ai-assistant-tier-100';
+	limit: 100;
+	value: 100;
+};
+
+export type Tier200Props = {
+	slug: 'ai-assistant-tier-200';
+	limit: 200;
+	value: 200;
+};
+
+export type Tier500Props = {
+	slug: 'ai-assistant-tier-500';
+	limit: 500;
+	value: 500;
+};
+
+export type Tier750Props = {
+	slug: 'ai-assistant-tier-750';
+	limit: 750;
+	value: 750;
+};
+
+export type Tier1000Props = {
+	slug: 'ai-assistant-tier-1000';
+	limit: 1000;
+	value: 1000;
+};
+
+export type TierProp = {
+	slug: TierSlugProp;
+	limit: TierLimitProp;
+	value: TierValueProp;
+	readableLimit?: string;
+};
+
+export type TierLimitProp =
+	| TierUnlimitedProps[ 'limit' ]
+	| TierFreeProps[ 'limit' ]
+	| Tier100Props[ 'limit' ]
+	| Tier200Props[ 'limit' ]
+	| Tier500Props[ 'limit' ]
+	| Tier750Props[ 'limit' ]
+	| Tier1000Props[ 'limit' ];
+
+export type TierSlugProp =
+	| TierUnlimitedProps[ 'slug' ]
+	| TierFreeProps[ 'slug' ]
+	| Tier100Props[ 'slug' ]
+	| Tier200Props[ 'slug' ]
+	| Tier500Props[ 'slug' ]
+	| Tier750Props[ 'slug' ]
+	| Tier1000Props[ 'slug' ];
+
+export type TierValueProp =
+	| TierUnlimitedProps[ 'value' ]
+	| TierFreeProps[ 'value' ]
+	| Tier100Props[ 'value' ]
+	| Tier200Props[ 'value' ]
+	| Tier500Props[ 'value' ]
+	| Tier750Props[ 'value' ]
+	| Tier1000Props[ 'value' ];
+
+export type AiFeatureProps = {
+	hasFeature: boolean;
+	isOverLimit: boolean;
+	requestsCount: number;
+	requestsLimit: number;
+	requireUpgrade: boolean;
+	errorMessage?: string;
+	errorCode?: string;
+	upgradeType: UpgradeTypeProp;
+	currentTier?: TierProp;
+	usagePeriod?: {
+		currentStart: string;
+		nextStart: string;
+		requestsCount: number;
+	};
+	nextTier?: TierProp | null;
+	tierPlansEnabled?: boolean;
+	costs?: {
+		'jetpack-ai-logo-generator': {
+			logo: number;
+		};
+	};
+};
+
+// Type used in the `wordpress-com/plans` store.
+export type AiFeatureStateProps = AiFeatureProps & {
+	_meta?: {
+		isRequesting: boolean;
+		asyncRequestCountdown: number;
+		asyncRequestTimerId: number;
+		isRequestingImage: boolean;
+	};
+};
+
+export type Logo = {
+	url: string;
+	description: string;
+	mediaId?: number;
+};
+
+export type RequestError = string | Error | null;
+
+export type LogoGeneratorStateProp = {
+	_meta?: {
+		isSavingLogoToLibrary: boolean;
+		isApplyingLogo: boolean;
+		isRequestingImage: boolean;
+		isEnhancingPrompt: boolean;
+		featureFetchError?: RequestError;
+		firstLogoPromptFetchError?: RequestError;
+		enhancePromptFetchError?: RequestError;
+		logoFetchError?: RequestError;
+		saveToLibraryError?: RequestError;
+		logoUpdateError?: RequestError;
+		context: string;
+	};
+	siteDetails?: SiteDetails | Record< string, never >;
+	features: {
+		aiAssistantFeature?: AiFeatureStateProps;
+	};
+	history: Array< Logo >;
+	selectedLogoIndex: number;
+};
+
+export type Selectors = {
+	getAiAssistantFeature( siteId?: string ): Partial< AiFeatureProps >;
+	getIsRequestingAiAssistantFeature(): boolean;
+	getLogos(): Array< Logo >;
+	getSelectedLogoIndex(): number | null;
+	getSelectedLogo(): Logo;
+	getSiteDetails(): SiteDetails;
+	getIsSavingLogoToLibrary(): boolean;
+	getIsApplyingLogo(): boolean;
+	getIsRequestingImage(): boolean;
+	getIsEnhancingPrompt(): boolean;
+	getIsBusy(): boolean;
+	getRequireUpgrade(): boolean;
+	getFeatureFetchError(): RequestError;
+	getFirstLogoPromptFetchError(): RequestError;
+	getEnhancePromptFetchError(): RequestError;
+	getLogoFetchError(): RequestError;
+	getSaveToLibraryError(): RequestError;
+	getLogoUpdateError(): RequestError;
+	getContext(): string;
+};
+
+/*
+ * `sites/$site/ai-assistant-feature` endpoint response body props
+ */
+export type AiAssistantFeatureEndpointResponseProps = {
+	'is-enabled': boolean;
+	'has-feature': boolean;
+	'is-over-limit': boolean;
+	'requests-count': number;
+	'requests-limit': number;
+	'usage-period': {
+		'current-start': string;
+		'next-start': string;
+		'requests-count': number;
+	};
+	'site-require-upgrade': boolean;
+	'error-message'?: string;
+	'error-code'?: string;
+	'is-playground-visible'?: boolean;
+	'upgrade-type': UpgradeTypeProp;
+	'current-tier': TierProp;
+	'tier-plans': Array< TierProp >;
+	'next-tier'?: TierProp | null;
+	'tier-plans-enabled': boolean;
+	costs: {
+		'jetpack-ai-logo-generator': {
+			logo: number;
+		};
+	};
+};
+
+export type SaveLogo = ( logo: Logo ) => Promise< { mediaId: number; mediaURL: string } >;

package/src/logo-generator/types.ts

@@ -0,0 +1,97 @@
+/**
+ * Types
+ */
+import type { Logo } from './store/types.js';
+
+export type SiteDetails = {
+	ID: number;
+	URL: string;
+	domain: string;
+	name: string;
+	description: string;
+};
+
+export interface GeneratorModalProps {
+	siteDetails?: SiteDetails;
+	isOpen: boolean;
+	onClose: () => void;
+	context: string;
+}
+
+export interface LogoPresenterProps {
+	logo?: Logo;
+	loading?: boolean;
+	onApplyLogo: () => void;
+	logoAccepted?: boolean;
+	siteId: string | number;
+}
+
+export type SaveToMediaLibraryProps = {
+	siteId: string | number;
+	url: string;
+	attrs?: {
+		caption?: string;
+		description?: string;
+		title?: string;
+		alt?: string;
+	};
+};
+
+export type SaveToMediaLibraryResponseProps = {
+	code: number;
+	media: [
+		{
+			ID: number;
+			URL: string;
+		},
+	];
+};
+
+export type CheckMediaProps = {
+	siteId: string | number;
+	mediaId: Logo[ 'mediaId' ];
+};
+
+export type SetSiteLogoProps = {
+	siteId: string | number;
+	imageId: string | number;
+};
+
+export type SetSiteLogoResponseProps = {
+	id: number;
+	url: string;
+};
+
+// Token
+export type RequestTokenOptions = {
+	siteDetails?: SiteDetails;
+	isJetpackSite?: boolean;
+	expirationTime?: number;
+};
+
+export type TokenDataProps = {
+	token: string;
+	blogId: string | undefined;
+	expire: number;
+};
+
+export type TokenDataEndpointResponseProps = {
+	token: string;
+	blog_id: string;
+};
+
+export type SaveToStorageProps = Logo & {
+	siteId: string;
+};
+
+export type UpdateInStorageProps = {
+	siteId: string;
+	url: Logo[ 'url' ];
+	newUrl: Logo[ 'url' ];
+	mediaId: Logo[ 'mediaId' ];
+};
+
+export type RemoveFromStorageProps = {
+	mediaId: Logo[ 'mediaId' ];
+	siteId: string;
+};

package/src/types.ts

@@ -1,3 +1,5 @@
+import type * as BlockEditorSelectors from '@wordpress/block-editor/store/selectors.js';
+
 export const ERROR_SERVICE_UNAVAILABLE = 'error_service_unavailable' as const;
 export const ERROR_QUOTA_EXCEEDED = 'error_quota_exceeded' as const;
 export const ERROR_MODERATION = 'error_moderation' as const;
@@ -113,3 +115,9 @@ export type TranscriptionState = RecordingState | 'validating' | 'processing' |
  * Lib types
  */
 export type { RenderHTMLRules } from './libs/index.js';
+
+export interface BlockEditorStore {
+	selectors: {
+		[ key in keyof typeof BlockEditorSelectors ]: ( typeof BlockEditorSelectors )[ key ];
+	};
+}