fix: declare types for UserInfo and SessionData (#17)

Author: MarioSimou

package.json

@@ -31,7 +31,7 @@
     "./server": "./src/server/index.js"
   },
   "main": "src/index.js",
-  "types": "./src/index.d.ts",
+  "types": "./src/types/index.d.ts",
   "files": [
     "src"
   ],

src/index.d.ts src/types/auth0-solid-start.d.ts

@@ -11,28 +11,26 @@ declare module '@zentered/auth0-solid-start/api/logout' {
 declare module '@zentered/auth0-solid-start/server' {
   import type { ServerFunctionEvent } from 'solid-start/server'
   import type { Session } from 'solid-start/session/sessions'
-
+  export type { SessionData } from 'solid-start/session/sessions'
   export function getSession(event: ServerFunctionEvent): Promise<Session>
 }
 
 declare module '@zentered/auth0-solid-start' {
   import { Accessor, JSX } from 'solid-js'
+  import { SessionData } from 'solid-start/session/sessions'
   import type { WebAuth } from 'auth0-js'
-  export type { SessionData } from 'solid-start/session/sessions'
 
-  type Organization = { id: string }
+  export type UserInfo = SessionData['userInfo']
 
-  export interface User {
-    [name: string]: unknown
-  }
+  type Organization = { id: string }
 
   type Auth0Context = {
     auth0Client: WebAuth
     isAuthenticated: () => boolean
     isInitialized: () => boolean
     organization: Accessor<Organization>
     setInvitation: (invitation: string, org: string, orgName: string) => void
-    user: Accessor<User>
+    user: Accessor<SessionData['userInfo']>
     userId: Accessor<string>
     idToken: Accessor<string>
     accessToken: Accessor<string>

src/types/index.d.ts

@@ -0,0 +1,2 @@
+/// <reference path="./auth0-solid-start.d.ts"/>
+/// <reference path="./solid-start.d.ts"/>

src/types/solid-start.d.ts

@@ -0,0 +1,28 @@
+import 'solid-start/session/sessions'
+
+declare module 'solid-start/session/sessions' {
+  type UserInfo = {
+    sub: string
+    nickname: string
+    name: string
+    picture: string
+    updated_at: string
+    org_id: string
+  }
+
+  /*
+    Note: This is the most basic form of SessionData, but sufficient for most of the times. Ideally, we should have built a discriminated union. 
+    One type would set the refreshToken as required when the scope is set to offline_access, and another type would ignore that field.
+  */
+  export interface SessionData {
+    accessToken: string
+    idToken: string
+    refreshToken?: string
+    scope: string
+    tokenType?: string
+    userInfo: UserInfo
+    userId: string
+    orgId: string
+    permissions?: unknown
+  }
+}