@inappstory/js-sdk 3.1.5 → 3.2.0-rc.0

package/dist/types/global.d.ts

@@ -1,5 +1,5 @@
 import { AppearanceManager } from "./appearance-manager";
-import { StoryManager, StoryManagerConfig } from "./storyManager";
+import { StoryManager, StoryManagerConfig } from "./inAppStoryManager";
 
 export type RecursivePartial<T> = {
     [P in keyof T]?: T[P] extends object ? RecursivePartial<T[P]> | null : T[P] | null;

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

@@ -0,0 +1,55 @@
+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;
+}
+
+export type IamError =
+    | IamNotFoundByEventError
+    | IamNotFoundByIdError
+    | IamNotFoundLimitError
+    | IamMessageOpenError
+    | IamOtherReaderIsOpenError
+    | IamShowOnlyIfLoadedError
+    | IamFrequencyLimitError
+    | IamCheckDisplayTimeRangeError
+    | IamMessageLimitExceededError;

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

@@ -0,0 +1,44 @@
+export declare enum IamMessageType {
+    BottomSheet = 1,
+    Modal = 2,
+    Fullscreen = 3
+}
+
+export interface IamMessage {
+    id: number;
+    campaignName: string;
+    type: IamMessageType;
+}
+
+export type IamEvents = {
+    close: {
+        message: IamMessage;
+    };
+    widgetEvent: {
+        message: IamMessage;
+        name: string;
+        data: Record<string, any>;
+    };
+    clickOnButton: {
+        id: number;
+        index: number;
+        url: string;
+        elementId: string;
+    };
+};
+
+export type IamEventHandler<Event extends keyof IamEvents> = (event: IamEvents[Event]) => void;
+
+export interface InAppMessaging {
+    get activeMessage(): IamMessage | null;
+    get isLoaded(): boolean;
+    get isLoading(): boolean;
+    get isOpened(): boolean;
+
+    preload(): Promise<IamMessage[]>;
+    showMessageById(messageId: number | string, showOnlyIfLoaded?: boolean): Promise<IamMessage>;
+    showMessageByEvent(eventName: string, showOnlyIfLoaded?: boolean): Promise<IamMessage>;
+    on<Event extends keyof IamEvents>(eventName: Event, listener: IamEventHandler<Event>): this;
+    once<Event extends keyof IamEvents>(eventName: Event, listener: IamEventHandler<Event>): this;
+    off<Event extends keyof IamEvents>(eventName: Event, listener: IamEventHandler<Event>): this;
+}

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

@@ -0,0 +1,2 @@
+export * from "./iamErrors"
+export * from "./inAppMessaging"

package/dist/types/{storyManager.d.ts → inAppStoryManager.d.ts}

@@ -2,6 +2,7 @@ import { SharePage, SharePageOptions } from "./share-page";
 import { AppearanceManager } from "./appearance-manager/appearanceManager";
 import { StoriesList, UGCStoriesList } from "./story-list";
 import { PublicEventHandler, PublicEvents } from "./publicEvents";
+import { InAppMessaging } from "./in-app-messaging";
 
 export declare enum StoryLinkSource {
     StoryList = "storyList",
@@ -9,7 +10,7 @@ export declare enum StoryLinkSource {
     GameReader = "gameReader"
 }
 
-export type StoryManagerConfig = {
+export type InAppStoryManagerConfig = {
     apiKey: string;
     userId?: string | number;
     userIdSign?: string;
@@ -38,17 +39,18 @@ export type StoryLinkClickHandler = (payload: {
 
 export interface Plugin {
     name: string;
-    install(storyManager: StoryManager, options?: any): void;
-    uninstall(storyManager: StoryManager, options?: any): void;
+    install(inAppStoryManager: InAppStoryManager, options?: any): void;
+    uninstall(inAppStoryManager: InAppStoryManager, options?: any): void;
 }
 
-export declare class StoryManager {
+export declare class InAppStoryManager {
     get sdkVersionName(): string;
     get sdkVersionCode(): number;
+    inAppMessaging: InAppMessaging;
     set storyLinkClickHandler(value: StoryLinkClickHandler);
 
-    constructor(config: StoryManagerConfig);
-    static getInstance(): StoryManager;
+    constructor(config: InAppStoryManagerConfig);
+    static getInstance(): InAppStoryManager;
     static use(plugin: any, options?: any): void;
 
     destroy(): void;

package/dist/types/index.d.ts

@@ -1,5 +1,6 @@
 export * from "./appearance-manager";
 export * from "./story-list";
 export * from "./share-page";
-export * from "./storyManager";
-export * from "./publicEvents"
+export * from "./inAppStoryManager";
+export * from "./publicEvents";
+export * from "./in-app-messaging";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@inappstory/js-sdk",
-  "version": "3.1.5",
+  "version": "3.2.0-rc.0",
   "description": "JS SDK",
   "main": "dist/index.umd.js",
   "module": "dist/index.esm.mjs",
@@ -54,6 +54,7 @@
     "react-dom": "^18.2.0",
     "mobx-react-lite": "^4.1.0",
     "mobx": "^6.9.0",
+    "lit": "^3.2.1",
     "async-mutex": "^0.5.0"
   },
   "devDependencies": {},