@red-hat-developer-hub/backstage-plugin-bulk-import-backend 9.0.1 → 9.1.0

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 # @red-hat-developer-hub/backstage-plugin-bulk-import-backend
 
+## 9.1.0
+
+### Minor Changes
+
+- 2b31f6c: Convert `bulk.import` from a resource permission to a feature permission, and register the NFS bulk import page using the `if` permission predicate.
+
+### Patch Changes
+
+- Updated dependencies [2b31f6c]
+  - @red-hat-developer-hub/backstage-plugin-bulk-import-common@9.1.0
+
 ## 9.0.1
 
 ### Patch Changes

package/README.md

@@ -30,7 +30,9 @@ To set up the bulk import backend package for the backend:
 
 #### Permission Framework Support
 
-The Bulk Import Backend plugin has support for the permission framework. A basic example permission policy is shown below to disallow access to the bulk import API for all users except those in the `backstage-admins` group.
+The Bulk Import Backend plugin has support for the permission framework. The plugin registers `bulk.import` as a **feature permission** (`BasicPermission`) from `@red-hat-developer-hub/backstage-plugin-bulk-import-common`.
+
+A basic example permission policy is shown below to disallow access to the bulk import API for all users except those in the `backstage-admins` group.
 
 1. Create a backend module for the permission policy, under a `packages/backend/src/plugins/permissions.ts` file:
 

package/dist/helpers/auth.cjs.js

@@ -9,8 +9,7 @@ async function permissionCheck(auditor, openApiOperationId, permissions, httpAut
   const decision = (await permissions.authorize(
     [
       {
-        permission: backstagePluginBulkImportCommon.bulkImportPermission,
-        resourceRef: backstagePluginBulkImportCommon.bulkImportPermission.resourceType
+        permission: backstagePluginBulkImportCommon.bulkImportPermission
       }
     ],
     {

package/dist/helpers/auth.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"auth.cjs.js","sources":["../../src/helpers/auth.ts"],"sourcesContent":["/*\n * Copyright Red Hat, Inc.\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 type {\n  AuditorService,\n  HttpAuthService,\n  PermissionsService,\n} from '@backstage/backend-plugin-api';\nimport { NotAllowedError } from '@backstage/errors';\nimport { AuthorizeResult } from '@backstage/plugin-permission-common';\n\nimport express from 'express';\n\nimport { bulkImportPermission } from '@red-hat-developer-hub/backstage-plugin-bulk-import-common';\n\nimport { auditCreateEvent } from './auditorUtils';\n\n/**\n * This will resolve to { result: AuthorizeResult.ALLOW } if the permission framework is disabled\n */\nexport async function permissionCheck(\n  auditor: AuditorService,\n  openApiOperationId: string | undefined,\n  permissions: PermissionsService,\n  httpAuth: HttpAuthService,\n  req: express.Request,\n) {\n  const decision = (\n    await permissions.authorize(\n      [\n        {\n          permission: bulkImportPermission,\n          resourceRef: bulkImportPermission.resourceType,\n        },\n      ],\n      {\n        credentials: await httpAuth.credentials(req),\n      },\n    )\n  )[0];\n\n  if (decision.result === AuthorizeResult.DENY) {\n    const err = new NotAllowedError('Unauthorized');\n    const auditorEvent = await auditCreateEvent(\n      auditor,\n      openApiOperationId,\n      req,\n    );\n    await auditorEvent.fail({ error: err, meta: { responseStatus: 403 } });\n    throw err;\n  }\n}\n"],"names":["bulkImportPermission","AuthorizeResult","NotAllowedError","auditCreateEvent"],"mappings":";;;;;;;AAiCA,eAAsB,eAAA,CACpB,OAAA,EACA,kBAAA,EACA,WAAA,EACA,UACA,GAAA,EACA;AACA,EAAA,MAAM,QAAA,GAAA,CACJ,MAAM,WAAA,CAAY,SAAA;AAAA,IAChB;AAAA,MACE;AAAA,QACE,UAAA,EAAYA,oDAAA;AAAA,QACZ,aAAaA,oDAAA,CAAqB;AAAA;AACpC,KACF;AAAA,IACA;AAAA,MACE,WAAA,EAAa,MAAM,QAAA,CAAS,WAAA,CAAY,GAAG;AAAA;AAC7C,KAEF,CAAC,CAAA;AAEH,EAAA,IAAI,QAAA,CAAS,MAAA,KAAWC,sCAAA,CAAgB,IAAA,EAAM;AAC5C,IAAA,MAAM,GAAA,GAAM,IAAIC,sBAAA,CAAgB,cAAc,CAAA;AAC9C,IAAA,MAAM,eAAe,MAAMC,6BAAA;AAAA,MACzB,OAAA;AAAA,MACA,kBAAA;AAAA,MACA;AAAA,KACF;AACA,IAAA,MAAM,YAAA,CAAa,IAAA,CAAK,EAAE,KAAA,EAAO,GAAA,EAAK,MAAM,EAAE,cAAA,EAAgB,GAAA,EAAI,EAAG,CAAA;AACrE,IAAA,MAAM,GAAA;AAAA,EACR;AACF;;;;"}
+{"version":3,"file":"auth.cjs.js","sources":["../../src/helpers/auth.ts"],"sourcesContent":["/*\n * Copyright Red Hat, Inc.\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 type {\n  AuditorService,\n  HttpAuthService,\n  PermissionsService,\n} from '@backstage/backend-plugin-api';\nimport { NotAllowedError } from '@backstage/errors';\nimport { AuthorizeResult } from '@backstage/plugin-permission-common';\n\nimport express from 'express';\n\nimport { bulkImportPermission } from '@red-hat-developer-hub/backstage-plugin-bulk-import-common';\n\nimport { auditCreateEvent } from './auditorUtils';\n\n/**\n * This will resolve to { result: AuthorizeResult.ALLOW } if the permission framework is disabled\n */\nexport async function permissionCheck(\n  auditor: AuditorService,\n  openApiOperationId: string | undefined,\n  permissions: PermissionsService,\n  httpAuth: HttpAuthService,\n  req: express.Request,\n) {\n  const decision = (\n    await permissions.authorize(\n      [\n        {\n          permission: bulkImportPermission,\n        },\n      ],\n      {\n        credentials: await httpAuth.credentials(req),\n      },\n    )\n  )[0];\n\n  if (decision.result === AuthorizeResult.DENY) {\n    const err = new NotAllowedError('Unauthorized');\n    const auditorEvent = await auditCreateEvent(\n      auditor,\n      openApiOperationId,\n      req,\n    );\n    await auditorEvent.fail({ error: err, meta: { responseStatus: 403 } });\n    throw err;\n  }\n}\n"],"names":["bulkImportPermission","AuthorizeResult","NotAllowedError","auditCreateEvent"],"mappings":";;;;;;;AAiCA,eAAsB,eAAA,CACpB,OAAA,EACA,kBAAA,EACA,WAAA,EACA,UACA,GAAA,EACA;AACA,EAAA,MAAM,QAAA,GAAA,CACJ,MAAM,WAAA,CAAY,SAAA;AAAA,IAChB;AAAA,MACE;AAAA,QACE,UAAA,EAAYA;AAAA;AACd,KACF;AAAA,IACA;AAAA,MACE,WAAA,EAAa,MAAM,QAAA,CAAS,WAAA,CAAY,GAAG;AAAA;AAC7C,KAEF,CAAC,CAAA;AAEH,EAAA,IAAI,QAAA,CAAS,MAAA,KAAWC,sCAAA,CAAgB,IAAA,EAAM;AAC5C,IAAA,MAAM,GAAA,GAAM,IAAIC,sBAAA,CAAgB,cAAc,CAAA;AAC9C,IAAA,MAAM,eAAe,MAAMC,6BAAA;AAAA,MACzB,OAAA;AAAA,MACA,kBAAA;AAAA,MACA;AAAA,KACF;AACA,IAAA,MAAM,YAAA,CAAa,IAAA,CAAK,EAAE,KAAA,EAAO,GAAA,EAAK,MAAM,EAAE,cAAA,EAAgB,GAAA,EAAI,EAAG,CAAA;AACrE,IAAA,MAAM,GAAA;AAAA,EACR;AACF;;;;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@red-hat-developer-hub/backstage-plugin-bulk-import-backend",
-  "version": "9.0.1",
+  "version": "9.1.0",
   "main": "./dist/index.cjs.js",
   "types": "./dist/index.d.ts",
   "license": "Apache-2.0",
@@ -61,7 +61,7 @@
     "@gitbeaker/rest": "^43.4.0",
     "@octokit/auth-app": "^7.2.2",
     "@octokit/rest": "^20.0.2",
-    "@red-hat-developer-hub/backstage-plugin-bulk-import-common": "^9.0.1",
+    "@red-hat-developer-hub/backstage-plugin-bulk-import-common": "^9.1.0",
     "@red-hat-developer-hub/backstage-plugin-orchestrator-common": "^3.7.3",
     "ajv-formats": "^3.0.1",
     "eventsource-client": "^1.2.0",