box-ui-elements-mlh/es/utils/file.js

Box UI Elements

/**
 * 
 * @file Helper for throwing errors
 * @author Box
 */
import getProp from 'lodash/get';
import { TYPED_ID_FILE_PREFIX, TYPED_ID_FOLDER_PREFIX, FILE_EXTENSION_BOX_NOTE, FILE_EXTENSION_GOOGLE_DOC, FILE_EXTENSION_GOOGLE_SHEET, FILE_EXTENSION_GOOGLE_SLIDE, FILE_EXTENSION_GOOGLE_SLIDE_LEGACY } from '../constants';
var FILE_EXT_REGEX = /\.([0-9a-z]+)$/i; // Case insensitive regex to extract file extension without "."

/**
 * Returns typed id for file. Useful for when
 * making file based XHRs where auth token
 * can be per file as used by Preview.
 * @param {id} id the file id
 * @return {string} typed id for file
 */

export function getTypedFileId(id) {
  return "".concat(TYPED_ID_FILE_PREFIX).concat(id);
}
/**
 * Returns typed id for folder.
 * @param {id} id the folder id
 * @return {string} typed id for folder
 */

export function getTypedFolderId(id) {
  return "".concat(TYPED_ID_FOLDER_PREFIX).concat(id);
}
/**
 * Determines if the file is a box note
 * @param {Object} file a box file
 * @return boolean true if it is a box note
 */

export function isBoxNote(file) {
  return file.extension === FILE_EXTENSION_BOX_NOTE;
}
/**
 * Determines whether a file extension is associated with a G Suite file.
 * @param {string} extension
 * @return boolean true if the extension is a valid G Suite extension
 */

export function isGSuiteExtension(extension) {
  return extension === FILE_EXTENSION_GOOGLE_DOC || extension === FILE_EXTENSION_GOOGLE_SHEET || extension === FILE_EXTENSION_GOOGLE_SLIDE || extension === FILE_EXTENSION_GOOGLE_SLIDE_LEGACY;
}
/**
 * Returns the extension from the file name
 * @param {string} filename a Box file
 * @return {string} typed id for file
 */

export function getFileExtension(filename) {
  if (typeof filename !== 'string') {
    return '';
  }

  var result = FILE_EXT_REGEX.exec(filename);
  return getProp(result, '[1]', '');
}
//# sourceMappingURL=file.js.map