@neta-art/cohub 1.9.0 → 1.10.1

package/dist/debugger.d.ts

@@ -0,0 +1,198 @@
+//#region src/debugger.d.ts
+type CohubConsoleLevel = "debug" | "error" | "info" | "log" | "trace" | "warn";
+type CohubNetworkKind = "eventsource" | "fetch" | "resource" | "websocket" | "xhr";
+type CohubNetworkPhase = "abort" | "close" | "error" | "line" | "message" | "open" | "request" | "response" | "timeout";
+interface CohubDebuggerOptions {
+  enabled?: boolean;
+  maxConsoleEntries?: number;
+  maxNetworkEntries?: number;
+  maxPayloadBytes?: number;
+  maxLineBytes?: number;
+  captureHeaders?: boolean;
+  captureRequestBody?: boolean;
+  captureResponseBody?: boolean;
+  redactHeaders?: string[];
+}
+interface CohubDebuggerHandle {
+  exportLog: () => CohubDebugLogPackage;
+  exportHar: () => CohubDebugHar;
+  clear: () => void;
+  stop: () => void;
+}
+interface CohubDebugLogPackage {
+  version: 1;
+  exportedAt: string;
+  startedAt: string;
+  userAgent?: string;
+  url?: string;
+  options: Required<CohubDebuggerOptions>;
+  console: CohubConsoleEntry[];
+  network: CohubNetworkEntry[];
+  dropped: {
+    console: number;
+    network: number;
+  };
+}
+interface CohubConsoleEntry {
+  id: number;
+  at: string;
+  elapsedMs: number;
+  level: CohubConsoleLevel;
+  args: SerializedValue[];
+  stack?: string;
+}
+interface CohubNetworkEntry {
+  id: number;
+  connectionId: string;
+  at: string;
+  elapsedMs: number;
+  kind: CohubNetworkKind;
+  phase: CohubNetworkPhase;
+  method?: string;
+  url: string;
+  status?: number;
+  statusText?: string;
+  durationMs?: number;
+  requestHeaders?: Record<string, string>;
+  responseHeaders?: Record<string, string>;
+  direction?: "incoming" | "outgoing";
+  source?: "instrumentation" | "performance";
+  initiatorType?: string;
+  lineNumber?: number;
+  sizeBytes?: number;
+  truncated?: boolean;
+  eventName?: string;
+  payload?: SerializedValue | string;
+  error?: string;
+  close?: {
+    code: number;
+    reason: string;
+    wasClean: boolean;
+  };
+}
+interface CohubDebugHar {
+  log: {
+    version: "1.2";
+    creator: {
+      name: "@neta-art/cohub/debugger";
+      version: string;
+    };
+    browser?: {
+      name: string;
+      version: string;
+    };
+    pages: HarPage[];
+    entries: HarEntry[];
+    _cohub?: {
+      exportedAt: string;
+      startedAt: string;
+      dropped: {
+        console: number;
+        network: number;
+      };
+    };
+  };
+}
+interface HarPage {
+  startedDateTime: string;
+  id: string;
+  title: string;
+  pageTimings: {
+    onContentLoad: number;
+    onLoad: number;
+  };
+}
+interface HarEntry {
+  pageref: string;
+  startedDateTime: string;
+  time: number;
+  request: HarRequest;
+  response: HarResponse;
+  cache: Record<string, never>;
+  timings: HarTimings;
+  serverIPAddress: string;
+  connection: string;
+  _resourceType: string;
+  _cohubConnectionId: string;
+  _cohubKind: CohubNetworkKind;
+  _cohubSource?: "instrumentation" | "performance";
+  _cohubEntries: CohubNetworkEntry[];
+  _cohubMessages?: HarCohubMessage[];
+  _webSocketMessages?: HarWebSocketMessage[];
+}
+interface HarRequest {
+  method: string;
+  url: string;
+  httpVersion: string;
+  cookies: HarCookie[];
+  headers: HarNameValuePair[];
+  queryString: HarNameValuePair[];
+  headersSize: number;
+  bodySize: number;
+  postData?: HarPostData;
+}
+interface HarResponse {
+  status: number;
+  statusText: string;
+  httpVersion: string;
+  cookies: HarCookie[];
+  headers: HarNameValuePair[];
+  content: HarContent;
+  redirectURL: string;
+  headersSize: number;
+  bodySize: number;
+}
+interface HarNameValuePair {
+  name: string;
+  value: string;
+}
+interface HarCookie extends HarNameValuePair {
+  path?: string;
+  domain?: string;
+  expires?: string | null;
+  httpOnly?: boolean;
+  secure?: boolean;
+}
+interface HarPostData {
+  mimeType: string;
+  text: string;
+  params: HarNameValuePair[];
+}
+interface HarContent {
+  size: number;
+  mimeType: string;
+  text?: string;
+  encoding?: string;
+}
+interface HarTimings {
+  blocked: number;
+  dns: number;
+  connect: number;
+  send: number;
+  wait: number;
+  receive: number;
+  ssl: number;
+}
+interface HarCohubMessage {
+  time: string;
+  direction?: "incoming" | "outgoing";
+  lineNumber?: number;
+  eventName?: string;
+  data: string;
+}
+interface HarWebSocketMessage {
+  type: "receive" | "send";
+  time: number;
+  opcode: number;
+  data: string;
+}
+type SerializedValue = null | boolean | number | string | SerializedValue[] | {
+  [key: string]: SerializedValue;
+};
+declare function startCohubDebugger(options?: CohubDebuggerOptions): CohubDebuggerHandle;
+declare function exportCohubDebugLog(): CohubDebugLogPackage;
+declare function exportCohubDebugHar(): CohubDebugHar;
+declare function clearCohubDebugLog(): void;
+declare function stopCohubDebugger(): void;
+//#endregion
+export { CohubConsoleEntry, CohubConsoleLevel, CohubDebugHar, CohubDebugLogPackage, CohubDebuggerHandle, CohubDebuggerOptions, CohubNetworkEntry, CohubNetworkKind, CohubNetworkPhase, HarCohubMessage, HarContent, HarCookie, HarEntry, HarNameValuePair, HarPage, HarPostData, HarRequest, HarResponse, HarTimings, HarWebSocketMessage, SerializedValue, clearCohubDebugLog, exportCohubDebugHar, exportCohubDebugLog, startCohubDebugger, stopCohubDebugger };