fix: resolve multiple visual issues and minor fixes (#136)

Author: aliasghar98

README.md

@@ -24,7 +24,7 @@ $ npm install -g @apimatic/cli
 $ apimatic COMMAND
 running command...
 $ apimatic (--version)
-@apimatic/cli/1.1.0-alpha.14 win32-x64 node-v20.18.3
+@apimatic/cli/1.1.0-alpha.16 win32-x64 node-v20.18.3
 $ apimatic --help [COMMAND]
 USAGE
   $ apimatic COMMAND
@@ -236,7 +236,7 @@ _See code: [src/commands/portal/copilot.ts](https://github.com/apimatic/apimatic
 
 ## `apimatic portal:generate`
 
-Generate and download a static API Documentation portal. Requires an input directory containing API specifications, a config file and optionally, markdown guides. For details, refer to the [documentation](https://docs.apimatic.io/platform-api/#/http/guides/generating-on-prem-api-portal/build-file-reference)
+Generate an API Documentation portal. Requires an input directory containing API specifications, a config file and optionally, markdown guides. For details, refer to the [documentation](https://docs.apimatic.io/platform-api/#/http/guides/generating-on-prem-api-portal/build-file-reference)
 
 ```
 USAGE
@@ -251,9 +251,9 @@ FLAGS
       --zip                  download the generated portal as a .zip archive
 
 DESCRIPTION
-  Generate and download a static API Documentation portal. Requires an input directory containing API specifications, a
-  config file and optionally, markdown guides. For details, refer to the [documentation](https://docs.apimatic.io/platfo
-  rm-api/#/http/guides/generating-on-prem-api-portal/build-file-reference)
+  Generate an API Documentation portal. Requires an input directory containing API specifications, a config file and
+  optionally, markdown guides. For details, refer to the [documentation](https://docs.apimatic.io/platform-api/#/http/gu
+  ides/generating-on-prem-api-portal/build-file-reference)
 
 EXAMPLES
   $ apimatic portal:generate
@@ -282,7 +282,7 @@ _See code: [src/commands/portal/quickstart.ts](https://github.com/apimatic/apima
 
 ## `apimatic portal:recipe:new`
 
-Generate an API Recipe for a static API Documentation portal.
+Add an API Recipe to your API Documentation portal.
 
 ```
 USAGE
@@ -294,7 +294,7 @@ FLAGS
       --name=<value>   name for the recipe
 
 DESCRIPTION
-  Generate an API Recipe for a static API Documentation portal.
+  Add an API Recipe to your API Documentation portal.
 
   To learn more about API Recipes, visit:
   https://docs.apimatic.io/platform-api/#/http/guides/generating-on-prem-api-portal/api-recipes
@@ -339,7 +339,7 @@ _See code: [src/commands/portal/serve.ts](https://github.com/apimatic/apimatic-c
 
 ## `apimatic portal:toc:new`
 
-Generates a TOC file based on the content directory and spec folder provided in your working directory
+Generate a Table of Contents (TOC) file for your API documentation portal
 
 ```
 USAGE
@@ -356,7 +356,7 @@ FLAGS
                              specification in the working directory.
 
 DESCRIPTION
-  Generates a TOC file based on the content directory and spec folder provided in your working directory
+  Generate a Table of Contents (TOC) file for your API documentation portal
 
   This command generates a new Table of Contents (TOC) file used in the
   generation of your API documentation portal.
@@ -378,15 +378,15 @@ _See code: [src/commands/portal/toc/new.ts](https://github.com/apimatic/apimatic
 
 ## `apimatic sdk:generate`
 
-Generates SDK for your API
+Generate an SDK for your API
 
 ```
 USAGE
   $ apimatic sdk:generate --platform csharp|java|php|python|ruby|typescript|go [--spec <value>] [-d <value>] [-f]
     [--zip] [-k <value>]
 
 FLAGS
-  -d, --destination=<value>  [default: <input>/sdk] path where the sdk will be generated.
+  -d, --destination=<value>  [default: ./sdk/<platform>] path where the sdk will be generated.
   -f, --force                overwrite changes without asking for user consent.
   -k, --auth-key=<value>     override current authentication state with an authentication key.
       --platform=<option>    (required) language platform for sdk
@@ -395,7 +395,7 @@ FLAGS
       --zip                  download the generated SDK as a .zip archive
 
 DESCRIPTION
-  Generates SDK for your API
+  Generate an SDK for your API
 
 EXAMPLES
   $ apimatic sdk:generate --platform="java"

package-lock.json

@@ -1,7 +1,7 @@
 {
     "name": "@apimatic/cli",
     "description": "The official CLI for APIMatic.",
-    "version": "1.1.0-alpha.15",
+    "version": "1.1.0-alpha.16",
     "author": "APIMatic",
     "bin": {
         "apimatic": "./bin/run.js"
@@ -137,6 +137,9 @@
             },
             "sdk": {
                 "description": "Generate SDKs for your APIs in multiple languages."
+            },
+            "portal:toc": {
+                "description": "Generate a Table of Contents (TOC) file for your API documentation portal"
             }
         },
         "state": "Alpha"

package.json

@@ -29,7 +29,7 @@ export class CopilotAction {
       return ActionResult.error("Exiting without making any change.");
 
     const response = await this.apiService.getAccountInfo(this.configDir, this.authKey);
-    if (!response.isErr()) {
+    if (response.isErr()) {
       return ActionResult.error(response._unsafeUnwrapErr());
     }
     const apiCopilotKey = await this.selectCopilotKey(response._unsafeUnwrap());

src/actions/portal/copilot.ts

@@ -161,9 +161,9 @@ export class PortalRecipeAction {
     this.prompts.displayContentStepInfo();
     let editor = process.env.EDITOR;
     let editorArgs: string[] = [];
-    const tempFilePath = path.join(tmpdir(), `recipe-markdown-content-${Date.now()}.md`);
+    const tempFilePath = path.join(tmpdir(), `recipe-markdown-content-${Date.now()}.txt`);
     const template = `# The Heading Goes Here\n\nThis is placeholder text for your API Recipe content step. Feel free to edit this. Save your changes and then close the file once you're done.`;
-    await fsExtra.writeFile(tempFilePath, template);
+    await fsExtra.writeFile(tempFilePath, template, 'utf-8');
 
     try {
       if (!editor) {
@@ -313,7 +313,7 @@ export class PortalRecipeAction {
     }
 
     this.prompts.stopProgressIndicatorWithMessage(
-      "✅  Successfully extracted endpoint groups and endpoints from the API specification."
+      "Successfully extracted endpoint groups and endpoints from the API specification."
     );
     return Result.success(endpointGroupsResult.value!);
   }

src/actions/portal/recipe/new-recipe.ts

@@ -67,7 +67,7 @@ export class PortalNewTocAction {
       return Result.success(tocPath.toString());
     } catch (error) {
       this.prompts.logError(getMessageInRedColor(`${(error as Error).message}`));
-      return Result.failure(`❌ An unexpected error occurred while generating the TOC file.`);
+      return Result.failure(`An unexpected error occurred while generating the TOC file.`);
     }
   }
 
@@ -112,7 +112,7 @@ export class PortalNewTocAction {
     }
 
     this.prompts.stopProgressIndicatorWithMessage(
-      "✅ Successfully extracted endpoints and/or models from the specification."
+      "Successfully extracted endpoints and/or models from the specification."
     );
     return sdlResult.value!;
   }

src/actions/portal/toc/new-toc.ts

@@ -10,7 +10,7 @@ import { SdkContext } from "../../types/sdk-context.js";
 import { Platforms } from "@apimatic/sdk";
 import { SpecContext } from "../../types/spec-context.js";
 import { SdkGeneratePrompts } from "../../prompts/sdk/generate.js";
-
+import { LanguagePlatform } from "../../types/sdk/generate.js";
 
 export class GenerateAction {
   private readonly prompts: SdkGeneratePrompts = new SdkGeneratePrompts();
@@ -28,17 +28,16 @@ export class GenerateAction {
   public readonly execute = async (
     specDirectory: DirectoryPath,
     sdkDirectory: DirectoryPath,
-    platform: Platforms,
+    platform: LanguagePlatform,
     force: boolean,
     zipSdk: boolean
   ): Promise<ActionResult> => {
-
     if (specDirectory.isEqual(sdkDirectory)) {
       return ActionResult.error(`The spec directory and sdk directory cannot be the same: "${specDirectory}"`);
     }
 
     const specContext = new SpecContext(specDirectory);
-    if (!await specContext.validate()) {
+    if (!(await specContext.validate())) {
       return ActionResult.error(`The spec directory is either empty or invalid: "${specDirectory}"`);
     }
 
@@ -55,7 +54,8 @@ export class GenerateAction {
       const specZipPath = new FilePath(tempDirectory, new FileName("spec.zip"));
       await this.zipArchiver.archive(specDirectory, specZipPath);
 
-      const response = await this.portalService.generateSdk(specZipPath, platform, this.configDir, this.authKey);
+      const sdkPlatform = this.convertSimplePlatformToPlatform(platform as LanguagePlatform);
+      const response = await this.portalService.generateSdk(specZipPath, sdkPlatform, this.configDir, this.authKey);
 
       if (!response.isSuccess()) {
         this.prompts.displaySdkGenerationErrorMessage();
@@ -70,5 +70,26 @@ export class GenerateAction {
 
       return ActionResult.success();
     });
+  };
+
+  private convertSimplePlatformToPlatform(languagePlatform: LanguagePlatform): Platforms {
+    switch (languagePlatform) {
+      case LanguagePlatform.CSHARP:
+        return Platforms.CsNetStandardLib;
+      case LanguagePlatform.JAVA:
+        return Platforms.JavaEclipseJreLib;
+      case LanguagePlatform.PHP:
+        return Platforms.PhpGenericLibV2;
+      case LanguagePlatform.PYTHON:
+        return Platforms.PythonGenericLib;
+      case LanguagePlatform.RUBY:
+        return Platforms.RubyGenericLib;
+      case LanguagePlatform.TYPESCRIPT:
+        return Platforms.TsGenericLib;
+      case LanguagePlatform.GO:
+        return Platforms.GoGenericLib;
+      default:
+        throw new Error(`Unknown LanguagePlatform: ${languagePlatform}`);
+    }
   }
 }

src/actions/sdk/generate.ts

@@ -151,7 +151,7 @@ export class PortalRecipeGenerator {
     generatedRecipeScript: string,
     generatedRecipeScriptsDirectoryPath: string,
     recipeFileName: string,
-    format: boolean = true
+    format: boolean = false
   ): Promise<void> {
     if (format) {
       generatedRecipeScript = await this.formatScript(generatedRecipeScript);
@@ -170,7 +170,7 @@ export class PortalRecipeGenerator {
   }
 
   private addContentStepToScript(contentConfig: ContentStepConfig): string {
-    return `return workflowCtx.showContent(\`${contentConfig.content}\`);`;
+    return `return workflowCtx.showContent(${JSON.stringify(contentConfig.content)});`;
   }
 
   private addEndpointStepToScript(endpointConfig: EndpointStepConfig): string {

src/application/portal/recipe/recipe-generator.ts

@@ -45,7 +45,7 @@ export class SDKClient {
 
     await setAuthInfo(email, authKey, isTelemetryOptedOut, new DirectoryPath(configDir));
 
-    return "✅ Logged in successfully as " + email;
+    return "Logged in successfully as " + email;
   }
 
   public async logout(configDir: string): Promise<string> {

src/client-utils/sdk-client.ts

@@ -8,7 +8,7 @@ const DEFAULT_WORKING_DIRECTORY = "./";
 
 export class PortalGenerate extends Command {
   static description =
-    "Generate and download a static API Documentation portal. Requires an input directory containing API specifications, a config file and optionally, markdown guides. For details, refer to the [documentation](https://docs.apimatic.io/platform-api/#/http/guides/generating-on-prem-api-portal/build-file-reference)";
+    "Generate an API Documentation portal. Requires an input directory containing API specifications, a config file and optionally, markdown guides. For details, refer to the [documentation](https://docs.apimatic.io/platform-api/#/http/guides/generating-on-prem-api-portal/build-file-reference)";
 
   static flags = {
     ...FlagsProvider.input,