@ccmsg/protocol 0.6.1 → 0.7.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ccmsg/protocol",
-  "version": "0.6.1",
+  "version": "0.7.0",
   "description": "Wire contract (schema + types + op attribute table) shared by the ccmsg daemon and web UI",
   "license": "MIT",
   "author": "kawaz",

package/src/control/session.ts

@@ -27,6 +27,13 @@ export type SessionKillResult = Static<typeof SessionKillResult>;
 export const SessionKillRequest = request("session_kill", SessionKillArgs);
 export const SessionKillResponse = response("session_kill", SessionKillResult);
 
+/** How long a title may be. A title is typed into a terminal and shown as a
+ * session's first line, where anything longer is unreadable whatever the
+ * terminal would accept — so the ceiling is the caller's to keep to, and a
+ * client that composes a title has to know it before it sends one. Counted the
+ * way a JSON Schema `maxLength` is, over the value as sent. */
+export const TITLE_MAX_CHARS = 200;
+
 /** Retitles a running session by typing its own rename command into the
  * terminal it lives in.
  *
@@ -40,7 +47,7 @@ export const SessionRenameArgs = Type.Object({
   /** The new title. Surrounding whitespace is trimmed and control characters
    * are refused: the value is typed, so a newline in it would submit a
    * half-written command. */
-  title: Type.String({ minLength: 1 }),
+  title: Type.String({ minLength: 1, maxLength: TITLE_MAX_CHARS }),
 });
 export type SessionRenameArgs = Static<typeof SessionRenameArgs>;
 

package/src/envelope.ts

@@ -8,6 +8,16 @@ import { InstanceId, Role, Sid } from "./identifiers.ts";
  * connections and on mesh links alike. */
 export const PROTOCOL_VERSION = 2;
 
+/** The largest a single frame — one newline-delimited line, request, reply or
+ * topic frame alike — may be, in bytes.
+ *
+ * A value both sides hold because only the sender can keep to it: a frame over
+ * it is answered `bad_request` and the connection stays up, so a client that
+ * does not know the ceiling reads a refusal it cannot attribute to size. What
+ * a caller does with a payload above it — split it, write it as a file — is its
+ * own decision, which is why the contract states the limit and not a remedy. */
+export const MAX_FRAME_BYTES = 1_048_576;
+
 /** The identity a forwarded request is dispatched as: the connection the
  * forwarding instance received it on, in the two fields that decide anything —
  * the role the attribute table is read against, and the session it speaks for. */