@toolproof-core/schema 1.0.0

package/src/generated/schemas/RunnableStrategy.json

@@ -0,0 +1,737 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "allOf": [
+    {
+      "$comment": "The Engine runs jobs specified by steps in strategyThreadMap. The Engine  also injects repeted steps when encountering loops.",
+      "$ref": "#/$defs/StrategyThreadMapFacet"
+    },
+    {
+      "$comment": "The Engine updates strategyState with materialized Resources upon job completions and runtime-provided input events. It also inserts input-potential and output-potential Resources upon step injections.",
+      "$ref": "#/$defs/StrategyStateFacet"
+    }
+  ],
+  "properties": {
+    "identity": {
+      "$ref": "#/$defs/RunnableStrategyIdentity"
+    },
+    "runnableStrategyContext": {
+      "$ref": "#/$defs/RunnableStrategyContext"
+    }
+  },
+  "required": [
+    "identity",
+    "runnableStrategyContext"
+  ],
+  "unevaluatedProperties": false,
+  "$anchor": "RunnableStrategy",
+  "$defs": {
+    "StrategyThreadMapFacet": {
+      "$schema": "https://json-schema.org/draft/2020-12/schema",
+      "type": "object",
+      "properties": {
+        "strategyThreadMap": {
+          "$ref": "#/$defs/StrategyThreadMap"
+        }
+      },
+      "required": [
+        "strategyThreadMap"
+      ],
+      "$anchor": "StrategyThreadMapFacet"
+    },
+    "StrategyStateFacet": {
+      "$schema": "https://json-schema.org/draft/2020-12/schema",
+      "type": "object",
+      "properties": {
+        "strategyState": {
+          "$ref": "#/$defs/StrategyState"
+        }
+      },
+      "required": [
+        "strategyState"
+      ],
+      "$anchor": "StrategyStateFacet"
+    },
+    "RunnableStrategyIdentity": {
+      "$schema": "https://json-schema.org/draft/2020-12/schema",
+      "type": "string",
+      "$anchor": "RunnableStrategyIdentity",
+      "pattern": "^RUNNABLE_STRATEGY-.+$"
+    },
+    "RunnableStrategyContext": {
+      "$schema": "https://json-schema.org/draft/2020-12/schema",
+      "type": "object",
+      "properties": {
+        "completedAt": {
+          "$ref": "#/$defs/Timestamp"
+        },
+        "startedAt": {
+          "$ref": "#/$defs/Timestamp"
+        },
+        "status": {
+          "$ref": "#/$defs/RunnableStrategyStatus"
+        }
+      },
+      "required": [
+        "status"
+      ],
+      "unevaluatedProperties": false,
+      "$anchor": "RunnableStrategyContext"
+    },
+    "StrategyThreadMap": {
+      "$schema": "https://json-schema.org/draft/2020-12/schema",
+      "type": "object",
+      "additionalProperties": {
+        "$ref": "#/$defs/StepArray"
+      },
+      "$anchor": "StrategyThreadMap",
+      "$comment": "Each thread contains an array of steps, allowing for sequential execution within a thread while supporting parallel execution across multiple threads.",
+      "propertyNames": {
+        "$ref": "#/$defs/StrategyThreadIdentity"
+      }
+    },
+    "StrategyState": {
+      "$schema": "https://json-schema.org/draft/2020-12/schema",
+      "type": "object",
+      "additionalProperties": {
+        "$ref": "#/$defs/JobRunSocket"
+      },
+      "$anchor": "StrategyState",
+      "propertyNames": {
+        "$ref": "#/$defs/JobRunIdentity"
+      }
+    },
+    "Timestamp": {
+      "$schema": "https://json-schema.org/draft/2020-12/schema",
+      "type": "string",
+      "$anchor": "Timestamp",
+      "format": "date-time"
+    },
+    "RunnableStrategyStatus": {
+      "$schema": "https://json-schema.org/draft/2020-12/schema",
+      "type": "string",
+      "$anchor": "RunnableStrategyStatus",
+      "enum": [
+        "pending",
+        "running",
+        "completed",
+        "failed",
+        "cancelled"
+      ]
+    },
+    "StepArray": {
+      "$schema": "https://json-schema.org/draft/2020-12/schema",
+      "type": "array",
+      "$anchor": "StepArray",
+      "items": {
+        "$ref": "#/$defs/Step"
+      },
+      "uniqueItems": true
+    },
+    "StrategyThreadIdentity": {
+      "$schema": "https://json-schema.org/draft/2020-12/schema",
+      "type": "string",
+      "$anchor": "StrategyThreadIdentity",
+      "pattern": "^STRATEGY_THREAD-.+$"
+    },
+    "JobRunSocket": {
+      "$schema": "https://json-schema.org/draft/2020-12/schema",
+      "type": "object",
+      "additionalProperties": {
+        "$ref": "#/$defs/Resource"
+      },
+      "$anchor": "JobRunSocket",
+      "propertyNames": {
+        "$ref": "#/$defs/ResourceRoleIdentity"
+      }
+    },
+    "JobRunIdentity": {
+      "$schema": "https://json-schema.org/draft/2020-12/schema",
+      "type": "string",
+      "$anchor": "JobRunIdentity",
+      "pattern": "^JobRun-.+$"
+    },
+    "Step": {
+      "$schema": "https://json-schema.org/draft/2020-12/schema",
+      "type": "object",
+      "oneOf": [
+        {
+          "$ref": "#/$defs/JobStep"
+        },
+        {
+          "$ref": "#/$defs/BranchStep"
+        },
+        {
+          "$ref": "#/$defs/WhileStep"
+        },
+        {
+          "$ref": "#/$defs/ForStep"
+        }
+      ],
+      "unevaluatedProperties": false,
+      "$anchor": "Step"
+    },
+    "Resource": {
+      "$schema": "https://json-schema.org/draft/2020-12/schema",
+      "type": "object",
+      "oneOf": [
+        {
+          "$ref": "#/$defs/ResourceMissing"
+        },
+        {
+          "$ref": "#/$defs/ResourceInputPotential"
+        },
+        {
+          "$ref": "#/$defs/ResourceOutputPotential"
+        },
+        {
+          "$ref": "#/$defs/ResourceMaterialized"
+        }
+      ],
+      "unevaluatedProperties": false,
+      "$anchor": "Resource"
+    },
+    "ResourceRoleIdentity": {
+      "$schema": "https://json-schema.org/draft/2020-12/schema",
+      "type": "string",
+      "$anchor": "ResourceRoleIdentity",
+      "pattern": "^ROLE-.+$"
+    },
+    "JobStep": {
+      "$schema": "https://json-schema.org/draft/2020-12/schema",
+      "type": "object",
+      "allOf": [
+        {
+          "$ref": "#/$defs/StepKindFacet"
+        }
+      ],
+      "properties": {
+        "identity": {
+          "$ref": "#/$defs/JobStepIdentity"
+        },
+        "jobRun": {
+          "$ref": "#/$defs/JobRun"
+        },
+        "stepKind": {
+          "const": "job"
+        }
+      },
+      "required": [
+        "identity",
+        "jobRun"
+      ],
+      "$anchor": "JobStep"
+    },
+    "BranchStep": {
+      "$schema": "https://json-schema.org/draft/2020-12/schema",
+      "type": "object",
+      "allOf": [
+        {
+          "$ref": "#/$defs/StepKindFacet"
+        }
+      ],
+      "properties": {
+        "cases": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/Conditional"
+          },
+          "minItems": 1,
+          "uniqueItems": true
+        },
+        "identity": {
+          "$ref": "#/$defs/BranchStepIdentity"
+        },
+        "stepKind": {
+          "const": "branch"
+        }
+      },
+      "required": [
+        "identity",
+        "cases"
+      ],
+      "$anchor": "BranchStep"
+    },
+    "WhileStep": {
+      "$schema": "https://json-schema.org/draft/2020-12/schema",
+      "type": "object",
+      "allOf": [
+        {
+          "$ref": "#/$defs/StepKindFacet"
+        }
+      ],
+      "properties": {
+        "case": {
+          "$ref": "#/$defs/Conditional"
+        },
+        "identity": {
+          "$ref": "#/$defs/WhileStepIdentity"
+        },
+        "stepKind": {
+          "const": "while"
+        }
+      },
+      "required": [
+        "identity",
+        "case"
+      ],
+      "$anchor": "WhileStep"
+    },
+    "ForStep": {
+      "$schema": "https://json-schema.org/draft/2020-12/schema",
+      "type": "object",
+      "allOf": [
+        {
+          "$ref": "#/$defs/StepKindFacet"
+        }
+      ],
+      "properties": {
+        "case": {
+          "$ref": "#/$defs/Conditional"
+        },
+        "identity": {
+          "$ref": "#/$defs/ForStepIdentity"
+        },
+        "stepKind": {
+          "const": "for"
+        }
+      },
+      "required": [
+        "identity",
+        "case"
+      ],
+      "$anchor": "ForStep"
+    },
+    "ResourceMissing": {
+      "$schema": "https://json-schema.org/draft/2020-12/schema",
+      "type": "object",
+      "unevaluatedProperties": false,
+      "$anchor": "ResourceMissing",
+      "$ref": "#/$defs/ShellMissing"
+    },
+    "ResourceInputPotential": {
+      "$schema": "https://json-schema.org/draft/2020-12/schema",
+      "type": "object",
+      "unevaluatedProperties": false,
+      "$anchor": "ResourceInputPotential",
+      "$ref": "#/$defs/ShellInputPotential"
+    },
+    "ResourceOutputPotential": {
+      "$schema": "https://json-schema.org/draft/2020-12/schema",
+      "type": "object",
+      "unevaluatedProperties": false,
+      "$anchor": "ResourceOutputPotential",
+      "$ref": "#/$defs/ShellOutputPotential"
+    },
+    "ResourceMaterialized": {
+      "$schema": "https://json-schema.org/draft/2020-12/schema",
+      "type": "object",
+      "allOf": [
+        {
+          "$ref": "#/$defs/ShellMaterializedBase"
+        },
+        {
+          "$comment": "This will be overlayed dynamically to match the data structure of the underlying ResourceType's nucleusSchema.",
+          "$ref": "#/$defs/NucleusFacet"
+        }
+      ],
+      "unevaluatedProperties": false,
+      "$anchor": "ResourceMaterialized"
+    },
+    "StepKindFacet": {
+      "$schema": "https://json-schema.org/draft/2020-12/schema",
+      "type": "object",
+      "properties": {
+        "stepKind": {
+          "$ref": "#/$defs/StepKind"
+        }
+      },
+      "required": [
+        "stepKind"
+      ],
+      "$anchor": "StepKindFacet"
+    },
+    "JobStepIdentity": {
+      "$schema": "https://json-schema.org/draft/2020-12/schema",
+      "type": "string",
+      "$anchor": "JobStepIdentity",
+      "pattern": "^JobStep-.+$"
+    },
+    "JobRun": {
+      "$schema": "https://json-schema.org/draft/2020-12/schema",
+      "type": "object",
+      "allOf": [
+        {
+          "$comment": "This will be overlayed dynamically to specify roleBindings corresponding to the roles of the underlying job.",
+          "$ref": "#/$defs/RoleBindingsFacet"
+        }
+      ],
+      "properties": {
+        "identity": {
+          "$ref": "#/$defs/JobRunIdentity"
+        },
+        "jobHandle": {
+          "$ref": "#/$defs/JobIdentity"
+        }
+      },
+      "required": [
+        "identity",
+        "jobHandle"
+      ],
+      "$anchor": "JobRun"
+    },
+    "Conditional": {
+      "$schema": "https://json-schema.org/draft/2020-12/schema",
+      "type": "object",
+      "properties": {
+        "what": {
+          "$ref": "#/$defs/JobStep"
+        },
+        "when": {
+          "$ref": "#/$defs/JobStep"
+        }
+      },
+      "required": [
+        "when",
+        "what"
+      ],
+      "unevaluatedProperties": false,
+      "$anchor": "Conditional"
+    },
+    "BranchStepIdentity": {
+      "$schema": "https://json-schema.org/draft/2020-12/schema",
+      "type": "string",
+      "$anchor": "BranchStepIdentity",
+      "pattern": "^BRANCHSTEP-.+$"
+    },
+    "WhileStepIdentity": {
+      "$schema": "https://json-schema.org/draft/2020-12/schema",
+      "type": "string",
+      "$anchor": "WhileStepIdentity",
+      "pattern": "^WHILESTEP-.+$"
+    },
+    "ForStepIdentity": {
+      "$schema": "https://json-schema.org/draft/2020-12/schema",
+      "type": "string",
+      "$anchor": "ForStepIdentity",
+      "pattern": "^FORSTEP-.+$"
+    },
+    "ShellMissing": {
+      "$schema": "https://json-schema.org/draft/2020-12/schema",
+      "type": "object",
+      "allOf": [
+        {
+          "$ref": "#/$defs/ResourceBase"
+        },
+        {
+          "$ref": "#/$defs/ResourceKindFacet"
+        }
+      ],
+      "properties": {
+        "resourceKind": {
+          "const": "missing"
+        }
+      },
+      "unevaluatedProperties": false,
+      "$anchor": "ShellMissing"
+    },
+    "ShellInputPotential": {
+      "$schema": "https://json-schema.org/draft/2020-12/schema",
+      "type": "object",
+      "allOf": [
+        {
+          "$ref": "#/$defs/ResourceBase"
+        },
+        {
+          "$ref": "#/$defs/CreationContextFacet"
+        },
+        {
+          "$ref": "#/$defs/ResourceKindFacet"
+        }
+      ],
+      "properties": {
+        "resourceKind": {
+          "const": "input-potential"
+        }
+      },
+      "unevaluatedProperties": false,
+      "$anchor": "ShellInputPotential"
+    },
+    "ShellOutputPotential": {
+      "$schema": "https://json-schema.org/draft/2020-12/schema",
+      "type": "object",
+      "allOf": [
+        {
+          "$ref": "#/$defs/ResourceBase"
+        },
+        {
+          "$ref": "#/$defs/CreationContextFacet"
+        },
+        {
+          "$ref": "#/$defs/ResourceKindFacet"
+        }
+      ],
+      "properties": {
+        "resourceKind": {
+          "const": "output-potential"
+        }
+      },
+      "unevaluatedProperties": false,
+      "$anchor": "ShellOutputPotential"
+    },
+    "ShellMaterializedBase": {
+      "$schema": "https://json-schema.org/draft/2020-12/schema",
+      "type": "object",
+      "allOf": [
+        {
+          "$ref": "#/$defs/ResourceBase"
+        },
+        {
+          "$ref": "#/$defs/CreationContextFacet"
+        },
+        {
+          "$ref": "#/$defs/ResourceKindFacet"
+        },
+        {
+          "$ref": "#/$defs/TimestampFacet"
+        },
+        {
+          "$ref": "#/$defs/PathFacet"
+        }
+      ],
+      "properties": {
+        "resourceKind": {
+          "const": "materialized"
+        },
+        "version": {
+          "const": 1
+        }
+      },
+      "required": [
+        "version"
+      ],
+      "$anchor": "ShellMaterializedBase"
+    },
+    "NucleusFacet": {
+      "$schema": "https://json-schema.org/draft/2020-12/schema",
+      "type": "object",
+      "properties": {
+        "nucleus": {
+          "$ref": "#/$defs/Nucleus"
+        }
+      },
+      "required": [
+        "nucleus"
+      ],
+      "$anchor": "NucleusFacet"
+    },
+    "StepKind": {
+      "$schema": "https://json-schema.org/draft/2020-12/schema",
+      "type": "string",
+      "$anchor": "StepKind",
+      "enum": [
+        "job",
+        "branch",
+        "while",
+        "for"
+      ]
+    },
+    "RoleBindingsFacet": {
+      "$schema": "https://json-schema.org/draft/2020-12/schema",
+      "type": "object",
+      "properties": {
+        "roleBindings": {
+          "$ref": "#/$defs/RoleBindings"
+        }
+      },
+      "required": [
+        "roleBindings"
+      ],
+      "$anchor": "RoleBindingsFacet"
+    },
+    "JobIdentity": {
+      "$schema": "https://json-schema.org/draft/2020-12/schema",
+      "type": "string",
+      "$anchor": "JobIdentity",
+      "pattern": "^JOB-.+$"
+    },
+    "ResourceBase": {
+      "$schema": "https://json-schema.org/draft/2020-12/schema",
+      "type": "object",
+      "properties": {
+        "identity": {
+          "$ref": "#/$defs/ResourceIdentity"
+        },
+        "resourceTypeHandle": {
+          "$ref": "#/$defs/ResourceTypeIdentity"
+        }
+      },
+      "required": [
+        "identity",
+        "resourceTypeHandle"
+      ],
+      "$anchor": "ResourceBase"
+    },
+    "ResourceKindFacet": {
+      "$schema": "https://json-schema.org/draft/2020-12/schema",
+      "type": "object",
+      "properties": {
+        "resourceKind": {
+          "$ref": "#/$defs/ResourceKind"
+        }
+      },
+      "required": [
+        "resourceKind"
+      ],
+      "$anchor": "ResourceKindFacet"
+    },
+    "CreationContextFacet": {
+      "$schema": "https://json-schema.org/draft/2020-12/schema",
+      "type": "object",
+      "properties": {
+        "creationContext": {
+          "$ref": "#/$defs/CreationContext"
+        }
+      },
+      "required": [
+        "creationContext"
+      ],
+      "$anchor": "CreationContextFacet"
+    },
+    "TimestampFacet": {
+      "$schema": "https://json-schema.org/draft/2020-12/schema",
+      "type": "object",
+      "properties": {
+        "timestamp": {
+          "$ref": "#/$defs/Timestamp"
+        }
+      },
+      "required": [
+        "timestamp"
+      ],
+      "$anchor": "TimestampFacet"
+    },
+    "PathFacet": {
+      "$schema": "https://json-schema.org/draft/2020-12/schema",
+      "type": "object",
+      "properties": {
+        "path": {
+          "$ref": "#/$defs/Path"
+        }
+      },
+      "required": [
+        "path"
+      ],
+      "$anchor": "PathFacet"
+    },
+    "Nucleus": {
+      "$schema": "https://json-schema.org/draft/2020-12/schema",
+      "type": "object",
+      "additionalProperties": {
+        "$ref": "#/$defs/JsonData"
+      },
+      "$anchor": "Nucleus"
+    },
+    "RoleBindings": {
+      "$schema": "https://json-schema.org/draft/2020-12/schema",
+      "type": "object",
+      "properties": {
+        "inputBindings": {
+          "$ref": "#/$defs/RoleBindingArray"
+        },
+        "outputBindings": {
+          "$ref": "#/$defs/RoleBindingArray"
+        }
+      },
+      "required": [
+        "inputBindings",
+        "outputBindings"
+      ],
+      "$anchor": "RoleBindings"
+    },
+    "ResourceIdentity": {
+      "$schema": "https://json-schema.org/draft/2020-12/schema",
+      "type": "string",
+      "$anchor": "ResourceIdentity",
+      "pattern": "^RESOURCE-.+$"
+    },
+    "ResourceTypeIdentity": {
+      "$schema": "https://json-schema.org/draft/2020-12/schema",
+      "type": "string",
+      "$anchor": "ResourceTypeIdentity",
+      "pattern": "^TYPE-.+$"
+    },
+    "ResourceKind": {
+      "$schema": "https://json-schema.org/draft/2020-12/schema",
+      "type": "string",
+      "$anchor": "ResourceKind",
+      "enum": [
+        "missing",
+        "input-potential",
+        "output-potential",
+        "materialized"
+      ]
+    },
+    "CreationContext": {
+      "$schema": "https://json-schema.org/draft/2020-12/schema",
+      "type": "object",
+      "properties": {
+        "jobRunHandle": {
+          "$ref": "#/$defs/JobRunIdentity"
+        },
+        "resourceRoleHandle": {
+          "$ref": "#/$defs/ResourceRoleIdentity"
+        }
+      },
+      "required": [
+        "resourceRoleHandle",
+        "jobRunHandle"
+      ],
+      "$anchor": "CreationContext"
+    },
+    "Path": {
+      "$schema": "https://json-schema.org/draft/2020-12/schema",
+      "type": "string",
+      "$anchor": "Path",
+      "format": "uri-reference"
+    },
+    "JsonData": {
+      "$schema": "https://json-schema.org/draft/2020-12/schema",
+      "oneOf": [
+        {
+          "type": "null"
+        },
+        {
+          "type": "boolean"
+        },
+        {
+          "type": "number"
+        },
+        {
+          "type": "string"
+        },
+        {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/JsonData"
+          }
+        },
+        {
+          "type": "object",
+          "additionalProperties": {
+            "$ref": "#/$defs/JsonData"
+          }
+        }
+      ],
+      "$anchor": "JsonData"
+    },
+    "RoleBindingArray": {
+      "$schema": "https://json-schema.org/draft/2020-12/schema",
+      "type": "array",
+      "$anchor": "RoleBindingArray",
+      "items": {
+        "$ref": "#/$defs/ResourceRoleIdentity"
+      }
+    }
+  }
+}