@hey-api/openapi-ts 0.64.12 → 0.64.14

package/dist/index.d.cts

@@ -7176,6 +7176,18 @@ interface Input {
    * Organization created in Hey API platform.
    */
   organization?: string;
+  /**
+   * Pagination configuration
+   */
+  pagination?: {
+    /**
+     * Array of keywords to be considered as pagination field names.
+     * These will be used to detect pagination fields in schemas and parameters.
+     *
+     * @default ['after', 'before', 'cursor', 'offset', 'page', 'start']
+     */
+    keywords?: ReadonlyArray<string>;
+  };
   /**
    * Path to the OpenAPI specification. This can be either local or remote path.
    * Both JSON and YAML file formats are supported. You can also pass the parsed
@@ -7199,6 +7211,7 @@ interface Input {
    * the first match will be returned.
    */
   tags?: ReadonlyArray<string>;
+
   /**
    * **Requires `path` to start with `https://get.heyapi.dev` or be undefined**
    *
@@ -7874,15 +7887,16 @@ declare const utils: {
     }) => string;
 };
 
+type Configs = UserConfig | (() => UserConfig) | (() => Promise<UserConfig>);
 /**
  * Generate a client from the provided configuration.
  *
  * @param userConfig User provided {@link UserConfig} configuration.
  */
-declare const createClient: (userConfig: UserConfig) => Promise<ReadonlyArray<Client$1 | IR.Context>>;
+declare const createClient: (userConfig?: Configs) => Promise<ReadonlyArray<Client$1 | IR.Context>>;
 /**
  * Type helper for openapi-ts.config.ts, returns {@link UserConfig} object
  */
-declare const defineConfig: (config: UserConfig) => UserConfig;
+declare const defineConfig: (config: Configs) => Promise<UserConfig>;
 
 export { IR, LegacyIR, OpenApi, Plugin, type UserConfig, createClient, defaultPlugins, defineConfig, utils };

package/dist/index.d.ts

@@ -7176,6 +7176,18 @@ interface Input {
    * Organization created in Hey API platform.
    */
   organization?: string;
+  /**
+   * Pagination configuration
+   */
+  pagination?: {
+    /**
+     * Array of keywords to be considered as pagination field names.
+     * These will be used to detect pagination fields in schemas and parameters.
+     *
+     * @default ['after', 'before', 'cursor', 'offset', 'page', 'start']
+     */
+    keywords?: ReadonlyArray<string>;
+  };
   /**
    * Path to the OpenAPI specification. This can be either local or remote path.
    * Both JSON and YAML file formats are supported. You can also pass the parsed
@@ -7199,6 +7211,7 @@ interface Input {
    * the first match will be returned.
    */
   tags?: ReadonlyArray<string>;
+
   /**
    * **Requires `path` to start with `https://get.heyapi.dev` or be undefined**
    *
@@ -7874,15 +7887,16 @@ declare const utils: {
     }) => string;
 };
 
+type Configs = UserConfig | (() => UserConfig) | (() => Promise<UserConfig>);
 /**
  * Generate a client from the provided configuration.
  *
  * @param userConfig User provided {@link UserConfig} configuration.
  */
-declare const createClient: (userConfig: UserConfig) => Promise<ReadonlyArray<Client$1 | IR.Context>>;
+declare const createClient: (userConfig?: Configs) => Promise<ReadonlyArray<Client$1 | IR.Context>>;
 /**
  * Type helper for openapi-ts.config.ts, returns {@link UserConfig} object
  */
-declare const defineConfig: (config: UserConfig) => UserConfig;
+declare const defineConfig: (config: Configs) => Promise<UserConfig>;
 
 export { IR, LegacyIR, OpenApi, Plugin, type UserConfig, createClient, defaultPlugins, defineConfig, utils };