@springtree/eva-services-bi 1.2.3 → 1.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +11 -0
- package/lib/EVA.BI.Services.d.ts +19 -19
- package/lib/EVA.BI.Services.d.ts.map +1 -1
- package/lib/EVA.BI.Services.js +19 -19
- package/lib/EVA.BI.Services.js.map +1 -1
- package/lib/eva-services-bi.es5.js +19 -19
- package/lib/eva-services-bi.umd.js +21 -21
- package/package.json +2 -2
package/CHANGELOG.md
CHANGED
|
@@ -3,6 +3,17 @@
|
|
|
3
3
|
All notable changes to this project will be documented in this file.
|
|
4
4
|
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
|
5
5
|
|
|
6
|
+
# 1.3.0 (2021-11-26)
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
### Features
|
|
10
|
+
|
|
11
|
+
* **typings:** update to latest ([ea0a930](https://github.com/springtreesolutions/eva-sdk-repo/commit/ea0a930452790bd1ff569072c0916dbac217e2f3))
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
|
|
6
17
|
## 1.2.3 (2021-08-03)
|
|
7
18
|
|
|
8
19
|
**Note:** Version bump only for package @springtree/eva-services-bi
|
package/lib/EVA.BI.Services.d.ts
CHANGED
|
@@ -28,19 +28,19 @@ export declare namespace BI {
|
|
|
28
28
|
}
|
|
29
29
|
/**
|
|
30
30
|
* Gets BI data based on the given Labels.
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
31
|
+
|
|
32
|
+
* `OrganizationUnitID` is the organization unit you want data from; this may be a container unit or a shop alike
|
|
33
|
+
* `Labels` define the data you want to retrieve; use `GetLabels` to find the available labels in this instance
|
|
34
|
+
* `Timeframe` defines the range of dates you want to accumulate, where you have three options available;
|
|
35
|
+
* A `Period` with a `Year` and then either a `Month` or a `Week` (ISO)
|
|
36
|
+
* A `Range` with a `From` and `To` date and a `Grain` to define the amount of detail within this period
|
|
37
|
+
* A `Date` for a single date point in time
|
|
38
|
+
|
|
39
|
+
Optionally, you can supply the following parameters;
|
|
40
|
+
|
|
41
|
+
* `Series` is an array where you can specify which `Series` to retrieve; current values include `Actual` and `LFL`
|
|
42
|
+
* `GroupBy` defines the 'rotation' to view the data in; by default you'll see data per `Label`, but you can rotate for a ranking view using `OrganizationUnit` or a more detailed view using `Name`
|
|
43
|
+
* `Mock` allows you to override the base `BI:Mock` setting to switch between mocked- and live data
|
|
44
44
|
*
|
|
45
45
|
* @export
|
|
46
46
|
* @class GetData
|
|
@@ -93,12 +93,12 @@ export declare namespace BI {
|
|
|
93
93
|
}
|
|
94
94
|
/**
|
|
95
95
|
* Retrieves a list of stores the current user has the `ViewReports` rights for, nested in a BI-specific tree for use in the BI app. The response contains
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
96
|
+
one root node, from which you can traverse its Children (and its Children.Children, and its... you get it).
|
|
97
|
+
|
|
98
|
+
From outside in, these are the types you will *always* find: `Root` (5), `Country` (4), `Region` (3), `City` (2) and `Shop` (1).
|
|
99
|
+
|
|
100
|
+
Note that when a user does not have rights on a specific level (e.g. you may see a Region, but not the Country above), this node will have ID `-1`
|
|
101
|
+
and Name `Unknown`. Needless to point out, but note you cannot use the ID `-1` as a value for the `GetData` service `OrganizationUnitID` parameter.
|
|
102
102
|
*
|
|
103
103
|
* @export
|
|
104
104
|
* @class GetStoresForUser
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"EVA.BI.Services.d.ts","sourceRoot":"","sources":["../src/EVA.BI.Services.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAE,MAAM,+BAA+B,CAAC;
|
|
1
|
+
{"version":3,"file":"EVA.BI.Services.d.ts","sourceRoot":"","sources":["../src/EVA.BI.Services.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAE,MAAM,+BAA+B,CAAC;AAEpE,yBAAiB,EAAE,CAAC;IAElB;;;;;;OAMG;IACH,MAAa,iBAAkB,YAAW,qBAAqB;QAC7D,IAAI,SAA0B;QAC9B,IAAI,SAA+B;QACnC,OAAO,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC,iBAAiB,CAAC;QACnC,QAAQ,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC,iBAAiB,CAAC;KACrC;IAED;;;;;;OAMG;IACH,MAAa,aAAc,YAAW,qBAAqB;QACzD,IAAI,SAAsB;QAC1B,IAAI,SAA2B;QAC/B,OAAO,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC,aAAa,CAAC;QAC/B,QAAQ,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC,qBAAqB,CAAC;KACzC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,MAAa,OAAQ,YAAW,qBAAqB;QACnD,IAAI,SAAgB;QACpB,IAAI,SAAqB;QACzB,OAAO,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC,OAAO,CAAC;QACzB,QAAQ,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC,eAAe,CAAC;KACnC;IAED;;;;;;OAMG;IACH,MAAa,SAAU,YAAW,qBAAqB;QACrD,IAAI,SAAkB;QACtB,IAAI,SAAuB;QAC3B,OAAO,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC,SAAS,CAAC;QAC3B,QAAQ,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC,iBAAiB,CAAC;KACrC;IAED;;;;;;OAMG;IACH,MAAa,cAAe,YAAW,qBAAqB;QAC1D,IAAI,SAAuB;QAC3B,IAAI,SAA4B;QAChC,OAAO,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC,cAAc,CAAC;QAChC,QAAQ,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC,sBAAsB,CAAC;KAC1C;IAED;;;;;;OAMG;IACH,MAAa,kBAAmB,YAAW,qBAAqB;QAC9D,IAAI,SAA2B;QAC/B,IAAI,SAAgC;QACpC,OAAO,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC,kBAAkB,CAAC;QACpC,QAAQ,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC,0BAA0B,CAAC;KAC9C;IAED;;;;;;;;;;;;OAYG;IACH,MAAa,gBAAiB,YAAW,qBAAqB;QAC5D,IAAI,SAAyB;QAC7B,IAAI,SAA8B;QAClC,OAAO,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC,gBAAgB,CAAC;QAClC,QAAQ,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC,wBAAwB,CAAC;KAC5C;CACF"}
|
package/lib/EVA.BI.Services.js
CHANGED
|
@@ -30,19 +30,19 @@ export var BI;
|
|
|
30
30
|
BI.GetDailyStats = GetDailyStats;
|
|
31
31
|
/**
|
|
32
32
|
* Gets BI data based on the given Labels.
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
33
|
+
|
|
34
|
+
* `OrganizationUnitID` is the organization unit you want data from; this may be a container unit or a shop alike
|
|
35
|
+
* `Labels` define the data you want to retrieve; use `GetLabels` to find the available labels in this instance
|
|
36
|
+
* `Timeframe` defines the range of dates you want to accumulate, where you have three options available;
|
|
37
|
+
* A `Period` with a `Year` and then either a `Month` or a `Week` (ISO)
|
|
38
|
+
* A `Range` with a `From` and `To` date and a `Grain` to define the amount of detail within this period
|
|
39
|
+
* A `Date` for a single date point in time
|
|
40
|
+
|
|
41
|
+
Optionally, you can supply the following parameters;
|
|
42
|
+
|
|
43
|
+
* `Series` is an array where you can specify which `Series` to retrieve; current values include `Actual` and `LFL`
|
|
44
|
+
* `GroupBy` defines the 'rotation' to view the data in; by default you'll see data per `Label`, but you can rotate for a ranking view using `OrganizationUnit` or a more detailed view using `Name`
|
|
45
|
+
* `Mock` allows you to override the base `BI:Mock` setting to switch between mocked- and live data
|
|
46
46
|
*
|
|
47
47
|
* @export
|
|
48
48
|
* @class GetData
|
|
@@ -99,12 +99,12 @@ export var BI;
|
|
|
99
99
|
BI.GetPopularProducts = GetPopularProducts;
|
|
100
100
|
/**
|
|
101
101
|
* Retrieves a list of stores the current user has the `ViewReports` rights for, nested in a BI-specific tree for use in the BI app. The response contains
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
102
|
+
one root node, from which you can traverse its Children (and its Children.Children, and its... you get it).
|
|
103
|
+
|
|
104
|
+
From outside in, these are the types you will *always* find: `Root` (5), `Country` (4), `Region` (3), `City` (2) and `Shop` (1).
|
|
105
|
+
|
|
106
|
+
Note that when a user does not have rights on a specific level (e.g. you may see a Region, but not the Country above), this node will have ID `-1`
|
|
107
|
+
and Name `Unknown`. Needless to point out, but note you cannot use the ID `-1` as a value for the `GetData` service `OrganizationUnitID` parameter.
|
|
108
108
|
*
|
|
109
109
|
* @export
|
|
110
110
|
* @class GetStoresForUser
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"EVA.BI.Services.js","sourceRoot":"","sources":["../src/EVA.BI.Services.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"EVA.BI.Services.js","sourceRoot":"","sources":["../src/EVA.BI.Services.ts"],"names":[],"mappings":"AAEE,MAAM,KAAW,EAAE,CAsHlB;AAtHD,WAAiB,EAAE;IAEjB;;;;;;OAMG;IACH,MAAa,iBAAiB;QAA9B;YACE,SAAI,GAAG,sBAAsB,CAAC;YAC9B,SAAI,GAAG,2BAA2B,CAAC;QAGrC,CAAC;KAAA;IALY,oBAAiB,oBAK7B,CAAA;IAED;;;;;;OAMG;IACH,MAAa,aAAa;QAA1B;YACE,SAAI,GAAG,kBAAkB,CAAC;YAC1B,SAAI,GAAG,uBAAuB,CAAC;QAGjC,CAAC;KAAA;IALY,gBAAa,gBAKzB,CAAA;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,MAAa,OAAO;QAApB;YACE,SAAI,GAAG,YAAY,CAAC;YACpB,SAAI,GAAG,iBAAiB,CAAC;QAG3B,CAAC;KAAA;IALY,UAAO,UAKnB,CAAA;IAED;;;;;;OAMG;IACH,MAAa,SAAS;QAAtB;YACE,SAAI,GAAG,cAAc,CAAC;YACtB,SAAI,GAAG,mBAAmB,CAAC;QAG7B,CAAC;KAAA;IALY,YAAS,YAKrB,CAAA;IAED;;;;;;OAMG;IACH,MAAa,cAAc;QAA3B;YACE,SAAI,GAAG,mBAAmB,CAAC;YAC3B,SAAI,GAAG,wBAAwB,CAAC;QAGlC,CAAC;KAAA;IALY,iBAAc,iBAK1B,CAAA;IAED;;;;;;OAMG;IACH,MAAa,kBAAkB;QAA/B;YACE,SAAI,GAAG,uBAAuB,CAAC;YAC/B,SAAI,GAAG,4BAA4B,CAAC;QAGtC,CAAC;KAAA;IALY,qBAAkB,qBAK9B,CAAA;IAED;;;;;;;;;;;;OAYG;IACH,MAAa,gBAAgB;QAA7B;YACE,SAAI,GAAG,qBAAqB,CAAC;YAC7B,SAAI,GAAG,0BAA0B,CAAC;QAGpC,CAAC;KAAA;IALY,mBAAgB,mBAK5B,CAAA;AACH,CAAC,EAtHgB,EAAE,KAAF,EAAE,QAsHlB"}
|
|
@@ -30,19 +30,19 @@ var BI;
|
|
|
30
30
|
BI.GetDailyStats = GetDailyStats;
|
|
31
31
|
/**
|
|
32
32
|
* Gets BI data based on the given Labels.
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
33
|
+
|
|
34
|
+
* `OrganizationUnitID` is the organization unit you want data from; this may be a container unit or a shop alike
|
|
35
|
+
* `Labels` define the data you want to retrieve; use `GetLabels` to find the available labels in this instance
|
|
36
|
+
* `Timeframe` defines the range of dates you want to accumulate, where you have three options available;
|
|
37
|
+
* A `Period` with a `Year` and then either a `Month` or a `Week` (ISO)
|
|
38
|
+
* A `Range` with a `From` and `To` date and a `Grain` to define the amount of detail within this period
|
|
39
|
+
* A `Date` for a single date point in time
|
|
40
|
+
|
|
41
|
+
Optionally, you can supply the following parameters;
|
|
42
|
+
|
|
43
|
+
* `Series` is an array where you can specify which `Series` to retrieve; current values include `Actual` and `LFL`
|
|
44
|
+
* `GroupBy` defines the 'rotation' to view the data in; by default you'll see data per `Label`, but you can rotate for a ranking view using `OrganizationUnit` or a more detailed view using `Name`
|
|
45
|
+
* `Mock` allows you to override the base `BI:Mock` setting to switch between mocked- and live data
|
|
46
46
|
*
|
|
47
47
|
* @export
|
|
48
48
|
* @class GetData
|
|
@@ -99,12 +99,12 @@ var BI;
|
|
|
99
99
|
BI.GetPopularProducts = GetPopularProducts;
|
|
100
100
|
/**
|
|
101
101
|
* Retrieves a list of stores the current user has the `ViewReports` rights for, nested in a BI-specific tree for use in the BI app. The response contains
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
102
|
+
one root node, from which you can traverse its Children (and its Children.Children, and its... you get it).
|
|
103
|
+
|
|
104
|
+
From outside in, these are the types you will *always* find: `Root` (5), `Country` (4), `Region` (3), `City` (2) and `Shop` (1).
|
|
105
|
+
|
|
106
|
+
Note that when a user does not have rights on a specific level (e.g. you may see a Region, but not the Country above), this node will have ID `-1`
|
|
107
|
+
and Name `Unknown`. Needless to point out, but note you cannot use the ID `-1` as a value for the `GetData` service `OrganizationUnitID` parameter.
|
|
108
108
|
*
|
|
109
109
|
* @export
|
|
110
110
|
* @class GetStoresForUser
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports) :
|
|
3
3
|
typeof define === 'function' && define.amd ? define(['exports'], factory) :
|
|
4
4
|
(global = typeof globalThis !== 'undefined' ? globalThis : global || self, factory(global.evaServicesBi = {}));
|
|
5
|
-
}(this, (function (exports) { 'use strict';
|
|
5
|
+
})(this, (function (exports) { 'use strict';
|
|
6
6
|
|
|
7
7
|
exports.BI = void 0;
|
|
8
8
|
(function (BI) {
|
|
@@ -36,19 +36,19 @@
|
|
|
36
36
|
BI.GetDailyStats = GetDailyStats;
|
|
37
37
|
/**
|
|
38
38
|
* Gets BI data based on the given Labels.
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
39
|
+
|
|
40
|
+
* `OrganizationUnitID` is the organization unit you want data from; this may be a container unit or a shop alike
|
|
41
|
+
* `Labels` define the data you want to retrieve; use `GetLabels` to find the available labels in this instance
|
|
42
|
+
* `Timeframe` defines the range of dates you want to accumulate, where you have three options available;
|
|
43
|
+
* A `Period` with a `Year` and then either a `Month` or a `Week` (ISO)
|
|
44
|
+
* A `Range` with a `From` and `To` date and a `Grain` to define the amount of detail within this period
|
|
45
|
+
* A `Date` for a single date point in time
|
|
46
|
+
|
|
47
|
+
Optionally, you can supply the following parameters;
|
|
48
|
+
|
|
49
|
+
* `Series` is an array where you can specify which `Series` to retrieve; current values include `Actual` and `LFL`
|
|
50
|
+
* `GroupBy` defines the 'rotation' to view the data in; by default you'll see data per `Label`, but you can rotate for a ranking view using `OrganizationUnit` or a more detailed view using `Name`
|
|
51
|
+
* `Mock` allows you to override the base `BI:Mock` setting to switch between mocked- and live data
|
|
52
52
|
*
|
|
53
53
|
* @export
|
|
54
54
|
* @class GetData
|
|
@@ -105,12 +105,12 @@
|
|
|
105
105
|
BI.GetPopularProducts = GetPopularProducts;
|
|
106
106
|
/**
|
|
107
107
|
* Retrieves a list of stores the current user has the `ViewReports` rights for, nested in a BI-specific tree for use in the BI app. The response contains
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
108
|
+
one root node, from which you can traverse its Children (and its Children.Children, and its... you get it).
|
|
109
|
+
|
|
110
|
+
From outside in, these are the types you will *always* find: `Root` (5), `Country` (4), `Region` (3), `City` (2) and `Shop` (1).
|
|
111
|
+
|
|
112
|
+
Note that when a user does not have rights on a specific level (e.g. you may see a Region, but not the Country above), this node will have ID `-1`
|
|
113
|
+
and Name `Unknown`. Needless to point out, but note you cannot use the ID `-1` as a value for the `GetData` service `OrganizationUnitID` parameter.
|
|
114
114
|
*
|
|
115
115
|
* @export
|
|
116
116
|
* @class GetStoresForUser
|
|
@@ -127,5 +127,5 @@
|
|
|
127
127
|
|
|
128
128
|
Object.defineProperty(exports, '__esModule', { value: true });
|
|
129
129
|
|
|
130
|
-
}))
|
|
130
|
+
}));
|
|
131
131
|
//# sourceMappingURL=eva-services-bi.umd.js.map
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@springtree/eva-services-bi",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.3.0",
|
|
4
4
|
"description": "The EVA service repository for EVA.BI",
|
|
5
5
|
"keywords": [],
|
|
6
6
|
"author": "SpringTree <info@springtree.nl>",
|
|
@@ -33,5 +33,5 @@
|
|
|
33
33
|
"peerDependencies": {
|
|
34
34
|
"@springtree/eva-services-core": "^1.0.0"
|
|
35
35
|
},
|
|
36
|
-
"gitHead": "
|
|
36
|
+
"gitHead": "6424b18cbe6f14c3e21cb59971e8bf88d2c3f9e7"
|
|
37
37
|
}
|