sokel-plugin-sdk 0.2.0__tar.gz

sokel_plugin_sdk-0.2.0/.gitignore

@@ -0,0 +1,25 @@
+# 编译产物。Go 的二进制没有后缀，`go build ./...` 会按目录名把它们丢在 cwd——
+# 已经因此把一个 4.3MB 的 sokel-gen 误提交过一次，所以逐个挡住。
+/sokel-gen
+/examples/*/sysinfo
+/examples/**/*.test
+*.test
+*.exe
+
+# 本地实例身份（sokel 首次运行落盘，机器相关）
+.sokel-instance-id*
+
+# 编辑器 / 系统
+.DS_Store
+.idea/
+.vscode/
+
+# Python SDK
+.venv/
+__pycache__/
+*.egg-info/
+.pytest_cache/
+
+# Node SDK
+node_modules/
+dist/

sokel_plugin_sdk-0.2.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 The Sokel Authors
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

sokel_plugin_sdk-0.2.0/PKG-INFO

@@ -0,0 +1,115 @@
+Metadata-Version: 2.5
+Name: sokel-plugin-sdk
+Version: 0.2.0
+Summary: Sokel plugin SDK for Python — declare the contract in sokel.yaml, implement typed handlers.
+Project-URL: Homepage, https://github.com/sokel-dev/sokel-plugin-sdk
+Project-URL: Source, https://github.com/sokel-dev/sokel-plugin-sdk/tree/main/sdk-python
+Project-URL: Issues, https://github.com/sokel-dev/sokel-plugin-sdk/issues
+License: Apache-2.0
+License-File: LICENSE
+Keywords: automation,nats,plugin,sdk,sokel,workflow
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
+Classifier: Typing :: Typed
+Requires-Python: >=3.9
+Requires-Dist: nats-py>=2.6.0
+Requires-Dist: pydantic>=2.5.0
+Provides-Extra: dev
+Requires-Dist: pytest-asyncio>=0.23; extra == 'dev'
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# Sokel Plugin SDK — Python
+
+用 Python 写 [Sokel](https://github.com/sokel-dev) 插件。契约写在 `sokel.yaml` 里（语言中立），
+`sokel-gen` 把它生成成 pydantic 模型与类型化的注册口；SDK 负责注册、传输、凭证、文件、心跳与重连。
+
+```python
+async def issues_list(ctx: Ctx, in_: IssuesListIn) -> IssuesListOut:
+    issues = await client.list_issues(in_.project, in_.state)
+    return IssuesListOut(issues=issues, count=len(issues))
+
+on_issues_list(p, issues_list)
+```
+
+`in_.project` 拼错是 IDE 里的红线，不是线上的一次失败调用——代码里没有任何 `dict["key"]`。
+
+## 装
+
+```bash
+pip install sokel-plugin-sdk
+go install github.com/sokel-dev/sokel-plugin-sdk/cmd/sokel-gen@latest   # 生成器
+```
+
+`sokel-gen` 是个单文件二进制（Go 写的），只在**生成时**用到；跑插件时不需要它。
+
+## 四步
+
+```bash
+sokel-gen init -lang python ./my-plugin
+cd my-plugin
+pip install -r requirements.txt
+sokel-gen generate .     # sokel.yaml → sokel_gen.py
+python main.py
+```
+
+1. **声明** —— `sokel.yaml`：操作、事件、凭证、认证方式。格式见 [docs/manifest.md](../docs/manifest.md)。
+2. **生成** —— `sokel-gen generate .` 产出 `sokel_gen.py`：每个操作一对 `XxxIn` / `XxxOut` 模型
+   和一个 `on_xxx(p, fn)`；每个事件一个 payload 模型和一个 `trigger_xxx(ctx, event_id, payload)`。
+3. **实现** —— handler 签名完全具体，可以是 `async def` 也可以是普通函数。
+4. **连接** —— `asyncio.run(p.run())`。插件**出站**连平台：无入站端口、无公网 IP、无防火墙洞。
+
+## 能力一览
+
+| 要做的事 | 怎么写 |
+|---|---|
+| 读凭证 | `credential(ctx)` → 生成的 `Credential` 模型 |
+| 取入参文件的字节 | `await ctx.fetch(in_.file)` |
+| 产出文件 | `await ctx.upload(name, mime, data)` → 放进出参 |
+| 流式产出 | `out.text(...)` 逐帧给人看，`out.vars(Out(...))` 给下游 |
+| 推事件 | `await trigger_message(ctx, event_id, MessageEvent(...))` |
+| 常驻事件源 | `p.register_source(id, label, fn)`，循环里判 `ctx.stopping.is_set()` |
+| 平台代收 webhook | `p.register_webhook(fn)`，返回 `ok()` / `text(401, "...")` |
+| 协作式认证 | `p.register_auth(start=…, poll=…, submit=…)` |
+| 会话型凭证刷新 | `await ctx.update_credential({"session": "…"})` |
+| 自报运行态 | `ctx.report_status("auth_required", "…")` |
+
+## 配置
+
+SDK 读 `SOKEL_` 前缀的环境变量：
+
+| 变量 | 必填 | 含义 |
+|---|---|---|
+| `SOKEL_ENDPOINT` | 是 | `nats://broker:4222`，或 `https://` 平台地址（经 `/connect-info` 发现 broker） |
+| `SOKEL_TOKEN` | 是 | 接入组 token（`skp_…`），平台据此认「插件 + 工作空间」 |
+| `SOKEL_NATS_TOKEN` | 否 | broker 的传输层鉴权 |
+| `SOKEL_NATS_CA` | 否 | `tls://` broker 的自定义 CA |
+| `SOKEL_INSTANCE_ID` | 否 | 固定副本身份（默认按 token 指纹落盘复用） |
+| `SOKEL_REGION` | 否 | 副本的地域标注 |
+
+凭证从不由插件存储：平台随每次调用把解析后的字段下发下来。
+
+## 例子
+
+[`examples/kitchen-sink`](../examples/kitchen-sink) 覆盖了全部形态——每种字段、文件、流式、
+事件、webhook、协作式认证各一份，Python 与 Node 实现的是同一份声明。
+
+```bash
+cd examples/kitchen-sink/python
+pip install -r requirements.txt
+SOKEL_ENDPOINT=nats://localhost:4222 SOKEL_TOKEN=skp_xxx python main.py
+```
+
+## 开发本 SDK
+
+```bash
+uv venv && uv pip install -e '.[dev]'
+python -m pytest -q
+```
+
+## License
+
+Apache-2.0.

sokel_plugin_sdk-0.2.0/README.md

@@ -0,0 +1,91 @@
+# Sokel Plugin SDK — Python
+
+用 Python 写 [Sokel](https://github.com/sokel-dev) 插件。契约写在 `sokel.yaml` 里（语言中立），
+`sokel-gen` 把它生成成 pydantic 模型与类型化的注册口；SDK 负责注册、传输、凭证、文件、心跳与重连。
+
+```python
+async def issues_list(ctx: Ctx, in_: IssuesListIn) -> IssuesListOut:
+    issues = await client.list_issues(in_.project, in_.state)
+    return IssuesListOut(issues=issues, count=len(issues))
+
+on_issues_list(p, issues_list)
+```
+
+`in_.project` 拼错是 IDE 里的红线，不是线上的一次失败调用——代码里没有任何 `dict["key"]`。
+
+## 装
+
+```bash
+pip install sokel-plugin-sdk
+go install github.com/sokel-dev/sokel-plugin-sdk/cmd/sokel-gen@latest   # 生成器
+```
+
+`sokel-gen` 是个单文件二进制（Go 写的），只在**生成时**用到；跑插件时不需要它。
+
+## 四步
+
+```bash
+sokel-gen init -lang python ./my-plugin
+cd my-plugin
+pip install -r requirements.txt
+sokel-gen generate .     # sokel.yaml → sokel_gen.py
+python main.py
+```
+
+1. **声明** —— `sokel.yaml`：操作、事件、凭证、认证方式。格式见 [docs/manifest.md](../docs/manifest.md)。
+2. **生成** —— `sokel-gen generate .` 产出 `sokel_gen.py`：每个操作一对 `XxxIn` / `XxxOut` 模型
+   和一个 `on_xxx(p, fn)`；每个事件一个 payload 模型和一个 `trigger_xxx(ctx, event_id, payload)`。
+3. **实现** —— handler 签名完全具体，可以是 `async def` 也可以是普通函数。
+4. **连接** —— `asyncio.run(p.run())`。插件**出站**连平台：无入站端口、无公网 IP、无防火墙洞。
+
+## 能力一览
+
+| 要做的事 | 怎么写 |
+|---|---|
+| 读凭证 | `credential(ctx)` → 生成的 `Credential` 模型 |
+| 取入参文件的字节 | `await ctx.fetch(in_.file)` |
+| 产出文件 | `await ctx.upload(name, mime, data)` → 放进出参 |
+| 流式产出 | `out.text(...)` 逐帧给人看，`out.vars(Out(...))` 给下游 |
+| 推事件 | `await trigger_message(ctx, event_id, MessageEvent(...))` |
+| 常驻事件源 | `p.register_source(id, label, fn)`，循环里判 `ctx.stopping.is_set()` |
+| 平台代收 webhook | `p.register_webhook(fn)`，返回 `ok()` / `text(401, "...")` |
+| 协作式认证 | `p.register_auth(start=…, poll=…, submit=…)` |
+| 会话型凭证刷新 | `await ctx.update_credential({"session": "…"})` |
+| 自报运行态 | `ctx.report_status("auth_required", "…")` |
+
+## 配置
+
+SDK 读 `SOKEL_` 前缀的环境变量：
+
+| 变量 | 必填 | 含义 |
+|---|---|---|
+| `SOKEL_ENDPOINT` | 是 | `nats://broker:4222`，或 `https://` 平台地址（经 `/connect-info` 发现 broker） |
+| `SOKEL_TOKEN` | 是 | 接入组 token（`skp_…`），平台据此认「插件 + 工作空间」 |
+| `SOKEL_NATS_TOKEN` | 否 | broker 的传输层鉴权 |
+| `SOKEL_NATS_CA` | 否 | `tls://` broker 的自定义 CA |
+| `SOKEL_INSTANCE_ID` | 否 | 固定副本身份（默认按 token 指纹落盘复用） |
+| `SOKEL_REGION` | 否 | 副本的地域标注 |
+
+凭证从不由插件存储：平台随每次调用把解析后的字段下发下来。
+
+## 例子
+
+[`examples/kitchen-sink`](../examples/kitchen-sink) 覆盖了全部形态——每种字段、文件、流式、
+事件、webhook、协作式认证各一份，Python 与 Node 实现的是同一份声明。
+
+```bash
+cd examples/kitchen-sink/python
+pip install -r requirements.txt
+SOKEL_ENDPOINT=nats://localhost:4222 SOKEL_TOKEN=skp_xxx python main.py
+```
+
+## 开发本 SDK
+
+```bash
+uv venv && uv pip install -e '.[dev]'
+python -m pytest -q
+```
+
+## License
+
+Apache-2.0.

sokel_plugin_sdk-0.2.0/pyproject.toml

@@ -0,0 +1,39 @@
+[project]
+name = "sokel-plugin-sdk"
+version = "0.2.0"
+description = "Sokel plugin SDK for Python — declare the contract in sokel.yaml, implement typed handlers."
+readme = "README.md"
+requires-python = ">=3.9"
+license = { text = "Apache-2.0" }
+keywords = ["sokel", "plugin", "sdk", "nats", "workflow", "automation"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: Apache Software License",
+    "Programming Language :: Python :: 3",
+    "Topic :: Software Development :: Libraries :: Application Frameworks",
+    "Typing :: Typed",
+]
+dependencies = [
+    "nats-py>=2.6.0",
+    "pydantic>=2.5.0",
+]
+
+[project.urls]
+Homepage = "https://github.com/sokel-dev/sokel-plugin-sdk"
+Source = "https://github.com/sokel-dev/sokel-plugin-sdk/tree/main/sdk-python"
+Issues = "https://github.com/sokel-dev/sokel-plugin-sdk/issues"
+
+[project.optional-dependencies]
+dev = ["pytest>=8.0", "pytest-asyncio>=0.23"]
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["sokel"]
+
+[tool.pytest.ini_options]
+asyncio_mode = "auto"
+testpaths = ["tests"]

sokel_plugin_sdk-0.2.0/sokel/__init__.py

@@ -0,0 +1,48 @@
+"""Sokel plugin SDK for Python.
+
+契约在 sokel.yaml 里声明（语言中立），`sokel-gen generate` 生成类型化的模型与注册口；
+本包提供运行时：注册握手、心跳、调用分发、文件分块、事件触发、webhook、协作式认证。
+
+    from sokel import Plugin
+    from sokel_gen import CONTRACT, on_issues_list, IssuesListIn, IssuesListOut
+
+    p = Plugin(CONTRACT, name="gitlab")
+
+    async def handle(ctx, in_: IssuesListIn) -> IssuesListOut:
+        ...
+
+    on_issues_list(p, handle)
+    asyncio.run(p.run())
+"""
+
+from .auth import AuthChallenge, AuthState
+from .contract import Contract
+# 注意导出名不能叫 env —— 那会遮住 sokel.env 这个子模块，包内的 `from . import env`
+# 会拿到函数而不是模块（第一次跑示例就撞上了，报的还是个莫名其妙的 AttributeError）。
+from .env import get as getenv, get_or as getenv_or
+from .events import CredEntry, Source, SourceCtx, StateBoard
+from .plugin import Plugin
+from .runtime import Ctx, Emitter, File
+from .webhook import WebhookRequest, WebhookResponse, ok, text
+
+__all__ = [
+    "AuthChallenge",
+    "AuthState",
+    "Contract",
+    "CredEntry",
+    "Ctx",
+    "Emitter",
+    "File",
+    "Plugin",
+    "Source",
+    "SourceCtx",
+    "StateBoard",
+    "WebhookRequest",
+    "WebhookResponse",
+    "getenv",
+    "getenv_or",
+    "ok",
+    "text",
+]
+
+__version__ = "0.1.0"

sokel_plugin_sdk-0.2.0/sokel/auth.py

@@ -0,0 +1,41 @@
+"""协作式凭证认证：有些凭证没法让人填——扫码、验证码回填、OAuth 同意页。
+
+面板点「登录」→ start 拿挑战 →（扫码 / 回填）→ 2s 轮询 poll → confirmed。
+
+形态写在 sokel.yaml 的 credential.auth 里（声明式），处理器挂在保留操作 id
+auth.start / auth.poll / auth.submit 上——**不要**自己注册叫 auth_start 的业务操作：
+那三个名字从来不是保留字，任何插件的同名业务操作都会让面板的按钮凭空出现。
+"""
+
+from __future__ import annotations
+
+from typing import Any, Dict, Optional
+
+from pydantic import BaseModel
+
+KIND_QR = "qr"
+KIND_INPUT = "input"
+KIND_OAUTH = "oauth"
+
+# 状态常量：拼错字符串不会报错，只会让面板一直转圈
+PENDING = "pending"
+SCANNED = "scanned"
+CONFIRMED = "confirmed"
+EXPIRED = "expired"
+
+
+class AuthChallenge(BaseModel):
+    """start 交出的挑战。面板按 kind 渲染：qr 画二维码，input 显示 prompt 与输入框。"""
+
+    auth_id: str = ""
+    kind: str = ""
+    qr_image: str = ""  # data-uri
+    prompt: str = ""
+    expires_in: int = 0
+
+
+class AuthState(BaseModel):
+    """poll 的结果。session 只在 confirmed 时带上——中途带出去等于让平台反复覆写凭证行。"""
+
+    status: str = PENDING
+    session: Optional[Dict[str, Any]] = None

sokel_plugin_sdk-0.2.0/sokel/contract.py

@@ -0,0 +1,86 @@
+"""契约的运行时视图（线协议 §5）。
+
+契约本身是**数据**：`sokel-gen` 从 sokel.yaml 生成一份 CONTRACT 字典，运行时只是查它、上报它。
+所以这里不重新定义一套 Field 类——那会变成契约的第二份定义，而两份定义迟早会漂
+（Go 侧栽过一次：SDK 的 Field 是全量的、平台那份只有四个键，SDK 声明了的东西平台看不见）。
+"""
+
+from __future__ import annotations
+
+from typing import Any, Dict, List, Optional
+
+# 契约字典的键（与线协议 §3 的注册载荷同名，直接上报，不做转换）
+KEY_OPERATIONS = "operations"
+KEY_CREDENTIAL = "credential_schema"
+KEY_EVENTS = "events"
+KEY_EVENTS_COMMON = "events_common"
+KEY_AUTH_FLOW = "auth_flow"
+KEY_OAUTH = "oauth"
+KEY_CAPABILITIES = "capabilities"
+KEY_DOC = "doc"
+KEY_DOC_URL = "doc_url"
+
+# 保留操作 id（认证流）。带点号，业务 id 产生不出来（业务 id 限定 ^[a-z][a-z0-9_]*$）。
+OP_AUTH_START = "auth.start"
+OP_AUTH_POLL = "auth.poll"
+OP_AUTH_SUBMIT = "auth.submit"
+
+# 平台代收 webhook 的特殊操作名（复用调用帧，见协议 §7b）
+OP_WEBHOOK = "__webhook__"
+
+# 能力位：注册了 webhook 处理器就是支持，不靠作者手动声明
+CAP_WEBHOOK = "webhook"
+
+
+class Contract:
+    """一份插件契约。构造参数就是生成物 CONTRACT 字典。"""
+
+    def __init__(self, data: Optional[Dict[str, Any]] = None) -> None:
+        self.data: Dict[str, Any] = dict(data or {})
+
+    # —— 查 ——
+
+    def operations(self) -> List[Dict[str, Any]]:
+        return list(self.data.get(KEY_OPERATIONS) or [])
+
+    def operation(self, op_id: str) -> Optional[Dict[str, Any]]:
+        for op in self.operations():
+            if op.get("id") == op_id:
+                return op
+        return None
+
+    def is_stream(self, op_id: str) -> bool:
+        op = self.operation(op_id)
+        return bool(op and op.get("stream"))
+
+    def event_ids(self) -> List[str]:
+        return [e.get("id", "") for e in (self.data.get(KEY_EVENTS) or [])]
+
+    def get(self, key: str, default: Any = None) -> Any:
+        return self.data.get(key, default)
+
+    def set(self, key: str, value: Any) -> None:
+        self.data[key] = value
+
+    # —— 上报 ——
+
+    def payload(self) -> Dict[str, Any]:
+        """契约部分的注册载荷。空值一律省略（协议：新字段一律 optional）。"""
+        out: Dict[str, Any] = {}
+        for key in (
+            KEY_OPERATIONS,
+            KEY_CREDENTIAL,
+            KEY_EVENTS,
+            KEY_EVENTS_COMMON,
+            KEY_AUTH_FLOW,
+            KEY_OAUTH,
+            KEY_CAPABILITIES,
+            KEY_DOC,
+            KEY_DOC_URL,
+        ):
+            v = self.data.get(key)
+            if v:
+                out[key] = v
+        # operations 必须在（哪怕空）：平台侧读不到这个键会当成「契约锁定」而不是「没有操作」
+        out.setdefault(KEY_OPERATIONS, [])
+        return out

sokel_plugin_sdk-0.2.0/sokel/env.py

@@ -0,0 +1,19 @@
+"""插件侧环境变量的统一读法：把 SOKEL_ 前缀收在一处（对齐 Go 侧 pluginenv）。
+
+没有第二个前缀的兼容层——认第二个前缀省下的是一次重新部署，换来的是一个没人敢摘的包袱。
+"""
+
+from __future__ import annotations
+
+import os
+
+PREFIX = "SOKEL_"
+
+
+def get(name: str) -> str:
+    """读 SOKEL_<name>。name 不带前缀，如 get("TOKEN")。"""
+    return (os.environ.get(PREFIX + name) or "").strip()
+
+
+def get_or(name: str, default: str) -> str:
+    return get(name) or default