@gooddata/sdk-backend-base 9.0.0-alpha.8 → 9.0.0-beta.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gooddata/sdk-backend-base",
-  "version": "9.0.0-alpha.8",
+  "version": "9.0.0-beta.0",
   "author": "GoodData",
   "description": "GoodData.UI SDK - Base for backend implementations",
   "repository": {
@@ -9,25 +9,17 @@
     "directory": "libs/sdk-backend-base"
   },
   "license": "MIT",
-  "main": "dist/index.js",
-  "module": "esm/index.js",
-  "es2015": "esm/index.js",
-  "browser": "dist/index.js",
-  "typings": "esm/index.d.ts",
+  "type": "module",
+  "browser": "./esm/index.js",
+  "exports": "./esm/index.js",
+  "types": "./esm/index.d.ts",
   "sideEffects": false,
   "files": [
-    "dist/**/*.js",
-    "dist/**/*.json",
-    "dist/**/*.d.ts",
-    "dist/**/*.map",
     "esm/**/*.js",
     "esm/**/*.json",
     "esm/**/*.d.ts",
     "esm/**/*.map"
   ],
-  "config": {
-    "eslint": "-c .eslintrc.js --ext ts src/"
-  },
   "dependencies": {
     "@braintree/sanitize-url": "^6.0.0",
     "json-stable-stringify": "^1.0.1",
@@ -36,16 +28,15 @@
     "ts-invariant": "^0.7.3",
     "tslib": "^2.5.0",
     "uuid": "^8.3.2",
-    "lru-cache": "^8.0.4",
-    "@gooddata/sdk-backend-spi": "9.0.0-alpha.8",
-    "@gooddata/sdk-model": "9.0.0-alpha.8",
-    "@gooddata/util": "9.0.0-alpha.8"
+    "lru-cache": "^9.1.1",
+    "@gooddata/sdk-backend-spi": "9.0.0-beta.0",
+    "@gooddata/sdk-model": "9.0.0-beta.0",
+    "@gooddata/util": "9.0.0-beta.0"
   },
   "devDependencies": {
     "@gooddata/eslint-config": "^4.1.0",
     "@microsoft/api-documenter": "^7.17.0",
-    "@microsoft/api-extractor": "^7.20.0",
-    "@types/jest": "^29.5.1",
+    "@microsoft/api-extractor": "^7.36.0",
     "@types/json-stable-stringify": "^1.0.32",
     "@types/lodash": "^4.14.158",
     "@types/spark-md5": "^3.0.1",
@@ -53,39 +44,38 @@
     "@typescript-eslint/eslint-plugin": "^5.57.1",
     "@typescript-eslint/parser": "^5.57.1",
     "concurrently": "^6.0.2",
-    "dependency-cruiser": "^10.1.1",
+    "dependency-cruiser": "^13.0.3",
     "eslint": "^8.25.0",
     "eslint-plugin-header": "^3.0.0",
     "eslint-plugin-import": "^2.22.0",
+    "eslint-plugin-import-esm": "^1.2.1",
     "eslint-plugin-jest": "^27.1.1",
     "eslint-plugin-no-only-tests": "^2.4.0",
     "eslint-plugin-prettier": "^4.0.0",
     "eslint-plugin-regexp": "^1.9.0",
     "eslint-plugin-sonarjs": "^0.16.0",
     "eslint-plugin-tsdoc": "^0.2.14",
-    "jest": "^29.5.0",
-    "jest-junit": "^3.0.0",
     "prettier": "~2.5.0",
-    "ts-jest": "^29.1.0",
     "typescript": "5.0.2",
-    "@gooddata/reference-workspace": "9.0.0-alpha.8"
+    "vitest": "0.31.4",
+    "@gooddata/reference-workspace": "9.0.0-beta.0"
   },
   "scripts": {
-    "clean": "rm -rf ci dist esm coverage *.log && jest --clearCache",
+    "clean": "rm -rf ci dist esm coverage *.log",
     "dev": "tsc -p tsconfig.dev.json --watch",
-    "build": "concurrently \"npm run build-cjs\" \"npm run build-esm\" && npm run api-extractor",
-    "build-cjs": "tsc -p tsconfig.build.json",
-    "build-esm": "tsc -p tsconfig.build.esm.json",
+    "build": "npm run build-esm && npm run api-extractor",
+    "build-esm": "tsc -p tsconfig.build.json",
     "api-extractor": "mkdir -p api && [ -z \"${CI}\" ] && (api-extractor run -l) || (api-extractor run)",
-    "test": "jest --watch",
-    "test-once": "jest --maxWorkers=${JEST_MAX_WORKERS:-'45%'}",
-    "test-ci": "JEST_JUNIT_OUTPUT=./ci/results/test-results.xml jest --ci --config jest.ci.js",
-    "eslint": "eslint $npm_package_config_eslint",
-    "eslint-ci": "mkdir -p ./ci/results && eslint -f checkstyle -o ci/results/eslint-results.xml $npm_package_config_eslint",
+    "test": "vitest watch",
+    "test-once": "vitest run",
+    "test-ci": "vitest run --reporter=junit --outputFile=./ci/results/test-results.xml",
+    "eslint": "eslint -c .eslintrc.cjs src/",
+    "eslint-fix": "eslint -c .eslintrc.cjs src/ --fix",
+    "eslint-ci": "mkdir -p ./ci/results && eslint -f checkstyle -o ci/results/eslint-results.xml -c .eslintrc.cjs src/",
     "prettier-check": "prettier --check '{src,test}/**/*.{ts,tsx,json,scss,md,yaml,html}'",
     "prettier-write": "prettier --write '{src,test}/**/*.{ts,tsx,json,scss,md,yaml,html}'",
-    "dep-cruiser": "depcruise --validate .dependency-cruiser.js --output-type err-long src/",
-    "dep-cruiser-ci": "depcruise --validate .dependency-cruiser.js --output-type err-long src/",
+    "dep-cruiser": "depcruise --validate .dependency-cruiser.cjs --output-type err-long src/",
+    "dep-cruiser-ci": "depcruise --validate .dependency-cruiser.cjs --output-type err-long src/",
     "validate": "npm run dep-cruiser && npm run eslint && npm run prettier-check",
     "validate-ci": "npm run dep-cruiser-ci && npm run eslint-ci && npm run prettier-check"
   }

package/dist/cachingBackend/index.d.ts

@@ -1,230 +0,0 @@
-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.
- *
- * @public
- */
-export type CacheControl = {
-    /**
-     * Resets all execution caches.
-     *
-     * NOTE: this only resets the top-level caches. If your code holds onto execution results returned by
-     * caching backend, those have additional sub-caches which _will not_ be impacted by this call.
-     */
-    resetExecutions: () => void;
-    /**
-     * Resets all catalog caches.
-     */
-    resetCatalogs: () => void;
-    /**
-     * Resets all organization security settings caches.
-     */
-    resetSecuritySettings: () => void;
-    /**
-     * Resets all workspace attribute caches.
-     */
-    resetAttributes: () => void;
-    /**
-     * Resets all workspace settings caches.
-     */
-    resetWorkspaceSettings: () => void;
-    /**
-     * Convenience method to reset all caches (calls all the particular resets).
-     */
-    resetAll: () => void;
-};
-/**
- * Specifies where should the caching decorator apply and to what size should caches grow.
- *
- * @public
- */
-export type CachingConfiguration = {
-    /**
-     * Maximum number of executions which will have their results cached. The execution fingerprint is used
-     * as cache key - the caching is thus subject to some limitations. See `defFingerprint` function for more
-     * information.
-     *
-     * 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
-     * executions cache is dangerous in applications with long-lived sessions that can create many unique executions -
-     * memory usage will only go up.
-     *
-     * When non-positive number is specified, then no caching will be done.
-     */
-    maxExecutions?: number;
-    /**
-     * Maximum number of execution result's pages to cache PER result. The window offset and limit are used as cache key.
-     *
-     * 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
-     * result window cache is dangerous in applications that read result windows in 'random' fashion.
-     *
-     * When non-positive number is specified, then no caching of result windows will be done.
-     *
-     * Note: this option has no effect if execution caching is disabled.
-     */
-    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.
-     *
-     * 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
-     * catalogs cache may be OK in applications where number of workspaces is small - the cache will be limited
-     * naturally and will not grow uncontrollably.
-     *
-     * When non-positive number is specified, then no caching of result windows will be done.
-     */
-    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.
-     *
-     * 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. How dangerous
-     * this is depends on how many catalog load options combinations your application allows to create. Recommended
-     * approach is to load entire catalog of all items once and reuse it. If there is chance that your app can create
-     * many unique options, then it is better to bound this.
-     *
-     * Setting non-positive number here is invalid. If you want to turn off catalog caching, tweak the `maxCatalogs`.
-     */
-    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.
-     *
-     * @param cacheControl - cache control instance
-     */
-    onCacheReady?: (cacheControl: CacheControl) => void;
-    /**
-     * Maximum number of organizations that will have its security settings cached. The scope string built by
-     * particular backend implementation from organization ID will be used as cache key.
-     *
-     * 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
-     * security settings organization cache is dangerous in applications with long-lived sessions that can
-     * create many unique requests and memory usage will only go up.
-     *
-     * When non-positive number is specified, then no caching will be done.
-     */
-    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.
-     *
-     * 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
-     * security settings organization URL cache is dangerous in applications with long-lived sessions that can
-     * create many unique requests and memory usage will only go up.
-     *
-     * Setting non-positive number here is invalid. If you want to turn off organization security settings caching,
-     * tweak the `maxSecuritySettingsOrgs`.
-     */
-    maxSecuritySettingsOrgUrls?: number;
-    /**
-     * Maximum age of cached organization's URL validation results. The value is in milliseconds.
-     *
-     * Items are not pro-actively pruned out as they age, but if you try to get an item that is too old,
-     * it'll drop it and make a new request to the backend. The purpose of the cache setting is not mainly
-     * to limit its size to prevent memory usage grow (tweak `maxSecuritySettingsOrgUrls` for that)
-     * but to propagate URL whitelist changes on backend to the long-lived application sessions.
-     *
-     * Setting non-positive number here is invalid. If you want to turn off organization security settings
-     * caching, tweak the `maxSecuritySettingsOrgs`.
-     */
-    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.
-     * For each workspace, there will be a cache entry holding `maxAttributeDisplayFormsPerWorkspace` entries for attribute display form-related calls.
-     *
-     * 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
-     * cache may be OK in applications where number of workspaces is small - the cache will be limited
-     * naturally and will not grow uncontrollably.
-     *
-     * When non-positive number is specified, then no caching will be done.
-     */
-    maxAttributeWorkspaces?: number;
-    /**
-     * Maximum number of attribute display forms 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 display form cache may be OK in applications where number of attribute display forms 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 display form
-     * caching, tweak the `maxAttributeWorkspaces` value.
-     */
-    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 attribute 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.
-     *
-     * The `maxAttributeWorkspaces` value must be positive, otherwise this setting is ignored.
-     * When non-positive number is specified, then no caching of attribute element results will be done.
-     */
-    maxAttributeElementResultsPerWorkspace?: number;
-    /**
-     * Maximum number of settings for a workspace and for a user 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
-     * workspace settings cache is dangerous in applications that change query the settings of many different
-     * workspaces - this will cache quite large objects for each workspace and can make the memory usage go up.
-     *
-     * When non-positive number is specified, then no caching of result windows will be done.
-     */
-    maxWorkspaceSettings?: number;
-};
-/**
- * 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;
-/**
- * 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. {@link RecommendedCachingConfiguration} can be used
- * @public
- */
-export declare function withCaching(realBackend: IAnalyticalBackend, config: CachingConfiguration): IAnalyticalBackend;
-//# sourceMappingURL=index.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/cachingBackend/index.ts"],"names":[],"mappings":"AACA,OAAO,EACH,kBAAkB,EAoBrB,MAAM,2BAA2B,CAAC;AAkuBnC;;;;;GAKG;AACH,MAAM,MAAM,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,MAAM,MAAM,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"}