@ftvs/jssdk 1.1.0 → 1.3.0

package/lib/index.d.ts

@@ -1,15 +1,86 @@
 declare function invokeNativeMethod<T>(methodName: string, args?: any): Promise<T>;
 
+interface AddressSelectionResult {
+    /**
+     * 省份名字
+     *
+     */
+    proName: string;
+    /**
+     * 省份code
+     *
+     */
+    proCode: string;
+    /**
+     * 城市名字
+     *
+     */
+    cityName: string;
+    /**
+     * 城市code
+     *
+     */
+    cityCode: string;
+    /**
+     * 区划名字
+     *
+     */
+    dirName: string;
+    /**
+     * 区划code
+     *
+     */
+    dirCode: string;
+}
+/**
+ * 客户端地址选择器。
+ * @category 开放接口 > 地址
+ * @example
+ * ```javascript
+ * const res = await ftv.addressSelection();
+ * // 结果类似：
+ * //{
+ * //"proCode":"520000",
+ * //"cityName":"贵阳市",
+ * //"cityCode":"520100",
+ * //"dirCode":"520115",
+ * //"proName":"贵州省",
+ * //"dirName":"观山湖区"
+ * //}
+ * ```
+ */
+declare function addressSelection(): Promise<AddressSelectionResult>;
+
+interface ChooseImageResult {
+    /**
+     * base64的图片资源字符串，需要在字符串前拼接`data:image/jpeg;base64,`
+     */
+    base64Image: string;
+}
+/**
+ * 拍摄照片
+ * @category 媒体 > 图片
+ * @example
+ * ```javascript
+ * const res = await ftv.chooseImage();
+ * // 结果类似：
+ * // {
+ * //   base64Image: '/9j/4AAQSkZJRgABAQAAAQABAAD/4QAwRXhpZgAATU0AKgAAAAgAAQExAAIAAAAOAAAAGgAAAAB3d3cubWVpdHUuY29tAP/bAEMAAwICAwICAwMDAwQDAwQFCAUFBAQFCgcHBggMCgwMCwoLCw0OEhANDhEOCwsQFhARExQVFRUMDxcYFhQYEhQVFP/bAEMBAwQEBQQFCQUFCRQNCw0UFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUF'
+ * // }
+ * ```
+ */
+declare function chooseImage(): Promise<ChooseImageResult>;
+
 /**
  * 关闭当前浏览器。
  *
  * @category 路由
  * @example
  * ```javascript
- * await ftv.closeWindow();
+ * await ftv.closeWebView();
  * ```
  */
-declare function closeWindow(): Promise<void>;
+declare function closeWebView(): Promise<void>;
 
 interface TrackOptions {
     /**
@@ -34,12 +105,6 @@ interface ConfigPayload {
      * 服务端分配的 AppSecret。
      */
     appSecret: string;
-    /**
-     * 是否启用埋点工具。
-     *
-     * @default false
-     */
-    track?: boolean | string | TrackOptions;
     /**
      * 是否开启 debug 模式。
      *
@@ -50,7 +115,7 @@ interface ConfigPayload {
     debug?: boolean;
 }
 /**
- * 注入权限验证配置。`appId`、`appSecret` 请通过钉钉向 `熊小川` 申请。
+ * 注入权限验证配置。`appId`、`appSecret` 请先申请。
  *
  * @category 基础
  * @example
@@ -58,13 +123,63 @@ interface ConfigPayload {
  * await ftv.config({
  *   appId: 'xxxx',
  *   appSecret: 'xxxxxx',
- *   track: true,
  *   debug: process.env.NODE_ENV === 'development',
  * });
  * ```
  */
 declare function config(payload: ConfigPayload): Promise<void>;
 
+interface DefaultAddressResult {
+    /**
+     * 省份名字
+     *
+     */
+    proName: string;
+    /**
+     * 省份code
+     *
+     */
+    proCode: string;
+    /**
+     * 城市名字
+     *
+     */
+    cityName: string;
+    /**
+     * 城市code
+     *
+     */
+    cityCode: string;
+    /**
+     * 区划名字
+     *
+     */
+    dirName: string;
+    /**
+     * 区划code
+     *
+     */
+    dirCode: string;
+}
+/**
+ * 获取默认区划地址。
+ * @category 开放接口 > 地址
+ * @example
+ * ```javascript
+ * const res = await ftv.defaultAddress();
+ * // 结果类似：
+ * //{
+ * //"proCode":"520000",
+ * //"cityName":"贵阳市",
+ * //"cityCode":"520100",
+ * //"dirCode":"520115",
+ * //"proName":"贵州省",
+ * //"dirName":"观山湖区"
+ * //}
+ * ```
+ */
+declare function defaultAddress(): Promise<DefaultAddressResult>;
+
 interface GetAuthCodePayload {
     /**
      * 应用id
@@ -93,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 {
     /**
      * 是否在未来电视客户端中。
@@ -171,9 +306,9 @@ interface GetUserInfoPayload {
      */
     authCode: string;
     /**
-     * 是否需要实名信息
+     * 是否需要敏感信息
      */
-    isAuth?: boolean;
+    withCredentials?: boolean;
 }
 interface GetUserInfoResult {
     /**
@@ -233,7 +368,6 @@ declare function getUserInfo(payload: GetUserInfoPayload): Promise<GetUserInfoRe
 /**
  * 客户端浏览器返回上一页，当浏览器栈无上一级时，关闭当前浏览器。
  *
- * @mp
  * @category 路由
  * @example
  * ```javascript
@@ -266,236 +400,55 @@ interface NavigateToPayLoad {
  */
 declare function navigateTo(payload: NavigateToPayLoad): Promise<void>;
 
-interface PlayVideoPayload {
-    /**
-     * 视频地址。
-     */
-    url: string;
-}
-/**
- * 播放视频。
- *
- * @category 媒体 > 视频
- * @example
- * ```javascript
- * await ftv.playVideo({
- *   url: 'https://dcb-cdn.oss-cn-beijing.aliyuncs.com/386fdc3e8a1cd6c5ea91e446d975e367.mp4',
- * });
- * ```
- */
-declare function playVideo(payload: PlayVideoPayload): Promise<void>;
-
-interface AddressAddPayload {
+interface RequestFaceAuthenticationPayload {
     /**
-     * 二级地级行政区(地级市、地区、自治州、盟)
-     *
+     * 内部认证`0` 属于多彩未来电视的服务使用
+     * 三方认证`1` 非多彩未来电视的服务使用
      */
-    city?: string;
+    authCheckType: '0' | '1';
     /**
-     * 三级县级行政区(市辖区、县级市、县、自治县、旗、自治旗、林区、特区)
-     *
-     */
-    county?: string;
-    /**
-     * 是否是默认地址
-     *
+     * 三方认证使用用户openId
      */
-    defaultFlag?: string;
-    /**
-     * 详情地址及门牌号
-     *
-     */
-    detail?: string;
-    /**
-     * 区划编码
-     *
-     */
-    districtCode?: string;
-    /**
-     * 地址Id,新增的时候不传，修改的时候必传
-     *
-     */
-    id?: string;
-    /**
-     * 手机号
-     *
-     */
-    phoneNo?: string;
-    /**
-     * 一级省级行政区(省、自治区、直辖市、特别行政区)
-     *
-     */
-    province?: string;
-    /**
-     * 收件人
-     *
-     */
-    receiver?: string;
+    openId?: string;
 }
-interface AddressAddResult {
+interface RequestFaceAuthenticationResult {
     /**
-     * 操作状态
-     *
+     * 包含认证信息的加密数据。根据需要直接传给后端即可。返回空字符串则是认证失败
      */
-    status: boolean;
+    encryptedData: string;
 }
 /**
- * 新增或修改地址。
- * @category 开放接口 > 地址
+ * 人脸认证
+ * @category 开放接口 > 授权
  * @example
  * ```javascript
- * const res = await ftv.addressAdd({{
- *   id: "",
- *  defaultFlag: "0",
- *  detail: "大DJ的",
- *  phoneNo: "14755555555",
- *  receiver: "李三",
- *  districtCode: "130102",
- *  province: "河北省",
- *  city: "石家庄市",
- *  county: "长安区"
- * });
+ * const res = await ftv.requestFaceAuthentication();
  * // 结果类似：
  * // {
- * // status: true
+ * //   encryptedData: '4088a70bc2ed4b0aac7a904aeaf3819e'
  * // }
  * ```
  */
-declare function addressAdd(payload: AddressAddPayload): Promise<AddressAddResult>;
-
-interface AddressListResult {
-    /**
-     * 地址数据Json
-     *
-     */
-    addressList: string[];
-}
-/**
- * 返回地址列表至少包含：姓名、电话、是否为默认、省市区名称和编码、详细地址。。
- * @category 开放接口 > 地址
- * @example
- * ```javascript
- * const res = await ftv.addressList();
- * // 结果类似：
- * //{addressList: "[{"city":"石家庄市",
- * //"cityCode":"130100",
- * //"county":"长安区",
- * //"dcbUserId":"bb5760886dcb9c1201asas",
- * //"defaultFlag":0,
- * //"detail":"大DJ的",
- * //"districtCode":"130102",
- * //"id":"8aaa8c387fd09607017fa55552",
- * //"phoneNo":"14755555555",
- * //"province":"河北省",
- * //"provinceCode":"130000",
- * //"receiver":"李三",
- * //"serviceFlag":1}]"
- * //}
- * ```
- */
-declare function addressList(): Promise<AddressListResult>;
-
-interface AddressSelectionResult {
-    /**
-     * 省份名字
-     *
-     */
-    proName: string;
-    /**
-     * 省份code
-     *
-     */
-    proCode: string;
-    /**
-     * 城市名字
-     *
-     */
-    cityName: string;
-    /**
-     * 城市code
-     *
-     */
-    cityCode: string;
-    /**
-     * 区划名字
-     *
-     */
-    dirName: string;
-    /**
-     * 区划code
-     *
-     */
-    dirCode: string;
-}
-/**
- * 客户端地址选择器。
- * @category 开放接口 > 地址
- * @example
- * ```javascript
- * const res = await ftv.addressSelection();
- * // 结果类似：
- * //{
- * //"proCode":"520000",
- * //"cityName":"贵阳市",
- * //"cityCode":"520100",
- * //"dirCode":"520115",
- * //"proName":"贵州省",
- * //"dirName":"观山湖区"
- * //}
- * ```
- */
-declare function addressSelection(): Promise<AddressSelectionResult>;
+declare function requestFaceAuthentication(payload: RequestFaceAuthenticationPayload): Promise<RequestFaceAuthenticationResult>;
 
-interface DefaultAddressResult {
-    /**
-     * 省份名字
-     *
-     */
-    proName: string;
-    /**
-     * 省份code
-     *
-     */
-    proCode: string;
-    /**
-     * 城市名字
-     *
-     */
-    cityName: string;
-    /**
-     * 城市code
-     *
-     */
-    cityCode: string;
-    /**
-     * 区划名字
-     *
-     */
-    dirName: string;
+interface ReturnToControlPayload {
     /**
-     * 区划code
-     *
+     * 是否管控
      */
-    dirCode: string;
+    hijack: boolean;
 }
 /**
- * 获取默认区划地址。
- * @category 开放接口 > 地址
+ * 路由权限管控。
+ *
+ * @category 路由
  * @example
  * ```javascript
- * const res = await ftv.defaultAddress();
- * // 结果类似：
- * //{
- * //"proCode":"520000",
- * //"cityName":"贵阳市",
- * //"cityCode":"520100",
- * //"dirCode":"520115",
- * //"proName":"贵州省",
- * //"dirName":"观山湖区"
- * //}
+ * await ftv.returnToControl({
+ *   hijack: true
+ * });
  * ```
  */
-declare function defaultAddress(): Promise<DefaultAddressResult>;
+declare function returnToControl(payload: ReturnToControlPayload): Promise<void>;
 
 interface SelectFamilyResult {
     /**
@@ -530,13 +483,21 @@ interface SelectFamilyResult {
  */
 declare function selectFamily(): Promise<SelectFamilyResult>;
 
-declare const _ftv_closeWindow: typeof closeWindow;
+type _ftv_AddressSelectionResult = AddressSelectionResult;
+declare const _ftv_addressSelection: typeof addressSelection;
+type _ftv_ChooseImageResult = ChooseImageResult;
+declare const _ftv_chooseImage: typeof chooseImage;
+declare const _ftv_closeWebView: typeof closeWebView;
 type _ftv_TrackOptions = TrackOptions;
 type _ftv_ConfigPayload = ConfigPayload;
 declare const _ftv_config: typeof config;
+type _ftv_DefaultAddressResult = DefaultAddressResult;
+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;
@@ -546,28 +507,30 @@ declare const _ftv_getUserInfo: typeof getUserInfo;
 declare const _ftv_navigateBack: typeof navigateBack;
 type _ftv_NavigateToPayLoad = NavigateToPayLoad;
 declare const _ftv_navigateTo: typeof navigateTo;
-type _ftv_PlayVideoPayload = PlayVideoPayload;
-declare const _ftv_playVideo: typeof playVideo;
-type _ftv_AddressAddPayload = AddressAddPayload;
-type _ftv_AddressAddResult = AddressAddResult;
-declare const _ftv_addressAdd: typeof addressAdd;
-type _ftv_AddressListResult = AddressListResult;
-declare const _ftv_addressList: typeof addressList;
-type _ftv_AddressSelectionResult = AddressSelectionResult;
-declare const _ftv_addressSelection: typeof addressSelection;
-type _ftv_DefaultAddressResult = DefaultAddressResult;
-declare const _ftv_defaultAddress: typeof defaultAddress;
+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 {
   export {
-    _ftv_closeWindow as closeWindow,
+    _ftv_AddressSelectionResult as AddressSelectionResult,
+    _ftv_addressSelection as addressSelection,
+    _ftv_ChooseImageResult as ChooseImageResult,
+    _ftv_chooseImage as chooseImage,
+    _ftv_closeWebView as closeWebView,
     _ftv_TrackOptions as TrackOptions,
     _ftv_ConfigPayload as ConfigPayload,
     _ftv_config as config,
+    _ftv_DefaultAddressResult as DefaultAddressResult,
+    _ftv_defaultAddress as defaultAddress,
     _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,
@@ -577,17 +540,11 @@ declare namespace _ftv {
     _ftv_navigateBack as navigateBack,
     _ftv_NavigateToPayLoad as NavigateToPayLoad,
     _ftv_navigateTo as navigateTo,
-    _ftv_PlayVideoPayload as PlayVideoPayload,
-    _ftv_playVideo as playVideo,
-    _ftv_AddressAddPayload as AddressAddPayload,
-    _ftv_AddressAddResult as AddressAddResult,
-    _ftv_addressAdd as addressAdd,
-    _ftv_AddressListResult as AddressListResult,
-    _ftv_addressList as addressList,
-    _ftv_AddressSelectionResult as AddressSelectionResult,
-    _ftv_addressSelection as addressSelection,
-    _ftv_DefaultAddressResult as DefaultAddressResult,
-    _ftv_defaultAddress as defaultAddress,
+    _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,
   };