v0breaking: renamed createExternalAuthHandler => createExternalAuthLoginHandler

This makes it clearer it can only handle logins

Author: alanscodelog

README.md

@@ -187,7 +187,7 @@ In some cases you may want to customize this behavior, such as when calling this
 
 This can be customized with the `handleActions` option on the `useAuth` composable.
 
-There is also a `createExternalAuthHandler` helper and related utils, see [External Auth Handlers](#external-auth-handlers).
+There is also a `createExternalAuthLoginHandler` helper and related utils, see [External Auth Handlers](#external-auth-handlers).
 
 ### Changing Routes
 
@@ -411,7 +411,7 @@ definePageMeta({
 
 ```
 
-Then in the login page, we can use the `createExternalAuthHandler` to intercept the action of the `LoginProviderButtons` only when the user is on electron.
+Then in the login page, we can use the `createExternalAuthLoginHandler` to intercept the action of the `LoginProviderButtons` only when the user is on electron.
 
 
 ```vue [pages/auth/login.vue]
@@ -425,14 +425,14 @@ import { useRuntimeConfig } from "#app"
 const rc = useRuntimeConfig()
 
 const handleActions: ActionHandler = (action, url) =>
-createExternalAuthHandler(
+createExternalAuthLoginHandler(
 	"electron", // for the query param
 	isElectron, // platform check
 	publicServerUrl, // you must define this somehow
 	window?.electron?.api.open,
 	"auth/code", // the default
 )(action, url)
-|| createExternalAuthHandler(...) // they can be chained
+|| createExternalAuthLoginHandler(...) // they can be chained
 
 </script>
 ```

src/module.ts

@@ -299,7 +299,7 @@ export default defineNuxtModule<ModuleOptions>({
 			"runtime/utils/getAuthApiRoute",
 			"runtime/core/providers/google",
 			"runtime/core/providers/github",
-			"runtime/utils/createExternalAuthHandler"
+			"runtime/utils/createExternalAuthLoginHandler"
 		]) {
 			nuxt.options.build.transpile.push(resolve(file))
 		}

…ntime/utils/createExternalAuthHandler.ts …/utils/createExternalAuthLoginHandler.tssrc/runtime/utils/createExternalAuthHandler.ts renamed to src/runtime/utils/createExternalAuthLoginHandler.ts src/runtime/utils/createExternalAuthHandler.ts renamed to src/runtime/utils/createExternalAuthLoginHandler.ts

@@ -1,9 +1,9 @@
 import { navigateTo, useRuntimeConfig } from "#imports"
 
 /**
- * Creates an external (e.g. desktop) auth handler.
+ * Creates an external (e.g. desktop) auth login handler. A logout one doesn't exist as that is very platform dependant.
  */
-export function createExternalAuthHandler(
+export function createExternalAuthLoginHandler(
 /**
  * The name of the platform.
  *
@@ -43,11 +43,11 @@ export function createExternalAuthHandler(
 		if (!isExternal()) return false
 
 		if (deeplinkCallbackPath === undefined) {
-			throw new Error("createExternalAuthHandler: deeplinkCallbackPath cannot be undefined. See docs for more info.")
+			throw new Error("createExternalAuthLoginHandler: deeplinkCallbackPath cannot be undefined. See docs for more info.")
 		}
 
-		if (!serverUrl) throw new Error("createExternalAuthHandler: serverUrl cannot be undefined when isExternal returns true. See docs for more info.")
-		if (!open) throw new Error("createExternalAuthHandler: open cannot be undefined when isExternal returns true. See docs for more info.")
+		if (!serverUrl) throw new Error("createExternalAuthLoginHandler: serverUrl cannot be undefined when isExternal returns true. See docs for more info.")
+		if (!open) throw new Error("createExternalAuthLoginHandler: open cannot be undefined when isExternal returns true. See docs for more info.")
 
 		let origin = typeof serverUrl === "function" ? serverUrl() : serverUrl
 		if (origin instanceof Promise) {