@opensoftware/contracts 0.0.0-stage → 1.0.0

package/events/run-completed/run-completed.schema.json

@@ -0,0 +1,163 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://raw.githubusercontent.com/sesigl/open-software-factory/main/contracts/events/run-completed/run-completed.schema.json",
+  "title": "RunCompleted",
+  "$comment": "Generated by `pnpm build` in contracts/ from typespec/. Do not edit.",
+  "type": "object",
+  "properties": {
+    "specversion": {
+      "type": "string",
+      "const": "1.0"
+    },
+    "id": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 128,
+      "description": "Unique per source. A consumer that sees the same source and id twice handles the event once."
+    },
+    "source": {
+      "type": "string",
+      "minLength": 1,
+      "description": "The producing module, for example \"/osf/intake\"."
+    },
+    "type": {
+      "type": "string",
+      "const": "run.completed@v1"
+    },
+    "time": {
+      "type": "string",
+      "format": "date-time"
+    },
+    "subject": {
+      "type": "string",
+      "description": "The ID of the thing the event is about: work item, gate, run, score or pull request."
+    },
+    "datacontenttype": {
+      "type": "string",
+      "const": "application/json"
+    },
+    "dataschema": {
+      "type": "string",
+      "format": "uri"
+    },
+    "traceparent": {
+      "type": "string",
+      "description": "W3C trace context (CloudEvents distributed tracing extension)."
+    },
+    "data": {
+      "type": "object",
+      "properties": {
+        "runId": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 128,
+          "description": "An identifier chosen by the producer. ULIDs are recommended; consumers treat it as opaque."
+        },
+        "workItemId": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 128,
+          "description": "An identifier chosen by the producer. ULIDs are recommended; consumers treat it as opaque."
+        },
+        "stage": {
+          "type": "string",
+          "pattern": "^[a-z][a-z0-9-]{0,62}$",
+          "description": "A lowercase name: letters, digits and hyphens, starting with a letter. Agents, stages, adapters, sources."
+        },
+        "factoryVersion": {
+          "type": "string",
+          "pattern": "^[0-9a-f]{7,40}$",
+          "description": "A Git commit hash, abbreviated (7+) or full. The factory version is the commit of the factory definition."
+        },
+        "outcome": {
+          "type": "string",
+          "enum": [
+            "succeeded",
+            "failed",
+            "cancelled"
+          ],
+          "description": "How a run ended."
+        },
+        "startedAt": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "endedAt": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "requester": {
+          "type": "object",
+          "properties": {
+            "kind": {
+              "type": "string",
+              "enum": [
+                "person",
+                "trigger"
+              ],
+              "description": "Who caused something: a person, or an automated trigger such as a cron rule or an alert."
+            },
+            "id": {
+              "type": "string",
+              "minLength": 1,
+              "description": "Stable ID in the source system, prefixed with the source, for example \"slack:U024BE7LH\"."
+            },
+            "displayName": {
+              "type": "string",
+              "description": "Shown to people, for example \"Varun\"."
+            }
+          },
+          "required": [
+            "kind",
+            "id"
+          ],
+          "description": "A person or trigger. RUNTIME-008: every run is attributed to one."
+        },
+        "source": {
+          "type": "string",
+          "pattern": "^[a-z][a-z0-9-]{0,62}$",
+          "description": "A lowercase name: letters, digits and hyphens, starting with a letter. Agents, stages, adapters, sources."
+        },
+        "costUsd": {
+          "type": "number",
+          "minimum": 0
+        },
+        "traceId": {
+          "type": "string",
+          "pattern": "^[0-9a-f]{32}$",
+          "description": "An OpenTelemetry trace ID: 32 lowercase hex characters."
+        },
+        "pullRequests": {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "format": "uri"
+          }
+        },
+        "evidenceBundle": {
+          "type": "string",
+          "format": "uri"
+        }
+      },
+      "required": [
+        "runId",
+        "workItemId",
+        "factoryVersion",
+        "outcome",
+        "startedAt",
+        "endedAt",
+        "requester",
+        "source"
+      ]
+    }
+  },
+  "required": [
+    "specversion",
+    "id",
+    "source",
+    "type",
+    "time",
+    "data"
+  ],
+  "description": "foreman: a run ended."
+}

package/events/score-recorded/score-recorded.schema.json

@@ -0,0 +1,163 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://raw.githubusercontent.com/sesigl/open-software-factory/main/contracts/events/score-recorded/score-recorded.schema.json",
+  "title": "ScoreRecorded",
+  "$comment": "Generated by `pnpm build` in contracts/ from typespec/. Do not edit.",
+  "type": "object",
+  "properties": {
+    "specversion": {
+      "type": "string",
+      "const": "1.0"
+    },
+    "id": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 128,
+      "description": "Unique per source. A consumer that sees the same source and id twice handles the event once."
+    },
+    "source": {
+      "type": "string",
+      "minLength": 1,
+      "description": "The producing module, for example \"/osf/intake\"."
+    },
+    "type": {
+      "type": "string",
+      "const": "score.recorded@v1"
+    },
+    "time": {
+      "type": "string",
+      "format": "date-time"
+    },
+    "subject": {
+      "type": "string",
+      "description": "The ID of the thing the event is about: work item, gate, run, score or pull request."
+    },
+    "datacontenttype": {
+      "type": "string",
+      "const": "application/json"
+    },
+    "dataschema": {
+      "type": "string",
+      "format": "uri"
+    },
+    "traceparent": {
+      "type": "string",
+      "description": "W3C trace context (CloudEvents distributed tracing extension)."
+    },
+    "data": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 128,
+          "description": "An identifier chosen by the producer. ULIDs are recommended; consumers treat it as opaque."
+        },
+        "name": {
+          "type": "string",
+          "minLength": 1,
+          "description": "Scorer name, for example \"redundant-tests\"."
+        },
+        "value": {
+          "anyOf": [
+            {
+              "type": "number"
+            },
+            {
+              "type": "string"
+            }
+          ],
+          "description": "A number for NUMERIC, 0 or 1 for BOOLEAN, a string for CATEGORICAL."
+        },
+        "dataType": {
+          "type": "string",
+          "enum": [
+            "NUMERIC",
+            "BOOLEAN",
+            "CATEGORICAL"
+          ]
+        },
+        "traceId": {
+          "type": "string",
+          "pattern": "^[0-9a-f]{32}$",
+          "description": "Trace of the run (the OTel trace ID)."
+        },
+        "observationId": {
+          "type": "string",
+          "description": "Span the score is about, when it is not the whole run."
+        },
+        "sessionId": {
+          "type": "string"
+        },
+        "comment": {
+          "type": "string",
+          "description": "The reason."
+        },
+        "timestamp": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "source": {
+          "type": "string",
+          "enum": [
+            "API",
+            "ANNOTATION"
+          ],
+          "description": "API for scorers, ANNOTATION for scores a person reviews."
+        },
+        "configId": {
+          "type": "string"
+        },
+        "environment": {
+          "type": "string"
+        },
+        "metadata": {
+          "type": "object",
+          "properties": {
+            "osf.run.id": {
+              "type": "string",
+              "minLength": 1,
+              "maxLength": 128,
+              "description": "An identifier chosen by the producer. ULIDs are recommended; consumers treat it as opaque."
+            },
+            "osf.scorer.version": {
+              "type": "string"
+            },
+            "osf.judge.model": {
+              "type": "string",
+              "description": "Judge model of an LLM scorer."
+            },
+            "osf.judge.cost.usd": {
+              "type": "number",
+              "minimum": 0,
+              "description": "Cost of the judge call."
+            }
+          },
+          "required": [
+            "osf.run.id"
+          ],
+          "unevaluatedProperties": {}
+        }
+      },
+      "required": [
+        "id",
+        "name",
+        "value",
+        "dataType",
+        "traceId",
+        "timestamp",
+        "metadata"
+      ],
+      "description": "The result of one scorer on one run. The fields are a subset of Langfuse's create-score request\n(POST /api/public/scores), so a score can be sent to Langfuse as is. Factory fields live in `metadata`."
+    }
+  },
+  "required": [
+    "specversion",
+    "id",
+    "source",
+    "type",
+    "time",
+    "data"
+  ],
+  "description": "scorekit: a scorer scored a run."
+}

package/events/work-received/work-received.schema.json

@@ -0,0 +1,182 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://raw.githubusercontent.com/sesigl/open-software-factory/main/contracts/events/work-received/work-received.schema.json",
+  "title": "WorkReceived",
+  "$comment": "Generated by `pnpm build` in contracts/ from typespec/. Do not edit.",
+  "type": "object",
+  "properties": {
+    "specversion": {
+      "type": "string",
+      "const": "1.0"
+    },
+    "id": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 128,
+      "description": "Unique per source. A consumer that sees the same source and id twice handles the event once."
+    },
+    "source": {
+      "type": "string",
+      "minLength": 1,
+      "description": "The producing module, for example \"/osf/intake\"."
+    },
+    "type": {
+      "type": "string",
+      "const": "work.received@v1"
+    },
+    "time": {
+      "type": "string",
+      "format": "date-time"
+    },
+    "subject": {
+      "type": "string",
+      "description": "The ID of the thing the event is about: work item, gate, run, score or pull request."
+    },
+    "datacontenttype": {
+      "type": "string",
+      "const": "application/json"
+    },
+    "dataschema": {
+      "type": "string",
+      "format": "uri"
+    },
+    "traceparent": {
+      "type": "string",
+      "description": "W3C trace context (CloudEvents distributed tracing extension)."
+    },
+    "data": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 128,
+          "description": "An identifier chosen by the producer. ULIDs are recommended; consumers treat it as opaque."
+        },
+        "type": {
+          "type": "string",
+          "enum": [
+            "idea",
+            "bug",
+            "task",
+            "automation"
+          ]
+        },
+        "title": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 300
+        },
+        "description": {
+          "type": "string"
+        },
+        "requester": {
+          "type": "object",
+          "properties": {
+            "kind": {
+              "type": "string",
+              "enum": [
+                "person",
+                "trigger"
+              ],
+              "description": "Who caused something: a person, or an automated trigger such as a cron rule or an alert."
+            },
+            "id": {
+              "type": "string",
+              "minLength": 1,
+              "description": "Stable ID in the source system, prefixed with the source, for example \"slack:U024BE7LH\"."
+            },
+            "displayName": {
+              "type": "string",
+              "description": "Shown to people, for example \"Varun\"."
+            }
+          },
+          "required": [
+            "kind",
+            "id"
+          ],
+          "description": "The person or trigger that asked for the work."
+        },
+        "origin": {
+          "type": "object",
+          "properties": {
+            "source": {
+              "type": "string",
+              "pattern": "^[a-z][a-z0-9-]{0,62}$",
+              "description": "The channel or system, for example \"slack\", \"github\", \"sentry\", \"cron\", \"mcp\"."
+            },
+            "url": {
+              "type": "string",
+              "format": "uri",
+              "description": "Link back to the origin, for example the Slack thread. Absent for a schedule."
+            },
+            "externalId": {
+              "type": "string",
+              "description": "ID in the source system."
+            }
+          },
+          "required": [
+            "source"
+          ],
+          "description": "Where the work came from."
+        },
+        "dedupeKey": {
+          "type": "string",
+          "minLength": 1,
+          "description": "Requests with the same key become one work item, for example \"github:acme/web#42\"."
+        },
+        "surface": {
+          "type": "string",
+          "description": "Product surface the work is about, for example \"checkout\"."
+        },
+        "priority": {
+          "type": "string",
+          "enum": [
+            "urgent",
+            "high",
+            "normal",
+            "low"
+          ],
+          "description": "Set by triage."
+        },
+        "links": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "url": {
+                "type": "string",
+                "format": "uri"
+              },
+              "title": {
+                "type": "string"
+              }
+            },
+            "required": [
+              "url"
+            ]
+          },
+          "description": "Related material: an error report, a change, a document."
+        }
+      },
+      "required": [
+        "id",
+        "type",
+        "title",
+        "requester",
+        "origin",
+        "dedupeKey"
+      ],
+      "description": "One unit of requested work: the `data` of a `work.received@v1` CloudEvent."
+    }
+  },
+  "required": [
+    "specversion",
+    "id",
+    "source",
+    "type",
+    "time",
+    "data"
+  ],
+  "description": "intake: a work item was accepted."
+}

package/evidence-bundle/evidence-bundle.schema.json

@@ -0,0 +1,180 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://raw.githubusercontent.com/sesigl/open-software-factory/main/contracts/evidence-bundle/evidence-bundle.schema.json",
+  "title": "EvidenceManifest",
+  "$comment": "Generated by `pnpm build` in contracts/ from typespec/. Do not edit.",
+  "type": "object",
+  "properties": {
+    "manifestVersion": {
+      "type": "integer",
+      "minimum": 1,
+      "maximum": 2147483647,
+      "description": "Version of this format.",
+      "const": 1
+    },
+    "id": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 128,
+      "description": "An identifier chosen by the producer. ULIDs are recommended; consumers treat it as opaque."
+    },
+    "createdAt": {
+      "type": "string",
+      "format": "date-time"
+    },
+    "subject": {
+      "type": "object",
+      "properties": {
+        "repository": {
+          "type": "string",
+          "format": "uri"
+        },
+        "commit": {
+          "type": "string",
+          "pattern": "^[0-9a-f]{7,40}$",
+          "description": "A Git commit hash, abbreviated (7+) or full. The factory version is the commit of the factory definition."
+        },
+        "pullRequest": {
+          "type": "string",
+          "format": "uri"
+        }
+      },
+      "required": [
+        "repository",
+        "commit"
+      ],
+      "description": "The change that was verified."
+    },
+    "runId": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 128,
+      "description": "An identifier chosen by the producer. ULIDs are recommended; consumers treat it as opaque."
+    },
+    "workItemId": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 128,
+      "description": "An identifier chosen by the producer. ULIDs are recommended; consumers treat it as opaque."
+    },
+    "producer": {
+      "type": "object",
+      "properties": {
+        "name": {
+          "type": "string",
+          "minLength": 1
+        },
+        "version": {
+          "type": "string",
+          "minLength": 1
+        }
+      },
+      "required": [
+        "name",
+        "version"
+      ],
+      "description": "The tool that wrote the bundle, for example proof 1.2.0."
+    },
+    "result": {
+      "type": "string",
+      "enum": [
+        "passed",
+        "failed"
+      ],
+      "description": "Passed only when every scenario passed."
+    },
+    "scenarios": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string",
+            "pattern": "^SCN-[A-Z][A-Z0-9]*(-[A-Z][A-Z0-9]*)*-[0-9]{3}$",
+            "description": "A scenario ID as checked by SPEC, for example SCN-PROOF-004."
+          },
+          "result": {
+            "type": "string",
+            "enum": [
+              "passed",
+              "failed",
+              "skipped"
+            ]
+          },
+          "artifacts": {
+            "type": "array",
+            "items": {
+              "type": "string",
+              "pattern": "^(?!/)(?!.*(^|/)\\.\\.(/|$))[^\\\\]+$",
+              "description": "A path inside the bundle: relative, forward slashes, no \"..\"."
+            },
+            "description": "Paths of the artifacts in this bundle that prove the scenario."
+          },
+          "summary": {
+            "type": "string"
+          }
+        },
+        "required": [
+          "id",
+          "result",
+          "artifacts"
+        ]
+      }
+    },
+    "artifacts": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "path": {
+            "type": "string",
+            "pattern": "^(?!/)(?!.*(^|/)\\.\\.(/|$))[^\\\\]+$",
+            "description": "A path inside the bundle: relative, forward slashes, no \"..\"."
+          },
+          "kind": {
+            "type": "string",
+            "enum": [
+              "screenshot",
+              "video",
+              "playwright-trace",
+              "junit",
+              "log",
+              "report",
+              "other"
+            ]
+          },
+          "mediaType": {
+            "type": "string",
+            "minLength": 1,
+            "description": "IANA media type, for example \"image/png\"."
+          },
+          "sha256": {
+            "type": "string",
+            "pattern": "^[0-9a-f]{64}$"
+          },
+          "bytes": {
+            "type": "integer",
+            "minimum": 0
+          }
+        },
+        "required": [
+          "path",
+          "kind",
+          "mediaType",
+          "sha256"
+        ]
+      }
+    }
+  },
+  "required": [
+    "manifestVersion",
+    "id",
+    "createdAt",
+    "subject",
+    "producer",
+    "result",
+    "scenarios",
+    "artifacts"
+  ],
+  "description": "`evidence.json` at the root of an evidence bundle: what was verified, against which scenario IDs, with which\nartifacts and result (P10)."
+}