@plurnk/plurnk-contracts 3.2.0 → 4.0.0

package/plurnk.md

@@ -1,13 +1,7 @@
 # Plurnk Operation Protocol
 
 > [!IMPORTANT]
-> YOU MUST ONLY emit fenced operations; with the parameters, pattern, and terse aside on the fenced Operation line.
-
-> [!IMPORTANT]
-> YOU MUST record at least one NOTE along with other operations.
-
-> [!TIP]
-> All operations (except NOTE) are converted into log items.
+> YOU MUST ONLY emit fenced operations; with the parameters, pattern, and terse aside on the fenced operation line.
 
 ## Syntax
 
@@ -17,7 +11,7 @@ body?
 
 ## Core Operations
 
-* NOTE: Persistent Detailed Internal Register. Emit NOTE for every summary, finding, decision, and plan (and why).
+* NOTE: Internal Working Memory Register recording **every** plan, finding, decision, and next action.
 * FIND: List matching paths, or the match locations inside one path.
 * READ: Read files, entries, streams, or only the lines a pattern selects.
 * EDIT: Create a file or entry; replace existing text by scope or by pattern.
@@ -26,40 +20,40 @@ body?
 * KILL: Delete an entry, stop a process, or retire log items.
 * WORK: Delegate to a child worker (fresh log).
 * FORK: Delegate to a child worker (copied log).
-* WAIT: Yield to child workers and streams (not the user). You may include `[60]` to check in after 60 seconds.
+* WAIT: Yield to child workers or streams. You may include `[60]` to check in after 60 seconds. Not for awaiting user input.
 * SEND: Message endpoints, workers, or Open Messages (when the path is omitted, the oldest Open Message).
 
 ## Loop Protocol
 
-```NOTE <!-- summary -->
-Configuration exampleLoader.py load-order bug identified; fix and regression test pending.
+> [!TIP]
+> YOU SHOULD record every plan, finding, decision, and next action in detailed NOTEs to avoid permanent loss of information.
+
+```NOTE <!-- plan -->
+the steps ahead and why
 ```
 
 ```NOTE <!-- finding -->
-exampleLoader.py:58 reads the config before exampleInit() sets its path, so every test sees the defaults.
+a finding and its evidence
 ```
 
 ```NOTE <!-- decision -->
-Move configuration reading in exampleLoader.py into exampleInit() so it uses the initialized path. Plugin dependence on the old order is still unverified.
+a decision and its reasons
 ```
 
-```NOTE <!-- plan -->
-Edit exampleLoader.py, then rerun exampleTest.py.
+```NOTE <!-- next -->
+the next action and what it needs
 ```
 
 ```SEND
-This is an example of a continuing progress update response.
+a continuing progress update response
 ```
 
 ```SEND [200]
-This is an example of a final deliverable response.
+a final deliverable response
 ```
 
-> [!TIP]
-> YOU SHOULD include the Open Message's (path) to complete `[200]` or cancel `[499]` specific Open Messages.
-
 > [!CAUTION]
-> The loop continues until every Open Message has a `[200]` or `[499]` reply, operation results have been observed, and work held by the loop has settled.
+> The loop continues until all Open Messages receive a `[200]` or `[499]` response and all Open Work is completed.
 
 ## Delegation (worker:///_plurnk/plurnk/delegation.md)
 
@@ -89,6 +83,10 @@ Describe the child's complete task in the body.
 ```COPY (sh:///ab3d5678) (build.log) <!-- the command's output lands in a file, never in your context -->
 ```
 
+```members (add) <!-- adding membership tracking for files outside of the project folder -->
+{"files": ["../exampleSisterProject/*.md", "../exampleSisterProject/example.json"]}
+```
+
 * `(path)` may be a glob/extglob, permitting bulk operations.
 * Log item paths nest: `log:///1/2/3/READ` is loop/turn/item/OP.
 * FIND results hold one inner array per path: its channels, default first; append `#channel` to the path to select another: `(sh:///ab3d5678#stderr)`.
@@ -147,14 +145,11 @@ Nesting can be resolved with increased outer fences.
 
 ## Context Curation
 
-> [!WARNING]
-> YOU MUST NOT exceed budget.
-
-```READ (largeExampleFile.txt) <101,200> <!-- READing in chunks to not exceed budget -->
+```READ (largeExampleFile.txt) <101,200> <!-- READing in chunks if budget constrained -->
 ```
 
 ```KILL (log:///1/[1-7]/*/{READ,emission}) <!-- old results and your own old programs, in bulk; the body survives as a NOTE -->
-exampleModule.py: exampleFunction() returns 42 on empty input (lines 12–40); both callers in exampleTest.py expect it.
+example distillation or summarization
 ```
 
 ## Environment (worker:///_plurnk/plurnk/env.md)

package/dist/schema/ClientStatement.json

@@ -1,104 +0,0 @@
-{
-    "$schema": "https://json-schema.org/draft/2020-12/schema",
-    "$id": "https://schemas.plurnk.xyz/v0/ClientStatement.json",
-    "title": "ClientStatement",
-    "description": "The client-tier AST returned by PlurnkParser.parseClient: the closed protocol PlurnkStatement union plus the read-shaped LOOK utility statement.",
-    "oneOf": [
-        {
-            "$ref": "https://schemas.plurnk.xyz/v0/PlurnkStatement.json"
-        },
-        {
-            "$ref": "#/$defs/LookStatement"
-        }
-    ],
-    "$defs": {
-        "AsideOrNull": {
-            "type": [
-                "string",
-                "null"
-            ]
-        },
-        "SchemeMetadataOrNull": {
-            "oneOf": [
-                {
-                    "type": "array",
-                    "items": {
-                        "type": "string"
-                    }
-                },
-                {
-                    "type": "null"
-                }
-            ]
-        },
-        "PathOrNull": {
-            "oneOf": [
-                {
-                    "$ref": "https://schemas.plurnk.xyz/v0/ParsedPath.json"
-                },
-                {
-                    "type": "null"
-                }
-            ]
-        },
-        "TextLineMarkerOrNull": {
-            "oneOf": [
-                {
-                    "$ref": "https://schemas.plurnk.xyz/v0/TextLineMarker.json"
-                },
-                {
-                    "type": "null"
-                }
-            ]
-        },
-        "MatcherBodyOrNull": {
-            "oneOf": [
-                {
-                    "$ref": "https://schemas.plurnk.xyz/v0/MatcherBody.json"
-                },
-                {
-                    "type": "null"
-                }
-            ]
-        },
-        "PositionRef": {
-            "$ref": "https://schemas.plurnk.xyz/v0/Position.json"
-        },
-        "LookStatement": {
-            "type": "object",
-            "required": [
-                "op",
-                "aside",
-                "metadata",
-                "target",
-                "lineMarker",
-                "body",
-                "position"
-            ],
-            "additionalProperties": false,
-            "properties": {
-                "op": {
-                    "const": "LOOK"
-                },
-                "aside": {
-                    "$ref": "#/$defs/AsideOrNull"
-                },
-                "metadata": {
-                    "$ref": "#/$defs/SchemeMetadataOrNull"
-                },
-                "target": {
-                    "$ref": "#/$defs/PathOrNull"
-                },
-                "lineMarker": {
-                    "$ref": "#/$defs/TextLineMarkerOrNull"
-                },
-                "body": {
-                    "$ref": "#/$defs/MatcherBodyOrNull"
-                },
-                "position": {
-                    "$ref": "#/$defs/PositionRef"
-                }
-            }
-        }
-    }
-}