From 6972645ce726a7ae08e4eeb4c365c5aaf27dca07 Mon Sep 17 00:00:00 2001 From: Patrik Oldsberg Date: Tue, 31 Aug 2021 14:53:09 +0200 Subject: [PATCH] integration-react: update API report Signed-off-by: Patrik Oldsberg --- packages/integration-react/api-report.md | 78 ++++++++++++++++++++++++ 1 file changed, 78 insertions(+) diff --git a/packages/integration-react/api-report.md b/packages/integration-react/api-report.md index 88057fda74..8b7b3717a3 100644 --- a/packages/integration-react/api-report.md +++ b/packages/integration-react/api-report.md @@ -6,9 +6,87 @@ /// import { ApiRef } from '@backstage/core-plugin-api'; +import { AuthRequestOptions } from '@backstage/core-plugin-api'; import { Config } from '@backstage/config'; +import { OAuthApi } from '@backstage/core-plugin-api'; import { ScmIntegrationRegistry } from '@backstage/integration'; +// Warning: (ae-missing-release-tag) "ScmAuth" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public +export class ScmAuth implements ScmAuthApi { + static forAuthApi( + authApi: OAuthApi, + options: { + host: string; + scopeMapping: { + default: string[]; + repoWrite: string[]; + }; + }, + ): ScmAuth; + static forAzure( + microsoftAuthApiRef: OAuthApi, + options?: { + host?: string; + }, + ): ScmAuth; + static forBitbucket( + bitbucketAuthApi: OAuthApi, + options?: { + host?: string; + }, + ): ScmAuth; + static forGithub( + githubAuthApi: OAuthApi, + options?: { + host?: string; + }, + ): ScmAuth; + static forGitlab( + gitlabAuthApi: OAuthApi, + options?: { + host?: string; + }, + ): ScmAuth; + // (undocumented) + getCredentials(options: ScmAuthTokenOptions): Promise; + isUrlSupported(url: URL): boolean; + static merge(...providers: ScmAuth[]): ScmAuthApi; +} + +// Warning: (ae-missing-release-tag) "ScmAuthApi" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public +export interface ScmAuthApi { + getCredentials(options: ScmAuthTokenOptions): Promise; +} + +// Warning: (ae-missing-release-tag) "scmAuthApiRef" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public (undocumented) +export const scmAuthApiRef: ApiRef; + +// Warning: (ae-missing-release-tag) "ScmAuthTokenOptions" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public (undocumented) +export interface ScmAuthTokenOptions extends AuthRequestOptions { + additionalScope?: { + repoWrite?: boolean; + }; + url: string; +} + +// Warning: (ae-missing-release-tag) "ScmAuthTokenResponse" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public (undocumented) +export interface ScmAuthTokenResponse { + headers: { + [name: string]: string; + }; + token: string; +} + // Warning: (ae-missing-release-tag) "ScmIntegrationIcon" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public (undocumented)