@inappstory/js-sdk 3.6.4 → 3.6.6

package/dist/types/appearance-manager/storyReader.d.ts

@@ -0,0 +1,260 @@
+import { CloseButtonPosition } from "./appearanceCommon";
+import { SharePanel } from "./sharePanel";
+import { Nullable, RecursivePartial } from "../global";
+
+/**
+ * Defines the swipe animation style used when navigating between stories.
+ *
+ * This affects the visual transition effect when the user swipes to the next or previous story.
+ */
+export declare enum StoryReaderSwipeStyle {
+    /**
+     * Flat swipe with no 3D or overlay effects.
+     * Simple, fast, and performance-optimized.
+     */
+    FLAT = "flat",
+
+    /**
+     * Cover swipe where the next story over the current one.
+     * Offers a layered visual effect.
+     */
+    COVER = "cover",
+
+    /**
+     * 3D cube rotation effect between stories.
+     * Visually rich but more performance-intensive.
+     */
+    CUBE = "cube"
+}
+/**
+ * Enum representing story reader layout variants
+ *
+ * @property {string} Classic - Classic display variant (default)
+ * @property {string} Modern - Modern experimental display variant
+ */
+export declare enum StoryReaderLayout {
+    /** Classic display variant (default) */
+    Classic = "classic",
+
+    /** Modern experimental display variant */
+    Modern = "modern"
+}
+
+/**
+ * Appearance options for Story Reader.
+ */
+export type StoryReaderOptions = RecursivePartial<{
+    /**
+     * Position of the close button.
+     *
+     * @default CloseButtonPosition.END
+     */
+    closeButtonPosition: CloseButtonPosition | "left" | "right";
+
+    /**
+     * Swipe animation style for switching between stories.
+     *
+     * @default StoryReaderSwipeStyle.FLAT
+     */
+    scrollStyle: StoryReaderSwipeStyle | "flat" | "cover" | "cube";
+
+    /**
+     * Vertical offset for the timeline block (in pixels).
+     * @default 8
+     */
+    timelineBlockTopOffset: Nullable<number>;
+
+    /**
+     * Vertical offset for the bottom action panel (in pixels).
+     * @default 0
+     */
+    actionPanelBottomOffset: Nullable<number>;
+
+    /**
+     * Border radius applied to the story container (in pixels).
+     *
+     * @default 12
+     */
+    borderRadius: number;
+
+    /**
+     * Enables the experimental modern layout variant.
+     *
+     * @default false
+     * @deprecated Use `layout` property instead
+     */
+    useExperimentalModernVariant: boolean;
+
+    /**
+     * Layout style for rendering stories.
+     * Can be `'classic'` or `'modern'`.
+     *
+     * @default StoryReaderLayout.Classic
+     */
+    layout: StoryReaderLayout;
+
+    /**
+     * Loader configuration, supports default and custom options.
+     */
+    loader: {
+        default: {
+            /**
+             * Primary loader color.
+             * @default #FFF
+             */
+            color: string;
+            /**
+             * Accent loader color.
+             * @default transparent
+             */
+            accentColor: string;
+        };
+    };
+
+    /**
+     * Whether the story list should loop back to the beginning after the last story.
+     *
+     * @default false
+     */
+    recycleStoriesList: boolean;
+
+    /**
+     * Automatically closes the viewer after the last slide, using a timer.
+     *
+     * @default false
+     */
+    closeOnLastSlideByTimer: boolean;
+
+    /**
+     * Configuration for the share panel.
+     * @see https://docs.inappstory.com/sdk-guides/react-sdk/share-panel.html
+     */
+    sharePanel: SharePanel<string>;
+
+    /**
+     * Global backdrop settings for all slides.
+     */
+    commonBackdrop: {
+        /**
+         * Background color.
+         * @default
+         * rgba(51, 51, 51, 1)
+         */
+        color: string;
+        /**
+         * CSS backdrop filter (e.g., `blur(10px)`).
+         * @default null
+         */
+        backdropFilter: string;
+    };
+
+    /**
+     * Slide-specific backdrop settings.
+     */
+    slideBackdrop: {
+        /**
+         * Opacity of the backdrop layer.
+         * @default 0.56
+         */
+        opacity: number;
+        /**
+         * Blur intensity applied to the backdrop.
+         * @default 30
+         */
+        blur: number;
+        /**
+         * Array of CSS linear-gradient strings used as overlays.
+         * @default
+         * ["rgba(0, 0, 0, 0.1) 0%", "rgba(0, 0, 0, 0.9) 100%"]
+         */
+        linearGradientOverlay: string[];
+    };
+
+    /**
+     * Close button configuration.
+     */
+    closeButton: {
+        svgSrc: {
+            /**
+             * Base (default) SVG icon for the close button.
+             */
+            baseState: string;
+        };
+    };
+
+    /**
+     * Like button configuration.
+     */
+    likeButton: {
+        svgSrc: {
+            /**
+             * SVG icon for the default (inactive) state.
+             */
+            baseState: string;
+            /**
+             * SVG icon for the active (liked) state.
+             */
+            activeState: string;
+        };
+    };
+
+    /**
+     * Dislike button configuration.
+     */
+    dislikeButton: {
+        svgSrc: {
+            /**
+             * SVG icon for the default (inactive) state.
+             */
+            baseState: string;
+            /**
+             * SVG icon for the active (disliked) state.
+             */
+            activeState: string;
+        };
+    };
+
+    /**
+     * Favorite button configuration.
+     */
+    favoriteButton: {
+        svgSrc: {
+            /**
+             * SVG icon for the default (not-favorited) state.
+             */
+            baseState: string;
+            /**
+             * SVG icon for the active (favorited) state.
+             */
+            activeState: string;
+        };
+    };
+
+    /**
+     * Mute button configuration.
+     */
+    muteButton: {
+        svgSrc: {
+            /**
+             * SVG icon for the unmuted state.
+             */
+            baseState: string;
+            /**
+             * SVG icon for the muted state.
+             */
+            activeState: string;
+        };
+    };
+
+    /**
+     * Share button configuration.
+     */
+    shareButton: {
+        svgSrc: {
+            /**
+             * SVG icon for the share button.
+             */
+            baseState: string;
+        };
+    };
+}>;

package/dist/types/events.d.ts

@@ -0,0 +1,207 @@
+/**
+ * Base StoryReader event.
+ * Used as a foundation for most story-related events.
+ */
+export interface StoryReaderEvent {
+    /** Unique story identifier */
+    id: number;
+    /** Story title (optional) */
+    title?: string;
+    /** Number of slides in the story */
+    slidesCount?: number;
+    /** Feed name where the story was loaded from */
+    feed?: string;
+    /** Source of story launch (e.g., deeplink, banner) */
+    source?: string;
+    /** Filters applied to the story list */
+    filter: Record<string, unknown>;
+    /** User-generated payload (e.g., UGC data) */
+    ugcPayload: Record<string, unknown>;
+    /** Number of items in the default list */
+    defaultListLength: number;
+    /** Number of items in the favorites list */
+    favoriteListLength: number;
+}
+
+/**
+ * Possible reasons for closing StoryReader.
+ */
+export enum CloseAction {
+    /** Closed via the close (X) button in UI */
+    closeReaderByCloseBtn = "closeReaderByCloseBtn",
+    /** Closed via ESC key (desktop only) */
+    closeReaderByEscBtn = "closeReaderByEscBtn",
+    /** Closed by swipe down (mobile only) */
+    swipeDown = "swipeDown",
+    /** Closed by swipe to next story (mobile only) */
+    swipe = "swipe",
+    /** Closed by clicking the first (backward) or last (forward) slide */
+    lastSlideClick = "lastSlideClick",
+    /** Closed automatically by timer transition to next story */
+    auto = "auto",
+    /** Closed using public API: StoryManager.closeStoryReader */
+    externalCloseReader = "externalCloseReader"
+}
+
+/** Event: user clicked on a story */
+export interface ClickOnStoryEvent extends StoryReaderEvent {
+    /** Story index inside feed */
+    index: number;
+    /** Whether the click was triggered by deeplink */
+    isDeeplink: boolean;
+    /** URL if click leads externally */
+    url?: string;
+}
+
+/** Event: story was shown */
+export interface ShowStoryEvent extends StoryReaderEvent {}
+
+/** Event: story was closed */
+export interface CloseStoryEvent extends StoryReaderEvent {
+    /** Close reason */
+    action: CloseAction;
+}
+
+/** Event: specific slide was shown */
+export interface ShowSlideEvent extends StoryReaderEvent {
+    /** Index of the current slide */
+    index: number;
+    /** Slide payload (e.g., JSON data) */
+    payload: string;
+}
+
+/** Event: story was liked */
+export interface LikeStoryEvent extends StoryReaderEvent {
+    /** true — liked, false — unliked */
+    value: boolean;
+}
+
+/** Event: story was disliked */
+export interface DislikeStoryEvent extends StoryReaderEvent {
+    /** true — disliked, false — undisliked */
+    value: boolean;
+}
+
+/** Event: story was added/removed from favorites */
+export interface FavoriteStoryEvent extends StoryReaderEvent {
+    /** true — added, false — removed */
+    value: boolean;
+}
+
+/** Event: story was shared */
+export interface ShareStoryEvent extends StoryReaderEvent {}
+
+/** Event: story was shared with a given URL */
+export interface ShareStoryWithPathEvent extends StoryReaderEvent {
+    /** URL used for sharing */
+    url: string;
+}
+
+/** Event: user clicked on the "favorites" cell */
+export interface ClickOnFavoriteCellEvent {
+    /** Feed name where the click happened */
+    feed: string;
+}
+
+/** Event: feed was loaded */
+export interface FeedLoadEvent {
+    /** Feed name */
+    feed: string;
+    /** List of stories in the feed */
+    stories: Array<{ id: number; title: string; slidesCount: number }>;
+}
+
+/** Event: feed impression (visible stories) */
+export interface FeedImpressionEvent {
+    /** Feed name */
+    feed: string;
+    /** Stories that entered visible area */
+    stories: Array<{ id: number; title: string; slidesCount: number }>;
+}
+
+/** Event: visible area with stories was updated */
+export interface VisibleAreaUpdatedEvent {
+    /** Feed name */
+    feed: string;
+    /** Stories that became visible */
+    stories: Array<{ id: number; title: string; slidesCount: number }>;
+}
+
+/** Generic widget event */
+export interface WidgetEvent {
+    /** Event name */
+    name: string;
+    /** Event data */
+    data: any;
+}
+
+/** Event: mini-game started */
+export interface StartGameEvent {
+    /** Game ID */
+    id: string;
+}
+
+/** Event: mini-game closed */
+export interface CloseGameEvent {
+    /** Game ID */
+    id: string;
+}
+
+/** Event: mini-game finished */
+export interface FinishGameEvent {
+    /** Game ID */
+    id: string;
+    /** Game result */
+    result: Record<string, any>;
+}
+
+/** Generic game event */
+export interface EventGameEvent {
+    /** Event name */
+    name: string;
+    /** Event payload */
+    payload: Record<string, any>;
+}
+
+/**
+ * All StoryManager events that can be emitted externally.
+ */
+export interface StoryManagerEvents {
+    /** Story preview card is clicked */
+    clickOnStory: ClickOnStoryEvent;
+    /** Story is shown */
+    showStory: ShowSlideEvent;
+    /** Story is closed */
+    closeStory: CloseStoryEvent;
+    /** Slide is shown */
+    showSlide: ShowSlideEvent;
+    /** Story was liked */
+    likeStory: LikeStoryEvent;
+    /** Story was disliked */
+    dislikeStory: DislikeStoryEvent;
+    /** Story added/removed from favorites */
+    favoriteStory: FavoriteStoryEvent;
+    /** Story was shared */
+    shareStory: ShareStoryEvent;
+    /** Story shared with a given URL */
+    shareStoryWithPath: ShareStoryWithPathEvent;
+    /** Feed impression */
+    feedImpression: FeedImpressionEvent;
+    /** Visible area with stories was updated */
+    visibleAreaUpdated: VisibleAreaUpdatedEvent;
+    /** Widget event */
+    widgetEvent: WidgetEvent;
+    /** Game started */
+    startGame: StartGameEvent;
+    /** Game closed */
+    closeGame: CloseGameEvent;
+    /** Game finished */
+    finishGame: FinishGameEvent;
+    /** Custom game event */
+    eventGame: EventGameEvent;
+    /**
+     * @deprecated
+     * See https://docs.inappstory.com/sdk-guides/react-sdk/link-handling.html
+     */
+    clickOnButton: any;
+}

package/dist/types/in-app-messaging/iamErrors.d.ts

@@ -1,48 +1,52 @@
-export declare class IamNotFoundByEventError extends Error {
-    constructor(eventName: string);
-    name: string;
-}
-
-export declare class IamNotFoundByIdError extends Error {
-    constructor(messageId: string | number);
-    name: string;
-}
-
-export declare class IamNotFoundLimitError extends Error {
-    constructor(messageId: string | number);
-    name: string;
-}
-
-export declare class IamMessageOpenError extends Error {
-    constructor(messageId: string | number);
-    name: string;
-}
-
-export declare class IamOtherReaderIsOpenError extends Error {
-    constructor();
-    name: string;
-}
-
-export declare class IamShowOnlyIfLoadedError extends Error {
-    constructor();
-    name: string;
-}
-
-export declare class IamFrequencyLimitError extends Error {
-    constructor();
-    name: string;
-}
-
-export declare class IamCheckDisplayTimeRangeError extends Error {
-    constructor();
-    name: string;
-}
-
-export declare class IamMessageLimitExceededError extends Error {
-    constructor(messageId: string | number);
-    name: string;
-}
-
+/**
+ * Error thrown when no message is found matching the specified event name
+ */
+export declare class IamNotFoundByEventError extends Error {}
+
+/**
+ * Error thrown when no message is found matching the specified message ID
+ */
+export declare class IamNotFoundByIdError extends Error {}
+
+/**
+ * Error thrown when no display limit configuration is found for the specified message
+ */
+export declare class IamNotFoundLimitError extends Error {}
+
+/**
+ * Error thrown when attempting to open a message that is already open
+ */
+export declare class IamMessageOpenError extends Error {}
+
+/**
+ * Error thrown when attempting to open a message while another reader is active
+ */
+export declare class IamOtherReaderIsOpenError extends Error {}
+
+/**
+ * Error thrown when attempting to show a message that hasn't been preloaded,
+ * when the showOnlyIfLoaded option is enabled
+ */
+export declare class IamShowOnlyIfLoadedError extends Error {}
+
+/**
+ * Error thrown when a message's frequency limit has been exceeded
+ */
+export declare class IamFrequencyLimitError extends Error {}
+
+/**
+ * Error thrown when attempting to show a message outside its allowed display time range
+ */
+export declare class IamCheckDisplayTimeRangeError extends Error {}
+
+/**
+ * Error thrown when a message's display limit has been exceeded
+ */
+export declare class IamMessageLimitExceededError extends Error {}
+
+/**
+ * Union type representing all possible In-App Messaging error types
+ */
 export type IamError =
     | IamNotFoundByEventError
     | IamNotFoundByIdError