@kbapp/js-bridge 0.4.8-alpha.0 → 1.0.0-alpha.0

package/dist/lib/app-version-support.d.ts

@@ -0,0 +1,41 @@
+import { BridgeCode } from './bridge-code';
+
+/**
+ *
+ * @description 判断当前版本号是否 大于等于 minVersion
+ * @example
+ * **示例代码**
+```js
+import { isAppVersionSupport } from '@kbapp/market-partner-sdk';
+
+isAppVersionSupport({
+    minVersion: 80711,
+    success(result: boolean) {
+        console.log('是否能使用', result)
+    }
+})
+```
+ */
+export declare const isAppVersionSupport: (params: {
+    minVersion: number;
+} & {
+    success?: ((res: boolean) => void) | undefined;
+    fail?: (error: BridgeCode) => void;
+    complete?: () => void;
+}) => Promise<boolean>;
+/**
+ *
+ * @description 装饰器. 检查app版本是否支持某个api, 如果不支持, 则抛出错误
+ * @example
+ * **示例代码**
+```js
+import { decorateAppVersionSupport } from '@kbapp/market-partner-sdk';
+
+const onTapLogin = decorateAppVersionSupport({ minVersion: 80711 }, () => {
+    console.log('当前版本号大于80711')
+})
+```
+ */
+export declare function decorateAppVersionSupport<Callback extends (...params: any[]) => any>(config: {
+    minVersion: number;
+}, callback: Callback): (...params: Parameters<Callback>) => Promise<any>;

package/dist/lib/bridge-code.d.ts

@@ -0,0 +1,14 @@
+export declare class BridgeCode {
+    /** 错误码 */
+    errorCode: number;
+    /** 错误信息 */
+    errorMsg: string;
+    constructor(params: {
+        errorCode: number;
+        errorMsg: string;
+    });
+    static UNKNOWN: BridgeCode;
+    static UNSUPPORTED_VERSION: BridgeCode;
+    static TIMEOUT: BridgeCode;
+    static UNSUPPORTED_BRIDGE_ENV: BridgeCode;
+}

package/dist/lib/check-for-new-version.d.ts

@@ -1,14 +1,16 @@
 /**
  *
  * @description 检测是否有新版本可用, iOS无论是否有最新版本都直接跳转到应用商店, 安卓如果有新版, 则弹窗提示, 没有的话toast提示无新版本
- *
+ * 桥接type: 56
  * **示例代码**
 ```js
 import { checkForNewVersion } from '@kbapp/js-bridge';
 
-checkForNewVersion({
-    title: '开吧标题'
-})
+checkForNewVersion()
 ```
  */
-export declare function checkForNewVersion(): void;
+export declare const checkForNewVersion: (params?: {
+    success?: ((res: void) => void) | undefined;
+    fail?: (error: import('./bridge-code').BridgeCode) => void;
+    complete?: () => void;
+} | undefined) => Promise<void>;

package/dist/lib/close-webview.d.ts

@@ -1,7 +1,7 @@
 /**
  *
  * @description 关闭当前webview
- *
+ * 桥接type: -1
  * **示例代码**
 ```js
 import { closeWebView } from '@kbapp/js-bridge';
@@ -9,4 +9,8 @@ import { closeWebView } from '@kbapp/js-bridge';
 closeWebView()
 ```
  */
-export declare function closeWebView(): void;
+export declare const closeWebView: (params?: {
+    success?: ((res: void) => void) | undefined;
+    fail?: (error: import('./bridge-code').BridgeCode) => void;
+    complete?: () => void;
+} | undefined) => Promise<void>;

package/dist/lib/define-permission-usage.d.ts

@@ -14,6 +14,8 @@ declare enum PermissionUsage {
  *
  * @description 定义相关隐私政策文案, 用于网页授权相关权限时候, 提醒用户
  * @example ```js
+import { definePermissionUsage } from '@kbapp/js-bridge';
+
 definePermissionUsage({
     microphone: { description: '用于发帖上传音频' },
     location: { description: '获取你选择的位置信息，用于线下导航服务' },
@@ -21,7 +23,11 @@ definePermissionUsage({
 })
 ```
  */
-export declare function definePermissionUsage(config: Partial<Record<PermissionUsage, {
+export declare const definePermissionUsage: (params?: (Partial<Record<PermissionUsage, {
     description: string;
-}>>): void;
+}>> & {
+    success?: ((res: void) => void) | undefined;
+    fail?: (error: import('./bridge-code').BridgeCode) => void;
+    complete?: () => void;
+}) | undefined) => Promise<void>;
 export {};

package/dist/lib/generate-kb-sign.d.ts

@@ -1,9 +1,20 @@
 /**
  *
- * @description 生成kbSign
+ * @description 生成kbSign, 禁止传入kbKey
+ * 桥接type: 51
+ * @example **示例代码**
+```js
+import { generateKBSign } from '@kbapp/js-bridge';
+
+const kbSign = await generateKBSign()
+```
  */
 export declare const generateKBSign: (params: {
+    [key: string]: any;
     kbSignTime: number;
     kbSignType: number;
-    [key: string]: any;
+} & {
+    success?: ((res: string) => void) | undefined;
+    fail?: (error: import('./bridge-code').BridgeCode) => void;
+    complete?: () => void;
 }) => Promise<string>;

package/dist/lib/{get-device-info.d.ts → get-app-base-info.d.ts}

@@ -2,7 +2,7 @@
  *
  * @description app本地设备信息
  */
-export declare class AppDeviceInfo {
+export declare class AppBaseInfo {
     /** 例如iOS */
     do: string;
     /** 例如iPhone11,2 */
@@ -25,13 +25,20 @@ export declare class AppDeviceInfo {
 /**
  *
  * @description 获取设备信息
- *
- * **示例代码**
+ * 桥接type: 35
+ * @example **示例代码**
 ```js
-import { getDeviceInfo } from '@kbapp/js-bridge';
+import { getAppBaseInfo } from '@kbapp/js-bridge';
 
-const deviceInfo = await getDeviceInfo()
-deviceInfo.vcode
+getAppBaseInfo({
+    success(deviceInfo) {
+        console.log(deviceInfo)
+    }
+})
 ```
  */
-export declare const getDeviceInfo: () => Promise<AppDeviceInfo>;
+export declare const getAppBaseInfo: (params?: {
+    success?: ((res: AppBaseInfo) => void) | undefined;
+    fail?: (error: import('./bridge-code').BridgeCode) => void;
+    complete?: () => void;
+} | undefined) => Promise<AppBaseInfo>;

package/dist/lib/open-post-editor.d.ts

@@ -56,9 +56,32 @@ export declare function createPostEditorParams(params?: Partial<PostEditorParams
 };
 /**
  *
- * @description 唤起发帖器, 由于原生发帖器桥接参数存在一些小问题, 建议使用 createPostEditorParams 来构造参数
+ * @description 唤起app发帖器
+ * 桥接type: 13
  */
-export declare function openPostEditor(data?: {
+export declare const openPostEditor: (...args: [params?: {
+    success?: ((res: {
+        content: string;
+        /** 街道信息 */
+        street?: string;
+        /**  音频model */
+        audio?: unknown;
+        /** 视频model */
+        video?: unknown;
+        /** 媒资视频 */
+        mediaVideo?: {
+            mediaId: string;
+        };
+        images: {
+            url: string;
+            width: number;
+            height: number;
+        }[] | undefined;
+    }) => void) | undefined;
+    fail?: (error: import('./bridge-code').BridgeCode) => void;
+    complete?: () => void;
+} | undefined] | [params?: ({
+    [key: string]: any;
     /** 文本默认显示内容（placehold） */
     hint?: string;
     /** 默认初始化文案 */
@@ -89,8 +112,28 @@ export declare function openPostEditor(data?: {
     content_max_length?: number;
     /** 文本最小长度 */
     content_min_length?: number;
-    [key: string]: any;
-}): Promise<{
+} & {
+    success?: ((res: {
+        content: string;
+        /** 街道信息 */
+        street?: string;
+        /**  音频model */
+        audio?: unknown;
+        /** 视频model */
+        video?: unknown;
+        /** 媒资视频 */
+        mediaVideo?: {
+            mediaId: string;
+        };
+        images: {
+            url: string;
+            width: number;
+            height: number;
+        }[] | undefined;
+    }) => void) | undefined;
+    fail?: (error: import('./bridge-code').BridgeCode) => void;
+    complete?: () => void;
+}) | undefined]) => Promise<{
     content: string;
     /** 街道信息 */
     street?: string;

package/dist/lib/report-da-event.d.ts

@@ -0,0 +1,33 @@
+/**
+ *
+ * @description 上报数据埋点到个推
+ * 桥接type: 69
+ * @example **示例代码**
+```js
+import { reportDAEvent } from '@kbapp/js-bridge';
+
+reportDAEvent({
+    eventName: 'event_name',
+    eventParams: {
+        test_param: 'test_value',
+    },
+    success() {
+        console.log('上报成功')
+    },
+})
+```
+ */
+export declare const reportDAEvent: (params: {
+    /** 事件名 */
+    eventName: string;
+    /** 上报值 */
+    eventParams?: {
+        [key: string]: any;
+    };
+    /** 开始结束类型传递 */
+    eventType?: "Begin" | "End";
+} & {
+    success?: ((res: void) => void) | undefined;
+    fail?: (error: import('./bridge-code').BridgeCode) => void;
+    complete?: () => void;
+}) => Promise<void>;

package/dist/lib/run-action.d.ts

@@ -1,8 +1,8 @@
 /**
  *
- * @description app执行action
- *
- * **示例代码**
+ * @description 执行统一跳转页面标准
+ * 桥接type: 1001
+ * @example **示例代码**
 ```js
 import { runAction } from '@kbapp/js-bridge';
 
@@ -14,7 +14,11 @@ runAction({
 })
 ```
  */
-export declare function runAction(data: {
+export declare const runAction: (params: {
     action: string;
     actionParams?: Record<string, any>;
-}): void;
+} & {
+    success?: ((res: void) => void) | undefined;
+    fail?: (error: import('./bridge-code').BridgeCode) => void;
+    complete?: () => void;
+}) => Promise<void>;

package/dist/lib/save-image-to-local.d.ts

@@ -1,8 +1,8 @@
 /**
  *
- * @description 保存图片到本地. app版本要求6.90.11
- *
- * **示例代码**
+ * @description 保存图片到本地
+ * 桥接type: 62
+ * @example **示例代码**
 ```js
 import { saveImageToLocal } from '@kbapp/js-bridge';
 
@@ -12,7 +12,11 @@ saveImageToLocal({
 ```
  *
  */
-export declare const saveImageToLocal: (data: {
+export declare const saveImageToLocal: (params: {
     /** 图片url(仅支持网络地址) */
     imageUrl: string;
+} & {
+    success?: ((res: void) => void) | undefined;
+    fail?: (error: import('./bridge-code').BridgeCode) => void;
+    complete?: () => void;
 }) => Promise<void>;

package/dist/lib/save-video-to-local.d.ts

@@ -1,8 +1,8 @@
 /**
  *
  * @description 保存视频到本地. app版本要求6.90.11
- *
- * **示例代码**
+ * 桥接type: 63
+ * @example **示例代码**
 ```js
 import { saveVideoToLocal } from '@kbapp/js-bridge';
 
@@ -12,7 +12,11 @@ saveVideoToLocal({
 ```
  *
  */
-export declare const saveVideoToLocal: (data: {
+export declare const saveVideoToLocal: (params: {
     /** 视频url(仅支持网络地址) */
     videoUrl: string;
+} & {
+    success?: ((res: void) => void) | undefined;
+    fail?: (error: import('./bridge-code').BridgeCode) => void;
+    complete?: () => void;
 }) => Promise<void>;

package/dist/lib/scan-qr-code.d.ts

@@ -0,0 +1,23 @@
+/**
+ *
+ * @description 扫描二维码
+ * 桥接type: 26
+ * @example **示例代码**
+```js
+import { scanQRCode } from '@kbapp/js-bridge';
+
+scanQRCode({
+    success(result) {
+        console.log('扫描结果', result)
+    },
+    fail(error) {
+        console.log('扫描失败', error)
+    },
+})
+```
+ */
+export declare const scanQRCode: (params?: {
+    success?: ((res: string) => void) | undefined;
+    fail?: (error: import('./bridge-code').BridgeCode) => void;
+    complete?: () => void;
+} | undefined) => Promise<string>;

package/dist/lib/screen-orientation.d.ts

@@ -0,0 +1,13 @@
+/**
+ *
+ * @description 定义屏幕方向
+ * 桥接type: 71
+ */
+export declare const setScreenOrientation: (params: {
+    /** 屏幕方向. 0: 竖屏. 1: 横屏 */
+    orientation: 0 | 1;
+} & {
+    success?: ((res: void) => void) | undefined;
+    fail?: (error: import('./bridge-code').BridgeCode) => void;
+    complete?: () => void;
+}) => Promise<void>;

package/dist/lib/set-webview-title.d.ts

@@ -1,8 +1,8 @@
 /**
  *
  * @description 设置网页标题(建议通过document.title设置), app版本要求6.90.11
- *
- * **示例代码**
+ * 桥接type: 64
+ * @example **示例代码**
 ```js
 import { setWebViewTitle } from '@kbapp/js-bridge';
 
@@ -11,7 +11,11 @@ setWebViewTitle({
 })
 ```
  */
-export declare const setWebViewTitle: (data: {
+export declare const setWebViewTitle: (params: {
     /** 网页标题 */
     title: string;
+} & {
+    success?: ((res: void) => void) | undefined;
+    fail?: (error: import('./bridge-code').BridgeCode) => void;
+    complete?: () => void;
 }) => Promise<void>;

package/dist/lib/share-image.d.ts

@@ -0,0 +1,21 @@
+/**
+ *
+ * @description 分享图片 app版本要求6.90.11
+ * 桥接type: 58
+ * **示例代码**
+```js
+import { shareImage } from '@kbapp/js-bridge';
+
+shareImage({
+    imageUrl: 'https://static.kaiba315.com.cn/kaiba-logo.png'
+})
+```
+ */
+export declare const shareImage: (params: {
+    /** 图片(仅支持网络地址,jpg/png) */
+    imageUrl: string;
+} & {
+    success?: ((res: void) => void) | undefined;
+    fail?: (error: import('./bridge-code').BridgeCode) => void;
+    complete?: () => void;
+}) => Promise<void>;