@spotlightjs/overlay 0.0.19 → 0.0.21

package/dist/sidecar.d.ts

@@ -1,4 +1,3 @@
 import React from 'react';
 import { Integration, IntegrationData } from './integrations/integration';
-import { TriggerButtonCount } from './types';
-export declare function connectToSidecar(sidecar: string, contentTypeToIntegrations: Map<string, Integration<unknown>[]>, setIntegrationData: React.Dispatch<React.SetStateAction<IntegrationData<unknown>>>, setOnline: React.Dispatch<React.SetStateAction<boolean>>, setTriggerButtonCount: React.Dispatch<React.SetStateAction<TriggerButtonCount>>): () => void;
+export declare function connectToSidecar(sidecarUrl: string, contentTypeToIntegrations: Map<string, Integration<unknown>[]>, setIntegrationData: React.Dispatch<React.SetStateAction<IntegrationData<unknown>>>, setOnline: React.Dispatch<React.SetStateAction<boolean>>): () => void;

package/dist/types.d.ts

@@ -1,6 +1,80 @@
-export type TriggerButtonCount = {
-    general: number;
-    severe: number;
+import { Anchor } from './components/Trigger';
+import { Integration } from './integrations/integration';
+export type SpotlightOverlayOptions = {
+    /**
+     * Array of Spotlight integrations to enable when the Overlay initializes.
+     *
+     * Usage:
+     * ```js
+     * integrations: [sentry(), myIntegration()]
+     * ```
+     *
+     * @default [sentry()]
+     */
+    integrations?: Integration[];
+    /**
+     * Set a URL to a custom Spotlight Sidecar instance. The Spotlight overlay
+     * will use this URL instead of the default URL to connect to the sidecar
+     * and to listen to incoming events.
+     *
+     * @default "http://localhost:8969/stream"
+     */
+    sidecarUrl?: string;
+    /**
+     * If set to `true`, the Spotlight overlay Window will be opened immediately
+     * after calling the init function.
+     *
+     * @default false - only the Spotlight button is visible.
+     */
+    openOnInit?: boolean;
+    /**
+     * By default, Spotlight waits until the host page is loaded before injecting the
+     * Spotlight Overlay. Depending on how and when the init call is made, the load
+     * event might have already happened.
+     *
+     * Setting injectImmediately to `true`, will inject the UI synchronously with the
+     * `init` call, regardless of the host page's load state.
+     *
+     * Use this option, if you called `init()` but the Spotlight Overlay UI is not visible.
+     *
+     * @default false
+     */
+    injectImmediately?: boolean;
+    /**
+     * If set to `false`, the Spotlight button will not be visible.
+     * This is useful if Spotlight is integrated into an existing UI,
+     * such as the Astro Dev Overlay.
+     *
+     * @default true
+     */
+    showTriggerButton?: boolean;
+    /**
+     * Set this option to define where the spotlight button should be anchored.
+     *
+     * @default "bottomRight"
+     */
+    anchor?: Anchor;
+    /**
+     * If set to `true`, the Spotlight overlay will log additional debug messages to the console.
+     *
+     * @default false
+     */
+    debug?: boolean;
+    /**
+     * TODO: Remove? No longer needed with new approach
+     */
+    defaultEventId?: string;
+};
+export type NotificationCount = {
+    /**
+     * Numbers of notifications
+     */
+    count: number;
+    /**
+     * Indicating that among the notification count, there's at least one severe notification.
+     * (This has impact on the UI, e.g. the notification count badge will be red)
+     */
+    severe?: boolean;
 };
 export type WindowWithSpotlight = Window & {
     __spotlight?: {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@spotlightjs/overlay",
   "description": "The overlay of Spotlight to add debug interface to your web app.",
-  "version": "0.0.19",
+  "version": "0.0.21",
   "license": "Apache-2.0",
   "type": "module",
   "files": [
@@ -50,7 +50,7 @@
   },
   "scripts": {
     "dev": "vite build --watch",
-    "build": "tsc && vite build",
+    "build": "NODE_ENV=production tsc && vite build",
     "build:watch": "vite build --watch",
     "preview": "vite preview",
     "test": "vitest",