@tracepass/dpp-schemas 0.1.0 → 0.2.0

package/README.md

@@ -10,7 +10,7 @@
 
 [![License](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](./LICENSE)
 [![npm](https://img.shields.io/npm/v/@tracepass/dpp-schemas.svg)](https://www.npmjs.com/package/@tracepass/dpp-schemas)
-[![Fields](https://img.shields.io/badge/fields-913-informational)](#whats-in-here)
+[![Fields](https://img.shields.io/badge/fields-935-informational)](#whats-in-here)
 [![Categories](https://img.shields.io/badge/categories-12-informational)](#whats-in-here)
 [![Dependencies](https://img.shields.io/badge/dependencies-none-success)](#no-build-step)
 [![Schema](https://img.shields.io/badge/JSON%20Schema-2020--12-orange)](./schema.json)
@@ -39,12 +39,12 @@ this repository contains.
 
 ## What's in here
 
-Twelve JSON files, one per product category. **913 fields in total. 343 are required by an instrument in force;
-187 are anticipated under a rule that has not yet been adopted.**
+Twelve JSON files, one per product category. **935 fields in total. 307 are required by an instrument in force;
+198 are anticipated under a rule that has not yet been adopted.**
 
 | Category | Fields | Required | Instrument |
 |---|---:|---:|---|
-| `battery` | 95 | 95 | Regulation (EU) 2023/1542 |
+| `battery` | 117 | 59 | Regulation (EU) 2023/1542 |
 | `chemicals` | 96 | 28 | ESPR (EU) 2024/1781 |
 | `construction` | 49 | 43 | CPR (EU) 2024/3110 |
 | `electronics` | 167 | 20 | ESPR (EU) 2024/1781 |
@@ -66,6 +66,16 @@ flows through a delegated act adopted under its Article 4. No product-group dele
 has been adopted. Fields expected under a future act carry `validation.anticipated`
 rather than `required`, with the CELEX of the instrument expected to impose them.
 
+**An obligation does not always apply uniformly across a category.** Where the governing
+instrument distinguishes sub-categories, the field carries `validation.requiredBy` — a map
+from sub-category to `required`, `conditional`, or `notApplicable`. Battery uses the
+Regulation (EU) 2023/1542 split (`EV`, `LMT`, `industrial_gt_2kwh`): everything applies to
+EV batteries, LMT is exempt from the capacity-threshold-for-exhaustion field, and industrial
+batteries are largely conditional on gates such as having a battery management system or
+containing Annex X materials. `conditional` means the instrument compels the field only when
+its stated gate is met — so a passport legitimately leaves it empty otherwise. Fields with no
+`requiredBy` apply to the whole category.
+
 ## What a field looks like
 
 ```jsonc

package/index.json

@@ -7,22 +7,23 @@
   },
   "totals": {
     "categories": 12,
-    "fields": 913,
-    "requiredFields": 343,
-    "anticipatedFields": 187
+    "fields": 935,
+    "requiredFields": 307,
+    "anticipatedFields": 198
   },
   "categories": [
     {
       "category": "battery",
       "label": "Battery",
       "file": "templates/battery.json",
-      "version": 2,
-      "fieldCount": 95,
-      "requiredFieldCount": 95,
-      "anticipatedFieldCount": 0,
+      "version": 3,
+      "fieldCount": 117,
+      "requiredFieldCount": 59,
+      "anticipatedFieldCount": 11,
       "regulation": {
         "name": "EU Battery Regulation",
         "number": "(EU) 2023/1542",
+        "effectiveDate": "2027-02-18",
         "mandatoryDate": "2027-02-18"
       }
     },
@@ -37,6 +38,7 @@
       "regulation": {
         "name": "EU ESPR - Chemicals",
         "number": "(EU) 2024/1781",
+        "effectiveDate": "2029-09-01",
         "mandatoryDate": "2029-09-01"
       }
     },
@@ -51,6 +53,7 @@
       "regulation": {
         "name": "Construction Products Regulation",
         "number": "(EU) 2024/3110",
+        "effectiveDate": "2029-01-01",
         "mandatoryDate": "2029-01-01"
       }
     },
@@ -65,6 +68,7 @@
       "regulation": {
         "name": "EU ESPR - Electronics",
         "number": "(EU) 2024/1781",
+        "effectiveDate": "2028-01-01",
         "mandatoryDate": "2029-01-01"
       }
     },
@@ -79,6 +83,7 @@
       "regulation": {
         "name": "EU ESPR - FMCG",
         "number": "(EU) 2024/1781",
+        "effectiveDate": "2028-01-01",
         "mandatoryDate": "2030-01-01"
       }
     },
@@ -93,6 +98,7 @@
       "regulation": {
         "name": "EU ESPR - Furniture",
         "number": "(EU) 2024/1781",
+        "effectiveDate": "2029-01-01",
         "mandatoryDate": "2030-01-01"
       }
     },
@@ -107,6 +113,7 @@
       "regulation": {
         "name": "EU ESPR - Jewelry",
         "number": "(EU) 2024/1781",
+        "effectiveDate": "2030-01-01",
         "mandatoryDate": "2030-01-01"
       }
     },
@@ -121,6 +128,7 @@
       "regulation": {
         "name": "Packaging and Packaging Waste Regulation",
         "number": "(EU) 2025/40",
+        "effectiveDate": "2027-01-01",
         "mandatoryDate": "2030-01-01"
       }
     },
@@ -135,6 +143,7 @@
       "regulation": {
         "name": "EU ESPR - Iron, Steel & Aluminium",
         "number": "(EU) 2024/1781",
+        "effectiveDate": "2027-01-01",
         "mandatoryDate": "2028-01-01"
       }
     },
@@ -149,6 +158,7 @@
       "regulation": {
         "name": "EU ESPR - Textiles",
         "number": "(EU) 2024/1781",
+        "effectiveDate": "2028-01-01",
         "mandatoryDate": "2029-01-01"
       }
     },
@@ -163,6 +173,7 @@
       "regulation": {
         "name": "EU ESPR - Toys",
         "number": "(EU) 2024/1781",
+        "effectiveDate": "2030-01-01",
         "mandatoryDate": "2030-01-01"
       }
     },
@@ -177,6 +188,7 @@
       "regulation": {
         "name": "EU ESPR - Tyres",
         "number": "(EU) 2024/1781",
+        "effectiveDate": "2028-01-01",
         "mandatoryDate": "2029-01-01"
       }
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tracepass/dpp-schemas",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Machine-readable field specifications for EU Digital Product Passports (ESPR) — 12 product categories, 913 fields, each traced to the article of EU law that mandates it. Pure JSON, no dependencies.",
   "keywords": [
     "digital-product-passport",
@@ -38,9 +38,13 @@
   ],
   "sideEffects": false,
   "publishConfig": {
-    "access": "public"
+    "access": "public",
+    "provenance": true
   },
   "scripts": {
-    "validate": "python3 -c \"import json,glob;from jsonschema import Draft202012Validator as V;v=V(json.load(open('schema.json')));[print(('ok  ' if not list(v.iter_errors(json.load(open(p)))) else 'FAIL'),p) for p in sorted(glob.glob('templates/*.json'))]\""
+    "validate": "python3 -c \"import json,glob,sys;from jsonschema import Draft202012Validator as V;v=V(json.load(open('schema.json')));bad=0\nfor p in sorted(glob.glob('templates/*.json')):\n    e=list(v.iter_errors(json.load(open(p))));bad+=bool(e);print(('FAIL' if e else 'ok  '),p)\n    [print('     ',str(x.absolute_path),x.message[:120]) for x in e[:3]]\nsys.exit(1 if bad else 0)\"",
+    "build:index": "node scripts/build-index.mjs",
+    "check:index": "node scripts/build-index.mjs --check",
+    "check": "npm run validate && npm run check:index"
   }
 }

package/schema.json

@@ -395,6 +395,19 @@
             "anticipatedNote": {
               "type": "string",
               "description": "Why it is expected — e.g. \"ESPR Annex I(p), pending a delegated act under Art. 4\"."
+            },
+            "requiredBy": {
+              "type": "object",
+              "description": "Per-sub-category applicability, where one obligation does not apply uniformly across a category. Present only on fields whose governing instrument distinguishes sub-categories; absent means `required`/`anticipated` applies to the whole category. Battery uses the Regulation (EU) 2023/1542 split: EV batteries, light means of transport (LMT), and industrial batteries over 2 kWh.",
+              "additionalProperties": {
+                "type": "string",
+                "enum": [
+                  "required",
+                  "conditional",
+                  "notApplicable"
+                ],
+                "description": "`required` — the instrument compels it for this sub-category. `conditional` — compelled only when a stated gate is met (e.g. the battery has a BMS, is rechargeable, or contains Annex X materials). `notApplicable` — the provision does not reach this sub-category."
+              }
             }
           }
         },