@cloudbase/app 3.0.3 → 3.0.5

package/src/libs/adapter-node/types.ts

@@ -0,0 +1,116 @@
+/** 自定义登录 Ticket 创建选项 */
+export interface ICreateTicketOpts {
+  /** 刷新间隔（毫秒），默认 3600000（1小时） */
+  refresh?: number
+  /** 过期时间戳（毫秒），默认 7 天后 */
+  expire?: number
+}
+
+/** 用户信息查询结果 */
+export interface IGetUserInfoResult {
+  openId: string
+  appId: string
+  uid: string
+  customUserId: string
+  isAnonymous: boolean
+}
+
+/** 云函数入口 context 参数结构 */
+export interface IContextParam {
+  memory_limit_in_mb: number
+  time_limit_in_ms: number
+  request_id: string
+  /** 老架构环境变量字符串，分号分隔的 key=value */
+  environ?: string
+  /** 新架构环境变量 JSON 字符串 */
+  environment?: string
+  function_version: string
+  function_name: string
+  namespace: string
+}
+
+/** 用户信息查询请求参数 */
+export interface IUserInfoQuery {
+  platform?: string
+  platformId?: string
+  uid?: string
+}
+
+/**
+ * 云函数运行时完整环境变量类型汇总
+ * 包含 SCF、TCB、微信相关的所有环境变量
+ */
+export interface ICompleteCloudbaseContext {
+  /** SCF 日志配置 */
+  _SCF_TCB_LOG?: string
+  /** 登录类型 */
+  LOGINTYPE?: string
+  QQ_APPID?: string
+  QQ_OPENID?: string
+  /** SCF 命名空间 */
+  SCF_NAMESPACE: string
+  /** TCB 上下文配置 */
+  TCB_CONTEXT_CNFG?: string
+  /** TCB 上下文 key 列表，逗号分隔 */
+  TCB_CONTEXT_KEYS: string[]
+  TCB_CUSTOM_USER_ID?: string
+  /** 云开发环境 ID */
+  TCB_ENV: string
+  TCB_HTTP_CONTEXT?: string
+  TCB_ISANONYMOUS_USER?: string
+  TCB_ROUTE_KEY?: string
+  /** 请求序列 ID */
+  TCB_SEQID: string
+  TCB_SESSIONTOKEN?: string
+  /** 客户端来源 IP */
+  TCB_SOURCE_IP?: string
+  TCB_SOURCE?: string
+  TCB_TRACELOG?: string
+  /** 用户唯一标识 */
+  TCB_UUID?: string
+  /** 腾讯云运行环境标识 */
+  TENCENTCLOUD_RUNENV: string
+  TENCENTCLOUD_SECRETID: string
+  TENCENTCLOUD_SECRETKEY: string
+  TENCENTCLOUD_SESSIONTOKEN: string
+  /** 触发来源 */
+  TRIGGER_SRC: string
+  WX_API_TOKEN?: string
+  WX_APPID?: string
+  WX_CLIENTIP?: string
+  WX_CLIENTIPV6?: string
+  WX_CLOUDBASE_ACCESSTOKEN?: string
+  /** 微信上下文 key 列表，逗号分隔 */
+  WX_CONTEXT_KEYS: string[]
+  WX_OPENID?: string
+  WX_TRIGGER_API_TOKEN_V0?: string
+  WX_UNIONID?: string
+}
+
+/** getEndUserInfo 返回结果 */
+export interface IGetEndUserInfoResult {
+  userInfo?: {
+    openId: string
+    appId: string
+    uid: string
+    customUserId: string
+    isAnonymous: boolean
+  }
+  requestId?: string
+}
+
+/** 自定义请求选项 */
+export interface ICustomReqOpts {
+  /** 请求超时时间（毫秒） */
+  timeout?: number
+}
+
+/** 模板消息推送请求参数 */
+export interface ITemplateNotifyReq {
+  /** 通知策略 ID */
+  notifyId: string
+  /** 通知模板变量键值对 */
+  data?: Record<string, unknown>
+  /** 点击消息打开的页面地址 */
+  url?: string
+}

package/src/libs/adapter-node/utils.ts

@@ -0,0 +1,182 @@
+import { utils } from '@cloudbase/utilities'
+import { ReadableStream } from 'web-streams-polyfill'
+import { ERROR, checkCustomUserIdRegex } from './constants'
+import { lookupAppId } from './metadata'
+
+/** 从 @cloudbase/utilities 中提取的表单和查询字符串工具 */
+export const { isFormData, toQueryString } = utils as {
+  isFormData: (obj: unknown) => boolean
+  toQueryString: (data: Record<string, any>) => string
+}
+
+/**
+ * 跨端安全获取环境变量
+ * Web 端、小游戏端等没有 process 全局对象，直接访问 process.env 会报错
+ */
+export function getEnv(): Record<string, string | undefined>
+export function getEnv(key: string): string | undefined
+export function getEnv(key?: string): string | undefined | Record<string, string | undefined> {
+  if (typeof process === 'undefined' || !process.env) {
+    return key !== undefined ? undefined : {}
+  }
+  return key !== undefined ? process.env[key] : process.env
+}
+
+/** 判断当前是否在 SCF（云函数）运行环境中 */
+export const checkIsInScf = () => getEnv('TENCENTCLOUD_RUNENV') === 'SCF'
+
+export function checkIsInCBR() {
+  // CBR = CLOUDBASE_RUN
+  return !!getEnv('CBR_ENV_ID')
+}
+
+const kSumeruEnvSet = new Set(['formal', 'pre', 'test'])
+export function checkIsInSumeru() {
+  // SUMERU_ENV=formal | test | pre
+  return kSumeruEnvSet.has(getEnv('SUMERU_ENV') || '')
+}
+
+export function isNonEmptyString(str: string) {
+  return typeof str === 'string' && str !== ''
+}
+
+export async function checkIsInTencentCloud(): Promise<boolean> {
+  if (getEnv('TENCENTCLOUD') === 'true') {
+    return true
+  }
+  return isNonEmptyString(await lookupAppId())
+}
+
+export const getCurrRunEnvTag = async (): Promise<string> => {
+  if (checkIsInScf()) {
+    return 'scf'
+  } if (checkIsInCBR()) {
+    return 'cbr'
+  } if (checkIsInSumeru()) {
+    return 'sumeru'
+  } if (await checkIsInTencentCloud()) {
+    return 'tencentcloud'
+  }
+  return 'unknown'
+}
+
+/**
+ * 校验自定义用户 ID 格式
+ * @throws 格式不合法时抛出 INVALID_PARAM 错误
+ */
+export const validateUid = (uid: string): void => {
+  if (typeof uid !== 'string') {
+    throw { ...ERROR.INVALID_PARAM, message: 'uid must be a string' }
+  }
+  if (!checkCustomUserIdRegex.test(uid)) {
+    throw { ...ERROR.INVALID_PARAM, message: `Invalid uid: "${uid}"` }
+  }
+}
+
+/**
+ * 安全的 JSON 解析，解析失败时返回原始文本而非抛异常
+ * @param text - 待解析的字符串
+ * @returns 解析后的对象，空字符串返回 null，解析失败返回原始文本
+ */
+export function safeParseJson(text: string): any {
+  if (!text || !text.trim()) {
+    return null
+  }
+  try {
+    return JSON.parse(text)
+  } catch (e) {
+    console.warn('catch an error', { e, text })
+    return text
+  }
+}
+
+/**
+ * 将对象的所有值转为字符串类型
+ * 用于将 headers 等对象统一为 Record<string, string>
+ */
+export function obj2StrRecord(obj: object): Record<string, string> {
+  return Object.entries(obj).reduce<Record<string, string>>((acc, cur: [string, unknown]) => {
+    const [key, value] = cur
+    acc[key] = String(value)
+    return acc
+  }, {})
+}
+
+/**
+ * 将 HeadersInit 转为可索引的普通对象
+ * 兼容 Headers 实例和普通对象两种形式
+ */
+export function headersInit2Indexable(h: HeadersInit) {
+  if (isHeaders(h)) {
+    const ret: Record<string, string> = {}
+    h.forEach((val, key) => {
+      ret[key] = val
+    })
+    return ret
+  }
+  return h
+
+  function isHeaders(h: HeadersInit): h is Headers {
+    try {
+      // Node 低版本可能没有全局 Headers
+      return h instanceof Headers
+    } catch (_) {
+      return false
+    }
+  }
+}
+
+/**
+ * 手动解析查询字符串，避免 URLSearchParams 的兼容性问题
+ * 支持重复 key 自动转为数组
+ * @param search - 查询字符串，可带前导 ? 或 #
+ */
+export function parseQueryString(search: string): Record<string, string | string[]> {
+  const params: any = {}
+  const cleanSearch = search.replace(/^[?#]/, '')
+
+  if (!cleanSearch) {
+    return params
+  }
+
+  const pairs = cleanSearch.split('&')
+
+  pairs.forEach((item) => {
+    let [key, value] = item.split('=')
+    key = decodeURIComponent(key)
+    value = decodeURIComponent(value || '')
+    if (key) {
+      if (params[key]) {
+        // 已存在同名 key，转为数组
+        if (Array.isArray(params[key])) {
+          params[key].push(value)
+        } else {
+          params[key] = [params[key], value]
+        }
+      } else {
+        params[key] = value
+      }
+    }
+  })
+  return params
+}
+
+/**
+ * 将 Node ReadableStream 转换为 Web ReadableStream (polyfill)
+ * 用于 fetch 流式响应在 Node 环境下的适配
+ */
+export function createWebStreamFromNodeReadableStream(stream: NodeJS.ReadableStream): ReadableStream {
+  const asyncIterator = stream[Symbol.asyncIterator]()
+
+  return new ReadableStream({
+    async pull(controller) {
+      const next = await asyncIterator.next()
+
+      if (next.done) {
+        controller.close()
+      } else {
+        controller.enqueue(next.value)
+      }
+    },
+  })
+}

package/src/libs/request.ts

@@ -113,10 +113,11 @@ export class CloudbaseRequest implements ICloudbaseRequest {
    */
   constructor(config: ICloudbaseRequestConfig & { throw?: boolean }) {
     this.config = config
-    const reqConfig: IRequestConfig = {
+    const reqConfig: IRequestConfig & { auth: ICloudbaseRequestConfig['auth'] } = {
       timeout: this.config.timeout,
       timeoutMsg: `[@cloudbase/js-sdk] 请求在${this.config.timeout / 1000}s内未完成，已中断`,
       restrictedMethods: ['post', 'put'],
+      auth: config.auth,
     }
     this.reqClass = new Platform.adapter.reqClass(reqConfig)
     this.throwWhenRequestFail = config.throw || false
@@ -201,6 +202,7 @@ export class CloudbaseRequest implements ICloudbaseRequest {
       search?: string
       defaultQuery?: KV<any>
       headers?: KV<string>
+      endPointMode?: 'CLOUD_API' | 'GATEWAY'
     },
     customReqOpts?: ICustomReqOpts,
   ): Promise<ResponseObject> {
@@ -284,7 +286,7 @@ export class CloudbaseRequest implements ICloudbaseRequest {
         ...formatQuery,
       })
 
-    const endPointMode = this.config.endPointMode || 'CLOUD_API'
+    const endPointMode = options?.endPointMode || this.config.endPointMode || 'CLOUD_API'
 
     const url = getEndPointInfo(this.config.env, endPointMode)
     let BASE_URL = url.baseUrl

package/webpack/web.prod.js

@@ -5,7 +5,7 @@ const TerserPlugin = require('terser-webpack-plugin')
 module.exports = function (options) {
   const { context, entry, output, mode, watch, externals, definePlugin = {}, optimization = {} } = options
   const isDevelopment = mode !== 'production'
-  let plugins = [
+  const plugins = [
     new webpack.DefinePlugin(definePlugin),
     // new BundleAnalyzerPlugin()
   ].filter((item) => !!item)
@@ -82,19 +82,19 @@ module.exports = function (options) {
       ...optimization,
       ...(isDevelopment
         ? {
-            minimize: false,
-            removeAvailableModules: false,
-            concatenateModules: true,
-          }
+          minimize: false,
+          removeAvailableModules: false,
+          concatenateModules: true,
+        }
         : {
-            minimizer: [
-              new TerserPlugin({
-                test: /\.js(\?.*)?$/i,
-                cache: false,
-                parallel: true,
-              }),
-            ],
-          }),
+          minimizer: [
+            new TerserPlugin({
+              test: /\.js(\?.*)?$/i,
+              cache: false,
+              parallel: true,
+            }),
+          ],
+        }),
     },
   }
 }

package/webpack/webpack.miniprogram.js

@@ -1,4 +1,5 @@
 const path = require('path')
+const { ignoreNodeDepsPlugins } = require('../../../webpack.ignore-node-deps')
 
 const params = {
   context: path.resolve(__dirname, '../'),
@@ -8,17 +9,22 @@ const params = {
   output: {
     path: path.resolve(__dirname, '../dist/miniprogram'),
     filename: 'index.js',
-    library: `tcboauth`,
+    library: 'tcboauth',
     libraryTarget: 'umd',
     umdNamedDefine: true,
     globalObject: 'typeof window !== "undefined"?window:this',
   },
   externals: {},
   definePlugin: {
-    'process.env.NODE_ENV': JSON.stringify('production'), // 注入环境变量，用于业务代码判断
+    'process.env.NODE_ENV': JSON.stringify('production'),
     'process.env.IS_MP_BUILD': 'true',
+    'process.env.IS_BROWSER_BUILD': 'true',
     'globalThis.IS_MP_BUILD': true,
   },
 }
 
-module.exports = require('./web.prod.js')(params)
+const config = require('./web.prod.js')(params)
+
+config.plugins.push(...ignoreNodeDepsPlugins)
+
+module.exports = config