@ftvs/jssdk 1.2.0 → 1.3.0

package/lib/index.d.ts

@@ -77,7 +77,7 @@ declare function chooseImage(): Promise<ChooseImageResult>;
  * @category 路由
  * @example
  * ```javascript
- * await ftv.closeWebview();
+ * await ftv.closeWebView();
  * ```
  */
 declare function closeWebView(): Promise<void>;
@@ -105,12 +105,6 @@ interface ConfigPayload {
      * 服务端分配的 AppSecret。
      */
     appSecret: string;
-    /**
-     * 是否启用埋点工具。
-     *
-     * @default false
-     */
-    track?: boolean | string | TrackOptions;
     /**
      * 是否开启 debug 模式。
      *
@@ -129,7 +123,6 @@ interface ConfigPayload {
  * await ftv.config({
  *   appId: 'xxxx',
  *   appSecret: 'xxxxxx',
- *   track: true,
  *   debug: process.env.NODE_ENV === 'development',
  * });
  * ```
@@ -215,6 +208,26 @@ interface GetAuthCodeResult {
  */
 declare function getAuthCode(payload: GetAuthCodePayload): Promise<GetAuthCodeResult>;
 
+interface GetTokenResult {
+    /**
+     * 令牌,返回空字符串表示没有登录
+     */
+    token: string;
+}
+/**
+ * 获取token令牌
+ * @category 开放接口 > 用户信息
+ * @example
+ * ```javascript
+ * const res = await ftv.getAuthToken();
+ * // 结果类似：
+ * // {
+ * //   token: 'xxxxxxxxxxxxxxxxxx'
+ * // }
+ * ```
+ */
+declare function getAuthToken(): Promise<GetTokenResult>;
+
 interface Environment {
     /**
      * 是否在未来电视客户端中。
@@ -283,26 +296,6 @@ declare function getEnvSync(): Environment;
  */
 declare function getEnv(): Promise<Environment>;
 
-interface GetTokenResult {
-    /**
-     * 令牌,返回空字符串表示没有登录
-     */
-    token: string;
-}
-/**
- * 获取token令牌
- * @category 开放接口 > 用户信息
- * @example
- * ```javascript
- * const res = await ftv.getAuthToken();
- * // 结果类似：
- * // {
- * //   token: 'xxxxxxxxxxxxxxxxxx'
- * // }
- * ```
- */
-declare function getAuthToken(): Promise<GetTokenResult>;
-
 declare type OneData<T> = {
     [K in keyof T]: any;
 };
@@ -438,6 +431,25 @@ interface RequestFaceAuthenticationResult {
  */
 declare function requestFaceAuthentication(payload: RequestFaceAuthenticationPayload): Promise<RequestFaceAuthenticationResult>;
 
+interface ReturnToControlPayload {
+    /**
+     * 是否管控
+     */
+    hijack: boolean;
+}
+/**
+ * 路由权限管控。
+ *
+ * @category 路由
+ * @example
+ * ```javascript
+ * await ftv.returnToControl({
+ *   hijack: true
+ * });
+ * ```
+ */
+declare function returnToControl(payload: ReturnToControlPayload): Promise<void>;
+
 interface SelectFamilyResult {
     /**
      * 打开状态
@@ -484,11 +496,11 @@ declare const _ftv_defaultAddress: typeof defaultAddress;
 type _ftv_GetAuthCodePayload = GetAuthCodePayload;
 type _ftv_GetAuthCodeResult = GetAuthCodeResult;
 declare const _ftv_getAuthCode: typeof getAuthCode;
+type _ftv_GetTokenResult = GetTokenResult;
+declare const _ftv_getAuthToken: typeof getAuthToken;
 declare const _ftv_getEnv: typeof getEnv;
 type _ftv_Environment = Environment;
 declare const _ftv_getEnvSync: typeof getEnvSync;
-type _ftv_GetTokenResult = GetTokenResult;
-declare const _ftv_getAuthToken: typeof getAuthToken;
 type _ftv_GetUserInfoPayload = GetUserInfoPayload;
 type _ftv_GetUserInfoResult = GetUserInfoResult;
 declare const _ftv_getUserInfo: typeof getUserInfo;
@@ -498,6 +510,8 @@ declare const _ftv_navigateTo: typeof navigateTo;
 type _ftv_RequestFaceAuthenticationPayload = RequestFaceAuthenticationPayload;
 type _ftv_RequestFaceAuthenticationResult = RequestFaceAuthenticationResult;
 declare const _ftv_requestFaceAuthentication: typeof requestFaceAuthentication;
+type _ftv_ReturnToControlPayload = ReturnToControlPayload;
+declare const _ftv_returnToControl: typeof returnToControl;
 type _ftv_SelectFamilyResult = SelectFamilyResult;
 declare const _ftv_selectFamily: typeof selectFamily;
 declare namespace _ftv {
@@ -515,11 +529,11 @@ declare namespace _ftv {
     _ftv_GetAuthCodePayload as GetAuthCodePayload,
     _ftv_GetAuthCodeResult as GetAuthCodeResult,
     _ftv_getAuthCode as getAuthCode,
+    _ftv_GetTokenResult as GetTokenResult,
+    _ftv_getAuthToken as getAuthToken,
     _ftv_getEnv as getEnv,
     _ftv_Environment as Environment,
     _ftv_getEnvSync as getEnvSync,
-    _ftv_GetTokenResult as GetTokenResult,
-    _ftv_getAuthToken as getAuthToken,
     _ftv_GetUserInfoPayload as GetUserInfoPayload,
     _ftv_GetUserInfoResult as GetUserInfoResult,
     _ftv_getUserInfo as getUserInfo,
@@ -529,6 +543,8 @@ declare namespace _ftv {
     _ftv_RequestFaceAuthenticationPayload as RequestFaceAuthenticationPayload,
     _ftv_RequestFaceAuthenticationResult as RequestFaceAuthenticationResult,
     _ftv_requestFaceAuthentication as requestFaceAuthentication,
+    _ftv_ReturnToControlPayload as ReturnToControlPayload,
+    _ftv_returnToControl as returnToControl,
     _ftv_SelectFamilyResult as SelectFamilyResult,
     _ftv_selectFamily as selectFamily,
   };