@intentius/sql-yodeler 0.3.0 → 0.5.0

package/schemas/plan.schema.json

@@ -66,6 +66,33 @@
             "type": "object"
           }
         },
+        "access": {
+          "description": "Whether access control is managed in the environment (environments.<env>.access in yodel.config.ts, else sql.profiles.<env>.access) and the plan's access changes: on Postgres policies, row-level security, roles and privileges; on ClickHouse users, roles, row policies and grants. byHand marks a revoke of a privilege no declaration grants: one granted by hand (or whose declaration was deleted), which the apply takes away. On ClickHouse every revoke is one.",
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["managed", "source", "changes"],
+          "properties": {
+            "managed": { "type": "boolean" },
+            "source": { "type": "string" },
+            "changes": {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "additionalProperties": false,
+                "required": ["object", "rule", "class", "field"],
+                "properties": {
+                  "object": { "type": "string" },
+                  "rule": { "type": "string" },
+                  "class": { "type": "string" },
+                  "field": { "type": "string" },
+                  "before": {},
+                  "after": {},
+                  "byHand": { "const": true }
+                }
+              }
+            }
+          }
+        },
         "mode": false
       }
     },
@@ -278,6 +305,10 @@
           "description": "The command a person runs to approve this plan. An agent prints it and never runs it.",
           "type": "string"
         },
+        "approvalMode": {
+          "description": "Which approvals of the migrations Op's gate count, as yodel.config.ts at the base commit has it, when not ledger: sealed counts only an approval sealed by a key the signers file at base lists for its approver.",
+          "enum": ["sealed"]
+        },
         "approval": {
           "description": "The newest approval of the gate in chant's ledger.",
           "type": "object",
@@ -334,6 +365,10 @@
                   "$ref": "#/$defs/moved"
                 }
               }
+            },
+            "uncounted": {
+              "description": "The gate's approval mode does not count it (under sealed, it is not sealed by a signer at the base commit), and why.",
+              "type": "string"
             }
           }
         },
@@ -400,6 +435,10 @@
               "description": "The chant approve command for the wave, for a person to run.",
               "type": "string"
             },
+            "approval": {
+              "description": "Which approvals of the wave's digest count, as yodel.config.ts at the base commit has the wave, when not ledger.",
+              "enum": ["pr-review", "sealed"]
+            },
             "promotions": {
               "description": "Each environment this one requires (waves[].requires) and what its history records of each pending migration.",
               "type": "array",

package/schemas/report.schema.json

@@ -70,7 +70,7 @@
         "id": { "type": "string", "description": "A hash of the entry and its source: the same sources give the same id." },
         "at": { "type": "string" },
         "environment": { "type": "string" },
-        "kind": { "enum": ["approval-requested", "approved", "override", "silenced", "applied", "refused", "failed", "repaired", "reverted"] },
+        "kind": { "enum": ["approval-requested", "approved", "override", "silenced", "applied", "refused", "failed", "repaired", "reverted", "step"] },
         "by": { "type": "string" },
         "migration": { "type": "string" },
         "digest": { "type": "string" },

package/schemas/test.schema.json

@@ -0,0 +1,41 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://intentius.io/sql-yodeler/schemas/v1/test.schema.json",
+  "title": "yodel test --json",
+  "description": "Version 1. The cases of tests/*.test.ts, each run on a database built from the migrations on a throwaway server: what passed, what failed and why. Within a version, fields are only added; a reader ignores fields it does not know.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": ["files", "summary", "cases"],
+  "properties": {
+    "environment": { "description": "The throwaway server's profile.", "type": "string" },
+    "dialect": { "enum": ["clickhouse", "postgres"] },
+    "where": { "description": "The server, without credentials.", "type": "string" },
+    "scope": { "description": "The databases (ClickHouse) or schemas (Postgres) each case empties and builds.", "$ref": "common.schema.json#/$defs/stringList" },
+    "reset": { "description": "The target held what the history names, and was emptied first (--reset).", "type": "boolean" },
+    "files": { "description": "The test files, relative to the project directory.", "$ref": "common.schema.json#/$defs/stringList" },
+    "summary": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["passed", "failed", "errors"],
+      "properties": { "passed": { "type": "integer", "minimum": 0 }, "failed": { "type": "integer", "minimum": 0 }, "errors": { "type": "integer", "minimum": 0 } }
+    },
+    "cases": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "additionalProperties": false,
+        "required": ["file", "name", "status", "ms", "failures", "before", "after"],
+        "properties": {
+          "file": { "type": "string" },
+          "name": { "type": "string" },
+          "status": { "description": "passed: every expectation held. failed: one did not. error: the case could not run (a migration or seed statement failed, an unknown migration id).", "enum": ["passed", "failed", "error"] },
+          "ms": { "type": "integer", "minimum": 0 },
+          "failures": { "description": "The expectations that did not hold, one line each.", "$ref": "common.schema.json#/$defs/stringList" },
+          "error": { "type": "string" },
+          "before": { "description": "The migrations replayed before the seed.", "$ref": "common.schema.json#/$defs/stringList" },
+          "after": { "description": "The migrations run after the seed, with their steps.", "$ref": "common.schema.json#/$defs/stringList" }
+        }
+      }
+    }
+  }
+}