sideby 0.0.0-stage → 0.2.1

package/schemas/families.json

@@ -0,0 +1,205 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "sideby/families.json",
+  "type": "object",
+  "required": [
+    "schemaVersion",
+    "families"
+  ],
+  "properties": {
+    "schemaVersion": {
+      "type": "number",
+      "const": 1
+    },
+    "families": {
+      "type": "array",
+      "items": {
+        "allOf": [
+          {
+            "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"
+              }
+            }
+          },
+          {
+            "type": "object",
+            "required": [
+              "layout",
+              "selectVar",
+              "login",
+              "quota",
+              "usage",
+              "quotaSetup",
+              "shared"
+            ],
+            "properties": {
+              "layout": {
+                "type": "object",
+                "required": [
+                  "main",
+                  "account"
+                ],
+                "properties": {
+                  "main": {
+                    "type": "string"
+                  },
+                  "account": {
+                    "type": "string"
+                  }
+                },
+                "description": "Relative to HOME, for example `.claude` and `.claude-<name>`."
+              },
+              "selectVar": {
+                "type": "string",
+                "description": "Environment variable that selects a non-main Account directory."
+              },
+              "login": {
+                "type": "object",
+                "required": [
+                  "args",
+                  "hint"
+                ],
+                "properties": {
+                  "args": {
+                    "anyOf": [
+                      {
+                        "type": "array",
+                        "items": {
+                          "type": "string"
+                        }
+                      },
+                      {
+                        "type": "null"
+                      }
+                    ],
+                    "description": "Arguments of the Host's sign-in command; null when sign-in happens inside the Host."
+                  },
+                  "hint": {
+                    "type": "string"
+                  }
+                }
+              },
+              "quota": {
+                "type": "boolean"
+              },
+              "usage": {
+                "type": "boolean"
+              },
+              "quotaSetup": {
+                "type": "boolean",
+                "description": "Quota needs `sideby quota setup <family>` once."
+              },
+              "shared": {
+                "type": "array",
+                "items": {
+                  "type": "object",
+                  "required": [
+                    "path",
+                    "mode",
+                    "source",
+                    "meaning"
+                  ],
+                  "properties": {
+                    "path": {
+                      "type": "string"
+                    },
+                    "mode": {
+                      "anyOf": [
+                        {
+                          "type": "string",
+                          "const": "link"
+                        },
+                        {
+                          "type": "string",
+                          "const": "copy"
+                        },
+                        {
+                          "type": "string",
+                          "const": "link-or-copy"
+                        },
+                        {
+                          "type": "string",
+                          "const": "link-or-local"
+                        },
+                        {
+                          "type": "string",
+                          "const": "local"
+                        },
+                        {
+                          "type": "string",
+                          "const": "local-if-api"
+                        },
+                        {
+                          "type": "string",
+                          "const": "info"
+                        },
+                        {
+                          "type": "string",
+                          "const": "json-key"
+                        }
+                      ]
+                    },
+                    "key": {
+                      "type": "string"
+                    },
+                    "mainPath": {
+                      "type": "string"
+                    },
+                    "credential": {
+                      "type": "boolean"
+                    },
+                    "noSymlink": {
+                      "type": "boolean"
+                    },
+                    "source": {
+                      "anyOf": [
+                        {
+                          "type": "string",
+                          "const": "family"
+                        },
+                        {
+                          "type": "string",
+                          "const": "config"
+                        }
+                      ]
+                    },
+                    "meaning": {
+                      "type": "string",
+                      "description": "What the item looks like in each Account, in one fixed sentence."
+                    }
+                  }
+                }
+              }
+            }
+          }
+        ]
+      }
+    }
+  },
+  "title": "sideby families --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,199 @@
+{
+  "$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."
+    },
+    "suggestion": {
+      "type": "object",
+      "required": [
+        "name"
+      ],
+      "properties": {
+        "name": {
+          "type": "string"
+        },
+        "alias": {
+          "type": "string"
+        },
+        "aliasProblem": {
+          "type": "string"
+        }
+      },
+      "description": "Only with `--next`: the picked name, the short command that follows the existing pattern, or why that short command was left out."
+    }
+  },
+  "title": "sideby new --json"
+}

package/schemas/next.json

@@ -0,0 +1,127 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "sideby/next.json",
+  "type": "object",
+  "required": [
+    "schemaVersion",
+    "family",
+    "pick",
+    "accounts",
+    "hasQuota"
+  ],
+  "properties": {
+    "schemaVersion": {
+      "type": "number",
+      "const": 1
+    },
+    "family": {
+      "type": "string"
+    },
+    "pick": {
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ],
+      "description": "The recommended account; null when none can be used now (exit code 1)."
+    },
+    "accounts": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "required": [
+          "ref",
+          "kind",
+          "state",
+          "pressure"
+        ],
+        "properties": {
+          "ref": {
+            "type": "string"
+          },
+          "kind": {
+            "anyOf": [
+              {
+                "type": "string",
+                "const": "subscription"
+              },
+              {
+                "type": "string",
+                "const": "api"
+              }
+            ]
+          },
+          "state": {
+            "anyOf": [
+              {
+                "type": "string",
+                "const": "ready"
+              },
+              {
+                "type": "string",
+                "const": "unknown"
+              },
+              {
+                "type": "string",
+                "const": "api"
+              },
+              {
+                "type": "string",
+                "const": "full"
+              },
+              {
+                "type": "string",
+                "const": "logged-out"
+              }
+            ],
+            "description": "ready and unknown can be picked; api only with --include-api; full and logged-out never."
+          },
+          "pressure": {
+            "anyOf": [
+              {
+                "type": "number"
+              },
+              {
+                "type": "null"
+              }
+            ],
+            "description": "Used percent of the fullest window not reset yet; null without quota."
+          },
+          "resetsAt": {
+            "type": "string",
+            "description": "For full: when its last full window resets."
+          },
+          "observedAt": {
+            "type": "string",
+            "description": "When the account's quota was recorded (its last session)."
+          }
+        }
+      },
+      "description": "Every account of the family, best first."
+    },
+    "hasQuota": {
+      "type": "boolean",
+      "description": "False when no account has quota data: the pick is then a guess, and `sideby next` does not start it (exit 1)."
+    },
+    "earliestReset": {
+      "type": "object",
+      "required": [
+        "ref",
+        "at"
+      ],
+      "properties": {
+        "ref": {
+          "type": "string"
+        },
+        "at": {
+          "type": "string"
+        }
+      },
+      "description": "Set when nothing can be picked and some accounts are full: the first to come back."
+    }
+  },
+  "title": "sideby next --json"
+}