Merge pull request #101 from nicolas-chaulet/refactor/types-dir

refactor(types): move types from client folder to types
hey-api · Mar 20, 2024 · df99278 · df99278
2 parents 1c1a86a + e669195
commit df99278
Show file tree

Hide file tree

Showing 89 changed files with 247 additions and 353 deletions.
diff --git a/src/client/interfaces/Client.ts b/src/client/interfaces/Client.ts
diff --git a/src/client/interfaces/Enum.ts b/src/client/interfaces/Enum.ts
diff --git a/src/client/interfaces/Model.ts b/src/client/interfaces/Model.ts
diff --git a/src/client/interfaces/ModelComposition.ts b/src/client/interfaces/ModelComposition.ts
diff --git a/src/client/interfaces/Operation.ts b/src/client/interfaces/Operation.ts
diff --git a/src/client/interfaces/OperationError.ts b/src/client/interfaces/OperationError.ts
diff --git a/src/client/interfaces/OperationParameter.ts b/src/client/interfaces/OperationParameter.ts
diff --git a/src/client/interfaces/OperationParameters.ts b/src/client/interfaces/OperationParameters.ts
diff --git a/src/client/interfaces/OperationResponse.ts b/src/client/interfaces/OperationResponse.ts
diff --git a/src/client/interfaces/Schema.ts b/src/client/interfaces/Schema.ts
diff --git a/src/client/interfaces/Service.ts b/src/client/interfaces/Service.ts
diff --git a/src/client/interfaces/Type.ts b/src/client/interfaces/Type.ts
diff --git a/src/client/interfaces/WithEnumExtension.ts b/src/client/interfaces/WithEnumExtension.ts
diff --git a/src/index.ts b/src/index.ts
@@ -4,9 +4,9 @@ import { pathToFileURL } from 'node:url';
 
 import { sync } from 'cross-spawn';
 
-import type { Client } from './client/interfaces/Client';
 import { parse as parseV2 } from './openApi/v2';
 import { parse as parseV3 } from './openApi/v3';
+import type { Client } from './types/client';
 import type { Config, UserConfig } from './types/config';
 import { getOpenApiSpec } from './utils/getOpenApiSpec';
 import { registerHandlebarTemplates } from './utils/handlebars';

diff --git a/src/openApi/v2/index.ts b/src/openApi/v2/index.ts
@@ -1,4 +1,4 @@
-import type { Client } from '../../client/interfaces/Client';
+import type { Client } from '../../types/client';
 import type { Config } from '../../types/config';
 import type { OpenApi } from './interfaces/OpenApi';
 import { getModels } from './parser/getModels';

diff --git a/src/openApi/v2/interfaces/OpenApiItems.ts b/src/openApi/v2/interfaces/OpenApiItems.ts
@@ -1,4 +1,4 @@
-import type { WithEnumExtension } from '../../../client/interfaces/WithEnumExtension';
+import type { WithEnumExtension } from '../../../types/client';
 
 /**
  * https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#itemsObject

diff --git a/src/openApi/v2/interfaces/OpenApiParameter.ts b/src/openApi/v2/interfaces/OpenApiParameter.ts
@@ -1,4 +1,4 @@
-import type { WithEnumExtension } from '../../../client/interfaces/WithEnumExtension';
+import type { WithEnumExtension } from '../../../types/client';
 import type { WithNullableExtension } from './Extensions/WithNullableExtension';
 import type { OpenApiItems } from './OpenApiItems';
 import type { OpenApiReference } from './OpenApiReference';

diff --git a/src/openApi/v2/interfaces/OpenApiSchema.ts b/src/openApi/v2/interfaces/OpenApiSchema.ts
@@ -1,4 +1,4 @@
-import type { WithEnumExtension } from '../../../client/interfaces/WithEnumExtension';
+import type { WithEnumExtension } from '../../../types/client';
 import type { Dictionary } from '../../../utils/types';
 import type { WithNullableExtension } from './Extensions/WithNullableExtension';
 import type { OpenApiExternalDocs } from './OpenApiExternalDocs';

diff --git a/src/openApi/v2/parser/getModel.ts b/src/openApi/v2/parser/getModel.ts
@@ -1,4 +1,4 @@
-import type { Model } from '../../../client/interfaces/Model';
+import type { Model } from '../../../types/client';
 import { getEnums } from '../../../utils/getEnums';
 import { getPattern } from '../../../utils/getPattern';
 import { getType } from '../../../utils/type';

diff --git a/src/openApi/v2/parser/getModelComposition.ts b/src/openApi/v2/parser/getModelComposition.ts
@@ -1,5 +1,4 @@
-import type { Model } from '../../../client/interfaces/Model';
-import type { ModelComposition } from '../../../client/interfaces/ModelComposition';
+import type { Model, ModelComposition } from '../../../types/client';
 import type { OpenApi } from '../interfaces/OpenApi';
 import type { OpenApiSchema } from '../interfaces/OpenApiSchema';
 import type { getModel } from './getModel';

diff --git a/src/openApi/v2/parser/getModelProperties.ts b/src/openApi/v2/parser/getModelProperties.ts
@@ -1,4 +1,4 @@
-import type { Model } from '../../../client/interfaces/Model';
+import type { Model } from '../../../types/client';
 import { escapeName } from '../../../utils/escapeName';
 import { getPattern } from '../../../utils/getPattern';
 import { getType } from '../../../utils/type';

diff --git a/src/openApi/v2/parser/getModelTemplate.spec.ts b/src/openApi/v2/parser/getModelTemplate.spec.ts
diff --git a/src/openApi/v2/parser/getModelTemplate.ts b/src/openApi/v2/parser/getModelTemplate.ts
diff --git a/src/openApi/v2/parser/getModels.ts b/src/openApi/v2/parser/getModels.ts
@@ -1,4 +1,4 @@
-import type { Model } from '../../../client/interfaces/Model';
+import type { Model } from '../../../types/client';
 import { reservedWords } from '../../../utils/reservedWords';
 import { getType } from '../../../utils/type';
 import type { OpenApi } from '../interfaces/OpenApi';

diff --git a/src/openApi/v2/parser/getOperation.ts b/src/openApi/v2/parser/getOperation.ts
@@ -1,5 +1,4 @@
-import type { Operation } from '../../../client/interfaces/Operation';
-import type { OperationParameters } from '../../../client/interfaces/OperationParameters';
+import type { Operation, OperationParameter, OperationParameters } from '../../../types/client';
 import type { Config } from '../../../types/config';
 import { getOperationName } from '../../../utils/operation';
 import type { OpenApi } from '../interfaces/OpenApi';
@@ -10,7 +9,14 @@ import { getOperationResponseHeader } from './getOperationResponseHeader';
 import { getOperationResponses } from './getOperationResponses';
 import { getOperationResults } from './getOperationResults';
 import { getServiceName } from './getServiceName';
-import { sortByRequired } from './sortByRequired';
+
+const sortByRequired = (a: OperationParameter, b: OperationParameter): number => {
+    const aNeedsValue = a.isRequired && a.default === undefined;
+    const bNeedsValue = b.isRequired && b.default === undefined;
+    if (aNeedsValue && !bNeedsValue) return -1;
+    if (bNeedsValue && !aNeedsValue) return 1;
+    return 0;
+};
 
 export const getOperation = (
     openApi: OpenApi,

diff --git a/src/openApi/v2/parser/getOperationErrors.ts b/src/openApi/v2/parser/getOperationErrors.ts
@@ -1,5 +1,4 @@
-import type { OperationError } from '../../../client/interfaces/OperationError';
-import type { OperationResponse } from '../../../client/interfaces/OperationResponse';
+import type { OperationError, OperationResponse } from '../../../types/client';
 
 /**
  *

diff --git a/src/openApi/v2/parser/getOperationParameter.ts b/src/openApi/v2/parser/getOperationParameter.ts
@@ -1,4 +1,4 @@
-import type { OperationParameter } from '../../../client/interfaces/OperationParameter';
+import type { OperationParameter } from '../../../types/client';
 import { getEnums } from '../../../utils/getEnums';
 import { getPattern } from '../../../utils/getPattern';
 import { getType } from '../../../utils/type';

diff --git a/src/openApi/v2/parser/getOperationParameterDefault.ts b/src/openApi/v2/parser/getOperationParameterDefault.ts
@@ -1,4 +1,4 @@
-import type { OperationParameter } from '../../../client/interfaces/OperationParameter';
+import type { OperationParameter } from '../../../types/client';
 import type { OpenApiParameter } from '../interfaces/OpenApiParameter';
 
 export const getOperationParameterDefault = (

diff --git a/src/openApi/v2/parser/getOperationParameters.ts b/src/openApi/v2/parser/getOperationParameters.ts
@@ -1,4 +1,4 @@
-import type { OperationParameters } from '../../../client/interfaces/OperationParameters';
+import type { OperationParameters } from '../../../types/client';
 import type { OpenApi } from '../interfaces/OpenApi';
 import type { OpenApiParameter } from '../interfaces/OpenApiParameter';
 import { getOperationParameter } from './getOperationParameter';

diff --git a/src/openApi/v2/parser/getOperationResponse.ts b/src/openApi/v2/parser/getOperationResponse.ts
@@ -1,4 +1,4 @@
-import type { OperationResponse } from '../../../client/interfaces/OperationResponse';
+import type { OperationResponse } from '../../../types/client';
 import { getPattern } from '../../../utils/getPattern';
 import { getType } from '../../../utils/type';
 import type { OpenApi } from '../interfaces/OpenApi';

diff --git a/src/openApi/v2/parser/getOperationResponseHeader.ts b/src/openApi/v2/parser/getOperationResponseHeader.ts
@@ -1,4 +1,4 @@
-import type { OperationResponse } from '../../../client/interfaces/OperationResponse';
+import type { OperationResponse } from '../../../types/client';
 
 export const getOperationResponseHeader = (operationResponses: OperationResponse[]): string | null => {
     const header = operationResponses.find(operationResponses => operationResponses.in === 'header');

diff --git a/src/openApi/v2/parser/getOperationResponses.ts b/src/openApi/v2/parser/getOperationResponses.ts
@@ -1,4 +1,4 @@
-import type { OperationResponse } from '../../../client/interfaces/OperationResponse';
+import type { OperationResponse } from '../../../types/client';
 import type { OpenApi } from '../interfaces/OpenApi';
 import type { OpenApiResponse } from '../interfaces/OpenApiResponse';
 import type { OpenApiResponses } from '../interfaces/OpenApiResponses';

diff --git a/src/openApi/v2/parser/getOperationResults.ts b/src/openApi/v2/parser/getOperationResults.ts
@@ -1,5 +1,4 @@
-import type { Model } from '../../../client/interfaces/Model';
-import type { OperationResponse } from '../../../client/interfaces/OperationResponse';
+import type { Model, OperationResponse } from '../../../types/client';
 
 const areEqual = (a: Model, b: Model): boolean => {
     const equal = a.type === b.type && a.base === b.base && a.template === b.template;

diff --git a/src/openApi/v2/parser/getRequiredPropertiesFromComposition.ts b/src/openApi/v2/parser/getRequiredPropertiesFromComposition.ts
@@ -1,4 +1,4 @@
-import type { Model } from '../../../client/interfaces/Model';
+import type { Model } from '../../../types/client';
 import type { OpenApi } from '../interfaces/OpenApi';
 import type { OpenApiSchema } from '../interfaces/OpenApiSchema';
 import type { getModel } from './getModel';

diff --git a/src/openApi/v2/parser/getServices.ts b/src/openApi/v2/parser/getServices.ts
@@ -1,4 +1,4 @@
-import type { Service } from '../../../client/interfaces/Service';
+import type { Service } from '../../../types/client';
 import type { Config } from '../../../types/config';
 import { unique } from '../../../utils/unique';
 import type { OpenApi } from '../interfaces/OpenApi';

diff --git a/src/openApi/v2/parser/sortByRequired.ts b/src/openApi/v2/parser/sortByRequired.ts
diff --git a/src/openApi/v3/index.ts b/src/openApi/v3/index.ts
@@ -1,4 +1,4 @@
-import type { Client } from '../../client/interfaces/Client';
+import type { Client } from '../../types/client';
 import type { Config } from '../../types/config';
 import type { OpenApi } from './interfaces/OpenApi';
 import { getModels } from './parser/getModels';

diff --git a/src/openApi/v3/interfaces/OpenApiSchema.ts b/src/openApi/v3/interfaces/OpenApiSchema.ts
@@ -1,4 +1,4 @@
-import type { WithEnumExtension } from '../../../client/interfaces/WithEnumExtension';
+import type { WithEnumExtension } from '../../../types/client';
 import type { Dictionary } from '../../../utils/types';
 import type { OpenApiDiscriminator } from './OpenApiDiscriminator';
 import type { OpenApiExternalDocs } from './OpenApiExternalDocs';

diff --git a/src/openApi/v3/interfaces/OpenApiServerVariable.ts b/src/openApi/v3/interfaces/OpenApiServerVariable.ts
@@ -1,4 +1,4 @@
-import type { WithEnumExtension } from '../../../client/interfaces/WithEnumExtension';
+import type { WithEnumExtension } from '../../../types/client';
 
 /**
  * https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#serverVariableObject

diff --git a/src/openApi/v3/parser/getModel.ts b/src/openApi/v3/parser/getModel.ts
@@ -1,4 +1,4 @@
-import type { Model } from '../../../client/interfaces/Model';
+import type { Model } from '../../../types/client';
 import { getEnums } from '../../../utils/getEnums';
 import { getPattern } from '../../../utils/getPattern';
 import { getType } from '../../../utils/type';

diff --git a/src/openApi/v3/parser/getModelComposition.ts b/src/openApi/v3/parser/getModelComposition.ts
@@ -1,5 +1,4 @@
-import type { Model } from '../../../client/interfaces/Model';
-import type { ModelComposition } from '../../../client/interfaces/ModelComposition';
+import type { Model, ModelComposition } from '../../../types/client';
 import type { OpenApi } from '../interfaces/OpenApi';
 import type { OpenApiSchema } from '../interfaces/OpenApiSchema';
 import type { getModel } from './getModel';

diff --git a/src/openApi/v3/parser/getModelDefault.ts b/src/openApi/v3/parser/getModelDefault.ts
@@ -1,4 +1,4 @@
-import type { Model } from '../../../client/interfaces/Model';
+import type { Model } from '../../../types/client';
 import type { OpenApiSchema } from '../interfaces/OpenApiSchema';
 
 export const getModelDefault = (definition: OpenApiSchema, model?: Model): string | undefined => {