@jolibox/implement 1.1.4-beta.4

package/src/native/network/types.ts

@@ -0,0 +1,77 @@
+interface Profile {
+  socketReused?: boolean; // 是否复用连接
+}
+
+export interface DownLoadOptions {
+  url: string;
+  header: Record<string, unknown>;
+  filePath?: string;
+  appendHostCookie?: boolean;
+  timeout?: number;
+}
+
+export interface DownLoadResponse {
+  statusCode?: number;
+  tempFilePath?: string;
+  errMsg?: string;
+  profile?: Profile;
+  filePath?: string;
+  header?: Record<string, string>;
+}
+
+export type HTTPMethod =
+  | 'GET'
+  | 'OPTIONS'
+  | 'HEAD'
+  | 'POST'
+  | 'PUT'
+  | 'DELETE'
+  | 'TRACE'
+  | 'CONNECT'
+  | 'PATCH';
+
+export interface FetchOptions {
+  method?: HTTPMethod;
+  data?: Record<string, unknown> | string | ArrayBuffer;
+  query?: Record<string, string>;
+  header?: Record<string, string>;
+  dataType?: string; // 'json'
+  timeout?: number;
+  enableCache?: boolean;
+  responseType?: string; // 'text' | 'arraybuffer';
+  appendHostCookie?: boolean;
+}
+
+export interface FetchResponse<T = string | JSON | ArrayBuffer | undefined> {
+  header?: Record<string, string>;
+  code?: string;
+  message?: string;
+  data: T;
+  errMsg?: string;
+  prefetchDetail?: number;
+  size?: number;
+  profile?: Profile;
+}
+
+export interface UpLoadOptions {
+  url: string;
+  filePath: string;
+  name: string;
+  header: Record<string, unknown>;
+  formData: Record<string, unknown>;
+  appendHostCookie?: boolean;
+  timeout?: number;
+}
+
+export interface UpLoadResponse<T = string | Record<string, unknown> | ArrayBuffer | undefined> {
+  statusCode?: number;
+  data: T;
+  errMsg?: string;
+  progress?: number;
+  profile?: Profile;
+}
+
+export enum RequestFrom {
+  PUBLIC = 'public',
+  INNER = 'inner'
+}

package/src/native/network/utils.ts

@@ -0,0 +1,90 @@
+import { isObject } from '@jolibox/common';
+
+export type HTTPMethod =
+  | 'GET'
+  | 'OPTIONS'
+  | 'HEAD'
+  | 'POST'
+  | 'PUT'
+  | 'DELETE'
+  | 'TRACE'
+  | 'CONNECT'
+  | 'PATCH';
+
+export function normalizeHeader(header: unknown) {
+  const normalized: Record<string, string> = {};
+
+  if (!isObject(header)) {
+    return normalized;
+  }
+  for (const [_key, value] of Object.entries(header)) {
+    const key = _key.toLocaleLowerCase();
+    if (!value) {
+      normalized[key] = '';
+    } else if (typeof value === 'object') {
+      normalized[key] = Object.prototype.toString.call(value);
+    } else {
+      normalized[key] = String(value);
+    }
+  }
+
+  return normalized;
+}
+
+export function normalizeFormData(formData: unknown) {
+  const normalized: Record<string, string> = {};
+
+  if (!isObject(formData)) {
+    return normalized;
+  }
+
+  for (const [key, value] of Object.entries(formData)) {
+    if (!value) {
+      normalized[key] = '';
+    } else if (typeof value === 'object') {
+      normalized[key] = Object.prototype.toString.call(value);
+    } else {
+      normalized[key] = String(value);
+    }
+  }
+
+  return normalized;
+}
+
+export function normalizeMethod(method = 'GET') {
+  if (method === '') {
+    return 'POST';
+  }
+
+  const _method = method.toUpperCase();
+
+  if (['GET', 'OPTIONS', 'HEAD', 'POST', 'PUT', 'DELETE', 'TRACE', 'CONNECT', 'PATCH'].includes(_method)) {
+    return _method as HTTPMethod;
+  }
+
+  return 'GET';
+}
+
+export function normalizeTimeout(time: number | undefined, unlimited = false) {
+  if (!time) return undefined;
+  if (unlimited || (time > 0 && time <= 60e3)) return Math.ceil(time);
+  return 60e3;
+}
+
+/**
+ * modify url
+ */
+export function dirtyURL(url: string, method: HTTPMethod, data?: unknown) {
+  if (['POST', 'PUT', 'PATCH'].includes(method)) return url;
+
+  if (!isObject(data)) return url;
+
+  const [_url, search = ''] = url.split('?');
+
+  const query = JSON.stringify({
+    ...JSON.parse(search),
+    ...data
+  });
+
+  return `${_url}?${query}`;
+}

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

@@ -0,0 +1,27 @@
+/**
+ * 端侧上报的实现逻辑
+ */
+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';
+
+errorReportEmitter.on('GLOBAL_ERROR', (error, errorData: ErrorData) => {
+  const extra = {
+    message: error.message,
+    stack: error.stack ?? '',
+    errorType: error.name,
+    source: 0
+  };
+
+  invokeNative('trackAsync', {
+    event: 'reportJsError',
+    data: extra
+  });
+});
+
+errorReportEmitter.on('GLOBAL_USER_ERROR', (error, errorData: ErrorData) => {
+  // TODO: User Error
+  logger.log('UserError', error, errorData);
+});

package/src/native/report/index.ts

@@ -0,0 +1,51 @@
+import './errors';
+import { createCommands, isObject, isString, EventEmitter } from '@jolibox/common';
+export * from '../../common/report/types';
+import { createTracks, EProject, ReportHandler } from '@/common/report';
+import { context } from '@/common/context';
+import { NativeTaskTracker } from './task-tracker';
+import { invokeNative } from '../bootstrap/bridge';
+
+const reportNative: ReportHandler = (event, data, webviewId) => {
+  const _data = data as Record<string, unknown>;
+  const originExtra = isObject(_data.extra)
+    ? _data.extra
+    : isString(_data.extra)
+    ? JSON.parse(_data.extra)
+    : {};
+  const extra = {
+    ...originExtra,
+    source_id: (_data.source_id as string) ?? '',
+    source_version: (_data.source_version as string) ?? ''
+  };
+  invokeNative('trackAsync', {
+    event,
+    data: extra,
+    webviewId
+  });
+};
+
+const { track, trackPerformance } = createTracks(reportNative, {
+  type: EProject.AppSDK,
+  platform: 'native',
+  jssdk_version: context.sdkInfo?.jssdkVersion ?? '1.0.0',
+  source_id: context.game_id,
+  source_version: context.game_version
+});
+
+export { track, trackPerformance };
+
+const commands = createCommands();
+
+commands.registerCommand('ReportSDK.traceSystemTimeline', ({ event, duration }) => {
+  trackPerformance(event, duration);
+});
+
+commands.registerCommand('ReportSDK.traceSystem', ({ event, info }) => {
+  track(event, info);
+});
+
+// 任务上报
+
+export const nativeTaskEmitter = new EventEmitter<{ visible: [boolean] }>();
+export const taskTracker = new NativeTaskTracker(nativeTaskEmitter);

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

@@ -0,0 +1,64 @@
+/**
+ * 任务上报
+ */
+
+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';
+
+type NativeTaskPointEvent =
+  | 'OPEN_GAME'
+  | 'CLOSE_GAME'
+  | 'LEVEL_FINISHED'
+  | 'TASK_FINISHED'
+  | 'LEVEL_UPGRADE'
+  | 'HISTORY_USER_LEVEL'
+  | 'HISTORY_USER_SCORE'
+  | 'TASK_PAYMENT'
+  | 'TASK_EVENT';
+
+export type NativeTaskPoint = {
+  event: NativeTaskPointEvent;
+  params: Record<string, unknown>;
+};
+export class NativeTaskTracker extends TaskTracker {
+  private gameId: string;
+  private sessionId: string;
+
+  constructor(eventEmitter: EventEmitter<{ visible: [boolean] }>, interval?: number) {
+    super(eventEmitter, interval);
+    this.gameId = context.game_id;
+    this.sessionId = context.session_id;
+  }
+  async reporter(point: TaskPoint): Promise<void> {
+    const { event, params } = point;
+    const reportTasks = [];
+    reportTasks.push(
+      fetch(`/api/base/app-event`, {
+        method: 'POST',
+        data: {
+          eventType: event,
+          gameInfo: {
+            gameId: this.gameId,
+            sessionId: this.sessionId,
+            ...params
+          }
+        }
+      })
+    );
+    await Promise.all(reportTasks);
+  }
+
+  async reportToNative(point: NativeTaskPoint) {
+    const { event, params } = point;
+    await applyNative('userTrackAsync', {
+      event: event,
+      params: {
+        ...params
+      },
+      gameId: this.gameId
+    });
+  }
+}

package/src/native/types/global.d.ts

@@ -0,0 +1,26 @@
+declare global {
+  namespace jsb {
+    interface JSCore {
+      invoke: (method: string, params: string, callbackId: number) => string | Record<string, unknown> | void;
+
+      // publish: (event: string, data: Record<string, unknown>, webviewIds: number[]) => void;
+
+      // 安卓 Webview 没有call
+      call?: (
+        method: string,
+        params: Record<string, unknown>,
+        callbackId: number
+      ) => string | Record<string, unknown> | void;
+
+      onDocumentReady: (path: string) => void;
+      doExit: (uuid: string) => void;
+      bind?: (id: number, handler: (...args: unknown[]) => unknown) => void;
+    }
+
+    type ApplyNativeReturn<T> = T extends Promise<infer U>
+      ? Promise<Omit<U, 'errMsg' | 'errNo'>>
+      : Omit<T, 'errMsg' | 'errNo'>;
+  }
+}
+
+export {};

package/src/native/types/native-method-map.d.ts

@@ -0,0 +1,282 @@
+import { Env, ISystemInfo } from '@jolibox/types';
+
+declare global {
+  namespace jsb.service {
+    type NativeTaskPointEvent =
+      | 'OPEN_GAME'
+      | 'CLOSE_GAME'
+      | 'LEVEL_FINISHED'
+      | 'TASK_FINISHED'
+      | 'LEVEL_UPGRADE'
+      | 'HISTORY_USER_LEVEL'
+      | 'HISTORY_USER_SCORE'
+      | 'TASK_PAYMENT'
+      | 'TASK_EVENT';
+    interface NativeMethodMap {
+      prefetchImages: (params: {
+        /** 需要预下载的图片 url */
+        images: string[];
+      }) => Promise<{
+        /** 错误消息 */
+        errMsg: string;
+        /** 错误码 */
+        errNo?: number;
+      }>;
+
+      showKeyboardSync: (params: {
+        /** 默认值 */
+        defaultValue?: string;
+        /** 最大长度 */
+        maxLength?: number; // Integer
+        /** 是否是多行 */
+        multiple?: boolean;
+      }) => {
+        /** 错误消息 */
+        errMsg: string;
+        /** 错误码 */
+        errNo?: number;
+      };
+
+      updateKeyboardSync: (params: {
+        /** 更新的文本内容 */
+        value?: string;
+      }) => Promise<{
+        /** 错误消息 */
+        errMsg: string;
+        /** 错误码 */
+        errNo?: number;
+      }>;
+
+      hideKeyboardSync: () => {
+        /** 错误消息 */
+        errMsg: string;
+        /** 错误码 */
+        errNo?: number;
+      };
+
+      /**
+       * 存储相关
+       */
+      getLocalStorageAsync: (params: { key: string }) => Promise<{
+        /** 错误消息 */
+        errMsg: string;
+        /** 错误码 */
+        errNo?: number;
+        data: {
+          /** 数据 */
+          data: any;
+          /** 数据类型 */
+          dataType: string;
+        };
+      }>;
+
+      setLocalStorageAsync: (params: { key: string; data: any; dataType: string }) => Promise<{
+        /** 错误消息 */
+        errMsg: string;
+        /** 错误码 */
+        errNo?: number;
+      }>;
+
+      removeLocalStorageAsync: (params: {
+        /** 要删除缓存数据的键 */
+        key: string;
+      }) => Promise<{
+        /** 错误消息 */
+        errMsg: string;
+        /** 错误码 */
+        errNo?: number;
+      }>;
+
+      clearLocalStorageAsync: () => Promise<{
+        /** 错误消息 */
+        errMsg: string;
+        /** 错误码 */
+        errNo?: number;
+      }>;
+
+      getStorageInfoAsync: () => Promise<{
+        /** 错误消息 */
+        errMsg: string;
+        /** 错误码 */
+        errNo?: number;
+        data: {
+          /** 当前已缓存数据的大小，单位:KB */
+          currentSize: number; // Long
+          /** 数据缓存大小上限，单位:KB */
+          limitSize: number; // Long
+          /** 已缓存数据的key */
+          keys: string[];
+        };
+      }>;
+
+      getStorageInfoSync: () => {
+        /** 错误消息 */
+        errMsg: string;
+        /** 错误码 */
+        errNo?: number;
+        data: {
+          /** 当前已缓存数据的大小，单位:KB */
+          currentSize: number; // Long
+          /** 数据缓存大小上限，单位:KB */
+          limitSize: number; // Long
+          /** 已缓存数据的key */
+          keys: string[];
+        };
+      };
+
+      exitAppAsync: () => Promise<{
+        /** 错误消息 */
+        errMsg: string;
+        /** 错误码 */
+        errNo?: number;
+      }>;
+
+      getSystemInfoSync: () => {
+        /** 错误消息 */
+        errMsg: string;
+        /** 错误码 */
+        errNo?: number;
+        data: ISystemInfo;
+      };
+
+      envSync: () => {
+        /** 错误消息 */
+        errMsg: string;
+        /** 错误码 */
+        errNo?: number;
+        /** 环境 */
+        data: Env;
+      };
+
+      loadScriptSync: () => {
+        /** 错误消息 */
+        errMsg: string;
+        /** 错误码 */
+        errNo?: number;
+        data: string;
+      };
+      /**
+       * 用户行为上报,
+       * TODO: 明确event类型和params类型
+       */
+      userTrackAsync: (params: { event: NativeTaskPointEvent; params: any; gameId: string }) => Promise<{
+        /** 错误消息 */
+        errMsg: string;
+        /** 错误码 */
+        errNo?: number;
+      }>;
+
+      trackAsync: (params: { event: string; data: any; webviewId?: number }) => Promise<{
+        /** 错误消息 */
+        errMsg: string;
+        /** 错误码 */
+        errNo?: number;
+      }>;
+
+      /**
+       * 网络请求
+       */
+      createRequestTaskSync: (params: {
+        url: string;
+        data: string | ArrayBuffer;
+        method: HTTPMethod;
+        header: {
+          'content-type': string;
+        } & Record<string, string>;
+        enableCache: boolean;
+        responseType: string;
+        appendHostCookie: boolean;
+      }) => {
+        /** 错误消息 */
+        errMsg: string;
+        /** 错误码 */
+        errNo?: number;
+        data: {
+          requestTaskId?: string;
+        };
+      };
+
+      /**
+       * 登陆
+       */
+      loginSync: () => {
+        /** 错误消息 */
+        errMsg: string;
+        /** 错误码 */
+        errNo?: number;
+        data: {
+          uuid: string; // 用户唯一标识
+        };
+      };
+
+      /**
+       * 检查登陆状态
+       */
+      checkLoginAsync: () => Promise<{
+        /** 错误消息 */
+        errMsg: string;
+        /** 错误码 */
+        errNo?: number;
+        data: {
+          isLogin: boolean;
+        };
+      }>;
+
+      getUserInfoAsync: () => Promise<{
+        errNo?: number;
+        errMsg: string;
+        data: {
+          userInfo: {
+            avatarUrl?: string;
+            [key: string]: unknown;
+          }; // 用户信息对象，不包含 openid 等敏感信息
+          rawData: string; // 不包括敏感信息的原始数据字符串，用于计算签名。
+          signature?: string; // 使用 sha1( rawData + sessionkey ) 得到字符串
+          encryptedData?: string; // 包括敏感数据在内的完整用户信息的加密数据
+          iv?: string; // 加密算法的初始向量
+          realNameAuthenticationStatus?: 'uncertified' | 'certified';
+        };
+      }>;
+    }
+
+    interface NativeEventMap {
+      onMemoryWarning: [
+        {
+          /** 内存告警等级，只有 Android 才有，对应系统宏定义 */
+          level?: '5' | '10' | '15';
+        }
+      ];
+      onJoliboxEnterBackground: [];
+      onJoliboxEnterForeground: [];
+      onBeforeExit: [
+        {
+          uuid: string;
+        }
+      ];
+      onJoliboxServiceReady: [
+        {
+          runtimeInfo?: Env.hostUserInfo;
+          loadDuration?: number;
+        }
+      ];
+
+      onRequestTaskStateChange: [
+        {
+          requestTaskId: string;
+          state: string;
+          errMsg: string;
+          errNo?: number;
+        }
+      ];
+      onLoginStateChange: [
+        {
+          isLogin: boolean;
+          uuid: string;
+          token?: string;
+        }
+      ];
+    }
+  }
+}
+
+export {};

package/src/native/types/native-method.d.ts

@@ -0,0 +1,30 @@
+declare global {
+  namespace jsb.service {
+    /**
+     * implement 调 native 方法
+     */
+    type InvokeNative = <T extends keyof NativeMethodMap>(
+      method: T,
+      ...params: Parameters<NativeMethodMap[T]>
+    ) => ReturnType<NativeMethodMap[T]>;
+
+    type ApplyNative = <T extends keyof NativeMethodMap>(
+      method: T,
+      ...paras: Parameters<NativeMethodMap[T]>
+    ) => ApplyNativeReturn<ReturnType<NativeMethodMap[T]>>;
+
+    /**
+     * implement 监听 native 方法
+     */
+    type OnNative = <T extends keyof NativeEventMap>(
+      event: T,
+      handler: (...params: NativeEventMap[T]) => void
+    ) => void;
+
+    type OnNativeOnce = OnNative;
+
+    type OffNative = OnNative;
+  }
+}
+
+export {};

package/tsconfig.json

@@ -0,0 +1,18 @@
+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "rootDir": "./src",
+    "outDir": "./dist",
+    "target": "ES2020",
+    "lib": ["ES2020", "DOM"],
+    "declaration": true,
+    "emitDeclarationOnly": true,
+    "noEmit": false,
+    "experimentalDecorators": true,
+    "paths": {
+      "@/*": ["./src/*"]
+    }
+  },
+  "include": ["src/**/*"],
+  "exclude": ["dist/", "node_modules"]
+}