@instructure/canvas-rce 7.3.1 → 8.1.0

package/es/rce/style.js

@@ -18,7 +18,9 @@
 
 import { getThemeVars } from '../getThemeVars';
 import { darken, lighten, alpha } from '@instructure/ui-color-utils';
-export default function buildStyle() {
+
+/** @param {boolean} useHighContrast @param {string} [fontFamily] */
+export default function buildStyle(useHighContrast = false, fontFamily) {
   /*
    * If the theme variables to be used when generating the styles below
    * are dependent on the actual theme in use, you can also pull out the
@@ -28,7 +30,7 @@ export default function buildStyle() {
   const {
     variables,
     key
-  } = getThemeVars();
+  } = getThemeVars(useHighContrast, fontFamily);
   let themeCanvasLinkColor = '';
   let themeCanvasLinkDecoration = '';
   let themeCanvasTextColor = '';

package/es/rcs/api.d.ts

@@ -26,7 +26,7 @@ declare class RceApiSource {
         formExpanded: boolean;
     };
     initializeImages(props: any): {
-        [x: number]: {
+        [props.contextType]: {
             files: never[];
             bookmark: null;
             isLoading: boolean;
@@ -35,7 +35,7 @@ declare class RceApiSource {
         searchString: string;
     };
     initializeDocuments(props: any): {
-        [x: number]: {
+        [props.contextType]: {
             files: never[];
             bookmark: null;
             isLoading: boolean;
@@ -44,7 +44,7 @@ declare class RceApiSource {
         searchString: string;
     };
     initializeMedia(props: any): {
-        [x: number]: {
+        [props.contextType]: {
             files: never[];
             bookmark: null;
             isLoading: boolean;
@@ -52,11 +52,6 @@ declare class RceApiSource {
         };
         searchString: string;
     };
-    initializeFlickr(): {
-        searchResults: never[];
-        searching: boolean;
-        formExpanded: boolean;
-    };
     fetchPage(uri: any): Promise<any>;
     fetchBookmarkedData(fetchFunction: any, properties: any, onSuccess: any, onError: any, bookmark: any): any;
     fetchDocs(props: any): Promise<{
@@ -75,10 +70,11 @@ declare class RceApiSource {
     fetchRootFolder(props: any): Promise<any>;
     mediaServerSession(): Promise<any>;
     uploadMediaToCanvas(mediaObject: any): Promise<any>;
-    updateMediaObject(apiProps: any, { media_object_id, title, attachment_id }: {
+    updateMediaObject(apiProps: any, { media_object_id, title, attachment_id, viewerRestrictions }: {
         media_object_id: any;
         title: any;
         attachment_id: any;
+        viewerRestrictions?: {} | undefined;
     }): Promise<any>;
     updateClosedCaptions(apiProps: any, { media_object_id, attachment_id, subtitles }: {
         media_object_id: any;
@@ -107,7 +103,6 @@ declare class RceApiSource {
     uploadFRD(fileDomObject: any, preflightProps: any): Promise<any>;
     finalizeUpload(preflightProps: any, uploadResults: any): Promise<any>;
     setUsageRights(fileId: any, usageRights: any): Promise<any>;
-    searchFlickr(term: any, apiProps: any): Promise<any>;
     getFile(id: any, options?: {}): Promise<any>;
     addParamsIfPresent(uri: any, params: any): any;
     apiFetch(uri: any, headers: any, options: any): Promise<any>;

package/es/rcs/api.js

@@ -125,13 +125,6 @@ class RceApiSource {
   initializeMedia(props) {
     return this.initializeDocuments(props);
   }
-  initializeFlickr() {
-    return {
-      searchResults: [],
-      searching: false,
-      formExpanded: false
-    };
-  }
 
   // fetches the given URI and filters it to either an error or parsed response
   fetchPage(uri) {
@@ -213,10 +206,14 @@ class RceApiSource {
   updateMediaObject(apiProps, {
     media_object_id,
     title,
-    attachment_id
+    attachment_id,
+    viewerRestrictions = {}
   }) {
     const uri = attachment_id ? `${this.baseUri('media_attachments', apiProps.host)}/${attachment_id}?user_entered_title=${encodeURIComponent(title)}` : `${this.baseUri('media_objects', apiProps.host)}/${media_object_id}?user_entered_title=${encodeURIComponent(title)}`;
-    return this.apiPost(uri, headerFor(this.jwt), null, 'PUT');
+    const body = {
+      viewer_restrictions: viewerRestrictions
+    };
+    return this.apiPost(uri, headerFor(this.jwt), body, 'PUT');
   }
 
   // PUT to //RCS/api/media_objects/:mediaId/media_tracks [{locale, content}, ...]
@@ -346,7 +343,7 @@ class RceApiSource {
       fetchOptions.credentials = 'include';
     }
     return fetch(preflightProps.upload_url, fetchOptions).then(checkStatus).then(res => {
-      if (res.headers.get('content-type').includes('application/xml')) {
+      if (res.headers.get('content-type')?.includes('application/xml')) {
         if (res.status === 201) {
           return res.text().then(text => {
             const xmldoc = new window.DOMParser().parseFromString(text, 'application/xml');
@@ -403,12 +400,6 @@ class RceApiSource {
     };
     return this.apiPost(uri, headers, body);
   }
-  searchFlickr(term, apiProps) {
-    const headers = headerFor(this.jwt);
-    const base = this.baseUri('flickr_search', apiProps.host);
-    const uri = `${base}?term=${encodeURIComponent(term)}`;
-    return this.apiFetch(uri, headers);
-  }
   getFile(id, options = {}) {
     const headers = headerFor(this.jwt);
     const base = this.baseUri('file');
@@ -502,11 +493,14 @@ class RceApiSource {
       } else {
         return response;
       }
-    }).then(checkStatus).then(res => res.json()).catch(throwConnectionError).catch(e => e.response.json().then(responseBody => {
-      console.error(e);
-      this.alertFunc(buildError(responseBody));
-      throw e;
-    }));
+    }).then(checkStatus).then(res => res.json()).catch(throwConnectionError).catch(e => {
+      if (!e.response) throw e;
+      return e.response.json().then(responseBody => {
+        console.error(e);
+        this.alertFunc(buildError(responseBody));
+        throw e;
+      });
+    });
   }
 
   // @private

package/es/rcs/fake.d.ts

@@ -16,7 +16,7 @@ export function getSession(): Promise<{
 }>;
 export function initializeFolders(): {};
 export function initializeImages(props: any): {
-    [x: number]: {
+    [props.contextType]: {
         files: never[];
         bookmark: undefined;
         hasMore: boolean;
@@ -28,11 +28,6 @@ export function initializeUpload(): {
     folders: {};
     formExpanded: boolean;
 };
-export function initializeFlickr(): {
-    searchResults: never[];
-    searching: boolean;
-    formExpanded: boolean;
-};
 export function initializeCollection(endpoint: any): {
     links: never[];
     bookmark: any;
@@ -90,7 +85,6 @@ export function fetchRootFolder(props: any): Promise<{
     }[];
 }>;
 export function fetchPage(uri: any): Promise<any>;
-export function searchFlickr(term: any): Promise<any>;
 export function setUsageRights(id: any, usageRights: any): void;
 export function getFile(id: any): Promise<{
     id: any;

package/es/rcs/fake.js

@@ -317,34 +317,6 @@ const IMAGE_RESPONSES = [{
   bookmarkForThis: 'http://canvas/images/3',
   files: images.slice(20)
 }];
-const FLICKR_RESULTS = {
-  go: [{
-    id: '1',
-    href: 'https://farm9.static.flickr.com/8491/8297692520_4e7a43ffcf_s.jpg',
-    title: 'Game of Go in our club.'
-  }, {
-    id: '2',
-    href: 'https://farm1.static.flickr.com/5/7270219_6d3f41bc71_s.jpg',
-    title: 'Another game of Go'
-  }, {
-    id: '3',
-    href: 'https://farm1.static.flickr.com/8/9686480_c726bf6c5d_s.jpg',
-    title: 'the fourth game'
-  }],
-  chess: [{
-    id: '4',
-    href: 'https://farm5.static.flickr.com/4051/4627936161_39df5d616a_s.jpg',
-    title: 'Chess.'
-  }, {
-    id: '5',
-    href: 'https://farm8.static.flickr.com/7428/9646564428_0e359a1092_s.jpg',
-    title: 'chess'
-  }, {
-    id: '6',
-    href: 'https://farm9.static.flickr.com/8309/7961751980_66333f83cf_s.jpg',
-    title: 'champion chess'
-  }]
-};
 function makeFiles(bookmark_base, extension, content_type) {
   return {
     [`${bookmark_base}1`]: {
@@ -407,13 +379,6 @@ export function initializeUpload() {
     formExpanded: false
   };
 }
-export function initializeFlickr() {
-  return {
-    searchResults: [],
-    searching: false,
-    formExpanded: false
-  };
-}
 export function initializeCollection(endpoint) {
   return {
     links: [],
@@ -521,20 +486,9 @@ export function fetchPage(uri) {
     }, 1000);
   });
 }
-export function searchFlickr(term) {
-  return new Promise((resolve, reject) => {
-    setTimeout(() => {
-      if (FLICKR_RESULTS[term]) {
-        resolve(FLICKR_RESULTS[term]);
-      } else {
-        reject(new Error('No search results!'));
-      }
-    }, 1000);
-  });
-}
 export function setUsageRights(id, usageRights) {
   const msg = 'Setting the following usage rights for file (id: %s):';
-  console.log(msg, id, usageRights); // eslint-disable-line no-console
+  console.log(msg, id, usageRights);
 }
 export function getFile(id) {
   return Promise.resolve({

package/es/sidebar/actions/media.d.ts

@@ -34,12 +34,25 @@ export function failMedia({ error, contextType }: {
 export function fetchMedia(): (dispatch: any, getState: any) => any;
 export function fetchNextMedia(): (dispatch: any, getState: any) => any;
 export function fetchInitialMedia(): (dispatch: any, getState: any) => any;
-export function updateMediaObject({ media_object_id, attachment_id, title, subtitles }: {
-    media_object_id: any;
-    attachment_id: any;
-    title: any;
-    subtitles: any;
-}): (dispatch: any, getState: any) => Promise<[any, any]>;
+/**
+ * Update a media object's title and optionally its closed captions
+ * @param {Object} params
+ * @param {string} params.media_object_id - Media object ID
+ * @param {string} params.attachment_id - Attachment ID (if video from file upload)
+ * @param {string} params.title - New title for the media
+ * @param {Array} params.subtitles - Subtitle/caption data (optional)
+ * @param {boolean} params.skipCaptionUpdate - If true, skip updating captions even if subtitles provided (default: false)
+ * @param {Object} params.viewerRestrictions - Viewer restrictions to apply for this media (default: {})
+ * @returns {Function} Redux thunk
+ */
+export function updateMediaObject({ media_object_id, attachment_id, title, subtitles, skipCaptionUpdate, viewerRestrictions, }: {
+    media_object_id: string;
+    attachment_id: string;
+    title: string;
+    subtitles: any[];
+    skipCaptionUpdate: boolean;
+    viewerRestrictions: Object;
+}): Function;
 export const REQUEST_INITIAL_MEDIA: "REQUEST_INITIAL_MEDIA";
 export const REQUEST_MEDIA: "REQUEST_MEDIA";
 export const RECEIVE_MEDIA: "RECEIVE_MEDIA";

package/es/sidebar/actions/media.js

@@ -108,19 +108,32 @@ export function fetchInitialMedia() {
   };
 }
 
-// update the media object.
+/**
+ * Update a media object's title and optionally its closed captions
+ * @param {Object} params
+ * @param {string} params.media_object_id - Media object ID
+ * @param {string} params.attachment_id - Attachment ID (if video from file upload)
+ * @param {string} params.title - New title for the media
+ * @param {Array} params.subtitles - Subtitle/caption data (optional)
+ * @param {boolean} params.skipCaptionUpdate - If true, skip updating captions even if subtitles provided (default: false)
+ * @param {Object} params.viewerRestrictions - Viewer restrictions to apply for this media (default: {})
+ * @returns {Function} Redux thunk
+ */
 export function updateMediaObject({
   media_object_id,
   attachment_id,
   title,
-  subtitles
+  subtitles,
+  skipCaptionUpdate = false,
+  viewerRestrictions
 }) {
   return (dispatch, getState) => {
     const state = getState();
     const moUpdate = state.source.updateMediaObject(state, {
       media_object_id,
       title,
-      attachment_id
+      attachment_id,
+      viewerRestrictions
     }).catch(e => {
       alertHandler.handleAlert({
         text: formatMessage('Though your video will have the correct title in the browser, we failed to update it in the database.'),
@@ -135,7 +148,7 @@ export function updateMediaObject({
     if (attachment_id) {
       ccData.attachment_id = attachment_id;
     }
-    const ccUpdate = state.source.updateClosedCaptions(state, ccData);
+    const ccUpdate = skipCaptionUpdate ? Promise.resolve() : state.source.updateClosedCaptions(state, ccData);
     return Promise.all([moUpdate, ccUpdate]);
   };
 }

package/es/sidebar/actions/upload.d.ts

@@ -86,19 +86,19 @@ export function allUploadCompleteActions(results: any, fileMetaProps: any, conte
     type: string;
     results: any;
 })[];
-export function embedUploadResult(results: any, selectedTabType: any): any;
+export function embedUploadResult(results: any): any;
 export function fetchFolders(bookmark: any): (dispatch: any, getState: any) => any;
 export function mediaUploadComplete(error: any, uploadData: any): (dispatch: any, _getState: any) => void;
 export function createMediaServerSession(): (dispatch: any, getState: any) => any;
 export function uploadToIconMakerFolder(svg: any, uploadSettings?: {}): (_dispatch: any, getState: any) => any;
 export function uploadToMediaFolderWithoutEditor(fileMetaProps: any): (_: any, getState: any) => any;
-export function uploadToMediaFolder(tabContext: any, fileMetaProps: any): (dispatch: any, getState: any) => any;
+export function uploadToMediaFolder(fileMetaProps: any): (dispatch: any, getState: any) => any;
 export function setUsageRights(source: any, fileMetaProps: any, results: any): any;
 export function getFileUrlIfMissing(source: any, results: any): any;
 export function generateThumbnailUrl(results: any, fileDOMObject: any, reader: any): Promise<any>;
 export function setAltText(altText: any, results: any): any;
 export function handleFailures(error: any, dispatch: any): any;
-export function uploadPreflight(tabContext: any, fileMetaProps: any): (dispatch: any, getState: any) => Promise<any>;
+export function uploadPreflight(fileMetaProps: any): (dispatch: any, getState: any) => Promise<any>;
 export const COMPLETE_FILE_UPLOAD: "COMPLETE_FILE_UPLOAD";
 export const FAIL_FILE_UPLOAD: "FAIL_FILE_UPLOAD";
 export const FAIL_FOLDERS_LOAD: "FAIL_FOLDERS_LOAD";

package/es/sidebar/actions/upload.js

@@ -158,9 +158,9 @@ export function allUploadCompleteActions(results, fileMetaProps, contextType) {
   }
   return actions;
 }
-export function embedUploadResult(results, selectedTabType) {
+export function embedUploadResult(results) {
   const embedData = fileEmbed(results);
-  if (selectedTabType === 'images' && isImage(embedData.type) && results.displayAs !== 'link') {
+  if (isImage(embedData.type) && results.displayAs !== 'link') {
     // embed the image after any current selection rather than link to it or replace it
     bridge.activeEditor()?.mceInstance()?.selection.collapse();
     const file_props = {
@@ -175,7 +175,7 @@ export function embedUploadResult(results, selectedTabType) {
       uuid: results.uuid
     };
     return bridge.insertImage(file_props);
-  } else if (selectedTabType === 'media' && isAudioOrVideo(embedData.type)) {
+  } else if (isAudioOrVideo(embedData.type)) {
     // embed media after any current selection rather than link to it or replace it
     bridge.activeEditor()?.mceInstance()?.selection.collapse();
 
@@ -270,7 +270,7 @@ export function mediaUploadComplete(error, uploadData) {
         contextType: mediaObject.media_object.context_type
       };
       dispatch(removePlaceholdersFor(uploadedFile.name));
-      embedUploadResult(embedData, 'media');
+      embedUploadResult(embedData);
       dispatch(mediaUploadSuccess());
     }
   };
@@ -386,7 +386,7 @@ export function uploadToMediaFolderWithoutEditor(fileMetaProps) {
     });
   };
 }
-export function uploadToMediaFolder(tabContext, fileMetaProps) {
+export function uploadToMediaFolder(fileMetaProps) {
   return (dispatch, getState) => {
     const editorComponent = bridge.activeEditor();
     const bookmark = editorComponent?.editor?.selection.getBookmark(undefined, true);
@@ -398,7 +398,7 @@ export function uploadToMediaFolder(tabContext, fileMetaProps) {
       contextId,
       contextType
     } = getState();
-    if (tabContext === 'media' && fileMetaProps.domObject) {
+    if (isAudioOrVideo(fileMetaProps.contentType) && fileMetaProps.domObject) {
       return saveMediaRecording(fileMetaProps.domObject, {
         contextId,
         contextType,
@@ -420,7 +420,7 @@ export function uploadToMediaFolder(tabContext, fileMetaProps) {
       if (fileMetaProps.domObject) {
         delete fileMetaProps.domObject.preview; // don't need this anymore
       }
-      return dispatch(uploadPreflight(tabContext, {
+      return dispatch(uploadPreflight({
         ...fileMetaProps,
         bookmark
       })).then(results => {
@@ -493,7 +493,7 @@ export function handleFailures(error, dispatch) {
     return Promise.resolve().then(() => dispatch(failUpload(error)));
   }
 }
-export function uploadPreflight(tabContext, fileMetaProps) {
+export function uploadPreflight(fileMetaProps) {
   return (dispatch, getState) => {
     const {
       source,
@@ -549,7 +549,7 @@ export function uploadPreflight(tabContext, fileMetaProps) {
           contextId,
           ...results
         };
-        const embedResult = embedUploadResult(uploadResult, tabContext);
+        const embedResult = embedUploadResult(uploadResult);
         if (fileMetaProps.bookmark) {
           editorComponent.editor.selection.moveToBookmark(newBookmark);
         }

package/es/sidebar/containers/Sidebar.js

@@ -28,7 +28,6 @@ export function propsFromState(state) {
     media,
     folders,
     rootFolderId,
-    flickr,
     upload,
     session,
     newPageLinkExpanded,
@@ -53,7 +52,6 @@ export function propsFromState(state) {
     media,
     folders,
     rootFolderId,
-    flickr,
     upload,
     session,
     newPageLinkExpanded,

package/es/sidebar/containers/sidebarHandlers.d.ts

@@ -12,13 +12,11 @@ export default function propsFromDispatch(dispatch: any): {
     fetchNextImages: (opts?: {
         category: string;
     }) => any;
-    startUpload: (tabContext: any, fileMetaProps: any) => any;
-    flickrSearch: (term: any) => any;
-    toggleFlickrForm: () => any;
+    startUpload: (fileMetaProps: any) => any;
     toggleUploadForm: () => any;
     toggleNewPageForm: () => any;
     startIconMakerUpload: (fileMetaProps: any, uploadSettings: any) => any;
-    startMediaUpload: (tabContext: any, fileMetaProps: any) => any;
+    startMediaUpload: (fileMetaProps: any) => any;
     startMediaUploadInStandaloneMode: (fileMetaProps: any) => any;
     createMediaServerSession: () => any;
     mediaUploadComplete: (error: any, uploadData: any) => any;

package/es/sidebar/containers/sidebarHandlers.js

@@ -22,7 +22,6 @@ import { fetchInitialImages, fetchNextImages } from '../actions/images';
 import { createMediaServerSession, fetchFolders, openOrCloseUploadForm,
 // saveMediaRecording,
 mediaUploadComplete, uploadPreflight, uploadToIconMakerFolder, uploadToMediaFolder, uploadToMediaFolderWithoutEditor } from '../actions/upload';
-import { searchFlickr, openOrCloseFlickrForm } from '../actions/flickr';
 import { toggle as toggleFolder } from '../actions/files';
 import { openOrCloseNewPageForm } from '../actions/links';
 import { fetchInitialDocs, fetchNextDocs } from '../actions/documents';
@@ -46,13 +45,11 @@ export default function propsFromDispatch(dispatch) {
     fetchNextImages: (opts = {
       category: DEFAULT_FILE_CATEGORY
     }) => dispatch(fetchNextImages(opts)),
-    startUpload: (tabContext, fileMetaProps) => dispatch(uploadPreflight(tabContext, fileMetaProps)),
-    flickrSearch: term => dispatch(searchFlickr(term)),
-    toggleFlickrForm: () => dispatch(openOrCloseFlickrForm()),
+    startUpload: fileMetaProps => dispatch(uploadPreflight(fileMetaProps)),
     toggleUploadForm: () => dispatch(openOrCloseUploadForm()),
     toggleNewPageForm: () => dispatch(openOrCloseNewPageForm()),
     startIconMakerUpload: (fileMetaProps, uploadSettings) => dispatch(uploadToIconMakerFolder(fileMetaProps, uploadSettings)),
-    startMediaUpload: (tabContext, fileMetaProps) => dispatch(uploadToMediaFolder(tabContext, fileMetaProps)),
+    startMediaUpload: fileMetaProps => dispatch(uploadToMediaFolder(fileMetaProps)),
     startMediaUploadInStandaloneMode: fileMetaProps => dispatch(uploadToMediaFolderWithoutEditor(fileMetaProps)),
     createMediaServerSession: () => dispatch(createMediaServerSession()),
     // saveMediaRecording: (file, editor, dismiss) => dispatch(saveMediaRecording(file, editor, dismiss)),

package/es/sidebar/reducers/index.d.ts

@@ -37,7 +37,6 @@ declare const _default: import("redux").Reducer<import("redux").CombinedState<{
         loadingFolders: boolean;
         uploadingMediaStatus: never;
     }>;
-    flickr: {};
     session: any;
     newPageLinkExpanded: boolean;
 }>, any>;

package/es/sidebar/reducers/index.js

@@ -26,7 +26,6 @@ import imagesReducer from './images';
 import documentsReducer from './documents';
 import mediaReducer from './media';
 import upload from './upload';
-import flickrReducer from './flickr';
 import session from './session';
 import newPageLinkReducer from './newPageLinkExpanded';
 import { changeContextType, changeContextId, changeSearchString, changeSortBy } from './filter';
@@ -53,7 +52,6 @@ export default combineReducers({
   documents: documentsReducer,
   media: mediaReducer,
   upload,
-  flickr: flickrReducer,
   session,
   newPageLinkExpanded: newPageLinkReducer
 });

package/es/sidebar/store/initialState.d.ts

@@ -14,7 +14,6 @@ export default function _default(props?: {}): {
     images: any;
     documents: any;
     media: any;
-    flickr: any;
     newPageLinkExpanded: any;
     searchString: any;
     sortBy: any;

package/es/sidebar/store/initialState.js

@@ -52,7 +52,6 @@ export default function (props = {}) {
     images,
     documents,
     media,
-    flickr,
     newPageLinkExpanded,
     searchString,
     sortBy,
@@ -111,9 +110,6 @@ export default function (props = {}) {
   if (upload === undefined) {
     upload = source.initializeUpload(props);
   }
-  if (flickr === undefined) {
-    flickr = source.initializeFlickr(props);
-  }
   if (images === undefined) {
     images = source.initializeImages(props);
   }
@@ -152,7 +148,6 @@ export default function (props = {}) {
     images,
     documents,
     media,
-    flickr,
     newPageLinkExpanded,
     searchString,
     sortBy,