@cloudbase/js-sdk 3.1.6 → 3.1.8

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # 更新日志
 
+## [3.1.8] 2026-03-12
+- [Fixed] 增加 storage 类型定义
+
+## [3.1.7] 2026-03-12
+- [Fixed] getVerification 增加 phone_number 参数格式化
+
 ## [3.1.6] 2026-03-12
 - [Added] signInWithOtp 增加可选参数 options.shouldCreateUser 控制是否自动注册用户
 
@@ -40,6 +46,9 @@
 ## [3.0.0] 2026-02-10
 - [Changed] endPointMode 默认启用 GATEWAY 模式
 
+## [2.26.1] 2026-03-12
+- [Fixed] getVerification 增加 phone_number 参数格式化
+
 ## [2.26.0] 2026-03-12
 - [Added] signInWithOtp 增加可选参数 options.shouldCreateUser 控制是否自动注册用户
 

package/dist/index.cjs.js

@@ -14,7 +14,7 @@ var cloudrun_1 = require("@cloudbase/cloudrun");
 var mysql_1 = require("@cloudbase/mysql");
 var apis_1 = require("@cloudbase/apis");
 var database_1 = require("./../database");
-var version = "3.1.6";
+var version = "3.1.8";
 app_1.default.registerVersion(version);
 try {
     (0, auth_1.registerAuth)(app_1.default);

package/dist/index.esm.js

@@ -10,7 +10,7 @@ import { registerCloudrun } from '@cloudbase/cloudrun';
 import { registerMySQL } from '@cloudbase/mysql';
 import { registerApis } from '@cloudbase/apis';
 import { registerDatabase } from './../database';
-var version = "3.1.6";
+var version = "3.1.8";
 cloudbase.registerVersion(version);
 try {
     registerAuth(cloudbase);

package/index.d.ts

@@ -512,8 +512,7 @@ declare namespace cloudbase.app {
 
     getFileInfo(
       params: cloudbase.storage.ICloudbaseGetTempFileURLParams,
-      callback?: Function,
-    ): Promise<cloudbase.storage.ICloudbaseGetTempFileURLResult>
+    ): Promise<cloudbase.storage.ICloudbaseGetFileInfoResult>
     /**
      * 云存储-获取上传元信息
      *
@@ -522,6 +521,17 @@ declare namespace cloudbase.app {
      * @param callback
      */
     getUploadMetadata(params: cloudbase.storage.ICloudbaseGetUploadMetadataParams, callback?: Function): Promise<any>
+
+    /**
+     * Supabase 风格的文件存储 API
+     *
+     * @example
+     * ```typescript
+     * const bucket = app.storage.from('my-bucket')
+     * const { data, error } = await bucket.upload('path/to/file.jpg', file)
+     * ```
+     */
+    storage: cloudbase.storage.SupabaseFileAPILikeStorage
     /**
      * 获取数据库实例
      *
@@ -1428,6 +1438,365 @@ declare namespace cloudbase.storage {
     }>
     requestId?: string
   }
+
+  interface ICloudbaseGetFileInfoResultItem {
+    code?: string
+    message?: string
+    fileID: string
+    tempFileURL: string
+    fileName?: string
+    cloudId?: string
+    contentType?: string
+    mime?: string
+    size?: number
+    cacheControl?: string
+    lastModified?: string
+    etag?: string
+  }
+
+  interface ICloudbaseGetFileInfoResult {
+    fileList: ICloudbaseGetFileInfoResultItem[]
+    requestId: string
+  }
+
+  // ---- Supabase-like Storage Types ----
+
+  type FileBody =
+    | ArrayBuffer
+    | ArrayBufferView
+    | Blob
+    | Buffer
+    | File
+    | FormData
+    | NodeJS.ReadableStream
+    | ReadableStream<Uint8Array>
+    | URLSearchParams
+    | string
+
+  interface FileOptions {
+    cacheControl?: string
+    contentType?: string
+    upsert?: boolean
+    duplex?: string
+    metadata?: Record<string, any>
+    headers?: Record<string, string>
+  }
+
+  interface TransformOptions {
+    width?: number
+    height?: number
+    resize?: 'cover' | 'contain' | 'fill'
+    quality?: number
+    format?: 'origin'
+  }
+
+  interface FileObject {
+    name: string
+    bucket_id: string
+    owner: string
+    id: string
+    updated_at: string
+    created_at: string
+    /** @deprecated */
+    last_accessed_at: string
+    metadata: Record<string, any>
+    buckets: {
+      id: string
+      name: string
+      owner: string
+      public: boolean
+      created_at: string
+      updated_at: string
+    }
+  }
+
+  interface FileObjectV2 {
+    id: string
+    version: string
+    name: string
+    bucketId: string
+    updatedAt: string
+    createdAt: string
+    /** @deprecated */
+    lastAccessedAt: string
+    size?: number
+    cacheControl?: string
+    contentType?: string
+    etag?: string
+    lastModified?: string
+    metadata?: Record<string, any>
+  }
+
+  class StorageError extends Error {
+    name: 'StorageError'
+    constructor(message: string)
+  }
+
+  /**
+   * Supabase 风格的文件存储 API
+   *
+   * 通过 `app.storage` 获取实例，提供类似 Supabase Storage 的操作接口。
+   *
+   * @example
+   * ```typescript
+   * const app = cloudbase.init({ env: 'your-envid' })
+   * const bucket = app.storage.from('my-bucket')
+   *
+   * // 上传文件
+   * const { data, error } = await bucket.upload('path/to/file.jpg', file)
+   *
+   * // 获取签名 URL
+   * const { data } = await bucket.createSignedUrl('path/to/file.jpg', 3600)
+   *
+   * // 下载文件
+   * const { data } = await bucket.download('path/to/file.jpg')
+   * ```
+   */
+  interface SupabaseFileAPILikeStorage {
+    /**
+     * 启用错误抛出模式，而非返回 `{ data: null, error }` 格式
+     */
+    throwOnError(): this
+
+    /**
+     * 选择存储桶
+     *
+     * @param bucket 存储桶名称
+     * @returns 当前实例（链式调用）
+     *
+     * @example
+     * ```typescript
+     * const bucket = app.storage.from('my-bucket')
+     * ```
+     */
+    from(bucket?: string): this
+
+    /**
+     * 上传文件
+     *
+     * @param path 文件路径
+     * @param fileBody 文件内容
+     * @param fileOptions 上传选项
+     */
+    upload(
+      path: string,
+      fileBody: FileBody,
+      fileOptions?: FileOptions,
+    ): Promise<
+      | { data: { id: string; path: string; fullPath: string }; error: null }
+      | { data: null; error: StorageError }
+    >
+
+    /**
+     * 上传文件到已签名的 URL
+     *
+     * @param path 文件路径
+     * @param token 签名 Token
+     * @param fileBody 文件内容
+     * @param fileOptions 上传选项
+     */
+    uploadToSignedUrl(
+      path: string,
+      token: string,
+      fileBody: FileBody,
+      fileOptions?: FileOptions,
+    ): Promise<
+      | { data: { id: string; path: string; fullPath: string }; error: null }
+      | { data: null; error: StorageError }
+    >
+
+    /**
+     * 创建用于上传的签名 URL
+     *
+     * @param path 文件路径
+     */
+    createSignedUploadUrl(path: string): Promise<
+      | {
+          data: {
+            signedUrl: string
+            token: string
+            path: string
+            authorization?: string
+            id?: string
+            cosFileId?: string
+            downloadUrl?: string
+          }
+          error: null
+        }
+      | { data: null; error: StorageError }
+    >
+
+    /**
+     * 更新（覆盖）文件
+     *
+     * @param path 文件路径
+     * @param fileBody 文件内容
+     * @param fileOptions 上传选项
+     */
+    update(
+      path: string,
+      fileBody: FileBody,
+      fileOptions?: FileOptions,
+    ): Promise<
+      | { data: { id: string; path: string; fullPath: string }; error: null }
+      | { data: null; error: StorageError }
+    >
+
+    /**
+     * 移动文件（复制后删除源文件）
+     *
+     * @param fromPath 源文件路径
+     * @param toPath 目标文件路径
+     */
+    move(
+      fromPath: string,
+      toPath: string,
+    ): Promise<
+      | { data: { message: string }; error: null }
+      | { data: null; error: StorageError }
+    >
+
+    /**
+     * 复制文件
+     *
+     * @param fromPath 源文件路径
+     * @param toPath 目标文件路径
+     */
+    copy(
+      fromPath: string,
+      toPath: string,
+    ): Promise<
+      | { data: { path: string }; error: null }
+      | { data: null; error: StorageError }
+    >
+
+    /**
+     * 创建签名下载 URL
+     *
+     * @param path 文件路径
+     * @param expiresIn 有效期（秒）
+     * @param options 可选配置
+     */
+    createSignedUrl(
+      path: string,
+      expiresIn: number,
+      options?: {
+        download?: string | boolean
+        transform?: TransformOptions
+      },
+    ): Promise<
+      | { data: { signedUrl: string }; error: null }
+      | { data: null; error: StorageError }
+    >
+
+    /**
+     * 批量创建签名下载 URL
+     *
+     * @param paths 文件路径数组
+     * @param expiresIn 有效期（秒）
+     */
+    createSignedUrls(
+      paths: string[],
+      expiresIn: number,
+    ): Promise<
+      | { data: Array<{ path: string; signedUrl: string; error: string | null }>; error: null }
+      | { data: null; error: StorageError }
+    >
+
+    /**
+     * 下载文件，返回 Blob
+     *
+     * @param path 文件路径
+     * @param options 图片转换选项
+     */
+    download(
+      path: string,
+      options?: TransformOptions,
+    ): Promise<{ data: Blob; error: StorageError | null }>
+
+    /**
+     * 获取文件详细信息
+     *
+     * @param pathOrFileId 相对路径或 CloudBase fileID
+     */
+    info(pathOrFileId: string): Promise<
+      | { data: FileObjectV2; error: null }
+      | { data: null; error: StorageError }
+    >
+
+    /**
+     * 检查文件是否存在
+     *
+     * @param pathOrFileId 相对路径或 CloudBase fileID
+     */
+    exists(pathOrFileId: string): Promise<
+      | { data: boolean; error: null }
+      | { data: null; error: StorageError }
+    >
+
+    /**
+     * 获取文件的公开 URL
+     *
+     * @param path 文件路径
+     * @param options 可选配置
+     */
+    getPublicUrl(
+      path: string,
+      options?: {
+        download?: string | boolean
+        transform?: TransformOptions
+      },
+    ): Promise<
+      | { data: { publicUrl: string } }
+      | { data: null; error: StorageError }
+    >
+
+    /**
+     * 批量删除文件
+     *
+     * @param paths 文件路径数组
+     */
+    remove(paths: string[]): Promise<
+      | { data: FileObject[]; error: null }
+      | { data: null; error: StorageError }
+    >
+
+    // ---- 继承自 CloudbaseStorage 的方法 ----
+
+    uploadFile(
+      params: ICloudbaseUploadFileParams,
+      callback?: Function,
+    ): Promise<ICloudbaseUploadFileResult>
+
+    deleteFile(
+      params: ICloudbaseDeleteFileParams,
+      callback?: Function,
+    ): Promise<ICloudbaseDeleteFileResult>
+
+    getTempFileURL(
+      params: ICloudbaseGetTempFileURLParams,
+      callback?: Function,
+    ): Promise<ICloudbaseGetTempFileURLResult>
+
+    downloadFile(
+      params: ICloudbaseDownloadFileParams,
+      callback?: Function,
+    ): Promise<ICloudbaseDownloadFileResult>
+
+    getUploadMetadata(
+      params: ICloudbaseGetUploadMetadataParams,
+      callback?: Function,
+    ): Promise<ICloudbaseFileMetaDataRes>
+
+    copyFile(
+      params: ICloudbaseCopyFileParams,
+      callback?: Function,
+    ): Promise<ICloudbaseCopyFileResult>
+
+    getFileInfo(
+      params: ICloudbaseGetTempFileURLParams,
+    ): Promise<ICloudbaseGetFileInfoResult>
+  }
 }
 
 declare namespace cloudbase.database {