@tiangong-lca/pcr 0.3.1 → 0.4.0

package/packages/pcr-core/schemas/structured-projection.schema.json

@@ -24,21 +24,35 @@
     "projection_metadata"
   ],
   "$defs": {
-    "nonEmptyString": { "type": "string", "minLength": 1 },
+    "nonEmptyString": {
+      "type": "string",
+      "minLength": 1
+    },
     "normativeRule": {
       "type": "object",
-      "required": ["rule_id", "applies_to", "rule", "source_ids"],
+      "required": [
+        "rule_id",
+        "applies_to",
+        "rule",
+        "source_ids"
+      ],
       "properties": {
         "rule_id": {
           "type": "string",
           "minLength": 1,
           "pattern": "^[a-z0-9]+(?:_[a-z0-9]+)*$"
         },
-        "applies_to": { "$ref": "#/$defs/nonEmptyString" },
-        "rule": { "$ref": "#/$defs/nonEmptyString" },
+        "applies_to": {
+          "$ref": "#/$defs/nonEmptyString"
+        },
+        "rule": {
+          "$ref": "#/$defs/nonEmptyString"
+        },
         "source_ids": {
           "type": "array",
-          "items": { "$ref": "#/$defs/nonEmptyString" },
+          "items": {
+            "$ref": "#/$defs/nonEmptyString"
+          },
           "uniqueItems": true
         }
       },
@@ -46,22 +60,50 @@
     },
     "normativeRuleArray": {
       "type": "array",
-      "items": { "$ref": "#/$defs/normativeRule" }
+      "items": {
+        "$ref": "#/$defs/normativeRule"
+      }
     },
     "projectionMetadata": {
       "type": "object",
-      "required": ["contract_version", "generator", "canonical_markdown", "generated_content_sha256"],
+      "required": [
+        "contract_version",
+        "generator",
+        "canonical_markdown",
+        "generated_content_sha256"
+      ],
       "properties": {
-        "contract_version": { "const": "1" },
-        "generator": { "const": "tiangong-pcr-builder/markdown-projection" },
+        "contract_version": {
+          "enum": [
+            "1",
+            "2"
+          ]
+        },
+        "generator": {
+          "const": "tiangong-pcr-builder/markdown-projection"
+        },
         "canonical_markdown": {
           "type": "object",
-          "required": ["path", "normalization", "hash_algorithm", "sha256"],
+          "required": [
+            "path",
+            "normalization",
+            "hash_algorithm",
+            "sha256"
+          ],
           "properties": {
-            "path": { "const": "pcr.en-US.md" },
-            "normalization": { "const": "utf8-lf-v1" },
-            "hash_algorithm": { "const": "sha256" },
-            "sha256": { "type": "string", "pattern": "^sha256:[0-9a-f]{64}$" }
+            "path": {
+              "const": "pcr.en-US.md"
+            },
+            "normalization": {
+              "const": "utf8-lf-v1"
+            },
+            "hash_algorithm": {
+              "const": "sha256"
+            },
+            "sha256": {
+              "type": "string",
+              "pattern": "^sha256:[0-9a-f]{64}$"
+            }
           },
           "additionalProperties": false
         },
@@ -74,24 +116,45 @@
     },
     "processMapEntry": {
       "type": "object",
-      "required": ["id", "name", "inclusion", "inclusion_condition", "role", "quantitative_reference"],
+      "required": [
+        "id",
+        "name",
+        "inclusion",
+        "inclusion_condition",
+        "role",
+        "quantitative_reference"
+      ],
       "properties": {
-        "id": { "$ref": "#/$defs/nonEmptyString" },
-        "name": { "$ref": "#/$defs/nonEmptyString" },
+        "id": {
+          "$ref": "#/$defs/nonEmptyString"
+        },
+        "name": {
+          "$ref": "#/$defs/nonEmptyString"
+        },
         "inclusion": {
           "$ref": "https://tiangong-lca.org/schemas/pcr/v1/controlled-vocabulary.schema.json#/$defs/process_inclusion"
         },
-        "inclusion_condition": { "type": "string" },
-        "role": { "$ref": "#/$defs/nonEmptyString" },
-        "quantitative_reference": { "$ref": "#/$defs/nonEmptyString" }
+        "inclusion_condition": {
+          "type": "string"
+        },
+        "role": {
+          "$ref": "#/$defs/nonEmptyString"
+        },
+        "quantitative_reference": {
+          "$ref": "#/$defs/nonEmptyString"
+        }
       },
       "additionalProperties": false
     },
     "amountBasis": {
       "type": "object",
-      "required": ["kind"],
+      "required": [
+        "kind"
+      ],
       "properties": {
-        "text": { "type": "string" },
+        "text": {
+          "type": "string"
+        },
         "kind": {
           "$ref": "https://tiangong-lca.org/schemas/pcr/v1/controlled-vocabulary.schema.json#/$defs/basis_kind"
         }
@@ -100,15 +163,21 @@
     },
     "amountEvidence": {
       "type": "object",
-      "required": ["kind"],
+      "required": [
+        "kind"
+      ],
       "properties": {
         "kind": {
           "$ref": "https://tiangong-lca.org/schemas/pcr/v1/controlled-vocabulary.schema.json#/$defs/evidence_kind"
         },
-        "collection_protocol_id": { "type": "string" },
+        "collection_protocol_id": {
+          "type": "string"
+        },
         "source_ids": {
           "type": "array",
-          "items": { "type": "string" },
+          "items": {
+            "type": "string"
+          },
           "uniqueItems": true
         }
       },
@@ -116,15 +185,27 @@
     },
     "amountRange": {
       "type": "object",
-      "required": ["role", "basis_kind", "evidence_kind"],
+      "required": [
+        "role",
+        "basis_kind",
+        "evidence_kind"
+      ],
       "properties": {
         "role": {
           "$ref": "https://tiangong-lca.org/schemas/pcr/v1/controlled-vocabulary.schema.json#/$defs/amount_range_role"
         },
-        "lower": { "type": "string" },
-        "upper": { "type": "string" },
-        "unit": { "type": "string" },
-        "basis": { "type": "string" },
+        "lower": {
+          "type": "string"
+        },
+        "upper": {
+          "type": "string"
+        },
+        "unit": {
+          "type": "string"
+        },
+        "basis": {
+          "type": "string"
+        },
         "basis_kind": {
           "$ref": "https://tiangong-lca.org/schemas/pcr/v1/controlled-vocabulary.schema.json#/$defs/basis_kind"
         },
@@ -133,7 +214,9 @@
         },
         "source_ids": {
           "type": "array",
-          "items": { "type": "string" },
+          "items": {
+            "type": "string"
+          },
           "uniqueItems": true
         }
       },
@@ -141,20 +224,34 @@
     },
     "flowAmount": {
       "type": "object",
-      "required": ["value_mode", "specificity", "basis", "evidence", "ranges"],
+      "required": [
+        "value_mode",
+        "specificity",
+        "basis",
+        "evidence",
+        "ranges"
+      ],
       "properties": {
-        "expression": { "type": "string" },
+        "expression": {
+          "type": "string"
+        },
         "value_mode": {
           "$ref": "https://tiangong-lca.org/schemas/pcr/v1/controlled-vocabulary.schema.json#/$defs/amount_value_mode"
         },
         "specificity": {
           "$ref": "https://tiangong-lca.org/schemas/pcr/v1/controlled-vocabulary.schema.json#/$defs/amount_specificity"
         },
-        "basis": { "$ref": "#/$defs/amountBasis" },
-        "evidence": { "$ref": "#/$defs/amountEvidence" },
+        "basis": {
+          "$ref": "#/$defs/amountBasis"
+        },
+        "evidence": {
+          "$ref": "#/$defs/amountEvidence"
+        },
         "ranges": {
           "type": "array",
-          "items": { "$ref": "#/$defs/amountRange" }
+          "items": {
+            "$ref": "#/$defs/amountRange"
+          }
         }
       },
       "additionalProperties": false
@@ -171,99 +268,498 @@
         "amount"
       ],
       "properties": {
-        "row_id": { "type": "string" },
-        "role": { "type": "string" },
-        "name": { "type": "string" },
+        "row_id": {
+          "type": "string"
+        },
+        "role": {
+          "type": "string"
+        },
+        "name": {
+          "type": "string"
+        },
         "flow_type": {
           "$ref": "https://tiangong-lca.org/schemas/pcr/v1/controlled-vocabulary.schema.json#/$defs/flow_type"
         },
-        "flow_ref": { "type": "object" },
-        "property_unit": { "type": "string" },
-        "description": { "type": "string" },
-        "amount": { "$ref": "#/$defs/flowAmount" }
+        "flow_ref": {
+          "type": "object"
+        },
+        "property_unit": {
+          "type": "string"
+        },
+        "description": {
+          "type": "string"
+        },
+        "amount": {
+          "$ref": "#/$defs/flowAmount"
+        }
       },
       "additionalProperties": false
     },
     "flowGroups": {
       "type": "object",
-      "required": ["product", "waste", "elementary"],
+      "required": [
+        "product",
+        "waste",
+        "elementary"
+      ],
       "properties": {
-        "product": { "type": "array", "items": { "$ref": "#/$defs/flowRow" } },
-        "waste": { "type": "array", "items": { "$ref": "#/$defs/flowRow" } },
-        "elementary": { "type": "array", "items": { "$ref": "#/$defs/flowRow" } }
+        "product": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/flowRow"
+          }
+        },
+        "waste": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/flowRow"
+          }
+        },
+        "elementary": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/flowRow"
+          }
+        }
       },
       "additionalProperties": false
     },
     "processInventoryEntry": {
       "type": "object",
-      "required": ["id", "label", "inputs", "outputs"],
+      "required": [
+        "id",
+        "label",
+        "inputs",
+        "outputs"
+      ],
       "properties": {
-        "id": { "$ref": "#/$defs/nonEmptyString" },
-        "label": { "$ref": "#/$defs/nonEmptyString" },
-        "inputs": { "$ref": "#/$defs/flowGroups" },
-        "outputs": { "$ref": "#/$defs/flowGroups" }
+        "id": {
+          "$ref": "#/$defs/nonEmptyString"
+        },
+        "label": {
+          "$ref": "#/$defs/nonEmptyString"
+        },
+        "inputs": {
+          "$ref": "#/$defs/flowGroups"
+        },
+        "outputs": {
+          "$ref": "#/$defs/flowGroups"
+        }
       },
       "additionalProperties": false
     },
     "dataSource": {
       "type": "object",
-      "required": ["type"],
+      "required": [
+        "type"
+      ],
       "properties": {
-        "id": { "type": "string" },
+        "id": {
+          "type": "string"
+        },
         "type": {
           "$ref": "https://tiangong-lca.org/schemas/pcr/v1/controlled-vocabulary.schema.json#/$defs/source_type"
         },
-        "reference": { "type": "string" },
-        "used_for": { "type": "string" }
+        "reference": {
+          "type": "string"
+        },
+        "used_for": {
+          "type": "string"
+        }
+      },
+      "additionalProperties": false
+    },
+    "sourcePoint": {
+      "type": "object",
+      "required": [
+        "offset",
+        "line",
+        "column"
+      ],
+      "properties": {
+        "offset": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "line": {
+          "type": "integer",
+          "minimum": 1
+        },
+        "column": {
+          "type": "integer",
+          "minimum": 1
+        }
+      },
+      "additionalProperties": false,
+      "$comment": "Normalized source coordinates: zero-based UTF-16 offsets and one-based lines/columns. Source correspondence is checked at runtime."
+    },
+    "sourceSpan": {
+      "type": "object",
+      "required": [
+        "start",
+        "end"
+      ],
+      "properties": {
+        "start": {
+          "$ref": "#/$defs/sourcePoint"
+        },
+        "end": {
+          "$ref": "#/$defs/sourcePoint"
+        }
+      },
+      "additionalProperties": false,
+      "$comment": "Start is inclusive and end exclusive. Ordering and containment require runtime checks."
+    },
+    "sourceHeading": {
+      "type": "object",
+      "required": [
+        "kind",
+        "span",
+        "text",
+        "depth"
+      ],
+      "properties": {
+        "kind": {
+          "const": "heading"
+        },
+        "span": {
+          "$ref": "#/$defs/sourceSpan"
+        },
+        "text": {
+          "$ref": "#/$defs/nonEmptyString"
+        },
+        "depth": {
+          "type": "integer",
+          "minimum": 1,
+          "maximum": 6
+        }
+      },
+      "additionalProperties": false
+    },
+    "normativeUnit": {
+      "type": "object",
+      "required": [
+        "unit_id",
+        "family",
+        "span",
+        "markdown",
+        "headings",
+        "ancestor_context"
+      ],
+      "properties": {
+        "unit_id": {
+          "$ref": "#/$defs/nonEmptyString"
+        },
+        "family": {
+          "enum": [
+            "system_boundary",
+            "allocation",
+            "validation"
+          ]
+        },
+        "span": {
+          "$ref": "#/$defs/sourceSpan"
+        },
+        "markdown": {
+          "$ref": "#/$defs/nonEmptyString"
+        },
+        "headings": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/sourceHeading"
+          }
+        },
+        "ancestor_context": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "required": [
+              "span",
+              "markdown"
+            ],
+            "properties": {
+              "span": {
+                "$ref": "#/$defs/sourceSpan"
+              },
+              "markdown": {
+                "$ref": "#/$defs/nonEmptyString"
+              }
+            },
+            "additionalProperties": false
+          }
+        }
+      },
+      "additionalProperties": false
+    },
+    "normativeBinding": {
+      "type": "object",
+      "required": [
+        "pointer",
+        "rule_id",
+        "identity_kind",
+        "unit_id",
+        "source_span"
+      ],
+      "properties": {
+        "pointer": {
+          "type": "string",
+          "pattern": "^/(?:system_boundary/rules|allocation_rules|validation_rules)/(?:0|[1-9][0-9]*)$"
+        },
+        "rule_id": {
+          "type": "string",
+          "minLength": 1,
+          "pattern": "^[a-z0-9]+(?:_[a-z0-9]+)*$"
+        },
+        "identity_kind": {
+          "enum": [
+            "explicit",
+            "snapshot_local"
+          ]
+        },
+        "unit_id": {
+          "$ref": "#/$defs/nonEmptyString"
+        },
+        "source_span": {
+          "$ref": "#/$defs/sourceSpan"
+        }
+      },
+      "additionalProperties": false
+    },
+    "normativeDiagnostic": {
+      "type": "object",
+      "required": [
+        "code",
+        "message",
+        "unit_id",
+        "source_span"
+      ],
+      "properties": {
+        "code": {
+          "enum": [
+            "UNSUPPORTED_NORMATIVE_BLOCK",
+            "NON_RULE_TABLE",
+            "AMBIGUOUS_PROSE_ATTACHMENT",
+            "SNAPSHOT_RULE_ID_DISAMBIGUATED"
+          ]
+        },
+        "message": {
+          "$ref": "#/$defs/nonEmptyString"
+        },
+        "unit_id": {
+          "$ref": "#/$defs/nonEmptyString"
+        },
+        "source_span": {
+          "$ref": "#/$defs/sourceSpan"
+        }
       },
       "additionalProperties": false
+    },
+    "normativeContext": {
+      "type": "object",
+      "required": [
+        "normalization",
+        "source_sha256",
+        "identity_scope",
+        "units",
+        "bindings",
+        "diagnostics"
+      ],
+      "properties": {
+        "normalization": {
+          "const": "utf8-lf-v1"
+        },
+        "source_sha256": {
+          "type": "string",
+          "pattern": "^sha256:[0-9a-f]{64}$"
+        },
+        "identity_scope": {
+          "const": "projection_snapshot"
+        },
+        "units": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/normativeUnit"
+          }
+        },
+        "bindings": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/normativeBinding"
+          }
+        },
+        "diagnostics": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/normativeDiagnostic"
+          }
+        }
+      },
+      "additionalProperties": false,
+      "$comment": "Structural source context preserves authored Markdown without asserting scientific applicability. Reference uniqueness, binding coverage, source bytes and hash agreement require runtime integrity checks; material completeness remains a separate policy."
     }
   },
   "properties": {
-    "schema_version": { "const": 1 },
-    "generated_from": { "const": "markdown" },
-    "source_markdown": { "const": "pcr.en-US.md" },
+    "schema_version": {
+      "enum": [
+        1,
+        2
+      ]
+    },
+    "generated_from": {
+      "const": "markdown"
+    },
+    "source_markdown": {
+      "const": "pcr.en-US.md"
+    },
     "product_category_identity": {
       "type": "object",
       "properties": {
-        "canonical_pcr_id": { "type": "string", "pattern": "^pcr\\." }
+        "canonical_pcr_id": {
+          "type": "string",
+          "pattern": "^pcr\\."
+        }
       },
-      "additionalProperties": { "type": "string" }
+      "additionalProperties": {
+        "type": "string"
+      }
+    },
+    "functional_unit": {
+      "type": "object"
     },
-    "functional_unit": { "type": "object" },
     "system_boundary": {
       "type": "object",
-      "required": ["rules"],
-      "properties": { "rules": { "$ref": "#/$defs/normativeRuleArray" } },
+      "required": [
+        "rules"
+      ],
+      "properties": {
+        "rules": {
+          "$ref": "#/$defs/normativeRuleArray"
+        }
+      },
       "additionalProperties": false
     },
-    "boundary_abstraction": { "type": "object" },
-    "reference_flow_definition": { "type": "object" },
-    "reference_flows": { "type": "array" },
-    "measurement_rules": { "type": "array", "items": { "type": "object" } },
+    "boundary_abstraction": {
+      "type": "object"
+    },
+    "reference_flow_definition": {
+      "type": "object"
+    },
+    "reference_flows": {
+      "type": "array"
+    },
+    "measurement_rules": {
+      "type": "array",
+      "items": {
+        "type": "object"
+      }
+    },
     "process_map": {
       "type": "array",
-      "items": { "$ref": "#/$defs/processMapEntry" }
+      "items": {
+        "$ref": "#/$defs/processMapEntry"
+      }
     },
     "process_inventory": {
       "type": "array",
-      "items": { "$ref": "#/$defs/processInventoryEntry" }
+      "items": {
+        "$ref": "#/$defs/processInventoryEntry"
+      }
+    },
+    "allocation_rules": {
+      "$ref": "#/$defs/normativeRuleArray"
     },
-    "allocation_rules": { "$ref": "#/$defs/normativeRuleArray" },
     "dataset_production": {
       "type": "object",
-      "required": ["collection_protocols", "calculation_rules", "data_quality_requirements"],
+      "required": [
+        "collection_protocols",
+        "calculation_rules",
+        "data_quality_requirements"
+      ],
       "properties": {
-        "collection_protocols": { "type": "array" },
-        "calculation_rules": { "type": "array" },
-        "data_quality_requirements": { "type": "array" }
+        "collection_protocols": {
+          "type": "array"
+        },
+        "calculation_rules": {
+          "type": "array"
+        },
+        "data_quality_requirements": {
+          "type": "array"
+        }
       },
       "additionalProperties": false
     },
-    "validation_rules": { "$ref": "#/$defs/normativeRuleArray" },
-    "published_dataset_profile": { "type": "object" },
-    "data_sources": { "type": "array", "items": { "$ref": "#/$defs/dataSource" } },
-    "projection_metadata": { "$ref": "#/$defs/projectionMetadata" }
+    "validation_rules": {
+      "$ref": "#/$defs/normativeRuleArray"
+    },
+    "published_dataset_profile": {
+      "type": "object"
+    },
+    "data_sources": {
+      "type": "array",
+      "items": {
+        "$ref": "#/$defs/dataSource"
+      }
+    },
+    "projection_metadata": {
+      "$ref": "#/$defs/projectionMetadata"
+    },
+    "normative_context": {
+      "$ref": "#/$defs/normativeContext"
+    }
   },
-  "additionalProperties": false
+  "additionalProperties": false,
+  "allOf": [
+    {
+      "if": {
+        "properties": {
+          "schema_version": {
+            "const": 1
+          }
+        },
+        "required": [
+          "schema_version"
+        ]
+      },
+      "then": {
+        "properties": {
+          "normative_context": false,
+          "projection_metadata": {
+            "properties": {
+              "contract_version": {
+                "const": "1"
+              }
+            },
+            "type": "object"
+          }
+        }
+      }
+    },
+    {
+      "if": {
+        "properties": {
+          "schema_version": {
+            "const": 2
+          }
+        },
+        "required": [
+          "schema_version"
+        ]
+      },
+      "then": {
+        "required": [
+          "normative_context"
+        ],
+        "properties": {
+          "projection_metadata": {
+            "properties": {
+              "contract_version": {
+                "const": "2"
+              }
+            },
+            "type": "object"
+          }
+        }
+      }
+    }
+  ]
 }