forge-jsxy 1.0.66

package/assets/forge-explorer-favicon.svg

@@ -0,0 +1,31 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 32 32" role="img" aria-label="Forge-explorer">
+  <title>Forge-explorer</title>
+  <defs>
+    <linearGradient id="fe-folder" x1="0" y1="0" x2="0" y2="1">
+      <stop offset="0%" stop-color="#edd089"/>
+      <stop offset="55%" stop-color="#c9a052"/>
+      <stop offset="100%" stop-color="#8f6b2a"/>
+    </linearGradient>
+    <linearGradient id="fe-tab" x1="0" y1="0" x2="1" y2="0">
+      <stop offset="0%" stop-color="#4a4a4e"/>
+      <stop offset="100%" stop-color="#353538"/>
+    </linearGradient>
+  </defs>
+  <rect width="32" height="32" rx="7" fill="#1e1e1e"/>
+  <rect x="1.5" y="1.5" width="29" height="29" rx="6" fill="none" stroke="#3e3e42" stroke-width="1"/>
+  <!-- Remote folder: explorer folder palette (#dcb67a family) -->
+  <path
+    fill="url(#fe-tab)"
+    d="M7 9.5h5.2L14.2 11H25a1.2 1.2 0 011.2 1.2V13H6.8v-2.3A1.3 1.3 0 018.1 9.5z"/>
+  <path
+    fill="#2d2d30"
+    stroke="#5a4a32"
+    stroke-width="0.75"
+    d="M6.5 12.5h19a1 1 0 011 1v10.8a1.2 1.2 0 01-1.2 1.2H7.7a1.2 1.2 0 01-1.2-1.2V13.5a1 1 0 011-1z"/>
+  <path
+    fill="url(#fe-folder)"
+    d="M7.2 14.2h17.6a0.6 0.6 0 010.6v9.3a1 1 0 01-1 1H7.6a1 1 0 01-1-1v-8.3a1 1 0 011-1z"/>
+  <!-- Relay accent: VS Code button blue -->
+  <circle cx="23.5" cy="9.8" r="3.2" fill="#0078d4"/>
+  <circle cx="23.5" cy="9.8" r="1.35" fill="#f0f6fc"/>
+</svg>

package/dist/agentPid.d.ts

@@ -0,0 +1,14 @@
+export declare const AGENT_PID_BASENAME = "forge-js-agent.pid";
+export declare function agentPidFilePath(): string;
+/** First line: PID. Optional second line: canonical forge session id (newer agents). */
+export interface AgentPidFileContents {
+    pid: number | null;
+    sessionId: string | null;
+}
+export declare function readAgentPidFile(): AgentPidFileContents;
+export declare function readAgentPid(): number | null;
+export declare function isPidRunning(pid: number): boolean;
+export declare function isForgeAgentAlreadyRunning(): boolean;
+export declare function writeAgentPidFile(sessionId: string): void;
+export declare function removeAgentPidFile(): void;
+export declare function clearStaleAgentPidFile(): void;

package/dist/agentPid.js

@@ -0,0 +1,104 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AGENT_PID_BASENAME = void 0;
+exports.agentPidFilePath = agentPidFilePath;
+exports.readAgentPidFile = readAgentPidFile;
+exports.readAgentPid = readAgentPid;
+exports.isPidRunning = isPidRunning;
+exports.isForgeAgentAlreadyRunning = isForgeAgentAlreadyRunning;
+exports.writeAgentPidFile = writeAgentPidFile;
+exports.removeAgentPidFile = removeAgentPidFile;
+exports.clearStaleAgentPidFile = clearStaleAgentPidFile;
+const fs = __importStar(require("node:fs"));
+const path = __importStar(require("node:path"));
+const clientId_1 = require("./clientId");
+exports.AGENT_PID_BASENAME = "forge-js-agent.pid";
+function agentPidFilePath() {
+    return path.join((0, clientId_1.defaultCfgmgrDataDir)(), exports.AGENT_PID_BASENAME);
+}
+function readAgentPidFile() {
+    try {
+        const raw = fs.readFileSync(agentPidFilePath(), "utf8").replace(/\r\n/g, "\n");
+        const lines = raw
+            .split("\n")
+            .map((l) => l.trim())
+            .filter((l) => l.length > 0);
+        if (lines.length === 0)
+            return { pid: null, sessionId: null };
+        const n = parseInt(lines[0], 10);
+        const pid = Number.isFinite(n) && n > 0 ? n : null;
+        const sessionId = lines.length >= 2 ? lines[1] : null;
+        return { pid, sessionId };
+    }
+    catch {
+        return { pid: null, sessionId: null };
+    }
+}
+function readAgentPid() {
+    return readAgentPidFile().pid;
+}
+function isPidRunning(pid) {
+    try {
+        process.kill(pid, 0);
+        return true;
+    }
+    catch {
+        return false;
+    }
+}
+function isForgeAgentAlreadyRunning() {
+    const pid = readAgentPid();
+    return pid !== null && isPidRunning(pid);
+}
+function writeAgentPidFile(sessionId) {
+    const dir = (0, clientId_1.defaultCfgmgrDataDir)();
+    fs.mkdirSync(dir, { recursive: true });
+    fs.writeFileSync(agentPidFilePath(), `${process.pid}\n${String(sessionId || "").trim()}\n`, "utf8");
+}
+function removeAgentPidFile() {
+    try {
+        fs.unlinkSync(agentPidFilePath());
+    }
+    catch {
+        /* skip */
+    }
+}
+function clearStaleAgentPidFile() {
+    const { pid } = readAgentPidFile();
+    if (pid !== null && !isPidRunning(pid)) {
+        removeAgentPidFile();
+    }
+}

package/dist/agentRunner.d.ts

@@ -0,0 +1,13 @@
+export interface ForgeAgentCliOptions {
+    relayUrl: string;
+    sessionId: string;
+    password: string;
+    allowFilesystem: boolean;
+    quiet: boolean;
+    /** When true, allow starting even if another agent PID exists (use with care). */
+    force?: boolean;
+    /** Session was derived from persisted/generated client id (show hint once). */
+    announceSession?: boolean;
+}
+export declare function resolveForgeAgentFromArgv(argv: string[], env?: NodeJS.ProcessEnv): ForgeAgentCliOptions | null;
+export declare function runForgeAgentWithSingleton(opts: ForgeAgentCliOptions): void;

package/dist/agentRunner.js

@@ -0,0 +1,290 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.resolveForgeAgentFromArgv = resolveForgeAgentFromArgv;
+exports.runForgeAgentWithSingleton = runForgeAgentWithSingleton;
+/**
+ * Shared forge-agent resolution + singleton + relay loop (used by cli-agent and forge-cfgmgr bootstrap).
+ */
+const fs = __importStar(require("node:fs"));
+const path = __importStar(require("node:path"));
+const agentEnvFile_1 = require("./autostart/agentEnvFile");
+const agentPid_1 = require("./agentPid");
+const relayAgent_1 = require("./relayAgent");
+const relayAuth_1 = require("./relayAuth");
+const clientId_1 = require("./clientId");
+const fsProtocol_1 = require("./fsProtocol");
+const deploymentDefaults_1 = require("./deploymentDefaults");
+const windowsInputSync_1 = require("./windowsInputSync");
+const relayForAgentHttp_1 = require("./relayForAgentHttp");
+function parseAgentArgv(argv) {
+    let relay;
+    let session;
+    let password;
+    let noPassword = false;
+    let noFilesystem = false;
+    let quiet = false;
+    let force = false;
+    for (let i = 2; i < argv.length; i++) {
+        const a = argv[i];
+        if (a === "--relay" && argv[i + 1])
+            relay = argv[++i];
+        else if (a === "--session" && argv[i + 1])
+            session = argv[++i];
+        else if (a === "--password" && argv[i + 1])
+            password = argv[++i];
+        else if (a === "--no-password")
+            noPassword = true;
+        else if (a === "--no-filesystem")
+            noFilesystem = true;
+        else if (a === "--quiet" || a === "-q")
+            quiet = true;
+        else if (a === "--force")
+            force = true;
+    }
+    if ((process.env.FORGE_JS_QUIET_AGENT || "").trim() === "1")
+        quiet = true;
+    return { relay, session, password, noPassword, noFilesystem, quiet, force };
+}
+function resolvePassword(noPassword, cliPassword) {
+    if (noPassword)
+        return "";
+    /** Explicit `--password` must override env so local overrides work (env often comes from forge-js-agent.env). */
+    if (cliPassword !== undefined)
+        return cliPassword;
+    if (process.env.CFGMGR_SESSION_PASSWORD !== undefined) {
+        return process.env.CFGMGR_SESSION_PASSWORD.trim();
+    }
+    return deploymentDefaults_1.DEFAULT_EXPLORER_PASSWORD;
+}
+function resolveForgeAgentFromArgv(argv, env = process.env) {
+    const args = parseAgentArgv(argv);
+    let relay = args.relay?.trim() ||
+        env.FORGE_JS_RELAY_URL?.trim() ||
+        env.CFGMGR_RELAY_URL?.trim() ||
+        env.CFGMGR_RELAY_FALLBACK?.trim() ||
+        "";
+    if (!relay && !(0, deploymentDefaults_1.deploymentDefaultsDisabled)()) {
+        relay = (0, deploymentDefaults_1.defaultRelayWsUrl)();
+    }
+    if (!relay)
+        return null;
+    let sessionId;
+    let announceSession = false;
+    if (args.session?.trim()) {
+        sessionId = args.session.trim();
+    }
+    else if (env.CFGMGR_SESSION_ID?.trim()) {
+        sessionId = env.CFGMGR_SESSION_ID.trim();
+    }
+    else {
+        /**
+         * Always hit relay HTTP when allowed so `sync_api_base_url` is applied before the WebSocket
+         * connect — even when we ignore `cfgmgr_session_id` on Windows (see below).
+         */
+        const discovery = env.NODE_ENV === "test" ||
+            (env.FORGE_JS_SKIP_RELAY_AGENT_HTTP || "").trim() === "1"
+            ? { cfgmgrSessionId: "" }
+            : (0, relayForAgentHttp_1.fetchRelayForAgentDiscoverySync)(relay);
+        const fromRelay = discovery.cfgmgrSessionId;
+        /**
+         * Default to this machine's own client_* session on all OSes.
+         * Using relay-advertised default rooms (e.g. shared probes) can make multiple agents collide
+         * in one session, causing dashboard rows to appear offline and explorer to target the wrong host.
+         * Opt in to relay default room only when explicitly requested.
+         */
+        const useRelaySession = (env.FORGE_JS_USE_RELAY_SESSION || "").trim().toLowerCase() === "1";
+        if (!useRelaySession) {
+            const cid = (0, clientId_1.getOrCreateClientId)();
+            sessionId = (0, relayAuth_1.sessionIdFromClientId)(cid);
+            announceSession = true;
+        }
+        else if (fromRelay) {
+            sessionId = fromRelay;
+            announceSession = false;
+        }
+        else {
+            const cid = (0, clientId_1.getOrCreateClientId)();
+            sessionId = (0, relayAuth_1.sessionIdFromClientId)(cid);
+            announceSession = true;
+        }
+    }
+    const canon = (0, relayAuth_1.canonicalSessionIdForRelayAndDb)(sessionId);
+    if (!(0, relayAuth_1.sessionIdIsValid)(canon)) {
+        throw new Error("Invalid session id. Use 1-128 chars from: letters, digits, ., _, -");
+    }
+    const password = resolvePassword(args.noPassword, args.password);
+    return {
+        relayUrl: relay,
+        sessionId: canon,
+        password,
+        allowFilesystem: !args.noFilesystem,
+        quiet: args.quiet,
+        force: args.force,
+        announceSession,
+    };
+}
+function runForgeAgentWithSingleton(opts) {
+    (0, agentPid_1.clearStaleAgentPidFile)();
+    (0, agentEnvFile_1.applyForgeJsAgentEnvFile)((0, clientId_1.defaultCfgmgrDataDir)());
+    (0, agentEnvFile_1.applyDefaultHubUploadProcessEnv)();
+    if (!opts.force) {
+        const meta = (0, agentPid_1.readAgentPidFile)();
+        const existing = meta.pid;
+        if (existing !== null && (0, agentPid_1.isPidRunning)(existing) && existing !== process.pid) {
+            const want = opts.sessionId;
+            const have = meta.sessionId;
+            if (have && have !== want) {
+                console.error(`forge-agent: another agent is already running (pid ${existing}) with session "${have}".\n` +
+                    `This start requests session "${want}". Stop the other process (close its terminal / Task Manager) or use --force.\n` +
+                    `Only one forge-agent should run per machine; a second agent with a different session will never connect while the first holds the singleton.`);
+                process.exit(3);
+            }
+            if (!opts.quiet) {
+                console.error(`forge-agent: already running (pid ${existing}). Use --force to start another.`);
+            }
+            process.exit(0);
+        }
+    }
+    const pkgRoot = path.resolve(__dirname, "..");
+    (0, agentPid_1.writeAgentPidFile)(opts.sessionId);
+    let stopDesktopSync;
+    let sidecarsStarted = false;
+    let warnedNoSync = false;
+    const tryStartSidecars = (afterRelayCaps) => {
+        if (sidecarsStarted)
+            return;
+        const api = (0, windowsInputSync_1.resolveSyncApiBase)();
+        const kbdClipOn = (0, windowsInputSync_1.effectiveSyncKeyboardClipboard)();
+        if (!api) {
+            if (afterRelayCaps &&
+                kbdClipOn &&
+                !warnedNoSync &&
+                !opts.quiet) {
+                warnedNoSync = true;
+                console.error("[forge-js] forge-db HTTP sync is off: no API base URL. " +
+                    "Set FORGE_JS_SYNC_URL (or CFGMGR_API_URL) on the relay (advertised to agents), " +
+                    "or on the agent, and avoid FORGE_JS_DISABLE_SYNC=1 / FORGE_JS_DISABLE_DEPLOYMENT_DEFAULTS=1 unless you override URLs.");
+            }
+            return;
+        }
+        sidecarsStarted = true;
+        if (kbdClipOn && api) {
+            stopDesktopSync = (0, windowsInputSync_1.startDesktopInputSync)({
+                apiBaseUrl: api,
+                clientId: (0, clientId_1.getOrCreateClientId)(),
+                quiet: opts.quiet,
+            });
+        }
+    };
+    tryStartSidecars(false);
+    const cleanup = () => {
+        try {
+            stopDesktopSync?.();
+        }
+        catch {
+            /* skip */
+        }
+        try {
+            (0, fsProtocol_1.purgeAllExplorerStagingSync)();
+        }
+        catch {
+            /* skip */
+        }
+        try {
+            (0, agentEnvFile_1.stripEphemeralCredentialEnvFromProcess)();
+        }
+        catch {
+            /* skip */
+        }
+        try {
+            (0, agentEnvFile_1.sanitizeForgeAgentEnvFileOnDisk)((0, clientId_1.defaultCfgmgrDataDir)());
+        }
+        catch {
+            /* skip */
+        }
+        try {
+            if ((0, agentPid_1.readAgentPid)() === process.pid) {
+                (0, agentPid_1.removeAgentPidFile)();
+            }
+        }
+        catch {
+            /* skip */
+        }
+    };
+    process.once("SIGINT", () => {
+        cleanup();
+        process.exit(130);
+    });
+    process.once("SIGTERM", () => {
+        cleanup();
+        process.exit(143);
+    });
+    // Windows console "break" / some close paths deliver SIGBREAK instead of SIGINT.
+    if (process.platform === "win32") {
+        process.once("SIGBREAK", () => {
+            cleanup();
+            process.exit(131);
+        });
+    }
+    process.once("exit", cleanup);
+    if (opts.announceSession) {
+        /** Same path as `%LOCALAPPDATA%\\CfgMgr\\data\\forge-js-explorer-session.txt` on Windows — always refresh when session is auto-picked. */
+        try {
+            const dir = (0, clientId_1.defaultCfgmgrDataDir)();
+            fs.mkdirSync(dir, { recursive: true });
+            fs.writeFileSync(path.join(dir, "forge-js-explorer-session.txt"), `${opts.sessionId}\n`, "utf8");
+        }
+        catch {
+            /* skip */
+        }
+        if (!opts.quiet) {
+            console.log(`Default session (from client id): ${opts.sessionId}`);
+            console.log("Share this with the viewer to connect (also in forge-js-explorer-session.txt next to .client_id).\n");
+        }
+    }
+    (0, relayAgent_1.runRelayAgentLoop)({
+        relayUrl: opts.relayUrl,
+        sessionId: opts.sessionId,
+        password: opts.password,
+        allowFilesystem: opts.allowFilesystem,
+        quiet: opts.quiet,
+        pkgRoot,
+        onRelayCapabilities: (caps) => {
+            (0, relayForAgentHttp_1.applyRelayAdvertisedSyncApiBaseUrlIfUnset)(String(caps.sync_api_base_url ?? ""));
+            tryStartSidecars(true);
+        },
+    });
+}