Refactor filters from crud model to get/set model with objects representing each level instead of targets. (microsoft#24)

Refactor filters from crud model to get/set model with objects representing each level instead of targets.

* Update Service class to implement IService

* Add more tests for Page and Visual for SDK to MockApp

* Change getPages and getVisuals to return concrete classes instead of node interfaces

* Change IReport, IPage, IVisual to use Node suffix to make it clear they are not interface for class, but for traversing tree

* Cleanup on tests in attempt to fix error.

* Attempt to fix tests by using jasmine.objectContaining when comparing object equality in catch blocks.

* Update load documentation to use filters array

Author: mattmazzola

.vscode/settings.json

@@ -0,0 +1,5 @@
+// Place your settings in this file to overwrite default and user settings.
+{
+  "editor.tabSize": 4,
+  "editor.insertSpaces": true
+}

package.json

@@ -66,7 +66,7 @@
   },
   "dependencies": {
     "http-post-message": "^0.2.0",
-    "powerbi-models": "^0.5.0",
+    "powerbi-models": "^0.7.2",
     "powerbi-router": "^0.1.2",
     "window-post-message-proxy": "^0.2.1"
   },

src/config.ts

@@ -1,5 +1,5 @@
 const config = {
-  version: '2.0.0-beta.7',
+  version: '2.0.0-beta.8',
   type: 'js'
 };
 

src/embed.ts

@@ -97,7 +97,11 @@ export abstract class Embed {
      *     navContentPaneEnabled: false
      *   },
      *   pageName: "DefaultPage",
-     *   filte: "DefaultReportFilter"
+     *   filters: [
+     *     {
+     *        ...  DefaultReportFilter ...
+     *     }
+     *   ]
      * })
      *   .catch(error => { ... });
      * ```
@@ -109,7 +113,10 @@ export abstract class Embed {
         }
 
         return this.service.hpm.post<void>('/report/load', config, { uid: this.config.uniqueId }, this.iframe.contentWindow)
-            .catch(response => {
+            .then(response => {
+                return response.body;
+            },
+            response => {
                 throw response.body;
             });
     }

src/ifilterable.ts

@@ -0,0 +1,7 @@
+import * as models from 'powerbi-models';
+
+export interface IFilterable {
+    getFilters(): Promise<(models.IBasicFilter | models.IAdvancedFilter)[]>;
+    setFilters(filters: (models.IBasicFilter | models.IAdvancedFilter)[]): Promise<void>;
+    removeFilters(): Promise<void>;
+}

src/page.ts

@@ -0,0 +1,121 @@
+import { IFilterable } from './ifilterable';
+import { IReportNode } from './report';
+import { Visual } from './visual';
+import * as models from 'powerbi-models';
+
+export interface IPageNode {
+    report: IReportNode;
+    name: string;
+}
+
+export class Page implements IPageNode, IFilterable {
+    report: IReportNode;
+    name: string;
+    // This can be undefined in cases where page is created manually
+    displayName: string;
+
+    constructor(report: IReportNode, name: string, displayName?: string) {
+        this.report = report;
+        this.name = name;
+        this.displayName = displayName;
+    }
+
+    /**
+     * Gets all page level filters within report
+     * 
+     * ```javascript
+     * page.getFilters()
+     *  .then(pages => { ... });
+     * ```
+     */
+    getFilters() {
+        return this.report.service.hpm.get<models.IFilter[]>(`/report/pages/${this.name}/filters`, { uid: this.report.config.uniqueId }, this.report.iframe.contentWindow)
+            .then(response => response.body,
+            response => {
+                throw response.body;
+            });
+    }
+
+    /**
+     * Gets all the visuals on the page.
+     * 
+     * ```javascript
+     * page.getVisuals()
+     *   .then(visuals => { ... });
+     * ```
+     */
+    getVisuals(): Promise<Visual[]> {
+        return this.report.service.hpm.get<models.IVisual[]>(`/report/pages/${this.name}/visuals`, { uid: this.report.config.uniqueId }, this.report.iframe.contentWindow)
+            .then(response => {
+                return response.body
+                    .map(visual => {
+                        return new Visual(this, visual.name);
+                    });
+            }, response => {
+                throw response.body;
+            });
+    }
+
+    /**
+     * Remove all filters on this page within the report
+     * 
+     * ```javascript
+     * page.removeFilters();
+     * ```
+     */
+    removeFilters() {
+        return this.setFilters([]);
+    }
+
+    /**
+     * Make the current page the active page of the report.
+     * 
+     * ```javascripot
+     * page.setActive();
+     * ```
+     */
+    setActive() {
+        const page: models.IPage = {
+            name: this.name,
+            displayName: null
+        };
+
+        return this.report.service.hpm.put<models.IError[]>('/report/pages/active', page, { uid: this.report.config.uniqueId }, this.report.iframe.contentWindow)
+            .catch(response => {
+                throw response.body;
+            });
+    }
+
+    /**
+     * Sets all filters on the current page.
+     * 
+     * ```javascript
+     * page.setFilters(filters);
+     *   .catch(errors => { ... });
+     * ```
+     */
+    setFilters(filters: (models.IBasicFilter | models.IAdvancedFilter)[]) {
+        return this.report.service.hpm.put<models.IError[]>(`/report/pages/${this.name}/filters`, filters, { uid: this.report.config.uniqueId }, this.report.iframe.contentWindow)
+            .catch(response => {
+                throw response.body;
+            });
+    }
+
+    /**
+     * Creates new Visual object given a name of the visual.
+     * 
+     * Normally you would get Visual objects by calling `page.getVisuals()` but in the case
+     * that the visual name is known and you want to perform an action on a visaul such as setting a filters
+     * without having to retrieve it first you can create it directly.
+     * 
+     * Note: Since you are creating the visual manually there is no guarantee that the visual actually exists in the report and the subsequence requests could fail.
+     * 
+     * ```javascript
+     * const visual = report.page('ReportSection1').visual('BarChart1');
+     * visual.setFilters(filters);
+     * ```
+     */
+    visual(name: string): Visual {
+        return new Visual(this, name);
+    }
+}