chore: api-reports

Signed-off-by: blam <ben@blam.sh>
2024-08-15 16:32:09 +02:00
parent 4a8b94ee93
commit af7be32e90
14 changed files with 1195 additions and 63 deletions
@@ -3,10 +3,17 @@
 > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).

 ```ts
-import { AnyExtensionDataRef } from '@backstage/frontend-plugin-api';
+import { AnyApiFactory } from '@backstage/core-plugin-api';
+import { AnyRouteRefParams } from '@backstage/frontend-plugin-api';
 import { BackstagePlugin } from '@backstage/frontend-plugin-api';
+import { ConfigurableExtensionDataRef } from '@backstage/frontend-plugin-api';
 import { ExtensionDefinition } from '@backstage/frontend-plugin-api';
+import { ExtensionInput } from '@backstage/frontend-plugin-api';
+import { IconComponent } from '@backstage/core-plugin-api';
+import { default as React_2 } from 'react';
 import { RouteRef } from '@backstage/frontend-plugin-api';
+import { SearchResultItemExtensionComponent } from '@backstage/plugin-search-react/alpha';
+import { SearchResultItemExtensionPredicate } from '@backstage/plugin-search-react/alpha';

 // @alpha (undocumented)
 const _default: BackstagePlugin<
@@ -14,7 +21,78 @@ const _default: BackstagePlugin<
    root: RouteRef<undefined>;
  },
  {},
-  {}
+  {
+    'api:search': ExtensionDefinition<
+      {},
+      {},
+      ConfigurableExtensionDataRef<AnyApiFactory, 'core.api.factory', {}>,
+      {},
+      'api',
+      undefined,
+      undefined
+    >;
+    'nav-item:search': ExtensionDefinition<
+      {},
+      {},
+      ConfigurableExtensionDataRef<
+        {
+          title: string;
+          icon: IconComponent;
+          routeRef: RouteRef<undefined>;
+        },
+        'core.nav-item.target',
+        {}
+      >,
+      {},
+      'nav-item',
+      undefined,
+      undefined
+    >;
+    'page:search': ExtensionDefinition<
+      {
+        noTrack: boolean;
+      } & {
+        path: string | undefined;
+      },
+      {
+        noTrack?: boolean | undefined;
+      } & {
+        path?: string | undefined;
+      },
+      | ConfigurableExtensionDataRef<
+          React_2.JSX.Element,
+          'core.reactElement',
+          {}
+        >
+      | ConfigurableExtensionDataRef<string, 'core.routing.path', {}>
+      | ConfigurableExtensionDataRef<
+          RouteRef<AnyRouteRefParams>,
+          'core.routing.ref',
+          {
+            optional: true;
+          }
+        >,
+      {
+        items: ExtensionInput<
+          ConfigurableExtensionDataRef<
+            {
+              predicate?: SearchResultItemExtensionPredicate | undefined;
+              component: SearchResultItemExtensionComponent;
+            },
+            'search.search-result-list-item.item',
+            {}
+          >,
+          {
+            singleton: false;
+            optional: false;
+          }
+        >;
+      },
+      'page',
+      undefined,
+      undefined
+    >;
+  }
 >;
 export default _default;

@@ -22,43 +100,72 @@ export default _default;
 export const searchApi: ExtensionDefinition<
  {},
  {},
-  never,
-  never,
-  string | undefined,
-  string | undefined,
-  string | undefined
+  ConfigurableExtensionDataRef<AnyApiFactory, 'core.api.factory', {}>,
+  {},
+  'api',
+  undefined,
+  undefined
 >;

 // @alpha (undocumented)
 export const searchNavItem: ExtensionDefinition<
-  {
-    title: string;
-  },
-  {
-    title?: string | undefined;
-  },
-  never,
-  never,
-  string | undefined,
-  string | undefined,
-  string | undefined
+  {},
+  {},
+  ConfigurableExtensionDataRef<
+    {
+      title: string;
+      icon: IconComponent;
+      routeRef: RouteRef<undefined>;
+    },
+    'core.nav-item.target',
+    {}
+  >,
+  {},
+  'nav-item',
+  undefined,
+  undefined
 >;

 // @alpha (undocumented)
 export const searchPage: ExtensionDefinition<
  {
-    path: string;
    noTrack: boolean;
+  } & {
+    path: string | undefined;
  },
  {
-    path: string;
-    noTrack: boolean;
+    noTrack?: boolean | undefined;
+  } & {
+    path?: string | undefined;
  },
-  AnyExtensionDataRef,
-  {},
-  string | undefined,
-  string | undefined,
-  string | undefined
+  | ConfigurableExtensionDataRef<React_2.JSX.Element, 'core.reactElement', {}>
+  | ConfigurableExtensionDataRef<string, 'core.routing.path', {}>
+  | ConfigurableExtensionDataRef<
+      RouteRef<AnyRouteRefParams>,
+      'core.routing.ref',
+      {
+        optional: true;
+      }
+    >,
+  {
+    items: ExtensionInput<
+      ConfigurableExtensionDataRef<
+        {
+          predicate?: SearchResultItemExtensionPredicate | undefined;
+          component: SearchResultItemExtensionComponent;
+        },
+        'search.search-result-list-item.item',
+        {}
+      >,
+      {
+        singleton: false;
+        optional: false;
+      }
+    >;
+  },
+  'page',
+  undefined,
+  undefined
 >;

 // (No @packageDocumentation comment for this package)