@inappstory/react-sdk 1.12.0 → 1.13.0

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

@@ -54,6 +54,26 @@ export interface IamMessage {
     type: IamMessageType;
 }
 
+/**
+ * Client-side overrides applied when opening a message
+ */
+export interface IamClientAppearanceOptions {
+    /**
+     * Custom z-index for the message container (BottomSheet / Modal / Fullscreen / Toast overlay)
+     */
+    zIndex?: number;
+    /**
+     * Overrides when the message type is Toast
+     */
+    toast?: {
+        /**
+         * Maximum toast width on desktop (pixels)
+         * @default 320
+         */
+        width?: number;
+    };
+}
+
 /**
  * Type mapping of all possible IAM events and their payload structures
  */
@@ -170,8 +190,10 @@ export interface InAppMessaging {
      * @param options - Optional display configuration
      * @param options.showOnlyIfLoaded - If true, only shows messages that were preloaded
      * @param options.signal - Abort signal to cancel the operation
-     * @param options.appearance - Appearance options for the message
-     * @param options.appearance.zIndex - Custom z-index value for the message container (BottomSheet/Modal)
+     * @param options.appearance - Client appearance overrides when opening the message
+     * @param options.appearance.zIndex - Custom z-index for the message container
+     * @param options.appearance.toast - Toast-specific overrides (when message type is Toast)
+     * @param options.appearance.toast.width - Max toast width on desktop (px); default 320
      * @returns Promise resolving to the displayed message
      * @throws {IamNotFoundByIdError} If no message exists with this ID
      * @throws {IamMessageOpenError} If this message is already open
@@ -179,7 +201,10 @@ export interface InAppMessaging {
      * @throws {IamShowOnlyIfLoadedError} If showOnlyIfLoaded=true but message wasn't preloaded
      * @throws {IamMessageLimitExceededError} If message display limit was reached
      */
-    showMessageById(messageId: number | string, options?: { showOnlyIfLoaded?: boolean; signal?: AbortSignal; appearance?: { zIndex?: number }; }): Promise<IamMessage>;
+    showMessageById(
+        messageId: number | string,
+        options?: { showOnlyIfLoaded?: boolean; signal?: AbortSignal; appearance?: IamClientAppearanceOptions }
+    ): Promise<IamMessage>;
 
     /**
      * Displays a message associated with an event name
@@ -188,8 +213,10 @@ export interface InAppMessaging {
      * @param options.showOnlyIfLoaded - If true, only shows messages that were preloaded
      * @param options.tags - Filter messages by tags
      * @param options.signal - Abort signal to cancel the operation
-     * @param options.appearance - Appearance options for the message
-     * @param options.appearance.zIndex - Custom z-index value for the message container (BottomSheet/Modal)
+     * @param options.appearance - Client appearance overrides when opening the message
+     * @param options.appearance.zIndex - Custom z-index for the message container
+     * @param options.appearance.toast - Toast-specific overrides (when message type is Toast)
+     * @param options.appearance.toast.width - Max toast width on desktop (px); default 320
      * @returns Promise resolving to the displayed message
      * @throws {IamNotFoundByEventError} If no message exists for this event
      * @throws {IamFrequencyLimitError} If message frequency limit was exceeded
@@ -199,7 +226,12 @@ export interface InAppMessaging {
      */
     showMessageByEvent(
         eventName: string,
-        options?: { showOnlyIfLoaded?: boolean; tags?: string[]; signal?: AbortSignal; appearance?: { zIndex?: number }; }
+        options?: {
+            showOnlyIfLoaded?: boolean;
+            tags?: string[];
+            signal?: AbortSignal;
+            appearance?: IamClientAppearanceOptions;
+        }
     ): Promise<IamMessage>;
 
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@inappstory/react-sdk",
-  "version": "1.12.0",
+  "version": "1.13.0",
   "description": "React SDK",
   "keywords": [
     "stories",
@@ -58,7 +58,7 @@
     "Samsung >= 5"
   ],
   "dependencies": {
-    "@inappstory/slide-api": "^0.1.41",
+    "@inappstory/slide-api": "^0.1.42",
     "async-mutex": "^0.5.0",
     "bowser": "^2.11.0",
     "classnames": "^2.5.1",