powerbi-visuals-tools 4.3.2 → 5.0.0

package/Changelog.md

@@ -2,6 +2,13 @@
 
 This page contains information about changes to the PowerBI Visual Tools (pbiviz).
 
+## 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-----
-MIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwggSkAgEAAoIBAQCt6LQgF0rF6JfW
-9eXIvaK8aGccaMqPQtLLh1Nc+xNxzfZ33DbZHaZrt7cO1obfeUVQ7KWUMHAXmUBz
-Fr01bCiSHKe8BKRxb502NXYtZuO9cGDk4Ya3U6QxDqKWMz3+0qpwsnsGGOqLo+EJ
-1v0crKtPZS4S39rl1tAIRdyiJimH87B+DjuQpI9pOrnWsdikuK++Q+htp5dEPPjF
-uMszYJNXN9MGV3Q2yxzxmhG9HY2YcDLrNUnXD2O9Sd2oj50IUDjALArIVMiTV0fe
-yde7QLT5QUizx69dZCFlnjf/1wj9MZquuZEewnuJJGtegZF07GUtm0axyVZjBkgB
-WP9SIyFtAgMBAAECggEAJa5eGPXzBZ64B6OP/kbYk+orLUSnXxMjiWXw8hyUwfvW
-g3H7kF+UR5Ku31AsOQ+VrUsZNVqpbvONu2IZ7RFaWQ5Mabi3yLxeW/iJepzoi4tl
-8zHKdr5wvRBmuhSwQh5zP6fscA3GBCul/vPONABVvgY2TXCjhVleCezZOWj7ZrFS
-VD5ZLR55aoIrGu5YDN1eb5q2pnM8DpRTQVMtC0SaYnduiS9gnM5p6/UnJtJmVJa2
-yPtUXEv5v6/qWcVoh4Yq6nzNC0aCs++QH0CuT9HYML/z2X3EPbJlNOMHYQeBZIEy
-tZxZuXOUNjMf2riZtkrhWWlJBjM6cZSlIe+abJyrIQKBgQDujSwrLdG0tQNYe0yU
-xGNW0yk0X0y/H+9+xb0FWFyI/JBXSkpKmgtJ7gANAKgQ9lnAXKg09RZ5czU4ew2m
-tz2WWWkUDw8wcl5W3DsbWwNp0Xf4ZK6R/HNbUEAQrEYEkg9ZVFCkN9+yI/4wq0/r
-gQp6b3l07Z/fbTQ3NSRWhBC6EwKBgQC6oR0+L+scTwy7jNa3fLhe4tzctOaynEqP
-GWU7I4gMiMYKga2CPEe1Hd4JbIe16KrLZ7djNCy6MkDiu0kYjavB+ZaNAVIIuYWh
-2gQI81iyOtJRJfb5Z3SLG7WfGsMFETwV9nqIapy8PREQMT0bOlNtxCRfHcshNCRx
-BYWiq+gmfwKBgQCMl9VdSW7bwwdKwbh7wVcO1/rj6/rOdeLv41io6s/2yGvFlno8
-h5d5pfSPtUBYZui0r6dPNtddEuJd/GAqTrrUfrOoZ8u68Nza8oc/cx+K4TKEycn9
-Lj1KpvxrFy1ZCkBTlJbGgkursPzh8EV09iOXz1VU7auYwcLReteEyecV0wKBgB6u
-WfZdPlObE0bJ8oqbsFu5BAIsozh9xSwdSq0cPEODQLt9ch7U9hzqWhRGiVD4fQuP
-c3CVpTy/AjfD/lJRCAmNlJh9vRS+Gx/ujXdDOjOiw+yfRyjdPyWXWpZbefAdUzlx
-GdfPXxD7IRD+Z0NQpWKIOkqAxWIiBlOmSr/hbvrVAoGBALyJ+Ovefv2LO/Ez66S0
-318LpnDOrVh/RRFxL4oCIUMZRLTXqjBiBrFbuOuHXUOlmIT6Wv5fkMtEKbZqjoFs
-HKOJsQGIf2a+KGGNWpHY0b1cLncLWb0fYzeB+6ezPOxXZJ3WM+115Aj00ZVzNjVA
-aRYc4vrWxJaR/fD5zni83gRp
+MIIEvAIBADANBgkqhkiG9w0BAQEFAASCBKYwggSiAgEAAoIBAQCi3X3hDfJ24lQJ
+nEPNxT37WNNDVD4Dq4yb5aTrDWxZJT7U1Je7G9j4y3+LE6s4HioehtGHRXECfVZ7
+Ts8t2oVhiim9751ECTSmsAFEboy7t8mvLCFlIvjU1NZUXlAe1dO/ekcecLSnzczF
+x+l8VgNve0DYRgRjuckgI4UDNrTCvKqxlQUW2YSh+/nmUiF9A9ZPfq2gkSiZLsS5
+tpRvVx102en1JZ1FLu3dZ/oI3A5HeDZgAW9HkSPZVBcp+aSG+S8ZHCRD/2B/qynt
+9IDwFotNQgnMJjl1Z3Y0qHQIntNUmv6MPFPgNEqk40ceT5CdA+jjZrgPxAjG3LR+
+6EMchWXlAgMBAAECggEAGLw+DYvCOvcV313J2Hsv9jgf4fZt8r2/vb+rg/2GaqWi
+/M0K/GJ22haCGPvUQdInAHrmYL6VstSZaWHnSmYJYu6Kd2vofThOtFA/6QZHPo1j
+xsSTj9o3Y4+tu6OVVJGSNt8Z5RAmB+RUSOebWQRxQiG8j/xWV1UUrFporbvFyVuD
+B+EWhUiUQSFlIFHuI/abMDGYChw05N0sRj78zU/ezBxxlvuxXacjbT8x3/3yROW5
+8ys9SW2C1ITUGpjM3m/ycF/IFgK7okklpQrZarha6wOeizx9v3g5TlhyscN4epTi
+ARR3MqpCecmTq/cCbszGhtr/cjXoW6uxoNSI2jzLowKBgQDY8sXPpf3C9yUVhxfX
+DRtZ0g20PXz6cYP88e3dJrkxXZljdEbvq0/5y2gR1jhVG1nyRpJrQ2ndGfsRN1Sb
+BHfOaf75ra1wBbDo05YvuQYq6YXfnH/sKGeRIcnrZ3g9Zso8WAQLlkQ65oW1ZQCM
+gxDw8gu0rIiNSJtkzX+RJVyRIwKBgQDALoGt+qK/gGKom2JmyGpxieHgj/dPWCJL
+uVk++PjC0v+4PznlhPk/6FFiMaQdgi0VnSbVtCuxiNFwcRWtT9EZRzbFb/bFxMNO
+Yd56onzbtJ9HupK3hhJ1ECY53uLpQlVnvHupG1xTE4jbOrmZxMKr7NdSNnvogPEF
+F7rty4xRVwKBgEJOQMLsGpjB7GWd+l1RtjBHkMSrnkz08MAYOPjEYwmBb+YDncKW
+e0T/M/lvnZv1VhJEG3AJFIvs6t0iKguO3AcMQk+RE1cPhjhCor5HMGlhIfdr33UQ
+DEdBKnN2Fju99MVoqSPZc1UFK4x7KCXJ0R2y/Hzl1n5H2KaAYCK+ZoI9AoGAPszz
+w46rsDicBM0CEuRbJE8SaPeisWLzkhs3dsSVRdT9i4/ds4sIiEG6loPyRVJMuUtp
+bVw7CwDSsBPEKaZzhfcnhs1Xrrjlua9xrFF8y67yfdYSK7a8QVTNqQuUyvTKQ+Pr
+5Q7z1JIFnt5J2F3b36K9mjgDta6tFCT1CNADQnECgYAJ20mQQEFO4xkaq5kkmben
+sKBJXWl/a/5lg9mIGLpbe7iLFZyCiNaCP1+QuPYJ9cihff270zU4rSXEp/BKUA5s
+084ozyhzCQ3UhYgZNte25Ct2Cwa6putzf++V31lu+zVs+WkPtOjKOStYc9MGD557
+oilZTxLWnVw/xSwoCJUc9g==
 -----END PRIVATE KEY-----

package/certs/PowerBICustomVisualTest_public.crt

@@ -1,19 +1,19 @@
 -----BEGIN CERTIFICATE-----
-MIIDCTCCAfGgAwIBAgIUb0Ahy3dl5lVvF6fgf0i2d3yTBywwDQYJKoZIhvcNAQEL
-BQAwFDESMBAGA1UEAwwJbG9jYWxob3N0MB4XDTIzMDUxMDA4NTYyMVoXDTI0MDUw
-OTA4NTYyMVowFDESMBAGA1UEAwwJbG9jYWxob3N0MIIBIjANBgkqhkiG9w0BAQEF
-AAOCAQ8AMIIBCgKCAQEArei0IBdKxeiX1vXlyL2ivGhnHGjKj0LSy4dTXPsTcc32
-d9w22R2ma7e3DtaG33lFUOyllDBwF5lAcxa9NWwokhynvASkcW+dNjV2LWbjvXBg
-5OGGt1OkMQ6iljM9/tKqcLJ7Bhjqi6PhCdb9HKyrT2UuEt/a5dbQCEXcoiYph/Ow
-fg47kKSPaTq51rHYpLivvkPobaeXRDz4xbjLM2CTVzfTBld0Nssc8ZoRvR2NmHAy
-6zVJ1w9jvUndqI+dCFA4wCwKyFTIk1dH3snXu0C0+UFIs8evXWQhZZ43/9cI/TGa
-rrmRHsJ7iSRrXoGRdOxlLZtGsclWYwZIAVj/UiMhbQIDAQABo1MwUTAdBgNVHQ4E
-FgQU9S5eM+NXgLaWklNwuiUBrOSMydUwHwYDVR0jBBgwFoAU9S5eM+NXgLaWklNw
-uiUBrOSMydUwDwYDVR0TAQH/BAUwAwEB/zANBgkqhkiG9w0BAQsFAAOCAQEAbBy4
-mARqkoNtP/cxlKxIHm0u8yYZxv0K/FjyA1PdB8iMkf96kSN7PVgjReGu8AYymUWF
-0dJiPwWYg917wfRWNadnNljnakA7QfAfxNjFwKANbccW5FJNXSc5pxZoDu06AvEt
-lw/Xx7JmQDDwrLk3jecTZy2m+mPxaQlJa0pd8+DerQZ5f5RbvgBp6Am7oGApvvb6
-XW0PzpApvrT/r/2jGyqU8P/lEL0FdsHrDlK9YusozpNK+j3broEzCUR4F363rEOf
-GPIiy2xFAvhq9s1fWY3Cof7+/nDRVYapIadUOw/irIKY9uzPtqkXKEgFw5lZwLnL
-MUj+ODfSVhjI5kPp2Q==
+MIIDCTCCAfGgAwIBAgIUU4UcF0xMfHlD1fGJZHbh+qlUYUcwDQYJKoZIhvcNAQEL
+BQAwFDESMBAGA1UEAwwJbG9jYWxob3N0MB4XDTIzMDcyMDA3NDMxM1oXDTI0MDcx
+OTA3NDMxM1owFDESMBAGA1UEAwwJbG9jYWxob3N0MIIBIjANBgkqhkiG9w0BAQEF
+AAOCAQ8AMIIBCgKCAQEAot194Q3yduJUCZxDzcU9+1jTQ1Q+A6uMm+Wk6w1sWSU+
+1NSXuxvY+Mt/ixOrOB4qHobRh0VxAn1We07PLdqFYYopve+dRAk0prABRG6Mu7fJ
+rywhZSL41NTWVF5QHtXTv3pHHnC0p83MxcfpfFYDb3tA2EYEY7nJICOFAza0wryq
+sZUFFtmEofv55lIhfQPWT36toJEomS7EubaUb1cddNnp9SWdRS7t3Wf6CNwOR3g2
+YAFvR5Ej2VQXKfmkhvkvGRwkQ/9gf6sp7fSA8BaLTUIJzCY5dWd2NKh0CJ7TVJr+
+jDxT4DRKpONHHk+QnQPo42a4D8QIxty0fuhDHIVl5QIDAQABo1MwUTAdBgNVHQ4E
+FgQUw6fYQDkuenlPn0I04iICZ7IwxKkwHwYDVR0jBBgwFoAUw6fYQDkuenlPn0I0
+4iICZ7IwxKkwDwYDVR0TAQH/BAUwAwEB/zANBgkqhkiG9w0BAQsFAAOCAQEAm00D
+jOW/wg/QXlR3vyL79+QWiRwVKCLe81jBtH8YvOp644pXvU4KNzPxum+acfMZNgGX
+TDSo9+K2jsJUddTdaMwX1XkY/HsYRgXtLF0y6O/2N+iqOyfeWg768G3KHoKruDk8
+pUMe4hxkCHMStOhgxlVTpBmX1vGejkLncFLXZR2sfu8pXoNDwpy4VygEgl7f6WAO
+aa0OM3xLX+U5P2aH8WRH4GDbfAqO2zYC1wzoguJIvYGgfcPL1mF+gjzSRAWr2Ia6
+qNZXOL6Tf3WURblbyGx0H0RadRmK90W5GX2y/wqkBNHmhlizljammeNuiOWIQQWU
+HDDjrvTD8qw+qNNMKw==
 -----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"
+  }
+}