From 147648a2d105a4d242861dcbe7129ab6ada3878b Mon Sep 17 00:00:00 2001
From: Jonah Back <jback@legalzoom.com>
Date: Mon, 18 Jan 2021 14:12:12 -0800
Subject: [PATCH] Update type definition and docs to be clear about
 experimental status

---
 plugins/auth-backend/src/providers/types.ts | 9 +++++++--
 1 file changed, 7 insertions(+), 2 deletions(-)

diff --git a/plugins/auth-backend/src/providers/types.ts b/plugins/auth-backend/src/providers/types.ts
index a31ef85a7d..1a4e7b118a 100644
--- a/plugins/auth-backend/src/providers/types.ts
+++ b/plugins/auth-backend/src/providers/types.ts
@@ -112,7 +112,12 @@ export interface AuthProviderRouteHandlers {
   logout?(req: express.Request, res: express.Response): Promise<void>;
 }
 
-export type IdentityResolver = (
+/**
+ * EXPERIMENTAL - this will almost certainly break in a future release.
+ *
+ * Used to resolve an identity from auth information in some auth providers.
+ */
+export type ExperimentalIdentityResolver = (
   /**
    * An object containing information specific to the auth provider.
    */
@@ -128,7 +133,7 @@ export type AuthProviderFactoryOptions = {
   tokenIssuer: TokenIssuer;
   discovery: PluginEndpointDiscovery;
   catalogApi: CatalogApi;
-  identityResolver?: IdentityResolver;
+  identityResolver?: ExperimentalIdentityResolver;
 };
 
 export type AuthProviderFactory = (