@cloudbase/js-sdk 3.9.3 → 3.9.5-alpha.0

package/core.d.ts

@@ -38,6 +38,7 @@ declare namespace cloudbase {
   type OrmClient = import('@cloudbase/js-sdk/model').OrmClient
   type OrmRawQueryClient = import('@cloudbase/js-sdk/model').OrmRawQueryClient
   type IMySqlClient = import('@cloudbase/js-sdk/mysql').IMySqlClient
+  type RealtimeClient = import('@cloudbase/realtime-js').RealtimeClient
   type AI = import('@cloudbase/js-sdk/ai').AI
   type CloudbaseAdapter = import('@cloudbase/adapter-interface').CloudbaseAdapter
   type ResponseObject = import('@cloudbase/adapter-interface').ResponseObject
@@ -596,7 +597,7 @@ declare namespace cloudbase.app {
      *     '文件A的fileID',
      *     {
      *       fileID: '文件B的fileID',
-     *       maxAge: 600 // 文件B的链接有效期，单位`ms`
+     *       maxAge: 600 // 兼容字段，传统模式不会用它生成下载链接
      *     }
      *   ]
      * });
@@ -605,7 +606,7 @@ declare namespace cloudbase.app {
      * @param params
      * @param params.fileList 要下载的文件数组，数组元素可以是`string`或`Object`，如果是`string`代表文件ID，如果是`Object`可配置以下信息
      * @param params.fileList[].fileID 要下载的文件ID
-     * @param params.fileList[].maxAge 下载链接的有效期，单位`ms`
+     * @param params.fileList[].maxAge 过期时间。传统模式不会用它生成下载链接，TTL 传入无效。需要可控过期请改用 `app.storage.from(bucketId).createSignedUrl(path, expiresIn)`（PG 模式下可用）。
      *
      * @return Promise-文件下载链接
      *
@@ -751,6 +752,26 @@ declare namespace cloudbase.app {
     mysql: IMySqlClient
     rdb: IMySqlClient
 
+    /**
+     * Realtime 客户端（Broadcast / Presence / Postgres CDC）
+     *
+     * WebSocket 地址为 `wss://{GW}/v1/realtime/websocket?apikey={accessToken}&vsn=1.0.0`。
+     *
+     * 浏览器 / Node / 微信小程序均通过 `app.realtime()` 获取客户端。
+     * 小程序不要单独 `new RealtimeClient()`，需使用已注册 adapter 的 `wsClass`。
+     * 使用前需先登录（如 `auth.signInAnonymously()`）；没有登录态时会在控制台提示。
+     *
+     * @example
+     * ```javascript
+     * const app = cloudbase.init({ env: 'xxxx-yyy' })
+     * const realtime = app.realtime()
+     * const channel = realtime.channel('room')
+     * channel.on('broadcast', { event: 'cursor-pos' }, (payload) => console.log(payload))
+     * channel.subscribe()
+     * ```
+     */
+    realtime(): RealtimeClient
+
     ai(options?: { baseUrl?: string }): AI
 
     apis: ICloudbaseApis
@@ -1956,6 +1977,10 @@ declare namespace cloudbase.storage {
 
   interface ICloudbaseFileInfo {
     fileID: string
+    /**
+     * 仅为兼容字段。传统模式不会用它生成下载链接，TTL 传入无效。
+     * 需要可控过期请改用 `app.storage.from(bucketId).createSignedUrl(path, expiresIn)`（PG 模式下可用）。
+     */
     maxAge: number
   }
 
@@ -2278,7 +2303,7 @@ declare namespace cloudbase.storage {
      * 创建签名下载 URL
      *
      * @param path 文件路径
-     * @param expiresIn 有效期（秒）
+     * @param expiresIn 过期时间。传统模式不会用它生成下载链接，TTL 传入无效。需要可控过期请改用 `from(bucketId).createSignedUrl`（PG 模式下可用）。
      * @param options 可选配置
      */
     createSignedUrl(
@@ -2297,7 +2322,7 @@ declare namespace cloudbase.storage {
      * 批量创建签名下载 URL
      *
      * @param paths 文件路径数组
-     * @param expiresIn 有效期（秒）
+     * @param expiresIn 过期时间。传统模式不会用它生成下载链接，TTL 传入无效。需要可控过期请改用 `from(bucketId).createSignedUrls`（PG 模式下可用）。
      */
     createSignedUrls(
       paths: string[],