@inappstory/react-sdk 1.8.0-rc.2 → 1.8.0-rc.4

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/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

@@ -10,8 +10,12 @@ import {
     ShowSlideEvent,
     ShowStoryEvent,
     VisibleAreaUpdatedEvent,
-    WidgetEvent
-} from "./publicEvents";
+    WidgetEvent,
+    StartGameEvent,
+    FinishGameEvent,
+    CloseGameEvent,
+    EventGameEvent
+} from "../events";
 
 /**
  * Interface for `StoryManager` event handlers.
@@ -64,13 +68,6 @@ export interface StoryManagerEventsProps {
      */
     onDislikeStory?: (event: DislikeStoryEvent) => void;
 
-    /**
-     * Called when a user clicks on an interactive button in the story
-     * @param event - Contains URL
-     * @deprecated Use `onWidgetEvent` instead
-     */
-    onClickOnButton?: (event: ClickOnButtonEvent) => void;
-
     /**
      * Called when a user favorites a story
      * @param event - Contains story ID and favorite status
@@ -106,4 +103,35 @@ export interface StoryManagerEventsProps {
      * @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/index.d.ts

@@ -2,4 +2,5 @@ export * from "./appearance-manager";
 export * from "./story-list";
 export * from "./storyManager";
 export * from "./ias-container";
-export * from "./in-app-messaging"
+export * from "./in-app-messaging"
+export * from "./events"

package/dist/types/storyManager.d.ts

@@ -1,3 +1,4 @@
+import { StoryManagerEvents } from "./events";
 import { PublicEventHandler, PublicEvents } from "./ias-container";
 import { InAppMessaging } from "./in-app-messaging/inAppMessaging";
 
@@ -38,7 +39,7 @@ export type StoryManagerConfig = {
     placeholders?: Record<string, string>;
     /** Image placeholders to be replaced in stories (optional)
      * @see https://docs.inappstory.com/sdk-guides/js-sdk/placeholders.html
-     * @example 
+     * @example
      * imagePlaceholders: {
      *   "your-image-placeholder-key": "value"
      * }
@@ -146,10 +147,10 @@ export declare class StoryManager {
         };
 
      */
-    showOnboardingStories(options?: { feed?: string; customTags?: Array<string>; limit?: number }): Promise<{
+    showOnboardingStories(options?: { feed?: string; customTags?: string[]; limit?: number }): Promise<{
         stories: {
             title: Option<string>;
-            tags: Array<string>;
+            tags: string[];
             slidesCount: Option<number>;
             ugcPayload?: Record<string, unknown>;
             id: number;
@@ -218,7 +219,10 @@ export declare class StoryManager {
      * @param listener The event handler
      * @see https://docs.inappstory.com/sdk-guides/react-sdk/events.html
      */
-    on(eventName: string, listener: (...args: any[]) => void): this;
+    on<EventName extends keyof StoryManagerEvents>(
+        eventName: EventName,
+        listener: (event: StoryManagerEvents[EventName]) => void
+    ): this;
 
     /**
      * Subscribes to a one-time SDK event.
@@ -226,7 +230,10 @@ export declare class StoryManager {
      * @param listener The event handler
      * @see https://docs.inappstory.com/sdk-guides/react-sdk/events.html
      */
-    once(eventName: string, listener: (...args: any[]) => void): this;
+    once<EventName extends keyof StoryManagerEvents>(
+        eventName: EventName,
+        listener: (event: StoryManagerEvents[EventName]) => void
+    ): this;
 
     /**
      * Unsubscribes from an SDK event.
@@ -234,7 +241,10 @@ export declare class StoryManager {
      * @param listener The event handler
      * @see https://docs.inappstory.com/sdk-guides/react-sdk/events.html
      */
-    off(eventName: string, listener: (...args: any[]) => void): this;
+    off<EventName extends keyof StoryManagerEvents>(
+        eventName: EventName,
+        listener: (event: StoryManagerEvents[EventName]) => void
+    ): this;
 
     /**
      * Installs a plugin at the class level.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@inappstory/react-sdk",
-  "version": "1.8.0-rc.2",
+  "version": "1.8.0-rc.4",
   "description": "React SDK",
   "keywords": [
     "stories",