WIP: Start work on integrating the new WordPress Abilities API

composer.json

@@ -13,7 +13,8 @@
     "php": ">=7.4",
     "yahnis-elsts/plugin-update-checker": "5.1",
     "aws/aws-sdk-php": "^3.300",
-    "woocommerce/action-scheduler": "3.8.1"
+    "woocommerce/action-scheduler": "3.8.1",
+    "wordpress/abilities-api": "^0.1"
   },
   "autoload": {
     "psr-4": {

includes/Classifai/Features/Feature.php

@@ -74,6 +74,10 @@ public function setup() {
 		if ( $this->is_feature_enabled() ) {
 			$this->feature_setup();
 		}
+
+		if ( $this->is_enabled() ) {
+			add_action( 'abilities_api_init', [ $this, 'abilities_api_init' ] );
+		}
 	}
 
 	/**
@@ -84,6 +88,25 @@ public function setup() {
 	public function feature_setup() {
 	}
 
+	/**
+	 * Register an ability after the abilities API is initialized.
+	 *
+	 * Only fires if the Feature is enabled and configured.
+	 */
+	public function abilities_api_init() {
+		if ( function_exists( 'wp_register_ability' ) ) {
+			$this->register_ability();
+		}
+	}
+
+	/**
+	 * Register the ability for the Feature.
+	 *
+	 * Override this method in the Feature to register an ability.
+	 */
+	public function register_ability() {
+	}
+
 	/**
 	 * Assigns user roles to the $roles array.
 	 */

includes/Classifai/Features/TitleGeneration.php

@@ -95,6 +95,58 @@
 		add_action( 'edit_form_before_permalink', [ $this, 'register_generated_titles_template' ] );
 	}
 
+	/**
+	 * Register the ability for the Feature.
+	 */
+	public function register_ability() {
+		wp_register_ability(
+			'classifai/generate-title',
+			[
+				'label'               => esc_html__( 'Generate title suggestions', 'classifai' ),
+				'description'         => esc_html__( 'Use AI to generate title suggestions based on content. This can be content that is passed in or content that is pulled from a post via the post ID. Will return an array of title suggestions.', 'classifai' ),
+				'input_schema'        => [
+					'type'       => 'object',
+					'properties' => [
+						'content' => [
+							'type'              => 'string',
+							'sanitize_callback' => 'sanitize_text_field',
+							'description'       => esc_html__( 'Content to generate a title for.', 'classifai' ),
+						],
+						'id'      => [
+							'type'              => 'integer',
+							'sanitize_callback' => 'absint',
+							'description'       => esc_html__( 'Post ID to generate a title for.', 'classifai' ),
+						],
+						'n'       => [
+							'type'              => 'integer',
+							'minimum'           => 1,
+							'maximum'           => 10,
+							'sanitize_callback' => 'absint',
+							'description'       => esc_html__( 'Number of titles to generate', 'classifai' ),
+						],
+					],
+				],
+				'output_schema'       => [
+					'type'       => 'object',
+					'properties' => [
+						'titles' => [
+							'type'  => 'array',
+							'items' => [
+								'type'        => 'string',
+								'description' => esc_html__( 'Title suggestion', 'classifai' ),
+							],
+						],
+					],
+				],
+				'execute_callback'    => [ $this, 'abilities_api_callback' ],
+				'permission_callback' => [ $this, 'abilities_api_permissions_check' ],
+				'meta'                => [
+					'type' => 'tool',
+				],
+			]
+		);
+	}
+
 	/**
 	 * Register any needed endpoints.
 	 */
@@ -202,6 +254,66 @@
 		return parent::rest_endpoint_callback( $request );
 	}
 
+	/**
+	 * Check if a given request has access to generate a title.
+	 *
+	 * TODO: If we want to keep our custom REST endpoint,
+	 * we can look to merge these permission callbacks together
+	 * to avoid duplicating code.
+	 *
+	 * @param array $input The input array.
+	 * @return bool|WP_Error
+	 */
+	public function abilities_api_permissions_check( array $input ) {
+		$post_id = $input['id'] ?? null;
+
+		// Ensure we have a logged in user that can edit the item.
+		if ( empty( $post_id ) || ! current_user_can( 'edit_post', $post_id ) ) {
+			return false;
+		}
+
+		$post_type     = get_post_type( $post_id );
+		$post_type_obj = get_post_type_object( $post_type );
+
+		// Ensure the post type is allowed in REST endpoints.
+		if ( ! $post_type || empty( $post_type_obj ) || empty( $post_type_obj->show_in_rest ) ) {
+			return false;
+		}
+
+		// Ensure the feature is enabled. Also runs a user check.
+		if ( ! $this->is_feature_enabled() ) {
+			return new WP_Error( 'not_enabled', esc_html__( 'Title generation not currently enabled.', 'classifai' ) );
+		}
+
+		return true;
+	}
+
+	/**
+	 * Request handler for the abilities API.
+	 *
+	 * @param array $input The input array.
+	 * @return \WP_REST_Response
+	 */
+	public function abilities_api_callback( array $input ) {
+		$args = wp_parse_args(
+			$input,
+			[
+				'content' => null,
+				'id'      => null,
+				'n'       => null,
+			]
+		);
+
+		return $this->run(
+			$args['id'],
+			'title',
+			[
+				'num'     => $args['n'],
+				'content' => $args['content'],
+			]
+		);
+	}
+
 	/**
 	 * Enqueue the editor scripts.
 	 */
@@ -299,7 +411,7 @@
 			'enabledFeatures' => [
 				0 => [
 					'feature'       => 'title',
-					'path'          => '/classifai/v1/generate-title/',
+					'path'          => '/wp/v2/abilities/classifai/generate-title/run/',
 					'buttonText'    => __( 'Generate titles', 'classifai' ),
 					'modalTitle'    => __( 'Select a title', 'classifai' ),
 					'selectBtnText' => __( 'Select', 'classifai' ),

src/js/features/title-generation/classic/index.js

@@ -100,10 +100,10 @@ const scriptData = classifaiChatGPTData.enabledFeatures.reduce(
 			spinnerEl.show();
 			isProcessing = true;
 
-			const path = scriptData.title?.path + postId;
-
 			apiFetch( {
-				path,
+				path: scriptData.title?.path,
+				method: 'POST',
+				data: { input: { id: postId } },
 			} )
 				.then( ( result ) => {
 					generateTextEl.css( 'opacity', '1' );

src/js/features/title-generation/index.js

@@ -66,7 +66,7 @@ const TitleGenerationPlugin = () => {
 		apiFetch( {
 			path,
 			method: 'POST',
-			data: { id: postId, content: postContent },
+			data: { input: { id: postId, content: postContent } },
 		} ).then(
 			async ( res ) => {
 				// Support calling a function from the response for browser AI.