Merge pull request #6433 from backstage/rugvip/report-all-the-things

root: bump api-extractor & friends + recreate API reports along with previously unsupported packages
2021-07-12 20:28:09 +02:00
parent 11251fedfc a07354e109
commit 1118f33e4f
82 changed files with 9295 additions and 4009 deletions
@@ -3,7 +3,6 @@
 > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).

 ```ts
-
 import { CatalogApi } from '@backstage/catalog-client';
 import { Config } from '@backstage/config';
 import { Entity } from '@backstage/catalog-model';
@@ -16,52 +15,62 @@ import { Profile } from 'passport';
 import { UserEntity } from '@backstage/catalog-model';

 // @public (undocumented)
-export type AuthProviderFactory = (options: AuthProviderFactoryOptions) => AuthProviderRouteHandlers;
+export type AuthProviderFactory = (
+  options: AuthProviderFactoryOptions,
+) => AuthProviderRouteHandlers;

 // @public (undocumented)
 export type AuthProviderFactoryOptions = {
-    providerId: string;
-    globalConfig: AuthProviderConfig;
-    config: Config;
-    logger: Logger_2;
-    tokenIssuer: TokenIssuer;
-    discovery: PluginEndpointDiscovery;
-    catalogApi: CatalogApi;
-    identityResolver?: ExperimentalIdentityResolver;
+  providerId: string;
+  globalConfig: AuthProviderConfig;
+  config: Config;
+  logger: Logger_2;
+  tokenIssuer: TokenIssuer;
+  discovery: PluginEndpointDiscovery;
+  catalogApi: CatalogApi;
+  identityResolver?: ExperimentalIdentityResolver;
 };

 // @public
 export interface AuthProviderRouteHandlers {
-    frameHandler(req: express.Request, res: express.Response): Promise<void>;
-    logout?(req: express.Request, res: express.Response): Promise<void>;
-    refresh?(req: express.Request, res: express.Response): Promise<void>;
-    start(req: express.Request, res: express.Response): Promise<void>;
+  frameHandler(req: express.Request, res: express.Response): Promise<void>;
+  logout?(req: express.Request, res: express.Response): Promise<void>;
+  refresh?(req: express.Request, res: express.Response): Promise<void>;
+  start(req: express.Request, res: express.Response): Promise<void>;
 }

 // @public (undocumented)
 export type AuthResponse<ProviderInfo> = {
-    providerInfo: ProviderInfo;
-    profile: ProfileInfo;
-    backstageIdentity?: BackstageIdentity;
+  providerInfo: ProviderInfo;
+  profile: ProfileInfo;
+  backstageIdentity?: BackstageIdentity;
 };

 // @public (undocumented)
 export type BackstageIdentity = {
-    id: string;
-    idToken?: string;
-    token?: string;
-    entity?: Entity;
+  id: string;
+  idToken?: string;
+  token?: string;
+  entity?: Entity;
 };

 // @public (undocumented)
-export const createGoogleProvider: (options?: GoogleProviderOptions | undefined) => AuthProviderFactory;
+export const createGoogleProvider: (
+  options?: GoogleProviderOptions | undefined,
+) => AuthProviderFactory;

 // @public (undocumented)
-export function createRouter({ logger, config, discovery, database, providerFactories, }: RouterOptions): Promise<express.Router>;
+export function createRouter({
+  logger,
+  config,
+  discovery,
+  database,
+  providerFactories,
+}: RouterOptions): Promise<express.Router>;

 // @public (undocumented)
 export const defaultAuthProviderFactories: {
-    [providerId: string]: AuthProviderFactory;
+  [providerId: string]: AuthProviderFactory;
 };

 // @public (undocumented)
@@ -75,86 +84,97 @@ export const googleEmailSignInResolver: SignInResolver<OAuthResult>;

 // @public (undocumented)
 export type GoogleProviderOptions = {
-    authHandler?: AuthHandler<OAuthResult>;
-    signIn?: {
-        resolver?: SignInResolver<OAuthResult>;
-    };
+  authHandler?: AuthHandler<OAuthResult>;
+  signIn?: {
+    resolver?: SignInResolver<OAuthResult>;
+  };
 };

 // @public
 export class IdentityClient {
-    constructor(options: {
-        discovery: PluginEndpointDiscovery;
-        issuer: string;
-    });
-    authenticate(token: string | undefined): Promise<BackstageIdentity>;
-    static getBearerToken(authorizationHeader: string | undefined): string | undefined;
-    listPublicKeys(): Promise<{
-        keys: JSONWebKey[];
-    }>;
-    }
+  constructor(options: { discovery: PluginEndpointDiscovery; issuer: string });
+  authenticate(token: string | undefined): Promise<BackstageIdentity>;
+  static getBearerToken(
+    authorizationHeader: string | undefined,
+  ): string | undefined;
+  listPublicKeys(): Promise<{
+    keys: JSONWebKey[];
+  }>;
+}

 // @public (undocumented)
 export class OAuthAdapter implements AuthProviderRouteHandlers {
-    constructor(handlers: OAuthHandlers, options: Options);
-    // (undocumented)
-    frameHandler(req: express.Request, res: express.Response): Promise<void>;
-    // (undocumented)
-    static fromConfig(config: AuthProviderConfig, handlers: OAuthHandlers, options: Pick<Options, 'providerId' | 'persistScopes' | 'disableRefresh' | 'tokenIssuer'>): OAuthAdapter;
-    // (undocumented)
-    logout(req: express.Request, res: express.Response): Promise<void>;
-    // (undocumented)
-    refresh(req: express.Request, res: express.Response): Promise<void>;
-    // (undocumented)
-    start(req: express.Request, res: express.Response): Promise<void>;
+  constructor(handlers: OAuthHandlers, options: Options);
+  // (undocumented)
+  frameHandler(req: express.Request, res: express.Response): Promise<void>;
+  // (undocumented)
+  static fromConfig(
+    config: AuthProviderConfig,
+    handlers: OAuthHandlers,
+    options: Pick<
+      Options,
+      'providerId' | 'persistScopes' | 'disableRefresh' | 'tokenIssuer'
+    >,
+  ): OAuthAdapter;
+  // (undocumented)
+  logout(req: express.Request, res: express.Response): Promise<void>;
+  // (undocumented)
+  refresh(req: express.Request, res: express.Response): Promise<void>;
+  // (undocumented)
+  start(req: express.Request, res: express.Response): Promise<void>;
 }

 // @public (undocumented)
 export class OAuthEnvironmentHandler implements AuthProviderRouteHandlers {
-    constructor(handlers: Map<string, AuthProviderRouteHandlers>);
-    // (undocumented)
-    frameHandler(req: express.Request, res: express.Response): Promise<void>;
-    // (undocumented)
-    logout(req: express.Request, res: express.Response): Promise<void>;
-    // (undocumented)
-    static mapConfig(config: Config, factoryFunc: (envConfig: Config) => AuthProviderRouteHandlers): OAuthEnvironmentHandler;
-    // (undocumented)
-    refresh(req: express.Request, res: express.Response): Promise<void>;
-    // (undocumented)
-    start(req: express.Request, res: express.Response): Promise<void>;
+  constructor(handlers: Map<string, AuthProviderRouteHandlers>);
+  // (undocumented)
+  frameHandler(req: express.Request, res: express.Response): Promise<void>;
+  // (undocumented)
+  logout(req: express.Request, res: express.Response): Promise<void>;
+  // (undocumented)
+  static mapConfig(
+    config: Config,
+    factoryFunc: (envConfig: Config) => AuthProviderRouteHandlers,
+  ): OAuthEnvironmentHandler;
+  // (undocumented)
+  refresh(req: express.Request, res: express.Response): Promise<void>;
+  // (undocumented)
+  start(req: express.Request, res: express.Response): Promise<void>;
 }

 // @public
 export interface OAuthHandlers {
-    handler(req: express.Request): Promise<{
-        response: AuthResponse<OAuthProviderInfo>;
-        refreshToken?: string;
-    }>;
-    logout?(): Promise<void>;
-    refresh?(req: OAuthRefreshRequest): Promise<AuthResponse<OAuthProviderInfo>>;
-    start(req: OAuthStartRequest): Promise<RedirectInfo>;
+  handler(
+    req: express.Request,
+  ): Promise<{
+    response: AuthResponse<OAuthProviderInfo>;
+    refreshToken?: string;
+  }>;
+  logout?(): Promise<void>;
+  refresh?(req: OAuthRefreshRequest): Promise<AuthResponse<OAuthProviderInfo>>;
+  start(req: OAuthStartRequest): Promise<RedirectInfo>;
 }

 // @public (undocumented)
 export type OAuthProviderInfo = {
-    accessToken: string;
-    idToken?: string;
-    expiresInSeconds?: number;
-    scope: string;
-    refreshToken?: string;
+  accessToken: string;
+  idToken?: string;
+  expiresInSeconds?: number;
+  scope: string;
+  refreshToken?: string;
 };

 // @public
 export type OAuthProviderOptions = {
-    clientId: string;
-    clientSecret: string;
-    callbackUrl: string;
+  clientId: string;
+  clientSecret: string;
+  callbackUrl: string;
 };

 // @public (undocumented)
 export type OAuthRefreshRequest = express.Request<{}> & {
-    scope: string;
-    refreshToken: string;
+  scope: string;
+  refreshToken: string;
 };

 // @public (undocumented)
@@ -162,36 +182,40 @@ export type OAuthResponse = AuthResponse<OAuthProviderInfo>;

 // @public (undocumented)
 export type OAuthResult = {
-    fullProfile: Profile;
-    params: {
-        id_token?: string;
-        scope: string;
-        expires_in: number;
-    };
-    accessToken: string;
-    refreshToken?: string;
+  fullProfile: Profile;
+  params: {
+    id_token?: string;
+    scope: string;
+    expires_in: number;
+  };
+  accessToken: string;
+  refreshToken?: string;
 };

 // @public (undocumented)
 export type OAuthStartRequest = express.Request<{}> & {
-    scope: string;
-    state: OAuthState;
+  scope: string;
+  state: OAuthState;
 };

 // @public (undocumented)
 export type OAuthState = {
-    nonce: string;
-    env: string;
+  nonce: string;
+  env: string;
 };

 // @public (undocumented)
-export const postMessageResponse: (res: express.Response, appOrigin: string, response: WebMessageResponse) => void;
+export const postMessageResponse: (
+  res: express.Response,
+  appOrigin: string,
+  response: WebMessageResponse,
+) => void;

 // @public
 export type ProfileInfo = {
-    email?: string;
-    displayName?: string;
-    picture?: string;
+  email?: string;
+  displayName?: string;
+  picture?: string;
 };

 // @public (undocumented)
@@ -199,31 +223,31 @@ export const readState: (stateString: string) => OAuthState;

 // @public (undocumented)
 export interface RouterOptions {
-    // (undocumented)
-    config: Config;
-    // (undocumented)
-    database: PluginDatabaseManager;
-    // (undocumented)
-    discovery: PluginEndpointDiscovery;
-    // (undocumented)
-    logger: Logger_2;
-    // (undocumented)
-    providerFactories?: ProviderFactories;
+  // (undocumented)
+  config: Config;
+  // (undocumented)
+  database: PluginDatabaseManager;
+  // (undocumented)
+  discovery: PluginEndpointDiscovery;
+  // (undocumented)
+  logger: Logger_2;
+  // (undocumented)
+  providerFactories?: ProviderFactories;
 }

 // @public (undocumented)
 export const verifyNonce: (req: express.Request, providerId: string) => void;

 // @public
-export type WebMessageResponse = {
-    type: 'authorization_response';
-    response: AuthResponse<unknown>;
-} | {
-    type: 'authorization_response';
-    error: Error;
-};
-
+export type WebMessageResponse =
+  | {
+      type: 'authorization_response';
+      response: AuthResponse<unknown>;
+    }
+  | {
+      type: 'authorization_response';
+      error: Error;
+    };

 // (No @packageDocumentation comment for this package)
-
 ```