provide sid in auth.getUser

prostgles · Dec 21, 2024 · fc246db · fc246db
1 parent 47d9bda
commit fc246db
Show file tree

Hide file tree

Showing 6 changed files with 10 additions and 9 deletions.
diff --git a/docs/server.md b/docs/server.md
@@ -139,7 +139,7 @@ prostgles<DBGeneratedSchema>({
   Data access rules applied to clients.
   By default, nothing is allowed.
 
-- **publishRawSQL** <span style="color: grey">optional</span> <span style="color: green;">(params: PublishParams&lt;S, SUser&gt;) =&gt; boolean | "*" | Promise&lt;boolean | "*"&gt;</span>
+- **publishRawSQL** <span style="color: grey">optional</span> <span style="color: green;">(params: PublishParams&lt;S, SUser&gt;) =&gt; Awaitable&lt;boolean | "*"&gt;</span>
 
   If defined and resolves to true then the connected client can run SQL queries
 
@@ -194,7 +194,7 @@ prostgles<DBGeneratedSchema>({
 
     Name of the cookie or socket hadnshake query param that represents the session id.
     Defaults to "session_id"
-  - **getUser** <span style="color: red">required</span> <span style="color: green;">(sid: string | undefined, dbo: DBOFullyTyped&lt;S&gt;, db: DB, client: AuthClientRequest & LoginClientInfo) =&gt; Awaitable&lt;AuthResult&lt;...&gt;&gt;</span>
+  - **getUser** <span style="color: red">required</span> <span style="color: green;">(sid: string | undefined, dbo: DBOFullyTyped&lt;S&gt;, db: DB, client: AuthClientRequest & LoginClientInfo) =&gt; Awaitable&lt;AuthResultOrError&lt;...&gt;&gt;</span>
 
     undefined sid is allowed to enable public users
   - **expressConfig** <span style="color: grey">optional</span> <span style="color: green;">ExpressConfig</span>

diff --git a/lib/Auth/AuthHandler.ts b/lib/Auth/AuthHandler.ts
@@ -15,6 +15,7 @@ import {
   AuthClientRequest,
   AuthResult,
   AuthResultOrError,
+  AuthResultWithSID,
   BasicSession,
   ExpressReq,
   ExpressRes,
@@ -145,7 +146,7 @@ export class AuthHandler {
     }
   };
 
-  getUserAndHandleError = async (localParams: AuthClientRequest): Promise<AuthResult> => {
+  getUserAndHandleError = async (localParams: AuthClientRequest): Promise<AuthResultWithSID> => {
     const sid = this.getSID(localParams);
     if (!sid) return undefined;
     const handlerError = (code: AuthFailure["code"]) => {
@@ -170,7 +171,7 @@ export class AuthHandler {
         return handlerError(userOrErrorCode);
       }
 
-      return userOrErrorCode;
+      return { sid, ...userOrErrorCode };
     } catch (_err) {
       return handlerError("server-error");
     }

diff --git a/lib/Auth/AuthTypes.ts b/lib/Auth/AuthTypes.ts
@@ -263,7 +263,7 @@ export type AuthResultOrError<SU = SessionUser> = AuthFailure["code"] | AuthResu
 export type AuthRequestParams<S, SUser extends SessionUser> = {
   db: DB;
   dbo: DBOFullyTyped<S>;
-  getUser: () => Promise<AuthResultOrError<SUser>>;
+  getUser: () => Promise<AuthResultWithSID<SUser>>;
 };
 
 export type Auth<S = void, SUser extends SessionUser = SessionUser> = {

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "prostgles-server",
-  "version": "4.2.192",
+  "version": "4.2.193",
   "description": "",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

diff --git a/tests/server/package-lock.json b/tests/server/package-lock.json