@nosana/types 0.1.0

package/dist/Schemas/job.js

@@ -0,0 +1,889 @@
+import typia from "typia";
+export const jobSchemas = {
+    version: "3.0",
+    components: {
+        schemas: {
+            JobDefinition: {
+                type: "object",
+                properties: {
+                    version: {
+                        type: "string",
+                        "enum": [
+                            "0.1"
+                        ]
+                    },
+                    type: {
+                        type: "string",
+                        "enum": [
+                            "container"
+                        ]
+                    },
+                    logistics: {
+                        $ref: "#/components/schemas/Logistics"
+                    },
+                    deployment_id: {
+                        type: "string"
+                    },
+                    meta: {
+                        $ref: "#/components/schemas/Meta"
+                    },
+                    global: {
+                        $ref: "#/components/schemas/Global"
+                    },
+                    ops: {
+                        $ref: "#/components/schemas/Ops"
+                    }
+                },
+                required: [
+                    "version",
+                    "type",
+                    "ops"
+                ]
+            },
+            Logistics: {
+                type: "object",
+                properties: {
+                    type: {
+                        $ref: "#/components/schemas/LogisticsType"
+                    },
+                    args: {
+                        $ref: "#/components/schemas/Partial__type"
+                    }
+                },
+                required: [
+                    "type",
+                    "args"
+                ]
+            },
+            LogisticsType: {
+                type: "string",
+                "enum": [
+                    "api",
+                    "api-listen"
+                ],
+                description: "api        - we receive and send via an endpoint endpoint\napi-listen - we create an endpoint to listen for incoming requests"
+            },
+            Partial__type: {
+                type: "object",
+                properties: {
+                    endpoint: {
+                        type: "string"
+                    }
+                },
+                required: [],
+                description: "Make all properties in T optional"
+            },
+            Meta: {
+                type: "object",
+                properties: {
+                    trigger: {
+                        type: "string"
+                    },
+                    system_resources: {
+                        $ref: "#/components/schemas/Recordstringstringnumber"
+                    }
+                },
+                required: [],
+                additionalProperties: {
+                    oneOf: [
+                        {
+                            type: "string"
+                        },
+                        {
+                            type: "number"
+                        }
+                    ]
+                }
+            },
+            Recordstringstringnumber: {
+                type: "object",
+                properties: {},
+                required: [],
+                description: "Construct a type with a set of properties K of type T",
+                additionalProperties: {
+                    oneOf: [
+                        {
+                            type: "string"
+                        },
+                        {
+                            type: "number"
+                        }
+                    ]
+                }
+            },
+            Global: {
+                type: "object",
+                properties: {
+                    image: {
+                        type: "string"
+                    },
+                    gpu: {
+                        type: "boolean"
+                    },
+                    entrypoint: {
+                        oneOf: [
+                            {
+                                type: "string"
+                            },
+                            {
+                                $ref: "#/components/schemas/CMDArray"
+                            }
+                        ]
+                    },
+                    env: {
+                        $ref: "#/components/schemas/Env"
+                    },
+                    work_dir: {
+                        type: "string"
+                    },
+                    variables: {
+                        $ref: "#/components/schemas/Variables"
+                    }
+                },
+                required: []
+            },
+            CMDArray: {
+                type: "array",
+                items: {
+                    type: "string"
+                }
+            },
+            Env: {
+                type: "object",
+                properties: {},
+                required: [],
+                additionalProperties: {
+                    type: "string"
+                }
+            },
+            Variables: {
+                type: "object",
+                properties: {},
+                required: [],
+                additionalProperties: {
+                    type: "string"
+                }
+            },
+            Ops: {
+                type: "array",
+                items: {
+                    $ref: "#/components/schemas/OperationkeyofOperationArgsMap"
+                }
+            },
+            OperationkeyofOperationArgsMap: {
+                type: "object",
+                properties: {
+                    type: {
+                        type: "string",
+                        "enum": [
+                            "container/run",
+                            "container/create-volume"
+                        ]
+                    },
+                    id: {
+                        type: "string"
+                    },
+                    args: {
+                        oneOf: [
+                            {
+                                $ref: "#/components/schemas/ContainerRun"
+                            },
+                            {
+                                $ref: "#/components/schemas/ContainerCreateVolume"
+                            }
+                        ]
+                    },
+                    results: {
+                        $ref: "#/components/schemas/OperationResults"
+                    },
+                    execution: {
+                        oneOf: [
+                            {
+                                $ref: "#/components/schemas/groupstringundefineddepends_onstringstop_if_dependent_stopsbooleanundefined"
+                            },
+                            {
+                                $ref: "#/components/schemas/groupstringundefineddepends_onundefinedstop_if_dependent_stopsundefined"
+                            }
+                        ]
+                    }
+                },
+                required: [
+                    "type",
+                    "id",
+                    "args"
+                ]
+            },
+            ContainerRun: {
+                type: "object",
+                properties: {
+                    image: {
+                        type: "string"
+                    },
+                    aliases: {
+                        oneOf: [
+                            {
+                                type: "string"
+                            },
+                            {
+                                $ref: "#/components/schemas/Aliases"
+                            }
+                        ]
+                    },
+                    cmd: {
+                        oneOf: [
+                            {
+                                type: "string"
+                            },
+                            {
+                                $ref: "#/components/schemas/CMDArray"
+                            }
+                        ]
+                    },
+                    volumes: {
+                        type: "array",
+                        items: {
+                            $ref: "#/components/schemas/Volume"
+                        }
+                    },
+                    expose: {
+                        oneOf: [
+                            {
+                                type: "number"
+                            },
+                            {
+                                $ref: "#/components/schemas/LiteralString"
+                            },
+                            {
+                                type: "object",
+                                properties: {
+                                    __spread__: {
+                                        $ref: "#/components/schemas/LiteralString"
+                                    }
+                                },
+                                required: [
+                                    "__spread__"
+                                ]
+                            },
+                            {
+                                $ref: "#/components/schemas/UniqueExposedPorts"
+                            }
+                        ]
+                    },
+                    gpu: {
+                        type: "boolean"
+                    },
+                    work_dir: {
+                        type: "string"
+                    },
+                    entrypoint: {
+                        oneOf: [
+                            {
+                                type: "string"
+                            },
+                            {
+                                $ref: "#/components/schemas/CMDArray"
+                            }
+                        ]
+                    },
+                    env: {
+                        $ref: "#/components/schemas/Env"
+                    },
+                    resources: {
+                        $ref: "#/components/schemas/Resources"
+                    },
+                    authentication: {
+                        $ref: "#/components/schemas/Authentication"
+                    }
+                },
+                required: [
+                    "image"
+                ]
+            },
+            Aliases: {
+                type: "array",
+                items: {
+                    type: "string"
+                }
+            },
+            Volume: {
+                type: "object",
+                properties: {
+                    name: {
+                        type: "string"
+                    },
+                    dest: {
+                        type: "string"
+                    }
+                },
+                required: [
+                    "name",
+                    "dest"
+                ]
+            },
+            LiteralString: {
+                type: "string"
+            },
+            UniqueExposedPorts: {
+                type: "array",
+                items: {
+                    $ref: "#/components/schemas/ExposeBase"
+                }
+            },
+            ExposeBase: {
+                oneOf: [
+                    {
+                        type: "number"
+                    },
+                    {
+                        $ref: "#/components/schemas/LiteralString"
+                    },
+                    {
+                        type: "object",
+                        properties: {
+                            __spread__: {
+                                $ref: "#/components/schemas/LiteralString"
+                            }
+                        },
+                        required: [
+                            "__spread__"
+                        ]
+                    }
+                ]
+            },
+            Resources: {
+                type: "array",
+                items: {
+                    oneOf: [
+                        {
+                            type: "object",
+                            properties: {
+                                __spread__: {
+                                    $ref: "#/components/schemas/LiteralString"
+                                }
+                            },
+                            required: [
+                                "__spread__"
+                            ]
+                        },
+                        {
+                            $ref: "#/components/schemas/S3Base"
+                        },
+                        {
+                            $ref: "#/components/schemas/S3WithBucket"
+                        },
+                        {
+                            $ref: "#/components/schemas/S3WithBuckets"
+                        },
+                        {
+                            $ref: "#/components/schemas/HFResource"
+                        },
+                        {
+                            $ref: "#/components/schemas/OllamaResource"
+                        },
+                        {
+                            type: "string",
+                            "enum": [
+                                "__remove-if-empty__"
+                            ]
+                        }
+                    ]
+                }
+            },
+            S3Base: {
+                type: "object",
+                properties: {
+                    type: {
+                        type: "string",
+                        "enum": [
+                            "S3"
+                        ]
+                    },
+                    target: {
+                        type: "string"
+                    },
+                    url: {
+                        type: "string"
+                    },
+                    allowWrite: {
+                        type: "boolean"
+                    },
+                    files: {
+                        type: "array",
+                        items: {
+                            type: "string"
+                        }
+                    },
+                    IAM: {
+                        $ref: "#/components/schemas/S3Auth"
+                    }
+                },
+                required: [
+                    "type",
+                    "target"
+                ]
+            },
+            S3Auth: {
+                type: "object",
+                properties: {
+                    REGION: {
+                        type: "string"
+                    },
+                    ACCESS_KEY_ID: {
+                        type: "string"
+                    },
+                    SECRET_ACCESS_KEY: {
+                        type: "string"
+                    }
+                },
+                required: [
+                    "REGION",
+                    "ACCESS_KEY_ID",
+                    "SECRET_ACCESS_KEY"
+                ]
+            },
+            S3WithBucket: {
+                type: "object",
+                properties: {
+                    type: {
+                        type: "string",
+                        "enum": [
+                            "S3"
+                        ]
+                    },
+                    target: {
+                        type: "string"
+                    },
+                    bucket: {
+                        type: "string"
+                    },
+                    url: {
+                        type: "string"
+                    },
+                    allowWrite: {
+                        type: "boolean"
+                    },
+                    IAM: {
+                        $ref: "#/components/schemas/S3Auth"
+                    }
+                },
+                required: [
+                    "type",
+                    "target",
+                    "bucket"
+                ]
+            },
+            S3WithBuckets: {
+                type: "object",
+                properties: {
+                    type: {
+                        type: "string",
+                        "enum": [
+                            "S3"
+                        ]
+                    },
+                    target: {
+                        type: "string"
+                    },
+                    buckets: {
+                        type: "array",
+                        items: {
+                            type: "object",
+                            properties: {
+                                url: {
+                                    type: "string"
+                                },
+                                files: {
+                                    type: "array",
+                                    items: {
+                                        type: "string"
+                                    }
+                                }
+                            },
+                            required: [
+                                "url"
+                            ]
+                        }
+                    },
+                    url: {
+                        type: "string"
+                    },
+                    allowWrite: {
+                        type: "boolean"
+                    },
+                    IAM: {
+                        $ref: "#/components/schemas/S3Auth"
+                    }
+                },
+                required: [
+                    "type",
+                    "target",
+                    "buckets"
+                ]
+            },
+            HFResource: {
+                type: "object",
+                properties: {
+                    type: {
+                        type: "string",
+                        "enum": [
+                            "HF"
+                        ]
+                    },
+                    target: {
+                        type: "string"
+                    },
+                    repo: {
+                        type: "string"
+                    },
+                    revision: {
+                        type: "string"
+                    },
+                    files: {
+                        type: "array",
+                        items: {
+                            type: "string"
+                        }
+                    },
+                    accessToken: {
+                        type: "string"
+                    }
+                },
+                required: [
+                    "type",
+                    "target",
+                    "repo"
+                ]
+            },
+            OllamaResource: {
+                type: "object",
+                properties: {
+                    type: {
+                        type: "string",
+                        "enum": [
+                            "Ollama"
+                        ]
+                    },
+                    model: {
+                        type: "string"
+                    },
+                    target: {
+                        type: "string"
+                    }
+                },
+                required: [
+                    "type",
+                    "model"
+                ]
+            },
+            Authentication: {
+                type: "object",
+                properties: {
+                    docker: {
+                        $ref: "#/components/schemas/DockerAuth"
+                    }
+                },
+                required: []
+            },
+            DockerAuth: {
+                type: "object",
+                properties: {
+                    username: {
+                        type: "string"
+                    },
+                    password: {
+                        type: "string"
+                    },
+                    email: {
+                        type: "string"
+                    },
+                    server: {
+                        type: "string"
+                    }
+                },
+                required: []
+            },
+            ContainerCreateVolume: {
+                type: "object",
+                properties: {
+                    name: {
+                        type: "string"
+                    }
+                },
+                required: [
+                    "name"
+                ]
+            },
+            OperationResults: {
+                type: "object",
+                properties: {},
+                required: [],
+                additionalProperties: {
+                    oneOf: [
+                        {
+                            type: "string"
+                        },
+                        {
+                            $ref: "#/components/schemas/OperationResult"
+                        }
+                    ]
+                }
+            },
+            OperationResult: {
+                type: "object",
+                properties: {
+                    regex: {
+                        type: "string"
+                    },
+                    logType: {
+                        $ref: "#/components/schemas/LogTypeTuple"
+                    }
+                },
+                required: [
+                    "regex",
+                    "logType"
+                ]
+            },
+            LogTypeTuple: {
+                type: "array",
+                items: {
+                    $ref: "#/components/schemas/StdOption"
+                }
+            },
+            StdOption: {
+                type: "string",
+                "enum": [
+                    "stdin",
+                    "stdout",
+                    "stderr",
+                    "nodeerr"
+                ]
+            },
+            groupstringundefineddepends_onstringstop_if_dependent_stopsbooleanundefined: {
+                type: "object",
+                properties: {
+                    group: {
+                        type: "string"
+                    },
+                    depends_on: {
+                        type: "array",
+                        items: {
+                            type: "string"
+                        }
+                    },
+                    stop_if_dependent_stops: {
+                        type: "boolean"
+                    }
+                },
+                required: [
+                    "depends_on"
+                ]
+            },
+            groupstringundefineddepends_onundefinedstop_if_dependent_stopsundefined: {
+                type: "object",
+                properties: {
+                    group: {
+                        type: "string"
+                    }
+                },
+                required: []
+            },
+            FlowState: {
+                type: "object",
+                properties: {
+                    status: {
+                        type: "string"
+                    },
+                    startTime: {
+                        type: "number"
+                    },
+                    endTime: {
+                        type: "number",
+                        nullable: true
+                    },
+                    errors: {
+                        type: "array",
+                        items: {}
+                    },
+                    opStates: {
+                        type: "array",
+                        items: {
+                            $ref: "#/components/schemas/OpState"
+                        }
+                    },
+                    secrets: {
+                        $ref: "#/components/schemas/FlowSecrets"
+                    }
+                },
+                required: [
+                    "status",
+                    "startTime",
+                    "endTime",
+                    "opStates"
+                ]
+            },
+            OpState: {
+                type: "object",
+                properties: {
+                    providerId: {
+                        type: "string",
+                        nullable: true
+                    },
+                    operationId: {
+                        type: "string",
+                        nullable: true
+                    },
+                    group: {
+                        type: "string",
+                        nullable: true
+                    },
+                    status: {
+                        type: "string",
+                        nullable: true
+                    },
+                    startTime: {
+                        type: "number",
+                        nullable: true
+                    },
+                    endTime: {
+                        type: "number",
+                        nullable: true
+                    },
+                    exitCode: {
+                        type: "number",
+                        nullable: true
+                    },
+                    logs: {
+                        type: "array",
+                        items: {
+                            $ref: "#/components/schemas/Log"
+                        }
+                    },
+                    results: {
+                        type: "object",
+                        properties: {},
+                        required: [],
+                        additionalProperties: {
+                            oneOf: [
+                                {
+                                    type: "string"
+                                },
+                                {
+                                    type: "array",
+                                    items: {
+                                        type: "string"
+                                    }
+                                }
+                            ]
+                        }
+                    }
+                },
+                required: [
+                    "providerId",
+                    "operationId",
+                    "group",
+                    "status",
+                    "startTime",
+                    "endTime",
+                    "exitCode",
+                    "logs"
+                ]
+            },
+            Log: {
+                type: "object",
+                properties: {
+                    type: {
+                        $ref: "#/components/schemas/StdOption"
+                    },
+                    log: {
+                        type: "string"
+                    }
+                },
+                required: [
+                    "type"
+                ]
+            },
+            FlowSecrets: {
+                type: "object",
+                properties: {
+                    urlmode: {
+                        type: "string",
+                        "enum": [
+                            "private",
+                            "public"
+                        ]
+                    }
+                },
+                required: [],
+                additionalProperties: {
+                    oneOf: [
+                        {
+                            $ref: "#/components/schemas/JobExposeSecrets"
+                        },
+                        {
+                            type: "string",
+                            "enum": [
+                                "private",
+                                "public"
+                            ]
+                        }
+                    ]
+                }
+            },
+            JobExposeSecrets: {
+                type: "object",
+                properties: {},
+                required: [],
+                additionalProperties: {
+                    $ref: "#/components/schemas/EndpointSecret"
+                }
+            },
+            EndpointSecret: {
+                type: "object",
+                properties: {
+                    opID: {
+                        type: "string"
+                    },
+                    port: {
+                        oneOf: [
+                            {
+                                type: "string"
+                            },
+                            {
+                                type: "number"
+                            }
+                        ]
+                    },
+                    url: {
+                        type: "string"
+                    },
+                    status: {
+                        $ref: "#/components/schemas/EndpointStatus"
+                    }
+                },
+                required: [
+                    "opID",
+                    "port",
+                    "url",
+                    "status"
+                ]
+            },
+            EndpointStatus: {
+                type: "string",
+                "enum": [
+                    "ONLINE",
+                    "OFFLINE",
+                    "UNKNOWN"
+                ]
+            }
+        }
+    },
+    schemas: [
+        {
+            $ref: "#/components/schemas/JobDefinition"
+        },
+        {
+            $ref: "#/components/schemas/FlowState"
+        }
+    ]
+};
+//# sourceMappingURL=job.js.map