vite-plugin-openapi-codegen 1.1.3 → 1.2.0

package/README.md

@@ -225,6 +225,8 @@ The generated client shape depends on the OpenAPI operation:
 - path parameters become `options.path`
 - query parameters become `options.query`
 - JSON request bodies become `options.body`
+- `application/octet-stream` request bodies become `options.body` with `contentType: "application/octet-stream"`
+- `multipart/form-data` request bodies become `options.body` as `FormData`
 - JSON responses become typed `Promise<T>`
 - empty responses use the configured void request function
 

package/dist/cli.mjs

@@ -146,7 +146,11 @@ function createClientChannelField(key, channel) {
 function createClientFunctionDeclaration(operation) {
 	const requestProperties = [ts.factory.createSpreadAssignment(ts.factory.createIdentifier("requestOptions")), ts.factory.createPropertyAssignment(ts.factory.createIdentifier("method"), ts.factory.createStringLiteral(operation.methodUpper))];
 	if (operation.queryChannel.present) requestProperties.push(ts.factory.createPropertyAssignment(ts.factory.createIdentifier("searchParams"), ts.factory.createCallExpression(ts.factory.createIdentifier("buildSearchParams"), void 0, [ts.factory.createPropertyAccessExpression(ts.factory.createIdentifier("options"), "query")])));
-	if (operation.bodyChannel.present) requestProperties.push(ts.factory.createPropertyAssignment(ts.factory.createIdentifier("json"), ts.factory.createPropertyAccessExpression(ts.factory.createIdentifier("options"), "body")));
+	if (operation.bodyChannel.present) {
+		if (operation.bodyContentType === "json") requestProperties.push(ts.factory.createPropertyAssignment(ts.factory.createIdentifier("json"), ts.factory.createPropertyAccessExpression(ts.factory.createIdentifier("options"), "body")));
+		else requestProperties.push(ts.factory.createPropertyAssignment(ts.factory.createIdentifier("body"), ts.factory.createPropertyAccessExpression(ts.factory.createIdentifier("options"), "body")));
+		if (operation.bodyContentType === "binary") requestProperties.push(ts.factory.createPropertyAssignment(ts.factory.createIdentifier("contentType"), ts.factory.createStringLiteral("application/octet-stream")));
+	}
 	requestProperties.push(ts.factory.createPropertyAssignment(ts.factory.createIdentifier("signal"), ts.factory.createPropertyAccessExpression(ts.factory.createIdentifier("options"), "signal")));
 	const requestCall = ts.factory.createCallExpression(ts.factory.createIdentifier(operation.requestFunction), operation.responseTypeExpr ? [createTypeNodeFromText(operation.responseTypeExpr)] : void 0, [parseExpression(operation.pathInvocationExpr), ts.factory.createObjectLiteralExpression(requestProperties, true)]);
 	return ts.factory.createFunctionDeclaration([createExportModifier()], void 0, ts.factory.createIdentifier(operation.funcName), void 0, [ts.factory.createParameterDeclaration(void 0, void 0, ts.factory.createIdentifier("options"), void 0, ts.factory.createTypeReferenceNode(operation.optionTypeName)), ts.factory.createParameterDeclaration(void 0, void 0, ts.factory.createIdentifier("requestOptions"), void 0, ts.factory.createTypeReferenceNode("RuntimeRequestOptions"), ts.factory.createObjectLiteralExpression())], createTypeNodeFromText(operation.returnTypeExpr), ts.factory.createBlock([ts.factory.createReturnStatement(requestCall)], true));
@@ -242,13 +246,6 @@ function getParametersByLocation(operation, location) {
 function hasRequiredChannel(parameters) {
 	return parameters.some((parameter) => parameter.required);
 }
-function getJsonRequestBody(operation) {
-	const requestBody = operation.requestBody;
-	if (!requestBody) return void 0;
-	const jsonBody = requestBody.content?.["application/json"];
-	if (!jsonBody) throw new Error(`Operation "${operation.operationId ?? "unknown"}" has a requestBody but no application/json content`);
-	return jsonBody;
-}
 function getSuccessResponseInfo(operation) {
 	const successResponses = Object.entries(operation.responses ?? {}).filter(([statusKey]) => isSuccessStatus(statusKey)).sort(([left], [right]) => Number(left) - Number(right));
 	if (successResponses.length === 0) throw new Error(`Operation "${operation.operationId ?? "unknown"}" has no 2xx success response`);
@@ -335,10 +332,11 @@ function normalizeOperation(entry, context, requestFunctionNames) {
 	const builderAlias = getBuilderAlias(entry.funcName);
 	const pathChannel = normalizeParameterChannel(entry, context, "path");
 	const queryChannel = normalizeParameterChannel(entry, context, "query");
-	const bodyChannel = normalizeBodyChannel(entry, context);
+	const bodyResolution = normalizeBodyChannel(entry, context);
 	const responseTypeRef = resolveResponseTypeReference(entry, context, successResponse);
 	return {
-		bodyChannel,
+		bodyChannel: bodyResolution.channel,
+		bodyContentType: bodyResolution.contentType,
 		builderAlias,
 		entry,
 		optionTypeName: getClientOptionTypeName(entry.funcName),
@@ -364,7 +362,35 @@ function normalizeParameterChannel(entry, context, location) {
 	};
 }
 function normalizeBodyChannel(entry, context) {
-	const typeRef = resolveRequestBodyTypeReference(entry, context);
+	const requestBody = entry.operation.requestBody;
+	if (!requestBody) return {
+		channel: {
+			present: false,
+			required: false,
+			typeRef: null
+		},
+		contentType: null
+	};
+	const content = requestBody.content ?? {};
+	const jsonBody = content["application/json"];
+	if (jsonBody) return {
+		channel: createRequestBodyChannel(entry, context, jsonBody, "json"),
+		contentType: "json"
+	};
+	const binaryBody = content["application/octet-stream"];
+	if (binaryBody) return {
+		channel: createRequestBodyChannel(entry, context, binaryBody, "binary"),
+		contentType: "binary"
+	};
+	const multipartBody = content["multipart/form-data"];
+	if (multipartBody) return {
+		channel: createRequestBodyChannel(entry, context, multipartBody, "formData"),
+		contentType: "formData"
+	};
+	throw new Error(`Operation "${entry.operationId ?? "unknown"}" has a requestBody but no supported content type`);
+}
+function createRequestBodyChannel(entry, context, body, kind) {
+	const typeRef = resolveRequestBodyTypeReference(entry, context, body, kind);
 	if (!typeRef) return {
 		present: false,
 		required: false,
@@ -376,10 +402,18 @@ function normalizeBodyChannel(entry, context) {
 		typeRef
 	};
 }
-function resolveRequestBodyTypeReference(entry, context) {
-	const jsonBody = getJsonRequestBody(entry.operation);
-	if (!jsonBody) return null;
-	const schemaTypeRef = resolveSchemaTypeReference(context, jsonBody.schema);
+function resolveRequestBodyTypeReference(entry, context, body, kind) {
+	if (kind === "formData") return {
+		aliasDefinitionExpr: "FormData",
+		sourceExpr: "FormData",
+		typeName: allocateOperationTypeName(context, entry.funcName, "Request")
+	};
+	if (kind === "binary") return {
+		aliasDefinitionExpr: "Blob | File | ArrayBuffer | string",
+		sourceExpr: "Blob | File | ArrayBuffer | string",
+		typeName: allocateOperationTypeName(context, entry.funcName, "Request")
+	};
+	const schemaTypeRef = resolveSchemaTypeReference(context, body.schema);
 	if (schemaTypeRef) return schemaTypeRef;
 	return {
 		aliasDefinitionExpr: `operations['${entry.operationId}']['requestBody']['content']['application/json']`,
@@ -526,6 +560,7 @@ function createApiEntries(normalizedOps, useTypeAliases) {
 	return normalizedOps.map((op) => ({
 		funcName: op.entry.funcName,
 		group: op.entry.group,
+		bodyContentType: op.bodyContentType,
 		pathTypeExpr: op.pathChannel.typeRef == null ? null : useTypeAliases ? op.pathChannel.typeRef.typeName : op.pathChannel.typeRef.sourceExpr,
 		strippedPath: op.entry.strippedPath
 	}));
@@ -540,6 +575,7 @@ function createClientRenderModel(model, useTypeAliases) {
 		needsSearchParamsHelper: model.needsSearchParamsHelper,
 		operations: model.operations.map((operation) => ({
 			bodyChannel: resolveChannel(operation.bodyChannel, useTypeAliases),
+			bodyContentType: operation.bodyContentType,
 			builderAlias: operation.builderAlias,
 			funcName: operation.entry.funcName,
 			group: operation.entry.group,

package/dist/index.mjs

@@ -144,7 +144,11 @@ function createClientChannelField(key, channel) {
 function createClientFunctionDeclaration(operation) {
 	const requestProperties = [ts.factory.createSpreadAssignment(ts.factory.createIdentifier("requestOptions")), ts.factory.createPropertyAssignment(ts.factory.createIdentifier("method"), ts.factory.createStringLiteral(operation.methodUpper))];
 	if (operation.queryChannel.present) requestProperties.push(ts.factory.createPropertyAssignment(ts.factory.createIdentifier("searchParams"), ts.factory.createCallExpression(ts.factory.createIdentifier("buildSearchParams"), void 0, [ts.factory.createPropertyAccessExpression(ts.factory.createIdentifier("options"), "query")])));
-	if (operation.bodyChannel.present) requestProperties.push(ts.factory.createPropertyAssignment(ts.factory.createIdentifier("json"), ts.factory.createPropertyAccessExpression(ts.factory.createIdentifier("options"), "body")));
+	if (operation.bodyChannel.present) {
+		if (operation.bodyContentType === "json") requestProperties.push(ts.factory.createPropertyAssignment(ts.factory.createIdentifier("json"), ts.factory.createPropertyAccessExpression(ts.factory.createIdentifier("options"), "body")));
+		else requestProperties.push(ts.factory.createPropertyAssignment(ts.factory.createIdentifier("body"), ts.factory.createPropertyAccessExpression(ts.factory.createIdentifier("options"), "body")));
+		if (operation.bodyContentType === "binary") requestProperties.push(ts.factory.createPropertyAssignment(ts.factory.createIdentifier("contentType"), ts.factory.createStringLiteral("application/octet-stream")));
+	}
 	requestProperties.push(ts.factory.createPropertyAssignment(ts.factory.createIdentifier("signal"), ts.factory.createPropertyAccessExpression(ts.factory.createIdentifier("options"), "signal")));
 	const requestCall = ts.factory.createCallExpression(ts.factory.createIdentifier(operation.requestFunction), operation.responseTypeExpr ? [createTypeNodeFromText(operation.responseTypeExpr)] : void 0, [parseExpression(operation.pathInvocationExpr), ts.factory.createObjectLiteralExpression(requestProperties, true)]);
 	return ts.factory.createFunctionDeclaration([createExportModifier()], void 0, ts.factory.createIdentifier(operation.funcName), void 0, [ts.factory.createParameterDeclaration(void 0, void 0, ts.factory.createIdentifier("options"), void 0, ts.factory.createTypeReferenceNode(operation.optionTypeName)), ts.factory.createParameterDeclaration(void 0, void 0, ts.factory.createIdentifier("requestOptions"), void 0, ts.factory.createTypeReferenceNode("RuntimeRequestOptions"), ts.factory.createObjectLiteralExpression())], createTypeNodeFromText(operation.returnTypeExpr), ts.factory.createBlock([ts.factory.createReturnStatement(requestCall)], true));
@@ -240,13 +244,6 @@ function getParametersByLocation(operation, location) {
 function hasRequiredChannel(parameters) {
 	return parameters.some((parameter) => parameter.required);
 }
-function getJsonRequestBody(operation) {
-	const requestBody = operation.requestBody;
-	if (!requestBody) return void 0;
-	const jsonBody = requestBody.content?.["application/json"];
-	if (!jsonBody) throw new Error(`Operation "${operation.operationId ?? "unknown"}" has a requestBody but no application/json content`);
-	return jsonBody;
-}
 function getSuccessResponseInfo(operation) {
 	const successResponses = Object.entries(operation.responses ?? {}).filter(([statusKey]) => isSuccessStatus(statusKey)).sort(([left], [right]) => Number(left) - Number(right));
 	if (successResponses.length === 0) throw new Error(`Operation "${operation.operationId ?? "unknown"}" has no 2xx success response`);
@@ -333,10 +330,11 @@ function normalizeOperation(entry, context, requestFunctionNames) {
 	const builderAlias = getBuilderAlias(entry.funcName);
 	const pathChannel = normalizeParameterChannel(entry, context, "path");
 	const queryChannel = normalizeParameterChannel(entry, context, "query");
-	const bodyChannel = normalizeBodyChannel(entry, context);
+	const bodyResolution = normalizeBodyChannel(entry, context);
 	const responseTypeRef = resolveResponseTypeReference(entry, context, successResponse);
 	return {
-		bodyChannel,
+		bodyChannel: bodyResolution.channel,
+		bodyContentType: bodyResolution.contentType,
 		builderAlias,
 		entry,
 		optionTypeName: getClientOptionTypeName(entry.funcName),
@@ -362,7 +360,35 @@ function normalizeParameterChannel(entry, context, location) {
 	};
 }
 function normalizeBodyChannel(entry, context) {
-	const typeRef = resolveRequestBodyTypeReference(entry, context);
+	const requestBody = entry.operation.requestBody;
+	if (!requestBody) return {
+		channel: {
+			present: false,
+			required: false,
+			typeRef: null
+		},
+		contentType: null
+	};
+	const content = requestBody.content ?? {};
+	const jsonBody = content["application/json"];
+	if (jsonBody) return {
+		channel: createRequestBodyChannel(entry, context, jsonBody, "json"),
+		contentType: "json"
+	};
+	const binaryBody = content["application/octet-stream"];
+	if (binaryBody) return {
+		channel: createRequestBodyChannel(entry, context, binaryBody, "binary"),
+		contentType: "binary"
+	};
+	const multipartBody = content["multipart/form-data"];
+	if (multipartBody) return {
+		channel: createRequestBodyChannel(entry, context, multipartBody, "formData"),
+		contentType: "formData"
+	};
+	throw new Error(`Operation "${entry.operationId ?? "unknown"}" has a requestBody but no supported content type`);
+}
+function createRequestBodyChannel(entry, context, body, kind) {
+	const typeRef = resolveRequestBodyTypeReference(entry, context, body, kind);
 	if (!typeRef) return {
 		present: false,
 		required: false,
@@ -374,10 +400,18 @@ function normalizeBodyChannel(entry, context) {
 		typeRef
 	};
 }
-function resolveRequestBodyTypeReference(entry, context) {
-	const jsonBody = getJsonRequestBody(entry.operation);
-	if (!jsonBody) return null;
-	const schemaTypeRef = resolveSchemaTypeReference(context, jsonBody.schema);
+function resolveRequestBodyTypeReference(entry, context, body, kind) {
+	if (kind === "formData") return {
+		aliasDefinitionExpr: "FormData",
+		sourceExpr: "FormData",
+		typeName: allocateOperationTypeName(context, entry.funcName, "Request")
+	};
+	if (kind === "binary") return {
+		aliasDefinitionExpr: "Blob | File | ArrayBuffer | string",
+		sourceExpr: "Blob | File | ArrayBuffer | string",
+		typeName: allocateOperationTypeName(context, entry.funcName, "Request")
+	};
+	const schemaTypeRef = resolveSchemaTypeReference(context, body.schema);
 	if (schemaTypeRef) return schemaTypeRef;
 	return {
 		aliasDefinitionExpr: `operations['${entry.operationId}']['requestBody']['content']['application/json']`,
@@ -524,6 +558,7 @@ function createApiEntries(normalizedOps, useTypeAliases) {
 	return normalizedOps.map((op) => ({
 		funcName: op.entry.funcName,
 		group: op.entry.group,
+		bodyContentType: op.bodyContentType,
 		pathTypeExpr: op.pathChannel.typeRef == null ? null : useTypeAliases ? op.pathChannel.typeRef.typeName : op.pathChannel.typeRef.sourceExpr,
 		strippedPath: op.entry.strippedPath
 	}));
@@ -538,6 +573,7 @@ function createClientRenderModel(model, useTypeAliases) {
 		needsSearchParamsHelper: model.needsSearchParamsHelper,
 		operations: model.operations.map((operation) => ({
 			bodyChannel: resolveChannel(operation.bodyChannel, useTypeAliases),
+			bodyContentType: operation.bodyContentType,
 			builderAlias: operation.builderAlias,
 			funcName: operation.entry.funcName,
 			group: operation.entry.group,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vite-plugin-openapi-codegen",
-  "version": "1.1.3",
+  "version": "1.2.0",
   "description": "Vite plugin that generates typed API clients and route builders from OpenAPI specs",
   "keywords": [
     "api-client",