Add getAuthOptions to expose resolve options for client

Author: andrew-propelauth

package.json

@@ -5,7 +5,7 @@
         "type": "git",
         "url": "https://github.com/PropelAuth/javascript"
     },
-    "version": "2.0.23",
+    "version": "2.0.24",
     "keywords": [
         "auth",
         "user",

src/client.ts

@@ -163,6 +163,11 @@ export interface IAuthClient {
      * Cleanup the auth client if you no longer need it.
      */
     destroy(): void
+
+    /**
+     * Returns the auth options with all default values filled in.
+     */
+    getAuthOptions(): IResolvedAuthOptions
 }
 
 export interface IAuthOptions {
@@ -195,12 +200,20 @@ export interface IAuthOptions {
     /**
      * If true, disables the token refresh on initial page load.
      * Can help reduce duplicate token refresh requests.
-     * 
+     *
      * Default false
      */
     skipInitialFetch?: boolean
 }
 
+export interface IResolvedAuthOptions {
+    authUrl: string
+    enableBackgroundTokenRefresh: boolean
+    minSecondsBeforeRefresh: number
+    disableRefreshOnFocus: boolean
+    skipInitialFetch: boolean
+}
+
 interface AccessTokenActiveOrgMap {
     [orgId: string]: {
         accessToken: string
@@ -626,6 +639,16 @@ export function createClient(authOptions: IAuthOptions): IAuthClient {
                 clearInterval(clientState.refreshInterval)
             }
         },
+
+        getAuthOptions(): IResolvedAuthOptions {
+            return {
+                authUrl: clientState.authUrl,
+                enableBackgroundTokenRefresh: authOptions.enableBackgroundTokenRefresh!,
+                minSecondsBeforeRefresh: minSecondsBeforeRefresh,
+                disableRefreshOnFocus: authOptions.disableRefreshOnFocus ?? false,
+                skipInitialFetch: authOptions.skipInitialFetch ?? false,
+            }
+        },
     }
 
     const onStorageChange = async function () {

src/index.ts

@@ -5,6 +5,7 @@ export type {
     AccessTokenForActiveOrg,
     IAuthClient,
     IAuthOptions,
+    IResolvedAuthOptions,
     RedirectToAccountOptions,
     RedirectToCreateOrgOptions,
     RedirectToLoginOptions,

src/tests/index.test.ts

@@ -69,6 +69,44 @@ afterAll(() => {
     jest.useRealTimers()
 })
 
+test("getAuthOptions returns defaults when no options provided", () => {
+    let client = createClient({ authUrl: "https://www.example.com", enableBackgroundTokenRefresh: false })
+
+    const options = client.getAuthOptions()
+
+    expect(options.authUrl).toBe("https://www.example.com")
+    expect(options.enableBackgroundTokenRefresh).toBe(false)
+    expect(options.minSecondsBeforeRefresh).toBe(120)
+    expect(options.disableRefreshOnFocus).toBe(false)
+    expect(options.skipInitialFetch).toBe(false)
+})
+
+test("getAuthOptions returns user-provided values", () => {
+    let client = createClient({
+        authUrl: "https://www.example.com",
+        enableBackgroundTokenRefresh: false,
+        minSecondsBeforeRefresh: 300,
+        disableRefreshOnFocus: true,
+        skipInitialFetch: true,
+    })
+
+    const options = client.getAuthOptions()
+
+    expect(options.authUrl).toBe("https://www.example.com")
+    expect(options.enableBackgroundTokenRefresh).toBe(false)
+    expect(options.minSecondsBeforeRefresh).toBe(300)
+    expect(options.disableRefreshOnFocus).toBe(true)
+    expect(options.skipInitialFetch).toBe(true)
+})
+
+test("getAuthOptions returns normalized authUrl", () => {
+    let client = createClient({ authUrl: "https://www.example.com/path/to/something", enableBackgroundTokenRefresh: false })
+
+    const options = client.getAuthOptions()
+
+    expect(options.authUrl).toBe("https://www.example.com")
+})
+
 test("cannot create client without auth url origin", () => {
     expect(() => {
         createClient({ authUrl: "" })