diff --git a/plugins/auth-backend/api-report.md b/plugins/auth-backend/api-report.md index 4227f1db0a..fb58196b2f 100644 --- a/plugins/auth-backend/api-report.md +++ b/plugins/auth-backend/api-report.md @@ -74,13 +74,21 @@ export type AuthHandlerResult = { // Warning: (ae-missing-release-tag) "AuthProviderFactory" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public (undocumented) -export type AuthProviderFactory = ( - options: AuthProviderFactoryOptions, -) => AuthProviderRouteHandlers; +export type AuthProviderFactory = (options: { + providerId: string; + globalConfig: AuthProviderConfig; + config: Config; + resolverContext: AuthResolverContext; + logger: Logger; + tokenManager: TokenManager; + tokenIssuer: TokenIssuer; + discovery: PluginEndpointDiscovery; + catalogApi: CatalogApi; +}) => AuthProviderRouteHandlers; // Warning: (ae-missing-release-tag) "AuthProviderFactoryOptions" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // -// @public (undocumented) +// @public @deprecated (undocumented) export type AuthProviderFactoryOptions = { providerId: string; globalConfig: AuthProviderConfig; @@ -248,9 +256,18 @@ export const createGitlabProvider: ( // Warning: (ae-missing-release-tag) "createGoogleProvider" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // -// @public (undocumented) +// @public @deprecated (undocumented) export const createGoogleProvider: ( - options?: GoogleProviderOptions | undefined, + options?: + | { + authHandler?: AuthHandler | undefined; + signIn?: + | { + resolver: SignInResolver; + } + | undefined; + } + | undefined, ) => AuthProviderFactory; // Warning: (ae-missing-release-tag) "createMicrosoftProvider" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) @@ -369,33 +386,38 @@ export type GithubOAuthResult = { export type GithubProviderOptions = { authHandler?: AuthHandler; signIn?: { - resolver?: SignInResolver; + resolver: SignInResolver; }; stateEncoder?: StateEncoder; }; +// Warning: (ae-missing-release-tag) "githubUsernameEntityNameSignInResolver" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public (undocumented) +export const githubUsernameEntityNameSignInResolver: SignInResolver; + // Warning: (ae-missing-release-tag) "GitlabProviderOptions" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public (undocumented) export type GitlabProviderOptions = { authHandler?: AuthHandler; signIn?: { - resolver?: SignInResolver; + resolver: SignInResolver; }; }; // Warning: (ae-missing-release-tag) "googleEmailSignInResolver" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // -// @public (undocumented) -export const googleEmailSignInResolver: SignInResolver; +// @public @deprecated (undocumented) +export const googleEmailSignInResolver: () => SignInResolver; // Warning: (ae-missing-release-tag) "GoogleProviderOptions" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // -// @public (undocumented) +// @public @deprecated (undocumented) export type GoogleProviderOptions = { authHandler?: AuthHandler; signIn?: { - resolver?: SignInResolver; + resolver: SignInResolver; }; }; @@ -410,7 +432,7 @@ export const microsoftEmailSignInResolver: SignInResolver; export type MicrosoftProviderOptions = { authHandler?: AuthHandler; signIn?: { - resolver?: SignInResolver; + resolver: SignInResolver; }; }; @@ -420,7 +442,7 @@ export type MicrosoftProviderOptions = { export type OAuth2ProviderOptions = { authHandler?: AuthHandler; signIn?: { - resolver?: SignInResolver; + resolver: SignInResolver; }; }; @@ -578,7 +600,7 @@ export type OidcAuthResult = { export type OidcProviderOptions = { authHandler?: AuthHandler; signIn?: { - resolver?: SignInResolver; + resolver: SignInResolver; }; }; @@ -593,7 +615,7 @@ export const oktaEmailSignInResolver: SignInResolver; export type OktaProviderOptions = { authHandler?: AuthHandler; signIn?: { - resolver?: SignInResolver; + resolver: SignInResolver; }; }; @@ -626,6 +648,30 @@ export type ProfileInfo = { picture?: string; }; +// Warning: (ae-missing-release-tag) "providers" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public (undocumented) +export const providers: Readonly<{ + google: Readonly<{ + create: ( + options?: + | { + authHandler?: AuthHandler | undefined; + signIn?: + | { + resolver: SignInResolver; + } + | undefined; + } + | undefined, + ) => AuthProviderFactory; + resolvers: Readonly<{ + byEmailLocalPart: () => SignInResolver; + lookupEmailAnnotation(): SignInResolver; + }>; + }>; +}>; + // Warning: (ae-missing-release-tag) "readState" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public (undocumented) @@ -656,11 +702,16 @@ export type SamlAuthResult = { fullProfile: any; }; +// Warning: (ae-missing-release-tag) "samlNameIdEntityNameSignInResolver" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public (undocumented) +export const samlNameIdEntityNameSignInResolver: SignInResolver; + // @public (undocumented) export type SamlProviderOptions = { authHandler?: AuthHandler; signIn?: { - resolver?: SignInResolver; + resolver: SignInResolver; }; }; @@ -709,5 +760,5 @@ export type WebMessageResponse = // src/identity/types.d.ts:31:9 - (ae-forgotten-export) The symbol "AnyJWK" needs to be exported by the entry point index.d.ts // src/providers/aws-alb/provider.d.ts:77:5 - (ae-forgotten-export) The symbol "AwsAlbResult" needs to be exported by the entry point index.d.ts // src/providers/github/provider.d.ts:97:5 - (ae-forgotten-export) The symbol "StateEncoder" needs to be exported by the entry point index.d.ts -// src/providers/types.d.ts:118:5 - (ae-forgotten-export) The symbol "AuthProviderConfig" needs to be exported by the entry point index.d.ts +// src/providers/types.d.ts:131:5 - (ae-forgotten-export) The symbol "AuthProviderConfig" needs to be exported by the entry point index.d.ts ```