Add additional comments portion to all forms (#57)

* additional comments for histology form * add additional comments and increment editions * additional comments to handling form * additional comments to housing form * additional comments for injection form * increment edition add additional comment to origin form * adding additional comments and incrementing editions of forms * Update lib/forms/CoBrALab-Mouse-End-Of-Life-Form/index.ts Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * Update lib/forms/CoBrALab-Mouse-End-Of-Life-Form/index.ts Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> --------- Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
CoBrALab · Feb 12, 2025 · 5773abc · 5773abc
1 parent 50f4fb1
commit 5773abc
Show file tree

Hide file tree

Showing 11 changed files with 143 additions and 23 deletions.
diff --git a/lib/forms/CoBrALab-Histology-Form/index.ts b/lib/forms/CoBrALab-Histology-Form/index.ts
@@ -17,7 +17,7 @@ export default defineInstrument({
     "Antibodies"
   ],
   internal: {
-    edition: 1,
+    edition: 2,
     name: "HISTOLOGY_FORM",
   },
   content: {
@@ -190,6 +190,12 @@ export default defineInstrument({
       variant: "radio",
       label: "Histology Quantified",
     },
+
+    additionalComments: {
+      kind: "string",
+      variant: "textarea",
+      label: "Additional Comments"
+    }
   },
   details: {
     description:
@@ -282,6 +288,10 @@ export default defineInstrument({
       kind: "const",
       ref: "histologyQuantified",
     },
+    additionalComments: {
+      kind: "const",
+      ref: "additionalComments"
+    }
   },
   validationSchema: z.object({
     roomNumber: z.string(),
@@ -310,5 +320,6 @@ export default defineInstrument({
     stainUsed: z.enum(["GFAP", "IBA1", "PSYN", "TH", "NEUN"]).optional(),
     dateStained: z.date().optional(),
     histologyQuantified: z.boolean(),
+    additionalComments: z.string().optional()
   }),
 });
diff --git a/lib/forms/CoBrALab-Mouse-End-Of-Life-Form/index.ts b/lib/forms/CoBrALab-Mouse-End-Of-Life-Form/index.ts
@@ -23,7 +23,7 @@ export default defineInstrument({
   language: 'en',
   tags: ['End of Life', 'Mouse', 'Euthanasia', 'Termination'],
   internal: {
-    edition: 2,
+    edition: 3,
     name: 'MOUSE_END_OF_LIFE_FORM'
   },
   content: {
@@ -260,7 +260,13 @@ export default defineInstrument({
         }
         return null;
       }
+    },
+    additionalComments: {
+      kind: 'string',
+      variant: 'textarea',
+      label: 'Additional comments'
     }
+
   },
   details: {
     description: 'Form to fill in info of mouse end of life',
@@ -337,6 +343,11 @@ export default defineInstrument({
         }
         return extractInfo;
       }
+    },
+    additionalComments: {
+      kind: "const",
+      label: "Additional comments",
+      ref: "additionalComments"
     }
 
   },
@@ -403,6 +414,8 @@ export default defineInstrument({
         ])
         })
       )
-      .optional()
+      .optional(),
+
+    additionalComments: z.string().optional()
   })
 });
diff --git a/lib/forms/CoBrALab-Mouse-Handling-Form/index.ts b/lib/forms/CoBrALab-Mouse-Handling-Form/index.ts
@@ -8,7 +8,7 @@ export default defineInstrument({
   language: 'en',
   tags: ['Handling','Cupping','Training'],
   internal: {
-    edition: 1,
+    edition: 2,
     name: 'MOUSE_HANDLING_FORM'
   },
   clientDetails: {
@@ -36,6 +36,11 @@ export default defineInstrument({
       kind: "number",
       variant: "input",
       label: "Duration (minutes)"
+    },
+    additionalComments: {
+      kind: "string",
+      variant: "textarea",
+      label: "Additional Comments"
     }
   },
   details: {
@@ -58,11 +63,16 @@ export default defineInstrument({
       kind: 'const',
       label: "Duration (minutes)",
       ref: "handlingDuration"
+    },
+    additionalComments: {
+      kind: "const",
+      ref: "additionalComments"
     }
   },
   validationSchema: z.object({
     roomNumber: z.string(),
     handlingType: z.enum(["Tail grabbing","Cupping","Tube method"]),
-    handlingDuration: z.number().min(0)
+    handlingDuration: z.number().min(0),
+    additionalComments: z.string().optional()
   })
 });
diff --git a/lib/forms/CoBrALab-Mouse-Housing-Form/index.ts b/lib/forms/CoBrALab-Mouse-Housing-Form/index.ts
@@ -8,7 +8,7 @@ export default defineInstrument({
   language: 'en',
   tags: ['Housing','Cage Enrichment','Room Change','Cage Change', 'Cage'],
   internal: {
-    edition: 2,
+    edition: 3,
     name: 'MOUSE_HOUSING_FORM'
   },
   content: {
@@ -117,6 +117,11 @@ export default defineInstrument({
         }
         return null
       }
+    },
+    additionalComments: {
+      kind: "string",
+      variant: "textarea",
+      label: "Additional Comments"
     }
   },
   clientDetails: {
@@ -181,6 +186,10 @@ export default defineInstrument({
 
         return data.cageEnrichment ? Array.from(data.cageEnrichment).join(" ") : ""
       }
+    },
+    additionalComments: {
+      kind: "const",
+      ref: "additionalComments"
     }
   },
   validationSchema: z.object({
@@ -202,6 +211,7 @@ export default defineInstrument({
     bottleType: z.enum(['Auto Bottle', 'Standard']),
     cageType: z.enum(['Enriched', 'Standard']),
     cageEnrichment: z.set(z.enum(['Wheel',"Cover","Tube","Enlarged Cage"])).optional(),
+    additionalComments: z.string().optional()
 
   })
 });
diff --git a/lib/forms/CoBrALab-Mouse-Injection-Form/index.ts b/lib/forms/CoBrALab-Mouse-Injection-Form/index.ts
@@ -23,7 +23,7 @@ export default defineInstrument({
   language: 'en',
   tags: ['Injections', 'Drug', 'Physical Intervention','Anesthesia'],
   internal: {
-    edition: 2,
+    edition: 3,
     name: 'MOUSE_INJECTIONS_FORM'
   },
   content: {
@@ -151,7 +151,13 @@ export default defineInstrument({
         "Viral memetic": "Viral memetic",
         "Anesthetic": "Anesthetic"
       }
-    },(type) => type === "IP")
+    },(type) => type === "IP"),
+
+    additionalComments: {
+      kind: "string",
+      variant: "textarea",
+      label: "Additional Comments"
+    }
 
 
   },
@@ -212,6 +218,10 @@ export default defineInstrument({
     ipInjectionType: {
       kind: "const",
       ref: "ipInjectionType"
+    },
+    additionalComments: {
+      kind: "const",
+      ref: "additionalComments"
     }
 
   },
@@ -227,6 +237,7 @@ export default defineInstrument({
     analgesicType: z.enum(["Carprofen", "Bupivacaine"]).optional(),
     ipDoseVolume: z.number().min(0).optional(),
     drugInjected: z.enum(["PU-AD", "PU-AD Vehicle", "IP Tamoxifen", "STZ"]).optional(),
-    ipInjectionType: z.enum(["Viral memetic", "Anesthetic"]).optional()
+    ipInjectionType: z.enum(["Viral memetic", "Anesthetic"]).optional(),
+    additionalComments: z.string().optional()
   })
 });
diff --git a/lib/forms/CoBrALab-Mouse-Surgery-Form/index.ts b/lib/forms/CoBrALab-Mouse-Surgery-Form/index.ts
@@ -23,7 +23,7 @@ export default defineInstrument({
   language: 'en',
   tags: ['Surgery', 'Vet Care', 'Wound Treatment', 'Ovariectomy'],
   internal: {
-    edition: 2,
+    edition: 3,
     name: 'MOUSE_SURGERY_FORM'
   },
   content: {
@@ -218,6 +218,12 @@ export default defineInstrument({
       variant: "input",
       label: "Treatment provided"
     }, (type) => type === "Wound treatment"),
+
+    additionalComments: {
+      kind: "string",
+      variant: "textarea",
+      label: "Additional Comments"
+    }
 
 
   },
@@ -295,6 +301,10 @@ export default defineInstrument({
     treatmentProvided: {
       kind: "const",
       ref: "treatmentProvided"
+    },
+    additionalComments: {
+      kind: "const",
+      ref: "additionalComments"
     }
   },
   validationSchema: z.object({
@@ -313,7 +323,8 @@ export default defineInstrument({
       brainSurgeryPaxinosDVCoords: z.number().min(0).max(6.4).optional(),
       woundDateReported: z.date().optional(),
       clinicalCondition: z.string().optional(),
-      treatmentProvided: z.string().optional()
+      treatmentProvided: z.string().optional(),
+      additionalComments: z.string().optional()
 
   })
 });
diff --git a/lib/forms/CoBrALab-Physical-Intervention-Form/index.ts b/lib/forms/CoBrALab-Physical-Intervention-Form/index.ts
@@ -32,7 +32,7 @@ export default defineInstrument({
   language: 'en',
   tags: ['Physical intervention','Blood extraction', 'Ear tagging', 'Genotyping', 'Vaginal cytology','Blood glucose','anesthesia'],
   internal: {
-    edition: 1,
+    edition: 2,
     name: 'PHYSICAL_INTERVENTION_FORM'
   },
   content: {
@@ -144,7 +144,13 @@ export default defineInstrument({
       kind: "string",
       variant: 'input',
       label: "Blood glucose level"
-    }, (type) => type === "Blood glucose")
+    }, (type) => type === "Blood glucose"),
+
+    additionalComments: {
+      kind: "string",
+      variant: "textarea",
+      label: "Additional Comments"
+    }
   },
   details: {
     description: 'This form is used to track any physical intervention done upon an animal. Possible physical interventions include teeth extraction, tagging, tattooing, cytologies and other forms of swabbing.',
@@ -214,6 +220,10 @@ export default defineInstrument({
     bloodGlucoseLevel: {
       kind: "const",
       ref: "bloodGlucoseLevel"
+    },
+    additionalComments: {
+      kind: 'const',
+      ref: 'additionalComments'
     }
   },
   validationSchema: z.object({
@@ -260,6 +270,7 @@ export default defineInstrument({
     ]).optional()
   })).optional(),
     teethExtractionNumber: z.number().int().min(0).max(16).optional(),
-    bloodGlucoseLevel: z.string().optional()
+    bloodGlucoseLevel: z.string().optional(),
+    additionalComments: z.string().optional()
   })
 });
diff --git a/lib/forms/CoBrALab-Stress-Administration-Form/index.ts b/lib/forms/CoBrALab-Stress-Administration-Form/index.ts
@@ -25,7 +25,7 @@ export default defineInstrument({
   language: 'en',
   tags: ['Stress', 'Tail suspension', 'Restraint', 'Electric shock'],
   internal: {
-    edition: 1,
+    edition: 2,
     name: 'STRESS_ADMINISTRATION_FORM'
   },
   content: {
@@ -70,7 +70,13 @@ export default defineInstrument({
       variant: "radio",
       label: "Climb stoppers used"
     },
-    (type) => type === "Tail suspension")
+    (type) => type === "Tail suspension"),
+
+    additionalComments: {
+      kind: "string",
+      variant: "textarea",
+      label: "Additional Comments"
+    }
   },
   details: {
     description: 'Describes the stress administration done upon an animal, with the current possible three options being tail suspension, restraint and electric foot shocks.',
@@ -105,15 +111,21 @@ export default defineInstrument({
       tailSuspensionClimbStoppers: {
         kind: "const",
         ref: "tailSuspensionClimbStoppers"
+      },
+      additionalComments: {
+        kind: 'const',
+        ref: 'additionalComments'
       }
+
   },
   validationSchema: z.object({
     miceNumber: z.number().min(0).max(10).int(),
     roomNumber: z.string(),
     stressorType: z.enum(["Electric foot shocks", "Tail suspension", "Restraint"]),
     footShocksNumber: z.number().int().min(1).optional(),
     footShockAmperage: z.number().min(0).optional(),
-    tailSuspensionClimbStoppers: z.boolean().optional()
+    tailSuspensionClimbStoppers: z.boolean().optional(),
+    additionalComments: z.string().optional()
 
   })
 });
diff --git a/lib/forms/CoBraLab-Mouse-Origin-Form/index.ts b/lib/forms/CoBraLab-Mouse-Origin-Form/index.ts
@@ -8,7 +8,7 @@ export default defineInstrument({
   language: 'en',
   tags: ['Birth', 'Mouse','Origin'],
   internal: {
-    edition: 2,
+    edition: 3,
     name: 'MOUSE_ORIGIN_FORM'
   },
   content: {
@@ -212,6 +212,11 @@ export default defineInstrument({
       kind: 'number',
       variant: 'input',
       label: 'N-generation of mouse'
+    },
+    additionalComments: {
+      kind: "string",
+      variant: "textarea",
+      label: "Additional Comments"
     }
   },
   clientDetails: {
@@ -308,6 +313,10 @@ export default defineInstrument({
     kind: 'const',
     label: 'Generation Number',
     ref: 'generationNumber'
+  },
+  additionalComments: {
+    kind: 'const',
+    ref: 'additionalComments'
   }
   },
   validationSchema: z.object({
@@ -345,6 +354,7 @@ export default defineInstrument({
     'Other'
   ]).optional(),
   otherBreederOrigin: z.string().optional(),
-  generationNumber: z.number().min(0).int()
+  generationNumber: z.number().min(0).int(),
+  additionalComments: z.string().optional()
 })
 });