+5

.changeset/wicked-lizards-admire.md

reviewed

··· 1 1 + --- 2 2 + '@hey-api/openapi-ts': patch 3 3 + --- 4 4 + 5 5 + fix: add conditionnal generation for service related types

+4

packages/openapi-ts/src/generate/types.ts

reviewed

··· 287 287 288 288 const config = getConfig(); 289 289 290 290 + if (!config.services.export && !config.types.tree) { 291 291 + return; 292 292 + } 293 293 + 290 294 const isStandalone = isStandaloneClient(config); 291 295 292 296 for (const service of client.services) {

+1 -422

packages/openapi-ts/test/__snapshots__/test/generated/v3_types_no_tree/types.gen.ts.snap

reviewed

··· 882 882 /** 883 883 * Parameter with illegal characters 884 884 */ 885 885 - export type Parameterx_Foo_Bar = ModelWithString; 886 886 - 887 887 - export type ImportData = { 888 888 - requestBody: ModelWithReadOnlyAndWriteOnly | ModelWithArrayReadOnlyAndWriteOnly; 889 889 - }; 890 890 - 891 891 - export type ImportResponse = Model_From_Zendesk | ModelWithReadOnlyAndWriteOnly; 892 892 - 893 893 - export type ApiVversionOdataControllerCountResponse = Model_From_Zendesk; 894 894 - 895 895 - export type DeleteFooData3 = { 896 896 - /** 897 897 - * bar in method 898 898 - */ 899 899 - barParam: string; 900 900 - /** 901 901 - * foo in method 902 902 - */ 903 903 - fooParam: string; 904 904 - /** 905 905 - * Parameter with illegal characters 906 906 - */ 907 907 - xFooBar: ModelWithString; 908 908 - }; 909 909 - 910 910 - export type CallWithDescriptionsData = { 911 911 - /** 912 912 - * Testing backticks in string: `backticks` and ```multiple backticks``` should work 913 913 - */ 914 914 - parameterWithBackticks?: unknown; 915 915 - /** 916 916 - * Testing multiline comments in string: First line 917 917 - * Second line 918 918 - * 919 919 - * Fourth line 920 920 - */ 921 921 - parameterWithBreaks?: unknown; 922 922 - /** 923 923 - * Testing expression placeholders in string: ${expression} should work 924 924 - */ 925 925 - parameterWithExpressionPlaceholders?: unknown; 926 926 - /** 927 927 - * Testing quotes in string: 'single quote''' and "double quotes""" should work 928 928 - */ 929 929 - parameterWithQuotes?: unknown; 930 930 - /** 931 931 - * Testing reserved characters in string: * inline * and ** inline ** should work 932 932 - */ 933 933 - parameterWithReservedCharacters?: unknown; 934 934 - /** 935 935 - * Testing slashes in string: \backwards\\\ and /forwards/// should work 936 936 - */ 937 937 - parameterWithSlashes?: unknown; 938 938 - }; 939 939 - 940 940 - export type DeprecatedCallData = { 941 941 - /** 942 942 - * This parameter is deprecated 943 943 - * @deprecated 944 944 - */ 945 945 - parameter: DeprecatedModel | null; 946 946 - }; 947 947 - 948 948 - export type CallWithParametersData = { 949 949 - fooAllOfEnum: ModelWithNestedArrayEnumsDataFoo; 950 950 - fooRefEnum?: ModelWithNestedArrayEnumsDataFoo; 951 951 - /** 952 952 - * This is the parameter that goes into the cookie 953 953 - */ 954 954 - parameterCookie: string | null; 955 955 - /** 956 956 - * This is the parameter that goes into the header 957 957 - */ 958 958 - parameterHeader: string | null; 959 959 - /** 960 960 - * This is the parameter that goes into the path 961 961 - */ 962 962 - parameterPath: string | null; 963 963 - /** 964 964 - * This is the parameter that goes into the query params 965 965 - */ 966 966 - parameterQuery: string | null; 967 967 - /** 968 968 - * This is the parameter that goes into the body 969 969 - */ 970 970 - requestBody: { 971 971 - [key: string]: unknown; 972 972 - } | null; 973 973 - }; 974 974 - 975 975 - export type CallWithWeirdParameterNamesData = { 976 976 - /** 977 977 - * This is the parameter with a reserved keyword 978 978 - */ 979 979 - _default?: string; 980 980 - /** 981 981 - * This is the parameter that goes into the cookie 982 982 - */ 983 983 - parameterCookie: string | null; 984 984 - /** 985 985 - * This is the parameter that goes into the request header 986 986 - */ 987 987 - parameterHeader: string | null; 988 988 - /** 989 989 - * This is the parameter that goes into the path 990 990 - */ 991 991 - parameterPath1?: string; 992 992 - /** 993 993 - * This is the parameter that goes into the path 994 994 - */ 995 995 - parameterPath2?: string; 996 996 - /** 997 997 - * This is the parameter that goes into the path 998 998 - */ 999 999 - parameterPath3?: string; 1000 1000 - /** 1001 1001 - * This is the parameter that goes into the request query params 1002 1002 - */ 1003 1003 - parameterQuery: string | null; 1004 1004 - /** 1005 1005 - * This is the parameter that goes into the body 1006 1006 - */ 1007 1007 - requestBody: ModelWithString | null; 1008 1008 - }; 1009 1009 - 1010 1010 - export type GetCallWithOptionalParamData = { 1011 1011 - /** 1012 1012 - * This is an optional parameter 1013 1013 - */ 1014 1014 - parameter?: string; 1015 1015 - /** 1016 1016 - * This is a required parameter 1017 1017 - */ 1018 1018 - requestBody: ModelWithOneOfEnum; 1019 1019 - }; 1020 1020 - 1021 1021 - export type PostCallWithOptionalParamData = { 1022 1022 - /** 1023 1023 - * This is a required parameter 1024 1024 - */ 1025 1025 - parameter: Pageable; 1026 1026 - /** 1027 1027 - * This is an optional parameter 1028 1028 - */ 1029 1029 - requestBody?: ModelWithString; 1030 1030 - }; 1031 1031 - 1032 1032 - export type PostApiRequestBodyData = { 1033 1033 - /** 1034 1034 - * A reusable request body 1035 1035 - */ 1036 1036 - foo?: ModelWithString; 1037 1037 - /** 1038 1038 - * This is a reusable parameter 1039 1039 - */ 1040 1040 - parameter?: string; 1041 1041 - }; 1042 1042 - 1043 1043 - export type PostApiFormDataData = { 1044 1044 - /** 1045 1045 - * A reusable request body 1046 1046 - */ 1047 1047 - formData?: ModelWithString; 1048 1048 - /** 1049 1049 - * This is a reusable parameter 1050 1050 - */ 1051 1051 - parameter?: string; 1052 1052 - }; 1053 1053 - 1054 1054 - export type CallWithDefaultParametersData = { 1055 1055 - /** 1056 1056 - * This is a simple boolean with default value 1057 1057 - */ 1058 1058 - parameterBoolean?: boolean | null; 1059 1059 - /** 1060 1060 - * This is a simple enum with default value 1061 1061 - */ 1062 1062 - parameterEnum?: 'Success' | 'Warning' | 'Error'; 1063 1063 - /** 1064 1064 - * This is a simple model with default value 1065 1065 - */ 1066 1066 - parameterModel?: ModelWithString | null; 1067 1067 - /** 1068 1068 - * This is a simple number with default value 1069 1069 - */ 1070 1070 - parameterNumber?: number | null; 1071 1071 - /** 1072 1072 - * This is a simple string with default value 1073 1073 - */ 1074 1074 - parameterString?: string | null; 1075 1075 - }; 1076 1076 - 1077 1077 - export type CallWithDefaultOptionalParametersData = { 1078 1078 - /** 1079 1079 - * This is a simple boolean that is optional with default value 1080 1080 - */ 1081 1081 - parameterBoolean?: boolean; 1082 1082 - /** 1083 1083 - * This is a simple enum that is optional with default value 1084 1084 - */ 1085 1085 - parameterEnum?: 'Success' | 'Warning' | 'Error'; 1086 1086 - /** 1087 1087 - * This is a simple model that is optional with default value 1088 1088 - */ 1089 1089 - parameterModel?: ModelWithString; 1090 1090 - /** 1091 1091 - * This is a simple number that is optional with default value 1092 1092 - */ 1093 1093 - parameterNumber?: number; 1094 1094 - /** 1095 1095 - * This is a simple string that is optional with default value 1096 1096 - */ 1097 1097 - parameterString?: string; 1098 1098 - }; 1099 1099 - 1100 1100 - export type CallToTestOrderOfParamsData = { 1101 1101 - /** 1102 1102 - * This is a optional string with default 1103 1103 - */ 1104 1104 - parameterOptionalStringWithDefault?: string; 1105 1105 - /** 1106 1106 - * This is a optional string with empty default 1107 1107 - */ 1108 1108 - parameterOptionalStringWithEmptyDefault?: string; 1109 1109 - /** 1110 1110 - * This is a optional string with no default 1111 1111 - */ 1112 1112 - parameterOptionalStringWithNoDefault?: string; 1113 1113 - /** 1114 1114 - * This is a string that can be null with default 1115 1115 - */ 1116 1116 - parameterStringNullableWithDefault?: string | null; 1117 1117 - /** 1118 1118 - * This is a string that can be null with no default 1119 1119 - */ 1120 1120 - parameterStringNullableWithNoDefault?: string | null; 1121 1121 - /** 1122 1122 - * This is a string with default 1123 1123 - */ 1124 1124 - parameterStringWithDefault: string; 1125 1125 - /** 1126 1126 - * This is a string with empty default 1127 1127 - */ 1128 1128 - parameterStringWithEmptyDefault: string; 1129 1129 - /** 1130 1130 - * This is a string with no default 1131 1131 - */ 1132 1132 - parameterStringWithNoDefault: string; 1133 1133 - }; 1134 1134 - 1135 1135 - export type CallWithNoContentResponseResponse = void; 1136 1136 - 1137 1137 - export type CallWithResponseAndNoContentResponseResponse = number | void; 1138 1138 - 1139 1139 - export type DummyAResponse = _400; 1140 1140 - 1141 1141 - export type DummyBResponse = void; 1142 1142 - 1143 1143 - export type CallWithResponseResponse = _import; 1144 1144 - 1145 1145 - export type CallWithDuplicateResponsesResponse = ModelWithBoolean & ModelWithInteger | ModelWithString; 1146 1146 - 1147 1147 - export type CallWithResponsesResponse = { 1148 1148 - readonly '@namespace.string'?: string; 1149 1149 - readonly '@namespace.integer'?: number; 1150 1150 - readonly value?: Array<ModelWithString>; 1151 1151 - } | ModelThatExtends | ModelThatExtendsExtends; 1152 1152 - 1153 1153 - export type CollectionFormatData = { 1154 1154 - /** 1155 1155 - * This is an array parameter that is sent as csv format (comma-separated values) 1156 1156 - */ 1157 1157 - parameterArrayCsv: Array<(string)> | null; 1158 1158 - /** 1159 1159 - * This is an array parameter that is sent as multi format (multiple parameter instances) 1160 1160 - */ 1161 1161 - parameterArrayMulti: Array<(string)> | null; 1162 1162 - /** 1163 1163 - * This is an array parameter that is sent as pipes format (pipe-separated values) 1164 1164 - */ 1165 1165 - parameterArrayPipes: Array<(string)> | null; 1166 1166 - /** 1167 1167 - * This is an array parameter that is sent as ssv format (space-separated values) 1168 1168 - */ 1169 1169 - parameterArraySsv: Array<(string)> | null; 1170 1170 - /** 1171 1171 - * This is an array parameter that is sent as tsv format (tab-separated values) 1172 1172 - */ 1173 1173 - parameterArrayTsv: Array<(string)> | null; 1174 1174 - }; 1175 1175 - 1176 1176 - export type TypesData = { 1177 1177 - /** 1178 1178 - * This is a number parameter 1179 1179 - */ 1180 1180 - id?: number; 1181 1181 - /** 1182 1182 - * This is an array parameter 1183 1183 - */ 1184 1184 - parameterArray: Array<(string)> | null; 1185 1185 - /** 1186 1186 - * This is a boolean parameter 1187 1187 - */ 1188 1188 - parameterBoolean: boolean | null; 1189 1189 - /** 1190 1190 - * This is a dictionary parameter 1191 1191 - */ 1192 1192 - parameterDictionary: { 1193 1193 - [key: string]: unknown; 1194 1194 - } | null; 1195 1195 - /** 1196 1196 - * This is an enum parameter 1197 1197 - */ 1198 1198 - parameterEnum: 'Success' | 'Warning' | 'Error' | null; 1199 1199 - /** 1200 1200 - * This is a number parameter 1201 1201 - */ 1202 1202 - parameterNumber: number; 1203 1203 - /** 1204 1204 - * This is an object parameter 1205 1205 - */ 1206 1206 - parameterObject: { 1207 1207 - [key: string]: unknown; 1208 1208 - } | null; 1209 1209 - /** 1210 1210 - * This is a string parameter 1211 1211 - */ 1212 1212 - parameterString: string | null; 1213 1213 - }; 1214 1214 - 1215 1215 - export type TypesResponse = number | string | boolean | { 1216 1216 - [key: string]: unknown; 1217 1217 - }; 1218 1218 - 1219 1219 - export type UploadFileData = { 1220 1220 - formData: (Blob | File); 1221 1221 - }; 1222 1222 - 1223 1223 - export type UploadFileResponse = boolean; 1224 1224 - 1225 1225 - export type FileResponseData = { 1226 1226 - id: string; 1227 1227 - }; 1228 1228 - 1229 1229 - export type FileResponseResponse = (Blob | File); 1230 1230 - 1231 1231 - export type ComplexTypesData = { 1232 1232 - /** 1233 1233 - * Parameter containing object 1234 1234 - */ 1235 1235 - parameterObject: { 1236 1236 - first?: { 1237 1237 - second?: { 1238 1238 - third?: string; 1239 1239 - }; 1240 1240 - }; 1241 1241 - }; 1242 1242 - /** 1243 1243 - * Parameter containing reference 1244 1244 - */ 1245 1245 - parameterReference: ModelWithString; 1246 1246 - }; 1247 1247 - 1248 1248 - export type ComplexTypesResponse = Array<ModelWithString>; 1249 1249 - 1250 1250 - export type MultipartRequestData = { 1251 1251 - formData?: { 1252 1252 - content?: (Blob | File); 1253 1253 - data?: ModelWithString | null; 1254 1254 - }; 1255 1255 - }; 1256 1256 - 1257 1257 - export type MultipartResponseResponse = { 1258 1258 - file?: (Blob | File); 1259 1259 - metadata?: { 1260 1260 - foo?: string; 1261 1261 - bar?: string; 1262 1262 - }; 1263 1263 - }; 1264 1264 - 1265 1265 - export type ComplexParamsData = { 1266 1266 - id: number; 1267 1267 - requestBody?: { 1268 1268 - readonly key: string | null; 1269 1269 - name: string | null; 1270 1270 - enabled?: boolean; 1271 1271 - readonly type: 'Monkey' | 'Horse' | 'Bird'; 1272 1272 - listOfModels?: Array<ModelWithString> | null; 1273 1273 - listOfStrings?: Array<(string)> | null; 1274 1274 - parameters: ModelWithString | ModelWithEnum | ModelWithArray | ModelWithDictionary; 1275 1275 - readonly user?: { 1276 1276 - readonly id?: number; 1277 1277 - readonly name?: string | null; 1278 1278 - }; 1279 1279 - }; 1280 1280 - }; 1281 1281 - 1282 1282 - export type ComplexParamsResponse = ModelWithString; 1283 1283 - 1284 1284 - export type CallWithResultFromHeaderResponse = string; 1285 1285 - 1286 1286 - export type TestErrorCodeData = { 1287 1287 - /** 1288 1288 - * Status code to return 1289 1289 - */ 1290 1290 - status: number; 1291 1291 - }; 1292 1292 - 1293 1293 - export type TestErrorCodeResponse = unknown; 1294 1294 - 1295 1295 - export type NonAsciiæøåÆøÅöôêÊ字符串Data = { 1296 1296 - /** 1297 1297 - * Dummy input param 1298 1298 - */ 1299 1299 - nonAsciiParamæøåÆøÅöôêÊ: number; 1300 1300 - }; 1301 1301 - 1302 1302 - export type NonAsciiæøåÆøÅöôêÊ字符串Response = Array<NonAsciiStringæøåÆØÅöôêÊ字符串>; 1303 1303 - 1304 1304 - export type PutWithFormUrlEncodedData = { 1305 1305 - formData: ArrayWithStrings; 1306 1306 - }; 885 885 + export type Parameterx_Foo_Bar = ModelWithString;