@llblab/pi-state-flow 0.2.2 → 0.2.3
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/CHANGELOG.md +6 -0
- package/README.md +3 -0
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,11 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 0.2.3: Document protocol and validation limitations
|
|
4
|
+
|
|
5
|
+
- Document that duplicate-comment detection also rejects literal State Flow envelope examples inside fenced or inline code in terminal answers, and provide a plain-JSON workaround.
|
|
6
|
+
- Clarify that mock lifecycle tests are not real Pi scheduler integration checks and that structural validation cannot guarantee semantic memory retention.
|
|
7
|
+
- No runtime behavior changes.
|
|
8
|
+
|
|
3
9
|
## 0.2.2: README structure hotfix
|
|
4
10
|
|
|
5
11
|
- Separate installation from usage, remove the redundant quick-start section, and move architecture details after the user-facing documentation.
|
package/README.md
CHANGED
|
@@ -156,6 +156,7 @@ The normative protocol remains in the system prompt throughout a tool/retry chai
|
|
|
156
156
|
|
|
157
157
|
- State commits exactly once per successful complete agent run, at terminal `message_end`/`turn_end`.
|
|
158
158
|
- Tool-bearing responses do not require or commit patches and retain ordinary Pi tool behavior, including multiple sequential calls. The runtime removes an accidental leading terminal envelope only when its JSON, fields, separator, and non-empty response are all structurally valid; malformed or quoted examples remain untouched.
|
|
159
|
+
- Terminal answers cannot contain another complete State Flow comment, even inside a fenced code block or inline code: duplicate detection scans the entire answer body, not Markdown structure. When explaining the protocol while State Flow is enabled, describe the fields or show plain JSON without the HTML comment delimiters. The literal envelope examples in this README are documentation, not valid content to copy into a terminal answer body.
|
|
159
160
|
- A failed tool remains in the current run trajectory for ordinary model reconciliation before terminal commit.
|
|
160
161
|
- If a run never reaches a valid terminal handoff, its external tool effects may exist while persistent State Flow state remains at the previous commit.
|
|
161
162
|
- The terminal envelope exists in ordinary assistant text until `message_end`; `message_update`, RPC, JSON, or other streaming consumers can observe it. Never place secrets in State Flow state.
|
|
@@ -173,6 +174,8 @@ npm install
|
|
|
173
174
|
npm run validate
|
|
174
175
|
```
|
|
175
176
|
|
|
177
|
+
Validation covers TypeScript checking, automated tests, and an extension import smoke check. Lifecycle tests use a mock Pi event harness; they do not establish behavior under the real Pi scheduler, queued prompts, abort/compaction interactions, or combinations of extensions. Those scenarios still need integration checks. Structural patch validation also cannot prove that a handoff preserved every important requirement or compiled a Skill faithfully.
|
|
178
|
+
|
|
176
179
|
## Project status
|
|
177
180
|
|
|
178
181
|
- [Open work](BACKLOG.md)
|