@backstage/plugin-catalog-common 0.0.0-nightly-20220216022224 → 0.0.0-nightly-20220305022735
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 +53 -2
- package/alpha/package.json +7 -0
- package/dist/index.cjs.js +1 -2
- package/dist/index.cjs.js.map +1 -1
- package/dist/index.esm.js +1 -2
- package/dist/index.esm.js.map +1 -1
- package/package.json +17 -11
- package/dist/index.d.ts +0 -58
package/CHANGELOG.md
CHANGED
|
@@ -1,11 +1,62 @@
|
|
|
1
1
|
# @backstage/plugin-catalog-common
|
|
2
2
|
|
|
3
|
-
## 0.0.0-nightly-
|
|
3
|
+
## 0.0.0-nightly-20220305022735
|
|
4
4
|
|
|
5
5
|
### Patch Changes
|
|
6
6
|
|
|
7
|
+
- b1aacbf96a: Applied the fix for the `/alpha` entry point resolution that was part of the `v0.70.1` release of Backstage.
|
|
7
8
|
- Updated dependencies
|
|
8
|
-
- @backstage/
|
|
9
|
+
- @backstage/search-common@0.0.0-nightly-20220305022735
|
|
10
|
+
|
|
11
|
+
## 0.2.1
|
|
12
|
+
|
|
13
|
+
### Patch Changes
|
|
14
|
+
|
|
15
|
+
- Fixed runtime resolution of the `/alpha` entry point.
|
|
16
|
+
|
|
17
|
+
## 0.2.0
|
|
18
|
+
|
|
19
|
+
### Minor Changes
|
|
20
|
+
|
|
21
|
+
- e3c2bfef11: Remove resourceType property from catalogEntityCreatePermission. Resource type refers to the type of resources whose resourceRefs should be passed along with authorize requests, to allow conditional responses for that resource type. Since creation does not correspond to an entity (as the entity does not exist at the time of authorization), the resourceRef should not be included on the permission.
|
|
22
|
+
- 81273e95cf: **Breaking**: Mark permission-related exports as alpha. This means that the exports below should now be imported from `@backstage/plugin-catalog-common/alpha` instead of `@backstage/plugin-catalog-common`.
|
|
23
|
+
|
|
24
|
+
- `RESOURCE_TYPE_CATALOG_ENTITY`
|
|
25
|
+
- `catalogEntityReadPermission`
|
|
26
|
+
- `catalogEntityCreatePermission`
|
|
27
|
+
- `catalogEntityDeletePermission`
|
|
28
|
+
- `catalogEntityRefreshPermission`
|
|
29
|
+
- `catalogLocationReadPermission`
|
|
30
|
+
- `catalogLocationCreatePermission`
|
|
31
|
+
- `catalogLocationDeletePermission`
|
|
32
|
+
|
|
33
|
+
### Patch Changes
|
|
34
|
+
|
|
35
|
+
- ab7b6cb7b1: **DEPRECATION**: Moved the `CatalogEntityDocument` to `@backstage/plugin-catalog-common` and deprecated the export from `@backstage/plugin-catalog-backend`.
|
|
36
|
+
|
|
37
|
+
A new `type` field has also been added to `CatalogEntityDocument` as a replacement for `componentType`, which is now deprecated. Both fields are still present and should be set to the same value in order to avoid issues with indexing.
|
|
38
|
+
|
|
39
|
+
Any search customizations need to be updated to use this new `type` field instead, including any custom frontend filters, custom frontend result components, custom search decorators, or non-default Catalog collator implementations.
|
|
40
|
+
|
|
41
|
+
- Updated dependencies
|
|
42
|
+
- @backstage/plugin-permission-common@0.5.2
|
|
43
|
+
- @backstage/search-common@0.3.0
|
|
44
|
+
|
|
45
|
+
## 0.1.4
|
|
46
|
+
|
|
47
|
+
### Patch Changes
|
|
48
|
+
|
|
49
|
+
- Fix for the previous release with missing type declarations.
|
|
50
|
+
- Updated dependencies
|
|
51
|
+
- @backstage/plugin-permission-common@0.5.1
|
|
52
|
+
|
|
53
|
+
## 0.1.3
|
|
54
|
+
|
|
55
|
+
### Patch Changes
|
|
56
|
+
|
|
57
|
+
- c77c5c7eb6: Added `backstage.role` to `package.json`
|
|
58
|
+
- Updated dependencies
|
|
59
|
+
- @backstage/plugin-permission-common@0.5.0
|
|
9
60
|
|
|
10
61
|
## 0.1.2
|
|
11
62
|
|
package/dist/index.cjs.js
CHANGED
package/dist/index.cjs.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.cjs.js","sources":["../src/permissions.ts"],"sourcesContent":["/*\n * Copyright 2021 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { Permission } from '@backstage/plugin-permission-common';\n\n/**\n * {@link https://backstage.io/docs/features/software-catalog/software-catalog-overview}\n * @
|
|
1
|
+
{"version":3,"file":"index.cjs.js","sources":["../src/permissions.ts"],"sourcesContent":["/*\n * Copyright 2021 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { Permission } from '@backstage/plugin-permission-common';\n\n/**\n * Permission resource type which corresponds to catalog entities.\n *\n * {@link https://backstage.io/docs/features/software-catalog/software-catalog-overview}\n * @alpha\n */\nexport const RESOURCE_TYPE_CATALOG_ENTITY = 'catalog-entity';\n\n/**\n * This permission is used to authorize actions that involve reading one or more\n * entities from the catalog.\n *\n * If this permission is not authorized, it will appear that the entity does not\n * exist in the catalog — both in the frontend and in API responses.\n * @alpha\n */\nexport const catalogEntityReadPermission: Permission = {\n name: 'catalog.entity.read',\n attributes: {\n action: 'read',\n },\n resourceType: RESOURCE_TYPE_CATALOG_ENTITY,\n};\n\n/**\n * This permission is used to authorize actions that involve creating a new\n * catalog entity. This includes registering an existing component into the\n * catalog.\n * @alpha\n */\nexport const catalogEntityCreatePermission: Permission = {\n name: 'catalog.entity.create',\n attributes: {\n action: 'create',\n },\n};\n\n/**\n * This permission is used to designate actions that involve removing one or\n * more entities from the catalog.\n * @alpha\n */\nexport const catalogEntityDeletePermission: Permission = {\n name: 'catalog.entity.delete',\n attributes: {\n action: 'delete',\n },\n resourceType: RESOURCE_TYPE_CATALOG_ENTITY,\n};\n\n/**\n * This permission is used to designate refreshing one or more entities from the\n * catalog.\n * @alpha\n */\nexport const catalogEntityRefreshPermission: Permission = {\n name: 'catalog.entity.refresh',\n attributes: {\n action: 'update',\n },\n resourceType: RESOURCE_TYPE_CATALOG_ENTITY,\n};\n\n/**\n * This permission is used to designate actions that involve reading one or more\n * locations from the catalog.\n *\n * If this permission is not authorized, it will appear that the location does\n * not exist in the catalog — both in the frontend and in API responses.\n * @alpha\n */\nexport const catalogLocationReadPermission: Permission = {\n name: 'catalog.location.read',\n attributes: {\n action: 'read',\n },\n};\n\n/**\n * This permission is used to designate actions that involve creating catalog\n * locations.\n * @alpha\n */\nexport const catalogLocationCreatePermission: Permission = {\n name: 'catalog.location.create',\n attributes: {\n action: 'create',\n },\n};\n\n/**\n * This permission is used to designate actions that involve deleting locations\n * from the catalog.\n * @alpha\n */\nexport const catalogLocationDeletePermission: Permission = {\n name: 'catalog.location.delete',\n attributes: {\n action: 'delete',\n },\n};\n"],"names":[],"mappings":";;;;MAwBa,+BAA+B;MAU/B,8BAA0C;AAAA,EACrD,MAAM;AAAA,EACN,YAAY;AAAA,IACV,QAAQ;AAAA;AAAA,EAEV,cAAc;AAAA;MASH,gCAA4C;AAAA,EACvD,MAAM;AAAA,EACN,YAAY;AAAA,IACV,QAAQ;AAAA;AAAA;MASC,gCAA4C;AAAA,EACvD,MAAM;AAAA,EACN,YAAY;AAAA,IACV,QAAQ;AAAA;AAAA,EAEV,cAAc;AAAA;MAQH,iCAA6C;AAAA,EACxD,MAAM;AAAA,EACN,YAAY;AAAA,IACV,QAAQ;AAAA;AAAA,EAEV,cAAc;AAAA;MAWH,gCAA4C;AAAA,EACvD,MAAM;AAAA,EACN,YAAY;AAAA,IACV,QAAQ;AAAA;AAAA;MASC,kCAA8C;AAAA,EACzD,MAAM;AAAA,EACN,YAAY;AAAA,IACV,QAAQ;AAAA;AAAA;MASC,kCAA8C;AAAA,EACzD,MAAM;AAAA,EACN,YAAY;AAAA,IACV,QAAQ;AAAA;AAAA;;;;;;;;;;;"}
|
package/dist/index.esm.js
CHANGED
package/dist/index.esm.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.esm.js","sources":["../src/permissions.ts"],"sourcesContent":["/*\n * Copyright 2021 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { Permission } from '@backstage/plugin-permission-common';\n\n/**\n * {@link https://backstage.io/docs/features/software-catalog/software-catalog-overview}\n * @
|
|
1
|
+
{"version":3,"file":"index.esm.js","sources":["../src/permissions.ts"],"sourcesContent":["/*\n * Copyright 2021 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { Permission } from '@backstage/plugin-permission-common';\n\n/**\n * Permission resource type which corresponds to catalog entities.\n *\n * {@link https://backstage.io/docs/features/software-catalog/software-catalog-overview}\n * @alpha\n */\nexport const RESOURCE_TYPE_CATALOG_ENTITY = 'catalog-entity';\n\n/**\n * This permission is used to authorize actions that involve reading one or more\n * entities from the catalog.\n *\n * If this permission is not authorized, it will appear that the entity does not\n * exist in the catalog — both in the frontend and in API responses.\n * @alpha\n */\nexport const catalogEntityReadPermission: Permission = {\n name: 'catalog.entity.read',\n attributes: {\n action: 'read',\n },\n resourceType: RESOURCE_TYPE_CATALOG_ENTITY,\n};\n\n/**\n * This permission is used to authorize actions that involve creating a new\n * catalog entity. This includes registering an existing component into the\n * catalog.\n * @alpha\n */\nexport const catalogEntityCreatePermission: Permission = {\n name: 'catalog.entity.create',\n attributes: {\n action: 'create',\n },\n};\n\n/**\n * This permission is used to designate actions that involve removing one or\n * more entities from the catalog.\n * @alpha\n */\nexport const catalogEntityDeletePermission: Permission = {\n name: 'catalog.entity.delete',\n attributes: {\n action: 'delete',\n },\n resourceType: RESOURCE_TYPE_CATALOG_ENTITY,\n};\n\n/**\n * This permission is used to designate refreshing one or more entities from the\n * catalog.\n * @alpha\n */\nexport const catalogEntityRefreshPermission: Permission = {\n name: 'catalog.entity.refresh',\n attributes: {\n action: 'update',\n },\n resourceType: RESOURCE_TYPE_CATALOG_ENTITY,\n};\n\n/**\n * This permission is used to designate actions that involve reading one or more\n * locations from the catalog.\n *\n * If this permission is not authorized, it will appear that the location does\n * not exist in the catalog — both in the frontend and in API responses.\n * @alpha\n */\nexport const catalogLocationReadPermission: Permission = {\n name: 'catalog.location.read',\n attributes: {\n action: 'read',\n },\n};\n\n/**\n * This permission is used to designate actions that involve creating catalog\n * locations.\n * @alpha\n */\nexport const catalogLocationCreatePermission: Permission = {\n name: 'catalog.location.create',\n attributes: {\n action: 'create',\n },\n};\n\n/**\n * This permission is used to designate actions that involve deleting locations\n * from the catalog.\n * @alpha\n */\nexport const catalogLocationDeletePermission: Permission = {\n name: 'catalog.location.delete',\n attributes: {\n action: 'delete',\n },\n};\n"],"names":[],"mappings":"MAwBa,+BAA+B;MAU/B,8BAA0C;AAAA,EACrD,MAAM;AAAA,EACN,YAAY;AAAA,IACV,QAAQ;AAAA;AAAA,EAEV,cAAc;AAAA;MASH,gCAA4C;AAAA,EACvD,MAAM;AAAA,EACN,YAAY;AAAA,IACV,QAAQ;AAAA;AAAA;MASC,gCAA4C;AAAA,EACvD,MAAM;AAAA,EACN,YAAY;AAAA,IACV,QAAQ;AAAA;AAAA,EAEV,cAAc;AAAA;MAQH,iCAA6C;AAAA,EACxD,MAAM;AAAA,EACN,YAAY;AAAA,IACV,QAAQ;AAAA;AAAA,EAEV,cAAc;AAAA;MAWH,gCAA4C;AAAA,EACvD,MAAM;AAAA,EACN,YAAY;AAAA,IACV,QAAQ;AAAA;AAAA;MASC,kCAA8C;AAAA,EACzD,MAAM;AAAA,EACN,YAAY;AAAA,IACV,QAAQ;AAAA;AAAA;MASC,kCAA8C;AAAA,EACzD,MAAM;AAAA,EACN,YAAY;AAAA,IACV,QAAQ;AAAA;AAAA;;;;"}
|
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-20220305022735",
|
|
5
5
|
"main": "dist/index.cjs.js",
|
|
6
6
|
"types": "dist/index.d.ts",
|
|
7
7
|
"license": "Apache-2.0",
|
|
@@ -10,7 +10,11 @@
|
|
|
10
10
|
"access": "public",
|
|
11
11
|
"main": "dist/index.cjs.js",
|
|
12
12
|
"module": "dist/index.esm.js",
|
|
13
|
-
"types": "dist/index.d.ts"
|
|
13
|
+
"types": "dist/index.d.ts",
|
|
14
|
+
"alphaTypes": "dist/index.alpha.d.ts"
|
|
15
|
+
},
|
|
16
|
+
"backstage": {
|
|
17
|
+
"role": "common-library"
|
|
14
18
|
},
|
|
15
19
|
"homepage": "https://backstage.io",
|
|
16
20
|
"repository": {
|
|
@@ -22,21 +26,23 @@
|
|
|
22
26
|
"backstage"
|
|
23
27
|
],
|
|
24
28
|
"scripts": {
|
|
25
|
-
"build": "backstage-cli build",
|
|
26
|
-
"lint": "backstage-cli lint",
|
|
27
|
-
"test": "backstage-cli test
|
|
28
|
-
"prepack": "backstage-cli prepack",
|
|
29
|
-
"postpack": "backstage-cli postpack",
|
|
30
|
-
"clean": "backstage-cli clean"
|
|
29
|
+
"build": "backstage-cli package build --experimental-type-build",
|
|
30
|
+
"lint": "backstage-cli package lint",
|
|
31
|
+
"test": "backstage-cli package test",
|
|
32
|
+
"prepack": "backstage-cli package prepack",
|
|
33
|
+
"postpack": "backstage-cli package postpack",
|
|
34
|
+
"clean": "backstage-cli package clean"
|
|
31
35
|
},
|
|
32
36
|
"dependencies": {
|
|
33
|
-
"@backstage/plugin-permission-common": "^0.
|
|
37
|
+
"@backstage/plugin-permission-common": "^0.5.2",
|
|
38
|
+
"@backstage/search-common": "^0.0.0-nightly-20220305022735"
|
|
34
39
|
},
|
|
35
40
|
"devDependencies": {
|
|
36
|
-
"@backstage/cli": "^0.0.0-nightly-
|
|
41
|
+
"@backstage/cli": "^0.0.0-nightly-20220305022735"
|
|
37
42
|
},
|
|
38
43
|
"files": [
|
|
39
|
-
"dist"
|
|
44
|
+
"dist",
|
|
45
|
+
"alpha"
|
|
40
46
|
],
|
|
41
47
|
"module": "dist/index.esm.js"
|
|
42
48
|
}
|
package/dist/index.d.ts
DELETED
|
@@ -1,58 +0,0 @@
|
|
|
1
|
-
import { Permission } from '@backstage/plugin-permission-common';
|
|
2
|
-
|
|
3
|
-
/**
|
|
4
|
-
* {@link https://backstage.io/docs/features/software-catalog/software-catalog-overview}
|
|
5
|
-
* @public
|
|
6
|
-
*/
|
|
7
|
-
declare const RESOURCE_TYPE_CATALOG_ENTITY = "catalog-entity";
|
|
8
|
-
/**
|
|
9
|
-
* This permission is used to authorize actions that involve reading one or more
|
|
10
|
-
* entities from the catalog.
|
|
11
|
-
*
|
|
12
|
-
* If this permission is not authorized, it will appear that the entity does not
|
|
13
|
-
* exist in the catalog — both in the frontend and in API responses.
|
|
14
|
-
* @public
|
|
15
|
-
*/
|
|
16
|
-
declare const catalogEntityReadPermission: Permission;
|
|
17
|
-
/**
|
|
18
|
-
* This permission is used to authorize actions that involve creating a new
|
|
19
|
-
* catalog entity. This includes registering an existing component into the
|
|
20
|
-
* catalog.
|
|
21
|
-
* @public
|
|
22
|
-
*/
|
|
23
|
-
declare const catalogEntityCreatePermission: Permission;
|
|
24
|
-
/**
|
|
25
|
-
* This permission is used to designate actions that involve removing one or
|
|
26
|
-
* more entities from the catalog.
|
|
27
|
-
* @public
|
|
28
|
-
*/
|
|
29
|
-
declare const catalogEntityDeletePermission: Permission;
|
|
30
|
-
/**
|
|
31
|
-
* This permission is used to designate refreshing one or more entities from the
|
|
32
|
-
* catalog.
|
|
33
|
-
* @public
|
|
34
|
-
*/
|
|
35
|
-
declare const catalogEntityRefreshPermission: Permission;
|
|
36
|
-
/**
|
|
37
|
-
* This permission is used to designate actions that involve reading one or more
|
|
38
|
-
* locations from the catalog.
|
|
39
|
-
*
|
|
40
|
-
* If this permission is not authorized, it will appear that the location does
|
|
41
|
-
* not exist in the catalog — both in the frontend and in API responses.
|
|
42
|
-
* @public
|
|
43
|
-
*/
|
|
44
|
-
declare const catalogLocationReadPermission: Permission;
|
|
45
|
-
/**
|
|
46
|
-
* This permission is used to designate actions that involve creating catalog
|
|
47
|
-
* locations.
|
|
48
|
-
* @public
|
|
49
|
-
*/
|
|
50
|
-
declare const catalogLocationCreatePermission: Permission;
|
|
51
|
-
/**
|
|
52
|
-
* This permission is used to designate actions that involve deleting locations
|
|
53
|
-
* from the catalog.
|
|
54
|
-
* @public
|
|
55
|
-
*/
|
|
56
|
-
declare const catalogLocationDeletePermission: Permission;
|
|
57
|
-
|
|
58
|
-
export { RESOURCE_TYPE_CATALOG_ENTITY, catalogEntityCreatePermission, catalogEntityDeletePermission, catalogEntityReadPermission, catalogEntityRefreshPermission, catalogLocationCreatePermission, catalogLocationDeletePermission, catalogLocationReadPermission };
|