Merged PR 17832: add isSaved API method

add isSaved to report and create

Author: johaddad

src/create.ts

@@ -57,6 +57,19 @@ export class Create extends embed.Embed {
       }
   }
 
+  /**
+   * checks if the report is saved.
+   *
+   * ```javascript
+   * report.isSaved()
+   * ```
+   *
+   * @returns {Promise<boolean>}
+   */
+  isSaved(): Promise<boolean> {
+    return utils.isSavedInternal(this.service.hpm, this.config.uniqueId, this.iframe.contentWindow);
+  }
+
   /**
    * Adds the ability to get datasetId from url. 
    * (e.g. http://embedded.powerbi.com/appTokenReportEmbed?datasetId=854846ed-2106-4dc2-bc58-eb77533bf2f1).

src/report.ts

@@ -366,7 +366,19 @@ export class Report extends embed.Embed implements IReportNode, IFilterable {
   }
 
   /**
-  * Apply a theme to the report
+   * checks if the report is saved.
+   *
+   * ```javascript
+   * report.isSaved()
+   * ```
+   *
+   * @returns {Promise<boolean>}
+   */
+  isSaved(): Promise<boolean> {
+    return utils.isSavedInternal(this.service.hpm, this.config.uniqueId, this.iframe.contentWindow);
+  }
+
+  /* Apply a theme to the report
   *
   * ```javascript
   * report.applyTheme(theme);
@@ -394,7 +406,7 @@ export class Report extends embed.Embed implements IReportNode, IFilterable {
       })
       .catch(response => {
         throw response.body;
-    });
+      });
   }
 
   private viewModeToString(viewMode: models.ViewMode): string {

src/util.ts

@@ -1,3 +1,4 @@
+import { HttpPostMessage } from 'http-post-message';
 
 /**
  * Raises a custom event with event data on the specified HTML element.
@@ -144,3 +145,20 @@ export function addParamToUrl(url: string, paramName: string, value: string): st
   url += parameterPrefix + paramName + '=' + value;
   return url;
 }
+
+/**
+ * Checks if the report is saved.
+ * 
+ * @export
+ * @param {HttpPostMessage} hpm
+ * @param {string} uid
+ * @param {Window} contentWindow
+ * @returns {Promise<boolean>}
+ */
+export function isSavedInternal(hpm: HttpPostMessage, uid: string, contentWindow: Window): Promise<boolean> {
+  return hpm.get<boolean>('/report/hasUnsavedChanges', { uid }, contentWindow)
+    .then(response => !response.body,
+    response => {
+      throw response.body;
+    });
+}