@gooddata/sdk-backend-spi 10.8.0-alpha.26 → 10.8.0-alpha.27
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/esm/sdk-backend-spi.d.ts
CHANGED
|
@@ -37,6 +37,8 @@ import { IColorPaletteDefinition } from '@gooddata/sdk-model';
|
|
|
37
37
|
import { IColorPaletteMetadataObject } from '@gooddata/sdk-model';
|
|
38
38
|
import { IDashboard } from '@gooddata/sdk-model';
|
|
39
39
|
import { IDashboardDefinition } from '@gooddata/sdk-model';
|
|
40
|
+
import { IDashboardFilterView } from '@gooddata/sdk-model';
|
|
41
|
+
import { IDashboardFilterViewSaveRequest } from '@gooddata/sdk-model';
|
|
40
42
|
import { IDashboardLayout } from '@gooddata/sdk-model';
|
|
41
43
|
import { IDashboardLayoutItem } from '@gooddata/sdk-model';
|
|
42
44
|
import { IDashboardLayoutSection } from '@gooddata/sdk-model';
|
|
@@ -4260,6 +4262,34 @@ export declare interface IWorkspaceDashboardsService {
|
|
|
4260
4262
|
* @param dashboardRefs - dashboard references to validate
|
|
4261
4263
|
*/
|
|
4262
4264
|
validateDashboardsExistence(dashboardRefs: ObjRef[]): Promise<IExistingDashboard[]>;
|
|
4265
|
+
/**
|
|
4266
|
+
* Get a list of filter views for the current user.
|
|
4267
|
+
*
|
|
4268
|
+
* @param dashboardRef - ref of the dashboard for which we want to get the filter views.
|
|
4269
|
+
*/
|
|
4270
|
+
getFilterViewsForCurrentUser(dashboardRef: ObjRef): Promise<IDashboardFilterView[]>;
|
|
4271
|
+
/**
|
|
4272
|
+
* Create a new filter view.
|
|
4273
|
+
*
|
|
4274
|
+
* @param filterView - filter view that must be created.
|
|
4275
|
+
*/
|
|
4276
|
+
createFilterView(filterView: IDashboardFilterViewSaveRequest): Promise<IDashboardFilterView>;
|
|
4277
|
+
/**
|
|
4278
|
+
* Delete a filter view identified by the provided ref.
|
|
4279
|
+
*
|
|
4280
|
+
* @param ref - ref of the filter view that must be deleted.
|
|
4281
|
+
*/
|
|
4282
|
+
deleteFilterView(ref: ObjRef): Promise<void>;
|
|
4283
|
+
/**
|
|
4284
|
+
* Set a filter view identified by the provided ref as the default one.
|
|
4285
|
+
* The other filter views for the same dashboard that are marked as default ones will be unmarked.
|
|
4286
|
+
*
|
|
4287
|
+
* @param ref - ref of the filter view that must be set as default.
|
|
4288
|
+
* @param isDefault - determine if filter view identified by the provided ref should be marked as a default
|
|
4289
|
+
* one. If yes, any existing filter view for the same user and dashboard will be marked as non default
|
|
4290
|
+
* as only one can be set as default at the same time.
|
|
4291
|
+
*/
|
|
4292
|
+
setFilterViewAsDefault(ref: ObjRef, isDefault: boolean): Promise<void>;
|
|
4263
4293
|
}
|
|
4264
4294
|
|
|
4265
4295
|
/**
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { IFilter, ObjRef, FilterContextItem, IFilterContextDefinition, IWidgetAlert, IWidgetAlertDefinition, IWidget, ObjectType, CatalogItem, IScheduledMail, IScheduledMailDefinition, IInsight, IDashboardPlugin, IDashboard, IListedDashboard, IDashboardDefinition, IDashboardPluginDefinition, IDashboardPermissions, IExistingDashboard, IDateFilter } from "@gooddata/sdk-model";
|
|
1
|
+
import { IFilter, ObjRef, FilterContextItem, IFilterContextDefinition, IWidgetAlert, IWidgetAlertDefinition, IWidget, ObjectType, CatalogItem, IScheduledMail, IScheduledMailDefinition, IInsight, IDashboardPlugin, IDashboard, IListedDashboard, IDashboardDefinition, IDashboardPluginDefinition, IDashboardPermissions, IExistingDashboard, IDateFilter, IDashboardFilterView, IDashboardFilterViewSaveRequest } from "@gooddata/sdk-model";
|
|
2
2
|
import { IExportResult } from "../execution/export.js";
|
|
3
3
|
import { IPagedResource } from "../../common/paging.js";
|
|
4
4
|
/**
|
|
@@ -387,6 +387,34 @@ export interface IWorkspaceDashboardsService {
|
|
|
387
387
|
* @param dashboardRefs - dashboard references to validate
|
|
388
388
|
*/
|
|
389
389
|
validateDashboardsExistence(dashboardRefs: ObjRef[]): Promise<IExistingDashboard[]>;
|
|
390
|
+
/**
|
|
391
|
+
* Get a list of filter views for the current user.
|
|
392
|
+
*
|
|
393
|
+
* @param dashboardRef - ref of the dashboard for which we want to get the filter views.
|
|
394
|
+
*/
|
|
395
|
+
getFilterViewsForCurrentUser(dashboardRef: ObjRef): Promise<IDashboardFilterView[]>;
|
|
396
|
+
/**
|
|
397
|
+
* Create a new filter view.
|
|
398
|
+
*
|
|
399
|
+
* @param filterView - filter view that must be created.
|
|
400
|
+
*/
|
|
401
|
+
createFilterView(filterView: IDashboardFilterViewSaveRequest): Promise<IDashboardFilterView>;
|
|
402
|
+
/**
|
|
403
|
+
* Delete a filter view identified by the provided ref.
|
|
404
|
+
*
|
|
405
|
+
* @param ref - ref of the filter view that must be deleted.
|
|
406
|
+
*/
|
|
407
|
+
deleteFilterView(ref: ObjRef): Promise<void>;
|
|
408
|
+
/**
|
|
409
|
+
* Set a filter view identified by the provided ref as the default one.
|
|
410
|
+
* The other filter views for the same dashboard that are marked as default ones will be unmarked.
|
|
411
|
+
*
|
|
412
|
+
* @param ref - ref of the filter view that must be set as default.
|
|
413
|
+
* @param isDefault - determine if filter view identified by the provided ref should be marked as a default
|
|
414
|
+
* one. If yes, any existing filter view for the same user and dashboard will be marked as non default
|
|
415
|
+
* as only one can be set as default at the same time.
|
|
416
|
+
*/
|
|
417
|
+
setFilterViewAsDefault(ref: ObjRef, isDefault: boolean): Promise<void>;
|
|
390
418
|
}
|
|
391
419
|
/**
|
|
392
420
|
* Service to query dashboards.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/workspace/dashboards/index.ts"],"names":[],"mappings":"AACA,OAAO,EACH,OAAO,EACP,MAAM,EACN,iBAAiB,EACjB,wBAAwB,EACxB,YAAY,EACZ,sBAAsB,EACtB,OAAO,EACP,UAAU,EACV,WAAW,EACX,cAAc,EACd,wBAAwB,EACxB,QAAQ,EACR,gBAAgB,EAChB,UAAU,EACV,gBAAgB,EAChB,oBAAoB,EACpB,0BAA0B,EAC1B,qBAAqB,EACrB,kBAAkB,EAClB,WAAW,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/workspace/dashboards/index.ts"],"names":[],"mappings":"AACA,OAAO,EACH,OAAO,EACP,MAAM,EACN,iBAAiB,EACjB,wBAAwB,EACxB,YAAY,EACZ,sBAAsB,EACtB,OAAO,EACP,UAAU,EACV,WAAW,EACX,cAAc,EACd,wBAAwB,EACxB,QAAQ,EACR,gBAAgB,EAChB,UAAU,EACV,gBAAgB,EAChB,oBAAoB,EACpB,0BAA0B,EAC1B,qBAAqB,EACrB,kBAAkB,EAClB,WAAW,EACX,oBAAoB,EACpB,+BAA+B,EAClC,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AACvD,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AAExD;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACjC;;OAEG;IACH,QAAQ,EAAE,QAAQ,EAAE,CAAC;IAErB;;OAEG;IACH,OAAO,EAAE,gBAAgB,EAAE,CAAC;CAC/B;AAED;;;GAGG;AACH,MAAM,WAAW,wBAAwB;IACrC,SAAS,EAAE,UAAU,CAAC;IACtB,UAAU,EAAE,oBAAoB,CAAC;CACpC;AAED;;;GAGG;AACH,MAAM,MAAM,6BAA6B,GAAG,OAAO,CAC/C,UAAU,EACR,MAAM,GACN,WAAW,GACX,aAAa,GACb,SAAS,GACT,KAAK,GACL,SAAS,GACT,UAAU,GACV,cAAc,GACd,oBAAoB,CACzB,CAAC;AAGF;;;;;GAKG;AACH,MAAM,WAAW,iBAAiB;IAC9B;;;OAGG;IACH,YAAY,CAAC,EAAE,WAAW,EAAE,CAAC;CAChC;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAC9B;;OAEG;IACH,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;CAC/B;AAED;;;;GAIG;AACH,MAAM,WAAW,oBAAoB;IACjC;;;;;OAKG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB;;;;;OAKG;IACH,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAElC;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;;;GAIG;AACH,MAAM,WAAW,0BAA0B;IACvC;;;;;OAKG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;CAC1B;AAED;;;;GAIG;AACH,MAAM,WAAW,wBAAwB;IACrC;;;;;;;OAOG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB;;;;;OAKG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAC;CAClC;AAED;;GAEG;AACH,MAAM,MAAM,gCAAgC,GAAG,SAAS,GAAG,iBAAiB,CAAC;AAE7E;;;;GAIG;AACH,MAAM,WAAW,2BAA2B;IACxC,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAE3B;;;;;OAKG;IACH,aAAa,CAAC,OAAO,CAAC,EAAE,oBAAoB,GAAG,OAAO,CAAC,gBAAgB,EAAE,CAAC,CAAC;IAE3E;;;;OAIG;IACH,kBAAkB,IAAI,gBAAgB,CAAC;IAEvC;;;;;;;;;;OAUG;IACH,YAAY,CAAC,GAAG,EAAE,MAAM,EAAE,gBAAgB,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,oBAAoB,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;IAE1G;;;;;;;;;;OAUG;IACH,0BAA0B,CACtB,GAAG,EAAE,MAAM,EACX,gBAAgB,CAAC,EAAE,MAAM,EACzB,OAAO,CAAC,EAAE,oBAAoB,EAC9B,KAAK,CAAC,EAAE,gCAAgC,EAAE,GAC3C,OAAO,CAAC,wBAAwB,CAAC,CAAC;IAErC;;;;;;OAMG;IACH,6BAA6B,CACzB,SAAS,EAAE,UAAU,EACrB,KAAK,CAAC,EAAE,gCAAgC,EAAE,GAC3C,OAAO,CAAC,oBAAoB,CAAC,CAAC;IAEjC;;;;;OAKG;IACH,eAAe,CAAC,SAAS,EAAE,oBAAoB,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;IAEtE;;;;;;OAMG;IACH,eAAe,CAAC,SAAS,EAAE,UAAU,EAAE,gBAAgB,EAAE,oBAAoB,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;IAEpG;;;;;OAKG;IACH,eAAe,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE5C;;;;;;;;;OASG;IACH,oBAAoB,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,iBAAiB,EAAE,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;IAEzF;;;;;;OAMG;IACH,mBAAmB,CACf,aAAa,EAAE,wBAAwB,EACvC,mBAAmB,CAAC,EAAE,wBAAwB,GAC/C,OAAO,CAAC,cAAc,CAAC,CAAC;IAE3B;;;;;;;OAOG;IACH,mBAAmB,CACf,GAAG,EAAE,MAAM,EACX,aAAa,EAAE,wBAAwB,EACvC,gBAAgB,CAAC,EAAE,MAAM,GAC1B,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjB;;;;;OAKG;IACH,mBAAmB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEhD;;;;;;OAMG;IACH,6BAA6B,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,wBAAwB,GAAG,OAAO,CAAC,cAAc,EAAE,CAAC,CAAC;IAE1G;;;;;OAKG;IACH,kCAAkC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAEjE;;;;OAIG;IACH,gCAAgC,IAAI,OAAO,CAAC,YAAY,EAAE,CAAC,CAAC;IAE5D;;;;;OAKG;IACH,sCAAsC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC,CAAC;IAE7E;;;;;OAKG;IACH,8BAA8B,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,iBAAiB,EAAE,CAAC,CAAC;IAE7E;;;;;OAKG;IACH,iBAAiB,CAAC,KAAK,EAAE,sBAAsB,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;IAExE;;;;;OAKG;IACH,iBAAiB,CAAC,KAAK,EAAE,YAAY,GAAG,sBAAsB,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;IAEvF;;;;;OAKG;IACH,iBAAiB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE9C;;;;;OAKG;IACH,kBAAkB,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAElD;;;;;;OAMG;IACH,0BAA0B,CACtB,MAAM,EAAE,OAAO,EACf,KAAK,CAAC,EAAE,6BAA6B,EAAE,GACxC,OAAO,CAAC,iBAAiB,CAAC,CAAC;IAE9B;;;;;;;;;;;;;OAaG;IACH,2BAA2B,CAAC,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC;IAErF;;;;;;;;;;;;;;OAcG;IACH,kDAAkD,CAC9C,MAAM,EAAE,OAAO,EACf,iBAAiB,EAAE,WAAW,EAAE,EAChC,YAAY,EAAE,OAAO,EAAE,GACxB,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC;IAEtB;;;;OAIG;IACH,mBAAmB,CAAC,OAAO,CAAC,EAAE,0BAA0B,GAAG,OAAO,CAAC,gBAAgB,EAAE,CAAC,CAAC;IAEvF;;;;;OAKG;IACH,kBAAkB,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,0BAA0B,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC;IAEjG;;;;;;;;;;;;;;;OAeG;IACH,qBAAqB,CAAC,MAAM,EAAE,0BAA0B,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC;IAErF;;;;;;;OAOG;IACH,qBAAqB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAElD;;;;OAIG;IACH,uBAAuB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAAC;IAErE;;;;;OAKG;IACH,2BAA2B,CAAC,aAAa,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,kBAAkB,EAAE,CAAC,CAAC;IAEpF;;;;OAIG;IACH,4BAA4B,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,oBAAoB,EAAE,CAAC,CAAC;IAEpF;;;;OAIG;IACH,gBAAgB,CAAC,UAAU,EAAE,+BAA+B,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAAC;IAE7F;;;;OAIG;IACH,gBAAgB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE7C;;;;;;;;OAQG;IACH,sBAAsB,CAAC,GAAG,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAC1E;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAC7B;;;;;;OAMG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,gBAAgB,CAAC;IAEzC;;;;;;;OAOG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,gBAAgB,CAAC;IAEzC;;;;;OAKG;IACH,UAAU,CAAC,MAAM,EAAE;QAAE,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,gBAAgB,CAAC;IAEzD;;;;;OAKG;IACH,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,gBAAgB,CAAC;IAE9C;;;;OAIG;IACH,KAAK,IAAI,OAAO,CAAC,sBAAsB,CAAC,CAAC;CAC5C;AAED;;;;GAIG;AACH,MAAM,MAAM,sBAAsB,GAAG,cAAc,CAAC,gBAAgB,CAAC,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@gooddata/sdk-backend-spi",
|
|
3
|
-
"version": "10.8.0-alpha.
|
|
3
|
+
"version": "10.8.0-alpha.27",
|
|
4
4
|
"author": "GoodData",
|
|
5
5
|
"description": "GoodData Backend SPI abstraction interfaces",
|
|
6
6
|
"repository": {
|
|
@@ -24,7 +24,7 @@
|
|
|
24
24
|
"lodash": "^4.17.21",
|
|
25
25
|
"ts-invariant": "^0.7.5",
|
|
26
26
|
"tslib": "^2.5.0",
|
|
27
|
-
"@gooddata/sdk-model": "10.8.0-alpha.
|
|
27
|
+
"@gooddata/sdk-model": "10.8.0-alpha.27"
|
|
28
28
|
},
|
|
29
29
|
"devDependencies": {
|
|
30
30
|
"@gooddata/eslint-config": "^4.1.0",
|