@bcgov/plugin-catalog-dataset 0.1.0
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 +47 -0
- package/package.json +56 -0
package/README.md
ADDED
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
# catalog-dataset
|
|
2
|
+
|
|
3
|
+
This package is part of the BC Data Catalogue Backstage integration.
|
|
4
|
+
|
|
5
|
+
👉 **Please refer to the main project README at the root of this repository for installation and usage instructions.**
|
|
6
|
+
|
|
7
|
+
This plugin is one part of a multi-package integration and is not intended to be used independently.
|
|
8
|
+
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
## Purpose
|
|
12
|
+
|
|
13
|
+
The `@bcgov/catalog-dataset` package provides the frontend UI for rendering `Dataset` entities in Backstage.
|
|
14
|
+
|
|
15
|
+
It is intended to be used from the Backstage **entity page**, not as a standalone route.
|
|
16
|
+
|
|
17
|
+
---
|
|
18
|
+
|
|
19
|
+
## How It Is Accessed
|
|
20
|
+
|
|
21
|
+
This plugin uses the Backstage entity context and is expected to be rendered through an entity page configuration such as:
|
|
22
|
+
|
|
23
|
+
```tsx
|
|
24
|
+
<EntitySwitch.Case if={isKind('dataset')} children={<CatalogDatasetPage />} />
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
In normal usage, users access this page by opening a `Dataset` entity from the Backstage catalog.
|
|
28
|
+
|
|
29
|
+
A direct route such as `/catalog-dataset` does **not** provide entity context and will fail unless additional context wiring is added.
|
|
30
|
+
|
|
31
|
+
---
|
|
32
|
+
|
|
33
|
+
## Local Development
|
|
34
|
+
|
|
35
|
+
This plugin can still be developed locally, but the standard Backstage usage is through a dataset entity in the catalog.
|
|
36
|
+
|
|
37
|
+
See the `./dev` directory for local plugin development setup.
|
|
38
|
+
|
|
39
|
+
---
|
|
40
|
+
|
|
41
|
+
## Notes
|
|
42
|
+
|
|
43
|
+
- This plugin depends on:
|
|
44
|
+
- `@bcgov/plugin-catalog-common-bc-data-catalogue`
|
|
45
|
+
- `@bcgov/plugin-catalog-backend-module-bc-data-catalogue`
|
|
46
|
+
- Always follow the main project README when adding this to a Backstage instance
|
|
47
|
+
- Do not document `/catalog-dataset` as the normal access path unless you intentionally add entity context for that route
|
package/package.json
ADDED
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@bcgov/plugin-catalog-dataset",
|
|
3
|
+
"version": "0.1.0",
|
|
4
|
+
"license": "Apache-2.0",
|
|
5
|
+
"main": "dist/index.esm.js",
|
|
6
|
+
"types": "dist/index.d.ts",
|
|
7
|
+
"publishConfig": {
|
|
8
|
+
"access": "public",
|
|
9
|
+
"main": "dist/index.esm.js",
|
|
10
|
+
"types": "dist/index.d.ts"
|
|
11
|
+
},
|
|
12
|
+
"backstage": {
|
|
13
|
+
"role": "frontend-plugin",
|
|
14
|
+
"pluginId": "catalog-dataset",
|
|
15
|
+
"pluginPackages": [
|
|
16
|
+
"@bcgov/plugin-catalog-dataset"
|
|
17
|
+
]
|
|
18
|
+
},
|
|
19
|
+
"sideEffects": false,
|
|
20
|
+
"scripts": {
|
|
21
|
+
"start": "backstage-cli package start",
|
|
22
|
+
"build": "backstage-cli package build",
|
|
23
|
+
"lint": "backstage-cli package lint",
|
|
24
|
+
"test": "backstage-cli package test",
|
|
25
|
+
"clean": "backstage-cli package clean",
|
|
26
|
+
"prepack": "backstage-cli package prepack",
|
|
27
|
+
"postpack": "backstage-cli package postpack"
|
|
28
|
+
},
|
|
29
|
+
"dependencies": {
|
|
30
|
+
"@backstage/core-components": "^0.17.3",
|
|
31
|
+
"@backstage/core-plugin-api": "^1.10.9",
|
|
32
|
+
"@backstage/theme": "^0.6.6",
|
|
33
|
+
"@bcgov/plugin-catalog-common-bc-data-catalogue": "workspace:*",
|
|
34
|
+
"@material-ui/core": "^4.9.13",
|
|
35
|
+
"@material-ui/icons": "^4.9.1",
|
|
36
|
+
"@material-ui/lab": "^4.0.0-alpha.61",
|
|
37
|
+
"react-use": "^17.2.4"
|
|
38
|
+
},
|
|
39
|
+
"peerDependencies": {
|
|
40
|
+
"react": "^16.13.1 || ^17.0.0 || ^18.0.0"
|
|
41
|
+
},
|
|
42
|
+
"devDependencies": {
|
|
43
|
+
"@backstage/cli": "^0.33.0",
|
|
44
|
+
"@backstage/core-app-api": "^1.17.1",
|
|
45
|
+
"@backstage/dev-utils": "^1.1.12",
|
|
46
|
+
"@backstage/test-utils": "^1.7.9",
|
|
47
|
+
"@testing-library/jest-dom": "^6.0.0",
|
|
48
|
+
"@testing-library/react": "^14.0.0",
|
|
49
|
+
"@testing-library/user-event": "^14.0.0",
|
|
50
|
+
"msw": "^1.0.0",
|
|
51
|
+
"react": "^16.13.1 || ^17.0.0 || ^18.0.0"
|
|
52
|
+
},
|
|
53
|
+
"files": [
|
|
54
|
+
"dist"
|
|
55
|
+
]
|
|
56
|
+
}
|