@hey-api/openapi-ts 0.64.15 → 0.66.0

package/dist/index.d.cts

@@ -6468,7 +6468,7 @@ declare namespace Plugin {
     };
 
   export type DefineConfig<Config extends BaseConfig> = (
-    config?: Plugin.UserConfig<Config>,
+    config?: Plugin.UserConfig<Omit<Config, 'name'>>,
   ) => Omit<Plugin.Config<Config>, 'name'> & {
     /**
      * Cast name to `any` so it doesn't throw type error in `plugins` array.
@@ -6538,6 +6538,14 @@ interface Config$i
   extends Plugin.Name<'@hey-api/client-nuxt'>,
     Client.Config {}
 
+type PluginHandler<ReturnType = void> = Plugin.Handler<
+  Omit<
+    Config$h | Config$k | Config$j | Config$i,
+    'name'
+  >,
+  ReturnType
+>;
+
 /**
  * Public Client API.
  */
@@ -6567,6 +6575,16 @@ declare namespace Client {
      * @default false
      */
     bundle?: boolean;
+    /**
+     * **This is an experimental feature.**
+     *
+     * When `bundle` is set to `true`, you can optionally set this option
+     * to `true` to bundle the client source code instead of the `dist` folder.
+     * This will copy the TypeScript files instead of CJS/ESM JavaScript files.
+     *
+     * @default false
+     */
+    bundleSource_EXPERIMENTAL?: boolean;
     /**
      * Should the exports from the generated files be re-exported in the index
      * barrel file?
@@ -6715,18 +6733,6 @@ interface Config$a extends Plugin.Name<'@hey-api/sdk'> {
    * @default true
    */
   exportFromIndex?: boolean;
-  /**
-   * @deprecated
-   *
-   * **This feature works only with the legacy parser**
-   *
-   * Filter endpoints to be included in the generated SDK. The provided
-   * string should be a regular expression where matched results will be
-   * included in the output. The input pattern this string will be tested
-   * against is `{method} {path}`. For example, you can match
-   * `POST /api/v1/foo` with `^POST /api/v1/foo$`.
-   */
-  filter?: string;
   /**
    * Include only service classes with names matching regular expression
    *
@@ -6750,14 +6756,6 @@ interface Config$a extends Plugin.Name<'@hey-api/sdk'> {
    * @default 'sdk'
    */
   output?: string;
-  /**
-   * @deprecated
-   *
-   * Define shape of returned value from service calls
-   *
-   * @default 'body'
-   */
-  response?: 'body' | 'response';
   /**
    * Customize the generated service class names. The name variable is
    * obtained from your OpenAPI specification tags.
@@ -6793,6 +6791,30 @@ interface Config$a extends Plugin.Name<'@hey-api/sdk'> {
    * @default false
    */
   validator?: PluginValidatorNames | boolean;
+
+  // DEPRECATED OPTIONS BELOW
+
+  /**
+   * @deprecated
+   *
+   * **This feature works only with the legacy parser**
+   *
+   * Filter endpoints to be included in the generated SDK. The provided
+   * string should be a regular expression where matched results will be
+   * included in the output. The input pattern this string will be tested
+   * against is `{method} {path}`. For example, you can match
+   * `POST /api/v1/foo` with `^POST /api/v1/foo$`.
+   */
+  // eslint-disable-next-line typescript-sort-keys/interface
+  filter?: string;
+  /**
+   * @deprecated
+   *
+   * Define shape of returned value from service calls
+   *
+   * @default 'body'
+   */
+  response?: 'body' | 'response';
 }
 
 interface Config$9 extends Plugin.Name<'@hey-api/transformers'> {
@@ -6861,6 +6883,37 @@ interface Config$8 extends Plugin.Name<'@hey-api/typescript'> {
    * @default 'PascalCase'
    */
   identifierCase?: Exclude<StringCase, 'SCREAMING_SNAKE_CASE'>;
+  /**
+   * Name of the generated file.
+   *
+   * @default 'types'
+   */
+  output?: string;
+  /**
+   * Choose how to handle types containing read-only or write-only fields?
+   * This option exists for backward compatibility with outputs created before
+   * this feature existed.
+   *
+   * @default 'split'
+   */
+  readOnlyWriteOnlyBehavior?: 'off' | 'split';
+  /**
+   * Customize the name of types used in responses or containing read-only
+   * fields.
+   *
+   * @default '{{name}}Readable'
+   */
+  readableNameBuilder?: string;
+  /**
+   * Customize the name of types used in payloads or containing write-only
+   * fields.
+   *
+   * @default '{{name}}Writable'
+   */
+  writableNameBuilder?: string;
+
+  // DEPRECATED OPTIONS BELOW
+
   /**
    * @deprecated
    *
@@ -6868,13 +6921,8 @@ interface Config$8 extends Plugin.Name<'@hey-api/typescript'> {
    *
    * Include only types matching regular expression.
    */
+  // eslint-disable-next-line typescript-sort-keys/interface
   include?: string;
-  /**
-   * Name of the generated file.
-   *
-   * @default 'types'
-   */
-  output?: string;
   /**
    * @deprecated
    *
@@ -7160,6 +7208,11 @@ interface Input {
    * schema: '^#/components/schemas/Foo$'
    */
   exclude?: string;
+  /**
+   * You pass any valid Fetch API options to the request for fetching your
+   * specification. This is useful if your file is behind auth for example.
+   */
+  fetch?: RequestInit;
   /**
    * Process only parts matching the regular expression. You can select both
    * operations and components by reference within the bundled input. In
@@ -7244,7 +7297,7 @@ interface UserConfig {
   input:
     | 'https://get.heyapi.dev/<organization>/<project>'
     | (string & {})
-    | Record<string, unknown>
+    | (Record<string, unknown> & { path?: never })
     | Input;
   /**
    * The relative location of the logs folder
@@ -7254,6 +7307,12 @@ interface UserConfig {
   logs?:
     | string
     | {
+        /**
+         * Whether or not error logs should be written to a file or not
+         *
+         * @default true
+         * */
+        file?: boolean;
         /**
          * The logging level to control the verbosity of log output.
          * Determines which messages are logged based on their severity.
@@ -7279,6 +7338,7 @@ interface UserConfig {
           | 'silent'
           | 'trace'
           | 'warn';
+
         /**
          * The relative location of the logs folder
          *
@@ -7370,6 +7430,9 @@ interface UserConfig {
          */
         timeout?: number;
       };
+
+  // DEPRECATED OPTIONS BELOW
+
   /**
    * @deprecated
    *
@@ -7795,9 +7858,16 @@ interface IRSchemaObject
   > {
   /**
    * If the schema is intended to be used as an object property, it can be
-   * marked as read-only or write-only.
+   * marked as read-only or write-only. This value controls whether the schema
+   * receives the "readonly" TypeScript keyword.
    */
   accessScope?: 'read' | 'write';
+  /**
+   * Similar to `accessScope`, but tells us whether the schema as a whole
+   * contains any read-only or write-only fields. This value controls whether
+   * we split the schema into individual schemas for payloads and responses.
+   */
+  accessScopes?: ReadonlyArray<'read' | 'write'>;
   /**
    * If type is `object`, `additionalProperties` can be used to either define
    * a schema for properties not included in `properties` or disallow such
@@ -7875,6 +7945,17 @@ declare namespace IR {
  */
 declare const defaultPlugins: readonly ["@hey-api/typescript", "@hey-api/sdk"];
 
+declare const clientDefaultConfig: {
+    readonly _dependencies: readonly ["@hey-api/typescript"];
+    readonly _tags: readonly ["client"];
+    readonly baseUrl: true;
+    readonly bundle: false;
+    readonly exportFromIndex: false;
+    readonly output: "client";
+};
+
+declare const clientPluginHandler: PluginHandler;
+
 declare namespace LegacyIR {
   export type LegacyOperation = Operation;
 }
@@ -7899,4 +7980,4 @@ declare const createClient: (userConfig?: Configs) => Promise<ReadonlyArray<Clie
  */
 declare const defineConfig: (config: Configs) => Promise<UserConfig>;
 
-export { IR, LegacyIR, OpenApi, Plugin, type UserConfig, createClient, defaultPlugins, defineConfig, utils };
+export { Client, IR, LegacyIR, OpenApi, Plugin, type UserConfig, clientDefaultConfig, clientPluginHandler, createClient, defaultPlugins, defineConfig, utils };

package/dist/index.d.ts

@@ -6468,7 +6468,7 @@ declare namespace Plugin {
     };
 
   export type DefineConfig<Config extends BaseConfig> = (
-    config?: Plugin.UserConfig<Config>,
+    config?: Plugin.UserConfig<Omit<Config, 'name'>>,
   ) => Omit<Plugin.Config<Config>, 'name'> & {
     /**
      * Cast name to `any` so it doesn't throw type error in `plugins` array.
@@ -6538,6 +6538,14 @@ interface Config$i
   extends Plugin.Name<'@hey-api/client-nuxt'>,
     Client.Config {}
 
+type PluginHandler<ReturnType = void> = Plugin.Handler<
+  Omit<
+    Config$h | Config$k | Config$j | Config$i,
+    'name'
+  >,
+  ReturnType
+>;
+
 /**
  * Public Client API.
  */
@@ -6567,6 +6575,16 @@ declare namespace Client {
      * @default false
      */
     bundle?: boolean;
+    /**
+     * **This is an experimental feature.**
+     *
+     * When `bundle` is set to `true`, you can optionally set this option
+     * to `true` to bundle the client source code instead of the `dist` folder.
+     * This will copy the TypeScript files instead of CJS/ESM JavaScript files.
+     *
+     * @default false
+     */
+    bundleSource_EXPERIMENTAL?: boolean;
     /**
      * Should the exports from the generated files be re-exported in the index
      * barrel file?
@@ -6715,18 +6733,6 @@ interface Config$a extends Plugin.Name<'@hey-api/sdk'> {
    * @default true
    */
   exportFromIndex?: boolean;
-  /**
-   * @deprecated
-   *
-   * **This feature works only with the legacy parser**
-   *
-   * Filter endpoints to be included in the generated SDK. The provided
-   * string should be a regular expression where matched results will be
-   * included in the output. The input pattern this string will be tested
-   * against is `{method} {path}`. For example, you can match
-   * `POST /api/v1/foo` with `^POST /api/v1/foo$`.
-   */
-  filter?: string;
   /**
    * Include only service classes with names matching regular expression
    *
@@ -6750,14 +6756,6 @@ interface Config$a extends Plugin.Name<'@hey-api/sdk'> {
    * @default 'sdk'
    */
   output?: string;
-  /**
-   * @deprecated
-   *
-   * Define shape of returned value from service calls
-   *
-   * @default 'body'
-   */
-  response?: 'body' | 'response';
   /**
    * Customize the generated service class names. The name variable is
    * obtained from your OpenAPI specification tags.
@@ -6793,6 +6791,30 @@ interface Config$a extends Plugin.Name<'@hey-api/sdk'> {
    * @default false
    */
   validator?: PluginValidatorNames | boolean;
+
+  // DEPRECATED OPTIONS BELOW
+
+  /**
+   * @deprecated
+   *
+   * **This feature works only with the legacy parser**
+   *
+   * Filter endpoints to be included in the generated SDK. The provided
+   * string should be a regular expression where matched results will be
+   * included in the output. The input pattern this string will be tested
+   * against is `{method} {path}`. For example, you can match
+   * `POST /api/v1/foo` with `^POST /api/v1/foo$`.
+   */
+  // eslint-disable-next-line typescript-sort-keys/interface
+  filter?: string;
+  /**
+   * @deprecated
+   *
+   * Define shape of returned value from service calls
+   *
+   * @default 'body'
+   */
+  response?: 'body' | 'response';
 }
 
 interface Config$9 extends Plugin.Name<'@hey-api/transformers'> {
@@ -6861,6 +6883,37 @@ interface Config$8 extends Plugin.Name<'@hey-api/typescript'> {
    * @default 'PascalCase'
    */
   identifierCase?: Exclude<StringCase, 'SCREAMING_SNAKE_CASE'>;
+  /**
+   * Name of the generated file.
+   *
+   * @default 'types'
+   */
+  output?: string;
+  /**
+   * Choose how to handle types containing read-only or write-only fields?
+   * This option exists for backward compatibility with outputs created before
+   * this feature existed.
+   *
+   * @default 'split'
+   */
+  readOnlyWriteOnlyBehavior?: 'off' | 'split';
+  /**
+   * Customize the name of types used in responses or containing read-only
+   * fields.
+   *
+   * @default '{{name}}Readable'
+   */
+  readableNameBuilder?: string;
+  /**
+   * Customize the name of types used in payloads or containing write-only
+   * fields.
+   *
+   * @default '{{name}}Writable'
+   */
+  writableNameBuilder?: string;
+
+  // DEPRECATED OPTIONS BELOW
+
   /**
    * @deprecated
    *
@@ -6868,13 +6921,8 @@ interface Config$8 extends Plugin.Name<'@hey-api/typescript'> {
    *
    * Include only types matching regular expression.
    */
+  // eslint-disable-next-line typescript-sort-keys/interface
   include?: string;
-  /**
-   * Name of the generated file.
-   *
-   * @default 'types'
-   */
-  output?: string;
   /**
    * @deprecated
    *
@@ -7160,6 +7208,11 @@ interface Input {
    * schema: '^#/components/schemas/Foo$'
    */
   exclude?: string;
+  /**
+   * You pass any valid Fetch API options to the request for fetching your
+   * specification. This is useful if your file is behind auth for example.
+   */
+  fetch?: RequestInit;
   /**
    * Process only parts matching the regular expression. You can select both
    * operations and components by reference within the bundled input. In
@@ -7244,7 +7297,7 @@ interface UserConfig {
   input:
     | 'https://get.heyapi.dev/<organization>/<project>'
     | (string & {})
-    | Record<string, unknown>
+    | (Record<string, unknown> & { path?: never })
     | Input;
   /**
    * The relative location of the logs folder
@@ -7254,6 +7307,12 @@ interface UserConfig {
   logs?:
     | string
     | {
+        /**
+         * Whether or not error logs should be written to a file or not
+         *
+         * @default true
+         * */
+        file?: boolean;
         /**
          * The logging level to control the verbosity of log output.
          * Determines which messages are logged based on their severity.
@@ -7279,6 +7338,7 @@ interface UserConfig {
           | 'silent'
           | 'trace'
           | 'warn';
+
         /**
          * The relative location of the logs folder
          *
@@ -7370,6 +7430,9 @@ interface UserConfig {
          */
         timeout?: number;
       };
+
+  // DEPRECATED OPTIONS BELOW
+
   /**
    * @deprecated
    *
@@ -7795,9 +7858,16 @@ interface IRSchemaObject
   > {
   /**
    * If the schema is intended to be used as an object property, it can be
-   * marked as read-only or write-only.
+   * marked as read-only or write-only. This value controls whether the schema
+   * receives the "readonly" TypeScript keyword.
    */
   accessScope?: 'read' | 'write';
+  /**
+   * Similar to `accessScope`, but tells us whether the schema as a whole
+   * contains any read-only or write-only fields. This value controls whether
+   * we split the schema into individual schemas for payloads and responses.
+   */
+  accessScopes?: ReadonlyArray<'read' | 'write'>;
   /**
    * If type is `object`, `additionalProperties` can be used to either define
    * a schema for properties not included in `properties` or disallow such
@@ -7875,6 +7945,17 @@ declare namespace IR {
  */
 declare const defaultPlugins: readonly ["@hey-api/typescript", "@hey-api/sdk"];
 
+declare const clientDefaultConfig: {
+    readonly _dependencies: readonly ["@hey-api/typescript"];
+    readonly _tags: readonly ["client"];
+    readonly baseUrl: true;
+    readonly bundle: false;
+    readonly exportFromIndex: false;
+    readonly output: "client";
+};
+
+declare const clientPluginHandler: PluginHandler;
+
 declare namespace LegacyIR {
   export type LegacyOperation = Operation;
 }
@@ -7899,4 +7980,4 @@ declare const createClient: (userConfig?: Configs) => Promise<ReadonlyArray<Clie
  */
 declare const defineConfig: (config: Configs) => Promise<UserConfig>;
 
-export { IR, LegacyIR, OpenApi, Plugin, type UserConfig, createClient, defaultPlugins, defineConfig, utils };
+export { Client, IR, LegacyIR, OpenApi, Plugin, type UserConfig, clientDefaultConfig, clientPluginHandler, createClient, defaultPlugins, defineConfig, utils };