Updates for Research Output Table question type in Plan Creator #1078

jupiter007 · 2026-01-02T16:59:47Z

Description

Made lots of changes to support the Research Outputs from Plan Creator View. I'm sure some areas could still use refinement, but this PR was getting really big, and I thought it best to get these changes through and create follow up tickets.

Added new ResearchOutputAnswerComponent, SingleResearchOutputComponent, RepoSelectorForAnswer and MetaDataStandardForAnswer components for the rendering of researchOutputTable question type answer form
Added utils/researchOutputTransformations.ts to group utilities for researchOutputTable
Updated QuestionAdd and associated unit tests to include tests for new researchOutputTable question type
Update PlanOverviewQuestionPage component and related unit test in template builder flow to add researchOutputTable question type support
Updated QuestionEdit page and related unit test to improve the researchOutputTable question type application by moving hydration out to hook
Update hooks/useResearchOutputTable to memoize some functions and moved some code out to new researchOutputTransformations util
Moved ResearchOutputQuestionComponent and ResearchOutputAnswerComponent under components/Form
Updated shared ErrorMessages to pass in ref so we can control which field error to scroll to
Updated hooks/useRenderQuestionField hook to include rendering of researchOutputTable answer form
Updated utils/questionTypeHandlers with use of Default types from @dmptool/types

Fixes # (787)

Type of change

New feature (non-breaking change which adds functionality)

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Include any relevant details for your test configuration.

Checklist:

My code follows the style guidelines of this project
I have performed a self-review of my own code
I have commented my code, particularly in hard-to-understand areas
I updated the CHANGELOG.md and added documentation if necessary
I have added tests that prove my fix is effective or that my feature works
I have completed manual or automated accessibility testing for my changes
New and existing unit tests pass locally with my changes
[NA] Any dependent changes have been merged and published in downstream modules

Important Note:

Please make sure to do a careful merge of development branch into yours, to make sure you aren't reverting or effecting any previous commits to the development branch.

Testing

Use development branch of backend app to test this.
Create a template with a Research Output question type
Then a project off of that and select that template for the plan
When you go in to answer the question, you should see the Research Output form, instead of the List view
Once you have at least one answer, you would see the list view, and only see the form when you edit an answer or select + Output button.

Screen recording

Adding answers to a Research Output question

Screen.Recording.2026-01-02.at.8.55.13.AM.mov

…mptools-version

… in modal

…its more complex

…textArea question

…show form if there is only one. Also added a new SingleSearchOutputComponent to display just the one form

…iptions in metadata standards list in modal and fixed Delete button

…re are no answers. Added use of default licenses and output types when the question didn't save any custom ones.Fixed issue with both data flags showing all the time.Added Loading spinner.Added form field validation.Updated styles for RO list so that they are consistent with sitewide styles.Added scroll after updating or adding form

…ion to build out RO form state

…n compoents. Moved shared actions to the common app/actions location for addRepositoryAction and addMetaDataStandardAction

…oent to not show empty selections for repositories when it is enabled with no selections, and also updated to not show the Data Flags label when it is enabled but no chcekboxes have been checked. Made sure that help text appears for repositories and metadatastandards

… button only appears at the bottom of the SingleReseearchOutputComponent form

…fixed the getRowTitle which would be empty and fall back to default when first adding

…. Updated some broken unit tests

… increase coverage

…nswer and fixed some lintnig issues

…d not recognize that it needed to call update instead of add for answer. made improvements to ResearchOutputAnswerComponent and SingleResearchOutputComponent

jupiter007 · 2026-01-02T17:00:40Z

app/[locale]/projects/[projectId]/dmp/[dmpid]/members/page.tsx

                          onChange={(selected) =>
                            dispatch({ type: 'SET_SELECTED_PLAN_MEMBER', payload: selected as string })
-                          } selectedKey={selectedPlanMember}
+                          } selectedKey={selectedPlanMember ?? undefined}


Fixed type error

jupiter007 · 2026-01-02T17:02:55Z

app/[locale]/projects/[projectId]/dmp/[dmpid]/s/[sid]/q/[qid]/__tests__/page.spec.tsx

 import mockQuestionDataForTypeAheadSearch from '@/__mocks__/common/mockPublishedQuestionDataForAffiliationSearch.json';
 import mockQuestionDataForURL from '@/__mocks__/common/mockPublishedQuestionDataForURL.json';
 import mockOtherQuestion from '../__mocks__/mockOtherQuestionData.json';
+import mockQuestionDataForResearchOutput from '../__mocks__/mockROPublishedQuestion.json';


Updated to include the new code to support researchOutputTable question in PlanOverviewQuestionPage

jupiter007 · 2026-01-02T17:03:54Z

app/[locale]/projects/[projectId]/dmp/[dmpid]/s/[sid]/q/[qid]/page.tsx

 import React, { useEffect, useRef, useState } from 'react';
 import { useParams, useRouter } from 'next/navigation';
 import Image from 'next/image';
+import { useTranslations } from "next-intl";


Updated this component to support researchOutputTable question type

jupiter007 · 2026-01-02T17:04:20Z

app/[locale]/projects/[projectId]/dmp/[dmpid]/s/[sid]/q/[qid]/page.tsx

  const prefillAnswer = (answer: any, type: string) => {
    switch (type) {
-      case 'text':
+      case TYPEAHEAD_QUESTION_TYPE:


Updated prefillAnswer to use constants

jupiter007 · 2026-01-02T17:06:06Z

app/[locale]/template/[templateId]/q/[q_slug]/__tests__/page.spec.tsx

@@ -1,12 +1,17 @@
 import React from "react";
-import { act, fireEvent, render, screen, waitFor } from '@/utils/test-utils';
+import { act, fireEvent, render, screen, waitFor, within } from '@/utils/test-utils';


Updated with unit tests for researchOutputTable question type

jupiter007 · 2026-01-02T17:07:39Z

app/[locale]/template/[templateId]/q/[q_slug]/actions/removeQuestionAction.ts

@@ -0,0 +1,20 @@
+"use server";
+


Updated an existing graphql mutation call to use server actions instead

jupiter007 · 2026-01-02T17:07:53Z

app/[locale]/template/[templateId]/q/[q_slug]/actions/updateQuestionAction.ts

@@ -0,0 +1,46 @@
+"use server";
+
+import { executeGraphQLMutation } from "@/utils/server/graphqlServerActionHandler";


Updated an existing graphql mutation call to use server actions instead

jupiter007 · 2026-01-02T17:10:17Z

app/[locale]/template/[templateId]/q/new/page.tsx

                              handleSelect={handleSelect}
                            />
                          ))}
-                          {/** This is temporary, until we add research output question type to questionTypes */}


Replaced this with the actual researchOutputTable question type code.

jupiter007 · 2026-01-02T17:12:44Z

app/[locale]/template/[templateId]/q/standardFields.ts

-  OutputTypeInterface,
-  StandardField,
-  RepositoryInterface,
-  MetaDataStandardInterface,


Moved this to shared useResearchOutTable hook

jupiter007 · 2026-01-02T17:13:22Z

app/hooks/useResearchOutputTable.ts

 'use client'

-import { useState } from 'react';
+import { useState, useCallback, useMemo } from 'react';


Moved location of this file and made some updates to memoize functions, and also move out utilities to a separate utils/researchOutputTransformations.ts file

jupiter007 · 2026-01-02T17:14:53Z

components/ErrorMessages/index.tsx


 type ErrorMessagesProps = {
  errors: string[] | Record<string, string | null | undefined>;
+  noScroll?: boolean;


Updated to allow passing of ref so that users can be scrolled to first invalid field

jupiter007 · 2026-01-02T17:15:50Z

components/Form/QuestionComponents/BooleanQuestionComponent/__tests__/index.spec.tsx

    attributes: {
-      checked: true,
-      labelTranslationKey: "questions.use_existing_data"
+      label: "Use existing data",


I know that we will not be displaying the Boolean question type soon, but I fixed a bug with it, because I'm thinking of hanging on to the component, just in case.

jupiter007 · 2026-01-02T17:18:05Z

components/Form/ResearchOutputAnswerComponent/SingleResearchOutputComponent/index.tsx

@@ -0,0 +1,830 @@
+'use client'
+


The new Question answer page in the Plan builder flow for researchOutputTable questions, uses a parent ResearchOutputAnswerComponent that either shows a list of all answers under the question, or displays just the form. This SingleResearchOutputComponent is used to display just the form by default when the user hasn't answer the question yet, or when users are editing their answers.

jupiter007 · 2026-01-02T17:24:28Z

components/QuestionAdd/MetaDataStandards.tsx

 import {
  addMetaDataStandardsAction
-} from "./actions";
+} from "@/app/actions";


L26: This is because I moved some shared actions under @/app/actions

jupiter007 · 2026-01-02T17:25:34Z

components/QuestionView/__tests__/index.spec.tsx

      type: "boolean",
      attributes: {
-        checked: false
+        label: "Boolean Question",


Fixed a bug in Preview mode for Boolean questions

jupiter007 · 2026-01-02T17:26:19Z

components/RepoSelectorForAnswer/index.tsx

+} from '@/app/types';
+import styles from './repoSelectorForAnswer.module.scss';
+
+// TODO: There is some overlap with components/QuestionAdd/RepoSelector.tsx - consider refactoring shared logic


This is the new RepoSelector selection code for the Answer page. It has lots of overlap with the RepoSelector.tsx component, but there were enough differences that, for now, I created this separate component. At some point, I will separate out common code into a shared location.

jupiter007 · 2026-01-02T17:27:25Z

utils/questionTypeHandlers.ts

  QuestionFormatsEnum,
  QuestionFormatsUsage,
  QuestionFormatsUsageInterface,
+  DefaultAffiliationSearchQuestion,


Updated questionTypeHandlers to use defaults from @dmptool/types and added support for researchOutputTable question type

jupiter007 · 2026-01-02T17:28:27Z

utils/researchOutputTransformations.ts

@@ -0,0 +1,712 @@
+import {
+  CURRENT_SCHEMA_VERSION,


Moved many research output helper functions into one utility

jupiter007 · 2026-01-05T16:55:09Z

Switching to Draft because I just noticed a weird issue with the form not saving

jupiter007 · 2026-01-05T17:04:08Z

Actually, I'm reopening. I can't save any answers for any question type

briri

This was a ton of work! It looks great @jupiter007

We're currently on @dmptool/types 2.1.0 which is the Zod upgrade (with clearer/cleaner defaults). Let's get this merged though with 2.0.0 since, as you noted in the PR its getting really big. I will create a ticket to upgrade to 2.1.0 with all of the things I think will need to be addressed in this repo (e.g. Maps of the type to default are available).

briri · 2026-01-05T17:29:44Z

components/RepoSelectorForAnswer/index.tsx

+
+  // Transform subject areas data for FormSelect - add empty option for deselection
+  const subjectAreas = [
+    { id: 'none', name: '-- None --' },


jupiter007 added 30 commits December 15, 2025 13:36

Changes for the new @dmptool/types updates

2fb9d4a

added Loading component to template/[templateId]

78c45f5

Merge branch 'development' into feature/787/JS-with-changes-for-new-d…

31f5f8c

…mptools-version

Initial changes for question answer

773af2b

Made updates to data flags to use new schema

3967950

Plan create question is now saving

0123a88

Added missing anticipated release date, anticipated file size and unit

58c58b5

Fixed the saving of date and file size

d889bd1

finally got all data saving properly

53d8a73

Fixed issue with metadataStandards selected items not being reflected…

88e9300

… in modal

Moved state management for researchOutputTable out of formData since …

02f2b2d

…its more complex

Moved shared getDefaultAnswerForType to shared location

fa82067

Fixed issue with data not saving

7fdc391

Fixed the metadatastandard selection not showing it was sselected

1f39cbd

Fixed the issue with values in form being wiped out when I entered a …

099904e

…textArea question

Updated ResearchOutputAnswerComponent to list out RO answers, and ot …

2a2947c

…show form if there is only one. Also added a new SingleSearchOutputComponent to display just the one form

Updated to get info mapped to columnHeadings.Updated to include descr…

8bfb680

…iptions in metadata standards list in modal and fixed Delete button

Initial updates for the RO list and edit buttons

024c199

Updated useResearchOutputTable to use DefaultResearchOutputTableQuest…

ed89b7d

…ion to build out RO form state

Updated useResearchOutputTable to use constants

fcee552

Moved reposSelectorForAnswer and metadataStanardForAnsser to their ow…

2ba681e

…n compoents. Moved shared actions to the common app/actions location for addRepositoryAction and addMetaDataStandardAction

added use of languageTranslationKey and constants

195d08d

Updated buttons so that Delete button is in list view, and backToList…

d1e16fc

… button only appears at the bottom of the SingleReseearchOutputComponent form

Added warning when users leave RO form

2cb3b28

Added more unit tests

f403bd7

Removed unused columnHeadings from ResearchOutputAnswerComponent and …

8505c83

…fixed the getRowTitle which would be empty and fall back to default when first adding

Reorganized code by adding a new researchOutputTransformation.ts util…

11b44f5

…. Updated some broken unit tests

Fixed failing unit tests, but still need to add missing unit tests to…

289783b

… increase coverage

jupiter007 added 5 commits December 30, 2025 11:16

Added more unit tests to increase coverage

ee0fcfe

Added unit test for SingleReserchOutputComponent and RepoSelectorForA…

69bb2b9

…nswer and fixed some lintnig issues

Fixed linting issues

86c1668

Fixed issue with question answer page not using new answerId so it di…

4432dcb

…d not recognize that it needed to call update instead of add for answer. made improvements to ResearchOutputAnswerComponent and SingleResearchOutputComponent

Added CHANGELOG.md comments

ed55951

jupiter007 commented Jan 2, 2026

View reviewed changes

jupiter007 changed the base branch from main to development January 2, 2026 17:11

jupiter007 commented Jan 2, 2026

View reviewed changes

jupiter007 requested review from briri and sfisher January 2, 2026 17:28

jupiter007 marked this pull request as draft January 5, 2026 16:54

jupiter007 marked this pull request as ready for review January 5, 2026 17:04

briri approved these changes Jan 5, 2026

View reviewed changes

Added 'meta' object to answer JSONs for all question types

5216030

jupiter007 merged commit e61fcb3 into development Jan 5, 2026

jupiter007 deleted the feature/787/JS-with-changes-for-new-dmptools-version branch January 6, 2026 23:20

		@@ -0,0 +1,46 @@
		"use server";

		import { executeGraphQLMutation } from "@/utils/server/graphqlServerActionHandler";

Updates for Research Output Table question type in Plan Creator #1078

Updates for Research Output Table question type in Plan Creator #1078

Uh oh!

Conversation

jupiter007 commented Jan 2, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Type of change

How Has This Been Tested?

Checklist:

Important Note:

Testing

Screen recording

Adding answers to a Research Output question

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jupiter007 commented Jan 5, 2026

Uh oh!

jupiter007 commented Jan 5, 2026

Uh oh!

briri left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

jupiter007 commented Jan 2, 2026 •

edited

Loading