swagger-typescript-api 13.4.0 → 13.6.0

package/dist/{src-BPFXd2rf.mjs → src-sIP2rLyu.mjs}

@@ -174,7 +174,7 @@ var ComponentTypeNameResolver = class extends NameResolver {
 //#endregion
 //#region package.json
 var name = "swagger-typescript-api";
-var version = "13.4.0";
+var version = "13.6.0";
 var description = "Generate the API client for Fetch or Axios from an OpenAPI Specification";
 //#endregion
 //#region src/constants.ts
@@ -500,6 +500,7 @@ var CodeGenConfig = class {
 		string: {
 			$default: this.Ts.Keyword.String,
 			binary: () => this.Ts.Keyword.File,
+			byte: () => this.Ts.Keyword.Blob,
 			file: () => this.Ts.Keyword.File,
 			"date-time": () => this.Ts.Keyword.String,
 			time: () => this.Ts.Keyword.String,
@@ -1411,7 +1412,7 @@ var SchemaUtils = class {
 		this.schemaComponentsMap = schemaComponentsMap;
 		this.typeNameFormatter = typeNameFormatter;
 	}
-	isBinaryLikeContentMediaType = (contentMediaType) => {
+	isBinaryLikeMimeType = (contentMediaType) => {
 		if (typeof contentMediaType !== "string" || !contentMediaType) return false;
 		const mediaType = contentMediaType.split(";")[0]?.trim().toLowerCase();
 		if (!mediaType) return false;
@@ -1422,10 +1423,13 @@ var SchemaUtils = class {
 		*/
 		if (mediaType.startsWith("text/")) return false;
 		if (mediaType.includes("json") || mediaType.includes("+json")) return false;
+		/** application/vnd.* binary types first: names like "openxmlformats" / "spreadsheetml" contain "xml" but are binary. */
+		if (mediaType.startsWith("application/vnd.")) return mediaType.endsWith(".blob") || mediaType.includes("spreadsheetml.sheet") || mediaType.startsWith("application/vnd.ms-excel") || mediaType.startsWith("application/vnd.openxmlformats-officedocument.") || mediaType === "application/vnd.rar" || mediaType.startsWith("application/vnd.oasis.opendocument.") || mediaType.startsWith("application/vnd.ms-powerpoint") || mediaType.startsWith("application/vnd.ms-fontobject") || mediaType === "application/vnd.visio" || mediaType === "application/vnd.amazon.ebook";
 		if (mediaType.includes("xml") || mediaType.includes("+xml")) return false;
 		if (mediaType === "application/x-www-form-urlencoded") return false;
-		if (mediaType === "application/javascript" || mediaType === "application/ecmascript" || mediaType === "application/graphql" || mediaType === "application/yaml" || mediaType === "application/x-yaml") return false;
-		return mediaType === "application/octet-stream" || mediaType.startsWith("image/") || mediaType.startsWith("audio/") || mediaType.startsWith("video/") || mediaType.startsWith("font/") || mediaType.startsWith("model/") || mediaType.startsWith("application/");
+		if (mediaType === "application/javascript" || mediaType === "application/ecmascript" || mediaType === "application/graphql" || mediaType === "application/yaml" || mediaType === "application/x-yaml" || mediaType === "application/jwt") return false;
+		if (mediaType.startsWith("application/")) return mediaType === "application/octet-stream" || mediaType.startsWith("application/pdf") || mediaType === "application/zip" || mediaType.startsWith("application/x-zip") || mediaType === "application/gzip" || mediaType.startsWith("application/x-gzip") || mediaType.startsWith("application/x-bzip") || mediaType === "application/x-bzip2" || mediaType.startsWith("application/x-tar") || mediaType.startsWith("application/x-rar") || mediaType.startsWith("application/x-7z") || mediaType === "application/x-binary" || mediaType === "application/java-archive" || mediaType === "application/epub+zip" || mediaType === "application/msword" || mediaType === "application/rtf" || mediaType === "application/x-abiword" || mediaType === "application/x-freearc";
+		return mediaType.startsWith("image/") || mediaType.startsWith("audio/") || mediaType.startsWith("video/") || mediaType.startsWith("font/") || mediaType.startsWith("model/");
 	};
 	getRequiredProperties = (schema) => {
 		return uniq(schema && Array.isArray(schema.required) && schema.required || []);
@@ -1535,7 +1539,7 @@ var SchemaUtils = class {
 		else {
 			const primitiveType = this.getSchemaPrimitiveType(schema);
 			if (primitiveType == null) return this.config.Ts.Keyword.Any;
-			if (primitiveType === this.config.Ts.Keyword.String && !schema.format && this.isBinaryLikeContentMediaType(schema.contentMediaType)) resultType = this.config.Ts.UnionType([this.config.Ts.Keyword.File, this.config.Ts.Keyword.Blob]);
+			if (primitiveType === this.config.Ts.Keyword.String && !schema.format && this.isBinaryLikeMimeType(schema.contentMediaType)) resultType = this.config.Ts.UnionType([this.config.Ts.Keyword.File, this.config.Ts.Keyword.Blob]);
 			else {
 				const typeAlias = get(this.config.primitiveTypes, [primitiveType, schema.format]) || get(this.config.primitiveTypes, [primitiveType, "$default"]) || this.config.primitiveTypes[primitiveType];
 				if (typeof typeAlias === "function") resultType = typeAlias(schema, this);
@@ -1797,6 +1801,8 @@ var SchemaRoutes = class {
 		if (contentTypes.some((contentType) => contentType.startsWith("text/"))) return CONTENT_KIND.TEXT;
 		return CONTENT_KIND.OTHER;
 	};
+	/** True when response produces only binary media types (e.g. file download). */
+	isBinaryOnlyContentTypes = (contentTypes) => !!contentTypes?.length && contentTypes.every((ct) => this.schemaUtils.isBinaryLikeMimeType(ct));
 	isSuccessStatus = (status) => this.config.defaultResponseAsSuccess && status === "default" || +status >= this.config.successResponseStatusRange[0] && +status <= this.config.successResponseStatusRange[1] || status === "2xx";
 	getSchemaFromRequestType = (requestInfo) => {
 		const content = get(requestInfo, "content");
@@ -1876,9 +1882,18 @@ var SchemaRoutes = class {
 			return acc;
 		}, []);
 	};
-	getResponseBodyInfo = (routeInfo, parsedSchemas, resolvedSwaggerSchema) => {
+	getResponseBodyInfo = (routeInfo, parsedSchemas, resolvedSwaggerSchema, pathName, method) => {
 		const { produces, operationId, responses } = routeInfo;
 		const contentTypes = this.getContentTypes(responses, [...produces || [], routeInfo["x-accepts"]]);
+		const successStatus = Object.keys(responses || {}).find((s) => this.isSuccessStatus(s));
+		const successResponseContent = successStatus && responses?.[successStatus];
+		const successContentTypes = successResponseContent?.content && typeof successResponseContent.content === "object" ? Object.keys(successResponseContent.content) : null;
+		const originalProduces = pathName && method ? resolvedSwaggerSchema.getOriginalProduces(pathName, method) ?? get(resolvedSwaggerSchema.originalSchema, [
+			"paths",
+			pathName,
+			method,
+			"produces"
+		]) : void 0;
 		const responseInfos = this.getRequestInfoTypes({
 			requestInfos: responses,
 			parsedSchemas,
@@ -1896,13 +1911,14 @@ var SchemaRoutes = class {
 			}));
 			return `headers: { ${Object.entries(headerTypes).map(([k, v]) => `"${k}": ${v}`).join(",")} },`;
 		};
+		const typesToCheck = (Array.isArray(originalProduces) && originalProduces.length > 0 ? originalProduces : null) ?? (produces?.length ? produces : null) ?? (successContentTypes?.length ? successContentTypes : null) ?? contentTypes;
 		return {
 			contentTypes,
 			responses: responseInfos,
 			links,
 			success: {
 				schema: successResponse,
-				type: successResponse?.type || this.config.Ts.Keyword.Any
+				type: this.isBinaryOnlyContentTypes(typesToCheck) ? this.config.Ts.Keyword.Blob : successResponse?.type || this.config.Ts.Keyword.Any
 			},
 			error: {
 				schemas: errorResponses,
@@ -2102,7 +2118,7 @@ var SchemaRoutes = class {
 			description: pathArgSchema.description
 		}));
 		const pathArgsNames = pathArgs.map((arg) => arg.name);
-		const responseBodyInfo = this.getResponseBodyInfo(routeInfo, parsedSchemas, resolvedSwaggerSchema);
+		const responseBodyInfo = this.getResponseBodyInfo(routeInfo, parsedSchemas, resolvedSwaggerSchema, rawRouteName, method);
 		const rawRouteInfo = {
 			...otherInfo,
 			pathArgs,
@@ -2402,13 +2418,18 @@ var ResolvedSwaggerSchema = class ResolvedSwaggerSchema {
 		if (resolved == null) return null;
 		return this.absolutizeLocalRefs(resolved, this.stripHash(externalPath));
 	}
-	constructor(config, usageSchema, originalSchema, resolvers) {
+	originalProducesByRoute = Object.create(null);
+	constructor(config, usageSchema, originalSchema, resolvers, originalProducesByRoute) {
 		this.config = config;
 		this.usageSchema = usageSchema;
 		this.originalSchema = originalSchema;
 		this.resolvers = resolvers;
 		this.usageSchema = usageSchema;
 		this.originalSchema = originalSchema;
+		if (originalProducesByRoute) this.originalProducesByRoute = originalProducesByRoute;
+	}
+	getOriginalProduces(pathName, method) {
+		return this.originalProducesByRoute[pathName]?.[method];
 	}
 	getRefDetails(ref) {
 		const normalizedRef = this.normalizeRef(ref);
@@ -2576,7 +2597,7 @@ var ResolvedSwaggerSchema = class ResolvedSwaggerSchema {
 		}
 		return null;
 	}
-	static async create(config, usageSchema, originalSchema) {
+	static async create(config, usageSchema, originalSchema, originalProducesByRoute) {
 		const resolvers = [];
 		const options = {
 			continueOnError: true,
@@ -2609,7 +2630,7 @@ var ResolvedSwaggerSchema = class ResolvedSwaggerSchema {
 		} catch (e) {
 			consola.debug(e);
 		}
-		const resolvedSwaggerSchema = new ResolvedSwaggerSchema(config, usageSchema, originalSchema, resolvers);
+		const resolvedSwaggerSchema = new ResolvedSwaggerSchema(config, usageSchema, originalSchema, resolvers, originalProducesByRoute);
 		await resolvedSwaggerSchema.warmUpRemoteSchemasCache();
 		return resolvedSwaggerSchema;
 	}
@@ -2654,12 +2675,13 @@ var SwaggerSchemaResolver = class {
 			const swaggerSchemaObject = this.processSwaggerSchemaFile(swaggerSchemaFile);
 			swaggerSchemas = await this.convertSwaggerObject(swaggerSchemaObject, { patch });
 		}
-		this.fixSwaggerSchemas(swaggerSchemas);
-		return ResolvedSwaggerSchema.create(this.config, swaggerSchemas.usageSchema, swaggerSchemas.originalSchema);
+		const originalProducesByRoute = this.fixSwaggerSchemas(swaggerSchemas);
+		return await ResolvedSwaggerSchema.create(this.config, swaggerSchemas.usageSchema, swaggerSchemas.originalSchema, originalProducesByRoute);
 	}
 	convertSwaggerObject(swaggerSchema, converterOptions) {
 		return new Promise((resolve) => {
 			const result = structuredClone(swaggerSchema);
+			const originalSchemaForProduces = structuredClone(swaggerSchema);
 			result.info = merge({
 				title: "No title",
 				version: ""
@@ -2678,12 +2700,14 @@ var SwaggerSchemaResolver = class {
 					this.config.update({ convertedFromSwagger2: true });
 					resolve({
 						usageSchema: parsedSwaggerSchema,
-						originalSchema: result
+						originalSchema: result,
+						originalSchemaForProduces
 					});
 				});
 			} else resolve({
 				usageSchema: result,
-				originalSchema: structuredClone(result)
+				originalSchema: structuredClone(result),
+				originalSchemaForProduces
 			});
 		});
 	}
@@ -2724,13 +2748,17 @@ var SwaggerSchemaResolver = class {
 		if (typeof objectSchema.$ref === "string") objectSchema.$ref = this.normalizeRefValue(objectSchema.$ref);
 		for (const value of Object.values(objectSchema)) this.normalizeRefsInSchema(value);
 	}
-	fixSwaggerSchemas({ usageSchema, originalSchema }) {
+	fixSwaggerSchemas({ usageSchema, originalSchema, originalSchemaForProduces }) {
 		this.normalizeRefsInSchema(usageSchema);
 		this.normalizeRefsInSchema(originalSchema);
 		const usagePaths = get(usageSchema, "paths") || {};
-		const originalPaths = get(originalSchema, "paths") || {};
+		const schemaForProduces = originalSchemaForProduces ?? originalSchema;
+		const originalPaths = get(schemaForProduces, "paths") || {};
+		const basePath = schemaForProduces.basePath?.replace(/\/$/, "") || "";
+		const originalProducesByRoute = Object.create(null);
 		for (const [route, usagePathObject] of Object.entries(usagePaths)) {
-			const originalPathObject = get(originalPaths, route) || {};
+			const routeWithoutBase = basePath && route.startsWith(basePath) ? route.slice(basePath.length) || "/" : route;
+			const originalPathObject = get(originalPaths, route) || get(originalPaths, routeWithoutBase.startsWith("/") ? routeWithoutBase : `/${routeWithoutBase}`) || {};
 			for (const [methodName, usageRouteInfo] of Object.entries(usagePathObject)) {
 				const originalRouteInfo = get(originalPathObject, methodName) || {};
 				const usageRouteParams = get(usageRouteInfo, "parameters") || [];
@@ -2738,11 +2766,18 @@ var SwaggerSchemaResolver = class {
 				const usageAsOpenapiv2 = usageRouteInfo;
 				if (typeof usageRouteInfo === "object") {
 					usageAsOpenapiv2.consumes = uniq(compact([...usageAsOpenapiv2.consumes || [], ...originalRouteInfo.consumes || []]));
-					usageAsOpenapiv2.produces = uniq(compact([...usageAsOpenapiv2.produces || [], ...originalRouteInfo.produces || []]));
+					let mergedProduces = uniq(compact([...usageAsOpenapiv2.produces || [], ...originalRouteInfo.produces || []]));
+					if (mergedProduces.length === 0) mergedProduces = uniq(compact(get(schemaForProduces, "produces") || []));
+					usageAsOpenapiv2.produces = mergedProduces;
+					if (mergedProduces.length > 0) {
+						if (!originalProducesByRoute[route]) originalProducesByRoute[route] = Object.create(null);
+						originalProducesByRoute[route][methodName] = mergedProduces;
+					}
 				}
 				for (const originalRouteParam of originalRouteParams) if (!usageRouteParams.find((param) => originalRouteParam.in === param.in && originalRouteParam.name === param.name)) usageRouteParams.push(originalRouteParam);
 			}
 		}
+		return originalProducesByRoute;
 	}
 };
 //#endregion
@@ -3432,4 +3467,4 @@ async function generateApi(config) {
 //#endregion
 export { SCHEMA_TYPES as a, constants_exports as c, version as d, RequestContentKind as i, description as l, generateTemplates as n, CodeGenConfig as o, TemplatesGenConfig as r, HTTP_CLIENT as s, generateApi as t, name as u };
 
-//# sourceMappingURL=src-BPFXd2rf.mjs.map
+//# sourceMappingURL=src-sIP2rLyu.mjs.map