@hey-api/openapi-ts 0.64.9 → 0.64.11

package/dist/index.d.cts

@@ -7123,6 +7123,92 @@ type StringCase =
   | 'snake_case'
   | 'SCREAMING_SNAKE_CASE';
 
+interface Input {
+  /**
+   * **Requires `path` to start with `https://get.heyapi.dev` or be undefined**
+   *
+   * Projects are private by default, you will need to be authenticated
+   * to download OpenAPI specifications. We recommend using project API
+   * keys in CI workflows and personal API keys for local development.
+   *
+   * API key isn't required for public projects. You can also omit this
+   * parameter and provide an environment variable `HEY_API_TOKEN`.
+   */
+  api_key?: string;
+  /**
+   * **Requires `path` to start with `https://get.heyapi.dev` or be undefined**
+   *
+   * You can fetch the last build from branch by providing the branch
+   * name.
+   */
+  branch?: string;
+  /**
+   * **Requires `path` to start with `https://get.heyapi.dev` or be undefined**
+   *
+   * You can fetch an exact specification by providing a commit sha.
+   * This will always return the same file.
+   */
+  commit_sha?: string;
+  /**
+   * Prevent parts matching the regular expression from being processed.
+   * You can select both operations and components by reference within
+   * the bundled input. In case of conflicts, `exclude` takes precedence
+   * over `include`.
+   *
+   * @example
+   * operation: '^#/paths/api/v1/foo/get$'
+   * schema: '^#/components/schemas/Foo$'
+   */
+  exclude?: string;
+  /**
+   * 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`.
+   *
+   * @example
+   * operation: '^#/paths/api/v1/foo/get$'
+   * schema: '^#/components/schemas/Foo$'
+   */
+  include?: string;
+  /**
+   * **Requires `path` to start with `https://get.heyapi.dev` or be undefined**
+   *
+   * Organization created in Hey API platform.
+   */
+  organization?: 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?:
+    | 'https://get.heyapi.dev/<organization>/<project>'
+    | (string & {})
+    | Record<string, unknown>;
+  /**
+   * **Requires `path` to start with `https://get.heyapi.dev` or be undefined**
+   *
+   * Project created in Hey API platform.
+   */
+  project?: string;
+  /**
+   * **Requires `path` to start with `https://get.heyapi.dev` or be undefined**
+   *
+   * If you're tagging your specifications with custom tags, you can use
+   * them to filter the results. When you provide multiple tags, only
+   * the first match will be returned.
+   */
+  tags?: ReadonlyArray<string>;
+  /**
+   * **Requires `path` to start with `https://get.heyapi.dev` or be undefined**
+   *
+   * Every OpenAPI document contains a required version field. You can
+   * use this value to fetch the last uploaded specification matching
+   * the value.
+   */
+  version?: string;
+}
+
 interface UserConfig {
   /**
    * Path to the config file. Set this value if you don't use the default
@@ -7143,37 +7229,10 @@ interface UserConfig {
    * Alternatively, you can define a configuration object with more options.
    */
   input:
-    | string
+    | 'https://get.heyapi.dev/<organization>/<project>'
+    | (string & {})
     | Record<string, unknown>
-    | {
-        /**
-         * Prevent parts matching the regular expression from being processed.
-         * You can select both operations and components by reference within
-         * the bundled input. In case of conflicts, `exclude` takes precedence
-         * over `include`.
-         *
-         * @example
-         * operation: '^#/paths/api/v1/foo/get$'
-         * schema: '^#/components/schemas/Foo$'
-         */
-        exclude?: string;
-        /**
-         * 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`.
-         *
-         * @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>;
-      };
+    | Input;
   /**
    * The relative location of the logs folder
    *
@@ -7364,7 +7423,7 @@ type Config = Omit<
   | 'watch'
 > &
   Pick<UserConfig, 'base' | 'name' | 'request'> & {
-    input: ExtractWithDiscriminator<UserConfig['input'], { path: unknown }>;
+    input: Omit<Input, 'path'> & Pick<Required<Input>, 'path'>;
     logs: Extract<Required<UserConfig['logs']>, object>;
     output: Extract<UserConfig['output'], object>;
     pluginOrder: ReadonlyArray<ClientPlugins['name']>;

package/dist/index.d.ts

@@ -7123,6 +7123,92 @@ type StringCase =
   | 'snake_case'
   | 'SCREAMING_SNAKE_CASE';
 
+interface Input {
+  /**
+   * **Requires `path` to start with `https://get.heyapi.dev` or be undefined**
+   *
+   * Projects are private by default, you will need to be authenticated
+   * to download OpenAPI specifications. We recommend using project API
+   * keys in CI workflows and personal API keys for local development.
+   *
+   * API key isn't required for public projects. You can also omit this
+   * parameter and provide an environment variable `HEY_API_TOKEN`.
+   */
+  api_key?: string;
+  /**
+   * **Requires `path` to start with `https://get.heyapi.dev` or be undefined**
+   *
+   * You can fetch the last build from branch by providing the branch
+   * name.
+   */
+  branch?: string;
+  /**
+   * **Requires `path` to start with `https://get.heyapi.dev` or be undefined**
+   *
+   * You can fetch an exact specification by providing a commit sha.
+   * This will always return the same file.
+   */
+  commit_sha?: string;
+  /**
+   * Prevent parts matching the regular expression from being processed.
+   * You can select both operations and components by reference within
+   * the bundled input. In case of conflicts, `exclude` takes precedence
+   * over `include`.
+   *
+   * @example
+   * operation: '^#/paths/api/v1/foo/get$'
+   * schema: '^#/components/schemas/Foo$'
+   */
+  exclude?: string;
+  /**
+   * 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`.
+   *
+   * @example
+   * operation: '^#/paths/api/v1/foo/get$'
+   * schema: '^#/components/schemas/Foo$'
+   */
+  include?: string;
+  /**
+   * **Requires `path` to start with `https://get.heyapi.dev` or be undefined**
+   *
+   * Organization created in Hey API platform.
+   */
+  organization?: 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?:
+    | 'https://get.heyapi.dev/<organization>/<project>'
+    | (string & {})
+    | Record<string, unknown>;
+  /**
+   * **Requires `path` to start with `https://get.heyapi.dev` or be undefined**
+   *
+   * Project created in Hey API platform.
+   */
+  project?: string;
+  /**
+   * **Requires `path` to start with `https://get.heyapi.dev` or be undefined**
+   *
+   * If you're tagging your specifications with custom tags, you can use
+   * them to filter the results. When you provide multiple tags, only
+   * the first match will be returned.
+   */
+  tags?: ReadonlyArray<string>;
+  /**
+   * **Requires `path` to start with `https://get.heyapi.dev` or be undefined**
+   *
+   * Every OpenAPI document contains a required version field. You can
+   * use this value to fetch the last uploaded specification matching
+   * the value.
+   */
+  version?: string;
+}
+
 interface UserConfig {
   /**
    * Path to the config file. Set this value if you don't use the default
@@ -7143,37 +7229,10 @@ interface UserConfig {
    * Alternatively, you can define a configuration object with more options.
    */
   input:
-    | string
+    | 'https://get.heyapi.dev/<organization>/<project>'
+    | (string & {})
     | Record<string, unknown>
-    | {
-        /**
-         * Prevent parts matching the regular expression from being processed.
-         * You can select both operations and components by reference within
-         * the bundled input. In case of conflicts, `exclude` takes precedence
-         * over `include`.
-         *
-         * @example
-         * operation: '^#/paths/api/v1/foo/get$'
-         * schema: '^#/components/schemas/Foo$'
-         */
-        exclude?: string;
-        /**
-         * 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`.
-         *
-         * @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>;
-      };
+    | Input;
   /**
    * The relative location of the logs folder
    *
@@ -7364,7 +7423,7 @@ type Config = Omit<
   | 'watch'
 > &
   Pick<UserConfig, 'base' | 'name' | 'request'> & {
-    input: ExtractWithDiscriminator<UserConfig['input'], { path: unknown }>;
+    input: Omit<Input, 'path'> & Pick<Required<Input>, 'path'>;
     logs: Extract<Required<UserConfig['logs']>, object>;
     output: Extract<UserConfig['output'], object>;
     pluginOrder: ReadonlyArray<ClientPlugins['name']>;