@plurnk/plurnk-contracts 1.7.0 → 1.9.0

package/dist/conformance/agui-v1.json

@@ -0,0 +1,541 @@
+{
+    "schemaVersion": 1,
+    "transport": [
+        {
+            "name": "comments-crlf-split-multiline",
+            "chunks": [
+                ": heartbeat\r\nid: ignored\r\ndata: {\"type\":\"CUSTOM\",\r\ndata: \"name\":\"plurnk.notice\",\"value\":{\"source\":\"engine\",\"kind\":\"fixture\",\"level\":\"info\"}}\r",
+                "\n\r\n"
+            ],
+            "eof": false,
+            "expect": {
+                "events": [
+                    {
+                        "type": "CUSTOM",
+                        "name": "plurnk.notice",
+                        "value": { "source": "engine", "kind": "fixture", "level": "info" }
+                    }
+                ]
+            }
+        },
+        {
+            "name": "split-frame-and-eof-dispatch",
+            "chunks": [
+                "data: {\"type\":\"RUN_STARTED\",\"threadId\":\"fixture\",\"runId\":\"run",
+                "\"}\n\ndata: {\"type\":\"RUN_FINISHED\",\"threadId\":\"fixture\",\"runId\":\"run\",\"outcome\":{\"type\":\"success\"}}"
+            ],
+            "eof": true,
+            "expect": {
+                "events": [
+                    { "type": "RUN_STARTED", "threadId": "fixture", "runId": "run" },
+                    {
+                        "type": "RUN_FINISHED",
+                        "threadId": "fixture",
+                        "runId": "run",
+                        "outcome": { "type": "success" }
+                    }
+                ]
+            }
+        },
+        {
+            "name": "malformed-json",
+            "chunks": ["data: not-json\n\n"],
+            "eof": false,
+            "expect": { "error": "invalid-json" }
+        },
+        {
+            "name": "cr-only-lines",
+            "chunks": [
+                ": comment\rdata: {\"type\":\"RUN_STARTED\",\"threadId\":\"fixture\",\"runId\":\"cr\"}\r\r: tail\n"
+            ],
+            "eof": false,
+            "expect": {
+                "events": [
+                    { "type": "RUN_STARTED", "threadId": "fixture", "runId": "cr" }
+                ]
+            }
+        }
+    ],
+    "lifecycles": [
+        {
+            "name": "ordinary-run",
+            "events": [
+                { "type": "RUN_STARTED", "threadId": "fixture", "runId": "run" },
+                {
+                    "type": "CUSTOM",
+                    "name": "plurnk.row",
+                    "value": {
+                        "id": 1,
+                        "worker_id": 7,
+                        "origin": "model",
+                        "op": "PLAN",
+                        "coordinate": "1.1.1",
+                        "tx": { "body": "Work." }
+                    }
+                },
+                {
+                    "type": "CUSTOM",
+                    "name": "plurnk.terminated",
+                    "value": {
+                        "workspaceId": 1,
+                        "workerId": 7,
+                        "loopId": 1,
+                        "result": { "status": 200 },
+                        "hitMaxTurns": false,
+                        "turnIds": [1],
+                        "attributions": [],
+                        "usage": {
+                            "accounting": { "requests": [], "usage": null, "costUsd": null },
+                            "curationWeight": null,
+                            "curationBudget": null,
+                            "contextTokens": null,
+                            "contextCapacity": null,
+                            "meta": {}
+                        }
+                    }
+                },
+                {
+                    "type": "RUN_FINISHED",
+                    "threadId": "fixture",
+                    "runId": "run",
+                    "outcome": { "type": "success" }
+                }
+            ],
+            "expect": {
+                "completion": "success",
+                "families": ["log/entry", "loop/terminated"],
+                "status": 200
+            }
+        },
+        {
+            "name": "action-success",
+            "events": [
+                { "type": "RUN_STARTED", "threadId": "fixture", "runId": "action" },
+                {
+                    "type": "CUSTOM",
+                    "name": "plurnk.action.result",
+                    "value": {
+                        "kind": "workspace.list",
+                        "ok": true,
+                        "result": { "workspaces": [] }
+                    }
+                },
+                {
+                    "type": "RUN_FINISHED",
+                    "threadId": "fixture",
+                    "runId": "action",
+                    "outcome": { "type": "success" }
+                }
+            ],
+            "expect": {
+                "completion": "success",
+                "families": [],
+                "action": { "kind": "workspace.list", "ok": true }
+            }
+        },
+        {
+            "name": "action-problem",
+            "events": [
+                {
+                    "type": "CUSTOM",
+                    "name": "plurnk.action.result",
+                    "value": {
+                        "kind": "workspace.rename",
+                        "ok": false,
+                        "problem": {
+                            "type": "https://problems.plurnk.xyz/daemon/workspace/name-conflict",
+                            "title": "Name conflict",
+                            "status": 409,
+                            "detail": "The workspace name is already in use."
+                        }
+                    }
+                },
+                {
+                    "type": "RUN_FINISHED",
+                    "threadId": "fixture",
+                    "runId": "action-problem",
+                    "outcome": { "type": "success" }
+                }
+            ],
+            "expect": {
+                "completion": "success",
+                "families": [],
+                "action": { "kind": "workspace.rename", "ok": false, "status": 409 }
+            }
+        },
+        {
+            "name": "loop-injection",
+            "events": [
+                {
+                    "type": "CUSTOM",
+                    "name": "plurnk.action.result",
+                    "value": {
+                        "kind": "loop.inject",
+                        "ok": true,
+                        "result": {
+                            "status": 100,
+                            "action": "injected_next_turn",
+                            "loopId": 9,
+                            "turnSeq": 2
+                        }
+                    }
+                },
+                {
+                    "type": "RUN_FINISHED",
+                    "threadId": "fixture",
+                    "runId": "inject",
+                    "outcome": { "type": "success" }
+                }
+            ],
+            "expect": {
+                "completion": "success",
+                "families": [],
+                "status": 100,
+                "action": { "kind": "loop.inject", "ok": true, "status": 100 }
+            }
+        },
+        {
+            "name": "proposal-interrupt",
+            "events": [
+                {
+                    "type": "TOOL_CALL_START",
+                    "toolCallId": "prop:42",
+                    "toolCallName": "request_approval"
+                },
+                {
+                    "type": "TOOL_CALL_ARGS",
+                    "toolCallId": "prop:42",
+                    "delta": "{\"op\":\"EDIT\",\"target\":{\"scheme\":\"file\",\"pathname\":\"example.txt\"},\"body\":\"change\",\"attrs\":{},\"flags\":{}}"
+                },
+                { "type": "TOOL_CALL_END", "toolCallId": "prop:42" },
+                {
+                    "type": "RUN_FINISHED",
+                    "threadId": "fixture",
+                    "runId": "proposal",
+                    "outcome": {
+                        "type": "interrupt",
+                        "interrupts": [
+                            {
+                                "id": "prop:42",
+                                "reason": "tool_call",
+                                "toolCallId": "prop:42"
+                            }
+                        ]
+                    }
+                }
+            ],
+            "expect": {
+                "completion": "interrupt",
+                "families": ["loop/proposal"],
+                "interrupt": "proposal"
+            }
+        },
+        {
+            "name": "interaction-interrupt",
+            "events": [
+                {
+                    "type": "TOOL_CALL_START",
+                    "toolCallId": "int:43",
+                    "toolCallName": "request_user_input"
+                },
+                {
+                    "type": "TOOL_CALL_ARGS",
+                    "toolCallId": "int:43",
+                    "delta": "{\"question\":\"Proceed?\"}"
+                },
+                { "type": "TOOL_CALL_END", "toolCallId": "int:43" },
+                {
+                    "type": "RUN_FINISHED",
+                    "threadId": "fixture",
+                    "runId": "interaction",
+                    "outcome": {
+                        "type": "interrupt",
+                        "interrupts": [
+                            {
+                                "id": "int:43",
+                                "reason": "tool_call",
+                                "toolCallId": "int:43",
+                                "message": "Answer the question.",
+                                "responseSchema": {
+                                    "type": "object",
+                                    "required": ["answer"],
+                                    "properties": { "answer": { "type": "string" } }
+                                }
+                            }
+                        ]
+                    }
+                }
+            ],
+            "expect": {
+                "completion": "interrupt",
+                "families": ["loop/interaction"],
+                "interrupt": "interaction"
+            }
+        },
+        {
+            "name": "reasoning-stream",
+            "events": [
+                {
+                    "type": "REASONING_START",
+                    "messageId": "model-call-11/reasoning"
+                },
+                {
+                    "type": "REASONING_MESSAGE_START",
+                    "messageId": "model-call-11/reasoning",
+                    "role": "reasoning"
+                },
+                {
+                    "type": "REASONING_MESSAGE_CONTENT",
+                    "messageId": "model-call-11/reasoning",
+                    "delta": "checked "
+                },
+                {
+                    "type": "REASONING_MESSAGE_CONTENT",
+                    "messageId": "model-call-11/reasoning",
+                    "delta": "the evidence"
+                },
+                {
+                    "type": "REASONING_MESSAGE_END",
+                    "messageId": "model-call-11/reasoning"
+                },
+                {
+                    "type": "REASONING_END",
+                    "messageId": "model-call-11/reasoning"
+                },
+                {
+                    "type": "CUSTOM",
+                    "name": "plurnk.terminated",
+                    "value": {
+                        "workspaceId": 1,
+                        "workerId": 7,
+                        "loopId": 1,
+                        "result": { "status": 200 },
+                        "hitMaxTurns": false,
+                        "turnIds": [1],
+                        "attributions": [],
+                        "usage": {
+                            "accounting": { "requests": [], "usage": null, "costUsd": null },
+                            "curationWeight": null,
+                            "curationBudget": null,
+                            "contextTokens": null,
+                            "contextCapacity": null,
+                            "meta": {}
+                        }
+                    }
+                },
+                {
+                    "type": "RUN_FINISHED",
+                    "threadId": "fixture",
+                    "runId": "reasoning",
+                    "outcome": { "type": "success" }
+                }
+            ],
+            "expect": {
+                "completion": "success",
+                "families": ["reasoning/event", "loop/terminated"],
+                "status": 200
+            }
+        },
+        {
+            "name": "notice-and-stream",
+            "events": [
+                {
+                    "type": "CUSTOM",
+                    "name": "plurnk.notice",
+                    "value": { "source": "engine", "kind": "fixture", "level": "info" }
+                },
+                {
+                    "type": "CUSTOM",
+                    "name": "plurnk.stream",
+                    "value": {
+                        "entryId": 8,
+                        "workerId": 7,
+                        "target": "sh:///1/1/8",
+                        "scheme": "sh",
+                        "channel": "stdout",
+                        "state": "active",
+                        "contentLength": 4
+                    }
+                },
+                {
+                    "type": "CUSTOM",
+                    "name": "plurnk.stream",
+                    "value": {
+                        "entryId": 8,
+                        "workerId": 7,
+                        "target": "sh:///1/1/8",
+                        "subscriptionId": 3,
+                        "scheme": "sh",
+                        "result": { "status": 200 },
+                        "summary": "completed",
+                        "wakeAction": "no-loop"
+                    }
+                },
+                {
+                    "type": "CUSTOM",
+                    "name": "plurnk.terminated",
+                    "value": {
+                        "workspaceId": 1,
+                        "workerId": 7,
+                        "loopId": 1,
+                        "result": { "status": 200 },
+                        "hitMaxTurns": false,
+                        "turnIds": [1],
+                        "attributions": [],
+                        "usage": {
+                            "accounting": { "requests": [], "usage": null, "costUsd": null },
+                            "curationWeight": null,
+                            "curationBudget": null,
+                            "contextTokens": null,
+                            "contextCapacity": null,
+                            "meta": {}
+                        }
+                    }
+                },
+                {
+                    "type": "RUN_FINISHED",
+                    "threadId": "fixture",
+                    "runId": "stream",
+                    "outcome": { "type": "success" }
+                }
+            ],
+            "expect": {
+                "completion": "success",
+                "families": ["notice/event", "stream/event", "stream/concluded", "loop/terminated"],
+                "status": 200
+            }
+        },
+        {
+            "name": "problem-run",
+            "events": [
+                {
+                    "type": "CUSTOM",
+                    "name": "plurnk.problem",
+                    "value": {
+                        "type": "https://problems.plurnk.xyz/fixture/conflict",
+                        "title": "Fixture conflict",
+                        "status": 409,
+                        "detail": "The fixture deliberately conflicts."
+                    }
+                },
+                {
+                    "type": "RUN_ERROR",
+                    "message": "The fixture deliberately conflicts.",
+                    "code": "https://problems.plurnk.xyz/fixture/conflict"
+                }
+            ],
+            "expect": {
+                "completion": "error",
+                "families": ["problem/event"],
+                "status": 409
+            }
+        },
+        {
+            "name": "branch-batch",
+            "events": [
+                {
+                    "type": "CUSTOM",
+                    "name": "plurnk.branch_batch",
+                    "value": {
+                        "batchId": 4,
+                        "state": "completed",
+                        "completed": 2,
+                        "total": 2
+                    }
+                },
+                {
+                    "type": "CUSTOM",
+                    "name": "plurnk.terminated",
+                    "value": {
+                        "workspaceId": 1,
+                        "workerId": 7,
+                        "loopId": 1,
+                        "result": { "status": 200 },
+                        "hitMaxTurns": false,
+                        "turnIds": [1],
+                        "attributions": [],
+                        "usage": {
+                            "accounting": { "requests": [], "usage": null, "costUsd": null },
+                            "curationWeight": null,
+                            "curationBudget": null,
+                            "contextTokens": null,
+                            "contextCapacity": null,
+                            "meta": {}
+                        }
+                    }
+                },
+                {
+                    "type": "RUN_FINISHED",
+                    "threadId": "fixture",
+                    "runId": "branch",
+                    "outcome": { "type": "success" }
+                }
+            ],
+            "expect": {
+                "completion": "success",
+                "families": ["workspace/branch-batch", "loop/terminated"],
+                "status": 200
+            }
+        },
+        {
+            "name": "cancelled-run",
+            "events": [
+                {
+                    "type": "CUSTOM",
+                    "name": "plurnk.terminated",
+                    "value": {
+                        "workspaceId": 1,
+                        "workerId": 7,
+                        "loopId": 1,
+                        "result": {
+                            "status": 499,
+                            "problem": {
+                                "type": "https://problems.plurnk.xyz/lifecycle/cancel/loop-cancelled",
+                                "title": "Loop cancelled",
+                                "status": 499,
+                                "detail": "The loop was cancelled."
+                            }
+                        },
+                        "hitMaxTurns": false,
+                        "turnIds": [1],
+                        "attributions": [],
+                        "usage": {
+                            "accounting": { "requests": [], "usage": null, "costUsd": null },
+                            "curationWeight": null,
+                            "curationBudget": null,
+                            "contextTokens": null,
+                            "contextCapacity": null,
+                            "meta": {}
+                        }
+                    }
+                },
+                {
+                    "type": "RUN_FINISHED",
+                    "threadId": "fixture",
+                    "runId": "cancel",
+                    "outcome": { "type": "success" }
+                }
+            ],
+            "expect": {
+                "completion": "success",
+                "families": ["loop/terminated"],
+                "status": 499
+            }
+        },
+        {
+            "name": "dead-stream",
+            "events": [
+                {
+                    "type": "CUSTOM",
+                    "name": "plurnk.row",
+                    "value": { "id": 1, "worker_id": 7, "origin": "model", "op": "PLAN" }
+                }
+            ],
+            "expect": {
+                "completion": "dead-stream",
+                "families": ["log/entry"],
+                "status": 502
+            }
+        }
+    ]
+}

package/dist/plurnk.gemma.gbnf

@@ -45,29 +45,32 @@ section-body-b40 ::= ("#" section-body-b1 | [ PLANFDRETCOYMVSXBWK] section-body-
 section-body-b41 ::= ("#" section-body-b1 | [ PANFIDRETCOYMVSXBWK] section-body-b0 | "L" section-body-b42 | [^\x00-\x08\x0B-\x0C\x0E-\x1F\x7F# PLANFIDRETCOYMVSXBWK] section-body-b0)?
 section-body-b42 ::= ("#" section-body-b1 | [ PANFIDRETCOYMVSXBWK] section-body-b0 | [^\x00-\x08\x0B-\x0C\x0E-\x1F\x7F# PLANFIDRETCOYMVSXBWK] section-body-b0)?
 section-body-ne ::= "#" section-body-b1 | [ PLANFIDRETCOYMVSXBWK] section-body-b0 | [^\x00-\x08\x0B-\x0C\x0E-\x1F\x7F# PLANFIDRETCOYMVSXBWK] section-body-b0
+annotation-body-b0 ::= ("-" annotation-body-b1 | ">" annotation-body-b0 | [^\x00-\x08\x0B-\x0C\x0E-\x1F\x7F\n\r>-] annotation-body-b0)?
+annotation-body-b1 ::= ("-" annotation-body-b2 | ">" annotation-body-b0 | [^\x00-\x08\x0B-\x0C\x0E-\x1F\x7F\n\r>-] annotation-body-b0)?
+annotation-body-b2 ::= ("-" annotation-body-b2 | [^\x00-\x08\x0B-\x0C\x0E-\x1F\x7F\n\r>-] annotation-body-b0)?
+annotation-body-ne ::= "-" annotation-body-b1 | ">" annotation-body-b0 | [^\x00-\x08\x0B-\x0C\x0E-\x1F\x7F\n\r>-] annotation-body-b0
 pattern-body-ne ::= [^\x00-\x08\x0B-\x0C\x0E-\x1F\x7F\n\r:#] [^\x00-\x08\x0B-\x0C\x0E-\x1F\x7F\n\r]*
 log-selection ::= (curation-tags-slot log-target-slot? | log-target-slot)?
-plan ::= "# PLAN0" "\n" section-body-ne "\n\n"
-find ::= "## FIND0" add-tags-slot? target-slot line-slot? "\n\n" | "## FIND0" add-tags-slot? target-slot line-slot? "\n" pattern-body-ne "\n\n"
-read ::= "## READ0" add-tags-slot? target-slot text-line-slot? "\n\n" | "## READ0" add-tags-slot? target-slot text-line-slot? "\n" pattern-body-ne "\n\n"
-edit ::= "## EDIT0" add-tags-slot? target-slot text-line-slot? "\n\n" | "## EDIT0" add-tags-slot? target-slot text-line-slot? "\n" section-body-ne "\n\n"
-copy ::= "## COPY0" add-tags-slot? target-slot text-line-slot? "\n" section-body-ne "\n\n"
-move ::= "## MOVE0" add-tags-slot? target-slot text-line-slot? "\n" section-body-ne "\n\n"
-open ::= "## OPEN0" log-selection "\n\n" | "## OPEN0" log-selection "\n" pattern-body-ne "\n\n"
-fold ::= "## FOLD0" log-selection "\n\n" | "## FOLD0" log-selection "\n" pattern-body-ne "\n\n"
-exec ::= "## EXEC0" exec-slot? target-slot? line-slot? "\n\n" | "## EXEC0" exec-slot? target-slot? line-slot? "\n" section-body-ne "\n\n"
-bare ::= "## BARE0" add-tags-slot? "\n" section-body-ne "\n\n"
-work ::= "## WORK0" branch-slot? target-slot "\n" section-body-ne "\n\n"
-fork ::= "## FORK0" branch-slot? target-slot "\n" section-body-ne "\n\n"
-kill ::= "## KILL0" kill-slot? target-slot "\n\n"
-send-mid ::= "## SEND0" status-mid-slot target-slot? "\n\n" | "## SEND0" status-mid-slot target-slot? "\n" section-body-ne "\n\n" | "## SEND0" target-slot? "\n\n" | "## SEND0" target-slot? "\n" section-body-ne "\n\n"
-send-102 ::= "## SEND0 [102]" target-slot? "\n" section-body-ne
-send-200 ::= "## SEND0 [200]" target-slot? "\n" section-body-ne
-send-202 ::= "## SEND0 [202]" target-slot? park-slot? "\n" section-body-ne
-send-300 ::= "## SEND0 [300]" target-slot? "\n" section-body-ne
-send-499 ::= "## SEND0 [499]" target-slot? "\n" section-body-ne
-send-final-any ::= send-102 | send-200 | send-202 | send-300 | send-499
-send-final-first ::= send-200 | send-202 | send-300 | send-499
+plan ::= "# PLAN0" annotation-slot? "\n" section-body-ne "\n"
+find ::= "## FIND0" add-tags-slot? target-slot line-slot? annotation-slot? "\n" | "## FIND0" add-tags-slot? target-slot line-slot? annotation-slot? "\n" pattern-body-ne "\n"
+read ::= "## READ0" add-tags-slot? target-slot text-line-slot? annotation-slot? "\n" | "## READ0" add-tags-slot? target-slot text-line-slot? annotation-slot? "\n" pattern-body-ne "\n"
+edit ::= "## EDIT0" add-tags-slot? target-slot text-line-slot? annotation-slot? "\n" | "## EDIT0" add-tags-slot? target-slot text-line-slot? annotation-slot? "\n" section-body-ne "\n"
+copy ::= "## COPY0" add-tags-slot? target-slot text-line-slot? annotation-slot? "\n" section-body-ne "\n"
+move ::= "## MOVE0" add-tags-slot? target-slot text-line-slot? annotation-slot? "\n" section-body-ne "\n"
+open ::= "## OPEN0" log-selection text-line-slot? annotation-slot? "\n" | "## OPEN0" log-selection text-line-slot? annotation-slot? "\n" pattern-body-ne "\n"
+fold ::= "## FOLD0" log-selection text-line-slot? annotation-slot? "\n" | "## FOLD0" log-selection text-line-slot? annotation-slot? "\n" pattern-body-ne "\n"
+exec ::= "## EXEC0" exec-slot? target-slot? line-slot? annotation-slot? "\n" | "## EXEC0" exec-slot? target-slot? line-slot? annotation-slot? "\n" section-body-ne "\n"
+bare ::= "## BARE0" add-tags-slot? annotation-slot? "\n" section-body-ne "\n"
+work ::= "## WORK0" branch-slot? target-slot annotation-slot? "\n" section-body-ne "\n"
+fork ::= "## FORK0" branch-slot? target-slot annotation-slot? "\n" section-body-ne "\n"
+kill ::= "## KILL0" kill-slot? target-slot annotation-slot? "\n"
+send-mid ::= "## SEND0" status-mid-slot target-slot? annotation-slot? "\n" | "## SEND0" status-mid-slot target-slot? annotation-slot? "\n" section-body-ne "\n" | "## SEND0" target-slot? annotation-slot? "\n" | "## SEND0" target-slot? annotation-slot? "\n" section-body-ne "\n"
+send-102 ::= "## SEND0 [102]" target-slot? annotation-slot? "\n" section-body-ne
+send-200 ::= "## SEND0 [200]" target-slot? annotation-slot? "\n" section-body-ne
+send-202 ::= "## SEND0 [202]" target-slot? park-slot? annotation-slot? "\n" section-body-ne
+send-499 ::= "## SEND0 [499]" target-slot? annotation-slot? "\n" section-body-ne
+send-final-any ::= send-102 | send-200 | send-202 | send-499
+send-final-first ::= send-200 | send-202 | send-499
 op-statement ::= find | read | edit | copy | move | open | fold | exec | bare | work | fork | kill
 tail-0 ::= send-mid tail-1 | op-statement tail-1 | send-final-first
 tail-1 ::= send-mid tail-2 | op-statement tail-2 | send-final-any
@@ -126,10 +129,11 @@ branch-slot ::= " " branch
 kill-slot ::= " " kill-sig
 status-mid-slot ::= " [" status-mid "]"
 park-slot ::= " " park
+annotation-slot ::= " <!-- " annotation-body-ne " -->"
 status-mid ::= [05-9] [0-9] [0-9] | "1" status-mid-1 | "2" status-mid-2 | "3" status-mid-3 | "4" status-mid-4
 status-mid-1 ::= "0" [0-13-9] | [1-9] [0-9]
 status-mid-2 ::= "0" [13-9] | [1-9] [0-9]
-status-mid-3 ::= "0" [1-9] | [1-9] [0-9]
+status-mid-3 ::= "0" [0-9] | [1-9] [0-9]
 status-mid-4 ::= "9" [0-8] | [0-8] [0-9]
 add-tags ::= "[" add-tag add-tag-rest* "]"
 curation-tags ::= "[" curation-term curation-term-rest* "]"