pi-openai-toolkit 0.23.1 → 0.23.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -21
- package/NOTICE +83 -83
- package/README.md +6 -2
- package/README.zh.md +6 -2
- package/config.schema.json +278 -278
- package/docs/configuration.md +306 -298
- package/docs/internals.md +184 -181
- package/package.json +136 -135
- package/src/compact-client.ts +412 -412
- package/src/compaction-projection.ts +35 -35
- package/src/config/migration.ts +103 -103
- package/src/config.ts +310 -310
- package/src/context-management/codex-provider.ts +270 -270
- package/src/context-management/history-notes.ts +357 -357
- package/src/context-management/manual-compact.ts +247 -599
- package/src/context-management/scoped-compaction.ts +89 -0
- package/src/context-management/tools.ts +371 -371
- package/src/context-management/types.ts +168 -168
- package/src/context-management/window-manager.ts +912 -905
- package/src/debug.ts +238 -238
- package/src/deferred-tool-carryover.ts +282 -282
- package/src/details-store.ts +151 -151
- package/src/extension-runtime.ts +1919 -1986
- package/src/image-generation/extension.ts +189 -189
- package/src/image-generation/protocol.ts +579 -579
- package/src/image-generation/types.ts +300 -300
- package/src/native-fallback.ts +32 -29
- package/src/payload-rewrite.ts +515 -515
- package/src/pi-context-hook.ts +117 -117
- package/src/remote-v2-client.ts +811 -811
- package/src/request-context-cache.ts +155 -155
- package/src/responses-headers.ts +180 -180
- package/src/runtime.ts +865 -865
- package/src/serializer.ts +882 -882
- package/src/supported-environment.ts +27 -27
- package/src/types.ts +565 -565
- package/src/web-search/alpha-client.ts +876 -876
- package/src/web-search/extension.ts +530 -530
- package/src/web-search/payload.ts +299 -299
- package/src/web-search/prompt.ts +60 -60
- package/src/web-search/types.ts +166 -166
- package/tsconfig.check.json +50 -50
package/LICENSE
CHANGED
|
@@ -1,21 +1,21 @@
|
|
|
1
|
-
MIT License
|
|
2
|
-
|
|
3
|
-
Copyright (c) 2026 lll9p
|
|
4
|
-
|
|
5
|
-
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
-
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
-
in the Software without restriction, including without limitation the rights
|
|
8
|
-
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
-
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
-
furnished to do so, subject to the following conditions:
|
|
11
|
-
|
|
12
|
-
The above copyright notice and this permission notice shall be included in all
|
|
13
|
-
copies or substantial portions of the Software.
|
|
14
|
-
|
|
15
|
-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
-
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
-
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
-
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
-
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
-
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
-
SOFTWARE.
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 lll9p
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/NOTICE
CHANGED
|
@@ -1,83 +1,83 @@
|
|
|
1
|
-
pi-openai-toolkit
|
|
2
|
-
Copyright (c) 2026 awoaCrim and contributors
|
|
3
|
-
|
|
4
|
-
The native OpenAI Web Search behavior in this package was adapted from
|
|
5
|
-
code-yeongyu/pi-openai-web-search at commit
|
|
6
|
-
39643380682f02f306b0de2673ff136c45ccc2a2.
|
|
7
|
-
|
|
8
|
-
Upstream copyright and license notice:
|
|
9
|
-
|
|
10
|
-
Copyright (c) 2026 Yeongyu Kim
|
|
11
|
-
|
|
12
|
-
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
13
|
-
of this software and associated documentation files (the "Software"), to deal
|
|
14
|
-
in the Software without restriction, including without limitation the rights
|
|
15
|
-
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
16
|
-
copies of the Software, and to permit persons to whom the Software is
|
|
17
|
-
furnished to do so, subject to the following conditions:
|
|
18
|
-
|
|
19
|
-
The above copyright notice and this permission notice shall be included in all
|
|
20
|
-
copies or substantial portions of the Software.
|
|
21
|
-
|
|
22
|
-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
23
|
-
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
24
|
-
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
25
|
-
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
26
|
-
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
27
|
-
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
28
|
-
SOFTWARE.
|
|
29
|
-
|
|
30
|
-
The adapted implementation targets the @earendil-works Pi interfaces and is
|
|
31
|
-
integrated with pi-openai-toolkit's independent compaction and Web Search
|
|
32
|
-
extension entry points. The upstream NOTICE also identifies the behavior as a
|
|
33
|
-
standalone port of the senpi-mono built-in openai-web-search extension.
|
|
34
|
-
|
|
35
|
-
The stable reasoning-effort planner in src/codex-astra/effort-planner.ts was
|
|
36
|
-
ported from Oh My Pi (@oh-my-pi/pi-ai, providers/openai-configuration-update.ts)
|
|
37
|
-
at version 18.1.8.
|
|
38
|
-
|
|
39
|
-
Upstream copyright and license notice:
|
|
40
|
-
|
|
41
|
-
MIT License
|
|
42
|
-
|
|
43
|
-
Copyright (c) 2025 Mario Zechner
|
|
44
|
-
Copyright (c) 2025-2026 Can Bölük
|
|
45
|
-
Copyright (c) 2026 Stencil Labs, Inc.
|
|
46
|
-
|
|
47
|
-
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
48
|
-
of this software and associated documentation files (the "Software"), to deal
|
|
49
|
-
in the Software without restriction, including without limitation the rights
|
|
50
|
-
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
51
|
-
copies of the Software, and to permit persons to whom the Software is
|
|
52
|
-
furnished to do so, subject to the following conditions:
|
|
53
|
-
|
|
54
|
-
The above copyright notice and this permission notice shall be included in all
|
|
55
|
-
copies or substantial portions of the Software.
|
|
56
|
-
|
|
57
|
-
The Remote Context management implementation in src/context-management/ was
|
|
58
|
-
adapted from @howaboua/pi-codex-conversion@3.0.29 at source commit
|
|
59
|
-
7021ae48e8efe36a3becc5830d529696ff798e5e.
|
|
60
|
-
|
|
61
|
-
Upstream copyright and license notice:
|
|
62
|
-
|
|
63
|
-
MIT License
|
|
64
|
-
|
|
65
|
-
Copyright (c) 2026 Igor Warzocha
|
|
66
|
-
|
|
67
|
-
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
68
|
-
of this software and associated documentation files (the "Software"), to deal
|
|
69
|
-
in the Software without restriction, including without limitation the rights
|
|
70
|
-
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
71
|
-
copies of the Software, and to permit persons to whom the Software is
|
|
72
|
-
furnished to do so, subject to the following conditions:
|
|
73
|
-
|
|
74
|
-
The above copyright notice and this permission notice shall be included in all
|
|
75
|
-
copies or substantial portions of the Software.
|
|
76
|
-
|
|
77
|
-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
78
|
-
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
79
|
-
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
80
|
-
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
81
|
-
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
82
|
-
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
83
|
-
SOFTWARE.
|
|
1
|
+
pi-openai-toolkit
|
|
2
|
+
Copyright (c) 2026 awoaCrim and contributors
|
|
3
|
+
|
|
4
|
+
The native OpenAI Web Search behavior in this package was adapted from
|
|
5
|
+
code-yeongyu/pi-openai-web-search at commit
|
|
6
|
+
39643380682f02f306b0de2673ff136c45ccc2a2.
|
|
7
|
+
|
|
8
|
+
Upstream copyright and license notice:
|
|
9
|
+
|
|
10
|
+
Copyright (c) 2026 Yeongyu Kim
|
|
11
|
+
|
|
12
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
13
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
14
|
+
in the Software without restriction, including without limitation the rights
|
|
15
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
16
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
17
|
+
furnished to do so, subject to the following conditions:
|
|
18
|
+
|
|
19
|
+
The above copyright notice and this permission notice shall be included in all
|
|
20
|
+
copies or substantial portions of the Software.
|
|
21
|
+
|
|
22
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
23
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
24
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
25
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
26
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
27
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
28
|
+
SOFTWARE.
|
|
29
|
+
|
|
30
|
+
The adapted implementation targets the @earendil-works Pi interfaces and is
|
|
31
|
+
integrated with pi-openai-toolkit's independent compaction and Web Search
|
|
32
|
+
extension entry points. The upstream NOTICE also identifies the behavior as a
|
|
33
|
+
standalone port of the senpi-mono built-in openai-web-search extension.
|
|
34
|
+
|
|
35
|
+
The stable reasoning-effort planner in src/codex-astra/effort-planner.ts was
|
|
36
|
+
ported from Oh My Pi (@oh-my-pi/pi-ai, providers/openai-configuration-update.ts)
|
|
37
|
+
at version 18.1.8.
|
|
38
|
+
|
|
39
|
+
Upstream copyright and license notice:
|
|
40
|
+
|
|
41
|
+
MIT License
|
|
42
|
+
|
|
43
|
+
Copyright (c) 2025 Mario Zechner
|
|
44
|
+
Copyright (c) 2025-2026 Can Bölük
|
|
45
|
+
Copyright (c) 2026 Stencil Labs, Inc.
|
|
46
|
+
|
|
47
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
48
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
49
|
+
in the Software without restriction, including without limitation the rights
|
|
50
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
51
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
52
|
+
furnished to do so, subject to the following conditions:
|
|
53
|
+
|
|
54
|
+
The above copyright notice and this permission notice shall be included in all
|
|
55
|
+
copies or substantial portions of the Software.
|
|
56
|
+
|
|
57
|
+
The Remote Context management implementation in src/context-management/ was
|
|
58
|
+
adapted from @howaboua/pi-codex-conversion@3.0.29 at source commit
|
|
59
|
+
7021ae48e8efe36a3becc5830d529696ff798e5e.
|
|
60
|
+
|
|
61
|
+
Upstream copyright and license notice:
|
|
62
|
+
|
|
63
|
+
MIT License
|
|
64
|
+
|
|
65
|
+
Copyright (c) 2026 Igor Warzocha
|
|
66
|
+
|
|
67
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
68
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
69
|
+
in the Software without restriction, including without limitation the rights
|
|
70
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
71
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
72
|
+
furnished to do so, subject to the following conditions:
|
|
73
|
+
|
|
74
|
+
The above copyright notice and this permission notice shall be included in all
|
|
75
|
+
copies or substantial portions of the Software.
|
|
76
|
+
|
|
77
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
78
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
79
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
80
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
81
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
82
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
83
|
+
SOFTWARE.
|
package/README.md
CHANGED
|
@@ -56,9 +56,13 @@ Set `context.remoteCompaction.model` to use a separate producer on the same effe
|
|
|
56
56
|
|
|
57
57
|
**Remote windows** require the native `openai-codex` provider with `openai-codex-responses`, or an `openai-responses` gateway implementing the protocol. Gateways require `compatibility.transport: "codex-gateway"` on the exact model entry. This setting does not add the capability to an ordinary compatible endpoint.
|
|
58
58
|
|
|
59
|
-
Change `mode` in the example above to `remote-windows`. Eligible sessions expose `new_context`, `get_context_remaining`, `history`, and `notes`. Manual `/compact [instructions]`
|
|
59
|
+
Change `mode` in the example above to `remote-windows`. Eligible sessions expose `new_context`, `get_context_remaining`, `history`, and `notes`. Manual `/compact [instructions]` uses Pi's native text compression of **only the current window**. It does not use the Toolkit remote producer or configured fallback, switch the active model, open another window, or send an automatic continuation. `remote-compaction` is the mode that selects Toolkit's remote/fallback compression chain.
|
|
60
60
|
|
|
61
|
-
An existing effective window boundary survives model changes and switches to `remote-compaction` or `pi`:
|
|
61
|
+
An existing effective window boundary survives model changes and switches to `remote-compaction` or `pi`: retired history stays outside live requests and every compaction tier. Historical boundaries constrain input; they cannot replace a requested compression with no-summary cleanup. Window identity is preserved for switching back. An unsafe current-window view cancels rather than reopening archived windows. The legacy `leaveManagedMode` setting remains compatible but does not trigger bulk close-out compaction.
|
|
62
|
+
|
|
63
|
+
Native text compression cannot read an existing encrypted checkpoint. If that checkpoint owns the current context, native compression/fallback cancels and preserves it instead of summarizing its placeholder and losing information. Compatible remote compression can still reuse it.
|
|
64
|
+
|
|
65
|
+
Raw history remains in the local Pi session JSONL; remote `history`/`notes` are separate backend APIs. Window markers alone are not native Pi cutoffs, so request-time isolation requires the extension to be loaded. An old session already ending in a no-summary cleanup may report `Already compacted` before any extension hook; continue with a genuine user message before retrying. Toolkit does not rewrite those logs or bypass Pi's eligibility checks.
|
|
62
66
|
|
|
63
67
|
Remote windows use alpha endpoints that may change upstream. When switching models, the remote window remains persisted and reusable; see the [window lifecycle](docs/internals.md#rollover-lifecycle).
|
|
64
68
|
|
package/README.zh.md
CHANGED
|
@@ -56,9 +56,13 @@ Toolkit 只读取一个全局配置文件,即使扩展安装在项目内也一
|
|
|
56
56
|
|
|
57
57
|
**远程窗口**需要原生 `openai-codex` 提供商的 `openai-codex-responses` API,或支持相应协议的 `openai-responses` 网关。网关必须在精确模型下设置 `compatibility.transport: "codex-gateway"`;这一设置不会让普通兼容端点自动获得该能力。
|
|
58
58
|
|
|
59
|
-
将上例的 `mode` 改为 `remote-windows` 后,符合条件的会话会提供 `new_context`、`get_context_remaining`、`history` 和 `notes`。手动 `/compact [instructions]`
|
|
59
|
+
将上例的 `mode` 改为 `remote-windows` 后,符合条件的会话会提供 `new_context`、`get_context_remaining`、`history` 和 `notes`。手动 `/compact [instructions]` 使用 Pi 原生文本压缩,**只处理当前窗口**。它不调用 Toolkit 的远程 producer 或指定回退模型,不切换当前模型、打开新窗口,也不自动发送续跑提示。只有 `remote-compaction` 模式选择 Toolkit 的远程压缩及回退链路。
|
|
60
60
|
|
|
61
|
-
切换模型或改用 `remote-compaction`、`pi`
|
|
61
|
+
切换模型或改用 `remote-compaction`、`pi` 模式后,已有的有效窗口边界仍然生效:旧历史不会进入普通请求或任何压缩层。历史边界只限定输入,不能把实际压缩替换成一次无摘要清理。窗口身份仍会保留,便于切回;无法安全重建当前窗口时取消操作,不退回全部归档历史。旧配置中的 `leaveManagedMode` 仍会解析,但不再触发批量 close-out 压缩。
|
|
62
|
+
|
|
63
|
+
原生文本压缩无法读取已有的加密检查点。如果当前上下文由该检查点承接,原生压缩或回退会取消并保留现状,避免把占位文本当作摘要、丢失信息;兼容的远程压缩仍可复用它。
|
|
64
|
+
|
|
65
|
+
完整历史仍保存在本地 Pi 会话 JSONL,远端 `history`、`notes` 则是独立的后端 API。窗口标记本身不是 Pi 原生截断点,运行时隔离仍依赖扩展正常加载。旧会话若恰好以无摘要清理记录结尾,Pi 可能在进入扩展钩子前提示 `Already compacted`;先发送一条正常用户消息再重试。Toolkit 不改写原日志,也不绕过 Pi 的压缩资格检查。
|
|
62
66
|
|
|
63
67
|
远程窗口依赖 alpha 接口,上游可能随时调整。切换模型时远程窗口状态仍会持久化并可复用,详见[窗口生命周期](docs/internals.md#rollover-lifecycle)。
|
|
64
68
|
|