pi-openai-toolkit 0.3.0 → 0.4.0

package/README.md

@@ -17,10 +17,22 @@
 
 ## Installation
 
-### Install via Pi Package Manager (recommended)
+### Install the published package globally (recommended)
 
 ```bash
-pi install npm:pi-openai-toolkit
+pi install npm:pi-openai-toolkit@0.3.0
+```
+
+This adds the package to Pi's global settings. Verify the installation with:
+
+```bash
+pi list
+```
+
+To install it only for the current project, use:
+
+```bash
+pi install npm:pi-openai-toolkit@0.3.0 --local
 ```
 
 ### Git installation (alternative / development)
@@ -59,6 +71,12 @@ Configuration file location:
 ~/.pi/agent/extensions/pi-openai-toolkit/config.json
 ```
 
+On Windows:
+
+```text
+C:\Users\<user>\.pi\agent\extensions\pi-openai-toolkit\config.json
+```
+
 ### Example `config.json`
 
 ```json
@@ -66,6 +84,7 @@ Configuration file location:
   "compaction": {
     "enabled": true,
     "allowCompactionContinuityBreak": false,
+    "remoteCompactModel": "uwoacrimson/gpt-5.6-luna",
     "model": null,
     "thinkingLevel": "off",
     "responsesApis": [
@@ -94,13 +113,14 @@ Configuration file location:
 
 - `enabled` (*boolean*, default: `true`): Enable or disable Remote Compaction.
 - `allowCompactionContinuityBreak` (*boolean*, default: `false`): When `true`, allows restarting a fresh native opaque compaction chain from Pi's current session text if the latest compaction was made by another strategy (e.g. text summary).
-- `model` (*string | null*, default: `null`): Fallback model formatted as `provider/model-id` (e.g. `"openai/gpt-4o-mini"`) used if the remote compact gateway fails or when switching to non-Responses APIs. If `null`, uses the session's active model.
+- `remoteCompactModel` (*string | null*, default: `null`): Model formatted as `provider/model-id` used only for the synthetic `remote_compaction_v2` request. Pi's active session model is not switched and resumes normal requests after compaction. The override must resolve to the same provider, Responses API identifier, and effective base URL as the active model. `null` preserves the current same-model path.
+- `model` (*string | null*, default: `null`): Separate native text-summary fallback model formatted as `provider/model-id` (e.g. `"openai/gpt-4o-mini"`) used if remote v2 is unavailable or fails. If `null`, Pi uses its default current-model compaction path.
 - `thinkingLevel` (*string*, default: `"off"`): Reasoning / thinking level passed to Pi native compaction fallback (`"off"`, `"minimal"`, `"low"`, `"medium"`, `"high"`, `"xhigh"`, `"max"`).
 - `responsesApis` (*string[]*): Narrow the supported remote compaction API identifiers (subset of `["openai-responses", "openai-codex-responses"]`).
 - `notifyOnLoad` (*boolean*, default: `false`): Show a notification banner on Pi startup.
 - `debug` (*boolean*, default: `false`): Output diagnostics and write execution artifacts to disk.
 - `logProviderPayloads` / `logCompactResponses` (*boolean*, default: `false`): Write raw provider request payloads and compact SSE event bodies to artifacts.
-- `redactSensitiveData` (*boolean*, default: `true`): Automatically redact Authorization headers, API keys, sensitive URL query tokens, and opaque `encrypted_content` ciphertext from debug artifacts.
+- `redactSensitiveData` (*boolean*, default: `true`): Apply full sensitive-value redaction to debug artifacts. Authorization credentials, API keys/tokens, and opaque `encrypted_content` are always redacted even when this option is `false`.
 - `artifactRoot` (*string*): Directory root for diagnostic artifacts. Relative paths resolve against the config directory.
 
 #### `webSearch`
@@ -132,6 +152,7 @@ Content-Type: application/json
 ```
 
 - **Validation Criteria**: Must return a valid SSE stream with `response.completed` (status `completed`) containing exactly one output item of `type: "compaction"` with non-empty `encrypted_content`.
+- **Remote Model Override**: `compaction.remoteCompactModel` can assign a same-gateway Responses model as the checkpoint producer while the active model remains the consumer. Its registered model metadata, authentication, headers, and effective base URL are used only for the synthetic compact request. Existing and recursive checkpoints remain replayable by the active model.
 - **Zero Loss Replay**: The opaque encrypted item is stored in `CompactionEntry.details.compactedWindow`. On subsequent requests, it is transparently prepended after fresh preamble instructions alongside live turns, eliminating lossy text re-summaries.
 - **Graceful Multi-Tier Fallback**:
   1. Compatible Responses endpoints &rarr; Remote v2 Opaque Compaction.

package/README_zh.md

@@ -17,10 +17,22 @@
 
 ## 安装使用
 
-### 通过 Pi 安装 (推荐)
+### 全局安装已发布版本（推荐）
 
 ```bash
-pi install npm:pi-openai-toolkit
+pi install npm:pi-openai-toolkit@0.3.0
+```
+
+该命令会把工具包加入 Pi 的全局配置。可以使用以下命令确认安装成功：
+
+```bash
+pi list
+```
+
+如果只想安装到当前项目，使用：
+
+```bash
+pi install npm:pi-openai-toolkit@0.3.0 --local
 ```
 
 ### Git 安装（替代 / 开发路径）
@@ -59,6 +71,12 @@ pi --no-extensions -e /本地绝对路径/pi-openai-toolkit/extensions/web-searc
 ~/.pi/agent/extensions/pi-openai-toolkit/config.json
 ```
 
+Windows 下对应：
+
+```text
+C:\Users\<user>\.pi\agent\extensions\pi-openai-toolkit\config.json
+```
+
 ### 配置示例
 
 ```json
@@ -66,6 +84,7 @@ pi --no-extensions -e /本地绝对路径/pi-openai-toolkit/extensions/web-searc
   "compaction": {
     "enabled": true,
     "allowCompactionContinuityBreak": false,
+    "remoteCompactModel": "uwoacrimson/gpt-5.6-luna",
     "model": null,
     "thinkingLevel": "off",
     "responsesApis": [
@@ -94,13 +113,14 @@ pi --no-extensions -e /本地绝对路径/pi-openai-toolkit/extensions/web-searc
 
 - `enabled` (*boolean*, 默认 `true`): 是否启用远端无损压缩。
 - `allowCompactionContinuityBreak` (*boolean*, 默认 `false`): 若最近一次历史压缩由其他方式（如文本摘要）生成，设为 `true` 允许直接从当前有效文本上下文重建密文压缩链。
-- `model` (*string | null*, 默认 `null`): 降级模型，格式为 `"provider/model-id"`（例如 `"openai/gpt-4o-mini"`）。当网关不支持远端压缩或切换到非 Responses 协议模型时使用。为 `null` 时使用当前会话模型。
+- `remoteCompactModel` (*string | null*, 默认 `null`): 仅用于 synthetic `remote_compaction_v2` 请求的模型，格式为 `"provider/model-id"`。Pi 不会切换当前会话模型，压缩完成后仍由原模型继续正常请求。覆盖模型必须与当前模型使用相同的 Provider、Responses API 标识符和实际生效的 Base URL。为 `null` 时保持当前模型执行远端压缩的原有行为。
+- `model` (*string | null*, 默认 `null`): 独立的原生文本摘要降级模型，格式为 `"provider/model-id"`（例如 `"openai/gpt-4o-mini"`）。当 Remote v2 不可用或失败时使用；为 `null` 时进入 Pi 默认的当前模型压缩路径。
 - `thinkingLevel` (*string*, 默认 `"off"`): 降级模型调用 Pi 原生压缩时的思考级别（`"off"`, `"minimal"`, `"low"`, `"medium"`, `"high"`, `"xhigh"`, `"max"`）。
 - `responsesApis` (*string[]*): 允许尝试远端压缩的 API 标识符子集（从 `["openai-responses", "openai-codex-responses"]` 中选定）。
 - `notifyOnLoad` (*boolean*, 默认 `false`): Pi 启动加载时是否弹出气泡提示。
 - `debug` (*boolean*, 默认 `false`): 是否开启调试模式并记录诊断日志。
 - `logProviderPayloads` / `logCompactResponses` (*boolean*, 默认 `false`): 是否在 Artifacts 中记录完整的 Provider 请求与 SSE 流事件体。
-- `redactSensitiveData` (*boolean*, 默认 `true`): 自动对日志中的 Authorization 请求头、API Key、URL 敏感参数及 `encrypted_content` 密文进行脱敏处理（替换为 `[REDACTED]`）。
+- `redactSensitiveData` (*boolean*, 默认 `true`): 对调试日志应用完整的敏感值脱敏。即使设为 `false`，Authorization 凭据、API Key/Token 和 `encrypted_content` 密文也始终会被替换为 `[REDACTED]`。
 - `artifactRoot` (*string*): 诊断日志存储根目录，支持 `~/` 路径。
 
 #### `webSearch`（联网搜索配置）
@@ -132,6 +152,7 @@ Content-Type: application/json
 ```
 
 - **校验标准**：接收 SSE 流并验证 `response.completed` 事件（状态为 `completed`），且返回且仅返回一个包含非空 `encrypted_content` 密文的 `type: "compaction"` 数据块。
+- **远端压缩模型覆盖**：`compaction.remoteCompactModel` 可以让同一网关上的另一个 Responses 模型负责生成 checkpoint，而当前活动模型仍是 checkpoint 的消费者。synthetic 压缩请求会使用覆盖模型在注册表中的模型元数据、认证、请求头和实际 Base URL；旧 checkpoint、递归压缩 checkpoint 都仍由当前活动模型重放。
 - **无损重放机制**：密文数据完整存入 `CompactionEntry.details.compactedWindow`。在后续对话中，插件会自动将密文插入在最新的系统指令之后与最新几轮消息之前，实现完全服务端无损上下文还原。
 - **三级优雅降级**：
   1. 支持的 Responses 端点 &rarr; 触发 Remote v2 密文无损压缩；

package/package.json

@@ -1,79 +1,79 @@
-{
-  "name": "pi-openai-toolkit",
-  "version": "0.3.0",
-  "private": false,
-  "type": "module",
-  "description": "OpenAI-focused Pi toolkit providing remote Responses compaction and native Web Search.",
-  "author": "awoaCrim and contributors",
-  "license": "MIT",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/awoaCrim/pi-openai-toolkit.git"
-  },
-  "bugs": {
-    "url": "https://github.com/awoaCrim/pi-openai-toolkit/issues"
-  },
-  "homepage": "https://github.com/awoaCrim/pi-openai-toolkit#readme",
-  "publishConfig": {
-    "access": "public",
-    "registry": "https://registry.npmjs.org/"
-  },
-  "keywords": [
-    "pi-package",
-    "pi-extension",
-    "openai",
-    "compaction",
-    "web-search",
-    "codex",
-    "responses"
-  ],
-  "pi": {
-    "extensions": [
-      "./extensions/compaction.ts",
-      "./extensions/web-search.ts"
-    ]
-  },
-  "files": [
-    "extensions/compaction.ts",
-    "extensions/web-search.ts",
-    "src/compact-client.ts",
-    "src/config.ts",
-    "src/debug.ts",
-    "src/details-store.ts",
-    "src/extension-runtime.ts",
-    "src/native-fallback.ts",
-    "src/payload-rewrite.ts",
-    "src/provider-headers.ts",
-    "src/remote-v2-client.ts",
-    "src/request-context-cache.ts",
-    "src/runtime.ts",
-    "src/serializer.ts",
-    "src/supported-environment.ts",
-    "src/types.ts",
-    "src/web-search/extension.ts",
-    "src/web-search/payload.ts",
-    "src/web-search/prompt.ts",
-    "src/web-search/types.ts",
-    "README.md",
-    "README_zh.md",
-    "LICENSE",
-    "NOTICE",
-    "tsconfig.check.json"
-  ],
-  "scripts": {
-    "test": "bun test",
-    "test:coverage": "bun test --coverage --coverage-reporter=text --coverage-reporter=lcov && node ./scripts/check-lcov.mjs ./coverage/lcov.info",
-    "test:pi": "bun test ./test/pi-smoke.test.ts",
-    "typecheck": "tsc -p tsconfig.check.json"
-  },
-  "peerDependencies": {
-    "@earendil-works/pi-agent-core": "*",
-    "@earendil-works/pi-ai": "*",
-    "@earendil-works/pi-coding-agent": ">=0.80.0"
-  },
-  "devDependencies": {
-    "@types/node": "24.12.4",
-    "bun": "1.2.23",
-    "typescript": "5.9.3"
-  }
-}
+{
+  "name": "pi-openai-toolkit",
+  "version": "0.4.0",
+  "private": false,
+  "type": "module",
+  "description": "OpenAI-focused Pi toolkit providing remote Responses compaction and native Web Search.",
+  "author": "awoaCrim and contributors",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/awoaCrim/pi-openai-toolkit.git"
+  },
+  "bugs": {
+    "url": "https://github.com/awoaCrim/pi-openai-toolkit/issues"
+  },
+  "homepage": "https://github.com/awoaCrim/pi-openai-toolkit#readme",
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "keywords": [
+    "pi-package",
+    "pi-extension",
+    "openai",
+    "compaction",
+    "web-search",
+    "codex",
+    "responses"
+  ],
+  "pi": {
+    "extensions": [
+      "./extensions/compaction.ts",
+      "./extensions/web-search.ts"
+    ]
+  },
+  "files": [
+    "extensions/compaction.ts",
+    "extensions/web-search.ts",
+    "src/compact-client.ts",
+    "src/config.ts",
+    "src/debug.ts",
+    "src/details-store.ts",
+    "src/extension-runtime.ts",
+    "src/native-fallback.ts",
+    "src/payload-rewrite.ts",
+    "src/provider-headers.ts",
+    "src/remote-v2-client.ts",
+    "src/request-context-cache.ts",
+    "src/runtime.ts",
+    "src/serializer.ts",
+    "src/supported-environment.ts",
+    "src/types.ts",
+    "src/web-search/extension.ts",
+    "src/web-search/payload.ts",
+    "src/web-search/prompt.ts",
+    "src/web-search/types.ts",
+    "README.md",
+    "README_zh.md",
+    "LICENSE",
+    "NOTICE",
+    "tsconfig.check.json"
+  ],
+  "scripts": {
+    "test": "bun test",
+    "test:coverage": "bun test --coverage --coverage-reporter=text --coverage-reporter=lcov && node ./scripts/check-lcov.mjs ./coverage/lcov.info",
+    "test:pi": "bun test ./test/pi-smoke.test.ts",
+    "typecheck": "tsc -p tsconfig.check.json"
+  },
+  "peerDependencies": {
+    "@earendil-works/pi-agent-core": "*",
+    "@earendil-works/pi-ai": "*",
+    "@earendil-works/pi-coding-agent": ">=0.80.0"
+  },
+  "devDependencies": {
+    "@types/node": "24.12.4",
+    "bun": "1.2.23",
+    "typescript": "5.9.3"
+  }
+}