@hey-api/openapi-ts 0.58.0 → 0.59.1

package/dist/index.d.cts

@@ -1,4 +1,4 @@
-import { rmSync } from 'node:fs';
+import fs from 'node:fs';
 import ts from 'typescript';
 
 interface ImportExportItemObject {
@@ -4165,7 +4165,7 @@ interface Config$a extends Plugin.Name<'@hey-api/sdk'> {
 interface Config$9 extends Plugin.Name<'@hey-api/transformers'> {
   /**
    * Convert date strings into Date objects?
-   * @default false
+   * @default true
    */
   dates?: boolean;
   /**
@@ -4408,12 +4408,6 @@ type Formatters = 'biome' | 'prettier';
 type Linters = 'biome' | 'eslint' | 'oxlint';
 type StringCase = 'camelCase' | 'PascalCase' | 'preserve' | 'snake_case' | 'SCREAMING_SNAKE_CASE';
 interface ClientConfig {
-    /**
-     * Manually set base in OpenAPI config instead of inferring from server value
-     *
-     * @deprecated
-     */
-    base?: string;
     /**
      * HTTP client to generate
      */
@@ -4439,12 +4433,6 @@ interface ClientConfig {
      * config file name, or it's not located in the project root.
      */
     configFile?: string;
-    /**
-     * Run in debug mode?
-     *
-     * @default false
-     */
-    debug?: boolean;
     /**
      * Skip writing files to disk?
      *
@@ -4457,12 +4445,6 @@ interface ClientConfig {
      * @default false
      */
     experimentalParser?: boolean;
-    /**
-     * Generate core client classes?
-     *
-     * @default true
-     */
-    exportCore?: boolean;
     /**
      * 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
@@ -4486,7 +4468,7 @@ interface ClientConfig {
         exclude?: string;
         /**
          * **This feature works only with the experimental parser**
-
+         *
          * Process only parts matching the regular expression. You can select both
          * operations and components by reference within the bundled input. In
          * case of conflicts, `exclude` takes precedence over `include`.
@@ -4504,14 +4486,36 @@ interface ClientConfig {
         path: string | Record<string, unknown>;
     };
     /**
-     * Custom client class name. Please note this option is deprecated and
-     * will be removed in favor of clients.
-     *
-     * @link https://heyapi.dev/openapi-ts/migrating.html#deprecated-name
+     * The relative location of the logs folder
      *
-     * @deprecated
+     * @default process.cwd()
      */
-    name?: string;
+    logs?: string | {
+        /**
+         * The logging level to control the verbosity of log output.
+         * Determines which messages are logged based on their severity.
+         *
+         * Available levels (in increasing order of severity):
+         * - `trace`: Detailed debug information, primarily for development.
+         * - `debug`: Diagnostic information useful during debugging.
+         * - `info`: General operational messages that indicate normal application behavior.
+         * - `warn`: Potentially problematic situations that require attention.
+         * - `error`: Errors that prevent some functionality but do not crash the application.
+         * - `fatal`: Critical errors that cause the application to terminate.
+         * - `silent`: Disables all logging.
+         *
+         * Messages with a severity equal to or higher than the specified level will be logged.
+         *
+         * @default 'info'
+         */
+        level?: 'debug' | 'error' | 'fatal' | 'info' | 'silent' | 'trace' | 'warn';
+        /**
+         * The relative location of the logs folder
+         *
+         * @default process.cwd()
+         */
+        path?: string;
+    };
     /**
      * The relative location of the output folder
      */
@@ -4552,9 +4556,36 @@ interface ClientConfig {
         path: string;
     };
     /**
-     * Plugins are used to generate artifacts from provided input.
+     * Plugins generate artifacts from `input`. By default, we generate SDK
+     * functions and TypeScript interfaces. If you manually define `plugins`,
+     * you need to include the default plugins if you wish to use them.
+     *
+     * @default ['@hey-api/typescript', '@hey-api/sdk']
      */
     plugins?: ReadonlyArray<UserPlugins['name'] | UserPlugins>;
+    /**
+     * Manually set base in OpenAPI config instead of inferring from server value
+     *
+     * @deprecated
+     */
+    base?: string;
+    /**
+     * Generate core client classes?
+     *
+     * @deprecated
+     *
+     * @default true
+     */
+    exportCore?: boolean;
+    /**
+     * Custom client class name. Please note this option is deprecated and
+     * will be removed in favor of clients.
+     *
+     * @link https://heyapi.dev/openapi-ts/migrating.html#deprecated-name
+     *
+     * @deprecated
+     */
+    name?: string;
     /**
      * Path to custom request file. Please note this option is deprecated and
      * will be removed in favor of clients.
@@ -4578,11 +4609,12 @@ interface ClientConfig {
 }
 interface UserConfig extends ClientConfig {
 }
-type Config = Omit<Required<ClientConfig>, 'base' | 'client' | 'input' | 'name' | 'output' | 'plugins' | 'request'> & Pick<ClientConfig, 'base' | 'name' | 'request'> & {
+type Config = Omit<Required<ClientConfig>, 'base' | 'client' | 'input' | 'logs' | 'name' | 'output' | 'plugins' | 'request'> & Pick<ClientConfig, 'base' | 'name' | 'request'> & {
     client: Extract<Required<ClientConfig>['client'], object>;
     input: ExtractWithDiscriminator<ClientConfig['input'], {
         path: unknown;
     }>;
+    logs: Extract<Required<ClientConfig['logs']>, object>;
     output: Extract<ClientConfig['output'], object>;
     pluginOrder: ReadonlyArray<ClientPlugins['name']>;
     plugins: ArrayOfObjectsToObjectMap<ExtractArrayOfObjects<ReadonlyArray<ClientPlugins>, {
@@ -4665,7 +4697,7 @@ declare class TypeScriptFile {
         context: IRContext;
         id: string;
     }): string;
-    remove(options?: Parameters<typeof rmSync>[1]): void;
+    remove(options?: Parameters<typeof fs.rmSync>[1]): void;
     /**
      * Removes last node form the stack. Works as undo.
      */
@@ -4679,8 +4711,11 @@ interface EnsureUniqueIdentifierData {
     case: StringCase | undefined;
     count?: number;
     create?: boolean;
+    /**
+     * Transforms name obtained from `$ref` before it's passed to `stringCase()`.
+     */
+    nameTransformer?: (name: string) => string;
     namespace: Namespace;
-    validNameTransformer?: (value: string) => string;
 }
 
 interface ContextFile {
@@ -5586,6 +5621,10 @@ interface Client extends Omit<Client$1, 'operations'> {
  * @param userConfig {@link UserConfig} passed to the `createClient()` method
  */
 declare function createClient(userConfig: UserConfig): Promise<ReadonlyArray<Client>>;
+/**
+ * Default plugins used to generate artifacts if plugins aren't specified.
+ */
+declare const defaultPlugins: readonly ["@hey-api/typescript", "@hey-api/sdk"];
 /**
  * Type helper for openapi-ts.config.ts, returns {@link UserConfig} object
  */
@@ -5595,4 +5634,4 @@ declare const _default: {
     defineConfig: (config: UserConfig) => UserConfig;
 };
 
-export { type OpenApiV3_0_X, type OpenApiV3_1_X, Plugin, type UserConfig, createClient, _default as default, defineConfig };
+export { type OpenApiV3_0_X, type OpenApiV3_1_X, Plugin, type UserConfig, createClient, _default as default, defaultPlugins, defineConfig };

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { rmSync } from 'node:fs';
+import fs from 'node:fs';
 import ts from 'typescript';
 
 interface ImportExportItemObject {
@@ -4165,7 +4165,7 @@ interface Config$a extends Plugin.Name<'@hey-api/sdk'> {
 interface Config$9 extends Plugin.Name<'@hey-api/transformers'> {
   /**
    * Convert date strings into Date objects?
-   * @default false
+   * @default true
    */
   dates?: boolean;
   /**
@@ -4408,12 +4408,6 @@ type Formatters = 'biome' | 'prettier';
 type Linters = 'biome' | 'eslint' | 'oxlint';
 type StringCase = 'camelCase' | 'PascalCase' | 'preserve' | 'snake_case' | 'SCREAMING_SNAKE_CASE';
 interface ClientConfig {
-    /**
-     * Manually set base in OpenAPI config instead of inferring from server value
-     *
-     * @deprecated
-     */
-    base?: string;
     /**
      * HTTP client to generate
      */
@@ -4439,12 +4433,6 @@ interface ClientConfig {
      * config file name, or it's not located in the project root.
      */
     configFile?: string;
-    /**
-     * Run in debug mode?
-     *
-     * @default false
-     */
-    debug?: boolean;
     /**
      * Skip writing files to disk?
      *
@@ -4457,12 +4445,6 @@ interface ClientConfig {
      * @default false
      */
     experimentalParser?: boolean;
-    /**
-     * Generate core client classes?
-     *
-     * @default true
-     */
-    exportCore?: boolean;
     /**
      * 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
@@ -4486,7 +4468,7 @@ interface ClientConfig {
         exclude?: string;
         /**
          * **This feature works only with the experimental parser**
-
+         *
          * Process only parts matching the regular expression. You can select both
          * operations and components by reference within the bundled input. In
          * case of conflicts, `exclude` takes precedence over `include`.
@@ -4504,14 +4486,36 @@ interface ClientConfig {
         path: string | Record<string, unknown>;
     };
     /**
-     * Custom client class name. Please note this option is deprecated and
-     * will be removed in favor of clients.
-     *
-     * @link https://heyapi.dev/openapi-ts/migrating.html#deprecated-name
+     * The relative location of the logs folder
      *
-     * @deprecated
+     * @default process.cwd()
      */
-    name?: string;
+    logs?: string | {
+        /**
+         * The logging level to control the verbosity of log output.
+         * Determines which messages are logged based on their severity.
+         *
+         * Available levels (in increasing order of severity):
+         * - `trace`: Detailed debug information, primarily for development.
+         * - `debug`: Diagnostic information useful during debugging.
+         * - `info`: General operational messages that indicate normal application behavior.
+         * - `warn`: Potentially problematic situations that require attention.
+         * - `error`: Errors that prevent some functionality but do not crash the application.
+         * - `fatal`: Critical errors that cause the application to terminate.
+         * - `silent`: Disables all logging.
+         *
+         * Messages with a severity equal to or higher than the specified level will be logged.
+         *
+         * @default 'info'
+         */
+        level?: 'debug' | 'error' | 'fatal' | 'info' | 'silent' | 'trace' | 'warn';
+        /**
+         * The relative location of the logs folder
+         *
+         * @default process.cwd()
+         */
+        path?: string;
+    };
     /**
      * The relative location of the output folder
      */
@@ -4552,9 +4556,36 @@ interface ClientConfig {
         path: string;
     };
     /**
-     * Plugins are used to generate artifacts from provided input.
+     * Plugins generate artifacts from `input`. By default, we generate SDK
+     * functions and TypeScript interfaces. If you manually define `plugins`,
+     * you need to include the default plugins if you wish to use them.
+     *
+     * @default ['@hey-api/typescript', '@hey-api/sdk']
      */
     plugins?: ReadonlyArray<UserPlugins['name'] | UserPlugins>;
+    /**
+     * Manually set base in OpenAPI config instead of inferring from server value
+     *
+     * @deprecated
+     */
+    base?: string;
+    /**
+     * Generate core client classes?
+     *
+     * @deprecated
+     *
+     * @default true
+     */
+    exportCore?: boolean;
+    /**
+     * Custom client class name. Please note this option is deprecated and
+     * will be removed in favor of clients.
+     *
+     * @link https://heyapi.dev/openapi-ts/migrating.html#deprecated-name
+     *
+     * @deprecated
+     */
+    name?: string;
     /**
      * Path to custom request file. Please note this option is deprecated and
      * will be removed in favor of clients.
@@ -4578,11 +4609,12 @@ interface ClientConfig {
 }
 interface UserConfig extends ClientConfig {
 }
-type Config = Omit<Required<ClientConfig>, 'base' | 'client' | 'input' | 'name' | 'output' | 'plugins' | 'request'> & Pick<ClientConfig, 'base' | 'name' | 'request'> & {
+type Config = Omit<Required<ClientConfig>, 'base' | 'client' | 'input' | 'logs' | 'name' | 'output' | 'plugins' | 'request'> & Pick<ClientConfig, 'base' | 'name' | 'request'> & {
     client: Extract<Required<ClientConfig>['client'], object>;
     input: ExtractWithDiscriminator<ClientConfig['input'], {
         path: unknown;
     }>;
+    logs: Extract<Required<ClientConfig['logs']>, object>;
     output: Extract<ClientConfig['output'], object>;
     pluginOrder: ReadonlyArray<ClientPlugins['name']>;
     plugins: ArrayOfObjectsToObjectMap<ExtractArrayOfObjects<ReadonlyArray<ClientPlugins>, {
@@ -4665,7 +4697,7 @@ declare class TypeScriptFile {
         context: IRContext;
         id: string;
     }): string;
-    remove(options?: Parameters<typeof rmSync>[1]): void;
+    remove(options?: Parameters<typeof fs.rmSync>[1]): void;
     /**
      * Removes last node form the stack. Works as undo.
      */
@@ -4679,8 +4711,11 @@ interface EnsureUniqueIdentifierData {
     case: StringCase | undefined;
     count?: number;
     create?: boolean;
+    /**
+     * Transforms name obtained from `$ref` before it's passed to `stringCase()`.
+     */
+    nameTransformer?: (name: string) => string;
     namespace: Namespace;
-    validNameTransformer?: (value: string) => string;
 }
 
 interface ContextFile {
@@ -5586,6 +5621,10 @@ interface Client extends Omit<Client$1, 'operations'> {
  * @param userConfig {@link UserConfig} passed to the `createClient()` method
  */
 declare function createClient(userConfig: UserConfig): Promise<ReadonlyArray<Client>>;
+/**
+ * Default plugins used to generate artifacts if plugins aren't specified.
+ */
+declare const defaultPlugins: readonly ["@hey-api/typescript", "@hey-api/sdk"];
 /**
  * Type helper for openapi-ts.config.ts, returns {@link UserConfig} object
  */
@@ -5595,4 +5634,4 @@ declare const _default: {
     defineConfig: (config: UserConfig) => UserConfig;
 };
 
-export { type OpenApiV3_0_X, type OpenApiV3_1_X, Plugin, type UserConfig, createClient, _default as default, defineConfig };
+export { type OpenApiV3_0_X, type OpenApiV3_1_X, Plugin, type UserConfig, createClient, _default as default, defaultPlugins, defineConfig };