powerbi-visuals-tools 4.3.2 → 5.0.0

package/lib/ConsoleWriter.js

@@ -23,76 +23,64 @@
  *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  *  THE SOFTWARE.
  */
-
 "use strict";
-
-let chalk = require('chalk');
-let fs = require('fs');
-let path = require('path');
-let os = require('os');
-
-if (os.platform() === 'darwin') {
-    chalk = chalk.bold;
-}
-
+import chalk from 'chalk';
+import fs from 'fs';
+import os from 'os';
+import path from 'path';
+import { getRootPath } from './utils.js';
+const preferredChalk = os.platform() === 'darwin' ? chalk.bold : chalk;
 function prependLogTag(tag, args) {
-    return [tag].concat(Array.from(args));
+    return [tag].concat(args);
 }
-
-class ConsoleWriter {
+export default class ConsoleWriter {
     /** Causes the terminal to beep */
     static beep() {
         process.stdout.write("\x07");
     }
-
     /** Outputs a blank line */
     static blank() {
-        console.info(chalk.reset(' '));
+        console.info(preferredChalk.reset(' '));
     }
-
     /**
      * Outputs arguments with the "done" tag / colors
-     * 
-     * @param {...*} arguments - arguments passed through to console.info
+     *
+     * @param {array} arguments - arguments passed through to console.info
      */
-    static done(/* arguments */) {
-        let tag = chalk.bgGreen(' done  ');
-        console.info.apply(this, prependLogTag(tag, arguments));
+    static done(args) {
+        const tag = preferredChalk.bgGreen(' done  ');
+        console.info.apply(this, prependLogTag(tag, args));
     }
-
     /**
      * Outputs arguments with the "info" tag / colors
-     * 
-     * @param {...*} arguments - arguments passed through to console.info
+     *
+     * @param {array} args - arguments passed through to console.info
      */
-    static info(/* arguments */) {
-        let tag = chalk.bgCyan(' info  ');
-        console.info.apply(this, prependLogTag(tag, arguments));
+    static info(args) {
+        const tag = preferredChalk.bgCyan(' info  ');
+        console.info.apply(this, prependLogTag(tag, args));
     }
-
     /**
      * Outputs arguments with the "warn" tag / colors
-     * 
-     * @param {...*} arguments - arguments passed through to console.warn
+     *
+     * @param {array} args - arguments passed through to console.warn
      */
-    static warn(/* arguments */) {
-        let tag = chalk.bgYellow.black(' warn  ');
-        console.warn.apply(this, prependLogTag(tag, arguments));
+    static warning(args) {
+        const tag = preferredChalk.bgYellow.black(' warn  ');
+        console.warn.apply(this, prependLogTag(tag, args));
     }
-
     /**
      * Outputs arguments with the "error" tag / colors
-     * 
-     * @param {...*} arguments - arguments passed through to console.error
+     *
+     * @param {array} args - arguments passed through to console.error
      */
-    static error(/* arguments */) {
-        let tag = chalk.bgRed(' error ');
-        console.error.apply(this, prependLogTag(tag, arguments));
+    static error(args) {
+        const tag = preferredChalk.bgRed(' error ');
+        console.error.apply(this, prependLogTag(tag, args));
     }
-
     /**
      * Outputs an object as a table
-     * 
+     *
      * @param {string} data - object to output
      * @param {number} [depthLimit=Infinity] - limit the number of levels to recurse
      * @param {string} [keyPrefix=''] - text to prepend to each key
@@ -101,35 +89,34 @@ class ConsoleWriter {
         if (!data) {
             return;
         }
-        let limit = typeof depthLimit === 'undefined' ? Infinity : depthLimit;
-        for (let key in data) {
-            let item = data[key];
-            let itemKey = (keyPrefix || '') + key;
+        const limit = typeof depthLimit === 'undefined' ? Infinity : depthLimit;
+        for (const key in data) {
+            const item = data[key];
+            const itemKey = (keyPrefix || '') + key;
             if (limit > 1 && typeof item === 'object' && !Array.isArray(item)) {
                 ConsoleWriter.infoTable(item, limit - 1, itemKey + '.');
-            } else {
+            }
+            else {
                 ConsoleWriter.infoTableRow(itemKey, item);
             }
         }
     }
-
     /**
      * Outputs a table row with even spaced keys
-     * 
+     *
      * @param {string} key - title of this row
      * @param {string} value - value for this row
      * @param {number} [keyWidth=30] - width used for padding of the key column
      */
     static infoTableRow(key, value, keyWidth) {
-        let width = keyWidth || 30;
-        let padding = Math.max(0, width - key.length);
-        let paddedKey = chalk.bold(key) + (new Array(padding)).join('.');
-        ConsoleWriter.info(paddedKey, value);
+        const width = keyWidth || 30;
+        const padding = Math.max(0, width - key.length);
+        const paddedKey = preferredChalk.bold(key) + (new Array(padding)).join('.');
+        ConsoleWriter.info([paddedKey, value]);
     }
-
     /**
      * Outputs formatted errors
-     * 
+     *
      * @param {Array<Error>} errors
      */
     static formattedErrors(errors) {
@@ -138,58 +125,53 @@ class ConsoleWriter {
                 if (!error) {
                     return;
                 }
-                let tag = error.type ? chalk.bold(error.type.toUpperCase()) : 'UNKNOWN';
-                let file = error.filename ? chalk.bgWhite.black(` ${error.filename} `) + ':' : '';
-                let position = (error.line && error.column) ? chalk.cyan(`(${error.line},${error.column})`) : '';
-                let message = error.message || '';
-                ConsoleWriter.error(tag, `${file} ${position} ${message}`);
+                const tag = error.type ? preferredChalk.bold(error.type.toUpperCase()) : 'UNKNOWN';
+                const file = error.filename ? preferredChalk.bgWhite.black(` ${error.filename} `) + ':' : '';
+                const position = (error.line && error.column) ? preferredChalk.cyan(`(${error.line},${error.column})`) : '';
+                const message = error.message || '';
+                ConsoleWriter.error([tag, `${file} ${position} ${message}`]);
             });
-        } else {
-            ConsoleWriter.error('UNKNOWN', errors);
+        }
+        else {
+            ConsoleWriter.error(['UNKNOWN', errors]);
         }
     }
-
     /**
      * Outputs ascii art of the PowerBI logo
      */
-    static logo() {
-        let logoText = fs.readFileSync(path.join(__dirname, '..', 'assets', 'logo.txt')).toString();
-        console.info(chalk.bold.yellow(logoText));
+    static getLogoVisualization() {
+        return fs.readFileSync(path.join(getRootPath(), 'assets', 'logo.txt')).toString();
     }
-
     /**
      * Outputs validation log from PBIVIZ package checking
      */
     static validationLog(log) {
-
         // api/js/css/pkg
-        let filterChecks = (attrCB, propCB) => {
-            for (let checkname in log) {
+        const filterChecks = (attrCB, propCB) => {
+            for (const checkname in log) {
                 if (checkname !== 'valid') {
-                    let checkpoint = log[checkname];
+                    const checkpoint = log[checkname];
                     ConsoleWriter[checkpoint.error.length ? 'info' : 'done'](checkpoint.check);
                     attrCB(checkpoint, propCB);
                 }
             }
         };
-
         // error/message/ok
-        let filterCheckAttrs = (checkpoint, propCB) => {
-            for (let propName in checkpoint) {
+        const filterCheckAttrs = (checkpoint, propCB) => {
+            for (const propName in checkpoint) {
                 if (propName !== 'message') {
-                    let prop = checkpoint[propName];
+                    const prop = checkpoint[propName];
                     if (typeof (prop) === 'object' && prop.length) {
                         propCB(prop, propName);
                     }
                 }
             }
         };
-
         // col/line/text
-        let filterAttrProps = (props, propName) => {
+        const filterAttrProps = (props, propName) => {
             props.forEach((opt) => {
-                let result = [];
-                for (let key in opt) {
+                const result = [];
+                for (const key in opt) {
                     result.push(opt[key]);
                 }
                 if (result.length) {
@@ -197,14 +179,10 @@ class ConsoleWriter {
                 }
             });
         };
-
         filterChecks(filterCheckAttrs, filterAttrProps);
-
-        let type = log.valid ? 'done' : 'error';
-        let text = log.valid ? 'Valid package' : 'Invalid package';
+        const type = log.valid ? 'done' : 'error';
+        const text = log.valid ? 'Valid package' : 'Invalid package';
         ConsoleWriter.blank();
         ConsoleWriter[type](text);
     }
 }
-
-module.exports = ConsoleWriter;

package/lib/TemplateFetcher.js

@@ -1,23 +1,24 @@
-const fs = require('fs-extra');
-const path = require('path');
-const config = require('../config.json');
-const JSZip = require('jszip');
-const VisualGenerator = require("./VisualGenerator");
-const { exec } = require('child_process');
-const ConsoleWriter = require('../lib/ConsoleWriter');
-const download = require('./utils').download;
-const createFolder = require('./utils').createFolder;
-
-class TemplateFetcher {
-    constructor({ templateName, visualName, apiVersion }) {
+import { createFolder, download, readJsonFromRoot } from './utils.js';
+import ConsoleWriter from './ConsoleWriter.js';
+import JSZip from 'jszip';
+import VisualGenerator from "./VisualGenerator.js";
+import { exec } from 'child_process';
+import fs from 'fs-extra';
+import path from 'path';
+const config = readJsonFromRoot('config.json');
+export default class TemplateFetcher {
+    templateName;
+    visualName;
+    folderName;
+    apiVersion;
+    constructor(templateName, visualName, apiVersion) {
         this.templateName = templateName;
         this.visualName = visualName;
         this.folderName = `${this.visualName}`;
         this.apiVersion = apiVersion;
     }
-
     fetch() {
-        let folder = createFolder.call(this, this.folderName);
+        const folder = createFolder.call(this, this.folderName);
         download.call(this, config.visualTemplates[this.templateName], path.join(folder, "template.zip"))
             .then(this.extractFiles.bind(this))
             .then(this.removeZipFile.bind(this))
@@ -26,37 +27,34 @@ class TemplateFetcher {
             .then(this.runNpmInstall.bind(this))
             .then(this.showNextSteps.bind(this));
     }
-
     async removeZipFile() {
         const folder = path.join("./", this.folderName);
         const fileName = path.join(folder, "template.zip");
         await fs.unlink(`.${path.sep}${fileName}`, (err) => {
             if (err) {
-                ConsoleWriter.warn(`.${path.sep}${fileName} was not deleted`);
+                ConsoleWriter.warning(`.${path.sep}${fileName} was not deleted`);
             }
         });
     }
-
     async extractFiles(file) {
         const filePath = path.join(process.cwd(), file.path);
         const buffer = await fs.readFile(filePath);
         const zip = await JSZip.loadAsync(buffer);
-
         const filesList = Object.keys(zip.files);
         for (const filename of filesList) {
             if (filename[filename.length - 1] === "/") {
                 // generate folders                            for exclude parent folder
                 const dest = path.join(path.dirname(filePath), path.join(filename, ".."));
                 await fs.ensureDir(dest);
-            } else {
+            }
+            else {
                 // write files into dirs                       for exclude parent folder
-                const dest = path.join(path.dirname(filePath), path.join(path.dirname(filename), "..", filename.split("/").pop(0)));
-                const content = await zip.file(filename).async('nodebuffer');
+                const dest = path.join(path.dirname(filePath), path.join(path.dirname(filename), "..", filename.split("/").pop() ?? ""));
+                const content = await zip.file(filename)?.async('nodebuffer');
                 await fs.writeFile(dest, content);
             }
         }
     }
-
     async setApiVersion() {
         if (!this.apiVersion) {
             return;
@@ -72,14 +70,12 @@ class TemplateFetcher {
         }
         await fs.writeJSON(packageJsonFile, packageJson);
     }
-
     async setVisualGUID() {
         const pbivizJsonFile = path.join(process.cwd(), this.folderName, "pbiviz.json");
         const pbivizJson = await fs.readJson(pbivizJsonFile);
         pbivizJson.visual.guid = this.visualName + VisualGenerator.generateVisualGuid();
         await fs.writeJSON(pbivizJsonFile, pbivizJson);
     }
-
     runNpmInstall() {
         return new Promise((resolve, reject) => {
             ConsoleWriter.info("Installing packages...");
@@ -91,12 +87,12 @@ class TemplateFetcher {
                     ConsoleWriter.error(`Error code: ${error.code}`);
                     ConsoleWriter.error(`Signal received: ${error.signal}`);
                 }
-                ConsoleWriter.warn(stderr);
+                ConsoleWriter.warning(stderr);
                 ConsoleWriter.info(stdout);
-                resolve();
+                resolve(true);
             });
             child.on("error", (er) => {
-                ConsoleWriter.log(er);
+                ConsoleWriter.error(er);
                 reject();
             });
             child.on("exit", (code) => {
@@ -107,12 +103,9 @@ class TemplateFetcher {
             });
         });
     }
-
     showNextSteps() {
         ConsoleWriter.blank();
         ConsoleWriter.info("Run `npm run start` to start visual development");
         ConsoleWriter.info("Run `npm run package` to create visual package");
     }
 }
-
-module.exports = TemplateFetcher;

package/lib/VisualGenerator.js

@@ -23,21 +23,18 @@
  *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  *  THE SOFTWARE.
  */
-
 "use strict";
-
-const fs = require('fs-extra');
-const path = require('path');
-const uuid = require('uuid');
-const compareVersions = require("compare-versions");
-const config = require('../config.json');
-const lodashDefaults = require('lodash.defaults');
-const template = require('../templates/pbiviz-json-template');
-
-const VISUAL_TEMPLATES_PATH = path.join(__dirname, '..', config.templates.visuals);
+import crypto from 'crypto';
+import { getRootPath, readJsonFromRoot } from './utils.js';
+import { compareVersions } from "compare-versions";
+import fs from 'fs-extra';
+import lodashDefaults from 'lodash.defaults';
+import path from 'path';
+import template from '../templates/pbiviz-json-template.js';
+const config = readJsonFromRoot('config.json');
+const VISUAL_TEMPLATES_PATH = path.join(getRootPath(), config.templates.visuals);
 const API_VERSION = config.generate.apiVersion;
 const minAPIversion = config.constants.minAPIversion;
-
 /**
  * Generates the data for the visual
  */
@@ -51,9 +48,8 @@ function generateVisualOptions(visualName, apiVersion) {
         apiVersion: apiVersion
     };
 }
-
 /**
- * 
+ *
  */
 function generateVisualName(displayName) {
     return displayName.replace(/(?:^\w|[A-Z]|\b\w|_|\s+)/g, (match, index) => {
@@ -63,58 +59,51 @@ function generateVisualName(displayName) {
         return index === 0 ? match.toLowerCase() : match.toUpperCase();
     });
 }
-
 /**
  * Creates a default pbiviz.json config file
- * 
+ *
  * @param {string} visualPath - path to the visual
  * @param {Object} options - visual information for populating the pbiviz.json template
  * @param {string} templateName - external js files
  */
 function createPbiVizJson(visualPath, options, templateName) {
-
     // read the global template data
     // and generate the actual file content
     let data = template(options);
-
     // write out the target file content
-    let targetPath = path.join(visualPath, 'pbiviz.json');
+    const targetPath = path.join(visualPath, 'pbiviz.json');
     fs.writeFileSync(targetPath, data);
-
     let templatePath = path.join(VISUAL_TEMPLATES_PATH, templateName);
     templatePath = path.join(templatePath, 'pbiviz.json');
     if (templateName && fileExists(templatePath)) {
         //read the target file content 
         data = fs.readJsonSync(targetPath);
-
         //override externalJS settings with those of the local template file
-        let templateData = fs.readJsonSync(templatePath);
+        const templateData = fs.readJsonSync(templatePath);
         for (const objKey of Object.keys(templateData)) {
             data[objKey] = templateData[objKey];
         }
-
         // write out the target file content
         fs.writeJsonSync(targetPath, data);
     }
 }
-
 /**
  * Checks if the specified file exists
- * 
- * @param {string} file - path to the file 
+ *
+ * @param {string} file - path to the file
  */
 function fileExists(file) {
     try {
         fs.accessSync(file);
-    } catch (e) {
+    }
+    catch (e) {
         return false;
     }
     return true;
 }
-
 /**
  * Copies the visual template directory
- * 
+ *
  * @param {string} targetPath - file path to root of visual package
  * @param {string} templateName - template to use for generating the visual
  */
@@ -122,54 +111,50 @@ function copyVisualTemplate(targetPath, templateName) {
     fs.copySync(path.join(VISUAL_TEMPLATES_PATH, '_global'), targetPath);
     fs.copySync(path.join(VISUAL_TEMPLATES_PATH, templateName), targetPath);
 }
-
 /**
  * Checks if the specified template is valid
- * 
+ *
  * @param {string} templateName - template to use for generating the visual
  */
 function validTemplate(templateName) {
     try {
         fs.accessSync(path.join(VISUAL_TEMPLATES_PATH, templateName));
-    } catch (e) {
+    }
+    catch (e) {
         return false;
     }
     return true;
 }
-
 const defaultOptions = {
     force: false,
     template: 'default',
     apiVersion: API_VERSION,
     externalJS: []
 };
-
-class VisualGenerator {
+export default class VisualGenerator {
     /**
      * Generates a new visual
-     * 
+     *
      * @param {string} targetPath - file path for creation of the new visual package
      * @param {string} visualName - name of the new visual package
      * @param {object} options - specify options for the visual generator
-     * @returns {Promise<string>} - promise resolves with the path to the newly created package 
+     * @returns {Promise<string>} - promise resolves with the path to the newly created package
      */
-    static generate(targetPath, visualName, options) {
+    static generateVisual(targetPath, visualName, options) {
         return new Promise((resolve, reject) => {
-            let buildOptions = lodashDefaults(options, defaultOptions);
-            if (!buildOptions.apiVersion || compareVersions.compare(buildOptions.apiVersion, minAPIversion, "<")) {
+            const buildOptions = lodashDefaults(options, defaultOptions);
+            if (!buildOptions.apiVersion || compareVersions(buildOptions.apiVersion, minAPIversion) === -1) {
                 return reject(new Error(`Can not generate a visual with an API below than ${minAPIversion}, current API is '${buildOptions.apiVersion}'.`));
             }
-            let visualOptions = generateVisualOptions(visualName, buildOptions.apiVersion);
+            const visualOptions = generateVisualOptions(visualName, buildOptions.apiVersion);
             const validationResult = VisualGenerator.checkVisualName(visualOptions.name);
             if (!visualOptions || !visualOptions.name || validationResult) {
                 return reject(new Error(validationResult || "Invalid visual name"));
             }
-
             if (!validTemplate(buildOptions.template)) {
-                return reject(new Error('Invalid template'));
+                return reject(new Error(`Invalid template "${buildOptions.template}"`));
             }
-
-            let visualPath = path.join(targetPath, visualOptions.name);
+            const visualPath = path.join(targetPath, visualOptions.name);
             fs.access(visualPath, err => {
                 if (!err && !buildOptions.force) {
                     return reject(new Error('This visual already exists. Use force to overwrite.'));
@@ -181,28 +166,27 @@ class VisualGenerator {
                     copyVisualTemplate(visualPath, buildOptions.template);
                     createPbiVizJson(visualPath, visualOptions, options.template);
                     resolve(visualPath);
-                } catch (e) {
+                }
+                catch (e) {
                     reject(e);
                 }
             });
         });
     }
-
     /**
      * Generates a random GUID for your visual
      */
     static generateVisualGuid() {
-        return uuid.v4().replace(/-/g, '').toUpperCase();
+        return crypto.randomUUID().replace(/-/g, '').toUpperCase();
     }
-
     /**
-     * Check visual name 
+     * Check visual name
      * Using https://github.com/mathiasbynens/mothereff.in/tree/master/js-properties
-     * 
+     *
      * @static
      * @param {string} name Visual name
      * @returns {string} error message
-     * 
+     *
      * @memberof VisualGenerator
      */
     static checkVisualName(name) {
@@ -222,14 +206,16 @@ class VisualGenerator {
         });
         if (regexNumber.test(name)) {
             return `The visual name can't begin with a number digit`;
-        } else if (!regexpWrongSymbols.test(name)) {
+        }
+        else if (!regexpWrongSymbols.test(name)) {
             return `The visual name can contain only letters and numbers`;
-        } else if (regexES3ReservedWord.test(valueAsUnescapedString)) {
+        }
+        else if (regexES3ReservedWord.test(valueAsUnescapedString)) {
             return `The visual name cannot be equal to a reserved JavaScript keyword.
                 More information: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Lexical_grammar#Keywords`;
-        } else if (regexZeroWidth.test(valueAsUnescapedString)) {
+        }
+        else if (regexZeroWidth.test(valueAsUnescapedString)) {
             return `The visual name can't be empty`;
         }
     }
 }
-module.exports = VisualGenerator;