@gooddata/sdk-backend-spi 10.25.0-alpha.2 → 10.25.0-alpha.21

package/esm/backend/index.d.ts

@@ -217,6 +217,22 @@ export interface IAuthenticationProvider {
      * @param returnTo - url to redirect after successful logout
      */
     deauthenticate(context: IAuthenticationContext, returnTo?: string): Promise<void>;
+    /**
+     * Instructs the consumer which uses this provider to not cache authentication in any ways.
+     * Note: It does not affect calls deduplication like debouncing or throttling.
+     *
+     * If true, the consumer will always call authenticate if there is a need to authenticate user (like if some request respons with 401).
+     * If false, the consumer is allowed to cache the authenticated principal and reuse it for subsequent requests. This is the current behavior.
+     *
+     * It is here because some implementations of authentication works with time restricted sessions.
+     * It means the session can expire during user activity and the consumer should call authenticate again and not just reuse the cached principal.
+     *
+     * FIXME: I believe this should be true by default and if authentication provider wants to do some caching, it should implement it on its own.
+     * In this case, this property should be removed from the interface.
+     * But for now I dont have enough time to refactor this, so Im creating this backwards compatible solution.
+     * See JIRA ticket F1-1256 for more details.
+     */
+    disablePrincipalCache: boolean;
 }
 /**
  * Describes user, which is currently authenticated to the backend.

package/esm/backend/index.d.ts.map

@@ -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;;;;;;;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"}
+{"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;IAElF;;;;;;;;;;;;;;OAcG;IACH,qBAAqB,EAAE,OAAO,CAAC;CAClC;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

@@ -1 +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"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/backend/index.ts"],"names":[],"mappings":"AAAA,qCAAqC;AAyUrC,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/sdk-backend-spi.d.ts

@@ -740,6 +740,22 @@ export declare interface IAuthenticationProvider {
      * @param returnTo - url to redirect after successful logout
      */
     deauthenticate(context: IAuthenticationContext, returnTo?: string): Promise<void>;
+    /**
+     * Instructs the consumer which uses this provider to not cache authentication in any ways.
+     * Note: It does not affect calls deduplication like debouncing or throttling.
+     *
+     * If true, the consumer will always call authenticate if there is a need to authenticate user (like if some request respons with 401).
+     * If false, the consumer is allowed to cache the authenticated principal and reuse it for subsequent requests. This is the current behavior.
+     *
+     * It is here because some implementations of authentication works with time restricted sessions.
+     * It means the session can expire during user activity and the consumer should call authenticate again and not just reuse the cached principal.
+     *
+     * FIXME: I believe this should be true by default and if authentication provider wants to do some caching, it should implement it on its own.
+     * In this case, this property should be removed from the interface.
+     * But for now I dont have enough time to refactor this, so Im creating this backwards compatible solution.
+     * See JIRA ticket F1-1256 for more details.
+     */
+    disablePrincipalCache: boolean;
 }
 
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gooddata/sdk-backend-spi",
-  "version": "10.25.0-alpha.2",
+  "version": "10.25.0-alpha.21",
   "author": "GoodData",
   "description": "GoodData Backend SPI abstraction interfaces",
   "repository": {
@@ -24,7 +24,7 @@
     "lodash": "^4.17.21",
     "ts-invariant": "^0.7.5",
     "tslib": "^2.5.0",
-    "@gooddata/sdk-model": "10.25.0-alpha.2"
+    "@gooddata/sdk-model": "10.25.0-alpha.21"
   },
   "devDependencies": {
     "@gooddata/eslint-config": "^4.1.0",