From 926a65b611240bd0af5ef19f9b421bedfc5b6480 Mon Sep 17 00:00:00 2001 From: Manuel Scurti Date: Sun, 11 Jun 2023 01:29:57 +0200 Subject: [PATCH] fixed api-report Signed-off-by: Manuel Scurti --- packages/core-components/api-report.md | 18 ------------------ .../AutoLogoutProvider/AutoLogoutProvider.tsx | 6 +++--- .../ConfigBasedAutoLogoutProvider.tsx | 1 + .../src/components/AutoLogoutProvider/index.ts | 1 + 4 files changed, 5 insertions(+), 21 deletions(-) diff --git a/packages/core-components/api-report.md b/packages/core-components/api-report.md index daaa640c3a..fa4d440031 100644 --- a/packages/core-components/api-report.md +++ b/packages/core-components/api-report.md @@ -68,14 +68,10 @@ export type AlertDisplayProps = { transientTimeoutMs?: number; }; -// Warning: (ae-missing-release-tag) "AUTOLOGOUT_LAST_SEEN_ONLINE_STORAGE_KEY" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) -// // @public (undocumented) export const AUTOLOGOUT_LAST_SEEN_ONLINE_STORAGE_KEY = '@backstage/autologout:lastSeenOnline'; -// Warning: (ae-missing-release-tag) "AutoLogoutProvider" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) -// // @public export const AutoLogoutProvider: ({ children, @@ -87,8 +83,6 @@ export const AutoLogoutProvider: ({ logoutIfDisconnected, }: PropsWithChildren) => JSX.Element; -// Warning: (ae-missing-release-tag) "AutoLogoutProviderProps" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) -// // @public (undocumented) export type AutoLogoutProviderProps = { enabled?: boolean; @@ -99,8 +93,6 @@ export type AutoLogoutProviderProps = { logoutIfDisconnected?: boolean; }; -// Warning: (ae-missing-release-tag) "AutoLogoutTrackableEvent" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) -// // @public (undocumented) export type AutoLogoutTrackableEvent = EventsType; @@ -202,15 +194,11 @@ export interface CodeSnippetProps { text: string; } -// Warning: (ae-missing-release-tag) "ConfigBasedAutoLogoutProvider" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) -// // @public export const ConfigBasedAutoLogoutProvider: ({ children, }: PropsWithChildren) => JSX.Element; -// Warning: (ae-missing-release-tag) "ConfigBasedAutoLogoutProviderProps" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) -// // @public (undocumented) export type ConfigBasedAutoLogoutProviderProps = {}; @@ -1550,12 +1538,6 @@ export type WarningPanelClassKey = // Warnings were encountered during analysis: // -// src/components/AutoLogoutProvider/AutoLogoutProvider.d.ts:7:8 - (tsdoc-undefined-tag) The TSDoc tag "@default" is not defined in this configuration -// src/components/AutoLogoutProvider/AutoLogoutProvider.d.ts:13:8 - (tsdoc-undefined-tag) The TSDoc tag "@default" is not defined in this configuration -// src/components/AutoLogoutProvider/AutoLogoutProvider.d.ts:20:8 - (tsdoc-undefined-tag) The TSDoc tag "@default" is not defined in this configuration -// src/components/AutoLogoutProvider/AutoLogoutProvider.d.ts:27:8 - (tsdoc-undefined-tag) The TSDoc tag "@default" is not defined in this configuration -// src/components/AutoLogoutProvider/AutoLogoutProvider.d.ts:32:8 - (tsdoc-undefined-tag) The TSDoc tag "@default" is not defined in this configuration -// src/components/AutoLogoutProvider/AutoLogoutProvider.d.ts:39:8 - (tsdoc-undefined-tag) The TSDoc tag "@default" is not defined in this configuration // src/components/DependencyGraph/types.d.ts:22:9 - (ae-unresolved-link) The @link reference could not be resolved: The package "@backstage/core-components" does not have an export "DependencyNode" // src/components/DependencyGraph/types.d.ts:26:9 - (ae-unresolved-link) The @link reference could not be resolved: The package "@backstage/core-components" does not have an export "DependencyNode" // src/components/TabbedLayout/RoutedTabs.d.ts:9:5 - (ae-forgotten-export) The symbol "SubRoute_2" needs to be exported by the entry point index.d.ts diff --git a/packages/core-components/src/components/AutoLogoutProvider/AutoLogoutProvider.tsx b/packages/core-components/src/components/AutoLogoutProvider/AutoLogoutProvider.tsx index 073dbb9283..44c79cc4d7 100644 --- a/packages/core-components/src/components/AutoLogoutProvider/AutoLogoutProvider.tsx +++ b/packages/core-components/src/components/AutoLogoutProvider/AutoLogoutProvider.tsx @@ -30,11 +30,10 @@ import { import { StillTherePrompt } from './StillTherePrompt'; import { DefaultTimestampStore, TimestampStore } from './timestampStore'; +/** @public */ export type AutoLogoutTrackableEvent = EventsType; -/** - * @public - */ +/** @public */ export type AutoLogoutProviderProps = { /** * Enable/disable the AutoLogoutMechanism. @@ -79,6 +78,7 @@ export type AutoLogoutProviderProps = { * The Autologout feature enables platform engineers to add a mechanism to log out users after a configurable amount of time of inactivity. * When enabled, the mechanism will track user actions (mouse movement, mouse click, key pressing, taps, etc.) in order to determine if they are active or not. * After a certain amount of inactivity/idle time, the user session is invalidated and they are required to sign in again. + * * @public */ export const AutoLogoutProvider = ({ diff --git a/packages/core-components/src/components/AutoLogoutProvider/ConfigBasedAutoLogoutProvider.tsx b/packages/core-components/src/components/AutoLogoutProvider/ConfigBasedAutoLogoutProvider.tsx index af40efcf1c..1eceedaa3b 100644 --- a/packages/core-components/src/components/AutoLogoutProvider/ConfigBasedAutoLogoutProvider.tsx +++ b/packages/core-components/src/components/AutoLogoutProvider/ConfigBasedAutoLogoutProvider.tsx @@ -29,6 +29,7 @@ export type ConfigBasedAutoLogoutProviderProps = {}; /** * A config based flavour of the AutoLogoutProvider. * It allows to configure Autologout settings through `app-config` + * * @public */ export const ConfigBasedAutoLogoutProvider = ({ diff --git a/packages/core-components/src/components/AutoLogoutProvider/index.ts b/packages/core-components/src/components/AutoLogoutProvider/index.ts index e80ed7aae0..158c6a0ea4 100644 --- a/packages/core-components/src/components/AutoLogoutProvider/index.ts +++ b/packages/core-components/src/components/AutoLogoutProvider/index.ts @@ -18,5 +18,6 @@ import { LAST_SEEN_ONLINE_STORAGE_KEY } from './disconnectedUsers'; export * from './AutoLogoutProvider'; export * from './ConfigBasedAutoLogoutProvider'; +/** @public */ export const AUTOLOGOUT_LAST_SEEN_ONLINE_STORAGE_KEY = LAST_SEEN_ONLINE_STORAGE_KEY;