add user-agent

Author: gmethvin

src/config.ts

@@ -1,16 +1,29 @@
-import { logger } from "@iterable/api";
+import { IterableClient, logger } from "@iterable/api";
 
 import { CliError } from "./errors.js";
 import { getKeyManager } from "./key-manager.js";
 import { isTestEnv } from "./utils/cli-env.js";
-import { COMMAND_NAME } from "./utils/command-info.js";
+import { COMMAND_NAME, PACKAGE_VERSION } from "./utils/command-info.js";
 import { sanitizeString } from "./utils/sanitize.js";
 
 export interface CliConfig {
   readonly apiKey: string;
   readonly baseUrl: string;
 }
 
+export function createClient(config: CliConfig): IterableClient {
+  const debug =
+    process.env.ITERABLE_DEBUG === "true" ||
+    process.env.ITERABLE_DEBUG_VERBOSE === "true";
+  return new IterableClient({
+    apiKey: config.apiKey,
+    baseUrl: config.baseUrl,
+    debug,
+    debugVerbose: process.env.ITERABLE_DEBUG_VERBOSE === "true",
+    customHeaders: { "User-Agent": `iterable-cli/${PACKAGE_VERSION}` },
+  });
+}
+
 /**
  * Load configuration.
  *

src/index.ts

@@ -1,11 +1,10 @@
 #!/usr/bin/env node
 
-import { IterableClient } from "@iterable/api";
 import chalk from "chalk";
 import { readFileSync } from "fs";
 import { z } from "zod";
 
-import { loadCliConfig } from "./config.js";
+import { createClient, loadCliConfig } from "./config.js";
 import { CliError, UsageError } from "./errors.js";
 import { formatOutput, getDefaultFormat } from "./output.js";
 import { buildParser, parseCommand } from "./parser.js";
@@ -77,15 +76,7 @@ async function main(): Promise<void> {
   }
 
   const config = await loadCliConfig(parsed.globalFlags.key);
-  const debug =
-    process.env.ITERABLE_DEBUG === "true" ||
-    process.env.ITERABLE_DEBUG_VERBOSE === "true";
-  const client = new IterableClient({
-    apiKey: config.apiKey,
-    baseUrl: config.baseUrl,
-    debug,
-    debugVerbose: process.env.ITERABLE_DEBUG_VERBOSE === "true",
-  });
+  const client = createClient(config);
 
   try {
     let restArgs = parsed.rest;

src/keys-cli.ts

@@ -1,9 +1,8 @@
 /* eslint-disable no-console */
-import { IterableClient } from "@iterable/api";
 import chalk from "chalk";
 import inquirer from "inquirer";
 
-import { loadCliConfig } from "./config.js";
+import { createClient, loadCliConfig } from "./config.js";
 import type { ApiKeyMetadata, KeyManager } from "./key-manager.js";
 import { getKeyManager } from "./key-manager.js";
 import { getSpinner, isTestEnv } from "./utils/cli-env.js";
@@ -468,15 +467,7 @@ export async function handleKeysCommand(
       spinner.start("Validating API connection...");
       try {
         const config = await loadCliConfig(keyOverride);
-        const debug =
-          process.env.ITERABLE_DEBUG === "true" ||
-          process.env.ITERABLE_DEBUG_VERBOSE === "true";
-        const client = new IterableClient({
-          apiKey: config.apiKey,
-          baseUrl: config.baseUrl,
-          debug,
-          debugVerbose: process.env.ITERABLE_DEBUG_VERBOSE === "true",
-        });
+        const client = createClient(config);
         try {
           await client.getUserFields();
           spinner.succeed("API connection successful");