feat: new EventID field

Author: jayakishore709

CHANGELOG.md

@@ -31,6 +31,7 @@ Targets `3.0.0`. Introduces **Groundwater support** to the DataStream schema.
   - `MonitoringLocationVerticalUnit`: `ft`, `m`
   - `SampleCollectionEquipmentName`: `Air line`, `Bailer`, `Hydrasleeve`, `Snap sampler`, `Tubing`, `Water level meter`, `Wetted tape`
   - `CharacteristicName`: `Water level elevation`, `Water level in well, depth from a reference point`
+- **`EventID` field** — optional free-text identifier (max 255 characters) for grouping observations by field sampling event; available for all data types. No conditional logic or validation checks beyond the standard single-line string pattern.
 
 ### Breaking
 

schemas/data/src/backend.json

@@ -128,6 +128,10 @@
           "$ref": "./definitions.json#/definitions/WellOpenIntervalBottomUnitLoose",
           "transform": ["trim", "toEnumCase"]
         },
+        "EventID": {
+          "$ref": "./definitions.json#/definitions/EventID",
+          "transform": ["trim"]
+        },
         "ActivityType": {
           "$ref": "./definitions.json#/definitions/ActivityTypeLoose",
           "transform": ["trim", "toEnumCase"]

schemas/data/src/definitions.json

@@ -181,6 +181,12 @@
     "WellOpenIntervalBottomUnitLoose": {
       "$ref": "https://datastream.org/schema/data/values/WellOpenIntervalBottomUnit.legacy.json"
     },
+    "EventID": {
+      "title": "Event ID",
+      "description": "A unique identifier supplied by the data contributor, usually corresponding to field sampling events",
+      "$ref": "#/definitions/string",
+      "maxLength": 255
+    },
     "ActivityTypeStrict": {
       "$ref": "https://datastream.org/schema/data/values/ActivityType.primary.json"
     },

schemas/data/src/extract.json

@@ -106,6 +106,9 @@
         "WellOpenIntervalBottomUnit": {
           "$ref": "./definitions.json#/definitions/WellOpenIntervalBottomUnitStrict"
         },
+        "EventID": {
+          "$ref": "./definitions.json#/definitions/EventID"
+        },
         "ActivityType": {
           "$ref": "./definitions.json#/definitions/ActivityTypeStrict"
         },

schemas/data/src/frontend.json

@@ -124,6 +124,9 @@
           "$ref": "./definitions.json#/definitions/WellOpenIntervalBottomUnitStrict",
           "transform": ["trim", "toEnumCase"]
         },
+        "EventID": {
+          "$ref": "./definitions.json#/definitions/EventID"
+        },
         "ActivityType": {
           "$ref": "./definitions.json#/definitions/ActivityTypeStrict",
           "transform": ["trim", "toEnumCase"]

schemas/data/src/primary.json

@@ -101,6 +101,9 @@
         "WellOpenIntervalBottomUnit": {
           "$ref": "./definitions.json#/definitions/WellOpenIntervalBottomUnitStrict"
         },
+        "EventID": {
+          "$ref": "./definitions.json#/definitions/EventID"
+        },
         "ActivityType": {
           "$ref": "./definitions.json#/definitions/ActivityTypeStrict"
         },

schemas/data/src/quality-control.json

@@ -42,6 +42,7 @@
         "WellOpenIntervalTopUnit": true,
         "WellOpenIntervalBottomMeasure": true,
         "WellOpenIntervalBottomUnit": true,
+        "EventID": true,
         "ActivityType": true,
         "ActivityMediaName": true,
         "ActivityStartDate": true,

schemas/data/test/format.js

@@ -85,6 +85,8 @@ test("Should reject strings with multiline", async (t) => {
     1234`,
     LaboratorySampleID: `qwertyuiopasdfghjklzxcvbnmQWERTYUIOPASDFGHJKLZXCVBNM:/.,-'\"
     1234`,
+    EventID: `qwertyuiopasdfghjklzxcvbnmQWERTYUIOPASDFGHJKLZXCVBNM:/.,-'\"
+    1234`,
   });
 
   assert.equal(checkProperty(validate.errors, "pattern", "DatasetName"), true);
@@ -112,6 +114,7 @@ test("Should reject strings with multiline", async (t) => {
     checkProperty(validate.errors, "pattern", "LaboratorySampleID"),
     true,
   );
+  assert.equal(checkProperty(validate.errors, "pattern", "EventID"), true);
 });
 
 test("Should accept strings-multiline", async (t) => {
@@ -675,3 +678,12 @@ test("Should accept SampleCollectionMethodID <= 50 chars", async (t) => {
   validate({ SampleCollectionMethodID: "x".repeat(50) });
   assert.equal(checkProperty(validate.errors, "maxLength", "SampleCollectionMethodID"), false);
 });
+
+test("Should reject EventID > 255 chars", async (t) => {
+  validate({ EventID: "x".repeat(256) });
+  assert.equal(checkProperty(validate.errors, "maxLength", "EventID"), true);
+});
+test("Should accept EventID <= 255 chars", async (t) => {
+  validate({ EventID: "x".repeat(255) });
+  assert.equal(checkProperty(validate.errors, "maxLength", "EventID"), false);
+});

schemas/data/test/primary.js

@@ -139,6 +139,12 @@ test("LaboratorySampleID has maxLength 60", () => {
   assert.equal(main.properties.LaboratorySampleID.maxLength, 60);
 });
 
+test("EventID is text with maxLength 255", () => {
+  const f = main.properties.EventID;
+  assert.equal(f.type, "string");
+  assert.equal(f.maxLength, 255);
+});
+
 test("ResultComment has maxLength 4000", () => {
   assert.equal(main.properties.ResultComment.maxLength, 4000);
 });

schemas/data/test/required.js

@@ -159,6 +159,18 @@ test("Should reject additional headers", async (t) => {
   );
 });
 
+test("Should treat EventID as an optional, unconditional field", async (t) => {
+  validate({ EventID: "Spring 2018 survey" });
+  // Recognized column — not rejected as an unknown/additional header.
+  assert.equal(
+    checkProperty(validate.errors, "unevaluatedProperties", "EventID"),
+    false,
+  );
+  // Imposes no requirement of its own — never reported as required or as a dependency.
+  assert.equal(checkProperty(validate.errors, "required", "EventID"), false);
+  assert.equal(checkProperty(validate.errors, "dependencies", "EventID"), false);
+});
+
 test("Should reject ActivityDepthHeightMeasure AND NOT ActivityDepthHeightUnit", async (t) => {
   const valid = validate({
     ActivityDepthHeightMeasure: true,