@bi-nova/ui-weapp 1.2.0 → 1.2.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bi-nova/ui-weapp",
-  "version": "1.2.0",
+  "version": "1.2.1",
   "description": "BI Nova SDK WeChat Mini Program Components",
   "miniprogram": "src",
   "license": "ISC",

package/src/ad/README.md

@@ -42,6 +42,8 @@ yarn add @bi-nova/core @bi-nova/services @bi-nova/ui-weapp
 <bi-display-ad
   ad-id="ad_123456"
   type="banner"
+  equipment-value="{{equipmentValue}}"
+  user-id="{{userId}}"
   bind:load="handleAdLoad"
   bind:error="handleAdError"
   bind:close="handleAdClose"
@@ -56,16 +58,18 @@ yarn add @bi-nova/core @bi-nova/services @bi-nova/ui-weapp
 
 `bi-display-ad` 是广告组件的标准接入入口。业务侧仅需关注广告位 ID、广告类型和必要的展示控制参数。
 
-| 属性 | 类型 | 默认值 | 说明 |
-| --- | --- | --- | --- |
-| `ad-id` | `string` | `''` | 我方分配的广告位 ID。组件会根据该 ID 获取广告位配置并展示广告。 |
-| `type` | `'banner' \| 'splash'` | `'banner'` | 广告类型。仅支持 `banner` 和 `splash`。 |
-| `show` | `boolean` | `true` | 是否展示广告。对开屏广告的显隐控制更常用。 |
-| `z-index` | `number` | `999` | 开屏广告容器层级。 |
-| `picture-in-picture` | `boolean` | `false` | 开屏广告跳过后是否进入画中画状态。 |
-| `check-native-splash` | `boolean` | `true` | 开屏广告是否先检查微信系统开屏广告状态，设置为 `false` 可用于真机调试或强制展示远程开屏广告。 |
-| `native-splash-cache` | `boolean` | `true` | 是否缓存微信系统开屏广告承接记录，用于短时间内连续扫码时跳过残留的微信开屏状态检查。 |
-| `jump-seconds` | `number` | `5` | 开屏广告倒计时秒数。 |
+| 属性 | 类型 | 默认值 | 说明                                                          |
+| --- | --- | --- |-------------------------------------------------------------|
+| `ad-id` | `string` | `''` | 我方分配的广告位 ID。组件会根据该 ID 获取广告位配置并展示广告。                         |
+| `type` | `'banner' \| 'splash'` | `'banner'` | 广告类型。仅支持 `banner` 和 `splash`。                               |
+| `show` | `boolean` | `true` | 是否展示广告。对开屏广告的显隐控制更常用。                                       |
+| `z-index` | `number` | `999` | 开屏广告容器层级。                                                   |
+| `picture-in-picture` | `boolean` | `false` | 开屏广告跳过后是否进入画中画状态。                                           |
+| `check-native-splash` | `boolean` | `true` | 开屏广告是否先检查微信系统开屏广告状态，设置为 `false` 可用于真机调试或强制展示远程开屏广告。         |
+| `native-splash-cache` | `boolean` | `true` | 是否缓存微信系统开屏广告承接记录，用于短时间内连续扫码时跳过残留的微信开屏状态检查。                  |
+| `jump-seconds` | `number` | `5` | 开屏广告倒计时秒数。                                                  |
+| `equipment-value` | `string` | `''` | 对接方真实设备标识。自营广告跳转类型为动态获取时必填                                  |
+| `user-id` | `number` | `0` | 对接方真实用户 ID，必须传入正整数；默认值 `0` 仅表示未传入。自营广告跳转类型为动态获取时必填 |
 
 ## 广告位配置
 
@@ -150,6 +154,8 @@ getApp().globalData.biNova.clearToken()
 <bi-display-ad
   ad-id="launch_splash"
   type="splash"
+  equipment-value="{{equipmentValue}}"
+  user-id="{{userId}}"
   show="{{showSplash}}"
   z-index="{{999}}"
   picture-in-picture="{{true}}"
@@ -232,11 +238,13 @@ Page({
 | `BI_BANNER_CUSTOM_MEDIA_LOAD_FAIL` | Banner 自定义图片加载失败。 |
 | `BI_BANNER_NAVIGATE_MINI_PROGRAM_FAIL` | Banner 自定义广告跳转其他小程序失败。 |
 | `BI_BANNER_NAVIGATE_FAIL` | Banner 自定义广告跳转内部页面失败。 |
+| `BI_BANNER_API_REQUEST_FAIL` | Banner 接口型自营广告请求失败。 |
 | `BI_SPLASH_WECHAT_AD_LOAD_FAIL` | 微信开屏广告加载失败。 |
 | `BI_SPLASH_CUSTOM_MEDIA_LOAD_TIMEOUT` | 开屏自定义素材加载超时。 |
 | `BI_SPLASH_CUSTOM_MEDIA_LOAD_FAIL` | 开屏自定义素材加载失败。 |
 | `BI_SPLASH_NAVIGATE_MINI_PROGRAM_FAIL` | 开屏自定义广告跳转其他小程序失败。 |
 | `BI_SPLASH_NAVIGATE_FAIL` | 开屏自定义广告跳转内部页面失败。 |
+| `BI_SPLASH_API_REQUEST_FAIL` | 开屏接口型自营广告请求失败。 |
 
 自研素材加载失败或超时时，Banner 与开屏广告会额外返回以下统一字段：
 

package/src/ad/banner/index.js

@@ -3,7 +3,7 @@
  * @Author wutao
  * @Date 2026-04-10
  * @LastEditors wutao
- * @LastEditTime 2026-08-14 16:23:04
+ * @LastEditTime 2026-09-03 17:38:00
  */
 const {
   navigateCustomAd
@@ -14,7 +14,9 @@ Component({
     unitId: { type: String, value: '' },
     customAd: { type: Object, value: null },
     priority: { type: String, value: 'wechat-first' },
-    adIntervals: { type: Number, value: 30 }
+    adIntervals: { type: Number, value: 30 },
+    equipmentValue: { type: String, value: '' },
+    userId: { type: Number, value: 0 }
   },
   data: {
     isWechatAd: false,
@@ -514,7 +516,13 @@ Component({
         },
         resolveEventDetail: (provider, event, extraDetail) => this.resolveEventDetail(provider, event, extraDetail),
         miniProgramErrorCode: 'BI_BANNER_NAVIGATE_MINI_PROGRAM_FAIL',
-        navigateErrorCode: 'BI_BANNER_NAVIGATE_FAIL'
+        navigateErrorCode: 'BI_BANNER_NAVIGATE_FAIL',
+        apiRequestErrorCode: 'BI_BANNER_API_REQUEST_FAIL',
+        apiRequestParams: {
+          configId: this.properties.customAd && this.properties.customAd.configId,
+          equipmentValue: this.properties.equipmentValue,
+          userId: this.properties.userId
+        }
       })
     }
   }

package/src/ad/display/index.js

@@ -3,7 +3,7 @@
  * @Author wutao
  * @Date 2026-04-10
  * @LastEditors wutao
- * @LastEditTime 2026-08-13 11:28:34
+ * @LastEditTime 2026-09-03 18:00:19
  */
 const SUPPORTED_TYPES = ['banner', 'splash']
 /** 微信系统开屏广告承接记录的本地缓存键前缀，用于按 appId 和广告位隔离缓存 */
@@ -27,7 +27,9 @@ Component({
     pictureInPicture: { type: Boolean, value: false },
     checkNativeSplash: { type: Boolean, value: true },
     nativeSplashCache: { type: Boolean, value: true },
-    jumpSeconds: { type: Number, value: 5 }
+    jumpSeconds: { type: Number, value: 5 },
+    equipmentValue: { type: String, value: '' },
+    userId: { type: Number, value: 0 }
   },
   data: {
     resolvedType: 'banner',
@@ -64,7 +66,7 @@ Component({
         show: nextShow
       })
     },
-    'adId, adOptions, sdkKey, autoLoad'(nextAdId) {
+    'adId, adOptions, sdkKey, autoLoad, userId'(nextAdId) {
       this.syncNativeSplashCheck()
 
       if (!nextAdId) {
@@ -195,14 +197,22 @@ Component({
         ? this.properties.adOptions
         : {}
       const appId = this.getMiniProgramAppId()
-
-      return {
+      const userId = this.properties.userId
+      const requestOptions = {
         ...adOptions,
         adId: this.properties.adId,
         placementId: adOptions.placementId || this.properties.adId,
         appId: adOptions.appId || appId,
         type: this.data.resolvedType
       }
+
+      if (Number.isInteger(userId) && userId > 0) {
+        requestOptions.userId = userId
+      } else {
+        delete requestOptions.userId
+      }
+
+      return requestOptions
     },
 
     /**

package/src/ad/display/index.wxml

@@ -4,6 +4,8 @@
   unit-id="{{resolvedUnitId}}"
   custom-ad="{{resolvedCustomAd}}"
   priority="{{resolvedPriority}}"
+  equipment-value="{{equipmentValue}}"
+  user-id="{{userId}}"
   ad-intervals="{{adIntervals}}"
   bind:load="handleLoad"
   bind:error="handleError"
@@ -19,6 +21,8 @@
   unit-id="{{resolvedUnitId}}"
   custom-ad="{{resolvedCustomAd}}"
   priority="{{resolvedPriority}}"
+  equipment-value="{{equipmentValue}}"
+  user-id="{{userId}}"
   show="{{resolvedShow}}"
   z-index="{{zIndex}}"
   picture-in-picture="{{pictureInPicture}}"

package/src/ad/splash/index.js

@@ -3,7 +3,7 @@
  * @Author wutao
  * @Date 2026-04-10
  * @LastEditors wutao
- * @LastEditTime 2026-08-18 11:38:13
+ * @LastEditTime 2026-09-03 17:38:00
  */
 const {
   navigateCustomAd
@@ -18,7 +18,9 @@ Component({
     zIndex: { type: Number, value: 999 },
     pictureInPicture: { type: Boolean, value: false },
     checkNativeSplash: { type: Boolean, value: true },
-    jumpSeconds: { type: Number, value: 5 }
+    jumpSeconds: { type: Number, value: 5 },
+    equipmentValue: { type: String, value: '' },
+    userId: { type: Number, value: 0 }
   },
   data: {
     isWechatAd: false,
@@ -812,7 +814,13 @@ Component({
         },
         resolveEventDetail: (provider, event, extraDetail) => this.resolveEventDetail(provider, event, extraDetail),
         miniProgramErrorCode: 'BI_SPLASH_NAVIGATE_MINI_PROGRAM_FAIL',
-        navigateErrorCode: 'BI_SPLASH_NAVIGATE_FAIL'
+        navigateErrorCode: 'BI_SPLASH_NAVIGATE_FAIL',
+        apiRequestErrorCode: 'BI_SPLASH_API_REQUEST_FAIL',
+        apiRequestParams: {
+          configId: customAd.configId,
+          equipmentValue: this.properties.equipmentValue,
+          userId: this.properties.userId
+        }
       })
     },
 

package/src/ad/utils.js

@@ -3,13 +3,13 @@
  * @Author wutao
  * @Date 2026-04-17
  * @LastEditors wutao
- * @LastEditTime 2026-08-17 14:59:58
+ * @LastEditTime 2026-09-07 17:00:17
  */
 
 /**
  * 获取跳转目标类型
  * @param {Record<string, any> | null | undefined} customAd 自定义广告数据
- * @returns {'miniProgram' | 'internal' | 'web' | 'none'}
+ * @returns {'miniProgram' | 'internal' | 'web' | 'api' | 'none'}
  */
 function getNavigationType(customAd) {
   if (!customAd) return 'none'
@@ -20,6 +20,7 @@ function getNavigationType(customAd) {
   if (normalizedActionType === 'miniprogram') return 'miniProgram'
   if (normalizedActionType === 'internal') return 'internal'
   if (normalizedActionType === 'web') return 'web'
+  if (normalizedActionType === 'api') return 'api'
   if (normalizedActionType === 'none') return 'none'
 
   if (customAd.appId || customAd.targetAppId || customAd.miniProgramAppId || customAd.jumpAppId) {
@@ -70,7 +71,7 @@ function getMiniProgramOpenMode(customAd) {
 }
 
 /**
- * 获取 Web 跳转地址
+ * 获取 Web 跳转地址或接口请求地址
  * @param {Record<string, any> | null | undefined} customAd 自定义广告数据
  * @returns {string}
  */
@@ -79,6 +80,76 @@ function getWebUrl(customAd) {
   return customAd.action && customAd.action.url || customAd.url || customAd.jumpUrl || customAd.webUrl || customAd.h5Url || ''
 }
 
+/**
+ * 判断接口查询参数是否已提供有效值
+ * @param {unknown} value 参数值
+ * @returns {boolean}
+ */
+function hasQueryParamValue(value) {
+  return value !== undefined && value !== null && value !== ''
+}
+
+/**
+ * 向接口地址追加查询参数，并保留原有查询参数和哈希片段
+ * @param {string} url 接口地址
+ * @param {Record<string, string | number>} params 查询参数
+ * @returns {string}
+ */
+function appendUrlQueryParams(url, params) {
+  const hashIndex = url.indexOf('#')
+  const hash = hashIndex >= 0 ? url.slice(hashIndex) : ''
+  const baseUrl = hashIndex >= 0 ? url.slice(0, hashIndex) : url
+  const query = Object.keys(params)
+    .map(key => `${encodeURIComponent(key)}=${encodeURIComponent(String(params[key]))}`)
+    .join('&')
+
+  if (!query) return url
+
+  const separator = baseUrl.includes('?')
+    ? /[?&]$/.test(baseUrl) ? '' : '&'
+    : '?'
+
+  return `${baseUrl}${separator}${query}${hash}`
+}
+
+/**
+ * 处理接口型广告的请求结果
+ * @param {WechatMiniprogram.RequestSuccessCallbackResult} response 请求响应
+ * @param {Record<string, any>} context 广告点击上下文
+ * @returns {void}
+ */
+function handleApiResponse(response, context) {
+  const responseData = response && response.data && typeof response.data === 'object'
+    ? response.data
+    : null
+  const responseBody = responseData && responseData.body && typeof responseData.body === 'object'
+    ? responseData.body
+    : null
+  const appId = String(responseBody && responseBody.appId || '').trim()
+  const path = String(responseBody && responseBody.url || '').trim().replace(/^\/+/, '')
+  const responseCode = String(responseData && responseData.code || '')
+
+  if (responseCode !== '200' || !appId || !path) {
+    context.onError({
+      ...context.resolveEventDetail(context.actionDetail.provider, null),
+      errCode: context.apiRequestErrorCode || 'BI_CUSTOM_AD_API_REQUEST_FAIL',
+      errMsg: responseData && responseData.message || '广告接口响应异常'
+    })
+    return
+  }
+
+  navigateCustomAd({
+    ...context,
+    customAd: {
+      action: {
+        type: 'miniProgram',
+        appId,
+        path
+      }
+    }
+  })
+}
+
 /**
  * 执行自定义广告跳转
  * @param {Object} options 跳转参数
@@ -89,6 +160,8 @@ function getWebUrl(customAd) {
  * @param {(provider: 'wechat' | 'custom', event?: Record<string, any> | null, extraDetail?: Record<string, any>) => Record<string, any>} options.resolveEventDetail 事件合并方法
  * @param {string} options.miniProgramErrorCode 小程序跳转失败错误码
  * @param {string} options.navigateErrorCode 内部页面跳转失败错误码
+ * @param {string} [options.apiRequestErrorCode] 接口请求失败错误码
+ * @param {{configId?: number | string, equipmentValue?: string, userId?: number}} [options.apiRequestParams] 接口请求查询参数
  * @returns {void}
  */
 function navigateCustomAd(options) {
@@ -99,7 +172,9 @@ function navigateCustomAd(options) {
     onError,
     resolveEventDetail,
     miniProgramErrorCode,
-    navigateErrorCode
+    navigateErrorCode,
+    apiRequestErrorCode,
+    apiRequestParams
   } = options
 
   if (!customAd) return
@@ -107,7 +182,7 @@ function navigateCustomAd(options) {
   const targetType = getNavigationType(customAd)
   const appId = getNavigationAppId(customAd)
   const path = getNavigationPath(customAd)
-  const webUrl = getWebUrl(customAd)
+  const actionUrl = getWebUrl(customAd)
 
   if (targetType === 'miniProgram' && appId) {
     const miniProgramOpenMode = getMiniProgramOpenMode(customAd)
@@ -152,10 +227,57 @@ function navigateCustomAd(options) {
     return
   }
 
-  if (targetType === 'web' && webUrl) {
+  if (targetType === 'web' && actionUrl) {
     onOpenWebview({
       ...actionDetail,
-      url: webUrl
+      url: actionUrl
+    })
+    return
+  }
+
+  if (targetType === 'api' && actionUrl) {
+    if (typeof wx === 'undefined' || typeof wx.request !== 'function') return
+
+    const requestParams = apiRequestParams || {}
+    const requiredParamNames = ['configId', 'equipmentValue', 'userId']
+    const invalidParamNames = requiredParamNames.filter((name) => {
+      const value = requestParams[name]
+
+      if (name === 'userId') {
+        return !Number.isInteger(value) || value <= 0
+      }
+
+      return !hasQueryParamValue(value)
+    })
+
+    if (invalidParamNames.length) {
+      onError({
+        ...resolveEventDetail(actionDetail.provider, null),
+        errCode: apiRequestErrorCode || 'BI_CUSTOM_AD_API_REQUEST_FAIL',
+        errMsg: `接口型广告缺少必要参数或参数值无效：${invalidParamNames.join('、')}`
+      })
+      return
+    }
+
+    const requestUrl = appendUrlQueryParams(actionUrl, {
+      configId: requestParams.configId,
+      equipmentValue: requestParams.equipmentValue,
+      userId: requestParams.userId
+    })
+
+    wx.request({
+      url: requestUrl,
+      method: 'GET',
+      success: (response) => {
+        handleApiResponse(response, options)
+      },
+      fail: (error) => {
+        onError({
+          ...resolveEventDetail(actionDetail.provider, null),
+          errCode: apiRequestErrorCode || 'BI_CUSTOM_AD_API_REQUEST_FAIL',
+          errMsg: error && error.errMsg || '广告接口请求失败'
+        })
+      }
     })
   }
 }
@@ -166,5 +288,6 @@ module.exports = {
   getNavigationPath,
   getMiniProgramOpenMode,
   getWebUrl,
+  appendUrlQueryParams,
   navigateCustomAd
 }