@pushwoosh/websdk-common 0.0.0 → 6.17.0

package/subscription-widget/types.d.ts

@@ -0,0 +1,90 @@
+import { type WebPopupColors, type WebPopupColorSchemePref, type WebPopupDark } from '../web-popups/types';
+/** How the ask is drawn: a corner/edge card, a full-width bar, or a centered modal. */
+export type SubscriptionWidgetLayout = 'card' | 'bar' | 'modal';
+/** Screen corner a launcher or a card sits in. */
+export type SubscriptionWidgetCorner = 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right';
+/** Where the prompt sits; each layout accepts a subset (see SUBSCRIPTION_WIDGET_POSITIONS). */
+export type SubscriptionWidgetPosition = SubscriptionWidgetCorner | 'top' | 'bottom' | 'center';
+/** What opens the prompt: a timer on page load, a launcher click only, or the host API only. */
+export type SubscriptionWidgetTrigger = 'auto' | 'launcher' | 'manual';
+/** Browser notification permission as the host sees it; 'granted' = subscribed. */
+export type SubscriptionWidgetPermission = 'default' | 'granted' | 'denied' | 'unsupported';
+/** 'ask' invites to subscribe, 'blocked' explains how to unblock notifications in the browser. */
+export type SubscriptionWidgetPromptVariant = 'ask' | 'blocked';
+/** Every visitor-facing string of the widget. */
+export type SubscriptionWidgetTexts = {
+    title: string;
+    message: string;
+    acceptText: string;
+    declineText: string;
+    /** Dismisses the 'blocked' prompt. */
+    closeText: string;
+    blockedTitle: string;
+    blockedMessage: string;
+    /** Launcher tooltip while the visitor can still subscribe. */
+    launcherLabel: string;
+    /** Launcher tooltip while notifications are blocked. */
+    launcherBlockedLabel: string;
+};
+/** The ask itself. */
+export type SubscriptionWidgetPrompt = {
+    layout: SubscriptionWidgetLayout;
+    position: SubscriptionWidgetPosition;
+    /** Image drawn beside the copy; absent = no image. */
+    iconUrl?: string;
+    borderRadius: number;
+    /** Page dim behind the prompt; a modal always has one. */
+    overlay: boolean;
+};
+/** The floating bell that reopens the prompt. */
+export type SubscriptionWidgetLauncher = {
+    enabled: boolean;
+    position: SubscriptionWidgetCorner;
+    /** Distance from the screen edges, px. */
+    offset: number;
+    /** Button diameter, px. */
+    size: number;
+};
+/** When the prompt shows by itself. */
+export type SubscriptionWidgetDisplay = {
+    trigger: SubscriptionWidgetTrigger;
+    /** Seconds after page load before an auto show. */
+    delay: number;
+    /** Auto shows per visitor; 0 = unlimited. */
+    cappingCount: number;
+    /** Hours between two auto shows. */
+    cappingInterval: number;
+};
+/** The whole widget configuration as stored in the WebSDK config (`subscriptionWidget`). */
+export type SubscriptionWidgetConfig = {
+    enable: boolean;
+    prompt: SubscriptionWidgetPrompt;
+    launcher: SubscriptionWidgetLauncher;
+    display: SubscriptionWidgetDisplay;
+    texts: SubscriptionWidgetTexts;
+    colors: WebPopupColors;
+    dark?: WebPopupDark;
+    fontFamily: string;
+    zIndex: number;
+};
+/** What the host remembers about auto shows for one visitor. */
+export type SubscriptionWidgetHistory = {
+    shownCount: number;
+    /** Epoch ms of the last auto show; null = never shown. */
+    lastShownAt: number | null;
+};
+/** 'live' draws fixed to the viewport; 'preview' draws the same inside the nearest positioned parent. */
+export type SubscriptionWidgetReaderMode = 'live' | 'preview';
+export type SubscriptionWidgetReaderProps = {
+    config: SubscriptionWidgetConfig;
+    permission: SubscriptionWidgetPermission;
+    /** Whether the prompt is on screen; the host owns this state. */
+    open: boolean;
+    mode?: SubscriptionWidgetReaderMode;
+    colorScheme?: WebPopupColorSchemePref;
+    /** Disables the accept button while the browser permission dialog is up. */
+    busy?: boolean;
+    onAccept?: () => void;
+    onDecline?: () => void;
+    onLauncherClick?: () => void;
+};

package/subscription-widget/types.js

@@ -0,0 +1 @@
+export {};

package/web-popups/WebPopupReader.d.ts

@@ -0,0 +1,4 @@
+import { type WebPopupBoxProps, type WebPopupReaderProps, type WebPopupSlotViewProps } from './types';
+export declare function WebPopupSlotView({ slot, align, inverse, colors, mode, onRequestClose, onPageChange, onSubmitForm, onSubmitChoice, onSubmitRating, onRequestSubscribe, }: WebPopupSlotViewProps): import("react").JSX.Element;
+export declare function WebPopupBox({ page, params, mode, colorScheme, leafRenderers, animatePage, onRequestClose, onPageChange, onSubmitForm, onSubmitChoice, onSubmitRating, onRequestSubscribe, }: WebPopupBoxProps): import("react").JSX.Element;
+export declare function WebPopupReader({ params, mode, colorScheme, onRequestClose, onSubmitForm, onSubmitChoice, onSubmitRating, onRequestSubscribe, leafRenderers, }: WebPopupReaderProps): import("react").JSX.Element | null;