Merge pull request #9878 from backstage/catalog-common-alpha

catalog-common: mark permission-related exports as alpha

plugins/catalog-common/api-report.md

@@ -5,27 +5,27 @@
 ```ts
 import { Permission } from '@backstage/plugin-permission-common';
 
-// @public
+// @alpha
 export const catalogEntityCreatePermission: Permission;
 
-// @public
+// @alpha
 export const catalogEntityDeletePermission: Permission;
 
-// @public
+// @alpha
 export const catalogEntityReadPermission: Permission;
 
-// @public
+// @alpha
 export const catalogEntityRefreshPermission: Permission;
 
-// @public
+// @alpha
 export const catalogLocationCreatePermission: Permission;
 
-// @public
+// @alpha
 export const catalogLocationDeletePermission: Permission;
 
-// @public
+// @alpha
 export const catalogLocationReadPermission: Permission;
 
-// @public (undocumented)
+// @alpha
 export const RESOURCE_TYPE_CATALOG_ENTITY = 'catalog-entity';
 ```

plugins/catalog-common/package.json

@@ -10,7 +10,8 @@
     "access": "public",
     "main": "dist/index.cjs.js",
     "module": "dist/index.esm.js",
-    "types": "dist/index.d.ts"
+    "types": "dist/index.d.ts",
+    "alphaTypes": "dist/index.alpha.d.ts"
   },
   "backstage": {
     "role": "common-library"
@@ -25,7 +26,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",
@@ -39,6 +40,7 @@
     "@backstage/cli": "^0.14.0"
   },
   "files": [
-    "dist"
+    "dist",
+    "alpha"
   ]
 }

plugins/catalog-common/src/permissions.ts

@@ -17,8 +17,10 @@
 import { Permission } from '@backstage/plugin-permission-common';
 
 /**
+ * Permission resource type which corresponds to catalog entities.
+ *
  * {@link https://backstage.io/docs/features/software-catalog/software-catalog-overview}
- * @public
+ * @alpha
  */
 export const RESOURCE_TYPE_CATALOG_ENTITY = 'catalog-entity';
 
@@ -28,7 +30,7 @@ export const RESOURCE_TYPE_CATALOG_ENTITY = 'catalog-entity';
  *
  * If this permission is not authorized, it will appear that the entity does not
  * exist in the catalog — both in the frontend and in API responses.
- * @public
+ * @alpha
  */
 export const catalogEntityReadPermission: Permission = {
   name: 'catalog.entity.read',
@@ -42,7 +44,7 @@ export const catalogEntityReadPermission: Permission = {
  * This permission is used to authorize actions that involve creating a new
  * catalog entity. This includes registering an existing component into the
  * catalog.
- * @public
+ * @alpha
  */
 export const catalogEntityCreatePermission: Permission = {
   name: 'catalog.entity.create',
@@ -54,7 +56,7 @@ export const catalogEntityCreatePermission: Permission = {
 /**
  * This permission is used to designate actions that involve removing one or
  * more entities from the catalog.
- * @public
+ * @alpha
  */
 export const catalogEntityDeletePermission: Permission = {
   name: 'catalog.entity.delete',
@@ -67,7 +69,7 @@ export const catalogEntityDeletePermission: Permission = {
 /**
  * This permission is used to designate refreshing one or more entities from the
  * catalog.
- * @public
+ * @alpha
  */
 export const catalogEntityRefreshPermission: Permission = {
   name: 'catalog.entity.refresh',
@@ -83,7 +85,7 @@ export const catalogEntityRefreshPermission: Permission = {
  *
  * If this permission is not authorized, it will appear that the location does
  * not exist in the catalog — both in the frontend and in API responses.
- * @public
+ * @alpha
  */
 export const catalogLocationReadPermission: Permission = {
   name: 'catalog.location.read',
@@ -95,7 +97,7 @@ export const catalogLocationReadPermission: Permission = {
 /**
  * This permission is used to designate actions that involve creating catalog
  * locations.
- * @public
+ * @alpha
  */
 export const catalogLocationCreatePermission: Permission = {
   name: 'catalog.location.create',
@@ -107,7 +109,7 @@ export const catalogLocationCreatePermission: Permission = {
 /**
  * This permission is used to designate actions that involve deleting locations
  * from the catalog.
- * @public
+ * @alpha
  */
 export const catalogLocationDeletePermission: Permission = {
   name: 'catalog.location.delete',