next-auth.d.ts

/**
 * Copyright (c) HashiCorp, Inc.
 * SPDX-License-Identifier: MPL-2.0
 */

import { DefaultSession } from 'next-auth'
import { AuthErrors } from 'types/auth'

/**
 * Below are augmented interfaces on top of the default
 * next-auth interfaces https://next-auth.js.org/getting-started/typescript#main-module
 */

declare module 'next-auth' {
	/**
	 * Object representing an authentication session.
	 *
	 * Returned by `useSession`, `getSession` and received as a prop on
	 * the `SessionProvider` React Context.
	 */
	interface Session {
		accessToken?: string
		id?: string
		error?: AuthErrors
		/**
		 * Object representing an authenticated user.
		 */
		user?: {
			/** The user's HashiCorp ID */
			id: string
			/** The user's nickname. */
			nickname?: string | null
		} & DefaultSession['user']
		/* Key-value store of additional session data */
		meta: Record<string, unknown>
	}

	/** The OAuth profile returned from your provider */
	interface Profile {
		picture: string
		nickname: string
	}
}

declare module 'next-auth/jwt' {
	/** Returned by the `jwt` callback  */
	interface JWT {
		access_token: string
		refresh_token: string
		scope: string
		expires_in: number
		id_token: string
		token_type: 'bearer'
		error?: AuthErrors
		nickname?: string
		picture?: string
	}
}