The conditionals. */ public static function get_conditionals(): array { return [ AI_Conditional::class ]; } /** * AI_Bulk_Suggestions_Route constructor. * * @param Bulk_Suggestions_Provider $bulk_suggestions_provider The provider to handle the requests to the endpoint. */ public function __construct( Bulk_Suggestions_Provider $bulk_suggestions_provider ) { $this->bulk_suggestions_provider = $bulk_suggestions_provider; } /** * Registers routes with WordPress. * * @return void */ public function register_routes() { \register_rest_route( Main::API_V1_NAMESPACE, self::AI_BULK_SUGGESTIONS_ROUTE, [ 'methods' => 'POST', 'args' => [ 'subjects' => [ 'required' => true, 'type' => 'array', 'minItems' => 1, 'maxItems' => 20, 'description' => 'The subjects to fetch suggestions for.', 'items' => [ 'type' => 'object', 'required' => [ 'id', 'type', 'content' ], 'properties' => [ 'id' => [ 'type' => 'integer', 'minimum' => 1, 'description' => 'The post ID.', ], 'type' => [ 'type' => 'string', 'enum' => [ 'seo-title', 'meta-description', ], 'description' => 'The type of suggestion requested.', ], 'content' => [ 'type' => 'string', 'maxLength' => self::MAX_CONTENT_LENGTH, 'description' => 'The prompt content the suggestion should be based on, collected client-side by the analysis engine.', ], 'content_length' => [ 'type' => 'integer', 'minimum' => 0, 'description' => 'The visible-text length of the post, measured client-side. Omitted when it could not be measured, in which case the content length is not judged.', ], 'platform' => [ 'type' => 'string', 'enum' => [ 'Google', 'Facebook', 'Twitter', ], 'description' => 'The platform the suggestion is intended for.', ], ], ], ], ], 'callback' => [ $this, 'get_bulk_suggestions' ], 'permission_callback' => [ $this, 'check_permissions' ], ], ); } /** * Runs the callback to fetch bulk suggestions through AI. * * @param WP_REST_Request $request The request object. * * @return WP_REST_Response The response of the bulk suggestions action. */ public function get_bulk_suggestions( WP_REST_Request $request ): WP_REST_Response { try { $user = \wp_get_current_user(); $data = $this->bulk_suggestions_provider->get_bulk_suggestions( $user, $request->get_param( 'subjects' ) ); } catch ( Remote_Request_Exception $e ) { $message = [ 'message' => $e->getMessage(), 'errorIdentifier' => $e->get_error_identifier(), 'data' => [ 'status' => $e->getCode() ], ]; if ( $e instanceof Payment_Required_Exception ) { $message['missingLicenses'] = $e->get_missing_licenses(); } return new WP_REST_Response( $message, $e->getCode(), ); } catch ( RuntimeException $e ) { return new WP_REST_Response( 'Failed to retrieve AI bulk suggestions.', 500 ); } return new WP_REST_Response( $data ); } /** * Checks: * - if the user is logged in * - if the user can manage Yoast SEO options * * The per-post edit_post capability is enforced per subject when building the subjects. * * @return bool Whether the user is logged in and can manage Yoast SEO options. */ public function check_permissions(): bool { $user = \wp_get_current_user(); if ( $user === null || $user->ID < 1 ) { return false; } return \user_can( $user, 'wpseo_manage_options' ); } }