Installations

npm install powerbi-models

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Node Version

18.18.2

NPM Version

9.8.1 Score

99.4

Supply Chain

99.6

Quality

80

Maintenance

100

Vulnerability

100

License

Pull Requests

Open

7

Total

84

Closed

20

Merged

57

Issues

Open

0

Total

0

Closed

0

Releases

Unable to fetch releases

Contributors

36

Unable to fetch Contributors

View All 36 Contributors

Languages

2

TypeScript

JavaScript

TypeScript (95.9%)

JavaScript (4.1%)

Love this project? Help keep it running — sponsor us today! 🚀

Developer

Microsoft

Download Statistics

Total Downloads

25,798,276

Last Day

4,131

Last Week

211,289

Last Month

825,975

Last Year

8,625,844

GitHub Statistics

NOASSERTION License

47 Stars

523 Commits

40 Forks

38 Watchers

13 Branches

36 Contributors

Updated on Dec 19, 2024

Bundle Size

107.68 kB

Minified

11.81 kB

Minified + Gzipped

Bundlephobia

Maintainers

1

Package Meta Information

Latest Version

1.15.2

Package Id

powerbi-models@1.15.2

Unpacked Size

738.95 kB

Size

92.36 kB

File Count

7

NPM Version

9.8.1

Node Version

18.18.2

Published on

Mar 25, 2024

Total Downloads

Cumulative downloads

Total Downloads

25,798,276

Last Day

4.5%

4,131

Compared to previous day

Last Week

0.7%

211,289

Compared to previous week

Last Month

40%

825,975

Compared to previous month

Last Year

32.5%

8,625,844

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dev Dependencies

32

powerbi-models

Contains JavaScript & TypeScript object models for Microsoft Power BI JavaScript SDK.

For each model there is a TypeScript interface, a json schema definitions, and a validation function to ensure a given object is a valid model.

Documentation

https://microsoft.github.io/powerbi-models

Getting Started

Install

1npm install --save powerbi-models

Import

1import * as models from 'powerbi-models';

Usage

Validation:

1let testObject = { x: 1 };
2
3const errors = models.validateLoad(testObject);
4
5if(errors) {
6  console.warn(errors);
7}
8

Would output to the console:

1[
2  {
3    message: 'accessToken is required'
4  }
5]

Creating filters:

1const basicFilter: models.IBasicFilter = {
2  target: {
3    table: "Products",
4    column: "Version"
5  },
6  operator: "In",
7  values: [
8    1,
9    2,
10    3,
11    4
12  ]
13};
14
15const advancedFilter: models.IAdvancedFilter = {
16  target: {
17    table: "Products",
18    column: "Name"
19  },
20  logicalOperator: "Or",
21  conditions: [
22    {
23      operator: "Contains",
24      value: "Power"
25    },
26    {
27      operator: "Contains",
28      value: "Microsoft"
29    }
30  ]
31};

Or use the constructor methods:

1const advancedFilter = new models.AdvancedFilter(
2  {
3    table: "Products",
4    column: "Name"
5  },
6  "Or",
7  {
8    operator: "Contains",
9    value: "Power"
10  },
11  {
12    operator: "Contains",
13    value: "Microsoft"
14  }
15);

Date Formatting

Dates should be formated using ISO 8601 standard. Example: 2016-09-08T00:15:46.861Z

This is how dates are naturally serialized to JSON:

1new Date().toJSON(); //=> 2016-09-08T00:15:46.861Z

An example filter using this Date format would look like the following:

1{
2  "$schema": "http://powerbi.com/product/schema#advanced",
3  "target": {
4    "table": "Time",
5    "column": "Date"
6  },
7  "logicalOperator": "And",
8  "conditions": [
9    {
10      "operator": "GreaterThan",
11      "value": "2014-06-01T07:00:00.000Z"
12    }
13  ]
14}

No vulnerabilities found.

10

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

10

Security-Policy

Determines if the project has published a security policy.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

9

License

Determines if the project has defined a license.

0

Maintained

Determines if the project is "actively maintained".

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Fuzzing

Determines if the project uses fuzzing.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

4.5

/10

Last Scanned on 2025-02-17

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More