@gooddata/sdk-backend-spi 11.48.0-alpha.0 → 11.48.0-alpha.1
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
|
@@ -9537,6 +9537,11 @@ export declare interface IWorkspaceStylingService {
|
|
|
9537
9537
|
/**
|
|
9538
9538
|
* Set active theme setting in workspace.
|
|
9539
9539
|
*
|
|
9540
|
+
* @remarks
|
|
9541
|
+
* The scope is carried by the reference itself: an `idRef` typed `"workspaceTheme"` activates a
|
|
9542
|
+
* workspace-scoped theme, otherwise the theme is treated as organization-scoped. There is no
|
|
9543
|
+
* cross-scope fallback when the active setting is later resolved.
|
|
9544
|
+
*
|
|
9540
9545
|
* @param themeRef - active theme reference
|
|
9541
9546
|
* @returns promise
|
|
9542
9547
|
*/
|
|
@@ -9556,6 +9561,11 @@ export declare interface IWorkspaceStylingService {
|
|
|
9556
9561
|
/**
|
|
9557
9562
|
* Set active color palette setting in workspace.
|
|
9558
9563
|
*
|
|
9564
|
+
* @remarks
|
|
9565
|
+
* The scope is carried by the reference itself: an `idRef` typed `"workspaceColorPalette"` activates a
|
|
9566
|
+
* workspace-scoped color palette, otherwise it is treated as organization-scoped. There is no
|
|
9567
|
+
* cross-scope fallback when the active setting is later resolved.
|
|
9568
|
+
*
|
|
9559
9569
|
* @param colorPaletteRef - active color palette reference
|
|
9560
9570
|
* @returns promise
|
|
9561
9571
|
*/
|
|
@@ -9566,6 +9576,60 @@ export declare interface IWorkspaceStylingService {
|
|
|
9566
9576
|
* @returns promise
|
|
9567
9577
|
*/
|
|
9568
9578
|
clearActiveColorPalette(): Promise<void>;
|
|
9579
|
+
/**
|
|
9580
|
+
* Request all themes defined on the workspace level.
|
|
9581
|
+
*
|
|
9582
|
+
* @returns promise of array of theme metadata objects
|
|
9583
|
+
*/
|
|
9584
|
+
getThemes(): Promise<IThemeMetadataObject[]>;
|
|
9585
|
+
/**
|
|
9586
|
+
* Create a new theme on the workspace level.
|
|
9587
|
+
*
|
|
9588
|
+
* @param theme - theme definition
|
|
9589
|
+
* @returns promise of the created theme metadata object
|
|
9590
|
+
*/
|
|
9591
|
+
createTheme(theme: IThemeDefinition): Promise<IThemeMetadataObject>;
|
|
9592
|
+
/**
|
|
9593
|
+
* Update an existing theme on the workspace level.
|
|
9594
|
+
*
|
|
9595
|
+
* @param theme - theme definition
|
|
9596
|
+
* @returns promise of the updated theme metadata object
|
|
9597
|
+
*/
|
|
9598
|
+
updateTheme(theme: IThemeDefinition): Promise<IThemeMetadataObject>;
|
|
9599
|
+
/**
|
|
9600
|
+
* Delete a theme on the workspace level.
|
|
9601
|
+
*
|
|
9602
|
+
* @param themeRef - theme reference
|
|
9603
|
+
* @returns promise
|
|
9604
|
+
*/
|
|
9605
|
+
deleteTheme(themeRef: ObjRef): Promise<void>;
|
|
9606
|
+
/**
|
|
9607
|
+
* Request all color palettes defined on the workspace level.
|
|
9608
|
+
*
|
|
9609
|
+
* @returns promise of array of color palette metadata objects
|
|
9610
|
+
*/
|
|
9611
|
+
getColorPalettes(): Promise<IColorPaletteMetadataObject[]>;
|
|
9612
|
+
/**
|
|
9613
|
+
* Create a new color palette on the workspace level.
|
|
9614
|
+
*
|
|
9615
|
+
* @param colorPalette - color palette definition
|
|
9616
|
+
* @returns promise of the created color palette metadata object
|
|
9617
|
+
*/
|
|
9618
|
+
createColorPalette(colorPalette: IColorPaletteDefinition): Promise<IColorPaletteMetadataObject>;
|
|
9619
|
+
/**
|
|
9620
|
+
* Update an existing color palette on the workspace level.
|
|
9621
|
+
*
|
|
9622
|
+
* @param colorPalette - color palette definition
|
|
9623
|
+
* @returns promise of the updated color palette metadata object
|
|
9624
|
+
*/
|
|
9625
|
+
updateColorPalette(colorPalette: IColorPaletteDefinition): Promise<IColorPaletteMetadataObject>;
|
|
9626
|
+
/**
|
|
9627
|
+
* Delete a color palette on the workspace level.
|
|
9628
|
+
*
|
|
9629
|
+
* @param colorPaletteRef - color palette reference
|
|
9630
|
+
* @returns promise
|
|
9631
|
+
*/
|
|
9632
|
+
deleteColorPalette(colorPaletteRef: ObjRef): Promise<void>;
|
|
9569
9633
|
}
|
|
9570
9634
|
|
|
9571
9635
|
/**
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { type IColorPalette, type ITheme, type ObjRef } from "@gooddata/sdk-model";
|
|
1
|
+
import { type IColorPalette, type IColorPaletteDefinition, type IColorPaletteMetadataObject, type ITheme, type IThemeDefinition, type IThemeMetadataObject, type ObjRef } from "@gooddata/sdk-model";
|
|
2
2
|
/**
|
|
3
3
|
* This service provides access to workspace styling settings such as color palette.
|
|
4
4
|
*
|
|
@@ -31,6 +31,11 @@ export interface IWorkspaceStylingService {
|
|
|
31
31
|
/**
|
|
32
32
|
* Set active theme setting in workspace.
|
|
33
33
|
*
|
|
34
|
+
* @remarks
|
|
35
|
+
* The scope is carried by the reference itself: an `idRef` typed `"workspaceTheme"` activates a
|
|
36
|
+
* workspace-scoped theme, otherwise the theme is treated as organization-scoped. There is no
|
|
37
|
+
* cross-scope fallback when the active setting is later resolved.
|
|
38
|
+
*
|
|
34
39
|
* @param themeRef - active theme reference
|
|
35
40
|
* @returns promise
|
|
36
41
|
*/
|
|
@@ -50,6 +55,11 @@ export interface IWorkspaceStylingService {
|
|
|
50
55
|
/**
|
|
51
56
|
* Set active color palette setting in workspace.
|
|
52
57
|
*
|
|
58
|
+
* @remarks
|
|
59
|
+
* The scope is carried by the reference itself: an `idRef` typed `"workspaceColorPalette"` activates a
|
|
60
|
+
* workspace-scoped color palette, otherwise it is treated as organization-scoped. There is no
|
|
61
|
+
* cross-scope fallback when the active setting is later resolved.
|
|
62
|
+
*
|
|
53
63
|
* @param colorPaletteRef - active color palette reference
|
|
54
64
|
* @returns promise
|
|
55
65
|
*/
|
|
@@ -60,5 +70,59 @@ export interface IWorkspaceStylingService {
|
|
|
60
70
|
* @returns promise
|
|
61
71
|
*/
|
|
62
72
|
clearActiveColorPalette(): Promise<void>;
|
|
73
|
+
/**
|
|
74
|
+
* Request all themes defined on the workspace level.
|
|
75
|
+
*
|
|
76
|
+
* @returns promise of array of theme metadata objects
|
|
77
|
+
*/
|
|
78
|
+
getThemes(): Promise<IThemeMetadataObject[]>;
|
|
79
|
+
/**
|
|
80
|
+
* Create a new theme on the workspace level.
|
|
81
|
+
*
|
|
82
|
+
* @param theme - theme definition
|
|
83
|
+
* @returns promise of the created theme metadata object
|
|
84
|
+
*/
|
|
85
|
+
createTheme(theme: IThemeDefinition): Promise<IThemeMetadataObject>;
|
|
86
|
+
/**
|
|
87
|
+
* Update an existing theme on the workspace level.
|
|
88
|
+
*
|
|
89
|
+
* @param theme - theme definition
|
|
90
|
+
* @returns promise of the updated theme metadata object
|
|
91
|
+
*/
|
|
92
|
+
updateTheme(theme: IThemeDefinition): Promise<IThemeMetadataObject>;
|
|
93
|
+
/**
|
|
94
|
+
* Delete a theme on the workspace level.
|
|
95
|
+
*
|
|
96
|
+
* @param themeRef - theme reference
|
|
97
|
+
* @returns promise
|
|
98
|
+
*/
|
|
99
|
+
deleteTheme(themeRef: ObjRef): Promise<void>;
|
|
100
|
+
/**
|
|
101
|
+
* Request all color palettes defined on the workspace level.
|
|
102
|
+
*
|
|
103
|
+
* @returns promise of array of color palette metadata objects
|
|
104
|
+
*/
|
|
105
|
+
getColorPalettes(): Promise<IColorPaletteMetadataObject[]>;
|
|
106
|
+
/**
|
|
107
|
+
* Create a new color palette on the workspace level.
|
|
108
|
+
*
|
|
109
|
+
* @param colorPalette - color palette definition
|
|
110
|
+
* @returns promise of the created color palette metadata object
|
|
111
|
+
*/
|
|
112
|
+
createColorPalette(colorPalette: IColorPaletteDefinition): Promise<IColorPaletteMetadataObject>;
|
|
113
|
+
/**
|
|
114
|
+
* Update an existing color palette on the workspace level.
|
|
115
|
+
*
|
|
116
|
+
* @param colorPalette - color palette definition
|
|
117
|
+
* @returns promise of the updated color palette metadata object
|
|
118
|
+
*/
|
|
119
|
+
updateColorPalette(colorPalette: IColorPaletteDefinition): Promise<IColorPaletteMetadataObject>;
|
|
120
|
+
/**
|
|
121
|
+
* Delete a color palette on the workspace level.
|
|
122
|
+
*
|
|
123
|
+
* @param colorPaletteRef - color palette reference
|
|
124
|
+
* @returns promise
|
|
125
|
+
*/
|
|
126
|
+
deleteColorPalette(colorPaletteRef: ObjRef): Promise<void>;
|
|
63
127
|
}
|
|
64
128
|
//# sourceMappingURL=index.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/workspace/styling/index.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/workspace/styling/index.ts"],"names":[],"mappings":"AAEA,OAAO,EACH,KAAK,aAAa,EAClB,KAAK,uBAAuB,EAC5B,KAAK,2BAA2B,EAChC,KAAK,MAAM,EACX,KAAK,gBAAgB,EACrB,KAAK,oBAAoB,EACzB,KAAK,MAAM,EACd,MAAM,qBAAqB,CAAC;AAE7B;;;;;;;;;GASG;AACH,MAAM,WAAW,wBAAwB;IACrC;;;;OAIG;IACH,eAAe,IAAI,OAAO,CAAC,aAAa,CAAC,CAAC;IAE1C;;;;OAIG;IACH,QAAQ,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;IAE5B;;;;OAIG;IACH,cAAc,IAAI,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;IAE9C;;;;;;;;;;OAUG;IACH,cAAc,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEhD;;;;OAIG;IACH,gBAAgB,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAElC;;;;OAIG;IACH,qBAAqB,IAAI,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;IAErD;;;;;;;;;;OAUG;IACH,qBAAqB,CAAC,eAAe,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE9D;;;;OAIG;IACH,uBAAuB,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAEzC;;;;OAIG;IACH,SAAS,IAAI,OAAO,CAAC,oBAAoB,EAAE,CAAC,CAAC;IAE7C;;;;;OAKG;IACH,WAAW,CAAC,KAAK,EAAE,gBAAgB,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAAC;IAEpE;;;;;OAKG;IACH,WAAW,CAAC,KAAK,EAAE,gBAAgB,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAAC;IAEpE;;;;;OAKG;IACH,WAAW,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE7C;;;;OAIG;IACH,gBAAgB,IAAI,OAAO,CAAC,2BAA2B,EAAE,CAAC,CAAC;IAE3D;;;;;OAKG;IACH,kBAAkB,CAAC,YAAY,EAAE,uBAAuB,GAAG,OAAO,CAAC,2BAA2B,CAAC,CAAC;IAEhG;;;;;OAKG;IACH,kBAAkB,CAAC,YAAY,EAAE,uBAAuB,GAAG,OAAO,CAAC,2BAA2B,CAAC,CAAC;IAEhG;;;;;OAKG;IACH,kBAAkB,CAAC,eAAe,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAC9D"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@gooddata/sdk-backend-spi",
|
|
3
|
-
"version": "11.48.0-alpha.
|
|
3
|
+
"version": "11.48.0-alpha.1",
|
|
4
4
|
"description": "GoodData Backend SPI abstraction interfaces",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"author": "GoodData",
|
|
@@ -24,7 +24,7 @@
|
|
|
24
24
|
"lodash-es": "^4.17.23",
|
|
25
25
|
"ts-invariant": "0.10.3",
|
|
26
26
|
"tslib": "2.8.1",
|
|
27
|
-
"@gooddata/sdk-model": "11.48.0-alpha.
|
|
27
|
+
"@gooddata/sdk-model": "11.48.0-alpha.1"
|
|
28
28
|
},
|
|
29
29
|
"devDependencies": {
|
|
30
30
|
"@microsoft/api-documenter": "^7.17.0",
|
|
@@ -48,8 +48,8 @@
|
|
|
48
48
|
"oxlint-tsgolint": "0.15.0",
|
|
49
49
|
"typescript": "5.9.3",
|
|
50
50
|
"vitest": "4.1.8",
|
|
51
|
-
"@gooddata/oxlint-config": "11.48.0-alpha.
|
|
52
|
-
"@gooddata/eslint-config": "11.48.0-alpha.
|
|
51
|
+
"@gooddata/oxlint-config": "11.48.0-alpha.1",
|
|
52
|
+
"@gooddata/eslint-config": "11.48.0-alpha.1"
|
|
53
53
|
},
|
|
54
54
|
"scripts": {
|
|
55
55
|
"_phase:build": "npm run build",
|