chore: updating api-reports and documentation for exported blueprints

Co-authored-by: Patrik Oldsberg <poldsberg@gmail.com>
Co-authored-by: Fredrik Adelöw <freben@users.noreply.github.com>
Co-authored-by: Camila Belo <camilaibs@users.noreply.github.com>
Signed-off-by: blam <ben@blam.sh>

packages/frontend-plugin-api/api-report.md

@@ -189,7 +189,7 @@ export type AnyRoutes = {
   [name in string]: RouteRef | SubRouteRef;
 };
 
-// @public (undocumented)
+// @public
 export const ApiBlueprint: ExtensionBlueprint<
   'api',
   undefined,
@@ -261,7 +261,7 @@ export interface AppNodeSpec {
   readonly source?: BackstagePlugin;
 }
 
-// @public (undocumented)
+// @public
 export const AppRootElementBlueprint: ExtensionBlueprint<
   'app-root-element',
   undefined,
@@ -276,7 +276,7 @@ export const AppRootElementBlueprint: ExtensionBlueprint<
   never
 >;
 
-// @public (undocumented)
+// @public
 export const AppRootWrapperBlueprint: ExtensionBlueprint<
   'app-root-wrapper',
   undefined,
@@ -1696,7 +1696,7 @@ export interface LegacyExtensionInput<
 
 export { microsoftAuthApiRef };
 
-// @public (undocumented)
+// @public
 export const NavItemBlueprint: ExtensionBlueprint<
   'nav-item',
   undefined,
@@ -1731,7 +1731,7 @@ export const NavItemBlueprint: ExtensionBlueprint<
   }
 >;
 
-// @public (undocumented)
+// @public
 export const NavLogoBlueprint: ExtensionBlueprint<
   'nav-logo',
   undefined,
@@ -1781,7 +1781,7 @@ export { oneloginAuthApiRef };
 
 export { OpenIdConnectApi };
 
-// @public (undocumented)
+// @public
 export const PageBlueprint: ExtensionBlueprint<
   'page',
   undefined,
@@ -1938,7 +1938,7 @@ export { SessionApi };
 
 export { SessionState };
 
-// @public (undocumented)
+// @public
 export const SignInPageBlueprint: ExtensionBlueprint<
   'sign-in-page',
   undefined,
@@ -1981,7 +1981,7 @@ export interface SubRouteRef<
   readonly T: TParams;
 }
 
-// @public (undocumented)
+// @public
 export const ThemeBlueprint: ExtensionBlueprint<
   'theme',
   'app',
@@ -1998,7 +1998,7 @@ export const ThemeBlueprint: ExtensionBlueprint<
   }
 >;
 
-// @public (undocumented)
+// @public
 export const TranslationBlueprint: ExtensionBlueprint<
   'translation',
   undefined,

packages/frontend-plugin-api/src/blueprints/ApiBlueprint.ts

@@ -13,11 +13,16 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+
 import { createExtensionBlueprint } from '../wiring';
 import { createApiExtension } from '../extensions/createApiExtension';
 import { AnyApiFactory } from '@backstage/core-plugin-api';
 
-/** @public */
+/**
+ * Creates utility API extensions.
+ *
+ * @public
+ */
 export const ApiBlueprint = createExtensionBlueprint({
   kind: 'api',
   attachTo: { id: 'app', input: 'apis' },

packages/frontend-plugin-api/src/blueprints/AppRootElementBlueprint.ts

@@ -15,7 +15,12 @@
  */
 import { coreExtensionData, createExtensionBlueprint } from '../wiring';
 
-/** @public */
+/**
+ * Creates extensions that render a React element at the app root, outside of
+ * the app layout. This is useful for example for shared popups and similar.
+ *
+ * @public
+ */
 export const AppRootElementBlueprint = createExtensionBlueprint({
   kind: 'app-root-element',
   attachTo: { id: 'app/root', input: 'elements' },

packages/frontend-plugin-api/src/blueprints/AppRootWrapperBlueprint.tsx

@@ -19,7 +19,13 @@ import { ComponentType, PropsWithChildren } from 'react';
 import { createExtensionBlueprint } from '../wiring';
 import { createAppRootWrapperExtension } from '../extensions/createAppRootWrapperExtension';
 
-/** @public */
+/**
+ * Creates a extensions that render a React wrapper at the app root, enclosing
+ * the app layout. This is useful for example for adding global React contexts
+ * and similar.
+ *
+ * @public
+ */
 export const AppRootWrapperBlueprint = createExtensionBlueprint({
   kind: 'app-root-wrapper',
   attachTo: { id: 'app/root', input: 'wrappers' },

packages/frontend-plugin-api/src/blueprints/NavItemBlueprint.ts

@@ -19,7 +19,11 @@ import { RouteRef } from '../routing';
 import { createExtensionBlueprint } from '../wiring';
 import { createNavItemExtension } from '../extensions/createNavItemExtension';
 
-/** @public */
+/**
+ * Creates extensions that make up the items of the nav bar.
+ *
+ * @public
+ */
 export const NavItemBlueprint = createExtensionBlueprint({
   kind: 'nav-item',
   attachTo: { id: 'app/nav', input: 'items' },

packages/frontend-plugin-api/src/blueprints/NavLogoBlueprint.ts

@@ -17,7 +17,11 @@
 import { createExtensionBlueprint } from '../wiring';
 import { createNavLogoExtension } from '../extensions/createNavLogoExtension';
 
-/** @public */
+/**
+ * Creates an extension that replaces the logo in the nav bar with your own.
+ *
+ * @public
+ */
 export const NavLogoBlueprint = createExtensionBlueprint({
   kind: 'nav-logo',
   attachTo: { id: 'app/nav', input: 'logos' },

packages/frontend-plugin-api/src/blueprints/PageBlueprint.tsx

@@ -18,7 +18,11 @@ import { RouteRef } from '../routing';
 import { coreExtensionData, createExtensionBlueprint } from '../wiring';
 import { ExtensionBoundary } from '../components';
 
-/** @public */
+/**
+ * Createx extensions that are routable React page components.
+ *
+ * @public
+ */
 export const PageBlueprint = createExtensionBlueprint({
   kind: 'page',
   attachTo: { id: 'app/routes', input: 'routes' },

packages/frontend-plugin-api/src/blueprints/SignInPageBlueprint.tsx

@@ -19,7 +19,11 @@ import { createSignInPageExtension } from '../extensions/createSignInPageExtensi
 import { SignInPageProps } from '@backstage/core-plugin-api';
 import { ExtensionBoundary } from '../components';
 
-/** @public */
+/**
+ * Creates an extension that replaces the sign in page.
+ *
+ * @public
+ */
 export const SignInPageBlueprint = createExtensionBlueprint({
   kind: 'sign-in-page',
   attachTo: { id: 'app/root', input: 'signInPage' },

packages/frontend-plugin-api/src/blueprints/ThemeBlueprint.ts

@@ -18,7 +18,11 @@ import { AppTheme } from '@backstage/core-plugin-api';
 import { createExtensionBlueprint } from '../wiring';
 import { createThemeExtension } from '../extensions/createThemeExtension';
 
-/** @public */
+/**
+ * Creates an extension that adds/replaces an app theme.
+ *
+ * @public
+ */
 export const ThemeBlueprint = createExtensionBlueprint({
   kind: 'theme',
   namespace: 'app',

packages/frontend-plugin-api/src/blueprints/TranslationBlueprint.ts

@@ -18,7 +18,11 @@ import { createExtensionBlueprint } from '../wiring';
 import { createTranslationExtension } from '../extensions/createTranslationExtension';
 import { TranslationMessages, TranslationResource } from '../translation';
 
-/** @public */
+/**
+ * Creates an extension that adds translations to your app.
+ *
+ * @public
+ */
 export const TranslationBlueprint = createExtensionBlueprint({
   kind: 'translation',
   attachTo: { id: 'app', input: 'translations' },