@gooddata/sdk-backend-base 8.11.0 → 8.12.0-alpha.10
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/README.md +16 -9
- package/package.json +9 -9
package/README.md
CHANGED
|
@@ -1,5 +1,12 @@
|
|
|
1
1
|
# Analytical Backend SPI - infrastructure and foundations
|
|
2
2
|
|
|
3
|
+
[](https://www.npmjs.com/@gooddata/sdk-backend-base)
|
|
4
|
+
[](https://npmcharts.com/compare/@gooddata/sdk-backend-base?minimal=true)
|
|
5
|
+

|
|
6
|
+
|
|
7
|
+
This package is a part of the [GoodData.UI SDK](https://sdk.gooddata.com/gooddata-ui/docs/about_gooddataui.html).
|
|
8
|
+
To learn more, check [the source monorepo](https://github.com/gooddata/gooddata-ui-sdk).
|
|
9
|
+
|
|
3
10
|
This package contains foundational, reusable code useful for building new or decorating existing
|
|
4
11
|
[Analytical Backend](https://www.npmjs.com/package/@gooddata/sdk-backend-spi) implementations. This is lower-level, infrastructural code which may be useful
|
|
5
12
|
when building larger, more complex applications.
|
|
@@ -24,9 +31,9 @@ is at the moment limited to the execution part of the Analytical Backend SPI.
|
|
|
24
31
|
Backend decorated with eventing can be created as follows:
|
|
25
32
|
|
|
26
33
|
```typescript
|
|
27
|
-
import {IAnalyticalBackend} from "@gooddata/sdk-backend-spi";
|
|
28
|
-
import {IExecutionDefinition, IDataView} from "@gooddata/sdk-model";
|
|
29
|
-
import {withEventing} from "@gooddata/sdk-backend-base";
|
|
34
|
+
import { IAnalyticalBackend } from "@gooddata/sdk-backend-spi";
|
|
35
|
+
import { IExecutionDefinition, IDataView } from "@gooddata/sdk-model";
|
|
36
|
+
import { withEventing } from "@gooddata/sdk-backend-base";
|
|
30
37
|
|
|
31
38
|
const realBackendImplementation = ...;
|
|
32
39
|
const enhancedBackend: IAnalyticalBackend = withEventing(realBackendImplementation, {
|
|
@@ -58,8 +65,8 @@ data structures. To the caller, all of this optimization remains transparent and
|
|
|
58
65
|
execution actually executed.
|
|
59
66
|
|
|
60
67
|
```typescript
|
|
61
|
-
import {IAnalyticalBackend} from "@gooddata/sdk-backend-spi";
|
|
62
|
-
import {withNormalization} from "@gooddata/sdk-backend-base";
|
|
68
|
+
import { IAnalyticalBackend } from "@gooddata/sdk-backend-spi";
|
|
69
|
+
import { withNormalization } from "@gooddata/sdk-backend-base";
|
|
63
70
|
|
|
64
71
|
const realBackendImplementation = ...;
|
|
65
72
|
const enhancedBackend: IAnalyticalBackend = withNormalization(realBackendImplementation);
|
|
@@ -74,8 +81,8 @@ If your app must deliver a snappy experience without too many loading indicators
|
|
|
74
81
|
critical requirement, then this decorator can speed your application immensely.
|
|
75
82
|
|
|
76
83
|
```typescript
|
|
77
|
-
import {IAnalyticalBackend} from "@gooddata/sdk-backend-spi";
|
|
78
|
-
import {withCaching, RecommendedCachingConfiguration} from "@gooddata/sdk-backend-base";
|
|
84
|
+
import { IAnalyticalBackend } from "@gooddata/sdk-backend-spi";
|
|
85
|
+
import { withCaching, RecommendedCachingConfiguration } from "@gooddata/sdk-backend-base";
|
|
79
86
|
|
|
80
87
|
const realBackendImplementation = ...;
|
|
81
88
|
const enhancedBackend: IAnalyticalBackend = withCaching(realBackendImplementation, RecommendedCachingConfiguration);
|
|
@@ -87,8 +94,8 @@ available in this package.
|
|
|
87
94
|
The caching plays well with normalization:
|
|
88
95
|
|
|
89
96
|
```typescript
|
|
90
|
-
import {IAnalyticalBackend} from "@gooddata/sdk-backend-spi";
|
|
91
|
-
import {withCaching, withNormalization, RecommendedCachingConfiguration} from "@gooddata/sdk-backend-base";
|
|
97
|
+
import { IAnalyticalBackend } from "@gooddata/sdk-backend-spi";
|
|
98
|
+
import { withCaching, withNormalization, RecommendedCachingConfiguration } from "@gooddata/sdk-backend-base";
|
|
92
99
|
|
|
93
100
|
const realBackendImplementation = ...;
|
|
94
101
|
const enhancedBackend: IAnalyticalBackend = withNormalization(withCaching(realBackendImplementation, RecommendedCachingConfiguration));
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@gooddata/sdk-backend-base",
|
|
3
|
-
"version": "8.
|
|
3
|
+
"version": "8.12.0-alpha.10",
|
|
4
4
|
"author": "GoodData",
|
|
5
5
|
"description": "GoodData.UI SDK - Base for backend implementations",
|
|
6
6
|
"repository": {
|
|
@@ -30,9 +30,9 @@
|
|
|
30
30
|
},
|
|
31
31
|
"dependencies": {
|
|
32
32
|
"@braintree/sanitize-url": "^6.0.0",
|
|
33
|
-
"@gooddata/sdk-backend-spi": "^8.
|
|
34
|
-
"@gooddata/sdk-model": "^8.
|
|
35
|
-
"@gooddata/util": "^8.
|
|
33
|
+
"@gooddata/sdk-backend-spi": "^8.12.0-alpha.10",
|
|
34
|
+
"@gooddata/sdk-model": "^8.12.0-alpha.10",
|
|
35
|
+
"@gooddata/util": "^8.12.0-alpha.10",
|
|
36
36
|
"json-stable-stringify": "^1.0.1",
|
|
37
37
|
"lodash": "^4.17.19",
|
|
38
38
|
"spark-md5": "^3.0.0",
|
|
@@ -42,7 +42,7 @@
|
|
|
42
42
|
},
|
|
43
43
|
"devDependencies": {
|
|
44
44
|
"@gooddata/eslint-config": "^2.1.0",
|
|
45
|
-
"@gooddata/reference-workspace": "^8.
|
|
45
|
+
"@gooddata/reference-workspace": "^8.12.0-alpha.10",
|
|
46
46
|
"@microsoft/api-documenter": "^7.17.0",
|
|
47
47
|
"@microsoft/api-extractor": "^7.20.0",
|
|
48
48
|
"@types/jest": "^27.0.1",
|
|
@@ -54,14 +54,14 @@
|
|
|
54
54
|
"@typescript-eslint/parser": "^5.5.0",
|
|
55
55
|
"concurrently": "^6.0.2",
|
|
56
56
|
"dependency-cruiser": "^10.1.1",
|
|
57
|
-
"eslint": "^8.
|
|
57
|
+
"eslint": "^8.25.0",
|
|
58
58
|
"eslint-plugin-header": "^3.0.0",
|
|
59
59
|
"eslint-plugin-import": "^2.22.0",
|
|
60
|
-
"eslint-plugin-jest": "^
|
|
60
|
+
"eslint-plugin-jest": "^27.1.1",
|
|
61
61
|
"eslint-plugin-no-only-tests": "^2.4.0",
|
|
62
62
|
"eslint-plugin-prettier": "^4.0.0",
|
|
63
|
-
"eslint-plugin-regexp": "^1.
|
|
64
|
-
"eslint-plugin-sonarjs": "^0.
|
|
63
|
+
"eslint-plugin-regexp": "^1.9.0",
|
|
64
|
+
"eslint-plugin-sonarjs": "^0.16.0",
|
|
65
65
|
"eslint-plugin-tsdoc": "^0.2.14",
|
|
66
66
|
"jest": "^27.5.1",
|
|
67
67
|
"jest-junit": "^3.0.0",
|