3c22e4bbe1
* Add flow in course outline sidebar. Allows author to add new section/subsection/unit or any container from existing libraries via sidebar. * Adds library dropdown filter and collections dropdown filter in add sidebar. Allows authors to filter containers by selected libraries and collections.
909 lines
28 KiB
TypeScript
909 lines
28 KiB
TypeScript
import { camelCaseObject, getConfig, snakeCaseObject } from '@edx/frontend-platform';
|
|
import { getAuthenticatedHttpClient } from '@edx/frontend-platform/auth';
|
|
import { VersionSpec } from '../LibraryBlock';
|
|
import { type ContainerType } from '../../generic/key-utils';
|
|
|
|
const getApiBaseUrl = () => getConfig().STUDIO_BASE_URL;
|
|
|
|
/**
|
|
* Get the URL for the content library API.
|
|
*/
|
|
export const getContentLibraryApiUrl = (libraryId: string) => `${getApiBaseUrl()}/api/libraries/v2/${libraryId}/`;
|
|
|
|
/**
|
|
* Get the URL for create content in library.
|
|
*/
|
|
export const getCreateLibraryBlockUrl = (libraryId: string) => `${getApiBaseUrl()}/api/libraries/v2/${libraryId}/blocks/`;
|
|
|
|
/**
|
|
* Get the URL for the content library team API.
|
|
*/
|
|
export const getLibraryTeamApiUrl = (libraryId: string) => `${getApiBaseUrl()}/api/libraries/v2/${libraryId}/team/`;
|
|
|
|
/**
|
|
* Get the URL for updating/deleting a content library team member.
|
|
*/
|
|
export const getLibraryTeamMemberApiUrl = (libraryId: string, username: string) => `${getApiBaseUrl()}/api/libraries/v2/${libraryId}/team/user/${username}/`;
|
|
|
|
/**
|
|
* Get the URL for block types metadata.
|
|
*/
|
|
export const getBlockTypesMetaDataUrl = (libraryId: string) => `${getApiBaseUrl()}/api/libraries/v2/${libraryId}/block_types/`;
|
|
|
|
/**
|
|
* Get the URL for library block metadata.
|
|
*/
|
|
export const getLibraryBlockMetadataUrl = (usageKey: string) => `${getApiBaseUrl()}/api/libraries/v2/blocks/${usageKey}/`;
|
|
|
|
/**
|
|
* Get the URL for restoring deleted library block.
|
|
*/
|
|
export const getLibraryBlockRestoreUrl = (usageKey: string) => `${getLibraryBlockMetadataUrl(usageKey)}restore/`;
|
|
|
|
/**
|
|
* Get the URL for library block collections.
|
|
*/
|
|
export const getLibraryBlockCollectionsUrl = (usageKey: string) => `${getLibraryBlockMetadataUrl(usageKey)}collections/`;
|
|
|
|
/**
|
|
* Get the URL for a single component hierarchy api.
|
|
*/
|
|
export const getLibraryBlockHierarchyUrl = (usageKey: string) => `${getLibraryBlockMetadataUrl(usageKey)}hierarchy/`;
|
|
|
|
/**
|
|
* Get the URL for content library list API.
|
|
*/
|
|
export const getContentLibraryV2ListApiUrl = () => `${getApiBaseUrl()}/api/libraries/v2/`;
|
|
|
|
/**
|
|
* Get the URL for commit/revert changes in library.
|
|
*/
|
|
export const getCommitLibraryChangesUrl = (libraryId: string) => `${getApiBaseUrl()}/api/libraries/v2/${libraryId}/commit/`;
|
|
|
|
/**
|
|
* Get the URL for paste clipboard content into library.
|
|
*/
|
|
export const getLibraryPasteClipboardUrl = (libraryId: string) => `${getApiBaseUrl()}/api/libraries/v2/${libraryId}/paste_clipboard/`;
|
|
|
|
/**
|
|
* Get the URL for the xblock fields/metadata API.
|
|
*/
|
|
export const getXBlockFieldsApiUrl = (usageKey: string) => `${getApiBaseUrl()}/api/xblock/v2/xblocks/${usageKey}/fields/`;
|
|
export const getXBlockFieldsVersionApiUrl = (usageKey: string, version: VersionSpec) => `${getApiBaseUrl()}/api/xblock/v2/xblocks/${usageKey}@${version}/fields/`;
|
|
|
|
/**
|
|
* Get the URL for the xblock OLX API
|
|
*/
|
|
export const getXBlockOLXApiUrl = (usageKey: string) => `${getLibraryBlockMetadataUrl(usageKey)}olx/`;
|
|
export const getXBlockOLXVersionApiUrl = (usageKey: string, version: VersionSpec) => `${getApiBaseUrl()}/api/xblock/v2/xblocks/${usageKey}@${version}/olx/`;
|
|
|
|
/**
|
|
* Get the URL for the xblock Publish API
|
|
*/
|
|
export const getXBlockPublishApiUrl = (usageKey: string) => `${getApiBaseUrl()}/api/libraries/v2/blocks/${usageKey}/publish/`;
|
|
/**
|
|
* Get the URL for the xblock Assets List API
|
|
*/
|
|
export const getXBlockAssetsApiUrl = (usageKey: string) => `${getApiBaseUrl()}/api/libraries/v2/blocks/${usageKey}/assets/`;
|
|
/**
|
|
* Get the URL for the Library Collections API.
|
|
*/
|
|
export const getLibraryCollectionsApiUrl = (libraryId: string) => `${getApiBaseUrl()}/api/libraries/v2/${libraryId}/collections/`;
|
|
/**
|
|
* Get the URL for the collection detail API.
|
|
*/
|
|
export const getLibraryCollectionApiUrl = (libraryId: string, collectionId: string) => `${getLibraryCollectionsApiUrl(libraryId)}${collectionId}/`;
|
|
/**
|
|
* Get the URL for the collection items API.
|
|
*/
|
|
export const getLibraryCollectionItemsApiUrl = (libraryId: string, collectionId: string) => `${getLibraryCollectionApiUrl(libraryId, collectionId)}items/`;
|
|
/**
|
|
* Get the API URL for restoring deleted collection.
|
|
*/
|
|
export const getLibraryCollectionRestoreApiUrl = (libraryId: string, collectionId: string) => `${getLibraryCollectionApiUrl(libraryId, collectionId)}restore/`;
|
|
/**
|
|
* Get the URL for the xblock api.
|
|
*/
|
|
export const getXBlockBaseApiUrl = () => `${getApiBaseUrl()}/xblock/`;
|
|
/**
|
|
* Get the URL for the content store api.
|
|
*/
|
|
export const getContentStoreApiUrl = () => `${getApiBaseUrl()}/api/contentstore/v2/`;
|
|
/**
|
|
* Get the URL for the library container api.
|
|
*/
|
|
export const getLibraryContainersApiUrl = (libraryId: string) => `${getApiBaseUrl()}/api/libraries/v2/${libraryId}/containers/`;
|
|
/**
|
|
* Get the URL for the container detail api.
|
|
*/
|
|
export const getLibraryContainerApiUrl = (containerId: string) => `${getApiBaseUrl()}/api/libraries/v2/containers/${containerId}/`;
|
|
/**
|
|
* Get the URL for restore a container
|
|
*/
|
|
export const getLibraryContainerRestoreApiUrl = (containerId: string) => `${getLibraryContainerApiUrl(containerId)}restore/`;
|
|
/**
|
|
* Get the URL for a single container children api.
|
|
*/
|
|
export const getLibraryContainerChildrenApiUrl = (containerId: string, published: boolean = false) => `${getLibraryContainerApiUrl(containerId)}children/?published=${published}`;
|
|
/**
|
|
* Get the URL for a single container hierarchy api.
|
|
*/
|
|
export const getLibraryContainerHierarchyApiUrl = (containerId: string) => `${getLibraryContainerApiUrl(containerId)}hierarchy/`;
|
|
/**
|
|
* Get the URL for library container collections.
|
|
*/
|
|
export const getLibraryContainerCollectionsUrl = (containerId: string) => `${getLibraryContainerApiUrl(containerId)}collections/`;
|
|
/**
|
|
* Get the URL for the API endpoint to publish a single container (+ children).
|
|
*/
|
|
export const getLibraryContainerPublishApiUrl = (containerId: string) => `${getLibraryContainerApiUrl(containerId)}publish/`;
|
|
/**
|
|
* Get the URL for the API endpoint to create a backup of a v2 library.
|
|
*/
|
|
export const getLibraryBackupApiUrl = (libraryId: string) => `${getApiBaseUrl()}/api/libraries/v2/${libraryId}/backup/`;
|
|
/**
|
|
* Get the URL for the API endpoint to get the status of a library backup task.
|
|
*/
|
|
export const getLibraryBackupStatusApiUrl = (libraryId: string, taskId: string) => `${getApiBaseUrl()}/api/libraries/v2/${libraryId}/backup/?task_id=${taskId}`;
|
|
/**
|
|
* Get the URL for the API endpoint to restore a library from an archive.
|
|
*/
|
|
export const getLibraryRestoreApiUrl = () => `${getApiBaseUrl()}/api/libraries/v2/restore/`;
|
|
/**
|
|
* Get the URL for the API endpoint to get the status of a library restore task.
|
|
*/
|
|
export const getLibraryRestoreStatusApiUrl = (taskId: string) => `${getApiBaseUrl()}/api/libraries/v2/restore/?task_id=${taskId}`;
|
|
/**
|
|
* Get the URL for the API endpoint to copy a single container.
|
|
*/
|
|
export const getLibraryContainerCopyApiUrl = (containerId: string) => `${getLibraryContainerApiUrl(containerId)}copy/`;
|
|
/**
|
|
* Base url for modulestore_migrator
|
|
*/
|
|
export const getBaseModuleStoreMigrationUrl = () => `${getApiBaseUrl()}/api/modulestore_migrator/v1/`;
|
|
/**
|
|
* Get the url for the API endpoint to list library course imports.
|
|
*/
|
|
export const getCourseImportsApiUrl = (libraryId: string) => `${getBaseModuleStoreMigrationUrl()}library/${libraryId}/migrations/courses/`;
|
|
/**
|
|
* Get the url for the API endpoint to get migration blocks info.
|
|
*/
|
|
export const getModulestoreMigratedBlocksInfoUrl = () => `${getBaseModuleStoreMigrationUrl()}migration_blocks/`;
|
|
|
|
export interface ContentLibrary {
|
|
id: string;
|
|
type: string;
|
|
org: string;
|
|
slug: string;
|
|
title: string;
|
|
description: string;
|
|
numBlocks: number;
|
|
version: number;
|
|
lastPublished: string | null;
|
|
lastDraftCreated: string | null;
|
|
publishedBy: string | null;
|
|
lastDraftCreatedBy: string | null;
|
|
allowLti: boolean;
|
|
allowPublicLearning: boolean;
|
|
allowPublicRead: boolean;
|
|
hasUnpublishedChanges: boolean;
|
|
hasUnpublishedDeletes: boolean;
|
|
canEditLibrary: boolean;
|
|
license: string;
|
|
created: string | null;
|
|
updated: string | null;
|
|
}
|
|
|
|
export type LibraryAccessLevel = 'read' | 'author' | 'admin';
|
|
|
|
export interface LibraryTeamMember {
|
|
username: string;
|
|
email: string;
|
|
accessLevel: LibraryAccessLevel,
|
|
}
|
|
|
|
export interface AddLibraryTeamMember {
|
|
libraryId: string,
|
|
email: string;
|
|
accessLevel: LibraryAccessLevel,
|
|
}
|
|
|
|
export interface DeleteLibraryTeamMember {
|
|
libraryId: string,
|
|
username: string;
|
|
}
|
|
|
|
export interface UpdateLibraryTeamMember extends DeleteLibraryTeamMember {
|
|
accessLevel: LibraryAccessLevel,
|
|
}
|
|
|
|
export interface Collection {
|
|
id: number;
|
|
key: string;
|
|
title: string;
|
|
description: string;
|
|
enabled: boolean;
|
|
createdBy: string | null;
|
|
created: string;
|
|
modified: string;
|
|
learningPackage: number;
|
|
}
|
|
|
|
export interface LibraryBlockType {
|
|
blockType: string;
|
|
displayName: string;
|
|
}
|
|
|
|
export interface LibrariesV2Response {
|
|
next: string | null,
|
|
previous: string | null,
|
|
count: number,
|
|
numPages: number,
|
|
currentPage: number,
|
|
start: number,
|
|
results: ContentLibrary[],
|
|
}
|
|
|
|
export interface XBlockFields {
|
|
displayName: string;
|
|
metadata: Record<string, unknown>;
|
|
data: string;
|
|
}
|
|
|
|
/* Additional custom parameters for the API request. */
|
|
export interface GetLibrariesV2CustomParams {
|
|
/* (optional) Library type, default `complex` */
|
|
type?: string,
|
|
/* (optional) Page number of results */
|
|
page?: number,
|
|
/* (optional) The number of results on each page, default `50` */
|
|
pageSize?: number,
|
|
/* (optional) Whether pagination is supported, default `true` */
|
|
pagination?: boolean,
|
|
/* (optional) Library field to order results by. Prefix with '-' for descending */
|
|
order?: string,
|
|
/* (optional) Search query to filter v2 Libraries by */
|
|
search?: string,
|
|
}
|
|
|
|
export interface GetLibrariesV2CustomParamsNoPagination extends GetLibrariesV2CustomParams {
|
|
pagination: false,
|
|
}
|
|
|
|
export interface GetLibrariesV2CustomParamsPagination extends GetLibrariesV2CustomParams {
|
|
pagination?: true,
|
|
}
|
|
|
|
export type LibraryAssetResponse = {
|
|
path: string,
|
|
size: number,
|
|
url: string,
|
|
};
|
|
|
|
export interface CreateBlockDataRequest {
|
|
libraryId: string;
|
|
blockType: string;
|
|
definitionId: string;
|
|
}
|
|
|
|
export interface DeleteBlockDataRequest {
|
|
usageKey: string;
|
|
}
|
|
|
|
export interface CollectionMetadata {
|
|
key: string;
|
|
title: string;
|
|
}
|
|
|
|
export interface LibraryBlockMetadata {
|
|
id: string;
|
|
blockType: string;
|
|
displayName: string;
|
|
publishedDisplayName: string | null;
|
|
lastPublished: string | null;
|
|
publishedBy: string | null;
|
|
lastDraftCreated: string | null;
|
|
lastDraftCreatedBy: string | null,
|
|
hasUnpublishedChanges: boolean;
|
|
created: string | null;
|
|
modified: string | null;
|
|
tagsCount: number;
|
|
collections: CollectionMetadata[];
|
|
// Local only variable set to true when a new block is added
|
|
// NOTE: Currently only updated when a new component is added inside a unit
|
|
isNew?: boolean;
|
|
}
|
|
|
|
export interface UpdateLibraryDataRequest {
|
|
id: string;
|
|
title?: string;
|
|
description?: string;
|
|
allow_public_learning?: boolean;
|
|
allow_public_read?: boolean;
|
|
type?: string;
|
|
license?: string;
|
|
}
|
|
|
|
export interface LibraryPasteClipboardRequest {
|
|
libraryId: string;
|
|
}
|
|
|
|
export interface UpdateXBlockFieldsRequest {
|
|
data?: unknown;
|
|
metadata?: {
|
|
display_name?: string;
|
|
};
|
|
}
|
|
|
|
export interface CreateLibraryCollectionDataRequest {
|
|
title: string;
|
|
description: string | null;
|
|
}
|
|
|
|
export interface BlockTypeMetadata {
|
|
blockType: string;
|
|
displayName: string;
|
|
}
|
|
|
|
export type UpdateCollectionComponentsRequest = Partial<CreateLibraryCollectionDataRequest>;
|
|
|
|
/**
|
|
* Fetch a content library by its ID.
|
|
*/
|
|
export async function getContentLibrary(libraryId: string): Promise<ContentLibrary> {
|
|
const { data } = await getAuthenticatedHttpClient().get(getContentLibraryApiUrl(libraryId));
|
|
return camelCaseObject(data);
|
|
}
|
|
|
|
export async function createLibraryBlock({
|
|
libraryId,
|
|
blockType,
|
|
definitionId,
|
|
}: CreateBlockDataRequest): Promise<LibraryBlockMetadata> {
|
|
const client = getAuthenticatedHttpClient();
|
|
const { data } = await client.post(
|
|
getCreateLibraryBlockUrl(libraryId),
|
|
{
|
|
block_type: blockType,
|
|
definition_id: definitionId,
|
|
},
|
|
);
|
|
return camelCaseObject(data);
|
|
}
|
|
|
|
export async function deleteLibraryBlock({ usageKey }: DeleteBlockDataRequest): Promise<void> {
|
|
const client = getAuthenticatedHttpClient();
|
|
await client.delete(getLibraryBlockMetadataUrl(usageKey));
|
|
}
|
|
|
|
export async function restoreLibraryBlock({ usageKey }: DeleteBlockDataRequest): Promise<void> {
|
|
const client = getAuthenticatedHttpClient();
|
|
await client.post(getLibraryBlockRestoreUrl(usageKey));
|
|
}
|
|
|
|
/**
|
|
* Update library metadata.
|
|
*/
|
|
export async function updateLibraryMetadata(libraryData: UpdateLibraryDataRequest): Promise<ContentLibrary> {
|
|
const client = getAuthenticatedHttpClient();
|
|
const { id: libraryId, ...updateData } = libraryData;
|
|
const { data } = await client.patch(getContentLibraryApiUrl(libraryId), updateData);
|
|
|
|
return camelCaseObject(data);
|
|
}
|
|
|
|
function isNoPagination(
|
|
params: GetLibrariesV2CustomParams,
|
|
): params is GetLibrariesV2CustomParamsNoPagination {
|
|
return params.pagination === false;
|
|
}
|
|
|
|
/**
|
|
* Get a list of content libraries.
|
|
*/
|
|
export async function getContentLibraryV2List(
|
|
customParams: GetLibrariesV2CustomParamsNoPagination
|
|
): Promise<ContentLibrary[]>;
|
|
export async function getContentLibraryV2List(
|
|
customParams: GetLibrariesV2CustomParamsPagination
|
|
): Promise<LibrariesV2Response>;
|
|
export async function getContentLibraryV2List(
|
|
customParams: GetLibrariesV2CustomParams
|
|
): Promise<LibrariesV2Response | ContentLibrary[]>;
|
|
export async function getContentLibraryV2List(
|
|
customParams: GetLibrariesV2CustomParams,
|
|
): Promise<LibrariesV2Response | ContentLibrary[]> {
|
|
// Set default params if not passed in
|
|
const customParamsDefaults = {
|
|
type: customParams.type || 'complex',
|
|
page: customParams.page || 1,
|
|
pageSize: customParams.pageSize || 50,
|
|
pagination: customParams.pagination !== undefined ? customParams.pagination : true,
|
|
order: customParams.order || 'title',
|
|
textSearch: customParams.search,
|
|
};
|
|
const customParamsFormated = snakeCaseObject(customParamsDefaults);
|
|
const { data } = await getAuthenticatedHttpClient()
|
|
.get(getContentLibraryV2ListApiUrl(), { params: customParamsFormated });
|
|
const camel = camelCaseObject(data);
|
|
|
|
// Narrow the return type based on pagination flag
|
|
if (isNoPagination(customParams)) {
|
|
// `camel` is known to be an array of ContentLibrary
|
|
return camel as ContentLibrary[];
|
|
}
|
|
|
|
// otherwise it matches the paginated response shape
|
|
return camel as LibrariesV2Response;
|
|
}
|
|
|
|
/**
|
|
* Commit library changes.
|
|
*/
|
|
export async function commitLibraryChanges(libraryId: string) {
|
|
const client = getAuthenticatedHttpClient();
|
|
await client.post(getCommitLibraryChangesUrl(libraryId));
|
|
}
|
|
|
|
/**
|
|
* Revert library changes.
|
|
*/
|
|
export async function revertLibraryChanges(libraryId: string) {
|
|
const client = getAuthenticatedHttpClient();
|
|
await client.delete(getCommitLibraryChangesUrl(libraryId));
|
|
}
|
|
|
|
/**
|
|
* Fetch content library's team by library ID.
|
|
*/
|
|
export async function getLibraryTeam(libraryId: string): Promise<LibraryTeamMember[]> {
|
|
const client = getAuthenticatedHttpClient();
|
|
const { data } = await client.get(getLibraryTeamApiUrl(libraryId));
|
|
return camelCaseObject(data);
|
|
}
|
|
|
|
/**
|
|
* Add a new member to the library's team by email.
|
|
*/
|
|
export async function addLibraryTeamMember(memberData: AddLibraryTeamMember): Promise<LibraryTeamMember> {
|
|
const client = getAuthenticatedHttpClient();
|
|
const url = getLibraryTeamApiUrl(memberData.libraryId);
|
|
const { data } = await client.post(url, snakeCaseObject(memberData));
|
|
return camelCaseObject(data);
|
|
}
|
|
|
|
/**
|
|
* Delete an existing member from the library's team by username.
|
|
*/
|
|
export async function deleteLibraryTeamMember(memberData: DeleteLibraryTeamMember): Promise<LibraryTeamMember> {
|
|
const client = getAuthenticatedHttpClient();
|
|
const url = getLibraryTeamMemberApiUrl(memberData.libraryId, memberData.username);
|
|
const { data } = await client.delete(url);
|
|
return camelCaseObject(data);
|
|
}
|
|
|
|
/**
|
|
* Update an existing member's access to the library's team by username.
|
|
*/
|
|
export async function updateLibraryTeamMember(memberData: UpdateLibraryTeamMember): Promise<LibraryTeamMember> {
|
|
const client = getAuthenticatedHttpClient();
|
|
const url = getLibraryTeamMemberApiUrl(memberData.libraryId, memberData.username);
|
|
const { data } = await client.put(url, snakeCaseObject(memberData));
|
|
return camelCaseObject(data);
|
|
}
|
|
|
|
/**
|
|
* Get the list of XBlock types that can be added to this library
|
|
*/
|
|
export async function getBlockTypes(libraryId: string): Promise<BlockTypeMetadata[]> {
|
|
const client = getAuthenticatedHttpClient();
|
|
const url = getBlockTypesMetaDataUrl(libraryId);
|
|
const { data } = await client.get(url);
|
|
return camelCaseObject(data);
|
|
}
|
|
|
|
/**
|
|
* Paste clipboard content into library.
|
|
*/
|
|
export async function libraryPasteClipboard({
|
|
libraryId,
|
|
}: LibraryPasteClipboardRequest): Promise<LibraryBlockMetadata> {
|
|
const client = getAuthenticatedHttpClient();
|
|
const { data } = await client.post(getLibraryPasteClipboardUrl(libraryId), {});
|
|
return camelCaseObject(data);
|
|
}
|
|
|
|
/**
|
|
* Fetch library block metadata.
|
|
*/
|
|
export async function getLibraryBlockMetadata(usageKey: string): Promise<LibraryBlockMetadata> {
|
|
const { data } = await getAuthenticatedHttpClient().get(getLibraryBlockMetadataUrl(usageKey));
|
|
return camelCaseObject(data);
|
|
}
|
|
|
|
/**
|
|
* Fetch xblock fields.
|
|
*/
|
|
export async function getXBlockFields(usageKey: string, version: VersionSpec = 'draft'): Promise<XBlockFields> {
|
|
const { data } = await getAuthenticatedHttpClient().get(getXBlockFieldsVersionApiUrl(usageKey, version));
|
|
return camelCaseObject(data);
|
|
}
|
|
|
|
/**
|
|
* Update xblock fields.
|
|
*/
|
|
export async function updateXBlockFields(usageKey: string, xblockData: UpdateXBlockFieldsRequest) {
|
|
const client = getAuthenticatedHttpClient();
|
|
await client.post(getXBlockFieldsApiUrl(usageKey), xblockData);
|
|
}
|
|
|
|
/**
|
|
* Create a library collection
|
|
*/
|
|
export async function createCollection(libraryId: string, collectionData: CreateLibraryCollectionDataRequest) {
|
|
const client = getAuthenticatedHttpClient();
|
|
const { data } = await client.post(getLibraryCollectionsApiUrl(libraryId), collectionData);
|
|
|
|
return camelCaseObject(data);
|
|
}
|
|
|
|
/**
|
|
* Fetch the OLX for the given XBlock.
|
|
*/
|
|
// istanbul ignore next
|
|
export async function getXBlockOLX(usageKey: string, version: VersionSpec = 'draft'): Promise<string> {
|
|
const { data } = await getAuthenticatedHttpClient().get(getXBlockOLXVersionApiUrl(usageKey, version));
|
|
return data.olx;
|
|
}
|
|
|
|
/**
|
|
* Set the OLX for the given XBlock.
|
|
* Returns the OLX as it was actually saved.
|
|
*/
|
|
// istanbul ignore next
|
|
export async function setXBlockOLX(usageKey: string, newOLX: string): Promise<string> {
|
|
const { data } = await getAuthenticatedHttpClient().post(getXBlockOLXApiUrl(usageKey), { olx: newOLX });
|
|
return data.olx;
|
|
}
|
|
|
|
/**
|
|
* Publish the given XBlock.
|
|
*/
|
|
export async function publishXBlock(usageKey: string) {
|
|
const client = getAuthenticatedHttpClient();
|
|
await client.post(getXBlockPublishApiUrl(usageKey));
|
|
}
|
|
|
|
/**
|
|
* Fetch the asset (static file) list for the given XBlock.
|
|
*/
|
|
// istanbul ignore next
|
|
export async function getXBlockAssets(usageKey: string): Promise<LibraryAssetResponse[]> {
|
|
const { data } = await getAuthenticatedHttpClient().get(getXBlockAssetsApiUrl(usageKey));
|
|
return data.files;
|
|
}
|
|
|
|
/**
|
|
* Delete a single asset file
|
|
*/
|
|
// istanbul ignore next
|
|
export async function deleteXBlockAsset(usageKey: string, path: string): Promise<void> {
|
|
await getAuthenticatedHttpClient().delete(getXBlockAssetsApiUrl(usageKey) + encodeURIComponent(path));
|
|
}
|
|
|
|
/**
|
|
* Get the collection metadata.
|
|
*/
|
|
export async function getCollectionMetadata(libraryId: string, collectionId: string): Promise<Collection> {
|
|
const { data } = await getAuthenticatedHttpClient().get(getLibraryCollectionApiUrl(libraryId, collectionId));
|
|
return camelCaseObject(data);
|
|
}
|
|
|
|
/**
|
|
* Update collection metadata.
|
|
*/
|
|
export async function updateCollectionMetadata(
|
|
libraryId: string,
|
|
collectionId: string,
|
|
collectionData: UpdateCollectionComponentsRequest,
|
|
) {
|
|
const client = getAuthenticatedHttpClient();
|
|
await client.patch(getLibraryCollectionApiUrl(libraryId, collectionId), collectionData);
|
|
}
|
|
|
|
/**
|
|
* Add items to collection.
|
|
*/
|
|
export async function addItemsToCollection(libraryId: string, collectionId: string, usageKeys: string[]) {
|
|
await getAuthenticatedHttpClient().patch(getLibraryCollectionItemsApiUrl(libraryId, collectionId), {
|
|
usage_keys: usageKeys,
|
|
});
|
|
}
|
|
|
|
/**
|
|
* Remove items from collection.
|
|
*/
|
|
export async function removeItemsFromCollection(libraryId: string, collectionId: string, usageKeys: string[]) {
|
|
await getAuthenticatedHttpClient().delete(getLibraryCollectionItemsApiUrl(libraryId, collectionId), {
|
|
data: { usage_keys: usageKeys },
|
|
});
|
|
}
|
|
|
|
/**
|
|
* Soft-Delete collection.
|
|
*/
|
|
export async function deleteCollection(libraryId: string, collectionId: string) {
|
|
const client = getAuthenticatedHttpClient();
|
|
await client.delete(getLibraryCollectionApiUrl(libraryId, collectionId));
|
|
}
|
|
|
|
/**
|
|
* Restore soft-deleted collection
|
|
*/
|
|
export async function restoreCollection(libraryId: string, collectionId: string) {
|
|
const client = getAuthenticatedHttpClient();
|
|
await client.post(getLibraryCollectionRestoreApiUrl(libraryId, collectionId));
|
|
}
|
|
|
|
/**
|
|
* Update component collections.
|
|
*/
|
|
export async function updateComponentCollections(usageKey: string, collectionKeys: string[]) {
|
|
await getAuthenticatedHttpClient().patch(getLibraryBlockCollectionsUrl(usageKey), {
|
|
collection_keys: collectionKeys,
|
|
});
|
|
}
|
|
|
|
export interface ItemHierarchyData {
|
|
objectKey: string;
|
|
sections: Container[];
|
|
subsections: Container[];
|
|
units: Container[];
|
|
components: LibraryBlockMetadata[];
|
|
}
|
|
export type ItemHierarchyMember = Container | LibraryBlockMetadata;
|
|
|
|
/**
|
|
* Get the full hierarchy of a component
|
|
*/
|
|
export async function getBlockHierarchy(usageKey: string): Promise<ItemHierarchyData> {
|
|
const { data } = await getAuthenticatedHttpClient().get(getLibraryBlockHierarchyUrl(usageKey));
|
|
return camelCaseObject(data);
|
|
}
|
|
|
|
export interface CreateLibraryContainerDataRequest {
|
|
title: string;
|
|
containerType: ContainerType;
|
|
canStandAlone: boolean;
|
|
}
|
|
|
|
/**
|
|
* Create a library container
|
|
*/
|
|
export async function createLibraryContainer(
|
|
libraryId: string,
|
|
containerData: CreateLibraryContainerDataRequest,
|
|
): Promise<Container> {
|
|
const client = getAuthenticatedHttpClient();
|
|
const { data } = await client.post(getLibraryContainersApiUrl(libraryId), snakeCaseObject(containerData));
|
|
return camelCaseObject(data);
|
|
}
|
|
|
|
export interface Container {
|
|
id: string;
|
|
containerType: ContainerType;
|
|
displayName: string;
|
|
publishedDisplayName: string | null;
|
|
lastPublished: string | null;
|
|
publishedBy: string | null;
|
|
createdBy: string | null;
|
|
lastDraftCreated: string | null;
|
|
lastDraftCreatedBy: string | null,
|
|
hasUnpublishedChanges: boolean;
|
|
created: string;
|
|
modified: string;
|
|
collections: CollectionMetadata[];
|
|
tagsCount: number;
|
|
}
|
|
|
|
/**
|
|
* Get the container metadata.
|
|
*/
|
|
export async function getContainerMetadata(containerId: string): Promise<Container> {
|
|
const { data } = await getAuthenticatedHttpClient().get(getLibraryContainerApiUrl(containerId));
|
|
return camelCaseObject(data);
|
|
}
|
|
|
|
export interface UpdateContainerDataRequest {
|
|
displayName: string;
|
|
}
|
|
|
|
/**
|
|
* Update container metadata.
|
|
*/
|
|
export async function updateContainerMetadata(
|
|
containerId: string,
|
|
containerData: UpdateContainerDataRequest,
|
|
) {
|
|
const client = getAuthenticatedHttpClient();
|
|
await client.patch(getLibraryContainerApiUrl(containerId), snakeCaseObject(containerData));
|
|
}
|
|
|
|
/**
|
|
* Delete a container
|
|
*/
|
|
export async function deleteContainer(containerId: string) {
|
|
const client = getAuthenticatedHttpClient();
|
|
await client.delete(getLibraryContainerApiUrl(containerId));
|
|
}
|
|
|
|
/**
|
|
* Restore a container
|
|
*/
|
|
export async function restoreContainer(containerId: string) {
|
|
const client = getAuthenticatedHttpClient();
|
|
await client.post(getLibraryContainerRestoreApiUrl(containerId));
|
|
}
|
|
|
|
/**
|
|
* Fetch a library container's children's metadata.
|
|
*/
|
|
export async function getLibraryContainerChildren<ChildType = LibraryBlockMetadata | Container>(
|
|
containerId: string,
|
|
published: boolean = false,
|
|
): Promise<ChildType[]> {
|
|
const { data } = await getAuthenticatedHttpClient().get(
|
|
getLibraryContainerChildrenApiUrl(containerId, published),
|
|
);
|
|
return camelCaseObject(data);
|
|
}
|
|
|
|
/**
|
|
* Add components to library container
|
|
*/
|
|
export async function addComponentsToContainer(containerId: string, componentIds: string[]) {
|
|
const client = getAuthenticatedHttpClient();
|
|
// POSTing to this URL will append children; PATCHing to it will replace the children.
|
|
await client.post(
|
|
getLibraryContainerChildrenApiUrl(containerId),
|
|
snakeCaseObject({ usageKeys: componentIds }),
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Update container collections.
|
|
*/
|
|
export async function updateContainerCollections(containerId: string, collectionKeys: string[]) {
|
|
await getAuthenticatedHttpClient().patch(getLibraryContainerCollectionsUrl(containerId), {
|
|
collection_keys: collectionKeys,
|
|
});
|
|
}
|
|
|
|
/**
|
|
* Update library container's children.
|
|
*/
|
|
export async function updateLibraryContainerChildren(
|
|
containerId: string,
|
|
children: string[],
|
|
): Promise<LibraryBlockMetadata[]> {
|
|
const { data } = await getAuthenticatedHttpClient().patch(
|
|
getLibraryContainerChildrenApiUrl(containerId),
|
|
{ usage_keys: children },
|
|
);
|
|
return camelCaseObject(data);
|
|
}
|
|
|
|
/**
|
|
* Remove components in `children` from library container.
|
|
*/
|
|
export async function removeLibraryContainerChildren(
|
|
containerId: string,
|
|
children: string[],
|
|
): Promise<LibraryBlockMetadata[]> {
|
|
const { data } = await getAuthenticatedHttpClient().delete(
|
|
getLibraryContainerChildrenApiUrl(containerId),
|
|
{
|
|
data: { usage_keys: children },
|
|
},
|
|
);
|
|
return camelCaseObject(data);
|
|
}
|
|
|
|
/**
|
|
* Fetch a library container's hierarchy metadata.
|
|
*/
|
|
export async function getLibraryContainerHierarchy(
|
|
containerId: string,
|
|
): Promise<ItemHierarchyData> {
|
|
const { data } = await getAuthenticatedHttpClient().get(
|
|
getLibraryContainerHierarchyApiUrl(containerId),
|
|
);
|
|
return camelCaseObject(data);
|
|
}
|
|
|
|
/**
|
|
* Publish a container, and any unpublished children within it.
|
|
*
|
|
* This doesn't return any data at the moment, but we could have it return a
|
|
* list of the auto-published children in the future, if that would be helpful.
|
|
*/
|
|
export async function publishContainer(containerId: string) {
|
|
await getAuthenticatedHttpClient().post(getLibraryContainerPublishApiUrl(containerId));
|
|
}
|
|
|
|
export interface CourseImport {
|
|
taskUuid: string;
|
|
source: {
|
|
key: string;
|
|
displayName: string;
|
|
};
|
|
targetCollection: {
|
|
key: string;
|
|
title: string;
|
|
} | null;
|
|
state: 'Succeeded' | 'Failed' | 'In Progress';
|
|
progress: number;
|
|
}
|
|
|
|
/**
|
|
* Returns the course imports which had this library as destination.
|
|
*/
|
|
export async function getCourseImports(libraryId: string): Promise<CourseImport[]> {
|
|
const { data } = await getAuthenticatedHttpClient().get(getCourseImportsApiUrl(libraryId));
|
|
return camelCaseObject(data);
|
|
}
|
|
|
|
export interface MigrationInfo {
|
|
sourceKey: string;
|
|
targetCollectionKey: string;
|
|
targetCollectionTitle: string;
|
|
targetKey: string;
|
|
targetTitle: string;
|
|
}
|
|
|
|
/**
|
|
* Get the migration info data for a list of source keys
|
|
*/
|
|
export async function getMigrationInfo(sourceKeys: string[]): Promise<Record<string, MigrationInfo[]>> {
|
|
const client = getAuthenticatedHttpClient();
|
|
|
|
const params = new URLSearchParams();
|
|
sourceKeys.forEach(key => params.append('source_keys', key));
|
|
|
|
const { data } = await client.get(`${getApiBaseUrl()}/api/modulestore_migrator/v1/migration_info/`, { params });
|
|
return camelCaseObject(data);
|
|
}
|
|
|
|
export interface BlockMigrationInfo {
|
|
sourceKey: string;
|
|
targetKey: string | null;
|
|
unsupportedReason?: string;
|
|
}
|
|
|
|
/**
|
|
* Get the migration blocks info data for a library
|
|
*/
|
|
export async function getModulestoreMigrationBlocksInfo(
|
|
libraryId: string,
|
|
collectionId?: string,
|
|
isFailed?: boolean,
|
|
taskUuid?: string,
|
|
): Promise<BlockMigrationInfo[]> {
|
|
const client = getAuthenticatedHttpClient();
|
|
|
|
const params = new URLSearchParams();
|
|
params.append('target_key', libraryId);
|
|
if (collectionId) {
|
|
params.append('target_collection_key', collectionId);
|
|
}
|
|
if (taskUuid) {
|
|
params.append('task_uuid', taskUuid);
|
|
}
|
|
if (isFailed !== undefined) {
|
|
params.append('is_failed', JSON.stringify(isFailed));
|
|
}
|
|
|
|
const { data } = await client.get(getModulestoreMigratedBlocksInfoUrl(), { params });
|
|
return camelCaseObject(data);
|
|
}
|