@tiangong-lca/pcr 0.0.0-stage → 0.1.2

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

@@ -0,0 +1,269 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://tiangong-lca.org/schemas/pcr/v1/structured-projection.schema.json",
+  "title": "TianGong material PCR structured projection",
+  "type": "object",
+  "required": [
+    "schema_version",
+    "generated_from",
+    "source_markdown",
+    "product_category_identity",
+    "functional_unit",
+    "system_boundary",
+    "boundary_abstraction",
+    "reference_flow_definition",
+    "reference_flows",
+    "measurement_rules",
+    "process_map",
+    "process_inventory",
+    "allocation_rules",
+    "dataset_production",
+    "validation_rules",
+    "published_dataset_profile",
+    "data_sources",
+    "projection_metadata"
+  ],
+  "$defs": {
+    "nonEmptyString": { "type": "string", "minLength": 1 },
+    "normativeRule": {
+      "type": "object",
+      "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" },
+        "source_ids": {
+          "type": "array",
+          "items": { "$ref": "#/$defs/nonEmptyString" },
+          "uniqueItems": true
+        }
+      },
+      "additionalProperties": false
+    },
+    "normativeRuleArray": {
+      "type": "array",
+      "items": { "$ref": "#/$defs/normativeRule" }
+    },
+    "projectionMetadata": {
+      "type": "object",
+      "required": ["contract_version", "generator", "canonical_markdown", "generated_content_sha256"],
+      "properties": {
+        "contract_version": { "const": "1" },
+        "generator": { "const": "tiangong-pcr-builder/markdown-projection" },
+        "canonical_markdown": {
+          "type": "object",
+          "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}$" }
+          },
+          "additionalProperties": false
+        },
+        "generated_content_sha256": {
+          "type": "string",
+          "pattern": "^sha256:[0-9a-f]{64}$"
+        }
+      },
+      "additionalProperties": false
+    },
+    "processMapEntry": {
+      "type": "object",
+      "required": ["id", "name", "inclusion", "inclusion_condition", "role", "quantitative_reference"],
+      "properties": {
+        "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" }
+      },
+      "additionalProperties": false
+    },
+    "amountBasis": {
+      "type": "object",
+      "required": ["kind"],
+      "properties": {
+        "text": { "type": "string" },
+        "kind": {
+          "$ref": "https://tiangong-lca.org/schemas/pcr/v1/controlled-vocabulary.schema.json#/$defs/basis_kind"
+        }
+      },
+      "additionalProperties": false
+    },
+    "amountEvidence": {
+      "type": "object",
+      "required": ["kind"],
+      "properties": {
+        "kind": {
+          "$ref": "https://tiangong-lca.org/schemas/pcr/v1/controlled-vocabulary.schema.json#/$defs/evidence_kind"
+        },
+        "collection_protocol_id": { "type": "string" },
+        "source_ids": {
+          "type": "array",
+          "items": { "type": "string" },
+          "uniqueItems": true
+        }
+      },
+      "additionalProperties": false
+    },
+    "amountRange": {
+      "type": "object",
+      "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" },
+        "basis_kind": {
+          "$ref": "https://tiangong-lca.org/schemas/pcr/v1/controlled-vocabulary.schema.json#/$defs/basis_kind"
+        },
+        "evidence_kind": {
+          "$ref": "https://tiangong-lca.org/schemas/pcr/v1/controlled-vocabulary.schema.json#/$defs/evidence_kind"
+        },
+        "source_ids": {
+          "type": "array",
+          "items": { "type": "string" },
+          "uniqueItems": true
+        }
+      },
+      "additionalProperties": false
+    },
+    "flowAmount": {
+      "type": "object",
+      "required": ["value_mode", "specificity", "basis", "evidence", "ranges"],
+      "properties": {
+        "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" },
+        "ranges": {
+          "type": "array",
+          "items": { "$ref": "#/$defs/amountRange" }
+        }
+      },
+      "additionalProperties": false
+    },
+    "flowRow": {
+      "type": "object",
+      "required": [
+        "row_id",
+        "role",
+        "name",
+        "flow_type",
+        "property_unit",
+        "description",
+        "amount"
+      ],
+      "properties": {
+        "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" }
+      },
+      "additionalProperties": false
+    },
+    "flowGroups": {
+      "type": "object",
+      "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" } }
+      },
+      "additionalProperties": false
+    },
+    "processInventoryEntry": {
+      "type": "object",
+      "required": ["id", "label", "inputs", "outputs"],
+      "properties": {
+        "id": { "$ref": "#/$defs/nonEmptyString" },
+        "label": { "$ref": "#/$defs/nonEmptyString" },
+        "inputs": { "$ref": "#/$defs/flowGroups" },
+        "outputs": { "$ref": "#/$defs/flowGroups" }
+      },
+      "additionalProperties": false
+    },
+    "dataSource": {
+      "type": "object",
+      "required": ["type"],
+      "properties": {
+        "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" }
+      },
+      "additionalProperties": false
+    }
+  },
+  "properties": {
+    "schema_version": { "const": 1 },
+    "generated_from": { "const": "markdown" },
+    "source_markdown": { "const": "pcr.en-US.md" },
+    "product_category_identity": {
+      "type": "object",
+      "properties": {
+        "canonical_pcr_id": { "type": "string", "pattern": "^pcr\\." }
+      },
+      "additionalProperties": { "type": "string" }
+    },
+    "functional_unit": { "type": "object" },
+    "system_boundary": {
+      "type": "object",
+      "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" } },
+    "process_map": {
+      "type": "array",
+      "items": { "$ref": "#/$defs/processMapEntry" }
+    },
+    "process_inventory": {
+      "type": "array",
+      "items": { "$ref": "#/$defs/processInventoryEntry" }
+    },
+    "allocation_rules": { "$ref": "#/$defs/normativeRuleArray" },
+    "dataset_production": {
+      "type": "object",
+      "required": ["collection_protocols", "calculation_rules", "data_quality_requirements"],
+      "properties": {
+        "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" }
+  },
+  "additionalProperties": false
+}

package/packages/pcr-core/schemas/validation-output.schema.json

@@ -0,0 +1,117 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://tiangong-lca.org/schemas/pcr/v1/validation-output.schema.json",
+  "title": "TianGong PCR Validation Report",
+  "type": "object",
+  "required": [
+    "schema_version",
+    "validation_kind",
+    "pcr",
+    "readiness",
+    "validation_status",
+    "completeness",
+    "input",
+    "check_coverage",
+    "finding_count",
+    "finding_summary",
+    "findings"
+  ],
+  "properties": {
+    "schema_version": { "const": 1 },
+    "validation_kind": {
+      "enum": ["tiangong-pcr-model-validation", "tiangong-pcr-dataset-validation"]
+    },
+    "pcr": { "type": "object" },
+    "readiness": {
+      "$ref": "https://tiangong-lca.org/schemas/pcr/v1/readiness.schema.json"
+    },
+    "validation_status": { "enum": ["passed", "failed", "inconclusive"] },
+    "completeness": { "enum": ["none", "partial", "complete"] },
+    "input": {
+      "type": "object",
+      "required": ["input_kind", "representation", "accepted"],
+      "properties": {
+        "input_kind": { "type": "string", "minLength": 1 },
+        "representation": { "type": "string", "minLength": 1 },
+        "accepted": { "type": "boolean" },
+        "collection_record_count": { "type": "integer", "minimum": 0 },
+        "distinct_protocol_id_count": { "type": "integer", "minimum": 0 }
+      },
+      "additionalProperties": false
+    },
+    "check_coverage": {
+      "type": "object",
+      "required": [
+        "total_requirement_count",
+        "checked_requirement_count",
+        "skipped_requirement_count",
+        "checks_performed",
+        "checks_skipped"
+      ],
+      "properties": {
+        "total_requirement_count": { "type": "integer", "minimum": 0 },
+        "checked_requirement_count": { "type": "integer", "minimum": 0 },
+        "skipped_requirement_count": { "type": "integer", "minimum": 0 },
+        "checks_performed": {
+          "type": "array",
+          "items": { "$ref": "#/$defs/performedCheck" }
+        },
+        "checks_skipped": {
+          "type": "array",
+          "items": { "$ref": "#/$defs/skippedCheck" }
+        }
+      },
+      "additionalProperties": false
+    },
+    "finding_count": { "type": "integer", "minimum": 0 },
+    "finding_summary": {
+      "type": "object",
+      "required": ["error", "warning", "info"],
+      "properties": {
+        "error": { "type": "integer", "minimum": 0 },
+        "warning": { "type": "integer", "minimum": 0 },
+        "info": { "type": "integer", "minimum": 0 }
+      },
+      "additionalProperties": false
+    },
+    "findings": {
+      "type": "array",
+      "items": { "$ref": "#/$defs/finding" }
+    }
+  },
+  "additionalProperties": false,
+  "$defs": {
+    "performedCheck": {
+      "type": "object",
+      "required": ["check_id", "requirement_family", "requirement_count", "evaluated_requirement_count"],
+      "properties": {
+        "check_id": { "type": "string", "minLength": 1 },
+        "requirement_family": { "type": "string", "minLength": 1 },
+        "requirement_count": { "type": "integer", "minimum": 0 },
+        "evaluated_requirement_count": { "type": "integer", "minimum": 0 }
+      },
+      "additionalProperties": false
+    },
+    "skippedCheck": {
+      "type": "object",
+      "required": ["check_id", "requirement_family", "requirement_count", "reason"],
+      "properties": {
+        "check_id": { "type": "string", "minLength": 1 },
+        "requirement_family": { "type": "string", "minLength": 1 },
+        "requirement_count": { "type": "integer", "minimum": 0 },
+        "reason": { "type": "string", "minLength": 1 }
+      },
+      "additionalProperties": false
+    },
+    "finding": {
+      "type": "object",
+      "required": ["severity", "code", "message"],
+      "properties": {
+        "severity": { "enum": ["error", "warning", "info"] },
+        "code": { "type": "string", "minLength": 1 },
+        "message": { "type": "string", "minLength": 1 }
+      },
+      "additionalProperties": false
+    }
+  }
+}