powerbi-visuals-tools 7.0.0 → 7.0.1

package/lib/features/Tooltips.js

@@ -0,0 +1,12 @@
+import { Severity, Stage, VisualFeatureType } from "./FeatureTypes.js";
+export default class Tooltips {
+    static featureName = "Tooltips";
+    static documentationLink = "https://learn.microsoft.com/en-us/power-bi/developer/visuals/add-tooltips";
+    static severity = Severity.Warning;
+    static stage = Stage.PostBuild;
+    static visualFeatureType = VisualFeatureType.NonSlicer | VisualFeatureType.Slicer;
+    static errorMessage = `${this.featureName} - ${this.documentationLink}`;
+    static isSupported(packageInstance) {
+        return packageInstance.contain("tooltipService") && packageInstance.isCapabilityEnabled({ tooltips: {} });
+    }
+}

package/lib/features/TotalSubTotal.js

@@ -0,0 +1,12 @@
+import { Severity, Stage, VisualFeatureType } from "./FeatureTypes.js";
+export default class TotalSubTotal {
+    static featureName = "Total SubTotal";
+    static documentationLink = "https://learn.microsoft.com/en-us/power-bi/developer/visuals/total-subtotal-api";
+    static severity = Severity.Warning;
+    static stage = Stage.PostBuild;
+    static visualFeatureType = VisualFeatureType.Matrix;
+    static errorMessage = `${this.featureName} - ${this.documentationLink}`;
+    static isSupported(packageInstance) {
+        return packageInstance.isCapabilityEnabled({ subtotals: {} });
+    }
+}

package/lib/features/VisualVersion.js

@@ -0,0 +1,12 @@
+import { Severity, Stage, VisualFeatureType } from "./FeatureTypes.js";
+export default class VisualVersion {
+    static featureName = "Visual version";
+    static expectedVersionLength = 4;
+    static errorMessage = `${this.featureName} should consist of ${this.expectedVersionLength} parts. Update the pbiviz.json file`;
+    static severity = Severity.Error;
+    static stage = Stage.PreBuild;
+    static visualFeatureType = VisualFeatureType.All;
+    static isSupported(visual) {
+        return visual.isVisualVersionValid(this.expectedVersionLength);
+    }
+}

package/lib/features/WarningIcon.js

@@ -0,0 +1,12 @@
+import { Severity, Stage, VisualFeatureType } from "./FeatureTypes.js";
+export default class WarningIcon {
+    static featureName = "Warning Icon";
+    static documentationLink = "https://learn.microsoft.com/en-us/power-bi/developer/visuals/visual-display-warning-icon";
+    static severity = Severity.Info;
+    static stage = Stage.PostBuild;
+    static visualFeatureType = VisualFeatureType.NonSlicer | VisualFeatureType.Slicer;
+    static errorMessage = `${this.featureName} - ${this.documentationLink}`;
+    static isSupported(packageInstance) {
+        return packageInstance.contain(".displayWarningIcon");
+    }
+}

package/lib/features/index.js

@@ -0,0 +1,28 @@
+import AdvancedEditMode from './AdvancedEditMode.js';
+import AllowInteractions from './AllowInteractions.js';
+import AnalyticsPane from './AnalyticsPane.js';
+import Bookmarks from './Bookmarks.js';
+import ColorPalette from './ColorPalette.js';
+import ConditionalFormatting from './ConditionalFormatting.js';
+import ContextMenu from './ContextMenu.js';
+import DrillDown from './DrillDown.js';
+import FetchMoreData from './FetchMoreData.js';
+import FileDownload from './FileDownload.js';
+import FormatPane from './FormatPane.js';
+import HighContrast from './HighContrast.js';
+import HighlightData from './HighlightData.js';
+import KeyboardNavigation from './KeyboardNavigation.js';
+import LandingPage from './LandingPage.js';
+import LaunchURL from './LaunchURL.js';
+import Localizations from './Localizations.js';
+import LocalStorage from './LocalStorage.js';
+import ModalDialog from './ModalDialog.js';
+import RenderingEvents from './RenderingEvents.js';
+import SelectionAcrossVisuals from './SelectionAcrossVisuals.js';
+import SyncSlicer from './SyncSlicer.js';
+import Tooltips from './Tooltips.js';
+import TotalSubTotal from './TotalSubTotal.js';
+import WarningIcon from './WarningIcon.js';
+import APIVersion from './APIVersion.js';
+import VisualVersion from './VisualVersion.js';
+export { AdvancedEditMode, AllowInteractions, AnalyticsPane, Bookmarks, ColorPalette, ConditionalFormatting, ContextMenu, DrillDown, FetchMoreData, FileDownload, FormatPane, HighContrast, HighlightData, KeyboardNavigation, LandingPage, LaunchURL, Localizations, LocalStorage, ModalDialog, RenderingEvents, SelectionAcrossVisuals, SyncSlicer, Tooltips, TotalSubTotal, WarningIcon, APIVersion, VisualVersion };

package/lib/utils.js

@@ -0,0 +1,43 @@
+import fs from 'fs-extra';
+import https from "https";
+import path from "path";
+import { fileURLToPath } from 'node:url';
+export function download(url, pathToFile) {
+    return new Promise((resolve, reject) => {
+        const fileStream = fs.createWriteStream(pathToFile);
+        https.get(url, (res) => {
+            res.pipe(fileStream);
+            fileStream.on('close', () => resolve(fileStream));
+            res.on('error', (error) => reject(error));
+        })
+            .on('error', (error) => reject(error));
+    });
+}
+export function createFolder(folderName) {
+    const folder = path.join("./", folderName);
+    fs.ensureDirSync(folder);
+    return folder;
+}
+export function getRootPath() {
+    const pathToDirectory = fileURLToPath(import.meta.url);
+    return path.join(pathToDirectory, "..", "..");
+}
+export function getJsPath(filePath) {
+    return filePath.replace(/\.json$/, '.mjs');
+}
+async function safelyImport(filePath) {
+    return fs.existsSync(filePath) && (await import(`file://${filePath}`)).default;
+}
+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

@@ -0,0 +1,169 @@
+import { getRootPath, readJsonFromRoot } from './utils.js';
+import MiniCssExtractPlugin from "mini-css-extract-plugin";
+import TerserPlugin from "terser-webpack-plugin";
+import path from "path";
+const config = await readJsonFromRoot("/config.json");
+const rootPath = getRootPath();
+const webpackConfig = {
+    entry: {
+        'visual.js': ['./src/visual.ts']
+    },
+    target: 'web',
+    node: false,
+    devtool: false,
+    mode: "production",
+    optimization: {
+        minimizer: [
+            new TerserPlugin({
+                parallel: true,
+                terserOptions: {}
+            })
+        ],
+        minimize: false,
+        concatenateModules: false
+    },
+    performance: {
+        maxEntrypointSize: 1024000,
+        maxAssetSize: 1024000,
+        hints: false
+    },
+    module: {
+        rules: [
+            {
+                parser: {
+                    amd: false
+                }
+            },
+            {
+                test: /\.m?js/,
+                resolve: {
+                    fullySpecified: false
+                }
+            },
+            {
+                test: /\.json$/,
+                loader: "json-loader",
+                type: "javascript/auto"
+            },
+            {
+                test: /(\.less)|(\.css)$/,
+                use: [
+                    {
+                        loader: MiniCssExtractPlugin.loader
+                    },
+                    {
+                        loader: "css-loader"
+                    },
+                    {
+                        loader: "less-loader",
+                        options: {
+                            lessOptions: {
+                                paths: [path.resolve(rootPath, 'node_modules')]
+                            }
+                        }
+                    }
+                ]
+            },
+            {
+                test: /\.(woff|ttf|ico|woff2|jpg|jpeg|png|webp|gif|svg|eot)$/i,
+                type: 'asset/inline'
+            }
+        ]
+    },
+    resolveLoader: {
+        modules: ['node_modules', path.resolve(rootPath, 'node_modules')],
+    },
+    externals: {
+        "powerbi-visuals-api": 'null',
+        // Prevent Node.js core modules from being bundled
+        "fs": "{}",
+        "path": "{}",
+        "os": "{}",
+        "crypto": "{}",
+        "http": "{}",
+        "https": "{}",
+        "url": "{}",
+        "util": "{}",
+        "stream": "{}",
+        "buffer": "{}",
+        "process": "{}",
+        "events": "{}",
+        "child_process": "{}",
+        "cluster": "{}",
+        "dgram": "{}",
+        "dns": "{}",
+        "net": "{}",
+        "readline": "{}",
+        "repl": "{}",
+        "tls": "{}",
+        "tty": "{}",
+        "zlib": "{}",
+        "constants": "{}",
+        "vm": "{}",
+        "assert": "{}"
+    },
+    resolve: {
+        symlinks: false,
+        extensions: ['.tsx', '.ts', '.jsx', '.js', '.mjs', '.css'],
+        modules: ['node_modules', path.resolve(rootPath, 'node_modules')],
+        fallback: {
+            assert: false,
+            buffer: false,
+            console: false,
+            constants: false,
+            crypto: false,
+            domain: false,
+            events: false,
+            http: false,
+            https: false,
+            os: false,
+            path: false,
+            punycode: false,
+            process: false,
+            querystring: false,
+            stream: false,
+            _stream_duplex: false,
+            _stream_passthrough: false,
+            _stream_readable: false,
+            _stream_transform: false,
+            _stream_writable: false,
+            string_decoder: false,
+            sys: false,
+            timers: false,
+            tty: false,
+            url: false,
+            util: false,
+            vm: false,
+            zlib: false
+        }
+    },
+    output: {
+        path: null,
+        publicPath: 'assets',
+        filename: "[name]"
+    },
+    devServer: {
+        allowedHosts: "all",
+        static: {
+            directory: null
+        },
+        compress: true,
+        port: 8080,
+        hot: false,
+        server: 'https',
+        headers: {
+            "access-control-allow-origin": "*",
+            "cache-control": "public, max-age=0"
+        }
+    },
+    watchOptions: {
+        ignored: ['node_modules/**']
+    },
+    plugins: [
+        new MiniCssExtractPlugin({
+            filename: config.build.css,
+            chunkFilename: "[id].css"
+        })
+    ]
+};
+export default webpackConfig;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "powerbi-visuals-tools",
-  "version": "7.0.0",
+  "version": "7.0.1",
   "description": "Command line tool for creating and publishing visuals for Power BI",
   "main": "./bin/pbiviz.js",
   "type": "module",
@@ -40,27 +40,28 @@
     "inline-source-map": "^0.6.3",
     "json-loader": "0.5.7",
     "jszip": "^3.10.1",
-    "less": "^4.4.1",
+    "less": "^4.4.2",
     "less-loader": "^12.3.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.4",
+    "powerbi-visuals-api": "~5.3.0",
     "powerbi-visuals-webpack-plugin": "^4.3.1",
     "terser-webpack-plugin": "^5.3.14",
     "ts-loader": "^9.5.4",
     "typescript": "^5.9.3",
-    "webpack": "^5.102.0",
+    "webpack": "^5.103.0",
     "webpack-bundle-analyzer": "4.10.2",
     "webpack-dev-server": "^5.2.2"
   },
   "devDependencies": {
-    "@typescript-eslint/eslint-plugin": "^8.45.0",
-    "eslint": "^9.36.0",
+    "@typescript-eslint/eslint-plugin": "^8.47.0",
+    "eslint": "^9.39.1",
     "jasmine": "5.3.1",
     "jasmine-spec-reporter": "7.0.0",
-    "semver": "7.7.2",
+    "semver": "7.7.3",
     "tree-kill": "1.2.2",
     "webpack-cli": "^6.0.1"
   },

package/.eslintrc.json

@@ -1,21 +0,0 @@
-{
-    "env": {
-        "es6": true,
-        "node": true
-    },
-	"parser": "@typescript-eslint/parser",
-    "extends": "eslint:recommended",
-    "plugins": [
-        "@typescript-eslint"
-    ],
-    "parserOptions": {
-        "ecmaVersion": 2023,
-        "sourceType": "module",
-	    "project": "tsconfig.json",
-	    "tsconfigRootDir": "."
-    },
-    "rules": {
-        "no-unused-vars": "off",
-        "@typescript-eslint/no-unused-vars": "error"
-    }
-}

package/CVClientLA.md

@@ -1,85 +0,0 @@
-**POWER BI CUSTOM VISUALS – STANDARD VISUALIZATION LICENSE TERMS**
-
-These license terms are an agreement between you and the visualization developer. Please read them. 
-They apply to the visualization for Power BI you download from the Public AppSource store, including any updates 
-or supplements for the visualization (the “Visualization”), unless the Visualization comes with separate 
-terms, in which case those terms apply.  
-
-**BY DOWNLOADING OR USING THE VISUALIZATION, OR ATTEMPTING TO DO ANY OF THESE, YOU 
-ACCEPT THESE TERMS. IF YOU DO NOT ACCEPT THEM, YOU HAVE NO RIGHT TO AND MUST NOT 
-DOWNLOAD OR USE THE VISUALIZATION.** 
-
-**The Visualization developer means the entity licensing the Visualization to you, as identified in the 
-Public AppSource store.**  
-
-**If you comply with these license terms, you have the rights below.**
-
-1. **INSTALLATION AND USE RIGHTS.** You may install and use any number of copies of the Visualization 
-for use with a product or service that supports the Power BI visual interface.  
-
-2. **INTERNET-BASED SERVICES.**  
-**a. Consent for Internet-Based or Wireless Services.** The Visualization connects to computer systems 
-over the Internet, which may include via a wireless network. Using the Visualization operates as your 
-consent to the transmission of standard device information (including but not limited to technical 
-information about your device, system and Visualization software, and peripherals) for internet-based 
-or wireless services.  
-**b. Misuse of Internet-based Services.** You may not use any Internet-based service in any way that could 
-harm it or impair anyone else’s use of it or the wireless network. You may not use the service to try to 
-gain unauthorized access to any service, data, account or network by any means.  
-3. **SCOPE OF LICENSE.** The Visualization is licensed, not sold. This agreement only gives you some rights 
-to use the Visualization. Visualization developer reserves all other rights. Unless applicable law gives you 
-more rights despite this limitation, you may use the Visualization only as expressly permitted in this 
-agreement. You may not  
-• work around any technical limitations in the Visualization; or 
-• reverse engineer, decompile or disassemble the Visualization, except and only to the extent that 
-applicable law expressly permits, despite this limitation.  
-4. **DOCUMENTATION.** If documentation is provided with the Visualization, you may copy and use the 
-documentation for personal reference purposes.  
-5. **TECHNOLOGY AND EXPORT RESTRICTIONS.** The Visualization may be subject to United States or 
-international technology control or export laws and regulations. You must comply with all domestic and 
-international export laws and regulations that apply to the technology used or supported by the 
-Visualization. These laws include restrictions on destinations, end users and end use. For information on 
-Microsoft branded products, see www.microsoft.com/exporting.  
-6. **SUPPORT SERVICES.** Microsoft is not responsible for providing support services for the Visualization. If 
-Microsoft is the Visualization developer, it may provide support services, but is not obligated to do so 
-under this agreement. Contact the Visualization developer to determine what support services are 
-available.  
-7. **ENTIRE AGREEMENT.** This agreement, any applicable Visualization developer privacy policy, and the 
-terms for supplements and updates are the entire agreement between you and Visualization developer 
-for the Visualization. If Microsoft is the Visualization developer, this agreement does not change the 
-terms of your relationship with Microsoft with regard to Power BI, Microsoft Office, the Public AppSource store, or 
-any other Microsoft product or service (which is governed by the software license terms that 
-accompanied, or terms of use that are associated with, the applicable product or service).  
-8. **APPLICABLE LAW.**  
-a. **United States. If you acquired the Visualization in the United States, Washington state law governs 
-the interpretation of this agreement and applies to claims for breach of it, regardless of conflict of 
-laws principles. The laws of the state where you live govern all other claims, including claims under 
-state consumer protection laws, unfair competition laws, and in tort.**
-b. **Outside the United States. If you acquired the Visualization in any other country, the laws of that 
-country apply.**
-
-9. **LEGAL EFFECT.** This agreement describes certain legal rights. You may have other rights under the 
-laws of your state or country. This agreement does not change your rights under the laws of your state 
-or country if the laws of your state or country do not permit it to do so.  
-10. **DISCLAIMER OF WARRANTY. TO THE FULLEST EXTENT PERMITTED BY LAW, (A) THE VISUALIZATION 
-IS LICENSED "AS-IS," "WITH ALL FAULTS," AND "AS AVAILABLE" AND YOU BEAR ALL RISK OF USING IT; 
-(B) THE VISUALIZATION DEVELOPER, ON BEHALF OF ITSELF, MICROSOFT (IF MICROSOFT IS NOT THE 
-VISUALIZATION DEVELOPER), AND EACH OF OUR RESPECTIVE AFFILIATES, VENDORS, AGENTS AND 
-SUPPLIERS, GIVES NO EXPRESS WARRANTIES, GUARANTEES, OR CONDITIONS IN RELATION TO THE 
-VISUALIZATION; (C) YOU MAY HAVE ADDITIONAL CONSUMER RIGHTS UNDER YOUR LOCAL LAWS 
-THAT THIS AGREEMENT CANNOT CHANGE; AND (D) VISUALIZATION DEVELOPER AND MICROSOFT 
-EXCLUDE ANY IMPLIED WARRANTIES OR CONDITIONS, INCLUDING THOSE OF MERCHANTABILITY, 
-FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.**  
-11. **LIMITATION ON AND EXCLUSION OF REMEDIES AND DAMAGES. TO THE EXTENT NOT PROHIBITED 
-BY LAW, YOU CAN RECOVER FROM THE VISUALIZATION DEVELOPER ONLY DIRECT DAMAGES UP TO 
-THE AMOUNT YOU PAID FOR THE VISUALIZATION OR $1.00, WHICHEVER IS GREATER. YOU WILL NOT, 
-AND WAIVE ANY RIGHT TO, SEEK TO RECOVER ANY OTHER DAMAGES, INCLUDING CONSEQUENTIAL, 
-LOST PROFITS, SPECIAL, INDIRECT OR INCIDENTAL DAMAGES FROM THE VISUALIZATION DEVELOPER.**  
-**This limitation applies to  
-• anything related to the Visualization or services made available through the Visualization; and  
-• claims for breach of contract, breach of warranty, guarantee or condition, strict liability, negligence, 
-or other tort to the extent permitted by applicable law.  
-It also applies even if  
-• repair, replacement or a refund for the Visualization does not fully compensate you for any losses; 
-or  
-• Visualization developer knew or should have known about the possibility of the damages.**