@toolproof-core/schema 1.0.2 → 1.0.3

package/dist/generated/schemas/standalone/RunnableStrategy.json

@@ -0,0 +1,712 @@
+{
+    "$anchor": "RunnableStrategy",
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "type": "object",
+    "required": [
+        "identity",
+        "runnableStrategyContext"
+    ],
+    "properties": {
+        "identity": {
+            "$ref": "#/$defs/RunnableStrategyIdentity"
+        },
+        "runnableStrategyContext": {
+            "$ref": "#/$defs/RunnableStrategyContext"
+        }
+    },
+    "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"
+        }
+    ],
+    "unevaluatedProperties": false,
+    "$defs": {
+        "RunnableStrategyIdentity": {
+            "$anchor": "RunnableStrategyIdentity",
+            "$schema": "https://json-schema.org/draft/2020-12/schema",
+            "type": "string",
+            "pattern": "^RUNNABLE_STRATEGY-.+$"
+        },
+        "RunnableStrategyContext": {
+            "$anchor": "RunnableStrategyContext",
+            "$schema": "https://json-schema.org/draft/2020-12/schema",
+            "type": "object",
+            "required": [
+                "status"
+            ],
+            "properties": {
+                "status": {
+                    "$ref": "#/$defs/RunnableStrategyStatus"
+                },
+                "startedAt": {
+                    "$ref": "#/$defs/Timestamp"
+                },
+                "completedAt": {
+                    "$ref": "#/$defs/Timestamp"
+                }
+            },
+            "unevaluatedProperties": false
+        },
+        "StrategyThreadMapFacet": {
+            "$anchor": "StrategyThreadMapFacet",
+            "$schema": "https://json-schema.org/draft/2020-12/schema",
+            "type": "object",
+            "required": [
+                "strategyThreadMap"
+            ],
+            "properties": {
+                "strategyThreadMap": {
+                    "$ref": "#/$defs/StrategyThreadMap"
+                }
+            }
+        },
+        "StrategyStateFacet": {
+            "$anchor": "StrategyStateFacet",
+            "$schema": "https://json-schema.org/draft/2020-12/schema",
+            "type": "object",
+            "required": [
+                "strategyState"
+            ],
+            "properties": {
+                "strategyState": {
+                    "$ref": "#/$defs/StrategyState"
+                }
+            }
+        },
+        "RunnableStrategyStatus": {
+            "$anchor": "RunnableStrategyStatus",
+            "$schema": "https://json-schema.org/draft/2020-12/schema",
+            "type": "string",
+            "enum": [
+                "pending",
+                "running",
+                "completed",
+                "failed",
+                "cancelled"
+            ]
+        },
+        "Timestamp": {
+            "$anchor": "Timestamp",
+            "$schema": "https://json-schema.org/draft/2020-12/schema",
+            "type": "string",
+            "format": "date-time"
+        },
+        "StrategyThreadMap": {
+            "$anchor": "StrategyThreadMap",
+            "$schema": "https://json-schema.org/draft/2020-12/schema",
+            "type": "object",
+            "propertyNames": {
+                "$ref": "#/$defs/StrategyThreadIdentity"
+            },
+            "additionalProperties": {
+                "$ref": "#/$defs/StepArray"
+            },
+            "$comment": "Each thread contains an array of steps, allowing for sequential execution within a thread while supporting parallel execution across multiple threads."
+        },
+        "StrategyState": {
+            "$anchor": "StrategyState",
+            "$schema": "https://json-schema.org/draft/2020-12/schema",
+            "type": "object",
+            "propertyNames": {
+                "$ref": "#/$defs/JobStepIdentity"
+            },
+            "additionalProperties": {
+                "$ref": "#/$defs/JobStepSocket"
+            }
+        },
+        "StrategyThreadIdentity": {
+            "$anchor": "StrategyThreadIdentity",
+            "$schema": "https://json-schema.org/draft/2020-12/schema",
+            "type": "string",
+            "pattern": "^STRATEGY_THREAD-.+$"
+        },
+        "StepArray": {
+            "$anchor": "StepArray",
+            "$schema": "https://json-schema.org/draft/2020-12/schema",
+            "type": "array",
+            "items": {
+                "$ref": "#/$defs/Step"
+            },
+            "uniqueItems": true
+        },
+        "JobStepIdentity": {
+            "$anchor": "JobStepIdentity",
+            "$schema": "https://json-schema.org/draft/2020-12/schema",
+            "type": "string",
+            "pattern": "^JOB_STEP-.+$"
+        },
+        "JobStepSocket": {
+            "$anchor": "JobStepSocket",
+            "$schema": "https://json-schema.org/draft/2020-12/schema",
+            "type": "object",
+            "propertyNames": {
+                "$ref": "#/$defs/ResourceRoleIdentity"
+            },
+            "additionalProperties": {
+                "$ref": "#/$defs/Resource"
+            }
+        },
+        "Step": {
+            "$anchor": "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
+        },
+        "ResourceRoleIdentity": {
+            "$anchor": "ResourceRoleIdentity",
+            "$schema": "https://json-schema.org/draft/2020-12/schema",
+            "type": "string",
+            "pattern": "^ROLE-.+$"
+        },
+        "Resource": {
+            "$anchor": "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
+        },
+        "JobStep": {
+            "$anchor": "JobStep",
+            "$schema": "https://json-schema.org/draft/2020-12/schema",
+            "type": "object",
+            "required": [
+                "identity",
+                "jobHandle"
+            ],
+            "properties": {
+                "identity": {
+                    "$ref": "#/$defs/JobStepIdentity"
+                },
+                "stepKind": {
+                    "const": "job"
+                },
+                "jobHandle": {
+                    "$ref": "#/$defs/JobIdentity"
+                }
+            },
+            "allOf": [
+                {
+                    "$ref": "#/$defs/StepKindFacet"
+                },
+                {
+                    "$comment": "This will be overlayed dynamically to specify roleBindings corresponding to the roles of the underlying job.",
+                    "$ref": "#/$defs/RoleBindingsFacet"
+                }
+            ]
+        },
+        "BranchStep": {
+            "$anchor": "BranchStep",
+            "$schema": "https://json-schema.org/draft/2020-12/schema",
+            "type": "object",
+            "required": [
+                "identity",
+                "cases"
+            ],
+            "properties": {
+                "identity": {
+                    "$ref": "#/$defs/BranchStepIdentity"
+                },
+                "stepKind": {
+                    "const": "branch"
+                },
+                "cases": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/$defs/Conditional"
+                    },
+                    "minItems": 1,
+                    "uniqueItems": true
+                }
+            },
+            "allOf": [
+                {
+                    "$ref": "#/$defs/StepKindFacet"
+                }
+            ]
+        },
+        "WhileStep": {
+            "$anchor": "WhileStep",
+            "$schema": "https://json-schema.org/draft/2020-12/schema",
+            "type": "object",
+            "required": [
+                "identity",
+                "case"
+            ],
+            "properties": {
+                "identity": {
+                    "$ref": "#/$defs/WhileStepIdentity"
+                },
+                "stepKind": {
+                    "const": "while"
+                },
+                "case": {
+                    "$ref": "#/$defs/Conditional"
+                }
+            },
+            "allOf": [
+                {
+                    "$ref": "#/$defs/StepKindFacet"
+                }
+            ]
+        },
+        "ForStep": {
+            "$anchor": "ForStep",
+            "$schema": "https://json-schema.org/draft/2020-12/schema",
+            "type": "object",
+            "required": [
+                "identity",
+                "case"
+            ],
+            "properties": {
+                "identity": {
+                    "$ref": "#/$defs/ForStepIdentity"
+                },
+                "stepKind": {
+                    "const": "for"
+                },
+                "case": {
+                    "$ref": "#/$defs/Conditional"
+                }
+            },
+            "allOf": [
+                {
+                    "$ref": "#/$defs/StepKindFacet"
+                }
+            ]
+        },
+        "ResourceMissing": {
+            "$anchor": "ResourceMissing",
+            "$schema": "https://json-schema.org/draft/2020-12/schema",
+            "type": "object",
+            "$ref": "#/$defs/ShellMissing",
+            "unevaluatedProperties": false
+        },
+        "ResourceInputPotential": {
+            "$anchor": "ResourceInputPotential",
+            "$schema": "https://json-schema.org/draft/2020-12/schema",
+            "type": "object",
+            "$ref": "#/$defs/ShellInputPotential",
+            "unevaluatedProperties": false
+        },
+        "ResourceOutputPotential": {
+            "$anchor": "ResourceOutputPotential",
+            "$schema": "https://json-schema.org/draft/2020-12/schema",
+            "type": "object",
+            "$ref": "#/$defs/ShellOutputPotential",
+            "unevaluatedProperties": false
+        },
+        "ResourceMaterialized": {
+            "$anchor": "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
+        },
+        "JobIdentity": {
+            "$anchor": "JobIdentity",
+            "$schema": "https://json-schema.org/draft/2020-12/schema",
+            "type": "string",
+            "pattern": "^JOB-.+$"
+        },
+        "StepKindFacet": {
+            "$anchor": "StepKindFacet",
+            "$schema": "https://json-schema.org/draft/2020-12/schema",
+            "type": "object",
+            "required": [
+                "stepKind"
+            ],
+            "properties": {
+                "stepKind": {
+                    "$ref": "#/$defs/StepKind"
+                }
+            }
+        },
+        "RoleBindingsFacet": {
+            "$anchor": "RoleBindingsFacet",
+            "$schema": "https://json-schema.org/draft/2020-12/schema",
+            "type": "object",
+            "required": [
+                "roleBindings"
+            ],
+            "properties": {
+                "roleBindings": {
+                    "$ref": "#/$defs/RoleBindings"
+                }
+            }
+        },
+        "BranchStepIdentity": {
+            "$anchor": "BranchStepIdentity",
+            "$schema": "https://json-schema.org/draft/2020-12/schema",
+            "type": "string",
+            "pattern": "^BRANCH_STEP-.+$"
+        },
+        "Conditional": {
+            "$anchor": "Conditional",
+            "$schema": "https://json-schema.org/draft/2020-12/schema",
+            "type": "object",
+            "required": [
+                "when",
+                "what"
+            ],
+            "properties": {
+                "when": {
+                    "$ref": "#/$defs/JobStep"
+                },
+                "what": {
+                    "$ref": "#/$defs/JobStep"
+                }
+            },
+            "unevaluatedProperties": false
+        },
+        "WhileStepIdentity": {
+            "$anchor": "WhileStepIdentity",
+            "$schema": "https://json-schema.org/draft/2020-12/schema",
+            "type": "string",
+            "pattern": "^WHILE_STEP-.+$"
+        },
+        "ForStepIdentity": {
+            "$anchor": "ForStepIdentity",
+            "$schema": "https://json-schema.org/draft/2020-12/schema",
+            "type": "string",
+            "pattern": "^FOR_STEP-.+$"
+        },
+        "ShellMissing": {
+            "$anchor": "ShellMissing",
+            "$schema": "https://json-schema.org/draft/2020-12/schema",
+            "type": "object",
+            "properties": {
+                "resourceKind": {
+                    "const": "missing"
+                }
+            },
+            "allOf": [
+                {
+                    "$ref": "#/$defs/ResourceBase"
+                },
+                {
+                    "$ref": "#/$defs/ResourceKindFacet"
+                }
+            ],
+            "unevaluatedProperties": false
+        },
+        "ShellInputPotential": {
+            "$anchor": "ShellInputPotential",
+            "$schema": "https://json-schema.org/draft/2020-12/schema",
+            "type": "object",
+            "properties": {
+                "resourceKind": {
+                    "const": "input-potential"
+                }
+            },
+            "allOf": [
+                {
+                    "$ref": "#/$defs/ResourceBase"
+                },
+                {
+                    "$ref": "#/$defs/CreationContextFacet"
+                },
+                {
+                    "$ref": "#/$defs/ResourceKindFacet"
+                }
+            ],
+            "unevaluatedProperties": false
+        },
+        "ShellOutputPotential": {
+            "$anchor": "ShellOutputPotential",
+            "$schema": "https://json-schema.org/draft/2020-12/schema",
+            "type": "object",
+            "properties": {
+                "resourceKind": {
+                    "const": "output-potential"
+                }
+            },
+            "allOf": [
+                {
+                    "$ref": "#/$defs/ResourceBase"
+                },
+                {
+                    "$ref": "#/$defs/CreationContextFacet"
+                },
+                {
+                    "$ref": "#/$defs/ResourceKindFacet"
+                }
+            ],
+            "unevaluatedProperties": false
+        },
+        "ShellMaterializedBase": {
+            "$anchor": "ShellMaterializedBase",
+            "$schema": "https://json-schema.org/draft/2020-12/schema",
+            "type": "object",
+            "required": [
+                "version"
+            ],
+            "properties": {
+                "version": {
+                    "const": 1
+                },
+                "resourceKind": {
+                    "const": "materialized"
+                }
+            },
+            "allOf": [
+                {
+                    "$ref": "#/$defs/ResourceBase"
+                },
+                {
+                    "$ref": "#/$defs/CreationContextFacet"
+                },
+                {
+                    "$ref": "#/$defs/ResourceKindFacet"
+                },
+                {
+                    "$ref": "#/$defs/TimestampFacet"
+                },
+                {
+                    "$ref": "#/$defs/PathFacet"
+                }
+            ]
+        },
+        "NucleusFacet": {
+            "$anchor": "NucleusFacet",
+            "$schema": "https://json-schema.org/draft/2020-12/schema",
+            "type": "object",
+            "required": [
+                "nucleus"
+            ],
+            "properties": {
+                "nucleus": {
+                    "$ref": "#/$defs/Nucleus"
+                }
+            }
+        },
+        "StepKind": {
+            "$anchor": "StepKind",
+            "$schema": "https://json-schema.org/draft/2020-12/schema",
+            "type": "string",
+            "enum": [
+                "job",
+                "branch",
+                "while",
+                "for"
+            ]
+        },
+        "RoleBindings": {
+            "$anchor": "RoleBindings",
+            "$schema": "https://json-schema.org/draft/2020-12/schema",
+            "type": "object",
+            "required": [
+                "inputBindings",
+                "outputBindings"
+            ],
+            "properties": {
+                "inputBindings": {
+                    "$ref": "#/$defs/RoleBindingArray"
+                },
+                "outputBindings": {
+                    "$ref": "#/$defs/RoleBindingArray"
+                }
+            }
+        },
+        "ResourceBase": {
+            "$anchor": "ResourceBase",
+            "$schema": "https://json-schema.org/draft/2020-12/schema",
+            "type": "object",
+            "required": [
+                "identity",
+                "resourceTypeHandle"
+            ],
+            "properties": {
+                "identity": {
+                    "$ref": "#/$defs/ResourceIdentity"
+                },
+                "resourceTypeHandle": {
+                    "$ref": "#/$defs/ResourceTypeIdentity"
+                }
+            }
+        },
+        "ResourceKindFacet": {
+            "$anchor": "ResourceKindFacet",
+            "$schema": "https://json-schema.org/draft/2020-12/schema",
+            "type": "object",
+            "required": [
+                "resourceKind"
+            ],
+            "properties": {
+                "resourceKind": {
+                    "$ref": "#/$defs/ResourceKind"
+                }
+            }
+        },
+        "CreationContextFacet": {
+            "$anchor": "CreationContextFacet",
+            "$schema": "https://json-schema.org/draft/2020-12/schema",
+            "type": "object",
+            "required": [
+                "creationContext"
+            ],
+            "properties": {
+                "creationContext": {
+                    "$ref": "#/$defs/CreationContext"
+                }
+            }
+        },
+        "TimestampFacet": {
+            "$anchor": "TimestampFacet",
+            "$schema": "https://json-schema.org/draft/2020-12/schema",
+            "type": "object",
+            "required": [
+                "timestamp"
+            ],
+            "properties": {
+                "timestamp": {
+                    "$ref": "#/$defs/Timestamp"
+                }
+            }
+        },
+        "PathFacet": {
+            "$anchor": "PathFacet",
+            "$schema": "https://json-schema.org/draft/2020-12/schema",
+            "type": "object",
+            "required": [
+                "path"
+            ],
+            "properties": {
+                "path": {
+                    "$ref": "#/$defs/Path"
+                }
+            }
+        },
+        "Nucleus": {
+            "$anchor": "Nucleus",
+            "$schema": "https://json-schema.org/draft/2020-12/schema",
+            "type": "object",
+            "additionalProperties": {
+                "$ref": "#/$defs/JsonData"
+            }
+        },
+        "RoleBindingArray": {
+            "$anchor": "RoleBindingArray",
+            "$schema": "https://json-schema.org/draft/2020-12/schema",
+            "type": "array",
+            "items": {
+                "$ref": "#/$defs/ResourceRoleIdentity"
+            }
+        },
+        "ResourceIdentity": {
+            "$anchor": "ResourceIdentity",
+            "$schema": "https://json-schema.org/draft/2020-12/schema",
+            "type": "string",
+            "pattern": "^RESOURCE-.+$"
+        },
+        "ResourceTypeIdentity": {
+            "$anchor": "ResourceTypeIdentity",
+            "$schema": "https://json-schema.org/draft/2020-12/schema",
+            "type": "string",
+            "pattern": "^TYPE-.+$"
+        },
+        "ResourceKind": {
+            "$anchor": "ResourceKind",
+            "$schema": "https://json-schema.org/draft/2020-12/schema",
+            "type": "string",
+            "enum": [
+                "missing",
+                "input-potential",
+                "output-potential",
+                "materialized"
+            ]
+        },
+        "CreationContext": {
+            "$anchor": "CreationContext",
+            "$schema": "https://json-schema.org/draft/2020-12/schema",
+            "type": "object",
+            "required": [
+                "resourceRoleHandle",
+                "jobStepHandle"
+            ],
+            "properties": {
+                "resourceRoleHandle": {
+                    "$ref": "#/$defs/ResourceRoleIdentity"
+                },
+                "jobStepHandle": {
+                    "$ref": "#/$defs/JobStepIdentity"
+                }
+            }
+        },
+        "Path": {
+            "$anchor": "Path",
+            "$schema": "https://json-schema.org/draft/2020-12/schema",
+            "type": "string",
+            "format": "uri-reference"
+        },
+        "JsonData": {
+            "$anchor": "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"
+                    }
+                }
+            ]
+        }
+    }
+}