chore(core): flat AuthRuntimeConfig type

halvaradop · halvaradop · commit 0d17ee7f5458 · 2026-01-06T17:45:44.000-05:00
diff --git a/packages/core/src/@types/index.ts b/packages/core/src/@types/index.ts
@@ -193,27 +193,21 @@ export interface JoseInstance {
     decryptJWE: (payload: string) => Promise<string>
 }
 
-/**
- * Internal runtime configuration used within Aura Auth after initialization.
- * All optional fields from AuthConfig are resolved to their default values.
- * @internal
- * @todo: is this needed?
- */
-export interface AuthRuntimeConfig {
-    oauth: Record<LiteralUnion<BuiltInOAuthProvider>, OAuthProviderCredentials>
-    cookies: CookieConfig
-    secret: string
-    jose: JoseInstance
-}
-
 export interface RouterGlobalContext {
     oauth: Record<LiteralUnion<BuiltInOAuthProvider>, OAuthProviderCredentials>
     cookies: CookieStoreConfig
     jose: JoseInstance
+    secret?: string
     basePath: string
     trustedProxyHeaders: boolean
 }
 
+/**
+ * Internal runtime configuration used within Aura Auth after initialization.
+ * All optional fields from AuthConfig are resolved to their default values.
+ */
+export type AuthRuntimeConfig = RouterGlobalContext
+
 export interface AuthInstance {
     handlers: {
         GET: (request: Request) => Response | Promise<Response>
diff --git a/packages/core/src/actions/callback/callback.ts b/packages/core/src/actions/callback/callback.ts
@@ -67,7 +67,7 @@ export const callbackAction = (oauth: AuthRuntimeConfig["oauth"]) => {
             }
 
             const userInfo = await getUserInfo(oauthConfig, accessToken.access_token)
-            const sessionCookie = await createSessionCookie(userInfo as JWTPayload, jose)
+            const sessionCookie = await createSessionCookie(jose, userInfo as JWTPayload)
             const csrfToken = await createCSRF(jose)
 
             const headers = new HeadersBuilder(cacheControl)
diff --git a/packages/core/src/cookie.ts b/packages/core/src/cookie.ts
@@ -112,10 +112,11 @@ export const getSetCookie = (response: Response, cookieName: string) => {
  * Create a session cookie containing a signed and encrypted JWT, using the
  * `@aura-stack/jose` package for the encoding.
  *
+ * @param jose - Jose Instance
  * @param session - The JWT payload to be encoded in the session cookie
  * @returns The serialized session cookie string
  */
-export const createSessionCookie = async (session: JWTPayload, jose: AuthRuntimeConfig["jose"]) => {
+export const createSessionCookie = async (jose: AuthRuntimeConfig["jose"], session: JWTPayload) => {
     try {
         const encoded = await jose.encodeJWT(session)
         return encoded
diff --git a/packages/core/src/index.ts b/packages/core/src/index.ts
@@ -28,6 +28,7 @@ const createInternalConfig = (authConfig?: AuthConfig): RouterConfig => {
             oauth: createBuiltInOAuthProviders(authConfig?.oauth),
             cookies: {} as CookieStoreConfig,
             jose: createJoseInstance(authConfig?.secret),
+            secret: authConfig?.secret,
             basePath: authConfig?.basePath ?? "/auth",
             trustedProxyHeaders: !!authConfig?.trustedProxyHeaders,
         },
diff --git a/packages/core/src/oauth/discord.ts b/packages/core/src/oauth/discord.ts
@@ -49,12 +49,15 @@ export interface DiscordProfile {
 }
 
 /**
+ * Discord OAuth Provider
+ * 
  * @see [Discord - Applications](https://discord.com/developers/applications)
  * @see [Discord - OAuth2](https://discord.com/developers/docs/topics/oauth2)
  * @see [Discord - Get Current User](https://discord.com/developers/docs/resources/user#get-current-user)
  * @see [Discord - User Object](https://discord.com/developers/docs/resources/user#user-object)
  * @see [Discord - OAuth2 Scopes](https://discord.com/developers/docs/topics/oauth2#shared-resources-oauth2-scopes)
  * @see [Discord - Image Formatting](https://discord.com/developers/docs/reference#image-formatting)
+ * @see [Discord - Display Names](https://discord.com/developers/docs/change-log#display-names)
  */
 export const discord: OAuthProviderConfig<DiscordProfile> = {
     id: "discord",
@@ -75,7 +78,6 @@ export const discord: OAuthProviderConfig<DiscordProfile> = {
         }
         return {
             sub: profile.id,
-            // https://discord.com/developers/docs/change-log#display-names
             name: profile.global_name ?? profile.username,
             email: profile.email ?? "",
             image,
diff --git a/packages/core/src/oauth/figma.ts b/packages/core/src/oauth/figma.ts
@@ -11,6 +11,7 @@ export interface FigmaProfile {
 }
 
 /**
+ * Figma OAuth Provider
  * @see [Figma - REST API Introduction](https://developers.figma.com/docs/rest-api/)
  * @see [Figma - OAuth App](https://www.figma.com/developers/apps/)
  * @see [Figma - Create an OAuth App](https://developers.figma.com/docs/rest-api/authentication/#create-an-oauth-app)
diff --git a/packages/core/src/oauth/github.ts b/packages/core/src/oauth/github.ts
@@ -54,6 +54,7 @@ export interface GitHubProfile {
 
 /**
  * GitHub OAuth Provider
+ * 
  * @see [GitHub - Creating an OAuth App](https://docs.github.com/en/developers/apps/building-oauth-apps/creating-an-oauth-app)
  * @see [GitHub - Authorizing OAuth Apps](https://docs.github.com/en/developers/apps/building-oauth-apps/authorizing-oauth-apps)
  * @see [GitHub - Configure your GitHub OAuth Apps](https://github.com/settings/developers)
diff --git a/packages/core/src/oauth/gitlab.ts b/packages/core/src/oauth/gitlab.ts
@@ -54,6 +54,8 @@ export interface GitLabProfile {
 }
 
 /**
+ * GitLab OAuth Provider
+ * 
  * @see [GitLab - Applications](https://gitlab.com/-/user_settings/applications)
  * @see [GitLab - OAuth 2.0 identify provider API](https://docs.gitlab.com/api/oauth2/)
  * @see [GitLab - Scopes](https://docs.gitlab.com/integration/oauth_provider/#view-all-authorized-applications)
diff --git a/packages/core/src/oauth/spotify.ts b/packages/core/src/oauth/spotify.ts
@@ -28,6 +28,8 @@ export interface SpotifyProfile {
 }
 
 /**
+ * Spotify OAuth Provider
+ * 
  * @see [Spotify - Spotify Developer Dashboard](https://developer.spotify.com/dashboard)
  * @see [Spotify - Getting started with Web API](https://developer.spotify.com/documentation/web-api/tutorials/getting-started)
  * @see [Spotify - Get Current User's Profile](https://developer.spotify.com/documentation/web-api/reference/get-current-users-profile)
diff --git a/packages/core/src/oauth/strava.ts b/packages/core/src/oauth/strava.ts
@@ -66,6 +66,7 @@ export interface StravaProfile {
 }
 
 /**
+ * Strava OAuth Provider
  * @see [Strava - Getting Started with the Strava API](https://developers.strava.com/docs/getting-started/)
  * @see [Strava - My Applications](https://www.strava.com/settings/api)
  * @see [Strava - Authentication](https://developers.strava.com/docs/authentication/)
diff --git a/packages/core/src/oauth/x.ts b/packages/core/src/oauth/x.ts
@@ -13,6 +13,7 @@ export interface XProfile {
 }
 
 /**
+ * X (Twitter) OAuth Provider
  * @see [X - Developer Portal](https://developer.x.com/en/portal/projects-and-apps)
  * @see [X - Get my User](https://docs.x.com/x-api/users/get-my-user)
  * @see [X - OAuth 2.0 Authorization Code Flow with PKCE](https://docs.x.com/fundamentals/authentication/oauth-2-0/authorization-code)

Original file line number	Diff line number	Diff line change
`@@ -67,7 +67,7 @@ export const callbackAction = (oauth: AuthRuntimeConfig["oauth"]) => {`
`67`	`67`	`}`
`68`	`68`
`69`	`69`	`const userInfo = await getUserInfo(oauthConfig, accessToken.access_token)`
`70`		`- const sessionCookie = await createSessionCookie(userInfo as JWTPayload, jose)`
	`70`	`+ const sessionCookie = await createSessionCookie(jose, userInfo as JWTPayload)`
`71`	`71`	`const csrfToken = await createCSRF(jose)`
`72`	`72`
`73`	`73`	`const headers = new HeadersBuilder(cacheControl)`
Original file line number	Diff line number	Diff line change
`@@ -11,6 +11,7 @@ export interface FigmaProfile {`
`11`	`11`	`}`
`12`	`12`
`13`	`13`	`/**`
	`14`	`+ * Figma OAuth Provider`
`14`	`15`	`* @see [Figma - REST API Introduction](https://developers.figma.com/docs/rest-api/)`
`15`	`16`	`* @see [Figma - OAuth App](https://www.figma.com/developers/apps/)`
`16`	`17`	`* @see [Figma - Create an OAuth App](https://developers.figma.com/docs/rest-api/authentication/#create-an-oauth-app)`
Original file line number	Diff line number	Diff line change
`@@ -54,6 +54,8 @@ export interface GitLabProfile {`
`54`	`54`	`}`
`55`	`55`
`56`	`56`	`/**`
	`57`	`+ * GitLab OAuth Provider`
	`58`	`+ *`
`57`	`59`	`* @see [GitLab - Applications](https://gitlab.com/-/user_settings/applications)`
`58`	`60`	`* @see [GitLab - OAuth 2.0 identify provider API](https://docs.gitlab.com/api/oauth2/)`
`59`	`61`	`* @see [GitLab - Scopes](https://docs.gitlab.com/integration/oauth_provider/#view-all-authorized-applications)`
Original file line number	Diff line number	Diff line change
`@@ -28,6 +28,8 @@ export interface SpotifyProfile {`
`28`	`28`	`}`
`29`	`29`
`30`	`30`	`/**`
	`31`	`+ * Spotify OAuth Provider`
	`32`	`+ *`
`31`	`33`	`* @see [Spotify - Spotify Developer Dashboard](https://developer.spotify.com/dashboard)`
`32`	`34`	`* @see [Spotify - Getting started with Web API](https://developer.spotify.com/documentation/web-api/tutorials/getting-started)`
`33`	`35`	`* @see [Spotify - Get Current User's Profile](https://developer.spotify.com/documentation/web-api/reference/get-current-users-profile)`
Original file line number	Diff line number	Diff line change
`@@ -66,6 +66,7 @@ export interface StravaProfile {`
`66`	`66`	`}`
`67`	`67`
`68`	`68`	`/**`
	`69`	`+ * Strava OAuth Provider`
`69`	`70`	`* @see [Strava - Getting Started with the Strava API](https://developers.strava.com/docs/getting-started/)`
`70`	`71`	`* @see [Strava - My Applications](https://www.strava.com/settings/api)`
`71`	`72`	`* @see [Strava - Authentication](https://developers.strava.com/docs/authentication/)`