@kenkaiiii/gg-core 5.92.0 → 5.94.0

package/NOTICE

@@ -1,5 +1,5 @@
 GG Coder
-Copyright (C) 2025-2026 KenKai
+Copyright (C) 2025-2026 Ken Kai
 
 This program is free software: you can redistribute it and/or modify it under
 the terms of the GNU Affero General Public License as published by the Free

package/README.md

@@ -1,68 +1,84 @@
-# @kenkaiiii/gg-core
+<h1 align="center">@kenkaiiii/gg-core</h1>
 
 <p align="center">
-  <strong>Model registry, auth storage and local-model discovery. No UI, no agent loop.</strong>
+  <strong>Model list, sign-in and local model discovery for apps built on gg-ai.</strong>
 </p>
 
 <p align="center">
-  <a href="https://www.npmjs.com/package/@kenkaiiii/gg-core"><img src="https://img.shields.io/npm/v/@kenkaiiii/gg-core?style=for-the-badge" alt="npm version"></a>
-  <a href="../../LICENSE"><img src="https://img.shields.io/badge/License-AGPL--3.0-blue.svg?style=for-the-badge" alt="AGPL-3.0 License"></a>
+  <a href="https://www.npmjs.com/package/@kenkaiiii/gg-core"><img src="https://img.shields.io/npm/v/@kenkaiiii/gg-core?style=for-the-badge&color=blue" alt="npm version"></a>
+  <a href="https://www.npmjs.com/package/@kenkaiiii/gg-core"><img src="https://img.shields.io/npm/dm/@kenkaiiii/gg-core?style=for-the-badge&color=2ecc71" alt="npm downloads per month"></a>
+  <a href="https://github.com/KenKaiii/gg-framework/blob/main/LICENSE"><img src="https://img.shields.io/badge/License-AGPL--3.0-blue.svg?style=for-the-badge" alt="AGPL-3.0 License"></a>
 </p>
 
-The shared foundation under GG Coder's app and CLI. It depends only on [`@kenkaiiii/gg-ai`](../gg-ai/README.md), never on React, Ink or the agent loop.
+gg-core is the shared base under [GG Coder](https://github.com/KenKaiii/gg-framework)'s desktop app and CLI. It knows every supported model (context window, image and video support, thinking levels), signs users in to their AI subscriptions, keeps those credentials fresh, and finds models running on the user's machine.
 
-Part of the [GG Framework](../../README.md) monorepo.
-
----
+It has no UI and no agent loop. Its only framework dependency is [`@kenkaiiii/gg-ai`](https://www.npmjs.com/package/@kenkaiiii/gg-ai).
 
 ## Install
 
 ```bash
-npm i @kenkaiiii/gg-core
+npm install @kenkaiiii/gg-core
 ```
 
----
-
-## What's inside
-
-| Area            | Main exports                                                                              |
-| --------------- | ----------------------------------------------------------------------------------------- |
-| Model registry  | `getModel`, `getAllModels`, `getModelsForProvider`, `getDefaultModel`, `getContextWindow` |
-| Thinking levels | `getSupportedThinkingLevels`, `getMaxThinkingLevel`, `getDefaultThinkingLevel`            |
-| Auth storage    | `AuthStorage` (reads and writes `~/.gg/auth.json`, refreshes OAuth tokens)                |
-| OAuth           | Anthropic, OpenAI, Gemini, Kimi and xAI login flows                                       |
-| Local models    | `discoverLocalModels` (Ollama, LM Studio, llama.cpp, vLLM, custom endpoints)              |
-| Paths           | `getAppPaths` (every file under `~/.gg/`)                                                 |
-| Other           | Logger, file lock, usage limits, Telegram, voice transcription, auto-update               |
+Needs Node.js 22 or newer. Ships ESM and CommonJS builds with TypeScript types.
 
-Two lighter subpath entries skip the rest of the package:
-
-```ts
-import { getModel } from "@kenkaiiii/gg-core/models";
-import { getAppPaths } from "@kenkaiiii/gg-core/paths";
-```
-
----
-
-## Example
+## Quick start
 
 ```ts
 import { AuthStorage, discoverLocalModels, getModel } from "@kenkaiiii/gg-core";
 
 const model = getModel("claude-sonnet-5-5");
-console.log(model?.contextWindow);
+console.log(model?.contextWindow, model?.supportsImages); // 1000000 true
 
+// Credentials saved by `ggcoder login` or the GG Coder app, refreshed when they expire.
 const auth = new AuthStorage();
 const token = await auth.resolveToken("anthropic");
 
+// Models on a running Ollama server.
 const { models } = await discoverLocalModels();
 console.log(models.map((m) => m.id));
 ```
 
-`AuthStorage` throws `NotLoggedInError` when a provider has no stored credentials.
+`resolveToken()` throws `NotLoggedInError` when the provider has no saved credentials.
+
+## What's inside
+
+| Area            | Main exports                                                                                                               |
+| --------------- | -------------------------------------------------------------------------------------------------------------------------- |
+| Models          | `getModel`, `getAllModels`, `getModelsForProvider`, `getDefaultModel`, `getContextWindow`, `MODELS`                        |
+| Thinking levels | `getSupportedThinkingLevels`, `getMaxThinkingLevel`, `getDefaultThinkingLevel`, `getNextThinkingLevel`                     |
+| Credentials     | `AuthStorage`: reads and writes `~/.gg/auth.json`, refreshes sign-in tokens, safe across processes                         |
+| Sign-in         | `loginOpenAI`, `loginKimi`, `loginXai`, `loginGemini` and matching `refresh…Token` functions; `loginClaudeCode` for Claude |
+| Provider list   | `AUTH_PROVIDERS`: each provider's name, models and sign-in methods, ready for a login screen                               |
+| Local models    | `discoverLocalModels`, `probeEndpoint`: Ollama by default, plus LM Studio, llama.cpp, vLLM or any custom URL               |
+| Plan usage      | `fetchSubscriptionUsage`: remaining Claude, ChatGPT and Kimi plan usage                                                    |
+| Paths           | `getAppPaths`: every file GG Coder keeps under `~/.gg/`                                                                    |
+| Other           | Logger, file lock, Telegram bot, voice transcription, auto-update                                                          |
+
+`AuthStorage` shares `~/.gg/auth.json` with GG Coder, so a user who has signed in there is already signed in to your tool. Pass a different file path to the constructor to keep your own.
+
+## Lighter imports
+
+Two subpaths load only what they need, which keeps startup fast:
+
+```ts
+import { getModel } from "@kenkaiiii/gg-core/models";
+import { getAppPaths } from "@kenkaiiii/gg-core/paths";
+```
+
+Voice transcription uses two optional dependencies (`@huggingface/transformers`, `ogg-opus-decoder`). Everything else works without them.
+
+## The GG Framework
+
+| Package                                                                  | What it does                                                                     |
+| ------------------------------------------------------------------------ | -------------------------------------------------------------------------------- |
+| [@kenkaiiii/gg-ai](https://www.npmjs.com/package/@kenkaiiii/gg-ai)       | One streaming API for every provider                                             |
+| [@kenkaiiii/gg-agent](https://www.npmjs.com/package/@kenkaiiii/gg-agent) | The agent loop: runs tools and feeds results back to the model                   |
+| **@kenkaiiii/gg-core**                                                   | Model list, sign-in and stored credentials, local model discovery (this package) |
+| [@kenkaiiii/ggcoder](https://www.npmjs.com/package/@kenkaiiii/ggcoder)   | The GG Coder coding agent: CLI, tools and sessions                               |
 
----
+Source, issues and the desktop app: [github.com/KenKaiii/gg-framework](https://github.com/KenKaiii/gg-framework).
 
 ## License
 
-AGPL-3.0-only. See [LICENSE](../../LICENSE).
+[AGPL-3.0-only](https://github.com/KenKaiii/gg-framework/blob/main/LICENSE). You can build on it; if you distribute your changes or run them as a network service, share their source under the same license.

package/dist/{chunk-2X5L6U4Z.js → chunk-GXOFTHM5.js}

@@ -21,11 +21,13 @@ function getAppPaths() {
     agentsDir: path.join(agentDir, "agents"),
     progressFile: path.join(agentDir, "progress.json"),
     progressBackupFile: path.join(agentDir, "progress.backup.json"),
-    trophiesFile: path.join(agentDir, "trophies.json")
+    trophiesFile: path.join(agentDir, "trophies.json"),
+    claudeCodeDir: path.join(agentDir, "claude-code"),
+    claudeCodeConfigDir: path.join(agentDir, "claude-code", "config")
   };
 }
 
 export {
   getAppPaths
 };
-//# sourceMappingURL=chunk-2X5L6U4Z.js.map
+//# sourceMappingURL=chunk-GXOFTHM5.js.map

package/dist/chunk-GXOFTHM5.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/paths.ts"],"sourcesContent":["import path from \"node:path\";\nimport os from \"node:os\";\n\nexport interface AppPaths {\n  agentDir: string;\n  sessionsDir: string;\n  subagentSessionsDir: string;\n  subagentsDir: string;\n  settingsFile: string;\n  authFile: string;\n  telegramFile: string;\n  agentHomeFile: string;\n  mcpFile: string;\n  mcpAuthFile: string;\n  /** Cached MCP tool catalog, so a cold start can answer tool_search honestly. */\n  mcpCatalogFile: string;\n  logFile: string;\n  skillsDir: string;\n  extensionsDir: string;\n  agentsDir: string;\n  progressFile: string;\n  progressBackupFile: string;\n  /** Earned trophies and the counters that unlock them. */\n  trophiesFile: string;\n  /** On-demand Claude Code binaries for \"Sign in with Claude\", one dir per version. */\n  claudeCodeDir: string;\n  /** GG Coder's own Claude Code login (CLAUDE_CONFIG_DIR), separate from the user's. */\n  claudeCodeConfigDir: string;\n}\n\nexport function getAppPaths(): AppPaths {\n  const agentDir = path.join(os.homedir(), \".gg\");\n  return {\n    agentDir,\n    sessionsDir: path.join(agentDir, \"sessions\"),\n    subagentSessionsDir: path.join(agentDir, \"subagent-sessions\"),\n    subagentsDir: path.join(agentDir, \"subagents\"),\n    settingsFile: path.join(agentDir, \"settings.json\"),\n    authFile: path.join(agentDir, \"auth.json\"),\n    telegramFile: path.join(agentDir, \"telegram.json\"),\n    agentHomeFile: path.join(agentDir, \"agent-home.json\"),\n    mcpFile: path.join(agentDir, \"mcp.json\"),\n    mcpAuthFile: path.join(agentDir, \"mcp-auth.json\"),\n    mcpCatalogFile: path.join(agentDir, \"mcp-catalog.json\"),\n    logFile: path.join(agentDir, \"debug.log\"),\n    skillsDir: path.join(agentDir, \"skills\"),\n    extensionsDir: path.join(agentDir, \"extensions\"),\n    agentsDir: path.join(agentDir, \"agents\"),\n    progressFile: path.join(agentDir, \"progress.json\"),\n    progressBackupFile: path.join(agentDir, \"progress.backup.json\"),\n    trophiesFile: path.join(agentDir, \"trophies.json\"),\n    claudeCodeDir: path.join(agentDir, \"claude-code\"),\n    claudeCodeConfigDir: path.join(agentDir, \"claude-code\", \"config\"),\n  };\n}\n"],"mappings":";AAAA,OAAO,UAAU;AACjB,OAAO,QAAQ;AA6BR,SAAS,cAAwB;AACtC,QAAM,WAAW,KAAK,KAAK,GAAG,QAAQ,GAAG,KAAK;AAC9C,SAAO;AAAA,IACL;AAAA,IACA,aAAa,KAAK,KAAK,UAAU,UAAU;AAAA,IAC3C,qBAAqB,KAAK,KAAK,UAAU,mBAAmB;AAAA,IAC5D,cAAc,KAAK,KAAK,UAAU,WAAW;AAAA,IAC7C,cAAc,KAAK,KAAK,UAAU,eAAe;AAAA,IACjD,UAAU,KAAK,KAAK,UAAU,WAAW;AAAA,IACzC,cAAc,KAAK,KAAK,UAAU,eAAe;AAAA,IACjD,eAAe,KAAK,KAAK,UAAU,iBAAiB;AAAA,IACpD,SAAS,KAAK,KAAK,UAAU,UAAU;AAAA,IACvC,aAAa,KAAK,KAAK,UAAU,eAAe;AAAA,IAChD,gBAAgB,KAAK,KAAK,UAAU,kBAAkB;AAAA,IACtD,SAAS,KAAK,KAAK,UAAU,WAAW;AAAA,IACxC,WAAW,KAAK,KAAK,UAAU,QAAQ;AAAA,IACvC,eAAe,KAAK,KAAK,UAAU,YAAY;AAAA,IAC/C,WAAW,KAAK,KAAK,UAAU,QAAQ;AAAA,IACvC,cAAc,KAAK,KAAK,UAAU,eAAe;AAAA,IACjD,oBAAoB,KAAK,KAAK,UAAU,sBAAsB;AAAA,IAC9D,cAAc,KAAK,KAAK,UAAU,eAAe;AAAA,IACjD,eAAe,KAAK,KAAK,UAAU,aAAa;AAAA,IAChD,qBAAqB,KAAK,KAAK,UAAU,eAAe,QAAQ;AAAA,EAClE;AACF;","names":[]}