highspot-cli 0.2.0 → 0.2.1

package/README.md

@@ -31,6 +31,12 @@ export HIGHSPOT_API_KEY_ID=hs_key_id_xxx
 export HIGHSPOT_API_KEY_SECRET=hs_key_secret_xxx
 ```
 
+Or provide a precomputed Basic auth header directly:
+
+```bash
+export HIGHSPOT_BASIC_AUTH="Basic <base64(id:secret)>"
+```
+
 Optional:
 
 ```bash
@@ -44,6 +50,10 @@ It is not implied by the API key:
 - `hs-user` sets an explicit user context for requests where impersonation is needed.
 - CLI flag precedence still applies, so `--hs-user` overrides `HIGHSPOT_HS_USER`.
 
+Auth precedence:
+- `HIGHSPOT_BASIC_AUTH` is used directly when set.
+- Otherwise, `HIGHSPOT_API_KEY_ID` + `HIGHSPOT_API_KEY_SECRET` are used to compute `Authorization: Basic ...`.
+
 ## Config Files
 
 Config precedence (highest to lowest):
@@ -63,6 +73,7 @@ Example `.highspot-cli.json`:
   "maxRetries": 3,
   "retryDelayMs": 1200,
   "timeoutMs": 30000,
+  "basicAuth": "Basic <base64(id:secret)>",
   "apiKeyId": "hs_key_id_xxx",
   "apiKeySecret": "hs_key_secret_xxx"
 }

package/dist/lib/api.js

@@ -1,4 +1,3 @@
-import { Buffer } from "node:buffer";
 const TEXTUAL_CONTENT_TYPE_HINTS = [
     "application/xml",
     "application/xhtml+xml",
@@ -40,7 +39,7 @@ export class HighspotClient {
     #retryDelayMs;
     #timeoutMs;
     constructor(config) {
-        this.#authorizationHeader = `Basic ${Buffer.from(`${config.apiKeyId}:${config.apiKeySecret}`).toString("base64")}`;
+        this.#authorizationHeader = config.authorizationHeader;
         this.#endpoint = sanitizeEndpoint(config.endpoint);
         this.#hsUser = config.hsUser;
         this.#maxRetries = config.maxRetries;

package/dist/lib/command.js

@@ -54,7 +54,7 @@ export class BaseCommand extends Command {
         if (error instanceof ConfigError) {
             writeError(mode, {
                 error: error.message,
-                hint: "Set HIGHSPOT_API_KEY_ID and HIGHSPOT_API_KEY_SECRET, or configure .highspot-cli.json.",
+                hint: "Set HIGHSPOT_BASIC_AUTH, or set HIGHSPOT_API_KEY_ID and HIGHSPOT_API_KEY_SECRET, or configure .highspot-cli.json.",
             });
             this.exit(2);
         }

package/dist/lib/config.js

@@ -1,3 +1,4 @@
+import { Buffer } from "node:buffer";
 import { existsSync, readFileSync } from "node:fs";
 import { join } from "node:path";
 export class ConfigError extends Error {
@@ -43,6 +44,9 @@ function normalize(config) {
         maxRetries: toInteger(config.maxRetries),
         retryDelayMs: toInteger(config.retryDelayMs),
         timeoutMs: toInteger(config.timeoutMs),
+        basicAuth: typeof config.basicAuth === "string"
+            ? config.basicAuth.trim()
+            : undefined,
         apiKeyId: typeof config.apiKeyId === "string" ? config.apiKeyId.trim() : undefined,
         apiKeySecret: typeof config.apiKeySecret === "string"
             ? config.apiKeySecret.trim()
@@ -77,10 +81,38 @@ function fromEnv() {
         maxRetries: process.env.HIGHSPOT_MAX_RETRIES,
         retryDelayMs: process.env.HIGHSPOT_RETRY_DELAY_MS,
         timeoutMs: process.env.HIGHSPOT_TIMEOUT_MS,
+        basicAuth: process.env.HIGHSPOT_BASIC_AUTH,
         apiKeyId: process.env.HIGHSPOT_API_KEY_ID,
         apiKeySecret: process.env.HIGHSPOT_API_KEY_SECRET,
     });
 }
+function normalizeAuthorizationHeader(value) {
+    const trimmed = value?.trim();
+    if (!trimmed) {
+        return undefined;
+    }
+    if (/^Basic\s+/i.test(trimmed)) {
+        return trimmed;
+    }
+    return `Basic ${trimmed}`;
+}
+function resolveAuthorizationHeader(config) {
+    const explicitBasicAuth = normalizeAuthorizationHeader(config.basicAuth);
+    if (explicitBasicAuth) {
+        return explicitBasicAuth;
+    }
+    if (!config.apiKeyId && !config.apiKeySecret) {
+        throw new ConfigError("Missing auth configuration. Set HIGHSPOT_BASIC_AUTH, or set both HIGHSPOT_API_KEY_ID and HIGHSPOT_API_KEY_SECRET.");
+    }
+    if (!config.apiKeyId) {
+        throw new ConfigError("Missing HIGHSPOT_API_KEY_ID. Set HIGHSPOT_BASIC_AUTH, or configure apiKeyId with apiKeySecret in .highspot-cli.json.");
+    }
+    if (!config.apiKeySecret) {
+        throw new ConfigError("Missing HIGHSPOT_API_KEY_SECRET. Set HIGHSPOT_BASIC_AUTH, or configure apiKeySecret with apiKeyId in .highspot-cli.json.");
+    }
+    const token = Buffer.from(`${config.apiKeyId}:${config.apiKeySecret}`).toString("base64");
+    return `Basic ${token}`;
+}
 function overlay(base, next) {
     return {
         ...base,
@@ -96,19 +128,13 @@ export function loadResolvedConfig(overrides = {}) {
     const maxRetries = toInteger(config.maxRetries) ?? DEFAULT_MAX_RETRIES;
     const retryDelayMs = toInteger(config.retryDelayMs) ?? DEFAULT_RETRY_DELAY_MS;
     const timeoutMs = toInteger(config.timeoutMs) ?? DEFAULT_TIMEOUT_MS;
-    if (!config.apiKeyId) {
-        throw new ConfigError("Missing HIGHSPOT_API_KEY_ID. Set env vars or configure apiKeyId in .highspot-cli.json.");
-    }
-    if (!config.apiKeySecret) {
-        throw new ConfigError("Missing HIGHSPOT_API_KEY_SECRET. Set env vars or configure apiKeySecret in .highspot-cli.json.");
-    }
+    const authorizationHeader = resolveAuthorizationHeader(config);
     return {
         endpoint: config.endpoint || DEFAULT_ENDPOINT,
         hsUser: config.hsUser,
         maxRetries,
         retryDelayMs,
         timeoutMs,
-        apiKeyId: config.apiKeyId,
-        apiKeySecret: config.apiKeySecret,
+        authorizationHeader,
     };
 }

package/dist/lib/help.js

@@ -1,5 +1,5 @@
 import { Help as OclifHelp } from "@oclif/core";
-const AUTH_TEXT = "Requires HIGHSPOT_API_KEY_ID and HIGHSPOT_API_KEY_SECRET via env or config file.";
+const AUTH_TEXT = "Requires HIGHSPOT_BASIC_AUTH, or HIGHSPOT_API_KEY_ID and HIGHSPOT_API_KEY_SECRET, via env or config file.";
 const CONFIG_TEXT = "Precedence: flags > env > project config (.highspot-cli.json) > user config (~/.config/highspot-cli/config.json) > system config.";
 export default class Help extends OclifHelp {
     formatRoot() {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "highspot-cli",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "description": "Agent-first CLI for the Highspot API",
   "license": "MIT",
   "author": "Advait Shinde",