@accelbyte/codegen 0.0.0-dev-20240828055251 → 0.0.0-dev-20240904015634

package/dist/accelbyte-codegen.mjs

@@ -104,12 +104,26 @@ var getPermissionType = (permission) => {
   return type || null;
 };
 var removeAdminPrefix = (name) => name.startsWith("Admin") && name !== "Admin" ? name.replace(/^Admin/, "") : name;
-function extractDescription(description, options) {
-  return description ? `
-  /**${options?.isDeprecated ? "\n   * @deprecated" : ""}
-   * ${description.replace(/\*\//g, "*\\/").replace(/\n/g, "\n   * ")} 
-   */` : "";
-}
+var escapeComment = (string) => string.replace(/\*\//g, "*\\/").replace(/\n/g, "\n   * ");
+var generateJsDoc = ({ indentation = 4, lines }) => {
+  const indent = " ".repeat(indentation);
+  const formattedLines = lines.filter(Boolean).map((line) => `${indent} * ${line}`).join("\n");
+  return `${indent}/**
+${formattedLines}
+${indent} */`;
+};
+var extractDescription = (description, options) => {
+  const { indentation = 2, responseClasses, other, isDeprecated } = options;
+  return description ? generateJsDoc({
+    lines: [
+      isDeprecated ? "@deprecated" : "",
+      escapeComment(description),
+      ...responseClasses.length > 1 ? [" ", "#### Response type:", ...responseClasses.map((val) => `- \`${val}\``)] : "",
+      ...options?.other ? other : ""
+    ],
+    indentation
+  }) : "";
+};
 
 // src/templates/template-class.ts
 var getImportableVarMap = () => ({
@@ -160,7 +174,7 @@ var getImportableVarMap2 = () => ({
 });
 var makeNewImportVarMap2 = () => ({
   "@accelbyte/sdk": ["AccelByteSDK", "SdkSetConfigParam", "ApiUtils", "Network"],
-  axios: ["AxiosResponse"]
+  axios: ["AxiosRequestConfig", "AxiosResponse"]
 });
 var templateApiClass = (className, body, importStatements, returnMethods) => {
   const $className = className.replace(/Api$/, "$");
@@ -177,7 +191,7 @@ export function ${className}(sdk: AccelByteSDK, args?: SdkSetConfigParam) {
   const sdkAssembly = sdk.assembly()
   
   const namespace = args?.coreConfig?.namespace ?? sdkAssembly.coreConfig.namespace
-  const requestConfig = ApiUtils.mergeAxiosConfigs(sdkAssembly.axiosConfig.request, args?.axiosConfig?.request)
+  const requestConfig = ApiUtils.mergeAxiosConfigs(sdkAssembly.axiosInstance.defaults as AxiosRequestConfig, args?.axiosConfig?.request)
   const interceptors = args?.axiosConfig?.interceptors ?? sdkAssembly.axiosConfig.interceptors ?? []
   const useSchemaValidation = sdkAssembly.coreConfig.useSchemaValidation
   const axiosInstance = Network.create(requestConfig)
@@ -437,25 +451,23 @@ var ParserUtils = class _ParserUtils {
     }
     return null;
   };
-  static get2xxResponse(methodEntity) {
+  static get2xxResponses(methodEntity) {
     const keys = Object.keys(methodEntity);
-    let responseClass = null;
-    keys.forEach((key) => {
-      if (String(key).startsWith("2")) {
-        const sch = methodEntity[key].schema;
-        const schV3 = methodEntity[key].content && methodEntity[key].content["application/json"].schema;
-        if (sch?.$ref) {
-          responseClass = _ParserUtils.parseRefType(sch.$ref);
-        } else if (sch?.type === "array" && sch.items?.$ref) {
-          responseClass = _ParserUtils.parseRefType(sch.items.$ref);
-          responseClass = `${responseClass}Array`;
-        } else if (schV3?.$ref) {
-          responseClass = _ParserUtils.parseRefType(schV3.$ref);
-        } else {
-        }
+    const responseClasses = [];
+    const statusCodes = keys.filter((key) => String(key).startsWith("2"));
+    statusCodes.forEach((key) => {
+      const sch = methodEntity[key].schema;
+      const schV3 = methodEntity[key].content && methodEntity[key].content["application/json"].schema;
+      if (sch?.$ref) {
+        responseClasses.push(_ParserUtils.parseRefType(sch.$ref));
+      } else if (sch?.type === "array" && sch.items?.$ref) {
+        responseClasses.push(`${_ParserUtils.parseRefType(sch.items.$ref)}Array`);
+      } else if (schV3?.$ref) {
+        responseClasses.push(_ParserUtils.parseRefType(schV3.$ref));
+      } else {
       }
     });
-    return responseClass;
+    return responseClasses;
   }
   static isFormUrlEncoded(httpMethod, contentTypes) {
     if (!contentTypes || contentTypes.length < 1) {
@@ -855,7 +867,7 @@ var templateApiMethod = ({
   path: path7,
   pathParams,
   bodyParams,
-  responseClass,
+  responseClasses,
   classGenName,
   methodParams,
   methodParamsNoTypes,
@@ -890,8 +902,8 @@ var templateApiMethod = ({
     }
   }
   const snippetShell = `curl ${snippetShellArgs.join(" \\\n    ")}`;
-  const descriptionText = extractDescription(description, { isDeprecated: deprecated });
-  const resolvedResponseClass = responseClass || "unknown";
+  const descriptionText = extractDescription(description, { isDeprecated: deprecated, responseClasses });
+  const resolvedResponseClass = responseClasses.length === 1 ? responseClasses?.[0] : "unknown";
   const responseType = resolvedResponseClass !== "unknown" ? `${resolvedResponseClass}` : "unknown";
   const methodImpl = `
   ${descriptionText}
@@ -923,7 +935,7 @@ var templateMethod = ({
   bodyParams,
   queryParams,
   isFormUrlEncoded,
-  responseClass,
+  responseClasses,
   deprecated
 }) => {
   let methodParams = "";
@@ -959,7 +971,7 @@ var templateMethod = ({
   const isPostPutPatch = ["post", "put", "patch"].includes(httpMethod);
   const isDelete = ["delete"].includes(httpMethod);
   let dataPayload = "{params}";
-  const descriptionText = extractDescription(description, { isDeprecated: deprecated });
+  const descriptionText = extractDescription(description, { isDeprecated: deprecated, responseClasses });
   let formPayloadString = "";
   if (isFormUrlEncoded) {
     formPayloadString = ``;
@@ -971,8 +983,8 @@ var templateMethod = ({
     dataPayload = dataType ? `{data, params}` : "{params}";
   }
   const isFileUpload = methodParams.indexOf("data: {file") > -1;
-  const resolvedResponseClass = responseClass || "unknown";
-  const resolvedResponseClassValidated = responseClass || "z.unknown()";
+  const resolvedResponseClass = responseClasses.length === 1 ? responseClasses?.[0] : "unknown";
+  const resolvedResponseClassValidated = responseClasses.length === 1 ? responseClasses?.[0] : "z.unknown()";
   methodParams = (queryParamsType ? `${methodParams} ${queryParamsType}` : methodParams).replace(/,\s*$/, "");
   methodParamsNoTypes = queryParamsType ? `${methodParamsNoTypes} queryParams` : methodParamsNoTypes;
   const isGuardInvoked = ["get", "post", "put", "patch", "delete"].includes(httpMethod);
@@ -1007,9 +1019,11 @@ var templateQueryMethod = ({
   httpMethod,
   path: path7,
   pathParams,
-  responseClass,
+  responseClasses,
   methodParams,
-  apiGenName
+  apiGenName,
+  description,
+  deprecated
 }) => {
   const isPostFetch = httpMethod === "post" && (POST_FETCH_INCLUDES_PATH.some((p) => path7.includes(p)) || path7.endsWith("/list"));
   const isFetch = classMethod.startsWith("fetch");
@@ -1034,20 +1048,27 @@ var templateQueryMethod = ({
       }
     }
   }
-  const resolvedResponseClass = responseClass || "unknown";
+  const resolvedResponseClass = responseClasses.length === 1 ? responseClasses?.[0] : "unknown";
   let _methodName = convertMethodNameToHook({ classMethod, apiGenName, isPostFetch, isFetch });
   const _responseType = resolvedResponseClass !== "unknown" ? `${resolvedResponseClass}` : "unknown";
   const _methodParams = methodParams && methodParams.length > 0 ? `& { ${methodParams} }` : "";
   const _methodParamsImpl = convertToMethodImplArgs(methodParams);
+  const queryKey = createQueryKey(apiGenName, classMethod);
+  const descriptionText = extractDescription(description, {
+    isDeprecated: deprecated,
+    responseClasses,
+    other: [" ", "#### Default Query Options", "The default options include:", "```", "{", `   queryKey: [${queryKey}, input]`, "}", "```"]
+  });
   const queryMethodImpl = `
 
+${descriptionText}
 export const ${_methodName} = (
     sdk: AccelByteSDK,
     input: SdkSetConfigParam ${_methodParams},
     options?: Omit<UseQueryOptions<${_responseType}, AxiosError<ApiError>>, 'queryKey'>,
     callback?: (data: AxiosResponse<${_responseType}>) => void
   ): UseQueryResult<${_responseType}, AxiosError<ApiError>> => { 
-  //
+  
   const queryFn = (
   sdk: AccelByteSDK, 
   input: Parameters<typeof ${_methodName}>[1]
@@ -1060,7 +1081,7 @@ export const ${_methodName} = (
   }
   
   return ${queryMethod}<${_responseType}, AxiosError<ApiError>>({
-    queryKey: [${createQueryKey(apiGenName, classMethod)}, input],
+    queryKey: [${queryKey}, input],
     queryFn: queryFn(sdk, input),
     ...options
   })
@@ -1069,12 +1090,13 @@ export const ${_methodName} = (
   `;
   const mutationMethodImpl = `
 
+  ${descriptionText}
 export const ${_methodName} = (
     sdk: AccelByteSDK,
     options?: Omit<UseMutationOptions<${_responseType}, AxiosError<ApiError>, SdkSetConfigParam ${_methodParams}>, 'mutationKey'>,
     callback?: (data: ${_responseType}) => void
   ): UseMutationResult<${_responseType}, AxiosError<ApiError>, SdkSetConfigParam ${_methodParams}> => { 
-  //
+  
   const mutationFn = async (input: SdkSetConfigParam ${_methodParams}) => {
       const response = 
             (await ${apiGenName}(sdk, { coreConfig: input.coreConfig, axiosConfig: input.axiosConfig }).
@@ -1084,7 +1106,7 @@ export const ${_methodName} = (
   }
   
   return useMutation({
-    mutationKey: [${createQueryKey(apiGenName, classMethod)}],
+    mutationKey: [${queryKey}],
     mutationFn,
     ...options
   })
@@ -1274,12 +1296,12 @@ var SwaggerReaderHelpers = class _SwaggerReaderHelpers {
           snippetMap[pathWithBase] = {};
         }
         const description = endpoint.description?.replace(/\s+/g, " ") || "";
-        const responseClass = ParserUtils.get2xxResponse(endpoint.responses);
+        const responseClasses = ParserUtils.get2xxResponses(endpoint.responses);
+        const responseClass = responseClasses.length > 1 ? null : responseClasses?.[0];
         const { className, classGenName } = ParserUtils.generateClassName(tag, isAdminEndpoint);
         tagToClassImportsRecord[className] = tagToClassImportsRecord[className] ? tagToClassImportsRecord[className] : {};
         if (responseClass) {
-          const importTypeClass = ParserUtils.parseRefType(responseClass);
-          tagToClassImportsRecord[className][importTypeClass] = `import { ${importTypeClass} } from '../../generated-definitions/${importTypeClass}.js'`;
+          tagToClassImportsRecord[className][responseClass] = `import { ${responseClass} } from '../../generated-definitions/${responseClass}.js'`;
         }
         if (responseClass && responseClass.endsWith("Array")) {
           arrayDefinitions.push(responseClass);
@@ -1307,7 +1329,7 @@ var SwaggerReaderHelpers = class _SwaggerReaderHelpers {
           bodyParams,
           queryParams,
           isFormUrlEncoded,
-          responseClass,
+          responseClasses,
           deprecated
         });
         tagToEndpointClassesRecord[tag] = (tagToEndpointClassesRecord[tag] || "") + methodImpl;
@@ -1317,9 +1339,11 @@ var SwaggerReaderHelpers = class _SwaggerReaderHelpers {
           httpMethod,
           path: pathWithBase,
           pathParams,
-          responseClass,
+          responseClasses,
           methodParams,
-          apiGenName
+          apiGenName,
+          deprecated,
+          description
         });
         tagToEndpointQueryRecord[tag] = (tagToEndpointQueryRecord[tag] || "") + queryMethodImpl;
         const { generatedMethodString, snippetApiArgs, snippetMethod, snippetShell } = templateApiMethod({
@@ -1329,7 +1353,7 @@ var SwaggerReaderHelpers = class _SwaggerReaderHelpers {
           path: pathWithBase,
           pathParams,
           bodyParams,
-          responseClass,
+          responseClasses,
           classGenName,
           methodParams,
           methodParamsNoTypes,