docs: deduplicate type declarations copied from source files

johannschopplich · johannschopplich · commit cd7520732055 · 2025-08-30T15:02:46.000+02:00
diff --git a/docs/api/kirby.md b/docs/api/kirby.md
@@ -69,30 +69,6 @@ function $kirby<T = any>(
   path: string,
   opts: KirbyFetchOptions = {},
 ): Promise<T>
-
-type KirbyFetchOptions = Pick<
-  NitroFetchOptions<string>,
-  | 'onRequest'
-  | 'onRequestError'
-  | 'onResponse'
-  | 'onResponseError'
-  | 'query'
-  | 'headers'
-  | 'method'
-  | 'body'
-  | 'retry'
-  | 'retryDelay'
-  | 'retryStatusCodes'
-  | 'timeout'
-> & {
-  /**
-   * Language code to fetch data for in multi-language Kirby setups.
-   */
-  language?: string
-  /**
-   * Cache the response between function calls for the same query.
-   * @default true
-   */
-  cache?: boolean
-}
 ```
+
+<<< @/../src/runtime/composables/$kirby.ts#options
diff --git a/docs/api/kql.md b/docs/api/kql.md
@@ -69,27 +69,6 @@ function $kql<T extends KirbyQueryResponse<any, boolean> = KirbyQueryResponse>(
   query: KirbyQueryRequest,
   opts: KqlOptions = {}
 ): Promise<T>
-
-type KqlOptions = Pick<
-  NitroFetchOptions<string>,
-  | 'onRequest'
-  | 'onRequestError'
-  | 'onResponse'
-  | 'onResponseError'
-  | 'headers'
-  | 'retry'
-  | 'retryDelay'
-  | 'retryStatusCodes'
-  | 'timeout'
-> & {
-  /**
-   * Language code to fetch data for in multi-language Kirby setups.
-   */
-  language?: string
-  /**
-   * Cache the response between function calls for the same query.
-   * @default true
-   */
-  cache?: boolean
-}
 ```
+
+<<< @/../src/runtime/composables/$kql.ts#options
diff --git a/docs/api/use-kirby-data.md b/docs/api/use-kirby-data.md
@@ -100,38 +100,8 @@ export function useKirbyData<T = any>(
   path: MaybeRefOrGetter<string>,
   opts: UseKirbyDataOptions<T> = {},
 ): AsyncData<T | undefined, NuxtError>
-
-type UseKirbyDataOptions<T> = Omit<AsyncDataOptions<T>, 'watch'> & Pick<
-  NitroFetchOptions<string>,
-  | 'onRequest'
-  | 'onRequestError'
-  | 'onResponse'
-  | 'onResponseError'
-  | 'query'
-  | 'headers'
-  | 'method'
-  | 'body'
-  | 'retry'
-  | 'retryDelay'
-  | 'retryStatusCodes'
-  | 'timeout'
-> & {
-  /**
-   * Language code to fetch data for in multi-language Kirby setups.
-   */
-  language?: MaybeRefOrGetter<string>
-  /**
-   * Cache the response between function calls for the same path.
-   * @default true
-   */
-  cache?: boolean
-  /**
-   * Watch an array of reactive sources and auto-refresh the fetch result when they change.
-   * Path and language are watched by default. You can completely ignore reactive sources by using `watch: false`.
-   * @default undefined
-   */
-  watch?: MultiWatchSources | false
-}
 ```
 
+<<< @/../src/runtime/composables/useKirbyData.ts#options
+
 `useKirbyData` infers all of Nuxt's [`useAsyncData` options](https://nuxt.com/docs/api/composables/use-async-data#params).
diff --git a/docs/api/use-kql.md b/docs/api/use-kql.md
@@ -90,35 +90,8 @@ function useKql<
   query: MaybeRefOrGetter<ReqT>,
   opts?: UseKqlOptions<ResT>
 ): AsyncData<ResT | undefined, NuxtError>
-
-type UseKqlOptions<T> = AsyncDataOptions<T> & Pick<
-  NitroFetchOptions<string>,
-  | 'onRequest'
-  | 'onRequestError'
-  | 'onResponse'
-  | 'onResponseError'
-  | 'headers'
-  | 'retry'
-  | 'retryDelay'
-  | 'retryStatusCodes'
-  | 'timeout'
-> & {
-  /**
-   * Language code to fetch data for in multi-language Kirby setups.
-   */
-  language?: MaybeRefOrGetter<string>
-  /**
-   * Cache the response between function calls for the same query.
-   * @default true
-   */
-  cache?: boolean
-  /**
-   * Watch an array of reactive sources and auto-refresh the fetch result when they change.
-   * Query and language are watched by default. You can completely ignore reactive sources by using `watch: false`.
-   * @default undefined
-   */
-  watch?: MultiWatchSources | false
-}
 ```
 
+<<< @/../src/runtime/composables/useKql.ts#options
+
 `useKql` infers all of Nuxt's [`useAsyncData` options](https://nuxt.com/docs/api/composables/use-async-data#params).
diff --git a/docs/config/index.md b/docs/config/index.md
@@ -19,120 +19,4 @@ export default defineNuxtConfig({
 
 See the types below for a complete list of options.
 
-```ts
-interface ModuleOptions {
-  /**
-   * Kirby base URL, like `https://kirby.example.com`
-   *
-   * @default process.env.KIRBY_BASE_URL
-   */
-  url?: string
-
-  /**
-   * Kirby KQL API route path
-   *
-   * @default 'api/query' // for `basic` authentication
-   * @default 'api/kql' // for `bearer` authentication
-   */
-  prefix?: string
-
-  /**
-   * Kirby API authentication method
-   *
-   * @remarks
-   * Set to `none` to disable authentication
-   *
-   * @default 'basic'
-   */
-  auth?: 'basic' | 'bearer' | 'none'
-
-  /**
-   * Token for bearer authentication
-   *
-   * @default process.env.KIRBY_API_TOKEN
-   */
-  token?: string
-
-  /**
-   * Username/password pair for basic authentication
-   *
-   * @default { username: process.env.KIRBY_API_USERNAME, password: process.env.KIRBY_API_PASSWORD }
-   */
-  credentials?: {
-    username: string
-    password: string
-  }
-
-  /**
-   * Send client-side requests instead of using the server-side proxy
-   *
-   * @remarks
-   * By default, KQL data is fetched safely with a server-side proxy.
-   * If enabled, query requests will be be sent directly from the client.
-   * Note: This means your token or user credentials will be publicly visible.
-   * If Nuxt SSR is disabled, this option is enabled by default.
-   *
-   * @default false
-   */
-  client?: boolean
-
-  /**
-   * Prefetch custom KQL queries at build-time
-   *
-   * @remarks
-   * The queries will be fully typed and importable from `#nuxt-kql`.
-   *
-   * @default {}
-   */
-  prefetch?: Record<
-    string,
-    KirbyQueryRequest | { query: KirbyQueryRequest, language: string }
-  >
-
-  /**
-   * Server-side features
-   */
-  server?: {
-    /**
-     * Enable server-side caching of queries using the Nitro cache API
-     *
-     * @see https://nitro.unjs.io/guide/cache
-     */
-    cache?: boolean
-
-    /**
-     * Name of the storage mountpoint to use for caching
-     *
-     * @see https://nitro.unjs.io/guide/cache
-     * @default 'cache'
-     */
-    storage?: string
-
-    /**
-     * Enable stale-while-revalidate behavior (cache is returned while it is being updated)
-     *
-     * @see https://nitro.unjs.io/guide/cache#options
-     * @default false
-     */
-    swr?: boolean
-
-    /**
-     * Number of seconds to cache the query response
-     *
-     * @see https://nitro.unjs.io/guide/cache#options
-     * @default 1
-     */
-    maxAge?: number
-
-    /**
-     * Log verbose errors to the console if a query fails
-     *
-     * @remarks
-     * This will log the full query to the console. Depending on the content of the query, this could be a security risk.
-     *
-     * @default false
-     */
-    verboseErrors?: boolean
-  }
-}
-```
+<<< @/../src/module.ts#options
diff --git a/src/module.ts b/src/module.ts
@@ -24,6 +24,7 @@ const KIRBY_TYPES_PKG_EXPORT_NAMES = [
   'KirbyQuerySchema',
 ]
 
+// #region options
 export interface ModuleOptions {
   /**
    * Kirby base URL, like `https://kirby.example.com`
@@ -139,6 +140,7 @@ export interface ModuleOptions {
     verboseErrors?: boolean
   }
 }
+// #endregion options
 
 declare module '@nuxt/schema' {
   interface RuntimeConfig {
diff --git a/src/runtime/composables/$kirby.ts b/src/runtime/composables/$kirby.ts
@@ -6,6 +6,7 @@ import { hash } from 'ohash'
 import { joinURL } from 'ufo'
 import { createAuthHeader, getProxyPath, headersToObject } from '../utils'
 
+// #region options
 export type KirbyFetchOptions = Pick<
   NitroFetchOptions<string>,
   | 'onRequest'
@@ -31,6 +32,7 @@ export type KirbyFetchOptions = Pick<
    */
   cache?: boolean
 }
+// #endregion options
 
 export function $kirby<T = any>(
   path: string,
diff --git a/src/runtime/composables/$kql.ts b/src/runtime/composables/$kql.ts
@@ -6,6 +6,7 @@ import { useNuxtApp, useRequestFetch, useRuntimeConfig } from '#imports'
 import { hash } from 'ohash'
 import { createAuthHeader, getProxyPath, headersToObject } from '../utils'
 
+// #region options
 export type KqlOptions = Pick<
   NitroFetchOptions<string>,
   | 'onRequest'
@@ -28,6 +29,7 @@ export type KqlOptions = Pick<
    */
   cache?: boolean
 }
+// #endregion options
 
 export function $kql<T extends KirbyQueryResponse<any, boolean> = KirbyQueryResponse>(
   query: KirbyQueryRequest,
diff --git a/src/runtime/composables/useKirbyData.ts b/src/runtime/composables/useKirbyData.ts
@@ -8,6 +8,7 @@ import { joinURL } from 'ufo'
 import { computed, toValue } from 'vue'
 import { createAuthHeader, getProxyPath, headersToObject } from '../utils'
 
+// #region options
 type UseKirbyDataOptions<T> = Omit<AsyncDataOptions<T>, 'watch'> & Pick<
   NitroFetchOptions<string>,
   | 'onRequest'
@@ -39,6 +40,7 @@ type UseKirbyDataOptions<T> = Omit<AsyncDataOptions<T>, 'watch'> & Pick<
    */
   watch?: MultiWatchSources | false
 }
+// #endregion options
 
 export function useKirbyData<T = any>(
   path: MaybeRefOrGetter<string>,
diff --git a/src/runtime/composables/useKql.ts b/src/runtime/composables/useKql.ts
@@ -8,6 +8,7 @@ import { hash } from 'ohash'
 import { computed, toValue } from 'vue'
 import { createAuthHeader, getProxyPath, headersToObject } from '../utils'
 
+// #region options
 export type UseKqlOptions<T> = Omit<AsyncDataOptions<T>, 'watch'> & Pick<
   NitroFetchOptions<string>,
   | 'onRequest'
@@ -36,6 +37,7 @@ export type UseKqlOptions<T> = Omit<AsyncDataOptions<T>, 'watch'> & Pick<
    */
   watch?: MultiWatchSources | false
 }
+// #endregion options
 
 export function useKql<
   ResT extends KirbyQueryResponse<any, boolean> = KirbyQueryResponse,

Original file line number	Diff line number	Diff line change
`@@ -24,6 +24,7 @@ const KIRBY_TYPES_PKG_EXPORT_NAMES = [`
`24`	`24`	`'KirbyQuerySchema',`
`25`	`25`	`]`
`26`	`26`
	`27`	`+// #region options`
`27`	`28`	`export interface ModuleOptions {`
`28`	`29`	`/**`
`29`	`30`	* Kirby base URL, like `https://kirby.example.com`
`@@ -139,6 +140,7 @@ export interface ModuleOptions {`
`139`	`140`	`verboseErrors?: boolean`
`140`	`141`	`}`
`141`	`142`	`}`
	`143`	`+// #endregion options`
`142`	`144`
`143`	`145`	`declare module '@nuxt/schema' {`
`144`	`146`	`interface RuntimeConfig {`