@bi-nova/ui-weapp 1.2.1 → 1.3.0-beta.202609181052

package/src/shared/action-executor.js

@@ -0,0 +1,336 @@
+/**
+ * @Description Weapp 通用动作执行器
+ * @Author wutao
+ * @Date 2026-09-14
+ * @LastEditors wutao
+ * @LastEditTime 2026-09-14 17:19:39
+ */
+
+/** 通用动作执行错误码 */
+const DEFAULT_ERROR_CODES = {
+  invalidAction: 'WEAPP_ACTION_INVALID',
+  miniProgramFail: 'WEAPP_ACTION_MINI_PROGRAM_FAIL',
+  internalFail: 'WEAPP_ACTION_INTERNAL_FAIL',
+  apiRequestFail: 'WEAPP_ACTION_API_REQUEST_FAIL',
+  unsupportedApi: 'WEAPP_ACTION_API_UNSUPPORTED'
+}
+
+/**
+ * 判断接口参数是否具有有效值
+ * @param {unknown} value 参数值
+ * @returns {boolean}
+ */
+function hasValue(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)
+    .filter(key => hasValue(params[key]))
+    .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 {unknown} type 原始动作类型
+ * @returns {string}
+ */
+function normalizeActionType(type) {
+  const rawType = String(type || '').trim()
+
+  if (rawType === 'miniProgram' || rawType.toLowerCase() === 'miniprogram') {
+    return 'mini_program'
+  }
+
+  return rawType.toLowerCase()
+}
+
+/**
+ * 调用动作错误回调
+ * @param {Record<string, any>} options 执行参数
+ * @param {string} errCode 错误码
+ * @param {string} errMsg 错误信息
+ * @returns {false}
+ */
+function emitError(options, errCode, errMsg) {
+  if (typeof options.onError === 'function') {
+    options.onError({ errCode, errMsg })
+  }
+
+  return false
+}
+
+/**
+ * 调用动作成功回调
+ * @param {Record<string, any>} options 执行参数
+ * @param {Record<string, any>} detail 成功详情
+ * @returns {void}
+ */
+function emitSuccess(options, detail) {
+  if (typeof options.onSuccess === 'function') {
+    options.onSuccess(detail)
+  }
+}
+
+/**
+ * 执行小程序跳转
+ * @param {Record<string, any>} options 执行参数
+ * @param {Record<string, any>} action 动作配置
+ * @param {Record<string, string>} errorCodes 错误码配置
+ * @returns {boolean}
+ */
+function executeMiniProgramAction(options, action, errorCodes) {
+  const appId = String(action.appId || '').trim()
+  const path = String(action.path || '')
+  const wxApi = typeof wx === 'undefined' ? null : wx
+
+  if (!appId) {
+    return emitError(options, errorCodes.invalidAction, '小程序动作缺少 appId')
+  }
+
+  if (!wxApi || typeof wxApi.navigateToMiniProgram !== 'function') {
+    return emitError(options, errorCodes.unsupportedApi, '当前环境不支持跳转其他小程序')
+  }
+
+  wxApi.navigateToMiniProgram({
+    appId,
+    path,
+    success: () => {
+      emitSuccess(options, {
+        actionType: 'mini_program',
+        resultType: 'mini_program',
+        appId,
+        path
+      })
+    },
+    fail: (error) => {
+      emitError(
+        options,
+        errorCodes.miniProgramFail,
+        error && error.errMsg || '跳转到其他小程序失败'
+      )
+    }
+  })
+
+  return true
+}
+
+/**
+ * 执行小程序内部页面跳转
+ * @param {Record<string, any>} options 执行参数
+ * @param {Record<string, any>} action 动作配置
+ * @param {Record<string, string>} errorCodes 错误码配置
+ * @returns {boolean}
+ */
+function executeInternalAction(options, action, errorCodes) {
+  const path = String(action.path || '').trim()
+  const wxApi = typeof wx === 'undefined' ? null : wx
+
+  if (!path) {
+    return emitError(options, errorCodes.invalidAction, '内部页面动作缺少 path')
+  }
+
+  if (!wxApi || typeof wxApi.navigateTo !== 'function') {
+    return emitError(options, errorCodes.unsupportedApi, '当前环境不支持页面跳转')
+  }
+
+  wxApi.navigateTo({
+    url: path,
+    success: () => {
+      emitSuccess(options, {
+        actionType: 'internal',
+        resultType: 'internal',
+        path
+      })
+    },
+    fail: (error) => {
+      emitError(
+        options,
+        errorCodes.internalFail,
+        error && error.errMsg || '页面跳转失败'
+      )
+    }
+  })
+
+  return true
+}
+
+/**
+ * 执行 WebView 动作
+ * @param {Record<string, any>} options 执行参数
+ * @param {Record<string, any>} action 动作配置
+ * @param {Record<string, string>} errorCodes 错误码配置
+ * @returns {boolean}
+ */
+function executeWebAction(options, action, errorCodes) {
+  const url = String(action.url || '').trim()
+
+  if (!url) {
+    return emitError(options, errorCodes.invalidAction, 'Web 动作缺少 url')
+  }
+
+  if (typeof options.onOpenWebview === 'function') {
+    options.onOpenWebview({ url })
+  }
+
+  emitSuccess(options, {
+    actionType: 'web',
+    resultType: 'web',
+    url
+  })
+  return true
+}
+
+/**
+ * 校验动态接口动作运行时参数
+ * @param {Record<string, any>} requestParams 运行时参数
+ * @returns {string[]}
+ */
+function getInvalidApiParamNames(requestParams) {
+  return ['configId', 'equipmentValue', 'userId'].filter((name) => {
+    const value = requestParams[name]
+
+    if (name === 'userId') {
+      return !Number.isInteger(value) || value <= 0
+    }
+
+    return !hasValue(value)
+  })
+}
+
+/**
+ * 执行动态接口动作
+ * @param {Record<string, any>} options 执行参数
+ * @param {Record<string, any>} action 动作配置
+ * @param {Record<string, string>} errorCodes 错误码配置
+ * @returns {boolean}
+ */
+function executeApiAction(options, action, errorCodes) {
+  const url = String(action.url || '').trim()
+  const wxApi = typeof wx === 'undefined' ? null : wx
+  const requestParams = options.apiRequestParams || {}
+  const invalidParamNames = getInvalidApiParamNames(requestParams)
+
+  if (!url) {
+    return emitError(options, errorCodes.invalidAction, '接口动作缺少 url')
+  }
+
+  if (invalidParamNames.length) {
+    return emitError(
+      options,
+      errorCodes.apiRequestFail,
+      `接口动作缺少必要参数或参数值无效：${invalidParamNames.join('、')}`
+    )
+  }
+
+  if (!wxApi || typeof wxApi.request !== 'function') {
+    return emitError(options, errorCodes.unsupportedApi, '当前环境不支持接口请求')
+  }
+
+  wxApi.request({
+    url: appendUrlQueryParams(url, {
+      configId: requestParams.configId,
+      equipmentValue: requestParams.equipmentValue,
+      userId: requestParams.userId
+    }),
+    method: 'GET',
+    success: (response) => {
+      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.path || responseBody.url) || ''
+      ).trim().replace(/^\/+/, '')
+
+      if (String(responseData && responseData.code || '') !== '200' || !appId || !path) {
+        emitError(
+          options,
+          errorCodes.apiRequestFail,
+          responseData && responseData.message || '接口动作响应异常'
+        )
+        return
+      }
+
+      executeMiniProgramAction(options, { appId, path }, errorCodes)
+    },
+    fail: (error) => {
+      emitError(
+        options,
+        errorCodes.apiRequestFail,
+        error && error.errMsg || '接口动作请求失败'
+      )
+    }
+  })
+
+  return true
+}
+
+/**
+ * 执行标准导航动作
+ * @param {Object} options 动作执行参数
+ * @param {Record<string, any>} options.action 标准动作配置
+ * @param {Record<string, any>} [options.apiRequestParams] 动态接口运行时参数
+ * @param {Record<string, string>} [options.errorCodes] 自定义错误码
+ * @param {(detail: Record<string, any>) => void} [options.onOpenWebview] WebView 回调
+ * @param {(detail: Record<string, any>) => void} [options.onSuccess] 成功回调
+ * @param {(detail: {errCode: string, errMsg: string}) => void} [options.onError] 失败回调
+ * @returns {boolean} 是否已进入动作执行流程
+ */
+function executeNavigationAction(options) {
+  const action = options && options.action || {}
+  const actionType = normalizeActionType(action.type)
+  const errorCodes = {
+    ...DEFAULT_ERROR_CODES,
+    ...(options && options.errorCodes || {})
+  }
+
+  if (actionType === 'mini_program') {
+    return executeMiniProgramAction(options, action, errorCodes)
+  }
+
+  if (actionType === 'internal') {
+    return executeInternalAction(options, action, errorCodes)
+  }
+
+  if (actionType === 'web') {
+    return executeWebAction(options, action, errorCodes)
+  }
+
+  if (actionType === 'api') {
+    return executeApiAction(options, action, errorCodes)
+  }
+
+  return emitError(
+    options,
+    errorCodes.invalidAction,
+    `不支持的动作类型：${actionType || 'empty'}`
+  )
+}
+
+module.exports = {
+  appendUrlQueryParams,
+  executeNavigationAction,
+  normalizeActionType
+}