@scgczm/bridge 1.0.0

package/README.md

@@ -0,0 +1,77 @@
+# app jsbridge
+
+## 支持 cjs、esm、umd 引入
+
+### esm 用法(cjs 同理)
+
+#### 1、安装
+
+```shell
+npm i @scgczm/bridge
+```
+
+#### 2、使用
+
+```ts
+import { scgcLogin } from "@scgczm/bridge";
+scgcLogin();
+```
+
+### umd 用法
+
+#### 1、引入
+
+```html
+<script src="https://kscgc.sctv.com/sctv/dependencies/bridge/scgc_bridge.min.js"></script>
+```
+
+#### 2、使用
+
+```js
+window.scgcBridge.scgcLogin();
+```
+
+### bridge 方法列表
+
+#### 1、同步方法
+
+- scgcGetSlideData
+- scgcLogin
+- scgcScan
+- scgcClose
+- scgcOpenwechat
+- scgcSaveimage
+- scgcShare
+- scgcToH5
+- scgcToDetail
+- scgcSetVolume
+- scgcToSubSpecial
+- scgcFocusWeb
+- scgcToMall
+- scgcToKuaipai
+- scgcToAppHome
+- scgcChangeStateBarColor
+- scgcToLive
+- scgcToSpecial
+- scgcToTopic
+
+#### 2、异步方法
+
+- scgcGetUserId
+- scgcGetAvatar
+- scgcGetNickName
+
+### 工具方法
+
+- isScgcApp
+
+### 开发模式
+
+#### eg.
+
+```ts
+import { setDevMode } from "@scgczm/bridge";
+setDevMode();
+```
+
+##### 控制台会打印调用的参数等数据(建议使用 vconsole 查看)

package/dist/cjs/index.d.ts

@@ -0,0 +1,210 @@
+import { ICommonResult } from "./utils";
+export interface IGetSlideDataData {
+    token: string;
+    sessionId: string;
+    sig: string;
+    scene: string;
+}
+/**
+ * @description 阿里滑动验证（使用的旧版api，目前官方文档已散佚,可参考其他项目）
+ * @param {IGetSlideDataData} data
+ */
+export declare const scgcGetSlideData: (data: IGetSlideDataData) => void;
+/**
+ * @description 调用app登录
+ */
+export declare const scgcLogin: () => void;
+/**
+ * @description 调用app扫码
+ */
+export declare const scgcScan: () => void;
+/**
+ * @description 关闭当前webview
+ */
+export declare const scgcClose: () => void;
+export interface IOpenexplorerData {
+    path: string;
+}
+/**
+ * @description 使用系统浏览器打开指定的url
+ * @param {IOpenexplorerData} data
+ * @param {string} data.path 需要打开的url
+ */
+export declare const scgcOpenexplorer: (data: IOpenexplorerData) => void;
+export interface IOpenwechatData {
+    appid: string;
+    path: string;
+}
+/**
+ * @description 打开微信小程序
+ * @param {IOpenwechatData} data
+ * @param {string} data.appid 小程序appid，格式为gh开头
+ * @param {string} data.path 小程序路径
+ */
+export declare const scgcOpenwechat: (data: IOpenwechatData) => void;
+export interface ISaveimageData {
+    data: string;
+}
+/**
+ * @description 保存图片
+ * @param {ISaveimageData} data
+ * @param {string} data.data base64数据
+ */
+export declare const scgcSaveimage: (data: ISaveimageData) => void;
+export interface IShareData {
+    shareUrl?: string;
+    shareImg?: string;
+    shareTitle?: string;
+    shareDesc?: string;
+    doShare?: boolean;
+}
+/**
+ * @description 配置app分享
+ * @param {IShareData} data
+ * @param {string} data.shareUrl 需要分享的地址
+ * @param {string} data.shareImg 分享的封面
+ * @param {string} data.shareTitle 分享的标题
+ * @param {string} data.shareDesc 分享的说明
+ * @param {boolean} data.doShare 是否在调用bridge时立即触发app的分享，默认为仅修改配置
+ */
+export declare const scgcShare: (data: IShareData) => void;
+export interface ItoH5Data {
+    path: string;
+}
+/**
+ * @description 打开一个webview
+ * @param {ItoH5Data} data
+ * @param {string} data.path 需要打开的url
+ */
+export declare const scgcToH5: (data: ItoH5Data) => void;
+export interface IToDetailData {
+    path: string;
+    newsType?: number;
+}
+/**
+ * @description 打开app原生新闻页
+ * @param {IToDetailData} data
+ * @param {string} data.path 新闻json地址 --相对地址，没有域名前缀的形式
+ * @param {number} data.newsType 新闻类型 --1.图文 2.音频 3.视频 4.纯视频新闻 6 外链
+ */
+export declare const scgcToDetail: (data: IToDetailData) => void;
+export interface IToSpecialData {
+    id: string;
+}
+/**
+ * @description 打开app原生专题详情页
+ * @param {IToSpecialData} data
+ * @param {string} data.id 专题id
+ */
+export declare const scgcToSpecial: (data: IToSpecialData) => void;
+export interface IToLiveData {
+    id: string;
+    type: 1 | 2;
+}
+/**
+ * @description 打开app原生直播页
+ * @param {IToLiveData} data
+ * @param {string} data.id 直播id
+ * @param {string} data.type 直播样式 1 横版 2 竖版
+ */
+export declare const scgcToLive: (data: IToLiveData) => void;
+export interface IToTopicData {
+    name: string;
+    cover: string;
+    id: string;
+}
+/**
+ * @description 打开app话题页
+ * @param {IToTopicData} data
+ * @param {string} data.name 话题名称
+ * @param {string} data.cover 话题封面图(完整的图片地址)
+ * @param {string} data.id 话题id
+ */
+export declare const scgcToTopic: (data: IToTopicData) => void;
+export interface ISetVolumeData {
+    type: 0 | 1;
+}
+/**
+ * @description 设置app音量
+ * @param {ISetVolumeData} data
+ * @param {number} data.type 0 调小 1 调大
+ */
+export declare const scgcSetVolume: (data: ISetVolumeData) => void;
+export interface IToSubSpecialData {
+    title: string;
+    id: string;
+}
+/**
+ * @description 打开app原生专题新闻列表页
+ * @param {IToSubSpecialData} data
+ * @param {string} data.title 专题标题
+ * @param {string} data.id 专题id
+ */
+export declare const scgcToSubSpecial: (data: IToSubSpecialData) => void;
+export interface IMallDetailData {
+    json: string;
+    url: string;
+    ptype: "0";
+    isDark: 0 | 1;
+}
+/**
+ * @description 打开积分商城商品详情
+ * @param {IMallDetailData} data
+ * @param {string} data.json 商品详情json地址
+ * @param {string} data.url 商品详情网页地址
+ * @param {string} data.ptype todo 未知
+ * @param {number} data.isDark 0 普通模式 1 黑暗模式
+ */
+export declare const scgcToMallDetail: (data: IMallDetailData) => void;
+export interface IFocusWebData {
+    focus: boolean;
+}
+/**
+ * @description 是否禁用app左右滑动（主要用户嵌入在app首页的swiper，避免滑动swiper的情况下，会滑动app首页的tab页）
+ * @param {IMallDetailData} data
+ * @param {boolean} data.focus 是否禁止app滑动
+ *
+ */
+export declare const scgcFocusWeb: (data: IFocusWebData) => void;
+/**
+ * @description 跳转至积分商城
+ */
+export declare const scgcToMall: () => void;
+/**
+ * @description 跳转至快拍
+ */
+export declare const scgcToKuaipai: () => void;
+/**
+ * @description 跳转至app首页
+ */
+export declare const scgcToAppHome: () => void;
+export interface IChangeStateBarColorData {
+    type: 1 | 2;
+}
+/**
+ * @description 设置app顶部时间栏颜色
+ * @param {IChangeStateBarColorData} data
+ * @param {number} data.type  1 黑色 2 白色
+ *
+ */
+export declare const scgcChangeStateBarColor: (data: IChangeStateBarColorData) => void;
+/**
+ * @description 获取app 用户id
+ * @return {Promise((success:boolean,data:string))} 返回promise
+ *
+ */
+export declare const scgcGetUserId: () => Promise<ICommonResult<string>>;
+/**
+ * @description 获取app 用户头像
+ * @return {Promise((success:boolean,data:string))} 返回promise
+ *
+ */
+export declare const scgcGetAvatar: () => Promise<ICommonResult<string>>;
+/**
+ * @description 获取app 用户昵称
+ * @return {Promise((success:boolean,data:string))} 返回promise
+ *
+ */
+export declare const scgcGetNickName: () => Promise<ICommonResult<string>>;
+export declare const scgcGetPhoneNumber: () => Promise<ICommonResult<string>>;
+export { setDevMode, isScgcApp } from "./utils";

package/dist/cjs/index.js

@@ -0,0 +1,245 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isScgcApp = exports.setDevMode = exports.scgcGetPhoneNumber = exports.scgcGetNickName = exports.scgcGetAvatar = exports.scgcGetUserId = exports.scgcChangeStateBarColor = exports.scgcToAppHome = exports.scgcToKuaipai = exports.scgcToMall = exports.scgcFocusWeb = exports.scgcToMallDetail = exports.scgcToSubSpecial = exports.scgcSetVolume = exports.scgcToTopic = exports.scgcToLive = exports.scgcToSpecial = exports.scgcToDetail = exports.scgcToH5 = exports.scgcShare = exports.scgcSaveimage = exports.scgcOpenwechat = exports.scgcOpenexplorer = exports.scgcClose = exports.scgcScan = exports.scgcLogin = exports.scgcGetSlideData = void 0;
+/*#__PURE__*/
+var utils_1 = require("./utils");
+(0, utils_1.initAsyncCallbackPool)();
+var commonBridge = (0, utils_1.commonBridgeFun)();
+/**
+ * @description 阿里滑动验证（使用的旧版api，目前官方文档已散佚,可参考其他项目）
+ * @param {IGetSlideDataData} data
+ */
+var scgcGetSlideData = function (data) {
+    commonBridge("getSlideData", data);
+};
+exports.scgcGetSlideData = scgcGetSlideData;
+/**
+ * @description 调用app登录
+ */
+var scgcLogin = function () {
+    commonBridge("login");
+};
+exports.scgcLogin = scgcLogin;
+/**
+ * @description 调用app扫码
+ */
+var scgcScan = function () {
+    commonBridge("scan");
+};
+exports.scgcScan = scgcScan;
+/**
+ * @description 关闭当前webview
+ */
+var scgcClose = function () {
+    commonBridge("close");
+};
+exports.scgcClose = scgcClose;
+/**
+ * @description 使用系统浏览器打开指定的url
+ * @param {IOpenexplorerData} data
+ * @param {string} data.path 需要打开的url
+ */
+var scgcOpenexplorer = function (data) {
+    commonBridge("openexplorer", data);
+};
+exports.scgcOpenexplorer = scgcOpenexplorer;
+/**
+ * @description 打开微信小程序
+ * @param {IOpenwechatData} data
+ * @param {string} data.appid 小程序appid，格式为gh开头
+ * @param {string} data.path 小程序路径
+ */
+var scgcOpenwechat = function (data) {
+    commonBridge("openwechat", data);
+};
+exports.scgcOpenwechat = scgcOpenwechat;
+/**
+ * @description 保存图片
+ * @param {ISaveimageData} data
+ * @param {string} data.data base64数据
+ */
+var scgcSaveimage = function (data) {
+    commonBridge("saveimage", data);
+};
+exports.scgcSaveimage = scgcSaveimage;
+/**
+ * @description 配置app分享
+ * @param {IShareData} data
+ * @param {string} data.shareUrl 需要分享的地址
+ * @param {string} data.shareImg 分享的封面
+ * @param {string} data.shareTitle 分享的标题
+ * @param {string} data.shareDesc 分享的说明
+ * @param {boolean} data.doShare 是否在调用bridge时立即触发app的分享，默认为仅修改配置
+ */
+var scgcShare = function (data) {
+    commonBridge("share", data);
+};
+exports.scgcShare = scgcShare;
+/**
+ * @description 打开一个webview
+ * @param {ItoH5Data} data
+ * @param {string} data.path 需要打开的url
+ */
+var scgcToH5 = function (data) {
+    commonBridge("toH5", data);
+};
+exports.scgcToH5 = scgcToH5;
+/**
+ * @description 打开app原生新闻页
+ * @param {IToDetailData} data
+ * @param {string} data.path 新闻json地址 --相对地址，没有域名前缀的形式
+ * @param {number} data.newsType 新闻类型 --1.图文 2.音频 3.视频 4.纯视频新闻 6 外链
+ */
+var scgcToDetail = function (data) {
+    commonBridge("toDetail", data);
+};
+exports.scgcToDetail = scgcToDetail;
+/**
+ * @description 打开app原生专题详情页
+ * @param {IToSpecialData} data
+ * @param {string} data.id 专题id
+ */
+var scgcToSpecial = function (data) {
+    commonBridge("toSpecial", data);
+};
+exports.scgcToSpecial = scgcToSpecial;
+/**
+ * @description 打开app原生直播页
+ * @param {IToLiveData} data
+ * @param {string} data.id 直播id
+ * @param {string} data.type 直播样式 1 横版 2 竖版
+ */
+var scgcToLive = function (data) {
+    commonBridge("toLive", data);
+};
+exports.scgcToLive = scgcToLive;
+/**
+ * @description 打开app话题页
+ * @param {IToTopicData} data
+ * @param {string} data.name 话题名称
+ * @param {string} data.cover 话题封面图(完整的图片地址)
+ * @param {string} data.id 话题id
+ */
+var scgcToTopic = function (data) {
+    commonBridge("toTopic", data);
+};
+exports.scgcToTopic = scgcToTopic;
+/**
+ * @description 设置app音量
+ * @param {ISetVolumeData} data
+ * @param {number} data.type 0 调小 1 调大
+ */
+var scgcSetVolume = function (data) {
+    commonBridge("setVolume", data);
+};
+exports.scgcSetVolume = scgcSetVolume;
+/**
+ * @description 打开app原生专题新闻列表页
+ * @param {IToSubSpecialData} data
+ * @param {string} data.title 专题标题
+ * @param {string} data.id 专题id
+ */
+var scgcToSubSpecial = function (data) {
+    commonBridge("toSubSpecial", data);
+};
+exports.scgcToSubSpecial = scgcToSubSpecial;
+/**
+ * @description 打开积分商城商品详情
+ * @param {IMallDetailData} data
+ * @param {string} data.json 商品详情json地址
+ * @param {string} data.url 商品详情网页地址
+ * @param {string} data.ptype todo 未知
+ * @param {number} data.isDark 0 普通模式 1 黑暗模式
+ */
+var scgcToMallDetail = function (data) {
+    commonBridge("detailJson", data);
+};
+exports.scgcToMallDetail = scgcToMallDetail;
+/**
+ * @description 是否禁用app左右滑动（主要用户嵌入在app首页的swiper，避免滑动swiper的情况下，会滑动app首页的tab页）
+ * @param {IMallDetailData} data
+ * @param {boolean} data.focus 是否禁止app滑动
+ *
+ */
+var scgcFocusWeb = function (data) {
+    commonBridge("focusWeb", data);
+};
+exports.scgcFocusWeb = scgcFocusWeb;
+/**
+ * @description 跳转至积分商城
+ */
+var scgcToMall = function () {
+    commonBridge("mall");
+};
+exports.scgcToMall = scgcToMall;
+/**
+ * @description 跳转至快拍
+ */
+var scgcToKuaipai = function () {
+    commonBridge("release");
+};
+exports.scgcToKuaipai = scgcToKuaipai;
+/**
+ * @description 跳转至app首页
+ */
+var scgcToAppHome = function () {
+    commonBridge("mainPage");
+};
+exports.scgcToAppHome = scgcToAppHome;
+/**
+ * @description 设置app顶部时间栏颜色
+ * @param {IChangeStateBarColorData} data
+ * @param {number} data.type  1 黑色 2 白色
+ *
+ */
+var scgcChangeStateBarColor = function (data) {
+    commonBridge("changeStatebarColor", data);
+};
+exports.scgcChangeStateBarColor = scgcChangeStateBarColor;
+/**
+ * @description 获取app 用户id
+ * @return {Promise((success:boolean,data:string))} 返回promise
+ *
+ */
+var scgcGetUserId = function () {
+    return commonBridge("getUserId");
+};
+exports.scgcGetUserId = scgcGetUserId;
+/**
+ * @description 获取app 用户头像
+ * @return {Promise((success:boolean,data:string))} 返回promise
+ *
+ */
+var scgcGetAvatar = function () {
+    return commonBridge("getAvatar");
+};
+exports.scgcGetAvatar = scgcGetAvatar;
+/**
+ * @description 获取app 用户昵称
+ * @return {Promise((success:boolean,data:string))} 返回promise
+ *
+ */
+var scgcGetNickName = function () {
+    return commonBridge("getNickName");
+};
+exports.scgcGetNickName = scgcGetNickName;
+// /**
+//  * @description 获取app 用户手机号
+//  * @return {Promise((success:boolean,data:string))} 返回promise
+//  *
+//  */
+var scgcGetPhoneNumber = function () {
+    return commonBridge("getPhoneNumber");
+};
+exports.scgcGetPhoneNumber = scgcGetPhoneNumber;
+// /**
+//  * @description 获取app token --暂不可用
+//  * @return {Promise((success:boolean,data:string))} 返回promise,暂时不会有进catch的情况
+//  *
+//  */
+// export const scgcGetToken = () => {
+//   return commonBridge("getToken");
+// };
+var utils_2 = require("./utils");
+Object.defineProperty(exports, "setDevMode", { enumerable: true, get: function () { return utils_2.setDevMode; } });
+Object.defineProperty(exports, "isScgcApp", { enumerable: true, get: function () { return utils_2.isScgcApp; } });

package/dist/cjs/utils.d.ts

@@ -0,0 +1,17 @@
+export interface ICommonResult<T> {
+    success: boolean;
+    data: T;
+}
+type TSyncFuns = "getSlideData" | "login" | "scan" | "close" | "openexplorer" | "openwechat" | "saveimage" | "share" | "toH5" | "toDetail" | "toLive" | "toTopic" | "setVolume" | "toSubSpecial" | "detailJson" | "focusWeb" | "mall" | "mainPage" | "changeStatebarColor" | "release" | "toSpecial";
+type TAsyncFuns = "getToken" | "getUserId" | "getNickName" | "getAvatar" | "getPhoneNumber" | "getPromise";
+export declare const setDevMode: () => void;
+export declare const initAsyncCallbackPool: () => void;
+declare function androidBridgeFn(fnName: TSyncFuns, data?: Record<string, any>): void;
+declare function androidBridgeFn(fnName: TAsyncFuns, data?: Record<string, any>): Promise<any>;
+export declare const commonBridgeFun: () => typeof androidBridgeFn;
+/**
+ * @description 是否为app环境
+ * @return  {boolean} true 是 false 否
+ */
+export declare const isScgcApp: () => boolean;
+export {};