From 5b237adfb145dfa4ec0991bab83ddca01977d22e Mon Sep 17 00:00:00 2001
From: jyhein <124268211+jyhein@users.noreply.github.com>
Date: Mon, 7 Jul 2025 19:49:55 +0300
Subject: [PATCH] pkp/pkp-lib#857 Credit Roles

---
 src/components/Form/FormGroup.vue             |   2 +
 .../Form/fields/FieldCreditRoles.mdx          |  19 +++
 .../Form/fields/FieldCreditRoles.stories.js   |  29 ++++
 .../Form/fields/FieldCreditRoles.vue          | 139 ++++++++++++++++++
 .../Form/mocks/field-credit-roles.js          |  36 +++++
 5 files changed, 225 insertions(+)
 create mode 100644 src/components/Form/fields/FieldCreditRoles.mdx
 create mode 100644 src/components/Form/fields/FieldCreditRoles.stories.js
 create mode 100644 src/components/Form/fields/FieldCreditRoles.vue
 create mode 100644 src/components/Form/mocks/field-credit-roles.js

diff --git a/src/components/Form/FormGroup.vue b/src/components/Form/FormGroup.vue
index f142f4064..862eeae99 100644
--- a/src/components/Form/FormGroup.vue
+++ b/src/components/Form/FormGroup.vue
@@ -62,6 +62,7 @@ import FieldBaseAutosuggest from './fields/FieldBaseAutosuggest.vue';
 import FieldAuthors from './fields/FieldAuthors.vue';
 import FieldColor from './fields/FieldColor.vue';
 import FieldControlledVocab from './fields/FieldControlledVocab.vue';
+import FieldCreditRoles from './fields/FieldCreditRoles.vue';
 import FieldPubId from './fields/FieldPubId.vue';
 import FieldHtml from './fields/FieldHtml.vue';
 import FieldMetadataSetting from './fields/FieldMetadataSetting.vue';
@@ -95,6 +96,7 @@ export default {
 		FieldAuthors,
 		FieldColor,
 		FieldControlledVocab,
+		FieldCreditRoles,
 		FieldPubId,
 		FieldHtml,
 		FieldMetadataSetting,
diff --git a/src/components/Form/fields/FieldCreditRoles.mdx b/src/components/Form/fields/FieldCreditRoles.mdx
new file mode 100644
index 000000000..7f1fcfc85
--- /dev/null
+++ b/src/components/Form/fields/FieldCreditRoles.mdx
@@ -0,0 +1,19 @@
+import {Primary, Controls, Stories, Meta, ArgTypes} from '@storybook/blocks';
+
+import * as FieldCreditRolesStories from './FieldCreditRoles.stories.js';
+
+<Meta of={FieldCreditRolesStories} />
+
+# FieldCreditRole
+
+## Usage
+
+A special component to maintain Credit roles and degrees of authors (contributors).
+
+The CreditRoles currently saved are shown in a tabular way as roles and degrees.
+
+The `value` is an array of objects `{ role, degree }`.
+
+<Primary />
+<Controls />
+<Stories />
diff --git a/src/components/Form/fields/FieldCreditRoles.stories.js b/src/components/Form/fields/FieldCreditRoles.stories.js
new file mode 100644
index 000000000..dc618d99d
--- /dev/null
+++ b/src/components/Form/fields/FieldCreditRoles.stories.js
@@ -0,0 +1,29 @@
+import FieldCreditRoles from './FieldCreditRoles.vue';
+import FieldCreditRolesMock from '@/components/Form/mocks/field-credit-roles';
+
+export default {
+	title: 'Forms/FieldCreditRoles',
+	component: FieldCreditRoles,
+	render: (args) => ({
+		components: {FieldCreditRoles},
+		setup() {
+			function change(name, prop, newValue, localeKey) {
+				args[prop] = newValue;
+			}
+
+			return {args, change};
+		},
+		template: '<FieldCreditRoles v-bind="args" @change="change"/>',
+	}),
+	parameters: {
+		docs: {
+			story: {
+				height: '500px',
+			},
+		},
+	},
+};
+
+export const Base = {
+	args: {...FieldCreditRolesMock},
+};
diff --git a/src/components/Form/fields/FieldCreditRoles.vue b/src/components/Form/fields/FieldCreditRoles.vue
new file mode 100644
index 000000000..548060c1a
--- /dev/null
+++ b/src/components/Form/fields/FieldCreditRoles.vue
@@ -0,0 +1,139 @@
+<template>
+	<!-- To be able to scroll to this field on error-->
+	<div
+		:id="`${props.formId}-${props.name}`"
+		class="pkpFormField pkpFormField--creditRoles"
+	>
+		<div class="pkpFormField__heading">
+			<label :id="labelId" class="pkpFormFieldLabel">
+				{{ t('submission.submit.creditRoles.title', {}) }}
+			</label>
+		</div>
+		<div :id="descriptionId" class="pkpFormField__description">
+			{{ t('submission.submit.creditRoles.description', {}) }}
+		</div>
+		<div class="pkpFormField__control pkpFormField--creditRoles__control">
+			<PkpTable :labelled-by="labelId" :described-by="descriptionId">
+				<TableHeader>
+					<TableColumn id="" class="w-[45%]">
+						{{ t('submission.submit.creditRoles.role', {}) }}
+					</TableColumn>
+					<TableColumn id="">
+						{{ t('submission.submit.creditRoles.degree', {}) }}
+					</TableColumn>
+					<TableColumn id="" class="w-[100px]">&nbsp;</TableColumn>
+				</TableHeader>
+				<TableBody>
+					<TableRow
+						v-for="({role, degree}, creditRoleIndex) in currentValue"
+						:key="creditRoleIndex"
+					>
+						<TableCell>
+							<FieldSelect
+								name="role"
+								:label="t('submission.submit.creditRoles.selectRole')"
+								:is-required="true"
+								:value="role"
+								:options="props.options.roles"
+								class="creditRole__roleSelect"
+								@change="
+									(fieldName, propName, newValue, localeKey) =>
+										updateCreditRole(creditRoleIndex, fieldName, newValue)
+								"
+							/>
+						</TableCell>
+						<TableCell>
+							<FieldSelect
+								name="degree"
+								:label="t('submission.submit.creditRoles.selectDegree')"
+								:value="degree"
+								:options="props.options.degrees"
+								class="creditRole__roleSelect"
+								@change="
+									(fieldName, propName, newValue, localeKey) =>
+										updateCreditRole(creditRoleIndex, fieldName, newValue)
+								"
+							/>
+						</TableCell>
+						<TableCell>
+							<PkpButton
+								:is-warnable="true"
+								@click="removeCreditRole(creditRoleIndex)"
+							>
+								{{ t('submission.submit.creditRoles.button.remove') }}
+							</PkpButton>
+						</TableCell>
+					</TableRow>
+				</TableBody>
+				<template #bottom-controls>
+					<PkpButton @click="addCreditRole()">
+						{{ t('submission.submit.creditRoles.button.add') }}
+					</PkpButton>
+				</template>
+			</PkpTable>
+		</div>
+	</div>
+</template>
+
+<script setup>
+import {computed, useId} from 'vue';
+import {t} from '@/utils/i18n';
+import PkpButton from '@/components/Button/Button.vue';
+import PkpTable from '@/components/Table/Table.vue';
+import TableHeader from '@/components/Table/TableHeader.vue';
+import TableBody from '@/components/Table/TableBody.vue';
+import TableRow from '@/components/Table/TableRow.vue';
+import TableColumn from '@/components/Table/TableColumn.vue';
+import TableCell from '@/components/Table/TableCell.vue';
+import FieldSelect from './FieldSelect.vue';
+
+const props = defineProps({
+	/** Field key used for form submission */
+	name: {
+		type: String,
+		default: null,
+	},
+	/** The ID of the form this field should appear in. This is passed down from the `Form`.  */
+	formId: {
+		type: String,
+		default: null,
+	},
+	/** Current value of the field */
+	value: {
+		type: Array,
+		default: () => [],
+	},
+	options: {
+		type: Object,
+		required: true,
+	},
+});
+
+/**
+ * Accessibility
+ */
+const labelId = useId();
+const descriptionId = useId();
+
+const emit = defineEmits(['change']);
+
+const currentValue = computed({
+	get: () => props.value,
+	set: (newVal) => emit('change', props.name, 'value', newVal),
+});
+
+function addCreditRole() {
+	currentValue.value.push({
+		role: props.options.roles[0].value,
+		degree: props.options.degrees[0].value,
+	});
+}
+
+function removeCreditRole(index) {
+	currentValue.value.splice(index, 1);
+}
+
+function updateCreditRole(index, fieldName, newValue) {
+	currentValue.value[index][fieldName] = newValue;
+}
+</script>
diff --git a/src/components/Form/mocks/field-credit-roles.js b/src/components/Form/mocks/field-credit-roles.js
new file mode 100644
index 000000000..5ff1d18c9
--- /dev/null
+++ b/src/components/Form/mocks/field-credit-roles.js
@@ -0,0 +1,36 @@
+export default {
+	name: 'contributor-credit-roles',
+	component: 'contributor-credit-roles',
+	value: [
+		{
+			role: 'https://credit.niso.org/contributor-roles/data-curation/',
+			degree: null,
+		},
+	],
+	options: {
+		roles: [
+			{
+				label: 'Conceptualization',
+				value: 'https://credit.niso.org/contributor-roles/conceptualization/',
+			},
+			{
+				label: 'Data Curation',
+				value: 'https://credit.niso.org/contributor-roles/data-curation/',
+			},
+			{
+				label: 'Formal Analysis',
+				value: 'https://credit.niso.org/contributor-roles/formal-analysis/',
+			},
+		],
+		degrees: [
+			{
+				label: '',
+				value: null,
+			},
+			{
+				label: 'LEAD',
+				value: 'LEAD',
+			},
+		],
+	},
+};