|
| 1 | +import { camelCaseObject, getConfig } from '@edx/frontend-platform'; |
| 2 | +import { getAuthenticatedHttpClient } from '@edx/frontend-platform/auth'; |
| 3 | + |
| 4 | +import type { TagListData } from '@src/taxonomy/data/types'; |
| 5 | + |
| 6 | +import type { ContentData, ContentTaxonomyTagsData, UpdateTagsData } from './types'; |
| 7 | + |
| 8 | +const getApiBaseUrl = () => getConfig().STUDIO_BASE_URL; |
| 9 | + |
| 10 | +interface GetTaxonomyTagsApiUrlOptions { |
| 11 | + parentTag?: string; |
| 12 | + page?: number; |
| 13 | + searchTerm?: string; |
| 14 | +} |
| 15 | + |
| 16 | +/** |
| 17 | + * Get the URL used to fetch tags data from the "taxonomy tags" REST API |
| 18 | + */ |
| 19 | +export const getTaxonomyTagsApiUrl = (taxonomyId: number, options: GetTaxonomyTagsApiUrlOptions = {}): string => { |
| 20 | + const url = new URL(`api/content_tagging/v1/taxonomies/${taxonomyId}/tags/`, getApiBaseUrl()); |
| 21 | + if (options.parentTag) { |
| 22 | + url.searchParams.append('parent_tag', options.parentTag); |
| 23 | + } |
| 24 | + if (options.page) { |
| 25 | + url.searchParams.append('page', String(options.page)); |
| 26 | + } |
| 27 | + if (options.searchTerm) { |
| 28 | + url.searchParams.append('search_term', options.searchTerm); |
| 29 | + } |
| 30 | + |
| 31 | + // Load in the full tree if children at once, if we can: |
| 32 | + // Note: do not combine this with page_size (we currently aren't using page_size) |
| 33 | + url.searchParams.append('full_depth_threshold', '1000'); |
| 34 | + |
| 35 | + return url.href; |
| 36 | +}; |
| 37 | + |
| 38 | +export const getContentTaxonomyTagsApiUrl = (contentId: string) => new URL(`api/content_tagging/v1/object_tags/${contentId}/`, getApiBaseUrl()).href; |
| 39 | +export const getXBlockContentDataApiURL = (contentId: string) => new URL(`/xblock/outline/${contentId}`, getApiBaseUrl()).href; |
| 40 | +export const getCourseContentDataApiURL = (contentId: string) => new URL(`/api/contentstore/v1/course_settings/${contentId}`, getApiBaseUrl()).href; |
| 41 | +export const getLibraryContentDataApiUrl = (contentId: string) => new URL(`/api/libraries/v2/blocks/${contentId}/`, getApiBaseUrl()).href; |
| 42 | +export const getContentTaxonomyTagsCountApiUrl = (contentId: string) => new URL(`api/content_tagging/v1/object_tag_counts/${contentId}/?count_implicit`, getApiBaseUrl()).href; |
| 43 | + |
| 44 | +/** |
| 45 | + * Get all tags that belong to taxonomy. |
| 46 | + */ |
| 47 | +export async function getTaxonomyTagsData( |
| 48 | + taxonomyId: number, |
| 49 | + options: GetTaxonomyTagsApiUrlOptions = {}, |
| 50 | +): Promise<TagListData> { |
| 51 | + const url = getTaxonomyTagsApiUrl(taxonomyId, options); |
| 52 | + const { data } = await getAuthenticatedHttpClient().get(url); |
| 53 | + return camelCaseObject(data); |
| 54 | +} |
| 55 | + |
| 56 | +/** |
| 57 | + * Get the tags that are applied to the content object |
| 58 | + * @param contentId The id of the content object to fetch the applied tags for |
| 59 | + */ |
| 60 | +export async function getContentTaxonomyTagsData(contentId: string): Promise<ContentTaxonomyTagsData> { |
| 61 | + const url = getContentTaxonomyTagsApiUrl(contentId); |
| 62 | + const { data } = await getAuthenticatedHttpClient().get(url); |
| 63 | + return camelCaseObject(data[contentId]); |
| 64 | +} |
| 65 | + |
| 66 | +/** |
| 67 | + * Get the count of tags that are applied to the content object |
| 68 | + * @param contentId The id of the content object to fetch the count of the applied tags for |
| 69 | + */ |
| 70 | +export async function getContentTaxonomyTagsCount(contentId: string): Promise<number> { |
| 71 | + const url = getContentTaxonomyTagsCountApiUrl(contentId); |
| 72 | + const { data } = await getAuthenticatedHttpClient().get(url); |
| 73 | + if (contentId in data) { |
| 74 | + return camelCaseObject(data[contentId]); |
| 75 | + } |
| 76 | + return 0; |
| 77 | +} |
| 78 | + |
| 79 | +/** |
| 80 | + * Fetch meta data (eg: display_name) about the content object (unit/component) |
| 81 | + * @param contentId The id of the content object (unit/component) |
| 82 | + */ |
| 83 | +export async function getContentData(contentId: string): Promise<ContentData> { |
| 84 | + let url: string; |
| 85 | + |
| 86 | + if (contentId.startsWith('lb:')) { |
| 87 | + url = getLibraryContentDataApiUrl(contentId); |
| 88 | + } else if (contentId.startsWith('course-v1:')) { |
| 89 | + url = getCourseContentDataApiURL(contentId); |
| 90 | + } else { |
| 91 | + url = getXBlockContentDataApiURL(contentId); |
| 92 | + } |
| 93 | + const { data } = await getAuthenticatedHttpClient().get(url); |
| 94 | + return camelCaseObject(data); |
| 95 | +} |
| 96 | + |
| 97 | +/** |
| 98 | + * Update content object's applied tags |
| 99 | + * @param contentId The id of the content object (unit/component) |
| 100 | + * @param tagsData The list of tags (values) to set on content object |
| 101 | + */ |
| 102 | +export async function updateContentTaxonomyTags( |
| 103 | + contentId: string, |
| 104 | + tagsData: UpdateTagsData, |
| 105 | +): Promise<ContentTaxonomyTagsData> { |
| 106 | + const url = getContentTaxonomyTagsApiUrl(contentId); |
| 107 | + const { data } = await getAuthenticatedHttpClient().put(url, { tagsData }); |
| 108 | + return camelCaseObject(data[contentId]); |
| 109 | +} |
0 commit comments