cos-wx-sdk-v5 1.1.8 → 1.2.0

package/demo/demo-sdk.js

@@ -22,7 +22,7 @@ var getAuthorization = function(options, callback) {
             callback({
                 TmpSecretId: credentials.tmpSecretId,
                 TmpSecretKey: credentials.tmpSecretKey,
-                XCosSecurityToken: credentials.sessionToken,
+                SecurityToken: credentials.sessionToken,
                 StartTime: data.startTime, // 时间戳，单位秒，如：1580000000，建议返回服务器时间作为签名的开始时间，避免用户浏览器本地时间偏差过大导致签名错误
                 ExpiredTime: data.expiredTime, // 时间戳，单位秒，如：1580000900
             });
@@ -159,7 +159,11 @@ var toolsDao = {
                 Region: config.Region,
                 Key: file.name,
                 FilePath: file.path,
+                FileSize: file.size,
                 SliceSize: 1024 * 1024 * 5, // 文件大于5mb自动使用分块上传
+                onTaskReady: function(taskId) {
+                  TaskId = taskId
+                },
                 onProgress: function (info) {
                     var percent = parseInt(info.percent * 10000) / 100;
                     var speed = parseInt(info.speed / 1024 / 1024 * 100) / 100;
@@ -681,7 +685,7 @@ var objectDao = {
             Position: 0,
         },
         function(err, data) {
-            logger.log('putObject:', err || data);
+            console.log('putObject:', err || data);
         })
     },
     'appendObject_continue 继续追加上传': function() {
@@ -704,7 +708,7 @@ var objectDao = {
             function(err, data) {
                 // 也可以取到下一次上传的position继续追加上传
                 // var nextPosition = data.headers['x-cos-next-append-position'];
-                logger.log('putObject:', err || data);
+                console.log('putObject:', err || data);
             })
         });
     },
@@ -947,6 +951,285 @@ var ciObjectDao = {
             console.log(err || data);
         });
     },
+    '图片同步审核 getImageAuditing': function () {
+        cos.request({
+            Bucket: config.Bucket,
+            Region: config.Region,
+            Method: 'GET',
+            Key: '1.png',
+            Query: {
+                'ci-process': 'sensitive-content-recognition', /** 固定值，必须 */
+                'biz-type': '', /** 审核类型，非必须 */
+                'detect-type': 'porn,ads', /** 审核策略，不填写则使用默认策略，非必须 */
+                'detect-url': '', /** 审核任意公网可访问的图片链接，非必须 */
+                'interval': 5, /** 审核 GIF 动图时，每隔interval帧截取一帧，非必须 */
+                'max-frames': 5,  /** 审核 GIF 动图时，最大截帧数，非必须 */
+                'large-image-detect': '0', /** 是否需要压缩图片后再审核，非必须 */
+            },
+        },
+        function(err, data){
+            console.log(err || data);
+        });
+      },
+    '图片批量审核 postImagesAuditing': function () {
+        var host = config.Bucket + '.ci.' + config.Region + '.myqcloud.com';
+        var url = 'https://' + host + '/image/auditing';
+        var body = COS.util.json2xml({
+          Request: {
+            Input: [{
+              Object: '1.png',
+            }, {
+              Object: '6.png',
+            }],
+            Conf: {
+              BizType: '',
+              DetectType: 'Porn'
+            }
+          }
+        });
+        cos.request({
+            Bucket: config.Bucket,
+            Region: config.Region,
+            Method: 'POST',
+            Url: url,
+            Key: '/image/auditing',
+            ContentType: 'application/xml',
+            Body: body
+        },
+        function(err, data){
+            console.log(err || data);
+        });
+    },
+    '查询图片审核任务结果 getImageAuditingResult': function () {
+        var jobId = 'si8263213daf3711eca0d1525400d88xxx'; // jobId可以通过图片批量审核返回
+        var host = config.Bucket + '.ci.' + config.Region + '.myqcloud.com';
+        var url = 'https://' + host + '/image/auditing/' + jobId;
+        cos.request({
+            Bucket: config.Bucket,
+            Region: config.Region,
+            Method: 'GET',
+            Key: '/image/auditing/' + jobId,
+            Url: url,
+        },
+        function(err, data){
+            console.log(err || data);
+        });
+    },
+    '提交视频审核任务 postVideoAuditing': function() {
+        var host = config.Bucket + '.ci.' + config.Region + '.myqcloud.com';
+        var url = 'https://' + host + '/video/auditing';
+        var body = COS.util.json2xml({
+          Request: {
+            Input: {
+              Object: '1.mp4',
+            },
+            Conf: {
+              BizType: '',
+              DetectType: 'Porn',
+              Snapshot: {
+                Count: 1000, // 视频截帧数量
+              },
+              DetectContent: 1, // 是否审核视频声音,0-只审核视频不审核声音；1-审核视频+声音
+            }
+          }
+        });
+        cos.request({
+            Bucket: config.Bucket,
+            Region: config.Region,
+            Method: 'POST',
+            Url: url,
+            Key: '/video/auditing',
+            ContentType: 'application/xml',
+            Body: body
+        },
+        function(err, data){
+            console.log(err || data);
+        });
+    },
+    '查询视频审核任务结果 getVideoAuditingResult': function () {
+        var jobId = 'av5bd873d9f39011ecb6c95254009a49da'; // jobId可以通过提交视频审核任务返回
+        var host = config.Bucket + '.ci.' + config.Region + '.myqcloud.com';
+        var url = 'https://' + host + '/video/auditing/' + jobId;
+        cos.request({
+            Bucket: config.Bucket,
+            Region: config.Region,
+            Method: 'GET',
+            Key: '/video/auditing/' + jobId,
+            Url: url,
+        },
+        function(err, data){
+            console.log(err || data);
+        });
+    },
+    '提交音频审核任务 postAudioAuditing': function () {
+        var host = config.Bucket + '.ci.' + config.Region + '.myqcloud.com';
+        var url = 'https://' + host + '/audio/auditing';
+        var body = COS.util.json2xml({
+          Request: {
+            Input: {
+              Object: '1.mp3',
+            },
+            Conf: {
+              BizType: '',
+              DetectType: 'Porn',
+            }
+          }
+        });
+        cos.request({
+            Bucket: config.Bucket,
+            Region: config.Region,
+            Method: 'POST',
+            Url: url,
+            Key: '/audio/auditing',
+            ContentType: 'application/xml',
+            Body: body
+        },
+        function(err, data){
+            console.log(err || data);
+        });
+    },
+    '查询音频审核任务结果 getAudioAuditingResult': function () {
+        var jobId = 'sa0c28d41daff411ecb23352540078cxxx'; // jobId可以通过提交音频审核任务返回
+        var host = config.Bucket + '.ci.' + config.Region + '.myqcloud.com';
+        var url = 'https://' + host + '/audio/auditing/' + jobId;
+        cos.request({
+            Bucket: config.Bucket,
+            Region: config.Region,
+            Method: 'GET',
+            Key: '/audio/auditing/' + jobId,
+            Url: url,
+        },
+        function(err, data){
+            console.log(err || data);
+        });
+    },
+    '提交文本审核任务 postTextAuditing': function () {
+        var host = config.Bucket + '.ci.' + config.Region + '.myqcloud.com';
+        var url = 'https://' + host + '/text/auditing';
+        var body = COS.util.json2xml({
+          Request: {
+            Input: {
+              // Object: 'hello.txt', // 存在cos里的资源，审核结果异步返回，可以调用查询文本审核结果api查询
+              Content: '5Lmz5rKf', // 经过base64编码过的文本”乳沟“，查询结果同步返回
+            },
+            Conf: {
+              BizType: '',
+              DetectType: 'Porn',
+            }
+          }
+        });
+        cos.request({
+            Bucket: config.Bucket,
+            Region: config.Region,
+            Method: 'POST',
+            Url: url,
+            Key: '/text/auditing',
+            ContentType: 'application/xml',
+            Body: body
+        },
+        function(err, data){
+            console.log(err || data);
+        });
+    },
+    '查询文本审核任务结果 getTextAuditingResult': function () {
+        var jobId = 'st8d88c664aff511ecb23352540078cxxx'; // jobId可以通过提交文本审核任务返回（Input传入Object）
+        var host = config.Bucket + '.ci.' + config.Region + '.myqcloud.com';
+        var url = 'https://' + host + '/text/auditing/' + jobId;
+        cos.request({
+            Bucket: config.Bucket,
+            Region: config.Region,
+            Method: 'GET',
+            Key: '/text/auditing/' + jobId,
+            Url: url,
+        },
+        function(err, data){
+            console.log(err || data);
+        });
+    },
+    '提交文档审核任务 postDocumentAuditing': function () {
+        var host = config.Bucket + '.ci.' + config.Region + '.myqcloud.com';
+        var url = 'https://' + host + '/document/auditing';
+        var body = COS.util.json2xml({
+          Request: {
+            Input: {
+              Object: 'test.xlsx', // 存在cos里的资源，审核结果异步返回，可以调用查询文本审核结果api查询
+            },
+            Conf: {
+              BizType: '',
+              DetectType: 'Porn',
+            }
+          }
+        });
+        cos.request({
+            Bucket: config.Bucket,
+            Region: config.Region,
+            Method: 'POST',
+            Url: url,
+            Key: '/document/auditing',
+            ContentType: 'application/xml',
+            Body: body
+        },
+        function(err, data){
+            console.log(err || data);
+        });
+    },
+    '查询文档审核任务结果 getDocumentAuditingResult': function () {
+        var jobId = 'sd7815c21caff611eca12f525400d88560'; // jobId可以通过提交文档审核任务返回
+        var host = config.Bucket + '.ci.' + config.Region + '.myqcloud.com';
+        var url = 'https://' + host + '/document/auditing/' + jobId;
+        cos.request({
+            Bucket: config.Bucket,
+            Region: config.Region,
+            Method: 'GET',
+            Key: '/document/auditing/' + jobId,
+            Url: url,
+        },
+        function(err, data){
+            console.log(err || data);
+        });
+    },
+    '提交网页审核任务 postWebpageAuditing': function () {
+        var host = config.Bucket + '.ci.' + config.Region + '.myqcloud.com';
+        var url = 'https://' + host + '/webpage/auditing';
+        var body = COS.util.json2xml({
+          Request: {
+            Input: {
+              Url: 'https://cloud.tencent.com/', // 存在cos里的资源，审核结果异步返回，可以调用查询文本审核结果api查询
+            },
+            Conf: {
+              BizType: '',
+              DetectType: 'Porn,Ads',
+            }
+          }
+        });
+        cos.request({
+            Bucket: config.Bucket,
+            Region: config.Region,
+            Method: 'POST',
+            Url: url,
+            Key: '/webpage/auditing',
+            ContentType: 'application/xml',
+            Body: body
+        },
+        function(err, data){
+            console.log(err || data);
+        });
+    },
+    '查询网页审核任务结果 getWebpageAuditingResult': function () {
+        var jobId = 'shce868019aff611ecb1155254009a4xxx'; // jobId可以通过提交网页审核任务返回
+        var host = config.Bucket + '.ci.' + config.Region + '.myqcloud.com';
+        var url = 'https://' + host + '/webpage/auditing/' + jobId;
+        cos.request({
+            Bucket: config.Bucket,
+            Region: config.Region,
+            Method: 'GET',
+            Key: '/webpage/auditing/' + jobId,
+            Url: url,
+        },
+        function(err, data){
+            console.log(err || data);
+        });
+    },
 }
 
 // require('./test');

package/demo/lib/cos-wx-sdk-v5.js

@@ -646,6 +646,32 @@ var isCIHost = function isCIHost(url) {
     );
 };
 
+var error = function error(err, opt) {
+    var sourceErr = err;
+    err.message = err.message || null;
+
+    if (typeof opt === 'string') {
+        err.error = opt;
+        err.message = opt;
+    } else if ((typeof opt === 'undefined' ? 'undefined' : _typeof(opt)) === 'object' && opt !== null) {
+        extend(err, opt);
+        if (opt.code || opt.name) err.code = opt.code || opt.name;
+        if (opt.message) err.message = opt.message;
+        if (opt.stack) err.stack = opt.stack;
+    }
+
+    if (typeof Object.defineProperty === 'function') {
+        Object.defineProperty(err, 'name', { writable: true, enumerable: false });
+        Object.defineProperty(err, 'message', { enumerable: true });
+    }
+
+    err.name = opt && opt.name || err.name || err.code || 'Error';
+    if (!err.code) err.code = err.name;
+    if (!err.error) err.error = clone(sourceErr); // 兼容老的错误格式
+
+    return err;
+};
+
 var util = {
     noop: noop,
     formatParams: formatParams,
@@ -676,7 +702,8 @@ var util = {
     getAuth: getAuth,
     compareVersion: compareVersion,
     canFileSlice: canFileSlice,
-    isCIHost: isCIHost
+    isCIHost: isCIHost,
+    error: error
 };
 
 module.exports = util;
@@ -2722,7 +2749,7 @@ var advance = __webpack_require__(27);
 var defaultOptions = {
     SecretId: '',
     SecretKey: '',
-    XCosSecurityToken: '', // 使用临时密钥需要注意自行刷新 Token
+    SecurityToken: '', // 使用临时密钥需要注意自行刷新 Token
     ChunkRetryTimes: 2,
     FileParallelLimit: 3,
     ChunkParallelLimit: 3,
@@ -2784,7 +2811,7 @@ COS.util = {
     json2xml: util.json2xml
 };
 COS.getAuthorization = util.getAuth;
-COS.version = '1.1.8';
+COS.version = '1.2.0';
 
 module.exports = COS;
 
@@ -8152,6 +8179,7 @@ function postObject(params, callback) {
         headers: headers,
         qs: params.Query,
         filePath: filePath,
+        TaskId: params.TaskId,
         onProgress: onProgress
     }, function (err, data) {
         onProgress(null, true);
@@ -9164,7 +9192,7 @@ function getObjectUrl(params, callback) {
 
         var signUrl = url;
         signUrl += '?' + (AuthData.Authorization.indexOf('q-signature') > -1 ? replaceUrlParamList(AuthData.Authorization) : 'sign=' + encodeURIComponent(AuthData.Authorization));
-        AuthData.XCosSecurityToken && (signUrl += '&x-cos-security-token=' + AuthData.XCosSecurityToken);
+        AuthData.SecurityToken && (signUrl += '&x-cos-security-token=' + AuthData.SecurityToken);
         AuthData.ClientIP && (signUrl += '&clientIP=' + AuthData.ClientIP);
         AuthData.ClientUA && (signUrl += '&clientUA=' + AuthData.ClientUA);
         AuthData.Token && (signUrl += '&token=' + AuthData.Token);
@@ -9175,7 +9203,7 @@ function getObjectUrl(params, callback) {
     });
 
     if (AuthData) {
-        syncUrl += '?' + AuthData.Authorization + (AuthData.XCosSecurityToken ? '&x-cos-security-token=' + AuthData.XCosSecurityToken : '');
+        syncUrl += '?' + AuthData.Authorization + (AuthData.SecurityToken ? '&x-cos-security-token=' + AuthData.SecurityToken : '');
         queryParamsStr && (syncUrl += '&' + queryParamsStr);
     } else {
         queryParamsStr && (syncUrl += '?' + queryParamsStr);
@@ -9309,7 +9337,6 @@ var getSignHost = function getSignHost(opt) {
 
 // 异步获取签名
 function getAuthorizationAsync(params, callback) {
-
     var headers = util.clone(params.Headers);
     var headerHost = '';
     util.each(headers, function (v, k) {
@@ -9322,30 +9349,17 @@ function getAuthorizationAsync(params, callback) {
     // Host 加入签名计算
     if (!headerHost && params.SignHost && forceSignHost) headers.Host = params.SignHost;
 
-    var cb = function cb(AuthData) {
-
-        // 检查签名格式
-        var formatAllow = false;
-        var auth = AuthData.Authorization;
-        if (auth) {
-            if (auth.indexOf(' ') > -1) {
-                formatAllow = false;
-            } else if (auth.indexOf('q-sign-algorithm=') > -1 && auth.indexOf('q-ak=') > -1 && auth.indexOf('q-sign-time=') > -1 && auth.indexOf('q-key-time=') > -1 && auth.indexOf('q-url-param-list=') > -1) {
-                formatAllow = true;
-            } else {
-                try {
-                    auth = base64.atob(auth);
-                    if (auth.indexOf('a=') > -1 && auth.indexOf('k=') > -1 && auth.indexOf('t=') > -1 && auth.indexOf('r=') > -1 && auth.indexOf('b=') > -1) {
-                        formatAllow = true;
-                    }
-                } catch (e) {}
-            }
-        }
-        if (formatAllow) {
-            callback && callback(null, AuthData);
-        } else {
-            callback && callback('authorization error');
-        }
+    // 获取凭证的回调，避免用户 callback 多次
+    var cbDone = false;
+    var cb = function cb(err, AuthData) {
+        if (cbDone) return;
+        cbDone = true;
+        if (AuthData && AuthData.XCosSecurityToken && !AuthData.SecurityToken) {
+            AuthData = util.clone(AuthData);
+            AuthData.SecurityToken = AuthData.XCosSecurityToken;
+            delete AuthData.XCosSecurityToken;
+        }
+        callback && callback(err, AuthData);
     };
 
     var self = this;
@@ -9413,12 +9427,43 @@ function getAuthorizationAsync(params, callback) {
         });
         var AuthData = {
             Authorization: Authorization,
-            XCosSecurityToken: StsData.XCosSecurityToken || '',
+            SecurityToken: StsData.SecurityToken || StsData.XCosSecurityToken || '',
             Token: StsData.Token || '',
             ClientIP: StsData.ClientIP || '',
             ClientUA: StsData.ClientUA || ''
         };
-        cb(AuthData);
+        cb(null, AuthData);
+    };
+
+    var checkAuthError = function checkAuthError(AuthData) {
+        if (AuthData.Authorization) {
+            // 检查签名格式
+            var formatAllow = false;
+            var auth = AuthData.Authorization;
+            if (auth) {
+                if (auth.indexOf(' ') > -1) {
+                    formatAllow = false;
+                } else if (auth.indexOf('q-sign-algorithm=') > -1 && auth.indexOf('q-ak=') > -1 && auth.indexOf('q-sign-time=') > -1 && auth.indexOf('q-key-time=') > -1 && auth.indexOf('q-url-param-list=') > -1) {
+                    formatAllow = true;
+                } else {
+                    try {
+                        auth = atob(auth);
+                        if (auth.indexOf('a=') > -1 && auth.indexOf('k=') > -1 && auth.indexOf('t=') > -1 && auth.indexOf('r=') > -1 && auth.indexOf('b=') > -1) {
+                            formatAllow = true;
+                        }
+                    } catch (e) {}
+                }
+            }
+            if (!formatAllow) return util.error(new Error('getAuthorization callback params format error'));
+        } else {
+            if (!AuthData.TmpSecretId) return util.error(new Error('getAuthorization callback params missing "TmpSecretId"'));
+            if (!AuthData.TmpSecretKey) return util.error(new Error('getAuthorization callback params missing "TmpSecretKey"'));
+            if (!AuthData.SecurityToken && !AuthData.XCosSecurityToken) return util.error(new Error('getAuthorization callback params missing "SecurityToken"'));
+            if (!AuthData.ExpiredTime) return util.error(new Error('getAuthorization callback params missing "ExpiredTime"'));
+            if (AuthData.ExpiredTime && AuthData.ExpiredTime.toString().length !== 10) return util.error(new Error('getAuthorization callback params "ExpiredTime" should be 10 digits'));
+            if (AuthData.StartTime && AuthData.StartTime.toString().length !== 10) return util.error(new Error('getAuthorization callback params "StartTime" should be 10 StartTime'));
+        }
+        return false;
     };
 
     // 先判断是否有临时密钥
@@ -9442,14 +9487,16 @@ function getAuthorizationAsync(params, callback) {
             if (typeof AuthData === 'string') {
                 AuthData = { Authorization: AuthData };
             }
-            if (AuthData.TmpSecretId && AuthData.TmpSecretKey && AuthData.XCosSecurityToken && AuthData.ExpiredTime) {
+            var AuthError = checkAuthError(AuthData);
+            if (AuthError) return cb(AuthError);
+            if (AuthData.Authorization) {
+                cb(null, AuthData);
+            } else {
                 StsData = AuthData || {};
                 StsData.Scope = Scope;
                 StsData.ScopeKey = ScopeKey;
                 self._StsCache.push(StsData);
                 calcAuthByTmpKey();
-            } else {
-                cb(AuthData);
             }
         });
     } else if (self.options.getSTS) {
@@ -9461,8 +9508,10 @@ function getAuthorizationAsync(params, callback) {
             StsData = data || {};
             StsData.Scope = Scope;
             StsData.ScopeKey = ScopeKey;
-            StsData.TmpSecretId = StsData.SecretId;
-            StsData.TmpSecretKey = StsData.SecretKey;
+            if (!StsData.TmpSecretId) StsData.TmpSecretId = StsData.SecretId;
+            if (!StsData.TmpSecretKey) StsData.TmpSecretKey = StsData.SecretKey;
+            var AuthError = checkAuthError(StsData);
+            if (AuthError) return cb(AuthError);
             self._StsCache.push(StsData);
             calcAuthByTmpKey();
         });
@@ -9482,9 +9531,9 @@ function getAuthorizationAsync(params, callback) {
             });
             var AuthData = {
                 Authorization: Authorization,
-                XCosSecurityToken: self.options.XCosSecurityToken
+                SecurityToken: self.options.SecurityToken || self.options.XCosSecurityToken
             };
-            cb(AuthData);
+            cb(null, AuthData);
             return AuthData;
         }();
     }
@@ -9637,7 +9686,7 @@ function _submitRequest(params, callback) {
     params.AuthData.Token && (opt.headers['token'] = params.AuthData.Token);
     params.AuthData.ClientIP && (opt.headers['clientIP'] = params.AuthData.ClientIP);
     params.AuthData.ClientUA && (opt.headers['clientUA'] = params.AuthData.ClientUA);
-    params.AuthData.XCosSecurityToken && (opt.headers[token] = params.AuthData.XCosSecurityToken);
+    params.AuthData.SecurityToken && (opt.headers[token] = params.AuthData.SecurityToken);
 
     // 清理 undefined 和 null 字段
     opt.headers && (opt.headers = util.clearKey(opt.headers));