pkp/pkp-lib#9661 Allow Journal Managers to invite users to adopt a role - ORCiD

src/managers/UserInvitationManager/UserInvitationManager.vue

@@ -139,6 +139,6 @@ import {useDate} from '@/composables/useDate';
 import DropdownActions from '@/components/DropdownActions/DropdownActions.vue';
 
 const store = useUserInvitationManagerStore();
-const {t} = useLocalize();
+const {t, localize} = useLocalize();
 const {formatShortDate} = useDate();
 </script>

src/managers/UserInvitationManager/UserInvitationManagerCancelInvitationDialogBody.vue

@@ -2,10 +2,10 @@
 	<p>{{ message }}</p>
 	<div>
 		<ul role="list">
-			<li>{{ t('user.email') }}:{{ email }}</li>
-			<li>{{ t('userInvitation.roleTable.role') }}:{{ roles }}</li>
-			<li>{{ t('common.status') }}:{{ status }}</li>
-			<li>{{ t('user.affiliation') }}:{{ affiliation }}</li>
+			<li>{{ t('user.email') }}: {{ email }}</li>
+			<li>{{ t('userInvitation.roleTable.role') }}: {{ roles }}</li>
+			<li>{{ t('common.status') }}: {{ status }}</li>
+			<li>{{ t('user.affiliation') }}: {{ affiliation }}</li>
 		</ul>
 	</div>
 </template>

src/managers/UserInvitationManager/UserInvitationManagerStore.js

@@ -131,7 +131,7 @@ export const useUserInvitationManagerStore = defineComponentStore(
 					}),
 					affiliation: invitationObj.existingUser
 						? localize(invitationObj.existingUser.affiliation)
-						: invitationObj.affiliation,
+						: localize(invitationObj.affiliation),
 				},
 				actions: [
 					{

src/pages/acceptInvitation/AcceptInvitationPage.vue

@@ -57,7 +57,7 @@
 					{{ t('common.back') }}
 				</PkpButton>
 				<PkpButton
-					v-if="!store.isOnFirstStep"
+					v-if="store.currentStep.id !== 'verifyOrcid'"
 					:is-primary="true"
 					@click="store.nextStep"
 				>

src/pages/acceptInvitation/AcceptInvitationPageStore.js

@@ -21,6 +21,7 @@ export const useAcceptInvitationPageStore = defineComponentStore(
 
 		const email = ref(null);
 		const userId = ref(null);
+		const existingUser = ref(null);
 
 		/** All Errors */
 		const errors = ref({});
@@ -82,8 +83,37 @@ export const useAcceptInvitationPageStore = defineComponentStore(
 				if (data.value.givenName) {
 					updateAcceptInvitationPayload('givenName', data.value.givenName); //if not check this override the multilingual structure
 				}
+				if (data.value.affiliation) {
+					updateAcceptInvitationPayload('affiliation', data.value.affiliation);
+				}
 				updateAcceptInvitationPayload('userCountry', data.value.country);
-				updateAcceptInvitationPayload('userOrcid', data.value.orcid);
+
+				updateAcceptInvitationPayload('orcid', data.value.orcid);
+				updateAcceptInvitationPayload(
+					'orcidIsVerified',
+					data.value.orcidIsVerified,
+				);
+				updateAcceptInvitationPayload(
+					'orcidAccessDenied',
+					data.value.orcidAccessDenied,
+				);
+				updateAcceptInvitationPayload(
+					'orcidAccessToken',
+					data.value.orcidAccessToken,
+				);
+				updateAcceptInvitationPayload(
+					'orcidAccessScope',
+					data.value.orcidAccessScope,
+				);
+				updateAcceptInvitationPayload(
+					'orcidRefreshToken',
+					data.value.orcidRefreshToken,
+				);
+				updateAcceptInvitationPayload(
+					'orcidAccessExpiresOn',
+					data.value.orcidAccessExpiresOn,
+				);
+
 				updateAcceptInvitationPayload(
 					'userGroupsToAdd',
 					data.value.userGroupsToAdd,
@@ -93,9 +123,11 @@ export const useAcceptInvitationPageStore = defineComponentStore(
 					userId.value ? true : false,
 				);
 				// add username to invitation payload for validations
-				updateAcceptInvitationPayload('username', null);
+				updateAcceptInvitationPayload('username', data.value.username);
 				// add password to invitation payload for validations
 				updateAcceptInvitationPayload('password', null);
+
+				existingUser.value = data.existingUser;
 				errors.value = [];
 				if (steps.value.length === 0) {
 					await submit();
@@ -107,6 +139,61 @@ export const useAcceptInvitationPageStore = defineComponentStore(
 			acceptInvitationPayload.value[fieldName] = value;
 		}
 
+		/**
+		 * Sets ORCID data in invitation payload. If data is null, all ORCID related fields will be set to null/zero value.
+		 *
+		 * @param {Object|null} data - The ORCID OAuth data object.
+		 * @param {string} data.orcid - The ORCID URL of the user.
+		 * @param {boolean} data.orcidIsVerified - Indicates if the user's ORCID is verified.
+		 * @param {null|string} data.orcidAccessDenied - Indicates if access to ORCID is denied (null if not denied).
+		 * @param {string} data.orcidAccessToken - The access token for ORCID API.
+		 * @param {string} data.orcidAccessScope - The scope of access for the ORCID API.
+		 * @param {string} data.orcidRefreshToken - The refresh token for obtaining new access tokens.
+		 * @param {string} data.orcidAccessExpiresOn - The expiration date and time of the access token in ISO format.
+		 * @param data
+		 */
+		function setOrcidData(data) {
+			const fields = [
+				'orcid',
+				'orcidIsVerified',
+				'orcidAccessDenied',
+				'orcidAccessToken',
+				'orcidAccessScope',
+				'orcidRefreshToken',
+				'orcidAccessExpiresOn',
+			];
+			const isDataNull = data === null;
+			fields.forEach((fieldName) => {
+				acceptInvitationPayload.value[fieldName] = isDataNull
+					? null
+					: data[fieldName];
+			});
+		}
+
+		const hasValidOrcid = computed(() => {
+			if (acceptInvitationPayload.value['orcidIsVerified']) {
+				return true;
+			} else if (existingUser.value.orcidIsVerified) {
+				return true;
+			}
+
+			return false;
+		});
+
+		const orcidUri = computed(() => {
+			const invitationOrcid = acceptInvitationPayload.value['orcid'];
+			if (invitationOrcid) {
+				return invitationOrcid;
+			}
+
+			const userOrcid = existingUser.value['orcid'];
+			if (userOrcid) {
+				return userOrcid;
+			}
+
+			return null;
+		});
+
 		/** Steps */
 		const currentStepId = ref(
 			pageInitConfig.steps[0] ? pageInitConfig.steps[0].id : '',
@@ -311,7 +398,12 @@ export const useAcceptInvitationPageStore = defineComponentStore(
 				method: 'PUT',
 				body: {invitationData: invitationRequestPayload.value},
 			});
-			if (!acceptInvitationPayload.value.privacyStatement) {
+			// FIXME: Privacy statement check blocks ORCID from saving before hand.
+			//  		  Can this check be moved outside of update payload check?
+			if (
+				!acceptInvitationPayload.value.privacyStatement &&
+				currentStep.value.id !== 'verifyOrcid'
+			) {
 				errors.value = {
 					privacyStatement: [t('acceptInvitation.privacyStatement.validation')],
 				};
@@ -412,13 +504,15 @@ export const useAcceptInvitationPageStore = defineComponentStore(
 			//computed
 			currentStep,
 			currentStepIndex,
+			hasValidOrcid,
 			isOnFirstStep,
 			isOnLastStep,
 			isValid,
 			pageTitle,
 			startedSteps,
 			stepTitle,
 			openStep,
+			orcidUri,
 			steps,
 			pageTitleDescription,
 			errors,
@@ -428,6 +522,7 @@ export const useAcceptInvitationPageStore = defineComponentStore(
 			//methods
 			nextStep,
 			previousStep,
+			setOrcidData,
 			updateAcceptInvitationPayload,
 			cancel,
 

src/pages/acceptInvitation/AcceptInvitationUserAccountDetails.vue

@@ -10,7 +10,7 @@
 		<div class="my-4">
 			<FieldText
 				:label="t('user.username')"
-				:value="fields.username"
+				:value="store.acceptInvitationPayload.username"
 				:description="t('acceptInvitation.usernameField.description')"
 				:is-required="true"
 				name="username"
@@ -61,7 +61,7 @@ const props = defineProps({
 	validateFields: {type: Array, required: true},
 });
 const {t} = useLocalize();
-const fields = ref({username: '', password: '', privacyStatement: false});
+const fields = ref({password: '', privacyStatement: false});
 const {pageUrl} = useUrl('about/privacy');
 const options = [
 	{

src/pages/acceptInvitation/AcceptInvitationUserRoles.vue

@@ -12,7 +12,7 @@
 		<TableBody>
 			<TableRow v-for="(row, index) in userGroupsToAdd" :key="index">
 				<TableCell :is-row-header="true">
-					{{ row.userGroupName }}
+					{{ localize(row.userGroupName) }}
 				</TableCell>
 				<TableCell>{{ formatShortDate(row.dateStart) }}</TableCell>
 				<TableCell>
@@ -45,6 +45,6 @@ import {useDate} from '@/composables/useDate';
 defineProps({
 	userGroupsToAdd: {type: Array, required: true},
 });
-const {t} = useLocalize();
+const {t, localize} = useLocalize();
 const {formatShortDate} = useDate();
 </script>

src/pages/acceptInvitation/AcceptInvitationVerifyOrcid.vue

@@ -15,23 +15,57 @@
 
 <script setup>
 import PkpButton from '@/components/Button/Button.vue';
-import {defineProps} from 'vue';
+import {defineProps, onMounted} from 'vue';
 import {useLocalize} from '@/composables/useLocalize';
 import {useAcceptInvitationPageStore} from './AcceptInvitationPageStore';
 
-defineProps({});
+const props = defineProps({
+	orcidUrl: {type: String, required: true},
+	orcidOAuthUrl: {type: String, required: true},
+});
+
 const store = useAcceptInvitationPageStore();
 const {t} = useLocalize();
 
+onMounted(() => {
+	pkp.eventBus.$on('addOrcidInvitationData', (data) => setOrcidData(data));
+});
+
+/**
+ * Processes ORCID data for an invitation.
+ *
+ * @param {Object|null} data - The ORCID OAuth data object.
+ * @param {string} data.orcid - The ORCID URL of the user.
+ * @param {boolean} data.orcidIsVerified - Indicates if the user's ORCID is verified.
+ * @param {null|string} data.orcidAccessDenied - Indicates if access to ORCID is denied (null if not denied).
+ * @param {string} data.orcidAccessToken - The access token for ORCID API.
+ * @param {string} data.orcidAccessScope - The scope of access for the ORCID API.
+ * @param {string} data.orcidRefreshToken - The refresh token for obtaining new access tokens.
+ * @param {string} data.orcidAccessExpiresOn - The expiration date and time of the access token in ISO format.
+ *
+ * @returns {void}
+ */
+async function setOrcidData(data) {
+	store.setOrcidData(data);
+	await store.nextStep();
+}
+
 /**
  * Go to the next step
  */
 function skipOrcid() {
-	delete store.acceptInvitationPayload.userOrcid;
 	store.openStep(store.steps[1 + store.currentStepIndex].id);
 }
 
+/**
+ * Initiates ORCID OAuth granting flow
+ */
 function verifyOrcid() {
-	store.openStep(store.steps[1 + store.currentStepIndex].id);
+	const oauthWindow = window.open(
+		props.orcidOAuthUrl,
+		'_blank',
+		'toolbar=no, scrollbars=yes, width=540, height=700, top=500, left=500',
+	);
+	oauthWindow.opener = self;
 }
 </script>