From 12efbcaa7e862152c941aacfb498043a5b96b8e2 Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Thu, 4 Jun 2026 12:36:05 -0400 Subject: [PATCH] docs: document daemon oauth command seams --- src/commands/node-daemon-install-helpers.ts | 2 ++ src/commands/node-daemon-runtime.ts | 4 ++++ src/commands/non-interactive-prompter.ts | 2 ++ src/commands/oauth-env.ts | 1 + src/commands/oauth-tls-preflight.ts | 1 + 5 files changed, 10 insertions(+) diff --git a/src/commands/node-daemon-install-helpers.ts b/src/commands/node-daemon-install-helpers.ts index 648cf20dfae0..9da587402815 100644 --- a/src/commands/node-daemon-install-helpers.ts +++ b/src/commands/node-daemon-install-helpers.ts @@ -1,3 +1,4 @@ +/** Node-based daemon install plan builder for managed gateway services. */ import { formatNodeServiceDescription } from "../daemon/constants.js"; import { resolveNodeProgramArguments } from "../daemon/program-args.js"; import { buildNodeServiceEnvironment } from "../daemon/service-env.js"; @@ -27,6 +28,7 @@ function buildNodeInstallEnvironmentValueSources(): Record< }; } +/** Builds launch arguments, environment, and metadata for a Node daemon service install. */ export async function buildNodeInstallPlan(params: { env: Record; host: string; diff --git a/src/commands/node-daemon-runtime.ts b/src/commands/node-daemon-runtime.ts index 535c20ce623e..52422c0cdfb9 100644 --- a/src/commands/node-daemon-runtime.ts +++ b/src/commands/node-daemon-runtime.ts @@ -1,13 +1,17 @@ +/** Compatibility exports for the Node daemon runtime selector. */ import { DEFAULT_GATEWAY_DAEMON_RUNTIME, isGatewayDaemonRuntime, type GatewayDaemonRuntime, } from "./daemon-runtime.js"; +/** Runtime id accepted by Node daemon install/start helpers. */ export type NodeDaemonRuntime = GatewayDaemonRuntime; +/** Default Node daemon runtime, currently shared with the gateway daemon runtime. */ export const DEFAULT_NODE_DAEMON_RUNTIME = DEFAULT_GATEWAY_DAEMON_RUNTIME; +/** Returns true when a string is a supported Node daemon runtime id. */ export function isNodeDaemonRuntime(value: string | undefined): value is NodeDaemonRuntime { return isGatewayDaemonRuntime(value); } diff --git a/src/commands/non-interactive-prompter.ts b/src/commands/non-interactive-prompter.ts index 827e6205d457..bfc4385e4a51 100644 --- a/src/commands/non-interactive-prompter.ts +++ b/src/commands/non-interactive-prompter.ts @@ -1,6 +1,8 @@ +/** Non-interactive wizard prompter that logs progress but rejects input prompts. */ import type { RuntimeEnv } from "../runtime.js"; import type { WizardPrompter } from "../wizard/prompts.js"; +/** Builds a WizardPrompter for commands that must fail instead of prompting. */ export function createNonInteractiveLoggingPrompter( runtime: RuntimeEnv, formatPromptError: (message: string) => string, diff --git a/src/commands/oauth-env.ts b/src/commands/oauth-env.ts index 26b59e1b0a1a..0e9999607f5b 100644 --- a/src/commands/oauth-env.ts +++ b/src/commands/oauth-env.ts @@ -1 +1,2 @@ +/** Back-compat command seam for remote OAuth environment detection. */ export { isRemoteEnvironment } from "../infra/remote-env.js"; diff --git a/src/commands/oauth-tls-preflight.ts b/src/commands/oauth-tls-preflight.ts index ab07319accd8..5efd2643d1c3 100644 --- a/src/commands/oauth-tls-preflight.ts +++ b/src/commands/oauth-tls-preflight.ts @@ -1 +1,2 @@ +/** Back-compat command seam for OpenAI ChatGPT OAuth TLS preflight helpers. */ export * from "../plugins/provider-openai-chatgpt-oauth-tls.js";