feat: support custom signal for composables

Author: johannschopplich

src/runtime/composables/$kirby.ts

@@ -13,14 +13,15 @@ export type KirbyFetchOptions = Pick<
   | 'onRequestError'
   | 'onResponse'
   | 'onResponseError'
-  | 'query'
-  | 'headers'
   | 'method'
+  | 'headers'
+  | 'query'
   | 'body'
   | 'retry'
   | 'retryDelay'
   | 'retryStatusCodes'
   | 'timeout'
+  | 'signal'
 > & {
   /**
    * Language code to fetch data for in multi-language Kirby setups.
@@ -42,8 +43,8 @@ export function $kirby<T = any>(
   const promiseMap = (nuxt._pendingRequests ||= new Map()) as Map<string, Promise<T>>
   const {
     query,
-    headers,
     method,
+    headers,
     body,
     language,
     cache = true,

src/runtime/composables/$kql.ts

@@ -18,6 +18,7 @@ export type KqlOptions = Pick<
   | 'retryDelay'
   | 'retryStatusCodes'
   | 'timeout'
+  | 'signal'
 > & {
   /**
    * Language code to fetch data for in multi-language Kirby setups.

src/runtime/composables/useKirbyData.ts

@@ -15,9 +15,9 @@ type UseKirbyDataOptions<T> = Omit<AsyncDataOptions<T>, 'watch'> & Pick<
   | 'onRequestError'
   | 'onResponse'
   | 'onResponseError'
-  | 'query'
-  | 'headers'
   | 'method'
+  | 'headers'
+  | 'query'
   | 'body'
   | 'retry'
   | 'retryDelay'
@@ -54,9 +54,9 @@ export function useKirbyData<T = any>(
     pick,
     watch: watchSources,
     immediate,
-    query,
-    headers,
     method,
+    headers,
+    query,
     body,
     language,
     cache = true,

src/runtime/types.ts

@@ -1,13 +1,13 @@
 import type { KirbyQueryRequest } from 'kirby-types'
 import type { NitroFetchOptions } from 'nitropack'
 
-export type ServerFetchOptions = Pick<
+export interface ServerFetchOptions extends Pick<
   NitroFetchOptions<string>,
-  'query' | 'headers' | 'method' | 'body'
-> & {
-  // Either fetch a KQL query
+  'method' | 'headers' | 'query' | 'body'
+> {
+  // Either request a KQL query
   query?: Partial<KirbyQueryRequest>
-  // … or from a Kirby path
+  // … or a direct Kirby API path
   path?: string
   cache?: boolean
 }