Recommended Headers check

.gitignore

@@ -111,3 +111,4 @@ dist
 
 # n8N - ignore root level temp config folder
 .n8n
+n8n/.config/

api/src/utils/media/csv/dwc/dwc-archive-validator.ts

@@ -5,7 +5,8 @@ import { CSVValidator } from '../csv-file';
 import {
   getDuplicateHeadersValidator,
   getValidHeadersValidator,
-  hasRequiredHeadersValidator
+  hasRequiredHeadersValidator,
+  hasRecommendedHeadersValidator
 } from '../validation/csv-header-validator';
 import {
   getCodeValueFieldsValidator,
@@ -77,8 +78,7 @@ const getRequiredHeaders = (dwcClass: DWC_CLASS): string[] => {
         'verbatimElevation',
         'coordinateUncertaintyInMeters',
         'coordinatePrecision',
-        'verbatimLocality',
-        'locationRemarks'
+        'verbatimLocality'
       ];
     case DWC_CLASS.OCCURRENCE:
       return [
@@ -89,8 +89,7 @@ const getRequiredHeaders = (dwcClass: DWC_CLASS): string[] => {
         'associatedTaxa',
         'sex',
         'lifeStage',
-        'individualCount',
-        'identifiedBy'
+        'individualCount'
       ];
     case DWC_CLASS.MEASUREMENTORFACT:
       return ['measurementID', 'occurrenceID', 'measurementType', 'measurementUnit', 'measurementValue'];
@@ -103,6 +102,17 @@ const getRequiredHeaders = (dwcClass: DWC_CLASS): string[] => {
   }
 };
 
+const getRecommendedHeaders = (dwcClass: DWC_CLASS): string[] => {
+  switch (dwcClass) {
+    case DWC_CLASS.EVENT:
+      return ['locationRemarks'];
+    case DWC_CLASS.OCCURRENCE:
+      return ['identifiedBy'];
+    default:
+      return [];
+  }
+};
+
 const getRequiredFieldsByHeader = (dwcClass: DWC_CLASS): string[] => {
   switch (dwcClass) {
     case DWC_CLASS.EVENT:
@@ -160,6 +170,7 @@ export const getDWCCSVValidators = (dwcClass: DWC_CLASS): CSVValidator[] => {
   return [
     getDuplicateHeadersValidator(),
     hasRequiredHeadersValidator(getRequiredHeaders(dwcClass)),
+    hasRecommendedHeadersValidator(getRecommendedHeaders(dwcClass)),
     getValidHeadersValidator(getValidHeaders(dwcClass)),
     getRequiredFieldsValidator(getRequiredFieldsByHeader(dwcClass)),
     getCodeValueFieldsValidator(getCodeValuesByHeader(dwcClass)),

api/src/utils/media/csv/validation/csv-header-validator.ts

@@ -77,6 +77,50 @@ export const hasRequiredHeadersValidator = (requiredHeaders?: string[]): CSVVali
   };
 };
 
+/**
+ * For each `recommendedHeaders`, adds an error if the header is not present in the csv.
+ *
+ * @param {string[]} [recommendedHeaders]
+ * @return {*}  {CSVValidator}
+ */
+export const hasRecommendedHeadersValidator = (recommendedHeaders?: string[]): CSVValidator => {
+  return (csvWorksheet) => {
+    if (!recommendedHeaders?.length) {
+      return csvWorksheet;
+    }
+
+    const headers = csvWorksheet.getHeaders();
+
+    if (!headers?.length) {
+      csvWorksheet.csvValidation.addHeaderErrors(
+        recommendedHeaders.map((recommendedHeader) => {
+          return {
+            errorCode: 'Missing Recommended Header',
+            message: 'Missing recommended header',
+            col: recommendedHeader
+          };
+        })
+      );
+
+      return csvWorksheet;
+    }
+
+    for (const recommendedHeader of recommendedHeaders) {
+      if (!headers.includes(recommendedHeader)) {
+        csvWorksheet.csvValidation.addHeaderErrors([
+          {
+            errorCode: 'Missing Recommended Header',
+            message: 'Missing recommended header',
+            col: recommendedHeader
+          }
+        ]);
+      }
+    }
+
+    return csvWorksheet;
+  };
+};
+
 /**
  * Adds an error for any header that is not found in the provided `validHeaders` array.
  *

api/src/utils/media/csv/xlsx/xlsx-validator.ts

@@ -4,7 +4,8 @@ import { CSVValidator, XLSX_CLASS } from '../csv-file';
 import {
   getDuplicateHeadersValidator,
   getValidHeadersValidator,
-  hasRequiredHeadersValidator
+  hasRequiredHeadersValidator,
+  hasRecommendedHeadersValidator
 } from '../validation/csv-header-validator';
 import {
   getCodeValueFieldsValidator,
@@ -152,8 +153,7 @@ export const getRequiredHeaders = (xlsxClass: XLSX_CLASS): string[] => {
         'Sample Station Label',
         'UTM Zone Sample Station',
         'Easting Sample Station',
-        'Northing Sample Station',
-        'Design Type Given'
+        'Northing Sample Station'
       ];
     case XLSX_CLASS.GENERAL_SURVEY:
       return [
@@ -176,14 +176,24 @@ export const getRequiredHeaders = (xlsxClass: XLSX_CLASS): string[] => {
         'Site UTM Zone',
         'Site Easting',
         'Site Northing',
-        'Species',
-        'Date & Time'
+        'Species'
       ];
     default:
       return [];
   }
 };
 
+export const getRecommendedHeaders = (xlsxClass: XLSX_CLASS): string[] => {
+  switch (xlsxClass) {
+    case XLSX_CLASS.SAMPLE_STATION_INFORMATION:
+      return ['Design Type Given'];
+    case XLSX_CLASS.SITE_INCIDENTAL_OBSERVATIONS:
+      return ['Date & Time'];
+    default:
+      return [];
+  }
+};
+
 export const getRequiredFieldsByHeader = (xlsxClass: XLSX_CLASS): string[] => {
   switch (xlsxClass) {
     case XLSX_CLASS.SAMPLE_STATION_INFORMATION:
@@ -253,6 +263,7 @@ export const getXLSXCSVValidators = (xlsxClass: XLSX_CLASS): CSVValidator[] => {
   return [
     getDuplicateHeadersValidator(),
     hasRequiredHeadersValidator(getRequiredHeaders(xlsxClass)),
+    hasRecommendedHeadersValidator(getRecommendedHeaders(xlsxClass)),
     getValidHeadersValidator(getValidHeaders(xlsxClass)),
     getRequiredFieldsValidator(getRequiredFieldsByHeader(xlsxClass)),
     getCodeValueFieldsValidator(getCodeValuesByHeader(xlsxClass)),

app/src/features/surveys/view/SurveyObservations.tsx

@@ -236,6 +236,10 @@ const SurveyObservations = () => {
       type: ['Missing Required Field', 'Missing Required Header'],
       label: 'Mandatory fields have not been filled out'
     },
+    recommended: {
+      type: ['Missing Recommended Header'],
+      label: 'Recommended fields have not been filled out'
+    },
     value_not_from_list: {
       type: ['Invalid Value'],
       label: "Values have not been selected from the field's dropdown list"