refacto: moves types to a specific file

README.md

@@ -27,6 +27,7 @@ import { InferAuthEvents, Authenticators } from '@adonisjs/auth/types'
 import { sessionGuard, sessionUserProvider } from '@adonisjs/auth/session'
 import { jwtGuard } from '@maximemrf/adonisjs-jwt/jwt_config'
 import { JwtGuardUser } from '@maximemrf/adonisjs-jwt/types'
+import User from '#models/user'
 
 const authConfig = defineConfig({
   // define the default authenticator to jwt

src/jwt.ts

@@ -2,52 +2,7 @@ import { symbols, errors } from '@adonisjs/auth'
 import { AuthClientResponse, GuardContract } from '@adonisjs/auth/types'
 import type { HttpContext } from '@adonisjs/core/http'
 import jwt from 'jsonwebtoken'
-
-/**
- * The bridge between the User provider and the
- * Guard
- */
-export type JwtGuardUser<RealUser> = {
-  /**
-   * Returns the unique ID of the user
-   */
-  getId(): string | number | BigInt
-
-  /**
-   * Returns the original user object
-   */
-  getOriginal(): RealUser
-}
-
-/**
- * The interface for the UserProvider accepted by the
- * JWT guard.
- */
-export interface JwtUserProviderContract<RealUser> {
-  /**
-   * A property the guard implementation can use to infer
-   * the data type of the actual user (aka RealUser)
-   */
-  [symbols.PROVIDER_REAL_USER]: RealUser
-
-  /**
-   * Create a user object that acts as an adapter between
-   * the guard and real user value.
-   */
-  createUserForGuard(user: RealUser): Promise<JwtGuardUser<RealUser>>
-
-  /**
-   * Find a user by their id.
-   */
-  findById(identifier: string | number | BigInt): Promise<JwtGuardUser<RealUser> | null>
-}
-
-export type JwtGuardOptions<RealUser extends any = unknown> = {
-  secret: string
-  expiresIn?: number | string
-  useCookies?: boolean
-  content?: (user: JwtGuardUser<RealUser>) => Record<string, any>
-}
+import { JwtUserProviderContract, JwtGuardOptions } from './types.js'
 
 export class JwtGuard<UserProvider extends JwtUserProviderContract<unknown>>
   implements GuardContract<UserProvider[typeof symbols.PROVIDER_REAL_USER]>

src/types.ts

@@ -0,0 +1,47 @@
+import { symbols } from '@adonisjs/auth'
+
+/**
+ * The bridge between the User provider and the
+ * Guard
+ */
+export type JwtGuardUser<RealUser> = {
+  /**
+   * Returns the unique ID of the user
+   */
+  getId(): string | number | BigInt
+
+  /**
+   * Returns the original user object
+   */
+  getOriginal(): RealUser
+}
+
+/**
+ * The interface for the UserProvider accepted by the
+ * JWT guard.
+ */
+export interface JwtUserProviderContract<RealUser> {
+  /**
+   * A property the guard implementation can use to infer
+   * the data type of the actual user (aka RealUser)
+   */
+  [symbols.PROVIDER_REAL_USER]: RealUser
+
+  /**
+   * Create a user object that acts as an adapter between
+   * the guard and real user value.
+   */
+  createUserForGuard(user: RealUser): Promise<JwtGuardUser<RealUser>>
+
+  /**
+   * Find a user by their id.
+   */
+  findById(identifier: string | number | BigInt): Promise<JwtGuardUser<RealUser> | null>
+}
+
+export type JwtGuardOptions<RealUser extends any = unknown> = {
+  secret: string
+  expiresIn?: number | string
+  useCookies?: boolean
+  content?: (user: JwtGuardUser<RealUser>) => Record<string, any>
+}