@rozenite/network-activity-plugin 1.0.0-alpha.8 → 1.0.0

package/src/ui/state/model.ts

@@ -0,0 +1,140 @@
+import {
+  Initiator,
+  ResourceType,
+  HttpHeaders,
+  RequestPostData,
+} from '../../shared/client';
+
+export type RequestId = string;
+export type Timestamp = number;
+export type SocketId = number;
+export type HttpMethod = 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD';
+
+export type NetworkEntryType = 'http' | 'websocket' | 'sse';
+
+/* HTTP */
+export type HttpRequestData = {
+  type: string;
+  data: NonNullable<RequestPostData>;
+};
+
+export type HttpResponseData = {
+  type: string;
+  data: string;
+};
+
+export type HttpRequest = {
+  url: string;
+  method: HttpMethod;
+  headers: HttpHeaders;
+  body?: HttpRequestData;
+};
+
+export type HttpResponse = {
+  url: string;
+  status: number;
+  statusText: string;
+  headers: HttpHeaders;
+  contentType: string;
+  size: number;
+  responseTime: Timestamp;
+  body?: HttpResponseData;
+};
+
+export type HttpStatus = 'pending' | 'loading' | 'finished' | 'failed';
+
+export type HttpNetworkEntry = {
+  id: RequestId;
+  type: 'http';
+  timestamp: Timestamp;
+  duration?: number;
+
+  request: HttpRequest;
+  response?: HttpResponse;
+  status: HttpStatus;
+  error?: string;
+  canceled?: boolean;
+  ttfb?: number;
+  size?: number;
+  initiator?: Initiator;
+  resourceType?: ResourceType;
+};
+
+/* SSE */
+export type SSEMessage = {
+  id: string;
+  type: string;
+  data: string;
+  timestamp: Timestamp;
+};
+
+export type SSEStatus = 'connecting' | 'open' | 'closed' | 'error';
+
+export type SSENetworkEntry = {
+  id: RequestId;
+  type: 'sse';
+  timestamp: Timestamp;
+  duration?: number;
+
+  request: HttpRequest;
+  response?: HttpResponse;
+  status: SSEStatus;
+  messages: SSEMessage[];
+  error?: string;
+  initiator?: Initiator;
+  resourceType?: ResourceType;
+};
+
+/* WebSocket */
+export type WebSocketConnection = {
+  url: string;
+  socketId: SocketId;
+  protocols?: string[];
+  options?: string[];
+};
+
+export type WebSocketMessage = {
+  id: string;
+  direction: 'sent' | 'received';
+  data: string;
+  messageType: 'text' | 'binary';
+  timestamp: Timestamp;
+};
+
+export type WebSocketStatus =
+  | 'connecting'
+  | 'open'
+  | 'closing'
+  | 'closed'
+  | 'error';
+
+export type WebSocketNetworkEntry = {
+  id: RequestId;
+  type: 'websocket';
+  timestamp: Timestamp;
+  duration?: number;
+
+  connection: WebSocketConnection;
+  status: WebSocketStatus;
+  error?: string;
+  closeCode?: number;
+  closeReason?: string;
+};
+
+/* Shared */
+export type NetworkEntry =
+  | HttpNetworkEntry
+  | WebSocketNetworkEntry
+  | SSENetworkEntry;
+
+export type ProcessedRequest = {
+  id: RequestId;
+  type: NetworkEntryType;
+  name: string;
+  status: HttpStatus | WebSocketStatus | SSEStatus;
+  timestamp: Timestamp;
+  duration?: number;
+  size: number | null;
+  method: HttpMethod | 'WS' | 'SSE';
+  httpStatus?: number;
+};