@kungfu-tech/kfd 1.0.0-alpha.19 → 1.0.0-alpha.20

package/schemas/kfd-2/trust-claims.schema.json

@@ -0,0 +1,334 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://kfd.libkungfu.dev/schemas/kfd-2/trust-claims.schema.json",
+  "title": "KFD-2 trust claims",
+  "type": "object",
+  "required": [
+    "schemaVersion",
+    "contract",
+    "standard",
+    "claims"
+  ],
+  "properties": {
+    "schemaVersion": {
+      "const": 1
+    },
+    "contract": {
+      "const": "kfd-2-trust-claims"
+    },
+    "standard": {
+      "const": "kfd-2"
+    },
+    "claims": {
+      "type": "array",
+      "minItems": 1,
+      "items": {
+        "$ref": "#/$defs/claim"
+      }
+    },
+    "projection": {
+      "$ref": "#/$defs/projection"
+    },
+    "schemaEvolution": {
+      "$ref": "#/$defs/schemaEvolution"
+    }
+  },
+  "additionalProperties": true,
+  "$defs": {
+    "claim": {
+      "type": "object",
+      "required": [
+        "id",
+        "statement",
+        "subject",
+        "facts",
+        "evidence",
+        "auditBoundary",
+        "responsibility",
+        "status"
+      ],
+      "properties": {
+        "id": {
+          "type": "string",
+          "pattern": "^[a-z0-9]+(-[a-z0-9]+)*$"
+        },
+        "statement": {
+          "type": "string",
+          "minLength": 1
+        },
+        "subject": {
+          "$ref": "#/$defs/claimSubject"
+        },
+        "facts": {
+          "type": "array",
+          "minItems": 1,
+          "items": {
+            "$ref": "#/$defs/artifactPointer"
+          }
+        },
+        "evidence": {
+          "type": "array",
+          "minItems": 1,
+          "items": {
+            "$ref": "#/$defs/evidenceBinding"
+          }
+        },
+        "verification": {
+          "$ref": "#/$defs/verification"
+        },
+        "auditBoundary": {
+          "$ref": "#/$defs/auditBoundary"
+        },
+        "residualRisk": {
+          "type": "array",
+          "items": {
+            "$ref": "https://kfd.libkungfu.dev/schemas/kfd-2/trust-taxonomy.schema.json#/$defs/residualRisk"
+          }
+        },
+        "responsibility": {
+          "$ref": "#/$defs/responsibilityState"
+        },
+        "status": {
+          "enum": [
+            "declared",
+            "audited",
+            "enforced",
+            "not-applicable"
+          ]
+        }
+      },
+      "additionalProperties": true
+    },
+    "claimSubject": {
+      "type": "object",
+      "required": [
+        "kind",
+        "id"
+      ],
+      "properties": {
+        "kind": {
+          "enum": [
+            "kfd-standard",
+            "contract-world",
+            "collaboration-interface",
+            "observer-perspective",
+            "release",
+            "artifact",
+            "config",
+            "api",
+            "abi",
+            "gui-surface",
+            "runtime-fact",
+            "documentation",
+            "other"
+          ]
+        },
+        "id": {
+          "type": "string",
+          "minLength": 1
+        },
+        "standard": {
+          "type": "string",
+          "pattern": "^kfd-[1-9][0-9]*$"
+        },
+        "description": {
+          "type": "string",
+          "minLength": 1
+        }
+      },
+      "additionalProperties": true
+    },
+    "artifactPointer": {
+      "type": "object",
+      "required": [
+        "kind"
+      ],
+      "properties": {
+        "kind": {
+          "enum": [
+            "file",
+            "schema",
+            "package-export",
+            "artifact",
+            "command",
+            "witness",
+            "passport",
+            "url",
+            "other"
+          ]
+        },
+        "path": {
+          "type": "string",
+          "minLength": 1
+        },
+        "specifier": {
+          "type": "string",
+          "minLength": 1
+        },
+        "url": {
+          "type": "string",
+          "format": "uri"
+        },
+        "schemaId": {
+          "type": "string",
+          "format": "uri"
+        },
+        "sha256": {
+          "type": "string",
+          "pattern": "^[0-9a-f]{64}$"
+        },
+        "digest": {
+          "type": "string",
+          "minLength": 1
+        }
+      },
+      "additionalProperties": true
+    },
+    "evidenceBinding": {
+      "type": "object",
+      "required": [
+        "type",
+        "machineProvability"
+      ],
+      "properties": {
+        "type": {
+          "enum": [
+            "file",
+            "schema",
+            "package-export",
+            "artifact",
+            "hash",
+            "command-result",
+            "witness",
+            "passport-section",
+            "url",
+            "manual-review",
+            "other"
+          ]
+        },
+        "pointer": {
+          "$ref": "#/$defs/artifactPointer"
+        },
+        "machineProvability": {
+          "$ref": "https://kfd.libkungfu.dev/schemas/kfd-2/trust-taxonomy.schema.json#/$defs/machineProvability"
+        },
+        "description": {
+          "type": "string",
+          "minLength": 1
+        }
+      },
+      "additionalProperties": true
+    },
+    "verification": {
+      "type": "object",
+      "properties": {
+        "command": {
+          "type": "string",
+          "minLength": 1
+        },
+        "resultRef": {
+          "$ref": "#/$defs/artifactPointer"
+        },
+        "expectedResult": {
+          "enum": [
+            "pass",
+            "fail",
+            "warning",
+            "unverifiable"
+          ]
+        }
+      },
+      "additionalProperties": true
+    },
+    "auditBoundary": {
+      "type": "object",
+      "required": [
+        "scope",
+        "enumerability"
+      ],
+      "properties": {
+        "scope": {
+          "type": "string",
+          "minLength": 1
+        },
+        "enumerability": {
+          "enum": [
+            "closed-world",
+            "declared-open",
+            "sampled",
+            "manual"
+          ]
+        }
+      },
+      "additionalProperties": true
+    },
+    "responsibilityState": {
+      "type": "object",
+      "required": [
+        "owner",
+        "sourceOwner",
+        "verificationOwner",
+        "decisionOwner"
+      ],
+      "properties": {
+        "owner": {
+          "type": "string",
+          "minLength": 1
+        },
+        "sourceOwner": {
+          "type": "string",
+          "minLength": 1
+        },
+        "verificationOwner": {
+          "type": "string",
+          "minLength": 1
+        },
+        "decisionOwner": {
+          "type": "string",
+          "minLength": 1
+        },
+        "escalation": {
+          "type": "string",
+          "minLength": 1
+        }
+      },
+      "additionalProperties": true
+    },
+    "projection": {
+      "type": "object",
+      "required": [
+        "kind"
+      ],
+      "properties": {
+        "kind": {
+          "enum": [
+            "generic",
+            "release",
+            "package",
+            "site",
+            "runtime",
+            "other"
+          ]
+        },
+        "description": {
+          "type": "string",
+          "minLength": 1
+        }
+      },
+      "additionalProperties": true
+    },
+    "schemaEvolution": {
+      "type": "object",
+      "required": [
+        "compatibilityRule"
+      ],
+      "properties": {
+        "compatibilityRule": {
+          "type": "string",
+          "minLength": 1
+        }
+      },
+      "additionalProperties": true
+    }
+  }
+}

package/schemas/kfd-3/collaboration-interface.schema.json

@@ -12,6 +12,7 @@
     "participants",
     "minimalEntrypoints",
     "surfaces",
+    "valueEvidence",
     "transparentConstraints",
     "choicePaths",
     "closure"
@@ -78,6 +79,13 @@
         "$ref": "#/$defs/surface"
       }
     },
+    "valueEvidence": {
+      "type": "array",
+      "minItems": 1,
+      "items": {
+        "$ref": "#/$defs/valueEvidence"
+      }
+    },
     "transparentConstraints": {
       "type": "array",
       "items": {
@@ -337,6 +345,58 @@
       },
       "additionalProperties": true
     },
+    "valueEvidence": {
+      "type": "object",
+      "required": [
+        "id",
+        "claim",
+        "participants",
+        "facts",
+        "evidence"
+      ],
+      "properties": {
+        "id": {
+          "type": "string",
+          "pattern": "^[a-z0-9]+(-[a-z0-9]+)*$"
+        },
+        "claim": {
+          "type": "string",
+          "minLength": 1
+        },
+        "participants": {
+          "type": "array",
+          "minItems": 1,
+          "items": {
+            "type": "string",
+            "minLength": 1
+          }
+        },
+        "facts": {
+          "type": "array",
+          "minItems": 1,
+          "items": {
+            "$ref": "#/$defs/artifactPointer"
+          }
+        },
+        "evidence": {
+          "type": "array",
+          "minItems": 1,
+          "items": {
+            "$ref": "#/$defs/artifactPointer"
+          }
+        },
+        "trustAssessment": {
+          "$ref": "#/$defs/artifactPointer"
+        },
+        "residualRisk": {
+          "type": "array",
+          "items": {
+            "$ref": "https://kfd.libkungfu.dev/schemas/kfd-2/trust-taxonomy.schema.json#/$defs/residualRisk"
+          }
+        }
+      },
+      "additionalProperties": true
+    },
     "transparentConstraint": {
       "type": "object",
       "required": [

package/schemas/kfd-3/witness.schema.json

@@ -47,6 +47,7 @@
       "required": [
         "minimalEntrypoints",
         "discoverability",
+        "valueEvidence",
         "transparentConstraints",
         "choicePaths"
       ],
@@ -64,6 +65,13 @@
             "$ref": "#/$defs/artifactPointer"
           }
         },
+        "valueEvidence": {
+          "type": "array",
+          "minItems": 1,
+          "items": {
+            "$ref": "#/$defs/artifactPointer"
+          }
+        },
         "transparentConstraints": {
           "type": "array",
           "items": {

package/schemas/kfd-standards.schema.json

@@ -231,6 +231,130 @@
           "additionalProperties": {
             "type": "string"
           }
+        },
+        "surfaceRegister": {
+          "$ref": "#/$defs/surfaceRegister"
+        }
+      },
+      "additionalProperties": false
+    },
+    "surfaceClass": {
+      "enum": [
+        "integration-time",
+        "cross-time"
+      ]
+    },
+    "compatibilityImpact": {
+      "enum": [
+        "breaking",
+        "additive",
+        "none",
+        "unclassifiable"
+      ]
+    },
+    "impactProjection": {
+      "type": "object",
+      "required": [
+        "breaking",
+        "additive",
+        "none",
+        "unclassifiable"
+      ],
+      "properties": {
+        "breaking": {
+          "type": "string",
+          "minLength": 1
+        },
+        "additive": {
+          "type": "string",
+          "minLength": 1
+        },
+        "none": {
+          "type": "string",
+          "minLength": 1
+        },
+        "unclassifiable": {
+          "type": "string",
+          "minLength": 1
+        }
+      },
+      "additionalProperties": false
+    },
+    "registeredSurface": {
+      "type": "object",
+      "required": [
+        "id",
+        "class",
+        "description",
+        "sourcePath",
+        "impactProjection"
+      ],
+      "properties": {
+        "id": {
+          "type": "string",
+          "pattern": "^[a-z0-9]+(-[a-z0-9]+)*$"
+        },
+        "class": {
+          "$ref": "#/$defs/surfaceClass"
+        },
+        "classes": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/surfaceClass"
+          },
+          "uniqueItems": true,
+          "minItems": 1
+        },
+        "description": {
+          "type": "string",
+          "minLength": 1
+        },
+        "sourcePath": {
+          "type": "string",
+          "minLength": 1
+        },
+        "weldRationale": {
+          "type": "string",
+          "minLength": 1
+        },
+        "impactProjection": {
+          "$ref": "#/$defs/impactProjection"
+        }
+      },
+      "additionalProperties": false
+    },
+    "surfaceRegister": {
+      "type": "object",
+      "required": [
+        "factSource",
+        "surfaceClasses",
+        "compatibilityImpactClasses",
+        "surfaces"
+      ],
+      "properties": {
+        "factSource": {
+          "type": "string",
+          "minLength": 1
+        },
+        "surfaceClasses": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/surfaceClass"
+          },
+          "uniqueItems": true
+        },
+        "compatibilityImpactClasses": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/compatibilityImpact"
+          },
+          "uniqueItems": true
+        },
+        "surfaces": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/registeredSurface"
+          }
         }
       },
       "additionalProperties": false