@ccmsg/protocol 1.20.0 → 1.21.0

package/src/fixtures/index.ts

@@ -26,135 +26,149 @@ export interface OpFixture {
  * implementation. Every one of them passes the op's schema, which the
  * contract's tests hold it to. */
 export const OP_FIXTURES = {
-  hello: { request: common.HELLO_REQUEST, response: common.HELLO_RESPONSE },
-  instance_ping: {
+  "hello.session": { request: common.HELLO_SESSION_REQUEST, response: common.HELLO_RESPONSE },
+  "hello.user": { request: common.HELLO_USER_REQUEST, response: common.HELLO_RESPONSE },
+  "hello.instance": {
+    request: common.HELLO_INSTANCE_REQUEST,
+    response: common.HELLO_RESPONSE,
+  },
+  "instance.ping": {
     request: common.INSTANCE_PING_REQUEST,
     response: common.INSTANCE_PING_RESPONSE,
   },
-  instance_shutdown: {
+  "instance.shutdown": {
     request: common.INSTANCE_SHUTDOWN_REQUEST,
     response: common.INSTANCE_SHUTDOWN_RESPONSE,
   },
-  session_stopping: {
+  "session.stopping": {
     request: common.SESSION_STOPPING_REQUEST,
     response: common.SESSION_STOPPING_RESPONSE,
   },
-  topic_subscribe: {
+  "topic.subscribe": {
     request: common.TOPIC_SUBSCRIBE_REQUEST,
     response: common.TOPIC_SUBSCRIBE_RESPONSE,
   },
-  topic_unsubscribe: {
+  "topic.unsubscribe": {
     request: common.TOPIC_UNSUBSCRIBE_REQUEST,
     response: common.TOPIC_UNSUBSCRIBE_RESPONSE,
   },
-  auth_challenge: {
+  "auth.challenge": {
     request: common.AUTH_CHALLENGE_REQUEST,
     response: common.AUTH_CHALLENGE_RESPONSE,
   },
-  auth_register: {
+  "auth.register": {
     request: common.AUTH_REGISTER_REQUEST,
     response: common.AUTH_REGISTER_RESPONSE,
   },
-  auth_assert: { request: common.AUTH_ASSERT_REQUEST, response: common.AUTH_ASSERT_RESPONSE },
-  auth_refresh_token: {
-    request: common.AUTH_REFRESH_TOKEN_REQUEST,
-    response: common.AUTH_REFRESH_TOKEN_RESPONSE,
+  "auth.assert": { request: common.AUTH_ASSERT_REQUEST, response: common.AUTH_ASSERT_RESPONSE },
+  "auth.token.refresh": {
+    request: common.AUTH_TOKEN_REFRESH_REQUEST,
+    response: common.AUTH_TOKEN_REFRESH_RESPONSE,
   },
-  auth_refresh: { request: common.AUTH_REFRESH_REQUEST, response: common.AUTH_REFRESH_RESPONSE },
-  auth_resolve: { request: common.AUTH_RESOLVE_REQUEST, response: common.AUTH_RESOLVE_RESPONSE },
-  auth_rotate: { request: common.AUTH_ROTATE_REQUEST, response: common.AUTH_ROTATE_RESPONSE },
+  "auth.extend": { request: common.AUTH_EXTEND_REQUEST, response: common.AUTH_EXTEND_RESPONSE },
+  "auth.resolve": { request: common.AUTH_RESOLVE_REQUEST, response: common.AUTH_RESOLVE_RESPONSE },
+  "auth.rotate": { request: common.AUTH_ROTATE_REQUEST, response: common.AUTH_ROTATE_RESPONSE },
 
-  message_send: {
+  "message.send": {
     request: messaging.MESSAGE_SEND_REQUEST,
     response: messaging.MESSAGE_SEND_RESPONSE,
   },
-  say_post: { request: messaging.SAY_POST_REQUEST, response: messaging.SAY_POST_RESPONSE },
-  say_mark_read: {
-    request: messaging.SAY_MARK_READ_REQUEST,
-    response: messaging.SAY_MARK_READ_RESPONSE,
+  "say.post": { request: messaging.SAY_POST_REQUEST, response: messaging.SAY_POST_RESPONSE },
+  "say.unread.clear": {
+    request: messaging.SAY_UNREAD_CLEAR_REQUEST,
+    response: messaging.SAY_UNREAD_CLEAR_RESPONSE,
+  },
+  "notify.send": {
+    request: messaging.NOTIFY_SEND_REQUEST,
+    response: messaging.NOTIFY_SEND_RESPONSE,
   },
-  notify_send: { request: messaging.NOTIFY_SEND_REQUEST, response: messaging.NOTIFY_SEND_RESPONSE },
 
-  session_kill: { request: control.SESSION_KILL_REQUEST, response: control.SESSION_KILL_RESPONSE },
-  session_rename: {
+  "session.kill": {
+    request: control.SESSION_KILL_REQUEST,
+    response: control.SESSION_KILL_RESPONSE,
+  },
+  "session.rename": {
     request: control.SESSION_RENAME_REQUEST,
     response: control.SESSION_RENAME_RESPONSE,
   },
-  session_env_read: {
+  "session.env.read": {
     request: control.SESSION_ENV_READ_REQUEST,
     response: control.SESSION_ENV_READ_RESPONSE,
   },
-  session_search: {
+  "session.search": {
     request: control.SESSION_SEARCH_REQUEST,
     response: control.SESSION_SEARCH_RESPONSE,
   },
-  session_dump_write: {
+  "session.dump.write": {
     request: control.SESSION_DUMP_WRITE_REQUEST,
     response: control.SESSION_DUMP_WRITE_RESPONSE,
   },
-  dump_presets_read: {
+  "dump.presets.read": {
     request: control.DUMP_PRESETS_READ_REQUEST,
     response: control.DUMP_PRESETS_READ_RESPONSE,
   },
-  transcript_read: {
+  "transcript.read": {
     request: control.TRANSCRIPT_READ_REQUEST,
     response: control.TRANSCRIPT_READ_RESPONSE,
   },
-  transcript_items_read: {
+  "transcript.items.read": {
     request: control.TRANSCRIPT_ITEMS_READ_REQUEST,
     response: control.TRANSCRIPT_ITEMS_READ_RESPONSE,
   },
-  session_fork_origin: {
-    request: control.SESSION_FORK_ORIGIN_REQUEST,
-    response: control.SESSION_FORK_ORIGIN_RESPONSE,
+  "session.fork.origin.read": {
+    request: control.SESSION_FORK_ORIGIN_READ_REQUEST,
+    response: control.SESSION_FORK_ORIGIN_READ_RESPONSE,
   },
-  session_last_live_remove: {
-    request: control.SESSION_LAST_LIVE_REMOVE_REQUEST,
-    response: control.SESSION_LAST_LIVE_REMOVE_RESPONSE,
+  "session.forget": {
+    request: control.SESSION_FORGET_REQUEST,
+    response: control.SESSION_FORGET_RESPONSE,
   },
 
-  dir_list: { request: control.DIR_LIST_REQUEST, response: control.DIR_LIST_RESPONSE },
-  file_read: { request: control.FILE_READ_REQUEST, response: control.FILE_READ_RESPONSE },
-  file_write: { request: control.FILE_WRITE_REQUEST, response: control.FILE_WRITE_RESPONSE },
-  file_create: { request: control.FILE_CREATE_REQUEST, response: control.FILE_CREATE_RESPONSE },
-  file_edit: { request: control.FILE_EDIT_REQUEST, response: control.FILE_EDIT_RESPONSE },
-  file_delete: { request: control.FILE_DELETE_REQUEST, response: control.FILE_DELETE_RESPONSE },
-  file_find: { request: control.FILE_FIND_REQUEST, response: control.FILE_FIND_RESPONSE },
-  file_stat_batch: {
-    request: control.FILE_STAT_BATCH_REQUEST,
-    response: control.FILE_STAT_BATCH_RESPONSE,
-  },
-  dir_tree: { request: control.DIR_TREE_REQUEST, response: control.DIR_TREE_RESPONSE },
+  "dir.list": { request: control.DIR_LIST_REQUEST, response: control.DIR_LIST_RESPONSE },
+  "file.read": { request: control.FILE_READ_REQUEST, response: control.FILE_READ_RESPONSE },
+  "file.write": { request: control.FILE_WRITE_REQUEST, response: control.FILE_WRITE_RESPONSE },
+  "file.create": { request: control.FILE_CREATE_REQUEST, response: control.FILE_CREATE_RESPONSE },
+  "file.edit": { request: control.FILE_EDIT_REQUEST, response: control.FILE_EDIT_RESPONSE },
+  "file.delete": { request: control.FILE_DELETE_REQUEST, response: control.FILE_DELETE_RESPONSE },
+  "file.find": { request: control.FILE_FIND_REQUEST, response: control.FILE_FIND_RESPONSE },
+  "file.stat": {
+    request: control.FILE_STAT_REQUEST,
+    response: control.FILE_STAT_RESPONSE,
+  },
+  "dir.tree": { request: control.DIR_TREE_REQUEST, response: control.DIR_TREE_RESPONSE },
 
-  launcher_config_read: {
+  "launcher.config.read": {
     request: control.LAUNCHER_CONFIG_READ_REQUEST,
     response: control.LAUNCHER_CONFIG_READ_RESPONSE,
   },
-  launcher_run: { request: control.LAUNCHER_RUN_REQUEST, response: control.LAUNCHER_RUN_RESPONSE },
-  sandbox_grant: {
+  "launcher.run": {
+    request: control.LAUNCHER_RUN_REQUEST,
+    response: control.LAUNCHER_RUN_RESPONSE,
+  },
+  "sandbox.grant": {
     request: control.SANDBOX_GRANT_REQUEST,
     response: control.SANDBOX_GRANT_RESPONSE,
   },
-  sandbox_revoke: {
+  "sandbox.revoke": {
     request: control.SANDBOX_REVOKE_REQUEST,
     response: control.SANDBOX_REVOKE_RESPONSE,
   },
-  translate_run: {
+  "translate.run": {
     request: control.TRANSLATE_RUN_REQUEST,
     response: control.TRANSLATE_RUN_RESPONSE,
   },
-  llm_usage_read: {
+  "llm.usage.read": {
     request: control.LLM_USAGE_READ_REQUEST,
     response: control.LLM_USAGE_READ_RESPONSE,
   },
-  llm_stats_read: {
+  "llm.stats.read": {
     request: control.LLM_STATS_READ_REQUEST,
     response: control.LLM_STATS_READ_RESPONSE,
   },
 
-  kv_read: { request: control.KV_READ_REQUEST, response: control.KV_READ_RESPONSE },
-  kv_write: { request: control.KV_WRITE_REQUEST, response: control.KV_WRITE_RESPONSE },
-  kv_delete: { request: control.KV_DELETE_REQUEST, response: control.KV_DELETE_RESPONSE },
+  "kv.read": { request: control.KV_READ_REQUEST, response: control.KV_READ_RESPONSE },
+  "kv.write": { request: control.KV_WRITE_REQUEST, response: control.KV_WRITE_RESPONSE },
+  "kv.delete": { request: control.KV_DELETE_REQUEST, response: control.KV_DELETE_RESPONSE },
 } as const satisfies Record<OpName, OpFixture>;
 
 /** A representative frame for every topic, each one the snapshot a subscriber
@@ -165,12 +179,12 @@ export const TOPIC_FIXTURES = {
   peers: topics.PEERS_FRAME,
   instances: topics.INSTANCES_FRAME,
   agents: topics.AGENTS_FRAME,
-  session_status: topics.SESSION_STATUS_FRAME,
+  "session.status": topics.SESSION_STATUS_FRAME,
   transcript: topics.TRANSCRIPT_FRAME,
-  transcript_items: topics.TRANSCRIPT_ITEMS_FRAME,
-  session_errors: topics.SESSION_ERRORS_FRAME,
-  llm_requests: topics.LLM_REQUESTS_FRAME,
-  llm_status: topics.LLM_STATUS_FRAME,
+  "transcript.items": topics.TRANSCRIPT_ITEMS_FRAME,
+  "session.errors": topics.SESSION_ERRORS_FRAME,
+  "llm.requests": topics.LLM_REQUESTS_FRAME,
+  "llm.status": topics.LLM_STATUS_FRAME,
   kv: topics.KV_FRAME,
-  auth_records: topics.AUTH_RECORDS_FRAME,
+  "auth.records": topics.AUTH_RECORDS_FRAME,
 } as const satisfies Record<TopicKind, unknown>;

package/src/fixtures/messaging.ts

@@ -2,8 +2,8 @@ import type { Static } from "@sinclair/typebox";
 import type { MessageSendRequest, MessageSendResponse } from "../messaging/message.ts";
 import type { NotifySendRequest, NotifySendResponse } from "../messaging/notify.ts";
 import type {
-  SayMarkReadRequest,
-  SayMarkReadResponse,
+  SayUnreadClearRequest,
+  SayUnreadClearResponse,
   SayPostRequest,
   SayPostResponse,
 } from "../messaging/say.ts";
@@ -13,7 +13,7 @@ const { sid, other_sid, instance, mid, request_id } = FIXTURE_IDS;
 
 export const MESSAGE_SEND_REQUEST: Static<typeof MessageSendRequest> = {
   request_id,
-  op: "message_send",
+  op: "message.send",
   to: other_sid,
   text: "契約の fixture を export した",
   reply_to: mid,
@@ -23,7 +23,7 @@ export const MESSAGE_SEND_REQUEST: Static<typeof MessageSendRequest> = {
  * fields and the identity it was called with. */
 export const MESSAGE_SEND_FORWARDED_REQUEST: Static<typeof MessageSendRequest> = {
   request_id,
-  op: "message_send",
+  op: "message.send",
   to: other_sid,
   text: "契約の fixture を export した",
   from_instance: instance,
@@ -49,7 +49,7 @@ export const MESSAGE_SEND_HELD_RESPONSE: Static<typeof MessageSendResponse> = {
 
 export const SAY_POST_REQUEST: Static<typeof SayPostRequest> = {
   request_id,
-  op: "say_post",
+  op: "say.post",
   text: "終わりました",
 };
 
@@ -59,20 +59,20 @@ export const SAY_POST_RESPONSE: Static<typeof SayPostResponse> = {
   posted_at: FIXTURE_NOW,
 };
 
-export const SAY_MARK_READ_REQUEST: Static<typeof SayMarkReadRequest> = {
+export const SAY_UNREAD_CLEAR_REQUEST: Static<typeof SayUnreadClearRequest> = {
   request_id,
-  op: "say_mark_read",
+  op: "say.unread.clear",
   sid,
 };
 
-export const SAY_MARK_READ_RESPONSE: Static<typeof SayMarkReadResponse> = {
+export const SAY_UNREAD_CLEAR_RESPONSE: Static<typeof SayUnreadClearResponse> = {
   ok: true,
   request_id,
 };
 
 export const NOTIFY_SEND_REQUEST: Static<typeof NotifySendRequest> = {
   request_id,
-  op: "notify_send",
+  op: "notify.send",
   sid,
   text: "確認して",
 };

package/src/fixtures/topics.ts

@@ -167,7 +167,7 @@ export const AGENTS_CHANGE_FRAME: Static<typeof AgentsFrame> = {
 
 export const SESSION_STATUS_FRAME: Static<typeof SessionStatusFrame> = {
   ev: "topic",
-  topic: `session_status:${sid}`,
+  topic: `session.status:${sid}`,
   snapshot: true,
   instance,
   data: {
@@ -297,7 +297,7 @@ export const TRANSCRIPT_SIZE_FRAME = {
 /** The typed topic, whose frames carry items rather than bytes. */
 export const TRANSCRIPT_ITEMS_FRAME = {
   ev: "topic",
-  topic: `transcript_items:${sid}`,
+  topic: `transcript.items:${sid}`,
   instance,
   data: { sid, items: TRANSCRIPT_ITEMS.slice(-2) },
 } satisfies Static<typeof TranscriptItemsFrame>;
@@ -306,7 +306,7 @@ export const TRANSCRIPT_ITEMS_FRAME = {
  * every frame after it, so a subscriber appends both the same way. */
 export const TRANSCRIPT_ITEMS_SNAPSHOT_FRAME = {
   ev: "topic",
-  topic: `transcript_items:${sid}`,
+  topic: `transcript.items:${sid}`,
   snapshot: true,
   instance,
   data: { sid, items: TRANSCRIPT_ITEMS },
@@ -314,7 +314,7 @@ export const TRANSCRIPT_ITEMS_SNAPSHOT_FRAME = {
 
 export const SESSION_ERRORS_FRAME: Static<typeof SessionErrorsFrame> = {
   ev: "topic",
-  topic: "session_errors",
+  topic: "session.errors",
   snapshot: true,
   instance,
   data: {
@@ -324,7 +324,7 @@ export const SESSION_ERRORS_FRAME: Static<typeof SessionErrorsFrame> = {
 
 export const LLM_REQUESTS_FRAME: Static<typeof LlmRequestsFrame> = {
   ev: "topic",
-  topic: "llm_requests",
+  topic: "llm.requests",
   snapshot: true,
   instance,
   data: [
@@ -349,7 +349,7 @@ export const LLM_REQUESTS_FRAME: Static<typeof LlmRequestsFrame> = {
 
 export const LLM_STATUS_FRAME: Static<typeof LlmStatusFrame> = {
   ev: "topic",
-  topic: "llm_status",
+  topic: "llm.status",
   snapshot: true,
   instance,
   data: {
@@ -396,7 +396,7 @@ export const KV_FRAME: Static<typeof KvFrame> = {
 
 export const AUTH_RECORDS_FRAME = {
   ev: "topic",
-  topic: "auth_records",
+  topic: "auth.records",
   snapshot: true,
   instance,
   data: {
@@ -431,7 +431,7 @@ export const AUTH_RECORDS_FRAME = {
  * issued it. */
 export const AUTH_RECORDS_FAMILY_FRAME = {
   ev: "topic",
-  topic: "auth_records",
+  topic: "auth.records",
   instance,
   data: {
     records: [
@@ -462,7 +462,7 @@ export const AUTH_RECORDS_FAMILY_FRAME = {
  * family's is kept only as long as a refresh token could still arrive. */
 export const AUTH_RECORDS_TOMBSTONE_FRAME = {
   ev: "topic",
-  topic: "auth_records",
+  topic: "auth.records",
   instance,
   data: {
     records: [

package/src/identifiers.ts

@@ -81,12 +81,14 @@ export const Mid = Type.String({
 });
 export type Mid = Static<typeof Mid>;
 
-/** Who a connection speaks as. Set once by `hello` and fixed for the
- * connection's life; the op attribute table's `roles` is checked against it.
+/** Who a connection speaks as. Settled once by the greeting that opened it —
+ * `hello.session`, `hello.user` or `hello.instance`, the op being what says
+ * which — and fixed for the connection's life; the op attribute table's
+ * `roles` is checked against it.
  *
- * Once by `hello` means once: a second `hello` on a connection whose identity
- * is already settled is refused with `bad_request`, whether it repeats the
- * role or names another. */
+ * Once means once: a second greeting on a connection whose identity is
+ * already settled is refused with `bad_request`, whether it is the same one
+ * again or another. */
 export const Role = Type.Union(
   [Type.Literal("session"), Type.Literal("user"), Type.Literal("instance")],
   { $id: "Role" },
@@ -100,7 +102,7 @@ export const Capability = Type.Union(
     Type.Literal("fork"),
     Type.Literal("launcher"),
     /** A gateway webhook source is configured, so request activity arrives to
-     * be pushed on the `llm_requests` topic. */
+     * be pushed on the `llm.requests` topic. */
     Type.Literal("llm_events"),
     Type.Literal("llm_stats"),
     Type.Literal("llm_status"),

package/src/messaging/message.ts

@@ -65,8 +65,8 @@ export const MessageSendResult = Type.Object({
 });
 export type MessageSendResult = Static<typeof MessageSendResult>;
 
-export const MessageSendRequest = request("message_send", MessageSendArgs);
-export const MessageSendResponse = response("message_send", MessageSendResult);
+export const MessageSendRequest = request("message.send", MessageSendArgs);
+export const MessageSendResponse = response("message.send", MessageSendResult);
 
 /** A message as the recipient receives it, on topic `inbox`.
  *
@@ -75,7 +75,7 @@ export const MessageSendResponse = response("message_send", MessageSendResult);
  * whoever renders it — see `direct-delivery.ts` for the one route whose
  * recipient reads text instead of this frame.
  *
- * A `from` of `user` is the exception: `message_send` addresses a sid, so there
+ * A `from` of `user` is the exception: `message.send` addresses a sid, so there
  * is no such thing as sending back to the person. An answer to one reaches them
  * as a notification instead, which is the instance's to arrange — this contract
  * only states that the sender can be a person, so a client stops treating one

package/src/messaging/notify.ts

@@ -3,7 +3,7 @@ import { request, response, topicFrame } from "../envelope.ts";
 import { Sid, Timestamp } from "../identifiers.ts";
 
 /** A short line meant to reach a person watching, not the session's own turn.
- * Delivery is best effort and unacknowledged; unlike `message_send`, nothing is
+ * Delivery is best effort and unacknowledged; unlike `message.send`, nothing is
  * held for later. */
 export const NotifySendArgs = Type.Object({
   /** The session the notification is about. Omit to mean the caller. */
@@ -15,8 +15,8 @@ export type NotifySendArgs = Static<typeof NotifySendArgs>;
 export const NotifySendResult = Type.Object({});
 export type NotifySendResult = Static<typeof NotifySendResult>;
 
-export const NotifySendRequest = request("notify_send", NotifySendArgs);
-export const NotifySendResponse = response("notify_send", NotifySendResult);
+export const NotifySendRequest = request("notify.send", NotifySendArgs);
+export const NotifySendResponse = response("notify.send", NotifySendResult);
 
 export const Notification = Type.Object(
   {

package/src/messaging/say.ts

@@ -17,19 +17,19 @@ export const SayPostResult = Type.Object({
 });
 export type SayPostResult = Static<typeof SayPostResult>;
 
-export const SayPostRequest = request("say_post", SayPostArgs);
-export const SayPostResponse = response("say_post", SayPostResult);
+export const SayPostRequest = request("say.post", SayPostArgs);
+export const SayPostResponse = response("say.post", SayPostResult);
 
-/** Clears the unread mark a `say_post` raised. The mark is instance state that
+/** Clears the unread mark a `say.post` raised. The mark is instance state that
  * a restart may forget — nothing depends on it surviving. */
-export const SayMarkReadArgs = Type.Object({
+export const SayUnreadClearArgs = Type.Object({
   /** The session whose unread mark is cleared. Omit to clear every one. */
   sid: Type.Optional(Sid),
 });
-export type SayMarkReadArgs = Static<typeof SayMarkReadArgs>;
+export type SayUnreadClearArgs = Static<typeof SayUnreadClearArgs>;
 
-export const SayMarkReadResult = Type.Object({});
-export type SayMarkReadResult = Static<typeof SayMarkReadResult>;
+export const SayUnreadClearResult = Type.Object({});
+export type SayUnreadClearResult = Static<typeof SayUnreadClearResult>;
 
-export const SayMarkReadRequest = request("say_mark_read", SayMarkReadArgs);
-export const SayMarkReadResponse = response("say_mark_read", SayMarkReadResult);
+export const SayUnreadClearRequest = request("say.unread.clear", SayUnreadClearArgs);
+export const SayUnreadClearResponse = response("say.unread.clear", SayUnreadClearResult);