@welldot/core 0.2.2 → 0.3.0

package/LICENSE

@@ -1,3 +1,4 @@
+
                                  Apache License
                            Version 2.0, January 2004
                         http://www.apache.org/licenses/
@@ -32,9 +33,10 @@
       not limited to compiled object code, generated documentation,
       and conversions to other media types.
 
-      "Work" shall mean the work of authorship made available under
-      the License, as indicated by a copyright notice that is included in
-      or attached to the work (an example is provided in the Appendix below).
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
 
       "Derivative Works" shall mean any work, whether in Source or Object
       form, that is based on (or derived from) the Work and for which the
@@ -44,21 +46,23 @@
       separable from, or merely link (or bind by name) to the interfaces of,
       the Work and Derivative Works thereof.
 
-      "Contribution" shall mean, as submitted to the Licensor for inclusion
-      in the Work by the copyright owner or by an individual or Legal Entity
-      authorized to submit on behalf of the copyright owner. For the purposes
-      of this definition, "submitted" means any form of electronic, verbal,
-      or written communication sent to the Licensor or its representatives,
-      including but not limited to communication on electronic mailing lists,
-      source code control systems, and issue tracking systems that are managed
-      by, or on behalf of, the Licensor for the purpose of discussing and
-      improving the Work, but excluding communication that is conspicuously
-      marked or otherwise designated in writing by the copyright owner as
-      "Not a Contribution."
-
-      "Contributor" shall mean Licensor and any Legal Entity on behalf of
-      whom a Contribution has been received by the Licensor and incorporated
-      within the Work.
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
 
    2. Grant of Copyright License. Subject to the terms and conditions of
       this License, each Contributor hereby grants to You a perpetual,
@@ -74,22 +78,22 @@
       use, offer to sell, sell, import, and otherwise transfer the Work,
       where such license applies only to those patent claims licensable
       by such Contributor that are necessarily infringed by their
-      Contribution(s) alone or by the combination of their Contribution(s)
+      Contribution(s) alone or by combination of their Contribution(s)
       with the Work to which such Contribution(s) was submitted. If You
-      institute patent litigation against any entity (including a cross-claim
-      or counterclaim in a lawsuit) alleging that the Work or any
-      Contribution embodied within the Work constitutes direct or contributory
-      patent infringement, then any patent licenses granted to You under
-      this License for that Work shall terminate as of the date such
-      litigation is filed.
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
 
    4. Redistribution. You may reproduce and distribute copies of the
       Work or Derivative Works thereof in any medium, with or without
       modifications, and in Source or Object form, provided that You
       meet the following conditions:
 
-      (a) You must give any other recipients of the Work or Derivative
-          Works a copy of this License; and
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
 
       (b) You must cause any modified files to carry prominent notices
           stating that You changed the files; and
@@ -101,24 +105,28 @@
           the Derivative Works; and
 
       (d) If the Work includes a "NOTICE" text file as part of its
-          distribution, You must include a readable copy of the
-          attribution notices contained within such NOTICE file, in
-          at least one of the following places: within a NOTICE text
-          file distributed as part of the Derivative Works; within
-          the Source form or documentation, if provided along with the
-          Derivative Works; or, within a display generated by the
-          Derivative Works, if and wherever such third-party notices
-          normally appear. The contents of the NOTICE file are for
-          informational purposes only and do not modify the License.
-          You may add Your own attribution notices within Derivative
-          Works that You distribute, alongside or as an addendum to
-          the NOTICE text from the Work, provided that such additional
-          attribution notices cannot be construed as modifying the License.
-
-      You may add Your own license statement for Your modifications and
-      may provide additional grant of rights to use, copy, modify, merge,
-      publish, distribute, sublicense, and/or sell copies of the Work,
-      provided such statement does not conflict with the terms of this License.
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
 
    5. Submission of Contributions. Unless You explicitly state otherwise,
       any Contribution intentionally submitted for inclusion in the Work
@@ -140,7 +148,7 @@
       implied, including, without limitation, any warranties or conditions
       of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
       PARTICULAR PURPOSE. You are solely responsible for determining the
-      appropriateness of using or reproducing the Work and assume any
+      appropriateness of using or redistributing the Work and assume any
       risks associated with Your exercise of permissions under this License.
 
    8. Limitation of Liability. In no event and under no legal theory,
@@ -148,23 +156,38 @@
       unless required by applicable law (such as deliberate and grossly
       negligent acts) or agreed to in writing, shall any Contributor be
       liable to You for damages, including any direct, indirect, special,
-      incidental, or exemplary damages of any character arising as a
+      incidental, or consequential damages of any character arising as a
       result of this License or out of the use or inability to use the
       Work (including but not limited to damages for loss of goodwill,
-      work stoppage, computer failure or malfunction, or all other
-      commercial damages or losses), even if such Contributor has been
-      advised of the possibility of such damages.
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
 
    9. Accepting Warranty or Additional Liability. While redistributing
       the Work or Derivative Works thereof, You may choose to offer,
       and charge a fee for, acceptance of support, warranty, indemnity,
       or other liability obligations and/or rights consistent with this
-      License. However, in accepting such obligations, You may offer only
-      conditions consistent with this License.
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
 
    END OF TERMS AND CONDITIONS
 
-   Copyright (c) 2024 Rafael Neto
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2024 Rafael Neto
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

package/README.md

@@ -10,16 +10,16 @@ TypeScript types, Zod validators, and serialization utilities for the `.well` op
 
 `.well` is an open file format for encoding the complete record of a water well as a single, self-describing JSON document. A `.well` file contains:
 
-- **Constructive data** — borehole geometry, casing strings, screens, reducers, gravel packs, and cement pads
+- **Constructive data** — borehole geometry, casing strings, screens, reducers, gravel packs, centralizers, and cement pads
 - **Geologic data** — lithological column, discrete fractures, and cave zones
-- **Administrative metadata** — well identity, authority-scoped IDs (`well_id`), driller, construction date, and geographic coordinates with explicit CRS
+- **Administrative metadata** — well identity, construction type and purpose (`well_type`, `well_purpose`), authority-scoped IDs (`well_id`), driller, construction date, and geographic coordinates with explicit CRS
 - **Hydrodynamic events** — append-only ledger of static level readings, pumping tests (constant-rate, step-drawdown, airlift), and recovery phases
 - **Aquifer analysis** — interpreted parameter sets: transmissivity, specific capacity, storativity, and Jacob loss coefficients
 - **Operational history** — timestamped log of maintenance, inspections, and incidents with HTTPS attachment references
 
 The format is designed for three use cases: visualization of technical well profiles, registration with regulatory bodies, and hydrogeological research.
 
-See the [v2 format specification](./docs/spec/v2/overview.md) for the complete schema reference and design rationale. The [v1 spec](./docs/spec/v1/well-format.md) remains available for reference.
+See the [v2 format specification](./docs/spec/v2/overview.md) (current revision: v2.1) for the complete schema reference and design rationale. The [v1 spec](./docs/spec/v1/well-format.md) remains available for reference.
 
 ## Installation
 
@@ -80,6 +80,7 @@ All types are exported as TypeScript type-only exports (zero runtime cost).
 | `SurfaceCase`           | Protective casing near the surface                                              |
 | `HoleFill`              | Annular fill material (`gravel_pack` or `seal`)                                 |
 | `CementPad`             | Concrete wellhead pad dimensions                                                |
+| `Centralizer`           | Casing/screen centralizers over a depth interval with spacing (v2.1)            |
 | `Lithology`             | Geological description of a depth interval                                      |
 | `Texture`               | `{ code: string \| number; vocabulary?: string }` — lithology texture reference |
 | `Fracture`              | A discrete fracture or fracture zone                                            |
@@ -123,6 +124,7 @@ Each schema validates its corresponding type at runtime. All schemas are Zod obj
 | `SurfaceCaseSchema`           | `SurfaceCase`                                                           |
 | `HoleFillSchema`              | `HoleFill`                                                              |
 | `CementPadSchema`             | `CementPad`                                                             |
+| `CentralizerSchema`           | `Centralizer`                                                           |
 | `LithologySchema`             | `Lithology`                                                             |
 | `TextureSchema`               | `Texture`                                                               |
 | `FractureSchema`              | `Fracture`                                                              |

package/dist/index.cjs

@@ -26,6 +26,7 @@ __export(index_exports, {
   BoreHoleSchema: () => BoreHoleSchema,
   CaveSchema: () => CaveSchema,
   CementPadSchema: () => CementPadSchema,
+  CentralizerSchema: () => CentralizerSchema,
   ConstantRateEventSchema: () => ConstantRateEventSchema,
   FGDC_TEXTURES_OPTIONS: () => FGDC_TEXTURES_OPTIONS,
   FractureSchema: () => FractureSchema,
@@ -147,6 +148,14 @@ var SurfaceCaseSchema = import_zod.z.object({
   to: import_zod.z.number(),
   diameter: import_zod.z.number()
 });
+var CentralizerSchema = import_zod.z.object({
+  from: import_zod.z.number(),
+  to: import_zod.z.number(),
+  spacing: import_zod.z.number().positive().optional(),
+  type: import_zod.z.string(),
+  diameter: import_zod.z.number().optional(),
+  description: import_zod.z.string().optional()
+});
 var CementPadSchema = import_zod.z.object({
   type: import_zod.z.string(),
   width: import_zod.z.number(),
@@ -300,6 +309,7 @@ var WellSchema = import_zod.z.object({
     })
   ).optional(),
   well_type: import_zod.z.string().optional(),
+  well_purpose: import_zod.z.array(import_zod.z.string()).optional(),
   name: import_zod.z.string().optional(),
   well_driller: import_zod.z.string().optional(),
   construction_date: import_zod.z.string().regex(/^\d{4}-\d{2}-\d{2}$/, "construction_date must be YYYY-MM-DD").optional(),
@@ -314,6 +324,7 @@ var WellSchema = import_zod.z.object({
   well_screen: import_zod.z.array(WellScreenSchema),
   surface_case: import_zod.z.array(SurfaceCaseSchema),
   hole_fill: import_zod.z.array(HoleFillSchema),
+  centralizers: import_zod.z.array(CentralizerSchema).optional(),
   cement_pad: CementPadSchema.optional(),
   lithology: import_zod.z.array(LithologySchema),
   fractures: import_zod.z.array(FractureSchema),
@@ -526,6 +537,9 @@ function decodeV2Well(raw) {
       profiles: raw.profiles
     },
     ...raw.well_type !== void 0 && { well_type: raw.well_type },
+    ...raw.well_purpose !== void 0 && {
+      well_purpose: raw.well_purpose
+    },
     ...raw.name !== void 0 && { name: raw.name },
     ...raw.well_driller !== void 0 && {
       well_driller: raw.well_driller
@@ -543,6 +557,9 @@ function decodeV2Well(raw) {
     well_screen: normalizeWellScreens(rawScreens),
     surface_case: raw.surface_case ?? [],
     hole_fill: raw.hole_fill ?? [],
+    ...raw.centralizers !== void 0 && {
+      centralizers: raw.centralizers
+    },
     ...raw.cement_pad ? { cement_pad: raw.cement_pad } : {},
     lithology: normalizeLithology(raw.lithology ?? []),
     fractures: raw.fractures ?? [],
@@ -604,6 +621,9 @@ function serializeWell(well) {
     ...well.location !== void 0 && { location: well.location },
     ...well.profiles !== void 0 && { profiles: well.profiles },
     ...well.well_type !== void 0 && { well_type: well.well_type },
+    ...well.well_purpose !== void 0 && {
+      well_purpose: well.well_purpose
+    },
     ...well.name !== void 0 && { name: well.name },
     ...well.well_driller !== void 0 && { well_driller: well.well_driller },
     ...well.construction_date !== void 0 && {
@@ -617,6 +637,9 @@ function serializeWell(well) {
     well_screen: well.well_screen,
     surface_case: well.surface_case,
     hole_fill: well.hole_fill,
+    ...well.centralizers !== void 0 && {
+      centralizers: well.centralizers
+    },
     ...well.cement_pad && { cement_pad: well.cement_pad },
     lithology: well.lithology,
     fractures: well.fractures,
@@ -643,6 +666,7 @@ function redactWell(well, visibility) {
     delete redacted.well_id;
     delete redacted.location;
     delete redacted.well_type;
+    delete redacted.well_purpose;
     delete redacted.name;
     delete redacted.well_driller;
     delete redacted.construction_date;
@@ -658,6 +682,7 @@ function redactWell(well, visibility) {
     redacted.well_screen = [];
     redacted.surface_case = [];
     redacted.hole_fill = [];
+    delete redacted.centralizers;
     delete redacted.cement_pad;
     delete redacted.well_depth;
   }
@@ -1104,6 +1129,7 @@ function hoursToMinutes(h) {
   BoreHoleSchema,
   CaveSchema,
   CementPadSchema,
+  CentralizerSchema,
   ConstantRateEventSchema,
   FGDC_TEXTURES_OPTIONS,
   FractureSchema,