Merge branch 'master' into patch-3

Author: karlhorky

CHANGELOG.md

@@ -1,3 +1,24 @@
+1.35.0 / 2023-03-03
+==================
+
+  * fix: removing nested nulls from options passed to api, closes #581
+  * feat: add option to configure tracked analytics
+
+1.34.0 / 2023-02-13
+==================
+
+  * fix: resource_type is not optional
+  * feat: search for folders
+  * feat: support for extra_headers in upload request
+
+1.33.0 / 2022-12-15
+==================
+
+  * feat: start and end offset normalized in a transformation string
+  * feat: new config option for hiding sensitive data when logging errors
+  * feat: multiple ACLs for generate_auth_token
+  * fix: improved TS typing
+
 1.32.0 / 2022-09-14
 ==================
 

lib-es5/api.js

@@ -16,7 +16,7 @@ function deleteResourcesParams(options) {
 }
 
 function getResourceParams(options) {
-  return pickOnlyExistingValues(options, "exif", "cinemagraph_analysis", "colors", "derived_next_cursor", "faces", "image_metadata", "pages", "phash", "coordinates", "max_results", "versions", "accessibility_analysis");
+  return pickOnlyExistingValues(options, "exif", "cinemagraph_analysis", "colors", "derived_next_cursor", "faces", "image_metadata", "media_metadata", "pages", "phash", "coordinates", "max_results", "versions", "accessibility_analysis");
 }
 
 exports.ping = function ping(callback) {
@@ -183,6 +183,9 @@ exports.update = function update(public_id, callback) {
   if (options.moderation_status != null) {
     params.moderation_status = options.moderation_status;
   }
+  if (options.clear_invalid !== null) {
+    params.clear_invalid = options.clear_invalid;
+  }
   return call_api("post", uri, params, callback, options);
 };
 
@@ -541,6 +544,13 @@ exports.search = function search(params, callback) {
   return call_api("post", "resources/search", params, callback, options);
 };
 
+exports.search_folders = function search_folders(params, callback) {
+  var options = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
+
+  options.content_type = 'json';
+  return call_api("post", "folders/search", params, callback, options);
+};
+
 exports.update_resources_access_mode_by_prefix = function update_resources_access_mode_by_prefix(access_mode, prefix, callback) {
   var options = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : {};
 

lib-es5/api_client/execute_request.js

@@ -1,5 +1,7 @@
 'use strict';
 
+var _extends = Object.assign || function (target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i]; for (var key in source) { if (Object.prototype.hasOwnProperty.call(source, key)) { target[key] = source[key]; } } } return target; };
+
 // eslint-disable-next-line import/order
 var config = require("../config");
 var https = /^http:/.test(config().upload_prefix) ? require('http') : require('https');
@@ -74,6 +76,21 @@ function execute_request(method, params, auth, api_url, callback) {
     request_options.headers['Content-Length'] = Buffer.byteLength(query_params);
   }
   handle_response = function handle_response(res) {
+    var _config = config(),
+        _config$hide_sensitiv = _config.hide_sensitive,
+        hide_sensitive = _config$hide_sensitiv === undefined ? false : _config$hide_sensitiv;
+
+    var sanitizedOptions = _extends({}, request_options);
+
+    if (hide_sensitive === true) {
+      if ("auth" in sanitizedOptions) {
+        delete sanitizedOptions.auth;
+      }
+      if ("Authorization" in sanitizedOptions.headers) {
+        delete sanitizedOptions.headers.Authorization;
+      }
+    }
+
     if (includes([200, 400, 401, 403, 404, 409, 420, 500], res.statusCode)) {
       var buffer = "";
       var error = false;
@@ -106,7 +123,7 @@ function execute_request(method, params, auth, api_url, callback) {
 
         if (result.error) {
           deferred.reject(Object.assign({
-            request_options,
+            request_options: sanitizedOptions,
             query_params
           }, result));
         } else {
@@ -122,7 +139,7 @@ function execute_request(method, params, auth, api_url, callback) {
           error: {
             message: e,
             http_code: res.statusCode,
-            request_options,
+            request_options: sanitizedOptions,
             query_params
           }
         };
@@ -136,7 +153,7 @@ function execute_request(method, params, auth, api_url, callback) {
         error: {
           message: "Server returned unexpected status code - " + res.statusCode,
           http_code: res.statusCode,
-          request_options,
+          request_options: sanitizedOptions,
           query_params
         }
       };

lib-es5/auth_token.js

@@ -35,7 +35,7 @@ function escapeToLower(url) {
  * @property {number} start_time=now The start time of the token in seconds from epoch.
  * @property {string} expiration The expiration time of the token in seconds from epoch.
  * @property {string} duration The duration of the token (from start_time).
- * @property {string} acl The ACL for the token.
+ * @property {string|Array<string>} acl The ACL(s) for the token.
  * @property {string} url The URL to authentication in case of a URL token.
  *
  */
@@ -65,6 +65,9 @@ module.exports = function (options) {
   }
   tokenParts.push(`exp=${options.expiration}`);
   if (options.acl != null) {
+    if (Array.isArray(options.acl) === true) {
+      options.acl = options.acl.join("!");
+    }
     tokenParts.push(`acl=${escapeToLower(options.acl)}`);
   }
   var toSign = [].concat(tokenParts);

lib-es5/uploader.js

@@ -269,7 +269,9 @@ exports.rename = function rename(from_public_id, to_public_id, callback) {
       to_public_id: to_public_id,
       overwrite: options.overwrite,
       invalidate: options.invalidate,
-      to_type: options.to_type
+      to_type: options.to_type,
+      context: options.context,
+      metadata: options.metadata
     }];
   });
 };
@@ -662,6 +664,9 @@ function post(url, post_data, boundary, file, callback, options) {
   if (options.x_unique_upload_id != null) {
     headers['X-Unique-Upload-Id'] = options.x_unique_upload_id;
   }
+  if (options.extra_headers !== null) {
+    headers = merge(headers, options.extra_headers);
+  }
   if (oauth_token != null) {
     headers.Authorization = `Bearer ${oauth_token}`;
   }
@@ -811,7 +816,8 @@ exports.update_metadata = function update_metadata(metadata, public_ids, callbac
       metadata: utils.encode_context(metadata),
       public_ids: utils.build_array(public_ids),
       timestamp: utils.timestamp(),
-      type: options.type
+      type: options.type,
+      clear_invalid: options.clear_invalid
     };
     return [params];
   });

lib-es5/utils/index.js

@@ -367,6 +367,7 @@ function build_upload_params(options) {
     format: options.format,
     filename_override: options.filename_override,
     image_metadata: utils.as_safe_bool(options.image_metadata),
+    media_metadata: utils.as_safe_bool(options.media_metadata),
     invalidate: utils.as_safe_bool(options.invalidate),
     moderation: options.moderation,
     notification_url: options.notification_url,
@@ -567,6 +568,12 @@ function generate_transformation_string(options) {
     options.start_offset = _split_range2[0];
     options.end_offset = _split_range2[1];
   }
+  if (options.start_offset) {
+    options.start_offset = normalize_expression(options.start_offset);
+  }
+  if (options.end_offset) {
+    options.end_offset = normalize_expression(options.end_offset);
+  }
   var overlay = process_layer(consumeOption(options, "overlay"));
   var radius = process_radius(consumeOption(options, "radius"));
   var underlay = process_layer(consumeOption(options, "underlay"));
@@ -893,7 +900,17 @@ function url(public_id) {
   var urlAnalytics = ensureOption(options, 'urlAnalytics', false);
 
   if (urlAnalytics === true) {
-    var sdkVersions = getSDKVersions();
+    var _getSDKVersions = getSDKVersions(),
+        sdkCode = _getSDKVersions.sdkCode,
+        sdkSemver = _getSDKVersions.sdkSemver,
+        techVersion = _getSDKVersions.techVersion;
+
+    var sdkVersions = {
+      sdkCode: ensureOption(options, 'sdkCode', sdkCode),
+      sdkSemver: ensureOption(options, 'sdkSemver', sdkSemver),
+      techVersion: ensureOption(options, 'techVersion', techVersion)
+    };
+
     var analyticsOptions = getAnalyticsOptions(Object.assign({}, options, sdkVersions));
 
     var sdkAnalyticsSignature = getSDKAnalyticsSignature(analyticsOptions);
@@ -903,7 +920,7 @@ function url(public_id) {
     if (resultUrl.indexOf('?') >= 0) {
       appender = '&';
     }
-    resultUrl = `${resultUrl}${appender}_s=${sdkAnalyticsSignature}`;
+    resultUrl = `${resultUrl}${appender}_a=${sdkAnalyticsSignature}`;
   }
 
   return resultUrl;
@@ -1105,7 +1122,9 @@ function clear_blank(hash) {
         k = _ref29[0],
         v = _ref29[1];
 
-    filtered_hash[k] = v;
+    filtered_hash[k] = v.filter ? v.filter(function (x) {
+      return x;
+    }) : v;
   });
   return filtered_hash;
 }

lib-es5/v2/api.js

@@ -55,6 +55,7 @@ v1_adapters(exports, api, {
   update_resources_access_mode_by_tag: 2,
   update_resources_access_mode_by_ids: 2,
   search: 1,
+  search_folders: 1,
   delete_derived_by_transformation: 2,
   add_metadata_field: 1,
   list_metadata_fields: 1,

lib-es5/v2/index.js

@@ -6,10 +6,12 @@ var v1 = require('../cloudinary');
 var api = require('./api');
 var uploader = require('./uploader');
 var search = require('./search');
+var search_folders = require('./search_folders');
 
 var v2 = _extends({}, v1, {
   api,
   uploader,
-  search
+  search,
+  search_folders
 });
 module.exports = v2;

lib-es5/v2/search_folders.js

@@ -0,0 +1,42 @@
+'use strict';
+
+var _createClass = function () { function defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } } return function (Constructor, protoProps, staticProps) { if (protoProps) defineProperties(Constructor.prototype, protoProps); if (staticProps) defineProperties(Constructor, staticProps); return Constructor; }; }();
+
+function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
+
+function _possibleConstructorReturn(self, call) { if (!self) { throw new ReferenceError("this hasn't been initialised - super() hasn't been called"); } return call && (typeof call === "object" || typeof call === "function") ? call : self; }
+
+function _inherits(subClass, superClass) { if (typeof superClass !== "function" && superClass !== null) { throw new TypeError("Super expression must either be null or a function, not " + typeof superClass); } subClass.prototype = Object.create(superClass && superClass.prototype, { constructor: { value: subClass, enumerable: false, writable: true, configurable: true } }); if (superClass) Object.setPrototypeOf ? Object.setPrototypeOf(subClass, superClass) : subClass.__proto__ = superClass; }
+
+var Search = require('./search');
+var api = require('./api');
+
+var SearchFolders = function (_Search) {
+  _inherits(SearchFolders, _Search);
+
+  function SearchFolders() {
+    _classCallCheck(this, SearchFolders);
+
+    return _possibleConstructorReturn(this, (SearchFolders.__proto__ || Object.getPrototypeOf(SearchFolders)).call(this));
+  }
+
+  _createClass(SearchFolders, [{
+    key: 'execute',
+    value: function execute(options, callback) {
+      if (callback === null) {
+        callback = options;
+      }
+      options = options || {};
+      return api.search_folders(this.to_query(), options, callback);
+    }
+  }], [{
+    key: 'instance',
+    value: function instance() {
+      return new SearchFolders();
+    }
+  }]);
+
+  return SearchFolders;
+}(Search);
+
+module.exports = SearchFolders;

lib/api.js

@@ -10,7 +10,7 @@ function deleteResourcesParams(options, params = {}) {
 }
 
 function getResourceParams(options) {
-  return pickOnlyExistingValues(options, "exif", "cinemagraph_analysis", "colors", "derived_next_cursor", "faces", "image_metadata", "pages", "phash", "coordinates", "max_results", "versions", "accessibility_analysis");
+  return pickOnlyExistingValues(options, "exif", "cinemagraph_analysis", "colors", "derived_next_cursor", "faces", "image_metadata", "media_metadata", "pages", "phash", "coordinates", "max_results", "versions", "accessibility_analysis");
 }
 
 exports.ping = function ping(callback, options = {}) {
@@ -131,6 +131,9 @@ exports.update = function update(public_id, callback, options = {}) {
   if (options.moderation_status != null) {
     params.moderation_status = options.moderation_status;
   }
+  if (options.clear_invalid !== null) {
+    params.clear_invalid = options.clear_invalid;
+  }
   return call_api("post", uri, params, callback, options);
 };
 
@@ -401,6 +404,11 @@ exports.search = function search(params, callback, options = {}) {
   return call_api("post", "resources/search", params, callback, options);
 };
 
+exports.search_folders = function search_folders(params, callback, options = {}) {
+  options.content_type = 'json';
+  return call_api("post", "folders/search", params, callback, options);
+};
+
 exports.update_resources_access_mode_by_prefix = function update_resources_access_mode_by_prefix(
   access_mode,
   prefix,