pkp/pkp-lib#4787 Reviewer suggestions

api/v1/submissions/index.php

@@ -16,12 +16,19 @@
  * @brief Handle requests for submission API functions.
  *
  */
+
 $urlParts = explode('/', trim($_SERVER['PATH_INFO'], '/'));
 
 if (count($urlParts) >= 6 && $urlParts[5] == 'files') {
     return new \PKP\handler\APIHandler(new \PKP\API\v1\submissions\PKPSubmissionFileController());
-} elseif (in_array('jats', $urlParts)) {
+}
+
+if (in_array('jats', $urlParts)) {
     return new \PKP\handler\APIHandler(new \PKP\API\v1\jats\PKPJatsController());
-} else {
-    return new \PKP\handler\APIHandler(new \APP\API\v1\submissions\SubmissionController());
 }
+
+if (in_array('suggestions', $urlParts)) {
+    return new \PKP\handler\APIHandler(new PKP\API\v1\reviewers\suggestions\ReviewerSuggestionController());
+}
+
+return new \PKP\handler\APIHandler(new \APP\API\v1\submissions\SubmissionController());

classes/migration/upgrade/v3_6_0/I4787_ReviewSuggestions.php

@@ -0,0 +1,23 @@
+<?php
+
+/**
+ * @file classes/migration/upgrade/v3_6_0/I4787_ReviewSuggestions.php
+ *
+ * Copyright (c) 2024 Simon Fraser University
+ * Copyright (c) 2024 John Willinsky
+ * Distributed under the GNU GPL v3. For full terms see the file docs/COPYING.
+ *
+ * @class I4787_ReviewSuggestions.php
+ *
+ * @brief Add reviewer suggestion related tables
+ *
+ */
+
+namespace APP\migration\upgrade\v3_6_0;
+
+class I4787_ReviewSuggestions extends \PKP\migration\upgrade\v3_6_0\I4787_ReviewSuggestions
+{
+    protected string $CONTEXT_TABLE = 'journals';
+    protected string $CONTEXT_SETTINGS_TABLE = 'journal_settings';
+    protected string $CONTEXT_COLUMN = 'journal_id';
+}

locale/en/manager.po

@@ -843,6 +843,15 @@ msgstr "Reviewer Ratings"
 msgid "manager.setup.reviewOptions.reviewerReminders"
 msgstr "Reviewer Reminders"
 
+msgid "manager.setup.reviewOptions.reviewerSuggestionEnabled"
+msgstr "Reviewer Suggestion at Submission"
+
+msgid "manager.setup.reviewOptions.reviewerSuggestionEnabled.description"
+msgstr "Author can suggest few potntial reviewers before completing the submission which can streamline the review process and provide valuable input for editorial team."
+
+msgid "manager.setup.reviewOptions.reviewerSuggestionEnabled.label"
+msgstr "Allow authors to suggest potential reviews at submission process"
+
 msgid "manager.setup.reviewPolicy"
 msgstr "Review Policy"
 

registry/uiLocaleKeysBackend.json

@@ -217,6 +217,7 @@
   "editor.submission.removeStageParticipant",
   "editor.submission.removeStageParticipant.description",
   "editor.submission.review.currentFiles",
+  "editor.submission.reviewerSuggestions",
   "editor.submission.revisions",
   "editor.submission.schedulePublication",
   "editor.submission.search",
@@ -253,9 +254,12 @@
   "form.saved",
   "grid.action.addContributor",
   "grid.action.addGalley",
+  "grid.action.addReviewerSuggestion",
   "grid.action.delete",
   "grid.action.deleteContributor",
   "grid.action.deleteContributor.confirmationMessage",
+  "grid.action.deleteReviewerSuggestion",
+  "grid.action.deleteReviewerSuggestion.confirmationMessage",
   "grid.action.edit",
   "grid.action.editFile",
   "grid.action.logInAs",

schemas/context.json

@@ -377,6 +377,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

@@ -18,6 +18,85 @@
 			"validation": [
 				"nullable"
 			]
+		},
+		"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"
+						]
+					}
+				}
+			}
 		}
 	}
 }