From 77a9d2f6cf9fc4c548cc994468bb7e5749b1c542 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fredrik=20Adel=C3=B6w?= Date: Fri, 19 Aug 2022 11:56:16 +0200 Subject: [PATCH] shortcuts MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Fredrik Adelöw --- plugins/shortcuts/api-report.md | 12 ------------ plugins/shortcuts/src/api/LocalStoredShortcuts.ts | 2 ++ plugins/shortcuts/src/api/ShortcutApi.ts | 2 ++ plugins/shortcuts/src/plugin.ts | 2 ++ plugins/shortcuts/src/types.ts | 1 + scripts/api-extractor.ts | 1 - 6 files changed, 7 insertions(+), 13 deletions(-) diff --git a/plugins/shortcuts/api-report.md b/plugins/shortcuts/api-report.md index 7f81df835d..1aa1dea003 100644 --- a/plugins/shortcuts/api-report.md +++ b/plugins/shortcuts/api-report.md @@ -12,8 +12,6 @@ import { Observable } from '@backstage/types'; import { default as Observable_2 } from 'zen-observable'; import { StorageApi } from '@backstage/core-plugin-api'; -// Warning: (ae-missing-release-tag) "LocalStoredShortcuts" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) -// // @public export class LocalStoredShortcuts implements ShortcutApi { constructor(storageApi: StorageApi); @@ -31,8 +29,6 @@ export class LocalStoredShortcuts implements ShortcutApi { update(shortcut: Shortcut): Promise; } -// Warning: (ae-missing-release-tag) "Shortcut" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) -// // @public (undocumented) export type Shortcut = { id: string; @@ -40,8 +36,6 @@ export type Shortcut = { title: string; }; -// Warning: (ae-missing-release-tag) "ShortcutApi" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) -// // @public (undocumented) export interface ShortcutApi { add(shortcut: Omit): Promise; @@ -52,18 +46,12 @@ export interface ShortcutApi { update(shortcut: Shortcut): Promise; } -// Warning: (ae-missing-release-tag) "Shortcuts" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) -// // @public (undocumented) export const Shortcuts: (props: ShortcutsProps) => JSX.Element; -// Warning: (ae-missing-release-tag) "shortcutsApiRef" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) -// // @public (undocumented) export const shortcutsApiRef: ApiRef; -// Warning: (ae-missing-release-tag) "shortcutsPlugin" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) -// // @public (undocumented) export const shortcutsPlugin: BackstagePlugin<{}, {}, {}>; diff --git a/plugins/shortcuts/src/api/LocalStoredShortcuts.ts b/plugins/shortcuts/src/api/LocalStoredShortcuts.ts index 82f4b7dd1a..9f3561be67 100644 --- a/plugins/shortcuts/src/api/LocalStoredShortcuts.ts +++ b/plugins/shortcuts/src/api/LocalStoredShortcuts.ts @@ -23,6 +23,8 @@ import Observable from 'zen-observable'; /** * Implementation of the ShortcutApi that uses the StorageApi to store shortcuts. + * + * @public */ export class LocalStoredShortcuts implements ShortcutApi { constructor(private readonly storageApi: StorageApi) {} diff --git a/plugins/shortcuts/src/api/ShortcutApi.ts b/plugins/shortcuts/src/api/ShortcutApi.ts index 1f93baa66c..96c5de1697 100644 --- a/plugins/shortcuts/src/api/ShortcutApi.ts +++ b/plugins/shortcuts/src/api/ShortcutApi.ts @@ -18,10 +18,12 @@ import { Shortcut } from '../types'; import { createApiRef } from '@backstage/core-plugin-api'; import { Observable } from '@backstage/types'; +/** @public */ export const shortcutsApiRef = createApiRef({ id: 'plugin.shortcuts.api', }); +/** @public */ export interface ShortcutApi { /** * Returns an Observable that will subscribe to changes. diff --git a/plugins/shortcuts/src/plugin.ts b/plugins/shortcuts/src/plugin.ts index d20cfa8401..2b0d0559e0 100644 --- a/plugins/shortcuts/src/plugin.ts +++ b/plugins/shortcuts/src/plugin.ts @@ -22,6 +22,7 @@ import { storageApiRef, } from '@backstage/core-plugin-api'; +/** @public */ export const shortcutsPlugin = createPlugin({ id: 'shortcuts', apis: [ @@ -34,6 +35,7 @@ export const shortcutsPlugin = createPlugin({ ], }); +/** @public */ export const Shortcuts = shortcutsPlugin.provide( createComponentExtension({ name: 'Shortcuts', diff --git a/plugins/shortcuts/src/types.ts b/plugins/shortcuts/src/types.ts index 2421f0e369..75ef561f74 100644 --- a/plugins/shortcuts/src/types.ts +++ b/plugins/shortcuts/src/types.ts @@ -14,6 +14,7 @@ * limitations under the License. */ +/** @public */ export type Shortcut = { id: string; url: string; diff --git a/scripts/api-extractor.ts b/scripts/api-extractor.ts index 1fd8131b4d..13c252a991 100644 --- a/scripts/api-extractor.ts +++ b/scripts/api-extractor.ts @@ -232,7 +232,6 @@ const ALLOW_WARNINGS = [ 'plugins/newrelic-dashboard', 'plugins/pagerduty', 'plugins/search-backend-module-pg', - 'plugins/shortcuts', 'plugins/splunk-on-call', 'plugins/tech-radar', 'plugins/user-settings',