chore: run api reports command

Signed-off-by: djamaile <rdjamaile@gmail.com>
This commit is contained in:
djamaile
2023-11-20 20:58:16 +01:00
parent 7ac25759a5
commit 37ad2a80c0
4 changed files with 53 additions and 14 deletions
@@ -0,0 +1,31 @@
## API Report File for "@backstage/plugin-auth-backend-module-oauth2-proxy-provider"
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
/// <reference types="node" />
import { BackendFeature } from '@backstage/backend-plugin-api';
import { IncomingHttpHeaders } from 'http';
import { ProxyAuthenticator } from '@backstage/plugin-auth-node';
// @public (undocumented)
export const authModuleOauth2ProxyProvider: () => BackendFeature;
// @public
export const OAUTH2_PROXY_JWT_HEADER = 'X-OAUTH2-PROXY-ID-TOKEN';
// @public (undocumented)
export const oauth2ProxyAuthenticator: ProxyAuthenticator<
unknown,
OAuth2ProxyResult
>;
// @public
export type OAuth2ProxyResult<JWTPayload = {}> = {
fullProfile: JWTPayload;
accessToken: string;
headers: IncomingHttpHeaders;
getHeader(name: string): string | undefined;
};
```
@@ -0,0 +1,10 @@
apiVersion: backstage.io/v1alpha1
kind: Component
metadata:
name: backstage-plugin-auth-backend-module-oauth2-proxy-provider
title: '@backstage/plugin-auth-backend-module-oauth2-proxy-provider'
description: The oauth2-proxy-provider backend module for the auth plugin.
spec:
lifecycle: experimental
type: backstage-backend-plugin-module
owner: maintainers
@@ -22,10 +22,15 @@ import {
import { decodeJwt } from 'jose';
import { OAuth2ProxyResult } from './types';
// NOTE: This may come in handy if you're doing work on this provider:
// plugins/auth-backend/examples/docker-compose.oauth2-proxy.yaml
/**
* NOTE: This may come in handy if you're doing work on this provider:
* plugins/auth-backend/examples/docker-compose.oauth2-proxy.yaml
*
* @public
*/
export const OAUTH2_PROXY_JWT_HEADER = 'X-OAUTH2-PROXY-ID-TOKEN';
/** @public */
export const oauth2ProxyAuthenticator = createProxyAuthenticator<
unknown,
OAuth2ProxyResult
+5 -12
View File
@@ -3,8 +3,6 @@
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
/// <reference types="node" />
import { AuthProviderConfig as AuthProviderConfig_2 } from '@backstage/plugin-auth-node';
import { AuthProviderFactory as AuthProviderFactory_2 } from '@backstage/plugin-auth-node';
import { AuthProviderRouteHandlers as AuthProviderRouteHandlers_2 } from '@backstage/plugin-auth-node';
@@ -23,8 +21,8 @@ import { Entity } from '@backstage/catalog-model';
import express from 'express';
import { GcpIapResult as GcpIapResult_2 } from '@backstage/plugin-auth-backend-module-gcp-iap-provider';
import { GcpIapTokenInfo as GcpIapTokenInfo_2 } from '@backstage/plugin-auth-backend-module-gcp-iap-provider';
import { IncomingHttpHeaders } from 'http';
import { LoggerService } from '@backstage/backend-plugin-api';
import { OAuth2ProxyResult as OAuth2ProxyResult_2 } from '@backstage/plugin-auth-backend-module-oauth2-proxy-provider';
import { OAuthEnvironmentHandler as OAuthEnvironmentHandler_2 } from '@backstage/plugin-auth-node';
import { OAuthState as OAuthState_2 } from '@backstage/plugin-auth-node';
import { PluginDatabaseManager } from '@backstage/backend-common';
@@ -228,13 +226,8 @@ export type GithubOAuthResult = {
refreshToken?: string;
};
// @public
export type OAuth2ProxyResult<JWTPayload = {}> = {
fullProfile: JWTPayload;
accessToken: string;
headers: IncomingHttpHeaders;
getHeader(name: string): string | undefined;
};
// @public @deprecated (undocumented)
export type OAuth2ProxyResult = OAuth2ProxyResult_2;
// @public @deprecated (undocumented)
export class OAuthAdapter implements AuthProviderRouteHandlers {
@@ -560,9 +553,9 @@ export const providers: Readonly<{
}>;
oauth2Proxy: Readonly<{
create: (options: {
authHandler?: AuthHandler<OAuth2ProxyResult<unknown>> | undefined;
authHandler?: AuthHandler<OAuth2ProxyResult_2> | undefined;
signIn: {
resolver: SignInResolver<OAuth2ProxyResult<unknown>>;
resolver: SignInResolver<OAuth2ProxyResult_2>;
};
}) => AuthProviderFactory_2;
resolvers: never;