style: rename apiKey input arg to serviceKey (#162)

Author: wrn14897

.changeset/spicy-waves-rule.md

@@ -0,0 +1,5 @@
+---
+'@hyperdx/cli': patch
+---
+
+style: rename apiKey input arg to serviceKey

packages/cli/README.md

@@ -5,7 +5,7 @@
 In your build pipeline, you will need to run the CLI tool. Here's how to run it:
 
 ```sh
-npx @hyperdx/cli upload-sourcemaps --path="/path/to/sourcemaps" --apiKey="your-api-key"
+npx @hyperdx/cli upload-sourcemaps --path="/path/to/sourcemaps" --serviceKey="your-service-account-api-key"
 ```
 
 You can also add this as an npm script
@@ -20,7 +20,7 @@ You can also add this as an npm script
 }
 ```
 
-Optionally, you can set the `HYPERDX_API_ACCESS_KEY` environment variable to avoid passing the `apiKey` flag.
+Optionally, you can set the `HYPERDX_SERVICE_KEY` environment variable to avoid passing the `serviceKey` flag.
 
 ## Contributing
 

packages/cli/src/index.ts

@@ -6,7 +6,7 @@ program.name('@hyperdx/cli').description('HyperDX Command Line Interface');
 
 program
   .command('upload-sourcemaps')
-  .option('-k, --apiKey <string>', 'The HyperDX personal api access key')
+  .option('-k, --serviceKey <string>', 'The HyperDX service account API key')
   .option(
     '-u, --apiUrl [string]',
     'An optional api url for self-hosted deployments',

packages/cli/src/lib.ts

@@ -9,24 +9,24 @@ const pj = require('../package.json');
 
 export const uploadSourcemaps = async ({
   allowNoop,
-  apiKey,
+  serviceKey,
   apiUrl,
   basePath,
   path,
   releaseId,
 }: {
   allowNoop?: boolean;
-  apiKey: string;
+  serviceKey: string;
   apiUrl?: string;
   basePath?: string;
   path: string;
   releaseId?: string;
 }) => {
-  if (!apiKey || apiKey === '') {
-    if (process.env.HYPERDX_API_ACCESS_KEY) {
-      apiKey = process.env.HYPERDX_API_ACCESS_KEY;
+  if (!serviceKey || serviceKey === '') {
+    if (process.env.HYPERDX_SERVICE_KEY) {
+      serviceKey = process.env.HYPERDX_SERVICE_KEY;
     } else {
-      throw new Error('api key cannot be empty');
+      throw new Error('service key cannot be empty');
     }
   }
 
@@ -36,7 +36,7 @@ export const uploadSourcemaps = async ({
     method: 'get',
     headers: {
       'Content-Type': 'application/json',
-      Authorization: `Bearer ${apiKey}`,
+      Authorization: `Bearer ${serviceKey}`,
     },
   })
     .then((response) => response.json())
@@ -49,7 +49,7 @@ export const uploadSourcemaps = async ({
 
   const teamId = res?.user?.team;
   if (!teamId) {
-    throw new Error('invalid api key');
+    throw new Error('invalid service key');
   }
 
   console.info(`Starting to upload source maps from ${path}`);
@@ -76,7 +76,7 @@ export const uploadSourcemaps = async ({
       method: 'post',
       headers: {
         'Content-Type': 'application/json',
-        Authorization: `Bearer ${apiKey}`,
+        Authorization: `Bearer ${serviceKey}`,
       },
       body: JSON.stringify({
         pkgVersion: pj.version,