From 90bd5ab9e7fa086b14a6f5b736fdaea0c5275e55 Mon Sep 17 00:00:00 2001 From: blam Date: Thu, 17 Jun 2021 19:19:42 +0200 Subject: [PATCH] chore: updating the api-docs as some PR's were merged after the api-docs PR merge that were not rebuilt Signed-off-by: blam --- plugins/auth-backend/api-report.md | 21 +++++++++++++++++++++ plugins/explore/api-report.md | 29 ++++++++++++++++++++++++++++- plugins/techdocs/api-report.md | 7 +++++-- 3 files changed, 54 insertions(+), 3 deletions(-) diff --git a/plugins/auth-backend/api-report.md b/plugins/auth-backend/api-report.md index dea5500d53..4788b9c102 100644 --- a/plugins/auth-backend/api-report.md +++ b/plugins/auth-backend/api-report.md @@ -6,12 +6,14 @@ import { CatalogApi } from '@backstage/catalog-client'; import { Config } from '@backstage/config'; +import { Entity } from '@backstage/catalog-model'; import express from 'express'; import { JSONWebKey } from 'jose'; import { Logger } from 'winston'; import { PluginDatabaseManager } from '@backstage/backend-common'; import { PluginEndpointDiscovery } from '@backstage/backend-common'; import { Profile } from 'passport'; +import { UserEntity } from '@backstage/catalog-model'; // @public (undocumented) export type AuthProviderFactory = (options: AuthProviderFactoryOptions) => AuthProviderRouteHandlers; @@ -47,8 +49,13 @@ export type AuthResponse = { export type BackstageIdentity = { id: string; idToken?: string; + token?: string; + entity?: Entity; }; +// @public (undocumented) +export const createGoogleProvider: (options?: GoogleProviderOptions | undefined) => AuthProviderFactory; + // @public (undocumented) export function createRouter({ logger, config, discovery, database, providerFactories, }: RouterOptions): Promise; @@ -63,6 +70,20 @@ export const encodeState: (state: OAuthState) => string; // @public (undocumented) export const ensuresXRequestedWith: (req: express.Request) => boolean; +// @public (undocumented) +export const googleDefaultSignInResolver: SignInResolver; + +// @public (undocumented) +export const googleEmailSignInResolver: SignInResolver; + +// @public (undocumented) +export type GoogleProviderOptions = { + authHandler?: AuthHandler; + signIn?: { + resolver?: SignInResolver; + }; +}; + // @public export class IdentityClient { constructor(options: { diff --git a/plugins/explore/api-report.md b/plugins/explore/api-report.md index 590af53de8..4116247061 100644 --- a/plugins/explore/api-report.md +++ b/plugins/explore/api-report.md @@ -5,8 +5,10 @@ ```ts import { BackstagePlugin } from '@backstage/core'; +import { default } from 'react'; import { ExternalRouteRef } from '@backstage/core'; import { RouteRef } from '@backstage/core'; +import { TabProps } from '@material-ui/core'; // @public (undocumented) export const catalogEntityRouteRef: ExternalRouteRef<{ @@ -15,11 +17,22 @@ export const catalogEntityRouteRef: ExternalRouteRef<{ namespace: string; }, false>; +// @public (undocumented) +export const DomainExplorerContent: ({ title, }: { + title?: string | undefined; +}) => JSX.Element; + +// @public +export const ExploreLayout: { + ({ title, subtitle, children, }: ExploreLayoutProps): JSX.Element; + Route: (props: SubRoute) => null; +}; + // @public (undocumented) export const ExplorePage: () => JSX.Element; // @public (undocumented) -export const explorePlugin: BackstagePlugin<{ +const explorePlugin: BackstagePlugin<{ explore: RouteRef; }, { catalogEntity: ExternalRouteRef<{ @@ -29,9 +42,23 @@ export const explorePlugin: BackstagePlugin<{ }, false>; }>; +export { explorePlugin } + +export { explorePlugin as plugin } + // @public (undocumented) export const exploreRouteRef: RouteRef; +// @public (undocumented) +export const GroupsExplorerContent: ({ title, }: { + title?: string | undefined; +}) => JSX.Element; + +// @public (undocumented) +export const ToolExplorerContent: ({ title }: { + title?: string | undefined; +}) => JSX.Element; + // (No @packageDocumentation comment for this package) diff --git a/plugins/techdocs/api-report.md b/plugins/techdocs/api-report.md index 801eabf368..69a62b4362 100644 --- a/plugins/techdocs/api-report.md +++ b/plugins/techdocs/api-report.md @@ -43,6 +43,9 @@ export const Reader: ({ entityId, onReady }: Props_2) => JSX.Element; // @public (undocumented) export const Router: () => JSX.Element; +// @public (undocumented) +export type SyncResult = 'cached' | 'updated' | 'timeout'; + // @public (undocumented) export interface TechDocsApi { // (undocumented) @@ -109,7 +112,7 @@ export interface TechDocsStorageApi { // (undocumented) getStorageUrl(): Promise; // (undocumented) - syncEntityDocs(entityId: EntityName): Promise; + syncEntityDocs(entityId: EntityName): Promise; } // @public (undocumented) @@ -137,7 +140,7 @@ export class TechDocsStorageClient implements TechDocsStorageApi { getStorageUrl(): Promise; // (undocumented) identityApi: IdentityApi; - syncEntityDocs(entityId: EntityName): Promise; + syncEntityDocs(entityId: EntityName): Promise; }