@zimic/interceptor/src/webSocket/types.ts

Next-gen TypeScript-first HTTP intercepting and mocking

import { JSONValue } from '@zimic/http';
import { PossiblePromise } from '@zimic/utils/types';
import type { WebSocket as ClientSocket } from 'isomorphic-ws';

export interface WebSocketChannelFrame<Channel extends string> {
  id: string;
  channel: Channel;
}

export interface WebSocketEventMessage<
  Schema extends WebSocketSchema,
  Channel extends WebSocketChannel<Schema> = WebSocketChannel<Schema>,
> extends WebSocketChannelFrame<Channel> {
  data: Schema[Channel]['event'];
}

export interface WebSocketReplyMessage<
  Schema extends WebSocketSchema,
  Channel extends WebSocketChannel<Schema> = WebSocketChannel<Schema>,
> extends WebSocketChannelFrame<Channel> {
  data: Schema[Channel]['reply'];
  requestId: string;
}

export type WebSocketMessage<
  Schema extends WebSocketSchema,
  Channel extends WebSocketChannel<Schema> = WebSocketChannel<Schema>,
> = WebSocketEventMessage<Schema, Channel> | WebSocketReplyMessage<Schema, Channel>;

interface BaseWebSocketSchema {
  [channel: string]: {
    event?: JSONValue.Loose;
    reply?: JSONValue.Loose;
  };
}

export type WebSocketSchema<Schema extends BaseWebSocketSchema = BaseWebSocketSchema> = Schema;

export type WebSocketChannel<Schema extends WebSocketSchema> = keyof Schema & string;

export type WebSocketChannelWithNoReply<Schema extends WebSocketSchema> = {
  [Channel in WebSocketChannel<Schema>]: Schema[Channel]['reply'] extends JSONValue ? never : Channel;
}[WebSocketChannel<Schema>];

export type WebSocketChannelWithReply<Schema extends WebSocketSchema> = Exclude<
  WebSocketChannel<Schema>,
  WebSocketChannelWithNoReply<Schema>
>;

export type WebSocketEventMessageListener<Schema extends WebSocketSchema, Channel extends WebSocketChannel<Schema>> = (
  message: WebSocketEventMessage<Schema, Channel>,
  socket: ClientSocket,
) => PossiblePromise<WebSocketReplyMessage<Schema, Channel>['data']>;

export type WebSocketReplyMessageListener<Schema extends WebSocketSchema, Channel extends WebSocketChannel<Schema>> = (
  message: WebSocketReplyMessage<Schema, Channel>,
  socket: ClientSocket,
) => PossiblePromise<void>;

export type WebSocketMessageListener<Schema extends WebSocketSchema, Channel extends WebSocketChannel<Schema>> =
  | WebSocketEventMessageListener<Schema, Channel>
  | WebSocketReplyMessageListener<Schema, Channel>;