@mat3ra/esse 2026.5.18-2 → 2026.5.27-0

package/dist/js/schema/workflow/unit/mixins/io.json

@@ -0,0 +1,131 @@
+{
+    "$id": "workflow/unit/mixins/io",
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "title": "data IO unit mixin schema",
+    "type": "object",
+    "required": [
+        "subtype",
+        "source",
+        "input"
+    ],
+    "properties": {
+        "type": {
+            "const": "io"
+        },
+        "subtype": {
+            "enum": [
+                "input",
+                "output",
+                "dataFrame"
+            ]
+        },
+        "source": {
+            "enum": [
+                "api",
+                "object_storage"
+            ]
+        },
+        "input": {
+            "type": "array",
+            "items": {
+                "type": "object",
+                "oneOf": [
+                    {
+                        "$schema": "http://json-schema.org/draft-07/schema#",
+                        "title": "data IO rest API input schema",
+                        "type": "object",
+                        "properties": {
+                            "type": {
+                                "type": "string",
+                                "const": "api"
+                            },
+                            "endpoint": {
+                                "description": "rest API endpoint",
+                                "type": "string"
+                            },
+                            "endpoint_options": {
+                                "description": "rest API endpoint options",
+                                "type": "object"
+                            },
+                            "name": {
+                                "description": "the name of the variable in local scope to save the data under",
+                                "type": "string"
+                            }
+                        },
+                        "required": [
+                            "type",
+                            "endpoint",
+                            "endpoint_options"
+                        ]
+                    },
+                    {
+                        "$schema": "http://json-schema.org/draft-07/schema#",
+                        "title": "object_storage io schema",
+                        "type": "object",
+                        "required": [
+                            "type",
+                            "objectData"
+                        ],
+                        "properties": {
+                            "type": {
+                                "type": "string",
+                                "const": "object_storage"
+                            },
+                            "objectData": {
+                                "$schema": "http://json-schema.org/draft-07/schema#",
+                                "title": "Object Storage Container Data",
+                                "type": "object",
+                                "properties": {
+                                    "CONTAINER": {
+                                        "description": "Object storage container for the file",
+                                        "type": "string"
+                                    },
+                                    "NAME": {
+                                        "description": "Name of the file inside the object storage bucket",
+                                        "type": "string"
+                                    },
+                                    "PROVIDER": {
+                                        "description": "Object storage provider",
+                                        "type": "string"
+                                    },
+                                    "REGION": {
+                                        "description": "Region for the object container specified in Container",
+                                        "type": "string"
+                                    },
+                                    "SIZE": {
+                                        "description": "Size of the file in bytes",
+                                        "type": "integer"
+                                    },
+                                    "TIMESTAMP": {
+                                        "description": "Unix timestamp showing when the file was last modified",
+                                        "type": "string"
+                                    }
+                                }
+                            },
+                            "overwrite": {
+                                "description": "if a file with the same filename already exists, whether to overwrite the old file",
+                                "type": "boolean"
+                            },
+                            "pathname": {
+                                "description": "Relative path to the directory that contains the file.",
+                                "type": "string"
+                            },
+                            "basename": {
+                                "description": "Basename of the file",
+                                "type": "string",
+                                "$comment": "isGenerative:true"
+                            },
+                            "filetype": {
+                                "description": "What kind of file this is, e.g. image / text",
+                                "type": "string"
+                            }
+                        }
+                    }
+                ],
+                "discriminator": {
+                    "propertyName": "type"
+                }
+            }
+        }
+    }
+}

package/dist/js/schema/workflow/unit/mixins/map.json

@@ -0,0 +1,60 @@
+{
+    "$id": "workflow/unit/mixins/map",
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "title": "map unit mixin schema",
+    "type": "object",
+    "required": [
+        "input",
+        "workflowId"
+    ],
+    "properties": {
+        "type": {
+            "const": "map"
+        },
+        "workflowId": {
+            "description": "Id of workflow to run inside map",
+            "type": "string"
+        },
+        "input": {
+            "description": "Input information for map.",
+            "type": "object",
+            "required": [
+                "target"
+            ],
+            "properties": {
+                "target": {
+                    "description": "Name of the target variable to substitute using the values below. e.g. K_POINTS",
+                    "type": "string"
+                },
+                "scope": {
+                    "description": "Scope to retrieve `values` from, global or flowchartId. Optional if `values` is given.",
+                    "type": "string"
+                },
+                "name": {
+                    "description": "Name of the variable inside the scope to retrieve `values` from. Optional if `values` is given.",
+                    "type": "string"
+                },
+                "values": {
+                    "description": "Sequence of values for the target Jinja variable. Optional if `scope` and `name` are given. This can be used for map-reduce type parallel execution",
+                    "type": "array",
+                    "items": {
+                        "oneOf": [
+                            {
+                                "type": "string"
+                            },
+                            {
+                                "type": "number"
+                            },
+                            {
+                                "type": "object"
+                            }
+                        ]
+                    }
+                },
+                "useValues": {
+                    "type": "boolean"
+                }
+            }
+        }
+    }
+}

package/dist/js/schema/workflow/unit/mixins/processing.json

@@ -0,0 +1,27 @@
+{
+    "$id": "workflow/unit/mixins/processing",
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "title": "processing unit mixin schema",
+    "type": "object",
+    "required": [
+        "operation",
+        "operationType",
+        "inputData"
+    ],
+    "properties": {
+        "type": {
+            "const": "processing"
+        },
+        "operation": {
+            "description": "Contains information about the operation used.",
+            "type": "string"
+        },
+        "operationType": {
+            "description": "Contains information about the specific type of the operation used.",
+            "type": "string"
+        },
+        "inputData": {
+            "description": "unit input (type to be specified by the child units)"
+        }
+    }
+}

package/dist/js/schema/workflow/unit/mixins/reduce.json

@@ -0,0 +1,43 @@
+{
+    "$id": "workflow/unit/mixins/reduce",
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "title": "reduce unit mixin schema",
+    "type": "object",
+    "required": [
+        "mapFlowchartId",
+        "input"
+    ],
+    "properties": {
+        "type": {
+            "const": "reduce"
+        },
+        "mapFlowchartId": {
+            "description": "corresponding map unit flowchart ID",
+            "type": "string"
+        },
+        "input": {
+            "description": "input information for reduce unit",
+            "type": "array",
+            "items": {
+                "type": "object",
+                "required": [
+                    "operation",
+                    "arguments"
+                ],
+                "properties": {
+                    "operation": {
+                        "description": "reduce operation, e.g. aggregate",
+                        "type": "string"
+                    },
+                    "arguments": {
+                        "description": "arguments which are passed to reduce operation function",
+                        "type": "array",
+                        "items": {
+                            "type": "string"
+                        }
+                    }
+                }
+            }
+        }
+    }
+}

package/dist/js/schema/workflow/unit/mixins/subworkflow.json

@@ -0,0 +1,11 @@
+{
+    "$id": "workflow/unit/mixins/subworkflow",
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "title": "subworkflow unit mixin schema",
+    "type": "object",
+    "properties": {
+        "type": {
+            "const": "subworkflow"
+        }
+    }
+}

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

@@ -7,84 +7,18 @@
         "flowchartId",
         "input",
         "mapFlowchartId",
+        "monitors",
+        "name",
+        "postProcessors",
+        "preProcessors",
+        "results",
         "type"
     ],
-    "additionalProperties": true,
     "properties": {
-        "type": {
-            "const": "reduce",
-            "description": "type of the unit",
-            "type": "string"
-        },
-        "mapFlowchartId": {
-            "description": "corresponding map unit flowchart ID",
-            "type": "string"
-        },
-        "input": {
-            "description": "input information for reduce unit",
-            "type": "array",
-            "items": {
-                "type": "object",
-                "required": [
-                    "operation",
-                    "arguments"
-                ],
-                "properties": {
-                    "operation": {
-                        "description": "reduce operation, e.g. aggregate",
-                        "type": "string"
-                    },
-                    "arguments": {
-                        "description": "arguments which are passed to reduce operation function",
-                        "type": "array",
-                        "items": {
-                            "type": "string"
-                        }
-                    }
-                }
-            }
-        },
         "_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.",
+            "description": "entity identity",
             "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"
@@ -97,6 +31,10 @@
             "type": "string",
             "default": "2022.8.16"
         },
+        "name": {
+            "description": "entity name",
+            "type": "string"
+        },
         "isDefault": {
             "description": "Identifies that entity is defaultable",
             "type": "boolean",
@@ -107,30 +45,19 @@
             "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"
-                            }
-                        },
-                        "additionalProperties": true,
-                        "required": [
-                            "name"
-                        ]
-                    },
-                    {
-                        "$schema": "http://json-schema.org/draft-07/schema#",
-                        "title": "RuntimeItemString",
-                        "description": "name of runtime item in shortened notation",
+                "title": "runtime item name object schema",
+                "description": "A runtime item is a name of a pre-processor, post-processor, monitor, or result for a calculation. Can contain additional properties basename, filetype etc.",
+                "type": "object",
+                "required": [
+                    "name"
+                ],
+                "additionalProperties": true,
+                "properties": {
+                    "name": {
+                        "description": "The name of this item. e.g. scf_accuracy",
                         "type": "string"
                     }
-                ]
+                }
             }
         },
         "postProcessors": {
@@ -138,30 +65,19 @@
             "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"
-                            }
-                        },
-                        "additionalProperties": true,
-                        "required": [
-                            "name"
-                        ]
-                    },
-                    {
-                        "$schema": "http://json-schema.org/draft-07/schema#",
-                        "title": "RuntimeItemString",
-                        "description": "name of runtime item in shortened notation",
+                "title": "runtime item name object schema",
+                "description": "A runtime item is a name of a pre-processor, post-processor, monitor, or result for a calculation. Can contain additional properties basename, filetype etc.",
+                "type": "object",
+                "required": [
+                    "name"
+                ],
+                "additionalProperties": true,
+                "properties": {
+                    "name": {
+                        "description": "The name of this item. e.g. scf_accuracy",
                         "type": "string"
                     }
-                ]
+                }
             }
         },
         "monitors": {
@@ -169,30 +85,19 @@
             "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"
-                            }
-                        },
-                        "additionalProperties": true,
-                        "required": [
-                            "name"
-                        ]
-                    },
-                    {
-                        "$schema": "http://json-schema.org/draft-07/schema#",
-                        "title": "RuntimeItemString",
-                        "description": "name of runtime item in shortened notation",
+                "title": "runtime item name object schema",
+                "description": "A runtime item is a name of a pre-processor, post-processor, monitor, or result for a calculation. Can contain additional properties basename, filetype etc.",
+                "type": "object",
+                "required": [
+                    "name"
+                ],
+                "additionalProperties": true,
+                "properties": {
+                    "name": {
+                        "description": "The name of this item. e.g. scf_accuracy",
                         "type": "string"
                     }
-                ]
+                }
             }
         },
         "results": {
@@ -200,30 +105,19 @@
             "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"
-                            }
-                        },
-                        "additionalProperties": true,
-                        "required": [
-                            "name"
-                        ]
-                    },
-                    {
-                        "$schema": "http://json-schema.org/draft-07/schema#",
-                        "title": "RuntimeItemString",
-                        "description": "name of runtime item in shortened notation",
+                "title": "runtime item name object schema",
+                "description": "A runtime item is a name of a pre-processor, post-processor, monitor, or result for a calculation. Can contain additional properties basename, filetype etc.",
+                "type": "object",
+                "required": [
+                    "name"
+                ],
+                "additionalProperties": true,
+                "properties": {
+                    "name": {
+                        "description": "The name of this item. e.g. scf_accuracy",
                         "type": "string"
                     }
-                ]
+                }
             }
         },
         "tags": {
@@ -233,6 +127,17 @@
                 "type": "string"
             }
         },
+        "status": {
+            "type": "string",
+            "description": "Status of the unit.",
+            "enum": [
+                "idle",
+                "active",
+                "warning",
+                "error",
+                "finished"
+            ]
+        },
         "statusTrack": {
             "type": "array",
             "items": {
@@ -253,6 +158,58 @@
                     }
                 }
             }
+        },
+        "isDraft": {
+            "type": "boolean"
+        },
+        "type": {
+            "description": "type of the unit",
+            "type": "string",
+            "const": "reduce"
+        },
+        "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"
+        },
+        "mapFlowchartId": {
+            "description": "corresponding map unit flowchart ID",
+            "type": "string"
+        },
+        "input": {
+            "description": "input information for reduce unit",
+            "type": "array",
+            "items": {
+                "type": "object",
+                "required": [
+                    "operation",
+                    "arguments"
+                ],
+                "properties": {
+                    "operation": {
+                        "description": "reduce operation, e.g. aggregate",
+                        "type": "string"
+                    },
+                    "arguments": {
+                        "description": "arguments which are passed to reduce operation function",
+                        "type": "array",
+                        "items": {
+                            "type": "string"
+                        }
+                    }
+                }
+            }
         }
     }
 }