fix(oauth): add generic OAuthConfig type (#18)

* fix(oauth): add generic OAuhtConfig type * fix(oauth): use generic OAuthConfig type * fix(oauth/battlenet): use oauthconfig type * chore: revert some formatting changes * refactor: expose `OAuthConfig` type from `#auth-utils` --------- Co-authored-by: Daniel Roe <[email protected]>
atinux · Nov 20, 2023 · 5b060b8 · 5b060b8
1 parent 13daa78
commit 5b060b8
Show file tree

Hide file tree

Showing 13 changed files with 39 additions and 61 deletions.
diff --git a/README.md b/README.md
@@ -108,14 +108,15 @@ await clearUserSession(event)
 const session = await requireUserSession(event)
 ```
 
-You can define the type for your user session by creating a type declaration file (for example, `auth.d.ts`) in your project:
+You can define the type for your user session by creating a type declaration file (for example, `auth.d.ts`) in your project to augment the `UserSession` type:
 
 ```ts
 declare module '#auth-utils' {
   interface UserSession {
     // define the type here
   }
 }
+export {}
 ```
 
 ### OAuth Event Handlers

diff --git a/playground/auth.d.ts b/playground/auth.d.ts
@@ -12,3 +12,5 @@ declare module '#auth-utils' {
     loggedInAt: number
   }
 }
+
+export {}
diff --git a/src/module.ts b/src/module.ts
@@ -22,7 +22,7 @@ export default defineNuxtModule<ModuleOptions>({
       console.log(`NUXT_SESSION_PASSWORD=${randomPassword}`)
     }
 
-    nuxt.options.alias['#auth-utils'] = resolver.resolve('./runtime/types/auth-utils-session')
+    nuxt.options.alias['#auth-utils'] = resolver.resolve('./runtime/types/index')
 
     // App
     addImportsDir(resolver.resolve('./runtime/composables'))

diff --git a/src/runtime/server/lib/oauth/auth0.ts b/src/runtime/server/lib/oauth/auth0.ts
@@ -1,9 +1,10 @@
-import type { H3Event, H3Error } from 'h3'
+import type { H3Event } from 'h3'
 import { eventHandler, createError, getQuery, getRequestURL, sendRedirect } from 'h3'
 import { withQuery, parsePath } from 'ufo'
 import { ofetch } from 'ofetch'
 import { defu } from 'defu'
 import { useRuntimeConfig } from '#imports'
+import type { OAuthConfig } from '#auth-utils'
 
 export interface OAuthAuth0Config {
   /**
@@ -40,13 +41,7 @@ export interface OAuthAuth0Config {
   emailRequired?: boolean
 }
 
-interface OAuthConfig {
-  config?: OAuthAuth0Config
-  onSuccess: (event: H3Event, result: { user: any, tokens: any }) => Promise<void> | void
-  onError?: (event: H3Event, error: H3Error) => Promise<void> | void
-}
-
-export function auth0EventHandler({ config, onSuccess, onError }: OAuthConfig) {
+export function auth0EventHandler({ config, onSuccess, onError }: OAuthConfig<OAuthAuth0Config>) {
   return eventHandler(async (event: H3Event) => {
     // @ts-ignore
     config = defu(config, useRuntimeConfig(event).oauth?.auth0) as OAuthAuth0Config

diff --git a/src/runtime/server/lib/oauth/battledotnet.ts b/src/runtime/server/lib/oauth/battledotnet.ts
@@ -1,10 +1,11 @@
-import type { H3Event, H3Error } from 'h3'
+import type { H3Event } from 'h3'
 import { eventHandler, createError, getQuery, getRequestURL, sendRedirect } from 'h3'
 import { ofetch } from 'ofetch'
 import { withQuery, parsePath } from 'ufo'
 import { defu } from 'defu'
 import { useRuntimeConfig } from '#imports'
 import { randomUUID } from 'crypto'
+import type { OAuthConfig } from '#auth-utils'
 
 export interface OAuthBattledotnetConfig {
   /**
@@ -43,13 +44,7 @@ export interface OAuthBattledotnetConfig {
   tokenURL?: string
 }
 
-interface OAuthConfig {
-  config?: OAuthBattledotnetConfig
-  onSuccess: (event: H3Event, result: { user: any, tokens: any }) => Promise<void> | void
-  onError?: (event: H3Event, error: H3Error) => Promise<void> | void
-}
-
-export function battledotnetEventHandler({ config, onSuccess, onError }: OAuthConfig) {
+export function battledotnetEventHandler({ config, onSuccess, onError }: OAuthConfig<OAuthBattledotnetConfig>) {
     return eventHandler(async (event: H3Event) => {
 
     // @ts-ignore

diff --git a/src/runtime/server/lib/oauth/discord.ts b/src/runtime/server/lib/oauth/discord.ts
@@ -1,9 +1,10 @@
-import type { H3Event, H3Error } from 'h3'
+import type { H3Event } from 'h3'
 import { eventHandler, createError, getQuery, getRequestURL, sendRedirect } from 'h3'
 import { withQuery, parseURL, stringifyParsedURL } from 'ufo'
 import { ofetch } from 'ofetch'
 import { defu } from 'defu'
 import { useRuntimeConfig } from '#imports'
+import type { OAuthConfig } from '#auth-utils'
 
 export interface OAuthDiscordConfig {
   /**
@@ -46,13 +47,7 @@ export interface OAuthDiscordConfig {
   tokenURL?: string
 }
 
-interface OAuthConfig {
-  config?: OAuthDiscordConfig
-  onSuccess: (event: H3Event, result: { user: any, tokens: any }) => Promise<void> | void
-  onError?: (event: H3Event, error: H3Error) => Promise<void> | void
-}
-
-export function discordEventHandler({ config, onSuccess, onError }: OAuthConfig) {
+export function discordEventHandler({ config, onSuccess, onError }: OAuthConfig<OAuthDiscordConfig>) {
   return eventHandler(async (event: H3Event) => {
     // @ts-ignore
     config = defu(config, useRuntimeConfig(event).oauth?.discord, {

diff --git a/src/runtime/server/lib/oauth/github.ts b/src/runtime/server/lib/oauth/github.ts
@@ -1,9 +1,10 @@
-import type { H3Event, H3Error } from 'h3'
+import type { H3Event } from 'h3'
 import { eventHandler, createError, getQuery, getRequestURL, sendRedirect } from 'h3'
 import { ofetch } from 'ofetch'
 import { withQuery } from 'ufo'
 import { defu } from 'defu'
 import { useRuntimeConfig } from '#imports'
+import type { OAuthConfig } from '#auth-utils'
 
 export interface OAuthGitHubConfig {
   /**
@@ -42,13 +43,7 @@ export interface OAuthGitHubConfig {
   tokenURL?: string
 }
 
-interface OAuthConfig {
-  config?: OAuthGitHubConfig
-  onSuccess: (event: H3Event, result: { user: any, tokens: any }) => Promise<void> | void
-  onError?: (event: H3Event, error: H3Error) => Promise<void> | void
-}
-
-export function githubEventHandler({ config, onSuccess, onError }: OAuthConfig) {
+export function githubEventHandler({ config, onSuccess, onError }: OAuthConfig<OAuthGitHubConfig>) {
   return eventHandler(async (event: H3Event) => {
     // @ts-ignore
     config = defu(config, useRuntimeConfig(event).oauth?.github, {

diff --git a/src/runtime/server/lib/oauth/google.ts b/src/runtime/server/lib/oauth/google.ts
@@ -1,4 +1,4 @@
-import type { H3Event, H3Error } from 'h3'
+import type { H3Event } from 'h3'
 import {
   eventHandler,
   createError,
@@ -10,6 +10,7 @@ import { withQuery, parsePath } from 'ufo'
 import { ofetch } from 'ofetch'
 import { defu } from 'defu'
 import { useRuntimeConfig } from '#imports'
+import type { OAuthConfig } from '#auth-utils'
 
 export interface OAuthGoogleConfig {
   /**
@@ -51,20 +52,11 @@ export interface OAuthGoogleConfig {
   redirectUrl: '/auth/google';
 }
 
-interface OAuthConfig {
-  config?: OAuthGoogleConfig;
-  onSuccess: (
-    event: H3Event,
-    result: { user: any; tokens: any }
-  ) => Promise<void> | void;
-  onError?: (event: H3Event, error: H3Error) => Promise<void> | void;
-}
-
 export function googleEventHandler({
   config,
   onSuccess,
   onError,
-}: OAuthConfig) {
+}: OAuthConfig<OAuthGoogleConfig>) {
   return eventHandler(async (event: H3Event) => {
     // @ts-ignore
     config = defu(config, useRuntimeConfig(event).oauth?.google, {

diff --git a/src/runtime/server/lib/oauth/spotify.ts b/src/runtime/server/lib/oauth/spotify.ts
@@ -1,9 +1,10 @@
-import type { H3Event, H3Error } from 'h3'
+import type { H3Event } from 'h3'
 import { eventHandler, createError, getQuery, getRequestURL, sendRedirect } from 'h3'
 import { withQuery, parsePath } from 'ufo'
 import { ofetch } from 'ofetch'
 import { defu } from 'defu'
 import { useRuntimeConfig } from '#imports'
+import type { OAuthConfig } from '#auth-utils'
 
 export interface OAuthSpotifyConfig {
   /**
@@ -42,13 +43,7 @@ export interface OAuthSpotifyConfig {
   tokenURL?: string
 }
 
-interface OAuthConfig {
-  config?: OAuthSpotifyConfig
-  onSuccess: (event: H3Event, result: { user: any, tokens: any }) => Promise<void> | void
-  onError?: (event: H3Event, error: H3Error) => Promise<void> | void
-}
-
-export function spotifyEventHandler({ config, onSuccess, onError }: OAuthConfig) {
+export function spotifyEventHandler({ config, onSuccess, onError }: OAuthConfig<OAuthSpotifyConfig>) {
   return eventHandler(async (event: H3Event) => {
     // @ts-ignore
     config = defu(config, useRuntimeConfig(event).oauth?.spotify, {

diff --git a/src/runtime/server/lib/oauth/twitch.ts b/src/runtime/server/lib/oauth/twitch.ts
@@ -1,9 +1,10 @@
-import type { H3Event, H3Error } from 'h3'
+import type { H3Event } from 'h3'
 import { eventHandler, createError, getQuery, getRequestURL, sendRedirect } from 'h3'
 import { withQuery, parsePath } from 'ufo'
 import { ofetch } from 'ofetch'
 import { defu } from 'defu'
 import { useRuntimeConfig } from '#imports'
+import type { OAuthConfig } from '#auth-utils'
 
 export interface OAuthTwitchConfig {
   /**
@@ -45,13 +46,7 @@ export interface OAuthTwitchConfig {
   tokenURL?: string
 }
 
-interface OAuthConfig {
-  config?: OAuthTwitchConfig
-  onSuccess: (event: H3Event, result: { user: any, tokens: any }) => Promise<void> | void
-  onError?: (event: H3Event, error: H3Error) => Promise<void> | void
-}
-
-export function twitchEventHandler({ config, onSuccess, onError }: OAuthConfig) {
+export function twitchEventHandler({ config, onSuccess, onError }: OAuthConfig<OAuthTwitchConfig>) {
   return eventHandler(async (event: H3Event) => {
     // @ts-ignore
     config = defu(config, useRuntimeConfig(event).oauth?.twitch, {

diff --git a/src/runtime/types/index.ts b/src/runtime/types/index.ts
@@ -0,0 +1,2 @@
+export type { UserSession } from './session'
+export type { OAuthConfig } from './oauth-config'
diff --git a/src/runtime/types/oauth-config.ts b/src/runtime/types/oauth-config.ts
@@ -0,0 +1,11 @@
+import type { H3Event, H3Error } from 'h3'
+import type { UserSession } from '#auth-utils'
+
+export interface OAuthConfig<TConfig, TUser = UserSession, TTokens = any> {
+  config?: TConfig;
+  onSuccess: (
+    event: H3Event,
+    result: { user: TUser; tokens: TTokens }
+  ) => Promise<void> | void;
+  onError?: (event: H3Event, error: H3Error) => Promise<void> | void;
+}
diff --git a/src/runtime/types/auth-utils-session.ts → src/runtime/types/session.ts b/src/runtime/types/auth-utils-session.ts → src/runtime/types/session.ts
-Original file line number
+Diff line change
@@ Expand Up / @@ -12,3 +12,5 @@ declare module '#auth-utils' { @@
         loggedInAt: number
       }
     }
+    export {}
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		export type { UserSession } from './session'
		export type { OAuthConfig } from './oauth-config'