powerbi-visuals-tools 4.3.3 → 5.0.0

package/lib/webpack.config.js

@@ -1,11 +1,11 @@
-const path = require("path");
-const webpack = require("webpack");
-const MiniCssExtractPlugin = require("mini-css-extract-plugin");
-const { LocalizationLoader } = require("powerbi-visuals-webpack-plugin");
-const TerserPlugin = require("terser-webpack-plugin");
-const config = require("../config.json");
-
-module.exports = {
+import { getRootPath, readJsonFromRoot } from './utils.js';
+import { LocalizationLoader } from "powerbi-visuals-webpack-plugin";
+import MiniCssExtractPlugin from "mini-css-extract-plugin";
+import TerserPlugin from "terser-webpack-plugin";
+import path from "path";
+import webpack from "webpack";
+const config = readJsonFromRoot("/config.json");
+const webpackConfig = {
     entry: {
         'visual.js': ['./src/visual.ts']
     },
@@ -36,7 +36,7 @@ module.exports = {
             },
             {
                 test: /\.json$/,
-                loader: require.resolve('json-loader'),
+                loader: 'json-loader',
                 type: "javascript/auto"
             },
             {
@@ -46,13 +46,13 @@ module.exports = {
                         loader: MiniCssExtractPlugin.loader
                     },
                     {
-                        loader: require.resolve('css-loader')
+                        loader: 'css-loader'
                     },
                     {
-                        loader: require.resolve('less-loader'),
+                        loader: 'less-loader',
                         options: {
                             lessOptions: {
-                                paths: [path.resolve(__dirname, "..", 'node_modules')]
+                                paths: [path.resolve(getRootPath(), 'node_modules')]
                             }
                         }
                     }
@@ -62,55 +62,46 @@ module.exports = {
                 test: /\.(woff|ttf|ico|woff2|jpg|jpeg|png|webp|gif|svg|eot)$/i,
                 type: 'asset/inline'
             },
-            { 
+            {
                 test: /powerbiGlobalizeLocales\.js$/,
-                use: [
-                    {
-                        loader: LocalizationLoader
-                    }
-                ]
+                loader: LocalizationLoader
             }
         ]
     },
     externals: {
-        "powerbi-visuals-api": 'null',
-        "fakeDefine": 'false',
-        "corePowerbiObject": "Function('return this.powerbi')()",
-        "realWindow": "Function('return this')()"
+        "powerbi-visuals-api": 'null'
     },
     resolve: {
         extensions: ['.tsx', '.ts', '.jsx', '.js', '.css'],
         fallback: {
-            assert: require.resolve("assert/"),
-            buffer: require.resolve("buffer/"),
-            console: require.resolve("console-browserify/"),
-            constants: require.resolve("constants-browserify/"),
-            crypto: require.resolve("crypto-browserify/"),
-            domain: require.resolve("domain-browser/"),
-            events: require.resolve("events/"),
-            http: require.resolve("stream-http/"),
-            https: require.resolve("https-browserify/"),
-            os: require.resolve("os-browserify/"),
-            path: require.resolve("path-browserify/"),
-            punycode: require.resolve("punycode/"),
-            process: require.resolve("process/"),
-            querystring: require.resolve("querystring-es3/"),
-            stream: require.resolve("stream-browserify/"),
-            /* eslint-disable camelcase */
-            _stream_duplex: require.resolve("readable-stream/"),
-            _stream_passthrough: require.resolve("readable-stream/"),
-            _stream_readable: require.resolve("readable-stream/"),
-            _stream_transform: require.resolve("readable-stream/"),
-            _stream_writable: require.resolve("readable-stream/"),
-            string_decoder: require.resolve("string_decoder/"),
-            /* eslint-enable camelcase */
-            sys: require.resolve("util/"),
-            timers: require.resolve("timers-browserify/"),
-            tty: require.resolve("tty-browserify/"),
-            url: require.resolve("url/"),
-            util: require.resolve("util/"),
-            vm: require.resolve("vm-browserify/"),
-            zlib: require.resolve("browserify-zlib/")
+            assert: path.resolve("../node-modules/assert/"),
+            buffer: path.resolve("../node-modules/buffer/"),
+            console: path.resolve("../node-modules/console-browserify/"),
+            constants: path.resolve("../node-modules/constants-browserify/"),
+            crypto: path.resolve("../node-modules/crypto-browserify/"),
+            domain: path.resolve("../node-modules/domain-browser/"),
+            events: path.resolve("../node-modules/events/"),
+            http: path.resolve("../node-modules/stream-http/"),
+            https: path.resolve("../node-modules/https-browserify/"),
+            os: path.resolve("../node-modules/os-browserify/"),
+            path: path.resolve("../node-modules/path-browserify/"),
+            punycode: path.resolve("../node-modules/punycode/"),
+            process: path.resolve("../node-modules/process/"),
+            querystring: path.resolve("../node-modules/querystring-es3/"),
+            stream: path.resolve("../node-modules/stream-browserify/"),
+            _stream_duplex: path.resolve("../node-modules/readable-stream/"),
+            _stream_passthrough: path.resolve("../node-modules/readable-stream/"),
+            _stream_readable: path.resolve("../node-modules/readable-stream/"),
+            _stream_transform: path.resolve("../node-modules/readable-stream/"),
+            _stream_writable: path.resolve("../node-modules/readable-stream/"),
+            string_decoder: path.resolve("../node-modules/string_decoder/"),
+            sys: path.resolve("../node-modules/util/"),
+            timers: path.resolve("../node-modules/timers-browserify/"),
+            tty: path.resolve("../node-modules/tty-browserify/"),
+            url: path.resolve("../node-modules/url/"),
+            util: path.resolve("../node-modules/util/"),
+            vm: path.resolve("../node-modules/vm-browserify/"),
+            zlib: path.resolve("../node-modules/browserify-zlib/")
         }
     },
     output: {
@@ -132,11 +123,11 @@ module.exports = {
             "cache-control": "public, max-age=0"
         }
     },
+    watchOptions: {
+        ignored: ['node_modules/**']
+    },
     plugins: [
         new webpack.ProvidePlugin({
-            $: 'jquery',
-            jQuery: 'jquery',
-            d3: 'd3',
             Buffer: ["buffer", "Buffer"],
             process: "process/browser"
         }),
@@ -146,4 +137,4 @@ module.exports = {
         })
     ]
 };
-
+export default webpackConfig;

package/package.json

@@ -1,14 +1,17 @@
 {
   "name": "powerbi-visuals-tools",
-  "version": "4.3.3",
+  "version": "5.0.0",
   "description": "Command line tool for creating and publishing visuals for Power BI",
-  "main": "./lib/VisualPackage.js",
+  "main": "./bin/pbiviz.js",
+  "type": "module",
   "scripts": {
-    "start": "node ./bin/pbiviz.js",
-    "test": "npm run clean-tests && npm run lint && npm run jasmine",
+    "build": "tsc",
+    "pbiviz": "node ./bin/pbiviz.js",
+    "start": "npm run pbiviz start",
+    "test": "npm run build && npm run clean-tests && npm run lint && npm run jasmine",
     "jasmine": "node spec/jasmine-runner.js",
     "jasmine-inspect": "node --inspect spec/jasmine-runner.js",
-    "lint": "eslint bin lib spec",
+    "lint": "npx eslint . --ext .ts,.tsx",
     "clean-tests": "node spec/clean-tests.js",
     "debug-tests": "npm run clean-tests && npm run lint && npm run jasmine-inspect"
   },
@@ -26,22 +29,25 @@
   },
   "homepage": "https://github.com/Microsoft/PowerBI-visuals-tools#readme",
   "dependencies": {
+    "@typescript-eslint/parser": "^5.62.0",
     "assert": "^2.0.0",
     "async": "^3.2.4",
     "browserify-zlib": "^0.2.0",
     "buffer": "^6.0.3",
-    "chalk": "3.0.0",
-    "commander": "4.1.1",
-    "compare-versions": "^3.6.0",
+    "chalk": "^5.3.0",
+    "commander": "^11.0.0",
+    "compare-versions": "^6.0.0",
     "console-browserify": "^1.2.0",
     "constants-browserify": "^1.0.0",
     "crypto-browserify": "^3.12.0",
     "css-loader": "^6.8.1",
     "domain-browser": "^4.22.0",
     "events": "^3.3.0",
+    "terser-webpack-plugin": "^5.3.9",
     "extra-watch-webpack-plugin": "^1.0.3",
     "fs-extra": "^11.1.1",
     "https-browserify": "^1.0.0",
+    "inline-source-map": "^0.6.2",
     "json-loader": "0.5.7",
     "jszip": "^3.10.1",
     "less": "^4.1.3",
@@ -66,9 +72,8 @@
     "typescript": "^4.9.5",
     "url": "^0.11.1",
     "util": "^0.12.5",
-    "uuid": "9.0.0",
     "vm-browserify": "^1.1.2",
-    "webpack": "^5.88.1",
+    "webpack": "^5.88.2",
     "webpack-bundle-analyzer": "4.9.0",
     "webpack-dev-server": "^4.15.1"
   },
@@ -77,12 +82,15 @@
     "jasmine": "5.0.2",
     "jasmine-spec-reporter": "7.0.0",
     "semver": "7.5.4",
-    "tree-kill": "1.2.2"
+    "tree-kill": "1.2.2",
+    "@typescript-eslint/eslint-plugin": "^5.62.0",
+    "eslint-plugin-powerbi-visuals": "^0.8.1",
+    "webpack-cli": "^5.1.4"
   },
   "optionalDependencies": {
     "fsevents": "*"
   },
   "engines": {
-    "node": ">=12.0.0"
+    "node": ">=18.0.0"
   }
 }

package/spec/clean-tests.js

@@ -26,6 +26,6 @@
 
 "use strict";
 
-let FileSystem = require('./helpers/FileSystem.js');
+import FileSystem from './helpers/FileSystem.js';
 
 FileSystem.deleteTempDirectory();

package/spec/e2e/pbivizCertSpec.js

@@ -26,28 +26,29 @@
 
 "use strict";
 
-let fs = require('fs-extra');
-let path = require('path');
-console.log(__dirname);
-let config = require('./../../config.json');
+import fs from 'fs-extra';
+import path from 'path';
+import { getRootPath, readJsonFromRoot } from '../../lib/utils.js';
+import { createCertFile } from '../../lib/CertificateTools.js';
 
-let CertificateTools = require('./../../lib/CertificateTools');
+const config = readJsonFromRoot('config.json');
 
 describe("E2E - pbiviz --install-cert", () => {
     beforeEach((done) => {
-        CertificateTools.createCertFile(config, false).then(done);
+        createCertFile(config, false).then(done);
     });
 
     describe("pbiviz", () => {
         it("pbiviz --install-cert command should generate certificate", (done) => {
-            let certPath = path.join(__dirname, "../../", config.server.certificate);
-            let keyPath = path.join(__dirname, "../../", config.server.privateKey);
-            let pfxPath = path.join(__dirname, "../../", config.server.pfx);
-            let certExists = fs.existsSync(certPath);
-            let keyExists = fs.existsSync(keyPath);
-            let pfxExists = fs.existsSync(pfxPath);
+            const rootPath = getRootPath();
+            const certPath = path.join(rootPath, config.server.certificate);
+            const keyPath = path.join(rootPath, config.server.privateKey);
+            const pfxPath = path.join(rootPath, config.server.pfx);
+            const certExists = fs.existsSync(certPath);
+            const keyExists = fs.existsSync(keyPath);
+            const pfxExists = fs.existsSync(pfxPath);
 
-            let result = (certExists && keyExists) || pfxExists;
+            const result = (certExists && keyExists) || pfxExists;
 
             expect(result).toBeTruthy();
             done();

package/spec/e2e/pbivizInfoSpec.js

@@ -26,21 +26,21 @@
 
 "use strict";
 
-const fs = require('fs-extra');
-const path = require('path');
-
-const FileSystem = require('../helpers/FileSystem.js');
+import fs from 'fs-extra';
+import path from 'path';
+import FileSystem from '../helpers/FileSystem.js';
+import { writeMetadata } from "./testUtils.js";
 
 const tempPath = FileSystem.getTempPath();
 const startPath = process.cwd();
-const writeMetadata = require("./utils").writeMetadata;
 
 describe("E2E - pbiviz info", () => {
 
-    const visualName = 'myuniquevisualnamegoeshere';
+    const visualName = 'myvisualname';
     const visualPath = path.join(tempPath, visualName);
 
     beforeEach(() => {
+        process.chdir(startPath);
         FileSystem.resetTempDirectory();
         process.chdir(tempPath);
         FileSystem.runPbiviz('new', visualName);
@@ -49,10 +49,6 @@ describe("E2E - pbiviz info", () => {
         writeMetadata(visualPath);
     });
 
-    afterEach(() => {
-        process.chdir(startPath);
-    });
-
     afterAll(() => {
         process.chdir(startPath);
         FileSystem.deleteTempDirectory();
@@ -71,6 +67,7 @@ describe("E2E - pbiviz info", () => {
         expect(error).toBeDefined();
         expect(error.status).toBe(1);
         expect(error.message).toContain("Error: pbiviz.json not found. You must be in the root of a visual project to run this command");
+
     });
 
     it("Should output visual info", () => {

package/spec/e2e/pbivizNewSpec.js

@@ -26,20 +26,19 @@
 
 "use strict";
 
-const fs = require('fs-extra');
-const path = require('path');
-const fsPromises = require("fs").promises;
-const utils = require('./utils');
-
-const FileSystem = require('../helpers/FileSystem.js');
-const writeMetadata = require("./utils").writeMetadata;
-const download = require("../../lib/utils").download;
-const createFolder = require("../../lib/utils").createFolder;
-const config = require("../../config.json");
-
+import fs from 'fs-extra';
+import path from 'path';
+import { promises as fsPromises } from "fs";
+import FileSystem from '../helpers/FileSystem.js';
+import { writeMetadata, readdirSyncRecursive } from "./testUtils.js";
+import { download, createFolder, readJsonFromRoot } from "../../lib/utils.js";
+
+const config = readJsonFromRoot('config.json');
 const tempPath = FileSystem.getTempPath();
 const templatePath = FileSystem.getTemplatePath();
 const startPath = process.cwd();
+const visualName = 'visualName';
+const visualPath = path.join(tempPath, visualName);
 
 describe("E2E - pbiviz new", () => {
 
@@ -53,37 +52,34 @@ describe("E2E - pbiviz new", () => {
     });
 
     afterAll(() => {
-        process.chdir(startPath);
         FileSystem.deleteTempDirectory();
     });
 
     it("Should generate new visual with default template", () => {
-        let visualName = 'visualname';
-        let template = 'default';
-        let visualPath = path.join(tempPath, visualName);
+        const template = 'default';
 
         FileSystem.runPbiviz('new', visualName, ' -t default');
 
         writeMetadata(visualPath);
 
         //check base dir
-        let stat = fs.statSync(visualPath);
+        const stat = fs.statSync(visualPath);
         expect(stat.isDirectory()).toBe(true);
 
         //check contents
-        let expectedFiles = utils.readdirSyncRecursive(path.join(templatePath, 'visuals', template));
-        expectedFiles.concat(utils.readdirSyncRecursive(path.join(templatePath, 'visuals', '_global')));
+        const expectedFiles = readdirSyncRecursive(path.join(templatePath, 'visuals', template));
+        expectedFiles.concat(readdirSyncRecursive(path.join(templatePath, 'visuals', '_global')));
         expectedFiles.push('/pbiviz.json');
-        let visualFiles = utils.readdirSyncRecursive(visualPath);
-        let fileDiff = [expectedFiles, visualFiles].reduce((a, b) => a.filter(c => !b.includes(c)));
+        const visualFiles = readdirSyncRecursive(visualPath);
+        const fileDiff = [expectedFiles, visualFiles].reduce((a, b) => a.filter(c => !b.includes(c)));
         expect(fileDiff.length).toBe(0);
 
         // check exists node_modules directory
-        let nodeModulesDirStat = fs.statSync(path.join(visualPath, "node_modules"));
+        const nodeModulesDirStat = fs.statSync(path.join(visualPath, "node_modules"));
         expect(nodeModulesDirStat.isDirectory()).toBe(true);
 
         //check pbiviz.json config file
-        let visualConfig = fs.readJsonSync(path.join(visualPath, 'pbiviz.json')).visual;
+        const visualConfig = fs.readJsonSync(path.join(visualPath, 'pbiviz.json')).visual;
         expect(visualConfig.name).toBe(visualName);
         expect(visualConfig.displayName).toBe(visualName);
         expect(visualConfig.guid).toBeDefined();
@@ -92,7 +88,7 @@ describe("E2E - pbiviz new", () => {
     });
 
     describe(`Should download 'Circlecard' visual archive from the repo`, () => {
-        let template = 'circlecard';
+        const template = 'circlecard';
 
         it(`Verifiy size`, async () => {
             const folder = createFolder(template);
@@ -108,6 +104,33 @@ describe("E2E - pbiviz new", () => {
 
     describe('Should generate new visual using specified template', () => {
 
+        function testGeneratedVisualByTemplateName(template) {
+            FileSystem.runPbiviz('new', visualName, `--template ${template}`);
+            if (template !== 'circlecard') {
+                FileSystem.runCMDCommand('npm i', visualPath, startPath);
+            }
+
+            //check base dir exists
+            const stat = fs.statSync(visualPath);
+            expect(stat.isDirectory()).toBe(true);
+
+            //read pbiviz json generated in visual
+            const pbivizJson = fs.readJsonSync(path.join(visualPath, 'pbiviz.json'));
+
+            //check pbiviz.json config file
+            const visualConfig = pbivizJson.visual;
+            if (template === 'circlecard') {
+                expect(visualConfig.name).toBe('reactCircleCard');
+                expect(visualConfig.displayName).toBe('ReactCircleCard');
+            } else {
+                expect(visualConfig.name).toBe(visualName);
+                expect(visualConfig.displayName).toBe(visualName);
+            }
+            expect(visualConfig.guid).toBeDefined();
+            expect(visualConfig.guid).toMatch(/^[a-zA-Z0-9]+$/g);
+            expect(visualConfig.guid.substr(0, visualName.length)).toBe(visualName);
+        }
+
         it('table', () => {
             const template = 'table';
 
@@ -137,55 +160,23 @@ describe("E2E - pbiviz new", () => {
 
             testGeneratedVisualByTemplateName(template);
         });
-
-        function testGeneratedVisualByTemplateName(template) {
-            let visualName = 'visualname',
-                visualPath = path.join(tempPath, visualName);
-
-            FileSystem.runPbiviz('new', visualName, `--template ${template}`);
-            if (template !== 'circlecard') {
-                FileSystem.runCMDCommand('npm i', visualPath, startPath);
-            }
-
-            //check base dir exists
-            let stat = fs.statSync(visualPath);
-            expect(stat.isDirectory()).toBe(true);
-
-            //read pbiviz json generated in visual
-            let pbivizJson = fs.readJsonSync(path.join(visualPath, 'pbiviz.json'));
-
-            //check pbiviz.json config file
-            let visualConfig = pbivizJson.visual;
-            if (template === 'circlecard') {
-                expect(visualConfig.name).toBe('reactCircleCard');
-                expect(visualConfig.displayName).toBe('ReactCircleCard');
-            } else {
-                expect(visualConfig.name).toBe(visualName);
-                expect(visualConfig.displayName).toBe(visualName);
-            }
-            expect(visualConfig.guid).toBeDefined();
-            expect(visualConfig.guid).toMatch(/^[a-zA-Z0-9]+$/g);
-            expect(visualConfig.guid.substr(0, visualName.length)).toBe(visualName);
-        }
     });
 
     it("Should convert multi-word visual name to camelCase", () => {
-        let visualDisplayName = 'My Visual Name here';
-        let visualName = 'myVisualNameHere';
-        FileSystem.runPbiviz('new', visualDisplayName);
+        const visualDisplayName = 'Visual Name';
+        FileSystem.runPbiviz('new', `"${visualDisplayName}"`);
 
-        let visualPath = path.join(tempPath, visualName);
-        let stat = fs.statSync(visualPath);
+        const stat = fs.statSync(visualPath);
         expect(stat.isDirectory()).toBe(true);
 
-        let visualConfig = fs.readJsonSync(path.join(visualPath, 'pbiviz.json')).visual;
+        const visualConfig = fs.readJsonSync(path.join(visualPath, 'pbiviz.json')).visual;
         expect(visualConfig.name).toBe(visualName);
         expect(visualConfig.displayName).toBe(visualDisplayName);
     });
 
     it("Should throw error if the visual name invalid", () => {
-        let invalidVisualName = '12test';
         let error;
+        let invalidVisualName = '12test';
         try {
             FileSystem.runPbiviz('new', invalidVisualName);
         }
@@ -215,9 +206,7 @@ describe("E2E - pbiviz new", () => {
     });
 
     it("Should throw error if the visual already exists", () => {
-        let visualName = 'visualname';
         let error;
-
         FileSystem.runPbiviz('new', visualName);
 
         try {
@@ -228,12 +217,11 @@ describe("E2E - pbiviz new", () => {
 
         expect(error).toBeDefined();
         expect(error.status).toBe(1);
+
     });
 
     it("Should overwrite existing visual with force flag", () => {
-        let visualName = 'visualname';
-        let visualPath = path.join(tempPath, visualName);
-        let visualTestFilePath = path.join(visualPath, 'testFile.txt');
+        const visualTestFilePath = path.join(visualPath, 'testFile.txt');
         let visualNewError, testFileError1, testFileError2;
 
         FileSystem.runPbiviz('new', visualName);