80073e3f83
* feat: updated redux structure and commentsview component * test: fixed test cases * fix: fixed lint error
124 lines
3.3 KiB
JavaScript
124 lines
3.3 KiB
JavaScript
import { ensureConfig, getConfig, snakeCaseObject } from '@edx/frontend-platform';
|
|
import { getAuthenticatedHttpClient } from '@edx/frontend-platform/auth';
|
|
|
|
import { ThreadType } from '../../../data/constants';
|
|
|
|
ensureConfig([
|
|
'LMS_BASE_URL',
|
|
], 'Comments API service');
|
|
|
|
export const getCommentsApiUrl = () => `${getConfig().LMS_BASE_URL}/api/discussion/v1/comments/`;
|
|
|
|
/**
|
|
* Returns all the comments for the specified thread.
|
|
* @param {string} threadId
|
|
* @param {EndorsementStatus} endorsed
|
|
* @param {number=} page
|
|
* @param {number=} pageSize
|
|
* @param reverseOrder
|
|
* @param enableInContextSidebar
|
|
* @returns {Promise<{}>}
|
|
*/
|
|
export const getThreadComments = async (threadId, {
|
|
threadType,
|
|
page,
|
|
pageSize,
|
|
reverseOrder,
|
|
enableInContextSidebar = false,
|
|
signal,
|
|
} = {}) => {
|
|
const params = snakeCaseObject({
|
|
threadId,
|
|
page,
|
|
pageSize,
|
|
reverseOrder,
|
|
requestedFields: 'profile_image',
|
|
enableInContextSidebar,
|
|
mergeQuestionTypeResponses: threadType === ThreadType.QUESTION ? true : null,
|
|
});
|
|
|
|
const { data } = await getAuthenticatedHttpClient().get(getCommentsApiUrl(), { params: { ...params, signal } });
|
|
return data;
|
|
};
|
|
|
|
/**
|
|
* Fetches a responses to a comment.
|
|
* @param {string} commentId
|
|
* @param {number=} page
|
|
* @param {number=} pageSize
|
|
* @returns {Promise<{}>}
|
|
*/
|
|
export const getCommentResponses = async (commentId, {
|
|
page,
|
|
pageSize,
|
|
reverseOrder,
|
|
} = {}) => {
|
|
const url = `${getCommentsApiUrl()}${commentId}/`;
|
|
const params = snakeCaseObject({
|
|
page,
|
|
pageSize,
|
|
requestedFields: 'profile_image',
|
|
reverseOrder,
|
|
});
|
|
const { data } = await getAuthenticatedHttpClient()
|
|
.get(url, { params });
|
|
return data;
|
|
};
|
|
|
|
/**
|
|
* Posts a comment.
|
|
* @param {string} comment Raw comment data to post.
|
|
* @param {string} threadId Thread ID for thread in which to post comment.
|
|
* @param {string=} parentId ID for a comments parent.
|
|
* @param {boolean} enableInContextSidebar
|
|
* @returns {Promise<{}>}
|
|
*/
|
|
export const postComment = async (comment, threadId, parentId = null, enableInContextSidebar = false) => {
|
|
const { data } = await getAuthenticatedHttpClient()
|
|
.post(getCommentsApiUrl(), snakeCaseObject({
|
|
threadId, raw_body: comment, parentId, enableInContextSidebar,
|
|
}));
|
|
return data;
|
|
};
|
|
|
|
/**
|
|
* Updates existing comment.
|
|
* @param {string} commentId ID of comment to update.
|
|
* @param {string=} comment Raw updated comment data to post.
|
|
* @param {boolean=} voted
|
|
* @param {boolean=} flagged
|
|
* @param {boolean=} endorsed
|
|
* @param {string=} editReasonCode The moderation reason code for editing.
|
|
* @returns {Promise<{}>}
|
|
*/
|
|
export const updateComment = async (commentId, {
|
|
comment,
|
|
voted,
|
|
flagged,
|
|
endorsed,
|
|
editReasonCode,
|
|
}) => {
|
|
const url = `${getCommentsApiUrl()}${commentId}/`;
|
|
const postData = snakeCaseObject({
|
|
raw_body: comment,
|
|
voted,
|
|
abuse_flagged: flagged,
|
|
endorsed,
|
|
editReasonCode,
|
|
});
|
|
|
|
const { data } = await getAuthenticatedHttpClient()
|
|
.patch(url, postData, { headers: { 'Content-Type': 'application/merge-patch+json' } });
|
|
return data;
|
|
};
|
|
|
|
/**
|
|
* Deletes existing comment.
|
|
* @param {string} commentId ID of comment to delete
|
|
*/
|
|
export const deleteComment = async (commentId) => {
|
|
const url = `${getCommentsApiUrl()}${commentId}/`;
|
|
await getAuthenticatedHttpClient()
|
|
.delete(url);
|
|
};
|