Merge pull request #9820 from backstage/jhaals/mark-useEntityPermission-alpha

catalog-react: mark useEntityPermission as alpha
This commit is contained in:
Johan Haals
2022-03-01 13:44:06 +01:00
committed by GitHub
4 changed files with 12 additions and 5 deletions
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/plugin-catalog-react': minor
---
Marked `useEntityPermission` as alpha since the underlying permission framework is under active development.
+1 -1
View File
@@ -560,7 +560,7 @@ export function useEntityOwnership(): {
isOwnedEntity: (entity: Entity | EntityName) => boolean;
};
// @public
// @alpha
export function useEntityPermission(permission: Permission): {
loading: boolean;
allowed: boolean;
+5 -3
View File
@@ -9,7 +9,8 @@
"publishConfig": {
"access": "public",
"main": "dist/index.esm.js",
"types": "dist/index.d.ts"
"types": "dist/index.d.ts",
"alphaTypes": "dist/index.alpha.d.ts"
},
"backstage": {
"role": "web-library"
@@ -24,7 +25,7 @@
"backstage"
],
"scripts": {
"build": "backstage-cli package build",
"build": "backstage-cli package build --experimental-type-build",
"lint": "backstage-cli package lint",
"test": "backstage-cli package test",
"prepack": "backstage-cli package prepack",
@@ -76,6 +77,7 @@
"react-test-renderer": "^16.13.1"
},
"files": [
"dist"
"dist",
"alpha"
]
}
@@ -28,7 +28,7 @@ import { useEntity } from './useEntity';
* Note: this hook blocks the permission request until the entity has loaded in
* context. If you have the entityRef and need concurrent requests, use the
* `usePermission` hook directly.
* @public
* @alpha
*/
export function useEntityPermission(permission: Permission): {
loading: boolean;