@accelbyte/codegen 1.0.0-alpha.1 → 1.0.0-alpha.3

package/README.md

@@ -2,7 +2,39 @@
 
 Odin Code Generator is a utility tool to generate network calls in Typescript for each of the endpoints on Swagger's JSON document found in Justice backend services
 
-To generate/regenerate the network call functions, run `yarn build:codegen` from the root directory (it won't work if it were inside `packages/od-codegen`). That command will check for every JSON inside the directory `packages/od-codegen/src/swaggers`. And will produce/update the files in `/accelbyte-web-sdk/packages/sdk/src/generated`
+## CLI
+This codegen build a CLI called `accelbyte-codegen` that will be used to generate code from given config.
+
+```
+Commands:  
+accelbyte-codegen download-swaggers  Download swaggers JSON files  
+accelbyte-codegen generate-code      Generate code based on downloaded swagger
+files
+
+Options:
+--version           Show version number                                         [boolean]  
+--config            Config file providing backend services URL.                 [string] [required]  
+--swaggersOutput    Output path for downloaded swaggers JSON files.             [string] [required]  
+--output            Output path for generated code. Required for generate-code  [string]  
+--admin             Only generate /admin endpoints.                             [boolean] [default: false]  
+--help              Show help                                                   [boolean]  
+```
+
+### Config file
+Provide swaggers url you wish to generate, store it in .json format file.
+
+```
+[
+  ["iam", "Iam", "iam.json", "https://example.com/iam/apidocs/api.json"]
+]
+```
+
+## How to Generate
+1. Provide config
+2. Download swagger files  
+   ``accelbyte-codegen download-swaggers --config ./config.json --swaggersOutput ./swaggers``
+3. Generate code from swagger files  
+   ``accelbyte-codegen generate-code --config ./config.json --swaggersOutput ./swaggers --output ./sdk``
 
 ## JSON Patch
 Inside the directory `packages/od-codegen/src/swaggers`, there are also JSON Patch that will patch the Swagger document. The patches will adjust the endpoints so that it will produce the proper functions to match the actual backend service. 
@@ -135,9 +167,3 @@ patch:
   ]
 }
 ```
-
-# How to generate
-So the flow to generate/regenerate Swagger JSON, here's what needs to be done.
-1. Download the JSON files and store it `packages/od-codegen/src/swaggers`
-2. Run `yarn build:codegen`
-3. See that `packages/od-web-sdk/src/generated` is changed

package/dist/accelbyte-codegen.js

@@ -22,12 +22,14 @@ function _interopNamespace(e) {
         var d = Object.getOwnPropertyDescriptor(e, k);
         Object.defineProperty(n, k, d.get ? d : {
           enumerable: true,
-          get: function () { return e[k]; }
+          get: function () {
+            return e[k];
+          }
         });
       }
     });
   }
-  n["default"] = e;
+  n['default'] = e;
   return Object.freeze(n);
 }
 
@@ -64,7 +66,7 @@ class CliParser {
     const configPath = CliParser.getConfigPath();
     if (!configPath)
       throw new Error("Missing config file");
-    const config = JSON.parse(fs__default["default"].readFileSync(configPath, "utf8"));
+    const config = JSON.parse(fs__default['default'].readFileSync(configPath, "utf8"));
     if (!SwaggersConfig.safeParse(config).success) {
       throw new Error("Wrong config file format");
     }
@@ -189,7 +191,7 @@ class ParserUtils {
       ref = ref.slice(0, -1);
     }
     const val = ref.slice(ref.lastIndexOf("/") + 1);
-    return ___default["default"].upperFirst(___default["default"].camelCase(val));
+    return ___default['default'].upperFirst(___default['default'].camelCase(val));
   };
   static parseAttributeType = (name, definition) => {
     const required = definition.required ? "" : "?";
@@ -281,7 +283,7 @@ class ParserUtils {
       }
     }
     let classMethod = httpMethod + "/" + replacedIdsPath;
-    classMethod = ___default["default"].camelCase(classMethod);
+    classMethod = ___default['default'].camelCase(classMethod);
     classMethod = classMethod.replace("PublicNamespacesByNamespace", "");
     classMethod = classMethod.replace("AdminNamespacesByNamespace", "Admin");
     const searchWord = "NamespacesByNamespace";
@@ -295,7 +297,7 @@ class ParserUtils {
   static getBodyParams(parametersArray) {
     if (!parametersArray)
       return [];
-    if (!___default["default"].isArray(parametersArray) && parametersArray)
+    if (!___default['default'].isArray(parametersArray) && parametersArray)
       return [parametersArray].filter((p) => p.in === "body" || p.in === "formData");
     return parametersArray.filter((p) => p.in === "body" || p.in === "formData");
   }
@@ -312,25 +314,25 @@ class ParserUtils {
     return res;
   }
   static mkdirIfNotExist(dirToCreate) {
-    if (!fs__default["default"].existsSync(dirToCreate)) {
-      fs__default["default"].mkdirSync(dirToCreate, { recursive: true });
+    if (!fs__default['default'].existsSync(dirToCreate)) {
+      fs__default['default'].mkdirSync(dirToCreate, { recursive: true });
     }
   }
   static writeClassFile(distDir, apiName, apiBuffer, imports) {
     const fileContent = templateClass(apiName, apiBuffer, imports);
-    fs__default["default"].writeFileSync(`${distDir}/${apiName}.ts`, ParserUtils.prependCopyrightHeader(fileContent));
+    fs__default['default'].writeFileSync(`${distDir}/${apiName}.ts`, ParserUtils.prependCopyrightHeader(fileContent));
   }
   static writeJsdocFile(distDir, nameArray, apiBuffer) {
     const jsdocFile = templateJsdocFile(nameArray[0], apiBuffer);
-    fs__default["default"].writeFileSync(`${distDir}/docs/${nameArray[0]}.md`, jsdocFile);
+    fs__default['default'].writeFileSync(`${distDir}/docs/${nameArray[0]}.md`, jsdocFile);
   }
   static writeDefinitionFile(distDir, name, buffer) {
     ParserUtils.mkdirIfNotExist(distDir);
-    fs__default["default"].writeFileSync(path__default["default"].join(distDir, `${name}.ts`), ParserUtils.prependCopyrightHeader(buffer));
+    fs__default['default'].writeFileSync(path__default['default'].join(distDir, `${name}.ts`), ParserUtils.prependCopyrightHeader(buffer));
   }
   static writeAllImportsFile(distDir, buffer, isAdminWebSdk) {
     ParserUtils.mkdirIfNotExist(distDir);
-    fs__default["default"].writeFileSync(path__default["default"].join(distDir, `all-${isAdminWebSdk ? "admin" : "public"}-imports.ts`), ParserUtils.prependCopyrightHeader(buffer));
+    fs__default['default'].writeFileSync(path__default['default'].join(distDir, `all-${isAdminWebSdk ? "admin" : "public"}-imports.ts`), ParserUtils.prependCopyrightHeader(buffer));
   }
   static toCamelCase(str) {
     return str.split("/").map(function(word, index) {
@@ -356,17 +358,17 @@ class ParserUtils {
     });
   }
   static applyPatchIfExists(swaggerFilePath, possibleSwaggerPatchFilePath, swaggerPatchedFilePath, swaggerPatchedDir) {
-    if (!fs__default["default"].existsSync(swaggerPatchedDir)) {
-      fs__default["default"].mkdirSync(swaggerPatchedDir, { recursive: true });
+    if (!fs__default['default'].existsSync(swaggerPatchedDir)) {
+      fs__default['default'].mkdirSync(swaggerPatchedDir, { recursive: true });
     }
-    if (!fs__default["default"].existsSync(possibleSwaggerPatchFilePath)) {
-      fs__default["default"].copyFileSync(swaggerFilePath, swaggerPatchedFilePath);
+    if (!fs__default['default'].existsSync(possibleSwaggerPatchFilePath)) {
+      fs__default['default'].copyFileSync(swaggerFilePath, swaggerPatchedFilePath);
       return;
     }
-    const swaggerContent = JSON.parse(fs__default["default"].readFileSync(swaggerFilePath, "utf8"));
-    const swaggerPatchFileContent = JSON.parse(fs__default["default"].readFileSync(possibleSwaggerPatchFilePath, "utf8"));
+    const swaggerContent = JSON.parse(fs__default['default'].readFileSync(swaggerFilePath, "utf8"));
+    const swaggerPatchFileContent = JSON.parse(fs__default['default'].readFileSync(possibleSwaggerPatchFilePath, "utf8"));
     const { newDocument } = fastJsonPatch.applyPatch(swaggerContent, swaggerPatchFileContent);
-    fs__default["default"].writeFileSync(swaggerPatchedFilePath, JSON.stringify(newDocument, null, 2));
+    fs__default['default'].writeFileSync(swaggerPatchedFilePath, JSON.stringify(newDocument, null, 2));
   }
   static mapKeys(map_) {
     const methods_ = [];
@@ -495,8 +497,8 @@ const templateMethod = (classMethod, description, httpMethod, path, pathParams,
     if (!this.cache) {
       return SdkCache.withoutCache(res)
     }
-    const key = url + CodeGenUtil.hashCode(JSON.stringify({ params }))
-    return SdkCache.withCache(key, res)
+    const cacheKey = url + CodeGenUtil.hashCode(JSON.stringify({ params }))
+    return SdkCache.withCache(cacheKey, res)
   }
   `;
     isGuardInvoked = true;
@@ -513,8 +515,8 @@ const templateMethod = (classMethod, description, httpMethod, path, pathParams,
     if (!this.cache) {
       return SdkCache.withoutCache(res)
     }
-    const key = url + CodeGenUtil.hashCode(JSON.stringify({ params }))
-    return SdkCache.withCache(key, res)
+    const cacheKey = url + CodeGenUtil.hashCode(JSON.stringify({ params }))
+    return SdkCache.withCache(cacheKey, res)
   }
   `;
     isGuardInvoked = true;
@@ -778,7 +780,7 @@ const extractEnumObject = (type, isRequired, enumArr) => {
 };
 
 class CodeGenerator {
-  static getPatchedDir = () => path__default["default"].join(CliParser.getSwaggersOutputPath(), "patched");
+  static getPatchedDir = () => path__default['default'].join(CliParser.getSwaggersOutputPath(), "patched");
   static getGeneratedPublicFolder = () => `${CliParser.getOutputPath()}/generated-public`;
   static getGeneratedAdminFolder = () => `${CliParser.getOutputPath()}/generated-admin`;
   static iterateApi = (api) => {
@@ -802,7 +804,7 @@ class CodeGenerator {
         const description = e.description;
         const isDeprecated = e.deprecated;
         const responseClass = ParserUtils.get2xxResponse(e.responses, path2);
-        const className = ___default["default"].upperFirst(___default["default"].camelCase(tag));
+        const className = ___default['default'].upperFirst(___default['default'].camelCase(tag));
         classImports[className] = classImports[className] ? classImports[className] : {};
         if (!isDeprecated) {
           if (responseClass) {
@@ -831,11 +833,11 @@ class CodeGenerator {
   static main = async (nameArray) => {
     const serviceName = nameArray[0];
     const swaggerFile = nameArray[2];
-    const parser = new SwaggerParser__default["default"]();
+    const parser = new SwaggerParser__default['default']();
     const generatedFolder = CliParser.isAdmin() ? CodeGenerator.getGeneratedAdminFolder() : CodeGenerator.getGeneratedPublicFolder();
     const DIST_DIR = `${generatedFolder}/${serviceName}`;
-    const DIST_DOCS_DIR = path__default["default"].join(DIST_DIR, "docs");
-    const DIST_DEFINITION_DIR = path__default["default"].join(DIST_DIR, "definitions");
+    const DIST_DOCS_DIR = path__default['default'].join(DIST_DIR, "docs");
+    const DIST_DEFINITION_DIR = path__default['default'].join(DIST_DIR, "definitions");
     const swaggerFilePath = `${CliParser.getSwaggersOutputPath()}/${swaggerFile}`;
     const swaggerPatchedFilePath = `${CodeGenerator.getPatchedDir()}/${swaggerFile}`;
     const swaggerPatchFilePath = `${swaggerFilePath}patch`;
@@ -849,25 +851,25 @@ class CodeGenerator {
     const { apiBufferByTag, dependenciesByTag, classImports, arrayDefinitions } = CodeGenerator.iterateApi(api);
     const targetSrcFolder = `${CliParser.getOutputPath()}/`;
     for (const tag in apiBufferByTag) {
-      const className = ___default["default"].upperFirst(___default["default"].camelCase(tag));
+      const className = ___default['default'].upperFirst(___default['default'].camelCase(tag));
       const apiBuffer = apiBufferByTag[tag];
       const imports = [.../* @__PURE__ */ new Set([...dependenciesByTag[tag], ...Object.values(classImports[className])])];
       const classGenName = CliParser.isAdmin() ? className + "Admin$" : className + "$";
       ParserUtils.writeClassFile(DIST_DIR, classGenName, apiBuffer, imports);
-      indexImportsSet.add(ParserUtils.getRelativePathToWebSdkSrcFolder(path__default["default"].join(DIST_DIR, `${classGenName}`), targetSrcFolder));
+      indexImportsSet.add(ParserUtils.getRelativePathToWebSdkSrcFolder(path__default['default'].join(DIST_DIR, `${classGenName}`), targetSrcFolder));
     }
     const duplicates = /* @__PURE__ */ new Map();
     for (const ref in api.definitions) {
       const definition = api.definitions[ref];
       let fileName = ParserUtils.parseRefType(ref);
-      const fileExist = fs__default["default"].existsSync(path__default["default"].join(DIST_DEFINITION_DIR, `${fileName}.ts`));
+      const fileExist = fs__default['default'].existsSync(path__default['default'].join(DIST_DEFINITION_DIR, `${fileName}.ts`));
       if (fileExist) {
         fileName = ParserUtils.toCamelCaseWord(ref).replace(".", "").replace(".", "");
         duplicates.set(ref, fileName);
       }
       const { buffer } = new TemplateZod().render(fileName, definition, /* @__PURE__ */ new Map());
       ParserUtils.writeDefinitionFile(DIST_DEFINITION_DIR, fileName, buffer);
-      indexImportsSet.add(ParserUtils.getRelativePathToWebSdkSrcFolder(path__default["default"].join(DIST_DEFINITION_DIR, fileName), targetSrcFolder));
+      indexImportsSet.add(ParserUtils.getRelativePathToWebSdkSrcFolder(path__default['default'].join(DIST_DEFINITION_DIR, fileName), targetSrcFolder));
     }
     for (const ref in api.definitions) {
       const definition = api.definitions[ref];
@@ -875,13 +877,13 @@ class CodeGenerator {
       const { buffer, duplicateFound } = new TemplateZod().render(fileName, definition, duplicates);
       if (duplicateFound) {
         ParserUtils.writeDefinitionFile(DIST_DEFINITION_DIR, fileName, buffer);
-        indexImportsSet.add(ParserUtils.getRelativePathToWebSdkSrcFolder(path__default["default"].join(DIST_DEFINITION_DIR, fileName), targetSrcFolder));
+        indexImportsSet.add(ParserUtils.getRelativePathToWebSdkSrcFolder(path__default['default'].join(DIST_DEFINITION_DIR, fileName), targetSrcFolder));
       }
     }
     for (const arrayClass of arrayDefinitions) {
       const buffer = new TemplateZodArray().render(arrayClass);
       ParserUtils.writeDefinitionFile(DIST_DEFINITION_DIR, arrayClass, buffer);
-      indexImportsSet.add(ParserUtils.getRelativePathToWebSdkSrcFolder(path__default["default"].join(DIST_DEFINITION_DIR, arrayClass), targetSrcFolder));
+      indexImportsSet.add(ParserUtils.getRelativePathToWebSdkSrcFolder(path__default['default'].join(DIST_DEFINITION_DIR, arrayClass), targetSrcFolder));
     }
     console.log("\n----------\nCOMPLETED.\n----------\n\n");
     return indexImportsSet;
@@ -924,7 +926,7 @@ class SwaggerDownloader {
   };
 }
 
-yargs__default["default"].command("download-swaggers", "Download swaggers JSON files", (yargs2) => {
+yargs__default['default'].command("download-swaggers", "Download swaggers JSON files", (yargs2) => {
   CliParser.createInstance(yargs2);
   SwaggerDownloader.main();
 }).command("generate-code", "Generate code based on downloaded swagger files", async (yargs2) => {
@@ -940,7 +942,7 @@ yargs__default["default"].command("download-swaggers", "Download swaggers JSON f
   const filenamesSet = /* @__PURE__ */ new Set();
   for (const set of arrayOfSets) {
     set.forEach((value) => {
-      const fileName = path__default["default"].basename(value);
+      const fileName = path__default['default'].basename(value);
       if (!filenamesSet.has(fileName)) {
         indexImportsSet.add(value);
         filenamesSet.add(fileName);