powerbi-visuals-tools 4.0.4 → 4.0.6

package/spec/helpers/FileSystem.js

@@ -0,0 +1,173 @@
+/*
+ *  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";
+
+let fs = require('fs-extra');
+let path = require('path');
+let childProcess = require('child_process');
+let treeKill = require('tree-kill');
+
+const TEMP_DIR = path.join(__dirname, '..', '.tmp');
+const BIN_PATH = path.join(__dirname, '..', '..', 'bin', 'pbiviz.js');
+const TEMPLATE_PATH = path.join(__dirname, '..', '..', 'templates');
+
+class FileSystem {
+    static expectFileToExist(fileName) {
+        return new Promise((resolve, reject) => {
+            fs.exists(fileName, (exist) => {
+                if (exist) {
+                    resolve();
+                } else {
+                    reject(new Error(`File ${fileName} was expected to exist but not found...`));
+                }
+            });
+        });
+    }
+
+    static readFile(fileName) {
+        return new Promise((resolve, reject) => {
+            fs.readFile(fileName, 'utf-8', (err, data) => {
+                if (err) {
+                    reject(err);
+                } else {
+                    resolve(data);
+                }
+            });
+        });
+    }
+
+    static expectFileToMatch(fileName, regEx) {
+        return FileSystem.readFile(fileName)
+            .then(content => {
+                if (typeof regEx == 'string') {
+                    if (content.indexOf(regEx) == -1) {
+                        throw new Error(`File "${fileName}" did not contain "${regEx}"...`);
+                    }
+                } else if (!content.match(regEx)) {
+                        throw new Error(`File "${fileName}" did not contain "${regEx}"...`);
+                    }
+            });
+    }
+
+    static getBinPath() {
+        return BIN_PATH;
+    }
+
+    static getTempPath() {
+        return TEMP_DIR;
+    }
+
+    static getTemplatePath() {
+        return TEMPLATE_PATH;
+    }
+
+    /**
+     * Creates the temp directory (deletes it first if it exists) 
+     */
+    static resetTempDirectory() {
+        FileSystem.deleteTempDirectory();
+        fs.ensureDirSync(TEMP_DIR);
+    }
+
+    /**
+     * Deletes the temporary directory if it exists
+     */
+    static deleteTempDirectory() {
+        try {
+            fs.removeSync(TEMP_DIR);
+        } catch (e) {
+            console.log('DELETE ERROR', e);
+        }
+    }
+
+    /**
+     * Executes the pbiviz CLI
+     * 
+     * @param {string} command - the command to be executed
+     * @param {string} [args=''] - arguments for the command
+     * @param {string} [flags=''] - command line flags
+     * @param {boolean} [verbose = false] - enables verbose output
+     */
+    static runPbiviz(command, args, flags, verbose) {
+        let opts = verbose ? undefined : { stdio: [] }; // eslint-disable-line no-undefined
+
+        flags = flags ? ' ' + flags : '';
+        args = args ? ' ' + args : '';
+        let pbivizCmd = command + args + flags;
+        if (verbose) { console.log('run:', 'node ' + BIN_PATH + ' ' + pbivizCmd); }
+        return childProcess.execSync('node ' + BIN_PATH + ' ' + pbivizCmd, opts);
+    }
+
+    /**
+     * Executes console commands
+     * 
+     * @param {string} command - the command to be executed
+     * @param {string} pathToExec - path where to execute command
+     * @param {string} pathToReturn - path to return after command execution
+     */
+    static runCMDCommand(command, pathToExec, pathToReturn) {
+        process.chdir(pathToExec);
+        childProcess.execSync('npm i --silent');
+        if (pathToReturn) {
+            process.chdir(pathToReturn);
+        }
+    }
+
+    /**
+     * Executes the pbiviz CLI
+     * 
+     * @param {string} command - the command to be executed
+     * @param {array} [args = []] - arguments for the command
+     * @param {boolean} [verbose = false] - enables verbose output
+     */
+    static runPbivizAsync(command, args, verbose) {
+        if (verbose) { console.log('run:', 'node ' + BIN_PATH + ' ' + command, args || ''); }
+
+        let spawnCmd = [BIN_PATH, command];
+        if (args) { spawnCmd = spawnCmd.concat(args); }
+        return childProcess.spawn('node', spawnCmd);
+    }
+
+    /**
+     * Kills a process on any platform
+     * 
+     * @param {object} childProcess - child process to kill
+     * @param {string} [signal] - signal to send ot the process
+     * @param {function} [callback] - callback called after all processes are terminated
+     */
+    static killProcess(childProcess, signal, callback) {
+        let pid = childProcess.pid || childProcess.PID;
+        treeKill(pid, signal, (error) => {
+            if (callback) {
+                callback(error || null);
+            }
+        });
+    }
+
+}
+
+module.exports = FileSystem;

package/spec/jasmine-runner.js

@@ -0,0 +1,36 @@
+/*
+ *  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";
+
+let Jasmine = require('jasmine');
+let SpecReporter = require('jasmine-spec-reporter').SpecReporter;
+
+let jrunner = new Jasmine();
+jrunner.configureDefaultReporter({ print: () => {} }); // eslint-disable-line no-empty-function
+jasmine.getEnv().addReporter(new SpecReporter());
+jrunner.loadConfigFile();
+jrunner.execute();

package/spec/support/jasmine.json

@@ -0,0 +1,11 @@
+{
+  "spec_dir": "spec",
+  "spec_files": [
+    "**/*[sS]pec.js"
+  ],
+  "helpers": [
+
+  ],
+  "stopSpecOnExpectationFailure": false,
+  "random": false
+}

package/templates/visuals/default/capabilities.json

@@ -13,10 +13,8 @@
     ],
     "objects": {
         "dataPoint": {
-            "displayName": "Data colors",
             "properties": {
                 "defaultColor": {
-                    "displayName": "Default color",
                     "type": {
                         "fill": {
                             "solid": {
@@ -26,13 +24,11 @@
                     }
                 },
                 "showAllDataPoints": {
-                    "displayName": "Show all",
                     "type": {
                         "bool": true
                     }
                 },
                 "fill": {
-                    "displayName": "Fill",
                     "type": {
                         "fill": {
                             "solid": {
@@ -42,13 +38,11 @@
                     }
                 },
                 "fillRule": {
-                    "displayName": "Color saturation",
                     "type": {
                         "fill": {}
                     }
                 },
                  "fontSize": {
-                    "displayName": "Text Size",
                     "type": {
                         "formatting": {
                             "fontSize": true
@@ -80,5 +74,6 @@
                 }
             }
         }
-    ]
+    ],
+    "privileges": []
 }

package/templates/visuals/default/package.json

@@ -15,8 +15,8 @@
   "dependencies": {
     "@types/d3": "5.7.2",
     "d3": "5.12.0",
-    "powerbi-visuals-utils-dataviewutils": "2.2.1",
-    "powerbi-visuals-api": "~3.8.0"
+    "powerbi-visuals-api": "5.1.0",
+    "powerbi-visuals-utils-formattingmodel": "5.0.0"
   },
   "devDependencies": {
     "ts-loader": "6.1.0",

package/templates/visuals/default/pbiviz.json

@@ -1,5 +1,5 @@
 {
-    "apiVersion": "3.8.0",
+    "apiVersion": "5.1.0",
     "externalJS": null,
     "dependencies": null
 }

package/templates/visuals/default/src/settings.ts

@@ -26,7 +26,58 @@
 
 "use strict";
 
-import { dataViewObjectsParser } from "powerbi-visuals-utils-dataviewutils";
-import DataViewObjectsParser = dataViewObjectsParser.DataViewObjectsParser;
+import { formattingSettings } from "powerbi-visuals-utils-formattingmodel";
 
-<%= visualSettingsClasses %>
+import FormattingSettingsCard = formattingSettings.Card;
+import FormattingSettingsSlice = formattingSettings.Slice;
+import FormattingSettingsModel = formattingSettings.Model;
+
+/**
+ * Data Point Formatting Card
+ */
+class DataPointCardSettings extends FormattingSettingsCard {
+    defaultColor = new formattingSettings.ColorPicker({
+        name: "defaultColor",
+        displayName: "Default color",
+        value: { value: "" }
+    });
+
+    showAllDataPoints = new formattingSettings.ToggleSwitch({
+        name: "showAllDataPoints",
+        displayName: "Show all",
+        value: true
+    });
+
+    fill = new formattingSettings.ColorPicker({
+        name: "fill",
+        displayName: "Fill",
+        value: { value: "" }
+    });
+
+    fillRule = new formattingSettings.ColorPicker({
+        name: "fillRule",
+        displayName: "Color saturation",
+        value: { value: "" }
+    });
+
+    fontSize = new formattingSettings.NumUpDown({
+        name: "fontSize",
+        displayName: "Text Size",
+        value: 12
+    });
+
+    name: string = "dataPoint";
+    displayName: string = "Data colors";
+    slices: Array<FormattingSettingsSlice> = [this.defaultColor, this.showAllDataPoints, this.fill, this.fillRule, this.fontSize];
+}
+
+/**
+* visual settings model class
+*
+*/
+export class VisualFormattingSettingsModel extends FormattingSettingsModel {
+    // Create formatting settings model formatting cards
+    dataPointCard = new DataPointCardSettings();
+
+    cards = [this.dataPointCard];
+}

package/templates/visuals/default/src/visual.ts

@@ -25,25 +25,26 @@
 */
 "use strict";
 
-import "./../style/visual.less";
 import powerbi from "powerbi-visuals-api";
+import { FormattingSettingsService } from "powerbi-visuals-utils-formattingmodel";
+import "./../style/visual.less";
+
 import VisualConstructorOptions = powerbi.extensibility.visual.VisualConstructorOptions;
 import VisualUpdateOptions = powerbi.extensibility.visual.VisualUpdateOptions;
 import IVisual = powerbi.extensibility.visual.IVisual;
-import EnumerateVisualObjectInstancesOptions = powerbi.EnumerateVisualObjectInstancesOptions;
-import VisualObjectInstance = powerbi.VisualObjectInstance;
-import DataView = powerbi.DataView;
-import VisualObjectInstanceEnumerationObject = powerbi.VisualObjectInstanceEnumerationObject;
 
-import { VisualSettings } from "./settings";
+import { VisualFormattingSettingsModel } from "./settings";
+
 export class Visual implements IVisual {
     private target: HTMLElement;
     private updateCount: number;
-    private settings: VisualSettings;
     private textNode: Text;
+    private formattingSettings: VisualFormattingSettingsModel;
+    private formattingSettingsService: FormattingSettingsService;
 
     constructor(options: VisualConstructorOptions) {
         console.log('Visual constructor', options);
+        this.formattingSettingsService = new FormattingSettingsService();
         this.target = options.element;
         this.updateCount = 0;
         if (document) {
@@ -58,23 +59,19 @@ export class Visual implements IVisual {
     }
 
     public update(options: VisualUpdateOptions) {
-        this.settings = Visual.parseSettings(options && options.dataViews && options.dataViews[0]);
+        this.formattingSettings = this.formattingSettingsService.populateFormattingSettingsModel(VisualFormattingSettingsModel, options.dataViews);
+
         console.log('Visual update', options);
         if (this.textNode) {
             this.textNode.textContent = (this.updateCount++).toString();
         }
     }
 
-    private static parseSettings(dataView: DataView): VisualSettings {
-        return <VisualSettings>VisualSettings.parse(dataView);
-    }
-
     /**
-     * This function gets called for each of the objects defined in the capabilities files and allows you to select which of the
-     * objects and properties you want to expose to the users in the property pane.
-     *
+     * Returns properties pane formatting model content hierarchies, properties and latest formatting values, Then populate properties pane.
+     * This method is called once every time we open properties pane or when the user edit any format property. 
      */
-    public enumerateObjectInstances(options: EnumerateVisualObjectInstancesOptions): VisualObjectInstance[] | VisualObjectInstanceEnumerationObject {
-        return VisualSettings.enumerateObjectInstances(this.settings || VisualSettings.getDefault(), options);
+    public getFormattingModel(): powerbi.visuals.FormattingModel {
+        return this.formattingSettingsService.buildFormattingModel(this.formattingSettings);
     }
 }

package/templates/visuals/rhtml/capabilities.json

@@ -58,5 +58,6 @@
       }
     }
   },
-  "suppressDefaultTitle": true
+  "suppressDefaultTitle": true,
+  "privileges": []
 }

package/templates/visuals/rhtml/package.json

@@ -1,10 +1,10 @@
 {
   "name": "visual",
   "dependencies": {
-    "powerbi-visuals-utils-dataviewutils": "^2.2.1"
+    "powerbi-visuals-utils-formattingmodel": "5.0.0"
   },
   "devDependencies": {
-    "powerbi-visuals-api": "~3.8.0",
+    "powerbi-visuals-api": "5.1.0",
     "ts-loader": "6.1.0",
     "tslint": "^5.18.0",
     "tslint-microsoft-contrib": "^6.2.0",

package/templates/visuals/rhtml/pbiviz.json

@@ -1,4 +1,4 @@
 {
-    "apiVersion": "3.8.0",
+    "apiVersion": "5.1.0",
     "externalJS": null
 }

package/templates/visuals/rhtml/src/settings.ts

@@ -26,7 +26,32 @@
 
 "use strict";
 
-import { dataViewObjectsParser } from "powerbi-visuals-utils-dataviewutils";
-import DataViewObjectsParser = dataViewObjectsParser.DataViewObjectsParser;
+import { formattingSettings } from "powerbi-visuals-utils-formattingmodel";
 
-<%= visualSettingsClasses %>
+import FormattingSettingsCard = formattingSettings.Card;
+import FormattingSettingsSlice = formattingSettings.Slice;
+import FormattingSettingsModel = formattingSettings.Model;
+
+
+/**
+ * RCV Script Formatting Card
+ */
+class rcvScriptCardSettings extends FormattingSettingsCard {
+    provider: FormattingSettingsSlice = undefined;
+    source: FormattingSettingsSlice = undefined;
+
+    name: string = "rcv_script";
+    displayName: string = "rcv_script";
+    slices: Array<FormattingSettingsSlice> = [this.provider, this.source];
+}
+
+/**
+* visual settings model class
+*
+*/
+export class VisualFormattingSettingsModel extends FormattingSettingsModel {
+    // Create formatting settings model formatting cards
+    rcvScriptCard = new rcvScriptCardSettings();
+
+    cards = [this.rcvScriptCard];
+}

package/templates/visuals/rhtml/src/visual.ts

@@ -25,17 +25,16 @@
 */
 "use strict";
 import powerbi from "powerbi-visuals-api";
+import { formattingSettings, FormattingSettingsService } from "powerbi-visuals-utils-formattingmodel";
+
 import VisualConstructorOptions = powerbi.extensibility.visual.VisualConstructorOptions;
 import VisualUpdateOptions = powerbi.extensibility.visual.VisualUpdateOptions;
 import IVisual = powerbi.extensibility.visual.IVisual;
-import EnumerateVisualObjectInstancesOptions = powerbi.EnumerateVisualObjectInstancesOptions;
-import VisualObjectInstance = powerbi.VisualObjectInstance;
 import DataView = powerbi.DataView;
 import IViewport = powerbi.IViewport;
-import VisualObjectInstanceEnumerationObject = powerbi.VisualObjectInstanceEnumerationObject;
 
-import { VisualSettings } from "./settings";
 import { parseElement, resetInjector, runHTMLWidgetRenderer } from "./htmlInjectionUtility";
+import { VisualFormattingSettingsModel } from "./settings";
 
 enum VisualUpdateType {
     Data = 2,
@@ -47,19 +46,30 @@ enum VisualUpdateType {
 }
 
 // below is a snippet of a definition for an object which will contain the property values
-// selected by the users
-/*interface VisualSettings {
-    lineColor: string;
+/*class settingsCardSettings extends FormattingSettingsCard {
+    lineColor: FormattingSettingsSlice =  new formattingSettings.ColorPicker({
+        name: "lineColor",
+        displayName: "Line Color",
+        value: { value: "#000000" }
+    });
+
+    name: string = "settings";
+    displayName: string = "Visual Settings";
+    description: string = "Visual Settings Tooltip";
+    slices: Array<FormattingSettingsSlice> = [this.lineColor];
+}
+
+export class VisualFormattingSettingsModel extends FormattingSettingsModel {
+    settingsCard = new settingsCardSettings();
+
+    cards = [this.settingsCard];
 }*/
 
 // to allow this scenario you should first the following JSON definition to the capabilities.json file
 // under the "objects" property:
 // "settings": {
-//     "displayName": "Visual Settings",
-//     "description": "Visual Settings Tooltip",
 //     "properties": {
 //         "lineColor": {
-//         "displayName": "Line Color",
 //         "type": { "fill": { "solid": { "color": true }}}
 //         }
 //     }
@@ -78,9 +88,11 @@ export class Visual implements IVisual {
     private rootElement: HTMLElement;
     private headNodes: Node[];
     private bodyNodes: Node[];
-    private settings: VisualSettings;
+    private formattingSettings: VisualFormattingSettingsModel;
+    private formattingSettingsService: FormattingSettingsService;
 
     public constructor(options: VisualConstructorOptions) {
+        this.formattingSettingsService = new FormattingSettingsService();
         if (options && options.element) {
             this.rootElement = options.element;
         }
@@ -89,7 +101,6 @@ export class Visual implements IVisual {
     }
 
     public update(options: VisualUpdateOptions): void {
-
         if (!options ||
             !options.type ||
             !options.viewport ||
@@ -98,8 +109,9 @@ export class Visual implements IVisual {
             !options.dataViews[0]) {
             return;
         }
+
         const dataView: DataView = options.dataViews[0];
-        this.settings = Visual.parseSettings(dataView);
+        this.formattingSettings = this.formattingSettingsService.populateFormattingSettingsModel(VisualFormattingSettingsModel, options.dataViews);
 
         let payloadBase64: string = null;
         if (dataView.scriptResult && dataView.scriptResult.payloadBase64) {
@@ -168,17 +180,11 @@ export class Visual implements IVisual {
         runHTMLWidgetRenderer();
     }
 
-    private static parseSettings(dataView: DataView): VisualSettings {
-        return <VisualSettings>VisualSettings.parse(dataView);
-    }
-
     /**
-     * This function gets called for each of the objects defined in the capabilities files and allows you to select which of the
-     * objects and properties you want to expose to the users in the property pane.
-     *
+     * Returns properties pane formatting model content hierarchies, properties and latest formatting values, Then populate properties pane.
+     * This method is called once every time we open properties pane or when the user edit any format property. 
      */
-    public enumerateObjectInstances(options: EnumerateVisualObjectInstancesOptions):
-        VisualObjectInstance[] | VisualObjectInstanceEnumerationObject {
-        return VisualSettings.enumerateObjectInstances(this.settings || VisualSettings.getDefault(), options);
+    public getFormattingModel(): powerbi.visuals.FormattingModel {
+        return this.formattingSettingsService.buildFormattingModel(this.formattingSettings);
     }
 }

package/templates/visuals/rvisual/capabilities.json

@@ -58,5 +58,6 @@
       }
     }
   },
-  "suppressDefaultTitle": true
+  "suppressDefaultTitle": true,
+  "privileges": []
 }

package/templates/visuals/rvisual/package.json

@@ -1,10 +1,10 @@
 {
   "name": "visual",
   "dependencies": {
-    "powerbi-visuals-utils-dataviewutils": "^2.2.1"
+    "powerbi-visuals-utils-formattingmodel": "5.0.0"
   },
   "devDependencies": {
-    "powerbi-visuals-api": "~3.8.0",
+    "powerbi-visuals-api": "5.1.0",
     "tslint": "^5.18.0",
     "tslint-microsoft-contrib": "^6.2.0",
     "typescript": "3.6.3"

package/templates/visuals/rvisual/pbiviz.json

@@ -1,4 +1,4 @@
 {
-    "apiVersion": "3.8.0",
+    "apiVersion": "5.1.0",
     "externalJS": null
 }

package/templates/visuals/rvisual/src/settings.ts

@@ -26,7 +26,32 @@
 
 "use strict";
 
-import { dataViewObjectsParser } from "powerbi-visuals-utils-dataviewutils";
-import DataViewObjectsParser = dataViewObjectsParser.DataViewObjectsParser;
+import { formattingSettings } from "powerbi-visuals-utils-formattingmodel";
 
-<%= visualSettingsClasses %>
+import FormattingSettingsCard = formattingSettings.Card;
+import FormattingSettingsSlice = formattingSettings.Slice;
+import FormattingSettingsModel = formattingSettings.Model;
+
+
+/**
+ * RCV Script Formatting Card
+ */
+class rcvScriptCardSettings extends FormattingSettingsCard {
+    provider: FormattingSettingsSlice = undefined;
+    source: FormattingSettingsSlice = undefined;
+
+    name: string = "rcv_script";
+    displayName: string = "rcv_script";
+    slices: Array<FormattingSettingsSlice> = [this.provider, this.source];
+}
+
+/**
+* visual settings model class
+*
+*/
+export class VisualFormattingSettingsModel extends FormattingSettingsModel {
+    // Create formatting settings model formatting cards
+    rcvScriptCard = new rcvScriptCardSettings();
+
+    cards = [this.rcvScriptCard];
+}