powerbi-visuals-tools 6.1.3 → 7.0.0

package/lib/ConsoleWriter.js

@@ -1,188 +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";
-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(args);
-}
-export default class ConsoleWriter {
-    /** Causes the terminal to beep */
-    static beep() {
-        process.stdout.write("\x07");
-    }
-    /** Outputs a blank line */
-    static blank() {
-        console.info(preferredChalk.reset(' '));
-    }
-    /**
-     * Outputs arguments with the "done" tag / colors
-     *
-     * @param {array} arguments - arguments passed through to console.info
-     */
-    static done(args) {
-        const tag = preferredChalk.bgGreen(' done  ');
-        console.info.apply(this, prependLogTag(tag, args));
-    }
-    /**
-     * Outputs arguments with the "info" tag / colors
-     *
-     * @param {array} args - arguments passed through to console.info
-     */
-    static info(args) {
-        const tag = preferredChalk.bgCyan(' info  ');
-        console.info.apply(this, prependLogTag(tag, args));
-    }
-    /**
-     * Outputs arguments with the "warn" tag / colors
-     *
-     * @param {array} args - arguments passed through to console.warn
-     */
-    static warning(args) {
-        const tag = preferredChalk.bgYellow.black(' warn  ');
-        console.warn.apply(this, prependLogTag(tag, args));
-    }
-    /**
-     * Outputs arguments with the "error" tag / colors
-     *
-     * @param {array} args - arguments passed through to console.error
-     */
-    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
-     */
-    static infoTable(data, depthLimit, keyPrefix) {
-        if (!data) {
-            return;
-        }
-        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 {
-                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) {
-        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) {
-        if (errors && Array.isArray(errors)) {
-            errors.forEach((error) => {
-                if (!error) {
-                    return;
-                }
-                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]);
-        }
-    }
-    /**
-     * Outputs ascii art of the PowerBI logo
-     */
-    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
-        const filterChecks = (attrCB, propCB) => {
-            for (const checkname in log) {
-                if (checkname !== 'valid') {
-                    const checkpoint = log[checkname];
-                    ConsoleWriter[checkpoint.error.length ? 'info' : 'done'](checkpoint.check);
-                    attrCB(checkpoint, propCB);
-                }
-            }
-        };
-        // error/message/ok
-        const filterCheckAttrs = (checkpoint, propCB) => {
-            for (const propName in checkpoint) {
-                if (propName !== 'message') {
-                    const prop = checkpoint[propName];
-                    if (typeof (prop) === 'object' && prop.length) {
-                        propCB(prop, propName);
-                    }
-                }
-            }
-        };
-        // col/line/text
-        const filterAttrProps = (props, propName) => {
-            props.forEach((opt) => {
-                const result = [];
-                for (const key in opt) {
-                    result.push(opt[key]);
-                }
-                if (result.length) {
-                    ConsoleWriter[propName === 'error' ? 'error' : 'warn'](result.join(' --> '));
-                }
-            });
-        };
-        filterChecks(filterCheckAttrs, filterAttrProps);
-        const type = log.valid ? 'done' : 'error';
-        const text = log.valid ? 'Valid package' : 'Invalid package';
-        ConsoleWriter.blank();
-        ConsoleWriter[type](text);
-    }
-}

package/lib/FeatureManager.js

@@ -1,43 +0,0 @@
-import { Severity } from "./features/FeatureTypes.js";
-import * as features from "./features/index.js";
-export var Status;
-(function (Status) {
-    Status[Status["Success"] = 0] = "Success";
-    Status[Status["Error"] = 1] = "Error";
-})(Status || (Status = {}));
-export class FeatureManager {
-    features = Object.keys(features).map(key => features[key]);
-    validate(stage, sourceInstance) {
-        const result = {
-            status: Status.Success,
-            logs: {
-                errors: [],
-                warnings: [],
-                info: [],
-                deprecation: []
-            }
-        };
-        this.features
-            .filter(feature => feature.stage == stage)
-            .filter(feature => feature.visualFeatureType & sourceInstance.visualFeatureType)
-            .filter(feature => !feature.isSupported(sourceInstance))
-            .forEach(({ errorMessage, severity }) => {
-            switch (severity) {
-                case Severity.Error:
-                    result.status = Status.Error;
-                    result.logs.errors.push(errorMessage);
-                    break;
-                case Severity.Warning:
-                    result.logs.warnings.push(errorMessage);
-                    break;
-                case Severity.Info:
-                    result.logs.info.push(errorMessage);
-                    break;
-                case Severity.Deprecation:
-                    result.logs.deprecation.push(errorMessage);
-                    break;
-            }
-        });
-        return result;
-    }
-}

package/lib/LintValidator.js

@@ -1,61 +0,0 @@
-import { ESLint } from "eslint";
-import powerbiPlugin from 'eslint-plugin-powerbi-visuals';
-import ConsoleWriter from "./ConsoleWriter.js";
-import { getRootPath } from "./utils.js";
-export class LintValidator {
-    visualPath;
-    rootPath;
-    isVerboseMode;
-    shouldFix;
-    config;
-    linterInstance;
-    constructor({ verbose, fix }) {
-        this.visualPath = process.cwd();
-        this.rootPath = getRootPath();
-        this.isVerboseMode = verbose;
-        this.shouldFix = fix;
-        this.prepareConfig();
-        this.linterInstance = new ESLint(this.config);
-    }
-    /**
-     * Runs lint validation in the visual folder
-     */
-    async runLintValidation() {
-        ConsoleWriter.info("Running lint check...");
-        // By default it will lint all files in the src of current working directory
-        const results = await this.linterInstance.lintFiles("src/");
-        if (this.shouldFix) {
-            await this.fixErrors(results);
-        }
-        await this.outputResults(results);
-        ConsoleWriter.info("Lint check completed.");
-    }
-    async fixErrors(results) {
-        ConsoleWriter.info("Lint fixing errors...");
-        await ESLint.outputFixes(results);
-    }
-    async outputResults(results) {
-        if (this.isVerboseMode) {
-            const formatter = await this.linterInstance.loadFormatter("stylish");
-            const formattedResults = await formatter.format(results);
-            console.log(formattedResults);
-        }
-        else {
-            const filteredResults = ESLint.getErrorResults(results);
-            // get total amount of errors and warnings in all elements of filteredResults
-            const totalErrors = filteredResults.reduce((acc, curr) => acc + curr.errorCount, 0);
-            const totalWarnings = filteredResults.reduce((acc, curr) => acc + curr.warningCount, 0);
-            if (totalErrors > 0 || totalWarnings > 0) {
-                ConsoleWriter.error(`Linter found ${totalErrors} errors and ${totalWarnings} warnings. Run with --verbose flag to see details.`);
-            }
-        }
-    }
-    prepareConfig() {
-        ConsoleWriter.warning("Using recommended eslint config.");
-        this.config = {
-            overrideConfig: powerbiPlugin.configs.recommended,
-            overrideConfigFile: true,
-            fix: this.shouldFix,
-        };
-    }
-}

package/lib/Package.js

@@ -1,46 +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";
-import isMatch from "lodash.ismatch";
-/**
- * Represents an instance of a visual package based on file path
- */
-export default class Package {
-    sourceCode;
-    capabilities;
-    visualFeatureType;
-    constructor(sourceCode, capabilities, visualFeatureType) {
-        this.sourceCode = sourceCode;
-        this.capabilities = capabilities;
-        this.visualFeatureType = visualFeatureType;
-    }
-    contain(keyword) {
-        return this.sourceCode.includes(keyword);
-    }
-    isCapabilityEnabled(expectedObject) {
-        return isMatch(this.capabilities, expectedObject);
-    }
-}

package/lib/TemplateFetcher.js

@@ -1,111 +0,0 @@
-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 = await 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() {
-        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))
-            .then(this.setVisualGUID.bind(this))
-            .then(this.setApiVersion.bind(this))
-            .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.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 {
-                // write files into dirs                       for exclude parent folder
-                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;
-        }
-        ConsoleWriter.info(`Set Visual API to ${this.apiVersion}`);
-        const packageJsonFile = path.join(process.cwd(), this.folderName, "package.json");
-        const packageJson = await fs.readJson(packageJsonFile);
-        if (packageJson.devDependencies && packageJson.devDependencies["powerbi-visuals-api"]) {
-            packageJson.devDependencies["powerbi-visuals-api"] = `~${this.apiVersion}`;
-        }
-        if (packageJson.dependencies && packageJson.dependencies["powerbi-visuals-api"]) {
-            packageJson.dependencies["powerbi-visuals-api"] = `~${this.apiVersion}`;
-        }
-        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...");
-            process.chdir(this.folderName);
-            // const { stdout, stderr } = await exec('ls');
-            const child = exec('npm install', (error, stdout, stderr) => {
-                if (error) {
-                    ConsoleWriter.error(error.stack);
-                    ConsoleWriter.error(`Error code: ${error.code}`);
-                    ConsoleWriter.error(`Signal received: ${error.signal}`);
-                }
-                ConsoleWriter.warning(stderr);
-                ConsoleWriter.info(stdout);
-                resolve(true);
-            });
-            child.on("error", (er) => {
-                ConsoleWriter.error(er);
-                reject();
-            });
-            child.on("exit", (code) => {
-                if (code !== 0) {
-                    ConsoleWriter.error(`npm install stopped with code ${code}`);
-                    reject();
-                }
-            });
-        });
-    }
-    showNextSteps() {
-        ConsoleWriter.blank();
-        ConsoleWriter.info("Run `npm run start` to start visual development");
-        ConsoleWriter.info("Run `npm run package` to create visual package");
-    }
-}

package/lib/Visual.js

@@ -1,29 +0,0 @@
-import { compareVersions } from "compare-versions";
-import { VisualFeatureType } from "./features/FeatureTypes.js";
-export class Visual {
-    visualFeatureType;
-    capabilities;
-    config;
-    visualVersion;
-    constructor(capabilities, config) {
-        this.capabilities = capabilities;
-        this.config = config;
-        this.visualFeatureType = this.getVisualFeatureType();
-        this.visualVersion = config.visual.version;
-    }
-    doesAPIVersionMatch(minAPIversion) {
-        return compareVersions(this.config.apiVersion ?? minAPIversion, minAPIversion) !== -1;
-    }
-    isVisualVersionValid(length) {
-        return this.visualVersion.split(".").length === length;
-    }
-    getVisualFeatureType() {
-        const isMatrixSupported = this.capabilities?.dataViewMappings?.some(dataView => dataView.matrix);
-        const isSlicer = Boolean(this.capabilities?.objects?.general?.properties?.filter?.type?.filter);
-        let type = isSlicer ? VisualFeatureType.Slicer : VisualFeatureType.NonSlicer;
-        if (isMatrixSupported) {
-            type = type | VisualFeatureType.Matrix;
-        }
-        return type;
-    }
-}