powerbi-visuals-tools 4.3.3 → 5.0.1

package/Changelog.md

@@ -2,6 +2,16 @@
 
 This page contains information about changes to the PowerBI Visual Tools (pbiviz).
 
+## 5.0.1
+* Fixed broken imports in webpack.config for some cases
+
+## 5.0.0
+* Migrated to TypeScript
+* Migrated to eslint
+* Fixed vulnerabilities
+* Migrated to newest CommanderJS
+* Migrated to NodeJS 18.0 **⚠**
+
 ## 4.3.2
 * LocalizationLoader has been moved to `powerbi-visuals-webpack-plugin`
 

package/README.md

@@ -24,7 +24,7 @@ Before you can get started you'll need to install the tools. This should only ta
 
 Before you can run (or install) the command line tools you must install NodeJS.
 
-* NodeJS 10.0+ Required - [Download NodeJS](https://nodejs.org)
+* NodeJS 18.0+ Required - [Download NodeJS](https://nodejs.org)
 
 #### Installation
 

package/bin/pbiviz.js

@@ -27,46 +27,65 @@
 
 "use strict";
 
-let confPath = '../config.json';
-let program = require('commander');
-let npmPackage = require('../package.json');
-let ConsoleWriter = require('../lib/ConsoleWriter');
-let config = require(confPath);
-let args = process.argv;
-let CertificateTools = require("../lib/CertificateTools");
+import { createCertificate } from "../lib/CertificateTools.js";
+import ConsoleWriter from '../lib/ConsoleWriter.js';
+import CommandManager from '../lib/CommandManager.js';
+import { readJsonFromRoot } from '../lib/utils.js';
+import { Command, Option } from 'commander';
 
-ConsoleWriter.info(`${npmPackage.name} version - ${npmPackage.version}`);
+const npmPackage = readJsonFromRoot('package.json');
+const rootPath = process.cwd();
+const program = new Command();
 
-program
+const pbiviz = program
     .version(npmPackage.version)
-    .command('new [name]', 'Create a new visual')
-    .command('info', 'Display info about the current visual')
-    .command('start', 'Start the current visual')
-    .command('package', 'Package the current visual into a pbiviz file')
-    .option('--install-cert', 'Creates and installs localhost certificate', onOpenCertFile);
+    .option('--install-cert', 'Creates and installs localhost certificate', createCertificate)
+    .showHelpAfterError('Run "pbiviz help" for usage instructions.')
+    .addHelpText('beforeAll', ConsoleWriter.info(`${npmPackage.name} version - ${npmPackage.version}`))
+    .addHelpText('before', ConsoleWriter.getLogoVisualization());
 
-//prepend logo to help screen
-if (args.length === 2 || (args.length > 2 && args[2] === 'help')) {
-    ConsoleWriter.logo();
-}
+pbiviz
+    .command('new')
+    .usage("<argument> [options]")
+    .argument('<name>', 'name of new visual')
+    .option('-f, --force', 'force creation (overwrites folder if exists)')
+    .addOption(new Option('-t, --template [template]', 'use a specific template')
+        .choices(['default', 'table', 'slicer', 'rvisual', 'rhtml', 'circlecard'])
+        .default('default')
+    )
+    .action((name, options) => {
+        CommandManager.new(options, name, rootPath);
+    });
 
-program.parse(args);
+pbiviz
+    .command('info')
+    .action(() => {
+        CommandManager.info(rootPath);
+    });
 
-if (program.args.length > 0) {
-    let validCommands = program.commands.map(c => c.name());
-    if (validCommands.indexOf(program.args[0]) === -1) {
-        ConsoleWriter.error("Invalid command. Run 'pbiviz help' for usage instructions.");
-        process.exit(1);
-    }
-}
+pbiviz
+    .command('start')
+    .usage('[options]')
+    .option('-p, --port [port]', 'set the port listening on')
+    .option('-d, --drop', 'drop outputs into output folder')
+    .option('--no-stats', "Doesn't generate statistics files")
+    .action(async (options) => {
+        CommandManager.start(options, rootPath);
+    });
 
-async function onOpenCertFile() {
-    let certPath = await CertificateTools.getCertFile(config, true);
-    
-    if (!certPath) {
-        ConsoleWriter.error("Certificate not found. The new certificate will be generated");
-        await CertificateTools.createCertFile(config, true);
-    } else {
-        await CertificateTools.openCertFile(config);
-    }
-}
+pbiviz
+    .command('package')
+    .usage('[options]')
+    .option('--resources', "Produces a folder containing the pbiviz resource files (js, css, json)")
+    .option('--no-pbiviz', "Doesn't produce a pbiviz file (must be used in conjunction with resources flag)")
+    .option('--no-minify', "Doesn't minify the js in the package (useful for debugging)")
+    .option('--no-stats', "Doesn't generate statistics files")
+    .addOption(new Option('-c, --compression <compressionLevel>', "Enables compression of visual package")
+        .choices(['0', '1', '2', '3', '4', '5', '6', '7', '8', '9'])
+        .default('6')
+    )
+    .action((options) => {
+        CommandManager.package(options, rootPath);
+    });
+
+program.parse(process.argv);

package/certs/PowerBICustomVisualTest_private.key

@@ -1,28 +1,28 @@
 -----BEGIN PRIVATE KEY-----
-MIIEvAIBADANBgkqhkiG9w0BAQEFAASCBKYwggSiAgEAAoIBAQDOSWlsqIWSWZW5
-8abJJymt4EcIUJA3HLW1NbMO43gdF+G/qiGbo3SoEHZEBm3wCiTDndFUXwqhfts9
-WUPg2R3hEP9l1BzidxyEktGJnjGwz2HDq2HdoTqTViHgZpso19kcfP3YOQdu8b9W
-X4cKrx2N5pJJjADRjyJsNqNKV5WdXBj5eAgy5BY70L7aew80PXVQ3fSl7/2f1tHC
-DxMdJwh+RKJnkpi72j5Gzgr5+q/oy0jrajNC8KLUR5DCXloeR6HjNHLjMM9oMsuu
-r6GspZkNWtA2WgZRQxF2YFG9XmS+e4bpsgnvqVCXodFbUcqhvJul+DYHNlvsQ5aP
-vdrO46zfAgMBAAECggEAVAhRuuK3btOxi4qmH6EleGA5b2iqJtk6KDRU2cbN4kQd
-QR+EC0u9tMzn8HQSCsuHCGzcnhsNUJZFpysa3Jh1dH6hG5EZpyNQaa0JUJ8xrM3+
-DGBfQJJyMxzONgR2RmAPYGyGV7N7lLVD9WJ6t154kpqPkwhGOReutRhY0mr1VqE2
-/gv3RHQqPMwKVIJjm7TgJH586c84xZaWjlF9OnbKm6jTkbW9zdHcALB76EWowNy8
-BNVk6kfF8DnfDJ/9hvQPFR4oGQ+gUiywPQPuwRWltfwyH1u9N+lN8RNUxklsXRuU
-yOYWJ7YYMwVj6fAAPEhaMKWQg0MoF6RXIn8HHr5p0QKBgQD4QwTccUwqZG0apyc5
-0i6Yuaug/ovmx26Lgkysw1OwnR7O78RZe6ofs2scpMLaKignXVj38WDstj6IZR6M
-SUCjbXxpF7SFbqDn1qikIANf9y9vVoamv8S3Mu+uN9ajYBOh9ptE1JfESuaIGREx
-/h4VCfSkwBFmrQh8LFWFVEnb+QKBgQDUt3UHN77/8MJhY1VKOaeRxeE8zNqw7y2P
-G54eeLPGecrXsQ8kIJ1Dod7zWa5ieB1HL8sA7JTloZvqbpOLS0FVa++MJZs/nGlp
-Fk6L48GeoQetXHdNi1AsRT/td31uZhs9eyZaCS64C0fGzj6K4rqgfYrKlYAAxmd2
-4G23kWOVlwKBgCotSKAi52u0UAzdJP7fxGbR9GSPmjkE3LT62Afpz0gMCXXiqhsB
-tW9ZTfM50pi53MSDSWAmM+9DLvCBLWVr9H1PVnmMO3EH0HJSt6fagHhHSFnD+3BM
-2CC/mJSii+aJpgw4FzzkWTxR9URd7dvubjHo1RVARDSLZQujhIv4O+wRAoGAYMxH
-PgyZJyDpY6XvRwKrhYN1ttRF5GRC6C+aKaWlsXj03GhfSoJo7kD4EudJmtesAxv1
-lisSqth6+hhtneKWDYg7jxwB5NWJhl+3SKNRFZ2Tv8knJStzRWIR8D8C3j0qwjSL
-REePcgL4G7j47vy0DppykTOs9y1SId+JLhLELWsCgYBwz8GwVMG0nxMJVsmkcg5V
-JGGSDMwtS3qPNN6QgTqzBnLiUHAdjz4RDsKEC9bPqi5//OePV2skaoAXWJmykl//
-8hGUr9YX1Lb6sh2ilfgnkDQdwMlVBXYgE5qUFoFmDtsymtKtdtKfpZz066llLl4y
-dBHWdyVaFgzl9YYIBchpEw==
+MIIEvQIBADANBgkqhkiG9w0BAQEFAASCBKcwggSjAgEAAoIBAQDR1WMQoToRp+2T
+IBC+pR/KnnaeF0QcKQF+0BmjSPKiJ7gRv9NlOX2ZuiDj/uFdHvVWO4ALhIt+NhKO
+eAxPPN/ekMHKJoxLxBrVHcvi8P5QKOraeklY5xiICLevUWsQ4XAWL3HaKx0ocPJQ
+qNnVzYykT01kg1HKBMmx2bFx3vff7wJMTN0luU4YFnvjtjFr/PD7d8No889Ud6Ho
+BzMSeOVyApvMI5TzsPqLiabZqZYiASw3E+P6RwZGYBwGcNegZVzhGOCIEHV6X1s0
+McVkwHjYnFTd808kZ2swU3uCDOW8t9mCxsT81gD2X9JfGQH8QnDLi12gC67TIb7P
+wxZXDcZ9AgMBAAECgf9NdPecq+dDnTmVlcCYn1uc7+HZeb0qp/hlV2wfWk42jXLl
+Gmpuc0pp9MsvXmbSeRsXOd+KYOMdM9ilvqrMlSwOfGEMvi4Lydgd02Hv5AX8kR4g
+iAOLTcNAc/daQDPFh3JYvirI3iFlTEwmei3vPnEsNhnbgJ4wdJP/ktxtrGDTyDtv
+lAL8Kjm0QYQzsmaeTZ97/Z5jBQf/UzUnPW+MeEteer185kuL8lKzAn5MLU5qzpsV
+h7FDemCg0RLShJ8GAyIb0F6SqK8m5oJAssxXALklfUibwFFyIJXTnGTzcz/t+5rk
+PVIItw9b0wJRZbZTnpbefbI978dVmVW0Ebagx6cCgYEA5Fz7uSQQHf9yGBxES2NH
+BVzdZPCaJpkdyejMSUAYl5tVF622Mo5cNAlL9nsHJn+Ouenc6HZyoWAcWXAa2y9u
+bM17Zv3p+ZkECBoEQD3jJDJSmTIvf3MPeyBz1YPkrmvxr3Paul4yOx58RxsY8o4i
+2uBEC5grPOQ0OqEcwfTE6q8CgYEA6zpT/ejNMHNxrQk8y3HPAIM0gKoXgsKDRx/h
+RoAB6grC5GBrQ2NSa1zEne2/9B7A8etSrYNeK7kKUyRPXdpBArZMQ6qU2zUbOk5x
+G2W14RzoZhKcutdq0QiR1/EIhNjyxM+ug8iIbZnlQbzN3LUDXmpiO7pPdUM8+TRT
+7kMmPJMCgYEAnm7URZJ7jBRZd9jEmPj7oQDYqNs0V2sLe7WDZZ6OcUBXPOJL8a9K
+0N9SUGLyhwcgYmOZ272xsbwYbwST3VV+6wV0g/PNjFlYrrY+FMPa/pXbMGXdBjMx
+nl7ZflzPHyPMvclHCt2nQ9TWrA5ktINgMzI8gz7DYK+CfNqiNP44UAkCgYEAxtcU
+fvMW2FkOA65mVLeMuyst64FcxGz2md3qCTVV6OhV3MVghqNj3Vua3MFH3O1OPnGk
+/wWoSh9uCeAMsxI2mDtPdnewwyg+Luh2FinBOFy+WuJq2EoWgkLTPg4DHIFjnljM
+dZvDL5rCv/IAtwvQoDQfe8u/NSm0VhgUxri+jr8CgYEApyRX9mpaqoVnyvt8tO3v
+knDtBjSkSg1RH7YgvkSnm+COtjeeaRJLE5FbqbE1MxOM8Uw3vxjjJO0EK+ALB1+7
+6cC6BNMBppnOi28iClMJbdFm7b1/hR3M2VIKXTo/ostWpyhi2D4jL0e2sHBAOfmd
+y/zyzdcQx4Cr/OdiqEV6FH0=
 -----END PRIVATE KEY-----

package/certs/PowerBICustomVisualTest_public.crt

@@ -1,19 +1,19 @@
 -----BEGIN CERTIFICATE-----
-MIIDCTCCAfGgAwIBAgIUELR3jPqp7LJNe+IaYBSt/PMQEuUwDQYJKoZIhvcNAQEL
-BQAwFDESMBAGA1UEAwwJbG9jYWxob3N0MB4XDTIzMDcxODA5NDgwM1oXDTI0MDcx
-NzA5NDgwM1owFDESMBAGA1UEAwwJbG9jYWxob3N0MIIBIjANBgkqhkiG9w0BAQEF
-AAOCAQ8AMIIBCgKCAQEAzklpbKiFklmVufGmyScpreBHCFCQNxy1tTWzDuN4HRfh
-v6ohm6N0qBB2RAZt8Aokw53RVF8KoX7bPVlD4Nkd4RD/ZdQc4ncchJLRiZ4xsM9h
-w6th3aE6k1Yh4GabKNfZHHz92DkHbvG/Vl+HCq8djeaSSYwA0Y8ibDajSleVnVwY
-+XgIMuQWO9C+2nsPND11UN30pe/9n9bRwg8THScIfkSiZ5KYu9o+Rs4K+fqv6MtI
-62ozQvCi1EeQwl5aHkeh4zRy4zDPaDLLrq+hrKWZDVrQNloGUUMRdmBRvV5kvnuG
-6bIJ76lQl6HRW1HKobybpfg2BzZb7EOWj73azuOs3wIDAQABo1MwUTAdBgNVHQ4E
-FgQUBhZ5+H7vF/fRcLn8DwDof/oF1OwwHwYDVR0jBBgwFoAUBhZ5+H7vF/fRcLn8
-DwDof/oF1OwwDwYDVR0TAQH/BAUwAwEB/zANBgkqhkiG9w0BAQsFAAOCAQEAJWcq
-W+T1hVENeUzllGC90/JaEIEzrMwnlhHCoC6LjVo9MBcpVL4gNzMYMJvNf6VuJu9u
-KVlN84tylrNV7G2YFKB3YcP54E7r/wi5i19OSuZ58b53U8Uo5zIGXlp2BuOwuSzr
-/oeQcXg3WAaS6qADg9ZD+DeWLw38QnwUDDl1Co4bS1Cr1t63P8xOMNdZB61J3hfa
-0k2ZWopzWInSFkDdu5SyZNISRBaXPrcCKzI25owbqWk0SdhrGFPFszH+w0XoLtEc
-i63sJp/98yP+zh5AgxtjR68YBwpQzVI9jVzrxZNLca0oh5KLX3kSPXa8N6EZYAmi
-osIHF7K4GD9KFzpULg==
+MIIDCTCCAfGgAwIBAgIUMxSp+t25lEMX+I2Qwl2VPvaIhMswDQYJKoZIhvcNAQEL
+BQAwFDESMBAGA1UEAwwJbG9jYWxob3N0MB4XDTIzMDcyNDE4NTUyNVoXDTI0MDcy
+MzE4NTUyNVowFDESMBAGA1UEAwwJbG9jYWxob3N0MIIBIjANBgkqhkiG9w0BAQEF
+AAOCAQ8AMIIBCgKCAQEA0dVjEKE6EaftkyAQvqUfyp52nhdEHCkBftAZo0jyoie4
+Eb/TZTl9mbog4/7hXR71VjuAC4SLfjYSjngMTzzf3pDByiaMS8Qa1R3L4vD+UCjq
+2npJWOcYiAi3r1FrEOFwFi9x2isdKHDyUKjZ1c2MpE9NZINRygTJsdmxcd733+8C
+TEzdJblOGBZ747Yxa/zw+3fDaPPPVHeh6AczEnjlcgKbzCOU87D6i4mm2amWIgEs
+NxPj+kcGRmAcBnDXoGVc4RjgiBB1el9bNDHFZMB42JxU3fNPJGdrMFN7ggzlvLfZ
+gsbE/NYA9l/SXxkB/EJwy4tdoAuu0yG+z8MWVw3GfQIDAQABo1MwUTAdBgNVHQ4E
+FgQUdVL9VTkbLJWGTUXaoxQ3Q0px1aMwHwYDVR0jBBgwFoAUdVL9VTkbLJWGTUXa
+oxQ3Q0px1aMwDwYDVR0TAQH/BAUwAwEB/zANBgkqhkiG9w0BAQsFAAOCAQEAxgJg
+PbzNc1+YI8BTNaIfwqhzuZ85xJlxMUY3YikjaVpZJs4wik1CL1M/TN/6s6MNiHrw
+fH7QhJGgt7tq5TEjUpDjVNDtYMX6/tx1XdjYTsIl3zBJkz9GUPckdF8OcK8a+D3R
+7LPyMKUQ38LzbDwfbkAjXeWL23E/gJcd7p14/Eeyew6/6Xi2RLdHrH5teSjyIZ9B
+1cM/1Nv1Q634Xts5o6SNvPfWyX0BxsmQYGraOXzNSS+oSilOEaMILHWWXXrGMtxN
+W7mjZfpXjM0Ofx4XatEdmO5664RpzA0QKltEV8IVohGbS26WfErrjsYVZ/zoO4dC
+cTpYSCqOl0e8eqfLnw==
 -----END CERTIFICATE-----

package/config.json

@@ -1,35 +1,28 @@
 {
-    "templates": {
-        "visuals": "templates/visuals",
-        "pbiviz": "templates/pbiviz.json.template",
-        "plugin": "templates/plugin.ts.template",
-        "package": "templates/package.json.template"
-    },
-    "generate": {
-        "apiVersion": "3.8.0"
-    },
-    "constants": {
-        "minAPIversion": "3.2.0"
-    },
-    "build": {
-        "precompileFolder": ".tmp/precompile",
-        "dropFolder": ".tmp/drop",
-        "js": "tmp.visual.js",
-        "css": "visual.css",
-        "stats": "../../webpack.statistics.html"
-    },
-    "package": {
-        "dropFolder": "dist"
-    },
-    "server": {
-        "root": "webRoot",
-        "assetsRoute": "/assets",
-        "privateKey": "certs/PowerBICustomVisualTest_private.key",
-        "certificate": "certs/PowerBICustomVisualTest_public.crt",
-        "pfx": "certs/PowerBICustomVisualTest_public.pfx",
-        "port": "8080"
-    },
-    "visualTemplates": {
-        "circlecard": "https://codeload.github.com/microsoft/powerbi-visuals-circlecard-react/zip/master"
-    }
-}
+  "templates": {
+    "visuals": "templates/visuals",
+    "pbiviz": "templates/pbiviz.json.template",
+    "plugin": "templates/plugin.ts.template",
+    "package": "templates/package.json.template"
+  },
+  "generate": { "apiVersion": "5.3.0" },
+  "constants": { "minAPIversion": "4.7.0" },
+  "build": {
+    "precompileFolder": ".tmp/precompile",
+    "dropFolder": ".tmp/drop",
+    "js": "tmp.visual.js",
+    "css": "visual.css",
+    "stats": "../../webpack.statistics.html"
+  },
+  "package": { "dropFolder": "dist" },
+  "server": {
+    "root": "webRoot",
+    "assetsRoute": "/assets",
+    "privateKey": "certs/PowerBICustomVisualTest_private.key",
+    "certificate": "certs/PowerBICustomVisualTest_public.crt",
+    "pfx": "certs/PowerBICustomVisualTest_public.pfx"
+  },
+  "visualTemplates": {
+    "circlecard": "https://codeload.github.com/microsoft/powerbi-visuals-circlecard-react/zip/master"
+  }
+}