@inappstory/react-sdk 1.7.4 → 1.7.6

package/dist/types/events.d.ts

@@ -0,0 +1,212 @@
+/**
+ * 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: story was shown */
+export interface ShowStoryEvent extends StoryReaderEvent {}
+
+/** Event: story was closed */
+export interface CloseStoryEvent extends StoryReaderEvent {
+    /** Close reason */
+    action: CloseAction;
+}
+
+/** 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: 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;
+}
+
+/**
+ * @deprecated
+ *  Use StoryManagerEvents instead
+ */
+export type PublicEvents = StoryManagerEvents;

package/dist/types/ias-container/IasContainer.d.ts

@@ -2,9 +2,33 @@ import { StoryManagerConfig } from "..";
 import { StoryManagerEventsProps } from "./storyManagerEventsProps";
 import { AppearanceOptionsProps } from "./appearanceOptionsProps";
 
+/**
+ * Props interface for IASContainer component.
+ * @extends StoryManagerEventsProps
+ * @extends AppearanceOptionsProps
+ */
 interface IASContainerProps extends StoryManagerEventsProps, AppearanceOptionsProps {
+    /** Configuration object for StoryManager. Must include API key. */
     config: StoryManagerConfig;
+    /** Optional child components to be rendered inside the container.
+     *  Typically includes StoryList or other InAppStory components. */
     children?: React.ReactNode;
 }
 
+/**
+ * Main container for InAppStory SDK.
+ *
+ * Provides `StoryManager` context and renders the necessary readers (`StoryReader`, `GameReader` etc).
+ *
+ * @example
+ * // Basic usage with StoryList
+ * <IASContainer config={{
+      apiKey: "{your-integration-key}",
+    }}>
+ *     <StoryList feedSlug="default" />
+ * </IASContainer>
+ *
+ * @param {IASContainerProps} props Properties including config, appearance options and event handlers
+ * @returns {JSX.Element} Provider component that enables InAppStory functionality for child components
+ */
 export declare const IASContainer: (props: IASContainerProps) => JSX.Element;

package/dist/types/ias-container/appearanceOptionsProps.d.ts

@@ -2,12 +2,31 @@ import {
     AppearanceCommonOptions,
     GameReaderOptions,
     GoodsWidgetOptions,
-    StoryReaderOptions,
+    StoryReaderOptions
 } from "../appearance-manager";
 
+/**
+ * Appearance customization options.
+ * Allows styling different parts of the InAppStory
+ */
 export interface AppearanceOptionsProps {
+    /**
+     * Common appearance options applied across All IAS components
+     */
     commonOptions?: AppearanceCommonOptions;
+
+    /**
+     * Customization options specific to the Story Reader component
+     */
     storyReaderOptions?: StoryReaderOptions;
+
+    /**
+     * Customization options specific to the Game Reader component
+     */
     gameReaderOptions?: GameReaderOptions;
+
+    /**
+     * Customization options for the Goods Widget (V1) appearance
+     */
     goodsWidgetOptions?: GoodsWidgetOptions;
 }

package/dist/types/ias-container/index.d.ts

@@ -1,2 +1 @@
-export { IASContainer } from './IasContainer';
-export * from "./publicEvents"
+export { IASContainer } from './IasContainer';

package/dist/types/ias-container/storyManagerEventsProps.d.ts

@@ -1,5 +1,4 @@
 import {
-    ClickOnButtonEvent,
     ClickOnStoryEvent,
     CloseStoryEvent,
     DislikeStoryEvent,
@@ -11,21 +10,128 @@ import {
     ShowSlideEvent,
     ShowStoryEvent,
     VisibleAreaUpdatedEvent,
-    WidgetEvent
-} from "./publicEvents";
+    WidgetEvent,
+    StartGameEvent,
+    FinishGameEvent,
+    CloseGameEvent,
+    EventGameEvent
+} from "../events";
 
+/**
+ * Interface for `StoryManager` event handlers.
+ * Contains callback props for various events that occur during story interactions.
+ * All event handlers are optional and follow the naming pattern `on[EventName]`.
+ *
+ * Each event handler receives a specific event object with relevant data about the interaction.
+ *
+ * @example
+ * // Example of using event handlers
+ * <IASContainer
+ *   onShowStory={(event) => console.log('Story shown:', event.id)}
+ *   onCloseStory={(event) => console.log('Story closed:', event.id)}
+ * />
+ */
 export interface StoryManagerEventsProps {
+    /**
+     * Called when a user clicks on a story in the story list
+     * @param event - Contains story ID and other metadata
+     */
     onClickOnStory?: (event: ClickOnStoryEvent) => void;
+
+    /**
+     * Called when a story becomes visible in the reader
+     * @param event - Contains story ID and opening context
+     */
     onShowStory?: (event: ShowStoryEvent) => void;
+
+    /**
+     * Called when a story is closed
+     * @param event - Contains story ID and close action
+     */
     onCloseStory?: (event: CloseStoryEvent) => void;
+
+    /**
+     * Called when a new slide is shown in the story
+     * @param event - Contains story ID and slide index
+     */
     onShowSlide?: (event: ShowSlideEvent) => void;
-    onClickOnButton?: (event: ClickOnButtonEvent) => void;
+
+    /**
+     * Called when a user likes a story
+     * @param event - Contains story ID and like status
+     */
     onLikeStory?: (event: LikeStoryEvent) => void;
+
+    /**
+     * Called when a user dislikes a story
+     * @param event - Contains story ID and dislike status
+     */
     onDislikeStory?: (event: DislikeStoryEvent) => void;
+
+    /**
+     * Called when a user favorites a story
+     * @param event - Contains story ID and favorite status
+     */
     onFavoriteStory?: (event: FavoriteStoryEvent) => void;
+
+    /**
+     * Called when a user shares a story (without specific path)
+     * @param event - Contains story ID and share method
+     */
     onShareStory?: (event: ShareStoryEvent) => void;
+
+    /**
+     * Called when a user shares a story with a specific path/slide
+     * @param event - Contains story ID, slide index, and share method
+     */
     onShareStoryWithPath?: (event: ShareStoryWithPathEvent) => void;
+
+    /**
+     * Called when stories feed becomes visible to the user
+     * @param event - Contains feed slug and impression data
+     */
     onFeedImpression?: (event: FeedImpressionEvent) => void;
+
+    /**
+     * Called when the visible area of stories in a feed changes
+     * @param event - Contains visibility information for stories in viewport
+     */
     onVisibleAreaUpdated?: (event: VisibleAreaUpdatedEvent) => void;
+
+    /**
+     * Generic handler for widget-specific events
+     * @param event - Contains widget type and event-specific data
+     */
     onWidgetEvent?: (event: WidgetEvent) => void;
+
+    /**
+     * Called when a game is started inside the story
+     * @param event - Contains game identifier
+     */
+    onStartGame?: (event: StartGameEvent) => void;
+
+    /**
+     * Called when a game is closed by user or system
+     * @param event - Contains game identifier
+     */
+    onCloseGame?: (event: CloseGameEvent) => void;
+
+    /**
+     * Called when a game finishes
+     * @param event - Contains game identifier and result payload
+     */
+    onFinishGame?: (event: FinishGameEvent) => void;
+
+    /**
+     * Called on custom in-game events
+     * @param event - Contains event name and custom payload
+     */
+    onEventGame?: (event: EventGameEvent) => void;
+
+    /**
+     *
+     * @deprecated
+     * See https://docs.inappstory.com/sdk-guides/react-sdk/link-handling.html
+     */
+    onClickOnButton?: (event: any) => void;
 }

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