Add embed.reload(). Allows reloading embeds using existing configuration. (#37)

Closes #4

Author: mattmazzola

demo/app/filters.js

@@ -14,6 +14,7 @@ $(function () {
   var $operatorFields = $('.filter-operators');
   var $targetTypeFields = $('input[type=radio][name=filterTarget]');
   var $targetFields = $('.filter-target');
+  var $reloadButton = $('#reload');
 
   var $predefinedFilter1 = $('#predefinedFilter1');
   var predefinedFilter1 = new models.AdvancedFilter({
@@ -56,6 +57,13 @@ $(function () {
       }
     ]);
 
+  $reloadButton.on('click', function (event) {
+    event.preventDefault();
+
+    console.log('reload');
+    customFilterPaneReport.reload();
+  });
+
   $customFilterForm.on('submit', function (event) {
     event.preventDefault();
     console.log('submit');

demo/filters.html

@@ -88,6 +88,11 @@ <h4>Visual</h4>
               Not Implemented
             </div>
           </div>
+          <div class="row">
+            <div class="col-md-4">
+              <button type="button" class="btn btn-danger btn-block" id="reload">Reload</button>
+            </div>
+          </div>
         </div>
         <div class="col-md-3">
           <form id="customfilterform" name="abc">

src/embed.ts

@@ -243,6 +243,18 @@ export abstract class Embed {
     this.element.addEventListener(eventName, <any>handler)
   }
 
+  /**
+   * Reloads embed using existing configuration.
+   * E.g. For reports this effectively clears all filters and makes the first page active which simulates resetting a report back to loaded state.
+   * 
+   * ```javascript
+   * report.reload();
+   * ```
+   */
+  reload(): Promise<void> {
+    return this.load(this.config);
+  }
+
   /**
    * Gets an access token from the first available location: config, attribute, global.
    * 

test/test.spec.ts

@@ -2146,6 +2146,33 @@ describe('SDK-to-HPM', function () {
       });
     });
 
+    describe('reload', function () {
+      it('report.reload() sends POST /report/load with configuration in body', function () {
+        // Arrange
+        const testData = {
+          loadConfiguration: {
+            id: 'fakeId',
+            accessToken: 'fakeToken'
+          },
+          response: {
+            body: null
+          }
+        };
+
+        spyHpm.post.and.returnValue(Promise.resolve(testData.response));
+        report.load(testData.loadConfiguration)
+          .then(() => {
+            spyHpm.post.calls.reset();
+
+            // Act
+            report.reload();
+
+            // Assert
+            expect(spyHpm.post).toHaveBeenCalledWith('/report/load', jasmine.objectContaining(testData.loadConfiguration), { uid: uniqueId }, iframe.contentWindow);
+          });
+      });
+    });
+
     describe('settings', function () {
       it('report.updateSettings(settings) sends PATCH /report/settings with settings object', function () {
         // Arrange