@ixo/topic-protocol 0.8.0 → 1.0.0-rc.1

package/recipes/research-brief.json

@@ -0,0 +1,460 @@
+{
+  "version": 1,
+  "code": "research-brief",
+  "id": "https://topic-protocol.ixo.world/recipes/research-brief",
+  "recipeVersion": "1.0.0-rc.1",
+  "label": "Research brief",
+  "description": "Frame a question, do the research, verify the sources, and close the brief explicitly.",
+  "baseRecipe": "research",
+  "creates": "draft",
+  "shape": {
+    "version": 1,
+    "code": "recipe/research-brief",
+    "axes": [
+      {
+        "code": "contract",
+        "phase": "forming",
+        "required": true,
+        "initialState": "draft",
+        "states": [
+          {
+            "code": "draft"
+          },
+          {
+            "code": "accepted",
+            "terminal": true
+          }
+        ]
+      },
+      {
+        "code": "work",
+        "phase": "working",
+        "required": true,
+        "initialState": "pending",
+        "states": [
+          {
+            "code": "pending"
+          },
+          {
+            "code": "in-progress"
+          },
+          {
+            "code": "submitted",
+            "terminal": true
+          }
+        ]
+      },
+      {
+        "code": "verification",
+        "phase": "verifying",
+        "required": true,
+        "initialState": "pending",
+        "states": [
+          {
+            "code": "pending"
+          },
+          {
+            "code": "verified",
+            "terminal": true
+          }
+        ]
+      },
+      {
+        "code": "topic",
+        "phase": "complete",
+        "required": true,
+        "initialState": "open",
+        "states": [
+          {
+            "code": "open"
+          },
+          {
+            "code": "complete",
+            "terminal": true
+          }
+        ]
+      }
+    ],
+    "transitions": [
+      {
+        "code": "edit-terms",
+        "phase": "forming",
+        "predecessor": {
+          "axis": "contract",
+          "state": "draft"
+        },
+        "target": {
+          "axis": "contract",
+          "state": "draft"
+        },
+        "command": "topic.edit-terms",
+        "requiredAbility": "topic/write",
+        "assignedTo": {
+          "kind": "role",
+          "value": "contract-acceptor"
+        },
+        "gates": [],
+        "confirmation": "none",
+        "consequence": "shared-state",
+        "evidence": {
+          "kind": "operation",
+          "type": "update-contract"
+        },
+        "presentation": {
+          "reasonCode": "terms-need-input"
+        }
+      },
+      {
+        "code": "accept-terms",
+        "phase": "forming",
+        "predecessor": {
+          "axis": "contract",
+          "state": "draft"
+        },
+        "target": {
+          "axis": "contract",
+          "state": "accepted"
+        },
+        "command": "topic.accept-terms",
+        "requiredAbility": "topic/accept-contract",
+        "assignedTo": {
+          "kind": "role",
+          "value": "contract-acceptor"
+        },
+        "gates": [],
+        "confirmation": "viewer",
+        "consequence": "shared-state",
+        "evidence": {
+          "kind": "operation",
+          "type": "accept-contract"
+        },
+        "presentation": {
+          "reasonCode": "terms-await-acceptance"
+        }
+      },
+      {
+        "code": "start-work",
+        "phase": "working",
+        "predecessor": {
+          "axis": "work",
+          "state": "pending"
+        },
+        "target": {
+          "axis": "work",
+          "state": "in-progress"
+        },
+        "command": "topic.start-work",
+        "requiredAbility": "topic/write",
+        "assignedTo": {
+          "kind": "role",
+          "value": "worker"
+        },
+        "gates": [
+          {
+            "kind": "axis",
+            "axis": "contract",
+            "states": [
+              "accepted"
+            ]
+          }
+        ],
+        "confirmation": "none",
+        "consequence": "shared-state",
+        "evidence": {
+          "kind": "operation",
+          "type": "change-progress"
+        },
+        "presentation": {
+          "reasonCode": "start-work"
+        }
+      },
+      {
+        "code": "answer-question",
+        "phase": "working",
+        "predecessor": {
+          "axis": "work",
+          "state": "in-progress"
+        },
+        "target": {
+          "axis": "work",
+          "state": "in-progress"
+        },
+        "command": "topic.answer-question",
+        "requiredAbility": "topic/write",
+        "assignedTo": {
+          "kind": "role",
+          "value": "worker"
+        },
+        "gates": [
+          {
+            "kind": "field",
+            "path": "/questions/open",
+            "predicate": "present"
+          }
+        ],
+        "confirmation": "none",
+        "consequence": "shared-state",
+        "evidence": {
+          "kind": "operation",
+          "type": "answer-question"
+        },
+        "presentation": {
+          "reasonCode": "question-awaits-answer"
+        }
+      },
+      {
+        "code": "change-due-date",
+        "phase": "working",
+        "predecessor": {
+          "axis": "work",
+          "state": "in-progress"
+        },
+        "target": {
+          "axis": "work",
+          "state": "in-progress"
+        },
+        "command": "topic.change-due-date",
+        "requiredAbility": "topic/write",
+        "assignedTo": {
+          "kind": "role",
+          "value": "worker"
+        },
+        "gates": [
+          {
+            "kind": "field",
+            "path": "/outcome/target/value",
+            "predicate": "present"
+          }
+        ],
+        "confirmation": "none",
+        "consequence": "shared-state",
+        "evidence": {
+          "kind": "operation",
+          "type": "change-due-date"
+        },
+        "presentation": {
+          "reasonCode": "due-date-review"
+        }
+      },
+      {
+        "code": "unblock-topic",
+        "phase": "working",
+        "predecessor": {
+          "axis": "topic",
+          "state": "open"
+        },
+        "target": {
+          "axis": "topic",
+          "state": "open"
+        },
+        "command": "topic.unblock",
+        "requiredAbility": "topic/unblock",
+        "assignedTo": {
+          "kind": "role",
+          "value": "block-resolver"
+        },
+        "gates": [
+          {
+            "kind": "condition",
+            "states": [
+              "blocked"
+            ]
+          }
+        ],
+        "confirmation": "none",
+        "consequence": "shared-state",
+        "evidence": {
+          "kind": "operation",
+          "type": "unblock-topic"
+        },
+        "presentation": {
+          "reasonCode": "topic-blocked"
+        }
+      },
+      {
+        "code": "submit-work",
+        "phase": "working",
+        "predecessor": {
+          "axis": "work",
+          "state": "in-progress"
+        },
+        "target": {
+          "axis": "work",
+          "state": "submitted"
+        },
+        "command": "topic.record-outcome",
+        "requiredAbility": "topic/record-outcome",
+        "assignedTo": {
+          "kind": "role",
+          "value": "worker"
+        },
+        "gates": [],
+        "confirmation": "none",
+        "consequence": "shared-state",
+        "evidence": {
+          "kind": "record",
+          "type": "ixo.topic.work-submission",
+          "finality": "accepted"
+        },
+        "presentation": {
+          "reasonCode": "submit-work"
+        }
+      },
+      {
+        "code": "complete-topic",
+        "phase": "complete",
+        "predecessor": {
+          "axis": "topic",
+          "state": "open"
+        },
+        "target": {
+          "axis": "topic",
+          "state": "complete"
+        },
+        "command": "topic.complete",
+        "requiredAbility": "topic/confirm-completion",
+        "assignedTo": {
+          "kind": "role",
+          "value": "completion-authority"
+        },
+        "gates": [
+          {
+            "kind": "axis",
+            "axis": "work",
+            "states": [
+              "submitted"
+            ]
+          }
+        ],
+        "confirmation": "authority",
+        "consequence": "shared-state",
+        "evidence": {
+          "kind": "operation",
+          "type": "complete-topic"
+        },
+        "completesTopic": true,
+        "presentation": {
+          "reasonCode": "complete-topic"
+        }
+      },
+      {
+        "code": "record-verification",
+        "phase": "verifying",
+        "predecessor": {
+          "axis": "verification",
+          "state": "pending"
+        },
+        "target": {
+          "axis": "verification",
+          "state": "verified"
+        },
+        "command": "topic.record-verification",
+        "requiredAbility": "claim/evaluate",
+        "assignedTo": {
+          "kind": "role",
+          "value": "evaluator"
+        },
+        "gates": [
+          {
+            "kind": "axis",
+            "axis": "work",
+            "states": [
+              "submitted"
+            ]
+          }
+        ],
+        "confirmation": "none",
+        "consequence": "shared-state",
+        "evidence": {
+          "kind": "record",
+          "type": "ixo.evaluation",
+          "finality": "accepted"
+        },
+        "handoff": {
+          "kind": "flow",
+          "binding": "evaluation"
+        },
+        "presentation": {
+          "reasonCode": "verification-required"
+        }
+      }
+    ],
+    "progressRules": [
+      {
+        "code": "disputed",
+        "condition": "disputed",
+        "priority": 700,
+        "source": {
+          "kind": "record",
+          "value": "ixo.topic.dispute"
+        }
+      },
+      {
+        "code": "failed",
+        "condition": "failed",
+        "priority": 650,
+        "source": {
+          "kind": "receipt",
+          "value": "failed"
+        }
+      },
+      {
+        "code": "blocked",
+        "condition": "blocked",
+        "priority": 600,
+        "source": {
+          "kind": "topic",
+          "value": "blocked"
+        },
+        "requiresTarget": true
+      },
+      {
+        "code": "waiting",
+        "condition": "waiting",
+        "priority": 500,
+        "source": {
+          "kind": "topic",
+          "value": "waiting"
+        },
+        "requiresTarget": true
+      },
+      {
+        "code": "needs-input",
+        "condition": "needs-input",
+        "priority": 400,
+        "source": {
+          "kind": "record",
+          "value": "ixo.topic.question"
+        }
+      },
+      {
+        "code": "needs-acceptance",
+        "condition": "needs-acceptance",
+        "priority": 350,
+        "source": {
+          "kind": "axis",
+          "value": "contract"
+        },
+        "states": [
+          "draft"
+        ]
+      }
+    ],
+    "inferredRecordPolicy": {
+      "autoAccept": [
+        "ixo.topic.fact",
+        "ixo.topic.summary",
+        "ixo.topic.classification"
+      ],
+      "neverAutoAccept": [
+        "ixo.topic.contract",
+        "ixo.topic.outcome",
+        "ixo.topic.authority",
+        "ixo.topic.action",
+        "ixo.claim",
+        "ixo.evaluation",
+        "ixo.settlement"
+      ]
+    }
+  }
+}