Updated jsdoc comments through source. Added missing return values in same methods (microsoft#28)

Author: wbreza

dist/embed.d.ts

@@ -11,13 +11,21 @@ declare global  {
         msRequestFullscreen: Function;
     }
 }
+/**
+ * Configuration settings for Power BI embed components
+ *
+ * @export
+ * @interface IEmbedConfiguration
+ */
 export interface IEmbedConfiguration {
     type?: string;
     id?: string;
     uniqueId?: string;
     embedUrl?: string;
     accessToken?: string;
     settings?: models.ISettings;
+    pageName?: string;
+    filters?: (models.IBasicFilter | models.IAdvancedFilter)[];
 }
 export interface IInternalEmbedConfiguration extends models.ILoadConfiguration {
     uniqueId: string;
@@ -28,6 +36,13 @@ export interface IInternalEventHandler<T> {
     test(event: service.IEvent<T>): boolean;
     handle(event: service.ICustomEvent<T>): void;
 }
+/**
+ * Base class for all Power BI embed components
+ *
+ * @export
+ * @abstract
+ * @class Embed
+ */
 export declare abstract class Embed {
     static allowedEvents: string[];
     static accessTokenAttribute: string;
@@ -37,14 +52,45 @@ export declare abstract class Embed {
     static type: string;
     private static defaultSettings;
     allowedEvents: any[];
+    /**
+     * Gets or set the event handler registered for this embed component
+     *
+     * @type {IInternalEventHandler<any>[]}
+     */
     eventHandlers: IInternalEventHandler<any>[];
+    /**
+     * Gets or sets the Power BI embed service
+     *
+     * @type {service.Service}
+     */
     service: service.Service;
+    /**
+     * Gets or sets the HTML element containing the Power BI embed component
+     *
+     * @type {HTMLElement}
+     */
     element: HTMLElement;
+    /**
+     * Gets or sets the HTML iframe element that renders the Power BI embed component
+     *
+     * @type {HTMLIFrameElement}
+     */
     iframe: HTMLIFrameElement;
+    /**
+     * Gets or sets the configuration settings for the embed component
+     *
+     * @type {IInternalEmbedConfiguration}
+     */
     config: IInternalEmbedConfiguration;
     /**
+     * Creates an instance of Embed.
+     *
      * Note: there is circular reference between embeds and service
      * The service has list of all embeds on the host page, and each embed has reference to the service that created it.
+     *
+     * @param {service.Service} service
+     * @param {HTMLElement} element
+     * @param {IEmbedConfiguration} config
      */
     constructor(service: service.Service, element: HTMLElement, config: IEmbedConfiguration);
     /**
@@ -67,6 +113,9 @@ export declare abstract class Embed {
      * })
      *   .catch(error => { ... });
      * ```
+     *
+     * @param {models.ILoadConfiguration} config
+     * @returns {Promise<void>}
      */
     load(config: models.ILoadConfiguration): Promise<void>;
     /**
@@ -86,6 +135,10 @@ export declare abstract class Embed {
      *
      * report.off('pageChanged', logHandler);
      * ```
+     *
+     * @template T
+     * @param {string} eventName
+     * @param {service.IEventHandler<T>} [handler]
      */
     off<T>(eventName: string, handler?: service.IEventHandler<T>): void;
     /**
@@ -96,23 +149,40 @@ export declare abstract class Embed {
      *   console.log('PageChanged: ', event.page.name);
      * });
      * ```
+     *
+     * @template T
+     * @param {string} eventName
+     * @param {service.IEventHandler<T>} handler
      */
     on<T>(eventName: string, handler: service.IEventHandler<T>): void;
     /**
      * Get access token from first available location: config, attribute, global.
+     *
+     * @private
+     * @param {string} globalAccessToken
+     * @returns {string}
      */
     private getAccessToken(globalAccessToken);
     /**
      * Get embed url from first available location: options, attribute.
+     *
+     * @private
+     * @returns {string}
      */
     private getEmbedUrl();
     /**
      * Get unique id from first available location: options, attribute.
      * If neither is provided generate unique string.
+     *
+     * @private
+     * @returns {string}
      */
     private getUniqueId();
     /**
      * Get report id from first available location: options, attribute.
+     *
+     * @abstract
+     * @returns {string}
      */
     abstract getId(): string;
     /**
@@ -126,6 +196,10 @@ export declare abstract class Embed {
     /**
      * Return true if iframe is fullscreen,
      * otherwise return false
+     *
+     * @private
+     * @param {HTMLIFrameElement} iframe
+     * @returns {boolean}
      */
     private isFullscreen(iframe);
 }

dist/ifilterable.d.ts

@@ -1,7 +1,30 @@
 /*! powerbi-client v2.0.0-beta.12 | (c) 2016 Microsoft Corporation MIT */
 import * as models from 'powerbi-models';
+/**
+ * Decorates embed components that support filters
+ * Examples include reports, pages and visuals
+ *
+ * @export
+ * @interface IFilterable
+ */
 export interface IFilterable {
+    /**
+     * Gets the filters currently applied to the object
+     *
+     * @returns {(Promise<(models.IBasicFilter | models.IAdvancedFilter)[]>)}
+     */
     getFilters(): Promise<(models.IBasicFilter | models.IAdvancedFilter)[]>;
+    /**
+     * Replaces all filters on the current object with the specified filter values
+     *
+     * @param {((models.IBasicFilter | models.IAdvancedFilter)[])} filters
+     * @returns {Promise<void>}
+     */
     setFilters(filters: (models.IBasicFilter | models.IAdvancedFilter)[]): Promise<void>;
+    /**
+     * Removes all filters from the current object
+     *
+     * @returns {Promise<void>}
+     */
     removeFilters(): Promise<void>;
 }

dist/page.d.ts

@@ -3,14 +3,51 @@ import { IFilterable } from './ifilterable';
 import { IReportNode } from './report';
 import { Visual } from './visual';
 import * as models from 'powerbi-models';
+/**
+ * A Page node within a report hierarchy
+ *
+ * @export
+ * @interface IPageNode
+ */
 export interface IPageNode {
     report: IReportNode;
     name: string;
 }
+/**
+ * A Power BI report page
+ *
+ * @export
+ * @class Page
+ * @implements {IPageNode}
+ * @implements {IFilterable}
+ */
 export declare class Page implements IPageNode, IFilterable {
+    /**
+     * The parent Power BI report that this page is a member of
+     *
+     * @type {IReportNode}
+     */
     report: IReportNode;
+    /**
+     * The report page name
+     *
+     * @type {string}
+     */
     name: string;
+    /**
+     * The user defined display name of the report page
+     * This can be undefined in cases where page is created manually
+     *
+     * @type {string}
+     */
     displayName: string;
+    /**
+     * Creates an instance of a Power BI report page.
+     *
+     * @param {IReportNode} report
+     * @param {string} name
+     * @param {string} [displayName]
+     */
     constructor(report: IReportNode, name: string, displayName?: string);
     /**
      * Gets all page level filters within report
@@ -19,15 +56,19 @@ export declare class Page implements IPageNode, IFilterable {
      * page.getFilters()
      *  .then(pages => { ... });
      * ```
+     *
+     * @returns {(Promise<(models.IBasicFilter | models.IAdvancedFilter)[]>)}
      */
-    getFilters(): Promise<models.IFilter[]>;
+    getFilters(): Promise<(models.IBasicFilter | models.IAdvancedFilter)[]>;
     /**
      * Gets all the visuals on the page.
      *
      * ```javascript
      * page.getVisuals()
      *   .then(visuals => { ... });
      * ```
+     *
+     * @returns {Promise<Visual[]>}
      */
     getVisuals(): Promise<Visual[]>;
     /**
@@ -36,6 +77,8 @@ export declare class Page implements IPageNode, IFilterable {
      * ```javascript
      * page.removeFilters();
      * ```
+     *
+     * @returns {Promise<void>}
      */
     removeFilters(): Promise<void>;
     /**
@@ -44,6 +87,8 @@ export declare class Page implements IPageNode, IFilterable {
      * ```javascripot
      * page.setActive();
      * ```
+     *
+     * @returns {Promise<void>}
      */
     setActive(): Promise<void>;
     /**
@@ -53,6 +98,9 @@ export declare class Page implements IPageNode, IFilterable {
      * page.setFilters(filters);
      *   .catch(errors => { ... });
      * ```
+     *
+     * @param {((models.IBasicFilter | models.IAdvancedFilter)[])} filters
+     * @returns {Promise<void>}
      */
     setFilters(filters: (models.IBasicFilter | models.IAdvancedFilter)[]): Promise<void>;
     /**
@@ -68,6 +116,9 @@ export declare class Page implements IPageNode, IFilterable {
      * const visual = report.page('ReportSection1').visual('BarChart1');
      * visual.setFilters(filters);
      * ```
+     *
+     * @param {string} name
+     * @returns {Visual}
      */
     visual(name: string): Visual;
 }

dist/powerbi.d.ts

@@ -11,7 +11,6 @@ export { Page } from './page';
 export { Visual } from './visual';
 declare global  {
     interface Window {
-        Powerbi: typeof service.Service;
         powerbi: service.Service;
     }
 }