@stsepelin/checktrail 0.1.0-alpha.1

package/schemas/review-context.schema.json

@@ -0,0 +1,254 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "schemaVersion": { "type": "number", "const": 1 },
+    "format": { "type": "string", "const": "review-context" },
+    "channel": { "type": "string", "const": "advisory" },
+    "automatedCoverage": { "type": "boolean", "const": false },
+    "sourceFingerprint": { "type": "string", "pattern": "^[a-f0-9]{64}$" },
+    "sourceTrust": { "type": "string", "const": "untrusted-source-text" },
+    "selection": {
+      "type": "object",
+      "properties": {
+        "schemaVersion": { "type": "number", "const": 1 },
+        "files": {
+          "minItems": 1,
+          "maxItems": 16,
+          "type": "array",
+          "items": { "type": "string", "minLength": 1, "maxLength": 1024 }
+        },
+        "topics": {
+          "maxItems": 16,
+          "type": "array",
+          "items": {
+            "type": "string",
+            "enum": [
+              "test-lifecycle",
+              "analysis-scope",
+              "package-consumers",
+              "python-imports",
+              "framework-assembly",
+              "execution-depth"
+            ]
+          }
+        }
+      },
+      "required": ["schemaVersion", "files", "topics"],
+      "additionalProperties": false
+    },
+    "instructions": { "type": "string" },
+    "guidance": {
+      "type": "object",
+      "properties": {
+        "schemaVersion": { "type": "number", "const": 1 },
+        "engineVersion": { "type": "string" },
+        "channel": { "type": "string", "const": "advisory" },
+        "provenance": {
+          "type": "string",
+          "const": "builtin-guidance-selection"
+        },
+        "catalogueDigest": { "type": "string", "pattern": "^[a-f0-9]{64}$" },
+        "automatedCoverage": { "type": "boolean", "const": false },
+        "selectionBasis": { "type": "string", "const": "exact-check-or-topic" },
+        "context": {
+          "type": "object",
+          "properties": {
+            "schemaVersion": { "type": "number", "const": 1 },
+            "checks": {
+              "maxItems": 100,
+              "type": "array",
+              "items": {
+                "type": "string",
+                "minLength": 1,
+                "maxLength": 128,
+                "pattern": "^[a-z0-9][a-z0-9.-]*$"
+              }
+            },
+            "topics": {
+              "maxItems": 16,
+              "type": "array",
+              "items": {
+                "type": "string",
+                "enum": [
+                  "test-lifecycle",
+                  "analysis-scope",
+                  "package-consumers",
+                  "python-imports",
+                  "framework-assembly",
+                  "execution-depth"
+                ]
+              }
+            }
+          },
+          "required": ["schemaVersion", "checks", "topics"],
+          "additionalProperties": false
+        },
+        "items": {
+          "maxItems": 64,
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "id": {
+                "type": "string",
+                "minLength": 1,
+                "maxLength": 128,
+                "pattern": "^[a-z0-9][a-z0-9.-]*$"
+              },
+              "version": { "type": "string", "const": "1.0.0" },
+              "title": { "type": "string", "minLength": 1, "maxLength": 160 },
+              "triggers": {
+                "type": "object",
+                "properties": {
+                  "checks": {
+                    "maxItems": 32,
+                    "type": "array",
+                    "items": {
+                      "type": "string",
+                      "minLength": 1,
+                      "maxLength": 128,
+                      "pattern": "^[a-z0-9][a-z0-9.-]*$"
+                    }
+                  },
+                  "topics": {
+                    "minItems": 1,
+                    "maxItems": 16,
+                    "type": "array",
+                    "items": {
+                      "type": "string",
+                      "enum": [
+                        "test-lifecycle",
+                        "analysis-scope",
+                        "package-consumers",
+                        "python-imports",
+                        "framework-assembly",
+                        "execution-depth"
+                      ]
+                    }
+                  }
+                },
+                "required": ["checks", "topics"],
+                "additionalProperties": false
+              },
+              "questions": {
+                "minItems": 1,
+                "maxItems": 8,
+                "type": "array",
+                "items": { "type": "string", "minLength": 1, "maxLength": 600 }
+              },
+              "references": {
+                "minItems": 1,
+                "maxItems": 8,
+                "type": "array",
+                "items": {
+                  "type": "object",
+                  "properties": {
+                    "title": {
+                      "type": "string",
+                      "minLength": 1,
+                      "maxLength": 160
+                    },
+                    "url": {
+                      "type": "string",
+                      "maxLength": 512,
+                      "pattern": "^https:\\/\\/",
+                      "format": "uri"
+                    }
+                  },
+                  "required": ["title", "url"],
+                  "additionalProperties": false
+                }
+              },
+              "matched": {
+                "type": "object",
+                "properties": {
+                  "schemaVersion": { "type": "number", "const": 1 },
+                  "checks": {
+                    "maxItems": 100,
+                    "type": "array",
+                    "items": {
+                      "type": "string",
+                      "minLength": 1,
+                      "maxLength": 128,
+                      "pattern": "^[a-z0-9][a-z0-9.-]*$"
+                    }
+                  },
+                  "topics": {
+                    "maxItems": 16,
+                    "type": "array",
+                    "items": {
+                      "type": "string",
+                      "enum": [
+                        "test-lifecycle",
+                        "analysis-scope",
+                        "package-consumers",
+                        "python-imports",
+                        "framework-assembly",
+                        "execution-depth"
+                      ]
+                    }
+                  }
+                },
+                "required": ["schemaVersion", "checks", "topics"],
+                "additionalProperties": false
+              }
+            },
+            "required": [
+              "id",
+              "version",
+              "title",
+              "triggers",
+              "questions",
+              "references",
+              "matched"
+            ],
+            "additionalProperties": false
+          }
+        }
+      },
+      "required": [
+        "schemaVersion",
+        "engineVersion",
+        "channel",
+        "provenance",
+        "catalogueDigest",
+        "automatedCoverage",
+        "selectionBasis",
+        "context",
+        "items"
+      ],
+      "additionalProperties": false
+    },
+    "files": {
+      "minItems": 1,
+      "maxItems": 16,
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "path": { "type": "string", "minLength": 1, "maxLength": 1024 },
+          "sha256": { "type": "string", "pattern": "^[a-f0-9]{64}$" },
+          "content": { "type": "string", "maxLength": 65536 }
+        },
+        "required": ["path", "sha256", "content"],
+        "additionalProperties": false
+      }
+    },
+    "contextDigest": { "type": "string", "pattern": "^[a-f0-9]{64}$" }
+  },
+  "required": [
+    "schemaVersion",
+    "format",
+    "channel",
+    "automatedCoverage",
+    "sourceFingerprint",
+    "sourceTrust",
+    "selection",
+    "instructions",
+    "guidance",
+    "files",
+    "contextDigest"
+  ],
+  "additionalProperties": false
+}

package/schemas/review-receipt-summary.schema.json

@@ -0,0 +1,104 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "schemaVersion": { "type": "number", "const": 1 },
+    "engineVersion": { "type": "string" },
+    "channel": { "type": "string", "const": "advisory" },
+    "automatedCoverage": { "type": "boolean", "const": false },
+    "claimsVerified": { "type": "boolean", "const": false },
+    "deterministicOutcomeChanged": { "type": "boolean", "const": false },
+    "provenance": { "type": "string", "const": "imported-review-assessment" },
+    "contextDigest": { "type": "string", "pattern": "^[a-f0-9]{64}$" },
+    "freshness": { "type": "string", "enum": ["current", "stale"] },
+    "usageProvenance": { "type": "string", "const": "reviewer-declared" },
+    "usage": {
+      "type": "object",
+      "properties": {
+        "inputTokens": {
+          "anyOf": [
+            { "type": "integer", "minimum": 0, "maximum": 1000000000 },
+            { "type": "null" }
+          ]
+        },
+        "outputTokens": {
+          "anyOf": [
+            { "type": "integer", "minimum": 0, "maximum": 1000000000 },
+            { "type": "null" }
+          ]
+        },
+        "elapsedMs": {
+          "anyOf": [
+            { "type": "integer", "minimum": 0, "maximum": 1000000000 },
+            { "type": "null" }
+          ]
+        },
+        "costUSD": {
+          "anyOf": [
+            { "type": "number", "minimum": 0, "maximum": 1000000 },
+            { "type": "null" }
+          ]
+        }
+      },
+      "required": ["inputTokens", "outputTokens", "elapsedMs", "costUSD"],
+      "additionalProperties": false
+    },
+    "coverage": {
+      "type": "object",
+      "properties": {
+        "selected": { "type": "integer", "minimum": 0, "maximum": 1000000000 },
+        "declaredReviewed": {
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 1000000000
+        },
+        "declaredNotReviewed": {
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 1000000000
+        },
+        "unaccounted": {
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 1000000000
+        }
+      },
+      "required": [
+        "selected",
+        "declaredReviewed",
+        "declaredNotReviewed",
+        "unaccounted"
+      ],
+      "additionalProperties": false
+    },
+    "citations": {
+      "type": "object",
+      "properties": {
+        "matched": { "type": "integer", "minimum": 0, "maximum": 1000000000 },
+        "unmatched": { "type": "integer", "minimum": 0, "maximum": 1000000000 }
+      },
+      "required": ["matched", "unmatched"],
+      "additionalProperties": false
+    },
+    "reviewerKind": { "type": "string", "enum": ["human", "model"] },
+    "observations": { "type": "integer", "minimum": 0, "maximum": 1000000000 }
+  },
+  "required": [
+    "schemaVersion",
+    "engineVersion",
+    "channel",
+    "automatedCoverage",
+    "claimsVerified",
+    "deterministicOutcomeChanged",
+    "provenance",
+    "contextDigest",
+    "freshness",
+    "usageProvenance",
+    "usage",
+    "coverage",
+    "citations",
+    "reviewerKind",
+    "observations"
+  ],
+  "additionalProperties": false
+}

package/schemas/review-receipt.schema.json

@@ -0,0 +1,271 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "schemaVersion": { "type": "number", "const": 1 },
+    "engineVersion": { "type": "string" },
+    "channel": { "type": "string", "const": "advisory" },
+    "automatedCoverage": { "type": "boolean", "const": false },
+    "claimsVerified": { "type": "boolean", "const": false },
+    "deterministicOutcomeChanged": { "type": "boolean", "const": false },
+    "provenance": { "type": "string", "const": "imported-review-assessment" },
+    "contextDigest": { "type": "string", "pattern": "^[a-f0-9]{64}$" },
+    "freshness": { "type": "string", "enum": ["current", "stale"] },
+    "usageProvenance": { "type": "string", "const": "reviewer-declared" },
+    "usage": {
+      "type": "object",
+      "properties": {
+        "inputTokens": {
+          "anyOf": [
+            { "type": "integer", "minimum": 0, "maximum": 1000000000 },
+            { "type": "null" }
+          ]
+        },
+        "outputTokens": {
+          "anyOf": [
+            { "type": "integer", "minimum": 0, "maximum": 1000000000 },
+            { "type": "null" }
+          ]
+        },
+        "elapsedMs": {
+          "anyOf": [
+            { "type": "integer", "minimum": 0, "maximum": 1000000000 },
+            { "type": "null" }
+          ]
+        },
+        "costUSD": {
+          "anyOf": [
+            { "type": "number", "minimum": 0, "maximum": 1000000 },
+            { "type": "null" }
+          ]
+        }
+      },
+      "required": ["inputTokens", "outputTokens", "elapsedMs", "costUSD"],
+      "additionalProperties": false
+    },
+    "coverage": {
+      "type": "object",
+      "properties": {
+        "selected": { "type": "integer", "minimum": 0, "maximum": 1000000000 },
+        "declaredReviewed": {
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 1000000000
+        },
+        "declaredNotReviewed": {
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 1000000000
+        },
+        "unaccounted": {
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 1000000000
+        }
+      },
+      "required": [
+        "selected",
+        "declaredReviewed",
+        "declaredNotReviewed",
+        "unaccounted"
+      ],
+      "additionalProperties": false
+    },
+    "citations": {
+      "type": "object",
+      "properties": {
+        "matched": { "type": "integer", "minimum": 0, "maximum": 1000000000 },
+        "unmatched": { "type": "integer", "minimum": 0, "maximum": 1000000000 }
+      },
+      "required": ["matched", "unmatched"],
+      "additionalProperties": false
+    },
+    "assessment": {
+      "type": "object",
+      "properties": {
+        "schemaVersion": { "type": "number", "const": 1 },
+        "contextDigest": { "type": "string", "pattern": "^[a-f0-9]{64}$" },
+        "reviewer": {
+          "oneOf": [
+            {
+              "type": "object",
+              "properties": {
+                "kind": { "type": "string", "const": "human" },
+                "name": { "type": "string", "minLength": 1, "maxLength": 256 }
+              },
+              "required": ["kind", "name"],
+              "additionalProperties": false
+            },
+            {
+              "type": "object",
+              "properties": {
+                "kind": { "type": "string", "const": "model" },
+                "provider": {
+                  "type": "string",
+                  "minLength": 1,
+                  "maxLength": 256
+                },
+                "model": { "type": "string", "minLength": 1, "maxLength": 256 },
+                "version": {
+                  "type": "string",
+                  "minLength": 1,
+                  "maxLength": 256
+                }
+              },
+              "required": ["kind", "provider", "model", "version"],
+              "additionalProperties": false
+            }
+          ]
+        },
+        "createdAt": {
+          "type": "string",
+          "format": "date-time",
+          "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
+        },
+        "usage": {
+          "type": "object",
+          "properties": {
+            "inputTokens": {
+              "anyOf": [
+                { "type": "integer", "minimum": 0, "maximum": 1000000000 },
+                { "type": "null" }
+              ]
+            },
+            "outputTokens": {
+              "anyOf": [
+                { "type": "integer", "minimum": 0, "maximum": 1000000000 },
+                { "type": "null" }
+              ]
+            },
+            "elapsedMs": {
+              "anyOf": [
+                { "type": "integer", "minimum": 0, "maximum": 1000000000 },
+                { "type": "null" }
+              ]
+            },
+            "costUSD": {
+              "anyOf": [
+                { "type": "number", "minimum": 0, "maximum": 1000000 },
+                { "type": "null" }
+              ]
+            }
+          },
+          "required": ["inputTokens", "outputTokens", "elapsedMs", "costUSD"],
+          "additionalProperties": false
+        },
+        "files": {
+          "maxItems": 16,
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "path": { "type": "string", "minLength": 1, "maxLength": 1024 },
+              "disposition": {
+                "type": "string",
+                "enum": ["reviewed", "not-reviewed"]
+              },
+              "note": { "type": "string", "maxLength": 1024 }
+            },
+            "required": ["path", "disposition", "note"],
+            "additionalProperties": false
+          }
+        },
+        "observations": {
+          "maxItems": 64,
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "id": { "type": "string", "minLength": 1, "maxLength": 128 },
+              "severity": {
+                "type": "string",
+                "enum": ["suggestion", "concern"]
+              },
+              "claim": { "type": "string", "minLength": 1, "maxLength": 4096 },
+              "citations": {
+                "minItems": 1,
+                "maxItems": 8,
+                "type": "array",
+                "items": {
+                  "type": "object",
+                  "properties": {
+                    "file": {
+                      "type": "string",
+                      "minLength": 1,
+                      "maxLength": 1024
+                    },
+                    "startLine": {
+                      "type": "integer",
+                      "minimum": 1,
+                      "maximum": 65537
+                    },
+                    "endLine": {
+                      "type": "integer",
+                      "minimum": 1,
+                      "maximum": 65537
+                    },
+                    "quote": {
+                      "type": "string",
+                      "minLength": 1,
+                      "maxLength": 2048
+                    }
+                  },
+                  "required": ["file", "startLine", "endLine", "quote"],
+                  "additionalProperties": false
+                }
+              }
+            },
+            "required": ["id", "severity", "claim", "citations"],
+            "additionalProperties": false
+          }
+        }
+      },
+      "required": [
+        "schemaVersion",
+        "contextDigest",
+        "reviewer",
+        "createdAt",
+        "usage",
+        "files",
+        "observations"
+      ],
+      "additionalProperties": false
+    },
+    "citationChecks": {
+      "maxItems": 512,
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "observationId": { "type": "string" },
+          "citation": {
+            "type": "integer",
+            "minimum": 0,
+            "maximum": 9007199254740991
+          },
+          "matchesContext": { "type": "boolean" }
+        },
+        "required": ["observationId", "citation", "matchesContext"],
+        "additionalProperties": false
+      }
+    }
+  },
+  "required": [
+    "schemaVersion",
+    "engineVersion",
+    "channel",
+    "automatedCoverage",
+    "claimsVerified",
+    "deterministicOutcomeChanged",
+    "provenance",
+    "contextDigest",
+    "freshness",
+    "usageProvenance",
+    "usage",
+    "coverage",
+    "citations",
+    "assessment",
+    "citationChecks"
+  ],
+  "additionalProperties": false
+}

package/schemas/review-selection.schema.json

@@ -0,0 +1,30 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "schemaVersion": { "type": "number", "const": 1 },
+    "files": {
+      "minItems": 1,
+      "maxItems": 16,
+      "type": "array",
+      "items": { "type": "string", "minLength": 1, "maxLength": 1024 }
+    },
+    "topics": {
+      "maxItems": 16,
+      "type": "array",
+      "items": {
+        "type": "string",
+        "enum": [
+          "test-lifecycle",
+          "analysis-scope",
+          "package-consumers",
+          "python-imports",
+          "framework-assembly",
+          "execution-depth"
+        ]
+      }
+    }
+  },
+  "required": ["schemaVersion", "files", "topics"],
+  "additionalProperties": false
+}