@mat3ra/esse 2024.3.25-2 → 2024.3.25-4

package/dist/js/schema/workflow/unit/base.json

@@ -0,0 +1,264 @@
+{
+    "$id": "workflow/unit/base",
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "title": "workflow base unit schema",
+    "type": "object",
+    "required": [
+        "type",
+        "flowchartId"
+    ],
+    "additionalProperties": true,
+    "properties": {
+        "_id": {
+            "type": "string",
+            "description": "entity identity"
+        },
+        "isDraft": {
+            "type": "boolean"
+        },
+        "type": {
+            "description": "type of the unit",
+            "type": "string"
+        },
+        "name": {
+            "description": "name of the unit. e.g. pw_scf",
+            "type": "string"
+        },
+        "status": {
+            "description": "Status of the unit.",
+            "type": "string",
+            "enum": [
+                "idle",
+                "active",
+                "warning",
+                "error",
+                "finished"
+            ]
+        },
+        "head": {
+            "description": "Whether this unit is the first one to be executed.",
+            "type": "boolean"
+        },
+        "flowchartId": {
+            "description": "Identity of the unit in the workflow. Used to trace the execution flow of the workflow.",
+            "type": "string"
+        },
+        "next": {
+            "description": "Next unit's flowchartId. If empty, the current unit is the last.",
+            "type": "string"
+        },
+        "enableRender": {
+            "description": "Whether Rupy should attempt to use Jinja templating to add context variables into the unit",
+            "type": "boolean"
+        },
+        "context": {
+            "type": "object"
+        },
+        "slug": {
+            "description": "entity slug",
+            "type": "string"
+        },
+        "systemName": {
+            "type": "string"
+        },
+        "consistencyChecks": {
+            "type": "array",
+            "items": {
+                "$schema": "http://json-schema.org/draft-07/schema#",
+                "title": "consistency check",
+                "type": "object",
+                "description": "The output of consistency checks performed on data adhering to JSON schema, but inconsistent with scientific or logical rules, to show problems in UI.",
+                "required": [
+                    "key",
+                    "name",
+                    "severity",
+                    "message"
+                ],
+                "properties": {
+                    "key": {
+                        "type": "string",
+                        "description": "Key of the property of the entity on which the consistency check is performed in Mongo dot notation, e.g. 'basis.coordinates.1'"
+                    },
+                    "name": {
+                        "enum": [
+                            "default",
+                            "atomsTooClose",
+                            "atomsOverlap"
+                        ],
+                        "description": "Name of the consistency check that is performed, which is listed in an enum."
+                    },
+                    "severity": {
+                        "enum": [
+                            "info",
+                            "warning",
+                            "error"
+                        ],
+                        "description": "Severity level of the problem, which is used in UI to differentiate."
+                    },
+                    "message": {
+                        "type": "string",
+                        "description": "Message generated by the consistency check describing the problem."
+                    }
+                }
+            }
+        },
+        "schemaVersion": {
+            "description": "entity's schema version. Used to distinct between different schemas.",
+            "type": "string",
+            "default": "2022.8.16"
+        },
+        "isDefault": {
+            "description": "Identifies that entity is defaultable",
+            "type": "boolean",
+            "default": false
+        },
+        "preProcessors": {
+            "description": "names of the pre-processors for this calculation",
+            "type": "array",
+            "items": {
+                "$schema": "http://json-schema.org/draft-07/schema#",
+                "title": "runtime item schema",
+                "oneOf": [
+                    {
+                        "$schema": "http://json-schema.org/draft-07/schema#",
+                        "title": "name result schema",
+                        "type": "object",
+                        "properties": {
+                            "name": {
+                                "description": "The name of this item. e.g. scf_accuracy",
+                                "type": "string"
+                            }
+                        },
+                        "required": [
+                            "name"
+                        ]
+                    },
+                    {
+                        "$schema": "http://json-schema.org/draft-07/schema#",
+                        "title": "RuntimeItemString",
+                        "description": "name of runtime item in shortened notation",
+                        "type": "string"
+                    }
+                ]
+            }
+        },
+        "postProcessors": {
+            "description": "names of the post-processors for this calculation",
+            "type": "array",
+            "items": {
+                "$schema": "http://json-schema.org/draft-07/schema#",
+                "title": "runtime item schema",
+                "oneOf": [
+                    {
+                        "$schema": "http://json-schema.org/draft-07/schema#",
+                        "title": "name result schema",
+                        "type": "object",
+                        "properties": {
+                            "name": {
+                                "description": "The name of this item. e.g. scf_accuracy",
+                                "type": "string"
+                            }
+                        },
+                        "required": [
+                            "name"
+                        ]
+                    },
+                    {
+                        "$schema": "http://json-schema.org/draft-07/schema#",
+                        "title": "RuntimeItemString",
+                        "description": "name of runtime item in shortened notation",
+                        "type": "string"
+                    }
+                ]
+            }
+        },
+        "monitors": {
+            "description": "names of the monitors for this calculation",
+            "type": "array",
+            "items": {
+                "$schema": "http://json-schema.org/draft-07/schema#",
+                "title": "runtime item schema",
+                "oneOf": [
+                    {
+                        "$schema": "http://json-schema.org/draft-07/schema#",
+                        "title": "name result schema",
+                        "type": "object",
+                        "properties": {
+                            "name": {
+                                "description": "The name of this item. e.g. scf_accuracy",
+                                "type": "string"
+                            }
+                        },
+                        "required": [
+                            "name"
+                        ]
+                    },
+                    {
+                        "$schema": "http://json-schema.org/draft-07/schema#",
+                        "title": "RuntimeItemString",
+                        "description": "name of runtime item in shortened notation",
+                        "type": "string"
+                    }
+                ]
+            }
+        },
+        "results": {
+            "description": "names of the results for this calculation",
+            "type": "array",
+            "items": {
+                "$schema": "http://json-schema.org/draft-07/schema#",
+                "title": "runtime item schema",
+                "oneOf": [
+                    {
+                        "$schema": "http://json-schema.org/draft-07/schema#",
+                        "title": "name result schema",
+                        "type": "object",
+                        "properties": {
+                            "name": {
+                                "description": "The name of this item. e.g. scf_accuracy",
+                                "type": "string"
+                            }
+                        },
+                        "required": [
+                            "name"
+                        ]
+                    },
+                    {
+                        "$schema": "http://json-schema.org/draft-07/schema#",
+                        "title": "RuntimeItemString",
+                        "description": "name of runtime item in shortened notation",
+                        "type": "string"
+                    }
+                ]
+            }
+        },
+        "tags": {
+            "description": "entity tags",
+            "type": "array",
+            "items": {
+                "type": "string"
+            }
+        },
+        "statusTrack": {
+            "type": "array",
+            "items": {
+                "type": "object",
+                "required": [
+                    "trackedAt",
+                    "status"
+                ],
+                "properties": {
+                    "trackedAt": {
+                        "type": "number"
+                    },
+                    "status": {
+                        "type": "string"
+                    },
+                    "repetition": {
+                        "type": "number"
+                    }
+                }
+            }
+        }
+    }
+}

package/dist/js/schema/workflow/unit/condition.json

@@ -0,0 +1,315 @@
+{
+    "$id": "workflow/unit/condition",
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "title": "condition unit schema",
+    "type": "object",
+    "required": [
+        "else",
+        "flowchartId",
+        "input",
+        "maxOccurrences",
+        "statement",
+        "then",
+        "type"
+    ],
+    "additionalProperties": true,
+    "properties": {
+        "type": {
+            "enum": [
+                "condition"
+            ],
+            "description": "type of the unit",
+            "type": "string"
+        },
+        "input": {
+            "description": "Input information for condition.",
+            "type": "array",
+            "items": {
+                "$schema": "http://json-schema.org/draft-07/schema#",
+                "title": "workflow unit input schema",
+                "type": "object",
+                "required": [
+                    "scope",
+                    "name"
+                ],
+                "properties": {
+                    "scope": {
+                        "description": "Scope of the variable. e.g. 'global' or 'flowchart_id_2'",
+                        "type": "string"
+                    },
+                    "name": {
+                        "description": "Name of the input data. e.g. total_energy",
+                        "type": "string"
+                    }
+                }
+            }
+        },
+        "statement": {
+            "description": "Condition statement. e.g. 'abs(x-total_energy) < 1e-5'",
+            "type": "string"
+        },
+        "then": {
+            "description": "Flowchart ID reference for `then` part of the condition.",
+            "type": "string"
+        },
+        "else": {
+            "description": "Flowchart ID reference for `else` part of the condition.",
+            "type": "string"
+        },
+        "maxOccurrences": {
+            "description": "Maximum occurrence of the condition, usable for loops.",
+            "type": "integer"
+        },
+        "throwException": {
+            "description": "Throw exception on reaching to maximum occurence.",
+            "type": "boolean"
+        },
+        "_id": {
+            "type": "string",
+            "description": "entity identity"
+        },
+        "isDraft": {
+            "type": "boolean"
+        },
+        "name": {
+            "description": "name of the unit. e.g. pw_scf",
+            "type": "string"
+        },
+        "status": {
+            "description": "Status of the unit.",
+            "type": "string",
+            "enum": [
+                "idle",
+                "active",
+                "warning",
+                "error",
+                "finished"
+            ]
+        },
+        "head": {
+            "description": "Whether this unit is the first one to be executed.",
+            "type": "boolean"
+        },
+        "flowchartId": {
+            "description": "Identity of the unit in the workflow. Used to trace the execution flow of the workflow.",
+            "type": "string"
+        },
+        "next": {
+            "description": "Next unit's flowchartId. If empty, the current unit is the last.",
+            "type": "string"
+        },
+        "enableRender": {
+            "description": "Whether Rupy should attempt to use Jinja templating to add context variables into the unit",
+            "type": "boolean"
+        },
+        "context": {
+            "type": "object"
+        },
+        "slug": {
+            "description": "entity slug",
+            "type": "string"
+        },
+        "systemName": {
+            "type": "string"
+        },
+        "consistencyChecks": {
+            "type": "array",
+            "items": {
+                "$schema": "http://json-schema.org/draft-07/schema#",
+                "title": "consistency check",
+                "type": "object",
+                "description": "The output of consistency checks performed on data adhering to JSON schema, but inconsistent with scientific or logical rules, to show problems in UI.",
+                "required": [
+                    "key",
+                    "name",
+                    "severity",
+                    "message"
+                ],
+                "properties": {
+                    "key": {
+                        "type": "string",
+                        "description": "Key of the property of the entity on which the consistency check is performed in Mongo dot notation, e.g. 'basis.coordinates.1'"
+                    },
+                    "name": {
+                        "enum": [
+                            "default",
+                            "atomsTooClose",
+                            "atomsOverlap"
+                        ],
+                        "description": "Name of the consistency check that is performed, which is listed in an enum."
+                    },
+                    "severity": {
+                        "enum": [
+                            "info",
+                            "warning",
+                            "error"
+                        ],
+                        "description": "Severity level of the problem, which is used in UI to differentiate."
+                    },
+                    "message": {
+                        "type": "string",
+                        "description": "Message generated by the consistency check describing the problem."
+                    }
+                }
+            }
+        },
+        "schemaVersion": {
+            "description": "entity's schema version. Used to distinct between different schemas.",
+            "type": "string",
+            "default": "2022.8.16"
+        },
+        "isDefault": {
+            "description": "Identifies that entity is defaultable",
+            "type": "boolean",
+            "default": false
+        },
+        "preProcessors": {
+            "description": "names of the pre-processors for this calculation",
+            "type": "array",
+            "items": {
+                "$schema": "http://json-schema.org/draft-07/schema#",
+                "title": "runtime item schema",
+                "oneOf": [
+                    {
+                        "$schema": "http://json-schema.org/draft-07/schema#",
+                        "title": "name result schema",
+                        "type": "object",
+                        "properties": {
+                            "name": {
+                                "description": "The name of this item. e.g. scf_accuracy",
+                                "type": "string"
+                            }
+                        },
+                        "required": [
+                            "name"
+                        ]
+                    },
+                    {
+                        "$schema": "http://json-schema.org/draft-07/schema#",
+                        "title": "RuntimeItemString",
+                        "description": "name of runtime item in shortened notation",
+                        "type": "string"
+                    }
+                ]
+            }
+        },
+        "postProcessors": {
+            "description": "names of the post-processors for this calculation",
+            "type": "array",
+            "items": {
+                "$schema": "http://json-schema.org/draft-07/schema#",
+                "title": "runtime item schema",
+                "oneOf": [
+                    {
+                        "$schema": "http://json-schema.org/draft-07/schema#",
+                        "title": "name result schema",
+                        "type": "object",
+                        "properties": {
+                            "name": {
+                                "description": "The name of this item. e.g. scf_accuracy",
+                                "type": "string"
+                            }
+                        },
+                        "required": [
+                            "name"
+                        ]
+                    },
+                    {
+                        "$schema": "http://json-schema.org/draft-07/schema#",
+                        "title": "RuntimeItemString",
+                        "description": "name of runtime item in shortened notation",
+                        "type": "string"
+                    }
+                ]
+            }
+        },
+        "monitors": {
+            "description": "names of the monitors for this calculation",
+            "type": "array",
+            "items": {
+                "$schema": "http://json-schema.org/draft-07/schema#",
+                "title": "runtime item schema",
+                "oneOf": [
+                    {
+                        "$schema": "http://json-schema.org/draft-07/schema#",
+                        "title": "name result schema",
+                        "type": "object",
+                        "properties": {
+                            "name": {
+                                "description": "The name of this item. e.g. scf_accuracy",
+                                "type": "string"
+                            }
+                        },
+                        "required": [
+                            "name"
+                        ]
+                    },
+                    {
+                        "$schema": "http://json-schema.org/draft-07/schema#",
+                        "title": "RuntimeItemString",
+                        "description": "name of runtime item in shortened notation",
+                        "type": "string"
+                    }
+                ]
+            }
+        },
+        "results": {
+            "description": "names of the results for this calculation",
+            "type": "array",
+            "items": {
+                "$schema": "http://json-schema.org/draft-07/schema#",
+                "title": "runtime item schema",
+                "oneOf": [
+                    {
+                        "$schema": "http://json-schema.org/draft-07/schema#",
+                        "title": "name result schema",
+                        "type": "object",
+                        "properties": {
+                            "name": {
+                                "description": "The name of this item. e.g. scf_accuracy",
+                                "type": "string"
+                            }
+                        },
+                        "required": [
+                            "name"
+                        ]
+                    },
+                    {
+                        "$schema": "http://json-schema.org/draft-07/schema#",
+                        "title": "RuntimeItemString",
+                        "description": "name of runtime item in shortened notation",
+                        "type": "string"
+                    }
+                ]
+            }
+        },
+        "tags": {
+            "description": "entity tags",
+            "type": "array",
+            "items": {
+                "type": "string"
+            }
+        },
+        "statusTrack": {
+            "type": "array",
+            "items": {
+                "type": "object",
+                "required": [
+                    "trackedAt",
+                    "status"
+                ],
+                "properties": {
+                    "trackedAt": {
+                        "type": "number"
+                    },
+                    "status": {
+                        "type": "string"
+                    },
+                    "repetition": {
+                        "type": "number"
+                    }
+                }
+            }
+        }
+    }
+}