Added new hook useAuthUrl (#73)

* Added new hook useAuthUrl

* Bump version & export

Author: andrew-propelauth

package.json

@@ -5,7 +5,7 @@
         "type": "git",
         "url": "https://github.com/PropelAuth/react"
     },
-    "version": "2.0.26",
+    "version": "2.0.27",
     "license": "MIT",
     "keywords": [
         "auth",

src/AuthContext.tsx

@@ -37,6 +37,9 @@ export interface InternalAuthState {
     getOrgPageUrl(orgId?: string, options?: RedirectToOrgPageOptions): string
     getCreateOrgPageUrl(options?: RedirectToCreateOrgOptions): string
     getSetupSAMLPageUrl(orgId: string, options?: RedirectToSetupSAMLPageOptions): string
+
+    authUrl: string
+
     tokens: Tokens
     refreshAuthInfo: () => Promise<void>
     defaultDisplayWhileLoading?: React.ReactElement
@@ -201,6 +204,7 @@ export const AuthProvider = (props: AuthProviderProps) => {
         getOrgPageUrl,
         getCreateOrgPageUrl,
         getSetupSAMLPageUrl,
+        authUrl,
         refreshAuthInfo,
         tokens: {
             getAccessTokenForOrg,

src/AuthContextForTesting.tsx

@@ -26,6 +26,7 @@ export type AuthProviderForTestingProps = {
     loading?: boolean
     userInformation?: UserInformationForTesting
     activeOrgFn?: () => string | null
+    authUrl?: string
     children?: React.ReactNode
 }
 
@@ -37,6 +38,7 @@ export const AuthProviderForTesting = ({
     loading,
     userInformation,
     activeOrgFn,
+    authUrl,
     children,
 }: AuthProviderForTestingProps) => {
     const authInfo = getAuthInfoForTesting(userInformation)
@@ -70,6 +72,7 @@ export const AuthProviderForTesting = ({
         getOrgPageUrl: () => "",
         getCreateOrgPageUrl: () => "",
         getSetupSAMLPageUrl: () => "",
+        authUrl: authUrl ?? "https://auth.example.com",
         activeOrgFn: activeOrgFnWithDefault,
         refreshAuthInfo: () => Promise.resolve(),
         tokens: {

src/hooks/useAuthUrl.tsx

@@ -0,0 +1,11 @@
+import { useContext } from "react"
+import { AuthContext } from "../AuthContext"
+
+export function useAuthUrl() {
+    const context = useContext(AuthContext)
+    if (context === undefined) {
+        throw new Error("useAuthUrl must be used within an AuthProvider or RequiredAuthProvider")
+    }
+    const { authUrl } = context
+    return authUrl
+}

src/index.tsx

@@ -31,6 +31,7 @@ export type {
 } from "./hooks/additionalHooks"
 export { loadOrgSelectionFromLocalStorage, saveOrgSelectionToLocalStorage, useActiveOrg } from "./hooks/useActiveOrg"
 export { useAuthInfo } from "./hooks/useAuthInfo"
+export { useAuthUrl } from "./hooks/useAuthUrl"
 export { useHostedPageUrls } from "./hooks/useHostedPageUrls"
 export { useLogoutFunction } from "./hooks/useLogoutFunction"
 export { RedirectToLogin, RedirectToSignup, useRedirectFunctions } from "./hooks/useRedirectFunctions"