@bagelink/sdk 1.5.32 → 1.6.4

package/dist/index.cjs

@@ -317,7 +317,7 @@ function generateResponseType(responses) {
   for (const [statusCode, response] of Object.entries(responses)) {
     if (statusCode.startsWith("2")) {
       const responseType = getResponseType(response);
-      if (responseType && "any" !== responseType) {
+      if (responseType && responseType !== "any") {
         types.push(responseType);
       }
     }
@@ -337,7 +337,7 @@ function formatPathWithParams(path) {
 }
 function generateRequestBody(requestBody) {
   const content = dereference(requestBody)?.content;
-  if (!content || 0 === Object.keys(content).length) {
+  if (!content || Object.keys(content).length === 0) {
     return { requestBodyParam: "", requestBodyPayload: "" };
   }
   if (content["multipart/form-data"]) {
@@ -390,7 +390,7 @@ function generateFunctionParameters(params, isFileUpload = false) {
     collectTypeForImportStatement(paramType);
     const paramName = param.name;
     const varName = toCamelCaseSafe(param.name);
-    if ("path" === param.in || "query" === param.in || "header" === param.in) {
+    if (param.in === "path" || param.in === "query" || param.in === "header") {
       functionParams.push(
         formatVarType({
           varName,
@@ -400,7 +400,7 @@ function generateFunctionParameters(params, isFileUpload = false) {
         })
       );
     }
-    if ("query" === param.in || "header" === param.in) {
+    if (param.in === "query" || param.in === "header") {
       queryParams.push(
         paramName === varName ? paramName : `'${paramName}': ${varName}`
       );
@@ -430,7 +430,7 @@ function combineAllParams(parameters, requestBodyParam) {
   if (requestBodyParam) {
     allParamsArray.push(requestBodyParam.trim());
   }
-  if (0 === allParamsArray.length) {
+  if (allParamsArray.length === 0) {
     return "";
   }
   const parsedParams = allParamsArray.filter(Boolean).map(parseParameter);
@@ -441,12 +441,12 @@ function combineAllParams(parameters, requestBodyParam) {
   return `{ ${destructuredNames} }: { ${typeDefinition} } = {}`;
 }
 function generateAxiosFunction(method, formattedPath, allParams, responseTypeStr, parameters, requestBodyPayload) {
-  if ("undefined" === allParams) {
+  if (allParams === "undefined") {
     allParams = "";
   }
   let axiosFunction = `async (${allParams})${responseTypeStr} => {`;
   const paramStr = parameters.config?.params ? `params: {${parameters.config.params}}` : "";
-  if ("formData" === requestBodyPayload) {
+  if (requestBodyPayload === "formData") {
     if (allParams.includes("file: File")) {
       axiosFunction += `
         const formData = new FormData()
@@ -496,6 +496,21 @@ function generateFunctionForOperation(method, path, operation) {
   if (!operation) {
     return "";
   }
+  const methodLower = method.toLowerCase();
+  if (["get", "delete"].includes(methodLower) && operation.requestBody) {
+    const requestBodyDeref = dereference(operation.requestBody);
+    const content = requestBodyDeref?.content;
+    if (content && Object.keys(content).length > 0) {
+      const hasSchema = Object.values(content).some(
+        (mediaType) => mediaType && "schema" in mediaType && mediaType.schema !== void 0 && mediaType.schema !== null
+      );
+      if (hasSchema) {
+        throw new Error(
+          `Invalid OpenAPI spec: ${method.toUpperCase()} request at path "${path}" has a request body. GET and DELETE requests should not have request bodies according to HTTP standards. Please move the body parameters to query parameters or use a different HTTP method.`
+        );
+      }
+    }
+  }
   const multiPartSchema = dereference(operation.requestBody)?.content?.["multipart/form-data"]?.schema;
   const isFileUpload = isReferenceObject(multiPartSchema) && multiPartSchema?.$ref?.includes("Body_upload_files");
   const parameters = generateFunctionParameters(
@@ -524,7 +539,7 @@ function hasConflict(path, method) {
     (p) => p.path === cleanPathName && p.method === method
   );
   pathOperations.push({ path: cleanPathName, method });
-  return 0 < matchingPaths.length;
+  return matchingPaths.length > 0;
 }
 function generateRandomString() {
   return Math.random().toString(36).slice(7);
@@ -570,13 +585,21 @@ function generateFunctions(paths, baseUrl) {
         return acc;
       }
       const methods = Object.keys(operation);
-      if (index === array.length - 1 && 1 === methods.length && 1 === allPathsClean.filter((p) => p === cleanPath(path)).length) {
+      const currentPathClean = cleanPath(path);
+      const currentPathPrefix = splitPath.slice(0, index + 1).join("/");
+      const prefixWithSlash = `${currentPathPrefix}/`;
+      const hasChildPaths = allPathsClean.some(
+        (otherPath) => otherPath !== currentPathClean && otherPath.startsWith(prefixWithSlash)
+      );
+      if (index === array.length - 1 && methods.length === 1 && allPathsClean.filter((p) => p === currentPathClean).length === 1 && !hasChildPaths) {
         const method = methods[0];
         const opp = operation[method];
         acc[objFuncKey] = createFunctionPlaceholder(path, method, opp);
       } else if (index === array.length - 1) {
-        acc[objFuncKey] = handlePathSegment(path, operation, acc[objFuncKey]);
-      } else if (!acc[objFuncKey] || "object" !== typeof acc[objFuncKey]) {
+        const existingValue = acc[objFuncKey];
+        const existingObj = existingValue && typeof existingValue === "object" && !Array.isArray(existingValue) ? existingValue : {};
+        acc[objFuncKey] = handlePathSegment(path, operation, existingObj);
+      } else if (!acc[objFuncKey] || typeof acc[objFuncKey] !== "object") {
         acc[objFuncKey] = {};
       }
       return acc[objFuncKey];

package/dist/index.mjs

@@ -311,7 +311,7 @@ function generateResponseType(responses) {
   for (const [statusCode, response] of Object.entries(responses)) {
     if (statusCode.startsWith("2")) {
       const responseType = getResponseType(response);
-      if (responseType && "any" !== responseType) {
+      if (responseType && responseType !== "any") {
         types.push(responseType);
       }
     }
@@ -331,7 +331,7 @@ function formatPathWithParams(path) {
 }
 function generateRequestBody(requestBody) {
   const content = dereference(requestBody)?.content;
-  if (!content || 0 === Object.keys(content).length) {
+  if (!content || Object.keys(content).length === 0) {
     return { requestBodyParam: "", requestBodyPayload: "" };
   }
   if (content["multipart/form-data"]) {
@@ -384,7 +384,7 @@ function generateFunctionParameters(params, isFileUpload = false) {
     collectTypeForImportStatement(paramType);
     const paramName = param.name;
     const varName = toCamelCaseSafe(param.name);
-    if ("path" === param.in || "query" === param.in || "header" === param.in) {
+    if (param.in === "path" || param.in === "query" || param.in === "header") {
       functionParams.push(
         formatVarType({
           varName,
@@ -394,7 +394,7 @@ function generateFunctionParameters(params, isFileUpload = false) {
         })
       );
     }
-    if ("query" === param.in || "header" === param.in) {
+    if (param.in === "query" || param.in === "header") {
       queryParams.push(
         paramName === varName ? paramName : `'${paramName}': ${varName}`
       );
@@ -424,7 +424,7 @@ function combineAllParams(parameters, requestBodyParam) {
   if (requestBodyParam) {
     allParamsArray.push(requestBodyParam.trim());
   }
-  if (0 === allParamsArray.length) {
+  if (allParamsArray.length === 0) {
     return "";
   }
   const parsedParams = allParamsArray.filter(Boolean).map(parseParameter);
@@ -435,12 +435,12 @@ function combineAllParams(parameters, requestBodyParam) {
   return `{ ${destructuredNames} }: { ${typeDefinition} } = {}`;
 }
 function generateAxiosFunction(method, formattedPath, allParams, responseTypeStr, parameters, requestBodyPayload) {
-  if ("undefined" === allParams) {
+  if (allParams === "undefined") {
     allParams = "";
   }
   let axiosFunction = `async (${allParams})${responseTypeStr} => {`;
   const paramStr = parameters.config?.params ? `params: {${parameters.config.params}}` : "";
-  if ("formData" === requestBodyPayload) {
+  if (requestBodyPayload === "formData") {
     if (allParams.includes("file: File")) {
       axiosFunction += `
         const formData = new FormData()
@@ -490,6 +490,21 @@ function generateFunctionForOperation(method, path, operation) {
   if (!operation) {
     return "";
   }
+  const methodLower = method.toLowerCase();
+  if (["get", "delete"].includes(methodLower) && operation.requestBody) {
+    const requestBodyDeref = dereference(operation.requestBody);
+    const content = requestBodyDeref?.content;
+    if (content && Object.keys(content).length > 0) {
+      const hasSchema = Object.values(content).some(
+        (mediaType) => mediaType && "schema" in mediaType && mediaType.schema !== void 0 && mediaType.schema !== null
+      );
+      if (hasSchema) {
+        throw new Error(
+          `Invalid OpenAPI spec: ${method.toUpperCase()} request at path "${path}" has a request body. GET and DELETE requests should not have request bodies according to HTTP standards. Please move the body parameters to query parameters or use a different HTTP method.`
+        );
+      }
+    }
+  }
   const multiPartSchema = dereference(operation.requestBody)?.content?.["multipart/form-data"]?.schema;
   const isFileUpload = isReferenceObject(multiPartSchema) && multiPartSchema?.$ref?.includes("Body_upload_files");
   const parameters = generateFunctionParameters(
@@ -518,7 +533,7 @@ function hasConflict(path, method) {
     (p) => p.path === cleanPathName && p.method === method
   );
   pathOperations.push({ path: cleanPathName, method });
-  return 0 < matchingPaths.length;
+  return matchingPaths.length > 0;
 }
 function generateRandomString() {
   return Math.random().toString(36).slice(7);
@@ -564,13 +579,21 @@ function generateFunctions(paths, baseUrl) {
         return acc;
       }
       const methods = Object.keys(operation);
-      if (index === array.length - 1 && 1 === methods.length && 1 === allPathsClean.filter((p) => p === cleanPath(path)).length) {
+      const currentPathClean = cleanPath(path);
+      const currentPathPrefix = splitPath.slice(0, index + 1).join("/");
+      const prefixWithSlash = `${currentPathPrefix}/`;
+      const hasChildPaths = allPathsClean.some(
+        (otherPath) => otherPath !== currentPathClean && otherPath.startsWith(prefixWithSlash)
+      );
+      if (index === array.length - 1 && methods.length === 1 && allPathsClean.filter((p) => p === currentPathClean).length === 1 && !hasChildPaths) {
         const method = methods[0];
         const opp = operation[method];
         acc[objFuncKey] = createFunctionPlaceholder(path, method, opp);
       } else if (index === array.length - 1) {
-        acc[objFuncKey] = handlePathSegment(path, operation, acc[objFuncKey]);
-      } else if (!acc[objFuncKey] || "object" !== typeof acc[objFuncKey]) {
+        const existingValue = acc[objFuncKey];
+        const existingObj = existingValue && typeof existingValue === "object" && !Array.isArray(existingValue) ? existingValue : {};
+        acc[objFuncKey] = handlePathSegment(path, operation, existingObj);
+      } else if (!acc[objFuncKey] || typeof acc[objFuncKey] !== "object") {
         acc[objFuncKey] = {};
       }
       return acc[objFuncKey];

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@bagelink/sdk",
   "type": "module",
-  "version": "1.5.32",
+  "version": "1.6.4",
   "description": "Bagel core sdk packages",
   "author": {
     "name": "Neveh Allon",

package/src/openAPITools/functionGenerator.ts

@@ -75,8 +75,8 @@ function collectTypeForImportStatement(typeName: string): void {
 	const isPrimitive = primitiveTypes.includes(typeName)
 	typeName = formatType(typeName)
 
-	if (!typeName || isPrimitive) {return}
-	if (!allTypes.includes(typeName)) {allTypes.push(typeName)}
+	if (!typeName || isPrimitive) { return }
+	if (!allTypes.includes(typeName)) { allTypes.push(typeName) }
 }
 
 /**
@@ -100,7 +100,7 @@ function getResponseType(response: OpenAPIResponse | ReferenceObject): string |
 		return undefined // TODO: handle references properly
 	}
 	const mediaTypeObject = response.content?.['application/json']
-	if (!mediaTypeObject?.schema) {return undefined}
+	if (!mediaTypeObject?.schema) { return undefined }
 	return schemaToTypeWithCollection(mediaTypeObject.schema)
 }
 
@@ -110,13 +110,13 @@ function getResponseType(response: OpenAPIResponse | ReferenceObject): string |
  * @returns The TypeScript response type string
  */
 function generateResponseType(responses?: OpenAPIResponses): string {
-	if (!responses) {return ''}
+	if (!responses) { return '' }
 
 	const types: string[] = []
 	for (const [statusCode, response] of Object.entries(responses)) {
 		if (statusCode.startsWith('2')) {
 			const responseType = getResponseType(response)
-			if (responseType && 'any' !== responseType) {
+			if (responseType && responseType !== 'any') {
 				types.push(responseType)
 			}
 		}
@@ -142,7 +142,7 @@ function getParamsFromPath(path: string): string[] | undefined {
  */
 function formatPathWithParams(path: string): string {
 	const params = getParamsFromPath(path)
-	if (!params) {return `'${path}'`}
+	if (!params) { return `'${path}'` }
 
 	return `\`${path.replace(/\{([^}]+)\}/g, (_, paramName) => `\${${toCamelCase(paramName)}}`)}\``
 }
@@ -160,7 +160,7 @@ function generateRequestBody(requestBody?: OpenAPIOperation['requestBody']): {
 	// 	return { requestBodyParam: '', requestBodyPayload: '' }
 
 	const content = dereference(requestBody)?.content
-	if (!content || 0 === Object.keys(content).length) {
+	if (!content || Object.keys(content).length === 0) {
 		return { requestBodyParam: '', requestBodyPayload: '' }
 	}
 
@@ -217,7 +217,7 @@ function generateFunctionParameters(
 	params?: OpenAPIOperation['parameters'],
 	isFileUpload = false
 ): { params?: string, config?: { params?: string } } {
-	if (!params?.length) {return {}}
+	if (!params?.length) { return {} }
 
 	// Special handling for file uploads
 	if (isFileUpload) {
@@ -241,7 +241,7 @@ function generateFunctionParameters(
 		const paramName = param.name
 		const varName = toCamelCaseSafe(param.name)
 
-		if ('path' === param.in || 'query' === param.in || 'header' === param.in) {
+		if (param.in === 'path' || param.in === 'query' || param.in === 'header') {
 			functionParams.push(
 				formatVarType({
 					varName,
@@ -252,7 +252,7 @@ function generateFunctionParameters(
 			)
 		}
 
-		if ('query' === param.in || 'header' === param.in) {
+		if (param.in === 'query' || param.in === 'header') {
 			queryParams.push(
 				paramName === varName ? paramName : `'${paramName}': ${varName}`
 			)
@@ -316,7 +316,7 @@ function combineAllParams(
 		allParamsArray.push(requestBodyParam.trim())
 	}
 
-	if (0 === allParamsArray.length) {
+	if (allParamsArray.length === 0) {
 		return ''
 	}
 
@@ -357,14 +357,14 @@ function generateAxiosFunction(
 	parameters: { config?: { params?: string } },
 	requestBodyPayload: string
 ): string {
-	if ('undefined' === allParams) {allParams = ''}
+	if (allParams === 'undefined') { allParams = '' }
 
 	let axiosFunction = `async (${allParams})${responseTypeStr} => {`
 	const paramStr = parameters.config?.params
 		? `params: {${parameters.config.params}}`
 		: ''
 
-	if ('formData' === requestBodyPayload) {
+	if (requestBodyPayload === 'formData') {
 		// Check if this is a file upload with specific file parameter
 		if (allParams.includes('file: File')) {
 			axiosFunction += `
@@ -384,8 +384,6 @@ function generateAxiosFunction(
 	} else {
 		const configParams = paramStr ? `, { ${paramStr} }` : ''
 		const bodyVar = requestBodyPayload || '{}'
-
-		// Handle different HTTP methods appropriately
 		axiosFunction += `return axios.${method}(${formattedPath}${
 			['get', 'delete'].includes(method)
 				? configParams
@@ -415,7 +413,7 @@ function buildJSDocComment(operation: OpenAPIOperation, method: string, path: st
 	// Add description if available
 	if (operation.description) {
 		// If there's already a summary, add a line break
-		if (operation.summary) {functionComment += ` *\n`}
+		if (operation.summary) { functionComment += ` *\n` }
 
 		// Split description into lines and add each line with proper JSDoc formatting
 		const descriptionLines = operation.description.split('\n')
@@ -443,7 +441,28 @@ function generateFunctionForOperation(
 	path: string,
 	operation: OpenAPIOperation
 ): string {
-	if (!operation) {return ''}
+	if (!operation) { return '' }
+
+	// Validate: GET and DELETE requests should not have request bodies
+	const methodLower = method.toLowerCase()
+	if (['get', 'delete'].includes(methodLower) && operation.requestBody) {
+		const requestBodyDeref = dereference(operation.requestBody)
+		const content = requestBodyDeref?.content
+		// Check if request body has actual content with schemas
+		if (content && Object.keys(content).length > 0) {
+			// Check if any content type has a schema (indicating actual body data)
+			const hasSchema = Object.values(content).some(
+				mediaType => mediaType && 'schema' in mediaType && mediaType.schema !== undefined && mediaType.schema !== null
+			)
+			if (hasSchema) {
+				throw new Error(
+					`Invalid OpenAPI spec: ${method.toUpperCase()} request at path "${path}" has a request body. `
+					+ `GET and DELETE requests should not have request bodies according to HTTP standards. `
+					+ `Please move the body parameters to query parameters or use a different HTTP method.`
+				)
+			}
+		}
+	}
 
 	// Check if this is a file upload
 	const multiPartSchema = dereference(operation.requestBody)?.content?.[
@@ -500,7 +519,7 @@ function hasConflict(path: string, method: string): boolean {
 	)
 
 	pathOperations.push({ path: cleanPathName, method })
-	return 0 < matchingPaths.length
+	return matchingPaths.length > 0
 }
 
 /**
@@ -585,24 +604,40 @@ export function generateFunctions(paths: OpenAPIPaths, baseUrl: string): string
 
 		splitPath.reduce((acc, key: string, index: number, array: string[]) => {
 			const objFuncKey = toCamelCaseSafe(key)
-			if (!objFuncKey) {return acc}
+			if (!objFuncKey) { return acc }
 
 			const methods = Object.keys(operation) as Array<keyof OpenAPIPath>
+			const currentPathClean = cleanPath(path)
+			const currentPathPrefix = splitPath.slice(0, index + 1).join('/')
+
+			// Check if any other path has this path as a prefix (indicating child paths exist)
+			const prefixWithSlash = `${currentPathPrefix}/`
+			const hasChildPaths = allPathsClean.some(
+				otherPath => otherPath !== currentPathClean && otherPath.startsWith(prefixWithSlash)
+			)
 
 			if (
 				index === array.length - 1
-				&& 1 === methods.length
-				&& 1 === allPathsClean.filter(p => p === cleanPath(path)).length
+				&& methods.length === 1
+				&& allPathsClean.filter(p => p === currentPathClean).length === 1
+				&& !hasChildPaths
 			) {
-				// Single method endpoint with unique path
+				// Single method endpoint with unique path and no child paths
 				const method = methods[0]
 				const opp = operation[method!] as OpenAPIOperation
 				acc[objFuncKey] = createFunctionPlaceholder(path, method!, opp)
 			} else if (index === array.length - 1) {
-				// Multiple methods endpoint or path with conflicts
-				acc[objFuncKey] = handlePathSegment(path, operation, acc[objFuncKey])
-			} else if (!acc[objFuncKey] || 'object' !== typeof acc[objFuncKey]) {
-				// Intermediate path segment
+				// Multiple methods endpoint or path with conflicts or has child paths
+				// Ensure we have an object to merge with (handlePathSegment expects an object)
+				const existingValue = acc[objFuncKey]
+				const existingObj = (existingValue && typeof existingValue === 'object' && !Array.isArray(existingValue))
+					? existingValue
+					: {}
+				acc[objFuncKey] = handlePathSegment(path, operation, existingObj)
+			} else if (!acc[objFuncKey] || typeof acc[objFuncKey] !== 'object') {
+				// Intermediate path segment - ensure it's an object
+				// If it's already a function, we need to preserve it but this shouldn't happen
+				// if hasChildPaths check works correctly
 				acc[objFuncKey] = {}
 			}