-
-
Notifications
You must be signed in to change notification settings - Fork 177
/
Copy pathuseAuth.ts
285 lines (236 loc) · 9.62 KB
/
useAuth.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
import { readonly } from 'vue'
import type { Ref } from 'vue'
import type { CommonUseAuthReturn, GetSessionOptions, SecondarySignInOptions, SignInFunc, SignOutFunc, SignUpOptions } from '../../types'
import { jsonPointerGet, objectFromJsonPointer, useTypedBackendConfig } from '../../helpers'
import { _fetch } from '../../utils/fetch'
import { getRequestURLWN } from '../common/getRequestURL'
import { ERROR_PREFIX } from '../../utils/logger'
import { determineCallbackUrl } from '../../utils/callbackUrl'
import { formatToken } from './utils/token'
import { useAuthState } from './useAuthState'
import type { UseAuthStateReturn } from './useAuthState'
import { callWithNuxt } from '#app/nuxt'
// @ts-expect-error - #auth not defined
import type { SessionData } from '#auth'
import { navigateTo, nextTick, useNuxtApp, useRoute, useRuntimeConfig } from '#imports'
type Credentials = { username?: string, email?: string, password?: string } & Record<string, any>
const signIn: SignInFunc<Credentials, any> = async (credentials, signInOptions, signInParams, signInHeaders) => {
const nuxt = useNuxtApp()
const runtimeConfig = useRuntimeConfig()
const config = useTypedBackendConfig(runtimeConfig, 'local')
const { path, method } = config.endpoints.signIn
const response = await _fetch<Record<string, any>>(nuxt, path, {
method,
body: credentials,
params: signInParams ?? {},
headers: signInHeaders ?? {}
})
const { rawToken, rawRefreshToken } = useAuthState()
// Extract the access token
const extractedToken = jsonPointerGet(response, config.token.signInResponseTokenPointer)
if (typeof extractedToken !== 'string') {
console.error(
`Auth: string token expected, received instead: ${JSON.stringify(extractedToken)}. `
+ `Tried to find token at ${config.token.signInResponseTokenPointer} in ${JSON.stringify(response)}`
)
return
}
rawToken.value = extractedToken
// Extract the refresh token if enabled
if (config.refresh.isEnabled) {
const refreshTokenPointer = config.refresh.token.signInResponseRefreshTokenPointer
const extractedRefreshToken = jsonPointerGet(response, refreshTokenPointer)
if (typeof extractedRefreshToken !== 'string') {
console.error(
`Auth: string token expected, received instead: ${JSON.stringify(extractedRefreshToken)}. `
+ `Tried to find refresh token at ${refreshTokenPointer} in ${JSON.stringify(response)}`
)
return
}
rawRefreshToken.value = extractedRefreshToken
}
const { redirect = true, external, callGetSession = true } = signInOptions ?? {}
if (callGetSession) {
await nextTick(getSession)
}
if (redirect) {
let callbackUrl = signInOptions?.callbackUrl
if (typeof callbackUrl === 'undefined') {
const redirectQueryParam = useRoute()?.query?.redirect
callbackUrl = await determineCallbackUrl(runtimeConfig.public.auth, redirectQueryParam?.toString())
}
return navigateTo(callbackUrl, { external })
}
return response
}
const signOut: SignOutFunc = async (signOutOptions) => {
const nuxt = useNuxtApp()
const runtimeConfig = useRuntimeConfig()
const config = useTypedBackendConfig(runtimeConfig, 'local')
const { data, token, rawToken, refreshToken, rawRefreshToken }: UseAuthStateReturn = await callWithNuxt(nuxt, useAuthState)
const signOutConfig = config.endpoints.signOut
let headers
let body
if (signOutConfig) {
headers = new Headers({ [config.token.headerName]: token.value } as HeadersInit)
// If the refresh provider is used, include the refreshToken in the body
if (config.refresh.isEnabled && ['post', 'put', 'patch', 'delete'].includes(signOutConfig.method.toLowerCase())) {
// This uses refresh token pointer as we are passing `refreshToken`
const signoutRequestRefreshTokenPointer = config.refresh.token.refreshRequestTokenPointer
body = objectFromJsonPointer(signoutRequestRefreshTokenPointer, refreshToken.value)
}
}
data.value = null
rawToken.value = null
rawRefreshToken.value = null
let res
if (signOutConfig) {
const { path, method } = signOutConfig
res = await _fetch(nuxt, path, { method, headers, body })
}
const { redirect = true, external } = signOutOptions ?? {}
if (redirect) {
let callbackUrl = signOutOptions?.callbackUrl
if (typeof callbackUrl === 'undefined') {
const redirectQueryParam = useRoute()?.query?.redirect
callbackUrl = await determineCallbackUrl(runtimeConfig.public.auth, redirectQueryParam?.toString(), true)
}
await navigateTo(callbackUrl, { external })
}
return res
}
async function getSession(getSessionOptions?: GetSessionOptions): Promise<SessionData | null | void> {
const nuxt = useNuxtApp()
const config = useTypedBackendConfig(useRuntimeConfig(), 'local')
const { path, method } = config.endpoints.getSession
const { data, loading, lastRefreshedAt, rawToken, token: tokenState, _internal } = useAuthState()
let token = tokenState.value
// For cached responses, return the token directly from the cookie
token ??= formatToken(_internal.rawTokenCookie.value, config)
if (!token && !getSessionOptions?.force) {
loading.value = false
return
}
const headers = new Headers(token ? { [config.token.headerName]: token } as HeadersInit : undefined)
loading.value = true
try {
const result = await _fetch<any>(nuxt, path, { method, headers })
const { dataResponsePointer: sessionDataResponsePointer } = config.session
data.value = jsonPointerGet<SessionData>(result, sessionDataResponsePointer)
}
catch (err) {
if (!data.value && err instanceof Error) {
console.error(`Session: unable to extract session, ${err.message}`)
}
// Clear all data: Request failed so we must not be authenticated
data.value = null
rawToken.value = null
}
loading.value = false
lastRefreshedAt.value = new Date()
const { required = false, callbackUrl, onUnauthenticated, external } = getSessionOptions ?? {}
if (required && data.value === null) {
if (onUnauthenticated) {
return onUnauthenticated()
}
await navigateTo(callbackUrl ?? await getRequestURLWN(nuxt), { external })
}
return data.value
}
async function signUp<T>(credentials: Credentials, signInOptions?: SecondarySignInOptions, signUpOptions?: SignUpOptions): Promise<T | undefined> {
const nuxt = useNuxtApp()
const runtimeConfig = useRuntimeConfig()
const config = useTypedBackendConfig(runtimeConfig, 'local')
const signUpEndpoint = config.endpoints.signUp
if (!signUpEndpoint) {
console.warn(`${ERROR_PREFIX} provider.endpoints.signUp is disabled.`)
return
}
const { path, method } = signUpEndpoint
// Holds result from fetch to be returned if signUpOptions?.preventLoginFlow is true
const result = await _fetch<T>(nuxt, path, {
method,
body: credentials
})
if (signUpOptions?.preventLoginFlow) {
return result
}
return signIn(credentials, signInOptions)
}
async function refresh(getSessionOptions?: GetSessionOptions) {
const nuxt = useNuxtApp()
const config = useTypedBackendConfig(useRuntimeConfig(), 'local')
// Only refresh the session if the refresh logic is not enabled
if (!config.refresh.isEnabled) {
return getSession(getSessionOptions)
}
const { path, method } = config.refresh.endpoint
const refreshRequestTokenPointer = config.refresh.token.refreshRequestTokenPointer
const { refreshToken, token, rawToken, rawRefreshToken, lastRefreshedAt } = useAuthState()
const headers = new Headers({
[config.token.headerName]: token.value
} as HeadersInit)
const response = await _fetch<Record<string, any>>(nuxt, path, {
method,
headers,
body: objectFromJsonPointer(refreshRequestTokenPointer, refreshToken.value)
})
// Extract the new token from the refresh response
const tokenPointer = config.refresh.token.refreshResponseTokenPointer || config.token.signInResponseTokenPointer
const extractedToken = jsonPointerGet(response, tokenPointer)
if (typeof extractedToken !== 'string') {
console.error(
`Auth: string token expected, received instead: ${JSON.stringify(extractedToken)}. `
+ `Tried to find token at ${tokenPointer} in ${JSON.stringify(response)}`
)
return
}
if (!config.refresh.refreshOnlyToken) {
const refreshTokenPointer = config.refresh.token.signInResponseRefreshTokenPointer
const extractedRefreshToken = jsonPointerGet(response, refreshTokenPointer)
if (typeof extractedRefreshToken !== 'string') {
console.error(
`Auth: string token expected, received instead: ${JSON.stringify(extractedRefreshToken)}. `
+ `Tried to find refresh token at ${refreshTokenPointer} in ${JSON.stringify(response)}`
)
return
}
rawRefreshToken.value = extractedRefreshToken
}
rawToken.value = extractedToken
lastRefreshedAt.value = new Date()
await nextTick()
return getSession(getSessionOptions)
}
/**
* Returns an extended version of CommonUseAuthReturn with local-provider specific data
*
* @remarks
* The returned value `refreshToken` will always be `null` if `refresh.isEnabled` is `false`
*/
interface UseAuthReturn extends CommonUseAuthReturn<typeof signIn, typeof signOut, typeof getSession, SessionData> {
signUp: typeof signUp
token: Readonly<Ref<string | null>>
refreshToken: Readonly<Ref<string | null>>
}
export function useAuth(): UseAuthReturn {
const {
data,
status,
lastRefreshedAt,
token,
refreshToken
} = useAuthState()
return {
status,
data: readonly(data),
lastRefreshedAt: readonly(lastRefreshedAt),
token: readonly(token),
refreshToken: readonly(refreshToken),
getSession,
signIn,
signOut,
signUp,
refresh
}
}