@spotlightjs/overlay - npm Package Compare versions

Comparing version 2.4.0 to 2.5.0

dist/App.d.ts

 import type { SpotlightOverlayOptions } from './types';
 type AppProps = Omit<SpotlightOverlayOptions, 'debug' | 'injectImmediately'> & Required<Pick<SpotlightOverlayOptions, 'sidecarUrl'>>;
-export default function App({ openOnInit, showTriggerButton, integrations, sidecarUrl, anchor, fullPage, showClearEventsButton, }: AppProps): import("react/jsx-runtime").JSX.Element;
+export default function App({ openOnInit, showTriggerButton, integrations, sidecarUrl, anchor, fullPage, showClearEventsButton, initialEvents, }: AppProps): import("react/jsx-runtime").JSX.Element;
 export {};

dist/index.d.ts

@@ -27,3 +27,3 @@ import { CONTEXT_LINES_ENDPOINT } from '@spotlightjs/sidecar/constants';
  */
-export declare function sendEvent(contentType: string, data: string): Promise<void>;
+export declare function sendEvent(contentType: string, data: string | Uint8Array): Promise<void>;
 /**
@@ -39,2 +39,2 @@ * Invokes the passed in callback when the Spotlight debugger Window is opened
 export declare function onSevereEvent(cb: (count: number) => void): Promise<void>;
-export declare function init({ openOnInit, showTriggerButton, injectImmediately, sidecarUrl, anchor, debug, integrations, experiments, fullPage, showClearEventsButton, }?: SpotlightOverlayOptions): Promise<void>;
+export declare function init({ openOnInit, showTriggerButton, injectImmediately, sidecarUrl, anchor, debug, integrations, experiments, fullPage, showClearEventsButton, initialEvents, }?: SpotlightOverlayOptions): Promise<void>;

dist/lib/useKeyPress.d.ts

@@ -0,7 +1,10 @@
+type ModifierKeys = 'altKey' | 'ctrlKey' | 'shiftKey' | 'metaKey';
 /**
  * useKeyPress
- * @param {string[]} keys - an array of keys to respond to, compared against event.key
+ * @param {string} key - The letter or name of the key to respond to -- this is normalized to lower case
+ * @param {ModifierKeys[]} modifiers - The modifiers that needs to be activated such as ctrlKey
  * @param {function} action - the action to perform on key press
  * @param {boolean} propagate - whether to stop event propagation (default is false)
  */
-export default function useKeyPress(keys: string[], action: () => void, propagate?: boolean): void;
+export default function useKeyPress(key: string, modifiers: ModifierKeys[], action: () => void, propagate?: boolean): void;
+export {};

dist/sentry-spotlight.js

@@ -1,2 +0,2 @@
-import { C as t, D as o, a as e, b as n, R as i, d as E, h as r, m as p, n as l, l as S, o as D, e as R, i as T, j as g, k as h, f as N, s as _, p as c, t as v, v as A } from "./index-4cc92fd8.js";
+import { C as t, D as o, a as e, b as n, R as i, d as E, h as r, m as p, n as l, l as S, o as D, e as R, i as T, j as g, k as h, f as N, s as _, p as c, t as v, v as A } from "./index-4373983e.js";
 window.Spotlight && Spotlight.init();
@@ -3,0 +3,0 @@ export {

dist/types.d.ts

@@ -1,2 +0,2 @@
-import { type Integration } from './integrations/integration';
+import type { Integration } from './integrations/integration';
 export type ExperimentName = 'sentry:focus-local-events';
@@ -76,3 +76,3 @@ export type ExperimentsConfig = Record<ExperimentName, boolean>;
      * It can't be closed nor minimized.
-     * This is useful for replaceing error page or in when directly rendered as an html page
+     * This is useful for replacing error page or in when directly rendered as an html page
      */
@@ -87,2 +87,8 @@ fullPage?: boolean;
     showClearEventsButton?: boolean;
+    /**
+     * Events to be sent into Spotlight (bypassing the sidecar) right after init
+     *
+     * This is useful when replacing error pages of frameworks etc. Implies "injectImmediately".
+     */
+    initialEvents?: Record<string, (string | Uint8Array)[]>;
 };
@@ -103,3 +109,4 @@ export type NotificationCount = {
         eventTarget?: EventTarget;
+        initOptions?: SpotlightOverlayOptions;
     };
 };

package.json

 {
   "name": "@spotlightjs/overlay",
   "description": "The overlay of Spotlight to add debug interface to your web app.",
-  "version": "2.4.0",
+  "version": "2.5.0",
   "license": "Apache-2.0",
@@ -54,3 +54,3 @@ "type": "module",
     "@spotlightjs/tsconfig": "1.0.0",
-    "@spotlightjs/sidecar": "1.7.0"
+    "@spotlightjs/sidecar": "1.8.0"
   },
@@ -57,0 +57,0 @@ "volta": {

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

7903644

increased by0.04%

Lines of code

37029

increased by0.05%

No dependency changes