refresh report - initial

Author: ali-hamud

dist/powerbi.js

@@ -173,4 +173,12 @@ export declare class Report extends embed.Embed implements IReportNode, IFiltera
      * @returns {Promise<void>}
      */
     switchMode(viewMode: models.ViewMode): Promise<void>;
+    /**
+    * Refreshes data sources for the report.
+    *
+    * ```javascript
+    * report.refresh();
+    * ```
+    */
+    refresh(): Promise<void>;
 }

dist/powerbi.js.map

@@ -279,4 +279,21 @@ export class Report extends embed.Embed implements IReportNode, IFilterable {
         throw response.body;
       });
   }
+
+  /**
+  * Refreshes data sources for the report.
+  * 
+  * ```javascript
+  * report.refresh();
+  * ```
+  */
+  refresh(): Promise<void> {
+    return this.service.hpm.post<models.IError[]>('/report/refresh', null, { uid: this.config.uniqueId }, this.iframe.contentWindow)
+      .then(response => {
+        return response.body;
+      })
+      .catch(response => {
+        throw response.body;
+    });
+  }
 }

dist/powerbi.min.js

@@ -1390,6 +1390,26 @@ describe('Protocol', function () {
       });
     });
 
+    describe('refresh', function () {
+      it('POST /report/refresh returns 202 if the request is valid', function (done) {
+        // Arrange
+        iframeLoaded
+          .then(() => {
+            spyApp.refreshData.and.returnValue(Promise.resolve(null));
+            // Act
+            hpm.post<void>('/report/refresh', null)
+              .then(response => {
+                // Assert
+                expect(spyApp.refreshData).toHaveBeenCalled();
+                expect(response.statusCode).toEqual(202);
+                // Cleanup
+                spyApp.refreshData.calls.reset();
+                done();
+              });
+          });
+      });
+    });
+
     describe('print', function () {
       it('POST /report/print returns 202 if the request is valid', function (done) {
         // Arrange
@@ -2704,6 +2724,36 @@ describe('SDK-to-HPM', function () {
       });
     });
 
+    describe('refresh', function () {
+      it('report.refresh() sends POST /report/refresh', function () {
+        // Arrange
+        spyHpm.post.and.returnValue(Promise.resolve({
+          body: {}
+        }));
+
+        // Act
+        report.refresh();
+
+        // Assert
+        expect(spyHpm.post).toHaveBeenCalledWith('/report/refresh', null, { uid: uniqueId }, iframe.contentWindow);
+      });
+
+      it('report.refresh() returns promise that resolves if the request is accepted', function (done) {
+        // Arrange
+        spyHpm.post.and.returnValue(Promise.resolve({
+          body: {}
+        }));
+
+        // Act
+        report.refresh()
+          .then(() => {
+            // Assert
+            expect(spyHpm.post).toHaveBeenCalledWith('/report/refresh', null, { uid: uniqueId }, iframe.contentWindow);
+            done();
+          });
+      });
+    });
+
     describe('settings', function () {
       it('report.updateSettings(settings) sends PATCH /report/settings with settings object', function () {
         // Arrange
@@ -3633,6 +3683,24 @@ describe('SDK-to-MockApp', function () {
       });
     });
 
+    describe('refresh', function () {
+      it('report.refresh() returns promise that resolves with null if the report refresh command was accepted', function (done) {
+        // Arrange
+        iframeLoaded
+          .then(() => {
+            spyApp.refreshData.and.returnValue(Promise.resolve(null));
+            // Act
+            report.refresh()
+              .then(response => {
+                // Assert
+                expect(spyApp.refreshData).toHaveBeenCalled();
+                expect(response).toEqual(undefined);
+                done();
+              });
+          });
+      });
+    });
+
     describe('settings', function () {
       it('report.updateSettings(setting) returns promise that rejects with validation error if object is invalid', function (done) {
         // Arrange

dist/report.d.ts

@@ -19,6 +19,7 @@ export interface IApp {
   validateFilter(filter: models.IFilter): Promise<models.IError[]>;
   // Other
   print(): Promise<void>;
+  refreshData(): Promise<void>;
   exportData(): Promise<void>;
   validateCreateReport(config: models.IReportCreateConfiguration): Promise<models.IError[]>;
   switchMode(): Promise<void>;
@@ -46,6 +47,7 @@ export const mockAppSpyObj = {
   validateFilter: jasmine.createSpy("validateFilter").and.callFake(models.validateFilter),
   // Other
   print: jasmine.createSpy("print").and.returnValue(Promise.resolve(null)),
+  refreshData: jasmine.createSpy("refreshData").and.returnValue(Promise.resolve(null)),
   exportData: jasmine.createSpy("exportData").and.returnValue(Promise.resolve(null)),
   validateCreateReport: jasmine.createSpy("validateCreateReport").and.callFake(models.validateCreateReport),
   switchMode: jasmine.createSpy("switchMode").and.returnValue(Promise.resolve(null)),
@@ -67,6 +69,7 @@ export const mockAppSpyObj = {
     mockAppSpyObj.setFilters.calls.reset();
     mockAppSpyObj.validateFilter.calls.reset();
     mockAppSpyObj.print.calls.reset();
+    mockAppSpyObj.refreshData.calls.reset();
     mockAppSpyObj.exportData.calls.reset();
     mockAppSpyObj.validateCreateReport.calls.reset();
     mockAppSpyObj.switchMode.calls.reset();

src/report.ts

@@ -263,6 +263,11 @@ export function setupEmbedMockApp(iframeContentWindow: Window, parentWindow: Win
       });
   });
 
+  router.post('/report/refresh', (req, res) => {
+    app.refreshData();
+    res.send(202);
+  });
+
   router.post('/report/print', (req, res) => {
     app.print();
     res.send(202);