chore: update stale example

Author: SukkaW

examples/openapi-ts-ky/src/client/client/client.gen.ts

@@ -1,18 +1,12 @@
 // This file is auto-generated by @hey-api/openapi-ts
 
-import type { HTTPError, Options as KyOptions } from 'ky';
-import ky from 'ky';
+import type { KyResponse, Options as KyOptions } from 'ky';
+import ky, { isHTTPError } from 'ky';
 
 import { createSseClient } from '../core/serverSentEvents.gen';
 import type { HttpMethod } from '../core/types.gen';
 import { getValidRequestBody } from '../core/utils.gen';
-import type {
-  Client,
-  Config,
-  RequestOptions,
-  ResolvedRequestOptions,
-  RetryOptions,
-} from './types.gen';
+import type { Client, Config, RequestOptions, ResolvedRequestOptions } from './types.gen';
 import type { Middleware } from './utils.gen';
 import {
   buildUrl,
@@ -49,6 +43,11 @@ export const createClient = (config: Config = {}): Client => {
       ...options,
       headers: mergeHeaders(_config.headers, options.headers),
       ky: options.ky ?? _config.ky ?? ky,
+      // deep merge kyOptions to ensure base _config is being respected
+      kyOptions: {
+        ..._config.kyOptions,
+        ...options.kyOptions,
+      },
       serializedBody: undefined as string | undefined,
     };
 
@@ -130,33 +129,23 @@ export const createClient = (config: Config = {}): Client => {
 
     const kyOptions: KyOptions = {
       body: validBody as BodyInit,
-      cache: opts.cache,
-      credentials: opts.credentials,
-      headers: opts.headers,
-      integrity: opts.integrity,
-      keepalive: opts.keepalive,
-      method: opts.method as KyOptions['method'],
-      mode: opts.mode,
-      redirect: 'follow',
-      referrer: opts.referrer,
-      referrerPolicy: opts.referrerPolicy,
-      signal: opts.signal,
+      ...(opts.cache !== undefined ? { cache: opts.cache } : {}),
+      ...(opts.credentials !== undefined ? { credentials: opts.credentials } : {}),
+      ...(opts.headers !== undefined ? { headers: opts.headers } : {}),
+      ...(opts.integrity !== undefined ? { integrity: opts.integrity } : {}),
+      ...(opts.keepalive !== undefined ? { keepalive: opts.keepalive } : {}),
+      ...(opts.method !== undefined ? { method: opts.method } : {}),
+      ...(opts.mode !== undefined ? { mode: opts.mode } : {}),
+      redirect: opts.redirect ?? 'follow',
+      ...(opts.referrer !== undefined ? { referrer: opts.referrer } : {}),
+      ...(opts.referrerPolicy !== undefined ? { referrerPolicy: opts.referrerPolicy } : {}),
+      ...(opts.signal !== undefined ? { signal: opts.signal } : {}),
       throwHttpErrors: opts.throwOnError ?? false,
-      timeout: opts.timeout,
+      ...(opts.timeout !== undefined ? { timeout: opts.timeout } : {}),
       ...opts.kyOptions,
+      retry: opts.retry ?? opts.kyOptions?.retry ?? 2,
     };
 
-    if (opts.retry && typeof opts.retry === 'object') {
-      const retryOpts = opts.retry as RetryOptions;
-      kyOptions.retry = {
-        limit: retryOpts.limit ?? 2,
-        methods: retryOpts.methods as Array<
-          'get' | 'post' | 'put' | 'patch' | 'head' | 'delete' | 'options' | 'trace'
-        >,
-        statusCodes: retryOpts.statusCodes,
-      };
-    }
-
     let request = new Request(url, {
       body: kyOptions.body as BodyInit,
       headers: kyOptions.headers as HeadersInit,
@@ -169,14 +158,13 @@ export const createClient = (config: Config = {}): Client => {
       }
     }
 
-    let response: Response;
+    let response: KyResponse;
 
     try {
       response = await kyInstance(request, kyOptions);
     } catch (error) {
-      if (error && typeof error === 'object' && 'response' in error) {
-        const httpError = error as HTTPError;
-        response = httpError.response;
+      if (isHTTPError(error)) {
+        response = error.response;
 
         for (const fn of interceptors.response.fns) {
           if (fn) {

examples/openapi-ts-ky/src/client/client/index.ts

@@ -20,7 +20,6 @@ export type {
   RequestResult,
   ResolvedRequestOptions,
   ResponseStyle,
-  RetryOptions,
   TDataShape,
 } from './types.gen';
 export { createConfig, mergeHeaders } from './utils.gen';

examples/openapi-ts-ky/src/client/client/types.gen.ts

@@ -10,30 +10,22 @@ import type { Middleware } from './utils.gen';
 
 export type ResponseStyle = 'data' | 'fields';
 
-export interface RetryOptions {
-  /**
-   * Maximum number of retry attempts
-   *
-   * @default 2
-   */
-  limit?: number;
-  /**
-   * HTTP methods to retry
-   *
-   * @default ['get', 'put', 'head', 'delete', 'options', 'trace']
-   */
-  methods?: Array<'get' | 'post' | 'put' | 'delete' | 'patch' | 'head' | 'options' | 'trace'>;
-  /**
-   * HTTP status codes to retry
-   *
-   * @default [408, 413, 429, 500, 502, 503, 504]
-   */
-  statusCodes?: number[];
-}
-
 export interface Config<T extends ClientOptions = ClientOptions>
   extends
-    Omit<KyOptions, 'body' | 'headers' | 'method' | 'prefixUrl' | 'retry' | 'throwHttpErrors'>,
+    Pick<
+      KyOptions,
+      | 'cache'
+      | 'credentials'
+      | 'retry'
+      | 'signal'
+      | 'integrity'
+      | 'keepalive'
+      | 'mode'
+      | 'redirect'
+      | 'referrer'
+      | 'referrerPolicy'
+      | 'timeout'
+    >,
     CoreConfig {
   /**
    * Base URL for all requests made by this client.
@@ -42,6 +34,10 @@ export interface Config<T extends ClientOptions = ClientOptions>
   /**
    * Ky instance to use. You can use this option to provide a custom
    * ky instance.
+   *
+   * Note that the `prefixUrl` of your ky instance will be ignored, as we
+   * will always build the full URL and pass it to your ky instance. You
+   * should configure `baseUrl` instead.
    */
   ky?: typeof ky;
   /**
@@ -64,22 +60,12 @@ export interface Config<T extends ClientOptions = ClientOptions>
    * @default 'fields'
    */
   responseStyle?: ResponseStyle;
-  /**
-   * Retry configuration
-   */
-  retry?: RetryOptions;
   /**
    * Throw an error instead of returning it in the response?
    *
    * @default false
    */
   throwOnError?: T['throwOnError'];
-  /**
-   * Request timeout in milliseconds
-   *
-   * @default 10000
-   */
-  timeout?: number;
 }
 
 export interface RequestOptions<