patchdrill 0.1.0

package/schemas/patchdrill-report.schema.json

@@ -0,0 +1,647 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://patchdrill.dev/schemas/patchdrill-report.schema.json",
+  "title": "PatchDrill Report",
+  "description": "Machine-readable JSON report emitted by PatchDrill scan --json.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "schemaVersion",
+    "generatedAt",
+    "root",
+    "summary",
+    "changedFiles",
+    "addedLines",
+    "projectSignals",
+    "affectedPackages",
+    "dependencyChanges",
+    "packageScriptChanges",
+    "findings",
+    "commandPlan",
+    "commandResults",
+    "verification"
+  ],
+  "properties": {
+    "schemaVersion": {
+      "type": "string",
+      "const": "1"
+    },
+    "generatedAt": {
+      "type": "string",
+      "format": "date-time"
+    },
+    "root": {
+      "type": "string"
+    },
+    "base": {
+      "type": "string"
+    },
+    "head": {
+      "type": "string"
+    },
+    "summary": {
+      "$ref": "#/$defs/patchSummary"
+    },
+    "changedFiles": {
+      "type": "array",
+      "items": {
+        "$ref": "#/$defs/changedFile"
+      }
+    },
+    "addedLines": {
+      "type": "integer",
+      "minimum": 0
+    },
+    "projectSignals": {
+      "type": "array",
+      "items": {
+        "$ref": "#/$defs/projectSignal"
+      }
+    },
+    "affectedPackages": {
+      "type": "array",
+      "items": {
+        "$ref": "#/$defs/workspacePackage"
+      }
+    },
+    "dependencyChanges": {
+      "type": "array",
+      "items": {
+        "$ref": "#/$defs/dependencyChange"
+      }
+    },
+    "packageScriptChanges": {
+      "type": "array",
+      "items": {
+        "$ref": "#/$defs/packageScriptChange"
+      }
+    },
+    "policy": {
+      "$ref": "#/$defs/reportPolicy"
+    },
+    "codeOwners": {
+      "$ref": "#/$defs/codeOwners"
+    },
+    "baseline": {
+      "$ref": "#/$defs/baseline"
+    },
+    "findings": {
+      "type": "array",
+      "items": {
+        "$ref": "#/$defs/riskFinding"
+      }
+    },
+    "commandPlan": {
+      "type": "array",
+      "items": {
+        "$ref": "#/$defs/commandPlan"
+      }
+    },
+    "commandResults": {
+      "type": "array",
+      "items": {
+        "$ref": "#/$defs/commandResult"
+      }
+    },
+    "verification": {
+      "$ref": "#/$defs/patchVerification"
+    }
+  },
+  "$defs": {
+    "severity": {
+      "type": "string",
+      "enum": ["info", "low", "medium", "high", "critical"]
+    },
+    "patchStatus": {
+      "type": "string",
+      "enum": ["pass", "warn", "fail"]
+    },
+    "fileStatus": {
+      "type": "string",
+      "enum": ["added", "modified", "deleted", "renamed", "copied", "untracked", "unknown"]
+    },
+    "ecosystem": {
+      "type": "string",
+      "enum": ["node", "python", "rust", "go", "java", "android", "ruby", "php", "dotnet", "swift", "xcode", "terraform", "docker", "kubernetes", "bazel", "buck", "pants", "github-actions", "unknown"]
+    },
+    "commandEcosystem": {
+      "type": "string",
+      "enum": ["node", "python", "rust", "go", "java", "android", "ruby", "php", "dotnet", "swift", "xcode", "terraform", "docker", "kubernetes", "bazel", "buck", "pants", "github-actions", "unknown", "general"]
+    },
+    "verificationStatus": {
+      "type": "string",
+      "enum": ["passed", "failed", "timed-out", "not-run", "skipped-optional"]
+    },
+    "patchSummary": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "status",
+        "riskScore",
+        "confidenceScore",
+        "changedFileCount",
+        "additions",
+        "deletions",
+        "requiredCommandCount",
+        "failedCommandCount"
+      ],
+      "properties": {
+        "status": {
+          "$ref": "#/$defs/patchStatus"
+        },
+        "riskScore": {
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 100
+        },
+        "confidenceScore": {
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 100
+        },
+        "changedFileCount": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "additions": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "deletions": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "requiredCommandCount": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "failedCommandCount": {
+          "type": "integer",
+          "minimum": 0
+        }
+      }
+    },
+    "changedFile": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["path", "status", "additions", "deletions", "binary"],
+      "properties": {
+        "path": {
+          "type": "string"
+        },
+        "previousPath": {
+          "type": "string"
+        },
+        "status": {
+          "$ref": "#/$defs/fileStatus"
+        },
+        "additions": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "deletions": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "binary": {
+          "type": "boolean"
+        },
+        "owners": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        }
+      }
+    },
+    "projectSignal": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["ecosystem", "manifestPath"],
+      "properties": {
+        "ecosystem": {
+          "$ref": "#/$defs/ecosystem"
+        },
+        "manifestPath": {
+          "type": "string"
+        },
+        "framework": {
+          "type": "string",
+          "enum": ["django", "fastapi", "spring-boot", "rails", "laravel", "aspnet-core"]
+        },
+        "entrypoint": {
+          "type": "string",
+          "pattern": "^[A-Za-z_][A-Za-z0-9_]*(\\.[A-Za-z_][A-Za-z0-9_]*)*:[A-Za-z_][A-Za-z0-9_]*$"
+        },
+        "packageManager": {
+          "type": "string"
+        },
+        "taskRunner": {
+          "type": "string",
+          "enum": ["turbo", "nx"]
+        },
+        "scripts": {
+          "type": "object",
+          "additionalProperties": {
+            "type": "string"
+          }
+        },
+        "workspacePackages": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/workspacePackage"
+          }
+        }
+      }
+    },
+    "workspacePackage": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["name", "path", "scripts"],
+      "properties": {
+        "name": {
+          "type": "string"
+        },
+        "projectName": {
+          "type": "string"
+        },
+        "path": {
+          "type": "string"
+        },
+        "scripts": {
+          "type": "object",
+          "additionalProperties": {
+            "type": "string"
+          }
+        },
+        "targets": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "dependencies": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        }
+      }
+    },
+    "dependencyChange": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["file", "packageName", "dependencyType", "changeType"],
+      "properties": {
+        "file": {
+          "type": "string"
+        },
+        "packageName": {
+          "type": "string"
+        },
+        "dependencyType": {
+          "type": "string",
+          "enum": ["dependencies", "devDependencies", "peerDependencies", "optionalDependencies", "lockfile"]
+        },
+        "changeType": {
+          "type": "string",
+          "enum": ["added", "removed", "updated"]
+        },
+        "packagePath": {
+          "type": "string"
+        },
+        "before": {
+          "type": "string"
+        },
+        "after": {
+          "type": "string"
+        }
+      }
+    },
+    "packageScriptChange": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["file", "scriptName", "changeType"],
+      "properties": {
+        "file": {
+          "type": "string"
+        },
+        "scriptName": {
+          "type": "string"
+        },
+        "changeType": {
+          "type": "string",
+          "enum": ["added", "removed", "updated"]
+        },
+        "before": {
+          "type": "string"
+        },
+        "after": {
+          "type": "string"
+        }
+      }
+    },
+    "reportPolicy": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["path", "ignoredPaths", "ruleCount", "requiredCommandCount", "optionalCommandCount"],
+      "properties": {
+        "path": {
+          "type": "string"
+        },
+        "ignoredPaths": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "failOn": {
+          "$ref": "#/$defs/severity"
+        },
+        "maxRisk": {
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 100
+        },
+        "ruleCount": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "requiredCommandCount": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "optionalCommandCount": {
+          "type": "integer",
+          "minimum": 0
+        }
+      }
+    },
+    "riskFinding": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["severity", "title", "detail"],
+      "properties": {
+        "ruleId": {
+          "type": "string"
+        },
+        "severity": {
+          "$ref": "#/$defs/severity"
+        },
+        "title": {
+          "type": "string"
+        },
+        "detail": {
+          "type": "string"
+        },
+        "file": {
+          "type": "string"
+        },
+        "line": {
+          "type": "integer",
+          "minimum": 1
+        },
+        "remediation": {
+          "type": "string"
+        },
+        "tags": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        }
+      }
+    },
+    "codeOwners": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["path", "ruleCount"],
+      "properties": {
+        "path": {
+          "type": "string"
+        },
+        "ruleCount": {
+          "type": "integer",
+          "minimum": 0
+        }
+      }
+    },
+    "baseline": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "path",
+        "currentStatus",
+        "currentRiskScore",
+        "riskDelta",
+        "newFindingCount",
+        "resolvedFindingCount",
+        "unchangedFindingCount"
+      ],
+      "properties": {
+        "path": {
+          "type": "string"
+        },
+        "previousStatus": {
+          "$ref": "#/$defs/patchStatus"
+        },
+        "currentStatus": {
+          "$ref": "#/$defs/patchStatus"
+        },
+        "previousRiskScore": {
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 100
+        },
+        "currentRiskScore": {
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 100
+        },
+        "riskDelta": {
+          "type": "integer",
+          "minimum": -100,
+          "maximum": 100
+        },
+        "newFindingCount": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "resolvedFindingCount": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "unchangedFindingCount": {
+          "type": "integer",
+          "minimum": 0
+        }
+      }
+    },
+    "patchVerification": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["summary", "commands"],
+      "properties": {
+        "summary": {
+          "$ref": "#/$defs/verificationSummary"
+        },
+        "commands": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/verificationCommand"
+          }
+        }
+      }
+    },
+    "verificationSummary": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["plannedRequired", "plannedOptional", "run", "passed", "failed", "timedOut", "missingRequired", "skippedOptional", "unplannedResults"],
+      "properties": {
+        "plannedRequired": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "plannedOptional": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "run": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "passed": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "failed": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "timedOut": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "missingRequired": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "skippedOptional": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "unplannedResults": {
+          "type": "integer",
+          "minimum": 0
+        }
+      }
+    },
+    "verificationCommand": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["id", "label", "command", "reason", "ecosystem", "required", "planned", "status"],
+      "properties": {
+        "id": {
+          "type": "string"
+        },
+        "label": {
+          "type": "string"
+        },
+        "command": {
+          "type": "string"
+        },
+        "reason": {
+          "type": "string"
+        },
+        "ecosystem": {
+          "$ref": "#/$defs/commandEcosystem"
+        },
+        "required": {
+          "type": "boolean"
+        },
+        "planned": {
+          "type": "boolean"
+        },
+        "status": {
+          "$ref": "#/$defs/verificationStatus"
+        },
+        "packageName": {
+          "type": "string"
+        },
+        "packagePath": {
+          "type": "string"
+        },
+        "exitCode": {
+          "type": "integer"
+        },
+        "durationMs": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "timedOut": {
+          "type": "boolean"
+        }
+      }
+    },
+    "commandPlan": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["id", "label", "command", "reason", "ecosystem", "required"],
+      "properties": {
+        "id": {
+          "type": "string"
+        },
+        "label": {
+          "type": "string"
+        },
+        "command": {
+          "type": "string"
+        },
+        "reason": {
+          "type": "string"
+        },
+        "ecosystem": {
+          "$ref": "#/$defs/commandEcosystem"
+        },
+        "required": {
+          "type": "boolean"
+        },
+        "packageName": {
+          "type": "string"
+        },
+        "packagePath": {
+          "type": "string"
+        }
+      }
+    },
+    "commandResult": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["id", "command", "exitCode", "durationMs", "stdout", "stderr"],
+      "properties": {
+        "id": {
+          "type": "string"
+        },
+        "command": {
+          "type": "string"
+        },
+        "exitCode": {
+          "type": "integer"
+        },
+        "durationMs": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "stdout": {
+          "type": "string"
+        },
+        "stderr": {
+          "type": "string"
+        },
+        "timedOut": {
+          "type": "boolean"
+        }
+      }
+    }
+  }
+}