powerbi-visuals-tools 5.6.0 → 6.0.0

package/Changelog.md

@@ -2,6 +2,11 @@
 
 This page contains information about changes to the PowerBI Visual Tools (pbiviz).
 
+## 6.0.0
+* **Introduced pbiviz.js support.** This feature allows generate configuration dynamically using benefits of JavaScript.
+  It allows you to easily use any js logic to build your pbiviz file using environment variables or other parameters.
+* Updated dependencies to the latest versions.
+
 ## 5.6.0
 * Updated to ESLint v9
 * Updated to TypeScript v5

package/bin/pbiviz.js

@@ -32,7 +32,7 @@ import CommandManager from '../lib/CommandManager.js';
 import { readJsonFromRoot } from '../lib/utils.js';
 import { program, Option } from 'commander';
 
-const npmPackage = readJsonFromRoot('package.json');
+const npmPackage = await readJsonFromRoot('package.json');
 const rootPath = process.cwd();
 const pbivizFile = 'pbiviz.json';
 
@@ -84,7 +84,7 @@ pbiviz
     .option('--no-stats', "Doesn't generate statistics files")
     .option('--skip-api', "Skips powerbi-visuals-api verifying")
     .option('-l, --all-locales', "Keeps all locale files in the package. By default only used inside stringResources folder locales are included.")
-    .option('-f, --pbiviz-file <pbiviz-file>', "Path to pbiviz.json file (useful for debugging)", pbivizFile)
+    .option('-f, --pbiviz-file <pbiviz-file>', "Path to visual config file (pbiviz.json / pbiviz.mjs)", pbivizFile)
     .action(async (options) => {
         CommandManager.start(options, rootPath);
     });
@@ -100,7 +100,7 @@ pbiviz
     .option('-l, --all-locales', "Keeps all locale files in the package. By default only used inside stringResources folder locales are included.")
     .option('-v, --verbose', "Enables verbose logging")
     .option('--fix', 'Enable autofixing of lint errors')
-    .option('-p, --pbiviz-file <pbiviz-file>', "Path to pbiviz.json file (useful for debugging)", pbivizFile)
+    .option('-p, --pbiviz-file <pbiviz-file>', "Path to visual config file (pbiviz.json / pbiviz.mjs)", pbivizFile)
     .addOption(new Option('-c, --compression <compressionLevel>', "Enables compression of visual package")
         .choices(['0', '1', '2', '3', '4', '5', '6', '7', '8', '9'])
         .default('6')

package/lib/CertificateTools.js

@@ -1,4 +1,3 @@
-/* eslint-disable no-case-declarations */
 /*
  *  Power BI Visual CLI
  *
@@ -33,7 +32,7 @@ import crypto from "crypto";
 import { readJsonFromRoot } from './utils.js';
 import ConsoleWriter from './ConsoleWriter.js';
 const certSafePeriod = 1000 * 60 * 60 * 24; // 24 hours
-const config = readJsonFromRoot('config.json');
+const config = await readJsonFromRoot('config.json');
 const pathToCertFolder = path.join(os.homedir(), config.server.certificateFolder);
 const secretFilesPath = {
     certPath: path.join(pathToCertFolder, config.server.certificate),

package/lib/CommandManager.js

@@ -17,17 +17,15 @@ export default class CommandManager {
             pbivizFile: options.pbivizFile,
         };
         const visualManager = new VisualManager(rootPath);
-        await visualManager
-            .prepareVisual(options.pbivizFile)
-            .validateVisual()
-            .initializeWebpack(webpackOptions);
+        await visualManager.prepareVisual(options.pbivizFile);
+        await visualManager.validateVisual();
+        await visualManager.initializeWebpack(webpackOptions);
         visualManager.startWebpackServer(options.drop);
     }
     static async lint(options, rootPath) {
         const visualManager = new VisualManager(rootPath);
-        await visualManager
-            .prepareVisual()
-            .runLintValidation(options);
+        await visualManager.prepareVisual();
+        await visualManager.runLintValidation(options);
     }
     static async package(options, rootPath) {
         if (!options.pbiviz && !options.resources) {
@@ -50,11 +48,12 @@ export default class CommandManager {
             verbose: options.verbose,
             fix: options.fix,
         };
-        const visual = new VisualManager(rootPath).prepareVisual(options.pbivizFile);
+        const visualManager = new VisualManager(rootPath);
+        const visual = await visualManager.prepareVisual(options.pbivizFile);
         await visual.runLintValidation(lintOptions);
-        visual.validateVisual(options.verbose)
-            .initializeWebpack(webpackOptions)
-            .then(visualManager => visualManager.generatePackage(options.verbose));
+        await visual.validateVisual(options.verbose);
+        await visual.initializeWebpack(webpackOptions)
+            .then(manager => manager.generatePackage(options.verbose));
     }
     static new({ force, template }, name, rootPath) {
         const generateOptions = {
@@ -63,10 +62,10 @@ export default class CommandManager {
         };
         VisualManager.createVisual(rootPath, name, generateOptions);
     }
-    static info(rootPath) {
-        new VisualManager(rootPath)
-            .prepareVisual()
-            .displayInfo();
+    static async info(rootPath) {
+        const visualManager = new VisualManager(rootPath);
+        await visualManager.prepareVisual();
+        await visualManager.displayInfo();
     }
     static async installCert() {
         await createCertificate();

package/lib/TemplateFetcher.js

@@ -5,7 +5,7 @@ import VisualGenerator from "./VisualGenerator.js";
 import { exec } from 'child_process';
 import fs from 'fs-extra';
 import path from 'path';
-const config = readJsonFromRoot('config.json');
+const config = await readJsonFromRoot('config.json');
 export default class TemplateFetcher {
     templateName;
     visualName;

package/lib/VisualGenerator.js

@@ -31,7 +31,7 @@ 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 config = await readJsonFromRoot('config.json');
 const VISUAL_TEMPLATES_PATH = path.join(getRootPath(), config.templates.visuals);
 const API_VERSION = config.generate.apiVersion;
 const minAPIversion = config.constants.minAPIversion;

package/lib/VisualManager.js

@@ -39,7 +39,7 @@ import { FeatureManager, Status } from "./FeatureManager.js";
 import { Severity, Stage } from "./features/FeatureTypes.js";
 import TemplateFetcher from "./TemplateFetcher.js";
 import { LintValidator } from "./LintValidator.js";
-const globalConfig = readJsonFromRoot('config.json');
+const globalConfig = await readJsonFromRoot('config.json');
 const PBIVIZ_FILE = 'pbiviz.json';
 /**
  * Represents an instance of a visual package based on file path
@@ -57,10 +57,10 @@ export default class VisualManager {
     constructor(rootPath) {
         this.basePath = rootPath;
     }
-    prepareVisual(pbivizFile = PBIVIZ_FILE) {
-        if (this.doesPBIVIZExists(pbivizFile)) {
-            this.pbivizConfig = readJsonFromVisual(pbivizFile, this.basePath);
-            this.createVisualInstance();
+    async prepareVisual(pbivizFile = PBIVIZ_FILE) {
+        this.pbivizConfig = await readJsonFromVisual(pbivizFile, this.basePath);
+        if (this.pbivizConfig) {
+            await this.createVisualInstance();
         }
         else {
             ConsoleWriter.error(pbivizFile + ' not found. You must be in the root of a visual project to run this command.');
@@ -80,8 +80,8 @@ export default class VisualManager {
             }
         }
     }
-    createVisualInstance() {
-        this.capabilities = readJsonFromVisual("capabilities.json", this.basePath);
+    async createVisualInstance() {
+        this.capabilities = await readJsonFromVisual("capabilities.json", this.basePath);
         this.visual = new Visual(this.capabilities, this.pbivizConfig);
     }
     async initializeWebpack(webpackOptions) {
@@ -188,7 +188,7 @@ export default class VisualManager {
             ConsoleWriter.warning('Running with force flag. Existing files will be overwritten');
         }
         try {
-            const config = readJsonFromRoot('config.json');
+            const config = await readJsonFromRoot('config.json');
             if (config.visualTemplates[generateOptions.template]) {
                 new TemplateFetcher(generateOptions.template, visualName, undefined)
                     .fetch();

package/lib/WebPackWrap.js

@@ -13,8 +13,8 @@ import { PowerBICustomVisualsWebpackPlugin, LocalizationLoader } from 'powerbi-v
 import ConsoleWriter from './ConsoleWriter.js';
 import { resolveCertificate } from "./CertificateTools.js";
 import { readJsonFromRoot, readJsonFromVisual } from './utils.js';
-const config = readJsonFromRoot('config.json');
-const npmPackage = readJsonFromRoot('package.json');
+const config = await readJsonFromRoot('config.json');
+const npmPackage = await readJsonFromRoot('package.json');
 const visualPlugin = "visualPlugin.ts";
 const encoding = "utf8";
 export default class WebPackWrap {
@@ -123,7 +123,7 @@ export default class WebPackWrap {
             await this.configureAPIVersion();
         }
         const api = await WebPackWrap.loadAPIPackage();
-        const dependenciesPath = this.pbiviz.dependencies && path.join(process.cwd(), this.pbiviz.dependencies);
+        const dependenciesPath = typeof this.pbiviz.dependencies === "string" && path.join(process.cwd(), this.pbiviz.dependencies);
         let pluginConfiguration = {
             ...lodashCloneDeep(visualPackage.pbivizConfig),
             apiVersion: api.version,
@@ -250,8 +250,8 @@ export default class WebPackWrap {
         allLocales: false,
         pbivizFile: 'pbiviz.json',
     }) {
-        const tsconfig = readJsonFromVisual('tsconfig.json');
-        this.pbiviz = readJsonFromVisual(options.pbivizFile);
+        const tsconfig = await readJsonFromVisual('tsconfig.json');
+        this.pbiviz = await readJsonFromVisual(options.pbivizFile);
         const capabilitiesPath = this.pbiviz.capabilities;
         visualPackage.pbivizConfig.capabilities = capabilitiesPath;
         const dependenciesPath = this.pbiviz.dependencies && path.join(process.cwd(), this.pbiviz.dependencies);

package/lib/features/APIVersion.js

@@ -7,8 +7,8 @@ export default class APIVersion {
     static visualFeatureType = VisualFeatureType.NonSlicer;
     static minAPIversion;
     static errorMessage;
-    static isSupported(visual) {
-        const globalConfig = readJsonFromRoot('config.json');
+    static async isSupported(visual) {
+        const globalConfig = await readJsonFromRoot('config.json');
         this.minAPIversion = globalConfig.constants.minAPIversion;
         this.errorMessage = `API version must be at least ${this.minAPIversion}.`;
         return visual.doesAPIVersionMatch(this.minAPIversion);

package/lib/utils.js

@@ -22,12 +22,22 @@ export function getRootPath() {
     const pathToDirectory = fileURLToPath(import.meta.url);
     return path.join(pathToDirectory, "..", "..");
 }
-function readFileFromRoot(filePath) {
-    return fs.readFileSync(path.join(getRootPath(), filePath), "utf8");
+export function getJsPath(filePath) {
+    return filePath.replace(/\.json$/, '.mjs');
 }
-export function readJsonFromRoot(filePath) {
-    return JSON.parse(readFileFromRoot(filePath));
+async function safelyImport(filePath) {
+    return fs.existsSync(filePath) && (await import(`file://${filePath}`)).default;
 }
-export function readJsonFromVisual(filePath, visualPath) {
-    return JSON.parse(fs.readFileSync(path.join(visualPath ?? process.cwd(), filePath), "utf8"));
+function safelyParse(filePath) {
+    return fs.existsSync(filePath) && JSON.parse(fs.readFileSync(filePath, "utf-8"));
+}
+export async function readJsonFromRoot(jsonFilename) {
+    const jsonPath = path.join(getRootPath(), jsonFilename);
+    const jsPath = getJsPath(jsonPath);
+    return (await safelyImport(jsPath)) || safelyParse(jsonPath);
+}
+export async function readJsonFromVisual(filePath, visualPath) {
+    const jsonPath = path.join(visualPath ?? process.cwd(), filePath);
+    const jsPath = getJsPath(jsonPath);
+    return (await safelyImport(jsPath)) || safelyParse(jsonPath);
 }

package/lib/webpack.config.js

@@ -3,7 +3,7 @@ import MiniCssExtractPlugin from "mini-css-extract-plugin";
 import TerserPlugin from "terser-webpack-plugin";
 import path from "path";
 import webpack from "webpack";
-const config = readJsonFromRoot("/config.json");
+const config = await readJsonFromRoot("/config.json");
 const rootPath = getRootPath();
 const webpackConfig = {
     entry: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "powerbi-visuals-tools",
-  "version": "5.6.0",
+  "version": "6.0.0",
   "description": "Command line tool for creating and publishing visuals for Power BI",
   "main": "./bin/pbiviz.js",
   "type": "module",
@@ -8,12 +8,11 @@
     "build": "tsc",
     "pbiviz": "node ./bin/pbiviz.js",
     "start": "npm run pbiviz start",
-    "test": "npm run build && npm run clean-tests && npm run lint && npm run jasmine",
+    "test": "npm run build && npm run lint && npm run jasmine",
     "jasmine": "node spec/jasmine-runner.js",
     "jasmine-inspect": "node --inspect spec/jasmine-runner.js",
     "lint": "npx eslint .",
-    "clean-tests": "node spec/clean-tests.js",
-    "debug-tests": "npm run clean-tests && npm run lint && npm run jasmine-inspect"
+    "debug-tests": "npm run lint && npm run jasmine-inspect"
   },
   "bin": {
     "pbiviz": "./bin/pbiviz.js"
@@ -29,33 +28,33 @@
   },
   "homepage": "https://github.com/Microsoft/PowerBI-visuals-tools#readme",
   "dependencies": {
-    "@typescript-eslint/parser": "^8.8.0",
+    "@typescript-eslint/parser": "^8.26.0",
     "assert": "^2.1.0",
     "async": "^3.2.6",
     "browserify-zlib": "^0.2.0",
     "buffer": "^6.0.3",
-    "chalk": "^5.3.0",
-    "commander": "^12.1.0",
+    "chalk": "^5.4.1",
+    "commander": "^13.1.0",
     "compare-versions": "^6.1.1",
     "console-browserify": "^1.2.0",
     "constants-browserify": "^1.0.0",
-    "crypto-browserify": "^3.12.0",
+    "crypto-browserify": "^3.12.1",
     "css-loader": "^7.1.2",
     "domain-browser": "^5.7.0",
     "events": "^3.3.0",
     "extra-watch-webpack-plugin": "^1.0.3",
-    "fs-extra": "^11.2.0",
+    "fs-extra": "^11.3.0",
     "https-browserify": "^1.0.0",
     "inline-source-map": "^0.6.3",
     "json-loader": "0.5.7",
     "jszip": "^3.10.1",
-    "less": "^4.2.0",
+    "less": "^4.2.2",
     "less-loader": "^12.2.0",
     "lodash.clonedeep": "4.5.0",
     "lodash.defaults": "4.2.0",
     "lodash.isequal": "4.5.0",
     "lodash.ismatch": "^4.4.0",
-    "mini-css-extract-plugin": "^2.9.1",
+    "mini-css-extract-plugin": "^2.9.2",
     "os-browserify": "^0.3.0",
     "path-browserify": "^1.0.1",
     "powerbi-visuals-webpack-plugin": "4.1.0",
@@ -63,30 +62,30 @@
     "process": "^0.11.10",
     "punycode": "^2.3.1",
     "querystring-es3": "^0.2.1",
-    "readable-stream": "^4.5.2",
+    "readable-stream": "^4.7.0",
     "stream-browserify": "^3.0.0",
     "stream-http": "^3.2.0",
     "string_decoder": "^1.3.0",
-    "terser-webpack-plugin": "^5.3.10",
+    "terser-webpack-plugin": "^5.3.14",
     "timers-browserify": "^2.0.12",
-    "ts-loader": "^9.5.1",
+    "ts-loader": "^9.5.2",
     "tty-browserify": "^0.0.1",
-    "typescript": "^5.5.0",
+    "typescript": "^5.8.2",
     "url": "^0.11.4",
     "util": "^0.12.5",
     "vm-browserify": "^1.1.2",
-    "webpack": "^5.95.0",
+    "webpack": "^5.98.0",
     "webpack-bundle-analyzer": "4.10.2",
-    "webpack-dev-server": "^5.1.0"
+    "webpack-dev-server": "^5.2.0"
   },
   "devDependencies": {
-    "@typescript-eslint/eslint-plugin": "^8.8.0",
-    "eslint": "^9.11.1",
-    "jasmine": "5.3.0",
+    "@typescript-eslint/eslint-plugin": "^8.26.0",
+    "eslint": "^9.22.0",
+    "jasmine": "5.3.1",
     "jasmine-spec-reporter": "7.0.0",
-    "semver": "7.6.3",
+    "semver": "7.7.1",
     "tree-kill": "1.2.2",
-    "webpack-cli": "^5.1.4"
+    "webpack-cli": "^6.0.1"
   },
   "optionalDependencies": {
     "fsevents": "*"