@hey-api/openapi-ts 0.54.4 → 0.55.1

package/dist/index.d.cts

@@ -15,7 +15,8 @@ interface PluginName<Name extends PluginNames> {
 }
 
 interface CommonConfig {
-  name: PluginNames;
+  // eslint-disable-next-line @typescript-eslint/ban-types
+  name: PluginNames | (string & {});
   output?: string;
 }
 
@@ -3943,6 +3944,7 @@ interface IRSchemaObject
     | 'object'
     | 'string'
     | 'tuple'
+    | 'undefined'
     | 'unknown'
     | 'void';
 }
@@ -3965,6 +3967,10 @@ interface Config$7 extends PluginName<'@hey-api/services'> {
    * 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$`.
+   *
+   * This option does not work with the experimental parser.
+   *
+   * @deprecated
    */
   filter?: string;
   /**
@@ -4024,7 +4030,11 @@ interface Config$5 extends PluginName<'@hey-api/types'> {
    */
   enums?: 'javascript' | 'typescript' | 'typescript+namespace' | false;
   /**
-   * Include only types matching regular expression
+   * Include only types matching regular expression.
+   *
+   * This option does not work with the experimental parser.
+   *
+   * @deprecated
    */
   include?: string;
   /**
@@ -4224,9 +4234,29 @@ interface ClientConfig {
      */
     exportCore?: boolean;
     /**
-     * The relative location of the OpenAPI spec
+     * 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
+     * object directly if you're fetching the file yourself.
+     *
+     * Alternatively, you can define a configuration object with more options.
      */
-    input: string | Record<string, unknown>;
+    input: string | Record<string, unknown> | {
+        /**
+         * Process only parts matching the regular expression. You can select both
+         * operations and components by reference within the bundled input.
+         *
+         * @example
+         * operation: '^#/paths/api/v1/foo/get$'
+         * schema: '^#/components/schemas/Foo$'
+         */
+        include?: 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
+         * object directly if you're fetching the file yourself.
+         */
+        path: string | Record<string, unknown>;
+    };
     /**
      * Custom client class name. Please note this option is deprecated and
      * will be removed in favor of clients.

package/dist/index.d.ts

@@ -15,7 +15,8 @@ interface PluginName<Name extends PluginNames> {
 }
 
 interface CommonConfig {
-  name: PluginNames;
+  // eslint-disable-next-line @typescript-eslint/ban-types
+  name: PluginNames | (string & {});
   output?: string;
 }
 
@@ -3943,6 +3944,7 @@ interface IRSchemaObject
     | 'object'
     | 'string'
     | 'tuple'
+    | 'undefined'
     | 'unknown'
     | 'void';
 }
@@ -3965,6 +3967,10 @@ interface Config$7 extends PluginName<'@hey-api/services'> {
    * 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$`.
+   *
+   * This option does not work with the experimental parser.
+   *
+   * @deprecated
    */
   filter?: string;
   /**
@@ -4024,7 +4030,11 @@ interface Config$5 extends PluginName<'@hey-api/types'> {
    */
   enums?: 'javascript' | 'typescript' | 'typescript+namespace' | false;
   /**
-   * Include only types matching regular expression
+   * Include only types matching regular expression.
+   *
+   * This option does not work with the experimental parser.
+   *
+   * @deprecated
    */
   include?: string;
   /**
@@ -4224,9 +4234,29 @@ interface ClientConfig {
      */
     exportCore?: boolean;
     /**
-     * The relative location of the OpenAPI spec
+     * 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
+     * object directly if you're fetching the file yourself.
+     *
+     * Alternatively, you can define a configuration object with more options.
      */
-    input: string | Record<string, unknown>;
+    input: string | Record<string, unknown> | {
+        /**
+         * Process only parts matching the regular expression. You can select both
+         * operations and components by reference within the bundled input.
+         *
+         * @example
+         * operation: '^#/paths/api/v1/foo/get$'
+         * schema: '^#/components/schemas/Foo$'
+         */
+        include?: 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
+         * object directly if you're fetching the file yourself.
+         */
+        path: string | Record<string, unknown>;
+    };
     /**
      * Custom client class name. Please note this option is deprecated and
      * will be removed in favor of clients.