@backstage/plugin-permission-react 0.4.42-next.0 → 0.5.0

package/CHANGELOG.md

@@ -1,5 +1,27 @@
 # @backstage/plugin-permission-react
 
+## 0.5.0
+
+### Minor Changes
+
+- 53954e1: **BREAKING**: Removed the deprecated `PermissionedRoute` component. Use `RequirePermission` instead.
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/config@1.3.7
+  - @backstage/core-plugin-api@1.12.5
+  - @backstage/plugin-permission-common@0.9.8
+
+## 0.4.42-next.1
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/config@1.3.7-next.0
+  - @backstage/core-plugin-api@1.12.5-next.2
+  - @backstage/plugin-permission-common@0.9.8-next.0
+
 ## 0.4.42-next.0
 
 ### Patch Changes

package/dist/index.d.ts

@@ -1,30 +1,8 @@
-import * as react_jsx_runtime from 'react/jsx-runtime';
-import { ReactNode, ReactElement } from 'react';
+import { ReactNode } from 'react';
 import { Permission, ResourcePermission, EvaluatePermissionRequest, EvaluatePermissionResponse, AuthorizePermissionRequest, AuthorizePermissionResponse } from '@backstage/plugin-permission-common';
 import { ApiRef, DiscoveryApi, IdentityApi } from '@backstage/core-plugin-api';
 import { Config } from '@backstage/config';
 
-/**
- * Returns a React Router Route which only renders the element when authorized. If unauthorized, the Route will render a
- * NotFoundErrorPage (see {@link @backstage/core-app-api#AppComponents}).
- *
- * @public
- * @deprecated This component no longer works with the most recent version of `@backstage/core-app-api` and react-router v6, use {@link RequirePermission} instead.
- */
-declare const PermissionedRoute: (props: {
-    caseSensitive?: boolean;
-    children?: ReactNode;
-    element?: ReactElement | null;
-    path?: string;
-    errorComponent?: ReactElement | null;
-} & ({
-    permission: Exclude<Permission, ResourcePermission>;
-    resourceRef?: never;
-} | {
-    permission: ResourcePermission;
-    resourceRef: string | undefined;
-})) => react_jsx_runtime.JSX.Element;
-
 /**
  * Properties for {@link RequirePermission}
  *
@@ -121,5 +99,5 @@ declare class IdentityPermissionApi implements PermissionApi {
     authorize(request: AuthorizePermissionRequest): Promise<AuthorizePermissionResponse>;
 }
 
-export { IdentityPermissionApi, PermissionedRoute, RequirePermission, permissionApiRef, usePermission };
+export { IdentityPermissionApi, RequirePermission, permissionApiRef, usePermission };
 export type { AsyncPermissionResult, PermissionApi, RequirePermissionProps };

package/dist/index.esm.js

@@ -1,4 +1,3 @@
-export { PermissionedRoute } from './components/PermissionedRoute.esm.js';
 export { RequirePermission } from './components/RequirePermission.esm.js';
 export { usePermission } from './hooks/usePermission.esm.js';
 export { permissionApiRef } from './apis/PermissionApi.esm.js';

package/dist/index.esm.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.esm.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;"}
+{"version":3,"file":"index.esm.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-permission-react",
-  "version": "0.4.42-next.0",
+  "version": "0.5.0",
   "backstage": {
     "role": "web-library",
     "pluginId": "permission",
@@ -42,27 +42,25 @@
     "test": "backstage-cli package test"
   },
   "dependencies": {
-    "@backstage/config": "1.3.6",
-    "@backstage/core-plugin-api": "1.12.5-next.0",
-    "@backstage/plugin-permission-common": "0.9.7",
+    "@backstage/config": "^1.3.7",
+    "@backstage/core-plugin-api": "^1.12.5",
+    "@backstage/plugin-permission-common": "^0.9.8",
     "dataloader": "^2.0.0",
     "swr": "^2.0.0"
   },
   "devDependencies": {
-    "@backstage/cli": "0.36.1-next.0",
-    "@backstage/test-utils": "1.7.17-next.0",
+    "@backstage/cli": "^0.36.1",
+    "@backstage/test-utils": "^1.7.17",
     "@testing-library/jest-dom": "^6.0.0",
     "@testing-library/react": "^16.0.0",
     "@types/react": "^18.0.0",
     "react": "^18.0.2",
-    "react-dom": "^18.0.2",
-    "react-router-dom": "^6.30.2"
+    "react-dom": "^18.0.2"
   },
   "peerDependencies": {
     "@types/react": "^17.0.0 || ^18.0.0",
     "react": "^17.0.0 || ^18.0.0",
-    "react-dom": "^17.0.0 || ^18.0.0",
-    "react-router-dom": "^6.30.2"
+    "react-dom": "^17.0.0 || ^18.0.0"
   },
   "peerDependenciesMeta": {
     "@types/react": {

package/dist/components/PermissionedRoute.esm.js

@@ -1,24 +0,0 @@
-import { jsx } from 'react/jsx-runtime';
-import { Route } from 'react-router-dom';
-import { useApp } from '@backstage/core-plugin-api';
-import { usePermission } from '../hooks/usePermission.esm.js';
-import { isResourcePermission } from '@backstage/plugin-permission-common';
-
-const PermissionedRoute = (props) => {
-  const { permission, resourceRef, errorComponent, ...otherProps } = props;
-  const permissionResult = usePermission(
-    isResourcePermission(permission) ? { permission, resourceRef } : { permission }
-  );
-  const app = useApp();
-  const { NotFoundErrorPage } = app.getComponents();
-  let shownElement = errorComponent === void 0 ? /* @__PURE__ */ jsx(NotFoundErrorPage, {}) : errorComponent;
-  if (permissionResult.loading) {
-    shownElement = null;
-  } else if (permissionResult.allowed) {
-    shownElement = props.element;
-  }
-  return /* @__PURE__ */ jsx(Route, { ...otherProps, element: shownElement });
-};
-
-export { PermissionedRoute };
-//# sourceMappingURL=PermissionedRoute.esm.js.map

package/dist/components/PermissionedRoute.esm.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"PermissionedRoute.esm.js","sources":["../../src/components/PermissionedRoute.tsx"],"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 { ReactElement, ReactNode } from 'react';\nimport { Route } from 'react-router-dom';\nimport { useApp } from '@backstage/core-plugin-api';\nimport { usePermission } from '../hooks';\nimport {\n  isResourcePermission,\n  Permission,\n  ResourcePermission,\n} from '@backstage/plugin-permission-common';\n\n/**\n * Returns a React Router Route which only renders the element when authorized. If unauthorized, the Route will render a\n * NotFoundErrorPage (see {@link @backstage/core-app-api#AppComponents}).\n *\n * @public\n * @deprecated This component no longer works with the most recent version of `@backstage/core-app-api` and react-router v6, use {@link RequirePermission} instead.\n */\nexport const PermissionedRoute = (\n  props: {\n    caseSensitive?: boolean;\n    children?: ReactNode;\n    element?: ReactElement | null;\n    path?: string;\n    errorComponent?: ReactElement | null;\n  } & (\n    | {\n        permission: Exclude<Permission, ResourcePermission>;\n        resourceRef?: never;\n      }\n    | {\n        permission: ResourcePermission;\n        resourceRef: string | undefined;\n      }\n  ),\n) => {\n  const { permission, resourceRef, errorComponent, ...otherProps } = props;\n\n  const permissionResult = usePermission(\n    isResourcePermission(permission)\n      ? { permission, resourceRef }\n      : { permission },\n  );\n  const app = useApp();\n  const { NotFoundErrorPage } = app.getComponents();\n\n  let shownElement: ReactElement | null | undefined =\n    errorComponent === undefined ? <NotFoundErrorPage /> : errorComponent;\n\n  if (permissionResult.loading) {\n    shownElement = null;\n  } else if (permissionResult.allowed) {\n    shownElement = props.element;\n  }\n\n  return <Route {...otherProps} element={shownElement} />;\n};\n"],"names":[],"mappings":";;;;;;AAiCO,MAAM,iBAAA,GAAoB,CAC/B,KAAA,KAgBG;AACH,EAAA,MAAM,EAAE,UAAA,EAAY,WAAA,EAAa,cAAA,EAAgB,GAAG,YAAW,GAAI,KAAA;AAEnE,EAAA,MAAM,gBAAA,GAAmB,aAAA;AAAA,IACvB,oBAAA,CAAqB,UAAU,CAAA,GAC3B,EAAE,YAAY,WAAA,EAAY,GAC1B,EAAE,UAAA;AAAW,GACnB;AACA,EAAA,MAAM,MAAM,MAAA,EAAO;AACnB,EAAA,MAAM,EAAE,iBAAA,EAAkB,GAAI,GAAA,CAAI,aAAA,EAAc;AAEhD,EAAA,IAAI,YAAA,GACF,cAAA,KAAmB,MAAA,mBAAY,GAAA,CAAC,qBAAkB,CAAA,GAAK,cAAA;AAEzD,EAAA,IAAI,iBAAiB,OAAA,EAAS;AAC5B,IAAA,YAAA,GAAe,IAAA;AAAA,EACjB,CAAA,MAAA,IAAW,iBAAiB,OAAA,EAAS;AACnC,IAAA,YAAA,GAAe,KAAA,CAAM,OAAA;AAAA,EACvB;AAEA,EAAA,uBAAO,GAAA,CAAC,KAAA,EAAA,EAAO,GAAG,UAAA,EAAY,SAAS,YAAA,EAAc,CAAA;AACvD;;;;"}