Merge pull request #621 from cloudinary/basic-asset-relations-api

feat: basic asset relations api

Author: cloudinary-pkoniu

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", "media_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", 'related', 'related_next_cursor');
 }
 
 exports.ping = function ping(callback) {
@@ -242,6 +242,50 @@ exports.delete_all_resources = function delete_all_resources(callback) {
   }), callback, options);
 };
 
+var createRelationParams = function createRelationParams() {
+  var publicIds = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : [];
+
+  return {
+    assets_to_relate: Array.isArray(publicIds) ? publicIds : [publicIds]
+  };
+};
+
+var deleteRelationParams = function deleteRelationParams() {
+  var publicIds = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : [];
+
+  return {
+    assets_to_unrelate: Array.isArray(publicIds) ? publicIds : [publicIds]
+  };
+};
+
+exports.add_related_assets = function (publicId, assetsToRelate, callback) {
+  var options = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : {};
+
+  var params = createRelationParams(assetsToRelate);
+  return call_api('post', ['resources', 'related_assets', options.resource_type, options.type, publicId], params, callback, options);
+};
+
+exports.add_related_assets_by_asset_id = function (assetId, assetsToRelate, callback) {
+  var options = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : {};
+
+  var params = createRelationParams(assetsToRelate);
+  return call_api('post', ['resources', 'related_assets', assetId], params, callback, options);
+};
+
+exports.delete_related_assets = function (publicId, assetsToUnrelate, callback) {
+  var options = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : {};
+
+  var params = deleteRelationParams(assetsToUnrelate);
+  return call_api('delete', ['resources', 'related_assets', options.resource_type, options.type, publicId], params, callback, options);
+};
+
+exports.delete_related_assets_by_asset_id = function (assetId, assetsToUnrelate, callback) {
+  var options = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : {};
+
+  var params = deleteRelationParams(assetsToUnrelate);
+  return call_api('delete', ['resources', 'related_assets', assetId], params, callback, options);
+};
+
 exports.delete_derived_resources = function delete_derived_resources(derived_resource_ids, callback) {
   var options = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
 
@@ -748,7 +792,10 @@ exports.order_metadata_field_datasource = function order_metadata_field_datasour
   var options = arguments.length > 4 && arguments[4] !== undefined ? arguments[4] : {};
 
   options.content_type = "json";
-  var params = { order_by: sort_by, direction: direction };
+  var params = {
+    order_by: sort_by,
+    direction: direction
+  };
   return call_api("post", ["metadata_fields", field_external_id, "datasource", "order"], params, callback, options);
 };
 
@@ -766,7 +813,10 @@ exports.reorder_metadata_fields = function reorder_metadata_fields(order_by, dir
   var options = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : {};
 
   options.content_type = "json";
-  var params = { order_by, direction };
+  var params = {
+    order_by,
+    direction
+  };
   return call_api("put", ["metadata_fields", "order"], params, callback, options);
 };
 

lib-es5/v2/api.js

@@ -70,5 +70,9 @@ v1_adapters(exports, api, {
   list_metadata_rules: 1,
   add_metadata_rule: 1,
   delete_metadata_rule: 1,
-  update_metadata_rule: 2
+  update_metadata_rule: 2,
+  add_related_assets: 2,
+  add_related_assets_by_asset_id: 2,
+  delete_related_assets: 2,
+  delete_related_assets_by_asset_id: 2
 });

lib/api.js

@@ -1,7 +1,10 @@
 const utils = require("./utils");
 const call_api = require("./api_client/call_api");
 
-const { extend, pickOnlyExistingValues } = utils;
+const {
+  extend,
+  pickOnlyExistingValues
+} = utils;
 
 const TRANSFORMATIONS_URI = "transformations";
 
@@ -10,7 +13,7 @@ function deleteResourcesParams(options, params = {}) {
 }
 
 function getResourceParams(options) {
-  return pickOnlyExistingValues(options, "exif", "cinemagraph_analysis", "colors", "derived_next_cursor", "faces", "image_metadata", "media_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", 'related', 'related_next_cursor');
 }
 
 exports.ping = function ping(callback, options = {}) {
@@ -175,6 +178,38 @@ exports.delete_all_resources = function delete_all_resources(callback, options =
   }), callback, options);
 };
 
+const createRelationParams = (publicIds = []) => {
+  return {
+    assets_to_relate: Array.isArray(publicIds) ? publicIds : [publicIds]
+  };
+};
+
+const deleteRelationParams = (publicIds = []) => {
+  return {
+    assets_to_unrelate: Array.isArray(publicIds) ? publicIds : [publicIds]
+  };
+};
+
+exports.add_related_assets = (publicId, assetsToRelate, callback, options = {}) => {
+  const params = createRelationParams(assetsToRelate);
+  return call_api('post', ['resources', 'related_assets', options.resource_type, options.type, publicId], params, callback, options);
+};
+
+exports.add_related_assets_by_asset_id = (assetId, assetsToRelate, callback, options = {}) => {
+  const params = createRelationParams(assetsToRelate);
+  return call_api('post', ['resources', 'related_assets', assetId], params, callback, options);
+};
+
+exports.delete_related_assets = (publicId, assetsToUnrelate, callback, options = {}) => {
+  const params = deleteRelationParams(assetsToUnrelate);
+  return call_api('delete', ['resources', 'related_assets', options.resource_type, options.type, publicId], params, callback, options);
+};
+
+exports.delete_related_assets_by_asset_id = (assetId, assetsToUnrelate, callback, options = {}) => {
+  const params = deleteRelationParams(assetsToUnrelate);
+  return call_api('delete', ['resources', 'related_assets', assetId], params, callback, options);
+};
+
 exports.delete_derived_resources = function delete_derived_resources(derived_resource_ids, callback, options = {}) {
   let uri;
   uri = ["derived_resources"];
@@ -235,7 +270,7 @@ exports.update_transformation = function update_transformation(transformationNam
 };
 
 exports.create_transformation = function create_transformation(name, definition, callback, options = {}) {
-  const params = { name };
+  const params = {name};
   params.transformation = utils.build_eager(definition);
   return call_api("post", TRANSFORMATIONS_URI, params, callback, options);
 };
@@ -560,7 +595,7 @@ exports.update_metadata_field_datasource = function update_metadata_field_dataso
  */
 exports.delete_datasource_entries = function delete_datasource_entries(field_external_id, entries_external_id, callback, options = {}) {
   options.content_type = "json";
-  const params = { external_ids: entries_external_id };
+  const params = {external_ids: entries_external_id};
   return call_api("delete", ["metadata_fields", field_external_id, "datasource"], params, callback, options);
 };
 
@@ -581,7 +616,7 @@ exports.delete_datasource_entries = function delete_datasource_entries(field_ext
  */
 exports.restore_metadata_field_datasource = function restore_metadata_field_datasource(field_external_id, entries_external_id, callback, options = {}) {
   options.content_type = "json";
-  const params = { external_ids: entries_external_id };
+  const params = {external_ids: entries_external_id};
   return call_api("post", ["metadata_fields", field_external_id, "datasource_restore"], params, callback, options);
 };
 
@@ -597,7 +632,10 @@ exports.restore_metadata_field_datasource = function restore_metadata_field_data
  */
 exports.order_metadata_field_datasource = function order_metadata_field_datasource(field_external_id, sort_by, direction, callback, options = {}) {
   options.content_type = "json";
-  const params = { order_by: sort_by, direction: direction};
+  const params = {
+    order_by: sort_by,
+    direction: direction
+  };
   return call_api("post", ["metadata_fields", field_external_id, "datasource", "order"], params, callback, options);
 };
 
@@ -613,7 +651,10 @@ exports.order_metadata_field_datasource = function order_metadata_field_datasour
  */
 exports.reorder_metadata_fields = function reorder_metadata_fields(order_by, direction, callback, options = {}) {
   options.content_type = "json";
-  const params = { order_by, direction };
+  const params = {
+    order_by,
+    direction
+  };
   return call_api("put", ["metadata_fields", "order"], params, callback, options);
 };
 

lib/v2/api.js

@@ -68,5 +68,9 @@ v1_adapters(exports, api, {
   list_metadata_rules: 1,
   add_metadata_rule: 1,
   delete_metadata_rule: 1,
-  update_metadata_rule: 2
+  update_metadata_rule: 2,
+  add_related_assets: 2,
+  add_related_assets_by_asset_id: 2,
+  delete_related_assets: 2,
+  delete_related_assets_by_asset_id: 2
 });