feat: Stage 1 - add parseConfig field to Question and OptionChoice models (#238)

* feat: add parseConfig field to Form, Question, and OptionGroup models

* feat: Add parseConfig field to OptionChoice model

* feat: Add parseConfig to questions and optionChoice seeds with predefined options

* refactor: Update parseConfig in checkin and voyage submission forms

- Modify rocket status icons to use icon and iconUrl properties
- Update boolean and NPS scale options to use more generic min/max keys

Author: timDeHof

prisma/migrations/20250207162121_add_parse_config_fields/migration.sql

@@ -0,0 +1,5 @@
+-- AlterTable
+ALTER TABLE "OptionChoice" ADD COLUMN     "parseConfig" JSONB;
+
+-- AlterTable
+ALTER TABLE "Question" ADD COLUMN     "parseConfig" JSONB;

prisma/schema/form.prisma

@@ -46,6 +46,7 @@ model Question {
 
   responses    Response[]
   subQuestions Question[] @relation("QuestionSubQuestion")
+  parseConfig  Json?
 }
 
 model InputType {
@@ -67,6 +68,7 @@ model OptionGroup {
 
   optionChoices OptionChoice[]
   questions     Question[]
+
 }
 
 model OptionChoice {
@@ -79,6 +81,7 @@ model OptionChoice {
   updatedAt DateTime @updatedAt
 
   responses Response[]
+  parseConfig Json?
 }
 
 model Response {

prisma/seed/forms/checkinform.ts

@@ -74,12 +74,27 @@ export const populateCheckinForm = async () => {
                                         data: [
                                             {
                                                 text: "{{greenRocket}} We have had a good start!",
+                                                parseConfig: {
+                                                    icon: "greenRocket",
+                                                    iconUrl:
+                                                        ".../greenRocket.png",
+                                                },
                                             },
                                             {
                                                 text: "{{amberRocket}} I'm nervous we won't finish",
+                                                parseConfig: {
+                                                    icon: "amberRocket",
+                                                    iconUrl:
+                                                        ".../amberRocket.png",
+                                                },
                                             },
                                             {
                                                 text: "{{redRocket}} It doesn't look good right now",
+                                                parseConfig: {
+                                                    icon: "redRocket",
+                                                    iconUrl:
+                                                        ".../redRocket.png",
+                                                },
                                             },
                                         ],
                                     },
@@ -157,7 +172,11 @@ export const populateCheckinForm = async () => {
                                 name: "boolean",
                             },
                         },
-                        text: "{{Yes,No}}Did you deploy to Production at the end of this Sprint?",
+                        text: "{{yes,no}}Did you deploy to Production at the end of this Sprint?",
+                        parseConfig: {
+                            yes: "Yes",
+                            no: "No",
+                        },
                         answerRequired: true,
                     },
                     {

prisma/seed/forms/checkinformSM.ts

@@ -23,6 +23,10 @@ export const populateCheckinFormSM = async () => {
                             },
                         },
                         text: "{{Yes,No}} Did your Scrum Master provide any Scrum training or coaching, either during events or through Discord?",
+                        parseConfig: {
+                            Yes: "Yes",
+                            No: "No",
+                        },
                         answerRequired: true,
                     },
                     {
@@ -33,6 +37,10 @@ export const populateCheckinFormSM = async () => {
                             },
                         },
                         text: "{{Yes,No}} Was your Scrum Master effective in resolving issues and removing impediments during sprints?",
+                        parseConfig: {
+                            Yes: "Yes",
+                            No: "No",
+                        },
                         answerRequired: true,
                     },
                     {
@@ -43,6 +51,10 @@ export const populateCheckinFormSM = async () => {
                             },
                         },
                         text: "{{Yes,No}} Did your Scrum Master work to ensure that all Scrum events ran smoothly, stayed positive and productive, and stayed within the designated timebox?",
+                        parseConfig: {
+                            Yes: "Yes",
+                            No: "No",
+                        },
                         answerRequired: true,
                     },
                     {

prisma/seed/forms/voyage-project-submission.ts

@@ -94,6 +94,10 @@ export const populateVoyageSubmissionForm = async () => {
                             },
                         },
                         text: "{{Not Likely,Extremely Likely}}On a scale of 0-10, how likely are you to suggest Chingu to a friend or colleague?",
+                        parseConfig: {
+                            min: "Not Likely",
+                            max: "Extremely Likely",
+                        },
                         answerRequired: true,
                         optionGroup: {
                             create: {

src/global/mocks/mock-data.ts

@@ -203,6 +203,7 @@ export const createMockData = {
         multipleAllowed: null,
         optionGroupId: null,
         parentQuestionId: null,
+        parseConfig: null,
         createdAt: mockDate,
         updatedAt: mockDate,
         ...partial,

src/sprints/sprints.controller.spec.ts

@@ -320,6 +320,7 @@ describe("SprintsController", () => {
                                 optionChoiceId: null,
                                 createdAt: mockDate,
                                 updatedAt: mockDate,
+
                                 question: {
                                     id: 1,
                                     text: "Question 1",
@@ -333,7 +334,9 @@ describe("SprintsController", () => {
                                     parentQuestionId: null,
                                     createdAt: mockDate,
                                     updatedAt: mockDate,
+                                    parseConfig: null,
                                 },
+
                                 optionChoice: null,
                             },
                         ],

src/sprints/sprints.service.spec.ts

@@ -313,6 +313,7 @@ describe("SprintsService", () => {
                                         parentQuestionId: null,
                                         createdAt: mockDate,
                                         updatedAt: mockDate,
+                                        parseConfig: null,
                                     },
                                     optionChoice: null,
                                 },