Merge pull request #86 from lsqlabs/with-credentials

feat(*): allow setting XHR withCredentials
lsqlabs · Apr 6, 2023 · 8ecfbdb · 8ecfbdb
2 parents 59ac7d1 + 8d80913
commit 8ecfbdb
Show file tree

Hide file tree

Showing 8 changed files with 26 additions and 8 deletions.
diff --git a/README.md b/README.md
@@ -73,7 +73,7 @@ uploader.selectFiles();
 
 ## Advanced example (using Angular)
 
-```javascript
+```typescript
 @Component({
     selector: 'uploader-demo',
     template: `
@@ -96,7 +96,7 @@ export class UploaderDemoComponent implements AfterViewInit {
         ],
         fileCountLimit: 100,
         fileSizeLimitMb: 10,
-        uploadFileAsBody: false // Default is false. When true, the file will be the body of the request, instead of being sent as form data.
+        uploadFileAsBody: false, // Default is false. When true, the file will be the body of the request, instead of being sent as form data.
         onFileCountLimitExceeded: (fileCountLimit) => alert(
             'You attempted to upload more than the limit of '
             + fileCountLimit + ' files'
@@ -107,7 +107,8 @@ export class UploaderDemoComponent implements AfterViewInit {
                     + fileUpload.name,
                 headers: {
                     'content-length': `${fileUpload.file.size}`
-                }
+                },
+                withCredentials: false // Default is false. When true, the XHR withCredentials flag will be set to allow propagating cookies.
             };
         },
         allFilesQueuedCallback: (fileUploads) => {
@@ -325,6 +326,7 @@ interface IUploadRequestOptions {
     method?: HttpMethod;
     formData?: FormData;
     headers?: { [key: string]: string };
+    withCredentials?: boolean;
 }
 
 enum ProgressState {

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
     "name": "rxjs-uploader-demo",
-    "version": "1.5.1",
+    "version": "1.6.1",
     "description": "A simple RxJS-powered interface for uploading files.",
     "author": {
         "name": "lsqlabs",

diff --git a/projects/rxjs-uploader/package-lock.json b/projects/rxjs-uploader/package-lock.json
diff --git a/projects/rxjs-uploader/package.json b/projects/rxjs-uploader/package.json
@@ -1,6 +1,6 @@
 {
     "name": "rxjs-uploader",
-    "version": "1.5.1",
+    "version": "1.6.1",
     "license": "MIT",
     "description": "A simple RxJS-powered interface for uploading files.",
     "repository": {

diff --git a/projects/rxjs-uploader/src/lib/models/upload-request-options.ts b/projects/rxjs-uploader/src/lib/models/upload-request-options.ts
@@ -5,4 +5,5 @@ export interface IUploadRequestOptions {
     method?: HttpMethod;
     formData?: FormData | { [key: string]: string };
     headers?: { [key: string]: string };
+    withCredentials?: boolean;
 }
diff --git a/projects/rxjs-uploader/src/lib/rxjs-uploader.spec.ts b/projects/rxjs-uploader/src/lib/rxjs-uploader.spec.ts
@@ -132,7 +132,8 @@ describe('RxJs Uploader', () => {
 
         const uploader = new Uploader()
             .setRequestOptions({
-                url: 'https://api.myawesomeservice.com/upload'
+                url: 'https://api.myawesomeservice.com/upload',
+                withCredentials: true
             })
             .setRequestOptionsFactory(async (fileUpload) => {
                 return {

diff --git a/projects/rxjs-uploader/src/lib/rxjs-uploader.ts b/projects/rxjs-uploader/src/lib/rxjs-uploader.ts
@@ -673,7 +673,7 @@ export class Uploader<FileUploadType extends FileUpload = FileUpload> {
                 const progressStream = fromEvent(xhr.upload, 'progress');
                 const completedStream = fromEvent(xhr, 'load');
                 const xhrErrorStream = fromEvent(xhr, 'error');
-                xhr.withCredentials = false;
+                xhr.withCredentials = fileUpload.requestOptions.withCredentials || false;
 
                 this._subscribeTemporarily(
                     merge(progressStream, completedStream)