@mingto/obs-server 1.0.32

package/README.md

@@ -0,0 +1,47 @@
+`@minto-ai/obs-server` 是一款统一的 OBS 文件上传工具库，旨在简化并高效处理文件上传任务。该工具库会通过后端的 `file/config` 接口获取 OBS 配置信息，进而自动判断使用 `@minto-ai/huawei-obs-server` 还是 ` @minto-ai/aws-obs-server` 、`@minto-ai/minio-v2-obs-server` 来完成上传操作。
+
+# 安装
+
+```bash
+pnpm install @minto-ai/obs-server
+```
+
+# 使用
+
+## 示例代码
+
+```js
+import obsServer from '@minto-ai/obs-server'
+
+// 配置全局参数
+obsServer.config({
+  getToken: () => '用户的token',
+  fileSplitThreshold: 1024 * 1024 * 5
+})
+
+// 创建要上传的文件对象
+const sourceFile = new File(['hello world'], 'hello.txt', { type: 'text/plain' })
+
+// 创建上传实例
+const uploadContext = obsServer.create({
+  sourceFile,
+  onProgress: (event) => {
+    console.log(`Upload progress: ${event.percent}%`)
+  },
+  onSuccess: (event) => {
+    console.log('Upload success:', event.fileInfo)
+  }
+})
+
+// 取消上传示例
+// uploadContext.abort()
+
+```
+
+# 注意事项
+
+- 在使用该工具库时，首先会调用 `file/config` 接口来获取 OBS 的类型。
+  - 若返回值为 `aws`，则使用 `@minto-ai/aws-obs-server` 进行上传；
+  - 若返回值为 `huawei`，则使用 `@minto-ai/huawei-obs-server` 进行上传。
+  - 若返回值为 `minio`，则使用 `@minto-ai/minio-v2-obs-server` 进行上传。
+- `config` 和 `create` 等方法所需要的参数会根据具体使用的工具库（`@minto-ai/aws-obs-server` 或 `@minto-ai/huawei-obs-server` 或 `@minto-ai/minio-v2-obs-server`）来决定。请参考对应工具库的文档进行准确配置。

package/dist/index.d.ts

@@ -0,0 +1,27 @@
+import { IGlobalOptions as IGlobalOptionsAws, IUploadFileSuccessResponse as IUploadFileSuccessResponseAws, IUploadInstance as IUploadInstanceAws, IUploadOptions as IUploadOptionsAws } from '@minto-ai/aws-obs-server';
+import { IGlobalOptions as IGlobalOptionsHuawei, IUploadFileSuccessResponse as IUploadFileSuccessResponseHuawei, IUploadInstance as IUploadInstanceHuawei, IUploadOptions as IUploadOptionsHuawei } from '@minto-ai/huawei-obs-server';
+import { IGlobalOptions as IGlobalOptionsMinioV2, IUploadFileSuccessResponse as IUploadFileSuccessResponseMinioV2, IUploadInstance as IUploadInstanceMinioV2, IUploadOptions as IUploadOptionsMinioV2 } from '@minto-ai/minio-v2-server-obs';
+type IGlobalOptions = (IGlobalOptionsAws | IGlobalOptionsHuawei | IGlobalOptionsMinioV2) & {
+    obsServerType?: 'aws' | 'huawei' | 'minio' | 'auto';
+};
+type IUploadFileOptions = IUploadOptionsAws | IUploadOptionsHuawei | IUploadOptionsMinioV2;
+type IUploadInstance = IUploadInstanceAws | IUploadInstanceHuawei | IUploadInstanceMinioV2;
+type IUploadFileSuccessResponse = IUploadFileSuccessResponseAws | IUploadFileSuccessResponseHuawei | IUploadFileSuccessResponseMinioV2;
+/**
+ * OBS 服务器配置和实例管理模块。
+ */
+declare const _default: {
+    /**
+     * 配置 OBS 服务器类型。
+     * @param options - 配置选项，包括获取认证 Token 的方法。
+     */
+    config(options: IGlobalOptions): Promise<void>;
+    /**
+     * 创建并返回 OBS 服务器实例。
+     * 如果未初始化，将抛出错误。
+     * @returns OBS 服务器实例。
+     */
+    create(options: IUploadFileOptions): IUploadInstance;
+};
+export default _default;
+export type { IUploadFileSuccessResponse, IUploadInstance, };