@hey-api/openapi-ts 0.59.2 → 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'>;
 
   /**
@@ -4176,6 +4193,34 @@ interface Config$a extends Plugin.Name<'@hey-api/sdk'> {
    * @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'> {

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'>;
 
   /**
@@ -4176,6 +4193,34 @@ interface Config$a extends Plugin.Name<'@hey-api/sdk'> {
    * @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'> {