opencode-goal-plugin 0.5.0 → 0.6.1

package/src/completion-claim.js

@@ -0,0 +1,127 @@
+const MAX_SUMMARY_LENGTH = 500
+const MAX_CRITERIA = 20
+const MAX_CHECKS = 20
+const MAX_CHANGED_FILES = 100
+const MAX_LIMITATIONS = 20
+const MAX_CRITERION_LENGTH = 300
+const MAX_ITEM_LENGTH = 500
+const CHECK_RESULTS = new Set(["passed", "failed", "not-run"])
+
+function cleanStringList(values, field) {
+  const cleaned = values.map((value) => (typeof value === "string" ? value.trim() : ""))
+  return cleaned.every((value) => value && value.length <= MAX_ITEM_LENGTH)
+    ? { ok: true, values: cleaned }
+    : {
+        ok: false,
+        error: `${field} entries must be non-empty strings of ${MAX_ITEM_LENGTH} characters or fewer`,
+      }
+}
+
+/**
+ * Validate an untrusted completion claim and render the concise evidence text
+ * consumed by completion auditors. Validation belongs at this tool boundary so
+ * malformed claims never enter goal state or verifier prompts.
+ */
+export function serializeCompletionClaim(raw = {}) {
+  const claim = raw && typeof raw === "object" && !Array.isArray(raw) ? raw : {}
+  const summary = typeof claim.summary === "string" ? claim.summary.trim() : ""
+  if (!summary) return { ok: false, error: "summary must be a non-empty string" }
+  if (summary.length > MAX_SUMMARY_LENGTH) {
+    return { ok: false, error: `summary must be ${MAX_SUMMARY_LENGTH} characters or fewer` }
+  }
+
+  const criteria = claim.criteria === undefined ? [] : claim.criteria
+  const checks = claim.checks === undefined ? [] : claim.checks
+  const changedFiles = claim.changedFiles === undefined ? [] : claim.changedFiles
+  const knownLimitations = claim.knownLimitations === undefined ? [] : claim.knownLimitations
+  if (
+    !Array.isArray(criteria) ||
+    !Array.isArray(checks) ||
+    !Array.isArray(changedFiles) ||
+    !Array.isArray(knownLimitations)
+  ) {
+    return {
+      ok: false,
+      error: "criteria, checks, changedFiles, and knownLimitations must be arrays when provided",
+    }
+  }
+  if (
+    criteria.length > MAX_CRITERIA ||
+    checks.length > MAX_CHECKS ||
+    changedFiles.length > MAX_CHANGED_FILES ||
+    knownLimitations.length > MAX_LIMITATIONS
+  ) {
+    return { ok: false, error: "completion claim exceeds item limits" }
+  }
+
+  const cleanCriteria = []
+  for (const item of criteria) {
+    const criterion = typeof item?.criterion === "string" ? item.criterion.trim() : ""
+    const evidence = Array.isArray(item?.evidence)
+      ? item.evidence.map((value) => (typeof value === "string" ? value.trim() : "")).filter(Boolean)
+      : []
+    if (!criterion || evidence.length === 0) {
+      return {
+        ok: false,
+        error: "each criterion requires a non-empty criterion and at least one evidence item",
+      }
+    }
+    if (
+      criterion.length > MAX_CRITERION_LENGTH ||
+      evidence.some((value) => value.length > MAX_ITEM_LENGTH)
+    ) {
+      return {
+        ok: false,
+        error: `criterion must be ${MAX_CRITERION_LENGTH} characters or fewer and evidence items ${MAX_ITEM_LENGTH} or fewer`,
+      }
+    }
+    cleanCriteria.push({ criterion, evidence })
+  }
+
+  const cleanChecks = []
+  for (const item of checks) {
+    const result = typeof item?.result === "string" ? item.result.trim() : ""
+    if (!CHECK_RESULTS.has(result)) {
+      return { ok: false, error: "each check result must be passed, failed, or not-run" }
+    }
+    if (result === "failed") return { ok: false, error: "completion cannot include a failed check" }
+    const command = typeof item?.command === "string" ? item.command.trim() : ""
+    const explanation = typeof item?.explanation === "string" ? item.explanation.trim() : ""
+    const exitCode = item?.exitCode
+    if (exitCode !== undefined && (!Number.isInteger(exitCode) || exitCode < 0)) {
+      return { ok: false, error: "check exitCode must be a non-negative integer" }
+    }
+    if (!command && !explanation) {
+      return { ok: false, error: "each check requires a command or explanation" }
+    }
+    if (command.length > MAX_ITEM_LENGTH || explanation.length > MAX_ITEM_LENGTH) {
+      return {
+        ok: false,
+        error: `check command and explanation must be ${MAX_ITEM_LENGTH} characters or fewer`,
+      }
+    }
+    cleanChecks.push({ command, result, exitCode, explanation })
+  }
+
+  const files = cleanStringList(changedFiles, "changedFiles")
+  if (!files.ok) return files
+  const limitations = cleanStringList(knownLimitations, "knownLimitations")
+  if (!limitations.ok) return limitations
+
+  const lines = [`Summary: ${summary}`]
+  cleanCriteria.forEach(({ criterion, evidence }) => {
+    lines.push(`Criterion: ${criterion} | Evidence: ${evidence.join("; ")}`)
+  })
+  cleanChecks.forEach(({ command, result, exitCode, explanation }) => {
+    const subject = command || "manual check"
+    const details = [exitCode === undefined ? "" : `exit ${exitCode}`, explanation]
+      .filter(Boolean)
+      .join("; ")
+    lines.push(`Check: ${subject} | ${result}${details ? ` | ${details}` : ""}`)
+  })
+  if (files.values.length) lines.push(`Changed files: ${files.values.join(", ")}`)
+  if (limitations.values.length) {
+    lines.push(`Known limitations: ${limitations.values.join("; ")}`)
+  }
+  return { ok: true, evidence: lines.join("\n") }
+}