@hey-api/openapi-ts 0.59.0 → 0.59.2

package/dist/index.d.cts

@@ -3950,8 +3950,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 +4110,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 +4149,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,6 +4172,7 @@ 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;
@@ -4213,15 +4229,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;
@@ -4711,8 +4728,11 @@ interface EnsureUniqueIdentifierData {
     case: StringCase | undefined;
     count?: number;
     create?: boolean;
+    /**
+     * Transforms name obtained from `$ref` before it's passed to `stringCase()`.
+     */
+    nameTransformer?: (name: string) => string;
     namespace: Namespace;
-    validNameTransformer?: (value: string) => string;
 }
 
 interface ContextFile {

package/dist/index.d.ts

@@ -3950,8 +3950,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 +4110,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 +4149,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,6 +4172,7 @@ 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;
@@ -4213,15 +4229,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;
@@ -4711,8 +4728,11 @@ interface EnsureUniqueIdentifierData {
     case: StringCase | undefined;
     count?: number;
     create?: boolean;
+    /**
+     * Transforms name obtained from `$ref` before it's passed to `stringCase()`.
+     */
+    nameTransformer?: (name: string) => string;
     namespace: Namespace;
-    validNameTransformer?: (value: string) => string;
 }
 
 interface ContextFile {