refactor: model message schemas after IRC RFC 1459/2812

Replace c2s/s2c/s2s taxonomy with IRC-native structure: - schema/commands/ — IRC command schemas (PRIVMSG, NOTICE, JOIN, PART, QUIT, NICK, TOPIC, MODE, KICK, PING, PONG) - schema/numerics/ — IRC numeric reply codes (001-004, 322-323, 332, 353, 366, 372-376, 401, 403, 433, 442, 482) - schema/message.json — base envelope mapping IRC wire format to JSON Messages use 'command' field with IRC command names or 3-digit numeric codes. 'body' is a string (IRC trailing parameter), not object/array. 'from'/'to' map to IRC prefix and first parameter. Federation uses the same IRC commands (no custom RELAY/LINK/SYNC). Update README message format, command tables, and examples to match.
2026-02-10 10:31:26 -08:00
parent c8d88de8c5
commit dfb1636be5
72 changed files with 963 additions and 1149 deletions
--- a/schema/commands/JOIN.json
+++ b/schema/commands/JOIN.json
@@ -0,0 +1,16 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://git.eeqj.de/sneak/chat/schema/commands/JOIN.json",
+  "title": "JOIN",
+  "description": "Join a channel. C2S: request to join. S2C: notification that a user joined. RFC 1459 §4.2.1.",
+  "$ref": "../message.json",
+  "properties": {
+    "command": { "const": "JOIN" },
+    "from": { "type": "string", "description": "Nick that joined (S2C)." },
+    "to": { "type": "string", "description": "Channel name.", "pattern": "^#[a-zA-Z0-9_-]+$" }
+  },
+  "required": ["command", "to"],
+  "examples": [
+    { "command": "JOIN", "from": "alice", "to": "#general" }
+  ]
+}
--- a/schema/commands/KICK.json
+++ b/schema/commands/KICK.json
@@ -0,0 +1,34 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://git.eeqj.de/sneak/chat/schema/commands/KICK.json",
+  "title": "KICK",
+  "description": "Kick a user from a channel. RFC 1459 §4.2.8.",
+  "$ref": "../message.json",
+  "properties": {
+    "command": { "const": "KICK" },
+    "from": {
+      "type": "string",
+      "description": "Nick that performed the kick."
+    },
+    "to": {
+      "type": "string",
+      "description": "Channel name.",
+      "pattern": "^#[a-zA-Z0-9_-]+$"
+    },
+    "params": {
+      "type": "array",
+      "items": { "type": "string" },
+      "description": "Kicked nick. e.g. [\"alice\"].",
+      "minItems": 1,
+      "maxItems": 1
+    },
+    "body": {
+      "type": "string",
+      "description": "Optional kick reason."
+    }
+  },
+  "required": ["command", "to", "params"],
+  "examples": [
+    { "command": "KICK", "from": "op1", "to": "#general", "params": ["troll"], "body": "Behave" }
+  ]
+}
--- a/schema/commands/MODE.json
+++ b/schema/commands/MODE.json
@@ -0,0 +1,29 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://git.eeqj.de/sneak/chat/schema/commands/MODE.json",
+  "title": "MODE",
+  "description": "Set or query channel/user modes. RFC 1459 §4.2.3.",
+  "$ref": "../message.json",
+  "properties": {
+    "command": { "const": "MODE" },
+    "from": {
+      "type": "string",
+      "description": "Nick that set the mode (S2C only)."
+    },
+    "to": {
+      "type": "string",
+      "description": "Channel name.",
+      "pattern": "^#[a-zA-Z0-9_-]+$"
+    },
+    "params": {
+      "type": "array",
+      "items": { "type": "string" },
+      "description": "Mode string and optional target nick. e.g. [\"+o\", \"alice\"].",
+      "examples": [["+o", "alice"], ["-m"], ["+v", "bob"]]
+    }
+  },
+  "required": ["command", "to", "params"],
+  "examples": [
+    { "command": "MODE", "from": "op1", "to": "#general", "params": ["+o", "alice"] }
+  ]
+}
--- a/schema/commands/NICK.json
+++ b/schema/commands/NICK.json
@@ -0,0 +1,16 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://git.eeqj.de/sneak/chat/schema/commands/NICK.json",
+  "title": "NICK",
+  "description": "Change nickname. C2S: request new nick. S2C: notification of nick change. RFC 1459 §4.1.2.",
+  "$ref": "../message.json",
+  "properties": {
+    "command": { "const": "NICK" },
+    "from": { "type": "string", "description": "Old nick (S2C)." },
+    "body": { "type": "string", "description": "New nick.", "minLength": 1, "maxLength": 32, "pattern": "^[a-zA-Z][a-zA-Z0-9_-]*$" }
+  },
+  "required": ["command", "body"],
+  "examples": [
+    { "command": "NICK", "from": "oldnick", "body": "newnick" }
+  ]
+}
--- a/schema/commands/NOTICE.json
+++ b/schema/commands/NOTICE.json
@@ -0,0 +1,17 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://git.eeqj.de/sneak/chat/schema/commands/NOTICE.json",
+  "title": "NOTICE",
+  "description": "Send a notice. Like PRIVMSG but must not trigger automatic replies. RFC 1459 §4.4.2.",
+  "$ref": "../message.json",
+  "properties": {
+    "command": { "const": "NOTICE" },
+    "from": { "type": "string" },
+    "to": { "type": "string", "description": "Target: #channel, nick, or * (global)." },
+    "body": { "type": "string", "description": "Notice text." }
+  },
+  "required": ["command", "to", "body"],
+  "examples": [
+    { "command": "NOTICE", "from": "server.example.com", "to": "*", "body": "Server restarting in 5 minutes" }
+  ]
+}
--- a/schema/commands/PART.json
+++ b/schema/commands/PART.json
@@ -0,0 +1,17 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://git.eeqj.de/sneak/chat/schema/commands/PART.json",
+  "title": "PART",
+  "description": "Leave a channel. C2S: request to leave. S2C: notification that a user left. RFC 1459 §4.2.2.",
+  "$ref": "../message.json",
+  "properties": {
+    "command": { "const": "PART" },
+    "from": { "type": "string", "description": "Nick that left (S2C)." },
+    "to": { "type": "string", "description": "Channel name.", "pattern": "^#[a-zA-Z0-9_-]+$" },
+    "body": { "type": "string", "description": "Optional part reason." }
+  },
+  "required": ["command", "to"],
+  "examples": [
+    { "command": "PART", "from": "alice", "to": "#general", "body": "later" }
+  ]
+}
--- a/schema/commands/PING.json
+++ b/schema/commands/PING.json
@@ -0,0 +1,18 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://git.eeqj.de/sneak/chat/schema/commands/PING.json",
+  "title": "PING",
+  "description": "Keepalive. C2S or S2S. Server responds with PONG. RFC 1459 §4.6.2.",
+  "$ref": "../message.json",
+  "properties": {
+    "command": { "const": "PING" },
+    "body": {
+      "type": "string",
+      "description": "Opaque token to be echoed in PONG."
+    }
+  },
+  "required": ["command"],
+  "examples": [
+    { "command": "PING", "body": "1707580000" }
+  ]
+}
--- a/schema/commands/PONG.json
+++ b/schema/commands/PONG.json
@@ -0,0 +1,22 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://git.eeqj.de/sneak/chat/schema/commands/PONG.json",
+  "title": "PONG",
+  "description": "Keepalive response. S2C or S2S. RFC 1459 §4.6.3.",
+  "$ref": "../message.json",
+  "properties": {
+    "command": { "const": "PONG" },
+    "from": {
+      "type": "string",
+      "description": "Responding server name."
+    },
+    "body": {
+      "type": "string",
+      "description": "Echoed token from PING."
+    }
+  },
+  "required": ["command"],
+  "examples": [
+    { "command": "PONG", "from": "server.example.com", "body": "1707580000" }
+  ]
+}
--- a/schema/commands/PRIVMSG.json
+++ b/schema/commands/PRIVMSG.json
@@ -0,0 +1,18 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://git.eeqj.de/sneak/chat/schema/commands/PRIVMSG.json",
+  "title": "PRIVMSG",
+  "description": "Send a message to a channel or user. C2S: client sends to server. S2C: server relays to recipients. RFC 1459 §4.4.1.",
+  "$ref": "../message.json",
+  "properties": {
+    "command": { "const": "PRIVMSG" },
+    "from": { "type": "string", "description": "Sender nick (set by server on relay)." },
+    "to": { "type": "string", "description": "Target: #channel or nick.", "examples": ["#general", "alice"] },
+    "body": { "type": "string", "description": "Message text.", "minLength": 1 }
+  },
+  "required": ["command", "to", "body"],
+  "examples": [
+    { "command": "PRIVMSG", "from": "bob", "to": "#general", "body": "hello world" },
+    { "command": "PRIVMSG", "from": "bob", "to": "alice", "body": "hey" }
+  ]
+}
--- a/schema/commands/QUIT.json
+++ b/schema/commands/QUIT.json
@@ -0,0 +1,16 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://git.eeqj.de/sneak/chat/schema/commands/QUIT.json",
+  "title": "QUIT",
+  "description": "User disconnected. S2C only. RFC 1459 §4.1.6.",
+  "$ref": "../message.json",
+  "properties": {
+    "command": { "const": "QUIT" },
+    "from": { "type": "string", "description": "Nick that quit." },
+    "body": { "type": "string", "description": "Optional quit reason." }
+  },
+  "required": ["command", "from"],
+  "examples": [
+    { "command": "QUIT", "from": "alice", "body": "Connection reset" }
+  ]
+}
--- a/schema/commands/TOPIC.json
+++ b/schema/commands/TOPIC.json
@@ -0,0 +1,17 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://git.eeqj.de/sneak/chat/schema/commands/TOPIC.json",
+  "title": "TOPIC",
+  "description": "Get or set channel topic. C2S: set topic (body present) or query (body absent). S2C: topic change notification. RFC 1459 §4.2.4.",
+  "$ref": "../message.json",
+  "properties": {
+    "command": { "const": "TOPIC" },
+    "from": { "type": "string", "description": "Nick that changed the topic (S2C)." },
+    "to": { "type": "string", "description": "Channel name.", "pattern": "^#[a-zA-Z0-9_-]+$" },
+    "body": { "type": "string", "description": "New topic text. Empty string clears the topic.", "maxLength": 512 }
+  },
+  "required": ["command", "to"],
+  "examples": [
+    { "command": "TOPIC", "from": "alice", "to": "#general", "body": "Welcome to the chat" }
+  ]
+}