From dfe7596becd08630590fbfd0677c0b9ecaa82e2b Mon Sep 17 00:00:00 2001
From: Bereket Engida <bekacru@gmail.com>
Date: Wed, 30 Oct 2024 11:20:26 +0300
Subject: [PATCH] fix: renmae leading _ to $ for signals

---
 packages/better-auth/src/client/config.ts     | 12 ++++----
 packages/better-auth/src/client/query.ts      |  1 +
 .../better-auth/src/client/session-atom.ts    |  4 +--
 .../better-auth/src/client/test-plugin.ts     | 28 +++++++++----------
 packages/better-auth/src/client/types.ts      |  6 ++--
 packages/better-auth/src/client/vue.ts        |  2 +-
 .../src/plugins/multi-session/client.ts       |  2 +-
 .../src/plugins/organization/client.ts        | 16 +++++------
 .../src/plugins/phone-number/client.ts        |  2 +-
 .../src/plugins/two-factor/client.ts          |  2 +-
 10 files changed, 38 insertions(+), 37 deletions(-)

diff --git a/packages/better-auth/src/client/config.ts b/packages/better-auth/src/client/config.ts
index 9bb8fad18f..bc92c691c8 100644
--- a/packages/better-auth/src/client/config.ts
+++ b/packages/better-auth/src/client/config.ts
@@ -27,12 +27,12 @@ export const getClientConfig = <O extends ClientOptions>(options?: O) => {
 					...pluginsFetchPlugins,
 				],
 	});
-	const { _sessionSignal, $session } = getSessionAtom<O>($fetch);
+	const { $sessionSignal, session } = getSessionAtom<O>($fetch);
 	const plugins = options?.plugins || [];
 	let pluginsActions = {} as Record<string, any>;
 	let pluginsAtoms = {
-		_sessionSignal,
-		session: $session,
+		$sessionSignal,
+		session,
 	} as Record<string, WritableAtom<any>>;
 	let pluginPathMethods: Record<string, "POST" | "GET"> = {
 		"/sign-out": "POST",
@@ -40,7 +40,7 @@ export const getClientConfig = <O extends ClientOptions>(options?: O) => {
 	};
 	const atomListeners: AtomListener[] = [
 		{
-			signal: "_sessionSignal",
+			signal: "$sessionSignal",
 			matcher(path) {
 				return (
 					path === "/sign-out" ||
@@ -65,13 +65,13 @@ export const getClientConfig = <O extends ClientOptions>(options?: O) => {
 	}
 
 	const $store = {
-		notify: (signal?: Omit<string, "_sessionSignal"> | "_sessionSignal") => {
+		notify: (signal?: Omit<string, "$sessionSignal"> | "$sessionSignal") => {
 			pluginsAtoms[signal as keyof typeof pluginsAtoms].set(
 				!pluginsAtoms[signal as keyof typeof pluginsAtoms].get(),
 			);
 		},
 		listen: (
-			signal: Omit<string, "_sessionSignal"> | "_sessionSignal",
+			signal: Omit<string, "$sessionSignal"> | "$sessionSignal",
 			listener: (value: boolean, oldValue?: boolean | undefined) => void,
 		) => {
 			pluginsAtoms[signal as keyof typeof pluginsAtoms].subscribe(listener);
diff --git a/packages/better-auth/src/client/query.ts b/packages/better-auth/src/client/query.ts
index 7833723cc4..235dcec777 100644
--- a/packages/better-auth/src/client/query.ts
+++ b/packages/better-auth/src/client/query.ts
@@ -40,6 +40,7 @@ export const useAuthQuery = <T>(
 						isPending: value.get().isPending,
 					})
 				: options;
+				
 		return $fetch<T>(path, {
 			...opts,
 			onSuccess: async (context) => {
diff --git a/packages/better-auth/src/client/session-atom.ts b/packages/better-auth/src/client/session-atom.ts
index 483c14135f..8b999e329e 100644
--- a/packages/better-auth/src/client/session-atom.ts
+++ b/packages/better-auth/src/client/session-atom.ts
@@ -21,7 +21,7 @@ export function getSessionAtom<Option extends ClientOptions>(
 		method: "GET",
 	});
 	return {
-		$session: session,
-		_sessionSignal: $signal,
+		session,
+		$sessionSignal: $signal,
 	};
 }
diff --git a/packages/better-auth/src/client/test-plugin.ts b/packages/better-auth/src/client/test-plugin.ts
index f8dbd0dc0c..29a0387865 100644
--- a/packages/better-auth/src/client/test-plugin.ts
+++ b/packages/better-auth/src/client/test-plugin.ts
@@ -53,9 +53,9 @@ const serverPlugin = {
 } satisfies BetterAuthPlugin;
 
 export const testClientPlugin = () => {
-	const _test = atom(false);
+	const $test = atom(false);
 	let testValue = 0;
-	const computedAtom = computed(_test, () => {
+	const computedAtom = computed($test, () => {
 		return testValue++;
 	});
 	return {
@@ -63,7 +63,7 @@ export const testClientPlugin = () => {
 		getActions($fetch) {
 			return {
 				setTestAtom(value: boolean) {
-					_test.set(value);
+					$test.set(value);
 				},
 				test: {
 					signOut: async () => {},
@@ -71,13 +71,13 @@ export const testClientPlugin = () => {
 			};
 		},
 		getAtoms($fetch) {
-			const _signal = atom(false);
-			const queryAtom = useAuthQuery<any>(_signal, "/test", $fetch, {
+			const $signal = atom(false);
+			const queryAtom = useAuthQuery<any>($signal, "/test", $fetch, {
 				method: "GET",
 			});
 			return {
-				_test,
-				_signal,
+				$test,
+				$signal,
 				computedAtom,
 				queryAtom,
 			};
@@ -86,37 +86,37 @@ export const testClientPlugin = () => {
 		atomListeners: [
 			{
 				matcher: (path) => path === "/test",
-				signal: "_test",
+				signal: "$test",
 			},
 			{
 				matcher: (path) => path === "/test2/sign-out",
-				signal: "_sessionSignal",
+				signal: "$sessionSignal",
 			},
 		],
 	} satisfies BetterAuthClientPlugin;
 };
 export const testClientPlugin2 = () => {
-	const _test2 = atom(false);
+	const $test2 = atom(false);
 	let testValue = 0;
-	const anotherAtom = computed(_test2, () => {
+	const anotherAtom = computed($test2, () => {
 		return testValue++;
 	});
 	return {
 		id: "test",
 		getAtoms($fetch) {
 			return {
-				_test2,
+				$test2,
 				anotherAtom,
 			};
 		},
 		atomListeners: [
 			{
 				matcher: (path) => path === "/test",
-				signal: "_test",
+				signal: "$test",
 			},
 			{
 				matcher: (path) => path === "/test2/sign-out",
-				signal: "_sessionSignal",
+				signal: "$sessionSignal",
 			},
 		],
 	} satisfies BetterAuthClientPlugin;
diff --git a/packages/better-auth/src/client/types.ts b/packages/better-auth/src/client/types.ts
index f2fdc497e2..8095d353e6 100644
--- a/packages/better-auth/src/client/types.ts
+++ b/packages/better-auth/src/client/types.ts
@@ -17,7 +17,7 @@ import type { InferFieldsInputClient, InferFieldsOutput } from "../db";
 
 export type AtomListener = {
 	matcher: (path: string) => boolean;
-	signal: "_sessionSignal" | Omit<string, "_sessionSignal">;
+	signal: "$sessionSignal" | Omit<string, "$sessionSignal">;
 };
 
 interface Store {
@@ -99,9 +99,9 @@ export type InferActions<O extends ClientOptions> = O["plugins"] extends Array<
 	: {};
 /**
  * signals are just used to recall a computed value.
- * as a convention they start with "_"
+ * as a convention they start with "$"
  */
-export type IsSignal<T> = T extends `_${infer _}` ? true : false;
+export type IsSignal<T> = T extends `$${infer _}` ? true : false;
 
 export type InferPluginsFromClient<O extends ClientOptions> =
 	O["plugins"] extends Array<BetterAuthClientPlugin>
diff --git a/packages/better-auth/src/client/vue.ts b/packages/better-auth/src/client/vue.ts
index 37adebcf75..053c315a8d 100644
--- a/packages/better-auth/src/client/vue.ts
+++ b/packages/better-auth/src/client/vue.ts
@@ -83,7 +83,7 @@ export function createAuthClient<Option extends ClientOptions>(
 		useFetch?: UseFetch,
 	) {
 		if (useFetch) {
-			const ref = useStore(pluginsAtoms._sessionSignal);
+			const ref = useStore(pluginsAtoms.$sessionSignal);
 			const baseURL = options?.fetchOptions?.baseURL || options?.baseURL;
 			const authPath = baseURL ? new URL(baseURL).pathname : "/api/auth";
 			return useFetch(`${authPath}/get-session`, {
diff --git a/packages/better-auth/src/plugins/multi-session/client.ts b/packages/better-auth/src/plugins/multi-session/client.ts
index 8c151fa3f2..02799faddb 100644
--- a/packages/better-auth/src/plugins/multi-session/client.ts
+++ b/packages/better-auth/src/plugins/multi-session/client.ts
@@ -13,7 +13,7 @@ export const multiSessionClient = () => {
 				matcher(path) {
 					return path === "/multi-session/set-active";
 				},
-				signal: "_sessionSignal",
+				signal: "$sessionSignal"
 			},
 		],
 	} satisfies BetterAuthClientPlugin;
diff --git a/packages/better-auth/src/plugins/organization/client.ts b/packages/better-auth/src/plugins/organization/client.ts
index 9c3b6f3125..5c3b9e1ec5 100644
--- a/packages/better-auth/src/plugins/organization/client.ts
+++ b/packages/better-auth/src/plugins/organization/client.ts
@@ -22,8 +22,8 @@ export const organizationClient = <O extends OrganizationClientOptions>(
 	options?: O,
 ) => {
 	const activeOrgId = atom<string | null | undefined>(undefined);
-	const _listOrg = atom<boolean>(false);
-	const _activeOrgSignal = atom<boolean>(false);
+	const $listOrg = atom<boolean>(false);
+	const $activeOrgSignal = atom<boolean>(false);
 
 	type DefaultStatements = typeof defaultStatements;
 	type Statements = O["ac"] extends AccessControl<infer S>
@@ -80,7 +80,7 @@ export const organizationClient = <O extends OrganizationClientOptions>(
 		}),
 		getAtoms: ($fetch) => {
 			const listOrganizations = useAuthQuery<Organization[]>(
-				_listOrg,
+				$listOrg,
 				"/organization/list",
 				$fetch,
 				{
@@ -102,7 +102,7 @@ export const organizationClient = <O extends OrganizationClientOptions>(
 					}
 				>
 			>(
-				[activeOrgId, _activeOrgSignal],
+				[activeOrgId, $activeOrgSignal],
 				"/organization/activate",
 				$fetch,
 				() => ({
@@ -114,8 +114,8 @@ export const organizationClient = <O extends OrganizationClientOptions>(
 			);
 
 			return {
-				_listOrg,
-				_activeOrgSignal,
+				$listOrg,
+				$activeOrgSignal,
 				activeOrganization,
 				listOrganizations,
 			};
@@ -127,13 +127,13 @@ export const organizationClient = <O extends OrganizationClientOptions>(
 						path === "/organization/create" || path === "/organization/delete"
 					);
 				},
-				signal: "_listOrg",
+				signal: "$listOrg",
 			},
 			{
 				matcher(path) {
 					return path.startsWith("/organization");
 				},
-				signal: "_activeOrgSignal",
+				signal: "$activeOrgSignal",
 			},
 		],
 	} satisfies BetterAuthClientPlugin;
diff --git a/packages/better-auth/src/plugins/phone-number/client.ts b/packages/better-auth/src/plugins/phone-number/client.ts
index 1fa557e09e..4f179f8ce4 100644
--- a/packages/better-auth/src/plugins/phone-number/client.ts
+++ b/packages/better-auth/src/plugins/phone-number/client.ts
@@ -12,7 +12,7 @@ export const phoneNumberClient = () => {
 						path === "/phone-number/update" || path === "/phone-number/verify"
 					);
 				},
-				signal: "_sessionSignal",
+				signal: "$sessionSignal" 
 			},
 		],
 	} satisfies BetterAuthClientPlugin;
diff --git a/packages/better-auth/src/plugins/two-factor/client.ts b/packages/better-auth/src/plugins/two-factor/client.ts
index ccac1ee140..39733092b2 100644
--- a/packages/better-auth/src/plugins/two-factor/client.ts
+++ b/packages/better-auth/src/plugins/two-factor/client.ts
@@ -21,7 +21,7 @@ export const twoFactorClient = (
 		atomListeners: [
 			{
 				matcher: (path) => path.startsWith("/two-factor/"),
-				signal: "_sessionSignal",
+				signal: "$sessionSignal"
 			},
 		],
 		pathMethods: {