@backstage/plugin-auth-backend 0.18.2-next.1 → 0.18.2-next.3

package/dist/index.d.ts

@@ -17,7 +17,7 @@ import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
  *
  * @public
  */
-declare type TokenParams = {
+type TokenParams = {
     /**
      * The claims that will be embedded within the token. At a minimum, this should include
      * the subject claim, `sub`. It is common to also list entity ownership relations in the
@@ -39,7 +39,7 @@ declare type TokenParams = {
  *
  * @public
  */
-declare type OAuthProviderOptions = {
+type OAuthProviderOptions = {
     /**
      * Client ID of the auth provider.
      */
@@ -54,7 +54,7 @@ declare type OAuthProviderOptions = {
     callbackUrl: string;
 };
 /** @public */
-declare type OAuthResult = {
+type OAuthResult = {
     fullProfile: Profile;
     params: {
         id_token?: string;
@@ -69,13 +69,13 @@ declare type OAuthResult = {
  *
  * @public
  */
-declare type OAuthResponse = {
+type OAuthResponse = {
     profile: ProfileInfo;
     providerInfo: OAuthProviderInfo;
     backstageIdentity?: BackstageSignInResult;
 };
 /** @public */
-declare type OAuthProviderInfo = {
+type OAuthProviderInfo = {
     /**
      * An access token issued for the signed in user.
      */
@@ -94,7 +94,7 @@ declare type OAuthProviderInfo = {
     scope: string;
 };
 /** @public */
-declare type OAuthState = {
+type OAuthState = {
     nonce: string;
     env: string;
     origin?: string;
@@ -103,17 +103,17 @@ declare type OAuthState = {
     flow?: string;
 };
 /** @public */
-declare type OAuthStartRequest = express.Request<{}> & {
+type OAuthStartRequest = express.Request<{}> & {
     scope: string;
     state: OAuthState;
 };
 /** @public */
-declare type OAuthRefreshRequest = express.Request<{}> & {
+type OAuthRefreshRequest = express.Request<{}> & {
     scope: string;
     refreshToken: string;
 };
 /** @public */
-declare type OAuthLogoutRequest = express.Request<{}> & {
+type OAuthLogoutRequest = express.Request<{}> & {
     refreshToken: string;
 };
 /**
@@ -163,7 +163,7 @@ interface OAuthHandlers {
  *
  * @public
  */
-declare type AuthResolverCatalogUserQuery = {
+type AuthResolverCatalogUserQuery = {
     entityRef: string | {
         kind?: string;
         namespace?: string;
@@ -179,7 +179,7 @@ declare type AuthResolverCatalogUserQuery = {
  *
  * @public
  */
-declare type AuthResolverContext = {
+type AuthResolverContext = {
     /**
      * Issues a Backstage token using the provided parameters.
      */
@@ -206,7 +206,7 @@ declare type AuthResolverContext = {
  * The callback used to resolve the cookie configuration for auth providers that use cookies.
  * @public
  */
-declare type CookieConfigurer = (ctx: {
+type CookieConfigurer = (ctx: {
     /** ID of the auth provider that this configuration applies to */
     providerId: string;
     /** The externally reachable base URL of the auth-backend plugin */
@@ -222,7 +222,7 @@ declare type CookieConfigurer = (ctx: {
     sameSite?: 'none' | 'lax' | 'strict';
 };
 /** @public */
-declare type AuthProviderConfig = {
+type AuthProviderConfig = {
     /**
      * The protocol://domain[:port] where the app is hosted. This is used to construct the
      * callbackURL to redirect to once the user signs in to the auth provider.
@@ -242,7 +242,7 @@ declare type AuthProviderConfig = {
     cookieConfigurer?: CookieConfigurer;
 };
 /** @public */
-declare type OAuthStartResponse = {
+type OAuthStartResponse = {
     /**
      * URL to redirect to
      */
@@ -306,7 +306,7 @@ interface AuthProviderRouteHandlers {
     logout?(req: express.Request, res: express.Response): Promise<void>;
 }
 /** @public */
-declare type AuthProviderFactory = (options: {
+type AuthProviderFactory = (options: {
     providerId: string;
     globalConfig: AuthProviderConfig;
     config: Config;
@@ -314,7 +314,7 @@ declare type AuthProviderFactory = (options: {
     resolverContext: AuthResolverContext;
 }) => AuthProviderRouteHandlers;
 /** @public */
-declare type AuthResponse<ProviderInfo> = {
+type AuthResponse<ProviderInfo> = {
     providerInfo: ProviderInfo;
     profile: ProfileInfo;
     backstageIdentity?: BackstageIdentityResponse;
@@ -328,7 +328,7 @@ declare type AuthResponse<ProviderInfo> = {
  *
  * @public
  */
-declare type ProfileInfo = {
+type ProfileInfo = {
     /**
      * Email ID of the signed in user.
      */
@@ -349,7 +349,7 @@ declare type ProfileInfo = {
  *
  * @public
  */
-declare type SignInInfo<TAuthResult> = {
+type SignInInfo<TAuthResult> = {
     /**
      * The simple profile passed down for use in the frontend.
      */
@@ -366,14 +366,14 @@ declare type SignInInfo<TAuthResult> = {
  *
  * @public
  */
-declare type SignInResolver<TAuthResult> = (info: SignInInfo<TAuthResult>, context: AuthResolverContext) => Promise<BackstageSignInResult>;
+type SignInResolver<TAuthResult> = (info: SignInInfo<TAuthResult>, context: AuthResolverContext) => Promise<BackstageSignInResult>;
 /**
  * The return type of an authentication handler. Must contain valid profile
  * information.
  *
  * @public
  */
-declare type AuthHandlerResult = {
+type AuthHandlerResult = {
     profile: ProfileInfo;
 };
 /**
@@ -389,19 +389,25 @@ declare type AuthHandlerResult = {
  *
  * @public
  */
-declare type AuthHandler<TAuthResult> = (input: TAuthResult, context: AuthResolverContext) => Promise<AuthHandlerResult>;
+type AuthHandler<TAuthResult> = (input: TAuthResult, context: AuthResolverContext) => Promise<AuthHandlerResult>;
 /** @public */
-declare type StateEncoder = (req: OAuthStartRequest) => Promise<{
+type StateEncoder = (req: OAuthStartRequest) => Promise<{
     encodedState: string;
 }>;
 
 /** @public */
-declare type AwsAlbResult = {
+type AwsAlbResult = {
     fullProfile: Profile;
     expiresInSeconds?: number;
     accessToken: string;
 };
 
+/** @public */
+type EasyAuthResult = {
+    fullProfile: Profile;
+    accessToken?: string;
+};
+
 /** @public */
 declare class OAuthEnvironmentHandler implements AuthProviderRouteHandlers {
     private readonly handlers;
@@ -416,7 +422,7 @@ declare class OAuthEnvironmentHandler implements AuthProviderRouteHandlers {
 }
 
 /** @public */
-declare type OAuthAdapterOptions = {
+type OAuthAdapterOptions = {
     providerId: string;
     persistScopes?: boolean;
     appOrigin: string;
@@ -458,7 +464,7 @@ declare const encodeState: (state: OAuthState) => string;
 declare const verifyNonce: (req: express.Request, providerId: string) => void;
 
 /** @public */
-declare type BitbucketOAuthResult = {
+type BitbucketOAuthResult = {
     fullProfile: BitbucketPassportProfile;
     params: {
         id_token?: string;
@@ -469,7 +475,7 @@ declare type BitbucketOAuthResult = {
     refreshToken?: string;
 };
 /** @public */
-declare type BitbucketPassportProfile = Profile & {
+type BitbucketPassportProfile = Profile & {
     id?: string;
     displayName?: string;
     username?: string;
@@ -484,7 +490,7 @@ declare type BitbucketPassportProfile = Profile & {
 };
 
 /** @public */
-declare type BitbucketServerOAuthResult = {
+type BitbucketServerOAuthResult = {
     fullProfile: Profile;
     params: {
         scope: string;
@@ -504,7 +510,7 @@ declare type BitbucketServerOAuthResult = {
  *
  * @public
  */
-declare type CloudflareAccessClaims = {
+type CloudflareAccessClaims = {
     /**
      * `aud` identifies the application to which the JWT is issued.
      */
@@ -546,7 +552,7 @@ declare type CloudflareAccessClaims = {
  *
  * @public
  */
-declare type CloudflareAccessGroup = {
+type CloudflareAccessGroup = {
     /**
      * Group id
      */
@@ -568,7 +574,7 @@ declare type CloudflareAccessGroup = {
  *
  * @public
  */
-declare type CloudflareAccessIdentityProfile = {
+type CloudflareAccessIdentityProfile = {
     id: string;
     name: string;
     email: string;
@@ -577,7 +583,7 @@ declare type CloudflareAccessIdentityProfile = {
 /**
  * @public
  */
-declare type CloudflareAccessResult = {
+type CloudflareAccessResult = {
     claims: CloudflareAccessClaims;
     cfIdentity: CloudflareAccessIdentityProfile;
     expiresInSeconds?: number;
@@ -585,7 +591,7 @@ declare type CloudflareAccessResult = {
 };
 
 /** @public */
-declare type GithubOAuthResult = {
+type GithubOAuthResult = {
     fullProfile: Profile;
     params: {
         scope: string;
@@ -602,7 +608,7 @@ declare type GithubOAuthResult = {
  *
  * @public
  */
-declare type OAuth2ProxyResult<JWTPayload = {}> = {
+type OAuth2ProxyResult<JWTPayload = {}> = {
     /**
      * The parsed payload of the `accessToken`. The token is only parsed, not verified.
      *
@@ -640,13 +646,13 @@ declare type OAuth2ProxyResult<JWTPayload = {}> = {
  * authentication result for the OIDC which includes the token set and user information (a profile response sent by OIDC server)
  * @public
  */
-declare type OidcAuthResult = {
+type OidcAuthResult = {
     tokenset: TokenSet;
     userinfo: UserinfoResponse;
 };
 
 /** @public */
-declare type SamlAuthResult = {
+type SamlAuthResult = {
     fullProfile: any;
 };
 
@@ -655,7 +661,7 @@ declare type SamlAuthResult = {
  *
  * @public
  */
-declare type GcpIapTokenInfo = {
+type GcpIapTokenInfo = {
     /**
      * The unique, stable identifier for the user.
      */
@@ -675,7 +681,7 @@ declare type GcpIapTokenInfo = {
  *
  * @public
  */
-declare type GcpIapResult = {
+type GcpIapResult = {
     /**
      * The data extracted from the IAP token header.
      */
@@ -831,7 +837,10 @@ declare const providers: Readonly<{
                 resolver: SignInResolver<OidcAuthResult>;
             } | undefined;
         } | undefined) => AuthProviderFactory;
-        resolvers: never;
+        resolvers: Readonly<{
+            emailLocalPartMatchingUserEntityName: () => SignInResolver<unknown>;
+            emailMatchingUserEntityProfileEmail: () => SignInResolver<unknown>;
+        }>;
     }>;
     okta: Readonly<{
         create: (options?: {
@@ -866,6 +875,15 @@ declare const providers: Readonly<{
             nameIdMatchingUserEntityName(): SignInResolver<SamlAuthResult>;
         }>;
     }>;
+    easyAuth: Readonly<{
+        create: (options?: {
+            authHandler?: AuthHandler<EasyAuthResult> | undefined;
+            signIn: {
+                resolver: SignInResolver<EasyAuthResult>;
+            };
+        } | undefined) => AuthProviderFactory;
+        resolvers: never;
+    }>;
 }>;
 /**
  * All auth provider factories that are installed by default.
@@ -905,7 +923,7 @@ declare function createAuthProviderIntegration<TCreateOptions extends unknown[],
 declare function prepareBackstageIdentityResponse(result: BackstageSignInResult): BackstageIdentityResponse;
 
 /** @public */
-declare type ProviderFactories = {
+type ProviderFactories = {
     [s: string]: AuthProviderFactory;
 };
 /** @public */
@@ -930,7 +948,7 @@ declare function createOriginFilter(config: Config): (origin: string) => boolean
  *
  * @public
  */
-declare type WebMessageResponse = {
+type WebMessageResponse = {
     type: 'authorization_response';
     response: AuthResponse<unknown>;
 } | {
@@ -986,4 +1004,4 @@ declare class CatalogIdentityClient {
  */
 declare function getDefaultOwnershipEntityRefs(entity: Entity): string[];
 
-export { AuthHandler, AuthHandlerResult, AuthProviderConfig, AuthProviderFactory, AuthProviderRouteHandlers, AuthResolverCatalogUserQuery, AuthResolverContext, AuthResponse, AwsAlbResult, BitbucketOAuthResult, BitbucketPassportProfile, BitbucketServerOAuthResult, CatalogIdentityClient, CloudflareAccessClaims, CloudflareAccessGroup, CloudflareAccessIdentityProfile, CloudflareAccessResult, CookieConfigurer, GcpIapResult, GcpIapTokenInfo, GithubOAuthResult, OAuth2ProxyResult, OAuthAdapter, OAuthAdapterOptions, OAuthEnvironmentHandler, OAuthHandlers, OAuthLogoutRequest, OAuthProviderInfo, OAuthProviderOptions, OAuthRefreshRequest, OAuthResponse, OAuthResult, OAuthStartRequest, OAuthStartResponse, OAuthState, OidcAuthResult, ProfileInfo, ProviderFactories, RouterOptions, SamlAuthResult, SignInInfo, SignInResolver, StateEncoder, TokenParams, WebMessageResponse, createAuthProviderIntegration, createOriginFilter, createRouter, defaultAuthProviderFactories, encodeState, ensuresXRequestedWith, getDefaultOwnershipEntityRefs, postMessageResponse, prepareBackstageIdentityResponse, providers, readState, verifyNonce };
+export { AuthHandler, AuthHandlerResult, AuthProviderConfig, AuthProviderFactory, AuthProviderRouteHandlers, AuthResolverCatalogUserQuery, AuthResolverContext, AuthResponse, AwsAlbResult, BitbucketOAuthResult, BitbucketPassportProfile, BitbucketServerOAuthResult, CatalogIdentityClient, CloudflareAccessClaims, CloudflareAccessGroup, CloudflareAccessIdentityProfile, CloudflareAccessResult, CookieConfigurer, EasyAuthResult, GcpIapResult, GcpIapTokenInfo, GithubOAuthResult, OAuth2ProxyResult, OAuthAdapter, OAuthAdapterOptions, OAuthEnvironmentHandler, OAuthHandlers, OAuthLogoutRequest, OAuthProviderInfo, OAuthProviderOptions, OAuthRefreshRequest, OAuthResponse, OAuthResult, OAuthStartRequest, OAuthStartResponse, OAuthState, OidcAuthResult, ProfileInfo, ProviderFactories, RouterOptions, SamlAuthResult, SignInInfo, SignInResolver, StateEncoder, TokenParams, WebMessageResponse, createAuthProviderIntegration, createOriginFilter, createRouter, defaultAuthProviderFactories, encodeState, ensuresXRequestedWith, getDefaultOwnershipEntityRefs, postMessageResponse, prepareBackstageIdentityResponse, providers, readState, verifyNonce };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@backstage/plugin-auth-backend",
   "description": "A Backstage backend plugin that handles authentication",
-  "version": "0.18.2-next.1",
+  "version": "0.18.2-next.3",
   "main": "dist/index.cjs.js",
   "types": "dist/index.d.ts",
   "license": "Apache-2.0",
@@ -32,12 +32,12 @@
     "clean": "backstage-cli package clean"
   },
   "dependencies": {
-    "@backstage/backend-common": "^0.18.4-next.1",
-    "@backstage/catalog-client": "^1.4.0",
-    "@backstage/catalog-model": "^1.2.1",
+    "@backstage/backend-common": "^0.18.4-next.2",
+    "@backstage/catalog-client": "^1.4.1-next.1",
+    "@backstage/catalog-model": "^1.3.0-next.0",
     "@backstage/config": "^1.0.7",
     "@backstage/errors": "^1.1.5",
-    "@backstage/plugin-auth-node": "^0.2.13-next.1",
+    "@backstage/plugin-auth-node": "^0.2.13-next.2",
     "@backstage/types": "^1.0.2",
     "@davidzemon/passport-okta-oauth": "^0.0.5",
     "@google-cloud/firestore": "^6.0.0",
@@ -76,8 +76,8 @@
     "yn": "^4.0.0"
   },
   "devDependencies": {
-    "@backstage/backend-test-utils": "^0.1.36-next.1",
-    "@backstage/cli": "^0.22.6-next.1",
+    "@backstage/backend-test-utils": "^0.1.36-next.2",
+    "@backstage/cli": "^0.22.6-next.3",
     "@types/body-parser": "^1.19.0",
     "@types/cookie-parser": "^1.4.2",
     "@types/express-session": "^1.17.2",