@backstage/plugin-catalog-common 0.1.1 → 0.1.2-next.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @backstage/plugin-catalog-common
 
+## 0.1.2-next.0
+
+### Patch Changes
+
+- ba59832aed: Adds new `catalogEntityCreatePermission` which can be imported and used when authoring a permission policy to restrict/grant a user's access to the catalog import plugin. (And the "Register Existing Component" button which navigates there).
+
 ## 0.1.1
 
 ### Patch Changes

package/dist/index.cjs.js

@@ -10,6 +10,13 @@ const catalogEntityReadPermission = {
   },
   resourceType: RESOURCE_TYPE_CATALOG_ENTITY
 };
+const catalogEntityCreatePermission = {
+  name: "catalog.entity.create",
+  attributes: {
+    action: "create"
+  },
+  resourceType: RESOURCE_TYPE_CATALOG_ENTITY
+};
 const catalogEntityDeletePermission = {
   name: "catalog.entity.delete",
   attributes: {
@@ -44,6 +51,7 @@ const catalogLocationDeletePermission = {
 };
 
 exports.RESOURCE_TYPE_CATALOG_ENTITY = RESOURCE_TYPE_CATALOG_ENTITY;
+exports.catalogEntityCreatePermission = catalogEntityCreatePermission;
 exports.catalogEntityDeletePermission = catalogEntityDeletePermission;
 exports.catalogEntityReadPermission = catalogEntityReadPermission;
 exports.catalogEntityRefreshPermission = catalogEntityRefreshPermission;

package/dist/index.cjs.js.map

@@ -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 * @public\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 * @public\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 designate actions that involve removing one or\n * more entities from the catalog.\n * @public\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 * @public\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 * @public\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 * @public\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 * @public\n */\nexport const catalogLocationDeletePermission: Permission = {\n  name: 'catalog.location.delete',\n  attributes: {\n    action: 'delete',\n  },\n};\n"],"names":[],"mappings":";;;;MAsBa,+BAA+B;MAU/B,8BAA0C;AAAA,EACrD,MAAM;AAAA,EACN,YAAY;AAAA,IACV,QAAQ;AAAA;AAAA,EAEV,cAAc;AAAA;MAQH,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;;;;;;;;;;"}
+{"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 * @public\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 * @public\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 * @public\n */\nexport const catalogEntityCreatePermission: Permission = {\n  name: 'catalog.entity.create',\n  attributes: {\n    action: 'create',\n  },\n  resourceType: RESOURCE_TYPE_CATALOG_ENTITY,\n};\n\n/**\n * This permission is used to designate actions that involve removing one or\n * more entities from the catalog.\n * @public\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 * @public\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 * @public\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 * @public\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 * @public\n */\nexport const catalogLocationDeletePermission: Permission = {\n  name: 'catalog.location.delete',\n  attributes: {\n    action: 'delete',\n  },\n};\n"],"names":[],"mappings":";;;;MAsBa,+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,EAEV,cAAc;AAAA;MAQH,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.d.ts

@@ -14,6 +14,13 @@ declare const RESOURCE_TYPE_CATALOG_ENTITY = "catalog-entity";
  * @public
  */
 declare 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
+ */
+declare const catalogEntityCreatePermission: Permission;
 /**
  * This permission is used to designate actions that involve removing one or
  * more entities from the catalog.
@@ -48,4 +55,4 @@ declare const catalogLocationCreatePermission: Permission;
  */
 declare const catalogLocationDeletePermission: Permission;
 
-export { RESOURCE_TYPE_CATALOG_ENTITY, catalogEntityDeletePermission, catalogEntityReadPermission, catalogEntityRefreshPermission, catalogLocationCreatePermission, catalogLocationDeletePermission, catalogLocationReadPermission };
+export { RESOURCE_TYPE_CATALOG_ENTITY, catalogEntityCreatePermission, catalogEntityDeletePermission, catalogEntityReadPermission, catalogEntityRefreshPermission, catalogLocationCreatePermission, catalogLocationDeletePermission, catalogLocationReadPermission };

package/dist/index.esm.js

@@ -6,6 +6,13 @@ const catalogEntityReadPermission = {
   },
   resourceType: RESOURCE_TYPE_CATALOG_ENTITY
 };
+const catalogEntityCreatePermission = {
+  name: "catalog.entity.create",
+  attributes: {
+    action: "create"
+  },
+  resourceType: RESOURCE_TYPE_CATALOG_ENTITY
+};
 const catalogEntityDeletePermission = {
   name: "catalog.entity.delete",
   attributes: {
@@ -39,5 +46,5 @@ const catalogLocationDeletePermission = {
   }
 };
 
-export { RESOURCE_TYPE_CATALOG_ENTITY, catalogEntityDeletePermission, catalogEntityReadPermission, catalogEntityRefreshPermission, catalogLocationCreatePermission, catalogLocationDeletePermission, catalogLocationReadPermission };
+export { RESOURCE_TYPE_CATALOG_ENTITY, catalogEntityCreatePermission, catalogEntityDeletePermission, catalogEntityReadPermission, catalogEntityRefreshPermission, catalogLocationCreatePermission, catalogLocationDeletePermission, catalogLocationReadPermission };
 //# sourceMappingURL=index.esm.js.map

package/dist/index.esm.js.map

@@ -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 * @public\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 * @public\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 designate actions that involve removing one or\n * more entities from the catalog.\n * @public\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 * @public\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 * @public\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 * @public\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 * @public\n */\nexport const catalogLocationDeletePermission: Permission = {\n  name: 'catalog.location.delete',\n  attributes: {\n    action: 'delete',\n  },\n};\n"],"names":[],"mappings":"MAsBa,+BAA+B;MAU/B,8BAA0C;AAAA,EACrD,MAAM;AAAA,EACN,YAAY;AAAA,IACV,QAAQ;AAAA;AAAA,EAEV,cAAc;AAAA;MAQH,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;;;;"}
+{"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 * @public\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 * @public\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 * @public\n */\nexport const catalogEntityCreatePermission: Permission = {\n  name: 'catalog.entity.create',\n  attributes: {\n    action: 'create',\n  },\n  resourceType: RESOURCE_TYPE_CATALOG_ENTITY,\n};\n\n/**\n * This permission is used to designate actions that involve removing one or\n * more entities from the catalog.\n * @public\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 * @public\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 * @public\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 * @public\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 * @public\n */\nexport const catalogLocationDeletePermission: Permission = {\n  name: 'catalog.location.delete',\n  attributes: {\n    action: 'delete',\n  },\n};\n"],"names":[],"mappings":"MAsBa,+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,EAEV,cAAc;AAAA;MAQH,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

@@ -1,7 +1,7 @@
 {
   "name": "@backstage/plugin-catalog-common",
   "description": "Common functionalities for the catalog plugin",
-  "version": "0.1.1",
+  "version": "0.1.2-next.0",
   "main": "dist/index.cjs.js",
   "types": "dist/index.d.ts",
   "license": "Apache-2.0",
@@ -33,11 +33,11 @@
     "@backstage/plugin-permission-common": "^0.4.0"
   },
   "devDependencies": {
-    "@backstage/cli": "^0.12.0"
+    "@backstage/cli": "^0.13.1-next.1"
   },
   "files": [
     "dist"
   ],
-  "gitHead": "600d6e3c854bbfb12a0078ca6f726d1c0d1fea0b",
+  "gitHead": "d6da97a1edeb21fcefc682d91916987ba9f3d89a",
   "module": "dist/index.esm.js"
 }