Merged PR 125682: Resolve npm audit vulnerabilities, TS v3, migrated to @types

## Changes in this PR
1. Resolved all npm audit vulnerabilities (except 1 low severity vulnerability in _gulp-gh-pages_, no fix available for that)
1. Upgraded to TS 3.9
1. Migrated from typings to @types
1. Used async/await to align with the return types of methods
1. Minor docs fixes
1. Fixed types of all methods

Related work items: #323592, #323972, #326488, #327505, #330227, #331107, #331778, #331837, #459272, #459826, #460523, #461075, #462110, #462652, #463184, #463185, #463806, #463807, #464436, #468356, #468867

Author: parth-007

dist/powerbi-client.d.ts

@@ -40,29 +40,27 @@ gulp.task('ghpages', 'Deploy documentation to gh-pages', ['nojekyll'], function
 gulp.task("docs", 'Compile documentation from src code', function () {
   return gulp
     .src([
-      "typings/globals/es6-promise/index.d.ts",
+      "node_modules/es6-promise/es6-promise.d.ts",
       "node_modules/powerbi-models/dist/models.d.ts",
       "src/**/*.ts"
     ])
     .pipe(typedoc({
       mode: 'modules',
       includeDeclarations: true,
 
-      // Output options (see typedoc docs) 
+      // Output options (see typedoc docs)
       out: "./docs",
       json: "./docs/json/" + package.name + ".json",
 
-      // TypeDoc options (see typedoc docs) 
+      // TypeDoc options (see typedoc docs)
       ignoreCompilerErrors: true,
       version: true
-    }))
-    ;
+    }));
 });
 
 gulp.task('copydemotodocs', 'Copy the demo to the docs', function () {
   return gulp.src(["demo/**/*"])
-    .pipe(gulp.dest("docs/demo"))
-    ;
+    .pipe(gulp.dest("docs/demo"));
 });
 
 gulp.task('nojekyll', 'Add .nojekyll file to docs directory', function (done) {
@@ -153,20 +151,32 @@ gulp.task('lint:ts', 'Lints all TypeScript', function () {
 });
 
 gulp.task('min:js', 'Creates minified JavaScript file', function () {
-  return gulp.src(['!./dist/*.min.js', './dist/*.js'])
-    .pipe(uglify({
-      preserveComments: 'license'
+  webpackConfig.plugins = [
+    new webpack.BannerPlugin(webpackBanner)
+  ];
+  
+  // Create minified bundle without source map
+  webpackConfig.mode = 'production';
+  webpackConfig.devtool = 'none'
+
+  return gulp.src(['./src/powerbi-client.ts'])
+    .pipe(webpackStream({
+      config: webpackConfig
     }))
     .pipe(rename({
       suffix: '.min'
     }))
-    .pipe(gulp.dest('./dist'));
+    .pipe(uglify({
+      preserveComments: 'license'
+    }))
+    .pipe(gulp.dest('dist/'));
 });
 
 gulp.task('compile:ts', 'Compile typescript for powerbi-client library', function () {
   webpackConfig.plugins = [
     new webpack.BannerPlugin(webpackBanner)
   ];
+  webpackConfig.mode = "development";
 
   return gulp.src(['./src/powerbi-client.ts'])
     .pipe(webpackStream(webpackConfig))
@@ -181,7 +191,9 @@ gulp.task('compile:dts', 'Generate one dts file from modules', function () {
 
   var settings = {
     out: "powerbi-client.js",
-    declaration: true
+    declaration: true,
+    module: "system",
+    moduleResolution: "node"
   };
 
   var tsResult = tsProject.src()

dist/powerbi.js

@@ -1,9 +1,9 @@
 {
   "name": "powerbi-client",
-  "version": "2.15.2",
+  "version": "2.16.0",
   "description": "JavaScript library for embedding Power BI into your apps. Provides service which makes it easy to embed different types of components and an object model which allows easy interaction with these components such as changing pages, applying filters, and responding to data selection.",
   "main": "dist/powerbi.js",
-  "typings": "dist/powerbi-client.d.ts",
+  "types": "dist/powerbi-client.d.ts",
   "files": [
     "dist"
   ],
@@ -15,8 +15,7 @@
     "start": "http-server ./demo",
     "prestart": "cd demo && npm install",
     "test": "gulp test",
-    "gulp": "gulp",
-    "typings": "typings"
+    "gulp": "gulp"
   },
   "keywords": [
     "microsoft",
@@ -31,6 +30,12 @@
   "author": "Microsoft",
   "license": "MIT",
   "devDependencies": {
+    "@types/jasmine": "^3.5.10",
+    "@types/jquery": "^3.3.34",
+    "@types/jsen": "0.0.19",
+    "@types/karma-jasmine": "^3.1.0",
+    "@types/node": "^14.14.7",
+    "@types/npm": "^2.0.31",
     "del": "^2.2.2",
     "es6-promise": "^3.2.1",
     "gulp": "^4.0.2",
@@ -40,37 +45,36 @@
     "gulp-help-four": "^0.2.3",
     "gulp-rename": "^1.2.2",
     "gulp-replace": "^0.5.4",
-    "gulp-tslint": "^4.3.4",
+    "gulp-tslint": "^7.1.0",
     "gulp-typedoc": "^2.0.0",
-    "gulp-typescript": "^2.12.1",
+    "gulp-typescript": "^4.0.1",
     "gulp-uglify": "^1.5.1",
     "gulp4-run-sequence": "^1.0.0",
-    "http-server": "^0.11.1",
+    "http-server": "^0.12.1",
     "ignore-loader": "^0.1.1",
-    "jasmine-core": "^2.4.1",
+    "jasmine-core": "^2.99.1",
     "jquery": "^3.3.1",
     "json-loader": "^0.5.4",
-    "karma": "^4.4.1",
+    "karma": "^5.2.3",
     "karma-chrome-launcher": "^3.1.0",
-    "karma-coverage": "^2.0.1",
+    "karma-coverage": "^2.0.3",
     "karma-firefox-launcher": "^1.2.0",
     "karma-jasmine": "^0.3.8",
     "karma-phantomjs-launcher": "^1.0.4",
     "karma-spec-reporter": "0.0.32",
     "moment": "^2.14.1",
-    "phantomjs-prebuilt": "^2.1.3",
-    "ts-loader": "^0.8.1",
-    "tslint": "^3.6.0",
+    "phantomjs-prebuilt": "^2.1.16",
+    "ts-loader": "^6.2.2",
+    "tslint": "^5.20.0",
     "typedoc": "^0.15.0",
-    "typescript": "^1.8.10",
-    "typings": "^1.3.2",
-    "webpack": "^1.12.14",
-    "webpack-stream": "^3.1.0",
-    "yargs": "^4.4.0"
+    "typescript": "^3.9.7",
+    "webpack": "^4.44.2",
+    "webpack-stream": "^5.2.1",
+    "yargs": "^16.1.0"
   },
   "dependencies": {
     "http-post-message": "^0.2",
-    "powerbi-models": "^1.7.0",
+    "powerbi-models": "^1.7",
     "powerbi-router": "^0.1",
     "window-post-message-proxy": "^0.2"
   },

dist/powerbi.min.js

@@ -3,6 +3,7 @@ import * as embed from './embed';
 import * as models from 'powerbi-models';
 import * as utils from './util';
 import * as errors from './errors';
+import { IHttpPostMessageResponse } from 'http-post-message';
 
 /**
  * APIs for managing the report bookmarks.
@@ -12,10 +13,10 @@ import * as errors from './errors';
  */
 export interface IBookmarksManager {
   getBookmarks(): Promise<models.IReportBookmark[]>;
-  apply(bookmarkName: string): Promise<void>;
-  play(playMode: models.BookmarksPlayMode): Promise<void>;
+  apply(bookmarkName: string): Promise<IHttpPostMessageResponse<void>>;
+  play(playMode: models.BookmarksPlayMode): Promise<IHttpPostMessageResponse<void>>;
   capture(options?: models.ICaptureBookmarkOptions): Promise<models.IReportBookmark>;
-  applyState(state: string): Promise<void>;
+  applyState(state: string): Promise<IHttpPostMessageResponse<void>>;
 }
 
 /**
@@ -45,16 +46,17 @@ export class BookmarksManager implements IBookmarksManager {
    *
    * @returns {Promise<models.IReportBookmark[]>}
    */
-  getBookmarks(): Promise<models.IReportBookmark[]> {
+  async getBookmarks(): Promise<models.IReportBookmark[]> {
     if (utils.isRDLEmbed(this.config.embedUrl)) {
       return Promise.reject(errors.APINotSupportedForRDLError);
     }
 
-    return this.service.hpm.get<models.IReportBookmark[]>(`/report/bookmarks`, { uid: this.config.uniqueId }, this.iframe.contentWindow)
-      .then(response => response.body,
-        response => {
-          throw response.body;
-        });
+    try {
+      const response = await this.service.hpm.get<models.IReportBookmark[]>(`/report/bookmarks`, { uid: this.config.uniqueId }, this.iframe.contentWindow);
+      return response.body;
+    } catch (response) {
+      throw response.body;
+    }
   }
 
   /**
@@ -65,9 +67,9 @@ export class BookmarksManager implements IBookmarksManager {
    * ```
    *
    * @param {string} bookmarkName The name of the bookmark to be applied
-   * @returns {Promise<void>}
+   * @returns {Promise<IHttpPostMessageResponse<void>>}
    */
-  apply(bookmarkName: string): Promise<void> {
+  async apply(bookmarkName: string): Promise<IHttpPostMessageResponse<void>> {
     if (utils.isRDLEmbed(this.config.embedUrl)) {
       return Promise.reject(errors.APINotSupportedForRDLError);
     }
@@ -76,10 +78,11 @@ export class BookmarksManager implements IBookmarksManager {
       name: bookmarkName
     };
 
-    return this.service.hpm.post<models.IError[]>(`/report/bookmarks/applyByName`, request, { uid: this.config.uniqueId }, this.iframe.contentWindow)
-      .catch(response => {
-        throw response.body;
-      });
+    try {
+      return await this.service.hpm.post<void>(`/report/bookmarks/applyByName`, request, { uid: this.config.uniqueId }, this.iframe.contentWindow);
+    } catch (response) {
+      throw response.body;
+    }
   }
 
   /**
@@ -91,9 +94,9 @@ export class BookmarksManager implements IBookmarksManager {
    * ```
    *
    * @param {models.BookmarksPlayMode} playMode Play mode can be either `Presentation` or `Off`
-   * @returns {Promise<void>}
+   * @returns {Promise<IHttpPostMessageResponse<void>>}
    */
-  play(playMode: models.BookmarksPlayMode): Promise<void> {
+  async play(playMode: models.BookmarksPlayMode): Promise<IHttpPostMessageResponse<void>> {
     if (utils.isRDLEmbed(this.config.embedUrl)) {
       return Promise.reject(errors.APINotSupportedForRDLError);
     }
@@ -102,10 +105,11 @@ export class BookmarksManager implements IBookmarksManager {
       playMode: playMode
     };
 
-    return this.service.hpm.post<models.IError[]>(`/report/bookmarks/play`, playBookmarkRequest, { uid: this.config.uniqueId }, this.iframe.contentWindow)
-      .catch(response => {
-        throw response.body;
-      });
+    try {
+      return await this.service.hpm.post<void>(`/report/bookmarks/play`, playBookmarkRequest, { uid: this.config.uniqueId }, this.iframe.contentWindow);
+    } catch (response) {
+      throw response.body;
+    }
   }
 
   /**
@@ -118,7 +122,7 @@ export class BookmarksManager implements IBookmarksManager {
    * @param {models.ICaptureBookmarkOptions} [options] Options for bookmark capturing
    * @returns {Promise<models.IReportBookmark>}
    */
-  capture(options?: models.ICaptureBookmarkOptions): Promise<models.IReportBookmark> {
+  async capture(options?: models.ICaptureBookmarkOptions): Promise<models.IReportBookmark> {
     if (utils.isRDLEmbed(this.config.embedUrl)) {
       return Promise.reject(errors.APINotSupportedForRDLError);
     }
@@ -127,11 +131,12 @@ export class BookmarksManager implements IBookmarksManager {
       options: options
     };
 
-    return this.service.hpm.post<models.IReportBookmark>(`/report/bookmarks/capture`, request, { uid: this.config.uniqueId }, this.iframe.contentWindow)
-      .then(response => response.body,
-        response => {
-          throw response.body;
-        });
+    try {
+      const response = await this.service.hpm.post<models.IReportBookmark>(`/report/bookmarks/capture`, request, { uid: this.config.uniqueId }, this.iframe.contentWindow);
+      return response.body;
+    } catch (response) {
+      throw response.body;
+    }
   }
 
   /**
@@ -142,9 +147,9 @@ export class BookmarksManager implements IBookmarksManager {
    * ```
    *
    * @param {string} state A base64 bookmark state to be applied
-   * @returns {Promise<void>}
+   * @returns {Promise<IHttpPostMessageResponse<void>>}
    */
-  applyState(state: string): Promise<void> {
+  async applyState(state: string): Promise<IHttpPostMessageResponse<void>> {
     if (utils.isRDLEmbed(this.config.embedUrl)) {
       return Promise.reject(errors.APINotSupportedForRDLError);
     }
@@ -153,9 +158,10 @@ export class BookmarksManager implements IBookmarksManager {
       state: state
     };
 
-    return this.service.hpm.post<models.IError[]>(`/report/bookmarks/applyState`, request, { uid: this.config.uniqueId }, this.iframe.contentWindow)
-      .catch(response => {
-        throw response.body;
-      });
+    try {
+      return await this.service.hpm.post<void>(`/report/bookmarks/applyState`, request, { uid: this.config.uniqueId }, this.iframe.contentWindow);
+    } catch (response) {
+      throw response.body;
+    }
   }
 }

gulpfile.js

@@ -1,6 +1,6 @@
 /** @ignore *//** */
 const config = {
-  version: '2.15.2',
+  version: '2.16.0',
   type: 'js'
 };
 

package.json

@@ -80,8 +80,8 @@ export class Create extends embed.Embed {
    *
    * @returns {Promise<boolean>}
    */
-  isSaved(): Promise<boolean> {
-    return utils.isSavedInternal(this.service.hpm, this.config.uniqueId, this.iframe.contentWindow);
+  async isSaved(): Promise<boolean> {
+    return await utils.isSavedInternal(this.service.hpm, this.config.uniqueId, this.iframe.contentWindow);
   }
 
   /**