SIMSBIOHUB-647: Create/Edit Observations Page (#1444)

* New Create and Edit Observations page.
* Add support for multiple subcounts per observation.
* Update existing observation endpoints/services and UI components to work with subcounts (rather than observations)
* Migration to move 'environment' attributes from the subcount record to the observation record
* Migration to move 'sign_id' from the subcount record to the observation record.
* Misc cleanup/fixes

---------

Co-authored-by: Nick Phura <nickphura@gmail.com>
Co-authored-by: Mac Deluca <Mac.Deluca@quartech.com>

Author: 3 people

api/src/database-models/environment_qualitative.ts

@@ -0,0 +1,35 @@
+import { z } from 'zod';
+
+/**
+ * Environment Qualitative Model.
+ *
+ * @description Data model for `environment_qualitative`.
+ */
+export const EnvironmentQualitativeModel = z.object({
+  environment_qualitative_id: z.string().uuid(),
+  name: z.string(),
+  description: z.string().nullable(),
+  record_end_date: z.string().nullable(),
+  create_date: z.string(),
+  create_user: z.number(),
+  update_date: z.string().nullable(),
+  update_user: z.number().nullable(),
+  revision_count: z.number()
+});
+
+export type EnvironmentQualitativeModel = z.infer<typeof EnvironmentQualitativeModel>;
+
+/**
+ * Environment Qualitative Record.
+ *
+ * @description Data record for `environment_qualitative`.
+ */
+export const EnvironmentQualitativeRecord = EnvironmentQualitativeModel.omit({
+  create_date: true,
+  create_user: true,
+  update_date: true,
+  update_user: true,
+  revision_count: true
+});
+
+export type EnvironmentQualitativeRecord = z.infer<typeof EnvironmentQualitativeRecord>;

api/src/database-models/environment_qualitative_option.ts

@@ -0,0 +1,36 @@
+import { z } from 'zod';
+
+/**
+ * Environment Qualitative Option Model.
+ *
+ * @description Data model for `environment_qualitative_option`.
+ */
+export const EnvironmentQualitativeOptionModel = z.object({
+  environment_qualitative_option_id: z.string(),
+  environment_qualitative_id: z.string(),
+  name: z.string(),
+  description: z.string().nullable(),
+  record_end_date: z.string().nullable(),
+  create_date: z.string(),
+  create_user: z.number(),
+  update_date: z.string().nullable(),
+  update_user: z.number().nullable(),
+  revision_count: z.number()
+});
+
+export type EnvironmentQualitativeOptionModel = z.infer<typeof EnvironmentQualitativeOptionModel>;
+
+/**
+ * Environment Qualitative Option Record.
+ *
+ * @description Data record for `environment_qualitative_option`.
+ */
+export const EnvironmentQualitativeOptionRecord = EnvironmentQualitativeOptionModel.omit({
+  create_date: true,
+  create_user: true,
+  update_date: true,
+  update_user: true,
+  revision_count: true
+});
+
+export type EnvironmentQualitativeOptionRecord = z.infer<typeof EnvironmentQualitativeOptionRecord>;

api/src/database-models/environment_quantitative.ts

@@ -0,0 +1,39 @@
+import { z } from 'zod';
+import { EnvironmentUnit } from '../database-units/environment_unit';
+
+/**
+ * Environment Quantitative Model.
+ *
+ * @description Data model for `environment_quantitative`.
+ */
+export const EnvironmentQuantitativeModel = z.object({
+  environment_quantitative_id: z.string().uuid(),
+  name: z.string(),
+  description: z.string().nullable(),
+  min: z.number().nullable(),
+  max: z.number().nullable(),
+  unit: EnvironmentUnit.nullable(),
+  record_end_date: z.string().nullable(),
+  create_date: z.string(),
+  create_user: z.number(),
+  update_date: z.string().nullable(),
+  update_user: z.number().nullable(),
+  revision_count: z.number()
+});
+
+export type EnvironmentQuantitativeModel = z.infer<typeof EnvironmentQuantitativeModel>;
+
+/**
+ * Environment Quantitative Record.
+ *
+ * @description Data record for `environment_quantitative`.
+ */
+export const EnvironmentQuantitativeRecord = EnvironmentQuantitativeModel.omit({
+  create_date: true,
+  create_user: true,
+  update_date: true,
+  update_user: true,
+  revision_count: true
+});
+
+export type EnvironmentQuantitativeRecord = z.infer<typeof EnvironmentQuantitativeRecord>;

api/src/database-models/observation_environment_qualitative.ts

@@ -0,0 +1,35 @@
+import { z } from 'zod';
+
+/**
+ * Observation Environment Qualitative Model.
+ *
+ * @description Data model for `observation_environment_qualitative`.
+ */
+export const ObservationEnvironmentQualitativeModel = z.object({
+  observation_environment_qualitative_id: z.number(),
+  survey_observation_id: z.number(),
+  environment_qualitative_id: z.string().uuid(),
+  environment_qualitative_option_id: z.string().uuid(),
+  create_date: z.string(),
+  create_user: z.number(),
+  update_date: z.string().nullable(),
+  update_user: z.number().nullable(),
+  revision_count: z.number()
+});
+
+export type ObservationEnvironmentQualitativeModel = z.infer<typeof ObservationEnvironmentQualitativeModel>;
+
+/**
+ * Observation Environment Qualitative Record.
+ *
+ * @description Data record for `observation_environment_qualitative`.
+ */
+export const ObservationEnvironmentQualitativeRecord = ObservationEnvironmentQualitativeModel.omit({
+  create_date: true,
+  create_user: true,
+  update_date: true,
+  update_user: true,
+  revision_count: true
+});
+
+export type ObservationEnvironmentQualitativeRecord = z.infer<typeof ObservationEnvironmentQualitativeRecord>;

api/src/database-models/observation_environment_quantitative.ts

@@ -0,0 +1,35 @@
+import { z } from 'zod';
+
+/**
+ * Observation Environment Quantitative Model.
+ *
+ * @description Data model for `observation_environment_quantitative`.
+ */
+export const ObservationEnvironmentQuantitativeModel = z.object({
+  observation_environment_quantitative_id: z.number(),
+  survey_observation_id: z.number(),
+  environment_quantitative_id: z.string().uuid(),
+  value: z.number(),
+  create_date: z.string(),
+  create_user: z.number(),
+  update_date: z.string().nullable(),
+  update_user: z.number().nullable(),
+  revision_count: z.number()
+});
+
+export type ObservationEnvironmentQuantitativeModel = z.infer<typeof ObservationEnvironmentQuantitativeModel>;
+
+/**
+ * Observation Environment Quantitative Record.
+ *
+ * @description Data record for `observation_environment_quantitative`.
+ */
+export const ObservationEnvironmentQuantitativeRecord = ObservationEnvironmentQuantitativeModel.omit({
+  create_date: true,
+  create_user: true,
+  update_date: true,
+  update_user: true,
+  revision_count: true
+});
+
+export type ObservationEnvironmentQuantitativeRecord = z.infer<typeof ObservationEnvironmentQuantitativeRecord>;

api/src/database-models/observation_sign.ts

@@ -0,0 +1,35 @@
+import { z } from 'zod';
+
+/**
+ * Observation Sign Model.
+ *
+ * @description Data model for `observation_sign`.
+ */
+export const ObservationSignModel = z.object({
+  observation_sign_id: z.number(),
+  name: z.string(),
+  description: z.string().nullable(),
+  record_end_date: z.string().nullable(),
+  create_date: z.string(),
+  create_user: z.number(),
+  update_date: z.string().nullable(),
+  update_user: z.number().nullable(),
+  revision_count: z.number()
+});
+
+export type ObservationSignModel = z.infer<typeof ObservationSignModel>;
+
+/**
+ * Observation Sign Record.
+ *
+ * @description Data record for `observation_sign`.
+ */
+export const ObservationSignRecord = ObservationSignModel.omit({
+  create_date: true,
+  create_user: true,
+  update_date: true,
+  update_user: true,
+  revision_count: true
+});
+
+export type ObservationSignRecord = z.infer<typeof ObservationSignRecord>;

api/src/database-models/observation_subcount.ts

@@ -0,0 +1,35 @@
+import { z } from 'zod';
+
+/**
+ * Observation Subcount Model.
+ *
+ * @description Data model for `observation_subcount`.
+ */
+export const ObservationSubcountModel = z.object({
+  observation_subcount_id: z.number(),
+  survey_observation_id: z.number(),
+  subcount: z.number(),
+  comment: z.string().nullable(),
+  create_date: z.string(),
+  create_user: z.number(),
+  update_date: z.string().nullable(),
+  update_user: z.number().nullable(),
+  revision_count: z.number()
+});
+
+export type ObservationSubcountModel = z.infer<typeof ObservationSubcountModel>;
+
+/**
+ * Observation Subcount Record.
+ *
+ * @description Data record for `observation_subcount`.
+ */
+export const ObservationSubcountRecord = ObservationSubcountModel.omit({
+  create_date: true,
+  create_user: true,
+  update_date: true,
+  update_user: true,
+  revision_count: true
+});
+
+export type ObservationSubcountRecord = z.infer<typeof ObservationSubcountRecord>;

api/src/database-models/subcount_critter.ts

@@ -0,0 +1,34 @@
+import { z } from 'zod';
+
+/**
+ * Subcount Critter Model.
+ *
+ * @description Data model for `subcount_critter`.
+ */
+export const SubcountCritterModel = z.object({
+  subcount_critter_id: z.number(),
+  observation_subcount_id: z.number(),
+  critter_id: z.number(),
+  create_date: z.string(),
+  create_user: z.number(),
+  update_date: z.string().nullable(),
+  update_user: z.number().nullable(),
+  revision_count: z.number()
+});
+
+export type SubcountCritterModel = z.infer<typeof SubcountCritterModel>;
+
+/**
+ * Subcount Critter Record.
+ *
+ * @description Data record for `subcount_critter`.
+ */
+export const SubcountCritterRecord = SubcountCritterModel.omit({
+  create_date: true,
+  create_user: true,
+  update_date: true,
+  update_user: true,
+  revision_count: true
+});
+
+export type SubcountCritterRecord = z.infer<typeof SubcountCritterRecord>;

api/src/database-models/survey_observation.ts

@@ -16,6 +16,7 @@ export const SurveyObservationModel = z.object({
   count: z.number(),
   observation_time: z.string().nullable(),
   observation_date: z.string().nullable(),
+  observation_sign_id: z.number().nullable(),
   create_date: z.string(),
   create_user: z.number(),
   update_date: z.string().nullable(),

api/src/database-units/environment_unit.ts

@@ -0,0 +1,23 @@
+import { z } from 'zod';
+
+/**
+ * Environment Unit Data Type.
+ *
+ * @description Data type for `environment_unit`.
+ */
+export const EnvironmentUnit = z.enum([
+  'millimeter',
+  'centimeter',
+  'meter',
+  'milligram',
+  'gram',
+  'kilogram',
+  'percent',
+  'celsius',
+  'ppt',
+  'SCF',
+  'degrees',
+  'pH'
+]);
+
+export type EnvironmentUnit = z.infer<typeof EnvironmentUnit>;

api/src/models/biohub-create.test.ts

@@ -24,7 +24,8 @@ describe('PostSurveyObservationToBiohubObject', () => {
       itis_tsn: 1,
       itis_scientific_name: 'itis_scientific_name',
       observation_time: 'observation_time',
-      observation_date: 'observation_date'
+      observation_date: 'observation_date',
+      observation_sign_id: 1
     };
 
     before(() => {
@@ -81,7 +82,8 @@ describe('PostSurveyToBiohubObject', () => {
       itis_tsn: 1,
       itis_scientific_name: 'itis_scientific_name',
       observation_time: 'observation_time',
-      observation_date: 'observation_date'
+      observation_date: 'observation_date',
+      observation_sign_id: 1
     };
 
     const survey_obj: GetSurveyData = {
@@ -153,7 +155,8 @@ describe('PostSurveySubmissionToBioHubObject', () => {
         itis_tsn: 2,
         itis_scientific_name: 'itis_scientific_name',
         observation_time: 'observation_time',
-        observation_date: 'observation_date'
+        observation_date: 'observation_date',
+        observation_sign_id: 1
       }
     ];