packages/shared/lib/helpers/file.ts

   1 import { base64StringToUint8Array, uint8ArrayToString } from './encoding';
   2
   3 /**
   4  * Convert file to encoded base 64 string
   5  */
   6 export const toBase64 = async (file: Blob, isValid: (file: Blob) => boolean = () => true) => {
   7     if (file && !isValid(file)) {
   8         throw new Error('Invalid file format');
   9     }
  10     return new Promise<string>((resolve, reject) => {
  11         const reader = new FileReader();
  12         reader.onload = ({ target }) => {
  13             if (!target?.result) {
  14                 return reject(new Error('Invalid file'));
  15             }
  16             resolve(target.result as string);
  17         };
  18         reader.onerror = reject;
  19         reader.onabort = reject;
  20         reader.readAsDataURL(file);
  21     });
  22 };
  23
  24 /**
  25  * Read the content of a blob and returns its value as a buffer
  26  */
  27 export const readFileAsBuffer = (file: File) => {
  28     return new Promise<ArrayBuffer>((resolve, reject) => {
  29         const reader = new FileReader();
  30         reader.onload = ({ target }) => {
  31             if (!target?.result) {
  32                 return reject(new Error('Invalid file'));
  33             }
  34             resolve(target.result as ArrayBuffer);
  35         };
  36         reader.onerror = reject;
  37         reader.onabort = reject;
  38         reader.readAsArrayBuffer(file);
  39     });
  40 };
  41
  42 /**
  43  * Read the content of a blob and returns its value as a text string
  44  */
  45 export const readFileAsString = (file: File, encoding?: string) => {
  46     return new Promise<string>((resolve, reject) => {
  47         const reader = new FileReader();
  48         reader.onload = ({ target }) => {
  49             if (!target?.result) {
  50                 return reject(new Error('Invalid file'));
  51             }
  52             resolve(target.result as string);
  53         };
  54         reader.onerror = reject;
  55         reader.onabort = reject;
  56         reader.readAsText(file, encoding);
  57     });
  58 };
  59
  60 /**
  61  * Read the content of a blob and returns its value as a binary string.
  62  * Not using readAsBinaryString because it's deprecated.
  63  */
  64 export const readFileAsBinaryString = async (file: File) => {
  65     const arrayBuffer = await readFileAsBuffer(file);
  66     // eslint-disable-next-line new-cap
  67     return uint8ArrayToString(new Uint8Array(arrayBuffer));
  68 };
  69
  70 /**
  71  * Convert a blob url to the matching blob
  72  * @link https://stackoverflow.com/a/42508185
  73  */
  74 export const blobURLtoBlob = (url: string) => {
  75     return new Promise((resolve, reject) => {
  76         const xhr = new XMLHttpRequest();
  77         xhr.open('GET', url);
  78         xhr.responseType = 'blob';
  79         xhr.onerror = reject;
  80         xhr.onload = () => {
  81             if (xhr.status === 200) {
  82                 return resolve(xhr.response);
  83             }
  84             reject(xhr);
  85         };
  86         xhr.send();
  87     });
  88 };
  89
  90 /**
  91  * Read the base64 portion of a data url.
  92  */
  93 export const readDataUrl = (url = '') => {
  94     const error = 'The given url is not a data url.';
  95
  96     if (url.substring(0, 5) !== 'data:') {
  97         throw new Error(error);
  98     }
  99
 100     const [, base64] = url.split(',');
 101     if (!base64) {
 102         throw new Error(error);
 103     }
 104
 105     return base64StringToUint8Array(base64);
 106 };
 107
 108 /**
 109  * Split a filename into [name, extension]
 110  */
 111 export const splitExtension = (filename = '') => {
 112     const endIdx = filename.lastIndexOf('.');
 113     if (endIdx === -1) {
 114         return [filename, ''];
 115     }
 116     return [filename.slice(0, endIdx), filename.slice(endIdx + 1)];
 117 };