@spotlightjs/overlay 2.0.0 → 2.2.0

package/dist/src/index.d.ts

@@ -1,10 +1,14 @@
+import { CONTEXT_LINES_ENDPOINT } from '@spotlightjs/sidecar/constants';
+import { DEFAULT_ANCHOR, DEFAULT_EXPERIMENTS, DEFAULT_SIDECAR_URL } from './constants.ts';
+import { off, on, trigger } from './lib/eventTarget.ts';
 import { React, ReactDOM } from './react-instance.tsx';
 import { SpotlightOverlayOptions } from './types.ts';
 export { default as console } from './integrations/console/index.ts';
 export { default as hydrationError } from './integrations/hydration-error/index.ts';
 export { default as sentry } from './integrations/sentry/index.ts';
 export { default as viteInspect } from './integrations/vite-inspect/index.ts';
-export { React, ReactDOM };
+export type { SpotlightOverlayOptions, WindowWithSpotlight } from './types.ts';
+export { CONTEXT_LINES_ENDPOINT, DEFAULT_ANCHOR, DEFAULT_EXPERIMENTS, DEFAULT_SIDECAR_URL, React, ReactDOM, off, on, trigger, };
 /**
  * Open the Spotlight debugger Window
  */
@@ -16,24 +20,15 @@ export declare function closeSpotlight(): Promise<void>;
 /**
  * Invokes the passed in callback when the Spotlight debugger Window is closed
  */
-export declare function onClose(cb: () => void): Promise<void>;
+export declare function onClose(cb: EventListener): Promise<void>;
 /**
  * Invokes the passed in callback when the Spotlight debugger Window is opened
  */
-export declare function onOpen(cb: () => void): Promise<void>;
+export declare function onOpen(cb: EventListener): Promise<void>;
 /**
  * Register a callback that is invoked when a severe event is processed
  * by a Spotlight integration.
  * A count of the number of collected severe events is passed to the callback.
  */
 export declare function onSevereEvent(cb: (count: number) => void): Promise<void>;
-/**
- * Trigger an event in Spotlight.
- *
- * This is primarily useful for handling an uncaught error/crash, and forcing the debugger
- * to render vs a native error handler.
- *
- * e.g. trigger("sentry.showError", {eventId});
- */
-export declare function trigger(eventName: string, payload: unknown): Promise<void>;
 export declare function init({ openOnInit, showTriggerButton, injectImmediately, sidecarUrl, anchor, debug, integrations, experiments, fullPage, showClearEventsButton, }?: SpotlightOverlayOptions): Promise<void>;

package/dist/src/integrations/integration.d.ts

@@ -1,3 +1,4 @@
+/// <reference types="node" />
 import { type ComponentType } from 'react';
 import { type ExperimentsConfig, type NotificationCount } from '../types';
 export type SpotlightContext = {
@@ -94,7 +95,7 @@ export type RawEventContext = {
      *
      * Return the processed object or undefined if the event should be ignored.
      */
-    data: string;
+    data: string | Buffer;
 };
 type TeardownFunction = () => void | Promise<() => void>;
 export declare function initIntegrations(integrations: Integration<any>[] | undefined, context: SpotlightContext): Promise<[Integration[], TeardownFunction[]]>;

package/dist/src/integrations/sentry/components/traces/spans/SpanItem.d.ts

@@ -1,5 +1,5 @@
 import { Span, TraceContext } from '../../../types';
-declare const SpanItem: ({ span, startTimestamp, totalDuration, depth, traceContext, totalTransactions, spanNodeWidth, setSpanNodeWidth, }: {
+declare const SpanItem: ({ span, startTimestamp, totalDuration, depth, traceContext, totalTransactions, spanNodeWidth, setSpanNodeWidth, query, }: {
     span: Span;
     startTimestamp: number;
     totalDuration: number;
@@ -8,5 +8,6 @@ declare const SpanItem: ({ span, startTimestamp, totalDuration, depth, traceCont
     totalTransactions?: number | undefined;
     spanNodeWidth: number;
     setSpanNodeWidth?: ((val: number) => void) | undefined;
+    query?: string | undefined;
 }) => import("react/jsx-runtime").JSX.Element;
 export default SpanItem;

package/dist/src/integrations/sentry/components/traces/spans/SpanTree.d.ts

@@ -1,5 +1,5 @@
 import { Span, TraceContext } from '../../../types';
-export default function SpanTree({ traceContext, tree, startTimestamp, totalDuration, depth, totalTransactions, spanNodeWidth, setSpanNodeWidth, }: {
+export default function SpanTree({ traceContext, tree, startTimestamp, totalDuration, depth, totalTransactions, spanNodeWidth, setSpanNodeWidth, query, }: {
     traceContext: TraceContext;
     tree: Span[];
     startTimestamp: number;
@@ -8,4 +8,5 @@ export default function SpanTree({ traceContext, tree, startTimestamp, totalDura
     totalTransactions?: number;
     spanNodeWidth: number;
     setSpanNodeWidth?: (val: number) => void;
+    query?: string;
 }): import("react/jsx-runtime").JSX.Element | null;

package/dist/src/integrations/sentry/components/traces/traceDetail/TraceDetailHeader.d.ts

@@ -0,0 +1,4 @@
+import { Trace } from '../../../../../integrations/sentry/types';
+export default function TraceDetailHeader({ trace }: {
+    trace: Trace;
+}): import("react/jsx-runtime").JSX.Element;

package/dist/src/integrations/sentry/components/traces/traceDetail/index.d.ts

@@ -0,0 +1 @@
+export default function TraceDetails(): import("react/jsx-runtime").JSX.Element;

package/dist/src/integrations/sentry/components/traces/traceInfo/TraceGeneralInfo.d.ts

@@ -0,0 +1,6 @@
+import { Trace } from '../../../../../integrations/sentry/types';
+type TraceGeneralInfoProps = {
+    trace: Trace;
+};
+export default function TraceGeneralInfo({ trace }: TraceGeneralInfoProps): import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/src/integrations/sentry/components/traces/traceInfo/TraceTags.d.ts

@@ -0,0 +1,6 @@
+import { Trace } from '../../../../../integrations/sentry/types';
+type TraceTagsProps = {
+    trace: Trace;
+};
+export default function TraceTags({ trace }: TraceTagsProps): import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/src/integrations/sentry/components/traces/traceInfo/index.d.ts

@@ -0,0 +1,6 @@
+import { TraceContext } from '../../../types';
+type TraceInfoProps = {
+    traceContext: TraceContext;
+};
+export default function TraceInfo({ traceContext }: TraceInfoProps): import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/src/integrations/sentry/data/sentryDataCache.d.ts

@@ -1,6 +1,6 @@
 import { Envelope } from '@sentry/types';
 import { RawEventContext } from '../../../integrations/integration';
-import { Sdk, SentryEvent, Span, Trace } from '../types';
+import { Sdk, SentryErrorEvent, SentryEvent, Span, Trace } from '../types';
 type OnlineSubscription = ['online', (status: boolean) => void];
 type EventSubscription = ['event', (event: SentryEvent) => void];
 type TraceSubscription = ['trace', (trace: Trace) => void];
@@ -19,17 +19,19 @@ declare class SentryDataCache {
         rawEnvelope: RawEventContext;
     }[];
     protected subscribers: Map<string, Subscription>;
+    protected contextLinesProvider: string;
     constructor(initial?: (SentryEvent & {
         event_id?: string;
     })[]);
+    setSidecarUrl(url: string): void;
     inferSdkFromEvent(event: SentryEvent): Sdk;
     pushEnvelope({ envelope, rawEnvelope }: {
         envelope: Envelope;
         rawEnvelope: RawEventContext;
-    }): void;
+    }): number;
     pushEvent(event: SentryEvent & {
         event_id?: string;
-    }): void;
+    }): Promise<void>;
     getEvents(): SentryEvent[];
     getTraces(): Trace[];
     getSdks(): Sdk[];
@@ -56,6 +58,12 @@ declare class SentryDataCache {
      * information about any session-initiated traces.
      */
     isTraceLocal(traceId: string): boolean | null;
+    /**
+     * Reverses the stack trace and tries to fill missing context lines
+     * @param errorEvent
+     * @returns
+     */
+    processStacktrace(errorEvent: SentryErrorEvent): Promise<void[]>;
 }
 declare const _default: SentryDataCache;
 export default _default;

package/dist/src/integrations/sentry/data/sentryEventsContext.d.ts

@@ -1,6 +1,6 @@
 import type { ReactNode } from 'react';
 import React from 'react';
-import { SentryEvent } from '../types';
+import type { SentryEvent } from '../types';
 interface SetEventsAction {
     e: SentryEvent | SentryEvent[];
     action: string;

package/dist/src/integrations/sentry/hooks/useDebounce.d.ts

@@ -0,0 +1 @@
+export default function useDebounce<T extends (...args: any[]) => void>(callback: T, delay: number): (...args: Parameters<T>) => void;

package/dist/src/integrations/sentry/index.d.ts

@@ -6,6 +6,8 @@ import TracesTab from './tabs/TracesTab';
 type SentryIntegrationOptions = {
     sidecarUrl?: string;
     injectIntoSDK?: boolean;
+    openLastError?: boolean;
+    retries?: number;
 };
 export default function sentryIntegration(options?: SentryIntegrationOptions): {
     name: string;
@@ -39,6 +41,12 @@ export default function sentryIntegration(options?: SentryIntegrationOptions): {
     })[];
     reset: () => void;
 };
+/**
+ * Implements parser for
+ * @see https://develop.sentry.dev/sdk/envelopes/#serialization-format
+ * @param rawEvent Envelope data
+ * @returns parsed envelope
+ */
 export declare function processEnvelope(rawEvent: RawEventContext): {
     event: Envelope;
     rawEvent: RawEventContext;

package/dist/src/integrations/sentry/sentry-integration.d.ts

@@ -2,9 +2,9 @@ import { Client, Event } from '@sentry/types';
 type SpotlightBrowserIntegrationOptions = {
     /**
      * The URL of the Sidecar instance to connect and forward events to.
-     * If not set, Spotlight will try to connect to the Sidecar running on localhost:8969.
+     * If not set, Spotlight will try to connect to the Sidecar running on DEFAULT_SIDECAR_URL.
      *
-     * @default "http://localhost:8969/stream"
+     * @default DEFAULT_SIDECAR_URL
      */
     sidecarUrl?: string;
 };
@@ -29,9 +29,4 @@ export declare const spotlightIntegration: (options?: SpotlightBrowserIntegratio
     processEvent: (event: Event) => Promise<Event | null>;
     afterAllSetup: (client: Client) => void;
 };
-type FetchImpl = typeof fetch;
-/**
- * We want to get an unpatched fetch implementation to avoid capturing our own calls.
- */
-export declare function getNativeFetchImplementation(): FetchImpl;
 export {};

package/dist/src/integrations/sentry/utils/fetch.d.ts

@@ -0,0 +1,6 @@
+type FetchImpl = typeof fetch;
+/**
+ * We want to get an unpatched fetch implementation to avoid capturing our own calls.
+ */
+export declare function getNativeFetchImplementation(): FetchImpl;
+export {};

package/dist/src/lib/eventTarget.d.ts

@@ -11,3 +11,14 @@
  * which is local to one spotlight code instance.
  */
 export declare function getSpotlightEventTarget(): EventTarget;
+/**
+ * Trigger an event in Spotlight.
+ *
+ * This is primarily useful for handling an uncaught error/crash, and forcing the debugger
+ * to render vs a native error handler.
+ *
+ * e.g. trigger("sentry.showError", {eventId});
+ */
+export declare function trigger(eventName: string, payload?: unknown): Promise<void>;
+export declare function on(eventName: string, cb: EventListener): Promise<void>;
+export declare function off(eventName: string, cb: EventListener): Promise<void>;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@spotlightjs/overlay",
   "description": "The overlay of Spotlight to add debug interface to your web app.",
-  "version": "2.0.0",
+  "version": "2.2.0",
   "license": "Apache-2.0",
   "type": "module",
   "files": [
@@ -30,7 +30,7 @@
     "eslint-plugin-react-hooks": "^4.6.0",
     "eslint-plugin-react-refresh": "^0.4.3",
     "typescript": "^5.0.2",
-    "vite": "^4.5.2",
+    "vite": "^4.5.3",
     "vite-plugin-dts": "^3.5.2",
     "vite-plugin-svgr": "^3.2.0",
     "vitest": "^0.34.6",
@@ -50,7 +50,8 @@
     "react-diff-viewer-continued": "^3.4.0",
     "@types/beautify": "^0.0.3",
     "react-json-view": "^1.21.3",
-    "@spotlightjs/tsconfig": "1.0.0"
+    "@spotlightjs/tsconfig": "1.0.0",
+    "@spotlightjs/sidecar": "1.6.0"
   },
   "volta": {
     "extends": "../../package.json"