@crvouga/atlas 1.20.0 → 1.22.0

package/packages/schema/schemas/critic-watch-result.schema.json

@@ -0,0 +1,211 @@
+{
+  "$id": "https://github.com/crvouga/atlas/schemas/critic-watch-result.schema.json",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "ok": {
+      "type": "boolean",
+      "description": "False when a critic failed on any entry (the exit code is then 1)"
+    },
+    "dryRun": {
+      "type": "boolean"
+    },
+    "server": {
+      "type": "string"
+    },
+    "scope": {
+      "type": "object",
+      "propertyNames": {
+        "type": "string"
+      },
+      "additionalProperties": {
+        "type": "string"
+      },
+      "description": "The choices that narrowed the catalog, as given"
+    },
+    "stoppedBy": {
+      "type": "string",
+      "enum": [
+        "interrupted",
+        "max-batches",
+        "budget",
+        "dry-run"
+      ],
+      "description": "Why the watch ended: Ctrl-C or a signal, `--max-batches`, a budget for the whole watch, or a dry run (one read)"
+    },
+    "batches": {
+      "type": "integer",
+      "minimum": 0,
+      "maximum": 9007199254740991,
+      "description": "How many times the catalog handed over something new, the catch-up on connecting included"
+    },
+    "version": {
+      "description": "The report version the watch had reached: resume with `--since` this. Null when nothing was read",
+      "type": [
+        "string",
+        "null"
+      ]
+    },
+    "critics": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "critic": {
+            "type": "string"
+          },
+          "version": {
+            "type": "string"
+          },
+          "sendsImagesTo": {
+            "type": [
+              "string",
+              "null"
+            ]
+          },
+          "entries": {
+            "type": "integer",
+            "minimum": 0,
+            "maximum": 9007199254740991,
+            "description": "Entries handed over by the catalog, counting a changed picture again"
+          },
+          "judged": {
+            "type": "integer",
+            "minimum": 0,
+            "maximum": 9007199254740991
+          },
+          "skipped": {
+            "type": "integer",
+            "minimum": 0,
+            "maximum": 9007199254740991,
+            "description": "Entries that already had a current critique of the same identity: no call was made"
+          },
+          "failed": {
+            "type": "integer",
+            "minimum": 0,
+            "maximum": 9007199254740991,
+            "description": "Entries recorded as failed with a reason code; the next batch that brings them, or the next run, retries them"
+          },
+          "failures": {
+            "type": "array",
+            "items": {
+              "type": "object",
+              "properties": {
+                "entry": {
+                  "type": "string"
+                },
+                "reason": {
+                  "type": "string"
+                }
+              },
+              "required": [
+                "entry",
+                "reason"
+              ],
+              "additionalProperties": {}
+            }
+          },
+          "spent": {
+            "type": "object",
+            "properties": {
+              "images": {
+                "type": "number"
+              },
+              "tokens": {
+                "type": "number"
+              },
+              "costUsd": {
+                "type": "number"
+              }
+            },
+            "required": [
+              "images",
+              "tokens",
+              "costUsd"
+            ],
+            "additionalProperties": {}
+          },
+          "published": {
+            "type": "object",
+            "properties": {
+              "layers": {
+                "type": "integer",
+                "minimum": 0,
+                "maximum": 9007199254740991
+              },
+              "critiques": {
+                "type": "integer",
+                "minimum": 0,
+                "maximum": 9007199254740991
+              }
+            },
+            "required": [
+              "layers",
+              "critiques"
+            ],
+            "additionalProperties": {}
+          }
+        },
+        "required": [
+          "critic",
+          "version",
+          "sendsImagesTo",
+          "entries",
+          "judged",
+          "skipped",
+          "failed",
+          "failures",
+          "spent",
+          "published"
+        ],
+        "additionalProperties": {}
+      }
+    },
+    "spool": {
+      "type": "object",
+      "properties": {
+        "flushed": {
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 9007199254740991
+        },
+        "spooled": {
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 9007199254740991
+        },
+        "pending": {
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 9007199254740991
+        }
+      },
+      "required": [
+        "flushed",
+        "spooled",
+        "pending"
+      ],
+      "additionalProperties": {},
+      "description": "As for `critic-run-result`"
+    },
+    "warnings": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    }
+  },
+  "required": [
+    "ok",
+    "dryRun",
+    "server",
+    "scope",
+    "stoppedBy",
+    "batches",
+    "version",
+    "critics",
+    "spool",
+    "warnings"
+  ],
+  "additionalProperties": {}
+}

package/packages/schema/schemas/critique-mark.schema.json

@@ -0,0 +1,81 @@
+{
+  "$id": "https://github.com/crvouga/atlas/schemas/critique-mark.schema.json",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "schema": {
+      "type": "integer",
+      "exclusiveMinimum": 0,
+      "maximum": 9007199254740991,
+      "description": "The version of this extension. 1"
+    },
+    "subject": {
+      "type": "object",
+      "properties": {
+        "entryKey": {
+          "type": "string",
+          "minLength": 1,
+          "description": "The catalog entry the marked critique is about"
+        },
+        "imageSha256": {
+          "type": "string",
+          "minLength": 1,
+          "description": "The hash of the picture the marked critique judged, so a mark about an earlier picture is shown as that"
+        }
+      },
+      "required": [
+        "entryKey",
+        "imageSha256"
+      ],
+      "additionalProperties": {}
+    },
+    "critic": {
+      "type": "object",
+      "properties": {
+        "name": {
+          "type": "string",
+          "minLength": 1
+        },
+        "version": {
+          "type": "string",
+          "minLength": 1
+        }
+      },
+      "required": [
+        "name"
+      ],
+      "additionalProperties": {},
+      "description": "The critic whose opinion is marked"
+    },
+    "finding": {
+      "description": "The `id` of the marked finding. Absent: the critique as a whole",
+      "type": "string",
+      "minLength": 1
+    },
+    "decision": {
+      "type": "string",
+      "minLength": 1,
+      "description": "Open vocabulary; this release understands `accept` (the opinion is right) and `dismiss` (it is not). Anything else is shown as written and counts as neither"
+    },
+    "reviewer": {
+      "description": "Who marked it: a name the reviewer chose, never an account",
+      "type": "string",
+      "minLength": 1
+    },
+    "note": {
+      "description": "Why, in the reviewer's words",
+      "type": "string"
+    },
+    "layer": {
+      "description": "The layer of the critique that was marked, for tracing",
+      "type": "string"
+    }
+  },
+  "required": [
+    "schema",
+    "subject",
+    "critic",
+    "decision"
+  ],
+  "additionalProperties": {}
+}

package/packages/schema/schemas/effective-delta.schema.json

@@ -411,6 +411,10 @@
                     "area": {
                       "type": "string"
                     },
+                    "kind": {
+                      "description": "The kind of UI state the producer declared: `screen`, `overlay`, `loading`, `error`, `empty`… Open vocabulary",
+                      "type": "string"
+                    },
                     "flags": {
                       "type": "array",
                       "items": {
@@ -468,6 +472,339 @@
                   },
                   "additionalProperties": {}
                 },
+                "critique": {
+                  "description": "Only for a check of a `critique` part whose `atlas.critique` extension can be read: the opinion of an automated reviewer. An opinion, never a result: it does not decide `status`, a slot or the gate. See the critics guide",
+                  "type": "object",
+                  "properties": {
+                    "schema": {
+                      "type": "integer",
+                      "exclusiveMinimum": 0,
+                      "maximum": 9007199254740991,
+                      "description": "The version of this extension. 1"
+                    },
+                    "subject": {
+                      "type": "object",
+                      "properties": {
+                        "entryKey": {
+                          "type": "string",
+                          "minLength": 1,
+                          "description": "The catalog entry that was judged"
+                        },
+                        "imageSha256": {
+                          "type": "string",
+                          "minLength": 1,
+                          "description": "The hash of the exact image bytes that were judged. When the entry's image changes, this critique judged an earlier image"
+                        },
+                        "state": {
+                          "description": "The kind of UI state: `screen`, `overlay`, `loading`, `error`, `empty`…",
+                          "type": "string",
+                          "minLength": 1
+                        }
+                      },
+                      "required": [
+                        "entryKey",
+                        "imageSha256"
+                      ],
+                      "additionalProperties": {}
+                    },
+                    "critic": {
+                      "type": "object",
+                      "properties": {
+                        "name": {
+                          "type": "string",
+                          "minLength": 1
+                        },
+                        "version": {
+                          "type": "string",
+                          "minLength": 1,
+                          "description": "Of the critic's own logic. A newer version replaces an older one"
+                        },
+                        "kind": {
+                          "description": "Open vocabulary: `model`, `llm`, `ml`, `heuristic`…",
+                          "type": "string",
+                          "minLength": 1
+                        }
+                      },
+                      "required": [
+                        "name",
+                        "version"
+                      ],
+                      "additionalProperties": {}
+                    },
+                    "model": {
+                      "type": "object",
+                      "properties": {
+                        "id": {
+                          "type": "string",
+                          "minLength": 1
+                        },
+                        "provider": {
+                          "type": "string"
+                        }
+                      },
+                      "required": [
+                        "id"
+                      ],
+                      "additionalProperties": {}
+                    },
+                    "parameters": {
+                      "description": "Everything else that explains the result: temperature, seed, the SHA-256 of the rubric",
+                      "type": "object",
+                      "propertyNames": {
+                        "type": "string"
+                      },
+                      "additionalProperties": {}
+                    },
+                    "verdict": {
+                      "type": "object",
+                      "properties": {
+                        "score": {
+                          "description": "A finite number. `scale` says what it means",
+                          "type": "number"
+                        },
+                        "scale": {
+                          "description": "For example `0..1, higher is better`",
+                          "type": "string"
+                        },
+                        "label": {
+                          "description": "Open vocabulary, conventionally `ok` or `needs-polish`",
+                          "type": "string"
+                        },
+                        "confidence": {
+                          "type": "number",
+                          "minimum": 0,
+                          "maximum": 1
+                        },
+                        "relative": {
+                          "type": "object",
+                          "properties": {
+                            "stateKind": {
+                              "type": "string",
+                              "minLength": 1,
+                              "description": "The kind of UI state the score is relative to: `screen`, `overlay`, `loading`, `error`, `empty`…"
+                            },
+                            "percentile": {
+                              "description": "Where the score falls among the project's scores of the same state kind, 0..100, higher is better",
+                              "type": "number",
+                              "minimum": 0,
+                              "maximum": 100
+                            },
+                            "sampleSize": {
+                              "description": "How many scores of that state kind the percentile is over",
+                              "type": "integer",
+                              "minimum": 0,
+                              "maximum": 9007199254740991
+                            },
+                            "previousScore": {
+                              "description": "The same entry's score for its previous image, from the same critic",
+                              "type": "number"
+                            },
+                            "delta": {
+                              "description": "`score` minus `previousScore`",
+                              "type": "number"
+                            }
+                          },
+                          "required": [
+                            "stateKind"
+                          ],
+                          "additionalProperties": {}
+                        }
+                      },
+                      "additionalProperties": {}
+                    },
+                    "findings": {
+                      "type": "array",
+                      "items": {
+                        "type": "object",
+                        "properties": {
+                          "id": {
+                            "description": "Stable within the critique, so a reviewer can mark this finding valid or not",
+                            "type": "string",
+                            "minLength": 1
+                          },
+                          "category": {
+                            "description": "Open vocabulary: `spacing`, `contrast`, `alignment`, `overflow`, `hierarchy`…",
+                            "type": "string",
+                            "minLength": 1
+                          },
+                          "severity": {
+                            "description": "Open vocabulary, conventionally `info`, `minor`, `major`",
+                            "type": "string",
+                            "minLength": 1
+                          },
+                          "confidence": {
+                            "type": "number",
+                            "minimum": 0,
+                            "maximum": 1
+                          },
+                          "region": {
+                            "type": "object",
+                            "properties": {
+                              "unit": {
+                                "type": "string",
+                                "minLength": 1,
+                                "description": "`px` (pixels of the stored image) or `normalized` (0..1 of its width and height). Open vocabulary"
+                              },
+                              "x": {
+                                "type": "number"
+                              },
+                              "y": {
+                                "type": "number"
+                              },
+                              "w": {
+                                "type": "number",
+                                "minimum": 0
+                              },
+                              "h": {
+                                "type": "number",
+                                "minimum": 0
+                              }
+                            },
+                            "required": [
+                              "unit",
+                              "x",
+                              "y",
+                              "w",
+                              "h"
+                            ],
+                            "additionalProperties": {}
+                          },
+                          "rationale": {
+                            "type": "string"
+                          },
+                          "suggestion": {
+                            "type": "string"
+                          }
+                        },
+                        "additionalProperties": {}
+                      }
+                    },
+                    "failure": {
+                      "type": "object",
+                      "properties": {
+                        "reason": {
+                          "type": "string",
+                          "minLength": 1
+                        },
+                        "message": {
+                          "type": "string"
+                        }
+                      },
+                      "required": [
+                        "reason"
+                      ],
+                      "additionalProperties": {}
+                    },
+                    "usage": {
+                      "type": "object",
+                      "properties": {
+                        "inputTokens": {
+                          "type": "number",
+                          "minimum": 0
+                        },
+                        "outputTokens": {
+                          "type": "number",
+                          "minimum": 0
+                        },
+                        "latencyMs": {
+                          "type": "number",
+                          "minimum": 0
+                        },
+                        "costUsd": {
+                          "type": "number",
+                          "minimum": 0
+                        }
+                      },
+                      "additionalProperties": {}
+                    }
+                  },
+                  "required": [
+                    "schema",
+                    "subject",
+                    "critic"
+                  ],
+                  "additionalProperties": {}
+                },
+                "critiqueMark": {
+                  "description": "Only for a check of a `critique` part whose `atlas.critique-mark` extension can be read: a person's accept or dismiss of a critic's opinion. Evidence, never a result: it does not decide `status`, a slot or the gate. See the critics guide",
+                  "type": "object",
+                  "properties": {
+                    "schema": {
+                      "type": "integer",
+                      "exclusiveMinimum": 0,
+                      "maximum": 9007199254740991,
+                      "description": "The version of this extension. 1"
+                    },
+                    "subject": {
+                      "type": "object",
+                      "properties": {
+                        "entryKey": {
+                          "type": "string",
+                          "minLength": 1,
+                          "description": "The catalog entry the marked critique is about"
+                        },
+                        "imageSha256": {
+                          "type": "string",
+                          "minLength": 1,
+                          "description": "The hash of the picture the marked critique judged, so a mark about an earlier picture is shown as that"
+                        }
+                      },
+                      "required": [
+                        "entryKey",
+                        "imageSha256"
+                      ],
+                      "additionalProperties": {}
+                    },
+                    "critic": {
+                      "type": "object",
+                      "properties": {
+                        "name": {
+                          "type": "string",
+                          "minLength": 1
+                        },
+                        "version": {
+                          "type": "string",
+                          "minLength": 1
+                        }
+                      },
+                      "required": [
+                        "name"
+                      ],
+                      "additionalProperties": {},
+                      "description": "The critic whose opinion is marked"
+                    },
+                    "finding": {
+                      "description": "The `id` of the marked finding. Absent: the critique as a whole",
+                      "type": "string",
+                      "minLength": 1
+                    },
+                    "decision": {
+                      "type": "string",
+                      "minLength": 1,
+                      "description": "Open vocabulary; this release understands `accept` (the opinion is right) and `dismiss` (it is not). Anything else is shown as written and counts as neither"
+                    },
+                    "reviewer": {
+                      "description": "Who marked it: a name the reviewer chose, never an account",
+                      "type": "string",
+                      "minLength": 1
+                    },
+                    "note": {
+                      "description": "Why, in the reviewer's words",
+                      "type": "string"
+                    },
+                    "layer": {
+                      "description": "The layer of the critique that was marked, for tracing",
+                      "type": "string"
+                    }
+                  },
+                  "required": [
+                    "schema",
+                    "subject",
+                    "critic",
+                    "decision"
+                  ],
+                  "additionalProperties": {}
+                },
                 "recording": {
                   "description": "What became of the check's expected recording: uploaded, referenced, skipped, unresolved or not-applicable. Independent of `status`",
                   "type": "object",