pkp/pkp-lib#4787 Reviewer suggestions

src/components/Container/SubmissionWizardPage.vue

@@ -2,6 +2,7 @@
 import Page from '@/components/Container/Page.vue';
 import ButtonRow from '../ButtonRow/ButtonRow.vue';
 import ContributorsListPanel from '../ListPanel/contributors/ContributorsListPanel.vue';
+import ReviewerSuggestionsListPanel from '../ListPanel/reviewerSuggestions/ReviewerSuggestionsListPanel.vue';
 import File from '../File/File.vue';
 import Modal from '../Modal/Modal.vue';
 import ReconfigureSubmissionModal from '@/pages/submissionWizard/ReconfigureSubmissionModal.vue';
@@ -19,6 +20,7 @@ export default {
 	components: {
 		ButtonRow,
 		ContributorsListPanel,
+		ReviewerSuggestionsListPanel,
 		File,
 		Modal,
 		SubmissionFilesListPanel,
@@ -601,6 +603,13 @@ export default {
 			this.publication.authors = newContributors;
 		},
 
+		/**
+		 * Update the reviewer suggestions in the submission
+		 */
+		setReviewerSuggestion(newReviewerSuggestions) {
+			this.submission.reviewerSuggestions = newReviewerSuggestions;
+		},
+
 		/**
 		 * Update the publication in the submission
 		 */

src/components/ListPanel/reviewerSuggestions/ReviewerSuggestionsEditModal.vue

@@ -0,0 +1,26 @@
+<template>
+	<SideModalBody>
+		<template #title>
+			{{ title }}
+		</template>
+		<SideModalLayoutBasic>
+			<PkpForm
+				v-bind="activeForm"
+				@set="(...args) => emit('updateForm', ...args)"
+				@success="(...args) => emit('formSuccess', ...args)"
+			/>
+		</SideModalLayoutBasic>
+	</SideModalBody>
+</template>
+
+<script setup>
+import SideModalBody from '@/components/Modal/SideModalBody.vue';
+import SideModalLayoutBasic from '@/components/Modal/SideModalLayoutBasic.vue';
+import PkpForm from '@/components/Form/Form.vue';
+
+defineProps({
+	title: {type: String, required: true},
+	activeForm: {type: Object, required: true},
+});
+const emit = defineEmits(['updateForm', 'formSuccess']);
+</script>

src/components/ListPanel/reviewerSuggestions/ReviewerSuggestionsListPanel.vue

@@ -0,0 +1,325 @@
+<template>
+	<div class="reviewerSuggestionsListPanel">
+		<slot>
+			<ListPanel :items="items" class="listPanel--reviewerSuggestions">
+				<template #header>
+					<PkpHeader>
+						<h2>{{ title }}</h2>
+						<Spinner v-if="isLoading" />
+						<template #actions>
+							<PkpButton
+								v-if="
+									publication.status !== getConstant('STATUS_PUBLISHED') &&
+									canEditPublication
+								"
+								:disabled="isLoading"
+								@click="openAddModal"
+							>
+								{{ t('grid.action.addReviewerSuggestion') }}
+							</PkpButton>
+						</template>
+					</PkpHeader>
+				</template>
+
+				<template #item-title="{item}">
+					{{ localize(item.fullName) }}
+					<Badge>
+						{{ localize(item.affiliation) }}
+					</Badge>
+				</template>
+
+				<template #item-subtitle="{item}">
+					{{ item.email }}
+				</template>
+
+				<template
+					v-if="
+						publication.status !== getConstant('STATUS_PUBLISHED') &&
+						canEditPublication
+					"
+					#item-actions="{item}"
+				>
+					<PkpButton :disabled="isLoading" @click="openEditModal(item.id)">
+						{{ t('common.edit') }}
+					</PkpButton>
+					<PkpButton
+						:disabled="isLoading"
+						:is-warnable="true"
+						@click="openDeleteModal(item.id)"
+					>
+						{{ t('common.delete') }}
+					</PkpButton>
+				</template>
+			</ListPanel>
+		</slot>
+	</div>
+</template>
+
+<script>
+import Spinner from '@/components/Spinner/Spinner.vue';
+import PkpButton from '@/components/Button/Button.vue';
+import Badge from '@/components/Badge/Badge.vue';
+import ListPanel from '@/components/ListPanel/ListPanel.vue';
+import PkpHeader from '@/components/Header/Header.vue';
+import ReviewerSuggestionsEditModal from './ReviewerSuggestionsEditModal.vue';
+
+import ajaxError from '@/mixins/ajaxError';
+import dialog from '@/mixins/dialog.js';
+import cloneDeep from 'clone-deep';
+import {useModal} from '@/composables/useModal';
+
+export default {
+	components: {
+		Spinner,
+		PkpButton,
+		Badge,
+		ListPanel,
+		PkpHeader,
+	},
+	mixins: [ajaxError, dialog],
+	props: {
+		canEditPublication: {
+			type: Boolean,
+			required: true,
+		},
+		form: {
+			type: Object,
+			required: true,
+		},
+		id: {
+			type: String,
+			required: true,
+		},
+		items: {
+			type: Array,
+			default() {
+				return [];
+			},
+		},
+		title: {
+			type: String,
+			required: true,
+		},
+		reviewerSuggestionsApiUrl: {
+			type: String,
+			required: true,
+		},
+		submission: {
+			type: Object,
+			required: true,
+		},
+		publication: {
+			type: Object,
+			required: true,
+		},
+	},
+	emits: [
+		'updated:reviewerSuggestions'
+	],
+	data() {
+		return {
+			activeForm: null,
+			activeFormTitle: '',
+			isLoading: false,
+		};
+	},
+	computed: {
+		/**
+		 * Unique ID for the form modal
+		 */
+		formModal() {
+			return this.id + 'form';
+		},
+	},
+	methods: {
+		/**
+		 * Helper method to access a global constant in the template
+		 *
+		 * @return {Object}
+		 */
+		getConstant(constant) {
+			return pkp.const[constant];
+		},
+
+		/**
+		 * Clear the active form when the modal is closed
+		 *
+		 * @param {Object} event
+		 */
+		closeFormModal(event) {
+			const {closeSideModal} = useModal();
+			closeSideModal(ReviewerSuggestionsEditModal);
+			this.activeForm = null;
+			this.activeFormTitle = '';
+		},
+
+		/**
+		 * The add/edit form has been successfully
+		 * submitted.
+		 *
+		 * @param {Object} item
+		 */
+		formSuccess(reviewerSuggestion) {
+			if (this.activeForm.method === 'POST') {
+				this.offset = 0;
+
+				const newReviewerSuggestions = [...this.submission.reviewerSuggestions];
+				newReviewerSuggestions.push(reviewerSuggestion);
+
+				this.$emit('updated:reviewerSuggestions', newReviewerSuggestions);
+			} else {
+				const newReviewerSuggestions = this.submission.reviewerSuggestions.map(
+					(suggestion) => {
+						if (suggestion.id === reviewerSuggestion.id) {
+							return reviewerSuggestion;
+						}
+						return suggestion;
+					},
+				);
+				this.$emit('updated:reviewerSuggestions', newReviewerSuggestions);
+			}
+
+			this.closeFormModal();
+		},
+
+		/**
+		 * Open the modal to add an item
+		 */
+		openAddModal() {
+			let activeForm = cloneDeep(this.form);
+			activeForm.action = this.reviewerSuggestionsApiUrl;
+			activeForm.method = 'POST';
+			this.activeForm = activeForm;
+			this.activeFormTitle = this.t('grid.action.addReviewerSuggestion');
+			const {openSideModal} = useModal();
+
+			openSideModal(ReviewerSuggestionsEditModal, {
+				title: this.activeFormTitle,
+				activeForm: this.activeForm,
+				onUpdateForm: this.updateForm,
+				onFormSuccess: this.formSuccess,
+			});
+		},
+
+		/**
+		 * Open delete modal
+		 *
+		 * @param {Number} id
+		 */
+		openDeleteModal(id) {
+			const reviewerSuggestion = this.items.find((a) => a.id === id);
+
+			this.openDialog({
+				name: 'delete',
+				title: this.t('grid.action.deleteReviewerSuggestion'),
+				message: this.t(
+					'grid.action.deleteReviewerSuggestion.confirmationMessage',
+					{
+						name: reviewerSuggestion.familyName,
+					},
+				),
+				actions: [
+					{
+						label: this.t('grid.action.deleteReviewerSuggestion'),
+						isWarnable: true,
+						callback: (close) => {
+							this.isLoading = true;
+
+							$.ajax({
+								url: this.reviewerSuggestionsApiUrl + '/' + id,
+								type: 'POST',
+								context: this,
+								headers: {
+									'X-Csrf-Token': pkp.currentUser.csrfToken,
+									'X-Http-Method-Override': 'DELETE',
+								},
+								error: this.ajaxErrorCallback,
+								success(r) {
+									close();
+									this.setFocusIn(this.$el);
+
+									const newReviewerSuggestions =
+										this.submission.reviewerSuggestions.filter(
+											(reviewerSuggestion) => {
+												return reviewerSuggestion.id !== id;
+											},
+										);
+									this.$emit(
+										'updated:reviewerSuggestions',
+										newReviewerSuggestions,
+									);
+								},
+								complete(r) {
+									this.isLoading = false;
+								},
+							});
+						},
+					},
+					{
+						label: this.t('common.cancel'),
+						callback: (close) => close(),
+					},
+				],
+			});
+		},
+
+		/**
+		 * Open the modal to edit an item
+		 *
+		 * @param {Number} id
+		 */
+		openEditModal(id) {
+			this.isLoading = true;
+			const apiUrl = this.reviewerSuggestionsApiUrl + '/' + id;
+
+			$.ajax({
+				url: apiUrl,
+				type: 'GET',
+				error: this.ajaxErrorCallback,
+				context: this,
+				success(reviewerSuggestion) {
+					let activeForm = cloneDeep(this.form);
+					activeForm.action = apiUrl;
+					activeForm.method = 'PUT';
+					activeForm.fields = activeForm.fields.map((field) => {
+						if (Object.keys(reviewerSuggestion).includes(field.name)) {
+							field.value = reviewerSuggestion[field.name];
+						}
+						return field;
+					});
+					this.activeForm = activeForm;
+					this.activeFormTitle = this.t('grid.action.edit');
+					const {openSideModal} = useModal();
+					openSideModal(ReviewerSuggestionsEditModal, {
+						title: this.activeFormTitle,
+						activeForm: this.activeForm,
+						onUpdateForm: this.updateForm,
+						onFormSuccess: this.formSuccess,
+					});
+				},
+				complete(r) {
+					this.isLoading = false;
+				},
+			});
+		},
+
+		/**
+		 * Update form values when they change
+		 *
+		 * @param {String} formId
+		 * @param {Object} data
+		 */
+		updateForm(formId, data) {
+			if (!this.activeForm) {
+				return;
+			}
+
+			let activeForm = this.activeForm;
+			Object.keys(data).forEach(function (key) {
+				activeForm[key] = data[key];
+			});
+			this.activeForm = activeForm;
+		},
+	},
+};
+</script>