@cloudbase/types 2.26.1 → 2.26.2

package/auth.d.ts

@@ -15,6 +15,7 @@ ICloudbaseConfig,
 | 'i18n'
 | 'accessKey'
 | 'useWxCloud'
+| 'auth'
 > &
 ICloudbaseConfig['auth']
 & {eventBus?: ICloudbaseEventEmitter}

package/index.d.ts

@@ -22,6 +22,16 @@ export interface KVstring {
 
 export type EndPointKey = 'CLOUD_API' | 'GATEWAY'
 
+/** 自定义登录凭证信息（从控制台下载的私钥文件） */
+export interface ICredentialsInfo {
+  /** 私钥 ID */
+  private_key_id: string;
+  /** RSA 私钥内容 */
+  private_key: string;
+  /** 所属环境 ID */
+  env_id: string;
+}
+
 export interface ICloudbaseConfig {
   env: string
   region?: string
@@ -43,7 +53,29 @@ export interface ICloudbaseConfig {
   useWxCloud?: boolean // 是否使用微信云开发链路
   auth?: {
     detectSessionInUrl?: boolean
+    secretId?: string
+    secretKey?: string
+    sessionToken?: string
+    secretType?: 'SESSION_SECRET' | 'SECRET'
+    credentials?: ICredentialsInfo // 自定义登录私钥信息，node端使用
   }
+  // @cloudbase/functions-framework 函数上下文，只要求部分字段，只在云函数或云托管中有效
+  context?: Readonly<{
+    eventID: string
+    extendedContext?: {
+      envId: string // 环境 ID
+      // uin: string             // 请求的 UIN
+      source: string // 请求来源，如 wx
+      accessToken?: string // 调用请求时的 AccessToken
+      userId?: string // 请求的用户 ID
+      tmpSecret?: {
+        // 临时凭证
+        secretId: string // secretId
+        secretKey: string // secretKey
+        token: string // token
+      }
+    }
+  }>
 }
 // 可更新的配置字段
 export type ICloudbaseUpgradedConfig = Pick<ICloudbaseConfig, 'persistence' | 'region' | 'debug'>
@@ -80,14 +112,47 @@ export interface ICloudbase {
   registerVersion: (version: string) => void
   fire?: (...args: any[]) => void
   updateLang?: (lang: LANGS) => void
+  /**
+   * 检查当前 Cloudbase 实例是否已完成初始化
+   * @returns 是否已初始化
+   */
+  isInitialized?: () => boolean
   getEndPointWithKey?: (key: EndPointKey) => {
     BASE_URL: string
     PROTOCOL: string
   }
   auth?: (options?: { persistence: cloudbase.auth.Persistence }) => cloudbase.auth.App
 }
+
+/**
+ * Node.js 端适配器扩展方法
+ */
+export interface INodeAdapterExtend {
+  /**
+   * 从环境变量中获取腾讯云临时密钥信息
+   * 用于 API 请求签名
+   */
+  getSecretInfo?: (config?: ICloudbaseConfig) => {
+    env: string
+    secretId: string
+    secretKey: string
+    sessionToken: string
+    accessKey: string
+    secretType: string
+  }
+  /**
+   * 初始化 Node.js 端工具方法，挂载到 js-sdk app 实例上
+   * 包含：auth 相关方法、模板消息推送、context 解析
+   */
+  nodeTool?: (
+    /** js-sdk cloudbase 实例 */
+    app: any,
+    /** 配置信息，包含认证凭证和环境 ID */
+    config: ICloudbaseConfig,
+  ) => void
+}
 export interface ICloudbasePlatformInfo {
-  adapter?: SDKAdapterInterface
+  adapter?: SDKAdapterInterface & INodeAdapterExtend
   runtime?: string
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cloudbase/types",
-  "version": "2.26.1",
+  "version": "2.26.2",
   "description": "cloudbase javascript sdk types",
   "files": [
     "index.js",
@@ -43,5 +43,5 @@
     "lint": "eslint --fix \"./**/*.ts\"",
     "precommit": "npm run lint"
   },
-  "gitHead": "e1fabef412c8dad7e66ea8a40dab53839119d4e5"
+  "gitHead": "af397dd45339057868b98ac09c417d352e56a217"
 }

package/request.d.ts

@@ -10,7 +10,7 @@ export interface IGetAccessTokenResult {
   accessTokenExpire: number;
 }
 
-export type ICloudbaseRequestConfig = Pick<ICloudbaseConfig, 'env' | 'region' | 'timeout' | 'oauthClient' | '_fromApp' | 'i18n' | 'endPointMode'>;
+export type ICloudbaseRequestConfig = Pick<ICloudbaseConfig, 'env' | 'region' | 'timeout' | 'oauthClient' | '_fromApp' | 'i18n' | 'endPointMode' | 'auth'>;
 
 export interface IAppendedRequestInfo {
   data: KV<any>;