Merges feature/schema-aggregation to trunk

admin/tracking/class-tracking-settings-data.php

@@ -244,6 +244,8 @@ class WPSEO_Tracking_Settings_Data implements WPSEO_Collection {
 		'enable_llms_txt',
 		'llms_txt_selection_mode',
 		'configuration_finished_steps',
+		'enable_schema_aggregation_endpoint',
+		'schema_aggregation_endpoint_enabled_on',
 		'enable_task_list',
 		'enable_schema',
 		// No need to add anything from WPSEO_Option_Tracking_Only as they are added automatically below.

composer.json

@@ -35,7 +35,9 @@
 		"psr/log": "^1.0",
 		"symfony/config": "^5.4.46",
 		"symfony/dependency-injection": "^5.4.48",
+		"wpackagist-plugin/easy-digital-downloads": "dev-trunk",
 		"wpackagist-plugin/google-site-kit": "dev-trunk",
+		"wpackagist-plugin/woocommerce": "dev-trunk",
 		"yoast/wp-test-utils": "^1.2.1",
 		"yoast/yoastcs": "^3.3.0"
 	},
@@ -86,7 +88,9 @@
 	"extra": {
 		"installer-paths": {
 			"vendor/{$name}": [
-				"wpackagist-plugin/google-site-kit"
+				"wpackagist-plugin/easy-digital-downloads",
+				"wpackagist-plugin/google-site-kit",
+				"wpackagist-plugin/woocommerce"
 			]
 		}
 	},

inc/options/class-wpseo-option-wpseo.php

@@ -154,6 +154,8 @@ class WPSEO_Option_Wpseo extends WPSEO_Option {
 		'default_seo_title'                                    => [],
 		'default_seo_meta_desc'                                => [],
 		'first_activated_by'                                   => 0,
+		'enable_schema_aggregation_endpoint'                   => false,
+		'schema_aggregation_endpoint_enabled_on'               => null,
 		'enable_task_list'                                     => true,
 		'enable_schema'                                        => true,
 	];
@@ -356,6 +358,7 @@ protected function validate_option( $dirty, $clean, $old ) {
 				case 'site_kit_tracking_setup_widget_temporarily_dismissed':
 				case 'site_kit_tracking_setup_widget_permanently_dismissed':
 				case 'ai_free_sparks_started_on':
+				case 'schema_aggregation_endpoint_enabled_on':
 					if ( isset( $dirty[ $key ] ) ) {
 						$clean[ $key ] = sanitize_text_field( $dirty[ $key ] );
 					}
@@ -549,6 +552,7 @@ protected function validate_option( $dirty, $clean, $old ) {
 				 *  'site_kit_connected',
 				 *  'google_site_kit_feature_enabled',
 				 *  'enable_llms_txt',
+				 *  'enable_schema_aggregation_endpoint'
 				 *  'enable_task_list',
 				 *  'enable_schema',
 				 *  and most of the feature variables.
@@ -622,6 +626,7 @@ public function verify_features_against_network( $options = [] ) {
 			'google_site_kit_feature_enabled'    => false,
 			'enable_llms_txt'                    => false,
 			'enable_task_list'                   => false,
+			'enable_schema_aggregation_endpoint' => false,
 			'enable_schema'                      => false,
 		];
 

packages/js/src/introductions/components/modals/schema-aggregator-announcement.js

@@ -0,0 +1,135 @@
+import { ArrowNarrowRightIcon } from "@heroicons/react/solid";
+import { useSelect } from "@wordpress/data";
+import { useMemo } from "@wordpress/element";
+import { __, sprintf } from "@wordpress/i18n";
+import { Button, useModalContext } from "@yoast/ui-library";
+import { safeCreateInterpolateElement } from "../../../helpers/i18n";
+import { STORE_NAME_INTRODUCTIONS } from "../../constants";
+import { Modal } from "../modal";
+
+
+/**
+ * @returns {JSX.Element} The element.
+ */
+
+const SchemaAggregatorAnnouncementContent = ( {
+	thumbnail,
+	buttonLink,
+	description,
+} ) => {
+	const { onClose, initialFocus } = useModalContext();
+
+	return (
+		<>
+			<div className="yst-px-10 yst-pt-10 yst-introduction-gradient yst-text-center">
+				<img
+					className="yst-w-full yst-h-auto yst-rounded-md yst-shadow-md"
+					alt="Thumbnail for Yoast SEO Google Docs Add-On"
+					loading="lazy"
+					decoding="async"
+					{ ...thumbnail }
+				/>
+				<div className="yst-mt-6 yst-text-xs yst-font-medium yst-flex yst-flex-col yst-items-center">
+					<span className="yst-introduction-modal-uppercase yst-flex yst-gap-2 yst-items-center">
+						<span className="yst-logo-icon" />
+						Yoast SEO
+					</span>
+				</div>
+			</div>
+			<div className="yst-px-10 yst-pb-4 yst-flex yst-flex-col yst-items-center">
+				<div className="yst-mt-4 yst-text-center">
+					<h3 className="yst-text-slate-900 yst-text-lg yst-font-medium">
+						{
+							__( "New: Prepare your site for AI powered discovery! ✨", "wordpress-seo" )
+						}
+					</h3>
+					<div className="yst-mt-2 yst-text-slate-600 yst-text-sm">
+						<p>{ description }</p>
+					</div>
+				</div>
+				<div className="yst-w-full yst-flex yst-mt-6">
+					<Button
+						as="a"
+						className="yst-grow"
+						size="extra-large"
+						variant="primary"
+						href={ buttonLink }
+						ref={ initialFocus }
+					>
+						{ __( "Enable Schema aggregation endpoint", "wordpress-seo" ) }
+						<span className="yst-sr-only">
+							{
+							/* translators: Hidden accessibility text. */
+								__( "(Opens in a new browser tab)", "wordpress-seo" )
+							}
+						</span>
+					</Button>
+				</div>
+				<Button
+					as="a"
+					className="yst-mt-4"
+					variant="tertiary"
+					onClick={ onClose }
+				>
+					{ __( "Close", "wordpress-seo" ) }
+				</Button>
+			</div>
+		</>
+	);
+};
+
+/**
+ * @returns {JSX.Element} The element.
+ */
+export const SchemaAggregatorAnnouncement = () => {
+	const imageLink = useSelect( select => select( STORE_NAME_INTRODUCTIONS ).selectImageLink( "schema-aggregator-thumbnail.png" ), [] );
+	const buttonLink = useSelect( select => select( STORE_NAME_INTRODUCTIONS ).selectLink( "?page=wpseo_page_settings#/site-features#card-wpseo-enable_schema_aggregation_endpoint" ), [] );
+	const learnMoreLink = useSelect( select => select( STORE_NAME_INTRODUCTIONS ).selectLink( "https://yoa.st/schema-aggregation-activation/" ), [] );
+
+	const thumbnail = useMemo( () => ( {
+		src: imageLink,
+		width: "432",
+		height: "243",
+	} ), [ imageLink ] );
+
+	const LearnMoreButton = 		() =>				<Button
+		as="a"
+		href={ learnMoreLink }
+		variant="tertiary"
+		className="yst-p-0 yst-no-underline yst-font-medium yst-inline-flex yst-items-center yst-gap-1"
+		target="_blank"
+		rel="noopener"
+	>
+		{ __( "Learn more", "wordpress-seo" ) }
+		<ArrowNarrowRightIcon className="yst-w-3 yst-h-3 yst-flex-shrink-0 rtl:yst-rotate-180" />
+		<span className="yst-sr-only">
+			{
+				/* translators: Hidden accessibility text. */
+				__( "(Opens in a new browser tab)", "wordpress-seo" )
+			}
+		</span>
+	</Button>;
+
+	const description = useMemo( () => safeCreateInterpolateElement(
+		sprintf(
+			/**
+			 * translators: %1$s expands to an opening anchor tag; %2$s expands to the arrow icon   ; %3$s expands to a closing anchor tag.
+			 */
+			__( "Enable the Schema aggregation endpoint to make your Schema readable by AI systems. %1$s", "wordpress-seo" ),
+			"<LearnMoreButton />"
+		),
+		{
+			LearnMoreButton: <LearnMoreButton />,
+		}
+	), [] );
+
+	return (
+		<Modal>
+			<SchemaAggregatorAnnouncementContent
+				buttonLink={ buttonLink }
+				thumbnail={ thumbnail }
+				description={ description }
+			/>
+		</Modal>
+	);
+};

packages/js/src/introductions/initialize.js

@@ -10,6 +10,7 @@ import { Introduction, IntroductionProvider } from "./components";
 import { AiBrandInsightsPostLaunch } from "./components/modals/ai-brand-insights-post-launch";
 import { BlackFridayAnnouncement } from "./components/modals/black-friday-announcement";
 import { DelayedPremiumUpsell } from "./components/modals/delayed-premium-upsell";
+import { SchemaAggregatorAnnouncement } from "./components/modals/schema-aggregator-announcement";
 import { STORE_NAME_INTRODUCTIONS } from "./constants";
 import { registerStore } from "./store";
 
@@ -25,6 +26,7 @@ domReady( () => {
 		"ai-brand-insights-post-launch": AiBrandInsightsPostLaunch,
 		"black-friday-announcement": BlackFridayAnnouncement,
 		"delayed-premium-upsell": DelayedPremiumUpsell,
+		"schema-aggregator-announcement": SchemaAggregatorAnnouncement,
 	};
 
 	if ( location.href.indexOf( "page=wpseo_dashboard#/first-time-configuration" ) !== -1 ) {

packages/js/src/settings/site-features/ai-tools.js

@@ -1,6 +1,7 @@
 import { __ } from "@wordpress/i18n";
 import { ReactComponent as AIGeneratorIcon } from "../../../../../images/icon-sparkles.svg";
 import { ReactComponent as LlmtxtIcon } from "../../../../../images/icon-llms-txt.svg";
+import { ReactComponent as SchemaAggregationIcon } from "../../../../../images/icon-schema-aggregation-endpoint.svg";
 
 export const aiToolsFeatures = {
 	aiGenerator: {
@@ -27,4 +28,16 @@ export const aiToolsFeatures = {
 		learnMoreLinkId: "link-llms-txt",
 		learnMoreLinkAriaLabel: __( "llms.txt", "wordpress-seo" ),
 	},
+	schemaAggregation: {
+		name: "wpseo.enable_schema_aggregation_endpoint",
+		id: "card-wpseo-enable_schema_aggregation_endpoint",
+		inputId: "input-wpseo-enable_schema_aggregation_endpoint",
+		Icon: SchemaAggregationIcon,
+		isPremiumFeature: false,
+		title: __( "Schema aggregation endpoint", "wordpress-seo" ),
+		description: __( "Provides everything required to connect with your site's public structured data. This enables conversational interfaces like NLWeb to power natural language queries on your content.", "wordpress-seo" ),
+		learnMoreUrl: "https://yoa.st/site-features-schema-aggregation-endpoint-learn-more",
+		learnMoreLinkId: "link-schema-aggregation-endpoint",
+		learnMoreLinkAriaLabel: __( "Schema aggregation endpoint", "wordpress-seo" ),
+	},
 };