@bagelink/sdk 1.2.54 → 1.2.58

package/dist/index.cjs

@@ -258,19 +258,7 @@ function generateAxiosFunction(method, formattedPath, allParams, responseTypeStr
   axiosFunction += "}";
   return axiosFunction;
 }
-function generateFunctionForOperation(method, path, operation) {
-  if (!operation) return "";
-  const isFileUpload = operation.requestBody?.content["multipart/form-data"]?.schema?.$ref?.includes("Body_upload_files");
-  const parameters = generateFunctionParameters(
-    operation.parameters,
-    isFileUpload
-  );
-  const { requestBodyParam, requestBodyPayload } = generateRequestBody(
-    operation.requestBody
-  );
-  const allParams = isFileUpload ? "file: File, options?: UploadOptions & { dirPath?: string, tags?: string[] }" : combineAllParams(parameters, requestBodyParam);
-  const responseType = generateResponseType(operation.responses);
-  const responseTypeStr = responseType ? `: Promise<AxiosResponse<${responseType}>>` : "";
+function buildJSDocComment(operation, method, path) {
   let functionComment = "/**\n";
   if (operation.summary) {
     functionComment += ` * ${operation.summary}
@@ -288,43 +276,23 @@ function generateFunctionForOperation(method, path, operation) {
   functionComment += ` *
  * @endpoint ${method.toUpperCase()} ${path}
 `;
-  if (operation.parameters?.length) {
-    functionComment += " *\n";
-    operation.parameters.forEach((param) => {
-      const paramType = schemaToType(param.schema);
-      const paramName = toCamelCase(param.name);
-      const required = param.required ? "" : "?";
-      functionComment += ` * @param {${paramType}} ${paramName}${required}`;
-      if (param.description) {
-        functionComment += ` - ${param.description}`;
-      } else {
-        functionComment += ` - ${param.name} parameter`;
-      }
-      functionComment += "\n";
-    });
-  }
-  if (operation.requestBody && requestBodyParam) {
-    const bodyParamName = requestBodyParam.split(":")[0].trim();
-    const bodyParamType = requestBodyParam.split(":")[1]?.split("=")[0]?.trim() || "any";
-    functionComment += ` * @param {${bodyParamType}} ${bodyParamName}`;
-    if (operation.requestBody.description) {
-      functionComment += ` - ${operation.requestBody.description}`;
-    } else {
-      functionComment += ` - Request body`;
-    }
-    functionComment += "\n";
-  }
-  if (responseType) {
-    functionComment += ` * @returns {Promise<AxiosResponse<${responseType}>>} The API response
-`;
-    for (const [statusCode, response] of Object.entries(operation.responses)) {
-      if (statusCode.startsWith("2") && response.description) {
-        functionComment += ` * @response ${statusCode} - ${response.description}
-`;
-      }
-    }
-  }
   functionComment += " */\n";
+  return functionComment;
+}
+function generateFunctionForOperation(method, path, operation) {
+  if (!operation) return "";
+  const isFileUpload = operation.requestBody?.content["multipart/form-data"]?.schema?.$ref?.includes("Body_upload_files");
+  const parameters = generateFunctionParameters(
+    operation.parameters,
+    isFileUpload
+  );
+  const { requestBodyParam, requestBodyPayload } = generateRequestBody(
+    operation.requestBody
+  );
+  const allParams = isFileUpload ? "file: File, options?: UploadOptions & { dirPath?: string, tags?: string[] }" : combineAllParams(parameters, requestBodyParam);
+  const responseType = generateResponseType(operation.responses);
+  const responseTypeStr = responseType ? `: Promise<AxiosResponse<${responseType}>>` : "";
+  const functionComment = buildJSDocComment(operation, method, path);
   return functionComment + generateAxiosFunction(
     method,
     formatPathWithParams(path),

package/dist/index.mjs

@@ -252,19 +252,7 @@ function generateAxiosFunction(method, formattedPath, allParams, responseTypeStr
   axiosFunction += "}";
   return axiosFunction;
 }
-function generateFunctionForOperation(method, path, operation) {
-  if (!operation) return "";
-  const isFileUpload = operation.requestBody?.content["multipart/form-data"]?.schema?.$ref?.includes("Body_upload_files");
-  const parameters = generateFunctionParameters(
-    operation.parameters,
-    isFileUpload
-  );
-  const { requestBodyParam, requestBodyPayload } = generateRequestBody(
-    operation.requestBody
-  );
-  const allParams = isFileUpload ? "file: File, options?: UploadOptions & { dirPath?: string, tags?: string[] }" : combineAllParams(parameters, requestBodyParam);
-  const responseType = generateResponseType(operation.responses);
-  const responseTypeStr = responseType ? `: Promise<AxiosResponse<${responseType}>>` : "";
+function buildJSDocComment(operation, method, path) {
   let functionComment = "/**\n";
   if (operation.summary) {
     functionComment += ` * ${operation.summary}
@@ -282,43 +270,23 @@ function generateFunctionForOperation(method, path, operation) {
   functionComment += ` *
  * @endpoint ${method.toUpperCase()} ${path}
 `;
-  if (operation.parameters?.length) {
-    functionComment += " *\n";
-    operation.parameters.forEach((param) => {
-      const paramType = schemaToType(param.schema);
-      const paramName = toCamelCase(param.name);
-      const required = param.required ? "" : "?";
-      functionComment += ` * @param {${paramType}} ${paramName}${required}`;
-      if (param.description) {
-        functionComment += ` - ${param.description}`;
-      } else {
-        functionComment += ` - ${param.name} parameter`;
-      }
-      functionComment += "\n";
-    });
-  }
-  if (operation.requestBody && requestBodyParam) {
-    const bodyParamName = requestBodyParam.split(":")[0].trim();
-    const bodyParamType = requestBodyParam.split(":")[1]?.split("=")[0]?.trim() || "any";
-    functionComment += ` * @param {${bodyParamType}} ${bodyParamName}`;
-    if (operation.requestBody.description) {
-      functionComment += ` - ${operation.requestBody.description}`;
-    } else {
-      functionComment += ` - Request body`;
-    }
-    functionComment += "\n";
-  }
-  if (responseType) {
-    functionComment += ` * @returns {Promise<AxiosResponse<${responseType}>>} The API response
-`;
-    for (const [statusCode, response] of Object.entries(operation.responses)) {
-      if (statusCode.startsWith("2") && response.description) {
-        functionComment += ` * @response ${statusCode} - ${response.description}
-`;
-      }
-    }
-  }
   functionComment += " */\n";
+  return functionComment;
+}
+function generateFunctionForOperation(method, path, operation) {
+  if (!operation) return "";
+  const isFileUpload = operation.requestBody?.content["multipart/form-data"]?.schema?.$ref?.includes("Body_upload_files");
+  const parameters = generateFunctionParameters(
+    operation.parameters,
+    isFileUpload
+  );
+  const { requestBodyParam, requestBodyPayload } = generateRequestBody(
+    operation.requestBody
+  );
+  const allParams = isFileUpload ? "file: File, options?: UploadOptions & { dirPath?: string, tags?: string[] }" : combineAllParams(parameters, requestBodyParam);
+  const responseType = generateResponseType(operation.responses);
+  const responseTypeStr = responseType ? `: Promise<AxiosResponse<${responseType}>>` : "";
+  const functionComment = buildJSDocComment(operation, method, path);
   return functionComment + generateAxiosFunction(
     method,
     formatPathWithParams(path),

package/package.json

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

package/src/openAPITools/functionGenerator.ts

@@ -339,6 +339,40 @@ function generateAxiosFunction(
 	return axiosFunction
 }
 
+/**
+ * Builds a JSDoc comment for an OpenAPI operation
+ * @param operation - The OpenAPI operation object
+ * @param method - The HTTP method
+ * @param path - The API path
+ * @returns The JSDoc comment as a string
+ */
+function buildJSDocComment(operation: OperationObject, method: string, path: string) {
+	let functionComment = '/**\n'
+
+	// Add summary
+	if (operation.summary) {
+		functionComment += ` * ${operation.summary}\n`
+	}
+
+	// Add description if available
+	if (operation.description) {
+		// If there's already a summary, add a line break
+		if (operation.summary) functionComment += ` *\n`
+
+		// Split description into lines and add each line with proper JSDoc formatting
+		const descriptionLines = operation.description.split('\n')
+		descriptionLines.forEach((line: string) => {
+			functionComment += ` * ${line}\n`
+		})
+	}
+
+	// Add endpoint path and method information
+	functionComment += ` *\n * @endpoint ${method.toUpperCase()} ${path}\n`
+
+	functionComment += ' */\n'
+	return functionComment
+}
+
 /**
  * Generates a function for an OpenAPI operation
  * @param method - The HTTP method
@@ -377,78 +411,7 @@ function generateFunctionForOperation(
 		: ''
 
 	// Create JSDoc comment with OpenAPI documentation
-	let functionComment = '/**\n'
-
-	// Add summary
-	if (operation.summary) {
-		functionComment += ` * ${operation.summary}\n`
-	}
-
-	// Add description if available
-	if (operation.description) {
-		// If there's already a summary, add a line break
-		if (operation.summary) functionComment += ` *\n`
-
-		// Split description into lines and add each line with proper JSDoc formatting
-		const descriptionLines = operation.description.split('\n')
-		descriptionLines.forEach((line: string) => {
-			functionComment += ` * ${line}\n`
-		})
-	}
-
-	// Add endpoint path and method information
-	functionComment += ` *\n * @endpoint ${method.toUpperCase()} ${path}\n`
-
-	// Add parameter documentation if available
-	if (operation.parameters?.length) {
-		functionComment += ' *\n'
-		operation.parameters.forEach((param) => {
-			const paramType = schemaToType(param.schema)
-			const paramName = toCamelCase(param.name)
-			const required = param.required ? '' : '?'
-
-			functionComment += ` * @param {${paramType}} ${paramName}${required}`
-
-			// Add parameter description if available
-			if (param.description) {
-				functionComment += ` - ${param.description}`
-			} else {
-				functionComment += ` - ${param.name} parameter`
-			}
-
-			functionComment += '\n'
-		})
-	}
-
-	// Add requestBody documentation if available
-	if (operation.requestBody && requestBodyParam) {
-		const bodyParamName = requestBodyParam.split(':')[0].trim()
-		const bodyParamType = requestBodyParam.split(':')[1]?.split('=')[0]?.trim() || 'any'
-
-		functionComment += ` * @param {${bodyParamType}} ${bodyParamName}`
-
-		if (operation.requestBody.description) {
-			functionComment += ` - ${operation.requestBody.description}`
-		} else {
-			functionComment += ` - Request body`
-		}
-
-		functionComment += '\n'
-	}
-
-	// Add response documentation
-	if (responseType) {
-		functionComment += ` * @returns {Promise<AxiosResponse<${responseType}>>} The API response\n`
-
-		// Include any response descriptions for 2xx status codes
-		for (const [statusCode, response] of Object.entries(operation.responses)) {
-			if (statusCode.startsWith('2') && response.description) {
-				functionComment += ` * @response ${statusCode} - ${response.description}\n`
-			}
-		}
-	}
-
-	functionComment += ' */\n'
+	const functionComment = buildJSDocComment(operation, method, path)
 
 	return functionComment + generateAxiosFunction(
 		method,