fix: update user-agent format in api calls (#135)

Author: Shield-Jaguar

src/commands/portal/copilot.ts

@@ -32,11 +32,11 @@ export default class PortalCopilotEnable extends Command {
 
   async run(): Promise<void> {
     const {
-      flags: { folder, "auth-key": authKey, disable, 'welcome-message': welcomeMessage}
+      flags: { input, "auth-key": authKey, disable, 'welcome-message': welcomeMessage}
     } = await this.parse(PortalCopilotEnable);
 
-    const workingDirectory = new DirectoryPath(folder ?? DEFAULT_WORKING_DIRECTORY);
-    const buildDirectory = folder ? new DirectoryPath(folder, "src") : workingDirectory.join("src");
+    const workingDirectory = new DirectoryPath(input ?? DEFAULT_WORKING_DIRECTORY);
+    const buildDirectory = input ? new DirectoryPath(input, "src") : workingDirectory.join("src");
     const copilotConfigAction = new CopilotAction(new DirectoryPath(this.config.configDir), authKey);
     const result = await copilotConfigAction.execute(buildDirectory, welcomeMessage, !disable);
     result.map((message) => this.prompts.logError(message));

src/commands/portal/generate.ts

@@ -32,11 +32,11 @@ export class PortalGenerate extends Command {
 
   async run(): Promise<void> {
     const {
-      flags: { folder, destination, force, zip: zipPortal, "auth-key": authKey }
+      flags: { input, destination, force, zip: zipPortal, "auth-key": authKey }
     } = await this.parse(PortalGenerate);
 
-    const workingDirectory = new DirectoryPath(folder ?? DEFAULT_WORKING_DIRECTORY);
-    const buildDirectory = folder ? new DirectoryPath(folder, "src") : workingDirectory.join("src");
+    const workingDirectory = new DirectoryPath(input ?? DEFAULT_WORKING_DIRECTORY);
+    const buildDirectory = input ? new DirectoryPath(input, "src") : workingDirectory.join("src");
     const portalDirectory = destination ? new DirectoryPath(destination) : workingDirectory.join("portal");
 
     const action = new GenerateAction(this.getConfigDir(), authKey);

src/infrastructure/env-info.ts

@@ -4,7 +4,6 @@ import { dirname, join } from "path";
 import fs from "fs-extra";
 
 class EnvInfo {
-
   private static cachedCliVersion: string | null = null;
   private static cachedUserAgent: string | null = null;
 
@@ -13,12 +12,12 @@ class EnvInfo {
       const osInfo = `${os.platform()} ${os.release()}`;
       const engine = "Node.js";
       const engineVersion = process.version;
-      EnvInfo.cachedUserAgent = `APIMATIC CLI - [OS: ${osInfo}, Engine: ${engine}/${engineVersion}]`;
+      EnvInfo.cachedUserAgent = `APIMATIC CLI/${this.getCLIVersion()} - (OS: ${osInfo}, Engine: ${engine}/${engineVersion})`;
     }
     return EnvInfo.cachedUserAgent;
   }
 
-  public  getCLIVersion(): string {
+  public getCLIVersion(): string {
     if (EnvInfo.cachedCliVersion) {
       return EnvInfo.cachedCliVersion;
     }

src/infrastructure/services/portal-service.ts

@@ -1,6 +1,4 @@
-import * as os from "os";
 import fs from "fs-extra";
-import process from "process";
 import {
   ContentType,
   DocsPortalManagementController,
@@ -26,6 +24,7 @@ import { Sdl } from "../../types/sdl/sdl.js";
 import { FilePath } from "../../types/file/filePath.js";
 import { DirectoryPath } from "../../types/file/directoryPath.js";
 import { FileService } from "../file-service.js";
+import { envInfo } from "../env-info.js";
 
 export class PortalService {
   private readonly CONTENT_TYPE = ContentType.EnumMultipartformdata;
@@ -121,20 +120,12 @@ export class PortalService {
     return `X-Auth-Key ${key ?? ""}`;
   };
 
-  private getUserAgent(): string {
-    const osInfo = `${os.platform()} ${os.release()}`;
-    const engine = "Node.js";
-    const engineVersion = process.version;
-
-    return `APIMATIC CLI - [OS: ${osInfo}, Engine: ${engine}/${engineVersion}]`;
-  }
-
   private createApiClient = (authorizationHeader: string): Client => {
     return new Client({
       customHeaderAuthenticationCredentials: {
         Authorization: authorizationHeader
       },
-      userAgent: this.getUserAgent(),
+      userAgent: envInfo.getUserAgent(),
       timeout: this.TIMEOUT
     });
   };
@@ -196,4 +187,4 @@ export class PortalService {
       );
     }
   };
-}
+}