@auth0/auth0-react 2.0.0-beta.0 → 2.0.1

package/package.json

@@ -1,7 +1,7 @@
 {
   "author": "Auth0",
   "name": "@auth0/auth0-react",
-  "version": "2.0.0-beta.0",
+  "version": "2.0.1",
   "description": "Auth0 SDK for React Single Page Applications (SPA)",
   "keywords": [
     "auth0",
@@ -101,6 +101,6 @@
     }
   },
   "dependencies": {
-    "@auth0/auth0-spa-js": "^2.0.1"
+    "@auth0/auth0-spa-js": "^2.0.4"
   }
 }

package/src/auth0-provider.tsx

@@ -21,7 +21,12 @@ import Auth0Context, {
   LogoutOptions,
   RedirectLoginOptions,
 } from './auth0-context';
-import { hasAuthParams, loginError, tokenError } from './utils';
+import {
+  hasAuthParams,
+  loginError,
+  tokenError,
+  deprecateRedirectUri,
+} from './utils';
 import { reducer } from './reducer';
 import { initialAuthState } from './auth-state';
 
@@ -93,6 +98,8 @@ declare const __VERSION__: string;
 const toAuth0ClientOptions = (
   opts: Auth0ProviderOptions
 ): Auth0ClientOptions => {
+  deprecateRedirectUri(opts);
+
   return {
     ...opts,
     auth0Client: {
@@ -118,7 +125,7 @@ const defaultOnRedirectCallback = (appState?: AppState): void => {
  * <Auth0Provider
  *   domain={domain}
  *   clientId={clientId}
- *   redirectUri={window.location.origin}>
+ *   authorizationParams={{ redirect_uri: window.location.origin }}}>
  *   <MyApp />
  * </Auth0Provider>
  * ```
@@ -163,8 +170,11 @@ const Auth0Provider = (opts: Auth0ProviderOptions): JSX.Element => {
   }, [client, onRedirectCallback, skipRedirectCallback]);
 
   const loginWithRedirect = useCallback(
-    (opts?: RedirectLoginOptions): Promise<void> =>
-      client.loginWithRedirect(opts),
+    (opts?: RedirectLoginOptions): Promise<void> => {
+      deprecateRedirectUri(opts);
+
+      return client.loginWithRedirect(opts);
+    },
     [client]
   );
 

package/src/utils.tsx

@@ -8,18 +8,46 @@ export const hasAuthParams = (searchParams = window.location.search): boolean =>
   (CODE_RE.test(searchParams) || ERROR_RE.test(searchParams)) &&
   STATE_RE.test(searchParams);
 
-const normalizeErrorFn = (fallbackMessage: string) => (
-  error: Error | { error: string; error_description?: string } | ProgressEvent
-): Error => {
-  if ('error' in error) {
-    return new OAuthError(error.error, error.error_description);
-  }
-  if (error instanceof Error) {
-    return error;
-  }
-  return new Error(fallbackMessage);
-};
+const normalizeErrorFn =
+  (fallbackMessage: string) =>
+  (
+    error: Error | { error: string; error_description?: string } | ProgressEvent
+  ): Error => {
+    if ('error' in error) {
+      return new OAuthError(error.error, error.error_description);
+    }
+    if (error instanceof Error) {
+      return error;
+    }
+    return new Error(fallbackMessage);
+  };
 
 export const loginError = normalizeErrorFn('Login failed');
 
 export const tokenError = normalizeErrorFn('Get access token failed');
+
+/**
+ * @ignore
+ * Helper function to map the v1 `redirectUri` option to the v2 `authorizationParams.redirect_uri`
+ * and log a warning.
+ */
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export const deprecateRedirectUri = (options?: any) => {
+  if (options?.redirectUri) {
+    console.warn(
+      'Using `redirectUri` has been deprecated, please use `authorizationParams.redirect_uri` instead as `redirectUri` will be no longer supported in a future version'
+    );
+    options.authorizationParams = options.authorizationParams || {};
+    options.authorizationParams.redirect_uri = options.redirectUri;
+    delete options.redirectUri;
+  }
+
+  if (options?.authorizationParams?.redirectUri) {
+    console.warn(
+      'Using `authorizationParams.redirectUri` has been deprecated, please use `authorizationParams.redirect_uri` instead as `authorizationParams.redirectUri` will be removed in a future version'
+    );
+    options.authorizationParams.redirect_uri =
+      options.authorizationParams.redirectUri;
+    delete options.authorizationParams.redirectUri;
+  }
+};