@accelbyte/codegen 1.0.0-beta.3 → 1.0.0-beta.6

package/dist/accelbyte-codegen.js

@@ -74,6 +74,9 @@ class CliParser {
   static isAdmin = () => {
     return CliParser.instance().argv.admin;
   };
+  static getSnippetOutputPath = () => {
+    return CliParser.instance().argv.snippetOutput;
+  };
 }
 
 const getImportableVarMap = () => ({
@@ -120,7 +123,18 @@ ${body}
 \`\`\`
 `.replace(/, \)/g, ")").trim();
 
-const SERVICE_PREFIXES = ["/iam/", "/gdpr/", "/sessionbrowser/", "/event/", "/admin/", "/public/"];
+const REMOVED_KEYWORDS = [
+  "/admin/",
+  "/public/",
+  "/v1/",
+  "/v2/",
+  "/v3/",
+  "/v4/",
+  "/v5/",
+  "/namespace/",
+  "/namespaces/",
+  "/{namespace}/"
+];
 class ParserUtils {
   static generateClassName = (tag) => {
     const className = _.upperFirst(_.camelCase(tag));
@@ -267,30 +281,34 @@ class ParserUtils {
     }
     return parameters.filter((parameter) => parameter.in === "path");
   }
-  static mappedMethod = (httpMethod, isForm) => {
-    if (httpMethod === "get") {
-      return "fetch";
-    } else if (httpMethod === "post" && isForm) {
-      return "post";
-    } else if (httpMethod === "post") {
-      return "create";
-    } else if (httpMethod === "put") {
-      return "update";
-    } else if (httpMethod === "patch") {
-      return "patch";
-    } else if (httpMethod === "delete") {
-      return "delete";
-    }
-  };
-  static generateHumanReadableMethod({ path: path2, httpMethod, isForm }) {
-    let path_ = path2.replace();
-    SERVICE_PREFIXES.forEach((prefix) => {
+  static generateNaturalLangMethod = ({ servicePrefix, path: path2, httpMethod, isForm, existingMethods }) => {
+    let path_ = path2;
+    path_ = path_.replace(`/${servicePrefix}/`, "/");
+    REMOVED_KEYWORDS.forEach((prefix) => {
       path_ = path_.replace(prefix, "/");
     });
     path_ = path_.substring(1);
+    const isPlural = httpMethod === "get" && !(path2.slice(-1) === "}");
+    if (!isPlural) {
+      path_ = replaceAll(path_, "ies/", "y/");
+      path_ = replaceAll(path_, "s/", "/");
+      if (path_.indexOf("status") < 0) {
+        path_ = path_.replace(/ies$/, "y");
+        path_ = path_.replace(/s$/, "");
+      }
+    }
     const arrLastWords = path_.split("}/");
     let lastWords = arrLastWords[arrLastWords.length - 1];
-    lastWords = lastWords.split("/{")[0];
+    const extractLastWord = (lastWords_) => {
+      let res = lastWords_;
+      res = res.split("/{")[0];
+      return res;
+    };
+    lastWords = extractLastWord(lastWords);
+    if (lastWords.indexOf("{") >= 0 && arrLastWords.length > 1) {
+      lastWords = arrLastWords[arrLastWords.length - 2];
+      lastWords = extractLastWord(lastWords);
+    }
     const listBeforeLastWords = [];
     let foundParam = false;
     const listByParams = [];
@@ -300,7 +318,7 @@ class ParserUtils {
         foundParam = true;
         let param = item.replace("{", "");
         param = param.replace("}", "");
-        param = "By" + _.upperFirst(param);
+        param = "Byword" + _.upperFirst(param);
         listByParams.push(param);
       } else if (!foundParam) {
         if (lastWords.indexOf(item) === -1) {
@@ -310,39 +328,12 @@ class ParserUtils {
         foundParam = false;
       }
     });
-    const genPath = _.upperFirst(lastWords) + "/" + listBeforeLastWords.join("/") + "/" + listByParams.join("/");
-    let res = _.camelCase(ParserUtils.mappedMethod(httpMethod, isForm) + genPath);
-    res = res.replace("ByNamespace", "");
-    return res;
-  }
-  static generateClassMethod({
-    path: path2,
-    endpoint,
-    httpMethod,
-    className
-  }) {
-    let replacedIdsPath = path2;
-    if (endpoint.parameters) {
-      for (const parameter of endpoint.parameters) {
-        if (parameter.in === "path") {
-          replacedIdsPath = replacedIdsPath.replace("{" + parameter.name + "}", "By" + ParserUtils.toTitleCaseWord(parameter.name));
-          replacedIdsPath = replacedIdsPath.replace("/iam", "");
-          replacedIdsPath = replacedIdsPath.replace("/odin-config", "");
-        }
-      }
-    }
-    let classMethod = httpMethod + "/" + replacedIdsPath;
-    classMethod = _.camelCase(classMethod);
-    classMethod = classMethod.replace("PublicNamespacesByNamespace", "Ns");
-    classMethod = classMethod.replace("AdminNamespacesByNamespace", "AdminNs");
-    const searchWord = "NamespacesByNamespace";
-    const nsExistInsideMethod = classMethod.indexOf(searchWord) > 0 && classMethod.indexOf(searchWord) + searchWord.length < classMethod.length;
-    const excludedClasses = ["Policies"];
-    if (nsExistInsideMethod && !excludedClasses.includes(className)) {
-      classMethod = classMethod.replace(searchWord, "");
-    }
-    return classMethod;
-  }
+    const genPath = _.upperFirst(lastWords) + "/" + listBeforeLastWords.join("/") + listByParams.reverse().join("/");
+    let generatedMethod = _.camelCase(mappedMethod(httpMethod, isForm) + genPath);
+    generatedMethod = replaceAll(generatedMethod, "Byword", "_By");
+    generatedMethod = resolveConflicts(path2, generatedMethod, existingMethods);
+    return generatedMethod;
+  };
   static filterBodyParams(parameters) {
     if (Array.isArray(parameters) && parameters.length > 0) {
       return parameters.filter((parameter) => parameter.in === "body" || parameter.in === "formData");
@@ -462,6 +453,70 @@ class ParserUtils {
 ${content}`;
   };
 }
+const replaceAll = (string, search, replace) => {
+  return string.split(search).join(replace);
+};
+const mappedMethod = (httpMethod, isForm) => {
+  if (httpMethod === "get") {
+    return "fetch";
+  } else if (httpMethod === "post" && isForm) {
+    return "post";
+  } else if (httpMethod === "post") {
+    return "create";
+  } else if (httpMethod === "put") {
+    return "update";
+  } else if (httpMethod === "patch") {
+    return "patch";
+  } else if (httpMethod === "delete") {
+    return "delete";
+  }
+};
+const resolveConflicts = (path2, generatedMethod, existingMethods) => {
+  try {
+    testConflict(path2, generatedMethod, existingMethods);
+  } catch (e) {
+    if (path2.indexOf("/namespaces/") >= 0) {
+      generatedMethod += "_ByNS";
+    }
+  }
+  try {
+    testConflict(path2, generatedMethod, existingMethods);
+  } catch (e) {
+    if (path2.indexOf("/v4/") >= 0) {
+      generatedMethod += "_v4";
+    }
+  }
+  try {
+    testConflict(path2, generatedMethod, existingMethods);
+  } catch (e) {
+    if (path2.indexOf("/v3/") >= 0) {
+      generatedMethod += "_v3";
+    }
+  }
+  try {
+    testConflict(path2, generatedMethod, existingMethods);
+  } catch (e) {
+    if (path2.indexOf("/v2/") >= 0) {
+      generatedMethod += "_v2";
+    }
+  }
+  try {
+    testConflict(path2, generatedMethod, existingMethods);
+  } catch (e) {
+    if (path2.indexOf("/admin/") >= 0) {
+      generatedMethod += "_admin";
+    }
+  }
+  testConflict(path2, generatedMethod, existingMethods);
+  return generatedMethod;
+};
+const testConflict = (path2, generatedMethod, existingMethods) => {
+  if (existingMethods[generatedMethod]) {
+    const conflictingMethod = { path: path2, generatedMethod };
+    throw Error(`Duplicate method conflict in ${JSON.stringify(conflictingMethod)},
+ existingMethods: ${JSON.stringify(existingMethods, null, 2)}`);
+  }
+};
 
 const Schema = zod.z.object({
   $ref: zod.z.string().nullish(),
@@ -904,21 +959,32 @@ class CodeGenerator {
   static getPatchedDir = () => path.join(CliParser.getSwaggersOutputPath(), "patched");
   static getGeneratedPublicFolder = () => `${CliParser.getOutputPath()}/generated-public`;
   static getGeneratedAdminFolder = () => `${CliParser.getOutputPath()}/generated-admin`;
-  static getGeneratedSnippetsFolder = () => `${CliParser.getOutputPath()}/../../../../apps/api-explorer-app/src/generated-snippets`;
+  static getGeneratedSnippetsFolder = () => `${CliParser.getSnippetOutputPath()}/generated-snippets`;
+  static getServicePrefix = (servicePaths) => servicePaths[servicePaths.length - 1].split("/")[1];
   static iterateApi = async (api) => {
     const apiBufferByTag = {};
     const dependenciesByTag = {};
     const classImports = {};
     let arrayDefinitions = [];
     const snippetMap = {};
-    for (const path2 in api.paths) {
+    const mapClassMethods = {};
+    const sortedPathsByLength = new Map(Object.entries(api.paths).sort((a, b) => {
+      if (a[0].length === b[0].length) {
+        return a[0].localeCompare(b[0]);
+      } else {
+        return a[0].length - b[0].length;
+      }
+    }));
+    const sortedKeys = Array.from(sortedPathsByLength.keys());
+    const servicePrefix = CodeGenerator.getServicePrefix(sortedKeys);
+    console.log("ServicePrefix", servicePrefix, ", Paths:", sortedKeys);
+    for (const [path2, operation] of sortedPathsByLength) {
       const isAdminEndpoint = path2.indexOf("/admin/") > -1;
       if (CliParser.isAdmin() && !isAdminEndpoint) {
         continue;
       } else if (!CliParser.isAdmin() && isAdminEndpoint) {
         continue;
       }
-      const operation = api.paths[path2];
       const httpMethods = Object.keys(operation);
       for (const httpMethod of httpMethods) {
         const endpoint = await Endpoint.parseAsync(operation[httpMethod]).catch((error) => {
@@ -928,55 +994,63 @@ class CodeGenerator {
         if (!endpoint.tags) {
           continue;
         }
+        if (endpoint.deprecated) {
+          continue;
+        }
         const [tag] = endpoint.tags;
+        mapClassMethods[tag] = mapClassMethods[tag] ? mapClassMethods[tag] : {};
+        const isForm = endpoint.consumes && endpoint.consumes[0] === "application/x-www-form-urlencoded";
+        const classMethod = ParserUtils.generateNaturalLangMethod({
+          servicePrefix,
+          path: path2,
+          httpMethod,
+          isForm,
+          existingMethods: mapClassMethods[tag]
+        });
+        mapClassMethods[tag][classMethod] = `${path2} ${httpMethod}`;
+        snippetMap[path2] = snippetMap[path2] ? snippetMap[path2] : {};
         const description = endpoint.description;
-        const isDeprecated = endpoint.deprecated;
         const responseClass = ParserUtils.get2xxResponse(endpoint.responses);
         const { className, classGenName } = ParserUtils.generateClassName(tag);
         classImports[className] = classImports[className] ? classImports[className] : {};
-        if (!isDeprecated) {
-          snippetMap[path2] = snippetMap[path2] ? snippetMap[path2] : {};
-          if (responseClass) {
-            const importTypeClass = ParserUtils.parseRefType(responseClass);
-            classImports[className][importTypeClass] = `import { ${importTypeClass} } from './definitions/${importTypeClass}'`;
-          }
-          if (responseClass && responseClass.endsWith("Array")) {
-            arrayDefinitions.push(responseClass);
-          }
-          const isFormUrlEncoded = ParserUtils.isFormUrlEncoded(httpMethod, endpoint.consumes);
-          const queryParams = ParserUtils.filterQueryParameters(endpoint.parameters);
-          const pathParams = ParserUtils.filterPathParams(endpoint.parameters);
-          let bodyParams = ParserUtils.filterBodyParams(endpoint.parameters);
-          const isForm = endpoint.consumes && endpoint.consumes[0] === "application/x-www-form-urlencoded";
-          const classMethod = ParserUtils.generateHumanReadableMethod({ path: path2, httpMethod, isForm });
-          if (endpoint.requestBody) {
-            bodyParams = [
-              {
-                name: "body",
-                in: "body",
-                schema: endpoint.requestBody.content["application/json"].schema
-              }
-            ];
-          }
-          const pathWithBase = `${api.basePath ?? ""}${path2}`;
-          const [generatedMethodString, importStatements, snippetString, snippetCurl] = templateMethod({
-            classMethod,
-            description,
-            httpMethod,
-            path: pathWithBase,
-            pathParams,
-            bodyParams,
-            queryParams,
-            isFormUrlEncoded,
-            responseClass
-          });
-          apiBufferByTag[tag] = (apiBufferByTag[tag] || "") + generatedMethodString;
-          dependenciesByTag[tag] = dependenciesByTag[tag] ? [.../* @__PURE__ */ new Set([...importStatements, ...dependenciesByTag[tag]])] : [...new Set(importStatements)];
-          snippetMap[path2][httpMethod] = {
-            web: `<span class='sn-blue'>import</span> axios from 'axios'<br/><span class='sn-blue'>import</span> { <span class='sn-purple'>${classGenName}</span> } <span class='sn-blue'>from</span> <span class='sn-green'>'@accelbyte/sdk'</span><br/><br/><span class='sn-blue'>const</span> axios = <span class='sn-blue'>axios</span>.create({<span class='sn-purple'>clientId</span>, <span class='sn-purple'>redirectURI</span>, <span class='sn-purple'>baseURL</span>})<br/><br/><span class='sn-blue'>new</span> ${classGenName}(<span class='sn-purple'>axios</span>, <span class='sn-purple'>namespace</span>).<span class='method-name'>${snippetString}</span>`,
-            shell: snippetCurl
-          };
+        if (responseClass) {
+          const importTypeClass = ParserUtils.parseRefType(responseClass);
+          classImports[className][importTypeClass] = `import { ${importTypeClass} } from './definitions/${importTypeClass}'`;
+        }
+        if (responseClass && responseClass.endsWith("Array")) {
+          arrayDefinitions.push(responseClass);
+        }
+        const queryParams = ParserUtils.filterQueryParameters(endpoint.parameters);
+        const pathWithBase = `${api.basePath ?? ""}${path2}`;
+        const isFormUrlEncoded = ParserUtils.isFormUrlEncoded(httpMethod, endpoint.consumes);
+        const pathParams = ParserUtils.filterPathParams(endpoint.parameters);
+        let bodyParams = ParserUtils.filterBodyParams(endpoint.parameters);
+        if (endpoint.requestBody) {
+          bodyParams = [
+            {
+              name: "body",
+              in: "body",
+              schema: endpoint.requestBody.content["application/json"].schema
+            }
+          ];
         }
+        const [generatedMethodString, importStatements, snippetString, snippetCurl] = templateMethod({
+          classMethod,
+          description,
+          httpMethod,
+          path: pathWithBase,
+          pathParams,
+          bodyParams,
+          queryParams,
+          isFormUrlEncoded,
+          responseClass
+        });
+        apiBufferByTag[tag] = (apiBufferByTag[tag] || "") + generatedMethodString;
+        dependenciesByTag[tag] = dependenciesByTag[tag] ? [.../* @__PURE__ */ new Set([...importStatements, ...dependenciesByTag[tag]])] : [...new Set(importStatements)];
+        snippetMap[path2][httpMethod] = {
+          web: `<span class='sn-blue'>import</span> axios from 'axios'<br/><span class='sn-blue'>import</span> { <span class='sn-purple'>${classGenName}</span> } <span class='sn-blue'>from</span> <span class='sn-green'>'@accelbyte/sdk'</span><br/><br/><span class='sn-blue'>const</span> axios = <span class='sn-blue'>axios</span>.create({<span class='sn-purple'>clientId</span>, <span class='sn-purple'>redirectURI</span>, <span class='sn-purple'>baseURL</span>})<br/><br/><span class='sn-blue'>new</span> ${classGenName}(<span class='sn-purple'>axios</span>, <span class='sn-purple'>namespace</span>).<span class='method-name'>${snippetString}</span>`,
+          shell: snippetCurl
+        };
       }
     }
     arrayDefinitions = [...new Set(arrayDefinitions)];
@@ -988,7 +1062,6 @@ class CodeGenerator {
     const parser = new SwaggerParser();
     const generatedFolder = CliParser.isAdmin() ? CodeGenerator.getGeneratedAdminFolder() : CodeGenerator.getGeneratedPublicFolder();
     const DIST_DIR = `${generatedFolder}/${serviceName}`;
-    const DIST_DOCS_DIR = path.join(DIST_DIR, "docs");
     const DIST_DEFINITION_DIR = path.join(DIST_DIR, "definitions");
     const swaggerFilePath = `${CliParser.getSwaggersOutputPath()}/${swaggerFile}`;
     const swaggerPatchedFilePath = `${CodeGenerator.getPatchedDir()}/${swaggerFile}`;
@@ -996,13 +1069,12 @@ class CodeGenerator {
     ParserUtils.applyPatchIfExists(swaggerFilePath, swaggerPatchFilePath, swaggerPatchedFilePath, CodeGenerator.getPatchedDir());
     const api = await parser.parse(swaggerPatchedFilePath);
     const indexImportsSet = /* @__PURE__ */ new Set();
-    console.log("\n----------\n API name: %s, Version: %s schemes %s", api, api.info.title, api.info.version, api.schemes);
+    console.log("----------\nGenerating API:", { title: api.info.title, version: api.info.version });
     ParserUtils.mkdirIfNotExist(DIST_DIR);
-    ParserUtils.mkdirIfNotExist(DIST_DOCS_DIR);
     ParserUtils.mkdirIfNotExist(DIST_DEFINITION_DIR);
     ParserUtils.writeVersionFile(DIST_DIR, "Version.ts", serviceName, api.info, BUILD_DATE);
     const { apiBufferByTag, dependenciesByTag, classImports, arrayDefinitions, snippetMap } = await CodeGenerator.iterateApi(api);
-    if (!CliParser.isAdmin()) {
+    if (CliParser.getSnippetOutputPath()) {
       ParserUtils.writeSnippetFile(CodeGenerator.getGeneratedSnippetsFolder(), api.info.title, JSON.stringify(snippetMap, null, 2));
     }
     const targetSrcFolder = `${CliParser.getOutputPath()}/`;
@@ -1041,7 +1113,7 @@ class CodeGenerator {
       ParserUtils.writeDefinitionFile(DIST_DEFINITION_DIR, arrayClass, buffer);
       indexImportsSet.add(ParserUtils.getRelativePathToWebSdkSrcFolder(path.join(DIST_DEFINITION_DIR, arrayClass), targetSrcFolder));
     }
-    console.log("\n----------\nCOMPLETED.\n----------\n\n");
+    console.log("\nCOMPLETED\n----------\n\n");
     return indexImportsSet;
   };
 }
@@ -1068,7 +1140,7 @@ class SwaggerDownloader {
       });
     });
     request.on("error", (err) => {
-      console.log(`SwaggerDownloader dl failed for "${targetFileName}" and "${url}"`, err);
+      console.log(`SwaggerDownloader failed for "${targetFileName}" and "${url}"`, err);
     });
   };
   static main = () => {