chore: rename signInRedirectURL to afterSignInUrl across codebase for consistency

brionmario · brionmario · commit 9b6d458e7a0b · 2025-06-09T17:21:51.000+05:30
diff --git a/docs/src/react/components/asgardeo-provider.md b/docs/src/react/components/asgardeo-provider.md
@@ -38,7 +38,7 @@ import { AsgardeoProvider } from "@asgardeo/react";
 
   - `baseURL`: The base URL of asgardeo.
 
-  - `signInRedirectURL`: The URL where users should be redirected after they sign in. This should be a page in your application.
+  - `afterSignInUrl`: The URL where users should be redirected after they sign in. This should be a page in your application.
 
   - `clientId`: The ID of your application. You get this when you register your application with Asgardeo.
 
diff --git a/docs/src/react/introduction.md b/docs/src/react/introduction.md
@@ -73,7 +73,7 @@ Then, wrap your application with the `AsgardeoProvider` and pass the basic confi
       baseUrl: "https://api.asgardeo.io/t/org_name",
       clientId: "gqtroUbA1Qsulqr*****",
       scope: ["openid", "internal_login", "profile"],
-      signInRedirectURL: "https://domain_name:8080",
+      afterSignInUrl: "https://domain_name:8080",
     }}>
     <App />
 </AsgardeoProvider>
diff --git a/packages/__legacy__/react/src/components/SignIn/SignIn.tsx b/packages/__legacy__/react/src/components/SignIn/SignIn.tsx
@@ -159,7 +159,7 @@ const SignIn: FC<SignInProps> = (props: SignInProps): ReactElement => {
           /**
            * Check the origin of the message to ensure it's from the popup window
            */
-          if (event.origin !== config.signInRedirectURL) return;
+          if (event.origin !== config.afterSignInUrl) return;
 
           const {code, state} = event.data;
 
diff --git a/packages/__legacy__/react/src/providers/AsgardeoProvider.tsx b/packages/__legacy__/react/src/providers/AsgardeoProvider.tsx
@@ -124,10 +124,10 @@ const AsgardeoProvider: FC<PropsWithChildren<AsgardeoProviderProps>> = (
       /**
        * Send the 'code' and 'state' to the parent window and close the current window (popup)
        */
-      window.opener.postMessage({code, state}, config.signInRedirectURL);
+      window.opener.postMessage({code, state}, config.afterSignInUrl);
       window.close();
     }
-  }, [config.signInRedirectURL, setAuthentication]);
+  }, [config.afterSignInUrl, setAuthentication]);
 
   const value: AuthContext = useMemo(
     () => ({
diff --git a/packages/browser/README.md b/packages/browser/README.md
@@ -28,7 +28,7 @@ import { AsgardeoAuthClient } from "@asgardeo/browser";
 
 // Initialize the auth client
 const authClient = new AsgardeoAuthClient({
-    signInRedirectURL: "https://localhost:3000",
+    afterSignInUrl: "https://localhost:3000",
     clientId: "<your_client_id>",
     baseUrl: "https://api.asgardeo.io/t/<org_name>"
 });
diff --git a/packages/browser/src/__legacy__/client.ts b/packages/browser/src/__legacy__/client.ts
@@ -217,7 +217,7 @@ export class AsgardeoSPAClient {
    * @example
    * ```
    * auth.initialize({
-   *     signInRedirectURL: "http://localhost:3000/sign-in",
+   *     afterSignInUrl: "http://localhost:3000/sign-in",
    *     clientId: "client ID",
    *     baseUrl: "https://api.asgardeo.io"
    * });
@@ -1144,7 +1144,7 @@ export class AsgardeoSPAClient {
    * @example
    * ```
    * const config = {
-   *     signInRedirectURL: "http://localhost:3000/sign-in",
+   *     afterSignInUrl: "http://localhost:3000/sign-in",
    *     clientId: "client ID",
    *     baseUrl: "https://api.asgardeo.io"
    * }
diff --git a/packages/browser/src/__legacy__/helpers/authentication-helper.ts b/packages/browser/src/__legacy__/helpers/authentication-helper.ts
@@ -95,7 +95,7 @@ export class AuthenticationHelper<T extends MainThreadClientConfig | WebWorkerCl
       getSessionState,
       config.checkSessionInterval ?? 3,
       config.sessionRefreshInterval ?? 300,
-      config.signInRedirectURL,
+      config.afterSignInUrl,
       getAuthzURL,
     );
   }
diff --git a/packages/browser/src/__legacy__/models/client.ts b/packages/browser/src/__legacy__/models/client.ts
@@ -50,7 +50,7 @@ export interface MainThreadClientInterface {
     config?: SignInConfig,
     authorizationCode?: string,
     sessionState?: string,
-    signInRedirectURL?: string,
+    afterSignInUrl?: string,
     tokenRequestConfig?: {
       params: Record<string, unknown>;
     },
@@ -87,7 +87,7 @@ export interface WebWorkerClientInterface {
     params?: SignInConfig,
     authorizationCode?: string,
     sessionState?: string,
-    signInRedirectURL?: string,
+    afterSignInUrl?: string,
     tokenRequestConfig?: {
       params: Record<string, unknown>;
     },
diff --git a/packages/browser/src/__legacy__/models/web-worker.ts b/packages/browser/src/__legacy__/models/web-worker.ts
@@ -45,7 +45,7 @@ export interface WebWorkerCoreInterface {
   httpRequestAll(configs: HttpRequestConfig[]): Promise<HttpResponse[] | undefined>;
   enableHttpHandler(): void;
   disableHttpHandler(): void;
-  getAuthorizationURL(params?: AuthorizeRequestUrlParams, signInRedirectURL?: string): Promise<AuthorizationResponse>;
+  getAuthorizationURL(params?: AuthorizeRequestUrlParams, afterSignInUrl?: string): Promise<AuthorizationResponse>;
   requestAccessToken(
     authorizationCode?: string,
     sessionState?: string,
diff --git a/packages/javascript/README.md b/packages/javascript/README.md
@@ -28,7 +28,7 @@ import { AsgardeoAuth } from "@asgardeo/javascript";
 
 // Initialize the auth instance
 const auth = new AsgardeoAuth({
-    signInRedirectURL: "https://localhost:3000",
+    afterSignInUrl: "https://localhost:3000",
     clientId: "<your_client_id>",
     baseUrl: "https://api.asgardeo.io/t/<org_name>"
 });
diff --git a/packages/javascript/src/__legacy__/client.ts b/packages/javascript/src/__legacy__/client.ts
@@ -102,7 +102,7 @@ export class AsgardeoAuthClient<T> {
    *
    * @example
    * const config = \{
-   *     signInRedirectURL: "http://localhost:3000/sign-in",
+   *     afterSignInUrl: "http://localhost:3000/sign-in",
    *     clientId: "client ID",
    *     baseUrl: "https://localhost:9443"
    * \}
@@ -249,7 +249,7 @@ export class AsgardeoAuthClient<T> {
 
       const authorizeRequestParams: Map<string, string> = getAuthorizeRequestUrlParams(
         {
-          redirectUri: configData.signInRedirectURL,
+          redirectUri: configData.afterSignInUrl,
           clientId: configData.clientId,
           scope: configData.scope as unknown as any,
           responseMode: configData.responseMode,
@@ -348,7 +348,7 @@ export class AsgardeoAuthClient<T> {
       body.set('code', code);
 
       body.set('grant_type', 'authorization_code');
-      body.set('redirect_uri', configData.signInRedirectURL);
+      body.set('redirect_uri', configData.afterSignInUrl);
 
       if (tokenRequestConfig?.params) {
         Object.entries(tokenRequestConfig.params).forEach(([key, value]: [key: string, value: unknown]) => {
@@ -510,7 +510,7 @@ export class AsgardeoAuthClient<T> {
       );
     }
 
-    const callbackURL: string = configData?.signOutRedirectURL ?? configData?.signInRedirectURL;
+    const callbackURL: string = configData?.signOutRedirectURL ?? configData?.afterSignInUrl;
 
     if (!callbackURL || callbackURL.trim().length === 0) {
       throw new AsgardeoAuthException(
@@ -1118,7 +1118,7 @@ export class AsgardeoAuthClient<T> {
    * @example
    * ```
    * const config = {
-   *     signInRedirectURL: "http://localhost:3000/sign-in",
+   *     afterSignInUrl: "http://localhost:3000/sign-in",
    *     clientId: "client ID",
    *     baseUrl: "https://localhost:9443"
    * }
diff --git a/packages/javascript/src/__legacy__/models/client-config.ts b/packages/javascript/src/__legacy__/models/client-config.ts
@@ -20,7 +20,7 @@ import {OAuthResponseMode} from '../../models/oauth-response';
 import {OIDCEndpoints} from '../../models/oidc-endpoints';
 
 export interface DefaultAuthClientConfig {
-  signInRedirectURL: string;
+  afterSignInUrl: string;
   signOutRedirectURL?: string;
   clientHost?: string;
   clientId: string;
diff --git a/packages/nextjs/src/AsgardeoNextClient.ts b/packages/nextjs/src/AsgardeoNextClient.ts
@@ -60,7 +60,7 @@ class AsgardeoNextClient<T extends AsgardeoNextConfig = AsgardeoNextConfig> exte
       baseUrl,
       clientId: clientId,
       clientSecret,
-      signInRedirectURL: afterSignInUrl,
+      afterSignInUrl: afterSignInUrl,
     } as any);
   }
 
diff --git a/packages/node/src/__legacy__/client.ts b/packages/node/src/__legacy__/client.ts
@@ -49,7 +49,7 @@ export class AsgardeoNodeClient<T> {
     * ```
     * const _store: Storage = new DataStore();
     * const _config = {
-           signInRedirectURL: "http://localhost:3000/sign-in",
+           afterSignInUrl: "http://localhost:3000/sign-in",
            signOutRedirectURL: "http://localhost:3000/dashboard",
            clientId: "client ID",
            serverOrigin: "https://api.asgardeo.io/t/<org_name>"
diff --git a/packages/nuxt/src/module.ts b/packages/nuxt/src/module.ts
@@ -32,7 +32,7 @@ export default defineNuxtModule<ModuleOptions>({
     clientId: process.env.ASGARDEO_CLIENT_ID || '',
     clientSecret: process.env.ASGARDEO_CLIENT_SECRET || '',
     scope: ['openid', 'profile'],
-    signInRedirectURL: process.env.ASGARDEO_SIGN_IN_REDIRECT_URL || '',
+    afterSignInUrl: process.env.ASGARDEO_SIGN_IN_REDIRECT_URL || '',
     signOutRedirectURL: process.env.ASGARDEO_SIGN_OUT_REDIRECT_URL || '',
   },
   meta: {
@@ -50,7 +50,7 @@ export default defineNuxtModule<ModuleOptions>({
         enablePKCE: true,
         scope: ['openid', 'profile'],
         serverOrigin: process.env.ASGARDEO_BASE_URL,
-        signInRedirectURL: process.env.ASGARDEO_SIGN_IN_REDIRECT_URL || '',
+        afterSignInUrl: process.env.ASGARDEO_SIGN_IN_REDIRECT_URL || '',
         signOutRedirectURL: process.env.ASGARDEO_SIGN_OUT_REDIRECT_URL || '',
       },
     ) as ModuleOptions;
@@ -66,7 +66,7 @@ export default defineNuxtModule<ModuleOptions>({
       clientSecret: options.clientSecret,
       scope: options.scope,
       serverOrigin: options.baseUrl,
-      signInRedirectURL: options.signInRedirectURL,
+      afterSignInUrl: options.afterSignInUrl,
       signOutRedirectURL: options.signOutRedirectURL,
     });
 
@@ -102,7 +102,7 @@ export default defineNuxtModule<ModuleOptions>({
 
 declare module '@nuxt/schema' {
   interface PublicRuntimeConfig {
-    asgardeoAuth: Pick<ModuleOptions, 'clientId' | 'baseUrl' | 'signInRedirectURL' | 'signOutRedirectURL' | 'scope'>;
+    asgardeoAuth: Pick<ModuleOptions, 'clientId' | 'baseUrl' | 'afterSignInUrl' | 'signOutRedirectURL' | 'scope'>;
   }
 
   interface RuntimeConfig {
diff --git a/packages/nuxt/src/runtime/types.ts b/packages/nuxt/src/runtime/types.ts
@@ -49,7 +49,7 @@ export interface ModuleOptions {
    * Must match the URI configured in your Asgardeo app.
    * @default process.env.ASGARDEO_SIGN_IN_REDIRECT_URL
    */
-  signInRedirectURL: string;
+  afterSignInUrl: string;
   /**
    * The absolute URI to redirect to after sign-out completes.
    * @default process.env.ASGARDEO_SIGN_OUT_REDIRECT_URL
diff --git a/packages/react/src/AsgardeoReactClient.ts b/packages/react/src/AsgardeoReactClient.ts
@@ -50,7 +50,7 @@ class AsgardeoReactClient<T extends AsgardeoReactConfig = AsgardeoReactConfig> e
     return this.asgardeo.init({
       baseUrl: config.baseUrl,
       clientId: config.clientId,
-      signInRedirectURL: config.afterSignInUrl,
+      afterSignInUrl: config.afterSignInUrl,
       scope: [...scopes, 'internal_login'],
     });
   }
diff --git a/packages/vue/README.md b/packages/vue/README.md
@@ -32,7 +32,7 @@ import { AsgardeoAuth } from '@asgardeo/vue'
 const app = createApp(App)
 
 app.use(AsgardeoAuth, {
-  signInRedirectURL: "http://localhost:3000",
+  afterSignInUrl: "http://localhost:3000",
   signOutRedirectURL: "http://localhost:3000",
   clientId: "<your-client-id>",
   baseUrl: "https://api.asgardeo.io/t/<org-name>",
diff --git a/packages/vue/src/plugins/AsgardeoPlugin.ts b/packages/vue/src/plugins/AsgardeoPlugin.ts
@@ -116,7 +116,7 @@ export const asgardeoPlugin: Plugin = {
 
             if (
               (SPAUtils.hasAuthSearchParamsInURL() &&
-                new URL(url.origin + url.pathname).toString() === new URL(config?.signInRedirectURL).toString()) ||
+                new URL(url.origin + url.pathname).toString() === new URL(config?.afterSignInUrl).toString()) ||
               authParams?.authorizationCode ||
               url.searchParams.get('error')
             ) {
diff --git a/packages/vue/src/tests/AsgardeoPlugin.test.ts b/packages/vue/src/tests/AsgardeoPlugin.test.ts
@@ -73,7 +73,7 @@ describe('asgardeoPlugin', () => {
         clientId: 'mock-client-id',
         disableAutoSignIn: true,
         disableTrySignInSilently: true,
-        signInRedirectURL: 'http://localhost:5173/',
+        afterSignInUrl: 'http://localhost:5173/',
         signOutRedirectURL: 'http://localhost:5173/',
       }),
     );
diff --git a/packages/vue/src/tests/auth-api.test.ts b/packages/vue/src/tests/auth-api.test.ts
@@ -71,7 +71,7 @@ describe('AuthAPI', () => {
       const config: AuthVueConfig = {
         baseUrl: 'https://api.asgardeo.io/t/mock-tenant',
         clientId: 'mock-client-id',
-        signInRedirectURL: 'http://localhost:5173/',
+        afterSignInUrl: 'http://localhost:5173/',
         signOutRedirectURL: 'http://localhost:5173/',
       };
 
diff --git a/packages/vue/src/tests/mocks/mocks.ts b/packages/vue/src/tests/mocks/mocks.ts
@@ -201,6 +201,6 @@ export const asgardeoAuthSPAMock: any = {
 export const mockConfig: AuthVueConfig = {
   baseUrl: 'https://api.asgardeo.io/t/mock-tenant',
   clientId: 'mock-client-id',
-  signInRedirectURL: 'http://localhost:5173/',
+  afterSignInUrl: 'http://localhost:5173/',
   signOutRedirectURL: 'http://localhost:5173/',
 };
diff --git a/recipes/__legacy__/react-vite/src/main.tsx b/recipes/__legacy__/react-vite/src/main.tsx
@@ -1,25 +1,25 @@
-import ReactDOM from "react-dom/client";
-import App from "./App.tsx";
-import { AsgardeoProvider, UIAuthConfig } from "@asgardeo/react";
+import ReactDOM from 'react-dom/client';
+import App from './App.tsx';
+import {AsgardeoProvider, UIAuthConfig} from '@asgardeo/react';
 
 const envVariables = import.meta.env;
 
 const config: UIAuthConfig = {
   baseUrl: envVariables.VITE_BASE_URL,
   clientId: envVariables.VITE_CLIENT_ID,
-  scope: envVariables.VITE_SCOPE?.split(","),
-  signInRedirectURL: envVariables.VITE_SIGN_IN_REDIRECT_URL,
+  scope: envVariables.VITE_SCOPE?.split(','),
+  afterSignInUrl: envVariables.VITE_SIGN_IN_REDIRECT_URL,
 };
 
-ReactDOM.createRoot(document.getElementById("root")!).render(
+ReactDOM.createRoot(document.getElementById('root')!).render(
   <AsgardeoProvider
     config={config}
     branding={{
       preference: {
-        theme: { LIGHT: { colors: { primary: { main: "#111111" } } } },
+        theme: {LIGHT: {colors: {primary: {main: '#111111'}}}},
       },
     }}
   >
     <App />
-  </AsgardeoProvider>
+  </AsgardeoProvider>,
 );
diff --git a/recipes/nuxt-vite/server/api/auth/[...].ts b/recipes/nuxt-vite/server/api/auth/[...].ts
@@ -2,7 +2,7 @@ const config = {
   baseUrl: process.env.ASGARDEO_BASE_URL as string,
   clientId: process.env.ASGARDEO_CLIENT_ID as string,
   clientSecret: process.env.ASGARDEO_CLIENT_SECRET as string,
-  signInRedirectURL: process.env.ASGARDEO_SIGN_IN_REDIRECT_URL as string,
+  afterSignInUrl: process.env.ASGARDEO_SIGN_IN_REDIRECT_URL as string,
   signOutRedirectURL: process.env.ASGARDEO_SIGN_OUT_REDIRECT_URL as string,
   scope: process.env.ASGARDEO_SCOPE?.split(',').map(scope => scope.trim()) as string[],
 };
diff --git a/recipes/vue-vite/README.md b/recipes/vue-vite/README.md
@@ -32,7 +32,7 @@ const app = createApp(App);
 
 app.use(router);
 app.use(asgardeoPlugin, {
-  signInRedirectURL: "http://localhost:5173/",
+  afterSignInUrl: "http://localhost:5173/",
   signOutRedirectURL: "http://localhost:5173/",
   clientId: "<ADD_CLIENT_ID_HERE>",
   baseUrl: "https://api.asgardeo.io/t/<org_name>",
@@ -63,7 +63,7 @@ By default, the Vite development server runs on port `5173`. In case you wish to
    })
    ```
 
-2. Update the `signInRedirectURL` & `signOutRedirectURL` in `main.ts` to match your new port.
+2. Update the `afterSignInUrl` & `signOutRedirectURL` in `main.ts` to match your new port.
 
 3. Go to the Asgardeo Console and navigate to the protocol tab of your application:
    - Update the Authorized Redirect URL.
diff --git a/recipes/vue-vite/src/main.ts b/recipes/vue-vite/src/main.ts
@@ -29,7 +29,7 @@ const config: AuthVueConfig = {
   baseUrl: import.meta.env.VITE_ASGARDEO_BASE_URL,
   clientId: import.meta.env.VITE_ASGARDEO_CLIENT_ID,
   scope: ['openid', 'profile', 'email'],
-  signInRedirectURL: import.meta.env.VITE_ASGARDEO_SIGN_IN_REDIRECT_URL,
+  afterSignInUrl: import.meta.env.VITE_ASGARDEO_SIGN_IN_REDIRECT_URL,
   signOutRedirectURL: import.meta.env.VITE_ASGARDEO_SIGN_OUT_REDIRECT_URL,
 }
 

Original file line number	Diff line number	Diff line change
`@@ -95,7 +95,7 @@ export class AuthenticationHelper<T extends MainThreadClientConfig \| WebWorkerCl`
`95`	`95`	`getSessionState,`
`96`	`96`	`config.checkSessionInterval ?? 3,`
`97`	`97`	`config.sessionRefreshInterval ?? 300,`
`98`		`- config.signInRedirectURL,`
	`98`	`+ config.afterSignInUrl,`
`99`	`99`	`getAuthzURL,`
`100`	`100`	`);`
`101`	`101`	`}`