box-ui-elements 17.2.0-beta.2 → 17.2.0-beta.4

package/es/api/Feed.js

@@ -53,8 +53,8 @@ function _objectWithoutPropertiesLoose(source, excluded) { if (source == null) r
  * @file Helper for activity feed API's
  * @author Box
  */
-import uniqueId from 'lodash/uniqueId';
 import noop from 'lodash/noop';
+import uniqueId from 'lodash/uniqueId';
 import { getBadItemError, getBadUserError, getMissingItemTextOrStatus, isUserCorrectableError } from '../utils/error';
 import commonMessages from '../elements/common/messages';
 import messages from './messages';
@@ -64,13 +64,14 @@ import Base from './Base';
 import AnnotationsAPI from './Annotations';
 import CommentsAPI from './Comments';
 import ThreadedCommentsAPI from './ThreadedComments';
+import FileActivitiesAPI from './FileActivities';
 import VersionsAPI from './Versions';
 import TasksNewAPI from './tasks/TasksNew';
 import GroupsAPI from './Groups';
 import TaskCollaboratorsAPI from './tasks/TaskCollaborators';
 import TaskLinksAPI from './tasks/TaskLinks';
 import AppActivityAPI from './AppActivity';
-import { ERROR_CODE_CREATE_TASK, ERROR_CODE_UPDATE_TASK, ERROR_CODE_GROUP_EXCEEDS_LIMIT, FEED_ITEM_TYPE_ANNOTATION, FEED_ITEM_TYPE_COMMENT, FEED_ITEM_TYPE_TASK, HTTP_STATUS_CODE_CONFLICT, IS_ERROR_DISPLAYED, TASK_NEW_APPROVED, TASK_NEW_COMPLETED, TASK_NEW_REJECTED, TASK_NEW_NOT_STARTED, TYPED_ID_FEED_PREFIX, TASK_MAX_GROUP_ASSIGNEES } from '../constants';
+import { ERROR_CODE_CREATE_TASK, ERROR_CODE_UPDATE_TASK, ERROR_CODE_GROUP_EXCEEDS_LIMIT, FEED_ITEM_TYPE_ANNOTATION, FEED_ITEM_TYPE_COMMENT, FEED_ITEM_TYPE_TASK, FILE_ACTIVITY_TYPE_ANNOTATION, FILE_ACTIVITY_TYPE_APP_ACTIVITY, FILE_ACTIVITY_TYPE_COMMENT, FILE_ACTIVITY_TYPE_TASK, HTTP_STATUS_CODE_CONFLICT, IS_ERROR_DISPLAYED, TASK_NEW_APPROVED, TASK_NEW_COMPLETED, TASK_NEW_REJECTED, TASK_NEW_NOT_STARTED, TYPED_ID_FEED_PREFIX, TASK_MAX_GROUP_ASSIGNEES } from '../constants';
 var TASK_NEW_INITIAL_STATUS = TASK_NEW_NOT_STARTED;
 
 var getItemWithFilteredReplies = function getItemWithFilteredReplies(item, replyId) {
@@ -96,6 +97,114 @@ var getItemWithPendingReply = function getItemWithPendingReply(item, reply) {
   }, rest);
 };
 
+var parseReplies = function parseReplies(replies) {
+  var parsedReplies = _toConsumableArray(replies);
+
+  return parsedReplies.map(function (reply) {
+    return _objectSpread({}, reply, {
+      tagged_message: reply.tagged_message || reply.message || ''
+    });
+  });
+};
+
+export var getParsedFileActivitiesResponse = function getParsedFileActivitiesResponse(response) {
+  if (!response || !response.entries || !response.entries.length) {
+    return {
+      entries: []
+    };
+  }
+
+  var data = response.entries;
+  var parsedData = data.map(function (item) {
+    if (!item.source) {
+      return null;
+    }
+
+    var source = _objectSpread({}, item.source);
+
+    switch (item.activity_type) {
+      case FILE_ACTIVITY_TYPE_TASK:
+        {
+          var _taskItem$assigned_to;
+
+          var taskItem = _objectSpread({}, source[FILE_ACTIVITY_TYPE_TASK]); // UAA follows a lowercased enum naming convention, convert to uppercase to align with task api
+
+
+          if ((_taskItem$assigned_to = taskItem.assigned_to) === null || _taskItem$assigned_to === void 0 ? void 0 : _taskItem$assigned_to.entries) {
+            var assignedToEntries = taskItem.assigned_to.entries.map(function (entry) {
+              var assignedToEntry = _objectSpread({}, entry);
+
+              assignedToEntry.role = entry.role.toUpperCase();
+              assignedToEntry.status = entry.status.toUpperCase();
+              return assignedToEntry;
+            }); // $FlowFixMe Using the toUpperCase method makes Flow assume role and status is a string type, which is incompatible with string literal
+
+            taskItem.assigned_to.entries = assignedToEntries;
+          }
+
+          if (taskItem.completion_rule) {
+            taskItem.completion_rule = taskItem.completion_rule.toUpperCase();
+          }
+
+          if (taskItem.status) {
+            taskItem.status = taskItem.status.toUpperCase();
+          }
+
+          if (taskItem.task_type) {
+            taskItem.task_type = taskItem.task_type.toUpperCase();
+          } // $FlowFixMe File Activities only returns a created_by user, Flow type fix is needed
+
+
+          taskItem.created_by = {
+            target: taskItem.created_by
+          };
+          return taskItem;
+        }
+
+      case FILE_ACTIVITY_TYPE_COMMENT:
+        {
+          var commentItem = _objectSpread({}, source[FILE_ACTIVITY_TYPE_COMMENT]);
+
+          if (commentItem.replies && commentItem.replies.length) {
+            var replies = parseReplies(commentItem.replies);
+            commentItem.replies = replies;
+          }
+
+          commentItem.tagged_message = commentItem.tagged_message || commentItem.message || '';
+          return commentItem;
+        }
+
+      case FILE_ACTIVITY_TYPE_ANNOTATION:
+        {
+          var annotationItem = _objectSpread({}, source[FILE_ACTIVITY_TYPE_ANNOTATION]);
+
+          if (annotationItem.replies && annotationItem.replies.length) {
+            var _replies = parseReplies(annotationItem.replies);
+
+            annotationItem.replies = _replies;
+          }
+
+          return annotationItem;
+        }
+
+      case FILE_ACTIVITY_TYPE_APP_ACTIVITY:
+        {
+          return _objectSpread({}, source[FILE_ACTIVITY_TYPE_APP_ACTIVITY]);
+        }
+
+      default:
+        {
+          return null;
+        }
+    }
+  }).filter(function (item) {
+    return !!item;
+  });
+  return {
+    entries: parsedData
+  };
+};
+
 var Feed =
 /*#__PURE__*/
 function (_Base) {
@@ -133,6 +242,10 @@ function (_Base) {
    * @property {ThreadedCommentsAPI}
    */
 
+  /**
+   * @property {FileActivitiesAPI}
+   */
+
   /**
    * @property {BoxItem}
    */
@@ -1332,7 +1445,9 @@ function (_Base) {
           _ref5$shouldShowTasks = _ref5.shouldShowTasks,
           shouldShowTasks = _ref5$shouldShowTasks === void 0 ? true : _ref5$shouldShowTasks,
           _ref5$shouldShowVersi = _ref5.shouldShowVersions,
-          shouldShowVersions = _ref5$shouldShowVersi === void 0 ? true : _ref5$shouldShowVersi;
+          shouldShowVersions = _ref5$shouldShowVersi === void 0 ? true : _ref5$shouldShowVersi,
+          _ref5$shouldUseUAA = _ref5.shouldUseUAA,
+          shouldUseUAA = _ref5$shouldUseUAA === void 0 ? false : _ref5$shouldUseUAA;
 
       var id = file.id,
           _file$permissions = file.permissions,
@@ -1356,32 +1471,66 @@ function (_Base) {
 
       this.file = file;
       this.errors = [];
-      this.errorCallback = onError;
-      var annotationsPromise = shouldShowAnnotations ? this.fetchAnnotations(permissions, shouldShowReplies) : Promise.resolve();
+      this.errorCallback = onError; // Using the UAA File Activities endpoint replaces the need for these calls
+
+      var annotationsPromise = !shouldUseUAA && shouldShowAnnotations ? this.fetchAnnotations(permissions, shouldShowReplies) : Promise.resolve();
+
+      var commentsPromise = function commentsPromise() {
+        if (shouldUseUAA) {
+          return Promise.resolve();
+        }
+
+        return shouldShowReplies ? _this2.fetchThreadedComments(permissions) : _this2.fetchComments(permissions);
+      };
+
+      var tasksPromise = !shouldUseUAA && shouldShowTasks ? this.fetchTasksNew() : Promise.resolve();
+      var appActivityPromise = !shouldUseUAA && shouldShowAppActivity ? this.fetchAppActivity(permissions) : Promise.resolve();
       var versionsPromise = shouldShowVersions ? this.fetchVersions() : Promise.resolve();
       var currentVersionPromise = shouldShowVersions ? this.fetchCurrentVersion() : Promise.resolve();
-      var commentsPromise = shouldShowReplies ? this.fetchThreadedComments(permissions) : this.fetchComments(permissions);
-      var tasksPromise = shouldShowTasks ? this.fetchTasksNew() : Promise.resolve();
-      var appActivityPromise = shouldShowAppActivity ? this.fetchAppActivity(permissions) : Promise.resolve();
-      Promise.all([versionsPromise, currentVersionPromise, commentsPromise, tasksPromise, appActivityPromise, annotationsPromise]).then(function (_ref6) {
-        var _ref7 = _toArray(_ref6),
-            versions = _ref7[0],
-            currentVersion = _ref7[1],
-            feedItems = _ref7.slice(2);
-
-        var versionsWithCurrent = currentVersion ? _this2.versionsAPI.addCurrentVersion(currentVersion, versions, _this2.file) : undefined;
-        var sortedFeedItems = sortFeedItems.apply(void 0, [versionsWithCurrent].concat(_toConsumableArray(feedItems)));
+      var fileActivitiesPromise = shouldUseUAA ? this.fetchFileActivities(permissions, [FILE_ACTIVITY_TYPE_ANNOTATION, FILE_ACTIVITY_TYPE_APP_ACTIVITY, FILE_ACTIVITY_TYPE_COMMENT, FILE_ACTIVITY_TYPE_TASK]) : Promise.resolve();
 
+      var handleFeedItems = function handleFeedItems(feedItems) {
         if (!_this2.isDestroyed()) {
-          _this2.setCachedItems(id, sortedFeedItems);
+          _this2.setCachedItems(id, feedItems);
 
           if (_this2.errors.length) {
-            errorCallback(sortedFeedItems, _this2.errors);
+            errorCallback(feedItems, _this2.errors);
           } else {
-            successCallback(sortedFeedItems);
+            successCallback(feedItems);
           }
         }
-      });
+      };
+
+      if (shouldUseUAA) {
+        Promise.all([versionsPromise, currentVersionPromise, fileActivitiesPromise]).then(function (_ref6) {
+          var _ref7 = _toArray(_ref6),
+              versions = _ref7[0],
+              currentVersion = _ref7[1],
+              feedItems = _ref7.slice(2);
+
+          if (!feedItems || !feedItems.length) {
+            return;
+          }
+
+          var fileActivitiesResponse = feedItems[0];
+          var versionsWithCurrent = currentVersion ? _this2.versionsAPI.addCurrentVersion(currentVersion, versions, _this2.file) : undefined;
+          var parsedFeedItems = getParsedFileActivitiesResponse(fileActivitiesResponse); // $FlowFixMe Does not need to be sorted once we include versions in the file activities call
+
+          var sortedFeedItems = sortFeedItems(versionsWithCurrent, parsedFeedItems);
+          handleFeedItems(sortedFeedItems);
+        });
+      } else {
+        Promise.all([versionsPromise, currentVersionPromise, commentsPromise(), tasksPromise, appActivityPromise, annotationsPromise]).then(function (_ref8) {
+          var _ref9 = _toArray(_ref8),
+              versions = _ref9[0],
+              currentVersion = _ref9[1],
+              feedItems = _ref9.slice(2);
+
+          var versionsWithCurrent = currentVersion ? _this2.versionsAPI.addCurrentVersion(currentVersion, versions, _this2.file) : undefined;
+          var sortedFeedItems = sortFeedItems.apply(void 0, [versionsWithCurrent].concat(_toConsumableArray(feedItems)));
+          handleFeedItems(sortedFeedItems);
+        });
+      }
     })
   }, {
     key: "fetchAnnotations",
@@ -1474,6 +1623,30 @@ function (_Base) {
         });
       });
     }
+    /**
+     * Fetches the file activities for a file
+     *
+     * @param {BoxItemPermission} permissions - the file permissions
+     * @param {FileActivityTypes[]} activityTypes - the activity types to filter by
+     * @return {Promise} - the file comments
+     */
+
+  }, {
+    key: "fetchFileActivities",
+    value: function fetchFileActivities(permissions, activityTypes) {
+      var _this7 = this;
+
+      this.fileActivitiesAPI = new FileActivitiesAPI(this.options);
+      return new Promise(function (resolve) {
+        _this7.fileActivitiesAPI.getActivities({
+          errorCallback: _this7.fetchFeedItemErrorCallback.bind(_this7, resolve),
+          fileID: _this7.file.id,
+          permissions: permissions,
+          successCallback: resolve,
+          activityTypes: activityTypes
+        });
+      });
+    }
     /**
      * Fetches replies (comments) of a comment or annotation
      *
@@ -1488,7 +1661,7 @@ function (_Base) {
   }, {
     key: "fetchReplies",
     value: function fetchReplies(file, commentFeedItemId, commentFeedItemType, successCallback, errorCallback) {
-      var _this7 = this;
+      var _this8 = this;
 
       var id = file.id,
           permissions = file.permissions;
@@ -1503,10 +1676,10 @@ function (_Base) {
         isRepliesLoading: true
       }, commentFeedItemId);
 
-      var successCallbackFn = function successCallbackFn(_ref8) {
-        var entries = _ref8.entries;
+      var successCallbackFn = function successCallbackFn(_ref10) {
+        var entries = _ref10.entries;
 
-        _this7.updateFeedItem({
+        _this8.updateFeedItem({
           isRepliesLoading: false,
           replies: entries,
           total_reply_count: entries.length
@@ -1516,7 +1689,7 @@ function (_Base) {
       };
 
       var errorCallbackFn = function errorCallbackFn(error, code) {
-        _this7.fetchRepliesErrorCallback(error, code, commentFeedItemId);
+        _this8.fetchRepliesErrorCallback(error, code, commentFeedItemId);
       };
 
       if (commentFeedItemType === FEED_ITEM_TYPE_ANNOTATION) {
@@ -1542,11 +1715,11 @@ function (_Base) {
   }, {
     key: "fetchVersions",
     value: function fetchVersions() {
-      var _this8 = this;
+      var _this9 = this;
 
       this.versionsAPI = new VersionsAPI(this.options);
       return new Promise(function (resolve) {
-        _this8.versionsAPI.getVersions(_this8.file.id, resolve, _this8.fetchFeedItemErrorCallback.bind(_this8, resolve), undefined, undefined, FEED_FILE_VERSIONS_FIELDS_TO_FETCH);
+        _this9.versionsAPI.getVersions(_this9.file.id, resolve, _this9.fetchFeedItemErrorCallback.bind(_this9, resolve), undefined, undefined, FEED_FILE_VERSIONS_FIELDS_TO_FETCH);
       });
     }
     /**
@@ -1558,14 +1731,14 @@ function (_Base) {
   }, {
     key: "fetchCurrentVersion",
     value: function fetchCurrentVersion() {
-      var _this9 = this;
+      var _this10 = this;
 
       this.versionsAPI = new VersionsAPI(this.options);
       return new Promise(function (resolve) {
-        var _this9$file$file_vers = _this9.file.file_version,
-            file_version = _this9$file$file_vers === void 0 ? {} : _this9$file$file_vers;
+        var _this10$file$file_ver = _this10.file.file_version,
+            file_version = _this10$file$file_ver === void 0 ? {} : _this10$file$file_ver;
 
-        _this9.versionsAPI.getVersion(_this9.file.id, file_version.id, resolve, _this9.fetchFeedItemErrorCallback.bind(_this9, resolve));
+        _this10.versionsAPI.getVersion(_this10.file.id, file_version.id, resolve, _this10.fetchFeedItemErrorCallback.bind(_this10, resolve));
       });
     }
     /**
@@ -1577,17 +1750,17 @@ function (_Base) {
   }, {
     key: "fetchTasksNew",
     value: function fetchTasksNew() {
-      var _this10 = this;
+      var _this11 = this;
 
       this.tasksNewAPI = new TasksNewAPI(this.options);
       return new Promise(function (resolve) {
-        _this10.tasksNewAPI.getTasksForFile({
+        _this11.tasksNewAPI.getTasksForFile({
           file: {
-            id: _this10.file.id
+            id: _this11.file.id
           },
           successCallback: resolve,
           errorCallback: function errorCallback(err, code) {
-            return _this10.fetchFeedItemErrorCallback(resolve, err, code);
+            return _this11.fetchFeedItemErrorCallback(resolve, err, code);
           }
         });
       });
@@ -1635,7 +1808,7 @@ function (_Base) {
      * @return {Promise<TaskAssignment>}
      */
     value: function createTaskCollaboratorsforGroup(file, task, assignee) {
-      var _this11 = this;
+      var _this12 = this;
 
       if (!file.id) {
         throw getBadItemError();
@@ -1643,9 +1816,9 @@ function (_Base) {
 
       this.file = file;
       return new Promise(function (resolve, reject) {
-        var taskCollaboratorsAPI = new TaskCollaboratorsAPI(_this11.options);
+        var taskCollaboratorsAPI = new TaskCollaboratorsAPI(_this12.options);
 
-        _this11.taskCollaboratorsAPI.push(taskCollaboratorsAPI);
+        _this12.taskCollaboratorsAPI.push(taskCollaboratorsAPI);
 
         taskCollaboratorsAPI.createTaskCollaboratorsforGroup({
           file: file,
@@ -1671,7 +1844,7 @@ function (_Base) {
   }, {
     key: "createTaskCollaborator",
     value: function createTaskCollaborator(file, task, assignee) {
-      var _this12 = this;
+      var _this13 = this;
 
       if (!file.id) {
         throw getBadItemError();
@@ -1679,9 +1852,9 @@ function (_Base) {
 
       this.file = file;
       return new Promise(function (resolve, reject) {
-        var taskCollaboratorsAPI = new TaskCollaboratorsAPI(_this12.options);
+        var taskCollaboratorsAPI = new TaskCollaboratorsAPI(_this13.options);
 
-        _this12.taskCollaboratorsAPI.push(taskCollaboratorsAPI);
+        _this13.taskCollaboratorsAPI.push(taskCollaboratorsAPI);
 
         taskCollaboratorsAPI.createTaskCollaborator({
           file: file,
@@ -1707,7 +1880,7 @@ function (_Base) {
   }, {
     key: "deleteTaskCollaborator",
     value: function deleteTaskCollaborator(file, task, assignee) {
-      var _this13 = this;
+      var _this14 = this;
 
       if (!file.id) {
         throw getBadItemError();
@@ -1715,9 +1888,9 @@ function (_Base) {
 
       this.file.id = file.id;
       return new Promise(function (resolve, reject) {
-        var taskCollaboratorsAPI = new TaskCollaboratorsAPI(_this13.options);
+        var taskCollaboratorsAPI = new TaskCollaboratorsAPI(_this14.options);
 
-        _this13.taskCollaboratorsAPI.push(taskCollaboratorsAPI);
+        _this14.taskCollaboratorsAPI.push(taskCollaboratorsAPI);
 
         taskCollaboratorsAPI.deleteTaskCollaborator({
           file: file,
@@ -1744,7 +1917,7 @@ function (_Base) {
   }, {
     key: "createTaskLink",
     value: function createTaskLink(file, task) {
-      var _this14 = this;
+      var _this15 = this;
 
       if (!file.id) {
         throw getBadItemError();
@@ -1752,9 +1925,9 @@ function (_Base) {
 
       this.file = file;
       return new Promise(function (resolve, reject) {
-        var taskLinksAPI = new TaskLinksAPI(_this14.options);
+        var taskLinksAPI = new TaskLinksAPI(_this15.options);
 
-        _this14.taskLinksAPI.push(taskLinksAPI);
+        _this15.taskLinksAPI.push(taskLinksAPI);
 
         taskLinksAPI.createTaskLink({
           file: file,
@@ -1817,7 +1990,7 @@ function (_Base) {
      * @return {void}
      */
     value: function createReply(file, currentUser, parentId, parentType, text, successCallback, errorCallback) {
-      var _this15 = this;
+      var _this16 = this;
 
       var id = file.id,
           permissions = file.permissions;
@@ -1838,11 +2011,11 @@ function (_Base) {
       this.modifyFeedItemRepliesCountBy(parentId, 1);
 
       var successCallbackFn = function successCallbackFn(comment) {
-        _this15.createReplySuccessCallback(comment, parentId, uuid, successCallback);
+        _this16.createReplySuccessCallback(comment, parentId, uuid, successCallback);
       };
 
       var errorCallbackFn = function errorCallbackFn(error, code) {
-        _this15.createReplyErrorCallback(error, code, parentId, uuid);
+        _this16.createReplyErrorCallback(error, code, parentId, uuid);
       };
 
       if (parentType === FEED_ITEM_TYPE_ANNOTATION) {
@@ -1903,11 +2076,11 @@ function (_Base) {
   }, {
     key: "fetchAppActivity",
     value: function fetchAppActivity(permissions) {
-      var _this16 = this;
+      var _this17 = this;
 
       this.appActivityAPI = new AppActivityAPI(this.options);
       return new Promise(function (resolve) {
-        _this16.appActivityAPI.getAppActivity(_this16.file.id, permissions, resolve, _this16.fetchFeedItemErrorCallback.bind(_this16, resolve));
+        _this17.appActivityAPI.getAppActivity(_this17.file.id, permissions, resolve, _this17.fetchFeedItemErrorCallback.bind(_this17, resolve));
       });
     }
     /**