@olivervea/pipelines 0.0.0-stage → 2.0.0-beta.10

package/manifest.schema.json

@@ -0,0 +1,674 @@
+{
+  "$defs": {
+    "InputType": {
+      "anyOf": [
+        {
+          "additionalProperties": false,
+          "properties": {
+            "model": {
+              "description": "Model name (key of `models`).",
+              "pattern": "^[A-Za-z][A-Za-z0-9_]*$",
+              "type": "string"
+            },
+            "optional": {
+              "description": "optional(Model): may be absent because its producer was skipped.",
+              "type": "boolean"
+            }
+          },
+          "required": [
+            "model",
+            "optional"
+          ],
+          "type": "object"
+        },
+        {
+          "additionalProperties": false,
+          "properties": {
+            "schema": {
+              "$ref": "#/$defs/ModelSchemas",
+              "description": "A plain (unnamed) zod schema. Such inputs always have an explicit mapping."
+            }
+          },
+          "required": [
+            "schema"
+          ],
+          "type": "object"
+        }
+      ]
+    },
+    "Json": {
+      "$ref": "#/$defs/__schema0",
+      "description": "Any JSON value."
+    },
+    "Manifest": {
+      "additionalProperties": false,
+      "properties": {
+        "apiVersion": {
+          "const": "2.0",
+          "type": "string"
+        },
+        "config": {
+          "description": "Config entries used by steps, sorted by name (omitted when none). Fields of kind secretRef ({secret: NAME}) name a secret.",
+          "items": {
+            "additionalProperties": false,
+            "properties": {
+              "description": {
+                "type": "string"
+              },
+              "name": {
+                "description": "Config entry name; a key of the pipeline's config document.",
+                "pattern": "^[a-z][a-zA-Z0-9]*$",
+                "type": "string"
+              },
+              "required": {
+                "description": "False when the schema accepts a missing value (optional, or a default).",
+                "type": "boolean"
+              },
+              "schema": {
+                "additionalProperties": {},
+                "description": "z.input view: validates the config document's value for this entry (defaults listed).",
+                "propertyNames": {
+                  "type": "string"
+                },
+                "type": "object"
+              }
+            },
+            "required": [
+              "name",
+              "description",
+              "required",
+              "schema"
+            ],
+            "type": "object"
+          },
+          "type": "array"
+        },
+        "description": {
+          "type": "string"
+        },
+        "failureHandlers": {
+          "items": {
+            "additionalProperties": false,
+            "properties": {
+              "step": {
+                "$ref": "#/$defs/Step",
+                "description": "The handler step. Not part of any stage; its inputs are all FailureContext ({ref: 'failure'})."
+              },
+              "steps": {
+                "anyOf": [
+                  {
+                    "items": {
+                      "description": "Step name: lower-case kebab, 1-63 chars. The step's identity.",
+                      "pattern": "^[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?$",
+                      "type": "string"
+                    },
+                    "type": "array"
+                  },
+                  {
+                    "type": "null"
+                  }
+                ],
+                "description": "Steps whose failure triggers the handler (null = any step)."
+              }
+            },
+            "required": [
+              "step",
+              "steps"
+            ],
+            "type": "object"
+          },
+          "type": "array"
+        },
+        "harness": {
+          "additionalProperties": false,
+          "description": "Harness identity. Already folded into every handlerHash.",
+          "properties": {
+            "bun": {
+              "description": "Bun runtime version compiled into the binary.",
+              "type": "string"
+            },
+            "sdk": {
+              "description": "@olivervea/pipelines package version.",
+              "type": "string"
+            },
+            "sdkHash": {
+              "description": "Hash of the SDK runtime sources + zod version.",
+              "pattern": "^sha256:[0-9a-f]{64}$",
+              "type": "string"
+            }
+          },
+          "required": [
+            "bun",
+            "sdk",
+            "sdkHash"
+          ],
+          "type": "object"
+        },
+        "input": {
+          "description": "Pipeline input model.",
+          "pattern": "^[A-Za-z][A-Za-z0-9_]*$",
+          "type": "string"
+        },
+        "models": {
+          "additionalProperties": {
+            "$ref": "#/$defs/ModelSchemas"
+          },
+          "description": "Every model referenced by the pipeline (input, step inputs/outputs).",
+          "propertyNames": {
+            "description": "Model name (key of `models`).",
+            "pattern": "^[A-Za-z][A-Za-z0-9_]*$",
+            "type": "string"
+          },
+          "type": "object"
+        },
+        "name": {
+          "minLength": 1,
+          "type": "string"
+        },
+        "secrets": {
+          "description": "All declared secrets (steps + poll triggers), sorted by name.",
+          "items": {
+            "additionalProperties": false,
+            "properties": {
+              "description": {
+                "type": "string"
+              },
+              "name": {
+                "description": "Secret name; also the env var name in the step container.",
+                "pattern": "^[A-Z_][A-Z0-9_]*$",
+                "type": "string"
+              }
+            },
+            "required": [
+              "name",
+              "description"
+            ],
+            "type": "object"
+          },
+          "type": "array"
+        },
+        "stages": {
+          "items": {
+            "$ref": "#/$defs/Stage"
+          },
+          "type": "array"
+        },
+        "triggers": {
+          "items": {
+            "$ref": "#/$defs/Trigger"
+          },
+          "type": "array"
+        }
+      },
+      "required": [
+        "apiVersion",
+        "name",
+        "input",
+        "harness",
+        "models",
+        "secrets",
+        "triggers",
+        "stages",
+        "failureHandlers"
+      ],
+      "title": "Olve.Pipelines v2 manifest",
+      "type": "object"
+    },
+    "Mapping": {
+      "anyOf": [
+        {
+          "additionalProperties": false,
+          "description": "Value taken from the run pool. A ref whose root step was skipped yields no value (only allowed for optional inputs).",
+          "properties": {
+            "ref": {
+              "description": "'<root>' or '<root>.<field>.<field>…'. Root: 'input' (pipeline input), a step name (that step's output) or 'failure' (FailureContext, failure handlers only).",
+              "pattern": "^(?:input|failure|[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?)(?:\\.[^.]+)*$",
+              "type": "string"
+            }
+          },
+          "required": [
+            "ref"
+          ],
+          "type": "object"
+        },
+        {
+          "additionalProperties": false,
+          "description": "A JSON constant.",
+          "properties": {
+            "const": {
+              "$ref": "#/$defs/Json"
+            }
+          },
+          "required": [
+            "const"
+          ],
+          "type": "object"
+        },
+        {
+          "additionalProperties": {
+            "$ref": "#/$defs/Mapping"
+          },
+          "description": "An object built field by field. Discrimination: an object whose only key is 'ref' (string value) is a ref, whose only key is 'const' is a constant, anything else is a nested object (describe never emits a nested object whose only key is 'ref' or 'const').",
+          "propertyNames": {
+            "type": "string"
+          },
+          "type": "object"
+        }
+      ]
+    },
+    "ModelSchemas": {
+      "additionalProperties": false,
+      "properties": {
+        "input": {
+          "additionalProperties": {},
+          "description": "z.input view (defaults make fields optional; `default` values are listed). Present only when it differs from `output`.",
+          "propertyNames": {
+            "type": "string"
+          },
+          "type": "object"
+        },
+        "output": {
+          "additionalProperties": {},
+          "description": "z.output view: validates step outputs, trigger results and the pool. Every object has additionalProperties: false.",
+          "propertyNames": {
+            "type": "string"
+          },
+          "type": "object"
+        }
+      },
+      "required": [
+        "output"
+      ],
+      "type": "object"
+    },
+    "Stage": {
+      "anyOf": [
+        {
+          "additionalProperties": false,
+          "properties": {
+            "steps": {
+              "description": "Steps run in parallel; the stage is a barrier.",
+              "items": {
+                "$ref": "#/$defs/Step"
+              },
+              "minItems": 1,
+              "type": "array"
+            }
+          },
+          "required": [
+            "steps"
+          ],
+          "type": "object"
+        },
+        {
+          "additionalProperties": false,
+          "properties": {
+            "stages": {
+              "items": {
+                "$ref": "#/$defs/Stage"
+              },
+              "type": "array"
+            },
+            "when": {
+              "additionalProperties": {
+                "items": {
+                  "type": [
+                    "string",
+                    "number",
+                    "boolean"
+                  ]
+                },
+                "minItems": 1,
+                "type": "array"
+              },
+              "description": "Pipeline-input field → accepted values (all fields must match). Empty object = always.",
+              "propertyNames": {
+                "type": "string"
+              },
+              "type": "object"
+            }
+          },
+          "required": [
+            "when",
+            "stages"
+          ],
+          "type": "object"
+        },
+        {
+          "additionalProperties": false,
+          "properties": {
+            "cases": {
+              "additionalProperties": {
+                "items": {
+                  "$ref": "#/$defs/Stage"
+                },
+                "type": "array"
+              },
+              "description": "Discriminator value → stages. Exactly one case runs; a step name may repeat across cases, nowhere else.",
+              "propertyNames": {
+                "type": "string"
+              },
+              "type": "object"
+            },
+            "discriminator": {
+              "description": "The union's literal field whose value names the case.",
+              "minLength": 1,
+              "type": "string"
+            },
+            "select": {
+              "description": "Config reference (`<entry>.<field>…`) to a discriminated union; the run's config snapshot picks the case.",
+              "minLength": 1,
+              "type": "string"
+            }
+          },
+          "required": [
+            "select",
+            "discriminator",
+            "cases"
+          ],
+          "type": "object"
+        }
+      ]
+    },
+    "Step": {
+      "additionalProperties": false,
+      "properties": {
+        "clusterAccess": {
+          "const": true,
+          "description": "The step pod gets the instance's step ServiceAccount token (Kubernetes:StepServiceAccount), if the instance grants one. Omitted = no token.",
+          "type": "boolean"
+        },
+        "config": {
+          "additionalProperties": {
+            "$ref": "#/$defs/Json"
+          },
+          "description": "The step's settings (display only; already covered by handlerHash). A config reference is recorded as {\"$config\": \"<entry>.<field>…\"}; the entry is in configEntries.",
+          "propertyNames": {
+            "type": "string"
+          },
+          "type": "object"
+        },
+        "configEntries": {
+          "description": "Config entries the step receives (sorted; omitted when none). The service delivers them in input.json under '$config'.",
+          "items": {
+            "description": "Config entry name; a key of the pipeline's config document.",
+            "pattern": "^[a-z][a-zA-Z0-9]*$",
+            "type": "string"
+          },
+          "type": "array"
+        },
+        "description": {
+          "description": "What the step does, shown in the UI (may be empty).",
+          "type": "string"
+        },
+        "handlerHash": {
+          "description": "Implementation identity: handler bundle (contract files excluded) + harness (bun + sdkHash); for a step that carries its implementation kind + config + harness + the hash of the code of its kind.",
+          "pattern": "^sha256:[0-9a-f]{64}$",
+          "type": "string"
+        },
+        "image": {
+          "description": "Container image the step runs in.",
+          "minLength": 1,
+          "type": "string"
+        },
+        "input": {
+          "additionalProperties": {
+            "$ref": "#/$defs/Mapping"
+          },
+          "description": "How the service assembles input.json: one mapping per input key (same keys as inputTypes).",
+          "propertyNames": {
+            "type": "string"
+          },
+          "type": "object"
+        },
+        "inputTypes": {
+          "additionalProperties": {
+            "$ref": "#/$defs/InputType"
+          },
+          "description": "Declared input entries, keyed like input.json.",
+          "propertyNames": {
+            "type": "string"
+          },
+          "type": "object"
+        },
+        "kind": {
+          "description": "'custom' = the handler is a handlers/*.ts file; any other kind is a step that carries its implementation (an SDK or package step). A label: the service accepts any kind.",
+          "minLength": 1,
+          "type": "string"
+        },
+        "name": {
+          "description": "Step name: lower-case kebab, 1-63 chars. The step's identity.",
+          "pattern": "^[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?$",
+          "type": "string"
+        },
+        "output": {
+          "anyOf": [
+            {
+              "description": "Model name (key of `models`).",
+              "pattern": "^[A-Za-z][A-Za-z0-9_]*$",
+              "type": "string"
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "description": "Output model, or null if the step produces no output."
+        },
+        "retries": {
+          "maximum": 9007199254740991,
+          "minimum": 0,
+          "type": "integer"
+        },
+        "secrets": {
+          "description": "Declared secrets (sorted). Mount exactly these, as env vars of the same name.",
+          "items": {
+            "description": "Secret name; also the env var name in the step container.",
+            "pattern": "^[A-Z_][A-Z0-9_]*$",
+            "type": "string"
+          },
+          "type": "array"
+        },
+        "timeoutSeconds": {
+          "exclusiveMinimum": 0,
+          "maximum": 9007199254740991,
+          "type": "integer"
+        }
+      },
+      "required": [
+        "name",
+        "description",
+        "kind",
+        "image",
+        "inputTypes",
+        "input",
+        "output",
+        "secrets",
+        "handlerHash"
+      ],
+      "type": "object"
+    },
+    "Trigger": {
+      "oneOf": [
+        {
+          "additionalProperties": false,
+          "description": "GitHub push. Event = the webhook payload.",
+          "properties": {
+            "kind": {
+              "const": "push",
+              "type": "string"
+            },
+            "name": {
+              "const": "push",
+              "type": "string"
+            }
+          },
+          "required": [
+            "kind",
+            "name"
+          ],
+          "type": "object"
+        },
+        {
+          "additionalProperties": false,
+          "description": "Background poller.",
+          "properties": {
+            "headers": {
+              "additionalProperties": {
+                "type": "string"
+              },
+              "description": "Values may contain '$SECRET:NAME' (NAME ∈ secrets).",
+              "propertyNames": {
+                "type": "string"
+              },
+              "type": "object"
+            },
+            "intervalSeconds": {
+              "exclusiveMinimum": 0,
+              "maximum": 9007199254740991,
+              "type": "integer"
+            },
+            "kind": {
+              "const": "poll",
+              "type": "string"
+            },
+            "name": {
+              "pattern": "^[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?$",
+              "type": "string"
+            },
+            "secrets": {
+              "items": {
+                "description": "Secret name; also the env var name in the step container.",
+                "pattern": "^[A-Z_][A-Z0-9_]*$",
+                "type": "string"
+              },
+              "type": "array"
+            },
+            "url": {
+              "type": "string"
+            },
+            "valuePath": {
+              "description": "Dot path into the JSON response; a change triggers map-trigger with {\"value\": <string>}.",
+              "type": "string"
+            }
+          },
+          "required": [
+            "kind",
+            "name",
+            "url",
+            "headers",
+            "secrets",
+            "valuePath",
+            "intervalSeconds"
+          ],
+          "type": "object"
+        },
+        {
+          "additionalProperties": false,
+          "description": "Inbound HTTP delivery to /api/hooks/<pipeline id>/<name>. Event = {headers, body}; a null mapping ignores it.",
+          "properties": {
+            "kind": {
+              "const": "webhook",
+              "type": "string"
+            },
+            "name": {
+              "pattern": "^[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?$",
+              "type": "string"
+            },
+            "verify": {
+              "oneOf": [
+                {
+                  "additionalProperties": false,
+                  "properties": {
+                    "header": {
+                      "minLength": 1,
+                      "type": "string"
+                    },
+                    "prefix": {
+                      "description": "Text before the hex digest in the header, e.g. 'sha256='.",
+                      "type": "string"
+                    },
+                    "scheme": {
+                      "const": "hmac-sha256",
+                      "type": "string"
+                    },
+                    "secret": {
+                      "description": "Secret name; also the env var name in the step container.",
+                      "pattern": "^[A-Z_][A-Z0-9_]*$",
+                      "type": "string"
+                    }
+                  },
+                  "required": [
+                    "scheme",
+                    "secret",
+                    "header",
+                    "prefix"
+                  ],
+                  "type": "object"
+                },
+                {
+                  "additionalProperties": false,
+                  "properties": {
+                    "scheme": {
+                      "const": "bearer",
+                      "type": "string"
+                    },
+                    "secret": {
+                      "description": "Secret name; also the env var name in the step container.",
+                      "pattern": "^[A-Z_][A-Z0-9_]*$",
+                      "type": "string"
+                    }
+                  },
+                  "required": [
+                    "scheme",
+                    "secret"
+                  ],
+                  "type": "object"
+                }
+              ]
+            }
+          },
+          "required": [
+            "kind",
+            "name",
+            "verify"
+          ],
+          "type": "object"
+        }
+      ]
+    },
+    "__schema0": {
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "number"
+        },
+        {
+          "type": "boolean"
+        },
+        {
+          "type": "null"
+        },
+        {
+          "items": {
+            "$ref": "#/$defs/__schema0"
+          },
+          "type": "array"
+        },
+        {
+          "additionalProperties": {
+            "$ref": "#/$defs/__schema0"
+          },
+          "propertyNames": {
+            "type": "string"
+          },
+          "type": "object"
+        }
+      ]
+    }
+  },
+  "$id": "https://olve.dev/schemas/pipelines/manifest-2.0.json",
+  "$ref": "#/$defs/Manifest",
+  "$schema": "https://json-schema.org/draft/2020-12/schema"
+}