feat: Add Parse.File option maxUploadSize to override the Parse Server option maxUploadSize per file upload (#2940)

Author: mtrezza

src/ParseFile.ts

@@ -19,6 +19,17 @@ export type FileSaveOptions = FullOptions & {
   metadata?: Record<string, any>;
   tags?: Record<string, any>;
   directory?: string;
+  /**
+   * Overrides the server's `maxUploadSize` for this file upload. Requires the
+   * master key (`useMasterKey: true`). The value uses the same format as the
+   * server option (e.g. `'50mb'`, `'1gb'`).
+   *
+   * Only supported for Buffer and Stream source types. Files created from
+   * base64 strings, number arrays, Blobs, or URIs do not support this option.
+   *
+   * Requires Parse Server >= 9.5.0.
+   */
+  maxUploadSize?: string;
 };
 export type FileSource =
   | {
@@ -309,6 +320,10 @@ class ParseFile {
    *   }
    * });
    * </pre>
+   *   <li>maxUploadSize: Overrides the server's maxUploadSize for this upload.
+   *     Requires the master key. Only supported for Buffer and Stream source
+   *     types; files created from base64 strings, number arrays, Blobs, or URIs
+   *     do not support this option. Requires Parse Server >= 9.5.0.
    * </ul>
    * @returns {Promise | undefined} Promise that is resolved when the save finishes.
    */
@@ -333,7 +348,7 @@ class ParseFile {
           (this._tags && Object.keys(this._tags).length > 0) ||
           !!this._directory;
 
-        if (controller.saveBinary && (this._source.format === 'stream' || !hasFileData)) {
+        if (controller.saveBinary && (this._source.format === 'stream' || !hasFileData || options.maxUploadSize)) {
           // Binary upload via ajax (file data sent via headers for streams)
           this._previousSave = controller
             .saveBinary(this._name, this._source, options)
@@ -632,6 +647,9 @@ const DefaultController = {
     if (options.tags && Object.keys(options.tags).length > 0) {
       headers['X-Parse-File-Tags'] = JSON.stringify(options.tags);
     }
+    if (options.maxUploadSize) {
+      headers['X-Parse-File-Max-Upload-Size'] = options.maxUploadSize.replace(/[\r\n]/g, '');
+    }
     const jsKey = CoreManager.get('JAVASCRIPT_KEY');
     if (jsKey) {
       headers['X-Parse-JavaScript-Key'] = jsKey;

types/ParseFile.d.ts

@@ -10,6 +10,17 @@ export type FileSaveOptions = FullOptions & {
     metadata?: Record<string, any>;
     tags?: Record<string, any>;
     directory?: string;
+    /**
+     * Overrides the server's `maxUploadSize` for this file upload. Requires the
+     * master key (`useMasterKey: true`). The value uses the same format as the
+     * server option (e.g. `'50mb'`, `'1gb'`).
+     *
+     * Only supported for Buffer and Stream source types. Files created from
+     * base64 strings, number arrays, Blobs, or URIs do not support this option.
+     *
+     * Requires Parse Server >= 9.5.0.
+     */
+    maxUploadSize?: string;
 };
 export type FileSource = {
     format: 'file';
@@ -171,6 +182,10 @@ declare class ParseFile {
      *   }
      * });
      * </pre>
+     *   <li>maxUploadSize: Overrides the server's maxUploadSize for this upload.
+     *     Requires the master key. Only supported for Buffer and Stream source
+     *     types; files created from base64 strings, number arrays, Blobs, or URIs
+     *     do not support this option. Requires Parse Server >= 9.5.0.
      * </ul>
      * @returns {Promise | undefined} Promise that is resolved when the save finishes.
      */