@accelbyte/codegen 2.0.0-beta.9 → 2.0.1

package/README.md

@@ -1,4 +1,4 @@
-# AccelByte Code Generator
+# AccelByte Web SDK Code Generator
 
 AccelByte Code Generator is a CLI tool that facilitates creating an AccelByte Web SDK from AccelByte OpenAPI definitions.
 
@@ -30,10 +30,82 @@ Provide swaggers url you wish to generate, store it in .json format file.
 ```
 
 ## How to Generate
-1. Provide the `config.json` file
-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`
-4. Prettify the files using
-   `yarn prettier`
+
+**Step 1: Set Up Your Node.js Environment** Make sure you have Node.js and npm (Node Package Manager) installed on your system. You can download and install them from the official website: https://nodejs.org/en/ 
+
+__*It is recommended__ to use [nvm](https://github.com/nvm-sh/nvm) or [fnm](https://github.com/Schniz/fnm) to install Node.js so you can switch between Node versions more easily 
+
+**Step 2: Create a New Node.js Project (if needed)** If you are starting a new project, create a new directory and initialize it as a Node.js project. You can do this using the following commands: 
+```
+mkdir my-project
+cd my-project
+npm init
+```
+Follow the prompts to set up your project's package.json file.
+
+**Step 3: Install the Package** To use `@accelbyte/codegen`, you need to install it as a dependency for your project. Run the following command within your project directory:
+```
+npm install @accelbyte/codegen
+# Or, with yarn:
+yarn add @accelbyte/codegen
+```
+**Step 4: Configure the Package** Check the documentation or the README of the package for specific configuration instructions. 
+  1.	Prepare The `CHANGELOG.md` file, create the Changelog file in the root project with `CHANGELOG.md` file name.
+  2.	Prepare Config file, Provide the swaggers URL you wish to generate with the format of an Array of array detailed services, so we can add multiple services at the same time, by adding an Array of detailed services into `Config.json` Array like this:
+```
+[
+  [serviceName, aliasName, swaggerFileOutput, swaggerURL],
+  [serviceName2, aliasName2, swaggerFileOutput2, swaggerURL2],
+  ...
+]
+```
+and then store it in .json format file (we suggest placing the file in the root directory). example:
+```
+[
+  ["iam", "Iam", "iam.json", "https://example.com/iam/apidocs/api.json"]
+]
+```
+for the Accelbyte Demo environment, this will look like this
+```
+[
+  ["iam", "Iam", "iam.json", "https://demo.accelbyte.io/iam/apidocs/api.json"]
+]
+```
+
+**Step 5: Download Swagger Files** download the swagger file to the project by executing this command
+```
+npm exec -- accelbyte-codegen download-swaggers --config ./config.json --swaggersOutput ./swaggers
+# Or, with yarn:
+yarn accelbyte-codegen download-swaggers --config ./config.json --swaggersOutput ./swaggers
+```
+*note: please adjust the `--config` flag with the path of config.json file that was already set up before, and please specify the swagger output directory by using `--swaggersOutput` flag.
+
+**Step 6: Generate Code from Swagger Files** after the swagger file has already been downloaded we can proceed to generating Web SDK code from the Swagger File using this command : 
+```
+npm exec -- accelbyte-codegen generate-code --config ./config.json --swaggersOutput ./swaggers --output ./sdk
+```
+*note: please adjust the `--config` flag with the path of config.json file that was already set up before, and please specify for the swagger output directory by using `--swaggersOutput` flag, and the directory output of generated SDK using `--output` flag.
+if it is successful the result will look like this, and the WebSDK code should be generated under the/sdk directory
+
+```
+----------
+Generating API: { title: 'justice-iam-service', version: '7.4.0' }
+!!!! Missing x-version ...
+COMPLETED
+----------
+```
+
+**Step 7: Prettify the files (Optional)** 
+
+To prettify the code file using the prettier tool, please install the plugin first by doing this:
+```
+npm install prettier 
+# Or, with yarn:
+yarn add prettier
+```
+after installing, execute prettier as below
+```
+npm exec prettier --write swaggers/*.json && prettier --write sdk/**/*
+# Or, with yarn:
+yarn prettier --write swaggers/*.json && prettier --write sdk/**/*
+```

package/dist/accelbyte-codegen.js

@@ -149,12 +149,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 +166,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 +175,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 +197,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)
@@ -221,7 +216,7 @@ class VersionHelpers {
 }
 
 const codegenPackageJsonPath = path.join(__dirname, "../package.json");
-const codegenPackageJSON = JSON.parse(fs.readFileSync(codegenPackageJsonPath, "utf-8"));
+JSON.parse(fs.readFileSync(codegenPackageJsonPath, "utf-8"));
 const UNDEFINED_SWAGGER_SEMVER = "0.0.0";
 const REMOVED_KEYWORDS = [
   "/admin/",
@@ -346,6 +341,12 @@ class ParserUtils {
     if (definition?.schema?.type && definition.schema.type === "array") {
       return `${attrName}${required}: ${definition.schema.items.type ?? "any"}[]`;
     }
+    if (definition.type && definition.type === "file") {
+      return `${attrName}${required}: File`;
+    }
+    if (definition?.schema?.type && definition.schema.type === "file") {
+      return `${attrName}${required}: File`;
+    }
     if (definition.type && definition.type) {
       return `${attrName}${required}: ${definition.type} | null`;
     }
@@ -531,9 +532,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