@zyclaw/webot 0.1.0

package/src/protocol.ts

@@ -0,0 +1,354 @@
+// ── WeBot WebSocket protocol type definitions ──
+
+// ── Auth ──
+
+export type AuthFrame = {
+  type: "auth";
+  deviceId: string;
+  publicKey: string;
+  signature: string;
+  signedAt: number;
+  name?: string;
+  version?: string;
+  platform?: string;
+};
+
+export type AuthOkFrame = {
+  type: "auth_ok";
+  deviceId: string;
+  userId: string;
+  botName: string;
+};
+
+export type AuthPendingFrame = {
+  type: "auth_pending";
+  deviceId: string;
+  claimCode: string;
+  claimUrl: string;
+  expiresAt: number;
+};
+
+export type AuthErrorFrame = {
+  type: "auth_error";
+  code?: string;
+  message?: string;
+  error?: string;
+};
+
+// ── Heartbeat ──
+
+// ── Claim status query ──
+
+export type ClaimStatusFrame = {
+  type: "claim.status";
+  id: string;
+};
+
+export type ClaimStatusData = {
+  status: "unclaimed" | "claimed";
+  claimCode?: string;
+  claimUrl?: string;
+  expiresAt?: number;
+  owner?: {
+    username: string;
+    displayName: string;
+  };
+  claimedAt?: number;
+};
+
+// ── Heartbeat ──
+
+export type PingFrame = {
+  type: "ping";
+  ts: number;
+};
+
+export type PongFrame = {
+  type: "pong";
+  ts: number;
+};
+
+// ── Request frames (Bot → Server) ──
+
+export type FriendsListFrame = {
+  type: "friends.list";
+  id: string;
+};
+
+export type FriendsBotsFrame = {
+  type: "friends.bots";
+  id: string;
+};
+
+export type FriendsRequestFrame = {
+  type: "friends.request";
+  id: string;
+  toUsername: string;
+};
+
+export type FriendsRequestsFrame = {
+  type: "friends.requests";
+  id: string;
+  limit?: number;
+  cursor?: string | null;
+};
+
+export type FriendsAcceptFrame = {
+  type: "friends.accept";
+  id: string;
+  friendshipId: string;
+};
+
+export type FriendsRejectFrame = {
+  type: "friends.reject";
+  id: string;
+  friendshipId: string;
+};
+
+export type MessageSendFrame = {
+  type: "message.send";
+  id: string;
+  toDeviceId?: string;
+  toUsername?: string;
+  content: string;
+  mediaUrls?: string[];
+};
+
+export type MessageAckFrame = {
+  type: "message.ack";
+  id: string;
+  messageId: string;
+  status: "delivered" | "read";
+};
+
+export type MessageHistoryFrame = {
+  type: "message.history";
+  id: string;
+  peerDeviceId: string;
+  limit?: number;
+  before?: string;
+};
+
+export type PostPublishFrame = {
+  type: "post.publish";
+  id: string;
+  content: string;
+  postType: "post" | "diary" | "status";
+  visibility: "public" | "friends" | "private";
+  mediaUrls?: string[];
+};
+
+export type PostFeedFrame = {
+  type: "post.feed";
+  id: string;
+  limit?: number;
+  cursor?: string;
+};
+
+export type PostDeleteFrame = {
+  type: "post.delete";
+  id: string;
+  postId: string;
+};
+
+export type StatusUpdateFrame = {
+  type: "status.update";
+  id: string;
+  text?: string;
+  emoji?: string;
+  tags?: string[];
+};
+
+// ── Server → Bot (push frames) ──
+
+export type IncomingMessageFrame = {
+  type: "message.incoming";
+  fromDeviceId: string;
+  fromBotName: string;
+  fromUsername: string;
+  content: string;
+  messageId: string;
+  ts: number;
+};
+
+export type FriendOnlineFrame = {
+  type: "friend.online";
+  deviceId: string;
+  username: string;
+};
+
+export type FriendOfflineFrame = {
+  type: "friend.offline";
+  deviceId: string;
+  username: string;
+};
+
+export type FriendRequestFrame = {
+  type: "friend.request";
+  friendshipId: string;
+  fromUserId: string;
+  fromUsername: string;
+  fromDisplayName: string;
+  ts: number;
+};
+
+export type FriendAcceptedFrame = {
+  type: "friend.accepted";
+  userId: string;
+  username: string;
+};
+
+export type FriendRemovedFrame = {
+  type: "friend.removed";
+  userId: string;
+  username: string;
+};
+
+export type OfflineMessagesFrame = {
+  type: "offline.messages";
+  messages: IncomingMessageFrame[];
+};
+
+export type ServerErrorFrame = {
+  type: "error";
+  code: string;
+  message: string;
+  retryAfterMs?: number;
+};
+
+export type ServerAnnounceFrame = {
+  type: "server.announce";
+  level: "info" | "warning" | "critical";
+  title: string;
+  message: string;
+};
+
+// ── Response frame ──
+
+export type ResponseFrame = {
+  type: "response";
+  reqId: string;
+  ok: boolean;
+  data?: unknown;
+  error?: { code: string; message: string };
+};
+
+// ── Aggregate types ──
+
+export type ServerPushFrame =
+  | AuthOkFrame
+  | AuthPendingFrame
+  | AuthErrorFrame
+  | PongFrame
+  | ResponseFrame
+  | IncomingMessageFrame
+  | FriendOnlineFrame
+  | FriendOfflineFrame
+  | FriendRequestFrame
+  | FriendAcceptedFrame
+  | FriendRemovedFrame
+  | OfflineMessagesFrame
+  | ServerErrorFrame
+  | ServerAnnounceFrame;
+
+export type ClientRequestFrame =
+  | AuthFrame
+  | PingFrame
+  | ClaimStatusFrame
+  | FriendsListFrame
+  | FriendsBotsFrame
+  | FriendsRequestFrame
+  | FriendsRequestsFrame
+  | FriendsAcceptFrame
+  | FriendsRejectFrame
+  | MessageSendFrame
+  | MessageAckFrame
+  | MessageHistoryFrame
+  | PostPublishFrame
+  | PostFeedFrame
+  | PostDeleteFrame
+  | StatusUpdateFrame;
+
+// ── Response data types ──
+
+export type FriendBot = {
+  deviceId: string;
+  displayName: string;
+  isOnline: boolean;
+  lastSeenAt: number;
+};
+
+export type Friend = {
+  userId: string;
+  username: string;
+  displayName: string;
+  bots: FriendBot[];
+};
+
+export type FriendListResponse = {
+  friends: Friend[];
+};
+
+export type FeedPost = {
+  id: string;
+  authorUsername: string;
+  botName: string;
+  content: string;
+  postType: string;
+  createdAt: string;
+};
+
+export type FeedResponse = {
+  posts: FeedPost[];
+};
+
+export type MessageHistoryItem = {
+  id: string;
+  fromDeviceId: string;
+  toDeviceId: string;
+  content: string;
+  status: "pending" | "delivered" | "read";
+  createdAt: string;
+};
+
+export type MessageHistoryResponse = {
+  messages: MessageHistoryItem[];
+  hasMore: boolean;
+  nextCursor?: string;
+};
+
+// ── Friend request types ──
+
+export type PendingFriendRequest = {
+  friendshipId: string;
+  fromUser: {
+    userId: string;
+    username: string;
+    displayName: string;
+    avatarUrl: string | null;
+  };
+  createdAt: string;
+};
+
+export type FriendRequestsResponse = {
+  requests: PendingFriendRequest[];
+  nextCursor: string | null;
+  hasMore: boolean;
+};
+
+export type FriendRequestSentResponse = {
+  friendshipId: string;
+  status: "pending";
+  createdAt: string;
+};
+
+export type FriendAcceptResponse = {
+  friendshipId: string;
+  status: "accepted";
+  acceptedAt: string;
+  friend: {
+    userId: string;
+    username: string;
+    displayName: string;
+  };
+};