Merge pull request #392 from hey-api/fix/prefer-unknown-over-any

fix: prefer unknown type over any
hey-api · Apr 16, 2024 · a2f68f6 · a2f68f6
2 parents a9a8783 + 90c383a
commit a2f68f6
Show file tree

Hide file tree

Showing 23 changed files with 60 additions and 46 deletions.
diff --git a/.changeset/few-rice-marry.md b/.changeset/few-rice-marry.md
@@ -0,0 +1,5 @@
+---
+"@hey-api/openapi-ts": patch
+---
+
+fix: prefer unknown type over any
diff --git a/docs/openapi-ts/migrating.md b/docs/openapi-ts/migrating.md
@@ -52,6 +52,15 @@ This config option is deprecated and will be removed.
 
 ## v0.39.0
 
+### Prefer `unknown` over `any`
+
+Types that cannot be determined will now be generated as `unknown` instead of `any`.
+
+```js
+200: any // [!code --]
+200: unknown // [!code ++]
+```
+
 ### Single `enums.gen.ts` file
 
 Enums are now exported from a separate file. If you use imports from `models.ts`, you can change them to `enums.gen.ts`.

diff --git a/packages/openapi-ts/src/openApi/v2/parser/getModel.ts b/packages/openapi-ts/src/openApi/v2/parser/getModel.ts
@@ -15,7 +15,7 @@ export const getModel = (
 ): Model => {
     const model: Model = {
         $refs: [],
-        base: 'any',
+        base: 'unknown',
         description: definition.description || null,
         enum: [],
         enums: [],
@@ -42,7 +42,7 @@ export const getModel = (
         pattern: getPattern(definition.pattern),
         properties: [],
         template: null,
-        type: 'any',
+        type: 'unknown',
         uniqueItems: definition.uniqueItems,
     };
 
@@ -120,8 +120,8 @@ export const getModel = (
 
     if (definition.type === 'object') {
         model.export = 'interface';
-        model.type = 'any';
-        model.base = 'any';
+        model.type = 'unknown';
+        model.base = 'unknown';
 
         if (definition.properties) {
             const modelProperties = getModelProperties(openApi, definition, getModel);

diff --git a/packages/openapi-ts/src/openApi/v2/parser/getModelComposition.ts b/packages/openapi-ts/src/openApi/v2/parser/getModelComposition.ts
@@ -30,7 +30,7 @@ export const getModelComposition = (
         .filter(model => {
             const hasProperties = model.properties.length;
             const hasEnums = model.enums.length;
-            const isObject = model.type === 'any';
+            const isObject = model.type === 'unknown';
             const isEmpty = isObject && !hasProperties && !hasEnums;
             return !isEmpty;
         })
@@ -69,7 +69,7 @@ export const getModelComposition = (
     if (properties.length) {
         composition.properties.push({
             $refs: [],
-            base: 'any',
+            base: 'unknown',
             description: '',
             enum: [],
             enums: [],
@@ -83,7 +83,7 @@ export const getModelComposition = (
             name: 'properties',
             properties,
             template: null,
-            type: 'any',
+            type: 'unknown',
         });
     }
 

diff --git a/packages/openapi-ts/src/openApi/v2/parser/getOperationParameter.ts b/packages/openapi-ts/src/openApi/v2/parser/getOperationParameter.ts
@@ -13,7 +13,7 @@ import { getModel } from './getModel';
 export const getOperationParameter = (openApi: OpenApi, parameter: OpenApiParameter): OperationParameter => {
     const operationParameter: OperationParameter = {
         $refs: [],
-        base: 'any',
+        base: 'unknown',
         description: parameter.description || null,
         enum: [],
         enums: [],
@@ -41,7 +41,7 @@ export const getOperationParameter = (openApi: OpenApi, parameter: OpenApiParame
         prop: parameter.name,
         properties: [],
         template: null,
-        type: 'any',
+        type: 'unknown',
         uniqueItems: parameter.uniqueItems,
     };
 

diff --git a/packages/openapi-ts/src/openApi/v2/parser/getOperationResponse.ts b/packages/openapi-ts/src/openApi/v2/parser/getOperationResponse.ts
@@ -14,7 +14,7 @@ export const getOperationResponse = (
 ): OperationResponse => {
     const operationResponse: OperationResponse = {
         $refs: [],
-        base: responseCode !== 204 ? 'any' : 'void',
+        base: responseCode !== 204 ? 'unknown' : 'void',
         code: responseCode,
         description: response.description || null,
         enum: [],
@@ -30,7 +30,7 @@ export const getOperationResponse = (
         name: '',
         properties: [],
         template: null,
-        type: responseCode !== 204 ? 'any' : 'void',
+        type: responseCode !== 204 ? 'unknown' : 'void',
     };
 
     // If this response has a schema, then we need to check two things:

diff --git a/packages/openapi-ts/src/openApi/v3/parser/getModel.ts b/packages/openapi-ts/src/openApi/v3/parser/getModel.ts
@@ -130,9 +130,9 @@ export const getModel = (
 
     if (definition.type === 'object' || definition.properties) {
         if (definition.properties) {
-            model.base = 'any';
+            model.base = 'unknown';
             model.export = 'interface';
-            model.type = 'any';
+            model.type = 'unknown';
             model.default = getDefault(definition, model);
 
             const modelProperties = getModelProperties(openApi, definition, getModel, model);

diff --git a/packages/openapi-ts/src/openApi/v3/parser/getModelComposition.ts b/packages/openapi-ts/src/openApi/v3/parser/getModelComposition.ts
@@ -103,7 +103,7 @@ export const getModelComposition = ({
         } else {
             composition.properties.push({
                 $refs: [],
-                base: 'any',
+                base: 'unknown',
                 description: '',
                 enum: [],
                 enums: [],
@@ -117,7 +117,7 @@ export const getModelComposition = ({
                 name: 'properties',
                 properties,
                 template: null,
-                type: 'any',
+                type: 'unknown',
             });
         }
     }

diff --git a/packages/openapi-ts/src/openApi/v3/parser/getOperationParameter.ts b/packages/openapi-ts/src/openApi/v3/parser/getOperationParameter.ts
@@ -12,7 +12,7 @@ import { getModel } from './getModel';
 export const getOperationParameter = (openApi: OpenApi, parameter: OpenApiParameter): OperationParameter => {
     const operationParameter: OperationParameter = {
         $refs: [],
-        base: 'any',
+        base: 'unknown',
         deprecated: parameter.deprecated === true,
         description: parameter.description || null,
         enum: [],
@@ -30,7 +30,7 @@ export const getOperationParameter = (openApi: OpenApi, parameter: OpenApiParame
         prop: parameter.name,
         properties: [],
         template: null,
-        type: 'any',
+        type: 'unknown',
     };
 
     if (parameter.$ref) {

diff --git a/packages/openapi-ts/src/openApi/v3/parser/getOperationRequestBody.ts b/packages/openapi-ts/src/openApi/v3/parser/getOperationRequestBody.ts
@@ -9,7 +9,7 @@ import { getModel } from './getModel';
 export const getOperationRequestBody = (openApi: OpenApi, body: OpenApiRequestBody): OperationParameter => {
     const requestBody: OperationParameter = {
         $refs: [],
-        base: 'any',
+        base: 'unknown',
         default: undefined,
         description: body.description || null,
         enum: [],
@@ -27,7 +27,7 @@ export const getOperationRequestBody = (openApi: OpenApi, body: OpenApiRequestBo
         prop: body['x-body-name'] ?? 'requestBody',
         properties: [],
         template: null,
-        type: 'any',
+        type: 'unknown',
     };
 
     if (body.content) {

diff --git a/packages/openapi-ts/src/openApi/v3/parser/getOperationResponse.ts b/packages/openapi-ts/src/openApi/v3/parser/getOperationResponse.ts
@@ -15,7 +15,7 @@ export const getOperationResponse = (
 ): OperationResponse => {
     const operationResponse: OperationResponse = {
         $refs: [],
-        base: responseCode !== 204 ? 'any' : 'void',
+        base: responseCode !== 204 ? 'unknown' : 'void',
         code: responseCode,
         description: response.description || null,
         enum: [],
@@ -31,7 +31,7 @@ export const getOperationResponse = (
         name: '',
         properties: [],
         template: null,
-        type: responseCode !== 204 ? 'any' : 'void',
+        type: responseCode !== 204 ? 'unknown' : 'void',
     };
 
     if (response.content) {

diff --git a/packages/openapi-ts/test/__snapshots__/test/generated/v2/models.gen.ts.snap b/packages/openapi-ts/test/__snapshots__/test/generated/v2/models.gen.ts.snap
@@ -584,7 +584,7 @@ export type $OpenApiTs = {
                 /**
                  * Response is a simple number
                  */
-                200: any;
+                200: unknown;
                 /**
                  * Success
                  */
@@ -778,7 +778,7 @@ export type $OpenApiTs = {
                 /**
                  * Custom message: Successful response
                  */
-                200: any;
+                200: unknown;
             };
         };
     };

diff --git a/packages/openapi-ts/test/__snapshots__/test/generated/v2/services.gen.ts.snap b/packages/openapi-ts/test/__snapshots__/test/generated/v2/services.gen.ts.snap
@@ -316,7 +316,7 @@ export class NoContentService {
     }
 
     /**
-     * @returns any Response is a simple number
+     * @returns unknown Response is a simple number
      * @returns void Success
      * @throws ApiError
      */
@@ -333,7 +333,7 @@ export class NoContentService {
 
 export class ResponseService {
     /**
-     * @returns any Response is a simple number
+     * @returns unknown Response is a simple number
      * @returns void Success
      * @throws ApiError
      */
@@ -377,7 +377,7 @@ export class ResponseService {
     }
 
     /**
-     * @returns any Message for 200 response
+     * @returns unknown Message for 200 response
      * @returns ModelWithString Message for default response
      * @returns ModelThatExtends Message for 201 response
      * @returns ModelThatExtendsExtends Message for 202 response
@@ -490,7 +490,7 @@ export class TypesService {
      * @returns number Response is a simple number
      * @returns string Response is a simple string
      * @returns boolean Response is a simple boolean
-     * @returns any Response is a simple object
+     * @returns unknown Response is a simple object
      * @throws ApiError
      */
     public static types(
@@ -576,7 +576,7 @@ export class HeaderService {
 
 export class ErrorService {
     /**
-     * @returns any Custom message: Successful response
+     * @returns unknown Custom message: Successful response
      * @throws ApiError
      */
     public static testErrorCode(

diff --git a/packages/openapi-ts/test/__snapshots__/test/generated/v3/models.gen.ts.snap b/packages/openapi-ts/test/__snapshots__/test/generated/v3/models.gen.ts.snap
@@ -1363,7 +1363,7 @@ export type $OpenApiTs = {
                 /**
                  * Custom message: Successful response
                  */
-                200: any;
+                200: unknown;
             };
         };
     };

diff --git a/packages/openapi-ts/test/__snapshots__/test/generated/v3/services.gen.ts.snap b/packages/openapi-ts/test/__snapshots__/test/generated/v3/services.gen.ts.snap
@@ -538,7 +538,7 @@ export class ResponseService {
     }
 
     /**
-     * @returns any Message for 200 response
+     * @returns unknown Message for 200 response
      * @returns ModelWithString Message for default response
      * @returns ModelThatExtends Message for 201 response
      * @returns ModelThatExtendsExtends Message for 202 response
@@ -789,7 +789,7 @@ export class MultipartService {
     }
 
     /**
-     * @returns any OK
+     * @returns unknown OK
      * @throws ApiError
      */
     public static multipartResponse(): CancelablePromise<
@@ -824,7 +824,7 @@ export class HeaderService {
 
 export class ErrorService {
     /**
-     * @returns any Custom message: Successful response
+     * @returns unknown Custom message: Successful response
      * @throws ApiError
      */
     public static testErrorCode(

diff --git a/packages/openapi-ts/test/__snapshots__/test/generated/v3_angular/models.gen.ts.snap b/packages/openapi-ts/test/__snapshots__/test/generated/v3_angular/models.gen.ts.snap
@@ -1363,7 +1363,7 @@ export type $OpenApiTs = {
                 /**
                  * Custom message: Successful response
                  */
-                200: any;
+                200: unknown;
             };
         };
     };

diff --git a/packages/openapi-ts/test/__snapshots__/test/generated/v3_angular/services.gen.ts.snap b/packages/openapi-ts/test/__snapshots__/test/generated/v3_angular/services.gen.ts.snap
@@ -585,7 +585,7 @@ export class ResponseService {
     }
 
     /**
-     * @returns any Message for 200 response
+     * @returns unknown Message for 200 response
      * @returns ModelWithString Message for default response
      * @returns ModelThatExtends Message for 201 response
      * @returns ModelThatExtendsExtends Message for 202 response
@@ -877,7 +877,7 @@ export class MultipartService {
     }
 
     /**
-     * @returns any OK
+     * @returns unknown OK
      * @throws ApiError
      */
     public multipartResponse(): Observable<$OpenApiTs['/api/v{api-version}/multipart']['get']['res'][200]> {
@@ -918,7 +918,7 @@ export class ErrorService {
     constructor(public readonly http: HttpClient) {}
 
     /**
-     * @returns any Custom message: Successful response
+     * @returns unknown Custom message: Successful response
      * @throws ApiError
      */
     public testErrorCode(

diff --git a/packages/openapi-ts/test/__snapshots__/test/generated/v3_client/models.gen.ts.snap b/packages/openapi-ts/test/__snapshots__/test/generated/v3_client/models.gen.ts.snap
@@ -1363,7 +1363,7 @@ export type $OpenApiTs = {
                 /**
                  * Custom message: Successful response
                  */
-                200: any;
+                200: unknown;
             };
         };
     };

diff --git a/packages/openapi-ts/test/__snapshots__/test/generated/v3_client/services.gen.ts.snap b/packages/openapi-ts/test/__snapshots__/test/generated/v3_client/services.gen.ts.snap
@@ -559,7 +559,7 @@ export class ResponseService {
     }
 
     /**
-     * @returns any Message for 200 response
+     * @returns unknown Message for 200 response
      * @returns ModelWithString Message for default response
      * @returns ModelThatExtends Message for 201 response
      * @returns ModelThatExtendsExtends Message for 202 response
@@ -828,7 +828,7 @@ export class MultipartService {
     }
 
     /**
-     * @returns any OK
+     * @returns unknown OK
      * @throws ApiError
      */
     public multipartResponse(): CancelablePromise<$OpenApiTs['/api/v{api-version}/multipart']['get']['res'][200]> {
@@ -863,7 +863,7 @@ export class ErrorService {
     constructor(public readonly httpRequest: BaseHttpRequest) {}
 
     /**
-     * @returns any Custom message: Successful response
+     * @returns unknown Custom message: Successful response
      * @throws ApiError
      */
     public testErrorCode(

diff --git a/packages/openapi-ts/test/__snapshots__/test/generated/v3_date/models.gen.ts.snap b/packages/openapi-ts/test/__snapshots__/test/generated/v3_date/models.gen.ts.snap
@@ -595,7 +595,7 @@ export type $OpenApiTs = {
                 /**
                  * Custom message: Successful response
                  */
-                200: any;
+                200: unknown;
             };
         };
     };

diff --git a/packages/openapi-ts/test/__snapshots__/test/generated/v3_enums_typescript/models.gen.ts.snap b/packages/openapi-ts/test/__snapshots__/test/generated/v3_enums_typescript/models.gen.ts.snap
@@ -1363,7 +1363,7 @@ export type $OpenApiTs = {
                 /**
                  * Custom message: Successful response
                  */
-                200: any;
+                200: unknown;
             };
         };
     };
-Original file line number
+Diff line change
@@ Expand Up / @@ -1363,7 +1363,7 @@ export type $OpenApiTs = { @@
                     /**
                      * Custom message: Successful response
                      */
-: any;
+: unknown;
                 };
             };
         };
@@ Expand Down @@