-
-
Notifications
You must be signed in to change notification settings - Fork 2
/
useKql.ts
135 lines (118 loc) · 3.38 KB
/
useKql.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
import { computed, reactive } from 'vue'
import { hash } from 'ohash'
import type { FetchError, FetchOptions } from 'ofetch'
import type { AsyncData, AsyncDataOptions } from 'nuxt/app'
import type { KirbyQueryRequest, KirbyQueryResponse } from 'kirby-fest'
import { resolveUnref } from '@vueuse/core'
import type { MaybeComputedRef } from '@vueuse/core'
import { DEFAULT_CLIENT_ERROR, KQL_API_ROUTE, getAuthHeader, headersToObject } from '../utils'
import type { ModuleOptions } from '../../module'
import { useAsyncData, useRuntimeConfig } from '#imports'
export type UseKqlOptions<T> = Pick<
AsyncDataOptions<T>,
| 'server'
| 'lazy'
| 'default'
| 'watch'
| 'immediate'
> & Pick<
FetchOptions,
| 'onRequest'
| 'onRequestError'
| 'onResponse'
| 'onResponseError'
// Pick from `globalThis.RequestInit`
| 'headers'
> & {
/**
* Language code to fetch data for in multilang Kirby setups
*/
language?: string
/**
* Skip the Nuxt server proxy and fetch directly from the API
* Requires `client` to be enabled in the module options as well
*/
client?: boolean
}
export function useKql<
ResT extends KirbyQueryResponse = KirbyQueryResponse,
ReqT extends KirbyQueryRequest = KirbyQueryRequest,
>(query: MaybeComputedRef<ReqT>, opts: UseKqlOptions<ResT> = {}) {
const nuxt = useNuxtApp()
const { kql } = useRuntimeConfig().public
const _query = computed(() => resolveUnref(query))
const key = `$kql${hash(_query.value)}`
const {
server,
lazy,
default: defaultFn,
immediate,
watch,
headers,
language,
client,
...fetchOptions
} = opts
if (Object.keys(_query.value).length === 0 || !_query.value.query)
console.error('[useKql] Empty KQL query')
if (client && !kql.client)
throw new Error(DEFAULT_CLIENT_ERROR)
const asyncDataOptions: AsyncDataOptions<ResT> = {
server,
lazy,
default: defaultFn,
immediate,
watch: [
_query,
...(watch || []),
],
}
const baseHeaders = {
...headersToObject(headers),
...(language ? { 'X-Language': language } : {}),
}
const _fetchOptions = reactive<FetchOptions>({
method: 'POST',
body: {
query: _query,
headers: baseHeaders,
},
})
const _publicFetchOptions = reactive<FetchOptions>({
baseURL: kql.url,
method: 'POST',
body: _query,
headers: {
...baseHeaders,
...getAuthHeader({
auth: kql.auth as ModuleOptions['auth'],
token: kql.token,
credentials: kql.credentials,
}),
},
})
let controller: AbortController
return useAsyncData<ResT, FetchError>(
key,
async () => {
controller?.abort?.()
if (key in nuxt.payload.data)
return Promise.resolve(nuxt.payload.data[key])
if (key in nuxt.static.data)
return Promise.resolve(nuxt.static.data[key])
controller = typeof AbortController !== 'undefined'
? new AbortController()
: ({} as AbortController)
const result = (await $fetch<ResT>(client ? kql.prefix : KQL_API_ROUTE, {
...fetchOptions,
signal: controller.signal,
...(client ? _publicFetchOptions : _fetchOptions),
})) as ResT
// Workaround to persist response client-side
// https://github.com/nuxt/framework/issues/8917
nuxt.static.data[key] = result
return result
},
asyncDataOptions,
) as AsyncData<ResT, FetchError | null | true>
}