@welldot/core 0.4.0 → 0.5.0

package/docs/reference/fgdc-textures.md

@@ -1,5 +1,7 @@
 # FGDC Texture Patterns Reference
 
+## Overview
+
 This document lists all texture patterns available in `FGDC_TEXTURES_OPTIONS` from `@welldot/core`. These codes follow the **FGDC (Federal Geographic Data Committee)** digital cartographic standard for geologic map symbolization.
 
 Use a `code` value in the `texture` field of a `Lithology` record to assign a pattern to a depth interval.
@@ -19,6 +21,19 @@ const available = FGDC_TEXTURES_OPTIONS.filter(t => !t.pending);
 >
 > Currently **120 of 282 textures** are available: all of Series 600 (84) and Series 700 (33), plus codes 120, 123, and 132 from Series 100.
 
+The patterns are grouped by FGDC series below. Each table lists the code and label of every pattern, and the summary at the end gives the available and pending counts per series.
+
+## Table of contents
+
+- [Series 100 — Surficial Patterns](#series-100--surficial-patterns)
+- [Series 200 — Sedimentary Patterns](#series-200--sedimentary-patterns)
+- [Series 300 — Igneous Patterns](#series-300--igneous-patterns)
+- [Series 400 — Miscellaneous and Metamorphic Patterns](#series-400--miscellaneous-and-metamorphic-patterns)
+- [Series 500 — Glacial and Periglacial Patterns](#series-500--glacial-and-periglacial-patterns)
+- [Series 600 — Sedimentary Lithology Patterns](#series-600--sedimentary-lithology-patterns)
+- [Series 700 — Metamorphic and Igneous Lithology Patterns](#series-700--metamorphic-and-igneous-lithology-patterns)
+- [Summary](#summary)
+
 ---
 
 ## Series 100 — Surficial Patterns

package/docs/schema/v2/well.schema.json

@@ -6,7 +6,16 @@
   "type": "object",
   "properties": {
     "version": {
-      "type": "integer"
+      "anyOf": [
+        {
+          "type": "integer",
+          "minimum": 0
+        },
+        {
+          "type": "string",
+          "pattern": "^\\d+\\.\\d+$"
+        }
+      ]
     },
     "@context": {
       "anyOf": [
@@ -77,6 +86,9 @@
             },
             "original_crs": {
               "type": "string"
+            },
+            "timezone": {
+              "type": "string"
             }
           },
           "additionalProperties": false
@@ -583,6 +595,10 @@
                               "elapsed": {
                                 "type": "number"
                               },
+                              "datetime": {
+                                "type": "string",
+                                "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[+-]\\d{2}:\\d{2})$"
+                              },
                               "depth": {
                                 "type": "number"
                               },
@@ -605,8 +621,7 @@
                         "rate"
                       ],
                       "additionalProperties": false
-                    },
-                    "maxItems": 1
+                    }
                   },
                   "recovery": {
                     "type": "object",
@@ -671,8 +686,6 @@
                   },
                   "steps": {
                     "type": "array",
-                    "minItems": 1,
-                    "maxItems": 1,
                     "items": {
                       "$ref": "#/properties/hydrodynamic_events/items/anyOf/0/anyOf/0/properties/steps/items"
                     }
@@ -840,6 +853,114 @@
                   "recovery"
                 ],
                 "additionalProperties": false
+              },
+              {
+                "type": "object",
+                "properties": {
+                  "id": {
+                    "$ref": "#/properties/hydrodynamic_events/items/anyOf/0/anyOf/0/properties/id"
+                  },
+                  "type": {
+                    "type": "string",
+                    "const": "logger_series"
+                  },
+                  "datetime": {
+                    "$ref": "#/properties/hydrodynamic_events/items/anyOf/0/anyOf/0/properties/datetime"
+                  },
+                  "sequence": {
+                    "$ref": "#/properties/hydrodynamic_events/items/anyOf/0/anyOf/0/properties/sequence"
+                  },
+                  "operator": {
+                    "$ref": "#/properties/hydrodynamic_events/items/anyOf/0/anyOf/0/properties/operator"
+                  },
+                  "equipment": {
+                    "$ref": "#/properties/hydrodynamic_events/items/anyOf/0/anyOf/0/properties/equipment"
+                  },
+                  "notes": {
+                    "$ref": "#/properties/hydrodynamic_events/items/anyOf/0/anyOf/0/properties/notes"
+                  },
+                  "corrects": {
+                    "$ref": "#/properties/hydrodynamic_events/items/anyOf/0/anyOf/0/properties/corrects"
+                  },
+                  "attachments": {
+                    "$ref": "#/properties/hydrodynamic_events/items/anyOf/0/anyOf/0/properties/attachments"
+                  },
+                  "measurement_method": {
+                    "type": "string"
+                  },
+                  "sensor_depth": {
+                    "type": "number"
+                  },
+                  "interval": {
+                    "type": "number",
+                    "exclusiveMinimum": 0
+                  },
+                  "barometric_compensation": {
+                    "type": "string",
+                    "enum": [
+                      "barologger",
+                      "vented",
+                      "none"
+                    ]
+                  },
+                  "aggregation": {
+                    "type": "string",
+                    "enum": [
+                      "none",
+                      "hourly",
+                      "daily"
+                    ]
+                  },
+                  "readings": {
+                    "type": "array",
+                    "items": {
+                      "type": "object",
+                      "properties": {
+                        "datetime": {
+                          "type": "string",
+                          "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[+-]\\d{2}:\\d{2})$"
+                        },
+                        "elapsed": {
+                          "not": {}
+                        },
+                        "depth": {
+                          "type": "number"
+                        },
+                        "depth_precision": {
+                          "type": "number"
+                        },
+                        "pressure": {
+                          "type": "number"
+                        },
+                        "depth_min": {
+                          "type": "number"
+                        },
+                        "depth_max": {
+                          "type": "number"
+                        }
+                      },
+                      "required": [
+                        "datetime",
+                        "depth"
+                      ],
+                      "additionalProperties": false
+                    },
+                    "minItems": 1
+                  },
+                  "steps": {
+                    "not": {}
+                  },
+                  "recovery": {
+                    "not": {}
+                  }
+                },
+                "required": [
+                  "id",
+                  "type",
+                  "datetime",
+                  "readings"
+                ],
+                "additionalProperties": false
               }
             ]
           },
@@ -945,10 +1066,7 @@
             "type": "number"
           },
           "storativity": {
-            "type": [
-              "number",
-              "null"
-            ]
+            "type": "number"
           },
           "hydraulic_conductivity": {
             "type": "number"
@@ -1658,8 +1776,7 @@
           },
           "daily_operating_time": {
             "type": "number",
-            "minimum": 0,
-            "maximum": 24
+            "minimum": 0
           },
           "days_per_week": {
             "type": "integer",

package/docs/spec/v1/well-format.md

@@ -5,6 +5,32 @@
 **Encoding:** UTF-8
 **Base format:** JSON
 
+## Overview
+
+This is the specification of version 1 of the `.well` format: one JSON file that holds the static record of one water well, its identity, construction (borehole, casing, screens, fills, cement pad) and geology (lithology, fractures, caves). v1 is stable and kept for reference. New files use version 2, described in [../v2/overview.md](../v2/overview.md); `deserializeWell()` in `@welldot/core` reads v1 files and normalizes them to v2.
+
+## Table of contents
+
+- [Purpose](#purpose)
+- [Design Principles](#design-principles)
+- [File Structure](#file-structure)
+- [Top-level Fields](#top-level-fields)
+  - [`well_type` — Recommended values](#well_type--recommended-values)
+- [Object Schemas](#object-schemas)
+  - [`BoreHole` — `bore_hole[]`](#borehole--bore_hole)
+  - [`WellCase` — `well_case[]`](#wellcase--well_case)
+  - [`Reduction` — `reduction[]`](#reduction--reduction)
+  - [`WellScreen` — `well_screen[]`](#wellscreen--well_screen)
+  - [`SurfaceCase` — `surface_case[]`](#surfacecase--surface_case)
+  - [`HoleFill` — `hole_fill[]`](#holefill--hole_fill)
+  - [`CementPad` — `cement_pad`](#cementpad--cement_pad)
+  - [`Lithology` — `lithology[]`](#lithology--lithology)
+  - [`Fracture` — `fractures[]`](#fracture--fractures)
+  - [`Cave` — `caves[]`](#cave--caves)
+- [Complete Example](#complete-example)
+- [Versioning](#versioning)
+- [MIME Type](#mime-type)
+
 ---
 
 ## Purpose