@gooddata/sdk-backend-spi 10.22.0-alpha.17 → 10.22.0-alpha.19
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 +22 -0
- package/esm/backend/index.d.ts.map +1 -1
- package/esm/backend/index.js.map +1 -1
- package/esm/index.d.ts +1 -1
- package/esm/index.d.ts.map +1 -1
- package/esm/index.js.map +1 -1
- package/esm/sdk-backend-spi.d.ts +23 -0
- package/package.json +2 -2
package/esm/backend/index.d.ts
CHANGED
|
@@ -78,6 +78,15 @@ export interface IAnalyticalBackend {
|
|
|
78
78
|
* @returns a new instance of backend, set up with the provided telemetry
|
|
79
79
|
*/
|
|
80
80
|
withTelemetry(componentName: string, props: object): IAnalyticalBackend;
|
|
81
|
+
/**
|
|
82
|
+
* Sets request correlation metadata that will be included in HTTP requests to the backend.
|
|
83
|
+
* If the {@link IAnalyticalBackend} instance already has correlation metadata set, the new metadata will be merged with the existing one.
|
|
84
|
+
* This method provides more flexibility than withTelemetry by allowing arbitrary key-value pairs to be sent.
|
|
85
|
+
*
|
|
86
|
+
* @param correlationMetadata - key-value pairs to include as correlation metadata
|
|
87
|
+
* @returns a new instance of backend configured with the merged correlation metadata
|
|
88
|
+
*/
|
|
89
|
+
withCorrelation(correlationMetadata: IRequestCorrelationMetadata): IAnalyticalBackend;
|
|
81
90
|
/**
|
|
82
91
|
* Sets authentication provider to be used when backend discovers current session is
|
|
83
92
|
* not authenticated.
|
|
@@ -253,6 +262,19 @@ export interface IAuthenticationContext {
|
|
|
253
262
|
*/
|
|
254
263
|
client: any;
|
|
255
264
|
}
|
|
265
|
+
/**
|
|
266
|
+
* Correlation metadata that will be included in HTTP requests.
|
|
267
|
+
* The exact mechanism for including correlation metadata in requests
|
|
268
|
+
* is determined by the specific sdk-backend-spi implementation.
|
|
269
|
+
*
|
|
270
|
+
* @public
|
|
271
|
+
*/
|
|
272
|
+
export interface IRequestCorrelationMetadata {
|
|
273
|
+
/**
|
|
274
|
+
* Key-value pairs for correlation metadata
|
|
275
|
+
*/
|
|
276
|
+
readonly [key: string]: string;
|
|
277
|
+
}
|
|
256
278
|
/**
|
|
257
279
|
* Prepares execution of the provided definition against a backend.
|
|
258
280
|
*
|
|
@@ -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,yBAAyB,EAAE,MAAM,iCAAiC,CAAC;AAChG,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,EAChC,OAAO,CAAC,EAAE,yBAAyB,GACpC,kBAAkB,CAEpB"}
|
|
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,yBAAyB,EAAE,MAAM,iCAAiC,CAAC;AAChG,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;;;;;;;OAOG;IACH,eAAe,CAAC,mBAAmB,EAAE,2BAA2B,GAAG,kBAAkB,CAAC;IAEtF;;;;;;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;AAED;;;;;;GAMG;AACH,MAAM,WAAW,2BAA2B;IACxC;;OAEG;IACH,QAAQ,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC;CAClC;AAMD;;;;;;;;;;GAUG;AACH,wBAAgB,gBAAgB,CAC5B,OAAO,EAAE,kBAAkB,EAC3B,UAAU,EAAE,oBAAoB,EAChC,OAAO,CAAC,EAAE,yBAAyB,GACpC,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;AAwTrC,EAAE;AACF,qCAAqC;AACrC,EAAE;AAEF;;;;;;;;;;GAUG;AACH,MAAM,UAAU,gBAAgB,CAC5B,OAA2B,EAC3B,UAAgC,EAChC,OAAmC;IAEnC,OAAO,OAAO,CAAC,SAAS,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,SAAS,EAAE,CAAC,aAAa,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;AAClG,CAAC"}
|
package/esm/index.d.ts
CHANGED
|
@@ -7,7 +7,7 @@
|
|
|
7
7
|
*
|
|
8
8
|
* @packageDocumentation
|
|
9
9
|
*/
|
|
10
|
-
export type { IAnalyticalBackend, IAnalyticalBackendConfig, AnalyticalBackendFactory, IAuthenticationContext, IAuthenticatedPrincipal, IAuthenticationProvider, NotAuthenticatedHandler, } from "./backend/index.js";
|
|
10
|
+
export type { IAnalyticalBackend, IAnalyticalBackendConfig, AnalyticalBackendFactory, IAuthenticationContext, IAuthenticatedPrincipal, IAuthenticationProvider, NotAuthenticatedHandler, IRequestCorrelationMetadata, } from "./backend/index.js";
|
|
11
11
|
export { prepareExecution } from "./backend/index.js";
|
|
12
12
|
export type { IBackendCapabilities } from "./backend/capabilities.js";
|
|
13
13
|
export type { IUserSettings, IWorkspaceSettings, IUserWorkspaceSettings } from "./common/settings.js";
|
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,YAAY,EACR,kBAAkB,EAClB,wBAAwB,EACxB,wBAAwB,EACxB,sBAAsB,EACtB,uBAAuB,EACvB,uBAAuB,EACvB,uBAAuB,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA;;;;;;;;GAQG;AACH,YAAY,EACR,kBAAkB,EAClB,wBAAwB,EACxB,wBAAwB,EACxB,sBAAsB,EACtB,uBAAuB,EACvB,uBAAuB,EACvB,uBAAuB,EACvB,2BAA2B,GAC9B,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAEtD,YAAY,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAC;AAEtE,YAAY,EAAE,aAAa,EAAE,kBAAkB,EAAE,sBAAsB,EAAE,MAAM,sBAAsB,CAAC;AAEtG,YAAY,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AACpD,YAAY,EAAE,oBAAoB,EAAE,MAAM,0BAA0B,CAAC;AAErE,YAAY,EACR,yBAAyB,EACzB,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,YAAY,EAAE,yBAAyB,EAAE,MAAM,+BAA+B,CAAC;AAE/E,YAAY,EAAE,iBAAiB,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAE7E,YAAY,EACR,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,YAAY,EACR,wBAAwB,EACxB,uBAAuB,EACvB,8BAA8B,EAC9B,6BAA6B,EAC7B,2BAA2B,EAC3B,kCAAkC,EAClC,kCAAkC,EAClC,iCAAiC,EACjC,yBAAyB,GAC5B,MAAM,wCAAwC,CAAC;AAEhD,YAAY,EACR,qBAAqB,EACrB,oBAAoB,EACpB,cAAc,EACd,qBAAqB,EACrB,6BAA6B,EAC7B,kCAAkC,EAClC,oCAAoC,EACpC,sDAAsD,EACtD,yCAAyC,EACzC,oBAAoB,EACpB,4BAA4B,GAC/B,MAAM,0CAA0C,CAAC;AAClD,OAAO,EACH,qCAAqC,EACrC,uDAAuD,EACvD,wCAAwC,GAC3C,MAAM,0CAA0C,CAAC;AAElD,YAAY,EAAE,aAAa,EAAE,aAAa,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAC;AAEtG,YAAY,EACR,aAAa,EACb,oBAAoB,EACpB,qBAAqB,EACrB,WAAW,EACX,kBAAkB,EAClB,gBAAgB,EAChB,oBAAoB,GACvB,MAAM,4BAA4B,CAAC;AAEpC,YAAY,EAAE,wBAAwB,EAAE,MAAM,8BAA8B,CAAC;AAC7E,YAAY,EAAE,sBAAsB,EAAE,cAAc,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAC;AACpG,OAAO,EACH,sBAAsB,EACtB,WAAW,EACX,iBAAiB,EACjB,YAAY,EACZ,kBAAkB,EAClB,uBAAuB,EACvB,eAAe,EACf,YAAY,EACZ,cAAc,EACd,gBAAgB,EAChB,YAAY,EACZ,eAAe,EACf,UAAU,EACV,wBAAwB,EACxB,aAAa,EACb,mBAAmB,EACnB,oBAAoB,EACpB,yBAAyB,EACzB,iBAAiB,EACjB,cAAc,EACd,gBAAgB,EAChB,kBAAkB,EAClB,cAAc,EACd,iBAAiB,EACjB,2BAA2B,EAC3B,YAAY,GACf,MAAM,mBAAmB,CAAC;AAE3B,YAAY,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAEzD,YAAY,EACR,oBAAoB,EACpB,gBAAgB,EAChB,uBAAuB,EACvB,sBAAsB,EACtB,sBAAsB,EACtB,uBAAuB,EACvB,oBAAoB,EACpB,0BAA0B,GAC7B,MAAM,sBAAsB,CAAC;AAE9B,YAAY,EAAE,4BAA4B,EAAE,MAAM,2CAA2C,CAAC;AAE9F,YAAY,EAAE,4BAA4B,EAAE,MAAM,kCAAkC,CAAC;AAErF,YAAY,EAAE,2BAA2B,EAAE,wBAAwB,EAAE,MAAM,iCAAiC,CAAC;AAE7G,YAAY,EACR,yBAAyB,EACzB,mBAAmB,EACnB,kBAAkB,GACrB,MAAM,+BAA+B,CAAC;AAEvC,YAAY,EAAE,sBAAsB,EAAE,MAAM,4BAA4B,CAAC;AAEzE,YAAY,EACR,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,YAAY,EAAE,qBAAqB,EAAE,UAAU,EAAE,MAAM,iCAAiC,CAAC;AACzF,OAAO,EACH,sBAAsB,EACtB,aAAa,EACb,sBAAsB,EACtB,UAAU,GACb,MAAM,iCAAiC,CAAC;AACzC,YAAY,EACR,oBAAoB,EACpB,2BAA2B,EAC3B,0BAA0B,GAC7B,MAAM,4BAA4B,CAAC;AACpC,YAAY,EACR,uBAAuB,EACvB,6BAA6B,GAChC,MAAM,wCAAwC,CAAC;AAEhD,YAAY,EACR,wBAAwB,EACxB,sCAAsC,EACtC,iBAAiB,EACjB,+BAA+B,EAC/B,mCAAmC,EACnC,iDAAiD,EACjD,+BAA+B,EAC/B,wBAAwB,GAC3B,MAAM,4BAA4B,CAAC;AAEpC,YAAY,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAC;AAE7E,YAAY,EACR,uBAAuB,EACvB,sBAAsB,EACtB,gCAAgC,EAChC,oBAAoB,EACpB,uBAAuB,EACvB,uBAAuB,GAC1B,MAAM,iCAAiC,CAAC;AAEzC,YAAY,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAC7E,YAAY,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AAC7D,YAAY,EAAE,mBAAmB,EAAE,MAAM,wBAAwB,CAAC;AAClE,YAAY,EAAE,wBAAwB,EAAE,iBAAiB,EAAE,MAAM,0CAA0C,CAAC;AAC5G,YAAY,EAAE,2BAA2B,EAAE,MAAM,iCAAiC,CAAC;AACnF,YAAY,EAAE,4BAA4B,EAAE,MAAM,kCAAkC,CAAC;AAErF,YAAY,EACR,yBAAyB,EACzB,gCAAgC,EAChC,+BAA+B,GAClC,MAAM,iCAAiC,CAAC;AAEzC,YAAY,EAAE,8BAA8B,EAAE,MAAM,oCAAoC,CAAC;AAEzF,YAAY,EACR,wBAAwB,EACxB,uBAAuB,EACvB,6BAA6B,EAC7B,4BAA4B,EAC5B,kCAAkC,GACrC,MAAM,+BAA+B,CAAC;AACvC,YAAY,EACR,8BAA8B,EAC9B,sBAAsB,GACzB,MAAM,qCAAqC,CAAC;AAC7C,YAAY,EAAE,uCAAuC,EAAE,MAAM,8CAA8C,CAAC;AAC5G,YAAY,EACR,0BAA0B,EAC1B,gCAAgC,GACnC,MAAM,8CAA8C,CAAC;AACtD,YAAY,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAC;AAE3E,YAAY,EAAE,6BAA6B,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AAE5F,YAAY,EACR,2BAA2B,EAC3B,qBAAqB,EACrB,sBAAsB,EACtB,cAAc,EACd,iBAAiB,EACjB,uBAAuB,GAC1B,MAAM,kCAAkC,CAAC;AAE1C,YAAY,EAAE,gCAAgC,EAAE,MAAM,sCAAsC,CAAC;AAE7F,YAAY,EAAE,gCAAgC,EAAE,MAAM,uCAAuC,CAAC;AAC9F,YAAY,EAAE,mBAAmB,EAAE,yBAAyB,EAAE,MAAM,uCAAuC,CAAC"}
|
package/esm/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAoBA,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAuEtD,OAAO,EACH,qCAAqC,EACrC,uDAAuD,EACvD,wCAAwC,GAC3C,MAAM,0CAA0C,CAAC;AAgBlD,OAAO,EACH,sBAAsB,EACtB,WAAW,EACX,iBAAiB,EACjB,YAAY,EACZ,kBAAkB,EAClB,uBAAuB,EACvB,eAAe,EACf,YAAY,EACZ,cAAc,EACd,gBAAgB,EAChB,YAAY,EACZ,eAAe,EACf,UAAU,EACV,wBAAwB,EACxB,aAAa,EACb,mBAAmB,EACnB,oBAAoB,EACpB,yBAAyB,EACzB,iBAAiB,EACjB,cAAc,EACd,gBAAgB,EAChB,kBAAkB,EAClB,cAAc,EACd,iBAAiB,EACjB,2BAA2B,EAC3B,YAAY,GACf,MAAM,mBAAmB,CAAC;AA4C3B,OAAO,EACH,sBAAsB,EACtB,aAAa,EACb,sBAAsB,EACtB,UAAU,GACb,MAAM,iCAAiC,CAAC"}
|
package/esm/sdk-backend-spi.d.ts
CHANGED
|
@@ -333,6 +333,15 @@ export declare interface IAnalyticalBackend {
|
|
|
333
333
|
* @returns a new instance of backend, set up with the provided telemetry
|
|
334
334
|
*/
|
|
335
335
|
withTelemetry(componentName: string, props: object): IAnalyticalBackend;
|
|
336
|
+
/**
|
|
337
|
+
* Sets request correlation metadata that will be included in HTTP requests to the backend.
|
|
338
|
+
* If the {@link IAnalyticalBackend} instance already has correlation metadata set, the new metadata will be merged with the existing one.
|
|
339
|
+
* This method provides more flexibility than withTelemetry by allowing arbitrary key-value pairs to be sent.
|
|
340
|
+
*
|
|
341
|
+
* @param correlationMetadata - key-value pairs to include as correlation metadata
|
|
342
|
+
* @returns a new instance of backend configured with the merged correlation metadata
|
|
343
|
+
*/
|
|
344
|
+
withCorrelation(correlationMetadata: IRequestCorrelationMetadata): IAnalyticalBackend;
|
|
336
345
|
/**
|
|
337
346
|
* Sets authentication provider to be used when backend discovers current session is
|
|
338
347
|
* not authenticated.
|
|
@@ -3699,6 +3708,20 @@ export declare interface IPreparedExecutionOptions {
|
|
|
3699
3708
|
signal?: AbortSignal;
|
|
3700
3709
|
}
|
|
3701
3710
|
|
|
3711
|
+
/**
|
|
3712
|
+
* Correlation metadata that will be included in HTTP requests.
|
|
3713
|
+
* The exact mechanism for including correlation metadata in requests
|
|
3714
|
+
* is determined by the specific sdk-backend-spi implementation.
|
|
3715
|
+
*
|
|
3716
|
+
* @public
|
|
3717
|
+
*/
|
|
3718
|
+
export declare interface IRequestCorrelationMetadata {
|
|
3719
|
+
/**
|
|
3720
|
+
* Key-value pairs for correlation metadata
|
|
3721
|
+
*/
|
|
3722
|
+
readonly [key: string]: string;
|
|
3723
|
+
}
|
|
3724
|
+
|
|
3702
3725
|
/**
|
|
3703
3726
|
* Type guard checking whether input is an instance of {@link AbortError}
|
|
3704
3727
|
*
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@gooddata/sdk-backend-spi",
|
|
3
|
-
"version": "10.22.0-alpha.
|
|
3
|
+
"version": "10.22.0-alpha.19",
|
|
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.22.0-alpha.
|
|
27
|
+
"@gooddata/sdk-model": "10.22.0-alpha.19"
|
|
28
28
|
},
|
|
29
29
|
"devDependencies": {
|
|
30
30
|
"@gooddata/eslint-config": "^4.1.0",
|