sideby 0.0.0-stage → 0.1.0

package/schemas/doctor.json

@@ -0,0 +1,229 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "sideby/doctor.json",
+  "type": "object",
+  "required": [
+    "schemaVersion",
+    "status",
+    "accounts",
+    "general",
+    "fixes"
+  ],
+  "properties": {
+    "schemaVersion": {
+      "type": "number",
+      "const": 1
+    },
+    "status": {
+      "anyOf": [
+        {
+          "type": "string",
+          "const": "ok"
+        },
+        {
+          "type": "string",
+          "const": "issues"
+        }
+      ]
+    },
+    "accounts": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "required": [
+          "ref",
+          "family",
+          "name",
+          "kind",
+          "dir",
+          "shared",
+          "backups",
+          "findings"
+        ],
+        "properties": {
+          "ref": {
+            "type": "string"
+          },
+          "family": {
+            "type": "string"
+          },
+          "name": {
+            "type": "string"
+          },
+          "kind": {
+            "anyOf": [
+              {
+                "type": "string",
+                "const": "subscription"
+              },
+              {
+                "type": "string",
+                "const": "api"
+              }
+            ]
+          },
+          "dir": {
+            "type": "string"
+          },
+          "shared": {
+            "type": "object",
+            "required": [
+              "ok",
+              "total"
+            ],
+            "properties": {
+              "ok": {
+                "type": "number"
+              },
+              "total": {
+                "type": "number"
+              }
+            }
+          },
+          "backups": {
+            "type": "number"
+          },
+          "findings": {
+            "type": "array",
+            "items": {
+              "type": "object",
+              "required": [
+                "level",
+                "account",
+                "item",
+                "code",
+                "message",
+                "source",
+                "fixable"
+              ],
+              "properties": {
+                "level": {
+                  "anyOf": [
+                    {
+                      "type": "string",
+                      "const": "ok"
+                    },
+                    {
+                      "type": "string",
+                      "const": "warn"
+                    },
+                    {
+                      "type": "string",
+                      "const": "fail"
+                    }
+                  ]
+                },
+                "account": {
+                  "type": "string"
+                },
+                "item": {
+                  "type": "string"
+                },
+                "code": {
+                  "type": "string"
+                },
+                "message": {
+                  "type": "string"
+                },
+                "hint": {
+                  "type": "string"
+                },
+                "source": {
+                  "type": "string"
+                },
+                "fixable": {
+                  "type": "boolean"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "general": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "required": [
+          "level",
+          "account",
+          "item",
+          "code",
+          "message",
+          "source",
+          "fixable"
+        ],
+        "properties": {
+          "level": {
+            "anyOf": [
+              {
+                "type": "string",
+                "const": "ok"
+              },
+              {
+                "type": "string",
+                "const": "warn"
+              },
+              {
+                "type": "string",
+                "const": "fail"
+              }
+            ]
+          },
+          "account": {
+            "type": "string"
+          },
+          "item": {
+            "type": "string"
+          },
+          "code": {
+            "type": "string"
+          },
+          "message": {
+            "type": "string"
+          },
+          "hint": {
+            "type": "string"
+          },
+          "source": {
+            "type": "string"
+          },
+          "fixable": {
+            "type": "boolean"
+          }
+        }
+      }
+    },
+    "fixes": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "required": [
+          "account",
+          "item",
+          "code",
+          "ok",
+          "message"
+        ],
+        "properties": {
+          "account": {
+            "type": "string"
+          },
+          "item": {
+            "type": "string"
+          },
+          "code": {
+            "type": "string"
+          },
+          "ok": {
+            "type": "boolean"
+          },
+          "message": {
+            "type": "string"
+          }
+        }
+      }
+    }
+  },
+  "title": "sideby doctor --json"
+}

package/schemas/error.json

@@ -0,0 +1,25 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "sideby/error.json",
+  "type": "object",
+  "required": [
+    "schemaVersion",
+    "error",
+    "code"
+  ],
+  "properties": {
+    "schemaVersion": {
+      "type": "number",
+      "const": 1
+    },
+    "error": {
+      "type": "string",
+      "description": "What went wrong and what to do next."
+    },
+    "code": {
+      "type": "string",
+      "description": "`usage` for a malformed command line (exit 2), a reason such as `no-quota-source` or `alias-invalid`, or `error`."
+    }
+  },
+  "title": "sideby error --json"
+}

package/schemas/list.json

@@ -0,0 +1,177 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "sideby/list.json",
+  "type": "object",
+  "required": [
+    "schemaVersion",
+    "families",
+    "accounts",
+    "pluginErrors"
+  ],
+  "properties": {
+    "schemaVersion": {
+      "type": "number",
+      "const": 1
+    },
+    "families": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "required": [
+          "id",
+          "title",
+          "bin",
+          "installUrl",
+          "installed",
+          "plugin"
+        ],
+        "properties": {
+          "id": {
+            "type": "string"
+          },
+          "title": {
+            "type": "string"
+          },
+          "bin": {
+            "type": "string"
+          },
+          "installUrl": {
+            "type": "string"
+          },
+          "installed": {
+            "type": "boolean"
+          },
+          "plugin": {
+            "type": "string"
+          }
+        }
+      }
+    },
+    "accounts": {
+      "type": "array",
+      "items": {
+        "allOf": [
+          {
+            "type": "object",
+            "required": [
+              "family",
+              "name",
+              "ref",
+              "dir",
+              "isMain",
+              "kind"
+            ],
+            "properties": {
+              "family": {
+                "type": "string"
+              },
+              "name": {
+                "type": "string"
+              },
+              "ref": {
+                "type": "string"
+              },
+              "dir": {
+                "type": "string"
+              },
+              "isMain": {
+                "type": "boolean"
+              },
+              "kind": {
+                "anyOf": [
+                  {
+                    "type": "string",
+                    "const": "subscription"
+                  },
+                  {
+                    "type": "string",
+                    "const": "api"
+                  }
+                ]
+              },
+              "secretFile": {
+                "type": "string"
+              }
+            }
+          },
+          {
+            "type": "object",
+            "required": [
+              "familyTitle",
+              "hostInstalled",
+              "login"
+            ],
+            "properties": {
+              "familyTitle": {
+                "type": "string"
+              },
+              "hostInstalled": {
+                "type": "boolean"
+              },
+              "login": {
+                "anyOf": [
+                  {
+                    "type": "string",
+                    "const": "logged-in"
+                  },
+                  {
+                    "type": "string",
+                    "const": "logged-out"
+                  },
+                  {
+                    "type": "string",
+                    "const": "unknown"
+                  },
+                  {
+                    "type": "string",
+                    "const": "not-needed"
+                  }
+                ]
+              },
+              "model": {
+                "type": "string"
+              },
+              "identity": {
+                "type": "object",
+                "properties": {
+                  "email": {
+                    "type": "string"
+                  },
+                  "org": {
+                    "type": "string"
+                  }
+                },
+                "description": "Who the account is signed in as, from the host's login file: identity fields only, never a token (ADR-0003)."
+              },
+              "problems": {
+                "type": "array",
+                "items": {
+                  "type": "string"
+                }
+              }
+            }
+          }
+        ]
+      }
+    },
+    "pluginErrors": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "required": [
+          "where",
+          "message"
+        ],
+        "properties": {
+          "where": {
+            "type": "string"
+          },
+          "message": {
+            "type": "string"
+          }
+        }
+      }
+    }
+  },
+  "title": "sideby list --json"
+}

package/schemas/new.json

@@ -0,0 +1,181 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "sideby/new.json",
+  "type": "object",
+  "required": [
+    "schemaVersion",
+    "ok",
+    "account",
+    "steps",
+    "hookErrors",
+    "nextSteps"
+  ],
+  "properties": {
+    "schemaVersion": {
+      "type": "number",
+      "const": 1
+    },
+    "ok": {
+      "type": "boolean"
+    },
+    "account": {
+      "type": "object",
+      "required": [
+        "family",
+        "name",
+        "ref",
+        "dir",
+        "isMain",
+        "kind"
+      ],
+      "properties": {
+        "family": {
+          "type": "string"
+        },
+        "name": {
+          "type": "string"
+        },
+        "ref": {
+          "type": "string"
+        },
+        "dir": {
+          "type": "string"
+        },
+        "isMain": {
+          "type": "boolean"
+        },
+        "kind": {
+          "anyOf": [
+            {
+              "type": "string",
+              "const": "subscription"
+            },
+            {
+              "type": "string",
+              "const": "api"
+            }
+          ]
+        },
+        "secretFile": {
+          "type": "string"
+        }
+      }
+    },
+    "steps": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "required": [
+          "item",
+          "action",
+          "ok"
+        ],
+        "properties": {
+          "item": {
+            "type": "string"
+          },
+          "action": {
+            "type": "string"
+          },
+          "ok": {
+            "type": "boolean"
+          },
+          "message": {
+            "type": "string"
+          }
+        }
+      }
+    },
+    "hookErrors": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "required": [
+          "plugin",
+          "message"
+        ],
+        "properties": {
+          "plugin": {
+            "type": "string"
+          },
+          "message": {
+            "type": "string"
+          }
+        }
+      }
+    },
+    "nextSteps": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    },
+    "alias": {
+      "type": "object",
+      "required": [
+        "name",
+        "added"
+      ],
+      "properties": {
+        "name": {
+          "type": "string"
+        },
+        "added": {
+          "type": "boolean"
+        },
+        "message": {
+          "type": "string"
+        }
+      },
+      "description": "The `--alias` short command; `added: false` means the Account exists without it."
+    },
+    "shellInitFiles": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "required": [
+          "shell",
+          "path",
+          "ok"
+        ],
+        "properties": {
+          "shell": {
+            "anyOf": [
+              {
+                "type": "string",
+                "const": "zsh"
+              },
+              {
+                "type": "string",
+                "const": "bash"
+              }
+            ]
+          },
+          "path": {
+            "type": "string"
+          },
+          "ok": {
+            "type": "boolean"
+          },
+          "action": {
+            "anyOf": [
+              {
+                "type": "string",
+                "const": "written"
+              },
+              {
+                "type": "string",
+                "const": "unchanged"
+              }
+            ]
+          },
+          "message": {
+            "type": "string"
+          }
+        }
+      },
+      "description": "One entry per config `shellInitFile`, rewritten after the change."
+    }
+  },
+  "title": "sideby new --json"
+}