@crvouga/atlas 1.19.0 → 1.21.0

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": {}
+}

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

@@ -0,0 +1,116 @@
+{
+  "$id": "https://github.com/crvouga/atlas/schemas/ui-catalog-publish-result.schema.json",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "ok": {
+      "type": "boolean",
+      "const": true,
+      "description": "True: the layer was written. A state whose picture could not be read is published as `failed` and named in `warnings`; it does not fail the command"
+    },
+    "store": {
+      "type": "string",
+      "description": "Where it was written: a folder, `s3://…` or a server URL"
+    },
+    "layer": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string",
+          "description": "The layer id: 64 hex digits, the SHA-256 of its content. Publishing the same input again gives the same id"
+        },
+        "kind": {
+          "type": "string",
+          "enum": [
+            "ui-state",
+            "ui-plan"
+          ],
+          "description": "`ui-state`: captures (`publish`). `ui-plan`: the expected set (`plan`)"
+        },
+        "producer": {
+          "type": "string"
+        },
+        "environment": {
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "parameters": {
+          "type": "object",
+          "propertyNames": {
+            "type": "string"
+          },
+          "additionalProperties": {
+            "type": "string"
+          },
+          "description": "The rest of the profile, such as `{ \"viewport\": \"390x844\" }`"
+        },
+        "states": {
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 9007199254740991,
+          "description": "States in the layer"
+        },
+        "captured": {
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 9007199254740991,
+          "description": "For `publish`: states that were captured (`passed`). Zero for a plan"
+        },
+        "failed": {
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 9007199254740991,
+          "description": "For `publish`: states recorded as failed, including those whose picture could not be read"
+        },
+        "pictures": {
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 9007199254740991,
+          "description": "Pictures stored in the layer"
+        },
+        "pictureBytes": {
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 9007199254740991
+        },
+        "shard": {
+          "description": "The `--shard` label, which describes the layer and never splits its slot",
+          "type": [
+            "string",
+            "null"
+          ]
+        }
+      },
+      "required": [
+        "id",
+        "kind",
+        "producer",
+        "environment",
+        "parameters",
+        "states",
+        "captured",
+        "failed",
+        "pictures",
+        "pictureBytes",
+        "shard"
+      ],
+      "additionalProperties": {}
+    },
+    "warnings": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      },
+      "description": "What was skipped and why, such as a picture file that could not be read. Never fatal"
+    }
+  },
+  "required": [
+    "ok",
+    "store",
+    "layer",
+    "warnings"
+  ],
+  "additionalProperties": {}
+}

package/packages/schema/schemas/ui-catalog-status.schema.json

@@ -0,0 +1,197 @@
+{
+  "$id": "https://github.com/crvouga/atlas/schemas/ui-catalog-status.schema.json",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "ok": {
+      "type": "boolean",
+      "description": "True only when the catalog holds a state and has no problem: nothing failed, nothing expected is missing, nothing is still being captured, and every backend and layer was read (otherwise the exit code is 1). Skipped cells are counted, not problems"
+    },
+    "summary": {
+      "type": "object",
+      "properties": {
+        "states": {
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 9007199254740991
+        },
+        "profiles": {
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 9007199254740991
+        },
+        "cells": {
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 9007199254740991,
+          "description": "States counted once per profile"
+        },
+        "coverage": {
+          "type": "object",
+          "propertyNames": {
+            "type": "string",
+            "enum": [
+              "captured",
+              "failed",
+              "capturing",
+              "skipped",
+              "missing"
+            ]
+          },
+          "additionalProperties": {
+            "type": "integer",
+            "minimum": 0,
+            "maximum": 9007199254740991
+          },
+          "required": [
+            "captured",
+            "failed",
+            "capturing",
+            "skipped",
+            "missing"
+          ],
+          "description": "Cells by coverage"
+        },
+        "undeclared": {
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 9007199254740991,
+          "description": "Captured cells no plan expects; zero when no plan exists"
+        },
+        "planned": {
+          "type": "boolean",
+          "description": "Whether any plan was published. Without one, `missing` is always zero because what should exist is unknown"
+        },
+        "surfaces": {
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 9007199254740991
+        },
+        "uncoveredSurfaces": {
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 9007199254740991
+        }
+      },
+      "required": [
+        "states",
+        "profiles",
+        "cells",
+        "coverage",
+        "undeclared",
+        "planned",
+        "surfaces",
+        "uncoveredSurfaces"
+      ],
+      "additionalProperties": {}
+    },
+    "profiles": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "key": {
+            "type": "string"
+          },
+          "label": {
+            "type": "string"
+          }
+        },
+        "required": [
+          "key",
+          "label"
+        ],
+        "additionalProperties": {}
+      }
+    },
+    "problems": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "kind": {
+            "type": "string",
+            "enum": [
+              "failed",
+              "missing",
+              "capturing",
+              "unavailable",
+              "unreadable",
+              "empty"
+            ],
+            "description": "`failed`: a capture was attempted and failed. `missing`: a plan expects it and nothing was captured. `capturing`: still being taken, so not known. `unavailable`: a backend could not be read. `unreadable`: a layer could not be read. `empty`: the catalog holds no state at all"
+          },
+          "state": {
+            "description": "The state id, for `failed`, `missing` and `capturing`",
+            "type": "string"
+          },
+          "profile": {
+            "description": "The profile label, for `failed`, `missing` and `capturing`",
+            "type": "string"
+          },
+          "detail": {
+            "description": "Why, when the producer said",
+            "type": "string"
+          }
+        },
+        "required": [
+          "kind"
+        ],
+        "additionalProperties": {}
+      }
+    },
+    "sources": {
+      "type": "object",
+      "properties": {
+        "layers": {
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 9007199254740991
+        },
+        "backends": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "id": {
+                "type": "string"
+              },
+              "label": {
+                "type": "string"
+              },
+              "available": {
+                "type": "boolean"
+              }
+            },
+            "required": [
+              "id",
+              "label",
+              "available"
+            ],
+            "additionalProperties": {}
+          }
+        },
+        "notices": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        }
+      },
+      "required": [
+        "layers",
+        "backends",
+        "notices"
+      ],
+      "additionalProperties": {}
+    }
+  },
+  "required": [
+    "ok",
+    "summary",
+    "profiles",
+    "problems",
+    "sources"
+  ],
+  "additionalProperties": {}
+}