Updated documentation

Add flag for postBackWait (true/false)

Author: Manuel.PirkerIhl

README.md

@@ -89,12 +89,36 @@ The port is required if you want to start the application on a differnt port.
 {
     "url": "http://orf.at",
     "filename": "my-wished-filename",
+    "postBackWait": true,
     "postBackUrl": "http://where-should-it-be-posted",
-    "postBackBody": "{}", // String cause form data does not accept json
-    "token": "CUSTOM AUTH-TOKEN" // Provide a valid authentication key if you do not want to use the JWT Authentication
+    "postBackBody": "{}",
+    "token": "CUSTOM AUTH-TOKEN"
 }
 ```
 
+#### url
+
+Provide the url of the page you want to be tranformed to a pdf document.
+
+#### filename
+
+If you do not provide a filename (without the extension) a uuid will be used as filename. Please choose a unique string otherwise you potentially overwrite documents (name conflicts).
+
+#### postBackUrl
+
+If you provide a postBackUrl the api will try to post the document to the given url.
+
+#### postBackBody
+
+Provide a string of data you wanna send back to the url. Please be aware that only string (NOT json) is supported.
+
+#### postBackWait
+Default: true
+
+Provide a boolean value if you want to wait for the complete answer of the postBackProcess.
+
+If set to false the return value "uploaded" will always be false. 
+
 ### [GET] /api/browse/:id
 
 This endpoint will return the file. Please be aware that there will be a query string required query string param *signed*.

src/browser/browser.controller.ts

@@ -46,25 +46,37 @@ export class BrowserController {
     let result = await this.browserService.savePage(createSession.url, createSession.filename);
     let resultUpload = false;
 
+    createSession.postBackWait = createSession.postBackWait == true;
+
     if (createSession.postBackUrl) {
 
-        resultUpload = await this.browserService.uploadFile(request, result.id, createSession);
+        if (createSession.postBackWait != false) {
+
+          resultUpload = await this.browserService.uploadFile(request, result.id, createSession);
+
+          // Delete the file after uploading to the endpoint
+          if (resultUpload) {
+            await this.browserService.deleteFile(result.storagePath);
+          }
+
+        }        
+        else {
+
+          this.browserService.uploadFile(request, result.id, createSession).then(() => {
+             this.browserService.deleteFile(result.storagePath)
+          });
 
-        // Delete the file after uploading to the endpoint
-        if (resultUpload) {
-          await this.browserService.deleteFile(result.storagePath);
         }
 
     }
 
-    console.error(result);
-
     res.status(HttpStatus.OK).json(new PdfResult({
         statusCode: HttpStatus.OK,
         requestUrl: createSession.url,
         downloadUrl: resultUpload == false ? this.signature.sign(`http://${request.headers.host}/api/browse/${result.id}`) : null,
         filename: result.id,
-        uploaded: resultUpload  
+        uploaded: resultUpload,
+        waited: createSession.postBackWait
     }));
 
   }

src/dto/create-browser.dto.ts

@@ -6,6 +6,7 @@ export class CreateBrowserDto {
     url: String;
 
     filename: String;
+    postBackWait: boolean = true;
     postBackUrl: String;
     postBackBody: Object;
     token: String;