box-ui-elements 16.0.0-beta.9 → 16.0.0

package/src/api/__tests__/FileCollaborators.test.js

@@ -55,4 +55,45 @@ describe('api/FileCollaborators', () => {
             expect(fileCollaborators.successCallback).toBeCalledWith(formattedResponse);
         });
     });
+
+    describe('getCollaboratorsWithQuery', () => {
+        beforeEach(() => {
+            fileCollaborators.getFileCollaborators = jest.fn();
+        });
+
+        test.each(['', ' ', '   ', null])('should short circuit if there is no search string', string => {
+            fileCollaborators.getCollaboratorsWithQuery('file_id', jest.fn(), jest.fn(), string);
+
+            expect(fileCollaborators.getFileCollaborators).not.toBeCalled();
+        });
+
+        test('should call the file collaborators api withoutGroups', () => {
+            const searchStr = 'foo';
+            const successCb = jest.fn();
+            const errorCb = jest.fn();
+
+            fileCollaborators.getCollaboratorsWithQuery('file_id', successCb, errorCb, searchStr);
+
+            expect(fileCollaborators.getFileCollaborators).toBeCalledWith('file_id', successCb, errorCb, {
+                filter_term: searchStr,
+                include_groups: false,
+                include_uploader_collabs: false,
+            });
+        });
+
+        test('should get collaborators with groups', () => {
+            const searchStr = 'foo';
+            const includeGroups = true;
+            const successCb = jest.fn();
+            const errorCb = jest.fn();
+
+            fileCollaborators.getCollaboratorsWithQuery('file_id', successCb, errorCb, searchStr, { includeGroups });
+
+            expect(fileCollaborators.getFileCollaborators).toBeCalledWith('file_id', successCb, errorCb, {
+                filter_term: searchStr,
+                include_groups: true,
+                include_uploader_collabs: false,
+            });
+        });
+    });
 });

package/src/api/__tests__/ThreadedComments.test.js

@@ -1,3 +1,4 @@
+import cloneDeep from 'lodash/cloneDeep';
 import ThreadedComments from '../ThreadedComments';
 import {
     ERROR_CODE_CREATE_COMMENT,
@@ -7,6 +8,10 @@ import {
     ERROR_CODE_FETCH_REPLIES,
     ERROR_CODE_CREATE_REPLY,
 } from '../../constants';
+import { formatComment } from '../utils';
+import { threadedComments as mockThreadedComments } from '../fixtures';
+
+jest.mock('../utils', () => ({ formatComment: jest.fn() }));
 
 describe('api/ThreadedComments', () => {
     let threadedComments;
@@ -29,6 +34,10 @@ describe('api/ThreadedComments', () => {
         test('should return correct url for threaded comments', () => {
             expect(threadedComments.getUrl()).toBe('https://api.box.com/2.0/undoc/comments');
         });
+
+        test('should return correct url for threaded comments if fileId is given', () => {
+            expect(threadedComments.getUrl('123')).toBe('https://api.box.com/2.0/undoc/comments?file_id=123');
+        });
     });
 
     describe('getUrlForId()', () => {
@@ -43,6 +52,12 @@ describe('api/ThreadedComments', () => {
                 'https://api.box.com/2.0/undoc/comments/test/replies',
             );
         });
+
+        test('should return the correct replies url for a given threaded comment id if fileId is given', () => {
+            expect(threadedComments.getUrlWithRepliesForId('test', '123')).toBe(
+                'https://api.box.com/2.0/undoc/comments/test/replies?file_id=123',
+            );
+        });
     });
 
     describe('createComment()', () => {
@@ -70,17 +85,11 @@ describe('api/ThreadedComments', () => {
             expect(threadedComments.post).toBeCalledWith({
                 id: 'foo',
                 data: {
-                    data: {
-                        item: {
-                            id: 'foo',
-                            type: 'file',
-                        },
-                        message,
-                    },
+                    data: { message },
                 },
                 errorCallback,
                 successCallback,
-                url: 'https://api.box.com/2.0/undoc/comments',
+                url: 'https://api.box.com/2.0/undoc/comments?file_id=foo',
             });
         });
 
@@ -203,7 +212,6 @@ describe('api/ThreadedComments', () => {
                 id: '12345',
                 errorCallback,
                 requestData: {
-                    file_id: '12345',
                     replies_count: 1,
                 },
                 successCallback,
@@ -291,7 +299,7 @@ describe('api/ThreadedComments', () => {
             expect(threadedComments.post).toBeCalledWith({
                 id: '12345',
                 errorCallback,
-                url: 'https://api.box.com/2.0/undoc/comments/67890/replies',
+                url: 'https://api.box.com/2.0/undoc/comments/67890/replies?file_id=12345',
                 data: { data: { message } },
                 successCallback,
             });
@@ -315,4 +323,33 @@ describe('api/ThreadedComments', () => {
             expect(threadedComments.get).not.toBeCalled();
         });
     });
+
+    describe('successHandler()', () => {
+        beforeEach(() => {
+            threadedComments.successCallback = jest.fn();
+        });
+
+        test('should call the success callback with no data if none provided from API', () => {
+            threadedComments.successHandler();
+            expect(threadedComments.successCallback).toBeCalledWith();
+        });
+
+        test('should call formatReplies method and call the success callback if the response does not contain entries property', () => {
+            const response = cloneDeep(mockThreadedComments[0]);
+            threadedComments.successHandler(response);
+            expect(formatComment).toBeCalledWith(response);
+            expect(threadedComments.successCallback).toBeCalled();
+        });
+
+        test('should call formatReplies method and call the success callback if the response contains entries (comments)', () => {
+            const response = {
+                entries: cloneDeep(mockThreadedComments),
+                limit: 1000,
+                next_marker: null,
+            };
+            threadedComments.successHandler(response);
+            expect(formatComment).toBeCalled();
+            expect(threadedComments.successCallback).toBeCalled();
+        });
+    });
 });

package/src/api/__tests__/utils.test.js

@@ -0,0 +1,11 @@
+import { formatComment } from '../utils';
+import { threadedComments, threadedCommentsFormatted } from '../fixtures';
+
+describe('api/utils', () => {
+    describe('formatComment()', () => {
+        test('should return a comment and its replies with tagged_message property equal to message', () => {
+            expect(formatComment(threadedComments[0])).toMatchObject(threadedCommentsFormatted[0]);
+            expect(formatComment(threadedComments[1])).toMatchObject(threadedCommentsFormatted[1]);
+        });
+    });
+});

package/src/api/fixtures.js

@@ -0,0 +1,401 @@
+// @flow
+import { TASK_NEW_NOT_STARTED } from '../constants';
+
+export const annotations = [
+    {
+        created_at: '2022-08-19T03:39:00-07:00',
+        created_by: {
+            id: '18836063658',
+            name: 'John Doe',
+            login: 'jdoe@box.com',
+            type: 'user',
+        },
+        description: {
+            message: 'test',
+        },
+        modified_at: '2022-08-19T03:39:00-07:00',
+        modified_by: {
+            id: '18836063658',
+            name: 'John Doe',
+            login: 'jdoe@box.com',
+            type: 'user',
+        },
+        target: {
+            location: {
+                value: 1,
+                type: 'page',
+            },
+            shape: {
+                height: 48.275862068965516,
+                type: 'rect',
+                width: 44.827586206896555,
+                x: 24.137931034482758,
+                y: 20.689655172413794,
+            },
+            type: 'region',
+        },
+        id: '4441340671',
+        replies: [
+            {
+                created_at: '1970-01-01T00:00:00.003Z',
+                created_by: {
+                    id: '12',
+                    type: 'user',
+                    name: 'u3_name',
+                    login: 'u3@box.com',
+                },
+                id: '21',
+                item: {
+                    type: 'file',
+                    id: 'f1',
+                },
+                message: 'Test message',
+                modified_at: '1970-01-01T00:00:00.003Z',
+                type: 'comment',
+                parent: null,
+                permissions: {
+                    can_delete: false,
+                    can_edit: false,
+                    can_reply: true,
+                    can_resolve: true,
+                },
+                replies: [],
+                total_reply_count: 0,
+                status: 'open',
+            },
+        ],
+        status: 'open',
+        type: 'annotation',
+        permissions: {
+            can_edit: true,
+            can_delete: true,
+            can_resolve: true,
+        },
+        file_version: {
+            id: '1080675498428',
+            version_number: 1,
+            type: 'file_version',
+        },
+    },
+];
+
+export const annotationsWithFormattedReplies = [
+    {
+        created_at: '2022-08-19T03:39:00-07:00',
+        created_by: {
+            id: '18836063658',
+            name: 'John Doe',
+            login: 'jdoe@box.com',
+            type: 'user',
+        },
+        description: {
+            message: 'test',
+        },
+        modified_at: '2022-08-19T03:39:00-07:00',
+        modified_by: {
+            id: '18836063658',
+            name: 'John Doe',
+            login: 'jdoe@box.com',
+            type: 'user',
+        },
+        target: {
+            location: {
+                value: 1,
+                type: 'page',
+            },
+            shape: {
+                height: 48.275862068965516,
+                type: 'rect',
+                width: 44.827586206896555,
+                x: 24.137931034482758,
+                y: 20.689655172413794,
+            },
+            type: 'region',
+        },
+        id: '4441340671',
+        replies: [
+            {
+                created_at: '1970-01-01T00:00:00.003Z',
+                created_by: {
+                    id: '12',
+                    type: 'user',
+                    name: 'u3_name',
+                    login: 'u3@box.com',
+                },
+                id: '21',
+                item: {
+                    type: 'file',
+                    id: 'f1',
+                },
+                message: 'Test message',
+                modified_at: '1970-01-01T00:00:00.003Z',
+                tagged_message: 'Test message',
+                type: 'comment',
+                parent: null,
+                permissions: {
+                    can_delete: false,
+                    can_edit: false,
+                    can_reply: true,
+                    can_resolve: true,
+                },
+                replies: [],
+                total_reply_count: 0,
+                status: 'open',
+            },
+        ],
+        status: 'open',
+        type: 'annotation',
+        permissions: {
+            can_edit: true,
+            can_delete: true,
+            can_resolve: true,
+        },
+        file_version: {
+            id: '1080675498428',
+            version_number: 1,
+            type: 'file_version',
+        },
+    },
+];
+
+export const task = {
+    created_by: {
+        type: 'task_collaborator',
+        target: { name: 'Jay-Z', id: '100' },
+        id: '000',
+        role: 'CREATOR',
+        status: TASK_NEW_NOT_STARTED,
+    },
+    created_at: '2019-01-01',
+    due_at: '2019-02-02',
+    id: '0',
+    name: 'task message',
+    type: 'task',
+    assigned_to: {
+        entries: [
+            {
+                id: '1',
+                target: { name: 'Beyonce', id: '2', avatar_url: '', type: 'user' },
+                status: TASK_NEW_NOT_STARTED,
+                permissions: {
+                    can_delete: false,
+                    can_update: false,
+                },
+                role: 'ASSIGNEE',
+                type: 'task_collaborator',
+            },
+        ],
+        limit: 10,
+        next_marker: null,
+    },
+    permissions: {
+        can_update: false,
+        can_delete: false,
+        can_create_task_collaborator: false,
+        can_create_task_link: false,
+    },
+    task_links: {
+        entries: [
+            {
+                id: '03',
+                type: 'task_link',
+                target: {
+                    type: 'file',
+                    id: '4',
+                },
+                permissions: {
+                    can_delete: false,
+                    can_update: false,
+                },
+            },
+        ],
+        limit: 1,
+        next_marker: null,
+    },
+    status: TASK_NEW_NOT_STARTED,
+};
+
+export const threadedComments = [
+    {
+        created_at: '1970-01-01T00:00:00.001Z',
+        created_by: {
+            id: '10',
+            type: 'user',
+            name: 'u1_name',
+            login: 'u1@box.com',
+        },
+        id: '20',
+        item: {
+            type: 'file',
+            id: 'f1',
+        },
+        message: '@[111:Aaron Levie] these tigers are cool!',
+        modified_at: '1970-01-01T00:00:00.001Z',
+        type: 'comment',
+        parent: null,
+        permissions: {
+            can_delete: false,
+            can_edit: false,
+            can_reply: true,
+            can_resolve: true,
+        },
+        replies: [
+            {
+                created_at: '1970-01-01T00:00:00.002Z',
+                created_by: {
+                    id: '11',
+                    type: 'user',
+                    name: 'u2_name',
+                    login: 'u2@box.com',
+                },
+                id: '21',
+                item: {
+                    type: 'file',
+                    id: 'f1',
+                },
+                message: '@[u1:Mateusz Mamczarz] Yes, they really are!',
+                modified_at: '1970-01-01T00:00:00.002Z',
+                type: 'comment',
+                parent: {
+                    id: 'c1',
+                    type: 'comment',
+                },
+                permissions: {
+                    can_delete: false,
+                    can_edit: false,
+                    can_reply: false,
+                    can_resolve: true,
+                },
+                replies: [],
+                total_reply_count: 0,
+                status: 'open',
+            },
+        ],
+        total_reply_count: 1,
+        status: 'open',
+    },
+    {
+        created_at: '1970-01-01T00:00:00.003Z',
+        created_by: {
+            id: '12',
+            type: 'user',
+            name: 'u3_name',
+            login: 'u3@box.com',
+        },
+        id: '21',
+        item: {
+            type: 'file',
+            id: 'f1',
+        },
+        message: 'Test message',
+        modified_at: '1970-01-01T00:00:00.003Z',
+        type: 'comment',
+        parent: null,
+        permissions: {
+            can_delete: false,
+            can_edit: false,
+            can_reply: true,
+            can_resolve: true,
+        },
+        replies: [],
+        total_reply_count: 0,
+        status: 'open',
+    },
+];
+
+export const threadedCommentsFormatted = [
+    {
+        created_at: '1970-01-01T00:00:00.001Z',
+        created_by: {
+            id: '10',
+            type: 'user',
+            name: 'u1_name',
+            login: 'u1@box.com',
+        },
+        id: '20',
+        item: {
+            type: 'file',
+            id: 'f1',
+        },
+        message: '@[111:Aaron Levie] these tigers are cool!',
+        modified_at: '1970-01-01T00:00:00.001Z',
+        tagged_message: '@[111:Aaron Levie] these tigers are cool!',
+        type: 'comment',
+        parent: null,
+        permissions: {
+            can_delete: false,
+            can_edit: false,
+            can_reply: true,
+            can_resolve: true,
+        },
+        replies: [
+            {
+                created_at: '1970-01-01T00:00:00.002Z',
+                created_by: {
+                    id: '11',
+                    type: 'user',
+                    name: 'u2_name',
+                    login: 'u2@box.com',
+                },
+                id: '21',
+                item: {
+                    type: 'file',
+                    id: 'f1',
+                },
+                message: '@[u1:Mateusz Mamczarz] Yes, they really are!',
+                modified_at: '1970-01-01T00:00:00.002Z',
+                tagged_message: '@[u1:Mateusz Mamczarz] Yes, they really are!',
+                type: 'comment',
+                parent: {
+                    id: 'c1',
+                    type: 'comment',
+                },
+                permissions: {
+                    can_delete: false,
+                    can_edit: false,
+                    can_reply: false,
+                    can_resolve: true,
+                },
+                replies: [],
+                total_reply_count: 0,
+                status: 'open',
+            },
+        ],
+        total_reply_count: 1,
+        status: 'open',
+    },
+    {
+        created_at: '1970-01-01T00:00:00.003Z',
+        created_by: {
+            id: '12',
+            type: 'user',
+            name: 'u3_name',
+            login: 'u3@box.com',
+        },
+        id: '21',
+        item: {
+            type: 'file',
+            id: 'f1',
+        },
+        message: 'Test message',
+        modified_at: '1970-01-01T00:00:00.003Z',
+        tagged_message: 'Test message',
+        type: 'comment',
+        parent: null,
+        permissions: {
+            can_delete: false,
+            can_edit: false,
+            can_reply: true,
+            can_resolve: true,
+        },
+        replies: [],
+        total_reply_count: 0,
+        status: 'open',
+    },
+];
+
+export default {
+    task,
+    threadedComments,
+    threadedCommentsFormatted,
+};

package/src/api/messages.js

@@ -32,6 +32,11 @@ const messages = defineMessages({
         description: 'Error message when an annotation comment update fails',
         defaultMessage: 'This comment could not be modified.',
     },
+    repliesFetchErrorMessage: {
+        id: 'be.api.repliesFetchErrorMessage',
+        description: 'Error message when fetching for comment replies fails',
+        defaultMessage: 'The replies to this comment could not be loaded.',
+    },
     taskActionErrorTitle: {
         id: 'be.api.taskActionErrorTitle',
         description: 'Title shown when an error occurs performing an action on a task',

package/src/api/utils.js

@@ -0,0 +1,30 @@
+/**
+ * @flow
+ * @file Utils for the box APIs
+ * @author Box
+ */
+
+import type { Comment } from '../common/types/feed';
+
+/**
+ * Formats comment data (including replies) for use in components.
+ *
+ * @param {Comment} comment - An individual comment entry from the API
+ * @return {Comment} Updated comment
+ */
+export const formatComment = (comment: Comment): Comment => {
+    const formattedComment = {
+        ...comment,
+        tagged_message: comment.message,
+    };
+
+    if (comment.replies && comment.replies.length) {
+        formattedComment.replies = comment.replies.map(formatComment);
+    }
+
+    return formattedComment;
+};
+
+export default {
+    formatComment,
+};

package/src/common/types/annotations.js

@@ -1,7 +1,7 @@
 // @flow
 
 import type { BoxItemVersionMini, Reply, User } from './core';
-import type { ActionItemError } from './feed';
+import type { ActionItemError, Comment, FeedItemStatus } from './feed';
 
 export type Page = {
     type: 'page',
@@ -29,15 +29,22 @@ export type TargetRegion = {
     type: 'region',
 };
 
-export type Target = TargetRegion;
+export type TargetPoint = {
+    location: Page,
+    type: 'point',
+    x: number,
+    y: number,
+};
+
+export type Target = TargetRegion | TargetPoint;
 
 export type AnnotationPermission = {
     can_delete?: boolean,
     can_edit?: boolean,
+    can_reply?: boolean,
+    can_resolve?: boolean,
 };
 
-export type AnnotationStatus = 'open' | 'deleted' | 'resolved';
-
 export type Annotation = {
     created_at: string,
     created_by: User,
@@ -46,12 +53,14 @@ export type Annotation = {
     file_version: BoxItemVersionMini | null,
     id: string,
     isPending?: boolean, // Doesn't come from the API but used in the FeedItems
+    isRepliesLoading?: boolean,
     modified_at: string,
     modified_by: User,
     permissions: AnnotationPermission,
-    replies?: Array<Reply>,
-    status?: AnnotationStatus,
+    replies?: Array<Comment>,
+    status?: FeedItemStatus,
     target: Target,
+    total_reply_count?: number,
     type: 'annotation',
 };
 
@@ -61,12 +70,9 @@ export type Annotations = {
     next_marker: string | null,
 };
 
-export type NewReply = {
-    message: string,
-    type: 'reply',
-};
-
 export type NewAnnotation = {
-    description?: NewReply,
+    description?: {
+        message: string,
+    },
     target: Target,
 };