@instructure/canvas-rce 5.14.1 → 5.15.0

package/es/rcs/api.js

@@ -15,13 +15,14 @@
  * You should have received a copy of the GNU Affero General Public License along
  * with this program. If not, see <http://www.gnu.org/licenses/>.
  */
+
 import 'isomorphic-fetch';
-import { parse } from 'url';
 import { saveClosedCaptions, saveClosedCaptionsForAttachment, CONSTANTS } from '@instructure/canvas-media';
 import { downloadToWrap, fixupFileUrl } from '../common/fileUrl';
 import alertHandler from '../rce/alertHandler';
 import buildError from './buildError';
 import RCEGlobals from '../rce/RCEGlobals';
+import { parseUrlPath } from '../util/url-util';
 export function headerFor(jwt) {
   return {
     Authorization: 'Bearer ' + jwt
@@ -29,23 +30,19 @@ export function headerFor(jwt) {
 }
 export function originFromHost(host, windowOverride) {
   let origin = host;
-
   if (typeof origin !== 'string') {
     origin = '';
   } else if (origin && origin.substr(0, 4) !== 'http') {
-    var _windowHandle$locatio;
-
     origin = `//${origin}`;
     const windowHandle = windowOverride || (typeof window !== 'undefined' ? window : undefined);
-
-    if (origin.length > 0 && windowHandle !== null && windowHandle !== void 0 && (_windowHandle$locatio = windowHandle.location) !== null && _windowHandle$locatio !== void 0 && _windowHandle$locatio.protocol) {
+    if (origin.length > 0 && windowHandle?.location?.protocol) {
       origin = `${windowHandle.location.protocol}${origin}`;
     }
   }
-
   return origin;
-} // filter a response to raise an error on a 400+ status
+}
 
+// filter a response to raise an error on a 400+ status
 function checkStatus(response) {
   if (response.status < 400) {
     return response;
@@ -55,11 +52,9 @@ function checkStatus(response) {
     throw error;
   }
 }
-
 function defaultRefreshTokenHandler() {
   throw new Error('Token expired, no refresh function provided');
 }
-
 function normalizeFileData(file) {
   return {
     // copy the name to the default display name if none provided
@@ -69,22 +64,17 @@ function normalizeFileData(file) {
     href: downloadToWrap(file.href || file.url)
   };
 }
-
 function throwConnectionError(error) {
   if (error.name === 'TypeError') {
-    // eslint-disable-next-line no-console
     console.error(`Failed to fetch from the canvas-rce-api.
       Did you forget to start it or configure it?
       Details can be found at https://github.com/instructure/canvas-rce-api
     `);
   }
-
   throw error;
 }
-
 class RceApiSource {
-  constructor() {
-    let options = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+  constructor(options = {}) {
     this.jwt = options.jwt;
     this.host = options.host;
     this.refreshToken = options.refreshToken || defaultRefreshTokenHandler;
@@ -92,7 +82,6 @@ class RceApiSource {
     this.alertFunc = options.alertFunc || alertHandler.handleAlert;
     this.canvasOrigin = options.canvasOrigin || window.origin;
   }
-
   getSession() {
     const headers = headerFor(this.jwt);
     const uri = this.baseUri('session');
@@ -100,10 +89,10 @@ class RceApiSource {
       this.hasSession = true;
       return data;
     }).catch(throwConnectionError);
-  } // initial state of a collection is empty, not loading, with bookmark set to
-  // uri for initial page fetch
-
+  }
 
+  // initial state of a collection is empty, not loading, with bookmark set to
+  // uri for initial page fetch
   initializeCollection(endpoint, props) {
     return {
       links: [],
@@ -113,7 +102,6 @@ class RceApiSource {
       searchString: props.searchString
     };
   }
-
   initializeUpload() {
     return {
       uploading: false,
@@ -121,11 +109,9 @@ class RceApiSource {
       formExpanded: false
     };
   }
-
   initializeImages(props) {
     return this.initializeDocuments(props);
   }
-
   initializeDocuments(props) {
     return {
       [props.contextType]: {
@@ -137,28 +123,24 @@ class RceApiSource {
       searchString: ''
     };
   }
-
   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
-
+  }
 
+  // fetches the given URI and filters it to either an error or parsed response
   fetchPage(uri) {
     return this.apiFetch(uri, headerFor(this.jwt));
   }
-
   fetchBookmarkedData(fetchFunction, properties, onSuccess, onError, bookmark) {
     return fetchFunction(properties, bookmark).then(result => {
       onSuccess(result);
-
       if (result.bookmark) {
         this.fetchBookmarkedData(fetchFunction, properties, onSuccess, onError, result.bookmark);
       }
@@ -166,57 +148,46 @@ class RceApiSource {
       onError(error);
     });
   }
-
   fetchDocs(props) {
     const documents = props.documents[props.contextType];
     const uri = documents.bookmark || this.uriFor('documents', props);
-    return this.apiFetch(uri, headerFor(this.jwt)).then(_ref => {
-      let {
-        bookmark,
-        files
-      } = _ref;
+    return this.apiFetch(uri, headerFor(this.jwt)).then(({
+      bookmark,
+      files
+    }) => {
       return {
         bookmark,
         files: files.map(f => fixupFileUrl(props.contextType, props.contextId, f, this.canvasOrigin))
       };
     });
   }
-
   fetchMedia(props) {
-    var _RCEGlobals$getFeatur;
-
     const media = props.media[props.contextType];
     const uri = media.bookmark || this.uriFor('media', props);
-
-    if ((_RCEGlobals$getFeatur = RCEGlobals.getFeatures()) !== null && _RCEGlobals$getFeatur !== void 0 && _RCEGlobals$getFeatur.media_links_use_attachment_id) {
-      return this.apiFetch(uri, headerFor(this.jwt)).then(_ref2 => {
-        let {
-          bookmark,
-          files
-        } = _ref2;
+    if (RCEGlobals.getFeatures()?.media_links_use_attachment_id) {
+      return this.apiFetch(uri, headerFor(this.jwt)).then(({
+        bookmark,
+        files
+      }) => {
         return {
           bookmark,
           files: files.map(f => fixupFileUrl(props.contextType, props.contextId, f, this.canvasOrigin))
         };
       });
     }
-
     return this.apiFetch(uri, headerFor(this.jwt));
   }
-
   fetchFiles(uri) {
-    return this.fetchPage(uri).then(_ref3 => {
-      let {
-        bookmark,
-        files
-      } = _ref3;
+    return this.fetchPage(uri).then(({
+      bookmark,
+      files
+    }) => {
       return {
         bookmark,
         files: files.map(normalizeFileData)
       };
     });
   }
-
   fetchLinks(key, props) {
     const {
       collections
@@ -224,15 +195,12 @@ class RceApiSource {
     const bookmark = collections[key].bookmark || this.uriFor(key, props);
     return this.fetchPage(bookmark);
   }
-
   fetchRootFolder(props) {
     return this.fetchPage(this.uriFor('folders', props), this.jwt);
   }
-
   mediaServerSession() {
     return this.apiPost(this.baseUri('v1/services/kaltura_session'), headerFor(this.jwt), {});
   }
-
   uploadMediaToCanvas(mediaObject) {
     const body = {
       id: mediaObject.entryId,
@@ -246,28 +214,22 @@ class RceApiSource {
     };
     return this.apiPost(this.baseUri('media_objects'), headerFor(this.jwt), body);
   }
-
-  updateMediaObject(apiProps, _ref4) {
-    var _RCEGlobals$getFeatur2;
-
-    let {
-      media_object_id,
-      title,
-      attachment_id
-    } = _ref4;
-    const uri = (_RCEGlobals$getFeatur2 = RCEGlobals.getFeatures()) !== null && _RCEGlobals$getFeatur2 !== void 0 && _RCEGlobals$getFeatur2.media_links_use_attachment_id && 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)}`;
+  updateMediaObject(apiProps, {
+    media_object_id,
+    title,
+    attachment_id
+  }) {
+    const uri = RCEGlobals.getFeatures()?.media_links_use_attachment_id && 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');
-  } // PUT to //RCS/api/media_objects/:mediaId/media_tracks [{locale, content}, ...]
-  // receive back a 200 with the new subtitles, or a 4xx error
-
+  }
 
-  updateClosedCaptions(apiProps, _ref5) {
-    let {
-      media_object_id,
-      attachment_id,
-      subtitles
-    } = _ref5;
-    let maxBytes = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : CONSTANTS.CC_FILE_MAX_BYTES;
+  // PUT to //RCS/api/media_objects/:mediaId/media_tracks [{locale, content}, ...]
+  // receive back a 200 with the new subtitles, or a 4xx error
+  updateClosedCaptions(apiProps, {
+    media_object_id,
+    attachment_id,
+    subtitles
+  }, maxBytes = CONSTANTS.CC_FILE_MAX_BYTES) {
     const rcsConfig = {
       origin: originFromHost(apiProps.host),
       headers: headerFor(apiProps.jwt)
@@ -278,10 +240,10 @@ class RceApiSource {
         message: 'failed to save captions'
       }, e));
     });
-  } // GET /media_objects/:mediaId/media_tracks
-  // receive back the current list of media_tracks
-
+  }
 
+  // GET /media_objects/:mediaId/media_tracks
+  // receive back the current list of media_tracks
   fetchClosedCaptions(_mediaId) {
     return Promise.resolve([{
       locale: 'af',
@@ -290,47 +252,40 @@ class RceApiSource {
       locale: 'es',
       content: '1\r\n00:00:00,000 --> 00:00:01,251\r\nThis is the content\r\n'
     }]);
-  } // fetches folders for the given context to upload files to
-
+  }
 
+  // fetches folders for the given context to upload files to
   fetchFolders(props, bookmark) {
     const headers = headerFor(this.jwt);
     const uri = bookmark || this.uriFor('folders/all', props);
     return this.apiFetch(uri, headers);
-  } // Fetches all files for a given folder
-
+  }
 
+  // Fetches all files for a given folder
   fetchFilesForFolder(props, bookmark) {
     let uri;
-
     if (!bookmark) {
       const perPageQuery = props.perPage ? `per_page=${props.perPage}` : '';
       const searchParam = getSearchParam(props.searchString);
       uri = `${props.filesUrl}`;
       uri += perPageQuery ? `?${perPageQuery}` : '';
-
       if (searchParam) {
         uri += perPageQuery ? `${searchParam}` : `?${searchParam}`;
       }
-
       if (props.sortBy) {
         uri += `${getSortParams(props.sortBy.sort, props.sortBy.order)}`;
       }
     }
-
     return this.fetchPage(uri || bookmark, this.jwt);
   }
-
   fetchSubFolders(props, bookmark) {
     const uri = bookmark || `${this.baseUri('folders', props.host)}/${props.folderId}`;
     return this.apiFetch(uri, headerFor(this.jwt));
   }
-
-  fetchIconMakerFolder(_ref6) {
-    let {
-      contextId,
-      contextType
-    } = _ref6;
+  fetchIconMakerFolder({
+    contextId,
+    contextType
+  }) {
     const uri = this.uriFor('folders/icon_maker', {
       contextId,
       contextType,
@@ -339,32 +294,26 @@ class RceApiSource {
     });
     return this.fetchPage(uri);
   }
-
   fetchMediaFolder(props) {
     let uri;
-
     if (props.contextType === 'user') {
       uri = this.uriFor('folders', props);
     } else {
       uri = this.uriFor('folders/media', props);
     }
-
     return this.fetchPage(uri);
   }
-
   fetchMediaObjectIframe(mediaObjectId) {
     return this.fetchPage(this.uriFor(`media_objects_iframe/${mediaObjectId}`));
   }
-
   fetchImages(props) {
     const images = props.images[props.contextType];
     const uri = images.bookmark || this.uriFor('images', props);
     const headers = headerFor(this.jwt);
-    return this.apiFetch(uri, headers).then(_ref7 => {
-      let {
-        bookmark,
-        files
-      } = _ref7;
+    return this.apiFetch(uri, headers).then(({
+      bookmark,
+      files
+    }) => {
       return {
         bookmark,
         files: files.map(f => fixupFileUrl(props.contextType, props.contextId, f, this.canvasOrigin)),
@@ -372,7 +321,6 @@ class RceApiSource {
       };
     });
   }
-
   preflightUpload(fileProps, apiProps) {
     const headers = headerFor(this.jwt);
     const uri = this.baseUri('upload', apiProps.host);
@@ -386,7 +334,6 @@ class RceApiSource {
     };
     return this.apiPost(uri, headers, body);
   }
-
   uploadFRD(fileDomObject, preflightProps) {
     const data = new window.FormData();
     Object.keys(preflightProps.upload_params).forEach(uploadProp => {
@@ -397,20 +344,33 @@ class RceApiSource {
       method: 'POST',
       body: data
     };
-
     if (!preflightProps.upload_params['x-amz-signature'] && !preflightProps.upload_url.includes('files_api')) {
       // _not_ an S3 upload, include the credentials in the upload POST
       // local uploads can include crendentials for same-origin requests
       fetchOptions.credentials = 'include';
     }
-
-    return fetch(preflightProps.upload_url, fetchOptions).then(checkStatus).then(res => res.json()).then(uploadResults => {
+    return fetch(preflightProps.upload_url, fetchOptions).then(checkStatus).then(res => {
+      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');
+            const location = xmldoc.querySelector('Location').textContent;
+            return {
+              Location: location
+            };
+          });
+        } else {
+          throw new Error('upload failed to create the file');
+        }
+      } else {
+        return res.json();
+      }
+    }).then(uploadResults => {
       return this.finalizeUpload(preflightProps, uploadResults);
     }).catch(e => {
       this.alertFunc(buildError({}, e));
     });
   }
-
   finalizeUpload(preflightProps, uploadResults) {
     if (preflightProps.upload_params.success_url) {
       // s3 upload, follow-up at success_url to finalize. the success_url doesn't
@@ -421,21 +381,16 @@ class RceApiSource {
       // response. we can't just fetch the location as would be intended because
       // it requires Canvas authentication. we also don't have an RCE API
       // endpoint to forward it through.
-      const {
-        pathname
-      } = parse(uploadResults.location);
+      const pathname = parseUrlPath(uploadResults.location);
       const matchData = pathname.match(/^\/api\/v1\/files\/((?:\d+~)?\d+)$/);
-
       if (!matchData) {
         const error = new Error('cannot determine file ID from location');
         error.location = uploadResults.location;
         throw error;
       }
-
       const fileId = matchData[1];
       return this.getFile(fileId).then(fileResults => {
         fileResults.uuid = uploadResults.uuid; // if present, we'll need the uuid for the file verifier downstream
-
         return fileResults;
       });
     } else {
@@ -443,7 +398,6 @@ class RceApiSource {
       return Promise.resolve(uploadResults);
     }
   }
-
   setUsageRights(fileId, usageRights) {
     const headers = headerFor(this.jwt);
     const uri = this.baseUri('usage_rights');
@@ -453,19 +407,17 @@ 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) {
-    let options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+  getFile(id, options = {}) {
     const headers = headerFor(this.jwt);
-    const base = this.baseUri('file'); // Valid query parameters for getFile
+    const base = this.baseUri('file');
 
+    // Valid query parameters for getFile
     const {
       replacement_chain_context_type,
       replacement_chain_context_id,
@@ -477,39 +429,34 @@ class RceApiSource {
       include
     });
     return this.apiFetch(uri, headers).then(normalizeFileData);
-  } // @private
-
+  }
 
+  // @private
   addParamsIfPresent(uri, params) {
     let url;
-
     try {
       url = new URL(uri);
-    } catch (e) {
+    } catch (_e) {
       // Just return the URI if it was invalid
       return uri;
-    } // Add all truthy parameters to the URL
-
+    }
 
+    // Add all truthy parameters to the URL
     for (const [name, value] of Object.entries(params)) {
       if (!value) continue;
       url.searchParams.append(name, value);
     }
-
     return url.toString();
-  } // @private
-
+  }
 
+  // @private
   async apiFetch(uri, headers, options) {
     if (!this.hasSession) {
       await this.getSession();
     }
-
     return this.apiReallyFetch(uri, headers, options);
   }
-
-  apiReallyFetch(uri, headers) {
-    let options = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
+  apiReallyFetch(uri, headers, options = {}) {
     uri = this.normalizeUriProtocol(uri);
     return fetch(uri, {
       headers
@@ -528,31 +475,30 @@ class RceApiSource {
       this.alertFunc(buildError(e));
       throw e;
     });
-  } // @private
-
+  }
 
-  apiPost(uri, headers, body) {
-    let method = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : 'POST';
-    headers = { ...headers,
+  // @private
+  apiPost(uri, headers, body, method = 'POST') {
+    headers = {
+      ...headers,
       'Content-Type': 'application/json'
     };
     const fetchOptions = {
       method,
       headers
     };
-
     if (body) {
       fetchOptions.body = JSON.stringify(body);
     } else {
       fetchOptions.form = body;
     }
-
     uri = this.normalizeUriProtocol(uri);
     return fetch(uri, fetchOptions).then(response => {
       if (response.status === 401) {
         // retry once with fresh token
         return this.buildRetryHeaders(fetchOptions.headers).then(newHeaders => {
-          const newOptions = { ...fetchOptions,
+          const newOptions = {
+            ...fetchOptions,
             headers: newHeaders
           };
           return fetch(uri, newOptions);
@@ -561,55 +507,50 @@ class RceApiSource {
         return response;
       }
     }).then(checkStatus).then(res => res.json()).catch(throwConnectionError).catch(e => e.response.json().then(responseBody => {
-      console.error(e); // eslint-disable-line no-console
-
+      console.error(e);
       this.alertFunc(buildError(responseBody));
       throw e;
     }));
-  } // @private
-
+  }
 
+  // @private
   normalizeUriProtocol(uri, windowOverride) {
     const windowHandle = windowOverride || (typeof window !== 'undefined' ? window : undefined);
-
     if (windowHandle && windowHandle.location && windowHandle.location.protocol === 'https:') {
       return uri.replace('http://', 'https://');
     }
-
     return uri;
-  } // @private
-
+  }
 
+  // @private
   buildRetryHeaders(headers) {
     return new Promise(resolve => {
       this.refreshToken(freshToken => {
         this.jwt = freshToken;
         const freshHeader = headerFor(freshToken);
-        const mergedHeaders = { ...headers,
+        const mergedHeaders = {
+          ...headers,
           ...freshHeader
         };
         resolve(mergedHeaders);
       });
     });
   }
-
   baseUri(endpoint, host, windowOverride) {
     if (!host && this.host) {
       host = this.host;
     }
-
     host = originFromHost(host, windowOverride);
     const sharedEndpoints = ['images', 'media', 'documents', 'all']; // 'all' will eventually be something different
-
     const endpt = sharedEndpoints.includes(endpoint) ? 'documents' : endpoint;
     return `${host}/api/${endpt}`;
-  } // returns the URI to use with the fetchPage method to fetch the first page of
+  }
+
+  // returns the URI to use with the fetchPage method to fetch the first page of
   // the given endpoint. e.g. for wikiPages it might return:
   //
   //   //rce.docker/api/wikiPages?context_type=course&context_id=42
   //
-
-
   uriFor(endpoint, props) {
     const {
       host,
@@ -621,52 +562,40 @@ class RceApiSource {
     } = props;
     let extra = '';
     const pageSizeParam = perPage ? `&per_page=${perPage}` : '';
-
     switch (endpoint) {
       case 'images':
         extra = `&content_types=image${getSortParams(sortBy.sort, sortBy.dir)}${getSearchParam(searchString)}${optionalQuery(props, 'category')}`;
         break;
-
       case 'media':
         // when requesting media files via the documents endpoint
         extra = `&content_types=video,audio${getSortParams(sortBy.sort, sortBy.dir)}${getSearchParam(searchString)}`;
         break;
-
       case 'documents':
         extra = `&exclude_content_types=image,video,audio${getSortParams(sortBy.sort, sortBy.dir)}${getSearchParam(searchString)}`;
         break;
-
       case 'media_objects':
         // when requesting media objects (this is the currently used branch)
         extra = `${getSortParams(sortBy.sort === 'alphabetical' ? 'title' : 'date', sortBy.dir)}${getSearchParam(searchString)}`;
         break;
-
       default:
         extra = getSearchParam(searchString);
     }
-
     return `${this.baseUri(endpoint, host)}?contextType=${contextType}&contextId=${contextId}${pageSizeParam}${extra}`;
   }
-
 }
-
 function getSortParams(sort, dir) {
   let sortBy = sort;
-
   if (sortBy === 'date_added') {
     sortBy = 'created_at';
   } else if (sortBy === 'alphabetical') {
     sortBy = 'name';
   }
-
   return `&sort=${sortBy}&order=${dir}`;
 }
-
 function optionalQuery(props, name) {
   return props[name] ? `&${name}=${props[name]}` : '';
 }
-
 export function getSearchParam(searchString) {
-  return (searchString === null || searchString === void 0 ? void 0 : searchString.length) >= 3 ? `&search_term=${encodeURIComponent(searchString)}` : '';
+  return searchString?.length >= 3 ? `&search_term=${encodeURIComponent(searchString)}` : '';
 }
 export default RceApiSource;