@hyext/types-ext-sdk-hy 4.1.3-beta.7 → 4.2.0-beta.1

package/index.d.ts

@@ -203,6 +203,29 @@ namespace storage {
      * @returns 调用结果
      */
     function getKeys(): Promise<StorageKeys>;
+    /**
+     * 清理本地数据缓存。
+     */
+    function clearStorage(): Promise<void>;
+    /**
+     * 从本地缓存中异步获取指定 key 的内容
+     * @param params - 传入参数
+     */
+    function getStorage(params: GetStorageReq): Promise<StorageRsp>;
+    /**
+     * 异步获取当前storage的相关信息。
+     */
+    function getStorageInfo(): Promise<GetSorageInfoRsp>;
+    /**
+     * 从本地缓存中移除指定 key
+     * @param params - 传入参数
+     */
+    function removeStorage(params: RemoveStorageReq): void;
+    /**
+     * 将数据存储在本地缓存中指定的 key 中, 会覆盖掉原来该 key 对应的内容
+     * @param params - 传入参数
+     */
+    function setStorage(params: SetStorageReq): Promise<void>;
 }
 
 /**
@@ -3983,6 +4006,10 @@ namespace device {
      * @param [params] - 输入参数
      */
     function lockOrientation(params?: LockOrientationReq): Promise<void>;
+    /**
+     * 获取系统信息
+     */
+    function getSystemInfo(): Promise<SystemInfo>;
 }
 
 /**
@@ -4324,6 +4351,54 @@ type LockOrientationReq = {
     enable: boolean;
 };
 
+/**
+ * 锁定横或竖屏传入参数
+ * @property appId - 宿主 app 对应的 appId
+ */
+type HostInfo = {
+    appId: string;
+};
+
+/**
+ * 窗口信息
+ * @property brand - 设备品牌
+ * @property model - 设备型号
+ * @property pixelRatio - 设备像素比
+ * @property screenWidth - 屏幕宽度，单位px
+ * @property screenHeight - 屏幕高度，单位px
+ * @property windowWidth - 可使用窗口宽度，单位px
+ * @property windowHeight - 可使用窗口高度，单位px
+ * @property statusBarHeight - 状态栏的高度，单位px
+ * @property language - 设置的语言
+ * @property version - 虎牙版本号
+ * @property system - 操作系统及版本
+ * @property platform - 客户端平台枚举, 值为：ios | android | ohos | windows | mac
+ * @property fontSizeSetting - 用户字体大小（单位px）
+ * @property SDKVersion - 客户端基础库版本
+ * @property safeArea - 在竖屏正方向下的安全区域。部分机型没有安全区域概念，也不会返回 safeArea 字段，开发者需自行兼容。
+ * @property deviceOrientation - 设备方向，值为：portrait | landscape
+ * @property host - 当前小程序运行的宿主环境信息
+ */
+type SystemInfo = {
+    brand: string;
+    model: string;
+    pixelRatio: number;
+    screenWidth: number;
+    screenHeight: number;
+    windowWidth: number;
+    windowHeight: number;
+    statusBarHeight: number;
+    language: string;
+    version: string;
+    system: string;
+    platform: string;
+    fontSizeSetting: number;
+    SDKVersion: string;
+    safeArea: SafeArea;
+    deviceOrientation: string;
+    host: HostInfo;
+};
+
 /**
  * 逐步废弃
  */
@@ -4372,6 +4447,14 @@ namespace env {
      * 取消监听来源数据变化
      */
     function offSourceDataChange(): Promise<void>;
+    /**
+     * 同步获取冷启动时的参数
+     */
+    function getLaunchOptionsSync(): LaunchOptions;
+    /**
+     * 获取网络类型
+     */
+    function getNetworkType(): Promise<NetworkTypeRsp>;
 }
 
 /**
@@ -4567,6 +4650,39 @@ type OnSourceDataChangeReq = {
     callback: SourceDataChangeCallback;
 };
 
+/**
+ * @property appId - 来源小程序或 App 的 appId
+ * @property extraData - 来源小程序传过来的数据
+ */
+type ReferrerInfo = {
+    appId: number;
+    extraData: Map;
+};
+
+/**
+ * @property scene - 启动小游戏的场景值，其值为：1000
+ * @property query - 启动小游戏的 query 参数
+ * @property referrerInfo - 来源信息。从另一个小程序 或 App 进入小程序时返回。否则返回 {}。
+ */
+type LaunchOptions = {
+    scene: number;
+    query: Map;
+    referrerInfo: ReferrerInfo;
+};
+
+/**
+ * @property networkType - 网络类型，其值为：'wifi' | '2g' | '3g' | '4g' | '5g' | 'unknown' | 'none'
+ * @property signalStrength - 信号强弱，单位 dbm
+ * @property hasSystemProxy - 设备是否使用了网络代理
+ * @property weakNet - 是否处于弱网环境
+ */
+type NetworkTypeRsp = {
+    networkType: string;
+    signalStrength: number;
+    hasSystemProxy: boolean;
+    weakNet: boolean;
+};
+
 /**
  * EXE加工相关
  */
@@ -8691,6 +8807,104 @@ type RaiseCaptchaReq = {
 
 type sentryTags = any;
 
+/**
+ * 服务端持久化
+ */
+namespace storage {
+    /**
+     * 获取存储信息
+     * @param key - 存储的键
+     * @returns 返回存储信息
+     */
+    function getItem(key: string): Promise<string>;
+    /**
+     * 设置存储信息
+     * @param key - 存储的键
+     * @param value - 存储的值
+     * @returns 调用结果
+     */
+    function setItem(key: string, value: string): Promise<void>;
+    /**
+     * 移除存储信息
+     * @param key - 存储的键
+     * @returns 调用结果
+     */
+    function removeItem(key: string): Promise<void>;
+    /**
+     * 获取所有存储的键
+     * @returns 调用结果
+     */
+    function getKeys(): Promise<StorageKeys>;
+    /**
+     * 清理本地数据缓存。
+     */
+    function clearStorage(): Promise<void>;
+    /**
+     * 从本地缓存中异步获取指定 key 的内容
+     * @param params - 传入参数
+     */
+    function getStorage(params: GetStorageReq): Promise<StorageRsp>;
+    /**
+     * 异步获取当前storage的相关信息。
+     */
+    function getStorageInfo(): Promise<GetSorageInfoRsp>;
+    /**
+     * 从本地缓存中移除指定 key
+     * @param params - 传入参数
+     */
+    function removeStorage(params: RemoveStorageReq): void;
+    /**
+     * 将数据存储在本地缓存中指定的 key 中, 会覆盖掉原来该 key 对应的内容
+     * @param params - 传入参数
+     */
+    function setStorage(params: SetStorageReq): Promise<void>;
+}
+
+/**
+ * @property data - 需要存储的内容。只支持原生类型、Date、及能够通过JSON.stringify序列化的对象
+ */
+type StorageRsp = {
+    data: any;
+};
+
+/**
+ * @property key - 本地缓存中指定的 key
+ * @property encrypt - 是否开启加密存储，默认为false
+ */
+type GetStorageReq = {
+    key: string;
+    encrypt: boolean;
+};
+
+/**
+ * @property keys - 当前 storage 中所有的 key
+ * @property currentSize - 是否开启加密存储，默认为false
+ * @property limitSize - 限制的空间大小，单位 KB
+ */
+type GetSorageInfoRsp = {
+    keys: string[];
+    currentSize: number;
+    limitSize: number;
+};
+
+/**
+ * @property key - 本地缓存中指定的 key
+ */
+type RemoveStorageReq = {
+    key: string;
+};
+
+/**
+ * @property key - 本地缓存中指定的 key
+ * @property data - 需要存储的内容。只支持原生类型、Date、及能够通过JSON.stringify序列化的对象
+ * @property encrypt - 是否开启加密存储，默认为false
+ */
+type SetStorageReq = {
+    key: string;
+    data: any;
+    encrypt: boolean;
+};
+
 /**
  * 流模块
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hyext/types-ext-sdk-hy",
-  "version": "4.1.3-beta.7",
+  "version": "4.2.0-beta.1",
   "description": "TypeScript definitions for sdk",
   "types": "./index.d.ts",
   "main": "",