Initial Commit of powerbi-models. Has interfaces which are shared between host and iframe code.

Author: mattmazzola

.gitignore

@@ -0,0 +1,5 @@
+node_modules
+coverage
+typings
+dist
+tmp

LICENSE.txt

@@ -0,0 +1,13 @@
+powerbi-models
+
+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.

README.md

@@ -1,2 +1,29 @@
 # powerbi-models
-Contains JavaScript & TypeScript object models for Microsoft Power BI JavaScript SDK
+
+Collection of functions to validate PowerBI messages using json schema.  Also contains shared interfaces for all messages to ensure host and iframe agree.
+
+## Getting Started
+
+Install
+```
+npm install --save powerbi-models
+```
+
+Import
+```
+import * as models from 'powerbi-models';
+```
+
+Usage
+```
+let testObject = { x: 1 };
+
+const errors = models.validateLoad(testObject);
+
+if(errors) {
+  console.warn(errors) 
+}
+
+...
+
+```

gulpfile.js

@@ -0,0 +1,66 @@
+var gulp = require('gulp-help')(require('gulp'));
+var rename = require('gulp-rename'),
+    replace = require('gulp-replace'),
+    uglify = require('gulp-uglify'),
+    karma = require('karma'),
+    webpack = require('webpack-stream'),
+    webpackConfig = require('./webpack.config'),
+    webpackTestConfig = require('./webpack.test.config'),
+    runSequence = require('run-sequence'),
+    argv = require('yargs').argv;
+    ;
+
+gulp.task('build', 'Build for release', function (done) {
+    return runSequence(
+        'compile:ts',
+        'min',
+        'generatecustomdts',
+        done
+    );
+});
+
+gulp.task('test', 'Runs all tests', function (done) {
+    return runSequence(
+        'compile:spec',
+        'test:js',
+        done
+    );
+});
+
+gulp.task('compile:ts', 'Compile source files', function() {
+    return gulp.src(['typings/**/*.d.ts', './src/**/*.ts'])
+        .pipe(webpack(webpackConfig))
+        .pipe(gulp.dest('./dist'));
+});
+
+gulp.task('min', 'Minify build files', function () {
+    return gulp.src(['./dist/models.js'])
+        .pipe(uglify())
+        .pipe(rename({
+            suffix: '.min'
+        }))
+        .pipe(gulp.dest('./dist/'));
+});
+
+gulp.task('compile:spec', 'Compile spec tests', function () {
+    return gulp.src(['./test/test.spec.ts'])
+        .pipe(webpack(webpackTestConfig))
+        .pipe(gulp.dest('./tmp'));
+});
+
+gulp.task('generatecustomdts', 'Generate dts with no exports', function (done) {
+    return gulp.src(['./dist/*.d.ts'])
+        .pipe(replace(/export\s/g, ''))
+        .pipe(rename(function (path) {
+            path.basename = "httpPostMessage-noexports.d";
+        }))
+        .pipe(gulp.dest('dist/'));
+});
+
+gulp.task('test:js', 'Run spec tests', function (done) {
+    new karma.Server.start({
+        configFile: __dirname + '/karma.conf.js',
+        singleRun: argv.debug ? false : true,
+        captureTimeout: argv.timeout || 60000
+    }, done);
+});

karma.conf.js

@@ -0,0 +1,29 @@
+var argv = require('yargs').argv;
+
+module.exports = function (config) {
+    config.set({
+        frameworks: ['jasmine'],
+        files: [
+            './tmp/**/*.js'
+        ],
+        exclude: [],
+        reporters: argv.debug ? ['spec'] : ['spec', 'coverage'],
+        autoWatch: true,
+        browsers: [argv.chrome ? 'Chrome' : 'PhantomJS'],
+        plugins: [
+            'karma-chrome-launcher',
+            'karma-jasmine',
+            'karma-spec-reporter',
+            'karma-phantomjs-launcher',
+            'karma-coverage'
+        ],
+        preprocessors: { './tmp/**/*.js': ['coverage'] },
+        coverageReporter: {
+            reporters: [
+                { type: 'html' },
+                { type: 'text-summary' }
+            ]
+        },
+        logLevel: argv.debug ? config.LOG_DEBUG : config.LOG_INFO
+    });
+};

package.json

@@ -0,0 +1,53 @@
+{
+  "name": "powerbi-models",
+  "version": "0.1.0",
+  "description": "Collection of functions to validate PowerBI messages using json schema.  Also contains shared interfaces for all messages to ensure host and iframe agree.",
+  "main": "index.js",
+  "directories": {
+    "test": "test"
+  },
+  "scripts": {
+    "prepublish": "gulp build",
+    "test": "gulp test --chrome"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://pbix.visualstudio.com/DefaultCollection/PaaS/_git/powerbi-models"
+  },
+  "keywords": [
+    "Microsoft",
+    "PowerBI",
+    "message",
+    "validation",
+    "json",
+    "schema"
+  ],
+  "author": "Microsoft PowerBI Team",
+  "license": "MIT",
+  "devDependencies": {
+    "gulp": "^3.9.1",
+    "gulp-help": "^1.6.1",
+    "gulp-rename": "^1.2.2",
+    "gulp-replace": "^0.5.4",
+    "gulp-uglify": "^1.5.4",
+    "jasmine-core": "^2.4.1",
+    "json-loader": "^0.5.4",
+    "karma": "^0.13.22",
+    "karma-chrome-launcher": "^1.0.1",
+    "karma-coverage": "^1.0.0",
+    "karma-jasmine": "^1.0.2",
+    "karma-phantomjs-launcher": "^1.0.0",
+    "karma-spec-reporter": "0.0.26",
+    "phantomjs-prebuilt": "^2.1.7",
+    "run-sequence": "^1.2.1",
+    "ts-loader": "^0.8.2",
+    "webpack-stream": "^3.2.0",
+    "yargs": "^4.7.1"
+  },
+  "publishConfig": {
+    "tag": "beta"
+  },
+  "dependencies": {
+    "jsen": "^0.6.1"
+  }
+}

src/models.ts

@@ -0,0 +1,98 @@
+declare var require: Function;
+
+export const settingsSchema = require('./schemas/settings.json');
+export const loadSchema = require('./schemas/load.json');
+export const pageTargetSchema = require('./schemas/pageTarget.json');
+export const visualTargetSchema = require('./schemas/visualTarget.json');
+export const pageSchema = require('./schemas/page.json');
+
+import * as jsen from 'jsen';
+
+interface IValidationError {
+  path: string;
+  keyword: string;
+  message: string;
+}
+
+export interface IError {
+  message: string;
+}
+
+function normalizeError(error: IValidationError): IError {
+  if(!error.message) {
+    error.message = `${error.path} is invalid. Not meeting ${error.keyword} constraint`;
+  }
+
+  delete error.path;
+  delete error.keyword;
+
+  return error;
+}
+
+/**
+ * Takes in schema and returns function which can be used to validate the schema with better semantics around exposing errors
+ */
+export function validate(schema: any, options?: any) {
+  return (x: any): any[] => {
+    const validate = jsen(schema, options);
+    const isValid = validate(x);
+
+    if(isValid) {
+      return undefined;
+    }
+    else {
+      return validate.errors
+        .map(normalizeError);
+    }
+  }
+}
+
+
+export interface ISettings {
+  filter?: any;
+  filterPaneEnabled?: boolean;
+  pageName?: string;
+  pageNavigationEnabled?: boolean;
+}
+
+export const validateSettings = validate(settingsSchema);
+
+/**
+ * TODO: Consider adding type: "report" | "tile" property to indicate what type of object to embed
+ * 
+ * This would align with goal of having single embed page which adapts to the thing being embedded
+ * instead of having M x N embed pages where M is type of object (report, tile) and N is authorization
+ * type (PaaS, SaaS, Anonymous)
+ */
+export interface ILoadConfiguration {
+  accessToken: string;
+  id: string;
+  settings?: ISettings;
+}
+
+export const validateLoad = validate(loadSchema, {
+  schemas: {
+    settings: settingsSchema
+  }
+});
+
+export interface IPageTarget {
+  type: "page";
+  name: string;
+}
+
+export const validatePageTarget = validate(pageTargetSchema);
+
+export interface IVisualTarget {
+  type: "visual";
+  id: string;
+}
+
+export const validateVisualTarget = validate(visualTargetSchema);
+
+export interface IPage {
+  name: string;
+  displayName: string;
+}
+
+export const validatePage = validate(pageSchema);

src/schemas/load.json

@@ -0,0 +1,28 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "type": "object",
+  "properties": {
+    "accessToken": {
+      "type": "string",
+      "messages": {
+        "type": "accessToken must be a string",
+        "required": "accessToken is required"
+      },
+      "invalidMessage": "accessToken property is invalid"
+    },
+    "id": {
+      "type": "string",
+      "messages": {
+        "type": "id must be a string",
+        "required": "id is required"
+      }
+    },
+    "settings": {
+      "$ref": "#settings"
+    }
+  },
+  "required": [
+    "accessToken",
+    "id"
+  ]
+}

src/schemas/page.json

@@ -0,0 +1,24 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "type": "object",
+  "properties": {
+    "name": {
+      "type": "string",
+      "messages": {
+        "type": "name must be a string",
+        "required": "name is required"
+      }
+    },
+    "displayName": {
+      "type": "string",
+      "messages": {
+        "type": "displayName must be a string",
+        "required": "displayName is required"
+      }
+    }
+  },
+  "required": [
+    "name",
+    "displayName"
+  ]
+}

src/schemas/pageTarget.json

@@ -0,0 +1,28 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "type": "object",
+  "properties": {
+    "type": {
+      "type": "string",
+      "enum": [
+        "page"
+      ],
+      "messages": {
+        "type": "type must be a string",
+        "enum": "type must be 'page'",
+        "required": "type is required"
+      }
+    },
+    "name": {
+      "type": "string",
+      "messages": {
+        "type": "name must be a string",
+        "required": "name is required"
+      }
+    }
+  },
+  "required": [
+    "type",
+    "name"
+  ]
+}