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_6_0/I4787_AddReviewSuggestionHelp.php

@@ -0,0 +1,23 @@
+<?php
+
+/**
+ * @file classes/migration/upgrade/v3_6_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_6_0;
+
+class I4787_AddReviewSuggestionHelp extends \PKP\migration\upgrade\v3_6_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,10 @@
 		<migration class="PKP\migration\upgrade\v3_5_0\I10759_AddReviewAssignmentSettings"/>
 		<migration class="PKP\migration\upgrade\v3_5_0\I10819_OrcidOauthScopeMail"/>
 		<note file="docs/release-notes/README-3.5.0" />
+
+		<!-- Need to be moved to new block once 3.5 branch created -->
+		<migration class="APP\migration\upgrade\v3_6_0\I4787_AddReviewSuggestionHelp"/>
+		<migration class="PKP\migration\upgrade\v3_6_0\I4787_InstallReviewerSuggestion"/>
 	</upgrade>
 
 	<!-- Update plugin configuration - should be done as the final upgrade task -->

locale/en/default.po

@@ -153,3 +153,12 @@ msgstr "External Reviewers"
 
 msgid "default.groups.abbrev.externalReviewer"
 msgstr "ER"
+
+msgid "default.submission.step.reviewerSuggestions"
+msgstr ""
+"<p>When submitting your article, you have the option to suggest 2/3 potential "
+"reviewers. This can help streamline the review process and provide valueable "
+"input for the editorial team. Please choose reviewers who are expert in your "
+"field and have no conflict of interest with your work. This feature aims to "
+"enhance the review process and and support a more efficient experience for both "
+"authors and presses.</p>"

locale/en/manager.po

@@ -769,6 +769,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 potential 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 reviewers at submission process"
+
 msgid "manager.setup.reviewPolicy"
 msgstr "Review Policy"
 

registry/uiLocaleKeysBackend.json

@@ -33,6 +33,7 @@
   "catalog.manage.isNotFeatured",
   "catalog.manage.isNotNewRelease",
   "catalog.manage.seriesFeatured",
+  "common.add",
   "common.addCCBCC",
   "common.assign",
   "common.attachFiles",
@@ -230,6 +231,7 @@
   "editor.submission.removeStageParticipant",
   "editor.submission.removeStageParticipant.description",
   "editor.submission.review.currentFiles",
+  "editor.submission.reviewerSuggestions",
   "editor.submission.revisions",
   "editor.submission.schedulePublication",
   "editor.submission.search",
@@ -244,6 +246,7 @@
   "email.bcc",
   "email.cc",
   "email.confirmSwitchLocale",
+  "email.email",
   "email.subject",
   "email.to",
   "fileManager.copyeditedFiles",
@@ -260,22 +263,29 @@
   "form.errorGoTo",
   "form.errorMany",
   "form.errorOne",
-  "form.errors",
-  "form.errorSummaryOne",
   "form.errorSummaryMany",
+  "form.errorSummaryOne",
+  "form.errors",
   "form.multilingualLabel",
   "form.multilingualProgress",
   "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.disable",
   "grid.action.edit",
   "grid.action.editFile",
+  "grid.action.enable",
   "grid.action.logInAs",
+  "grid.action.mergeUser",
   "grid.action.moreInformation",
   "grid.action.order",
+  "grid.action.remove",
   "grid.action.saveOrdering",
   "grid.action.sort",
   "grid.catalogEntry.publicationDates",
@@ -284,6 +294,9 @@
   "grid.libraryFiles.submission.title",
   "grid.noItems",
   "grid.user.confirmLogInAs",
+  "grid.user.currentUsers",
+  "grid.user.disable",
+  "grid.user.email",
   "help.help",
   "informationCenter.informationCenter",
   "invitation.cancelInvite.actionName",
@@ -370,6 +383,7 @@
   "manager.mailables.addTemplates",
   "manager.mailables.editTemplate",
   "manager.mailables.templates",
+  "manager.people.confirmRemove",
   "manager.publication.productionStage",
   "manager.publication.reviewStage",
   "manager.publication.submissionStage",
@@ -540,6 +554,20 @@
   "submissions.declined",
   "submissions.incomplete",
   "user.affiliation",
+  "user.affiliations",
+  "user.affiliations.deleteModal.message",
+  "user.affiliations.deleteModal.title",
+  "user.affiliations.description",
+  "user.affiliations.institution",
+  "user.affiliations.primaryLocaleRequired",
+  "user.affiliations.searchPhraseLabel",
+  "user.affiliations.translation",
+  "user.affiliations.translationActionsAriaLabel",
+  "user.affiliations.translationDeleteActionLabel",
+  "user.affiliations.translationEditActionLabel",
+  "user.affiliations.translationsAllAvailable",
+  "user.affiliations.translationsSomeAvailable",
+  "user.affiliations.typeTranslationNameInLanguageLabel",
   "user.authorization.accessibleWorkflowStage",
   "user.email",
   "user.familyName",
@@ -551,7 +579,12 @@
   "user.removeRole.message",
   "user.role.reviewer",
   "user.role.reviewers",
+  "user.roles",
   "user.username",
+  "userAccess.management.options",
+  "userAccess.search",
+  "userAccess.tableHeader.name",
+  "userAccess.tableHeader.startDate",
   "userInvitation.cancel.goBack",
   "userInvitation.cancel.message",
   "userInvitation.edit.message",

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"
+						]
+					}
+				}
+			}
 		}
 	}
 }