@backstage/plugin-auth-backend 0.15.2-next.0 → 0.16.0-next.1

package/dist/index.d.ts

@@ -29,6 +29,8 @@ declare type TokenParams = {
 
 /**
  * Common options for passport.js-based OAuth providers
+ *
+ * @public
  */
 declare type OAuthProviderOptions = {
     /**
@@ -44,6 +46,7 @@ declare type OAuthProviderOptions = {
      */
     callbackUrl: string;
 };
+/** @public */
 declare type OAuthResult = {
     fullProfile: Profile;
     params: {
@@ -64,6 +67,7 @@ declare type OAuthResponse = {
     providerInfo: OAuthProviderInfo;
     backstageIdentity?: BackstageSignInResult;
 };
+/** @public */
 declare type OAuthProviderInfo = {
     /**
      * An access token issued for the signed in user.
@@ -82,16 +86,19 @@ declare type OAuthProviderInfo = {
      */
     scope: string;
 };
+/** @public */
 declare type OAuthState = {
     nonce: string;
     env: string;
     origin?: string;
     scope?: string;
 };
+/** @public */
 declare type OAuthStartRequest = express.Request<{}> & {
     scope: string;
     state: OAuthState;
 };
+/** @public */
 declare type OAuthRefreshRequest = express.Request<{}> & {
     scope: string;
     refreshToken: string;
@@ -107,7 +114,7 @@ interface OAuthHandlers {
     /**
      * Initiate a sign in request with an auth provider.
      */
-    start(req: OAuthStartRequest): Promise<RedirectInfo>;
+    start(req: OAuthStartRequest): Promise<OAuthStartResponse>;
     /**
      * Handle the redirect from the auth provider when the user has signed in.
      */
@@ -218,7 +225,8 @@ declare type AuthProviderConfig = {
      */
     cookieConfigurer?: CookieConfigurer;
 };
-declare type RedirectInfo = {
+/** @public */
+declare type OAuthStartResponse = {
     /**
      * URL to redirect to
      */
@@ -238,6 +246,8 @@ declare type RedirectInfo = {
  * `/auth/[provider]/handler/frame -> frameHandler`
  * `/auth/[provider]/refresh -> refresh`
  * `/auth/[provider]/logout -> logout`
+ *
+ * @public
  */
 interface AuthProviderRouteHandlers {
     /**
@@ -279,6 +289,7 @@ interface AuthProviderRouteHandlers {
      */
     logout?(req: express.Request, res: express.Response): Promise<void>;
 }
+/** @public */
 declare type AuthProviderFactory = (options: {
     providerId: string;
     globalConfig: AuthProviderConfig;
@@ -368,6 +379,14 @@ declare type StateEncoder = (req: OAuthStartRequest) => Promise<{
     encodedState: string;
 }>;
 
+/** @public */
+declare type AwsAlbResult = {
+    fullProfile: Profile;
+    expiresInSeconds?: number;
+    accessToken: string;
+};
+
+/** @public */
 declare class OAuthEnvironmentHandler implements AuthProviderRouteHandlers {
     private readonly handlers;
     static mapConfig(config: Config, factoryFunc: (envConfig: Config) => AuthProviderRouteHandlers): OAuthEnvironmentHandler;
@@ -380,7 +399,8 @@ declare class OAuthEnvironmentHandler implements AuthProviderRouteHandlers {
     private getProviderForEnv;
 }
 
-declare type Options = {
+/** @public */
+declare type OAuthAdapterOptions = {
     providerId: string;
     secure: boolean;
     persistScopes?: boolean;
@@ -390,12 +410,13 @@ declare type Options = {
     isOriginAllowed: (origin: string) => boolean;
     callbackUrl: string;
 };
+/** @public */
 declare class OAuthAdapter implements AuthProviderRouteHandlers {
     private readonly handlers;
     private readonly options;
-    static fromConfig(config: AuthProviderConfig, handlers: OAuthHandlers, options: Pick<Options, 'providerId' | 'persistScopes' | 'callbackUrl'>): OAuthAdapter;
+    static fromConfig(config: AuthProviderConfig, handlers: OAuthHandlers, options: Pick<OAuthAdapterOptions, 'providerId' | 'persistScopes' | 'callbackUrl'>): OAuthAdapter;
     private readonly baseCookieOptions;
-    constructor(handlers: OAuthHandlers, options: Options);
+    constructor(handlers: OAuthHandlers, options: OAuthAdapterOptions);
     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>;
@@ -412,45 +433,14 @@ declare class OAuthAdapter implements AuthProviderRouteHandlers {
     private removeRefreshTokenCookie;
 }
 
+/** @public */
 declare const readState: (stateString: string) => OAuthState;
+/** @public */
 declare const encodeState: (state: OAuthState) => string;
+/** @public */
 declare const verifyNonce: (req: express.Request, providerId: string) => void;
 
-declare type AtlassianAuthProviderOptions = OAuthProviderOptions & {
-    scopes: string;
-    signInResolver?: SignInResolver<OAuthResult>;
-    authHandler: AuthHandler<OAuthResult>;
-    resolverContext: AuthResolverContext;
-};
-/**
- * @public
- * @deprecated This export is deprecated and will be removed in the future.
- */
-declare class AtlassianAuthProvider implements OAuthHandlers {
-    private readonly _strategy;
-    private readonly signInResolver?;
-    private readonly authHandler;
-    private readonly resolverContext;
-    constructor(options: AtlassianAuthProviderOptions);
-    start(req: OAuthStartRequest): Promise<RedirectInfo>;
-    handler(req: express.Request): Promise<{
-        response: OAuthResponse;
-        refreshToken: string | undefined;
-    }>;
-    private handleResult;
-    refresh(req: OAuthRefreshRequest): Promise<{
-        response: OAuthResponse;
-        refreshToken: string | undefined;
-    }>;
-}
-
 /** @public */
-declare type AwsAlbResult = {
-    fullProfile: Profile;
-    expiresInSeconds?: number;
-    accessToken: string;
-};
-
 declare type BitbucketOAuthResult = {
     fullProfile: BitbucketPassportProfile;
     params: {
@@ -461,6 +451,7 @@ declare type BitbucketOAuthResult = {
     accessToken: string;
     refreshToken?: string;
 };
+/** @public */
 declare type BitbucketPassportProfile = Profile & {
     id?: string;
     displayName?: string;
@@ -554,15 +545,16 @@ declare type CloudflareAccessIdentityProfile = {
     groups: CloudflareAccessGroup[];
 };
 /**
- *
  * @public
  */
 declare type CloudflareAccessResult = {
     claims: CloudflareAccessClaims;
     cfIdentity: CloudflareAccessIdentityProfile;
     expiresInSeconds?: number;
+    token: string;
 };
 
+/** @public */
 declare type GithubOAuthResult = {
     fullProfile: Profile;
     params: {
@@ -849,6 +841,8 @@ declare const defaultAuthProviderFactories: {
  *
  * The returned object facilitates the creation of provider instances, and
  * supplies built-in sign-in resolvers for the specific provider.
+ *
+ * @public
  */
 declare function createAuthProviderIntegration<TCreateOptions extends unknown[], TResolvers extends {
     [name in string]: (...args: any[]) => SignInResolver<any>;
@@ -869,9 +863,11 @@ declare function createAuthProviderIntegration<TCreateOptions extends unknown[],
  */
 declare function prepareBackstageIdentityResponse(result: BackstageSignInResult): BackstageIdentityResponse;
 
+/** @public */
 declare type ProviderFactories = {
     [s: string]: AuthProviderFactory;
 };
+/** @public */
 interface RouterOptions {
     logger: Logger;
     database: PluginDatabaseManager;
@@ -881,12 +877,16 @@ interface RouterOptions {
     tokenFactoryAlgorithm?: string;
     providerFactories?: ProviderFactories;
 }
+/** @public */
 declare function createRouter(options: RouterOptions): Promise<express.Router>;
+/** @public */
 declare function createOriginFilter(config: Config): (origin: string) => boolean;
 
 /**
  * Payload sent as a post message after the auth request is complete.
  * If successful then has a valid payload with Auth information else contains an error.
+ *
+ * @public
  */
 declare type WebMessageResponse = {
     type: 'authorization_response';
@@ -896,18 +896,15 @@ declare type WebMessageResponse = {
     error: Error;
 };
 
+/** @public */
 declare const postMessageResponse: (res: express.Response, appOrigin: string, response: WebMessageResponse) => void;
+/** @public */
 declare const ensuresXRequestedWith: (req: express.Request) => boolean;
 
-declare type UserQuery = {
-    annotations: Record<string, string>;
-};
-declare type MemberClaimQuery = {
-    entityRefs: string[];
-    logger?: Logger;
-};
 /**
  * A catalog client tailored for reading out identity data from the catalog.
+ *
+ * @public
  */
 declare class CatalogIdentityClient {
     private readonly catalogApi;
@@ -921,7 +918,9 @@ declare class CatalogIdentityClient {
      *
      * Throws a NotFoundError or ConflictError if 0 or multiple users are found.
      */
-    findUser(query: UserQuery): Promise<UserEntity>;
+    findUser(query: {
+        annotations: Record<string, string>;
+    }): Promise<UserEntity>;
     /**
      * Resolve additional entity claims from the catalog, using the passed-in entity names. Designed
      * to be used within a `signInResolver` where additional entity claims might be provided, but
@@ -929,7 +928,10 @@ declare class CatalogIdentityClient {
      *
      * Returns a superset of the entity names that can be passed directly to `issueToken` as `ent`.
      */
-    resolveCatalogMembership(query: MemberClaimQuery): Promise<string[]>;
+    resolveCatalogMembership(query: {
+        entityRefs: string[];
+        logger?: Logger;
+    }): Promise<string[]>;
 }
 
 /**
@@ -942,4 +944,4 @@ declare class CatalogIdentityClient {
  */
 declare function getDefaultOwnershipEntityRefs(entity: Entity): string[];
 
-export { AtlassianAuthProvider, AuthHandler, AuthHandlerResult, AuthProviderConfig, AuthProviderFactory, AuthProviderRouteHandlers, AuthResolverCatalogUserQuery, AuthResolverContext, AuthResponse, AwsAlbResult, BitbucketOAuthResult, BitbucketPassportProfile, CatalogIdentityClient, CloudflareAccessClaims, CloudflareAccessGroup, CloudflareAccessIdentityProfile, CloudflareAccessResult, CookieConfigurer, GcpIapResult, GcpIapTokenInfo, GithubOAuthResult, OAuth2ProxyResult, OAuthAdapter, OAuthEnvironmentHandler, OAuthHandlers, OAuthProviderInfo, OAuthProviderOptions, OAuthRefreshRequest, OAuthResponse, OAuthResult, OAuthStartRequest, OAuthState, OidcAuthResult, ProfileInfo, 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, CatalogIdentityClient, CloudflareAccessClaims, CloudflareAccessGroup, CloudflareAccessIdentityProfile, CloudflareAccessResult, CookieConfigurer, GcpIapResult, GcpIapTokenInfo, GithubOAuthResult, OAuth2ProxyResult, OAuthAdapter, OAuthAdapterOptions, OAuthEnvironmentHandler, OAuthHandlers, 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.15.2-next.0",
+  "version": "0.16.0-next.1",
   "main": "dist/index.cjs.js",
   "types": "dist/index.d.ts",
   "license": "Apache-2.0",
@@ -33,12 +33,12 @@
     "clean": "backstage-cli package clean"
   },
   "dependencies": {
-    "@backstage/backend-common": "^0.15.1-next.0",
+    "@backstage/backend-common": "^0.15.1-next.1",
     "@backstage/catalog-client": "^1.0.5-next.0",
     "@backstage/catalog-model": "^1.1.0",
     "@backstage/config": "^1.0.1",
     "@backstage/errors": "^1.1.0",
-    "@backstage/plugin-auth-node": "^0.2.5-next.0",
+    "@backstage/plugin-auth-node": "^0.2.5-next.1",
     "@backstage/types": "^1.0.0",
     "@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.28-next.0",
-    "@backstage/cli": "^0.18.2-next.0",
+    "@backstage/backend-test-utils": "^0.1.28-next.1",
+    "@backstage/cli": "^0.19.0-next.1",
     "@types/body-parser": "^1.19.0",
     "@types/cookie-parser": "^1.4.2",
     "@types/express-session": "^1.17.2",
@@ -97,5 +97,5 @@
     "config.d.ts"
   ],
   "configSchema": "config.d.ts",
-  "gitHead": "c6c0b1978a7ab4d29d813996c56beb7e6b48a268"
+  "gitHead": "64f2e93089b61902a3302933dfec197deb10506c"
 }