@pushwoosh/websdk-common 6.17.1 → 6.19.0

package/subscription-widget/types.d.ts

@@ -28,6 +28,8 @@ export type SubscriptionWidgetTexts = {
 };
 /** The ask itself. */
 export type SubscriptionWidgetPrompt = {
+    /** Whether the prompt is drawn at all; independent of the launcher. */
+    enabled: boolean;
     layout: SubscriptionWidgetLayout;
     position: SubscriptionWidgetPosition;
     /** Image drawn beside the copy; absent = no image. */
@@ -36,15 +38,25 @@ export type SubscriptionWidgetPrompt = {
     /** Page dim behind the prompt; a modal always has one. */
     overlay: boolean;
 };
-/** The floating bell that reopens the prompt. */
+/** The floating bell: opens the prompt when it is on, asks for the permission itself otherwise. */
 export type SubscriptionWidgetLauncher = {
+    /** Whether the bell is drawn at all; independent of the prompt. */
     enabled: boolean;
     position: SubscriptionWidgetCorner;
     /** Distance from the screen edges, px. */
     offset: number;
-    /** Button diameter, px. */
-    size: number;
+    /** Button size, px. */
+    width: number;
+    height: number;
+    /** Picture drawn instead of the round bell button; absent = the bell. */
+    imageUrl?: string;
+    /** Fill of the round button; absent = the palette accent. */
+    background?: string;
+    /** The bell glyph; absent = the label colour over the accent. */
+    iconColor?: string;
 };
+/** What a launcher click does: open the prompt, ask the browser directly, or nothing (blocked). */
+export type SubscriptionWidgetLauncherAction = 'prompt' | 'subscribe' | 'none';
 /** When the prompt shows by itself. */
 export type SubscriptionWidgetDisplay = {
     trigger: SubscriptionWidgetTrigger;
@@ -57,6 +69,7 @@ export type SubscriptionWidgetDisplay = {
 };
 /** The whole widget configuration as stored in the WebSDK config (`subscriptionWidget`). */
 export type SubscriptionWidgetConfig = {
+    /** True when the prompt or the launcher is on, i.e. the widget draws something. */
     enable: boolean;
     prompt: SubscriptionWidgetPrompt;
     launcher: SubscriptionWidgetLauncher;