usable zod enum for event names

Author: ahoward2

src/client/pages/chat.tsx

@@ -7,6 +7,7 @@ import {
  ServerToClientEvents,
  ClientToServerEvents,
  KickUser,
+ JoinRoom,
 } from '../../shared/interfaces/chat.interface';
 import { Header } from '../components/header';
 import { UserList } from '../components/list';
@@ -46,7 +47,7 @@ function Chat() {
  navigate({ to: '/', replace: true });
  } else {
  socket.on('connect', () => {
- const joinRoom = {
+ const joinRoom: JoinRoom = {
  roomName,
  user: { socketId: socket.id, ...user },
  eventName: 'join_room',
@@ -88,7 +89,7 @@ function Chat() {
 
  const sendMessage = (message: string) => {
  if (user && socket && roomName) {
- const chatMessage = {
+ const chatMessage: Message = {
  user: {
  userId: user.userId,
  userName: user.userName,

src/server/chat/guards/chat.guard.ts

@@ -12,7 +12,7 @@ import {
 import { RoomService } from '../../room/room.service';
 import { PolicyHandler } from '../../casl/interfaces/policy.interface';
 import {
- EventName,
+ ClientToServerEvents,
  Room as RoomType,
  User,
 } from '../../../shared/interfaces/chat.interface';
@@ -23,7 +23,7 @@ export class ChatPoliciesGuard<
  CtxData extends {
  user: User;
  roomName: RoomType['name'];
- eventName: EventName;
+ eventName: keyof ClientToServerEvents;
  },
 > implements CanActivate
 {

src/shared/interfaces/chat.interface.ts

@@ -1,7 +1,6 @@
 import { z } from 'zod';
 import {
  ChatMessageSchema,
- EventNameSchema,
  JoinRoomSchema,
  KickUserSchema,
  RoomNameSchema,
@@ -10,6 +9,8 @@ import {
  UserIdSchema,
  UserNameSchema,
  UserSchema,
+ ServerToClientEventsSchema,
+ ClientToServerEventsSchema,
 } from '../schemas/chat.schema';
 
 export type UserId = z.infer<typeof UserIdSchema>;
@@ -19,22 +20,10 @@ export type User = z.infer<typeof UserSchema>;
 
 export type RoomName = z.infer<typeof RoomNameSchema>;
 export type Room = z.infer<typeof RoomSchema>;
-export type EventName = z.infer<typeof EventNameSchema>;
 export type Message = z.infer<typeof ChatMessageSchema>;
 
 export type JoinRoom = z.infer<typeof JoinRoomSchema>;
 export type KickUser = z.infer<typeof KickUserSchema>;
 
-export interface ServerToClientEvents {
- chat: (e: Message) => void;
- kick_user: (e: KickUser) => void;
-}
-
-export interface ClientToServerEvents {
- chat: (e: Message) => void;
- join_room: (e: JoinRoom) => void;
- kick_user: (
- e: KickUser,
- completionCallback: (complete: boolean) => void,
- ) => void;
-}
+export type ServerToClientEvents = z.infer<typeof ServerToClientEventsSchema>;
+export type ClientToServerEvents = z.infer<typeof ClientToServerEventsSchema>;

src/shared/schemas/chat.schema.ts

@@ -24,7 +24,7 @@ export const RoomNameSchema = z
  message: 'Must not contain spaces or special characters.',
  });
 
-export const EventNameSchema = z.string();
+export const EventNameSchema = z.enum(['chat', 'kick_user', 'join_room']);
 
 export const SocketIdSchema = z
  .string()
@@ -62,3 +62,17 @@ export const KickUserSchema = z.object({
  roomName: RoomNameSchema,
  eventName: EventNameSchema,
 });
+
+export const ClientToServerEventsSchema = z.object({
+ chat: z.function().args(ChatMessageSchema).returns(z.void()),
+ join_room: z.function().args(JoinRoomSchema).returns(z.void()),
+ kick_user: z
+ .function()
+ .args(KickUserSchema, z.function().args(z.boolean()).returns(z.void()))
+ .returns(z.void()),
+});
+
+export const ServerToClientEventsSchema = z.object({
+ chat: z.function().args(ChatMessageSchema).returns(z.void()),
+ kick_user: z.function().args(KickUserSchema).returns(z.void()),
+});