fix: accept altText and mimetype as storeOptions

Author: sethk4783

src/lib/api/upload/file_tools.browser.ts

@@ -154,7 +154,7 @@ const readPart = (start: number, end: number, file): Promise<any> => {
  * @param {*} fileOrString
  * @returns {Promise<File>}
  */
-export const getFile = (input: InputFile, sanitizeOptions?: SanitizeOptions): Promise<FsFile> => {
+export const getFile = (input: InputFile, sanitizeOptions?: SanitizeOptions, mimetype?: string): Promise<FsFile> => {
   let filename;
   let file: Blob;
 
@@ -186,7 +186,7 @@ export const getFile = (input: InputFile, sanitizeOptions?: SanitizeOptions): Pr
         {
           name: filename,
           size: file.size,
-          type: mime,
+          type: mimetype || mime,
           slice: res.slice,
           release: res.release,
         },

src/lib/api/upload/file_tools.node.ts

@@ -63,7 +63,7 @@ const isFileBase = (input: InputFile): input is string => {
  * @param {*} inputFile
  * @returns {Promise<File>}
  */
-export const getFile = async(input: InputFile, sanitizeOptions?: SanitizeOptions): Promise<FsFile> => {
+export const getFile = async(input: InputFile, sanitizeOptions?: SanitizeOptions, mimetype?: string): Promise<FsFile> => {
   let filename;
 
   if (isFileNamed(input)) {
@@ -88,7 +88,7 @@ export const getFile = async(input: InputFile, sanitizeOptions?: SanitizeOptions
             {
               name: filename,
               size: buffer.byteLength,
-              type: mime,
+              type: mimetype || mime,
               slice: (start, end) => Promise.resolve(buffer.slice(start, end)),
             },
             sanitizeOptions
@@ -114,7 +114,7 @@ export const getFile = async(input: InputFile, sanitizeOptions?: SanitizeOptions
         {
           name: filename,
           size: input.byteLength,
-          type: mime,
+          type: mimetype || mime,
           // @ts-ignore
           slice: (start, end) => Promise.resolve(input.slice(start, end)),
         },

src/lib/api/upload/types.ts

@@ -81,8 +81,6 @@ export interface UploadOptions {
    * @memberof UploadOptions
    */
   tags?: UploadTags;
-
-  altText?: string;
 }
 
 export type StoreUploadOptions = StoreBaseParams & {
@@ -91,6 +89,16 @@ export type StoreUploadOptions = StoreBaseParams & {
    */
   filename?: ((file: File) => string) | string;
 
+  /**
+   * Mimetype of the stored file
+   */
+  mimetype?: string;
+
+  /**
+   * Alt text of the stored file
+   */
+  altText?: string;
+
   /**
    * Workflows ids to run after upload
    */

src/lib/api/upload/upload.ts

@@ -67,6 +67,22 @@ export class Upload extends EventEmitter {
    */
   private overrideFileName;
 
+  /**
+   * Mimetype of the file
+   *
+   * @private
+   * @memberof Upload
+   */
+  private mimetype;
+
+  /**
+   * Alt Text of the file
+   *
+   * @private
+   * @memberof Upload
+   */
+  private altText;
+
   private lastProgress: ProgressEvent = {
     totalBytes: 0,
     totalPercent: 0,
@@ -102,6 +118,16 @@ export class Upload extends EventEmitter {
       delete this.storeOptions.sanitizer;
     }
 
+    if (storeOptions.altText) {
+      this.altText = storeOptions.altText;
+      delete this.storeOptions.altText;
+    }
+
+    if (storeOptions.mimetype) {
+      this.mimetype = storeOptions.mimetype;
+      delete this.storeOptions.mimetype;
+    }
+
     this.uploader = new S3Uploader(this.storeOptions, options.concurrency);
 
     this.uploader.setRetryConfig({
@@ -199,16 +225,16 @@ export class Upload extends EventEmitter {
    * Upload single file
    *
    * @param {(InputFile)} file
-   * @param {(string)} altText
    * @returns {Promise<any>}
    * @memberof Upload
    */
-  async upload(input: InputFile, altText?: string): Promise<any> {
+  async upload(input: InputFile): Promise<any> {
 
-    const f = await getFile(input, this.sanitizerOptions);
+    const f = await getFile(input, this.sanitizerOptions, this.mimetype);
     f.customName = this.overrideFileName;
-    if (altText) {
-      f.alt = altText;
+
+    if (this.overrideFileName) {
+      f.alt = this.altText
     }
 
     this.uploader.addFile(f);
@@ -240,8 +266,13 @@ export class Upload extends EventEmitter {
         continue;
       }
 
-      const f = await getFile(input[i], this.sanitizerOptions);
+      const f = await getFile(input[i], this.sanitizerOptions, this.mimetype);
       f.customName = this.overrideFileName;
+
+      if (this.overrideFileName) {
+        f.alt = this.altText
+      }
+
       this.uploader.addFile(f);
     }
 

src/lib/client.spec.ts

@@ -210,15 +210,13 @@ describe('client', () => {
 
     expect(Upload.prototype.setToken).toHaveBeenCalledWith(token);
     expect(Upload.prototype.setSecurity).toHaveBeenCalledWith(defaultSecurity);
-    expect(Upload.prototype.upload).toHaveBeenCalledWith(file, undefined);
+    expect(Upload.prototype.upload).toHaveBeenCalledWith(file);
   });
 
   it('should be able to upload file with alt text', async () => {
     const client = new Client(defaultApikey);
     const file = 'anyFile';
-    const uploadOptions = {
-      altText: 'alt',
-    };
+    const uploadOptions = {};
     const storeOptions = {};
     const token = {};
 
@@ -233,7 +231,7 @@ describe('client', () => {
 
     expect(Upload.prototype.setToken).toHaveBeenCalledWith(token);
     expect(Upload.prototype.setSecurity).toHaveBeenCalledWith(defaultSecurity);
-    expect(Upload.prototype.upload).toHaveBeenCalledWith(file, uploadOptions.altText);
+    expect(Upload.prototype.upload).toHaveBeenCalledWith(file);
   });
 
   it('should be able to upload file without token and security', async () => {
@@ -251,7 +249,7 @@ describe('client', () => {
       urls: sessionURls,
     });
 
-    expect(Upload.prototype.upload).toHaveBeenCalledWith(file, undefined);
+    expect(Upload.prototype.upload).toHaveBeenCalledWith(file);
   });
 
   it('should emit error', async () => {

src/lib/client.ts

@@ -474,7 +474,7 @@ export class Client extends EventEmitter {
       this.emit('upload.error', e);
     });
 
-    return upload.upload(file, options && options.altText);
+    return upload.upload(file);
   }
 
   /**

src/schema/store.schema.ts

@@ -28,6 +28,14 @@ export const StoreParamsSchema = {
         format: 'callback',
       }],
     },
+    mimetype: {
+      type: ['string', 'null'],
+      maxLength: 60,
+    },
+    altText: {
+      type: ['string', 'null'],
+      maxLength: 125,
+    },
     location: {
       '$ref': 'locationsDef',
     },

src/schema/upload.schema.ts

@@ -81,9 +81,5 @@ export const UploadParamsSchema = {
         maxlength: 256,
       },
     },
-    altText: {
-      type: ['string', 'null'],
-      maxLength: 60,
-    },
   },
 };