@spotlightjs/overlay 0.0.21 → 1.0.0

package/dist/src/components/Badge.d.ts

@@ -0,0 +1,2 @@
+import { type ComponentProps } from 'react';
+export default function Badge(props: Omit<ComponentProps<'span'>, 'className'>): import("react/jsx-runtime").JSX.Element;

package/dist/{components → src/components}/Trigger.d.ts

@@ -1,9 +1,7 @@
-import { NotificationCount } from '../types';
-export declare const DEFAULT_ANCHOR = "bottomRight";
-export type Anchor = 'bottomRight' | 'bottomLeft' | 'centerRight' | 'centerLeft' | 'topLeft' | 'topRight';
+import { NotificationCount, type AnchorConfig } from '../types';
 export default function Trigger({ isOpen, setOpen, notificationCount, anchor, }: {
     isOpen: boolean;
     setOpen: (value: boolean) => void;
     notificationCount: NotificationCount;
-    anchor?: Anchor;
+    anchor?: AnchorConfig;
 }): import("react/jsx-runtime").JSX.Element;

package/dist/src/constants.d.ts

@@ -0,0 +1,5 @@
+export declare const DEFAULT_SIDECAR_URL = "http://localhost:8969/stream";
+export declare const DEFAULT_EXPERIMENTS: {
+    'sentry:focus-local-events': boolean;
+};
+export declare const DEFAULT_ANCHOR = "bottomRight";

package/dist/{index.d.ts → src/index.d.ts}

@@ -33,4 +33,4 @@ export declare function onSevereEvent(cb: (count: number) => void): Promise<void
  * 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, }?: SpotlightOverlayOptions): Promise<void>;
+export declare function init({ openOnInit, showTriggerButton, injectImmediately, sidecarUrl, anchor, debug, integrations, experiments, }?: SpotlightOverlayOptions): Promise<void>;

package/dist/{integrations → src/integrations}/integration.d.ts

@@ -1,8 +1,9 @@
 import { type ComponentType } from 'react';
-import { NotificationCount } from '../types';
+import { type ExperimentsConfig, type NotificationCount } from '../types';
 export type SpotlightContext = {
     open: (path: string | undefined) => void;
     close: () => void;
+    experiments: ExperimentsConfig;
 };
 export type Integration<T = any> = {
     /**

package/dist/src/integrations/sentry/components/HiddenItemsButton.d.ts

@@ -0,0 +1,4 @@
+import { type ComponentProps } from 'react';
+export default function HiddenItemsButton({ itemCount, ...props }: Omit<ComponentProps<'button'>, 'className' | 'children'> & {
+    itemCount: number;
+}): import("react/jsx-runtime").JSX.Element;

package/dist/{integrations → src/integrations}/sentry/data/sentryDataCache.d.ts

@@ -12,6 +12,7 @@ declare class SentryDataCache {
     protected tracesById: {
         [id: string]: Trace;
     };
+    protected localTraceIds: Set<string>;
     protected subscribers: Map<string, Subscription>;
     constructor(initial?: (SentryEvent & {
         event_id?: string;
@@ -29,6 +30,19 @@ declare class SentryDataCache {
     getEventsByTrace(traceId: string, spanId?: string | null): SentryEvent[];
     getSpanById(traceId: string, spanId: string): Span | undefined;
     subscribe(...args: Subscription): () => void;
+    /**
+     * Mark a traceId as being seen in the local session.
+     *
+     * @param traceId
+     */
+    trackLocalTrace(traceId: string): void;
+    /**
+     * Determine if a traceId was seen in the local session.
+     *
+     * A result of `null` means "unknown", which implies there is no known
+     * information about any session-initiated traces.
+     */
+    isTraceLocal(traceId: string): boolean | null;
 }
 declare const _default: SentryDataCache;
 export default _default;

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

@@ -0,0 +1,3 @@
+export declare const useSentryHelpers: () => {
+    isLocalToSession: (traceId: string) => boolean | null;
+};

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

@@ -0,0 +1,4 @@
+/**
+ * Normalizes SDK name to a platform. Can be as specific or unspecific as we support different platforms and SDKs.
+ */
+export declare function sdkToPlatform(name: string): "javascript.astro" | "javascript" | "python" | "php" | "ruby" | "unknown";

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

@@ -0,0 +1,7 @@
+import React, { type ReactNode } from 'react';
+import { type SpotlightContext } from '../integrations/integration';
+export declare const SpotlightContextProvider: React.FC<{
+    children: ReactNode;
+    context: SpotlightContext;
+}>;
+export declare const useSpotlightContext: () => SpotlightContext;

package/dist/{types.d.ts → src/types.d.ts}

@@ -1,5 +1,7 @@
-import { Anchor } from './components/Trigger';
-import { Integration } from './integrations/integration';
+import { type Integration } from './integrations/integration';
+export type ExperimentName = 'sentry:focus-local-events';
+export type ExperimentsConfig = Record<ExperimentName, boolean>;
+export type AnchorConfig = 'bottomRight' | 'bottomLeft' | 'centerRight' | 'centerLeft' | 'topLeft' | 'topRight';
 export type SpotlightOverlayOptions = {
     /**
      * Array of Spotlight integrations to enable when the Overlay initializes.
@@ -53,7 +55,7 @@ export type SpotlightOverlayOptions = {
      *
      * @default "bottomRight"
      */
-    anchor?: Anchor;
+    anchor?: AnchorConfig;
     /**
      * If set to `true`, the Spotlight overlay will log additional debug messages to the console.
      *
@@ -64,6 +66,10 @@ export type SpotlightOverlayOptions = {
      * TODO: Remove? No longer needed with new approach
      */
     defaultEventId?: string;
+    /**
+     * Experimental configuration.
+     */
+    experiments?: ExperimentsConfig;
 };
 export type NotificationCount = {
     /**

package/package.json

@@ -1,15 +1,17 @@
 {
   "name": "@spotlightjs/overlay",
   "description": "The overlay of Spotlight to add debug interface to your web app.",
-  "version": "0.0.21",
+  "version": "1.0.0",
   "license": "Apache-2.0",
   "type": "module",
   "files": [
     "dist"
   ],
   "main": "./dist/sentry-spotlight.js",
+  "types": "./dist/sentry-spotlight.d.ts",
   "exports": {
     ".": {
+      "types": "./dist/sentry-spotlight.d.ts",
       "import": "./dist/sentry-spotlight.js",
       "require": "./dist/sentry-spotlight.umd.cjs"
     }
@@ -27,7 +29,7 @@
     "eslint-plugin-react-hooks": "^4.6.0",
     "eslint-plugin-react-refresh": "^0.4.3",
     "typescript": "^5.0.2",
-    "vite": "^4.4.5",
+    "vite": "^4.5.1",
     "vite-plugin-dts": "^3.5.2",
     "vite-plugin-svgr": "^3.2.0",
     "vitest": "^0.34.6",
@@ -35,7 +37,7 @@
     "@sentry/utils": "^7.77.0",
     "autoprefixer": "^10.4.15",
     "dayjs": "^1.11.9",
-    "platformicons": "^5.6.2",
+    "platformicons": "^5.8.3",
     "postcss": "^8.4.28",
     "react": "^18.2.0",
     "react-dom": "^18.2.0",
@@ -43,7 +45,8 @@
     "sql-formatter": "^12.2.4",
     "tailwindcss": "^3.3.3",
     "usehooks-ts": "^2.9.1",
-    "@spotlightjs/tsconfig": "0.0.1"
+    "magic-string": "^0.30.5",
+    "@spotlightjs/tsconfig": "1.0.0"
   },
   "volta": {
     "extends": "../../package.json"