@inappstory/game-center-api 1.1.0 → 1.2.0

package/lib/ResourceManager.d.ts

@@ -17,13 +17,11 @@ export declare class ResourceManager {
     private addResourceToCacheTree;
     private createCacheTree;
     cacheAllResources(): Promise<void>;
-    cacheResource({ uri, originUri, resouceKeys, onSuccess, onFail, }: {
+    cacheResource({ uri, originUri, resouceKeys, }: {
         uri: string;
         originUri?: string;
         resouceKeys?: string[];
-        onSuccess: (objectUrl: string | null) => void;
-        onFail: () => void;
-    }): Promise<void>;
+    }): Promise<string>;
     private createObjectUrlByUri;
     revokeCache(): void;
 }

package/lib/ResourceManager.js

@@ -47,24 +47,20 @@ class ResourceManager {
                     const resouceKeys = relatedResources.map(resource => resource.key);
                     const uri = resourceForFetch.getUri();
                     const originUri = resourceForFetch.getOriginUri();
-                    await this.cacheResource({
-                        uri,
-                        originUri,
-                        resouceKeys,
-                        onSuccess: objectUrl => {
-                            if (objectUrl === null) {
-                                resolve();
-                                return;
-                            }
-                            for (const resource of relatedResources) {
-                                resource.setCacheUri(objectUrl);
-                            }
+                    try {
+                        const objectUrl = await this.cacheResource({ uri, originUri, resouceKeys });
+                        if (objectUrl === originUri) {
                             resolve();
-                        },
-                        onFail: () => {
-                            reject(`Can't load resource for [${resouceKeys.join(", ")}]`);
-                        },
-                    });
+                            return;
+                        }
+                        for (const resource of relatedResources) {
+                            resource.setCacheUri(objectUrl);
+                        }
+                        resolve();
+                    }
+                    catch (e) {
+                        reject(`Can't load resource for [${resouceKeys.join(", ")}]`);
+                    }
                 });
             })(resourceForFetch, relatedResources);
             promises.push(promise);
@@ -73,18 +69,18 @@ class ResourceManager {
         for (const resList of this.resLists)
             resList["onCacheDone"]();
     }
-    async cacheResource({ uri, originUri = uri, resouceKeys = ["outerResource"], onSuccess, onFail, }) {
+    async cacheResource({ uri, originUri = uri, resouceKeys = ["outerResource"], }) {
         let objectUrl = await this.createObjectUrlByUri(uri, resouceKeys);
         if (objectUrl === null && uri !== originUri)
             objectUrl = await this.createObjectUrlByUri(originUri, resouceKeys);
-        if (objectUrl === null) {
+        if (objectUrl !== null)
+            return objectUrl;
+        return new Promise((resolve, reject) => {
             const image = new Image();
-            image.onload = () => onSuccess(null);
-            image.onerror = () => onFail();
+            image.onload = () => resolve(originUri);
+            image.onerror = () => reject();
             image.src = originUri;
-        }
-        else
-            onSuccess(objectUrl);
+        });
     }
     async createObjectUrlByUri(uri, resouceKeys) {
         if (!uri)

package/lib/index.d.ts

@@ -4,7 +4,7 @@ import { getDynamicResourceAsset, getDynamicResourceFont, getProjectFontFamilySt
 import { sendIasApiRequest } from "./iasApi";
 import { gameLocalData } from "./localData";
 import { closeGameReader, createSdkApi, reloadGameReader } from "./sdkApi";
-import { gameLoadedSdkCallback, gameLoadFailedSdkCallback } from "./sdkApi/initGame";
+import { gameLoadedSdkCallback, gameLoadFailedSdkCallback, gameShouldForegroundCallback, isSdkSupportGameShouldForegroundCallback, gameOnForeground } from "./sdkApi/initGame";
 import { openUrl } from "./sdkApi/openUrl";
 import { share } from "./sdkApi/share";
 import { vibrate } from "./sdkApi/vibrate";
@@ -23,9 +23,9 @@ export type { RequestInfo as APIRequestInfo, Response as APIResponse } from "./i
 export type { Placeholder, GameLaunchConfig };
 export type { ProjectFontFamily } from "./gameResources";
 export type { ResourceInterface } from "./ResourceManager";
-export { createSdkApi, closeGameReader, gameLoadedSdkCallback, gameLoadFailedSdkCallback, gameLaunchConfig, isIos, isWeb, isAndroid, isDev, getSdkVersion, getSemverSdkVersion, gameLocalData, sendIasApiRequest, openUrl, share, vibrate, getDynamicResourceAsset, getDynamicResourceFont, getProjectFontFamilyStylesheet, getIsDemoMode, getSessionId, getApiBaseUrl, ScreenOrientation, PlaceholderType, fetchLocalFile, openStory, ResourceManager, dynamicResourceAssets, dynamicResourceFonts, staticResourcesImagePlaceholders, StaticResourceList, eventGame, reloadGameReader, openFilePicker, FilePickerResultType, isFilePickerResultFileList, isFilePickerResultLocalFileList, isLocalFile, hasFilePickerApi, };
+export { createSdkApi, closeGameReader, gameLoadedSdkCallback, gameLoadFailedSdkCallback, gameLaunchConfig, isIos, isWeb, isAndroid, isDev, getSdkVersion, getSemverSdkVersion, gameLocalData, sendIasApiRequest, openUrl, share, vibrate, getDynamicResourceAsset, getDynamicResourceFont, getProjectFontFamilyStylesheet, getIsDemoMode, getSessionId, getApiBaseUrl, ScreenOrientation, PlaceholderType, fetchLocalFile, openStory, ResourceManager, dynamicResourceAssets, dynamicResourceFonts, staticResourcesImagePlaceholders, StaticResourceList, eventGame, reloadGameReader, openFilePicker, FilePickerResultType, isFilePickerResultFileList, isFilePickerResultLocalFileList, isLocalFile, hasFilePickerApi, gameShouldForegroundCallback, isSdkSupportGameShouldForegroundCallback, gameOnForeground, };
 declare const GameCenterApi: {
-    createSdkApi: ({ mounted, beforeUnmount: beforeUnmountCb, onSdkCloseGameReaderIntent, onPause, onResume, onBackGesture, onAudioFocusChange, filterPlaceholders, }: Partial<{
+    createSdkApi: ({ mounted, beforeUnmount: beforeUnmountCb, onSdkCloseGameReaderIntent, onPause, onResume, onBackGesture, onAudioFocusChange, filterPlaceholders, gameShouldForeground, }: Partial<{
         mounted: () => void;
         beforeUnmount: () => void;
         onSdkCloseGameReaderIntent: () => void;
@@ -34,6 +34,7 @@ declare const GameCenterApi: {
         onBackGesture: () => void;
         onAudioFocusChange: (focusChange: number) => void;
         filterPlaceholders: (placeholders: Placeholder[]) => Placeholder[];
+        gameShouldForeground: () => void;
     }>) => void;
     closeGameReader: (data?: import("./sdkApi").CloseGameReaderOptions | undefined) => void;
     gameLoadedSdkCallback: (config?: Partial<Partial<{
@@ -85,5 +86,11 @@ declare const GameCenterApi: {
     isFilePickerResultLocalFileList: typeof isFilePickerResultLocalFileList;
     isLocalFile: typeof isLocalFile;
     hasFilePickerApi: () => boolean;
+    gameShouldForegroundCallback: (config?: Partial<Partial<{
+        showClose: boolean;
+        backGesture: boolean;
+    }>> | undefined) => void;
+    isSdkSupportGameShouldForegroundCallback: () => boolean | undefined;
+    gameOnForeground: Promise<void>;
 };
 export { GameCenterApi as default };

package/lib/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = exports.hasFilePickerApi = exports.isLocalFile = exports.isFilePickerResultLocalFileList = exports.isFilePickerResultFileList = exports.FilePickerResultType = exports.openFilePicker = exports.reloadGameReader = exports.eventGame = exports.StaticResourceList = exports.staticResourcesImagePlaceholders = exports.dynamicResourceFonts = exports.dynamicResourceAssets = exports.ResourceManager = exports.openStory = exports.fetchLocalFile = exports.PlaceholderType = exports.ScreenOrientation = exports.getApiBaseUrl = exports.getSessionId = exports.getIsDemoMode = exports.getProjectFontFamilyStylesheet = exports.getDynamicResourceFont = exports.getDynamicResourceAsset = exports.vibrate = exports.share = exports.openUrl = exports.sendIasApiRequest = exports.gameLocalData = exports.getSemverSdkVersion = exports.getSdkVersion = exports.isDev = exports.isAndroid = exports.isWeb = exports.isIos = exports.gameLaunchConfig = exports.gameLoadFailedSdkCallback = exports.gameLoadedSdkCallback = exports.closeGameReader = exports.createSdkApi = void 0;
+exports.default = exports.gameOnForeground = exports.isSdkSupportGameShouldForegroundCallback = exports.gameShouldForegroundCallback = exports.hasFilePickerApi = exports.isLocalFile = exports.isFilePickerResultLocalFileList = exports.isFilePickerResultFileList = exports.FilePickerResultType = exports.openFilePicker = exports.reloadGameReader = exports.eventGame = exports.StaticResourceList = exports.staticResourcesImagePlaceholders = exports.dynamicResourceFonts = exports.dynamicResourceAssets = exports.ResourceManager = exports.openStory = exports.fetchLocalFile = exports.PlaceholderType = exports.ScreenOrientation = exports.getApiBaseUrl = exports.getSessionId = exports.getIsDemoMode = exports.getProjectFontFamilyStylesheet = exports.getDynamicResourceFont = exports.getDynamicResourceAsset = exports.vibrate = exports.share = exports.openUrl = exports.sendIasApiRequest = exports.gameLocalData = exports.getSemverSdkVersion = exports.getSdkVersion = exports.isDev = exports.isAndroid = exports.isWeb = exports.isIos = exports.gameLaunchConfig = exports.gameLoadFailedSdkCallback = exports.gameLoadedSdkCallback = exports.closeGameReader = exports.createSdkApi = void 0;
 const env_1 = require("./env");
 Object.defineProperty(exports, "getSdkVersion", { enumerable: true, get: function () { return env_1.getSdkVersion; } });
 Object.defineProperty(exports, "getSemverSdkVersion", { enumerable: true, get: function () { return env_1.getSemverSdkVersion; } });
@@ -32,6 +32,9 @@ Object.defineProperty(exports, "reloadGameReader", { enumerable: true, get: func
 const initGame_1 = require("./sdkApi/initGame");
 Object.defineProperty(exports, "gameLoadedSdkCallback", { enumerable: true, get: function () { return initGame_1.gameLoadedSdkCallback; } });
 Object.defineProperty(exports, "gameLoadFailedSdkCallback", { enumerable: true, get: function () { return initGame_1.gameLoadFailedSdkCallback; } });
+Object.defineProperty(exports, "gameShouldForegroundCallback", { enumerable: true, get: function () { return initGame_1.gameShouldForegroundCallback; } });
+Object.defineProperty(exports, "isSdkSupportGameShouldForegroundCallback", { enumerable: true, get: function () { return initGame_1.isSdkSupportGameShouldForegroundCallback; } });
+Object.defineProperty(exports, "gameOnForeground", { enumerable: true, get: function () { return initGame_1.gameOnForeground; } });
 const openUrl_1 = require("./sdkApi/openUrl");
 Object.defineProperty(exports, "openUrl", { enumerable: true, get: function () { return openUrl_1.openUrl; } });
 const share_1 = require("./sdkApi/share");
@@ -97,6 +100,9 @@ const GameCenterApi = {
     isFilePickerResultLocalFileList: filePicker_h_1.isFilePickerResultLocalFileList,
     isLocalFile: filePicker_h_1.isLocalFile,
     hasFilePickerApi: filePicker_1.hasFilePickerApi,
+    gameShouldForegroundCallback: initGame_1.gameShouldForegroundCallback,
+    isSdkSupportGameShouldForegroundCallback: initGame_1.isSdkSupportGameShouldForegroundCallback,
+    gameOnForeground: initGame_1.gameOnForeground,
 };
 exports.default = GameCenterApi;
 // export { Placeholder as default};

package/lib/sdkApi/index.d.ts

@@ -3,7 +3,7 @@
  */
 import { SdkApiCallbacks } from "./index.h";
 import { OpenStoryOptions } from "./openStory.h";
-export declare const createSdkApi: ({ mounted, beforeUnmount: beforeUnmountCb, onSdkCloseGameReaderIntent, onPause, onResume, onBackGesture, onAudioFocusChange, filterPlaceholders, }: SdkApiCallbacks) => void;
+export declare const createSdkApi: ({ mounted, beforeUnmount: beforeUnmountCb, onSdkCloseGameReaderIntent, onPause, onResume, onBackGesture, onAudioFocusChange, filterPlaceholders, gameShouldForeground, }: SdkApiCallbacks) => void;
 export type CloseGameReaderOptions = {
     [key: string]: any;
     openUrl?: string;

package/lib/sdkApi/index.h.d.ts

@@ -8,4 +8,5 @@ export type SdkApiCallbacks = Partial<{
     onBackGesture: () => void;
     onAudioFocusChange: (focusChange: number) => void;
     filterPlaceholders: (placeholders: Placeholder[]) => Placeholder[];
+    gameShouldForeground: () => void;
 }>;

package/lib/sdkApi/index.js

@@ -10,10 +10,11 @@ const isObject_1 = require("../helpers/isObject");
 const gameLaunchConfig_1 = require("../gameLaunchConfig");
 const asyncQueue_1 = require("../asyncQueue");
 let beforeUnmount;
-const createSdkApi = ({ mounted, beforeUnmount: beforeUnmountCb, onSdkCloseGameReaderIntent, onPause, onResume, onBackGesture, onAudioFocusChange, filterPlaceholders, }) => {
+const createSdkApi = ({ mounted, beforeUnmount: beforeUnmountCb, onSdkCloseGameReaderIntent, onPause, onResume, onBackGesture, onAudioFocusChange, filterPlaceholders, gameShouldForeground, }) => {
     beforeUnmount = beforeUnmountCb;
     gameLaunchConfig_1.gameLaunchHandlers.filterPlaceholders = filterPlaceholders ?? gameLaunchConfig_1.gameLaunchHandlers.filterPlaceholders;
     (0, initGame_1.createInitGame)(async () => (0, localData_1.initLocalData)(), mounted);
+    (0, initGame_1.createGameShouldForeground)(gameShouldForeground ?? (() => { }));
     window.closeGameReader = () => {
         if (onSdkCloseGameReaderIntent) {
             onSdkCloseGameReaderIntent();
@@ -77,6 +78,10 @@ const createSdkApi = ({ mounted, beforeUnmount: beforeUnmountCb, onSdkCloseGameR
                             (0, isFunction_1.isFunction)(window.initGame) && window.initGame(data[1]);
                         }
                         break;
+                    case "gameShouldForeground": {
+                        window.gameShouldForeground();
+                        break;
+                    }
                     case "closeGameReader":
                         {
                             window.closeGameReader();

package/lib/sdkApi/initGame.d.ts

@@ -19,6 +19,7 @@ declare global {
             error: string;
         };
         gameLoadFailed: typeof gameLoadFailedSdkCallback;
+        gameShouldForeground: () => void;
     }
 }
 type GameReaderInit = {
@@ -35,4 +36,15 @@ type GameLoadedSdkConfig = Partial<{
  */
 export declare const gameLoadedSdkCallback: (config?: Partial<GameLoadedSdkConfig>) => void;
 export declare const gameLoadFailedSdkCallback: (reason: string, canTryReload: boolean) => void;
+export declare const createGameShouldForeground: (gameShouldForeground: () => void) => void;
+type GameShouldForegroundConfig = Partial<{
+    showClose: boolean;
+    backGesture: boolean;
+}>;
+/**
+ * API method for remove loader screen from Reader
+ */
+export declare const gameShouldForegroundCallback: (config?: Partial<GameShouldForegroundConfig>) => void;
+export declare const isSdkSupportGameShouldForegroundCallback: () => boolean | undefined;
+export declare const gameOnForeground: Promise<void>;
 export {};

package/lib/sdkApi/initGame.js

@@ -1,11 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.gameLoadFailedSdkCallback = exports.gameLoadedSdkCallback = exports.createInitGame = void 0;
+exports.gameOnForeground = exports.isSdkSupportGameShouldForegroundCallback = exports.gameShouldForegroundCallback = exports.createGameShouldForeground = exports.gameLoadFailedSdkCallback = exports.gameLoadedSdkCallback = exports.createInitGame = void 0;
 const isObject_1 = require("../helpers/isObject");
 const gameLaunchConfig_1 = require("../gameLaunchConfig");
 const env_1 = require("../env");
 const Source_1 = require("./web/Source");
 const createNonce_1 = require("../createNonce");
+const semver = require("semver");
 window.gameLoadingInfo = {
     loaded: false,
     state: "before gameReader API creation",
@@ -100,28 +101,49 @@ const gameLoadedSdkCallback = (config) => {
         }
         if (env_1.isAndroid) {
             if (window.Android.gameLoaded !== undefined) {
-                window.Android.gameLoaded(JSON.stringify({ showClose, backGesture }));
+                if ((0, exports.isSdkSupportGameShouldForegroundCallback)()) {
+                    window.Android.gameLoaded();
+                }
+                else {
+                    // old SDK API style
+                    window.Android.gameLoaded(JSON.stringify({ showClose, backGesture }));
+                }
             }
         }
         else if (env_1.isIos) {
             if (env_1.iosMh.gameLoaded !== undefined) {
-                env_1.iosMh.gameLoaded.postMessage(JSON.stringify({ showClose, backGesture: false }));
+                if ((0, exports.isSdkSupportGameShouldForegroundCallback)()) {
+                    env_1.iosMh.gameLoaded.postMessage("");
+                }
+                else {
+                    // old SDK API style
+                    env_1.iosMh.gameLoaded.postMessage(JSON.stringify({ showClose, backGesture: false }));
+                }
             }
         }
         else if (env_1.isWeb) {
             if (Source_1.webSource.sourceWindow && Source_1.webSource.sourceWindowOrigin) {
-                Source_1.webSource.sourceWindow.postMessage([
-                    "gameLoaded",
-                    JSON.stringify({
-                        showClose,
-                        backGesture,
-                    }),
-                ], Source_1.webSource.sourceWindowOrigin);
+                if ((0, exports.isSdkSupportGameShouldForegroundCallback)()) {
+                    Source_1.webSource.sourceWindow.postMessage(["gameLoaded"], Source_1.webSource.sourceWindowOrigin);
+                }
+                else {
+                    // old SDK API style
+                    Source_1.webSource.sourceWindow.postMessage([
+                        "gameLoaded",
+                        JSON.stringify({
+                            showClose,
+                            backGesture,
+                        }),
+                    ], Source_1.webSource.sourceWindowOrigin);
+                }
             }
         }
         window.gameLoadingInfo.state = "after call gameLoadedSdkCallback";
         window.gameLoadingInfo.description = "";
         window.gameLoadingInfo.loaded = true;
+        if (!(0, exports.isSdkSupportGameShouldForegroundCallback)()) {
+            gameOnForegroundResolve();
+        }
     }
     catch (e) {
         window._sendErrorLog && window._sendErrorLog({ src: "gameLoadedSdkCallback", message: e.message, stack: e.stack });
@@ -154,7 +176,74 @@ const gameLoadFailedSdkCallback = (reason, canTryReload) => {
                 Source_1.webSource.sourceWindow.postMessage(["gameLoadFailed", reason, canTryReload], Source_1.webSource.sourceWindowOrigin);
             }
         }
+        gameOnForegroundReject(reason);
     }
 };
 exports.gameLoadFailedSdkCallback = gameLoadFailedSdkCallback;
 window.gameLoadFailed = exports.gameLoadFailedSdkCallback;
+const createGameShouldForeground = (gameShouldForeground) => {
+    window.gameShouldForeground = gameShouldForeground;
+};
+exports.createGameShouldForeground = createGameShouldForeground;
+/**
+ * API method for remove loader screen from Reader
+ */
+const gameShouldForegroundCallback = (config) => {
+    let showClose = config?.showClose;
+    if (showClose == null) {
+        showClose = false;
+    }
+    let backGesture = config?.backGesture;
+    if (backGesture == null) {
+        backGesture = true;
+    }
+    if (env_1.isAndroid) {
+        if (window.Android.gameShouldForegroundCallback) {
+            window.Android.gameShouldForegroundCallback(JSON.stringify({ showClose, backGesture }));
+        }
+    }
+    else if (env_1.isIos) {
+        if (env_1.iosMh.gameShouldForegroundCallback) {
+            env_1.iosMh.gameShouldForegroundCallback.postMessage(JSON.stringify({ showClose, backGesture: false }));
+        }
+    }
+    else if (env_1.isWeb) {
+        if (Source_1.webSource.sourceWindow && Source_1.webSource.sourceWindowOrigin) {
+            Source_1.webSource.sourceWindow.postMessage([
+                "gameShouldForegroundCallback",
+                JSON.stringify({
+                    showClose,
+                    backGesture,
+                }),
+            ], Source_1.webSource.sourceWindowOrigin);
+        }
+    }
+    gameOnForegroundResolve();
+};
+exports.gameShouldForegroundCallback = gameShouldForegroundCallback;
+const isSdkSupportGameShouldForegroundCallback = () => {
+    if (env_1.isAndroid) {
+        return "gameShouldForegroundCallback" in window.Android;
+    }
+    else if (env_1.isIos) {
+        return "gameShouldForegroundCallback" in env_1.iosMh;
+    }
+    else if (env_1.isWeb) {
+        let support = false;
+        const semverVersion = (0, env_1.getSemverSdkVersion)();
+        if (semverVersion != null && semverVersion) {
+            // gte(v1, v2): v1 >= v2
+            if (semver.gte(semverVersion, "2.12.0-rc.11")) {
+                support = true;
+            }
+        }
+        return support;
+    }
+};
+exports.isSdkSupportGameShouldForegroundCallback = isSdkSupportGameShouldForegroundCallback;
+let gameOnForegroundResolve = () => { };
+let gameOnForegroundReject = () => { };
+exports.gameOnForeground = new Promise((resolve, reject) => {
+    gameOnForegroundResolve = resolve;
+    gameOnForegroundReject = reject;
+});

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@inappstory/game-center-api",
-    "version": "1.1.0",
+    "version": "1.2.0",
     "description": "",
     "dependencies": {
         "semver": "^7.3.8",