powerbi-visuals-tools 4.3.2 → 5.0.0

package/bin/pbiviz-package.js

@@ -1,122 +0,0 @@
-/*
- *  Power BI Visual CLI
- *
- *  Copyright (c) Microsoft Corporation
- *  All rights reserved.
- *  MIT License
- *
- *  Permission is hereby granted, free of charge, to any person obtaining a copy
- *  of this software and associated documentation files (the ""Software""), to deal
- *  in the Software without restriction, including without limitation the rights
- *  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- *  copies of the Software, and to permit persons to whom the Software is
- *  furnished to do so, subject to the following conditions:
- *
- *  The above copyright notice and this permission notice shall be included in
- *  all copies or substantial portions of the Software.
- *
- *  THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- *  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- *  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
- *  THE SOFTWARE.
- */
-
-"use strict";
-
-const program = require('commander');
-const compareVersions = require("compare-versions");
-const webpack = require("webpack");
-
-const config = require('../config.json');
-const VisualPackage = require('../lib/VisualPackage');
-const ConsoleWriter = require('../lib/ConsoleWriter');
-const WebPackWrap = require('../lib/WebPackWrap');
-const CommandHelpManager = require('../lib/CommandHelpManager');
-
-let options = process.argv;
-const minAPIversion = config.constants.minAPIversion;
-
-program
-    .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-plugin', "Doesn't include a plugin declaration to the package (must be used in conjunction with --no-pbiviz and --resources flags)")
-    .option('--no-stats', "Doesn't generate statistics files")
-    .option('-c, --compression <compressionLevel>', "Enables compression of visual package", /^(0|1|2|3|4|5|6|7|8|9)$/i, "6");
-
-if (options.some(option => option === '--help' || option === '-h')) {
-    program.help(CommandHelpManager.createSubCommandHelpCallback(options));
-    process.exit(0);
-}
-
-program.parse(options);
-
-let cwd = process.cwd();
-
-if (!program.pbiviz && !program.resources) {
-    ConsoleWriter.error('Nothing to build. Cannot use --no-pbiviz without --resources');
-    process.exit(1);
-}
-
-VisualPackage.loadVisualPackage(cwd).then((visualPackage) => {
-    if (visualPackage.config.apiVersion && compareVersions.compare(visualPackage.config.apiVersion, minAPIversion, "<")) {
-        ConsoleWriter.error(`Package wasn't created, your current API is '${visualPackage.config.apiVersion}'.
-        Please use 'powerbi-visuals-api' ${minAPIversion} or above to build a visual.`);
-        process.exit(9);
-    }
-    ConsoleWriter.info('Building visual...');
-
-    new WebPackWrap().applyWebpackConfig(visualPackage, {
-        devMode: false,
-        generateResources: program.resources,
-        generatePbiviz: program.pbiviz,
-        minifyJS: program.minify,
-        minify: program.minify,
-        compression: program.compression, 
-        disableStats: !program.stats
-    }).then(({ webpackConfig }) => {
-        let compiler = webpack(webpackConfig);
-        compiler.run(function (err, stats) {
-            if (err) {
-                ConsoleWriter.error(`Package wasn't created. ${JSON.stringify(err)}`);
-            }
-            if (stats.compilation.errors.length) {
-                ConsoleWriter.error(`Package wasn't created. ${stats.compilation.errors.length} errors found`);
-            }
-            displayCertificationRules();
-            process.exit(0);
-        });
-    }).catch(e => {
-        ConsoleWriter.error(e.message);
-        process.exit(1);
-    });
-}).catch(e => {
-    ConsoleWriter.error('LOAD ERROR', e);
-    process.exit(1);
-});
-
-function displayCertificationRules() {
-    ConsoleWriter.blank();
-    ConsoleWriter.warn("Please, make sure that the visual source code matches to requirements of certification:");
-    ConsoleWriter.blank();
-    ConsoleWriter.info(`Visual must use API v${minAPIversion} and above`);
-    ConsoleWriter.info("The project repository must:");
-    ConsoleWriter.info("Include package.json and package-lock.json;");
-    ConsoleWriter.info("Not include node_modules folder");
-    ConsoleWriter.info("Run npm install expect no errors");
-    ConsoleWriter.info("Run pbiviz package expect no errors");
-    ConsoleWriter.info("The compiled package of the Custom Visual should match submitted package.");
-    ConsoleWriter.info("npm audit command must not return any alerts with high or moderate level.");
-    ConsoleWriter.info("The project must include Tslint from Microsoft with no overridden configuration, and this command shouldn’t return any tslint errors.");
-    ConsoleWriter.info("https://www.npmjs.com/package/tslint-microsoft-contrib");
-    ConsoleWriter.info("Ensure no arbitrary/dynamic code is run (bad: eval(), unsafe use of settimeout(), requestAnimationFrame(), setinterval(some function with user input).. running user input/data etc.)");
-    ConsoleWriter.info("Ensure DOM is manipulated safely (bad: innerHTML, D3.html(<some user/data input>), unsanitized user input/data directly added to DOM, etc.)");
-    ConsoleWriter.info("Ensure no js errors/exceptions in browser console for any input data. As test dataset please use this sample report");
-    ConsoleWriter.blank();
-    ConsoleWriter.info("Full description of certification requirements you can find in documentation:");
-    ConsoleWriter.info("https://docs.microsoft.com/en-us/power-bi/power-bi-custom-visuals-certified#certification-requirements");
-}
-

package/bin/pbiviz-start.js

@@ -1,142 +0,0 @@
-/*
- *  Power BI Visual CLI
- *
- *  Copyright (c) Microsoft Corporation
- *  All rights reserved.
- *  MIT License
- *
- *  Permission is hereby granted, free of charge, to any person obtaining a copy
- *  of this software and associated documentation files (the ""Software""), to deal
- *  in the Software without restriction, including without limitation the rights
- *  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- *  copies of the Software, and to permit persons to whom the Software is
- *  furnished to do so, subject to the following conditions:
- *
- *  The above copyright notice and this permission notice shall be included in
- *  all copies or substantial portions of the Software.
- *
- *  THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- *  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- *  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
- *  THE SOFTWARE.
- */
-
-"use strict";
-
-const program = require('commander');
-const compareVersions = require("compare-versions");
-const fs = require('fs-extra');
-const path = require('path');
-const webpack = require("webpack");
-
-const config = require('../config.json');
-const VisualPackage = require('../lib/VisualPackage');
-const WebpackDevServer = require("webpack-dev-server");
-const ConsoleWriter = require('../lib/ConsoleWriter');
-const WebPackWrap = require('../lib/WebPackWrap');
-const CommandHelpManager = require('../lib/CommandHelpManager');
-
-const options = process.argv;
-const minAPIversion = config.constants.minAPIversion;
-
-program
-    .option('-p, --port [port]', 'set the port listening on')
-    .option('-m, --mute', 'mute error outputs')
-    .option('-d, --drop', 'drop outputs into output folder')
-    .option('--no-stats', "Doesn't generate statistics files");
-
-if (options.some(option => option === '--help' || option === '-h')) {
-    program.help(CommandHelpManager.createSubCommandHelpCallback(options));
-    process.exit(0);
-}
-
-program.parse(options);
-
-let cwd = process.cwd();
-let server;
-VisualPackage.loadVisualPackage(cwd).then((visualPackage) => {
-    if (visualPackage.config.apiVersion && compareVersions.compare(visualPackage.config.apiVersion, minAPIversion, "<")) {
-        ConsoleWriter.error(`Can't start the visual because of the current API is '${visualPackage.config.apiVersion}'.
-        Please use 'powerbi-visuals-api' ${minAPIversion} or above to build a visual.`);
-        throw new Error(`Invalid API version.`);
-    }
-    new WebPackWrap().applyWebpackConfig(visualPackage, {
-        devMode: true,
-        devtool: "source-map",
-        generateResources: true,
-        generatePbiviz: false,
-        minifyJS: false,
-        minify: false,
-        devServerPort: program.port,
-        disableStats: !program.stats
-    })
-        .then(({ webpackConfig }) => {
-            let compiler = webpack(webpackConfig);
-            ConsoleWriter.blank();
-            ConsoleWriter.info('Starting server...');
-            // webpack dev server serves bundle from disk instead memory
-            if (program.drop) {
-                webpackConfig.devServer.onBeforeSetupMiddleware = (devServer) => {
-                    let setHeaders = (res) => {
-                        Object.getOwnPropertyNames(webpackConfig.devServer.headers)
-                            .forEach(property => res.header(property, webpackConfig.devServer.headers[property]));
-                    };
-                    let readFile = (file, res) => {
-                        fs.readFile(file).then(function (content) {
-                            res.write(content);
-                            res.end();
-                        });
-                    };
-                    [
-                        'visual.js`',
-                        'visual.css',
-                        'pbiviz.json'
-                    ].forEach(asset => {
-                        devServer.app.get(`${webpackConfig.devServer.publicPath}/${asset}`, function (req, res) {
-                            setHeaders(res);
-                            readFile(path.join(webpackConfig.devServer.static.directory, asset), res);
-                        });
-                    });
-                };
-            }
-
-            server = new WebpackDevServer({
-                ...webpackConfig.devServer,
-                client: false,
-                hot: false,
-                devMiddleware: {
-                    writeToDisk: true    
-                }
-            }, compiler);
-
-            (async () => {
-                await server.start();
-                ConsoleWriter.info(`Server listening on port ${webpackConfig.devServer.port}`);
-            })();
-
-        })
-        .catch(e => {
-            ConsoleWriter.error(e.message);
-            process.exit(1);
-        });
-}).catch(e => {
-    ConsoleWriter.error('LOAD ERROR', e);
-    process.exit(1);
-});
-
-//clean up
-function stopServer() {
-    ConsoleWriter.blank();
-    ConsoleWriter.info("Stopping server...");
-    if (server) {
-        server.close();
-        server = null;
-    }
-}
-
-process.on('SIGINT', stopServer);
-process.on('SIGTERM', stopServer);
-

package/lib/CommandHelpManager.js

@@ -1,51 +0,0 @@
-/*
- *  Power BI Visual CLI
- *
- *  Copyright (c) Microsoft Corporation
- *  All rights reserved.
- *  MIT License
- *
- *  Permission is hereby granted, free of charge, to any person obtaining a copy
- *  of this software and associated documentation files (the ""Software""), to deal
- *  in the Software without restriction, including without limitation the rights
- *  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- *  copies of the Software, and to permit persons to whom the Software is
- *  furnished to do so, subject to the following conditions:
- *
- *  The above copyright notice and this permission notice shall be included in
- *  all copies or substantial portions of the Software.
- *
- *  THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- *  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- *  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
- *  THE SOFTWARE.
- */
-
-"use strict";
-
-let path = require('path');
-let basename = path.basename;
-let targetString = "Usage:";
-
-class CommandHelpmanager {
-    static createSubCommandHelpCallback(options) {
-        return (txt) => {
-            let targetPosition = txt.indexOf(targetString);
-            let preparedHelp = "";
-            let subCommandName = basename(options[1], ".js").replace("-", " ");
-
-            if (targetPosition !== -1) {
-                targetPosition += targetString.length + 1; 
-                preparedHelp = [txt.slice(0, targetPosition), subCommandName, txt.slice(targetPosition)].join('');
-                return preparedHelp;
-            }
-
-            return txt;
-        };
-    }
-}
-
-module.exports = CommandHelpmanager;

package/lib/VisualPackage.js

@@ -1,118 +0,0 @@
-/*
- *  Power BI Visual CLI
- *
- *  Copyright (c) Microsoft Corporation
- *  All rights reserved.
- *  MIT License
- *
- *  Permission is hereby granted, free of charge, to any person obtaining a copy
- *  of this software and associated documentation files (the ""Software""), to deal
- *  in the Software without restriction, including without limitation the rights
- *  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- *  copies of the Software, and to permit persons to whom the Software is
- *  furnished to do so, subject to the following conditions:
- *
- *  The above copyright notice and this permission notice shall be included in
- *  all copies or substantial portions of the Software.
- *
- *  THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- *  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- *  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
- *  THE SOFTWARE.
- */
-
-"use strict";
-
-let fs = require('fs-extra');
-let path = require('path');
-let VisualGenerator = require('../lib/VisualGenerator');
-let childProcess = require('child_process');
-let ConsoleWriter = require('../lib/ConsoleWriter');
-
-const CONFIG_FILE = 'pbiviz.json';
-
-/**
- * Represents an instance of a visual package based on file path
- */
-class VisualPackage {
-    /**
-     * Creates a new visual package
-     * 
-     * @param {string} rootPath - file path to root of visual package
-     * @param {string} visualName - name of the visual to create in the rootPath
-     * @param {object} generateOptions - options for the visual generator
-     * <VisualPackage>} - instance of newly created visual package
-     */
-    static createVisualPackage(rootPath, visualName, generateOptions) {
-        return VisualGenerator.generate(rootPath, visualName, generateOptions)
-            .then((visualPath) => VisualPackage.installPackages(visualPath)
-                    .then(() => visualPath)
-            )
-            .then((visualPath) => VisualPackage.loadVisualPackage(visualPath));
-    }
-
-    /**
-     * Loads an instance of a visual package from a file path
-     * 
-     * @param {string} rootPath - file path to root of visual package
-     * @returns {Promise<VisualPackage>} - instance of newly created visual package
-     */
-    static loadVisualPackage(rootPath) {
-        return new Promise((resolve, reject) => {
-            try {
-                resolve(new VisualPackage(rootPath));
-            } catch (e) {
-                if (e && e.code && e.code === 'ENOENT') {
-                    return reject(new Error(CONFIG_FILE + ' not found. You must be in the root of a visual project to run this command.'));
-                }
-                reject(e);
-            }
-        });
-    }
-
-    /**
-     * Install npm dependencies for visual
-     * @param {string} rootPath - file path to root of visual package
-     * @static
-     * @returns {Promise<void>}
-     * @memberof VisualPackage
-     */
-    static installPackages(visualPath) {
-        return new Promise(function (resolve, reject) {
-            ConsoleWriter.info('Installing packages...');
-            childProcess.exec(`npm install`, { cwd: visualPath },
-                (err) => {
-                    if (err) {
-                        reject(new Error('Package install failed.'));
-                    } else {
-                        ConsoleWriter.info('Installed packages.');
-                        resolve();
-                    }
-                });
-        });
-    }
-
-    /**
-     * Creates a VisualPackage instance
-     * 
-     * @param {string} rootPath - file path to root of visual package
-     */
-    constructor(rootPath) {
-        this.basePath = rootPath;
-        this.config = fs.readJsonSync(this.buildPath(CONFIG_FILE));
-    }
-
-    /**
-     * Builds a path starting from the package base path
-     * 
-     * @param {...*} arguments - arguments passed through to path.join
-     */
-    buildPath() {
-        return path.join.apply(this, [this.basePath].concat(Array.from(arguments)));
-    }
-}
-
-module.exports = VisualPackage;

package/templates/visuals/default/tslint.json

@@ -1,9 +0,0 @@
-{
-    "extends": "tslint-microsoft-contrib/recommended",
-    "rulesDirectory": [
-        "node_modules/tslint-microsoft-contrib"
-    ],
-    "rules": {
-        "no-relative-imports": false
-    }
-}

package/templates/visuals/rhtml/tslint.json

@@ -1,9 +0,0 @@
-{
-    "extends": "tslint-microsoft-contrib/recommended",
-    "rulesDirectory": [
-        "node_modules/tslint-microsoft-contrib"
-    ],
-    "rules": {
-        "no-relative-imports": false
-    }
-}

package/templates/visuals/rvisual/tslint.json

@@ -1,9 +0,0 @@
-{
-    "extends": "tslint-microsoft-contrib/recommended",
-    "rulesDirectory": [
-        "node_modules/tslint-microsoft-contrib"
-    ],
-    "rules": {
-        "no-relative-imports": false
-    }
-}

package/templates/visuals/slicer/tslint.json

@@ -1,9 +0,0 @@
-{
-    "extends": "tslint-microsoft-contrib/recommended",
-    "rulesDirectory": [
-        "node_modules/tslint-microsoft-contrib"
-    ],
-    "rules": {
-        "no-relative-imports": false
-    }
-}

package/templates/visuals/table/tslint.json

@@ -1,9 +0,0 @@
-{
-    "extends": "tslint-microsoft-contrib/recommended",
-    "rulesDirectory": [
-        "node_modules/tslint-microsoft-contrib"
-    ],
-    "rules": {
-        "no-relative-imports": false
-    }
-}