pkp/pkp-lib#4787 Reviewer suggestions

api/v1/submissions/index.php

@@ -23,6 +23,8 @@
 
 if (strpos($requestPath, '/files')) {
     return new \PKP\handler\APIHandler(new \PKP\API\v1\submissions\PKPSubmissionFileController());
+} elseif (strpos($requestPath, '/suggestions')) {
+    return new \PKP\handler\APIHandler(new PKP\API\v1\reviewers\suggestions\ReviewerSuggestionController());
 } else {
     return new \PKP\handler\APIHandler(new \APP\API\v1\submissions\SubmissionController());
 }

classes/migration/upgrade/v3_5_0/I4787_AddReviewSuggestionHelp.php

@@ -0,0 +1,23 @@
+<?php
+
+/**
+ * @file classes/migration/upgrade/v3_5_0/I4787_AddReviewSuggestionHelp.php
+ *
+ * Copyright (c) 2025 Simon Fraser University
+ * Copyright (c) 2025 John Willinsky
+ * Distributed under the GNU GPL v3. For full terms see the file docs/COPYING.
+ *
+ * @class I4787_AddReviewSuggestionHelp.php
+ *
+ * @brief Add reviewer suggestion related default help text
+ *
+ */
+
+namespace APP\migration\upgrade\v3_5_0;
+
+class I4787_AddReviewSuggestionHelp extends \PKP\migration\upgrade\v3_5_0\I4787_AddReviewSuggestionHelp
+{
+    protected string $CONTEXT_TABLE = 'presses';
+    protected string $CONTEXT_SETTINGS_TABLE = 'press_settings';
+    protected string $CONTEXT_COLUMN = 'press_id';
+}

dbscripts/xml/install.xml

@@ -35,6 +35,7 @@
 	<migration class="PKP\migration\install\ReviewFormsMigration" />
 	<migration class="PKP\migration\install\LibraryFilesMigration" />
 	<migration class="PKP\migration\install\ReviewsMigration" />
+	<migration class="PKP\migration\install\ReviewerSuggestionsMigration" />
 	<migration class="PKP\migration\install\TemporaryFilesMigration" />
 	<migration class="PKP\migration\install\TombstoneMigration" />
 	<migration class="PKP\migration\install\DoiMigration" />

dbscripts/xml/upgrade.xml

@@ -156,6 +156,8 @@
 		<migration class="PKP\migration\upgrade\v3_5_0\I10759_AddReviewAssignmentSettings"/>
 		<migration class="PKP\migration\upgrade\v3_5_0\I10819_OrcidOauthScopeMail"/>
 		<migration class="PKP\migration\upgrade\v3_5_0\I10359_DateConsideredToReviewAssignments"/>
+		<migration class="APP\migration\upgrade\v3_5_0\I4787_AddReviewSuggestionHelp"/>
+		<migration class="PKP\migration\upgrade\v3_5_0\I4787_InstallReviewerSuggestion"/>
 		<note file="docs/release-notes/README-3.5.0" />
 	</upgrade>
 

schemas/context.json

@@ -177,6 +177,20 @@
 			"type": "boolean",
 			"default": false,
 			"description": "Whether each publication version should receive a unique DOI"
+		},
+		"reviewerSuggestionEnabled": {
+			"type": "boolean",
+			"validation": [
+				"nullable"
+			]
+		},
+		"reviewerSuggestionsHelp": {
+			"type": "string",
+			"multilingual": true,
+			"validation": [
+				"nullable"
+			],
+			"defaultLocaleKey": "default.submission.step.reviewerSuggestions"
 		}
 	}
 }

schemas/submission.json

@@ -48,6 +48,85 @@
 			"validation": [
 				"in:1,2"
 			]
+		},
+		"reviewerSuggestions": {
+			"type": "array",
+			"description": "Information about suggested reviewers at the time of submission.",
+			"readOnly": true,
+			"items": {
+				"type": "object",
+				"properties": {
+					"id": {
+						"type": "integer"
+					},
+					"familyName" : {
+						"type": "string",
+						"multilingual": true,
+						"apiSummary": true
+					},
+					"givenName": {
+						"type": "string",
+						"multilingual": true,
+						"apiSummary": true
+					},
+					"fullName": {
+						"type": "string",
+						"multilingual": true,
+						"apiSummary": true
+					},
+					"email": {
+						"type": "string",
+						"apiSummary": true
+					},
+					"orcidId": {
+						"type": "string",
+						"apiSummary": true,
+						"validation": [
+							"nullable"
+						]
+					},
+					"suggestionReason": {
+						"type": "string",
+						"multilingual": true,
+						"apiSummary": true
+					},
+					"affiliation" : {
+						"type": "string",
+						"multilingual": true,
+						"apiSummary": true
+					},
+					"approvedAt": {
+						"type": "string",
+						"apiSummary": true,
+						"description": "The date suggestion was approved as reviewer.",
+						"validation": [
+							"nullable",
+							"date:Y-m-d H:i:s"
+						]
+					},
+					"existingUserId": {
+						"type": "integer",
+						"apiSummary": true,
+						"description": "The existing user id if already present as an user.",
+						"validation": [
+							"nullable"
+						]
+					},
+					"existingReviewerRole": {
+						"type": "boolean",
+						"apiSummary": true,
+						"description": "The existing user has reviewer role when already there is an existing user association."
+					},
+					"reviewerId": {
+						"type": "integer",
+						"apiSummary": true,
+						"description": "The existing user id with reviewer role who as been mapped to this suggestion after the suggestion has made",
+						"validation": [
+							"nullable"
+						]
+					}
+				}
+			}
 		}
 	}
 }