@gooddata/reference-workspace 11.19.0-alpha.3 → 11.19.0-alpha.4
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 +7 -6
- package/package.json +7 -9
package/README.md
CHANGED
|
@@ -65,16 +65,17 @@ The `src/recordings/uiTestScenarios` directory defines recordings for storybook
|
|
|
65
65
|
The Logical Data Model (LDM) is stored in the [src/md](src/md) directory and consists of two files:
|
|
66
66
|
|
|
67
67
|
- **full.ts**: An auto-generated file created by running the `npm run refresh-md` script.
|
|
68
|
-
|
|
68
|
+
|
|
69
|
+
> Note: The script is hardcoded with an existing workspace. You may need to request access to this workspace or modify the script to use your own.
|
|
69
70
|
|
|
70
71
|
- **ext.ts**: A file holding extensions to the standard LDM. This file stores custom LDM and analytical objects built on top of standard objects, such as PoP measures, Previous Period Measures, and Arithmetic Measures.
|
|
71
|
-
|
|
72
|
+
> Note: Objects in `ext.ts` must be related to the reference workspace. Avoid using dummy or mock declarations.
|
|
72
73
|
|
|
73
74
|
## Working with Recordings
|
|
74
75
|
|
|
75
76
|
### Executions
|
|
76
77
|
|
|
77
|
-
Execution recordings are in the [src/recordings/executions](src/recordings/executions) directory. Each execution recording must be stored in its own directory. The directories can be organized as needed.
|
|
78
|
+
Execution recordings are in the [src/recordings/executions](src/recordings/executions) directory. Each execution recording must be stored in its own directory. The directories can be organized as needed.
|
|
78
79
|
|
|
79
80
|
> **Note:** The `uiTestScenarios` directory is managed via automation. Do not store custom recordings here, as they will be overwritten.
|
|
80
81
|
|
|
@@ -83,8 +84,8 @@ Rules for recording entries:
|
|
|
83
84
|
- **Unique Recordings**: Must be stored in a directory named after the fingerprint of their execution definition (obtained using the `defFingerprint` function).
|
|
84
85
|
- **definition.json**: Must exist and contain a valid execution definition (obtained by serializing the `IExecutionDefinition` to JSON).
|
|
85
86
|
- **Optional Metadata Files**:
|
|
86
|
-
|
|
87
|
-
|
|
87
|
+
- `scenarios.json`: Contains an array of `{ vis: string, scenario: string }` objects to create a `Scenarios` mapping in the recording index.
|
|
88
|
+
- `requests.json`: This specifies which data views to obtain and store. Examples are in the `uiTestScenarios` directory.
|
|
88
89
|
|
|
89
90
|
After creating this, run the `npm run refresh-md` script to obtain data from the live reference workspace.
|
|
90
91
|
|
|
@@ -92,4 +93,4 @@ After creating this, run the `npm run refresh-md` script to obtain data from the
|
|
|
92
93
|
|
|
93
94
|
(C) 2017-2024 GoodData Corporation
|
|
94
95
|
|
|
95
|
-
This project is licensed under the MIT License. See [LICENSE](https://github.com/gooddata/gooddata-ui-sdk/blob/master/tools/reference-workspace/LICENSE).
|
|
96
|
+
This project is licensed under the MIT License. See [LICENSE](https://github.com/gooddata/gooddata-ui-sdk/blob/master/tools/reference-workspace/LICENSE).
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@gooddata/reference-workspace",
|
|
3
|
-
"version": "11.19.0-alpha.
|
|
3
|
+
"version": "11.19.0-alpha.4",
|
|
4
4
|
"description": "GoodData SDK - Reference Workspace for tests",
|
|
5
5
|
"repository": {
|
|
6
6
|
"type": "git",
|
|
@@ -20,10 +20,10 @@
|
|
|
20
20
|
"esm/**/*.map"
|
|
21
21
|
],
|
|
22
22
|
"dependencies": {
|
|
23
|
-
"lodash-es": "^4.17.
|
|
23
|
+
"lodash-es": "^4.17.23",
|
|
24
24
|
"tslib": "2.8.1",
|
|
25
|
-
"@gooddata/sdk-backend-spi": "11.19.0-alpha.
|
|
26
|
-
"@gooddata/sdk-model": "11.19.0-alpha.
|
|
25
|
+
"@gooddata/sdk-backend-spi": "11.19.0-alpha.4",
|
|
26
|
+
"@gooddata/sdk-model": "11.19.0-alpha.4"
|
|
27
27
|
},
|
|
28
28
|
"devDependencies": {
|
|
29
29
|
"@types/lodash-es": "^4.17.12",
|
|
@@ -32,18 +32,16 @@
|
|
|
32
32
|
"@typescript-eslint/parser": "8.52.0",
|
|
33
33
|
"dependency-cruiser": "^14.1.2",
|
|
34
34
|
"eslint": "^9.39.2",
|
|
35
|
-
"eslint-config-prettier": "10.1.8",
|
|
36
35
|
"eslint-plugin-header": "3.1.1",
|
|
37
36
|
"eslint-plugin-import-esm": "1.2.1",
|
|
38
37
|
"eslint-plugin-import-x": "4.16.1",
|
|
39
38
|
"eslint-plugin-jsdoc": "62.1.0",
|
|
40
39
|
"eslint-plugin-no-barrel-files": "1.2.2",
|
|
41
40
|
"eslint-plugin-no-only-tests": "3.3.0",
|
|
42
|
-
"eslint-plugin-prettier": "5.5.4",
|
|
43
41
|
"eslint-plugin-sonarjs": "3.0.6",
|
|
44
42
|
"prettier": "^3.6.2",
|
|
45
43
|
"typescript": "5.9.3",
|
|
46
|
-
"@gooddata/eslint-config": "11.19.0-alpha.
|
|
44
|
+
"@gooddata/eslint-config": "11.19.0-alpha.4"
|
|
47
45
|
},
|
|
48
46
|
"scripts": {
|
|
49
47
|
"_phase:build": "npm run build",
|
|
@@ -56,8 +54,8 @@
|
|
|
56
54
|
"eslint-fix": "eslint src --fix",
|
|
57
55
|
"export-ref-workspace": "cd ../reference-workspace-mgmt && npm run export-ref-workspace",
|
|
58
56
|
"import-ref-workspace": "cd ../reference-workspace-mgmt && npm run import-ref-workspace",
|
|
59
|
-
"prettier-check": "prettier --
|
|
60
|
-
"prettier-write": "prettier --
|
|
57
|
+
"prettier-check": "prettier --check .",
|
|
58
|
+
"prettier-write": "prettier --write .",
|
|
61
59
|
"refresh-md": "../reference-workspace-mgmt/bin/refresh-md.sh && npm run build",
|
|
62
60
|
"refresh-recordings": "../reference-workspace-mgmt/bin/refresh-recordings.sh && npm run prettier-write && npm run build",
|
|
63
61
|
"validate": "npm run dep-cruiser && npm run eslint && npm run prettier-check"
|