@backstage/plugin-catalog-common 0.0.0-nightly-20220306022754 → 0.0.0-nightly-20220309022441
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/CHANGELOG.md +2 -2
- package/alpha/package.json +1 -1
- package/dist/index.alpha.d.ts +90 -0
- package/dist/index.beta.d.ts +42 -0
- package/dist/index.d.ts +42 -0
- package/package.json +3 -3
package/CHANGELOG.md
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
# @backstage/plugin-catalog-common
|
|
2
2
|
|
|
3
|
-
## 0.0.0-nightly-
|
|
3
|
+
## 0.0.0-nightly-20220309022441
|
|
4
4
|
|
|
5
5
|
### Patch Changes
|
|
6
6
|
|
|
7
7
|
- b1aacbf96a: Applied the fix for the `/alpha` entry point resolution that was part of the `v0.70.1` release of Backstage.
|
|
8
8
|
- Updated dependencies
|
|
9
|
-
- @backstage/search-common@0.0.0-nightly-
|
|
9
|
+
- @backstage/search-common@0.0.0-nightly-20220309022441
|
|
10
10
|
|
|
11
11
|
## 0.2.1
|
|
12
12
|
|
package/alpha/package.json
CHANGED
|
@@ -0,0 +1,90 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Provides shared objects useful for interacting with the catalog and its
|
|
3
|
+
* entities, such as catalog permissions.
|
|
4
|
+
*
|
|
5
|
+
* @packageDocumentation
|
|
6
|
+
*/
|
|
7
|
+
|
|
8
|
+
import { IndexableDocument } from '@backstage/search-common';
|
|
9
|
+
import { Permission } from '@backstage/plugin-permission-common';
|
|
10
|
+
|
|
11
|
+
/**
|
|
12
|
+
* This permission is used to authorize actions that involve creating a new
|
|
13
|
+
* catalog entity. This includes registering an existing component into the
|
|
14
|
+
* catalog.
|
|
15
|
+
* @alpha
|
|
16
|
+
*/
|
|
17
|
+
export declare const catalogEntityCreatePermission: Permission;
|
|
18
|
+
|
|
19
|
+
/**
|
|
20
|
+
* This permission is used to designate actions that involve removing one or
|
|
21
|
+
* more entities from the catalog.
|
|
22
|
+
* @alpha
|
|
23
|
+
*/
|
|
24
|
+
export declare const catalogEntityDeletePermission: Permission;
|
|
25
|
+
|
|
26
|
+
/**
|
|
27
|
+
* The Document format for an Entity in the Catalog for search
|
|
28
|
+
*
|
|
29
|
+
* @public
|
|
30
|
+
*/
|
|
31
|
+
export declare interface CatalogEntityDocument extends IndexableDocument {
|
|
32
|
+
/** @deprecated `componentType` is being renamed to `type`. During the transition both of these fields should be set to the same value, in order to avoid issues with indexing. */
|
|
33
|
+
componentType: string;
|
|
34
|
+
type: string;
|
|
35
|
+
namespace: string;
|
|
36
|
+
kind: string;
|
|
37
|
+
lifecycle: string;
|
|
38
|
+
owner: string;
|
|
39
|
+
}
|
|
40
|
+
|
|
41
|
+
/**
|
|
42
|
+
* This permission is used to authorize actions that involve reading one or more
|
|
43
|
+
* entities from the catalog.
|
|
44
|
+
*
|
|
45
|
+
* If this permission is not authorized, it will appear that the entity does not
|
|
46
|
+
* exist in the catalog — both in the frontend and in API responses.
|
|
47
|
+
* @alpha
|
|
48
|
+
*/
|
|
49
|
+
export declare const catalogEntityReadPermission: Permission;
|
|
50
|
+
|
|
51
|
+
/**
|
|
52
|
+
* This permission is used to designate refreshing one or more entities from the
|
|
53
|
+
* catalog.
|
|
54
|
+
* @alpha
|
|
55
|
+
*/
|
|
56
|
+
export declare const catalogEntityRefreshPermission: Permission;
|
|
57
|
+
|
|
58
|
+
/**
|
|
59
|
+
* This permission is used to designate actions that involve creating catalog
|
|
60
|
+
* locations.
|
|
61
|
+
* @alpha
|
|
62
|
+
*/
|
|
63
|
+
export declare const catalogLocationCreatePermission: Permission;
|
|
64
|
+
|
|
65
|
+
/**
|
|
66
|
+
* This permission is used to designate actions that involve deleting locations
|
|
67
|
+
* from the catalog.
|
|
68
|
+
* @alpha
|
|
69
|
+
*/
|
|
70
|
+
export declare const catalogLocationDeletePermission: Permission;
|
|
71
|
+
|
|
72
|
+
/**
|
|
73
|
+
* This permission is used to designate actions that involve reading one or more
|
|
74
|
+
* locations from the catalog.
|
|
75
|
+
*
|
|
76
|
+
* If this permission is not authorized, it will appear that the location does
|
|
77
|
+
* not exist in the catalog — both in the frontend and in API responses.
|
|
78
|
+
* @alpha
|
|
79
|
+
*/
|
|
80
|
+
export declare const catalogLocationReadPermission: Permission;
|
|
81
|
+
|
|
82
|
+
/**
|
|
83
|
+
* Permission resource type which corresponds to catalog entities.
|
|
84
|
+
*
|
|
85
|
+
* {@link https://backstage.io/docs/features/software-catalog/software-catalog-overview}
|
|
86
|
+
* @alpha
|
|
87
|
+
*/
|
|
88
|
+
export declare const RESOURCE_TYPE_CATALOG_ENTITY = "catalog-entity";
|
|
89
|
+
|
|
90
|
+
export { }
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Provides shared objects useful for interacting with the catalog and its
|
|
3
|
+
* entities, such as catalog permissions.
|
|
4
|
+
*
|
|
5
|
+
* @packageDocumentation
|
|
6
|
+
*/
|
|
7
|
+
|
|
8
|
+
import { IndexableDocument } from '@backstage/search-common';
|
|
9
|
+
import { Permission } from '@backstage/plugin-permission-common';
|
|
10
|
+
|
|
11
|
+
/* Excluded from this release type: catalogEntityCreatePermission */
|
|
12
|
+
|
|
13
|
+
/* Excluded from this release type: catalogEntityDeletePermission */
|
|
14
|
+
|
|
15
|
+
/**
|
|
16
|
+
* The Document format for an Entity in the Catalog for search
|
|
17
|
+
*
|
|
18
|
+
* @public
|
|
19
|
+
*/
|
|
20
|
+
export declare interface CatalogEntityDocument extends IndexableDocument {
|
|
21
|
+
/** @deprecated `componentType` is being renamed to `type`. During the transition both of these fields should be set to the same value, in order to avoid issues with indexing. */
|
|
22
|
+
componentType: string;
|
|
23
|
+
type: string;
|
|
24
|
+
namespace: string;
|
|
25
|
+
kind: string;
|
|
26
|
+
lifecycle: string;
|
|
27
|
+
owner: string;
|
|
28
|
+
}
|
|
29
|
+
|
|
30
|
+
/* Excluded from this release type: catalogEntityReadPermission */
|
|
31
|
+
|
|
32
|
+
/* Excluded from this release type: catalogEntityRefreshPermission */
|
|
33
|
+
|
|
34
|
+
/* Excluded from this release type: catalogLocationCreatePermission */
|
|
35
|
+
|
|
36
|
+
/* Excluded from this release type: catalogLocationDeletePermission */
|
|
37
|
+
|
|
38
|
+
/* Excluded from this release type: catalogLocationReadPermission */
|
|
39
|
+
|
|
40
|
+
/* Excluded from this release type: RESOURCE_TYPE_CATALOG_ENTITY */
|
|
41
|
+
|
|
42
|
+
export { }
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Provides shared objects useful for interacting with the catalog and its
|
|
3
|
+
* entities, such as catalog permissions.
|
|
4
|
+
*
|
|
5
|
+
* @packageDocumentation
|
|
6
|
+
*/
|
|
7
|
+
|
|
8
|
+
import { IndexableDocument } from '@backstage/search-common';
|
|
9
|
+
import { Permission } from '@backstage/plugin-permission-common';
|
|
10
|
+
|
|
11
|
+
/* Excluded from this release type: catalogEntityCreatePermission */
|
|
12
|
+
|
|
13
|
+
/* Excluded from this release type: catalogEntityDeletePermission */
|
|
14
|
+
|
|
15
|
+
/**
|
|
16
|
+
* The Document format for an Entity in the Catalog for search
|
|
17
|
+
*
|
|
18
|
+
* @public
|
|
19
|
+
*/
|
|
20
|
+
export declare interface CatalogEntityDocument extends IndexableDocument {
|
|
21
|
+
/** @deprecated `componentType` is being renamed to `type`. During the transition both of these fields should be set to the same value, in order to avoid issues with indexing. */
|
|
22
|
+
componentType: string;
|
|
23
|
+
type: string;
|
|
24
|
+
namespace: string;
|
|
25
|
+
kind: string;
|
|
26
|
+
lifecycle: string;
|
|
27
|
+
owner: string;
|
|
28
|
+
}
|
|
29
|
+
|
|
30
|
+
/* Excluded from this release type: catalogEntityReadPermission */
|
|
31
|
+
|
|
32
|
+
/* Excluded from this release type: catalogEntityRefreshPermission */
|
|
33
|
+
|
|
34
|
+
/* Excluded from this release type: catalogLocationCreatePermission */
|
|
35
|
+
|
|
36
|
+
/* Excluded from this release type: catalogLocationDeletePermission */
|
|
37
|
+
|
|
38
|
+
/* Excluded from this release type: catalogLocationReadPermission */
|
|
39
|
+
|
|
40
|
+
/* Excluded from this release type: RESOURCE_TYPE_CATALOG_ENTITY */
|
|
41
|
+
|
|
42
|
+
export { }
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@backstage/plugin-catalog-common",
|
|
3
3
|
"description": "Common functionalities for the catalog plugin",
|
|
4
|
-
"version": "0.0.0-nightly-
|
|
4
|
+
"version": "0.0.0-nightly-20220309022441",
|
|
5
5
|
"main": "dist/index.cjs.js",
|
|
6
6
|
"types": "dist/index.d.ts",
|
|
7
7
|
"license": "Apache-2.0",
|
|
@@ -35,10 +35,10 @@
|
|
|
35
35
|
},
|
|
36
36
|
"dependencies": {
|
|
37
37
|
"@backstage/plugin-permission-common": "^0.5.2",
|
|
38
|
-
"@backstage/search-common": "^0.0.0-nightly-
|
|
38
|
+
"@backstage/search-common": "^0.0.0-nightly-20220309022441"
|
|
39
39
|
},
|
|
40
40
|
"devDependencies": {
|
|
41
|
-
"@backstage/cli": "^0.0.0-nightly-
|
|
41
|
+
"@backstage/cli": "^0.0.0-nightly-20220309022441"
|
|
42
42
|
},
|
|
43
43
|
"files": [
|
|
44
44
|
"dist",
|