@crvouga/atlas 1.20.0 → 1.22.0

package/packages/schema/schemas/layer-rows.schema.json

@@ -402,6 +402,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": {
@@ -459,6 +463,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",

package/packages/schema/schemas/ui-catalog-diff-result.schema.json

@@ -0,0 +1,201 @@
+{
+  "$id": "https://github.com/crvouga/atlas/schemas/ui-catalog-diff-result.schema.json",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "ok": {
+      "type": "boolean",
+      "description": "False when a layer or backend could not be read (the comparison may be wrong), or, with `--fail-on-change`, when anything differs. Otherwise true: a difference is not a failure by itself"
+    },
+    "from": {
+      "type": "object",
+      "properties": {
+        "sha": {
+          "type": "string"
+        },
+        "states": {
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 9007199254740991
+        },
+        "layers": {
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 9007199254740991
+        }
+      },
+      "required": [
+        "sha",
+        "states",
+        "layers"
+      ],
+      "additionalProperties": {}
+    },
+    "to": {
+      "type": "object",
+      "properties": {
+        "sha": {
+          "type": "string"
+        },
+        "states": {
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 9007199254740991
+        },
+        "layers": {
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 9007199254740991
+        }
+      },
+      "required": [
+        "sha",
+        "states",
+        "layers"
+      ],
+      "additionalProperties": {}
+    },
+    "summary": {
+      "type": "object",
+      "properties": {
+        "coverage": {
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 9007199254740991,
+          "description": "Pairs that stand differently (captured against failed, for example)"
+        },
+        "picture": {
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 9007199254740991,
+          "description": "Both captured, and the stored bytes differ. Not a measure of how many pixels"
+        },
+        "unverified": {
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 9007199254740991,
+          "description": "Both captured, but a side has no content hash, so whether the picture changed is unknown"
+        },
+        "added": {
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 9007199254740991,
+          "description": "Only `to` has it"
+        },
+        "removed": {
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 9007199254740991,
+          "description": "Only `from` has it. Not a regression: the other side may not have run it"
+        },
+        "unchanged": {
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 9007199254740991
+        },
+        "total": {
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 9007199254740991
+        }
+      },
+      "required": [
+        "coverage",
+        "picture",
+        "unverified",
+        "added",
+        "removed",
+        "unchanged",
+        "total"
+      ],
+      "additionalProperties": {}
+    },
+    "changes": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "state": {
+            "type": "string"
+          },
+          "title": {
+            "type": "string"
+          },
+          "profile": {
+            "type": "string"
+          },
+          "change": {
+            "type": "string",
+            "enum": [
+              "coverage",
+              "picture",
+              "unverified",
+              "added",
+              "removed"
+            ]
+          },
+          "from": {
+            "anyOf": [
+              {
+                "type": "string",
+                "enum": [
+                  "captured",
+                  "failed",
+                  "capturing",
+                  "skipped",
+                  "missing"
+                ]
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "to": {
+            "anyOf": [
+              {
+                "type": "string",
+                "enum": [
+                  "captured",
+                  "failed",
+                  "capturing",
+                  "skipped",
+                  "missing"
+                ]
+              },
+              {
+                "type": "null"
+              }
+            ]
+          }
+        },
+        "required": [
+          "state",
+          "title",
+          "profile",
+          "change",
+          "from",
+          "to"
+        ],
+        "additionalProperties": {}
+      },
+      "description": "Every pair that is not unchanged"
+    },
+    "notices": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      },
+      "description": "What could not be read. Any makes `ok` false: an unreadable layer is unknown, never unchanged"
+    }
+  },
+  "required": [
+    "ok",
+    "from",
+    "to",
+    "summary",
+    "changes",
+    "notices"
+  ],
+  "additionalProperties": {}
+}

package/packages/schema/schemas/ui-catalog-export-result.schema.json

@@ -0,0 +1,83 @@
+{
+  "$id": "https://github.com/crvouga/atlas/schemas/ui-catalog-export-result.schema.json",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "ok": {
+      "type": "boolean",
+      "const": true
+    },
+    "out": {
+      "type": "string",
+      "description": "The HTML file that was written"
+    },
+    "bytes": {
+      "type": "integer",
+      "minimum": 0,
+      "maximum": 9007199254740991,
+      "description": "Its size"
+    },
+    "states": {
+      "type": "integer",
+      "minimum": 0,
+      "maximum": 9007199254740991
+    },
+    "cells": {
+      "type": "integer",
+      "minimum": 0,
+      "maximum": 9007199254740991
+    },
+    "pictures": {
+      "type": "object",
+      "properties": {
+        "embedded": {
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 9007199254740991
+        },
+        "embeddedBytes": {
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 9007199254740991
+        },
+        "left": {
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 9007199254740991,
+          "description": "Pictures not embedded (over the size limit, not stored, not an image, or `--images none`); each is listed on the page with the reason"
+        }
+      },
+      "required": [
+        "embedded",
+        "embeddedBytes",
+        "left"
+      ],
+      "additionalProperties": {}
+    },
+    "manifest": {
+      "description": "The JSON manifest written beside it with `--manifest`, or null",
+      "type": [
+        "string",
+        "null"
+      ]
+    },
+    "warnings": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      },
+      "description": "Backends and layers that could not be read, and pictures left out. The page says so too"
+    }
+  },
+  "required": [
+    "ok",
+    "out",
+    "bytes",
+    "states",
+    "cells",
+    "pictures",
+    "manifest",
+    "warnings"
+  ],
+  "additionalProperties": {}
+}