peepface 0.0.0-stage → 0.1.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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 Silas Solivagus
+
+   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.

package/README.md

@@ -1,3 +1,214 @@
-# Temporary Holding Version
+# peepface
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+**agent 状态的视觉词汇表。**
+
+12 KB · 零依赖 · 纯 SVG · Apache-2.0
+
+[![Stars](https://img.shields.io/github/stars/SilasSolivagus/peepface?style=flat-square&color=222)](https://github.com/SilasSolivagus/peepface/stargazers)
+[![License](https://img.shields.io/github/license/SilasSolivagus/peepface?style=flat-square&color=222)](./LICENSE)
+[![Last commit](https://img.shields.io/github/last-commit/SilasSolivagus/peepface?style=flat-square&color=222)](https://github.com/SilasSolivagus/peepface/commits/main)
+
+**[看 demo →](https://silassolivagus.github.io/peepface/)**　（十二张脸同时在动，鼠标移上去它们会看你）
+
+![peepface demo](assets/demo.gif)
+
+---
+
+## 为什么
+
+现在做 agent 的人，状态只有三种表达：
+
+```
+转圈          三个点        一行小字
+◜            ...          正在思考…
+```
+
+这三种**都分不清「在干活」和「卡死了」**。用户看着转圈转了三十秒，不知道应该继续等，还是去点一下试试。
+
+peepface 的做法是给 agent 一张脸，让状态变成**形状上的差别**，而不是文字上的：
+
+| 状态 | 一眼看到的是 |
+|---|---|
+| `working` | 眼睛眯成一条横缝 |
+| `blocked` | 身体拉长、眼歪着 —— 过不去 |
+| `failed` | 圆脸、眼睛下垂 —— 塌了 |
+| `finished` | 弯月笑眼、身体撑开一下 |
+
+不看标签也能分出「在做事」和「出问题了」。这就是全部。
+
+---
+
+## 快速开始
+
+**浏览器**（3 行）：
+
+```html
+<script src="https://silassolivagus.github.io/peepface/dist/peepface.js"></script>
+<div id="face"></div>
+<script>
+  peepface.createFace(document.getElementById('face'), { state: 'working' });
+</script>
+```
+
+**ESM**：
+
+```bash
+npm i peepface
+```
+
+```js
+import { createFace } from 'peepface';
+
+const face = createFace(document.querySelector('#face'), { state: 'idle' });
+face.setState('thinking');   // 就这一句
+```
+
+它会自己眨眼、呼吸、跟着鼠标看。你只负责告诉它「现在在干什么」。
+
+---
+
+## 十二个生命周期状态
+
+| 状态 | 什么时候用 | 视觉上靠什么区分 |
+|---|---|---|
+| `idle` | 没事干，但醒着 | 正圆 + 竖眼 + 缓慢漂移 |
+| `listening` | 用户在打字，我在等 | 眼位前倾 |
+| `thinking` | 收到请求，还没开口 | 形体变不规则 + 轨道环 |
+| `searching` | 在翻找（检索、读文件） | 眼左右扫视 3.6 Hz |
+| `streaming` | 正在往外吐字 | 竖眼 + 呼吸加快 |
+| `working` | 在做事，用户不用管 | **眼睛眯成横缝** |
+| `waiting` | 等你决定（审批、选择） | 侧看 + 半透明环 |
+| `blocked` | 过不去，需要人拉一把 | **身体拉长 + 眼歪 30°** |
+| `finished` | 干完了 | 弯月笑眼 + 身体变宽 |
+| `failed` | 出错了 | **圆脸 + 眼睛下垂** |
+| `sleeping` | 很久没人用 | 眼睛闭成一条线 |
+| `waking` | 被叫醒了 | 眼睛猛地放大 |
+
+完整定义在 **[`states.json`](./states.json)**，包括每个状态的 `differs_from`（和谁不像）和 `must_not`（做了什么就毁了）。
+
+---
+
+## 核心不是代码，是这两个字段
+
+```json
+"working": {
+  "differs_from": {
+    "blocked": "不歪、不变形、不冒符号",
+    "thinking": "形状是圆，不是 blob"
+  },
+  "must_not": "加任何「卡住」的视觉信号。那会让人以为出问题了。"
+}
+```
+
+代码可以从零再写一遍，但这些判断是调出来的：
+
+- `finished` **停留超过 2 秒就变成常态，失去信号价值**
+- `sleeping` **在 5 分钟内出现，就不是「睡了」，是「累了」**
+- `working` **加任何「卡住」的暗示，用户会以为出问题**
+
+这也是为什么它是「词汇表」而不是「一个库」——**形态可以换，语义必须一致**。
+
+---
+
+## 保留你自己的词汇
+
+现实里没人把状态叫 `working`。你叫 `tool_call`、叫 `executing`、叫 `retrieving`。
+
+`states.json` 里有 `aliases`：
+
+```json
+{ "coding": "working", "retrieving": "searching", "done": "finished" }
+```
+
+**你保留自己的词，视觉上大家统一。** 不逼人改代码，是它能当规范的前提。
+
+---
+
+## API
+
+```js
+const face = peepface.createFace(container, {
+  state: 'idle',     // 初始状态
+  size: 84,          // 像素
+  dark: true,        // 深色主题：白脸黑眼
+  follow: true,      // 眼睛跟随鼠标
+});
+
+face.setState('working');
+face.getState();     // 'working'
+face.blink();        // 手动眨一次
+face.destroy();      // 卸载，移除全部监听
+```
+
+一页可以同时跑多个实例（demo 页就是 12 个）。类型定义在 [`peepface.d.ts`](./peepface.d.ts)。
+
+---
+
+## 视觉上唯一需要知道的一件事
+
+**眼睛是「洞」**——从脸的形状里挖出来，露出的是背景色。
+
+所以背景换什么颜色、什么主题，眼睛都自动是对的：
+
+```js
+深色主题 → 白脸 + 黑眼（洞露出深背景）
+浅色主题 → 黑脸 + 白眼（洞露出浅背景）
+```
+
+脸用页面的文字色，洞用页面的背景色。零配置就跟随了。
+
+---
+
+## 目录
+
+```
+├── core.js            唯一引擎（328 行，工厂版可多实例）
+├── states.json        词汇表
+├── peepface.d.ts      类型定义
+├── build.mjs          core.js → dist/
+├── dist/
+│   ├── peepface.js    浏览器（UMD）
+│   ├── peepface.mjs   ESM
+│   └── dsh-client.js  DeepSeek Harness 插件
+├── adapters/dsh.js    适配层：状态判定 + 拖拽
+├── plugin-dsh/        DSH 插件包
+└── index.html         demo
+```
+
+```bash
+node build.mjs      # 改完 core.js 后重新生成 dist/
+```
+
+**只改 `core.js`，不要手改 `dist/`。**
+
+---
+
+## 接入新宿主
+
+`adapters/dsh.js` 是一个完整例子：怎么把一个「能画的脸」变成一个「会跟着 agent 状态变的脸」。
+
+核心只有一件事：**把宿主的事件翻译成 `face.setState()`**。
+
+```js
+// 事件 → 状态，这张表才是每个宿主真正要写的东西
+on('tool_start',  () => face.setState('working'));
+on('token',       () => face.setState('streaming'));
+on('error',       () => face.setState('failed'));
+on('done',        () => face.setState('finished'));
+```
+
+欢迎提 PR 加适配器。
+
+---
+
+## 致谢
+
+球面眼睛的几何、眨眼的分段曲线、状态语义的分层，来自对 [Grok Bot](https://x.ai/news/designing-grok-bot) 头像系统的观察与研究。
+
+本项目**不含任何原厂素材**（形状路径、关键帧、配色）。全部代码与参数基于可观察行为重建。
+
+---
+
+## License
+
+[Apache-2.0](./LICENSE)