@accelbyte/codegen 2.0.0 → 2.1.0-experimental.0

package/README.md

@@ -90,18 +90,7 @@ if it is successful the result will look like this, and the WebSDK code should b
 ```
 ----------
 Generating API: { title: 'justice-iam-service', version: '7.4.0' }
-!!!! Missing x-version for  ./sdk/generated-public/iam {
-  description: 'Justice IAM Service',
-  title: 'justice-iam-service',
-  contact: {
-    name: 'Engineering Team at AccelByte',
-    url: 'https://accelbyte.io',
-    email: 'engineering@accelbyte.io'
-  },
-  version: '7.4.0',
-  gitHash: '7.4.0'
-}
-
+!!!! Missing x-version ...
 COMPLETED
 ----------
 ```

package/dist/accelbyte-codegen.js

@@ -72,9 +72,6 @@ class CliParser {
   static getResolvedSwaggersOutputPath = () => {
     return path__namespace.resolve(CliParser.getSwaggersOutputPath());
   };
-  static isAdmin = () => {
-    return CliParser.instance().argv.admin;
-  };
   static getSnippetOutputPath = () => {
     return CliParser.instance().argv.snippetOutput;
   };
@@ -103,7 +100,9 @@ const generateImports = (body, importStatements, makeNewImportVarMap2, getImport
       }
     }
   }
-  const generatedImports = Object.keys(usedImportVarMap).sort().map((moduleSource) => `import { ${usedImportVarMap[moduleSource].sort().join(", ")} } from '${moduleSource}'`).join("\n");
+  const generatedImports = Object.keys(usedImportVarMap).sort().map((moduleSource) => {
+    return `import { ${usedImportVarMap[moduleSource].sort().join(", ")} } from '${moduleSource}'`;
+  }).join("\n");
   return `${generatedImports}
 ${importStatements.sort().join("\n")}`;
 };
@@ -149,12 +148,10 @@ export function ${className}(sdk: AccelbyteSDK, args?: ApiArgs) {
   `;
 };
 
-const VersionBumpType = zod.z.enum(["CUTOFF", "RELEASE", "HOTFIX"]);
+const VersionBumpType = zod.z.enum(["CUTOFF", "RELEASE", "HOTFIX", "BREAKING"]);
 class VersionHelpers {
   static getNextVersion = ({
-    codegenVersion,
     serviceVersion,
-    predefinedMajorVersion,
     versionBumpType,
     sdkVersion,
     nextPrereleaseId
@@ -168,12 +165,8 @@ class VersionHelpers {
         throw new Error(`process.env.PRERELEASE_ID should be empty when process.env.VERSION_BUMP_TYPE is "HOTFIX" or "PRELEASE".`);
       }
     }
-    const codegenSemvers = semver.parse(codegenVersion);
     const serviceSemvers = semver.parse(serviceVersion);
     const sdkSemvers = semver.parse(sdkVersion);
-    if (codegenSemvers === null) {
-      throw new Error(`Invalid codegen version: ${codegenVersion}`);
-    }
     if (serviceSemvers === null) {
       throw new Error(`Invalid service version: ${serviceVersion}`);
     }
@@ -181,11 +174,16 @@ class VersionHelpers {
       throw new Error(`Invalid sdk version: ${sdkVersion}`);
     }
     const { major: currentMajor, minor: currentMinor, patch: currentPatch, prerelease: currentPrerelease } = sdkSemvers;
-    const nextMajor = codegenSemvers.major + predefinedMajorVersion;
-    const shouldResetVersion = nextMajor !== currentMajor;
+    let nextMajor = currentMajor;
     let nextMinor = currentMinor;
     let nextPatch = currentPatch;
     switch (versionBumpType) {
+      case VersionBumpType.Enum.BREAKING: {
+        nextMajor++;
+        nextMinor = 0;
+        nextPatch = 0;
+        break;
+      }
       case VersionBumpType.Enum.CUTOFF: {
         nextMinor++;
         nextPatch = 0;
@@ -198,17 +196,13 @@ class VersionHelpers {
         break;
       }
     }
-    if (shouldResetVersion) {
-      nextMinor = 0;
-      nextPatch = 0;
-    }
     let nextVersion = [
-      codegenSemvers.major + predefinedMajorVersion,
+      nextMajor,
       nextMinor,
       nextPatch
     ].join(".");
     if (nextPrereleaseId) {
-      if (nextMinor !== currentMinor || nextMajor !== currentMajor) {
+      if (nextMinor !== currentMinor) {
         nextVersion += `-${nextPrereleaseId}.0`;
       } else {
         if (currentPrerelease.length)
@@ -220,8 +214,6 @@ class VersionHelpers {
   };
 }
 
-const codegenPackageJsonPath = path.join(__dirname, "../package.json");
-const codegenPackageJSON = JSON.parse(fs.readFileSync(codegenPackageJsonPath, "utf-8"));
 const UNDEFINED_SWAGGER_SEMVER = "0.0.0";
 const REMOVED_KEYWORDS = [
   "/admin/",
@@ -317,7 +309,7 @@ class ParserUtils {
       return null;
     }
     const type = ParserUtils.parseRefType($ref);
-    return `import { ${type} } from '../definitions/${type}.js'`;
+    return `import { ${type} } from '../../generated-definitions/${type}.js'`;
   };
   static parseRefType = ($ref) => {
     let ref = $ref.replace(".", "/");
@@ -509,7 +501,7 @@ class ParserUtils {
   static writeApiFile(distDir, apiName, apiBuffer, imports, returnMethods) {
     const newImports = [];
     imports.forEach((el, index) => {
-      newImports.push(el.replace("../definitions", "./definitions"));
+      newImports.push(el.replace("../../generated-definitions", "../generated-definitions"));
     });
     const fileContent = templateApiClass(apiName, apiBuffer, newImports, returnMethods);
     fs.writeFileSync(`${distDir}/${apiName}.ts`, ParserUtils.prependCopyrightHeader(fileContent));
@@ -527,9 +519,9 @@ class ParserUtils {
     ParserUtils.mkdirIfNotExist(distDir);
     fs.writeFileSync(path.join(distDir, `${name}.ts`), ParserUtils.prependCopyrightHeader(buffer));
   }
-  static writeAllImportsFile(distDir, buffer, isAdminWebSdk) {
+  static writeAllImportsFile(distDir, buffer) {
     ParserUtils.mkdirIfNotExist(distDir);
-    fs.writeFileSync(path.join(distDir, `all-${isAdminWebSdk ? "admin" : "public"}-imports.ts`), ParserUtils.prependCopyrightHeader(buffer));
+    fs.writeFileSync(path.join(distDir, "all-imports.ts"), ParserUtils.prependCopyrightHeader(buffer));
   }
   static syncPackageVersion(apiInfo, skipVersionSync, prereleaseId) {
     if (skipVersionSync)
@@ -537,9 +529,7 @@ class ParserUtils {
     const currDir = process.cwd();
     const { packageJSON, pathToPackageJSON } = ParserUtils.getPackageJSONInfo(currDir);
     const nextSemver = VersionHelpers.getNextVersion({
-      codegenVersion: codegenPackageJSON.version,
       serviceVersion: apiInfo["x-version"] || apiInfo.version || UNDEFINED_SWAGGER_SEMVER,
-      predefinedMajorVersion: packageJSON.predefinedMajorVersion || 0,
       versionBumpType: process.env.VERSION_BUMP_TYPE,
       sdkVersion: packageJSON.version,
       nextPrereleaseId: prereleaseId
@@ -950,8 +940,9 @@ const templateApiIndex = (serviceName, serviceNameTitle, apiList) => {
   let imports = "";
   let returnStatement = "";
   for (const cl of apiList) {
+    const dir = cl.toLowerCase().includes("admin") ? "generated-admin" : "generated-public";
     imports += `
-import { ${cl} } from './${serviceName}/${cl}.js'`;
+import { ${cl} } from './${dir}/${cl}.js'`;
     returnStatement += `
 ${cl}, `;
   }
@@ -1352,7 +1343,7 @@ class SwaggerReaderHelpers {
         tagToClassImportsRecord[className] = tagToClassImportsRecord[className] ? tagToClassImportsRecord[className] : {};
         if (responseClass) {
           const importTypeClass = ParserUtils.parseRefType(responseClass);
-          tagToClassImportsRecord[className][importTypeClass] = `import { ${importTypeClass} } from '../definitions/${importTypeClass}.js'`;
+          tagToClassImportsRecord[className][importTypeClass] = `import { ${importTypeClass} } from '../../generated-definitions/${importTypeClass}.js'`;
         }
         if (responseClass && responseClass.endsWith("Array")) {
           arrayDefinitions.push(responseClass);
@@ -1417,39 +1408,30 @@ class SwaggerReaderHelpers {
 }
 
 class CodeGenerator {
-  static getPatchedDir = () => path.join(CliParser.getSwaggersOutputPath(), "patched");
-  static getGeneratedPublicFolder = () => `${CliParser.getOutputPath()}/generated-public`;
-  static getGeneratedAdminFolder = () => `${CliParser.getOutputPath()}/generated-admin`;
+  static srcFolder = () => CliParser.getOutputPath();
+  static getGeneratedFolder = (isAdmin) => isAdmin ? `${CodeGenerator.srcFolder()}/generated-admin` : `${CodeGenerator.srcFolder()}/generated-public`;
   static getGeneratedSnippetsFolder = () => `${CliParser.getSnippetOutputPath()}/generated-snippets`;
-  static getServicePrefix = (servicePaths) => servicePaths[servicePaths.length - 1].split("/")[1];
+  static prepareDirs = (DIST_DEFINITION_DIR, DIST_DIR, DIST_DIR_ENDPOINTS) => {
+    ParserUtils.mkdirIfNotExist(DIST_DEFINITION_DIR);
+    ParserUtils.mkdirIfNotExist(DIST_DIR(true));
+    ParserUtils.mkdirIfNotExist(DIST_DIR(false));
+    ParserUtils.mkdirIfNotExist(DIST_DIR_ENDPOINTS(true));
+    ParserUtils.mkdirIfNotExist(DIST_DIR_ENDPOINTS(false));
+  };
   static main = async (nameArray) => {
     const serviceName = nameArray[0];
     const sdkName = nameArray[1];
     const swaggerFile = nameArray[2];
     const parser = new SwaggerParser();
-    const generatedFolder = CliParser.isAdmin() ? CodeGenerator.getGeneratedAdminFolder() : CodeGenerator.getGeneratedPublicFolder();
-    const DIST_DIR = `${generatedFolder}/${serviceName}`;
-    const DIST_ENDPOINTS_DIR = path.join(DIST_DIR, "endpoints");
-    const DIST_DEFINITION_DIR = path.join(DIST_DIR, "definitions");
     const swaggerFilePath = `${CliParser.getSwaggersOutputPath()}/${swaggerFile}`;
     const api = await parser.parse(swaggerFilePath);
+    const serviceNameTitle = ParserUtils.convertDashesToTitleCase(serviceName);
     const indexImportsSet = /* @__PURE__ */ new Set();
     const apiInfo = { ...api.info, "x-version": api["x-version"]?.version };
     console.log("----------\nGenerating API:", { title: apiInfo.title, version: apiInfo.version });
-    ParserUtils.mkdirIfNotExist(DIST_DIR);
-    ParserUtils.mkdirIfNotExist(DIST_DEFINITION_DIR);
-    ParserUtils.mkdirIfNotExist(DIST_ENDPOINTS_DIR);
     ParserUtils.syncPackageVersion(apiInfo, CliParser.skipVersionSync(), process.env.PRERELEASE_ID);
+    ParserUtils.writeXVersion(CodeGenerator.srcFolder(), api["x-version"], api.info);
     const parsedInformation = await SwaggerReaderHelpers.parseAllEndpoints({ api, sdkName, serviceName });
-    const parsedInformationByType = CliParser.isAdmin() ? parsedInformation.admin : parsedInformation.public;
-    const {
-      arrayDefinitions,
-      tagToClassImportsRecord,
-      tagToEndpointClassesRecord,
-      tagToSdkClientRecord,
-      tagToSdkFunctionNamesRecord,
-      tagToSdkImportsRecord
-    } = parsedInformationByType;
     if (CliParser.getSnippetOutputPath()) {
       try {
         ParserUtils.writeSnippetFile(CodeGenerator.getGeneratedSnippetsFolder(), api.info.title, JSON.stringify({
@@ -1460,55 +1442,69 @@ class CodeGenerator {
         console.log("Generating snippets", err);
       }
     }
-    const targetSrcFolder = `${CliParser.getOutputPath()}/`;
-    const apiList = [];
-    for (const tag in tagToEndpointClassesRecord) {
-      const { className, classGenName } = ParserUtils.generateClassName(tag, CliParser.isAdmin());
-      const classBuffer = tagToEndpointClassesRecord[tag];
-      const imports = [.../* @__PURE__ */ new Set([...tagToSdkImportsRecord[tag], ...Object.values(tagToClassImportsRecord[className])])];
-      const apiImports = [.../* @__PURE__ */ new Set([...tagToSdkImportsRecord[tag], ...Object.values(tagToClassImportsRecord[className])])];
-      apiImports.push(`import { ${classGenName} } from './endpoints/${classGenName}.js'`);
-      ParserUtils.writeClassFile(DIST_ENDPOINTS_DIR, classGenName, classBuffer, imports);
-      const apiBuffer = tagToSdkClientRecord[tag];
-      const { apiGenName } = ParserUtils.generateApiName(tag, CliParser.isAdmin());
-      ParserUtils.writeApiFile(DIST_DIR, apiGenName, apiBuffer, apiImports, tagToSdkFunctionNamesRecord[tag]);
-      apiList.push(apiGenName);
-      indexImportsSet.add(ParserUtils.getRelativePathToWebSdkSrcFolder(path.join(DIST_ENDPOINTS_DIR, `${classGenName}`), targetSrcFolder));
-      indexImportsSet.add(ParserUtils.getRelativePathToWebSdkSrcFolder(path.join(DIST_DIR, `${apiGenName}`), targetSrcFolder));
-    }
-    const serviceNameTitle = ParserUtils.convertDashesToTitleCase(serviceName);
-    const apiIndexBuff = templateApiIndex(serviceName, serviceNameTitle, apiList);
-    ParserUtils.writeApiMainFile(generatedFolder, serviceNameTitle, apiIndexBuff);
-    indexImportsSet.add(ParserUtils.getRelativePathToWebSdkSrcFolder(path.join(generatedFolder, serviceNameTitle), targetSrcFolder));
-    const duplicates = /* @__PURE__ */ new Map();
-    const definitions = api?.components?.schemas || api.definitions;
-    for (const ref in definitions) {
-      const definition = definitions[ref];
-      let fileName = ParserUtils.parseRefType(ref);
-      const fileExist = fs.existsSync(path.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.join(DIST_DEFINITION_DIR, fileName), targetSrcFolder));
-    }
-    for (const ref in definitions) {
-      const definition = definitions[ref];
-      const fileName = ParserUtils.parseRefType(ref);
-      const { buffer, duplicateFound } = new TemplateZod().render(fileName, definition, duplicates);
-      if (duplicateFound) {
-        ParserUtils.writeDefinitionFile(DIST_DEFINITION_DIR, fileName, buffer);
-        indexImportsSet.add(ParserUtils.getRelativePathToWebSdkSrcFolder(path.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.join(DIST_DEFINITION_DIR, arrayClass), targetSrcFolder));
-    }
-    ParserUtils.writeXVersion(DIST_DIR, api["x-version"], api.info);
+    const DIST_DIR = (isAdmin) => `${CodeGenerator.getGeneratedFolder(isAdmin)}`;
+    const DIST_DIR_ENDPOINTS = (isAdmin) => path.join(DIST_DIR(isAdmin), "endpoints");
+    const DIST_DEFINITION_DIR = path.join(CodeGenerator.srcFolder(), "generated-definitions");
+    const targetSrcFolder = `${CodeGenerator.srcFolder()}/`;
+    CodeGenerator.prepareDirs(DIST_DEFINITION_DIR, DIST_DIR, DIST_DIR_ENDPOINTS);
+    const mainApiList = [];
+    const generatePublicOrAdmin = (isAdmin) => {
+      const parsedInformationByType = isAdmin ? parsedInformation.admin : parsedInformation.public;
+      const {
+        arrayDefinitions,
+        tagToClassImportsRecord,
+        tagToEndpointClassesRecord,
+        tagToSdkClientRecord,
+        tagToSdkFunctionNamesRecord,
+        tagToSdkImportsRecord
+      } = parsedInformationByType;
+      const writeApiEndpointFiles = (isAdminEndpoint) => {
+        const apiList = [];
+        for (const tag in tagToEndpointClassesRecord) {
+          const { className, classGenName } = ParserUtils.generateClassName(tag, isAdminEndpoint);
+          const classBuffer = tagToEndpointClassesRecord[tag];
+          const imports = [.../* @__PURE__ */ new Set([...tagToSdkImportsRecord[tag], ...Object.values(tagToClassImportsRecord[className])])];
+          const apiImports = [.../* @__PURE__ */ new Set([...tagToSdkImportsRecord[tag], ...Object.values(tagToClassImportsRecord[className])])];
+          apiImports.push(`import { ${classGenName} } from './endpoints/${classGenName}.js'`);
+          ParserUtils.writeClassFile(DIST_DIR_ENDPOINTS(isAdminEndpoint), classGenName, classBuffer, imports);
+          const apiBuffer = tagToSdkClientRecord[tag];
+          const { apiGenName } = ParserUtils.generateApiName(tag, isAdminEndpoint);
+          ParserUtils.writeApiFile(DIST_DIR(isAdminEndpoint), apiGenName, apiBuffer, apiImports, tagToSdkFunctionNamesRecord[tag]);
+          apiList.push(apiGenName);
+          indexImportsSet.add(ParserUtils.getRelativePathToWebSdkSrcFolder(path.join(DIST_DIR_ENDPOINTS(isAdminEndpoint), `${classGenName}`), targetSrcFolder));
+          indexImportsSet.add(ParserUtils.getRelativePathToWebSdkSrcFolder(path.join(DIST_DIR(isAdminEndpoint), `${apiGenName}`), targetSrcFolder));
+        }
+        mainApiList.push(...apiList);
+        indexImportsSet.add(ParserUtils.getRelativePathToWebSdkSrcFolder(path.join(CodeGenerator.srcFolder(), serviceNameTitle), targetSrcFolder));
+      };
+      const writeDefinitions = (api2) => {
+        const duplicates = /* @__PURE__ */ new Map();
+        const definitions = api2?.components?.schemas || api2.definitions;
+        for (const ref in definitions) {
+          const definition = definitions[ref];
+          const fileName = ParserUtils.parseRefType(ref);
+          const fileExist = fs.existsSync(path.join(DIST_DEFINITION_DIR, `${fileName}.ts`));
+          if (fileExist) {
+            const duplicateName = ParserUtils.toCamelCaseWord(ref).replace(".", "").replace(".", "");
+            duplicates.set(ref, duplicateName);
+          }
+          const { buffer } = new TemplateZod().render(fileName, definition, /* @__PURE__ */ new Map());
+          ParserUtils.writeDefinitionFile(DIST_DEFINITION_DIR, fileName, buffer);
+          indexImportsSet.add(ParserUtils.getRelativePathToWebSdkSrcFolder(path.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.join(DIST_DEFINITION_DIR, arrayClass), targetSrcFolder));
+        }
+      };
+      writeApiEndpointFiles(isAdmin);
+      writeDefinitions(api);
+    };
+    generatePublicOrAdmin(true);
+    generatePublicOrAdmin(false);
+    const apiIndexBuff = templateApiIndex(serviceName, serviceNameTitle, mainApiList);
+    ParserUtils.writeApiMainFile(CodeGenerator.srcFolder(), serviceNameTitle, apiIndexBuff);
     console.log("\nCOMPLETED\n----------\n\n");
     return indexImportsSet;
   };
@@ -1575,17 +1571,7 @@ class SwaggerDownloader {
   };
 }
 
-yargs.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) => {
-  yargs2.check(({ output }) => {
-    if (!output?.trim()) {
-      throw new Error("output is required for generate-code");
-    }
-    return true;
-  });
-  CliParser.createInstance(yargs2);
+const generateSdk = async () => {
   const arrayOfSets = await Promise.all(CliParser.getConfigFile().map((config) => CodeGenerator.main(config)));
   const indexImportsSet = /* @__PURE__ */ new Set();
   const filenamesSet = /* @__PURE__ */ new Set();
@@ -1602,7 +1588,20 @@ yargs.command("download-swaggers", "Download swaggers JSON files", (yargs2) => {
   const filesToImport = indexImportsArray.map((fileToImport) => {
     return `export * from '${fileToImport.replace("\\", "/")}.js'`;
   });
-  ParserUtils.writeAllImportsFile(CliParser.getOutputPath(), filesToImport.join("\n"), CliParser.isAdmin());
+  ParserUtils.writeAllImportsFile(CliParser.getOutputPath(), filesToImport.join("\n"));
+};
+yargs.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) => {
+  yargs2.check(({ output }) => {
+    if (!output?.trim()) {
+      throw new Error("output is required for generate-code");
+    }
+    return true;
+  });
+  CliParser.createInstance(yargs2);
+  await generateSdk();
 }).option("config", {
   description: "Config file providing backend services URL.",
   type: "string",
@@ -1614,10 +1613,5 @@ yargs.command("download-swaggers", "Download swaggers JSON files", (yargs2) => {
 }).option("output", {
   description: "Output path for generated code. Required for generate-code",
   type: "string"
-}).option("admin", {
-  description: "Only generate /admin endpoints.",
-  type: "boolean",
-  default: false,
-  demandOption: false
 }).demandCommand(1).help().argv;
 //# sourceMappingURL=accelbyte-codegen.js.map