From 9b6811f0765adb923d4416f20c5cf63198e46c0b Mon Sep 17 00:00:00 2001
From: Lukas Stracke <lukas.stracke@sentry.io>
Date: Thu, 30 Nov 2023 11:12:44 +0100
Subject: [PATCH 1/2] ref(overlay): Rename `fullscreen` option to `openOnInit`

Previously, the name was missleading, suggesting it'd make open the overlay
in fullscreen rather than windowed mode, which it never did.
The only thing this option does is controlling if the overlay window
should be opened immediately when the UI is rendered or if just the
button should be displayed.
---
 packages/overlay/src/App.tsx                  | 18 ++++--------
 packages/overlay/src/index.tsx                |  4 +--
 packages/overlay/src/types.ts                 | 28 +++++++++----------
 .../content/docs/reference/configuration.md   |  7 +++++
 4 files changed, 28 insertions(+), 29 deletions(-)

diff --git a/packages/overlay/src/App.tsx b/packages/overlay/src/App.tsx
index 3c0cba387..f1d0de70e 100644
--- a/packages/overlay/src/App.tsx
+++ b/packages/overlay/src/App.tsx
@@ -1,23 +1,17 @@
 import { useEffect, useState } from 'react';
 import Debugger from './components/Debugger';
-import Trigger, { type Anchor } from './components/Trigger';
+import Trigger from './components/Trigger';
 import type { Integration, IntegrationData } from './integrations/integration';
 import { getSpotlightEventTarget } from './lib/eventTarget';
 import { log } from './lib/logger';
 import { connectToSidecar } from './sidecar';
-import { TriggerButtonCount } from './types';
+import { SpotlightOverlayOptions, TriggerButtonCount } from './types';
 
-type AppProps = {
-  fullScreen?: boolean;
-  showTriggerButton?: boolean;
-  defaultEventId?: string;
-  integrations?: Integration[];
-  sidecarUrl: string;
-  anchor?: Anchor;
-};
+type AppProps = Omit<SpotlightOverlayOptions, 'debug' | 'injectImmediately'> &
+  Required<Pick<SpotlightOverlayOptions, 'sidecarUrl'>>;
 
 export default function App({
-  fullScreen = false,
+  openOnInit = false,
   showTriggerButton = true,
   defaultEventId,
   integrations = [],
@@ -29,7 +23,7 @@ export default function App({
   const [integrationData, setIntegrationData] = useState<IntegrationData<unknown>>({});
   const [isOnline, setOnline] = useState(false);
   const [triggerButtonCount, setTriggerButtonCount] = useState<TriggerButtonCount>({ general: 0, severe: 0 });
-  const [isOpen, setOpen] = useState(fullScreen);
+  const [isOpen, setOpen] = useState(openOnInit);
 
   useEffect(() => {
     // Map that holds the information which kind of content type should be dispatched to which integration(s)
diff --git a/packages/overlay/src/index.tsx b/packages/overlay/src/index.tsx
index 61d476a50..afdf53f1f 100644
--- a/packages/overlay/src/index.tsx
+++ b/packages/overlay/src/index.tsx
@@ -63,7 +63,7 @@ export async function onSevereEvent(cb: (count: number) => void) {
 const DEFAULT_SIDECAR_URL = 'http://localhost:8969/stream';
 
 export async function init({
-  fullScreen = false,
+  openOnInit = false,
   showTriggerButton = true,
   defaultEventId,
   injectImmediately = false,
@@ -114,7 +114,7 @@ export async function init({
     // <React.StrictMode>
     <App
       integrations={initializedIntegrations}
-      fullScreen={fullScreen}
+      openOnInit={openOnInit}
       defaultEventId={defaultEventId}
       showTriggerButton={showTriggerButton}
       sidecarUrl={sidecarUrl}
diff --git a/packages/overlay/src/types.ts b/packages/overlay/src/types.ts
index fd600b731..ab91e55f0 100644
--- a/packages/overlay/src/types.ts
+++ b/packages/overlay/src/types.ts
@@ -14,16 +14,6 @@ export type SpotlightOverlayOptions = {
    */
   integrations?: Integration[];
 
-  /**
-   * TODO: Rename
-   *
-   * If set to `true`, the Spotlight overlay Window will be opened immediately
-   * after calling the init.
-   *
-   * @default false - only the Spotlight button is visible.
-   */
-  fullScreen?: boolean;
-
   /**
    * 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
@@ -34,13 +24,12 @@ export type SpotlightOverlayOptions = {
   sidecarUrl?: string;
 
   /**
-   * 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.
+   * If set to `true`, the Spotlight overlay Window will be opened immediately
+   * after calling the init function.
    *
-   * @default true
+   * @default false - only the Spotlight button is visible.
    */
-  showTriggerButton?: boolean;
+  openOnInit?: boolean;
 
   /**
    * By default, Spotlight waits until the host page is loaded before injecting the
@@ -56,6 +45,15 @@ export type SpotlightOverlayOptions = {
    */
   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.
    *
diff --git a/packages/website/src/content/docs/reference/configuration.md b/packages/website/src/content/docs/reference/configuration.md
index e481b80d9..c9a31fc4c 100644
--- a/packages/website/src/content/docs/reference/configuration.md
+++ b/packages/website/src/content/docs/reference/configuration.md
@@ -92,3 +92,10 @@ init({
   injectImmediately: true,
 });
 ```
+
+### `openOnInit`
+
+**type:** `boolean` **default:** `false`
+
+If set to `true`, the Spotlight overlay Window will be opened immediately after calling the init function. By default,
+only the button is visible.

From d6ba4d8ac52631e34e6a36b2e784d5f722f93704 Mon Sep 17 00:00:00 2001
From: Lukas Stracke <lukas.stracke@sentry.io>
Date: Thu, 30 Nov 2023 11:18:37 +0100
Subject: [PATCH 2/2] changeset

---
 .changeset/polite-glasses-add.md | 5 +++++
 1 file changed, 5 insertions(+)
 create mode 100644 .changeset/polite-glasses-add.md

diff --git a/.changeset/polite-glasses-add.md b/.changeset/polite-glasses-add.md
new file mode 100644
index 000000000..8615b7323
--- /dev/null
+++ b/.changeset/polite-glasses-add.md
@@ -0,0 +1,5 @@
+---
+'@spotlightjs/overlay': patch
+---
+
+ref(overlay): Rename `fullscreen` option to `openOnInit`