@hey-api/openapi-ts 0.59.1 → 0.60.0

package/dist/index.d.cts

@@ -24,6 +24,10 @@ type ArrayOfObjectsToObjectMap<T extends ReadonlyArray<Record<string, any>>, D e
     [K in T[number][D]]?: Extract<T[number], Record<D, K>>;
 };
 
+type OmitUnderscoreKeys<T> = {
+  [K in keyof T as K extends `_${string}` ? never : K]: T[K];
+};
+
 type PluginNames =
   | '@hey-api/schemas'
   | '@hey-api/sdk'
@@ -37,23 +41,39 @@ type PluginNames =
   | 'fastify'
   | 'zod';
 
+type PluginTag = 'transformer' | 'validator';
+
+interface PluginContext {
+  ensureDependency: (name: PluginNames | true) => void;
+  pluginByTag: (tag: PluginTag) => PluginNames | undefined;
+}
+
 interface BaseConfig {
   // eslint-disable-next-line @typescript-eslint/ban-types
   name: PluginNames | (string & {});
   output?: string;
 }
 
-interface Dependencies {
+interface Meta<Config extends BaseConfig> {
   /**
-   * Required dependencies will be always processed, regardless of whether
-   * a user defines them in their `plugins` config.
+   * Dependency plugins will be always processed, regardless of whether user
+   * explicitly defines them in their `plugins` config.
    */
   _dependencies?: ReadonlyArray<PluginNames>;
   /**
-   * Optional dependencies are not processed unless a user explicitly defines
-   * them in their `plugins` config.
+   * Allows overriding config before it's sent to the parser. An example is
+   * defining `validator` as `true` and the plugin figures out which plugin
+   * should be used for validation.
    */
-  _optionalDependencies?: ReadonlyArray<PluginNames>;
+  _infer?: (
+    config: Config & Omit<Meta<Config>, '_infer'>,
+    context: PluginContext,
+  ) => void;
+  /**
+   * Optional tags can be used to help with deciding plugin order and inferring
+   * plugin configuration options.
+   */
+  _tags?: ReadonlyArray<PluginTag>;
 }
 
 /**
@@ -61,7 +81,7 @@ interface Dependencies {
  */
 declare namespace Plugin {
   export type Config<Config extends BaseConfig> = Config &
-    Dependencies & {
+    Meta<Config> & {
       _handler: Plugin.Handler<Config>;
       _handlerLegacy: Plugin.LegacyHandler<Config>;
     };
@@ -78,10 +98,7 @@ declare namespace Plugin {
     plugin: Plugin.Instance<Config>;
   }) => void;
 
-  export type Instance<Config extends BaseConfig> = Omit<
-    Config,
-    '_dependencies' | '_handler' | '_handlerLegacy' | '_optionalDependencies'
-  > &
+  export type Instance<Config extends BaseConfig> = OmitUnderscoreKeys<Config> &
     Pick<Required<Config>, 'output'>;
 
   /**
@@ -3950,8 +3967,8 @@ interface IROperationObject {
   parameters?: IRParametersObject;
   path: keyof IRPathsObject;
   responses?: IRResponsesObject;
+  security?: ReadonlyArray<SecuritySchemeObject>;
   // TODO: parser - add more properties
-  // security?: ReadonlyArray<SecurityRequirementObject>;
   // servers?: ReadonlyArray<ServerObject>;
   summary?: string;
   tags?: ReadonlyArray<string>;
@@ -4110,18 +4127,29 @@ interface Config$a extends Plugin.Name<'@hey-api/sdk'> {
    * Note that by enabling this option, your SDKs will **NOT**
    * support {@link https://developer.mozilla.org/docs/Glossary/Tree_shaking tree-shaking}.
    * For this reason, it is disabled by default.
+   *
    * @default false
    */
   asClass?: boolean;
   /**
+   * **This feature works only with the experimental parser**
+   *
+   * Should the generated functions contain auth mechanisms? You may want to
+   * disable this option if you're handling auth yourself or defining it
+   * globally on the client and want to reduce the size of generated code.
+   *
+   * @default true
+   */
+  auth?: boolean;
+  /**
+   * **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$`.
    *
-   * This option does not work with the experimental parser.
-   *
    * @deprecated
    */
   filter?: string;
@@ -4138,17 +4166,21 @@ interface Config$a extends Plugin.Name<'@hey-api/sdk'> {
   // TODO: parser - rename operationId option to something like inferId?: boolean
   /**
    * Use operation ID to generate operation names?
+   *
    * @default true
    */
   operationId?: boolean;
   /**
    * Name of the generated file.
+   *
    * @default 'sdk'
    */
   output?: string;
   /**
    * Define shape of returned value from service calls
+   *
    * @default 'body'
+   *
    * @deprecated
    */
   response?: 'body' | 'response';
@@ -4157,9 +4189,38 @@ interface Config$a extends Plugin.Name<'@hey-api/sdk'> {
    * obtained from your OpenAPI specification tags.
    *
    * This option has no effect if `sdk.asClass` is `false`.
+   *
    * @default '{{name}}Service'
    */
   serviceNameBuilder?: string;
+  /**
+   * Transform response data before returning. This is useful if you want to
+   * convert for example ISO strings into Date objects. However, transformation
+   * adds runtime overhead, so it's not recommended to use unless necessary.
+   *
+   * You can customize the selected transformer output through its plugin. You
+   * can also set `transformer` to `true` to automatically choose the
+   * transformer from your defined plugins.
+   *
+   * @default false
+   */
+  transformer?: '@hey-api/transformers' | boolean;
+  /**
+   * **This feature works only with the experimental parser**
+   *
+   * Validate response data against schema before returning. This is useful
+   * if you want to ensure the response conforms to a desired shape. However,
+   * validation adds runtime overhead, so it's not recommended to use unless
+   * absolutely necessary.
+   *
+   * Ensure you have declared the selected library as a dependency to avoid
+   * errors. You can customize the selected validator output through its
+   * plugin. You can also set `validator` to `true` to automatically choose
+   * the validator from your defined plugins.
+   *
+   * @default false
+   */
+  validator?: 'zod' | boolean;
 }
 
 interface Config$9 extends Plugin.Name<'@hey-api/transformers'> {
@@ -4213,15 +4274,16 @@ interface Config$8 extends Plugin.Name<'@hey-api/typescript'> {
    */
   identifierCase?: Exclude<StringCase, 'SCREAMING_SNAKE_CASE'>;
   /**
-   * Include only types matching regular expression.
+   * **This feature works only with the legacy parser**
    *
-   * This option does not work with the experimental parser.
+   * Include only types matching regular expression.
    *
    * @deprecated
    */
   include?: string;
   /**
    * Name of the generated file.
+   *
    * @default 'types'
    */
   output?: string;

package/dist/index.d.ts

@@ -24,6 +24,10 @@ type ArrayOfObjectsToObjectMap<T extends ReadonlyArray<Record<string, any>>, D e
     [K in T[number][D]]?: Extract<T[number], Record<D, K>>;
 };
 
+type OmitUnderscoreKeys<T> = {
+  [K in keyof T as K extends `_${string}` ? never : K]: T[K];
+};
+
 type PluginNames =
   | '@hey-api/schemas'
   | '@hey-api/sdk'
@@ -37,23 +41,39 @@ type PluginNames =
   | 'fastify'
   | 'zod';
 
+type PluginTag = 'transformer' | 'validator';
+
+interface PluginContext {
+  ensureDependency: (name: PluginNames | true) => void;
+  pluginByTag: (tag: PluginTag) => PluginNames | undefined;
+}
+
 interface BaseConfig {
   // eslint-disable-next-line @typescript-eslint/ban-types
   name: PluginNames | (string & {});
   output?: string;
 }
 
-interface Dependencies {
+interface Meta<Config extends BaseConfig> {
   /**
-   * Required dependencies will be always processed, regardless of whether
-   * a user defines them in their `plugins` config.
+   * Dependency plugins will be always processed, regardless of whether user
+   * explicitly defines them in their `plugins` config.
    */
   _dependencies?: ReadonlyArray<PluginNames>;
   /**
-   * Optional dependencies are not processed unless a user explicitly defines
-   * them in their `plugins` config.
+   * Allows overriding config before it's sent to the parser. An example is
+   * defining `validator` as `true` and the plugin figures out which plugin
+   * should be used for validation.
    */
-  _optionalDependencies?: ReadonlyArray<PluginNames>;
+  _infer?: (
+    config: Config & Omit<Meta<Config>, '_infer'>,
+    context: PluginContext,
+  ) => void;
+  /**
+   * Optional tags can be used to help with deciding plugin order and inferring
+   * plugin configuration options.
+   */
+  _tags?: ReadonlyArray<PluginTag>;
 }
 
 /**
@@ -61,7 +81,7 @@ interface Dependencies {
  */
 declare namespace Plugin {
   export type Config<Config extends BaseConfig> = Config &
-    Dependencies & {
+    Meta<Config> & {
       _handler: Plugin.Handler<Config>;
       _handlerLegacy: Plugin.LegacyHandler<Config>;
     };
@@ -78,10 +98,7 @@ declare namespace Plugin {
     plugin: Plugin.Instance<Config>;
   }) => void;
 
-  export type Instance<Config extends BaseConfig> = Omit<
-    Config,
-    '_dependencies' | '_handler' | '_handlerLegacy' | '_optionalDependencies'
-  > &
+  export type Instance<Config extends BaseConfig> = OmitUnderscoreKeys<Config> &
     Pick<Required<Config>, 'output'>;
 
   /**
@@ -3950,8 +3967,8 @@ interface IROperationObject {
   parameters?: IRParametersObject;
   path: keyof IRPathsObject;
   responses?: IRResponsesObject;
+  security?: ReadonlyArray<SecuritySchemeObject>;
   // TODO: parser - add more properties
-  // security?: ReadonlyArray<SecurityRequirementObject>;
   // servers?: ReadonlyArray<ServerObject>;
   summary?: string;
   tags?: ReadonlyArray<string>;
@@ -4110,18 +4127,29 @@ interface Config$a extends Plugin.Name<'@hey-api/sdk'> {
    * Note that by enabling this option, your SDKs will **NOT**
    * support {@link https://developer.mozilla.org/docs/Glossary/Tree_shaking tree-shaking}.
    * For this reason, it is disabled by default.
+   *
    * @default false
    */
   asClass?: boolean;
   /**
+   * **This feature works only with the experimental parser**
+   *
+   * Should the generated functions contain auth mechanisms? You may want to
+   * disable this option if you're handling auth yourself or defining it
+   * globally on the client and want to reduce the size of generated code.
+   *
+   * @default true
+   */
+  auth?: boolean;
+  /**
+   * **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$`.
    *
-   * This option does not work with the experimental parser.
-   *
    * @deprecated
    */
   filter?: string;
@@ -4138,17 +4166,21 @@ interface Config$a extends Plugin.Name<'@hey-api/sdk'> {
   // TODO: parser - rename operationId option to something like inferId?: boolean
   /**
    * Use operation ID to generate operation names?
+   *
    * @default true
    */
   operationId?: boolean;
   /**
    * Name of the generated file.
+   *
    * @default 'sdk'
    */
   output?: string;
   /**
    * Define shape of returned value from service calls
+   *
    * @default 'body'
+   *
    * @deprecated
    */
   response?: 'body' | 'response';
@@ -4157,9 +4189,38 @@ interface Config$a extends Plugin.Name<'@hey-api/sdk'> {
    * obtained from your OpenAPI specification tags.
    *
    * This option has no effect if `sdk.asClass` is `false`.
+   *
    * @default '{{name}}Service'
    */
   serviceNameBuilder?: string;
+  /**
+   * Transform response data before returning. This is useful if you want to
+   * convert for example ISO strings into Date objects. However, transformation
+   * adds runtime overhead, so it's not recommended to use unless necessary.
+   *
+   * You can customize the selected transformer output through its plugin. You
+   * can also set `transformer` to `true` to automatically choose the
+   * transformer from your defined plugins.
+   *
+   * @default false
+   */
+  transformer?: '@hey-api/transformers' | boolean;
+  /**
+   * **This feature works only with the experimental parser**
+   *
+   * Validate response data against schema before returning. This is useful
+   * if you want to ensure the response conforms to a desired shape. However,
+   * validation adds runtime overhead, so it's not recommended to use unless
+   * absolutely necessary.
+   *
+   * Ensure you have declared the selected library as a dependency to avoid
+   * errors. You can customize the selected validator output through its
+   * plugin. You can also set `validator` to `true` to automatically choose
+   * the validator from your defined plugins.
+   *
+   * @default false
+   */
+  validator?: 'zod' | boolean;
 }
 
 interface Config$9 extends Plugin.Name<'@hey-api/transformers'> {
@@ -4213,15 +4274,16 @@ interface Config$8 extends Plugin.Name<'@hey-api/typescript'> {
    */
   identifierCase?: Exclude<StringCase, 'SCREAMING_SNAKE_CASE'>;
   /**
-   * Include only types matching regular expression.
+   * **This feature works only with the legacy parser**
    *
-   * This option does not work with the experimental parser.
+   * Include only types matching regular expression.
    *
    * @deprecated
    */
   include?: string;
   /**
    * Name of the generated file.
+   *
    * @default 'types'
    */
   output?: string;