paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 23 Packages Projects Releases Wiki Activity

fixed api report and docs

Browse Source 
Signed-off-by: Manuel Scurti <manuel.scurti@agilelab.it>
This commit is contained in:
Manuel Scurti
2023-09-12 11:39:17 +02:00
parent 031101e20d
commit 214d02fa8d
4 changed files with 15 additions and 32 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.changeset/many-panthers-wink.md
+1 -1
View File
@@ -2,4 +2,4 @@
'@backstage/core-components': patch
---
Added AutoLogoutProvider which introduces an optional automatic logout mechanism on user inactivity
Added `<AutoLogout>` component which introduces an optional automatic logout mechanism on user inactivity
docs/auth/autologout.md
+10 -10
View File
@@ -27,7 +27,7 @@ To enable and configure Auto Logout, you will need to add the `<AutoLogout>` com
Here's how to add it:
```ts
import { AutoLogoutProvider } from '@backstage/core-components';
import { AutoLogout } from '@backstage/core-components';
// ... App.tsx contents
@@ -63,13 +63,13 @@ auth:
enabled: true
```
Bear in mind that, in case the same property is found both in the `<AutoLogout>` component and the `app-config` file then the properties set in the React component take precedence over configuration properties found inside your `app-config`.
You will now be able to configure the AutoLogoutProvider through your `app-config`. These are the available settings:
Bear in mind that, properties configured in `app-config` take precedence over the props passed to the `<AutoLogout/>` React component.
These are the available settings:
| Configuration Key | Component Property | Description | Allowed Values | Default Value |
| ----------------------------------------- | ------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------- | ----------------------------------------------------------------------------------------------------------------------------- |
| `auth.autologout.enabled` | `enabled` | Enable/disable the Auto Logout feature. | `true`/`false` | With `<AutoLogoutProvider>` default is enabled (`true`). With `<ConfigBasedAutoLogoutProvider>` default is disabled (`false`) |
| `auth.autologout.idleTimeoutMinutes` | `idleTimeoutMinutes` | Sets the idle time (in minutes) after which the user will be logged out. | `>= 0.5` minutes | `60` |
| `auth.autologout.promptBeforeIdleSeconds` | `promptBeforeIdleSeconds` | Determines the time (in seconds) prior to idle state when a prompt will appear. A value of 0 disables the prompt. This must be less than the value of `idleTimeoutMinutes`. | `>= 0` seconds | `10` |
| `auth.autologout.useWorkerTimers` | `useWorkerTimers` | Enables or disables the use of Node's worker thread timers instead of main thread timers. This can be beneficial if the browser is terminating timers in inactive tabs, like those used by auto logout. In case of browser incompatibility, try setting this to false. | `true`/`false` | `true` |
| `auth.autologout.logoutIfDisconnected` | `logoutIfDisconnected` | Enable/disable auto logout for disconnected users. Disconnected users are those who are logged in but do not have any active Backstage tabs open in their browsers. If enabled, such users will be automatically logged out after `idleTimeoutMinutes`. | `true`/`false` | `true` |
| Configuration Key | Component Property | Description | Allowed Values | Default Value |
| ----------------------------------------- | ------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------- | --------------------------- |
| `auth.autologout.enabled` | `enabled` | Enable/disable the Auto Logout feature. | `true`/`false` | Default is enabled (`true`) |
| `auth.autologout.idleTimeoutMinutes` | `idleTimeoutMinutes` | Sets the idle time (in minutes) after which the user will be logged out. | `>= 0.5` minutes | `60` |
| `auth.autologout.promptBeforeIdleSeconds` | `promptBeforeIdleSeconds` | Determines the time (in seconds) prior to idle state when a prompt will appear. A value of 0 disables the prompt. This must be less than the value of `idleTimeoutMinutes`. | `>= 0` seconds | `10` |
| `auth.autologout.useWorkerTimers` | `useWorkerTimers` | Enables or disables the use of Node's worker thread timers instead of main thread timers. This can be beneficial if the browser is terminating timers in inactive tabs, like those used by auto logout. In case of browser incompatibility, try setting this to false. | `true`/`false` | `true` |
| `auth.autologout.logoutIfDisconnected` | `logoutIfDisconnected` | Enable/disable auto logout for disconnected users. Disconnected users are those who are logged in but do not have any active Backstage tabs open in their browsers. If enabled, such users will be automatically logged out after `idleTimeoutMinutes`. | `true`/`false` | `true` |
packages/core-components/api-report.md
+2 -19
View File
@@ -69,23 +69,14 @@ export type AlertDisplayProps = {
};
// @public
export const AutoLogoutProvider: ({
children,
enabled,
idleTimeoutMinutes,
promptBeforeIdleSeconds,
useWorkerTimers,
events,
logoutIfDisconnected,
}: PropsWithChildren<AutoLogoutProviderProps>) => JSX.Element;
export const AutoLogout: (props: AutoLogoutProps) => JSX.Element | null;
// @public (undocumented)
export type AutoLogoutProviderProps = {
export type AutoLogoutProps = {
enabled?: boolean;
idleTimeoutMinutes?: number;
promptBeforeIdleSeconds?: number;
useWorkerTimers?: boolean;
events?: AutoLogoutTrackableEvent[];
logoutIfDisconnected?: boolean;
};
@@ -190,14 +181,6 @@ export interface CodeSnippetProps {
text: string;
}
// @public
export const ConfigBasedAutoLogoutProvider: ({
children,
}: PropsWithChildren<ConfigBasedAutoLogoutProviderProps>) => JSX.Element;
// @public (undocumented)
export type ConfigBasedAutoLogoutProviderProps = {};
// Warning: (ae-forgotten-export) The symbol "Props_13" needs to be exported by the entry point index.d.ts
//
// @public
packages/core-components/src/components/AutoLogout/AutoLogout.tsx
+2 -2
View File
@@ -229,7 +229,7 @@ const parseConfig = (
*
* @public
*/
export const AutoLogout = (props: AutoLogoutProps): JSX.Element => {
export const AutoLogout = (props: AutoLogoutProps): JSX.Element | null => {
const identityApi = useApi(identityApiRef);
const configApi = useApi(configApiRef);
const [isLogged, setIsLogged] = useState(false);
@@ -293,7 +293,7 @@ export const AutoLogout = (props: AutoLogoutProps): JSX.Element => {
});
if (!enabled || !isLogged) {
return <></>;
return null;
}
return (