@jolibox/implement 1.1.12 → 1.1.13-beta.1

package/dist/native/js-bridge/types.d.ts

@@ -2,6 +2,7 @@ export type Listener = (...args: any[]) => any;
 export type On = <T extends string>(event: T, handler: Listener) => void;
 export type Off = <T extends string>(event: T, handler: Listener) => void;
 export type InvokeHandler = (callbackId: string | number, data: string | Record<string, unknown>) => void;
+export type Publish = (event: string, data: Record<string, unknown>, webviewId?: number, force?: boolean) => void;
 export type SubscribeHandler = (event: string, data: string | Record<string, unknown>, webviewId?: number) => void;
 export type AnyFunction = (...args: any[]) => any;
 export interface JSBridge {
@@ -11,4 +12,7 @@ export interface JSBridge {
     applyNative: jsb.service.ApplyNative;
     onNative: jsb.service.OnNative;
     offNative: jsb.service.OffNative;
+    publish: Publish;
+    subscribe: On;
+    unsubscribe: Off;
 }

package/dist/native/js-core/jolibox-js-core.d.ts

@@ -5,6 +5,11 @@ declare global {
             invoke: (invokeString: string) => void;
             onDocumentReady: (paramsstr: string) => void;
             doExit: (uuidString: string) => void;
+            publish: (params: {
+                event: string;
+                webviewIds: number[] | '*';
+                paramsString: string;
+            }) => void;
         };
         webkit?: {
             messageHandlers: {
@@ -18,7 +23,7 @@ declare global {
                 publish: {
                     postMessage: (params: {
                         event: string;
-                        webviewIds: string;
+                        webviewIds: number[] | '*';
                         paramsString: string;
                     }) => void;
                 };
@@ -39,7 +44,7 @@ declare global {
 }
 export declare const RuntimeLoader: {
     trigger(): void;
-    exit(): boolean;
+    exit(): Promise<boolean>;
     onReady(fn: () => void): void;
-    doExit(fn: () => boolean): void;
+    doExit(fn: () => Promise<boolean>): void;
 };

package/dist/native/network/create-fetch.d.ts

@@ -15,6 +15,7 @@ type PublicFetch = <T>(url: string, options?: FetchOptions) => Promise<{
 }>;
 export declare function createFetch(createMethod: 'createRequestTaskSync', operateMethod: 'operateRequestTaskSync', options?: {
     baseUrl?: string;
+    defaultHeaders?: Record<string, string>;
     type: 'public';
 }): PublicFetch;
 export declare function createFetch(createMethod: 'createRequestTaskSync', operateMethod: 'operateRequestTaskSync', options?: {

package/dist/native/ui/retention.d.ts

@@ -0,0 +1 @@
+export declare function openRetentionSchema(): Promise<boolean>;

package/implement.build.log

@@ -1,9 +1,9 @@
 Invoking: npm run clean && npm run build:esm && tsc 
 
-> @jolibox/implement@1.1.12 clean
+> @jolibox/implement@1.1.13-beta.1 clean
 > rimraf ./dist
 
 
-> @jolibox/implement@1.1.12 build:esm
+> @jolibox/implement@1.1.13-beta.1 build:esm
 > BUILD_VERSION=$(node -p "require('./package.json').version")  node esbuild.config.js --format=esm
 

package/package.json

@@ -1,14 +1,15 @@
 {
   "name": "@jolibox/implement",
   "description": "This project is Jolibox JS-SDk implement for Native && H5",
-  "version": "1.1.12",
+  "version": "1.1.13-beta.1",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
   "license": "MIT",
   "dependencies": {
-    "@jolibox/common": "1.1.12",
-    "@jolibox/types": "1.1.12",
+    "@jolibox/common": "1.1.13-beta.1",
+    "@jolibox/types": "1.1.13-beta.1",
     "localforage": "1.10.0",
+    "@jolibox/ui": "1.0.0",
     "web-vitals": "4.2.4"
   },
   "devDependencies": {

package/src/common/context/index.ts

@@ -1,7 +1,7 @@
 import { mergeArray, mergeWith } from '@jolibox/common';
 import { DeviceInfo, HostInfo, HostUserInfo, SdkInfo } from './types';
 import { Env } from '@jolibox/types';
-import { parseUrlQuery } from './url-parse';
+import { parseUrlQuery, encodeJoliSourceQuery, QueryParams } from './url-parse';
 import { getAppVersion } from '../http/xua';
 import { getDeviceId } from '@jolibox/common';
 
@@ -36,12 +36,13 @@ const env = Object.assign({}, nativeEnv?.() ?? defaultEnv);
 type MPType = 'game' | 'miniApp';
 
 const wrapContext = () => {
-  const { payloadJson, headerJson } = env.schema.length ? parseUrlQuery(env.schema) : {};
+  const { payloadJson, headerJson, signature } = env.schema.length ? parseUrlQuery(env.schema) : {};
   const defaultSessionId = `${env.deviceInfo.did}-${new Date().getTime()}`;
   const url = new URL(env.schema.length ? env.schema : window.location.href);
   const urlParams = url.searchParams;
   const defaultGameID = urlParams.get('mpId') ?? urlParams.get('appId') ?? urlParams.get('gameId') ?? '';
-  const sessionId = payloadJson?.sessionId ?? urlParams.get('sessionId') ?? defaultSessionId;
+  const sessionId =
+    env.clientSessionId ?? payloadJson?.sessionId ?? urlParams.get('sessionId') ?? defaultSessionId;
   const testAdsMode = !!(payloadJson?.testAdsMode ?? urlParams.get('testAdsMode') === 'true');
   const joliboxEnv = payloadJson?.joliboxEnv ?? urlParams.get('joliboxEnv') ?? 'production';
   const testMode = joliboxEnv === 'staging';
@@ -93,8 +94,26 @@ const wrapContext = () => {
     get webviewId(): number {
       return env.webviewId ?? -1;
     },
+    get shouldInterupt(): boolean | undefined {
+      return payloadJson?.__shouldInterupt;
+    },
+    get from(): number | undefined {
+      return payloadJson?.__from;
+    },
+    get baseApiHost(): string {
+      return testMode ? 'https://stg-api.jolibox.com' : 'https://api.jolibox.com';
+    },
     onEnvConfigChanged: (newConfig: Partial<Env>) => {
       mergeWith(env, newConfig, mergeArray);
+    },
+    encodeJoliSourceQuery: (newPayloadJson: QueryParams['payloadJson']) => {
+      if (headerJson && signature) {
+        return encodeJoliSourceQuery(
+          { ...payloadJson, ...newPayloadJson },
+          urlParams.get('joliSource') ?? ''
+        );
+      }
+      return urlParams.get('joliSource') ?? '';
     }
   };
 };

package/src/common/context/url-parse.ts

@@ -14,6 +14,12 @@ interface PayloadJson {
   joliboxEnv?: 'staging' | 'production';
   sessionId?: string;
   __mpType?: 'game' | 'miniApp';
+  __orientation?: 'HORIZONTAL' | 'VERTICAL';
+  __transparent?: boolean;
+  __entryPath?: string;
+  __showStatusBar?: boolean;
+  __shouldInterupt?: boolean;
+  __from?: number; // 从哪个小程序打开的
 }
 
 interface Signature {
@@ -21,7 +27,7 @@ interface Signature {
   payloadSig?: string;
 }
 
-interface QueryParams {
+export interface QueryParams {
   headerJson: HeaderJson;
   payloadJson: PayloadJson;
   signature: Signature;
@@ -38,6 +44,12 @@ const base64UrlDecode = <T>(input: string): T => {
   }
 };
 
+const base64UrlEncode = <T>(input: T): string => {
+  const jsonStr = JSON.stringify(input);
+  const base64 = btoa(jsonStr);
+  return base64.replace(/\+/g, '-').replace(/\//g, '_').replace(/=/g, '');
+};
+
 export const parseUrlQuery = (url: string): QueryParams => {
   try {
     const urlObj = new URL(url);
@@ -63,3 +75,14 @@ export const parseUrlQuery = (url: string): QueryParams => {
     };
   }
 };
+
+export const encodeJoliSourceQuery = (payloadJson: PayloadJson, originJoliSource: string): string => {
+  const joli_source = originJoliSource.split('.');
+  if (joli_source && joli_source.length === 3) {
+    const headerJsonStr = joli_source[0];
+    const payloadJsonStr = base64UrlEncode(payloadJson);
+    const signatureJsonStr = joli_source[2];
+    return `${headerJsonStr}.${payloadJsonStr}.${signatureJsonStr}`;
+  }
+  return originJoliSource;
+};

package/src/native/api/index.ts

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

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 '../bootstrap/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/navigate.ts

@@ -0,0 +1,61 @@
+import { createCommands, UserCustomError } from '@jolibox/common';
+import { invokeNative } from '../bootstrap/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/bootstrap/bridge.ts

@@ -38,7 +38,16 @@ const bridge = createBridge(core);
 
 const { invokeHandler } = bridge;
 
-export const { applyNative, invokeNative, onNative, offNative, subscribeHandler } = bridge;
+export const {
+  applyNative,
+  invokeNative,
+  onNative,
+  offNative,
+  subscribeHandler,
+  publish,
+  subscribe,
+  unsubscribe
+} = bridge;
 
 export const onNativeWithError: On = (event, handler) => {
   // eslint-disable-next-line @typescript-eslint/no-explicit-any

package/src/native/bootstrap/index.ts

@@ -5,35 +5,52 @@ 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';
 
+interface IBasicMetaConfig {
+  canShowRecommended: boolean;
+}
+
+/**
+ * 全局变量
+ */
+
+/**
+ * 清除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,
@@ -75,11 +92,71 @@ function addGameServiceReadyListener() {
     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.doExit(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/js-bridge/const.ts

@@ -9,3 +9,5 @@ export const BUFFER_METHODS: string[] = [];
 export const BACKGROUND_FORBIDDEN_METHODS: string[] = [];
 
 export const SYNC_METHODS: string[] = ['env', 'createRequestTask', 'login'];
+
+export const BATCH_EVENT = '__batch_event__';

package/src/native/js-bridge/js-bridge.ts

@@ -1,15 +1,17 @@
 import { createInvoke } from './invoke';
 import { createSubscribe } from './subscribe';
 import { JSBridge } from './types';
+import { createPublish } from './publish';
 
 /**
  * build js-bridge
  * @param jsCore jsCore function inject by native
  */
 export function createBridge(jsCore: jsb.JSCore): JSBridge {
-  const { subscribeHandler, onNative, offNative } = createSubscribe(jsCore);
+  const { subscribeHandler, onNative, offNative, subscribe, unsubscribe } = createSubscribe(jsCore);
 
   const { invokeNative, invokeHandler, applyNative } = createInvoke(jsCore, onNative);
+  const publish = createPublish(jsCore);
 
   return {
     // 宿主调用
@@ -18,6 +20,9 @@ export function createBridge(jsCore: jsb.JSCore): JSBridge {
     applyNative,
     invokeNative,
     onNative,
-    offNative
+    offNative,
+    publish,
+    subscribe,
+    unsubscribe
   };
 }

package/src/native/js-bridge/publish.ts

@@ -0,0 +1,44 @@
+import { CUSTOM_EVENT_PREFIX, BATCH_EVENT } from './const';
+
+type BatchEvent = [event: string, data: unknown];
+type BatchEvents = BatchEvent[];
+
+export function createPublish(jsCore: jsb.JSCore) {
+  const eventsMap = new Map<number | undefined, BatchEvents>();
+  let batchTask: Promise<void> | undefined;
+  const publish = (event: string, data: Record<string, unknown>, webviewId?: number, force?: boolean) => {
+    if (force) {
+      const ids = webviewId ? [webviewId] : '*';
+      jsCore.publish(`${CUSTOM_EVENT_PREFIX}${event}`, data, ids);
+      return;
+    }
+
+    if (!batchTask) {
+      batchTask = Promise.resolve().then(() => {
+        eventsMap.forEach((data, webviewId) => {
+          try {
+            const ids = webviewId ? [webviewId] : '*';
+            jsCore.publish(BATCH_EVENT, data, ids);
+          } catch {
+            // 避免一组 webview publish 的报错影响其他 webview publish
+          }
+        });
+
+        // reset
+        batchTask = undefined;
+        eventsMap.clear();
+      });
+    }
+
+    let events = eventsMap.get(webviewId);
+
+    if (!events) {
+      events = [];
+      eventsMap.set(webviewId, events);
+    }
+
+    events.push([`${CUSTOM_EVENT_PREFIX}${event}`, data]);
+  };
+
+  return publish;
+}