@gooddata/sdk-backend-spi 10.5.0-alpha.9 → 10.5.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/esm/backend/index.d.ts +4 -2
- package/esm/backend/index.d.ts.map +1 -1
- package/esm/backend/index.js.map +1 -1
- package/esm/index.d.ts +1 -0
- package/esm/index.d.ts.map +1 -1
- package/esm/sdk-backend-spi.d.ts +203 -15
- package/esm/workspace/automations/index.d.ts +159 -0
- package/esm/workspace/automations/index.d.ts.map +1 -0
- package/esm/workspace/automations/index.js +3 -0
- package/esm/workspace/automations/index.js.map +1 -0
- package/esm/workspace/execution/export.d.ts +23 -6
- package/esm/workspace/execution/export.d.ts.map +1 -1
- package/esm/workspace/exportDefinitions/index.d.ts +6 -6
- package/esm/workspace/exportDefinitions/index.d.ts.map +1 -1
- package/esm/workspace/index.d.ts +7 -0
- package/esm/workspace/index.d.ts.map +1 -1
- package/package.json +2 -2
package/esm/backend/index.d.ts
CHANGED
|
@@ -115,10 +115,11 @@ export interface IAnalyticalBackend {
|
|
|
115
115
|
authenticate(force?: boolean): Promise<IAuthenticatedPrincipal>;
|
|
116
116
|
/**
|
|
117
117
|
* Triggers deauthentication process against the backend.
|
|
118
|
+
* @param returnTo - url to redirect after successful relogin
|
|
118
119
|
*
|
|
119
120
|
* @returns promise of the completed process, or rejection if deauthentication failed.
|
|
120
121
|
*/
|
|
121
|
-
deauthenticate(): Promise<void>;
|
|
122
|
+
deauthenticate(returnTo?: string): Promise<void>;
|
|
122
123
|
/**
|
|
123
124
|
* Returns an organization available on the backend.
|
|
124
125
|
* @param organizationId - unique ID of the organization
|
|
@@ -204,8 +205,9 @@ export interface IAuthenticationProvider {
|
|
|
204
205
|
* Clear existing authentication.
|
|
205
206
|
*
|
|
206
207
|
* @param context - context in which the authentication is done
|
|
208
|
+
* @param returnTo - url to redirect after successful logout
|
|
207
209
|
*/
|
|
208
|
-
deauthenticate(context: IAuthenticationContext): Promise<void>;
|
|
210
|
+
deauthenticate(context: IAuthenticationContext, returnTo?: string): Promise<void>;
|
|
209
211
|
}
|
|
210
212
|
/**
|
|
211
213
|
* Describes user, which is currently authenticated to the backend.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/backend/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,oBAAoB,EAAE,MAAM,qBAAqB,CAAC;AAC3D,OAAO,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AACrE,OAAO,EAAE,uBAAuB,EAAE,oBAAoB,EAAE,MAAM,uBAAuB,CAAC;AACtF,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAChD,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAE,oBAAoB,EAAE,MAAM,mBAAmB,CAAC;AACzD,OAAO,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AACzE,OAAO,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AACzD,OAAO,EAAE,mBAAmB,EAAE,MAAM,yBAAyB,CAAC;AAE9D;;;;;;;GAOG;AACH,MAAM,WAAW,wBAAwB;IACrC;;;;;;OAMG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;CAC9B;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,wBAAwB,GAAG,CACnC,MAAM,CAAC,EAAE,wBAAwB,EACjC,UAAU,CAAC,EAAE,GAAG,KACf,kBAAkB,CAAC;AAExB;;;;;;;;;;GAUG;AACH,MAAM,WAAW,kBAAkB;IAC/B;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,wBAAwB,CAAC;IAE1C;;OAEG;IACH,QAAQ,CAAC,YAAY,EAAE,oBAAoB,CAAC;IAE5C;;;;;;;;;OASG;IACH,UAAU,CAAC,QAAQ,EAAE,MAAM,GAAG,kBAAkB,CAAC;IAEjD;;;;;;OAMG;IACH,aAAa,CAAC,aAAa,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,kBAAkB,CAAC;IAExE;;;;;;OAMG;IACH,kBAAkB,CAAC,QAAQ,EAAE,uBAAuB,GAAG,kBAAkB,CAAC;IAE1E;;;;;;;;;OASG;IACH,eAAe,IAAI,OAAO,CAAC,uBAAuB,GAAG,IAAI,CAAC,CAAC;IAE3D;;;;;;;;;;;;;;OAcG;IACH,YAAY,CAAC,KAAK,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,uBAAuB,CAAC,CAAC;IAEhE
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/backend/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,oBAAoB,EAAE,MAAM,qBAAqB,CAAC;AAC3D,OAAO,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AACrE,OAAO,EAAE,uBAAuB,EAAE,oBAAoB,EAAE,MAAM,uBAAuB,CAAC;AACtF,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAChD,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAE,oBAAoB,EAAE,MAAM,mBAAmB,CAAC;AACzD,OAAO,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AACzE,OAAO,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AACzD,OAAO,EAAE,mBAAmB,EAAE,MAAM,yBAAyB,CAAC;AAE9D;;;;;;;GAOG;AACH,MAAM,WAAW,wBAAwB;IACrC;;;;;;OAMG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;CAC9B;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,wBAAwB,GAAG,CACnC,MAAM,CAAC,EAAE,wBAAwB,EACjC,UAAU,CAAC,EAAE,GAAG,KACf,kBAAkB,CAAC;AAExB;;;;;;;;;;GAUG;AACH,MAAM,WAAW,kBAAkB;IAC/B;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,wBAAwB,CAAC;IAE1C;;OAEG;IACH,QAAQ,CAAC,YAAY,EAAE,oBAAoB,CAAC;IAE5C;;;;;;;;;OASG;IACH,UAAU,CAAC,QAAQ,EAAE,MAAM,GAAG,kBAAkB,CAAC;IAEjD;;;;;;OAMG;IACH,aAAa,CAAC,aAAa,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,kBAAkB,CAAC;IAExE;;;;;;OAMG;IACH,kBAAkB,CAAC,QAAQ,EAAE,uBAAuB,GAAG,kBAAkB,CAAC;IAE1E;;;;;;;;;OASG;IACH,eAAe,IAAI,OAAO,CAAC,uBAAuB,GAAG,IAAI,CAAC,CAAC;IAE3D;;;;;;;;;;;;;;OAcG;IACH,YAAY,CAAC,KAAK,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,uBAAuB,CAAC,CAAC;IAEhE;;;;;OAKG;IACH,cAAc,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjD;;;OAGG;IACH,YAAY,CAAC,cAAc,EAAE,MAAM,GAAG,aAAa,CAAC;IAEpD;;OAEG;IACH,aAAa,IAAI,cAAc,CAAC;IAEhC;;;;OAIG;IACH,WAAW,IAAI,YAAY,CAAC;IAE5B;;;;;OAKG;IACH,SAAS,CAAC,EAAE,EAAE,MAAM,GAAG,oBAAoB,CAAC;IAE5C;;OAEG;IACH,UAAU,IAAI,uBAAuB,CAAC;IAEtC;;OAEG;IACH,YAAY,IAAI,aAAa,CAAC;IAE9B;;OAEG;IACH,WAAW,IAAI,mBAAmB,CAAC;CACtC;AAED;;;;;GAKG;AACH,MAAM,MAAM,uBAAuB,GAAG,CAAC,OAAO,EAAE,sBAAsB,EAAE,KAAK,EAAE,gBAAgB,KAAK,IAAI,CAAC;AAEzG;;;;;GAKG;AACH,MAAM,WAAW,uBAAuB;IACpC;;;;;;;;;;;;OAYG;IACH,gBAAgB,CAAC,CAAC,MAAM,EAAE,GAAG,GAAG,IAAI,CAAC;IAErC;;;;;OAKG;IACH,kBAAkB,CAAC,EAAE,uBAAuB,CAAC;IAE7C;;;;OAIG;IACH,YAAY,CAAC,OAAO,EAAE,sBAAsB,GAAG,OAAO,CAAC,uBAAuB,CAAC,CAAC;IAEhF;;;OAGG;IACH,mBAAmB,CAAC,OAAO,EAAE,sBAAsB,GAAG,OAAO,CAAC,uBAAuB,GAAG,IAAI,CAAC,CAAC;IAE9F;;;;;OAKG;IACH,cAAc,CAAC,OAAO,EAAE,sBAAsB,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACrF;AAED;;;;GAIG;AACH,MAAM,WAAW,uBAAuB;IACpC;;;;;;;OAOG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,QAAQ,CAAC,EAAE,GAAG,CAAC;CAClB;AAED;;;;;;;;;GASG;AACH,MAAM,WAAW,sBAAsB;IACnC;;OAEG;IACH,OAAO,EAAE,kBAAkB,CAAC;IAE5B;;;;;;OAMG;IACH,MAAM,EAAE,GAAG,CAAC;CACf;AAMD;;;;;;;;;;GAUG;AACH,wBAAgB,gBAAgB,CAC5B,OAAO,EAAE,kBAAkB,EAC3B,UAAU,EAAE,oBAAoB,GACjC,kBAAkB,CAEpB"}
|
package/esm/backend/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/backend/index.ts"],"names":[],"mappings":"AAAA,qCAAqC;
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/backend/index.ts"],"names":[],"mappings":"AAAA,qCAAqC;AAgSrC,EAAE;AACF,qCAAqC;AACrC,EAAE;AAEF;;;;;;;;;;GAUG;AACH,MAAM,UAAU,gBAAgB,CAC5B,OAA2B,EAC3B,UAAgC;IAEhC,OAAO,OAAO,CAAC,SAAS,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,SAAS,EAAE,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;AACzF,CAAC"}
|
package/esm/index.d.ts
CHANGED
|
@@ -48,4 +48,5 @@ export { IOrganizationPermissionService, IPermissionsAssignment } from "./organi
|
|
|
48
48
|
export { IOrganizationNotificationChannelService } from "./organization/notificationChannels/index.js";
|
|
49
49
|
export { IDataFiltersService } from "./workspace/dataFilter/index.js";
|
|
50
50
|
export { IWorkspaceLogicalModelService, IDateDataset } from "./workspace/ldm/model.js";
|
|
51
|
+
export { IWorkspaceAutomationService, IGetAutomationOptions, IGetAutomationsOptions, AutomationType, IAutomationsQuery, IAutomationsQueryResult, } from "./workspace/automations/index.js";
|
|
51
52
|
//# sourceMappingURL=index.d.ts.map
|
package/esm/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA;;;;;;;;GAQG;AACH,OAAO,EACH,kBAAkB,EAClB,wBAAwB,EACxB,wBAAwB,EACxB,gBAAgB,EAChB,sBAAsB,EACtB,uBAAuB,EACvB,uBAAuB,EACvB,uBAAuB,GAC1B,MAAM,oBAAoB,CAAC;AAE5B,OAAO,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAC;AAEjE,OAAO,EAAE,aAAa,EAAE,kBAAkB,EAAE,sBAAsB,EAAE,MAAM,sBAAsB,CAAC;AAEjG,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAC/C,OAAO,EAAE,oBAAoB,EAAE,MAAM,0BAA0B,CAAC;AAEhE,OAAO,EACH,iBAAiB,EACjB,kBAAkB,EAClB,gBAAgB,EAChB,SAAS,EACT,aAAa,EACb,aAAa,EACb,cAAc,EACd,gBAAgB,EAChB,WAAW,EACX,eAAe,EACf,eAAe,EACf,uBAAuB,EACvB,uBAAuB,EACvB,iBAAiB,EACjB,iBAAiB,GACpB,MAAM,gCAAgC,CAAC;AAExC,OAAO,EAAE,yBAAyB,EAAE,MAAM,+BAA+B,CAAC;AAE1E,OAAO,EAAE,iBAAiB,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAExE,OAAO,EACH,kBAAkB,EAClB,+BAA+B,EAC/B,yBAAyB,EACzB,eAAe,EACf,qBAAqB,EACrB,cAAc,EACd,oBAAoB,EACpB,kBAAkB,EAClB,mBAAmB,EACnB,qBAAqB,EACrB,8BAA8B,GACjC,MAAM,+BAA+B,CAAC;AAEvC,OAAO,EACH,wBAAwB,EACxB,uBAAuB,EACvB,8BAA8B,EAC9B,6BAA6B,EAC7B,2BAA2B,EAC3B,kCAAkC,EAClC,kCAAkC,EAClC,iCAAiC,EACjC,yBAAyB,GAC5B,MAAM,wCAAwC,CAAC;AAEhD,OAAO,EACH,qBAAqB,EACrB,oBAAoB,EACpB,cAAc,EACd,qBAAqB,EACrB,6BAA6B,EAC7B,kCAAkC,EAClC,oCAAoC,EACpC,sDAAsD,EACtD,yCAAyC,EACzC,qCAAqC,EACrC,uDAAuD,EACvD,wCAAwC,EACxC,oBAAoB,EACpB,4BAA4B,GAC/B,MAAM,0CAA0C,CAAC;AAElD,OAAO,EAAE,aAAa,EAAE,aAAa,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAC;AAEjG,OAAO,EAAE,wBAAwB,EAAE,MAAM,8BAA8B,CAAC;AACxE,OAAO,EACH,sBAAsB,EACtB,WAAW,EACX,iBAAiB,EACjB,YAAY,EACZ,kBAAkB,EAClB,uBAAuB,EACvB,eAAe,EACf,YAAY,EACZ,cAAc,EACd,gBAAgB,EAChB,sBAAsB,EACtB,YAAY,EACZ,eAAe,EACf,cAAc,EACd,wBAAwB,EACxB,aAAa,EACb,mBAAmB,EACnB,oBAAoB,EACpB,yBAAyB,EACzB,iBAAiB,EACjB,cAAc,EACd,gBAAgB,EAChB,kBAAkB,EAClB,cAAc,EACd,iBAAiB,EACjB,kBAAkB,EAClB,2BAA2B,GAC9B,MAAM,mBAAmB,CAAC;AAE3B,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAEpD,OAAO,EACH,oBAAoB,EACpB,gBAAgB,EAChB,uBAAuB,EACvB,sBAAsB,EACtB,sBAAsB,EACtB,uBAAuB,EACvB,oBAAoB,EACpB,0BAA0B,GAC7B,MAAM,sBAAsB,CAAC;AAE9B,OAAO,EAAE,4BAA4B,EAAE,MAAM,2CAA2C,CAAC;AAEzF,OAAO,EAAE,4BAA4B,EAAE,MAAM,kCAAkC,CAAC;AAEhF,OAAO,EAAE,2BAA2B,EAAE,MAAM,iCAAiC,CAAC;AAE9E,OAAO,EACH,yBAAyB,EACzB,mBAAmB,EACnB,kBAAkB,GACrB,MAAM,+BAA+B,CAAC;AAEvC,OAAO,EAAE,sBAAsB,EAAE,MAAM,4BAA4B,CAAC;AAEpE,OAAO,EACH,2BAA2B,EAC3B,oBAAoB,EACpB,0BAA0B,EAC1B,wBAAwB,EACxB,iBAAiB,EACjB,gCAAgC,EAChC,iBAAiB,EACjB,6BAA6B,EAC7B,oBAAoB,EACpB,wBAAwB,EACxB,gBAAgB,EAChB,sBAAsB,GACzB,MAAM,iCAAiC,CAAC;AACzC,OAAO,EACH,sBAAsB,EACtB,qBAAqB,EACrB,UAAU,EACV,aAAa,EACb,sBAAsB,EACtB,UAAU,GACb,MAAM,iCAAiC,CAAC;AACzC,OAAO,EACH,oBAAoB,EACpB,2BAA2B,EAC3B,0BAA0B,GAC7B,MAAM,4BAA4B,CAAC;AACpC,OAAO,EACH,uBAAuB,EACvB,6BAA6B,GAChC,MAAM,wCAAwC,CAAC;AAEhD,OAAO,EACH,wBAAwB,EACxB,sCAAsC,EACtC,iBAAiB,EACjB,+BAA+B,EAC/B,mCAAmC,EACnC,iDAAiD,EACjD,+BAA+B,EAC/B,wBAAwB,GAC3B,MAAM,4BAA4B,CAAC;AAEpC,OAAO,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAC;AAExE,OAAO,EACH,uBAAuB,EACvB,sBAAsB,EACtB,gCAAgC,EAChC,oBAAoB,EACpB,uBAAuB,EACvB,uBAAuB,GAC1B,MAAM,iCAAiC,CAAC;AAEzC,OAAO,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AACxE,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AACxD,OAAO,EAAE,mBAAmB,EAAE,MAAM,wBAAwB,CAAC;AAC7D,OAAO,EAAE,wBAAwB,EAAE,iBAAiB,EAAE,MAAM,0CAA0C,CAAC;AACvG,OAAO,EAAE,2BAA2B,EAAE,MAAM,iCAAiC,CAAC;AAC9E,OAAO,EAAE,4BAA4B,EAAE,MAAM,kCAAkC,CAAC;AAEhF,OAAO,EACH,yBAAyB,EACzB,gCAAgC,EAChC,+BAA+B,GAClC,MAAM,iCAAiC,CAAC;AAEzC,OAAO,EAAE,8BAA8B,EAAE,MAAM,oCAAoC,CAAC;AAEpF,OAAO,EACH,wBAAwB,EACxB,uBAAuB,EACvB,6BAA6B,EAC7B,4BAA4B,EAC5B,kCAAkC,GACrC,MAAM,+BAA+B,CAAC;AACvC,OAAO,EAAE,8BAA8B,EAAE,sBAAsB,EAAE,MAAM,qCAAqC,CAAC;AAC7G,OAAO,EAAE,uCAAuC,EAAE,MAAM,8CAA8C,CAAC;AACvG,OAAO,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAC;AAEtE,OAAO,EAAE,6BAA6B,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC"}
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA;;;;;;;;GAQG;AACH,OAAO,EACH,kBAAkB,EAClB,wBAAwB,EACxB,wBAAwB,EACxB,gBAAgB,EAChB,sBAAsB,EACtB,uBAAuB,EACvB,uBAAuB,EACvB,uBAAuB,GAC1B,MAAM,oBAAoB,CAAC;AAE5B,OAAO,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAC;AAEjE,OAAO,EAAE,aAAa,EAAE,kBAAkB,EAAE,sBAAsB,EAAE,MAAM,sBAAsB,CAAC;AAEjG,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAC/C,OAAO,EAAE,oBAAoB,EAAE,MAAM,0BAA0B,CAAC;AAEhE,OAAO,EACH,iBAAiB,EACjB,kBAAkB,EAClB,gBAAgB,EAChB,SAAS,EACT,aAAa,EACb,aAAa,EACb,cAAc,EACd,gBAAgB,EAChB,WAAW,EACX,eAAe,EACf,eAAe,EACf,uBAAuB,EACvB,uBAAuB,EACvB,iBAAiB,EACjB,iBAAiB,GACpB,MAAM,gCAAgC,CAAC;AAExC,OAAO,EAAE,yBAAyB,EAAE,MAAM,+BAA+B,CAAC;AAE1E,OAAO,EAAE,iBAAiB,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAExE,OAAO,EACH,kBAAkB,EAClB,+BAA+B,EAC/B,yBAAyB,EACzB,eAAe,EACf,qBAAqB,EACrB,cAAc,EACd,oBAAoB,EACpB,kBAAkB,EAClB,mBAAmB,EACnB,qBAAqB,EACrB,8BAA8B,GACjC,MAAM,+BAA+B,CAAC;AAEvC,OAAO,EACH,wBAAwB,EACxB,uBAAuB,EACvB,8BAA8B,EAC9B,6BAA6B,EAC7B,2BAA2B,EAC3B,kCAAkC,EAClC,kCAAkC,EAClC,iCAAiC,EACjC,yBAAyB,GAC5B,MAAM,wCAAwC,CAAC;AAEhD,OAAO,EACH,qBAAqB,EACrB,oBAAoB,EACpB,cAAc,EACd,qBAAqB,EACrB,6BAA6B,EAC7B,kCAAkC,EAClC,oCAAoC,EACpC,sDAAsD,EACtD,yCAAyC,EACzC,qCAAqC,EACrC,uDAAuD,EACvD,wCAAwC,EACxC,oBAAoB,EACpB,4BAA4B,GAC/B,MAAM,0CAA0C,CAAC;AAElD,OAAO,EAAE,aAAa,EAAE,aAAa,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAC;AAEjG,OAAO,EAAE,wBAAwB,EAAE,MAAM,8BAA8B,CAAC;AACxE,OAAO,EACH,sBAAsB,EACtB,WAAW,EACX,iBAAiB,EACjB,YAAY,EACZ,kBAAkB,EAClB,uBAAuB,EACvB,eAAe,EACf,YAAY,EACZ,cAAc,EACd,gBAAgB,EAChB,sBAAsB,EACtB,YAAY,EACZ,eAAe,EACf,cAAc,EACd,wBAAwB,EACxB,aAAa,EACb,mBAAmB,EACnB,oBAAoB,EACpB,yBAAyB,EACzB,iBAAiB,EACjB,cAAc,EACd,gBAAgB,EAChB,kBAAkB,EAClB,cAAc,EACd,iBAAiB,EACjB,kBAAkB,EAClB,2BAA2B,GAC9B,MAAM,mBAAmB,CAAC;AAE3B,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAEpD,OAAO,EACH,oBAAoB,EACpB,gBAAgB,EAChB,uBAAuB,EACvB,sBAAsB,EACtB,sBAAsB,EACtB,uBAAuB,EACvB,oBAAoB,EACpB,0BAA0B,GAC7B,MAAM,sBAAsB,CAAC;AAE9B,OAAO,EAAE,4BAA4B,EAAE,MAAM,2CAA2C,CAAC;AAEzF,OAAO,EAAE,4BAA4B,EAAE,MAAM,kCAAkC,CAAC;AAEhF,OAAO,EAAE,2BAA2B,EAAE,MAAM,iCAAiC,CAAC;AAE9E,OAAO,EACH,yBAAyB,EACzB,mBAAmB,EACnB,kBAAkB,GACrB,MAAM,+BAA+B,CAAC;AAEvC,OAAO,EAAE,sBAAsB,EAAE,MAAM,4BAA4B,CAAC;AAEpE,OAAO,EACH,2BAA2B,EAC3B,oBAAoB,EACpB,0BAA0B,EAC1B,wBAAwB,EACxB,iBAAiB,EACjB,gCAAgC,EAChC,iBAAiB,EACjB,6BAA6B,EAC7B,oBAAoB,EACpB,wBAAwB,EACxB,gBAAgB,EAChB,sBAAsB,GACzB,MAAM,iCAAiC,CAAC;AACzC,OAAO,EACH,sBAAsB,EACtB,qBAAqB,EACrB,UAAU,EACV,aAAa,EACb,sBAAsB,EACtB,UAAU,GACb,MAAM,iCAAiC,CAAC;AACzC,OAAO,EACH,oBAAoB,EACpB,2BAA2B,EAC3B,0BAA0B,GAC7B,MAAM,4BAA4B,CAAC;AACpC,OAAO,EACH,uBAAuB,EACvB,6BAA6B,GAChC,MAAM,wCAAwC,CAAC;AAEhD,OAAO,EACH,wBAAwB,EACxB,sCAAsC,EACtC,iBAAiB,EACjB,+BAA+B,EAC/B,mCAAmC,EACnC,iDAAiD,EACjD,+BAA+B,EAC/B,wBAAwB,GAC3B,MAAM,4BAA4B,CAAC;AAEpC,OAAO,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAC;AAExE,OAAO,EACH,uBAAuB,EACvB,sBAAsB,EACtB,gCAAgC,EAChC,oBAAoB,EACpB,uBAAuB,EACvB,uBAAuB,GAC1B,MAAM,iCAAiC,CAAC;AAEzC,OAAO,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AACxE,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AACxD,OAAO,EAAE,mBAAmB,EAAE,MAAM,wBAAwB,CAAC;AAC7D,OAAO,EAAE,wBAAwB,EAAE,iBAAiB,EAAE,MAAM,0CAA0C,CAAC;AACvG,OAAO,EAAE,2BAA2B,EAAE,MAAM,iCAAiC,CAAC;AAC9E,OAAO,EAAE,4BAA4B,EAAE,MAAM,kCAAkC,CAAC;AAEhF,OAAO,EACH,yBAAyB,EACzB,gCAAgC,EAChC,+BAA+B,GAClC,MAAM,iCAAiC,CAAC;AAEzC,OAAO,EAAE,8BAA8B,EAAE,MAAM,oCAAoC,CAAC;AAEpF,OAAO,EACH,wBAAwB,EACxB,uBAAuB,EACvB,6BAA6B,EAC7B,4BAA4B,EAC5B,kCAAkC,GACrC,MAAM,+BAA+B,CAAC;AACvC,OAAO,EAAE,8BAA8B,EAAE,sBAAsB,EAAE,MAAM,qCAAqC,CAAC;AAC7G,OAAO,EAAE,uCAAuC,EAAE,MAAM,8CAA8C,CAAC;AACvG,OAAO,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAC;AAEtE,OAAO,EAAE,6BAA6B,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AAEvF,OAAO,EACH,2BAA2B,EAC3B,qBAAqB,EACrB,sBAAsB,EACtB,cAAc,EACd,iBAAiB,EACjB,uBAAuB,GAC1B,MAAM,kCAAkC,CAAC"}
|
package/esm/sdk-backend-spi.d.ts
CHANGED
|
@@ -21,6 +21,8 @@ import { IAttributeElement } from '@gooddata/sdk-model';
|
|
|
21
21
|
import { IAttributeFilter } from '@gooddata/sdk-model';
|
|
22
22
|
import { IAttributeMetadataObject } from '@gooddata/sdk-model';
|
|
23
23
|
import { IAttributeOrMeasure } from '@gooddata/sdk-model';
|
|
24
|
+
import { IAutomationMetadataObject } from '@gooddata/sdk-model';
|
|
25
|
+
import { IAutomationMetadataObjectDefinition } from '@gooddata/sdk-model';
|
|
24
26
|
import { IAvailableAccessGrantee } from '@gooddata/sdk-model';
|
|
25
27
|
import { IBucket } from '@gooddata/sdk-model';
|
|
26
28
|
import { ICatalogAttribute } from '@gooddata/sdk-model';
|
|
@@ -53,8 +55,8 @@ import { IEntitlementDescriptor } from '@gooddata/sdk-model';
|
|
|
53
55
|
import { IExecutionConfig } from '@gooddata/sdk-model';
|
|
54
56
|
import { IExecutionDefinition } from '@gooddata/sdk-model';
|
|
55
57
|
import { IExistingDashboard } from '@gooddata/sdk-model';
|
|
56
|
-
import {
|
|
57
|
-
import {
|
|
58
|
+
import { IExportDefinitionMetadataObject } from '@gooddata/sdk-model';
|
|
59
|
+
import { IExportDefinitionMetadataObjectDefinition } from '@gooddata/sdk-model';
|
|
58
60
|
import { IFilter } from '@gooddata/sdk-model';
|
|
59
61
|
import { IFilterContextDefinition } from '@gooddata/sdk-model';
|
|
60
62
|
import { IGranularAccessGrantee } from '@gooddata/sdk-model';
|
|
@@ -164,6 +166,13 @@ export declare type AuthenticationFlow = {
|
|
|
164
166
|
returnRedirectParam: string;
|
|
165
167
|
};
|
|
166
168
|
|
|
169
|
+
/**
|
|
170
|
+
* Type of workspace automation.
|
|
171
|
+
*
|
|
172
|
+
* @alpha
|
|
173
|
+
*/
|
|
174
|
+
export declare type AutomationType = "schedule" | "trigger";
|
|
175
|
+
|
|
167
176
|
/**
|
|
168
177
|
* Options that is used for propagation cancellation signal / abort signal
|
|
169
178
|
* @beta
|
|
@@ -330,10 +339,11 @@ export declare interface IAnalyticalBackend {
|
|
|
330
339
|
authenticate(force?: boolean): Promise<IAuthenticatedPrincipal>;
|
|
331
340
|
/**
|
|
332
341
|
* Triggers deauthentication process against the backend.
|
|
342
|
+
* @param returnTo - url to redirect after successful relogin
|
|
333
343
|
*
|
|
334
344
|
* @returns promise of the completed process, or rejection if deauthentication failed.
|
|
335
345
|
*/
|
|
336
|
-
deauthenticate(): Promise<void>;
|
|
346
|
+
deauthenticate(returnTo?: string): Promise<void>;
|
|
337
347
|
/**
|
|
338
348
|
* Returns an organization available on the backend.
|
|
339
349
|
* @param organizationId - unique ID of the organization
|
|
@@ -418,6 +428,12 @@ export declare interface IAnalyticalWorkspace {
|
|
|
418
428
|
* Returns parent analytical workspace when this workspace has a parent, undefined otherwise.
|
|
419
429
|
*/
|
|
420
430
|
getParentWorkspace(): Promise<IAnalyticalWorkspace | undefined>;
|
|
431
|
+
/**
|
|
432
|
+
* Returns service that can be used to query and update workspace automations.
|
|
433
|
+
*
|
|
434
|
+
* @alpha
|
|
435
|
+
*/
|
|
436
|
+
automations(): IWorkspaceAutomationService;
|
|
421
437
|
/**
|
|
422
438
|
* Returns factory that can be used to query workspace catalog items - attributes, measures, facts and date data sets.
|
|
423
439
|
*/
|
|
@@ -661,10 +677,72 @@ export declare interface IAuthenticationProvider {
|
|
|
661
677
|
* Clear existing authentication.
|
|
662
678
|
*
|
|
663
679
|
* @param context - context in which the authentication is done
|
|
680
|
+
* @param returnTo - url to redirect after successful logout
|
|
681
|
+
*/
|
|
682
|
+
deauthenticate(context: IAuthenticationContext, returnTo?: string): Promise<void>;
|
|
683
|
+
}
|
|
684
|
+
|
|
685
|
+
/**
|
|
686
|
+
* Service to query automations.
|
|
687
|
+
*
|
|
688
|
+
* @public
|
|
689
|
+
*/
|
|
690
|
+
export declare interface IAutomationsQuery {
|
|
691
|
+
/**
|
|
692
|
+
* Sets number of automations to return per page.
|
|
693
|
+
* Default size: 50
|
|
694
|
+
*
|
|
695
|
+
* @param size - desired max number of automations per page must be a positive number
|
|
696
|
+
* @returns automations query
|
|
697
|
+
*/
|
|
698
|
+
withSize(size: number): IAutomationsQuery;
|
|
699
|
+
/**
|
|
700
|
+
* Sets starting page for the query. Backend WILL return no data if the page is greater than
|
|
701
|
+
* total number of pages.
|
|
702
|
+
* Default page: 0
|
|
703
|
+
*
|
|
704
|
+
* @param page - zero indexed, must be non-negative
|
|
705
|
+
* @returns automations query
|
|
706
|
+
*/
|
|
707
|
+
withPage(page: number): IAutomationsQuery;
|
|
708
|
+
/**
|
|
709
|
+
* Sets filter for the query.
|
|
710
|
+
*
|
|
711
|
+
* @param filter - filter to apply
|
|
712
|
+
* @returns automations query
|
|
713
|
+
*/
|
|
714
|
+
withFilter(filter: {
|
|
715
|
+
title?: string;
|
|
716
|
+
}): IAutomationsQuery;
|
|
717
|
+
/**
|
|
718
|
+
* Sets sorting for the query.
|
|
719
|
+
*
|
|
720
|
+
* @param sort - Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
721
|
+
* @returns automations query
|
|
722
|
+
*/
|
|
723
|
+
withSorting(sort: string[]): IAutomationsQuery;
|
|
724
|
+
/**
|
|
725
|
+
* Sets type of the automation for the query.
|
|
726
|
+
*
|
|
727
|
+
* @param type - type of the automation, e.g. "schedule" or "trigger"
|
|
728
|
+
* @returns automations query
|
|
729
|
+
*/
|
|
730
|
+
withType(type: AutomationType): IAutomationsQuery;
|
|
731
|
+
/**
|
|
732
|
+
* Starts the automations query.
|
|
733
|
+
*
|
|
734
|
+
* @returns promise of first page of the results
|
|
664
735
|
*/
|
|
665
|
-
|
|
736
|
+
query(): Promise<IAutomationsQueryResult>;
|
|
666
737
|
}
|
|
667
738
|
|
|
739
|
+
/**
|
|
740
|
+
* Queried automations are returned in a paged representation.
|
|
741
|
+
*
|
|
742
|
+
* @public
|
|
743
|
+
*/
|
|
744
|
+
export declare type IAutomationsQueryResult = IPagedResource<IAutomationMetadataObject>;
|
|
745
|
+
|
|
668
746
|
/**
|
|
669
747
|
* Analytical Backend communicates its capabilities via objects of this type. In return, the capabilities
|
|
670
748
|
* can then be used by applications to enable / disable particular features.
|
|
@@ -1752,7 +1830,7 @@ export declare type IExplainResult = {
|
|
|
1752
1830
|
};
|
|
1753
1831
|
|
|
1754
1832
|
/**
|
|
1755
|
-
* Configuration for exports of results into
|
|
1833
|
+
* Configuration for exports of results into tabular formats.
|
|
1756
1834
|
*
|
|
1757
1835
|
* @public
|
|
1758
1836
|
*/
|
|
@@ -1771,19 +1849,30 @@ export declare interface IExportConfig {
|
|
|
1771
1849
|
*/
|
|
1772
1850
|
mergeHeaders?: boolean;
|
|
1773
1851
|
/**
|
|
1774
|
-
* Applicable for XLSX format; specifies filters to include as comments / metadata in
|
|
1852
|
+
* Applicable for XLSX, and PDF format; specifies filters to include as comments / metadata in
|
|
1775
1853
|
* the Excel sheet.
|
|
1776
1854
|
*
|
|
1777
1855
|
* @remarks
|
|
1778
1856
|
* Filters provided here are purely to paint a better context for the
|
|
1779
|
-
* person looking at the
|
|
1780
|
-
*
|
|
1857
|
+
* person looking at the exported file. They serve no other purpose and are merely serialized
|
|
1858
|
+
* in the export in a human-readable form.
|
|
1859
|
+
* The visualizationObjectId has to be provided to make this work for PDF format.
|
|
1781
1860
|
*/
|
|
1782
1861
|
showFilters?: boolean;
|
|
1783
1862
|
/**
|
|
1784
|
-
*
|
|
1863
|
+
* Applicable for PDF format; specifies configuration for PDF export.
|
|
1785
1864
|
*/
|
|
1786
1865
|
pdfConfiguration?: IExportPdfConfig;
|
|
1866
|
+
/**
|
|
1867
|
+
* Visualization object identifier. Used to ensure the export result is generated based on
|
|
1868
|
+
* existing visualization in the PDF document. (PDF only)
|
|
1869
|
+
*/
|
|
1870
|
+
visualizationObjectId?: string;
|
|
1871
|
+
/**
|
|
1872
|
+
* Optional custom filters (as array of IFilter objects defined in UI SDK) to be applied
|
|
1873
|
+
* when visualizationObject is given. (PDF only)
|
|
1874
|
+
*/
|
|
1875
|
+
visualizationObjectCustomFilters?: Array<IFilter>;
|
|
1787
1876
|
}
|
|
1788
1877
|
|
|
1789
1878
|
/**
|
|
@@ -1874,7 +1963,7 @@ export declare interface IExportDefinitionsQueryOptions {
|
|
|
1874
1963
|
*
|
|
1875
1964
|
* @alpha
|
|
1876
1965
|
*/
|
|
1877
|
-
export declare type IExportDefinitionsQueryResult = IPagedResource<
|
|
1966
|
+
export declare type IExportDefinitionsQueryResult = IPagedResource<IExportDefinitionMetadataObject>;
|
|
1878
1967
|
|
|
1879
1968
|
/**
|
|
1880
1969
|
* Configuration for PDF export.
|
|
@@ -1882,7 +1971,12 @@ export declare type IExportDefinitionsQueryResult = IPagedResource<IExportDefini
|
|
|
1882
1971
|
* @public
|
|
1883
1972
|
*/
|
|
1884
1973
|
export declare interface IExportPdfConfig {
|
|
1885
|
-
orientation
|
|
1974
|
+
/** Page size and orientation (e.g. 'a4 landscape'). */
|
|
1975
|
+
pdfPageSize?: string;
|
|
1976
|
+
/** PDF top left header content. */
|
|
1977
|
+
pdfTopLeftContent?: string;
|
|
1978
|
+
/** PDF top right header content. */
|
|
1979
|
+
pdfTopRightContent?: string;
|
|
1886
1980
|
}
|
|
1887
1981
|
|
|
1888
1982
|
/**
|
|
@@ -1976,6 +2070,46 @@ export declare interface IForecastView {
|
|
|
1976
2070
|
loading: boolean;
|
|
1977
2071
|
}
|
|
1978
2072
|
|
|
2073
|
+
/**
|
|
2074
|
+
* Configuration options for loading automation metadata object.
|
|
2075
|
+
*
|
|
2076
|
+
* @alpha
|
|
2077
|
+
*/
|
|
2078
|
+
export declare interface IGetAutomationOptions {
|
|
2079
|
+
/**
|
|
2080
|
+
* Specify if information about the users that created/modified the automation should be loaded.
|
|
2081
|
+
*
|
|
2082
|
+
* @remarks
|
|
2083
|
+
* Defaults to false.
|
|
2084
|
+
*
|
|
2085
|
+
* If user is inactive or logged in user has not rights to access this information than users that created/modified is undefined.
|
|
2086
|
+
*/
|
|
2087
|
+
loadUserData?: boolean;
|
|
2088
|
+
}
|
|
2089
|
+
|
|
2090
|
+
/**
|
|
2091
|
+
* Configuration options for loading automation metadata objects.
|
|
2092
|
+
*
|
|
2093
|
+
* @alpha
|
|
2094
|
+
*/
|
|
2095
|
+
export declare interface IGetAutomationsOptions {
|
|
2096
|
+
/**
|
|
2097
|
+
* Specify (zero-based) starting offset for the results. Default: 0
|
|
2098
|
+
*/
|
|
2099
|
+
offset?: number;
|
|
2100
|
+
/**
|
|
2101
|
+
* Specify number of items per page. Default: 50
|
|
2102
|
+
*/
|
|
2103
|
+
limit?: number;
|
|
2104
|
+
/**
|
|
2105
|
+
* Specify if information about the users that created/modified the exportDefinitions should be loaded for each exportDefinition.
|
|
2106
|
+
*
|
|
2107
|
+
* @remarks
|
|
2108
|
+
* Defaults to false.
|
|
2109
|
+
*/
|
|
2110
|
+
loadUserData?: boolean;
|
|
2111
|
+
}
|
|
2112
|
+
|
|
1979
2113
|
/**
|
|
1980
2114
|
* Configuration options for getting dashboards.
|
|
1981
2115
|
*
|
|
@@ -3447,6 +3581,60 @@ export declare interface IWorkspaceAttributesService {
|
|
|
3447
3581
|
getConnectedAttributesByDisplayForm(ref: ObjRef): Promise<ObjRef[]>;
|
|
3448
3582
|
}
|
|
3449
3583
|
|
|
3584
|
+
/**
|
|
3585
|
+
* This service provides access to workspace automations.
|
|
3586
|
+
*
|
|
3587
|
+
* @alpha
|
|
3588
|
+
*/
|
|
3589
|
+
export declare interface IWorkspaceAutomationService {
|
|
3590
|
+
/**
|
|
3591
|
+
* List automations
|
|
3592
|
+
*
|
|
3593
|
+
* @returns methods for querying automations
|
|
3594
|
+
*/
|
|
3595
|
+
getAutomationsQuery(): IAutomationsQuery;
|
|
3596
|
+
/**
|
|
3597
|
+
* Get all automations
|
|
3598
|
+
*
|
|
3599
|
+
* @param options - specify additional options
|
|
3600
|
+
* @returns Promise resolved with array of automations.
|
|
3601
|
+
* @throws In case of error.
|
|
3602
|
+
*
|
|
3603
|
+
*/
|
|
3604
|
+
getAutomations(options?: IGetAutomationsOptions): Promise<IAutomationMetadataObject[]>;
|
|
3605
|
+
/**
|
|
3606
|
+
* Get atuomation by id
|
|
3607
|
+
*
|
|
3608
|
+
* @param id - id of the automation
|
|
3609
|
+
* @param options - specify additional options
|
|
3610
|
+
* @returns Promise resolved with automation definition
|
|
3611
|
+
*/
|
|
3612
|
+
getAutomation(id: string, options?: IGetAutomationOptions): Promise<IAutomationMetadataObject>;
|
|
3613
|
+
/**
|
|
3614
|
+
* Create new automation
|
|
3615
|
+
*
|
|
3616
|
+
* @param automation - definition of the automation
|
|
3617
|
+
* @param options - specify additional options
|
|
3618
|
+
* @returns Promise resolved with created automation.
|
|
3619
|
+
*/
|
|
3620
|
+
createAutomation(automation: IAutomationMetadataObjectDefinition, options?: IGetAutomationOptions): Promise<IAutomationMetadataObject>;
|
|
3621
|
+
/**
|
|
3622
|
+
* Update existing automation
|
|
3623
|
+
*
|
|
3624
|
+
* @param automation - definition of the automation
|
|
3625
|
+
* @param options - specify additional options
|
|
3626
|
+
* @returns Promise resolved when the automation is updated.
|
|
3627
|
+
*/
|
|
3628
|
+
updateAutomation(automation: IAutomationMetadataObject, options?: IGetAutomationOptions): Promise<IAutomationMetadataObject>;
|
|
3629
|
+
/**
|
|
3630
|
+
* Delete automation
|
|
3631
|
+
*
|
|
3632
|
+
* @param id - id of the automation
|
|
3633
|
+
* @returns Promise resolved when the automation is deleted.
|
|
3634
|
+
*/
|
|
3635
|
+
deleteAutomation(id: string): Promise<void>;
|
|
3636
|
+
}
|
|
3637
|
+
|
|
3450
3638
|
/**
|
|
3451
3639
|
* Instance of workspace catalog with loaded items
|
|
3452
3640
|
*
|
|
@@ -4057,7 +4245,7 @@ export declare interface IWorkspaceDescriptorUpdate {
|
|
|
4057
4245
|
|
|
4058
4246
|
/**
|
|
4059
4247
|
* Service to query, update or delete exportDefinitions, and other methods related to exportDefinitions.
|
|
4060
|
-
* Check
|
|
4248
|
+
* Check IExportDefinitionMetadataObject for more details.
|
|
4061
4249
|
*
|
|
4062
4250
|
* @alpha
|
|
4063
4251
|
*/
|
|
@@ -4069,7 +4257,7 @@ export declare interface IWorkspaceExportDefinitionsService {
|
|
|
4069
4257
|
* @param options - specify additional options
|
|
4070
4258
|
* @returns promise of exportDefinition
|
|
4071
4259
|
*/
|
|
4072
|
-
getExportDefinition(ref: ObjRef, options?: IGetExportDefinitionOptions): Promise<
|
|
4260
|
+
getExportDefinition(ref: ObjRef, options?: IGetExportDefinitionOptions): Promise<IExportDefinitionMetadataObject>;
|
|
4073
4261
|
/**
|
|
4074
4262
|
* Queries workspace exportDefinitions, using various criteria and paging settings.
|
|
4075
4263
|
*
|
|
@@ -4089,7 +4277,7 @@ export declare interface IWorkspaceExportDefinitionsService {
|
|
|
4089
4277
|
* @param exportDefinition - exportDefinition to create
|
|
4090
4278
|
* @returns promise of created exportDefinition
|
|
4091
4279
|
*/
|
|
4092
|
-
createExportDefinition(exportDefinition:
|
|
4280
|
+
createExportDefinition(exportDefinition: IExportDefinitionMetadataObjectDefinition): Promise<IExportDefinitionMetadataObject>;
|
|
4093
4281
|
/**
|
|
4094
4282
|
* Update provided exportDefinition
|
|
4095
4283
|
*
|
|
@@ -4097,7 +4285,7 @@ export declare interface IWorkspaceExportDefinitionsService {
|
|
|
4097
4285
|
* @param exportDefinition - exportDefinition to update
|
|
4098
4286
|
* @returns promise of updated exportDefinition
|
|
4099
4287
|
*/
|
|
4100
|
-
updateExportDefinition(ref: ObjRef, exportDefinition:
|
|
4288
|
+
updateExportDefinition(ref: ObjRef, exportDefinition: IExportDefinitionMetadataObjectDefinition): Promise<IExportDefinitionMetadataObject>;
|
|
4101
4289
|
/**
|
|
4102
4290
|
* Delete exportDefinition with the given reference
|
|
4103
4291
|
*
|
|
@@ -0,0 +1,159 @@
|
|
|
1
|
+
import { IAutomationMetadataObject, IAutomationMetadataObjectDefinition } from "@gooddata/sdk-model";
|
|
2
|
+
import { IPagedResource } from "../../common/paging.js";
|
|
3
|
+
/**
|
|
4
|
+
* Type of workspace automation.
|
|
5
|
+
*
|
|
6
|
+
* @alpha
|
|
7
|
+
*/
|
|
8
|
+
export type AutomationType = "schedule" | "trigger";
|
|
9
|
+
/**
|
|
10
|
+
* Configuration options for loading automation metadata objects.
|
|
11
|
+
*
|
|
12
|
+
* @alpha
|
|
13
|
+
*/
|
|
14
|
+
export interface IGetAutomationsOptions {
|
|
15
|
+
/**
|
|
16
|
+
* Specify (zero-based) starting offset for the results. Default: 0
|
|
17
|
+
*/
|
|
18
|
+
offset?: number;
|
|
19
|
+
/**
|
|
20
|
+
* Specify number of items per page. Default: 50
|
|
21
|
+
*/
|
|
22
|
+
limit?: number;
|
|
23
|
+
/**
|
|
24
|
+
* Specify if information about the users that created/modified the exportDefinitions should be loaded for each exportDefinition.
|
|
25
|
+
*
|
|
26
|
+
* @remarks
|
|
27
|
+
* Defaults to false.
|
|
28
|
+
*/
|
|
29
|
+
loadUserData?: boolean;
|
|
30
|
+
}
|
|
31
|
+
/**
|
|
32
|
+
* Configuration options for loading automation metadata object.
|
|
33
|
+
*
|
|
34
|
+
* @alpha
|
|
35
|
+
*/
|
|
36
|
+
export interface IGetAutomationOptions {
|
|
37
|
+
/**
|
|
38
|
+
* Specify if information about the users that created/modified the automation should be loaded.
|
|
39
|
+
*
|
|
40
|
+
* @remarks
|
|
41
|
+
* Defaults to false.
|
|
42
|
+
*
|
|
43
|
+
* If user is inactive or logged in user has not rights to access this information than users that created/modified is undefined.
|
|
44
|
+
*/
|
|
45
|
+
loadUserData?: boolean;
|
|
46
|
+
}
|
|
47
|
+
/**
|
|
48
|
+
* This service provides access to workspace automations.
|
|
49
|
+
*
|
|
50
|
+
* @alpha
|
|
51
|
+
*/
|
|
52
|
+
export interface IWorkspaceAutomationService {
|
|
53
|
+
/**
|
|
54
|
+
* List automations
|
|
55
|
+
*
|
|
56
|
+
* @returns methods for querying automations
|
|
57
|
+
*/
|
|
58
|
+
getAutomationsQuery(): IAutomationsQuery;
|
|
59
|
+
/**
|
|
60
|
+
* Get all automations
|
|
61
|
+
*
|
|
62
|
+
* @param options - specify additional options
|
|
63
|
+
* @returns Promise resolved with array of automations.
|
|
64
|
+
* @throws In case of error.
|
|
65
|
+
*
|
|
66
|
+
*/
|
|
67
|
+
getAutomations(options?: IGetAutomationsOptions): Promise<IAutomationMetadataObject[]>;
|
|
68
|
+
/**
|
|
69
|
+
* Get atuomation by id
|
|
70
|
+
*
|
|
71
|
+
* @param id - id of the automation
|
|
72
|
+
* @param options - specify additional options
|
|
73
|
+
* @returns Promise resolved with automation definition
|
|
74
|
+
*/
|
|
75
|
+
getAutomation(id: string, options?: IGetAutomationOptions): Promise<IAutomationMetadataObject>;
|
|
76
|
+
/**
|
|
77
|
+
* Create new automation
|
|
78
|
+
*
|
|
79
|
+
* @param automation - definition of the automation
|
|
80
|
+
* @param options - specify additional options
|
|
81
|
+
* @returns Promise resolved with created automation.
|
|
82
|
+
*/
|
|
83
|
+
createAutomation(automation: IAutomationMetadataObjectDefinition, options?: IGetAutomationOptions): Promise<IAutomationMetadataObject>;
|
|
84
|
+
/**
|
|
85
|
+
* Update existing automation
|
|
86
|
+
*
|
|
87
|
+
* @param automation - definition of the automation
|
|
88
|
+
* @param options - specify additional options
|
|
89
|
+
* @returns Promise resolved when the automation is updated.
|
|
90
|
+
*/
|
|
91
|
+
updateAutomation(automation: IAutomationMetadataObject, options?: IGetAutomationOptions): Promise<IAutomationMetadataObject>;
|
|
92
|
+
/**
|
|
93
|
+
* Delete automation
|
|
94
|
+
*
|
|
95
|
+
* @param id - id of the automation
|
|
96
|
+
* @returns Promise resolved when the automation is deleted.
|
|
97
|
+
*/
|
|
98
|
+
deleteAutomation(id: string): Promise<void>;
|
|
99
|
+
}
|
|
100
|
+
/**
|
|
101
|
+
* Service to query automations.
|
|
102
|
+
*
|
|
103
|
+
* @public
|
|
104
|
+
*/
|
|
105
|
+
export interface IAutomationsQuery {
|
|
106
|
+
/**
|
|
107
|
+
* Sets number of automations to return per page.
|
|
108
|
+
* Default size: 50
|
|
109
|
+
*
|
|
110
|
+
* @param size - desired max number of automations per page must be a positive number
|
|
111
|
+
* @returns automations query
|
|
112
|
+
*/
|
|
113
|
+
withSize(size: number): IAutomationsQuery;
|
|
114
|
+
/**
|
|
115
|
+
* Sets starting page for the query. Backend WILL return no data if the page is greater than
|
|
116
|
+
* total number of pages.
|
|
117
|
+
* Default page: 0
|
|
118
|
+
*
|
|
119
|
+
* @param page - zero indexed, must be non-negative
|
|
120
|
+
* @returns automations query
|
|
121
|
+
*/
|
|
122
|
+
withPage(page: number): IAutomationsQuery;
|
|
123
|
+
/**
|
|
124
|
+
* Sets filter for the query.
|
|
125
|
+
*
|
|
126
|
+
* @param filter - filter to apply
|
|
127
|
+
* @returns automations query
|
|
128
|
+
*/
|
|
129
|
+
withFilter(filter: {
|
|
130
|
+
title?: string;
|
|
131
|
+
}): IAutomationsQuery;
|
|
132
|
+
/**
|
|
133
|
+
* Sets sorting for the query.
|
|
134
|
+
*
|
|
135
|
+
* @param sort - Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
136
|
+
* @returns automations query
|
|
137
|
+
*/
|
|
138
|
+
withSorting(sort: string[]): IAutomationsQuery;
|
|
139
|
+
/**
|
|
140
|
+
* Sets type of the automation for the query.
|
|
141
|
+
*
|
|
142
|
+
* @param type - type of the automation, e.g. "schedule" or "trigger"
|
|
143
|
+
* @returns automations query
|
|
144
|
+
*/
|
|
145
|
+
withType(type: AutomationType): IAutomationsQuery;
|
|
146
|
+
/**
|
|
147
|
+
* Starts the automations query.
|
|
148
|
+
*
|
|
149
|
+
* @returns promise of first page of the results
|
|
150
|
+
*/
|
|
151
|
+
query(): Promise<IAutomationsQueryResult>;
|
|
152
|
+
}
|
|
153
|
+
/**
|
|
154
|
+
* Queried automations are returned in a paged representation.
|
|
155
|
+
*
|
|
156
|
+
* @public
|
|
157
|
+
*/
|
|
158
|
+
export type IAutomationsQueryResult = IPagedResource<IAutomationMetadataObject>;
|
|
159
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/workspace/automations/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,yBAAyB,EAAE,mCAAmC,EAAE,MAAM,qBAAqB,CAAC;AACrG,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AAExD;;;;GAIG;AAEH,MAAM,MAAM,cAAc,GAAG,UAAU,GAAG,SAAS,CAAC;AAEpD;;;;GAIG;AACH,MAAM,WAAW,sBAAsB;IACnC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;;OAKG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;CAC1B;AAED;;;;GAIG;AACH,MAAM,WAAW,qBAAqB;IAClC;;;;;;;OAOG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;CAC1B;AAED;;;;GAIG;AACH,MAAM,WAAW,2BAA2B;IACxC;;;;OAIG;IACH,mBAAmB,IAAI,iBAAiB,CAAC;IAEzC;;;;;;;OAOG;IACH,cAAc,CAAC,OAAO,CAAC,EAAE,sBAAsB,GAAG,OAAO,CAAC,yBAAyB,EAAE,CAAC,CAAC;IAEvF;;;;;;OAMG;IACH,aAAa,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,qBAAqB,GAAG,OAAO,CAAC,yBAAyB,CAAC,CAAC;IAE/F;;;;;;OAMG;IACH,gBAAgB,CACZ,UAAU,EAAE,mCAAmC,EAC/C,OAAO,CAAC,EAAE,qBAAqB,GAChC,OAAO,CAAC,yBAAyB,CAAC,CAAC;IAEtC;;;;;;OAMG;IACH,gBAAgB,CACZ,UAAU,EAAE,yBAAyB,EACrC,OAAO,CAAC,EAAE,qBAAqB,GAChC,OAAO,CAAC,yBAAyB,CAAC,CAAC;IAEtC;;;;;OAKG;IACH,gBAAgB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAC/C;AAED;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IAC9B;;;;;;OAMG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,iBAAiB,CAAC;IAE1C;;;;;;;OAOG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,iBAAiB,CAAC;IAE1C;;;;;OAKG;IACH,UAAU,CAAC,MAAM,EAAE;QAAE,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,iBAAiB,CAAC;IAE1D;;;;;OAKG;IACH,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,iBAAiB,CAAC;IAE/C;;;;;OAKG;IACH,QAAQ,CAAC,IAAI,EAAE,cAAc,GAAG,iBAAiB,CAAC;IAElD;;;;OAIG;IACH,KAAK,IAAI,OAAO,CAAC,uBAAuB,CAAC,CAAC;CAC7C;AAED;;;;GAIG;AACH,MAAM,MAAM,uBAAuB,GAAG,cAAc,CAAC,yBAAyB,CAAC,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/workspace/automations/index.ts"],"names":[],"mappings":"AAAA,qCAAqC"}
|
|
@@ -1,5 +1,6 @@
|
|
|
1
|
+
import { IFilter } from "@gooddata/sdk-model";
|
|
1
2
|
/**
|
|
2
|
-
* Configuration for exports of results into
|
|
3
|
+
* Configuration for exports of results into tabular formats.
|
|
3
4
|
*
|
|
4
5
|
* @public
|
|
5
6
|
*/
|
|
@@ -18,19 +19,30 @@ export interface IExportConfig {
|
|
|
18
19
|
*/
|
|
19
20
|
mergeHeaders?: boolean;
|
|
20
21
|
/**
|
|
21
|
-
* Applicable for XLSX format; specifies filters to include as comments / metadata in
|
|
22
|
+
* Applicable for XLSX, and PDF format; specifies filters to include as comments / metadata in
|
|
22
23
|
* the Excel sheet.
|
|
23
24
|
*
|
|
24
25
|
* @remarks
|
|
25
26
|
* Filters provided here are purely to paint a better context for the
|
|
26
|
-
* person looking at the
|
|
27
|
-
*
|
|
27
|
+
* person looking at the exported file. They serve no other purpose and are merely serialized
|
|
28
|
+
* in the export in a human-readable form.
|
|
29
|
+
* The visualizationObjectId has to be provided to make this work for PDF format.
|
|
28
30
|
*/
|
|
29
31
|
showFilters?: boolean;
|
|
30
32
|
/**
|
|
31
|
-
*
|
|
33
|
+
* Applicable for PDF format; specifies configuration for PDF export.
|
|
32
34
|
*/
|
|
33
35
|
pdfConfiguration?: IExportPdfConfig;
|
|
36
|
+
/**
|
|
37
|
+
* Visualization object identifier. Used to ensure the export result is generated based on
|
|
38
|
+
* existing visualization in the PDF document. (PDF only)
|
|
39
|
+
*/
|
|
40
|
+
visualizationObjectId?: string;
|
|
41
|
+
/**
|
|
42
|
+
* Optional custom filters (as array of IFilter objects defined in UI SDK) to be applied
|
|
43
|
+
* when visualizationObject is given. (PDF only)
|
|
44
|
+
*/
|
|
45
|
+
visualizationObjectCustomFilters?: Array<IFilter>;
|
|
34
46
|
}
|
|
35
47
|
/**
|
|
36
48
|
* Configuration for PDF export.
|
|
@@ -38,7 +50,12 @@ export interface IExportConfig {
|
|
|
38
50
|
* @public
|
|
39
51
|
*/
|
|
40
52
|
export interface IExportPdfConfig {
|
|
41
|
-
orientation
|
|
53
|
+
/** Page size and orientation (e.g. 'a4 landscape'). */
|
|
54
|
+
pdfPageSize?: string;
|
|
55
|
+
/** PDF top left header content. */
|
|
56
|
+
pdfTopLeftContent?: string;
|
|
57
|
+
/** PDF top right header content. */
|
|
58
|
+
pdfTopRightContent?: string;
|
|
42
59
|
}
|
|
43
60
|
/**
|
|
44
61
|
* Result of export is an object URL pointing to a Blob of downloaded data attached to the current
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"export.d.ts","sourceRoot":"","sources":["../../../src/workspace/execution/export.ts"],"names":[],"mappings":"AAEA;;;;GAIG;AACH,MAAM,WAAW,aAAa;IAC1B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,CAAC;IAExC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB
|
|
1
|
+
{"version":3,"file":"export.d.ts","sourceRoot":"","sources":["../../../src/workspace/execution/export.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAE9C;;;;GAIG;AACH,MAAM,WAAW,aAAa;IAC1B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,CAAC;IAExC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB;;;;;;;;;OASG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;OAEG;IACH,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;IAEpC;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAE/B;;;OAGG;IACH,gCAAgC,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;CACrD;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAC7B,uDAAuD;IACvD,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,mCAAmC;IACnC,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,oCAAoC;IACpC,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC/B;AAED;;;;;;;;;GASG;AACH,MAAM,WAAW,aAAa;IAC1B,qDAAqD;IACrD,GAAG,EAAE,MAAM,CAAC;IACZ,kEAAkE;IAClE,SAAS,EAAE,MAAM,CAAC;IAClB,+DAA+D;IAC/D,QAAQ,CAAC,EAAE,MAAM,CAAC;CACrB"}
|
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
import { ObjRef,
|
|
1
|
+
import { ObjRef, IExportDefinitionMetadataObject, IExportDefinitionMetadataObjectDefinition } from "@gooddata/sdk-model";
|
|
2
2
|
import { IPagedResource } from "../../common/paging.js";
|
|
3
3
|
/**
|
|
4
4
|
* Service to query, update or delete exportDefinitions, and other methods related to exportDefinitions.
|
|
5
|
-
* Check
|
|
5
|
+
* Check IExportDefinitionMetadataObject for more details.
|
|
6
6
|
*
|
|
7
7
|
* @alpha
|
|
8
8
|
*/
|
|
@@ -14,7 +14,7 @@ export interface IWorkspaceExportDefinitionsService {
|
|
|
14
14
|
* @param options - specify additional options
|
|
15
15
|
* @returns promise of exportDefinition
|
|
16
16
|
*/
|
|
17
|
-
getExportDefinition(ref: ObjRef, options?: IGetExportDefinitionOptions): Promise<
|
|
17
|
+
getExportDefinition(ref: ObjRef, options?: IGetExportDefinitionOptions): Promise<IExportDefinitionMetadataObject>;
|
|
18
18
|
/**
|
|
19
19
|
* Queries workspace exportDefinitions, using various criteria and paging settings.
|
|
20
20
|
*
|
|
@@ -34,7 +34,7 @@ export interface IWorkspaceExportDefinitionsService {
|
|
|
34
34
|
* @param exportDefinition - exportDefinition to create
|
|
35
35
|
* @returns promise of created exportDefinition
|
|
36
36
|
*/
|
|
37
|
-
createExportDefinition(exportDefinition:
|
|
37
|
+
createExportDefinition(exportDefinition: IExportDefinitionMetadataObjectDefinition): Promise<IExportDefinitionMetadataObject>;
|
|
38
38
|
/**
|
|
39
39
|
* Update provided exportDefinition
|
|
40
40
|
*
|
|
@@ -42,7 +42,7 @@ export interface IWorkspaceExportDefinitionsService {
|
|
|
42
42
|
* @param exportDefinition - exportDefinition to update
|
|
43
43
|
* @returns promise of updated exportDefinition
|
|
44
44
|
*/
|
|
45
|
-
updateExportDefinition(ref: ObjRef, exportDefinition:
|
|
45
|
+
updateExportDefinition(ref: ObjRef, exportDefinition: IExportDefinitionMetadataObjectDefinition): Promise<IExportDefinitionMetadataObject>;
|
|
46
46
|
/**
|
|
47
47
|
* Delete exportDefinition with the given reference
|
|
48
48
|
*
|
|
@@ -177,5 +177,5 @@ export interface IExportDefinitionsQuery {
|
|
|
177
177
|
*
|
|
178
178
|
* @alpha
|
|
179
179
|
*/
|
|
180
|
-
export type IExportDefinitionsQueryResult = IPagedResource<
|
|
180
|
+
export type IExportDefinitionsQueryResult = IPagedResource<IExportDefinitionMetadataObject>;
|
|
181
181
|
//# sourceMappingURL=index.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/workspace/exportDefinitions/index.ts"],"names":[],"mappings":"AAEA,OAAO,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/workspace/exportDefinitions/index.ts"],"names":[],"mappings":"AAEA,OAAO,EACH,MAAM,EACN,+BAA+B,EAC/B,yCAAyC,EAC5C,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AAExD;;;;;GAKG;AACH,MAAM,WAAW,kCAAkC;IAC/C;;;;;;OAMG;IACH,mBAAmB,CACf,GAAG,EAAE,MAAM,EACX,OAAO,CAAC,EAAE,2BAA2B,GACtC,OAAO,CAAC,+BAA+B,CAAC,CAAC;IAE5C;;;;;OAKG;IACH,oBAAoB,CAAC,OAAO,CAAC,EAAE,8BAA8B,GAAG,OAAO,CAAC,6BAA6B,CAAC,CAAC;IAEvG;;;;OAIG;IACH,yBAAyB,IAAI,uBAAuB,CAAC;IAErD;;;;;OAKG;IACH,sBAAsB,CAClB,gBAAgB,EAAE,yCAAyC,GAC5D,OAAO,CAAC,+BAA+B,CAAC,CAAC;IAE5C;;;;;;OAMG;IACH,sBAAsB,CAClB,GAAG,EAAE,MAAM,EACX,gBAAgB,EAAE,yCAAyC,GAC5D,OAAO,CAAC,+BAA+B,CAAC,CAAC;IAE5C;;;;;OAKG;IACH,sBAAsB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACtD;AAED;;;;GAIG;AACH,MAAM,MAAM,wBAAwB,GAAG,IAAI,GAAG,OAAO,GAAG,SAAS,CAAC;AAElE;;;;GAIG;AACH,MAAM,WAAW,8BAA8B;IAC3C;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,OAAO,CAAC,EAAE,wBAAwB,CAAC;IAEnC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;;OAKG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;CAC1B;AAED;;;;GAIG;AACH,MAAM,WAAW,2BAA2B;IACxC;;;;;;;OAOG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;CAC1B;AAED;;;;GAIG;AACH,MAAM,MAAM,kCAAkC,GAAG,KAAK,GAAG,MAAM,CAAC;AAEhE;;;;GAIG;AACH,MAAM,MAAM,iCAAiC,GAAG,IAAI,GAAG,OAAO,CAAC;AAE/D;;;;GAIG;AACH,MAAM,MAAM,yBAAyB,GAC/B,iCAAiC,GACjC,GAAG,iCAAiC,IAAI,kCAAkC,EAAE,CAAC;AAEnF;;;;GAIG;AACH,MAAM,WAAW,uBAAuB;IACpC;;;;;;OAMG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,uBAAuB,CAAC;IAEhD;;;;;;;OAOG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,uBAAuB,CAAC;IAEhD;;;;;OAKG;IACH,UAAU,CAAC,MAAM,EAAE;QAAE,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,uBAAuB,CAAC;IAEhE;;;;;OAKG;IACH,WAAW,CAAC,IAAI,EAAE,yBAAyB,EAAE,GAAG,uBAAuB,CAAC;IAExE;;;;OAIG;IACH,KAAK,IAAI,OAAO,CAAC,6BAA6B,CAAC,CAAC;CACnD;AAED;;;;GAIG;AACH,MAAM,MAAM,6BAA6B,GAAG,cAAc,CAAC,+BAA+B,CAAC,CAAC"}
|
package/esm/workspace/index.d.ts
CHANGED
|
@@ -18,6 +18,7 @@ import { IAttributeHierarchiesService } from "./attributeHierarchies/index.js";
|
|
|
18
18
|
import { IWorkspaceExportDefinitionsService } from "./exportDefinitions/index.js";
|
|
19
19
|
import { IDataFiltersService } from "./dataFilter/index.js";
|
|
20
20
|
import { IWorkspaceLogicalModelService } from "./ldm/model.js";
|
|
21
|
+
import { IWorkspaceAutomationService } from "./automations/index.js";
|
|
21
22
|
/**
|
|
22
23
|
* Represents an analytical workspace hosted on a backend.
|
|
23
24
|
*
|
|
@@ -47,6 +48,12 @@ export interface IAnalyticalWorkspace {
|
|
|
47
48
|
* Returns parent analytical workspace when this workspace has a parent, undefined otherwise.
|
|
48
49
|
*/
|
|
49
50
|
getParentWorkspace(): Promise<IAnalyticalWorkspace | undefined>;
|
|
51
|
+
/**
|
|
52
|
+
* Returns service that can be used to query and update workspace automations.
|
|
53
|
+
*
|
|
54
|
+
* @alpha
|
|
55
|
+
*/
|
|
56
|
+
automations(): IWorkspaceAutomationService;
|
|
50
57
|
/**
|
|
51
58
|
* Returns factory that can be used to query workspace catalog items - attributes, measures, facts and date data sets.
|
|
52
59
|
*/
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/workspace/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AACzD,OAAO,EAAE,yBAAyB,EAAE,MAAM,qBAAqB,CAAC;AAChE,OAAO,EAAE,wBAAwB,EAAE,MAAM,oBAAoB,CAAC;AAC9D,OAAO,EAAE,yBAAyB,EAAE,MAAM,qBAAqB,CAAC;AAChE,OAAO,EAAE,wBAAwB,EAAE,MAAM,kBAAkB,CAAC;AAC5D,OAAO,EAAE,yBAAyB,EAAE,MAAM,mBAAmB,CAAC;AAC9D,OAAO,EAAE,4BAA4B,EAAE,MAAM,wBAAwB,CAAC;AACtE,OAAO,EAAE,2BAA2B,EAAE,MAAM,uBAAuB,CAAC;AACpE,OAAO,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAC;AACxD,OAAO,EAAE,uBAAuB,EAAE,MAAM,8BAA8B,CAAC;AACvE,OAAO,EAAE,2BAA2B,EAAE,MAAM,uBAAuB,CAAC;AACpE,OAAO,EAAE,yBAAyB,EAAE,MAAM,qBAAqB,CAAC;AAChE,OAAO,EAAE,sBAAsB,EAAE,MAAM,kBAAkB,CAAC;AAC1D,OAAO,EAAE,8BAA8B,EAAE,MAAM,0BAA0B,CAAC;AAC1E,OAAO,EAAE,yBAAyB,EAAE,MAAM,uBAAuB,CAAC;AAClE,OAAO,EAAE,4BAA4B,EAAE,MAAM,iCAAiC,CAAC;AAC/E,OAAO,EAAE,kCAAkC,EAAE,MAAM,8BAA8B,CAAC;AAClF,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,EAAE,6BAA6B,EAAE,MAAM,gBAAgB,CAAC;
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/workspace/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AACzD,OAAO,EAAE,yBAAyB,EAAE,MAAM,qBAAqB,CAAC;AAChE,OAAO,EAAE,wBAAwB,EAAE,MAAM,oBAAoB,CAAC;AAC9D,OAAO,EAAE,yBAAyB,EAAE,MAAM,qBAAqB,CAAC;AAChE,OAAO,EAAE,wBAAwB,EAAE,MAAM,kBAAkB,CAAC;AAC5D,OAAO,EAAE,yBAAyB,EAAE,MAAM,mBAAmB,CAAC;AAC9D,OAAO,EAAE,4BAA4B,EAAE,MAAM,wBAAwB,CAAC;AACtE,OAAO,EAAE,2BAA2B,EAAE,MAAM,uBAAuB,CAAC;AACpE,OAAO,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAC;AACxD,OAAO,EAAE,uBAAuB,EAAE,MAAM,8BAA8B,CAAC;AACvE,OAAO,EAAE,2BAA2B,EAAE,MAAM,uBAAuB,CAAC;AACpE,OAAO,EAAE,yBAAyB,EAAE,MAAM,qBAAqB,CAAC;AAChE,OAAO,EAAE,sBAAsB,EAAE,MAAM,kBAAkB,CAAC;AAC1D,OAAO,EAAE,8BAA8B,EAAE,MAAM,0BAA0B,CAAC;AAC1E,OAAO,EAAE,yBAAyB,EAAE,MAAM,uBAAuB,CAAC;AAClE,OAAO,EAAE,4BAA4B,EAAE,MAAM,iCAAiC,CAAC;AAC/E,OAAO,EAAE,kCAAkC,EAAE,MAAM,8BAA8B,CAAC;AAClF,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,EAAE,6BAA6B,EAAE,MAAM,gBAAgB,CAAC;AAC/D,OAAO,EAAE,2BAA2B,EAAE,MAAM,wBAAwB,CAAC;AAErE;;;;;;;;GAQG;AACH,MAAM,WAAW,oBAAoB;IACjC,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAE3B;;;;;OAKG;IACH,aAAa,CAAC,qBAAqB,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAAC;IAE9E;;;;;OAKG;IACH,gBAAgB,CAAC,UAAU,EAAE,0BAA0B,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAExE;;OAEG;IACH,kBAAkB,IAAI,OAAO,CAAC,oBAAoB,GAAG,SAAS,CAAC,CAAC;IAEhE;;;;OAIG;IACH,WAAW,IAAI,2BAA2B,CAAC;IAE3C;;OAEG;IACH,OAAO,IAAI,wBAAwB,CAAC;IAEpC;;OAEG;IACH,QAAQ,IAAI,yBAAyB,CAAC;IAEtC;;OAEG;IACH,UAAU,IAAI,2BAA2B,CAAC;IAE1C;;OAEG;IACH,iBAAiB,IAAI,uBAAuB,CAAC;IAE7C;;OAEG;IACH,UAAU,IAAI,2BAA2B,CAAC;IAE1C;;OAEG;IACH,QAAQ,IAAI,yBAAyB,CAAC;IAEtC;;OAEG;IACH,KAAK,IAAI,sBAAsB,CAAC;IAEhC;;OAEG;IACH,QAAQ,IAAI,yBAAyB,CAAC;IAEtC;;;OAGG;IACH,SAAS,IAAI,iBAAiB,CAAC;IAE/B;;OAEG;IACH,KAAK,IAAI,oBAAoB,CAAC;IAE9B;;OAEG;IACH,UAAU,IAAI,yBAAyB,CAAC;IAExC;;OAEG;IACH,WAAW,IAAI,4BAA4B,CAAC;IAE5C;;OAEG;IACH,QAAQ,IAAI,yBAAyB,CAAC;IAEtC;;;OAGG;IACH,OAAO,IAAI,wBAAwB,CAAC;IAEpC;;OAEG;IACH,aAAa,IAAI,8BAA8B,CAAC;IAEhD;;;OAGG;IACH,oBAAoB,IAAI,4BAA4B,CAAC;IAErD;;;OAGG;IACH,iBAAiB,IAAI,kCAAkC,CAAC;IAExD;;;OAGG;IACH,WAAW,IAAI,mBAAmB,CAAC;IAEnC;;;OAGG;IACH,YAAY,IAAI,6BAA6B,CAAC;CACjD;AAED;;;;GAIG;AACH,MAAM,WAAW,oBAAoB;IACjC,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;IAC1B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;CACjC;AAED;;;;;;GAMG;AACH,MAAM,WAAW,0BAA0B;IACvC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC/B;AAED;;;;GAIG;AACH,MAAM,WAAW,uBAAuB;IACpC;;;;;OAKG;IACH,OAAO,CAAC,MAAM,EAAE,MAAM,GAAG,gBAAgB,CAAC;IAE1C;;;;OAIG;IACH,cAAc,IAAI,gBAAgB,CAAC;CACtC;AAED;;;;GAIG;AACH,MAAM,WAAW,sBAAsB;IACnC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;CAChC;AAED;;;;GAIG;AACH,MAAM,WAAW,uBAAuB;IACpC;;OAEG;IACH,2BAA2B,CAAC,EAAE,OAAO,CAAC;CACzC;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAC7B;;;;;OAKG;IACH,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,gBAAgB,CAAC;IAE3C;;;OAGG;IACH,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,gBAAgB,CAAC;IAE7C;;;OAGG;IACH,UAAU,CAAC,WAAW,EAAE,MAAM,GAAG,SAAS,GAAG,gBAAgB,CAAC;IAE9D;;;;OAIG;IACH,UAAU,CAAC,MAAM,EAAE,sBAAsB,GAAG,gBAAgB,CAAC;IAE7D;;;;OAIG;IACH,WAAW,CAAC,OAAO,EAAE,uBAAuB,GAAG,gBAAgB,CAAC;IAEhE;;;OAGG;IACH,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,gBAAgB,CAAC;IAE7C;;OAEG;IACH,KAAK,IAAI,OAAO,CAAC,sBAAsB,CAAC,CAAC;CAC5C;AAED;;;;GAIG;AACH,MAAM,MAAM,sBAAsB,GAAG,cAAc,CAAC,oBAAoB,CAAC,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@gooddata/sdk-backend-spi",
|
|
3
|
-
"version": "10.5.0
|
|
3
|
+
"version": "10.5.0",
|
|
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.5.0
|
|
27
|
+
"@gooddata/sdk-model": "10.5.0"
|
|
28
28
|
},
|
|
29
29
|
"devDependencies": {
|
|
30
30
|
"@gooddata/eslint-config": "^4.1.0",
|