@inappstory/js-sdk 3.0.0-rc.0

package/dist/types/story-list/storyListLoadStatus.ts

@@ -0,0 +1,12 @@
+export interface StoryListLoadStatus {
+    feed: string | number,
+    filter: Record<string, any> | null,
+    defaultListLength: number,
+    favoriteListLength: number,
+    success: boolean,
+    error: {
+        name: string,
+        networkStatus: number,
+        networkMessage: string
+    } | null
+}

package/dist/types/storyManager.d.ts

@@ -0,0 +1,91 @@
+import { SharePage, SharePageOptions } from "./share-page";
+import { AppearanceManager } from "./appearance-manager/appearanceManager";
+import { StoriesList, UGCStoriesList } from "./story-list";
+import { PublicEventHandler, PublicEvents } from "./publicEvents";
+
+export declare enum StoryLinkSource {
+    StoryList = "storyList",
+    StoryReader = "storyReader",
+    GameReader = "gameReader"
+}
+
+export type StoryManagerConfig = {
+    apiKey: string;
+    userId?: string | number;
+    tags?: Array<string>;
+    placeholders?: Record<string, string>;
+    imagePlaceholders?: Record<string, string>;
+    lang?: string;
+    disableDeviceId?: boolean;
+};
+
+export type UgcEditorConfig = {
+    sessionId: string;
+    apiKey: string;
+    editor: Record<any, any>;
+    sdkVersion: string;
+    appPackageId?: string;
+    deviceId: string;
+    userId?: string;
+    lang: string;
+};
+
+export type StoryLinkClickHandler = (payload: {
+    data: { id: number; index: number; isDeeplink: boolean; url: string };
+    src: StoryLinkSource;
+}) => void;
+
+export interface Plugin {
+    name: string;
+    install(storyManager: StoryManager, options?: any): void;
+    uninstall(storyManager: StoryManager, options?: any): void;
+}
+
+export declare class StoryManager {
+    get sdkVersionName(): string;
+    get sdkVersionCode(): number;
+    set storyLinkClickHandler(value: StoryLinkClickHandler);
+
+    constructor(config: StoryManagerConfig);
+    static getInstance(): StoryManager;
+    static use(plugin: any, options?: any): void;
+
+    destroy(): void;
+    showOnboardingStories(
+        appearanceManager: AppearanceManager,
+        options?: { feed?: string; customTags?: Array<string>; limit?: number }
+    ): Promise<void>;
+    showStory(id: number | string, appearanceManager: AppearanceManager): Promise<void>;
+    showStoryOnce(id: number | string, appearanceManager: AppearanceManager): Promise<void>;
+    openGame(
+        gameInstanceId: string,
+        appearanceManager: AppearanceManager,
+        gameOptions?: { demoMode?: boolean }
+    ): Promise<void>;
+    closeGame(): Promise<boolean>;
+    closeStoryReader(): Promise<boolean | undefined>;
+    closeGoodsWidget(): void;
+    getUgcEditorConfig(): Promise<UgcEditorConfig>;
+    getNonce(): string | undefined;
+    on<Event extends keyof PublicEvents>(eventName: Event, listener: PublicEventHandler<Event>): this;
+    once<Event extends keyof PublicEvents>(eventName: Event, listener: PublicEventHandler<Event>): this;
+    off<Event extends keyof PublicEvents>(eventName: Event, listener: PublicEventHandler<Event>): this;
+
+    SharePage: {
+        new (storyId: number | string, appearanceManager: AppearanceManager, options?: SharePageOptions): SharePage;
+    };
+    StoriesList: {
+        new (
+            mountSelector: string,
+            appearanceManager: AppearanceManager,
+            options: { feed?: string; testKey?: string; useUgcCard?: boolean }
+        ): StoriesList;
+    };
+    UGCStoriesList: {
+        new (
+            mountSelector: string,
+            appearanceManager: AppearanceManager,
+            options: { filter?: Record<string, any>; testKey?: string; useUgcCard?: boolean }
+        ): UGCStoriesList;
+    };
+}

package/package.json

@@ -0,0 +1,66 @@
+{
+  "name": "@inappstory/js-sdk",
+  "version": "3.0.0-rc.0",
+  "description": "JS SDK",
+  "main": "dist/index.umd.js",
+  "module": "dist/index.esm.mjs",
+  "types": "dist/types/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/types/index.d.ts",
+      "require": "./dist/index.umd.js",
+      "import": "./dist/index.esm.mjs",
+      "default": "./dist/index.umd.js"
+    },
+    "./plugins/dotLottie": {
+      "types": "./plugins/dotLottie/dotLottie.d.ts",
+      "default": "./plugins/dotLottie/dotLottie.umd.js"
+    }
+  },
+  "files": [
+    "dist",
+    "plugins"
+  ],
+  "license": "MIT",
+  "keywords": [
+    "stories",
+    "stories SDK",
+    "InAppStory"
+  ],
+  "author": "Inappstory",
+  "maintainers": [
+    {
+      "name": "Inappstory",
+      "email": "dev@inappstory.com"
+    }
+  ],
+  "homepage": "https://inappstory.com",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/inappstory/react-web-sdk.git"
+  },
+  "bugs": "https://github.com/inappstory/react-web-sdk/issues",
+  "dependencies": {
+    "@inappstory/slide-api": "0.0.13",
+    "@inappstory/video-player": "^1.0.1",
+    "bowser": "^2.4.0",
+    "classnames": "^2.5.1",
+    "effector": "^23.2.2",
+    "lodash": "^4.17.21",
+    "parse-css-sides": "^3.0.1",
+    "react-input-mask": "^2.0.4",
+    "uuid": "^10.0.0",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0"
+  },
+  "devDependencies": {},
+  "scripts": {},
+  "browserslist": [
+    "Android >= 5",
+    "IOS >= 11",
+    "Safari >= 11",
+    "Chrome >= 49",
+    "Firefox >= 31",
+    "Samsung >= 5"
+  ]
+}

package/plugins/dotLottie/dotLottie.d.ts

@@ -0,0 +1,28 @@
+export type LottiePlayerEventName = "play" | "complete" | "beforeLoad" | "load" | "minPlayingTimeExpired" | "error";
+
+export interface LottiePlayer {
+    get frameRate(): number;
+    get loop(): boolean;
+
+    destroy(): void;
+    play(): void;
+    stop(): void;
+    setSpeed(speed: number): void;
+    setTimer(duration: number): void;
+    clearTimer(): void;
+    on(eventName: LottiePlayerEventName, listener: (...args: any[]) => void): this;
+    once(eventName: LottiePlayerEventName, listener: (...args: any[]) => void): this;
+    off(eventName: LottiePlayerEventName, listener: (...args: any[]) => void): this;
+}
+
+export declare class DotLottie {
+    createLottiePlayer(
+        canvas: HTMLCanvasElement,
+        config: {
+            url?: string;
+            size: number;
+            sha1: string;
+            durationMinimalMs: number;
+        }
+    ): LottiePlayer;
+}