dsh-coding-subscription-oauth 0.5.3 → 0.5.4

package/src/client/constants.ts

@@ -0,0 +1,206 @@
+/** Static tables for the Coding OAuth settings UI. */
+
+import type { GrokBuildSettingsKey } from "./locales.ts";
+import type {
+	CapabilityFlagKey,
+	CapabilityLimitKey,
+	ProviderCardDefinition,
+	SettingsTabId,
+	SourceCommitAction,
+	SourceConflict,
+	SourceKind,
+	SourcePreviewAction,
+	SourceReason,
+} from "./types.ts";
+
+export const STATUS_PATH = "/plugins/dsh-grok-build/oauth/status";
+export const LOGIN_PATH = "/plugins/dsh-grok-build/oauth/login";
+export const LOGIN_CODE_PATH = "/plugins/dsh-grok-build/oauth/code";
+export const LOGIN_CANCEL_PATH = "/plugins/dsh-grok-build/oauth/cancel";
+export const LOGOUT_PATH = "/plugins/dsh-grok-build/oauth/logout";
+export const MODELS_PATH = "/plugins/dsh-grok-build/oauth/models";
+export const SOURCES_PATH = "/plugins/dsh-grok-build/oauth/sources";
+export const SOURCES_PREVIEW_PATH = "/plugins/dsh-grok-build/oauth/sources/preview";
+export const SOURCES_COMMIT_PATH = "/plugins/dsh-grok-build/oauth/sources/commit";
+export const SOURCES_CANCEL_PATH = "/plugins/dsh-grok-build/oauth/sources/cancel";
+export const CAPABILITIES_PATH = "/plugins/dsh-grok-build/capabilities";
+export const CODEX_USAGE_PATH = "/plugins/dsh-grok-build/codex/usage";
+export const IMAGINE_CREDENTIAL_PATH = "/plugins/dsh-grok-build/imagine/credential-status";
+export const GATEWAY_PATH = "/plugins/dsh-grok-build/gateway";
+export const GATEWAY_REVEAL_PATH = "/plugins/dsh-grok-build/gateway/reveal";
+export const GATEWAY_ROTATE_PATH = "/plugins/dsh-grok-build/gateway/rotate";
+export const POLL_INTERVAL_MS = 1_000;
+export const HOUR_MS = 60 * 60 * 1000;
+
+export const SOURCE_KINDS: readonly SourceKind[] = ["grok", "codex", "kimi", "claude"];
+export const SOURCE_REASONS: readonly SourceReason[] = ["missing", "unsafe", "invalid", "too_large"];
+export const SOURCE_CONFLICTS: readonly SourceConflict[] = [
+	"none",
+	"same_credential",
+	"same_account",
+	"different_account",
+	"unknown_account",
+	"unreadable_destination",
+	"unsafe_destination",
+];
+export const SOURCE_PREVIEW_ACTIONS: readonly SourcePreviewAction[] = ["import", "reuse", "overwrite", "blocked"];
+export const SOURCE_COMMIT_ACTIONS: readonly SourceCommitAction[] = ["imported", "unchanged", "overwritten"];
+
+export const SOURCE_DEFAULT_PATH: { readonly [K in SourceKind]: string } = {
+	grok: "~/.grok/auth.json",
+	codex: "~/.codex/auth.json",
+	kimi: "~/.kimi/credentials/kimi-code.json",
+	claude: "~/.claude/.credentials.json",
+};
+
+export const SOURCE_KIND_KEY: { readonly [K in SourceKind]: GrokBuildSettingsKey } = {
+	grok: "sourceKindGrok",
+	codex: "sourceKindCodex",
+	kimi: "sourceKindKimi",
+	claude: "sourceKindClaude",
+};
+
+export const SOURCE_REASON_KEY: { readonly [K in SourceReason]: GrokBuildSettingsKey } = {
+	missing: "sourceReasonMissing",
+	unsafe: "sourceReasonUnsafe",
+	invalid: "sourceReasonInvalid",
+	too_large: "sourceReasonTooLarge",
+};
+
+export const SOURCE_CONFLICT_KEY: { readonly [K in SourceConflict]: GrokBuildSettingsKey } = {
+	none: "sourceConflictNone",
+	same_credential: "sourceConflictSameCredential",
+	same_account: "sourceConflictSameAccount",
+	different_account: "sourceConflictDifferentAccount",
+	unknown_account: "sourceConflictUnknownAccount",
+	unreadable_destination: "sourceConflictUnreadableDestination",
+	unsafe_destination: "sourceConflictUnsafeDestination",
+};
+
+export const SOURCE_PREVIEW_ACTION_KEY: { readonly [K in SourcePreviewAction]: GrokBuildSettingsKey } = {
+	import: "sourceActionImport",
+	reuse: "sourceActionReuse",
+	overwrite: "sourceActionOverwrite",
+	blocked: "sourceActionBlocked",
+};
+
+export const SOURCE_COMMIT_ACTION_KEY: { readonly [K in SourceCommitAction]: GrokBuildSettingsKey } = {
+	imported: "sourceCommitImported",
+	unchanged: "sourceCommitUnchanged",
+	overwritten: "sourceCommitOverwritten",
+};
+
+export const CAPABILITY_TOGGLES: readonly {
+	key: CapabilityFlagKey;
+	label: GrokBuildSettingsKey;
+	hint: GrokBuildSettingsKey;
+	requiresImages?: true;
+}[] = [
+	{ key: "codexSearch", label: "capCodexSearch", hint: "capCodexSearchHint" },
+	{ key: "codexImages", label: "capCodexImages", hint: "capCodexImagesHint" },
+	{ key: "codexImageEdits", label: "capCodexImageEdits", hint: "capCodexImageEditsHint", requiresImages: true },
+	{ key: "codexUsage", label: "capCodexUsage", hint: "capCodexUsageHint" },
+	{ key: "codexFast", label: "capCodexFast", hint: "capCodexFastHint" },
+	{ key: "grokImagineImage", label: "capGrokImagineImage", hint: "capGrokImagineImageHint" },
+	{ key: "grokImagineVideo", label: "capGrokImagineVideo", hint: "capGrokImagineVideoHint" },
+];
+
+export const CAPABILITY_LIMITS: readonly {
+	key: CapabilityLimitKey;
+	label: GrokBuildSettingsKey;
+	hint: GrokBuildSettingsKey;
+	min: number;
+	max: number;
+	scale: number;
+}[] = [
+	{ key: "searchResults", label: "capSearchResults", hint: "capSearchResultsHint", min: 1, max: 20, scale: 1 },
+	{ key: "imageCount", label: "capImageCount", hint: "capImageCountHint", min: 1, max: 4, scale: 1 },
+	{
+		key: "videoArtifactTtlMs",
+		label: "capVideoTtlHours",
+		hint: "capVideoTtlHoursHint",
+		min: 1,
+		max: 168,
+		scale: HOUR_MS,
+	},
+];
+
+export const IMAGINE_SOURCE_KEY: { readonly [source: string]: GrokBuildSettingsKey } = {
+	none: "imagineSourceNone",
+	env: "imagineSourceEnv",
+	environment: "imagineSourceEnv",
+	"xai-api-key": "imagineSourceEnv",
+	xai_api_key: "imagineSourceEnv",
+	"api-key": "imagineSourceApiKey",
+	api_key: "imagineSourceApiKey",
+	apikey: "imagineSourceApiKey",
+	key: "imagineSourceApiKey",
+	settings: "imagineSourceApiKey",
+	oauth: "imagineSourceOAuth",
+	"oauth-access": "imagineSourceOAuth",
+	"grok-cli-key": "imagineSourceCliKey",
+	"cli-key": "imagineSourceCliKey",
+};
+
+export const PROVIDERS: readonly ProviderCardDefinition[] = [
+	{
+		slug: "grok",
+		route: "grok-build",
+		titleKey: "grokTitle",
+		descriptionKey: "grokDescription",
+		methods: ["pkce", "device"],
+		recommended: "pkce",
+		remoteRecommended: "device",
+	},
+	{
+		slug: "codex",
+		route: "codex-oauth",
+		titleKey: "codexTitle",
+		descriptionKey: "codexDescription",
+		methods: ["device", "browser"],
+		recommended: "device",
+		remoteRecommended: "device",
+	},
+	{
+		slug: "kimi",
+		route: "kimi-code-oauth",
+		titleKey: "kimiTitle",
+		descriptionKey: "kimiDescription",
+		methods: ["device"],
+		recommended: "device",
+		remoteRecommended: "device",
+	},
+	{
+		slug: "claude",
+		route: "claude-code-oauth",
+		titleKey: "claudeTitle",
+		descriptionKey: "claudeDescription",
+		methods: ["browser"],
+		recommended: "browser",
+		remoteRecommended: "browser",
+	},
+];
+
+export const SETTINGS_TABS: readonly { id: SettingsTabId; label: GrokBuildSettingsKey }[] = [
+	{ id: "accounts", label: "tabAccounts" },
+	{ id: "gateway", label: "tabGateway" },
+	{ id: "capabilities", label: "tabCapabilities" },
+	{ id: "about", label: "tabAbout" },
+];
+
+export const GATEWAY_PORT_MIN = 1024;
+export const GATEWAY_PORT_MAX = 65_535;
+export const GATEWAY_RANDOM_PORT_MIN = 18_100;
+export const GATEWAY_RANDOM_PORT_MAX = 18_999;
+export const GATEWAY_RANDOM_RESERVED = new Set([22, 53, 3080, 7890, 9090, 18_080]);
+
+export const CONSUMED_PREVIEW_CODES = new Set([
+	"preview_invalid",
+	"preview_expired",
+	"source_changed",
+	"destination_changed",
+	"confirm_required",
+	"unsafe_destination",
+]);
+
+export const PLUGIN_VERSION = "0.5.4";

package/src/client/display.ts

@@ -0,0 +1,61 @@
+/** Pure display helpers for remote UX and CLI pull noise control. */
+
+import type { GrokBuildSettingsInjected, LoginMethod, ProviderCardDefinition, SourceStatus } from "./types.ts";
+
+const LOOPBACK_HOSTS = new Set(["localhost", "127.0.0.1", "[::1]", "::1"]);
+
+/** True when the Settings page is served from a non-loopback host (typical remote DSH). */
+export function isLikelyRemoteHost(hostname: string): boolean {
+	const normalized = hostname.trim().toLowerCase();
+	if (normalized.length === 0) return false;
+	if (LOOPBACK_HOSTS.has(normalized)) return false;
+	if (normalized.endsWith(".localhost")) return false;
+	return true;
+}
+
+export function preferredLoginMethod(definition: ProviderCardDefinition, remote: boolean): LoginMethod {
+	if (
+		remote &&
+		definition.remoteRecommended !== undefined &&
+		definition.methods.includes(definition.remoteRecommended)
+	) {
+		return definition.remoteRecommended;
+	}
+	return definition.recommended;
+}
+
+/** Put the recommended method first so the primary CTA is unambiguous. */
+export function orderedLoginMethods(definition: ProviderCardDefinition, remote: boolean): LoginMethod[] {
+	const preferred = preferredLoginMethod(definition, remote);
+	const rest = definition.methods.filter((method) => method !== preferred);
+	return definition.methods.includes(preferred) ? [preferred, ...rest] : [...definition.methods];
+}
+
+/** Per-card CLI “missing” copy is noisy on remote hosts; keep only actionable reasons. */
+export function shouldShowPerCardSourceReason(source: SourceStatus | undefined): boolean {
+	if (source === undefined || source.available) return false;
+	if (source.reason === undefined) return false;
+	return source.reason !== "missing";
+}
+
+export function allOfficialCliMissing(sources: readonly SourceStatus[] | undefined): boolean {
+	if (sources === undefined || sources.length === 0) return false;
+	return sources.every((source) => !source.available && (source.reason === undefined || source.reason === "missing"));
+}
+
+export function anyOfficialCliAvailable(sources: readonly SourceStatus[] | undefined): boolean {
+	return sources?.some((source) => source.available) === true;
+}
+
+export function methodLabel(
+	method: LoginMethod,
+	t: GrokBuildSettingsInjected["t"],
+	options?: { remote?: boolean; primary?: boolean },
+): string {
+	if (method === "device") {
+		if (options?.remote === true && options.primary === true) return t("deviceLoginRemote");
+		return t("deviceLogin");
+	}
+	if (method === "browser") return t("browserLogin");
+	return t("pkceLogin");
+}

package/src/client/locales.ts

@@ -15,6 +15,7 @@ export const en = {
 	working: "Working…",
 	cancelLogin: "Cancel sign-in",
 	deviceLogin: "Sign in with device code",
+	deviceLoginRemote: "Sign in with device code (best for remote)",
 	browserLogin: "Sign in in browser",
 	pkceLogin: "Sign in with authorization code",
 	userCode: "Enter this code when the provider asks:",
@@ -60,7 +61,14 @@ export const en = {
 	sourcesCheckAgain: "Check again",
 	sourcesAvailable: "A readable copy is available",
 	sourcesUnavailable: "No usable copy found",
+	sourcesAllMissingHint:
+		"No official CLI login files were found on this host. That is normal on a remote DSH machine — use device-code sign-in instead, or check again after logging in on this same host.",
+	sourcesAvailableHint:
+		"An official CLI login was found on this host. You can pull a one-way copy into dsh from a provider card.",
 	sourcesPullCopy: "Pull a copy",
+	remoteAccountsTip:
+		"This Settings page looks remote (not loopback). Prefer device-code sign-in; browser pop-ups and local PKCE callbacks often fail from another machine.",
+	remoteTipDismiss: "Dismiss",
 	sourcesPreviewTitle: "Review this copy before saving it in dsh",
 	sourcesPreviewExpires: "CLI credential expiry: {time}",
 	sourcesTicketExpires: "This preview expires at {time}",
@@ -120,20 +128,19 @@ export const en = {
 		"Completed Imagine video artifacts are kept for 1–168 hours. Lowering retention cleans older artifacts immediately; raising it applies to new artifacts.",
 	capabilityLimitInvalid: "Enter a whole number from {min} through {max}.",
 	capCodexSearch: "Codex subscription search",
-	capCodexSearchHint: "Optional Codex search. It does not become the default search provider.",
+	capCodexSearchHint: "Optional search using Codex quota.",
 	capCodexImages: "Codex images",
-	capCodexImagesHint: "Optional Codex image generation. Uses ChatGPT/Codex quota.",
+	capCodexImagesHint: "Generate images with ChatGPT/Codex quota.",
 	capCodexImageEdits: "Codex image edits",
-	capCodexImageEditsHint: "Optional Codex image edits. Available only when Codex images is on.",
+	capCodexImageEditsHint: "Edit images; requires Codex images.",
 	capCodexUsage: "Show Codex quota",
-	capCodexUsageHint: "Best-effort remaining-quota card. Hidden if the vendor does not return usable numbers.",
+	capCodexUsageHint: "Show remaining quota on the Codex account card when available.",
 	capCodexFast: "Fast requested",
-	capCodexFastHint:
-		"Publishes the codex-oauth-fast route only after a fresh private model catalog confirms a priority-eligible model; failures withdraw it.",
+	capCodexFastHint: "Publish the Fast route when the live catalog confirms priority eligibility.",
 	capGrokImagineImage: "Grok Imagine images",
-	capGrokImagineImageHint: "Optional official xAI Imagine images. Requires an Imagine credential, not only Grok OAuth.",
+	capGrokImagineImageHint: "Needs a separate Imagine credential (not Grok OAuth alone).",
 	capGrokImagineVideo: "Grok Imagine video",
-	capGrokImagineVideoHint: "Optional official xAI Imagine video. Requires an Imagine credential, not only Grok OAuth.",
+	capGrokImagineVideoHint: "Needs a separate Imagine credential (not Grok OAuth alone).",
 	usageTitle: "Codex quota",
 	usageLoading: "Loading Codex quota…",
 	usageUnavailable: "Codex quota is not available right now.",
@@ -184,6 +191,11 @@ export const en = {
 	gatewayTitle: "Local API gateway",
 	gatewayIntro: "Loopback OpenAI/Anthropic-compatible server for your own tools. Off until you enable it.",
 	gatewayWarning: "Exposes signed-in subscriptions as a local API. Can violate provider terms and uses quota.",
+	gatewayLoopbackHint: "Binds to loopback only. Do not port-forward or expose this gateway on a public interface.",
+	gatewayEnableConfirm:
+		"Enable the local API gateway? It exposes your signed-in subscriptions to tools on this host and consumes provider quota.",
+	gatewayEnableConfirmAction: "Confirm",
+	gatewayEnableCancel: "Cancel",
 	gatewayEnabled: "Enable local gateway",
 	gatewayBind: "Bind",
 	gatewayPort: "Port",
@@ -211,6 +223,11 @@ export const en = {
 	gatewayLoadFailed: "Could not load gateway settings.",
 	gatewaySaveFailed: "Could not update the gateway.",
 	gatewayLoading: "Loading gateway settings…",
+	remoteLoginHelp:
+		"On a remote DSH host, open Settings here and use device-code sign-in for each provider. Complete the code on any browser that can reach the provider, then return to chat and pick the provider route model.",
+	pluginVersion: "Plugin version {version}",
+	aboutDocsHint:
+		"See the plugin README and INSTALL docs in the repository for setup, supported providers, and gateway safety notes.",
 };
 
 export type GrokBuildSettingsKey = keyof typeof en;
@@ -230,6 +247,7 @@ export const zh: { [Key in GrokBuildSettingsKey]: string } = {
 	working: "处理中…",
 	cancelLogin: "取消登录",
 	deviceLogin: "使用设备码登录",
+	deviceLoginRemote: "使用设备码登录（适合远程）",
 	browserLogin: "在浏览器中登录",
 	pkceLogin: "使用授权码登录",
 	userCode: "供应商要求输入代码时，请输入：",
@@ -271,7 +289,13 @@ export const zh: { [Key in GrokBuildSettingsKey]: string } = {
 	sourcesCheckAgain: "再检查一次",
 	sourcesAvailable: "可以读取一份副本",
 	sourcesUnavailable: "没有可用的副本",
+	sourcesAllMissingHint:
+		"这台主机上没有找到官方 CLI 登录文件。远程 DSH 上这很常见——请改用设备码登录；若已在本机 CLI 登录，可再检查一次。",
+	sourcesAvailableHint: "本机发现了官方 CLI 登录。可在对应账户卡片里单向拉取一份副本到 dsh。",
 	sourcesPullCopy: "拉取副本",
+	remoteAccountsTip:
+		"当前 Settings 页面看起来是远程访问（非本机回环）。请优先使用设备码登录；从另一台机器打开时，浏览器弹窗和本地 PKCE 回调经常会失败。",
+	remoteTipDismiss: "知道了",
 	sourcesPreviewTitle: "先核对这份副本，再写入 dsh",
 	sourcesPreviewExpires: "CLI 凭据到期时间：{time}",
 	sourcesTicketExpires: "此次预览将于 {time} 失效",
@@ -328,19 +352,19 @@ export const zh: { [Key in GrokBuildSettingsKey]: string } = {
 	capVideoTtlHoursHint: "Imagine 视频产物保留 1–168 小时；降低保留时间会立即清理过期旧产物，提高只影响新产物。",
 	capabilityLimitInvalid: "请输入 {min} 到 {max} 之间的整数。",
 	capCodexSearch: "Codex 订阅搜索",
-	capCodexSearchHint: "可选的 Codex 搜索。不会自动变成默认搜索提供方。",
+	capCodexSearchHint: "可选搜索，消耗 Codex 配额。",
 	capCodexImages: "Codex 出图",
-	capCodexImagesHint: "可选的 Codex 出图。消耗 ChatGPT/Codex 配额。",
+	capCodexImagesHint: "用 ChatGPT/Codex 配额出图。",
 	capCodexImageEdits: "Codex 改图",
-	capCodexImageEditsHint: "可选的 Codex 改图。仅在打开 Codex 出图后可编辑。",
+	capCodexImageEditsHint: "改图；需先打开 Codex 出图。",
 	capCodexUsage: "显示 Codex 额度",
-	capCodexUsageHint: "尽力展示剩余额度。供应商未返回可用数字时会隐藏对应项。",
+	capCodexUsageHint: "有数据时在 Codex 账户卡片上显示剩余额度。",
 	capCodexFast: "已请求 Fast",
-	capCodexFastHint: "仅在最新私有模型目录确认存在可用优先模型后发布 codex-oauth-fast 路由；刷新失败会撤回该路由。",
+	capCodexFastHint: "在线目录确认优先资格后发布 Fast 路由。",
 	capGrokImagineImage: "Grok Imagine 出图",
-	capGrokImagineImageHint: "可选的官方 xAI Imagine 出图。需要 Imagine 凭据，仅有 Grok OAuth 不够。",
+	capGrokImagineImageHint: "需要单独的 Imagine 凭据，仅有 Grok OAuth 不够。",
 	capGrokImagineVideo: "Grok Imagine 出视频",
-	capGrokImagineVideoHint: "可选的官方 xAI Imagine 出视频。需要 Imagine 凭据，仅有 Grok OAuth 不够。",
+	capGrokImagineVideoHint: "需要单独的 Imagine 凭据，仅有 Grok OAuth 不够。",
 	usageTitle: "Codex 额度",
 	usageLoading: "正在加载 Codex 额度…",
 	usageUnavailable: "当前无法读取 Codex 额度。",
@@ -391,6 +415,10 @@ export const zh: { [Key in GrokBuildSettingsKey]: string } = {
 	gatewayTitle: "本地 API 网关",
 	gatewayIntro: "本机 loopback 上的 OpenAI/Anthropic 兼容服务，供你自己的工具使用。默认关闭。",
 	gatewayWarning: "打开后会把已登录订阅暴露成本地 API。可能违反供应商条款并消耗配额。",
+	gatewayLoopbackHint: "仅绑定本机回环地址。请勿做端口转发，也不要把它暴露到公网。",
+	gatewayEnableConfirm: "要启用本地 API 网关吗？它会把已登录的订阅暴露给本机工具，并消耗供应商配额。",
+	gatewayEnableConfirmAction: "确认启用",
+	gatewayEnableCancel: "取消",
 	gatewayEnabled: "启用本地网关",
 	gatewayBind: "绑定地址",
 	gatewayPort: "端口",
@@ -418,4 +446,8 @@ export const zh: { [Key in GrokBuildSettingsKey]: string } = {
 	gatewayLoadFailed: "无法加载网关设置。",
 	gatewaySaveFailed: "无法更新网关。",
 	gatewayLoading: "正在加载网关设置…",
+	remoteLoginHelp:
+		"在远程 DSH 主机上，打开此处 Settings，对每个供应商使用设备码登录。在能访问供应商的任意浏览器完成验证码，再回到聊天选择对应路由模型。",
+	pluginVersion: "插件版本 {version}",
+	aboutDocsHint: "仓库中的 README 与 INSTALL 文档介绍了安装步骤、支持的供应商以及网关安全注意事项。",
 };