powerbi-visuals-tools 5.0.3 → 5.1.0

package/Changelog.md

@@ -2,6 +2,13 @@
 
 This page contains information about changes to the PowerBI Visual Tools (pbiviz).
 
+## 5.1.0
+* New flag `--skip-api` to skip verifying api version. It might produce different errors in visual, so use it only in some specific cases (ex. installing something during the build process brakes packages managed by monorepo managers).
+* New flag `--all-locales` to disable optimization using localization loader. It's recommended not to use this flag because all locales take a huge amount of package size. If you need just a few of them follow [this guide](https://learn.microsoft.com/en-us/power-bi/developer/visuals/localization?tabs=English#step-5---add-a-resources-file-for-each-language). In this case, only declared in stringResources locales will be added to your visual package.
+
+## 5.0.3
+* Now option `--install-cert` is command. The new usage is `pbiviz install-cert` **⚠**
+
 ## 5.0.3
 * Now option `--install-cert` is command. New usage is `pbiviz install-cert`
 * Fixed bug with the incorrect detection of the installed API version
@@ -20,6 +27,7 @@ This page contains information about changes to the PowerBI Visual Tools (pbiviz
 * Migrated to NodeJS 18.0 **⚠**
 
 ## 4.3.2
+* `options` in `Visual.constructor()` is optional. It's made to match PowerBI interface and to support strict mode
 * LocalizationLoader has been moved to `powerbi-visuals-webpack-plugin`
 
 ## 4.3.1
@@ -36,8 +44,13 @@ This page contains information about changes to the PowerBI Visual Tools (pbiviz
 * Fixed vulnerabilities
 * Updated `powerbi-visuals-webpack-plugin` to 3.2.0
 
+
+### **⚠ BREAKING CHANGES**
 ## 4.1.0
-* Added loader to reduce localizations size. REQUIRES `powerbi-visuals-utils-formattingutils` version 5.1 and higher
+* Added loader to reduce localizations size. REQUIRES `powerbi-visuals-utils-formattingutils` version 5.1 and higher.
+  
+    Now loader deletes all unused in stringResources folder locales.
+
 * Fixed vulnerabilities
 
 ## 4.0.9

package/bin/pbiviz.js

@@ -44,9 +44,9 @@ const pbiviz = program
 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')
+    .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')
     )
@@ -71,9 +71,11 @@ pbiviz
 pbiviz
     .command('start')
     .usage('[options]')
-    .option('-p, --port [port]', 'set the port listening on')
-    .option('-d, --drop', 'drop outputs into output folder')
+    .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")
+    .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.")
     .action(async (options) => {
         CommandManager.start(options, rootPath);
     });
@@ -85,6 +87,8 @@ pbiviz
     .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")
+    .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.")
     .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/certs/PowerBICustomVisualTest_private.key

@@ -1,28 +1,28 @@
 -----BEGIN PRIVATE KEY-----
-MIIEvAIBADANBgkqhkiG9w0BAQEFAASCBKYwggSiAgEAAoIBAQC155Q6mq/fmI37
-F9qnGiky6TA0zLOAQV/k0dQbx0vz9+33dO7h+Hnjyu6YUOV1YvFzOWg81nfCUrT3
-ccoOUQmahanypuvW5cqtopXH0b3Qsfau+whA5PM6ozR3cV4HrxQa00hLe7GFDZWn
-oDJsr9QpZ0bWTmBm20kZ9Rg4NegUQb9LV9Ko0HMbC4zdnRGb2HndlNxnECd1qFCL
-duPSRRoyfEi6sOaLApBRr2gbyKi33AKGnEpH2N8Nll1dYWjjC5tuz62LzNSzT8dW
-N9d85HQsxp0+isHrss02+dCF/gBsnhr4yScmgIY49XFlpPdqKySETPb0TBKx2XA+
-Eil/XeaDAgMBAAECggEASAQI4TLAkks5WsFU5Xcr/GXpmd246vv21QZlbSH35fyw
-D5oRwRC4YQDEeTT9wv2LDc0agYt/GkXYM2avUf+vR6fHYrPHBusu1JNbrSJSfb8X
-JKtp1xdNXFeku+z8Bxq/YOdo5clwvHZmW1jG3dS2sDWdC9c3v0DtrgMktYxR90Jt
-XWa4q2C/U0qmjppMmXwH7NCoHjflIGUPq3wnPYO4VTjI7xQUDTnrFt3WefDJPB1C
-7Qj/uFIZhG1aLGUx5rCrZ6Shwt61kB1yEHHRGEvaccexk7Hj93MFFPxiY2sRXI67
-8RWaeUZVl1dnlGTJc4ceBp1JQz8unw6Z8bVX90OrsQKBgQDQy6+sZChUifo/gq4i
-R+ewpr1h56glmyDwsOqfPRiKYoM/HfTQvUY/P1UcXcni4+10G8y1zrlo5q2C5m1o
-wsbtwGMh5mC2HkejcUxzIDMi7FklSQoOKf/WbI1cicw1FPN6IzCWygu83BnwuNyn
-n7qdGFJf1lxdEy+cLAwPf82CFQKBgQDfB4oYUNaBY/86XAKd6RQdShh9kUPIi5gC
-SvNT5iZoD2yOARaXM6N9NRL8ecjUgCOwFE0EXhwbxLA7jhEp0tlUEcLTSG82m/K/
-X7iQSYrAUHMeYDnDqw4ldbvOiwyW4BTyQXZt/zBNsoeRXwymTGW9QcGkJ8dlSH7r
-GJofyzwkNwKBgBZx3ueUOLWlw23yWU+8FQ7rTa5pnay1OVxGWGJXyfyOTHeLe9a4
-kgWYhEixWFN4lv0FRANDPrElIv/QT3CUh5flN4LcZgcNyDusoUA69ORLLeYRLPCK
-2UKulp+c/IO0RdwaTk3XWF2r92nmJWorhH8Ar1I4E+O5fUO3hHBiF7BlAoGAUcJ4
-zGsuB6b51JIQX4UnW4ljKv0KxUTvR7/kLdiMMc+dsv0RJALJJ0hCmo2mosgKzSzU
-Awrg8QkMtfhhsFxcUWZlboD6TCGlPqS/ix16oP+dBACwjFtzxyW+4Hu29MRWyWxY
-FwDa21DcQ919TKVrEpM9gokWnrmR1WtibM9bT8cCgYAuuMnTGwe7IdJE8yX1Z8cj
-+uhL1zhkRanLDB2VCRjIaVAhYFlsKSCLkdoPtlhm+DCpa9dIYn/5Lr675kXT75Om
-NlzA8al4hspE4SmtzWkH8rPRlBNlSx6MXMIpx2B5WAv+vt+pF35f3QDyCrFHlYG4
-0EosZqYcRWBQUmNETOPTWQ==
+MIIEvQIBADANBgkqhkiG9w0BAQEFAASCBKcwggSjAgEAAoIBAQDEKuHsNka9n8H9
+28W1ARv0lBkZYfQMxNK7IOSWopNp+l2w13ns3/Uz6IMB7iRqSCR8i8p0vQHatZP+
+0o8QY2NkMgaRiXlSH48GxmaRfhdTaPv0r2WTB7jibl3c5xEunjL3cvO2F8qVh+8S
+SybpY2v4RCqHCAg2o2ZyAkXJk+Rkh/TIOcmQzbQk8SLkuFIPBAXObS8SxZ03/VXJ
+x+5iYYqC28TJAkHh8ZSknpkIRCDfV5RzRkwWXvP70aY0Mm1T7rETBh9yDlThZbg5
+9WWYcyqZUn0PgNmM/VWwAYWD16/X832BFYFMbFrANv8CFchtZ58aLcAd9hXarpVT
+2UxFQpOPAgMBAAECggEADMGTyA4jfX3frzKqYZcn3+NS2oFceF7C1qOl7wcKuk/V
+5dkCjF0Sjy87IwCpt4uSFn3p9WYRB82E89jHWtPLs8lDqhUcIYinKVP0ztiPNb+p
+mq4JLI11AAHDSB5yfJXm+eECE2uVTdygDDrSK0e+zqRyy4MXMvkJ1rdqcwLootd4
+YQ2HaGDznr1DyAswfjgwJDut2gmast8GdKcCQZqk52VtRMs8zNY/O22HFRP1nQQZ
+o0vTGnn1y4Yw8r3psDrIK/lKoYSKgX3ljd1dP3B9SF7Nb/pxRgkeK/b21xJXQl+Y
+xcFOFe2pvGLCYyJXbdO6TyKAgNIMajmARrJ4/HLQ2QKBgQDErYQVb3urMcQYhuMF
+QedZ6rKJn8IhqXA41qnfV4yPS+UOwpi4IJh4SZkHfCFaqidoG9BDNAAWQYBTIrUo
+KLNMhWh5xcSPETN6LotdxbaAzkp3/vo6+Gkxhbk4S0nOD6TDbatXuaW412X2bHLP
+1qs1bYYDJ/zsyPTg2mPzJo9JAwKBgQD/Vfb49NOlnK51/oDULOIkJS0yB/DWLKxP
+Xjwt9ja5sgxRA3A69V3AhwcZh8nJ2n/EaoQB0WMI46q9rWFfJpktuT03xpGTT+bZ
+6+wTgjfng4rdWeYoA0PQj+7y2lU8WIFRQHucxjs1jz3qLN6/T8NuzwbfD7r5Ml5j
+TrQPhLY3hQKBgQCLaxj7fPikhXWlkVCytGIEimufRWF/LTZBBGKM0Onx1nH8QZOy
+ymBqvHk/Jg4a0A15LmY2jVEWdb46sJrMafWX4+YIlFnetOnRzda7VWEm85U0dMn7
+LYacNVf0AOLDsLEyW7afTBme6wn7YisNC/Z3vDjIWftf+qAkGIvLnGTr8wKBgBIW
+4gdjOPdbsVR0smXVxDOxWpFX1K0nvxFkaLkM33Wqcoruxm224mx4ZH1fjGE7lJ+y
+uCV00yJXFsqXVPWrw2Bk5jxkWf3oxD8eIryDFjjVreneq5qcGJrXB6O26iD7WDYM
+bnV96cXynv1PLny5Ruw7yI3XDHUJJ3y7n7AVw98NAoGAGH8vZfDKQxicfS3FuRs+
+Wt6ALNTJ/SQXLzg0/9G71YbI4Kxcr9g+OS01jShD5PUbBEc92YQJxFNpsYK5PeOF
+N0Wm3Y2qDANmI6OPN9G6YJq+JDPPLyAXMSYFIz8p8nZDF7WxJZGLe/2wl6oXf704
+iOPJDmLH53+a0xNA0vrtB3o=
 -----END PRIVATE KEY-----

package/certs/PowerBICustomVisualTest_public.crt

@@ -1,19 +1,19 @@
 -----BEGIN CERTIFICATE-----
-MIIDCTCCAfGgAwIBAgIUGsxsjjaY2GmUHIEyJG5gYWxgDvcwDQYJKoZIhvcNAQEL
-BQAwFDESMBAGA1UEAwwJbG9jYWxob3N0MB4XDTIzMDgwNzE0MDk1OFoXDTI0MDgw
-NjE0MDk1OFowFDESMBAGA1UEAwwJbG9jYWxob3N0MIIBIjANBgkqhkiG9w0BAQEF
-AAOCAQ8AMIIBCgKCAQEAteeUOpqv35iN+xfapxopMukwNMyzgEFf5NHUG8dL8/ft
-93Tu4fh548rumFDldWLxczloPNZ3wlK093HKDlEJmoWp8qbr1uXKraKVx9G90LH2
-rvsIQOTzOqM0d3FeB68UGtNIS3uxhQ2Vp6AybK/UKWdG1k5gZttJGfUYODXoFEG/
-S1fSqNBzGwuM3Z0Rm9h53ZTcZxAndahQi3bj0kUaMnxIurDmiwKQUa9oG8iot9wC
-hpxKR9jfDZZdXWFo4wubbs+ti8zUs0/HVjfXfOR0LMadPorB67LNNvnQhf4AbJ4a
-+MknJoCGOPVxZaT3aiskhEz29EwSsdlwPhIpf13mgwIDAQABo1MwUTAdBgNVHQ4E
-FgQU5X2k15HyvorxnwSoZdgQgncfLtYwHwYDVR0jBBgwFoAU5X2k15HyvorxnwSo
-ZdgQgncfLtYwDwYDVR0TAQH/BAUwAwEB/zANBgkqhkiG9w0BAQsFAAOCAQEAOypg
-7ioP4P6R/8gomTzzo+PrFO9YeM4ZyJrwLRTSlWTudjfmMRwIMKmhWo/tFo+e5+IZ
-uYaXYWCtyQSz6fb/XF1RlbmeBd4NhT81mITh9h8s7Hjece1UX73Gc5n2uZr7sokl
-9D+rcXPPKhrCvNAuRIEcQSKpueKcADizT/KFDjqX5DhztiiZmk62Ki/K+aTWSl0q
-Pj3s0KNBCL8sUecvjGoaxNamJ3v22tYmKPi5G79suat5kvEjkndU+F0Y/EM5lwsH
-whChIjCR4RBU01pPG6S2zzvgNUrVHc7W7CsSX55U641oHd9r5gLkBQ0t9Sa5xXqd
-saWvwAR8yKA6G+t5PQ==
+MIIDCTCCAfGgAwIBAgIUdiNbul8BmWrJiP6z3MbFof3u/6AwDQYJKoZIhvcNAQEL
+BQAwFDESMBAGA1UEAwwJbG9jYWxob3N0MB4XDTIzMDgyMTE4MTM1NVoXDTI0MDgy
+MDE4MTM1NVowFDESMBAGA1UEAwwJbG9jYWxob3N0MIIBIjANBgkqhkiG9w0BAQEF
+AAOCAQ8AMIIBCgKCAQEAxCrh7DZGvZ/B/dvFtQEb9JQZGWH0DMTSuyDklqKTafpd
+sNd57N/1M+iDAe4kakgkfIvKdL0B2rWT/tKPEGNjZDIGkYl5Uh+PBsZmkX4XU2j7
+9K9lkwe44m5d3OcRLp4y93LzthfKlYfvEksm6WNr+EQqhwgINqNmcgJFyZPkZIf0
+yDnJkM20JPEi5LhSDwQFzm0vEsWdN/1VycfuYmGKgtvEyQJB4fGUpJ6ZCEQg31eU
+c0ZMFl7z+9GmNDJtU+6xEwYfcg5U4WW4OfVlmHMqmVJ9D4DZjP1VsAGFg9ev1/N9
+gRWBTGxawDb/AhXIbWefGi3AHfYV2q6VU9lMRUKTjwIDAQABo1MwUTAdBgNVHQ4E
+FgQU3LMs3hmPwHpL5sqTzN2RWogd2/kwHwYDVR0jBBgwFoAU3LMs3hmPwHpL5sqT
+zN2RWogd2/kwDwYDVR0TAQH/BAUwAwEB/zANBgkqhkiG9w0BAQsFAAOCAQEARQpD
+lZRixXXot7qr1ygS1iSDm8CODWhQca8V1T80TPRFNlX3beQPkbCndsZBa/PoXN21
+D2QBScsXgMaVEBB5FVmKAVXf/e2KoOUZ9Au8Oko9sKrzUalirM2YlqYbgwiAI0wR
+1rTBm+aNsP8xFVDyYrbFe60rtuhduFDvAWi2p9ywQdRuW5I5DyLMBuqOVWo7vn0I
+3hJ4FM3r4Lb/8LUrFVjxtLVMEqC1nlpt5FgyjpuN/adYICBQFqtHCiirXRoyfdL8
+7TZts6ychG5yhoB0fixYnExQfwIMeaqIKiuwqcZoRB2EjTKBTNBeXfxISNR6HPnq
+a0Q0pHZGEGnT+S8mFA==
 -----END CERTIFICATE-----

package/lib/CertificateTools.js

@@ -28,7 +28,7 @@ import { exec as nodeExec } from 'child_process';
 import fs from 'fs-extra';
 import os from 'os';
 import path from 'path';
-import crypto from "crypto";
+import crypto, { webcrypto } from "crypto";
 import { getRootPath, readJsonFromRoot } from './utils.js';
 import ConsoleWriter from './ConsoleWriter.js';
 const certSafePeriod = 1000 * 60 * 60 * 24; // 24 hours
@@ -140,7 +140,7 @@ export async function createCertFile(config, open) {
                         }
                         break;
                     }
-                    passphrase = crypto.getRandomValues(new Uint32Array(1))[0].toString().substring(2);
+                    passphrase = (crypto.getRandomValues || webcrypto.getRandomValues)(new Uint32Array(1))[0].toString().substring(2);
                     config.server.passphrase = passphrase;
                     fs.writeFileSync(path.join(rootPath, confPath), JSON.stringify(config));
                     // for windows 8 / 8.1 / server 2012 R2 /

package/lib/CommandManager.js

@@ -11,7 +11,9 @@ export default class CommandManager {
             minifyJS: false,
             minify: false,
             devServerPort: options.port,
-            stats: options.stats
+            stats: options.stats,
+            skipApiCheck: options.skipApi,
+            allLocales: options.allLocales
         };
         const visualManager = new VisualManager(rootPath);
         await visualManager
@@ -31,7 +33,9 @@ export default class CommandManager {
             minifyJS: options.minify,
             minify: options.minify,
             compression: options.compression,
-            stats: options.stats
+            stats: options.stats,
+            skipApiCheck: options.skipApi,
+            allLocales: options.allLocales
         };
         new VisualManager(rootPath)
             .prepareVisual()

package/lib/VisualManager.js

@@ -52,7 +52,8 @@ export default class VisualManager {
             this.pbivizConfig = readJsonFromVisual(PBIVIZ_FILE, this.basePath);
         }
         else {
-            throw new Error(PBIVIZ_FILE + ' not found. You must be in the root of a visual project to run this command.');
+            ConsoleWriter.error(PBIVIZ_FILE + ' not found. You must be in the root of a visual project to run this command.');
+            process.exit(1);
         }
         return this;
     }

package/lib/WebPackWrap.js

@@ -9,7 +9,7 @@ import { exec as processExec } from 'child_process';
 import lodashCloneDeep from 'lodash.clonedeep';
 import ExtraWatchWebpackPlugin from 'extra-watch-webpack-plugin';
 import { BundleAnalyzerPlugin } from 'webpack-bundle-analyzer';
-import { PowerBICustomVisualsWebpackPlugin } from 'powerbi-visuals-webpack-plugin';
+import { PowerBICustomVisualsWebpackPlugin, LocalizationLoader } from 'powerbi-visuals-webpack-plugin';
 import ConsoleWriter from './ConsoleWriter.js';
 import { resolveCertificate } from "./CertificateTools.js";
 import { readJsonFromRoot, readJsonFromVisual } from './utils.js';
@@ -33,12 +33,13 @@ export default class WebPackWrap {
         await fs.createFile(visualPluginFile);
     }
     static loadAPIPackage() {
-        try {
-            return import("file://" + path.join(process.cwd(), "node_modules", "powerbi-visuals-api", "index.js"));
-        }
-        catch (ex) {
-            return null;
+        const apiPath = path.join(process.cwd(), "node_modules", "powerbi-visuals-api");
+        const doesAPIExist = fs.pathExistsSync(apiPath);
+        if (!doesAPIExist) {
+            ConsoleWriter.error(`Can't find powerbi-visuals-api package`);
+            process.exit(1);
         }
+        return import("file://" + path.join(apiPath, "index.js"));
     }
     async installAPIpackage() {
         const apiVersion = this.pbiviz.apiVersion ? `~${this.pbiviz.apiVersion}` : "latest";
@@ -115,45 +116,50 @@ export default class WebPackWrap {
         return env;
     }
     async configureCustomVisualsWebpackPlugin(visualPackage, options, tsconfig) {
-        const pluginConfiguration = lodashCloneDeep(visualPackage.pbivizConfig);
-        //(?=\D*$) - positive look-ahead to find last version symbols and exclude any non-digit symbols after the version.
-        const regexFullVersion = /(?<=powerbi-visuals-api@)((?:\d+\.?){1,3})/g;
-        const regexMinorVersion = /\d+(?:\.\d+)?/;
-        let apiVersionInstalled;
-        try {
-            const subprocess = await exec('npm list powerbi-visuals-api version');
-            apiVersionInstalled = subprocess.stdout.match(regexFullVersion)[0];
-        }
-        catch (err) {
-            ConsoleWriter.warning(`"powerbi-visuals-api" is not installed`);
+        if (options.skipApiCheck) {
+            ConsoleWriter.warning(`Skipping API check. Tools started with --skipApi flag.`);
         }
-        // if the powerbi-visual-api package wasn't installed
-        // install the powerbi-visual-api, with version from apiVersion in pbiviz.json
-        // or the latest API, if apiVersion is absent in pbiviz.json
-        if (!apiVersionInstalled || !this.pbiviz.apiVersion || this.pbiviz.apiVersion.match(regexMinorVersion)[0] != apiVersionInstalled.match(regexMinorVersion)[0]) {
-            ConsoleWriter.warning(`installed "powerbi-visuals-api" version - "${apiVersionInstalled}", is not match with the version specified in pbviz.json - "${this.pbiviz.apiVersion}".`);
-            await this.installAPIpackage();
+        else {
+            await this.configureAPIVersion();
         }
-        // pluginConfiguration.env = await this.getEnvironmentDetails();
         const api = await WebPackWrap.loadAPIPackage();
-        pluginConfiguration.apiVersion = api.version;
-        pluginConfiguration.capabilitiesSchema = api.schemas.capabilities;
-        pluginConfiguration.pbivizSchema = api.schemas.pbiviz;
-        pluginConfiguration.stringResourcesSchema = api.schemas.stringResources;
-        pluginConfiguration.dependenciesSchema = api.schemas.dependencies;
-        pluginConfiguration.customVisualID = `CustomVisual_${this.pbiviz.visual.guid}`.replace(/[^\w\s]/gi, '');
-        pluginConfiguration.devMode = (typeof options.devMode === "undefined") ? true : options.devMode;
-        pluginConfiguration.generatePbiviz = options.generatePbiviz;
-        pluginConfiguration.generateResources = options.generateResources;
-        pluginConfiguration.minifyJS = options.minifyJS;
         const dependenciesPath = this.pbiviz.dependencies && path.join(process.cwd(), this.pbiviz.dependencies);
-        pluginConfiguration.dependencies = fs.existsSync(dependenciesPath) ? this.pbiviz.dependencies : null;
-        pluginConfiguration.modules = typeof tsconfig.compilerOptions.outDir !== "undefined";
-        pluginConfiguration.visualSourceLocation = path.posix.relative(config.build.precompileFolder, tsconfig.files[0]).replace(/(\.ts)x|\.ts/, "");
-        pluginConfiguration.pluginLocation = path.join(config.build.precompileFolder, "visualPlugin.ts");
-        pluginConfiguration.compression = options.compression;
+        let pluginConfiguration = {
+            ...lodashCloneDeep(visualPackage.pbivizConfig),
+            apiVersion: api.version,
+            capabilitiesSchema: api.schemas.capabilities,
+            pbivizSchema: api.schemas.pbiviz,
+            stringResourcesSchema: api.schemas.stringResources,
+            dependenciesSchema: api.schemas.dependencies,
+            customVisualID: `CustomVisual_${this.pbiviz.visual.guid}`.replace(/[^\w\s]/gi, ''),
+            devMode: options.devMode,
+            generatePbiviz: options.generatePbiviz,
+            generateResources: options.generateResources,
+            minifyJS: options.minifyJS,
+            dependencies: fs.existsSync(dependenciesPath) ? this.pbiviz.dependencies : null,
+            modules: typeof tsconfig.compilerOptions.outDir !== "undefined",
+            visualSourceLocation: path.posix.relative(config.build.precompileFolder, tsconfig.files[0]).replace(/(\.ts)x|\.ts/, ""),
+            pluginLocation: path.join(config.build.precompileFolder, "visualPlugin.ts"),
+            compression: options.compression
+        };
         return pluginConfiguration;
     }
+    async configureAPIVersion() {
+        //(?<=powerbi-visuals-api@) - positive look-behind to find version installed in visual and get 3 level version.
+        const regexFullVersion = /(?<=powerbi-visuals-api@)((?:\d+\.?){1,3})/g;
+        //get only first 2 parts of version
+        const regexMajorVersion = /\d+(?:\.\d+)?/;
+        const listResults = (await exec('npm list powerbi-visuals-api version')).stdout;
+        const installedAPIVersion = listResults.match(regexFullVersion)[0] ?? "not found";
+        const doesAPIExist = fs.pathExistsSync(path.join(process.cwd(), "node_modules", "powerbi-visuals-api"));
+        // if the powerbi-visual-api package wasn't installed install the powerbi-visual-api,
+        // with version from apiVersion in pbiviz.json or the latest API, if apiVersion is absent in pbiviz.json
+        const isAPIConfigured = doesAPIExist && installedAPIVersion && this.pbiviz.apiVersion;
+        if (!isAPIConfigured || this.pbiviz.apiVersion.match(regexMajorVersion)[0] != installedAPIVersion.match(regexMajorVersion)[0]) {
+            ConsoleWriter.warning(`installed "powerbi-visuals-api" version - "${installedAPIVersion}", is not match with the version specified in pbviz.json - "${this.pbiviz.apiVersion}".`);
+            await this.installAPIpackage();
+        }
+    }
     async appendPlugins(options, visualPackage, tsconfig) {
         const pluginConfiguration = await this.configureCustomVisualsWebpackPlugin(visualPackage, options, tsconfig);
         let statsFilename = config.build.stats.split("/").pop();
@@ -177,23 +183,27 @@ export default class WebPackWrap {
             }));
         }
     }
-    async useLoader({ fast = false }) {
-        let tsOptions = {};
-        if (fast) {
-            tsOptions = {
-                transpileOnly: false,
-                experimentalWatchApi: false
-            };
-        }
+    async configureLoaders({ fast = false, includeAllLocales = false }) {
         this.webpackConfig.module.rules.push({
             test: /(\.ts)x?$/,
             use: [
                 {
                     loader: "ts-loader",
-                    options: tsOptions
+                    options: fast
+                        ? {
+                            transpileOnly: false,
+                            experimentalWatchApi: false
+                        }
+                        : {}
                 }
             ]
         });
+        if (!includeAllLocales) {
+            this.webpackConfig.module.rules.push({
+                test: /powerbiGlobalizeLocales\.js$/,
+                loader: LocalizationLoader
+            });
+        }
     }
     async prepareWebPackConfig(visualPackage, options, tsconfig) {
         this.webpackConfig = Object.assign({}, await import('./webpack.config.js')).default;
@@ -206,8 +216,9 @@ export default class WebPackWrap {
         await this.appendPlugins(options, visualPackage, tsconfig);
         await this.configureDevServer(visualPackage, options.devServerPort);
         await this.configureVisualPlugin(options, tsconfig, visualPackage);
-        await this.useLoader({
-            fast: options.fast
+        await this.configureLoaders({
+            fast: options.fast,
+            includeAllLocales: options.allLocales
         });
         return this.webpackConfig;
     }
@@ -228,7 +239,9 @@ export default class WebPackWrap {
         devServerPort: 8080,
         fast: false,
         compression: 0,
-        stats: true
+        stats: true,
+        skipApiCheck: false,
+        allLocales: false
     }) {
         const tsconfig = readJsonFromVisual('tsconfig.json');
         this.pbiviz = readJsonFromVisual('pbiviz.json');

package/lib/webpack.config.js

@@ -1,5 +1,4 @@
 import { getRootPath, readJsonFromRoot } from './utils.js';
-import { LocalizationLoader } from "powerbi-visuals-webpack-plugin";
 import MiniCssExtractPlugin from "mini-css-extract-plugin";
 import TerserPlugin from "terser-webpack-plugin";
 import path from "path";
@@ -62,10 +61,6 @@ const webpackConfig = {
             {
                 test: /\.(woff|ttf|ico|woff2|jpg|jpeg|png|webp|gif|svg|eot)$/i,
                 type: 'asset/inline'
-            },
-            {
-                test: /powerbiGlobalizeLocales\.js$/,
-                loader: LocalizationLoader
             }
         ]
     },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "powerbi-visuals-tools",
-  "version": "5.0.3",
+  "version": "5.1.0",
   "description": "Command line tool for creating and publishing visuals for Power BI",
   "main": "./bin/pbiviz.js",
   "type": "module",
@@ -36,7 +36,7 @@
     "buffer": "^6.0.3",
     "chalk": "^5.3.0",
     "commander": "^11.0.0",
-    "compare-versions": "^6.0.0",
+    "compare-versions": "^6.1.0",
     "console-browserify": "^1.2.0",
     "constants-browserify": "^1.0.0",
     "crypto-browserify": "^3.12.0",
@@ -49,7 +49,7 @@
     "inline-source-map": "^0.6.2",
     "json-loader": "0.5.7",
     "jszip": "^3.10.1",
-    "less": "^4.1.3",
+    "less": "^4.2.0",
     "less-loader": "^11.1.3",
     "lodash.clonedeep": "4.5.0",
     "lodash.defaults": "4.2.0",
@@ -79,9 +79,9 @@
   },
   "devDependencies": {
     "@typescript-eslint/eslint-plugin": "^5.62.0",
-    "eslint": "^8.45.0",
+    "eslint": "^8.47.0",
     "eslint-plugin-powerbi-visuals": "^0.8.1",
-    "jasmine": "5.0.2",
+    "jasmine": "5.1.0",
     "jasmine-spec-reporter": "7.0.0",
     "semver": "7.5.4",
     "tree-kill": "1.2.2",