@chipschat/protocol 0.0.0-stage → 1.0.1

package/generated/schema/harness.transferred.json

@@ -0,0 +1,117 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "v": {
+      "type": "number",
+      "const": 1,
+      "description": "Protocol major version."
+    },
+    "type": {
+      "type": "string",
+      "const": "harness.transferred"
+    },
+    "id": {
+      "type": "string",
+      "pattern": "^evt_[0-7][0-9A-HJKMNP-TV-Z]{25}$",
+      "description": "The event's own id. Stable across a retry of the same event."
+    },
+    "ts": {
+      "type": "string",
+      "format": "date-time",
+      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
+      "description": "When it happened, by Chips' clock. Stamped on the way in; a value the sender writes is replaced."
+    },
+    "workspace_id": {
+      "type": "string",
+      "pattern": "^ws_[0-7][0-9A-HJKMNP-TV-Z]{25}$",
+      "description": "A workspace identifier: `ws_` followed by a ULID."
+    },
+    "space_id": {
+      "description": "The space, when the event belongs to one.",
+      "type": "string",
+      "pattern": "^spc_[0-7][0-9A-HJKMNP-TV-Z]{25}$"
+    },
+    "run_id": {
+      "description": "The run, when the event belongs to one.",
+      "type": "string",
+      "pattern": "^run_[0-7][0-9A-HJKMNP-TV-Z]{25}$"
+    },
+    "seq": {
+      "description": "Assigned by the server on append, monotonic per workspace. Absent on the way in.",
+      "type": "integer",
+      "exclusiveMinimum": 0,
+      "maximum": 9007199254740991
+    },
+    "idempotency_key": {
+      "description": "Required on every client-originated write. Sending the same key twice is a no-op.",
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 200
+    },
+    "actor": {
+      "type": "object",
+      "properties": {
+        "kind": {
+          "type": "string",
+          "enum": [
+            "person",
+            "harness",
+            "agent",
+            "system"
+          ],
+          "description": "Whether a person, a harness, one of a harness's agents or Chips itself acted."
+        },
+        "id": {
+          "type": "string",
+          "minLength": 1,
+          "description": "The participant id, or `system` for Chips."
+        },
+        "harness_id": {
+          "description": "For an agent: the harness it speaks through, whose budget and runs are the agent's (ADR 0087). Filled in by Chips.",
+          "type": "string",
+          "pattern": "^hrn_[0-7][0-9A-HJKMNP-TV-Z]{25}$"
+        }
+      },
+      "required": [
+        "kind",
+        "id"
+      ],
+      "description": "The participant an event is attributed to."
+    },
+    "harness_id": {
+      "type": "string",
+      "pattern": "^hrn_[0-7][0-9A-HJKMNP-TV-Z]{25}$",
+      "description": "The harness handed over."
+    },
+    "from_owner_id": {
+      "type": "string",
+      "pattern": "^usr_[0-7][0-9A-HJKMNP-TV-Z]{25}$",
+      "description": "Who owned it until now."
+    },
+    "to_owner_id": {
+      "type": "string",
+      "pattern": "^usr_[0-7][0-9A-HJKMNP-TV-Z]{25}$",
+      "description": "Who owns it from here."
+    },
+    "reason": {
+      "description": "Why, for the audit.",
+      "type": "string",
+      "maxLength": 400
+    }
+  },
+  "required": [
+    "v",
+    "type",
+    "id",
+    "ts",
+    "workspace_id",
+    "actor",
+    "harness_id",
+    "from_owner_id",
+    "to_owner_id"
+  ],
+  "description": "A harness was handed to another person, who is accountable for it from here: its approvals default to them, and its tokens are theirs.",
+  "$id": "https://chipschat.ai/schema/v1/harness.transferred.json",
+  "title": "HarnessTransferred"
+}

package/generated/schema/hello.json

@@ -0,0 +1,509 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "v": {
+      "type": "number",
+      "const": 1,
+      "description": "Protocol major version."
+    },
+    "type": {
+      "type": "string",
+      "const": "hello"
+    },
+    "id": {
+      "type": "string",
+      "pattern": "^evt_[0-7][0-9A-HJKMNP-TV-Z]{25}$",
+      "description": "The event's own id. Stable across a retry of the same event."
+    },
+    "ts": {
+      "type": "string",
+      "format": "date-time",
+      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
+      "description": "When it happened, by Chips' clock. Stamped on the way in; a value the sender writes is replaced."
+    },
+    "workspace_id": {
+      "type": "string",
+      "pattern": "^ws_[0-7][0-9A-HJKMNP-TV-Z]{25}$",
+      "description": "A workspace identifier: `ws_` followed by a ULID."
+    },
+    "space_id": {
+      "description": "The space, when the event belongs to one.",
+      "type": "string",
+      "pattern": "^spc_[0-7][0-9A-HJKMNP-TV-Z]{25}$"
+    },
+    "run_id": {
+      "description": "The run, when the event belongs to one.",
+      "type": "string",
+      "pattern": "^run_[0-7][0-9A-HJKMNP-TV-Z]{25}$"
+    },
+    "seq": {
+      "description": "Assigned by the server on append, monotonic per workspace. Absent on the way in.",
+      "type": "integer",
+      "exclusiveMinimum": 0,
+      "maximum": 9007199254740991
+    },
+    "idempotency_key": {
+      "description": "Required on every client-originated write. Sending the same key twice is a no-op.",
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 200
+    },
+    "actor": {
+      "type": "object",
+      "properties": {
+        "kind": {
+          "type": "string",
+          "enum": [
+            "person",
+            "harness",
+            "agent",
+            "system"
+          ],
+          "description": "Whether a person, a harness, one of a harness's agents or Chips itself acted."
+        },
+        "id": {
+          "type": "string",
+          "minLength": 1,
+          "description": "The participant id, or `system` for Chips."
+        },
+        "harness_id": {
+          "description": "For an agent: the harness it speaks through, whose budget and runs are the agent's (ADR 0087). Filled in by Chips.",
+          "type": "string",
+          "pattern": "^hrn_[0-7][0-9A-HJKMNP-TV-Z]{25}$"
+        }
+      },
+      "required": [
+        "kind",
+        "id"
+      ],
+      "description": "The participant an event is attributed to."
+    },
+    "protocol": {
+      "type": "object",
+      "properties": {
+        "min": {
+          "type": "integer",
+          "exclusiveMinimum": 0,
+          "maximum": 9007199254740991,
+          "description": "Oldest major version the server accepts."
+        },
+        "max": {
+          "type": "integer",
+          "exclusiveMinimum": 0,
+          "maximum": 9007199254740991,
+          "description": "Newest major version the server speaks."
+        }
+      },
+      "required": [
+        "min",
+        "max"
+      ],
+      "description": "The negotiated range. A client picks a version inside it or is refused."
+    },
+    "server": {
+      "type": "object",
+      "properties": {
+        "name": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 120,
+          "description": "Usually `chipsd`."
+        },
+        "version": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 60,
+          "description": "The server's own version."
+        }
+      },
+      "required": [
+        "name",
+        "version"
+      ],
+      "description": "Who the client is talking to."
+    },
+    "harnesses": {
+      "minItems": 1,
+      "maxItems": 64,
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "harness_id": {
+            "type": "string",
+            "pattern": "^hrn_[0-7][0-9A-HJKMNP-TV-Z]{25}$",
+            "description": "A harness identifier: `hrn_` followed by a ULID."
+          },
+          "display_name": {
+            "type": "string",
+            "minLength": 1,
+            "maxLength": 120,
+            "description": "The harness's name in the workspace."
+          },
+          "owner_id": {
+            "type": "string",
+            "pattern": "^usr_[0-7][0-9A-HJKMNP-TV-Z]{25}$",
+            "description": "The person accountable for this harness."
+          },
+          "capabilities": {
+            "description": "What the harness can do.",
+            "maxItems": 64,
+            "type": "array",
+            "items": {
+              "type": "string",
+              "maxLength": 120
+            }
+          },
+          "ephemeral": {
+            "default": false,
+            "description": "True for a transient child minted for one lane, which inherits its lead's settings.",
+            "type": "boolean"
+          }
+        },
+        "required": [
+          "harness_id",
+          "display_name",
+          "owner_id"
+        ],
+        "description": "The harness this connection is, as Chips knows it."
+      },
+      "description": "The harness the token belongs to, and only that one. One connection speaks for all of the harness's agents (ADR 0087), which `agents` lists. A harness running inside another is a lane, not a duplicate."
+    },
+    "harness": {
+      "description": "The harness this connection is: `harnesses[0]`, said once. Read this rather than the list.",
+      "type": "object",
+      "properties": {
+        "harness_id": {
+          "type": "string",
+          "pattern": "^hrn_[0-7][0-9A-HJKMNP-TV-Z]{25}$",
+          "description": "A harness identifier: `hrn_` followed by a ULID."
+        },
+        "display_name": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 120,
+          "description": "The harness's name in the workspace."
+        },
+        "owner_id": {
+          "type": "string",
+          "pattern": "^usr_[0-7][0-9A-HJKMNP-TV-Z]{25}$",
+          "description": "The person accountable for this harness."
+        },
+        "capabilities": {
+          "description": "What the harness can do.",
+          "maxItems": 64,
+          "type": "array",
+          "items": {
+            "type": "string",
+            "maxLength": 120
+          }
+        },
+        "ephemeral": {
+          "default": false,
+          "description": "True for a transient child minted for one lane, which inherits its lead's settings.",
+          "type": "boolean"
+        }
+      },
+      "required": [
+        "harness_id",
+        "display_name",
+        "owner_id"
+      ]
+    },
+    "agents": {
+      "description": "The harness's agents, each with its rooms (ADR 0087). Everything the connection sends names one of them as `actor`; a harness's own id is read as its one agent in the room. Sent only to a harness that declares `agents`.",
+      "maxItems": 10000,
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "agent_id": {
+            "type": "string",
+            "pattern": "^agt_[0-7][0-9A-HJKMNP-TV-Z]{25}$",
+            "description": "A agent identifier: `agt_` followed by a ULID."
+          },
+          "key": {
+            "type": "string",
+            "minLength": 1,
+            "maxLength": 400,
+            "description": "The harness's own name for it."
+          },
+          "name": {
+            "type": "string",
+            "minLength": 1,
+            "maxLength": 120,
+            "description": "What it is called, and so its @handle."
+          },
+          "lead": {
+            "type": "boolean",
+            "description": "Whether it is the harness's Main agent."
+          },
+          "state": {
+            "type": "string",
+            "enum": [
+              "active",
+              "archived"
+            ],
+            "description": "Archived when its thing was put away."
+          },
+          "spaces": {
+            "maxItems": 10000,
+            "type": "array",
+            "items": {
+              "type": "string",
+              "pattern": "^spc_[0-7][0-9A-HJKMNP-TV-Z]{25}$",
+              "description": "A space identifier: `spc_` followed by a ULID."
+            },
+            "description": "The rooms it is in. One at most, once one room per agent is the rule."
+          },
+          "room": {
+            "description": "The open room it is in (ADR 0087: one at a time), or `null` while it is free. What it says while free is held.",
+            "anyOf": [
+              {
+                "type": "string",
+                "pattern": "^spc_[0-7][0-9A-HJKMNP-TV-Z]{25}$",
+                "description": "A space identifier: `spc_` followed by a ULID."
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "held": {
+            "description": "How many of its words Chips is holding, said while it was in no room.",
+            "type": "integer",
+            "minimum": 0,
+            "maximum": 9007199254740991
+          }
+        },
+        "required": [
+          "agent_id",
+          "key",
+          "name",
+          "lead",
+          "state",
+          "spaces"
+        ],
+        "description": "An agent the harness speaks for."
+      }
+    },
+    "autonomy": {
+      "anyOf": [
+        {
+          "type": "number",
+          "const": 0
+        },
+        {
+          "type": "number",
+          "const": 1
+        },
+        {
+          "type": "number",
+          "const": 2
+        },
+        {
+          "type": "number",
+          "const": 3
+        }
+      ],
+      "description": "The level in force for this connection."
+    },
+    "policy": {
+      "description": "The rules that fill in the details.",
+      "type": "object",
+      "properties": {
+        "autonomy": {
+          "anyOf": [
+            {
+              "type": "number",
+              "const": 0
+            },
+            {
+              "type": "number",
+              "const": 1
+            },
+            {
+              "type": "number",
+              "const": 2
+            },
+            {
+              "type": "number",
+              "const": 3
+            }
+          ],
+          "description": "0 observe, 1 ask first, 2 ask when it matters, 3 autonomous and report back. Presets that expand to rules."
+        },
+        "rules": {
+          "maxItems": 200,
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "match": {
+                "type": "string",
+                "minLength": 1,
+                "maxLength": 120,
+                "description": "A glob over action kinds, for example `payment.*`."
+              },
+              "when": {
+                "description": "Extra conditions on the action's flags, and for a command, how its parts start.",
+                "type": "object",
+                "properties": {
+                  "external": {
+                    "type": "boolean"
+                  },
+                  "irreversible": {
+                    "type": "boolean"
+                  },
+                  "money_usd_over": {
+                    "type": "number",
+                    "minimum": 0
+                  },
+                  "risk": {
+                    "maxItems": 8,
+                    "type": "array",
+                    "items": {
+                      "type": "string",
+                      "enum": [
+                        "external",
+                        "external_communication",
+                        "irreversible",
+                        "destructive",
+                        "financial",
+                        "credential",
+                        "privacy",
+                        "legal"
+                      ],
+                      "description": "A risk class the policy engine can match a rule against."
+                    }
+                  },
+                  "starts_with": {
+                    "description": "For an action that carries a command (ADR 0239): the words a part of it starts with. A command goes ahead on such rules only when every part starts with one that allows it.",
+                    "minItems": 1,
+                    "maxItems": 8,
+                    "type": "array",
+                    "items": {
+                      "type": "string",
+                      "minLength": 1,
+                      "maxLength": 400
+                    }
+                  }
+                }
+              },
+              "decision": {
+                "type": "string",
+                "enum": [
+                  "allow",
+                  "ask",
+                  "deny"
+                ],
+                "description": "What to do when the rule matches."
+              },
+              "approvers": {
+                "description": "Who may answer, when the decision is `ask`.",
+                "maxItems": 16,
+                "type": "array",
+                "items": {
+                  "type": "string",
+                  "pattern": "^(owner|any|lead|role:[a-z][a-z0-9_]*|usr_[0-9A-HJKMNP-TV-Z]{26}|hrn_[0-9A-HJKMNP-TV-Z]{26})$",
+                  "description": "`owner`, `any`, `lead`, `role:<name>`, or a specific person id; a lead harness's id once resolved."
+                }
+              },
+              "reason": {
+                "description": "Shown to the harness, and recorded in the audit log.",
+                "type": "string",
+                "maxLength": 400
+              },
+              "off": {
+                "description": "Turned off by a person (ADR 0195): kept in the list to turn back on, and skipped by the policy engine until then.",
+                "type": "boolean"
+              },
+              "made_by": {
+                "description": "Who made it by answering an ask with Always (ADR 0195). Filled in by Chips.",
+                "type": "string",
+                "minLength": 1,
+                "maxLength": 120
+              },
+              "made_at": {
+                "description": "When a person's answer made it (ADR 0195): Always, or This session. Filled in by Chips. A rule a person's answer made never allows an action that matters.",
+                "type": "string",
+                "format": "date-time",
+                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
+              }
+            },
+            "required": [
+              "match",
+              "decision"
+            ],
+            "description": "A rule the policy engine evaluates."
+          },
+          "description": "Evaluated in order; the workspace cap always wins."
+        }
+      },
+      "required": [
+        "autonomy",
+        "rules"
+      ]
+    },
+    "budget": {
+      "description": "The ceiling, and what has been spent.",
+      "type": "object",
+      "properties": {
+        "limit_usd": {
+          "type": "number",
+          "minimum": 0,
+          "description": "The ceiling for this harness."
+        },
+        "spent_usd": {
+          "type": "number",
+          "minimum": 0,
+          "description": "Spent so far, estimated."
+        }
+      },
+      "required": [
+        "limit_usd",
+        "spent_usd"
+      ]
+    },
+    "spaces": {
+      "description": "The spaces this credential is a member of as it connects. A client that kept a cache drops what is not here: a membership it lost while away is the one event a replay can never bring it, because it is no longer in the space that event belongs to.",
+      "maxItems": 10000,
+      "type": "array",
+      "items": {
+        "type": "string",
+        "pattern": "^spc_[0-7][0-9A-HJKMNP-TV-Z]{25}$",
+        "description": "A space identifier: `spc_` followed by a ULID."
+      }
+    },
+    "workspace": {
+      "description": "The workspace as it is called now. A device keeps the name it was told when it paired and takes this one when they differ, so a workspace renamed since is called by its new name without pairing again. Absent when the workspace has no name.",
+      "type": "object",
+      "properties": {
+        "name": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 120
+        }
+      },
+      "required": [
+        "name"
+      ]
+    }
+  },
+  "required": [
+    "v",
+    "type",
+    "id",
+    "ts",
+    "workspace_id",
+    "actor",
+    "protocol",
+    "server",
+    "harnesses",
+    "autonomy"
+  ],
+  "description": "The server's half of the handshake: the protocol range it speaks, and who this connection is.",
+  "$id": "https://chipschat.ai/schema/v1/hello.json",
+  "title": "Hello"
+}