it just keeps 🧹 -ing

Signed-off-by: Fredrik Adelöw <freben@gmail.com>
2022-08-18 16:58:54 +02:00
parent d461eca145
commit ef9ab322de
55 changed files with 193 additions and 302 deletions
@@ -17,13 +17,9 @@ import { TableColumn } from '@backstage/core-components';
 import { TableProps } from '@backstage/core-components';
 import { UserListFilterKind } from '@backstage/plugin-catalog-react';

-// Warning: (ae-missing-release-tag) "ApiDefinitionCard" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
 // @public (undocumented)
 export const ApiDefinitionCard: () => JSX.Element;

-// Warning: (ae-missing-release-tag) "ApiDefinitionWidget" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
 // @public (undocumented)
 export type ApiDefinitionWidget = {
  type: string;
@@ -32,14 +28,17 @@ export type ApiDefinitionWidget = {
  rawLanguage?: string;
 };

-// Warning: (ae-forgotten-export) The symbol "ApiDocsConfig" needs to be exported by the entry point index.d.ts
-// Warning: (ae-missing-release-tag) "apiDocsConfigRef" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
+// @public (undocumented)
+export interface ApiDocsConfig {
+  // (undocumented)
+  getApiDefinitionWidget: (
+    apiEntity: ApiEntity,
+  ) => ApiDefinitionWidget | undefined;
+}
+
 // @public (undocumented)
 export const apiDocsConfigRef: ApiRef<ApiDocsConfig>;

-// Warning: (ae-missing-release-tag) "apiDocsPlugin" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
 // @public (undocumented)
 const apiDocsPlugin: BackstagePlugin<
  {
@@ -66,15 +65,11 @@ export const ApiExplorerPage: (
 // @public (undocumented)
 export const ApiTypeTitle: (props: { apiEntity: ApiEntity }) => JSX.Element;

-// Warning: (ae-missing-release-tag) "AsyncApiDefinitionWidget" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
 // @public (undocumented)
 export const AsyncApiDefinitionWidget: (
  props: AsyncApiDefinitionWidgetProps,
 ) => JSX.Element;

-// Warning: (ae-missing-release-tag) "AsyncApiDefinitionWidgetProps" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
 // @public (undocumented)
 export type AsyncApiDefinitionWidgetProps = {
  definition: string;
@@ -91,11 +86,9 @@ export const ConsumingComponentsCard: (props: {
 }) => JSX.Element;

 // @public
-export const DefaultApiExplorerPage: ({
-  initiallySelectedFilter,
-  columns,
-  actions,
-}: DefaultApiExplorerPageProps) => JSX.Element;
+export const DefaultApiExplorerPage: (
+  props: DefaultApiExplorerPageProps,
+) => JSX.Element;

 // @public
 export type DefaultApiExplorerPageProps = {
@@ -104,8 +97,6 @@ export type DefaultApiExplorerPageProps = {
  actions?: TableProps<CatalogTableRow>['actions'];
 };

-// Warning: (ae-missing-release-tag) "defaultDefinitionWidgets" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
 // @public (undocumented)
 export function defaultDefinitionWidgets(): ApiDefinitionWidget[];

@@ -137,15 +128,11 @@ export const EntityProvidingComponentsCard: (props: {
  variant?: InfoCardVariants | undefined;
 }) => JSX.Element;

-// Warning: (ae-missing-release-tag) "GraphQlDefinitionWidget" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
 // @public (undocumented)
 export const GraphQlDefinitionWidget: (
  props: GraphQlDefinitionWidgetProps,
 ) => JSX.Element;

-// Warning: (ae-missing-release-tag) "GraphQlDefinitionWidgetProps" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
 // @public (undocumented)
 export type GraphQlDefinitionWidgetProps = {
  definition: string;
@@ -156,29 +143,21 @@ export const HasApisCard: (props: {
  variant?: InfoCardVariants;
 }) => JSX.Element;

-// Warning: (ae-missing-release-tag) "OpenApiDefinitionWidget" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
 // @public (undocumented)
 export const OpenApiDefinitionWidget: (
  props: OpenApiDefinitionWidgetProps,
 ) => JSX.Element;

-// Warning: (ae-missing-release-tag) "OpenApiDefinitionWidgetProps" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
 // @public (undocumented)
 export type OpenApiDefinitionWidgetProps = {
  definition: string;
 };

-// Warning: (ae-missing-release-tag) "PlainApiDefinitionWidget" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
 // @public (undocumented)
 export const PlainApiDefinitionWidget: (
  props: PlainApiDefinitionWidgetProps,
 ) => JSX.Element;

-// Warning: (ae-missing-release-tag) "PlainApiDefinitionWidgetProps" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
 // @public (undocumented)
 export type PlainApiDefinitionWidgetProps = {
  definition: any;
@@ -190,8 +169,6 @@ export const ProvidedApisCard: (props: {
  variant?: InfoCardVariants;
 }) => JSX.Element;

-// Warning: (ae-missing-release-tag) "ProvidingComponentsCard" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
 // @public (undocumented)
 export const ProvidingComponentsCard: (props: {
  variant?: InfoCardVariants;
@@ -24,6 +24,7 @@ import { PlainApiDefinitionWidget } from '../PlainApiDefinitionWidget';
 import { CardTab, TabbedCard } from '@backstage/core-components';
 import { useApi } from '@backstage/core-plugin-api';

+/** @public */
 export const ApiDefinitionCard = () => {
  const { entity } = useEntity<ApiEntity>();
  const config = useApi(apiDocsConfigRef);
@@ -19,6 +19,7 @@ import { GraphQlDefinitionWidget } from '../GraphQlDefinitionWidget';
 import { OpenApiDefinitionWidget } from '../OpenApiDefinitionWidget';
 import { GrpcApiDefinitionWidget } from '../GrpcApiDefinitionWidget';

+/** @public */
 export type ApiDefinitionWidget = {
  type: string;
  title: string;
@@ -26,6 +27,7 @@ export type ApiDefinitionWidget = {
  rawLanguage?: string;
 };

+/** @public */
 export function defaultDefinitionWidgets(): ApiDefinitionWidget[] {
  return [
    {
@@ -64,11 +64,9 @@ export type DefaultApiExplorerPageProps = {
 * DefaultApiExplorerPage
 * @public
 */
-export const DefaultApiExplorerPage = ({
-  initiallySelectedFilter = 'all',
-  columns,
-  actions,
-}: DefaultApiExplorerPageProps) => {
+export const DefaultApiExplorerPage = (props: DefaultApiExplorerPageProps) => {
+  const { initiallySelectedFilter = 'all', columns, actions } = props;
+
  const configApi = useApi(configApiRef);
  const generatedSubtitle = `${
    configApi.getOptionalString('organization.name') ?? 'Backstage'
@@ -25,10 +25,12 @@ const LazyAsyncApiDefinition = React.lazy(() =>
  })),
 );

+/** @public */
 export type AsyncApiDefinitionWidgetProps = {
  definition: string;
 };

+/** @public */
 export const AsyncApiDefinitionWidget = (
  props: AsyncApiDefinitionWidgetProps,
 ) => {
@@ -34,6 +34,7 @@ import {
  WarningPanel,
 } from '@backstage/core-components';

+/** @public */
 export const ProvidingComponentsCard = (props: {
  variant?: InfoCardVariants;
 }) => {
@@ -25,10 +25,12 @@ const LazyGraphQlDefinition = React.lazy(() =>
  })),
 );

+/** @public */
 export type GraphQlDefinitionWidgetProps = {
  definition: string;
 };

+/** @public */
 export const GraphQlDefinitionWidget = (
  props: GraphQlDefinitionWidgetProps,
 ) => {
@@ -19,10 +19,12 @@ import { CodeSnippet } from '@backstage/core-components';
 import { useTheme } from '@material-ui/core/styles';
 import { BackstageTheme } from '@backstage/theme';

+/** @public */
 export type GrpcApiDefinitionWidgetProps = {
  definition: string;
 };

+/** @public */
 export const GrpcApiDefinitionWidget = (
  props: GrpcApiDefinitionWidgetProps,
 ) => {
@@ -25,10 +25,12 @@ const LazyOpenApiDefinition = React.lazy(() =>
  })),
 );

+/** @public */
 export type OpenApiDefinitionWidgetProps = {
  definition: string;
 };

+/** @public */
 export const OpenApiDefinitionWidget = (
  props: OpenApiDefinitionWidgetProps,
 ) => {
@@ -17,11 +17,13 @@
 import React from 'react';
 import { CodeSnippet } from '@backstage/core-components';

+/** @public */
 export type PlainApiDefinitionWidgetProps = {
  definition: any;
  language: string;
 };

+/** @public */
 export const PlainApiDefinitionWidget = (
  props: PlainApiDefinitionWidgetProps,
 ) => {
@@ -18,10 +18,12 @@ import { ApiEntity } from '@backstage/catalog-model';
 import { ApiDefinitionWidget } from './components/ApiDefinitionCard/ApiDefinitionWidget';
 import { createApiRef } from '@backstage/core-plugin-api';

+/** @public */
 export const apiDocsConfigRef = createApiRef<ApiDocsConfig>({
  id: 'plugin.api-docs.config',
 });

+/** @public */
 export interface ApiDocsConfig {
  getApiDefinitionWidget: (
    apiEntity: ApiEntity,
@@ -21,6 +21,7 @@
 */

 export * from './components';
+export type { ApiDocsConfig } from './config';
 export { apiDocsConfigRef } from './config';
 export {
  apiDocsPlugin,
@@ -25,6 +25,7 @@ import {
  createRoutableExtension,
 } from '@backstage/core-plugin-api';

+/** @public */
 export const apiDocsPlugin = createPlugin({
  id: 'api-docs',
  routes: {