import { onBeforeMount, onServerPrefetch, onUnmounted, ref, getCurrentInstance, watch, unref } from 'vue'
import type { Ref, WatchSource } from 'vue'
import { wrapInRef } from './utils'
import { NuxtApp, useNuxtApp } from '#app'
export type _Transform = (input: Input) => Output
export type PickFrom> = T extends Array
? T
: T extends Record
? keyof T extends K[number]
? T // Exact same keys as the target, skip Pick
: Pick
: T
export type KeysOf = Array
export type KeyOfRes = KeysOf>
type MultiWatchSources = (WatchSource | object)[];
export interface AsyncDataOptions<
DataT,
Transform extends _Transform = _Transform,
PickKeys extends KeyOfRes<_Transform> = KeyOfRes
> {
server?: boolean
lazy?: boolean
default?: () => DataT | Ref
transform?: Transform
pick?: PickKeys
watch?: MultiWatchSources
initialCache?: boolean
}
export interface RefreshOptions {
_initial?: boolean
}
export interface _AsyncData {
data: Ref
pending: Ref
refresh: (opts?: RefreshOptions) => Promise
error: Ref
}
export type AsyncData = _AsyncData & Promise<_AsyncData>
const getDefault = () => null
export function useAsyncData<
DataT,
DataE = Error,
Transform extends _Transform = _Transform,
PickKeys extends KeyOfRes = KeyOfRes
> (
handler: (ctx?: NuxtApp) => Promise,
options?: AsyncDataOptions
): AsyncData, PickKeys>, DataE | null | true>
export function useAsyncData<
DataT,
DataE = Error,
Transform extends _Transform = _Transform,
PickKeys extends KeyOfRes = KeyOfRes
> (
key: string,
handler: (ctx?: NuxtApp) => Promise,
options?: AsyncDataOptions
): AsyncData, PickKeys>, DataE | null | true>
export function useAsyncData<
DataT,
DataE = Error,
Transform extends _Transform = _Transform,
PickKeys extends KeyOfRes = KeyOfRes
> (...args): AsyncData, PickKeys>, DataE | null | true> {
const autoKey = typeof args[args.length - 1] === 'string' ? args.pop() : undefined
if (typeof args[0] !== 'string') { args.unshift(autoKey) }
// eslint-disable-next-line prefer-const
let [key, handler, options = {}] = args as [string, (ctx?: NuxtApp) => Promise, AsyncDataOptions]
// Validate arguments
if (typeof key !== 'string') {
throw new TypeError('[nuxt] [asyncData] key must be a string.')
}
if (typeof handler !== 'function') {
throw new TypeError('[nuxt] [asyncData] handler must be a function.')
}
// Apply defaults
options.server = options.server ?? true
options.default = options.default ?? getDefault
// TODO: remove support for `defer` in Nuxt 3 RC
if ((options as any).defer) {
console.warn('[useAsyncData] `defer` has been renamed to `lazy`. Support for `defer` will be removed in RC.')
}
options.lazy = options.lazy ?? (options as any).defer ?? false
options.initialCache = options.initialCache ?? true
// Setup nuxt instance payload
const nuxt = useNuxtApp()
// Setup hook callbacks once per instance
const instance = getCurrentInstance()
if (instance && !instance._nuxtOnBeforeMountCbs) {
const cbs = instance._nuxtOnBeforeMountCbs = []
if (instance && process.client) {
onBeforeMount(() => {
cbs.forEach((cb) => { cb() })
cbs.splice(0, cbs.length)
})
onUnmounted(() => cbs.splice(0, cbs.length))
}
}
const useInitialCache = () => options.initialCache && nuxt.payload.data[key] !== undefined
const asyncData = {
data: wrapInRef(nuxt.payload.data[key] ?? options.default()),
pending: ref(!useInitialCache()),
error: ref(nuxt.payload._errors[key] ?? null)
} as AsyncData
asyncData.refresh = (opts = {}) => {
// Avoid fetching same key more than once at a time
if (nuxt._asyncDataPromises[key]) {
return nuxt._asyncDataPromises[key]
}
// Avoid fetching same key that is already fetched
if (opts._initial && useInitialCache()) {
return nuxt.payload.data[key]
}
asyncData.pending.value = true
// TODO: Cancel previous promise
// TODO: Handle immediate errors
nuxt._asyncDataPromises[key] = Promise.resolve(handler(nuxt))
.then((result) => {
if (options.transform) {
result = options.transform(result)
}
if (options.pick) {
result = pick(result, options.pick) as DataT
}
asyncData.data.value = result
asyncData.error.value = null
})
.catch((error: any) => {
asyncData.error.value = error
asyncData.data.value = unref(options.default())
})
.finally(() => {
asyncData.pending.value = false
nuxt.payload.data[key] = asyncData.data.value
if (asyncData.error.value) {
nuxt.payload._errors[key] = true
}
delete nuxt._asyncDataPromises[key]
})
return nuxt._asyncDataPromises[key]
}
const initialFetch = () => asyncData.refresh({ _initial: true })
const fetchOnServer = options.server !== false && nuxt.payload.serverRendered
// Server side
if (process.server && fetchOnServer) {
const promise = initialFetch()
onServerPrefetch(() => promise)
}
// Client side
if (process.client) {
if (fetchOnServer && nuxt.isHydrating && key in nuxt.payload.data) {
// 1. Hydration (server: true): no fetch
asyncData.pending.value = false
} else if (instance && nuxt.payload.serverRendered && (nuxt.isHydrating || options.lazy)) {
// 2. Initial load (server: false): fetch on mounted
// 3. Navigation (lazy: true): fetch on mounted
instance._nuxtOnBeforeMountCbs.push(initialFetch)
} else {
// 4. Navigation (lazy: false) - or plugin usage: await fetch
initialFetch()
}
if (options.watch) {
watch(options.watch, () => asyncData.refresh())
}
const off = nuxt.hook('app:data:refresh', (keys) => {
if (!keys || keys.includes(key)) {
return asyncData.refresh()
}
})
if (instance) {
onUnmounted(off)
}
}
// Allow directly awaiting on asyncData
const asyncDataPromise = Promise.resolve(nuxt._asyncDataPromises[key]).then(() => asyncData) as AsyncData
Object.assign(asyncDataPromise, asyncData)
return asyncDataPromise as AsyncData, PickKeys>, DataE>
}
export function useLazyAsyncData<
DataT,
DataE = Error,
Transform extends _Transform = _Transform,
PickKeys extends KeyOfRes = KeyOfRes
> (
handler: (ctx?: NuxtApp) => Promise,
options?: Omit, 'lazy'>
): AsyncData, PickKeys>, DataE | null | true>
export function useLazyAsyncData<
DataT,
DataE = Error,
Transform extends _Transform = _Transform,
PickKeys extends KeyOfRes = KeyOfRes
> (
key: string,
handler: (ctx?: NuxtApp) => Promise,
options?: Omit, 'lazy'>
): AsyncData, PickKeys>, DataE | null | true>
export function useLazyAsyncData<
DataT,
DataE = Error,
Transform extends _Transform = _Transform,
PickKeys extends KeyOfRes = KeyOfRes
> (...args): AsyncData, PickKeys>, DataE | null | true> {
const autoKey = typeof args[args.length - 1] === 'string' ? args.pop() : undefined
if (typeof args[0] !== 'string') { args.unshift(autoKey) }
const [key, handler, options] = args as [string, (ctx?: NuxtApp) => Promise, AsyncDataOptions]
// @ts-ignore
return useAsyncData(key, handler, { ...options, lazy: true }, null)
}
export function refreshNuxtData (keys?: string | string[]): Promise {
if (process.server) {
return Promise.resolve()
}
const _keys = keys ? Array.isArray(keys) ? keys : [keys] : undefined
return useNuxtApp().callHook('app:data:refresh', _keys)
}
function pick (obj: Record, keys: string[]) {
const newObj = {}
for (const key of keys) {
newObj[key] = obj[key]
}
return newObj
}