@indigoai-us/hq-cli 5.275.0 → 5.277.0

package/dist/utils/cli-telemetry.js

@@ -1,23 +1,117 @@
+import { randomUUID } from "node:crypto";
 import * as fs from "node:fs";
 import * as os from "node:os";
 import * as path from "node:path";
 import { CLI_VERSION } from "../cli-version.js";
-import { isExpiring, isMachineIdentity, loadCachedTokens, } from "./cognito-session.js";
+import { isExpiring, isMachineIdentity, loadCachedTokens, loadMachineCachedTokens, } from "./cognito-session.js";
+import { resolveProcessFlagGate } from "../lib/flag-registry.js";
 import { vaultApiFetch } from "./vault-api.js";
 import { firstSyncStepTelemetryProperties, isFirstSyncNextStepEnabled, isHumanInteractiveCliSession, } from "../lib/first-sync-next-step.js";
 export { CLI_FIRST_SYNC_NEXT_STEP_FLAG, FIRST_SYNC_CONFIRMATION_COPY, FIRST_SYNC_NEXT_STEP_COPY, claimFirstSyncStepMarker, firstSyncStepMarkerPaths, firstSyncStepTelemetryProperties, isFirstSyncNextStepEnabled, isHumanInteractiveCliSession, isWorkBearingSyncResult, maybeShowFirstSyncNextStep, recordFirstWorkBearingSync, shouldConfirmFirstWorkBearingSync, shouldShowFirstSyncNextStep, takeFirstSyncStepOutcomes, } from "../lib/first-sync-next-step.js";
 export const TELEMETRY_TIMEOUT_MS = 1_200;
 /**
  * Exact stderr line printed once on the first signed-in TTY run that is not
- * `--json`. Keep this notice and its marker stable for the default telemetry
- * path; first-sync fields have a separate opt-in disclosure below.
+ * `--json`. Keep this notice and its marker stable for session telemetry;
+ * first-sync and feature-used fields have separate opt-in disclosures below.
  */
 export const TELEMETRY_DISCLOSURE_LINE = "HQ sends a usage event when you run a signed-in command (CLI version and a timestamp, never command names, file contents, or secrets) to improve the CLI. Set HQ_TELEMETRY=0 to turn this off.";
 export const FIRST_SYNC_TELEMETRY_DISCLOSURE_LINE = "HQ sends a usage event when you run a signed-in command (CLI version and a timestamp; when enabled, first-sync guidance shown or followed and the flag key cli.first-sync-next-step; never command names, file contents, or secrets) to improve the CLI. Set HQ_TELEMETRY=0 to turn this off.";
+export const CLI_FEATURE_USED_TELEMETRY_FLAG = "cli.feature-used-telemetry-v1";
+export const CLI_FEATURE_USED_TELEMETRY_DISCLOSURE_LINE = "HQ sends a feature-use event when you run a supported CLI feature (feature kind and outcome, plus your company UID when available; never command names, file contents, or secrets). The hq-flags key cli.feature-used-telemetry-v1 controls these events. Set HQ_TELEMETRY=0 to turn this off.";
 const TELEMETRY_DISABLED_VALUES = new Set(["0", "false", "off"]);
 const DISCLOSURE_MARKER = "cli-telemetry-disclosed";
 const FIRST_SYNC_DISCLOSURE_MARKER = "cli-telemetry-disclosed-first-sync-v1";
+const FEATURE_USED_DISCLOSURE_MARKER = "cli-telemetry-disclosed-feature-used-v1";
 let cliSessionStartedPromise;
+const pendingPlanLimitInviteTeammateExposures = [];
+/** Queue one exposure after the CLI has printed the invite suggestion. */
+export function queuePlanLimitInviteTeammateExposure(companyUid) {
+    const normalizedCompanyUid = companyUid.trim();
+    if (normalizedCompanyUid.length === 0)
+        return;
+    pendingPlanLimitInviteTeammateExposures.push(normalizedCompanyUid);
+}
+/** Drain invite-suggestion exposures for the bounded command-finalization flush. */
+export function takePlanLimitInviteTeammateExposures() {
+    return pendingPlanLimitInviteTeammateExposures.splice(0, pendingPlanLimitInviteTeammateExposures.length);
+}
+const COMPANY_UID_PATTERN = /^cmp_[A-Za-z0-9_-]{1,128}$/;
+/**
+ * Emit one bounded, privacy-limited feature-use event with a cached identity.
+ * It never refreshes credentials or turns telemetry failure into command failure.
+ */
+export async function emitCliFeatureUsed(usage, timeoutMs = TELEMETRY_TIMEOUT_MS) {
+    try {
+        // Unit tests may run with a real cached user/agent token on the host. Never
+        // let their command fixtures write telemetry to a live account.
+        if (process.env.NODE_ENV === "test")
+            return;
+        if (isCliTelemetryDisabled() || !isCliFeatureUsedTelemetryEnabled())
+            return;
+        const machineIdentity = isMachineIdentity();
+        const cached = machineIdentity ? loadMachineCachedTokens() : loadCachedTokens();
+        if (!cached || isExpiring(cached, 120))
+            return;
+        const token = machineIdentity ? cached.idToken : cached.accessToken;
+        if (!token)
+            return;
+        const consentBasis = maybeDiscloseFeatureUsedTelemetry() ? "disclosed" : "no-consent";
+        const controller = new AbortController();
+        const timeout = setTimeout(() => controller.abort(), timeoutMs);
+        const companyUid = usage.companyUid && COMPANY_UID_PATTERN.test(usage.companyUid)
+            ? usage.companyUid
+            : undefined;
+        try {
+            await vaultApiFetch({
+                token,
+                path: "/v1/telemetry/events",
+                method: "POST",
+                body: {
+                    events: [
+                        {
+                            eventName: "cli_feature_used",
+                            app: "hq-cli",
+                            source: "cli",
+                            occurredAt: new Date().toISOString(),
+                            consentBasis,
+                            schemaVersion: 1,
+                            ...(companyUid ? { companyUid } : {}),
+                            properties: { kind: usage.kind, outcome: usage.outcome },
+                        },
+                    ],
+                },
+                signal: controller.signal,
+            });
+        }
+        catch {
+            // Feature telemetry is best effort and must never affect the CLI action.
+        }
+        finally {
+            clearTimeout(timeout);
+        }
+    }
+    catch {
+        // Cached-token reads are also best effort (for example, a malformed cache).
+    }
+}
+/** Run one action and emit exactly one success/failure event without masking errors. */
+export async function withCliFeatureUsed(kind, action, companyUid) {
+    let outcome = "success";
+    try {
+        return await action();
+    }
+    catch (err) {
+        outcome = "failure";
+        throw err;
+    }
+    finally {
+        await emitCliFeatureUsed({
+            kind,
+            outcome,
+            ...(companyUid ? { companyUid } : {}),
+        });
+    }
+}
 /**
  * `HQ_TELEMETRY=0` (also `false` and `off`, case-insensitive) disables every
  * CLI POST to `/v1/telemetry/events`. `HQ_TELEMETRY_TIMEOUT_MS` is unchanged.
@@ -28,6 +122,10 @@ export function isCliTelemetryDisabled(env = process.env) {
         return false;
     return TELEMETRY_DISABLED_VALUES.has(raw);
 }
+/** Feature-use collection stays off until the HQ flag is explicitly enabled. */
+export function isCliFeatureUsedTelemetryEnabled() {
+    return resolveProcessFlagGate(CLI_FEATURE_USED_TELEMETRY_FLAG, { fallback: false }, () => false);
+}
 function hqConfigDir() {
     const home = process.env.HOME?.trim() || os.homedir();
     return path.join(home, ".hq");
@@ -38,6 +136,9 @@ export function telemetryDisclosureMarkerPath() {
 function firstSyncTelemetryDisclosureMarkerPath() {
     return path.join(hqConfigDir(), FIRST_SYNC_DISCLOSURE_MARKER);
 }
+function featureUsedTelemetryDisclosureMarkerPath() {
+    return path.join(hqConfigDir(), FEATURE_USED_DISCLOSURE_MARKER);
+}
 function wantsJsonOutput(argv = process.argv) {
     return argv.includes("--json");
 }
@@ -75,6 +176,9 @@ export function maybeDiscloseCliTelemetry(stderr = process.stderr, stdout = proc
 function maybeDiscloseFirstSyncTelemetry() {
     return maybeDiscloseTelemetry(FIRST_SYNC_TELEMETRY_DISCLOSURE_LINE, firstSyncTelemetryDisclosureMarkerPath());
 }
+function maybeDiscloseFeatureUsedTelemetry() {
+    return maybeDiscloseTelemetry(CLI_FEATURE_USED_TELEMETRY_DISCLOSURE_LINE, featureUsedTelemetryDisclosureMarkerPath());
+}
 function maybeDiscloseTelemetry(line, markerPath, stderr = process.stderr, stdout = process.stdout, argv = process.argv) {
     if (hasShownDisclosure(markerPath))
         return true;
@@ -207,4 +311,75 @@ export async function emitCliFirstSyncNextStepOutcome(outcome, timeoutMs = TELEM
         // Cached-token reads are also best effort (for example, a malformed cache).
     }
 }
+/** Emit one company-scoped event for a printed invite-teammate suggestion. */
+function logPlanLimitInviteTeammateExposureFailure(cause, status) {
+    const errorClass = cause instanceof Error ? cause.name : "unknown";
+    const result = status === undefined ? errorClass : `http_${status}`;
+    console.error(`hq: Could not send invite-teammate exposure telemetry (${result}).`);
+}
+export async function emitPlanLimitInviteTeammateExposure(companyUid, timeoutMs = TELEMETRY_TIMEOUT_MS) {
+    try {
+        if (isCliTelemetryDisabled())
+            return;
+        const cached = loadCachedTokens();
+        const machineIdentity = isMachineIdentity();
+        if (!cached ||
+            isExpiring(cached, 120) ||
+            !isHumanInteractiveCliSession({
+                stdoutIsTTY: Boolean(process.stdout.isTTY),
+                argv: process.argv,
+                env: process.env,
+                machineIdentity,
+            })) {
+            return;
+        }
+        const token = cached.accessToken;
+        if (!token)
+            return;
+        const controller = new AbortController();
+        const timeout = setTimeout(() => controller.abort(), timeoutMs);
+        try {
+            const response = await vaultApiFetch({
+                token,
+                path: "/v1/telemetry/events",
+                method: "POST",
+                body: {
+                    events: [
+                        {
+                            eventName: "plan_limit_prompt_exposed",
+                            app: "hq-cli",
+                            source: "cli",
+                            occurredAt: new Date().toISOString(),
+                            consentBasis: "no-consent",
+                            schemaVersion: 2,
+                            companyUid,
+                            idempotencyKey: randomUUID(),
+                            properties: {
+                                surface: "cli_whoami_plan_limit",
+                                resourceKind: "users",
+                                presentationKind: "advisory",
+                                exposureId: randomUUID(),
+                            },
+                        },
+                    ],
+                },
+                signal: controller.signal,
+            });
+            if (!response.ok) {
+                logPlanLimitInviteTeammateExposureFailure(undefined, response.status);
+            }
+        }
+        catch (error) {
+            // This measurement is best-effort and must not affect the CLI command.
+            logPlanLimitInviteTeammateExposureFailure(error);
+        }
+        finally {
+            clearTimeout(timeout);
+        }
+    }
+    catch (error) {
+        // Cached-token reads and identity checks are best-effort too.
+        logPlanLimitInviteTeammateExposureFailure(error);
+    }
+}
 //# sourceMappingURL=cli-telemetry.js.map

package/dist/utils/hq-root-resolver.d.ts

@@ -0,0 +1,13 @@
+/** Lightweight HQ-root resolver shared by cloud commands and fast flag scope. */
+/**
+ * Resolve the HQ tree root using the same precedence as the Cognito helpers:
+ * explicit HQ_ROOT, nearest cwd root, installer records, known locations, then
+ * the historical ~/hq fallback (or an error when requested).
+ */
+export declare function resolveDefaultHqRoot(opts?: {
+    onMissing?: "throw" | "fallback";
+    env?: NodeJS.ProcessEnv;
+    cwd?: string;
+    home?: string;
+}): string;
+//# sourceMappingURL=hq-root-resolver.d.ts.map

package/dist/utils/hq-root-resolver.js

@@ -0,0 +1,103 @@
+/** Lightweight HQ-root resolver shared by cloud commands and fast flag scope. */
+import * as fs from "node:fs";
+import * as os from "node:os";
+import * as path from "node:path";
+import * as yaml from "js-yaml";
+/**
+ * Resolve the HQ tree root using the same precedence as the Cognito helpers:
+ * explicit HQ_ROOT, nearest cwd root, installer records, known locations, then
+ * the historical ~/hq fallback (or an error when requested).
+ */
+export function resolveDefaultHqRoot(opts = {}) {
+    const env = opts.env ?? process.env;
+    const home = opts.home ?? os.homedir();
+    if (env.HQ_ROOT)
+        return path.resolve(env.HQ_ROOT);
+    let cur = path.resolve(opts.cwd ?? process.cwd());
+    while (cur !== path.dirname(cur)) {
+        if (isHqRoot(cur))
+            return cur;
+        cur = path.dirname(cur);
+    }
+    const fromConfig = readHqRootFromHqConfig(path.join(home, ".hq"));
+    if (fromConfig)
+        return path.resolve(fromConfig);
+    const discovered = discoverHqRootViaCoreYaml(home);
+    if (discovered)
+        return discovered;
+    if (opts.onMissing === "throw") {
+        throw new Error("Could not find HQ root. Run this command from within your HQ directory " +
+            "(must contain core.yaml AND a companies/ subdirectory), set $HQ_ROOT, " +
+            "or install HQ via the installer/menubar so ~/.hq/menubar.json records " +
+            "its location.");
+    }
+    return path.join(home, "hq");
+}
+function readHqRootFromHqConfig(hqConfigDir) {
+    const fromMenubar = readJsonStringField(path.join(hqConfigDir, "menubar.json"), "hqPath");
+    if (fromMenubar)
+        return fromMenubar;
+    return readJsonStringField(path.join(hqConfigDir, "config.json"), "hqFolderPath");
+}
+function readJsonStringField(file, field) {
+    try {
+        const parsed = JSON.parse(fs.readFileSync(file, "utf-8"));
+        const value = parsed[field];
+        return typeof value === "string" && value.length > 0 ? value : undefined;
+    }
+    catch {
+        return undefined;
+    }
+}
+function hqDiscoveryCandidates(home) {
+    return [
+        path.join(home, "HQ"),
+        path.join(home, "hq"),
+        path.join(home, "Documents", "HQ"),
+        path.join(home, "Documents", "hq"),
+        path.join(home, "Desktop", "HQ"),
+        path.join(home, "Desktop", "hq"),
+    ];
+}
+function discoverHqRootViaCoreYaml(home) {
+    return hqDiscoveryCandidates(home).find(isValidHqRootSignature);
+}
+function isValidHqRootSignature(dir) {
+    const canonical = path.join(dir, "core", "core.yaml");
+    const legacy = path.join(dir, "core.yaml");
+    let file;
+    if (fileExists(canonical))
+        file = canonical;
+    else if (fileExists(legacy))
+        file = legacy;
+    else
+        return false;
+    try {
+        const parsed = yaml.load(fs.readFileSync(file, "utf-8"));
+        return !!parsed && typeof parsed === "object" && "version" in parsed && "hqVersion" in parsed;
+    }
+    catch {
+        return false;
+    }
+}
+function fileExists(file) {
+    try {
+        return fs.statSync(file).isFile();
+    }
+    catch {
+        return false;
+    }
+}
+function isHqRoot(dir) {
+    const hasCoreYaml = fileExists(path.join(dir, "core", "core.yaml")) ||
+        fileExists(path.join(dir, "core.yaml"));
+    if (!hasCoreYaml)
+        return false;
+    try {
+        return fs.statSync(path.join(dir, "companies")).isDirectory();
+    }
+    catch {
+        return false;
+    }
+}
+//# sourceMappingURL=hq-root-resolver.js.map

package/dist/utils/scaffold-fast-import-guard.js

@@ -4,6 +4,8 @@ export function forbiddenFastPathModules(loadedModules, distDirectory) {
     const dist = path.resolve(distDirectory);
     const main = path.join(dist, "main.js");
     const commands = `${path.join(dist, "commands")}${path.sep}`;
+    const flagRegistry = path.join(dist, "lib", "flag-registry.js");
+    const coreCommand = path.join(dist, "commands", "core.js");
     return [...new Set(loadedModules.map((loaded) => {
             if (loaded.startsWith("file:")) {
                 try {
@@ -16,7 +18,10 @@ export function forbiddenFastPathModules(loadedModules, distDirectory) {
             return path.resolve(loaded);
         }))]
         .filter((loaded) => path.resolve(loaded) === main ||
-        path.resolve(loaded).startsWith(commands))
+        path.resolve(loaded).startsWith(commands) ||
+        path.resolve(loaded) === flagRegistry ||
+        path.resolve(loaded) === coreCommand ||
+        path.resolve(loaded).includes(`${path.sep}node_modules${path.sep}@sentry${path.sep}node${path.sep}`))
         .sort();
 }
 export function assertFastPathStaysCommandGraphFree(loadedModules, distDirectory) {

package/dist/utils/vault-api.d.ts

@@ -47,6 +47,13 @@ export declare function rewritePathForApiKey(path: string): string | null;
  * authorization or request signing depends on it.
  */
 export declare const HQ_CLIENT_NAME = "@indigoai-us/hq-cli";
+type VaultApiRequestTargetOptions = Pick<VaultApiOptions, "baseUrl" | "token" | "path" | "query">;
+/**
+ * Run vaultApiFetch's synchronous, client-side request checks without sending
+ * the request. Commands with prior uploads use this to fail before creating
+ * objects that a later local refusal would leave orphaned.
+ */
+export declare function assertVaultApiRequestSupported(opts: VaultApiRequestTargetOptions): void;
 export declare function vaultApiFetch(opts: VaultApiOptions): Promise<Response>;
 /**
  * Public (NONE-auth) GET against the vault API — no bearer token. The
@@ -77,4 +84,5 @@ export declare function getEntityUid(token: string, opts: {
 }, options?: {
     allowOfflineScopeFallback?: boolean;
 }): Promise<string>;
+export {};
 //# sourceMappingURL=vault-api.d.ts.map

package/dist/utils/vault-api.js

@@ -155,7 +155,7 @@ export function rewritePathForApiKey(path) {
  * authorization or request signing depends on it.
  */
 export const HQ_CLIENT_NAME = "@indigoai-us/hq-cli";
-export async function vaultApiFetch(opts) {
+function resolveVaultApiRequestTarget(opts) {
     let path = opts.path;
     if (opts.token.startsWith("hqk_")) {
         const rewritten = rewritePathForApiKey(path);
@@ -172,6 +172,18 @@ export async function vaultApiFetch(opts) {
             url.searchParams.set(k, v);
         }
     }
+    return { path, url };
+}
+/**
+ * Run vaultApiFetch's synchronous, client-side request checks without sending
+ * the request. Commands with prior uploads use this to fail before creating
+ * objects that a later local refusal would leave orphaned.
+ */
+export function assertVaultApiRequestSupported(opts) {
+    resolveVaultApiRequestTarget(opts);
+}
+export async function vaultApiFetch(opts) {
+    const { path, url } = resolveVaultApiRequestTarget(opts);
     const method = opts.method ?? 'GET';
     const safeUrl = url.search ? `${url.origin}${url.pathname}?<redacted>` : `${url.origin}${url.pathname}`;
     Sentry.addBreadcrumb({

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@indigoai-us/hq-cli",
-  "version": "5.275.0",
+  "version": "5.277.0",
   "description": "HQ by Indigo management CLI — modules and cloud sync",
   "main": "dist/index.js",
   "bin": {
@@ -44,7 +44,7 @@
   "dependencies": {
     "@aws-sdk/client-iot-data-plane": "^3.1096.0",
     "@aws-sdk/client-s3": "^3.1049.0",
-    "@indigoai-us/hq-cloud": "~6.18.10",
+    "@indigoai-us/hq-cloud": "~6.18.13",
     "@indigoai-us/hq-flags-client": "^0.1.2",
     "@sentry/node": "^10.49.0",
     "@tobilu/qmd": "2.5.3",