react-query-lightbase-codegen 3.0.0 → 3.1.0

package/dist/generator/clientGenerator.js

@@ -3,9 +3,11 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.generateApiClient = generateApiClient;
 const utils_1 = require("../utils");
 function generateAxiosMethod(operation, spec) {
-    const { method, path, operationId, summary, description, parameters, requestBody, responses } = operation;
+    const { method, path, operationId, summary, description, deprecated, parameters, requestBody, responses } = operation;
     // Generate JSDoc
     const jsDocLines = ["/**"];
+    if (deprecated)
+        jsDocLines.push(" * @deprecated");
     if (summary)
         jsDocLines.push(` * ${summary}`);
     if (description)
@@ -19,14 +21,17 @@ function generateAxiosMethod(operation, spec) {
                 ? "query."
                 : param.in === "header"
                     ? "headers."
-                    : "";
+                    : param.in === "cookie"
+                        ? "cookies."
+                        : "";
         jsDocLines.push(` * @param ${prefix}${param.name}${desc}`);
     });
     if (requestBody && "description" in requestBody) {
         jsDocLines.push(` * @param data - ${requestBody.description}`);
     }
-    // Add return type description
-    const responseDetails = Object.entries(responses).find(([code]) => code.startsWith("2"));
+    // Add return type description - prefer 2xx responses, fall back to "default"
+    const responseDetails = Object.entries(responses).find(([code]) => code.startsWith("2")) ||
+        Object.entries(responses).find(([code]) => code === "default");
     if (responseDetails) {
         const [code, response] = responseDetails;
         const responseObj = response;
@@ -47,6 +52,7 @@ function generateAxiosMethod(operation, spec) {
     const urlParams = parameters?.filter((p) => p.in === "path") || [];
     const queryParams = parameters?.filter((p) => p.in === "query") || [];
     const headerParams = parameters?.filter((p) => p.in === "header") || [];
+    const cookieParams = parameters?.filter((p) => p.in === "cookie") || [];
     const isFormData = requestBody && "content" in requestBody && requestBody.content?.["multipart/form-data"];
     const formDataSchema = isFormData
         ? (0, utils_1.resolveSchema)(requestBody.content["multipart/form-data"].schema, spec)
@@ -62,9 +68,20 @@ function generateAxiosMethod(operation, spec) {
     const hasData = (parameters && parameters.length > 0) || operation.requestBody;
     const namedType = (0, utils_1.pascalCase)(operationId);
     // Get response type from 2xx response
-    const responseType = responseDetails?.[0] && "content" in responseDetails[1]
-        ? `T.${`${namedType}Response${responseDetails[0]}`}`
-        : "unknown";
+    const responseType = (() => {
+        if (!responseDetails)
+            return "unknown";
+        const [code, response] = responseDetails;
+        // If response has content, use the generated type
+        if ("content" in response && response.content) {
+            return `T.${namedType}Response${code}`;
+        }
+        // 204 (No Content) and 205 (Reset Content) should return void
+        if (code === "204" || code === "205") {
+            return "void";
+        }
+        return "unknown";
+    })();
     const urlWithParams = urlParams.length > 0 ? `\`${path.replace(/{(\w+)}/g, "${encodeURIComponent(data.$1)}")}\`` : `"${path}"`;
     // Handle destructuring based on whether we have primitive request body
     const destructuringLine = hasData
@@ -106,13 +123,18 @@ function generateAxiosMethod(operation, spec) {
         headerParams.length > 0
             ? `axiosConfig.headers = { ...axiosConfig.headers, ${headerParams.map((p) => `["${p.name}"]: data["${p.name}"]`).join(", ")} };`
             : "",
-        isFormData
-            ? "axiosConfig.headers = { ...axiosConfig.headers, 'Content-Type': 'multipart/form-data' };"
+        cookieParams.length > 0
+            ? `axiosConfig.headers = { ...axiosConfig.headers, Cookie: [${cookieParams.map((p) => `data["${p.name}"] != null ? \`${p.name}=\${data["${p.name}"]}\` : null`).join(", ")}].filter(Boolean).join("; ") };`
             : "",
+        // Note: Don't set Content-Type for FormData - Axios will set it automatically with the correct boundary
         requestBody
-            ? `const res = await apiClient.${method}<${responseType}>(url, ${formDataSchema?.properties || requestBodySchema?.properties ? "bodyData" : "data"}, axiosConfig);`
-            : `const res = await apiClient.${method}<${responseType}>(url, axiosConfig);`,
-        "return res.data;",
+            ? responseType === "void"
+                ? `await apiClient.${method}<${responseType}>(url, ${formDataSchema?.properties || requestBodySchema?.properties ? "bodyData" : "data"}, axiosConfig);`
+                : `const res = await apiClient.${method}<${responseType}>(url, ${formDataSchema?.properties || requestBodySchema?.properties ? "bodyData" : "data"}, axiosConfig);`
+            : responseType === "void"
+                ? `await apiClient.${method}<${responseType}>(url, axiosConfig);`
+                : `const res = await apiClient.${method}<${responseType}>(url, axiosConfig);`,
+        responseType !== "void" ? "return res.data;" : "",
     ]
         .filter(Boolean)
         .join("\n	");

package/dist/generator/reactQueryGenerator.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.generateReactQuery = generateReactQuery;
 const utils_1 = require("../utils");
 function generateQueryOptions(operation, spec) {
-    const { operationId, parameters, requestBody } = operation;
+    const { operationId, parameters, requestBody, deprecated } = operation;
     const hasData = (parameters && parameters.length > 0) || operation.requestBody;
     // Helper to get required fields from a schema
     const getRequiredFields = (schema, context) => {
@@ -56,8 +56,9 @@ function generateQueryOptions(operation, spec) {
             ? "!!data"
             : `hasDefinedProps(${paramsVariable}, ${requiredParams.join(", ")})`
         : "true";
+    const deprecatedComment = deprecated ? "/** @deprecated */\n" : "";
     return `
-export const ${namedQueryOptions} = ( 
+${deprecatedComment}export const ${namedQueryOptions} = (
   ${hasData ? `props: Partial<Parameters<typeof apiClient.${namedQuery}>[0]>` : `props?: Partial<Parameters<typeof apiClient.${namedQuery}>[0]>`}
 ) => {
   ${destructuringLine}
@@ -72,10 +73,8 @@ function generateReactQuery(spec) {
     const operations = (0, utils_1.collectOperations)(spec);
     return `import { queryOptions, skipToken } from '@tanstack/react-query';
 	import * as apiClient from './${(0, utils_1.specTitle)(spec)}.client';
-	// TEMPORARY: allows for backward compatibility imports
-	export * from './${(0, utils_1.specTitle)(spec)}.client';
 
-const hasDefinedProps = <T extends { [P in K]?: any }, K extends PropertyKey>(
+const hasDefinedProps = <T extends { [P in K]?: unknown }, K extends PropertyKey>(
   obj: T,
   ...keys: K[]
 ): obj is T & { [P in K]-?: Exclude<T[P], undefined> } => {

package/dist/generator/schemaGenerator.js

@@ -87,10 +87,13 @@ function generateTypeDefinitions(spec) {
                     []);
                 const headerParams = (parameters?.filter((p) => "in" in p && p.in === "header") ||
                     []);
-                // Add path, query, and header parameters
+                const cookieParams = (parameters?.filter((p) => "in" in p && p.in === "cookie") ||
+                    []);
+                // Add path, query, header, and cookie parameters
                 urlParams.forEach((p) => dataProps.push(formatParamProperty(p, true))); // Path params always required
                 queryParams.forEach((p) => dataProps.push(formatParamProperty(p)));
                 headerParams.forEach((p) => dataProps.push(formatParamProperty(p)));
+                cookieParams.forEach((p) => dataProps.push(formatParamProperty(p)));
                 // Add request body type if it exists
                 const hasData = (parameters && parameters.length > 0) || requestBody;
                 let dataType = "undefined";

package/dist/utils.d.ts

@@ -2,7 +2,7 @@ import type { OpenAPIV3 } from "openapi-types";
 /**
  * Supported content types in order of preference
  */
-export declare const CONTENT_TYPES: readonly ["application/ld+json", "application/json", "multipart/form-data", "application/octet-stream", "application/json;charset=UTF-8"];
+export declare const CONTENT_TYPES: readonly ["application/ld+json", "application/json", "text/plain", "multipart/form-data", "application/octet-stream", "application/json;charset=UTF-8"];
 /**
  * Resolves a schema reference to its actual schema object.
  * If the schema is already a concrete schema (not a $ref), returns it as-is.
@@ -23,6 +23,7 @@ export interface OperationInfo {
     operationId: string;
     summary?: string;
     description?: string;
+    deprecated?: boolean;
     parameters: OpenAPIV3.ParameterObject[];
     requestBody?: OpenAPIV3.RequestBodyObject;
     responses: OpenAPIV3.ResponsesObject;

package/dist/utils.js

@@ -16,6 +16,7 @@ exports.getTypeFromSchema = getTypeFromSchema;
 exports.CONTENT_TYPES = [
     "application/ld+json",
     "application/json",
+    "text/plain",
     "multipart/form-data",
     "application/octet-stream",
     "application/json;charset=UTF-8",
@@ -83,6 +84,7 @@ function collectOperations(spec) {
                 operationId: sanitizeTypeName(operation.operationId || path.replace(/\W+/g, "_")),
                 summary: operation.summary,
                 description: operation.description,
+                deprecated: operation.deprecated,
                 parameters: resolveParameters([...(pathItem.parameters || []), ...(operation.parameters || [])]),
                 requestBody: resolveRequestBody(operation.requestBody),
                 responses: operation.responses,
@@ -176,7 +178,7 @@ function getTypeFromSchema(schema) {
     if ("allOf" in schema && schema.allOf) {
         const types = schema.allOf.map((s) => getTypeFromSchema(s)).filter(Boolean);
         if (types.length === 0)
-            return "any";
+            return "unknown";
         const result = types.length === 1 ? types[0] : `(${types.join(" & ")})`;
         return `${result}${nullable}`;
     }
@@ -184,7 +186,7 @@ function getTypeFromSchema(schema) {
     if ("oneOf" in schema && schema.oneOf) {
         const types = schema.oneOf.map((s) => getTypeFromSchema(s)).filter(Boolean);
         if (types.length === 0)
-            return "any";
+            return "unknown";
         const result = types.length === 1 ? types[0] : `(${types.join(" | ")})`;
         return `${result}${nullable}`;
     }
@@ -192,7 +194,7 @@ function getTypeFromSchema(schema) {
     if ("anyOf" in schema && schema.anyOf) {
         const types = schema.anyOf.map((s) => getTypeFromSchema(s)).filter(Boolean);
         if (types.length === 0)
-            return "any";
+            return "unknown";
         const result = types.length === 1 ? types[0] : `(${types.join(" | ")})`;
         return `${result}${nullable}`;
     }
@@ -245,16 +247,16 @@ function getTypeFromSchema(schema) {
                 // Handle objects with additionalProperties
                 if (schema.additionalProperties) {
                     const valueType = typeof schema.additionalProperties === "boolean"
-                        ? "any"
+                        ? "unknown"
                         : getTypeFromSchema(schema.additionalProperties);
                     return `Record<string, ${valueType}>${nullable}`;
                 }
                 // Default object type when no properties specified
-                return `Record<string, any>${nullable}`;
+                return `Record<string, unknown>${nullable}`;
             default:
-                return `any${nullable}`;
+                return `unknown${nullable}`;
         }
     }
     // Fallback for schemas without a type
-    return "any";
+    return "unknown";
 }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "react-query-lightbase-codegen",
-	"version": "3.0.0",
+	"version": "3.1.0",
 	"license": "MIT",
 	"description": "Generate Axios API clients and React Query options from OpenAPI specifications",
 	"exports": "./dist/index.js",

package/src/generator/clientGenerator.ts

@@ -10,9 +10,11 @@ import {
 } from "../utils";
 
 function generateAxiosMethod(operation: OperationInfo, spec: OpenAPIV3.Document): string {
-	const { method, path, operationId, summary, description, parameters, requestBody, responses } = operation;
+	const { method, path, operationId, summary, description, deprecated, parameters, requestBody, responses } =
+		operation;
 	// Generate JSDoc
 	const jsDocLines = ["/**"];
+	if (deprecated) jsDocLines.push(" * @deprecated");
 	if (summary) jsDocLines.push(` * ${summary}`);
 	if (description) jsDocLines.push(` * ${description}`);
 
@@ -26,7 +28,9 @@ function generateAxiosMethod(operation: OperationInfo, spec: OpenAPIV3.Document)
 					? "query."
 					: param.in === "header"
 						? "headers."
-						: "";
+						: param.in === "cookie"
+							? "cookies."
+							: "";
 		jsDocLines.push(` * @param ${prefix}${param.name}${desc}`);
 	});
 
@@ -34,8 +38,10 @@ function generateAxiosMethod(operation: OperationInfo, spec: OpenAPIV3.Document)
 		jsDocLines.push(` * @param data - ${requestBody.description}`);
 	}
 
-	// Add return type description
-	const responseDetails = Object.entries(responses).find(([code]) => code.startsWith("2"));
+	// Add return type description - prefer 2xx responses, fall back to "default"
+	const responseDetails =
+		Object.entries(responses).find(([code]) => code.startsWith("2")) ||
+		Object.entries(responses).find(([code]) => code === "default");
 	if (responseDetails) {
 		const [code, response] = responseDetails;
 		const responseObj = response as OpenAPIV3.ResponseObject;
@@ -58,6 +64,7 @@ function generateAxiosMethod(operation: OperationInfo, spec: OpenAPIV3.Document)
 	const urlParams = parameters?.filter((p) => p.in === "path") || [];
 	const queryParams = parameters?.filter((p) => p.in === "query") || [];
 	const headerParams = parameters?.filter((p) => p.in === "header") || [];
+	const cookieParams = parameters?.filter((p) => p.in === "cookie") || [];
 
 	const isFormData = requestBody && "content" in requestBody && requestBody.content?.["multipart/form-data"];
 
@@ -82,11 +89,19 @@ function generateAxiosMethod(operation: OperationInfo, spec: OpenAPIV3.Document)
 	const namedType = pascalCase(operationId);
 
 	// Get response type from 2xx response
-
-	const responseType =
-		responseDetails?.[0] && "content" in responseDetails[1]
-			? `T.${`${namedType}Response${responseDetails[0]}`}`
-			: "unknown";
+	const responseType = (() => {
+		if (!responseDetails) return "unknown";
+		const [code, response] = responseDetails;
+		// If response has content, use the generated type
+		if ("content" in response && response.content) {
+			return `T.${namedType}Response${code}`;
+		}
+		// 204 (No Content) and 205 (Reset Content) should return void
+		if (code === "204" || code === "205") {
+			return "void";
+		}
+		return "unknown";
+	})();
 
 	const urlWithParams =
 		urlParams.length > 0 ? `\`${path.replace(/{(\w+)}/g, "${encodeURIComponent(data.$1)}")}\`` : `"${path}"`;
@@ -134,13 +149,18 @@ function generateAxiosMethod(operation: OperationInfo, spec: OpenAPIV3.Document)
 		headerParams.length > 0
 			? `axiosConfig.headers = { ...axiosConfig.headers, ${headerParams.map((p) => `["${p.name}"]: data["${p.name}"]`).join(", ")} };`
 			: "",
-		isFormData
-			? "axiosConfig.headers = { ...axiosConfig.headers, 'Content-Type': 'multipart/form-data' };"
+		cookieParams.length > 0
+			? `axiosConfig.headers = { ...axiosConfig.headers, Cookie: [${cookieParams.map((p) => `data["${p.name}"] != null ? \`${p.name}=\${data["${p.name}"]}\` : null`).join(", ")}].filter(Boolean).join("; ") };`
 			: "",
+		// Note: Don't set Content-Type for FormData - Axios will set it automatically with the correct boundary
 		requestBody
-			? `const res = await apiClient.${method}<${responseType}>(url, ${formDataSchema?.properties || requestBodySchema?.properties ? "bodyData" : "data"}, axiosConfig);`
-			: `const res = await apiClient.${method}<${responseType}>(url, axiosConfig);`,
-		"return res.data;",
+			? responseType === "void"
+				? `await apiClient.${method}<${responseType}>(url, ${formDataSchema?.properties || requestBodySchema?.properties ? "bodyData" : "data"}, axiosConfig);`
+				: `const res = await apiClient.${method}<${responseType}>(url, ${formDataSchema?.properties || requestBodySchema?.properties ? "bodyData" : "data"}, axiosConfig);`
+			: responseType === "void"
+				? `await apiClient.${method}<${responseType}>(url, axiosConfig);`
+				: `const res = await apiClient.${method}<${responseType}>(url, axiosConfig);`,
+		responseType !== "void" ? "return res.data;" : "",
 	]
 		.filter(Boolean)
 		.join("\n	");

package/src/generator/reactQueryGenerator.ts

@@ -9,7 +9,7 @@ import {
 } from "../utils";
 
 function generateQueryOptions(operation: OperationInfo, spec: OpenAPIV3.Document): string {
-	const { operationId, parameters, requestBody } = operation;
+	const { operationId, parameters, requestBody, deprecated } = operation;
 
 	const hasData = (parameters && parameters.length > 0) || operation.requestBody;
 
@@ -78,8 +78,10 @@ function generateQueryOptions(operation: OperationInfo, spec: OpenAPIV3.Document
 			: `hasDefinedProps(${paramsVariable}, ${requiredParams.join(", ")})`
 		: "true";
 
+	const deprecatedComment = deprecated ? "/** @deprecated */\n" : "";
+
 	return `
-export const ${namedQueryOptions} = ( 
+${deprecatedComment}export const ${namedQueryOptions} = (
   ${hasData ? `props: Partial<Parameters<typeof apiClient.${namedQuery}>[0]>` : `props?: Partial<Parameters<typeof apiClient.${namedQuery}>[0]>`}
 ) => {
   ${destructuringLine}
@@ -96,10 +98,8 @@ export function generateReactQuery(spec: OpenAPIV3.Document): string {
 
 	return `import { queryOptions, skipToken } from '@tanstack/react-query';
 	import * as apiClient from './${specTitle(spec)}.client';
-	// TEMPORARY: allows for backward compatibility imports
-	export * from './${specTitle(spec)}.client';
 
-const hasDefinedProps = <T extends { [P in K]?: any }, K extends PropertyKey>(
+const hasDefinedProps = <T extends { [P in K]?: unknown }, K extends PropertyKey>(
   obj: T,
   ...keys: K[]
 ): obj is T & { [P in K]-?: Exclude<T[P], undefined> } => {

package/src/generator/schemaGenerator.ts

@@ -109,11 +109,14 @@ export function generateTypeDefinitions(spec: OpenAPIV3.Document): string {
 					[]) as OpenAPIV3.ParameterObject[];
 				const headerParams = (parameters?.filter((p) => "in" in p && p.in === "header") ||
 					[]) as OpenAPIV3.ParameterObject[];
+				const cookieParams = (parameters?.filter((p) => "in" in p && p.in === "cookie") ||
+					[]) as OpenAPIV3.ParameterObject[];
 
-				// Add path, query, and header parameters
+				// Add path, query, header, and cookie parameters
 				urlParams.forEach((p) => dataProps.push(formatParamProperty(p, true))); // Path params always required
 				queryParams.forEach((p) => dataProps.push(formatParamProperty(p)));
 				headerParams.forEach((p) => dataProps.push(formatParamProperty(p)));
+				cookieParams.forEach((p) => dataProps.push(formatParamProperty(p)));
 
 				// Add request body type if it exists
 				const hasData = (parameters && parameters.length > 0) || requestBody;

package/src/utils.ts

@@ -6,6 +6,7 @@ import type { OpenAPIV3 } from "openapi-types";
 export const CONTENT_TYPES = [
 	"application/ld+json",
 	"application/json",
+	"text/plain",
 	"multipart/form-data",
 	"application/octet-stream",
 	"application/json;charset=UTF-8",
@@ -51,6 +52,7 @@ export interface OperationInfo {
 	operationId: string;
 	summary?: string;
 	description?: string;
+	deprecated?: boolean;
 	parameters: OpenAPIV3.ParameterObject[];
 	requestBody?: OpenAPIV3.RequestBodyObject;
 	responses: OpenAPIV3.ResponsesObject;
@@ -100,6 +102,7 @@ export function collectOperations(spec: OpenAPIV3.Document): OperationInfo[] {
 				operationId: sanitizeTypeName(operation.operationId || path.replace(/\W+/g, "_")),
 				summary: operation.summary,
 				description: operation.description,
+				deprecated: operation.deprecated,
 				parameters: resolveParameters([...(pathItem.parameters || []), ...(operation.parameters || [])]),
 				requestBody: resolveRequestBody(operation.requestBody),
 				responses: operation.responses,
@@ -202,7 +205,7 @@ export function getTypeFromSchema(
 	// Handle allOf (intersection types)
 	if ("allOf" in schema && schema.allOf) {
 		const types = schema.allOf.map((s) => getTypeFromSchema(s)).filter(Boolean) as string[];
-		if (types.length === 0) return "any";
+		if (types.length === 0) return "unknown";
 		const result = types.length === 1 ? types[0] : `(${types.join(" & ")})`;
 		return `${result}${nullable}`;
 	}
@@ -210,7 +213,7 @@ export function getTypeFromSchema(
 	// Handle oneOf (union types - exactly one)
 	if ("oneOf" in schema && schema.oneOf) {
 		const types = schema.oneOf.map((s) => getTypeFromSchema(s)).filter(Boolean) as string[];
-		if (types.length === 0) return "any";
+		if (types.length === 0) return "unknown";
 		const result = types.length === 1 ? types[0] : `(${types.join(" | ")})`;
 		return `${result}${nullable}`;
 	}
@@ -218,7 +221,7 @@ export function getTypeFromSchema(
 	// Handle anyOf (union types - one or more)
 	if ("anyOf" in schema && schema.anyOf) {
 		const types = schema.anyOf.map((s) => getTypeFromSchema(s)).filter(Boolean) as string[];
-		if (types.length === 0) return "any";
+		if (types.length === 0) return "unknown";
 		const result = types.length === 1 ? types[0] : `(${types.join(" | ")})`;
 		return `${result}${nullable}`;
 	}
@@ -282,19 +285,19 @@ export function getTypeFromSchema(
 				if (schema.additionalProperties) {
 					const valueType =
 						typeof schema.additionalProperties === "boolean"
-							? "any"
+							? "unknown"
 							: getTypeFromSchema(schema.additionalProperties);
 					return `Record<string, ${valueType}>${nullable}`;
 				}
 
 				// Default object type when no properties specified
-				return `Record<string, any>${nullable}`;
+				return `Record<string, unknown>${nullable}`;
 
 			default:
-				return `any${nullable}`;
+				return `unknown${nullable}`;
 		}
 	}
 
 	// Fallback for schemas without a type
-	return "any";
+	return "unknown";
 }