@gooddata/sdk-backend-base 8.11.0-alpha.10 → 8.11.0-alpha.100

package/dist/sdk-backend-base.d.ts

@@ -16,6 +16,7 @@ import { DateAttributeGranularity } from '@gooddata/sdk-model';
 import { DimensionGenerator } from '@gooddata/sdk-model';
 import { ErrorConverter } from '@gooddata/sdk-backend-spi';
 import { ExplainConfig } from '@gooddata/sdk-backend-spi';
+import { ExplainType } from '@gooddata/sdk-backend-spi';
 import { FilterContextItem } from '@gooddata/sdk-model';
 import { IAnalyticalBackend } from '@gooddata/sdk-backend-spi';
 import { IAnalyticalBackendConfig } from '@gooddata/sdk-backend-spi';
@@ -49,6 +50,7 @@ import { IExecutionConfig } from '@gooddata/sdk-model';
 import { IExecutionDefinition } from '@gooddata/sdk-model';
 import { IExecutionFactory } from '@gooddata/sdk-backend-spi';
 import { IExecutionResult } from '@gooddata/sdk-backend-spi';
+import { IExplainProvider } from '@gooddata/sdk-backend-spi';
 import { IExportConfig } from '@gooddata/sdk-backend-spi';
 import { IExportResult } from '@gooddata/sdk-backend-spi';
 import { IFactMetadataObject } from '@gooddata/sdk-model';
@@ -322,7 +324,7 @@ export declare type BuilderModifications<TBuilder extends IBuilder<TItem>, TItem
  * Cache control can be used to interact with the caching layer - at the moment to reset the contents of the
  * different top-level caches.
  *
- * @beta
+ * @public
  */
 export declare type CacheControl = {
     /**
@@ -357,7 +359,7 @@ export declare type CacheControl = {
 /**
  * Specifies where should the caching decorator apply and to what size should caches grow.
  *
- * @beta
+ * @public
  */
 export declare type CachingConfiguration = {
     /**
@@ -373,7 +375,7 @@ export declare type CachingConfiguration = {
      *
      * When non-positive number is specified, then no caching will be done.
      */
-    maxExecutions: number | undefined;
+    maxExecutions?: number;
     /**
      * Maximum number of execution result's pages to cache PER result. The window offset and limit are used as cache key.
      *
@@ -386,7 +388,7 @@ export declare type CachingConfiguration = {
      *
      * Note: this option has no effect if execution caching is disabled.
      */
-    maxResultWindows: number | undefined;
+    maxResultWindows?: number;
     /**
      * Maximum number of workspaces for which to cache catalogs. The workspace identifier is used as cache key. For
      * each workspace, there will be a cache entry holding `maxCatalogOptions` entries.
@@ -399,7 +401,7 @@ export declare type CachingConfiguration = {
      *
      * When non-positive number is specified, then no caching of result windows will be done.
      */
-    maxCatalogs: number | undefined;
+    maxCatalogs?: number;
     /**
      * Catalog can be viewed in many different ways - determined by the options specified during load. This option
      * indicates how many unique options to cache results for.
@@ -413,7 +415,7 @@ export declare type CachingConfiguration = {
      *
      * Setting non-positive number here is invalid. If you want to turn off catalog caching, tweak the `maxCatalogs`.
      */
-    maxCatalogOptions: number | undefined;
+    maxCatalogOptions?: number;
     /**
      * Specify function to call once the caching is set up. If present, the function will be called
      * with an instance of {@link CacheControl} which you can use to interact with the caches.
@@ -433,7 +435,7 @@ export declare type CachingConfiguration = {
      *
      * When non-positive number is specified, then no caching will be done.
      */
-    maxSecuritySettingsOrgs: number | undefined;
+    maxSecuritySettingsOrgs?: number;
     /**
      * Maximum number of URLs per organization that will have its validation result cached. The URL
      * and validation context is used to form a cache key.
@@ -447,7 +449,7 @@ export declare type CachingConfiguration = {
      * Setting non-positive number here is invalid. If you want to turn off organization security settings caching,
      * tweak the `maxSecuritySettingsOrgs`.
      */
-    maxSecuritySettingsOrgUrls: number | undefined;
+    maxSecuritySettingsOrgUrls?: number;
     /**
      * Maximum age of cached organization's URL validation results. The value is in milliseconds.
      *
@@ -459,7 +461,7 @@ export declare type CachingConfiguration = {
      * Setting non-positive number here is invalid. If you want to turn off organization security settings
      * caching, tweak the `maxSecuritySettingsOrgs`.
      */
-    maxSecuritySettingsOrgUrlsAge: number | undefined;
+    maxSecuritySettingsOrgUrlsAge?: number;
     /**
      * Maximum number of workspaces for which to cache selected {@link @gooddata/sdk-backend-spi#IWorkspaceAttributesService} calls.
      * The workspace identifier is used as cache key.
@@ -473,7 +475,7 @@ export declare type CachingConfiguration = {
      *
      * When non-positive number is specified, then no caching will be done.
      */
-    maxAttributeWorkspaces: number | undefined;
+    maxAttributeWorkspaces?: number;
     /**
      * Maximum number of attribute display forms to cache per workspace.
      *
@@ -486,7 +488,35 @@ export declare type CachingConfiguration = {
      * Setting non-positive number here is invalid. If you want to turn off attribute display form
      * caching, tweak the `maxAttributeWorkspaces` value.
      */
-    maxAttributeDisplayFormsPerWorkspace: number | undefined;
+    maxAttributeDisplayFormsPerWorkspace?: number;
+    /**
+     * Maximum number of attributes to cache per workspace.
+     *
+     * When limit is reached, cache entries will be evicted using LRU policy.
+     *
+     * When no maximum number is specified, the cache will be unbounded and no evictions will happen. Unbounded
+     * attribute cache may be OK in applications where number of attributes is small and/or they are requested
+     * infrequently - the cache will be limited naturally and will not grow uncontrollably.
+     *
+     * Setting non-positive number here is invalid. If you want to turn off attribute caching,
+     * tweak the `maxAttributeWorkspaces` value.
+     */
+    maxAttributesPerWorkspace?: number;
+    /**
+     * Maximum number of attributes element results to cache per workspace.
+     *
+     * Note that not all the queries are cached (e.g. queries with `filter` value).
+     *
+     * When limit is reached, cache entries will be evicted using LRU policy.
+     *
+     * When no maximum number is specified, the cache will be unbounded and no evictions will happen. Unbounded
+     * attribute elements cache may be OK in applications where number of attributes and/or their elements is small
+     * and/or they are requested infrequently - the cache will be limited naturally and will not grow uncontrollably.
+     *
+     * Setting non-positive number here is invalid. If you want to turn off attribute caching,
+     * tweak the `maxAttributeWorkspaces` value.
+     */
+    maxAttributeElementResultsPerWorkspace?: number;
     /**
      * Maximum number of settings for a workspace and for a user to cache per workspace.
      *
@@ -498,7 +528,7 @@ export declare type CachingConfiguration = {
      *
      * When non-positive number is specified, then no caching of result windows will be done.
      */
-    maxWorkspaceSettings: number | undefined;
+    maxWorkspaceSettings?: number;
 };
 
 /**
@@ -828,7 +858,7 @@ export declare abstract class DecoratedPreparedExecution implements IPreparedExe
     protected constructor(decorated: IPreparedExecution);
     equals(other: IPreparedExecution): boolean;
     execute(): Promise<IExecutionResult>;
-    explain(config: ExplainConfig): Promise<void>;
+    explain<T extends ExplainType | undefined>(config: ExplainConfig<T>): IExplainProvider<typeof config["explainType"]>;
     fingerprint(): string;
     withDimensions(...dim: Array<IDimension | DimensionGenerator>): IPreparedExecution;
     withSorting(...items: ISortItem[]): IPreparedExecution;
@@ -884,6 +914,7 @@ export declare abstract class DecoratedWorkspaceCatalogFactory implements IWorks
     excludeTags(tags: ObjRef[]): IWorkspaceCatalogFactory;
     includeTags(tags: ObjRef[]): IWorkspaceCatalogFactory;
     withOptions(options: IWorkspaceCatalogFactoryOptions): IWorkspaceCatalogFactory;
+    withGroups(loadGroups: boolean): IWorkspaceCatalogFactory;
     load(): Promise<IWorkspaceCatalog>;
     /**
      * Methods that create new instances of catalog loader (e.g. all except load) will
@@ -938,6 +969,7 @@ export declare abstract class DecoratedWorkspaceSettingsService implements IWork
     protected constructor(decorated: IWorkspaceSettingsService);
     getSettings(): Promise<IWorkspaceSettings>;
     getSettingsForCurrentUser(): Promise<IUserWorkspaceSettings>;
+    setLocale(locale: string): Promise<void>;
 }
 
 /**
@@ -956,11 +988,6 @@ export declare type DecoratorFactories = {
     dashboards?: DashboardsDecoratorFactory;
 };
 
-/**
- * @beta
- */
-export declare const DefaultCachingConfiguration: CachingConfiguration;
-
 /**
  * @internal
  */
@@ -1634,6 +1661,16 @@ export declare class Normalizer {
  */
 export declare type PreparedExecutionWrapper = (execution: IPreparedExecution) => IPreparedExecution;
 
+/**
+ * These are the recommended settings for the backend caching.
+ *
+ * @remarks
+ * For more information on what the options mean see {@link CachingConfiguration}.
+ *
+ * @public
+ */
+export declare const RecommendedCachingConfiguration: CachingConfiguration;
+
 /**
  * Calls an update callback when it's a function, otherwise returns the value itself.
  * This is just an utility function to DRY the builder implementation a bit.
@@ -1776,10 +1813,10 @@ export declare class WidgetBaseBuilder<T extends IWidget> extends Builder<T> imp
  *
  * @remarks see {@link CachingConfiguration} properties for more information.
  * @param realBackend - real backend to decorate with caching
- * @param config - caching configuration
- * @beta
+ * @param config - caching configuration. {@link RecommendedCachingConfiguration} can be used
+ * @public
  */
-export declare function withCaching(realBackend: IAnalyticalBackend, config?: CachingConfiguration): IAnalyticalBackend;
+export declare function withCaching(realBackend: IAnalyticalBackend, config: CachingConfiguration): IAnalyticalBackend;
 
 /**
  * Adjusts workspace configs and current user configs from the real backend.

package/esm/cachingBackend/index.d.ts

@@ -3,7 +3,7 @@ import { IAnalyticalBackend } from "@gooddata/sdk-backend-spi";
  * Cache control can be used to interact with the caching layer - at the moment to reset the contents of the
  * different top-level caches.
  *
- * @beta
+ * @public
  */
 export declare type CacheControl = {
     /**
@@ -37,7 +37,7 @@ export declare type CacheControl = {
 /**
  * Specifies where should the caching decorator apply and to what size should caches grow.
  *
- * @beta
+ * @public
  */
 export declare type CachingConfiguration = {
     /**
@@ -53,7 +53,7 @@ export declare type CachingConfiguration = {
      *
      * When non-positive number is specified, then no caching will be done.
      */
-    maxExecutions: number | undefined;
+    maxExecutions?: number;
     /**
      * Maximum number of execution result's pages to cache PER result. The window offset and limit are used as cache key.
      *
@@ -66,7 +66,7 @@ export declare type CachingConfiguration = {
      *
      * Note: this option has no effect if execution caching is disabled.
      */
-    maxResultWindows: number | undefined;
+    maxResultWindows?: number;
     /**
      * Maximum number of workspaces for which to cache catalogs. The workspace identifier is used as cache key. For
      * each workspace, there will be a cache entry holding `maxCatalogOptions` entries.
@@ -79,7 +79,7 @@ export declare type CachingConfiguration = {
      *
      * When non-positive number is specified, then no caching of result windows will be done.
      */
-    maxCatalogs: number | undefined;
+    maxCatalogs?: number;
     /**
      * Catalog can be viewed in many different ways - determined by the options specified during load. This option
      * indicates how many unique options to cache results for.
@@ -93,7 +93,7 @@ export declare type CachingConfiguration = {
      *
      * Setting non-positive number here is invalid. If you want to turn off catalog caching, tweak the `maxCatalogs`.
      */
-    maxCatalogOptions: number | undefined;
+    maxCatalogOptions?: number;
     /**
      * Specify function to call once the caching is set up. If present, the function will be called
      * with an instance of {@link CacheControl} which you can use to interact with the caches.
@@ -113,7 +113,7 @@ export declare type CachingConfiguration = {
      *
      * When non-positive number is specified, then no caching will be done.
      */
-    maxSecuritySettingsOrgs: number | undefined;
+    maxSecuritySettingsOrgs?: number;
     /**
      * Maximum number of URLs per organization that will have its validation result cached. The URL
      * and validation context is used to form a cache key.
@@ -127,7 +127,7 @@ export declare type CachingConfiguration = {
      * Setting non-positive number here is invalid. If you want to turn off organization security settings caching,
      * tweak the `maxSecuritySettingsOrgs`.
      */
-    maxSecuritySettingsOrgUrls: number | undefined;
+    maxSecuritySettingsOrgUrls?: number;
     /**
      * Maximum age of cached organization's URL validation results. The value is in milliseconds.
      *
@@ -139,7 +139,7 @@ export declare type CachingConfiguration = {
      * Setting non-positive number here is invalid. If you want to turn off organization security settings
      * caching, tweak the `maxSecuritySettingsOrgs`.
      */
-    maxSecuritySettingsOrgUrlsAge: number | undefined;
+    maxSecuritySettingsOrgUrlsAge?: number;
     /**
      * Maximum number of workspaces for which to cache selected {@link @gooddata/sdk-backend-spi#IWorkspaceAttributesService} calls.
      * The workspace identifier is used as cache key.
@@ -153,7 +153,7 @@ export declare type CachingConfiguration = {
      *
      * When non-positive number is specified, then no caching will be done.
      */
-    maxAttributeWorkspaces: number | undefined;
+    maxAttributeWorkspaces?: number;
     /**
      * Maximum number of attribute display forms to cache per workspace.
      *
@@ -166,7 +166,35 @@ export declare type CachingConfiguration = {
      * Setting non-positive number here is invalid. If you want to turn off attribute display form
      * caching, tweak the `maxAttributeWorkspaces` value.
      */
-    maxAttributeDisplayFormsPerWorkspace: number | undefined;
+    maxAttributeDisplayFormsPerWorkspace?: number;
+    /**
+     * Maximum number of attributes to cache per workspace.
+     *
+     * When limit is reached, cache entries will be evicted using LRU policy.
+     *
+     * When no maximum number is specified, the cache will be unbounded and no evictions will happen. Unbounded
+     * attribute cache may be OK in applications where number of attributes is small and/or they are requested
+     * infrequently - the cache will be limited naturally and will not grow uncontrollably.
+     *
+     * Setting non-positive number here is invalid. If you want to turn off attribute caching,
+     * tweak the `maxAttributeWorkspaces` value.
+     */
+    maxAttributesPerWorkspace?: number;
+    /**
+     * Maximum number of attributes element results to cache per workspace.
+     *
+     * Note that not all the queries are cached (e.g. queries with `filter` value).
+     *
+     * When limit is reached, cache entries will be evicted using LRU policy.
+     *
+     * When no maximum number is specified, the cache will be unbounded and no evictions will happen. Unbounded
+     * attribute elements cache may be OK in applications where number of attributes and/or their elements is small
+     * and/or they are requested infrequently - the cache will be limited naturally and will not grow uncontrollably.
+     *
+     * Setting non-positive number here is invalid. If you want to turn off attribute caching,
+     * tweak the `maxAttributeWorkspaces` value.
+     */
+    maxAttributeElementResultsPerWorkspace?: number;
     /**
      * Maximum number of settings for a workspace and for a user to cache per workspace.
      *
@@ -178,20 +206,25 @@ export declare type CachingConfiguration = {
      *
      * When non-positive number is specified, then no caching of result windows will be done.
      */
-    maxWorkspaceSettings: number | undefined;
+    maxWorkspaceSettings?: number;
 };
 /**
- * @beta
+ * These are the recommended settings for the backend caching.
+ *
+ * @remarks
+ * For more information on what the options mean see {@link CachingConfiguration}.
+ *
+ * @public
  */
-export declare const DefaultCachingConfiguration: CachingConfiguration;
+export declare const RecommendedCachingConfiguration: CachingConfiguration;
 /**
  * Adds caching layer on top of an existing analytical backend instance. It is currently possible to cache
  * results of executions and the workspace LDM catalog.
  *
  * @remarks see {@link CachingConfiguration} properties for more information.
  * @param realBackend - real backend to decorate with caching
- * @param config - caching configuration
- * @beta
+ * @param config - caching configuration. {@link RecommendedCachingConfiguration} can be used
+ * @public
  */
-export declare function withCaching(realBackend: IAnalyticalBackend, config?: CachingConfiguration): IAnalyticalBackend;
+export declare function withCaching(realBackend: IAnalyticalBackend, config: CachingConfiguration): IAnalyticalBackend;
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/cachingBackend/index.ts"],"names":[],"mappings":"AACA,OAAO,EACH,kBAAkB,EAerB,MAAM,2BAA2B,CAAC;AAglBnC;;;;;GAKG;AACH,oBAAY,YAAY,GAAG;IACvB;;;;;OAKG;IACH,eAAe,EAAE,MAAM,IAAI,CAAC;IAE5B;;OAEG;IACH,aAAa,EAAE,MAAM,IAAI,CAAC;IAE1B;;OAEG;IACH,qBAAqB,EAAE,MAAM,IAAI,CAAC;IAElC;;OAEG;IACH,eAAe,EAAE,MAAM,IAAI,CAAC;IAE5B;;OAEG;IACH,sBAAsB,EAAE,MAAM,IAAI,CAAC;IAEnC;;OAEG;IACH,QAAQ,EAAE,MAAM,IAAI,CAAC;CACxB,CAAC;AAEF;;;;GAIG;AACH,oBAAY,oBAAoB,GAAG;IAC/B;;;;;;;;;;;;OAYG;IACH,aAAa,EAAE,MAAM,GAAG,SAAS,CAAC;IAElC;;;;;;;;;;;OAWG;IACH,gBAAgB,EAAE,MAAM,GAAG,SAAS,CAAC;IAErC;;;;;;;;;;;OAWG;IACH,WAAW,EAAE,MAAM,GAAG,SAAS,CAAC;IAEhC;;;;;;;;;;;;OAYG;IACH,iBAAiB,EAAE,MAAM,GAAG,SAAS,CAAC;IAEtC;;;;;OAKG;IACH,YAAY,CAAC,EAAE,CAAC,YAAY,EAAE,YAAY,KAAK,IAAI,CAAC;IAEpD;;;;;;;;;;;OAWG;IACH,uBAAuB,EAAE,MAAM,GAAG,SAAS,CAAC;IAE5C;;;;;;;;;;;;OAYG;IACH,0BAA0B,EAAE,MAAM,GAAG,SAAS,CAAC;IAE/C;;;;;;;;;;OAUG;IACH,6BAA6B,EAAE,MAAM,GAAG,SAAS,CAAC;IAElD;;;;;;;;;;;;OAYG;IACH,sBAAsB,EAAE,MAAM,GAAG,SAAS,CAAC;IAE3C;;;;;;;;;;;OAWG;IACH,oCAAoC,EAAE,MAAM,GAAG,SAAS,CAAC;IAEzD;;;;;;;;;;OAUG;IACH,oBAAoB,EAAE,MAAM,GAAG,SAAS,CAAC;CAC5C,CAAC;AASF;;GAEG;AACH,eAAO,MAAM,2BAA2B,EAAE,oBAWzC,CAAC;AAEF;;;;;;;;GAQG;AACH,wBAAgB,WAAW,CACvB,WAAW,EAAE,kBAAkB,EAC/B,MAAM,GAAE,oBAAkD,GAC3D,kBAAkB,CA8CpB"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/cachingBackend/index.ts"],"names":[],"mappings":"AACA,OAAO,EACH,kBAAkB,EAoBrB,MAAM,2BAA2B,CAAC;AA6tBnC;;;;;GAKG;AACH,oBAAY,YAAY,GAAG;IACvB;;;;;OAKG;IACH,eAAe,EAAE,MAAM,IAAI,CAAC;IAE5B;;OAEG;IACH,aAAa,EAAE,MAAM,IAAI,CAAC;IAE1B;;OAEG;IACH,qBAAqB,EAAE,MAAM,IAAI,CAAC;IAElC;;OAEG;IACH,eAAe,EAAE,MAAM,IAAI,CAAC;IAE5B;;OAEG;IACH,sBAAsB,EAAE,MAAM,IAAI,CAAC;IAEnC;;OAEG;IACH,QAAQ,EAAE,MAAM,IAAI,CAAC;CACxB,CAAC;AAEF;;;;GAIG;AACH,oBAAY,oBAAoB,GAAG;IAC/B;;;;;;;;;;;;OAYG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;;;;;;;;;OAWG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;;;;;;;;;;OAWG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;;;;;;;;;OAYG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;;;;OAKG;IACH,YAAY,CAAC,EAAE,CAAC,YAAY,EAAE,YAAY,KAAK,IAAI,CAAC;IAEpD;;;;;;;;;;;OAWG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC;IAEjC;;;;;;;;;;;;OAYG;IACH,0BAA0B,CAAC,EAAE,MAAM,CAAC;IAEpC;;;;;;;;;;OAUG;IACH,6BAA6B,CAAC,EAAE,MAAM,CAAC;IAEvC;;;;;;;;;;;;OAYG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAEhC;;;;;;;;;;;OAWG;IACH,oCAAoC,CAAC,EAAE,MAAM,CAAC;IAE9C;;;;;;;;;;;OAWG;IACH,yBAAyB,CAAC,EAAE,MAAM,CAAC;IAEnC;;;;;;;;;;;;;OAaG;IACH,sCAAsC,CAAC,EAAE,MAAM,CAAC;IAEhD;;;;;;;;;;OAUG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;CACjC,CAAC;AASF;;;;;;;GAOG;AACH,eAAO,MAAM,+BAA+B,EAAE,oBAa7C,CAAC;AAEF;;;;;;;;GAQG;AACH,wBAAgB,WAAW,CACvB,WAAW,EAAE,kBAAkB,EAC/B,MAAM,EAAE,oBAAoB,GAC7B,kBAAkB,CA8CpB"}

package/esm/cachingBackend/index.js

@@ -4,6 +4,7 @@ import { LRUCache } from "@gooddata/util";
 import { DecoratedSecuritySettingsService } from "../decoratedBackend/securitySettings";
 import { DecoratedDataView, DecoratedExecutionFactory, DecoratedExecutionResult, DecoratedPreparedExecution, } from "../decoratedBackend/execution";
 import { DecoratedWorkspaceCatalogFactory } from "../decoratedBackend/catalog";
+import { DecoratedElementsQuery, DecoratedElementsQueryFactory } from "../decoratedBackend/elements";
 import stringify from "json-stable-stringify";
 import compact from "lodash/compact";
 import first from "lodash/first";
@@ -11,7 +12,8 @@ import flow from "lodash/flow";
 import identity from "lodash/identity";
 import invariant from "ts-invariant";
 import partition from "lodash/partition";
-import { areObjRefsEqual, idRef, isIdentifierRef, isUriRef, uriRef, } from "@gooddata/sdk-model";
+import SparkMD5 from "spark-md5";
+import { areObjRefsEqual, idRef, isIdentifierRef, isUriRef, uriRef, objRefToString, } from "@gooddata/sdk-model";
 import { DecoratedWorkspaceAttributesService } from "../decoratedBackend/attributes";
 import { DecoratedWorkspaceSettingsService } from "../decoratedBackend/workspaceSettings";
 //
@@ -304,6 +306,13 @@ var WithWorkspaceSettingsCaching = /** @class */ (function (_super) {
         }
         return userWorkspaceSettings;
     };
+    WithWorkspaceSettingsCaching.prototype.setLocale = function (locale) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                return [2 /*return*/, _super.prototype.setLocale.call(this, locale)];
+            });
+        });
+    };
     return WithWorkspaceSettingsCaching;
 }(DecoratedWorkspaceSettingsService));
 //
@@ -315,6 +324,78 @@ function refMatchesMdObject(ref, mdObject, type) {
         areObjRefsEqual(ref, uriRef(mdObject.uri)));
 }
 var firstDefined = flow(compact, first);
+function elementsCacheKey(ref, settings) {
+    return new SparkMD5().append(objRefToString(ref)).append(stringify(settings)).end();
+}
+function getOrCreateAttributeCache(ctx, workspace) {
+    var cache = ctx.caches.workspaceAttributes;
+    var cacheEntry = cache.get(workspace);
+    if (!cacheEntry) {
+        cacheEntry = {
+            displayForms: new LRUCache({
+                maxSize: ctx.config.maxAttributeDisplayFormsPerWorkspace,
+            }),
+            attributesByDisplayForms: new LRUCache({
+                maxSize: ctx.config.maxAttributesPerWorkspace,
+            }),
+            attributeElementResults: new LRUCache({
+                maxSize: ctx.config.maxAttributeElementResultsPerWorkspace,
+            }),
+        };
+        cache.set(workspace, cacheEntry);
+    }
+    return cacheEntry;
+}
+var CachedElementsQuery = /** @class */ (function (_super) {
+    __extends(CachedElementsQuery, _super);
+    function CachedElementsQuery(decorated, ctx, workspace, ref, settings) {
+        if (settings === void 0) { settings = {}; }
+        var _this = _super.call(this, decorated, settings) || this;
+        _this.ctx = ctx;
+        _this.workspace = workspace;
+        _this.ref = ref;
+        _this.query = function () { return __awaiter(_this, void 0, void 0, function () {
+            var canCache, cache, cacheKey, result;
+            var _a;
+            return __generator(this, function (_b) {
+                canCache = !((_a = this.settings.options) === null || _a === void 0 ? void 0 : _a.filter);
+                if (!canCache) {
+                    return [2 /*return*/, _super.prototype.query.call(this)];
+                }
+                cache = getOrCreateAttributeCache(this.ctx, this.workspace).attributeElementResults;
+                cacheKey = elementsCacheKey(this.ref, this.settings);
+                result = cache.get(cacheKey);
+                if (!result) {
+                    result = _super.prototype.query.call(this).catch(function (e) {
+                        cache.delete(cacheKey);
+                        throw e;
+                    });
+                    cache.set(cacheKey, result);
+                }
+                return [2 /*return*/, result];
+            });
+        }); };
+        return _this;
+    }
+    CachedElementsQuery.prototype.createNew = function (decorated, settings) {
+        return new CachedElementsQuery(decorated, this.ctx, this.workspace, this.ref, settings);
+    };
+    return CachedElementsQuery;
+}(DecoratedElementsQuery));
+var CachedElementsQueryFactory = /** @class */ (function (_super) {
+    __extends(CachedElementsQueryFactory, _super);
+    function CachedElementsQueryFactory(decorated, ctx, workspace) {
+        var _this = _super.call(this, decorated) || this;
+        _this.ctx = ctx;
+        _this.workspace = workspace;
+        return _this;
+    }
+    CachedElementsQueryFactory.prototype.forDisplayForm = function (ref) {
+        var decorated = this.decorated.forDisplayForm(ref);
+        return new CachedElementsQuery(decorated, this.ctx, this.workspace, ref);
+    };
+    return CachedElementsQueryFactory;
+}(DecoratedElementsQueryFactory));
 var WithAttributesCaching = /** @class */ (function (_super) {
     __extends(WithAttributesCaching, _super);
     function WithAttributesCaching(decorated, ctx, workspace) {
@@ -322,7 +403,7 @@ var WithAttributesCaching = /** @class */ (function (_super) {
         _this.ctx = ctx;
         _this.workspace = workspace;
         _this.getAttributeDisplayForm = function (ref) {
-            var cache = _this.getOrCreateWorkspaceEntry(_this.workspace).displayForms;
+            var cache = getOrCreateAttributeCache(_this.ctx, _this.workspace).displayForms;
             var idCacheKey = isIdentifierRef(ref) ? ref.identifier : undefined;
             var uriCacheKey = isUriRef(ref) ? ref.uri : undefined;
             var cacheItem = firstDefined([idCacheKey, uriCacheKey].map(function (key) { return key && cache.get(key); }));
@@ -350,7 +431,7 @@ var WithAttributesCaching = /** @class */ (function (_super) {
             return __generator(this, function (_c) {
                 switch (_c.label) {
                     case 0:
-                        cache = this.getOrCreateWorkspaceEntry(this.workspace).displayForms;
+                        cache = getOrCreateAttributeCache(this.ctx, this.workspace).displayForms;
                         refsWithCacheResults = refs.map(function (ref) {
                             var idCacheKey = isIdentifierRef(ref) ? ref.identifier : undefined;
                             var uriCacheKey = isUriRef(ref) ? ref.uri : undefined;
@@ -391,21 +472,40 @@ var WithAttributesCaching = /** @class */ (function (_super) {
                 }
             });
         }); };
-        _this.getOrCreateWorkspaceEntry = function (workspace) {
-            var cache = _this.ctx.caches.workspaceAttributes;
-            var cacheEntry = cache.get(workspace);
-            if (!cacheEntry) {
-                cacheEntry = {
-                    displayForms: new LRUCache({
-                        maxSize: _this.ctx.config.maxAttributeDisplayFormsPerWorkspace,
-                    }),
-                };
-                cache.set(workspace, cacheEntry);
-            }
-            return cacheEntry;
-        };
+        _this.getAttributeByDisplayForm = function (ref) { return __awaiter(_this, void 0, void 0, function () {
+            var cache, idCacheKey, uriCacheKey, cacheItem;
+            return __generator(this, function (_a) {
+                cache = getOrCreateAttributeCache(this.ctx, this.workspace).attributesByDisplayForms;
+                idCacheKey = isIdentifierRef(ref) ? ref.identifier : undefined;
+                uriCacheKey = isUriRef(ref) ? ref.uri : undefined;
+                cacheItem = firstDefined([idCacheKey, uriCacheKey].map(function (key) { return key && cache.get(key); }));
+                if (!cacheItem) {
+                    // eslint-disable-next-line sonarjs/no-identical-functions
+                    cacheItem = _super.prototype.getAttributeByDisplayForm.call(this, ref).catch(function (e) {
+                        if (idCacheKey) {
+                            cache.delete(idCacheKey);
+                        }
+                        if (uriCacheKey) {
+                            cache.delete(uriCacheKey);
+                        }
+                        throw e;
+                    });
+                    if (idCacheKey) {
+                        cache.set(idCacheKey, cacheItem);
+                    }
+                    if (uriCacheKey) {
+                        cache.set(uriCacheKey, cacheItem);
+                    }
+                }
+                return [2 /*return*/, cacheItem];
+            });
+        }); };
         return _this;
     }
+    WithAttributesCaching.prototype.elements = function () {
+        var decorated = this.decorated.elements();
+        return new CachedElementsQueryFactory(decorated, this.ctx, this.workspace);
+    };
     return WithAttributesCaching;
 }(DecoratedWorkspaceAttributesService));
 //
@@ -467,9 +567,14 @@ function assertPositiveOrUndefined(value, valueName) {
     invariant(value === undefined || value > 0, valueName + " to cache must be positive or undefined, got: " + value);
 }
 /**
- * @beta
+ * These are the recommended settings for the backend caching.
+ *
+ * @remarks
+ * For more information on what the options mean see {@link CachingConfiguration}.
+ *
+ * @public
  */
-export var DefaultCachingConfiguration = {
+export var RecommendedCachingConfiguration = {
     maxExecutions: 10,
     maxResultWindows: 5,
     maxCatalogs: 1,
@@ -479,6 +584,8 @@ export var DefaultCachingConfiguration = {
     maxSecuritySettingsOrgUrlsAge: 300000,
     maxAttributeWorkspaces: 1,
     maxAttributeDisplayFormsPerWorkspace: 100,
+    maxAttributesPerWorkspace: 100,
+    maxAttributeElementResultsPerWorkspace: 100,
     maxWorkspaceSettings: 1,
 };
 /**
@@ -487,11 +594,10 @@ export var DefaultCachingConfiguration = {
  *
  * @remarks see {@link CachingConfiguration} properties for more information.
  * @param realBackend - real backend to decorate with caching
- * @param config - caching configuration
- * @beta
+ * @param config - caching configuration. {@link RecommendedCachingConfiguration} can be used
+ * @public
  */
 export function withCaching(realBackend, config) {
-    if (config === void 0) { config = DefaultCachingConfiguration; }
     assertPositiveOrUndefined(config.maxCatalogOptions, "maxCatalogOptions");
     assertPositiveOrUndefined(config.maxSecuritySettingsOrgUrls, "maxSecuritySettingsOrgUrls");
     assertPositiveOrUndefined(config.maxSecuritySettingsOrgUrlsAge, "maxSecuritySettingsOrgUrlsAge");