@deepdesk/deepdesk-sdk 19.7.2-beta.0 → 19.7.2-beta.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.mts CHANGED
@@ -2215,6 +2215,18 @@ interface WidgetOptions {
2215
2215
  openAdminFeedback?: OpenAdminFeedbackHandler;
2216
2216
  knowledgeAssist?: KnowledgeAssistOptions;
2217
2217
  assistantOptions?: Omit<EvaluateInput, 'assistantCode'>;
2218
+ /**
2219
+ * Mount the search overlay (command palette) next to the widget, so the widget's Search
2220
+ * button and CMD+K open a search box inside the widget's own frame.
2221
+ *
2222
+ * Set this only when nothing else on the page already mounts a search box, for example an
2223
+ * iframe whose host page has no Deepdesk SDK. When the host page already mounts one (it
2224
+ * calls `mount()` and receives the widget's `ShowCommandPalette` event), leave it off:
2225
+ * the search would open twice and the copy inside the widget would cover the widget.
2226
+ *
2227
+ * @default false
2228
+ */
2229
+ mountSearchOverlay?: boolean;
2218
2230
  }
2219
2231
  interface KnowledgeAssistantWidgetOptions extends KnowledgeAssistOptions {
2220
2232
  customStyles?: WidgetCustomStyles;
@@ -2243,6 +2255,8 @@ declare class DeepdeskSDK {
2243
2255
  private dialogOverlaysCustomStyles;
2244
2256
  /** OR of includeLoginOverlay across ensureDialogOverlays callers (mount can upgrade widget-only). */
2245
2257
  private dialogOverlaysIncludeLogin;
2258
+ /** True while the rendered widget asked for the shared overlays (`mountSearchOverlay`). */
2259
+ private widgetOwnsDialogOverlays;
2246
2260
  private nicknameDialogUnsubscribe;
2247
2261
  private nicknameDialogFailed;
2248
2262
  private dynamicThunkObject;
@@ -3549,6 +3563,11 @@ declare class DeepdeskSDK {
3549
3563
  */
3550
3564
  private ensureDialogOverlays;
3551
3565
  private disposeDialogOverlays;
3566
+ /**
3567
+ * `mount()` is done with the shared overlays. They go away unless the rendered widget asked
3568
+ * for them (`mountSearchOverlay`); then only what `mount()` added, the login overlay, goes.
3569
+ */
3570
+ private releaseDialogOverlaysFromMount;
3552
3571
  private renderOverlays;
3553
3572
  /**
3554
3573
  * Renders the Deepdesk widget in a container element.
@@ -3560,10 +3579,11 @@ declare class DeepdeskSDK {
3560
3579
  * **Important:** Make sure to set the container element to a fixed or minimum size
3561
3580
  * (height and width) as the widget will grow to fill the container.
3562
3581
  *
3563
- * Also mounts dialog overlays (search command palette / CMD+K) so iframe-only
3564
- * integrations that never call {@link mount} still get search. Shared with `mount()` —
3565
- * only one overlays root exists per SDK instance. Does **not** mount `LoginOverlay`
3566
- * (iframe apps use their own sign-in); `mount()` still can.
3582
+ * Mounts dialog overlays (search command palette / CMD+K) only when
3583
+ * `options.mountSearchOverlay` is `true`, for iframe-only integrations that never call
3584
+ * {@link mount} and whose host page has no search box. Shared with `mount()` — only one
3585
+ * overlays root exists per SDK instance. Does **not** mount `LoginOverlay` (iframe apps
3586
+ * use their own sign-in); `mount()` still can.
3567
3587
  *
3568
3588
  * **Note:** Only one widget can be rendered per SDK instance.
3569
3589
  *
@@ -3574,6 +3594,7 @@ declare class DeepdeskSDK {
3574
3594
  * @param options.isEmbedded - Whether the widget is embedded in another application
3575
3595
  * @param options.knowledgeAssist - Knowledge assistant configuration
3576
3596
  * @param options.assistantOptions - Assistant evaluation options
3597
+ * @param options.mountSearchOverlay - Mount a search box inside the widget's frame (default: false)
3577
3598
  *
3578
3599
  * @example
3579
3600
  * ```typescript
package/dist/index.d.ts CHANGED
@@ -2215,6 +2215,18 @@ interface WidgetOptions {
2215
2215
  openAdminFeedback?: OpenAdminFeedbackHandler;
2216
2216
  knowledgeAssist?: KnowledgeAssistOptions;
2217
2217
  assistantOptions?: Omit<EvaluateInput, 'assistantCode'>;
2218
+ /**
2219
+ * Mount the search overlay (command palette) next to the widget, so the widget's Search
2220
+ * button and CMD+K open a search box inside the widget's own frame.
2221
+ *
2222
+ * Set this only when nothing else on the page already mounts a search box, for example an
2223
+ * iframe whose host page has no Deepdesk SDK. When the host page already mounts one (it
2224
+ * calls `mount()` and receives the widget's `ShowCommandPalette` event), leave it off:
2225
+ * the search would open twice and the copy inside the widget would cover the widget.
2226
+ *
2227
+ * @default false
2228
+ */
2229
+ mountSearchOverlay?: boolean;
2218
2230
  }
2219
2231
  interface KnowledgeAssistantWidgetOptions extends KnowledgeAssistOptions {
2220
2232
  customStyles?: WidgetCustomStyles;
@@ -2243,6 +2255,8 @@ declare class DeepdeskSDK {
2243
2255
  private dialogOverlaysCustomStyles;
2244
2256
  /** OR of includeLoginOverlay across ensureDialogOverlays callers (mount can upgrade widget-only). */
2245
2257
  private dialogOverlaysIncludeLogin;
2258
+ /** True while the rendered widget asked for the shared overlays (`mountSearchOverlay`). */
2259
+ private widgetOwnsDialogOverlays;
2246
2260
  private nicknameDialogUnsubscribe;
2247
2261
  private nicknameDialogFailed;
2248
2262
  private dynamicThunkObject;
@@ -3549,6 +3563,11 @@ declare class DeepdeskSDK {
3549
3563
  */
3550
3564
  private ensureDialogOverlays;
3551
3565
  private disposeDialogOverlays;
3566
+ /**
3567
+ * `mount()` is done with the shared overlays. They go away unless the rendered widget asked
3568
+ * for them (`mountSearchOverlay`); then only what `mount()` added, the login overlay, goes.
3569
+ */
3570
+ private releaseDialogOverlaysFromMount;
3552
3571
  private renderOverlays;
3553
3572
  /**
3554
3573
  * Renders the Deepdesk widget in a container element.
@@ -3560,10 +3579,11 @@ declare class DeepdeskSDK {
3560
3579
  * **Important:** Make sure to set the container element to a fixed or minimum size
3561
3580
  * (height and width) as the widget will grow to fill the container.
3562
3581
  *
3563
- * Also mounts dialog overlays (search command palette / CMD+K) so iframe-only
3564
- * integrations that never call {@link mount} still get search. Shared with `mount()` —
3565
- * only one overlays root exists per SDK instance. Does **not** mount `LoginOverlay`
3566
- * (iframe apps use their own sign-in); `mount()` still can.
3582
+ * Mounts dialog overlays (search command palette / CMD+K) only when
3583
+ * `options.mountSearchOverlay` is `true`, for iframe-only integrations that never call
3584
+ * {@link mount} and whose host page has no search box. Shared with `mount()` — only one
3585
+ * overlays root exists per SDK instance. Does **not** mount `LoginOverlay` (iframe apps
3586
+ * use their own sign-in); `mount()` still can.
3567
3587
  *
3568
3588
  * **Note:** Only one widget can be rendered per SDK instance.
3569
3589
  *
@@ -3574,6 +3594,7 @@ declare class DeepdeskSDK {
3574
3594
  * @param options.isEmbedded - Whether the widget is embedded in another application
3575
3595
  * @param options.knowledgeAssist - Knowledge assistant configuration
3576
3596
  * @param options.assistantOptions - Assistant evaluation options
3597
+ * @param options.mountSearchOverlay - Mount a search box inside the widget's frame (default: false)
3577
3598
  *
3578
3599
  * @example
3579
3600
  * ```typescript