shcp-api-lib 1.0.0 → 1.0.1

package/dist/index.js

@@ -1027,6 +1027,183 @@ class CommonDictApi {
     }
 }
 
+// 七牛云区域上传URL映射常量
+const QINIU_UPLOAD_URLS = {
+    ECN: 'https://up.qiniup.com',
+    NCN: 'https://up-z1.qiniup.com',
+    SCN: 'https://up-z2.qiniup.com',
+    NA: 'https://up-na0.qiniup.com',
+    ASG: 'https://up-as0.qiniup.com',
+};
+// 根据区域代码获取上传URL
+function getUploadURL(code) {
+    return (code && QINIU_UPLOAD_URLS[code]) || null;
+}
+// 七牛云上传 API 类
+class _QiniuUploaderApi {
+    constructor() {
+        // 请参考demo的index.js中的initQiniu()方法，若在使用处对options进行了赋值，则此处config不需要赋默认值。init(options) 即updateConfigWithOptions(options)，会对config进行赋值
+        this.config = {
+            // bucket 所在区域。ECN, SCN, NCN, NA, ASG，分别对应七牛云的：华东，华南，华北，北美，新加坡 5 个区域
+            qiniuRegion: '',
+            // 七牛云bucket 外链前缀，外链在下载资源时用到
+            qiniuBucketURLPrefix: '',
+            // 获取uptoken方法三选一即可，执行优先级为：uptoken > uptokenURL > uptokenFunc。三选一，剩下两个置空。推荐使用uptokenURL，详情请见 README.md
+            // 由其他程序生成七牛云uptoken，然后直接写入uptoken
+            qiniuUploadToken: '',
+            // 从指定 url 通过 HTTP GET 获取 uptoken，返回的格式必须是 json 且包含 uptoken 字段，例如： {"uptoken": "0MLvWPnyy..."}
+            qiniuUploadTokenURL: '',
+            // qiniuShouldUseQiniuFileName 如果是 true，则文件的 key 由 qiniu 服务器分配（全局去重）。如果是 false，则文件的 key 使用微信自动生成的 filename。出于初代sdk用户升级后兼容问题的考虑，默认是 false。
+            // 微信自动生成的 filename较长，导致fileURL较长。推荐使用{qiniuShouldUseQiniuFileName: true} + "通过fileURL下载文件时，自定义下载名" 的组合方式。
+            // 自定义上传key 需要两个条件：1. 此处 shouldUseQiniuFileName 值为false。 2. 通过修改qiniuUploader.upload方法传入的options参数，可以进行自定义key。（请不要直接在sdk中修改options参数，修改方法请见demo的index.js）
+            // 通过fileURL下载文件时，自定义下载名，请参考：七牛云"对象存储 > 产品手册 > 下载资源 > 下载设置 > 自定义资源下载名"（https://developer.qiniu.com/kodo/manual/1659/download-setting）。本sdk在README.md的"常见问题"板块中，有"通过fileURL下载文件时，自定义下载名"使用样例。
+            qiniuShouldUseQiniuFileName: false,
+            shouldUseQiniuFileName: false,
+            fileType: '',
+        };
+    }
+    // init(options) 将七牛云相关配置初始化进本sdk
+    // 在整个程序生命周期中，只需要 init(options); 一次即可
+    // 如果需要变更七牛云配置，再次调用 init(options); 即可
+    init(options) {
+        this.updateConfigWithOptions(options);
+    }
+    // 正式上传的前置方法，做预处理，应用七牛云配置
+    async upload(filePath, suffix) {
+        if (filePath == null) {
+            throw new Error('qiniu uploader need filePath to upload');
+        }
+        const res = await this.getQiniuPolicy({
+            tenantId: '000000',
+            fileNames: (filePath.split('/').pop() || '') + '.' + suffix,
+        });
+        const result = res.data;
+        if (result) {
+            this.updateConfigWithOptions(result);
+            // 自定义上传key（即自定义上传文件名）。通过修改qiniuUploader.upload方法传入的options参数，可以进行自定义文件名称。如果options非空，则使用options中的key作为fileName
+            if (result.key) {
+                filePath = result.key;
+            }
+        }
+        if (this.config.qiniuUploadToken) {
+            return await this.doUpload(filePath);
+        }
+        else if (this.config.qiniuUploadTokenURL) {
+            const token = await this.getQiniuToken();
+            if (token) {
+                return await this.doUpload(filePath);
+            }
+        }
+        throw new Error('qiniu uploader need one of [uptoken, uptokenURL]');
+    }
+    // 更新七牛云配置
+    updateConfigWithOptions(options) {
+        if (options.region) {
+            this.config.qiniuRegion = options.region;
+        }
+        else {
+            console.error('qiniu uploader need your bucket region');
+        }
+        if (options.uptoken) {
+            this.config.qiniuUploadToken = options.uptoken;
+        }
+        else if (options.uptokenURL) {
+            this.config.qiniuUploadTokenURL = options.uptokenURL;
+        }
+        if (options.domain) {
+            this.config.qiniuBucketURLPrefix = options.domain;
+        }
+        if (options.shouldUseQiniuFileName !== undefined) {
+            this.config.qiniuShouldUseQiniuFileName = options.shouldUseQiniuFileName;
+        }
+        if (options.fileType) {
+            this.config.fileType = options.fileType;
+        }
+        if (options.uploadFile) {
+            this.config.uploadFile = options.uploadFile;
+        }
+    }
+    // 正式上传
+    async doUpload(filePath) {
+        if (this.config.qiniuUploadToken == null || this.config.qiniuUploadToken.length === 0) {
+            throw new Error('qiniu UploadToken is null, please check the init config or networking');
+        }
+        const url = getUploadURL(this.config.qiniuRegion);
+        if (!url) {
+            throw new Error('Invalid qiniu region code');
+        }
+        const fileName = filePath.split('//')[1];
+        const formData = {
+            token: this.config.qiniuUploadToken,
+        };
+        // qiniuShouldUseQiniuFileName 如果是 true，则文件的 key 由 qiniu 服务器分配（全局去重）。如果是 false，则文件的 key 使用微信自动生成的 filename。出于初代sdk用户升级后兼容问题的考虑，默认是 false。
+        if (!this.config.qiniuShouldUseQiniuFileName) {
+            formData.key = fileName;
+        }
+        const config = this.config;
+        const res = await this.config.uploadFile?.({
+            url,
+            filePath,
+            name: 'file',
+            formData,
+        });
+        const dataString = res.data;
+        //   // this if case is a compatibility with wechat server returned a charcode, but was fixed
+        //   if(res.data.hasOwnProperty('type') && res.data.type === 'Buffer'){
+        //     dataString = String.fromCharCode.apply(null, res.data.data)
+        //   }
+        const dataObject = JSON.parse(dataString);
+        // 拼接fileURL
+        const fileURL = config.qiniuBucketURLPrefix + '/' + dataObject.key;
+        const result = {
+            ...dataObject,
+            name: filePath,
+            fileURL,
+            // imageURL字段和fileURL字段重复，但本sdk不做删除，因为在最初版本使用的是imageURL。直接删除可能导致原有用户升级至新版sdk后出现异常。
+            imageURL: fileURL,
+            fileType: config.fileType,
+        };
+        return result;
+    }
+    // 获取七牛云uptoken, url为后端服务器获取七牛云uptoken接口
+    async getQiniuToken() {
+        const res = await ShcpApiSdk.request({
+            url: this.config.qiniuUploadTokenURL,
+            method: 'GET',
+        });
+        const data = res.data;
+        const token = data.uptoken;
+        if (token && token.length > 0) {
+            this.config.qiniuUploadToken = token;
+        }
+        return token || '';
+    }
+    async getQiniuPolicy(data) {
+        return ShcpApiSdk.request({
+            url: `/api/blade-resource/oss/endpoint/uptoken?tenantId=${data.tenantId}&fileNames=${data.fileNames}`,
+            method: 'POST',
+        });
+    }
+}
+const QiniuUploaderApi = new _QiniuUploaderApi();
+
+class FileApi {
+    static async uploadFileQiniu(file) {
+        if (Array.isArray(file)) {
+            return await Promise.all(file.map(async (item) => await FileApi.upload_file(item)));
+        }
+        else {
+            return await FileApi.upload_file(file);
+        }
+    }
+    static async upload_file(file) {
+        console.log(" upload_file file=", file);
+        file.url.split("/");
+        const suffix = (file.name || file.path || file.cloudPath).split(".")[1];
+        return await QiniuUploaderApi.upload(file.url, suffix);
+    }
+}
+
 class CommonRightApi {
     // 获取权益列表
     // URL: /api/shcp-healthcare/${ShcpApiSdk.getApiSuffix()}/right/list
@@ -2971,6 +3148,7 @@ exports.DeviceStatusOptions = DeviceStatusOptions;
 exports.DeviceTypeOptions = DeviceTypeOptions;
 exports.DeviceUserApi = DeviceUserApi;
 exports.DiseaseCareServiceFlowStatusOptions = DiseaseCareServiceFlowStatusOptions;
+exports.FileApi = FileApi;
 exports.FileTypeOptions = FileTypeOptions;
 exports.GenderOptions = GenderOptions;
 exports.GroupJoinTypeOptions = GroupJoinTypeOptions;