@jolibox/implement 1.1.12 → 1.1.13-beta.10

package/src/common/rewards/type.ts

@@ -0,0 +1,25 @@
+export interface IJoliCoin {
+  balance: number;
+  enableAutoDeduct: boolean;
+}
+
+export type IUnlockOptionType = 'JOLI_COIN' | 'ADS';
+
+interface IJoliCoinChoice {
+  joliCoinQuantity: number;
+}
+export interface IUnlockOption {
+  type: IUnlockOptionType;
+  joliCoinChoices: IJoliCoinChoice[];
+}
+
+export interface IJolicoinRewardOption {
+  code: 'SUCCESS' | 'ERROR' | 'PARAMETER_ERROR' | 'EPISODE_LOCK_JUMP';
+  message: string;
+  data: {
+    unlockOptions?: IUnlockOption[];
+  };
+  extra: {
+    joliCoin: IJoliCoin;
+  };
+}

package/src/common/utils/index.ts

@@ -1,9 +1,16 @@
 const JOLIBOX_CUSTOM_ADS_EVENT_TYPE = 'JOLIBOX_ADS_EVENT';
+const JOLIBOX_CUSTOM_REWARDS_EVENT_TYPE = 'JOLIBOX_CUSTOM_REWARDS_EVENT';
 
 interface JoliboxCustomEvent {
   [JOLIBOX_CUSTOM_ADS_EVENT_TYPE]: {
     isAdShowing: boolean;
   };
+  [JOLIBOX_CUSTOM_REWARDS_EVENT_TYPE]: {
+    ['JOLI_COIN']?: {
+      quantity: number;
+      balance: number;
+    };
+  };
 }
 
 export const notifyCustomEvent = <T extends keyof JoliboxCustomEvent>(

package/src/h5/api/ads.ts

@@ -3,10 +3,23 @@ import { track } from '../report';
 import { createCommands } from '@jolibox/common';
 import { httpClientManager } from '../http';
 import { notifyCustomEvent } from '@/common/utils';
+import { createAdsRewardHandler, rewardsHelper, createJolicoinRewardHandler } from '@/common/rewards';
+
 const commands = createCommands();
 
 const httpClient = httpClientManager.create();
 const ads = new JoliboxAdsImpl(track, httpClient, () => httpClientManager.getNetworkStatus());
+rewardsHelper.registerRewardHandler('ADS', createAdsRewardHandler(ads));
+rewardsHelper.registerRewardHandler(
+  'JOLI_COIN',
+  createJolicoinRewardHandler(ads.httpClient, {
+    onUnlockSuccess: (params: { quantity: number; balance: number }) => {
+      notifyCustomEvent('JOLIBOX_CUSTOM_REWARDS_EVENT', {
+        JOLI_COIN: params
+      });
+    }
+  })
+);
 
 adEventEmitter.on('isAdShowing', (isAdShowing) => {
   notifyCustomEvent('JOLIBOX_ADS_EVENT', { isAdShowing });
@@ -21,7 +34,13 @@ commands.registerCommand('AdsSDK.adConfig', (params) => {
 });
 
 commands.registerCommand('AdsSDK.adBreak', (params) => {
-  ads.adBreak(params);
+  if (params.type === 'reward') {
+    rewardsHelper.getRewardsTypes(ads.httpClient).then((rewardsTypes) => {
+      rewardsHelper.handleReward(rewardsTypes, params);
+    });
+  } else {
+    ads.adBreak(params);
+  }
 });
 
 commands.registerCommand('AdsSDK.adUnit', (params) => {

package/src/h5/api/get-system-info.ts

@@ -11,7 +11,7 @@ const API_GET_SYSTEM_SYNC = 'getSystemInfoSync';
 const getSystemInfo = () => {
   let config = {
     system: context.deviceInfo.system,
-    platform: context.deviceInfo.platform,
+    platform: context.deviceInfo.platform.toLowerCase(),
     brand: context.deviceInfo.brand,
     pixelRatio: context.deviceInfo.pixelRatio,
     language: context.deviceInfo.lang,

package/src/h5/http/utils/__tests__/xua.test.ts

@@ -4,7 +4,7 @@ import { isValidUUIDV4 } from '@jolibox/common';
 
 describe('xua', () => {
   it('test xua', () => {
-    // window.__JOLIBOX_LOCAL_SDK_VERSION__ = '1.0.0';
+    (window as any).__joliboxLocalStorage__ = window.localStorage;
     const xua = xUserAgent();
     const deviceInfoRegex = /.* (\(.*\) ).*/;
     const deviceInfoMatch = xua.match(deviceInfoRegex);

package/src/native/api/ads.ts

@@ -1,5 +1,6 @@
-import { createCommands, logger } from '@jolibox/common';
+import { createCommands } from '@jolibox/common';
 import { createSyncAPI, registerCanIUse } from './base';
+import { createToast } from '@jolibox/ui';
 
 const commands = createCommands();
 
@@ -7,7 +8,8 @@ import { IAdsInitParams, JoliboxAdsImpl, IAdConfigParams, IAdBreakParams, IAdUni
 import { track } from '../report';
 
 import { innerFetch as fetch } from '../network';
-import { invokeNative } from '../bootstrap/bridge';
+import { invokeNative } from '@jolibox/native-bridge';
+import { rewardsHelper, createAdsRewardHandler, createJolicoinRewardHandler } from '@/common/rewards';
 
 const checkNetworkStatus = () => {
   const { data } = invokeNative('getNetworkStatusSync');
@@ -34,6 +36,26 @@ const ads = new JoliboxAdsImpl(
   checkNetworkStatus
 );
 
+rewardsHelper.registerRewardHandler('ADS', createAdsRewardHandler(ads));
+rewardsHelper.registerRewardHandler(
+  'JOLI_COIN',
+  createJolicoinRewardHandler(ads.httpClient, {
+    onUnlockSuccess: (params) => {
+      const { quantity, balance } = params;
+      const balanceStr = balance >= 1000 ? '999+' : balance;
+      createToast(`{slot-checkmark}  −${quantity} {slot-coin} | Balance: ${balanceStr} {slot-coin}`, {
+        customStyle: {
+          mark: {
+            marginRight: '8px'
+          }
+        }
+      });
+    },
+    onUnlockFailed: () => {
+      console.log('onUnlockFailed');
+    }
+  })
+);
 const adInit = createSyncAPI('adInit', {
   implement: (config?: IAdsInitParams) => {
     ads.init(config);
@@ -48,7 +70,13 @@ const adConfig = createSyncAPI('adConfig', {
 
 const adBreak = createSyncAPI('adBreak', {
   implement: (params: IAdBreakParams) => {
-    ads.adBreak(params);
+    if (params.type === 'reward') {
+      rewardsHelper.getRewardsTypes(ads.httpClient).then((rewardsTypes) => {
+        rewardsHelper.handleReward(rewardsTypes, params);
+      });
+    } else {
+      ads.adBreak(params);
+    }
   }
 });
 

package/src/native/api/get-system-info.ts

@@ -1,6 +1,6 @@
 import { createCommands } from '@jolibox/common';
 import { createSyncAPI, registerCanIUse } from './base';
-import { invokeNative } from '../bootstrap/bridge';
+import { invokeNative } from '@jolibox/native-bridge';
 
 const commands = createCommands();
 
@@ -13,7 +13,7 @@ const getSystemInfoSync = createSyncAPI(API_GET_SYSTEM_SYNC, {
     const { data } = res;
     return {
       system: data.deviceInfo.system,
-      platform: data.deviceInfo.platform,
+      platform: data.deviceInfo.platform.toLowerCase() as 'h5' | 'android' | 'ios',
       version: data.sdkInfo.jssdkVersion,
       pixelRatio: data.deviceInfo.pixelRatio,
       language: data.deviceInfo.lang,

package/src/native/api/index.ts

@@ -6,3 +6,4 @@ import './keyboard';
 import './task';
 import './login';
 import './ads';
+import './navigate';

package/src/native/api/keyboard.ts

@@ -1,5 +1,5 @@
 import { createCommands } from '@jolibox/common';
-import { invokeNative } from '../bootstrap/bridge';
+import { invokeNative } from '@jolibox/native-bridge';
 import { createSyncAPI, registerCanIUse, t } from './base';
 
 export const showKeyboard = createSyncAPI('showKeyboard', {

package/src/native/api/lifecycle.ts

@@ -1,8 +1,9 @@
-import { BaseError, createCommands, wrapUserFunction, hostEmitter } from '@jolibox/common';
+import { BaseError, createCommands, wrapUserFunction, hostEmitter, isBoolean } from '@jolibox/common';
 import { createAPI, createSyncAPI, registerCanIUse, t } from './base';
 import { reportError } from '@/common/report/errors/report';
-import { applyNative, onNative } from '../bootstrap/bridge';
+import { applyNative, onNative, publish } from '@jolibox/native-bridge';
 import { nativeTaskEmitter } from '../report';
+import { context } from '@/common/context';
 
 const EXIT_GAME = 'exitGame';
 const ON_READY = 'onReady';
@@ -13,11 +14,22 @@ const commands = createCommands();
 
 const safeCallbackWrapper = wrapUserFunction(reportError as (err: Error | BaseError) => void);
 const exitGame = createAPI(EXIT_GAME, {
-  paramsSchema: t.tuple(t.function()),
-  implement: async (onBeforeExit: () => void) => {
+  paramsSchema: t.tuple(t.function(), t.boolean().optional().default(false)),
+  implement: async (onBeforeExit: () => void, shouldStay = false) => {
     const safeCallback = safeCallbackWrapper(onBeforeExit);
     // 集中上报
     safeCallback.call(this);
+    // 透传context.shouldInterupt 且值为false时，为内部小程序。广播onRetentionResult
+    if (isBoolean(context.shouldInterupt) && !context.shouldInterupt && context.from) {
+      publish(
+        'onRetentionResult',
+        {
+          shouldStay
+        },
+        context.from,
+        true
+      );
+    }
     await applyNative('exitAppAsync');
   }
 });

package/src/native/api/login.ts

@@ -1,5 +1,5 @@
 import { context } from '@/common/context';
-import { applyNative, invokeNative, onNative } from '../bootstrap/bridge';
+import { applyNative, invokeNative, onNative } from '@jolibox/native-bridge';
 import { createAPI, t, registerCanIUse } from './base';
 import { createCommands, Deferred, hostEmitter } from '@jolibox/common';
 import { createAPIError } from '@/common/report/errors';

package/src/native/api/navigate.ts

@@ -0,0 +1,61 @@
+import { createCommands, UserCustomError } from '@jolibox/common';
+import { invokeNative } from '@jolibox/native-bridge';
+import { createSyncAPI, t, registerCanIUse } from './base';
+import { context } from '@/common/context';
+
+const commands = createCommands();
+
+const openSchemaSync = createSyncAPI('openSchemaSync', {
+  paramsSchema: t.tuple(t.string()),
+  implement: (schema) => {
+    // Add compatibility logic for incomplete URLs
+    let finalSchema = schema;
+    if (!schema.match(/^https?:\/\//)) {
+      finalSchema = `https://${context.mpId}.app.jolibox.com${schema.startsWith('/') ? '' : '/'}${schema}`;
+    }
+
+    const res = invokeNative('openSchemaSync', {
+      schema: finalSchema
+    });
+    if (res.errNo !== 0) {
+      throw new UserCustomError(res.errMsg, res.errNo);
+    }
+  }
+});
+
+const openPageSync = createSyncAPI('openPageSync', {
+  paramsSchema: t.tuple(t.string()),
+  implement: (page) => {
+    const { errNo, errMsg, data } = invokeNative('openPageSync', { url: page });
+    if (errNo !== 0 || !data) {
+      throw new UserCustomError(errMsg, errNo);
+    }
+    return { webviewId: data.webviewId };
+  }
+});
+
+const closePageSync = createSyncAPI('closePageSync', {
+  paramsSchema: t.tuple(t.number()),
+  implement: (webviewId) => {
+    const { errNo, errMsg } = invokeNative('closePageSync', { webviewId });
+    if (errNo !== 0) {
+      throw new UserCustomError(errMsg, errNo);
+    }
+  }
+});
+
+commands.registerCommand('RouterSDK.openSchema', openSchemaSync);
+commands.registerCommand('RouterSDK.openPage', openPageSync);
+commands.registerCommand('RouterSDK.closePage', closePageSync);
+
+registerCanIUse('router.openSchema', {
+  version: '1.1.10'
+});
+
+registerCanIUse('router.openPage', {
+  version: '1.1.10'
+});
+
+registerCanIUse('router.closePage', {
+  version: '1.1.10'
+});

package/src/native/api/request.ts

@@ -1,16 +1,18 @@
 import { createAPIError } from '@/common/report/errors';
 import { createFetch } from '../network/create-fetch';
-import { createAPI, registerCanIUse, t } from './base';
+import { createSyncAPI, registerCanIUse, t } from './base';
 import { dirtyURL, normalizeHeader, normalizeMethod, normalizeTimeout } from '../network/utils';
 import { BaseError, createCommands, Deferred, wrapUserFunction } from '@jolibox/common';
 import { AnyFunction, ResponseType } from '@jolibox/types';
 import { reportError } from '@/common/report/errors/report';
 import { FetchOptions } from '../network/types';
+import { context } from '@/common/context';
 
 const LIMIT = 15;
 
 const publicFetch = createFetch('createRequestTaskSync', 'operateRequestTaskSync', {
-  type: 'public'
+  type: 'public',
+  baseUrl: context.baseApiHost
 });
 
 /** current active count */
@@ -41,12 +43,12 @@ const request = (_params: unknown) => {
     // noop
   };
 
-  const _request = createAPI('request', {
+  const _request = createSyncAPI('request', {
     paramsSchema: t.tuple(
       t.object({
         url: t.string(),
         method: t.string(),
-        header: t.object(),
+        headers: t.object(),
         data: t.object().optional(),
         query: t.object().optional(),
         dataType: t.string().default('json'),
@@ -68,9 +70,10 @@ const request = (_params: unknown) => {
           if (deferred.state !== 'pending') {
             return;
           }
+
           const { data, dataType, responseType, enableCache, appendHostCookie } = params;
 
-          const header = normalizeHeader(params.header);
+          const header = normalizeHeader(params.headers);
           const method = normalizeMethod(params.method);
           const timeout = normalizeTimeout(params.timeout);
           const url = dirtyURL(params.url, method, data);
@@ -89,15 +92,21 @@ const request = (_params: unknown) => {
 
           if (timeout) _params['timeout'] = timeout;
 
-          const task = publicFetch<string | ArrayBuffer | JSON>(url, _params);
-
+          const task = publicFetch<
+            string | ArrayBuffer | JSON | { status: number; data: string | ArrayBuffer | JSON }
+          >(url, _params);
           {
             const { response } = await task;
             const { code, data, message } = response;
-
+            if (data && typeof data === 'object' && 'status' in data && data.status !== 200) {
+              throw createAPIError({
+                code: data.status || -1,
+                msg: `request:fail status ${data.status}`
+              });
+            }
             deferred.resolve({
               code: (code ?? 'SUCCESS') as ResponseType,
-              data,
+              data: data as string | ArrayBuffer | JSON,
               message: message ?? 'request:ok'
             });
 
@@ -132,7 +141,7 @@ const request = (_params: unknown) => {
     }
   });
 
-  _request(_params);
+  _request(_params as Parameters<typeof _request>[0]);
 
   return {
     /**

package/src/native/api/storage.ts

@@ -1,5 +1,5 @@
 import { createAPI, createSyncAPI, registerCanIUse, t } from './base';
-import { applyNative, invokeNative } from '../bootstrap/bridge';
+import { applyNative, invokeNative } from '@jolibox/native-bridge';
 import { createCommands } from '@jolibox/common';
 import { innerFetch as fetch } from '../network';
 import { context } from '@/common/context';

package/src/native/bootstrap/index.ts

@@ -1,39 +1,63 @@
-import { invokeNative, onNative, RuntimeLoader } from './bridge';
-import { joliboxJSCore } from '../js-core';
+import { invokeNative, onNative, RuntimeLoader } from '@jolibox/native-bridge';
 import { context } from '@/common/context';
 import { hostEmitter, isBoolean } from '@jolibox/common';
 import { taskTracker, track } from '../report';
 import { initializeNativeEnv } from './init-env';
 import { adEventEmitter } from '@/common/ads';
+import { openRetentionSchema } from '../ui/retention';
+import { innerFetch } from '../network';
+import { Env } from '@jolibox/types';
+interface IBasicMetaConfig {
+  canShowRecommended: boolean;
+}
+
+declare const globalThis: {
+  joliboxJSCore: {
+    doExit: (uuid: string) => void;
+    onDocumentReady: (path: string) => void;
+    env: (params: { onError: (error: Error) => void }) => Env | undefined;
+  };
+};
+
+/**
+ * 全局变量
+ */
 
+/**
+ * 清除safari jolibox样式
+ */
 let cleanStyles: () => void;
+
+/**
+ * 启动时间戳
+ */
+let start_timestamp: number;
+
+/**
+ * 是否展示广告
+ */
+let isAdShowing = false;
+
+let baskcMeta: IBasicMetaConfig | null = null;
+
 RuntimeLoader.onReady(() => {
   // TODO: merge some env config
 });
 
-RuntimeLoader.doExit(() => {
-  //埋点上报
-  track('onBeforeExit', {
-    timestamp: Date.now()
+/**
+ * 添加广告展示监听
+ */
+function addShowAdListener() {
+  adEventEmitter.on('isAdShowing', (isShowing) => {
+    isAdShowing = isShowing;
+    if (isBoolean(isAdShowing)) {
+      invokeNative('updateContainerConfigSync', {
+        displayCapsuleButton: !isAdShowing,
+        webviewId: context.webviewId
+      });
+    }
   });
-  cleanStyles?.();
-  taskTracker.close(Date.now() - start_timestamp);
-  if (isAdShowing) {
-    return true; // Forbid exit on watching ads
-  }
-  return false;
-});
-
-let isAdShowing = false;
-adEventEmitter.on('isAdShowing', (isShowing) => {
-  isAdShowing = isShowing;
-  if (isBoolean(isAdShowing)) {
-    invokeNative('updateContainerConfigSync', {
-      displayCapsuleButton: !isAdShowing,
-      webviewId: context.webviewId
-    });
-  }
-});
+}
 
 /**
  * The DOMContentLoaded event might be triggered very early,
@@ -41,7 +65,7 @@ adEventEmitter.on('isAdShowing', (isShowing) => {
  */
 function addWebviewReadyListener() {
   hostEmitter.on('onDocumentReady', () => {
-    joliboxJSCore?.onDocumentReady(window.location.href);
+    globalThis.joliboxJSCore?.onDocumentReady(window.location.href);
     track('onDocumentReady', {
       start_timestamp,
       timestamp: Date.now()
@@ -72,14 +96,74 @@ function addGameServiceReadyListener() {
   });
 
   onNative('onBeforeExit', ({ uuid }) => {
-    joliboxJSCore?.doExit(uuid);
+    globalThis.joliboxJSCore?.doExit(uuid);
   });
 }
-let start_timestamp: number;
+
+function addDoExitLoader() {
+  /**
+   * 退出逻辑
+   * 1. 如果正在展示广告，则禁止退出
+   * 2. 如果指定退出挽留逻辑，则按照指定逻辑运行
+   * 3. 如果退出挽留逻辑返回 true，则按照指定逻辑运行
+   * 4. 否则，按照默认逻辑运行
+   */
+
+  const doActualExit = () => {
+    //埋点上报
+    track('onBeforeExit', {
+      timestamp: Date.now()
+    });
+    cleanStyles?.();
+    taskTracker.close(Date.now() - start_timestamp);
+  };
+
+  RuntimeLoader.onDoExit(async () => {
+    if (isAdShowing) {
+      return true; // Forbid exit on watching ads
+    }
+
+    // 指定退出挽留逻辑，则按照指定逻辑运行
+    if (isBoolean(context.shouldInterupt)) {
+      // 不需要打断退出，上报埋点
+      if (!context.shouldInterupt) {
+        doActualExit();
+      }
+      return context.shouldInterupt;
+    }
+
+    if (baskcMeta?.canShowRecommended) {
+      const stay = await openRetentionSchema();
+      if (stay) {
+        // 挽留成功，打断退出
+        return true;
+      }
+    }
+
+    // 退出，对应上报
+    //埋点上报
+    doActualExit();
+    return false;
+  });
+}
+
+async function fetchMetaConfig() {
+  const url = `${context.baseApiHost}/api/fe-configs/js-sdk/basic-meta`;
+  const {
+    response: { data }
+  } = await innerFetch<IBasicMetaConfig>(url);
+
+  if (data) {
+    baskcMeta = data;
+  }
+}
 
 export function config(): void {
   start_timestamp = Date.now();
   addGameServiceReadyListener();
+  addShowAdListener();
+  addDoExitLoader();
   addWebviewReadyListener();
+  fetchMetaConfig();
   cleanStyles = initializeNativeEnv();
 }

package/src/native/network/create-fetch.ts

@@ -2,7 +2,7 @@ import { isString, logger, Deferred, isObject, hostEmitter } from '@jolibox/comm
 import { reportNetworkAPI } from './report';
 import { RequestFrom } from './types';
 import { FetchResponse, FetchOptions } from './types';
-import { invokeNative, onNative } from '@/native/bootstrap/bridge';
+import { invokeNative, onNative } from '@jolibox/native-bridge';
 import { AnyFunction } from '@jolibox/types';
 import { reportError } from '@/common/report/errors/report';
 import { createAPIError } from '@/common/report/errors';
@@ -46,6 +46,7 @@ export function createFetch(
   operateMethod: 'operateRequestTaskSync',
   options?: {
     baseUrl?: string;
+    defaultHeaders?: Record<string, string>;
     type: 'public';
   }
 ): PublicFetch;
@@ -81,7 +82,11 @@ export function createFetch(
 
     if (res.state === 'success') {
       const { requestTaskId, state, ...rest } = res;
-      task.resolve(rest);
+      if (res.statusCode === 200) {
+        task.resolve(rest);
+      } else {
+        task.reject(rest);
+      }
       promiseMap.delete(requestTaskId);
     } else if (res.state === 'fail') {
       const { requestTaskId, state, ...rest } = res;

package/src/native/network/utils.ts

@@ -79,12 +79,19 @@ export function dirtyURL(url: string, method: HTTPMethod, data?: unknown) {
 
   if (!isObject(data)) return url;
 
-  const [_url, search = ''] = url.split('?');
+  const [baseUrl, search = ''] = url.split('?');
 
-  const query = JSON.stringify({
-    ...JSON.parse(search),
-    ...data
-  });
+  // Parse existing query parameters
+  const dataParams = new URLSearchParams(search);
 
-  return `${_url}?${query}`;
+  // Add new parameters from data object
+  for (const [key, value] of Object.entries(data)) {
+    if (value !== undefined && value !== null) {
+      dataParams.append(key, String(value));
+    }
+  }
+
+  const queryString = dataParams.toString();
+
+  return queryString ? `${baseUrl}?${queryString}` : baseUrl;
 }

package/src/native/report/errors/index.ts

@@ -5,7 +5,7 @@ import '@/common/report/errors/report/listeners';
 import { errorReportEmitter } from '@/common/report/errors';
 import { ErrorData } from '@/common/report/errors/report';
 import { logger } from '@jolibox/common';
-import { applyNative, invokeNative } from '@/native/bootstrap/bridge';
+import { invokeNative } from '@jolibox/native-bridge';
 
 errorReportEmitter.on('GLOBAL_ERROR', (error, errorData: ErrorData) => {
   const extra = {

package/src/native/report/index.ts

@@ -4,7 +4,7 @@ export * from '../../common/report/types';
 import { createTracks, ReportHandler } from '@/common/report';
 import { context } from '@/common/context';
 import { NativeTaskTracker } from './task-tracker';
-import { invokeNative } from '../bootstrap/bridge';
+import { invokeNative } from '@jolibox/native-bridge';
 
 const reportNative: ReportHandler = (event, data, webviewId) => {
   const _data = data as Record<string, unknown>;

package/src/native/report/task-tracker.ts

@@ -6,7 +6,7 @@ import { context } from '@/common/context';
 import { TaskTracker, TaskPoint } from '@/common/report/task-track';
 import { EventEmitter } from '@jolibox/common';
 import { innerFetch as fetch } from '../network';
-import { applyNative } from '../bootstrap/bridge';
+import { applyNative } from '@jolibox/native-bridge';
 import type { Track } from '.';
 import type { TrackEvent } from '@jolibox/types';