mustflow 2.84.0 → 2.99.0

package/schemas/dependency-graph-report.schema.json

@@ -0,0 +1,149 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://mustflow.github.io/schemas/dependency-graph-report.schema.json",
+  "title": "mustflow dependency-graph report",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "schema_version",
+    "command",
+    "pack_id",
+    "script_id",
+    "script_ref",
+    "action",
+    "status",
+    "ok",
+    "mustflow_root",
+    "policy",
+    "input_hash",
+    "targets",
+    "nodes",
+    "edges",
+    "cycles",
+    "truncated",
+    "findings",
+    "issues"
+  ],
+  "properties": {
+    "schema_version": { "const": "1" },
+    "command": { "const": "script-pack" },
+    "pack_id": { "const": "code" },
+    "script_id": { "const": "dependency-graph" },
+    "script_ref": { "const": "code/dependency-graph" },
+    "action": { "const": "scan" },
+    "status": { "enum": ["passed", "failed", "error"] },
+    "ok": { "type": "boolean" },
+    "mustflow_root": { "type": "string" },
+    "policy": { "$ref": "#/$defs/policy" },
+    "input_hash": { "$ref": "#/$defs/sha256" },
+    "targets": { "type": "array", "items": { "$ref": "#/$defs/target" } },
+    "nodes": { "type": "array", "items": { "$ref": "#/$defs/node" } },
+    "edges": { "type": "array", "items": { "$ref": "#/$defs/edge" } },
+    "cycles": {
+      "type": "array",
+      "items": {
+        "type": "array",
+        "items": { "type": "string" }
+      }
+    },
+    "truncated": { "type": "boolean" },
+    "findings": { "type": "array", "items": { "$ref": "#/$defs/finding" } },
+    "issues": { "type": "array", "items": { "type": "string" } }
+  },
+  "$defs": {
+    "sha256": { "type": "string", "pattern": "^sha256:[a-f0-9]{64}$" },
+    "stringArray": { "type": "array", "items": { "type": "string" } },
+    "language": {
+      "enum": [
+        "typescript",
+        "tsx",
+        "javascript",
+        "jsx",
+        "javascript-module",
+        "javascript-commonjs",
+        "json",
+        "other"
+      ]
+    },
+    "targetKind": { "enum": ["file", "directory", "missing", "other", "unknown"] },
+    "edgeKind": { "enum": ["static_import", "static_export", "dynamic_import", "require"] },
+    "policy": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "max_file_bytes",
+        "max_files",
+        "max_depth",
+        "max_nodes",
+        "max_edges",
+        "extensions",
+        "ignored_directories"
+      ],
+      "properties": {
+        "max_file_bytes": { "type": "integer", "minimum": 1 },
+        "max_files": { "type": "integer", "minimum": 1 },
+        "max_depth": { "type": "integer", "minimum": 1 },
+        "max_nodes": { "type": "integer", "minimum": 1 },
+        "max_edges": { "type": "integer", "minimum": 1 },
+        "extensions": { "$ref": "#/$defs/stringArray" },
+        "ignored_directories": { "$ref": "#/$defs/stringArray" }
+      }
+    },
+    "target": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["input", "path", "exists", "kind", "language"],
+      "properties": {
+        "input": { "type": "string" },
+        "path": { "type": "string" },
+        "exists": { "type": ["boolean", "null"] },
+        "kind": { "$ref": "#/$defs/targetKind" },
+        "language": { "$ref": "#/$defs/language" }
+      }
+    },
+    "node": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["path", "language", "target", "depth", "import_count", "importer_count"],
+      "properties": {
+        "path": { "type": "string" },
+        "language": { "$ref": "#/$defs/language" },
+        "target": { "type": "boolean" },
+        "depth": { "type": "integer", "minimum": 0 },
+        "import_count": { "type": "integer", "minimum": 0 },
+        "importer_count": { "type": "integer", "minimum": 0 }
+      }
+    },
+    "edge": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["source_path", "target_path", "specifier", "line", "kind"],
+      "properties": {
+        "source_path": { "type": "string" },
+        "target_path": { "type": "string" },
+        "specifier": { "type": "string" },
+        "line": { "type": "integer", "minimum": 1 },
+        "kind": { "$ref": "#/$defs/edgeKind" }
+      }
+    },
+    "finding": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["code", "severity", "message", "path"],
+      "properties": {
+        "code": {
+          "enum": [
+            "dependency_graph_path_outside_root",
+            "dependency_graph_unreadable_path",
+            "dependency_graph_max_files_exceeded",
+            "dependency_graph_max_nodes_exceeded",
+            "dependency_graph_max_edges_exceeded"
+          ]
+        },
+        "severity": { "enum": ["low", "medium", "high", "critical"] },
+        "message": { "type": "string" },
+        "path": { "type": "string" }
+      }
+    }
+  }
+}

package/schemas/env-contract-report.schema.json

@@ -0,0 +1,203 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://mustflow.github.io/schemas/env-contract-report.schema.json",
+  "title": "mustflow env-contract report",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "schema_version",
+    "command",
+    "pack_id",
+    "script_id",
+    "script_ref",
+    "action",
+    "status",
+    "ok",
+    "mustflow_root",
+    "policy",
+    "input_hash",
+    "targets",
+    "summary",
+    "keys",
+    "truncated",
+    "findings",
+    "issues"
+  ],
+  "properties": {
+    "schema_version": { "const": "1" },
+    "command": { "const": "script-pack" },
+    "pack_id": { "const": "repo" },
+    "script_id": { "const": "env-contract" },
+    "script_ref": { "const": "repo/env-contract" },
+    "action": { "const": "scan" },
+    "status": { "enum": ["passed", "failed", "error"] },
+    "ok": { "type": "boolean" },
+    "mustflow_root": { "type": "string" },
+    "policy": { "$ref": "#/$defs/policy" },
+    "input_hash": { "$ref": "#/$defs/sha256" },
+    "targets": {
+      "type": "array",
+      "items": { "$ref": "#/$defs/target" }
+    },
+    "summary": { "$ref": "#/$defs/summary" },
+    "keys": {
+      "type": "array",
+      "items": { "$ref": "#/$defs/envKey" }
+    },
+    "truncated": { "type": "boolean" },
+    "findings": {
+      "type": "array",
+      "items": { "$ref": "#/$defs/finding" }
+    },
+    "issues": {
+      "type": "array",
+      "items": { "type": "string" }
+    }
+  },
+  "$defs": {
+    "sha256": {
+      "type": "string",
+      "pattern": "^sha256:[a-f0-9]{64}$"
+    },
+    "stringArray": {
+      "type": "array",
+      "items": { "type": "string" }
+    },
+    "policy": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "max_file_bytes",
+        "max_files",
+        "max_keys",
+        "extensions",
+        "env_example_names",
+        "skipped_secret_names",
+        "ignored_directories"
+      ],
+      "properties": {
+        "max_file_bytes": { "type": "integer", "minimum": 1 },
+        "max_files": { "type": "integer", "minimum": 1 },
+        "max_keys": { "type": "integer", "minimum": 1 },
+        "extensions": { "$ref": "#/$defs/stringArray" },
+        "env_example_names": { "$ref": "#/$defs/stringArray" },
+        "skipped_secret_names": { "$ref": "#/$defs/stringArray" },
+        "ignored_directories": { "$ref": "#/$defs/stringArray" }
+      }
+    },
+    "target": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["input", "path", "exists", "kind"],
+      "properties": {
+        "input": { "type": "string" },
+        "path": { "type": "string" },
+        "exists": { "type": ["boolean", "null"] },
+        "kind": { "enum": ["file", "directory", "missing", "other", "unknown"] }
+      }
+    },
+    "summary": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "target_count",
+        "file_count",
+        "key_count",
+        "code_key_count",
+        "example_key_count",
+        "documented_key_count",
+        "ci_key_count"
+      ],
+      "properties": {
+        "target_count": { "type": "integer", "minimum": 0 },
+        "file_count": { "type": "integer", "minimum": 0 },
+        "key_count": { "type": "integer", "minimum": 0 },
+        "code_key_count": { "type": "integer", "minimum": 0 },
+        "example_key_count": { "type": "integer", "minimum": 0 },
+        "documented_key_count": { "type": "integer", "minimum": 0 },
+        "ci_key_count": { "type": "integer", "minimum": 0 }
+      }
+    },
+    "surface": {
+      "enum": ["code", "config", "ci", "docs", "example"]
+    },
+    "referenceKind": {
+      "enum": [
+        "process_env_dot",
+        "process_env_bracket",
+        "process_env_destructure",
+        "bun_env_dot",
+        "import_meta_env",
+        "env_example",
+        "ci_secret",
+        "ci_var",
+        "ci_env",
+        "documented"
+      ]
+    },
+    "reference": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["key", "path", "line", "surface", "kind"],
+      "properties": {
+        "key": { "type": "string" },
+        "path": { "type": "string" },
+        "line": { "type": "integer", "minimum": 1 },
+        "surface": { "$ref": "#/$defs/surface" },
+        "kind": { "$ref": "#/$defs/referenceKind" }
+      }
+    },
+    "envKey": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "key",
+        "used_in_code",
+        "declared_in_example",
+        "referenced_in_ci",
+        "documented",
+        "secret_like",
+        "public_like",
+        "source_count",
+        "sources"
+      ],
+      "properties": {
+        "key": { "type": "string" },
+        "used_in_code": { "type": "boolean" },
+        "declared_in_example": { "type": "boolean" },
+        "referenced_in_ci": { "type": "boolean" },
+        "documented": { "type": "boolean" },
+        "secret_like": { "type": "boolean" },
+        "public_like": { "type": "boolean" },
+        "source_count": { "type": "integer", "minimum": 0 },
+        "sources": {
+          "type": "array",
+          "items": { "$ref": "#/$defs/reference" }
+        }
+      }
+    },
+    "finding": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["code", "severity", "message", "path"],
+      "properties": {
+        "code": {
+          "enum": [
+            "env_contract_path_outside_root",
+            "env_contract_unreadable_path",
+            "env_contract_secret_file_skipped",
+            "env_contract_max_files_exceeded",
+            "env_contract_max_keys_exceeded",
+            "env_contract_missing_example",
+            "env_contract_unused_example",
+            "env_contract_secret_like_public_name"
+          ]
+        },
+        "severity": { "enum": ["low", "medium", "high", "critical"] },
+        "message": { "type": "string" },
+        "path": { "type": "string" },
+        "key": { "type": "string" }
+      }
+    }
+  }
+}

package/schemas/import-cycle-report.schema.json

@@ -0,0 +1,157 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://mustflow.github.io/schemas/import-cycle-report.schema.json",
+  "title": "mustflow import-cycle report",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "schema_version",
+    "command",
+    "pack_id",
+    "script_id",
+    "script_ref",
+    "action",
+    "status",
+    "ok",
+    "mustflow_root",
+    "policy",
+    "input_hash",
+    "targets",
+    "graph",
+    "cycles",
+    "truncated",
+    "findings",
+    "issues"
+  ],
+  "properties": {
+    "schema_version": { "const": "1" },
+    "command": { "const": "script-pack" },
+    "pack_id": { "const": "code" },
+    "script_id": { "const": "import-cycle" },
+    "script_ref": { "const": "code/import-cycle" },
+    "action": { "const": "check" },
+    "status": { "enum": ["passed", "failed", "error"] },
+    "ok": { "type": "boolean" },
+    "mustflow_root": { "type": "string" },
+    "policy": { "$ref": "#/$defs/policy" },
+    "input_hash": { "$ref": "#/$defs/sha256" },
+    "targets": { "type": "array", "items": { "$ref": "#/$defs/target" } },
+    "graph": { "$ref": "#/$defs/graph" },
+    "cycles": { "type": "array", "items": { "$ref": "#/$defs/cycle" } },
+    "truncated": { "type": "boolean" },
+    "findings": { "type": "array", "items": { "$ref": "#/$defs/finding" } },
+    "issues": { "type": "array", "items": { "type": "string" } }
+  },
+  "$defs": {
+    "sha256": { "type": "string", "pattern": "^sha256:[a-f0-9]{64}$" },
+    "stringArray": { "type": "array", "items": { "type": "string" } },
+    "language": {
+      "enum": [
+        "typescript",
+        "tsx",
+        "javascript",
+        "jsx",
+        "javascript-module",
+        "javascript-commonjs",
+        "json",
+        "other"
+      ]
+    },
+    "targetKind": { "enum": ["file", "directory", "missing", "other", "unknown"] },
+    "edgeKind": { "enum": ["static_import", "static_export", "dynamic_import", "require"] },
+    "policy": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "max_file_bytes",
+        "max_files",
+        "max_depth",
+        "max_nodes",
+        "max_edges",
+        "extensions",
+        "ignored_directories",
+        "max_cycles"
+      ],
+      "properties": {
+        "max_file_bytes": { "type": "integer", "minimum": 1 },
+        "max_files": { "type": "integer", "minimum": 1 },
+        "max_depth": { "type": "integer", "minimum": 1 },
+        "max_nodes": { "type": "integer", "minimum": 1 },
+        "max_edges": { "type": "integer", "minimum": 1 },
+        "extensions": { "$ref": "#/$defs/stringArray" },
+        "ignored_directories": { "$ref": "#/$defs/stringArray" },
+        "max_cycles": { "type": "integer", "minimum": 1 }
+      }
+    },
+    "target": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["input", "path", "exists", "kind", "language"],
+      "properties": {
+        "input": { "type": "string" },
+        "path": { "type": "string" },
+        "exists": { "type": ["boolean", "null"] },
+        "kind": { "$ref": "#/$defs/targetKind" },
+        "language": { "$ref": "#/$defs/language" }
+      }
+    },
+    "graph": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["script_ref", "status", "node_count", "edge_count", "cycle_hint_count", "truncated"],
+      "properties": {
+        "script_ref": { "const": "code/dependency-graph" },
+        "status": { "enum": ["passed", "failed", "error"] },
+        "node_count": { "type": "integer", "minimum": 0 },
+        "edge_count": { "type": "integer", "minimum": 0 },
+        "cycle_hint_count": { "type": "integer", "minimum": 0 },
+        "truncated": { "type": "boolean" }
+      }
+    },
+    "edge": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["source_path", "target_path", "specifier", "line", "kind"],
+      "properties": {
+        "source_path": { "type": "string" },
+        "target_path": { "type": "string" },
+        "specifier": { "type": "string" },
+        "line": { "type": "integer", "minimum": 1 },
+        "kind": { "$ref": "#/$defs/edgeKind" }
+      }
+    },
+    "cycle": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["cycle_id", "path_count", "paths", "edges"],
+      "properties": {
+        "cycle_id": { "type": "string", "pattern": "^cycle:[a-f0-9]{12}$" },
+        "path_count": { "type": "integer", "minimum": 0 },
+        "paths": { "$ref": "#/$defs/stringArray" },
+        "edges": { "type": "array", "items": { "$ref": "#/$defs/edge" } }
+      }
+    },
+    "finding": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["code", "severity", "message", "path"],
+      "properties": {
+        "code": {
+          "enum": [
+            "dependency_graph_path_outside_root",
+            "dependency_graph_unreadable_path",
+            "dependency_graph_max_files_exceeded",
+            "dependency_graph_max_nodes_exceeded",
+            "dependency_graph_max_edges_exceeded",
+            "import_cycle_detected",
+            "import_cycle_max_cycles_exceeded"
+          ]
+        },
+        "severity": { "enum": ["low", "medium", "high", "critical"] },
+        "message": { "type": "string" },
+        "path": { "type": "string" },
+        "cycle_id": { "type": "string", "pattern": "^cycle:[a-f0-9]{12}$" }
+      }
+    }
+  }
+}