@kenkaiiii/gg-core 5.79.0 → 5.79.2

package/dist/index.d.cts

@@ -429,6 +429,87 @@ declare class NotLoggedInError extends Error {
     constructor(provider: string);
 }
 
+type AuthMethod = "oauth" | "apikey";
+/**
+ * One API-key option for a provider that splits auth across multiple distinct
+ * endpoints/credentials (currently only Xiaomi: Token Plan vs. API Credits).
+ * Each variant stores under its own auth.json key so a user can hold both at
+ * once — the model registry picks which one a given model resolves via
+ * `getAuthStorageKeys()`.
+ */
+interface ApiKeyVariant {
+    /** Storage key in auth.json (distinct from `value` when multiple variants exist). */
+    key: string;
+    /** Display label, e.g. "Token Plan" or "API Credits". */
+    label: string;
+    /** Base URL stored alongside this variant's credential. */
+    baseUrl?: string;
+}
+interface AuthProviderMeta {
+    /** Stable provider id (matches the gg-ai Provider union, plus storage keys). */
+    value: string;
+    /** Display name shown in the login list. */
+    label: string;
+    /** One-line model summary. */
+    description: string;
+    /** Supported auth methods, in preferred order (oauth first when both). */
+    methods: AuthMethod[];
+    /** Friendly label for the API key field (e.g. "Z.AI"). */
+    apiKeyLabel?: string;
+    /** Fixed base URL stored alongside an API key (e.g. Xiaomi's token plan). */
+    apiKeyBaseUrl?: string;
+    /**
+     * When a provider's API-key auth splits across multiple endpoints, the
+     * choices to present (in order). The first variant is the default. Absent
+     * for every provider with a single API-key credential.
+     */
+    apiKeyVariants?: ApiKeyVariant[];
+    /**
+     * Per-method guidance overrides. Only providers whose methods differ in
+     * billing/entitlement (the dual-auth ones) need these; everything else is
+     * described generically by {@link describeAuthMethods}.
+     */
+    methodDetails?: Partial<Record<AuthMethod, AuthMethodMeta>>;
+}
+/**
+ * What one auth method means for a provider, so both UIs can answer "which do I
+ * pick?" without hardcoding provider knowledge in a component.
+ */
+interface AuthMethodMeta {
+    method: AuthMethod;
+    /** Button/row label, e.g. "Sign in with Grok (SuperGrok / X Premium)". */
+    label: string;
+    /** What the user spends on this method. */
+    billing: string;
+    /** When to choose it. */
+    when: string;
+    /** Prerequisite the user must already have, if any. */
+    requires?: string;
+}
+/**
+ * Every provider a user can connect, in login-screen order. `description`
+ * lists that provider's models and feeds both the CLI login screen and the
+ * app's provider list, so `auth-providers.test.ts` pins each one to the model
+ * registry — a registry change that isn't reflected here fails the suite.
+ */
+declare const AUTH_PROVIDERS: AuthProviderMeta[];
+declare function getAuthProvider(value: string): AuthProviderMeta | undefined;
+/**
+ * Per-method guidance for a provider, in resolution order. Providers with a
+ * single method get a generic description; the dual-auth ones (Kimi, Grok) carry
+ * explicit `methodDetails` because the choice changes what the user is billed.
+ */
+declare function describeAuthMethods(provider: string): AuthMethodMeta[];
+/**
+ * How the runtime picks between two connected methods, phrased for the UI. Only
+ * dual-auth providers have a choice to explain; everything else returns
+ * undefined so callers can omit the note entirely.
+ *
+ * Keep this wording in sync with AuthStorage's actual resolution order in
+ * gg-core (`DUAL_AUTH_PROVIDERS`) — it is the user-facing description of it.
+ */
+declare function authPriorityNote(provider: string): string | undefined;
+
 type SubscriptionUsageProvider = "anthropic" | "openai" | "moonshot";
 interface SubscriptionUsageWindow {
     kind: "current" | "weekly";
@@ -759,4 +840,4 @@ interface AutoUpdater {
 }
 declare function createAutoUpdater(config: AutoUpdateConfig): AutoUpdater;
 
-export { AuthStorage, type AutoUpdateConfig, type AutoUpdater, DEFAULT_LOCAL_ENDPOINTS, type DiscoverOptions, type DiscoveryResult, type DualAuthProvider, FALLBACK_CONTEXT_WINDOW, type InlineButton, LOCAL_API_KEY_PLACEHOLDER, LOCAL_AUTH_KEY_PREFIX, type LocalEndpoint, type LocalEndpointKind, type LocalEndpointProbe, type LocalModel, type LogLevel, MOONSHOT_OAUTH_KEY, ModelInfo, NotLoggedInError, type OAuthCredentials, type OAuthLoginCallbacks, PLAN_MODE_THINKING_CAP, type ProbeOptions, type ProgressCallback, SubscriptionUsageError, type SubscriptionUsageProvider, type SubscriptionUsageSnapshot, type SubscriptionUsageWindow, TelegramBot, type TelegramConfig, type TelegramMessage, type TelegramUpdate, type TelegramVoiceMessage, XAI_OAUTH_KEY, XIAOMI_CREDITS_KEY, clampThinkingForPlanMode, clearLocalDiscoveryCache, closeLogger, createAutoUpdater, decodeOggOpus, discoverLocalModels, downmixToMono, dualAuthProvider, dualAuthProviderByOAuthKey, endpointRoot, fetchSubscriptionUsage, findProbedModel, formatLocalModelId, generatePKCE, getClaudeCliUserAgent, getClaudeCodeVersion, getLowestThinkingLevel, getNextThinkingLevel, getSessionId, getSupportedThinkingLevels, grokCliBaseUrl, grokCliHeaders, isGrokCliEndpoint, isKimiCodingEndpoint, isLocalModelId, isLoggerOpen, isModelLoaded, isThinkingLevelSupported, kimiCodeBaseUrl, kimiCodingHeaders, localAuthStorageKey, log, loginAnthropic, loginGemini, loginKimi, loginOpenAI, loginXai, oauthStorageKey, openLog, parseLocalModelId, probeEndpoint, providerStorageKeys, readStoredBaseUrlSync, refreshAnthropicToken, refreshGeminiToken, refreshKimiToken, refreshOpenAIToken, refreshXaiToken, registerLogCleanup, resample, setProgressCallback, toModelInfo, transcribeVoice, withFileLock };
+export { AUTH_PROVIDERS, type ApiKeyVariant, type AuthMethod, type AuthMethodMeta, type AuthProviderMeta, AuthStorage, type AutoUpdateConfig, type AutoUpdater, DEFAULT_LOCAL_ENDPOINTS, type DiscoverOptions, type DiscoveryResult, type DualAuthProvider, FALLBACK_CONTEXT_WINDOW, type InlineButton, LOCAL_API_KEY_PLACEHOLDER, LOCAL_AUTH_KEY_PREFIX, type LocalEndpoint, type LocalEndpointKind, type LocalEndpointProbe, type LocalModel, type LogLevel, MOONSHOT_OAUTH_KEY, ModelInfo, NotLoggedInError, type OAuthCredentials, type OAuthLoginCallbacks, PLAN_MODE_THINKING_CAP, type ProbeOptions, type ProgressCallback, SubscriptionUsageError, type SubscriptionUsageProvider, type SubscriptionUsageSnapshot, type SubscriptionUsageWindow, TelegramBot, type TelegramConfig, type TelegramMessage, type TelegramUpdate, type TelegramVoiceMessage, XAI_OAUTH_KEY, XIAOMI_CREDITS_KEY, authPriorityNote, clampThinkingForPlanMode, clearLocalDiscoveryCache, closeLogger, createAutoUpdater, decodeOggOpus, describeAuthMethods, discoverLocalModels, downmixToMono, dualAuthProvider, dualAuthProviderByOAuthKey, endpointRoot, fetchSubscriptionUsage, findProbedModel, formatLocalModelId, generatePKCE, getAuthProvider, getClaudeCliUserAgent, getClaudeCodeVersion, getLowestThinkingLevel, getNextThinkingLevel, getSessionId, getSupportedThinkingLevels, grokCliBaseUrl, grokCliHeaders, isGrokCliEndpoint, isKimiCodingEndpoint, isLocalModelId, isLoggerOpen, isModelLoaded, isThinkingLevelSupported, kimiCodeBaseUrl, kimiCodingHeaders, localAuthStorageKey, log, loginAnthropic, loginGemini, loginKimi, loginOpenAI, loginXai, oauthStorageKey, openLog, parseLocalModelId, probeEndpoint, providerStorageKeys, readStoredBaseUrlSync, refreshAnthropicToken, refreshGeminiToken, refreshKimiToken, refreshOpenAIToken, refreshXaiToken, registerLogCleanup, resample, setProgressCallback, toModelInfo, transcribeVoice, withFileLock };

package/dist/index.d.ts

@@ -429,6 +429,87 @@ declare class NotLoggedInError extends Error {
     constructor(provider: string);
 }
 
+type AuthMethod = "oauth" | "apikey";
+/**
+ * One API-key option for a provider that splits auth across multiple distinct
+ * endpoints/credentials (currently only Xiaomi: Token Plan vs. API Credits).
+ * Each variant stores under its own auth.json key so a user can hold both at
+ * once — the model registry picks which one a given model resolves via
+ * `getAuthStorageKeys()`.
+ */
+interface ApiKeyVariant {
+    /** Storage key in auth.json (distinct from `value` when multiple variants exist). */
+    key: string;
+    /** Display label, e.g. "Token Plan" or "API Credits". */
+    label: string;
+    /** Base URL stored alongside this variant's credential. */
+    baseUrl?: string;
+}
+interface AuthProviderMeta {
+    /** Stable provider id (matches the gg-ai Provider union, plus storage keys). */
+    value: string;
+    /** Display name shown in the login list. */
+    label: string;
+    /** One-line model summary. */
+    description: string;
+    /** Supported auth methods, in preferred order (oauth first when both). */
+    methods: AuthMethod[];
+    /** Friendly label for the API key field (e.g. "Z.AI"). */
+    apiKeyLabel?: string;
+    /** Fixed base URL stored alongside an API key (e.g. Xiaomi's token plan). */
+    apiKeyBaseUrl?: string;
+    /**
+     * When a provider's API-key auth splits across multiple endpoints, the
+     * choices to present (in order). The first variant is the default. Absent
+     * for every provider with a single API-key credential.
+     */
+    apiKeyVariants?: ApiKeyVariant[];
+    /**
+     * Per-method guidance overrides. Only providers whose methods differ in
+     * billing/entitlement (the dual-auth ones) need these; everything else is
+     * described generically by {@link describeAuthMethods}.
+     */
+    methodDetails?: Partial<Record<AuthMethod, AuthMethodMeta>>;
+}
+/**
+ * What one auth method means for a provider, so both UIs can answer "which do I
+ * pick?" without hardcoding provider knowledge in a component.
+ */
+interface AuthMethodMeta {
+    method: AuthMethod;
+    /** Button/row label, e.g. "Sign in with Grok (SuperGrok / X Premium)". */
+    label: string;
+    /** What the user spends on this method. */
+    billing: string;
+    /** When to choose it. */
+    when: string;
+    /** Prerequisite the user must already have, if any. */
+    requires?: string;
+}
+/**
+ * Every provider a user can connect, in login-screen order. `description`
+ * lists that provider's models and feeds both the CLI login screen and the
+ * app's provider list, so `auth-providers.test.ts` pins each one to the model
+ * registry — a registry change that isn't reflected here fails the suite.
+ */
+declare const AUTH_PROVIDERS: AuthProviderMeta[];
+declare function getAuthProvider(value: string): AuthProviderMeta | undefined;
+/**
+ * Per-method guidance for a provider, in resolution order. Providers with a
+ * single method get a generic description; the dual-auth ones (Kimi, Grok) carry
+ * explicit `methodDetails` because the choice changes what the user is billed.
+ */
+declare function describeAuthMethods(provider: string): AuthMethodMeta[];
+/**
+ * How the runtime picks between two connected methods, phrased for the UI. Only
+ * dual-auth providers have a choice to explain; everything else returns
+ * undefined so callers can omit the note entirely.
+ *
+ * Keep this wording in sync with AuthStorage's actual resolution order in
+ * gg-core (`DUAL_AUTH_PROVIDERS`) — it is the user-facing description of it.
+ */
+declare function authPriorityNote(provider: string): string | undefined;
+
 type SubscriptionUsageProvider = "anthropic" | "openai" | "moonshot";
 interface SubscriptionUsageWindow {
     kind: "current" | "weekly";
@@ -759,4 +840,4 @@ interface AutoUpdater {
 }
 declare function createAutoUpdater(config: AutoUpdateConfig): AutoUpdater;
 
-export { AuthStorage, type AutoUpdateConfig, type AutoUpdater, DEFAULT_LOCAL_ENDPOINTS, type DiscoverOptions, type DiscoveryResult, type DualAuthProvider, FALLBACK_CONTEXT_WINDOW, type InlineButton, LOCAL_API_KEY_PLACEHOLDER, LOCAL_AUTH_KEY_PREFIX, type LocalEndpoint, type LocalEndpointKind, type LocalEndpointProbe, type LocalModel, type LogLevel, MOONSHOT_OAUTH_KEY, ModelInfo, NotLoggedInError, type OAuthCredentials, type OAuthLoginCallbacks, PLAN_MODE_THINKING_CAP, type ProbeOptions, type ProgressCallback, SubscriptionUsageError, type SubscriptionUsageProvider, type SubscriptionUsageSnapshot, type SubscriptionUsageWindow, TelegramBot, type TelegramConfig, type TelegramMessage, type TelegramUpdate, type TelegramVoiceMessage, XAI_OAUTH_KEY, XIAOMI_CREDITS_KEY, clampThinkingForPlanMode, clearLocalDiscoveryCache, closeLogger, createAutoUpdater, decodeOggOpus, discoverLocalModels, downmixToMono, dualAuthProvider, dualAuthProviderByOAuthKey, endpointRoot, fetchSubscriptionUsage, findProbedModel, formatLocalModelId, generatePKCE, getClaudeCliUserAgent, getClaudeCodeVersion, getLowestThinkingLevel, getNextThinkingLevel, getSessionId, getSupportedThinkingLevels, grokCliBaseUrl, grokCliHeaders, isGrokCliEndpoint, isKimiCodingEndpoint, isLocalModelId, isLoggerOpen, isModelLoaded, isThinkingLevelSupported, kimiCodeBaseUrl, kimiCodingHeaders, localAuthStorageKey, log, loginAnthropic, loginGemini, loginKimi, loginOpenAI, loginXai, oauthStorageKey, openLog, parseLocalModelId, probeEndpoint, providerStorageKeys, readStoredBaseUrlSync, refreshAnthropicToken, refreshGeminiToken, refreshKimiToken, refreshOpenAIToken, refreshXaiToken, registerLogCleanup, resample, setProgressCallback, toModelInfo, transcribeVoice, withFileLock };
+export { AUTH_PROVIDERS, type ApiKeyVariant, type AuthMethod, type AuthMethodMeta, type AuthProviderMeta, AuthStorage, type AutoUpdateConfig, type AutoUpdater, DEFAULT_LOCAL_ENDPOINTS, type DiscoverOptions, type DiscoveryResult, type DualAuthProvider, FALLBACK_CONTEXT_WINDOW, type InlineButton, LOCAL_API_KEY_PLACEHOLDER, LOCAL_AUTH_KEY_PREFIX, type LocalEndpoint, type LocalEndpointKind, type LocalEndpointProbe, type LocalModel, type LogLevel, MOONSHOT_OAUTH_KEY, ModelInfo, NotLoggedInError, type OAuthCredentials, type OAuthLoginCallbacks, PLAN_MODE_THINKING_CAP, type ProbeOptions, type ProgressCallback, SubscriptionUsageError, type SubscriptionUsageProvider, type SubscriptionUsageSnapshot, type SubscriptionUsageWindow, TelegramBot, type TelegramConfig, type TelegramMessage, type TelegramUpdate, type TelegramVoiceMessage, XAI_OAUTH_KEY, XIAOMI_CREDITS_KEY, authPriorityNote, clampThinkingForPlanMode, clearLocalDiscoveryCache, closeLogger, createAutoUpdater, decodeOggOpus, describeAuthMethods, discoverLocalModels, downmixToMono, dualAuthProvider, dualAuthProviderByOAuthKey, endpointRoot, fetchSubscriptionUsage, findProbedModel, formatLocalModelId, generatePKCE, getAuthProvider, getClaudeCliUserAgent, getClaudeCodeVersion, getLowestThinkingLevel, getNextThinkingLevel, getSessionId, getSupportedThinkingLevels, grokCliBaseUrl, grokCliHeaders, isGrokCliEndpoint, isKimiCodingEndpoint, isLocalModelId, isLoggerOpen, isModelLoaded, isThinkingLevelSupported, kimiCodeBaseUrl, kimiCodingHeaders, localAuthStorageKey, log, loginAnthropic, loginGemini, loginKimi, loginOpenAI, loginXai, oauthStorageKey, openLog, parseLocalModelId, probeEndpoint, providerStorageKeys, readStoredBaseUrlSync, refreshAnthropicToken, refreshGeminiToken, refreshKimiToken, refreshOpenAIToken, refreshXaiToken, registerLogCleanup, resample, setProgressCallback, toModelInfo, transcribeVoice, withFileLock };

package/dist/index.js

@@ -455,6 +455,159 @@ function findProbedModel(probes, modelId) {
   return void 0;
 }
 
+// src/auth-providers.ts
+var AUTH_PROVIDERS = [
+  {
+    value: "anthropic",
+    label: "Anthropic",
+    description: "Claude Fable 5.1, Opus 5.5, Sonnet 5.5, Haiku 5.5",
+    methods: ["oauth"]
+  },
+  {
+    value: "openai",
+    label: "OpenAI",
+    description: "GPT-6 Astra, GPT-6.1 Sol, GPT-6 Luna",
+    methods: ["oauth"]
+  },
+  {
+    value: "gemini",
+    label: "Gemini",
+    description: "Gemini 3.8 Flash, 3.5 Flash Lite, 3.7 Flash, 3.1 Flash Lite, 3.5 Flash, 3.1 Pro (Preview)",
+    methods: ["oauth"]
+  },
+  {
+    value: "xai",
+    label: "xAI (Grok)",
+    description: "Grok 4.7 \xB7 OAuth or API key",
+    methods: ["oauth", "apikey"],
+    apiKeyLabel: "xAI",
+    methodDetails: {
+      oauth: {
+        method: "oauth",
+        label: "Sign in with Grok",
+        billing: "Included with SuperGrok or X Premium.",
+        when: ""
+      },
+      apikey: {
+        method: "apikey",
+        label: "xAI API key",
+        billing: "Pay-per-token on console.x.ai credits.",
+        when: ""
+      }
+    }
+  },
+  {
+    value: "moonshot",
+    label: "Moonshot",
+    description: "Kimi K3, K2.8 Preview (Kimi sign-in), K2.7 Code, K2.7 Code HighSpeed \xB7 OAuth or API key",
+    methods: ["oauth", "apikey"],
+    apiKeyLabel: "Moonshot",
+    methodDetails: {
+      oauth: {
+        method: "oauth",
+        label: "Sign in with Kimi",
+        billing: "Included with a Kimi For Coding plan.",
+        when: ""
+      },
+      apikey: {
+        method: "apikey",
+        label: "Moonshot API key",
+        billing: "Pay-per-token on Moonshot credits.",
+        when: ""
+      }
+    }
+  },
+  {
+    value: "glm",
+    label: "Z.AI (GLM)",
+    description: "GLM-5.3, GLM-5.3-Flash",
+    methods: ["apikey"],
+    apiKeyLabel: "Z.AI"
+  },
+  {
+    value: "minimax",
+    label: "MiniMax",
+    description: "MiniMax M3",
+    methods: ["apikey"],
+    apiKeyLabel: "MiniMax"
+  },
+  {
+    value: "xiaomi",
+    label: "Xiaomi (MiMo)",
+    description: "MiMo-V2.6-Pro, MiMo-V2.6-Flash, MiMo-V2.6-Pro-UltraSpeed \xB7 Token Plan or API Credits",
+    methods: ["apikey"],
+    apiKeyLabel: "Xiaomi MiMo",
+    apiKeyBaseUrl: "https://token-plan-sgp.xiaomimimo.com/v1",
+    apiKeyVariants: [
+      {
+        key: "xiaomi",
+        label: "Token Plan",
+        baseUrl: "https://token-plan-sgp.xiaomimimo.com/v1"
+      },
+      {
+        key: XIAOMI_CREDITS_KEY,
+        label: "API Credits (required for UltraSpeed)",
+        baseUrl: "https://api.xiaomimimo.com/v1"
+      }
+    ]
+  },
+  {
+    value: "deepseek",
+    label: "DeepSeek",
+    description: "DeepSeek V4 Pro, V4.1 Flash",
+    methods: ["apikey"],
+    apiKeyLabel: "DeepSeek"
+  },
+  {
+    value: "sakana",
+    label: "Sakana (Fugu)",
+    description: "Fugu, Fugu Max, Fugu Ultra",
+    methods: ["apikey"],
+    apiKeyLabel: "Sakana"
+  },
+  {
+    value: "openrouter",
+    label: "OpenRouter",
+    description: "Qwen3.8 Max \xB7 multi-provider gateway",
+    methods: ["apikey"],
+    apiKeyLabel: "OpenRouter"
+  },
+  {
+    value: "huggingface",
+    label: "Hugging Face",
+    description: "Kimi K2.7 Code, DeepSeek V4.1 Flash, GPT-OSS 120B",
+    methods: ["apikey"],
+    apiKeyLabel: "Hugging Face"
+  }
+];
+function getAuthProvider(value) {
+  return AUTH_PROVIDERS.find((p) => p.value === value);
+}
+function describeAuthMethods(provider) {
+  const meta = getAuthProvider(provider);
+  if (!meta) return [];
+  return meta.methods.map((method) => {
+    const override = meta.methodDetails?.[method];
+    if (override) return { ...override };
+    return method === "oauth" ? {
+      method,
+      label: `Sign in with ${meta.label}`,
+      billing: "Uses your existing plan with this provider.",
+      when: ""
+    } : {
+      method,
+      label: `${meta.apiKeyLabel ?? meta.label} API key`,
+      billing: "Pay-per-token on this provider's API credits.",
+      when: ""
+    };
+  });
+}
+function authPriorityNote(provider) {
+  const dual = dualAuthProvider(provider);
+  if (!dual) return void 0;
+  return `Uses ${dual.oauthLabel} first; the ${dual.apiKeyLabel} takes over when it runs out, then switches back.`;
+}
+
 // src/provider-usage.ts
 var SubscriptionUsageError = class extends Error {
   constructor(message, status, retryAfterMs2) {
@@ -1190,6 +1343,7 @@ function createAutoUpdater(config) {
   };
 }
 export {
+  AUTH_PROVIDERS,
   AuthStorage,
   DEFAULT_LOCAL_ENDPOINTS,
   DEFAULT_MAX_VIDEO_BYTES,
@@ -1204,12 +1358,14 @@ export {
   TelegramBot,
   XAI_OAUTH_KEY,
   XIAOMI_CREDITS_KEY,
+  authPriorityNote,
   clampThinkingForPlanMode,
   clearLocalDiscoveryCache,
   clearRuntimeModels,
   closeLogger,
   createAutoUpdater,
   decodeOggOpus,
+  describeAuthMethods,
   discoverLocalModels,
   downmixToMono,
   dualAuthProvider,
@@ -1221,6 +1377,7 @@ export {
   generatePKCE,
   getAllModels,
   getAppPaths,
+  getAuthProvider,
   getAuthStorageKey,
   getAuthStorageKeys,
   getClaudeCliUserAgent,